@payloadcms/ui 4.0.0-internal.b6f3b9a → 4.0.0-internal.b8e7c89

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["DndContext","React","useCallback","useEffect","useId","useMemo","useRef","useState","usePopupWindow","useDocumentInfo","usePreferences","formatAbsoluteURL","customCollisionDetection","LivePreviewContext","sizeReducer","LivePreviewProvider","breakpoints","incomingBreakpoints","children","isLivePreviewEnabled","isLivePreviewing","incomingIsLivePreviewing","isPreviewEnabled","previewURL","previewURLFromProps","typeofLivePreviewURL","url","urlFromProps","_setIsLivePreviewing","shouldRenderIframe","setShouldRenderIframe","setIsLivePreviewing","livePreviewing","name","height","label","width","setURL","setPreviewURL","isPopupOpen","openPopupWindow","popupRef","eventType","appIsReady","setAppIsReady","lastReadyAt","setLastReadyAt","collectionSlug","globalSlug","isFirstRender","setPreference","iframeRef","isExpanded","setIsExpanded","loadedURL","setLoadedURL","zoom","setZoom","position","setPosition","x","y","size","setSize","useReducer","measuredDeviceSize","setMeasuredDeviceSize","breakpoint","setBreakpoint","setLivePreviewURL","_incomingURL","incomingURL","handleDragEnd","ev","over","id","newPos","delta","setWidth","type","value","setHeight","foundBreakpoint","find","bp","handleMessage","event","startsWith","origin","data","ready","Date","now","window","addEventListener","removeEventListener","current","editViewType","dndContextID","_jsx","setToolbarPosition","toolbarPosition","collisionDetection","onDragEnd"],"sources":["../../../src/providers/LivePreview/index.tsx"],"sourcesContent":["'use client'\nimport type { CollectionPreferences, LivePreviewConfig, LivePreviewURLType } from 'payload'\n\nimport { DndContext } from '@dnd-kit/core'\nimport React, { useCallback, useEffect, useId, useMemo, useRef, useState } from 'react'\n\nimport type { LivePreviewContextType } from './context.js'\n\nimport { usePopupWindow } from '../../hooks/usePopupWindow.js'\nimport { useDocumentInfo } from '../../providers/DocumentInfo/index.js'\nimport { usePreferences } from '../../providers/Preferences/index.js'\nimport { formatAbsoluteURL } from '../../utilities/formatAbsoluteURL.js'\nimport { customCollisionDetection } from './collisionDetection.js'\nimport { LivePreviewContext } from './context.js'\nimport { sizeReducer } from './sizeReducer.js'\n\nexport type LivePreviewProviderProps = {\n  appIsReady?: boolean\n  breakpoints?: LivePreviewConfig['breakpoints']\n  children: React.ReactNode\n  deviceSize?: {\n    height: number\n    width: number\n  }\n  isLivePreviewEnabled?: boolean\n  isLivePreviewing: boolean\n  /**\n   * This specifically relates to `admin.preview` function in the config instead of live preview.\n   */\n  isPreviewEnabled?: boolean\n  /**\n   * This specifically relates to `admin.preview` function in the config instead of live preview.\n   */\n  previewURL?: string\n} & Pick<LivePreviewContextType, 'typeofLivePreviewURL' | 'url'>\n\nexport const LivePreviewProvider: React.FC<LivePreviewProviderProps> = ({\n  breakpoints: incomingBreakpoints,\n  children,\n  isLivePreviewEnabled,\n  isLivePreviewing: incomingIsLivePreviewing,\n  isPreviewEnabled,\n  previewURL: previewURLFromProps,\n  typeofLivePreviewURL,\n  url: urlFromProps,\n}) => {\n  const [isLivePreviewing, _setIsLivePreviewing] =\n    useState<LivePreviewContextType['isLivePreviewing']>(incomingIsLivePreviewing)\n\n  const [shouldRenderIframe, setShouldRenderIframe] =\n    useState<LivePreviewContextType['shouldRenderIframe']>(isLivePreviewing)\n\n  /**\n   * Rendering the iframe is a one-way event, e.g. defer load and never unmount.\n   * This way, subsequent toggles will appear to load instantly.\n   */\n  const setIsLivePreviewing = useCallback<LivePreviewContextType['setIsLivePreviewing']>(\n    (livePreviewing) => {\n      if (livePreviewing) {\n        setShouldRenderIframe(true)\n      }\n\n      _setIsLivePreviewing(livePreviewing)\n    },\n    [],\n  )\n\n  const breakpoints: LivePreviewConfig['breakpoints'] = useMemo(\n    () => [\n      ...(incomingBreakpoints || []),\n      {\n        name: 'responsive',\n        height: '100%',\n        label: 'Responsive',\n        width: '100%',\n      },\n    ],\n    [incomingBreakpoints],\n  )\n\n  const [url, setURL] = useState<string>('')\n  const [previewURL, setPreviewURL] = useState<string>(previewURLFromProps)\n\n  const { isPopupOpen, openPopupWindow, popupRef } = usePopupWindow({\n    eventType: 'payload-live-preview',\n    url,\n  })\n\n  const [appIsReady, setAppIsReady] = useState(false)\n  // Tracks when any preview (iframe or popup) signals it's ready\n  // Used to trigger an initial sync to newly opened previews\n  const [lastReadyAt, setLastReadyAt] = useState<number>(0)\n\n  const { collectionSlug, globalSlug } = useDocumentInfo()\n\n  const isFirstRender = useRef(true)\n\n  const { setPreference } = usePreferences()\n\n  const iframeRef = React.useRef<HTMLIFrameElement>(null)\n\n  const [isExpanded, setIsExpanded] = useState(false)\n\n  const [loadedURL, setLoadedURL] = useState<string>()\n\n  const [zoom, setZoom] = useState(1)\n\n  const [position, setPosition] = useState({ x: 0, y: 0 })\n\n  const [size, setSize] = React.useReducer(sizeReducer, { height: 0, width: 0 })\n\n  const [measuredDeviceSize, setMeasuredDeviceSize] = useState({\n    height: 0,\n    width: 0,\n  })\n\n  const [breakpoint, setBreakpoint] =\n    React.useState<LivePreviewConfig['breakpoints'][0]['name']>('responsive')\n\n  /**\n   * A \"middleware\" callback fn that does some additional work before `setURL`.\n   * This is what we provide through context, bc it:\n   *  - ensures the URL is absolute\n   *  - resets `appIsReady` to `false` while the new URL is loading\n   */\n  const setLivePreviewURL = useCallback<LivePreviewContextType['setURL']>(\n    (_incomingURL) => {\n      let incomingURL: LivePreviewURLType\n\n      if (typeof _incomingURL === 'string') {\n        incomingURL = formatAbsoluteURL(_incomingURL)\n      }\n\n      if (!incomingURL) {\n        setIsLivePreviewing(false)\n      }\n\n      if (incomingURL !== url) {\n        setAppIsReady(false)\n        setURL(incomingURL)\n      }\n    },\n    [setIsLivePreviewing, url],\n  )\n\n  /**\n   * `url` needs to be relative to the window, which cannot be done on initial render.\n   */\n  useEffect(() => {\n    if (typeof urlFromProps === 'string') {\n      setURL(formatAbsoluteURL(urlFromProps))\n    }\n  }, [urlFromProps])\n\n  // The toolbar needs to freely drag and drop around the page\n  const handleDragEnd = (ev) => {\n    // only update position if the toolbar is completely within the preview area\n    // otherwise reset it back to the previous position\n    // TODO: reset to the nearest edge of the preview area\n    if (ev.over && ev.over.id === 'live-preview-area') {\n      const newPos = {\n        x: position.x + ev.delta.x,\n        y: position.y + ev.delta.y,\n      }\n\n      setPosition(newPos)\n    } else {\n      // reset\n    }\n  }\n\n  const setWidth = useCallback(\n    (width) => {\n      setSize({ type: 'width', value: width })\n    },\n    [setSize],\n  )\n\n  const setHeight = useCallback(\n    (height) => {\n      setSize({ type: 'height', value: height })\n    },\n    [setSize],\n  )\n\n  // explicitly set new width and height when as new breakpoints are selected\n  // exclude `custom` breakpoint as it is handled by the `setWidth` and `setHeight` directly\n  useEffect(() => {\n    const foundBreakpoint = breakpoints?.find((bp) => bp.name === breakpoint)\n\n    if (\n      foundBreakpoint &&\n      breakpoint !== 'responsive' &&\n      breakpoint !== 'custom' &&\n      typeof foundBreakpoint?.width === 'number' &&\n      typeof foundBreakpoint?.height === 'number'\n    ) {\n      setSize({\n        type: 'reset',\n        value: {\n          height: foundBreakpoint.height,\n          width: foundBreakpoint.width,\n        },\n      })\n    }\n  }, [breakpoint, breakpoints])\n\n  /**\n   * Receive the `ready` message from the popup window\n   * This indicates that the app is ready to receive `window.postMessage` events\n   * This is also the only cross-origin way of detecting when a popup window has loaded\n   * Unlike iframe elements which have an `onLoad` handler, there is no way to access `window.open` on popups\n   */\n  useEffect(() => {\n    const handleMessage = (event: MessageEvent) => {\n      if (\n        url?.startsWith(event.origin) &&\n        event.data &&\n        typeof event.data === 'object' &&\n        event.data.type === 'payload-live-preview'\n      ) {\n        if (event.data.ready) {\n          setAppIsReady(true)\n          setLastReadyAt(Date.now())\n        }\n      }\n    }\n\n    window.addEventListener('message', handleMessage)\n\n    return () => {\n      window.removeEventListener('message', handleMessage)\n    }\n  }, [url])\n\n  useEffect(() => {\n    if (isFirstRender.current) {\n      isFirstRender.current = false\n      return\n    }\n\n    void setPreference<CollectionPreferences>(\n      collectionSlug ? `collection-${collectionSlug}` : `global-${globalSlug}`,\n      {\n        editViewType: isLivePreviewing ? 'live-preview' : 'default',\n      },\n      true,\n    )\n  }, [isLivePreviewing, setPreference, collectionSlug, globalSlug])\n\n  const dndContextID = useId()\n\n  return (\n    <LivePreviewContext\n      value={{\n        appIsReady,\n        breakpoint,\n        breakpoints,\n        iframeRef,\n        isExpanded,\n        isLivePreviewEnabled,\n        isLivePreviewing,\n        isPopupOpen,\n        isPreviewEnabled,\n        lastReadyAt,\n        loadedURL,\n        measuredDeviceSize,\n        openPopupWindow,\n        popupRef,\n        previewURL,\n        setBreakpoint,\n        setHeight,\n        setIsExpanded,\n        setIsLivePreviewing,\n        setLoadedURL,\n        setMeasuredDeviceSize,\n        setPreviewURL,\n        setSize,\n        setToolbarPosition: setPosition,\n        setURL: setLivePreviewURL,\n        setWidth,\n        setZoom,\n        shouldRenderIframe,\n        size,\n        toolbarPosition: position,\n        typeofLivePreviewURL,\n        url,\n        zoom,\n      }}\n    >\n      <DndContext\n        collisionDetection={customCollisionDetection}\n        // Provide stable ID to fix hydration issues: https://github.com/clauderic/dnd-kit/issues/926\n        id={dndContextID}\n        onDragEnd={handleDragEnd}\n      >\n        {children}\n      </DndContext>\n    </LivePreviewContext>\n  )\n}\n"],"mappings":"AAAA;;;AAGA,SAASA,UAAU,QAAQ;AAC3B,OAAOC,KAAA,IAASC,WAAW,EAAEC,SAAS,EAAEC,KAAK,EAAEC,OAAO,EAAEC,MAAM,EAAEC,QAAQ,QAAQ;AAIhF,SAASC,cAAc,QAAQ;AAC/B,SAASC,eAAe,QAAQ;AAChC,SAASC,cAAc,QAAQ;AAC/B,SAASC,iBAAiB,QAAQ;AAClC,SAASC,wBAAwB,QAAQ;AACzC,SAASC,kBAAkB,QAAQ;AACnC,SAASC,WAAW,QAAQ;AAsB5B,OAAO,MAAMC,mBAAA,GAA0DA,CAAC;EACtEC,WAAA,EAAaC,mBAAmB;EAChCC,QAAQ;EACRC,oBAAoB;EACpBC,gBAAA,EAAkBC,wBAAwB;EAC1CC,gBAAgB;EAChBC,UAAA,EAAYC,mBAAmB;EAC/BC,oBAAoB;EACpBC,GAAA,EAAKC;AAAY,CAClB;EACC,MAAM,CAACP,gBAAA,EAAkBQ,oBAAA,CAAqB,GAC5CrB,QAAA,CAAqDc,wBAAA;EAEvD,MAAM,CAACQ,kBAAA,EAAoBC,qBAAA,CAAsB,GAC/CvB,QAAA,CAAuDa,gBAAA;EAEzD;;;;EAIA,MAAMW,mBAAA,GAAsB7B,WAAA,CACzB8B,cAAA;IACC,IAAIA,cAAA,EAAgB;MAClBF,qBAAA,CAAsB;IACxB;IAEAF,oBAAA,CAAqBI,cAAA;EACvB,GACA,EAAE;EAGJ,MAAMhB,WAAA,GAAgDX,OAAA,CACpD,MAAM,C,IACAY,mBAAA,IAAuB,EAAE,GAC7B;IACEgB,IAAA,EAAM;IACNC,MAAA,EAAQ;IACRC,KAAA,EAAO;IACPC,KAAA,EAAO;EACT,EACD,EACD,CAACnB,mBAAA,CAAoB;EAGvB,MAAM,CAACS,GAAA,EAAKW,MAAA,CAAO,GAAG9B,QAAA,CAAiB;EACvC,MAAM,CAACgB,UAAA,EAAYe,aAAA,CAAc,GAAG/B,QAAA,CAAiBiB,mBAAA;EAErD,MAAM;IAAEe,WAAW;IAAEC,eAAe;IAAEC;EAAQ,CAAE,GAAGjC,cAAA,CAAe;IAChEkC,SAAA,EAAW;IACXhB;EACF;EAEA,MAAM,CAACiB,UAAA,EAAYC,aAAA,CAAc,GAAGrC,QAAA,CAAS;EAC7C;EACA;EACA,MAAM,CAACsC,WAAA,EAAaC,cAAA,CAAe,GAAGvC,QAAA,CAAiB;EAEvD,MAAM;IAAEwC,cAAc;IAAEC;EAAU,CAAE,GAAGvC,eAAA;EAEvC,MAAMwC,aAAA,GAAgB3C,MAAA,CAAO;EAE7B,MAAM;IAAE4C;EAAa,CAAE,GAAGxC,cAAA;EAE1B,MAAMyC,SAAA,GAAYlD,KAAA,CAAMK,MAAM,CAAoB;EAElD,MAAM,CAAC8C,UAAA,EAAYC,aAAA,CAAc,GAAG9C,QAAA,CAAS;EAE7C,MAAM,CAAC+C,SAAA,EAAWC,YAAA,CAAa,GAAGhD,QAAA;EAElC,MAAM,CAACiD,IAAA,EAAMC,OAAA,CAAQ,GAAGlD,QAAA,CAAS;EAEjC,MAAM,CAACmD,QAAA,EAAUC,WAAA,CAAY,GAAGpD,QAAA,CAAS;IAAEqD,CAAA,EAAG;IAAGC,CAAA,EAAG;EAAE;EAEtD,MAAM,CAACC,IAAA,EAAMC,OAAA,CAAQ,GAAG9D,KAAA,CAAM+D,UAAU,CAAClD,WAAA,EAAa;IAAEoB,MAAA,EAAQ;IAAGE,KAAA,EAAO;EAAE;EAE5E,MAAM,CAAC6B,kBAAA,EAAoBC,qBAAA,CAAsB,GAAG3D,QAAA,CAAS;IAC3D2B,MAAA,EAAQ;IACRE,KAAA,EAAO;EACT;EAEA,MAAM,CAAC+B,UAAA,EAAYC,aAAA,CAAc,GAC/BnE,KAAA,CAAMM,QAAQ,CAA8C;EAE9D;;;;;;EAMA,MAAM8D,iBAAA,GAAoBnE,WAAA,CACvBoE,YAAA;IACC,IAAIC,WAAA;IAEJ,IAAI,OAAOD,YAAA,KAAiB,UAAU;MACpCC,WAAA,GAAc5D,iBAAA,CAAkB2D,YAAA;IAClC;IAEA,IAAI,CAACC,WAAA,EAAa;MAChBxC,mBAAA,CAAoB;IACtB;IAEA,IAAIwC,WAAA,KAAgB7C,GAAA,EAAK;MACvBkB,aAAA,CAAc;MACdP,MAAA,CAAOkC,WAAA;IACT;EACF,GACA,CAACxC,mBAAA,EAAqBL,GAAA,CAAI;EAG5B;;;EAGAvB,SAAA,CAAU;IACR,IAAI,OAAOwB,YAAA,KAAiB,UAAU;MACpCU,MAAA,CAAO1B,iBAAA,CAAkBgB,YAAA;IAC3B;EACF,GAAG,CAACA,YAAA,CAAa;EAEjB;EACA,MAAM6C,aAAA,GAAiBC,EAAA;IACrB;IACA;IACA;IACA,IAAIA,EAAA,CAAGC,IAAI,IAAID,EAAA,CAAGC,IAAI,CAACC,EAAE,KAAK,qBAAqB;MACjD,MAAMC,MAAA,GAAS;QACbhB,CAAA,EAAGF,QAAA,CAASE,CAAC,GAAGa,EAAA,CAAGI,KAAK,CAACjB,CAAC;QAC1BC,CAAA,EAAGH,QAAA,CAASG,CAAC,GAAGY,EAAA,CAAGI,KAAK,CAAChB;MAC3B;MAEAF,WAAA,CAAYiB,MAAA;IACd,OAAO;MACL;IAAA;EAEJ;EAEA,MAAME,QAAA,GAAW5E,WAAA,CACdkC,KAAA;IACC2B,OAAA,CAAQ;MAAEgB,IAAA,EAAM;MAASC,KAAA,EAAO5C;IAAM;EACxC,GACA,CAAC2B,OAAA,CAAQ;EAGX,MAAMkB,SAAA,GAAY/E,WAAA,CACfgC,MAAA;IACC6B,OAAA,CAAQ;MAAEgB,IAAA,EAAM;MAAUC,KAAA,EAAO9C;IAAO;EAC1C,GACA,CAAC6B,OAAA,CAAQ;EAGX;EACA;EACA5D,SAAA,CAAU;IACR,MAAM+E,eAAA,GAAkBlE,WAAA,EAAamE,IAAA,CAAMC,EAAA,IAAOA,EAAA,CAAGnD,IAAI,KAAKkC,UAAA;IAE9D,IACEe,eAAA,IACAf,UAAA,KAAe,gBACfA,UAAA,KAAe,YACf,OAAOe,eAAA,EAAiB9C,KAAA,KAAU,YAClC,OAAO8C,eAAA,EAAiBhD,MAAA,KAAW,UACnC;MACA6B,OAAA,CAAQ;QACNgB,IAAA,EAAM;QACNC,KAAA,EAAO;UACL9C,MAAA,EAAQgD,eAAA,CAAgBhD,MAAM;UAC9BE,KAAA,EAAO8C,eAAA,CAAgB9C;QACzB;MACF;IACF;EACF,GAAG,CAAC+B,UAAA,EAAYnD,WAAA,CAAY;EAE5B;;;;;;EAMAb,SAAA,CAAU;IACR,MAAMkF,aAAA,GAAiBC,KAAA;MACrB,IACE5D,GAAA,EAAK6D,UAAA,CAAWD,KAAA,CAAME,MAAM,KAC5BF,KAAA,CAAMG,IAAI,IACV,OAAOH,KAAA,CAAMG,IAAI,KAAK,YACtBH,KAAA,CAAMG,IAAI,CAACV,IAAI,KAAK,wBACpB;QACA,IAAIO,KAAA,CAAMG,IAAI,CAACC,KAAK,EAAE;UACpB9C,aAAA,CAAc;UACdE,cAAA,CAAe6C,IAAA,CAAKC,GAAG;QACzB;MACF;IACF;IAEAC,MAAA,CAAOC,gBAAgB,CAAC,WAAWT,aAAA;IAEnC,OAAO;MACLQ,MAAA,CAAOE,mBAAmB,CAAC,WAAWV,aAAA;IACxC;EACF,GAAG,CAAC3D,GAAA,CAAI;EAERvB,SAAA,CAAU;IACR,IAAI8C,aAAA,CAAc+C,OAAO,EAAE;MACzB/C,aAAA,CAAc+C,OAAO,GAAG;MACxB;IACF;IAEA,KAAK9C,aAAA,CACHH,cAAA,GAAiB,cAAcA,cAAA,EAAgB,GAAG,UAAUC,UAAA,EAAY,EACxE;MACEiD,YAAA,EAAc7E,gBAAA,GAAmB,iBAAiB;IACpD,GACA;EAEJ,GAAG,CAACA,gBAAA,EAAkB8B,aAAA,EAAeH,cAAA,EAAgBC,UAAA,CAAW;EAEhE,MAAMkD,YAAA,GAAe9F,KAAA;EAErB,oBACE+F,IAAA,CAACtF,kBAAA;IACCmE,KAAA,EAAO;MACLrC,UAAA;MACAwB,UAAA;MACAnD,WAAA;MACAmC,SAAA;MACAC,UAAA;MACAjC,oBAAA;MACAC,gBAAA;MACAmB,WAAA;MACAjB,gBAAA;MACAuB,WAAA;MACAS,SAAA;MACAW,kBAAA;MACAzB,eAAA;MACAC,QAAA;MACAlB,UAAA;MACA6C,aAAA;MACAa,SAAA;MACA5B,aAAA;MACAtB,mBAAA;MACAwB,YAAA;MACAW,qBAAA;MACA5B,aAAA;MACAyB,OAAA;MACAqC,kBAAA,EAAoBzC,WAAA;MACpBtB,MAAA,EAAQgC,iBAAA;MACRS,QAAA;MACArB,OAAA;MACA5B,kBAAA;MACAiC,IAAA;MACAuC,eAAA,EAAiB3C,QAAA;MACjBjC,oBAAA;MACAC,GAAA;MACA8B;IACF;cAEA,aAAA2C,IAAA,CAACnG,UAAA;MACCsG,kBAAA,EAAoB1F,wBAAA;MACpB;MACA+D,EAAA,EAAIuB,YAAA;MACJK,SAAA,EAAW/B,aAAA;gBAEVtD;;;AAIT","ignoreList":[]}
+{"version":3,"file":"index.js","names":["DndContext","React","useCallback","useEffect","useId","useMemo","useRef","useState","usePopupWindow","useDocumentInfo","usePreferences","formatAbsoluteURL","isHttpURL","customCollisionDetection","LivePreviewContext","sizeReducer","LivePreviewProvider","breakpoints","incomingBreakpoints","children","isLivePreviewEnabled","isLivePreviewing","incomingIsLivePreviewing","isPreviewEnabled","previewURL","previewURLFromProps","typeofLivePreviewURL","url","urlFromProps","_setIsLivePreviewing","shouldRenderIframe","setShouldRenderIframe","setIsLivePreviewing","livePreviewing","name","height","label","width","setURL","_setPreviewURL","setPreviewURL","incomingURL","undefined","isPopupOpen","openPopupWindow","popupRef","eventType","appIsReady","setAppIsReady","lastReadyAt","setLastReadyAt","collectionSlug","globalSlug","isFirstRender","setPreference","iframeRef","isExpanded","setIsExpanded","loadedURL","setLoadedURL","zoom","setZoom","position","setPosition","x","y","size","setSize","useReducer","measuredDeviceSize","setMeasuredDeviceSize","breakpoint","setBreakpoint","setLivePreviewURL","_incomingURL","handleDragEnd","ev","over","id","newPos","delta","setWidth","type","value","setHeight","foundBreakpoint","find","bp","handleMessage","event","startsWith","origin","data","ready","Date","now","window","addEventListener","removeEventListener","current","editViewType","dndContextID","_jsx","setToolbarPosition","toolbarPosition","collisionDetection","onDragEnd"],"sources":["../../../src/providers/LivePreview/index.tsx"],"sourcesContent":["'use client'\nimport type { CollectionPreferences, LivePreviewConfig, LivePreviewURLType } from 'payload'\n\nimport { DndContext } from '@dnd-kit/core'\nimport React, { useCallback, useEffect, useId, useMemo, useRef, useState } from 'react'\n\nimport type { LivePreviewContextType } from './context.js'\n\nimport { usePopupWindow } from '../../hooks/usePopupWindow.js'\nimport { useDocumentInfo } from '../../providers/DocumentInfo/index.js'\nimport { usePreferences } from '../../providers/Preferences/index.js'\nimport { formatAbsoluteURL } from '../../utilities/formatAbsoluteURL.js'\nimport { isHttpURL } from '../../utilities/isHttpURL.js'\nimport { customCollisionDetection } from './collisionDetection.js'\nimport { LivePreviewContext } from './context.js'\nimport { sizeReducer } from './sizeReducer.js'\n\nexport type LivePreviewProviderProps = {\n  appIsReady?: boolean\n  breakpoints?: LivePreviewConfig['breakpoints']\n  children: React.ReactNode\n  deviceSize?: {\n    height: number\n    width: number\n  }\n  isLivePreviewEnabled?: boolean\n  isLivePreviewing: boolean\n  /**\n   * This specifically relates to `admin.preview` function in the config instead of live preview.\n   */\n  isPreviewEnabled?: boolean\n  /**\n   * This specifically relates to `admin.preview` function in the config instead of live preview.\n   */\n  previewURL?: string\n} & Pick<LivePreviewContextType, 'typeofLivePreviewURL' | 'url'>\n\nexport const LivePreviewProvider: React.FC<LivePreviewProviderProps> = ({\n  breakpoints: incomingBreakpoints,\n  children,\n  isLivePreviewEnabled,\n  isLivePreviewing: incomingIsLivePreviewing,\n  isPreviewEnabled,\n  previewURL: previewURLFromProps,\n  typeofLivePreviewURL,\n  url: urlFromProps,\n}) => {\n  const [isLivePreviewing, _setIsLivePreviewing] =\n    useState<LivePreviewContextType['isLivePreviewing']>(incomingIsLivePreviewing)\n\n  const [shouldRenderIframe, setShouldRenderIframe] =\n    useState<LivePreviewContextType['shouldRenderIframe']>(isLivePreviewing)\n\n  /**\n   * Rendering the iframe is a one-way event, e.g. defer load and never unmount.\n   * This way, subsequent toggles will appear to load instantly.\n   */\n  const setIsLivePreviewing = useCallback<LivePreviewContextType['setIsLivePreviewing']>(\n    (livePreviewing) => {\n      if (livePreviewing) {\n        setShouldRenderIframe(true)\n      }\n\n      _setIsLivePreviewing(livePreviewing)\n    },\n    [],\n  )\n\n  const breakpoints: LivePreviewConfig['breakpoints'] = useMemo(\n    () => [\n      ...(incomingBreakpoints || []),\n      {\n        name: 'responsive',\n        height: '100%',\n        label: 'Responsive',\n        width: '100%',\n      },\n    ],\n    [incomingBreakpoints],\n  )\n\n  const [url, setURL] = useState<string>('')\n  const [previewURL, _setPreviewURL] = useState<string>()\n\n  const setPreviewURL = useCallback<LivePreviewContextType['setPreviewURL']>((incomingURL) => {\n    _setPreviewURL(isHttpURL(incomingURL) ? incomingURL : undefined)\n  }, [])\n\n  useEffect(() => {\n    setPreviewURL(previewURLFromProps)\n  }, [previewURLFromProps, setPreviewURL])\n\n  const { isPopupOpen, openPopupWindow, popupRef } = usePopupWindow({\n    eventType: 'payload-live-preview',\n    url,\n  })\n\n  const [appIsReady, setAppIsReady] = useState(false)\n  // Tracks when any preview (iframe or popup) signals it's ready\n  // Used to trigger an initial sync to newly opened previews\n  const [lastReadyAt, setLastReadyAt] = useState<number>(0)\n\n  const { collectionSlug, globalSlug } = useDocumentInfo()\n\n  const isFirstRender = useRef(true)\n\n  const { setPreference } = usePreferences()\n\n  const iframeRef = React.useRef<HTMLIFrameElement>(null)\n\n  const [isExpanded, setIsExpanded] = useState(false)\n\n  const [loadedURL, setLoadedURL] = useState<string>()\n\n  const [zoom, setZoom] = useState(1)\n\n  const [position, setPosition] = useState({ x: 0, y: 0 })\n\n  const [size, setSize] = React.useReducer(sizeReducer, { height: 0, width: 0 })\n\n  const [measuredDeviceSize, setMeasuredDeviceSize] = useState({\n    height: 0,\n    width: 0,\n  })\n\n  const [breakpoint, setBreakpoint] =\n    React.useState<LivePreviewConfig['breakpoints'][0]['name']>('responsive')\n\n  /**\n   * A \"middleware\" callback fn that does some additional work before `setURL`.\n   * This is what we provide through context, bc it:\n   *  - ensures the URL is absolute\n   *  - resets `appIsReady` to `false` while the new URL is loading\n   */\n  const setLivePreviewURL = useCallback<LivePreviewContextType['setURL']>(\n    (_incomingURL) => {\n      let incomingURL: LivePreviewURLType\n\n      if (typeof _incomingURL === 'string') {\n        incomingURL = formatAbsoluteURL(_incomingURL)\n      }\n\n      if (!incomingURL) {\n        setIsLivePreviewing(false)\n      }\n\n      if (incomingURL !== url) {\n        setAppIsReady(false)\n        setURL(incomingURL)\n      }\n    },\n    [setIsLivePreviewing, url],\n  )\n\n  /**\n   * `url` needs to be relative to the window, which cannot be done on initial render.\n   */\n  useEffect(() => {\n    if (typeof urlFromProps === 'string') {\n      setURL(formatAbsoluteURL(urlFromProps))\n    }\n  }, [urlFromProps])\n\n  // The toolbar needs to freely drag and drop around the page\n  const handleDragEnd = (ev) => {\n    // only update position if the toolbar is completely within the preview area\n    // otherwise reset it back to the previous position\n    // TODO: reset to the nearest edge of the preview area\n    if (ev.over && ev.over.id === 'live-preview-area') {\n      const newPos = {\n        x: position.x + ev.delta.x,\n        y: position.y + ev.delta.y,\n      }\n\n      setPosition(newPos)\n    } else {\n      // reset\n    }\n  }\n\n  const setWidth = useCallback(\n    (width) => {\n      setSize({ type: 'width', value: width })\n    },\n    [setSize],\n  )\n\n  const setHeight = useCallback(\n    (height) => {\n      setSize({ type: 'height', value: height })\n    },\n    [setSize],\n  )\n\n  // explicitly set new width and height when as new breakpoints are selected\n  // exclude `custom` breakpoint as it is handled by the `setWidth` and `setHeight` directly\n  useEffect(() => {\n    const foundBreakpoint = breakpoints?.find((bp) => bp.name === breakpoint)\n\n    if (\n      foundBreakpoint &&\n      breakpoint !== 'responsive' &&\n      breakpoint !== 'custom' &&\n      typeof foundBreakpoint?.width === 'number' &&\n      typeof foundBreakpoint?.height === 'number'\n    ) {\n      setSize({\n        type: 'reset',\n        value: {\n          height: foundBreakpoint.height,\n          width: foundBreakpoint.width,\n        },\n      })\n    }\n  }, [breakpoint, breakpoints])\n\n  /**\n   * Receive the `ready` message from the popup window\n   * This indicates that the app is ready to receive `window.postMessage` events\n   * This is also the only cross-origin way of detecting when a popup window has loaded\n   * Unlike iframe elements which have an `onLoad` handler, there is no way to access `window.open` on popups\n   */\n  useEffect(() => {\n    const handleMessage = (event: MessageEvent) => {\n      if (\n        url?.startsWith(event.origin) &&\n        event.data &&\n        typeof event.data === 'object' &&\n        event.data.type === 'payload-live-preview'\n      ) {\n        if (event.data.ready) {\n          setAppIsReady(true)\n          setLastReadyAt(Date.now())\n        }\n      }\n    }\n\n    window.addEventListener('message', handleMessage)\n\n    return () => {\n      window.removeEventListener('message', handleMessage)\n    }\n  }, [url])\n\n  useEffect(() => {\n    if (isFirstRender.current) {\n      isFirstRender.current = false\n      return\n    }\n\n    void setPreference<CollectionPreferences>(\n      collectionSlug ? `collection-${collectionSlug}` : `global-${globalSlug}`,\n      {\n        editViewType: isLivePreviewing ? 'live-preview' : 'default',\n      },\n      true,\n    )\n  }, [isLivePreviewing, setPreference, collectionSlug, globalSlug])\n\n  const dndContextID = useId()\n\n  return (\n    <LivePreviewContext\n      value={{\n        appIsReady,\n        breakpoint,\n        breakpoints,\n        iframeRef,\n        isExpanded,\n        isLivePreviewEnabled,\n        isLivePreviewing,\n        isPopupOpen,\n        isPreviewEnabled,\n        lastReadyAt,\n        loadedURL,\n        measuredDeviceSize,\n        openPopupWindow,\n        popupRef,\n        previewURL,\n        setBreakpoint,\n        setHeight,\n        setIsExpanded,\n        setIsLivePreviewing,\n        setLoadedURL,\n        setMeasuredDeviceSize,\n        setPreviewURL,\n        setSize,\n        setToolbarPosition: setPosition,\n        setURL: setLivePreviewURL,\n        setWidth,\n        setZoom,\n        shouldRenderIframe,\n        size,\n        toolbarPosition: position,\n        typeofLivePreviewURL,\n        url,\n        zoom,\n      }}\n    >\n      <DndContext\n        collisionDetection={customCollisionDetection}\n        // Provide stable ID to fix hydration issues: https://github.com/clauderic/dnd-kit/issues/926\n        id={dndContextID}\n        onDragEnd={handleDragEnd}\n      >\n        {children}\n      </DndContext>\n    </LivePreviewContext>\n  )\n}\n"],"mappings":"AAAA;;;AAGA,SAASA,UAAU,QAAQ;AAC3B,OAAOC,KAAA,IAASC,WAAW,EAAEC,SAAS,EAAEC,KAAK,EAAEC,OAAO,EAAEC,MAAM,EAAEC,QAAQ,QAAQ;AAIhF,SAASC,cAAc,QAAQ;AAC/B,SAASC,eAAe,QAAQ;AAChC,SAASC,cAAc,QAAQ;AAC/B,SAASC,iBAAiB,QAAQ;AAClC,SAASC,SAAS,QAAQ;AAC1B,SAASC,wBAAwB,QAAQ;AACzC,SAASC,kBAAkB,QAAQ;AACnC,SAASC,WAAW,QAAQ;AAsB5B,OAAO,MAAMC,mBAAA,GAA0DA,CAAC;EACtEC,WAAA,EAAaC,mBAAmB;EAChCC,QAAQ;EACRC,oBAAoB;EACpBC,gBAAA,EAAkBC,wBAAwB;EAC1CC,gBAAgB;EAChBC,UAAA,EAAYC,mBAAmB;EAC/BC,oBAAoB;EACpBC,GAAA,EAAKC;AAAY,CAClB;EACC,MAAM,CAACP,gBAAA,EAAkBQ,oBAAA,CAAqB,GAC5CtB,QAAA,CAAqDe,wBAAA;EAEvD,MAAM,CAACQ,kBAAA,EAAoBC,qBAAA,CAAsB,GAC/CxB,QAAA,CAAuDc,gBAAA;EAEzD;;;;EAIA,MAAMW,mBAAA,GAAsB9B,WAAA,CACzB+B,cAAA;IACC,IAAIA,cAAA,EAAgB;MAClBF,qBAAA,CAAsB;IACxB;IAEAF,oBAAA,CAAqBI,cAAA;EACvB,GACA,EAAE;EAGJ,MAAMhB,WAAA,GAAgDZ,OAAA,CACpD,MAAM,C,IACAa,mBAAA,IAAuB,EAAE,GAC7B;IACEgB,IAAA,EAAM;IACNC,MAAA,EAAQ;IACRC,KAAA,EAAO;IACPC,KAAA,EAAO;EACT,EACD,EACD,CAACnB,mBAAA,CAAoB;EAGvB,MAAM,CAACS,GAAA,EAAKW,MAAA,CAAO,GAAG/B,QAAA,CAAiB;EACvC,MAAM,CAACiB,UAAA,EAAYe,cAAA,CAAe,GAAGhC,QAAA;EAErC,MAAMiC,aAAA,GAAgBtC,WAAA,CAAsDuC,WAAA;IAC1EF,cAAA,CAAe3B,SAAA,CAAU6B,WAAA,IAAeA,WAAA,GAAcC,SAAA;EACxD,GAAG,EAAE;EAELvC,SAAA,CAAU;IACRqC,aAAA,CAAcf,mBAAA;EAChB,GAAG,CAACA,mBAAA,EAAqBe,aAAA,CAAc;EAEvC,MAAM;IAAEG,WAAW;IAAEC,eAAe;IAAEC;EAAQ,CAAE,GAAGrC,cAAA,CAAe;IAChEsC,SAAA,EAAW;IACXnB;EACF;EAEA,MAAM,CAACoB,UAAA,EAAYC,aAAA,CAAc,GAAGzC,QAAA,CAAS;EAC7C;EACA;EACA,MAAM,CAAC0C,WAAA,EAAaC,cAAA,CAAe,GAAG3C,QAAA,CAAiB;EAEvD,MAAM;IAAE4C,cAAc;IAAEC;EAAU,CAAE,GAAG3C,eAAA;EAEvC,MAAM4C,aAAA,GAAgB/C,MAAA,CAAO;EAE7B,MAAM;IAAEgD;EAAa,CAAE,GAAG5C,cAAA;EAE1B,MAAM6C,SAAA,GAAYtD,KAAA,CAAMK,MAAM,CAAoB;EAElD,MAAM,CAACkD,UAAA,EAAYC,aAAA,CAAc,GAAGlD,QAAA,CAAS;EAE7C,MAAM,CAACmD,SAAA,EAAWC,YAAA,CAAa,GAAGpD,QAAA;EAElC,MAAM,CAACqD,IAAA,EAAMC,OAAA,CAAQ,GAAGtD,QAAA,CAAS;EAEjC,MAAM,CAACuD,QAAA,EAAUC,WAAA,CAAY,GAAGxD,QAAA,CAAS;IAAEyD,CAAA,EAAG;IAAGC,CAAA,EAAG;EAAE;EAEtD,MAAM,CAACC,IAAA,EAAMC,OAAA,CAAQ,GAAGlE,KAAA,CAAMmE,UAAU,CAACrD,WAAA,EAAa;IAAEoB,MAAA,EAAQ;IAAGE,KAAA,EAAO;EAAE;EAE5E,MAAM,CAACgC,kBAAA,EAAoBC,qBAAA,CAAsB,GAAG/D,QAAA,CAAS;IAC3D4B,MAAA,EAAQ;IACRE,KAAA,EAAO;EACT;EAEA,MAAM,CAACkC,UAAA,EAAYC,aAAA,CAAc,GAC/BvE,KAAA,CAAMM,QAAQ,CAA8C;EAE9D;;;;;;EAMA,MAAMkE,iBAAA,GAAoBvE,WAAA,CACvBwE,YAAA;IACC,IAAIjC,aAAA;IAEJ,IAAI,OAAOiC,YAAA,KAAiB,UAAU;MACpCjC,aAAA,GAAc9B,iBAAA,CAAkB+D,YAAA;IAClC;IAEA,IAAI,CAACjC,aAAA,EAAa;MAChBT,mBAAA,CAAoB;IACtB;IAEA,IAAIS,aAAA,KAAgBd,GAAA,EAAK;MACvBqB,aAAA,CAAc;MACdV,MAAA,CAAOG,aAAA;IACT;EACF,GACA,CAACT,mBAAA,EAAqBL,GAAA,CAAI;EAG5B;;;EAGAxB,SAAA,CAAU;IACR,IAAI,OAAOyB,YAAA,KAAiB,UAAU;MACpCU,MAAA,CAAO3B,iBAAA,CAAkBiB,YAAA;IAC3B;EACF,GAAG,CAACA,YAAA,CAAa;EAEjB;EACA,MAAM+C,aAAA,GAAiBC,EAAA;IACrB;IACA;IACA;IACA,IAAIA,EAAA,CAAGC,IAAI,IAAID,EAAA,CAAGC,IAAI,CAACC,EAAE,KAAK,qBAAqB;MACjD,MAAMC,MAAA,GAAS;QACbf,CAAA,EAAGF,QAAA,CAASE,CAAC,GAAGY,EAAA,CAAGI,KAAK,CAAChB,CAAC;QAC1BC,CAAA,EAAGH,QAAA,CAASG,CAAC,GAAGW,EAAA,CAAGI,KAAK,CAACf;MAC3B;MAEAF,WAAA,CAAYgB,MAAA;IACd,OAAO;MACL;IAAA;EAEJ;EAEA,MAAME,QAAA,GAAW/E,WAAA,CACdmC,KAAA;IACC8B,OAAA,CAAQ;MAAEe,IAAA,EAAM;MAASC,KAAA,EAAO9C;IAAM;EACxC,GACA,CAAC8B,OAAA,CAAQ;EAGX,MAAMiB,SAAA,GAAYlF,WAAA,CACfiC,MAAA;IACCgC,OAAA,CAAQ;MAAEe,IAAA,EAAM;MAAUC,KAAA,EAAOhD;IAAO;EAC1C,GACA,CAACgC,OAAA,CAAQ;EAGX;EACA;EACAhE,SAAA,CAAU;IACR,MAAMkF,eAAA,GAAkBpE,WAAA,EAAaqE,IAAA,CAAMC,EAAA,IAAOA,EAAA,CAAGrD,IAAI,KAAKqC,UAAA;IAE9D,IACEc,eAAA,IACAd,UAAA,KAAe,gBACfA,UAAA,KAAe,YACf,OAAOc,eAAA,EAAiBhD,KAAA,KAAU,YAClC,OAAOgD,eAAA,EAAiBlD,MAAA,KAAW,UACnC;MACAgC,OAAA,CAAQ;QACNe,IAAA,EAAM;QACNC,KAAA,EAAO;UACLhD,MAAA,EAAQkD,eAAA,CAAgBlD,MAAM;UAC9BE,KAAA,EAAOgD,eAAA,CAAgBhD;QACzB;MACF;IACF;EACF,GAAG,CAACkC,UAAA,EAAYtD,WAAA,CAAY;EAE5B;;;;;;EAMAd,SAAA,CAAU;IACR,MAAMqF,aAAA,GAAiBC,KAAA;MACrB,IACE9D,GAAA,EAAK+D,UAAA,CAAWD,KAAA,CAAME,MAAM,KAC5BF,KAAA,CAAMG,IAAI,IACV,OAAOH,KAAA,CAAMG,IAAI,KAAK,YACtBH,KAAA,CAAMG,IAAI,CAACV,IAAI,KAAK,wBACpB;QACA,IAAIO,KAAA,CAAMG,IAAI,CAACC,KAAK,EAAE;UACpB7C,aAAA,CAAc;UACdE,cAAA,CAAe4C,IAAA,CAAKC,GAAG;QACzB;MACF;IACF;IAEAC,MAAA,CAAOC,gBAAgB,CAAC,WAAWT,aAAA;IAEnC,OAAO;MACLQ,MAAA,CAAOE,mBAAmB,CAAC,WAAWV,aAAA;IACxC;EACF,GAAG,CAAC7D,GAAA,CAAI;EAERxB,SAAA,CAAU;IACR,IAAIkD,aAAA,CAAc8C,OAAO,EAAE;MACzB9C,aAAA,CAAc8C,OAAO,GAAG;MACxB;IACF;IAEA,KAAK7C,aAAA,CACHH,cAAA,GAAiB,cAAcA,cAAA,EAAgB,GAAG,UAAUC,UAAA,EAAY,EACxE;MACEgD,YAAA,EAAc/E,gBAAA,GAAmB,iBAAiB;IACpD,GACA;EAEJ,GAAG,CAACA,gBAAA,EAAkBiC,aAAA,EAAeH,cAAA,EAAgBC,UAAA,CAAW;EAEhE,MAAMiD,YAAA,GAAejG,KAAA;EAErB,oBACEkG,IAAA,CAACxF,kBAAA;IACCqE,KAAA,EAAO;MACLpC,UAAA;MACAwB,UAAA;MACAtD,WAAA;MACAsC,SAAA;MACAC,UAAA;MACApC,oBAAA;MACAC,gBAAA;MACAsB,WAAA;MACApB,gBAAA;MACA0B,WAAA;MACAS,SAAA;MACAW,kBAAA;MACAzB,eAAA;MACAC,QAAA;MACArB,UAAA;MACAgD,aAAA;MACAY,SAAA;MACA3B,aAAA;MACAzB,mBAAA;MACA2B,YAAA;MACAW,qBAAA;MACA9B,aAAA;MACA2B,OAAA;MACAoC,kBAAA,EAAoBxC,WAAA;MACpBzB,MAAA,EAAQmC,iBAAA;MACRQ,QAAA;MACApB,OAAA;MACA/B,kBAAA;MACAoC,IAAA;MACAsC,eAAA,EAAiB1C,QAAA;MACjBpC,oBAAA;MACAC,GAAA;MACAiC;IACF;cAEA,aAAA0C,IAAA,CAACtG,UAAA;MACCyG,kBAAA,EAAoB5F,wBAAA;MACpB;MACAiE,EAAA,EAAIuB,YAAA;MACJK,SAAA,EAAW/B,aAAA;gBAEVxD;;;AAIT","ignoreList":[]}

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

