payload 0.20.0 → 0.20.3-beta.0

package/dist/index.d.ts

@@ -0,0 +1,165 @@
+import { Express, Router } from 'express';
+import pino from 'pino';
+import { GraphQLError, GraphQLFormattedError, GraphQLSchema } from 'graphql';
+import { TypeWithID, 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, TypeWithID as GlobalTypeWithID } 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 Payload {
+    config: SanitizedConfig;
+    collections: {
+        [slug: string]: Collection;
+    };
+    versions: {
+        [slug: string]: CollectionModel;
+    };
+    preferences: Preferences;
+    globals: Globals;
+    logger: pino.Logger;
+    express: Express;
+    router: Router;
+    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;
+    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;
+    /**
+     * @description Initializes Payload
+     * @param options
+     */
+    init(options: InitOptions): Promise<void>;
+    getAdminURL: () => string;
+    getAPIURL: () => string;
+    /**
+     * @description Performs create operation
+     * @param options
+     * @returns created document
+     */
+    create: <T = any>(options: CreateOptions<T>) => Promise<T>;
+    /**
+     * @description Find documents with criteria
+     * @param options
+     * @returns documents satisfying query
+     */
+    find: <T extends TypeWithID = any>(options: FindOptions) => Promise<PaginatedDocs<T>>;
+    findGlobal: <T extends GlobalTypeWithID = any>(options: FindGlobalOptions) => Promise<T>;
+    updateGlobal: <T extends GlobalTypeWithID = any>(options: UpdateGlobalOptions) => Promise<T>;
+    /**
+     * @description Find global versions with criteria
+     * @param options
+     * @returns versions satisfying query
+     */
+    findGlobalVersions: <T extends TypeWithVersion<T> = any>(options: FindGlobalVersionsOptions) => Promise<PaginatedDocs<T>>;
+    /**
+     * @description Find global version by ID
+     * @param options
+     * @returns global version with specified ID
+     */
+    findGlobalVersionByID: <T extends TypeWithVersion<T> = any>(options: FindGlobalVersionByIDOptions) => Promise<T>;
+    /**
+     * @description Restore global version by ID
+     * @param options
+     * @returns version with specified ID
+     */
+    restoreGlobalVersion: <T extends TypeWithVersion<T> = any>(options: RestoreGlobalVersionOptions) => Promise<T>;
+    /**
+     * @description Find document by ID
+     * @param options
+     * @returns document with specified ID
+     */
+    findByID: <T extends TypeWithID = any>(options: FindByIDOptions) => Promise<T>;
+    /**
+     * @description Update document
+     * @param options
+     * @returns Updated document
+     */
+    update: <T = any>(options: UpdateOptions<T>) => Promise<T>;
+    delete: <T extends TypeWithID = any>(options: DeleteOptions) => Promise<T>;
+    /**
+     * @description Find versions with criteria
+     * @param options
+     * @returns versions satisfying query
+     */
+    findVersions: <T extends TypeWithVersion<T> = any>(options: FindVersionsOptions) => Promise<PaginatedDocs<T>>;
+    /**
+     * @description Find version by ID
+     * @param options
+     * @returns version with specified ID
+     */
+    findVersionByID: <T extends TypeWithVersion<T> = any>(options: FindVersionByIDOptions) => Promise<T>;
+    /**
+     * @description Restore version by ID
+     * @param options
+     * @returns version with specified ID
+     */
+    restoreVersion: <T extends TypeWithVersion<T> = any>(options: RestoreVersionOptions) => Promise<T>;
+    login: <T extends TypeWithID = any>(options: LoginOptions) => Promise<LoginResult & {
+        user: T;
+    }>;
+    forgotPassword: (options: ForgotPasswordOptions) => Promise<ForgotPasswordResult>;
+    resetPassword: (options: ResetPasswordOptions) => Promise<ResetPasswordResult>;
+    unlock: (options: UnlockOptions) => Promise<boolean>;
+    verifyEmail: (options: VerifyEmailOptions) => Promise<boolean>;
+}
+declare const payload: Payload;
+export default payload;

