payload 1.6.4-beta.0 → 1.6.4

package/dist/mongoose/operatorMap.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.operatorMap = void 0;
+exports.operatorMap = {
+    greater_than_equal: '$gte',
+    less_than_equal: '$lte',
+    less_than: '$lt',
+    greater_than: '$gt',
+    in: '$in',
+    all: '$all',
+    not_in: '$nin',
+    not_equals: '$ne',
+    exists: '$exists',
+    equals: '$eq',
+    near: '$near',
+};
+//# sourceMappingURL=operatorMap.js.map

package/dist/mongoose/operatorMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operatorMap.js","sourceRoot":"","sources":["../../src/mongoose/operatorMap.ts"],"names":[],"mappings":";;;AAAa,QAAA,WAAW,GAAG;IACzB,kBAAkB,EAAE,MAAM;IAC1B,eAAe,EAAE,MAAM;IACvB,SAAS,EAAE,KAAK;IAChB,YAAY,EAAE,KAAK;IACnB,EAAE,EAAE,KAAK;IACT,GAAG,EAAE,MAAM;IACX,MAAM,EAAE,MAAM;IACd,UAAU,EAAE,KAAK;IACjB,MAAM,EAAE,SAAS;IACjB,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,OAAO;CACd,CAAC"}

package/dist/mongoose/sanitizeFormattedValue.d.ts

@@ -0,0 +1,2 @@
+import { SchemaType } from 'mongoose';
+export declare const sanitizeQueryValue: (schemaType: SchemaType, path: string, operator: string, val: any) => unknown;

package/dist/mongoose/sanitizeFormattedValue.js

