@forgerock/login-widget 1.0.0-beta.1 → 1.0.0-beta.3

package/inline.d.ts

@@ -234,6 +234,173 @@ interface OAuth2Tokens {
     tokenExpiry?: number;
 }
 
+interface GetTokensOptions extends ConfigOptions {
+    forceRenew?: boolean;
+    login?: 'embedded' | 'redirect' | undefined;
+    query?: StringDict<string>;
+}
+
+/**
+ * Types of steps returned by the authentication tree.
+ */
+declare enum StepType {
+    LoginFailure = "LoginFailure",
+    LoginSuccess = "LoginSuccess",
+    Step = "Step"
+}
+
+/**
+ * Base interface for all types of authentication step responses.
+ */
+interface AuthResponse {
+    type: StepType;
+}
+/**
+ * Represents details of a failure in an authentication step.
+ */
+interface FailureDetail {
+    failureUrl?: string;
+}
+
+/**
+ * Represents a single step of an authentication tree.
+ */
+declare class FRStep implements AuthResponse {
+    payload: Step;
+    /**
+     * The type of step.
+     */
+    readonly type = StepType.Step;
+    /**
+     * The callbacks contained in this step.
+     */
+    callbacks: FRCallback[];
+    /**
+     * @param payload The raw payload returned by OpenAM
+     * @param callbackFactory A function that returns am implementation of FRCallback
+     */
+    constructor(payload: Step, callbackFactory?: FRCallbackFactory);
+    /**
+     * Gets the first callback of the specified type in this step.
+     *
+     * @param type The type of callback to find.
+     */
+    getCallbackOfType<T extends FRCallback>(type: CallbackType): T;
+    /**
+     * Gets all callbacks of the specified type in this step.
+     *
+     * @param type The type of callback to find.
+     */
+    getCallbacksOfType<T extends FRCallback>(type: CallbackType): T[];
+    /**
+     * Sets the value of the first callback of the specified type in this step.
+     *
+     * @param type The type of callback to find.
+     * @param value The value to set for the callback.
+     */
+    setCallbackValue(type: CallbackType, value: unknown): void;
+    /**
+     * Gets the step's description.
+     */
+    getDescription(): string | undefined;
+    /**
+     * Gets the step's header.
+     */
+    getHeader(): string | undefined;
+    /**
+     * Gets the step's stage.
+     */
+    getStage(): string | undefined;
+    private convertCallbacks;
+}
+
+declare type HandleStep = (step: FRStep) => Promise<FRStep>;
+/**
+ * Options to use when making an HTTP call.
+ */
+interface HttpClientRequestOptions {
+    bypassAuthentication?: boolean;
+    authorization?: {
+        config?: ConfigOptions;
+        handleStep: HandleStep;
+        idToken?: string;
+        txnID?: string;
+    };
+    init: RequestInit;
+    requiresNewToken?: RequiresNewTokenFn;
+    timeout: number;
+    url: string;
+}
+/**
+ * A function that determines whether a new token is required based on a HTTP response.
+ */
+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;
+    /**
+     * Gets the step's success URL.
+     */
+    getSuccessUrl(): string | undefined;
+}
 
 declare function noop(): void;
 
@@ -392,152 +559,6 @@ declare class SvelteComponentTyped<Props extends Record<string, any> = any, Even
     constructor(options: ComponentConstructorOptions<Props>);
 }
 
