payload 1.6.4-beta.0 → 1.6.4

package/dist/collections/config/types.d.ts

@@ -0,0 +1,304 @@
+/// <reference types="mongoose-aggregate-paginate-v2" />
+/// <reference types="react" />
+import { DeepRequired } from 'ts-essentials';
+import { Model, PaginateModel, AggregatePaginateModel } from 'mongoose';
+import { GraphQLInputObjectType, GraphQLNonNull, GraphQLObjectType } from 'graphql';
+import { Response } from 'express';
+import { Access, GeneratePreviewURL, EntityDescription, Endpoint } from '../../config/types';
+import { Field } from '../../fields/config/types';
+import { PayloadRequest } from '../../express/types';
+import { IncomingAuthType, Auth } from '../../auth/types';
+import { IncomingUploadType, Upload } from '../../uploads/types';
+import { IncomingCollectionVersions, SanitizedCollectionVersions } from '../../versions/types';
+type Register<T = any> = (doc: T, password: string) => T;
+interface PassportLocalModel {
+    register: Register;
+    authenticate: any;
+}
+export interface CollectionModel extends Model<any>, PaginateModel<any>, AggregatePaginateModel<any>, PassportLocalModel {
+    buildQuery: (query: unknown, locale?: string) => Record<string, unknown>;
+}
+export interface AuthCollectionModel extends CollectionModel {
+    resetPasswordToken: string;
+    resetPasswordExpiration: Date;
+}
+export type HookOperationType = 'create' | 'autosave' | 'read' | 'update' | 'delete' | 'refresh' | 'login' | 'forgotPassword';
+type CreateOrUpdateOperation = Extract<HookOperationType, 'create' | 'update'>;
+export type BeforeOperationHook = (args: {
+    args?: any;
+    /**
+     * Hook operation being performed
+     */
+    operation: HookOperationType;
+}) => any;
+export type BeforeValidateHook<T extends TypeWithID = any> = (args: {
+    data?: Partial<T>;
+    req?: PayloadRequest;
+    /**
+     * Hook operation being performed
+     */
+    operation: CreateOrUpdateOperation;
+    /**
+     * Original document before change
+     *
+     * `undefined` on 'create' operation
+     */
+    originalDoc?: T;
+}) => any;
+export type BeforeChangeHook<T extends TypeWithID = any> = (args: {
+    data: Partial<T>;
+    req: PayloadRequest;
+    /**
+     * Hook operation being performed
+     */
+    operation: CreateOrUpdateOperation;
+    /**
+     * Original document before change
+     *
+     * `undefined` on 'create' operation
+     */
+    originalDoc?: T;
+}) => any;
+export type AfterChangeHook<T extends TypeWithID = any> = (args: {
+    doc: T;
+    req: PayloadRequest;
+    previousDoc: T;
+    /**
+     * Hook operation being performed
+     */
+    operation: CreateOrUpdateOperation;
+}) => any;
+export type BeforeReadHook<T extends TypeWithID = any> = (args: {
+    doc: T;
+    req: PayloadRequest;
+    query: {
+        [key: string]: any;
+    };
+}) => any;
+export type AfterReadHook<T extends TypeWithID = any> = (args: {
+    doc: T;
+    req: PayloadRequest;
+    query?: {
+        [key: string]: any;
+    };
+    findMany?: boolean;
+}) => any;
+export type BeforeDeleteHook = (args: {
+    req: PayloadRequest;
+    id: string;
+}) => any;
+export type AfterDeleteHook<T extends TypeWithID = any> = (args: {
+    doc: T;
+    req: PayloadRequest;
+    id: string;
+}) => any;
+export type AfterErrorHook = (err: Error, res: unknown) => {
+    response: any;
+    status: number;
+} | void;
+export type BeforeLoginHook<T extends TypeWithID = any> = (args: {
+    req: PayloadRequest;
+    user: T;
+}) => any;
+export type AfterLoginHook<T extends TypeWithID = any> = (args: {
+    req: PayloadRequest;
+    user: T;
+    token: string;
+}) => any;
+export type AfterLogoutHook<T extends TypeWithID = any> = (args: {
+    req: PayloadRequest;
+    res: Response;
+}) => any;
+export type AfterMeHook<T extends TypeWithID = any> = (args: {
+    req: PayloadRequest;
+    response: unknown;
+}) => any;
+export type AfterRefreshHook<T extends TypeWithID = any> = (args: {
+    req: PayloadRequest;
+    res: Response;
+    token: string;
+    exp: number;
+}) => any;
+export type AfterForgotPasswordHook = (args: {
+    args?: any;
+}) => any;
+type BeforeDuplicateArgs<T> = {
+    data: T;
+    locale?: string;
+};
+export type BeforeDuplicate<T = any> = (args: BeforeDuplicateArgs<T>) => T | Promise<T>;
+export type CollectionAdminOptions = {
+    /**
+     * Field to use as title in Edit view and first column in List view
+     */
+    useAsTitle?: string;
+    /**
+     * Default columns to show in list view
+     */
+    defaultColumns?: string[];
+    /**
+     * Additional fields to be searched via the full text search
+     */
+    listSearchableFields?: string[];
+    hooks?: {
+        /**
+         * Function that allows you to modify a document's data before it is duplicated
+         */
+        beforeDuplicate?: BeforeDuplicate;
+    };
+    /**
+     * Place collections into a navigational group
+     * */
+    group?: Record<string, string> | string;
+    /**
+     * Custom description for collection
+     */
+    description?: EntityDescription;
+    disableDuplicate?: boolean;
+    /**
+     * Hide the API URL within the Edit view
+     */
+    hideAPIURL?: boolean;
+    /**
+     * Custom admin components
+     */
+    components?: {
+        views?: {
+            Edit?: React.ComponentType<any>;
+            List?: React.ComponentType<any>;
+        };
+    };
+    pagination?: {
+        defaultLimit?: number;
+        limits?: number[];
+    };
+    enableRichTextRelationship?: boolean;
+    /**
+     * Function to generate custom preview URL
+     */
+    preview?: GeneratePreviewURL;
+};
+/** Manage all aspects of a data collection */
+export type CollectionConfig = {
+    slug: string;
+    /**
+     * Label configuration
+     */
+    labels?: {
+        singular?: Record<string, string> | string;
+        plural?: Record<string, string> | string;
+    };
+    /**
+     * GraphQL configuration
+     */
+    graphQL?: {
+        singularName?: string;
+        pluralName?: string;
+    };
+    /**
+     * Options used in typescript generation
+     */
+    typescript?: {
+        /**
+         * Typescript generation name given to the interface type
+         */
+        interface?: string;
+    };
+    fields: Field[];
+    /**
+     * Collection admin options
+     */
+    admin?: CollectionAdminOptions;
+    /**
+     * Hooks to modify Payload functionality
+     */
+    hooks?: {
+        beforeOperation?: BeforeOperationHook[];
+        beforeValidate?: BeforeValidateHook[];
+        beforeChange?: BeforeChangeHook[];
+        afterChange?: AfterChangeHook[];
+        beforeRead?: BeforeReadHook[];
+        afterRead?: AfterReadHook[];
+        beforeDelete?: BeforeDeleteHook[];
+        afterDelete?: AfterDeleteHook[];
+        afterError?: AfterErrorHook;
+        beforeLogin?: BeforeLoginHook[];
+        afterLogin?: AfterLoginHook[];
+        afterLogout?: AfterLogoutHook[];
+        afterMe?: AfterMeHook[];
+        afterRefresh?: AfterRefreshHook[];
+        afterForgotPassword?: AfterForgotPasswordHook[];
+    };
+    /**
+     * Custom rest api endpoints
+     */
+    endpoints?: Omit<Endpoint, 'root'>[];
+    /**
+     * Access control
+     */
+    access?: {
+        create?: Access;
+        read?: Access;
+        readVersions?: Access;
+        update?: Access;
+        delete?: Access;
+        admin?: (args?: any) => boolean | Promise<boolean>;
+        unlock?: Access;
+    };
+    /**
+     * Collection login options
+     *
+     * Use `true` to enable with default options
+     */
+    auth?: IncomingAuthType | boolean;
+    /**
+     * Customize the handling of incoming file uploads
+     *
+     * @default false // disable uploads
+     */
+    upload?: IncomingUploadType | boolean;
+    /**
+     * Customize the handling of incoming file uploads
+     *
+     * @default false // disable versioning
+     */
+    versions?: IncomingCollectionVersions | boolean;
+    /**
+     * Add `createdAt` and `updatedAt` fields
+     *
+     * @default true
+     */
+    timestamps?: boolean;
+};
+export interface SanitizedCollectionConfig extends Omit<DeepRequired<CollectionConfig>, 'auth' | 'upload' | 'fields' | 'versions'> {
+    auth: Auth;
+    upload: Upload;
+    fields: Field[];
+    versions: SanitizedCollectionVersions;
+}
+export type Collection = {
+    Model: CollectionModel;
+    config: SanitizedCollectionConfig;
+    graphQL?: {
+        type: GraphQLObjectType;
+        JWT: GraphQLObjectType;
+        versionType: GraphQLObjectType;
+        whereInputType: GraphQLInputObjectType;
+        mutationInputType: GraphQLNonNull<any>;
+        updateMutationInputType: GraphQLNonNull<any>;
+    };
+};
+export type AuthCollection = {
+    Model: AuthCollectionModel;
+    config: SanitizedCollectionConfig;
+};
+export type TypeWithID = {
+    id: string | number;
+};
+export type TypeWithTimestamps = {
+    id: string | number;
+    createdAt: string;
+    updatedAt: string;
+    [key: string]: unknown;
+};
+export {};

