Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates IDX API options parameter type to optional #981

Closed
wants to merge 3 commits into from
Closed

Updates IDX API options parameter type to optional #981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cf2d107
fix: updates idx api types for on-demand use
shawyu-okta Oct 21, 2021
79ecf06
fix: updates README with updated contributing link
shawyu-okta Oct 21, 2021
ef8554e
update changelog
shawyu-okta Oct 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## 5.7.0

### Other
- [#981](https://github.com/okta/okta-auth-js/pull/981) TypeScript: Allows optional paramters for IDX methods

## 5.6.0

### Features
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1854,4 +1854,4 @@ const OktaAuth = require('@okta/okta-auth-js').OktaAuth;

## Contributing

We're happy to accept contributions and PRs! Please see the [contribution guide](contributing.md) to understand how to structure a contribution.
We're happy to accept contributions and PRs! Please see the [contribution guide](CONTRIBUTING.md) to understand how to structure a contribution.
6 changes: 3 additions & 3 deletions lib/types/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,10 +256,10 @@ export interface PkceAPI {
export interface IdxAPI {
interact: (options?: InteractOptions) => Promise<InteractResponse>;
introspect: (options?: IntrospectOptions) => Promise<IdxResponse>;
authenticate: (options: AuthenticationOptions) => Promise<IdxTransaction>;
register: (options: IdxRegistrationOptions) => Promise<IdxTransaction>;
authenticate: (options?: AuthenticationOptions) => Promise<IdxTransaction>;
register: (options?: IdxRegistrationOptions) => Promise<IdxTransaction>;
cancel: (options?: CancelOptions) => Promise<IdxTransaction>;
startTransaction: (options?: IdxOptions) => Promise<IdxTransaction>;
recoverPassword: (options: PasswordRecoveryOptions) => Promise<IdxTransaction>;
recoverPassword: (options?: PasswordRecoveryOptions) => Promise<IdxTransaction>;
handleInteractionCodeRedirect: (url: string) => Promise<void>;
}