@payloadcms/ui 3.25.0 → 3.26.0

package/dist/providers/ListQuery/index.js

@@ -2,20 +2,22 @@
 
 import { jsx as _jsx } from "react/jsx-runtime";
 import { useRouter, useSearchParams } from 'next/navigation.js';
-import { isNumber } from 'payload/shared';
+import { isNumber, transformColumnsToSearchParams } from 'payload/shared';
 import * as qs from 'qs-esm';
-import React, { createContext, useCallback, useContext, useEffect, useMemo, useState } from 'react';
+import React, { useCallback, useEffect, useMemo, useState } from 'react';
 import { useListDrawerContext } from '../../elements/ListDrawer/Provider.js';
+import { useEffectEvent } from '../../hooks/useEffectEvent.js';
+import { useRouteTransition } from '../../providers/RouteTransition/index.js';
 import { parseSearchParams } from '../../utilities/parseSearchParams.js';
-const Context = /*#__PURE__*/createContext({});
-export const useListQuery = () => {
-  return useContext(Context);
-};
+import { ListQueryContext } from './context.js';
+export { useListQuery } from './context.js';
 export const ListQueryProvider = ({
   children,
+  columns,
   data,
   defaultLimit,
   defaultSort,
+  listPreferences,
   modifySearchParams,
   onQueryChange: onQueryChangeFromProps
 }) => {
@@ -23,6 +25,9 @@ export const ListQueryProvider = ({
 
   const router = useRouter();
   const rawSearchParams = useSearchParams();
+  const {
+    startRouteTransition
+  } = useRouteTransition();
   const searchParams = useMemo(() => parseSearchParams(rawSearchParams), [rawSearchParams]);
   const {
     onQueryChange
@@ -34,13 +39,6 @@ export const ListQueryProvider = ({
       return {};
     }
   });
-  const currentQueryRef = React.useRef(currentQuery);
-  // If the search params change externally, update the current query
-  useEffect(() => {
-    if (modifySearchParams) {
-      setCurrentQuery(searchParams);
-    }
-  }, [searchParams, modifySearchParams]);
   const refineListData = useCallback(
   // eslint-disable-next-line @typescript-eslint/require-await
   async query => {
@@ -49,6 +47,7 @@ export const ListQueryProvider = ({
       page = '1';
     }
     const newQuery = {
+      columns: 'columns' in query ? query.columns : currentQuery.columns,
       limit: 'limit' in query ? query.limit : currentQuery?.limit ?? String(defaultLimit),
       page,
       search: 'search' in query ? query.search : currentQuery?.search,
@@ -56,15 +55,18 @@ export const ListQueryProvider = ({
       where: 'where' in query ? query.where : currentQuery?.where
     };
     if (modifySearchParams) {
-      router.replace(`${qs.stringify(newQuery, {
+      startRouteTransition(() => router.replace(`${qs.stringify({
+        ...newQuery,
+        columns: JSON.stringify(newQuery.columns)
+      }, {
         addQueryPrefix: true
-      })}`);
+      })}`));
     } else if (typeof onQueryChange === 'function' || typeof onQueryChangeFromProps === 'function') {
       const onChangeFn = onQueryChange || onQueryChangeFromProps;
       onChangeFn(newQuery);
     }
     setCurrentQuery(newQuery);
-  }, [currentQuery?.page, currentQuery?.limit, currentQuery?.search, currentQuery?.sort, currentQuery?.where, defaultLimit, defaultSort, modifySearchParams, onQueryChange, onQueryChangeFromProps, router]);
+  }, [currentQuery?.columns, currentQuery?.limit, currentQuery?.page, currentQuery?.search, currentQuery?.sort, currentQuery?.where, startRouteTransition, defaultLimit, defaultSort, modifySearchParams, onQueryChange, onQueryChangeFromProps, router]);
   const handlePageChange = useCallback(async arg => {
     await refineListData({
       page: String(arg)
@@ -92,32 +94,44 @@ export const ListQueryProvider = ({
       where: arg_3
     });
   }, [refineListData]);
+  const syncQuery = useEffectEvent(() => {
+    let shouldUpdateQueryString = false;
+    const newQuery_0 = {
+      ...(currentQuery || {})
+    };
+    // Allow the URL to override the default limit
+    if (isNumber(defaultLimit) && !('limit' in currentQuery)) {
+      newQuery_0.limit = String(defaultLimit);
+      shouldUpdateQueryString = true;
+    }
+    // Allow the URL to override the default sort
+    if (defaultSort && !('sort' in currentQuery)) {
+      newQuery_0.sort = defaultSort;
+      shouldUpdateQueryString = true;
+    }
+    // Only modify columns if they originated from preferences
+    // We can assume they did if `listPreferences.columns` is defined
+    if (columns && listPreferences?.columns && !('columns' in currentQuery)) {
+      newQuery_0.columns = transformColumnsToSearchParams(columns);
+      shouldUpdateQueryString = true;
+    }
+    if (shouldUpdateQueryString) {
+      setCurrentQuery(newQuery_0);
+      // Do not use router.replace here to avoid re-rendering on initial load
+      window.history.replaceState(null, '', `?${qs.stringify({
+        ...newQuery_0,
+        columns: JSON.stringify(newQuery_0.columns)
+      })}`);
+    }
+  });
   // If `defaultLimit` or `defaultSort` are updated externally, update the query
   // I.e. when HMR runs, these properties may be different
   useEffect(() => {
     if (modifySearchParams) {
-      let shouldUpdateQueryString = false;
-      const newQuery_0 = {
-        ...(currentQueryRef.current || {})
-      };
-      // Allow the URL to override the default limit
-      if (isNumber(defaultLimit) && !('limit' in currentQueryRef.current)) {
-        newQuery_0.limit = String(defaultLimit);
-        shouldUpdateQueryString = true;
-      }
-      // Allow the URL to override the default sort
-      if (defaultSort && !('sort' in currentQueryRef.current)) {
-        newQuery_0.sort = defaultSort;
-        shouldUpdateQueryString = true;
-      }
-      if (shouldUpdateQueryString) {
-        setCurrentQuery(newQuery_0);
-        // Do not use router.replace here to avoid re-rendering on initial load
-        window.history.replaceState(null, '', `?${qs.stringify(newQuery_0)}`);
-      }
+      syncQuery();
     }
-  }, [defaultSort, defaultLimit, router, modifySearchParams]);
-  return /*#__PURE__*/_jsx(Context.Provider, {
+  }, [defaultSort, defaultLimit, modifySearchParams, columns]);
+  return /*#__PURE__*/_jsx(ListQueryContext.Provider, {
     value: {
       data,
       handlePageChange,

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["useRouter","useSearchParams","isNumber","qs","React","createContext","useCallback","useContext","useEffect","useMemo","useState","useListDrawerContext","parseSearchParams","Context","useListQuery","ListQueryProvider","children","data","defaultLimit","defaultSort","modifySearchParams","onQueryChange","onQueryChangeFromProps","router","rawSearchParams","searchParams","currentQuery","setCurrentQuery","currentQueryRef","useRef","refineListData","query","page","newQuery","limit","String","search","sort","where","replace","stringify","addQueryPrefix","onChangeFn","handlePageChange","arg","handlePerPageChange","handleSearchChange","undefined","handleSortChange","handleWhereChange","shouldUpdateQueryString","current","window","history","replaceState","_jsx","Provider","value"],"sources":["../../../src/providers/ListQuery/index.tsx"],"sourcesContent":["'use client'\nimport type { ListQuery, PaginatedDocs, Sort, Where } from 'payload'\n\nimport { useRouter, useSearchParams } from 'next/navigation.js'\nimport { isNumber } from 'payload/shared'\nimport * as qs from 'qs-esm'\nimport React, { createContext, useCallback, useContext, useEffect, useMemo, useState } from 'react'\n\nimport { useListDrawerContext } from '../../elements/ListDrawer/Provider.js'\nimport { parseSearchParams } from '../../utilities/parseSearchParams.js'\n\ntype ContextHandlers = {\n  handlePageChange?: (page: number) => Promise<void>\n  handlePerPageChange?: (limit: number) => Promise<void>\n  handleSearchChange?: (search: string) => Promise<void>\n  handleSortChange?: (sort: string) => Promise<void>\n  handleWhereChange?: (where: Where) => Promise<void>\n}\n\nexport type ListQueryProps = {\n  readonly children: React.ReactNode\n  readonly collectionSlug?: string\n  readonly data: PaginatedDocs\n  readonly defaultLimit?: number\n  readonly defaultSort?: Sort\n  readonly modifySearchParams?: boolean\n  readonly onQueryChange?: (query: ListQuery) => void\n  readonly preferenceKey?: string\n}\n\nexport type ListQueryContext = {\n  data: PaginatedDocs\n  defaultLimit?: number\n  defaultSort?: Sort\n  query: ListQuery\n  refineListData: (args: ListQuery) => Promise<void>\n} & ContextHandlers\n\nconst Context = createContext({} as ListQueryContext)\n\nexport const useListQuery = (): ListQueryContext => useContext(Context)\n\nexport const ListQueryProvider: React.FC<ListQueryProps> = ({\n  children,\n  data,\n  defaultLimit,\n  defaultSort,\n  modifySearchParams,\n  onQueryChange: onQueryChangeFromProps,\n}) => {\n  'use no memo'\n  const router = useRouter()\n  const rawSearchParams = useSearchParams()\n  const searchParams = useMemo(() => parseSearchParams(rawSearchParams), [rawSearchParams])\n\n  const { onQueryChange } = useListDrawerContext()\n\n  const [currentQuery, setCurrentQuery] = useState<ListQuery>(() => {\n    if (modifySearchParams) {\n      return searchParams\n    } else {\n      return {}\n    }\n  })\n\n  const currentQueryRef = React.useRef(currentQuery)\n\n  // If the search params change externally, update the current query\n  useEffect(() => {\n    if (modifySearchParams) {\n      setCurrentQuery(searchParams)\n    }\n  }, [searchParams, modifySearchParams])\n\n  const refineListData = useCallback(\n    // eslint-disable-next-line @typescript-eslint/require-await\n    async (query: ListQuery) => {\n      let page = 'page' in query ? query.page : currentQuery?.page\n\n      if ('where' in query || 'search' in query) {\n        page = '1'\n      }\n\n      const newQuery: ListQuery = {\n        limit: 'limit' in query ? query.limit : (currentQuery?.limit ?? String(defaultLimit)),\n        page,\n        search: 'search' in query ? query.search : currentQuery?.search,\n        sort: 'sort' in query ? query.sort : ((currentQuery?.sort as string) ?? defaultSort),\n        where: 'where' in query ? query.where : currentQuery?.where,\n      }\n\n      if (modifySearchParams) {\n        router.replace(`${qs.stringify(newQuery, { addQueryPrefix: true })}`)\n      } else if (\n        typeof onQueryChange === 'function' ||\n        typeof onQueryChangeFromProps === 'function'\n      ) {\n        const onChangeFn = onQueryChange || onQueryChangeFromProps\n        onChangeFn(newQuery)\n      }\n\n      setCurrentQuery(newQuery)\n    },\n    [\n      currentQuery?.page,\n      currentQuery?.limit,\n      currentQuery?.search,\n      currentQuery?.sort,\n      currentQuery?.where,\n      defaultLimit,\n      defaultSort,\n      modifySearchParams,\n      onQueryChange,\n      onQueryChangeFromProps,\n      router,\n    ],\n  )\n\n  const handlePageChange = useCallback(\n    async (arg: number) => {\n      await refineListData({ page: String(arg) })\n    },\n    [refineListData],\n  )\n\n  const handlePerPageChange = React.useCallback(\n    async (arg: number) => {\n      await refineListData({ limit: String(arg), page: '1' })\n    },\n    [refineListData],\n  )\n\n  const handleSearchChange = useCallback(\n    async (arg: string) => {\n      const search = arg === '' ? undefined : arg\n      await refineListData({ search })\n    },\n    [refineListData],\n  )\n\n  const handleSortChange = useCallback(\n    async (arg: string) => {\n      await refineListData({ sort: arg })\n    },\n    [refineListData],\n  )\n\n  const handleWhereChange = useCallback(\n    async (arg: Where) => {\n      await refineListData({ where: arg })\n    },\n    [refineListData],\n  )\n\n  // If `defaultLimit` or `defaultSort` are updated externally, update the query\n  // I.e. when HMR runs, these properties may be different\n  useEffect(() => {\n    if (modifySearchParams) {\n      let shouldUpdateQueryString = false\n      const newQuery = { ...(currentQueryRef.current || {}) }\n\n      // Allow the URL to override the default limit\n      if (isNumber(defaultLimit) && !('limit' in currentQueryRef.current)) {\n        newQuery.limit = String(defaultLimit)\n        shouldUpdateQueryString = true\n      }\n\n      // Allow the URL to override the default sort\n      if (defaultSort && !('sort' in currentQueryRef.current)) {\n        newQuery.sort = defaultSort\n        shouldUpdateQueryString = true\n      }\n\n      if (shouldUpdateQueryString) {\n        setCurrentQuery(newQuery)\n        // Do not use router.replace here to avoid re-rendering on initial load\n        window.history.replaceState(null, '', `?${qs.stringify(newQuery)}`)\n      }\n    }\n  }, [defaultSort, defaultLimit, router, modifySearchParams])\n\n  return (\n    <Context.Provider\n      value={{\n        data,\n        handlePageChange,\n        handlePerPageChange,\n        handleSearchChange,\n        handleSortChange,\n        handleWhereChange,\n        query: currentQuery,\n        refineListData,\n      }}\n    >\n      {children}\n    </Context.Provider>\n  )\n}\n"],"mappings":"AAAA;;;AAGA,SAASA,SAAS,EAAEC,eAAe,QAAQ;AAC3C,SAASC,QAAQ,QAAQ;AACzB,YAAYC,EAAA,MAAQ;AACpB,OAAOC,KAAA,IAASC,aAAa,EAAEC,WAAW,EAAEC,UAAU,EAAEC,SAAS,EAAEC,OAAO,EAAEC,QAAQ,QAAQ;AAE5F,SAASC,oBAAoB,QAAQ;AACrC,SAASC,iBAAiB,QAAQ;AA6BlC,MAAMC,OAAA,gBAAUR,aAAA,CAAc,CAAC;AAE/B,OAAO,MAAMS,YAAA,GAAeA,CAAA;EAAA,OAAwBP,UAAA,CAAAM,OAAW;AAAA;AAE/D,OAAO,MAAME,iBAAA,GAA8CA,CAAC;EAC1DC,QAAQ;EACRC,IAAI;EACJC,YAAY;EACZC,WAAW;EACXC,kBAAkB;EAClBC,aAAA,EAAeC;AAAsB,CACtC;EACC;;EACA,MAAMC,MAAA,GAASvB,SAAA;EACf,MAAMwB,eAAA,GAAkBvB,eAAA;EACxB,MAAMwB,YAAA,GAAehB,OAAA,CAAQ,MAAMG,iBAAA,CAAkBY,eAAA,GAAkB,CAACA,eAAA,CAAgB;EAExF,MAAM;IAAEH;EAAa,CAAE,GAAGV,oBAAA;EAE1B,MAAM,CAACe,YAAA,EAAcC,eAAA,CAAgB,GAAGjB,QAAA,CAAoB;IAC1D,IAAIU,kBAAA,EAAoB;MACtB,OAAOK,YAAA;IACT,OAAO;MACL,OAAO,CAAC;IACV;EACF;EAEA,MAAMG,eAAA,GAAkBxB,KAAA,CAAMyB,MAAM,CAACH,YAAA;EAErC;EACAlB,SAAA,CAAU;IACR,IAAIY,kBAAA,EAAoB;MACtBO,eAAA,CAAgBF,YAAA;IAClB;EACF,GAAG,CAACA,YAAA,EAAcL,kBAAA,CAAmB;EAErC,MAAMU,cAAA,GAAiBxB,WAAA;EACrB;EACA,MAAOyB,KAAA;IACL,IAAIC,IAAA,GAAO,UAAUD,KAAA,GAAQA,KAAA,CAAMC,IAAI,GAAGN,YAAA,EAAcM,IAAA;IAExD,IAAI,WAAWD,KAAA,IAAS,YAAYA,KAAA,EAAO;MACzCC,IAAA,GAAO;IACT;IAEA,MAAMC,QAAA,GAAsB;MAC1BC,KAAA,EAAO,WAAWH,KAAA,GAAQA,KAAA,CAAMG,KAAK,GAAIR,YAAA,EAAcQ,KAAA,IAASC,MAAA,CAAOjB,YAAA;MACvEc,IAAA;MACAI,MAAA,EAAQ,YAAYL,KAAA,GAAQA,KAAA,CAAMK,MAAM,GAAGV,YAAA,EAAcU,MAAA;MACzDC,IAAA,EAAM,UAAUN,KAAA,GAAQA,KAAA,CAAMM,IAAI,GAAIX,YAAC,EAAcW,IAAA,IAAmBlB,WAAA;MACxEmB,KAAA,EAAO,WAAWP,KAAA,GAAQA,KAAA,CAAMO,KAAK,GAAGZ,YAAA,EAAcY;IACxD;IAEA,IAAIlB,kBAAA,EAAoB;MACtBG,MAAA,CAAOgB,OAAO,CAAC,GAAGpC,EAAA,CAAGqC,SAAS,CAACP,QAAA,EAAU;QAAEQ,cAAA,EAAgB;MAAK,IAAI;IACtE,OAAO,IACL,OAAOpB,aAAA,KAAkB,cACzB,OAAOC,sBAAA,KAA2B,YAClC;MACA,MAAMoB,UAAA,GAAarB,aAAA,IAAiBC,sBAAA;MACpCoB,UAAA,CAAWT,QAAA;IACb;IAEAN,eAAA,CAAgBM,QAAA;EAClB,GACA,CACEP,YAAA,EAAcM,IAAA,EACdN,YAAA,EAAcQ,KAAA,EACdR,YAAA,EAAcU,MAAA,EACdV,YAAA,EAAcW,IAAA,EACdX,YAAA,EAAcY,KAAA,EACdpB,YAAA,EACAC,WAAA,EACAC,kBAAA,EACAC,aAAA,EACAC,sBAAA,EACAC,MAAA,CACD;EAGH,MAAMoB,gBAAA,GAAmBrC,WAAA,CACvB,MAAOsC,GAAA;IACL,MAAMd,cAAA,CAAe;MAAEE,IAAA,EAAMG,MAAA,CAAOS,GAAA;IAAK;EAC3C,GACA,CAACd,cAAA,CAAe;EAGlB,MAAMe,mBAAA,GAAsBzC,KAAA,CAAME,WAAW,CAC3C,MAAOsC,KAAA;IACL,MAAMd,cAAA,CAAe;MAAEI,KAAA,EAAOC,MAAA,CAAOS,KAAA;MAAMZ,IAAA,EAAM;IAAI;EACvD,GACA,CAACF,cAAA,CAAe;EAGlB,MAAMgB,kBAAA,GAAqBxC,WAAA,CACzB,MAAOsC,KAAA;IACL,MAAMR,MAAA,GAASQ,KAAA,KAAQ,KAAKG,SAAA,GAAYH,KAAA;IACxC,MAAMd,cAAA,CAAe;MAAEM;IAAO;EAChC,GACA,CAACN,cAAA,CAAe;EAGlB,MAAMkB,gBAAA,GAAmB1C,WAAA,CACvB,MAAOsC,KAAA;IACL,MAAMd,cAAA,CAAe;MAAEO,IAAA,EAAMO;IAAI;EACnC,GACA,CAACd,cAAA,CAAe;EAGlB,MAAMmB,iBAAA,GAAoB3C,WAAA,CACxB,MAAOsC,KAAA;IACL,MAAMd,cAAA,CAAe;MAAEQ,KAAA,EAAOM;IAAI;EACpC,GACA,CAACd,cAAA,CAAe;EAGlB;EACA;EACAtB,SAAA,CAAU;IACR,IAAIY,kBAAA,EAAoB;MACtB,IAAI8B,uBAAA,GAA0B;MAC9B,MAAMjB,UAAA,GAAW;QAAE,IAAIL,eAAA,CAAgBuB,OAAO,IAAI,CAAC,CAAC;MAAE;MAEtD;MACA,IAAIjD,QAAA,CAASgB,YAAA,KAAiB,EAAE,WAAWU,eAAA,CAAgBuB,OAAO,CAAD,EAAI;QACnElB,UAAA,CAASC,KAAK,GAAGC,MAAA,CAAOjB,YAAA;QACxBgC,uBAAA,GAA0B;MAC5B;MAEA;MACA,IAAI/B,WAAA,IAAe,EAAE,UAAUS,eAAA,CAAgBuB,OAAO,CAAD,EAAI;QACvDlB,UAAA,CAASI,IAAI,GAAGlB,WAAA;QAChB+B,uBAAA,GAA0B;MAC5B;MAEA,IAAIA,uBAAA,EAAyB;QAC3BvB,eAAA,CAAgBM,UAAA;QAChB;QACAmB,MAAA,CAAOC,OAAO,CAACC,YAAY,CAAC,MAAM,IAAI,IAAInD,EAAA,CAAGqC,SAAS,CAACP,UAAA,GAAW;MACpE;IACF;EACF,GAAG,CAACd,WAAA,EAAaD,YAAA,EAAcK,MAAA,EAAQH,kBAAA,CAAmB;EAE1D,oBACEmC,IAAA,CAAC1C,OAAA,CAAQ2C,QAAQ;IACfC,KAAA,EAAO;MACLxC,IAAA;MACA0B,gBAAA;MACAE,mBAAA;MACAC,kBAAA;MACAE,gBAAA;MACAC,iBAAA;MACAlB,KAAA,EAAOL,YAAA;MACPI;IACF;cAECd;;AAGP","ignoreList":[]}
+{"version":3,"file":"index.js","names":["useRouter","useSearchParams","isNumber","transformColumnsToSearchParams","qs","React","useCallback","useEffect","useMemo","useState","useListDrawerContext","useEffectEvent","useRouteTransition","parseSearchParams","ListQueryContext","useListQuery","ListQueryProvider","children","columns","data","defaultLimit","defaultSort","listPreferences","modifySearchParams","onQueryChange","onQueryChangeFromProps","router","rawSearchParams","startRouteTransition","searchParams","currentQuery","setCurrentQuery","refineListData","query","page","newQuery","limit","String","search","sort","where","replace","stringify","JSON","addQueryPrefix","onChangeFn","handlePageChange","arg","handlePerPageChange","handleSearchChange","undefined","handleSortChange","handleWhereChange","syncQuery","shouldUpdateQueryString","window","history","replaceState","_jsx","Provider","value"],"sources":["../../../src/providers/ListQuery/index.tsx"],"sourcesContent":["'use client'\nimport { useRouter, useSearchParams } from 'next/navigation.js'\nimport { type ListQuery, type Where } from 'payload'\nimport { isNumber, transformColumnsToSearchParams } from 'payload/shared'\nimport * as qs from 'qs-esm'\nimport React, { useCallback, useEffect, useMemo, useState } from 'react'\n\nimport type { ListQueryProps } from './types.js'\n\nimport { useListDrawerContext } from '../../elements/ListDrawer/Provider.js'\nimport { useEffectEvent } from '../../hooks/useEffectEvent.js'\nimport { useRouteTransition } from '../../providers/RouteTransition/index.js'\nimport { parseSearchParams } from '../../utilities/parseSearchParams.js'\nimport { ListQueryContext } from './context.js'\n\nexport { useListQuery } from './context.js'\n\nexport const ListQueryProvider: React.FC<ListQueryProps> = ({\n  children,\n  columns,\n  data,\n  defaultLimit,\n  defaultSort,\n  listPreferences,\n  modifySearchParams,\n  onQueryChange: onQueryChangeFromProps,\n}) => {\n  'use no memo'\n  const router = useRouter()\n  const rawSearchParams = useSearchParams()\n  const { startRouteTransition } = useRouteTransition()\n\n  const searchParams = useMemo<ListQuery>(\n    () => parseSearchParams(rawSearchParams),\n    [rawSearchParams],\n  )\n\n  const { onQueryChange } = useListDrawerContext()\n\n  const [currentQuery, setCurrentQuery] = useState<ListQuery>(() => {\n    if (modifySearchParams) {\n      return searchParams\n    } else {\n      return {}\n    }\n  })\n\n  const refineListData = useCallback(\n    // eslint-disable-next-line @typescript-eslint/require-await\n    async (query: ListQuery) => {\n      let page = 'page' in query ? query.page : currentQuery?.page\n\n      if ('where' in query || 'search' in query) {\n        page = '1'\n      }\n\n      const newQuery: ListQuery = {\n        columns: 'columns' in query ? query.columns : currentQuery.columns,\n        limit: 'limit' in query ? query.limit : (currentQuery?.limit ?? String(defaultLimit)),\n        page,\n        search: 'search' in query ? query.search : currentQuery?.search,\n        sort: 'sort' in query ? query.sort : ((currentQuery?.sort as string) ?? defaultSort),\n        where: 'where' in query ? query.where : currentQuery?.where,\n      }\n\n      if (modifySearchParams) {\n        startRouteTransition(() =>\n          router.replace(\n            `${qs.stringify(\n              { ...newQuery, columns: JSON.stringify(newQuery.columns) },\n              { addQueryPrefix: true },\n            )}`,\n          ),\n        )\n      } else if (\n        typeof onQueryChange === 'function' ||\n        typeof onQueryChangeFromProps === 'function'\n      ) {\n        const onChangeFn = onQueryChange || onQueryChangeFromProps\n        onChangeFn(newQuery)\n      }\n\n      setCurrentQuery(newQuery)\n    },\n    [\n      currentQuery?.columns,\n      currentQuery?.limit,\n      currentQuery?.page,\n      currentQuery?.search,\n      currentQuery?.sort,\n      currentQuery?.where,\n      startRouteTransition,\n      defaultLimit,\n      defaultSort,\n      modifySearchParams,\n      onQueryChange,\n      onQueryChangeFromProps,\n      router,\n    ],\n  )\n\n  const handlePageChange = useCallback(\n    async (arg: number) => {\n      await refineListData({ page: String(arg) })\n    },\n    [refineListData],\n  )\n\n  const handlePerPageChange = React.useCallback(\n    async (arg: number) => {\n      await refineListData({ limit: String(arg), page: '1' })\n    },\n    [refineListData],\n  )\n\n  const handleSearchChange = useCallback(\n    async (arg: string) => {\n      const search = arg === '' ? undefined : arg\n      await refineListData({ search })\n    },\n    [refineListData],\n  )\n\n  const handleSortChange = useCallback(\n    async (arg: string) => {\n      await refineListData({ sort: arg })\n    },\n    [refineListData],\n  )\n\n  const handleWhereChange = useCallback(\n    async (arg: Where) => {\n      await refineListData({ where: arg })\n    },\n    [refineListData],\n  )\n\n  const syncQuery = useEffectEvent(() => {\n    let shouldUpdateQueryString = false\n    const newQuery = { ...(currentQuery || {}) }\n\n    // Allow the URL to override the default limit\n    if (isNumber(defaultLimit) && !('limit' in currentQuery)) {\n      newQuery.limit = String(defaultLimit)\n      shouldUpdateQueryString = true\n    }\n\n    // Allow the URL to override the default sort\n    if (defaultSort && !('sort' in currentQuery)) {\n      newQuery.sort = defaultSort\n      shouldUpdateQueryString = true\n    }\n\n    // Only modify columns if they originated from preferences\n    // We can assume they did if `listPreferences.columns` is defined\n    if (columns && listPreferences?.columns && !('columns' in currentQuery)) {\n      newQuery.columns = transformColumnsToSearchParams(columns)\n      shouldUpdateQueryString = true\n    }\n\n    if (shouldUpdateQueryString) {\n      setCurrentQuery(newQuery)\n      // Do not use router.replace here to avoid re-rendering on initial load\n      window.history.replaceState(\n        null,\n        '',\n        `?${qs.stringify({ ...newQuery, columns: JSON.stringify(newQuery.columns) })}`,\n      )\n    }\n  })\n\n  // If `defaultLimit` or `defaultSort` are updated externally, update the query\n  // I.e. when HMR runs, these properties may be different\n  useEffect(() => {\n    if (modifySearchParams) {\n      syncQuery()\n    }\n  }, [defaultSort, defaultLimit, modifySearchParams, columns])\n\n  return (\n    <ListQueryContext.Provider\n      value={{\n        data,\n        handlePageChange,\n        handlePerPageChange,\n        handleSearchChange,\n        handleSortChange,\n        handleWhereChange,\n        query: currentQuery,\n        refineListData,\n      }}\n    >\n      {children}\n    </ListQueryContext.Provider>\n  )\n}\n"],"mappings":"AAAA;;;AACA,SAASA,SAAS,EAAEC,eAAe,QAAQ;AAE3C,SAASC,QAAQ,EAAEC,8BAA8B,QAAQ;AACzD,YAAYC,EAAA,MAAQ;AACpB,OAAOC,KAAA,IAASC,WAAW,EAAEC,SAAS,EAAEC,OAAO,EAAEC,QAAQ,QAAQ;AAIjE,SAASC,oBAAoB,QAAQ;AACrC,SAASC,cAAc,QAAQ;AAC/B,SAASC,kBAAkB,QAAQ;AACnC,SAASC,iBAAiB,QAAQ;AAClC,SAASC,gBAAgB,QAAQ;AAEjC,SAASC,YAAY,QAAQ;AAE7B,OAAO,MAAMC,iBAAA,GAA8CA,CAAC;EAC1DC,QAAQ;EACRC,OAAO;EACPC,IAAI;EACJC,YAAY;EACZC,WAAW;EACXC,eAAe;EACfC,kBAAkB;EAClBC,aAAA,EAAeC;AAAsB,CACtC;EACC;;EACA,MAAMC,MAAA,GAAS1B,SAAA;EACf,MAAM2B,eAAA,GAAkB1B,eAAA;EACxB,MAAM;IAAE2B;EAAoB,CAAE,GAAGhB,kBAAA;EAEjC,MAAMiB,YAAA,GAAerB,OAAA,CACnB,MAAMK,iBAAA,CAAkBc,eAAA,GACxB,CAACA,eAAA,CAAgB;EAGnB,MAAM;IAAEH;EAAa,CAAE,GAAGd,oBAAA;EAE1B,MAAM,CAACoB,YAAA,EAAcC,eAAA,CAAgB,GAAGtB,QAAA,CAAoB;IAC1D,IAAIc,kBAAA,EAAoB;MACtB,OAAOM,YAAA;IACT,OAAO;MACL,OAAO,CAAC;IACV;EACF;EAEA,MAAMG,cAAA,GAAiB1B,WAAA;EACrB;EACA,MAAO2B,KAAA;IACL,IAAIC,IAAA,GAAO,UAAUD,KAAA,GAAQA,KAAA,CAAMC,IAAI,GAAGJ,YAAA,EAAcI,IAAA;IAExD,IAAI,WAAWD,KAAA,IAAS,YAAYA,KAAA,EAAO;MACzCC,IAAA,GAAO;IACT;IAEA,MAAMC,QAAA,GAAsB;MAC1BjB,OAAA,EAAS,aAAae,KAAA,GAAQA,KAAA,CAAMf,OAAO,GAAGY,YAAA,CAAaZ,OAAO;MAClEkB,KAAA,EAAO,WAAWH,KAAA,GAAQA,KAAA,CAAMG,KAAK,GAAIN,YAAA,EAAcM,KAAA,IAASC,MAAA,CAAOjB,YAAA;MACvEc,IAAA;MACAI,MAAA,EAAQ,YAAYL,KAAA,GAAQA,KAAA,CAAMK,MAAM,GAAGR,YAAA,EAAcQ,MAAA;MACzDC,IAAA,EAAM,UAAUN,KAAA,GAAQA,KAAA,CAAMM,IAAI,GAAIT,YAAC,EAAcS,IAAA,IAAmBlB,WAAA;MACxEmB,KAAA,EAAO,WAAWP,KAAA,GAAQA,KAAA,CAAMO,KAAK,GAAGV,YAAA,EAAcU;IACxD;IAEA,IAAIjB,kBAAA,EAAoB;MACtBK,oBAAA,CAAqB,MACnBF,MAAA,CAAOe,OAAO,CACZ,GAAGrC,EAAA,CAAGsC,SAAS,CACb;QAAE,GAAGP,QAAQ;QAAEjB,OAAA,EAASyB,IAAA,CAAKD,SAAS,CAACP,QAAA,CAASjB,OAAO;MAAE,GACzD;QAAE0B,cAAA,EAAgB;MAAK,IACtB;IAGT,OAAO,IACL,OAAOpB,aAAA,KAAkB,cACzB,OAAOC,sBAAA,KAA2B,YAClC;MACA,MAAMoB,UAAA,GAAarB,aAAA,IAAiBC,sBAAA;MACpCoB,UAAA,CAAWV,QAAA;IACb;IAEAJ,eAAA,CAAgBI,QAAA;EAClB,GACA,CACEL,YAAA,EAAcZ,OAAA,EACdY,YAAA,EAAcM,KAAA,EACdN,YAAA,EAAcI,IAAA,EACdJ,YAAA,EAAcQ,MAAA,EACdR,YAAA,EAAcS,IAAA,EACdT,YAAA,EAAcU,KAAA,EACdZ,oBAAA,EACAR,YAAA,EACAC,WAAA,EACAE,kBAAA,EACAC,aAAA,EACAC,sBAAA,EACAC,MAAA,CACD;EAGH,MAAMoB,gBAAA,GAAmBxC,WAAA,CACvB,MAAOyC,GAAA;IACL,MAAMf,cAAA,CAAe;MAAEE,IAAA,EAAMG,MAAA,CAAOU,GAAA;IAAK;EAC3C,GACA,CAACf,cAAA,CAAe;EAGlB,MAAMgB,mBAAA,GAAsB3C,KAAA,CAAMC,WAAW,CAC3C,MAAOyC,KAAA;IACL,MAAMf,cAAA,CAAe;MAAEI,KAAA,EAAOC,MAAA,CAAOU,KAAA;MAAMb,IAAA,EAAM;IAAI;EACvD,GACA,CAACF,cAAA,CAAe;EAGlB,MAAMiB,kBAAA,GAAqB3C,WAAA,CACzB,MAAOyC,KAAA;IACL,MAAMT,MAAA,GAASS,KAAA,KAAQ,KAAKG,SAAA,GAAYH,KAAA;IACxC,MAAMf,cAAA,CAAe;MAAEM;IAAO;EAChC,GACA,CAACN,cAAA,CAAe;EAGlB,MAAMmB,gBAAA,GAAmB7C,WAAA,CACvB,MAAOyC,KAAA;IACL,MAAMf,cAAA,CAAe;MAAEO,IAAA,EAAMQ;IAAI;EACnC,GACA,CAACf,cAAA,CAAe;EAGlB,MAAMoB,iBAAA,GAAoB9C,WAAA,CACxB,MAAOyC,KAAA;IACL,MAAMf,cAAA,CAAe;MAAEQ,KAAA,EAAOO;IAAI;EACpC,GACA,CAACf,cAAA,CAAe;EAGlB,MAAMqB,SAAA,GAAY1C,cAAA,CAAe;IAC/B,IAAI2C,uBAAA,GAA0B;IAC9B,MAAMnB,UAAA,GAAW;MAAE,IAAIL,YAAA,IAAgB,CAAC,CAAC;IAAE;IAE3C;IACA,IAAI5B,QAAA,CAASkB,YAAA,KAAiB,EAAE,WAAWU,YAAW,GAAI;MACxDK,UAAA,CAASC,KAAK,GAAGC,MAAA,CAAOjB,YAAA;MACxBkC,uBAAA,GAA0B;IAC5B;IAEA;IACA,IAAIjC,WAAA,IAAe,EAAE,UAAUS,YAAW,GAAI;MAC5CK,UAAA,CAASI,IAAI,GAAGlB,WAAA;MAChBiC,uBAAA,GAA0B;IAC5B;IAEA;IACA;IACA,IAAIpC,OAAA,IAAWI,eAAA,EAAiBJ,OAAA,IAAW,EAAE,aAAaY,YAAW,GAAI;MACvEK,UAAA,CAASjB,OAAO,GAAGf,8BAAA,CAA+Be,OAAA;MAClDoC,uBAAA,GAA0B;IAC5B;IAEA,IAAIA,uBAAA,EAAyB;MAC3BvB,eAAA,CAAgBI,UAAA;MAChB;MACAoB,MAAA,CAAOC,OAAO,CAACC,YAAY,CACzB,MACA,IACA,IAAIrD,EAAA,CAAGsC,SAAS,CAAC;QAAE,GAAGP,UAAQ;QAAEjB,OAAA,EAASyB,IAAA,CAAKD,SAAS,CAACP,UAAA,CAASjB,OAAO;MAAE,IAAI;IAElF;EACF;EAEA;EACA;EACAX,SAAA,CAAU;IACR,IAAIgB,kBAAA,EAAoB;MACtB8B,SAAA;IACF;EACF,GAAG,CAAChC,WAAA,EAAaD,YAAA,EAAcG,kBAAA,EAAoBL,OAAA,CAAQ;EAE3D,oBACEwC,IAAA,CAAC5C,gBAAA,CAAiB6C,QAAQ;IACxBC,KAAA,EAAO;MACLzC,IAAA;MACA2B,gBAAA;MACAE,mBAAA;MACAC,kBAAA;MACAE,gBAAA;MACAC,iBAAA;MACAnB,KAAA,EAAOH,YAAA;MACPE;IACF;cAECf;;AAGP","ignoreList":[]}

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

@@ -0,0 +1,33 @@
+import type { ColumnPreference, ListPreferences, ListQuery, PaginatedDocs, Sort, Where } from 'payload';
+type ContextHandlers = {
+    handlePageChange?: (page: number) => Promise<void>;
+    handlePerPageChange?: (limit: number) => Promise<void>;
+    handleSearchChange?: (search: string) => Promise<void>;
+    handleSortChange?: (sort: string) => Promise<void>;
+    handleWhereChange?: (where: Where) => Promise<void>;
+};
+export type OnListQueryChange = (query: ListQuery) => void;
+export type ListQueryProps = {
+    readonly children: React.ReactNode;
+    readonly collectionSlug?: string;
+    readonly columns?: ColumnPreference[];
+    readonly data: PaginatedDocs;
+    readonly defaultLimit?: number;
+    readonly defaultSort?: Sort;
+    readonly listPreferences?: ListPreferences;
+    readonly modifySearchParams?: boolean;
+    readonly onQueryChange?: OnListQueryChange;
+    /**
+     * @deprecated
+     */
+    readonly preferenceKey?: string;
+};
+export type IListQueryContext = {
+    data: PaginatedDocs;
+    defaultLimit?: number;
+    defaultSort?: Sort;
+    query: ListQuery;
+    refineListData: (args: ListQuery) => Promise<void>;
+} & ContextHandlers;
+export {};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/providers/ListQuery/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EACf,SAAS,EACT,aAAa,EACb,IAAI,EACJ,KAAK,EACN,MAAM,SAAS,CAAA;AAEhB,KAAK,eAAe,GAAG;IACrB,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAClD,mBAAmB,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACtD,kBAAkB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACtD,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAClD,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CACpD,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAA;AAE1D,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IAClC,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC,QAAQ,CAAC,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAA;IACrC,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAA;IAC5B,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;IAC9B,QAAQ,CAAC,WAAW,CAAC,EAAE,IAAI,CAAA;IAC3B,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,CAAA;IAC1C,QAAQ,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAA;IACrC,QAAQ,CAAC,aAAa,CAAC,EAAE,iBAAiB,CAAA;IAC1C;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;CAChC,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,aAAa,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,WAAW,CAAC,EAAE,IAAI,CAAA;IAClB,KAAK,EAAE,SAAS,CAAA;IAChB,cAAc,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CACnD,GAAG,eAAe,CAAA"}

package/dist/providers/ListQuery/types.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","names":[],"sources":["../../../src/providers/ListQuery/types.ts"],"sourcesContent":["import type {\n  ColumnPreference,\n  ListPreferences,\n  ListQuery,\n  PaginatedDocs,\n  Sort,\n  Where,\n} from 'payload'\n\ntype ContextHandlers = {\n  handlePageChange?: (page: number) => Promise<void>\n  handlePerPageChange?: (limit: number) => Promise<void>\n  handleSearchChange?: (search: string) => Promise<void>\n  handleSortChange?: (sort: string) => Promise<void>\n  handleWhereChange?: (where: Where) => Promise<void>\n}\n\nexport type OnListQueryChange = (query: ListQuery) => void\n\nexport type ListQueryProps = {\n  readonly children: React.ReactNode\n  readonly collectionSlug?: string\n  readonly columns?: ColumnPreference[]\n  readonly data: PaginatedDocs\n  readonly defaultLimit?: number\n  readonly defaultSort?: Sort\n  readonly listPreferences?: ListPreferences\n  readonly modifySearchParams?: boolean\n  readonly onQueryChange?: OnListQueryChange\n  /**\n   * @deprecated\n   */\n  readonly preferenceKey?: string\n}\n\nexport type IListQueryContext = {\n  data: PaginatedDocs\n  defaultLimit?: number\n  defaultSort?: Sort\n  query: ListQuery\n  refineListData: (args: ListQuery) => Promise<void>\n} & ContextHandlers\n"],"mappings":"AAmCA","ignoreList":[]}

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

@@ -1,21 +1,23 @@
-.progress-bar {
-  position: fixed;
-  top: 0;
-  left: 0;
-  width: 100%;
-  height: 2px;
-  z-index: 9999;
-  opacity: 1;
+@layer payload-default {
+  .progress-bar {
+    position: fixed;
+    top: 0;
+    left: 0;
+    width: 100%;
+    height: 2px;
+    z-index: 9999;
+    opacity: 1;
 
-  &__progress {
-    height: 100%;
-    background-color: var(--theme-elevation-1000);
-    transition: width ease-in var(--transition-duration);
-  }
+    &__progress {
+      height: 100%;
+      background-color: var(--theme-elevation-1000);
+      transition: width ease-in var(--transition-duration);
+    }
 
-  &--fade-out {
-    opacity: 0;
-    transition: opacity linear var(--transition-duration);
-    transition-delay: var(--transition-duration);
+    &--fade-out {
+      opacity: 0;
+      transition: opacity linear var(--transition-duration);
+      transition-delay: var(--transition-duration);
+    }
   }
 }