@@ -0,0 +1,101 @@
+"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 getSchemaTypeOptions_1 = require("./getSchemaTypeOptions");
+const wordBoundariesRegex_1 = __importDefault(require("../utilities/wordBoundariesRegex"));
+const sanitizeQueryValue = (schemaType, path, operator, val) => {
+    let formattedValue = val;
+    const schemaOptions = (0, getSchemaTypeOptions_1.getSchemaTypeOptions)(schemaType);
+    // Disregard invalid _ids
+    if (path === '_id' && typeof val === 'string' && val.split(',').length === 1) {
+        if ((schemaType === null || schemaType === void 0 ? void 0 : schemaType.instance) === 'ObjectID') {
+            const isValid = mongoose_1.default.Types.ObjectId.isValid(val);
+            if (!isValid) {
+                return undefined;
+            }
+        }
+        if ((schemaType === null || schemaType === void 0 ? void 0 : schemaType.instance) === 'Number') {
+            const parsedNumber = parseFloat(val);
+            if (Number.isNaN(parsedNumber)) {
+                return undefined;
+            }
+        }
+    }
+    // Cast incoming values as proper searchable types
+    if ((schemaType === null || schemaType === void 0 ? void 0 : schemaType.instance) === 'Boolean' && typeof val === 'string') {
+        if (val.toLowerCase() === 'true')
+            formattedValue = true;
+        if (val.toLowerCase() === 'false')
+            formattedValue = false;
+    }
+    if ((schemaType === null || schemaType === void 0 ? void 0 : schemaType.instance) === 'Number' && typeof val === 'string') {
+        formattedValue = Number(val);
+    }
+    if (((schemaOptions === null || schemaOptions === void 0 ? void 0 : schemaOptions.ref) || (schemaOptions === null || schemaOptions === void 0 ? void 0 : schemaOptions.refPath)) && val === 'null') {
+        formattedValue = null;
+    }
+    // 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 (schemaOptions && (schemaOptions.ref || schemaOptions.refPath) && operator === 'in') {
+        if (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,
+                ];
+            }, []);
+        }
+    }
+    if (path !== '_id') {
+        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=sanitizeFormattedValue.js.map

package/dist/mongoose/sanitizeFormattedValue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sanitizeFormattedValue.js","sourceRoot":"","sources":["../../src/mongoose/sanitizeFormattedValue.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAgD;AAChD,qFAAkF;AAClF,iEAA8D;AAC9D,2FAAmE;AAE5D,MAAM,kBAAkB,GAAG,CAAC,UAAsB,EAAE,IAAY,EAAE,QAAgB,EAAE,GAAQ,EAAW,EAAE;IAC9G,IAAI,cAAc,GAAG,GAAG,CAAC;IACzB,MAAM,aAAa,GAAG,IAAA,2CAAoB,EAAC,UAAU,CAAC,CAAC;IAEvD,yBAAyB;IAEzB,IAAI,IAAI,KAAK,KAAK,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QAC5E,IAAI,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,QAAQ,MAAK,UAAU,EAAE;YACvC,MAAM,OAAO,GAAG,kBAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAErD,IAAI,CAAC,OAAO,EAAE;gBACZ,OAAO,SAAS,CAAC;aAClB;SACF;QAED,IAAI,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,QAAQ,MAAK,QAAQ,EAAE;YACrC,MAAM,YAAY,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;YAErC,IAAI,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE;gBAC9B,OAAO,SAAS,CAAC;aAClB;SACF;KACF;IAED,kDAAkD;IAElD,IAAI,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,QAAQ,MAAK,SAAS,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QACjE,IAAI,GAAG,CAAC,WAAW,EAAE,KAAK,MAAM;YAAE,cAAc,GAAG,IAAI,CAAC;QACxD,IAAI,GAAG,CAAC,WAAW,EAAE,KAAK,OAAO;YAAE,cAAc,GAAG,KAAK,CAAC;KAC3D;IAED,IAAI,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,QAAQ,MAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAChE,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;KAC9B;IAED,IAAI,CAAC,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,GAAG,MAAI,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,OAAO,CAAA,CAAC,IAAI,GAAG,KAAK,MAAM,EAAE;QACpE,cAAc,GAAG,IAAI,CAAC;KACvB;IAED,oDAAoD;IAEpD,IAAI,QAAQ,KAAK,MAAM,EAAE;QACvB,IAAI,GAAG,CAAC;QACR,IAAI,GAAG,CAAC;QACR,IAAI,WAAW,CAAC;QAChB,IAAI,WAAW,CAAC;QAEhB,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;YACjC,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,WAAW,CAAC,GAAG,cAAc,CAAC;SACvD;QAED,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE;YACtC,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,WAAW,CAAC,GAAG,IAAA,+DAA8B,EAAC,cAAc,CAAC,CAAC;SACvF;QAED,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,WAAW,IAAI,CAAC,WAAW,CAAC,EAAE;YAClD,cAAc,GAAG,SAAS,CAAC;SAC5B;aAAM;YACL,cAAc,GAAG;gBACf,SAAS,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE;aAC9E,CAAC;YAEF,IAAI,WAAW;gBAAE,cAAc,CAAC,YAAY,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;YACvE,IAAI,WAAW;gBAAE,cAAc,CAAC,YAAY,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;SACxE;KACF;IAED,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE;QACpF,cAAc,GAAG,IAAA,+DAA8B,EAAC,cAAc,CAAC,CAAC;KACjE;IAED,IAAI,aAAa,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI,aAAa,CAAC,OAAO,CAAC,IAAI,QAAQ,KAAK,IAAI,EAAE;QACtF,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;YACjC,cAAc,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,eAAe,EAAE,KAAK,EAAE,EAAE;gBAChE,MAAM,SAAS,GAAG,CAAC,KAAK,CAAC,CAAC;gBAC1B,IAAI,kBAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC;oBAAE,SAAS,CAAC,IAAI,CAAC,IAAI,kBAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;gBAE/F,MAAM,YAAY,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;gBACvC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC;oBAAE,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAE9D,OAAO;oBACL,GAAG,eAAe;oBAClB,GAAG,SAAS;iBACb,CAAC;YACJ,CAAC,EAAE,EAAE,CAAC,CAAC;SACR;KACF;IAED,IAAI,IAAI,KAAK,KAAK,EAAE;QAClB,IAAI,QAAQ,KAAK,UAAU,EAAE;YAC3B,cAAc,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC;SAC5D;QAED,IAAI,QAAQ,KAAK,MAAM,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE;YAC7D,MAAM,MAAM,GAAG,IAAA,6BAAmB,EAAC,cAAc,CAAC,CAAC;YACnD,cAAc,GAAG,EAAE,MAAM,EAAE,CAAC;SAC7B;KACF;IAED,IAAI,QAAQ,KAAK,QAAQ,EAAE;QACzB,cAAc,GAAG,CAAC,cAAc,KAAK,MAAM,IAAI,cAAc,KAAK,IAAI,CAAC,CAAC;KACzE;IAED,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;AAxGW,QAAA,kBAAkB,sBAwG7B"}

package/dist/mongoose/testCredentials.d.ts

@@ -0,0 +1,7 @@
+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

@@ -0,0 +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',
+};
+//# sourceMappingURL=testCredentials.js.map

