@okta/okta-auth-js 6.5.3 → 6.6.2

package/lib/oidc/util/errors.d.ts

@@ -9,6 +9,7 @@
  *
  * See the License for the specific language governing permissions and limitations under the License.
  */
-import { OktaAuthInterface } from '../../types';
+import { OktaAuthOptionsInterface } from '../../types';
 export declare function isInteractionRequiredError(error: Error): boolean;
-export declare function isAuthorizationCodeError(sdk: OktaAuthInterface, error: Error): boolean | undefined;
+export declare function isAuthorizationCodeError(sdk: OktaAuthOptionsInterface, error: Error): boolean | undefined;
+export declare function isRefreshTokenInvalidError(error: unknown): boolean;

package/lib/oidc/util/loginRedirect.d.ts

@@ -10,21 +10,21 @@
  * See the License for the specific language governing permissions and limitations under the License.
  *
  */
-import { OktaAuthInterface, OktaAuthOptions } from '../../types';
+import { OktaAuthOptionsInterface, OktaAuthOptions } from '../../types';
 export declare function hasTokensInHash(hash: string): boolean;
 export declare function hasAuthorizationCode(hashOrSearch: string): boolean;
 export declare function hasInteractionCode(hashOrSearch: string): boolean;
 export declare function hasErrorInUrl(hashOrSearch: string): boolean;
-export declare function isRedirectUri(uri: string, sdk: OktaAuthInterface): boolean;
+export declare function isRedirectUri(uri: string, sdk: OktaAuthOptionsInterface): boolean;
 export declare function isCodeFlow(options: OktaAuthOptions): boolean;
 export declare function getHashOrSearch(options: OktaAuthOptions): string;
 /**
  * Check if tokens or a code have been passed back into the url, which happens in
  * the OIDC (including social auth IDP) redirect flow.
  */
-export declare function isLoginRedirect(sdk: OktaAuthInterface): boolean;
+export declare function isLoginRedirect(sdk: OktaAuthOptionsInterface): boolean;
 /**
  * Check if error=interaction_required has been passed back in the url, which happens in
  * the social auth IDP redirect flow.
  */
-export declare function isInteractionRequired(sdk: OktaAuthInterface, hashOrSearch?: string): boolean;
+export declare function isInteractionRequired(sdk: OktaAuthOptionsInterface, hashOrSearch?: string): boolean;

package/lib/oidc/util/oauth.d.ts

@@ -1,6 +1,6 @@
-import { OktaAuthInterface, CustomUrls } from '../../types';
+import { OktaAuthOptionsInterface, CustomUrls } from '../../types';
 export declare function generateState(): string;
 export declare function generateNonce(): string;
-export declare function getOAuthBaseUrl(sdk: OktaAuthInterface, options?: CustomUrls): any;
-export declare function getOAuthDomain(sdk: OktaAuthInterface, options?: CustomUrls): any;
-export declare function getOAuthUrls(sdk: OktaAuthInterface, options?: CustomUrls): CustomUrls;
+export declare function getOAuthBaseUrl(sdk: OktaAuthOptionsInterface, options?: CustomUrls): any;
+export declare function getOAuthDomain(sdk: OktaAuthOptionsInterface, options?: CustomUrls): any;
+export declare function getOAuthUrls(sdk: OktaAuthOptionsInterface, options?: CustomUrls): CustomUrls;

package/lib/oidc/util/oauthMeta.d.ts

@@ -1,2 +1,2 @@
-import { OAuthTransactionMeta, OktaAuthInterface, PKCETransactionMeta, TokenParams } from '../../types';
-export declare function createOAuthMeta(sdk: OktaAuthInterface, tokenParams: TokenParams): OAuthTransactionMeta | PKCETransactionMeta;
+import { OAuthTransactionMeta, OktaAuthOptionsInterface, PKCETransactionMeta, TokenParams } from '../../types';
+export declare function createOAuthMeta(sdk: OktaAuthOptionsInterface, tokenParams: TokenParams): OAuthTransactionMeta | PKCETransactionMeta;

package/lib/oidc/util/prepareTokenParams.d.ts

@@ -1,5 +1,5 @@
-import { OktaAuthInterface, TokenParams } from '../../types';
-export declare function assertPKCESupport(sdk: OktaAuthInterface): void;
-export declare function validateCodeChallengeMethod(sdk: OktaAuthInterface, codeChallengeMethod?: string): Promise<string>;
-export declare function preparePKCE(sdk: OktaAuthInterface, tokenParams: TokenParams): Promise<TokenParams>;
-export declare function prepareTokenParams(sdk: OktaAuthInterface, tokenParams?: TokenParams): Promise<TokenParams>;
+import { OktaAuthFeaturesInterface, OktaAuthOIDCInterface, TokenParams } from '../../types';
+export declare function assertPKCESupport(sdk: OktaAuthFeaturesInterface): void;
+export declare function validateCodeChallengeMethod(sdk: OktaAuthOIDCInterface, codeChallengeMethod?: string): Promise<string>;
+export declare function preparePKCE(sdk: OktaAuthOIDCInterface, tokenParams: TokenParams): Promise<TokenParams>;
+export declare function prepareTokenParams(sdk: OktaAuthOIDCInterface, tokenParams?: TokenParams): Promise<TokenParams>;

