@payloadcms/ui 4.0.0-internal.77191e5 → 4.0.0-internal.7b53b6d

package/dist/providers/Preferences/index.js

@@ -25,6 +25,10 @@ export const PreferencesProvider = ({
   const contextRef = useRef({});
   const preferencesRef = useRef({});
   const pendingUpdate = useRef({});
+  const scheduledMergedUpdates = useRef({});
+  const pendingWrites = useRef({});
+  const updateQueues = useRef({});
+  const latestWrites = useRef({});
   const {
     config
   } = useConfig();
@@ -43,6 +47,10 @@ export const PreferencesProvider = ({
     if (!user) {
       // clear preferences between users
       preferencesRef.current = {};
+      pendingUpdate.current = {};
+      pendingWrites.current = {};
+      updateQueues.current = {};
+      latestWrites.current = {};
     }
   }, [user]);
   const getPreference = useCallback(async key => {
@@ -66,65 +74,123 @@ export const PreferencesProvider = ({
           const preference = await request.json();
           value = preference.value;
         }
-        preferencesRef.current[key] = value;
-        resolve(value);
+        if (prefs[key] === promise) {
+          prefs[key] = value;
+          resolve(value);
+        } else {
+          resolve(await prefs[key]);
+        }
       })();
     });
     prefs[key] = promise;
     return promise;
   }, [i18n.language, api, preferencesRef]);