package/dist/index.js

@@ -0,0 +1,247 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Payload = void 0;
+const express_1 = __importDefault(require("express"));
+const crypto_1 = __importDefault(require("crypto"));
+const logger_1 = __importDefault(require("./utilities/logger"));
+const load_1 = __importDefault(require("./config/load"));
+const authenticate_1 = __importDefault(require("./express/middleware/authenticate"));
+const connect_1 = __importDefault(require("./mongoose/connect"));
+const middleware_1 = __importDefault(require("./express/middleware"));
+const admin_1 = __importDefault(require("./express/admin"));
+const init_1 = __importDefault(require("./auth/init"));
+const access_1 = __importDefault(require("./auth/requestHandlers/access"));
+const init_2 = __importDefault(require("./collections/init"));
+const init_3 = __importDefault(require("./preferences/init"));
+const init_4 = __importDefault(require("./globals/init"));
+const initPlayground_1 = __importDefault(require("./graphql/initPlayground"));
+const static_1 = __importDefault(require("./express/static"));
+const registerSchema_1 = __importDefault(require("./graphql/registerSchema"));
+const graphQLHandler_1 = __importDefault(require("./graphql/graphQLHandler"));
+const build_1 = __importDefault(require("./email/build"));
+const identifyAPI_1 = __importDefault(require("./express/middleware/identifyAPI"));
+const errorHandler_1 = __importDefault(require("./express/middleware/errorHandler"));
+const local_1 = __importDefault(require("./collections/operations/local"));
+const local_2 = __importDefault(require("./globals/operations/local"));
+const crypto_2 = require("./auth/crypto");
+const sendEmail_1 = __importDefault(require("./email/sendEmail"));
+const serverInit_1 = require("./utilities/telemetry/events/serverInit");
+require('isomorphic-fetch');
+/**
+ * @description Payload
+ */
+class Payload {
+    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);
+        };
+        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 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);
+        };
+    }
+    /**
+     * @description Initializes Payload
+     * @param options
+     */
+    async init(options) {
+        this.logger = (0, logger_1.default)('payload', options.loggerOptions);
+        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.mongoURL = options.mongoURL;
+        this.local = options.local;
+        this.config = (0, load_1.default)(this.logger);
+        // Connect to database
+        if (this.mongoURL) {
+            this.mongoMemoryServer = await (0, connect_1.default)(this.mongoURL, options.mongoOptions, this.logger);
+        }
+        // If not initializing locally, scaffold router
+        if (!this.local) {
+            this.router = express_1.default.Router();
+            this.router.use(...(0, middleware_1.default)(this));
+            (0, init_1.default)(this);
+        }
+        // Configure email service
+        this.email = (0, build_1.default)(this.emailOptions, this.logger);
+        this.sendEmail = sendEmail_1.default.bind(this);
+        // Initialize collections & globals
+        (0, init_2.default)(this);
+        (0, init_4.default)(this);
+        if (!this.config.graphQL.disable) {
+            (0, registerSchema_1.default)(this);
+        }
+        // If not initializing locally, set up HTTP routing
+        if (!this.local) {
+            options.express.use((req, res, next) => {
+                req.payload = this;
+                next();
+            });
+            this.express = options.express;
+            if (this.config.rateLimit.trustProxy) {
+                this.express.set('trust proxy', 1);
+            }
+            (0, admin_1.default)(this);
+            (0, init_3.default)(this);
+            this.router.get('/access', access_1.default);
+            if (!this.config.graphQL.disable) {
+                this.router.use(this.config.routes.graphQL, (0, identifyAPI_1.default)('GraphQL'), (req, res) => (0, graphQLHandler_1.default)(req, res)(req, res));
+                (0, initPlayground_1.default)(this);
+            }
+            // Bind router to API
+            this.express.use(this.config.routes.api, this.router);
+            // Enable static routes for all collections permitting upload
+            (0, static_1.default)(this);
+            this.errorHandler = (0, errorHandler_1.default)(this.config, this.logger);
+            this.router.use(this.errorHandler);
+            this.authenticate = (0, authenticate_1.default)(this.config);
+        }
+        if (typeof options.onInit === 'function')
+            await options.onInit(this);
+        if (typeof this.config.onInit === 'function')
+            await this.config.onInit(this);
+        (0, serverInit_1.serverInit)(this);
+    }
+}
+exports.Payload = Payload;
+const payload = new Payload();
+exports.default = payload;
+module.exports = payload;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA6D;AAE7D,oDAA4B;AAe5B,gEAAwC;AACxC,yDAAuC;AACvC,qFAAsF;AACtF,iEAAiD;AACjD,sEAAqD;AACrD,4DAAwC;AACxC,uDAAmC;AACnC,2EAAmD;AACnD,8DAAiD;AACjD,8DAAiD;AACjD,0DAAyC;AAEzC,8EAA6D;AAC7D,8DAA0C;AAC1C,8EAAsD;AACtD,8EAAsD;AACtD,0DAAuC;AACvC,mFAA2D;AAC3D,qFAA+E;AAC/E,2EAA6D;AAC7D,uEAA+D;AAC/D,0CAAiD;AAGjD,kEAA0C;AAwB1C,wEAA4F;AAE5F,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAE5B;;GAEG;AACH,MAAa,OAAO;IAApB;QAGE,gBAAW,GAEP,EAAE,CAAA;QAEN,aAAQ,GAEJ,EAAE,CAAA;QA0BN,YAAO,GAAG,gBAAO,CAAC;QAElB,YAAO,GAAG,gBAAO,CAAC;QAalB,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;QAqG7C,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;QAE9E;;;;WAIG;QACH,WAAM,GAAG,KAAK,EAAW,OAAyB,EAAc,EAAE;YAChE,MAAM,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC;YACnC,OAAO,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC/B,CAAC,CAAA;QAED;;;;WAIG;QACH,SAAI,GAAG,KAAK,EAA8B,OAAoB,EAA6B,EAAE;YAC3F,MAAM,EAAE,IAAI,EAAE,GAAG,eAAe,CAAC;YACjC,OAAO,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7B,CAAC,CAAA;QAED,eAAU,GAAG,KAAK,EAAoC,OAA0B,EAAc,EAAE;YAC9F,MAAM,EAAE,OAAO,EAAE,GAAG,eAAqB,CAAC;YAC1C,OAAO,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAChC,CAAC,CAAA;QAED,iBAAY,GAAG,KAAK,EAAoC,OAA4B,EAAc,EAAE;YAClG,MAAM,EAAE,MAAM,EAAE,GAAG,eAAqB,CAAC;YACzC,OAAO,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC/B,CAAC,CAAA;QAED;;;;WAIG;QACH,uBAAkB,GAAG,KAAK,EAAsC,OAAkC,EAA6B,EAAE;YAC/H,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,EAAsC,OAAqC,EAAc,EAAE;YACtH,MAAM,EAAE,eAAe,EAAE,GAAG,eAAqB,CAAC;YAClD,OAAO,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACxC,CAAC,CAAA;QAED;;;;WAIG;QACH,yBAAoB,GAAG,KAAK,EAAsC,OAAoC,EAAc,EAAE;YACpH,MAAM,EAAE,cAAc,EAAE,GAAG,eAAqB,CAAC;YACjD,OAAO,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACvC,CAAC,CAAA;QAED;;;;WAIG;QACH,aAAQ,GAAG,KAAK,EAA8B,OAAwB,EAAc,EAAE;YACpF,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,EAAW,OAAyB,EAAc,EAAE;YAChE,MAAM,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC;YACnC,OAAO,MAAM,CAAI,IAAI,EAAE,OAAO,CAAC,CAAC;QAClC,CAAC,CAAA;QAED,WAAM,GAAG,KAAK,EAA8B,OAAsB,EAAc,EAAE;YAChF,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,EAAsC,OAA4B,EAA6B,EAAE;YACnH,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,EAAsC,OAA+B,EAAc,EAAE;YAC1G,MAAM,EAAE,eAAe,EAAE,GAAG,eAAe,CAAC;YAC5C,OAAO,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACxC,CAAC,CAAA;QAED;;;;WAIG;QACH,mBAAc,GAAG,KAAK,EAAsC,OAA8B,EAAc,EAAE;YACxG,MAAM,EAAE,cAAc,EAAE,GAAG,eAAe,CAAC;YAC3C,OAAO,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACvC,CAAC,CAAA;QAED,UAAK,GAAG,KAAK,EAA8B,OAAqB,EAAqC,EAAE;YACrG,MAAM,EAAE,KAAK,EAAE,GAAG,eAAe,CAAC,IAAI,CAAC;YACvC,OAAO,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC9B,CAAC,CAAA;QAED,mBAAc,GAAG,KAAK,EAAE,OAA8B,EAAiC,EAAE;YACvF,MAAM,EAAE,cAAc,EAAE,GAAG,eAAe,CAAC,IAAI,CAAC;YAChD,OAAO,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACvC,CAAC,CAAA;QAED,kBAAa,GAAG,KAAK,EAAE,OAA6B,EAAgC,EAAE;YACpF,MAAM,EAAE,aAAa,EAAE,GAAG,eAAe,CAAC,IAAI,CAAC;YAC/C,OAAO,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACtC,CAAC,CAAA;QAED,WAAM,GAAG,KAAK,EAAE,OAAsB,EAAoB,EAAE;YAC1D,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,EAAE,OAA2B,EAAoB,EAAE;YACpE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,CAAC,IAAI,CAAC;YAC7C,OAAO,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACpC,CAAC,CAAA;IACH,CAAC;IAhPC;;;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,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,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAE3B,IAAI,CAAC,MAAM,GAAG,IAAA,cAAU,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEtC,sBAAsB;QACtB,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,IAAI,CAAC,iBAAiB,GAAG,MAAM,IAAA,iBAAe,EAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;SAClG;QAED,+CAA+C;QAC/C,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,IAAI,CAAC,MAAM,GAAG,iBAAO,CAAC,MAAM,EAAE,CAAC;YAC/B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAA,oBAAiB,EAAC,IAAI,CAAC,CAAC,CAAC;YAC5C,IAAA,cAAQ,EAAC,IAAI,CAAC,CAAC;SAChB;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,cAAe,EAAC,IAAI,CAAC,CAAC;QACtB,IAAA,cAAW,EAAC,IAAI,CAAC,CAAC;QAElB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE;YAChC,IAAA,wBAAc,EAAC,IAAI,CAAC,CAAC;SACtB;QACD,mDAAmD;QACnD,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAmB,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;gBACrD,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC;gBACnB,IAAI,EAAE,CAAC;YACT,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;YAE/B,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,EAAE;gBACpC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;aACpC;YAED,IAAA,eAAS,EAAC,IAAI,CAAC,CAAC;YAChB,IAAA,cAAe,EAAC,IAAI,CAAC,CAAC;YAEtB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,gBAAM,CAAC,CAAC;YAEnC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE;gBAChC,IAAI,CAAC,MAAM,CAAC,GAAG,CACb,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAC1B,IAAA,qBAAW,EAAC,SAAS,CAAC,EACtB,CAAC,GAAmB,EAAE,GAAa,EAAE,EAAE,CAAC,IAAA,wBAAc,EAAC,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAC3E,CAAC;gBACF,IAAA,wBAAqB,EAAC,IAAI,CAAC,CAAC;aAC7B;YAED,qBAAqB;YACrB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YAEtD,6DAA6D;YAC7D,IAAA,gBAAU,EAAC,IAAI,CAAC,CAAC;YAEjB,IAAI,CAAC,YAAY,GAAG,IAAA,sBAAY,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YAC3D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAEnC,IAAI,CAAC,YAAY,GAAG,IAAA,sBAAY,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAC/C;QAED,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,UAAU;YAAE,MAAM,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACrE,IAAI,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,UAAU;YAAE,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAE7E,IAAA,uBAAmB,EAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;CAiJF;AAlTD,0BAkTC;AAED,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,kBAAe,OAAO,CAAC;AACvB,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC"}