package/dist/collections/config/types.js

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

package/dist/collections/config/types.js.map

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

package/dist/collections/dataloader.d.ts

@@ -0,0 +1,4 @@
+import DataLoader from 'dataloader';
+import { PayloadRequest } from '../express/types';
+import { TypeWithID } from './config/types';
+export declare const getDataLoader: (req: PayloadRequest) => DataLoader<string, TypeWithID, string>;

package/dist/collections/dataloader.js

@@ -0,0 +1,98 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDataLoader = void 0;
+const dataloader_1 = __importDefault(require("dataloader"));
+const isValidID_1 = require("../utilities/isValidID");
+const getIDType_1 = require("../utilities/getIDType");
+const types_1 = require("../fields/config/types");
+// Payload uses `dataloader` to solve the classic GraphQL N+1 problem.
+// We keep a list of all documents requested to be populated for any given request
+// and then batch together documents within the same collection,
+// making only 1 find per each collection, rather than `findByID` per each requested doc.
+// This dramatically improves performance for REST and Local API `depth` populations,
+// and also ensures complex GraphQL queries perform lightning-fast.
+const batchAndLoadDocs = (req) => async (keys) => {
+    const { payload } = req;
+    // Create docs array of same length as keys, using null as value
+    // We will replace nulls with injected docs as they are retrieved
+    const docs = keys.map(() => null);
+    // Batch IDs by their `find` args
+    // so we can make one find query per combination of collection, depth, locale, and fallbackLocale.
+    // Resulting shape will be as follows:
+    // {
+    //   // key is stringified set of find args
+    //   '["pages",2,0,"es","en",false,false]': [
+    //     // value is array of IDs to find with these args
+    //     'q34tl23462346234524',
+    //     '435523540194324280',
+    //     '2346245j35l3j5234532li',
+    //   ],
+    //   // etc
+    // };
+    const batchByFindArgs = keys.reduce((batches, key) => {
+        var _a;
+        const [collection, id, depth, currentDepth, locale, fallbackLocale, overrideAccess, showHiddenFields] = JSON.parse(key);
+        const batchKeyArray = [
+            collection,
+            depth,
+            currentDepth,
+            locale,
+            fallbackLocale,
+            overrideAccess,
+            showHiddenFields,
+        ];
+        const batchKey = JSON.stringify(batchKeyArray);
+        const idField = (_a = payload.collections) === null || _a === void 0 ? void 0 : _a[collection].config.fields.find((field) => (0, types_1.fieldAffectsData)(field) && field.name === 'id');
+        if ((0, isValidID_1.isValidID)(id, (0, getIDType_1.getIDType)(idField))) {
+            return {
+                ...batches,
+                [batchKey]: [
+                    ...batches[batchKey] || [],
+                    id,
+                ],
+            };
+        }
+        return batches;
+    }, {});
+    // Run find requests in parallel
+    const results = Object.entries(batchByFindArgs).map(async ([batchKey, ids]) => {
+        const [collection, depth, currentDepth, locale, fallbackLocale, overrideAccess, showHiddenFields] = JSON.parse(batchKey);
+        const result = await payload.find({
+            collection,
+            locale,
+            fallbackLocale,
+            depth,
+            currentDepth,
+            pagination: false,
+            where: {
+                id: {
+                    in: ids,
+                },
+            },
+            overrideAccess: Boolean(overrideAccess),
+            showHiddenFields: Boolean(showHiddenFields),
+            disableErrors: true,
+            req,
+        });
+        // For each returned doc, find index in original keys
+        // Inject doc within docs array if index exists
+        result.docs.forEach((doc) => {
+            const docKey = JSON.stringify([collection, doc.id, depth, currentDepth, locale, fallbackLocale, overrideAccess, showHiddenFields]);
+            const docsIndex = keys.findIndex((key) => key === docKey);
+            if (docsIndex > -1) {
+                docs[docsIndex] = doc;
+            }
+        });
+    });
+    await Promise.all(results);
+    // Return docs array,
+    // which has now been injected with all fetched docs
+    // and should match the length of the incoming keys arg
+    return docs;
+};
+const getDataLoader = (req) => new dataloader_1.default(batchAndLoadDocs(req));
+exports.getDataLoader = getDataLoader;
+//# sourceMappingURL=dataloader.js.map

