@okta/okta-auth-js 5.10.0 → 6.1.0

package/lib/types/Storage.d.ts

@@ -49,13 +49,13 @@ export interface StorageOptions extends CookieOptions {
     storageTypes?: StorageType[];
     storageProvider?: SimpleStorage;
     storageKey?: string;
-    useMultipleCookies?: boolean;
+    useSeparateCookies?: boolean;
 }
 export declare type StorageType = 'memory' | 'sessionStorage' | 'localStorage' | 'cookie' | 'custom' | 'auto';
 export interface StorageUtil {
     storage: TxStorage;
     testStorageType(storageType: StorageType): boolean;
-    getStorageByType(storageType: StorageType, options: StorageOptions): SimpleStorage;
+    getStorageByType(storageType: StorageType, options?: StorageOptions): SimpleStorage;
     findStorageType(types: StorageType[]): StorageType;
 }
 export interface BrowserStorageUtil extends StorageUtil {
@@ -79,7 +79,7 @@ export interface NodeStorageUtil extends StorageUtil {
     getStorage(): SimpleStorage;
 }
 export interface CookieStorage extends SimpleStorage {
-    setItem(key: string, value: any, expiresAt?: string): void;
+    setItem(key: string, value: any, expiresAt?: string | null): void;
     getItem(key?: string): any;
     removeItem(key: string): any;
 }

package/lib/types/Transaction.d.ts

@@ -9,9 +9,9 @@
  *
  * See the License for the specific language governing permissions and limitations under the License.
  */
-import StorageManager from '../StorageManager';
+import { StorageManager } from '../StorageManager';
 import { CustomUrls } from './OktaAuthOptions';
-import { FlowIdentifier } from '../idx/types';
+import { FlowIdentifier, IdxTransactionMeta } from '../idx/types';
 export interface TransactionManagerOptions {
     storageManager?: StorageManager;
     enableSharedStorage?: boolean;
@@ -19,12 +19,19 @@ export interface TransactionManagerOptions {
     saveNonceCookie?: boolean;
     saveStateCookie?: boolean;
     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;
@@ -32,6 +39,7 @@ export interface OAuthTransactionMeta {
     state: string;
     nonce: string;
     responseType: string | string[];
+    responseMode?: string;
     scopes: string[];
     clientId: string;
     urls: CustomUrls;
@@ -43,11 +51,6 @@ export interface PKCETransactionMeta extends OAuthTransactionMeta {
     codeChallengeMethod: string;
     codeChallenge: string;
 }
-export interface IdxTransactionMeta extends PKCETransactionMeta {
-    interactionHandle?: string;
-    remediations?: string[];
-    flow?: FlowIdentifier;
-}
 export declare type CustomAuthTransactionMeta = Record<string, string | undefined>;
 export declare type TransactionMeta = IdxTransactionMeta | PKCETransactionMeta | OAuthTransactionMeta | CustomAuthTransactionMeta;
 export declare function isOAuthTransactionMeta(obj: any): obj is OAuthTransactionMeta;

package/lib/types/UserClaims.d.ts

@@ -15,7 +15,7 @@
  * ID Token or returned from the /userinfo response and depend on the
  * response_type and scope parameters in the authorize request
  */
-export interface UserClaims {
+export declare type UserClaims<T = {}> = T & {
     auth_time?: number;
     aud?: string;
     email?: string;
@@ -34,5 +34,5 @@ export interface UserClaims {
     updated_at?: number;
     ver?: number;
     zoneinfo?: string;
-    [propName: string]: any;
-}
+    at_hash?: string;
+};

package/lib/types/api.d.ts

@@ -14,27 +14,26 @@ import { Token, Tokens, RevocableToken, AccessToken, IDToken, RefreshToken } fro
 import { JWTObject } from './JWT';
 import { UserClaims } from './UserClaims';
 import { CustomUrls, OktaAuthOptions } from './OktaAuthOptions';
-import StorageManager from '../StorageManager';
+import { StorageManager } from '../StorageManager';
 import TransactionManager from '../TransactionManager';
 import { TokenManagerInterface } from './TokenManager';
 import { OktaUserAgent } from '../OktaUserAgent';
-import { FlowIdentifier, IdxPollOptions } from '../idx/types';
-import { AuthenticationOptions, RegistrationOptions as IdxRegistrationOptions, PasswordRecoveryOptions, ProceedOptions, CancelOptions, IdxOptions, IdxTransaction } from '../idx/types';
+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';
-export interface OktaAuth {
+import { TransactionMetaOptions } from './Transaction';
+export interface OktaAuthInterface {
     options: OktaAuthOptions;
-    userAgent: string;
     getIssuerOrigin(): string;
-    getOriginalUri(): string;
+    getOriginalUri(): string | undefined;
     _oktaUserAgent: OktaUserAgent;
     storageManager: StorageManager;
     transactionManager: TransactionManager;
     tokenManager: TokenManagerInterface;
     idx: IdxAPI;
-    features?: FeaturesAPI;
-    token?: TokenAPI;
+    features: FeaturesAPI;
+    token: TokenAPI;
 }
 export interface APIError {
     errorSummary: string;
@@ -83,11 +82,10 @@ export interface TokenParams extends CustomUrls {
     scopes?: string[];
     display?: string;
     ignoreSignature?: boolean;
-    codeChallengeMethod?: string;
     codeVerifier?: string;
     authorizationCode?: string;
     codeChallenge?: string;
-    grantType?: string;
+    codeChallengeMethod?: string;
     interactionCode?: string;
     idp?: string;
     idpScope?: string | string[];
@@ -136,8 +134,8 @@ export interface TokenAPI extends BaseTokenAPI {
     getWithoutPrompt(params?: TokenParams): Promise<TokenResponse>;
     getWithPopup(params?: TokenParams): Promise<TokenResponse>;
     revoke(token: RevocableToken): Promise<object>;
-    renew(token: Token): Promise<Token>;
-    renewTokens(): Promise<Tokens>;
+    renew(token: Token): Promise<Token | undefined>;
+    renewTokens(options?: TokenParams): Promise<Tokens>;
     renewTokensWithRefresh(tokenParams: TokenParams, refreshTokenObject: RefreshToken): Promise<Tokens>;
     verify(token: IDToken, params?: object): Promise<IDToken>;
     isLoginRedirect(): boolean;
@@ -163,12 +161,24 @@ export interface FeaturesAPI {
     isPKCESupported(): boolean;
     isIE11OrLess(): boolean;
 }
+export interface CryptoAPI {
+    base64UrlToBuffer(b64u: string): Uint8Array;
+    bufferToBase64Url(bin: Uint8Array): string;
+}
+export interface WebauthnAPI {
+    getAssertion(credential: PublicKeyCredential): WebauthnVerificationValues;
+    getAttestation(credential: PublicKeyCredential): WebauthnEnrollValues;
+    buildCredentialRequestOptions(challengeData: ChallengeData, authenticatorEnrollments: IdxAuthenticator[]): CredentialRequestOptions;
+    buildCredentialCreationOptions(activationData: ActivationData, authenticatorEnrollments: IdxAuthenticator[]): CredentialCreationOptions;
+}
 export interface SupportsCodeFlow {
     useInteractionCodeFlow?: boolean;
 }
 export interface SigninOptions extends SupportsCodeFlow, AuthenticationOptions {
     relayState?: string;
-    context?: string;
+    context?: {
+        deviceToken?: string;
+    };
     sendFingerprint?: boolean;
 }
 export interface SigninWithRedirectOptions extends SigninOptions, TokenParams {
@@ -192,7 +202,7 @@ export interface SignoutOptions extends SignoutRedirectUrlOptions {
     revokeRefreshToken?: boolean;
     accessToken?: AccessToken;
     refreshToken?: RefreshToken;
-    clearTokensAfterRedirect?: boolean;
+    clearTokensBeforeRedirect?: boolean;
 }
 export interface SignoutAPI {
     signOut(opts: SignoutOptions): any;
@@ -215,15 +225,29 @@ export interface IdxAPI {
     introspect: (options?: IntrospectOptions) => Promise<IdxResponse>;
     authenticate: (options?: AuthenticationOptions) => Promise<IdxTransaction>;
     register: (options?: IdxRegistrationOptions) => Promise<IdxTransaction>;
+    recoverPassword: (options?: PasswordRecoveryOptions) => Promise<IdxTransaction>;
+    unlockAccount: (options?: AccountUnlockOptions) => Promise<IdxTransaction>;
     poll: (options?: IdxPollOptions) => Promise<IdxTransaction>;
+    start: (options?: IdxOptions) => Promise<IdxTransaction>;
+    canProceed(options?: {
+        state?: string;
+    }): boolean;
     proceed: (options?: ProceedOptions) => Promise<IdxTransaction>;
     cancel: (options?: CancelOptions) => Promise<IdxTransaction>;
+    getFlow(): FlowIdentifier | undefined;
+    setFlow(flow: FlowIdentifier): void;
     startTransaction: (options?: IdxOptions) => Promise<IdxTransaction>;
-    recoverPassword: (options?: PasswordRecoveryOptions) => Promise<IdxTransaction>;
+    isInteractionRequired: (hashOrSearch?: string) => boolean;
+    isInteractionRequiredError: (error: Error) => boolean;
     handleInteractionCodeRedirect: (url: string) => Promise<void>;
-    getFlow(): FlowIdentifier;
-    setFlow(flow: FlowIdentifier): void;
-    canProceed(options?: {
-        state?: string;
-    }): boolean;
+    isEmailVerifyCallback: (search: string) => boolean;
+    parseEmailVerifyCallback: (search: string) => EmailVerifyCallbackResponse;
+    handleEmailVerifyCallback: (search: string) => Promise<IdxTransaction | undefined>;
+    isEmailVerifyCallbackError: (error: Error) => boolean;
+    getSavedTransactionMeta: (options?: TransactionMetaOptions) => IdxTransactionMeta | undefined;
+    createTransactionMeta: (options?: TransactionMetaOptions) => Promise<IdxTransactionMeta>;
+    getTransactionMeta: (options?: TransactionMetaOptions) => Promise<IdxTransactionMeta>;
+    saveTransactionMeta: (meta: unknown) => void;
+    clearTransactionMeta: () => void;
+    isTransactionMetaValid: (meta: unknown) => boolean;
 }

package/lib/types/index.d.ts

@@ -23,4 +23,3 @@ export * from './Storage';
 export * from './Token';
 export * from './TokenManager';
 export * from './UserClaims';
-export * from './AuthState';

package/lib/util/console.d.ts

@@ -9,7 +9,7 @@
  *
  * See the License for the specific language governing permissions and limitations under the License.
  */
-export declare function getNativeConsole(): Console;
+export declare function getNativeConsole(): Console | undefined;
 export declare function getConsole(): Console | {
     log: () => void;
     warn: () => void;

package/lib/util/index.d.ts

@@ -10,7 +10,6 @@
  * See the License for the specific language governing permissions and limitations under the License.
  */
 export * from './console';
-export * from './emailVerify';
 export * from './misc';
 export * from './object';
 export * from './types';

package/lib/util/sharedStorage.d.ts

@@ -1,5 +1,5 @@
 import { TransactionMeta } from '../types';
-import StorageManager from '../StorageManager';
+import { StorageManager } from '../StorageManager';
 export declare function pruneSharedStorage(storageManager: StorageManager): void;
 export declare function saveTransactionToSharedStorage(storageManager: StorageManager, state: string, meta: TransactionMeta): void;
 export declare function loadTransactionFromSharedStorage(storageManager: StorageManager, state: string): any;

package/lib/util/types.d.ts

@@ -13,4 +13,4 @@ export declare function isString(obj: any): obj is string;
 export declare function isObject(obj: any): obj is object;
 export declare function isNumber(obj: any): obj is number;
 export declare function isFunction(fn: any): fn is Function;
-export declare function isPromise(obj: any): boolean;
+export declare function isPromise(obj: any): any;

package/lib/util/url.d.ts

@@ -10,7 +10,7 @@
  * See the License for the specific language governing permissions and limitations under the License.
  */
 export declare function isAbsoluteUrl(url: any): boolean;
-export declare function toAbsoluteUrl(url: string, baseUrl: any): string;
-export declare function toRelativeUrl(url: string, baseUrl: any): string;
+export declare function toAbsoluteUrl(url: string | undefined, baseUrl: any): string;
+export declare function toRelativeUrl(url: string | undefined, baseUrl: any): string;
 export declare function toQueryString(obj: any): string;
 export declare function removeTrailingSlash(path: any): any;

package/package.json

@@ -2,7 +2,7 @@
   "private": false,
   "name": "@okta/okta-auth-js",
   "description": "The Okta Auth SDK",
-  "version": "5.10.0",
+  "version": "6.1.0",
   "homepage": "https://github.com/okta/okta-auth-js",
   "license": "Apache-2.0",
   "main": "cjs/index.js",
@@ -70,14 +70,15 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.12.5",
-    "@okta/okta-idx-js": "0.23.0",
+    "@babel/runtime-corejs3": "^7.17.0",
     "@peculiar/webcrypto": "1.1.6",
     "Base64": "1.1.0",
     "atob": "^2.1.2",
     "btoa": "^1.2.1",
     "core-js": "^3.6.5",
-    "cross-fetch": "^3.0.6",
+    "cross-fetch": "^3.1.5",
     "js-cookie": "2.2.1",
+    "jsonpath-plus": "^6.0.1",
     "node-cache": "^5.1.2",
     "p-cancelable": "^2.0.0",
     "text-encoding": "^0.7.0",
@@ -94,7 +95,7 @@
     "@babel/plugin-transform-typescript": "^7.10.5",
     "@babel/preset-env": "^7.8.2",
     "@babel/preset-typescript": "^7.10.4",
-    "@okta/okta-signin-widget": "5.13.0",
+    "@okta/okta-signin-widget": "6.0.0",
     "@rollup/plugin-alias": "^3.1.8",
     "@rollup/plugin-babel": "^5.3.0",
     "@rollup/plugin-replace": "^3.0.0",
@@ -109,7 +110,9 @@
     "chalk": "2.4.2",
     "cross-env": "^5.1.1",
     "eslint": "^7.1.0",
+    "eslint-import-resolver-typescript": "^2.5.0",
     "eslint-plugin-compat": "^3.3.0",
+    "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-jasmine": "^2.10.1",
     "eslint-plugin-jsdoc": "^25.4.2",
     "eslint-plugin-node": "^11.1.0",
@@ -169,8 +172,8 @@
     }
   },
   "okta": {
-    "commitSha": "4b2245069dc5dcc649fb4003d3fa5cb55db0ade5",
-    "fullVersion": "5.10.0-g4b22450",
-    "testedSha": "ba58fe6ea838ce2c9867271ea7b199cfffe41a59"
+    "commitSha": "1478c1930c4034d0033f5af740dc996cbe58ceb5",
+    "fullVersion": "6.1.0-g1478c19",
+    "testedSha": "fe1efe5ae03fe0fce892e1f2738f6fa3fa448c5a"
   }
 }

package/polyfill/index.js

@@ -14,6 +14,7 @@
 // Polyfills objects needed to support IE 11+
 require('core-js/features/object/assign');
 require('core-js/features/object/values');
+require('core-js/features/object/from-entries');
 require('core-js/es/promise');
 require('core-js/es/typed-array/uint8-array');
 require('core-js/features/array/from');

package/cjs/util/emailVerify.js

@@ -1,28 +0,0 @@
-"use strict";
-
-exports.isEmailVerifyCallback = isEmailVerifyCallback;
-exports.parseEmailVerifyCallback = parseEmailVerifyCallback;
-
-var _urlParams = require("../oidc/util/urlParams");
-
-/*!
- * Copyright (c) 2015-present, Okta, Inc. and/or its affiliates. All rights reserved.
- * The Okta software accompanied by this notice is provided pursuant to the Apache License, Version 2.0 (the "License.")
- *
- * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and limitations under the License.
- */
-// Check if state && stateTokenExternalId have been passed back in the url
-function isEmailVerifyCallback(urlPath) {
-  return /(stateTokenExternalId=)/i.test(urlPath) && /(state=)/i.test(urlPath);
-} // Parse state and stateTokenExternalId from a urlPath (should be either a search or fragment from the URL)
-
-
-function parseEmailVerifyCallback(urlPath) {
-  return (0, _urlParams.urlParamsToObject)(urlPath);
-}
-//# sourceMappingURL=emailVerify.js.map

package/cjs/util/emailVerify.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../lib/util/emailVerify.ts"],"names":["isEmailVerifyCallback","urlPath","test","parseEmailVerifyCallback"],"mappings":";;;;;AAaA;;AAZA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AASA;AACO,SAASA,qBAAT,CAAgCC,OAAhC,EAA0D;AAC/D,SAAO,2BAA2BC,IAA3B,CAAgCD,OAAhC,KAA4C,YAAYC,IAAZ,CAAiBD,OAAjB,CAAnD;AACD,C,CAED;;;AACO,SAASE,wBAAT,CAAkCF,OAAlC,EAAgF;AACrF,SAAO,kCAAkBA,OAAlB,CAAP;AACD","sourcesContent":["\n/*!\n * Copyright (c) 2015-present, Okta, Inc. and/or its affiliates. All rights reserved.\n * The Okta software accompanied by this notice is provided pursuant to the Apache License, Version 2.0 (the \"License.\")\n *\n * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT\n * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n *\n * See the License for the specific language governing permissions and limitations under the License.\n */\n\nimport { urlParamsToObject  } from '../oidc/util/urlParams';\n\nexport interface EmailVerifyCallbackResponse {\n  state: string;\n  stateTokenExternalId: string;\n}\n\n// Check if state && stateTokenExternalId have been passed back in the url\nexport function isEmailVerifyCallback (urlPath: string): boolean {\n  return /(stateTokenExternalId=)/i.test(urlPath) && /(state=)/i.test(urlPath);\n}\n\n// Parse state and stateTokenExternalId from a urlPath (should be either a search or fragment from the URL)\nexport function parseEmailVerifyCallback(urlPath: string): EmailVerifyCallbackResponse {\n  return urlParamsToObject(urlPath) as EmailVerifyCallbackResponse;\n}\n"],"file":"emailVerify.js"}