@webiny/api-headless-cms 0.0.0-unstable.eb196ccd2f → 0.0.0-unstable.f6dc066313

package/types/modelAst.d.ts

@@ -1,7 +1,7 @@
 /**
  * CMS Model AST
  */
-import type { CmsModelField } from "./modelField";
+import type { CmsModelField } from "./modelField.js";
 export interface ICmsModelFieldToAst {
     toAst(field: CmsModelField): CmsModelFieldAstNode;
 }
@@ -35,5 +35,5 @@ export interface ContentEntryNodeContext {
     parent: CmsModelAst | CmsModelFieldAstNode | null;
 }
 export interface ContentEntryValueVisitor {
-    (params: ContentEntryNode, context: ContentEntryNodeContext): Promise<void | unknown> | void | unknown;
+    (params: ContentEntryNode, context: ContentEntryNodeContext): Promise<void | unknown>;
 }

package/types/modelAst.js

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

package/types/modelAst.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["modelAst.ts"],"sourcesContent":["/**\n * CMS Model AST\n */\nimport type { CmsModelField } from \"./modelField\";\n\nexport interface ICmsModelFieldToAst {\n    toAst(field: CmsModelField): CmsModelFieldAstNode;\n}\n\nexport type CmsModelAst = {\n    type: \"root\";\n    children: CmsModelFieldAstNode[];\n};\n\nexport type CmsModelFieldAstNodeCollection = {\n    type: \"collection\";\n    collection: { discriminator: string } & Record<string, any>;\n    children: CmsModelFieldAstNode[];\n};\n\nexport type CmsModelFieldAstNodeField = {\n    type: \"field\";\n    field: CmsModelField;\n    children: CmsModelFieldAstNode[];\n};\n\nexport type CmsModelFieldAstNode = CmsModelFieldAstNodeCollection | CmsModelFieldAstNodeField;\n\nexport interface GetCmsModelFieldAst<TField> {\n    (field: TField, converter: ICmsModelFieldToAst): CmsModelFieldAstNode;\n}\n\nexport interface ContentEntryNode {\n    field: CmsModelField;\n    value: any;\n    path: string;\n    // parentField: CmsModelField | undefined;\n    // parent => parent object (e.g., entry)\n}\n\nexport interface ContentEntryNodeContext {\n    node: CmsModelAst | CmsModelFieldAstNode;\n    parent: CmsModelAst | CmsModelFieldAstNode | null;\n}\n\nexport interface ContentEntryValueVisitor {\n    (params: ContentEntryNode, context: ContentEntryNodeContext):\n        | Promise<void | unknown>\n        | void\n        | unknown;\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":[],"sources":["modelAst.ts"],"sourcesContent":["/**\n * CMS Model AST\n */\nimport type { CmsModelField } from \"./modelField.js\";\n\nexport interface ICmsModelFieldToAst {\n    toAst(field: CmsModelField): CmsModelFieldAstNode;\n}\n\nexport type CmsModelAst = {\n    type: \"root\";\n    children: CmsModelFieldAstNode[];\n};\n\nexport type CmsModelFieldAstNodeCollection = {\n    type: \"collection\";\n    collection: { discriminator: string } & Record<string, any>;\n    children: CmsModelFieldAstNode[];\n};\n\nexport type CmsModelFieldAstNodeField = {\n    type: \"field\";\n    field: CmsModelField;\n    children: CmsModelFieldAstNode[];\n};\n\nexport type CmsModelFieldAstNode = CmsModelFieldAstNodeCollection | CmsModelFieldAstNodeField;\n\nexport interface GetCmsModelFieldAst<TField> {\n    (field: TField, converter: ICmsModelFieldToAst): CmsModelFieldAstNode;\n}\n\nexport interface ContentEntryNode {\n    field: CmsModelField;\n    value: any;\n    path: string;\n    // parentField: CmsModelField | undefined;\n    // parent => parent object (e.g., entry)\n}\n\nexport interface ContentEntryNodeContext {\n    node: CmsModelAst | CmsModelFieldAstNode;\n    parent: CmsModelAst | CmsModelFieldAstNode | null;\n}\n\nexport interface ContentEntryValueVisitor {\n    (params: ContentEntryNode, context: ContentEntryNodeContext): Promise<void | unknown>;\n}\n"],"mappings":"","ignoreList":[]}

package/types/modelField.d.ts

