payload 1.9.2 → 1.9.4

package/dist/mongoose/sanitizeQueryValue.js

@@ -1,105 +1,105 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sanitizeQueryValue = void 0;
-const mongoose_1 = __importDefault(require("mongoose"));
-const createArrayFromCommaDelineated_1 = require("./createArrayFromCommaDelineated");
-const wordBoundariesRegex_1 = __importDefault(require("../utilities/wordBoundariesRegex"));
-const sanitizeQueryValue = ({ field, path, operator, val, hasCustomID }) => {
-    let formattedValue = val;
-    // Disregard invalid _ids
-    if (path === '_id' && typeof val === 'string' && val.split(',').length === 1) {
-        if (!hasCustomID) {
-            const isValid = mongoose_1.default.Types.ObjectId.isValid(val);
-            if (!isValid) {
-                return undefined;
-            }
-        }
-        if (field.type === 'number') {
-            const parsedNumber = parseFloat(val);
-            if (Number.isNaN(parsedNumber)) {
-                return undefined;
-            }
-        }
-    }
-    // Cast incoming values as proper searchable types
-    if (field.type === 'checkbox' && typeof val === 'string') {
-        if (val.toLowerCase() === 'true')
-            formattedValue = true;
-        if (val.toLowerCase() === 'false')
-            formattedValue = false;
-    }
-    if (field.type === 'number' && typeof val === 'string') {
-        formattedValue = Number(val);
-    }
-    if (field.type === 'date' && typeof val === 'string') {
-        formattedValue = new Date(val);
-        if (Number.isNaN(Date.parse(formattedValue))) {
-            return undefined;
-        }
-    }
-    if (['relationship', 'upload'].includes(field.type)) {
-        if (val === 'null') {
-            formattedValue = null;
-        }
-        if (operator === 'in' && Array.isArray(formattedValue)) {
-            formattedValue = formattedValue.reduce((formattedValues, inVal) => {
-                const newValues = [inVal];
-                if (mongoose_1.default.Types.ObjectId.isValid(inVal))
-                    newValues.push(new mongoose_1.default.Types.ObjectId(inVal));
-                const parsedNumber = parseFloat(inVal);
-                if (!Number.isNaN(parsedNumber))
-                    newValues.push(parsedNumber);
-                return [
-                    ...formattedValues,
-                    ...newValues,
-                ];
-            }, []);
-        }
-    }
-    // Set up specific formatting necessary by operators
-    if (operator === 'near') {
-        let lng;
-        let lat;
-        let maxDistance;
-        let minDistance;
-        if (Array.isArray(formattedValue)) {
-            [lng, lat, maxDistance, minDistance] = formattedValue;
-        }
-        if (typeof formattedValue === 'string') {
-            [lng, lat, maxDistance, minDistance] = (0, createArrayFromCommaDelineated_1.createArrayFromCommaDelineated)(formattedValue);
-        }
-        if (!lng || !lat || (!maxDistance && !minDistance)) {
-            formattedValue = undefined;
-        }
-        else {
-            formattedValue = {
-                $geometry: { type: 'Point', coordinates: [parseFloat(lng), parseFloat(lat)] },
-            };
-            if (maxDistance)
-                formattedValue.$maxDistance = parseFloat(maxDistance);
-            if (minDistance)
-                formattedValue.$minDistance = parseFloat(minDistance);
-        }
-    }
-    if (['all', 'not_in', 'in'].includes(operator) && typeof formattedValue === 'string') {
-        formattedValue = (0, createArrayFromCommaDelineated_1.createArrayFromCommaDelineated)(formattedValue);
-    }
-    if (path !== '_id' || (path === '_id' && hasCustomID && field.type === 'text')) {
-        if (operator === 'contains') {
-            formattedValue = { $regex: formattedValue, $options: 'i' };
-        }
-        if (operator === 'like' && typeof formattedValue === 'string') {
-            const $regex = (0, wordBoundariesRegex_1.default)(formattedValue);
-            formattedValue = { $regex };
-        }
-    }
-    if (operator === 'exists') {
-        formattedValue = (formattedValue === 'true' || formattedValue === true);
-    }
-    return formattedValue;
-};
-exports.sanitizeQueryValue = sanitizeQueryValue;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sanitizeQueryValue = void 0;
+const mongoose_1 = __importDefault(require("mongoose"));
+const createArrayFromCommaDelineated_1 = require("./createArrayFromCommaDelineated");
+const wordBoundariesRegex_1 = __importDefault(require("../utilities/wordBoundariesRegex"));
+const sanitizeQueryValue = ({ field, path, operator, val, hasCustomID }) => {
+    let formattedValue = val;
+    // Disregard invalid _ids
+    if (path === '_id' && typeof val === 'string' && val.split(',').length === 1) {
+        if (!hasCustomID) {
+            const isValid = mongoose_1.default.Types.ObjectId.isValid(val);
+            if (!isValid) {
+                return undefined;
+            }
+        }
+        if (field.type === 'number') {
+            const parsedNumber = parseFloat(val);
+            if (Number.isNaN(parsedNumber)) {
+                return undefined;
+            }
+        }
+    }
+    // Cast incoming values as proper searchable types
+    if (field.type === 'checkbox' && typeof val === 'string') {
+        if (val.toLowerCase() === 'true')
+            formattedValue = true;
+        if (val.toLowerCase() === 'false')
+            formattedValue = false;
+    }
+    if (field.type === 'number' && typeof val === 'string') {
+        formattedValue = Number(val);
+    }
+    if (field.type === 'date' && typeof val === 'string') {
+        formattedValue = new Date(val);
+        if (Number.isNaN(Date.parse(formattedValue))) {
+            return undefined;
+        }
+    }
+    if (['relationship', 'upload'].includes(field.type)) {
+        if (val === 'null') {
+            formattedValue = null;
+        }
+        if (operator === 'in' && Array.isArray(formattedValue)) {
+            formattedValue = formattedValue.reduce((formattedValues, inVal) => {
+                const newValues = [inVal];
+                if (mongoose_1.default.Types.ObjectId.isValid(inVal))
+                    newValues.push(new mongoose_1.default.Types.ObjectId(inVal));
+                const parsedNumber = parseFloat(inVal);
+                if (!Number.isNaN(parsedNumber))
+                    newValues.push(parsedNumber);
+                return [
+                    ...formattedValues,
+                    ...newValues,
+                ];
+            }, []);
+        }
+    }
+    // Set up specific formatting necessary by operators
+    if (operator === 'near') {
+        let lng;
+        let lat;
+        let maxDistance;
+        let minDistance;
+        if (Array.isArray(formattedValue)) {
+            [lng, lat, maxDistance, minDistance] = formattedValue;
+        }
+        if (typeof formattedValue === 'string') {
+            [lng, lat, maxDistance, minDistance] = (0, createArrayFromCommaDelineated_1.createArrayFromCommaDelineated)(formattedValue);
+        }
+        if (!lng || !lat || (!maxDistance && !minDistance)) {
+            formattedValue = undefined;
+        }
+        else {
+            formattedValue = {
+                $geometry: { type: 'Point', coordinates: [parseFloat(lng), parseFloat(lat)] },
+            };
+            if (maxDistance)
+                formattedValue.$maxDistance = parseFloat(maxDistance);
+            if (minDistance)
+                formattedValue.$minDistance = parseFloat(minDistance);
+        }
+    }
+    if (['all', 'not_in', 'in'].includes(operator) && typeof formattedValue === 'string') {
+        formattedValue = (0, createArrayFromCommaDelineated_1.createArrayFromCommaDelineated)(formattedValue);
+    }
+    if (path !== '_id' || (path === '_id' && hasCustomID && field.type === 'text')) {
+        if (operator === 'contains') {
+            formattedValue = { $regex: formattedValue, $options: 'i' };
+        }
+        if (operator === 'like' && typeof formattedValue === 'string') {
+            const $regex = (0, wordBoundariesRegex_1.default)(formattedValue);
+            formattedValue = { $regex };
+        }
+    }
+    if (operator === 'exists') {
+        formattedValue = (formattedValue === 'true' || formattedValue === true);
+    }
+    return formattedValue;
+};
+exports.sanitizeQueryValue = sanitizeQueryValue;
 //# sourceMappingURL=sanitizeQueryValue.js.map

