@atlasauth/js 0.10.0 → 0.11.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlasauth/js changelog
 
+## 0.11.0
+- **New: `fetchAtlasInitialState({ publishableKey, frontendApi, fetchImpl?, init?, timeoutMs? })`** →
+  `Promise<AtlasInitialState>` (`{ appearance?: unknown; environment?: unknown }`). Fetches `/v1/appearance` and
+  `/v1/client/environment` in parallel on the server, for a provider's `initialState`. Never throws: a part that
+  fails or takes longer than `timeoutMs` (default 1500) is left out. `init` is passed to both requests (for example
+  `{ next: { revalidate: 60 } }`).
+- New types `AtlasInitialState` and `FetchInitialStateOptions`.
+
 ## 0.10.0
 - **New: `planFirstFactor(offered)`** → `{ password: boolean; email: ('email_code' | 'email_link')[]; autoSend: 'email_code' | 'email_link' | null }`.
   The rule every prebuilt sign-in form follows: a password field only when the server offers `password`; with no

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export * from './token-cache';
 export * from './tab-election';
 export * from './attempt';
 export * from './first-factor';
+export * from './initial-state';
 export * from './errors';
 export * from './redirect';
 export * from './popup-channel';

package/dist/index.js

@@ -24,6 +24,7 @@ __exportStar(require("./token-cache"), exports);
 __exportStar(require("./tab-election"), exports);
 __exportStar(require("./attempt"), exports);
 __exportStar(require("./first-factor"), exports);