@@ -12,9 +12,5 @@ export declare const useLocaleLoading: () => {
     localeIsLoading: boolean;
     setLocaleIsLoading: (_: boolean) => any;
 };
-/**
- * TODO: V4
- * The return type of the `useLocale` hook will change in v4. It will return `null | Locale` instead of `false | {} | Locale`.
- */
-export declare const useLocale: () => Locale;
+export declare const useLocale: () => Locale | null;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/Locale/index.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAGrC,OAAO,KAA0D,MAAM,OAAO,CAAA;AAS9E,eAAO,MAAM,oBAAoB;;4BAEP,OAAO;EAC/B,CAAA;AAcF,eAAO,MAAM,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC;IAAE,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAA;CAAE,CA4F5F,CAAA;AAED,eAAO,MAAM,gBAAgB;;4BA7GH,OAAO;CA6G8B,CAAA;AAE/D;;;GAGG;AACH,eAAO,MAAM,SAAS,QAAO,MAA4B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/Locale/index.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAGrC,OAAO,KAA0D,MAAM,OAAO,CAAA;AAU9E,eAAO,MAAM,oBAAoB;;4BAEP,OAAO;EAC/B,CAAA;AAcF,eAAO,MAAM,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC;IAAE,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAA;CAAE,CAsF5F,CAAA;AAED,eAAO,MAAM,gBAAgB;;4BAvGH,OAAO;CAuG8B,CAAA;AAE/D,eAAO,MAAM,SAAS,QAAO,MAAM,GAAG,IAA0B,CAAA"}

