@webiny/api-headless-cms 0.0.0-unstable.fcdad0bc61 → 0.0.0-unstable.fdd9228b5d

package/types/plugins.d.ts

@@ -0,0 +1,365 @@
+import type { Plugin } from "@webiny/plugins/types";
+import type { GraphQLSchemaDefinition } from "@webiny/handler-graphql/types";
+import type { CmsContext, CmsFieldTypePlugins, CmsModelFieldDefinition, CmsModelFieldToGraphQLCreateResolver, CmsModelFieldToGraphQLNormalizeInputParams, CmsModelFieldToGraphQLPluginValidateChildFields, CmsModelFieldValidatorValidateParams } from "./types";
+import type { GetCmsModelFieldAst } from "./modelAst";
+import type { CmsModelField, CmsModelFieldType, LockedField } from "./modelField";
+import type { CmsModel } from "./model";
+/**
+ * @category Plugin
+ * @category ModelField
+ * @category GraphQL
+ */
+export interface CmsModelFieldToGraphQLPlugin<TField extends CmsModelField = CmsModelField> extends Plugin {
+    /**
+     * A plugin type
+     */
+    type: "cms-model-field-to-graphql";
+    /**
+     * Field type name which must be exact as the one in `CmsEditorFieldTypePlugin` plugin.
+     *
+     * ```ts
+     * fieldType: "myField"
+     * ```
+     */
+    fieldType: CmsModelFieldType;
+    /**
+     * Is the field searchable via the GraphQL?
+     *
+     * ```ts
+     * isSearchable: false
+     * ```
+     */
+    isSearchable: boolean;
+    /**
+     * Is the field searchable via full text search?
+     *
+     * Field is not full text searchable by default.
+     * ```ts
+     * fullTextSearch: false
+     * ```
+     */
+    fullTextSearch?: boolean;
+    /**
+     * Is the field sortable via the GraphQL?
+     *
+     * ```ts
+     * isSortable: true
+     * ```
+     */
+    isSortable: boolean;
+    /**
+     * Optional method which creates the storageId.
+     * Primary use is for the datetime field, but if users has some specific fields, they can customize the storageId to their needs.
+     *
+     * ```ts
+     * createStorageId: ({field}) => {
+     *     if (field.settings.type === "time) {
+     *         return `${field.type}_time@${field.id}`
+     *     }
+     *     // use default method
+     *     return undefined;
+     * }
+     * ```
+     */
+    createStorageId?: (params: {
+        model: CmsModel;
+        field: Omit<TField, "storageId"> & Partial<Pick<TField, "storageId">>;
+    }) => string | null | undefined;
+    /**
+     * Read API methods.
+     */
+    read: {
+        /**
+         * Definition for get filtering for GraphQL.
+         *
+         * ```ts
+         * read: {
+         *     createGetFilters({ field }) {
+         *         return `${field.fieldId}: MyField`;
+         *     }
+         * }
+         * ```
+         */
+        createGetFilters?(params: {
+            field: TField;
+        }): string;
+        /**
+         * Definition for list filtering for GraphQL.
+         *
+         * ```ts
+         * read: {
+         *     createListFilters({ field }) {
+         *         return `
+         *             ${field.fieldId}: MyType
+         *             ${field.fieldId}_not: MyType
+         *             ${field.fieldId}_in: [MyType]
+         *             ${field.fieldId}_not_in: [MyType]
+         *         `;
+         *     }
+         * }
+         * ```
+         */
+        createListFilters?(params: {
+            model: Pick<CmsModel, "singularApiName">;
+            field: TField;
+            plugins: CmsFieldTypePlugins;
+        }): string;
+        /**
+         * Definition of the field type for GraphQL - be aware if multiple values is selected.
+         *
+         * ```ts
+         * read: {
+         *     createTypeField({ field }) {
+         *         if (field.multipleValues) {
+         *             return `${field.fieldId}: [MyFieldType]`;
+         *         }
+         *
+         *         return `${field.fieldId}: MyField`;
+         *     }
+         * }
+         * ```
+         */
+        createTypeField(params: {
+            models: CmsModel[];
+            model: CmsModel;
+            field: TField;
+            fieldTypePlugins: CmsFieldTypePlugins;
+        }): CmsModelFieldDefinition | string | null;
+        /**
+         * Definition for field resolver.
+         * By default, it is simple return of the `instance.values[storageId]` but if required, users can define their own.
+         *
+         * ```ts
+         * read: {
+         *     createResolver({ field }) {
+         *         return instance => {
+         *             return instance.values[field.storageId];
+         *         };
+         *     }
+         * }
+         * ```
+         */
+        createResolver?: CmsModelFieldToGraphQLCreateResolver<TField>;
+        /**
+         * Read API schema definitions for the field and resolvers for them.
+         *
+         * ```ts
+         * read: {
+         *     createSchema() {
+         *         return {
+         *             typeDefs: `
+         *                 myField {
+         *                     id
+         *                     date
+         *                 }
+         *             `,
+         *             resolvers: {}
+         *         }
+         *     }
+         * }
+         * ```
+         */
+        createSchema?: (params: {
+            models: CmsModel[];
+        }) => GraphQLSchemaDefinition<CmsContext>;
+    };
+    manage: {
+        /**
+         * Definition for list filtering for GraphQL.
+         *
+         * ```ts
+         * manage: {
+         *     createListFilters({ field }) {
+         *         return `
+         *             ${field.fieldId}: MyType
+         *             ${field.fieldId}_not: MyType
+         *             ${field.fieldId}_in: [MyType]
+         *             ${field.fieldId}_not_in: [MyType]
+         *         `;
+         *     }
+         * }
+         * ```
+         */
+        createListFilters?: (params: {
+            model: Pick<CmsModel, "singularApiName">;
+            field: TField;
+            plugins: CmsFieldTypePlugins;
+        }) => string;
+        /**
+         * Manage API schema definitions for the field and resolvers for them. Probably similar to `read.createSchema`.
+         *
+         * ```ts
+         *     createSchema() {
+         *         return {
+         *             typeDefs: `
+         *                 myField {
+         *                     id
+         *                     date
+         *                 }
+         *             `,
+         *             resolvers: {}
+         *         }
+         *     }
+         * ```
+         */
+        createSchema?: (params: {
+            models: CmsModel[];
+        }) => GraphQLSchemaDefinition<CmsContext>;
+        /**
+         * Definition of the field type for GraphQL - be aware if multiple values is selected. Probably same as `read.createTypeField`.
+         *
+         * ```ts
+         * manage: {
+         *     createTypeField({ field }) {
+         *         if (field.multipleValues) {
+         *             return field.fieldId + ": [MyType]";
+         *         }
+         *
+         *         return field.fieldId + ": MyType";
+         *     }
+         * }
+         * ```
+         */
+        createTypeField: (params: {
+            models: CmsModel[];
+            model: CmsModel;
+            field: TField;
+            fieldTypePlugins: CmsFieldTypePlugins;
+        }) => CmsModelFieldDefinition | string | null;
+        /**
+         * Definition for input GraphQL field type.
+         *
+         * ```ts
+         * manage: {
+         *     createInputField({ field }) {
+         *         if (field.multipleValues) {
+         *             return field.fieldId + ": [MyField]";
+         *         }
+         *
+         *         return field.fieldId + ": MyField";
+         *     }
+         * }
+         * ```
+         */
+        createInputField: (params: {
+            models: CmsModel[];
+            model: CmsModel;
+            field: TField;
+            fieldTypePlugins: CmsFieldTypePlugins;
+        }) => CmsModelFieldDefinition | string | null;
+        /**
+         * Definition for field resolver.
+         * By default, it is simple return of the `instance.values[storageId]` but if required, users can define their own.
+         *
+         * ```ts
+         * manage: {
+         *     createResolver({ field }) {
+         *         return instance => {
+         *             return instance.values[field.storageId];
+         *         };
+         *     }
+         * }
+         * ```
+         */
+        createResolver?: CmsModelFieldToGraphQLCreateResolver<TField>;
+        normalizeInput?: <T>(params: CmsModelFieldToGraphQLNormalizeInputParams<TField>) => Promise<T>;
+    };
+    /**
+     *
+     * @param field
+     */
+    validateChildFields?: CmsModelFieldToGraphQLPluginValidateChildFields<TField>;
+    /**
+     * Get field AST.
+     */
+    getFieldAst?: GetCmsModelFieldAst<TField>;
+}
+/**
+ * Check for content model locked field.
+ * A custom plugin definable by the user.
+ *
+ * @category CmsModel
+ * @category Plugin
+ */
+export interface CmsModelLockedFieldPlugin extends Plugin {
+    /**
+     * A plugin type
+     */
+    type: "cms-model-locked-field";
+    /**
+     * A unique identifier of the field type (text, number, json, myField, ...).
+     */
+    fieldType: string;
+    /**
+     * A method to check if field really is locked.
+     */
+    checkLockedField?: (params: {
+        lockedField: LockedField;
+        field: CmsModelField;
+    }) => void;
+    /**
+     * A method to get the locked field data.
+     */
+    getLockedFieldData?: (params: {
+        field: CmsModelField;
+    }) => Record<string, any>;
+}
+/**
+ * Definition for the field validator.
+ *
+ * @category Plugin
+ * @category ModelField
+ * @category FieldValidation
+ */
+export interface CmsModelFieldValidatorPluginValidateCb {
+    (params: CmsModelFieldValidatorValidateParams): Promise<boolean>;
+}
+export interface CmsModelFieldValidatorPlugin extends Plugin {
+    /**
+     * A plugin type.
+     */
+    type: "cms-model-field-validator";
+    /**
+     * Actual validator definition.
+     */
+    validator: {
+        /**
+         * Name of the validator.
+         */
+        name: string;
+        /**
+         * Validation method.
+         */
+        validate: CmsModelFieldValidatorPluginValidateCb;
+    };
+}
+/**
+ * A pattern validator for the content entry field value.
+ *
+ * @category Plugin
+ * @category ModelField
+ * @category FieldValidation
+ */
+export interface CmsModelFieldPatternValidatorPlugin extends Plugin {
+    /**
+     * A plugin type
+     */
+    type: "cms-model-field-validator-pattern";
+    /**
+     * A pattern object for the validator.
+     */
+    pattern: {
+        /**
+         * name of the pattern.
+         */
+        name: string;
+        /**
+         * RegExp of the validator.
+         */
+        regex: string;
+        /**
+         * RegExp flags
+         */
+        flags: string;
+    };
+}

