@payloadcms/sdk 4.0.0-internal.40de3ec → 4.0.0-internal.45cfa3d
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/collections/update.d.ts +0 -4
- package/dist/collections/update.d.ts.map +1 -1
- package/dist/collections/update.js.map +1 -1
- package/dist/globals/update.d.ts +0 -4
- package/dist/globals/update.d.ts.map +1 -1
- package/dist/globals/update.js.map +1 -1
- package/dist/utilities/buildSearchParams.d.ts.map +1 -1
- package/dist/utilities/buildSearchParams.js +3 -1
- package/dist/utilities/buildSearchParams.js.map +1 -1
- package/license.md +1 -1
- package/package.json +2 -2
|
@@ -38,10 +38,6 @@ export type UpdateBaseOptions<T extends PayloadTypesShape, TSlug extends Collect
|
|
|
38
38
|
* Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.
|
|
39
39
|
*/
|
|
40
40
|
populate?: PopulateType<T>;
|
|
41
|
-
/**
|
|
42
|
-
* Publish the document / documents with a specific locale.
|
|
43
|
-
*/
|
|
44
|
-
publishSpecificLocale?: string;
|
|
45
41
|
/**
|
|
46
42
|
* Specify [select](https://payloadcms.com/docs/queries/select) to control which fields to include to the result.
|
|
47
43
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"update.d.ts","sourceRoot":"","sources":["../../src/collections/update.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,iBAAiB,EAEjB,WAAW,EACX,oBAAoB,EACpB,KAAK,EACN,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAEhD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EACV,mBAAmB,EACnB,YAAY,EACZ,8BAA8B,EAC9B,wBAAwB,EACxB,6BAA6B,EAC9B,MAAM,aAAa,CAAA;AAIpB,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,iBAAiB,EAC3B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAC/B,OAAO,SAAS,wBAAwB,CAAC,CAAC,EAAE,KAAK,CAAC,IAChD;IACF;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAA;IACjB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,8BAA8B,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA;IAC3D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;IACvC,uEAAuE;IACvE,IAAI,CAAC,EAAE,KAAK,SAAS,oBAAoB,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,MAAM,GAAG,KAAK,CAAA;IACpE;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;IAC1B;;OAEG;IACH,
|
|
1
|
+
{"version":3,"file":"update.d.ts","sourceRoot":"","sources":["../../src/collections/update.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,iBAAiB,EAEjB,WAAW,EACX,oBAAoB,EACpB,KAAK,EACN,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAEhD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EACV,mBAAmB,EACnB,YAAY,EACZ,8BAA8B,EAC9B,wBAAwB,EACxB,6BAA6B,EAC9B,MAAM,aAAa,CAAA;AAIpB,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,iBAAiB,EAC3B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAC/B,OAAO,SAAS,wBAAwB,CAAC,CAAC,EAAE,KAAK,CAAC,IAChD;IACF;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAA;IACjB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,8BAA8B,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA;IAC3D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;IACvC,uEAAuE;IACvE,IAAI,CAAC,EAAE,KAAK,SAAS,oBAAoB,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,MAAM,GAAG,KAAK,CAAA;IACpE;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,iBAAiB,EAC3B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAC/B,OAAO,SAAS,wBAAwB,CAAC,CAAC,EAAE,KAAK,CAAC,IAChD;IACF,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,GAAG,iBAAiB,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;AAExC,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,iBAAiB,EAC3B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAC/B,OAAO,SAAS,wBAAwB,CAAC,CAAC,EAAE,KAAK,CAAC,IAChD;IACF,EAAE,CAAC,EAAE,KAAK,CAAA;IACV,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,KAAK,CAAA;CACb,GAAG,iBAAiB,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;AAExC,MAAM,MAAM,aAAa,CACvB,CAAC,SAAS,iBAAiB,EAC3B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAC/B,OAAO,SAAS,wBAAwB,CAAC,CAAC,EAAE,KAAK,CAAC,IAChD,iBAAiB,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,iBAAiB,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;AAE/E,wBAAsB,MAAM,CAC1B,CAAC,SAAS,iBAAiB,EAC3B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAC/B,OAAO,SAAS,wBAAwB,CAAC,CAAC,EAAE,KAAK,CAAC,EAElD,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,EAClB,OAAO,EAAE,aAAa,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EACzC,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CACR,mBAAmB,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,6BAA6B,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAC1F,CAuBA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/collections/update.ts"],"sourcesContent":["import type {\n CollectionSlug,\n PayloadTypesShape,\n SelectType,\n TypedLocale,\n UploadCollectionSlug,\n Where,\n} from 'payload'\nimport type { DeepPartial } from 'ts-essentials'\n\nimport type { PayloadSDK } from '../index.js'\nimport type {\n BulkOperationResult,\n PopulateType,\n RequiredDataFromCollectionSlug,\n SelectFromCollectionSlug,\n TransformCollectionWithSelect,\n} from '../types.js'\n\nimport { resolveFileFromOptions } from '../utilities/resolveFileFromOptions.js'\n\nexport type UpdateBaseOptions<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n> = {\n /**\n * Whether the current update should be marked as from autosave.\n * `versions.drafts.autosave` should be specified.\n */\n autosave?: boolean\n /**\n * the Collection slug to operate against.\n */\n collection: TSlug\n /**\n * The document / documents data to update.\n */\n data: DeepPartial<RequiredDataFromCollectionSlug<T, TSlug>>\n /**\n * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.\n */\n depth?: number\n /**\n * Update documents to a draft.\n */\n draft?: boolean\n /**\n * Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.\n */\n fallbackLocale?: false | TypedLocale<T>\n /** File Blob object or URL to the file. Only for upload collections */\n file?: TSlug extends UploadCollectionSlug<T> ? Blob | string : never\n /**\n * Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.\n */\n locale?: TypedLocale<T>\n /**\n * Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.\n */\n populate?: PopulateType<T>\n /**\n *
|
|
1
|
+
{"version":3,"sources":["../../src/collections/update.ts"],"sourcesContent":["import type {\n CollectionSlug,\n PayloadTypesShape,\n SelectType,\n TypedLocale,\n UploadCollectionSlug,\n Where,\n} from 'payload'\nimport type { DeepPartial } from 'ts-essentials'\n\nimport type { PayloadSDK } from '../index.js'\nimport type {\n BulkOperationResult,\n PopulateType,\n RequiredDataFromCollectionSlug,\n SelectFromCollectionSlug,\n TransformCollectionWithSelect,\n} from '../types.js'\n\nimport { resolveFileFromOptions } from '../utilities/resolveFileFromOptions.js'\n\nexport type UpdateBaseOptions<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n> = {\n /**\n * Whether the current update should be marked as from autosave.\n * `versions.drafts.autosave` should be specified.\n */\n autosave?: boolean\n /**\n * the Collection slug to operate against.\n */\n collection: TSlug\n /**\n * The document / documents data to update.\n */\n data: DeepPartial<RequiredDataFromCollectionSlug<T, TSlug>>\n /**\n * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.\n */\n depth?: number\n /**\n * Update documents to a draft.\n */\n draft?: boolean\n /**\n * Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.\n */\n fallbackLocale?: false | TypedLocale<T>\n /** File Blob object or URL to the file. Only for upload collections */\n file?: TSlug extends UploadCollectionSlug<T> ? Blob | string : never\n /**\n * Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.\n */\n locale?: TypedLocale<T>\n /**\n * Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.\n */\n populate?: PopulateType<T>\n /**\n * Specify [select](https://payloadcms.com/docs/queries/select) to control which fields to include to the result.\n */\n select?: TSelect\n /**\n * When `true`, the operation can target trashed (soft-deleted) documents. No effect unless the collection has `trash` enabled.\n * @default false\n */\n trash?: boolean\n}\n\nexport type UpdateByIDOptions<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n> = {\n id: number | string\n limit?: never\n where?: never\n} & UpdateBaseOptions<T, TSlug, TSelect>\n\nexport type UpdateManyOptions<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n> = {\n id?: never\n limit?: number\n where: Where\n} & UpdateBaseOptions<T, TSlug, TSelect>\n\nexport type UpdateOptions<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n> = UpdateByIDOptions<T, TSlug, TSelect> | UpdateManyOptions<T, TSlug, TSelect>\n\nexport async function update<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n>(\n sdk: PayloadSDK<T>,\n options: UpdateOptions<T, TSlug, TSelect>,\n init?: RequestInit,\n): Promise<\n BulkOperationResult<T, TSlug, TSelect> | TransformCollectionWithSelect<T, TSlug, TSelect>\n> {\n let file: Blob | undefined = undefined\n\n if (options.file) {\n file = await resolveFileFromOptions(options.file)\n }\n\n const response = await sdk.request({\n args: options,\n file,\n init,\n json: options.data,\n method: 'PATCH',\n path: `/${options.collection}${options.id ? `/${options.id}` : ''}`,\n })\n\n const json = await response.json()\n\n if (options.id) {\n return json.doc\n }\n\n return json\n}\n"],"names":["resolveFileFromOptions","update","sdk","options","init","file","undefined","response","request","args","json","data","method","path","collection","id","doc"],"mappings":"AAmBA,SAASA,sBAAsB,QAAQ,yCAAwC;AA+E/E,OAAO,eAAeC,OAKpBC,GAAkB,EAClBC,OAAyC,EACzCC,IAAkB;IAIlB,IAAIC,OAAyBC;IAE7B,IAAIH,QAAQE,IAAI,EAAE;QAChBA,OAAO,MAAML,uBAAuBG,QAAQE,IAAI;IAClD;IAEA,MAAME,WAAW,MAAML,IAAIM,OAAO,CAAC;QACjCC,MAAMN;QACNE;QACAD;QACAM,MAAMP,QAAQQ,IAAI;QAClBC,QAAQ;QACRC,MAAM,CAAC,CAAC,EAAEV,QAAQW,UAAU,GAAGX,QAAQY,EAAE,GAAG,CAAC,CAAC,EAAEZ,QAAQY,EAAE,EAAE,GAAG,IAAI;IACrE;IAEA,MAAML,OAAO,MAAMH,SAASG,IAAI;IAEhC,IAAIP,QAAQY,EAAE,EAAE;QACd,OAAOL,KAAKM,GAAG;IACjB;IAEA,OAAON;AACT"}
|
package/dist/globals/update.d.ts
CHANGED
|
@@ -27,10 +27,6 @@ export type UpdateGlobalOptions<T extends PayloadTypesShape, TSlug extends Globa
|
|
|
27
27
|
* Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.
|
|
28
28
|
*/
|
|
29
29
|
populate?: PopulateType<T>;
|
|
30
|
-
/**
|
|
31
|
-
* Publish the document / documents with a specific locale.
|
|
32
|
-
*/
|
|
33
|
-
publishSpecificLocale?: TypedLocale<T>;
|
|
34
30
|
/**
|
|
35
31
|
* Specify [select](https://payloadcms.com/docs/queries/select) to control which fields to include to the result.
|
|
36
32
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"update.d.ts","sourceRoot":"","sources":["../../src/globals/update.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACzE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAEhD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EACV,kBAAkB,EAClB,YAAY,EACZ,oBAAoB,EACpB,yBAAyB,EAC1B,MAAM,aAAa,CAAA;AAEpB,MAAM,MAAM,mBAAmB,CAC7B,CAAC,SAAS,iBAAiB,EAC3B,KAAK,SAAS,UAAU,CAAC,CAAC,CAAC,EAC3B,OAAO,SAAS,oBAAoB,CAAC,CAAC,EAAE,KAAK,CAAC,IAC5C;IACF;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;IAC3D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;IACvC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;IAC1B;;OAEG;IACH,
|
|
1
|
+
{"version":3,"file":"update.d.ts","sourceRoot":"","sources":["../../src/globals/update.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACzE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAEhD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EACV,kBAAkB,EAClB,YAAY,EACZ,oBAAoB,EACpB,yBAAyB,EAC1B,MAAM,aAAa,CAAA;AAEpB,MAAM,MAAM,mBAAmB,CAC7B,CAAC,SAAS,iBAAiB,EAC3B,KAAK,SAAS,UAAU,CAAC,CAAC,CAAC,EAC3B,OAAO,SAAS,oBAAoB,CAAC,CAAC,EAAE,KAAK,CAAC,IAC5C;IACF;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;IAC3D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;IACvC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAA;CACZ,CAAA;AAED,wBAAsB,YAAY,CAChC,CAAC,SAAS,iBAAiB,EAC3B,KAAK,SAAS,UAAU,CAAC,CAAC,CAAC,EAC3B,OAAO,SAAS,oBAAoB,CAAC,CAAC,EAAE,KAAK,CAAC,EAE9C,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,EAClB,OAAO,EAAE,mBAAmB,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EAC/C,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,yBAAyB,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAYvD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/globals/update.ts"],"sourcesContent":["import type { GlobalSlug, PayloadTypesShape, TypedLocale } from 'payload'\nimport type { DeepPartial } from 'ts-essentials'\n\nimport type { PayloadSDK } from '../index.js'\nimport type {\n DataFromGlobalSlug,\n PopulateType,\n SelectFromGlobalSlug,\n TransformGlobalWithSelect,\n} from '../types.js'\n\nexport type UpdateGlobalOptions<\n T extends PayloadTypesShape,\n TSlug extends GlobalSlug<T>,\n TSelect extends SelectFromGlobalSlug<T, TSlug>,\n> = {\n /**\n * The global data to update.\n */\n data: DeepPartial<Omit<DataFromGlobalSlug<T, TSlug>, 'id'>>\n /**\n * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.\n */\n depth?: number\n /**\n * Update documents to a draft.\n */\n draft?: boolean\n /**\n * Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.\n */\n fallbackLocale?: false | TypedLocale<T>\n /**\n * Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.\n */\n locale?: 'all' | TypedLocale<T>\n /**\n * Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.\n */\n populate?: PopulateType<T>\n /**\n *
|
|
1
|
+
{"version":3,"sources":["../../src/globals/update.ts"],"sourcesContent":["import type { GlobalSlug, PayloadTypesShape, TypedLocale } from 'payload'\nimport type { DeepPartial } from 'ts-essentials'\n\nimport type { PayloadSDK } from '../index.js'\nimport type {\n DataFromGlobalSlug,\n PopulateType,\n SelectFromGlobalSlug,\n TransformGlobalWithSelect,\n} from '../types.js'\n\nexport type UpdateGlobalOptions<\n T extends PayloadTypesShape,\n TSlug extends GlobalSlug<T>,\n TSelect extends SelectFromGlobalSlug<T, TSlug>,\n> = {\n /**\n * The global data to update.\n */\n data: DeepPartial<Omit<DataFromGlobalSlug<T, TSlug>, 'id'>>\n /**\n * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.\n */\n depth?: number\n /**\n * Update documents to a draft.\n */\n draft?: boolean\n /**\n * Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.\n */\n fallbackLocale?: false | TypedLocale<T>\n /**\n * Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.\n */\n locale?: 'all' | TypedLocale<T>\n /**\n * Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.\n */\n populate?: PopulateType<T>\n /**\n * Specify [select](https://payloadcms.com/docs/queries/select) to control which fields to include to the result.\n */\n select?: TSelect\n /**\n * the Global slug to operate against.\n */\n slug: TSlug\n}\n\nexport async function updateGlobal<\n T extends PayloadTypesShape,\n TSlug extends GlobalSlug<T>,\n TSelect extends SelectFromGlobalSlug<T, TSlug>,\n>(\n sdk: PayloadSDK<T>,\n options: UpdateGlobalOptions<T, TSlug, TSelect>,\n init?: RequestInit,\n): Promise<TransformGlobalWithSelect<T, TSlug, TSelect>> {\n const response = await sdk.request({\n args: options,\n init,\n json: options.data,\n method: 'POST',\n path: `/globals/${options.slug}`,\n })\n\n const { result } = await response.json()\n\n return result\n}\n"],"names":["updateGlobal","sdk","options","init","response","request","args","json","data","method","path","slug","result"],"mappings":"AAkDA,OAAO,eAAeA,aAKpBC,GAAkB,EAClBC,OAA+C,EAC/CC,IAAkB;IAElB,MAAMC,WAAW,MAAMH,IAAII,OAAO,CAAC;QACjCC,MAAMJ;QACNC;QACAI,MAAML,QAAQM,IAAI;QAClBC,QAAQ;QACRC,MAAM,CAAC,SAAS,EAAER,QAAQS,IAAI,EAAE;IAClC;IAEA,MAAM,EAAEC,MAAM,EAAE,GAAG,MAAMR,SAASG,IAAI;IAEtC,OAAOK;AACT"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"buildSearchParams.d.ts","sourceRoot":"","sources":["../../src/utilities/buildSearchParams.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAI1C,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACvC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClC,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,CAAA;AAED,eAAO,MAAM,iBAAiB,GAAI,MAAM,aAAa,KAAG,
|
|
1
|
+
{"version":3,"file":"buildSearchParams.d.ts","sourceRoot":"","sources":["../../src/utilities/buildSearchParams.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAI1C,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACvC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClC,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,CAAA;AAED,eAAO,MAAM,iBAAiB,GAAI,MAAM,aAAa,KAAG,MA8DvD,CAAA"}
|
|
@@ -42,8 +42,10 @@ export const buildSearchParams = (args)=>{
|
|
|
42
42
|
search.joins = args.joins;
|
|
43
43
|
}
|
|
44
44
|
if (Object.keys(search).length > 0) {
|
|
45
|
+
// @ts-expect-error allowEmptyArrays is not in the type definition for qs-esm, but it is supported
|
|
45
46
|
return stringify(search, {
|
|
46
|
-
addQueryPrefix: true
|
|
47
|
+
addQueryPrefix: true,
|
|
48
|
+
allowEmptyArrays: true
|
|
47
49
|
});
|
|
48
50
|
}
|
|
49
51
|
return '';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/utilities/buildSearchParams.ts"],"sourcesContent":["import type { Sort, Where } from 'payload'\n\nimport { stringify } from 'qs-esm'\n\nexport type OperationArgs = {\n depth?: number\n draft?: boolean\n fallbackLocale?: unknown\n joins?: false | Record<string, unknown>\n limit?: number\n locale?: unknown\n page?: number\n pagination?: boolean\n populate?: Record<string, unknown>\n select?: unknown\n sort?: Sort\n trash?: boolean\n where?: Where\n}\n\nexport const buildSearchParams = (args: OperationArgs): string => {\n const search: Record<string, unknown> = {}\n\n if (typeof args.depth === 'number') {\n search.depth = String(args.depth)\n }\n\n if (typeof args.page === 'number') {\n search.page = String(args.page)\n }\n\n if (typeof args.limit === 'number') {\n search.limit = String(args.limit)\n }\n\n if (typeof args.draft === 'boolean') {\n search.draft = String(args.draft)\n }\n\n if (typeof args.trash === 'boolean') {\n search.trash = String(args.trash)\n }\n\n if (typeof args.pagination === 'boolean') {\n search.pagination = String(args.pagination)\n }\n\n if (args.fallbackLocale) {\n search['fallback-locale'] = String(args.fallbackLocale)\n }\n\n if (args.locale) {\n search.locale = args.locale\n }\n\n if (args.sort) {\n const sanitizedSort = Array.isArray(args.sort) ? args.sort.join(',') : args.sort\n search.sort = sanitizedSort\n }\n\n if (args.select) {\n search.select = args.select\n }\n\n if (args.where) {\n search.where = args.where\n }\n\n if (args.populate) {\n search.populate = args.populate\n }\n\n if (args.joins) {\n search.joins = args.joins\n }\n\n if (Object.keys(search).length > 0) {\n return stringify(search, { addQueryPrefix: true })\n }\n\n return ''\n}\n"],"names":["stringify","buildSearchParams","args","search","depth","String","page","limit","draft","trash","pagination","fallbackLocale","locale","sort","sanitizedSort","Array","isArray","join","select","where","populate","joins","Object","keys","length","addQueryPrefix"],"mappings":"AAEA,SAASA,SAAS,QAAQ,SAAQ;AAkBlC,OAAO,MAAMC,oBAAoB,CAACC;IAChC,MAAMC,SAAkC,CAAC;IAEzC,IAAI,OAAOD,KAAKE,KAAK,KAAK,UAAU;QAClCD,OAAOC,KAAK,GAAGC,OAAOH,KAAKE,KAAK;IAClC;IAEA,IAAI,OAAOF,KAAKI,IAAI,KAAK,UAAU;QACjCH,OAAOG,IAAI,GAAGD,OAAOH,KAAKI,IAAI;IAChC;IAEA,IAAI,OAAOJ,KAAKK,KAAK,KAAK,UAAU;QAClCJ,OAAOI,KAAK,GAAGF,OAAOH,KAAKK,KAAK;IAClC;IAEA,IAAI,OAAOL,KAAKM,KAAK,KAAK,WAAW;QACnCL,OAAOK,KAAK,GAAGH,OAAOH,KAAKM,KAAK;IAClC;IAEA,IAAI,OAAON,KAAKO,KAAK,KAAK,WAAW;QACnCN,OAAOM,KAAK,GAAGJ,OAAOH,KAAKO,KAAK;IAClC;IAEA,IAAI,OAAOP,KAAKQ,UAAU,KAAK,WAAW;QACxCP,OAAOO,UAAU,GAAGL,OAAOH,KAAKQ,UAAU;IAC5C;IAEA,IAAIR,KAAKS,cAAc,EAAE;QACvBR,MAAM,CAAC,kBAAkB,GAAGE,OAAOH,KAAKS,cAAc;IACxD;IAEA,IAAIT,KAAKU,MAAM,EAAE;QACfT,OAAOS,MAAM,GAAGV,KAAKU,MAAM;IAC7B;IAEA,IAAIV,KAAKW,IAAI,EAAE;QACb,MAAMC,gBAAgBC,MAAMC,OAAO,CAACd,KAAKW,IAAI,IAAIX,KAAKW,IAAI,CAACI,IAAI,CAAC,OAAOf,KAAKW,IAAI;QAChFV,OAAOU,IAAI,GAAGC;IAChB;IAEA,IAAIZ,KAAKgB,MAAM,EAAE;QACff,OAAOe,MAAM,GAAGhB,KAAKgB,MAAM;IAC7B;IAEA,IAAIhB,KAAKiB,KAAK,EAAE;QACdhB,OAAOgB,KAAK,GAAGjB,KAAKiB,KAAK;IAC3B;IAEA,IAAIjB,KAAKkB,QAAQ,EAAE;QACjBjB,OAAOiB,QAAQ,GAAGlB,KAAKkB,QAAQ;IACjC;IAEA,IAAIlB,KAAKmB,KAAK,EAAE;QACdlB,OAAOkB,KAAK,GAAGnB,KAAKmB,KAAK;IAC3B;IAEA,IAAIC,OAAOC,IAAI,CAACpB,QAAQqB,MAAM,GAAG,GAAG;QAClC,OAAOxB,UAAUG,QAAQ;YAAEsB,gBAAgB;QAAK;
|
|
1
|
+
{"version":3,"sources":["../../src/utilities/buildSearchParams.ts"],"sourcesContent":["import type { Sort, Where } from 'payload'\n\nimport { stringify } from 'qs-esm'\n\nexport type OperationArgs = {\n depth?: number\n draft?: boolean\n fallbackLocale?: unknown\n joins?: false | Record<string, unknown>\n limit?: number\n locale?: unknown\n page?: number\n pagination?: boolean\n populate?: Record<string, unknown>\n select?: unknown\n sort?: Sort\n trash?: boolean\n where?: Where\n}\n\nexport const buildSearchParams = (args: OperationArgs): string => {\n const search: Record<string, unknown> = {}\n\n if (typeof args.depth === 'number') {\n search.depth = String(args.depth)\n }\n\n if (typeof args.page === 'number') {\n search.page = String(args.page)\n }\n\n if (typeof args.limit === 'number') {\n search.limit = String(args.limit)\n }\n\n if (typeof args.draft === 'boolean') {\n search.draft = String(args.draft)\n }\n\n if (typeof args.trash === 'boolean') {\n search.trash = String(args.trash)\n }\n\n if (typeof args.pagination === 'boolean') {\n search.pagination = String(args.pagination)\n }\n\n if (args.fallbackLocale) {\n search['fallback-locale'] = String(args.fallbackLocale)\n }\n\n if (args.locale) {\n search.locale = args.locale\n }\n\n if (args.sort) {\n const sanitizedSort = Array.isArray(args.sort) ? args.sort.join(',') : args.sort\n search.sort = sanitizedSort\n }\n\n if (args.select) {\n search.select = args.select\n }\n\n if (args.where) {\n search.where = args.where\n }\n\n if (args.populate) {\n search.populate = args.populate\n }\n\n if (args.joins) {\n search.joins = args.joins\n }\n\n if (Object.keys(search).length > 0) {\n // @ts-expect-error allowEmptyArrays is not in the type definition for qs-esm, but it is supported\n return stringify(search, { addQueryPrefix: true, allowEmptyArrays: true })\n }\n\n return ''\n}\n"],"names":["stringify","buildSearchParams","args","search","depth","String","page","limit","draft","trash","pagination","fallbackLocale","locale","sort","sanitizedSort","Array","isArray","join","select","where","populate","joins","Object","keys","length","addQueryPrefix","allowEmptyArrays"],"mappings":"AAEA,SAASA,SAAS,QAAQ,SAAQ;AAkBlC,OAAO,MAAMC,oBAAoB,CAACC;IAChC,MAAMC,SAAkC,CAAC;IAEzC,IAAI,OAAOD,KAAKE,KAAK,KAAK,UAAU;QAClCD,OAAOC,KAAK,GAAGC,OAAOH,KAAKE,KAAK;IAClC;IAEA,IAAI,OAAOF,KAAKI,IAAI,KAAK,UAAU;QACjCH,OAAOG,IAAI,GAAGD,OAAOH,KAAKI,IAAI;IAChC;IAEA,IAAI,OAAOJ,KAAKK,KAAK,KAAK,UAAU;QAClCJ,OAAOI,KAAK,GAAGF,OAAOH,KAAKK,KAAK;IAClC;IAEA,IAAI,OAAOL,KAAKM,KAAK,KAAK,WAAW;QACnCL,OAAOK,KAAK,GAAGH,OAAOH,KAAKM,KAAK;IAClC;IAEA,IAAI,OAAON,KAAKO,KAAK,KAAK,WAAW;QACnCN,OAAOM,KAAK,GAAGJ,OAAOH,KAAKO,KAAK;IAClC;IAEA,IAAI,OAAOP,KAAKQ,UAAU,KAAK,WAAW;QACxCP,OAAOO,UAAU,GAAGL,OAAOH,KAAKQ,UAAU;IAC5C;IAEA,IAAIR,KAAKS,cAAc,EAAE;QACvBR,MAAM,CAAC,kBAAkB,GAAGE,OAAOH,KAAKS,cAAc;IACxD;IAEA,IAAIT,KAAKU,MAAM,EAAE;QACfT,OAAOS,MAAM,GAAGV,KAAKU,MAAM;IAC7B;IAEA,IAAIV,KAAKW,IAAI,EAAE;QACb,MAAMC,gBAAgBC,MAAMC,OAAO,CAACd,KAAKW,IAAI,IAAIX,KAAKW,IAAI,CAACI,IAAI,CAAC,OAAOf,KAAKW,IAAI;QAChFV,OAAOU,IAAI,GAAGC;IAChB;IAEA,IAAIZ,KAAKgB,MAAM,EAAE;QACff,OAAOe,MAAM,GAAGhB,KAAKgB,MAAM;IAC7B;IAEA,IAAIhB,KAAKiB,KAAK,EAAE;QACdhB,OAAOgB,KAAK,GAAGjB,KAAKiB,KAAK;IAC3B;IAEA,IAAIjB,KAAKkB,QAAQ,EAAE;QACjBjB,OAAOiB,QAAQ,GAAGlB,KAAKkB,QAAQ;IACjC;IAEA,IAAIlB,KAAKmB,KAAK,EAAE;QACdlB,OAAOkB,KAAK,GAAGnB,KAAKmB,KAAK;IAC3B;IAEA,IAAIC,OAAOC,IAAI,CAACpB,QAAQqB,MAAM,GAAG,GAAG;QAClC,kGAAkG;QAClG,OAAOxB,UAAUG,QAAQ;YAAEsB,gBAAgB;YAAMC,kBAAkB;QAAK;IAC1E;IAEA,OAAO;AACT,EAAC"}
|
package/license.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
MIT License
|
|
2
2
|
|
|
3
|
-
Copyright (c) 2018-
|
|
3
|
+
Copyright (c) 2018-2026 Payload CMS, LLC <info@payloadcms.com>
|
|
4
4
|
|
|
5
5
|
Permission is hereby granted, free of charge, to any person obtaining
|
|
6
6
|
a copy of this software and associated documentation files (the
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@payloadcms/sdk",
|
|
3
|
-
"version": "4.0.0-internal.
|
|
3
|
+
"version": "4.0.0-internal.45cfa3d",
|
|
4
4
|
"description": "The official Payload REST API SDK",
|
|
5
5
|
"homepage": "https://payloadcms.com",
|
|
6
6
|
"repository": {
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
"dependencies": {
|
|
34
34
|
"qs-esm": "8.0.1",
|
|
35
35
|
"ts-essentials": "10.0.3",
|
|
36
|
-
"payload": "4.0.0-internal.
|
|
36
|
+
"payload": "4.0.0-internal.45cfa3d"
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
39
|
"@payloadcms/eslint-config": "3.28.0"
|