-  const setPreference = useCallback(async (key_0, value_0, merge = false) => {
+  const syncPreference = useCallback((key_0, value_0) => {
+    if (pendingWrites.current[key_0] || typeof pendingUpdate.current[key_0] !== 'undefined') {
+      return;
+    }
+    preferencesRef.current[key_0] = value_0;
+  }, []);
+  const setPreference = useCallback(async (key_1, value_1, merge = false) => {
+    if (typeof value_1 === 'function') {
+      const updater = value_1;
+      const previousUpdate = updateQueues.current[key_1] ?? Promise.resolve();
+      pendingWrites.current[key_1] = (pendingWrites.current[key_1] ?? 0) + 1;
+      const update = previousUpdate.then(async () => {
+        const current = await getPreference(key_1);
+        const nextValue = updater(current ?? null);
+        preferencesRef.current[key_1] = nextValue;
+        await requests.post(formatAdminURL({
+          apiRoute: api,
+          path: `/payload-preferences/${key_1}`
+        }), requestOptions(nextValue, i18n.language));
+      });
+      latestWrites.current[key_1] = update;
+      updateQueues.current[key_1] = update.catch(() => undefined);
+      try {
+        await update;
+      } finally {
+        pendingWrites.current[key_1] -= 1;
+      }
+      return;
+    }
     if (merge === false) {
-      preferencesRef.current[key_0] = value_0;
-      await requests.post(formatAdminURL({
-        apiRoute: api,
-        path: `/payload-preferences/${key_0}`
-      }), requestOptions(value_0, i18n.language));
+      preferencesRef.current[key_1] = value_1;
+      pendingWrites.current[key_1] = (pendingWrites.current[key_1] ?? 0) + 1;
+      try {
+        const update = requests.post(formatAdminURL({
+          apiRoute: api,
+          path: `/payload-preferences/${key_1}`
+        }), requestOptions(value_1, i18n.language)).then(() => undefined);
+        latestWrites.current[key_1] = update;
+        await update;
+      } finally {
+        pendingWrites.current[key_1] -= 1;
+      }
       return;
     }
-    let newValue = value_0;
-    const currentPreference = await getPreference(key_0);
+    let newValue = value_1;
+    const currentPreference = await getPreference(key_1);
     // handle value objects where multiple values can be set under one key
-    if (typeof value_0 === 'object' && typeof currentPreference === 'object' && typeof newValue === 'object') {
+    if (typeof value_1 === 'object' && typeof currentPreference === 'object' && typeof newValue === 'object') {
       // merge the value with any existing preference for the key
       if (currentPreference) {
         newValue = deepMergeSimple(currentPreference, newValue);
       }
       if (dequal(newValue, currentPreference)) {
+        await latestWrites.current[key_1];
         return;
       }
       // add the requested changes to a pendingUpdate batch for the key
-      pendingUpdate.current[key_0] = {
-        ...pendingUpdate.current[key_0],
+      pendingUpdate.current[key_1] = {
+        ...pendingUpdate.current[key_1],
         ...newValue
       };
     } else {
       if (newValue === currentPreference) {
+        await latestWrites.current[key_1];
         return;
       }
-      pendingUpdate.current[key_0] = newValue;
+      pendingUpdate.current[key_1] = newValue;
     }
     const updatePreference = async () => {
       // compare the value stored in context before sending to eliminate duplicate requests
-      if (dequal(pendingUpdate.current[key_0], preferencesRef.current[key_0])) {
+      if (dequal(pendingUpdate.current[key_1], preferencesRef.current[key_1])) {
         return;
       }
-      // preference set in context here to prevent other updatePreference at the same time
-      preferencesRef.current[key_0] = pendingUpdate.current[key_0];
-      await requests.post(formatAdminURL({
+      // Take this batch before awaiting persistence so later changes form a new batch.
+      const nextValue_0 = pendingUpdate.current[key_1];
+      delete pendingUpdate.current[key_1];
+      preferencesRef.current[key_1] = nextValue_0;
+      pendingWrites.current[key_1] = (pendingWrites.current[key_1] ?? 0) + 1;
+      const previousUpdate_0 = updateQueues.current[key_1] ?? Promise.resolve();
+      const update_0 = previousUpdate_0.then(() => requests.post(formatAdminURL({
         apiRoute: api,
-        path: `/payload-preferences/${key_0}`
-      }), requestOptions(preferencesRef.current[key_0], i18n.language));
-      // reset any changes for this key after sending the request
-      delete pendingUpdate.current[key_0];
+        path: `/payload-preferences/${key_1}`
+      }), requestOptions(nextValue_0, i18n.language)));
+      const latestWrite = update_0.then(() => undefined);
+      latestWrites.current[key_1] = latestWrite;
+      updateQueues.current[key_1] = latestWrite.catch(() => undefined);
+      try {
+        await update_0;
+      } finally {
+        pendingWrites.current[key_1] -= 1;
+      }
     };
-    // use timeout to allow multiple changes of different values using the same key in one request
-    setTimeout(() => {
-      void updatePreference();
-    });
-  }, [api, getPreference, i18n.language, pendingUpdate]);
+    // Callers coalesced into the same batch must all await its persisted write.
+    if (typeof scheduledMergedUpdates.current[key_1] === 'undefined') {
+      scheduledMergedUpdates.current[key_1] = new Promise((resolve_0, reject) => {
+        setTimeout(() => {
+          delete scheduledMergedUpdates.current[key_1];
+          updatePreference().then(resolve_0, reject);
+        });
+      });
+    }
+    await scheduledMergedUpdates.current[key_1];
+  }, [api, getPreference, i18n.language, pendingUpdate, updateQueues]);
   contextRef.current.getPreference = getPreference;
   contextRef.current.setPreference = setPreference;
+  contextRef.current.syncPreference = syncPreference;
   return /*#__PURE__*/_jsx(Context, {
     value: contextRef.current,
     children: children

package/dist/providers/Preferences/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["dequal","formatAdminURL","React","createContext","use","useCallback","useEffect","useRef","useTranslation","requests","deepMergeSimple","useAuth","useConfig","Context","requestOptions","value","language","body","JSON","stringify","headers","PreferencesProvider","children","contextRef","preferencesRef","pendingUpdate","config","user","i18n","routes","api","current","getPreference","key","prefs","promise","Promise","resolve","request","get","apiRoute","path","credentials","status","preference","json","setPreference","merge","post","newValue","currentPreference","updatePreference","setTimeout","_jsx","usePreferences"],"sources":["../../../src/providers/Preferences/index.tsx"],"sourcesContent":["'use client'\nimport { dequal } from 'dequal/lite' // lite: no need for Map and Set support\nimport { formatAdminURL } from 'payload/shared'\nimport React, { createContext, use, useCallback, useEffect, useRef } from 'react'\n\nimport type { Preferences } from '../../forms/Form/types.js'\n\nimport { useTranslation } from '../../providers/Translation/index.js'\nimport { requests } from '../../utilities/api.js'\nimport { deepMergeSimple } from '../../utilities/deepMerge.js'\nimport { useAuth } from '../Auth/index.js'\nimport { useConfig } from '../Config/index.js'\n\ntype PreferencesContext = {\n  getPreference: <T = Preferences>(key: string) => Promise<T>\n  /**\n   * @param key - a string identifier for the property being set\n   * @param value - preference data to store\n   * @param merge - when true will combine the existing preference object batch the change into one request for objects, default = false\n   */\n  setPreference: <T = Preferences>(key: string, value: T, merge?: boolean) => Promise<void>\n}\n\nconst Context = createContext({} as PreferencesContext)\n\nconst requestOptions = (value, language) => ({\n  body: JSON.stringify({ value }),\n  headers: {\n    'Accept-Language': language,\n    'Content-Type': 'application/json',\n  },\n})\n\nexport const PreferencesProvider: React.FC<{ children?: React.ReactNode }> = ({ children }) => {\n  const contextRef = useRef({} as PreferencesContext)\n  const preferencesRef = useRef({})\n  const pendingUpdate = useRef({})\n  const { config } = useConfig()\n  const { user } = useAuth()\n  const { i18n } = useTranslation()\n\n  const {\n    routes: { api },\n  } = config\n\n  useEffect(() => {\n    if (!user) {\n      // clear preferences between users\n      preferencesRef.current = {}\n    }\n  }, [user])\n\n  const getPreference = useCallback(\n    async <T = unknown,>(key: string): Promise<T> => {\n      const prefs = preferencesRef.current\n\n      if (typeof prefs[key] !== 'undefined') {\n        return prefs[key]\n      }\n\n      const promise = new Promise((resolve: (value: T) => void) => {\n        void (async () => {\n          const request = await requests.get(\n            formatAdminURL({\n              apiRoute: api,\n              path: `/payload-preferences/${key}`,\n            }),\n            {\n              credentials: 'include',\n              headers: {\n                'Accept-Language': i18n.language,\n              },\n            },\n          )\n\n          let value = null\n\n          if (request.status === 200) {\n            const preference = await request.json()\n            value = preference.value\n          }\n\n          preferencesRef.current[key] = value\n\n          resolve(value)\n        })()\n      })\n\n      prefs[key] = promise\n\n      return promise\n    },\n    [i18n.language, api, preferencesRef],\n  )\n\n  const setPreference = useCallback(\n    async (key: string, value: unknown, merge = false): Promise<void> => {\n      if (merge === false) {\n        preferencesRef.current[key] = value\n\n        await requests.post(\n          formatAdminURL({\n            apiRoute: api,\n            path: `/payload-preferences/${key}`,\n          }),\n          requestOptions(value, i18n.language),\n        )\n\n        return\n      }\n\n      let newValue = value\n      const currentPreference = await getPreference(key)\n\n      // handle value objects where multiple values can be set under one key\n      if (\n        typeof value === 'object' &&\n        typeof currentPreference === 'object' &&\n        typeof newValue === 'object'\n      ) {\n        // merge the value with any existing preference for the key\n        if (currentPreference) {\n          newValue = deepMergeSimple(currentPreference, newValue)\n        }\n\n        if (dequal(newValue, currentPreference)) {\n          return\n        }\n\n        // add the requested changes to a pendingUpdate batch for the key\n        pendingUpdate.current[key] = {\n          ...pendingUpdate.current[key],\n          ...(newValue as Record<string, unknown>),\n        }\n      } else {\n        if (newValue === currentPreference) {\n          return\n        }\n\n        pendingUpdate.current[key] = newValue\n      }\n\n      const updatePreference = async () => {\n        // compare the value stored in context before sending to eliminate duplicate requests\n        if (dequal(pendingUpdate.current[key], preferencesRef.current[key])) {\n          return\n        }\n\n        // preference set in context here to prevent other updatePreference at the same time\n        preferencesRef.current[key] = pendingUpdate.current[key]\n\n        await requests.post(\n          formatAdminURL({\n            apiRoute: api,\n            path: `/payload-preferences/${key}`,\n          }),\n          requestOptions(preferencesRef.current[key], i18n.language),\n        )\n\n        // reset any changes for this key after sending the request\n        delete pendingUpdate.current[key]\n      }\n\n      // use timeout to allow multiple changes of different values using the same key in one request\n      setTimeout(() => {\n        void updatePreference()\n      })\n    },\n    [api, getPreference, i18n.language, pendingUpdate],\n  )\n\n  contextRef.current.getPreference = getPreference\n  contextRef.current.setPreference = setPreference\n  return <Context value={contextRef.current}>{children}</Context>\n}\n\nexport const usePreferences = (): PreferencesContext => use(Context)\n"],"mappings":"AAAA;;;AACA,SAASA,MAAM,QAAQ,cAAa,CAAC;AACrC,SAASC,cAAc,QAAQ;AAC/B,OAAOC,KAAA,IAASC,aAAa,EAAEC,GAAG,EAAEC,WAAW,EAAEC,SAAS,EAAEC,MAAM,QAAQ;AAI1E,SAASC,cAAc,QAAQ;AAC/B,SAASC,QAAQ,QAAQ;AACzB,SAASC,eAAe,QAAQ;AAChC,SAASC,OAAO,QAAQ;AACxB,SAASC,SAAS,QAAQ;AAY1B,MAAMC,OAAA,gBAAUV,aAAA,CAAc,CAAC;AAE/B,MAAMW,cAAA,GAAiBA,CAACC,KAAA,EAAOC,QAAA,MAAc;EAC3CC,IAAA,EAAMC,IAAA,CAAKC,SAAS,CAAC;IAAEJ;EAAM;EAC7BK,OAAA,EAAS;IACP,mBAAmBJ,QAAA;IACnB,gBAAgB;EAClB;AACF;AAEA,OAAO,MAAMK,mBAAA,GAAgEA,CAAC;EAAEC;AAAQ,CAAE;EACxF,MAAMC,UAAA,GAAahB,MAAA,CAAO,CAAC;EAC3B,MAAMiB,cAAA,GAAiBjB,MAAA,CAAO,CAAC;EAC/B,MAAMkB,aAAA,GAAgBlB,MAAA,CAAO,CAAC;EAC9B,MAAM;IAAEmB;EAAM,CAAE,GAAGd,SAAA;EACnB,MAAM;IAAEe;EAAI,CAAE,GAAGhB,OAAA;EACjB,MAAM;IAAEiB;EAAI,CAAE,GAAGpB,cAAA;EAEjB,MAAM;IACJqB,MAAA,EAAQ;MAAEC;IAAG;EAAE,CAChB,GAAGJ,MAAA;EAEJpB,SAAA,CAAU;IACR,IAAI,CAACqB,IAAA,EAAM;MACT;MACAH,cAAA,CAAeO,OAAO,GAAG,CAAC;IAC5B;EACF,GAAG,CAACJ,IAAA,CAAK;EAET,MAAMK,aAAA,GAAgB3B,WAAA,CACpB,MAAqB4B,GAAA;IACnB,MAAMC,KAAA,GAAQV,cAAA,CAAeO,OAAO;IAEpC,IAAI,OAAOG,KAAK,CAACD,GAAA,CAAI,KAAK,aAAa;MACrC,OAAOC,KAAK,CAACD,GAAA,CAAI;IACnB;IAEA,MAAME,OAAA,GAAU,IAAIC,OAAA,CAASC,OAAA;MAC3B,KAAK,CAAC;QACJ,MAAMC,OAAA,GAAU,MAAM7B,QAAA,CAAS8B,GAAG,CAChCtC,cAAA,CAAe;UACbuC,QAAA,EAAUV,GAAA;UACVW,IAAA,EAAM,wBAAwBR,GAAA;QAChC,IACA;UACES,WAAA,EAAa;UACbtB,OAAA,EAAS;YACP,mBAAmBQ,IAAA,CAAKZ;UAC1B;QACF;QAGF,IAAID,KAAA,GAAQ;QAEZ,IAAIuB,OAAA,CAAQK,MAAM,KAAK,KAAK;UAC1B,MAAMC,UAAA,GAAa,MAAMN,OAAA,CAAQO,IAAI;UACrC9B,KAAA,GAAQ6B,UAAA,CAAW7B,KAAK;QAC1B;QAEAS,cAAA,CAAeO,OAAO,CAACE,GAAA,CAAI,GAAGlB,KAAA;QAE9BsB,OAAA,CAAQtB,KAAA;MACV;IACF;IAEAmB,KAAK,CAACD,GAAA,CAAI,GAAGE,OAAA;IAEb,OAAOA,OAAA;EACT,GACA,CAACP,IAAA,CAAKZ,QAAQ,EAAEc,GAAA,EAAKN,cAAA,CAAe;EAGtC,MAAMsB,aAAA,GAAgBzC,WAAA,CACpB,OAAO4B,KAAA,EAAalB,OAAA,EAAgBgC,KAAA,GAAQ,KAAK;IAC/C,IAAIA,KAAA,KAAU,OAAO;MACnBvB,cAAA,CAAeO,OAAO,CAACE,KAAA,CAAI,GAAGlB,OAAA;MAE9B,MAAMN,QAAA,CAASuC,IAAI,CACjB/C,cAAA,CAAe;QACbuC,QAAA,EAAUV,GAAA;QACVW,IAAA,EAAM,wBAAwBR,KAAA;MAChC,IACAnB,cAAA,CAAeC,OAAA,EAAOa,IAAA,CAAKZ,QAAQ;MAGrC;IACF;IAEA,IAAIiC,QAAA,GAAWlC,OAAA;IACf,MAAMmC,iBAAA,GAAoB,MAAMlB,aAAA,CAAcC,KAAA;IAE9C;IACA,IACE,OAAOlB,OAAA,KAAU,YACjB,OAAOmC,iBAAA,KAAsB,YAC7B,OAAOD,QAAA,KAAa,UACpB;MACA;MACA,IAAIC,iBAAA,EAAmB;QACrBD,QAAA,GAAWvC,eAAA,CAAgBwC,iBAAA,EAAmBD,QAAA;MAChD;MAEA,IAAIjD,MAAA,CAAOiD,QAAA,EAAUC,iBAAA,GAAoB;QACvC;MACF;MAEA;MACAzB,aAAA,CAAcM,OAAO,CAACE,KAAA,CAAI,GAAG;QAC3B,GAAGR,aAAA,CAAcM,OAAO,CAACE,KAAA,CAAI;QAC7B,GAAIgB;MACN;IACF,OAAO;MACL,IAAIA,QAAA,KAAaC,iBAAA,EAAmB;QAClC;MACF;MAEAzB,aAAA,CAAcM,OAAO,CAACE,KAAA,CAAI,GAAGgB,QAAA;IAC/B;IAEA,MAAME,gBAAA,GAAmB,MAAAA,CAAA;MACvB;MACA,IAAInD,MAAA,CAAOyB,aAAA,CAAcM,OAAO,CAACE,KAAA,CAAI,EAAET,cAAA,CAAeO,OAAO,CAACE,KAAA,CAAI,GAAG;QACnE;MACF;MAEA;MACAT,cAAA,CAAeO,OAAO,CAACE,KAAA,CAAI,GAAGR,aAAA,CAAcM,OAAO,CAACE,KAAA,CAAI;MAExD,MAAMxB,QAAA,CAASuC,IAAI,CACjB/C,cAAA,CAAe;QACbuC,QAAA,EAAUV,GAAA;QACVW,IAAA,EAAM,wBAAwBR,KAAA;MAChC,IACAnB,cAAA,CAAeU,cAAA,CAAeO,OAAO,CAACE,KAAA,CAAI,EAAEL,IAAA,CAAKZ,QAAQ;MAG3D;MACA,OAAOS,aAAA,CAAcM,OAAO,CAACE,KAAA,CAAI;IACnC;IAEA;IACAmB,UAAA,CAAW;MACT,KAAKD,gBAAA;IACP;EACF,GACA,CAACrB,GAAA,EAAKE,aAAA,EAAeJ,IAAA,CAAKZ,QAAQ,EAAES,aAAA,CAAc;EAGpDF,UAAA,CAAWQ,OAAO,CAACC,aAAa,GAAGA,aAAA;EACnCT,UAAA,CAAWQ,OAAO,CAACe,aAAa,GAAGA,aAAA;EACnC,oBAAOO,IAAA,CAACxC,OAAA;IAAQE,KAAA,EAAOQ,UAAA,CAAWQ,OAAO;cAAGT;;AAC9C;AAEA,OAAO,MAAMgC,cAAA,GAAiBA,CAAA,KAA0BlD,GAAA,CAAIS,OAAA","ignoreList":[]}
+{"version":3,"file":"index.js","names":["dequal","formatAdminURL","React","createContext","use","useCallback","useEffect","useRef","useTranslation","requests","deepMergeSimple","useAuth","useConfig","Context","requestOptions","value","language","body","JSON","stringify","headers","PreferencesProvider","children","contextRef","preferencesRef","pendingUpdate","scheduledMergedUpdates","pendingWrites","updateQueues","latestWrites","config","user","i18n","routes","api","current","getPreference","key","prefs","promise","Promise","resolve","request","get","apiRoute","path","credentials","status","preference","json","syncPreference","setPreference","merge","updater","previousUpdate","update","then","nextValue","post","catch","undefined","newValue","currentPreference","updatePreference","latestWrite","reject","setTimeout","_jsx","usePreferences"],"sources":["../../../src/providers/Preferences/index.tsx"],"sourcesContent":["'use client'\nimport { dequal } from 'dequal/lite' // lite: no need for Map and Set support\nimport { formatAdminURL } from 'payload/shared'\nimport React, { createContext, use, useCallback, useEffect, useRef } from 'react'\n\nimport type { Preferences } from '../../forms/Form/types.js'\n\nimport { useTranslation } from '../../providers/Translation/index.js'\nimport { requests } from '../../utilities/api.js'\nimport { deepMergeSimple } from '../../utilities/deepMerge.js'\nimport { useAuth } from '../Auth/index.js'\nimport { useConfig } from '../Config/index.js'\n\ntype PreferenceUpdater<T> = (current: null | T) => T\n\ntype SetPreference = {\n  <T = Preferences>(key: string, updater: PreferenceUpdater<T>): Promise<void>\n  <T = Preferences>(key: string, value: T, merge?: boolean): Promise<void>\n}\n\ntype PreferencesContext = {\n  getPreference: <T = Preferences>(key: string) => Promise<T>\n  /**\n   * @param key - a string identifier for the property being set\n   * @param value - preference data to store\n   * @param merge - when true, combines the value with the existing preference stored under the key\n   * and batches concurrent changes to that key into one request, default = false. Awaiting the\n   * returned promise waits for the write to land either way.\n   */\n  setPreference: SetPreference\n  syncPreference: <T = Preferences>(key: string, value: T) => void\n}\n\nconst Context = createContext({} as PreferencesContext)\n\nconst requestOptions = (value, language) => ({\n  body: JSON.stringify({ value }),\n  headers: {\n    'Accept-Language': language,\n    'Content-Type': 'application/json',\n  },\n})\n\nexport const PreferencesProvider: React.FC<{ children?: React.ReactNode }> = ({ children }) => {\n  const contextRef = useRef({} as PreferencesContext)\n  const preferencesRef = useRef({})\n  const pendingUpdate = useRef({})\n  const scheduledMergedUpdates = useRef<Record<string, Promise<void>>>({})\n  const pendingWrites = useRef<Record<string, number>>({})\n  const updateQueues = useRef<Record<string, Promise<void>>>({})\n  const latestWrites = useRef<Record<string, Promise<void>>>({})\n  const { config } = useConfig()\n  const { user } = useAuth()\n  const { i18n } = useTranslation()\n\n  const {\n    routes: { api },\n  } = config\n\n  useEffect(() => {\n    if (!user) {\n      // clear preferences between users\n      preferencesRef.current = {}\n      pendingUpdate.current = {}\n      pendingWrites.current = {}\n      updateQueues.current = {}\n      latestWrites.current = {}\n    }\n  }, [user])\n\n  const getPreference = useCallback(\n    async <T = unknown,>(key: string): Promise<T> => {\n      const prefs = preferencesRef.current\n\n      if (typeof prefs[key] !== 'undefined') {\n        return prefs[key]\n      }\n\n      const promise = new Promise((resolve: (value: T) => void) => {\n        void (async () => {\n          const request = await requests.get(\n            formatAdminURL({\n              apiRoute: api,\n              path: `/payload-preferences/${key}`,\n            }),\n            {\n              credentials: 'include',\n              headers: {\n                'Accept-Language': i18n.language,\n              },\n            },\n          )\n\n          let value = null\n\n          if (request.status === 200) {\n            const preference = await request.json()\n            value = preference.value\n          }\n\n          if (prefs[key] === promise) {\n            prefs[key] = value\n            resolve(value)\n          } else {\n            resolve(await prefs[key])\n          }\n        })()\n      })\n\n      prefs[key] = promise\n\n      return promise\n    },\n    [i18n.language, api, preferencesRef],\n  )\n\n  const syncPreference = useCallback(<T = Preferences,>(key: string, value: T): void => {\n    if (pendingWrites.current[key] || typeof pendingUpdate.current[key] !== 'undefined') {\n      return\n    }\n\n    preferencesRef.current[key] = value\n  }, [])\n\n  const setPreference = useCallback(\n    async <T = Preferences,>(\n      key: string,\n      value: PreferenceUpdater<T> | T,\n      merge = false,\n    ): Promise<void> => {\n      if (typeof value === 'function') {\n        const updater = value as PreferenceUpdater<T>\n        const previousUpdate = updateQueues.current[key] ?? Promise.resolve()\n        pendingWrites.current[key] = (pendingWrites.current[key] ?? 0) + 1\n        const update = previousUpdate.then(async () => {\n          const current = await getPreference<T>(key)\n          const nextValue = updater(current ?? null)\n\n          preferencesRef.current[key] = nextValue\n\n          await requests.post(\n            formatAdminURL({\n              apiRoute: api,\n              path: `/payload-preferences/${key}`,\n            }),\n            requestOptions(nextValue, i18n.language),\n          )\n        })\n\n        latestWrites.current[key] = update\n        updateQueues.current[key] = update.catch(() => undefined)\n        try {\n          await update\n        } finally {\n          pendingWrites.current[key] -= 1\n        }\n        return\n      }\n\n      if (merge === false) {\n        preferencesRef.current[key] = value\n        pendingWrites.current[key] = (pendingWrites.current[key] ?? 0) + 1\n\n        try {\n          const update = requests\n            .post(\n              formatAdminURL({\n                apiRoute: api,\n                path: `/payload-preferences/${key}`,\n              }),\n              requestOptions(value, i18n.language),\n            )\n            .then(() => undefined)\n\n          latestWrites.current[key] = update\n          await update\n        } finally {\n          pendingWrites.current[key] -= 1\n        }\n\n        return\n      }\n\n      let newValue = value\n      const currentPreference = await getPreference(key)\n\n      // handle value objects where multiple values can be set under one key\n      if (\n        typeof value === 'object' &&\n        typeof currentPreference === 'object' &&\n        typeof newValue === 'object'\n      ) {\n        // merge the value with any existing preference for the key\n        if (currentPreference) {\n          newValue = deepMergeSimple(currentPreference, newValue)\n        }\n\n        if (dequal(newValue, currentPreference)) {\n          await latestWrites.current[key]\n          return\n        }\n\n        // add the requested changes to a pendingUpdate batch for the key\n        pendingUpdate.current[key] = {\n          ...pendingUpdate.current[key],\n          ...(newValue as Record<string, unknown>),\n        }\n      } else {\n        if (newValue === currentPreference) {\n          await latestWrites.current[key]\n          return\n        }\n\n        pendingUpdate.current[key] = newValue\n      }\n\n      const updatePreference = async () => {\n        // compare the value stored in context before sending to eliminate duplicate requests\n        if (dequal(pendingUpdate.current[key], preferencesRef.current[key])) {\n          return\n        }\n\n        // Take this batch before awaiting persistence so later changes form a new batch.\n        const nextValue = pendingUpdate.current[key]\n\n        delete pendingUpdate.current[key]\n        preferencesRef.current[key] = nextValue\n        pendingWrites.current[key] = (pendingWrites.current[key] ?? 0) + 1\n\n        const previousUpdate = updateQueues.current[key] ?? Promise.resolve()\n        const update = previousUpdate.then(() =>\n          requests.post(\n            formatAdminURL({\n              apiRoute: api,\n              path: `/payload-preferences/${key}`,\n            }),\n            requestOptions(nextValue, i18n.language),\n          ),\n        )\n\n        const latestWrite = update.then(() => undefined)\n\n        latestWrites.current[key] = latestWrite\n        updateQueues.current[key] = latestWrite.catch(() => undefined)\n        try {\n          await update\n        } finally {\n          pendingWrites.current[key] -= 1\n        }\n      }\n\n      // Callers coalesced into the same batch must all await its persisted write.\n      if (typeof scheduledMergedUpdates.current[key] === 'undefined') {\n        scheduledMergedUpdates.current[key] = new Promise<void>((resolve, reject) => {\n          setTimeout(() => {\n            delete scheduledMergedUpdates.current[key]\n            updatePreference().then(resolve, reject)\n          })\n        })\n      }\n\n      await scheduledMergedUpdates.current[key]\n    },\n    [api, getPreference, i18n.language, pendingUpdate, updateQueues],\n  )\n\n  contextRef.current.getPreference = getPreference\n  contextRef.current.setPreference = setPreference\n  contextRef.current.syncPreference = syncPreference\n  return <Context value={contextRef.current}>{children}</Context>\n}\n\nexport const usePreferences = (): PreferencesContext => use(Context)\n"],"mappings":"AAAA;;;AACA,SAASA,MAAM,QAAQ,cAAa,CAAC;AACrC,SAASC,cAAc,QAAQ;AAC/B,OAAOC,KAAA,IAASC,aAAa,EAAEC,GAAG,EAAEC,WAAW,EAAEC,SAAS,EAAEC,MAAM,QAAQ;AAI1E,SAASC,cAAc,QAAQ;AAC/B,SAASC,QAAQ,QAAQ;AACzB,SAASC,eAAe,QAAQ;AAChC,SAASC,OAAO,QAAQ;AACxB,SAASC,SAAS,QAAQ;AAsB1B,MAAMC,OAAA,gBAAUV,aAAA,CAAc,CAAC;AAE/B,MAAMW,cAAA,GAAiBA,CAACC,KAAA,EAAOC,QAAA,MAAc;EAC3CC,IAAA,EAAMC,IAAA,CAAKC,SAAS,CAAC;IAAEJ;EAAM;EAC7BK,OAAA,EAAS;IACP,mBAAmBJ,QAAA;IACnB,gBAAgB;EAClB;AACF;AAEA,OAAO,MAAMK,mBAAA,GAAgEA,CAAC;EAAEC;AAAQ,CAAE;EACxF,MAAMC,UAAA,GAAahB,MAAA,CAAO,CAAC;EAC3B,MAAMiB,cAAA,GAAiBjB,MAAA,CAAO,CAAC;EAC/B,MAAMkB,aAAA,GAAgBlB,MAAA,CAAO,CAAC;EAC9B,MAAMmB,sBAAA,GAAyBnB,MAAA,CAAsC,CAAC;EACtE,MAAMoB,aAAA,GAAgBpB,MAAA,CAA+B,CAAC;EACtD,MAAMqB,YAAA,GAAerB,MAAA,CAAsC,CAAC;EAC5D,MAAMsB,YAAA,GAAetB,MAAA,CAAsC,CAAC;EAC5D,MAAM;IAAEuB;EAAM,CAAE,GAAGlB,SAAA;EACnB,MAAM;IAAEmB;EAAI,CAAE,GAAGpB,OAAA;EACjB,MAAM;IAAEqB;EAAI,CAAE,GAAGxB,cAAA;EAEjB,MAAM;IACJyB,MAAA,EAAQ;MAAEC;IAAG;EAAE,CAChB,GAAGJ,MAAA;EAEJxB,SAAA,CAAU;IACR,IAAI,CAACyB,IAAA,EAAM;MACT;MACAP,cAAA,CAAeW,OAAO,GAAG,CAAC;MAC1BV,aAAA,CAAcU,OAAO,GAAG,CAAC;MACzBR,aAAA,CAAcQ,OAAO,GAAG,CAAC;MACzBP,YAAA,CAAaO,OAAO,GAAG,CAAC;MACxBN,YAAA,CAAaM,OAAO,GAAG,CAAC;IAC1B;EACF,GAAG,CAACJ,IAAA,CAAK;EAET,MAAMK,aAAA,GAAgB/B,WAAA,CACpB,MAAqBgC,GAAA;IACnB,MAAMC,KAAA,GAAQd,cAAA,CAAeW,OAAO;IAEpC,IAAI,OAAOG,KAAK,CAACD,GAAA,CAAI,KAAK,aAAa;MACrC,OAAOC,KAAK,CAACD,GAAA,CAAI;IACnB;IAEA,MAAME,OAAA,GAAU,IAAIC,OAAA,CAASC,OAAA;MAC3B,KAAK,CAAC;QACJ,MAAMC,OAAA,GAAU,MAAMjC,QAAA,CAASkC,GAAG,CAChC1C,cAAA,CAAe;UACb2C,QAAA,EAAUV,GAAA;UACVW,IAAA,EAAM,wBAAwBR,GAAA;QAChC,IACA;UACES,WAAA,EAAa;UACb1B,OAAA,EAAS;YACP,mBAAmBY,IAAA,CAAKhB;UAC1B;QACF;QAGF,IAAID,KAAA,GAAQ;QAEZ,IAAI2B,OAAA,CAAQK,MAAM,KAAK,KAAK;UAC1B,MAAMC,UAAA,GAAa,MAAMN,OAAA,CAAQO,IAAI;UACrClC,KAAA,GAAQiC,UAAA,CAAWjC,KAAK;QAC1B;QAEA,IAAIuB,KAAK,CAACD,GAAA,CAAI,KAAKE,OAAA,EAAS;UAC1BD,KAAK,CAACD,GAAA,CAAI,GAAGtB,KAAA;UACb0B,OAAA,CAAQ1B,KAAA;QACV,OAAO;UACL0B,OAAA,CAAQ,MAAMH,KAAK,CAACD,GAAA,CAAI;QAC1B;MACF;IACF;IAEAC,KAAK,CAACD,GAAA,CAAI,GAAGE,OAAA;IAEb,OAAOA,OAAA;EACT,GACA,CAACP,IAAA,CAAKhB,QAAQ,EAAEkB,GAAA,EAAKV,cAAA,CAAe;EAGtC,MAAM0B,cAAA,GAAiB7C,WAAA,CAAY,CAAmBgC,KAAA,EAAatB,OAAA;IACjE,IAAIY,aAAA,CAAcQ,OAAO,CAACE,KAAA,CAAI,IAAI,OAAOZ,aAAA,CAAcU,OAAO,CAACE,KAAA,CAAI,KAAK,aAAa;MACnF;IACF;IAEAb,cAAA,CAAeW,OAAO,CAACE,KAAA,CAAI,GAAGtB,OAAA;EAChC,GAAG,EAAE;EAEL,MAAMoC,aAAA,GAAgB9C,WAAA,CACpB,OACEgC,KAAA,EACAtB,OAAA,EACAqC,KAAA,GAAQ,KAAK;IAEb,IAAI,OAAOrC,OAAA,KAAU,YAAY;MAC/B,MAAMsC,OAAA,GAAUtC,OAAA;MAChB,MAAMuC,cAAA,GAAiB1B,YAAA,CAAaO,OAAO,CAACE,KAAA,CAAI,IAAIG,OAAA,CAAQC,OAAO;MACnEd,aAAA,CAAcQ,OAAO,CAACE,KAAA,CAAI,GAAG,CAACV,aAAA,CAAcQ,OAAO,CAACE,KAAA,CAAI,IAAI,KAAK;MACjE,MAAMkB,MAAA,GAASD,cAAA,CAAeE,IAAI,CAAC;QACjC,MAAMrB,OAAA,GAAU,MAAMC,aAAA,CAAiBC,KAAA;QACvC,MAAMoB,SAAA,GAAYJ,OAAA,CAAQlB,OAAA,IAAW;QAErCX,cAAA,CAAeW,OAAO,CAACE,KAAA,CAAI,GAAGoB,SAAA;QAE9B,MAAMhD,QAAA,CAASiD,IAAI,CACjBzD,cAAA,CAAe;UACb2C,QAAA,EAAUV,GAAA;UACVW,IAAA,EAAM,wBAAwBR,KAAA;QAChC,IACAvB,cAAA,CAAe2C,SAAA,EAAWzB,IAAA,CAAKhB,QAAQ;MAE3C;MAEAa,YAAA,CAAaM,OAAO,CAACE,KAAA,CAAI,GAAGkB,MAAA;MAC5B3B,YAAA,CAAaO,OAAO,CAACE,KAAA,CAAI,GAAGkB,MAAA,CAAOI,KAAK,CAAC,MAAMC,SAAA;MAC/C,IAAI;QACF,MAAML,MAAA;MACR,UAAU;QACR5B,aAAA,CAAcQ,OAAO,CAACE,KAAA,CAAI,IAAI;MAChC;MACA;IACF;IAEA,IAAIe,KAAA,KAAU,OAAO;MACnB5B,cAAA,CAAeW,OAAO,CAACE,KAAA,CAAI,GAAGtB,OAAA;MAC9BY,aAAA,CAAcQ,OAAO,CAACE,KAAA,CAAI,GAAG,CAACV,aAAA,CAAcQ,OAAO,CAACE,KAAA,CAAI,IAAI,KAAK;MAEjE,IAAI;QACF,MAAMkB,MAAA,GAAS9C,QAAA,CACZiD,IAAI,CACHzD,cAAA,CAAe;UACb2C,QAAA,EAAUV,GAAA;UACVW,IAAA,EAAM,wBAAwBR,KAAA;QAChC,IACAvB,cAAA,CAAeC,OAAA,EAAOiB,IAAA,CAAKhB,QAAQ,GAEpCwC,IAAI,CAAC,MAAMI,SAAA;QAEd/B,YAAA,CAAaM,OAAO,CAACE,KAAA,CAAI,GAAGkB,MAAA;QAC5B,MAAMA,MAAA;MACR,UAAU;QACR5B,aAAA,CAAcQ,OAAO,CAACE,KAAA,CAAI,IAAI;MAChC;MAEA;IACF;IAEA,IAAIwB,QAAA,GAAW9C,OAAA;IACf,MAAM+C,iBAAA,GAAoB,MAAM1B,aAAA,CAAcC,KAAA;IAE9C;IACA,IACE,OAAOtB,OAAA,KAAU,YACjB,OAAO+C,iBAAA,KAAsB,YAC7B,OAAOD,QAAA,KAAa,UACpB;MACA;MACA,IAAIC,iBAAA,EAAmB;QACrBD,QAAA,GAAWnD,eAAA,CAAgBoD,iBAAA,EAAmBD,QAAA;MAChD;MAEA,IAAI7D,MAAA,CAAO6D,QAAA,EAAUC,iBAAA,GAAoB;QACvC,MAAMjC,YAAA,CAAaM,OAAO,CAACE,KAAA,CAAI;QAC/B;MACF;MAEA;MACAZ,aAAA,CAAcU,OAAO,CAACE,KAAA,CAAI,GAAG;QAC3B,GAAGZ,aAAA,CAAcU,OAAO,CAACE,KAAA,CAAI;QAC7B,GAAIwB;MACN;IACF,OAAO;MACL,IAAIA,QAAA,KAAaC,iBAAA,EAAmB;QAClC,MAAMjC,YAAA,CAAaM,OAAO,CAACE,KAAA,CAAI;QAC/B;MACF;MAEAZ,aAAA,CAAcU,OAAO,CAACE,KAAA,CAAI,GAAGwB,QAAA;IAC/B;IAEA,MAAME,gBAAA,GAAmB,MAAAA,CAAA;MACvB;MACA,IAAI/D,MAAA,CAAOyB,aAAA,CAAcU,OAAO,CAACE,KAAA,CAAI,EAAEb,cAAA,CAAeW,OAAO,CAACE,KAAA,CAAI,GAAG;QACnE;MACF;MAEA;MACA,MAAMoB,WAAA,GAAYhC,aAAA,CAAcU,OAAO,CAACE,KAAA,CAAI;MAE5C,OAAOZ,aAAA,CAAcU,OAAO,CAACE,KAAA,CAAI;MACjCb,cAAA,CAAeW,OAAO,CAACE,KAAA,CAAI,GAAGoB,WAAA;MAC9B9B,aAAA,CAAcQ,OAAO,CAACE,KAAA,CAAI,GAAG,CAACV,aAAA,CAAcQ,OAAO,CAACE,KAAA,CAAI,IAAI,KAAK;MAEjE,MAAMiB,gBAAA,GAAiB1B,YAAA,CAAaO,OAAO,CAACE,KAAA,CAAI,IAAIG,OAAA,CAAQC,OAAO;MACnE,MAAMc,QAAA,GAASD,gBAAA,CAAeE,IAAI,CAAC,MACjC/C,QAAA,CAASiD,IAAI,CACXzD,cAAA,CAAe;QACb2C,QAAA,EAAUV,GAAA;QACVW,IAAA,EAAM,wBAAwBR,KAAA;MAChC,IACAvB,cAAA,CAAe2C,WAAA,EAAWzB,IAAA,CAAKhB,QAAQ;MAI3C,MAAMgD,WAAA,GAAcT,QAAA,CAAOC,IAAI,CAAC,MAAMI,SAAA;MAEtC/B,YAAA,CAAaM,OAAO,CAACE,KAAA,CAAI,GAAG2B,WAAA;MAC5BpC,YAAA,CAAaO,OAAO,CAACE,KAAA,CAAI,GAAG2B,WAAA,CAAYL,KAAK,CAAC,MAAMC,SAAA;MACpD,IAAI;QACF,MAAML,QAAA;MACR,UAAU;QACR5B,aAAA,CAAcQ,OAAO,CAACE,KAAA,CAAI,IAAI;MAChC;IACF;IAEA;IACA,IAAI,OAAOX,sBAAA,CAAuBS,OAAO,CAACE,KAAA,CAAI,KAAK,aAAa;MAC9DX,sBAAA,CAAuBS,OAAO,CAACE,KAAA,CAAI,GAAG,IAAIG,OAAA,CAAc,CAACC,SAAA,EAASwB,MAAA;QAChEC,UAAA,CAAW;UACT,OAAOxC,sBAAA,CAAuBS,OAAO,CAACE,KAAA,CAAI;UAC1C0B,gBAAA,GAAmBP,IAAI,CAACf,SAAA,EAASwB,MAAA;QACnC;MACF;IACF;IAEA,MAAMvC,sBAAA,CAAuBS,OAAO,CAACE,KAAA,CAAI;EAC3C,GACA,CAACH,GAAA,EAAKE,aAAA,EAAeJ,IAAA,CAAKhB,QAAQ,EAAES,aAAA,EAAeG,YAAA,CAAa;EAGlEL,UAAA,CAAWY,OAAO,CAACC,aAAa,GAAGA,aAAA;EACnCb,UAAA,CAAWY,OAAO,CAACgB,aAAa,GAAGA,aAAA;EACnC5B,UAAA,CAAWY,OAAO,CAACe,cAAc,GAAGA,cAAA;EACpC,oBAAOiB,IAAA,CAACtD,OAAA;IAAQE,KAAA,EAAOQ,UAAA,CAAWY,OAAO;cAAGb;;AAC9C;AAEA,OAAO,MAAM8C,cAAA,GAAiBA,CAAA,KAA0BhE,GAAA,CAAIS,OAAA","ignoreList":[]}

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/RouteCache/index.tsx"],"names":[],"mappings":"AAEA,OAAO,KAA6D,MAAM,OAAO,CAAA;AAKjF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,cAAc,EAAE,OAAO,CAAA;IACvB,eAAe,EAAE,MAAM,IAAI,CAAA;CAC5B,CAAA;AAOD,eAAO,MAAM,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC;IAAE,cAAc,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAAE,CA4CxF,CAAA;AAED,eAAO,MAAM,aAAa,yBAAqB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/RouteCache/index.tsx"],"names":[],"mappings":"AAEA,OAAO,KAA6D,MAAM,OAAO,CAAA;AAKjF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,cAAc,EAAE,OAAO,CAAA;IACvB,eAAe,EAAE,MAAM,IAAI,CAAA;CAC5B,CAAA;AAOD,eAAO,MAAM,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC;IAAE,cAAc,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAAE,CA0ExF,CAAA;AAED,eAAO,MAAM,aAAa,yBAAqB,CAAA"}

package/dist/providers/RouteCache/index.js

@@ -18,7 +18,7 @@ export const RouteCache = t0 => {
   const cachingEnabled = t1 === undefined ? true : t1;
   const pathname = usePathname();
   const router = useRouter();
-  const clearAfterPathnameChange = useRef(false);
+  const previousPathnameRef = useRef("");
   let t2;
   if ($[0] !== router) {
     t2 = () => {
@@ -31,51 +31,63 @@ export const RouteCache = t0 => {
   }
   const clearRouteCache = t2;
   let t3;
-  if ($[2] === Symbol.for("react.memo_cache_sentinel")) {
+  let t4;
+  if ($[2] !== cachingEnabled || $[3] !== clearRouteCache) {
     t3 = () => {
+      if (cachingEnabled) {
+        return;
+      }
+      previousPathnameRef.current = window.location.pathname;
+      let refreshTimeout;
       const handlePopState = () => {
-        clearAfterPathnameChange.current = true;
+        const currentPathname = window.location.pathname;
+        if (previousPathnameRef.current === currentPathname) {
+          return;
+        }
+        previousPathnameRef.current = currentPathname;
+        refreshTimeout = setTimeout(clearRouteCache, 0);
       };
       window.addEventListener("popstate", handlePopState);
       return () => {
+        clearTimeout(refreshTimeout);
         window.removeEventListener("popstate", handlePopState);
       };
     };
-    $[2] = t3;
-  } else {
-    t3 = $[2];
-  }
-  let t4;
-  if ($[3] !== router) {
-    t4 = [router];
-    $[3] = router;
-    $[4] = t4;
+    t4 = [cachingEnabled, clearRouteCache];
+    $[2] = cachingEnabled;
+    $[3] = clearRouteCache;
+    $[4] = t3;
+    $[5] = t4;
   } else {
-    t4 = $[4];
+    t3 = $[4];
+    t4 = $[5];
   }
   useEffect(t3, t4);
   let t5;
-  if ($[5] !== cachingEnabled || $[6] !== clearRouteCache) {
-    t5 = pathname_0 => {
-      if (cachingEnabled || clearAfterPathnameChange.current) {
-        clearAfterPathnameChange.current = false;
+  if ($[6] !== cachingEnabled || $[7] !== clearRouteCache) {
+    t5 = () => {
+      if (cachingEnabled) {
         clearRouteCache();
       }
     };
-    $[5] = cachingEnabled;
-    $[6] = clearRouteCache;
-    $[7] = t5;
+    $[6] = cachingEnabled;
+    $[7] = clearRouteCache;
+    $[8] = t5;
   } else {
-    t5 = $[7];
+    t5 = $[8];
   }
   const handlePathnameChange = useEffectEvent(t5);
   let t6;
-  if ($[8] !== handlePathnameChange || $[9] !== pathname) {
+  if ($[9] !== handlePathnameChange) {
     t6 = () => {
-      handlePathnameChange(pathname);
+      handlePathnameChange();
+      const currentPathname_0 = window.location.pathname;
+      const timeout = setTimeout(() => {
+        previousPathnameRef.current = currentPathname_0;
+      }, 0);
+      return () => clearTimeout(timeout);
     };
-    $[8] = handlePathnameChange;
-    $[9] = pathname;
+    $[9] = handlePathnameChange;
     $[10] = t6;
   } else {
     t6 = $[10];

package/dist/providers/RouteCache/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["c","_c","React","createContext","use","useCallback","useEffect","useRef","useEffectEvent","usePathname","useRouter","Context","cachingEnabled","clearRouteCache","RouteCache","t0","$","t1","children","undefined","pathname","router","clearAfterPathnameChange","t2","refresh","t3","Symbol","for","handlePopState","current","window","addEventListener","removeEventListener","t4","t5","pathname_0","handlePathnameChange","t6","t7","t8","_jsx","value","useRouteCache"],"sources":["../../../src/providers/RouteCache/index.tsx"],"sourcesContent":["'use client'\n\nimport React, { createContext, use, useCallback, useEffect, useRef } from 'react'\n\nimport { useEffectEvent } from '../../hooks/useEffectEvent.js'\nimport { usePathname, useRouter } from '../RouterAdapter/index.js'\n\nexport type RouteCacheContext = {\n  cachingEnabled: boolean\n  clearRouteCache: () => void\n}\n\nconst Context = createContext<RouteCacheContext>({\n  cachingEnabled: true,\n  clearRouteCache: () => {},\n})\n\nexport const RouteCache: React.FC<{ cachingEnabled?: boolean; children: React.ReactNode }> = ({\n  cachingEnabled = true,\n  children,\n}) => {\n  const pathname = usePathname()\n  const router = useRouter()\n\n  /**\n   * Next.js caches pages in memory in their {@link https://nextjs.org/docs/app/guides/caching#client-side-router-cache Client-side Router Cache},\n   * causing forward/back browser navigation to show stale data from a previous visit.\n   * The problem is this bfcache-like behavior has no opt-out, even if the page is dynamic, requires authentication, etc.\n   * The workaround is to force a refresh when navigating via the browser controls.\n   * This should be removed if/when Next.js supports this natively.\n   */\n  const clearAfterPathnameChange = useRef(false)\n\n  const clearRouteCache = useCallback(() => {\n    router.refresh()\n  }, [router])\n\n  useEffect(() => {\n    const handlePopState = () => {\n      clearAfterPathnameChange.current = true\n    }\n\n    window.addEventListener('popstate', handlePopState)\n\n    return () => {\n      window.removeEventListener('popstate', handlePopState)\n    }\n  }, [router])\n\n  const handlePathnameChange = useEffectEvent((pathname: string) => {\n    if (cachingEnabled || clearAfterPathnameChange.current) {\n      clearAfterPathnameChange.current = false\n      clearRouteCache()\n    }\n  })\n\n  useEffect(() => {\n    handlePathnameChange(pathname)\n  }, [pathname])\n\n  return <Context value={{ cachingEnabled, clearRouteCache }}>{children}</Context>\n}\n\nexport const useRouteCache = () => use(Context)\n"],"mappings":"AAAA;;AAAA,SAAAA,CAAA,IAAAC,EAAA;;AAEA,OAAOC,KAAA,IAASC,aAAa,EAAEC,GAAG,EAAEC,WAAW,EAAEC,SAAS,EAAEC,MAAM,QAAQ;AAE1E,SAASC,cAAc,QAAQ;AAC/B,SAASC,WAAW,EAAEC,SAAS,QAAQ;AAOvC,MAAMC,OAAA,gBAAUR,aAAA,CAAiC;EAC/CS,cAAA,EAAgB;EAChBC,eAAA,EAAiBA,CAAA,MAAO;AAC1B;AAEA,OAAO,MAAMC,UAAA,GAAgFC,EAAA;EAAA,MAAAC,CAAA,GAAAf,EAAA;EAAC;IAAAW,cAAA,EAAAK,EAAA;IAAAC;EAAA,IAAAH,EAG7F;EAFC,MAAAH,cAAA,GAAAK,EAAqB,KAAAE,SAAA,UAArBF,EAAqB;EAGrB,MAAAG,QAAA,GAAiBX,WAAA;EACjB,MAAAY,MAAA,GAAeX,SAAA;EASf,MAAAY,wBAAA,GAAiCf,MAAA,MAAO;EAAA,IAAAgB,EAAA;EAAA,IAAAP,CAAA,QAAAK,MAAA;IAEJE,EAAA,GAAAA,CAAA;MAClCF,MAAA,CAAAG,OAAA,CAAc;IAAA;IAChBR,CAAA,MAAAK,MAAA;IAAAL,CAAA,MAAAO,EAAA;EAAA;IAAAA,EAAA,GAAAP,CAAA;EAAA;EAFA,MAAAH,eAAA,GAAwBU,EAEb;EAAA,IAAAE,EAAA;EAAA,IAAAT,CAAA,QAAAU,MAAA,CAAAC,GAAA;IAEDF,EAAA,GAAAA,CAAA;MACR,MAAAG,cAAA,GAAAA,CAAA;QACEN,wBAAA,CAAAO,OAAA;MAAA;MAGFC,MAAA,CAAAC,gBAAA,CAAwB,YAAYH,cAAA;MAAA;QAGlCE,MAAA,CAAAE,mBAAA,CAA2B,YAAYJ,cAAA;MAAA;IAAA;IAE3CZ,CAAA,MAAAS,EAAA;EAAA;IAAAA,EAAA,GAAAT,CAAA;EAAA;EAAA,IAAAiB,EAAA;EAAA,IAAAjB,CAAA,QAAAK,MAAA;IAAGY,EAAA,IAACZ,MAAA;IAAOL,CAAA,MAAAK,MAAA;IAAAL,CAAA,MAAAiB,EAAA;EAAA;IAAAA,EAAA,GAAAjB,CAAA;EAAA;EAVXV,SAAA,CAAUmB,EAUV,EAAGQ,EAAQ;EAAA,IAAAC,EAAA;EAAA,IAAAlB,CAAA,QAAAJ,cAAA,IAAAI,CAAA,QAAAH,eAAA;IAEiCqB,EAAA,GAAAC,UAAA;MAAA,IACtCvB,cAAA,IAAkBU,wBAAA,CAAAO,OAAgC;QACpDP,wBAAA,CAAAO,OAAA;QACAhB,eAAA;MAAA;IAAA;IAEJG,CAAA,MAAAJ,cAAA;IAAAI,CAAA,MAAAH,eAAA;IAAAG,CAAA,MAAAkB,EAAA;EAAA;IAAAA,EAAA,GAAAlB,CAAA;EAAA;EALA,MAAAoB,oBAAA,GAA6B5B,cAAA,CAAe0B,EAK5C;EAAA,IAAAG,EAAA;EAAA,IAAArB,CAAA,QAAAoB,oBAAA,IAAApB,CAAA,QAAAI,QAAA;IAEUiB,EAAA,GAAAA,CAAA;MACRD,oBAAA,CAAqBhB,QAAA;IAAA;IACvBJ,CAAA,MAAAoB,oBAAA;IAAApB,CAAA,MAAAI,QAAA;IAAAJ,CAAA,OAAAqB,EAAA;EAAA;IAAAA,EAAA,GAAArB,CAAA;EAAA;EAAA,IAAAsB,EAAA;EAAA,IAAAtB,CAAA,SAAAI,QAAA;IAAGkB,EAAA,IAAClB,QAAA;IAASJ,CAAA,OAAAI,QAAA;IAAAJ,CAAA,OAAAsB,EAAA;EAAA;IAAAA,EAAA,GAAAtB,CAAA;EAAA;EAFbV,SAAA,CAAU+B,EAEV,EAAGC,EAAU;EAAA,IAAAC,EAAA;EAAA,IAAAvB,CAAA,SAAAJ,cAAA,IAAAI,CAAA,SAAAE,QAAA,IAAAF,CAAA,SAAAH,eAAA;IAEN0B,EAAA,GAAAC,IAAA,CAAA7B,OAAA;MAAA8B,KAAA;QAAA7B,cAAA;QAAAC;MAAA;MAAAK;IAAA,C;;;;;;;;SAAAqB,E;CACT;AAEA,OAAO,MAAMG,aAAA,GAAgBA,CAAA,KAAMtC,GAAA,CAAIO,OAAA","ignoreList":[]}
+{"version":3,"file":"index.js","names":["c","_c","React","createContext","use","useCallback","useEffect","useRef","useEffectEvent","usePathname","useRouter","Context","cachingEnabled","clearRouteCache","RouteCache","t0","$","t1","children","undefined","pathname","router","previousPathnameRef","t2","refresh","t3","t4","current","window","location","refreshTimeout","handlePopState","currentPathname","setTimeout","addEventListener","clearTimeout","removeEventListener","t5","handlePathnameChange","t6","currentPathname_0","timeout","t7","t8","_jsx","value","useRouteCache"],"sources":["../../../src/providers/RouteCache/index.tsx"],"sourcesContent":["'use client'\n\nimport React, { createContext, use, useCallback, useEffect, useRef } from 'react'\n\nimport { useEffectEvent } from '../../hooks/useEffectEvent.js'\nimport { usePathname, useRouter } from '../RouterAdapter/index.js'\n\nexport type RouteCacheContext = {\n  cachingEnabled: boolean\n  clearRouteCache: () => void\n}\n\nconst Context = createContext<RouteCacheContext>({\n  cachingEnabled: true,\n  clearRouteCache: () => {},\n})\n\nexport const RouteCache: React.FC<{ cachingEnabled?: boolean; children: React.ReactNode }> = ({\n  cachingEnabled = true,\n  children,\n}) => {\n  const pathname = usePathname()\n  const router = useRouter()\n  const previousPathnameRef = useRef('')\n\n  const clearRouteCache = useCallback(() => {\n    router.refresh()\n  }, [router])\n\n  /**\n   * Next.js caches pages in memory in their {@link https://nextjs.org/docs/app/guides/caching#client-side-router-cache Client-side Router Cache},\n   * causing forward/back browser navigation to show stale data from a previous visit.\n   * The problem is this bfcache-like behavior has no opt-out, even if the page is dynamic, requires authentication, etc.\n   * The workaround is to force a refresh when navigating via the browser controls.\n   * This should be removed if/when Next.js supports this natively.\n   */\n  useEffect(() => {\n    if (cachingEnabled) {\n      // Already refreshed on every pathname change below\n      return\n    }\n\n    previousPathnameRef.current = window.location.pathname\n\n    let refreshTimeout: ReturnType<typeof setTimeout> | undefined\n\n    const handlePopState = () => {\n      const currentPathname = window.location.pathname\n\n      // Fragment navigation also fires popstate. Refreshing the same route resets unsaved forms.\n      if (previousPathnameRef.current === currentPathname) {\n        return\n      }\n\n      previousPathnameRef.current = currentPathname\n\n      // Next.js restores the previous page in its own `popstate` listener. With `cacheComponents`,\n      // that happens synchronously and may run before or after this listener, so refreshing right\n      // away (or in a microtask) could refresh the page we are leaving. A timeout runs after all\n      // `popstate` listeners, once the restored page is the current route.\n      refreshTimeout = setTimeout(clearRouteCache, 0)\n    }\n\n    window.addEventListener('popstate', handlePopState)\n\n    return () => {\n      clearTimeout(refreshTimeout)\n      window.removeEventListener('popstate', handlePopState)\n    }\n  }, [cachingEnabled, clearRouteCache])\n\n  const handlePathnameChange = useEffectEvent(() => {\n    if (cachingEnabled) {\n      clearRouteCache()\n    }\n  })\n\n  useEffect(() => {\n    handlePathnameChange()\n\n    const currentPathname = window.location.pathname\n\n    // Next.js may commit the restored route before popstate runs. Keep the previous path until then.\n    const timeout = setTimeout(() => {\n      previousPathnameRef.current = currentPathname\n    }, 0)\n\n    return () => clearTimeout(timeout)\n  }, [pathname])\n\n  return <Context value={{ cachingEnabled, clearRouteCache }}>{children}</Context>\n}\n\nexport const useRouteCache = () => use(Context)\n"],"mappings":"AAAA;;AAAA,SAAAA,CAAA,IAAAC,EAAA;;AAEA,OAAOC,KAAA,IAASC,aAAa,EAAEC,GAAG,EAAEC,WAAW,EAAEC,SAAS,EAAEC,MAAM,QAAQ;AAE1E,SAASC,cAAc,QAAQ;AAC/B,SAASC,WAAW,EAAEC,SAAS,QAAQ;AAOvC,MAAMC,OAAA,gBAAUR,aAAA,CAAiC;EAC/CS,cAAA,EAAgB;EAChBC,eAAA,EAAiBA,CAAA,MAAO;AAC1B;AAEA,OAAO,MAAMC,UAAA,GAAgFC,EAAA;EAAA,MAAAC,CAAA,GAAAf,EAAA;EAAC;IAAAW,cAAA,EAAAK,EAAA;IAAAC;EAAA,IAAAH,EAG7F;EAFC,MAAAH,cAAA,GAAAK,EAAqB,KAArBE,SAAqB,GAArB,IAAqB,GAArBF,EAAqB;EAGrB,MAAAG,QAAA,GAAiBX,WAAA;EACjB,MAAAY,MAAA,GAAeX,SAAA;EACf,MAAAY,mBAAA,GAA4Bf,MAAA,CAAO;EAAA,IAAAgB,EAAA;EAAA,IAAAP,CAAA,QAAAK,MAAA;IAECE,EAAA,GAAAA,CAAA;MAClCF,MAAA,CAAAG,OAAc;IAAA,CAChB;IAAAR,CAAA,MAAAK,MAAA;IAAAL,CAAA,MAAAO,EAAA;EAAA;IAAAA,EAAA,GAAAP,CAAA;EAAA;EAFA,MAAAH,eAAA,GAAwBU,EAEb;EAAA,IAAAE,EAAA;EAAA,IAAAC,EAAA;EAAA,IAAAV,CAAA,QAAAJ,cAAA,IAAAI,CAAA,QAAAH,eAAA;IASDY,EAAA,GAAAA,CAAA;MACR,IAAIb,cAAA;QAAA;MAAA;MAKJU,mBAAA,CAAAK,OAAA,GAA8BC,MAAA,CAAAC,QAAe,CAAAT,QAAlB;MAEvBU,GAAA,CAAAA,cAAA;MAEJ,MAAAC,cAAA,GAAuBA,CAAA;QACrB,MAAAC,eAAA,GAAwBJ,MAAA,CAAAC,QAAe,CAAAT,QAAS;QAGhD,IAAIE,mBAAA,CAAAK,OAA2B,KAAKK,eAAA;UAAA;QAAA;QAIpCV,mBAAA,CAAAK,OAAA,GAA8BK,eAAH;QAM3BF,cAAA,CAAAA,CAAA,CAAiBG,UAAA,CAAWpB,eAAA,EAAiB;MAA7C,CACF;MAEAe,MAAA,CAAAM,gBAAuB,CAAC,YAAYH,cAAA;MAAA,OAE7B;QACLI,YAAA,CAAaL,cAAA;QACbF,MAAA,CAAAQ,mBAA0B,CAAC,YAAYL,cAAA;MAAA,CACzC;IAAA,CACF;IAAGL,EAAA,IAACd,cAAA,EAAgBC,eAAA,CAAgB;IAAAG,CAAA,MAAAJ,cAAA;IAAAI,CAAA,MAAAH,eAAA;IAAAG,CAAA,MAAAS,EAAA;IAAAT,CAAA,MAAAU,EAAA;EAAA;IAAAD,EAAA,GAAAT,CAAA;IAAAU,EAAA,GAAAV,CAAA;EAAA;EAjCpCV,SAAA,CAAUmB,EAiCV,EAAGC,EAAiC;EAAA,IAAAW,EAAA;EAAA,IAAArB,CAAA,QAAAJ,cAAA,IAAAI,CAAA,QAAAH,eAAA;IAEQwB,EAAA,GAAAA,CAAA;MAC1C,IAAIzB,cAAA;QACFC,eAAA;MAAA;IACF,CACF;IAAAG,CAAA,MAAAJ,cAAA;IAAAI,CAAA,MAAAH,eAAA;IAAAG,CAAA,MAAAqB,EAAA;EAAA;IAAAA,EAAA,GAAArB,CAAA;EAAA;EAJA,MAAAsB,oBAAA,GAA6B9B,cAAA,CAAe6B,EAI5C;EAAA,IAAAE,EAAA;EAAA,IAAAvB,CAAA,QAAAsB,oBAAA;IAEUC,EAAA,GAAAA,CAAA;MACRD,oBAAA;MAEA,MAAAE,iBAAA,GAAwBZ,MAAA,CAAAC,QAAe,CAAAT,QAAS;MAGhD,MAAAqB,OAAA,GAAgBR,UAAA,CAAW;QACzBX,mBAAA,CAAAK,OAAA,GAA8BK,iBAAH;MAAA,CAC7B,EAAG;MAAA,OAEI,MAAMG,YAAA,CAAaM,OAAA;IAAA,CAC5B;IAAAzB,CAAA,MAAAsB,oBAAA;IAAAtB,CAAA,OAAAuB,EAAA;EAAA;IAAAA,EAAA,GAAAvB,CAAA;EAAA;EAAA,IAAA0B,EAAA;EAAA,IAAA1B,CAAA,SAAAI,QAAA;IAAGsB,EAAA,IAACtB,QAAA,CAAS;IAAAJ,CAAA,OAAAI,QAAA;IAAAJ,CAAA,OAAA0B,EAAA;EAAA;IAAAA,EAAA,GAAA1B,CAAA;EAAA;EAXbV,SAAA,CAAUiC,EAWV,EAAGG,EAAU;EAAA,IAAAC,EAAA;EAAA,IAAA3B,CAAA,SAAAJ,cAAA,IAAAI,CAAA,SAAAE,QAAA,IAAAF,CAAA,SAAAH,eAAA;IAEN8B,EAAA,GAAAC,IAAA,CAACjC,OAAA;MAAAkC,KAAA,EAAe;QAAAjC,cAAA;QAAAC;MAAkC;MAAAK;;;;;;;;;SAAlDyB,E;CACT;AAEA,OAAO,MAAMG,aAAA,GAAgBA,CAAA,KAAM1C,GAAA,CAAIO,OAAA","ignoreList":[]}

package/dist/providers/RouteTransition/ProgressBar/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["c","_c","React","useEffect","useRef","useRouteTransition","transitionDuration","baseClass","initialDelay","ProgressBar","$","isTransitioning","transitionProgress","progressToShow","setProgressToShow","useState","shouldDelayProgress","t0","t1","clearTimerID","delayTimerID","current","_temp","clearTimeout","t2","t3","filter","Boolean","t4","join","t5","_jsx","className","style","children","width","currentProgress"],"sources":["../../../../src/providers/RouteTransition/ProgressBar/index.tsx"],"sourcesContent":["'use client'\nimport React, { useEffect, useRef } from 'react'\n\nimport { useRouteTransition } from '../index.js'\nimport './index.css'\n\nconst transitionDuration = 200\nconst baseClass = 'progress-bar'\nconst initialDelay = 150\n\n/**\n * Renders a progress bar that shows the progress of a route transition.\n * Place this at the root of your application, inside of the `RouteTransitionProvider`.\n * When a transition is triggered, the progress bar will show the progress of that transition and exit when the transition is complete.\n * @returns A progress bar that shows the progress of a route transition\n * @example\n * import { RouteTransitionProvider, ProgressBar, Link } from '@payloadcms/ui'\n * const App = () => (\n * <RouteTransitionProvider>\n *  <ProgressBar />\n *  <Link href=\"/somewhere\">Go Somewhere</Link>\n * </RouteTransitionProvider>\n */\nexport const ProgressBar = () => {\n  const { isTransitioning, transitionProgress } = useRouteTransition()\n  const [progressToShow, setProgressToShow] = React.useState<null | number>(null)\n  const shouldDelayProgress = useRef(true)\n\n  useEffect(() => {\n    let clearTimerID: NodeJS.Timeout\n    let delayTimerID: NodeJS.Timeout\n\n    if (isTransitioning) {\n      if (shouldDelayProgress.current) {\n        delayTimerID = setTimeout(() => {\n          setProgressToShow(transitionProgress)\n          shouldDelayProgress.current = false\n        }, initialDelay)\n      } else {\n        setProgressToShow(transitionProgress)\n      }\n    } else {\n      shouldDelayProgress.current = true\n\n      // Fast forward to 100% when the transition is complete\n      // Then fade out the progress bar directly after\n      setProgressToShow((currentProgress) => (currentProgress === null ? null : 1))\n\n      // Wait for CSS transition to finish before hiding the progress bar\n      // This includes both the fast-forward to 100% and the subsequent fade-out\n      clearTimerID = setTimeout(() => {\n        setProgressToShow(null)\n      }, transitionDuration * 2)\n    }\n\n    return () => {\n      clearTimeout(clearTimerID)\n      clearTimeout(delayTimerID)\n    }\n  }, [isTransitioning, transitionProgress])\n\n  if (typeof progressToShow === 'number') {\n    return (\n      <div\n        className={[baseClass, progressToShow === 1 && `${baseClass}--fade-out`]\n          .filter(Boolean)\n          .join(' ')}\n        style={{\n          // @ts-expect-error - TS doesn't like custom CSS properties\n          '--transition-duration': `${transitionDuration}ms`,\n        }}\n      >\n        <div\n          className={`${baseClass}__progress`}\n          style={{\n            width: `${(progressToShow || 0) * 100}%`,\n          }}\n        />\n      </div>\n    )\n  }\n\n  return null\n}\n"],"mappings":"AAAA;;AAAA,SAAAA,CAAA,IAAAC,EAAA;;AACA,OAAOC,KAAA,IAASC,SAAS,EAAEC,MAAM,QAAQ;AAEzC,SAASC,kBAAkB,QAAQ;AACnC,OAAO;AAEP,MAAMC,kBAAA,GAAqB;AAC3B,MAAMC,SAAA,GAAY;AAClB,MAAMC,YAAA,GAAe;AAErB;;;;;;;;;;;;;AAaA,OAAO,MAAMC,WAAA,GAAcA,CAAA;EAAA,MAAAC,CAAA,GAAAT,EAAA;EACzB;IAAAU,eAAA;IAAAC;EAAA,IAAgDP,kBAAA;EAChD,OAAAQ,cAAA,EAAAC,iBAAA,IAA4CZ,KAAA,CAAAa,QAAA,KAA8B;EAC1E,MAAAC,mBAAA,GAA4BZ,MAAA,KAAO;EAAA,IAAAa,EAAA;EAAA,IAAAC,EAAA;EAAA,IAAAR,CAAA,QAAAC,eAAA,IAAAD,CAAA,QAAAE,kBAAA;IAEzBK,EAAA,GAAAA,CAAA;MACJE,GAAA,CAAAA,YAAA;MACAC,GAAA,CAAAA,YAAA;MAAA,IAEAT,eAAA;QAAA,IACEK,mBAAA,CAAAK,OAAA;UACFD,YAAA,CAAAA,CAAA,CAAeA,aAAA,CAAAA,EAAA,CAAAA;YACbN,iBAAA,CAAkBF,kBAAA;YAClBI,mBAAA,CAAAK,OAAA;UAAA,GAAAb,YACC;QAHH;UAKAM,iBAAA,CAAkBF,kBAAA;QAAA;MAAA;QAGpBI,mBAAA,CAAAK,OAAA;QAIAP,iBAAA,CAAAQ,KAA0E;QAI1EH,YAAA,CAAAA,CAAA,CAAeA,aAAA,CAAAA,EAAA,CAAAA;UACbL,iBAAA,KAAkB;QAAA,GACjBR,kBAAA,IAAqB;MAFxB;MAAA;QAMAiB,YAAA,CAAaJ,YAAA;QACbI,YAAA,CAAaH,YAAA;MAAA;IAAA;IAEdF,EAAA,IAACP,eAAA,EAAiBC,kBAAA;IAAmBF,CAAA,MAAAC,eAAA;IAAAD,CAAA,MAAAE,kBAAA;IAAAF,CAAA,MAAAO,EAAA;IAAAP,CAAA,MAAAQ,EAAA;EAAA;IAAAD,EAAA,GAAAP,CAAA;IAAAQ,EAAA,GAAAR,CAAA;EAAA;EA/BxCP,SAAA,CAAUc,EA+BV,EAAGC,EAAqC;EAAA,IAEpC,OAAOL,cAAA,KAAmB;IAGD,MAAAW,EAAA,GAAAX,cAAA,MAAmB,IAAK,GAAAN,SAAA,YAAwB;IAAA,IAAAkB,EAAA;IAAA,IAAAf,CAAA,QAAAc,EAAA;MAA5DC,EAAA,IAAAlB,SAAA,EAAYiB,EAAgD,EAAAE,MAAA,CAAAC,OAC7D;MAAAjB,CAAA,MAAAc,EAAA;MAAAd,CAAA,MAAAe,EAAA;IAAA;MAAAA,EAAA,GAAAf,CAAA;IAAA;IADC,MAAAkB,EAAA,GAAAH,EACD,CAAAI,IAAA,CACF;IAAA,IAAAC,EAAA;IAAA,IAAApB,CAAA,QAAAG,cAAA,IAAAH,CAAA,QAAAkB,EAAA;MAHVE,EAAA,GAAAC,IAAA,CAAC;QAAAC,SAAA,EACYJ,EAEH;QAAAK,KAAA;UAAA,yBAGmB,GAAA3B,kBAAA;QAAyB;QAAA4B,QAAA,EAGpDH,IAAA,CAAC;UAAAC,SAAA,EACY,GAAAzB,SAAA,YAAwB;UAAA0B,KAAA;YAAAE,KAAA,EAE1B,GAAG,CAACtB,cAAA,KAAkB,OAAK;UAAM;QAAA,C;;;;;;;;WAZ9CiB,E;;;CAoBN;AA5D2B,SAAAR,MAAAc,eAAA;EAAA,OAuBmBA,eAAA,SAAoB,WAAc;AAAA","ignoreList":[]}
+{"version":3,"file":"index.js","names":["c","_c","React","useEffect","useRef","useRouteTransition","transitionDuration","baseClass","initialDelay","ProgressBar","$","isTransitioning","transitionProgress","progressToShow","setProgressToShow","useState","shouldDelayProgress","t0","t1","clearTimerID","delayTimerID","current","setTimeout","_temp","clearTimeout","t2","t3","filter","Boolean","t4","join","t5","_jsx","className","style","children","width","currentProgress"],"sources":["../../../../src/providers/RouteTransition/ProgressBar/index.tsx"],"sourcesContent":["'use client'\nimport React, { useEffect, useRef } from 'react'\n\nimport { useRouteTransition } from '../index.js'\nimport './index.css'\n\nconst transitionDuration = 200\nconst baseClass = 'progress-bar'\nconst initialDelay = 150\n\n/**\n * Renders a progress bar that shows the progress of a route transition.\n * Place this at the root of your application, inside of the `RouteTransitionProvider`.\n * When a transition is triggered, the progress bar will show the progress of that transition and exit when the transition is complete.\n * @returns A progress bar that shows the progress of a route transition\n * @example\n * import { RouteTransitionProvider, ProgressBar, Link } from '@payloadcms/ui'\n * const App = () => (\n * <RouteTransitionProvider>\n *  <ProgressBar />\n *  <Link href=\"/somewhere\">Go Somewhere</Link>\n * </RouteTransitionProvider>\n */\nexport const ProgressBar = () => {\n  const { isTransitioning, transitionProgress } = useRouteTransition()\n  const [progressToShow, setProgressToShow] = React.useState<null | number>(null)\n  const shouldDelayProgress = useRef(true)\n\n  useEffect(() => {\n    let clearTimerID: NodeJS.Timeout\n    let delayTimerID: NodeJS.Timeout\n\n    if (isTransitioning) {\n      if (shouldDelayProgress.current) {\n        delayTimerID = setTimeout(() => {\n          setProgressToShow(transitionProgress)\n          shouldDelayProgress.current = false\n        }, initialDelay)\n      } else {\n        setProgressToShow(transitionProgress)\n      }\n    } else {\n      shouldDelayProgress.current = true\n\n      // Fast forward to 100% when the transition is complete\n      // Then fade out the progress bar directly after\n      setProgressToShow((currentProgress) => (currentProgress === null ? null : 1))\n\n      // Wait for CSS transition to finish before hiding the progress bar\n      // This includes both the fast-forward to 100% and the subsequent fade-out\n      clearTimerID = setTimeout(() => {\n        setProgressToShow(null)\n      }, transitionDuration * 2)\n    }\n\n    return () => {\n      clearTimeout(clearTimerID)\n      clearTimeout(delayTimerID)\n    }\n  }, [isTransitioning, transitionProgress])\n\n  if (typeof progressToShow === 'number') {\n    return (\n      <div\n        className={[baseClass, progressToShow === 1 && `${baseClass}--fade-out`]\n          .filter(Boolean)\n          .join(' ')}\n        style={{\n          // @ts-expect-error - TS doesn't like custom CSS properties\n          '--transition-duration': `${transitionDuration}ms`,\n        }}\n      >\n        <div\n          className={`${baseClass}__progress`}\n          style={{\n            width: `${(progressToShow || 0) * 100}%`,\n          }}\n        />\n      </div>\n    )\n  }\n\n  return null\n}\n"],"mappings":"AAAA;;AAAA,SAAAA,CAAA,IAAAC,EAAA;;AACA,OAAOC,KAAA,IAASC,SAAS,EAAEC,MAAM,QAAQ;AAEzC,SAASC,kBAAkB,QAAQ;AACnC,OAAO;AAEP,MAAMC,kBAAA,GAAqB;AAC3B,MAAMC,SAAA,GAAY;AAClB,MAAMC,YAAA,GAAe;AAErB;;;;;;;;;;;;;AAaA,OAAO,MAAMC,WAAA,GAAcA,CAAA;EAAA,MAAAC,CAAA,GAAAT,EAAA;EACzB;IAAAU,eAAA;IAAAC;EAAA,IAAgDP,kBAAA;EAChD,OAAAQ,cAAA,EAAAC,iBAAA,IAA4CZ,KAAA,CAAAa,QAAc,CAAgB;EAC1E,MAAAC,mBAAA,GAA4BZ,MAAA,CAAO;EAAA,IAAAa,EAAA;EAAA,IAAAC,EAAA;EAAA,IAAAR,CAAA,QAAAC,eAAA,IAAAD,CAAA,QAAAE,kBAAA;IAEzBK,EAAA,GAAAA,CAAA;MACJE,GAAA,CAAAA,YAAA;MACAC,GAAA,CAAAA,YAAA;MAEJ,IAAIT,eAAA;QACF,IAAIK,mBAAA,CAAAK,OAA2B;UAC7BD,YAAA,CAAAA,CAAA,CAAeE,UAAA,CAAW;YACxBR,iBAAA,CAAkBF,kBAAA;YAClBI,mBAAA,CAAAK,OAAA,GAA8B,KAAH;UAAA,CAC7B,EAAGb,YAAA;QAHH;UAKAM,iBAAA,CAAkBF,kBAAA;QAAA;MACpB;QAEAI,mBAAA,CAAAK,OAAA,GAA8B,IAAH;QAI3BP,iBAAA,CAAkBS,KAAwD;QAI1EJ,YAAA,CAAAA,CAAA,CAAeG,UAAA,CAAW;UACxBR,iBAAA,CAAkB;QAAA,CACpB,EAAGR,kBAAA,GAAqB;MAFxB;MAGF,OAEO;QACLkB,YAAA,CAAaL,YAAA;QACbK,YAAA,CAAaJ,YAAA;MAAA,CACf;IAAA,CACF;IAAGF,EAAA,IAACP,eAAA,EAAiBC,kBAAA,CAAmB;IAAAF,CAAA,MAAAC,eAAA;IAAAD,CAAA,MAAAE,kBAAA;IAAAF,CAAA,MAAAO,EAAA;IAAAP,CAAA,MAAAQ,EAAA;EAAA;IAAAD,EAAA,GAAAP,CAAA;IAAAQ,EAAA,GAAAR,CAAA;EAAA;EA/BxCP,SAAA,CAAUc,EA+BV,EAAGC,EAAqC;EAExC,IAAI,OAAOL,cAAA,KAAmB;IAGD,MAAAY,EAAA,GAAAZ,cAAA,KAAmB,CAA6B,IAAhD,GAA2BN,SAAA,YAAqB;IAAA,IAAAmB,EAAA;IAAA,IAAAhB,CAAA,QAAAe,EAAA;MAA5DC,EAAA,IAACnB,SAAA,EAAWkB,EAAgD,CAAC,CAAAE,MAC/D,CAACC,OAAA;MAAAlB,CAAA,MAAAe,EAAA;MAAAf,CAAA,MAAAgB,EAAA;IAAA;MAAAA,EAAA,GAAAhB,CAAA;IAAA;IADC,MAAAmB,EAAA,GAAAH,EACD,CAAAI,IACH,CAAC;IAAA,IAAAC,EAAA;IAAA,IAAArB,CAAA,QAAAG,cAAA,IAAAH,CAAA,QAAAmB,EAAA;MAHVE,EAAA,GAAAC,IAAA,CAAC;QAAAC,SAAA,EACYJ,EAEH;QAAAK,KAAA,EACD;UAAA,yBAEoB,GAAG5B,kBAAA;QAC9B;QAAA6B,QAAA,EAEAH,IAAA,CAAC;UAAAC,SAAA,EACY,GAAG1B,SAAA,YAAqB;UAAA2B,KAAA,EAC5B;YAAAE,KAAA,EACE,GAAG,CAACvB,cAAkB,IAAlB,CAAkB,IAAK;UACpC;;;;;;;;;WAbJkB,E;;EAiBJ,OAEO;AAAA,CACT;AA5D2B,SAAAR,MAAAc,eAAA;EAAA,OAuBmBA,eAAA,KAAoB,IAAc,GAAlC,IAAkC,GAAlC,CAAkC;AAAA","ignoreList":[]}

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

@@ -19,11 +19,12 @@ export declare const RouteTransitionProvider: React.FC<RouteTransitionProps>;
 type RouteTransitionProps = {
     children: React.ReactNode;
 };
-type StartRouteTransition = (callback?: () => void) => void;
+type StartRouteTransition = (callback?: () => unknown) => Promise<void>;
 type RouteTransitionContextValue = {
     /** Keeps the transition active until the returned release function is called. */
     holdRouteTransition: () => () => void;
     isTransitioning: boolean;
+    /** Resolves after the callback and active route transition holds complete. */
     startRouteTransition: StartRouteTransition;
     transitionProgress: number;
 };
@@ -41,7 +42,7 @@ type RouteTransitionContextValue = {
  *   const { startRouteTransition } = useRouteTransition()
  *
  *   const redirectSomewhere = useCallback(() => {
- *     startRouteTransition(() => router.push('/somewhere'))
+ *     void startRouteTransition(() => router.push('/somewhere'))
  *   }, [startRouteTransition, router])
  *
  *   // ...

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/RouteTransition/index.tsx"],"names":[],"mappings":"AACA,OAAO,KAAyE,MAAM,OAAO,CAAA;AAE7F;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,uBAAuB,EAAE,KAAK,CAAC,EAAE,CAAC,oBAAoB,CAqFlE,CAAA;AAED,KAAK,oBAAoB,GAAG;IAC1B,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC1B,CAAA;AAED,KAAK,oBAAoB,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,IAAI,KAAK,IAAI,CAAA;AAE3D,KAAK,2BAA2B,GAAG;IACjC,iFAAiF;IACjF,mBAAmB,EAAE,MAAM,MAAM,IAAI,CAAA;IACrC,eAAe,EAAE,OAAO,CAAA;IACxB,oBAAoB,EAAE,oBAAoB,CAAA;IAC1C,kBAAkB,EAAE,MAAM,CAAA;CAC3B,CAAA;AAcD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,kBAAkB,mCAA0C,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/RouteTransition/index.tsx"],"names":[],"mappings":"AACA,OAAO,KAAyE,MAAM,OAAO,CAAA;AAE7F;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,uBAAuB,EAAE,KAAK,CAAC,EAAE,CAAC,oBAAoB,CA4GlE,CAAA;AAED,KAAK,oBAAoB,GAAG;IAC1B,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC1B,CAAA;AAED,KAAK,oBAAoB,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;AAEvE,KAAK,2BAA2B,GAAG;IACjC,iFAAiF;IACjF,mBAAmB,EAAE,MAAM,MAAM,IAAI,CAAA;IACrC,eAAe,EAAE,OAAO,CAAA;IACxB,8EAA8E;IAC9E,oBAAoB,EAAE,oBAAoB,CAAA;IAC1C,kBAAkB,EAAE,MAAM,CAAA;CAC3B,CAAA;AAYD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,kBAAkB,mCAA0C,CAAA"}