@descope/web-component 3.48.2 → 3.49.0

package/dist/index.d.ts

@@ -127,11 +127,32 @@ type CustomScreenState = Omit<ScreenState, 'cssVars' | 'componentsConfig' | 'inp
     }[];
 };
 type ScriptModule = {
-    stop: () => void;
-    start: () => void;
     /**
-     * Refreshes any tokens or state that might be needed before form submission
-     * Currently implemented for reCAPTCHA to ensure we have a fresh token
+     * Unique identifier of the module.
+     */
+    id: string;
+    /**
+     * Notifies the module that it should start any profiling or monitoring.
+     */
+    start?: () => void;
+    /**
+     * Notifies the module that it should stop any profiling or monitoring.
+     */
+    stop?: () => void;
+    /**
+     * Presents the user with any required interaction to get a refreshed token or state,
+     * e.g., a challenge or captcha.
+     *
+     * Modules should return a value of true if the presentation completed successfully,
+     * false if it was cancelled by the user, and throw an error in case of failure.
+     *
+     * This is called before form submission (via a next call) after a button click.
+     */
+    present?: () => Promise<boolean>;
+    /**
+     * Refreshes any tokens or state that might be needed before form submission.
+     *
+     * Modules should throw an error in case of failure.
      */
     refresh?: () => Promise<void>;
 };
