@payloadcms/ui 4.0.0-internal.d28e9fb → 4.0.0-internal.d3909a9

package/dist/providers/Auth/tabSessionSync/useTabSessionSync.js

@@ -0,0 +1,90 @@
+'use client';
+
+import { c as _c } from "react/compiler-runtime";
+import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
+import { createTabSessionSync } from './index.js';
+/** Connects the Auth provider to one cross-tab session coordinator for the current browser tab. */
+export function useTabSessionSync(options) {
+  const $ = _c(9);
+  const [sourceTabID] = useState(createTabID);
+  const optionsRef = useRef(options);
+  const tabSessionSyncRef = useRef(undefined);
+  let t0;
+  let t1;
+  if ($[0] !== options) {
+    t0 = () => {
+      optionsRef.current = options;
+    };
+    t1 = [options];
+    $[0] = options;
+    $[1] = t0;
+    $[2] = t1;
+  } else {
+    t0 = $[1];
+    t1 = $[2];
+  }
+  useEffect(t0, t1);
+  let t2;
+  let t3;
+  if ($[3] !== sourceTabID) {
+    t2 = () => {
+      const tabSessionSync = createTabSessionSync({
+        getTokenExpirationMs: () => optionsRef.current.getTokenExpirationMs(),
+        onSessionExpired: expiredTokenAt => optionsRef.current.onSessionExpired(expiredTokenAt),
+        onSessionLoggedOut: () => optionsRef.current.onSessionLoggedOut(),
+        onSessionRefreshed: session => optionsRef.current.onSessionRefreshed(session),
+        onTabSessionUnauthenticated: () => optionsRef.current.onTabSessionUnauthenticated(),
+        reconcileSession: reconciliationOptions => optionsRef.current.reconcileSession(reconciliationOptions),
+        sourceTabID
+      });
+      tabSessionSyncRef.current = tabSessionSync;
+      return () => {
+        if (tabSessionSyncRef.current === tabSessionSync) {
+          tabSessionSyncRef.current = undefined;
+        }
+        tabSessionSync.cleanup();
+      };
+    };
+    t3 = [sourceTabID];
+    $[3] = sourceTabID;
+    $[4] = t2;
+    $[5] = t3;
+  } else {
+    t2 = $[4];
+    t3 = $[5];
+  }
+  useEffect(t2, t3);
+  let t4;
+  if ($[6] === Symbol.for("react.memo_cache_sentinel")) {
+    t4 = event => tabSessionSyncRef.current?.broadcast(event);
+    $[6] = t4;
+  } else {
+    t4 = $[6];
+  }
+  const broadcast = t4;
+  let t5;
+  if ($[7] === Symbol.for("react.memo_cache_sentinel")) {
+    t5 = publication => {
+      tabSessionSyncRef.current?.broadcastLogoutSettlement(publication);
+    };
+    $[7] = t5;
+  } else {
+    t5 = $[7];
+  }
+  const broadcastLogoutSettlement = t5;
+  let t6;
+  if ($[8] === Symbol.for("react.memo_cache_sentinel")) {
+    t6 = {
+      broadcast,
+      broadcastLogoutSettlement
+    };
+    $[8] = t6;
+  } else {
+    t6 = $[8];
+  }
+  return t6;
+}
+function createTabID() {
+  return globalThis.crypto?.randomUUID?.() ?? `${Date.now()}-${Math.random()}`;
+}
+//# sourceMappingURL=useTabSessionSync.js.map

