@okta/okta-auth-js 6.4.2 → 6.4.5

package/lib/types/OktaAuthOptions.d.ts

@@ -14,9 +14,10 @@ import { CookieOptions } from './Cookies';
 import { HttpRequestClient } from './http';
 import { AuthState } from './AuthState';
 import { TransactionManagerOptions } from './Transaction';
-import { FlowIdentifier } from '../idx/types';
+import { IdxTransactionMeta } from '../idx/types';
 import { ServiceManagerOptions } from './Service';
 import OktaAuth from '../OktaAuth';
+import { OAuthResponseMode, OAuthResponseType } from './OAuth';
 export interface IsAuthenticatedOptions {
     onExpiredToken?: 'renew' | 'remove' | 'none';
 }
@@ -39,16 +40,36 @@ export interface CustomUrls {
     revokeUrl?: string;
     logoutUrl?: string;
 }
-export interface OktaAuthOptions extends CustomUrls {
+export interface TokenParams extends CustomUrls {
     pkce?: boolean;
     clientId?: string;
     redirectUri?: string;
-    useInteractionCodeFlow?: boolean;
-    responseType?: string | string[];
-    responseMode?: string;
-    scopes?: string[];
+    responseType?: OAuthResponseType | OAuthResponseType[];
+    responseMode?: OAuthResponseMode;
     state?: string;
+    nonce?: string;
+    scopes?: string[];
+    display?: string;
     ignoreSignature?: boolean;
+    codeVerifier?: string;
+    authorizationCode?: string;
+    codeChallenge?: string;
+    codeChallengeMethod?: string;
+    interactionCode?: string;
+    idp?: string;
+    idpScope?: string | string[];
+    loginHint?: string;
+    maxAge?: string | number;
+    prompt?: string;
+    sessionToken?: string;
+    timeout?: number;
+    extraParams?: {
+        [propName: string]: string;
+    };
+    popupTitle?: string;
+}
+export interface OktaAuthOptions extends CustomUrls, Pick<TokenParams, 'issuer' | 'clientId' | 'redirectUri' | 'responseType' | 'responseMode' | 'scopes' | 'state' | 'pkce' | 'ignoreSignature' | 'codeChallenge' | 'codeChallengeMethod'>, Pick<IdxTransactionMeta, 'flow' | 'activationToken' | 'recoveryToken'> {
+    useInteractionCodeFlow?: boolean;
     ignoreLifetime?: boolean;
     tokenManager?: TokenManagerOptions;
     postLogoutRedirectUri?: string;
@@ -65,10 +86,5 @@ export interface OktaAuthOptions extends CustomUrls {
     storageManager?: StorageManagerOptions;
     services?: ServiceManagerOptions;
     transactionManager?: TransactionManagerOptions;
-    flow?: FlowIdentifier;
-    codeChallenge?: string;
-    codeChallengeMethod?: string;
-    recoveryToken?: string;
-    activationToken?: string;
     clientSecret?: string;
 }

package/lib/types/Storage.d.ts

@@ -12,6 +12,7 @@
 import { TransactionMeta } from './Transaction';
 import { Cookies, CookieOptions } from './Cookies';
 import { RawIdxResponse } from '../idx/types/idx-js';
+import { IntrospectOptions } from '.';
 export interface TxStorage {
     get(name: string): string;
     set(name: string, value: string, expiresAt: string, options: CookieOptions): string;
@@ -40,7 +41,7 @@ export interface TransactionStorage extends StorageProvider {
     setStorage(obj: TransactionMeta): void;
     getStorage(): TransactionMeta;
 }
-export interface SavedIdxResponse {
+export interface SavedIdxResponse extends Pick<IntrospectOptions, 'stateHandle' | 'interactionHandle'> {
     rawIdxResponse: RawIdxResponse;
     requestDidSucceed?: boolean;
 }

package/lib/types/Transaction.d.ts

@@ -10,8 +10,8 @@
  * See the License for the specific language governing permissions and limitations under the License.
  */
 import { StorageManager } from '../StorageManager';
-import { CustomUrls } from './OktaAuthOptions';
-import { FlowIdentifier, IdxTransactionMeta } from '../idx/types';
+import { CustomUrls, TokenParams } from './OktaAuthOptions';
+import { IdxTransactionMeta } from '../idx/types';
 export interface TransactionManagerOptions {
     storageManager?: StorageManager;
     enableSharedStorage?: boolean;
@@ -21,38 +21,18 @@ export interface TransactionManagerOptions {
     saveParamsCookie?: boolean;
     saveLastResponse?: boolean;
 }
-export interface TransactionMetaOptions {
-    pkce?: boolean;
-    oauth?: boolean;
-    muteWarning?: boolean;
-    state?: string;
-    flow?: FlowIdentifier;
-    codeVerifier?: string;
-    codeChallenge?: string;
-    codeChallengeMethod?: string;
-    activationToken?: string;
-    recoveryToken?: string;
-}
-export interface OAuthTransactionMeta {
-    issuer: string;
-    redirectUri: string;
-    state: string;
-    nonce: string;
-    responseType: string | string[];
-    responseMode?: string;
-    scopes: string[];
-    clientId: string;
+export interface OAuthTransactionMeta extends Pick<TokenParams, 'issuer' | 'clientId' | 'redirectUri' | 'responseType' | 'responseMode' | 'scopes' | 'state' | 'pkce' | 'ignoreSignature' | 'nonce'> {
     urls: CustomUrls;
-    ignoreSignature: boolean;
     originalUri?: string;
 }
-export interface PKCETransactionMeta extends OAuthTransactionMeta {
-    codeVerifier: string;
-    codeChallengeMethod: string;
-    codeChallenge: string;
+export interface PKCETransactionMeta extends OAuthTransactionMeta, Pick<TokenParams, 'codeChallenge' | 'codeChallengeMethod' | 'codeVerifier'> {
 }
 export declare type CustomAuthTransactionMeta = Record<string, string | undefined>;
 export declare type TransactionMeta = IdxTransactionMeta | PKCETransactionMeta | OAuthTransactionMeta | CustomAuthTransactionMeta;
+export interface TransactionMetaOptions extends Pick<IdxTransactionMeta, 'pkce' | 'state' | 'codeChallenge' | 'codeChallengeMethod' | 'codeVerifier' | 'flow' | 'activationToken' | 'recoveryToken'> {
+    oauth?: boolean;
+    muteWarning?: boolean;
+}
 export declare function isOAuthTransactionMeta(obj: any): obj is OAuthTransactionMeta;
 export declare function isPKCETransactionMeta(obj: any): obj is PKCETransactionMeta;
 export declare function isIdxTransactionMeta(obj: any): obj is IdxTransactionMeta;

package/lib/types/api.d.ts

@@ -13,16 +13,13 @@ import { AuthTransaction } from '../tx/AuthTransaction';
 import { Token, Tokens, RevocableToken, AccessToken, IDToken, RefreshToken } from './Token';
 import { JWTObject } from './JWT';
 import { UserClaims } from './UserClaims';
-import { CustomUrls, OktaAuthOptions } from './OktaAuthOptions';
+import { CustomUrls, OktaAuthOptions, TokenParams } from './OktaAuthOptions';
 import { StorageManager } from '../StorageManager';
 import TransactionManager from '../TransactionManager';
 import { TokenManagerInterface } from './TokenManager';
 import { ServiceManagerInterface } from './Service';
 import { OktaUserAgent } from '../OktaUserAgent';
-import { AuthenticationOptions, RegistrationOptions as IdxRegistrationOptions, PasswordRecoveryOptions, AccountUnlockOptions, ProceedOptions, CancelOptions, IdxOptions, IdxTransaction, IdxTransactionMeta, EmailVerifyCallbackResponse, IdxAuthenticator, ChallengeData, ActivationData, WebauthnEnrollValues, WebauthnVerificationValues, FlowIdentifier, IdxPollOptions } from '../idx/types';
-import { InteractOptions, InteractResponse } from '../idx/interact';
-import { IntrospectOptions } from '../idx/introspect';
-import { IdxResponse } from '../idx/types/idx-js';
+import { AuthenticationOptions, RegistrationOptions as IdxRegistrationOptions, PasswordRecoveryOptions, AccountUnlockOptions, ProceedOptions, CancelOptions, IdxTransaction, IdxTransactionMeta, EmailVerifyCallbackResponse, IdxAuthenticator, ChallengeData, ActivationData, WebauthnEnrollValues, WebauthnVerificationValues, FlowIdentifier, IdxPollOptions, IdxResponse, IntrospectOptions, InteractOptions, InteractResponse, StartOptions } from '../idx/types';
 import { TransactionMetaOptions } from './Transaction';
 export interface OktaAuthInterface {
     options: OktaAuthOptions;
@@ -37,12 +34,19 @@ export interface OktaAuthInterface {
     features: FeaturesAPI;
     token: TokenAPI;
 }
+export interface FieldError {
+    errorSummary: string;
+    reason?: string;
+    location?: string;
+    locationType?: string;
+    domain?: string;
+}
 export interface APIError {
     errorSummary: string;
     errorCode?: string;
     errorLink?: string;
     errorId?: string;
-    errorCauses?: string[];
+    errorCauses?: Array<FieldError>;
 }
 export interface HttpAPI {
     setRequestHeader(name: string, value: string): void;
@@ -73,34 +77,6 @@ export interface SessionAPI {
     refresh: () => Promise<object>;
     setCookieAndRedirect: (sessionToken?: string, redirectUri?: string) => void;
 }
-export interface TokenParams extends CustomUrls {
-    pkce?: boolean;
-    clientId?: string;
-    redirectUri?: string;
-    responseType?: string | string[];
-    responseMode?: string;
-    state?: string;
-    nonce?: string;
-    scopes?: string[];
-    display?: string;
-    ignoreSignature?: boolean;
-    codeVerifier?: string;
-    authorizationCode?: string;
-    codeChallenge?: string;
-    codeChallengeMethod?: string;
-    interactionCode?: string;
-    idp?: string;
-    idpScope?: string | string[];
-    loginHint?: string;
-    maxAge?: string | number;
-    prompt?: string;
-    sessionToken?: string;
-    timeout?: number;
-    extraParams?: {
-        [propName: string]: string;
-    };
-    popupTitle?: string;
-}
 export interface PopupParams {
     popupTitle?: string;
     popupWindow?: Window;
@@ -231,13 +207,13 @@ export interface IdxAPI {
     recoverPassword: (options?: PasswordRecoveryOptions) => Promise<IdxTransaction>;
     unlockAccount: (options?: AccountUnlockOptions) => Promise<IdxTransaction>;
     poll: (options?: IdxPollOptions) => Promise<IdxTransaction>;
-    start: (options?: IdxOptions) => Promise<IdxTransaction>;
+    start: (options?: StartOptions) => Promise<IdxTransaction>;
     canProceed(options?: ProceedOptions): boolean;
     proceed: (options?: ProceedOptions) => Promise<IdxTransaction>;
     cancel: (options?: CancelOptions) => Promise<IdxTransaction>;
     getFlow(): FlowIdentifier | undefined;
     setFlow(flow: FlowIdentifier): void;
-    startTransaction: (options?: IdxOptions) => Promise<IdxTransaction>;
+    startTransaction: (options?: StartOptions) => Promise<IdxTransaction>;
     isInteractionRequired: (hashOrSearch?: string) => boolean;
     isInteractionRequiredError: (error: Error) => boolean;
     handleInteractionCodeRedirect: (url: string) => Promise<void>;

package/package.json

@@ -2,7 +2,7 @@
   "private": false,
   "name": "@okta/okta-auth-js",
   "description": "The Okta Auth SDK",
-  "version": "6.4.2",
+  "version": "6.4.5",
   "homepage": "https://github.com/okta/okta-auth-js",
   "license": "Apache-2.0",
   "main": "cjs/index.js",
@@ -187,8 +187,8 @@
     }
   },
   "okta": {
-    "commitSha": "df5296fe5935b093118455de1856279ea0aa4790",
-    "fullVersion": "6.4.2-gdf5296f",
-    "testedSha": "8b2980f93ad144dc81ba8c9866ed380a86396544"
+    "commitSha": "445b4fb3e8e5da1ce20a9c2aa568c53ecf0d5821",
+    "fullVersion": "6.4.5-g445b4fb",
+    "testedSha": "77c77566ab6998f2235829a206ffef90a9c09d74"
   }
 }