@forgerock/login-widget 1.0.0-beta.4 → 1.0.0-beta.6

package/{inline.d.ts → index.d.ts}

@@ -1,13 +1,3 @@
-interface StringDict<T> {
-    [name: string]: T;
-}
-interface Tokens {
-    accessToken: string;
-    idToken?: string;
-    refreshToken?: string;
-    tokenExpiry?: number;
-}
-
 declare enum ActionTypes {
     Authenticate = "AUTHENTICATE",
     Authorize = "AUTHORIZE",
@@ -21,6 +11,16 @@ declare enum ActionTypes {
     UserInfo = "USER_INFO"
 }
 
+interface StringDict<T> {
+    [name: string]: T;
+}
+interface Tokens {
+    accessToken: string;
+    idToken?: string;
+    refreshToken?: string;
+    tokenExpiry?: number;
+}
+
 /**
  * Types of callbacks directly supported by the SDK.
  */
@@ -225,19 +225,44 @@ interface TokenStoreObject {
 }
 
 /**
- * Tokens returned after successful authentication.
+ * An event-handling function.
  */
-interface OAuth2Tokens {
-    accessToken: string;
-    idToken?: string;
-    refreshToken?: string;
-    tokenExpiry?: number;
+declare type Listener = (e: FREvent) => void;
+interface FREvent {
+    type: string;
 }
 
-interface GetTokensOptions extends ConfigOptions {
-    forceRenew?: boolean;
-    login?: 'embedded' | 'redirect' | undefined;
-    query?: StringDict<string>;
+/**
+ * Event dispatcher for subscribing and publishing categorized events.
+ */
+declare class Dispatcher {
+    private callbacks;
+    /**
+     * Subscribes to an event type.
+     *
+     * @param type The event type
+     * @param listener The function to subscribe to events of this type
+     */
+    addEventListener(type: string, listener: Listener): void;
+    /**
+     * Unsubscribes from an event type.
+     *
+     * @param type The event type
+     * @param listener The function to unsubscribe from events of this type
+     */
+    removeEventListener(type: string, listener: Listener): void;
+    /**
+     * Unsubscribes all listener functions to a single event type or all event types.
+     *
+     * @param type The event type, or all event types if not specified
+     */
+    clearEventListeners(type?: string): void;
+    /**
+     * Publishes an event.
+     *
+     * @param event The event object to publish
+     */
+    dispatchEvent<T extends FREvent>(event: T): void;
 }
 
 /**
@@ -336,70 +361,38 @@ interface HttpClientRequestOptions {
  */
 declare type RequiresNewTokenFn = (res: Response) => boolean;
 
-interface MessageCreator {
-    [key: string]: (propertyName: string, params?: {
-        [key: string]: unknown;
-    }) => string;
-}
-interface ProcessedPropertyError {
-    detail: FailedPolicyRequirement;
-    messages: string[];
-}
-
-declare class FRLoginFailure implements AuthResponse {
-    payload: Step;
-    /**
-     * The type of step.
-     */
-    readonly type = StepType.LoginFailure;
-    /**
-     * @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.
-     */
-    getMessage(): string | undefined;
-    /**
-     * Gets processed failure message.
-     */
-    getProcessedMessage(messageCreator?: MessageCreator): ProcessedPropertyError[];
-    /**
-     * Gets the failure reason.
-     */
-    getReason(): string | undefined;
-}
-
-declare class FRLoginSuccess implements AuthResponse {
-    payload: Step;
-    /**
-     * The type of step.
-     */
-    readonly type = StepType.LoginSuccess;
-    /**
-     * @param payload The raw payload returned by OpenAM
-     */
-    constructor(payload: Step);
-    /**
-     * Gets the step's realm.
-     */
-    getRealm(): string | undefined;
-    /**
-     * Gets the step's session token.
-     */
-    getSessionToken(): string | undefined;
+/**
+ * HTTP client that includes bearer token injection and refresh.
+ * This module also supports authorization for policy protected endpoints.
+ *
+ * Example:
+ *
+ * ```js
+ * return forgerock.HttpClient.request({
+ *   url: `https://example.com/protected/resource`,
+ *   init: {
+ *     method: 'GET',
+ *     credentials: 'include',
+ *   },
+ *   authorization: {
+ *     handleStep: async (step) => {
+ *       step.getCallbackOfType('PasswordCallback').setPassword(pw);
+ *       return Promise.resolve(step);
+ *     },
+ *   },
+ * });
+ * ```
+ */
+declare abstract class HttpClient extends Dispatcher {
     /**
-     * Gets the step's success URL.
+     * Makes a request using the specified options.
+     *
+     * @param options The options to use when making the request
      */
-    getSuccessUrl(): string | undefined;
+    static request(options: HttpClientRequestOptions): Promise<Response>;
+    private static setAuthHeaders;
+    private static stepIterator;
+    private static _request;
 }
 
 declare function noop(): void;
@@ -559,8 +552,151 @@ declare class SvelteComponentTyped<Props extends Record<string, any> = any, Even
     constructor(options: ComponentConstructorOptions<Props>);
 }
 
+/** Callback to inform of a value updates. */
+declare type Subscriber<T> = (value: T) => void;
+/** Unsubscribes from value updates. */
+declare type Unsubscriber = () => void;
+/** Callback to update a value. */
+declare type Updater<T> = (value: T) => T;
+/** Cleanup logic callback. */
+declare type Invalidator<T> = (value?: T) => void;
+/** Readable interface for subscribing. */
+interface Readable<T> {
+    /**
+     * Subscribe on value changes.
+     * @param run subscription callback
+     * @param invalidate cleanup callback
+     */
+    subscribe(this: void, run: Subscriber<T>, invalidate?: Invalidator<T>): Unsubscriber;
+}
+/** Writable interface for both updating and subscribing. */
+interface Writable<T> extends Readable<T> {
+    /**
+     * Set value and inform subscribers.
+     * @param value to set
+     */
+    set(this: void, value: T): void;
+    /**
+     * Update value using callback and inform subscribers.
+     * @param updater callback
+     */
+    update(this: void, updater: Updater<T>): void;
+}
+
+interface MessageCreator {
+    [key: string]: (propertyName: string, params?: {
+        [key: string]: unknown;
+    }) => string;
+}
+interface ProcessedPropertyError {
+    detail: FailedPolicyRequirement;
+    messages: string[];
+}
+
+declare class FRLoginFailure implements AuthResponse {
+    payload: Step;
+    /**
+     * The type of step.
+     */
+    readonly type = StepType.LoginFailure;
+    /**
+     * @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.
+     */
+    getMessage(): string | undefined;
+    /**
+     * Gets processed failure message.
+     */
+    getProcessedMessage(messageCreator?: MessageCreator): ProcessedPropertyError[];
+    /**
+     * Gets the failure reason.
+     */
+    getReason(): string | undefined;
+}
+
+declare class FRLoginSuccess implements AuthResponse {
+    payload: Step;
+    /**
+     * The type of step.
+     */
+    readonly type = StepType.LoginSuccess;
+    /**
+     * @param payload The raw payload returned by OpenAM
+     */
+    constructor(payload: Step);
+    /**
+     * Gets the step's realm.
+     */
+    getRealm(): string | undefined;
+    /**
+     * Gets the step's session token.
+     */
+    getSessionToken(): string | undefined;
+    /**
+     * Gets the step's success URL.
+     */
+    getSuccessUrl(): string | undefined;
+}
+
+/**
+ * Tokens returned after successful authentication.
+ */
+interface OAuth2Tokens {
+    accessToken: string;
+    idToken?: string;
+    refreshToken?: string;
+    tokenExpiry?: number;
+}
+
+interface GetTokensOptions extends ConfigOptions {
+    forceRenew?: boolean;
+    login?: 'embedded' | 'redirect' | undefined;
+    query?: StringDict<string>;
+}
+
 type Maybe<T> = T | null | undefined;
 
+interface UserStore extends Pick<Writable<UserStoreValue>, 'subscribe'> {
+    get: (getOptions?: ConfigOptions) => void;
+    reset: () => void;
+}
+interface UserStoreValue {
+    completed: boolean;
+    error: Maybe<{
+        code?: Maybe<number>;
+        message: Maybe<string>;
+    }>;
+    loading: boolean;
+    successful: boolean;
+    response: unknown;
+}
+
+interface OAuthStore extends Pick<Writable<OAuthTokenStoreValue>, 'subscribe'> {
+    get: (getOptions?: GetTokensOptions) => void;
+    reset: () => void;
+}
+interface OAuthTokenStoreValue {
+    completed: boolean;
+    error: Maybe<{
+        code?: Maybe<number>;
+        message: Maybe<string>;
+    }>;
+    loading: boolean;
+    successful: boolean;
+    response: Maybe<OAuth2Tokens> | void;
+}
+
 interface CallbackMetadata {
     derived: {
         canForceUserInputOptionality: boolean;
@@ -572,6 +708,14 @@ interface CallbackMetadata {
     idx: number;
     platform?: Record<string, unknown>;
 }
+interface JourneyStore extends Pick<Writable<JourneyStoreValue>, 'subscribe'> {
+    next: (prevStep?: StepTypes, nextOptions?: StepOptions) => void;
+    pop: () => void;
+    push: (changeOptions: StepOptions) => void;
+    reset: () => void;
+    resume: (url: string, resumeOptions?: StepOptions) => void;
+    start: (startOptions?: StepOptions) => void;
+}
 interface JourneyStoreValue {
     completed: boolean;
     error: Maybe<{
@@ -600,42 +744,6 @@ interface StepMetadata {
 }
 type StepTypes = FRStep | FRLoginSuccess | FRLoginFailure | null;
 
-interface OAuthTokenStoreValue {
-    completed: boolean;
-    error: Maybe<{
-        code?: Maybe<number>;
-        message: Maybe<string>;
-    }>;
-    loading: boolean;
-    successful: boolean;
-    response: Maybe<OAuth2Tokens> | void;
-}
-
-interface UserStoreValue {
-    completed: boolean;
-    error: Maybe<{
-        code?: Maybe<number>;
-        message: Maybe<string>;
-    }>;
-    loading: boolean;
-    successful: boolean;
-    response: unknown;
-}
-
-interface JourneyOptions {
-    config?: StepOptions;
-    journey?: string;
-    oauth?: boolean;
-    resumeUrl?: string;
-    user?: boolean;
-}
-interface Response$1 {
-    journey?: JourneyStoreValue;
-    oauth?: OAuthTokenStoreValue;
-    user?: UserStoreValue;
-}
-
-
 declare type Primitive = string | number | bigint | boolean | null | undefined;
 
 declare namespace util {
@@ -1473,14 +1581,6 @@ declare enum ZodFirstPartyTypeKind {
     ZodBranded = "ZodBranded"
 }
 
-declare const partialLinksSchema: ZodObject<{
-    termsAndConditions: ZodOptional<ZodString>;
-}, "strict", ZodTypeAny, {
-    termsAndConditions?: string | undefined;
-}, {
-    termsAndConditions?: string | undefined;
-}>;
-
 declare const partialConfigSchema: ZodObject<{
     callbackFactory: ZodOptional<ZodOptional<ZodFunction<ZodTuple<[ZodObject<{
         _id: ZodOptional<ZodNumber>;
@@ -1797,6 +1897,14 @@ declare const journeyConfigSchema: ZodObject<{
     };
 }>;
 
+declare const partialLinksSchema: ZodObject<{
+    termsAndConditions: ZodOptional<ZodString>;
+}, "strict", ZodTypeAny, {
+    termsAndConditions?: string | undefined;
+}, {
+    termsAndConditions?: string | undefined;
+}>;
+
 declare const partialStringsSchema: ZodObject<{
     alreadyHaveAnAccount: ZodOptional<ZodString>;
     backToDefault: ZodOptional<ZodString>;
@@ -1812,6 +1920,7 @@ declare const partialStringsSchema: ZodObject<{
     doesNotMeetMinimumCharacterLength: ZodOptional<ZodString>;
     ensurePasswordIsMoreThan: ZodOptional<ZodString>;
     ensurePasswordHasOne: ZodOptional<ZodString>;
+    enterVerificationCode: ZodOptional<ZodString>;
     exceedsMaximumCharacterLength: ZodOptional<ZodString>;
     fieldCanNotContainFollowingCharacters: ZodOptional<ZodString>;
     fieldCanNotContainFollowingValues: ZodOptional<ZodString>;
@@ -1855,10 +1964,13 @@ declare const partialStringsSchema: ZodObject<{
     termsAndConditions: ZodOptional<ZodString>;
     termsAndConditionsLinkText: ZodOptional<ZodString>;
     tryAgain: ZodOptional<ZodString>;
+    twoFactorAuthentication: ZodOptional<ZodString>;
     useValidEmail: ZodOptional<ZodString>;
     unrecoverableError: ZodOptional<ZodString>;
     unknownNetworkError: ZodOptional<ZodString>;
+    userName: ZodOptional<ZodString>;
     usernameRequirements: ZodOptional<ZodString>;
+    useTheAuthenticatorAppOnYourPhone: ZodOptional<ZodString>;
     validatedCreatePasswordCallback: ZodOptional<ZodString>;
     validatedCreateUsernameCallback: ZodOptional<ZodString>;
     valueRequirements: ZodOptional<ZodString>;
@@ -1879,6 +1991,7 @@ declare const partialStringsSchema: ZodObject<{
     doesNotMeetMinimumCharacterLength?: string | undefined;
     ensurePasswordIsMoreThan?: string | undefined;
     ensurePasswordHasOne?: string | undefined;
+    enterVerificationCode?: string | undefined;
     exceedsMaximumCharacterLength?: string | undefined;
     fieldCanNotContainFollowingCharacters?: string | undefined;
     fieldCanNotContainFollowingValues?: string | undefined;
@@ -1920,10 +2033,13 @@ declare const partialStringsSchema: ZodObject<{
     successMessage?: string | undefined;
     termsAndConditionsLinkText?: string | undefined;
     tryAgain?: string | undefined;
+    twoFactorAuthentication?: string | undefined;
     useValidEmail?: string | undefined;
     unrecoverableError?: string | undefined;
     unknownNetworkError?: string | undefined;
+    userName?: string | undefined;
     usernameRequirements?: string | undefined;
+    useTheAuthenticatorAppOnYourPhone?: string | undefined;
     validatedCreatePasswordCallback?: string | undefined;
     validatedCreateUsernameCallback?: string | undefined;
     valueRequirements?: string | undefined;
@@ -1944,6 +2060,7 @@ declare const partialStringsSchema: ZodObject<{
     doesNotMeetMinimumCharacterLength?: string | undefined;
     ensurePasswordIsMoreThan?: string | undefined;
     ensurePasswordHasOne?: string | undefined;
+    enterVerificationCode?: string | undefined;
     exceedsMaximumCharacterLength?: string | undefined;
     fieldCanNotContainFollowingCharacters?: string | undefined;
     fieldCanNotContainFollowingValues?: string | undefined;
@@ -1985,10 +2102,13 @@ declare const partialStringsSchema: ZodObject<{
     successMessage?: string | undefined;
     termsAndConditionsLinkText?: string | undefined;
     tryAgain?: string | undefined;
+    twoFactorAuthentication?: string | undefined;
     useValidEmail?: string | undefined;
     unrecoverableError?: string | undefined;
     unknownNetworkError?: string | undefined;
+    userName?: string | undefined;
     usernameRequirements?: string | undefined;
+    useTheAuthenticatorAppOnYourPhone?: string | undefined;
     validatedCreatePasswordCallback?: string | undefined;
     validatedCreateUsernameCallback?: string | undefined;
     valueRequirements?: string | undefined;
@@ -2059,89 +2179,134 @@ declare const partialStyleSchema: ZodObject<{
     } | undefined;
 }>;
 
-declare const configuration: {
-    set(options: {
-        type?: string | undefined;
-        callbackFactory?: ((args_0: {
-            input?: {
-                value?: unknown;
-                name: string;
-            }[] | undefined;
-            _id?: number | undefined;
-            type: CallbackType;
-            output: {
-                value?: unknown;
-                name: string;
-            }[];
-        }, ...args_1: unknown[]) => FRCallback) | undefined;
-        clientId?: string | undefined;
-        middleware?: ((...args: unknown[]) => unknown)[] | undefined;
-        realmPath?: string | undefined;
-        redirectUri?: string | undefined;
-        scope?: string | undefined;
-        serverConfig?: {
-            paths?: {
-                authenticate: string;
-                authorize: string;
-                accessToken: string;
-                endSession: string;
-                userInfo: string;
-                revoke: string;
-                sessions: string;
-            } | undefined;
-            timeout: number;
-            baseUrl: string;
-        } | undefined;
-        support?: "modern" | "legacy" | undefined;
-        tokenStore?: "localStorage" | "indexedDB" | "sessionStorage" | {
-            set: (args_0: string, ...args_1: unknown[]) => Promise<void>;
-            remove: (args_0: string, ...args_1: unknown[]) => Promise<void>;
-            get: (args_0: string, ...args_1: unknown[]) => Promise<{
-                idToken?: string | undefined;
-                refreshToken?: string | undefined;
-                tokenExpiry?: number | undefined;
-                accessToken: string;
-            }>;
-        } | undefined;
-        tree?: string | undefined;
-        oauthThreshold?: number | undefined;
-    }): void;
+interface JourneyOptions {
+    oauth?: boolean;
+    user?: boolean;
+}
+interface JourneyOptionsStart {
+    config?: StepOptions;
+    journey?: string;
+    resumeUrl?: string;
+}
+interface WidgetConfigOptions {
+    config?: TypeOf<typeof partialConfigSchema>;
+    content?: TypeOf<typeof partialStringsSchema>;
+    journeys?: TypeOf<typeof journeyConfigSchema>;
+    links?: TypeOf<typeof partialLinksSchema>;
+    style?: TypeOf<typeof partialStyleSchema>;
+}
+
+
+interface ComponentStoreValue {
+    error: {
+        code: string;
+        message: string;
+    } | null;
+    modal: {
+        component: SvelteComponentDev$1;
+        element: HTMLDialogElement;
+    } | null;
+    mounted: boolean;
+    open: boolean | null;
+    reason: 'auto' | 'external' | 'user' | null;
+    type: 'inline' | 'modal' | null;
+}
+
+declare const api: {
+    component: {
+        close: (args?: {
+            reason: "auto" | "external" | "user";
+        } | undefined) => void;
+        mount: (component: SvelteComponentDev$1, element: HTMLDialogElement) => void;
+        open: () => void;
+        subscribe: (this: void, run: Subscriber<ComponentStoreValue>, invalidate?: ((value?: ComponentStoreValue | undefined) => void) | undefined) => Unsubscriber;
+    };
+    configuration: (options?: WidgetConfigOptions | undefined) => {
+        set(setOptions?: WidgetConfigOptions | undefined): void;
+    };
+    getStores: () => {
+        journeyStore: JourneyStore;
+        oauthStore: OAuthStore;
+        userStore: UserStore;
+    };
+    journey: (options?: JourneyOptions | undefined) => {
+        start: (startOptions?: JourneyOptionsStart | undefined) => Promise<unknown>;
+        subscribe: (this: void, run: Subscriber<{
+            journey: JourneyStoreValue;
+            oauth: OAuthTokenStoreValue;
+            user: UserStoreValue;
+        }>, invalidate?: ((value?: {
+            journey: JourneyStoreValue;
+            oauth: OAuthTokenStoreValue;
+            user: UserStoreValue;
+        } | undefined) => void) | undefined) => Unsubscriber;
+    };
+    request: typeof HttpClient.request;
+    user: {
+        info(): {
+            get: (options?: ConfigOptions | undefined) => Promise<unknown>;
+            subscribe: (this: void, run: Subscriber<UserStoreValue>, invalidate?: ((value?: UserStoreValue | undefined) => void) | undefined) => Unsubscriber;
+        };
+        logout(): Promise<void>;
+        tokens(): {
+            get: (options?: ConfigOptions | undefined) => Promise<unknown>;
+            subscribe: (this: void, run: Subscriber<OAuthTokenStoreValue>, invalidate?: ((value?: OAuthTokenStoreValue | undefined) => void) | undefined) => Unsubscriber;
+        };
+    };
+};
+declare const configuration: (options?: WidgetConfigOptions | undefined) => {
+    set(setOptions?: WidgetConfigOptions | undefined): void;
 };
-declare const form: {
-    onMount(fn: (form: HTMLFormElement) => void): void;
+declare const journey: (options?: JourneyOptions | undefined) => {
+    start: (startOptions?: JourneyOptionsStart | undefined) => Promise<unknown>;
+    subscribe: (this: void, run: Subscriber<{
+        journey: JourneyStoreValue;
+        oauth: OAuthTokenStoreValue;
+        user: UserStoreValue;
+    }>, invalidate?: ((value?: {
+        journey: JourneyStoreValue;
+        oauth: OAuthTokenStoreValue;
+        user: UserStoreValue;
+    } | undefined) => void) | undefined) => Unsubscriber;
 };
-declare const journey: {
-    start(options?: JourneyOptions | undefined): void;
-    onFailure(fn: (response: Response$1) => void): void;
-    onSuccess(fn: (response: Response$1) => void): void;
+declare const component: () => {
+    close: (args?: {
+        reason: "auto" | "external" | "user";
+    } | undefined) => void;
+    mount: (component: SvelteComponentDev$1, element: HTMLDialogElement) => void;
+    open: () => void;
+    subscribe: (this: void, run: Subscriber<ComponentStoreValue>, invalidate?: ((value?: ComponentStoreValue | undefined) => void) | undefined) => Unsubscriber;
 };
-declare const request: (options: HttpClientRequestOptions) => Promise<Response>;
+declare const request: typeof HttpClient.request;
 declare const user: {
-    authorized(remote?: boolean): Promise<unknown>;
-    info(remote?: boolean): Promise<unknown>;
-    logout: () => Promise<void>;
-    tokens(options?: GetTokensOptions | undefined): Promise<void | OAuth2Tokens>;
+    info(): {
+        get: (options?: ConfigOptions | undefined) => Promise<unknown>;
+        subscribe: (this: void, run: Subscriber<UserStoreValue>, invalidate?: ((value?: UserStoreValue | undefined) => void) | undefined) => Unsubscriber;
+    };
+    logout(): Promise<void>;
+    tokens(): {
+        get: (options?: ConfigOptions | undefined) => Promise<unknown>;
+        subscribe: (this: void, run: Subscriber<OAuthTokenStoreValue>, invalidate?: ((value?: OAuthTokenStoreValue | undefined) => void) | undefined) => Unsubscriber;
+    };
 };
+type ConfigurationApi = ReturnType<typeof api.configuration>;
+type JourneyApi = ReturnType<typeof api.journey>;
+type UserInfoApi = ReturnType<typeof api.user.info>;
+type UserTokensApi = ReturnType<typeof api.user.tokens>;
 
 declare const __propDef: {
     props: {
-        config?: TypeOf<typeof partialConfigSchema> | undefined;
-        content?: TypeOf<typeof partialStringsSchema> | undefined;
-        journeys?: TypeOf<typeof journeyConfigSchema> | undefined;
-        links?: TypeOf<typeof partialLinksSchema> | undefined;
-        style?: TypeOf<typeof partialStyleSchema> | undefined;
+        type?: "inline" | "modal" | undefined;
     };
     events: {
-        'form-mount': CustomEvent<any>;
-    } & {
         [evt: string]: CustomEvent<any>;
     };
     slots: {};
 };
-type InlineProps = typeof __propDef.props;
-type InlineEvents = typeof __propDef.events;
-type InlineSlots = typeof __propDef.slots;
-declare class Inline extends SvelteComponentTyped<InlineProps, InlineEvents, InlineSlots> {
+type IndexProps = typeof __propDef.props;
+type IndexEvents = typeof __propDef.events;
+type IndexSlots = typeof __propDef.slots;
+declare class Index extends SvelteComponentTyped<IndexProps, IndexEvents, IndexSlots> {
 }
 
-export { InlineEvents, InlineProps, InlineSlots, configuration, Inline as default, form, journey, request, user };
+export { ConfigurationApi, IndexEvents, IndexProps, IndexSlots, JourneyApi, UserInfoApi, UserTokensApi, component, configuration, Index as default, journey, request, user };