@@ -243,12 +264,12 @@ declare const BaseClass: (new (...params: any[]) => {
         readonly cssRules: CSSRuleList;
     } | CSSStyleSheet;
     nonce: string;
-    "__#29686@#setNonce"(): void;
+    "__#29688@#setNonce"(): void;
     init(): Promise<void>;
-    "__#29681@#observeMappings": {};
+    "__#29683@#observeMappings": {};
     observeAttribute(attrName: string, onAttrChange: (attrName: string, value: string) => void): () => any;
     observeAttributes(attrs: string[], cb: (attrName: string, value: string) => void): () => void;
-    "__#29680@#isInit": boolean;
+    "__#29682@#isInit": boolean;
     connectedCallback: (() => void) & (() => void) & (() => void);
     accessKey: string;
     readonly accessKeyLabel: string;
@@ -574,8 +595,8 @@ declare const BaseClass: (new (...params: any[]) => {
     tabIndex: number;
     blur(): void;
     focus(options?: FocusOptions): void;
-    "__#29679@#logger": _descope_sdk_mixins_static_resources_mixin.Logger;
-    "__#29679@#wrapLogger"(logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>): _descope_sdk_mixins_static_resources_mixin.Logger;
+    "__#29681@#logger": _descope_sdk_mixins_static_resources_mixin.Logger;
+    "__#29681@#wrapLogger"(logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>): _descope_sdk_mixins_static_resources_mixin.Logger;
     get logger(): _descope_sdk_mixins_static_resources_mixin.Logger;
     set logger(logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>);
     onLogEvent(logLevel: "error" | "warn" | "info" | "debug", data: any[]): void;
@@ -911,9 +932,9 @@ declare const BaseClass: (new (...params: any[]) => {
         focus(options?: FocusOptions): void;
     };
 } & (new (...params: any[]) => {
-    "__#29683@#lastBaseUrl"?: string;
-    "__#29683@#workingBaseUrl"?: string;
-    "__#29683@#getResourceUrls"(filename: string): (URL & {
+    "__#29685@#lastBaseUrl"?: string;
+    "__#29685@#workingBaseUrl"?: string;
+    "__#29685@#getResourceUrls"(filename: string): (URL & {
         baseUrl: string;
     }) | (URL & {
         baseUrl: string;
@@ -1251,34 +1272,34 @@ declare const BaseClass: (new (...params: any[]) => {
     blur(): void;
     focus(options?: FocusOptions): void;
     readonly projectId: string;
-    "__#29682@#handleError"(attrName: string, newValue: string): void;
+    "__#29684@#handleError"(attrName: string, newValue: string): void;
     init(): Promise<void>;
-    "__#29681@#observeMappings": {};
+    "__#29683@#observeMappings": {};
     observeAttribute(attrName: string, onAttrChange: (attrName: string, value: string) => void): () => any;
     observeAttributes(attrs: string[], cb: (attrName: string, value: string) => void): () => void;
-    "__#29680@#isInit": boolean;
-    "__#29679@#logger": _descope_sdk_mixins_static_resources_mixin.Logger;
-    "__#29679@#wrapLogger": ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger);
+    "__#29682@#isInit": boolean;
+    "__#29681@#logger": _descope_sdk_mixins_static_resources_mixin.Logger;
+    "__#29681@#wrapLogger": ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger);
     get logger(): _descope_sdk_mixins_static_resources_mixin.Logger;
     set logger(logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>);
     onLogEvent: ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void);
 }) & (new (...params: any[]) => {
-    "__#29695@#globalStyle": _descope_sdk_mixins_static_resources_mixin.InjectedStyle;
+    "__#29697@#globalStyle": _descope_sdk_mixins_static_resources_mixin.InjectedStyle;
     readonly theme: _descope_sdk_mixins_static_resources_mixin.ThemeOptions;
     readonly styleId: string;
-    "__#29695@#_themeResource": Promise<void | Record<string, any>>;
-    "__#29695@#fetchTheme"(): Promise<Record<string, any>>;
-    readonly "__#29695@#themeResource": Promise<void | Record<string, any>>;
-    "__#29695@#loadGlobalStyle"(): Promise<void>;
-    "__#29695@#loadComponentsStyle"(): Promise<void>;
-    "__#29695@#getFontsConfig"(): Promise<Record<string, {
+    "__#29697@#_themeResource": Promise<void | Record<string, any>>;
+    "__#29697@#fetchTheme"(): Promise<Record<string, any>>;
+    readonly "__#29697@#themeResource": Promise<void | Record<string, any>>;
+    "__#29697@#loadGlobalStyle"(): Promise<void>;
+    "__#29697@#loadComponentsStyle"(): Promise<void>;
+    "__#29697@#getFontsConfig"(): Promise<Record<string, {
         url?: string;
     }>>;
-    "__#29695@#loadFonts"(): Promise<void>;
-    "__#29695@#applyTheme"(): Promise<void>;
-    "__#29695@#onThemeChange": () => void;
-    "__#29695@#loadTheme"(): void;
-    "__#29695@#toggleOsThemeChangeListener": (listen: boolean) => void;
+    "__#29697@#loadFonts"(): Promise<void>;
+    "__#29697@#applyTheme"(): Promise<void>;
+    "__#29697@#onThemeChange": () => void;
+    "__#29697@#loadTheme"(): void;
+    "__#29697@#toggleOsThemeChangeListener": (listen: boolean) => void;
     init(): Promise<void>;
     injectStyle: ((cssString: string, { prepend }?: {
         prepend?: boolean;
@@ -1296,11 +1317,11 @@ declare const BaseClass: (new (...params: any[]) => {
         readonly cssRules: CSSRuleList;
     });
     nonce: string;
-    "__#29686@#setNonce": (() => void) & (() => void);
-    "__#29681@#observeMappings": {};
+    "__#29688@#setNonce": (() => void) & (() => void);
+    "__#29683@#observeMappings": {};
     observeAttribute: ((attrName: string, onAttrChange: (attrName: string, value: string) => void) => () => any) & ((attrName: string, onAttrChange: (attrName: string, value: string) => void) => () => any) & ((attrName: string, onAttrChange: (attrName: string, value: string) => void) => () => any) & ((attrName: string, onAttrChange: (attrName: string, value: string) => void) => () => any) & ((attrName: string, onAttrChange: (attrName: string, value: string) => void) => () => any) & ((attrName: string, onAttrChange: (attrName: string, value: string) => void) => () => any) & ((attrName: string, onAttrChange: (attrName: string, value: string) => void) => () => any) & ((attrName: string, onAttrChange: (attrName: string, value: string) => void) => () => any) & ((attrName: string, onAttrChange: (attrName: string, value: string) => void) => () => any);
     observeAttributes: ((attrs: string[], cb: (attrName: string, value: string) => void) => () => void) & ((attrs: string[], cb: (attrName: string, value: string) => void) => () => void) & ((attrs: string[], cb: (attrName: string, value: string) => void) => () => void) & ((attrs: string[], cb: (attrName: string, value: string) => void) => () => void) & ((attrs: string[], cb: (attrName: string, value: string) => void) => () => void) & ((attrs: string[], cb: (attrName: string, value: string) => void) => () => void) & ((attrs: string[], cb: (attrName: string, value: string) => void) => () => void) & ((attrs: string[], cb: (attrName: string, value: string) => void) => () => void) & ((attrs: string[], cb: (attrName: string, value: string) => void) => () => void);
-    "__#29680@#isInit": boolean;
+    "__#29682@#isInit": boolean;
     connectedCallback: (() => void) & (() => void) & (() => void) & (() => void) & (() => void) & (() => void) & (() => void) & (() => void) & (() => void) & (() => void) & (() => void) & (() => void) & (() => void) & (() => void) & (() => void) & (() => void) & (() => void) & (() => void) & (() => void) & (() => void) & (() => void);
     accessKey: string;
     readonly accessKeyLabel: string;
@@ -1626,24 +1647,24 @@ declare const BaseClass: (new (...params: any[]) => {
     tabIndex: number;
     blur(): void;
     focus(options?: FocusOptions): void;
-    "__#29679@#logger": _descope_sdk_mixins_static_resources_mixin.Logger;
-    "__#29679@#wrapLogger": ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger);
+    "__#29681@#logger": _descope_sdk_mixins_static_resources_mixin.Logger;
+    "__#29681@#wrapLogger": ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger) & ((logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>) => _descope_sdk_mixins_static_resources_mixin.Logger);
     get logger(): _descope_sdk_mixins_static_resources_mixin.Logger;
     set logger(logger: Partial<_descope_sdk_mixins_static_resources_mixin.Logger>);
     onLogEvent: ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void) & ((logLevel: "error" | "warn" | "info" | "debug", data: any[]) => void);
     contentRootElement: HTMLElement;
     rootElement: HTMLElement;
     readonly config: Promise<_descope_sdk_mixins_static_resources_mixin.Config>;
-    "__#29685@#configCacheClear": (() => void) & (() => void);
-    "__#29685@#_configResource": Promise<_descope_sdk_mixins_static_resources_mixin.Config>;
-    "__#29685@#fetchConfig": (() => Promise<_descope_sdk_mixins_static_resources_mixin.Config>) & (() => Promise<_descope_sdk_mixins_static_resources_mixin.Config>);
-    "__#29684@#callbacks": Map<string, () => void> & Map<string, () => void>;
+    "__#29687@#configCacheClear": (() => void) & (() => void);
+    "__#29687@#_configResource": Promise<_descope_sdk_mixins_static_resources_mixin.Config>;
+    "__#29687@#fetchConfig": (() => Promise<_descope_sdk_mixins_static_resources_mixin.Config>) & (() => Promise<_descope_sdk_mixins_static_resources_mixin.Config>);
+    "__#29686@#callbacks": Map<string, () => void> & Map<string, () => void>;
     onReset: ((sectionId: string, callback: () => void | Promise<void>) => () => void) & ((sectionId: string, callback: () => void | Promise<void>) => () => void);
     reset: ((...sectionIds: string[]) => Promise<void>) & ((...sectionIds: string[]) => Promise<void>);
-    "__#29682@#handleError": ((attrName: string, newValue: string) => void) & ((attrName: string, newValue: string) => void) & ((attrName: string, newValue: string) => void) & ((attrName: string, newValue: string) => void) & ((attrName: string, newValue: string) => void) & ((attrName: string, newValue: string) => void);
-    "__#29683@#lastBaseUrl"?: string;
-    "__#29683@#workingBaseUrl"?: string;
-    "__#29683@#getResourceUrls": ((filename: string) => (URL & {
+    "__#29684@#handleError": ((attrName: string, newValue: string) => void) & ((attrName: string, newValue: string) => void) & ((attrName: string, newValue: string) => void) & ((attrName: string, newValue: string) => void) & ((attrName: string, newValue: string) => void) & ((attrName: string, newValue: string) => void);
+    "__#29685@#lastBaseUrl"?: string;
+    "__#29685@#workingBaseUrl"?: string;
+    "__#29685@#getResourceUrls": ((filename: string) => (URL & {
         baseUrl: string;
     }) | (URL & {
         baseUrl: string;
@@ -1669,11 +1690,11 @@ declare const BaseClass: (new (...params: any[]) => {
     readonly baseStaticUrl: string;
     readonly baseUrl: string;
     readonly projectId: string;
-    "__#29689@#getComponentsVersion"(): Promise<string>;
-    "__#29689@#descopeUi": Promise<any>;
+    "__#29691@#getComponentsVersion"(): Promise<string>;
+    "__#29691@#descopeUi": Promise<any>;
     readonly descopeUi: Promise<any>;
-    "__#29689@#loadDescopeUiComponent"(componentName: string): Promise<any>;
-    "__#29689@#getDescopeUi"(): Promise<any>;
+    "__#29691@#loadDescopeUiComponent"(componentName: string): Promise<any>;
+    "__#29691@#getDescopeUi"(): Promise<any>;
     loadDescopeUiComponents(templateOrComponentNames: string[] | HTMLTemplateElement): Promise<any[]>;
     readonly baseCdnUrl: string;
     injectNpmLib(libName: string, version: string, filePath?: string, overrides?: string[]): Promise<{