package/dist/mongoose/testCredentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testCredentials.js","sourceRoot":"","sources":["../../src/mongoose/testCredentials.ts"],"names":[],"mappings":";;;AAAa,QAAA,KAAK,GAAG,eAAe,CAAC;AACxB,QAAA,QAAQ,GAAG,SAAS,CAAC;AACrB,QAAA,UAAU,GAAG;IACxB,GAAG,EAAE,qBAAqB;IAC1B,IAAI,EAAE,KAAK;IACX,IAAI,EAAE,eAAe;CACtB,CAAC"}

package/dist/mongoose/types.d.ts

@@ -0,0 +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;
+};

package/dist/mongoose/types.js

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

package/dist/mongoose/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/mongoose/types.ts"],"names":[],"mappings":""}

package/dist/payload.d.ts

@@ -0,0 +1,166 @@
+import pino from 'pino';
+import type { Express, Router } from 'express';
+import { GraphQLError, GraphQLFormattedError, GraphQLSchema } from 'graphql';
+import { Config as GeneratedTypes } from 'payload/generated-types';
+import { Collection, CollectionModel } from './collections/config/types';
+import { SanitizedConfig, EmailOptions, InitOptions } 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 { encrypt, decrypt } from './auth/crypto';
+import { BuildEmailResult, Message } 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 { Options as FindByIDOptions } from './collections/operations/local/findByID';
+import { Options as UpdateOptions } from './collections/operations/local/update';
+import { Options as DeleteOptions } from './collections/operations/local/delete';
+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: Message) => Promise<unknown>;
+    secret: string;
+    mongoURL: string | false;
+    mongoMemoryServer: any;
+    local: boolean;
+    encrypt: typeof encrypt;
+    decrypt: typeof decrypt;
+    errorHandler: ErrorHandler;
+    authenticate: PayloadAuthenticate;
+    express?: Express;
+    router?: Router;
+    types: {
+        blockTypes: any;
+        blockInputTypes: any;
+        localeInputType?: any;
+        fallbackLocaleInputType?: any;
+    };
+    Query: {
+        name: string;
+        fields: {
+            [key: string]: any;
+        };
+    };
+    Mutation: {
+        name: string;
+        fields: {
+            [key: string]: any;
+        };
+    };
+    schema: GraphQLSchema;
+    extensions: (info: any) => Promise<any>;
+    customFormatErrorFn: (error: GraphQLError) => GraphQLFormattedError;
+    validationRules: any;
+    errorResponses: GraphQLFormattedError[];
+    errorIndex: number;
+    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 document
+     * @param options
+     * @returns Updated document
+     */
+    update: <T extends keyof TGeneratedTypes["collections"]>(options: UpdateOptions<T>) => Promise<TGeneratedTypes["collections"][T]>;
+    delete: <T extends keyof TGeneratedTypes["collections"]>(options: DeleteOptions<T>) => Promise<TGeneratedTypes["collections"][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>;

package/dist/payload.js

@@ -0,0 +1,245 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPayload = exports.BasePayload = void 0;
+const crypto_1 = __importDefault(require("crypto"));
+const path_1 = __importDefault(require("path"));
+const mongoose_1 = __importDefault(require("mongoose"));
+const local_1 = __importDefault(require("./collections/operations/local"));
+const local_2 = __importDefault(require("./globals/operations/local"));
+const crypto_2 = require("./auth/crypto");
+const connect_1 = __importDefault(require("./mongoose/connect"));
+const initLocal_1 = __importDefault(require("./collections/initLocal"));
+const initLocal_2 = __importDefault(require("./globals/initLocal"));
+const registerSchema_1 = __importDefault(require("./graphql/registerSchema"));
+const build_1 = __importDefault(require("./email/build"));
+const sendEmail_1 = __importDefault(require("./email/sendEmail"));
+const serverInit_1 = require("./utilities/telemetry/events/serverInit");
+const logger_1 = __importDefault(require("./utilities/logger"));
+const model_1 = __importDefault(require("./preferences/model"));
+const find_1 = __importDefault(require("./config/find"));
+/**
+ * @description Payload
+ */
+class BasePayload {
+    constructor() {
+        this.collections = {};
+        this.versions = {};
+        this.encrypt = crypto_2.encrypt;
+        this.decrypt = crypto_2.decrypt;
+        this.Query = { name: 'Query', fields: {} };
+        this.Mutation = { name: 'Mutation', fields: {} };
+        this.errorResponses = [];
+        this.getAdminURL = () => `${this.config.serverURL}${this.config.routes.admin}`;
+        this.getAPIURL = () => `${this.config.serverURL}${this.config.routes.api}`;
+        /**
+         * @description Performs create operation
+         * @param options
+         * @returns created document
+         */
+        this.create = async (options) => {
+            const { create } = local_1.default;
+            return create(this, options);
+        };
+        /**
+         * @description Find documents with criteria
+         * @param options
+         * @returns documents satisfying query
+         */
+        this.find = async (options) => {
+            const { find } = local_1.default;
+            return find(this, options);
+        };
+        /**
+         * @description Find document by ID
+         * @param options
+         * @returns document with specified ID
+         */
+        this.findByID = async (options) => {
+            const { findByID } = local_1.default;
+            return findByID(this, options);
+        };
+        /**
+         * @description Update document
+         * @param options
+         * @returns Updated document
+         */
+        this.update = async (options) => {
+            const { update } = local_1.default;
+            return update(this, options);
+        };
+        this.delete = async (options) => {
+            const { localDelete } = local_1.default;
+            return localDelete(this, options);
+        };
+        /**
+         * @description Find versions with criteria
+         * @param options
+         * @returns versions satisfying query
+         */
+        this.findVersions = async (options) => {
+            const { findVersions } = local_1.default;
+            return findVersions(this, options);
+        };
+        /**
+         * @description Find version by ID
+         * @param options
+         * @returns version with specified ID
+         */
+        this.findVersionByID = async (options) => {
+            const { findVersionByID } = local_1.default;
+            return findVersionByID(this, options);
+        };
+        /**
+         * @description Restore version by ID
+         * @param options
+         * @returns version with specified ID
+         */
+        this.restoreVersion = async (options) => {
+            const { restoreVersion } = local_1.default;
+            return restoreVersion(this, options);
+        };
+        this.login = async (options) => {
+            const { login } = local_1.default.auth;
+            return login(this, options);
+        };
+        this.forgotPassword = async (options) => {
+            const { forgotPassword } = local_1.default.auth;
+            return forgotPassword(this, options);
+        };
+        this.resetPassword = async (options) => {
+            const { resetPassword } = local_1.default.auth;
+            return resetPassword(this, options);
+        };
+        this.unlock = async (options) => {
+            const { unlock } = local_1.default.auth;
+            return unlock(this, options);
+        };
+        this.verifyEmail = async (options) => {
+            const { verifyEmail } = local_1.default.auth;
+            return verifyEmail(this, options);
+        };
+        this.findGlobal = async (options) => {
+            const { findOne } = local_2.default;
+            return findOne(this, options);
+        };
+        this.updateGlobal = async (options) => {
+            const { update } = local_2.default;
+            return update(this, options);
+        };
+        /**
+         * @description Find global versions with criteria
+         * @param options
+         * @returns versions satisfying query
+         */
+        this.findGlobalVersions = async (options) => {
+            const { findVersions } = local_2.default;
+            return findVersions(this, options);
+        };
+        /**
+         * @description Find global version by ID
+         * @param options
+         * @returns global version with specified ID
+         */
+        this.findGlobalVersionByID = async (options) => {
+            const { findVersionByID } = local_2.default;
+            return findVersionByID(this, options);
+        };
+        /**
+         * @description Restore global version by ID
+         * @param options
+         * @returns version with specified ID
+         */
+        this.restoreGlobalVersion = async (options) => {
+            const { restoreVersion } = local_2.default;
+            return restoreVersion(this, options);
+        };
+    }
+    /**
+     * @description Initializes Payload
+     * @param options
+     */
+    async init(options) {
+        this.logger = (0, logger_1.default)('payload', options.loggerOptions);
+        this.mongoURL = options.mongoURL;
+        if (this.mongoURL) {
+            mongoose_1.default.set('strictQuery', false);
+            this.mongoMemoryServer = await (0, connect_1.default)(this.mongoURL, options.mongoOptions, this.logger);
+        }
+        this.logger.info('Starting Payload...');
+        if (!options.secret) {
+            throw new Error('Error: missing secret key. A secret key is needed to secure Payload.');
+        }
+        if (options.mongoURL !== false && typeof options.mongoURL !== 'string') {
+            throw new Error('Error: missing MongoDB connection URL.');
+        }
+        this.emailOptions = { ...(options.email) };
+        this.secret = crypto_1.default
+            .createHash('sha256')
+            .update(options.secret)
+            .digest('hex')
+            .slice(0, 32);
+        this.local = options.local;
+        if (options.config) {
+            this.config = options.config;
+            const configPath = (0, find_1.default)();
+            this.config = {
+                ...options.config,
+                paths: {
+                    configDir: path_1.default.dirname(configPath),
+                    config: configPath,
+                    rawConfig: configPath,
+                },
+            };
+        }
+        else {
+            // eslint-disable-next-line @typescript-eslint/no-var-requires, global-require
+            const loadConfig = require('./config/load').default;
+            this.config = loadConfig(this.logger);
+        }
+        // Configure email service
+        this.email = (0, build_1.default)(this.emailOptions, this.logger);
+        this.sendEmail = sendEmail_1.default.bind(this);
+        // Initialize collections & globals
+        (0, initLocal_1.default)(this);
+        (0, initLocal_2.default)(this);
+        if (!this.config.graphQL.disable) {
+            (0, registerSchema_1.default)(this);
+        }
+        this.preferences = { Model: model_1.default };
+        (0, serverInit_1.serverInit)(this);
+        if (options.local !== false) {
+            if (typeof options.onInit === 'function')
+                await options.onInit(this);
+            if (typeof this.config.onInit === 'function')
+                await this.config.onInit(this);
+        }
+        return this;
+    }
+}
+exports.BasePayload = BasePayload;
+let cached = global._payload;
+if (!cached) {
+    // eslint-disable-next-line no-multi-assign
+    cached = global._payload = { payload: null, promise: null };
+}
+const getPayload = async (options) => {
+    if (cached.payload) {
+        return cached.payload;
+    }
+    if (!cached.promise) {
+        cached.promise = new BasePayload().init(options);
+    }
+    try {
+        cached.payload = await cached.promise;
+    }
+    catch (e) {
+        cached.promise = null;
+        throw e;
+    }
+    return cached.payload;
+};
+exports.getPayload = getPayload;
+//# sourceMappingURL=payload.js.map

package/dist/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../src/payload.ts"],"names":[],"mappings":";;;;;;AAGA,oDAA4B;AAC5B,gDAAwB;AACxB,wDAAgC;AAiBhC,2EAA6D;AAC7D,uEAA+D;AAC/D,0CAAiD;AA0BjD,iEAAiD;AACjD,wEAAsD;AACtD,oEAA8C;AAC9C,8EAAsD;AACtD,0DAAuC;AACvC,kEAA0C;AAE1C,wEAA4F;AAC5F,gEAAwC;AACxC,gEAAmD;AACnD,yDAAuC;AAEvC;;GAEG;AACH,MAAa,WAAW;IAAxB;QAGE,gBAAW,GAEP,EAAE,CAAA;QAEN,aAAQ,GAEJ,EAAE,CAAA;QAsBN,YAAO,GAAG,gBAAO,CAAC;QAElB,YAAO,GAAG,gBAAO,CAAC;QAiBlB,UAAK,GAAqD,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QAExF,aAAQ,GAAqD,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QAU9F,mBAAc,GAA4B,EAAE,CAAC;QAI7C,gBAAW,GAAG,GAAW,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QAElF,cAAS,GAAG,GAAW,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;QA6E9E;;;;WAIG;QACH,WAAM,GAAG,KAAK,EACZ,OAAyB,EACmB,EAAE;YAC9C,MAAM,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC;YACnC,OAAO,MAAM,CAAI,IAAI,EAAE,OAAO,CAAC,CAAC;QAClC,CAAC,CAAA;QAED;;;;WAIG;QACH,SAAI,GAAG,KAAK,EACV,OAAuB,EACoC,EAAE;YAC7D,MAAM,EAAE,IAAI,EAAE,GAAG,eAAe,CAAC;YACjC,OAAO,IAAI,CAAI,IAAI,EAAE,OAAO,CAAC,CAAC;QAChC,CAAC,CAAA;QAED;;;;WAIG;QAEH,aAAQ,GAAG,KAAK,EACd,OAA2B,EACiB,EAAE;YAC9C,MAAM,EAAE,QAAQ,EAAE,GAAG,eAAe,CAAC;YACrC,OAAO,QAAQ,CAAI,IAAI,EAAE,OAAO,CAAC,CAAC;QACpC,CAAC,CAAA;QAED;;;;WAIG;QACH,WAAM,GAAG,KAAK,EACZ,OAAyB,EACmB,EAAE;YAC9C,MAAM,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC;YACnC,OAAO,MAAM,CAAI,IAAI,EAAE,OAAO,CAAC,CAAC;QAClC,CAAC,CAAA;QAED,WAAM,GAAG,KAAK,EACZ,OAAyB,EACmB,EAAE;YAC9C,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,CAAC;YACxC,OAAO,WAAW,CAAI,IAAI,EAAE,OAAO,CAAC,CAAC;QACvC,CAAC,CAAA;QAED;;;;WAIG;QACH,iBAAY,GAAG,KAAK,EAClB,OAA+B,EAC6C,EAAE;YAC9E,MAAM,EAAE,YAAY,EAAE,GAAG,eAAe,CAAC;YACzC,OAAO,YAAY,CAAI,IAAI,EAAE,OAAO,CAAC,CAAC;QACxC,CAAC,CAAA;QAED;;;;WAIG;QACH,oBAAe,GAAG,KAAK,EACrB,OAAkC,EAC2B,EAAE;YAC/D,MAAM,EAAE,eAAe,EAAE,GAAG,eAAe,CAAC;YAC5C,OAAO,eAAe,CAAI,IAAI,EAAE,OAAO,CAAC,CAAC;QAC3C,CAAC,CAAA;QAED;;;;WAIG;QACH,mBAAc,GAAG,KAAK,EACpB,OAAiC,EACW,EAAE;YAC9C,MAAM,EAAE,cAAc,EAAE,GAAG,eAAe,CAAC;YAC3C,OAAO,cAAc,CAAI,IAAI,EAAE,OAAO,CAAC,CAAC;QAC1C,CAAC,CAAA;QAED,UAAK,GAAG,KAAK,EACX,OAAwB,EAC4C,EAAE;YACtE,MAAM,EAAE,KAAK,EAAE,GAAG,eAAe,CAAC,IAAI,CAAC;YACvC,OAAO,KAAK,CAAI,IAAI,EAAE,OAAO,CAAC,CAAC;QACjC,CAAC,CAAA;QAED,mBAAc,GAAG,KAAK,EACpB,OAAiC,EACF,EAAE;YACjC,MAAM,EAAE,cAAc,EAAE,GAAG,eAAe,CAAC,IAAI,CAAC;YAChD,OAAO,cAAc,CAAI,IAAI,EAAE,OAAO,CAAC,CAAC;QAC1C,CAAC,CAAA;QAED,kBAAa,GAAG,KAAK,EACnB,OAAgC,EACF,EAAE;YAChC,MAAM,EAAE,aAAa,EAAE,GAAG,eAAe,CAAC,IAAI,CAAC;YAC/C,OAAO,aAAa,CAAI,IAAI,EAAE,OAAO,CAAC,CAAC;QACzC,CAAC,CAAA;QAED,WAAM,GAAG,KAAK,EACZ,OAAyB,EACP,EAAE;YACpB,MAAM,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC,IAAI,CAAC;YACxC,OAAO,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC/B,CAAC,CAAA;QAED,gBAAW,GAAG,KAAK,EACjB,OAA8B,EACZ,EAAE;YACpB,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,CAAC,IAAI,CAAC;YAC7C,OAAO,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACpC,CAAC,CAAA;QAED,eAAU,GAAG,KAAK,EAChB,OAA6B,EACW,EAAE;YAC1C,MAAM,EAAE,OAAO,EAAE,GAAG,eAAqB,CAAC;YAC1C,OAAO,OAAO,CAAI,IAAI,EAAE,OAAO,CAAC,CAAC;QACnC,CAAC,CAAA;QAED,iBAAY,GAAG,KAAK,EAClB,OAA+B,EACS,EAAE;YAC1C,MAAM,EAAE,MAAM,EAAE,GAAG,eAAqB,CAAC;YACzC,OAAO,MAAM,CAAI,IAAI,EAAE,OAAO,CAAC,CAAC;QAClC,CAAC,CAAA;QAED;;;;WAIG;QACH,uBAAkB,GAAG,KAAK,EACxB,OAAqC,EACmC,EAAE;YAC1E,MAAM,EAAE,YAAY,EAAE,GAAG,eAAqB,CAAC;YAC/C,OAAO,YAAY,CAAI,IAAI,EAAE,OAAO,CAAC,CAAC;QACxC,CAAC,CAAA;QAED;;;;WAIG;QACH,0BAAqB,GAAG,KAAK,EAC3B,OAAwC,EACiB,EAAE;YAC3D,MAAM,EAAE,eAAe,EAAE,GAAG,eAAqB,CAAC;YAClD,OAAO,eAAe,CAAI,IAAI,EAAE,OAAO,CAAC,CAAC;QAC3C,CAAC,CAAA;QAED;;;;WAIG;QACH,yBAAoB,GAAG,KAAK,EAC1B,OAAuC,EACC,EAAE;YAC1C,MAAM,EAAE,cAAc,EAAE,GAAG,eAAqB,CAAC;YACjD,OAAO,cAAc,CAAI,IAAI,EAAE,OAAO,CAAC,CAAC;QAC1C,CAAC,CAAA;IACH,CAAC;IA3PC;;;OAGG;IACH,KAAK,CAAC,IAAI,CAAC,OAAoB;QAC7B,IAAI,CAAC,MAAM,GAAG,IAAA,gBAAM,EAAC,SAAS,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;QACvD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QAEjC,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,kBAAQ,CAAC,GAAG,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;YACnC,IAAI,CAAC,iBAAiB,GAAG,MAAM,IAAA,iBAAe,EAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;SAClG;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QACxC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YACnB,MAAM,IAAI,KAAK,CACb,sEAAsE,CACvE,CAAC;SACH;QAED,IAAI,OAAO,CAAC,QAAQ,KAAK,KAAK,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE;YACtE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;SAC3D;QAED,IAAI,CAAC,YAAY,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3C,IAAI,CAAC,MAAM,GAAG,gBAAM;aACjB,UAAU,CAAC,QAAQ,CAAC;aACpB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;aACtB,MAAM,CAAC,KAAK,CAAC;aACb,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAEhB,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAE3B,IAAI,OAAO,CAAC,MAAM,EAAE;YAClB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAC7B,MAAM,UAAU,GAAG,IAAA,cAAU,GAAE,CAAC;YAEhC,IAAI,CAAC,MAAM,GAAG;gBACZ,GAAG,OAAO,CAAC,MAAM;gBACjB,KAAK,EAAE;oBACL,SAAS,EAAE,cAAI,CAAC,OAAO,CAAC,UAAU,CAAC;oBACnC,MAAM,EAAE,UAAU;oBAClB,SAAS,EAAE,UAAU;iBACtB;aACF,CAAC;SACH;aAAM;YACL,8EAA8E;YAC9E,MAAM,UAAU,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC;YACpD,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACvC;QAED,0BAA0B;QAC1B,IAAI,CAAC,KAAK,GAAG,IAAA,eAAU,EAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACxD,IAAI,CAAC,SAAS,GAAG,mBAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEtC,mCAAmC;QACnC,IAAA,mBAAe,EAAC,IAAI,CAAC,CAAC;QACtB,IAAA,mBAAW,EAAC,IAAI,CAAC,CAAC;QAElB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE;YAChC,IAAA,wBAAc,EAAC,IAAI,CAAC,CAAC;SACtB;QAED,IAAI,CAAC,WAAW,GAAG,EAAE,KAAK,EAAE,eAAgB,EAAE,CAAC;QAE/C,IAAA,uBAAmB,EAAC,IAAI,CAAC,CAAC;QAE1B,IAAI,OAAO,CAAC,KAAK,KAAK,KAAK,EAAE;YAC3B,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,UAAU;gBAAE,MAAM,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACrE,IAAI,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,UAAU;gBAAE,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAC9E;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CAkLF;AAjUD,kCAiUC;AAID,IAAI,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC;AAE7B,IAAI,CAAC,MAAM,EAAE;IACX,2CAA2C;IAC3C,MAAM,GAAG,MAAM,CAAC,QAAQ,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;CAC7D;AAEM,MAAM,UAAU,GAAG,KAAK,EAAE,OAAoB,EAAoB,EAAE;IACzE,IAAI,MAAM,CAAC,OAAO,EAAE;QAClB,OAAO,MAAM,CAAC,OAAO,CAAC;KACvB;IAED,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;QACnB,MAAM,CAAC,OAAO,GAAG,IAAI,WAAW,EAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;KAClE;IAED,IAAI;QACF,MAAM,CAAC,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;KACvC;IAAC,OAAO,CAAC,EAAE;QACV,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;QACtB,MAAM,CAAC,CAAC;KACT;IAED,OAAO,MAAM,CAAC,OAAO,CAAC;AACxB,CAAC,CAAC;AAjBW,QAAA,UAAU,cAiBrB"}

package/dist/preferences/graphql/init.d.ts

@@ -0,0 +1,3 @@
+import { Payload } from '../../payload';
+declare function initCollectionsGraphQL(payload: Payload): void;
+export default initCollectionsGraphQL;