@payloadcms/sdk 0.0.1-beta.0

package/dist/collections/findByID.js

@@ -0,0 +1,23 @@
+export async function findByID(sdk, options, init) {
+    try {
+        const response = await sdk.request({
+            args: options,
+            init,
+            method: 'GET',
+            path: `/${options.collection}/${options.id}`
+        });
+        if (response.ok) {
+            return response.json();
+        } else {
+            throw new Error();
+        }
+    } catch  {
+        if (options.disableErrors) {
+            // @ts-expect-error generic nullable
+            return null;
+        }
+        throw new Error(`Error retrieving the document ${options.collection}/${options.id}`);
+    }
+}
+
+//# sourceMappingURL=findByID.js.map

package/dist/collections/findByID.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/collections/findByID.ts"],"sourcesContent":["import type { ApplyDisableErrors, SelectType } from 'payload'\n\nimport type { PayloadSDK } from '../index.js'\nimport type {\n  CollectionSlug,\n  JoinQuery,\n  PayloadGeneratedTypes,\n  PopulateType,\n  TransformCollectionWithSelect,\n  TypedLocale,\n} from '../types.js'\n\nexport type FindByIDOptions<\n  T extends PayloadGeneratedTypes,\n  TSlug extends CollectionSlug<T>,\n  TDisableErrors extends boolean,\n  TSelect extends SelectType,\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   * Specify [select](https://payloadcms.com/docs/queries/select) to control which fields to include to the result.\n   */\n  select?: TSelect\n}\n\nexport async function findByID<\n  T extends PayloadGeneratedTypes,\n  TSlug extends CollectionSlug<T>,\n  TDisableErrors extends boolean,\n  TSelect extends SelectType,\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    if (response.ok) {\n      return response.json()\n    } else {\n      throw new Error()\n    }\n  } catch {\n    if (options.disableErrors) {\n      // @ts-expect-error generic nullable\n      return null\n    }\n\n    throw new Error(`Error retrieving the document ${options.collection}/${options.id}`)\n  }\n}\n"],"names":["findByID","sdk","options","init","response","request","args","method","path","collection","id","ok","json","Error","disableErrors"],"mappings":"AA8DA,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,IAAIN,SAASO,EAAE,EAAE;YACf,OAAOP,SAASQ,IAAI;QACtB,OAAO;YACL,MAAM,IAAIC;QACZ;IACF,EAAE,OAAM;QACN,IAAIX,QAAQY,aAAa,EAAE;YACzB,oCAAoC;YACpC,OAAO;QACT;QAEA,MAAM,IAAID,MAAM,CAAC,8BAA8B,EAAEX,QAAQO,UAAU,CAAC,CAAC,EAAEP,QAAQQ,EAAE,EAAE;IACrF;AACF"}

package/dist/collections/findVersionByID.d.ts

@@ -0,0 +1,53 @@
+import type { ApplyDisableErrors, SelectType, TypeWithVersion } from 'payload';
+import type { PayloadSDK } from '../index.js';
+import type { CollectionSlug, DataFromCollectionSlug, PayloadGeneratedTypes, PopulateType, TypedLocale } from '../types.js';
+export type FindVersionByIDOptions<T extends PayloadGeneratedTypes, TSlug extends CollectionSlug<T>, TDisableErrors extends boolean> = {
+    /**
+     * the Collection slug to operate against.
+     */
+    collection: TSlug;
+    /**
+     * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.
+     */
+    depth?: number;
+    /**
+     * When set to `true`, errors will not be thrown.
+     * `null` will be returned instead, if the document on this ID was not found.
+     */
+    disableErrors?: TDisableErrors;
+    /**
+     * Whether the document should be queried from the versions table/collection or not. [More](https://payloadcms.com/docs/versions/drafts#draft-api)
+     */
+    draft?: boolean;
+    /**
+     * Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.
+     */
+    fallbackLocale?: false | TypedLocale<T>;
+    /**
+     * The ID of the version to find.
+     */
+    id: number | string;
+    /**
+     * Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.
+     */
+    locale?: 'all' | TypedLocale<T>;
+    /**
+     * Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.
+     */
+    populate?: PopulateType<T>;
+    /**
+     * Specify [select](https://payloadcms.com/docs/queries/select) to control which fields to include to the result.
+     */
+    select?: SelectType;
+    /**
+     * When set to `true`, the operation will return a document by ID, even if it is trashed (soft-deleted).
+     * By default (`false`), the operation will exclude trashed documents.
+     * To fetch a trashed document, set `trash: true`.
+     *
+     * This argument has no effect unless `trash` is enabled on the collection.
+     * @default false
+     */
+    trash?: boolean;
+};
+export declare function findVersionByID<T extends PayloadGeneratedTypes, TSlug extends CollectionSlug<T>, TDisableErrors extends boolean>(sdk: PayloadSDK<T>, options: FindVersionByIDOptions<T, TSlug, TDisableErrors>, init?: RequestInit): Promise<ApplyDisableErrors<TypeWithVersion<DataFromCollectionSlug<T, TSlug>>, TDisableErrors>>;
+//# sourceMappingURL=findVersionByID.d.ts.map

package/dist/collections/findVersionByID.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findVersionByID.d.ts","sourceRoot":"","sources":["../../src/collections/findVersionByID.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAE9E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EACV,cAAc,EACd,sBAAsB,EACtB,qBAAqB,EACrB,YAAY,EACZ,WAAW,EACZ,MAAM,aAAa,CAAA;AAEpB,MAAM,MAAM,sBAAsB,CAChC,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAC/B,cAAc,SAAS,OAAO,IAC5B;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;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,wBAAsB,eAAe,CACnC,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAC/B,cAAc,SAAS,OAAO,EAE9B,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,EAClB,OAAO,EAAE,sBAAsB,CAAC,CAAC,EAAE,KAAK,EAAE,cAAc,CAAC,EACzD,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,kBAAkB,CAAC,eAAe,CAAC,sBAAsB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,CAsBhG"}

package/dist/collections/findVersionByID.js

@@ -0,0 +1,23 @@
+export async function findVersionByID(sdk, options, init) {
+    try {
+        const response = await sdk.request({
+            args: options,
+            init,
+            method: 'GET',
+            path: `/${options.collection}/versions/${options.id}`
+        });
+        if (response.ok) {
+            return response.json();
+        } else {
+            throw new Error();
+        }
+    } catch  {
+        if (options.disableErrors) {
+            // @ts-expect-error generic nullable
+            return null;
+        }
+        throw new Error(`Error retrieving the version document ${options.collection}/${options.id}`);
+    }
+}
+
+//# sourceMappingURL=findVersionByID.js.map

package/dist/collections/findVersionByID.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/collections/findVersionByID.ts"],"sourcesContent":["import type { ApplyDisableErrors, SelectType, TypeWithVersion } from 'payload'\n\nimport type { PayloadSDK } from '../index.js'\nimport type {\n  CollectionSlug,\n  DataFromCollectionSlug,\n  PayloadGeneratedTypes,\n  PopulateType,\n  TypedLocale,\n} from '../types.js'\n\nexport type FindVersionByIDOptions<\n  T extends PayloadGeneratedTypes,\n  TSlug extends CollectionSlug<T>,\n  TDisableErrors extends boolean,\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 version to find.\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   * Specify [select](https://payloadcms.com/docs/queries/select) to control which fields to include to the result.\n   */\n  select?: SelectType\n  /**\n   * When set to `true`, the operation will return a document by ID, even if it is trashed (soft-deleted).\n   * By default (`false`), the operation will exclude trashed documents.\n   * To fetch a trashed document, set `trash: true`.\n   *\n   * This argument has no effect unless `trash` is enabled on the collection.\n   * @default false\n   */\n  trash?: boolean\n}\n\nexport async function findVersionByID<\n  T extends PayloadGeneratedTypes,\n  TSlug extends CollectionSlug<T>,\n  TDisableErrors extends boolean,\n>(\n  sdk: PayloadSDK<T>,\n  options: FindVersionByIDOptions<T, TSlug, TDisableErrors>,\n  init?: RequestInit,\n): Promise<ApplyDisableErrors<TypeWithVersion<DataFromCollectionSlug<T, TSlug>>, TDisableErrors>> {\n  try {\n    const response = await sdk.request({\n      args: options,\n      init,\n      method: 'GET',\n      path: `/${options.collection}/versions/${options.id}`,\n    })\n\n    if (response.ok) {\n      return response.json()\n    } else {\n      throw new Error()\n    }\n  } catch {\n    if (options.disableErrors) {\n      // @ts-expect-error generic nullable\n      return null\n    }\n\n    throw new Error(`Error retrieving the version document ${options.collection}/${options.id}`)\n  }\n}\n"],"names":["findVersionByID","sdk","options","init","response","request","args","method","path","collection","id","ok","json","Error","disableErrors"],"mappings":"AAgEA,OAAO,eAAeA,gBAKpBC,GAAkB,EAClBC,OAAyD,EACzDC,IAAkB;IAElB,IAAI;QACF,MAAMC,WAAW,MAAMH,IAAII,OAAO,CAAC;YACjCC,MAAMJ;YACNC;YACAI,QAAQ;YACRC,MAAM,CAAC,CAAC,EAAEN,QAAQO,UAAU,CAAC,UAAU,EAAEP,QAAQQ,EAAE,EAAE;QACvD;QAEA,IAAIN,SAASO,EAAE,EAAE;YACf,OAAOP,SAASQ,IAAI;QACtB,OAAO;YACL,MAAM,IAAIC;QACZ;IACF,EAAE,OAAM;QACN,IAAIX,QAAQY,aAAa,EAAE;YACzB,oCAAoC;YACpC,OAAO;QACT;QAEA,MAAM,IAAID,MAAM,CAAC,sCAAsC,EAAEX,QAAQO,UAAU,CAAC,CAAC,EAAEP,QAAQQ,EAAE,EAAE;IAC7F;AACF"}

package/dist/collections/findVersions.d.ts

@@ -0,0 +1,70 @@
+import type { PaginatedDocs, SelectType, Sort, TypeWithVersion, Where } from 'payload';
+import type { PayloadSDK } from '../index.js';
+import type { CollectionSlug, DataFromCollectionSlug, PayloadGeneratedTypes, PopulateType, TypedLocale } from '../types.js';
+export type FindVersionsOptions<T extends PayloadGeneratedTypes, TSlug extends CollectionSlug<T>> = {
+    /**
+     * the Collection slug to operate against.
+     */
+    collection: TSlug;
+    /**
+     * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.
+     */
+    depth?: number;
+    /**
+     * Whether the documents should be queried from the versions table/collection or not. [More](https://payloadcms.com/docs/versions/drafts#draft-api)
+     */
+    draft?: boolean;
+    /**
+     * Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.
+     */
+    fallbackLocale?: false | TypedLocale<T>;
+    /**
+     * The maximum related documents to be returned.
+     * Defaults unless `defaultLimit` is specified for the collection config
+     * @default 10
+     */
+    limit?: number;
+    /**
+     * Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.
+     */
+    locale?: 'all' | TypedLocale<T>;
+    /**
+     * Get a specific page number
+     * @default 1
+     */
+    page?: number;
+    /**
+     * Set to `false` to return all documents and avoid querying for document counts which introduces some overhead.
+     * You can also combine that property with a specified `limit` to limit documents but avoid the count query.
+     */
+    pagination?: boolean;
+    /**
+     * Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.
+     */
+    populate?: PopulateType<T>;
+    /**
+     * Specify [select](https://payloadcms.com/docs/queries/select) to control which fields to include to the result.
+     */
+    select?: SelectType;
+    /**
+     * Sort the documents, can be a string or an array of strings
+     * @example '-version.createdAt' // Sort DESC by createdAt
+     * @example ['version.group', '-version.createdAt'] // sort by 2 fields, ASC group and DESC createdAt
+     */
+    sort?: Sort;
+    /**
+     * When set to `true`, the query will include both normal and trashed (soft-deleted) documents.
+     * To query only trashed documents, pass `trash: true` and combine with a `where` clause filtering by `deletedAt`.
+     * By default (`false`), the query will only include normal documents and exclude those with a `deletedAt` field.
+     *
+     * This argument has no effect unless `trash` is enabled on the collection.
+     * @default false
+     */
+    trash?: boolean;
+    /**
+     * A filter [query](https://payloadcms.com/docs/queries/overview)
+     */
+    where?: Where;
+};
+export declare function findVersions<T extends PayloadGeneratedTypes, TSlug extends CollectionSlug<T>>(sdk: PayloadSDK<T>, options: FindVersionsOptions<T, TSlug>, init?: RequestInit): Promise<PaginatedDocs<TypeWithVersion<DataFromCollectionSlug<T, TSlug>>>>;
+//# sourceMappingURL=findVersions.d.ts.map

package/dist/collections/findVersions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findVersions.d.ts","sourceRoot":"","sources":["../../src/collections/findVersions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAEtF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EACV,cAAc,EACd,sBAAsB,EACtB,qBAAqB,EACrB,YAAY,EACZ,WAAW,EACZ,MAAM,aAAa,CAAA;AAEpB,MAAM,MAAM,mBAAmB,CAC7B,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,IAC7B;IACF;;OAEG;IACH,UAAU,EAAE,KAAK,CAAA;IACjB;;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;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;IAC/B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB;;;;OAIG;IACH,IAAI,CAAC,EAAE,IAAI,CAAA;IACX;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,CAAA;AAED,wBAAsB,YAAY,CAChC,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAE/B,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,EAClB,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,CAS3E"}

package/dist/collections/findVersions.js

@@ -0,0 +1,11 @@
+export async function findVersions(sdk, options, init) {
+    const response = await sdk.request({
+        args: options,
+        init,
+        method: 'GET',
+        path: `/${options.collection}/versions`
+    });
+    return response.json();
+}
+
+//# sourceMappingURL=findVersions.js.map

package/dist/collections/findVersions.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/collections/findVersions.ts"],"sourcesContent":["import type { PaginatedDocs, SelectType, Sort, TypeWithVersion, Where } from 'payload'\n\nimport type { PayloadSDK } from '../index.js'\nimport type {\n  CollectionSlug,\n  DataFromCollectionSlug,\n  PayloadGeneratedTypes,\n  PopulateType,\n  TypedLocale,\n} from '../types.js'\n\nexport type FindVersionsOptions<\n  T extends PayloadGeneratedTypes,\n  TSlug extends CollectionSlug<T>,\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   * Whether the documents 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 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   * 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   * When set to `true`, the query will include both normal and trashed (soft-deleted) documents.\n   * To query only trashed documents, pass `trash: true` and combine with a `where` clause filtering by `deletedAt`.\n   * By default (`false`), the query will only include normal documents and exclude those with a `deletedAt` field.\n   *\n   * This argument has no effect unless `trash` is enabled on the collection.\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 findVersions<\n  T extends PayloadGeneratedTypes,\n  TSlug extends CollectionSlug<T>,\n>(\n  sdk: PayloadSDK<T>,\n  options: FindVersionsOptions<T, TSlug>,\n  init?: RequestInit,\n): Promise<PaginatedDocs<TypeWithVersion<DataFromCollectionSlug<T, TSlug>>>> {\n  const response = await sdk.request({\n    args: options,\n    init,\n    method: 'GET',\n    path: `/${options.collection}/versions`,\n  })\n\n  return response.json()\n}\n"],"names":["findVersions","sdk","options","init","response","request","args","method","path","collection","json"],"mappings":"AAgFA,OAAO,eAAeA,aAIpBC,GAAkB,EAClBC,OAAsC,EACtCC,IAAkB;IAElB,MAAMC,WAAW,MAAMH,IAAII,OAAO,CAAC;QACjCC,MAAMJ;QACNC;QACAI,QAAQ;QACRC,MAAM,CAAC,CAAC,EAAEN,QAAQO,UAAU,CAAC,SAAS,CAAC;IACzC;IAEA,OAAOL,SAASM,IAAI;AACtB"}

package/dist/collections/restoreVersion.d.ts

@@ -0,0 +1,34 @@
+import type { PayloadSDK } from '../index.js';
+import type { CollectionSlug, DataFromCollectionSlug, PayloadGeneratedTypes, PopulateType, TypedLocale } from '../types.js';
+export type RestoreVersionByIDOptions<T extends PayloadGeneratedTypes, TSlug extends CollectionSlug<T>> = {
+    /**
+     * the Collection slug to operate against.
+     */
+    collection: TSlug;
+    /**
+     * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.
+     */
+    depth?: number;
+    /**
+     * Whether the document should be queried from the versions table/collection or not. [More](https://payloadcms.com/docs/versions/drafts#draft-api)
+     */
+    draft?: boolean;
+    /**
+     * Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.
+     */
+    fallbackLocale?: false | TypedLocale<T>;
+    /**
+     * The ID of the version to restore.
+     */
+    id: number | string;
+    /**
+     * Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.
+     */
+    locale?: 'all' | TypedLocale<T>;
+    /**
+     * Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.
+     */
+    populate?: PopulateType<T>;
+};
+export declare function restoreVersion<T extends PayloadGeneratedTypes, TSlug extends CollectionSlug<T>>(sdk: PayloadSDK<T>, options: RestoreVersionByIDOptions<T, TSlug>, init?: RequestInit): Promise<DataFromCollectionSlug<T, TSlug>>;
+//# sourceMappingURL=restoreVersion.d.ts.map

package/dist/collections/restoreVersion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"restoreVersion.d.ts","sourceRoot":"","sources":["../../src/collections/restoreVersion.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EACV,cAAc,EACd,sBAAsB,EACtB,qBAAqB,EACrB,YAAY,EACZ,WAAW,EACZ,MAAM,aAAa,CAAA;AAEpB,MAAM,MAAM,yBAAyB,CACnC,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,IAC7B;IACF;;OAEG;IACH,UAAU,EAAE,KAAK,CAAA;IACjB;;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,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;CAC3B,CAAA;AAED,wBAAsB,cAAc,CAClC,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAE/B,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,EAClB,OAAO,EAAE,yBAAyB,CAAC,CAAC,EAAE,KAAK,CAAC,EAC5C,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAS3C"}

package/dist/collections/restoreVersion.js

@@ -0,0 +1,11 @@
+export async function restoreVersion(sdk, options, init) {
+    const response = await sdk.request({
+        args: options,
+        init,
+        method: 'POST',
+        path: `/${options.collection}/versions/${options.id}`
+    });
+    return response.json();
+}
+
+//# sourceMappingURL=restoreVersion.js.map

package/dist/collections/restoreVersion.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/collections/restoreVersion.ts"],"sourcesContent":["import type { PayloadSDK } from '../index.js'\nimport type {\n  CollectionSlug,\n  DataFromCollectionSlug,\n  PayloadGeneratedTypes,\n  PopulateType,\n  TypedLocale,\n} from '../types.js'\n\nexport type RestoreVersionByIDOptions<\n  T extends PayloadGeneratedTypes,\n  TSlug extends CollectionSlug<T>,\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   * 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 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\nexport async function restoreVersion<\n  T extends PayloadGeneratedTypes,\n  TSlug extends CollectionSlug<T>,\n>(\n  sdk: PayloadSDK<T>,\n  options: RestoreVersionByIDOptions<T, TSlug>,\n  init?: RequestInit,\n): Promise<DataFromCollectionSlug<T, TSlug>> {\n  const response = await sdk.request({\n    args: options,\n    init,\n    method: 'POST',\n    path: `/${options.collection}/versions/${options.id}`,\n  })\n\n  return response.json()\n}\n"],"names":["restoreVersion","sdk","options","init","response","request","args","method","path","collection","id","json"],"mappings":"AA2CA,OAAO,eAAeA,eAIpBC,GAAkB,EAClBC,OAA4C,EAC5CC,IAAkB;IAElB,MAAMC,WAAW,MAAMH,IAAII,OAAO,CAAC;QACjCC,MAAMJ;QACNC;QACAI,QAAQ;QACRC,MAAM,CAAC,CAAC,EAAEN,QAAQO,UAAU,CAAC,UAAU,EAAEP,QAAQQ,EAAE,EAAE;IACvD;IAEA,OAAON,SAASO,IAAI;AACtB"}

package/dist/collections/update.d.ts

@@ -0,0 +1,62 @@
+import type { SelectType, Where } from 'payload';
+import type { DeepPartial } from 'ts-essentials';
+import type { PayloadSDK } from '../index.js';
+import type { BulkOperationResult, CollectionSlug, PayloadGeneratedTypes, PopulateType, RequiredDataFromCollectionSlug, SelectFromCollectionSlug, TransformCollectionWithSelect, TypedLocale, UploadCollectionSlug } from '../types.js';
+export type UpdateBaseOptions<T extends PayloadGeneratedTypes, TSlug extends CollectionSlug<T>, TSelect extends SelectType> = {
+    /**
+     * Whether the current update should be marked as from autosave.
+     * `versions.drafts.autosave` should be specified.
+     */
+    autosave?: boolean;
+    /**
+     * the Collection slug to operate against.
+     */
+    collection: TSlug;
+    /**
+     * The document / documents data to update.
+     */
+    data: DeepPartial<RequiredDataFromCollectionSlug<T, TSlug>>;
+    /**
+     * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.
+     */
+    depth?: number;
+    /**
+     * Update documents to a draft.
+     */
+    draft?: boolean;
+    /**
+     * Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.
+     */
+    fallbackLocale?: false | TypedLocale<T>;
+    /** File Blob object or URL to the file. Only for upload collections */
+    file?: TSlug extends UploadCollectionSlug<T> ? Blob | string : never;
+    /**
+     * Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.
+     */
+    locale?: TypedLocale<T>;
+    /**
+     * Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.
+     */
+    populate?: PopulateType<T>;
+    /**
+     * Publish the document / documents with a specific locale.
+     */
+    publishSpecificLocale?: string;
+    /**
+     * Specify [select](https://payloadcms.com/docs/queries/select) to control which fields to include to the result.
+     */
+    select?: TSelect;
+};
+export type UpdateByIDOptions<T extends PayloadGeneratedTypes, TSlug extends CollectionSlug<T>, TSelect extends SelectFromCollectionSlug<T, TSlug>> = {
+    id: number | string;
+    limit?: never;
+    where?: never;
+} & UpdateBaseOptions<T, TSlug, TSelect>;
+export type UpdateManyOptions<T extends PayloadGeneratedTypes, TSlug extends CollectionSlug<T>, TSelect extends SelectFromCollectionSlug<T, TSlug>> = {
+    id?: never;
+    limit?: number;
+    where: Where;
+} & UpdateBaseOptions<T, TSlug, TSelect>;
+export type UpdateOptions<T extends PayloadGeneratedTypes, TSlug extends CollectionSlug<T>, TSelect extends SelectFromCollectionSlug<T, TSlug>> = UpdateByIDOptions<T, TSlug, TSelect> | UpdateManyOptions<T, TSlug, TSelect>;
+export declare function update<T extends PayloadGeneratedTypes, TSlug extends CollectionSlug<T>, TSelect extends SelectFromCollectionSlug<T, TSlug>>(sdk: PayloadSDK<T>, options: UpdateOptions<T, TSlug, TSelect>, init?: RequestInit): Promise<BulkOperationResult<T, TSlug, TSelect> | TransformCollectionWithSelect<T, TSlug, TSelect>>;
+//# sourceMappingURL=update.d.ts.map

package/dist/collections/update.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update.d.ts","sourceRoot":"","sources":["../../src/collections/update.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAEhD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACd,qBAAqB,EACrB,YAAY,EACZ,8BAA8B,EAC9B,wBAAwB,EACxB,6BAA6B,EAC7B,WAAW,EACX,oBAAoB,EACrB,MAAM,aAAa,CAAA;AAIpB,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,cAAc,CAAC,CAAC,CAAC,EAC/B,OAAO,SAAS,UAAU,IACxB;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;CACjB,CAAA;AAED,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,qBAAqB,EAC/B,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,qBAAqB,EAC/B,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,qBAAqB,EAC/B,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,qBAAqB,EAC/B,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"}

package/dist/collections/update.js

@@ -0,0 +1,22 @@
+import { resolveFileFromOptions } from '../utilities/resolveFileFromOptions.js';
+export async function update(sdk, options, init) {
+    let file = undefined;
+    if (options.file) {
+        file = await resolveFileFromOptions(options.file);
+    }
+    const response = await sdk.request({
+        args: options,
+        file,
+        init,
+        json: options.data,
+        method: 'PATCH',
+        path: `/${options.collection}${options.id ? `/${options.id}` : ''}`
+    });
+    const json = await response.json();
+    if (options.id) {
+        return json.doc;
+    }
+    return json;
+}
+
+//# sourceMappingURL=update.js.map

package/dist/collections/update.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/collections/update.ts"],"sourcesContent":["import type { SelectType, Where } from 'payload'\nimport type { DeepPartial } from 'ts-essentials'\n\nimport type { PayloadSDK } from '../index.js'\nimport type {\n  BulkOperationResult,\n  CollectionSlug,\n  PayloadGeneratedTypes,\n  PopulateType,\n  RequiredDataFromCollectionSlug,\n  SelectFromCollectionSlug,\n  TransformCollectionWithSelect,\n  TypedLocale,\n  UploadCollectionSlug,\n} from '../types.js'\n\nimport { resolveFileFromOptions } from '../utilities/resolveFileFromOptions.js'\n\nexport type UpdateBaseOptions<\n  T extends PayloadGeneratedTypes,\n  TSlug extends CollectionSlug<T>,\n  TSelect extends SelectType,\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 PayloadGeneratedTypes,\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 PayloadGeneratedTypes,\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 PayloadGeneratedTypes,\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 PayloadGeneratedTypes,\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":"AAgBA,SAASA,sBAAsB,QAAQ,yCAAwC;AA8E/E,OAAO,eAAeC,OAKpBC,GAAkB,EAClBC,OAAyC,EACzCC,IAAkB;IAIlB,IAAIC,OAAyBC;IAE7B,IAAIH,QAAQE,IAAI,EAAE;QAChBA,OAAO,MAAML,uBAAuBG,QAAQE,IAAI;IAClD;IAEA,MAAME,WAAW,MAAML,IAAIM,OAAO,CAAC;QACjCC,MAAMN;QACNE;QACAD;QACAM,MAAMP,QAAQQ,IAAI;QAClBC,QAAQ;QACRC,MAAM,CAAC,CAAC,EAAEV,QAAQW,UAAU,GAAGX,QAAQY,EAAE,GAAG,CAAC,CAAC,EAAEZ,QAAQY,EAAE,EAAE,GAAG,IAAI;IACrE;IAEA,MAAML,OAAO,MAAMH,SAASG,IAAI;IAEhC,IAAIP,QAAQY,EAAE,EAAE;QACd,OAAOL,KAAKM,GAAG;IACjB;IAEA,OAAON;AACT"}

package/dist/globals/findOne.d.ts

@@ -0,0 +1,35 @@
+import type { SelectType } from 'payload';
+import type { PayloadSDK } from '../index.js';
+import type { GlobalSlug, PayloadGeneratedTypes, PopulateType, SelectFromGlobalSlug, TransformGlobalWithSelect, TypedLocale } from '../types.js';
+export type FindGlobalOptions<T extends PayloadGeneratedTypes, TSlug extends GlobalSlug<T>, TSelect extends SelectType> = {
+    /**
+     * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.
+     */
+    depth?: number;
+    /**
+     * Whether the document should be queried from the versions table/collection or not. [More](https://payloadcms.com/docs/versions/drafts#draft-api)
+     */
+    draft?: boolean;
+    /**
+     * Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.
+     */
+    fallbackLocale?: false | TypedLocale<T>;
+    /**
+     * Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.
+     */
+    locale?: 'all' | TypedLocale<T>;
+    /**
+     * Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.
+     */
+    populate?: PopulateType<T>;
+    /**
+     * Specify [select](https://payloadcms.com/docs/queries/select) to control which fields to include to the result.
+     */
+    select?: TSelect;
+    /**
+     * the Global slug to operate against.
+     */
+    slug: TSlug;
+};
+export declare function findGlobal<T extends PayloadGeneratedTypes, TSlug extends GlobalSlug<T>, TSelect extends SelectFromGlobalSlug<T, TSlug>>(sdk: PayloadSDK<T>, options: FindGlobalOptions<T, TSlug, TSelect>, init?: RequestInit): Promise<TransformGlobalWithSelect<T, TSlug, TSelect>>;
+//# sourceMappingURL=findOne.d.ts.map

package/dist/globals/findOne.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findOne.d.ts","sourceRoot":"","sources":["../../src/globals/findOne.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAEzC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EACV,UAAU,EACV,qBAAqB,EACrB,YAAY,EACZ,oBAAoB,EACpB,yBAAyB,EACzB,WAAW,EACZ,MAAM,aAAa,CAAA;AAEpB,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,UAAU,CAAC,CAAC,CAAC,EAC3B,OAAO,SAAS,UAAU,IACxB;IACF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;IACvC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAA;CACZ,CAAA;AAED,wBAAsB,UAAU,CAC9B,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,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,CASvD"}

package/dist/globals/findOne.js

@@ -0,0 +1,11 @@
+export async function findGlobal(sdk, options, init) {
+    const response = await sdk.request({
+        args: options,
+        init,
+        method: 'GET',
+        path: `/globals/${options.slug}`
+    });
+    return response.json();
+}
+
+//# sourceMappingURL=findOne.js.map

package/dist/globals/findOne.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/globals/findOne.ts"],"sourcesContent":["import type { SelectType } from 'payload'\n\nimport type { PayloadSDK } from '../index.js'\nimport type {\n  GlobalSlug,\n  PayloadGeneratedTypes,\n  PopulateType,\n  SelectFromGlobalSlug,\n  TransformGlobalWithSelect,\n  TypedLocale,\n} from '../types.js'\n\nexport type FindGlobalOptions<\n  T extends PayloadGeneratedTypes,\n  TSlug extends GlobalSlug<T>,\n  TSelect extends SelectType,\n> = {\n  /**\n   * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.\n   */\n  depth?: number\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   * Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.\n   */\n  locale?: 'all' | TypedLocale<T>\n  /**\n   * Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.\n   */\n  populate?: PopulateType<T>\n  /**\n   * Specify [select](https://payloadcms.com/docs/queries/select) to control which fields to include to the result.\n   */\n  select?: TSelect\n  /**\n   * the Global slug to operate against.\n   */\n  slug: TSlug\n}\n\nexport async function findGlobal<\n  T extends PayloadGeneratedTypes,\n  TSlug extends GlobalSlug<T>,\n  TSelect extends SelectFromGlobalSlug<T, TSlug>,\n>(\n  sdk: PayloadSDK<T>,\n  options: FindGlobalOptions<T, TSlug, TSelect>,\n  init?: RequestInit,\n): Promise<TransformGlobalWithSelect<T, TSlug, TSelect>> {\n  const response = await sdk.request({\n    args: options,\n    init,\n    method: 'GET',\n    path: `/globals/${options.slug}`,\n  })\n\n  return response.json()\n}\n"],"names":["findGlobal","sdk","options","init","response","request","args","method","path","slug","json"],"mappings":"AA+CA,OAAO,eAAeA,WAKpBC,GAAkB,EAClBC,OAA6C,EAC7CC,IAAkB;IAElB,MAAMC,WAAW,MAAMH,IAAII,OAAO,CAAC;QACjCC,MAAMJ;QACNC;QACAI,QAAQ;QACRC,MAAM,CAAC,SAAS,EAAEN,QAAQO,IAAI,EAAE;IAClC;IAEA,OAAOL,SAASM,IAAI;AACtB"}

package/dist/globals/findVersionByID.d.ts

@@ -0,0 +1,41 @@
+import type { ApplyDisableErrors, SelectType, TypeWithVersion } from 'payload';
+import type { PayloadSDK } from '../index.js';
+import type { DataFromGlobalSlug, GlobalSlug, PayloadGeneratedTypes, PopulateType, TypedLocale } from '../types.js';
+export type FindGlobalVersionByIDOptions<T extends PayloadGeneratedTypes, TSlug extends GlobalSlug<T>, TDisableErrors extends boolean> = {
+    /**
+     * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.
+     */
+    depth?: number;
+    /**
+     * When set to `true`, errors will not be thrown.
+     * `null` will be returned instead, if the document on this ID was not found.
+     */
+    disableErrors?: TDisableErrors;
+    draft?: boolean;
+    /**
+     * Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.
+     */
+    fallbackLocale?: false | TypedLocale<T>;
+    /**
+     * The ID of the version to find.
+     */
+    id: number | string;
+    /**
+     * Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.
+     */
+    locale?: 'all' | TypedLocale<T>;
+    /**
+     * Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.
+     */
+    populate?: PopulateType<T>;
+    /**
+     * Specify [select](https://payloadcms.com/docs/queries/select) to control which fields to include to the result.
+     */
+    select?: SelectType;
+    /**
+     * the Global slug to operate against.
+     */
+    slug: TSlug;
+};
+export declare function findGlobalVersionByID<T extends PayloadGeneratedTypes, TSlug extends GlobalSlug<T>, TDisableErrors extends boolean>(sdk: PayloadSDK<T>, options: FindGlobalVersionByIDOptions<T, TSlug, TDisableErrors>, init?: RequestInit): Promise<ApplyDisableErrors<TypeWithVersion<DataFromGlobalSlug<T, TSlug>>, TDisableErrors>>;
+//# sourceMappingURL=findVersionByID.d.ts.map

package/dist/globals/findVersionByID.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findVersionByID.d.ts","sourceRoot":"","sources":["../../src/globals/findVersionByID.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAE9E,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,4BAA4B,CACtC,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,UAAU,CAAC,CAAC,CAAC,EAC3B,cAAc,SAAS,OAAO,IAC5B;IACF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,aAAa,CAAC,EAAE,cAAc,CAAA;IAC9B,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,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAA;CACZ,CAAA;AAED,wBAAsB,qBAAqB,CACzC,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,UAAU,CAAC,CAAC,CAAC,EAC3B,cAAc,SAAS,OAAO,EAE9B,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,EAClB,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,CAsB5F"}

package/dist/globals/findVersionByID.js

@@ -0,0 +1,23 @@
+export async function findGlobalVersionByID(sdk, options, init) {
+    try {
+        const response = await sdk.request({
+            args: options,
+            init,
+            method: 'GET',
+            path: `/globals/${options.slug}/versions/${options.id}`
+        });
+        if (response.ok) {
+            return response.json();
+        } else {
+            throw new Error();
+        }
+    } catch  {
+        if (options.disableErrors) {
+            // @ts-expect-error generic nullable
+            return null;
+        }
+        throw new Error(`Error retrieving the version document ${options.slug}/${options.id}`);
+    }
+}
+
+//# sourceMappingURL=findVersionByID.js.map

package/dist/globals/findVersionByID.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/globals/findVersionByID.ts"],"sourcesContent":["import type { ApplyDisableErrors, SelectType, 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 FindGlobalVersionByIDOptions<\n  T extends PayloadGeneratedTypes,\n  TSlug extends GlobalSlug<T>,\n  TDisableErrors extends boolean,\n> = {\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  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 find.\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   * 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\nexport async function findGlobalVersionByID<\n  T extends PayloadGeneratedTypes,\n  TSlug extends GlobalSlug<T>,\n  TDisableErrors extends boolean,\n>(\n  sdk: PayloadSDK<T>,\n  options: FindGlobalVersionByIDOptions<T, TSlug, TDisableErrors>,\n  init?: RequestInit,\n): Promise<ApplyDisableErrors<TypeWithVersion<DataFromGlobalSlug<T, TSlug>>, TDisableErrors>> {\n  try {\n    const response = await sdk.request({\n      args: options,\n      init,\n      method: 'GET',\n      path: `/globals/${options.slug}/versions/${options.id}`,\n    })\n\n    if (response.ok) {\n      return response.json()\n    } else {\n      throw new Error()\n    }\n  } catch {\n    if (options.disableErrors) {\n      // @ts-expect-error generic nullable\n      return null\n    }\n\n    throw new Error(`Error retrieving the version document ${options.slug}/${options.id}`)\n  }\n}\n"],"names":["findGlobalVersionByID","sdk","options","init","response","request","args","method","path","slug","id","ok","json","Error","disableErrors"],"mappings":"AAoDA,OAAO,eAAeA,sBAKpBC,GAAkB,EAClBC,OAA+D,EAC/DC,IAAkB;IAElB,IAAI;QACF,MAAMC,WAAW,MAAMH,IAAII,OAAO,CAAC;YACjCC,MAAMJ;YACNC;YACAI,QAAQ;YACRC,MAAM,CAAC,SAAS,EAAEN,QAAQO,IAAI,CAAC,UAAU,EAAEP,QAAQQ,EAAE,EAAE;QACzD;QAEA,IAAIN,SAASO,EAAE,EAAE;YACf,OAAOP,SAASQ,IAAI;QACtB,OAAO;YACL,MAAM,IAAIC;QACZ;IACF,EAAE,OAAM;QACN,IAAIX,QAAQY,aAAa,EAAE;YACzB,oCAAoC;YACpC,OAAO;QACT;QAEA,MAAM,IAAID,MAAM,CAAC,sCAAsC,EAAEX,QAAQO,IAAI,CAAC,CAAC,EAAEP,QAAQQ,EAAE,EAAE;IACvF;AACF"}

package/dist/globals/findVersions.d.ts

@@ -0,0 +1,58 @@
+import type { PaginatedDocs, SelectType, Sort, TypeWithVersion, Where } from 'payload';
+import type { PayloadSDK } from '../index.js';
+import type { DataFromGlobalSlug, GlobalSlug, PayloadGeneratedTypes, PopulateType, TypedLocale } from '../types.js';
+export type FindGlobalVersionsOptions<T extends PayloadGeneratedTypes, TSlug extends GlobalSlug<T>> = {
+    /**
+     * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.
+     */
+    depth?: number;
+    draft?: boolean;
+    /**
+     * Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.
+     */
+    fallbackLocale?: false | TypedLocale<T>;
+    /**
+     * The maximum related documents to be returned.
+     * Defaults unless `defaultLimit` is specified for the collection config
+     * @default 10
+     */
+    limit?: number;
+    /**
+     * Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.
+     */
+    locale?: 'all' | TypedLocale<T>;
+    /**
+     * Get a specific page number
+     * @default 1
+     */
+    page?: number;
+    /**
+     * Set to `false` to return all documents and avoid querying for document counts which introduces some overhead.
+     * You can also combine that property with a specified `limit` to limit documents but avoid the count query.
+     */
+    pagination?: boolean;
+    /**
+     * Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.
+     */
+    populate?: PopulateType<T>;
+    /**
+     * Specify [select](https://payloadcms.com/docs/queries/select) to control which fields to include to the result.
+     */
+    select?: SelectType;
+    /**
+     * the Global slug to operate against.
+     */
+    slug: TSlug;
+    /**
+     * Sort the documents, can be a string or an array of strings
+     * @example '-version.createdAt' // Sort DESC by createdAt
+     * @example ['version.group', '-version.createdAt'] // sort by 2 fields, ASC group and DESC createdAt
+     */
+    sort?: Sort;
+    /**
+     * A filter [query](https://payloadcms.com/docs/queries/overview)
+     */
+    where?: Where;
+};
+export declare function findGlobalVersions<T extends PayloadGeneratedTypes, TSlug extends GlobalSlug<T>>(sdk: PayloadSDK<T>, options: FindGlobalVersionsOptions<T, TSlug>, init?: RequestInit): Promise<PaginatedDocs<TypeWithVersion<DataFromGlobalSlug<T, TSlug>>>>;
+//# sourceMappingURL=findVersions.d.ts.map

package/dist/globals/findVersions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findVersions.d.ts","sourceRoot":"","sources":["../../src/globals/findVersions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAEtF,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,yBAAyB,CACnC,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;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;IAC/B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAA;IACX;;;;OAIG;IACH,IAAI,CAAC,EAAE,IAAI,CAAA;IACX;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,CAAA;AAED,wBAAsB,kBAAkB,CACtC,CAAC,SAAS,qBAAqB,EAC/B,KAAK,SAAS,UAAU,CAAC,CAAC,CAAC,EAE3B,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,EAClB,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,CASvE"}

package/dist/globals/findVersions.js

@@ -0,0 +1,11 @@
+export async function findGlobalVersions(sdk, options, init) {
+    const response = await sdk.request({
+        args: options,
+        init,
+        method: 'GET',
+        path: `/globals/${options.slug}/versions`
+    });
+    return response.json();
+}
+
+//# sourceMappingURL=findVersions.js.map