package/dist/providers/Auth/tabSessionSync/useTabSessionSync.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTabSessionSync.js","names":["c","_c","useCallback","useEffect","useMemo","useRef","useState","createTabSessionSync","useTabSessionSync","options","$","sourceTabID","createTabID","optionsRef","tabSessionSyncRef","undefined","t0","t1","current","t2","t3","tabSessionSync","getTokenExpirationMs","onSessionExpired","expiredTokenAt","onSessionLoggedOut","onSessionRefreshed","session","onTabSessionUnauthenticated","reconcileSession","reconciliationOptions","cleanup","t4","Symbol","for","event","broadcast","t5","publication","broadcastLogoutSettlement","t6","globalThis","crypto","randomUUID","Date","now","Math","random"],"sources":["../../../../src/providers/Auth/tabSessionSync/useTabSessionSync.ts"],"sourcesContent":["'use client'\n\nimport { useCallback, useEffect, useMemo, useRef, useState } from 'react'\n\nimport type {\n  TabSessionEvent,\n  TabSessionLogoutPublication,\n  TabSessionPublication,\n} from './index.js'\n\nimport { createTabSessionSync } from './index.js'\n\nexport type TabSessionSync = {\n  /** Broadcasts a session lifecycle event to the other browser tabs. */\n  broadcast: (event: TabSessionEvent) => TabSessionPublication | undefined\n  /** Notifies storage-fallback tabs after the server-side logout request settles. */\n  broadcastLogoutSettlement: (publication: TabSessionLogoutPublication) => void\n}\n\n/** Connects the Auth provider to one cross-tab session coordinator for the current browser tab. */\nexport function useTabSessionSync(\n  options: Omit<Parameters<typeof createTabSessionSync>[0], 'sourceTabID'>,\n): TabSessionSync {\n  const [sourceTabID] = useState(createTabID)\n  const optionsRef = useRef(options)\n  const tabSessionSyncRef = useRef<ReturnType<typeof createTabSessionSync>>(undefined)\n\n  useEffect(() => {\n    optionsRef.current = options\n  }, [options])\n\n  useEffect(() => {\n    const tabSessionSync = createTabSessionSync({\n      getTokenExpirationMs: () => optionsRef.current.getTokenExpirationMs(),\n      onSessionExpired: (expiredTokenAt) => optionsRef.current.onSessionExpired(expiredTokenAt),\n      onSessionLoggedOut: () => optionsRef.current.onSessionLoggedOut(),\n      onSessionRefreshed: (session) => optionsRef.current.onSessionRefreshed(session),\n      onTabSessionUnauthenticated: () => optionsRef.current.onTabSessionUnauthenticated(),\n      reconcileSession: (reconciliationOptions) =>\n        optionsRef.current.reconcileSession(reconciliationOptions),\n      sourceTabID,\n    })\n\n    tabSessionSyncRef.current = tabSessionSync\n\n    return () => {\n      if (tabSessionSyncRef.current === tabSessionSync) {\n        tabSessionSyncRef.current = undefined\n      }\n\n      tabSessionSync.cleanup()\n    }\n  }, [sourceTabID])\n\n  const broadcast = useCallback(\n    (event: TabSessionEvent) => tabSessionSyncRef.current?.broadcast(event),\n    [],\n  )\n  const broadcastLogoutSettlement = useCallback((publication: TabSessionLogoutPublication) => {\n    tabSessionSyncRef.current?.broadcastLogoutSettlement(publication)\n  }, [])\n\n  return useMemo(\n    () => ({ broadcast, broadcastLogoutSettlement }),\n    [broadcast, broadcastLogoutSettlement],\n  )\n}\n\nfunction createTabID(): string {\n  return globalThis.crypto?.randomUUID?.() ?? `${Date.now()}-${Math.random()}`\n}\n"],"mappings":"AAAA;;AAAA,SAAAA,CAAA,IAAAC,EAAA;AAEA,SAASC,WAAW,EAAEC,SAAS,EAAEC,OAAO,EAAEC,MAAM,EAAEC,QAAQ,QAAQ;AAQlE,SAASC,oBAAoB,QAAQ;AASrC;AACA,OAAO,SAAAC,kBAAAC,OAAA;EAAA,MAAAC,CAAA,GAAAT,EAAA;EAGL,OAAAU,WAAA,IAAsBL,QAAA,CAAAM,WAAS;EAC/B,MAAAC,UAAA,GAAmBR,MAAA,CAAOI,OAAA;EAC1B,MAAAK,iBAAA,GAA0BT,MAAA,CAAAU,SAAgD;EAAA,IAAAC,EAAA;EAAA,IAAAC,EAAA;EAAA,IAAAP,CAAA,QAAAD,OAAA;IAEhEO,EAAA,GAAAA,CAAA;MACRH,UAAA,CAAAK,OAAA,GAAqBT,OAAA;IAAA;IACpBQ,EAAA,IAACR,OAAA;IAAQC,CAAA,MAAAD,OAAA;IAAAC,CAAA,MAAAM,EAAA;IAAAN,CAAA,MAAAO,EAAA;EAAA;IAAAD,EAAA,GAAAN,CAAA;IAAAO,EAAA,GAAAP,CAAA;EAAA;EAFZP,SAAA,CAAUa,EAEV,EAAGC,EAAS;EAAA,IAAAE,EAAA;EAAA,IAAAC,EAAA;EAAA,IAAAV,CAAA,QAAAC,WAAA;IAEFQ,EAAA,GAAAA,CAAA;MACR,MAAAE,cAAA,GAAuBd,oBAAA;QAAAe,oBAAA,EAAAA,CAAA,KACOT,UAAA,CAAAK,OAAA,CAAAI,oBAAA,CAAuC;QAAAC,gBAAA,EAAAC,cAAA,IAC7BX,UAAA,CAAAK,OAAA,CAAAK,gBAAA,CAAoCC,cAAA;QAAAC,kBAAA,EAAAA,CAAA,KAChDZ,UAAA,CAAAK,OAAA,CAAAO,kBAAA,CAAqC;QAAAC,kBAAA,EAAAC,OAAA,IAC9Bd,UAAA,CAAAK,OAAA,CAAAQ,kBAAA,CAAsCC,OAAA;QAAAC,2BAAA,EAAAA,CAAA,KACpCf,UAAA,CAAAK,OAAA,CAAAU,2BAAA,CAA8C;QAAAC,gBAAA,EAAAC,qBAAA,IAE/EjB,UAAA,CAAAK,OAAA,CAAAW,gBAAA,CAAoCC,qBAAA;QAAAnB;MAAA,CAExC;MAEAG,iBAAA,CAAAI,OAAA,GAA4BG,cAAA;MAAA;QAAA,IAGtBP,iBAAA,CAAAI,OAAA,KAA8BG,cAAA;UAChCP,iBAAA,CAAAI,OAAA,GAAAH,SAAA;QAAA;QAGFM,cAAA,CAAAU,OAAA,CAAsB;MAAA;IAAA;IAEvBX,EAAA,IAACT,WAAA;IAAYD,CAAA,MAAAC,WAAA;IAAAD,CAAA,MAAAS,EAAA;IAAAT,CAAA,MAAAU,EAAA;EAAA;IAAAD,EAAA,GAAAT,CAAA;IAAAU,EAAA,GAAAV,CAAA;EAAA;EArBhBP,SAAA,CAAUgB,EAqBV,EAAGC,EAAa;EAAA,IAAAY,EAAA;EAAA,IAAAtB,CAAA,QAAAuB,MAAA,CAAAC,GAAA;IAGdF,EAAA,GAAAG,KAAA,IAA4BrB,iBAAA,CAAAI,OAAA,EAAAkB,SAAA,CAAqCD,KAAA;IAAAzB,CAAA,MAAAsB,EAAA;EAAA;IAAAA,EAAA,GAAAtB,CAAA;EAAA;EADnE,MAAA0B,SAAA,GAAkBJ,EAEd;EAAA,IAAAK,EAAA;EAAA,IAAA3B,CAAA,QAAAuB,MAAA,CAAAC,GAAA;IAE0CG,EAAA,GAAAC,WAAA;MAC5CxB,iBAAA,CAAAI,OAAA,EAAAqB,yBAAA,CAAqDD,WAAA;IAAA;IACvD5B,CAAA,MAAA2B,EAAA;EAAA;IAAAA,EAAA,GAAA3B,CAAA;EAAA;EAFA,MAAA6B,yBAAA,GAAkCF,EAE7B;EAAA,IAAAG,EAAA;EAAA,IAAA9B,CAAA,QAAAuB,MAAA,CAAAC,GAAA;IAGIM,EAAA;MAAAJ,SAAA;MAAAG;IAAA;IAAuC7B,CAAA,MAAA8B,EAAA;EAAA;IAAAA,EAAA,GAAA9B,CAAA;EAAA;EAAA,OAAvC8B,EAAuC;AAAA;AAKlD,SAAS5B,YAAA;EACP,OAAO6B,UAAA,CAAWC,MAAM,EAAEC,UAAA,QAAkB,GAAGC,IAAA,CAAKC,GAAG,MAAMC,IAAA,CAAKC,MAAM,IAAI;AAC9E","ignoreList":[]}

package/dist/providers/Auth/tabSessionSync/utilities.d.ts

@@ -0,0 +1,26 @@
+import type { TabSessionEvent, TabSessionLifecycleOrder, TabSessionMessage, TabSessionStorageNotification } from './types.js';
+export declare const tabSessionSyncStorageKey = "payload:auth-session:tab-sync";
+export declare const tabSessionSyncChannelName = "payload-auth-session-tab-sync";
+export declare function isTabSessionMessage(value: unknown): value is TabSessionMessage;
+export declare function isTabSessionStorageNotification(value: unknown): value is TabSessionStorageNotification;
+export declare function parseTabSessionStorageNotification(event: StorageEvent): null | TabSessionStorageNotification;
+/**
+ * Orders two lifecycle events from oldest to newest.
+ *
+ * A refresh is ordered from when it started rather than when its response was published. This
+ * prevents a refresh that began before a logout or expiration from restoring that older session.
+ */
+export declare function compareLifecycleOrders({ first, second, }: {
+    first: TabSessionLifecycleOrder;
+    second: TabSessionLifecycleOrder;
+}): number;
+export declare function getLifecycleOrder(event: {
+    sentAt: number;
+    sourceTabID: string;
+} & TabSessionEvent): TabSessionLifecycleOrder;
+export declare function createTabSessionMessage({ event, sentAt, sourceTabID, }: {
+    event: TabSessionEvent;
+    sentAt: number;
+    sourceTabID: string;
+}): TabSessionMessage;
+//# sourceMappingURL=utilities.d.ts.map

package/dist/providers/Auth/tabSessionSync/utilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utilities.d.ts","sourceRoot":"","sources":["../../../../src/providers/Auth/tabSessionSync/utilities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EAEf,wBAAwB,EACxB,iBAAiB,EACjB,6BAA6B,EAC9B,MAAM,YAAY,CAAA;AAInB,eAAO,MAAM,wBAAwB,kCAAkC,CAAA;AACvE,eAAO,MAAM,yBAAyB,kCAAkC,CAAA;AAExE,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,iBAAiB,CA0C9E;AAED,wBAAgB,+BAA+B,CAC7C,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,6BAA6B,CAsCxC;AAED,wBAAgB,kCAAkC,CAChD,KAAK,EAAE,YAAY,GAClB,IAAI,GAAG,6BAA6B,CActC;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,EACrC,KAAK,EACL,MAAM,GACP,EAAE;IACD,KAAK,EAAE,wBAAwB,CAAA;IAC/B,MAAM,EAAE,wBAAwB,CAAA;CACjC,GAAG,MAAM,CAoCT;AAED,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,GAAG,eAAe,GAC/D,wBAAwB,CAwB1B;AAED,wBAAgB,uBAAuB,CAAC,EACtC,KAAK,EACL,MAAM,EACN,WAAW,GACZ,EAAE;IACD,KAAK,EAAE,eAAe,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;CACpB,GAAG,iBAAiB,CAgBpB"}

