@payloadcms/ui 4.0.0-internal.c2b57ce → 4.0.0-internal.c6494b5

package/dist/providers/Auth/authSessionRequests.js

@@ -0,0 +1,119 @@
+/**
+ * Coordinates requests that read or update the current auth session.
+ *
+ * Requests run in order, concurrent refreshes and logouts share a promise, and outdated results can
+ * be discarded after the session changes.
+ */export function createAuthSessionRequests() {
+  let authRequestQueue = Promise.resolve();
+  let authRequestSequence = 0;
+  let isLoggingOut = false;
+  let logoutRequest;
+  let pendingAuthInvalidation;
+  let refreshRequest;
+  let sessionGeneration = 0;
+  const clearPendingInvalidation = () => {
+    pendingAuthInvalidation = undefined;
+  };
+  const discardPendingResults = () => {
+    sessionGeneration += 1;
+    clearPendingInvalidation();
+  };
+  const queue = request => {
+    const requestGeneration = sessionGeneration;
+    const requestSequence = ++authRequestSequence;
+    const runRequest = async () => {
+      const isResultStale = () => sessionGeneration !== requestGeneration || isLoggingOut;
+      const result = await request({
+        acceptResult: () => {
+          if (isResultStale()) {
+            return false;
+          }
+          clearPendingInvalidation();
+          return true;
+        },
+        invalidateWhenIdle: invalidate => {
+          if (isResultStale()) {
+            return;
+          }
+          if (requestSequence < authRequestSequence) {
+            pendingAuthInvalidation = {
+              generation: requestGeneration,
+              run: invalidate
+            };
+          } else {
+            invalidate();
+          }
+        },
+        isResultStale
+      });
+      if (requestSequence === authRequestSequence) {
+        const pendingInvalidation = pendingAuthInvalidation;
+        clearPendingInvalidation();
+        if (pendingInvalidation?.generation === sessionGeneration) {
+          pendingInvalidation.run();
+        }
+      }
+      return result;
+    };
+    const queuedRequest = authRequestQueue.then(runRequest, runRequest);
+    authRequestQueue = queuedRequest.then(() => undefined, () => undefined);
+    return queuedRequest;
+  };
+  const refresh = request => {
+    const requestGeneration = sessionGeneration;
+    const activeRequest = refreshRequest;
+    if (isLoggingOut) {
+      return Promise.resolve(null);
+    }
+    if (activeRequest?.generation === requestGeneration) {
+      return activeRequest.promise;
+    }
+    const refreshPromise = queue(request);
+    refreshRequest = {
+      generation: requestGeneration,
+      promise: refreshPromise
+    };
+    /** Stops sharing this refresh after it settles without clearing a newer refresh request. */
+    const clearRefreshRequest = () => {
+      if (refreshRequest?.promise === refreshPromise) {
+        refreshRequest = undefined;
+      }
+    };
+    void refreshPromise.then(clearRefreshRequest, clearRefreshRequest);
+    return refreshPromise;
+  };
+  const logOut = ({
+    clearSession,
+    request
+  }) => {
+    if (logoutRequest !== undefined) {
+      return logoutRequest;
+    }
+    isLoggingOut = true;
+    clearSession();
+    const pendingLogout = queue(async () => {
+      try {
+        await request();
+      } finally {
+        isLoggingOut = false;
+      }
+    });
+    logoutRequest = pendingLogout;
+    /** Stops sharing this logout after it settles without clearing a newer logout request. */
+    const clearLogoutRequest = () => {
+      if (logoutRequest === pendingLogout) {
+        logoutRequest = undefined;
+      }
+    };
+    void pendingLogout.then(clearLogoutRequest, clearLogoutRequest);
+    return pendingLogout;
+  };
+  return {
+    discardPendingResults,
+    isLoggingOut: () => isLoggingOut,
+    logOut,
+    queue,
+    refresh
+  };
+}
+//# sourceMappingURL=authSessionRequests.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"authSessionRequests.js","names":["createAuthSessionRequests","authRequestQueue","Promise","resolve","authRequestSequence","isLoggingOut","logoutRequest","pendingAuthInvalidation","refreshRequest","sessionGeneration","clearPendingInvalidation","undefined","discardPendingResults","queue","request","requestGeneration","requestSequence","runRequest","isResultStale","result","acceptResult","invalidateWhenIdle","invalidate","generation","run","pendingInvalidation","queuedRequest","then","refresh","activeRequest","promise","refreshPromise","clearRefreshRequest","logOut","clearSession","pendingLogout","clearLogoutRequest"],"sources":["../../../src/providers/Auth/authSessionRequests.ts"],"sourcesContent":["import type { AuthenticatedUser } from 'payload'\n\nexport type AuthRequestContext = {\n  /** Accepts the result when its session is still active and cancels any deferred invalidation. */\n  acceptResult: () => boolean\n  /** Invalidates the session after newer queued auth requests have had a chance to restore it. */\n  invalidateWhenIdle: (invalidate: () => void) => void\n  /** Whether the session changed or logout began after this request was queued. */\n  isResultStale: () => boolean\n}\n\nexport type AuthSessionRequests = {\n  discardPendingResults: () => void\n  isLoggingOut: () => boolean\n  logOut: ({\n    clearSession,\n    request,\n  }: {\n    clearSession: () => void\n    request: () => Promise<void>\n  }) => Promise<void>\n  queue: <Result>(request: (context: AuthRequestContext) => Promise<Result>) => Promise<Result>\n  refresh: (\n    request: (context: AuthRequestContext) => Promise<AuthenticatedUser | null>,\n  ) => Promise<AuthenticatedUser | null>\n}\n\n/**\n * Coordinates requests that read or update the current auth session.\n *\n * Requests run in order, concurrent refreshes and logouts share a promise, and outdated results can\n * be discarded after the session changes.\n */\nexport function createAuthSessionRequests(): AuthSessionRequests {\n  let authRequestQueue = Promise.resolve()\n  let authRequestSequence = 0\n  let isLoggingOut = false\n  let logoutRequest: Promise<void> | undefined\n  let pendingAuthInvalidation:\n    | {\n        generation: number\n        run: () => void\n      }\n    | undefined\n  let refreshRequest:\n    | {\n        generation: number\n        promise: Promise<AuthenticatedUser | null>\n      }\n    | undefined\n  let sessionGeneration = 0\n\n  const clearPendingInvalidation = (): void => {\n    pendingAuthInvalidation = undefined\n  }\n\n  const discardPendingResults = (): void => {\n    sessionGeneration += 1\n    clearPendingInvalidation()\n  }\n\n  const queue = <Result>(\n    request: (context: AuthRequestContext) => Promise<Result>,\n  ): Promise<Result> => {\n    const requestGeneration = sessionGeneration\n    const requestSequence = ++authRequestSequence\n    const runRequest = async (): Promise<Result> => {\n      const isResultStale = () => sessionGeneration !== requestGeneration || isLoggingOut\n      const result = await request({\n        acceptResult: () => {\n          if (isResultStale()) {\n            return false\n          }\n\n          clearPendingInvalidation()\n          return true\n        },\n        invalidateWhenIdle: (invalidate) => {\n          if (isResultStale()) {\n            return\n          }\n\n          if (requestSequence < authRequestSequence) {\n            pendingAuthInvalidation = { generation: requestGeneration, run: invalidate }\n          } else {\n            invalidate()\n          }\n        },\n        isResultStale,\n      })\n\n      if (requestSequence === authRequestSequence) {\n        const pendingInvalidation = pendingAuthInvalidation\n\n        clearPendingInvalidation()\n\n        if (pendingInvalidation?.generation === sessionGeneration) {\n          pendingInvalidation.run()\n        }\n      }\n\n      return result\n    }\n    const queuedRequest = authRequestQueue.then(runRequest, runRequest)\n\n    authRequestQueue = queuedRequest.then(\n      () => undefined,\n      () => undefined,\n    )\n\n    return queuedRequest\n  }\n\n  const refresh = (\n    request: (context: AuthRequestContext) => Promise<AuthenticatedUser | null>,\n  ): Promise<AuthenticatedUser | null> => {\n    const requestGeneration = sessionGeneration\n    const activeRequest = refreshRequest\n\n    if (isLoggingOut) {\n      return Promise.resolve(null)\n    }\n\n    if (activeRequest?.generation === requestGeneration) {\n      return activeRequest.promise\n    }\n\n    const refreshPromise = queue(request)\n\n    refreshRequest = { generation: requestGeneration, promise: refreshPromise }\n    /** Stops sharing this refresh after it settles without clearing a newer refresh request. */\n    const clearRefreshRequest = () => {\n      if (refreshRequest?.promise === refreshPromise) {\n        refreshRequest = undefined\n      }\n    }\n\n    void refreshPromise.then(clearRefreshRequest, clearRefreshRequest)\n\n    return refreshPromise\n  }\n\n  const logOut = ({\n    clearSession,\n    request,\n  }: {\n    clearSession: () => void\n    request: () => Promise<void>\n  }): Promise<void> => {\n    if (logoutRequest !== undefined) {\n      return logoutRequest\n    }\n\n    isLoggingOut = true\n    clearSession()\n\n    const pendingLogout = queue(async () => {\n      try {\n        await request()\n      } finally {\n        isLoggingOut = false\n      }\n    })\n\n    logoutRequest = pendingLogout\n    /** Stops sharing this logout after it settles without clearing a newer logout request. */\n    const clearLogoutRequest = () => {\n      if (logoutRequest === pendingLogout) {\n        logoutRequest = undefined\n      }\n    }\n\n    void pendingLogout.then(\n      clearLogoutRequest, // onSuccess\n      clearLogoutRequest, // onFailure\n    )\n\n    return pendingLogout\n  }\n\n  return {\n    discardPendingResults,\n    isLoggingOut: () => isLoggingOut,\n    logOut,\n    queue,\n    refresh,\n  }\n}\n"],"mappings":"AA2BA;;;;;GAMA,OAAO,SAASA,0BAAA;EACd,IAAIC,gBAAA,GAAmBC,OAAA,CAAQC,OAAO;EACtC,IAAIC,mBAAA,GAAsB;EAC1B,IAAIC,YAAA,GAAe;EACnB,IAAIC,aAAA;EACJ,IAAIC,uBAAA;EAMJ,IAAIC,cAAA;EAMJ,IAAIC,iBAAA,GAAoB;EAExB,MAAMC,wBAAA,GAA2BA,CAAA;IAC/BH,uBAAA,GAA0BI,SAAA;EAC5B;EAEA,MAAMC,qBAAA,GAAwBA,CAAA;IAC5BH,iBAAA,IAAqB;IACrBC,wBAAA;EACF;EAEA,MAAMG,KAAA,GACJC,OAAA;IAEA,MAAMC,iBAAA,GAAoBN,iBAAA;IAC1B,MAAMO,eAAA,GAAkB,EAAEZ,mBAAA;IAC1B,MAAMa,UAAA,GAAa,MAAAA,CAAA;MACjB,MAAMC,aAAA,GAAgBA,CAAA,KAAMT,iBAAA,KAAsBM,iBAAA,IAAqBV,YAAA;MACvE,MAAMc,MAAA,GAAS,MAAML,OAAA,CAAQ;QAC3BM,YAAA,EAAcA,CAAA;UACZ,IAAIF,aAAA,IAAiB;YACnB,OAAO;UACT;UAEAR,wBAAA;UACA,OAAO;QACT;QACAW,kBAAA,EAAqBC,UAAA;UACnB,IAAIJ,aAAA,IAAiB;YACnB;UACF;UAEA,IAAIF,eAAA,GAAkBZ,mBAAA,EAAqB;YACzCG,uBAAA,GAA0B;cAAEgB,UAAA,EAAYR,iBAAA;cAAmBS,GAAA,EAAKF;YAAW;UAC7E,OAAO;YACLA,UAAA;UACF;QACF;QACAJ;MACF;MAEA,IAAIF,eAAA,KAAoBZ,mBAAA,EAAqB;QAC3C,MAAMqB,mBAAA,GAAsBlB,uBAAA;QAE5BG,wBAAA;QAEA,IAAIe,mBAAA,EAAqBF,UAAA,KAAed,iBAAA,EAAmB;UACzDgB,mBAAA,CAAoBD,GAAG;QACzB;MACF;MAEA,OAAOL,MAAA;IACT;IACA,MAAMO,aAAA,GAAgBzB,gBAAA,CAAiB0B,IAAI,CAACV,UAAA,EAAYA,UAAA;IAExDhB,gBAAA,GAAmByB,aAAA,CAAcC,IAAI,CACnC,MAAMhB,SAAA,EACN,MAAMA,SAAA;IAGR,OAAOe,aAAA;EACT;EAEA,MAAME,OAAA,GACJd,OAAA;IAEA,MAAMC,iBAAA,GAAoBN,iBAAA;IAC1B,MAAMoB,aAAA,GAAgBrB,cAAA;IAEtB,IAAIH,YAAA,EAAc;MAChB,OAAOH,OAAA,CAAQC,OAAO,CAAC;IACzB;IAEA,IAAI0B,aAAA,EAAeN,UAAA,KAAeR,iBAAA,EAAmB;MACnD,OAAOc,aAAA,CAAcC,OAAO;IAC9B;IAEA,MAAMC,cAAA,GAAiBlB,KAAA,CAAMC,OAAA;IAE7BN,cAAA,GAAiB;MAAEe,UAAA,EAAYR,iBAAA;MAAmBe,OAAA,EAASC;IAAe;IAC1E;IACA,MAAMC,mBAAA,GAAsBA,CAAA;MAC1B,IAAIxB,cAAA,EAAgBsB,OAAA,KAAYC,cAAA,EAAgB;QAC9CvB,cAAA,GAAiBG,SAAA;MACnB;IACF;IAEA,KAAKoB,cAAA,CAAeJ,IAAI,CAACK,mBAAA,EAAqBA,mBAAA;IAE9C,OAAOD,cAAA;EACT;EAEA,MAAME,MAAA,GAASA,CAAC;IACdC,YAAY;IACZpB;EAAO,CAIR;IACC,IAAIR,aAAA,KAAkBK,SAAA,EAAW;MAC/B,OAAOL,aAAA;IACT;IAEAD,YAAA,GAAe;IACf6B,YAAA;IAEA,MAAMC,aAAA,GAAgBtB,KAAA,CAAM;MAC1B,IAAI;QACF,MAAMC,OAAA;MACR,UAAU;QACRT,YAAA,GAAe;MACjB;IACF;IAEAC,aAAA,GAAgB6B,aAAA;IAChB;IACA,MAAMC,kBAAA,GAAqBA,CAAA;MACzB,IAAI9B,aAAA,KAAkB6B,aAAA,EAAe;QACnC7B,aAAA,GAAgBK,SAAA;MAClB;IACF;IAEA,KAAKwB,aAAA,CAAcR,IAAI,CACrBS,kBAAA,EACAA,kBAAA;IAGF,OAAOD,aAAA;EACT;EAEA,OAAO;IACLvB,qBAAA;IACAP,YAAA,EAAcA,CAAA,KAAMA,YAAA;IACpB4B,MAAA;IACApB,KAAA;IACAe;EACF;AACF","ignoreList":[]}

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