package/dist/mongoose/testCredentials.d.ts

@@ -1,7 +1,7 @@
-export declare const email = "test@test.com";
-export declare const password = "test123";
-export declare const connection: {
-    url: string;
-    port: number;
-    name: string;
-};
+export declare const email = "test@test.com";
+export declare const password = "test123";
+export declare const connection: {
+    url: string;
+    port: number;
+    name: string;
+};

package/dist/mongoose/testCredentials.js

@@ -1,11 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.connection = exports.password = exports.email = void 0;
-exports.email = 'test@test.com';
-exports.password = 'test123';
-exports.connection = {
-    url: 'mongodb://127.0.0.1',
-    port: 27018,
-    name: 'payloadmemory',
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.connection = exports.password = exports.email = void 0;
+exports.email = 'test@test.com';
+exports.password = 'test123';
+exports.connection = {
+    url: 'mongodb://127.0.0.1',
+    port: 27018,
+    name: 'payloadmemory',
+};
 //# sourceMappingURL=testCredentials.js.map

package/dist/mongoose/types.d.ts

@@ -1,12 +1,12 @@
-export type PaginatedDocs<T = any> = {
-    docs: T[];
-    totalDocs: number;
-    limit: number;
-    totalPages: number;
-    page?: number;
-    pagingCounter: number;
-    hasPrevPage: boolean;
-    hasNextPage: boolean;
-    prevPage?: number | null | undefined;
-    nextPage?: number | null | undefined;
-};
+export type PaginatedDocs<T = any> = {
+    docs: T[];
+    totalDocs: number;
+    limit: number;
+    totalPages: number;
+    page?: number;
+    pagingCounter: number;
+    hasPrevPage: boolean;
+    hasNextPage: boolean;
+    prevPage?: number | null | undefined;
+    nextPage?: number | null | undefined;
+};

package/dist/mongoose/types.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=types.js.map

package/dist/payload.d.ts

@@ -1,180 +1,180 @@
-import pino from 'pino';
-import type { Express, Router } from 'express';
-import { ExecutionResult, GraphQLSchema, ValidationRule } from 'graphql';
-import { Config as GeneratedTypes } from 'payload/generated-types';
-import { OperationArgs, Request as graphQLRequest } from 'graphql-http/lib/handler';
-import { SendMailOptions } from 'nodemailer';
-import { BulkOperationResult, Collection, CollectionModel } from './collections/config/types';
-import { EmailOptions, InitOptions, SanitizedConfig } from './config/types';
-import { TypeWithVersion } from './versions/types';
-import { PaginatedDocs } from './mongoose/types';
-import { PayloadAuthenticate } from './express/middleware/authenticate';
-import { Globals } from './globals/config/types';
-import { ErrorHandler } from './express/middleware/errorHandler';
-import { decrypt, encrypt } from './auth/crypto';
-import { BuildEmailResult } from './email/types';
-import { Preferences } from './preferences/types';
-import { Options as CreateOptions } from './collections/operations/local/create';
-import { Options as FindOptions } from './collections/operations/local/find';
-import { ByIDOptions as UpdateByIDOptions, ManyOptions as UpdateManyOptions } from './collections/operations/local/update';
-import { ByIDOptions as DeleteByIDOptions, ManyOptions as DeleteManyOptions } from './collections/operations/local/delete';
-import { Options as FindByIDOptions } from './collections/operations/local/findByID';
-import { Options as FindVersionsOptions } from './collections/operations/local/findVersions';
-import { Options as FindVersionByIDOptions } from './collections/operations/local/findVersionByID';
-import { Options as RestoreVersionOptions } from './collections/operations/local/restoreVersion';
-import { Options as FindGlobalVersionsOptions } from './globals/operations/local/findVersions';
-import { Options as FindGlobalVersionByIDOptions } from './globals/operations/local/findVersionByID';
-import { Options as RestoreGlobalVersionOptions } from './globals/operations/local/restoreVersion';
-import { Options as ForgotPasswordOptions } from './auth/operations/local/forgotPassword';
-import { Options as LoginOptions } from './auth/operations/local/login';
-import { Options as ResetPasswordOptions } from './auth/operations/local/resetPassword';
-import { Options as UnlockOptions } from './auth/operations/local/unlock';
-import { Options as VerifyEmailOptions } from './auth/operations/local/verifyEmail';
-import { Result as ForgotPasswordResult } from './auth/operations/forgotPassword';
-import { Result as ResetPasswordResult } from './auth/operations/resetPassword';
-import { Result as LoginResult } from './auth/operations/login';
-import { Options as FindGlobalOptions } from './globals/operations/local/findOne';
-import { Options as UpdateGlobalOptions } from './globals/operations/local/update';
-/**
- * @description Payload
- */
-export declare class BasePayload<TGeneratedTypes extends GeneratedTypes> {
-    config: SanitizedConfig;
-    collections: {
-        [slug: string | number | symbol]: Collection;
-    };
-    versions: {
-        [slug: string]: CollectionModel;
-    };
-    preferences: Preferences;
-    globals: Globals;
-    logger: pino.Logger;
-    emailOptions: EmailOptions;
-    email: BuildEmailResult;
-    sendEmail: (message: SendMailOptions) => Promise<unknown>;
-    secret: string;
-    mongoURL: string | false;
-    mongoOptions: InitOptions['mongoOptions'];
-    mongoMemoryServer: any;
-    local: boolean;
-    encrypt: typeof encrypt;
-    decrypt: typeof decrypt;
-    errorHandler: ErrorHandler;
-    authenticate: PayloadAuthenticate;
-    express?: Express;
-    router?: Router;
-    types: {
-        blockTypes: any;
-        blockInputTypes: any;
-        groupTypes: any;
-        arrayTypes: any;
-        tabTypes: any;
-        localeInputType?: any;
-        fallbackLocaleInputType?: any;
-    };
-    Query: {
-        name: string;
-        fields: {
-            [key: string]: any;
-        };
-    };
-    Mutation: {
-        name: string;
-        fields: {
-            [key: string]: any;
-        };
-    };
-    schema: GraphQLSchema;
-    extensions: (args: {
-        req: graphQLRequest<unknown, unknown>;
-        args: OperationArgs<any>;
-        result: ExecutionResult;
-    }) => Promise<any>;
-    validationRules: (args: OperationArgs<any>) => ValidationRule[];
-    getAdminURL: () => string;
-    getAPIURL: () => string;
-    /**
-     * @description Initializes Payload
-     * @param options
-     */
-    init(options: InitOptions): Promise<Payload>;
-    /**
-     * @description Performs create operation
-     * @param options
-     * @returns created document
-     */
-    create: <T extends keyof TGeneratedTypes["collections"]>(options: CreateOptions<T>) => Promise<TGeneratedTypes["collections"][T]>;
-    /**
-     * @description Find documents with criteria
-     * @param options
-     * @returns documents satisfying query
-     */
-    find: <T extends keyof TGeneratedTypes["collections"]>(options: FindOptions<T>) => Promise<PaginatedDocs<TGeneratedTypes["collections"][T]>>;
-    /**
-     * @description Find document by ID
-     * @param options
-     * @returns document with specified ID
-     */
-    findByID: <T extends keyof TGeneratedTypes["collections"]>(options: FindByIDOptions<T>) => Promise<TGeneratedTypes["collections"][T]>;
-    /**
-     * @description Update one or more documents
-     * @param options
-     * @returns Updated document(s)
-     */
-    update<T extends keyof TGeneratedTypes['collections']>(options: UpdateByIDOptions<T>): Promise<TGeneratedTypes['collections'][T]>;
-    update<T extends keyof TGeneratedTypes['collections']>(options: UpdateManyOptions<T>): Promise<BulkOperationResult<T>>;
-    /**
-     * @description delete one or more documents
-     * @param options
-     * @returns Updated document(s)
-     */
-    delete<T extends keyof TGeneratedTypes['collections']>(options: DeleteByIDOptions<T>): Promise<TGeneratedTypes['collections'][T]>;
-    delete<T extends keyof TGeneratedTypes['collections']>(options: DeleteManyOptions<T>): Promise<BulkOperationResult<T>>;
-    /**
-     * @description Find versions with criteria
-     * @param options
-     * @returns versions satisfying query
-     */
-    findVersions: <T extends keyof TGeneratedTypes["collections"]>(options: FindVersionsOptions<T>) => Promise<PaginatedDocs<TypeWithVersion<TGeneratedTypes["collections"][T]>>>;
-    /**
-     * @description Find version by ID
-     * @param options
-     * @returns version with specified ID
-     */
-    findVersionByID: <T extends keyof TGeneratedTypes["collections"]>(options: FindVersionByIDOptions<T>) => Promise<TypeWithVersion<TGeneratedTypes["collections"][T]>>;
-    /**
-     * @description Restore version by ID
-     * @param options
-     * @returns version with specified ID
-     */
-    restoreVersion: <T extends keyof TGeneratedTypes["collections"]>(options: RestoreVersionOptions<T>) => Promise<TGeneratedTypes["collections"][T]>;
-    login: <T extends keyof TGeneratedTypes["collections"]>(options: LoginOptions<T>) => Promise<LoginResult & {
-        user: TGeneratedTypes["collections"][T];
-    }>;
-    forgotPassword: <T extends keyof TGeneratedTypes["collections"]>(options: ForgotPasswordOptions<T>) => Promise<ForgotPasswordResult>;
-    resetPassword: <T extends keyof TGeneratedTypes["collections"]>(options: ResetPasswordOptions<T>) => Promise<ResetPasswordResult>;
-    unlock: <T extends keyof TGeneratedTypes["collections"]>(options: UnlockOptions<T>) => Promise<boolean>;
-    verifyEmail: <T extends keyof TGeneratedTypes["collections"]>(options: VerifyEmailOptions<T>) => Promise<boolean>;
-    findGlobal: <T extends keyof TGeneratedTypes["globals"]>(options: FindGlobalOptions<T>) => Promise<TGeneratedTypes["globals"][T]>;
-    updateGlobal: <T extends keyof TGeneratedTypes["globals"]>(options: UpdateGlobalOptions<T>) => Promise<TGeneratedTypes["globals"][T]>;
-    /**
-     * @description Find global versions with criteria
-     * @param options
-     * @returns versions satisfying query
-     */
-    findGlobalVersions: <T extends keyof TGeneratedTypes["globals"]>(options: FindGlobalVersionsOptions<T>) => Promise<PaginatedDocs<TypeWithVersion<TGeneratedTypes["globals"][T]>>>;
-    /**
-     * @description Find global version by ID
-     * @param options
-     * @returns global version with specified ID
-     */
-    findGlobalVersionByID: <T extends keyof TGeneratedTypes["globals"]>(options: FindGlobalVersionByIDOptions<T>) => Promise<TypeWithVersion<TGeneratedTypes["globals"][T]>>;
-    /**
-     * @description Restore global version by ID
-     * @param options
-     * @returns version with specified ID
-     */
-    restoreGlobalVersion: <T extends keyof TGeneratedTypes["globals"]>(options: RestoreGlobalVersionOptions<T>) => Promise<TGeneratedTypes["globals"][T]>;
-}
-export type Payload = BasePayload<GeneratedTypes>;
-export declare const getPayload: (options: InitOptions) => Promise<Payload>;
+import pino from 'pino';
+import type { Express, Router } from 'express';
+import { ExecutionResult, GraphQLSchema, ValidationRule } from 'graphql';
+import { Config as GeneratedTypes } from 'payload/generated-types';
+import { OperationArgs, Request as graphQLRequest } from 'graphql-http/lib/handler';
+import { SendMailOptions } from 'nodemailer';
+import { BulkOperationResult, Collection, CollectionModel } from './collections/config/types';
+import { EmailOptions, InitOptions, SanitizedConfig } from './config/types';
+import { TypeWithVersion } from './versions/types';
+import { PaginatedDocs } from './mongoose/types';
+import { PayloadAuthenticate } from './express/middleware/authenticate';
+import { Globals } from './globals/config/types';
+import { ErrorHandler } from './express/middleware/errorHandler';
+import { decrypt, encrypt } from './auth/crypto';
+import { BuildEmailResult } from './email/types';
+import { Preferences } from './preferences/types';
+import { Options as CreateOptions } from './collections/operations/local/create';
+import { Options as FindOptions } from './collections/operations/local/find';
+import { ByIDOptions as UpdateByIDOptions, ManyOptions as UpdateManyOptions } from './collections/operations/local/update';
+import { ByIDOptions as DeleteByIDOptions, ManyOptions as DeleteManyOptions } from './collections/operations/local/delete';
+import { Options as FindByIDOptions } from './collections/operations/local/findByID';
+import { Options as FindVersionsOptions } from './collections/operations/local/findVersions';
+import { Options as FindVersionByIDOptions } from './collections/operations/local/findVersionByID';
+import { Options as RestoreVersionOptions } from './collections/operations/local/restoreVersion';
+import { Options as FindGlobalVersionsOptions } from './globals/operations/local/findVersions';
+import { Options as FindGlobalVersionByIDOptions } from './globals/operations/local/findVersionByID';
+import { Options as RestoreGlobalVersionOptions } from './globals/operations/local/restoreVersion';
+import { Options as ForgotPasswordOptions } from './auth/operations/local/forgotPassword';
+import { Options as LoginOptions } from './auth/operations/local/login';
+import { Options as ResetPasswordOptions } from './auth/operations/local/resetPassword';
+import { Options as UnlockOptions } from './auth/operations/local/unlock';
+import { Options as VerifyEmailOptions } from './auth/operations/local/verifyEmail';
+import { Result as ForgotPasswordResult } from './auth/operations/forgotPassword';
+import { Result as ResetPasswordResult } from './auth/operations/resetPassword';
+import { Result as LoginResult } from './auth/operations/login';
+import { Options as FindGlobalOptions } from './globals/operations/local/findOne';
+import { Options as UpdateGlobalOptions } from './globals/operations/local/update';
+/**
+ * @description Payload
+ */
+export declare class BasePayload<TGeneratedTypes extends GeneratedTypes> {
+    config: SanitizedConfig;
+    collections: {
+        [slug: string | number | symbol]: Collection;
+    };
+    versions: {
+        [slug: string]: CollectionModel;
+    };
+    preferences: Preferences;
+    globals: Globals;
+    logger: pino.Logger;
+    emailOptions: EmailOptions;
+    email: BuildEmailResult;
+    sendEmail: (message: SendMailOptions) => Promise<unknown>;
+    secret: string;
+    mongoURL: string | false;
+    mongoOptions: InitOptions['mongoOptions'];
+    mongoMemoryServer: any;
+    local: boolean;
+    encrypt: typeof encrypt;
+    decrypt: typeof decrypt;
+    errorHandler: ErrorHandler;
+    authenticate: PayloadAuthenticate;
+    express?: Express;
+    router?: Router;
+    types: {
+        blockTypes: any;
+        blockInputTypes: any;
+        groupTypes: any;
+        arrayTypes: any;
+        tabTypes: any;
+        localeInputType?: any;
+        fallbackLocaleInputType?: any;
+    };
+    Query: {
+        name: string;
+        fields: {
+            [key: string]: any;
+        };
+    };
+    Mutation: {
+        name: string;
+        fields: {
+            [key: string]: any;
+        };
+    };
+    schema: GraphQLSchema;
+    extensions: (args: {
+        req: graphQLRequest<unknown, unknown>;
+        args: OperationArgs<any>;
+        result: ExecutionResult;
+    }) => Promise<any>;
+    validationRules: (args: OperationArgs<any>) => ValidationRule[];
+    getAdminURL: () => string;
+    getAPIURL: () => string;
+    /**
+     * @description Initializes Payload
+     * @param options
+     */
+    init(options: InitOptions): Promise<Payload>;
+    /**
+     * @description Performs create operation
+     * @param options
+     * @returns created document
+     */
+    create: <T extends keyof TGeneratedTypes["collections"]>(options: CreateOptions<T>) => Promise<TGeneratedTypes["collections"][T]>;
+    /**
+     * @description Find documents with criteria
+     * @param options
+     * @returns documents satisfying query
+     */
+    find: <T extends keyof TGeneratedTypes["collections"]>(options: FindOptions<T>) => Promise<PaginatedDocs<TGeneratedTypes["collections"][T]>>;
+    /**
+     * @description Find document by ID
+     * @param options
+     * @returns document with specified ID
+     */
+    findByID: <T extends keyof TGeneratedTypes["collections"]>(options: FindByIDOptions<T>) => Promise<TGeneratedTypes["collections"][T]>;
+    /**
+     * @description Update one or more documents
+     * @param options
+     * @returns Updated document(s)
+     */
+    update<T extends keyof TGeneratedTypes['collections']>(options: UpdateByIDOptions<T>): Promise<TGeneratedTypes['collections'][T]>;
+    update<T extends keyof TGeneratedTypes['collections']>(options: UpdateManyOptions<T>): Promise<BulkOperationResult<T>>;
+    /**
+     * @description delete one or more documents
+     * @param options
+     * @returns Updated document(s)
+     */
+    delete<T extends keyof TGeneratedTypes['collections']>(options: DeleteByIDOptions<T>): Promise<TGeneratedTypes['collections'][T]>;
+    delete<T extends keyof TGeneratedTypes['collections']>(options: DeleteManyOptions<T>): Promise<BulkOperationResult<T>>;
+    /**
+     * @description Find versions with criteria
+     * @param options
+     * @returns versions satisfying query
+     */
+    findVersions: <T extends keyof TGeneratedTypes["collections"]>(options: FindVersionsOptions<T>) => Promise<PaginatedDocs<TypeWithVersion<TGeneratedTypes["collections"][T]>>>;
+    /**
+     * @description Find version by ID
+     * @param options
+     * @returns version with specified ID
+     */
+    findVersionByID: <T extends keyof TGeneratedTypes["collections"]>(options: FindVersionByIDOptions<T>) => Promise<TypeWithVersion<TGeneratedTypes["collections"][T]>>;
+    /**
+     * @description Restore version by ID
+     * @param options
+     * @returns version with specified ID
+     */
+    restoreVersion: <T extends keyof TGeneratedTypes["collections"]>(options: RestoreVersionOptions<T>) => Promise<TGeneratedTypes["collections"][T]>;
+    login: <T extends keyof TGeneratedTypes["collections"]>(options: LoginOptions<T>) => Promise<LoginResult & {
+        user: TGeneratedTypes["collections"][T];
+    }>;
+    forgotPassword: <T extends keyof TGeneratedTypes["collections"]>(options: ForgotPasswordOptions<T>) => Promise<ForgotPasswordResult>;
+    resetPassword: <T extends keyof TGeneratedTypes["collections"]>(options: ResetPasswordOptions<T>) => Promise<ResetPasswordResult>;
+    unlock: <T extends keyof TGeneratedTypes["collections"]>(options: UnlockOptions<T>) => Promise<boolean>;
+    verifyEmail: <T extends keyof TGeneratedTypes["collections"]>(options: VerifyEmailOptions<T>) => Promise<boolean>;
+    findGlobal: <T extends keyof TGeneratedTypes["globals"]>(options: FindGlobalOptions<T>) => Promise<TGeneratedTypes["globals"][T]>;
+    updateGlobal: <T extends keyof TGeneratedTypes["globals"]>(options: UpdateGlobalOptions<T>) => Promise<TGeneratedTypes["globals"][T]>;
+    /**
+     * @description Find global versions with criteria
+     * @param options
+     * @returns versions satisfying query
+     */
+    findGlobalVersions: <T extends keyof TGeneratedTypes["globals"]>(options: FindGlobalVersionsOptions<T>) => Promise<PaginatedDocs<TypeWithVersion<TGeneratedTypes["globals"][T]>>>;
+    /**
+     * @description Find global version by ID
+     * @param options
+     * @returns global version with specified ID
+     */
+    findGlobalVersionByID: <T extends keyof TGeneratedTypes["globals"]>(options: FindGlobalVersionByIDOptions<T>) => Promise<TypeWithVersion<TGeneratedTypes["globals"][T]>>;
+    /**
+     * @description Restore global version by ID
+     * @param options
+     * @returns version with specified ID
+     */
+    restoreGlobalVersion: <T extends keyof TGeneratedTypes["globals"]>(options: RestoreGlobalVersionOptions<T>) => Promise<TGeneratedTypes["globals"][T]>;
+}
+export type Payload = BasePayload<GeneratedTypes>;
+export declare const getPayload: (options: InitOptions) => Promise<Payload>;