fixes some type declarations

OKTA-489428 <<<Jenkins Check-In of Tested SHA: 0d20151 for eng_productivity_ci_bot_okta@okta.com>>> Artifact: okta-auth-js Files changed count: 32 PR Link: "#1184"
okta · Apr 15, 2022 · 2a9db32 · 2a9db32
1 parent 4604b14
commit 2a9db32
Show file tree

Hide file tree

Showing 32 changed files with 402 additions and 388 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 ### Fixes
 
 - [#1182](https://github.com/okta/okta-auth-js/pull/1182) Fixes security question verification to accept `credentials.answer`
+- [#1184](https://github.com/okta/okta-auth-js/pull/1184) Fixes type declarations: `ApiError`, `responseType`, `responseMode`
 
 ## 6.4.2
 

diff --git a/lib/OktaAuth.ts b/lib/OktaAuth.ts
@@ -51,6 +51,7 @@ import {
   GetWithRedirectFunction,
   RequestOptions,
   IsAuthenticatedOptions,
+  OAuthResponseType,
 } from './types';
 import {
   transactionStatus,
@@ -729,7 +730,7 @@ class OktaAuth implements OktaAuthInterface, SigninAPI, SignoutAPI {
     return !!this.options.pkce;
   }
 
-  hasResponseType(responseType: string): boolean {
+  hasResponseType(responseType: OAuthResponseType): boolean {
     let hasResponseType = false;
     if (Array.isArray(this.options.responseType) && this.options.responseType.length) {
       hasResponseType = this.options.responseType.indexOf(responseType) >= 0;

diff --git a/lib/errors/AuthApiError.ts b/lib/errors/AuthApiError.ts
@@ -11,14 +11,14 @@
  */
 
 import CustomError from './CustomError';
-import { APIError, HttpResponse } from '../types';
+import { APIError, FieldError, HttpResponse } from '../types';
 
 export default class AuthApiError extends CustomError implements APIError {
   errorSummary: string;
   errorCode?: string;
   errorLink?: string;
   errorId?: string;
-  errorCauses?: string[];
+  errorCauses?: Array<FieldError>;
   xhr?: HttpResponse;
 
   constructor(err: APIError, xhr?: HttpResponse) {

diff --git a/lib/errors/AuthSdkError.ts b/lib/errors/AuthSdkError.ts
@@ -11,14 +11,14 @@
  */
 
 import CustomError from './CustomError';
-import { APIError } from '../types';
+import { APIError, FieldError } from '../types';
 
 export default class AuthSdkError extends CustomError implements APIError {
   errorSummary: string;
   errorCode: string;
   errorLink: string;
   errorId: string;
-  errorCauses: string[];
+  errorCauses: Array<FieldError>;
   xhr?: XMLHttpRequest;
 
   constructor(msg: string, xhr?: XMLHttpRequest) {

diff --git a/lib/idx/authenticate.ts b/lib/idx/authenticate.ts
@@ -13,29 +13,11 @@
 
 import { 
   OktaAuthInterface,
-  IdxOptions,
   IdxTransaction,
-  AuthenticatorKey
+  AuthenticatorKey,
+  AuthenticationOptions
 } from '../types';
 import { run } from './run';
-import { 
-  IdentifyValues,
-  SelectAuthenticatorAuthenticateValues,
-  ChallengeAuthenticatorValues,
-  ReEnrollAuthenticatorValues,
-  AuthenticatorEnrollmentDataValues,
-  SelectAuthenticatorEnrollValues,
-  EnrollAuthenticatorValues,
-} from './remediators';
-
-export type AuthenticationOptions = IdxOptions 
-  & IdentifyValues 
-  & SelectAuthenticatorAuthenticateValues 
-  & SelectAuthenticatorEnrollValues
-  & ChallengeAuthenticatorValues 
-  & ReEnrollAuthenticatorValues
-  & AuthenticatorEnrollmentDataValues
-  & EnrollAuthenticatorValues;
 
 export async function authenticate(
   authClient: OktaAuthInterface, options: AuthenticationOptions = {}

diff --git a/lib/idx/cancel.ts b/lib/idx/cancel.ts
@@ -10,12 +10,10 @@
  * See the License for the specific language governing permissions and limitations under the License.
  */
 
-import { OktaAuthInterface, IdxOptions, IdxTransactionMeta } from '../types';
+import { OktaAuthInterface, CancelOptions, IdxTransactionMeta } from '../types';
 import { run } from './run';
 import { getFlowSpecification } from './flow';
 
-export type CancelOptions = IdxOptions;
-
 export async function cancel (authClient: OktaAuthInterface, options?: CancelOptions) {
   const meta = authClient.transactionManager.load() as IdxTransactionMeta;
   const flowSpec = getFlowSpecification(authClient, meta.flow);

diff --git a/lib/idx/interact.ts b/lib/idx/interact.ts
@@ -11,29 +11,13 @@
  * See the License for the specific language governing permissions and limitations under the License.
  */
 /* eslint complexity:[0,8] */
-import { OktaAuthInterface, IdxTransactionMeta } from '../types';
+import { OktaAuthInterface, IdxTransactionMeta, InteractOptions, InteractResponse } from '../types';
 import { getSavedTransactionMeta, saveTransactionMeta } from './transactionMeta';
 import { getOAuthBaseUrl } from '../oidc';
 import { createTransactionMeta } from '.';
 import { removeNils } from '../util';
 import { httpRequest } from '../http';
 
-export interface InteractOptions {
-  withCredentials?: boolean;
-  state?: string;
-  scopes?: string[];
-  codeChallenge?: string;
-  codeChallengeMethod?: string;
-  activationToken?: string;
-  recoveryToken?: string;
-  clientSecret?: string;
-}
-
-export interface InteractResponse {
-  state?: string;
-  interactionHandle: string;
-  meta: IdxTransactionMeta;
-}
 
 /* eslint-disable camelcase */
 export interface InteractParams {
@@ -92,7 +76,7 @@ export async function interact (
   const url = `${baseUrl}/v1/interact`;
   const params = {
     client_id: clientId,
-    scope: scopes.join(' '),
+    scope: scopes!.join(' '),
     redirect_uri: redirectUri,
     code_challenge: codeChallenge,
     code_challenge_method: codeChallengeMethod,

diff --git a/lib/idx/introspect.ts b/lib/idx/introspect.ts
@@ -12,20 +12,13 @@
  */
 
 import { makeIdxState, validateVersionConfig } from './idxState';
-import { OktaAuthInterface } from '../types';
+import { IntrospectOptions, OktaAuthInterface } from '../types';
 import { IdxResponse, isRawIdxResponse } from './types/idx-js';
 import { getOAuthDomain } from '../oidc';
 import { IDX_API_VERSION } from '../constants';
 import { httpRequest } from '../http';
 import { isAuthApiError } from '../errors';
 
-export interface IntrospectOptions {
-  withCredentials?: boolean;
-  interactionHandle?: string;
-  stateHandle?: string;
-  version?: string;
-}
-
 export async function introspect (
   authClient: OktaAuthInterface, 
   options: IntrospectOptions = {}

diff --git a/lib/idx/proceed.ts b/lib/idx/proceed.ts
@@ -14,27 +14,12 @@
 import { 
   OktaAuthInterface,
   IdxTransaction,
+  ProceedOptions,
 } from '../types';
 import { run } from './run';
-import { AuthenticationOptions } from './authenticate';
-import {
-  EnrollPollValues as EnrollPollOptions,
-  SelectEnrollmentChannelValues as SelectEnrollmentChannelOptions
-} from './remediators';
-import { RegistrationOptions } from './register';
-import { PasswordRecoveryOptions } from './recoverPassword';
-import { AccountUnlockOptions } from './unlockAccount';
 import { getSavedTransactionMeta } from './transactionMeta';
 import { AuthSdkError } from '../errors';
 
-export type ProceedOptions = AuthenticationOptions
-  & RegistrationOptions
-  & PasswordRecoveryOptions
-  & AccountUnlockOptions
-  & EnrollPollOptions
-  & SelectEnrollmentChannelOptions
-  & { step?: string };
-
 export function canProceed(authClient: OktaAuthInterface, options: ProceedOptions = {}): boolean {
   const meta = getSavedTransactionMeta(authClient, options);
   return !!(meta || options.stateHandle);

diff --git a/lib/idx/recoverPassword.ts b/lib/idx/recoverPassword.ts
@@ -12,29 +12,13 @@
 
 
 import { run } from './run';
-import {
-  IdentifyValues,
-  SelectAuthenticatorAuthenticateValues,
-  ChallengeAuthenticatorValues,
-  AuthenticatorVerificationDataValues,
-  ResetAuthenticatorValues,
-  ReEnrollAuthenticatorValues,
-} from './remediators';
 import { getFlowSpecification } from './flow';
 import { 
   OktaAuthInterface, 
-  IdxOptions, 
+  PasswordRecoveryOptions, 
   IdxTransaction,
 } from '../types';
 
-export type PasswordRecoveryOptions = IdxOptions 
-  & IdentifyValues 
-  & SelectAuthenticatorAuthenticateValues 
-  & ChallengeAuthenticatorValues 
-  & ResetAuthenticatorValues
-  & AuthenticatorVerificationDataValues
-  & ReEnrollAuthenticatorValues;
-
 export async function recoverPassword(
   authClient: OktaAuthInterface, options: PasswordRecoveryOptions = {}
 ): Promise<IdxTransaction> {

diff --git a/lib/idx/register.ts b/lib/idx/register.ts
@@ -14,28 +14,14 @@
 import { run } from './run';
 import { hasSavedInteractionHandle } from './transactionMeta';
 import { startTransaction } from './startTransaction';
-import { 
-  EnrollProfileValues,
-  SelectAuthenticatorEnrollValues,
-  EnrollAuthenticatorValues,
-  AuthenticatorEnrollmentDataValues,
-  SkipValues,
-} from './remediators';
 import { AuthSdkError } from '../errors';
 import { 
-  IdxOptions, 
+  RegistrationOptions, 
   IdxTransaction, 
   OktaAuthInterface, 
   IdxFeature,
 } from '../types';
 
-export type RegistrationOptions = IdxOptions 
-  & EnrollProfileValues 
-  & SelectAuthenticatorEnrollValues 
-  & EnrollAuthenticatorValues 
-  & AuthenticatorEnrollmentDataValues 
-  & SkipValues;
-
 export async function register(
   authClient: OktaAuthInterface, options: RegistrationOptions = {}
 ): Promise<IdxTransaction> {

diff --git a/lib/idx/remediate.ts b/lib/idx/remediate.ts
@@ -14,8 +14,7 @@
 /* eslint-disable max-statements, max-depth, complexity */
 import { AuthSdkError } from '../errors';
 import { RemediationValues } from './remediators';
-import { FlowIdentifier, RemediationResponse } from './types';
-import { RemediationFlow } from './flow';
+import { RemediateOptions, RemediationResponse } from './types';
 import { 
   IdxResponse,
   IdxActionParams, 
@@ -35,13 +34,6 @@ export interface RemediateActionWithOptionalParams {
 }
 
 export type RemediateAction = string | RemediateActionWithOptionalParams;
-export interface RemediateOptions {
-  remediators?: RemediationFlow;
-  actions?: RemediateAction[];
-  flow?: FlowIdentifier;
-  step?: string;
-  shouldProceedWithEmailAuthenticator?: boolean; // will be removed in next major version
-}
 
 
 function getActionFromValues(values: RemediationValues, idxResponse: IdxResponse): string | undefined {

diff --git a/lib/idx/remediators/AuthenticatorVerificationData.ts b/lib/idx/remediators/AuthenticatorVerificationData.ts
@@ -14,8 +14,7 @@
 
 import { AuthSdkError } from '../../errors';
 import { AuthenticatorData, AuthenticatorDataValues } from './Base/AuthenticatorData';
-import { IdxRemediation } from '../types/idx-js';
-import { RemediateOptions } from '../remediate';
+import { IdxRemediation, RemediateOptions } from '../types';
 
 export type AuthenticatorVerificationDataValues = AuthenticatorDataValues;
 

diff --git a/lib/idx/remediators/Base/Remediator.ts b/lib/idx/remediators/Base/Remediator.ts
@@ -13,15 +13,15 @@
 
 
 /* eslint-disable complexity */
-import { NextStep, IdxMessage, Authenticator, Input, IdxOptions, RemediateOptions } from '../../types';
+import { NextStep, IdxMessage, Authenticator, Input, RemediateOptions } from '../../types';
 import { IdxAuthenticator, IdxRemediation, IdxContext } from '../../types/idx-js';
 import { getAllValues, getRequiredValues, titleCase, getAuthenticatorFromRemediation } from '../util';
 import { formatAuthenticator, compareAuthenticators } from '../../authenticator/util';
 
 // A map from IDX data values (server spec) to RemediationValues (client spec)
 export type IdxToRemediationValueMap = Record<string, string[]>;
 
-export interface RemediationValues extends IdxOptions {
+export interface RemediationValues {
   stateHandle?: string;
   authenticators?: (Authenticator | string)[];
   authenticator?: string | Authenticator;

diff --git a/lib/idx/remediators/EnrollmentChannelData.ts b/lib/idx/remediators/EnrollmentChannelData.ts
@@ -56,7 +56,7 @@ export class EnrollmentChannelData extends Remediator<EnrollmentChannelDataValue
     };
   }
 
-  getValuesAfterProceed() {
+  getValuesAfterProceed(): EnrollmentChannelDataValues {
     let trimmedValues = Object.keys(this.values).filter(valueKey => !['email', 'phoneNumber'].includes(valueKey));
     return trimmedValues.reduce((values, valueKey) => ({...values, [valueKey]: this.values[valueKey]}), {});
   }

diff --git a/lib/idx/remediators/SelectEnrollmentChannel.ts b/lib/idx/remediators/SelectEnrollmentChannel.ts
@@ -58,7 +58,7 @@ export class SelectEnrollmentChannel extends Remediator<SelectEnrollmentChannelV
     };
   }
 
-  getValuesAfterProceed() {
+  getValuesAfterProceed(): SelectEnrollmentChannelValues {
     let trimmedValues = Object.keys(this.values).filter(valueKey => valueKey !== 'channel');
     return trimmedValues.reduce((values, valueKey) => ({...values, [valueKey]: this.values[valueKey]}), {});
   }

diff --git a/lib/idx/run.ts b/lib/idx/run.ts
@@ -15,32 +15,23 @@
 /* eslint-disable max-statements, complexity, max-depth */
 import { interact } from './interact';
 import { introspect } from './introspect';
-import { remediate, RemediateOptions } from './remediate';
-import { getFlowSpecification, RemediationFlow } from './flow';
+import { remediate } from './remediate';
+import { getFlowSpecification } from './flow';
 import * as remediators from './remediators';
 import { 
   OktaAuthInterface,
   IdxStatus,
   IdxTransaction,
   IdxFeature,
   NextStep,
-  FlowIdentifier,
+  RunOptions,
   IdxTransactionMeta,
   Tokens,
   APIError,
 } from '../types';
 import { IdxMessage, IdxResponse, isIdxResponse } from './types/idx-js';
 import { getSavedTransactionMeta, saveTransactionMeta } from './transactionMeta';
-import { ProceedOptions } from './proceed';
 import { getAvailableSteps, getEnabledFeatures, getMessagesFromResponse, isTerminalResponse } from './util';
-
-export type RunOptions = ProceedOptions & RemediateOptions & {
-  flow?: FlowIdentifier;
-  remediators?: RemediationFlow;
-  actions?: string[];
-  withCredentials?: boolean;
-}
-
 declare interface RunData {
   options: RunOptions;
   values: remediators.RemediationValues;

diff --git a/lib/idx/startTransaction.ts b/lib/idx/startTransaction.ts
@@ -11,12 +11,12 @@
  */
 
 
-import { run, RunOptions } from './run';
-import { OktaAuthInterface, IdxTransaction } from '../types';
+import { run } from './run';
+import { OktaAuthInterface, IdxTransaction, StartOptions } from '../types';
 
 export async function startTransaction(
   authClient: OktaAuthInterface, 
-  options: RunOptions = {}
+  options: StartOptions = {}
 ): Promise<IdxTransaction> {
   // Clear IDX response cache and saved transaction meta (if any)
   authClient.transactionManager.clear();