@webiny/api-headless-cms 6.6.0-alpha.0 → 6.6.0-alpha.1

package/plugins/CmsModelPlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugins/CmsModelPlugin.js","sources":["../../src/plugins/CmsModelPlugin.ts"],"sourcesContent":["import WebinyError from \"@webiny/error\";\nimport lodashCamelCase from \"lodash/camelCase.js\";\nimport camelCase from \"lodash/camelCase.js\";\nimport upperFirst from \"lodash/upperFirst.js\";\nimport pluralize from \"pluralize\";\nimport { Plugin } from \"@webiny/plugins\";\nimport type {\n    CmsModel as CmsModelBase,\n    CmsModelField as CmsModelFieldBase,\n    CmsModelFieldSettings as BaseCmsModelFieldSettings\n} from \"~/types/index.js\";\nimport { createFieldStorageId } from \"~/crud/contentModel/createFieldStorageId.js\";\nimport { validateStorageId } from \"~/crud/contentModel/validateStorageId.js\";\n\nconst createApiName = (name: string) => {\n    return upperFirst(camelCase(name));\n};\n\nconst createPluralApiName = (name: string) => {\n    return pluralize(createApiName(name));\n};\n\ninterface CmsModelFieldSettings extends Omit<BaseCmsModelFieldSettings, \"fields\"> {\n    /**\n     * Object field has child fields.\n     */\n    fields?: CmsModelFieldInput[];\n}\n\ninterface CmsModelFieldInput extends Omit<CmsModelFieldBase, \"storageId\" | \"settings\"> {\n    /**\n     * If defined, it must be camelCased string.\n     * This is for backwards compatibility - before fields had storageId.\n     *\n     * This should only be populated in old model fields.\n     * New ones must have this empty.\n     */\n    storageId?: string;\n    /**\n     * We must have a possibility to have a nested field defined without the storageId.\n     */\n    settings?: CmsModelFieldSettings;\n}\n\nexport interface CmsApiModel extends Omit<\n    CmsModelPluginModel,\n    \"isPrivate\" | \"fields\" | \"singularApiName\" | \"pluralApiName\" | \"isPlugin\"\n> {\n    isPrivate?: never;\n    noValidate?: boolean;\n    singularApiName?: string;\n    pluralApiName?: string;\n    fields: CmsModelFieldInput[];\n}\n\nexport interface CmsApiModelFull extends Omit<CmsApiModel, \"fields\"> {\n    fields: CmsModelFieldBase[];\n}\n\ninterface CmsPrivateModel extends Omit<\n    CmsModelPluginModel,\n    | \"isPrivate\"\n    | \"singularApiName\"\n    | \"pluralApiName\"\n    | \"fields\"\n    | \"isPlugin\"\n    | \"layout\"\n    | \"icon\"\n    | \"titleFieldId\"\n    | \"description\"\n> {\n    noValidate?: boolean;\n    titleFieldId?: string;\n    singularApiName?: never;\n    pluralApiName?: never;\n    isPrivate: true;\n    fields: CmsModelFieldInput[];\n}\n\nexport interface CmsPrivateModelFull extends Omit<\n    CmsPrivateModel,\n    \"fields\" | \"createdBy\" | \"createdOn\" | \"savedOn\"\n> {\n    fields: CmsModelFieldBase[];\n}\n\nexport type CmsModelInput = CmsApiModel | CmsPrivateModel | CmsApiModelFull | CmsPrivateModelFull;\n\nexport interface CmsModelPluginModel extends Omit<CmsModelBase, \"tenant\"> {\n    tenant?: string;\n}\n\ninterface CmsModelPluginOptions {\n    validateLayout?: boolean;\n}\n\nexport class CmsModelPlugin extends Plugin {\n    public static override readonly type: string = \"cms-content-model\";\n    public readonly contentModel: CmsModelPluginModel;\n\n    private readonly options: CmsModelPluginOptions;\n\n    constructor(contentModel: CmsModelInput, options?: CmsModelPluginOptions) {\n        super();\n        this.options = options || {};\n        this.contentModel = this.buildModel(contentModel);\n    }\n\n    private buildModel(input: CmsModelInput): CmsModelPluginModel {\n        const isPrivate = input.isPrivate ?? false;\n\n        const singularApiName = input.singularApiName\n            ? createApiName(input.singularApiName)\n            : createApiName(input.name);\n\n        const pluralApiName = input.pluralApiName\n            ? createApiName(input.pluralApiName)\n            : createPluralApiName(input.name);\n\n        const modelPlugin: CmsModelPluginModel = {\n            group: input.group ?? \"ungrouped\",\n            description: \"\",\n            fields: [],\n            isPlugin: true,\n            isPrivate,\n            icon: null,\n            layout: [],\n            modelId: input.modelId,\n            name: input.name,\n            pluralApiName,\n            singularApiName,\n            titleFieldId: \"id\"\n        };\n\n        if (input.noValidate) {\n            /**\n             * We can safely ignore this error, because we are sure noValidate is not a model field.\n             */\n            delete input[\"noValidate\"];\n\n            return {\n                ...modelPlugin,\n                ...input,\n                // Since `noValidate` is set, we trust the input, and cast to `CmsModelFieldBase`.\n                fields: input.fields as CmsModelFieldBase[],\n                pluralApiName,\n                singularApiName\n            };\n        }\n\n        const model: CmsModelPluginModel = {\n            ...modelPlugin,\n            ...input,\n            pluralApiName,\n            singularApiName,\n            fields: this.buildFields(input, input.fields)\n        };\n        this.validateLayout(model);\n        return model;\n    }\n\n    private buildFields(\n        model: CmsModelInput,\n        inputFields: CmsModelFieldInput[]\n    ): CmsModelFieldBase[] {\n        if (inputFields.length === 0) {\n            throw new WebinyError(\n                `Missing fields for the defined model \"${model.modelId}\".`,\n                \"MISSING_FIELDS\",\n                {\n                    model\n                }\n            );\n        }\n        const fields: CmsModelFieldBase[] = [];\n        const storageIdList: string[] = [];\n        const fieldIdList: string[] = [];\n        for (const input of inputFields) {\n            /**\n             * Field must contain an fieldId. It is required in the graphql, but lets check it just in case\n             */\n            if (!(input.fieldId || \"\").trim()) {\n                throw new WebinyError(\n                    `Field's \"storageId\" is not defined for the content model \"${model.modelId}\".`,\n                    \"FIELD_ID_ERROR\",\n                    {\n                        model,\n                        field: input\n                    }\n                );\n            }\n            const fieldId = lodashCamelCase(input.fieldId);\n            /**\n             * FieldID must be in correct pattern.\n             */\n            if (fieldId.match(/^[0-9]/) !== null) {\n                throw new WebinyError(\n                    `Field's \"fieldId\" does not match correct pattern in the content model \"${model.modelId}\" - cannot start with a number.`,\n                    \"FIELD_FIELD_ID_ERROR\",\n                    {\n                        model,\n                        field: input\n                    }\n                );\n            }\n            /**\n             * FieldID also must be camelCased.\n             */\n            if (fieldId !== input.fieldId) {\n                throw new WebinyError(\n                    `Field's \"fieldId\" must be a camel cased string in the content model \"${model.modelId}\".`,\n                    \"FIELD_FIELD_ID_ERROR\",\n                    {\n                        model,\n                        field: input\n                    }\n                );\n            }\n            /**\n             * ... and fieldId must be unique.\n             */\n            if (fieldIdList.includes(fieldId)) {\n                throw new WebinyError(\n                    `Field's \"fieldId\" (id: ${input.id}) is not unique in the content model \"${model.modelId}\".`,\n                    \"FIELD_ID_NOT_UNIQUE_ERROR\",\n                    {\n                        model,\n                        field: input\n                    }\n                );\n            }\n\n            let storageId = input.storageId;\n            if (storageId) {\n                try {\n                    validateStorageId(storageId);\n                } catch (e) {\n                    throw WebinyError.from(e, {\n                        data: { model, storageId, field: input }\n                    });\n                }\n            } else {\n                storageId = createFieldStorageId(input);\n            }\n\n            /**\n             * Fields storageId must be unique.\n             */\n            if (storageIdList.includes(storageId)) {\n                throw new WebinyError(\n                    `Field's \"storageId\" is not unique in the content model \"${model.modelId}\".`,\n                    \"STORAGE_ID_ERROR\",\n                    {\n                        model,\n                        field: input\n                    }\n                );\n            }\n\n            /**\n             * We can safely ignore error because we are going through the fields and making sure each has storageId.\n             */\n            // @ts-expect-error\n            let settings: BaseCmsModelFieldSettings = input.settings;\n\n            const childFields = settings?.fields || [];\n            if (input.type === \"object\" && childFields.length > 0) {\n                settings = {\n                    ...(settings || {}),\n                    fields: this.buildFields(model, childFields)\n                };\n            }\n\n            const field: CmsModelFieldBase = {\n                ...input,\n                settings,\n                storageId\n            };\n            /**\n             * Add all relevant data to arrays.\n             */\n            fields.push(field);\n            storageIdList.push(field.storageId);\n            fieldIdList.push(field.fieldId);\n        }\n        return fields;\n    }\n\n    private validateLayout(model: CmsModelPluginModel): void {\n        /**\n         * Only skip validation if option.validateLayout was set as false, explicitly.\n         */\n        if (this.options.validateLayout === false) {\n            return;\n        }\n\n        const countFieldInLayout = (fieldId: string, layout: any[][]): number => {\n            let total = 0;\n            for (const row of layout) {\n                for (const cell of row) {\n                    if (typeof cell === \"string\") {\n                        if (cell === fieldId) {\n                            total++;\n                        }\n                    } else if (cell && typeof cell === \"object\" && Array.isArray(cell.tabs)) {\n                        for (const tab of cell.tabs) {\n                            if (Array.isArray(tab.layout)) {\n                                total += countFieldInLayout(fieldId, tab.layout);\n                            }\n                        }\n                    }\n                }\n            }\n            return total;\n        };\n\n        for (const field of model.fields) {\n            const total = countFieldInLayout(field.id, model.layout);\n            if (total === 1) {\n                continue;\n            } else if (total > 1) {\n                throw new WebinyError(\n                    `Field \"${field.id}\" is in more than one layout cell.`,\n                    \"DUPLICATE_FIELD_IN_LAYOUT\",\n                    {\n                        model,\n                        field\n                    }\n                );\n            }\n            throw new WebinyError(\n                `Missing field \"${field.id}\" in layout.`,\n                \"MISSING_FIELD_IN_LAYOUT\",\n                {\n                    model,\n                    field\n                }\n            );\n        }\n    }\n}\n\n/**\n * IMPORTANT! This function should NOT be used outside the `api-headless-cms` package!\n * @internal\n */\nexport const createModelPlugin = (\n    model: CmsModelInput,\n    options?: CmsModelPluginOptions\n): CmsModelPlugin => {\n    return new CmsModelPlugin(model, options);\n};\n\n/**\n * IMPORTANT! This function should NOT be used outside the `api-headless-cms` package!\n * @internal\n */\nexport const createPrivateModelPlugin = (\n    input: Omit<CmsPrivateModelFull, \"group\" | \"isPrivate\">\n): CmsModelPlugin => {\n    return createModelPlugin(\n        {\n            authorization: false,\n            noValidate: true,\n            isPrivate: true,\n            group: \"private\",\n            ...input\n        },\n        {\n            validateLayout: false\n        }\n    );\n};\n"],"names":["createApiName","name","upperFirst","camelCase","createPluralApiName","pluralize","CmsModelPlugin","Plugin","contentModel","options","input","isPrivate","singularApiName","pluralApiName","modelPlugin","model","inputFields","WebinyError","fields","storageIdList","fieldIdList","fieldId","lodashCamelCase","storageId","validateStorageId","e","createFieldStorageId","settings","childFields","field","countFieldInLayout","layout","total","row","cell","Array","tab","createModelPlugin","createPrivateModelPlugin"],"mappings":";;;;;;;AAcA,MAAMA,gBAAgB,CAACC,OACZC,WAAWC,UAAUF;AAGhC,MAAMG,sBAAsB,CAACH,OAClBI,UAAUL,cAAcC;AA6E5B,MAAMK,uBAAuBC;;aACA,IAAI,GAAW;;IAK/C,YAAYC,YAA2B,EAAEC,OAA+B,CAAE;QACtE,KAAK;QACL,IAAI,CAAC,OAAO,GAAGA,WAAW,CAAC;QAC3B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,UAAU,CAACD;IACxC;IAEQ,WAAWE,KAAoB,EAAuB;QAC1D,MAAMC,YAAYD,MAAM,SAAS,IAAI;QAErC,MAAME,kBAAkBF,MAAM,eAAe,GACvCV,cAAcU,MAAM,eAAe,IACnCV,cAAcU,MAAM,IAAI;QAE9B,MAAMG,gBAAgBH,MAAM,aAAa,GACnCV,cAAcU,MAAM,aAAa,IACjCN,oBAAoBM,MAAM,IAAI;QAEpC,MAAMI,cAAmC;YACrC,OAAOJ,MAAM,KAAK,IAAI;YACtB,aAAa;YACb,QAAQ,EAAE;YACV,UAAU;YACVC;YACA,MAAM;YACN,QAAQ,EAAE;YACV,SAASD,MAAM,OAAO;YACtB,MAAMA,MAAM,IAAI;YAChBG;YACAD;YACA,cAAc;QAClB;QAEA,IAAIF,MAAM,UAAU,EAAE;YAIlB,OAAOA,KAAK,CAAC,aAAa;YAE1B,OAAO;gBACH,GAAGI,WAAW;gBACd,GAAGJ,KAAK;gBAER,QAAQA,MAAM,MAAM;gBACpBG;gBACAD;YACJ;QACJ;QAEA,MAAMG,QAA6B;YAC/B,GAAGD,WAAW;YACd,GAAGJ,KAAK;YACRG;YACAD;YACA,QAAQ,IAAI,CAAC,WAAW,CAACF,OAAOA,MAAM,MAAM;QAChD;QACA,IAAI,CAAC,cAAc,CAACK;QACpB,OAAOA;IACX;IAEQ,YACJA,KAAoB,EACpBC,WAAiC,EACd;QACnB,IAAIA,AAAuB,MAAvBA,YAAY,MAAM,EAClB,MAAM,IAAIC,MACN,CAAC,sCAAsC,EAAEF,MAAM,OAAO,CAAC,EAAE,CAAC,EAC1D,kBACA;YACIA;QACJ;QAGR,MAAMG,SAA8B,EAAE;QACtC,MAAMC,gBAA0B,EAAE;QAClC,MAAMC,cAAwB,EAAE;QAChC,KAAK,MAAMV,SAASM,YAAa;YAI7B,IAAI,CAAEN,AAAAA,CAAAA,MAAM,OAAO,IAAI,EAAC,EAAG,IAAI,IAC3B,MAAM,IAAIO,MACN,CAAC,0DAA0D,EAAEF,MAAM,OAAO,CAAC,EAAE,CAAC,EAC9E,kBACA;gBACIA;gBACA,OAAOL;YACX;YAGR,MAAMW,UAAUC,UAAgBZ,MAAM,OAAO;YAI7C,IAAIW,AAA4B,SAA5BA,QAAQ,KAAK,CAAC,WACd,MAAM,IAAIJ,MACN,CAAC,uEAAuE,EAAEF,MAAM,OAAO,CAAC,+BAA+B,CAAC,EACxH,wBACA;gBACIA;gBACA,OAAOL;YACX;YAMR,IAAIW,YAAYX,MAAM,OAAO,EACzB,MAAM,IAAIO,MACN,CAAC,qEAAqE,EAAEF,MAAM,OAAO,CAAC,EAAE,CAAC,EACzF,wBACA;gBACIA;gBACA,OAAOL;YACX;YAMR,IAAIU,YAAY,QAAQ,CAACC,UACrB,MAAM,IAAIJ,MACN,CAAC,uBAAuB,EAAEP,MAAM,EAAE,CAAC,sCAAsC,EAAEK,MAAM,OAAO,CAAC,EAAE,CAAC,EAC5F,6BACA;gBACIA;gBACA,OAAOL;YACX;YAIR,IAAIa,YAAYb,MAAM,SAAS;YAC/B,IAAIa,WACA,IAAI;gBACAC,kBAAkBD;YACtB,EAAE,OAAOE,GAAG;gBACR,MAAMR,MAAAA,IAAgB,CAACQ,GAAG;oBACtB,MAAM;wBAAEV;wBAAOQ;wBAAW,OAAOb;oBAAM;gBAC3C;YACJ;iBAEAa,YAAYG,qBAAqBhB;YAMrC,IAAIS,cAAc,QAAQ,CAACI,YACvB,MAAM,IAAIN,MACN,CAAC,wDAAwD,EAAEF,MAAM,OAAO,CAAC,EAAE,CAAC,EAC5E,oBACA;gBACIA;gBACA,OAAOL;YACX;YAQR,IAAIiB,WAAsCjB,MAAM,QAAQ;YAExD,MAAMkB,cAAcD,UAAU,UAAU,EAAE;YAC1C,IAAIjB,AAAe,aAAfA,MAAM,IAAI,IAAiBkB,YAAY,MAAM,GAAG,GAChDD,WAAW;gBACP,GAAIA,YAAY,CAAC,CAAC;gBAClB,QAAQ,IAAI,CAAC,WAAW,CAACZ,OAAOa;YACpC;YAGJ,MAAMC,QAA2B;gBAC7B,GAAGnB,KAAK;gBACRiB;gBACAJ;YACJ;YAIAL,OAAO,IAAI,CAACW;YACZV,cAAc,IAAI,CAACU,MAAM,SAAS;YAClCT,YAAY,IAAI,CAACS,MAAM,OAAO;QAClC;QACA,OAAOX;IACX;IAEQ,eAAeH,KAA0B,EAAQ;QAIrD,IAAI,AAAgC,UAAhC,IAAI,CAAC,OAAO,CAAC,cAAc,EAC3B;QAGJ,MAAMe,qBAAqB,CAACT,SAAiBU;YACzC,IAAIC,QAAQ;YACZ,KAAK,MAAMC,OAAOF,OACd,KAAK,MAAMG,QAAQD,IACf,IAAI,AAAgB,YAAhB,OAAOC,MACP;gBAAA,IAAIA,SAASb,SACTW;YACJ,OACG,IAAIE,QAAQ,AAAgB,YAAhB,OAAOA,QAAqBC,MAAM,OAAO,CAACD,KAAK,IAAI,GAClE;gBAAA,KAAK,MAAME,OAAOF,KAAK,IAAI,CACvB,IAAIC,MAAM,OAAO,CAACC,IAAI,MAAM,GACxBJ,SAASF,mBAAmBT,SAASe,IAAI,MAAM;YAEvD;YAIZ,OAAOJ;QACX;QAEA,KAAK,MAAMH,SAASd,MAAM,MAAM,CAAE;YAC9B,MAAMiB,QAAQF,mBAAmBD,MAAM,EAAE,EAAEd,MAAM,MAAM;YACvD,IAAIiB,AAAU,MAAVA;gBAEG,IAAIA,QAAQ,GACf,MAAM,IAAIf,MACN,CAAC,OAAO,EAAEY,MAAM,EAAE,CAAC,kCAAkC,CAAC,EACtD,6BACA;oBACId;oBACAc;gBACJ;gBAGR,MAAM,IAAIZ,MACN,CAAC,eAAe,EAAEY,MAAM,EAAE,CAAC,YAAY,CAAC,EACxC,2BACA;oBACId;oBACAc;gBACJ;;QAER;IACJ;AACJ;AAMO,MAAMQ,oBAAoB,CAC7BtB,OACAN,UAEO,IAAIH,eAAeS,OAAON;AAO9B,MAAM6B,2BAA2B,CACpC5B,QAEO2B,kBACH;QACI,eAAe;QACf,YAAY;QACZ,WAAW;QACX,OAAO;QACP,GAAG3B,KAAK;IACZ,GACA;QACI,gBAAgB;IACpB"}
+{"version":3,"file":"plugins/CmsModelPlugin.js","sources":["../../src/plugins/CmsModelPlugin.ts"],"sourcesContent":["import WebinyError from \"@webiny/error\";\nimport lodashCamelCase from \"lodash/camelCase.js\";\nimport camelCase from \"lodash/camelCase.js\";\nimport upperFirst from \"lodash/upperFirst.js\";\nimport pluralize from \"pluralize\";\nimport { Plugin } from \"@webiny/plugins\";\nimport type {\n    CmsModel as CmsModelBase,\n    CmsModelField as CmsModelFieldBase,\n    CmsModelFieldSettings as BaseCmsModelFieldSettings\n} from \"~/types/index.js\";\nimport { createFieldStorageId } from \"~/crud/contentModel/createFieldStorageId.js\";\nimport { validateStorageId } from \"~/crud/contentModel/validateStorageId.js\";\n\nconst createApiName = (name: string) => {\n    return upperFirst(camelCase(name));\n};\n\nconst createPluralApiName = (name: string) => {\n    return pluralize(createApiName(name));\n};\n\ninterface CmsModelFieldSettings extends Omit<BaseCmsModelFieldSettings, \"fields\"> {\n    /**\n     * Object field has child fields.\n     */\n    fields?: CmsModelFieldInput[];\n}\n\ninterface CmsModelFieldInput extends Omit<CmsModelFieldBase, \"storageId\" | \"settings\"> {\n    /**\n     * If defined, it must be camelCased string.\n     * This is for backwards compatibility - before fields had storageId.\n     *\n     * This should only be populated in old model fields.\n     * New ones must have this empty.\n     */\n    storageId?: string;\n    /**\n     * We must have a possibility to have a nested field defined without the storageId.\n     */\n    settings?: CmsModelFieldSettings;\n}\n\nexport interface CmsApiModel extends Omit<\n    CmsModelPluginModel,\n    \"isPrivate\" | \"fields\" | \"singularApiName\" | \"pluralApiName\" | \"isPlugin\"\n> {\n    isPrivate?: never;\n    noValidate?: boolean;\n    singularApiName?: string;\n    pluralApiName?: string;\n    fields: CmsModelFieldInput[];\n}\n\nexport interface CmsApiModelFull extends Omit<CmsApiModel, \"fields\"> {\n    fields: CmsModelFieldBase[];\n}\n\ninterface CmsPrivateModel extends Omit<\n    CmsModelPluginModel,\n    | \"isPrivate\"\n    | \"singularApiName\"\n    | \"pluralApiName\"\n    | \"fields\"\n    | \"isPlugin\"\n    | \"layout\"\n    | \"icon\"\n    | \"titleFieldId\"\n    | \"description\"\n> {\n    noValidate?: boolean;\n    titleFieldId?: string;\n    singularApiName?: never;\n    pluralApiName?: never;\n    isPrivate: true;\n    fields: CmsModelFieldInput[];\n}\n\nexport interface CmsPrivateModelFull extends Omit<\n    CmsPrivateModel,\n    \"fields\" | \"createdBy\" | \"createdOn\" | \"savedOn\"\n> {\n    fields: CmsModelFieldBase[];\n}\n\nexport type CmsModelInput = CmsApiModel | CmsPrivateModel | CmsApiModelFull | CmsPrivateModelFull;\n\nexport interface CmsModelPluginModel extends Omit<CmsModelBase, \"tenant\"> {\n    tenant?: string;\n}\n\ninterface CmsModelPluginOptions {\n    validateLayout?: boolean;\n}\n\nexport class CmsModelPlugin extends Plugin {\n    public static override readonly type: string = \"cms-content-model\";\n    public readonly contentModel: CmsModelPluginModel;\n\n    private readonly options: CmsModelPluginOptions;\n\n    constructor(contentModel: CmsModelInput, options?: CmsModelPluginOptions) {\n        super();\n        this.options = options || {};\n        this.contentModel = this.buildModel(contentModel);\n    }\n\n    private buildModel(input: CmsModelInput): CmsModelPluginModel {\n        const isPrivate = input.isPrivate ?? false;\n\n        const singularApiName = input.singularApiName\n            ? createApiName(input.singularApiName)\n            : createApiName(input.name);\n\n        const pluralApiName = input.pluralApiName\n            ? createApiName(input.pluralApiName)\n            : createPluralApiName(input.name);\n\n        const modelPlugin: CmsModelPluginModel = {\n            group: input.group ?? \"ungrouped\",\n            description: \"\",\n            fields: [],\n            isPlugin: true,\n            isPrivate,\n            icon: null,\n            layout: [],\n            modelId: input.modelId,\n            name: input.name,\n            pluralApiName,\n            singularApiName,\n            titleFieldId: \"id\",\n            settings: {}\n        };\n\n        if (input.noValidate) {\n            /**\n             * We can safely ignore this error, because we are sure noValidate is not a model field.\n             */\n            delete input[\"noValidate\"];\n\n            return {\n                ...modelPlugin,\n                ...input,\n                // Since `noValidate` is set, we trust the input, and cast to `CmsModelFieldBase`.\n                fields: input.fields as CmsModelFieldBase[],\n                pluralApiName,\n                singularApiName\n            };\n        }\n\n        const model: CmsModelPluginModel = {\n            ...modelPlugin,\n            ...input,\n            pluralApiName,\n            singularApiName,\n            fields: this.buildFields(input, input.fields)\n        };\n        this.validateLayout(model);\n        return model;\n    }\n\n    private buildFields(\n        model: CmsModelInput,\n        inputFields: CmsModelFieldInput[]\n    ): CmsModelFieldBase[] {\n        if (inputFields.length === 0) {\n            throw new WebinyError(\n                `Missing fields for the defined model \"${model.modelId}\".`,\n                \"MISSING_FIELDS\",\n                {\n                    model\n                }\n            );\n        }\n        const fields: CmsModelFieldBase[] = [];\n        const storageIdList: string[] = [];\n        const fieldIdList: string[] = [];\n        for (const input of inputFields) {\n            /**\n             * Field must contain an fieldId. It is required in the graphql, but lets check it just in case\n             */\n            if (!(input.fieldId || \"\").trim()) {\n                throw new WebinyError(\n                    `Field's \"storageId\" is not defined for the content model \"${model.modelId}\".`,\n                    \"FIELD_ID_ERROR\",\n                    {\n                        model,\n                        field: input\n                    }\n                );\n            }\n            const fieldId = lodashCamelCase(input.fieldId);\n            /**\n             * FieldID must be in correct pattern.\n             */\n            if (fieldId.match(/^[0-9]/) !== null) {\n                throw new WebinyError(\n                    `Field's \"fieldId\" does not match correct pattern in the content model \"${model.modelId}\" - cannot start with a number.`,\n                    \"FIELD_FIELD_ID_ERROR\",\n                    {\n                        model,\n                        field: input\n                    }\n                );\n            }\n            /**\n             * FieldID also must be camelCased.\n             */\n            if (fieldId !== input.fieldId) {\n                throw new WebinyError(\n                    `Field's \"fieldId\" must be a camel cased string in the content model \"${model.modelId}\".`,\n                    \"FIELD_FIELD_ID_ERROR\",\n                    {\n                        model,\n                        field: input\n                    }\n                );\n            }\n            /**\n             * ... and fieldId must be unique.\n             */\n            if (fieldIdList.includes(fieldId)) {\n                throw new WebinyError(\n                    `Field's \"fieldId\" (id: ${input.id}) is not unique in the content model \"${model.modelId}\".`,\n                    \"FIELD_ID_NOT_UNIQUE_ERROR\",\n                    {\n                        model,\n                        field: input\n                    }\n                );\n            }\n\n            let storageId = input.storageId;\n            if (storageId) {\n                try {\n                    validateStorageId(storageId);\n                } catch (e) {\n                    throw WebinyError.from(e, {\n                        data: { model, storageId, field: input }\n                    });\n                }\n            } else {\n                storageId = createFieldStorageId(input);\n            }\n\n            /**\n             * Fields storageId must be unique.\n             */\n            if (storageIdList.includes(storageId)) {\n                throw new WebinyError(\n                    `Field's \"storageId\" is not unique in the content model \"${model.modelId}\".`,\n                    \"STORAGE_ID_ERROR\",\n                    {\n                        model,\n                        field: input\n                    }\n                );\n            }\n\n            /**\n             * We can safely ignore error because we are going through the fields and making sure each has storageId.\n             */\n            // @ts-expect-error\n            let settings: BaseCmsModelFieldSettings = input.settings;\n\n            const childFields = settings?.fields || [];\n            if (input.type === \"object\" && childFields.length > 0) {\n                settings = {\n                    ...(settings || {}),\n                    fields: this.buildFields(model, childFields)\n                };\n            }\n\n            const field: CmsModelFieldBase = {\n                ...input,\n                settings,\n                storageId\n            };\n            /**\n             * Add all relevant data to arrays.\n             */\n            fields.push(field);\n            storageIdList.push(field.storageId);\n            fieldIdList.push(field.fieldId);\n        }\n        return fields;\n    }\n\n    private validateLayout(model: CmsModelPluginModel): void {\n        /**\n         * Only skip validation if option.validateLayout was set as false, explicitly.\n         */\n        if (this.options.validateLayout === false) {\n            return;\n        }\n\n        const countFieldInLayout = (fieldId: string, layout: any[][]): number => {\n            let total = 0;\n            for (const row of layout) {\n                for (const cell of row) {\n                    if (typeof cell === \"string\") {\n                        if (cell === fieldId) {\n                            total++;\n                        }\n                    } else if (cell && typeof cell === \"object\" && Array.isArray(cell.tabs)) {\n                        for (const tab of cell.tabs) {\n                            if (Array.isArray(tab.layout)) {\n                                total += countFieldInLayout(fieldId, tab.layout);\n                            }\n                        }\n                    }\n                }\n            }\n            return total;\n        };\n\n        for (const field of model.fields) {\n            const total = countFieldInLayout(field.id, model.layout);\n            if (total === 1) {\n                continue;\n            } else if (total > 1) {\n                throw new WebinyError(\n                    `Field \"${field.id}\" is in more than one layout cell.`,\n                    \"DUPLICATE_FIELD_IN_LAYOUT\",\n                    {\n                        model,\n                        field\n                    }\n                );\n            }\n            throw new WebinyError(\n                `Missing field \"${field.id}\" in layout.`,\n                \"MISSING_FIELD_IN_LAYOUT\",\n                {\n                    model,\n                    field\n                }\n            );\n        }\n    }\n}\n\n/**\n * IMPORTANT! This function should NOT be used outside the `api-headless-cms` package!\n * @internal\n */\nexport const createModelPlugin = (\n    model: CmsModelInput,\n    options?: CmsModelPluginOptions\n): CmsModelPlugin => {\n    return new CmsModelPlugin(model, options);\n};\n\n/**\n * IMPORTANT! This function should NOT be used outside the `api-headless-cms` package!\n * @internal\n */\nexport const createPrivateModelPlugin = (\n    input: Omit<CmsPrivateModelFull, \"group\" | \"isPrivate\">\n): CmsModelPlugin => {\n    return createModelPlugin(\n        {\n            authorization: false,\n            noValidate: true,\n            isPrivate: true,\n            group: \"private\",\n            ...input\n        },\n        {\n            validateLayout: false\n        }\n    );\n};\n"],"names":["createApiName","name","upperFirst","camelCase","createPluralApiName","pluralize","CmsModelPlugin","Plugin","contentModel","options","input","isPrivate","singularApiName","pluralApiName","modelPlugin","model","inputFields","WebinyError","fields","storageIdList","fieldIdList","fieldId","lodashCamelCase","storageId","validateStorageId","e","createFieldStorageId","settings","childFields","field","countFieldInLayout","layout","total","row","cell","Array","tab","createModelPlugin","createPrivateModelPlugin"],"mappings":";;;;;;;AAcA,MAAMA,gBAAgB,CAACC,OACZC,WAAWC,UAAUF;AAGhC,MAAMG,sBAAsB,CAACH,OAClBI,UAAUL,cAAcC;AA6E5B,MAAMK,uBAAuBC;;aACA,IAAI,GAAW;;IAK/C,YAAYC,YAA2B,EAAEC,OAA+B,CAAE;QACtE,KAAK;QACL,IAAI,CAAC,OAAO,GAAGA,WAAW,CAAC;QAC3B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,UAAU,CAACD;IACxC;IAEQ,WAAWE,KAAoB,EAAuB;QAC1D,MAAMC,YAAYD,MAAM,SAAS,IAAI;QAErC,MAAME,kBAAkBF,MAAM,eAAe,GACvCV,cAAcU,MAAM,eAAe,IACnCV,cAAcU,MAAM,IAAI;QAE9B,MAAMG,gBAAgBH,MAAM,aAAa,GACnCV,cAAcU,MAAM,aAAa,IACjCN,oBAAoBM,MAAM,IAAI;QAEpC,MAAMI,cAAmC;YACrC,OAAOJ,MAAM,KAAK,IAAI;YACtB,aAAa;YACb,QAAQ,EAAE;YACV,UAAU;YACVC;YACA,MAAM;YACN,QAAQ,EAAE;YACV,SAASD,MAAM,OAAO;YACtB,MAAMA,MAAM,IAAI;YAChBG;YACAD;YACA,cAAc;YACd,UAAU,CAAC;QACf;QAEA,IAAIF,MAAM,UAAU,EAAE;YAIlB,OAAOA,KAAK,CAAC,aAAa;YAE1B,OAAO;gBACH,GAAGI,WAAW;gBACd,GAAGJ,KAAK;gBAER,QAAQA,MAAM,MAAM;gBACpBG;gBACAD;YACJ;QACJ;QAEA,MAAMG,QAA6B;YAC/B,GAAGD,WAAW;YACd,GAAGJ,KAAK;YACRG;YACAD;YACA,QAAQ,IAAI,CAAC,WAAW,CAACF,OAAOA,MAAM,MAAM;QAChD;QACA,IAAI,CAAC,cAAc,CAACK;QACpB,OAAOA;IACX;IAEQ,YACJA,KAAoB,EACpBC,WAAiC,EACd;QACnB,IAAIA,AAAuB,MAAvBA,YAAY,MAAM,EAClB,MAAM,IAAIC,MACN,CAAC,sCAAsC,EAAEF,MAAM,OAAO,CAAC,EAAE,CAAC,EAC1D,kBACA;YACIA;QACJ;QAGR,MAAMG,SAA8B,EAAE;QACtC,MAAMC,gBAA0B,EAAE;QAClC,MAAMC,cAAwB,EAAE;QAChC,KAAK,MAAMV,SAASM,YAAa;YAI7B,IAAI,CAAEN,AAAAA,CAAAA,MAAM,OAAO,IAAI,EAAC,EAAG,IAAI,IAC3B,MAAM,IAAIO,MACN,CAAC,0DAA0D,EAAEF,MAAM,OAAO,CAAC,EAAE,CAAC,EAC9E,kBACA;gBACIA;gBACA,OAAOL;YACX;YAGR,MAAMW,UAAUC,UAAgBZ,MAAM,OAAO;YAI7C,IAAIW,AAA4B,SAA5BA,QAAQ,KAAK,CAAC,WACd,MAAM,IAAIJ,MACN,CAAC,uEAAuE,EAAEF,MAAM,OAAO,CAAC,+BAA+B,CAAC,EACxH,wBACA;gBACIA;gBACA,OAAOL;YACX;YAMR,IAAIW,YAAYX,MAAM,OAAO,EACzB,MAAM,IAAIO,MACN,CAAC,qEAAqE,EAAEF,MAAM,OAAO,CAAC,EAAE,CAAC,EACzF,wBACA;gBACIA;gBACA,OAAOL;YACX;YAMR,IAAIU,YAAY,QAAQ,CAACC,UACrB,MAAM,IAAIJ,MACN,CAAC,uBAAuB,EAAEP,MAAM,EAAE,CAAC,sCAAsC,EAAEK,MAAM,OAAO,CAAC,EAAE,CAAC,EAC5F,6BACA;gBACIA;gBACA,OAAOL;YACX;YAIR,IAAIa,YAAYb,MAAM,SAAS;YAC/B,IAAIa,WACA,IAAI;gBACAC,kBAAkBD;YACtB,EAAE,OAAOE,GAAG;gBACR,MAAMR,MAAAA,IAAgB,CAACQ,GAAG;oBACtB,MAAM;wBAAEV;wBAAOQ;wBAAW,OAAOb;oBAAM;gBAC3C;YACJ;iBAEAa,YAAYG,qBAAqBhB;YAMrC,IAAIS,cAAc,QAAQ,CAACI,YACvB,MAAM,IAAIN,MACN,CAAC,wDAAwD,EAAEF,MAAM,OAAO,CAAC,EAAE,CAAC,EAC5E,oBACA;gBACIA;gBACA,OAAOL;YACX;YAQR,IAAIiB,WAAsCjB,MAAM,QAAQ;YAExD,MAAMkB,cAAcD,UAAU,UAAU,EAAE;YAC1C,IAAIjB,AAAe,aAAfA,MAAM,IAAI,IAAiBkB,YAAY,MAAM,GAAG,GAChDD,WAAW;gBACP,GAAIA,YAAY,CAAC,CAAC;gBAClB,QAAQ,IAAI,CAAC,WAAW,CAACZ,OAAOa;YACpC;YAGJ,MAAMC,QAA2B;gBAC7B,GAAGnB,KAAK;gBACRiB;gBACAJ;YACJ;YAIAL,OAAO,IAAI,CAACW;YACZV,cAAc,IAAI,CAACU,MAAM,SAAS;YAClCT,YAAY,IAAI,CAACS,MAAM,OAAO;QAClC;QACA,OAAOX;IACX;IAEQ,eAAeH,KAA0B,EAAQ;QAIrD,IAAI,AAAgC,UAAhC,IAAI,CAAC,OAAO,CAAC,cAAc,EAC3B;QAGJ,MAAMe,qBAAqB,CAACT,SAAiBU;YACzC,IAAIC,QAAQ;YACZ,KAAK,MAAMC,OAAOF,OACd,KAAK,MAAMG,QAAQD,IACf,IAAI,AAAgB,YAAhB,OAAOC,MACP;gBAAA,IAAIA,SAASb,SACTW;YACJ,OACG,IAAIE,QAAQ,AAAgB,YAAhB,OAAOA,QAAqBC,MAAM,OAAO,CAACD,KAAK,IAAI,GAClE;gBAAA,KAAK,MAAME,OAAOF,KAAK,IAAI,CACvB,IAAIC,MAAM,OAAO,CAACC,IAAI,MAAM,GACxBJ,SAASF,mBAAmBT,SAASe,IAAI,MAAM;YAEvD;YAIZ,OAAOJ;QACX;QAEA,KAAK,MAAMH,SAASd,MAAM,MAAM,CAAE;YAC9B,MAAMiB,QAAQF,mBAAmBD,MAAM,EAAE,EAAEd,MAAM,MAAM;YACvD,IAAIiB,AAAU,MAAVA;gBAEG,IAAIA,QAAQ,GACf,MAAM,IAAIf,MACN,CAAC,OAAO,EAAEY,MAAM,EAAE,CAAC,kCAAkC,CAAC,EACtD,6BACA;oBACId;oBACAc;gBACJ;gBAGR,MAAM,IAAIZ,MACN,CAAC,eAAe,EAAEY,MAAM,EAAE,CAAC,YAAY,CAAC,EACxC,2BACA;oBACId;oBACAc;gBACJ;;QAER;IACJ;AACJ;AAMO,MAAMQ,oBAAoB,CAC7BtB,OACAN,UAEO,IAAIH,eAAeS,OAAON;AAO9B,MAAM6B,2BAA2B,CACpC5B,QAEO2B,kBACH;QACI,eAAe;QACf,YAAY;QACZ,WAAW;QACX,OAAO;QACP,GAAG3B,KAAK;IACZ,GACA;QACI,gBAAgB;IACpB"}