package/dist/providers/Auth/tabSessionSync/utilities.js

@@ -0,0 +1,159 @@
+import { TAB_SESSION_EVENT_TYPES } from './types.js';
+export const tabSessionSyncStorageKey = 'payload:auth-session:tab-sync';
+export const tabSessionSyncChannelName = 'payload-auth-session-tab-sync';
+export function isTabSessionMessage(value) {
+  if (!value || typeof value !== 'object' || !('sourceTabID' in value) || typeof value.sourceTabID !== 'string' || !('sentAt' in value) || typeof value.sentAt !== 'number' || !Number.isFinite(value.sentAt) || !('type' in value)) {
+    return false;
+  }
+  if (value.type === TAB_SESSION_EVENT_TYPES.LOGGED_OUT) {
+    return true;
+  }
+  if (value.type === TAB_SESSION_EVENT_TYPES.EXPIRED) {
+    return 'expiredTokenAt' in value && typeof value.expiredTokenAt === 'number' && Number.isFinite(value.expiredTokenAt);
+  }
+  if (value.type === TAB_SESSION_EVENT_TYPES.REFRESHED) {
+    return 'refreshStartedAt' in value && typeof value.refreshStartedAt === 'number' && Number.isFinite(value.refreshStartedAt) && 'session' in value && Boolean(value.session) && typeof value.session === 'object' && 'exp' in value.session && typeof value.session.exp === 'number' && Number.isFinite(value.session.exp) && 'user' in value.session;
+  }
+  return false;
+}
+export function isTabSessionStorageNotification(value) {
+  if (!value || typeof value !== 'object' || !('affectedExpirationMs' in value) || typeof value.affectedExpirationMs !== 'number' || !Number.isFinite(value.affectedExpirationMs) || !('sentAt' in value) || typeof value.sentAt !== 'number' || !Number.isFinite(value.sentAt) || !('sourceTabID' in value) || typeof value.sourceTabID !== 'string' || !('type' in value) || !isTabSessionEventType(value.type) || 'isBroadcastChannelFallback' in value && value.isBroadcastChannelFallback !== true) {
+    return false;
+  }
+  if (value.type === TAB_SESSION_EVENT_TYPES.EXPIRED) {
+    return !('settlesSentAt' in value);
+  }
+  if (value.type === TAB_SESSION_EVENT_TYPES.REFRESHED) {
+    return !('settlesSentAt' in value) && 'refreshStartedAt' in value && typeof value.refreshStartedAt === 'number' && Number.isFinite(value.refreshStartedAt);
+  }
+  return value.affectedExpirationMs === 0 && 'settlesSentAt' in value && typeof value.settlesSentAt === 'number' && Number.isFinite(value.settlesSentAt);
+}
+export function parseTabSessionStorageNotification(event) {
+  if (event.key !== tabSessionSyncStorageKey || !event.newValue) {
+    return null;
+  }
+  try {
+    const notification = JSON.parse(event.newValue);
+    return isTabSessionStorageNotification(notification) ? notification : null;
+  } catch {
+    // Ignore storage writes that do not belong to cross-tab session synchronization.
+  }
+  return null;
+}
+/**
+ * Orders two lifecycle events from oldest to newest.
+ *
+ * A refresh is ordered from when it started rather than when its response was published. This
+ * prevents a refresh that began before a logout or expiration from restoring that older session.
+ */
+export function compareLifecycleOrders({
+  first,
+  second
+}) {
+  const isFirstRefresh = first.type === TAB_SESSION_EVENT_TYPES.REFRESHED;
+  const isSecondRefresh = second.type === TAB_SESSION_EVENT_TYPES.REFRESHED;
+  if (isFirstRefresh !== isSecondRefresh) {
+    const firstOrderingFence = getLifecycleOrderingFence(first);
+    const secondOrderingFence = getLifecycleOrderingFence(second);
+    if (firstOrderingFence !== secondOrderingFence) {
+      return firstOrderingFence - secondOrderingFence;
+    }
+  }
+  const isFirstLogout = first.type === TAB_SESSION_EVENT_TYPES.LOGGED_OUT;
+  const isSecondLogout = second.type === TAB_SESSION_EVENT_TYPES.LOGGED_OUT;
+  if (isFirstLogout !== isSecondLogout) {
+    return isFirstLogout ? 1 : -1;
+  }
+  if (first.sentAt !== second.sentAt) {
+    return first.sentAt - second.sentAt;
+  }
+  if (first.affectedExpirationMs !== second.affectedExpirationMs) {
+    return first.affectedExpirationMs - second.affectedExpirationMs;
+  }
+  const firstPrecedence = getLifecyclePrecedence(first.type);
+  const secondPrecedence = getLifecyclePrecedence(second.type);
+  if (firstPrecedence !== secondPrecedence) {
+    return firstPrecedence - secondPrecedence;
+  }
+  return compareSourceTabIDs({
+    first: first.sourceTabID,
+    second: second.sourceTabID
+  });
+}
+export function getLifecycleOrder(event) {
+  const lifecycleMetadata = {
+    sentAt: event.sentAt,
+    sourceTabID: event.sourceTabID
+  };
+  if (event.type === TAB_SESSION_EVENT_TYPES.REFRESHED) {
+    return {
+      type: event.type,
+      affectedExpirationMs: event.session.exp * 1000,
+      refreshStartedAt: event.refreshStartedAt,
+      ...lifecycleMetadata
+    };
+  }
+  if (event.type === TAB_SESSION_EVENT_TYPES.EXPIRED) {
+    return {
+      type: event.type,
+      affectedExpirationMs: event.expiredTokenAt,
+      ...lifecycleMetadata
+    };
+  }
+  return {
+    type: event.type,
+    affectedExpirationMs: 0,
+    ...lifecycleMetadata
+  };
+}
+export function createTabSessionMessage({
+  event,
+  sentAt,
+  sourceTabID
+}) {
+  if (event.type === TAB_SESSION_EVENT_TYPES.REFRESHED) {
+    return {
+      type: event.type,
+      refreshStartedAt: event.refreshStartedAt,
+      sentAt,
+      session: event.session,
+      sourceTabID
+    };
+  }
+  if (event.type === TAB_SESSION_EVENT_TYPES.EXPIRED) {
+    return {
+      type: event.type,
+      expiredTokenAt: event.expiredTokenAt,
+      sentAt,
+      sourceTabID
+    };
+  }
+  return {
+    type: event.type,
+    sentAt,
+    sourceTabID
+  };
+}
+function compareSourceTabIDs({
+  first,
+  second
+}) {
+  if (first === second) {
+    return 0;
+  }
+  return first > second ? 1 : -1;
+}
+/** Returns the point in time when a lifecycle event began affecting the session. */
+function getLifecycleOrderingFence(order) {
+  return order.type === TAB_SESSION_EVENT_TYPES.REFRESHED ? order.refreshStartedAt : order.sentAt;
+}
+function getLifecyclePrecedence(type) {
+  if (type === TAB_SESSION_EVENT_TYPES.EXPIRED) {
+    return 1;
+  }
+  return type === TAB_SESSION_EVENT_TYPES.LOGGED_OUT ? 2 : 0;
+}
+function isTabSessionEventType(value) {
+  return Object.values(TAB_SESSION_EVENT_TYPES).some(eventType => eventType === value);
+}
+//# sourceMappingURL=utilities.js.map

