@descope/sdk-mixins 0.20.0 → 0.21.0

package/dist/cjs/index.js

@@ -19,6 +19,8 @@ var projectIdMixin = require('./mixins/projectIdMixin.js');
 var tenantIdMixin = require('./mixins/tenantIdMixin.js');
 var widgetIdMixin = require('./mixins/widgetIdMixin.js');
 var widgetConfigMixin = require('./mixins/widgetConfigMixin/widgetConfigMixin.js');
+var localeMixin = require('./mixins/localeMixin/localeMixin.js');
+var createFetchWidgetPagesMixin = require('./mixins/fetchWidgetPagesMixin/createFetchWidgetPagesMixin.js');
 var baseUrlMixin = require('./mixins/baseUrlMixin.js');
 var cookieConfigMixin = require('./mixins/cookieConfigMixin.js');
 var injectNpmLibMixin = require('./mixins/injectNpmLibMixin/injectNpmLibMixin.js');
@@ -47,6 +49,8 @@ exports.projectIdMixin = projectIdMixin.projectIdMixin;
 exports.tenantIdMixin = tenantIdMixin.tenantIdMixin;
 exports.widgetIdMixin = widgetIdMixin.widgetIdMixin;
 exports.widgetConfigMixin = widgetConfigMixin.widgetConfigMixin;
+exports.localeMixin = localeMixin.localeMixin;
+exports.createFetchWidgetPagesMixin = createFetchWidgetPagesMixin.createFetchWidgetPagesMixin;
 exports.baseUrlMixin = baseUrlMixin.baseUrlMixin;
 exports.cookieConfigMixin = cookieConfigMixin.cookieConfigMixin;
 exports.injectNpmLibMixin = injectNpmLibMixin.injectNpmLibMixin;

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/cjs/mixins/fetchWidgetPagesMixin/createFetchWidgetPagesMixin.js

@@ -0,0 +1,70 @@
+'use strict';
+
+var tslib = require('tslib');
+var sdkHelpers = require('@descope/sdk-helpers');
+var localeMixin = require('../localeMixin/localeMixin.js');
+var staticResourcesMixin = require('../staticResourcesMixin/staticResourcesMixin.js');
+var widgetConfigMixin = require('../widgetConfigMixin/widgetConfigMixin.js');
+var widgetIdMixin = require('../widgetIdMixin.js');
+
+/**
+ * Builds a widget's fetchWidgetPagesMixin. Every widget shares identical logic and differs only by
+ * its published base directory (the widget type/name under which its screens live in S3), so each
+ * widget calls this with its own dir:
+ *
+ *   export const fetchWidgetPagesMixin = createFetchWidgetPagesMixin('user-profile-widget');
+ *
+ * `fetchWidgetPage` fetches `<base>/<widgetId>/<file>`, transparently preferring a localized
+ * `<file>-<locale>.html` variant when the widget publishes that locale (config.json targetLocales),
+ * and falling back to the default page otherwise.
+ */
+const createFetchWidgetPagesMixin = (widgetPagesBaseDir) => sdkHelpers.createSingletonMixin((superclass) => {
+    var _FetchWidgetPagesMixinClass_instances, _FetchWidgetPagesMixinClass_tryFetchLocalized, _a;
+    const BaseClass = sdkHelpers.compose(staticResourcesMixin.staticResourcesMixin, widgetIdMixin.widgetIdMixin, widgetConfigMixin.widgetConfigMixin, localeMixin.localeMixin)(superclass);
+    return _a = class FetchWidgetPagesMixinClass extends BaseClass {
+            constructor() {
+                super(...arguments);
+                _FetchWidgetPagesMixinClass_instances.add(this);
+            }
+            // Keep `init` typed as a method across the package boundary (mirrors widgetConfigMixin):
+            // without it, the emitted .d.ts widens the inherited `init` to a property, and a widget
+            // composing this alongside another init-providing mixin (e.g. initLifecycleMixin) hits TS2425.
+            async init() {
+                var _b;
+                await ((_b = super.init) === null || _b === void 0 ? void 0 : _b.call(this));
+            }
+            async fetchWidgetPage(filename) {
+                const localized = await tslib.__classPrivateFieldGet(this, _FetchWidgetPagesMixinClass_instances, "m", _FetchWidgetPagesMixinClass_tryFetchLocalized).call(this, filename);
+                if (localized !== undefined)
+                    return localized;
+                const res = await this.fetchStaticResource(`${widgetPagesBaseDir}/${this.widgetId}/${filename}`, 'text');
+                return res === null || res === void 0 ? void 0 : res.body;
+            }
+        },
+        _FetchWidgetPagesMixinClass_instances = new WeakSet(),
+        _FetchWidgetPagesMixinClass_tryFetchLocalized = 
+        // Fetch <page>-<locale>.html when the widget publishes that locale (config.json
+        // targetLocales); otherwise return undefined so the caller falls back to the default page.
+        async function _FetchWidgetPagesMixinClass_tryFetchLocalized(filename) {
+            var _b;
+            const widgetConfig = await this.getWidgetConfig();
+            const userLocale = this.firstAvailableLocale((_b = widgetConfig === null || widgetConfig === void 0 ? void 0 : widgetConfig.targetLocales) !== null && _b !== void 0 ? _b : []);
+            if (!userLocale)
+                return undefined;
+            const ext = '.html';
+            const base = filename.endsWith(ext)
+                ? filename.slice(0, -ext.length)
+                : filename;
+            try {
+                const res = await this.fetchStaticResource(`${widgetPagesBaseDir}/${this.widgetId}/${base}-${userLocale}${ext}`, 'text');
+                return res === null || res === void 0 ? void 0 : res.body;
+            }
+            catch (_c) {
+                return undefined;
+            }
+        },
+        _a;
+});
+
+exports.createFetchWidgetPagesMixin = createFetchWidgetPagesMixin;
+//# sourceMappingURL=createFetchWidgetPagesMixin.js.map