package/types/fields/dynamicZoneField.d.ts

@@ -1,5 +1,5 @@
 import type { CmsModelField, CmsModelFieldValidation } from "../modelField.js";
-import type { CmsIcon } from "../../types/index.js";
+import type { CmsIcon, CmsModelLayoutCell } from "../../types/index.js";
 export interface CmsDynamicZoneTemplate {
     id: string;
     name: string;
@@ -7,9 +7,10 @@ export interface CmsDynamicZoneTemplate {
     description: string;
     icon?: CmsIcon;
     fields: CmsModelField[];
-    layout: string[][];
+    layout: CmsModelLayoutCell[][];
     validation: CmsModelFieldValidation[];
     tags?: string[];
+    componentName?: string;
 }
 /**
  * A definition for dynamic-zone field to show possible type of the field in settings.

package/types/model.d.ts

@@ -1,6 +1,7 @@
 import type { CmsIdentity } from "./identity.js";
 import type { CmsModelField, CmsModelFieldInput, FieldRule } from "./modelField.js";
 import type { CmsIcon } from "../types/types.js";
+import type { IModelSettings } from "../features/modelBuilder/abstractions.js";
 export interface CmsTabLayoutTab {
     id: string;
     label: string;
@@ -140,6 +141,10 @@ export interface CmsModel {
      * Is this model created via plugin?
      */
     isPlugin?: boolean;
+    /**
+     * Arbitrary model-level settings (e.g., feature flags).
+     */
+    settings?: IModelSettings | null;
 }
 export interface StorageCmsModelFields {
     compression: string;
@@ -209,6 +214,7 @@ export interface CmsModelCreateInput {
     descriptionFieldId?: string | null;
     imageFieldId?: string | null;
     icon?: CmsIcon | null;
+    settings?: IModelSettings | null;
 }
 /**
  * A GraphQL `params.data` parameter received when creating content model from existing model.

package/types/modelField.d.ts

@@ -1,9 +1,10 @@
 import type { CmsModel, CmsModelLayout } from "./model.js";
 import type { GenericRecord } from "@webiny/api/types.js";
 import type { CmsDynamicZoneTemplate } from "../types/fields/dynamicZoneField.js";
+import type { IModelSettings } from "../features/modelBuilder/abstractions.js";
 export type FieldRuleAction = "hide" | "disable" | string;
 export interface FieldRule {
-    type: "accessControl" | "entryValue";
+    type: "accessControl" | "condition";
     target: string;
     operator: string;
     value: string | number | boolean | null;
@@ -242,6 +243,7 @@ export interface CmsModelUpdateInput {
     titleFieldId?: string | null;
     descriptionFieldId?: string | null;
     imageFieldId?: string | null;
+    settings?: IModelSettings | null;
 }
 /**
  * Object containing content model field renderer options.