@okta/okta-auth-js 7.4.3 → 7.5.0

package/types/lib/idx/types/api.d.ts

@@ -10,7 +10,7 @@
  * See the License for the specific language governing permissions and limitations under the License.
  */
 import { APIError } from '../../errors/types';
-import { OktaAuthOAuthInterface, Tokens, TransactionManagerConstructor, TransactionManagerInterface } from '../../oidc/types';
+import { OktaAuthOAuthInterface, MinimalOktaOAuthInterface, Tokens, TransactionManagerConstructor, TransactionManagerInterface } from '../../oidc/types';
 import { FlowIdentifier } from './FlowIdentifier';
 import { IdxActions, IdxAuthenticator, IdxContext, IdxForm, IdxMessage, IdxOption, IdxRemediation, IdxResponse, RawIdxResponse, IdxActionParams, IdpConfig, IdxToPersist, ChallengeData, ActivationData } from './idx-js';
 import { AccountUnlockOptions, AuthenticationOptions, CancelOptions, InteractOptions, IntrospectOptions, OktaAuthIdxOptions, PasswordRecoveryOptions, ProceedOptions, RegistrationOptions, StartOptions, IdxTransactionMetaOptions } from './options';
@@ -120,6 +120,19 @@ export interface EmailVerifyCallbackResponse {
     state: string;
     otp: string;
 }
