@payloadcms/ui 3.14.0 → 3.14.1-canary.2776826

package/dist/providers/ListQuery/index.js

@@ -47,24 +47,13 @@ export const ListQueryProvider = ({
       setCurrentQuery(searchParams);
     }
   }, [searchParams, modifySearchParams]);
-  const refineListData = useCallback(async query => {
+  const refineListData = useCallback(
+  // eslint-disable-next-line @typescript-eslint/require-await
+  async query => {
     let page = 'page' in query ? query.page : currentQuery?.page;
     if ('where' in query || 'search' in query) {
       page = '1';
     }
-    const updatedPreferences = {};
-    let updatePreferences = false;
-    if ('limit' in query) {
-      updatedPreferences.limit = Number(query.limit);
-      updatePreferences = true;
-    }
-    if ('sort' in query) {
-      updatedPreferences.sort = query.sort;
-      updatePreferences = true;
-    }
-    if (updatePreferences && preferenceKey) {
-      await setPreference(preferenceKey, updatedPreferences, true);
-    }
     const newQuery = {
       limit: 'limit' in query ? query.limit : currentQuery?.limit ?? String(defaultLimit),
       page,
@@ -81,7 +70,7 @@ export const ListQueryProvider = ({
       onChangeFn(newQuery);
     }
     setCurrentQuery(newQuery);
-  }, [currentQuery?.page, currentQuery?.limit, currentQuery?.search, currentQuery?.sort, currentQuery?.where, preferenceKey, defaultLimit, defaultSort, modifySearchParams, onQueryChange, onQueryChangeFromProps, setPreference, router]);
+  }, [currentQuery?.page, currentQuery?.limit, currentQuery?.search, currentQuery?.sort, currentQuery?.where, defaultLimit, defaultSort, modifySearchParams, onQueryChange, onQueryChangeFromProps, router]);
   const handlePageChange = useCallback(async arg => {
     await refineListData({
       page: String(arg)

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","usePreferences","Context","useListQuery","ListQueryProvider","children","collectionSlug","data","defaultLimit","defaultSort","modifySearchParams","onQueryChange","onQueryChangeFromProps","preferenceKey","router","setPreference","rawSearchParams","searchParams","currentQuery","setCurrentQuery","currentQueryRef","useRef","refineListData","query","page","updatedPreferences","updatePreferences","limit","Number","sort","newQuery","String","search","where","replace","stringify","addQueryPrefix","onChangeFn","handlePageChange","arg","handlePerPageChange","handleSearchChange","undefined","handleSortChange","handleWhereChange","shouldUpdateQueryString","current","_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 type { Column } from '../../elements/Table/index.js'\n\nimport { useListDrawerContext } from '../../elements/ListDrawer/Provider.js'\nimport { parseSearchParams } from '../../utilities/parseSearchParams.js'\nimport { usePreferences } from '../Preferences/index.js'\n\nexport type ColumnPreferences = Pick<Column, 'accessor' | 'active'>[]\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  collectionSlug,\n  data,\n  defaultLimit,\n  defaultSort,\n  modifySearchParams,\n  onQueryChange: onQueryChangeFromProps,\n  preferenceKey,\n}) => {\n  'use no memo'\n  const router = useRouter()\n  const { setPreference } = usePreferences()\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    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 updatedPreferences: Record<string, unknown> = {}\n      let updatePreferences = false\n\n      if ('limit' in query) {\n        updatedPreferences.limit = Number(query.limit)\n        updatePreferences = true\n      }\n\n      if ('sort' in query) {\n        updatedPreferences.sort = query.sort\n        updatePreferences = true\n      }\n\n      if (updatePreferences && preferenceKey) {\n        await setPreference(preferenceKey, updatedPreferences, true)\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      preferenceKey,\n      defaultLimit,\n      defaultSort,\n      modifySearchParams,\n      onQueryChange,\n      onQueryChangeFromProps,\n      setPreference,\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  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        router.replace(`?${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;AAI5F,SAASC,oBAAoB,QAAQ;AACrC,SAASC,iBAAiB,QAAQ;AAClC,SAASC,cAAc,QAAQ;AA+B/B,MAAMC,OAAA,gBAAUT,aAAA,CAAc,CAAC;AAE/B,OAAO,MAAMU,YAAA,GAAeA,CAAA;EAAA,OAAwBR,UAAA,CAAAO,OAAW;AAAA;AAE/D,OAAO,MAAME,iBAAA,GAA8CA,CAAC;EAC1DC,QAAQ;EACRC,cAAc;EACdC,IAAI;EACJC,YAAY;EACZC,WAAW;EACXC,kBAAkB;EAClBC,aAAA,EAAeC,sBAAsB;EACrCC;AAAa,CACd;EACC;;EACA,MAAMC,MAAA,GAAS1B,SAAA;EACf,MAAM;IAAE2B;EAAa,CAAE,GAAGd,cAAA;EAC1B,MAAMe,eAAA,GAAkB3B,eAAA;EACxB,MAAM4B,YAAA,GAAepB,OAAA,CAAQ,MAAMG,iBAAA,CAAkBgB,eAAA,GAAkB,CAACA,eAAA,CAAgB;EAExF,MAAM;IAAEL;EAAa,CAAE,GAAGZ,oBAAA;EAE1B,MAAM,CAACmB,YAAA,EAAcC,eAAA,CAAgB,GAAGrB,QAAA,CAAoB;IAC1D,IAAIY,kBAAA,EAAoB;MACtB,OAAOO,YAAA;IACT,OAAO;MACL,OAAO,CAAC;IACV;EACF;EAEA,MAAMG,eAAA,GAAkB5B,KAAA,CAAM6B,MAAM,CAACH,YAAA;EAErC;EACAtB,SAAA,CAAU;IACR,IAAIc,kBAAA,EAAoB;MACtBS,eAAA,CAAgBF,YAAA;IAClB;EACF,GAAG,CAACA,YAAA,EAAcP,kBAAA,CAAmB;EAErC,MAAMY,cAAA,GAAiB5B,WAAA,CACrB,MAAO6B,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,kBAAA,GAA8C,CAAC;IACrD,IAAIC,iBAAA,GAAoB;IAExB,IAAI,WAAWH,KAAA,EAAO;MACpBE,kBAAA,CAAmBE,KAAK,GAAGC,MAAA,CAAOL,KAAA,CAAMI,KAAK;MAC7CD,iBAAA,GAAoB;IACtB;IAEA,IAAI,UAAUH,KAAA,EAAO;MACnBE,kBAAA,CAAmBI,IAAI,GAAGN,KAAA,CAAMM,IAAI;MACpCH,iBAAA,GAAoB;IACtB;IAEA,IAAIA,iBAAA,IAAqBb,aAAA,EAAe;MACtC,MAAME,aAAA,CAAcF,aAAA,EAAeY,kBAAA,EAAoB;IACzD;IAEA,MAAMK,QAAA,GAAsB;MAC1BH,KAAA,EAAO,WAAWJ,KAAA,GAAQA,KAAA,CAAMI,KAAK,GAAIT,YAAA,EAAcS,KAAA,IAASI,MAAA,CAAOvB,YAAA;MACvEgB,IAAA;MACAQ,MAAA,EAAQ,YAAYT,KAAA,GAAQA,KAAA,CAAMS,MAAM,GAAGd,YAAA,EAAcc,MAAA;MACzDH,IAAA,EAAM,UAAUN,KAAA,GAAQA,KAAA,CAAMM,IAAI,GAAIX,YAAC,EAAcW,IAAA,IAAmBpB,WAAA;MACxEwB,KAAA,EAAO,WAAWV,KAAA,GAAQA,KAAA,CAAMU,KAAK,GAAGf,YAAA,EAAce;IACxD;IAEA,IAAIvB,kBAAA,EAAoB;MACtBI,MAAA,CAAOoB,OAAO,CAAC,GAAG3C,EAAA,CAAG4C,SAAS,CAACL,QAAA,EAAU;QAAEM,cAAA,EAAgB;MAAK,IAAI;IACtE,OAAO,IACL,OAAOzB,aAAA,KAAkB,cACzB,OAAOC,sBAAA,KAA2B,YAClC;MACA,MAAMyB,UAAA,GAAa1B,aAAA,IAAiBC,sBAAA;MACpCyB,UAAA,CAAWP,QAAA;IACb;IAEAX,eAAA,CAAgBW,QAAA;EAClB,GACA,CACEZ,YAAA,EAAcM,IAAA,EACdN,YAAA,EAAcS,KAAA,EACdT,YAAA,EAAcc,MAAA,EACdd,YAAA,EAAcW,IAAA,EACdX,YAAA,EAAce,KAAA,EACdpB,aAAA,EACAL,YAAA,EACAC,WAAA,EACAC,kBAAA,EACAC,aAAA,EACAC,sBAAA,EACAG,aAAA,EACAD,MAAA,CACD;EAGH,MAAMwB,gBAAA,GAAmB5C,WAAA,CACvB,MAAO6C,GAAA;IACL,MAAMjB,cAAA,CAAe;MAAEE,IAAA,EAAMO,MAAA,CAAOQ,GAAA;IAAK;EAC3C,GACA,CAACjB,cAAA,CAAe;EAGlB,MAAMkB,mBAAA,GAAsBhD,KAAA,CAAME,WAAW,CAC3C,MAAO6C,KAAA;IACL,MAAMjB,cAAA,CAAe;MAAEK,KAAA,EAAOI,MAAA,CAAOQ,KAAA;MAAMf,IAAA,EAAM;IAAI;EACvD,GACA,CAACF,cAAA,CAAe;EAGlB,MAAMmB,kBAAA,GAAqB/C,WAAA,CACzB,MAAO6C,KAAA;IACL,MAAMP,MAAA,GAASO,KAAA,KAAQ,KAAKG,SAAA,GAAYH,KAAA;IACxC,MAAMjB,cAAA,CAAe;MAAEU;IAAO;EAChC,GACA,CAACV,cAAA,CAAe;EAGlB,MAAMqB,gBAAA,GAAmBjD,WAAA,CACvB,MAAO6C,KAAA;IACL,MAAMjB,cAAA,CAAe;MAAEO,IAAA,EAAMU;IAAI;EACnC,GACA,CAACjB,cAAA,CAAe;EAGlB,MAAMsB,iBAAA,GAAoBlD,WAAA,CACxB,MAAO6C,KAAA;IACL,MAAMjB,cAAA,CAAe;MAAEW,KAAA,EAAOM;IAAI;EACpC,GACA,CAACjB,cAAA,CAAe;EAGlB;EACA1B,SAAA,CAAU;IACR,IAAIc,kBAAA,EAAoB;MACtB,IAAImC,uBAAA,GAA0B;MAC9B,MAAMf,UAAA,GAAW;QAAE,IAAIV,eAAA,CAAgB0B,OAAO,IAAI,CAAC,CAAC;MAAE;MAEtD;MACA,IAAIxD,QAAA,CAASkB,YAAA,KAAiB,EAAE,WAAWY,eAAA,CAAgB0B,OAAO,CAAD,EAAI;QACnEhB,UAAA,CAASH,KAAK,GAAGI,MAAA,CAAOvB,YAAA;QACxBqC,uBAAA,GAA0B;MAC5B;MAEA;MACA,IAAIpC,WAAA,IAAe,EAAE,UAAUW,eAAA,CAAgB0B,OAAO,CAAD,EAAI;QACvDhB,UAAA,CAASD,IAAI,GAAGpB,WAAA;QAChBoC,uBAAA,GAA0B;MAC5B;MAEA,IAAIA,uBAAA,EAAyB;QAC3B1B,eAAA,CAAgBW,UAAA;QAChBhB,MAAA,CAAOoB,OAAO,CAAC,IAAI3C,EAAA,CAAG4C,SAAS,CAACL,UAAA,GAAW;MAC7C;IACF;EACF,GAAG,CAACrB,WAAA,EAAaD,YAAA,EAAcM,MAAA,EAAQJ,kBAAA,CAAmB;EAE1D,oBACEqC,IAAA,CAAC7C,OAAA,CAAQ8C,QAAQ;IACfC,KAAA,EAAO;MACL1C,IAAA;MACA+B,gBAAA;MACAE,mBAAA;MACAC,kBAAA;MACAE,gBAAA;MACAC,iBAAA;MACArB,KAAA,EAAOL,YAAA;MACPI;IACF;cAECjB;;AAGP","ignoreList":[]}
+{"version":3,"file":"index.js","names":["useRouter","useSearchParams","isNumber","qs","React","createContext","useCallback","useContext","useEffect","useMemo","useState","useListDrawerContext","parseSearchParams","usePreferences","Context","useListQuery","ListQueryProvider","children","collectionSlug","data","defaultLimit","defaultSort","modifySearchParams","onQueryChange","onQueryChangeFromProps","preferenceKey","router","setPreference","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","_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 type { Column } from '../../elements/Table/index.js'\n\nimport { useListDrawerContext } from '../../elements/ListDrawer/Provider.js'\nimport { parseSearchParams } from '../../utilities/parseSearchParams.js'\nimport { usePreferences } from '../Preferences/index.js'\n\nexport type ColumnPreferences = Pick<Column, 'accessor' | 'active'>[]\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  collectionSlug,\n  data,\n  defaultLimit,\n  defaultSort,\n  modifySearchParams,\n  onQueryChange: onQueryChangeFromProps,\n  preferenceKey,\n}) => {\n  'use no memo'\n  const router = useRouter()\n  const { setPreference } = usePreferences()\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  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        router.replace(`?${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;AAI5F,SAASC,oBAAoB,QAAQ;AACrC,SAASC,iBAAiB,QAAQ;AAClC,SAASC,cAAc,QAAQ;AA+B/B,MAAMC,OAAA,gBAAUT,aAAA,CAAc,CAAC;AAE/B,OAAO,MAAMU,YAAA,GAAeA,CAAA;EAAA,OAAwBR,UAAA,CAAAO,OAAW;AAAA;AAE/D,OAAO,MAAME,iBAAA,GAA8CA,CAAC;EAC1DC,QAAQ;EACRC,cAAc;EACdC,IAAI;EACJC,YAAY;EACZC,WAAW;EACXC,kBAAkB;EAClBC,aAAA,EAAeC,sBAAsB;EACrCC;AAAa,CACd;EACC;;EACA,MAAMC,MAAA,GAAS1B,SAAA;EACf,MAAM;IAAE2B;EAAa,CAAE,GAAGd,cAAA;EAC1B,MAAMe,eAAA,GAAkB3B,eAAA;EACxB,MAAM4B,YAAA,GAAepB,OAAA,CAAQ,MAAMG,iBAAA,CAAkBgB,eAAA,GAAkB,CAACA,eAAA,CAAgB;EAExF,MAAM;IAAEL;EAAa,CAAE,GAAGZ,oBAAA;EAE1B,MAAM,CAACmB,YAAA,EAAcC,eAAA,CAAgB,GAAGrB,QAAA,CAAoB;IAC1D,IAAIY,kBAAA,EAAoB;MACtB,OAAOO,YAAA;IACT,OAAO;MACL,OAAO,CAAC;IACV;EACF;EAEA,MAAMG,eAAA,GAAkB5B,KAAA,CAAM6B,MAAM,CAACH,YAAA;EAErC;EACAtB,SAAA,CAAU;IACR,IAAIc,kBAAA,EAAoB;MACtBS,eAAA,CAAgBF,YAAA;IAClB;EACF,GAAG,CAACA,YAAA,EAAcP,kBAAA,CAAmB;EAErC,MAAMY,cAAA,GAAiB5B,WAAA;EACrB;EACA,MAAO6B,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,CAAOnB,YAAA;MACvEgB,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,IAAmBpB,WAAA;MACxEqB,KAAA,EAAO,WAAWP,KAAA,GAAQA,KAAA,CAAMO,KAAK,GAAGZ,YAAA,EAAcY;IACxD;IAEA,IAAIpB,kBAAA,EAAoB;MACtBI,MAAA,CAAOiB,OAAO,CAAC,GAAGxC,EAAA,CAAGyC,SAAS,CAACP,QAAA,EAAU;QAAEQ,cAAA,EAAgB;MAAK,IAAI;IACtE,OAAO,IACL,OAAOtB,aAAA,KAAkB,cACzB,OAAOC,sBAAA,KAA2B,YAClC;MACA,MAAMsB,UAAA,GAAavB,aAAA,IAAiBC,sBAAA;MACpCsB,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,EACdtB,YAAA,EACAC,WAAA,EACAC,kBAAA,EACAC,aAAA,EACAC,sBAAA,EACAE,MAAA,CACD;EAGH,MAAMqB,gBAAA,GAAmBzC,WAAA,CACvB,MAAO0C,GAAA;IACL,MAAMd,cAAA,CAAe;MAAEE,IAAA,EAAMG,MAAA,CAAOS,GAAA;IAAK;EAC3C,GACA,CAACd,cAAA,CAAe;EAGlB,MAAMe,mBAAA,GAAsB7C,KAAA,CAAME,WAAW,CAC3C,MAAO0C,KAAA;IACL,MAAMd,cAAA,CAAe;MAAEI,KAAA,EAAOC,MAAA,CAAOS,KAAA;MAAMZ,IAAA,EAAM;IAAI;EACvD,GACA,CAACF,cAAA,CAAe;EAGlB,MAAMgB,kBAAA,GAAqB5C,WAAA,CACzB,MAAO0C,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,GAAmB9C,WAAA,CACvB,MAAO0C,KAAA;IACL,MAAMd,cAAA,CAAe;MAAEO,IAAA,EAAMO;IAAI;EACnC,GACA,CAACd,cAAA,CAAe;EAGlB,MAAMmB,iBAAA,GAAoB/C,WAAA,CACxB,MAAO0C,KAAA;IACL,MAAMd,cAAA,CAAe;MAAEQ,KAAA,EAAOM;IAAI;EACpC,GACA,CAACd,cAAA,CAAe;EAGlB;EACA1B,SAAA,CAAU;IACR,IAAIc,kBAAA,EAAoB;MACtB,IAAIgC,uBAAA,GAA0B;MAC9B,MAAMjB,UAAA,GAAW;QAAE,IAAIL,eAAA,CAAgBuB,OAAO,IAAI,CAAC,CAAC;MAAE;MAEtD;MACA,IAAIrD,QAAA,CAASkB,YAAA,KAAiB,EAAE,WAAWY,eAAA,CAAgBuB,OAAO,CAAD,EAAI;QACnElB,UAAA,CAASC,KAAK,GAAGC,MAAA,CAAOnB,YAAA;QACxBkC,uBAAA,GAA0B;MAC5B;MAEA;MACA,IAAIjC,WAAA,IAAe,EAAE,UAAUW,eAAA,CAAgBuB,OAAO,CAAD,EAAI;QACvDlB,UAAA,CAASI,IAAI,GAAGpB,WAAA;QAChBiC,uBAAA,GAA0B;MAC5B;MAEA,IAAIA,uBAAA,EAAyB;QAC3BvB,eAAA,CAAgBM,UAAA;QAChBX,MAAA,CAAOiB,OAAO,CAAC,IAAIxC,EAAA,CAAGyC,SAAS,CAACP,UAAA,GAAW;MAC7C;IACF;EACF,GAAG,CAAChB,WAAA,EAAaD,YAAA,EAAcM,MAAA,EAAQJ,kBAAA,CAAmB;EAE1D,oBACEkC,IAAA,CAAC1C,OAAA,CAAQ2C,QAAQ;IACfC,KAAA,EAAO;MACLvC,IAAA;MACA4B,gBAAA;MACAE,mBAAA;MACAC,kBAAA;MACAE,gBAAA;MACAC,iBAAA;MACAlB,KAAA,EAAOL,YAAA;MACPI;IACF;cAECjB;;AAGP","ignoreList":[]}

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/Preferences/index.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAoE,MAAM,OAAO,CAAA;AAQxF,KAAK,kBAAkB,GAAG;IACxB,aAAa,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;IACnD;;;;OAIG;IACH,aAAa,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CAClF,CAAA;AAYD,eAAO,MAAM,mBAAmB,EAAE,KAAK,CAAC,EAAE,CAAC;IAAE,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAAE,CAyHxE,CAAA;AAED,eAAO,MAAM,cAAc,QAAO,kBAAyC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/Preferences/index.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAoE,MAAM,OAAO,CAAA;AAQxF,KAAK,kBAAkB,GAAG;IACxB,aAAa,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;IACnD;;;;OAIG;IACH,aAAa,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CAClF,CAAA;AAYD,eAAO,MAAM,mBAAmB,EAAE,KAAK,CAAC,EAAE,CAAC;IAAE,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAAE,CA0HxE,CAAA;AAED,eAAO,MAAM,cAAc,QAAO,kBAAyC,CAAA"}

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["dequal","React","createContext","useCallback","useContext","useEffect","useRef","useTranslation","requests","deepMergeSimple","useAuth","useConfig","Context","requestOptions","value","language","body","JSON","stringify","headers","PreferencesProvider","children","contextRef","preferencesRef","pendingUpdate","config","user","i18n","routes","api","serverURL","current","getPreference","key","prefs","promise","Promise","resolve","request","get","status","preference","json","setPreference","merge","post","newValue","currentPreference","updatePreference","setTimeout","_jsx","Provider","usePreferences"],"sources":["../../../src/providers/Preferences/index.tsx"],"sourcesContent":["'use client'\nimport { dequal } from 'dequal/lite' // lite: no need for Map and Set support\nimport React, { createContext, useCallback, useContext, useEffect, useRef } from 'react'\n\nimport { useTranslation } from '../../providers/Translation/index.js'\nimport { requests } from '../../utilities/api.js'\nimport { deepMergeSimple } from '../../utilities/deepMerge.js'\nimport { useAuth } from '../Auth/index.js'\nimport { useConfig } from '../Config/index.js'\n\ntype PreferencesContext = {\n  getPreference: <T = any>(key: string) => Promise<T>\n  /**\n   * @param key - a string identifier for the property being set\n   * @param value - preference data to store\n   * @param merge - when true will combine the existing preference object batch the change into one request for objects, default = false\n   */\n  setPreference: <T = any>(key: string, value: T, merge?: boolean) => Promise<void>\n}\n\nconst Context = createContext({} as PreferencesContext)\n\nconst requestOptions = (value, language) => ({\n  body: JSON.stringify({ value }),\n  headers: {\n    'Accept-Language': language,\n    'Content-Type': 'application/json',\n  },\n})\n\nexport const PreferencesProvider: React.FC<{ children?: React.ReactNode }> = ({ children }) => {\n  const contextRef = useRef({} as PreferencesContext)\n  const preferencesRef = useRef({})\n  const pendingUpdate = useRef({})\n  const { config } = useConfig()\n  const { user } = useAuth()\n  const { i18n } = useTranslation()\n\n  const {\n    routes: { api },\n    serverURL,\n  } = config\n\n  useEffect(() => {\n    if (!user) {\n      // clear preferences between users\n      preferencesRef.current = {}\n    }\n  }, [user])\n\n  const getPreference = useCallback(\n    async <T = any,>(key: string): Promise<T> => {\n      const prefs = preferencesRef.current\n      if (typeof prefs[key] !== 'undefined') {\n        return prefs[key]\n      }\n      const promise = new Promise((resolve: (value: T) => void) => {\n        void (async () => {\n          const request = await requests.get(`${serverURL}${api}/payload-preferences/${key}`, {\n            headers: {\n              'Accept-Language': i18n.language,\n            },\n          })\n          let value = null\n          if (request.status === 200) {\n            const preference = await request.json()\n            value = preference.value\n          }\n          preferencesRef.current[key] = value\n          resolve(value)\n        })()\n      })\n      prefs[key] = promise\n      return promise\n    },\n    [i18n.language, api, preferencesRef, serverURL],\n  )\n\n  const setPreference = useCallback(\n    async (key: string, value: unknown, merge = false): Promise<void> => {\n      if (merge === false) {\n        preferencesRef.current[key] = value\n\n        await requests.post(\n          `${serverURL}${api}/payload-preferences/${key}`,\n          requestOptions(value, i18n.language),\n        )\n\n        return\n      }\n\n      let newValue = value\n      const currentPreference = await getPreference(key)\n\n      // handle value objects where multiple values can be set under one key\n      if (\n        typeof value === 'object' &&\n        typeof currentPreference === 'object' &&\n        typeof newValue === 'object'\n      ) {\n        // merge the value with any existing preference for the key\n        if (currentPreference) {\n          newValue = deepMergeSimple(currentPreference, newValue)\n        }\n\n        if (dequal(newValue, currentPreference)) {\n          return\n        }\n\n        // add the requested changes to a pendingUpdate batch for the key\n        pendingUpdate.current[key] = {\n          ...pendingUpdate.current[key],\n          ...(newValue as Record<string, unknown>),\n        }\n      } else {\n        if (newValue === currentPreference) {\n          return\n        }\n        pendingUpdate.current[key] = newValue\n      }\n\n      const updatePreference = async () => {\n        // compare the value stored in context before sending to eliminate duplicate requests\n        if (dequal(pendingUpdate.current[key], preferencesRef.current[key])) {\n          return\n        }\n\n        // preference set in context here to prevent other updatePreference at the same time\n        preferencesRef.current[key] = pendingUpdate.current[key]\n\n        await requests.post(\n          `${serverURL}${api}/payload-preferences/${key}`,\n          requestOptions(preferencesRef.current[key], i18n.language),\n        )\n\n        // reset any changes for this key after sending the request\n        delete pendingUpdate.current[key]\n      }\n\n      // use timeout to allow multiple changes of different values using the same key in one request\n      setTimeout(() => {\n        void updatePreference()\n      })\n    },\n    [api, getPreference, i18n.language, pendingUpdate, serverURL],\n  )\n\n  contextRef.current.getPreference = getPreference\n  contextRef.current.setPreference = setPreference\n\n  return <Context.Provider value={contextRef.current}>{children}</Context.Provider>\n}\n\nexport const usePreferences = (): PreferencesContext => useContext(Context)\n"],"mappings":"AAAA;;;AACA,SAASA,MAAM,QAAQ,cAAa,CAAC;AACrC,OAAOC,KAAA,IAASC,aAAa,EAAEC,WAAW,EAAEC,UAAU,EAAEC,SAAS,EAAEC,MAAM,QAAQ;AAEjF,SAASC,cAAc,QAAQ;AAC/B,SAASC,QAAQ,QAAQ;AACzB,SAASC,eAAe,QAAQ;AAChC,SAASC,OAAO,QAAQ;AACxB,SAASC,SAAS,QAAQ;AAY1B,MAAMC,OAAA,gBAAUV,aAAA,CAAc,CAAC;AAE/B,MAAMW,cAAA,GAAiBA,CAACC,KAAA,EAAOC,QAAA,MAAc;EAC3CC,IAAA,EAAMC,IAAA,CAAKC,SAAS,CAAC;IAAEJ;EAAM;EAC7BK,OAAA,EAAS;IACP,mBAAmBJ,QAAA;IACnB,gBAAgB;EAClB;AACF;AAEA,OAAO,MAAMK,mBAAA,GAAgEA,CAAC;EAAEC;AAAQ,CAAE;EACxF,MAAMC,UAAA,GAAahB,MAAA,CAAO,CAAC;EAC3B,MAAMiB,cAAA,GAAiBjB,MAAA,CAAO,CAAC;EAC/B,MAAMkB,aAAA,GAAgBlB,MAAA,CAAO,CAAC;EAC9B,MAAM;IAAEmB;EAAM,CAAE,GAAGd,SAAA;EACnB,MAAM;IAAEe;EAAI,CAAE,GAAGhB,OAAA;EACjB,MAAM;IAAEiB;EAAI,CAAE,GAAGpB,cAAA;EAEjB,MAAM;IACJqB,MAAA,EAAQ;MAAEC;IAAG,CAAE;IACfC;EAAS,CACV,GAAGL,MAAA;EAEJpB,SAAA,CAAU;IACR,IAAI,CAACqB,IAAA,EAAM;MACT;MACAH,cAAA,CAAeQ,OAAO,GAAG,CAAC;IAC5B;EACF,GAAG,CAACL,IAAA,CAAK;EAET,MAAMM,aAAA,GAAgB7B,WAAA,CACpB,MAAiB8B,GAAA;IACf,MAAMC,KAAA,GAAQX,cAAA,CAAeQ,OAAO;IACpC,IAAI,OAAOG,KAAK,CAACD,GAAA,CAAI,KAAK,aAAa;MACrC,OAAOC,KAAK,CAACD,GAAA,CAAI;IACnB;IACA,MAAME,OAAA,GAAU,IAAIC,OAAA,CAASC,OAAA;MAC3B,KAAK,CAAC;QACJ,MAAMC,OAAA,GAAU,MAAM9B,QAAA,CAAS+B,GAAG,CAAC,GAAGT,SAAA,GAAYD,GAAA,wBAA2BI,GAAA,EAAK,EAAE;UAClFd,OAAA,EAAS;YACP,mBAAmBQ,IAAA,CAAKZ;UAC1B;QACF;QACA,IAAID,KAAA,GAAQ;QACZ,IAAIwB,OAAA,CAAQE,MAAM,KAAK,KAAK;UAC1B,MAAMC,UAAA,GAAa,MAAMH,OAAA,CAAQI,IAAI;UACrC5B,KAAA,GAAQ2B,UAAA,CAAW3B,KAAK;QAC1B;QACAS,cAAA,CAAeQ,OAAO,CAACE,GAAA,CAAI,GAAGnB,KAAA;QAC9BuB,OAAA,CAAQvB,KAAA;MACV;IACF;IACAoB,KAAK,CAACD,GAAA,CAAI,GAAGE,OAAA;IACb,OAAOA,OAAA;EACT,GACA,CAACR,IAAA,CAAKZ,QAAQ,EAAEc,GAAA,EAAKN,cAAA,EAAgBO,SAAA,CAAU;EAGjD,MAAMa,aAAA,GAAgBxC,WAAA,CACpB,OAAO8B,KAAA,EAAanB,OAAA,EAAgB8B,KAAA,GAAQ,KAAK;IAC/C,IAAIA,KAAA,KAAU,OAAO;MACnBrB,cAAA,CAAeQ,OAAO,CAACE,KAAA,CAAI,GAAGnB,OAAA;MAE9B,MAAMN,QAAA,CAASqC,IAAI,CACjB,GAAGf,SAAA,GAAYD,GAAA,wBAA2BI,KAAA,EAAK,EAC/CpB,cAAA,CAAeC,OAAA,EAAOa,IAAA,CAAKZ,QAAQ;MAGrC;IACF;IAEA,IAAI+B,QAAA,GAAWhC,OAAA;IACf,MAAMiC,iBAAA,GAAoB,MAAMf,aAAA,CAAcC,KAAA;IAE9C;IACA,IACE,OAAOnB,OAAA,KAAU,YACjB,OAAOiC,iBAAA,KAAsB,YAC7B,OAAOD,QAAA,KAAa,UACpB;MACA;MACA,IAAIC,iBAAA,EAAmB;QACrBD,QAAA,GAAWrC,eAAA,CAAgBsC,iBAAA,EAAmBD,QAAA;MAChD;MAEA,IAAI9C,MAAA,CAAO8C,QAAA,EAAUC,iBAAA,GAAoB;QACvC;MACF;MAEA;MACAvB,aAAA,CAAcO,OAAO,CAACE,KAAA,CAAI,GAAG;QAC3B,GAAGT,aAAA,CAAcO,OAAO,CAACE,KAAA,CAAI;QAC7B,GAAIa;MACN;IACF,OAAO;MACL,IAAIA,QAAA,KAAaC,iBAAA,EAAmB;QAClC;MACF;MACAvB,aAAA,CAAcO,OAAO,CAACE,KAAA,CAAI,GAAGa,QAAA;IAC/B;IAEA,MAAME,gBAAA,GAAmB,MAAAA,CAAA;MACvB;MACA,IAAIhD,MAAA,CAAOwB,aAAA,CAAcO,OAAO,CAACE,KAAA,CAAI,EAAEV,cAAA,CAAeQ,OAAO,CAACE,KAAA,CAAI,GAAG;QACnE;MACF;MAEA;MACAV,cAAA,CAAeQ,OAAO,CAACE,KAAA,CAAI,GAAGT,aAAA,CAAcO,OAAO,CAACE,KAAA,CAAI;MAExD,MAAMzB,QAAA,CAASqC,IAAI,CACjB,GAAGf,SAAA,GAAYD,GAAA,wBAA2BI,KAAA,EAAK,EAC/CpB,cAAA,CAAeU,cAAA,CAAeQ,OAAO,CAACE,KAAA,CAAI,EAAEN,IAAA,CAAKZ,QAAQ;MAG3D;MACA,OAAOS,aAAA,CAAcO,OAAO,CAACE,KAAA,CAAI;IACnC;IAEA;IACAgB,UAAA,CAAW;MACT,KAAKD,gBAAA;IACP;EACF,GACA,CAACnB,GAAA,EAAKG,aAAA,EAAeL,IAAA,CAAKZ,QAAQ,EAAES,aAAA,EAAeM,SAAA,CAAU;EAG/DR,UAAA,CAAWS,OAAO,CAACC,aAAa,GAAGA,aAAA;EACnCV,UAAA,CAAWS,OAAO,CAACY,aAAa,GAAGA,aAAA;EAEnC,oBAAOO,IAAA,CAACtC,OAAA,CAAQuC,QAAQ;IAACrC,KAAA,EAAOQ,UAAA,CAAWS,OAAO;cAAGV;;AACvD;AAEA,OAAO,MAAM+B,cAAA,GAAiBA,CAAA;EAAA,OAA0BhD,UAAA,CAAAQ,OAAW;AAAA","ignoreList":[]}
+{"version":3,"file":"index.js","names":["dequal","React","createContext","useCallback","useContext","useEffect","useRef","useTranslation","requests","deepMergeSimple","useAuth","useConfig","Context","requestOptions","value","language","body","JSON","stringify","headers","PreferencesProvider","children","contextRef","preferencesRef","pendingUpdate","config","user","i18n","routes","api","serverURL","current","getPreference","key","prefs","promise","Promise","resolve","request","get","status","preference","json","setPreference","merge","post","newValue","currentPreference","updatePreference","setTimeout","_jsx","Provider","usePreferences"],"sources":["../../../src/providers/Preferences/index.tsx"],"sourcesContent":["'use client'\nimport { dequal } from 'dequal/lite' // lite: no need for Map and Set support\nimport React, { createContext, useCallback, useContext, useEffect, useRef } from 'react'\n\nimport { useTranslation } from '../../providers/Translation/index.js'\nimport { requests } from '../../utilities/api.js'\nimport { deepMergeSimple } from '../../utilities/deepMerge.js'\nimport { useAuth } from '../Auth/index.js'\nimport { useConfig } from '../Config/index.js'\n\ntype PreferencesContext = {\n  getPreference: <T = any>(key: string) => Promise<T>\n  /**\n   * @param key - a string identifier for the property being set\n   * @param value - preference data to store\n   * @param merge - when true will combine the existing preference object batch the change into one request for objects, default = false\n   */\n  setPreference: <T = any>(key: string, value: T, merge?: boolean) => Promise<void>\n}\n\nconst Context = createContext({} as PreferencesContext)\n\nconst requestOptions = (value, language) => ({\n  body: JSON.stringify({ value }),\n  headers: {\n    'Accept-Language': language,\n    'Content-Type': 'application/json',\n  },\n})\n\nexport const PreferencesProvider: React.FC<{ children?: React.ReactNode }> = ({ children }) => {\n  const contextRef = useRef({} as PreferencesContext)\n  const preferencesRef = useRef({})\n  const pendingUpdate = useRef({})\n  const { config } = useConfig()\n  const { user } = useAuth()\n  const { i18n } = useTranslation()\n\n  const {\n    routes: { api },\n    serverURL,\n  } = config\n\n  useEffect(() => {\n    if (!user) {\n      // clear preferences between users\n      preferencesRef.current = {}\n    }\n  }, [user])\n\n  const getPreference = useCallback(\n    async <T = any,>(key: string): Promise<T> => {\n      const prefs = preferencesRef.current\n      if (typeof prefs[key] !== 'undefined') {\n        return prefs[key]\n      }\n      const promise = new Promise((resolve: (value: T) => void) => {\n        void (async () => {\n          const request = await requests.get(`${serverURL}${api}/payload-preferences/${key}`, {\n            headers: {\n              'Accept-Language': i18n.language,\n            },\n          })\n          let value = null\n          if (request.status === 200) {\n            const preference = await request.json()\n            value = preference.value\n          }\n          preferencesRef.current[key] = value\n          resolve(value)\n        })()\n      })\n      prefs[key] = promise\n      return promise\n    },\n    [i18n.language, api, preferencesRef, serverURL],\n  )\n\n  const setPreference = useCallback(\n    async (key: string, value: unknown, merge = false): Promise<void> => {\n      if (merge === false) {\n        preferencesRef.current[key] = value\n\n        await requests.post(\n          `${serverURL}${api}/payload-preferences/${key}`,\n          requestOptions(value, i18n.language),\n        )\n\n        return\n      }\n\n      let newValue = value\n      const currentPreference = await getPreference(key)\n\n      // handle value objects where multiple values can be set under one key\n      if (\n        typeof value === 'object' &&\n        typeof currentPreference === 'object' &&\n        typeof newValue === 'object'\n      ) {\n        // merge the value with any existing preference for the key\n        if (currentPreference) {\n          newValue = deepMergeSimple(currentPreference, newValue)\n        }\n\n        if (dequal(newValue, currentPreference)) {\n          return\n        }\n\n        // add the requested changes to a pendingUpdate batch for the key\n        pendingUpdate.current[key] = {\n          ...pendingUpdate.current[key],\n          ...(newValue as Record<string, unknown>),\n        }\n      } else {\n        if (newValue === currentPreference) {\n          return\n        }\n\n        pendingUpdate.current[key] = newValue\n      }\n\n      const updatePreference = async () => {\n        // compare the value stored in context before sending to eliminate duplicate requests\n        if (dequal(pendingUpdate.current[key], preferencesRef.current[key])) {\n          return\n        }\n\n        // preference set in context here to prevent other updatePreference at the same time\n        preferencesRef.current[key] = pendingUpdate.current[key]\n\n        await requests.post(\n          `${serverURL}${api}/payload-preferences/${key}`,\n          requestOptions(preferencesRef.current[key], i18n.language),\n        )\n\n        // reset any changes for this key after sending the request\n        delete pendingUpdate.current[key]\n      }\n\n      // use timeout to allow multiple changes of different values using the same key in one request\n      setTimeout(() => {\n        void updatePreference()\n      })\n    },\n    [api, getPreference, i18n.language, pendingUpdate, serverURL],\n  )\n\n  contextRef.current.getPreference = getPreference\n  contextRef.current.setPreference = setPreference\n\n  return <Context.Provider value={contextRef.current}>{children}</Context.Provider>\n}\n\nexport const usePreferences = (): PreferencesContext => useContext(Context)\n"],"mappings":"AAAA;;;AACA,SAASA,MAAM,QAAQ,cAAa,CAAC;AACrC,OAAOC,KAAA,IAASC,aAAa,EAAEC,WAAW,EAAEC,UAAU,EAAEC,SAAS,EAAEC,MAAM,QAAQ;AAEjF,SAASC,cAAc,QAAQ;AAC/B,SAASC,QAAQ,QAAQ;AACzB,SAASC,eAAe,QAAQ;AAChC,SAASC,OAAO,QAAQ;AACxB,SAASC,SAAS,QAAQ;AAY1B,MAAMC,OAAA,gBAAUV,aAAA,CAAc,CAAC;AAE/B,MAAMW,cAAA,GAAiBA,CAACC,KAAA,EAAOC,QAAA,MAAc;EAC3CC,IAAA,EAAMC,IAAA,CAAKC,SAAS,CAAC;IAAEJ;EAAM;EAC7BK,OAAA,EAAS;IACP,mBAAmBJ,QAAA;IACnB,gBAAgB;EAClB;AACF;AAEA,OAAO,MAAMK,mBAAA,GAAgEA,CAAC;EAAEC;AAAQ,CAAE;EACxF,MAAMC,UAAA,GAAahB,MAAA,CAAO,CAAC;EAC3B,MAAMiB,cAAA,GAAiBjB,MAAA,CAAO,CAAC;EAC/B,MAAMkB,aAAA,GAAgBlB,MAAA,CAAO,CAAC;EAC9B,MAAM;IAAEmB;EAAM,CAAE,GAAGd,SAAA;EACnB,MAAM;IAAEe;EAAI,CAAE,GAAGhB,OAAA;EACjB,MAAM;IAAEiB;EAAI,CAAE,GAAGpB,cAAA;EAEjB,MAAM;IACJqB,MAAA,EAAQ;MAAEC;IAAG,CAAE;IACfC;EAAS,CACV,GAAGL,MAAA;EAEJpB,SAAA,CAAU;IACR,IAAI,CAACqB,IAAA,EAAM;MACT;MACAH,cAAA,CAAeQ,OAAO,GAAG,CAAC;IAC5B;EACF,GAAG,CAACL,IAAA,CAAK;EAET,MAAMM,aAAA,GAAgB7B,WAAA,CACpB,MAAiB8B,GAAA;IACf,MAAMC,KAAA,GAAQX,cAAA,CAAeQ,OAAO;IACpC,IAAI,OAAOG,KAAK,CAACD,GAAA,CAAI,KAAK,aAAa;MACrC,OAAOC,KAAK,CAACD,GAAA,CAAI;IACnB;IACA,MAAME,OAAA,GAAU,IAAIC,OAAA,CAASC,OAAA;MAC3B,KAAK,CAAC;QACJ,MAAMC,OAAA,GAAU,MAAM9B,QAAA,CAAS+B,GAAG,CAAC,GAAGT,SAAA,GAAYD,GAAA,wBAA2BI,GAAA,EAAK,EAAE;UAClFd,OAAA,EAAS;YACP,mBAAmBQ,IAAA,CAAKZ;UAC1B;QACF;QACA,IAAID,KAAA,GAAQ;QACZ,IAAIwB,OAAA,CAAQE,MAAM,KAAK,KAAK;UAC1B,MAAMC,UAAA,GAAa,MAAMH,OAAA,CAAQI,IAAI;UACrC5B,KAAA,GAAQ2B,UAAA,CAAW3B,KAAK;QAC1B;QACAS,cAAA,CAAeQ,OAAO,CAACE,GAAA,CAAI,GAAGnB,KAAA;QAC9BuB,OAAA,CAAQvB,KAAA;MACV;IACF;IACAoB,KAAK,CAACD,GAAA,CAAI,GAAGE,OAAA;IACb,OAAOA,OAAA;EACT,GACA,CAACR,IAAA,CAAKZ,QAAQ,EAAEc,GAAA,EAAKN,cAAA,EAAgBO,SAAA,CAAU;EAGjD,MAAMa,aAAA,GAAgBxC,WAAA,CACpB,OAAO8B,KAAA,EAAanB,OAAA,EAAgB8B,KAAA,GAAQ,KAAK;IAC/C,IAAIA,KAAA,KAAU,OAAO;MACnBrB,cAAA,CAAeQ,OAAO,CAACE,KAAA,CAAI,GAAGnB,OAAA;MAE9B,MAAMN,QAAA,CAASqC,IAAI,CACjB,GAAGf,SAAA,GAAYD,GAAA,wBAA2BI,KAAA,EAAK,EAC/CpB,cAAA,CAAeC,OAAA,EAAOa,IAAA,CAAKZ,QAAQ;MAGrC;IACF;IAEA,IAAI+B,QAAA,GAAWhC,OAAA;IACf,MAAMiC,iBAAA,GAAoB,MAAMf,aAAA,CAAcC,KAAA;IAE9C;IACA,IACE,OAAOnB,OAAA,KAAU,YACjB,OAAOiC,iBAAA,KAAsB,YAC7B,OAAOD,QAAA,KAAa,UACpB;MACA;MACA,IAAIC,iBAAA,EAAmB;QACrBD,QAAA,GAAWrC,eAAA,CAAgBsC,iBAAA,EAAmBD,QAAA;MAChD;MAEA,IAAI9C,MAAA,CAAO8C,QAAA,EAAUC,iBAAA,GAAoB;QACvC;MACF;MAEA;MACAvB,aAAA,CAAcO,OAAO,CAACE,KAAA,CAAI,GAAG;QAC3B,GAAGT,aAAA,CAAcO,OAAO,CAACE,KAAA,CAAI;QAC7B,GAAIa;MACN;IACF,OAAO;MACL,IAAIA,QAAA,KAAaC,iBAAA,EAAmB;QAClC;MACF;MAEAvB,aAAA,CAAcO,OAAO,CAACE,KAAA,CAAI,GAAGa,QAAA;IAC/B;IAEA,MAAME,gBAAA,GAAmB,MAAAA,CAAA;MACvB;MACA,IAAIhD,MAAA,CAAOwB,aAAA,CAAcO,OAAO,CAACE,KAAA,CAAI,EAAEV,cAAA,CAAeQ,OAAO,CAACE,KAAA,CAAI,GAAG;QACnE;MACF;MAEA;MACAV,cAAA,CAAeQ,OAAO,CAACE,KAAA,CAAI,GAAGT,aAAA,CAAcO,OAAO,CAACE,KAAA,CAAI;MAExD,MAAMzB,QAAA,CAASqC,IAAI,CACjB,GAAGf,SAAA,GAAYD,GAAA,wBAA2BI,KAAA,EAAK,EAC/CpB,cAAA,CAAeU,cAAA,CAAeQ,OAAO,CAACE,KAAA,CAAI,EAAEN,IAAA,CAAKZ,QAAQ;MAG3D;MACA,OAAOS,aAAA,CAAcO,OAAO,CAACE,KAAA,CAAI;IACnC;IAEA;IACAgB,UAAA,CAAW;MACT,KAAKD,gBAAA;IACP;EACF,GACA,CAACnB,GAAA,EAAKG,aAAA,EAAeL,IAAA,CAAKZ,QAAQ,EAAES,aAAA,EAAeM,SAAA,CAAU;EAG/DR,UAAA,CAAWS,OAAO,CAACC,aAAa,GAAGA,aAAA;EACnCV,UAAA,CAAWS,OAAO,CAACY,aAAa,GAAGA,aAAA;EAEnC,oBAAOO,IAAA,CAACtC,OAAA,CAAQuC,QAAQ;IAACrC,KAAA,EAAOQ,UAAA,CAAWS,OAAO;cAAGV;;AACvD;AAEA,OAAO,MAAM+B,cAAA,GAAiBA,CAAA;EAAA,OAA0BhD,UAAA,CAAAQ,OAAW;AAAA","ignoreList":[]}

package/dist/utilities/buildTableState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"buildTableState.d.ts","sourceRoot":"","sources":["../../src/utilities/buildTableState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EAEnB,YAAY,EACZ,WAAW,EACX,aAAa,EAEd,MAAM,SAAS,CAAA;AAKhB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AAKxE,KAAK,4BAA4B,GAAG;IAClC,YAAY,CAAC,EAAE,YAAY,CAAA;IAC3B,IAAI,EAAE,aAAa,CAAA;IACnB,MAAM,CAAC,EAAE,KAAK,CAAA;IACd,WAAW,EAAE,eAAe,CAAA;IAC5B,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC,CAAA;IAC7C,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,KAAK,EAAE,KAAK,CAAC,SAAS,CAAA;CACvB,CAAA;AAED,KAAK,0BAA0B,GAAG;IAChC,IAAI,CAAC,EAAE,GAAG,CAAA;IACV,eAAe,CAAC,EAAE,KAAK,CAAA;IACvB,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,GAAG,CACA;IACE,OAAO,EAAE,MAAM,CAAA;CAChB,GACD,WAAW,CACd,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,0BAA0B,GAAG,4BAA4B,CAAA;AAE7F,eAAO,MAAM,sBAAsB,SAC3B,mBAAmB,KACxB,OAAO,CAAC,qBAAqB,CAqB/B,CAAA;AAED,eAAO,MAAM,eAAe,SACpB,mBAAmB,KACxB,OAAO,CAAC,4BAA4B,CA8KtC,CAAA"}
+{"version":3,"file":"buildTableState.d.ts","sourceRoot":"","sources":["../../src/utilities/buildTableState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EAEnB,YAAY,EACZ,WAAW,EACX,aAAa,EAEd,MAAM,SAAS,CAAA;AAKhB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AAMxE,KAAK,4BAA4B,GAAG;IAClC,YAAY,CAAC,EAAE,YAAY,CAAA;IAC3B,IAAI,EAAE,aAAa,CAAA;IACnB,MAAM,CAAC,EAAE,KAAK,CAAA;IACd,WAAW,EAAE,eAAe,CAAA;IAC5B,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC,CAAA;IAC7C,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,KAAK,EAAE,KAAK,CAAC,SAAS,CAAA;CACvB,CAAA;AAED,KAAK,0BAA0B,GAAG;IAChC,IAAI,CAAC,EAAE,GAAG,CAAA;IACV,eAAe,CAAC,EAAE,KAAK,CAAA;IACvB,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,GAAG,CACA;IACE,OAAO,EAAE,MAAM,CAAA;CAChB,GACD,WAAW,CACd,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,0BAA0B,GAAG,4BAA4B,CAAA;AAE7F,eAAO,MAAM,sBAAsB,SAC3B,mBAAmB,KACxB,OAAO,CAAC,qBAAqB,CAqB/B,CAAA;AAED,eAAO,MAAM,eAAe,SACpB,mBAAmB,KACxB,OAAO,CAAC,4BAA4B,CAyHtC,CAAA"}

package/dist/utilities/buildTableState.js

@@ -1,7 +1,8 @@
-import { dequal } from 'dequal/lite';
 import { formatErrors } from 'payload';
+import { isNumber } from 'payload/shared';
 import { getClientConfig } from './getClientConfig.js';
 import { renderFilters, renderTable } from './renderTable.js';
+import { upsertPreferences } from './upsertPreferences.js';
 export const buildTableStateHandler = async args => {
   const {
     req
@@ -84,59 +85,15 @@ export const buildTableState = async args => {
     collectionConfig = req.payload.collections[collectionSlug].config;
     clientCollectionConfig = clientConfig.collections.find(collection => collection.slug === collectionSlug);
   }
-  // get prefs, then set update them using the columns that we just received
-  const preferencesKey = `${collectionSlug}-list`;
-  const preferencesResult = await payload.find({
-    collection: 'payload-preferences',
-    depth: 0,
-    limit: 1,
-    pagination: false,
-    where: {
-      and: [{
-        key: {
-          equals: preferencesKey
-        }
-      }, {
-        'user.relationTo': {
-          equals: user.collection
-        }
-      }, {
-        'user.value': {
-          equals: user.id
-        }
-      }]
+  const listPreferences = await upsertPreferences({
+    key: `${collectionSlug}-list`,
+    req,
+    value: {
+      columns,
+      limit: isNumber(query?.limit) ? Number(query.limit) : undefined,
+      sort: query?.sort
     }
-  }).then(res => res.docs[0] ?? {
-    id: null,
-    value: {}
   });
-  let newPrefs = preferencesResult.value;
-  if (!preferencesResult.id || !dequal(columns, preferencesResult?.columns)) {
-    const preferencesArgs = {
-      collection: 'payload-preferences',
-      data: {
-        key: preferencesKey,
-        user: {
-          collection: user.collection,
-          value: user.id
-        },
-        value: {
-          ...(preferencesResult?.value || {}),
-          columns
-        }
-      },
-      depth: 0,
-      req
-    };
-    if (preferencesResult.id) {
-      newPrefs = await payload.update({
-        ...preferencesArgs,
-        id: preferencesResult.id
-      })?.then(res => res.value);
-    } else {
-      newPrefs = await payload.create(preferencesArgs)?.then(res => res.value);
-    }
-  }
   let docs = docsFromArgs;
   let data;
   // lookup docs, if desired, i.e. within `join` field which initialize with `depth: 0`
@@ -172,7 +129,7 @@ export const buildTableState = async args => {
   const renderedFilters = renderFilters(collectionConfig.fields, req.payload.importMap);
   return {
     data,
-    preferences: newPrefs,
+    preferences: listPreferences,
     renderedFilters,
     state: columnState,
     Table

package/dist/utilities/buildTableState.js.map

@@ -1 +1 @@
-{"version":3,"file":"buildTableState.js","names":["dequal","formatErrors","getClientConfig","renderFilters","renderTable","buildTableStateHandler","args","req","res","buildTableState","err","payload","logger","error","msg","message","collectionSlug","columns","docs","docsFromArgs","enableRowSelections","query","renderRowTypes","i18n","config","user","tableAppearance","incomingUserSlug","collection","adminUserSlug","admin","adminAccessFunction","collections","access","canAccessAdmin","Error","hasUsers","find","depth","limit","pagination","length","clientConfig","importMap","collectionConfig","clientCollectionConfig","slug","preferencesKey","preferencesResult","where","and","key","equals","id","then","value","newPrefs","preferencesArgs","data","update","create","parseInt","undefined","overrideAccess","page","sort","columnState","Table","columnPreferences","useAsTitle","renderedFilters","fields","preferences","state"],"sources":["../../src/utilities/buildTableState.ts"],"sourcesContent":["import type {\n  BuildTableStateArgs,\n  ClientCollectionConfig,\n  ClientConfig,\n  ErrorResult,\n  PaginatedDocs,\n  SanitizedCollectionConfig,\n} from 'payload'\n\nimport { dequal } from 'dequal/lite'\nimport { formatErrors } from 'payload'\n\nimport type { Column } from '../elements/Table/index.js'\nimport type { ListPreferences } from '../elements/TableColumns/index.js'\n\nimport { getClientConfig } from './getClientConfig.js'\nimport { renderFilters, renderTable } from './renderTable.js'\n\ntype BuildTableStateSuccessResult = {\n  clientConfig?: ClientConfig\n  data: PaginatedDocs\n  errors?: never\n  preferences: ListPreferences\n  renderedFilters: Map<string, React.ReactNode>\n  state: Column[]\n  Table: React.ReactNode\n}\n\ntype BuildTableStateErrorResult = {\n  data?: any\n  renderedFilters?: never\n  state?: never\n  Table?: never\n} & (\n  | {\n      message: string\n    }\n  | ErrorResult\n)\n\nexport type BuildTableStateResult = BuildTableStateErrorResult | BuildTableStateSuccessResult\n\nexport const buildTableStateHandler = async (\n  args: BuildTableStateArgs,\n): Promise<BuildTableStateResult> => {\n  const { req } = args\n\n  try {\n    const res = await buildTableState(args)\n    return res\n  } catch (err) {\n    req.payload.logger.error({ err, msg: `There was an error building form state` })\n\n    if (err.message === 'Could not find field schema for given path') {\n      return {\n        message: err.message,\n      }\n    }\n\n    if (err.message === 'Unauthorized') {\n      return null\n    }\n\n    return formatErrors(err)\n  }\n}\n\nexport const buildTableState = async (\n  args: BuildTableStateArgs,\n): Promise<BuildTableStateSuccessResult> => {\n  const {\n    collectionSlug,\n    columns,\n    docs: docsFromArgs,\n    enableRowSelections,\n    query,\n    renderRowTypes,\n    req,\n    req: {\n      i18n,\n      payload,\n      payload: { config },\n      user,\n    },\n    tableAppearance,\n  } = args\n\n  const incomingUserSlug = user?.collection\n\n  const adminUserSlug = config.admin.user\n\n  // If we have a user slug, test it against the functions\n  if (incomingUserSlug) {\n    const adminAccessFunction = payload.collections[incomingUserSlug].config.access?.admin\n\n    // Run the admin access function from the config if it exists\n    if (adminAccessFunction) {\n      const canAccessAdmin = await adminAccessFunction({ req })\n\n      if (!canAccessAdmin) {\n        throw new Error('Unauthorized')\n      }\n\n      // Match the user collection to the global admin config\n    } else if (adminUserSlug !== incomingUserSlug) {\n      throw new Error('Unauthorized')\n    }\n  } else {\n    const hasUsers = await payload.find({\n      collection: adminUserSlug,\n      depth: 0,\n      limit: 1,\n      pagination: false,\n    })\n\n    // If there are users, we should not allow access because of /create-first-user\n    if (hasUsers.docs.length) {\n      throw new Error('Unauthorized')\n    }\n  }\n\n  const clientConfig = getClientConfig({\n    config,\n    i18n,\n    importMap: payload.importMap,\n  })\n\n  let collectionConfig: SanitizedCollectionConfig\n  let clientCollectionConfig: ClientCollectionConfig\n\n  if (req.payload.collections[collectionSlug]) {\n    collectionConfig = req.payload.collections[collectionSlug].config\n    clientCollectionConfig = clientConfig.collections.find(\n      (collection) => collection.slug === collectionSlug,\n    )\n  }\n\n  // get prefs, then set update them using the columns that we just received\n  const preferencesKey = `${collectionSlug}-list`\n\n  const preferencesResult = await payload\n    .find({\n      collection: 'payload-preferences',\n      depth: 0,\n      limit: 1,\n      pagination: false,\n      where: {\n        and: [\n          {\n            key: {\n              equals: preferencesKey,\n            },\n          },\n          {\n            'user.relationTo': {\n              equals: user.collection,\n            },\n          },\n          {\n            'user.value': {\n              equals: user.id,\n            },\n          },\n        ],\n      },\n    })\n    .then((res) => res.docs[0] ?? { id: null, value: {} })\n\n  let newPrefs = preferencesResult.value\n\n  if (!preferencesResult.id || !dequal(columns, preferencesResult?.columns)) {\n    const preferencesArgs = {\n      collection: 'payload-preferences',\n      data: {\n        key: preferencesKey,\n        user: {\n          collection: user.collection,\n          value: user.id,\n        },\n        value: {\n          ...(preferencesResult?.value || {}),\n          columns,\n        },\n      },\n      depth: 0,\n      req,\n    }\n\n    if (preferencesResult.id) {\n      newPrefs = await payload\n        .update({\n          ...preferencesArgs,\n          id: preferencesResult.id,\n        })\n        ?.then((res) => res.value as ListPreferences)\n    } else {\n      newPrefs = await payload.create(preferencesArgs)?.then((res) => res.value as ListPreferences)\n    }\n  }\n\n  let docs = docsFromArgs\n  let data: PaginatedDocs\n\n  // lookup docs, if desired, i.e. within `join` field which initialize with `depth: 0`\n\n  if (!docs || query) {\n    data = await payload.find({\n      collection: collectionSlug,\n      depth: 0,\n      limit: query?.limit ? parseInt(query.limit, 10) : undefined,\n      overrideAccess: false,\n      page: query?.page ? parseInt(query.page, 10) : undefined,\n      sort: query?.sort,\n      user: req.user,\n      where: query?.where,\n    })\n\n    docs = data.docs\n  }\n\n  const { columnState, Table } = renderTable({\n    clientCollectionConfig,\n    collectionConfig,\n    columnPreferences: undefined, // TODO, might not be needed\n    columns,\n    docs,\n    enableRowSelections,\n    i18n: req.i18n,\n    payload,\n    renderRowTypes,\n    tableAppearance,\n    useAsTitle: collectionConfig.admin.useAsTitle,\n  })\n\n  const renderedFilters = renderFilters(collectionConfig.fields, req.payload.importMap)\n\n  return {\n    data,\n    preferences: newPrefs,\n    renderedFilters,\n    state: columnState,\n    Table,\n  }\n}\n"],"mappings":"AASA,SAASA,MAAM,QAAQ;AACvB,SAASC,YAAY,QAAQ;AAK7B,SAASC,eAAe,QAAQ;AAChC,SAASC,aAAa,EAAEC,WAAW,QAAQ;AA0B3C,OAAO,MAAMC,sBAAA,GAAyB,MACpCC,IAAA;EAEA,MAAM;IAAEC;EAAG,CAAE,GAAGD,IAAA;EAEhB,IAAI;IACF,MAAME,GAAA,GAAM,MAAMC,eAAA,CAAgBH,IAAA;IAClC,OAAOE,GAAA;EACT,EAAE,OAAOE,GAAA,EAAK;IACZH,GAAA,CAAII,OAAO,CAACC,MAAM,CAACC,KAAK,CAAC;MAAEH,GAAA;MAAKI,GAAA,EAAK;IAAyC;IAE9E,IAAIJ,GAAA,CAAIK,OAAO,KAAK,8CAA8C;MAChE,OAAO;QACLA,OAAA,EAASL,GAAA,CAAIK;MACf;IACF;IAEA,IAAIL,GAAA,CAAIK,OAAO,KAAK,gBAAgB;MAClC,OAAO;IACT;IAEA,OAAOd,YAAA,CAAaS,GAAA;EACtB;AACF;AAEA,OAAO,MAAMD,eAAA,GAAkB,MAC7BH,IAAA;EAEA,MAAM;IACJU,cAAc;IACdC,OAAO;IACPC,IAAA,EAAMC,YAAY;IAClBC,mBAAmB;IACnBC,KAAK;IACLC,cAAc;IACdf,GAAG;IACHA,GAAA,EAAK;MACHgB,IAAI;MACJZ,OAAO;MACPA,OAAA,EAAS;QAAEa;MAAM,CAAE;MACnBC;IAAI,CACL;IACDC;EAAe,CAChB,GAAGpB,IAAA;EAEJ,MAAMqB,gBAAA,GAAmBF,IAAA,EAAMG,UAAA;EAE/B,MAAMC,aAAA,GAAgBL,MAAA,CAAOM,KAAK,CAACL,IAAI;EAEvC;EACA,IAAIE,gBAAA,EAAkB;IACpB,MAAMI,mBAAA,GAAsBpB,OAAA,CAAQqB,WAAW,CAACL,gBAAA,CAAiB,CAACH,MAAM,CAACS,MAAM,EAAEH,KAAA;IAEjF;IACA,IAAIC,mBAAA,EAAqB;MACvB,MAAMG,cAAA,GAAiB,MAAMH,mBAAA,CAAoB;QAAExB;MAAI;MAEvD,IAAI,CAAC2B,cAAA,EAAgB;QACnB,MAAM,IAAIC,KAAA,CAAM;MAClB;MAEA;IACF,OAAO,IAAIN,aAAA,KAAkBF,gBAAA,EAAkB;MAC7C,MAAM,IAAIQ,KAAA,CAAM;IAClB;EACF,OAAO;IACL,MAAMC,QAAA,GAAW,MAAMzB,OAAA,CAAQ0B,IAAI,CAAC;MAClCT,UAAA,EAAYC,aAAA;MACZS,KAAA,EAAO;MACPC,KAAA,EAAO;MACPC,UAAA,EAAY;IACd;IAEA;IACA,IAAIJ,QAAA,CAASlB,IAAI,CAACuB,MAAM,EAAE;MACxB,MAAM,IAAIN,KAAA,CAAM;IAClB;EACF;EAEA,MAAMO,YAAA,GAAexC,eAAA,CAAgB;IACnCsB,MAAA;IACAD,IAAA;IACAoB,SAAA,EAAWhC,OAAA,CAAQgC;EACrB;EAEA,IAAIC,gBAAA;EACJ,IAAIC,sBAAA;EAEJ,IAAItC,GAAA,CAAII,OAAO,CAACqB,WAAW,CAAChB,cAAA,CAAe,EAAE;IAC3C4B,gBAAA,GAAmBrC,GAAA,CAAII,OAAO,CAACqB,WAAW,CAAChB,cAAA,CAAe,CAACQ,MAAM;IACjEqB,sBAAA,GAAyBH,YAAA,CAAaV,WAAW,CAACK,IAAI,CACnDT,UAAA,IAAeA,UAAA,CAAWkB,IAAI,KAAK9B,cAAA;EAExC;EAEA;EACA,MAAM+B,cAAA,GAAiB,GAAG/B,cAAA,OAAqB;EAE/C,MAAMgC,iBAAA,GAAoB,MAAMrC,OAAA,CAC7B0B,IAAI,CAAC;IACJT,UAAA,EAAY;IACZU,KAAA,EAAO;IACPC,KAAA,EAAO;IACPC,UAAA,EAAY;IACZS,KAAA,EAAO;MACLC,GAAA,EAAK,CACH;QACEC,GAAA,EAAK;UACHC,MAAA,EAAQL;QACV;MACF,GACA;QACE,mBAAmB;UACjBK,MAAA,EAAQ3B,IAAA,CAAKG;QACf;MACF,GACA;QACE,cAAc;UACZwB,MAAA,EAAQ3B,IAAA,CAAK4B;QACf;MACF;IAEJ;EACF,GACCC,IAAI,CAAE9C,GAAA,IAAQA,GAAA,CAAIU,IAAI,CAAC,EAAE,IAAI;IAAEmC,EAAA,EAAI;IAAME,KAAA,EAAO,CAAC;EAAE;EAEtD,IAAIC,QAAA,GAAWR,iBAAA,CAAkBO,KAAK;EAEtC,IAAI,CAACP,iBAAA,CAAkBK,EAAE,IAAI,CAACrD,MAAA,CAAOiB,OAAA,EAAS+B,iBAAA,EAAmB/B,OAAA,GAAU;IACzE,MAAMwC,eAAA,GAAkB;MACtB7B,UAAA,EAAY;MACZ8B,IAAA,EAAM;QACJP,GAAA,EAAKJ,cAAA;QACLtB,IAAA,EAAM;UACJG,UAAA,EAAYH,IAAA,CAAKG,UAAU;UAC3B2B,KAAA,EAAO9B,IAAA,CAAK4B;QACd;QACAE,KAAA,EAAO;UACL,IAAIP,iBAAA,EAAmBO,KAAA,IAAS,CAAC,CAAC;UAClCtC;QACF;MACF;MACAqB,KAAA,EAAO;MACP/B;IACF;IAEA,IAAIyC,iBAAA,CAAkBK,EAAE,EAAE;MACxBG,QAAA,GAAW,MAAM7C,OAAA,CACdgD,MAAM,CAAC;QACN,GAAGF,eAAe;QAClBJ,EAAA,EAAIL,iBAAA,CAAkBK;MACxB,IACEC,IAAA,CAAM9C,GAAA,IAAQA,GAAA,CAAI+C,KAAK;IAC7B,OAAO;MACLC,QAAA,GAAW,MAAM7C,OAAA,CAAQiD,MAAM,CAACH,eAAA,GAAkBH,IAAA,CAAM9C,GAAA,IAAQA,GAAA,CAAI+C,KAAK;IAC3E;EACF;EAEA,IAAIrC,IAAA,GAAOC,YAAA;EACX,IAAIuC,IAAA;EAEJ;EAEA,IAAI,CAACxC,IAAA,IAAQG,KAAA,EAAO;IAClBqC,IAAA,GAAO,MAAM/C,OAAA,CAAQ0B,IAAI,CAAC;MACxBT,UAAA,EAAYZ,cAAA;MACZsB,KAAA,EAAO;MACPC,KAAA,EAAOlB,KAAA,EAAOkB,KAAA,GAAQsB,QAAA,CAASxC,KAAA,CAAMkB,KAAK,EAAE,MAAMuB,SAAA;MAClDC,cAAA,EAAgB;MAChBC,IAAA,EAAM3C,KAAA,EAAO2C,IAAA,GAAOH,QAAA,CAASxC,KAAA,CAAM2C,IAAI,EAAE,MAAMF,SAAA;MAC/CG,IAAA,EAAM5C,KAAA,EAAO4C,IAAA;MACbxC,IAAA,EAAMlB,GAAA,CAAIkB,IAAI;MACdwB,KAAA,EAAO5B,KAAA,EAAO4B;IAChB;IAEA/B,IAAA,GAAOwC,IAAA,CAAKxC,IAAI;EAClB;EAEA,MAAM;IAAEgD,WAAW;IAAEC;EAAK,CAAE,GAAG/D,WAAA,CAAY;IACzCyC,sBAAA;IACAD,gBAAA;IACAwB,iBAAA,EAAmBN,SAAA;IACnB7C,OAAA;IACAC,IAAA;IACAE,mBAAA;IACAG,IAAA,EAAMhB,GAAA,CAAIgB,IAAI;IACdZ,OAAA;IACAW,cAAA;IACAI,eAAA;IACA2C,UAAA,EAAYzB,gBAAA,CAAiBd,KAAK,CAACuC;EACrC;EAEA,MAAMC,eAAA,GAAkBnE,aAAA,CAAcyC,gBAAA,CAAiB2B,MAAM,EAAEhE,GAAA,CAAII,OAAO,CAACgC,SAAS;EAEpF,OAAO;IACLe,IAAA;IACAc,WAAA,EAAahB,QAAA;IACbc,eAAA;IACAG,KAAA,EAAOP,WAAA;IACPC;EACF;AACF","ignoreList":[]}
+{"version":3,"file":"buildTableState.js","names":["formatErrors","isNumber","getClientConfig","renderFilters","renderTable","upsertPreferences","buildTableStateHandler","args","req","res","buildTableState","err","payload","logger","error","msg","message","collectionSlug","columns","docs","docsFromArgs","enableRowSelections","query","renderRowTypes","i18n","config","user","tableAppearance","incomingUserSlug","collection","adminUserSlug","admin","adminAccessFunction","collections","access","canAccessAdmin","Error","hasUsers","find","depth","limit","pagination","length","clientConfig","importMap","collectionConfig","clientCollectionConfig","slug","listPreferences","key","value","Number","undefined","sort","data","parseInt","overrideAccess","page","where","columnState","Table","columnPreferences","useAsTitle","renderedFilters","fields","preferences","state"],"sources":["../../src/utilities/buildTableState.ts"],"sourcesContent":["import type {\n  BuildTableStateArgs,\n  ClientCollectionConfig,\n  ClientConfig,\n  ErrorResult,\n  PaginatedDocs,\n  SanitizedCollectionConfig,\n} from 'payload'\n\nimport { formatErrors } from 'payload'\nimport { isNumber } from 'payload/shared'\n\nimport type { Column } from '../elements/Table/index.js'\nimport type { ListPreferences } from '../elements/TableColumns/index.js'\n\nimport { getClientConfig } from './getClientConfig.js'\nimport { renderFilters, renderTable } from './renderTable.js'\nimport { upsertPreferences } from './upsertPreferences.js'\n\ntype BuildTableStateSuccessResult = {\n  clientConfig?: ClientConfig\n  data: PaginatedDocs\n  errors?: never\n  preferences: ListPreferences\n  renderedFilters: Map<string, React.ReactNode>\n  state: Column[]\n  Table: React.ReactNode\n}\n\ntype BuildTableStateErrorResult = {\n  data?: any\n  renderedFilters?: never\n  state?: never\n  Table?: never\n} & (\n  | {\n      message: string\n    }\n  | ErrorResult\n)\n\nexport type BuildTableStateResult = BuildTableStateErrorResult | BuildTableStateSuccessResult\n\nexport const buildTableStateHandler = async (\n  args: BuildTableStateArgs,\n): Promise<BuildTableStateResult> => {\n  const { req } = args\n\n  try {\n    const res = await buildTableState(args)\n    return res\n  } catch (err) {\n    req.payload.logger.error({ err, msg: `There was an error building form state` })\n\n    if (err.message === 'Could not find field schema for given path') {\n      return {\n        message: err.message,\n      }\n    }\n\n    if (err.message === 'Unauthorized') {\n      return null\n    }\n\n    return formatErrors(err)\n  }\n}\n\nexport const buildTableState = async (\n  args: BuildTableStateArgs,\n): Promise<BuildTableStateSuccessResult> => {\n  const {\n    collectionSlug,\n    columns,\n    docs: docsFromArgs,\n    enableRowSelections,\n    query,\n    renderRowTypes,\n    req,\n    req: {\n      i18n,\n      payload,\n      payload: { config },\n      user,\n    },\n    tableAppearance,\n  } = args\n\n  const incomingUserSlug = user?.collection\n\n  const adminUserSlug = config.admin.user\n\n  // If we have a user slug, test it against the functions\n  if (incomingUserSlug) {\n    const adminAccessFunction = payload.collections[incomingUserSlug].config.access?.admin\n\n    // Run the admin access function from the config if it exists\n    if (adminAccessFunction) {\n      const canAccessAdmin = await adminAccessFunction({ req })\n\n      if (!canAccessAdmin) {\n        throw new Error('Unauthorized')\n      }\n\n      // Match the user collection to the global admin config\n    } else if (adminUserSlug !== incomingUserSlug) {\n      throw new Error('Unauthorized')\n    }\n  } else {\n    const hasUsers = await payload.find({\n      collection: adminUserSlug,\n      depth: 0,\n      limit: 1,\n      pagination: false,\n    })\n\n    // If there are users, we should not allow access because of /create-first-user\n    if (hasUsers.docs.length) {\n      throw new Error('Unauthorized')\n    }\n  }\n\n  const clientConfig = getClientConfig({\n    config,\n    i18n,\n    importMap: payload.importMap,\n  })\n\n  let collectionConfig: SanitizedCollectionConfig\n  let clientCollectionConfig: ClientCollectionConfig\n\n  if (req.payload.collections[collectionSlug]) {\n    collectionConfig = req.payload.collections[collectionSlug].config\n    clientCollectionConfig = clientConfig.collections.find(\n      (collection) => collection.slug === collectionSlug,\n    )\n  }\n\n  const listPreferences = await upsertPreferences<ListPreferences>({\n    key: `${collectionSlug}-list`,\n    req,\n    value: {\n      columns,\n      limit: isNumber(query?.limit) ? Number(query.limit) : undefined,\n      sort: query?.sort,\n    },\n  })\n\n  let docs = docsFromArgs\n  let data: PaginatedDocs\n\n  // lookup docs, if desired, i.e. within `join` field which initialize with `depth: 0`\n\n  if (!docs || query) {\n    data = await payload.find({\n      collection: collectionSlug,\n      depth: 0,\n      limit: query?.limit ? parseInt(query.limit, 10) : undefined,\n      overrideAccess: false,\n      page: query?.page ? parseInt(query.page, 10) : undefined,\n      sort: query?.sort,\n      user: req.user,\n      where: query?.where,\n    })\n\n    docs = data.docs\n  }\n\n  const { columnState, Table } = renderTable({\n    clientCollectionConfig,\n    collectionConfig,\n    columnPreferences: undefined, // TODO, might not be needed\n    columns,\n    docs,\n    enableRowSelections,\n    i18n: req.i18n,\n    payload,\n    renderRowTypes,\n    tableAppearance,\n    useAsTitle: collectionConfig.admin.useAsTitle,\n  })\n\n  const renderedFilters = renderFilters(collectionConfig.fields, req.payload.importMap)\n\n  return {\n    data,\n    preferences: listPreferences,\n    renderedFilters,\n    state: columnState,\n    Table,\n  }\n}\n"],"mappings":"AASA,SAASA,YAAY,QAAQ;AAC7B,SAASC,QAAQ,QAAQ;AAKzB,SAASC,eAAe,QAAQ;AAChC,SAASC,aAAa,EAAEC,WAAW,QAAQ;AAC3C,SAASC,iBAAiB,QAAQ;AA0BlC,OAAO,MAAMC,sBAAA,GAAyB,MACpCC,IAAA;EAEA,MAAM;IAAEC;EAAG,CAAE,GAAGD,IAAA;EAEhB,IAAI;IACF,MAAME,GAAA,GAAM,MAAMC,eAAA,CAAgBH,IAAA;IAClC,OAAOE,GAAA;EACT,EAAE,OAAOE,GAAA,EAAK;IACZH,GAAA,CAAII,OAAO,CAACC,MAAM,CAACC,KAAK,CAAC;MAAEH,GAAA;MAAKI,GAAA,EAAK;IAAyC;IAE9E,IAAIJ,GAAA,CAAIK,OAAO,KAAK,8CAA8C;MAChE,OAAO;QACLA,OAAA,EAASL,GAAA,CAAIK;MACf;IACF;IAEA,IAAIL,GAAA,CAAIK,OAAO,KAAK,gBAAgB;MAClC,OAAO;IACT;IAEA,OAAOhB,YAAA,CAAaW,GAAA;EACtB;AACF;AAEA,OAAO,MAAMD,eAAA,GAAkB,MAC7BH,IAAA;EAEA,MAAM;IACJU,cAAc;IACdC,OAAO;IACPC,IAAA,EAAMC,YAAY;IAClBC,mBAAmB;IACnBC,KAAK;IACLC,cAAc;IACdf,GAAG;IACHA,GAAA,EAAK;MACHgB,IAAI;MACJZ,OAAO;MACPA,OAAA,EAAS;QAAEa;MAAM,CAAE;MACnBC;IAAI,CACL;IACDC;EAAe,CAChB,GAAGpB,IAAA;EAEJ,MAAMqB,gBAAA,GAAmBF,IAAA,EAAMG,UAAA;EAE/B,MAAMC,aAAA,GAAgBL,MAAA,CAAOM,KAAK,CAACL,IAAI;EAEvC;EACA,IAAIE,gBAAA,EAAkB;IACpB,MAAMI,mBAAA,GAAsBpB,OAAA,CAAQqB,WAAW,CAACL,gBAAA,CAAiB,CAACH,MAAM,CAACS,MAAM,EAAEH,KAAA;IAEjF;IACA,IAAIC,mBAAA,EAAqB;MACvB,MAAMG,cAAA,GAAiB,MAAMH,mBAAA,CAAoB;QAAExB;MAAI;MAEvD,IAAI,CAAC2B,cAAA,EAAgB;QACnB,MAAM,IAAIC,KAAA,CAAM;MAClB;MAEA;IACF,OAAO,IAAIN,aAAA,KAAkBF,gBAAA,EAAkB;MAC7C,MAAM,IAAIQ,KAAA,CAAM;IAClB;EACF,OAAO;IACL,MAAMC,QAAA,GAAW,MAAMzB,OAAA,CAAQ0B,IAAI,CAAC;MAClCT,UAAA,EAAYC,aAAA;MACZS,KAAA,EAAO;MACPC,KAAA,EAAO;MACPC,UAAA,EAAY;IACd;IAEA;IACA,IAAIJ,QAAA,CAASlB,IAAI,CAACuB,MAAM,EAAE;MACxB,MAAM,IAAIN,KAAA,CAAM;IAClB;EACF;EAEA,MAAMO,YAAA,GAAezC,eAAA,CAAgB;IACnCuB,MAAA;IACAD,IAAA;IACAoB,SAAA,EAAWhC,OAAA,CAAQgC;EACrB;EAEA,IAAIC,gBAAA;EACJ,IAAIC,sBAAA;EAEJ,IAAItC,GAAA,CAAII,OAAO,CAACqB,WAAW,CAAChB,cAAA,CAAe,EAAE;IAC3C4B,gBAAA,GAAmBrC,GAAA,CAAII,OAAO,CAACqB,WAAW,CAAChB,cAAA,CAAe,CAACQ,MAAM;IACjEqB,sBAAA,GAAyBH,YAAA,CAAaV,WAAW,CAACK,IAAI,CACnDT,UAAA,IAAeA,UAAA,CAAWkB,IAAI,KAAK9B,cAAA;EAExC;EAEA,MAAM+B,eAAA,GAAkB,MAAM3C,iBAAA,CAAmC;IAC/D4C,GAAA,EAAK,GAAGhC,cAAA,OAAqB;IAC7BT,GAAA;IACA0C,KAAA,EAAO;MACLhC,OAAA;MACAsB,KAAA,EAAOvC,QAAA,CAASqB,KAAA,EAAOkB,KAAA,IAASW,MAAA,CAAO7B,KAAA,CAAMkB,KAAK,IAAIY,SAAA;MACtDC,IAAA,EAAM/B,KAAA,EAAO+B;IACf;EACF;EAEA,IAAIlC,IAAA,GAAOC,YAAA;EACX,IAAIkC,IAAA;EAEJ;EAEA,IAAI,CAACnC,IAAA,IAAQG,KAAA,EAAO;IAClBgC,IAAA,GAAO,MAAM1C,OAAA,CAAQ0B,IAAI,CAAC;MACxBT,UAAA,EAAYZ,cAAA;MACZsB,KAAA,EAAO;MACPC,KAAA,EAAOlB,KAAA,EAAOkB,KAAA,GAAQe,QAAA,CAASjC,KAAA,CAAMkB,KAAK,EAAE,MAAMY,SAAA;MAClDI,cAAA,EAAgB;MAChBC,IAAA,EAAMnC,KAAA,EAAOmC,IAAA,GAAOF,QAAA,CAASjC,KAAA,CAAMmC,IAAI,EAAE,MAAML,SAAA;MAC/CC,IAAA,EAAM/B,KAAA,EAAO+B,IAAA;MACb3B,IAAA,EAAMlB,GAAA,CAAIkB,IAAI;MACdgC,KAAA,EAAOpC,KAAA,EAAOoC;IAChB;IAEAvC,IAAA,GAAOmC,IAAA,CAAKnC,IAAI;EAClB;EAEA,MAAM;IAAEwC,WAAW;IAAEC;EAAK,CAAE,GAAGxD,WAAA,CAAY;IACzC0C,sBAAA;IACAD,gBAAA;IACAgB,iBAAA,EAAmBT,SAAA;IACnBlC,OAAA;IACAC,IAAA;IACAE,mBAAA;IACAG,IAAA,EAAMhB,GAAA,CAAIgB,IAAI;IACdZ,OAAA;IACAW,cAAA;IACAI,eAAA;IACAmC,UAAA,EAAYjB,gBAAA,CAAiBd,KAAK,CAAC+B;EACrC;EAEA,MAAMC,eAAA,GAAkB5D,aAAA,CAAc0C,gBAAA,CAAiBmB,MAAM,EAAExD,GAAA,CAAII,OAAO,CAACgC,SAAS;EAEpF,OAAO;IACLU,IAAA;IACAW,WAAA,EAAajB,eAAA;IACbe,eAAA;IACAG,KAAA,EAAOP,WAAA;IACPC;EACF;AACF","ignoreList":[]}

package/dist/utilities/copyDataFromLocale.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"copyDataFromLocale.d.ts","sourceRoot":"","sources":["../../src/utilities/copyDataFromLocale.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,cAAc,EAInB,KAAK,cAAc,EACpB,MAAM,SAAS,CAAA;AAGhB,MAAM,MAAM,sBAAsB,GAAG;IACnC,cAAc,CAAC,EAAE,cAAc,CAAA;IAC/B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACvB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,GAAG,EAAE,cAAc,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAkHD,eAAO,MAAM,yBAAyB,SAAgB,sBAAsB,0EAiB3E,CAAA;AAED,eAAO,MAAM,kBAAkB,SAAgB,sBAAsB,0CAgHpE,CAAA"}
+{"version":3,"file":"copyDataFromLocale.d.ts","sourceRoot":"","sources":["../../src/utilities/copyDataFromLocale.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,cAAc,EAInB,KAAK,cAAc,EACpB,MAAM,SAAS,CAAA;AAMhB,MAAM,MAAM,sBAAsB,GAAG;IACnC,cAAc,CAAC,EAAE,cAAc,CAAA;IAC/B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACvB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,GAAG,EAAE,cAAc,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AA6HD,eAAO,MAAM,yBAAyB,SAAgB,sBAAsB,0EAiB3E,CAAA;AAED,eAAO,MAAM,kBAAkB,SAAgB,sBAAsB,0CAgHpE,CAAA"}

package/dist/utilities/copyDataFromLocale.js

@@ -1,5 +1,7 @@
+import ObjectIdImport from 'bson-objectid';
 import { formatErrors } from 'payload';
 import { fieldAffectsData, tabHasName } from 'payload/shared';
+const ObjectId = ObjectIdImport.default || ObjectIdImport;
 function iterateFields(fields, fromLocaleData, toLocaleData) {
   fields.map(field => {
     if (fieldAffectsData(field)) {
@@ -12,10 +14,14 @@ function iterateFields(fields, fromLocaleData, toLocaleData) {
             toLocaleData[field.name] = fromLocaleData[field.name];
             break;
           }
-          // if the field has a value but is not localized, loop over the data from target
-          if (!field.localized && field.name in toLocaleData) {
+          // if the field has a value - loop over the data from target
+          if (field.name in toLocaleData) {
             toLocaleData[field.name].map((item, index) => {
               if (fromLocaleData[field.name]?.[index]) {
+                // Generate new IDs if the field is localized to prevent errors with relational DBs.
+                if (field.localized) {
+                  toLocaleData[field.name][index].id = new ObjectId().toHexString();
+                }
                 iterateFields(field.fields, fromLocaleData[field.name][index], item);
               }
             });
@@ -29,12 +35,16 @@ function iterateFields(fields, fromLocaleData, toLocaleData) {
             toLocaleData[field.name] = fromLocaleData[field.name];
             break;
           }
-          // if the field has a value but is not localized, loop over the data from target
-          if (!field.localized && field.name in toLocaleData) {
+          // if the field has a value - loop over the data from target
+          if (field.name in toLocaleData) {
             toLocaleData[field.name].map((blockData, index) => {
               const blockFields = field.blocks.find(({
                 slug
               }) => slug === blockData.blockType)?.fields;
+              // Generate new IDs if the field is localized to prevent errors with relational DBs.
+              if (field.localized) {
+                toLocaleData[field.name][index].id = new ObjectId().toHexString();
+              }
               if (blockFields?.length) {
                 iterateFields(blockFields, fromLocaleData[field.name][index], blockData);
               }

package/dist/utilities/copyDataFromLocale.js.map

@@ -1 +1 @@
-{"version":3,"file":"copyDataFromLocale.js","names":["formatErrors","fieldAffectsData","tabHasName","iterateFields","fields","fromLocaleData","toLocaleData","map","field","type","name","undefined","includes","localized","item","index","blockData","blockFields","blocks","find","slug","blockType","length","tabs","tab","mergeData","copyDataFromLocaleHandler","args","req","copyDataFromLocale","err","payload","logger","error","msg","fromLocale","toLocale","message","collectionSlug","docID","globalSlug","overrideData","collections","globals","user","incomingUserSlug","collection","adminUserSlug","config","admin","adminAccessFunction","access","canAccessAdmin","Error","Promise","allSettled","findGlobal","depth","locale","overrideAccess","findByID","id","joins","status","updateGlobal","data","value","update"],"sources":["../../src/utilities/copyDataFromLocale.ts"],"sourcesContent":["import {\n  type CollectionSlug,\n  type Data,\n  type Field,\n  formatErrors,\n  type PayloadRequest,\n} from 'payload'\nimport { fieldAffectsData, tabHasName } from 'payload/shared'\n\nexport type CopyDataFromLocaleArgs = {\n  collectionSlug?: CollectionSlug\n  docID?: number | string\n  fromLocale: string\n  globalSlug?: string\n  overrideData?: boolean\n  req: PayloadRequest\n  toLocale: string\n}\n\nfunction iterateFields(fields: Field[], fromLocaleData: Data, toLocaleData: Data): void {\n  fields.map((field) => {\n    if (fieldAffectsData(field)) {\n      switch (field.type) {\n        case 'array':\n          // if the field has no value, take the source value\n          if (\n            field.name in toLocaleData &&\n            // only replace if the target value is null or undefined\n            [null, undefined].includes(toLocaleData[field.name]) &&\n            field.name in fromLocaleData\n          ) {\n            toLocaleData[field.name] = fromLocaleData[field.name]\n            break\n          }\n\n          // if the field has a value but is not localized, loop over the data from target\n          if (!field.localized && field.name in toLocaleData) {\n            toLocaleData[field.name].map((item: Data, index: number) => {\n              if (fromLocaleData[field.name]?.[index]) {\n                iterateFields(field.fields, fromLocaleData[field.name][index], item)\n              }\n            })\n          }\n          break\n\n        case 'blocks':\n          // if the field has no value, take the source value\n          if (\n            field.name in toLocaleData &&\n            // only replace if the target value is null or undefined\n            [null, undefined].includes(toLocaleData[field.name]) &&\n            field.name in fromLocaleData\n          ) {\n            toLocaleData[field.name] = fromLocaleData[field.name]\n            break\n          }\n\n          // if the field has a value but is not localized, loop over the data from target\n          if (!field.localized && field.name in toLocaleData) {\n            toLocaleData[field.name].map((blockData: Data, index: number) => {\n              const blockFields = field.blocks.find(\n                ({ slug }) => slug === blockData.blockType,\n              )?.fields\n\n              if (blockFields?.length) {\n                iterateFields(blockFields, fromLocaleData[field.name][index], blockData)\n              }\n            })\n          }\n          break\n\n        case 'checkbox':\n        case 'code':\n        case 'date':\n        case 'email':\n        case 'json':\n        case 'number':\n        case 'point':\n        case 'radio':\n        case 'relationship':\n        case 'richText':\n        case 'select':\n        case 'text':\n        case 'textarea':\n        case 'upload':\n          if (\n            field.name in toLocaleData &&\n            // only replace if the target value is null or undefined\n            [null, undefined].includes(toLocaleData[field.name]) &&\n            field.name in fromLocaleData\n          ) {\n            toLocaleData[field.name] = fromLocaleData[field.name]\n          }\n          break\n\n        case 'group': {\n          if (field.name in toLocaleData && fromLocaleData?.[field.name] !== undefined) {\n            iterateFields(field.fields, fromLocaleData[field.name], toLocaleData[field.name])\n          }\n          break\n        }\n      }\n    } else {\n      switch (field.type) {\n        case 'collapsible':\n        case 'row':\n          iterateFields(field.fields, fromLocaleData, toLocaleData)\n          break\n\n        case 'tabs':\n          field.tabs.map((tab) => {\n            if (tabHasName(tab)) {\n              if (tab.name in toLocaleData && fromLocaleData?.[tab.name] !== undefined) {\n                iterateFields(tab.fields, fromLocaleData[tab.name], toLocaleData[tab.name])\n              }\n            } else {\n              iterateFields(tab.fields, fromLocaleData, toLocaleData)\n            }\n          })\n          break\n      }\n    }\n  })\n}\n\nfunction mergeData(fromLocaleData: Data, toLocaleData: Data, fields: Field[]): Data {\n  iterateFields(fields, fromLocaleData, toLocaleData)\n\n  return toLocaleData\n}\n\nexport const copyDataFromLocaleHandler = async (args: CopyDataFromLocaleArgs) => {\n  const { req } = args\n\n  try {\n    return await copyDataFromLocale(args)\n  } catch (err) {\n    req.payload.logger.error({\n      err,\n      msg: `There was an error copying data from \"${args.fromLocale}\" to \"${args.toLocale}\"`,\n    })\n\n    if (err.message === 'Unauthorized') {\n      return null\n    }\n\n    return formatErrors(err)\n  }\n}\n\nexport const copyDataFromLocale = async (args: CopyDataFromLocaleArgs) => {\n  const {\n    collectionSlug,\n    docID,\n    fromLocale,\n    globalSlug,\n    overrideData = false,\n    req: {\n      payload,\n      payload: { collections, globals },\n      user,\n    },\n    req,\n    toLocale,\n  } = args\n\n  const incomingUserSlug = user?.collection\n\n  const adminUserSlug = payload.config.admin.user\n\n  // If we have a user slug, test it against the functions\n  if (incomingUserSlug) {\n    const adminAccessFunction = payload.collections[incomingUserSlug].config.access?.admin\n\n    // Run the admin access function from the config if it exists\n    if (adminAccessFunction) {\n      const canAccessAdmin = await adminAccessFunction({ req: args.req })\n\n      if (!canAccessAdmin) {\n        throw new Error('Unauthorized')\n      }\n      // Match the user collection to the global admin config\n    } else if (adminUserSlug !== incomingUserSlug) {\n      throw new Error('Unauthorized')\n    }\n  }\n\n  const [fromLocaleData, toLocaleData] = await Promise.allSettled([\n    globalSlug\n      ? payload.findGlobal({\n          slug: globalSlug,\n          depth: 0,\n          locale: fromLocale,\n          overrideAccess: false,\n          user,\n          // `select` would allow us to select only the fields we need in the future\n        })\n      : payload.findByID({\n          id: docID,\n          collection: collectionSlug,\n          depth: 0,\n          joins: false,\n          locale: fromLocale,\n          overrideAccess: false,\n          user,\n          // `select` would allow us to select only the fields we need in the future\n        }),\n    globalSlug\n      ? payload.findGlobal({\n          slug: globalSlug,\n          depth: 0,\n          locale: toLocale,\n          overrideAccess: false,\n          user,\n          // `select` would allow us to select only the fields we need in the future\n        })\n      : payload.findByID({\n          id: docID,\n          collection: collectionSlug,\n          depth: 0,\n          joins: false,\n          locale: toLocale,\n          overrideAccess: false,\n          user,\n          // `select` would allow us to select only the fields we need in the future\n        }),\n  ])\n\n  if (fromLocaleData.status === 'rejected') {\n    throw new Error(`Error fetching data from locale \"${fromLocale}\"`)\n  }\n\n  if (toLocaleData.status === 'rejected') {\n    throw new Error(`Error fetching data from locale \"${toLocale}\"`)\n  }\n\n  return globalSlug\n    ? await payload.updateGlobal({\n        slug: globalSlug,\n        data: overrideData\n          ? fromLocaleData.value\n          : mergeData(fromLocaleData.value, toLocaleData.value, globals[globalSlug].config.fields),\n        locale: toLocale,\n        overrideAccess: false,\n        req,\n        user,\n      })\n    : await payload.update({\n        id: docID,\n        collection: collectionSlug,\n        data: overrideData\n          ? fromLocaleData.value\n          : mergeData(\n              fromLocaleData.value,\n              toLocaleData.value,\n              collections[collectionSlug].config.fields,\n            ),\n        locale: toLocale,\n        overrideAccess: false,\n        req,\n        user,\n      })\n}\n"],"mappings":"AAAA,SAIEA,YAAY,QAEP;AACP,SAASC,gBAAgB,EAAEC,UAAU,QAAQ;AAY7C,SAASC,cAAcC,MAAe,EAAEC,cAAoB,EAAEC,YAAkB;EAC9EF,MAAA,CAAOG,GAAG,CAAEC,KAAA;IACV,IAAIP,gBAAA,CAAiBO,KAAA,GAAQ;MAC3B,QAAQA,KAAA,CAAMC,IAAI;QAChB,KAAK;UACH;UACA,IACED,KAAA,CAAME,IAAI,IAAIJ,YAAA;UACd;UACA,CAAC,MAAMK,SAAA,CAAU,CAACC,QAAQ,CAACN,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC,KACnDF,KAAA,CAAME,IAAI,IAAIL,cAAA,EACd;YACAC,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC,GAAGL,cAAc,CAACG,KAAA,CAAME,IAAI,CAAC;YACrD;UACF;UAEA;UACA,IAAI,CAACF,KAAA,CAAMK,SAAS,IAAIL,KAAA,CAAME,IAAI,IAAIJ,YAAA,EAAc;YAClDA,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC,CAACH,GAAG,CAAC,CAACO,IAAA,EAAYC,KAAA;cACxC,IAAIV,cAAc,CAACG,KAAA,CAAME,IAAI,CAAC,GAAGK,KAAA,CAAM,EAAE;gBACvCZ,aAAA,CAAcK,KAAA,CAAMJ,MAAM,EAAEC,cAAc,CAACG,KAAA,CAAME,IAAI,CAAC,CAACK,KAAA,CAAM,EAAED,IAAA;cACjE;YACF;UACF;UACA;QAEF,KAAK;UACH;UACA,IACEN,KAAA,CAAME,IAAI,IAAIJ,YAAA;UACd;UACA,CAAC,MAAMK,SAAA,CAAU,CAACC,QAAQ,CAACN,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC,KACnDF,KAAA,CAAME,IAAI,IAAIL,cAAA,EACd;YACAC,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC,GAAGL,cAAc,CAACG,KAAA,CAAME,IAAI,CAAC;YACrD;UACF;UAEA;UACA,IAAI,CAACF,KAAA,CAAMK,SAAS,IAAIL,KAAA,CAAME,IAAI,IAAIJ,YAAA,EAAc;YAClDA,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC,CAACH,GAAG,CAAC,CAACS,SAAA,EAAiBD,KAAA;cAC7C,MAAME,WAAA,GAAcT,KAAA,CAAMU,MAAM,CAACC,IAAI,CACnC,CAAC;gBAAEC;cAAI,CAAE,KAAKA,IAAA,KAASJ,SAAA,CAAUK,SAAS,GACzCjB,MAAA;cAEH,IAAIa,WAAA,EAAaK,MAAA,EAAQ;gBACvBnB,aAAA,CAAcc,WAAA,EAAaZ,cAAc,CAACG,KAAA,CAAME,IAAI,CAAC,CAACK,KAAA,CAAM,EAAEC,SAAA;cAChE;YACF;UACF;UACA;QAEF,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;UACH,IACER,KAAA,CAAME,IAAI,IAAIJ,YAAA;UACd;UACA,CAAC,MAAMK,SAAA,CAAU,CAACC,QAAQ,CAACN,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC,KACnDF,KAAA,CAAME,IAAI,IAAIL,cAAA,EACd;YACAC,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC,GAAGL,cAAc,CAACG,KAAA,CAAME,IAAI,CAAC;UACvD;UACA;QAEF,KAAK;UAAS;YACZ,IAAIF,KAAA,CAAME,IAAI,IAAIJ,YAAA,IAAgBD,cAAA,GAAiBG,KAAA,CAAME,IAAI,CAAC,KAAKC,SAAA,EAAW;cAC5ER,aAAA,CAAcK,KAAA,CAAMJ,MAAM,EAAEC,cAAc,CAACG,KAAA,CAAME,IAAI,CAAC,EAAEJ,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC;YAClF;YACA;UACF;MACF;IACF,OAAO;MACL,QAAQF,KAAA,CAAMC,IAAI;QAChB,KAAK;QACL,KAAK;UACHN,aAAA,CAAcK,KAAA,CAAMJ,MAAM,EAAEC,cAAA,EAAgBC,YAAA;UAC5C;QAEF,KAAK;UACHE,KAAA,CAAMe,IAAI,CAAChB,GAAG,CAAEiB,GAAA;YACd,IAAItB,UAAA,CAAWsB,GAAA,GAAM;cACnB,IAAIA,GAAA,CAAId,IAAI,IAAIJ,YAAA,IAAgBD,cAAA,GAAiBmB,GAAA,CAAId,IAAI,CAAC,KAAKC,SAAA,EAAW;gBACxER,aAAA,CAAcqB,GAAA,CAAIpB,MAAM,EAAEC,cAAc,CAACmB,GAAA,CAAId,IAAI,CAAC,EAAEJ,YAAY,CAACkB,GAAA,CAAId,IAAI,CAAC;cAC5E;YACF,OAAO;cACLP,aAAA,CAAcqB,GAAA,CAAIpB,MAAM,EAAEC,cAAA,EAAgBC,YAAA;YAC5C;UACF;UACA;MACJ;IACF;EACF;AACF;AAEA,SAASmB,UAAUpB,cAAoB,EAAEC,YAAkB,EAAEF,MAAe;EAC1ED,aAAA,CAAcC,MAAA,EAAQC,cAAA,EAAgBC,YAAA;EAEtC,OAAOA,YAAA;AACT;AAEA,OAAO,MAAMoB,yBAAA,GAA4B,MAAOC,IAAA;EAC9C,MAAM;IAAEC;EAAG,CAAE,GAAGD,IAAA;EAEhB,IAAI;IACF,OAAO,MAAME,kBAAA,CAAmBF,IAAA;EAClC,EAAE,OAAOG,GAAA,EAAK;IACZF,GAAA,CAAIG,OAAO,CAACC,MAAM,CAACC,KAAK,CAAC;MACvBH,GAAA;MACAI,GAAA,EAAK,yCAAyCP,IAAA,CAAKQ,UAAU,SAASR,IAAA,CAAKS,QAAQ;IACrF;IAEA,IAAIN,GAAA,CAAIO,OAAO,KAAK,gBAAgB;MAClC,OAAO;IACT;IAEA,OAAOrC,YAAA,CAAa8B,GAAA;EACtB;AACF;AAEA,OAAO,MAAMD,kBAAA,GAAqB,MAAOF,IAAA;EACvC,MAAM;IACJW,cAAc;IACdC,KAAK;IACLJ,UAAU;IACVK,UAAU;IACVC,YAAA,GAAe,KAAK;IACpBb,GAAA,EAAK;MACHG,OAAO;MACPA,OAAA,EAAS;QAAEW,WAAW;QAAEC;MAAO,CAAE;MACjCC;IAAI,CACL;IACDhB,GAAG;IACHQ;EAAQ,CACT,GAAGT,IAAA;EAEJ,MAAMkB,gBAAA,GAAmBD,IAAA,EAAME,UAAA;EAE/B,MAAMC,aAAA,GAAgBhB,OAAA,CAAQiB,MAAM,CAACC,KAAK,CAACL,IAAI;EAE/C;EACA,IAAIC,gBAAA,EAAkB;IACpB,MAAMK,mBAAA,GAAsBnB,OAAA,CAAQW,WAAW,CAACG,gBAAA,CAAiB,CAACG,MAAM,CAACG,MAAM,EAAEF,KAAA;IAEjF;IACA,IAAIC,mBAAA,EAAqB;MACvB,MAAME,cAAA,GAAiB,MAAMF,mBAAA,CAAoB;QAAEtB,GAAA,EAAKD,IAAA,CAAKC;MAAI;MAEjE,IAAI,CAACwB,cAAA,EAAgB;QACnB,MAAM,IAAIC,KAAA,CAAM;MAClB;MACA;IACF,OAAO,IAAIN,aAAA,KAAkBF,gBAAA,EAAkB;MAC7C,MAAM,IAAIQ,KAAA,CAAM;IAClB;EACF;EAEA,MAAM,CAAChD,cAAA,EAAgBC,YAAA,CAAa,GAAG,MAAMgD,OAAA,CAAQC,UAAU,CAAC,CAC9Df,UAAA,GACIT,OAAA,CAAQyB,UAAU,CAAC;IACjBpC,IAAA,EAAMoB,UAAA;IACNiB,KAAA,EAAO;IACPC,MAAA,EAAQvB,UAAA;IACRwB,cAAA,EAAgB;IAChBf;EAEF,KACAb,OAAA,CAAQ6B,QAAQ,CAAC;IACfC,EAAA,EAAItB,KAAA;IACJO,UAAA,EAAYR,cAAA;IACZmB,KAAA,EAAO;IACPK,KAAA,EAAO;IACPJ,MAAA,EAAQvB,UAAA;IACRwB,cAAA,EAAgB;IAChBf;EAEF,IACJJ,UAAA,GACIT,OAAA,CAAQyB,UAAU,CAAC;IACjBpC,IAAA,EAAMoB,UAAA;IACNiB,KAAA,EAAO;IACPC,MAAA,EAAQtB,QAAA;IACRuB,cAAA,EAAgB;IAChBf;EAEF,KACAb,OAAA,CAAQ6B,QAAQ,CAAC;IACfC,EAAA,EAAItB,KAAA;IACJO,UAAA,EAAYR,cAAA;IACZmB,KAAA,EAAO;IACPK,KAAA,EAAO;IACPJ,MAAA,EAAQtB,QAAA;IACRuB,cAAA,EAAgB;IAChBf;EAEF,GACL;EAED,IAAIvC,cAAA,CAAe0D,MAAM,KAAK,YAAY;IACxC,MAAM,IAAIV,KAAA,CAAM,oCAAoClB,UAAA,GAAa;EACnE;EAEA,IAAI7B,YAAA,CAAayD,MAAM,KAAK,YAAY;IACtC,MAAM,IAAIV,KAAA,CAAM,oCAAoCjB,QAAA,GAAW;EACjE;EAEA,OAAOI,UAAA,GACH,MAAMT,OAAA,CAAQiC,YAAY,CAAC;IACzB5C,IAAA,EAAMoB,UAAA;IACNyB,IAAA,EAAMxB,YAAA,GACFpC,cAAA,CAAe6D,KAAK,GACpBzC,SAAA,CAAUpB,cAAA,CAAe6D,KAAK,EAAE5D,YAAA,CAAa4D,KAAK,EAAEvB,OAAO,CAACH,UAAA,CAAW,CAACQ,MAAM,CAAC5C,MAAM;IACzFsD,MAAA,EAAQtB,QAAA;IACRuB,cAAA,EAAgB;IAChB/B,GAAA;IACAgB;EACF,KACA,MAAMb,OAAA,CAAQoC,MAAM,CAAC;IACnBN,EAAA,EAAItB,KAAA;IACJO,UAAA,EAAYR,cAAA;IACZ2B,IAAA,EAAMxB,YAAA,GACFpC,cAAA,CAAe6D,KAAK,GACpBzC,SAAA,CACEpB,cAAA,CAAe6D,KAAK,EACpB5D,YAAA,CAAa4D,KAAK,EAClBxB,WAAW,CAACJ,cAAA,CAAe,CAACU,MAAM,CAAC5C,MAAM;IAE/CsD,MAAA,EAAQtB,QAAA;IACRuB,cAAA,EAAgB;IAChB/B,GAAA;IACAgB;EACF;AACN","ignoreList":[]}
+{"version":3,"file":"copyDataFromLocale.js","names":["ObjectIdImport","formatErrors","fieldAffectsData","tabHasName","ObjectId","default","iterateFields","fields","fromLocaleData","toLocaleData","map","field","type","name","undefined","includes","item","index","localized","id","toHexString","blockData","blockFields","blocks","find","slug","blockType","length","tabs","tab","mergeData","copyDataFromLocaleHandler","args","req","copyDataFromLocale","err","payload","logger","error","msg","fromLocale","toLocale","message","collectionSlug","docID","globalSlug","overrideData","collections","globals","user","incomingUserSlug","collection","adminUserSlug","config","admin","adminAccessFunction","access","canAccessAdmin","Error","Promise","allSettled","findGlobal","depth","locale","overrideAccess","findByID","joins","status","updateGlobal","data","value","update"],"sources":["../../src/utilities/copyDataFromLocale.ts"],"sourcesContent":["import ObjectIdImport from 'bson-objectid'\nimport {\n  type CollectionSlug,\n  type Data,\n  type Field,\n  formatErrors,\n  type PayloadRequest,\n} from 'payload'\nimport { fieldAffectsData, tabHasName } from 'payload/shared'\n\nconst ObjectId = (ObjectIdImport.default ||\n  ObjectIdImport) as unknown as typeof ObjectIdImport.default\n\nexport type CopyDataFromLocaleArgs = {\n  collectionSlug?: CollectionSlug\n  docID?: number | string\n  fromLocale: string\n  globalSlug?: string\n  overrideData?: boolean\n  req: PayloadRequest\n  toLocale: string\n}\n\nfunction iterateFields(fields: Field[], fromLocaleData: Data, toLocaleData: Data): void {\n  fields.map((field) => {\n    if (fieldAffectsData(field)) {\n      switch (field.type) {\n        case 'array':\n          // if the field has no value, take the source value\n          if (\n            field.name in toLocaleData &&\n            // only replace if the target value is null or undefined\n            [null, undefined].includes(toLocaleData[field.name]) &&\n            field.name in fromLocaleData\n          ) {\n            toLocaleData[field.name] = fromLocaleData[field.name]\n            break\n          }\n\n          // if the field has a value - loop over the data from target\n          if (field.name in toLocaleData) {\n            toLocaleData[field.name].map((item: Data, index: number) => {\n              if (fromLocaleData[field.name]?.[index]) {\n                // Generate new IDs if the field is localized to prevent errors with relational DBs.\n                if (field.localized) {\n                  toLocaleData[field.name][index].id = new ObjectId().toHexString()\n                }\n\n                iterateFields(field.fields, fromLocaleData[field.name][index], item)\n              }\n            })\n          }\n          break\n\n        case 'blocks':\n          // if the field has no value, take the source value\n          if (\n            field.name in toLocaleData &&\n            // only replace if the target value is null or undefined\n            [null, undefined].includes(toLocaleData[field.name]) &&\n            field.name in fromLocaleData\n          ) {\n            toLocaleData[field.name] = fromLocaleData[field.name]\n            break\n          }\n\n          // if the field has a value - loop over the data from target\n          if (field.name in toLocaleData) {\n            toLocaleData[field.name].map((blockData: Data, index: number) => {\n              const blockFields = field.blocks.find(\n                ({ slug }) => slug === blockData.blockType,\n              )?.fields\n\n              // Generate new IDs if the field is localized to prevent errors with relational DBs.\n              if (field.localized) {\n                toLocaleData[field.name][index].id = new ObjectId().toHexString()\n              }\n\n              if (blockFields?.length) {\n                iterateFields(blockFields, fromLocaleData[field.name][index], blockData)\n              }\n            })\n          }\n\n          break\n\n        case 'checkbox':\n        case 'code':\n        case 'date':\n        case 'email':\n        case 'json':\n        case 'number':\n        case 'point':\n        case 'radio':\n        case 'relationship':\n        case 'richText':\n        case 'select':\n        case 'text':\n        case 'textarea':\n        case 'upload':\n          if (\n            field.name in toLocaleData &&\n            // only replace if the target value is null or undefined\n            [null, undefined].includes(toLocaleData[field.name]) &&\n            field.name in fromLocaleData\n          ) {\n            toLocaleData[field.name] = fromLocaleData[field.name]\n          }\n          break\n\n        case 'group': {\n          if (field.name in toLocaleData && fromLocaleData?.[field.name] !== undefined) {\n            iterateFields(field.fields, fromLocaleData[field.name], toLocaleData[field.name])\n          }\n          break\n        }\n      }\n    } else {\n      switch (field.type) {\n        case 'collapsible':\n        case 'row':\n          iterateFields(field.fields, fromLocaleData, toLocaleData)\n          break\n\n        case 'tabs':\n          field.tabs.map((tab) => {\n            if (tabHasName(tab)) {\n              if (tab.name in toLocaleData && fromLocaleData?.[tab.name] !== undefined) {\n                iterateFields(tab.fields, fromLocaleData[tab.name], toLocaleData[tab.name])\n              }\n            } else {\n              iterateFields(tab.fields, fromLocaleData, toLocaleData)\n            }\n          })\n          break\n      }\n    }\n  })\n}\n\nfunction mergeData(fromLocaleData: Data, toLocaleData: Data, fields: Field[]): Data {\n  iterateFields(fields, fromLocaleData, toLocaleData)\n\n  return toLocaleData\n}\n\nexport const copyDataFromLocaleHandler = async (args: CopyDataFromLocaleArgs) => {\n  const { req } = args\n\n  try {\n    return await copyDataFromLocale(args)\n  } catch (err) {\n    req.payload.logger.error({\n      err,\n      msg: `There was an error copying data from \"${args.fromLocale}\" to \"${args.toLocale}\"`,\n    })\n\n    if (err.message === 'Unauthorized') {\n      return null\n    }\n\n    return formatErrors(err)\n  }\n}\n\nexport const copyDataFromLocale = async (args: CopyDataFromLocaleArgs) => {\n  const {\n    collectionSlug,\n    docID,\n    fromLocale,\n    globalSlug,\n    overrideData = false,\n    req: {\n      payload,\n      payload: { collections, globals },\n      user,\n    },\n    req,\n    toLocale,\n  } = args\n\n  const incomingUserSlug = user?.collection\n\n  const adminUserSlug = payload.config.admin.user\n\n  // If we have a user slug, test it against the functions\n  if (incomingUserSlug) {\n    const adminAccessFunction = payload.collections[incomingUserSlug].config.access?.admin\n\n    // Run the admin access function from the config if it exists\n    if (adminAccessFunction) {\n      const canAccessAdmin = await adminAccessFunction({ req: args.req })\n\n      if (!canAccessAdmin) {\n        throw new Error('Unauthorized')\n      }\n      // Match the user collection to the global admin config\n    } else if (adminUserSlug !== incomingUserSlug) {\n      throw new Error('Unauthorized')\n    }\n  }\n\n  const [fromLocaleData, toLocaleData] = await Promise.allSettled([\n    globalSlug\n      ? payload.findGlobal({\n          slug: globalSlug,\n          depth: 0,\n          locale: fromLocale,\n          overrideAccess: false,\n          user,\n          // `select` would allow us to select only the fields we need in the future\n        })\n      : payload.findByID({\n          id: docID,\n          collection: collectionSlug,\n          depth: 0,\n          joins: false,\n          locale: fromLocale,\n          overrideAccess: false,\n          user,\n          // `select` would allow us to select only the fields we need in the future\n        }),\n    globalSlug\n      ? payload.findGlobal({\n          slug: globalSlug,\n          depth: 0,\n          locale: toLocale,\n          overrideAccess: false,\n          user,\n          // `select` would allow us to select only the fields we need in the future\n        })\n      : payload.findByID({\n          id: docID,\n          collection: collectionSlug,\n          depth: 0,\n          joins: false,\n          locale: toLocale,\n          overrideAccess: false,\n          user,\n          // `select` would allow us to select only the fields we need in the future\n        }),\n  ])\n\n  if (fromLocaleData.status === 'rejected') {\n    throw new Error(`Error fetching data from locale \"${fromLocale}\"`)\n  }\n\n  if (toLocaleData.status === 'rejected') {\n    throw new Error(`Error fetching data from locale \"${toLocale}\"`)\n  }\n\n  return globalSlug\n    ? await payload.updateGlobal({\n        slug: globalSlug,\n        data: overrideData\n          ? fromLocaleData.value\n          : mergeData(fromLocaleData.value, toLocaleData.value, globals[globalSlug].config.fields),\n        locale: toLocale,\n        overrideAccess: false,\n        req,\n        user,\n      })\n    : await payload.update({\n        id: docID,\n        collection: collectionSlug,\n        data: overrideData\n          ? fromLocaleData.value\n          : mergeData(\n              fromLocaleData.value,\n              toLocaleData.value,\n              collections[collectionSlug].config.fields,\n            ),\n        locale: toLocale,\n        overrideAccess: false,\n        req,\n        user,\n      })\n}\n"],"mappings":"AAAA,OAAOA,cAAA,MAAoB;AAC3B,SAIEC,YAAY,QAEP;AACP,SAASC,gBAAgB,EAAEC,UAAU,QAAQ;AAE7C,MAAMC,QAAA,GAAYJ,cAAA,CAAeK,OAAO,IACtCL,cAAA;AAYF,SAASM,cAAcC,MAAe,EAAEC,cAAoB,EAAEC,YAAkB;EAC9EF,MAAA,CAAOG,GAAG,CAAEC,KAAA;IACV,IAAIT,gBAAA,CAAiBS,KAAA,GAAQ;MAC3B,QAAQA,KAAA,CAAMC,IAAI;QAChB,KAAK;UACH;UACA,IACED,KAAA,CAAME,IAAI,IAAIJ,YAAA;UACd;UACA,CAAC,MAAMK,SAAA,CAAU,CAACC,QAAQ,CAACN,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC,KACnDF,KAAA,CAAME,IAAI,IAAIL,cAAA,EACd;YACAC,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC,GAAGL,cAAc,CAACG,KAAA,CAAME,IAAI,CAAC;YACrD;UACF;UAEA;UACA,IAAIF,KAAA,CAAME,IAAI,IAAIJ,YAAA,EAAc;YAC9BA,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC,CAACH,GAAG,CAAC,CAACM,IAAA,EAAYC,KAAA;cACxC,IAAIT,cAAc,CAACG,KAAA,CAAME,IAAI,CAAC,GAAGI,KAAA,CAAM,EAAE;gBACvC;gBACA,IAAIN,KAAA,CAAMO,SAAS,EAAE;kBACnBT,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC,CAACI,KAAA,CAAM,CAACE,EAAE,GAAG,IAAIf,QAAA,GAAWgB,WAAW;gBACjE;gBAEAd,aAAA,CAAcK,KAAA,CAAMJ,MAAM,EAAEC,cAAc,CAACG,KAAA,CAAME,IAAI,CAAC,CAACI,KAAA,CAAM,EAAED,IAAA;cACjE;YACF;UACF;UACA;QAEF,KAAK;UACH;UACA,IACEL,KAAA,CAAME,IAAI,IAAIJ,YAAA;UACd;UACA,CAAC,MAAMK,SAAA,CAAU,CAACC,QAAQ,CAACN,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC,KACnDF,KAAA,CAAME,IAAI,IAAIL,cAAA,EACd;YACAC,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC,GAAGL,cAAc,CAACG,KAAA,CAAME,IAAI,CAAC;YACrD;UACF;UAEA;UACA,IAAIF,KAAA,CAAME,IAAI,IAAIJ,YAAA,EAAc;YAC9BA,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC,CAACH,GAAG,CAAC,CAACW,SAAA,EAAiBJ,KAAA;cAC7C,MAAMK,WAAA,GAAcX,KAAA,CAAMY,MAAM,CAACC,IAAI,CACnC,CAAC;gBAAEC;cAAI,CAAE,KAAKA,IAAA,KAASJ,SAAA,CAAUK,SAAS,GACzCnB,MAAA;cAEH;cACA,IAAII,KAAA,CAAMO,SAAS,EAAE;gBACnBT,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC,CAACI,KAAA,CAAM,CAACE,EAAE,GAAG,IAAIf,QAAA,GAAWgB,WAAW;cACjE;cAEA,IAAIE,WAAA,EAAaK,MAAA,EAAQ;gBACvBrB,aAAA,CAAcgB,WAAA,EAAad,cAAc,CAACG,KAAA,CAAME,IAAI,CAAC,CAACI,KAAA,CAAM,EAAEI,SAAA;cAChE;YACF;UACF;UAEA;QAEF,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;UACH,IACEV,KAAA,CAAME,IAAI,IAAIJ,YAAA;UACd;UACA,CAAC,MAAMK,SAAA,CAAU,CAACC,QAAQ,CAACN,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC,KACnDF,KAAA,CAAME,IAAI,IAAIL,cAAA,EACd;YACAC,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC,GAAGL,cAAc,CAACG,KAAA,CAAME,IAAI,CAAC;UACvD;UACA;QAEF,KAAK;UAAS;YACZ,IAAIF,KAAA,CAAME,IAAI,IAAIJ,YAAA,IAAgBD,cAAA,GAAiBG,KAAA,CAAME,IAAI,CAAC,KAAKC,SAAA,EAAW;cAC5ER,aAAA,CAAcK,KAAA,CAAMJ,MAAM,EAAEC,cAAc,CAACG,KAAA,CAAME,IAAI,CAAC,EAAEJ,YAAY,CAACE,KAAA,CAAME,IAAI,CAAC;YAClF;YACA;UACF;MACF;IACF,OAAO;MACL,QAAQF,KAAA,CAAMC,IAAI;QAChB,KAAK;QACL,KAAK;UACHN,aAAA,CAAcK,KAAA,CAAMJ,MAAM,EAAEC,cAAA,EAAgBC,YAAA;UAC5C;QAEF,KAAK;UACHE,KAAA,CAAMiB,IAAI,CAAClB,GAAG,CAAEmB,GAAA;YACd,IAAI1B,UAAA,CAAW0B,GAAA,GAAM;cACnB,IAAIA,GAAA,CAAIhB,IAAI,IAAIJ,YAAA,IAAgBD,cAAA,GAAiBqB,GAAA,CAAIhB,IAAI,CAAC,KAAKC,SAAA,EAAW;gBACxER,aAAA,CAAcuB,GAAA,CAAItB,MAAM,EAAEC,cAAc,CAACqB,GAAA,CAAIhB,IAAI,CAAC,EAAEJ,YAAY,CAACoB,GAAA,CAAIhB,IAAI,CAAC;cAC5E;YACF,OAAO;cACLP,aAAA,CAAcuB,GAAA,CAAItB,MAAM,EAAEC,cAAA,EAAgBC,YAAA;YAC5C;UACF;UACA;MACJ;IACF;EACF;AACF;AAEA,SAASqB,UAAUtB,cAAoB,EAAEC,YAAkB,EAAEF,MAAe;EAC1ED,aAAA,CAAcC,MAAA,EAAQC,cAAA,EAAgBC,YAAA;EAEtC,OAAOA,YAAA;AACT;AAEA,OAAO,MAAMsB,yBAAA,GAA4B,MAAOC,IAAA;EAC9C,MAAM;IAAEC;EAAG,CAAE,GAAGD,IAAA;EAEhB,IAAI;IACF,OAAO,MAAME,kBAAA,CAAmBF,IAAA;EAClC,EAAE,OAAOG,GAAA,EAAK;IACZF,GAAA,CAAIG,OAAO,CAACC,MAAM,CAACC,KAAK,CAAC;MACvBH,GAAA;MACAI,GAAA,EAAK,yCAAyCP,IAAA,CAAKQ,UAAU,SAASR,IAAA,CAAKS,QAAQ;IACrF;IAEA,IAAIN,GAAA,CAAIO,OAAO,KAAK,gBAAgB;MAClC,OAAO;IACT;IAEA,OAAOzC,YAAA,CAAakC,GAAA;EACtB;AACF;AAEA,OAAO,MAAMD,kBAAA,GAAqB,MAAOF,IAAA;EACvC,MAAM;IACJW,cAAc;IACdC,KAAK;IACLJ,UAAU;IACVK,UAAU;IACVC,YAAA,GAAe,KAAK;IACpBb,GAAA,EAAK;MACHG,OAAO;MACPA,OAAA,EAAS;QAAEW,WAAW;QAAEC;MAAO,CAAE;MACjCC;IAAI,CACL;IACDhB,GAAG;IACHQ;EAAQ,CACT,GAAGT,IAAA;EAEJ,MAAMkB,gBAAA,GAAmBD,IAAA,EAAME,UAAA;EAE/B,MAAMC,aAAA,GAAgBhB,OAAA,CAAQiB,MAAM,CAACC,KAAK,CAACL,IAAI;EAE/C;EACA,IAAIC,gBAAA,EAAkB;IACpB,MAAMK,mBAAA,GAAsBnB,OAAA,CAAQW,WAAW,CAACG,gBAAA,CAAiB,CAACG,MAAM,CAACG,MAAM,EAAEF,KAAA;IAEjF;IACA,IAAIC,mBAAA,EAAqB;MACvB,MAAME,cAAA,GAAiB,MAAMF,mBAAA,CAAoB;QAAEtB,GAAA,EAAKD,IAAA,CAAKC;MAAI;MAEjE,IAAI,CAACwB,cAAA,EAAgB;QACnB,MAAM,IAAIC,KAAA,CAAM;MAClB;MACA;IACF,OAAO,IAAIN,aAAA,KAAkBF,gBAAA,EAAkB;MAC7C,MAAM,IAAIQ,KAAA,CAAM;IAClB;EACF;EAEA,MAAM,CAAClD,cAAA,EAAgBC,YAAA,CAAa,GAAG,MAAMkD,OAAA,CAAQC,UAAU,CAAC,CAC9Df,UAAA,GACIT,OAAA,CAAQyB,UAAU,CAAC;IACjBpC,IAAA,EAAMoB,UAAA;IACNiB,KAAA,EAAO;IACPC,MAAA,EAAQvB,UAAA;IACRwB,cAAA,EAAgB;IAChBf;EAEF,KACAb,OAAA,CAAQ6B,QAAQ,CAAC;IACf9C,EAAA,EAAIyB,KAAA;IACJO,UAAA,EAAYR,cAAA;IACZmB,KAAA,EAAO;IACPI,KAAA,EAAO;IACPH,MAAA,EAAQvB,UAAA;IACRwB,cAAA,EAAgB;IAChBf;EAEF,IACJJ,UAAA,GACIT,OAAA,CAAQyB,UAAU,CAAC;IACjBpC,IAAA,EAAMoB,UAAA;IACNiB,KAAA,EAAO;IACPC,MAAA,EAAQtB,QAAA;IACRuB,cAAA,EAAgB;IAChBf;EAEF,KACAb,OAAA,CAAQ6B,QAAQ,CAAC;IACf9C,EAAA,EAAIyB,KAAA;IACJO,UAAA,EAAYR,cAAA;IACZmB,KAAA,EAAO;IACPI,KAAA,EAAO;IACPH,MAAA,EAAQtB,QAAA;IACRuB,cAAA,EAAgB;IAChBf;EAEF,GACL;EAED,IAAIzC,cAAA,CAAe2D,MAAM,KAAK,YAAY;IACxC,MAAM,IAAIT,KAAA,CAAM,oCAAoClB,UAAA,GAAa;EACnE;EAEA,IAAI/B,YAAA,CAAa0D,MAAM,KAAK,YAAY;IACtC,MAAM,IAAIT,KAAA,CAAM,oCAAoCjB,QAAA,GAAW;EACjE;EAEA,OAAOI,UAAA,GACH,MAAMT,OAAA,CAAQgC,YAAY,CAAC;IACzB3C,IAAA,EAAMoB,UAAA;IACNwB,IAAA,EAAMvB,YAAA,GACFtC,cAAA,CAAe8D,KAAK,GACpBxC,SAAA,CAAUtB,cAAA,CAAe8D,KAAK,EAAE7D,YAAA,CAAa6D,KAAK,EAAEtB,OAAO,CAACH,UAAA,CAAW,CAACQ,MAAM,CAAC9C,MAAM;IACzFwD,MAAA,EAAQtB,QAAA;IACRuB,cAAA,EAAgB;IAChB/B,GAAA;IACAgB;EACF,KACA,MAAMb,OAAA,CAAQmC,MAAM,CAAC;IACnBpD,EAAA,EAAIyB,KAAA;IACJO,UAAA,EAAYR,cAAA;IACZ0B,IAAA,EAAMvB,YAAA,GACFtC,cAAA,CAAe8D,KAAK,GACpBxC,SAAA,CACEtB,cAAA,CAAe8D,KAAK,EACpB7D,YAAA,CAAa6D,KAAK,EAClBvB,WAAW,CAACJ,cAAA,CAAe,CAACU,MAAM,CAAC9C,MAAM;IAE/CwD,MAAA,EAAQtB,QAAA;IACRuB,cAAA,EAAgB;IAChB/B,GAAA;IACAgB;EACF;AACN","ignoreList":[]}

package/dist/utilities/upsertPreferences.d.ts

@@ -0,0 +1,15 @@
+import type { PayloadRequest } from 'payload';
+/**
+ * Will update the given preferences by key, creating a new record if it doesn't already exist, or merging existing preferences with the new value.
+ * This is not possible to do with the existing `db.upsert` operation because it stores on the `value` key and does not perform a deep merge beyond the first level.
+ * I.e. if you have a preferences record with a `value` key, `db.upsert` will overwrite the existing value. In the future if this supported we should use that instead.
+ * @param req - The PayloadRequest object
+ * @param key - The key of the preferences to update
+ * @param value - The new value to merge with the existing preferences
+ */
+export declare const upsertPreferences: <T extends Record<string, any>>({ key, req, value: incomingValue, }: {
+    key: string;
+    req: PayloadRequest;
+    value: Record<string, any>;
+}) => Promise<T>;
+//# sourceMappingURL=upsertPreferences.d.ts.map

package/dist/utilities/upsertPreferences.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upsertPreferences.d.ts","sourceRoot":"","sources":["../../src/utilities/upsertPreferences.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAM7C;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,GAAU,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,uCAIlE;IACD,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,cAAc,CAAA;IACnB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC3B,KAAG,OAAO,CAAC,CAAC,CAwEZ,CAAA"}

package/dist/utilities/upsertPreferences.js

@@ -0,0 +1,79 @@
+import { dequal } from 'dequal/lite';
+import { removeUndefined } from './removeUndefined.js';
+/**
+ * Will update the given preferences by key, creating a new record if it doesn't already exist, or merging existing preferences with the new value.
+ * This is not possible to do with the existing `db.upsert` operation because it stores on the `value` key and does not perform a deep merge beyond the first level.
+ * I.e. if you have a preferences record with a `value` key, `db.upsert` will overwrite the existing value. In the future if this supported we should use that instead.
+ * @param req - The PayloadRequest object
+ * @param key - The key of the preferences to update
+ * @param value - The new value to merge with the existing preferences
+ */
+export const upsertPreferences = async ({
+  key,
+  req,
+  value: incomingValue
+}) => {
+  const preferencesResult = await req.payload.find({
+    collection: 'payload-preferences',
+    depth: 0,
+    limit: 1,
+    pagination: false,
+    where: {
+      and: [{
+        key: {
+          equals: key
+        }
+      }, {
+        'user.relationTo': {
+          equals: req.user.collection
+        }
+      }, {
+        'user.value': {
+          equals: req.user.id
+        }
+      }]
+    }
+  }).then(res => res.docs[0] ?? {
+    id: null,
+    value: {}
+  });
+  let newPrefs = preferencesResult.value;
+  if (!preferencesResult.id) {
+    await req.payload.create({
+      collection: 'payload-preferences',
+      data: {
+        key,
+        user: {
+          collection: req.user.collection,
+          value: req.user.id
+        },
+        value: incomingValue
+      },
+      depth: 0,
+      req
+    });
+  } else {
+    const mergedPrefs = {
+      ...(preferencesResult?.value || {}),
+      ...removeUndefined(incomingValue || {})
+    };
+    if (!dequal(mergedPrefs, preferencesResult.value)) {
+      newPrefs = await req.payload.update({
+        id: preferencesResult.id,
+        collection: 'payload-preferences',
+        data: {
+          key,
+          user: {
+            collection: req.user.collection,
+            value: req.user.id
+          },
+          value: mergedPrefs
+        },
+        depth: 0,
+        req
+      })?.then(res => res.value);
+    }
+  }
+  return newPrefs;
+};
+//# sourceMappingURL=upsertPreferences.js.map

package/dist/utilities/upsertPreferences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upsertPreferences.js","names":["dequal","removeUndefined","upsertPreferences","key","req","value","incomingValue","preferencesResult","payload","find","collection","depth","limit","pagination","where","and","equals","user","id","then","res","docs","newPrefs","create","data","mergedPrefs","update"],"sources":["../../src/utilities/upsertPreferences.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\n\nimport { dequal } from 'dequal/lite'\n\nimport { removeUndefined } from './removeUndefined.js'\n\n/**\n * Will update the given preferences by key, creating a new record if it doesn't already exist, or merging existing preferences with the new value.\n * This is not possible to do with the existing `db.upsert` operation because it stores on the `value` key and does not perform a deep merge beyond the first level.\n * I.e. if you have a preferences record with a `value` key, `db.upsert` will overwrite the existing value. In the future if this supported we should use that instead.\n * @param req - The PayloadRequest object\n * @param key - The key of the preferences to update\n * @param value - The new value to merge with the existing preferences\n */\nexport const upsertPreferences = async <T extends Record<string, any>>({\n  key,\n  req,\n  value: incomingValue,\n}: {\n  key: string\n  req: PayloadRequest\n  value: Record<string, any>\n}): Promise<T> => {\n  const preferencesResult = await req.payload\n    .find({\n      collection: 'payload-preferences',\n      depth: 0,\n      limit: 1,\n      pagination: false,\n      where: {\n        and: [\n          {\n            key: {\n              equals: key,\n            },\n          },\n          {\n            'user.relationTo': {\n              equals: req.user.collection,\n            },\n          },\n          {\n            'user.value': {\n              equals: req.user.id,\n            },\n          },\n        ],\n      },\n    })\n    .then((res) => res.docs[0] ?? { id: null, value: {} })\n\n  let newPrefs = preferencesResult.value\n\n  if (!preferencesResult.id) {\n    await req.payload.create({\n      collection: 'payload-preferences',\n      data: {\n        key,\n        user: {\n          collection: req.user.collection,\n          value: req.user.id,\n        },\n        value: incomingValue,\n      },\n      depth: 0,\n      req,\n    })\n  } else {\n    const mergedPrefs = {\n      ...(preferencesResult?.value || {}), // Shallow merge existing prefs to acquire any missing keys from incoming value\n      ...removeUndefined(incomingValue || {}),\n    }\n\n    if (!dequal(mergedPrefs, preferencesResult.value)) {\n      newPrefs = await req.payload\n        .update({\n          id: preferencesResult.id,\n          collection: 'payload-preferences',\n          data: {\n            key,\n            user: {\n              collection: req.user.collection,\n              value: req.user.id,\n            },\n            value: mergedPrefs,\n          },\n          depth: 0,\n          req,\n        })\n        ?.then((res) => res.value)\n    }\n  }\n\n  return newPrefs\n}\n"],"mappings":"AAEA,SAASA,MAAM,QAAQ;AAEvB,SAASC,eAAe,QAAQ;AAEhC;;;;;;;;AAQA,OAAO,MAAMC,iBAAA,GAAoB,MAAAA,CAAsC;EACrEC,GAAG;EACHC,GAAG;EACHC,KAAA,EAAOC;AAAa,CAKrB;EACC,MAAMC,iBAAA,GAAoB,MAAMH,GAAA,CAAII,OAAO,CACxCC,IAAI,CAAC;IACJC,UAAA,EAAY;IACZC,KAAA,EAAO;IACPC,KAAA,EAAO;IACPC,UAAA,EAAY;IACZC,KAAA,EAAO;MACLC,GAAA,EAAK,CACH;QACEZ,GAAA,EAAK;UACHa,MAAA,EAAQb;QACV;MACF,GACA;QACE,mBAAmB;UACjBa,MAAA,EAAQZ,GAAA,CAAIa,IAAI,CAACP;QACnB;MACF,GACA;QACE,cAAc;UACZM,MAAA,EAAQZ,GAAA,CAAIa,IAAI,CAACC;QACnB;MACF;IAEJ;EACF,GACCC,IAAI,CAAEC,GAAA,IAAQA,GAAA,CAAIC,IAAI,CAAC,EAAE,IAAI;IAAEH,EAAA,EAAI;IAAMb,KAAA,EAAO,CAAC;EAAE;EAEtD,IAAIiB,QAAA,GAAWf,iBAAA,CAAkBF,KAAK;EAEtC,IAAI,CAACE,iBAAA,CAAkBW,EAAE,EAAE;IACzB,MAAMd,GAAA,CAAII,OAAO,CAACe,MAAM,CAAC;MACvBb,UAAA,EAAY;MACZc,IAAA,EAAM;QACJrB,GAAA;QACAc,IAAA,EAAM;UACJP,UAAA,EAAYN,GAAA,CAAIa,IAAI,CAACP,UAAU;UAC/BL,KAAA,EAAOD,GAAA,CAAIa,IAAI,CAACC;QAClB;QACAb,KAAA,EAAOC;MACT;MACAK,KAAA,EAAO;MACPP;IACF;EACF,OAAO;IACL,MAAMqB,WAAA,GAAc;MAClB,IAAIlB,iBAAA,EAAmBF,KAAA,IAAS,CAAC,CAAC;MAClC,GAAGJ,eAAA,CAAgBK,aAAA,IAAiB,CAAC;IACvC;IAEA,IAAI,CAACN,MAAA,CAAOyB,WAAA,EAAalB,iBAAA,CAAkBF,KAAK,GAAG;MACjDiB,QAAA,GAAW,MAAMlB,GAAA,CAAII,OAAO,CACzBkB,MAAM,CAAC;QACNR,EAAA,EAAIX,iBAAA,CAAkBW,EAAE;QACxBR,UAAA,EAAY;QACZc,IAAA,EAAM;UACJrB,GAAA;UACAc,IAAA,EAAM;YACJP,UAAA,EAAYN,GAAA,CAAIa,IAAI,CAACP,UAAU;YAC/BL,KAAA,EAAOD,GAAA,CAAIa,IAAI,CAACC;UAClB;UACAb,KAAA,EAAOoB;QACT;QACAd,KAAA,EAAO;QACPP;MACF,IACEe,IAAA,CAAMC,GAAA,IAAQA,GAAA,CAAIf,KAAK;IAC7B;EACF;EAEA,OAAOiB,QAAA;AACT","ignoreList":[]}

package/dist/views/Edit/index.js

@@ -232,7 +232,7 @@ export const DefaultEditView = ({
       abortOnSaveRef.current = null;
       return state;
     }
-  }, [adminRoute, collectionSlug, depth, docPermissions, entitySlug, getDocPermissions, getDocPreferences, getFormState, globalSlug, id, incrementVersionCount, isEditing, isLockingEnabled, locale, onSaveFromContext, operation, refreshCookieAsync, reportUpdate, resetUploadEdits, router, schemaPathSegments, setDocumentIsLocked, updateSavedDocumentData, user, userSlug, autosaveEnabled]);
+  }, [reportUpdate, id, entitySlug, user, collectionSlug, userSlug, incrementVersionCount, updateSavedDocumentData, onSaveFromContext, isEditing, depth, getDocPermissions, globalSlug, autosaveEnabled, refreshCookieAsync, adminRoute, locale, router, resetUploadEdits, getDocPreferences, getFormState, docPermissions, operation, schemaPathSegments, isLockingEnabled, setDocumentIsLocked]);
   const onChange = useCallback(async ({
     formState: prevFormState
   }) => {