@forgerock/login-widget 1.2.0-beta.9 → 1.3.0

package/index.d.ts

@@ -1,16 +1,75 @@
-declare enum ActionTypes {
-    Authenticate = "AUTHENTICATE",
-    Authorize = "AUTHORIZE",
-    EndSession = "END_SESSION",
-    Logout = "LOGOUT",
-    ExchangeToken = "EXCHANGE_TOKEN",
-    RefreshToken = "REFRESH_TOKEN",
-    ResumeAuthenticate = "RESUME_AUTHENTICATE",
-    RevokeToken = "REVOKE_TOKEN",
-    StartAuthenticate = "START_AUTHENTICATE",
-    UserInfo = "USER_INFO"
+interface Identifiers {
+    [key: string]: string;
+}
+/**
+ * InitParams - Interface for the init method parameters
+ * envId: string - Required; the environment id from your PingOne tenant
+ * * - All other parameters are optional
+ */
+interface InitParams {
+    envId: string;
+    consoleLogEnabled?: boolean;
+    waitForWindowLoad?: boolean;
+    hubUrl?: string;
+    disableHub?: boolean;
+    deviceAttributesToIgnore?: string[];
+    lazyMetadata?: boolean;
+    behavioralDataCollection?: boolean;
+    disableTags?: boolean;
+    externalIdentifiers?: Identifiers;
+    deviceKeyRsyncIntervals?: number;
+    enableTrust?: boolean;
+}
+declare global {
+    interface Window {
+        _pingOneSignals: {
+            init: (initParams?: InitParams) => Promise<void>;
+            getData: () => Promise<string>;
+            pauseBehavioralData: () => void;
+            resumeBehavioralData: () => void;
+        };
+    }
+}
+/**
+ * @class PIProtect - Class to interact with the underlying PingOne Signals SDK
+ */
+declare abstract class PIProtect {
+    /**
+     * @method getData - Method to get the device data
+     * @returns {Promise<string>} - Returns the device data
+     */
+    static getData(): Promise<string>;
+    /**
+     * @method start - Method to initialize and start the PingOne Signals SDK
+     * @param {InitParams} options - The init parameters
+     * @returns {Promise<void>} - Returns a promise
+     */
+    static start(options: InitParams): Promise<void>;
+    /**
+     * @method pauseBehavioralData - Method to pause the behavioral data collection
+     * @returns {void}
+     * @description Pause the behavioral data collection only; device profile data will still be collected
+     */
+    static pauseBehavioralData(): void;
+    /**
+     * @method resumeBehavioralData - Method to resume the behavioral data collection
+     * @returns {void}
+     * @description Resume the behavioral data collection
+     */
+    static resumeBehavioralData(): void;
 }
 
+interface StringDict<T> {
+    [name: string]: T;
+}
+interface Tokens {
+    accessToken: string;
+    idToken?: string;
+    refreshToken?: string;
+    tokenExpiry?: number;
+}
+//# sourceMappingURL=interfaces.d.ts.map
+
 /**
  * Types of callbacks directly supported by the SDK.
  */
@@ -25,6 +84,8 @@ declare enum CallbackType {
     NameCallback = "NameCallback",
     NumberAttributeInputCallback = "NumberAttributeInputCallback",
     PasswordCallback = "PasswordCallback",
+    PingOneProtectEvaluationCallback = "PingOneProtectEvaluationCallback",
+    PingOneProtectInitializeCallback = "PingOneProtectInitializeCallback",
     PollingWaitCallback = "PollingWaitCallback",
     ReCaptchaCallback = "ReCaptchaCallback",
     RedirectCallback = "RedirectCallback",
@@ -37,16 +98,7 @@ declare enum CallbackType {
     ValidatedCreatePasswordCallback = "ValidatedCreatePasswordCallback",
     ValidatedCreateUsernameCallback = "ValidatedCreateUsernameCallback"
 }
-
-interface StringDict<T> {
-    [name: string]: T;
-}
-interface Tokens {
-    accessToken: string;
-    idToken?: string;
-    refreshToken?: string;
-    tokenExpiry?: number;
-}
+//# sourceMappingURL=enums.d.ts.map
 
 /**
  * Represents the authentication tree API payload schema.
@@ -75,13 +127,6 @@ interface StepDetail {
     failureUrl?: string;
     result?: boolean;
 }
-/**
- * Represents configuration overrides used when requesting the next
- * step in an authentication tree.
- */
-interface StepOptions extends ConfigOptions {
-    query?: StringDict<string>;
-}
 /**
  * Represents failed policies for a matching property.
  */
@@ -122,6 +167,7 @@ interface NameValue {
     name: string;
     value: unknown;
 }
+//# sourceMappingURL=interfaces.d.ts.map
 
 /**
  * Base class for authentication tree callback wrappers.
@@ -166,8 +212,23 @@ declare class FRCallback {
     getOutputByName<T>(name: string, defaultValue: T): T;
     private getArrayElement;
 }
+//# sourceMappingURL=index.d.ts.map
+
+type FRCallbackFactory = (callback: Callback) => FRCallback;//# sourceMappingURL=factory.d.ts.map
 
-type FRCallbackFactory = (callback: Callback) => FRCallback;
+declare enum ActionTypes {
+    Authenticate = "AUTHENTICATE",
+    Authorize = "AUTHORIZE",
+    EndSession = "END_SESSION",
+    Logout = "LOGOUT",
+    ExchangeToken = "EXCHANGE_TOKEN",
+    RefreshToken = "REFRESH_TOKEN",
+    ResumeAuthenticate = "RESUME_AUTHENTICATE",
+    RevokeToken = "REVOKE_TOKEN",
+    StartAuthenticate = "START_AUTHENTICATE",
+    UserInfo = "USER_INFO",
+    WellKnown = "WELL_KNOWN"
+}
 
 type LogLevel = 'none' | 'info' | 'warn' | 'error' | 'debug';
 interface Action {
@@ -200,6 +261,8 @@ interface ConfigOptions {
     oauthThreshold?: number;
     logLevel?: LogLevel;
     logger?: LoggerFunctions;
+    platformHeader?: boolean;
+    prefix?: string;
 }
 /**
  * Optional configuration for custom paths for actions
@@ -234,6 +297,13 @@ interface TokenStoreObject {
     set: (clientId: string, token: Tokens) => Promise<void>;
     remove: (clientId: string) => Promise<void>;
 }
+/**
+ * Represents configuration overrides used when requesting the next
+ * step in an authentication tree.
+ */
+interface StepOptions extends ConfigOptions {
+    query?: StringDict<string>;
+}//# sourceMappingURL=interfaces.d.ts.map
 
 /**
  * Types of steps returned by the authentication tree.
@@ -243,6 +313,7 @@ declare enum StepType {
     LoginSuccess = "LoginSuccess",
     Step = "Step"
 }
+//# sourceMappingURL=enums.d.ts.map
 
 /**
  * Base interface for all types of authentication step responses.
@@ -256,6 +327,7 @@ interface AuthResponse {
 interface FailureDetail {
     failureUrl?: string;
 }
+//# sourceMappingURL=interfaces.d.ts.map
 
 /**
  * Represents a single step of an authentication tree.
@@ -307,7 +379,7 @@ declare class FRStep implements AuthResponse {
      */
     getStage(): string | undefined;
     private convertCallbacks;
-}
+}//# sourceMappingURL=fr-step.d.ts.map
 
 declare type HandleStep = (step: FRStep) => Promise<FRStep>;
 /**
@@ -364,6 +436,7 @@ declare abstract class HttpClient {
     private static stepIterator;
     private static _request;
 }
+//# sourceMappingURL=index.d.ts.map
 
 declare function noop(): void;
 
@@ -417,7 +490,7 @@ declare class SvelteComponent {
 
 declare type Props = Record<string, any>;
 interface ComponentConstructorOptions<Props extends Record<string, any> = Record<string, any>> {
-    target: Element | Document | ShadowRoot;
+    target: Element | ShadowRoot;
     anchor?: Element;
     props?: Props;
     context?: Map<any, any>;
@@ -544,6 +617,16 @@ interface ComponentStoreValue {
     type: 'inline' | 'modal' | null;
 }
 
+/**
+ * Tokens returned after successful authentication.
+ */
+interface OAuth2Tokens {
+    accessToken: string;
+    idToken?: string;
+    refreshToken?: string;
+    tokenExpiry?: number;
+}//# sourceMappingURL=interfaces.d.ts.map
+
 interface MessageCreator {
     [key: string]: (propertyName: string, params?: {
         [key: string]: unknown;
@@ -553,72 +636,65 @@ interface ProcessedPropertyError {
     detail: FailedPolicyRequirement;
     messages: string[];
 }
+//# sourceMappingURL=interfaces.d.ts.map
 
-declare class FRLoginFailure implements AuthResponse {
+declare class FRLoginSuccess implements AuthResponse {
     payload: Step;
     /**
      * The type of step.
      */
-    readonly type = StepType.LoginFailure;
+    readonly type = StepType.LoginSuccess;
     /**
      * @param payload The raw payload returned by OpenAM
      */
     constructor(payload: Step);
     /**
-     * Gets the error code.
-     */
-    getCode(): number;
-    /**
-     * Gets the failure details.
-     */
-    getDetail(): FailureDetail | undefined;
-    /**
-     * Gets the failure message.
+     * Gets the step's realm.
      */
-    getMessage(): string | undefined;
+    getRealm(): string | undefined;
     /**
-     * Gets processed failure message.
+     * Gets the step's session token.
      */
-    getProcessedMessage(messageCreator?: MessageCreator): ProcessedPropertyError[];
+    getSessionToken(): string | undefined;
     /**
-     * Gets the failure reason.
+     * Gets the step's success URL.
      */
-    getReason(): string | undefined;
+    getSuccessUrl(): string | undefined;
 }
+//# sourceMappingURL=fr-login-success.d.ts.map
 
-declare class FRLoginSuccess implements AuthResponse {
+declare class FRLoginFailure implements AuthResponse {
     payload: Step;
     /**
      * The type of step.
      */
-    readonly type = StepType.LoginSuccess;
+    readonly type = StepType.LoginFailure;
     /**
      * @param payload The raw payload returned by OpenAM
      */
     constructor(payload: Step);
     /**
-     * Gets the step's realm.
+     * Gets the error code.
      */
-    getRealm(): string | undefined;
+    getCode(): number;
     /**
-     * Gets the step's session token.
+     * Gets the failure details.
      */
-    getSessionToken(): string | undefined;
+    getDetail(): FailureDetail | undefined;
     /**
-     * Gets the step's success URL.
+     * Gets the failure message.
      */
-    getSuccessUrl(): string | undefined;
-}
-
-/**
- * Tokens returned after successful authentication.
- */
-interface OAuth2Tokens {
-    accessToken: string;
-    idToken?: string;
-    refreshToken?: string;
-    tokenExpiry?: number;
+    getMessage(): string | undefined;
+    /**
+     * Gets processed failure message.
+     */
+    getProcessedMessage(messageCreator?: MessageCreator): ProcessedPropertyError[];
+    /**
+     * Gets the failure reason.
+     */
+    getReason(): string | undefined;
 }
+//# sourceMappingURL=fr-login-failure.d.ts.map
 
 type Maybe<T> = T | null | undefined;
 
@@ -670,9 +746,10 @@ interface JourneyStoreValue {
         callbacks: CallbackMetadata[];
         step: StepMetadata;
     } | null;
-    step: StepTypes;
+    step?: StepTypes;
     successful: boolean;
     response: Maybe<Step>;
+    recaptchaAction?: Maybe<string>;
 }
 interface StepMetadata {
     derived: {
@@ -709,7 +786,7 @@ declare namespace util {
     export const isInteger: NumberConstructor["isInteger"];
     export function joinValues<T extends any[]>(array: T, separator?: string): string;
     export const jsonStringifyReplacer: (_: string, value: any) => any;
-    export {};
+    export {  };
 }
 declare namespace objectUtil {
     export type MergeShapes<U, V> = {
@@ -731,7 +808,7 @@ declare namespace objectUtil {
     }>;
     export const mergeShapes: <U, T>(first: U, second: T) => T & U;
     export type extendShape<A, B> = flatten<Omit<A, keyof B> & B>;
-    export {};
+    export {  };
 }
 declare const ZodParsedType: {
     function: "function";
@@ -974,7 +1051,7 @@ declare namespace enumUtil {
     type UnionToTuple<T, Tuple extends unknown[] = []> = [T] extends [never] ? Tuple : UnionToTuple<Exclude<T, GetUnionLast<T>>, [GetUnionLast<T>, ...Tuple]>;
     type CastToStringTuple<T> = T extends [string, ...string[]] ? T : never;
     export type UnionToTupleString<T> = CastToStringTuple<UnionToTuple<T>>;
-    export {};
+    export {  };
 }
 
 declare namespace errorUtil {
@@ -1743,6 +1820,7 @@ declare const partialConfigSchema: ZodObject<{
         }[] | undefined;
     }>], ZodUnknown>, ZodType<FRCallback, ZodTypeDef, FRCallback>>>>;
     clientId: ZodOptional<ZodOptional<ZodString>>;
+    logLevel: ZodOptional<ZodOptional<ZodUnion<[ZodLiteral<"none">, ZodLiteral<"error">, ZodLiteral<"warn">, ZodLiteral<"info">, ZodLiteral<"debug">]>>>;
     middleware: ZodOptional<ZodOptional<ZodArray<ZodFunction<ZodTuple<[], ZodUnknown>, ZodUnknown>, "many">>>;
     realmPath: ZodOptional<ZodString>;
     redirectUri: ZodOptional<ZodOptional<ZodString>>;
@@ -1856,6 +1934,7 @@ declare const partialConfigSchema: ZodObject<{
         }[] | undefined;
     }, ...args_1: unknown[]) => FRCallback) | undefined;
     clientId?: string | undefined;
+    logLevel?: "none" | "error" | "info" | "warn" | "debug" | undefined;
     middleware?: ((...args: unknown[]) => unknown)[] | undefined;
     realmPath?: string | undefined;
     redirectUri?: string | undefined;
@@ -1901,6 +1980,7 @@ declare const partialConfigSchema: ZodObject<{
         }[] | undefined;
     }, ...args_1: unknown[]) => FRCallback) | undefined;
     clientId?: string | undefined;
+    logLevel?: "none" | "error" | "info" | "warn" | "debug" | undefined;
     middleware?: ((...args: unknown[]) => unknown)[] | undefined;
     realmPath?: string | undefined;
     redirectUri?: string | undefined;
@@ -2039,6 +2119,7 @@ declare const partialStringsSchema: ZodObject<{
     customSecurityQuestion: ZodOptional<ZodString>;
     dontGetLockedOut: ZodOptional<ZodString>;
     doesNotMeetMinimumCharacterLength: ZodOptional<ZodString>;
+    deviceName: ZodOptional<ZodString>;
     ensurePasswordIsMoreThan: ZodOptional<ZodString>;
     ensurePasswordHasOne: ZodOptional<ZodString>;
     enterVerificationCode: ZodOptional<ZodString>;
@@ -2060,11 +2141,14 @@ declare const partialStringsSchema: ZodObject<{
     minimumNumberOfUppercase: ZodOptional<ZodString>;
     minimumNumberOfSymbols: ZodOptional<ZodString>;
     nameCallback: ZodOptional<ZodString>;
+    nameYourDevice: ZodOptional<ZodString>;
     next: ZodOptional<ZodString>;
     nextButton: ZodOptional<ZodString>;
     notToExceedMaximumCharacterLength: ZodOptional<ZodString>;
     noLessThanMinimumCharacterLength: ZodOptional<ZodString>;
+    useOneOfTheseCodes: ZodOptional<ZodString>;
     onMobileOpenInAuthenticator: ZodOptional<ZodString>;
+    optionallyNameDevice: ZodOptional<ZodString>;
     passwordCallback: ZodOptional<ZodString>;
     passwordCannotContainCommonPasswords: ZodOptional<ZodString>;
     passwordCannotContainCommonPasswordsOrBeReversible: ZodOptional<ZodString>;
@@ -2093,6 +2177,8 @@ declare const partialStringsSchema: ZodObject<{
     shouldContainALowercase: ZodOptional<ZodString>;
     shouldContainASymbol: ZodOptional<ZodString>;
     showPassword: ZodOptional<ZodString>;
+    signalsEvaluation: ZodOptional<ZodString>;
+    skipButton: ZodOptional<ZodString>;
     sn: ZodOptional<ZodString>;
     submit: ZodOptional<ZodString>;
     submitButton: ZodOptional<ZodString>;
@@ -2115,6 +2201,7 @@ declare const partialStringsSchema: ZodObject<{
     validatedCreateUsernameCallback: ZodOptional<ZodString>;
     valueRequirements: ZodOptional<ZodString>;
     verifyYourIdentity: ZodOptional<ZodString>;
+    yourDevice: ZodOptional<ZodString>;
     yourMultiFactorAuthIsEnabled: ZodOptional<ZodString>;
     yourRecoveryCodesToAccessAccountForLostDevice: ZodOptional<ZodString>;
 }, "strict", ZodTypeAny, {
@@ -2137,6 +2224,7 @@ declare const partialStringsSchema: ZodObject<{
     customSecurityQuestion?: string | undefined;
     dontGetLockedOut?: string | undefined;
     doesNotMeetMinimumCharacterLength?: string | undefined;
+    deviceName?: string | undefined;
     ensurePasswordIsMoreThan?: string | undefined;
     ensurePasswordHasOne?: string | undefined;
     enterVerificationCode?: string | undefined;
@@ -2158,11 +2246,14 @@ declare const partialStringsSchema: ZodObject<{
     minimumNumberOfUppercase?: string | undefined;
     minimumNumberOfSymbols?: string | undefined;
     nameCallback?: string | undefined;
+    nameYourDevice?: string | undefined;
     next?: string | undefined;
     nextButton?: string | undefined;
     notToExceedMaximumCharacterLength?: string | undefined;
     noLessThanMinimumCharacterLength?: string | undefined;
+    useOneOfTheseCodes?: string | undefined;
     onMobileOpenInAuthenticator?: string | undefined;
+    optionallyNameDevice?: string | undefined;
     passwordCallback?: string | undefined;
     passwordCannotContainCommonPasswords?: string | undefined;
     passwordCannotContainCommonPasswordsOrBeReversible?: string | undefined;
@@ -2191,6 +2282,8 @@ declare const partialStringsSchema: ZodObject<{
     shouldContainALowercase?: string | undefined;
     shouldContainASymbol?: string | undefined;
     showPassword?: string | undefined;
+    signalsEvaluation?: string | undefined;
+    skipButton?: string | undefined;
     sn?: string | undefined;
     submit?: string | undefined;
     submitButton?: string | undefined;
@@ -2213,6 +2306,7 @@ declare const partialStringsSchema: ZodObject<{
     validatedCreateUsernameCallback?: string | undefined;
     valueRequirements?: string | undefined;
     verifyYourIdentity?: string | undefined;
+    yourDevice?: string | undefined;
     yourMultiFactorAuthIsEnabled?: string | undefined;
     yourRecoveryCodesToAccessAccountForLostDevice?: string | undefined;
 }, {
@@ -2235,6 +2329,7 @@ declare const partialStringsSchema: ZodObject<{
     customSecurityQuestion?: string | undefined;
     dontGetLockedOut?: string | undefined;
     doesNotMeetMinimumCharacterLength?: string | undefined;
+    deviceName?: string | undefined;
     ensurePasswordIsMoreThan?: string | undefined;
     ensurePasswordHasOne?: string | undefined;
     enterVerificationCode?: string | undefined;
@@ -2256,11 +2351,14 @@ declare const partialStringsSchema: ZodObject<{
     minimumNumberOfUppercase?: string | undefined;
     minimumNumberOfSymbols?: string | undefined;
     nameCallback?: string | undefined;
+    nameYourDevice?: string | undefined;
     next?: string | undefined;
     nextButton?: string | undefined;
     notToExceedMaximumCharacterLength?: string | undefined;
     noLessThanMinimumCharacterLength?: string | undefined;
+    useOneOfTheseCodes?: string | undefined;
     onMobileOpenInAuthenticator?: string | undefined;
+    optionallyNameDevice?: string | undefined;
     passwordCallback?: string | undefined;
     passwordCannotContainCommonPasswords?: string | undefined;
     passwordCannotContainCommonPasswordsOrBeReversible?: string | undefined;
@@ -2289,6 +2387,8 @@ declare const partialStringsSchema: ZodObject<{
     shouldContainALowercase?: string | undefined;
     shouldContainASymbol?: string | undefined;
     showPassword?: string | undefined;
+    signalsEvaluation?: string | undefined;
+    skipButton?: string | undefined;
     sn?: string | undefined;
     submit?: string | undefined;
     submitButton?: string | undefined;
@@ -2311,6 +2411,7 @@ declare const partialStringsSchema: ZodObject<{
     validatedCreateUsernameCallback?: string | undefined;
     valueRequirements?: string | undefined;
     verifyYourIdentity?: string | undefined;
+    yourDevice?: string | undefined;
     yourMultiFactorAuthIsEnabled?: string | undefined;
     yourRecoveryCodesToAccessAccountForLostDevice?: string | undefined;
 }>;
@@ -2318,6 +2419,7 @@ declare const partialStringsSchema: ZodObject<{
 declare const partialStyleSchema: ZodObject<{
     checksAndRadios: ZodOptional<ZodOptional<ZodUnion<[ZodLiteral<"animated">, ZodLiteral<"standard">]>>>;
     labels: ZodOptional<ZodOptional<ZodUnion<[ZodOptional<ZodLiteral<"floating">>, ZodLiteral<"stacked">]>>>;
+    showPassword: ZodOptional<ZodOptional<ZodUnion<[ZodLiteral<"none">, ZodLiteral<"button">, ZodLiteral<"checkbox">]>>>;
     logo: ZodOptional<ZodOptional<ZodObject<{
         dark: ZodOptional<ZodString>;
         height: ZodOptional<ZodNumber>;
@@ -2351,6 +2453,7 @@ declare const partialStyleSchema: ZodObject<{
 }, "strict", ZodTypeAny, {
     checksAndRadios?: "standard" | "animated" | undefined;
     labels?: "floating" | "stacked" | undefined;
+    showPassword?: "none" | "button" | "checkbox" | undefined;
     logo?: {
         dark?: string | undefined;
         height?: number | undefined;
@@ -2366,6 +2469,7 @@ declare const partialStyleSchema: ZodObject<{
 }, {
     checksAndRadios?: "standard" | "animated" | undefined;
     labels?: "floating" | "stacked" | undefined;
+    showPassword?: "none" | "button" | "checkbox" | undefined;
     logo?: {
         dark?: string | undefined;
         height?: number | undefined;
@@ -2392,6 +2496,7 @@ interface JourneyOptionsStart {
     forgerock?: StepOptions;
     journey?: string;
     resumeUrl?: string;
+    recaptchaAction?: string;
 }
 interface WidgetConfigOptions {
     forgerock?: TypeOf<typeof partialConfigSchema>;
@@ -2436,6 +2541,12 @@ declare const user: {
         subscribe: (this: void, run: Subscriber<OAuthTokenStoreValue>, invalidate?: ((value?: OAuthTokenStoreValue | undefined) => void) | undefined) => Unsubscriber;
     };
 };
+declare const protect: {
+    start: typeof PIProtect.start;
+    getData: typeof PIProtect.getData;
+    pauseBehavioralData: typeof PIProtect.pauseBehavioralData;
+    resumeBehavioralData: typeof PIProtect.resumeBehavioralData;
+};
 declare const __propDef: {
     props: {
         type?: "inline" | "modal" | undefined;
@@ -2451,4 +2562,4 @@ type IndexSlots = typeof __propDef.slots;
 declare class Index extends SvelteComponentTyped<IndexProps, IndexEvents, IndexSlots> {
 }
 
-export { IndexEvents, IndexProps, IndexSlots, component, configuration, Index as default, journey, request, user };
+export { type IndexEvents, type IndexProps, type IndexSlots, component, configuration, Index as default, journey, protect, request, user };