package/lib/oidc/util/validateClaims.d.ts

@@ -10,5 +10,5 @@
  * See the License for the specific language governing permissions and limitations under the License.
  *
  */
-import { OktaAuthInterface, TokenVerifyParams, UserClaims } from '../../types';
-export declare function validateClaims(sdk: OktaAuthInterface, claims: UserClaims, validationParams: TokenVerifyParams): void;
+import { OktaAuthOptionsInterface, TokenVerifyParams, UserClaims } from '../../types';
+export declare function validateClaims(sdk: OktaAuthOptionsInterface, claims: UserClaims, validationParams: TokenVerifyParams): void;

package/lib/oidc/verifyToken.d.ts

@@ -1,2 +1,2 @@
-import { IDToken, OktaAuthInterface, TokenVerifyParams } from '../types';
-export declare function verifyToken(sdk: OktaAuthInterface, token: IDToken, validationParams: TokenVerifyParams): Promise<IDToken>;
+import { IDToken, OktaAuthOIDCInterface, TokenVerifyParams } from '../types';
+export declare function verifyToken(sdk: OktaAuthOIDCInterface, token: IDToken, validationParams: TokenVerifyParams): Promise<IDToken>;

package/lib/tx/api.d.ts

@@ -10,10 +10,9 @@
  * See the License for the specific language governing permissions and limitations under the License.
  *
  */
-import { AuthTransaction } from './AuthTransaction';
 export declare function transactionStatus(sdk: any, args: any): Promise<any>;
 export declare function resumeTransaction(sdk: any, args: any): any;
-export declare function introspectAuthn(sdk: any, args: any): Promise<AuthTransaction>;
+export declare function introspectAuthn(sdk: any, args: any): Promise<any>;
 export declare function transactionStep(sdk: any, args: any): Promise<any>;
 export declare function transactionExists(sdk: any): boolean;
-export declare function postToTransaction(sdk: any, url: any, args: any, options?: any): Promise<AuthTransaction>;
+export declare function postToTransaction(sdk: any, url: any, args: any, options?: any): Promise<any>;

package/lib/types/OktaAuthOptions.d.ts

@@ -14,7 +14,7 @@ import { CookieOptions } from './Cookies';
 import { HttpRequestClient } from './http';
 import { AuthState } from './AuthState';
 import { TransactionManagerOptions } from './Transaction';
-import { IdxTransactionMeta } from '../idx/types';
+import { IdxTransactionMeta, RunOptions } from '../idx/types';
 import { ServiceManagerOptions } from './Service';
 import OktaAuth from '../OktaAuth';
 import { OAuthResponseMode, OAuthResponseType } from './OAuth';
@@ -86,6 +86,6 @@ export interface OktaAuthOptions extends CustomUrls, Pick<TokenParams, 'issuer'
     storageManager?: StorageManagerOptions;
     services?: ServiceManagerOptions;
     transactionManager?: TransactionManagerOptions;
-    idx?: Pick<IdxTransactionMeta, 'useGenericRemediator'>;
+    idx?: Pick<RunOptions, 'useGenericRemediator' | 'exchangeCodeForTokens'>;
     clientSecret?: string;
 }

package/lib/types/Service.d.ts