@@ -1,5 +1,14 @@
-import type { CmsModel } from "./model";
-import type { GenericRecord } from "@webiny/api/types";
+import type { CmsModel, CmsModelLayout } from "./model.js";
+import type { GenericRecord } from "@webiny/api/types.js";
+import type { CmsDynamicZoneTemplate } from "../types/fields/dynamicZoneField.js";
+export type FieldRuleAction = "hide" | "disable" | string;
+export interface FieldRule {
+    type: "accessControl" | "entryValue";
+    target: string;
+    operator: string;
+    value: string | number | boolean | null;
+    action: FieldRuleAction;
+}
 export type CmsModelFieldType = "boolean" | "datetime" | "file" | "long-text" | "number" | "json" | "object" | "ref" | "rich-text" | "text" | "dynamicZone" | string;
 export type ICmsModelFieldStorageId = `${string}@${string}` | string;
 /**
@@ -42,17 +51,25 @@ export interface CmsModelField {
      */
     fieldId: string;
     /**
-     * A label for the field
+     * A label for the field.
      */
     label: string;
     /**
-     * Text below the field to clarify what is it meant to be in the field value
+     * Field description right below the label.
      */
-    helpText?: string | null;
+    description?: string | null;
     /**
-     * Text to be displayed in the field
+     * Note displayed below the input.
      */
-    placeholderText?: string | null;
+    note?: string | null;
+    /**
+     * Text in the tooltip next to the input label.
+     */
+    help?: string | null;
+    /**
+     * Placeholder text to be displayed in the field
+     */
+    placeholder?: string | null;
     /**
      * Are predefined values enabled? And list of them
      */