@@ -1,66 +1,12 @@
-import type { ClientUser, SanitizedPermissions, TypedUser } from 'payload';
+import type { AuthenticatedUser, SanitizedPermissions } from 'payload';
 import React from 'react';
-export type UserWithToken<T = ClientUser> = {
-    /** seconds until expiration */
-    exp: number;
-    refreshedToken?: string;
-    token?: string;
-    user: T;
-};
-export type AuthContext<T = ClientUser> = {
-    fetchFullUser: () => Promise<null | TypedUser>;
-    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<ClientUser>;
-    refreshPermissions: () => Promise<void>;
-    setPermissions: (permissions: SanitizedPermissions) => void;
-    setUser: (user: null | UserWithToken<T>) => void;
-    strategy?: string;
-    token?: string;
-    tokenExpirationMs?: number;
-    user?: null | T;
-};
+import type { AuthContext } from './types.js';
+export type { AuthContext, AuthSession, UserWithToken } from './types.js';
 type Props = {
     children: React.ReactNode;
     permissions?: SanitizedPermissions;
-    user?: ClientUser | null;
+    user?: AuthenticatedUser | null;
 };
 export declare function AuthProvider({ children, permissions: initialPermissions, user: initialUser, }: Props): React.JSX.Element;
-export declare const useAuth: <T = ClientUser>() => AuthContext<T>;
-export {};
+export declare const useAuth: <T = AuthenticatedUser>() => AuthContext<T>;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/Auth/index.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,oBAAoB,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAK1E,OAAO,KAA+D,MAAM,OAAO,CAAA;AAWnF,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,UAAU,IAAI;IAC1C,+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,UAAU,IAAI;IACxC,aAAa,EAAE,MAAM,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC,CAAA;IAC9C,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,UAAU,CAAC,CAAA;IAC7C,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,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,IAAI,CAAC,EAAE,IAAI,GAAG,CAAC,CAAA;CAChB,CAAA;AAMD,KAAK,KAAK,GAAG;IACX,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IACzB,WAAW,CAAC,EAAE,oBAAoB,CAAA;IAClC,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;CACzB,CAAA;AAED,wBAAgB,YAAY,CAAC,EAC3B,QAAQ,EACR,WAAW,EAAE,kBAAkB,EAC/B,IAAI,EAAE,WAAW,GAClB,EAAE,KAAK,qBAgUP;AAED,eAAO,MAAM,OAAO,GAAI,CAAC,GAAG,UAAU,OAAM,WAAW,CAAC,CAAC,CAAmC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/Auth/index.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAKtE,OAAO,KAA+D,MAAM,OAAO,CAAA;AAInF,OAAO,KAAK,EAAE,WAAW,EAA8B,MAAM,YAAY,CAAA;AAczE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAIzE,KAAK,KAAK,GAAG;IACX,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IACzB,WAAW,CAAC,EAAE,oBAAoB,CAAA;IAClC,IAAI,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAA;CAChC,CAAA;AAsBD,wBAAgB,YAAY,CAAC,EAC3B,QAAQ,EACR,WAAW,EAAE,kBAAkB,EAC/B,IAAI,EAAE,WAAW,GAClB,EAAE,KAAK,qBAodP;AAED,eAAO,MAAM,OAAO,GAAI,CAAC,GAAG,iBAAiB,OAAM,WAAW,CAAC,CAAC,CAAmC,CAAA"}