-interface MessageCreator {
-    [key: string]: (propertyName: string, params?: {
-        [key: string]: unknown;
-    }) => string;
-}
-interface ProcessedPropertyError {
-    detail: FailedPolicyRequirement;
-    messages: string[];
-}
-
-/**
- * Types of steps returned by the authentication tree.
- */
-declare enum StepType {
-    LoginFailure = "LoginFailure",
-    LoginSuccess = "LoginSuccess",
-    Step = "Step"
-}
-
-/**
- * Base interface for all types of authentication step responses.
- */
-interface AuthResponse {
-    type: StepType;
-}
-/**
- * Represents details of a failure in an authentication step.
- */
-interface FailureDetail {
-    failureUrl?: 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;
-}
-
-/**
- * Represents a single step of an authentication tree.
- */
-declare class FRStep implements AuthResponse {
-    payload: Step;
-    /**
-     * The type of step.
-     */
-    readonly type = StepType.Step;
-    /**
-     * The callbacks contained in this step.
-     */
-    callbacks: FRCallback[];
-    /**
-     * @param payload The raw payload returned by OpenAM
-     * @param callbackFactory A function that returns am implementation of FRCallback
-     */
-    constructor(payload: Step, callbackFactory?: FRCallbackFactory);
-    /**
-     * Gets the first callback of the specified type in this step.
-     *
-     * @param type The type of callback to find.
-     */
-    getCallbackOfType<T extends FRCallback>(type: CallbackType): T;
-    /**
-     * Gets all callbacks of the specified type in this step.
-     *
-     * @param type The type of callback to find.
-     */
-    getCallbacksOfType<T extends FRCallback>(type: CallbackType): T[];
-    /**
-     * Sets the value of the first callback of the specified type in this step.
-     *
-     * @param type The type of callback to find.
-     * @param value The value to set for the callback.
-     */
-    setCallbackValue(type: CallbackType, value: unknown): void;
-    /**
-     * Gets the step's description.
-     */
-    getDescription(): string | undefined;
-    /**
-     * Gets the step's header.
-     */
-    getHeader(): string | undefined;
-    /**
-     * Gets the step's stage.
-     */
-    getStage(): string | undefined;
-    private convertCallbacks;
-}
-
-interface GetTokensOptions extends ConfigOptions {
-    forceRenew?: boolean;
-    login?: 'embedded' | 'redirect' | undefined;
-    query?: StringDict<string>;
-}
-
 type Maybe<T> = T | null | undefined;
 
 interface CallbackMetadata {
@@ -601,11 +622,6 @@ interface UserStoreValue {
     response: unknown;
 }
 
-interface Response {
-    journey?: JourneyStoreValue;
-    oauth?: OAuthTokenStoreValue;
-    user?: UserStoreValue;
-}
 interface JourneyOptions {
     config?: StepOptions;
     journey?: string;
@@ -613,6 +629,12 @@ interface JourneyOptions {
     resumeUrl?: string;
     user?: boolean;
 }
+interface Response$1 {
+    journey?: JourneyStoreValue;
+    oauth?: OAuthTokenStoreValue;
+    user?: UserStoreValue;
+}
+
 
 declare type Primitive = string | number | bigint | boolean | null | undefined;
 
@@ -1087,6 +1109,13 @@ declare class ZodNumber extends ZodType<number, ZodNumberDef> {
     get maxValue(): number | null;
     get isInt(): boolean;
 }
+interface ZodBooleanDef extends ZodTypeDef {
+    typeName: ZodFirstPartyTypeKind.ZodBoolean;
+}
+declare class ZodBoolean extends ZodType<boolean, ZodBooleanDef> {
+    _parse(input: ParseInput): ParseReturnType<boolean>;
+    static create: (params?: RawCreateParams) => ZodBoolean;
+}
 interface ZodUnknownDef extends ZodTypeDef {
     typeName: ZodFirstPartyTypeKind.ZodUnknown;
 }
@@ -1452,24 +1481,6 @@ declare const partialLinksSchema: ZodObject<{
     termsAndConditions?: string | undefined;
 }>;
 
-interface Logo {
-    dark?: string;
-    height?: number;
-    light: string;
-    width?: number;
-}
-interface Style {
-    checksAndRadios?: 'animated' | 'standard';
-    labels?: 'floating' | 'stacked';
-    logo?: Logo;
-    sections?: {
-        header?: boolean;
-    };
-    stage?: {
-        icon: boolean;
-    };
-}
-
 declare const partialConfigSchema: ZodObject<{
     callbackFactory: ZodOptional<ZodOptional<ZodFunction<ZodTuple<[ZodObject<{
         _id: ZodOptional<ZodNumber>;
@@ -1983,28 +1994,142 @@ declare const partialStringsSchema: ZodObject<{
     valueRequirements?: string | undefined;
 }>;
 
-declare const journey: {
-    start(options?: JourneyOptions): void;
-    onFailure(fn: (response: Response) => void): void;
-    onSuccess(fn: (response: Response) => void): void;
+declare const partialStyleSchema: ZodObject<{
+    checksAndRadios: ZodOptional<ZodOptional<ZodUnion<[ZodLiteral<"animated">, ZodLiteral<"standard">]>>>;
+    labels: ZodOptional<ZodOptional<ZodUnion<[ZodOptional<ZodLiteral<"floating">>, ZodLiteral<"stacked">]>>>;
+    logo: ZodOptional<ZodOptional<ZodObject<{
+        dark: ZodOptional<ZodString>;
+        height: ZodOptional<ZodNumber>;
+        light: ZodOptional<ZodString>;
+        width: ZodOptional<ZodNumber>;
+    }, "strict", ZodTypeAny, {
+        height?: number | undefined;
+        width?: number | undefined;
+        dark?: string | undefined;
+        light?: string | undefined;
+    }, {
+        height?: number | undefined;
+        width?: number | undefined;
+        dark?: string | undefined;
+        light?: string | undefined;
+    }>>>;
+    sections: ZodOptional<ZodOptional<ZodObject<{
+        header: ZodOptional<ZodBoolean>;
+    }, "strip", ZodTypeAny, {
+        header?: boolean | undefined;
+    }, {
+        header?: boolean | undefined;
+    }>>>;
+    stage: ZodOptional<ZodOptional<ZodObject<{
+        icon: ZodOptional<ZodBoolean>;
+    }, "strip", ZodTypeAny, {
+        icon?: boolean | undefined;
+    }, {
+        icon?: boolean | undefined;
+    }>>>;
+}, "strict", ZodTypeAny, {
+    labels?: "floating" | "stacked" | undefined;
+    checksAndRadios?: "standard" | "animated" | undefined;
+    logo?: {
+        height?: number | undefined;
+        width?: number | undefined;
+        dark?: string | undefined;
+        light?: string | undefined;
+    } | undefined;
+    sections?: {
+        header?: boolean | undefined;
+    } | undefined;
+    stage?: {
+        icon?: boolean | undefined;
+    } | undefined;
+}, {
+    labels?: "floating" | "stacked" | undefined;
+    checksAndRadios?: "standard" | "animated" | undefined;
+    logo?: {
+        height?: number | undefined;
+        width?: number | undefined;
+        dark?: string | undefined;
+        light?: string | undefined;
+    } | undefined;
+    sections?: {
+        header?: boolean | undefined;
+    } | undefined;
+    stage?: {
+        icon?: boolean | undefined;
+    } | 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;
 };
 declare const form: {
     onMount(fn: (form: HTMLFormElement) => void): void;
 };
+declare const journey: {
+    start(options?: JourneyOptions | undefined): void;
+    onFailure(fn: (response: Response$1) => void): void;
+    onSuccess(fn: (response: Response$1) => void): void;
+};
+declare const request: (options: HttpClientRequestOptions) => Promise<Response>;
 declare const user: {
-    authorized(remote?: boolean): Promise<boolean>;
+    authorized(remote?: boolean): Promise<unknown>;
     info(remote?: boolean): Promise<unknown>;
-    logout(): Promise<void>;
-    tokens(options?: GetTokensOptions): Promise<void | OAuth2Tokens>;
+    logout: () => Promise<void>;
+    tokens(options?: GetTokensOptions | undefined): Promise<void | OAuth2Tokens>;
 };
 
 declare const __propDef: {
     props: {
-        config: TypeOf<typeof partialConfigSchema>;
-        content: TypeOf<typeof partialStringsSchema>;
+        config?: TypeOf<typeof partialConfigSchema> | undefined;
+        content?: TypeOf<typeof partialStringsSchema> | undefined;
         journeys?: TypeOf<typeof journeyConfigSchema> | undefined;
         links?: TypeOf<typeof partialLinksSchema> | undefined;
-        style?: Style | undefined;
+        style?: TypeOf<typeof partialStyleSchema> | undefined;
     };
     events: {
         'form-mount': CustomEvent<any>;
@@ -2019,4 +2144,4 @@ type InlineSlots = typeof __propDef.slots;
 declare class Inline extends SvelteComponentTyped<InlineProps, InlineEvents, InlineSlots> {
 }
 
-export { InlineEvents, InlineProps, InlineSlots, Inline as default, form, journey, user };
+export { InlineEvents, InlineProps, InlineSlots, configuration, Inline as default, form, journey, request, user };