+__exportStar(require("./initial-state"), exports);
 // Server errors in the app's language (`error.<reason>` catalog keys).
 __exportStar(require("./errors"), exports);
 __exportStar(require("./redirect"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,6EAA6E;AAC7E,2CAAyB;AACzB,6CAA2B;AAC3B,sFAAsF;AACtF,mDAAiC;AACjC,gDAA8B;AAC9B,iDAA+B;AAC/B,4CAA0B;AAC1B,iDAA+B;AAC/B,uEAAuE;AACvE,2CAAyB;AACzB,6CAA2B;AAC3B,qFAAqF;AACrF,kDAAgC;AAChC,yCAAuB;AACvB,2CAAyB;AACzB,mDAAiC;AACjC,4CAA0B;AAC1B,6CAA2B;AAC3B,yCAAuB;AACvB,8CAA4B;AAC5B,2CAAyB;AACzB,4DAA4D;AAC5D,6CAA2B;AAC3B,4CAA0B;AAC1B,mDAAiC;AACjC,kDAAgC;AAChC,sDAAsD;AACtD,wDAAsC;AACtC,+EAA+E;AAC/E,2EAA2E;AAC3E,4CAA0B;AAC1B,kFAAkF;AAClF,mDAAiC;AACjC,kFAAkF;AAClF,yEAAyE;AACzE,oEAAoE;AACpE,uDAAqC;AACrC,sDAAoC;AACpC,uEAAuE;AACvE,gDAA8B;AAC9B,0EAA0E;AAC1E,4EAA4E;AAC5E,0CAa0B;AARxB,iGAAA,QAAQ,OAAA;AACR,sGAAA,aAAa,OAAA;AACb,0GAAA,iBAAiB,OAAA;AACjB,uGAAA,cAAc,OAAA;AACd,yGAAA,gBAAgB,OAAA;AAChB,+GAAA,sBAAsB,OAAA;AACtB,kGAAA,SAAS,OAAA;AACT,wGAAA,eAAe,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,6EAA6E;AAC7E,2CAAyB;AACzB,6CAA2B;AAC3B,sFAAsF;AACtF,mDAAiC;AACjC,gDAA8B;AAC9B,iDAA+B;AAC/B,4CAA0B;AAC1B,iDAA+B;AAC/B,kDAAgC;AAChC,uEAAuE;AACvE,2CAAyB;AACzB,6CAA2B;AAC3B,qFAAqF;AACrF,kDAAgC;AAChC,yCAAuB;AACvB,2CAAyB;AACzB,mDAAiC;AACjC,4CAA0B;AAC1B,6CAA2B;AAC3B,yCAAuB;AACvB,8CAA4B;AAC5B,2CAAyB;AACzB,4DAA4D;AAC5D,6CAA2B;AAC3B,4CAA0B;AAC1B,mDAAiC;AACjC,kDAAgC;AAChC,sDAAsD;AACtD,wDAAsC;AACtC,+EAA+E;AAC/E,2EAA2E;AAC3E,4CAA0B;AAC1B,kFAAkF;AAClF,mDAAiC;AACjC,kFAAkF;AAClF,yEAAyE;AACzE,oEAAoE;AACpE,uDAAqC;AACrC,sDAAoC;AACpC,uEAAuE;AACvE,gDAA8B;AAC9B,0EAA0E;AAC1E,4EAA4E;AAC5E,0CAa0B;AARxB,iGAAA,QAAQ,OAAA;AACR,sGAAA,aAAa,OAAA;AACb,0GAAA,iBAAiB,OAAA;AACjB,uGAAA,cAAc,OAAA;AACd,yGAAA,gBAAgB,OAAA;AAChB,+GAAA,sBAAsB,OAAA;AACtB,kGAAA,SAAS,OAAA;AACT,wGAAA,eAAe,OAAA"}

package/dist/initial-state.d.ts

@@ -0,0 +1,34 @@
+/**
+ * The public, per-instance data a sign-in panel needs before it can paint: the
+ * dashboard design and sign-in settings (`GET /v1/appearance`) and the enabled
+ * sign-in methods and social buttons (`GET /v1/client/environment`).
+ *
+ * Fetched on the SERVER and handed to the provider (`initialState`), the panel
+ * renders fully styled, with its social buttons, in the first HTML — no
+ * round trips from the browser before it looks right. Both responses are public
+ * and identical for every visitor of an instance, so they cache well.
+ *
+ * Never throws: a part that can't be fetched is left out and the browser fetches
+ * it as before, so a slow or unreachable API can't break the page render.
+ */
+export interface AtlasInitialState {
+    /** The raw `GET /v1/appearance` body. */
+    appearance?: unknown;
+    /** The raw `GET /v1/client/environment` body. */
+    environment?: unknown;
+}
+export interface FetchInitialStateOptions {
+    publishableKey: string;
+    /** The Frontend API origin, e.g. `https://auth.example.com`. */
+    frontendApi: string;
+    /** Defaults to the global `fetch`. */
+    fetchImpl?: typeof fetch;
+    /**
+     * Extra `fetch` options for both requests — e.g. `{ next: { revalidate: 60 } }`
+     * on Next.js to cache them between renders.
+     */
+    init?: RequestInit & Record<string, unknown>;
+    /** Give up on a request after this long and leave it to the browser. Default 1500 ms. */
+    timeoutMs?: number;
+}
+export declare function fetchAtlasInitialState(options: FetchInitialStateOptions): Promise<AtlasInitialState>;

package/dist/initial-state.js

@@ -0,0 +1,53 @@
+"use strict";
+/**
+ * The public, per-instance data a sign-in panel needs before it can paint: the
+ * dashboard design and sign-in settings (`GET /v1/appearance`) and the enabled
+ * sign-in methods and social buttons (`GET /v1/client/environment`).
+ *
+ * Fetched on the SERVER and handed to the provider (`initialState`), the panel
+ * renders fully styled, with its social buttons, in the first HTML — no
+ * round trips from the browser before it looks right. Both responses are public
+ * and identical for every visitor of an instance, so they cache well.
+ *
+ * Never throws: a part that can't be fetched is left out and the browser fetches
+ * it as before, so a slow or unreachable API can't break the page render.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchAtlasInitialState = fetchAtlasInitialState;
+async function fetchAtlasInitialState(options) {
+    const doFetch = options.fetchImpl ?? (typeof fetch === 'function' ? fetch : undefined);
+    if (!doFetch || !options.publishableKey || !options.frontendApi)
+        return {};
+    const base = options.frontendApi.replace(/\/+$/, '');
+    const timeoutMs = options.timeoutMs ?? 1500;
+    const get = async (path) => {
+        const controller = typeof AbortController === 'function' ? new AbortController() : null;
+        const timer = controller ? setTimeout(() => controller.abort(), timeoutMs) : null;
+        try {
+            const res = await doFetch(`${base}${path}`, {
+                ...options.init,
+                method: 'GET',
+                headers: { accept: 'application/json', 'x-publishable-key': options.publishableKey },
+                ...(controller ? { signal: controller.signal } : {}),
+            });
+            if (!res.ok)
+                return undefined;
+            return (await res.json());
+        }
+        catch {
+            return undefined;
+        }
+        finally {
+            if (timer)
+                clearTimeout(timer);
+        }
+    };
+    const [appearance, environment] = await Promise.all([get('/v1/appearance'), get('/v1/client/environment')]);
+    const state = {};
+    if (appearance && typeof appearance === 'object')
+        state.appearance = appearance;
+    if (environment && typeof environment === 'object')
+        state.environment = environment;
+    return state;
+}
+//# sourceMappingURL=initial-state.js.map

package/dist/initial-state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"initial-state.js","sourceRoot":"","sources":["../src/initial-state.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG;;AAwBH,wDA8BC;AA9BM,KAAK,UAAU,sBAAsB,CAAC,OAAiC;IAC5E,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,IAAI,CAAC,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACvF,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,CAAC,OAAO,CAAC,WAAW;QAAE,OAAO,EAAE,CAAC;IAC3E,MAAM,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACrD,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC;IAE5C,MAAM,GAAG,GAAG,KAAK,EAAE,IAAY,EAAoB,EAAE;QACnD,MAAM,UAAU,GAAG,OAAO,eAAe,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,eAAe,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QACxF,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAClF,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,GAAG,IAAI,GAAG,IAAI,EAAE,EAAE;gBAC1C,GAAG,OAAO,CAAC,IAAI;gBACf,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,OAAO,CAAC,cAAc,EAAE;gBACpF,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACrD,CAAC,CAAC;YACH,IAAI,CAAC,GAAG,CAAC,EAAE;gBAAE,OAAO,SAAS,CAAC;YAC9B,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAY,CAAC;QACvC,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;gBAAS,CAAC;YACT,IAAI,KAAK;gBAAE,YAAY,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,CAAC,UAAU,EAAE,WAAW,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAE,GAAG,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC;IAC5G,MAAM,KAAK,GAAsB,EAAE,CAAC;IACpC,IAAI,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ;QAAE,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC;IAChF,IAAI,WAAW,IAAI,OAAO,WAAW,KAAK,QAAQ;QAAE,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;IACpF,OAAO,KAAK,CAAC;AACf,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlasauth/js",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "devDependencies": {