package/dist/localization/middleware.d.ts

@@ -0,0 +1,7 @@
+/**
+ * sets request locale
+ *
+ * @param localization
+ * @returns {Function}
+ */
+export default function localizationMiddleware(localization: any): (req: any, res: any, next: any) => any;

package/dist/localization/middleware.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * sets request locale
+ *
+ * @param localization
+ * @returns {Function}
+ */
+function localizationMiddleware(localization) {
+    const middleware = (req, res, next) => {
+        if (localization) {
+            const validLocales = [...localization.locales, 'all'];
+            const validFallbackLocales = [...localization.locales, 'null'];
+            let requestedLocale = req.query.locale || localization.defaultLocale;
+            let requestedFallbackLocale = req.query['fallback-locale'] || localization.defaultLocale;
+            if (req.body) {
+                if (req.body.locale)
+                    requestedLocale = req.body.locale;
+                if (req.body['fallback-locale'])
+                    requestedFallbackLocale = req.body['fallback-locale'];
+            }
+            if (requestedFallbackLocale === 'none')
+                requestedFallbackLocale = 'null';
+            if (requestedLocale === '*' || requestedLocale === 'all')
+                requestedLocale = 'all';
+            if (validLocales.find((locale) => locale === requestedLocale)) {
+                req.locale = requestedLocale;
+            }
+            if (validFallbackLocales.find((locale) => locale === requestedFallbackLocale)) {
+                req.fallbackLocale = requestedFallbackLocale;
+            }
+        }
+        return next();
+    };
+    return middleware;
+}
+exports.default = localizationMiddleware;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWlkZGxld2FyZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9sb2NhbGl6YXRpb24vbWlkZGxld2FyZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBOzs7OztHQUtHO0FBQ0gsU0FBd0Isc0JBQXNCLENBQUMsWUFBWTtJQUN6RCxNQUFNLFVBQVUsR0FBRyxDQUFDLEdBQUcsRUFBRSxHQUFHLEVBQUUsSUFBSSxFQUFFLEVBQUU7UUFDcEMsSUFBSSxZQUFZLEVBQUU7WUFDaEIsTUFBTSxZQUFZLEdBQUcsQ0FBQyxHQUFHLFlBQVksQ0FBQyxPQUFPLEVBQUUsS0FBSyxDQUFDLENBQUM7WUFDdEQsTUFBTSxvQkFBb0IsR0FBRyxDQUFDLEdBQUcsWUFBWSxDQUFDLE9BQU8sRUFBRSxNQUFNLENBQUMsQ0FBQztZQUUvRCxJQUFJLGVBQWUsR0FBRyxHQUFHLENBQUMsS0FBSyxDQUFDLE1BQU0sSUFBSSxZQUFZLENBQUMsYUFBYSxDQUFDO1lBQ3JFLElBQUksdUJBQXVCLEdBQUcsR0FBRyxDQUFDLEtBQUssQ0FBQyxpQkFBaUIsQ0FBQyxJQUFJLFlBQVksQ0FBQyxhQUFhLENBQUM7WUFFekYsSUFBSSxHQUFHLENBQUMsSUFBSSxFQUFFO2dCQUNaLElBQUksR0FBRyxDQUFDLElBQUksQ0FBQyxNQUFNO29CQUFFLGVBQWUsR0FBRyxHQUFHLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQztnQkFDdkQsSUFBSSxHQUFHLENBQUMsSUFBSSxDQUFDLGlCQUFpQixDQUFDO29CQUFFLHVCQUF1QixHQUFHLEdBQUcsQ0FBQyxJQUFJLENBQUMsaUJBQWlCLENBQUMsQ0FBQzthQUN4RjtZQUVELElBQUksdUJBQXVCLEtBQUssTUFBTTtnQkFBRSx1QkFBdUIsR0FBRyxNQUFNLENBQUM7WUFDekUsSUFBSSxlQUFlLEtBQUssR0FBRyxJQUFJLGVBQWUsS0FBSyxLQUFLO2dCQUFFLGVBQWUsR0FBRyxLQUFLLENBQUM7WUFFbEYsSUFBSSxZQUFZLENBQUMsSUFBSSxDQUFDLENBQUMsTUFBTSxFQUFFLEVBQUUsQ0FBQyxNQUFNLEtBQUssZUFBZSxDQUFDLEVBQUU7Z0JBQzdELEdBQUcsQ0FBQyxNQUFNLEdBQUcsZUFBZSxDQUFDO2FBQzlCO1lBRUQsSUFBSSxvQkFBb0IsQ0FBQyxJQUFJLENBQUMsQ0FBQyxNQUFNLEVBQUUsRUFBRSxDQUFDLE1BQU0sS0FBSyx1QkFBdUIsQ0FBQyxFQUFFO2dCQUM3RSxHQUFHLENBQUMsY0FBYyxHQUFHLHVCQUF1QixDQUFDO2FBQzlDO1NBQ0Y7UUFFRCxPQUFPLElBQUksRUFBRSxDQUFDO0lBQ2hCLENBQUMsQ0FBQztJQUVGLE9BQU8sVUFBVSxDQUFDO0FBQ3BCLENBQUM7QUE5QkQseUNBOEJDIn0=