@@ -7,8 +7,8 @@ export interface ServiceInterface {
 }
 export interface ServiceManagerInterface {
     isLeader(): boolean;
-    start(): void;
-    stop(): void;
+    start(): Promise<void>;
+    stop(): Promise<void>;
     getService(name: string): ServiceInterface | undefined;
 }
 export interface AutoRenewServiceOptions {

package/lib/types/TokenManager.d.ts

@@ -19,4 +19,5 @@ export interface TokenManagerInterface {
     getStorageKeyByType(type: TokenType): string;
     add(key: any, token: Token): void;
     updateRefreshToken(token: RefreshToken): any;
+    removeRefreshToken(): void;
 }

package/lib/types/UserClaims.d.ts

@@ -15,7 +15,10 @@
  * ID Token or returned from the /userinfo response and depend on the
  * response_type and scope parameters in the authorize request
  */
-export declare type UserClaims<T = Record<string, string | boolean | number>> = T & {
+export declare type CustomUserClaimValue = string | boolean | number;
+export declare type CustomUserClaim = CustomUserClaimValue | Record<string, CustomUserClaimValue>;
+export declare type CustomUserClaims = Record<string, CustomUserClaim | CustomUserClaim[]>;
+export declare type UserClaims<T extends CustomUserClaims = CustomUserClaims> = T & {
     auth_time?: number;
     aud?: string;
     email?: string;

package/lib/types/api.d.ts

@@ -10,9 +10,10 @@
  * See the License for the specific language governing permissions and limitations under the License.
  */
 import { AuthTransaction } from '../tx/AuthTransaction';
+import { TransactionState } from '../tx/TransactionState';
 import { Token, Tokens, RevocableToken, AccessToken, IDToken, RefreshToken } from './Token';
 import { JWTObject } from './JWT';
-import { UserClaims } from './UserClaims';
+import { CustomUserClaims, UserClaims } from './UserClaims';
 import { CustomUrls, OktaAuthOptions, TokenParams } from './OktaAuthOptions';
 import { StorageManager } from '../StorageManager';
 import TransactionManager from '../TransactionManager';
@@ -21,18 +22,34 @@ import { ServiceManagerInterface } from './Service';
 import { OktaUserAgent } from '../OktaUserAgent';
 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 {
+import { RequestData, RequestOptions } from './http';
+import { IdxToPersist, RawIdxResponse } from '../idx/types/idx-js';
+export interface OktaAuthOptionsInterface {
     options: OktaAuthOptions;
     getIssuerOrigin(): string;
-    getOriginalUri(): string | undefined;
-    _oktaUserAgent: OktaUserAgent;
+}
+export interface OktaAuthStorageInterface {
     storageManager: StorageManager;
+}
+export interface OktaAuthHttpInterface extends OktaAuthOptionsInterface, OktaAuthStorageInterface {
+    _oktaUserAgent: OktaUserAgent;
+}
+export interface OktaAuthFeaturesInterface {
+    features: FeaturesAPI;
+}
+export interface OktaAuthTransactionInterface {
     transactionManager: TransactionManager;
+}
+export interface OktaAuthOIDCInterface extends OktaAuthOptionsInterface, OktaAuthHttpInterface, OktaAuthFeaturesInterface, OktaAuthTransactionInterface {
+    token: TokenAPI;
     tokenManager: TokenManagerInterface;
-    serviceManager: ServiceManagerInterface;
+}
+export interface OktaAuthIdxInterface extends OktaAuthHttpInterface, OktaAuthTransactionInterface, Pick<OktaAuthOIDCInterface, 'token'> {
     idx: IdxAPI;
-    features: FeaturesAPI;
-    token: TokenAPI;
+}
+export interface OktaAuthInterface extends OktaAuthOptionsInterface, OktaAuthStorageInterface, OktaAuthFeaturesInterface, OktaAuthHttpInterface, OktaAuthTransactionInterface, OktaAuthIdxInterface, OktaAuthOIDCInterface {
+    getOriginalUri(): string | undefined;
+    serviceManager: ServiceManagerInterface;
 }
 export interface FieldError {
     errorSummary: string;
@@ -60,6 +77,8 @@ export interface TransactionAPI {
     status: (args?: object) => Promise<object>;
     resume: (args?: object) => Promise<AuthTransaction>;
     introspect: (args?: object) => Promise<AuthTransaction>;
+    createTransaction: (res?: TransactionState) => AuthTransaction;
+    postToTransaction: (url: string, args?: RequestData, options?: RequestOptions) => Promise<AuthTransaction>;
 }
 export interface FingerprintOptions {
     timeout?: number;
@@ -106,7 +125,7 @@ export interface BaseTokenAPI {
     exchangeCodeForTokens(params: TokenParams, urls?: CustomUrls): Promise<TokenResponse>;
 }
 export interface TokenAPI extends BaseTokenAPI {
-    getUserInfo(accessToken?: AccessToken, idToken?: IDToken): Promise<UserClaims>;
+    getUserInfo<S extends CustomUserClaims = CustomUserClaims>(accessToken?: AccessToken, idToken?: IDToken): Promise<UserClaims<S>>;
     getWithRedirect: GetWithRedirectAPI;
     parseFromUrl: ParseFromUrlInterface;
     getWithoutPrompt(params?: TokenParams): Promise<TokenResponse>;
@@ -202,6 +221,7 @@ export interface PkceAPI {
 export interface IdxAPI {
     interact: (options?: InteractOptions) => Promise<InteractResponse>;
     introspect: (options?: IntrospectOptions) => Promise<IdxResponse>;
+    makeIdxResponse: (rawIdxResponse: RawIdxResponse, toPersist: IdxToPersist, requestDidSucceed: boolean) => IdxResponse;
     authenticate: (options?: AuthenticationOptions) => Promise<IdxTransaction>;
     register: (options?: IdxRegistrationOptions) => Promise<IdxTransaction>;
     recoverPassword: (options?: PasswordRecoveryOptions) => Promise<IdxTransaction>;

package/package.json

@@ -2,7 +2,7 @@
   "private": false,
   "name": "@okta/okta-auth-js",
   "description": "The Okta Auth SDK",
-  "version": "6.5.3",
+  "version": "6.6.2",
   "homepage": "https://github.com/okta/okta-auth-js",
   "license": "Apache-2.0",
   "main": "cjs/index.js",
@@ -33,7 +33,6 @@
     "dev:esm": "NODE_ENV=development yarn build:esm --watch",
     "dev:web": "cross-env NODE_ENV=development webpack --config webpack.config.js --watch",
     "lint": "eslint --ext .js,.ts,.jsx .",
-    "tsd": "tsd",
     "lint:report": "eslint -f checkstyle -o ./build2/reports/lint/eslint-checkstyle-result.xml .",
     "validate": "yarn tsc --noEmit && yarn lint && yarn workspace @okta/test.app validate && yarn tsd",
     "test": "yarn test:unit && yarn test:samples && yarn test:e2e",
@@ -50,6 +49,7 @@
     "test:bundle:esm:browser": "cross-env BUNDLE_ENV=browser NODE_OPTIONS=--experimental-vm-modules jest --config ./jest.esm.mjs",
     "test:bundle:esm:node": "cross-env BUNDLE_ENV=node NODE_OPTIONS=--experimental-vm-modules jest --config ./jest.esm.mjs",
     "test:bundle:cjs": "cross-env BUNDLE_ENV=node jest --config ./jest.cjs.js",
+    "test:types": "jest --config ./jest.tsd.js --runInBand",
     "build": "node scripts/build.js",
     "build:cdn": "cross-env NODE_ENV=production webpack --config webpack.cdn.config.js",
     "build:web": "cross-env NODE_ENV=production webpack --config webpack.config.js",
@@ -89,7 +89,7 @@
     "@peculiar/webcrypto": "1.1.6",
     "Base64": "1.1.0",
     "atob": "^2.1.2",
-    "broadcast-channel": "^4.10.0",
+    "broadcast-channel": "^4.13.0",
     "btoa": "^1.2.1",
     "core-js": "^3.6.5",
     "cross-fetch": "^3.1.5",
@@ -116,7 +116,8 @@
     "@rollup/plugin-alias": "^3.1.8",
     "@rollup/plugin-babel": "^5.3.0",
     "@rollup/plugin-replace": "^3.0.0",
-    "@types/jest": "^27.4.0",
+    "@tsd/typescript": "^4.6.4",
+    "@types/jest": "^27.5.1",
     "@types/node": "^14.0.3",
     "@typescript-eslint/eslint-plugin": "^5.18.0",
     "@typescript-eslint/parser": "^5.18.0",
@@ -136,8 +137,11 @@
     "globby": "^6.1.0",
     "istanbul-instrumenter-loader": "^3.0.1",
     "jasmine-ajax": "^4.0.0",
-    "jest": "^27.5.1",
+    "jest": "^28.1.0",
+    "jest-environment-jsdom": "^28.1.0",
     "jest-junit": "^13.0.0",
+    "jest-runner": "^28.1.0",
+    "jest-runner-tsd": "^3.0.0",
     "json-loader": "0.5.4",
     "lodash": "4.17.20",
     "rollup": "^2.59.0",
@@ -145,7 +149,7 @@
     "rollup-plugin-license": "^2.6.0",
     "rollup-plugin-typescript2": "^0.30.0",
     "shelljs": "0.8.4",
-    "ts-jest": "^27.1.3",
+    "ts-jest": "^28.0.2",
     "tsd": "^0.17.0",
     "typescript": "^4.2.3",
     "webpack": "^5.60.0",
@@ -171,24 +175,10 @@
     ]
   },
   "tsd": {
-    "directory": "test/types",
-    "compilerOptions": {
-      "skipLibCheck": true,
-      "types": [
-        "node"
-      ],
-      "lib": [
-        "dom"
-      ],
-      "paths": {
-        "@okta/okta-auth-js": [
-          "./build"
-        ]
-      }
-    }
+    "directory": "test/types"
   },
   "okta": {
-    "commitSha": "4536ba03ea316149d697bb9229260499e9f37e17",
-    "fullVersion": "6.5.3-g4536ba0"
+    "commitSha": "877bcc3ff0ff348a2292ddb45b73ed781eefa791",
+    "fullVersion": "6.6.2-g877bcc3"
   }
 }