@payloadcms/sdk 3.81.0-internal-debug.1a0f4d0 → 3.81.0
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/count.d.ts +5 -0
- package/dist/collections/count.d.ts.map +1 -1
- package/dist/collections/count.js.map +1 -1
- package/dist/collections/delete.d.ts +5 -0
- package/dist/collections/delete.d.ts.map +1 -1
- package/dist/collections/delete.js.map +1 -1
- package/dist/collections/findByID.d.ts +5 -0
- package/dist/collections/findByID.d.ts.map +1 -1
- package/dist/collections/findByID.js.map +1 -1
- package/dist/collections/update.d.ts +5 -0
- package/dist/collections/update.d.ts.map +1 -1
- package/dist/collections/update.js.map +1 -1
- package/dist/utilities/buildSearchParams.d.ts +1 -0
- package/dist/utilities/buildSearchParams.d.ts.map +1 -1
- package/dist/utilities/buildSearchParams.js +3 -0
- package/dist/utilities/buildSearchParams.js.map +1 -1
- package/package.json +3 -3
|
@@ -9,6 +9,11 @@ export type CountOptions<T extends PayloadTypesShape, TSlug extends CollectionSl
|
|
|
9
9
|
* Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.
|
|
10
10
|
*/
|
|
11
11
|
locale?: 'all' | TypedLocale<T>;
|
|
12
|
+
/**
|
|
13
|
+
* When `true`, the count includes trashed documents (same semantics as `find`). No effect unless the collection has `trash` enabled.
|
|
14
|
+
* @default false
|
|
15
|
+
*/
|
|
16
|
+
trash?: boolean;
|
|
12
17
|
/**
|
|
13
18
|
* A filter [query](https://payloadcms.com/docs/queries/overview)
|
|
14
19
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"count.d.ts","sourceRoot":"","sources":["../../src/collections/count.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAEpF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAE7C,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,iBAAiB,EAAE,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,IAAI;IACvF;;OAEG;IACH,UAAU,EAAE,KAAK,CAAA;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,CAAA;AAED,wBAAsB,KAAK,CAAC,CAAC,SAAS,iBAAiB,EAAE,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EACtF,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,EAClB,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,EAC/B,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC,CAShC"}
|
|
1
|
+
{"version":3,"file":"count.d.ts","sourceRoot":"","sources":["../../src/collections/count.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAEpF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAE7C,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,iBAAiB,EAAE,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,IAAI;IACvF;;OAEG;IACH,UAAU,EAAE,KAAK,CAAA;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;IAC/B;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,CAAA;AAED,wBAAsB,KAAK,CAAC,CAAC,SAAS,iBAAiB,EAAE,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EACtF,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,EAClB,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,EAC/B,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC,CAShC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/collections/count.ts"],"sourcesContent":["import type { CollectionSlug, PayloadTypesShape, TypedLocale, Where } from 'payload'\n\nimport type { PayloadSDK } from '../index.js'\n\nexport type CountOptions<T extends PayloadTypesShape, TSlug extends CollectionSlug<T>> = {\n /**\n * the Collection slug to operate against.\n */\n collection: TSlug\n /**\n * Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.\n */\n locale?: 'all' | TypedLocale<T>\n /**\n * A filter [query](https://payloadcms.com/docs/queries/overview)\n */\n where?: Where\n}\n\nexport async function count<T extends PayloadTypesShape, TSlug extends CollectionSlug<T>>(\n sdk: PayloadSDK<T>,\n options: CountOptions<T, TSlug>,\n init?: RequestInit,\n): Promise<{ totalDocs: number }> {\n const response = await sdk.request({\n args: options,\n init,\n method: 'GET',\n path: `/${options.collection}/count`,\n })\n\n return response.json()\n}\n"],"names":["count","sdk","options","init","response","request","args","method","path","collection","json"],"mappings":"
|
|
1
|
+
{"version":3,"sources":["../../src/collections/count.ts"],"sourcesContent":["import type { CollectionSlug, PayloadTypesShape, TypedLocale, Where } from 'payload'\n\nimport type { PayloadSDK } from '../index.js'\n\nexport type CountOptions<T extends PayloadTypesShape, TSlug extends CollectionSlug<T>> = {\n /**\n * the Collection slug to operate against.\n */\n collection: TSlug\n /**\n * Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.\n */\n locale?: 'all' | TypedLocale<T>\n /**\n * When `true`, the count includes trashed documents (same semantics as `find`). No effect unless the collection has `trash` enabled.\n * @default false\n */\n trash?: boolean\n /**\n * A filter [query](https://payloadcms.com/docs/queries/overview)\n */\n where?: Where\n}\n\nexport async function count<T extends PayloadTypesShape, TSlug extends CollectionSlug<T>>(\n sdk: PayloadSDK<T>,\n options: CountOptions<T, TSlug>,\n init?: RequestInit,\n): Promise<{ totalDocs: number }> {\n const response = await sdk.request({\n args: options,\n init,\n method: 'GET',\n path: `/${options.collection}/count`,\n })\n\n return response.json()\n}\n"],"names":["count","sdk","options","init","response","request","args","method","path","collection","json"],"mappings":"AAwBA,OAAO,eAAeA,MACpBC,GAAkB,EAClBC,OAA+B,EAC/BC,IAAkB;IAElB,MAAMC,WAAW,MAAMH,IAAII,OAAO,CAAC;QACjCC,MAAMJ;QACNC;QACAI,QAAQ;QACRC,MAAM,CAAC,CAAC,EAAEN,QAAQO,UAAU,CAAC,MAAM,CAAC;IACtC;IAEA,OAAOL,SAASM,IAAI;AACtB"}
|
|
@@ -27,6 +27,11 @@ export type DeleteBaseOptions<T extends PayloadTypesShape, TSlug extends Collect
|
|
|
27
27
|
* Specify [select](https://payloadcms.com/docs/queries/select) to control which fields to include to the result.
|
|
28
28
|
*/
|
|
29
29
|
select?: TSelect;
|
|
30
|
+
/**
|
|
31
|
+
* When the collection has `trash` enabled: use with the REST API semantics for permanent delete vs bulk operations on trashed docs.
|
|
32
|
+
* @default false
|
|
33
|
+
*/
|
|
34
|
+
trash?: boolean;
|
|
30
35
|
};
|
|
31
36
|
export type DeleteByIDOptions<T extends PayloadTypesShape, TSlug extends CollectionSlug<T>, TSelect extends SelectFromCollectionSlug<T, TSlug>> = {
|
|
32
37
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"delete.d.ts","sourceRoot":"","sources":["../../src/collections/delete.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAc,WAAW,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAEhG,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EACV,mBAAmB,EACnB,YAAY,EACZ,wBAAwB,EACxB,6BAA6B,EAC9B,MAAM,aAAa,CAAA;AAEpB,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;;OAEG;IACH,UAAU,EAAE,KAAK,CAAA;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;IACvC;;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;
|
|
1
|
+
{"version":3,"file":"delete.d.ts","sourceRoot":"","sources":["../../src/collections/delete.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAc,WAAW,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAEhG,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EACV,mBAAmB,EACnB,YAAY,EACZ,wBAAwB,EACxB,6BAA6B,EAC9B,MAAM,aAAa,CAAA;AAEpB,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;;OAEG;IACH,UAAU,EAAE,KAAK,CAAA;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;IACvC;;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;;OAEG;IACH,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IAEnB,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;;OAEG;IACH,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,eAAe,CACnC,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,CAeA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/collections/delete.ts"],"sourcesContent":["import type { CollectionSlug, PayloadTypesShape, SelectType, TypedLocale, Where } from 'payload'\n\nimport type { PayloadSDK } from '../index.js'\nimport type {\n BulkOperationResult,\n PopulateType,\n SelectFromCollectionSlug,\n TransformCollectionWithSelect,\n} from '../types.js'\n\nexport type DeleteBaseOptions<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n> = {\n /**\n * the Collection slug to operate against.\n */\n collection: TSlug\n /**\n * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.\n */\n depth?: number\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?: 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\nexport type DeleteByIDOptions<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n> = {\n /**\n * The ID of the document to delete.\n */\n id: number | string\n\n where?: never\n} & DeleteBaseOptions<T, TSlug, TSelect>\n\nexport type DeleteManyOptions<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n> = {\n id?: never\n /**\n * A filter [query](https://payloadcms.com/docs/queries/overview)\n */\n where: Where\n} & DeleteBaseOptions<T, TSlug, TSelect>\n\nexport type DeleteOptions<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n> = DeleteByIDOptions<T, TSlug, TSelect> | DeleteManyOptions<T, TSlug, TSelect>\n\nexport async function deleteOperation<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n>(\n sdk: PayloadSDK<T>,\n options: DeleteOptions<T, TSlug, TSelect>,\n init?: RequestInit,\n): Promise<\n BulkOperationResult<T, TSlug, TSelect> | TransformCollectionWithSelect<T, TSlug, TSelect>\n> {\n const response = await sdk.request({\n args: options,\n init,\n method: 'DELETE',\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":["deleteOperation","sdk","options","init","response","request","args","method","path","collection","id","json","doc"],"mappings":"
|
|
1
|
+
{"version":3,"sources":["../../src/collections/delete.ts"],"sourcesContent":["import type { CollectionSlug, PayloadTypesShape, SelectType, TypedLocale, Where } from 'payload'\n\nimport type { PayloadSDK } from '../index.js'\nimport type {\n BulkOperationResult,\n PopulateType,\n SelectFromCollectionSlug,\n TransformCollectionWithSelect,\n} from '../types.js'\n\nexport type DeleteBaseOptions<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n> = {\n /**\n * the Collection slug to operate against.\n */\n collection: TSlug\n /**\n * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.\n */\n depth?: number\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?: 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 the collection has `trash` enabled: use with the REST API semantics for permanent delete vs bulk operations on trashed docs.\n * @default false\n */\n trash?: boolean\n}\n\nexport type DeleteByIDOptions<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n> = {\n /**\n * The ID of the document to delete.\n */\n id: number | string\n\n where?: never\n} & DeleteBaseOptions<T, TSlug, TSelect>\n\nexport type DeleteManyOptions<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n> = {\n id?: never\n /**\n * A filter [query](https://payloadcms.com/docs/queries/overview)\n */\n where: Where\n} & DeleteBaseOptions<T, TSlug, TSelect>\n\nexport type DeleteOptions<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n> = DeleteByIDOptions<T, TSlug, TSelect> | DeleteManyOptions<T, TSlug, TSelect>\n\nexport async function deleteOperation<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n>(\n sdk: PayloadSDK<T>,\n options: DeleteOptions<T, TSlug, TSelect>,\n init?: RequestInit,\n): Promise<\n BulkOperationResult<T, TSlug, TSelect> | TransformCollectionWithSelect<T, TSlug, TSelect>\n> {\n const response = await sdk.request({\n args: options,\n init,\n method: 'DELETE',\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":["deleteOperation","sdk","options","init","response","request","args","method","path","collection","id","json","doc"],"mappings":"AA8EA,OAAO,eAAeA,gBAKpBC,GAAkB,EAClBC,OAAyC,EACzCC,IAAkB;IAIlB,MAAMC,WAAW,MAAMH,IAAII,OAAO,CAAC;QACjCC,MAAMJ;QACNC;QACAI,QAAQ;QACRC,MAAM,CAAC,CAAC,EAAEN,QAAQO,UAAU,GAAGP,QAAQQ,EAAE,GAAG,CAAC,CAAC,EAAER,QAAQQ,EAAE,EAAE,GAAG,IAAI;IACrE;IAEA,MAAMC,OAAO,MAAMP,SAASO,IAAI;IAEhC,IAAIT,QAAQQ,EAAE,EAAE;QACd,OAAOC,KAAKC,GAAG;IACjB;IAEA,OAAOD;AACT"}
|
|
@@ -40,6 +40,11 @@ export type FindByIDOptions<T extends PayloadTypesShape, TSlug extends Collectio
|
|
|
40
40
|
* Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.
|
|
41
41
|
*/
|
|
42
42
|
populate?: PopulateType<T>;
|
|
43
|
+
/**
|
|
44
|
+
* When `true`, returns the document even if it is trashed. No effect unless the collection has `trash` enabled.
|
|
45
|
+
* @default false
|
|
46
|
+
*/
|
|
47
|
+
trash?: boolean;
|
|
43
48
|
} & Pick<FindOptions<TSlug, SelectType & TSelect>, 'select'>;
|
|
44
49
|
export declare function findByID<T extends PayloadTypesShape, TSlug extends CollectionSlug<T>, TDisableErrors extends boolean, TSelect extends SelectFromCollectionSlug<T, TSlug>>(sdk: PayloadSDK<T>, options: FindByIDOptions<T, TSlug, TDisableErrors, TSelect>, init?: RequestInit): Promise<ApplyDisableErrors<TransformCollectionWithSelect<T, TSlug, TSelect>, TDisableErrors>>;
|
|
45
50
|
//# sourceMappingURL=findByID.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"findByID.d.ts","sourceRoot":"","sources":["../../src/collections/findByID.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,cAAc,EACd,WAAW,EACX,iBAAiB,EACjB,UAAU,EACV,WAAW,EACZ,MAAM,SAAS,CAAA;AAEhB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EACV,SAAS,EACT,YAAY,EACZ,wBAAwB,EACxB,6BAA6B,EAC9B,MAAM,aAAa,CAAA;AAEpB,MAAM,MAAM,eAAe,CACzB,CAAC,SAAS,iBAAiB,EAC3B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAC/B,cAAc,SAAS,OAAO,EAC9B,OAAO,SAAS,wBAAwB,CAAC,CAAC,EAAE,KAAK,CAAC,IAChD;IACF;;OAEG;IACH,UAAU,EAAE,KAAK,CAAA;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,aAAa,CAAC,EAAE,cAAc,CAAA;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IACnB;;;OAGG;IACH,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;
|
|
1
|
+
{"version":3,"file":"findByID.d.ts","sourceRoot":"","sources":["../../src/collections/findByID.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,cAAc,EACd,WAAW,EACX,iBAAiB,EACjB,UAAU,EACV,WAAW,EACZ,MAAM,SAAS,CAAA;AAEhB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EACV,SAAS,EACT,YAAY,EACZ,wBAAwB,EACxB,6BAA6B,EAC9B,MAAM,aAAa,CAAA;AAEpB,MAAM,MAAM,eAAe,CACzB,CAAC,SAAS,iBAAiB,EAC3B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAC/B,cAAc,SAAS,OAAO,EAC9B,OAAO,SAAS,wBAAwB,CAAC,CAAC,EAAE,KAAK,CAAC,IAChD;IACF;;OAEG;IACH,UAAU,EAAE,KAAK,CAAA;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,aAAa,CAAC,EAAE,cAAc,CAAA;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IACnB;;;OAGG;IACH,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;IAC3B;;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;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAA;AAE5D,wBAAsB,QAAQ,CAC5B,CAAC,SAAS,iBAAiB,EAC3B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAC/B,cAAc,SAAS,OAAO,EAC9B,OAAO,SAAS,wBAAwB,CAAC,CAAC,EAAE,KAAK,CAAC,EAElD,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,EAClB,OAAO,EAAE,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,OAAO,CAAC,EAC3D,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,kBAAkB,CAAC,6BAA6B,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAkB/F"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/collections/findByID.ts"],"sourcesContent":["import type {\n ApplyDisableErrors,\n CollectionSlug,\n FindOptions,\n PayloadTypesShape,\n SelectType,\n TypedLocale,\n} from 'payload'\n\nimport type { PayloadSDK } from '../index.js'\nimport type {\n JoinQuery,\n PopulateType,\n SelectFromCollectionSlug,\n TransformCollectionWithSelect,\n} from '../types.js'\n\nexport type FindByIDOptions<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TDisableErrors extends boolean,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n> = {\n /**\n * the Collection slug to operate against.\n */\n collection: TSlug\n /**\n * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.\n */\n depth?: number\n /**\n * When set to `true`, errors will not be thrown.\n * `null` will be returned instead, if the document on this ID was not found.\n */\n disableErrors?: TDisableErrors\n /**\n * Whether the document should be queried from the versions table/collection or not. [More](https://payloadcms.com/docs/versions/drafts#draft-api)\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 * The ID of the document to find.\n */\n id: number | string\n /**\n * The [Join Field Query](https://payloadcms.com/docs/fields/join#query-options).\n * Pass `false` to disable all join fields from the result.\n */\n joins?: JoinQuery<T, TSlug>\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} & Pick<FindOptions<TSlug, SelectType & TSelect>, 'select'>\n\nexport async function findByID<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TDisableErrors extends boolean,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n>(\n sdk: PayloadSDK<T>,\n options: FindByIDOptions<T, TSlug, TDisableErrors, TSelect>,\n init?: RequestInit,\n): Promise<ApplyDisableErrors<TransformCollectionWithSelect<T, TSlug, TSelect>, TDisableErrors>> {\n try {\n const response = await sdk.request({\n args: options,\n init,\n method: 'GET',\n path: `/${options.collection}/${options.id}`,\n })\n\n return response.json()\n } catch (err) {\n if (options.disableErrors) {\n // @ts-expect-error generic nullable\n return null\n }\n\n throw err\n }\n}\n"],"names":["findByID","sdk","options","init","response","request","args","method","path","collection","id","json","err","disableErrors"],"mappings":"
|
|
1
|
+
{"version":3,"sources":["../../src/collections/findByID.ts"],"sourcesContent":["import type {\n ApplyDisableErrors,\n CollectionSlug,\n FindOptions,\n PayloadTypesShape,\n SelectType,\n TypedLocale,\n} from 'payload'\n\nimport type { PayloadSDK } from '../index.js'\nimport type {\n JoinQuery,\n PopulateType,\n SelectFromCollectionSlug,\n TransformCollectionWithSelect,\n} from '../types.js'\n\nexport type FindByIDOptions<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TDisableErrors extends boolean,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n> = {\n /**\n * the Collection slug to operate against.\n */\n collection: TSlug\n /**\n * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.\n */\n depth?: number\n /**\n * When set to `true`, errors will not be thrown.\n * `null` will be returned instead, if the document on this ID was not found.\n */\n disableErrors?: TDisableErrors\n /**\n * Whether the document should be queried from the versions table/collection or not. [More](https://payloadcms.com/docs/versions/drafts#draft-api)\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 * The ID of the document to find.\n */\n id: number | string\n /**\n * The [Join Field Query](https://payloadcms.com/docs/fields/join#query-options).\n * Pass `false` to disable all join fields from the result.\n */\n joins?: JoinQuery<T, TSlug>\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 * When `true`, returns the document even if it is trashed. No effect unless the collection has `trash` enabled.\n * @default false\n */\n trash?: boolean\n} & Pick<FindOptions<TSlug, SelectType & TSelect>, 'select'>\n\nexport async function findByID<\n T extends PayloadTypesShape,\n TSlug extends CollectionSlug<T>,\n TDisableErrors extends boolean,\n TSelect extends SelectFromCollectionSlug<T, TSlug>,\n>(\n sdk: PayloadSDK<T>,\n options: FindByIDOptions<T, TSlug, TDisableErrors, TSelect>,\n init?: RequestInit,\n): Promise<ApplyDisableErrors<TransformCollectionWithSelect<T, TSlug, TSelect>, TDisableErrors>> {\n try {\n const response = await sdk.request({\n args: options,\n init,\n method: 'GET',\n path: `/${options.collection}/${options.id}`,\n })\n\n return response.json()\n } catch (err) {\n if (options.disableErrors) {\n // @ts-expect-error generic nullable\n return null\n }\n\n throw err\n }\n}\n"],"names":["findByID","sdk","options","init","response","request","args","method","path","collection","id","json","err","disableErrors"],"mappings":"AAoEA,OAAO,eAAeA,SAMpBC,GAAkB,EAClBC,OAA2D,EAC3DC,IAAkB;IAElB,IAAI;QACF,MAAMC,WAAW,MAAMH,IAAII,OAAO,CAAC;YACjCC,MAAMJ;YACNC;YACAI,QAAQ;YACRC,MAAM,CAAC,CAAC,EAAEN,QAAQO,UAAU,CAAC,CAAC,EAAEP,QAAQQ,EAAE,EAAE;QAC9C;QAEA,OAAON,SAASO,IAAI;IACtB,EAAE,OAAOC,KAAK;QACZ,IAAIV,QAAQW,aAAa,EAAE;YACzB,oCAAoC;YACpC,OAAO;QACT;QAEA,MAAMD;IACR;AACF"}
|
|
@@ -46,6 +46,11 @@ export type UpdateBaseOptions<T extends PayloadTypesShape, TSlug extends Collect
|
|
|
46
46
|
* Specify [select](https://payloadcms.com/docs/queries/select) to control which fields to include to the result.
|
|
47
47
|
*/
|
|
48
48
|
select?: TSelect;
|
|
49
|
+
/**
|
|
50
|
+
* When `true`, the operation can target trashed (soft-deleted) documents. No effect unless the collection has `trash` enabled.
|
|
51
|
+
* @default false
|
|
52
|
+
*/
|
|
53
|
+
trash?: boolean;
|
|
49
54
|
};
|
|
50
55
|
export type UpdateByIDOptions<T extends PayloadTypesShape, TSlug extends CollectionSlug<T>, TSelect extends SelectFromCollectionSlug<T, TSlug>> = {
|
|
51
56
|
id: number | string;
|
|
@@ -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,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;
|
|
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,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B;;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 * Publish the document / documents with a specific locale.\n */\n publishSpecificLocale?: string\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\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;
|
|
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 * Publish the document / documents with a specific locale.\n */\n publishSpecificLocale?: string\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;AAmF/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"}
|
|
@@ -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,KAAK,CAAA;CACd,CAAA;AAED,eAAO,MAAM,iBAAiB,SAAU,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,SAAU,aAAa,KAAG,MA6DvD,CAAA"}
|
|
@@ -13,6 +13,9 @@ export const buildSearchParams = (args)=>{
|
|
|
13
13
|
if (typeof args.draft === 'boolean') {
|
|
14
14
|
search.draft = String(args.draft);
|
|
15
15
|
}
|
|
16
|
+
if (typeof args.trash === 'boolean') {
|
|
17
|
+
search.trash = String(args.trash);
|
|
18
|
+
}
|
|
16
19
|
if (typeof args.pagination === 'boolean') {
|
|
17
20
|
search.pagination = String(args.pagination);
|
|
18
21
|
}
|
|
@@ -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 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.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","pagination","fallbackLocale","locale","sort","sanitizedSort","Array","isArray","join","select","where","populate","joins","Object","keys","length","addQueryPrefix"],"mappings":"AAEA,SAASA,SAAS,QAAQ,SAAQ;
|
|
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;IAClD;IAEA,OAAO;AACT,EAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@payloadcms/sdk",
|
|
3
|
-
"version": "3.81.0
|
|
3
|
+
"version": "3.81.0",
|
|
4
4
|
"description": "The official Payload REST API SDK",
|
|
5
5
|
"homepage": "https://payloadcms.com",
|
|
6
6
|
"repository": {
|
|
@@ -31,9 +31,9 @@
|
|
|
31
31
|
"dist"
|
|
32
32
|
],
|
|
33
33
|
"dependencies": {
|
|
34
|
-
"qs-esm": "
|
|
34
|
+
"qs-esm": "8.0.1",
|
|
35
35
|
"ts-essentials": "10.0.3",
|
|
36
|
-
"payload": "3.81.0
|
|
36
|
+
"payload": "3.81.0"
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
39
|
"@payloadcms/eslint-config": "3.28.0"
|