@payloadcms/ui 4.0.0-internal.fa183d3 → 4.0.0-internal.fec2230

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

@@ -0,0 +1,121 @@
+import { describe, expect, it } from 'vitest';
+import { createAuthSessionRequests } from './authSessionRequests.js';
+describe('createAuthSessionRequests', () => {
+  it('should serialize auth requests in queue order', async () => {
+    const authRequests = createAuthSessionRequests();
+    const first = createDeferred();
+    const order = [];
+    const firstRequest = authRequests.queue(async () => {
+      order.push('first:start');
+      await first.promise;
+      order.push('first:end');
+    });
+    const secondRequest = authRequests.queue(async () => {
+      order.push('second');
+    });
+    expect(order).toEqual([]);
+    await Promise.resolve();
+    expect(order).toEqual(['first:start']);
+    first.resolve();
+    await Promise.all([firstRequest, secondRequest]);
+    expect(order).toEqual(['first:start', 'first:end', 'second']);
+  });
+  it('should share a refresh while session results remain current', async () => {
+    const authRequests = createAuthSessionRequests();
+    const refresh = createDeferred();
+    let runs = 0;
+    const run = () => authRequests.refresh(async () => {
+      runs += 1;
+      return refresh.promise;
+    });
+    const first = run();
+    const second = run();
+    expect(first).toBe(second);
+    refresh.resolve(null);
+    await Promise.all([first, second]);
+    expect(runs).toBe(1);
+  });
+  it('should discard a queued result after the session changes', async () => {
+    const authRequests = createAuthSessionRequests();
+    const operation = createDeferred();
+    let isResultStaleAfterSettlement = false;
+    const request = authRequests.queue(async ({
+      isResultStale
+    }) => {
+      await operation.promise;
+      isResultStaleAfterSettlement = isResultStale();
+    });
+    await Promise.resolve();
+    authRequests.discardPendingResults();
+    operation.resolve();
+    await request;
+    expect(isResultStaleAfterSettlement).toBe(true);
+  });
+  it('should settle a logout once and prevent refresh from committing', async () => {
+    const authRequests = createAuthSessionRequests();
+    const logout = createDeferred();
+    let clears = 0;
+    let logoutRequests = 0;
+    const first = authRequests.logOut({
+      clearSession: () => {
+        clears += 1;
+        authRequests.discardPendingResults();
+      },
+      request: async () => {
+        logoutRequests += 1;
+        await logout.promise;
+      }
+    });
+    const second = authRequests.logOut({
+      clearSession: () => {
+        clears += 1;
+      },
+      request: async () => {
+        logoutRequests += 1;
+      }
+    });
+    expect(first).toBe(second);
+    expect(authRequests.isLoggingOut()).toBe(true);
+    expect(await authRequests.refresh(async () => null)).toBeNull();
+    logout.resolve();
+    await first;
+    expect({
+      clears,
+      logoutRequests
+    }).toEqual({
+      clears: 1,
+      logoutRequests: 1
+    });
+  });
+  it('should discard a deferred invalidation after the session changes', async () => {
+    const authRequests = createAuthSessionRequests();
+    let invalidations = 0;
+    const first = authRequests.refresh(async ({
+      invalidateWhenIdle
+    }) => {
+      invalidateWhenIdle(() => {
+        invalidations += 1;
+      });
+      return null;
+    });
+    const second = authRequests.queue(async () => {
+      authRequests.discardPendingResults();
+    });
+    await Promise.all([first, second]);
+    expect(invalidations).toBe(0);
+  });
+});
+function createDeferred() {
+  let resolve;
+  const promise = new Promise(resolvePromise => {
+    resolve = resolvePromise;
+  });
+  if (!resolve) {
+    throw new Error('Expected deferred promise resolver.');
+  }
+  return {
+    promise,
+    resolve
+  };
+}
+//# sourceMappingURL=authSessionRequests.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"authSessionRequests.spec.js","names":["describe","expect","it","createAuthSessionRequests","authRequests","first","createDeferred","order","firstRequest","queue","push","promise","secondRequest","toEqual","Promise","resolve","all","refresh","runs","run","second","toBe","operation","isResultStaleAfterSettlement","request","isResultStale","discardPendingResults","logout","clears","logoutRequests","logOut","clearSession","isLoggingOut","toBeNull","invalidations","invalidateWhenIdle","resolvePromise","Error"],"sources":["../../../src/providers/Auth/authSessionRequests.spec.ts"],"sourcesContent":["import { describe, expect, it } from 'vitest'\n\nimport { createAuthSessionRequests } from './authSessionRequests.js'\n\ndescribe('createAuthSessionRequests', () => {\n  it('should serialize auth requests in queue order', async () => {\n    const authRequests = createAuthSessionRequests()\n    const first = createDeferred<void>()\n    const order: string[] = []\n\n    const firstRequest = authRequests.queue(async () => {\n      order.push('first:start')\n      await first.promise\n      order.push('first:end')\n    })\n    const secondRequest = authRequests.queue(async () => {\n      order.push('second')\n    })\n\n    expect(order).toEqual([])\n    await Promise.resolve()\n    expect(order).toEqual(['first:start'])\n\n    first.resolve()\n    await Promise.all([firstRequest, secondRequest])\n    expect(order).toEqual(['first:start', 'first:end', 'second'])\n  })\n\n  it('should share a refresh while session results remain current', async () => {\n    const authRequests = createAuthSessionRequests()\n    const refresh = createDeferred<null>()\n    let runs = 0\n    const run = () =>\n      authRequests.refresh(async () => {\n        runs += 1\n        return refresh.promise\n      })\n\n    const first = run()\n    const second = run()\n    expect(first).toBe(second)\n\n    refresh.resolve(null)\n    await Promise.all([first, second])\n    expect(runs).toBe(1)\n  })\n\n  it('should discard a queued result after the session changes', async () => {\n    const authRequests = createAuthSessionRequests()\n    const operation = createDeferred<void>()\n    let isResultStaleAfterSettlement = false\n\n    const request = authRequests.queue(async ({ isResultStale }) => {\n      await operation.promise\n      isResultStaleAfterSettlement = isResultStale()\n    })\n\n    await Promise.resolve()\n    authRequests.discardPendingResults()\n    operation.resolve()\n    await request\n\n    expect(isResultStaleAfterSettlement).toBe(true)\n  })\n\n  it('should settle a logout once and prevent refresh from committing', async () => {\n    const authRequests = createAuthSessionRequests()\n    const logout = createDeferred<void>()\n    let clears = 0\n    let logoutRequests = 0\n\n    const first = authRequests.logOut({\n      clearSession: () => {\n        clears += 1\n        authRequests.discardPendingResults()\n      },\n      request: async () => {\n        logoutRequests += 1\n        await logout.promise\n      },\n    })\n    const second = authRequests.logOut({\n      clearSession: () => {\n        clears += 1\n      },\n      request: async () => {\n        logoutRequests += 1\n      },\n    })\n\n    expect(first).toBe(second)\n    expect(authRequests.isLoggingOut()).toBe(true)\n    expect(await authRequests.refresh(async () => null)).toBeNull()\n    logout.resolve()\n    await first\n    expect({ clears, logoutRequests }).toEqual({ clears: 1, logoutRequests: 1 })\n  })\n\n  it('should discard a deferred invalidation after the session changes', async () => {\n    const authRequests = createAuthSessionRequests()\n    let invalidations = 0\n\n    const first = authRequests.refresh(async ({ invalidateWhenIdle }) => {\n      invalidateWhenIdle(() => {\n        invalidations += 1\n      })\n      return null\n    })\n    const second = authRequests.queue(async () => {\n      authRequests.discardPendingResults()\n    })\n\n    await Promise.all([first, second])\n    expect(invalidations).toBe(0)\n  })\n})\n\nfunction createDeferred<Value>(): {\n  promise: Promise<Value>\n  resolve: (value: Value | PromiseLike<Value>) => void\n} {\n  let resolve: ((value: Value | PromiseLike<Value>) => void) | undefined\n  const promise = new Promise<Value>((resolvePromise) => {\n    resolve = resolvePromise\n  })\n\n  if (!resolve) {\n    throw new Error('Expected deferred promise resolver.')\n  }\n\n  return { promise, resolve }\n}\n"],"mappings":"AAAA,SAASA,QAAQ,EAAEC,MAAM,EAAEC,EAAE,QAAQ;AAErC,SAASC,yBAAyB,QAAQ;AAE1CH,QAAA,CAAS,6BAA6B;EACpCE,EAAA,CAAG,iDAAiD;IAClD,MAAME,YAAA,GAAeD,yBAAA;IACrB,MAAME,KAAA,GAAQC,cAAA;IACd,MAAMC,KAAA,GAAkB,EAAE;IAE1B,MAAMC,YAAA,GAAeJ,YAAA,CAAaK,KAAK,CAAC;MACtCF,KAAA,CAAMG,IAAI,CAAC;MACX,MAAML,KAAA,CAAMM,OAAO;MACnBJ,KAAA,CAAMG,IAAI,CAAC;IACb;IACA,MAAME,aAAA,GAAgBR,YAAA,CAAaK,KAAK,CAAC;MACvCF,KAAA,CAAMG,IAAI,CAAC;IACb;IAEAT,MAAA,CAAOM,KAAA,EAAOM,OAAO,CAAC,EAAE;IACxB,MAAMC,OAAA,CAAQC,OAAO;IACrBd,MAAA,CAAOM,KAAA,EAAOM,OAAO,CAAC,CAAC,cAAc;IAErCR,KAAA,CAAMU,OAAO;IACb,MAAMD,OAAA,CAAQE,GAAG,CAAC,CAACR,YAAA,EAAcI,aAAA,CAAc;IAC/CX,MAAA,CAAOM,KAAA,EAAOM,OAAO,CAAC,CAAC,eAAe,aAAa,SAAS;EAC9D;EAEAX,EAAA,CAAG,+DAA+D;IAChE,MAAME,YAAA,GAAeD,yBAAA;IACrB,MAAMc,OAAA,GAAUX,cAAA;IAChB,IAAIY,IAAA,GAAO;IACX,MAAMC,GAAA,GAAMA,CAAA,KACVf,YAAA,CAAaa,OAAO,CAAC;MACnBC,IAAA,IAAQ;MACR,OAAOD,OAAA,CAAQN,OAAO;IACxB;IAEF,MAAMN,KAAA,GAAQc,GAAA;IACd,MAAMC,MAAA,GAASD,GAAA;IACflB,MAAA,CAAOI,KAAA,EAAOgB,IAAI,CAACD,MAAA;IAEnBH,OAAA,CAAQF,OAAO,CAAC;IAChB,MAAMD,OAAA,CAAQE,GAAG,CAAC,CAACX,KAAA,EAAOe,MAAA,CAAO;IACjCnB,MAAA,CAAOiB,IAAA,EAAMG,IAAI,CAAC;EACpB;EAEAnB,EAAA,CAAG,4DAA4D;IAC7D,MAAME,YAAA,GAAeD,yBAAA;IACrB,MAAMmB,SAAA,GAAYhB,cAAA;IAClB,IAAIiB,4BAAA,GAA+B;IAEnC,MAAMC,OAAA,GAAUpB,YAAA,CAAaK,KAAK,CAAC,OAAO;MAAEgB;IAAa,CAAE;MACzD,MAAMH,SAAA,CAAUX,OAAO;MACvBY,4BAAA,GAA+BE,aAAA;IACjC;IAEA,MAAMX,OAAA,CAAQC,OAAO;IACrBX,YAAA,CAAasB,qBAAqB;IAClCJ,SAAA,CAAUP,OAAO;IACjB,MAAMS,OAAA;IAENvB,MAAA,CAAOsB,4BAAA,EAA8BF,IAAI,CAAC;EAC5C;EAEAnB,EAAA,CAAG,mEAAmE;IACpE,MAAME,YAAA,GAAeD,yBAAA;IACrB,MAAMwB,MAAA,GAASrB,cAAA;IACf,IAAIsB,MAAA,GAAS;IACb,IAAIC,cAAA,GAAiB;IAErB,MAAMxB,KAAA,GAAQD,YAAA,CAAa0B,MAAM,CAAC;MAChCC,YAAA,EAAcA,CAAA;QACZH,MAAA,IAAU;QACVxB,YAAA,CAAasB,qBAAqB;MACpC;MACAF,OAAA,EAAS,MAAAA,CAAA;QACPK,cAAA,IAAkB;QAClB,MAAMF,MAAA,CAAOhB,OAAO;MACtB;IACF;IACA,MAAMS,MAAA,GAAShB,YAAA,CAAa0B,MAAM,CAAC;MACjCC,YAAA,EAAcA,CAAA;QACZH,MAAA,IAAU;MACZ;MACAJ,OAAA,EAAS,MAAAA,CAAA;QACPK,cAAA,IAAkB;MACpB;IACF;IAEA5B,MAAA,CAAOI,KAAA,EAAOgB,IAAI,CAACD,MAAA;IACnBnB,MAAA,CAAOG,YAAA,CAAa4B,YAAY,IAAIX,IAAI,CAAC;IACzCpB,MAAA,CAAO,MAAMG,YAAA,CAAaa,OAAO,CAAC,YAAY,OAAOgB,QAAQ;IAC7DN,MAAA,CAAOZ,OAAO;IACd,MAAMV,KAAA;IACNJ,MAAA,CAAO;MAAE2B,MAAA;MAAQC;IAAe,GAAGhB,OAAO,CAAC;MAAEe,MAAA,EAAQ;MAAGC,cAAA,EAAgB;IAAE;EAC5E;EAEA3B,EAAA,CAAG,oEAAoE;IACrE,MAAME,YAAA,GAAeD,yBAAA;IACrB,IAAI+B,aAAA,GAAgB;IAEpB,MAAM7B,KAAA,GAAQD,YAAA,CAAaa,OAAO,CAAC,OAAO;MAAEkB;IAAkB,CAAE;MAC9DA,kBAAA,CAAmB;QACjBD,aAAA,IAAiB;MACnB;MACA,OAAO;IACT;IACA,MAAMd,MAAA,GAAShB,YAAA,CAAaK,KAAK,CAAC;MAChCL,YAAA,CAAasB,qBAAqB;IACpC;IAEA,MAAMZ,OAAA,CAAQE,GAAG,CAAC,CAACX,KAAA,EAAOe,MAAA,CAAO;IACjCnB,MAAA,CAAOiC,aAAA,EAAeb,IAAI,CAAC;EAC7B;AACF;AAEA,SAASf,eAAA;EAIP,IAAIS,OAAA;EACJ,MAAMJ,OAAA,GAAU,IAAIG,OAAA,CAAgBsB,cAAA;IAClCrB,OAAA,GAAUqB,cAAA;EACZ;EAEA,IAAI,CAACrB,OAAA,EAAS;IACZ,MAAM,IAAIsB,KAAA,CAAM;EAClB;EAEA,OAAO;IAAE1B,OAAA;IAASI;EAAQ;AAC5B","ignoreList":[]}

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

@@ -1,60 +1,7 @@
 import type { AuthenticatedUser, SanitizedPermissions } from 'payload';
 import React from 'react';
-export type UserWithToken<T = AuthenticatedUser> = {
-    /** seconds until expiration */
-    exp: number;
-    refreshedToken?: string;
-    token?: string;
-    user: T;
-};
-export type AuthContext<T = AuthenticatedUser> = {
-    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;
-    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;
@@ -62,5 +9,4 @@ type Props = {
 };
 export declare function AuthProvider({ children, permissions: initialPermissions, user: initialUser, }: Props): React.JSX.Element;
 export declare const useAuth: <T = AuthenticatedUser>() => AuthContext<T>;
-export {};
 //# 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,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAKtE,OAAO,KAA+D,MAAM,OAAO,CAAA;AAWnF,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,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,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,iBAAiB,GAAG,IAAI,CAAA;CAChC,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,iBAAiB,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"}