@forgerock/login-widget 1.0.0-beta.15 → 1.0.0-beta.17

package/package.json

@@ -11,7 +11,7 @@
       "require": "./widget.css"
     }
   },
-  "types": "./index.d.ts",
+  "types": "./types.d.ts",
   "dependencies": {},
-  "version": "1.0.0-beta.15"
+  "version": "1.0.0-beta.17"
 }

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

@@ -1,3 +1,44 @@
+/**
+ * An event-handling function.
+ */
+declare type Listener = (e: FREvent) => void;
+interface FREvent {
+    type: 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;
+}
+
 declare enum ActionTypes {
     Authenticate = "AUTHENTICATE",
     Authorize = "AUTHORIZE",
@@ -51,7 +92,7 @@ declare enum CallbackType {
 /**
  * Represents the authentication tree API payload schema.
  */
-interface Step {
+interface Step$1 {
     authId?: string;
     callbacks?: Callback[];
     code?: number;
@@ -79,7 +120,7 @@ interface StepDetail {
  * Represents configuration overrides used when requesting the next
  * step in an authentication tree.
  */
-interface StepOptions extends ConfigOptions {
+interface StepOptions extends ConfigOptions$1 {
     query?: StringDict<string>;
 }
 /**
@@ -176,7 +217,7 @@ interface Action {
 /**
  * Configuration options.
  */
-interface ConfigOptions {
+interface ConfigOptions$1 {
     callbackFactory?: FRCallbackFactory;
     clientId?: string;
     middleware?: RequestMiddleware[];
@@ -224,47 +265,6 @@ interface TokenStoreObject {
     remove: (clientId: string) => Promise<void>;
 }
 
-/**
- * An event-handling function.
- */
-declare type Listener = (e: FREvent) => void;
-interface FREvent {
-    type: 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;
-}
-
 /**
  * Types of steps returned by the authentication tree.
  */
@@ -291,7 +291,7 @@ interface FailureDetail {
  * Represents a single step of an authentication tree.
  */
 declare class FRStep implements AuthResponse {
-    payload: Step;
+    payload: Step$1;
     /**
      * The type of step.
      */
@@ -304,7 +304,7 @@ declare class FRStep implements AuthResponse {
      * @param payload The raw payload returned by OpenAM
      * @param callbackFactory A function that returns am implementation of FRCallback
      */
-    constructor(payload: Step, callbackFactory?: FRCallbackFactory);
+    constructor(payload: Step$1, callbackFactory?: FRCallbackFactory);
     /**
      * Gets the first callback of the specified type in this step.
      *
@@ -346,7 +346,7 @@ declare type HandleStep = (step: FRStep) => Promise<FRStep>;
 interface HttpClientRequestOptions {
     bypassAuthentication?: boolean;
     authorization?: {
-        config?: ConfigOptions;
+        config?: ConfigOptions$1;
         handleStep: HandleStep;
         idToken?: string;
         txnID?: string;
@@ -490,67 +490,6 @@ declare class SvelteComponentDev$1 extends SvelteComponent {
     $capture_state(): void;
     $inject_state(): void;
 }
-interface SvelteComponentTyped<Props extends Record<string, any> = any, Events extends Record<string, any> = any, Slots extends Record<string, any> = any> {
-    $set(props?: Partial<Props>): void;
-    $on<K extends Extract<keyof Events, string>>(type: K, callback: ((e: Events[K]) => void) | null | undefined): () => void;
-    $destroy(): void;
-    [accessor: string]: any;
-}
-/**
- * Base class to create strongly typed Svelte components.
- * This only exists for typing purposes and should be used in `.d.ts` files.
- *
- * ### Example:
- *
- * You have component library on npm called `component-library`, from which
- * you export a component called `MyComponent`. For Svelte+TypeScript users,
- * you want to provide typings. Therefore you create a `index.d.ts`:
- * ```ts
- * import { SvelteComponentTyped } from "svelte";
- * export class MyComponent extends SvelteComponentTyped<{foo: string}> {}
- * ```
- * Typing this makes it possible for IDEs like VS Code with the Svelte extension
- * to provide intellisense and to use the component like this in a Svelte file
- * with TypeScript:
- * ```svelte
- * <script lang="ts">
- * 	import { MyComponent } from "component-library";
- * </script>
- * <MyComponent foo={'bar'} />
- * ```
- *
- * #### Why not make this part of `SvelteComponent(Dev)`?
- * Because
- * ```ts
- * class ASubclassOfSvelteComponent extends SvelteComponent<{foo: string}> {}
- * const component: typeof SvelteComponent = ASubclassOfSvelteComponent;
- * ```
- * will throw a type error, so we need to separate the more strictly typed class.
- */
-declare class SvelteComponentTyped<Props extends Record<string, any> = any, Events extends Record<string, any> = any, Slots extends Record<string, any> = any> extends SvelteComponentDev$1 {
-    /**
-     * @private
-     * For type checking capabilities only.
-     * Does not exist at runtime.
-     * ### DO NOT USE!
-     */
-    $$prop_def: Props;
-    /**
-     * @private
-     * For type checking capabilities only.
-     * Does not exist at runtime.
-     * ### DO NOT USE!
-     */
-    $$events_def: Events;
-    /**
-     * @private
-     * For type checking capabilities only.
-     * Does not exist at runtime.
-     * ### DO NOT USE!
-     */
-    $$slot_def: Slots;
-    constructor(options: ComponentConstructorOptions<Props>);
-}
 
 /** Callback to inform of a value updates. */
 declare type Subscriber<T> = (value: T) => void;
@@ -594,7 +533,7 @@ interface ProcessedPropertyError {
 }
 
 declare class FRLoginFailure implements AuthResponse {
-    payload: Step;
+    payload: Step$1;
     /**
      * The type of step.
      */
@@ -602,7 +541,7 @@ declare class FRLoginFailure implements AuthResponse {
     /**
      * @param payload The raw payload returned by OpenAM
      */
-    constructor(payload: Step);
+    constructor(payload: Step$1);
     /**
      * Gets the error code.
      */
@@ -626,7 +565,7 @@ declare class FRLoginFailure implements AuthResponse {
 }
 
 declare class FRLoginSuccess implements AuthResponse {
-    payload: Step;
+    payload: Step$1;
     /**
      * The type of step.
      */
@@ -634,7 +573,7 @@ declare class FRLoginSuccess implements AuthResponse {
     /**
      * @param payload The raw payload returned by OpenAM
      */
-    constructor(payload: Step);
+    constructor(payload: Step$1);
     /**
      * Gets the step's realm.
      */
@@ -652,14 +591,14 @@ declare class FRLoginSuccess implements AuthResponse {
 /**
  * Tokens returned after successful authentication.
  */
-interface OAuth2Tokens {
+interface OAuth2Tokens$1 {
     accessToken: string;
     idToken?: string;
     refreshToken?: string;
     tokenExpiry?: number;
 }
 
-interface GetTokensOptions extends ConfigOptions {
+interface GetTokensOptions extends ConfigOptions$1 {
     forceRenew?: boolean;
     login?: 'embedded' | 'redirect' | undefined;
     query?: StringDict<string>;
@@ -667,11 +606,11 @@ interface GetTokensOptions extends ConfigOptions {
 
 type Maybe<T> = T | null | undefined;
 
-interface UserStore extends Pick<Writable<UserStoreValue>, 'subscribe'> {
-    get: (getOptions?: ConfigOptions) => void;
+interface UserStore extends Pick<Writable<UserStoreValue$1>, 'subscribe'> {
+    get: (getOptions?: ConfigOptions$1) => void;
     reset: () => void;
 }
-interface UserStoreValue {
+interface UserStoreValue$1 {
     completed: boolean;
     error: Maybe<{
         code?: Maybe<number>;
@@ -683,11 +622,11 @@ interface UserStoreValue {
     response: unknown;
 }
 
-interface OAuthStore extends Pick<Writable<OAuthTokenStoreValue>, 'subscribe'> {
+interface OAuthStore extends Pick<Writable<OAuthTokenStoreValue$1>, 'subscribe'> {
     get: (getOptions?: GetTokensOptions) => void;
     reset: () => void;
 }
-interface OAuthTokenStoreValue {
+interface OAuthTokenStoreValue$1 {
     completed: boolean;
     error: Maybe<{
         code?: Maybe<number>;
@@ -696,7 +635,7 @@ interface OAuthTokenStoreValue {
     }>;
     loading: boolean;
     successful: boolean;
-    response: Maybe<OAuth2Tokens> | void;
+    response: Maybe<OAuth2Tokens$1> | void;
 }
 
 interface CallbackMetadata {
@@ -710,7 +649,7 @@ interface CallbackMetadata {
     idx: number;
     platform?: Record<string, unknown>;
 }
-interface JourneyStore extends Pick<Writable<JourneyStoreValue>, 'subscribe'> {
+interface JourneyStore extends Pick<Writable<JourneyStoreValue$1>, 'subscribe'> {
     next: (prevStep?: StepTypes, nextOptions?: StepOptions) => void;
     pop: () => void;
     push: (changeOptions: StepOptions) => void;
@@ -718,12 +657,12 @@ interface JourneyStore extends Pick<Writable<JourneyStoreValue>, 'subscribe'> {
     resume: (url: string, resumeOptions?: StepOptions) => void;
     start: (startOptions?: StepOptions) => void;
 }
-interface JourneyStoreValue {
+interface JourneyStoreValue$1 {
     completed: boolean;
     error: Maybe<{
         code: Maybe<number>;
         message: Maybe<string>;
-        step: Maybe<Step>;
+        stage: Maybe<string>;
         troubleshoot: Maybe<string>;
     }>;
     loading: boolean;
@@ -733,7 +672,7 @@ interface JourneyStoreValue {
     } | null;
     step: StepTypes;
     successful: boolean;
-    response: Maybe<Step>;
+    response: Maybe<Step$1>;
 }
 interface StepMetadata {
     derived: {
@@ -747,6 +686,23 @@ interface StepMetadata {
 }
 type StepTypes = FRStep | FRLoginSuccess | FRLoginFailure | null;
 
+
+interface ComponentStoreValue {
+    lastAction: 'close' | 'open' | 'mount' | null;
+    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 type Primitive = string | number | symbol | bigint | boolean | null | undefined;
 
 declare namespace util {
@@ -2348,20 +2304,20 @@ declare const partialStyleSchema: ZodObject<{
     } | undefined;
 }>;
 
-interface JourneyOptions {
+interface JourneyOptions$1 {
     oauth?: boolean;
     user?: boolean;
 }
-interface JourneyOptionsChange {
+interface JourneyOptionsChange$1 {
     forgerock?: StepOptions;
     journey: string;
 }
-interface JourneyOptionsStart {
+interface JourneyOptionsStart$1 {
     forgerock?: StepOptions;
     journey?: string;
     resumeUrl?: string;
 }
-interface WidgetConfigOptions {
+interface WidgetConfigOptions$1 {
     forgerock?: TypeOf<typeof partialConfigSchema>;
     content?: TypeOf<typeof partialStringsSchema>;
     journeys?: TypeOf<typeof journeyConfigSchema>;
@@ -2369,23 +2325,6 @@ interface WidgetConfigOptions {
     style?: TypeOf<typeof partialStyleSchema>;
 }
 
-
-interface ComponentStoreValue {
-    lastAction: 'close' | 'open' | 'mount' | null;
-    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?: {
@@ -2394,92 +2333,53 @@ declare const api: {
         open: () => void;
         subscribe: (this: void, run: Subscriber<Pick<ComponentStoreValue, "reason" | "error" | "open" | "lastAction" | "mounted">>, invalidate?: ((value?: Pick<ComponentStoreValue, "reason" | "error" | "open" | "lastAction" | "mounted"> | undefined) => void) | undefined) => Unsubscriber;
     };
-    configuration: (options?: WidgetConfigOptions | undefined) => {
-        set(setOptions?: WidgetConfigOptions | undefined): void;
+    configuration: (options?: WidgetConfigOptions$1 | undefined) => {
+        set(setOptions?: WidgetConfigOptions$1 | undefined): void;
     };
     getStores: () => {
         journeyStore: JourneyStore;
         oauthStore: OAuthStore;
         userStore: UserStore;
     };
-    journey: (options?: JourneyOptions | undefined) => {
-        change: (changeOptions: JourneyOptionsChange) => Promise<unknown>;
-        start: (startOptions?: JourneyOptionsStart | undefined) => Promise<unknown>;
+    journey: (options?: JourneyOptions$1 | undefined) => {
+        change: (changeOptions: JourneyOptionsChange$1) => Promise<unknown>;
+        start: (startOptions?: JourneyOptionsStart$1 | undefined) => Promise<unknown>;
         subscribe: (this: void, run: Subscriber<{
-            journey: JourneyStoreValue;
-            oauth: OAuthTokenStoreValue;
-            user: UserStoreValue;
+            journey: JourneyStoreValue$1;
+            oauth: OAuthTokenStoreValue$1;
+            user: UserStoreValue$1;
         }>, invalidate?: ((value?: {
-            journey: JourneyStoreValue;
-            oauth: OAuthTokenStoreValue;
-            user: UserStoreValue;
+            journey: JourneyStoreValue$1;
+            oauth: OAuthTokenStoreValue$1;
+            user: UserStoreValue$1;
         } | 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;
+            get: (options?: ConfigOptions$1 | undefined) => Promise<unknown>;
+            subscribe: (this: void, run: Subscriber<UserStoreValue$1>, invalidate?: ((value?: UserStoreValue$1 | 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;
+            get: (options?: ConfigOptions$1 | undefined) => Promise<unknown>;
+            subscribe: (this: void, run: Subscriber<OAuthTokenStoreValue$1>, invalidate?: ((value?: OAuthTokenStoreValue$1 | undefined) => void) | undefined) => Unsubscriber;
         };
     };
 };
-declare const configuration: (options?: WidgetConfigOptions | undefined) => {
-    set(setOptions?: WidgetConfigOptions | undefined): void;
-};
-declare const journey: (options?: JourneyOptions | undefined) => {
-    change: (changeOptions: JourneyOptionsChange) => Promise<unknown>;
-    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 component: () => {
-    close: (args?: {
-        reason: "auto" | "external" | "user";
-    } | undefined) => void;
-    open: () => void;
-    subscribe: (this: void, run: Subscriber<Pick<ComponentStoreValue, "reason" | "error" | "open" | "lastAction" | "mounted">>, invalidate?: ((value?: Pick<ComponentStoreValue, "reason" | "error" | "open" | "lastAction" | "mounted"> | undefined) => void) | undefined) => Unsubscriber;
-};
-declare const request: typeof HttpClient.request;
-declare const 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;
-    };
-};
 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: {
-        type?: "inline" | "modal" | undefined;
-    };
-    events: {
-        [evt: string]: CustomEvent<any>;
-    };
-    slots: {};
-};
-type IndexProps = typeof __propDef.props;
-type IndexEvents = typeof __propDef.events;
-type IndexSlots = typeof __propDef.slots;
-declare class Index extends SvelteComponentTyped<IndexProps, IndexEvents, IndexSlots> {
-}
+type JourneyOptions = JourneyOptions$1;
+type JourneyOptionsChange = JourneyOptionsChange$1;
+type JourneyOptionsStart = JourneyOptionsStart$1;
+type WidgetConfigOptions = WidgetConfigOptions$1;
+type JourneyStoreValue = JourneyStoreValue$1;
+type OAuthTokenStoreValue = OAuthTokenStoreValue$1;
+type UserStoreValue = UserStoreValue$1;
+type ConfigOptions = ConfigOptions$1;
+type OAuth2Tokens = OAuth2Tokens$1;
+type Step = Step$1;
 
-export { ConfigurationApi, IndexEvents, IndexProps, IndexSlots, JourneyApi, UserInfoApi, UserTokensApi, component, configuration, Index as default, journey, request, user };
+export { ConfigOptions, ConfigurationApi, JourneyApi, JourneyOptions, JourneyOptionsChange, JourneyOptionsStart, JourneyStoreValue, OAuth2Tokens, OAuthTokenStoreValue, Step, UserInfoApi, UserStoreValue, UserTokensApi, WidgetConfigOptions };