@payloadcms/sdk 0.0.1-beta.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/auth/forgotPassword.d.ts +13 -0
- package/dist/auth/forgotPassword.d.ts.map +1 -0
- package/dist/auth/forgotPassword.js +11 -0
- package/dist/auth/forgotPassword.js.map +1 -0
- package/dist/auth/login.d.ts +14 -0
- package/dist/auth/login.d.ts.map +1 -0
- package/dist/auth/login.js +11 -0
- package/dist/auth/login.js.map +1 -0
- package/dist/auth/me.d.ts +15 -0
- package/dist/auth/me.d.ts.map +1 -0
- package/dist/auth/me.js +10 -0
- package/dist/auth/me.js.map +1 -0
- package/dist/auth/refreshToken.d.ts +14 -0
- package/dist/auth/refreshToken.d.ts.map +1 -0
- package/dist/auth/refreshToken.js +10 -0
- package/dist/auth/refreshToken.js.map +1 -0
- package/dist/auth/resetPassword.d.ts +15 -0
- package/dist/auth/resetPassword.d.ts.map +1 -0
- package/dist/auth/resetPassword.js +11 -0
- package/dist/auth/resetPassword.js.map +1 -0
- package/dist/auth/verifyEmail.d.ts +10 -0
- package/dist/auth/verifyEmail.d.ts.map +1 -0
- package/dist/auth/verifyEmail.js +10 -0
- package/dist/auth/verifyEmail.js.map +1 -0
- package/dist/collections/count.d.ts +21 -0
- package/dist/collections/count.d.ts.map +1 -0
- package/dist/collections/count.js +11 -0
- package/dist/collections/count.js.map +1 -0
- package/dist/collections/create.d.ts +41 -0
- package/dist/collections/create.d.ts.map +1 -0
- package/dist/collections/create.js +19 -0
- package/dist/collections/create.js.map +1 -0
- package/dist/collections/delete.d.ts +47 -0
- package/dist/collections/delete.d.ts.map +1 -0
- package/dist/collections/delete.js +15 -0
- package/dist/collections/delete.js.map +1 -0
- package/dist/collections/find.d.ts +75 -0
- package/dist/collections/find.d.ts.map +1 -0
- package/dist/collections/find.js +11 -0
- package/dist/collections/find.js.map +1 -0
- package/dist/collections/findByID.d.ts +49 -0
- package/dist/collections/findByID.d.ts.map +1 -0
- package/dist/collections/findByID.js +23 -0
- package/dist/collections/findByID.js.map +1 -0
- package/dist/collections/findVersionByID.d.ts +53 -0
- package/dist/collections/findVersionByID.d.ts.map +1 -0
- package/dist/collections/findVersionByID.js +23 -0
- package/dist/collections/findVersionByID.js.map +1 -0
- package/dist/collections/findVersions.d.ts +70 -0
- package/dist/collections/findVersions.d.ts.map +1 -0
- package/dist/collections/findVersions.js +11 -0
- package/dist/collections/findVersions.js.map +1 -0
- package/dist/collections/restoreVersion.d.ts +34 -0
- package/dist/collections/restoreVersion.d.ts.map +1 -0
- package/dist/collections/restoreVersion.js +11 -0
- package/dist/collections/restoreVersion.js.map +1 -0
- package/dist/collections/update.d.ts +62 -0
- package/dist/collections/update.d.ts.map +1 -0
- package/dist/collections/update.js +22 -0
- package/dist/collections/update.js.map +1 -0
- package/dist/globals/findOne.d.ts +35 -0
- package/dist/globals/findOne.d.ts.map +1 -0
- package/dist/globals/findOne.js +11 -0
- package/dist/globals/findOne.js.map +1 -0
- package/dist/globals/findVersionByID.d.ts +41 -0
- package/dist/globals/findVersionByID.d.ts.map +1 -0
- package/dist/globals/findVersionByID.js +23 -0
- package/dist/globals/findVersionByID.js.map +1 -0
- package/dist/globals/findVersions.d.ts +58 -0
- package/dist/globals/findVersions.d.ts.map +1 -0
- package/dist/globals/findVersions.js +11 -0
- package/dist/globals/findVersions.js.map +1 -0
- package/dist/globals/restoreVersion.d.ts +32 -0
- package/dist/globals/restoreVersion.d.ts.map +1 -0
- package/dist/globals/restoreVersion.js +12 -0
- package/dist/globals/restoreVersion.js.map +1 -0
- package/dist/globals/update.d.ts +44 -0
- package/dist/globals/update.d.ts.map +1 -0
- package/dist/globals/update.js +13 -0
- package/dist/globals/update.js.map +1 -0
- package/dist/index.d.ts +148 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +144 -0
- package/dist/index.js.map +1 -0
- package/dist/types.d.ts +84 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +3 -0
- package/dist/types.js.map +1 -0
- package/dist/utilities/buildSearchParams.d.ts +16 -0
- package/dist/utilities/buildSearchParams.d.ts.map +1 -0
- package/dist/utilities/buildSearchParams.js +46 -0
- package/dist/utilities/buildSearchParams.js.map +1 -0
- package/dist/utilities/resolveFileFromOptions.d.ts +2 -0
- package/dist/utilities/resolveFileFromOptions.d.ts.map +1 -0
- package/dist/utilities/resolveFileFromOptions.js +16 -0
- package/dist/utilities/resolveFileFromOptions.js.map +1 -0
- package/license.md +22 -0
- package/package.json +53 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/globals/findVersions.ts"],"sourcesContent":["import type { PaginatedDocs, SelectType, Sort, TypeWithVersion, Where } from 'payload'\n\nimport type { PayloadSDK } from '../index.js'\nimport type {\n DataFromGlobalSlug,\n GlobalSlug,\n PayloadGeneratedTypes,\n PopulateType,\n TypedLocale,\n} from '../types.js'\n\nexport type FindGlobalVersionsOptions<\n T extends PayloadGeneratedTypes,\n TSlug extends GlobalSlug<T>,\n> = {\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 * The maximum related documents to be returned.\n * Defaults unless `defaultLimit` is specified for the collection config\n * @default 10\n */\n limit?: number\n /**\n * Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.\n */\n locale?: 'all' | TypedLocale<T>\n /**\n * Get a specific page number\n * @default 1\n */\n page?: number\n /**\n * Set to `false` to return all documents and avoid querying for document counts which introduces some overhead.\n * You can also combine that property with a specified `limit` to limit documents but avoid the count query.\n */\n pagination?: boolean\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?: SelectType\n /**\n * the Global slug to operate against.\n */\n slug: TSlug\n /**\n * Sort the documents, can be a string or an array of strings\n * @example '-version.createdAt' // Sort DESC by createdAt\n * @example ['version.group', '-version.createdAt'] // sort by 2 fields, ASC group and DESC createdAt\n */\n sort?: Sort\n /**\n * A filter [query](https://payloadcms.com/docs/queries/overview)\n */\n where?: Where\n}\n\nexport async function findGlobalVersions<\n T extends PayloadGeneratedTypes,\n TSlug extends GlobalSlug<T>,\n>(\n sdk: PayloadSDK<T>,\n options: FindGlobalVersionsOptions<T, TSlug>,\n init?: RequestInit,\n): Promise<PaginatedDocs<TypeWithVersion<DataFromGlobalSlug<T, TSlug>>>> {\n const response = await sdk.request({\n args: options,\n init,\n method: 'GET',\n path: `/globals/${options.slug}/versions`,\n })\n\n return response.json()\n}\n"],"names":["findGlobalVersions","sdk","options","init","response","request","args","method","path","slug","json"],"mappings":"AAoEA,OAAO,eAAeA,mBAIpBC,GAAkB,EAClBC,OAA4C,EAC5CC,IAAkB;IAElB,MAAMC,WAAW,MAAMH,IAAII,OAAO,CAAC;QACjCC,MAAMJ;QACNC;QACAI,QAAQ;QACRC,MAAM,CAAC,SAAS,EAAEN,QAAQO,IAAI,CAAC,SAAS,CAAC;IAC3C;IAEA,OAAOL,SAASM,IAAI;AACtB"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import type { TypeWithVersion } from 'payload';
|
|
2
|
+
import type { PayloadSDK } from '../index.js';
|
|
3
|
+
import type { DataFromGlobalSlug, GlobalSlug, PayloadGeneratedTypes, PopulateType, TypedLocale } from '../types.js';
|
|
4
|
+
export type RestoreGlobalVersionByIDOptions<T extends PayloadGeneratedTypes, TSlug extends GlobalSlug<T>> = {
|
|
5
|
+
/**
|
|
6
|
+
* [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.
|
|
7
|
+
*/
|
|
8
|
+
depth?: number;
|
|
9
|
+
draft?: boolean;
|
|
10
|
+
/**
|
|
11
|
+
* Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.
|
|
12
|
+
*/
|
|
13
|
+
fallbackLocale?: false | TypedLocale<T>;
|
|
14
|
+
/**
|
|
15
|
+
* The ID of the version to restore.
|
|
16
|
+
*/
|
|
17
|
+
id: number | string;
|
|
18
|
+
/**
|
|
19
|
+
* Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.
|
|
20
|
+
*/
|
|
21
|
+
locale?: 'all' | TypedLocale<T>;
|
|
22
|
+
/**
|
|
23
|
+
* Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.
|
|
24
|
+
*/
|
|
25
|
+
populate?: PopulateType<T>;
|
|
26
|
+
/**
|
|
27
|
+
* the Global slug to operate against.
|
|
28
|
+
*/
|
|
29
|
+
slug: TSlug;
|
|
30
|
+
};
|
|
31
|
+
export declare function restoreGlobalVersion<T extends PayloadGeneratedTypes, TSlug extends GlobalSlug<T>>(sdk: PayloadSDK<T>, options: RestoreGlobalVersionByIDOptions<T, TSlug>, init?: RequestInit): Promise<TypeWithVersion<DataFromGlobalSlug<T, TSlug>>>;
|
|
32
|
+
//# sourceMappingURL=restoreVersion.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"restoreVersion.d.ts","sourceRoot":"","sources":["../../src/globals/restoreVersion.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAE9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EACV,kBAAkB,EAClB,UAAU,EACV,qBAAqB,EACrB,YAAY,EACZ,WAAW,EACZ,MAAM,aAAa,CAAA;AAEpB,MAAM,MAAM,+BAA+B,CACzC,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,UAAU,CAAC,CAAC,CAAC,IACzB;IACF;;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,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IACnB;;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,IAAI,EAAE,KAAK,CAAA;CACZ,CAAA;AAED,wBAAsB,oBAAoB,CACxC,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,UAAU,CAAC,CAAC,CAAC,EAE3B,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,EAClB,OAAO,EAAE,+BAA+B,CAAC,CAAC,EAAE,KAAK,CAAC,EAClD,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAWxD"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export async function restoreGlobalVersion(sdk, options, init) {
|
|
2
|
+
const response = await sdk.request({
|
|
3
|
+
args: options,
|
|
4
|
+
init,
|
|
5
|
+
method: 'POST',
|
|
6
|
+
path: `/globals/${options.slug}/versions/${options.id}`
|
|
7
|
+
});
|
|
8
|
+
const { doc } = await response.json();
|
|
9
|
+
return doc;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
//# sourceMappingURL=restoreVersion.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/globals/restoreVersion.ts"],"sourcesContent":["import type { TypeWithVersion } from 'payload'\n\nimport type { PayloadSDK } from '../index.js'\nimport type {\n DataFromGlobalSlug,\n GlobalSlug,\n PayloadGeneratedTypes,\n PopulateType,\n TypedLocale,\n} from '../types.js'\n\nexport type RestoreGlobalVersionByIDOptions<\n T extends PayloadGeneratedTypes,\n TSlug extends GlobalSlug<T>,\n> = {\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 * The ID of the version to restore.\n */\n id: number | string\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 * the Global slug to operate against.\n */\n slug: TSlug\n}\n\nexport async function restoreGlobalVersion<\n T extends PayloadGeneratedTypes,\n TSlug extends GlobalSlug<T>,\n>(\n sdk: PayloadSDK<T>,\n options: RestoreGlobalVersionByIDOptions<T, TSlug>,\n init?: RequestInit,\n): Promise<TypeWithVersion<DataFromGlobalSlug<T, TSlug>>> {\n const response = await sdk.request({\n args: options,\n init,\n method: 'POST',\n path: `/globals/${options.slug}/versions/${options.id}`,\n })\n\n const { doc } = await response.json()\n\n return doc\n}\n"],"names":["restoreGlobalVersion","sdk","options","init","response","request","args","method","path","slug","id","doc","json"],"mappings":"AA0CA,OAAO,eAAeA,qBAIpBC,GAAkB,EAClBC,OAAkD,EAClDC,IAAkB;IAElB,MAAMC,WAAW,MAAMH,IAAII,OAAO,CAAC;QACjCC,MAAMJ;QACNC;QACAI,QAAQ;QACRC,MAAM,CAAC,SAAS,EAAEN,QAAQO,IAAI,CAAC,UAAU,EAAEP,QAAQQ,EAAE,EAAE;IACzD;IAEA,MAAM,EAAEC,GAAG,EAAE,GAAG,MAAMP,SAASQ,IAAI;IAEnC,OAAOD;AACT"}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import type { SelectType } from 'payload';
|
|
2
|
+
import type { DeepPartial } from 'ts-essentials';
|
|
3
|
+
import type { PayloadSDK } from '../index.js';
|
|
4
|
+
import type { DataFromGlobalSlug, GlobalSlug, PayloadGeneratedTypes, PopulateType, SelectFromGlobalSlug, TransformGlobalWithSelect, TypedLocale } from '../types.js';
|
|
5
|
+
export type UpdateGlobalOptions<T extends PayloadGeneratedTypes, TSlug extends GlobalSlug<T>, TSelect extends SelectType> = {
|
|
6
|
+
/**
|
|
7
|
+
* The global data to update.
|
|
8
|
+
*/
|
|
9
|
+
data: DeepPartial<Omit<DataFromGlobalSlug<T, TSlug>, 'id'>>;
|
|
10
|
+
/**
|
|
11
|
+
* [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.
|
|
12
|
+
*/
|
|
13
|
+
depth?: number;
|
|
14
|
+
/**
|
|
15
|
+
* Update documents to a draft.
|
|
16
|
+
*/
|
|
17
|
+
draft?: boolean;
|
|
18
|
+
/**
|
|
19
|
+
* Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.
|
|
20
|
+
*/
|
|
21
|
+
fallbackLocale?: false | TypedLocale<T>;
|
|
22
|
+
/**
|
|
23
|
+
* Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.
|
|
24
|
+
*/
|
|
25
|
+
locale?: 'all' | TypedLocale<T>;
|
|
26
|
+
/**
|
|
27
|
+
* Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.
|
|
28
|
+
*/
|
|
29
|
+
populate?: PopulateType<T>;
|
|
30
|
+
/**
|
|
31
|
+
* Publish the document / documents with a specific locale.
|
|
32
|
+
*/
|
|
33
|
+
publishSpecificLocale?: TypedLocale<T>;
|
|
34
|
+
/**
|
|
35
|
+
* Specify [select](https://payloadcms.com/docs/queries/select) to control which fields to include to the result.
|
|
36
|
+
*/
|
|
37
|
+
select?: TSelect;
|
|
38
|
+
/**
|
|
39
|
+
* the Global slug to operate against.
|
|
40
|
+
*/
|
|
41
|
+
slug: TSlug;
|
|
42
|
+
};
|
|
43
|
+
export declare function updateGlobal<T extends PayloadGeneratedTypes, TSlug extends GlobalSlug<T>, TSelect extends SelectFromGlobalSlug<T, TSlug>>(sdk: PayloadSDK<T>, options: UpdateGlobalOptions<T, TSlug, TSelect>, init?: RequestInit): Promise<TransformGlobalWithSelect<T, TSlug, TSelect>>;
|
|
44
|
+
//# sourceMappingURL=update.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"update.d.ts","sourceRoot":"","sources":["../../src/globals/update.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AACzC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAEhD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EACV,kBAAkB,EAClB,UAAU,EACV,qBAAqB,EACrB,YAAY,EACZ,oBAAoB,EACpB,yBAAyB,EACzB,WAAW,EACZ,MAAM,aAAa,CAAA;AAEpB,MAAM,MAAM,mBAAmB,CAC7B,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,UAAU,CAAC,CAAC,CAAC,EAC3B,OAAO,SAAS,UAAU,IACxB;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,qBAAqB,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;IACtC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAA;CACZ,CAAA;AAED,wBAAsB,YAAY,CAChC,CAAC,SAAS,qBAAqB,EAC/B,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"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
export async function updateGlobal(sdk, options, init) {
|
|
2
|
+
const response = await sdk.request({
|
|
3
|
+
args: options,
|
|
4
|
+
init,
|
|
5
|
+
json: options.data,
|
|
6
|
+
method: 'POST',
|
|
7
|
+
path: `/globals/${options.slug}`
|
|
8
|
+
});
|
|
9
|
+
const { result } = await response.json();
|
|
10
|
+
return result;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
//# sourceMappingURL=update.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/globals/update.ts"],"sourcesContent":["import type { SelectType } from 'payload'\nimport type { DeepPartial } from 'ts-essentials'\n\nimport type { PayloadSDK } from '../index.js'\nimport type {\n DataFromGlobalSlug,\n GlobalSlug,\n PayloadGeneratedTypes,\n PopulateType,\n SelectFromGlobalSlug,\n TransformGlobalWithSelect,\n TypedLocale,\n} from '../types.js'\n\nexport type UpdateGlobalOptions<\n T extends PayloadGeneratedTypes,\n TSlug extends GlobalSlug<T>,\n TSelect extends SelectType,\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 * Publish the document / documents with a specific locale.\n */\n publishSpecificLocale?: TypedLocale<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 PayloadGeneratedTypes,\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":"AAyDA,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"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
import type { ApplyDisableErrors, PaginatedDocs, SelectType, TypeWithVersion } from 'payload';
|
|
2
|
+
import type { ForgotPasswordOptions } from './auth/forgotPassword.js';
|
|
3
|
+
import type { LoginOptions, LoginResult } from './auth/login.js';
|
|
4
|
+
import type { MeOptions, MeResult } from './auth/me.js';
|
|
5
|
+
import type { ResetPasswordOptions, ResetPasswordResult } from './auth/resetPassword.js';
|
|
6
|
+
import type { CountOptions } from './collections/count.js';
|
|
7
|
+
import type { CreateOptions } from './collections/create.js';
|
|
8
|
+
import type { DeleteByIDOptions, DeleteManyOptions } from './collections/delete.js';
|
|
9
|
+
import type { FindOptions } from './collections/find.js';
|
|
10
|
+
import type { FindByIDOptions } from './collections/findByID.js';
|
|
11
|
+
import type { FindVersionByIDOptions } from './collections/findVersionByID.js';
|
|
12
|
+
import type { FindVersionsOptions } from './collections/findVersions.js';
|
|
13
|
+
import type { RestoreVersionByIDOptions } from './collections/restoreVersion.js';
|
|
14
|
+
import type { FindGlobalVersionByIDOptions } from './globals/findVersionByID.js';
|
|
15
|
+
import type { FindGlobalVersionsOptions } from './globals/findVersions.js';
|
|
16
|
+
import type { RestoreGlobalVersionByIDOptions } from './globals/restoreVersion.js';
|
|
17
|
+
import type { UpdateGlobalOptions } from './globals/update.js';
|
|
18
|
+
import type { AuthCollectionSlug, BulkOperationResult, CollectionSlug, DataFromCollectionSlug, DataFromGlobalSlug, GlobalSlug, PayloadGeneratedTypes, SelectFromCollectionSlug, SelectFromGlobalSlug, TransformCollectionWithSelect, TransformGlobalWithSelect } from './types.js';
|
|
19
|
+
import type { OperationArgs } from './utilities/buildSearchParams.js';
|
|
20
|
+
import { type RefreshOptions, type RefreshResult } from './auth/refreshToken.js';
|
|
21
|
+
import { type VerifyEmailOptions } from './auth/verifyEmail.js';
|
|
22
|
+
import { type UpdateByIDOptions, type UpdateManyOptions } from './collections/update.js';
|
|
23
|
+
import { type FindGlobalOptions } from './globals/findOne.js';
|
|
24
|
+
type Args = {
|
|
25
|
+
/** Base passed `RequestInit` to `fetch`. For base headers / credentials include etc. */
|
|
26
|
+
baseInit?: RequestInit;
|
|
27
|
+
/**
|
|
28
|
+
* Base API URL for requests.
|
|
29
|
+
* @example 'https://example.com/api'
|
|
30
|
+
*/
|
|
31
|
+
baseURL: string;
|
|
32
|
+
/**
|
|
33
|
+
* This option allows you to pass a custom `fetch` implementation.
|
|
34
|
+
* The function always receives `path` as the first parameter and `RequestInit` as the second.
|
|
35
|
+
* @example For testing without needing an HTTP server:
|
|
36
|
+
* ```typescript
|
|
37
|
+
* import type { GeneratedTypes, SanitizedConfig } from 'payload';
|
|
38
|
+
* import config from '@payload-config';
|
|
39
|
+
* import { REST_DELETE, REST_GET, REST_PATCH, REST_POST, REST_PUT } from '@payloadcms/next/routes';
|
|
40
|
+
* import { PayloadSDK } from '@payloadcms/sdk';
|
|
41
|
+
*
|
|
42
|
+
* export type TypedPayloadSDK = PayloadSDK<GeneratedTypes>;
|
|
43
|
+
*
|
|
44
|
+
* const api = {
|
|
45
|
+
* GET: REST_GET(config),
|
|
46
|
+
* POST: REST_POST(config),
|
|
47
|
+
* PATCH: REST_PATCH(config),
|
|
48
|
+
* DELETE: REST_DELETE(config),
|
|
49
|
+
* PUT: REST_PUT(config),
|
|
50
|
+
* };
|
|
51
|
+
*
|
|
52
|
+
* const awaitedConfig = await config;
|
|
53
|
+
*
|
|
54
|
+
* export const sdk = new PayloadSDK<GeneratedTypes>({
|
|
55
|
+
* baseURL: '',
|
|
56
|
+
* fetch: (path: string, init: RequestInit) => {
|
|
57
|
+
* const [slugs, search] = path.slice(1).split('?');
|
|
58
|
+
* const url = `${awaitedConfig.serverURL || 'http://localhost:3000'}${awaitedConfig.routes.api}/${slugs}${search ? `?${search}` : ''}`;
|
|
59
|
+
*
|
|
60
|
+
* if (init.body instanceof FormData) {
|
|
61
|
+
* const file = init.body.get('file') as Blob;
|
|
62
|
+
* if (file && init.headers instanceof Headers) {
|
|
63
|
+
* init.headers.set('Content-Length', file.size.toString());
|
|
64
|
+
* }
|
|
65
|
+
* }
|
|
66
|
+
*
|
|
67
|
+
* const request = new Request(url, init);
|
|
68
|
+
*
|
|
69
|
+
* const params = {
|
|
70
|
+
* params: Promise.resolve({
|
|
71
|
+
* slug: slugs.split('/'),
|
|
72
|
+
* }),
|
|
73
|
+
* };
|
|
74
|
+
*
|
|
75
|
+
* return api[init.method.toUpperCase()](request, params);
|
|
76
|
+
* },
|
|
77
|
+
* });
|
|
78
|
+
* ```
|
|
79
|
+
*/
|
|
80
|
+
fetch?: typeof fetch;
|
|
81
|
+
};
|
|
82
|
+
/**
|
|
83
|
+
* @experimental
|
|
84
|
+
*/
|
|
85
|
+
export declare class PayloadSDK<T extends PayloadGeneratedTypes = PayloadGeneratedTypes> {
|
|
86
|
+
baseInit: RequestInit;
|
|
87
|
+
baseURL: string;
|
|
88
|
+
fetch: typeof fetch;
|
|
89
|
+
constructor(args: Args);
|
|
90
|
+
/**
|
|
91
|
+
* @description Performs count operation
|
|
92
|
+
* @param options
|
|
93
|
+
* @returns count of documents satisfying query
|
|
94
|
+
*/
|
|
95
|
+
count<TSlug extends CollectionSlug<T>>(options: CountOptions<T, TSlug>, init?: RequestInit): Promise<{
|
|
96
|
+
totalDocs: number;
|
|
97
|
+
}>;
|
|
98
|
+
/**
|
|
99
|
+
* @description Performs create operation
|
|
100
|
+
* @param options
|
|
101
|
+
* @returns created document
|
|
102
|
+
*/
|
|
103
|
+
create<TSlug extends CollectionSlug<T>, TSelect extends SelectType>(options: CreateOptions<T, TSlug, TSelect>, init?: RequestInit): Promise<TransformCollectionWithSelect<T, TSlug, TSelect>>;
|
|
104
|
+
delete<TSlug extends CollectionSlug<T>, TSelect extends SelectFromCollectionSlug<T, TSlug>>(options: DeleteManyOptions<T, TSlug, TSelect>, init?: RequestInit): Promise<BulkOperationResult<T, TSlug, TSelect>>;
|
|
105
|
+
delete<TSlug extends CollectionSlug<T>, TSelect extends SelectFromCollectionSlug<T, TSlug>>(options: DeleteByIDOptions<T, TSlug, TSelect>, init?: RequestInit): Promise<TransformCollectionWithSelect<T, TSlug, TSelect>>;
|
|
106
|
+
/**
|
|
107
|
+
* @description Find documents with criteria
|
|
108
|
+
* @param options
|
|
109
|
+
* @returns documents satisfying query
|
|
110
|
+
*/
|
|
111
|
+
find<TSlug extends CollectionSlug<T>, TSelect extends SelectType>(options: FindOptions<T, TSlug, TSelect>, init?: RequestInit): Promise<PaginatedDocs<TransformCollectionWithSelect<T, TSlug, TSelect>>>;
|
|
112
|
+
/**
|
|
113
|
+
* @description Find document by ID
|
|
114
|
+
* @param options
|
|
115
|
+
* @returns document with specified ID
|
|
116
|
+
*/
|
|
117
|
+
findByID<TSlug extends CollectionSlug<T>, TDisableErrors extends boolean, TSelect extends SelectType>(options: FindByIDOptions<T, TSlug, TDisableErrors, TSelect>, init?: RequestInit): Promise<ApplyDisableErrors<TransformCollectionWithSelect<T, TSlug, TSelect>, TDisableErrors>>;
|
|
118
|
+
findGlobal<TSlug extends GlobalSlug<T>, TSelect extends SelectFromGlobalSlug<T, TSlug>>(options: FindGlobalOptions<T, TSlug, TSelect>, init?: RequestInit): Promise<TransformGlobalWithSelect<T, TSlug, TSelect>>;
|
|
119
|
+
findGlobalVersionByID<TSlug extends GlobalSlug<T>, TDisableErrors extends boolean>(options: FindGlobalVersionByIDOptions<T, TSlug, TDisableErrors>, init?: RequestInit): Promise<ApplyDisableErrors<TypeWithVersion<DataFromGlobalSlug<T, TSlug>>, TDisableErrors>>;
|
|
120
|
+
findGlobalVersions<TSlug extends GlobalSlug<T>>(options: FindGlobalVersionsOptions<T, TSlug>, init?: RequestInit): Promise<PaginatedDocs<TypeWithVersion<DataFromGlobalSlug<T, TSlug>>>>;
|
|
121
|
+
findVersionByID<TSlug extends CollectionSlug<T>, TDisableErrors extends boolean>(options: FindVersionByIDOptions<T, TSlug, TDisableErrors>, init?: RequestInit): Promise<ApplyDisableErrors<TypeWithVersion<DataFromCollectionSlug<T, TSlug>>, TDisableErrors>>;
|
|
122
|
+
findVersions<TSlug extends CollectionSlug<T>>(options: FindVersionsOptions<T, TSlug>, init?: RequestInit): Promise<PaginatedDocs<TypeWithVersion<DataFromCollectionSlug<T, TSlug>>>>;
|
|
123
|
+
forgotPassword<TSlug extends AuthCollectionSlug<T>>(options: ForgotPasswordOptions<T, TSlug>, init?: RequestInit): Promise<{
|
|
124
|
+
message: string;
|
|
125
|
+
}>;
|
|
126
|
+
login<TSlug extends AuthCollectionSlug<T>>(options: LoginOptions<T, TSlug>, init?: RequestInit): Promise<LoginResult<T, TSlug>>;
|
|
127
|
+
me<TSlug extends AuthCollectionSlug<T>>(options: MeOptions<T, TSlug>, init?: RequestInit): Promise<MeResult<T, TSlug>>;
|
|
128
|
+
refreshToken<TSlug extends AuthCollectionSlug<T>>(options: RefreshOptions<T, TSlug>, init?: RequestInit): Promise<RefreshResult<T, TSlug>>;
|
|
129
|
+
request({ args, file, init: incomingInit, json, method, path, }: {
|
|
130
|
+
args?: OperationArgs;
|
|
131
|
+
file?: Blob;
|
|
132
|
+
init?: RequestInit;
|
|
133
|
+
json?: unknown;
|
|
134
|
+
method: 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT';
|
|
135
|
+
path: string;
|
|
136
|
+
}): Promise<Response>;
|
|
137
|
+
resetPassword<TSlug extends AuthCollectionSlug<T>>(options: ResetPasswordOptions<T, TSlug>, init?: RequestInit): Promise<ResetPasswordResult<T, TSlug>>;
|
|
138
|
+
restoreGlobalVersion<TSlug extends GlobalSlug<T>>(options: RestoreGlobalVersionByIDOptions<T, TSlug>, init?: RequestInit): Promise<TypeWithVersion<DataFromGlobalSlug<T, TSlug>>>;
|
|
139
|
+
restoreVersion<TSlug extends CollectionSlug<T>>(options: RestoreVersionByIDOptions<T, TSlug>, init?: RequestInit): Promise<DataFromCollectionSlug<T, TSlug>>;
|
|
140
|
+
update<TSlug extends CollectionSlug<T>, TSelect extends SelectFromCollectionSlug<T, TSlug>>(options: UpdateManyOptions<T, TSlug, TSelect>, init?: RequestInit): Promise<BulkOperationResult<T, TSlug, TSelect>>;
|
|
141
|
+
update<TSlug extends CollectionSlug<T>, TSelect extends SelectFromCollectionSlug<T, TSlug>>(options: UpdateByIDOptions<T, TSlug, TSelect>, init?: RequestInit): Promise<TransformCollectionWithSelect<T, TSlug, TSelect>>;
|
|
142
|
+
updateGlobal<TSlug extends GlobalSlug<T>, TSelect extends SelectFromGlobalSlug<T, TSlug>>(options: UpdateGlobalOptions<T, TSlug, TSelect>, init?: RequestInit): Promise<TransformGlobalWithSelect<T, TSlug, TSelect>>;
|
|
143
|
+
verifyEmail<TSlug extends AuthCollectionSlug<T>>(options: VerifyEmailOptions<T, TSlug>, init?: RequestInit): Promise<{
|
|
144
|
+
message: string;
|
|
145
|
+
}>;
|
|
146
|
+
}
|
|
147
|
+
export {};
|
|
148
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAE7F,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAA;AACrE,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAChE,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AACvD,OAAO,KAAK,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAA;AACxF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AAC5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,EAAiB,MAAM,yBAAyB,CAAA;AAClG,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAA;AAC9E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAA;AACxE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAA;AAChF,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,8BAA8B,CAAA;AAChF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAA;AAC1E,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,6BAA6B,CAAA;AAClF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EACV,kBAAkB,EAClB,mBAAmB,EACnB,cAAc,EACd,sBAAsB,EACtB,kBAAkB,EAClB,UAAU,EACV,qBAAqB,EACrB,wBAAwB,EACxB,oBAAoB,EACpB,6BAA6B,EAC7B,yBAAyB,EAC1B,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAA;AAKrE,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,aAAa,EAAgB,MAAM,wBAAwB,CAAA;AAE9F,OAAO,EAAe,KAAK,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAS5E,OAAO,EAEL,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EAEvB,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAc,KAAK,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAOzE,KAAK,IAAI,GAAG;IACV,wFAAwF;IACxF,QAAQ,CAAC,EAAE,WAAW,CAAA;IAEtB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,qBAAa,UAAU,CAAC,CAAC,SAAS,qBAAqB,GAAG,qBAAqB;IAC7E,QAAQ,EAAE,WAAW,CAAA;IAErB,OAAO,EAAE,MAAM,CAAA;IAEf,KAAK,EAAE,OAAO,KAAK,CAAA;gBACP,IAAI,EAAE,IAAI;IAMtB;;;;OAIG;IACH,KAAK,CAAC,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EACnC,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,EAC/B,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAIjC;;;;OAIG;IACH,MAAM,CAAC,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,SAAS,UAAU,EAChE,OAAO,EAAE,aAAa,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EACzC,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,6BAA6B,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAI5D,MAAM,CAAC,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,SAAS,wBAAwB,CAAC,CAAC,EAAE,KAAK,CAAC,EACxF,OAAO,EAAE,iBAAiB,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EAC7C,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,mBAAmB,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAClD,MAAM,CAAC,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,SAAS,wBAAwB,CAAC,CAAC,EAAE,KAAK,CAAC,EACxF,OAAO,EAAE,iBAAiB,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EAC7C,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,6BAA6B,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAgB5D;;;;OAIG;IACH,IAAI,CAAC,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,SAAS,UAAU,EAC9D,OAAO,EAAE,WAAW,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EACvC,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,aAAa,CAAC,6BAA6B,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;IAI3E;;;;OAIG;IACH,QAAQ,CACN,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAC/B,cAAc,SAAS,OAAO,EAC9B,OAAO,SAAS,UAAU,EAE1B,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;IAIhG,UAAU,CAAC,KAAK,SAAS,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,SAAS,oBAAoB,CAAC,CAAC,EAAE,KAAK,CAAC,EACpF,OAAO,EAAE,iBAAiB,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EAC7C,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,yBAAyB,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAIxD,qBAAqB,CAAC,KAAK,SAAS,UAAU,CAAC,CAAC,CAAC,EAAE,cAAc,SAAS,OAAO,EAC/E,OAAO,EAAE,4BAA4B,CAAC,CAAC,EAAE,KAAK,EAAE,cAAc,CAAC,EAC/D,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,kBAAkB,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;IAI7F,kBAAkB,CAAC,KAAK,SAAS,UAAU,CAAC,CAAC,CAAC,EAC5C,OAAO,EAAE,yBAAyB,CAAC,CAAC,EAAE,KAAK,CAAC,EAC5C,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,aAAa,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAGxE,eAAe,CAAC,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAAE,cAAc,SAAS,OAAO,EAC7E,OAAO,EAAE,sBAAsB,CAAC,CAAC,EAAE,KAAK,EAAE,cAAc,CAAC,EACzD,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CACR,kBAAkB,CAAC,eAAe,CAAC,sBAAsB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CACtF;IAID,YAAY,CAAC,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAC1C,OAAO,EAAE,mBAAmB,CAAC,CAAC,EAAE,KAAK,CAAC,EACtC,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,aAAa,CAAC,eAAe,CAAC,sBAAsB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAG5E,cAAc,CAAC,KAAK,SAAS,kBAAkB,CAAC,CAAC,CAAC,EAChD,OAAO,EAAE,qBAAqB,CAAC,CAAC,EAAE,KAAK,CAAC,EACxC,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAI/B,KAAK,CAAC,KAAK,SAAS,kBAAkB,CAAC,CAAC,CAAC,EACvC,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,EAC/B,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAIjC,EAAE,CAAC,KAAK,SAAS,kBAAkB,CAAC,CAAC,CAAC,EACpC,OAAO,EAAE,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,EAC5B,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAI9B,YAAY,CAAC,KAAK,SAAS,kBAAkB,CAAC,CAAC,CAAC,EAC9C,OAAO,EAAE,cAAc,CAAC,CAAC,EAAE,KAAK,CAAC,EACjC,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,aAAa,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAI7B,OAAO,CAAC,EACZ,IAAS,EACT,IAAI,EACJ,IAAI,EAAE,YAAY,EAClB,IAAI,EACJ,MAAM,EACN,IAAI,GACL,EAAE;QACD,IAAI,CAAC,EAAE,aAAa,CAAA;QACpB,IAAI,CAAC,EAAE,IAAI,CAAA;QACX,IAAI,CAAC,EAAE,WAAW,CAAA;QAClB,IAAI,CAAC,EAAE,OAAO,CAAA;QACd,MAAM,EAAE,QAAQ,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,CAAA;QACnD,IAAI,EAAE,MAAM,CAAA;KACb,GAAG,OAAO,CAAC,QAAQ,CAAC;IA2BrB,aAAa,CAAC,KAAK,SAAS,kBAAkB,CAAC,CAAC,CAAC,EAC/C,OAAO,EAAE,oBAAoB,CAAC,CAAC,EAAE,KAAK,CAAC,EACvC,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,mBAAmB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAIzC,oBAAoB,CAAC,KAAK,SAAS,UAAU,CAAC,CAAC,CAAC,EAC9C,OAAO,EAAE,+BAA+B,CAAC,CAAC,EAAE,KAAK,CAAC,EAClD,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IAIzD,cAAc,CAAC,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAC5C,OAAO,EAAE,yBAAyB,CAAC,CAAC,EAAE,KAAK,CAAC,EAC5C,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAI5C,MAAM,CAAC,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,SAAS,wBAAwB,CAAC,CAAC,EAAE,KAAK,CAAC,EACxF,OAAO,EAAE,iBAAiB,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EAC7C,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,mBAAmB,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAElD,MAAM,CAAC,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,SAAS,wBAAwB,CAAC,CAAC,EAAE,KAAK,CAAC,EACxF,OAAO,EAAE,iBAAiB,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EAC7C,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,6BAA6B,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAgB5D,YAAY,CAAC,KAAK,SAAS,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,SAAS,oBAAoB,CAAC,CAAC,EAAE,KAAK,CAAC,EACtF,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;IAIxD,WAAW,CAAC,KAAK,SAAS,kBAAkB,CAAC,CAAC,CAAC,EAC7C,OAAO,EAAE,kBAAkB,CAAC,CAAC,EAAE,KAAK,CAAC,EACrC,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CAGhC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
import { forgotPassword } from './auth/forgotPassword.js';
|
|
2
|
+
import { login } from './auth/login.js';
|
|
3
|
+
import { me } from './auth/me.js';
|
|
4
|
+
import { refreshToken } from './auth/refreshToken.js';
|
|
5
|
+
import { resetPassword } from './auth/resetPassword.js';
|
|
6
|
+
import { verifyEmail } from './auth/verifyEmail.js';
|
|
7
|
+
import { count } from './collections/count.js';
|
|
8
|
+
import { create } from './collections/create.js';
|
|
9
|
+
import { deleteOperation } from './collections/delete.js';
|
|
10
|
+
import { find } from './collections/find.js';
|
|
11
|
+
import { findByID } from './collections/findByID.js';
|
|
12
|
+
import { findVersionByID } from './collections/findVersionByID.js';
|
|
13
|
+
import { findVersions } from './collections/findVersions.js';
|
|
14
|
+
import { restoreVersion } from './collections/restoreVersion.js';
|
|
15
|
+
import { update } from './collections/update.js';
|
|
16
|
+
import { findGlobal } from './globals/findOne.js';
|
|
17
|
+
import { findGlobalVersionByID } from './globals/findVersionByID.js';
|
|
18
|
+
import { findGlobalVersions } from './globals/findVersions.js';
|
|
19
|
+
import { restoreGlobalVersion } from './globals/restoreVersion.js';
|
|
20
|
+
import { updateGlobal } from './globals/update.js';
|
|
21
|
+
import { buildSearchParams } from './utilities/buildSearchParams.js';
|
|
22
|
+
/**
|
|
23
|
+
* @experimental
|
|
24
|
+
*/ export class PayloadSDK {
|
|
25
|
+
baseInit;
|
|
26
|
+
baseURL;
|
|
27
|
+
fetch;
|
|
28
|
+
constructor(args){
|
|
29
|
+
this.baseURL = args.baseURL;
|
|
30
|
+
this.fetch = args.fetch ?? globalThis.fetch;
|
|
31
|
+
this.baseInit = args.baseInit ?? {};
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* @description Performs count operation
|
|
35
|
+
* @param options
|
|
36
|
+
* @returns count of documents satisfying query
|
|
37
|
+
*/ count(options, init) {
|
|
38
|
+
return count(this, options, init);
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* @description Performs create operation
|
|
42
|
+
* @param options
|
|
43
|
+
* @returns created document
|
|
44
|
+
*/ create(options, init) {
|
|
45
|
+
return create(this, options, init);
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* @description Update one or more documents
|
|
49
|
+
* @param options
|
|
50
|
+
* @returns Updated document(s)
|
|
51
|
+
*/ delete(options, init) {
|
|
52
|
+
return deleteOperation(this, options, init);
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* @description Find documents with criteria
|
|
56
|
+
* @param options
|
|
57
|
+
* @returns documents satisfying query
|
|
58
|
+
*/ find(options, init) {
|
|
59
|
+
return find(this, options, init);
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* @description Find document by ID
|
|
63
|
+
* @param options
|
|
64
|
+
* @returns document with specified ID
|
|
65
|
+
*/ findByID(options, init) {
|
|
66
|
+
return findByID(this, options, init);
|
|
67
|
+
}
|
|
68
|
+
findGlobal(options, init) {
|
|
69
|
+
return findGlobal(this, options, init);
|
|
70
|
+
}
|
|
71
|
+
findGlobalVersionByID(options, init) {
|
|
72
|
+
return findGlobalVersionByID(this, options, init);
|
|
73
|
+
}
|
|
74
|
+
findGlobalVersions(options, init) {
|
|
75
|
+
return findGlobalVersions(this, options, init);
|
|
76
|
+
}
|
|
77
|
+
findVersionByID(options, init) {
|
|
78
|
+
return findVersionByID(this, options, init);
|
|
79
|
+
}
|
|
80
|
+
findVersions(options, init) {
|
|
81
|
+
return findVersions(this, options, init);
|
|
82
|
+
}
|
|
83
|
+
forgotPassword(options, init) {
|
|
84
|
+
return forgotPassword(this, options, init);
|
|
85
|
+
}
|
|
86
|
+
login(options, init) {
|
|
87
|
+
return login(this, options, init);
|
|
88
|
+
}
|
|
89
|
+
me(options, init) {
|
|
90
|
+
return me(this, options, init);
|
|
91
|
+
}
|
|
92
|
+
refreshToken(options, init) {
|
|
93
|
+
return refreshToken(this, options, init);
|
|
94
|
+
}
|
|
95
|
+
async request({ args = {}, file, init: incomingInit, json, method, path }) {
|
|
96
|
+
const headers = new Headers({
|
|
97
|
+
...this.baseInit.headers,
|
|
98
|
+
...incomingInit?.headers
|
|
99
|
+
});
|
|
100
|
+
const init = {
|
|
101
|
+
method,
|
|
102
|
+
...this.baseInit,
|
|
103
|
+
...incomingInit,
|
|
104
|
+
headers
|
|
105
|
+
};
|
|
106
|
+
if (json) {
|
|
107
|
+
if (file) {
|
|
108
|
+
const formData = new FormData();
|
|
109
|
+
formData.append('file', file);
|
|
110
|
+
formData.append('_payload', JSON.stringify(json));
|
|
111
|
+
init.body = formData;
|
|
112
|
+
} else {
|
|
113
|
+
headers.set('Content-Type', 'application/json');
|
|
114
|
+
init.body = JSON.stringify(json);
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
const response = await this.fetch(`${this.baseURL}${path}${buildSearchParams(args)}`, init);
|
|
118
|
+
return response;
|
|
119
|
+
}
|
|
120
|
+
resetPassword(options, init) {
|
|
121
|
+
return resetPassword(this, options, init);
|
|
122
|
+
}
|
|
123
|
+
restoreGlobalVersion(options, init) {
|
|
124
|
+
return restoreGlobalVersion(this, options, init);
|
|
125
|
+
}
|
|
126
|
+
restoreVersion(options, init) {
|
|
127
|
+
return restoreVersion(this, options, init);
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* @description Update one or more documents
|
|
131
|
+
* @param options
|
|
132
|
+
* @returns Updated document(s)
|
|
133
|
+
*/ update(options, init) {
|
|
134
|
+
return update(this, options, init);
|
|
135
|
+
}
|
|
136
|
+
updateGlobal(options, init) {
|
|
137
|
+
return updateGlobal(this, options, init);
|
|
138
|
+
}
|
|
139
|
+
verifyEmail(options, init) {
|
|
140
|
+
return verifyEmail(this, options, init);
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { ApplyDisableErrors, PaginatedDocs, SelectType, TypeWithVersion } from 'payload'\n\nimport type { ForgotPasswordOptions } from './auth/forgotPassword.js'\nimport type { LoginOptions, LoginResult } from './auth/login.js'\nimport type { MeOptions, MeResult } from './auth/me.js'\nimport type { ResetPasswordOptions, ResetPasswordResult } from './auth/resetPassword.js'\nimport type { CountOptions } from './collections/count.js'\nimport type { CreateOptions } from './collections/create.js'\nimport type { DeleteByIDOptions, DeleteManyOptions, DeleteOptions } from './collections/delete.js'\nimport type { FindOptions } from './collections/find.js'\nimport type { FindByIDOptions } from './collections/findByID.js'\nimport type { FindVersionByIDOptions } from './collections/findVersionByID.js'\nimport type { FindVersionsOptions } from './collections/findVersions.js'\nimport type { RestoreVersionByIDOptions } from './collections/restoreVersion.js'\nimport type { FindGlobalVersionByIDOptions } from './globals/findVersionByID.js'\nimport type { FindGlobalVersionsOptions } from './globals/findVersions.js'\nimport type { RestoreGlobalVersionByIDOptions } from './globals/restoreVersion.js'\nimport type { UpdateGlobalOptions } from './globals/update.js'\nimport type {\n AuthCollectionSlug,\n BulkOperationResult,\n CollectionSlug,\n DataFromCollectionSlug,\n DataFromGlobalSlug,\n GlobalSlug,\n PayloadGeneratedTypes,\n SelectFromCollectionSlug,\n SelectFromGlobalSlug,\n TransformCollectionWithSelect,\n TransformGlobalWithSelect,\n} from './types.js'\nimport type { OperationArgs } from './utilities/buildSearchParams.js'\n\nimport { forgotPassword } from './auth/forgotPassword.js'\nimport { login } from './auth/login.js'\nimport { me } from './auth/me.js'\nimport { type RefreshOptions, type RefreshResult, refreshToken } from './auth/refreshToken.js'\nimport { resetPassword } from './auth/resetPassword.js'\nimport { verifyEmail, type VerifyEmailOptions } from './auth/verifyEmail.js'\nimport { count } from './collections/count.js'\nimport { create } from './collections/create.js'\nimport { deleteOperation } from './collections/delete.js'\nimport { find } from './collections/find.js'\nimport { findByID } from './collections/findByID.js'\nimport { findVersionByID } from './collections/findVersionByID.js'\nimport { findVersions } from './collections/findVersions.js'\nimport { restoreVersion } from './collections/restoreVersion.js'\nimport {\n update,\n type UpdateByIDOptions,\n type UpdateManyOptions,\n type UpdateOptions,\n} from './collections/update.js'\nimport { findGlobal, type FindGlobalOptions } from './globals/findOne.js'\nimport { findGlobalVersionByID } from './globals/findVersionByID.js'\nimport { findGlobalVersions } from './globals/findVersions.js'\nimport { restoreGlobalVersion } from './globals/restoreVersion.js'\nimport { updateGlobal } from './globals/update.js'\nimport { buildSearchParams } from './utilities/buildSearchParams.js'\n\ntype Args = {\n /** Base passed `RequestInit` to `fetch`. For base headers / credentials include etc. */\n baseInit?: RequestInit\n\n /**\n * Base API URL for requests.\n * @example 'https://example.com/api'\n */\n baseURL: string\n\n /**\n * This option allows you to pass a custom `fetch` implementation.\n * The function always receives `path` as the first parameter and `RequestInit` as the second.\n * @example For testing without needing an HTTP server:\n * ```typescript\n * import type { GeneratedTypes, SanitizedConfig } from 'payload';\n * import config from '@payload-config';\n * import { REST_DELETE, REST_GET, REST_PATCH, REST_POST, REST_PUT } from '@payloadcms/next/routes';\n * import { PayloadSDK } from '@payloadcms/sdk';\n *\n * export type TypedPayloadSDK = PayloadSDK<GeneratedTypes>;\n *\n * const api = {\n * GET: REST_GET(config),\n * POST: REST_POST(config),\n * PATCH: REST_PATCH(config),\n * DELETE: REST_DELETE(config),\n * PUT: REST_PUT(config),\n * };\n *\n * const awaitedConfig = await config;\n *\n * export const sdk = new PayloadSDK<GeneratedTypes>({\n * baseURL: '',\n * fetch: (path: string, init: RequestInit) => {\n * const [slugs, search] = path.slice(1).split('?');\n * const url = `${awaitedConfig.serverURL || 'http://localhost:3000'}${awaitedConfig.routes.api}/${slugs}${search ? `?${search}` : ''}`;\n *\n * if (init.body instanceof FormData) {\n * const file = init.body.get('file') as Blob;\n * if (file && init.headers instanceof Headers) {\n * init.headers.set('Content-Length', file.size.toString());\n * }\n * }\n *\n * const request = new Request(url, init);\n *\n * const params = {\n * params: Promise.resolve({\n * slug: slugs.split('/'),\n * }),\n * };\n *\n * return api[init.method.toUpperCase()](request, params);\n * },\n * });\n * ```\n */\n fetch?: typeof fetch\n}\n\n/**\n * @experimental\n */\nexport class PayloadSDK<T extends PayloadGeneratedTypes = PayloadGeneratedTypes> {\n baseInit: RequestInit\n\n baseURL: string\n\n fetch: typeof fetch\n constructor(args: Args) {\n this.baseURL = args.baseURL\n this.fetch = args.fetch ?? globalThis.fetch\n this.baseInit = args.baseInit ?? {}\n }\n\n /**\n * @description Performs count operation\n * @param options\n * @returns count of documents satisfying query\n */\n count<TSlug extends CollectionSlug<T>>(\n options: CountOptions<T, TSlug>,\n init?: RequestInit,\n ): Promise<{ totalDocs: number }> {\n return count(this, options, init)\n }\n\n /**\n * @description Performs create operation\n * @param options\n * @returns created document\n */\n create<TSlug extends CollectionSlug<T>, TSelect extends SelectType>(\n options: CreateOptions<T, TSlug, TSelect>,\n init?: RequestInit,\n ): Promise<TransformCollectionWithSelect<T, TSlug, TSelect>> {\n return create(this, options, init)\n }\n\n delete<TSlug extends CollectionSlug<T>, TSelect extends SelectFromCollectionSlug<T, TSlug>>(\n options: DeleteManyOptions<T, TSlug, TSelect>,\n init?: RequestInit,\n ): Promise<BulkOperationResult<T, TSlug, TSelect>>\n delete<TSlug extends CollectionSlug<T>, TSelect extends SelectFromCollectionSlug<T, TSlug>>(\n options: DeleteByIDOptions<T, TSlug, TSelect>,\n init?: RequestInit,\n ): Promise<TransformCollectionWithSelect<T, TSlug, TSelect>>\n\n /**\n * @description Update one or more documents\n * @param options\n * @returns Updated document(s)\n */\n delete<TSlug extends CollectionSlug<T>, TSelect extends SelectFromCollectionSlug<T, TSlug>>(\n options: DeleteOptions<T, TSlug, TSelect>,\n init?: RequestInit,\n ): Promise<\n BulkOperationResult<T, TSlug, TSelect> | TransformCollectionWithSelect<T, TSlug, TSelect>\n > {\n return deleteOperation(this, options, init)\n }\n\n /**\n * @description Find documents with criteria\n * @param options\n * @returns documents satisfying query\n */\n find<TSlug extends CollectionSlug<T>, TSelect extends SelectType>(\n options: FindOptions<T, TSlug, TSelect>,\n init?: RequestInit,\n ): Promise<PaginatedDocs<TransformCollectionWithSelect<T, TSlug, TSelect>>> {\n return find(this, options, init)\n }\n\n /**\n * @description Find document by ID\n * @param options\n * @returns document with specified ID\n */\n findByID<\n TSlug extends CollectionSlug<T>,\n TDisableErrors extends boolean,\n TSelect extends SelectType,\n >(\n options: FindByIDOptions<T, TSlug, TDisableErrors, TSelect>,\n init?: RequestInit,\n ): Promise<ApplyDisableErrors<TransformCollectionWithSelect<T, TSlug, TSelect>, TDisableErrors>> {\n return findByID(this, options, init)\n }\n\n findGlobal<TSlug extends GlobalSlug<T>, TSelect extends SelectFromGlobalSlug<T, TSlug>>(\n options: FindGlobalOptions<T, TSlug, TSelect>,\n init?: RequestInit,\n ): Promise<TransformGlobalWithSelect<T, TSlug, TSelect>> {\n return findGlobal(this, options, init)\n }\n\n findGlobalVersionByID<TSlug extends GlobalSlug<T>, TDisableErrors extends boolean>(\n options: FindGlobalVersionByIDOptions<T, TSlug, TDisableErrors>,\n init?: RequestInit,\n ): Promise<ApplyDisableErrors<TypeWithVersion<DataFromGlobalSlug<T, TSlug>>, TDisableErrors>> {\n return findGlobalVersionByID(this, options, init)\n }\n\n findGlobalVersions<TSlug extends GlobalSlug<T>>(\n options: FindGlobalVersionsOptions<T, TSlug>,\n init?: RequestInit,\n ): Promise<PaginatedDocs<TypeWithVersion<DataFromGlobalSlug<T, TSlug>>>> {\n return findGlobalVersions(this, options, init)\n }\n findVersionByID<TSlug extends CollectionSlug<T>, TDisableErrors extends boolean>(\n options: FindVersionByIDOptions<T, TSlug, TDisableErrors>,\n init?: RequestInit,\n ): Promise<\n ApplyDisableErrors<TypeWithVersion<DataFromCollectionSlug<T, TSlug>>, TDisableErrors>\n > {\n return findVersionByID(this, options, init)\n }\n\n findVersions<TSlug extends CollectionSlug<T>>(\n options: FindVersionsOptions<T, TSlug>,\n init?: RequestInit,\n ): Promise<PaginatedDocs<TypeWithVersion<DataFromCollectionSlug<T, TSlug>>>> {\n return findVersions(this, options, init)\n }\n forgotPassword<TSlug extends AuthCollectionSlug<T>>(\n options: ForgotPasswordOptions<T, TSlug>,\n init?: RequestInit,\n ): Promise<{ message: string }> {\n return forgotPassword(this, options, init)\n }\n\n login<TSlug extends AuthCollectionSlug<T>>(\n options: LoginOptions<T, TSlug>,\n init?: RequestInit,\n ): Promise<LoginResult<T, TSlug>> {\n return login(this, options, init)\n }\n\n me<TSlug extends AuthCollectionSlug<T>>(\n options: MeOptions<T, TSlug>,\n init?: RequestInit,\n ): Promise<MeResult<T, TSlug>> {\n return me(this, options, init)\n }\n\n refreshToken<TSlug extends AuthCollectionSlug<T>>(\n options: RefreshOptions<T, TSlug>,\n init?: RequestInit,\n ): Promise<RefreshResult<T, TSlug>> {\n return refreshToken(this, options, init)\n }\n\n async request({\n args = {},\n file,\n init: incomingInit,\n json,\n method,\n path,\n }: {\n args?: OperationArgs\n file?: Blob\n init?: RequestInit\n json?: unknown\n method: 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT'\n path: string\n }): Promise<Response> {\n const headers = new Headers({ ...this.baseInit.headers, ...incomingInit?.headers })\n\n const init: RequestInit = {\n method,\n ...this.baseInit,\n ...incomingInit,\n headers,\n }\n\n if (json) {\n if (file) {\n const formData = new FormData()\n formData.append('file', file)\n formData.append('_payload', JSON.stringify(json))\n init.body = formData\n } else {\n headers.set('Content-Type', 'application/json')\n init.body = JSON.stringify(json)\n }\n }\n\n const response = await this.fetch(`${this.baseURL}${path}${buildSearchParams(args)}`, init)\n\n return response\n }\n\n resetPassword<TSlug extends AuthCollectionSlug<T>>(\n options: ResetPasswordOptions<T, TSlug>,\n init?: RequestInit,\n ): Promise<ResetPasswordResult<T, TSlug>> {\n return resetPassword(this, options, init)\n }\n\n restoreGlobalVersion<TSlug extends GlobalSlug<T>>(\n options: RestoreGlobalVersionByIDOptions<T, TSlug>,\n init?: RequestInit,\n ): Promise<TypeWithVersion<DataFromGlobalSlug<T, TSlug>>> {\n return restoreGlobalVersion(this, options, init)\n }\n\n restoreVersion<TSlug extends CollectionSlug<T>>(\n options: RestoreVersionByIDOptions<T, TSlug>,\n init?: RequestInit,\n ): Promise<DataFromCollectionSlug<T, TSlug>> {\n return restoreVersion(this, options, init)\n }\n\n update<TSlug extends CollectionSlug<T>, TSelect extends SelectFromCollectionSlug<T, TSlug>>(\n options: UpdateManyOptions<T, TSlug, TSelect>,\n init?: RequestInit,\n ): Promise<BulkOperationResult<T, TSlug, TSelect>>\n\n update<TSlug extends CollectionSlug<T>, TSelect extends SelectFromCollectionSlug<T, TSlug>>(\n options: UpdateByIDOptions<T, TSlug, TSelect>,\n init?: RequestInit,\n ): Promise<TransformCollectionWithSelect<T, TSlug, TSelect>>\n\n /**\n * @description Update one or more documents\n * @param options\n * @returns Updated document(s)\n */\n update<TSlug extends CollectionSlug<T>, TSelect extends SelectFromCollectionSlug<T, TSlug>>(\n options: UpdateOptions<T, TSlug, TSelect>,\n init?: RequestInit,\n ): Promise<\n BulkOperationResult<T, TSlug, TSelect> | TransformCollectionWithSelect<T, TSlug, TSelect>\n > {\n return update(this, options, init)\n }\n\n updateGlobal<TSlug extends GlobalSlug<T>, TSelect extends SelectFromGlobalSlug<T, TSlug>>(\n options: UpdateGlobalOptions<T, TSlug, TSelect>,\n init?: RequestInit,\n ): Promise<TransformGlobalWithSelect<T, TSlug, TSelect>> {\n return updateGlobal(this, options, init)\n }\n\n verifyEmail<TSlug extends AuthCollectionSlug<T>>(\n options: VerifyEmailOptions<T, TSlug>,\n init?: RequestInit,\n ): Promise<{ message: string }> {\n return verifyEmail(this, options, init)\n }\n}\n"],"names":["forgotPassword","login","me","refreshToken","resetPassword","verifyEmail","count","create","deleteOperation","find","findByID","findVersionByID","findVersions","restoreVersion","update","findGlobal","findGlobalVersionByID","findGlobalVersions","restoreGlobalVersion","updateGlobal","buildSearchParams","PayloadSDK","baseInit","baseURL","fetch","constructor","args","globalThis","options","init","delete","request","file","incomingInit","json","method","path","headers","Headers","formData","FormData","append","JSON","stringify","body","set","response"],"mappings":"AAiCA,SAASA,cAAc,QAAQ,2BAA0B;AACzD,SAASC,KAAK,QAAQ,kBAAiB;AACvC,SAASC,EAAE,QAAQ,eAAc;AACjC,SAAkDC,YAAY,QAAQ,yBAAwB;AAC9F,SAASC,aAAa,QAAQ,0BAAyB;AACvD,SAASC,WAAW,QAAiC,wBAAuB;AAC5E,SAASC,KAAK,QAAQ,yBAAwB;AAC9C,SAASC,MAAM,QAAQ,0BAAyB;AAChD,SAASC,eAAe,QAAQ,0BAAyB;AACzD,SAASC,IAAI,QAAQ,wBAAuB;AAC5C,SAASC,QAAQ,QAAQ,4BAA2B;AACpD,SAASC,eAAe,QAAQ,mCAAkC;AAClE,SAASC,YAAY,QAAQ,gCAA+B;AAC5D,SAASC,cAAc,QAAQ,kCAAiC;AAChE,SACEC,MAAM,QAID,0BAAyB;AAChC,SAASC,UAAU,QAAgC,uBAAsB;AACzE,SAASC,qBAAqB,QAAQ,+BAA8B;AACpE,SAASC,kBAAkB,QAAQ,4BAA2B;AAC9D,SAASC,oBAAoB,QAAQ,8BAA6B;AAClE,SAASC,YAAY,QAAQ,sBAAqB;AAClD,SAASC,iBAAiB,QAAQ,mCAAkC;AA+DpE;;CAEC,GACD,OAAO,MAAMC;IACXC,SAAqB;IAErBC,QAAe;IAEfC,MAAmB;IACnBC,YAAYC,IAAU,CAAE;QACtB,IAAI,CAACH,OAAO,GAAGG,KAAKH,OAAO;QAC3B,IAAI,CAACC,KAAK,GAAGE,KAAKF,KAAK,IAAIG,WAAWH,KAAK;QAC3C,IAAI,CAACF,QAAQ,GAAGI,KAAKJ,QAAQ,IAAI,CAAC;IACpC;IAEA;;;;GAIC,GACDhB,MACEsB,OAA+B,EAC/BC,IAAkB,EACc;QAChC,OAAOvB,MAAM,IAAI,EAAEsB,SAASC;IAC9B;IAEA;;;;GAIC,GACDtB,OACEqB,OAAyC,EACzCC,IAAkB,EACyC;QAC3D,OAAOtB,OAAO,IAAI,EAAEqB,SAASC;IAC/B;IAWA;;;;GAIC,GACDC,OACEF,OAAyC,EACzCC,IAAkB,EAGlB;QACA,OAAOrB,gBAAgB,IAAI,EAAEoB,SAASC;IACxC;IAEA;;;;GAIC,GACDpB,KACEmB,OAAuC,EACvCC,IAAkB,EACwD;QAC1E,OAAOpB,KAAK,IAAI,EAAEmB,SAASC;IAC7B;IAEA;;;;GAIC,GACDnB,SAKEkB,OAA2D,EAC3DC,IAAkB,EAC6E;QAC/F,OAAOnB,SAAS,IAAI,EAAEkB,SAASC;IACjC;IAEAd,WACEa,OAA6C,EAC7CC,IAAkB,EACqC;QACvD,OAAOd,WAAW,IAAI,EAAEa,SAASC;IACnC;IAEAb,sBACEY,OAA+D,EAC/DC,IAAkB,EAC0E;QAC5F,OAAOb,sBAAsB,IAAI,EAAEY,SAASC;IAC9C;IAEAZ,mBACEW,OAA4C,EAC5CC,IAAkB,EACqD;QACvE,OAAOZ,mBAAmB,IAAI,EAAEW,SAASC;IAC3C;IACAlB,gBACEiB,OAAyD,EACzDC,IAAkB,EAGlB;QACA,OAAOlB,gBAAgB,IAAI,EAAEiB,SAASC;IACxC;IAEAjB,aACEgB,OAAsC,EACtCC,IAAkB,EACyD;QAC3E,OAAOjB,aAAa,IAAI,EAAEgB,SAASC;IACrC;IACA7B,eACE4B,OAAwC,EACxCC,IAAkB,EACY;QAC9B,OAAO7B,eAAe,IAAI,EAAE4B,SAASC;IACvC;IAEA5B,MACE2B,OAA+B,EAC/BC,IAAkB,EACc;QAChC,OAAO5B,MAAM,IAAI,EAAE2B,SAASC;IAC9B;IAEA3B,GACE0B,OAA4B,EAC5BC,IAAkB,EACW;QAC7B,OAAO3B,GAAG,IAAI,EAAE0B,SAASC;IAC3B;IAEA1B,aACEyB,OAAiC,EACjCC,IAAkB,EACgB;QAClC,OAAO1B,aAAa,IAAI,EAAEyB,SAASC;IACrC;IAEA,MAAME,QAAQ,EACZL,OAAO,CAAC,CAAC,EACTM,IAAI,EACJH,MAAMI,YAAY,EAClBC,IAAI,EACJC,MAAM,EACNC,IAAI,EAQL,EAAqB;QACpB,MAAMC,UAAU,IAAIC,QAAQ;YAAE,GAAG,IAAI,CAAChB,QAAQ,CAACe,OAAO;YAAE,GAAGJ,cAAcI,OAAO;QAAC;QAEjF,MAAMR,OAAoB;YACxBM;YACA,GAAG,IAAI,CAACb,QAAQ;YAChB,GAAGW,YAAY;YACfI;QACF;QAEA,IAAIH,MAAM;YACR,IAAIF,MAAM;gBACR,MAAMO,WAAW,IAAIC;gBACrBD,SAASE,MAAM,CAAC,QAAQT;gBACxBO,SAASE,MAAM,CAAC,YAAYC,KAAKC,SAAS,CAACT;gBAC3CL,KAAKe,IAAI,GAAGL;YACd,OAAO;gBACLF,QAAQQ,GAAG,CAAC,gBAAgB;gBAC5BhB,KAAKe,IAAI,GAAGF,KAAKC,SAAS,CAACT;YAC7B;QACF;QAEA,MAAMY,WAAW,MAAM,IAAI,CAACtB,KAAK,CAAC,GAAG,IAAI,CAACD,OAAO,GAAGa,OAAOhB,kBAAkBM,OAAO,EAAEG;QAEtF,OAAOiB;IACT;IAEA1C,cACEwB,OAAuC,EACvCC,IAAkB,EACsB;QACxC,OAAOzB,cAAc,IAAI,EAAEwB,SAASC;IACtC;IAEAX,qBACEU,OAAkD,EAClDC,IAAkB,EACsC;QACxD,OAAOX,qBAAqB,IAAI,EAAEU,SAASC;IAC7C;IAEAhB,eACEe,OAA4C,EAC5CC,IAAkB,EACyB;QAC3C,OAAOhB,eAAe,IAAI,EAAEe,SAASC;IACvC;IAYA;;;;GAIC,GACDf,OACEc,OAAyC,EACzCC,IAAkB,EAGlB;QACA,OAAOf,OAAO,IAAI,EAAEc,SAASC;IAC/B;IAEAV,aACES,OAA+C,EAC/CC,IAAkB,EACqC;QACvD,OAAOV,aAAa,IAAI,EAAES,SAASC;IACrC;IAEAxB,YACEuB,OAAqC,EACrCC,IAAkB,EACY;QAC9B,OAAOxB,YAAY,IAAI,EAAEuB,SAASC;IACpC;AACF"}
|
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import type { JsonObject, SelectType, Sort, StringKeyOf, TransformDataWithSelect, TypeWithID, Where } from 'payload';
|
|
2
|
+
import type { MarkOptional, NonNever } from 'ts-essentials';
|
|
3
|
+
export interface PayloadGeneratedTypes {
|
|
4
|
+
auth: {
|
|
5
|
+
[slug: string]: {
|
|
6
|
+
forgotPassword: {
|
|
7
|
+
email: string;
|
|
8
|
+
};
|
|
9
|
+
login: {
|
|
10
|
+
email: string;
|
|
11
|
+
password: string;
|
|
12
|
+
};
|
|
13
|
+
registerFirstUser: {
|
|
14
|
+
email: string;
|
|
15
|
+
password: string;
|
|
16
|
+
};
|
|
17
|
+
unlock: {
|
|
18
|
+
email: string;
|
|
19
|
+
};
|
|
20
|
+
};
|
|
21
|
+
};
|
|
22
|
+
collections: {
|
|
23
|
+
[slug: string]: JsonObject & TypeWithID;
|
|
24
|
+
};
|
|
25
|
+
collectionsJoins: {
|
|
26
|
+
[slug: string]: {
|
|
27
|
+
[schemaPath: string]: string;
|
|
28
|
+
};
|
|
29
|
+
};
|
|
30
|
+
collectionsSelect: {
|
|
31
|
+
[slug: string]: any;
|
|
32
|
+
};
|
|
33
|
+
db: {
|
|
34
|
+
defaultIDType: number | string;
|
|
35
|
+
};
|
|
36
|
+
globals: {
|
|
37
|
+
[slug: string]: JsonObject;
|
|
38
|
+
};
|
|
39
|
+
globalsSelect: {
|
|
40
|
+
[slug: string]: any;
|
|
41
|
+
};
|
|
42
|
+
locale: null | string;
|
|
43
|
+
}
|
|
44
|
+
export type TypedCollection<T extends PayloadGeneratedTypes> = T['collections'];
|
|
45
|
+
export type TypedGlobal<T extends PayloadGeneratedTypes> = T['globals'];
|
|
46
|
+
export type TypedCollectionSelect<T extends PayloadGeneratedTypes> = T['collectionsSelect'];
|
|
47
|
+
export type TypedCollectionJoins<T extends PayloadGeneratedTypes> = T['collectionsJoins'];
|
|
48
|
+
export type TypedGlobalSelect<T extends PayloadGeneratedTypes> = T['globalsSelect'];
|
|
49
|
+
export type TypedAuth<T extends PayloadGeneratedTypes> = T['auth'];
|
|
50
|
+
export type CollectionSlug<T extends PayloadGeneratedTypes> = StringKeyOf<TypedCollection<T>>;
|
|
51
|
+
export type GlobalSlug<T extends PayloadGeneratedTypes> = StringKeyOf<TypedGlobal<T>>;
|
|
52
|
+
export type AuthCollectionSlug<T extends PayloadGeneratedTypes> = StringKeyOf<TypedAuth<T>>;
|
|
53
|
+
export type TypedUploadCollection<T extends PayloadGeneratedTypes> = NonNever<{
|
|
54
|
+
[K in keyof TypedCollection<T>]: 'filename' | 'filesize' | 'mimeType' | 'url' extends keyof TypedCollection<T>[K] ? TypedCollection<T>[K] : never;
|
|
55
|
+
}>;
|
|
56
|
+
export type UploadCollectionSlug<T extends PayloadGeneratedTypes> = StringKeyOf<TypedUploadCollection<T>>;
|
|
57
|
+
export type DataFromCollectionSlug<T extends PayloadGeneratedTypes, TSlug extends CollectionSlug<T>> = TypedCollection<T>[TSlug];
|
|
58
|
+
export type DataFromGlobalSlug<T extends PayloadGeneratedTypes, TSlug extends GlobalSlug<T>> = TypedGlobal<T>[TSlug];
|
|
59
|
+
export type SelectFromCollectionSlug<T extends PayloadGeneratedTypes, TSlug extends CollectionSlug<T>> = TypedCollectionSelect<T>[TSlug];
|
|
60
|
+
export type SelectFromGlobalSlug<T extends PayloadGeneratedTypes, TSlug extends GlobalSlug<T>> = TypedGlobalSelect<T>[TSlug];
|
|
61
|
+
export type TransformCollectionWithSelect<T extends PayloadGeneratedTypes, TSlug extends CollectionSlug<T>, TSelect extends SelectType> = TSelect extends SelectType ? TransformDataWithSelect<DataFromCollectionSlug<T, TSlug>, TSelect> : DataFromCollectionSlug<T, TSlug>;
|
|
62
|
+
export type TransformGlobalWithSelect<T extends PayloadGeneratedTypes, TSlug extends GlobalSlug<T>, TSelect extends SelectType> = TSelect extends SelectType ? TransformDataWithSelect<DataFromGlobalSlug<T, TSlug>, TSelect> : DataFromGlobalSlug<T, TSlug>;
|
|
63
|
+
export type RequiredDataFromCollection<TData extends JsonObject> = MarkOptional<TData, 'createdAt' | 'id' | 'sizes' | 'updatedAt'>;
|
|
64
|
+
export type RequiredDataFromCollectionSlug<T extends PayloadGeneratedTypes, TSlug extends CollectionSlug<T>> = RequiredDataFromCollection<DataFromCollectionSlug<T, TSlug>>;
|
|
65
|
+
export type TypedLocale<T extends PayloadGeneratedTypes> = NonNullable<T['locale']>;
|
|
66
|
+
export type JoinQuery<T extends PayloadGeneratedTypes, TSlug extends CollectionSlug<T>> = TypedCollectionJoins<T>[TSlug] extends Record<string, string> ? false | Partial<{
|
|
67
|
+
[K in keyof TypedCollectionJoins<T>[TSlug]]: {
|
|
68
|
+
count?: boolean;
|
|
69
|
+
limit?: number;
|
|
70
|
+
page?: number;
|
|
71
|
+
sort?: Sort;
|
|
72
|
+
where?: Where;
|
|
73
|
+
} | false;
|
|
74
|
+
}> : never;
|
|
75
|
+
export type PopulateType<T extends PayloadGeneratedTypes> = Partial<TypedCollectionSelect<T>>;
|
|
76
|
+
export type IDType<T extends PayloadGeneratedTypes, TSlug extends CollectionSlug<T>> = DataFromCollectionSlug<T, TSlug>['id'];
|
|
77
|
+
export type BulkOperationResult<T extends PayloadGeneratedTypes, TSlug extends CollectionSlug<T>, TSelect extends SelectType> = {
|
|
78
|
+
docs: TransformCollectionWithSelect<T, TSlug, TSelect>[];
|
|
79
|
+
errors: {
|
|
80
|
+
id: DataFromCollectionSlug<T, TSlug>['id'];
|
|
81
|
+
message: string;
|
|
82
|
+
}[];
|
|
83
|
+
};
|
|
84
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,UAAU,EACV,IAAI,EACJ,WAAW,EACX,uBAAuB,EACvB,UAAU,EACV,KAAK,EACN,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAE3D,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE;QACJ,CAAC,IAAI,EAAE,MAAM,GAAG;YACd,cAAc,EAAE;gBACd,KAAK,EAAE,MAAM,CAAA;aACd,CAAA;YACD,KAAK,EAAE;gBACL,KAAK,EAAE,MAAM,CAAA;gBACb,QAAQ,EAAE,MAAM,CAAA;aACjB,CAAA;YACD,iBAAiB,EAAE;gBACjB,KAAK,EAAE,MAAM,CAAA;gBACb,QAAQ,EAAE,MAAM,CAAA;aACjB,CAAA;YACD,MAAM,EAAE;gBACN,KAAK,EAAE,MAAM,CAAA;aACd,CAAA;SACF,CAAA;KACF,CAAA;IAED,WAAW,EAAE;QACX,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,UAAU,CAAA;KACxC,CAAA;IACD,gBAAgB,EAAE;QAChB,CAAC,IAAI,EAAE,MAAM,GAAG;YACd,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAAA;SAC7B,CAAA;KACF,CAAA;IAED,iBAAiB,EAAE;QACjB,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAA;KACpB,CAAA;IACD,EAAE,EAAE;QACF,aAAa,EAAE,MAAM,GAAG,MAAM,CAAA;KAC/B,CAAA;IACD,OAAO,EAAE;QACP,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAA;KAC3B,CAAA;IAED,aAAa,EAAE;QACb,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAA;KACpB,CAAA;IAED,MAAM,EAAE,IAAI,GAAG,MAAM,CAAA;CACtB;AAED,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,qBAAqB,IAAI,CAAC,CAAC,aAAa,CAAC,CAAA;AAE/E,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,qBAAqB,IAAI,CAAC,CAAC,SAAS,CAAC,CAAA;AAEvE,MAAM,MAAM,qBAAqB,CAAC,CAAC,SAAS,qBAAqB,IAAI,CAAC,CAAC,mBAAmB,CAAC,CAAA;AAE3F,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,qBAAqB,IAAI,CAAC,CAAC,kBAAkB,CAAC,CAAA;AAEzF,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,qBAAqB,IAAI,CAAC,CAAC,eAAe,CAAC,CAAA;AAEnF,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,qBAAqB,IAAI,CAAC,CAAC,MAAM,CAAC,CAAA;AAElE,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,qBAAqB,IAAI,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;AAE7F,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,qBAAqB,IAAI,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;AAErF,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,qBAAqB,IAAI,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;AAE3F,MAAM,MAAM,qBAAqB,CAAC,CAAC,SAAS,qBAAqB,IAAI,QAAQ,CAAC;KAC3E,CAAC,IAAI,MAAM,eAAe,CAAC,CAAC,CAAC,GAC1B,UAAU,GACV,UAAU,GACV,UAAU,GACV,KAAK,SAAS,MAAM,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACzC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACrB,KAAK;CACV,CAAC,CAAA;AAEF,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,qBAAqB,IAAI,WAAW,CAC7E,qBAAqB,CAAC,CAAC,CAAC,CACzB,CAAA;AAED,MAAM,MAAM,sBAAsB,CAChC,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,IAC7B,eAAe,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;AAE7B,MAAM,MAAM,kBAAkB,CAC5B,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,UAAU,CAAC,CAAC,CAAC,IACzB,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;AAEzB,MAAM,MAAM,wBAAwB,CAClC,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,IAC7B,qBAAqB,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;AAEnC,MAAM,MAAM,oBAAoB,CAC9B,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,UAAU,CAAC,CAAC,CAAC,IACzB,iBAAiB,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;AAE/B,MAAM,MAAM,6BAA6B,CACvC,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAC/B,OAAO,SAAS,UAAU,IACxB,OAAO,SAAS,UAAU,GAC1B,uBAAuB,CAAC,sBAAsB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,OAAO,CAAC,GAClE,sBAAsB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;AAEpC,MAAM,MAAM,yBAAyB,CACnC,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,UAAU,CAAC,CAAC,CAAC,EAC3B,OAAO,SAAS,UAAU,IACxB,OAAO,SAAS,UAAU,GAC1B,uBAAuB,CAAC,kBAAkB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,OAAO,CAAC,GAC9D,kBAAkB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;AAEhC,MAAM,MAAM,0BAA0B,CAAC,KAAK,SAAS,UAAU,IAAI,YAAY,CAC7E,KAAK,EACL,WAAW,GAAG,IAAI,GAAG,OAAO,GAAG,WAAW,CAC3C,CAAA;AAED,MAAM,MAAM,8BAA8B,CACxC,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,IAC7B,0BAA0B,CAAC,sBAAsB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA;AAEhE,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,qBAAqB,IAAI,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEnF,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,qBAAqB,EAAE,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,IACpF,oBAAoB,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAErD,KAAK,GACL,OAAO,CAAC;KACL,CAAC,IAAI,MAAM,oBAAoB,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GACtC;QACE,KAAK,CAAC,EAAE,OAAO,CAAA;QACf,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,IAAI,CAAA;QACX,KAAK,CAAC,EAAE,KAAK,CAAA;KACd,GACD,KAAK;CACV,CAAC,GACN,KAAK,CAAA;AAEX,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,qBAAqB,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAA;AAE7F,MAAM,MAAM,MAAM,CAChB,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,IAC7B,sBAAsB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,CAAA;AAE1C,MAAM,MAAM,mBAAmB,CAC7B,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAC/B,OAAO,SAAS,UAAU,IACxB;IACF,IAAI,EAAE,6BAA6B,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,CAAA;IACxD,MAAM,EAAE;QACN,EAAE,EAAE,sBAAsB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,CAAA;QAC1C,OAAO,EAAE,MAAM,CAAA;KAChB,EAAE,CAAA;CACJ,CAAA"}
|
package/dist/types.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/types.ts"],"sourcesContent":["import type {\n JsonObject,\n SelectType,\n Sort,\n StringKeyOf,\n TransformDataWithSelect,\n TypeWithID,\n Where,\n} from 'payload'\nimport type { MarkOptional, NonNever } from 'ts-essentials'\n\nexport interface PayloadGeneratedTypes {\n auth: {\n [slug: string]: {\n forgotPassword: {\n email: string\n }\n login: {\n email: string\n password: string\n }\n registerFirstUser: {\n email: string\n password: string\n }\n unlock: {\n email: string\n }\n }\n }\n\n collections: {\n [slug: string]: JsonObject & TypeWithID\n }\n collectionsJoins: {\n [slug: string]: {\n [schemaPath: string]: string\n }\n }\n\n collectionsSelect: {\n [slug: string]: any\n }\n db: {\n defaultIDType: number | string\n }\n globals: {\n [slug: string]: JsonObject\n }\n\n globalsSelect: {\n [slug: string]: any\n }\n\n locale: null | string\n}\n\nexport type TypedCollection<T extends PayloadGeneratedTypes> = T['collections']\n\nexport type TypedGlobal<T extends PayloadGeneratedTypes> = T['globals']\n\nexport type TypedCollectionSelect<T extends PayloadGeneratedTypes> = T['collectionsSelect']\n\nexport type TypedCollectionJoins<T extends PayloadGeneratedTypes> = T['collectionsJoins']\n\nexport type TypedGlobalSelect<T extends PayloadGeneratedTypes> = T['globalsSelect']\n\nexport type TypedAuth<T extends PayloadGeneratedTypes> = T['auth']\n\nexport type CollectionSlug<T extends PayloadGeneratedTypes> = StringKeyOf<TypedCollection<T>>\n\nexport type GlobalSlug<T extends PayloadGeneratedTypes> = StringKeyOf<TypedGlobal<T>>\n\nexport type AuthCollectionSlug<T extends PayloadGeneratedTypes> = StringKeyOf<TypedAuth<T>>\n\nexport type TypedUploadCollection<T extends PayloadGeneratedTypes> = NonNever<{\n [K in keyof TypedCollection<T>]:\n | 'filename'\n | 'filesize'\n | 'mimeType'\n | 'url' extends keyof TypedCollection<T>[K]\n ? TypedCollection<T>[K]\n : never\n}>\n\nexport type UploadCollectionSlug<T extends PayloadGeneratedTypes> = StringKeyOf<\n TypedUploadCollection<T>\n>\n\nexport type DataFromCollectionSlug<\n T extends PayloadGeneratedTypes,\n TSlug extends CollectionSlug<T>,\n> = TypedCollection<T>[TSlug]\n\nexport type DataFromGlobalSlug<\n T extends PayloadGeneratedTypes,\n TSlug extends GlobalSlug<T>,\n> = TypedGlobal<T>[TSlug]\n\nexport type SelectFromCollectionSlug<\n T extends PayloadGeneratedTypes,\n TSlug extends CollectionSlug<T>,\n> = TypedCollectionSelect<T>[TSlug]\n\nexport type SelectFromGlobalSlug<\n T extends PayloadGeneratedTypes,\n TSlug extends GlobalSlug<T>,\n> = TypedGlobalSelect<T>[TSlug]\n\nexport type TransformCollectionWithSelect<\n T extends PayloadGeneratedTypes,\n TSlug extends CollectionSlug<T>,\n TSelect extends SelectType,\n> = TSelect extends SelectType\n ? TransformDataWithSelect<DataFromCollectionSlug<T, TSlug>, TSelect>\n : DataFromCollectionSlug<T, TSlug>\n\nexport type TransformGlobalWithSelect<\n T extends PayloadGeneratedTypes,\n TSlug extends GlobalSlug<T>,\n TSelect extends SelectType,\n> = TSelect extends SelectType\n ? TransformDataWithSelect<DataFromGlobalSlug<T, TSlug>, TSelect>\n : DataFromGlobalSlug<T, TSlug>\n\nexport type RequiredDataFromCollection<TData extends JsonObject> = MarkOptional<\n TData,\n 'createdAt' | 'id' | 'sizes' | 'updatedAt'\n>\n\nexport type RequiredDataFromCollectionSlug<\n T extends PayloadGeneratedTypes,\n TSlug extends CollectionSlug<T>,\n> = RequiredDataFromCollection<DataFromCollectionSlug<T, TSlug>>\n\nexport type TypedLocale<T extends PayloadGeneratedTypes> = NonNullable<T['locale']>\n\nexport type JoinQuery<T extends PayloadGeneratedTypes, TSlug extends CollectionSlug<T>> =\n TypedCollectionJoins<T>[TSlug] extends Record<string, string>\n ?\n | false\n | Partial<{\n [K in keyof TypedCollectionJoins<T>[TSlug]]:\n | {\n count?: boolean\n limit?: number\n page?: number\n sort?: Sort\n where?: Where\n }\n | false\n }>\n : never\n\nexport type PopulateType<T extends PayloadGeneratedTypes> = Partial<TypedCollectionSelect<T>>\n\nexport type IDType<\n T extends PayloadGeneratedTypes,\n TSlug extends CollectionSlug<T>,\n> = DataFromCollectionSlug<T, TSlug>['id']\n\nexport type BulkOperationResult<\n T extends PayloadGeneratedTypes,\n TSlug extends CollectionSlug<T>,\n TSelect extends SelectType,\n> = {\n docs: TransformCollectionWithSelect<T, TSlug, TSelect>[]\n errors: {\n id: DataFromCollectionSlug<T, TSlug>['id']\n message: string\n }[]\n}\n"],"names":[],"mappings":"AAiKA,WAUC"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { SelectType, Sort, Where } from 'payload';
|
|
2
|
+
export type OperationArgs = {
|
|
3
|
+
depth?: number;
|
|
4
|
+
draft?: boolean;
|
|
5
|
+
fallbackLocale?: false | string;
|
|
6
|
+
joins?: false | Record<string, unknown>;
|
|
7
|
+
limit?: number;
|
|
8
|
+
locale?: string;
|
|
9
|
+
page?: number;
|
|
10
|
+
populate?: Record<string, unknown>;
|
|
11
|
+
select?: SelectType;
|
|
12
|
+
sort?: Sort;
|
|
13
|
+
where?: Where;
|
|
14
|
+
};
|
|
15
|
+
export declare const buildSearchParams: (args: OperationArgs) => string;
|
|
16
|
+
//# sourceMappingURL=buildSearchParams.d.ts.map
|