@atlasauth/js 0.10.0 → 0.12.0

package/dist/sign-out-events.d.ts

@@ -0,0 +1,54 @@
+/**
+ * `onSignOut({ reason })` for embedded third parties (a support-chat widget, a
+ * docs reader session, analytics identity) that must reset when the user stops
+ * being signed in — on EVERY path, not only the app's own sign-out button:
+ *
+ *   - `user`            this tab called signOut()
+ *   - `other_tab`       another tab of this app signed out (BroadcastChannel / storage signal)
+ *   - `session_expired` the session ran out (idle or absolute lifetime)
+ *   - `revoked`         the session was ended elsewhere (signed out on another
+ *                       device, revoked by an admin, banned), detected on the
+ *                       next token refresh or session re-check
+ *   - `unknown`         signed out without a reason the SDK could tell
+ *
+ * Framework providers drive one {@link SignOutNotifier}: it fires listeners
+ * once per signed-in → signed-out transition and also dispatches a
+ * `atlas:signout` DOM event on `window`, so a script that has no access to the
+ * app's component tree can listen too:
+ *
+ *   window.addEventListener('atlas:signout', (e) => Chatly('reset'));
+ */
+export type SignOutReason = 'user' | 'other_tab' | 'session_expired' | 'revoked' | 'unknown';
+export interface SignOutEvent {
+    reason: SignOutReason;
+    /** The session that ended, when the SDK knew it. */
+    sessionId: string | null;
+}
+/** The `window` event name. */
+export declare const SIGN_OUT_EVENT = "atlas:signout";
+export type SignOutListener = (event: SignOutEvent) => void;
+/** Map a signed-out `/v1/client` body's `signed_out_reason` to a reason. */
+export declare function signOutReasonFromClient(body: unknown): SignOutReason;
+export declare class SignOutNotifier {
+    private readonly listeners;
+    private hint;
+    /** Subscribe; returns the unsubscribe. */
+    subscribe(listener: SignOutListener): () => void;
+    /**
+     * Note WHY the next sign-out is about to happen (call before the state
+     * changes). The first hint wins until the event fires: a user sign-out that
+     * also broadcasts to its own tab stays `user`.
+     */
+    expect(reason: SignOutReason): void;
+    /** Drop a stale hint (e.g. the session survived after all). */
+    clear(): void;
+    /**
+     * The provider went signed-in → signed-out: fire listeners and the DOM event
+     * once, with the hinted reason (else `fallback`, else `unknown`).
+     */
+    signedOut(sessionId: string | null, fallback?: SignOutReason): SignOutEvent;
+}
+/** Dispatch the `atlas:signout` window event (a no-op outside a browser). */
+export declare function dispatchSignOutEvent(event: SignOutEvent): void;
+/** Listen for `atlas:signout` on `window` from any framework; returns the unsubscribe. */
+export declare function onAtlasSignOut(listener: SignOutListener): () => void;

package/dist/sign-out-events.js

@@ -0,0 +1,97 @@
+"use strict";
+/**
+ * `onSignOut({ reason })` for embedded third parties (a support-chat widget, a
+ * docs reader session, analytics identity) that must reset when the user stops
+ * being signed in — on EVERY path, not only the app's own sign-out button:
+ *
+ *   - `user`            this tab called signOut()
+ *   - `other_tab`       another tab of this app signed out (BroadcastChannel / storage signal)
+ *   - `session_expired` the session ran out (idle or absolute lifetime)
+ *   - `revoked`         the session was ended elsewhere (signed out on another
+ *                       device, revoked by an admin, banned), detected on the
+ *                       next token refresh or session re-check
+ *   - `unknown`         signed out without a reason the SDK could tell
+ *
+ * Framework providers drive one {@link SignOutNotifier}: it fires listeners
+ * once per signed-in → signed-out transition and also dispatches a
+ * `atlas:signout` DOM event on `window`, so a script that has no access to the
+ * app's component tree can listen too:
+ *
+ *   window.addEventListener('atlas:signout', (e) => Chatly('reset'));
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SignOutNotifier = exports.SIGN_OUT_EVENT = void 0;
+exports.signOutReasonFromClient = signOutReasonFromClient;
+exports.dispatchSignOutEvent = dispatchSignOutEvent;
+exports.onAtlasSignOut = onAtlasSignOut;
+/** The `window` event name. */
+exports.SIGN_OUT_EVENT = 'atlas:signout';
+/** Map a signed-out `/v1/client` body's `signed_out_reason` to a reason. */
+function signOutReasonFromClient(body) {
+    const reason = body?.signed_out_reason;
+    return reason === 'session_expired' || reason === 'revoked' ? reason : 'unknown';
+}
+class SignOutNotifier {
+    listeners = new Set();
+    hint = null;
+    /** Subscribe; returns the unsubscribe. */
+    subscribe(listener) {
+        this.listeners.add(listener);
+        return () => this.listeners.delete(listener);
+    }
+    /**
+     * Note WHY the next sign-out is about to happen (call before the state
+     * changes). The first hint wins until the event fires: a user sign-out that
+     * also broadcasts to its own tab stays `user`.
+     */
+    expect(reason) {
+        if (this.hint === null)
+            this.hint = reason;
+    }
+    /** Drop a stale hint (e.g. the session survived after all). */
+    clear() {
+        this.hint = null;
+    }
+    /**
+     * The provider went signed-in → signed-out: fire listeners and the DOM event
+     * once, with the hinted reason (else `fallback`, else `unknown`).
+     */
+    signedOut(sessionId, fallback) {
+        const event = { reason: this.hint ?? fallback ?? 'unknown', sessionId };
+        this.hint = null;
+        for (const listener of [...this.listeners]) {
+            try {
+                listener(event);
+            }
+            catch {
+                // A listener that throws must not stop the others (or the sign-out).
+            }
+        }
+        dispatchSignOutEvent(event);
+        return event;
+    }
+}
+exports.SignOutNotifier = SignOutNotifier;
+/** Dispatch the `atlas:signout` window event (a no-op outside a browser). */
+function dispatchSignOutEvent(event) {
+    if (typeof window === 'undefined' || typeof window.dispatchEvent !== 'function')
+        return;
+    try {
+        const Ctor = globalThis.CustomEvent;
+        if (!Ctor)
+            return;
+        window.dispatchEvent(new Ctor(exports.SIGN_OUT_EVENT, { detail: event }));
+    }
+    catch {
+        // Never let a DOM quirk break a sign-out.
+    }
+}
+/** Listen for `atlas:signout` on `window` from any framework; returns the unsubscribe. */
+function onAtlasSignOut(listener) {
+    if (typeof window === 'undefined')
+        return () => undefined;
+    const handler = (e) => listener(e.detail);
+    window.addEventListener(exports.SIGN_OUT_EVENT, handler);
+    return () => window.removeEventListener(exports.SIGN_OUT_EVENT, handler);
+}
+//# sourceMappingURL=sign-out-events.js.map