package/dist/localization/sanitizeFallbackLocale.d.ts

@@ -0,0 +1,2 @@
+declare const sanitizeFallbackLocale: (fallbackLocale: any) => any;
+export default sanitizeFallbackLocale;

package/dist/localization/sanitizeFallbackLocale.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const sanitizeFallbackLocale = (fallbackLocale) => {
+    if (fallbackLocale === 'null' || fallbackLocale === 'none' || fallbackLocale === 'false' || fallbackLocale === false || fallbackLocale === null) {
+        return null;
+    }
+    return fallbackLocale;
+};
+exports.default = sanitizeFallbackLocale;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2FuaXRpemVGYWxsYmFja0xvY2FsZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9sb2NhbGl6YXRpb24vc2FuaXRpemVGYWxsYmFja0xvY2FsZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLE1BQU0sc0JBQXNCLEdBQUcsQ0FBQyxjQUFjLEVBQUUsRUFBRTtJQUNoRCxJQUFJLGNBQWMsS0FBSyxNQUFNLElBQUksY0FBYyxLQUFLLE1BQU0sSUFBSSxjQUFjLEtBQUssT0FBTyxJQUFJLGNBQWMsS0FBSyxLQUFLLElBQUksY0FBYyxLQUFLLElBQUksRUFBRTtRQUMvSSxPQUFPLElBQUksQ0FBQztLQUNiO0lBRUQsT0FBTyxjQUFjLENBQUM7QUFDeEIsQ0FBQyxDQUFDO0FBRUYsa0JBQWUsc0JBQXNCLENBQUMifQ==

package/dist/mongoose/buildQuery.d.ts

@@ -0,0 +1,2 @@
+declare function buildQueryPlugin(schema: any): void;
+export default buildQueryPlugin;