package/dist/collections/dataloader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataloader.js","sourceRoot":"","sources":["../../src/collections/dataloader.ts"],"names":[],"mappings":";;;;;;AAAA,4DAAqD;AAGrD,sDAAmD;AACnD,sDAAmD;AACnD,kDAA0D;AAE1D,sEAAsE;AAEtE,kFAAkF;AAClF,gEAAgE;AAChE,yFAAyF;AAEzF,qFAAqF;AACrF,mEAAmE;AAEnE,MAAM,gBAAgB,GAAG,CAAC,GAAmB,EAAmC,EAAE,CAAC,KAAK,EAAE,IAAc,EAAyB,EAAE;IACjI,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,CAAC;IAExB,gEAAgE;IAChE,iEAAiE;IACjE,MAAM,IAAI,GAA0B,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;IAEzD,iCAAiC;IACjC,kGAAkG;IAElG,sCAAsC;IAEtC,IAAI;IACJ,2CAA2C;IAC3C,6CAA6C;IAC7C,uDAAuD;IACvD,6BAA6B;IAC7B,4BAA4B;IAC5B,gCAAgC;IAChC,OAAO;IACP,WAAW;IACX,KAAK;IAEL,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE;;QACnD,MAAM,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,gBAAgB,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAExH,MAAM,aAAa,GAAG;YACpB,UAAU;YACV,KAAK;YACL,YAAY;YACZ,MAAM;YACN,cAAc;YACd,cAAc;YACd,gBAAgB;SACjB,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAE/C,MAAM,OAAO,GAAG,MAAA,OAAO,CAAC,WAAW,0CAAG,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,wBAAgB,EAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAEhI,IAAI,IAAA,qBAAS,EAAC,EAAE,EAAE,IAAA,qBAAS,EAAC,OAAO,CAAC,CAAC,EAAE;YACrC,OAAO;gBACL,GAAG,OAAO;gBACV,CAAC,QAAQ,CAAC,EAAE;oBACV,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;oBAC1B,EAAE;iBACH;aACF,CAAC;SACH;QACD,OAAO,OAAO,CAAC;IACjB,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,gCAAgC;IAEhC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE,EAAE;QAC5E,MAAM,CAAC,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,gBAAgB,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAEzH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC;YAChC,UAAU;YACV,MAAM;YACN,cAAc;YACd,KAAK;YACL,YAAY;YACZ,UAAU,EAAE,KAAK;YACjB,KAAK,EAAE;gBACL,EAAE,EAAE;oBACF,EAAE,EAAE,GAAG;iBACR;aACF;YACD,cAAc,EAAE,OAAO,CAAC,cAAc,CAAC;YACvC,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,CAAC;YAC3C,aAAa,EAAE,IAAI;YACnB,GAAG;SACJ,CAAC,CAAC;QAEH,qDAAqD;QACrD,+CAA+C;QAE/C,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YAC1B,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,gBAAgB,CAAC,CAAC,CAAC;YACnI,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,MAAM,CAAC,CAAC;YAE1D,IAAI,SAAS,GAAG,CAAC,CAAC,EAAE;gBAClB,IAAI,CAAC,SAAS,CAAC,GAAG,GAAG,CAAC;aACvB;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAE3B,qBAAqB;IACrB,oDAAoD;IACpD,uDAAuD;IACvD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEK,MAAM,aAAa,GAAG,CAAC,GAAmB,EAAE,EAAE,CAAC,IAAI,oBAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;AAA/E,QAAA,aAAa,iBAAkE"}

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

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