@@ -66,7 +83,7 @@ export interface CmsModelField {
      *
      * @default []
      */
-    validation?: CmsModelFieldValidation[];
+    validation: CmsModelFieldValidation[];
     /**
      * List of validations for the list of values, when a field is set to accept a list of values.
      * These validations will be applied to the entire list, and `validation` (see above) will be applied
@@ -74,12 +91,12 @@ export interface CmsModelField {
      *
      * @default []
      */
-    listValidation?: CmsModelFieldValidation[];
+    listValidation: CmsModelFieldValidation[];
     /**
      * Is this a multiple values field?
      *
      */
-    multipleValues?: boolean;
+    list?: boolean;
     /**
      * Fields can be tagged to give them contextual meaning.
      */
@@ -90,6 +107,10 @@ export interface CmsModelField {
      * @default {}
      */
     settings?: CmsModelFieldSettings;
+    /**
+     * Rules that control field visibility and editability (access control and entry value conditions).
+     */
+    rules?: FieldRule[];
 }
 /**
  * A definition for content model field received from the user.
@@ -119,13 +140,21 @@ export interface CmsModelFieldInput {
      */
     label: string;
     /**
-     * Text to display below the field to help user what to write in the field.
+     * Field description right below the label.
+     */
+    description?: string | null;
+    /**
+     * Note displayed below the input.
      */
-    helpText?: string | null;
+    note?: string | null;
     /**
-     * Text to display in the field.
+     * Text in the tooltip next to the input label.
      */
-    placeholderText?: string | null;
+    help?: string | null;
+    /**
+     * Placeholder text to be displayed in the field
+     */
+    placeholder?: string | null;
     /**
      * Fields can be tagged to give them contextual meaning.
      */
@@ -133,7 +162,7 @@ export interface CmsModelFieldInput {
     /**
      * Are multiple values allowed?
      */
-    multipleValues?: boolean;
+    list?: boolean;
     /**
      * Predefined values options for the field. Check the reference for more information.
      */
@@ -145,15 +174,21 @@ export interface CmsModelFieldInput {
     /**
      * List of validations for the field.
      */
-    validation?: CmsModelFieldValidation[];
+    validation: CmsModelFieldValidation[];
     /**
      * @see CmsModelField.listValidation
      */
-    listValidation?: CmsModelFieldValidation[];
+    listValidation: CmsModelFieldValidation[];
     /**
      * User defined settings.
      */
-    settings?: Record<string, any>;
+    settings?: {
+        [key: string]: any;
+    };
+    /**
+     * Rules that control field visibility and editability (access control and entry value conditions).
+     */
+    rules?: FieldRule[];
 }
 /**
  * A GraphQL `params.data` parameter received when updating content model.
@@ -196,7 +231,7 @@ export interface CmsModelUpdateInput {
      * ]
      * ```
      */
-    layout: string[][];
+    layout: CmsModelLayout;
     /**
      * Tags for the content model.
      */
@@ -208,29 +243,6 @@ export interface CmsModelUpdateInput {
     descriptionFieldId?: string | null;
     imageFieldId?: string | null;
 }
-/**
- * Locked field in the content model
- *
- * @see CmsModel.lockedFields
- *
- * @category ModelField
- */
-export interface LockedField {
-    /**
-     * Locked field storage ID - one used to store values.
-     * We cannot change this due to old systems.
-     */
-    fieldId: string;
-    /**
-     * Is the field multiple values field?
-     */
-    multipleValues: boolean;
-    /**
-     * Field type.
-     */
-    type: string;
-    [key: string]: any;
-}
 /**
  * Object containing content model field renderer options.
  *
@@ -270,7 +282,7 @@ export interface CmsModelFieldSettings {
     /**
      * Object field has child fields - so it needs to have a layout.
      */
-    layout?: string[][];
+    layout?: CmsModelLayout;
     /**
      * Ref field.
      */
@@ -283,6 +295,10 @@ export interface CmsModelFieldSettings {
      * Disable full text search explicitly on this field.
      */
     disableFullTextSearch?: boolean;
+    /**
+     * Dynamic zone field templates.
+     */
+    templates?: CmsDynamicZoneTemplate[];
     /**
      * There are a lot of other settings that are possible to add, so we keep the type opened.
      */

package/types/modelField.js

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

package/types/modelField.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["modelField.ts"],"sourcesContent":["import type { CmsModel } from \"./model\";\nimport type { GenericRecord } from \"@webiny/api/types\";\n\nexport type CmsModelFieldType =\n    | \"boolean\"\n    | \"datetime\"\n    | \"file\"\n    | \"long-text\"\n    | \"number\"\n    | \"json\"\n    | \"object\"\n    | \"ref\"\n    | \"rich-text\"\n    | \"text\"\n    | \"dynamicZone\"\n    | string;\n\nexport type ICmsModelFieldStorageId = `${string}@${string}` | string;\n/**\n * A definition for content model field. This type exists on the app side as well.\n *\n * @category ModelField\n * @category Database model\n */\nexport interface CmsModelField {\n    /**\n     * A generated unique ID for the model field.\n     * MUST be absolute unique throughout the models.\n     * Must be in form of a-zA-Z0-9.\n     *\n     * We generate a unique id value when you're building a model via UI,\n     * but when user is creating a model via a plugin it is up to them to be careful about this.\n     */\n    id: string;\n    /**\n     * A type of the field.\n     * We are defining our built-in fields, so people know which are available by the default.\n     */\n    type: CmsModelFieldType;\n    /**\n     * A unique storage ID for storing actual values.\n     * Must in form of a-zA-Z0-9@a-zA-Z0-9\n     *\n     * This is an auto-generated value: uses `id` and `type`\n     *\n     * This is used as path for the entry value.\n     */\n    storageId: ICmsModelFieldStorageId;\n    /**\n     * Field identifier for the model field that will be available to the outside world.\n     * `storageId` is used as path (or column) to store the data.\n     *\n     * Must in form of a-zA-Z0-9.\n     *\n     * This value MUST be unique in the CmsModel.\n     */\n    fieldId: string;\n    /**\n     * A label for the field\n     */\n    label: string;\n    /**\n     * Text below the field to clarify what is it meant to be in the field value\n     */\n    helpText?: string | null;\n    /**\n     * Text to be displayed in the field\n     */\n    placeholderText?: string | null;\n    /**\n     * Are predefined values enabled? And list of them\n     */\n    predefinedValues?: CmsModelFieldPredefinedValues;\n    /**\n     * Field renderer. Blank if determined automatically.\n     */\n    renderer?: CmsModelFieldRenderer | null;\n    /**\n     * List of validations for the field\n     *\n     * @default []\n     */\n    validation?: CmsModelFieldValidation[];\n    /**\n     * List of validations for the list of values, when a field is set to accept a list of values.\n     * These validations will be applied to the entire list, and `validation` (see above) will be applied\n     * to each individual value in the list.\n     *\n     * @default []\n     */\n    listValidation?: CmsModelFieldValidation[];\n    /**\n     * Is this a multiple values field?\n     *\n     */\n    multipleValues?: boolean;\n    /**\n     * Fields can be tagged to give them contextual meaning.\n     */\n    tags?: string[];\n    /**\n     * Any user defined settings.\n     *\n     * @default {}\n     */\n    settings?: CmsModelFieldSettings;\n}\n\n/**\n * A definition for content model field received from the user.\n *\n * Input type for `CmsModelField`.\n * @see CmsModelField\n *\n * @category GraphQL params\n * @category ModelField\n */\nexport interface CmsModelFieldInput {\n    /**\n     * Generated ID.\n     */\n    id: string;\n    /**\n     * Type of the field. A plugin for the field must be defined.\n     * @see CmsModelFieldToGraphQLPlugin\n     */\n    type: string;\n    /**\n     * Field outside world identifier for the field. Must be unique in the model.\n     */\n    fieldId: string;\n    /**\n     * Label for the field.\n     */\n    label: string;\n    /**\n     * Text to display below the field to help user what to write in the field.\n     */\n    helpText?: string | null;\n    /**\n     * Text to display in the field.\n     */\n    placeholderText?: string | null;\n    /**\n     * Fields can be tagged to give them contextual meaning.\n     */\n    tags?: string[];\n    /**\n     * Are multiple values allowed?\n     */\n    multipleValues?: boolean;\n    /**\n     * Predefined values options for the field. Check the reference for more information.\n     */\n    predefinedValues?: CmsModelFieldPredefinedValues;\n    /**\n     * Renderer options for the field. Check the reference for more information.\n     */\n    renderer?: CmsModelFieldRenderer | null;\n    /**\n     * List of validations for the field.\n     */\n    validation?: CmsModelFieldValidation[];\n    /**\n     * @see CmsModelField.listValidation\n     */\n    listValidation?: CmsModelFieldValidation[];\n    /**\n     * User defined settings.\n     */\n    settings?: Record<string, any>;\n}\n\n/**\n * A GraphQL `params.data` parameter received when updating content model.\n *\n * @category GraphQL params\n * @category CmsModel\n */\nexport interface CmsModelUpdateInput {\n    /**\n     * A new content model name.\n     */\n    name?: string;\n    /**\n     * A new singular name of the content model to be used in the API.\n     */\n    singularApiName?: string;\n    /**\n     * A new plural name of the content model to be used in the API.\n     */\n    pluralApiName?: string;\n    /**\n     * A group we want to move the model to.\n     */\n    group?: string;\n    /**\n     * A new description of the content model.\n     */\n    description?: string | null;\n    /**\n     * A list of content model fields to define the entry values.\n     */\n    fields: CmsModelFieldInput[];\n    /**\n     * Admin UI field layout\n     *\n     * ```ts\n     * layout: [\n     *      [field1id, field2id],\n     *      [field3id]\n     * ]\n     * ```\n     */\n    layout: string[][];\n    /**\n     * Tags for the content model.\n     */\n    tags?: string[];\n    /**\n     * Fields fieldId which are picked to represent the CMS entry.\n     */\n    titleFieldId?: string | null;\n    descriptionFieldId?: string | null;\n    imageFieldId?: string | null;\n}\n\n/**\n * Locked field in the content model\n *\n * @see CmsModel.lockedFields\n *\n * @category ModelField\n */\nexport interface LockedField {\n    /**\n     * Locked field storage ID - one used to store values.\n     * We cannot change this due to old systems.\n     */\n    fieldId: string;\n    /**\n     * Is the field multiple values field?\n     */\n    multipleValues: boolean;\n    /**\n     * Field type.\n     */\n    type: string;\n\n    [key: string]: any;\n}\n\n/**\n * Object containing content model field renderer options.\n *\n * @category CmsModelField\n */\ninterface CmsModelFieldRenderer {\n    /**\n     * Name of the field renderer. Must have one in field renderer plugins.\n     * Can be blank to let automatically determine the renderer.\n     */\n    name: string;\n    /**\n     * Renderer settings allow you to configure field renderer on a field level.\n     */\n    settings?: GenericRecord<string> | null;\n}\n\n/**\n * A definition for content model field settings.\n *\n * @category ModelField\n * @category Database model\n */\nexport interface CmsModelFieldSettings {\n    /**\n     * Predefined values (text, number)\n     * The default value for the field in case it is not predefined values field.\n     */\n    defaultValue?: string | boolean | number | null | undefined;\n    /**\n     * Object field has child fields.\n     */\n    fields?: CmsModelField[];\n    /**\n     * Is the file field images only one?\n     */\n    imagesOnly?: boolean;\n    /**\n     * Object field has child fields - so it needs to have a layout.\n     */\n    layout?: string[][];\n    /**\n     * Ref field.\n     */\n    models?: Pick<CmsModel, \"modelId\">[];\n    /**\n     * Date field.\n     */\n    type?: string;\n    /**\n     * Disable full text search explicitly on this field.\n     */\n    disableFullTextSearch?: boolean;\n\n    /**\n     * There are a lot of other settings that are possible to add, so we keep the type opened.\n     */\n    [key: string]: any;\n}\n\n/**\n * Definition for content model field validator.\n *\n * @category ModelField\n * @category FieldValidation\n */\nexport interface CmsModelFieldValidation {\n    name: string;\n    message: string;\n    settings?: {\n        value?: string | number;\n        values?: string[];\n        preset?: string;\n        [key: string]: any;\n    };\n}\n\n/**\n * Object containing content model field predefined options and values.\n *\n * @category CmsModelField\n */\nexport interface CmsModelFieldPredefinedValues {\n    /**\n     * Are predefined field values enabled?\n     */\n    enabled: boolean;\n    /**\n     * Predefined values array.\n     */\n    values: CmsModelFieldPredefinedValuesValue[];\n}\n\ninterface CmsModelFieldPredefinedValuesValue {\n    value: string;\n    label: string;\n    /**\n     * Default selected predefined value.\n     */\n    selected?: boolean;\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":[],"sources":["modelField.ts"],"sourcesContent":["import type { CmsModel, CmsModelLayout } from \"./model.js\";\nimport type { GenericRecord } from \"@webiny/api/types.js\";\nimport type { CmsDynamicZoneTemplate } from \"~/types/fields/dynamicZoneField.js\";\n\nexport type FieldRuleAction = \"hide\" | \"disable\" | string;\n\nexport interface FieldRule {\n    type: \"accessControl\" | \"entryValue\";\n    target: string;\n    operator: string;\n    value: string | number | boolean | null;\n    action: FieldRuleAction;\n}\n\nexport type CmsModelFieldType =\n    | \"boolean\"\n    | \"datetime\"\n    | \"file\"\n    | \"long-text\"\n    | \"number\"\n    | \"json\"\n    | \"object\"\n    | \"ref\"\n    | \"rich-text\"\n    | \"text\"\n    | \"dynamicZone\"\n    | string;\n\nexport type ICmsModelFieldStorageId = `${string}@${string}` | string;\n/**\n * A definition for content model field. This type exists on the app side as well.\n *\n * @category ModelField\n * @category Database model\n */\nexport interface CmsModelField {\n    /**\n     * A generated unique ID for the model field.\n     * MUST be absolute unique throughout the models.\n     * Must be in form of a-zA-Z0-9.\n     *\n     * We generate a unique id value when you're building a model via UI,\n     * but when user is creating a model via a plugin it is up to them to be careful about this.\n     */\n    id: string;\n    /**\n     * A type of the field.\n     * We are defining our built-in fields, so people know which are available by the default.\n     */\n    type: CmsModelFieldType;\n    /**\n     * A unique storage ID for storing actual values.\n     * Must in form of a-zA-Z0-9@a-zA-Z0-9\n     *\n     * This is an auto-generated value: uses `id` and `type`\n     *\n     * This is used as path for the entry value.\n     */\n    storageId: ICmsModelFieldStorageId;\n    /**\n     * Field identifier for the model field that will be available to the outside world.\n     * `storageId` is used as path (or column) to store the data.\n     *\n     * Must in form of a-zA-Z0-9.\n     *\n     * This value MUST be unique in the CmsModel.\n     */\n    fieldId: string;\n    /**\n     * A label for the field.\n     */\n    label: string;\n    /**\n     * Field description right below the label.\n     */\n    description?: string | null;\n    /**\n     * Note displayed below the input.\n     */\n    note?: string | null;\n    /**\n     * Text in the tooltip next to the input label.\n     */\n    help?: string | null;\n    /**\n     * Placeholder text to be displayed in the field\n     */\n    placeholder?: string | null;\n    /**\n     * Are predefined values enabled? And list of them\n     */\n    predefinedValues?: CmsModelFieldPredefinedValues;\n    /**\n     * Field renderer. Blank if determined automatically.\n     */\n    renderer?: CmsModelFieldRenderer | null;\n    /**\n     * List of validations for the field\n     *\n     * @default []\n     */\n    validation: CmsModelFieldValidation[];\n    /**\n     * List of validations for the list of values, when a field is set to accept a list of values.\n     * These validations will be applied to the entire list, and `validation` (see above) will be applied\n     * to each individual value in the list.\n     *\n     * @default []\n     */\n    listValidation: CmsModelFieldValidation[];\n    /**\n     * Is this a multiple values field?\n     *\n     */\n    list?: boolean;\n    /**\n     * Fields can be tagged to give them contextual meaning.\n     */\n    tags?: string[];\n    /**\n     * Any user defined settings.\n     *\n     * @default {}\n     */\n    settings?: CmsModelFieldSettings;\n    /**\n     * Rules that control field visibility and editability (access control and entry value conditions).\n     */\n    rules?: FieldRule[];\n}\n\n/**\n * A definition for content model field received from the user.\n *\n * Input type for `CmsModelField`.\n * @see CmsModelField\n *\n * @category GraphQL params\n * @category ModelField\n */\nexport interface CmsModelFieldInput {\n    /**\n     * Generated ID.\n     */\n    id: string;\n    /**\n     * Type of the field. A plugin for the field must be defined.\n     * @see CmsModelFieldToGraphQLPlugin\n     */\n    type: string;\n    /**\n     * Field outside world identifier for the field. Must be unique in the model.\n     */\n    fieldId: string;\n    /**\n     * Label for the field.\n     */\n    label: string;\n    /**\n     * Field description right below the label.\n     */\n    description?: string | null;\n    /**\n     * Note displayed below the input.\n     */\n    note?: string | null;\n    /**\n     * Text in the tooltip next to the input label.\n     */\n    help?: string | null;\n    /**\n     * Placeholder text to be displayed in the field\n     */\n    placeholder?: string | null;\n    /**\n     * Fields can be tagged to give them contextual meaning.\n     */\n    tags?: string[];\n    /**\n     * Are multiple values allowed?\n     */\n    list?: boolean;\n    /**\n     * Predefined values options for the field. Check the reference for more information.\n     */\n    predefinedValues?: CmsModelFieldPredefinedValues;\n    /**\n     * Renderer options for the field. Check the reference for more information.\n     */\n    renderer?: CmsModelFieldRenderer | null;\n    /**\n     * List of validations for the field.\n     */\n    validation: CmsModelFieldValidation[];\n    /**\n     * @see CmsModelField.listValidation\n     */\n    listValidation: CmsModelFieldValidation[];\n    /**\n     * User defined settings.\n     */\n    settings?: {\n        [key: string]: any;\n    };\n    /**\n     * Rules that control field visibility and editability (access control and entry value conditions).\n     */\n    rules?: FieldRule[];\n}\n\n/**\n * A GraphQL `params.data` parameter received when updating content model.\n *\n * @category GraphQL params\n * @category CmsModel\n */\nexport interface CmsModelUpdateInput {\n    /**\n     * A new content model name.\n     */\n    name?: string;\n    /**\n     * A new singular name of the content model to be used in the API.\n     */\n    singularApiName?: string;\n    /**\n     * A new plural name of the content model to be used in the API.\n     */\n    pluralApiName?: string;\n    /**\n     * A group we want to move the model to.\n     */\n    group?: string;\n    /**\n     * A new description of the content model.\n     */\n    description?: string | null;\n    /**\n     * A list of content model fields to define the entry values.\n     */\n    fields: CmsModelFieldInput[];\n    /**\n     * Admin UI field layout\n     *\n     * ```ts\n     * layout: [\n     *      [field1id, field2id],\n     *      [field3id]\n     * ]\n     * ```\n     */\n    layout: CmsModelLayout;\n    /**\n     * Tags for the content model.\n     */\n    tags?: string[];\n    /**\n     * Fields fieldId which are picked to represent the CMS entry.\n     */\n    titleFieldId?: string | null;\n    descriptionFieldId?: string | null;\n    imageFieldId?: string | null;\n}\n\n/**\n * Object containing content model field renderer options.\n *\n * @category CmsModelField\n */\ninterface CmsModelFieldRenderer {\n    /**\n     * Name of the field renderer. Must have one in field renderer plugins.\n     * Can be blank to let automatically determine the renderer.\n     */\n    name: string;\n    /**\n     * Renderer settings allow you to configure field renderer on a field level.\n     */\n    settings?: GenericRecord<string> | null;\n}\n\n/**\n * A definition for content model field settings.\n *\n * @category ModelField\n * @category Database model\n */\nexport interface CmsModelFieldSettings {\n    /**\n     * Predefined values (text, number)\n     * The default value for the field in case it is not predefined values field.\n     */\n    defaultValue?: string | boolean | number | null | undefined;\n    /**\n     * Object field has child fields.\n     */\n    fields?: CmsModelField[];\n    /**\n     * Is the file field images only one?\n     */\n    imagesOnly?: boolean;\n    /**\n     * Object field has child fields - so it needs to have a layout.\n     */\n    layout?: CmsModelLayout;\n    /**\n     * Ref field.\n     */\n    models?: Pick<CmsModel, \"modelId\">[];\n    /**\n     * Date field.\n     */\n    type?: string;\n    /**\n     * Disable full text search explicitly on this field.\n     */\n    disableFullTextSearch?: boolean;\n    /**\n     * Dynamic zone field templates.\n     */\n    templates?: CmsDynamicZoneTemplate[];\n    /**\n     * There are a lot of other settings that are possible to add, so we keep the type opened.\n     */\n    [key: string]: any;\n}\n\n/**\n * Definition for content model field validator.\n *\n * @category ModelField\n * @category FieldValidation\n */\nexport interface CmsModelFieldValidation {\n    name: string;\n    message: string;\n    settings?: {\n        value?: string | number;\n        values?: string[];\n        preset?: string;\n        [key: string]: any;\n    };\n}\n\n/**\n * Object containing content model field predefined options and values.\n *\n * @category CmsModelField\n */\nexport interface CmsModelFieldPredefinedValues {\n    /**\n     * Are predefined field values enabled?\n     */\n    enabled: boolean;\n    /**\n     * Predefined values array.\n     */\n    values: CmsModelFieldPredefinedValuesValue[];\n}\n\ninterface CmsModelFieldPredefinedValuesValue {\n    value: string;\n    label: string;\n    /**\n     * Default selected predefined value.\n     */\n    selected?: boolean;\n}\n"],"mappings":"","ignoreList":[]}

package/types/modelGroup.d.ts

@@ -1,4 +1,5 @@
-import type { CmsIdentity } from "./identity";
+import type { CmsIdentity } from "./identity.js";
+import type { CmsIcon } from "../types/types.js";
 /**
  * @category Database model
  * @category CmsModel
@@ -36,10 +37,6 @@ export interface CmsGroup {
      * Group tenant.
      */
     tenant: string;
-    /**
-     * Locale this group belongs to.
-     */
-    locale: string;
     /**
      * Description for the group.
      */
@@ -47,7 +44,7 @@ export interface CmsGroup {
     /**
      * Icon for the group. In a form of "ico/ico".
      */
-    icon: string;
+    icon: CmsIcon | null;
     /**
      * CreatedBy reference object.
      */
@@ -60,10 +57,6 @@ export interface CmsGroup {
      * Date group was created or changed on.
      */
     savedOn?: string;
-    /**
-     * Which Webiny version was this record stored with.
-     */
-    webinyVersion: string;
     /**
      * Is group private?
      * This is meant to be used for some internal groups - will not be visible in the schema.

package/types/modelGroup.js

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

package/types/modelGroup.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["modelGroup.ts"],"sourcesContent":["import type { CmsIdentity } from \"./identity\";\n\n/**\n * @category Database model\n * @category CmsModel\n */\nexport interface CmsModelGroup {\n    /**\n     * Generated ID of the group\n     */\n    id: string;\n    /**\n     * Name of the group\n     */\n    name: string;\n}\n\n/**\n * A representation of content model group in the database.\n *\n * @category CmsGroup\n * @category Database model\n */\nexport interface CmsGroup {\n    /**\n     * Generated ID.\n     */\n    id: string;\n    /**\n     * Name of the group.\n     */\n    name: string;\n    /**\n     * Slug for the group. Must be unique.\n     */\n    slug: string;\n    /**\n     * Group tenant.\n     */\n    tenant: string;\n    /**\n     * Locale this group belongs to.\n     */\n    locale: string;\n    /**\n     * Description for the group.\n     */\n    description: string | null;\n    /**\n     * Icon for the group. In a form of \"ico/ico\".\n     */\n    icon: string;\n    /**\n     * CreatedBy reference object.\n     */\n    createdBy?: CmsIdentity;\n    /**\n     * Date group was created on.\n     */\n    createdOn?: string;\n    /**\n     * Date group was created or changed on.\n     */\n    savedOn?: string;\n    /**\n     * Which Webiny version was this record stored with.\n     */\n    webinyVersion: string;\n    /**\n     * Is group private?\n     * This is meant to be used for some internal groups - will not be visible in the schema.\n     * Only available for the plugin constructed groups.\n     */\n    isPrivate?: boolean;\n    /**\n     * Is this group created via plugin?\n     */\n    isPlugin?: boolean;\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":[],"sources":["modelGroup.ts"],"sourcesContent":["import type { CmsIdentity } from \"./identity.js\";\nimport type { CmsIcon } from \"~/types/types.js\";\n\n/**\n * @category Database model\n * @category CmsModel\n */\nexport interface CmsModelGroup {\n    /**\n     * Generated ID of the group\n     */\n    id: string;\n    /**\n     * Name of the group\n     */\n    name: string;\n}\n\n/**\n * A representation of content model group in the database.\n *\n * @category CmsGroup\n * @category Database model\n */\nexport interface CmsGroup {\n    /**\n     * Generated ID.\n     */\n    id: string;\n    /**\n     * Name of the group.\n     */\n    name: string;\n    /**\n     * Slug for the group. Must be unique.\n     */\n    slug: string;\n    /**\n     * Group tenant.\n     */\n    tenant: string;\n    /**\n     * Description for the group.\n     */\n    description: string | null;\n    /**\n     * Icon for the group. In a form of \"ico/ico\".\n     */\n    icon: CmsIcon | null;\n    /**\n     * CreatedBy reference object.\n     */\n    createdBy?: CmsIdentity;\n    /**\n     * Date group was created on.\n     */\n    createdOn?: string;\n    /**\n     * Date group was created or changed on.\n     */\n    savedOn?: string;\n\n    /**\n     * Is group private?\n     * This is meant to be used for some internal groups - will not be visible in the schema.\n     * Only available for the plugin constructed groups.\n     */\n    isPrivate?: boolean;\n    /**\n     * Is this group created via plugin?\n     */\n    isPlugin?: boolean;\n}\n"],"mappings":"","ignoreList":[]}

package/types/plugins.d.ts

@@ -1,9 +1,9 @@
-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";
+import type { Plugin } from "@webiny/plugins/types.js";
+import type { GraphQLSchemaDefinition } from "@webiny/handler-graphql/types.js";
+import type { CmsContext, CmsFieldTypePlugins, CmsModelFieldDefinition, CmsModelFieldToGraphQLCreateResolver, CmsModelFieldToGraphQLNormalizeInputParams, CmsModelFieldToGraphQLPluginValidateChildFields, CmsModelFieldValidatorValidateParams } from "./types.js";
+import type { GetCmsModelFieldAst } from "./modelAst.js";
+import type { CmsModelField, CmsModelFieldType } from "./modelField.js";
+import type { CmsModel } from "./model.js";
 /**
  * @category Plugin
  * @category ModelField
@@ -110,7 +110,7 @@ export interface CmsModelFieldToGraphQLPlugin<TField extends CmsModelField = Cms
          * ```ts
          * read: {
          *     createTypeField({ field }) {
-         *         if (field.multipleValues) {
+         *         if (field.list) {
          *             return `${field.fieldId}: [MyFieldType]`;
          *         }
          *
@@ -211,7 +211,7 @@ export interface CmsModelFieldToGraphQLPlugin<TField extends CmsModelField = Cms
          * ```ts
          * manage: {
          *     createTypeField({ field }) {
-         *         if (field.multipleValues) {
+         *         if (field.list) {
          *             return field.fieldId + ": [MyType]";
          *         }
          *
@@ -232,7 +232,7 @@ export interface CmsModelFieldToGraphQLPlugin<TField extends CmsModelField = Cms
          * ```ts
          * manage: {
          *     createInputField({ field }) {
-         *         if (field.multipleValues) {
+         *         if (field.list) {
          *             return field.fieldId + ": [MyField]";
          *         }
          *
@@ -274,36 +274,6 @@ export interface CmsModelFieldToGraphQLPlugin<TField extends CmsModelField = Cms
      */
     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.
  *

package/types/plugins.js

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

package/types/plugins.js.map

@@ -1 +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":[]}
+{"version":3,"names":[],"sources":["plugins.ts"],"sourcesContent":["import type { Plugin } from \"@webiny/plugins/types.js\";\nimport type { GraphQLSchemaDefinition } from \"@webiny/handler-graphql/types.js\";\nimport type {\n    CmsContext,\n    CmsFieldTypePlugins,\n    CmsModelFieldDefinition,\n    CmsModelFieldToGraphQLCreateResolver,\n    CmsModelFieldToGraphQLNormalizeInputParams,\n    CmsModelFieldToGraphQLPluginValidateChildFields,\n    CmsModelFieldValidatorValidateParams\n} from \"./types.js\";\nimport type { GetCmsModelFieldAst } from \"./modelAst.js\";\nimport type { CmsModelField, CmsModelFieldType } from \"./modelField.js\";\nimport type { CmsModel } from \"./model.js\";\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.list) {\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.list) {\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.list) {\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 * 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":[]}