package/dist/sign-out-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sign-out-events.js","sourceRoot":"","sources":["../src/sign-out-events.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;GAmBG;;;AAgBH,0DAGC;AA8CD,oDASC;AAGD,wCAKC;AAxED,+BAA+B;AAClB,QAAA,cAAc,GAAG,eAAe,CAAC;AAI9C,4EAA4E;AAC5E,SAAgB,uBAAuB,CAAC,IAAa;IACnD,MAAM,MAAM,GAAI,IAA+C,EAAE,iBAAiB,CAAC;IACnF,OAAO,MAAM,KAAK,iBAAiB,IAAI,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AACnF,CAAC;AAED,MAAa,eAAe;IACT,SAAS,GAAG,IAAI,GAAG,EAAmB,CAAC;IAChD,IAAI,GAAyB,IAAI,CAAC;IAE1C,0CAA0C;IAC1C,SAAS,CAAC,QAAyB;QACjC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC7B,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,MAAqB;QAC1B,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI;YAAE,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC;IAC7C,CAAC;IAED,+DAA+D;IAC/D,KAAK;QACH,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,SAAwB,EAAE,QAAwB;QAC1D,MAAM,KAAK,GAAiB,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,IAAI,QAAQ,IAAI,SAAS,EAAE,SAAS,EAAE,CAAC;QACtF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,KAAK,MAAM,QAAQ,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC3C,IAAI,CAAC;gBACH,QAAQ,CAAC,KAAK,CAAC,CAAC;YAClB,CAAC;YAAC,MAAM,CAAC;gBACP,qEAAqE;YACvE,CAAC;QACH,CAAC;QACD,oBAAoB,CAAC,KAAK,CAAC,CAAC;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAzCD,0CAyCC;AAED,6EAA6E;AAC7E,SAAgB,oBAAoB,CAAC,KAAmB;IACtD,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,OAAO,MAAM,CAAC,aAAa,KAAK,UAAU;QAAE,OAAO;IACxF,IAAI,CAAC;QACH,MAAM,IAAI,GAAI,UAAmD,CAAC,WAAW,CAAC;QAC9E,IAAI,CAAC,IAAI;YAAE,OAAO;QAClB,MAAM,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,sBAAc,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACpE,CAAC;IAAC,MAAM,CAAC;QACP,0CAA0C;IAC5C,CAAC;AACH,CAAC;AAED,0FAA0F;AAC1F,SAAgB,cAAc,CAAC,QAAyB;IACtD,IAAI,OAAO,MAAM,KAAK,WAAW;QAAE,OAAO,GAAG,EAAE,CAAC,SAAS,CAAC;IAC1D,MAAM,OAAO,GAAG,CAAC,CAAQ,EAAE,EAAE,CAAC,QAAQ,CAAE,CAA+B,CAAC,MAAM,CAAC,CAAC;IAChF,MAAM,CAAC,gBAAgB,CAAC,sBAAc,EAAE,OAAO,CAAC,CAAC;IACjD,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,mBAAmB,CAAC,sBAAc,EAAE,OAAO,CAAC,CAAC;AACnE,CAAC"}

package/dist/version.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This package's version, sent as `X-Atlas-SDK: @atlasauth/js/<version>` so the
+ * Frontend API can answer an upgrade advisory. A constant (not read from
+ * package.json at runtime) so the bundle stays dependency-free and tests stay
+ * deterministic; `version.test.ts` fails when it drifts from package.json.
+ */
+export declare const ATLAS_JS_VERSION = "0.12.0";

package/dist/version.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ATLAS_JS_VERSION = void 0;
+/**
+ * This package's version, sent as `X-Atlas-SDK: @atlasauth/js/<version>` so the
+ * Frontend API can answer an upgrade advisory. A constant (not read from
+ * package.json at runtime) so the bundle stays dependency-free and tests stay
+ * deterministic; `version.test.ts` fails when it drifts from package.json.
+ */
+exports.ATLAS_JS_VERSION = '0.12.0';
+//# sourceMappingURL=version.js.map

package/dist/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACU,QAAA,gBAAgB,GAAG,QAAQ,CAAC"}

package/package.json

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