package/dist/cjs/mixins/fetchWidgetPagesMixin/createFetchWidgetPagesMixin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createFetchWidgetPagesMixin.js","sources":["../../../../src/mixins/fetchWidgetPagesMixin/createFetchWidgetPagesMixin.ts"],"sourcesContent":["import { compose, createSingletonMixin } from '@descope/sdk-helpers';\nimport { localeMixin } from '../localeMixin';\nimport { staticResourcesMixin } from '../staticResourcesMixin';\nimport { widgetConfigMixin } from '../widgetConfigMixin';\nimport { widgetIdMixin } from '../widgetIdMixin';\n\n/**\n * Builds a widget's fetchWidgetPagesMixin. Every widget shares identical logic and differs only by\n * its published base directory (the widget type/name under which its screens live in S3), so each\n * widget calls this with its own dir:\n *\n *   export const fetchWidgetPagesMixin = createFetchWidgetPagesMixin('user-profile-widget');\n *\n * `fetchWidgetPage` fetches `<base>/<widgetId>/<file>`, transparently preferring a localized\n * `<file>-<locale>.html` variant when the widget publishes that locale (config.json targetLocales),\n * and falling back to the default page otherwise.\n */\nexport const createFetchWidgetPagesMixin = (widgetPagesBaseDir: string) =>\n  createSingletonMixin(<T extends CustomElementConstructor>(superclass: T) => {\n    const BaseClass = compose(\n      staticResourcesMixin,\n      widgetIdMixin,\n      widgetConfigMixin,\n      localeMixin,\n    )(superclass);\n    return class FetchWidgetPagesMixinClass extends BaseClass {\n      // Keep `init` typed as a method across the package boundary (mirrors widgetConfigMixin):\n      // without it, the emitted .d.ts widens the inherited `init` to a property, and a widget\n      // composing this alongside another init-providing mixin (e.g. initLifecycleMixin) hits TS2425.\n      async init() {\n        await super.init?.();\n      }\n\n      async fetchWidgetPage(filename: string) {\n        const localized = await this.#tryFetchLocalized(filename);\n        if (localized !== undefined) return localized;\n\n        const res = await this.fetchStaticResource(\n          `${widgetPagesBaseDir}/${this.widgetId}/${filename}`,\n          'text',\n        );\n        return res?.body;\n      }\n\n      // Fetch <page>-<locale>.html when the widget publishes that locale (config.json\n      // targetLocales); otherwise return undefined so the caller falls back to the default page.\n      async #tryFetchLocalized(filename: string): Promise<string | undefined> {\n        const widgetConfig = await this.getWidgetConfig();\n        const userLocale = this.firstAvailableLocale(\n          widgetConfig?.targetLocales ?? [],\n        );\n        if (!userLocale) return undefined;\n\n        const ext = '.html';\n        const base = filename.endsWith(ext)\n          ? filename.slice(0, -ext.length)\n          : filename;\n        try {\n          const res = await this.fetchStaticResource(\n            `${widgetPagesBaseDir}/${this.widgetId}/${base}-${userLocale}${ext}`,\n            'text',\n          );\n          return res?.body;\n        } catch {\n          return undefined;\n        }\n      }\n    };\n  });\n"],"names":["createSingletonMixin","compose","staticResourcesMixin","widgetIdMixin","widgetConfigMixin","localeMixin","__classPrivateFieldGet"],"mappings":";;;;;;;;;AAMA;;;;;;;;;;AAUG;AACI,MAAM,2BAA2B,GAAG,CAAC,kBAA0B,KACpEA,+BAAoB,CAAC,CAAqC,UAAa,KAAI;;AACzE,IAAA,MAAM,SAAS,GAAGC,kBAAO,CACvBC,yCAAoB,EACpBC,2BAAa,EACbC,mCAAiB,EACjBC,uBAAW,CACZ,CAAC,UAAU,CAAC,CAAC;IACd,OAAO,EAAA,GAAA,MAAM,0BAA2B,SAAQ,SAAS,CAAA;AAAlD,YAAA,WAAA,GAAA;;;aA0CN;;;;AAtCC,YAAA,MAAM,IAAI,GAAA;;AACR,gBAAA,OAAM,CAAA,EAAA,GAAA,KAAK,CAAC,IAAI,MAAA,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,IAAA,CAAA,IAAA,CAAI,CAAA,CAAC;aACtB;YAED,MAAM,eAAe,CAAC,QAAgB,EAAA;gBACpC,MAAM,SAAS,GAAG,MAAMC,4BAAA,CAAA,IAAI,EAAmB,qCAAA,EAAA,GAAA,EAAA,6CAAA,CAAA,CAAA,IAAA,CAAvB,IAAI,EAAoB,QAAQ,CAAC,CAAC;gBAC1D,IAAI,SAAS,KAAK,SAAS;AAAE,oBAAA,OAAO,SAAS,CAAC;AAE9C,gBAAA,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,mBAAmB,CACxC,CAAG,EAAA,kBAAkB,IAAI,IAAI,CAAC,QAAQ,CAAI,CAAA,EAAA,QAAQ,EAAE,EACpD,MAAM,CACP,CAAC;AACF,gBAAA,OAAO,GAAG,KAAH,IAAA,IAAA,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAC;aAClB;AAyBF,SAAA;;;;;AArBC,QAAA,6DAAyB,QAAgB,EAAA;;AACvC,YAAA,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;AAClD,YAAA,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAC1C,CAAA,EAAA,GAAA,YAAY,KAAZ,IAAA,IAAA,YAAY,uBAAZ,YAAY,CAAE,aAAa,MAAI,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,EAAA,GAAA,EAAE,CAClC,CAAC;AACF,YAAA,IAAI,CAAC,UAAU;AAAE,gBAAA,OAAO,SAAS,CAAC;YAElC,MAAM,GAAG,GAAG,OAAO,CAAC;AACpB,YAAA,MAAM,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC;kBAC/B,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC;kBAC9B,QAAQ,CAAC;AACb,YAAA,IAAI;gBACF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,mBAAmB,CACxC,CAAG,EAAA,kBAAkB,CAAI,CAAA,EAAA,IAAI,CAAC,QAAQ,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI,UAAU,CAAA,EAAG,GAAG,CAAE,CAAA,EACpE,MAAM,CACP,CAAC;AACF,gBAAA,OAAO,GAAG,KAAH,IAAA,IAAA,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAC;aAClB;AAAC,YAAA,OAAA,EAAA,EAAM;AACN,gBAAA,OAAO,SAAS,CAAC;aAClB;SACF;AACD,QAAA,EAAA,CAAA;AACJ,CAAC;;;;"}

package/dist/cjs/mixins/localeMixin/localeMixin.js

@@ -0,0 +1,33 @@
+'use strict';
+
+var sdkHelpers = require('@descope/sdk-helpers');
+
+/**
+ * Exposes the widget's locale to mixins that need it (HTML fetching, flow propagation).
+ * Mirrors web-component's BaseDescopeWc locale handling:
+ *  - `locale` getter returns the raw attribute value, defaulting to '' when unset (like themeMixin's
+ *    theme/styleId), so callers can pass it straight to setAttribute without emitting "undefined".
+ *  - `localeCandidates` returns the lowercased locales to try, most-specific first: the resolved
+ *    locale and then its language-only fallback (e.g. 'en-us' then 'en'), matching the
+ *    web-component's getHtmlFilenameWithLocale probe order. Falls back to navigator.language.
+ *  - `firstAvailableLocale(availableLocales)` returns the most-specific candidate that the consumer
+ *    actually publishes (e.g. a widget's config.json targetLocales), or '' when none match.
+ */
+const localeMixin = sdkHelpers.createSingletonMixin((superclass) => class LocaleMixinClass extends superclass {
+    get locale() {
+        return this.getAttribute('locale') || '';
+    }
+    get localeCandidates() {
+        const { locale, fallback } = sdkHelpers.getUserLocale(this.locale);
+        return [...new Set([locale, fallback].filter(Boolean))];
+    }
+    firstAvailableLocale(availableLocales) {
+        var _a;
+        const available = (availableLocales !== null && availableLocales !== void 0 ? availableLocales : []).map((l) => l.toLowerCase());
+        // localeCandidates are already lowercased, most-specific first.
+        return (_a = this.localeCandidates.find((c) => available.includes(c))) !== null && _a !== void 0 ? _a : '';
+    }
+});
+
+exports.localeMixin = localeMixin;
+//# sourceMappingURL=localeMixin.js.map

package/dist/cjs/mixins/localeMixin/localeMixin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"localeMixin.js","sources":["../../../../src/mixins/localeMixin/localeMixin.ts"],"sourcesContent":["import { createSingletonMixin, getUserLocale } from '@descope/sdk-helpers';\n\n/**\n * Exposes the widget's locale to mixins that need it (HTML fetching, flow propagation).\n * Mirrors web-component's BaseDescopeWc locale handling:\n *  - `locale` getter returns the raw attribute value, defaulting to '' when unset (like themeMixin's\n *    theme/styleId), so callers can pass it straight to setAttribute without emitting \"undefined\".\n *  - `localeCandidates` returns the lowercased locales to try, most-specific first: the resolved\n *    locale and then its language-only fallback (e.g. 'en-us' then 'en'), matching the\n *    web-component's getHtmlFilenameWithLocale probe order. Falls back to navigator.language.\n *  - `firstAvailableLocale(availableLocales)` returns the most-specific candidate that the consumer\n *    actually publishes (e.g. a widget's config.json targetLocales), or '' when none match.\n */\nexport const localeMixin = createSingletonMixin(\n  <T extends CustomElementConstructor>(superclass: T) =>\n    class LocaleMixinClass extends superclass {\n      get locale(): string {\n        return this.getAttribute('locale') || '';\n      }\n\n      get localeCandidates(): string[] {\n        const { locale, fallback } = getUserLocale(this.locale);\n        return [...new Set([locale, fallback].filter(Boolean))];\n      }\n\n      firstAvailableLocale(availableLocales: string[]): string {\n        const available = (availableLocales ?? []).map((l) => l.toLowerCase());\n        // localeCandidates are already lowercased, most-specific first.\n        return this.localeCandidates.find((c) => available.includes(c)) ?? '';\n      }\n    },\n);\n"],"names":["createSingletonMixin","getUserLocale"],"mappings":";;;;AAEA;;;;;;;;;;AAUG;AACI,MAAM,WAAW,GAAGA,+BAAoB,CAC7C,CAAqC,UAAa,KAChD,MAAM,gBAAiB,SAAQ,UAAU,CAAA;AACvC,IAAA,IAAI,MAAM,GAAA;QACR,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;KAC1C;AAED,IAAA,IAAI,gBAAgB,GAAA;AAClB,QAAA,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAGC,wBAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACxD,QAAA,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;KACzD;AAED,IAAA,oBAAoB,CAAC,gBAA0B,EAAA;;QAC7C,MAAM,SAAS,GAAG,CAAC,gBAAgB,KAAA,IAAA,IAAhB,gBAAgB,KAAhB,KAAA,CAAA,GAAA,gBAAgB,GAAI,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;;QAEvE,OAAO,CAAA,EAAA,GAAA,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAI,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,EAAA,GAAA,EAAE,CAAC;KACvE;AACF,CAAA;;;;"}

package/dist/esm/index.js

@@ -17,6 +17,8 @@ export { projectIdMixin } from './mixins/projectIdMixin.js';
 export { tenantIdMixin } from './mixins/tenantIdMixin.js';
 export { widgetIdMixin } from './mixins/widgetIdMixin.js';
 export { widgetConfigMixin } from './mixins/widgetConfigMixin/widgetConfigMixin.js';
+export { localeMixin } from './mixins/localeMixin/localeMixin.js';
+export { createFetchWidgetPagesMixin } from './mixins/fetchWidgetPagesMixin/createFetchWidgetPagesMixin.js';
 export { baseUrlMixin } from './mixins/baseUrlMixin.js';
 export { cookieConfigMixin } from './mixins/cookieConfigMixin.js';
 export { injectNpmLibMixin } from './mixins/injectNpmLibMixin/injectNpmLibMixin.js';

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/esm/mixins/fetchWidgetPagesMixin/createFetchWidgetPagesMixin.js

@@ -0,0 +1,68 @@
+import { __classPrivateFieldGet } from 'tslib';
+import { createSingletonMixin, compose } from '@descope/sdk-helpers';
+import { localeMixin } from '../localeMixin/localeMixin.js';
+import { staticResourcesMixin } from '../staticResourcesMixin/staticResourcesMixin.js';
+import { widgetConfigMixin } from '../widgetConfigMixin/widgetConfigMixin.js';
+import { widgetIdMixin } from '../widgetIdMixin.js';
+
+/**
+ * Builds a widget's fetchWidgetPagesMixin. Every widget shares identical logic and differs only by
+ * its published base directory (the widget type/name under which its screens live in S3), so each
+ * widget calls this with its own dir:
+ *
+ *   export const fetchWidgetPagesMixin = createFetchWidgetPagesMixin('user-profile-widget');
+ *
+ * `fetchWidgetPage` fetches `<base>/<widgetId>/<file>`, transparently preferring a localized
+ * `<file>-<locale>.html` variant when the widget publishes that locale (config.json targetLocales),
+ * and falling back to the default page otherwise.
+ */
+const createFetchWidgetPagesMixin = (widgetPagesBaseDir) => createSingletonMixin((superclass) => {
+    var _FetchWidgetPagesMixinClass_instances, _FetchWidgetPagesMixinClass_tryFetchLocalized, _a;
+    const BaseClass = compose(staticResourcesMixin, widgetIdMixin, widgetConfigMixin, localeMixin)(superclass);
+    return _a = class FetchWidgetPagesMixinClass extends BaseClass {
+            constructor() {
+                super(...arguments);
+                _FetchWidgetPagesMixinClass_instances.add(this);
+            }
+            // Keep `init` typed as a method across the package boundary (mirrors widgetConfigMixin):
+            // without it, the emitted .d.ts widens the inherited `init` to a property, and a widget
+            // composing this alongside another init-providing mixin (e.g. initLifecycleMixin) hits TS2425.
+            async init() {
+                var _b;
+                await ((_b = super.init) === null || _b === void 0 ? void 0 : _b.call(this));
+            }
+            async fetchWidgetPage(filename) {
+                const localized = await __classPrivateFieldGet(this, _FetchWidgetPagesMixinClass_instances, "m", _FetchWidgetPagesMixinClass_tryFetchLocalized).call(this, filename);
+                if (localized !== undefined)
+                    return localized;
+                const res = await this.fetchStaticResource(`${widgetPagesBaseDir}/${this.widgetId}/${filename}`, 'text');
+                return res === null || res === void 0 ? void 0 : res.body;
+            }
+        },
+        _FetchWidgetPagesMixinClass_instances = new WeakSet(),
+        _FetchWidgetPagesMixinClass_tryFetchLocalized = 
+        // Fetch <page>-<locale>.html when the widget publishes that locale (config.json
+        // targetLocales); otherwise return undefined so the caller falls back to the default page.
+        async function _FetchWidgetPagesMixinClass_tryFetchLocalized(filename) {
+            var _b;
+            const widgetConfig = await this.getWidgetConfig();
+            const userLocale = this.firstAvailableLocale((_b = widgetConfig === null || widgetConfig === void 0 ? void 0 : widgetConfig.targetLocales) !== null && _b !== void 0 ? _b : []);
+            if (!userLocale)
+                return undefined;
+            const ext = '.html';
+            const base = filename.endsWith(ext)
+                ? filename.slice(0, -ext.length)
+                : filename;
+            try {
+                const res = await this.fetchStaticResource(`${widgetPagesBaseDir}/${this.widgetId}/${base}-${userLocale}${ext}`, 'text');
+                return res === null || res === void 0 ? void 0 : res.body;
+            }
+            catch (_c) {
+                return undefined;
+            }
+        },
+        _a;
+});
+
+export { createFetchWidgetPagesMixin };
+//# sourceMappingURL=createFetchWidgetPagesMixin.js.map

package/dist/esm/mixins/fetchWidgetPagesMixin/createFetchWidgetPagesMixin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createFetchWidgetPagesMixin.js","sources":["../../../../src/mixins/fetchWidgetPagesMixin/createFetchWidgetPagesMixin.ts"],"sourcesContent":["import { compose, createSingletonMixin } from '@descope/sdk-helpers';\nimport { localeMixin } from '../localeMixin';\nimport { staticResourcesMixin } from '../staticResourcesMixin';\nimport { widgetConfigMixin } from '../widgetConfigMixin';\nimport { widgetIdMixin } from '../widgetIdMixin';\n\n/**\n * Builds a widget's fetchWidgetPagesMixin. Every widget shares identical logic and differs only by\n * its published base directory (the widget type/name under which its screens live in S3), so each\n * widget calls this with its own dir:\n *\n *   export const fetchWidgetPagesMixin = createFetchWidgetPagesMixin('user-profile-widget');\n *\n * `fetchWidgetPage` fetches `<base>/<widgetId>/<file>`, transparently preferring a localized\n * `<file>-<locale>.html` variant when the widget publishes that locale (config.json targetLocales),\n * and falling back to the default page otherwise.\n */\nexport const createFetchWidgetPagesMixin = (widgetPagesBaseDir: string) =>\n  createSingletonMixin(<T extends CustomElementConstructor>(superclass: T) => {\n    const BaseClass = compose(\n      staticResourcesMixin,\n      widgetIdMixin,\n      widgetConfigMixin,\n      localeMixin,\n    )(superclass);\n    return class FetchWidgetPagesMixinClass extends BaseClass {\n      // Keep `init` typed as a method across the package boundary (mirrors widgetConfigMixin):\n      // without it, the emitted .d.ts widens the inherited `init` to a property, and a widget\n      // composing this alongside another init-providing mixin (e.g. initLifecycleMixin) hits TS2425.\n      async init() {\n        await super.init?.();\n      }\n\n      async fetchWidgetPage(filename: string) {\n        const localized = await this.#tryFetchLocalized(filename);\n        if (localized !== undefined) return localized;\n\n        const res = await this.fetchStaticResource(\n          `${widgetPagesBaseDir}/${this.widgetId}/${filename}`,\n          'text',\n        );\n        return res?.body;\n      }\n\n      // Fetch <page>-<locale>.html when the widget publishes that locale (config.json\n      // targetLocales); otherwise return undefined so the caller falls back to the default page.\n      async #tryFetchLocalized(filename: string): Promise<string | undefined> {\n        const widgetConfig = await this.getWidgetConfig();\n        const userLocale = this.firstAvailableLocale(\n          widgetConfig?.targetLocales ?? [],\n        );\n        if (!userLocale) return undefined;\n\n        const ext = '.html';\n        const base = filename.endsWith(ext)\n          ? filename.slice(0, -ext.length)\n          : filename;\n        try {\n          const res = await this.fetchStaticResource(\n            `${widgetPagesBaseDir}/${this.widgetId}/${base}-${userLocale}${ext}`,\n            'text',\n          );\n          return res?.body;\n        } catch {\n          return undefined;\n        }\n      }\n    };\n  });\n"],"names":[],"mappings":";;;;;;;AAMA;;;;;;;;;;AAUG;AACI,MAAM,2BAA2B,GAAG,CAAC,kBAA0B,KACpE,oBAAoB,CAAC,CAAqC,UAAa,KAAI;;AACzE,IAAA,MAAM,SAAS,GAAG,OAAO,CACvB,oBAAoB,EACpB,aAAa,EACb,iBAAiB,EACjB,WAAW,CACZ,CAAC,UAAU,CAAC,CAAC;IACd,OAAO,EAAA,GAAA,MAAM,0BAA2B,SAAQ,SAAS,CAAA;AAAlD,YAAA,WAAA,GAAA;;;aA0CN;;;;AAtCC,YAAA,MAAM,IAAI,GAAA;;AACR,gBAAA,OAAM,CAAA,EAAA,GAAA,KAAK,CAAC,IAAI,MAAA,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,IAAA,CAAA,IAAA,CAAI,CAAA,CAAC;aACtB;YAED,MAAM,eAAe,CAAC,QAAgB,EAAA;gBACpC,MAAM,SAAS,GAAG,MAAM,sBAAA,CAAA,IAAI,EAAmB,qCAAA,EAAA,GAAA,EAAA,6CAAA,CAAA,CAAA,IAAA,CAAvB,IAAI,EAAoB,QAAQ,CAAC,CAAC;gBAC1D,IAAI,SAAS,KAAK,SAAS;AAAE,oBAAA,OAAO,SAAS,CAAC;AAE9C,gBAAA,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,mBAAmB,CACxC,CAAG,EAAA,kBAAkB,IAAI,IAAI,CAAC,QAAQ,CAAI,CAAA,EAAA,QAAQ,EAAE,EACpD,MAAM,CACP,CAAC;AACF,gBAAA,OAAO,GAAG,KAAH,IAAA,IAAA,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAC;aAClB;AAyBF,SAAA;;;;;AArBC,QAAA,6DAAyB,QAAgB,EAAA;;AACvC,YAAA,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;AAClD,YAAA,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAC1C,CAAA,EAAA,GAAA,YAAY,KAAZ,IAAA,IAAA,YAAY,uBAAZ,YAAY,CAAE,aAAa,MAAI,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,EAAA,GAAA,EAAE,CAClC,CAAC;AACF,YAAA,IAAI,CAAC,UAAU;AAAE,gBAAA,OAAO,SAAS,CAAC;YAElC,MAAM,GAAG,GAAG,OAAO,CAAC;AACpB,YAAA,MAAM,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC;kBAC/B,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC;kBAC9B,QAAQ,CAAC;AACb,YAAA,IAAI;gBACF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,mBAAmB,CACxC,CAAG,EAAA,kBAAkB,CAAI,CAAA,EAAA,IAAI,CAAC,QAAQ,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI,UAAU,CAAA,EAAG,GAAG,CAAE,CAAA,EACpE,MAAM,CACP,CAAC;AACF,gBAAA,OAAO,GAAG,KAAH,IAAA,IAAA,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAC;aAClB;AAAC,YAAA,OAAA,EAAA,EAAM;AACN,gBAAA,OAAO,SAAS,CAAC;aAClB;SACF;AACD,QAAA,EAAA,CAAA;AACJ,CAAC;;;;"}

package/dist/esm/mixins/localeMixin/localeMixin.js

@@ -0,0 +1,31 @@
+import { createSingletonMixin, getUserLocale } from '@descope/sdk-helpers';
+
+/**
+ * Exposes the widget's locale to mixins that need it (HTML fetching, flow propagation).
+ * Mirrors web-component's BaseDescopeWc locale handling:
+ *  - `locale` getter returns the raw attribute value, defaulting to '' when unset (like themeMixin's
+ *    theme/styleId), so callers can pass it straight to setAttribute without emitting "undefined".
+ *  - `localeCandidates` returns the lowercased locales to try, most-specific first: the resolved
+ *    locale and then its language-only fallback (e.g. 'en-us' then 'en'), matching the
+ *    web-component's getHtmlFilenameWithLocale probe order. Falls back to navigator.language.
+ *  - `firstAvailableLocale(availableLocales)` returns the most-specific candidate that the consumer
+ *    actually publishes (e.g. a widget's config.json targetLocales), or '' when none match.
+ */
+const localeMixin = createSingletonMixin((superclass) => class LocaleMixinClass extends superclass {
+    get locale() {
+        return this.getAttribute('locale') || '';
+    }
+    get localeCandidates() {
+        const { locale, fallback } = getUserLocale(this.locale);
+        return [...new Set([locale, fallback].filter(Boolean))];
+    }
+    firstAvailableLocale(availableLocales) {
+        var _a;
+        const available = (availableLocales !== null && availableLocales !== void 0 ? availableLocales : []).map((l) => l.toLowerCase());
+        // localeCandidates are already lowercased, most-specific first.
+        return (_a = this.localeCandidates.find((c) => available.includes(c))) !== null && _a !== void 0 ? _a : '';
+    }
+});
+
+export { localeMixin };
+//# sourceMappingURL=localeMixin.js.map

package/dist/esm/mixins/localeMixin/localeMixin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"localeMixin.js","sources":["../../../../src/mixins/localeMixin/localeMixin.ts"],"sourcesContent":["import { createSingletonMixin, getUserLocale } from '@descope/sdk-helpers';\n\n/**\n * Exposes the widget's locale to mixins that need it (HTML fetching, flow propagation).\n * Mirrors web-component's BaseDescopeWc locale handling:\n *  - `locale` getter returns the raw attribute value, defaulting to '' when unset (like themeMixin's\n *    theme/styleId), so callers can pass it straight to setAttribute without emitting \"undefined\".\n *  - `localeCandidates` returns the lowercased locales to try, most-specific first: the resolved\n *    locale and then its language-only fallback (e.g. 'en-us' then 'en'), matching the\n *    web-component's getHtmlFilenameWithLocale probe order. Falls back to navigator.language.\n *  - `firstAvailableLocale(availableLocales)` returns the most-specific candidate that the consumer\n *    actually publishes (e.g. a widget's config.json targetLocales), or '' when none match.\n */\nexport const localeMixin = createSingletonMixin(\n  <T extends CustomElementConstructor>(superclass: T) =>\n    class LocaleMixinClass extends superclass {\n      get locale(): string {\n        return this.getAttribute('locale') || '';\n      }\n\n      get localeCandidates(): string[] {\n        const { locale, fallback } = getUserLocale(this.locale);\n        return [...new Set([locale, fallback].filter(Boolean))];\n      }\n\n      firstAvailableLocale(availableLocales: string[]): string {\n        const available = (availableLocales ?? []).map((l) => l.toLowerCase());\n        // localeCandidates are already lowercased, most-specific first.\n        return this.localeCandidates.find((c) => available.includes(c)) ?? '';\n      }\n    },\n);\n"],"names":[],"mappings":";;AAEA;;;;;;;;;;AAUG;AACI,MAAM,WAAW,GAAG,oBAAoB,CAC7C,CAAqC,UAAa,KAChD,MAAM,gBAAiB,SAAQ,UAAU,CAAA;AACvC,IAAA,IAAI,MAAM,GAAA;QACR,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;KAC1C;AAED,IAAA,IAAI,gBAAgB,GAAA;AAClB,QAAA,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACxD,QAAA,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;KACzD;AAED,IAAA,oBAAoB,CAAC,gBAA0B,EAAA;;QAC7C,MAAM,SAAS,GAAG,CAAC,gBAAgB,KAAA,IAAA,IAAhB,gBAAgB,KAAhB,KAAA,CAAA,GAAA,gBAAgB,GAAI,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;;QAEvE,OAAO,CAAA,EAAA,GAAA,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAI,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,EAAA,GAAA,EAAE,CAAC;KACvE;AACF,CAAA;;;;"}