+export interface MinimalIdxAPI {
+    makeIdxResponse: (rawIdxResponse: RawIdxResponse, toPersist: IdxToPersist, requestDidSucceed: boolean) => IdxResponse;
+    start: (options?: StartOptions) => Promise<IdxTransaction>;
+    canProceed(options?: ProceedOptions): boolean;
+    proceed: (options?: ProceedOptions) => Promise<IdxTransaction>;
+    startTransaction: (options?: StartOptions) => Promise<IdxTransaction>;
+    getSavedTransactionMeta: (options?: IdxTransactionMetaOptions) => IdxTransactionMeta | undefined;
+    createTransactionMeta: (options?: IdxTransactionMetaOptions) => Promise<IdxTransactionMeta>;
+    getTransactionMeta: (options?: IdxTransactionMetaOptions) => Promise<IdxTransactionMeta>;
+    saveTransactionMeta: (meta: unknown) => void;
+    clearTransactionMeta: () => void;
+    isTransactionMetaValid: (meta: unknown) => boolean;
+}
 export interface IdxAPI {
     interact: (options?: InteractOptions) => Promise<InteractResponse>;
     introspect: (options?: IntrospectOptions) => Promise<IdxResponse>;
@@ -165,7 +178,10 @@ export interface WebauthnAPI {
 export interface OktaAuthIdxInterface<M extends IdxTransactionMeta = IdxTransactionMeta, S extends IdxStorageManagerInterface<M> = IdxStorageManagerInterface<M>, O extends OktaAuthIdxOptions = OktaAuthIdxOptions, TM extends IdxTransactionManagerInterface = IdxTransactionManagerInterface> extends OktaAuthOAuthInterface<M, S, O, TM> {
     idx: IdxAPI;
 }
-export interface OktaAuthIdxConstructor<I extends OktaAuthIdxInterface = OktaAuthIdxInterface> extends OktaAuthConstructor<I> {
+export interface MinimalOktaAuthIdxInterface<M extends IdxTransactionMeta = IdxTransactionMeta, S extends IdxStorageManagerInterface<M> = IdxStorageManagerInterface<M>, O extends OktaAuthIdxOptions = OktaAuthIdxOptions, TM extends IdxTransactionManagerInterface = IdxTransactionManagerInterface> extends MinimalOktaOAuthInterface<M, S, O, TM> {
+    idx: MinimalIdxAPI;
+}
+export interface OktaAuthIdxConstructor<I extends MinimalOktaAuthIdxInterface = OktaAuthIdxInterface> extends OktaAuthConstructor<I> {
     new (...args: any[]): I;
     webauthn: WebauthnAPI;
 }

package/types/lib/idx/types/index.d.ts

@@ -14,6 +14,7 @@ export * from './options';
 export type { IdxMessage, IdxMessages, ChallengeData, ActivationData, IdxResponse, IdxContext, RawIdxResponse, IdxRemediation, IdxAuthenticator, IdxActionParams, IdxContextUIDisplay, } from './idx-js';
 export * from './meta';
 export type { FlowIdentifier } from './FlowIdentifier';
+export type { FlowSpecification } from './FlowSpecification';
 export type { WebauthnEnrollValues } from '../authenticator/WebauthnEnrollment';
 export type { WebauthnVerificationValues } from '../authenticator/WebauthnVerification';
 export * from './storage';

package/types/lib/idx/util.d.ts

@@ -1,6 +1,13 @@
-import { RemediationValues, Remediator } from './remediators';
-import { OktaAuthIdxInterface, IdxFeature, NextStep, RemediateOptions, RemediationResponse, RunOptions } from './types';
+import { RemediationValues, Remediator, RemediatorConstructor } from './remediators';
+import { OktaAuthIdxInterface, IdxFeature, NextStep, RemediateOptions, RemediationResponse, RunOptions, FlowIdentifier, FlowSpecification } from './types';
 import { IdxMessage, IdxRemediationValue, IdxResponse } from './types/idx-js';
+declare type GetFlowSpecification = (oktaAuth: OktaAuthIdxInterface, flow: FlowIdentifier) => FlowSpecification;
+declare const ctx: {
+    remediators: Record<string, RemediatorConstructor>;
+    getFlowSpecification: GetFlowSpecification;
+};
+export declare function setRemediatorsCtx(newCtx: Partial<typeof ctx>): void;
+export declare function getFlowSpecification(oktaAuth: OktaAuthIdxInterface, flow?: FlowIdentifier): FlowSpecification;
 export declare function isTerminalResponse(idxResponse: IdxResponse): boolean;
 export declare function canSkipFn(idxResponse: IdxResponse): boolean;
 export declare function canResendFn(idxResponse: IdxResponse): boolean;
@@ -12,3 +19,4 @@ export declare function filterValuesForRemediation(idxResponse: IdxResponse, rem
 export declare function getRemediator(idxResponse: IdxResponse, values: RemediationValues, options: RemediateOptions): Remediator | undefined;
 export declare function getNextStep(authClient: OktaAuthIdxInterface, remediator: Remediator, idxResponse: IdxResponse): NextStep;
 export declare function handleFailedResponse(authClient: OktaAuthIdxInterface, idxResponse: IdxResponse, options?: {}): RemediationResponse;
+export {};

package/types/lib/myaccount/emailApi.d.ts

@@ -1,4 +1,5 @@
-import { IAPIFunction, BaseTransaction, EmailTransaction, EmailChallengeTransaction } from './types';
+import { IAPIFunction } from './types';
+import { BaseTransaction, EmailTransaction, EmailChallengeTransaction } from './transactions';
 /**
  * @scope: okta.myAccount.email.read
  */

package/types/lib/myaccount/passwordApi.d.ts

@@ -1,4 +1,5 @@
-import { IAPIFunction, BaseTransaction, PasswordTransaction } from './types';
+import { IAPIFunction } from './types';
+import { BaseTransaction, PasswordTransaction } from './transactions';
 /**
  * @scope: okta.myAccount.password.read
  */

package/types/lib/myaccount/phoneApi.d.ts

@@ -1,4 +1,5 @@
-import { IAPIFunction, BaseTransaction, PhoneTransaction } from './types';
+import { IAPIFunction } from './types';
+import { BaseTransaction, PhoneTransaction } from './transactions';
 /**
  * @scope: okta.myAccount.phone.read
  */

package/types/lib/myaccount/profileApi.d.ts

@@ -1,4 +1,5 @@
-import { IAPIFunction, ProfileTransaction, ProfileSchemaTransaction } from './types';
+import { IAPIFunction } from './types';
+import { ProfileTransaction, ProfileSchemaTransaction } from './transactions';
 /**
  * @scope: okta.myAccount.profile.read
  */

package/types/lib/myaccount/request.d.ts

@@ -1,29 +1,17 @@
-import { BaseTransaction } from './transactions';
+import { default as BaseTransaction, TransactionType, TransactionLinks } from './transactions/Base';
 import { MyAccountRequestOptions as RequestOptions } from './types';
 import { OktaAuthOAuthInterface } from '../oidc/types';
-export declare type TransactionLink = {
-    href: string;
-    hints?: {
-        allow?: string[];
-    };
-};
-declare type TransactionLinks = {
-    self: TransactionLink;
-    [property: string]: TransactionLink;
-};
 declare type SendRequestOptions = RequestOptions & {
     url: string;
     method: string;
-    transactionClassName?: string;
 };
-export declare function sendRequest<T extends BaseTransaction>(oktaAuth: OktaAuthOAuthInterface, options: SendRequestOptions): Promise<T | T[]>;
+export declare function sendRequest<T extends BaseTransaction = BaseTransaction, N extends 'plural' | 'single' = 'single', NT = N extends 'plural' ? T[] : T>(oktaAuth: OktaAuthOAuthInterface, options: SendRequestOptions, TransactionClass?: TransactionType<T>): Promise<NT>;
 export declare type GenerateRequestFnFromLinksOptions = {
     oktaAuth: OktaAuthOAuthInterface;
     accessToken: string;
     methodName: string;
     links: TransactionLinks;
-    transactionClassName?: string;
 };
-declare type IRequestFnFromLinks = <T extends BaseTransaction>(payload?: any) => Promise<T | T[]>;
-export declare function generateRequestFnFromLinks({ oktaAuth, accessToken, methodName, links, transactionClassName }: GenerateRequestFnFromLinksOptions): IRequestFnFromLinks;
+declare type IRequestFnFromLinks<T extends BaseTransaction> = (payload?: any) => Promise<T>;
+export declare function generateRequestFnFromLinks<T extends BaseTransaction>({ oktaAuth, accessToken, methodName, links, }: GenerateRequestFnFromLinksOptions, TransactionClass?: TransactionType<T>): IRequestFnFromLinks<T>;
 export {};

package/types/lib/myaccount/transactions/Base.d.ts

@@ -1,5 +1,14 @@
 import { OktaAuthHttpInterface } from '../../http/types';
-import { TransactionLink } from '../request';
+export declare type TransactionLink = {
+    href: string;
+    hints?: {
+        allow?: string[];
+    };
+};
+export declare type TransactionLinks = {
+    self: TransactionLink;
+    [property: string]: TransactionLink;
+};
 declare type TransactionOptions = {
     res: {
         headers: Record<string, string>;
@@ -12,4 +21,8 @@ export default class BaseTransaction {
     headers?: Record<string, string>;
     constructor(oktaAuth: OktaAuthHttpInterface, options: TransactionOptions);
 }
+export interface TransactionType<T extends BaseTransaction = BaseTransaction> extends Function {
+    new (oktaAuth: OktaAuthHttpInterface, options: TransactionOptions): T;
+    prototype: T;
+}
 export {};

package/types/lib/myaccount/transactions/EmailTransaction.d.ts

@@ -1,4 +1,5 @@
-import { EmailChallengeTransaction, EmailStatusTransaction } from '.';
+import EmailChallengeTransaction from './EmailChallengeTransaction';
+import EmailStatusTransaction from './EmailStatusTransaction';
 import { EmailProfile, EmailRole, Status, VerificationPayload } from '../types';
 import BaseTransaction from './Base';
 export default class EmailTransaction extends BaseTransaction {

package/types/lib/myaccount/types.d.ts

@@ -1,5 +1,5 @@
 import { OAuthStorageManagerInterface, OAuthTransactionMeta, OktaAuthOAuthInterface, OktaAuthOAuthOptions, PKCETransactionMeta } from '../oidc/types';
-export { EmailTransaction, EmailStatusTransaction, EmailChallengeTransaction, PhoneTransaction, ProfileTransaction, ProfileSchemaTransaction, PasswordTransaction, BaseTransaction } from './transactions';
+export type { EmailTransaction, EmailStatusTransaction, EmailChallengeTransaction, PhoneTransaction, ProfileTransaction, ProfileSchemaTransaction, PasswordTransaction, BaseTransaction } from './transactions';
 export declare enum EmailRole {
     PRIMARY = "PRIMARY",
     SECONDARY = "SECONDARY"

package/types/lib/oidc/factory/baseApi.d.ts

@@ -0,0 +1,14 @@
+/*!
+ * 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.
+ *
+ */
+import { OktaAuthOAuthInterface, BaseTokenAPI } from '../types';
+export declare function createBaseTokenAPI(sdk: OktaAuthOAuthInterface): BaseTokenAPI;

package/types/lib/oidc/mixin/minimal.d.ts

@@ -0,0 +1,4 @@
+import { OktaAuthConstructor } from '../../base/types';
+import { OAuthStorageManagerInterface, OAuthTransactionMeta, MinimalOktaOAuthInterface, OktaAuthOAuthOptions, PKCETransactionMeta, TransactionManagerInterface, TransactionManagerConstructor } from '../types';
+import { OktaAuthSessionInterface } from '../../session/types';
+export declare function mixinMinimalOAuth<M extends OAuthTransactionMeta = PKCETransactionMeta, S extends OAuthStorageManagerInterface<M> = OAuthStorageManagerInterface<M>, O extends OktaAuthOAuthOptions = OktaAuthOAuthOptions, TM extends TransactionManagerInterface = TransactionManagerInterface, TBase extends OktaAuthConstructor<OktaAuthSessionInterface<S, O>> = OktaAuthConstructor<OktaAuthSessionInterface<S, O>>>(Base: TBase, TransactionManagerConstructor: TransactionManagerConstructor<TM>): TBase & OktaAuthConstructor<MinimalOktaOAuthInterface<M, S, O, TM>>;

package/types/lib/oidc/types/api.d.ts

@@ -99,6 +99,13 @@ export interface OriginalUriApi {
     setOriginalUri(originalUri: string, state?: string): void;
     removeOriginalUri(state?: string): void;
 }
+export interface MinimalOktaOAuthInterface<M extends OAuthTransactionMeta = PKCETransactionMeta, S extends OAuthStorageManagerInterface<M> = OAuthStorageManagerInterface<M>, O extends OktaAuthOAuthOptions = OktaAuthOAuthOptions, TM extends TransactionManagerInterface = TransactionManagerInterface> extends OktaAuthSessionInterface<S, O> {
+    token: BaseTokenAPI;
+    transactionManager: TM;
+    isPKCE(): boolean;
+    isLoginRedirect(): boolean;
+    isAuthorizationCodeFlow(): boolean;
+}
 export interface OktaAuthOAuthInterface<M extends OAuthTransactionMeta = PKCETransactionMeta, S extends OAuthStorageManagerInterface<M> = OAuthStorageManagerInterface<M>, O extends OktaAuthOAuthOptions = OktaAuthOAuthOptions, TM extends TransactionManagerInterface = TransactionManagerInterface> extends OktaAuthSessionInterface<S, O>, OriginalUriApi {
     token: TokenAPI;
     tokenManager: TokenManagerInterface;
@@ -112,6 +119,7 @@ export interface OktaAuthOAuthInterface<M extends OAuthTransactionMeta = PKCETra
     isAuthenticated(options?: IsAuthenticatedOptions): Promise<boolean>;
     signOut(opts?: SignoutOptions): Promise<boolean>;
     isLoginRedirect(): boolean;
+    isAuthorizationCodeFlow(): boolean;
     storeTokensFromRedirect(): Promise<void>;
     getUser<T extends CustomUserClaims = CustomUserClaims>(): Promise<UserClaims<T>>;
     signInWithRedirect(opts?: SigninWithRedirectOptions): Promise<void>;

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

@@ -10,13 +10,14 @@
  * See the License for the specific language governing permissions and limitations under the License.
  *
  */
-import { OktaAuthOAuthOptions, OktaAuthOAuthInterface } from '../types';
+import { OktaAuthOAuthOptions, OktaAuthOAuthInterface, OAuthResponseType } 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: OktaAuthOAuthInterface): boolean;
 export declare function isCodeFlow(options: OktaAuthOAuthOptions): boolean;
+export declare function hasResponseType(responseType: OAuthResponseType, options: OktaAuthOAuthOptions): boolean;
 export declare function getHashOrSearch(options: OktaAuthOAuthOptions): string;
 /**
  * Check if tokens or a code have been passed back into the url, which happens in