package/dist/providers/Auth/tabSessionSync/utilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utilities.js","names":["TAB_SESSION_EVENT_TYPES","tabSessionSyncStorageKey","tabSessionSyncChannelName","isTabSessionMessage","value","sourceTabID","sentAt","Number","isFinite","type","LOGGED_OUT","EXPIRED","expiredTokenAt","REFRESHED","refreshStartedAt","Boolean","session","exp","isTabSessionStorageNotification","affectedExpirationMs","isTabSessionEventType","isBroadcastChannelFallback","settlesSentAt","parseTabSessionStorageNotification","event","key","newValue","notification","JSON","parse","compareLifecycleOrders","first","second","isFirstRefresh","isSecondRefresh","firstOrderingFence","getLifecycleOrderingFence","secondOrderingFence","isFirstLogout","isSecondLogout","firstPrecedence","getLifecyclePrecedence","secondPrecedence","compareSourceTabIDs","getLifecycleOrder","lifecycleMetadata","createTabSessionMessage","order","Object","values","some","eventType"],"sources":["../../../../src/providers/Auth/tabSessionSync/utilities.ts"],"sourcesContent":["import type {\n  TabSessionEvent,\n  TabSessionEventType,\n  TabSessionLifecycleOrder,\n  TabSessionMessage,\n  TabSessionStorageNotification,\n} from './types.js'\n\nimport { TAB_SESSION_EVENT_TYPES } from './types.js'\n\nexport const tabSessionSyncStorageKey = 'payload:auth-session:tab-sync'\nexport const tabSessionSyncChannelName = 'payload-auth-session-tab-sync'\n\nexport function isTabSessionMessage(value: unknown): value is TabSessionMessage {\n  if (\n    !value ||\n    typeof value !== 'object' ||\n    !('sourceTabID' in value) ||\n    typeof value.sourceTabID !== 'string' ||\n    !('sentAt' in value) ||\n    typeof value.sentAt !== 'number' ||\n    !Number.isFinite(value.sentAt) ||\n    !('type' in value)\n  ) {\n    return false\n  }\n\n  if (value.type === TAB_SESSION_EVENT_TYPES.LOGGED_OUT) {\n    return true\n  }\n\n  if (value.type === TAB_SESSION_EVENT_TYPES.EXPIRED) {\n    return (\n      'expiredTokenAt' in value &&\n      typeof value.expiredTokenAt === 'number' &&\n      Number.isFinite(value.expiredTokenAt)\n    )\n  }\n\n  if (value.type === TAB_SESSION_EVENT_TYPES.REFRESHED) {\n    return (\n      'refreshStartedAt' in value &&\n      typeof value.refreshStartedAt === 'number' &&\n      Number.isFinite(value.refreshStartedAt) &&\n      'session' in value &&\n      Boolean(value.session) &&\n      typeof value.session === 'object' &&\n      'exp' in value.session &&\n      typeof value.session.exp === 'number' &&\n      Number.isFinite(value.session.exp) &&\n      'user' in value.session\n    )\n  }\n\n  return false\n}\n\nexport function isTabSessionStorageNotification(\n  value: unknown,\n): value is TabSessionStorageNotification {\n  if (\n    !value ||\n    typeof value !== 'object' ||\n    !('affectedExpirationMs' in value) ||\n    typeof value.affectedExpirationMs !== 'number' ||\n    !Number.isFinite(value.affectedExpirationMs) ||\n    !('sentAt' in value) ||\n    typeof value.sentAt !== 'number' ||\n    !Number.isFinite(value.sentAt) ||\n    !('sourceTabID' in value) ||\n    typeof value.sourceTabID !== 'string' ||\n    !('type' in value) ||\n    !isTabSessionEventType(value.type) ||\n    ('isBroadcastChannelFallback' in value && value.isBroadcastChannelFallback !== true)\n  ) {\n    return false\n  }\n\n  if (value.type === TAB_SESSION_EVENT_TYPES.EXPIRED) {\n    return !('settlesSentAt' in value)\n  }\n\n  if (value.type === TAB_SESSION_EVENT_TYPES.REFRESHED) {\n    return (\n      !('settlesSentAt' in value) &&\n      'refreshStartedAt' in value &&\n      typeof value.refreshStartedAt === 'number' &&\n      Number.isFinite(value.refreshStartedAt)\n    )\n  }\n\n  return (\n    value.affectedExpirationMs === 0 &&\n    'settlesSentAt' in value &&\n    typeof value.settlesSentAt === 'number' &&\n    Number.isFinite(value.settlesSentAt)\n  )\n}\n\nexport function parseTabSessionStorageNotification(\n  event: StorageEvent,\n): null | TabSessionStorageNotification {\n  if (event.key !== tabSessionSyncStorageKey || !event.newValue) {\n    return null\n  }\n\n  try {\n    const notification: unknown = JSON.parse(event.newValue)\n\n    return isTabSessionStorageNotification(notification) ? notification : null\n  } catch {\n    // Ignore storage writes that do not belong to cross-tab session synchronization.\n  }\n\n  return null\n}\n\n/**\n * Orders two lifecycle events from oldest to newest.\n *\n * A refresh is ordered from when it started rather than when its response was published. This\n * prevents a refresh that began before a logout or expiration from restoring that older session.\n */\nexport function compareLifecycleOrders({\n  first,\n  second,\n}: {\n  first: TabSessionLifecycleOrder\n  second: TabSessionLifecycleOrder\n}): number {\n  const isFirstRefresh = first.type === TAB_SESSION_EVENT_TYPES.REFRESHED\n  const isSecondRefresh = second.type === TAB_SESSION_EVENT_TYPES.REFRESHED\n\n  if (isFirstRefresh !== isSecondRefresh) {\n    const firstOrderingFence = getLifecycleOrderingFence(first)\n    const secondOrderingFence = getLifecycleOrderingFence(second)\n\n    if (firstOrderingFence !== secondOrderingFence) {\n      return firstOrderingFence - secondOrderingFence\n    }\n  }\n\n  const isFirstLogout = first.type === TAB_SESSION_EVENT_TYPES.LOGGED_OUT\n  const isSecondLogout = second.type === TAB_SESSION_EVENT_TYPES.LOGGED_OUT\n\n  if (isFirstLogout !== isSecondLogout) {\n    return isFirstLogout ? 1 : -1\n  }\n\n  if (first.sentAt !== second.sentAt) {\n    return first.sentAt - second.sentAt\n  }\n\n  if (first.affectedExpirationMs !== second.affectedExpirationMs) {\n    return first.affectedExpirationMs - second.affectedExpirationMs\n  }\n\n  const firstPrecedence = getLifecyclePrecedence(first.type)\n  const secondPrecedence = getLifecyclePrecedence(second.type)\n\n  if (firstPrecedence !== secondPrecedence) {\n    return firstPrecedence - secondPrecedence\n  }\n\n  return compareSourceTabIDs({ first: first.sourceTabID, second: second.sourceTabID })\n}\n\nexport function getLifecycleOrder(\n  event: { sentAt: number; sourceTabID: string } & TabSessionEvent,\n): TabSessionLifecycleOrder {\n  const lifecycleMetadata = {\n    sentAt: event.sentAt,\n    sourceTabID: event.sourceTabID,\n  }\n\n  if (event.type === TAB_SESSION_EVENT_TYPES.REFRESHED) {\n    return {\n      type: event.type,\n      affectedExpirationMs: event.session.exp * 1000,\n      refreshStartedAt: event.refreshStartedAt,\n      ...lifecycleMetadata,\n    }\n  }\n\n  if (event.type === TAB_SESSION_EVENT_TYPES.EXPIRED) {\n    return {\n      type: event.type,\n      affectedExpirationMs: event.expiredTokenAt,\n      ...lifecycleMetadata,\n    }\n  }\n\n  return { type: event.type, affectedExpirationMs: 0, ...lifecycleMetadata }\n}\n\nexport function createTabSessionMessage({\n  event,\n  sentAt,\n  sourceTabID,\n}: {\n  event: TabSessionEvent\n  sentAt: number\n  sourceTabID: string\n}): TabSessionMessage {\n  if (event.type === TAB_SESSION_EVENT_TYPES.REFRESHED) {\n    return {\n      type: event.type,\n      refreshStartedAt: event.refreshStartedAt,\n      sentAt,\n      session: event.session,\n      sourceTabID,\n    }\n  }\n\n  if (event.type === TAB_SESSION_EVENT_TYPES.EXPIRED) {\n    return { type: event.type, expiredTokenAt: event.expiredTokenAt, sentAt, sourceTabID }\n  }\n\n  return { type: event.type, sentAt, sourceTabID }\n}\n\nfunction compareSourceTabIDs({ first, second }: { first: string; second: string }): number {\n  if (first === second) {\n    return 0\n  }\n\n  return first > second ? 1 : -1\n}\n\n/** Returns the point in time when a lifecycle event began affecting the session. */\nfunction getLifecycleOrderingFence(order: TabSessionLifecycleOrder): number {\n  return order.type === TAB_SESSION_EVENT_TYPES.REFRESHED ? order.refreshStartedAt : order.sentAt\n}\n\nfunction getLifecyclePrecedence(type: TabSessionEventType): number {\n  if (type === TAB_SESSION_EVENT_TYPES.EXPIRED) {\n    return 1\n  }\n\n  return type === TAB_SESSION_EVENT_TYPES.LOGGED_OUT ? 2 : 0\n}\n\nfunction isTabSessionEventType(value: unknown): value is TabSessionEventType {\n  return Object.values(TAB_SESSION_EVENT_TYPES).some((eventType) => eventType === value)\n}\n"],"mappings":"AAQA,SAASA,uBAAuB,QAAQ;AAExC,OAAO,MAAMC,wBAAA,GAA2B;AACxC,OAAO,MAAMC,yBAAA,GAA4B;AAEzC,OAAO,SAASC,oBAAoBC,KAAc;EAChD,IACE,CAACA,KAAA,IACD,OAAOA,KAAA,KAAU,YACjB,EAAE,iBAAiBA,KAAI,KACvB,OAAOA,KAAA,CAAMC,WAAW,KAAK,YAC7B,EAAE,YAAYD,KAAI,KAClB,OAAOA,KAAA,CAAME,MAAM,KAAK,YACxB,CAACC,MAAA,CAAOC,QAAQ,CAACJ,KAAA,CAAME,MAAM,KAC7B,EAAE,UAAUF,KAAI,GAChB;IACA,OAAO;EACT;EAEA,IAAIA,KAAA,CAAMK,IAAI,KAAKT,uBAAA,CAAwBU,UAAU,EAAE;IACrD,OAAO;EACT;EAEA,IAAIN,KAAA,CAAMK,IAAI,KAAKT,uBAAA,CAAwBW,OAAO,EAAE;IAClD,OACE,oBAAoBP,KAAA,IACpB,OAAOA,KAAA,CAAMQ,cAAc,KAAK,YAChCL,MAAA,CAAOC,QAAQ,CAACJ,KAAA,CAAMQ,cAAc;EAExC;EAEA,IAAIR,KAAA,CAAMK,IAAI,KAAKT,uBAAA,CAAwBa,SAAS,EAAE;IACpD,OACE,sBAAsBT,KAAA,IACtB,OAAOA,KAAA,CAAMU,gBAAgB,KAAK,YAClCP,MAAA,CAAOC,QAAQ,CAACJ,KAAA,CAAMU,gBAAgB,KACtC,aAAaV,KAAA,IACbW,OAAA,CAAQX,KAAA,CAAMY,OAAO,KACrB,OAAOZ,KAAA,CAAMY,OAAO,KAAK,YACzB,SAASZ,KAAA,CAAMY,OAAO,IACtB,OAAOZ,KAAA,CAAMY,OAAO,CAACC,GAAG,KAAK,YAC7BV,MAAA,CAAOC,QAAQ,CAACJ,KAAA,CAAMY,OAAO,CAACC,GAAG,KACjC,UAAUb,KAAA,CAAMY,OAAO;EAE3B;EAEA,OAAO;AACT;AAEA,OAAO,SAASE,gCACdd,KAAc;EAEd,IACE,CAACA,KAAA,IACD,OAAOA,KAAA,KAAU,YACjB,EAAE,0BAA0BA,KAAI,KAChC,OAAOA,KAAA,CAAMe,oBAAoB,KAAK,YACtC,CAACZ,MAAA,CAAOC,QAAQ,CAACJ,KAAA,CAAMe,oBAAoB,KAC3C,EAAE,YAAYf,KAAI,KAClB,OAAOA,KAAA,CAAME,MAAM,KAAK,YACxB,CAACC,MAAA,CAAOC,QAAQ,CAACJ,KAAA,CAAME,MAAM,KAC7B,EAAE,iBAAiBF,KAAI,KACvB,OAAOA,KAAA,CAAMC,WAAW,KAAK,YAC7B,EAAE,UAAUD,KAAI,KAChB,CAACgB,qBAAA,CAAsBhB,KAAA,CAAMK,IAAI,KAChC,gCAAgCL,KAAA,IAASA,KAAA,CAAMiB,0BAA0B,KAAK,MAC/E;IACA,OAAO;EACT;EAEA,IAAIjB,KAAA,CAAMK,IAAI,KAAKT,uBAAA,CAAwBW,OAAO,EAAE;IAClD,OAAO,EAAE,mBAAmBP,KAAI;EAClC;EAEA,IAAIA,KAAA,CAAMK,IAAI,KAAKT,uBAAA,CAAwBa,SAAS,EAAE;IACpD,OACE,EAAE,mBAAmBT,KAAI,KACzB,sBAAsBA,KAAA,IACtB,OAAOA,KAAA,CAAMU,gBAAgB,KAAK,YAClCP,MAAA,CAAOC,QAAQ,CAACJ,KAAA,CAAMU,gBAAgB;EAE1C;EAEA,OACEV,KAAA,CAAMe,oBAAoB,KAAK,KAC/B,mBAAmBf,KAAA,IACnB,OAAOA,KAAA,CAAMkB,aAAa,KAAK,YAC/Bf,MAAA,CAAOC,QAAQ,CAACJ,KAAA,CAAMkB,aAAa;AAEvC;AAEA,OAAO,SAASC,mCACdC,KAAmB;EAEnB,IAAIA,KAAA,CAAMC,GAAG,KAAKxB,wBAAA,IAA4B,CAACuB,KAAA,CAAME,QAAQ,EAAE;IAC7D,OAAO;EACT;EAEA,IAAI;IACF,MAAMC,YAAA,GAAwBC,IAAA,CAAKC,KAAK,CAACL,KAAA,CAAME,QAAQ;IAEvD,OAAOR,+BAAA,CAAgCS,YAAA,IAAgBA,YAAA,GAAe;EACxE,EAAE,MAAM;IACN;EAAA;EAGF,OAAO;AACT;AAEA;;;;;;AAMA,OAAO,SAASG,uBAAuB;EACrCC,KAAK;EACLC;AAAM,CAIP;EACC,MAAMC,cAAA,GAAiBF,KAAA,CAAMtB,IAAI,KAAKT,uBAAA,CAAwBa,SAAS;EACvE,MAAMqB,eAAA,GAAkBF,MAAA,CAAOvB,IAAI,KAAKT,uBAAA,CAAwBa,SAAS;EAEzE,IAAIoB,cAAA,KAAmBC,eAAA,EAAiB;IACtC,MAAMC,kBAAA,GAAqBC,yBAAA,CAA0BL,KAAA;IACrD,MAAMM,mBAAA,GAAsBD,yBAAA,CAA0BJ,MAAA;IAEtD,IAAIG,kBAAA,KAAuBE,mBAAA,EAAqB;MAC9C,OAAOF,kBAAA,GAAqBE,mBAAA;IAC9B;EACF;EAEA,MAAMC,aAAA,GAAgBP,KAAA,CAAMtB,IAAI,KAAKT,uBAAA,CAAwBU,UAAU;EACvE,MAAM6B,cAAA,GAAiBP,MAAA,CAAOvB,IAAI,KAAKT,uBAAA,CAAwBU,UAAU;EAEzE,IAAI4B,aAAA,KAAkBC,cAAA,EAAgB;IACpC,OAAOD,aAAA,GAAgB,IAAI,CAAC;EAC9B;EAEA,IAAIP,KAAA,CAAMzB,MAAM,KAAK0B,MAAA,CAAO1B,MAAM,EAAE;IAClC,OAAOyB,KAAA,CAAMzB,MAAM,GAAG0B,MAAA,CAAO1B,MAAM;EACrC;EAEA,IAAIyB,KAAA,CAAMZ,oBAAoB,KAAKa,MAAA,CAAOb,oBAAoB,EAAE;IAC9D,OAAOY,KAAA,CAAMZ,oBAAoB,GAAGa,MAAA,CAAOb,oBAAoB;EACjE;EAEA,MAAMqB,eAAA,GAAkBC,sBAAA,CAAuBV,KAAA,CAAMtB,IAAI;EACzD,MAAMiC,gBAAA,GAAmBD,sBAAA,CAAuBT,MAAA,CAAOvB,IAAI;EAE3D,IAAI+B,eAAA,KAAoBE,gBAAA,EAAkB;IACxC,OAAOF,eAAA,GAAkBE,gBAAA;EAC3B;EAEA,OAAOC,mBAAA,CAAoB;IAAEZ,KAAA,EAAOA,KAAA,CAAM1B,WAAW;IAAE2B,MAAA,EAAQA,MAAA,CAAO3B;EAAY;AACpF;AAEA,OAAO,SAASuC,kBACdpB,KAAgE;EAEhE,MAAMqB,iBAAA,GAAoB;IACxBvC,MAAA,EAAQkB,KAAA,CAAMlB,MAAM;IACpBD,WAAA,EAAamB,KAAA,CAAMnB;EACrB;EAEA,IAAImB,KAAA,CAAMf,IAAI,KAAKT,uBAAA,CAAwBa,SAAS,EAAE;IACpD,OAAO;MACLJ,IAAA,EAAMe,KAAA,CAAMf,IAAI;MAChBU,oBAAA,EAAsBK,KAAA,CAAMR,OAAO,CAACC,GAAG,GAAG;MAC1CH,gBAAA,EAAkBU,KAAA,CAAMV,gBAAgB;MACxC,GAAG+B;IACL;EACF;EAEA,IAAIrB,KAAA,CAAMf,IAAI,KAAKT,uBAAA,CAAwBW,OAAO,EAAE;IAClD,OAAO;MACLF,IAAA,EAAMe,KAAA,CAAMf,IAAI;MAChBU,oBAAA,EAAsBK,KAAA,CAAMZ,cAAc;MAC1C,GAAGiC;IACL;EACF;EAEA,OAAO;IAAEpC,IAAA,EAAMe,KAAA,CAAMf,IAAI;IAAEU,oBAAA,EAAsB;IAAG,GAAG0B;EAAkB;AAC3E;AAEA,OAAO,SAASC,wBAAwB;EACtCtB,KAAK;EACLlB,MAAM;EACND;AAAW,CAKZ;EACC,IAAImB,KAAA,CAAMf,IAAI,KAAKT,uBAAA,CAAwBa,SAAS,EAAE;IACpD,OAAO;MACLJ,IAAA,EAAMe,KAAA,CAAMf,IAAI;MAChBK,gBAAA,EAAkBU,KAAA,CAAMV,gBAAgB;MACxCR,MAAA;MACAU,OAAA,EAASQ,KAAA,CAAMR,OAAO;MACtBX;IACF;EACF;EAEA,IAAImB,KAAA,CAAMf,IAAI,KAAKT,uBAAA,CAAwBW,OAAO,EAAE;IAClD,OAAO;MAAEF,IAAA,EAAMe,KAAA,CAAMf,IAAI;MAAEG,cAAA,EAAgBY,KAAA,CAAMZ,cAAc;MAAEN,MAAA;MAAQD;IAAY;EACvF;EAEA,OAAO;IAAEI,IAAA,EAAMe,KAAA,CAAMf,IAAI;IAAEH,MAAA;IAAQD;EAAY;AACjD;AAEA,SAASsC,oBAAoB;EAAEZ,KAAK;EAAEC;AAAM,CAAqC;EAC/E,IAAID,KAAA,KAAUC,MAAA,EAAQ;IACpB,OAAO;EACT;EAEA,OAAOD,KAAA,GAAQC,MAAA,GAAS,IAAI,CAAC;AAC/B;AAEA;AACA,SAASI,0BAA0BW,KAA+B;EAChE,OAAOA,KAAA,CAAMtC,IAAI,KAAKT,uBAAA,CAAwBa,SAAS,GAAGkC,KAAA,CAAMjC,gBAAgB,GAAGiC,KAAA,CAAMzC,MAAM;AACjG;AAEA,SAASmC,uBAAuBhC,IAAyB;EACvD,IAAIA,IAAA,KAAST,uBAAA,CAAwBW,OAAO,EAAE;IAC5C,OAAO;EACT;EAEA,OAAOF,IAAA,KAAST,uBAAA,CAAwBU,UAAU,GAAG,IAAI;AAC3D;AAEA,SAASU,sBAAsBhB,KAAc;EAC3C,OAAO4C,MAAA,CAAOC,MAAM,CAACjD,uBAAA,EAAyBkD,IAAI,CAAEC,SAAA,IAAcA,SAAA,KAAc/C,KAAA;AAClF","ignoreList":[]}

package/dist/providers/Auth/types.d.ts

@@ -0,0 +1,65 @@
+import type { AuthenticatedUser, SanitizedPermissions } from 'payload';
+export type AuthSession = {
+    /** Whether qualifying activity has been recorded for the current token. */
+    readonly activityRecorded: boolean;
+    readonly activityTrackingStartsAt: number;
+    readonly expiresAt: number;
+    readonly refreshStartsAt: number;
+    readonly reminderStartsAt: number;
+};
+export type UserWithToken<T = AuthenticatedUser> = {
+    /** seconds until expiration */
+    exp: number;
+    refreshedToken?: string;
+    token?: string;
+    user: T;
+};
+export type AuthContext<T = AuthenticatedUser> = {
+    /** Lifecycle state for the current auth session. */
+    authSession?: AuthSession;
+    fetchFullUser: () => Promise<null | T>;
+    logOut: () => Promise<boolean>;
+    /**
+     * These are the permissions for the current user from a global scope.
+     *
+     * When checking for permissions on document specific level, use the `useDocumentInfo` hook instead.
+     *
+     * @example
+     *
+     * ```tsx
+     * import { useAuth } from 'payload/ui'
+     *
+     * const MyComponent: React.FC = () => {
+     *   const { permissions } = useAuth()
+     *
+     *   if (permissions?.collections?.myCollection?.create) {
+     *     // user can create documents in 'myCollection'
+     *   }
+     *
+     *   return null
+     * }
+     * ```
+     *
+     * with useDocumentInfo:
+     *
+     * ```tsx
+     * import { useDocumentInfo } from 'payload/ui'
+     *
+     * const MyComponent: React.FC = () => {
+     *  const { docPermissions } = useDocumentInfo()
+     *  if (docPermissions?.create) {
+     *   // user can create this document
+     *  }
+     *  return null
+     * } ```
+     */
+    permissions?: SanitizedPermissions;
+    refreshCookie: (forceRefresh?: boolean) => void;
+    refreshCookieAsync: () => Promise<null | T>;
+    refreshPermissions: () => Promise<void>;
+    setPermissions: (permissions: SanitizedPermissions) => void;
+    setUser: (user: null | UserWithToken<T>) => void;
+    token?: string;
+    user?: null | T;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/providers/Auth/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/providers/Auth/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAEtE,MAAM,MAAM,WAAW,GAAG;IACxB,2EAA2E;IAC3E,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAA;IAClC,QAAQ,CAAC,wBAAwB,EAAE,MAAM,CAAA;IACzC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;IAChC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,iBAAiB,IAAI;IACjD,+BAA+B;IAC/B,GAAG,EAAE,MAAM,CAAA;IACX,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,CAAC,CAAA;CACR,CAAA;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,iBAAiB,IAAI;IAC/C,oDAAoD;IACpD,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,aAAa,EAAE,MAAM,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC,CAAA;IACtC,MAAM,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAA;IAC9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAA;IAClC,aAAa,EAAE,CAAC,YAAY,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;IAC/C,kBAAkB,EAAE,MAAM,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC,CAAA;IAC3C,kBAAkB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IACvC,cAAc,EAAE,CAAC,WAAW,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAC3D,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,GAAG,aAAa,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IAChD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,IAAI,GAAG,CAAC,CAAA;CAChB,CAAA"}

package/dist/providers/Auth/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/providers/Auth/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","names":[],"sources":["../../../src/providers/Auth/types.ts"],"sourcesContent":["import type { AuthenticatedUser, SanitizedPermissions } from 'payload'\n\nexport type AuthSession = {\n  /** Whether qualifying activity has been recorded for the current token. */\n  readonly activityRecorded: boolean\n  readonly activityTrackingStartsAt: number\n  readonly expiresAt: number\n  readonly refreshStartsAt: number\n  readonly reminderStartsAt: number\n}\n\nexport type UserWithToken<T = AuthenticatedUser> = {\n  /** seconds until expiration */\n  exp: number\n  refreshedToken?: string\n  token?: string\n  user: T\n}\n\nexport type AuthContext<T = AuthenticatedUser> = {\n  /** Lifecycle state for the current auth session. */\n  authSession?: AuthSession\n  fetchFullUser: () => Promise<null | T>\n  logOut: () => Promise<boolean>\n  /**\n   * These are the permissions for the current user from a global scope.\n   *\n   * When checking for permissions on document specific level, use the `useDocumentInfo` hook instead.\n   *\n   * @example\n   *\n   * ```tsx\n   * import { useAuth } from 'payload/ui'\n   *\n   * const MyComponent: React.FC = () => {\n   *   const { permissions } = useAuth()\n   *\n   *   if (permissions?.collections?.myCollection?.create) {\n   *     // user can create documents in 'myCollection'\n   *   }\n   *\n   *   return null\n   * }\n   * ```\n   *\n   * with useDocumentInfo:\n   *\n   * ```tsx\n   * import { useDocumentInfo } from 'payload/ui'\n   *\n   * const MyComponent: React.FC = () => {\n   *  const { docPermissions } = useDocumentInfo()\n   *  if (docPermissions?.create) {\n   *   // user can create this document\n   *  }\n   *  return null\n   * } ```\n   */\n  permissions?: SanitizedPermissions\n  refreshCookie: (forceRefresh?: boolean) => void\n  refreshCookieAsync: () => Promise<null | T>\n  refreshPermissions: () => Promise<void>\n  setPermissions: (permissions: SanitizedPermissions) => void\n  setUser: (user: null | UserWithToken<T>) => void\n  token?: string\n  user?: null | T\n}\n"],"mappings":"AAmBA","ignoreList":[]}

package/dist/providers/Auth/useAuthSessionTimers.d.ts

@@ -0,0 +1,26 @@
+import type { SessionActivitySource } from './sessionActivity.js';
+import type { AuthSessionTiming } from './sessionTiming.js';
+export type AuthSessionTimers = {
+    clear: () => void;
+    getCurrentExpirationMs: () => number | undefined;
+    /** Records activity only while the activity tracking window is open. */
+    recordActivity: (source: SessionActivitySource) => boolean;
+    scheduleRefresh: (forceRefresh?: boolean) => void;
+    setExpiration: (expirationMs: number) => AuthSessionTiming | undefined;
+};
+export type UseAuthSessionTimersArgs = {
+    isAuthenticated: boolean;
+    onActivity: () => void;
+    onActivityRefresh: () => void;
+    onExpire: (expirationMs: number) => void;
+    onReminder: () => void;
+};
+/**
+ * Manages activity-aware refresh, expiration reminders, and logout timing for the current session.
+ *
+ * Activity inside the refresh window schedules a refresh. Earlier activity is remembered until the
+ * refresh-window checkpoint so the session can still be extended without requiring another
+ * activity event.
+ */
+export declare function useAuthSessionTimers({ isAuthenticated, onActivity, onActivityRefresh, onExpire, onReminder, }: UseAuthSessionTimersArgs): AuthSessionTimers;
+//# sourceMappingURL=useAuthSessionTimers.d.ts.map

package/dist/providers/Auth/useAuthSessionTimers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAuthSessionTimers.d.ts","sourceRoot":"","sources":["../../../src/providers/Auth/useAuthSessionTimers.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAA;AACjE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAU3D,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,MAAM,IAAI,CAAA;IACjB,sBAAsB,EAAE,MAAM,MAAM,GAAG,SAAS,CAAA;IAChD,wEAAwE;IACxE,cAAc,EAAE,CAAC,MAAM,EAAE,qBAAqB,KAAK,OAAO,CAAA;IAC1D,eAAe,EAAE,CAAC,YAAY,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;IACjD,aAAa,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,iBAAiB,GAAG,SAAS,CAAA;CACvE,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,eAAe,EAAE,OAAO,CAAA;IACxB,UAAU,EAAE,MAAM,IAAI,CAAA;IACtB,iBAAiB,EAAE,MAAM,IAAI,CAAA;IAC7B,QAAQ,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,CAAA;IACxC,UAAU,EAAE,MAAM,IAAI,CAAA;CACvB,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,EACnC,eAAe,EACf,UAAU,EACV,iBAAiB,EACjB,QAAQ,EACR,UAAU,GACX,EAAE,wBAAwB,GAAG,iBAAiB,CAqP9C"}

package/dist/providers/Auth/useAuthSessionTimers.js

@@ -0,0 +1,203 @@
+'use client';
+
+import { useCallback, useEffect, useMemo, useRef } from 'react';
+import { createSessionActivityTracker, registerSessionActivityListeners } from './sessionActivity.js';
+import { getAuthSessionTiming } from './sessionTiming.js';
+const maxTimeoutMs = 2_147_483_647 // ~24.8 days
+;
+/**
+ * Manages activity-aware refresh, expiration reminders, and logout timing for the current session.
+ *
+ * Activity inside the refresh window schedules a refresh. Earlier activity is remembered until the
+ * refresh-window checkpoint so the session can still be extended without requiring another
+ * activity event.
+ */
+export function useAuthSessionTimers({
+  isAuthenticated,
+  onActivity,
+  onActivityRefresh,
+  onExpire,
+  onReminder
+}) {
+  const activityListenerCleanupRef = useRef(undefined);
+  const activityCheckpointTimeoutRef = useRef(null);
+  const forceLogOutTimeoutRef = useRef(null);
+  const hasActiveSessionRef = useRef(isAuthenticated);
+  const lastSessionActivityAtRef = useRef(undefined);
+  const scheduledRefreshTimeoutRef = useRef(null);
+  const reminderTimeoutRef = useRef(null);
+  const sessionTimingRef = useRef(undefined);
+  const tokenExpirationMsRef = useRef(undefined);
+  const callbacksRef = useRef({
+    onActivity,
+    onActivityRefresh,
+    onExpire,
+    onReminder
+  });
+  const scheduleRefresh = useCallback(forceRefresh => {
+    if (!hasActiveSessionRef.current) {
+      return;
+    }
+    const sessionTiming = sessionTimingRef.current;
+    if (forceRefresh || sessionTiming && Date.now() >= sessionTiming.refreshStartsAt) {
+      clearTimeout(scheduledRefreshTimeoutRef.current);
+      scheduledRefreshTimeoutRef.current = setTimeout(() => {
+        callbacksRef.current.onActivityRefresh();
+      }, 1000);
+    }
+  }, []);
+  const activityTracker = useMemo(() => createSessionActivityTracker({
+    onActivity: (_source, occurredAt) => {
+      const isFirstActivity = lastSessionActivityAtRef.current === undefined;
+      lastSessionActivityAtRef.current = occurredAt;
+      if (isFirstActivity) {
+        callbacksRef.current.onActivity();
+      }
+      scheduleRefresh();
+    }
+  }), [scheduleRefresh]);
+  const recordActivity = useCallback(source => {
+    const occurredAt_0 = Date.now();
+    const sessionTiming_0 = sessionTimingRef.current;
+    const isActivityWindowOpen = sessionTiming_0 && occurredAt_0 >= sessionTiming_0.activityTrackingStartsAt && occurredAt_0 < sessionTiming_0.reminderStartsAt;
+    if (!activityListenerCleanupRef.current || !isActivityWindowOpen) {
+      return false;
+    }
+    return activityTracker.record(source);
+  }, [activityTracker]);
+  const addActivityListeners = useCallback(() => {
+    if (activityListenerCleanupRef.current) {
+      return;
+    }
+    activityListenerCleanupRef.current = registerSessionActivityListeners({
+      markActivity: recordActivity,
+      window
+    });
+  }, [recordActivity]);
+  const removeActivityListeners = useCallback(() => {
+    const cleanup = activityListenerCleanupRef.current;
+    if (!cleanup) {
+      return;
+    }
+    activityListenerCleanupRef.current = undefined;
+    cleanup();
+  }, []);
+  const resetSessionLifecycle = useCallback(() => {
+    clearTimeout(activityCheckpointTimeoutRef.current);
+    clearTimeout(forceLogOutTimeoutRef.current);
+    clearTimeout(reminderTimeoutRef.current);
+    clearTimeout(scheduledRefreshTimeoutRef.current);
+    removeActivityListeners();
+    activityTracker.reset();
+    lastSessionActivityAtRef.current = undefined;
+  }, [activityTracker, removeActivityListeners]);
+  const clear = useCallback(() => {
+    resetSessionLifecycle();
+    hasActiveSessionRef.current = false;
+    sessionTimingRef.current = undefined;
+    tokenExpirationMsRef.current = undefined;
+  }, [resetSessionLifecycle]);
+  const setExpiration = useCallback(expirationMs => {
+    if (!Number.isFinite(expirationMs)) {
+      return;
+    }
+    resetSessionLifecycle();
+    tokenExpirationMsRef.current = expirationMs;
+    const sessionTiming_1 = getAuthSessionTiming({
+      expirationMs
+    });
+    sessionTimingRef.current = sessionTiming_1;
+    const scheduleReminder = () => {
+      if (tokenExpirationMsRef.current !== expirationMs) {
+        return;
+      }
+      const reminderStartsInMs = Math.max(sessionTiming_1.reminderStartsAt - Date.now(), 0);
+      reminderTimeoutRef.current = setTimeout(() => {
+        if (tokenExpirationMsRef.current !== expirationMs) {
+          return;
+        }
+        if (Date.now() < sessionTiming_1.reminderStartsAt) {
+          scheduleReminder();
+          return;
+        }
+        clearTimeout(scheduledRefreshTimeoutRef.current);
+        removeActivityListeners();
+        if (Date.now() < sessionTiming_1.expiresAt) {
+          callbacksRef.current.onReminder();
+        }
+      }, Math.min(reminderStartsInMs, maxTimeoutMs));
+    };
+    const scheduleActivityCheckpoint = () => {
+      if (tokenExpirationMsRef.current !== expirationMs) {
+        return;
+      }
+      const refreshStartsInMs = Math.max(sessionTiming_1.refreshStartsAt - Date.now(), 0);
+      activityCheckpointTimeoutRef.current = setTimeout(() => {
+        if (tokenExpirationMsRef.current !== expirationMs) {
+          return;
+        }
+        const checkpointAt = Date.now();
+        if (checkpointAt < sessionTiming_1.refreshStartsAt) {
+          scheduleActivityCheckpoint();
+          return;
+        }
+        const lastActivityAt = lastSessionActivityAtRef.current;
+        const hasRecentActivity = lastActivityAt !== undefined && checkpointAt < sessionTiming_1.reminderStartsAt && lastActivityAt >= sessionTiming_1.activityTrackingStartsAt;
+        if (hasRecentActivity) {
+          scheduleRefresh(true);
+        }
+      }, Math.min(refreshStartsInMs, maxTimeoutMs));
+    };
+    const scheduleExpiration = () => {
+      if (tokenExpirationMsRef.current !== expirationMs) {
+        return;
+      }
+      const expiresInMs = Math.max(sessionTiming_1.expiresAt - Date.now(), 0);
+      forceLogOutTimeoutRef.current = setTimeout(() => {
+        if (tokenExpirationMsRef.current === expirationMs) {
+          if (Date.now() < sessionTiming_1.expiresAt) {
+            scheduleExpiration();
+            return;
+          }
+          hasActiveSessionRef.current = false;
+          removeActivityListeners();
+          callbacksRef.current.onExpire(expirationMs);
+        }
+      }, Math.min(expiresInMs, maxTimeoutMs));
+    };
+    hasActiveSessionRef.current = expirationMs > Date.now();
+    if (hasActiveSessionRef.current) {
+      addActivityListeners();
+      scheduleReminder();
+      scheduleActivityCheckpoint();
+    }
+    scheduleExpiration();
+    return sessionTiming_1;
+  }, [addActivityListeners, removeActivityListeners, resetSessionLifecycle, scheduleRefresh]);
+  const getCurrentExpirationMs = useCallback(() => tokenExpirationMsRef.current, []);
+  useEffect(() => {
+    callbacksRef.current = {
+      onActivity,
+      onActivityRefresh,
+      onExpire,
+      onReminder
+    };
+  }, [onActivity, onActivityRefresh, onExpire, onReminder]);
+  useEffect(() => {
+    hasActiveSessionRef.current = isAuthenticated;
+    if (!isAuthenticated) {
+      removeActivityListeners();
+    }
+  }, [isAuthenticated, removeActivityListeners]);
+  useEffect(() => {
+    return clear;
+  }, [clear]);
+  return useMemo(() => ({
+    clear,
+    getCurrentExpirationMs,
+    recordActivity,
+    scheduleRefresh,
+    setExpiration
+  }), [clear, getCurrentExpirationMs, recordActivity, scheduleRefresh, setExpiration]);
+}
+//# sourceMappingURL=useAuthSessionTimers.js.map