package/types/plugins.js

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

package/types/plugins.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["plugins.ts"],"sourcesContent":["import type { Plugin } from \"@webiny/plugins/types\";\nimport type { GraphQLSchemaDefinition } from \"@webiny/handler-graphql/types\";\nimport type {\n    CmsContext,\n    CmsFieldTypePlugins,\n    CmsModelFieldDefinition,\n    CmsModelFieldToGraphQLCreateResolver,\n    CmsModelFieldToGraphQLNormalizeInputParams,\n    CmsModelFieldToGraphQLPluginValidateChildFields,\n    CmsModelFieldValidatorValidateParams\n} from \"./types\";\nimport type { GetCmsModelFieldAst } from \"./modelAst\";\nimport type { CmsModelField, CmsModelFieldType, LockedField } from \"./modelField\";\nimport type { CmsModel } from \"./model\";\n\n/**\n * @category Plugin\n * @category ModelField\n * @category GraphQL\n */\nexport interface CmsModelFieldToGraphQLPlugin<TField extends CmsModelField = CmsModelField>\n    extends Plugin {\n    /**\n     * A plugin type\n     */\n    type: \"cms-model-field-to-graphql\";\n    /**\n     * Field type name which must be exact as the one in `CmsEditorFieldTypePlugin` plugin.\n     *\n     * ```ts\n     * fieldType: \"myField\"\n     * ```\n     */\n    fieldType: CmsModelFieldType;\n    /**\n     * Is the field searchable via the GraphQL?\n     *\n     * ```ts\n     * isSearchable: false\n     * ```\n     */\n    isSearchable: boolean;\n    /**\n     * Is the field searchable via full text search?\n     *\n     * Field is not full text searchable by default.\n     * ```ts\n     * fullTextSearch: false\n     * ```\n     */\n    fullTextSearch?: boolean;\n    /**\n     * Is the field sortable via the GraphQL?\n     *\n     * ```ts\n     * isSortable: true\n     * ```\n     */\n    isSortable: boolean;\n    /**\n     * Optional method which creates the storageId.\n     * Primary use is for the datetime field, but if users has some specific fields, they can customize the storageId to their needs.\n     *\n     * ```ts\n     * createStorageId: ({field}) => {\n     *     if (field.settings.type === \"time) {\n     *         return `${field.type}_time@${field.id}`\n     *     }\n     *     // use default method\n     *     return undefined;\n     * }\n     * ```\n     */\n    createStorageId?: (params: {\n        model: CmsModel;\n        field: Omit<TField, \"storageId\"> & Partial<Pick<TField, \"storageId\">>;\n    }) => string | null | undefined;\n    /**\n     * Read API methods.\n     */\n    read: {\n        /**\n         * Definition for get filtering for GraphQL.\n         *\n         * ```ts\n         * read: {\n         *     createGetFilters({ field }) {\n         *         return `${field.fieldId}: MyField`;\n         *     }\n         * }\n         * ```\n         */\n        createGetFilters?(params: { field: TField }): string;\n        /**\n         * Definition for list filtering for GraphQL.\n         *\n         * ```ts\n         * read: {\n         *     createListFilters({ field }) {\n         *         return `\n         *             ${field.fieldId}: MyType\n         *             ${field.fieldId}_not: MyType\n         *             ${field.fieldId}_in: [MyType]\n         *             ${field.fieldId}_not_in: [MyType]\n         *         `;\n         *     }\n         * }\n         * ```\n         */\n        createListFilters?(params: {\n            model: Pick<CmsModel, \"singularApiName\">;\n            field: TField;\n            plugins: CmsFieldTypePlugins;\n        }): string;\n        /**\n         * Definition of the field type for GraphQL - be aware if multiple values is selected.\n         *\n         * ```ts\n         * read: {\n         *     createTypeField({ field }) {\n         *         if (field.multipleValues) {\n         *             return `${field.fieldId}: [MyFieldType]`;\n         *         }\n         *\n         *         return `${field.fieldId}: MyField`;\n         *     }\n         * }\n         * ```\n         */\n        createTypeField(params: {\n            models: CmsModel[];\n            model: CmsModel;\n            field: TField;\n            fieldTypePlugins: CmsFieldTypePlugins;\n        }): CmsModelFieldDefinition | string | null;\n        /**\n         * Definition for field resolver.\n         * By default, it is simple return of the `instance.values[storageId]` but if required, users can define their own.\n         *\n         * ```ts\n         * read: {\n         *     createResolver({ field }) {\n         *         return instance => {\n         *             return instance.values[field.storageId];\n         *         };\n         *     }\n         * }\n         * ```\n         */\n        createResolver?: CmsModelFieldToGraphQLCreateResolver<TField>;\n        /**\n         * Read API schema definitions for the field and resolvers for them.\n         *\n         * ```ts\n         * read: {\n         *     createSchema() {\n         *         return {\n         *             typeDefs: `\n         *                 myField {\n         *                     id\n         *                     date\n         *                 }\n         *             `,\n         *             resolvers: {}\n         *         }\n         *     }\n         * }\n         * ```\n         */\n        createSchema?: (params: { models: CmsModel[] }) => GraphQLSchemaDefinition<CmsContext>;\n    };\n    manage: {\n        /**\n         * Definition for list filtering for GraphQL.\n         *\n         * ```ts\n         * manage: {\n         *     createListFilters({ field }) {\n         *         return `\n         *             ${field.fieldId}: MyType\n         *             ${field.fieldId}_not: MyType\n         *             ${field.fieldId}_in: [MyType]\n         *             ${field.fieldId}_not_in: [MyType]\n         *         `;\n         *     }\n         * }\n         * ```\n         */\n        createListFilters?: (params: {\n            model: Pick<CmsModel, \"singularApiName\">;\n            field: TField;\n            plugins: CmsFieldTypePlugins;\n        }) => string;\n        /**\n         * Manage API schema definitions for the field and resolvers for them. Probably similar to `read.createSchema`.\n         *\n         * ```ts\n         *     createSchema() {\n         *         return {\n         *             typeDefs: `\n         *                 myField {\n         *                     id\n         *                     date\n         *                 }\n         *             `,\n         *             resolvers: {}\n         *         }\n         *     }\n         * ```\n         */\n        createSchema?: (params: { models: CmsModel[] }) => GraphQLSchemaDefinition<CmsContext>;\n        /**\n         * Definition of the field type for GraphQL - be aware if multiple values is selected. Probably same as `read.createTypeField`.\n         *\n         * ```ts\n         * manage: {\n         *     createTypeField({ field }) {\n         *         if (field.multipleValues) {\n         *             return field.fieldId + \": [MyType]\";\n         *         }\n         *\n         *         return field.fieldId + \": MyType\";\n         *     }\n         * }\n         * ```\n         */\n        createTypeField: (params: {\n            models: CmsModel[];\n            model: CmsModel;\n            field: TField;\n            fieldTypePlugins: CmsFieldTypePlugins;\n        }) => CmsModelFieldDefinition | string | null;\n        /**\n         * Definition for input GraphQL field type.\n         *\n         * ```ts\n         * manage: {\n         *     createInputField({ field }) {\n         *         if (field.multipleValues) {\n         *             return field.fieldId + \": [MyField]\";\n         *         }\n         *\n         *         return field.fieldId + \": MyField\";\n         *     }\n         * }\n         * ```\n         */\n        createInputField: (params: {\n            models: CmsModel[];\n            model: CmsModel;\n            field: TField;\n            fieldTypePlugins: CmsFieldTypePlugins;\n        }) => CmsModelFieldDefinition | string | null;\n        /**\n         * Definition for field resolver.\n         * By default, it is simple return of the `instance.values[storageId]` but if required, users can define their own.\n         *\n         * ```ts\n         * manage: {\n         *     createResolver({ field }) {\n         *         return instance => {\n         *             return instance.values[field.storageId];\n         *         };\n         *     }\n         * }\n         * ```\n         */\n        createResolver?: CmsModelFieldToGraphQLCreateResolver<TField>;\n        normalizeInput?: <T>(\n            params: CmsModelFieldToGraphQLNormalizeInputParams<TField>\n        ) => Promise<T>;\n    };\n    /**\n     *\n     * @param field\n     */\n    validateChildFields?: CmsModelFieldToGraphQLPluginValidateChildFields<TField>;\n    /**\n     * Get field AST.\n     */\n    getFieldAst?: GetCmsModelFieldAst<TField>;\n}\n\n/**\n * Check for content model locked field.\n * A custom plugin definable by the user.\n *\n * @category CmsModel\n * @category Plugin\n */\nexport interface CmsModelLockedFieldPlugin extends Plugin {\n    /**\n     * A plugin type\n     */\n    type: \"cms-model-locked-field\";\n    /**\n     * A unique identifier of the field type (text, number, json, myField, ...).\n     */\n    fieldType: string;\n    /**\n     * A method to check if field really is locked.\n     */\n    checkLockedField?: (params: { lockedField: LockedField; field: CmsModelField }) => void;\n    /**\n     * A method to get the locked field data.\n     */\n    getLockedFieldData?: (params: { field: CmsModelField }) => Record<string, any>;\n}\n\n/**\n * Definition for the field validator.\n *\n * @category Plugin\n * @category ModelField\n * @category FieldValidation\n */\nexport interface CmsModelFieldValidatorPluginValidateCb {\n    (params: CmsModelFieldValidatorValidateParams): Promise<boolean>;\n}\n\nexport interface CmsModelFieldValidatorPlugin extends Plugin {\n    /**\n     * A plugin type.\n     */\n    type: \"cms-model-field-validator\";\n    /**\n     * Actual validator definition.\n     */\n    validator: {\n        /**\n         * Name of the validator.\n         */\n        name: string;\n        /**\n         * Validation method.\n         */\n        validate: CmsModelFieldValidatorPluginValidateCb;\n    };\n}\n\n/**\n * A pattern validator for the content entry field value.\n *\n * @category Plugin\n * @category ModelField\n * @category FieldValidation\n */\nexport interface CmsModelFieldPatternValidatorPlugin extends Plugin {\n    /**\n     * A plugin type\n     */\n    type: \"cms-model-field-validator-pattern\";\n    /**\n     * A pattern object for the validator.\n     */\n    pattern: {\n        /**\n         * name of the pattern.\n         */\n        name: string;\n        /**\n         * RegExp of the validator.\n         */\n        regex: string;\n        /**\n         * RegExp flags\n         */\n        flags: string;\n    };\n}\n"],"mappings":"","ignoreList":[]}