package/dist/providers/Locale/index.js

@@ -1,6 +1,5 @@
 'use client';
 
-import { c as _c } from "react/compiler-runtime";
 import { jsx as _jsx } from "react/jsx-runtime";
 import { formatAdminURL } from 'payload/shared';
 import React, { createContext, use, useEffect, useRef, useState } from 'react';
@@ -8,7 +7,8 @@ import { findLocaleFromCode } from '../../utilities/findLocaleFromCode.js';
 import { useAuth } from '../Auth/index.js';
 import { useConfig } from '../Config/index.js';
 import { useSearchParams } from '../RouterAdapter/index.js';
-const LocaleContext = /*#__PURE__*/createContext({});
+import { useRouteTransition } from '../RouteTransition/index.js';
+const LocaleContext = /*#__PURE__*/createContext(null);
 export const LocaleLoadingContext = /*#__PURE__*/createContext({
   localeIsLoading: false,
   setLocaleIsLoading: _ => undefined
@@ -20,151 +20,78 @@ const fetchPreferences = async (key, baseURL) => await fetch(`${baseURL}/payload
   },
   method: 'GET'
 })?.then(res => res.json());
-export const LocaleProvider = t0 => {
-  const $ = _c(28);
+export const LocaleProvider = ({
+  children,
+  /**
+  The `locale` prop originates from the root layout, which does not have access to search params
+  This component uses the `useSearchParams` hook to get the locale from the URL as precedence over this prop
+  This prop does not update as the user navigates the site, because the root layout does not re-render
+  */
+  locale: initialLocaleFromPrefs
+}) => {
   const {
-    children,
-    locale: initialLocaleFromPrefs
-  } = t0;
-  const {
-    config: t1
+    config: {
+      localization = false,
+      routes: {
+        api: apiRoute
+      }
+    }
   } = useConfig();
-  const {
-    localization: t2,
-    routes: t3
-  } = t1;
-  const localization = t2 === undefined ? false : t2;
-  const {
-    api: apiRoute
-  } = t3;
   const {
     user
   } = useAuth();
-  const defaultLocale = localization ? localization.defaultLocale : "en";
-  const t4 = useSearchParams();
-  let t5;
-  if ($[0] !== t4) {
-    t5 = t4.get("locale");
-    $[0] = t4;
-    $[1] = t5;
-  } else {
-    t5 = $[1];
-  }
-  const localeFromParams = t5;
-  let t6;
-  if ($[2] !== defaultLocale || $[3] !== initialLocaleFromPrefs || $[4] !== localeFromParams || $[5] !== localization) {
-    t6 = () => {
-      if (!localization || localization && !localization.locales.length) {
-        return {};
-      }
-      return findLocaleFromCode(localization, localeFromParams) || findLocaleFromCode(localization, initialLocaleFromPrefs) || findLocaleFromCode(localization, defaultLocale) || findLocaleFromCode(localization, localization.locales[0].code);
-    };
-    $[2] = defaultLocale;
-    $[3] = initialLocaleFromPrefs;
-    $[4] = localeFromParams;
-    $[5] = localization;
-    $[6] = t6;
-  } else {
-    t6 = $[6];
-  }
-  const [locale, setLocale] = React.useState(t6);
+  const {
+    isTransitioning
+  } = useRouteTransition();
+  const defaultLocale = localization ? localization.defaultLocale : 'en';
+  const localeFromParams = useSearchParams().get('locale');
+  const [locale, setLocale] = React.useState(() => {
+    if (!localization || localization && !localization.locales.length) {
+      return null;
+    }
+    return findLocaleFromCode(localization, localeFromParams) || findLocaleFromCode(localization, initialLocaleFromPrefs) || findLocaleFromCode(localization, defaultLocale) || findLocaleFromCode(localization, localization.locales[0].code);
+  });
   const [isLoading, setLocaleIsLoading] = useState(false);
   const prevLocale = useRef(locale);
-  let t7;
-  let t8;
-  if ($[7] !== locale) {
-    t7 = () => {
-      if (locale.code !== prevLocale.current.code) {
-        setLocaleIsLoading(false);
-      }
+  useEffect(() => {
+    // Keep fields disabled until the new locale's document state finishes loading.
+    if (locale?.code !== prevLocale.current?.code && !isTransitioning) {
+      setLocaleIsLoading(false);
       prevLocale.current = locale;
-    };
-    t8 = [locale];
-    $[7] = locale;
-    $[8] = t7;
-    $[9] = t8;
-  } else {
-    t7 = $[8];
-    t8 = $[9];
-  }
-  useEffect(t7, t8);
-  let t9;
-  if ($[10] !== apiRoute) {
-    t9 = formatAdminURL({
-      apiRoute,
-      path: ""
-    });
-    $[10] = apiRoute;
-    $[11] = t9;
-  } else {
-    t9 = $[11];
-  }
-  const fetchURL = t9;
-  let t10;
-  if ($[12] !== defaultLocale || $[13] !== fetchURL || $[14] !== localeFromParams || $[15] !== localization || $[16] !== user?.id) {
-    t10 = () => {
-      const resetLocale = async function resetLocale() {
-        if (localization && user?.id) {
-          const localeToUse = localeFromParams || (await fetchPreferences("locale", fetchURL)?.then(_temp));
-          const newLocale = findLocaleFromCode(localization, localeToUse) || findLocaleFromCode(localization, defaultLocale) || findLocaleFromCode(localization, localization?.locales?.[0]?.code);
-          if (newLocale) {
-            setLocale(newLocale);
-          }
+    }
+  }, [isTransitioning, locale]);
+  const fetchURL = formatAdminURL({
+    apiRoute,
+    path: ''
+  });
+  useEffect(() => {
+    /**
+    * This effect should only run when `localeFromParams` changes, i.e. when the user clicks an anchor link
+    * The root layout, which sends the initial locale from prefs, will not re-render as the user navigates the site
+    * For this reason, we need to fetch the locale from prefs if the search params clears the `locale` query param
+    */
+    async function resetLocale() {
+      if (localization && user?.id) {
+        const localeToUse = localeFromParams || (await fetchPreferences('locale', fetchURL)?.then(res => res.value));
+        const newLocale = findLocaleFromCode(localization, localeToUse) || findLocaleFromCode(localization, defaultLocale) || findLocaleFromCode(localization, localization?.locales?.[0]?.code);
+        if (newLocale) {
+          setLocale(newLocale);
         }
-      };
-      resetLocale();
-    };
-    $[12] = defaultLocale;
-    $[13] = fetchURL;
-    $[14] = localeFromParams;
-    $[15] = localization;
-    $[16] = user?.id;
-    $[17] = t10;
-  } else {
-    t10 = $[17];
-  }
-  const t11 = user?.id;
-  let t12;
-  if ($[18] !== defaultLocale || $[19] !== fetchURL || $[20] !== localeFromParams || $[21] !== localization || $[22] !== t11) {
-    t12 = [defaultLocale, localization, fetchURL, localeFromParams, t11];
-    $[18] = defaultLocale;
-    $[19] = fetchURL;
-    $[20] = localeFromParams;
-    $[21] = localization;
-    $[22] = t11;
-    $[23] = t12;
-  } else {
-    t12 = $[23];
-  }
-  useEffect(t10, t12);
-  let t13;
-  if ($[24] !== children || $[25] !== isLoading || $[26] !== locale) {
-    t13 = _jsx(LocaleContext, {
-      value: locale,
-      children: _jsx(LocaleLoadingContext, {
-        value: {
-          localeIsLoading: isLoading,
-          setLocaleIsLoading
-        },
-        children
-      })
-    });
-    $[24] = children;
-    $[25] = isLoading;
-    $[26] = locale;
-    $[27] = t13;
-  } else {
-    t13 = $[27];
-  }
-  return t13;
+      }
+    }
+    void resetLocale();
+  }, [defaultLocale, localization, fetchURL, localeFromParams, user?.id]);
+  return /*#__PURE__*/_jsx(LocaleContext, {
+    value: locale,
+    children: /*#__PURE__*/_jsx(LocaleLoadingContext, {
+      value: {
+        localeIsLoading: isLoading,
+        setLocaleIsLoading
+      },
+      children: children
+    })
+  });
 };
 export const useLocaleLoading = () => use(LocaleLoadingContext);
-/**
- * TODO: V4
- * The return type of the `useLocale` hook will change in v4. It will return `null | Locale` instead of `false | {} | Locale`.
- */
 export const useLocale = () => use(LocaleContext);
-function _temp(res) {
-  return res.value;
-}
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["c","_c","formatAdminURL","React","createContext","use","useEffect","useRef","useState","findLocaleFromCode","useAuth","useConfig","useSearchParams","LocaleContext","LocaleLoadingContext","localeIsLoading","setLocaleIsLoading","_","undefined","fetchPreferences","key","baseURL","fetch","credentials","headers","method","then","res","json","LocaleProvider","t0","$","children","locale","initialLocaleFromPrefs","config","t1","localization","t2","routes","t3","api","apiRoute","user","defaultLocale","t4","t5","get","localeFromParams","t6","locales","length","code","setLocale","isLoading","prevLocale","t7","t8","current","t9","path","fetchURL","t10","id","resetLocale","localeToUse","_temp","newLocale","t11","t12","t13","_jsx","value","useLocaleLoading","useLocale"],"sources":["../../../src/providers/Locale/index.tsx"],"sourcesContent":["'use client'\n\nimport type { Locale } from 'payload'\n\nimport { formatAdminURL } from 'payload/shared'\nimport React, { createContext, use, useEffect, useRef, useState } from 'react'\n\nimport { findLocaleFromCode } from '../../utilities/findLocaleFromCode.js'\nimport { useAuth } from '../Auth/index.js'\nimport { useConfig } from '../Config/index.js'\nimport { useSearchParams } from '../RouterAdapter/index.js'\n\nconst LocaleContext = createContext({} as Locale)\n\nexport const LocaleLoadingContext = createContext({\n  localeIsLoading: false,\n  setLocaleIsLoading: (_: boolean) => undefined,\n})\n\nconst fetchPreferences = async <T extends Record<string, unknown> | string>(\n  key: string,\n  baseURL: string,\n): Promise<{ id: string; value: T }> =>\n  await fetch(`${baseURL}/payload-preferences/${key}`, {\n    credentials: 'include',\n    headers: {\n      'Content-Type': 'application/json',\n    },\n    method: 'GET',\n  })?.then((res) => res.json() as Promise<{ id: string; value: T }>)\n\nexport const LocaleProvider: React.FC<{ children?: React.ReactNode; locale?: Locale['code'] }> = ({\n  children,\n  /**\n    The `locale` prop originates from the root layout, which does not have access to search params\n    This component uses the `useSearchParams` hook to get the locale from the URL as precedence over this prop\n    This prop does not update as the user navigates the site, because the root layout does not re-render\n  */\n  locale: initialLocaleFromPrefs,\n}) => {\n  const {\n    config: {\n      localization = false,\n      routes: { api: apiRoute },\n    },\n  } = useConfig()\n\n  const { user } = useAuth()\n\n  const defaultLocale = localization ? localization.defaultLocale : 'en'\n\n  const localeFromParams = useSearchParams().get('locale')\n\n  const [locale, setLocale] = React.useState<Locale>(() => {\n    if (!localization || (localization && !localization.locales.length)) {\n      // TODO: return null V4\n      return {} as Locale\n    }\n\n    return (\n      findLocaleFromCode(localization, localeFromParams) ||\n      findLocaleFromCode(localization, initialLocaleFromPrefs) ||\n      findLocaleFromCode(localization, defaultLocale) ||\n      findLocaleFromCode(localization, localization.locales[0].code)\n    )\n  })\n\n  const [isLoading, setLocaleIsLoading] = useState(false)\n\n  const prevLocale = useRef<Locale>(locale)\n\n  useEffect(() => {\n    /**\n     * We need to set `isLoading` back to false once the locale is detected to be different\n     * This happens when the user clicks an anchor link which appends the `?locale=` query param\n     * This triggers a client-side navigation, which re-renders the page with the new locale\n     * In Next.js, local state is persisted during this type of navigation because components are not unmounted\n     */\n    if (locale.code !== prevLocale.current.code) {\n      setLocaleIsLoading(false)\n    }\n\n    prevLocale.current = locale\n  }, [locale])\n\n  const fetchURL = formatAdminURL({\n    apiRoute,\n    path: '',\n  })\n\n  useEffect(() => {\n    /**\n     * This effect should only run when `localeFromParams` changes, i.e. when the user clicks an anchor link\n     * The root layout, which sends the initial locale from prefs, will not re-render as the user navigates the site\n     * For this reason, we need to fetch the locale from prefs if the search params clears the `locale` query param\n     */\n    async function resetLocale() {\n      if (localization && user?.id) {\n        const localeToUse =\n          localeFromParams ||\n          (await fetchPreferences<Locale['code']>('locale', fetchURL)?.then((res) => res.value))\n\n        const newLocale =\n          findLocaleFromCode(localization, localeToUse) ||\n          findLocaleFromCode(localization, defaultLocale) ||\n          findLocaleFromCode(localization, localization?.locales?.[0]?.code)\n\n        if (newLocale) {\n          setLocale(newLocale)\n        }\n      }\n    }\n\n    void resetLocale()\n  }, [defaultLocale, localization, fetchURL, localeFromParams, user?.id])\n\n  return (\n    <LocaleContext value={locale}>\n      <LocaleLoadingContext value={{ localeIsLoading: isLoading, setLocaleIsLoading }}>\n        {children}\n      </LocaleLoadingContext>\n    </LocaleContext>\n  )\n}\n\nexport const useLocaleLoading = () => use(LocaleLoadingContext)\n\n/**\n * TODO: V4\n * The return type of the `useLocale` hook will change in v4. It will return `null | Locale` instead of `false | {} | Locale`.\n */\nexport const useLocale = (): Locale => use(LocaleContext)\n"],"mappings":"AAAA;;AAAA,SAAAA,CAAA,IAAAC,EAAA;;AAIA,SAASC,cAAc,QAAQ;AAC/B,OAAOC,KAAA,IAASC,aAAa,EAAEC,GAAG,EAAEC,SAAS,EAAEC,MAAM,EAAEC,QAAQ,QAAQ;AAEvE,SAASC,kBAAkB,QAAQ;AACnC,SAASC,OAAO,QAAQ;AACxB,SAASC,SAAS,QAAQ;AAC1B,SAASC,eAAe,QAAQ;AAEhC,MAAMC,aAAA,gBAAgBT,aAAA,CAAc,CAAC;AAErC,OAAO,MAAMU,oBAAA,gBAAuBV,aAAA,CAAc;EAChDW,eAAA,EAAiB;EACjBC,kBAAA,EAAqBC,CAAA,IAAeC;AACtC;AAEA,MAAMC,gBAAA,GAAmB,MAAAA,CACvBC,GAAA,EACAC,OAAA,KAEA,MAAMC,KAAA,CAAM,GAAGD,OAAA,wBAA+BD,GAAA,EAAK,EAAE;EACnDG,WAAA,EAAa;EACbC,OAAA,EAAS;IACP,gBAAgB;EAClB;EACAC,MAAA,EAAQ;AACV,IAAIC,IAAA,CAAMC,GAAA,IAAQA,GAAA,CAAIC,IAAI;AAE5B,OAAO,MAAMC,cAAA,GAAoFC,EAAA;EAAA,MAAAC,CAAA,GAAA9B,EAAA;EAAC;IAAA+B,QAAA;IAAAC,MAAA,EAAAC;EAAA,IAAAJ,EAQjG;EACC;IAAAK,MAAA,EAAAC;EAAA,IAKIzB,SAAA;EAJM;IAAA0B,YAAA,EAAAC,EAAA;IAAAC,MAAA,EAAAC;EAAA,IAAAJ,EAGP;EAFC,MAAAC,YAAA,GAAAC,EAAoB,KAAApB,SAAA,WAApBoB,EAAoB;EACZ;IAAAG,GAAA,EAAAC;EAAA,IAAAF,EAAiB;EAI7B;IAAAG;EAAA,IAAiBjC,OAAA;EAEjB,MAAAkC,aAAA,GAAsBP,YAAA,GAAeA,YAAA,CAAAO,aAAA,GAA6B;EAEzC,MAAAC,EAAA,GAAAjC,eAAA;EAAA,IAAAkC,EAAA;EAAA,IAAAf,CAAA,QAAAc,EAAA;IAAAC,EAAA,GAAAD,EAAA,CAAAE,GAAA,CAAsB;IAAAhB,CAAA,MAAAc,EAAA;IAAAd,CAAA,MAAAe,EAAA;EAAA;IAAAA,EAAA,GAAAf,CAAA;EAAA;EAA/C,MAAAiB,gBAAA,GAAyBF,EAAsB;EAAA,IAAAG,EAAA;EAAA,IAAAlB,CAAA,QAAAa,aAAA,IAAAb,CAAA,QAAAG,sBAAA,IAAAH,CAAA,QAAAiB,gBAAA,IAAAjB,CAAA,QAAAM,YAAA;IAEIY,EAAA,GAAAA,CAAA;MAAA,IAC7C,CAACZ,YAAA,IAAiBA,YAAA,KAAiBA,YAAA,CAAAa,OAAA,CAAAC,MAA2B;QAAA;MAAA;MAAA,OAMhE1C,kBAAA,CAAmB4B,YAAA,EAAcW,gBAAA,KACjCvC,kBAAA,CAAmB4B,YAAA,EAAcH,sBAAA,KACjCzB,kBAAA,CAAmB4B,YAAA,EAAcO,aAAA,KACjCnC,kBAAA,CAAmB4B,YAAA,EAAcA,YAAA,CAAAa,OAAA,IAAAE,IAA4B;IAAA;IAEjErB,CAAA,MAAAa,aAAA;IAAAb,CAAA,MAAAG,sBAAA;IAAAH,CAAA,MAAAiB,gBAAA;IAAAjB,CAAA,MAAAM,YAAA;IAAAN,CAAA,MAAAkB,EAAA;EAAA;IAAAA,EAAA,GAAAlB,CAAA;EAAA;EAZA,OAAAE,MAAA,EAAAoB,SAAA,IAA4BlD,KAAA,CAAAK,QAAA,CAAuByC,EAYnD;EAEA,OAAAK,SAAA,EAAAtC,kBAAA,IAAwCR,QAAA,MAAS;EAEjD,MAAA+C,UAAA,GAAmBhD,MAAA,CAAe0B,MAAA;EAAA,IAAAuB,EAAA;EAAA,IAAAC,EAAA;EAAA,IAAA1B,CAAA,QAAAE,MAAA;IAExBuB,EAAA,GAAAA,CAAA;MAAA,IAOJvB,MAAA,CAAAmB,IAAA,KAAgBG,UAAA,CAAAG,OAAA,CAAAN,IAAuB;QACzCpC,kBAAA,MAAmB;MAAA;MAGrBuC,UAAA,CAAAG,OAAA,GAAqBzB,MAAA;IAAA;IACpBwB,EAAA,IAACxB,MAAA;IAAOF,CAAA,MAAAE,MAAA;IAAAF,CAAA,MAAAyB,EAAA;IAAAzB,CAAA,MAAA0B,EAAA;EAAA;IAAAD,EAAA,GAAAzB,CAAA;IAAA0B,EAAA,GAAA1B,CAAA;EAAA;EAZXzB,SAAA,CAAUkD,EAYV,EAAGC,EAAQ;EAAA,IAAAE,EAAA;EAAA,IAAA5B,CAAA,SAAAW,QAAA;IAEMiB,EAAA,GAAAzD,cAAA;MAAAwC,QAAA;MAAAkB,IAAA,EAET;IAAA,CACR;IAAA7B,CAAA,OAAAW,QAAA;IAAAX,CAAA,OAAA4B,EAAA;EAAA;IAAAA,EAAA,GAAA5B,CAAA;EAAA;EAHA,MAAA8B,QAAA,GAAiBF,EAGjB;EAAA,IAAAG,GAAA;EAAA,IAAA/B,CAAA,SAAAa,aAAA,IAAAb,CAAA,SAAA8B,QAAA,IAAA9B,CAAA,SAAAiB,gBAAA,IAAAjB,CAAA,SAAAM,YAAA,IAAAN,CAAA,SAAAY,IAAA,EAAAoB,EAAA;IAEUD,GAAA,GAAAA,CAAA;MAMR,MAAAE,WAAA,kBAAAA,YAAA;QAAA,IACM3B,YAAA,IAAgBM,IAAA,EAAAoB,EAAM;UACxB,MAAAE,WAAA,GACEjB,gBAAA,WACO7B,gBAAA,CAAiC,UAAU0C,QAAA,GAAAnC,IAAA,CAAAwC,KAAA,EAAkC;UAEtF,MAAAC,SAAA,GACE1D,kBAAA,CAAmB4B,YAAA,EAAc4B,WAAA,KACjCxD,kBAAA,CAAmB4B,YAAA,EAAcO,aAAA,KACjCnC,kBAAA,CAAmB4B,YAAA,EAAcA,YAAA,EAAAa,OAAA,OAAAE,IAA4B;UAAA,IAE3De,SAAA;YACFd,SAAA,CAAUc,SAAA;UAAA;QAAA;MAAA;MAKXH,WAAA;IAAA;IACPjC,CAAA,OAAAa,aAAA;IAAAb,CAAA,OAAA8B,QAAA;IAAA9B,CAAA,OAAAiB,gBAAA;IAAAjB,CAAA,OAAAM,YAAA;IAAAN,CAAA,OAAAY,IAAA,EAAAoB,EAAA;IAAAhC,CAAA,OAAA+B,GAAA;EAAA;IAAAA,GAAA,GAAA/B,CAAA;EAAA;EAA6D,MAAAqC,GAAA,GAAAzB,IAAA,EAAAoB,EAAA;EAAM,IAAAM,GAAA;EAAA,IAAAtC,CAAA,SAAAa,aAAA,IAAAb,CAAA,SAAA8B,QAAA,IAAA9B,CAAA,SAAAiB,gBAAA,IAAAjB,CAAA,SAAAM,YAAA,IAAAN,CAAA,SAAAqC,GAAA;IAAhEC,GAAA,IAACzB,aAAA,EAAeP,YAAA,EAAcwB,QAAA,EAAUb,gBAAA,EAAkBoB,GAAM;IAAGrC,CAAA,OAAAa,aAAA;IAAAb,CAAA,OAAA8B,QAAA;IAAA9B,CAAA,OAAAiB,gBAAA;IAAAjB,CAAA,OAAAM,YAAA;IAAAN,CAAA,OAAAqC,GAAA;IAAArC,CAAA,OAAAsC,GAAA;EAAA;IAAAA,GAAA,GAAAtC,CAAA;EAAA;EAxBtEzB,SAAA,CAAUwD,GAwBV,EAAGO,GAAmE;EAAA,IAAAC,GAAA;EAAA,IAAAvC,CAAA,SAAAC,QAAA,IAAAD,CAAA,SAAAuB,SAAA,IAAAvB,CAAA,SAAAE,MAAA;IAGpEqC,GAAA,GAAAC,IAAA,CAAA1D,aAAA;MAAA2D,KAAA,EAAsBvC,MAAA;MAAAD,QAAA,EACpBuC,IAAA,CAAAzD,oBAAA;QAAA0D,KAAA;UAAAzD,eAAA,EAAgDuC,SAAA;UAAAtC;QAAA;QAAAgB;MAAA,C;;;;;;;;;SADlDsC,G;CAMJ;AAEA,OAAO,MAAMG,gBAAA,GAAmBA,CAAA,KAAMpE,GAAA,CAAIS,oBAAA;AAE1C;;;;AAIA,OAAO,MAAM4D,SAAA,GAAYA,CAAA,KAAcrE,GAAA,CAAIQ,aAAA;AApGsD,SAAAqD,MAAAvC,GAAA;EAAA,OAqEZA,GAAA,CAAA6C,KAAA;AAAA","ignoreList":[]}
+{"version":3,"file":"index.js","names":["formatAdminURL","React","createContext","use","useEffect","useRef","useState","findLocaleFromCode","useAuth","useConfig","useSearchParams","useRouteTransition","LocaleContext","LocaleLoadingContext","localeIsLoading","setLocaleIsLoading","_","undefined","fetchPreferences","key","baseURL","fetch","credentials","headers","method","then","res","json","LocaleProvider","children","locale","initialLocaleFromPrefs","config","localization","routes","api","apiRoute","user","isTransitioning","defaultLocale","localeFromParams","get","setLocale","locales","length","code","isLoading","prevLocale","current","fetchURL","path","resetLocale","id","localeToUse","value","newLocale","_jsx","useLocaleLoading","useLocale"],"sources":["../../../src/providers/Locale/index.tsx"],"sourcesContent":["'use client'\n\nimport type { Locale } from 'payload'\n\nimport { formatAdminURL } from 'payload/shared'\nimport React, { createContext, use, useEffect, useRef, useState } from 'react'\n\nimport { findLocaleFromCode } from '../../utilities/findLocaleFromCode.js'\nimport { useAuth } from '../Auth/index.js'\nimport { useConfig } from '../Config/index.js'\nimport { useSearchParams } from '../RouterAdapter/index.js'\nimport { useRouteTransition } from '../RouteTransition/index.js'\n\nconst LocaleContext = createContext<Locale | null>(null)\n\nexport const LocaleLoadingContext = createContext({\n  localeIsLoading: false,\n  setLocaleIsLoading: (_: boolean) => undefined,\n})\n\nconst fetchPreferences = async <T extends Record<string, unknown> | string>(\n  key: string,\n  baseURL: string,\n): Promise<{ id: string; value: T }> =>\n  await fetch(`${baseURL}/payload-preferences/${key}`, {\n    credentials: 'include',\n    headers: {\n      'Content-Type': 'application/json',\n    },\n    method: 'GET',\n  })?.then((res) => res.json() as Promise<{ id: string; value: T }>)\n\nexport const LocaleProvider: React.FC<{ children?: React.ReactNode; locale?: Locale['code'] }> = ({\n  children,\n  /**\n    The `locale` prop originates from the root layout, which does not have access to search params\n    This component uses the `useSearchParams` hook to get the locale from the URL as precedence over this prop\n    This prop does not update as the user navigates the site, because the root layout does not re-render\n  */\n  locale: initialLocaleFromPrefs,\n}) => {\n  const {\n    config: {\n      localization = false,\n      routes: { api: apiRoute },\n    },\n  } = useConfig()\n\n  const { user } = useAuth()\n  const { isTransitioning } = useRouteTransition()\n\n  const defaultLocale = localization ? localization.defaultLocale : 'en'\n\n  const localeFromParams = useSearchParams().get('locale')\n\n  const [locale, setLocale] = React.useState<Locale | null>(() => {\n    if (!localization || (localization && !localization.locales.length)) {\n      return null\n    }\n\n    return (\n      findLocaleFromCode(localization, localeFromParams) ||\n      findLocaleFromCode(localization, initialLocaleFromPrefs) ||\n      findLocaleFromCode(localization, defaultLocale) ||\n      findLocaleFromCode(localization, localization.locales[0].code)\n    )\n  })\n\n  const [isLoading, setLocaleIsLoading] = useState(false)\n\n  const prevLocale = useRef<Locale | null>(locale)\n\n  useEffect(() => {\n    // Keep fields disabled until the new locale's document state finishes loading.\n    if (locale?.code !== prevLocale.current?.code && !isTransitioning) {\n      setLocaleIsLoading(false)\n      prevLocale.current = locale\n    }\n  }, [isTransitioning, locale])\n\n  const fetchURL = formatAdminURL({\n    apiRoute,\n    path: '',\n  })\n\n  useEffect(() => {\n    /**\n     * This effect should only run when `localeFromParams` changes, i.e. when the user clicks an anchor link\n     * The root layout, which sends the initial locale from prefs, will not re-render as the user navigates the site\n     * For this reason, we need to fetch the locale from prefs if the search params clears the `locale` query param\n     */\n    async function resetLocale() {\n      if (localization && user?.id) {\n        const localeToUse =\n          localeFromParams ||\n          (await fetchPreferences<Locale['code']>('locale', fetchURL)?.then((res) => res.value))\n\n        const newLocale =\n          findLocaleFromCode(localization, localeToUse) ||\n          findLocaleFromCode(localization, defaultLocale) ||\n          findLocaleFromCode(localization, localization?.locales?.[0]?.code)\n\n        if (newLocale) {\n          setLocale(newLocale)\n        }\n      }\n    }\n\n    void resetLocale()\n  }, [defaultLocale, localization, fetchURL, localeFromParams, user?.id])\n\n  return (\n    <LocaleContext value={locale}>\n      <LocaleLoadingContext value={{ localeIsLoading: isLoading, setLocaleIsLoading }}>\n        {children}\n      </LocaleLoadingContext>\n    </LocaleContext>\n  )\n}\n\nexport const useLocaleLoading = () => use(LocaleLoadingContext)\n\nexport const useLocale = (): Locale | null => use(LocaleContext)\n"],"mappings":"AAAA;;;AAIA,SAASA,cAAc,QAAQ;AAC/B,OAAOC,KAAA,IAASC,aAAa,EAAEC,GAAG,EAAEC,SAAS,EAAEC,MAAM,EAAEC,QAAQ,QAAQ;AAEvE,SAASC,kBAAkB,QAAQ;AACnC,SAASC,OAAO,QAAQ;AACxB,SAASC,SAAS,QAAQ;AAC1B,SAASC,eAAe,QAAQ;AAChC,SAASC,kBAAkB,QAAQ;AAEnC,MAAMC,aAAA,gBAAgBV,aAAA,CAA6B;AAEnD,OAAO,MAAMW,oBAAA,gBAAuBX,aAAA,CAAc;EAChDY,eAAA,EAAiB;EACjBC,kBAAA,EAAqBC,CAAA,IAAeC;AACtC;AAEA,MAAMC,gBAAA,GAAmB,MAAAA,CACvBC,GAAA,EACAC,OAAA,KAEA,MAAMC,KAAA,CAAM,GAAGD,OAAA,wBAA+BD,GAAA,EAAK,EAAE;EACnDG,WAAA,EAAa;EACbC,OAAA,EAAS;IACP,gBAAgB;EAClB;EACAC,MAAA,EAAQ;AACV,IAAIC,IAAA,CAAMC,GAAA,IAAQA,GAAA,CAAIC,IAAI;AAE5B,OAAO,MAAMC,cAAA,GAAoFA,CAAC;EAChGC,QAAQ;EACR;;;;;EAKAC,MAAA,EAAQC;AAAsB,CAC/B;EACC,MAAM;IACJC,MAAA,EAAQ;MACNC,YAAA,GAAe,KAAK;MACpBC,MAAA,EAAQ;QAAEC,GAAA,EAAKC;MAAQ;IAAE;EAC1B,CACF,GAAG3B,SAAA;EAEJ,MAAM;IAAE4B;EAAI,CAAE,GAAG7B,OAAA;EACjB,MAAM;IAAE8B;EAAe,CAAE,GAAG3B,kBAAA;EAE5B,MAAM4B,aAAA,GAAgBN,YAAA,GAAeA,YAAA,CAAaM,aAAa,GAAG;EAElE,MAAMC,gBAAA,GAAmB9B,eAAA,GAAkB+B,GAAG,CAAC;EAE/C,MAAM,CAACX,MAAA,EAAQY,SAAA,CAAU,GAAGzC,KAAA,CAAMK,QAAQ,CAAgB;IACxD,IAAI,CAAC2B,YAAA,IAAiBA,YAAA,IAAgB,CAACA,YAAA,CAAaU,OAAO,CAACC,MAAM,EAAG;MACnE,OAAO;IACT;IAEA,OACErC,kBAAA,CAAmB0B,YAAA,EAAcO,gBAAA,KACjCjC,kBAAA,CAAmB0B,YAAA,EAAcF,sBAAA,KACjCxB,kBAAA,CAAmB0B,YAAA,EAAcM,aAAA,KACjChC,kBAAA,CAAmB0B,YAAA,EAAcA,YAAA,CAAaU,OAAO,CAAC,EAAE,CAACE,IAAI;EAEjE;EAEA,MAAM,CAACC,SAAA,EAAW/B,kBAAA,CAAmB,GAAGT,QAAA,CAAS;EAEjD,MAAMyC,UAAA,GAAa1C,MAAA,CAAsByB,MAAA;EAEzC1B,SAAA,CAAU;IACR;IACA,IAAI0B,MAAA,EAAQe,IAAA,KAASE,UAAA,CAAWC,OAAO,EAAEH,IAAA,IAAQ,CAACP,eAAA,EAAiB;MACjEvB,kBAAA,CAAmB;MACnBgC,UAAA,CAAWC,OAAO,GAAGlB,MAAA;IACvB;EACF,GAAG,CAACQ,eAAA,EAAiBR,MAAA,CAAO;EAE5B,MAAMmB,QAAA,GAAWjD,cAAA,CAAe;IAC9BoC,QAAA;IACAc,IAAA,EAAM;EACR;EAEA9C,SAAA,CAAU;IACR;;;;;IAKA,eAAe+C,YAAA;MACb,IAAIlB,YAAA,IAAgBI,IAAA,EAAMe,EAAA,EAAI;QAC5B,MAAMC,WAAA,GACJb,gBAAA,KACC,MAAMtB,gBAAA,CAAiC,UAAU+B,QAAA,GAAWxB,IAAA,CAAMC,GAAA,IAAQA,GAAA,CAAI4B,KAAK;QAEtF,MAAMC,SAAA,GACJhD,kBAAA,CAAmB0B,YAAA,EAAcoB,WAAA,KACjC9C,kBAAA,CAAmB0B,YAAA,EAAcM,aAAA,KACjChC,kBAAA,CAAmB0B,YAAA,EAAcA,YAAA,EAAcU,OAAA,GAAU,EAAE,EAAEE,IAAA;QAE/D,IAAIU,SAAA,EAAW;UACbb,SAAA,CAAUa,SAAA;QACZ;MACF;IACF;IAEA,KAAKJ,WAAA;EACP,GAAG,CAACZ,aAAA,EAAeN,YAAA,EAAcgB,QAAA,EAAUT,gBAAA,EAAkBH,IAAA,EAAMe,EAAA,CAAG;EAEtE,oBACEI,IAAA,CAAC5C,aAAA;IAAc0C,KAAA,EAAOxB,MAAA;cACpB,aAAA0B,IAAA,CAAC3C,oBAAA;MAAqByC,KAAA,EAAO;QAAExC,eAAA,EAAiBgC,SAAA;QAAW/B;MAAmB;gBAC3Ec;;;AAIT;AAEA,OAAO,MAAM4B,gBAAA,GAAmBA,CAAA,KAAMtD,GAAA,CAAIU,oBAAA;AAE1C,OAAO,MAAM6C,SAAA,GAAYA,CAAA,KAAqBvD,GAAA,CAAIS,aAAA","ignoreList":[]}

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

@@ -46,7 +46,7 @@ export const ProgressBar = () => {
         }
       } else {
         shouldDelayProgress.current = true;
-        setProgressToShow(1);
+        setProgressToShow(_temp);
         clearTimerID = setTimeout(() => {
           setProgressToShow(null);
         }, transitionDuration * 2);
@@ -101,4 +101,7 @@ export const ProgressBar = () => {
   }
   return null;
 };
+function _temp(currentProgress) {
+  return currentProgress === null ? null : 1;
+}
 //# sourceMappingURL=index.js.map

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","clearTimeout","t2","t3","filter","Boolean","t4","join","t5","_jsx","className","style","children","width"],"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(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,EAAkB;QAIlBK,YAAA,CAAAA,CAAA,CAAeA,aAAA,CAAAA,EAAA,CAAAA;UACbL,iBAAA,KAAkB;QAAA,GACjBR,kBAAA,IAAqB;MAFxB;MAAA;QAMAgB,YAAA,CAAaH,YAAA;QACbG,YAAA,CAAaF,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,MAAAU,EAAA,GAAAV,cAAA,MAAmB,IAAK,GAAAN,SAAA,YAAwB;IAAA,IAAAiB,EAAA;IAAA,IAAAd,CAAA,QAAAa,EAAA;MAA5DC,EAAA,IAAAjB,SAAA,EAAYgB,EAAgD,EAAAE,MAAA,CAAAC,OAC7D;MAAAhB,CAAA,MAAAa,EAAA;MAAAb,CAAA,MAAAc,EAAA;IAAA;MAAAA,EAAA,GAAAd,CAAA;IAAA;IADC,MAAAiB,EAAA,GAAAH,EACD,CAAAI,IAAA,CACF;IAAA,IAAAC,EAAA;IAAA,IAAAnB,CAAA,QAAAG,cAAA,IAAAH,CAAA,QAAAiB,EAAA;MAHVE,EAAA,GAAAC,IAAA,CAAC;QAAAC,SAAA,EACYJ,EAEH;QAAAK,KAAA;UAAA,yBAGmB,GAAA1B,kBAAA;QAAyB;QAAA2B,QAAA,EAGpDH,IAAA,CAAC;UAAAC,SAAA,EACY,GAAAxB,SAAA,YAAwB;UAAAyB,KAAA;YAAAE,KAAA,EAE1B,GAAG,CAACrB,cAAA,KAAkB,OAAK;UAAM;QAAA,C;;;;;;;;WAZ9CgB,E;;;CAoBN","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","_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":[]}

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

@@ -0,0 +1,44 @@
+// @vitest-environment happy-dom
+import { act, createElement, useEffect } from 'react';
+import { createRoot } from 'react-dom/client';
+import { afterEach, beforeEach, expect, test, vi } from 'vitest';
+import { RouteTransitionProvider, useRouteTransition } from '../index.js';
+import { ProgressBar } from './index.js';
+let container;
+let root;
+beforeEach(() => {
+  globalThis.IS_REACT_ACT_ENVIRONMENT = true;
+  container = document.createElement('div');
+  document.body.appendChild(container);
+  root = createRoot(container);
+});
+afterEach(() => {
+  act(() => root.unmount());
+  container.remove();
+  vi.useRealTimers();
+});
+test('does not show progress for transitions that finish before the initial delay', async () => {
+  vi.useFakeTimers();
+  const FastTransition = () => {
+    const {
+      holdRouteTransition
+    } = useRouteTransition();
+    useEffect(() => {
+      const releaseRouteTransition = holdRouteTransition();
+      const timeout = setTimeout(releaseRouteTransition, 50);
+      return () => {
+        clearTimeout(timeout);
+        releaseRouteTransition();
+      };
+    }, [holdRouteTransition]);
+    return null;
+  };
+  await act(async () => {
+    root.render(createElement(RouteTransitionProvider, null, createElement(ProgressBar), createElement(FastTransition)));
+  });
+  await act(async () => {
+    await vi.advanceTimersByTimeAsync(50);
+  });
+  expect(container.querySelector('.progress-bar')).toBeNull();
+});
+//# sourceMappingURL=index.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.spec.js","names":["act","createElement","useEffect","createRoot","afterEach","beforeEach","expect","test","vi","RouteTransitionProvider","useRouteTransition","ProgressBar","container","root","globalThis","IS_REACT_ACT_ENVIRONMENT","document","body","appendChild","unmount","remove","useRealTimers","useFakeTimers","FastTransition","holdRouteTransition","releaseRouteTransition","timeout","setTimeout","clearTimeout","render","advanceTimersByTimeAsync","querySelector","toBeNull"],"sources":["../../../../src/providers/RouteTransition/ProgressBar/index.spec.ts"],"sourcesContent":["// @vitest-environment happy-dom\n\nimport { act, createElement, useEffect } from 'react'\nimport { createRoot, type Root } from 'react-dom/client'\nimport { afterEach, beforeEach, expect, test, vi } from 'vitest'\n\nimport { RouteTransitionProvider, useRouteTransition } from '../index.js'\nimport { ProgressBar } from './index.js'\n\nlet container: HTMLDivElement\nlet root: Root\n\nbeforeEach(() => {\n  globalThis.IS_REACT_ACT_ENVIRONMENT = true\n  container = document.createElement('div')\n  document.body.appendChild(container)\n  root = createRoot(container)\n})\n\nafterEach(() => {\n  act(() => root.unmount())\n  container.remove()\n  vi.useRealTimers()\n})\n\ntest('does not show progress for transitions that finish before the initial delay', async () => {\n  vi.useFakeTimers()\n\n  const FastTransition = () => {\n    const { holdRouteTransition } = useRouteTransition()\n\n    useEffect(() => {\n      const releaseRouteTransition = holdRouteTransition()\n      const timeout = setTimeout(releaseRouteTransition, 50)\n\n      return () => {\n        clearTimeout(timeout)\n        releaseRouteTransition()\n      }\n    }, [holdRouteTransition])\n\n    return null\n  }\n\n  await act(async () => {\n    root.render(\n      createElement(\n        RouteTransitionProvider,\n        null,\n        createElement(ProgressBar),\n        createElement(FastTransition),\n      ),\n    )\n  })\n\n  await act(async () => {\n    await vi.advanceTimersByTimeAsync(50)\n  })\n\n  expect(container.querySelector('.progress-bar')).toBeNull()\n})\n"],"mappings":"AAAA;AAEA,SAASA,GAAG,EAAEC,aAAa,EAAEC,SAAS,QAAQ;AAC9C,SAASC,UAAU,QAAmB;AACtC,SAASC,SAAS,EAAEC,UAAU,EAAEC,MAAM,EAAEC,IAAI,EAAEC,EAAE,QAAQ;AAExD,SAASC,uBAAuB,EAAEC,kBAAkB,QAAQ;AAC5D,SAASC,WAAW,QAAQ;AAE5B,IAAIC,SAAA;AACJ,IAAIC,IAAA;AAEJR,UAAA,CAAW;EACTS,UAAA,CAAWC,wBAAwB,GAAG;EACtCH,SAAA,GAAYI,QAAA,CAASf,aAAa,CAAC;EACnCe,QAAA,CAASC,IAAI,CAACC,WAAW,CAACN,SAAA;EAC1BC,IAAA,GAAOV,UAAA,CAAWS,SAAA;AACpB;AAEAR,SAAA,CAAU;EACRJ,GAAA,CAAI,MAAMa,IAAA,CAAKM,OAAO;EACtBP,SAAA,CAAUQ,MAAM;EAChBZ,EAAA,CAAGa,aAAa;AAClB;AAEAd,IAAA,CAAK,+EAA+E;EAClFC,EAAA,CAAGc,aAAa;EAEhB,MAAMC,cAAA,GAAiBA,CAAA;IACrB,MAAM;MAAEC;IAAmB,CAAE,GAAGd,kBAAA;IAEhCR,SAAA,CAAU;MACR,MAAMuB,sBAAA,GAAyBD,mBAAA;MAC/B,MAAME,OAAA,GAAUC,UAAA,CAAWF,sBAAA,EAAwB;MAEnD,OAAO;QACLG,YAAA,CAAaF,OAAA;QACbD,sBAAA;MACF;IACF,GAAG,CAACD,mBAAA,CAAoB;IAExB,OAAO;EACT;EAEA,MAAMxB,GAAA,CAAI;IACRa,IAAA,CAAKgB,MAAM,CACT5B,aAAA,CACEQ,uBAAA,EACA,MACAR,aAAA,CAAcU,WAAA,GACdV,aAAA,CAAcsB,cAAA;EAGpB;EAEA,MAAMvB,GAAA,CAAI;IACR,MAAMQ,EAAA,CAAGsB,wBAAwB,CAAC;EACpC;EAEAxB,MAAA,CAAOM,SAAA,CAAUmB,aAAa,CAAC,kBAAkBC,QAAQ;AAC3D","ignoreList":[]}

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

@@ -21,8 +21,8 @@ type RouteTransitionProps = {
 };
 type StartRouteTransition = (callback?: () => void) => void;
 type RouteTransitionContextValue = {
-    /** Keeps the route transition active until the returned function is called. */
-    beginRouteTransition: () => () => void;
+    /** Keeps the transition active until the returned release function is called. */
+    holdRouteTransition: () => () => void;
     isTransitioning: boolean;
     startRouteTransition: StartRouteTransition;
     transitionProgress: number;

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,+EAA+E;IAC/E,oBAAoB,EAAE,MAAM,MAAM,IAAI,CAAA;IACtC,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,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"}

package/dist/providers/RouteTransition/index.js

@@ -25,9 +25,9 @@ export const RouteTransitionProvider = t0 => {
     children
   } = t0;
   const [isOptimisticallyTransitioning, setIsOptimisticallyTransitioning] = useOptimistic(false);
-  const [activeRouteTransitions, setActiveRouteTransitions] = React.useState(0);
+  const [activeRouteTransitionHolds, setActiveRouteTransitionHolds] = React.useState(0);
   const [transitionProgress, setTransitionProgress] = React.useState(0);
-  const isTransitioning = isOptimisticallyTransitioning || activeRouteTransitions > 0;
+  const isTransitioning = isOptimisticallyTransitioning || activeRouteTransitionHolds > 0;
   const transitionProgressRef = useRef(transitionProgress);
   const timerID = useRef(null);
   let t1;
@@ -86,26 +86,26 @@ export const RouteTransitionProvider = t0 => {
   let t5;
   if ($[6] === Symbol.for("react.memo_cache_sentinel")) {
     t5 = () => {
-      let hasEnded = false;
-      setActiveRouteTransitions(_temp);
+      let hasReleased = false;
+      setActiveRouteTransitionHolds(_temp);
       return () => {
-        if (hasEnded) {
+        if (hasReleased) {
           return;
         }
-        hasEnded = true;
-        setActiveRouteTransitions(_temp2);
+        hasReleased = true;
+        setActiveRouteTransitionHolds(_temp2);
       };
     };
     $[6] = t5;
   } else {
     t5 = $[6];
   }
-  const beginRouteTransition = t5;
+  const holdRouteTransition = t5;
   let t6;
   if ($[7] !== children || $[8] !== isTransitioning || $[9] !== startRouteTransition || $[10] !== transitionProgress) {
     t6 = _jsx(RouteTransitionContext, {
       value: {
-        beginRouteTransition,
+        holdRouteTransition,
         isTransitioning,
         startRouteTransition,
         transitionProgress
@@ -123,7 +123,7 @@ export const RouteTransitionProvider = t0 => {
   return t6;
 };
 const RouteTransitionContext = /*#__PURE__*/React.createContext({
-  beginRouteTransition: () => () => undefined,
+  holdRouteTransition: () => () => undefined,
   isTransitioning: false,
   // Default implementation: just call the callback directly (no transition animation)
   startRouteTransition: callback => {

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["c","_c","React","startTransition","useCallback","useEffect","useOptimistic","useRef","RouteTransitionProvider","t0","$","children","isOptimisticallyTransitioning","setIsOptimisticallyTransitioning","activeRouteTransitions","setActiveRouteTransitions","useState","transitionProgress","setTransitionProgress","isTransitioning","transitionProgressRef","timerID","t1","Symbol","for","current","setInterval","newProgress","Math","random","pow","log","initiateProgress","t2","t3","clearInterval","t4","callback","startRouteTransition","t5","hasEnded","_temp","_temp2","beginRouteTransition","t6","_jsx","RouteTransitionContext","value","createContext","undefined","useRouteTransition","use","count","count_0","max"],"sources":["../../../src/providers/RouteTransition/index.tsx"],"sourcesContent":["'use client'\nimport React, { startTransition, useCallback, useEffect, useOptimistic, useRef } from 'react'\n\n/**\n * Route transitions are useful in showing immediate visual feedback to the user when navigating between pages. This is especially useful on slow networks when navigating to data heavy or process intensive pages.\n * To use route transitions, place the `RouteTransitionProvider` at the root of your application, outside of the `ProgressBar` component.\n * To trigger a route transition, use the `Link` component from `@payloadcms/ui`,\n * or wrap a callback function with the `startRouteTransition` method.\n * To gain access to the `RouteTransitionContext`, call the `useRouteTransition` hook in your component.\n * @returns A context provider with methods and state for transitioning between routes, including `isTransitioning`, `startRouteTransition`, and `transitionProgress`.\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 * )\n */\nexport const RouteTransitionProvider: React.FC<RouteTransitionProps> = ({ children }) => {\n  const [isOptimisticallyTransitioning, setIsOptimisticallyTransitioning] = useOptimistic(false)\n  const [activeRouteTransitions, setActiveRouteTransitions] = React.useState(0)\n  const [transitionProgress, setTransitionProgress] = React.useState<number>(0)\n  const isTransitioning = isOptimisticallyTransitioning || activeRouteTransitions > 0\n\n  const transitionProgressRef = useRef(transitionProgress)\n\n  const timerID = useRef(null)\n\n  const initiateProgress = useCallback(() => {\n    timerID.current = setInterval(() => {\n      // randomly update progress using an exponential curve\n      // cap the progress to ensure it never fully reaches completion\n      // accelerate quickly then decelerate slowly\n      const maxProgress = 0.93\n      const jumpFactor = 0.2 // lower to reduce jumps in progress\n      const growthFactor = 0.75 // adjust to control acceleration\n      const slowdownFactor = 0.75 // adjust to control deceleration\n\n      const newProgress =\n        transitionProgressRef.current +\n        (maxProgress - transitionProgressRef.current) *\n          Math.random() *\n          jumpFactor *\n          Math.pow(Math.log(1 + (1 - transitionProgressRef.current) * growthFactor), slowdownFactor)\n\n      setTransitionProgress(newProgress)\n      transitionProgressRef.current = newProgress\n    }, 250) // every n ms, update progress\n  }, [])\n\n  useEffect(() => {\n    setTransitionProgress(0)\n    transitionProgressRef.current = 0\n\n    if (isTransitioning) {\n      initiateProgress()\n    } else {\n      if (timerID.current) {\n        clearInterval(timerID.current)\n      }\n    }\n  }, [isTransitioning, initiateProgress])\n\n  const startRouteTransition: StartRouteTransition = useCallback(\n    (callback?: () => void) => {\n      startTransition(() => {\n        setIsOptimisticallyTransitioning(true)\n\n        if (typeof callback === 'function') {\n          callback()\n        }\n      })\n    },\n    [setIsOptimisticallyTransitioning],\n  )\n\n  const beginRouteTransition = useCallback(() => {\n    let hasEnded = false\n\n    setActiveRouteTransitions((count) => count + 1)\n\n    return () => {\n      if (hasEnded) {\n        return\n      }\n\n      hasEnded = true\n      setActiveRouteTransitions((count) => Math.max(0, count - 1))\n    }\n  }, [])\n\n  return (\n    <RouteTransitionContext\n      value={{\n        beginRouteTransition,\n        isTransitioning,\n        startRouteTransition,\n        transitionProgress,\n      }}\n    >\n      {children}\n    </RouteTransitionContext>\n  )\n}\n\ntype RouteTransitionProps = {\n  children: React.ReactNode\n}\n\ntype StartRouteTransition = (callback?: () => void) => void\n\ntype RouteTransitionContextValue = {\n  /** Keeps the route transition active until the returned function is called. */\n  beginRouteTransition: () => () => void\n  isTransitioning: boolean\n  startRouteTransition: StartRouteTransition\n  transitionProgress: number\n}\n\nconst RouteTransitionContext = React.createContext<RouteTransitionContextValue>({\n  beginRouteTransition: () => () => undefined,\n  isTransitioning: false,\n  // Default implementation: just call the callback directly (no transition animation)\n  startRouteTransition: (callback) => {\n    if (typeof callback === 'function') {\n      callback()\n    }\n  },\n  transitionProgress: 0,\n})\n\n/**\n * Use this hook to access the `RouteTransitionContext` provided by the `RouteTransitionProvider`.\n * To start a transition, fire the `startRouteTransition` method with a provided callback to run while the transition takes place.\n * @returns The `RouteTransitionContext` needed for transitioning between routes, including `isTransitioning`, `startRouteTransition`, and `transitionProgress`.\n * @example\n * 'use client'\n * import React, { useCallback } from 'react'\n * import { useTransition, useRouter } from '@payloadcms/ui'\n *\n * const MyComponent: React.FC = () => {\n *   const router = useRouter()\n *   const { startRouteTransition } = useRouteTransition()\n *\n *   const redirectSomewhere = useCallback(() => {\n *     startRouteTransition(() => router.push('/somewhere'))\n *   }, [startRouteTransition, router])\n *\n *   // ...\n * }\n */\nexport const useRouteTransition = () => React.use(RouteTransitionContext)\n"],"mappings":"AAAA;;AAAA,SAAAA,CAAA,IAAAC,EAAA;;AACA,OAAOC,KAAA,IAASC,eAAe,EAAEC,WAAW,EAAEC,SAAS,EAAEC,aAAa,EAAEC,MAAM,QAAQ;AAEtF;;;;;;;;;;;;;;;;AAgBA,OAAO,MAAMC,uBAAA,GAA0DC,EAAA;EAAA,MAAAC,CAAA,GAAAT,EAAA;EAAC;IAAAU;EAAA,IAAAF,EAAY;EAClF,OAAAG,6BAAA,EAAAC,gCAAA,IAA0EP,aAAA,MAAc;EACxF,OAAAQ,sBAAA,EAAAC,yBAAA,IAA4Db,KAAA,CAAAc,QAAA,EAAe;EAC3E,OAAAC,kBAAA,EAAAC,qBAAA,IAAoDhB,KAAA,CAAAc,QAAA,EAAuB;EAC3E,MAAAG,eAAA,GAAwBP,6BAAA,IAAiCE,sBAAA,IAAyB;EAElF,MAAAM,qBAAA,GAA8Bb,MAAA,CAAOU,kBAAA;EAErC,MAAAI,OAAA,GAAgBd,MAAA,KAAO;EAAA,IAAAe,EAAA;EAAA,IAAAZ,CAAA,QAAAa,MAAA,CAAAC,GAAA;IAEcF,EAAA,GAAAA,CAAA;MACnCD,OAAA,CAAAI,OAAA,GAAkBC,WAAA;QAShB,MAAAC,WAAA,GACEP,qBAAA,CAAAK,OAAA,GACA,CAAC,OAAcL,qBAAA,CAAAK,OAA6B,IAC1CG,IAAA,CAAAC,MAAA,CAAW,OACX,GACAD,IAAA,CAAAE,GAAA,CAASF,IAAA,CAAAG,GAAA,CAAS,IAAI,CAAC,IAAIX,qBAAA,CAAAK,OAA6B,QAAI,OAAe;QAE/EP,qBAAA,CAAsBS,WAAA;QACtBP,qBAAA,CAAAK,OAAA,GAAgCE,WAAA;MAAA,MAC/B;IAAA;IACLjB,CAAA,MAAAY,EAAA;EAAA;IAAAA,EAAA,GAAAZ,CAAA;EAAA;EApBA,MAAAsB,gBAAA,GAAyBV,EAoBpB;EAAA,IAAAW,EAAA;EAAA,IAAAC,EAAA;EAAA,IAAAxB,CAAA,QAAAS,eAAA;IAEKc,EAAA,GAAAA,CAAA;MACRf,qBAAA,EAAsB;MACtBE,qBAAA,CAAAK,OAAA;MAAA,IAEIN,eAAA;QACFa,gBAAA;MAAA;QAAA,IAEIX,OAAA,CAAAI,OAAA;UACFU,aAAA,CAAcd,OAAA,CAAAI,OAAe;QAAA;MAAA;IAAA;IAGhCS,EAAA,IAACf,eAAA,EAAiBa,gBAAA;IAAiBtB,CAAA,MAAAS,eAAA;IAAAT,CAAA,MAAAuB,EAAA;IAAAvB,CAAA,MAAAwB,EAAA;EAAA;IAAAD,EAAA,GAAAvB,CAAA;IAAAwB,EAAA,GAAAxB,CAAA;EAAA;EAXtCL,SAAA,CAAU4B,EAWV,EAAGC,EAAmC;EAAA,IAAAE,EAAA;EAAA,IAAA1B,CAAA,QAAAG,gCAAA;IAGpCuB,EAAA,GAAAC,QAAA;MACElC,eAAA;QACEU,gCAAA,KAAiC;QAAA,IAE7B,OAAOwB,QAAA,KAAa;UACtBA,QAAA;QAAA;MAAA,CAEJ;IAAA;IACF3B,CAAA,MAAAG,gCAAA;IAAAH,CAAA,MAAA0B,EAAA;EAAA;IAAAA,EAAA,GAAA1B,CAAA;EAAA;EATF,MAAA4B,oBAAA,GAAmDF,EAUf;EAAA,IAAAG,EAAA;EAAA,IAAA7B,CAAA,QAAAa,MAAA,CAAAC,GAAA;IAGKe,EAAA,GAAAA,CAAA;MACvC,IAAAC,QAAA;MAEAzB,yBAAA,CAAA0B,KAA6C;MAAA;QAAA,IAGvCD,QAAA;UAAA;QAAA;QAIJA,QAAA,CAAAA,CAAA,CAAAA,IAAA;QACAzB,yBAAA,CAAA2B,MAAyD;MAAA;IAAA;IAE7DhC,CAAA,MAAA6B,EAAA;EAAA;IAAAA,EAAA,GAAA7B,CAAA;EAAA;EAbA,MAAAiC,oBAAA,GAA6BJ,EAaxB;EAAA,IAAAK,EAAA;EAAA,IAAAlC,CAAA,QAAAC,QAAA,IAAAD,CAAA,QAAAS,eAAA,IAAAT,CAAA,QAAA4B,oBAAA,IAAA5B,CAAA,SAAAO,kBAAA;IAGH2B,EAAA,GAAAC,IAAA,CAAAC,sBAAA;MAAAC,KAAA;QAAAJ,oBAAA;QAAAxB,eAAA;QAAAmB,oBAAA;QAAArB;MAAA;MAAAN;IAAA,C;;;;;;;;;SAAAiC,E;CAWJ;AAgBA,MAAME,sBAAA,gBAAyB5C,KAAA,CAAM8C,aAAa,CAA8B;EAC9EL,oBAAA,EAAsBA,CAAA,KAAM,MAAMM,SAAA;EAClC9B,eAAA,EAAiB;EACjB;EACAmB,oBAAA,EAAuBD,QAAA;IACrB,IAAI,OAAOA,QAAA,KAAa,YAAY;MAClCA,QAAA;IACF;EACF;EACApB,kBAAA,EAAoB;AACtB;AAEA;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,MAAMiC,kBAAA,GAAqBA,CAAA,KAAMhD,KAAA,CAAMiD,GAAG,CAACL,sBAAA;AArIqB,SAAAL,MAAAW,KAAA;EAAA,OA6D9BA,KAAA,IAAQ;AAAA;AA7DsB,SAAAV,OAAAW,OAAA;EAAA,OAqE5BzB,IAAA,CAAA0B,GAAA,IAAYF,OAAA,IAAQ;AAAA","ignoreList":[]}
+{"version":3,"file":"index.js","names":["c","_c","React","startTransition","useCallback","useEffect","useOptimistic","useRef","RouteTransitionProvider","t0","$","children","isOptimisticallyTransitioning","setIsOptimisticallyTransitioning","activeRouteTransitionHolds","setActiveRouteTransitionHolds","useState","transitionProgress","setTransitionProgress","isTransitioning","transitionProgressRef","timerID","t1","Symbol","for","current","setInterval","newProgress","Math","random","pow","log","initiateProgress","t2","t3","clearInterval","t4","callback","startRouteTransition","t5","hasReleased","_temp","_temp2","holdRouteTransition","t6","_jsx","RouteTransitionContext","value","createContext","undefined","useRouteTransition","use","count","count_0","max"],"sources":["../../../src/providers/RouteTransition/index.tsx"],"sourcesContent":["'use client'\nimport React, { startTransition, useCallback, useEffect, useOptimistic, useRef } from 'react'\n\n/**\n * Route transitions are useful in showing immediate visual feedback to the user when navigating between pages. This is especially useful on slow networks when navigating to data heavy or process intensive pages.\n * To use route transitions, place the `RouteTransitionProvider` at the root of your application, outside of the `ProgressBar` component.\n * To trigger a route transition, use the `Link` component from `@payloadcms/ui`,\n * or wrap a callback function with the `startRouteTransition` method.\n * To gain access to the `RouteTransitionContext`, call the `useRouteTransition` hook in your component.\n * @returns A context provider with methods and state for transitioning between routes, including `isTransitioning`, `startRouteTransition`, and `transitionProgress`.\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 * )\n */\nexport const RouteTransitionProvider: React.FC<RouteTransitionProps> = ({ children }) => {\n  const [isOptimisticallyTransitioning, setIsOptimisticallyTransitioning] = useOptimistic(false)\n  const [activeRouteTransitionHolds, setActiveRouteTransitionHolds] = React.useState(0)\n  const [transitionProgress, setTransitionProgress] = React.useState<number>(0)\n  const isTransitioning = isOptimisticallyTransitioning || activeRouteTransitionHolds > 0\n\n  const transitionProgressRef = useRef(transitionProgress)\n\n  const timerID = useRef(null)\n\n  const initiateProgress = useCallback(() => {\n    timerID.current = setInterval(() => {\n      // randomly update progress using an exponential curve\n      // cap the progress to ensure it never fully reaches completion\n      // accelerate quickly then decelerate slowly\n      const maxProgress = 0.93\n      const jumpFactor = 0.2 // lower to reduce jumps in progress\n      const growthFactor = 0.75 // adjust to control acceleration\n      const slowdownFactor = 0.75 // adjust to control deceleration\n\n      const newProgress =\n        transitionProgressRef.current +\n        (maxProgress - transitionProgressRef.current) *\n          Math.random() *\n          jumpFactor *\n          Math.pow(Math.log(1 + (1 - transitionProgressRef.current) * growthFactor), slowdownFactor)\n\n      setTransitionProgress(newProgress)\n      transitionProgressRef.current = newProgress\n    }, 250) // every n ms, update progress\n  }, [])\n\n  useEffect(() => {\n    setTransitionProgress(0)\n    transitionProgressRef.current = 0\n\n    if (isTransitioning) {\n      initiateProgress()\n    } else {\n      if (timerID.current) {\n        clearInterval(timerID.current)\n      }\n    }\n  }, [isTransitioning, initiateProgress])\n\n  const startRouteTransition: StartRouteTransition = useCallback(\n    (callback?: () => void) => {\n      startTransition(() => {\n        setIsOptimisticallyTransitioning(true)\n\n        if (typeof callback === 'function') {\n          callback()\n        }\n      })\n    },\n    [setIsOptimisticallyTransitioning],\n  )\n\n  const holdRouteTransition = useCallback(() => {\n    let hasReleased = false\n\n    setActiveRouteTransitionHolds((count) => count + 1)\n\n    return () => {\n      if (hasReleased) {\n        return\n      }\n\n      hasReleased = true\n      setActiveRouteTransitionHolds((count) => Math.max(0, count - 1))\n    }\n  }, [])\n\n  return (\n    <RouteTransitionContext\n      value={{\n        holdRouteTransition,\n        isTransitioning,\n        startRouteTransition,\n        transitionProgress,\n      }}\n    >\n      {children}\n    </RouteTransitionContext>\n  )\n}\n\ntype RouteTransitionProps = {\n  children: React.ReactNode\n}\n\ntype StartRouteTransition = (callback?: () => void) => void\n\ntype RouteTransitionContextValue = {\n  /** Keeps the transition active until the returned release function is called. */\n  holdRouteTransition: () => () => void\n  isTransitioning: boolean\n  startRouteTransition: StartRouteTransition\n  transitionProgress: number\n}\n\nconst RouteTransitionContext = React.createContext<RouteTransitionContextValue>({\n  holdRouteTransition: () => () => undefined,\n  isTransitioning: false,\n  // Default implementation: just call the callback directly (no transition animation)\n  startRouteTransition: (callback) => {\n    if (typeof callback === 'function') {\n      callback()\n    }\n  },\n  transitionProgress: 0,\n})\n\n/**\n * Use this hook to access the `RouteTransitionContext` provided by the `RouteTransitionProvider`.\n * To start a transition, fire the `startRouteTransition` method with a provided callback to run while the transition takes place.\n * @returns The `RouteTransitionContext` needed for transitioning between routes, including `isTransitioning`, `startRouteTransition`, and `transitionProgress`.\n * @example\n * 'use client'\n * import React, { useCallback } from 'react'\n * import { useTransition, useRouter } from '@payloadcms/ui'\n *\n * const MyComponent: React.FC = () => {\n *   const router = useRouter()\n *   const { startRouteTransition } = useRouteTransition()\n *\n *   const redirectSomewhere = useCallback(() => {\n *     startRouteTransition(() => router.push('/somewhere'))\n *   }, [startRouteTransition, router])\n *\n *   // ...\n * }\n */\nexport const useRouteTransition = () => React.use(RouteTransitionContext)\n"],"mappings":"AAAA;;AAAA,SAAAA,CAAA,IAAAC,EAAA;;AACA,OAAOC,KAAA,IAASC,eAAe,EAAEC,WAAW,EAAEC,SAAS,EAAEC,aAAa,EAAEC,MAAM,QAAQ;AAEtF;;;;;;;;;;;;;;;;AAgBA,OAAO,MAAMC,uBAAA,GAA0DC,EAAA;EAAA,MAAAC,CAAA,GAAAT,EAAA;EAAC;IAAAU;EAAA,IAAAF,EAAY;EAClF,OAAAG,6BAAA,EAAAC,gCAAA,IAA0EP,aAAA,MAAc;EACxF,OAAAQ,0BAAA,EAAAC,6BAAA,IAAoEb,KAAA,CAAAc,QAAA,EAAe;EACnF,OAAAC,kBAAA,EAAAC,qBAAA,IAAoDhB,KAAA,CAAAc,QAAA,EAAuB;EAC3E,MAAAG,eAAA,GAAwBP,6BAAA,IAAiCE,0BAAA,IAA6B;EAEtF,MAAAM,qBAAA,GAA8Bb,MAAA,CAAOU,kBAAA;EAErC,MAAAI,OAAA,GAAgBd,MAAA,KAAO;EAAA,IAAAe,EAAA;EAAA,IAAAZ,CAAA,QAAAa,MAAA,CAAAC,GAAA;IAEcF,EAAA,GAAAA,CAAA;MACnCD,OAAA,CAAAI,OAAA,GAAkBC,WAAA;QAShB,MAAAC,WAAA,GACEP,qBAAA,CAAAK,OAAA,GACA,CAAC,OAAcL,qBAAA,CAAAK,OAA6B,IAC1CG,IAAA,CAAAC,MAAA,CAAW,OACX,GACAD,IAAA,CAAAE,GAAA,CAASF,IAAA,CAAAG,GAAA,CAAS,IAAI,CAAC,IAAIX,qBAAA,CAAAK,OAA6B,QAAI,OAAe;QAE/EP,qBAAA,CAAsBS,WAAA;QACtBP,qBAAA,CAAAK,OAAA,GAAgCE,WAAA;MAAA,MAC/B;IAAA;IACLjB,CAAA,MAAAY,EAAA;EAAA;IAAAA,EAAA,GAAAZ,CAAA;EAAA;EApBA,MAAAsB,gBAAA,GAAyBV,EAoBpB;EAAA,IAAAW,EAAA;EAAA,IAAAC,EAAA;EAAA,IAAAxB,CAAA,QAAAS,eAAA;IAEKc,EAAA,GAAAA,CAAA;MACRf,qBAAA,EAAsB;MACtBE,qBAAA,CAAAK,OAAA;MAAA,IAEIN,eAAA;QACFa,gBAAA;MAAA;QAAA,IAEIX,OAAA,CAAAI,OAAA;UACFU,aAAA,CAAcd,OAAA,CAAAI,OAAe;QAAA;MAAA;IAAA;IAGhCS,EAAA,IAACf,eAAA,EAAiBa,gBAAA;IAAiBtB,CAAA,MAAAS,eAAA;IAAAT,CAAA,MAAAuB,EAAA;IAAAvB,CAAA,MAAAwB,EAAA;EAAA;IAAAD,EAAA,GAAAvB,CAAA;IAAAwB,EAAA,GAAAxB,CAAA;EAAA;EAXtCL,SAAA,CAAU4B,EAWV,EAAGC,EAAmC;EAAA,IAAAE,EAAA;EAAA,IAAA1B,CAAA,QAAAG,gCAAA;IAGpCuB,EAAA,GAAAC,QAAA;MACElC,eAAA;QACEU,gCAAA,KAAiC;QAAA,IAE7B,OAAOwB,QAAA,KAAa;UACtBA,QAAA;QAAA;MAAA,CAEJ;IAAA;IACF3B,CAAA,MAAAG,gCAAA;IAAAH,CAAA,MAAA0B,EAAA;EAAA;IAAAA,EAAA,GAAA1B,CAAA;EAAA;EATF,MAAA4B,oBAAA,GAAmDF,EAUf;EAAA,IAAAG,EAAA;EAAA,IAAA7B,CAAA,QAAAa,MAAA,CAAAC,GAAA;IAGIe,EAAA,GAAAA,CAAA;MACtC,IAAAC,WAAA;MAEAzB,6BAAA,CAAA0B,KAAiD;MAAA;QAAA,IAG3CD,WAAA;UAAA;QAAA;QAIJA,WAAA,CAAAA,CAAA,CAAAA,IAAA;QACAzB,6BAAA,CAAA2B,MAA6D;MAAA;IAAA;IAEjEhC,CAAA,MAAA6B,EAAA;EAAA;IAAAA,EAAA,GAAA7B,CAAA;EAAA;EAbA,MAAAiC,mBAAA,GAA4BJ,EAavB;EAAA,IAAAK,EAAA;EAAA,IAAAlC,CAAA,QAAAC,QAAA,IAAAD,CAAA,QAAAS,eAAA,IAAAT,CAAA,QAAA4B,oBAAA,IAAA5B,CAAA,SAAAO,kBAAA;IAGH2B,EAAA,GAAAC,IAAA,CAAAC,sBAAA;MAAAC,KAAA;QAAAJ,mBAAA;QAAAxB,eAAA;QAAAmB,oBAAA;QAAArB;MAAA;MAAAN;IAAA,C;;;;;;;;;SAAAiC,E;CAWJ;AAgBA,MAAME,sBAAA,gBAAyB5C,KAAA,CAAM8C,aAAa,CAA8B;EAC9EL,mBAAA,EAAqBA,CAAA,KAAM,MAAMM,SAAA;EACjC9B,eAAA,EAAiB;EACjB;EACAmB,oBAAA,EAAuBD,QAAA;IACrB,IAAI,OAAOA,QAAA,KAAa,YAAY;MAClCA,QAAA;IACF;EACF;EACApB,kBAAA,EAAoB;AACtB;AAEA;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,MAAMiC,kBAAA,GAAqBA,CAAA,KAAMhD,KAAA,CAAMiD,GAAG,CAACL,sBAAA;AArIqB,SAAAL,MAAAW,KAAA;EAAA,OA6D1BA,KAAA,IAAQ;AAAA;AA7DkB,SAAAV,OAAAW,OAAA;EAAA,OAqExBzB,IAAA,CAAA0B,GAAA,IAAYF,OAAA,IAAQ;AAAA","ignoreList":[]}