@brendanbank/atrium-host-types 0.17.0 → 0.18.0

package/README.md

@@ -32,8 +32,8 @@ your `.npmrc`, delete it — npmjs.org is the default registry.
 
 ## Versioning
 
-The package version tracks atrium's image version. Pin `^0.17` for
-"compatible with atrium 0.17.x"; bump together with the atrium image
+The package version tracks atrium's image version. Pin `^0.18` for
+"compatible with atrium 0.18.x"; bump together with the atrium image
 to pick up new registry slots. New slots land as **optional** members
 on `AtriumRegistry` first so a host that hasn't bumped yet still
 type-checks.

package/dist/index.d.ts

@@ -44,6 +44,33 @@ export interface AdminUserRow {
     role_ids: number[];
     roles: string[];
 }
+/** Detail payload of the ``atrium:userchange`` window CustomEvent
+ *  atrium dispatches whenever the signed-in user identity changes —
+ *  login, logout, logout-all, impersonation start/stop, same-tab
+ *  re-login as a different user. ``previous`` and ``current`` are user
+ *  ids; ``null`` means signed out (or, for ``previous``, transitioning
+ *  out of the signed-out state). ``nonce`` is a monotonic per-event
+ *  counter. The event does NOT fire on first identity observation
+ *  after a page load (the user has not changed).
+ *
+ *  Available since atrium 0.18. The canonical use is host bundles
+ *  clearing their own QueryClient cache when the user changes — atrium
+ *  clears its own cache via ``qc.clear()`` on logout, but a host bundle
+ *  runs a separate QueryClient (by design — see
+ *  ``@brendanbank/atrium-host-bundle-utils/react``) and needs an
+ *  external signal:
+ *
+ *  ```ts
+ *  window.addEventListener('atrium:userchange', () => {
+ *    hostQueryClient.clear();
+ *  });
+ *  ```
+ */
+export interface AtriumUserChangeDetail {
+    previous: number | null;
+    current: number | null;
+    nonce: number;
+}
 /** A single notification row as the SPA sees it. `kind` is host-defined;
  *  `payload` is opaque JSON. `read_at` is null until the user clears the
  *  bell; `created_at` is the server-side timestamp. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brendanbank/atrium-host-types",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "description": "TypeScript declarations for the atrium host-extension contract: AtriumRegistry, UserContext, AdminUserRow, AtriumNotification, AtriumEvent. Source-of-truth shapes a host bundle types against, kept in sync with atrium's published image major.minor.",
   "license": "BSD-2-Clause",
   "type": "module",