@webiny/api-headless-cms 6.0.0-rc.1 → 6.0.0-rc.3

package/plugins/CmsModelPlugin.js.map

@@ -1 +1 @@
-{"version":3,"names":["WebinyError","lodashCamelCase","camelCase","upperFirst","pluralize","Plugin","createFieldStorageId","validateStorageId","createApiName","name","createPluralApiName","CmsModelPlugin","type","constructor","contentModel","options","buildModel","input","isPrivate","singularApiName","pluralApiName","modelPlugin","group","description","fields","isPlugin","icon","layout","modelId","titleFieldId","noValidate","model","buildFields","validateLayout","inputFields","length","storageIdList","fieldIdList","fieldId","trim","field","match","includes","id","storageId","e","from","data","settings","childFields","push","total","row","count","filter","cell","createModelPlugin","createPrivateModelPlugin","authorization"],"sources":["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\n    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\n    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\n    extends Omit<CmsPrivateModel, \"fields\" | \"createdBy\" | \"createdOn\" | \"savedOn\"> {\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        for (const field of model.fields) {\n            let total = 0;\n            for (const row of model.layout) {\n                const count = row.filter(cell => cell === field.id).length;\n                total = total + count;\n            }\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"],"mappings":"AAAA,OAAOA,WAAW,MAAM,eAAe;AACvC,OAAOC,eAAe,MAAM,qBAAqB;AACjD,OAAOC,SAAS,MAAM,qBAAqB;AAC3C,OAAOC,UAAU,MAAM,sBAAsB;AAC7C,OAAOC,SAAS,MAAM,WAAW;AACjC,SAASC,MAAM,QAAQ,iBAAiB;AAMxC,SAASC,oBAAoB;AAC7B,SAASC,iBAAiB;AAE1B,MAAMC,aAAa,GAAIC,IAAY,IAAK;EACpC,OAAON,UAAU,CAACD,SAAS,CAACO,IAAI,CAAC,CAAC;AACtC,CAAC;AAED,MAAMC,mBAAmB,GAAID,IAAY,IAAK;EAC1C,OAAOL,SAAS,CAACI,aAAa,CAACC,IAAI,CAAC,CAAC;AACzC,CAAC;AA4ED,OAAO,MAAME,cAAc,SAASN,MAAM,CAAC;EACvC,OAAgCO,IAAI,GAAW,mBAAmB;EAKlEC,WAAWA,CAACC,YAA2B,EAAEC,OAA+B,EAAE;IACtE,KAAK,CAAC,CAAC;IACP,IAAI,CAACA,OAAO,GAAGA,OAAO,IAAI,CAAC,CAAC;IAC5B,IAAI,CAACD,YAAY,GAAG,IAAI,CAACE,UAAU,CAACF,YAAY,CAAC;EACrD;EAEQE,UAAUA,CAACC,KAAoB,EAAuB;IAC1D,MAAMC,SAAS,GAAGD,KAAK,CAACC,SAAS,IAAI,KAAK;IAE1C,MAAMC,eAAe,GAAGF,KAAK,CAACE,eAAe,GACvCX,aAAa,CAACS,KAAK,CAACE,eAAe,CAAC,GACpCX,aAAa,CAACS,KAAK,CAACR,IAAI,CAAC;IAE/B,MAAMW,aAAa,GAAGH,KAAK,CAACG,aAAa,GACnCZ,aAAa,CAACS,KAAK,CAACG,aAAa,CAAC,GAClCV,mBAAmB,CAACO,KAAK,CAACR,IAAI,CAAC;IAErC,MAAMY,WAAgC,GAAG;MACrCC,KAAK,EAAEL,KAAK,CAACK,KAAK,IAAI,WAAW;MACjCC,WAAW,EAAE,EAAE;MACfC,MAAM,EAAE,EAAE;MACVC,QAAQ,EAAE,IAAI;MACdP,SAAS;MACTQ,IAAI,EAAE,IAAI;MACVC,MAAM,EAAE,EAAE;MACVC,OAAO,EAAEX,KAAK,CAACW,OAAO;MACtBnB,IAAI,EAAEQ,KAAK,CAACR,IAAI;MAChBW,aAAa;MACbD,eAAe;MACfU,YAAY,EAAE;IAClB,CAAC;IAED,IAAIZ,KAAK,CAACa,UAAU,EAAE;MAClB;AACZ;AACA;MACY,OAAOb,KAAK,CAAC,YAAY,CAAC;MAE1B,OAAO;QACH,GAAGI,WAAW;QACd,GAAGJ,KAAK;QACR;QACAO,MAAM,EAAEP,KAAK,CAACO,MAA6B;QAC3CJ,aAAa;QACbD;MACJ,CAAC;IACL;IAEA,MAAMY,KAA0B,GAAG;MAC/B,GAAGV,WAAW;MACd,GAAGJ,KAAK;MACRG,aAAa;MACbD,eAAe;MACfK,MAAM,EAAE,IAAI,CAACQ,WAAW,CAACf,KAAK,EAAEA,KAAK,CAACO,MAAM;IAChD,CAAC;IACD,IAAI,CAACS,cAAc,CAACF,KAAK,CAAC;IAC1B,OAAOA,KAAK;EAChB;EAEQC,WAAWA,CACfD,KAAoB,EACpBG,WAAiC,EACd;IACnB,IAAIA,WAAW,CAACC,MAAM,KAAK,CAAC,EAAE;MAC1B,MAAM,IAAInC,WAAW,CACjB,yCAAyC+B,KAAK,CAACH,OAAO,IAAI,EAC1D,gBAAgB,EAChB;QACIG;MACJ,CACJ,CAAC;IACL;IACA,MAAMP,MAA2B,GAAG,EAAE;IACtC,MAAMY,aAAuB,GAAG,EAAE;IAClC,MAAMC,WAAqB,GAAG,EAAE;IAChC,KAAK,MAAMpB,KAAK,IAAIiB,WAAW,EAAE;MAC7B;AACZ;AACA;MACY,IAAI,CAAC,CAACjB,KAAK,CAACqB,OAAO,IAAI,EAAE,EAAEC,IAAI,CAAC,CAAC,EAAE;QAC/B,MAAM,IAAIvC,WAAW,CACjB,6DAA6D+B,KAAK,CAACH,OAAO,IAAI,EAC9E,gBAAgB,EAChB;UACIG,KAAK;UACLS,KAAK,EAAEvB;QACX,CACJ,CAAC;MACL;MACA,MAAMqB,OAAO,GAAGrC,eAAe,CAACgB,KAAK,CAACqB,OAAO,CAAC;MAC9C;AACZ;AACA;MACY,IAAIA,OAAO,CAACG,KAAK,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;QAClC,MAAM,IAAIzC,WAAW,CACjB,0EAA0E+B,KAAK,CAACH,OAAO,iCAAiC,EACxH,sBAAsB,EACtB;UACIG,KAAK;UACLS,KAAK,EAAEvB;QACX,CACJ,CAAC;MACL;MACA;AACZ;AACA;MACY,IAAIqB,OAAO,KAAKrB,KAAK,CAACqB,OAAO,EAAE;QAC3B,MAAM,IAAItC,WAAW,CACjB,wEAAwE+B,KAAK,CAACH,OAAO,IAAI,EACzF,sBAAsB,EACtB;UACIG,KAAK;UACLS,KAAK,EAAEvB;QACX,CACJ,CAAC;MACL;MACA;AACZ;AACA;MACY,IAAIoB,WAAW,CAACK,QAAQ,CAACJ,OAAO,CAAC,EAAE;QAC/B,MAAM,IAAItC,WAAW,CACjB,0BAA0BiB,KAAK,CAAC0B,EAAE,yCAAyCZ,KAAK,CAACH,OAAO,IAAI,EAC5F,2BAA2B,EAC3B;UACIG,KAAK;UACLS,KAAK,EAAEvB;QACX,CACJ,CAAC;MACL;MAEA,IAAI2B,SAAS,GAAG3B,KAAK,CAAC2B,SAAS;MAC/B,IAAIA,SAAS,EAAE;QACX,IAAI;UACArC,iBAAiB,CAACqC,SAAS,CAAC;QAChC,CAAC,CAAC,OAAOC,CAAC,EAAE;UACR,MAAM7C,WAAW,CAAC8C,IAAI,CAACD,CAAC,EAAE;YACtBE,IAAI,EAAE;cAAEhB,KAAK;cAAEa,SAAS;cAAEJ,KAAK,EAAEvB;YAAM;UAC3C,CAAC,CAAC;QACN;MACJ,CAAC,MAAM;QACH2B,SAAS,GAAGtC,oBAAoB,CAACW,KAAK,CAAC;MAC3C;;MAEA;AACZ;AACA;MACY,IAAImB,aAAa,CAACM,QAAQ,CAACE,SAAS,CAAC,EAAE;QACnC,MAAM,IAAI5C,WAAW,CACjB,2DAA2D+B,KAAK,CAACH,OAAO,IAAI,EAC5E,kBAAkB,EAClB;UACIG,KAAK;UACLS,KAAK,EAAEvB;QACX,CACJ,CAAC;MACL;;MAEA;AACZ;AACA;MACY;MACA,IAAI+B,QAAmC,GAAG/B,KAAK,CAAC+B,QAAQ;MAExD,MAAMC,WAAW,GAAGD,QAAQ,EAAExB,MAAM,IAAI,EAAE;MAC1C,IAAIP,KAAK,CAACL,IAAI,KAAK,QAAQ,IAAIqC,WAAW,CAACd,MAAM,GAAG,CAAC,EAAE;QACnDa,QAAQ,GAAG;UACP,IAAIA,QAAQ,IAAI,CAAC,CAAC,CAAC;UACnBxB,MAAM,EAAE,IAAI,CAACQ,WAAW,CAACD,KAAK,EAAEkB,WAAW;QAC/C,CAAC;MACL;MAEA,MAAMT,KAAwB,GAAG;QAC7B,GAAGvB,KAAK;QACR+B,QAAQ;QACRJ;MACJ,CAAC;MACD;AACZ;AACA;MACYpB,MAAM,CAAC0B,IAAI,CAACV,KAAK,CAAC;MAClBJ,aAAa,CAACc,IAAI,CAACV,KAAK,CAACI,SAAS,CAAC;MACnCP,WAAW,CAACa,IAAI,CAACV,KAAK,CAACF,OAAO,CAAC;IACnC;IACA,OAAOd,MAAM;EACjB;EAEQS,cAAcA,CAACF,KAA0B,EAAQ;IACrD;AACR;AACA;IACQ,IAAI,IAAI,CAAChB,OAAO,CAACkB,cAAc,KAAK,KAAK,EAAE;MACvC;IACJ;IACA,KAAK,MAAMO,KAAK,IAAIT,KAAK,CAACP,MAAM,EAAE;MAC9B,IAAI2B,KAAK,GAAG,CAAC;MACb,KAAK,MAAMC,GAAG,IAAIrB,KAAK,CAACJ,MAAM,EAAE;QAC5B,MAAM0B,KAAK,GAAGD,GAAG,CAACE,MAAM,CAACC,IAAI,IAAIA,IAAI,KAAKf,KAAK,CAACG,EAAE,CAAC,CAACR,MAAM;QAC1DgB,KAAK,GAAGA,KAAK,GAAGE,KAAK;MACzB;MACA,IAAIF,KAAK,KAAK,CAAC,EAAE;QACb;MACJ,CAAC,MAAM,IAAIA,KAAK,GAAG,CAAC,EAAE;QAClB,MAAM,IAAInD,WAAW,CACjB,UAAUwC,KAAK,CAACG,EAAE,oCAAoC,EACtD,2BAA2B,EAC3B;UACIZ,KAAK;UACLS;QACJ,CACJ,CAAC;MACL;MACA,MAAM,IAAIxC,WAAW,CACjB,kBAAkBwC,KAAK,CAACG,EAAE,cAAc,EACxC,yBAAyB,EACzB;QACIZ,KAAK;QACLS;MACJ,CACJ,CAAC;IACL;EACJ;AACJ;;AAEA;AACA;AACA;AACA;AACA,OAAO,MAAMgB,iBAAiB,GAAGA,CAC7BzB,KAAoB,EACpBhB,OAA+B,KACd;EACjB,OAAO,IAAIJ,cAAc,CAACoB,KAAK,EAAEhB,OAAO,CAAC;AAC7C,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,MAAM0C,wBAAwB,GACjCxC,KAAuD,IACtC;EACjB,OAAOuC,iBAAiB,CACpB;IACIE,aAAa,EAAE,KAAK;IACpB5B,UAAU,EAAE,IAAI;IAChBZ,SAAS,EAAE,IAAI;IACfI,KAAK,EAAE,SAAS;IAChB,GAAGL;EACP,CAAC,EACD;IACIgB,cAAc,EAAE;EACpB,CACJ,CAAC;AACL,CAAC","ignoreList":[]}
+{"version":3,"names":["WebinyError","lodashCamelCase","camelCase","upperFirst","pluralize","Plugin","createFieldStorageId","validateStorageId","createApiName","name","createPluralApiName","CmsModelPlugin","type","constructor","contentModel","options","buildModel","input","isPrivate","singularApiName","pluralApiName","modelPlugin","group","description","fields","isPlugin","icon","layout","modelId","titleFieldId","noValidate","model","buildFields","validateLayout","inputFields","length","storageIdList","fieldIdList","fieldId","trim","field","match","includes","id","storageId","e","from","data","settings","childFields","push","countFieldInLayout","total","row","cell","Array","isArray","tabs","tab","createModelPlugin","createPrivateModelPlugin","authorization"],"sources":["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\n    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\n    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\n    extends Omit<CmsPrivateModel, \"fields\" | \"createdBy\" | \"createdOn\" | \"savedOn\"> {\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"],"mappings":"AAAA,OAAOA,WAAW,MAAM,eAAe;AACvC,OAAOC,eAAe,MAAM,qBAAqB;AACjD,OAAOC,SAAS,MAAM,qBAAqB;AAC3C,OAAOC,UAAU,MAAM,sBAAsB;AAC7C,OAAOC,SAAS,MAAM,WAAW;AACjC,SAASC,MAAM,QAAQ,iBAAiB;AAMxC,SAASC,oBAAoB;AAC7B,SAASC,iBAAiB;AAE1B,MAAMC,aAAa,GAAIC,IAAY,IAAK;EACpC,OAAON,UAAU,CAACD,SAAS,CAACO,IAAI,CAAC,CAAC;AACtC,CAAC;AAED,MAAMC,mBAAmB,GAAID,IAAY,IAAK;EAC1C,OAAOL,SAAS,CAACI,aAAa,CAACC,IAAI,CAAC,CAAC;AACzC,CAAC;AA4ED,OAAO,MAAME,cAAc,SAASN,MAAM,CAAC;EACvC,OAAgCO,IAAI,GAAW,mBAAmB;EAKlEC,WAAWA,CAACC,YAA2B,EAAEC,OAA+B,EAAE;IACtE,KAAK,CAAC,CAAC;IACP,IAAI,CAACA,OAAO,GAAGA,OAAO,IAAI,CAAC,CAAC;IAC5B,IAAI,CAACD,YAAY,GAAG,IAAI,CAACE,UAAU,CAACF,YAAY,CAAC;EACrD;EAEQE,UAAUA,CAACC,KAAoB,EAAuB;IAC1D,MAAMC,SAAS,GAAGD,KAAK,CAACC,SAAS,IAAI,KAAK;IAE1C,MAAMC,eAAe,GAAGF,KAAK,CAACE,eAAe,GACvCX,aAAa,CAACS,KAAK,CAACE,eAAe,CAAC,GACpCX,aAAa,CAACS,KAAK,CAACR,IAAI,CAAC;IAE/B,MAAMW,aAAa,GAAGH,KAAK,CAACG,aAAa,GACnCZ,aAAa,CAACS,KAAK,CAACG,aAAa,CAAC,GAClCV,mBAAmB,CAACO,KAAK,CAACR,IAAI,CAAC;IAErC,MAAMY,WAAgC,GAAG;MACrCC,KAAK,EAAEL,KAAK,CAACK,KAAK,IAAI,WAAW;MACjCC,WAAW,EAAE,EAAE;MACfC,MAAM,EAAE,EAAE;MACVC,QAAQ,EAAE,IAAI;MACdP,SAAS;MACTQ,IAAI,EAAE,IAAI;MACVC,MAAM,EAAE,EAAE;MACVC,OAAO,EAAEX,KAAK,CAACW,OAAO;MACtBnB,IAAI,EAAEQ,KAAK,CAACR,IAAI;MAChBW,aAAa;MACbD,eAAe;MACfU,YAAY,EAAE;IAClB,CAAC;IAED,IAAIZ,KAAK,CAACa,UAAU,EAAE;MAClB;AACZ;AACA;MACY,OAAOb,KAAK,CAAC,YAAY,CAAC;MAE1B,OAAO;QACH,GAAGI,WAAW;QACd,GAAGJ,KAAK;QACR;QACAO,MAAM,EAAEP,KAAK,CAACO,MAA6B;QAC3CJ,aAAa;QACbD;MACJ,CAAC;IACL;IAEA,MAAMY,KAA0B,GAAG;MAC/B,GAAGV,WAAW;MACd,GAAGJ,KAAK;MACRG,aAAa;MACbD,eAAe;MACfK,MAAM,EAAE,IAAI,CAACQ,WAAW,CAACf,KAAK,EAAEA,KAAK,CAACO,MAAM;IAChD,CAAC;IACD,IAAI,CAACS,cAAc,CAACF,KAAK,CAAC;IAC1B,OAAOA,KAAK;EAChB;EAEQC,WAAWA,CACfD,KAAoB,EACpBG,WAAiC,EACd;IACnB,IAAIA,WAAW,CAACC,MAAM,KAAK,CAAC,EAAE;MAC1B,MAAM,IAAInC,WAAW,CACjB,yCAAyC+B,KAAK,CAACH,OAAO,IAAI,EAC1D,gBAAgB,EAChB;QACIG;MACJ,CACJ,CAAC;IACL;IACA,MAAMP,MAA2B,GAAG,EAAE;IACtC,MAAMY,aAAuB,GAAG,EAAE;IAClC,MAAMC,WAAqB,GAAG,EAAE;IAChC,KAAK,MAAMpB,KAAK,IAAIiB,WAAW,EAAE;MAC7B;AACZ;AACA;MACY,IAAI,CAAC,CAACjB,KAAK,CAACqB,OAAO,IAAI,EAAE,EAAEC,IAAI,CAAC,CAAC,EAAE;QAC/B,MAAM,IAAIvC,WAAW,CACjB,6DAA6D+B,KAAK,CAACH,OAAO,IAAI,EAC9E,gBAAgB,EAChB;UACIG,KAAK;UACLS,KAAK,EAAEvB;QACX,CACJ,CAAC;MACL;MACA,MAAMqB,OAAO,GAAGrC,eAAe,CAACgB,KAAK,CAACqB,OAAO,CAAC;MAC9C;AACZ;AACA;MACY,IAAIA,OAAO,CAACG,KAAK,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;QAClC,MAAM,IAAIzC,WAAW,CACjB,0EAA0E+B,KAAK,CAACH,OAAO,iCAAiC,EACxH,sBAAsB,EACtB;UACIG,KAAK;UACLS,KAAK,EAAEvB;QACX,CACJ,CAAC;MACL;MACA;AACZ;AACA;MACY,IAAIqB,OAAO,KAAKrB,KAAK,CAACqB,OAAO,EAAE;QAC3B,MAAM,IAAItC,WAAW,CACjB,wEAAwE+B,KAAK,CAACH,OAAO,IAAI,EACzF,sBAAsB,EACtB;UACIG,KAAK;UACLS,KAAK,EAAEvB;QACX,CACJ,CAAC;MACL;MACA;AACZ;AACA;MACY,IAAIoB,WAAW,CAACK,QAAQ,CAACJ,OAAO,CAAC,EAAE;QAC/B,MAAM,IAAItC,WAAW,CACjB,0BAA0BiB,KAAK,CAAC0B,EAAE,yCAAyCZ,KAAK,CAACH,OAAO,IAAI,EAC5F,2BAA2B,EAC3B;UACIG,KAAK;UACLS,KAAK,EAAEvB;QACX,CACJ,CAAC;MACL;MAEA,IAAI2B,SAAS,GAAG3B,KAAK,CAAC2B,SAAS;MAC/B,IAAIA,SAAS,EAAE;QACX,IAAI;UACArC,iBAAiB,CAACqC,SAAS,CAAC;QAChC,CAAC,CAAC,OAAOC,CAAC,EAAE;UACR,MAAM7C,WAAW,CAAC8C,IAAI,CAACD,CAAC,EAAE;YACtBE,IAAI,EAAE;cAAEhB,KAAK;cAAEa,SAAS;cAAEJ,KAAK,EAAEvB;YAAM;UAC3C,CAAC,CAAC;QACN;MACJ,CAAC,MAAM;QACH2B,SAAS,GAAGtC,oBAAoB,CAACW,KAAK,CAAC;MAC3C;;MAEA;AACZ;AACA;MACY,IAAImB,aAAa,CAACM,QAAQ,CAACE,SAAS,CAAC,EAAE;QACnC,MAAM,IAAI5C,WAAW,CACjB,2DAA2D+B,KAAK,CAACH,OAAO,IAAI,EAC5E,kBAAkB,EAClB;UACIG,KAAK;UACLS,KAAK,EAAEvB;QACX,CACJ,CAAC;MACL;;MAEA;AACZ;AACA;MACY;MACA,IAAI+B,QAAmC,GAAG/B,KAAK,CAAC+B,QAAQ;MAExD,MAAMC,WAAW,GAAGD,QAAQ,EAAExB,MAAM,IAAI,EAAE;MAC1C,IAAIP,KAAK,CAACL,IAAI,KAAK,QAAQ,IAAIqC,WAAW,CAACd,MAAM,GAAG,CAAC,EAAE;QACnDa,QAAQ,GAAG;UACP,IAAIA,QAAQ,IAAI,CAAC,CAAC,CAAC;UACnBxB,MAAM,EAAE,IAAI,CAACQ,WAAW,CAACD,KAAK,EAAEkB,WAAW;QAC/C,CAAC;MACL;MAEA,MAAMT,KAAwB,GAAG;QAC7B,GAAGvB,KAAK;QACR+B,QAAQ;QACRJ;MACJ,CAAC;MACD;AACZ;AACA;MACYpB,MAAM,CAAC0B,IAAI,CAACV,KAAK,CAAC;MAClBJ,aAAa,CAACc,IAAI,CAACV,KAAK,CAACI,SAAS,CAAC;MACnCP,WAAW,CAACa,IAAI,CAACV,KAAK,CAACF,OAAO,CAAC;IACnC;IACA,OAAOd,MAAM;EACjB;EAEQS,cAAcA,CAACF,KAA0B,EAAQ;IACrD;AACR;AACA;IACQ,IAAI,IAAI,CAAChB,OAAO,CAACkB,cAAc,KAAK,KAAK,EAAE;MACvC;IACJ;IAEA,MAAMkB,kBAAkB,GAAGA,CAACb,OAAe,EAAEX,MAAe,KAAa;MACrE,IAAIyB,KAAK,GAAG,CAAC;MACb,KAAK,MAAMC,GAAG,IAAI1B,MAAM,EAAE;QACtB,KAAK,MAAM2B,IAAI,IAAID,GAAG,EAAE;UACpB,IAAI,OAAOC,IAAI,KAAK,QAAQ,EAAE;YAC1B,IAAIA,IAAI,KAAKhB,OAAO,EAAE;cAClBc,KAAK,EAAE;YACX;UACJ,CAAC,MAAM,IAAIE,IAAI,IAAI,OAAOA,IAAI,KAAK,QAAQ,IAAIC,KAAK,CAACC,OAAO,CAACF,IAAI,CAACG,IAAI,CAAC,EAAE;YACrE,KAAK,MAAMC,GAAG,IAAIJ,IAAI,CAACG,IAAI,EAAE;cACzB,IAAIF,KAAK,CAACC,OAAO,CAACE,GAAG,CAAC/B,MAAM,CAAC,EAAE;gBAC3ByB,KAAK,IAAID,kBAAkB,CAACb,OAAO,EAAEoB,GAAG,CAAC/B,MAAM,CAAC;cACpD;YACJ;UACJ;QACJ;MACJ;MACA,OAAOyB,KAAK;IAChB,CAAC;IAED,KAAK,MAAMZ,KAAK,IAAIT,KAAK,CAACP,MAAM,EAAE;MAC9B,MAAM4B,KAAK,GAAGD,kBAAkB,CAACX,KAAK,CAACG,EAAE,EAAEZ,KAAK,CAACJ,MAAM,CAAC;MACxD,IAAIyB,KAAK,KAAK,CAAC,EAAE;QACb;MACJ,CAAC,MAAM,IAAIA,KAAK,GAAG,CAAC,EAAE;QAClB,MAAM,IAAIpD,WAAW,CACjB,UAAUwC,KAAK,CAACG,EAAE,oCAAoC,EACtD,2BAA2B,EAC3B;UACIZ,KAAK;UACLS;QACJ,CACJ,CAAC;MACL;MACA,MAAM,IAAIxC,WAAW,CACjB,kBAAkBwC,KAAK,CAACG,EAAE,cAAc,EACxC,yBAAyB,EACzB;QACIZ,KAAK;QACLS;MACJ,CACJ,CAAC;IACL;EACJ;AACJ;;AAEA;AACA;AACA;AACA;AACA,OAAO,MAAMmB,iBAAiB,GAAGA,CAC7B5B,KAAoB,EACpBhB,OAA+B,KACd;EACjB,OAAO,IAAIJ,cAAc,CAACoB,KAAK,EAAEhB,OAAO,CAAC;AAC7C,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,MAAM6C,wBAAwB,GACjC3C,KAAuD,IACtC;EACjB,OAAO0C,iBAAiB,CACpB;IACIE,aAAa,EAAE,KAAK;IACpB/B,UAAU,EAAE,IAAI;IAChBZ,SAAS,EAAE,IAAI;IACfI,KAAK,EAAE,SAAS;IAChB,GAAGL;EACP,CAAC,EACD;IACIgB,cAAc,EAAE;EACpB,CACJ,CAAC;AACL,CAAC","ignoreList":[]}

package/types/fields/objectField.d.ts

@@ -1,4 +1,5 @@
 import type { CmsModelField } from "../modelField.js";
+import type { CmsModelLayout } from "../../types/index.js";
 /**
  * A definition for object field to show possible type of the field in settings.
  */
@@ -8,6 +9,7 @@ export interface CmsModelObjectField extends CmsModelField {
      */
     settings: {
         fields: CmsModelField[];
+        layout?: CmsModelLayout;
         parents?: string[];
     };
 }

package/types/fields/objectField.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["objectField.ts"],"sourcesContent":["import type { CmsModelField } from \"../modelField.js\";\n\n/**\n * A definition for object field to show possible type of the field in settings.\n */\nexport interface CmsModelObjectField extends CmsModelField {\n    /**\n     * Settings object for the field. Contains `templates` property.\n     */\n    settings: {\n        fields: CmsModelField[];\n        parents?: string[];\n    };\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":[],"sources":["objectField.ts"],"sourcesContent":["import type { CmsModelField } from \"../modelField.js\";\nimport type { CmsModelLayout } from \"~/types/index.js\";\n\n/**\n * A definition for object field to show possible type of the field in settings.\n */\nexport interface CmsModelObjectField extends CmsModelField {\n    /**\n     * Settings object for the field. Contains `templates` property.\n     */\n    settings: {\n        fields: CmsModelField[];\n        layout?: CmsModelLayout;\n        parents?: string[];\n    };\n}\n"],"mappings":"","ignoreList":[]}

package/types/model.d.ts

@@ -1,6 +1,35 @@
 import type { CmsIdentity } from "./identity.js";
-import type { CmsModelField, CmsModelFieldInput } from "./modelField.js";
+import type { CmsModelField, CmsModelFieldInput, FieldRule } from "./modelField.js";
 import type { CmsIcon } from "../types/types.js";
+export interface CmsTabLayoutTab {
+    id: string;
+    label: string;
+    icon?: CmsIcon | null;
+    layout: CmsModelLayout;
+    rules?: FieldRule[];
+}
+export interface CmsTabLayoutDescriptor {
+    type: "tabs";
+    label: string;
+    description?: string | null;
+    help?: string | null;
+    tabs: CmsTabLayoutTab[];
+    rules?: FieldRule[];
+}
+export interface CmsSeparatorLayoutDescriptor {
+    type: "separator";
+    label: string;
+    description: string | null | undefined;
+    rules?: FieldRule[];
+}
+export interface CmsAlertLayoutDescriptor {
+    type: "alert";
+    label: string;
+    alertType: "info" | "success" | "warning" | "danger";
+    rules?: FieldRule[];
+}
+export type CmsModelLayoutCell = string | CmsTabLayoutDescriptor | CmsSeparatorLayoutDescriptor | CmsAlertLayoutDescriptor;
+export type CmsModelLayout = CmsModelLayoutCell[][];
 /**
  * Base CMS Model. Should not be exported and used outside of this package.
  *
@@ -76,7 +105,7 @@ export interface CmsModel {
      * ]
      * ```
      */
-    layout: string[][];
+    layout: CmsModelLayout;
     /**
      * Models can be tagged to give them contextual meaning.
      */
@@ -161,7 +190,7 @@ export interface CmsModelCreateInput {
      * ]
      * ```
      */
-    layout?: string[][];
+    layout?: CmsModelLayout;
     /**
      * Models can be tagged to give them contextual meaning.
      */

package/types/model.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["model.ts"],"sourcesContent":["import type { CmsIdentity } from \"./identity.js\";\nimport type { CmsModelField, CmsModelFieldInput } from \"./modelField.js\";\nimport type { CmsIcon } from \"~/types/types.js\";\n\n/**\n * Base CMS Model. Should not be exported and used outside of this package.\n *\n * @category Database model\n * @category CmsModel\n */\nexport interface CmsModel {\n    /**\n     * Name of the content model.\n     */\n    name: string;\n    /**\n     * Unique ID for the content model. Created from name if not defined by user.\n     */\n    modelId: string;\n    /**\n     * Name of the content model in singular form to be used in the API.\n     * example:\n     * - Article\n     * - Fruit\n     * - Vegetable\n     * - Car\n     */\n    singularApiName: string;\n    /**\n     * Name of the content model in plural form to be used in the API.\n     * example:\n     * - Articles\n     * - Fruits\n     * - Vegetables\n     * - Cars\n     */\n    pluralApiName: string;\n    /**\n     * Model tenant.\n     */\n    tenant: string;\n    /**\n     * Model group slug.\n     */\n    group: string;\n    /**\n     * Icon for the content model.\n     */\n    icon: CmsIcon | null;\n    /**\n     * Description for the content model.\n     */\n    description: string | null;\n    /**\n     * Date created\n     */\n    createdOn?: string;\n    /**\n     * Date saved. Changes on both save and create.\n     */\n    savedOn?: string;\n    /**\n     * CreatedBy object wrapper. Contains id, name and type of the user.\n     */\n    createdBy?: CmsIdentity;\n    /**\n     * List of fields defining entry values.\n     */\n    fields: CmsModelField[];\n    /**\n     * Admin UI field layout\n     *\n     * ```ts\n     * layout: [\n     *      [field1id, field2id],\n     *      [field3id]\n     * ]\n     * ```\n     */\n    layout: string[][];\n    /**\n     * Models can be tagged to give them contextual meaning.\n     */\n    tags?: string[];\n    /**\n     * The field that is used as an entry title.\n     * If not specified by the user, the system tries to assign the first available `text` field.\n     */\n    titleFieldId: string;\n    /**\n     * The field that is used as an entry description.\n     * If not set by the user, the system will try to assign the first available `long-text` field.\n     */\n    descriptionFieldId?: string | null;\n    /**\n     * The field that is used as an entry image.\n     * If not set by the user, the system will try to assign a `file` field which has `imagesOnly` enabled.\n     */\n    imageFieldId?: string | null;\n\n    /**\n     * Is model private?\n     * This is meant to be used for some internal models - will not be visible in the schema.\n     * Only available for the plugin constructed models.\n     */\n    isPrivate?: boolean;\n\n    /**\n     * Does this model require authorization to be performed?\n     * Only available for models created via plugins.\n     */\n    authorization?: boolean | CmsModelAuthorization;\n\n    /**\n     * Is this model created via plugin?\n     */\n    isPlugin?: boolean;\n}\n\nexport interface CmsModelAuthorization {\n    permissions: boolean;\n\n    [key: string]: any;\n}\n\n/**\n * A GraphQL `params.data` parameter received when creating content model.\n *\n * @category GraphQL params\n * @category CmsModel\n */\nexport interface CmsModelCreateInput {\n    /**\n     * Name of the content model.\n     */\n    name: string;\n    /**\n     * Singular name of the content model to be used in the API.\n     */\n    singularApiName: string;\n    /**\n     * Plural name of the content model to be used in the API.\n     */\n    pluralApiName: string;\n    /**\n     * Unique ID of the content model. Created from name if not sent by the user. Cannot be changed.\n     */\n    modelId?: string;\n    /**\n     * Description of the content model.\n     */\n    description?: string | null;\n    /**\n     * Group where to put the content model in.\n     */\n    group: string;\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     * Models can be tagged to give them contextual meaning.\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    icon?: CmsIcon | null;\n}\n\n/**\n * A GraphQL `params.data` parameter received when creating content model from existing model.\n *\n * @category GraphQL params\n * @category CmsModel\n */\nexport interface CmsModelCreateFromInput extends CmsModelCreateInput {}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":[],"sources":["model.ts"],"sourcesContent":["import type { CmsIdentity } from \"./identity.js\";\nimport type { CmsModelField, CmsModelFieldInput, FieldRule } from \"./modelField.js\";\nimport type { CmsIcon } from \"~/types/types.js\";\n\nexport interface CmsTabLayoutTab {\n    id: string;\n    label: string;\n    icon?: CmsIcon | null;\n    layout: CmsModelLayout;\n    rules?: FieldRule[];\n}\n\nexport interface CmsTabLayoutDescriptor {\n    type: \"tabs\";\n    label: string;\n    description?: string | null;\n    help?: string | null;\n    tabs: CmsTabLayoutTab[];\n    rules?: FieldRule[];\n}\n\nexport interface CmsSeparatorLayoutDescriptor {\n    type: \"separator\";\n    label: string;\n    description: string | null | undefined;\n    rules?: FieldRule[];\n}\n\nexport interface CmsAlertLayoutDescriptor {\n    type: \"alert\";\n    label: string;\n    alertType: \"info\" | \"success\" | \"warning\" | \"danger\";\n    rules?: FieldRule[];\n}\n\nexport type CmsModelLayoutCell =\n    | string\n    | CmsTabLayoutDescriptor\n    | CmsSeparatorLayoutDescriptor\n    | CmsAlertLayoutDescriptor;\nexport type CmsModelLayout = CmsModelLayoutCell[][];\n\n/**\n * Base CMS Model. Should not be exported and used outside of this package.\n *\n * @category Database model\n * @category CmsModel\n */\nexport interface CmsModel {\n    /**\n     * Name of the content model.\n     */\n    name: string;\n    /**\n     * Unique ID for the content model. Created from name if not defined by user.\n     */\n    modelId: string;\n    /**\n     * Name of the content model in singular form to be used in the API.\n     * example:\n     * - Article\n     * - Fruit\n     * - Vegetable\n     * - Car\n     */\n    singularApiName: string;\n    /**\n     * Name of the content model in plural form to be used in the API.\n     * example:\n     * - Articles\n     * - Fruits\n     * - Vegetables\n     * - Cars\n     */\n    pluralApiName: string;\n    /**\n     * Model tenant.\n     */\n    tenant: string;\n    /**\n     * Model group slug.\n     */\n    group: string;\n    /**\n     * Icon for the content model.\n     */\n    icon: CmsIcon | null;\n    /**\n     * Description for the content model.\n     */\n    description: string | null;\n    /**\n     * Date created\n     */\n    createdOn?: string;\n    /**\n     * Date saved. Changes on both save and create.\n     */\n    savedOn?: string;\n    /**\n     * CreatedBy object wrapper. Contains id, name and type of the user.\n     */\n    createdBy?: CmsIdentity;\n    /**\n     * List of fields defining entry values.\n     */\n    fields: CmsModelField[];\n    /**\n     * Admin UI field layout\n     *\n     * ```ts\n     * layout: [\n     *      [field1id, field2id],\n     *      [field3id]\n     * ]\n     * ```\n     */\n    layout: CmsModelLayout;\n    /**\n     * Models can be tagged to give them contextual meaning.\n     */\n    tags?: string[];\n    /**\n     * The field that is used as an entry title.\n     * If not specified by the user, the system tries to assign the first available `text` field.\n     */\n    titleFieldId: string;\n    /**\n     * The field that is used as an entry description.\n     * If not set by the user, the system will try to assign the first available `long-text` field.\n     */\n    descriptionFieldId?: string | null;\n    /**\n     * The field that is used as an entry image.\n     * If not set by the user, the system will try to assign a `file` field which has `imagesOnly` enabled.\n     */\n    imageFieldId?: string | null;\n\n    /**\n     * Is model private?\n     * This is meant to be used for some internal models - will not be visible in the schema.\n     * Only available for the plugin constructed models.\n     */\n    isPrivate?: boolean;\n\n    /**\n     * Does this model require authorization to be performed?\n     * Only available for models created via plugins.\n     */\n    authorization?: boolean | CmsModelAuthorization;\n\n    /**\n     * Is this model created via plugin?\n     */\n    isPlugin?: boolean;\n}\n\nexport interface CmsModelAuthorization {\n    permissions: boolean;\n\n    [key: string]: any;\n}\n\n/**\n * A GraphQL `params.data` parameter received when creating content model.\n *\n * @category GraphQL params\n * @category CmsModel\n */\nexport interface CmsModelCreateInput {\n    /**\n     * Name of the content model.\n     */\n    name: string;\n    /**\n     * Singular name of the content model to be used in the API.\n     */\n    singularApiName: string;\n    /**\n     * Plural name of the content model to be used in the API.\n     */\n    pluralApiName: string;\n    /**\n     * Unique ID of the content model. Created from name if not sent by the user. Cannot be changed.\n     */\n    modelId?: string;\n    /**\n     * Description of the content model.\n     */\n    description?: string | null;\n    /**\n     * Group where to put the content model in.\n     */\n    group: string;\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     * Models can be tagged to give them contextual meaning.\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    icon?: CmsIcon | null;\n}\n\n/**\n * A GraphQL `params.data` parameter received when creating content model from existing model.\n *\n * @category GraphQL params\n * @category CmsModel\n */\nexport interface CmsModelCreateFromInput extends CmsModelCreateInput {}\n"],"mappings":"","ignoreList":[]}

package/types/modelField.d.ts

@@ -1,6 +1,14 @@
-import type { CmsModel } from "./model.js";
+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;
 /**
@@ -99,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.
@@ -173,6 +185,10 @@ export interface CmsModelFieldInput {
     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.
@@ -215,7 +231,7 @@ export interface CmsModelUpdateInput {
      * ]
      * ```
      */
-    layout: string[][];
+    layout: CmsModelLayout;
     /**
      * Tags for the content model.
      */
@@ -266,7 +282,7 @@ export interface CmsModelFieldSettings {
     /**
      * Object field has child fields - so it needs to have a layout.
      */
-    layout?: string[][];
+    layout?: CmsModelLayout;
     /**
      * Ref field.
      */

package/types/modelField.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["modelField.ts"],"sourcesContent":["import type { CmsModel } from \"./model.js\";\nimport type { GenericRecord } from \"@webiny/api/types.js\";\nimport type { CmsDynamicZoneTemplate } from \"~/types/fields/dynamicZoneField.js\";\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\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\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 * 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     * 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":[]}
+{"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/types.d.ts

@@ -257,11 +257,10 @@ export interface CmsEntryValues {
 export interface ICmsEntryLocation {
     folderId?: string;
 }
-export interface IEntryState {
-    state: string;
-    workflowId: string;
-    stepId: string;
-    stepName: string;
+export interface ICmsEntryLive {
+    version: number;
+}
+export interface ICmsEntrySystem {
 }
 /**
  * A content entry definition for and from the database.
@@ -443,7 +442,11 @@ export interface CmsEntry<TValues extends CmsEntryValues = CmsEntryValues> {
      * The value is used when restoring the entry from the trash bin.
      */
     binOriginalFolderId?: string;
-    state?: IEntryState;
+    system?: ICmsEntrySystem;
+    /**
+     * Is this CMS Entry live (no matter the revision).
+     */
+    live: ICmsEntryLive | null;
 }
 export interface CmsStorageEntry<T extends CmsEntryValues = CmsEntryValues> extends CmsEntry<T> {
     [key: string]: any;
@@ -680,7 +683,7 @@ export interface CreateCmsEntryInput<TValues extends CmsEntryValues = CmsEntryVa
     location?: {
         folderId?: string | null;
     };
-    state?: Partial<IEntryState>;
+    system?: Partial<ICmsEntrySystem>;
     values: TValues | undefined;
 }
 export interface CreateCmsEntryOptionsInput {
@@ -717,7 +720,7 @@ export interface CreateFromCmsEntryInput<TValues extends CmsEntryValues = CmsEnt
     lastPublishedOn?: Date | string;
     firstPublishedBy?: CmsIdentity;
     lastPublishedBy?: CmsIdentity;
-    state?: Partial<IEntryState>;
+    system?: Partial<ICmsEntrySystem>;
     values: TValues;
 }
 export interface CreateRevisionCmsEntryOptionsInput {
@@ -768,7 +771,7 @@ export interface UpdateCmsEntryInput<TValues extends CmsEntryValues = CmsEntryVa
     location?: {
         folderId?: string | null;
     };
-    state?: Partial<IEntryState>;
+    system?: Partial<ICmsEntrySystem>;
     values?: Partial<TValues>;
 }
 export interface UpdateCmsEntryOptionsInput {

package/types/types.js.map

@@ -1 +1 @@
-{"version":3,"names":["CONTENT_ENTRY_STATUS"],"sources":["types.ts"],"sourcesContent":["import type { Context, GenericRecord } from \"@webiny/api/types.js\";\nimport type {\n    GraphQLFieldResolver,\n    GraphQLRequestBody,\n    Resolvers\n} from \"@webiny/handler-graphql/types.js\";\nimport type { processRequestBody } from \"@webiny/handler-graphql\";\nimport type { DbContext } from \"@webiny/handler-db/types.js\";\nimport type { CmsModelConverterCallable } from \"~/utils/converters/ConverterCollection.js\";\nimport type { HeadlessCmsExport, HeadlessCmsImport } from \"~/export/types.js\";\nimport type { AccessControl } from \"~/crud/AccessControl/AccessControl.js\";\nimport type { CmsModelToAstConverter } from \"~/utils/contentModelAst/CmsModelToAstConverter.js\";\nimport type { CmsModelFieldToGraphQLPlugin } from \"./plugins.js\";\nimport type { CmsEntryContext } from \"./context.js\";\nimport type { CmsModelField, CmsModelFieldValidation, CmsModelUpdateInput } from \"./modelField.js\";\nimport type { CmsModel, CmsModelCreateFromInput, CmsModelCreateInput } from \"./model.js\";\nimport type { CmsGroup } from \"./modelGroup.js\";\nimport type { CmsIdentity } from \"./identity.js\";\nimport type { ApiCoreContext } from \"@webiny/api-core/types/core.js\";\nimport type { SecurityPermission } from \"@webiny/api-core/types/security.js\";\nimport type {\n    DateStringInterfaceGenerator,\n    IdentityInterfaceGenerator,\n    IdInterfaceGenerator,\n    IdMixedInterfaceGenerator,\n    NumericInterfaceGenerator,\n    TruthfulInterfaceGenerator\n} from \"@webiny/api\";\n\nexport type CmsIcon = {\n    type: string;\n    name: string;\n    value?: string;\n};\n\nexport interface CmsError {\n    message: string;\n    code: string;\n    data: GenericRecord;\n    stack?: string;\n}\n\nexport type ApiEndpoint = \"manage\" | \"preview\" | \"read\";\n\nexport interface HeadlessCms extends CmsGroupContext, CmsModelContext, CmsEntryContext {\n    /**\n     * API type\n     */\n    type: ApiEndpoint | null;\n    /**\n     * Means this request is a READ API\n     */\n    READ: boolean;\n    /**\n     * Means this request is a MANAGE API\n     */\n    MANAGE: boolean;\n    /**\n     * Means this request is a PREVIEW API\n     */\n    PREVIEW: boolean;\n    /**\n     * The storage operations loaded for current context.\n     */\n    storageOperations: HeadlessCmsStorageOperations;\n\n    /**\n     * Use to ensure perform authorization and ensure identities have access to the groups, models and entries.\n     */\n    accessControl: AccessControl;\n\n    /**\n     * Export operations.\n     */\n    export: HeadlessCmsExport;\n    importing: HeadlessCmsImport;\n    getExecutableSchema: GetExecutableSchema;\n}\n\nexport type GetExecutableSchema = (\n    type: ApiEndpoint\n) => Promise<\n    <TData = Record<string, any>, TExtensions = Record<string, any>>(\n        input: GraphQLRequestBody | GraphQLRequestBody[]\n    ) => ReturnType<typeof processRequestBody<TData, TExtensions>>\n>;\n\n/**\n * @description This combines all contexts used in the CMS into a single one.\n *\n * @category Context\n */\nexport interface CmsContext extends Context, DbContext, ApiCoreContext {\n    cms: HeadlessCms;\n}\n\n/**\n * Used for our internal functionality.\n */\nexport interface CmsModelFieldWithParent extends CmsModelField {\n    parent?: CmsModelFieldWithParent | null;\n}\n\n/**\n * A definition for dateTime field to show possible type of the field in settings.\n */\nexport interface CmsModelDateTimeField extends CmsModelField {\n    /**\n     * Settings object for the field. Contains `type` property.\n     */\n    settings: {\n        type: \"time\" | \"date\" | \"dateTimeWithoutTimezone\" | \"dateTimeWithTimezone\";\n    };\n}\n\n/**\n * Arguments for the field validator validate method.\n *\n * @category ModelField\n * @category FieldValidation\n */\nexport interface CmsModelFieldValidatorValidateParams<T extends CmsEntryValues = CmsEntryValues> {\n    /**\n     * A value to be validated.\n     */\n    value: T[keyof T];\n    /**\n     * Options from the CmsModelField validations.\n     *\n     * @see CmsModelField.validation\n     * @see CmsModelField.listValidation\n     */\n    validator: CmsModelFieldValidation;\n    /**\n     * An instance of the current context.\n     */\n    context: CmsContext;\n    /**\n     * Field being validated.\n     */\n    field: CmsModelField;\n    /**\n     * An instance of the content model being validated.\n     */\n    model: CmsModel;\n    /**\n     * If entry is sent it means it is an update operation.\n     * First usage is for the unique field value.\n     */\n    entry?: CmsEntry<T>;\n}\n\n/**\n * When sending model to the storage operations, it must contain createValueKeyToStorageConverter and createValueKeyFromStorageConverter\n *\n * @category CmsModel\n */\nexport interface StorageOperationsCmsModel<T extends CmsEntryValues = CmsEntryValues>\n    extends CmsModel {\n    convertValueKeyToStorage: CmsModelConverterCallable<T>;\n    convertValueKeyFromStorage: CmsModelConverterCallable<T>;\n}\n\n/**\n * @category ModelField\n */\nexport interface CmsModelFieldDefinition {\n    fields: string;\n    typeDefs?: string;\n}\n\nexport interface CmsModelFieldToGraphQLNormalizeInputParams<TField> {\n    model: CmsModel;\n    field: TField;\n    input: GenericRecord<string> | Array<GenericRecord<string>>;\n}\n\ninterface CmsModelFieldToGraphQLCreateResolverParams<TField> {\n    models: CmsModel[];\n    model: CmsModel;\n    graphQLType: string;\n    field: TField;\n    createFieldResolvers: any;\n    fieldTypePlugins: CmsFieldTypePlugins;\n}\n\nexport interface CmsModelFieldToGraphQLCreateResolver<TField = CmsModelField> {\n    (params: CmsModelFieldToGraphQLCreateResolverParams<TField>):\n        | GraphQLFieldResolver\n        | {\n              resolver: GraphQLFieldResolver | null;\n              typeResolvers: Resolvers<CmsContext>;\n          }\n        | false;\n}\n\nexport interface CmsModelFieldToGraphQLPluginValidateChildFieldsValidateParams<\n    TField extends CmsModelField = CmsModelField\n> {\n    fields: TField[];\n    originalFields: TField[];\n}\n\nexport interface CmsModelFieldToGraphQLPluginValidateChildFieldsValidate {\n    (params: CmsModelFieldToGraphQLPluginValidateChildFieldsValidateParams): void;\n}\n\nexport interface CmsModelFieldToGraphQLPluginValidateChildFieldsParams<\n    TField extends CmsModelField = CmsModelField\n> {\n    field: TField;\n    originalField?: TField;\n    validate: CmsModelFieldToGraphQLPluginValidateChildFieldsValidate;\n}\n\nexport interface CmsModelFieldToGraphQLPluginValidateChildFields<\n    TField extends CmsModelField = CmsModelField\n> {\n    (params: CmsModelFieldToGraphQLPluginValidateChildFieldsParams<TField>): void;\n}\n\n/**\n * @category ModelField\n */\nexport interface CmsFieldTypePlugins {\n    [key: string]: CmsModelFieldToGraphQLPlugin;\n}\n\n/**\n * A GraphQL `params.data` parameter received when creating content model group.\n *\n * @category CmsGroup\n * @category GraphQL params\n */\nexport interface CmsGroupCreateInput {\n    id?: string;\n    name: string;\n    slug?: string;\n    description?: string | null;\n    icon?: CmsIcon | null;\n}\n\n/**\n * A GraphQL `params.data` parameter received when updating content model group.\n *\n * @category CmsGroup\n * @category GraphQL params\n */\nexport interface CmsGroupUpdateInput {\n    name?: string;\n    slug?: string;\n    description?: string;\n    icon?: CmsIcon;\n}\n\n/**\n * A `data.where` parameter received when listing content model groups.\n *\n * @category CmsGroup\n * @category GraphQL params\n */\nexport interface CmsGroupListParams {\n    where: {\n        tenant: string;\n    };\n}\n\n/**\n * Cms Group in context.\n *\n * @category Context\n * @category CmsGroup\n */\nexport interface CmsGroupContext {\n    /**\n     * Gets content model group by given id.\n     */\n    getGroup: (id: string) => Promise<CmsGroup>;\n    /**\n     * List all content model groups. Filterable via params.\n     */\n    listGroups: (params?: CmsGroupListParams) => Promise<CmsGroup[]>;\n    /**\n     * Create a new content model group.\n     */\n    createGroup: (data: CmsGroupCreateInput) => Promise<CmsGroup>;\n    /**\n     * Update existing content model group.\n     */\n    updateGroup: (id: string, data: CmsGroupUpdateInput) => Promise<CmsGroup>;\n    /**\n     * Delete content model group by given id.\n     */\n    deleteGroup: (id: string) => Promise<boolean>;\n    /**\n     * Clear the cached groups.\n     */\n    clearGroupsCache: () => void;\n}\n\n/**\n * A content entry values definition for and from the database.\n *\n * @category Database model\n * @category CmsEntry\n */\nexport interface CmsEntryValues {\n    [key: string]: any;\n}\n\nexport interface ICmsEntryLocation {\n    folderId?: string;\n}\n\nexport interface IEntryState {\n    state: string;\n    workflowId: string;\n    stepId: string;\n    stepName: string;\n}\n/**\n * A content entry definition for and from the database.\n *\n * @category Database model\n * @category CmsEntry\n */\nexport interface CmsEntry<TValues extends CmsEntryValues = CmsEntryValues> {\n    /**\n     * Tenant id which is this entry for. Can be used in case of shared storage.\n     */\n    tenant: string;\n    /**\n     * Generated ID of the entry. It is shared across all the records in the database that represent a single entry.\n     * So version 1, 2, ..., 2371 will have the same value in this field to link them together.\n     */\n    entryId: string;\n    /**\n     * Generated ID + version of the entry.\n     */\n    id: string;\n\n    /**\n     * Revision-level meta fields. 👇\n     */\n\n    /**\n     * An ISO 8601 date/time string.\n     */\n    revisionCreatedOn: string;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    revisionSavedOn: string;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    revisionModifiedOn: string | null;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    revisionDeletedOn: string | null;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    revisionRestoredOn: string | null;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    revisionFirstPublishedOn: string | null;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    revisionLastPublishedOn: string | null;\n\n    /**\n     * Identity that last ionCreated the entry.\n     */\n    revisionCreatedBy: CmsIdentity;\n    /**\n     * Identity that last ionSaved the entry.\n     */\n    revisionSavedBy: CmsIdentity;\n    /**\n     * Identity that last ionModified the entry.\n     */\n    revisionModifiedBy: CmsIdentity | null;\n    /**\n     * Identity that last deleted the revision.\n     */\n    revisionDeletedBy: CmsIdentity | null;\n    /**\n     * Identity that last restored the revision.\n     */\n    revisionRestoredBy: CmsIdentity | null;\n    /**\n     * Identity that first published the entry.\n     */\n    revisionFirstPublishedBy: CmsIdentity | null;\n    /**\n     * Identity that last published the entry.\n     */\n    revisionLastPublishedBy: CmsIdentity | null;\n\n    /**\n     * An ISO 8601 date/time string.\n     */\n    createdOn: string;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    savedOn: string;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    modifiedOn: string | null;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    deletedOn: string | null;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    restoredOn: string | null;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    firstPublishedOn: string | null;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    lastPublishedOn: string | null;\n\n    /**\n     * Identity that last created the entry.\n     */\n    createdBy: CmsIdentity;\n    /**\n     * Identity that last saved the entry.\n     */\n    savedBy: CmsIdentity;\n    /**\n     * Identity that last modified the entry.\n     */\n    modifiedBy: CmsIdentity | null;\n    /**\n     * Identity that last deleted the entry.\n     */\n    deletedBy: CmsIdentity | null;\n    /**\n     * Identity that last restored the entry.\n     */\n    restoredBy: CmsIdentity | null;\n    /**\n     * Identity that first published the entry.\n     */\n    firstPublishedBy: CmsIdentity | null;\n    /**\n     * Identity that last published the entry.\n     */\n    lastPublishedBy: CmsIdentity | null;\n\n    /**\n     * Model ID of the definition for the entry.\n     * @see CmsModel\n     */\n    modelId: string;\n    /**\n     * A revision version of the entry.\n     */\n    version: number;\n    /**\n     * Is the entry locked?\n     */\n    locked: boolean;\n    /**\n     * Status type of the entry.\n     */\n    status: CmsEntryStatus;\n    /**\n     * A mapped storageId -> value object.\n     *\n     * @see CmsModelField\n     */\n    values: TValues;\n    /**\n     * Advanced Content Organization\n     */\n    location?: ICmsEntryLocation;\n    /**\n     * Settings for the given entry.\n     *\n     * Introduced with Advanced Publishing Workflow. Will always be inserted once this PR is merged.\n     * Be aware that when accessing properties in it on old systems, it will break if not checked first.\n     *\n     * Available only on the Manage API in entry GraphQL type `meta.data` property.\n     */\n    meta?: GenericRecord;\n    /**\n     * Is the entry in the bin?\n     */\n    wbyDeleted?: boolean | null;\n    /**\n     * This field preserves the original folderId value, as the ROOT_FOLDER is set upon deletion.\n     * The value is used when restoring the entry from the trash bin.\n     */\n    binOriginalFolderId?: string;\n\n    state?: IEntryState;\n}\n\nexport interface CmsStorageEntry<T extends CmsEntryValues = CmsEntryValues> extends CmsEntry<T> {\n    [key: string]: any;\n}\n\nexport interface CmsEntryUniqueValue {\n    value: string;\n    count: number;\n}\n\nexport interface ICmsModelListParams {\n    /**\n     * Defaults to true.\n     */\n    includePrivate?: boolean;\n    includePlugins?: boolean;\n}\n\n/**\n * Cms Model in the context.\n *\n * @category Context\n * @category CmsModel\n */\nexport interface CmsModelContext {\n    /**\n     * Get a single content model.\n     *\n     * @throws NotFoundError\n     */\n    getModel(modelId: string): Promise<CmsModel>;\n    /**\n     * Get model to AST converter.\n     */\n    getModelToAstConverter: () => CmsModelToAstConverter;\n    /**\n     * Get all content models.\n     */\n    listModels(params?: ICmsModelListParams): Promise<CmsModel[]>;\n    /**\n     * Create a content model.\n     */\n    createModel(data: CmsModelCreateInput): Promise<CmsModel>;\n    /**\n     * Create a content model from the given model - clone.\n     */\n    createModelFrom(modelId: string, data: CmsModelCreateFromInput): Promise<CmsModel>;\n    /**\n     * Update content model.\n     */\n    updateModel(modelId: string, data: CmsModelUpdateInput): Promise<CmsModel>;\n    /**\n     * Delete content model. Should not allow deletion if there are entries connected to it.\n     */\n    deleteModel(modelId: string): Promise<void>;\n    /**\n     * Clear all the model caches.\n     */\n    clearModelsCache(): void;\n}\n\n/**\n * Available statuses for content entry.\n *\n * @category CmsEntry\n */\nexport type CmsEntryStatus = \"published\" | \"unpublished\" | \"draft\";\n\nexport interface CmsEntryListWhereRef\n    extends IdInterfaceGenerator<\"id\">,\n        IdInterfaceGenerator<\"entryId\">,\n        IdInterfaceGenerator<\"modelId\"> {}\n\nexport interface CmsEntryListWhereValues {\n    /**\n     * This is to allow querying by any content model field defined by the user.\n     */\n    [key: string]:\n        | string\n        | number\n        | boolean\n        | Date\n        | undefined\n        | string[]\n        | number[]\n        | null\n        | CmsEntryListWhereValues[]\n        | CmsEntryListWhereValues\n        | CmsEntryListWhereRef;\n}\n/**\n * Entry listing where params.\n *\n * @category CmsEntry\n * @category GraphQL params\n */\n\nexport interface CmsEntryListWhere\n    extends IdMixedInterfaceGenerator<\"id\">,\n        IdMixedInterfaceGenerator<\"entryId\">,\n        IdInterfaceGenerator<\"status\", CmsEntryStatus>,\n        /**\n         * Revision-level meta fields. 👇\n         */\n        IdentityInterfaceGenerator<\"revisionCreatedBy\">,\n        IdentityInterfaceGenerator<\"revisionModifiedBy\">,\n        IdentityInterfaceGenerator<\"revisionSavedBy\">,\n        IdentityInterfaceGenerator<\"revisionFirstPublishedBy\">,\n        IdentityInterfaceGenerator<\"revisionLastPublishedBy\">,\n        /**\n         * Entry-level meta fields. 👇\n         */\n        IdentityInterfaceGenerator<\"createdBy\">,\n        IdentityInterfaceGenerator<\"modifiedBy\">,\n        IdentityInterfaceGenerator<\"savedBy\">,\n        IdentityInterfaceGenerator<\"firstPublishedBy\">,\n        IdentityInterfaceGenerator<\"lastPublishedBy\">,\n        DateStringInterfaceGenerator<\"createdOn\">,\n        DateStringInterfaceGenerator<\"savedOn\">,\n        DateStringInterfaceGenerator<\"deletedOn\">,\n        /**\n         * Version of the entry.\n         *\n         * It is not meant to be used via the API.\n         * @internal\n         */\n        NumericInterfaceGenerator<\"version\">,\n        /**\n         * Each storage operations implementation MUST determine how to use this field.\n         * In SQL, it can be a `published` field, and in DynamoDB it can be an SK.\n         *\n         * It is not meant to be used via the API.\n         * @internal\n         */\n        TruthfulInterfaceGenerator<\"published\">,\n        /**\n         * Each storage operations implementation MUST determine how to use this field.\n         * In SQL, it can be a `latest` field, and in DynamoDB it can be an SK.\n         *\n         * It is not meant to be used via the API.\n         * @internal\n         */\n        TruthfulInterfaceGenerator<\"latest\"> {\n    /**\n     * ACO related parameters.\n     */\n    wbyAco_location?: {\n        folderId?: string;\n        folderId_not?: string;\n        folderId_in?: string[];\n        folderId_not_in?: string[];\n    };\n    location?: {\n        folderId?: string;\n        folderId_not?: string;\n        folderId_in?: string[];\n        folderId_not_in?: string[];\n    };\n\n    values?: CmsEntryListWhereValues;\n    /**\n     * Is the entry in the bin?\n     */\n    wbyDeleted?: boolean;\n    wbyDeleted_not?: boolean;\n\n    /**\n     * To allow querying via nested queries, we added the AND / OR properties.\n     */\n    AND?: CmsEntryListWhere[];\n    OR?: CmsEntryListWhere[];\n}\n\n/**\n * Entry listing sort.\n *\n * @category CmsEntry\n * @category GraphQL params\n */\nexport type CmsEntryListSortAsc = `${string}_ASC`;\nexport type CmsEntryListSortDesc = `${string}_DESC`;\nexport type CmsEntryListSort = (CmsEntryListSortAsc | CmsEntryListSortDesc)[];\n\n/**\n * Get entry GraphQL resolver params.\n *\n * @category CmsEntry\n * @category GraphQL params\n */\nexport interface CmsEntryGetParams {\n    where: CmsEntryListWhere;\n    sort?: CmsEntryListSort;\n}\n\n/**\n * List entries GraphQL resolver params.\n *\n * @category CmsEntry\n * @category GraphQL params\n */\nexport interface CmsEntryListParams {\n    where?: CmsEntryListWhere;\n    sort?: CmsEntryListSort;\n    search?: string;\n    fields?: string[];\n    limit?: number;\n    after?: string | null;\n}\n\n/**\n * Meta information for GraphQL output.\n *\n * @category CmsEntry\n * @category GraphQL output\n */\nexport interface CmsEntryMeta {\n    /**\n     * A cursor for pagination.\n     */\n    cursor: string | null;\n    /**\n     * Is there more items to load?\n     */\n    hasMoreItems: boolean;\n    /**\n     * Total count of the items in the storage.\n     */\n    totalCount: number;\n}\n\n/**\n * @category Context\n * @category CmsEntry\n */\nexport interface CreateCmsEntryInput<TValues extends CmsEntryValues = CmsEntryValues> {\n    id?: string;\n    status?: CmsEntryStatus;\n\n    /**\n     * Entry-level meta fields. 👇\n     */\n    createdOn?: Date | string;\n    modifiedOn?: Date | string | null;\n    savedOn?: Date | string;\n    deletedOn?: Date | string | null;\n    restoredOn?: Date | string | null;\n    createdBy?: CmsIdentity;\n    modifiedBy?: CmsIdentity;\n    savedBy?: CmsIdentity;\n    deletedBy?: CmsIdentity | null;\n    restoredBy?: CmsIdentity | null;\n    firstPublishedOn?: Date | string;\n    lastPublishedOn?: Date | string;\n    firstPublishedBy?: CmsIdentity;\n    lastPublishedBy?: CmsIdentity;\n\n    /**\n     * Revision-level meta fields. 👇\n     */\n    revisionCreatedOn?: Date | string;\n    revisionModifiedOn?: Date | string | null;\n    revisionSavedOn?: Date | string;\n    revisionDeletedOn?: Date | string | null;\n    revisionRestoredOn?: Date | string | null;\n    revisionCreatedBy?: CmsIdentity;\n    revisionModifiedBy?: CmsIdentity | null;\n    revisionSavedBy?: CmsIdentity;\n    revisionDeletedBy?: CmsIdentity | null;\n    revisionRestoredBy?: CmsIdentity | null;\n    revisionFirstPublishedOn?: Date | string;\n    revisionLastPublishedOn?: Date | string;\n    revisionFirstPublishedBy?: CmsIdentity;\n    revisionLastPublishedBy?: CmsIdentity;\n    // TODO remove wbyAco_location\n    wbyAco_location?: {\n        folderId?: string | null;\n    };\n    location?: {\n        folderId?: string | null;\n    };\n\n    state?: Partial<IEntryState>;\n\n    values: TValues | undefined;\n}\n\nexport interface CreateCmsEntryOptionsInput {\n    skipValidators?: string[];\n}\n\n/**\n * @category Context\n * @category CmsEntry\n */\nexport interface CreateFromCmsEntryInput<TValues extends CmsEntryValues = CmsEntryValues> {\n    /**\n     * Revision-level meta fields. 👇\n     */\n    revisionCreatedOn?: Date;\n    revisionSavedOn?: Date;\n    revisionModifiedOn?: Date;\n    revisionCreatedBy?: CmsIdentity;\n    revisionModifiedBy?: CmsIdentity;\n    revisionSavedBy?: CmsIdentity;\n    revisionFirstPublishedOn?: Date | string;\n    revisionLastPublishedOn?: Date | string;\n    revisionFirstPublishedBy?: CmsIdentity;\n    revisionLastPublishedBy?: CmsIdentity;\n\n    /**\n     * Entry-level meta fields. 👇\n     */\n    createdOn?: Date;\n    savedOn?: Date;\n    modifiedOn?: Date;\n    createdBy?: CmsIdentity;\n    modifiedBy?: CmsIdentity;\n    savedBy?: CmsIdentity;\n    firstPublishedOn?: Date | string;\n    lastPublishedOn?: Date | string;\n    firstPublishedBy?: CmsIdentity;\n    lastPublishedBy?: CmsIdentity;\n\n    state?: Partial<IEntryState>;\n\n    values: TValues;\n}\n\nexport interface CreateRevisionCmsEntryOptionsInput {\n    skipValidators?: string[];\n}\n\n/**\n * @category Context\n * @category CmsEntry\n */\nexport interface UpdateCmsEntryInput<TValues extends CmsEntryValues = CmsEntryValues> {\n    /**\n     * Revision-level meta fields. 👇\n     */\n    revisionCreatedOn?: Date | string | null;\n    revisionModifiedOn?: Date | string | null;\n    revisionSavedOn?: Date | string | null;\n    revisionDeletedOn?: Date | string | null;\n    revisionRestoredOn?: Date | string | null;\n    revisionFirstPublishedOn?: Date | string | null;\n    revisionLastPublishedOn?: Date | string | null;\n    revisionModifiedBy?: CmsIdentity | null;\n    revisionCreatedBy?: CmsIdentity | null;\n    revisionSavedBy?: CmsIdentity | null;\n    revisionDeletedBy?: CmsIdentity | null;\n    revisionRestoredBy?: CmsIdentity | null;\n    revisionFirstPublishedBy?: CmsIdentity | null;\n    revisionLastPublishedBy?: CmsIdentity | null;\n\n    /**\n     * Entry-level meta fields. 👇\n     */\n    createdOn?: Date | string | null;\n    modifiedOn?: Date | string | null;\n    savedOn?: Date | string | null;\n    deletedOn?: Date | string | null;\n    restoredOn?: Date | string | null;\n    firstPublishedOn?: Date | string | null;\n    lastPublishedOn?: Date | string | null;\n    createdBy?: CmsIdentity | null;\n    modifiedBy?: CmsIdentity | null;\n    savedBy?: CmsIdentity | null;\n    deletedBy?: CmsIdentity | null;\n    restoredBy?: CmsIdentity | null;\n    firstPublishedBy?: CmsIdentity | null;\n    lastPublishedBy?: CmsIdentity | null;\n\n    wbyAco_location?: {\n        folderId?: string | null;\n    };\n\n    location?: {\n        folderId?: string | null;\n    };\n\n    state?: Partial<IEntryState>;\n\n    values?: Partial<TValues>;\n}\n\nexport interface UpdateCmsEntryOptionsInput {\n    skipValidators?: string[];\n}\n\n/**\n * @category Context\n * @category CmsEntry\n */\nexport interface GetUniqueFieldValuesParams {\n    where: CmsEntryListWhere;\n    fieldId: string;\n}\n\n/**\n * @category CmsEntry\n */\nexport interface CmsDeleteEntryOptions {\n    /**\n     * Runs the delete commands even if the entry is not found in the DynamoDB.\n     * This is to force clean the entry records that might have been left behind a failed delete.\n     */\n    force?: boolean;\n    /**\n     * Destroying the entry directly, without moving it to the bin.\n     */\n    permanently?: boolean;\n}\n\n/**\n * @category Context\n * @category CmsEntry\n */\nexport interface DeleteMultipleEntriesParams {\n    entries: string[];\n}\n\nexport type DeleteMultipleEntriesResponse = {\n    id: string;\n}[];\n\nexport interface CmsEntryValidateResponse {\n    [key: string]: any;\n}\n\n/**\n * Parameters for CmsEntryResolverFactory.\n *\n * @category GraphQL resolver\n * @category CmsEntry\n */\ninterface CmsEntryResolverFactoryParams {\n    model: CmsModel;\n    fieldTypePlugins: CmsFieldTypePlugins;\n}\n\n/**\n * A type for EntryResolvers. Used when creating get, list, update, publish, ...etc.\n *\n * @category GraphQL resolver\n * @category CmsEntry\n */\nexport type CmsEntryResolverFactory<TSource = any, TArgs = any, TContext = CmsContext> = {\n    (params: CmsEntryResolverFactoryParams): GraphQLFieldResolver<TSource, TArgs, TContext>;\n};\n\n/**\n * A base security permission for CMS.\n *\n * @category SecurityPermission\n */\nexport interface BaseCmsSecurityPermission extends SecurityPermission {\n    own?: boolean;\n    rwd: string;\n}\n\n/**\n * A security permission for content model.\n *\n * @category SecurityPermission\n * @category CmsModel\n */\nexport interface CmsModelPermission extends BaseCmsSecurityPermission {\n    models?: string[];\n    groups?: string[];\n}\n\n/**\n * The security permission for content model groups.\n *\n * @category SecurityPermission\n * @category CmsGroup\n */\nexport interface CmsGroupPermission extends BaseCmsSecurityPermission {\n    groups?: string[];\n}\n\n/**\n * The security permission for content entry.\n *\n * @category SecurityPermission\n * @category CmsEntry\n */\nexport interface CmsEntryPermission extends BaseCmsSecurityPermission {\n    pw?: string;\n    models?: string[];\n    groups?: string[];\n}\n\nexport interface CmsGroupStorageOperationsGetParams {\n    id: string;\n    tenant: string;\n}\n\nexport interface CmsGroupStorageOperationsListWhereParams {\n    tenant: string;\n\n    [key: string]: any;\n}\n\nexport interface CmsGroupStorageOperationsListParams {\n    where: CmsGroupStorageOperationsListWhereParams;\n    sort?: string[];\n}\n\nexport interface CmsGroupStorageOperationsCreateParams {\n    group: CmsGroup;\n}\n\nexport interface CmsGroupStorageOperationsUpdateParams {\n    group: CmsGroup;\n}\n\nexport interface CmsGroupStorageOperationsDeleteParams {\n    group: CmsGroup;\n}\n\n/**\n * Description of the CmsGroup CRUD operations.\n * If user wants to add another database to the application, this is how it is done.\n * This is just plain read, update, write, delete and list - no authentication or permission checks.\n */\nexport interface CmsGroupStorageOperations {\n    /**\n     * Gets content model group by given id.\n     */\n    get: (params: CmsGroupStorageOperationsGetParams) => Promise<CmsGroup | null>;\n    /**\n     * List all content model groups. Filterable via params.\n     */\n    list: (params: CmsGroupStorageOperationsListParams) => Promise<CmsGroup[]>;\n    /**\n     * Create a new content model group.\n     */\n    create: (params: CmsGroupStorageOperationsCreateParams) => Promise<void>;\n    /**\n     * Update existing content model group.\n     */\n    update: (params: CmsGroupStorageOperationsUpdateParams) => Promise<void>;\n    /**\n     * Delete the content model group.\n     */\n    delete: (params: CmsGroupStorageOperationsDeleteParams) => Promise<void>;\n}\n\nexport interface CmsModelStorageOperationsGetParams {\n    tenant: string;\n    modelId: string;\n}\n\nexport interface CmsModelStorageOperationsListWhereParams {\n    tenant: string;\n\n    [key: string]: string;\n}\n\nexport interface CmsModelStorageOperationsListParams {\n    where: CmsModelStorageOperationsListWhereParams;\n}\n\nexport interface CmsModelStorageOperationsCreateParams {\n    model: CmsModel;\n}\n\nexport interface CmsModelStorageOperationsUpdateParams {\n    model: CmsModel;\n}\n\nexport interface CmsModelStorageOperationsDeleteParams {\n    model: CmsModel;\n}\n\n/**\n * Description of the CmsModel storage operations.\n * If user wants to add another database to the application, this is how it is done.\n * This is just plain read, update, write, delete and list - no authentication or permission checks.\n */\nexport interface CmsModelStorageOperations {\n    /**\n     * Gets content model by given id.\n     */\n    get: (params: CmsModelStorageOperationsGetParams) => Promise<CmsModel | null>;\n    /**\n     * List all content models. Filterable via params.\n     */\n    list: (params: CmsModelStorageOperationsListParams) => Promise<CmsModel[]>;\n    /**\n     * Create a new content model.\n     */\n    create: (params: CmsModelStorageOperationsCreateParams) => Promise<CmsModel>;\n    /**\n     * Update existing content model.\n     */\n    update: (params: CmsModelStorageOperationsUpdateParams) => Promise<CmsModel>;\n    /**\n     * Delete the content model.\n     */\n    delete: (params: CmsModelStorageOperationsDeleteParams) => Promise<CmsModel>;\n}\n\nexport interface CmsEntryStorageOperationsGetParams {\n    where: CmsEntryListWhere;\n    sort?: CmsEntryListSort;\n    limit?: number;\n}\n\nexport interface CmsEntryStorageOperationsListParams {\n    where: CmsEntryListWhere;\n    sort?: CmsEntryListSort;\n    search?: string;\n    fields?: string[];\n    limit: number;\n    after?: string | null;\n}\n\nexport interface CmsEntryStorageOperationsCreateParams<T extends CmsEntryValues = CmsEntryValues> {\n    /**\n     * Real entry, with no transformations on it.\n     */\n    entry: CmsEntry<T>;\n    /**\n     * Entry prepared for the storage.\n     */\n    storageEntry: CmsStorageEntry<T>;\n}\n\nexport interface CmsEntryStorageOperationsCreateRevisionFromParams<\n    T extends CmsEntryValues = CmsEntryValues\n> {\n    /**\n     * Real entry, with no transformations on it.\n     */\n    entry: CmsEntry<T>;\n    /**\n     * Entry prepared for the storage.\n     */\n    storageEntry: CmsStorageEntry<T>;\n}\n\nexport interface CmsEntryStorageOperationsUpdateParams<T extends CmsEntryValues = CmsEntryValues> {\n    /**\n     * Real entry, with no transformations on it.\n     */\n    entry: CmsEntry<T>;\n    /**\n     * Entry prepared for the storage.\n     */\n    storageEntry: CmsStorageEntry<T>;\n}\n\nexport interface CmsEntryStorageOperationsDeleteRevisionParams<\n    T extends CmsEntryValues = CmsEntryValues\n> {\n    /**\n     * Entry that was deleted.\n     */\n    entry: CmsEntry<T>;\n    /**\n     * Entry that was deleted, directly from storage, with transformations.\n     */\n    storageEntry: CmsStorageEntry<T>;\n    /**\n     * Entry that was set as latest.\n     */\n    latestEntry: CmsEntry | null;\n    /**\n     * Entry that was set as latest, directly from storage, with transformations.\n     */\n    latestStorageEntry: CmsStorageEntry<T> | null;\n}\n\nexport interface CmsEntryStorageOperationsDeleteParams<T extends CmsEntryValues = CmsEntryValues> {\n    entry: CmsEntry<T>;\n}\n\nexport interface CmsEntryStorageOperationsMoveToBinParams<\n    T extends CmsEntryValues = CmsEntryValues\n> {\n    /**\n     * The modified entry that is going to be saved as published.\n     * Entry is in its original form.\n     */\n    entry: CmsEntry<T>;\n    /**\n     * The modified entry and prepared for the storage.\n     */\n    storageEntry: CmsStorageEntry<T>;\n}\n\nexport interface CmsEntryStorageOperationsRestoreFromBinParams<\n    T extends CmsEntryValues = CmsEntryValues\n> {\n    /**\n     * The modified entry that is going to be saved as restored.\n     * Entry is in its original form.\n     */\n    entry: CmsEntry<T>;\n    /**\n     * The modified entry and prepared for the storage.\n     */\n    storageEntry: CmsStorageEntry<T>;\n}\n\nexport interface CmsEntryStorageOperationsDeleteEntriesParams {\n    entries: string[];\n}\n\nexport interface CmsEntryStorageOperationsPublishParams<T extends CmsEntryValues = CmsEntryValues> {\n    /**\n     * The modified entry that is going to be saved as published.\n     * Entry is in its original form.\n     */\n    entry: CmsEntry<T>;\n    /**\n     * The modified entry and prepared for the storage.\n     */\n    storageEntry: CmsStorageEntry<T>;\n}\n\nexport interface CmsEntryStorageOperationsUnpublishParams<\n    T extends CmsEntryValues = CmsEntryValues\n> {\n    /**\n     * The modified entry that is going to be saved as unpublished.\n     */\n    entry: CmsEntry<T>;\n    /**\n     * The modified entry that is going to be saved as unpublished, with transformations on it.\n     */\n    storageEntry: CmsStorageEntry<T>;\n}\n\nexport interface CmsEntryStorageOperationsGetUniqueFieldValuesParams {\n    where: CmsEntryListWhere;\n    fieldId: string;\n}\n\nexport interface CmsEntryStorageOperationsGetByIdsParams {\n    ids: readonly string[];\n}\n\nexport interface CmsEntryStorageOperationsGetLatestByIdsParams {\n    ids: readonly string[];\n}\n\nexport interface CmsEntryStorageOperationsGetPublishedByIdsParams {\n    ids: readonly string[];\n}\n\nexport interface CmsEntryStorageOperationsGetRevisionsParams {\n    id: string;\n}\n\nexport interface CmsEntryStorageOperationsGetRevisionParams {\n    id: string;\n}\n\nexport interface CmsEntryStorageOperationsGetPublishedRevisionParams {\n    id: string;\n}\n\nexport interface CmsEntryStorageOperationsGetLatestRevisionParams {\n    id: string;\n}\n\nexport interface CmsEntryStorageOperationsGetPreviousRevisionParams {\n    entryId: string;\n    version: number;\n}\n\nexport interface CmsEntryStorageOperationsListResponse<\n    T extends CmsStorageEntry = CmsStorageEntry\n> {\n    /**\n     * Has more items to load with the current filtering?\n     */\n    hasMoreItems: boolean;\n    /**\n     * Items loaded with current filtering.\n     */\n    items: T[];\n    /**\n     * Pointer for where to start the new item set.\n     */\n    cursor: string | null;\n    /**\n     * Total amount of items with the current filter.\n     */\n    totalCount: number;\n}\n\n/**\n * Description of the CmsModel storage operations.\n * If user wants to add another database to the application, this is how it is done.\n * This is just plain read, update, write, delete and list - no authentication or permission checks.\n *\n *\n * @category StorageOperations\n * @category CmsEntry\n */\nexport interface CmsEntryStorageOperations {\n    /**\n     * Get all the entries of the ids.\n     */\n    getByIds: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetByIdsParams\n    ) => Promise<CmsEntry<T>[]>;\n    /**\n     * Get all the published entries of the ids.\n     */\n    getPublishedByIds: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetPublishedByIdsParams\n    ) => Promise<CmsEntry<T>[]>;\n    /**\n     * Get all the latest entries of the ids.\n     */\n    getLatestByIds: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetLatestByIdsParams\n    ) => Promise<CmsEntry<T>[]>;\n    /**\n     * Get all revisions of the given entry id.\n     */\n    getRevisions: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetRevisionsParams\n    ) => Promise<CmsEntry<T>[]>;\n    /**\n     * Get the entry by the given revision id.\n     */\n    getRevisionById: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetRevisionParams\n    ) => Promise<CmsEntry<T> | null>;\n    /**\n     * Get the published entry by given entryId.\n     */\n    getPublishedRevisionByEntryId: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetPublishedRevisionParams\n    ) => Promise<CmsEntry<T> | null>;\n    /**\n     * Get the latest entry by given entryId.\n     */\n    getLatestRevisionByEntryId: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetLatestRevisionParams\n    ) => Promise<CmsEntry<T> | null>;\n    /**\n     * Get the revision of the entry before given one.\n     */\n    getPreviousRevision: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetPreviousRevisionParams\n    ) => Promise<CmsEntry<T> | null>;\n    /**\n     * Gets entry by given params.\n     */\n    get: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetParams\n    ) => Promise<CmsEntry<T> | null>;\n    /**\n     * List all entries. Filterable via params.\n     */\n    list: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsListParams\n    ) => Promise<CmsEntryStorageOperationsListResponse<CmsEntry<T>>>;\n    /**\n     * Create a new entry.\n     */\n    create: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsCreateParams<T>\n    ) => Promise<CmsEntry<T>>;\n    /**\n     * Create a new entry from existing one.\n     */\n    createRevisionFrom: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsCreateRevisionFromParams<T>\n    ) => Promise<CmsEntry<T>>;\n    /**\n     * Update existing entry.\n     */\n    update: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsUpdateParams<T>\n    ) => Promise<CmsEntry<T>>;\n    /**\n     * Move entry and all its entries into a new folder.\n     */\n    move: (model: CmsModel, id: string, folderId: string) => Promise<void>;\n    /**\n     * Delete the entry revision.\n     */\n    deleteRevision: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsDeleteRevisionParams<T>\n    ) => Promise<void>;\n    /**\n     * Delete the entry.\n     */\n    delete: (model: CmsModel, params: CmsEntryStorageOperationsDeleteParams) => Promise<void>;\n    /**\n     * Move the entry to bin.\n     */\n    moveToBin: (model: CmsModel, params: CmsEntryStorageOperationsMoveToBinParams) => Promise<void>;\n    /**\n     * Restore the entry from the bin.\n     */\n    restoreFromBin: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsRestoreFromBinParams<T>\n    ) => Promise<CmsEntry<T>>;\n    /**\n     * Delete multiple entries, with a limit on how much can be deleted in one call.\n     */\n    deleteMultipleEntries: (\n        model: CmsModel,\n        params: CmsEntryStorageOperationsDeleteEntriesParams\n    ) => Promise<void>;\n    /**\n     * Publish the entry.\n     */\n    publish: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsPublishParams<T>\n    ) => Promise<CmsEntry<T>>;\n    /**\n     * Unpublish the entry.\n     */\n    unpublish: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsUnpublishParams<T>\n    ) => Promise<CmsEntry<T>>;\n    /**\n     * Method to list all the unique values for the given field id.\n     * Simplest use case would be to aggregate tags for some content.\n     * @internal\n     */\n    getUniqueFieldValues: (\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetUniqueFieldValuesParams\n    ) => Promise<CmsEntryUniqueValue[]>;\n}\n\nexport enum CONTENT_ENTRY_STATUS {\n    DRAFT = \"draft\",\n    PUBLISHED = \"published\",\n    UNPUBLISHED = \"unpublished\"\n}\n\nexport interface HeadlessCmsStorageOperations<C = CmsContext> {\n    name: string;\n    groups: CmsGroupStorageOperations;\n    models: CmsModelStorageOperations;\n    entries: CmsEntryStorageOperations;\n    /**\n     * Either attach something from the storage operations or run something in it.\n     */\n    beforeInit: (context: C) => Promise<void>;\n    init?: (context: C) => Promise<void>;\n}\n"],"mappings":"AAuFA;AACA;AACA;AACA;AACA;;AAKA;AACA;AACA;;AAKA;AACA;AACA;;AAUA;AACA;AACA;AACA;AACA;AACA;;AAgCA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;;AAwDA;AACA;AACA;;AAKA;AACA;AACA;AACA;AACA;AACA;;AASA;AACA;AACA;AACA;AACA;AACA;;AAQA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;;AA4BA;AACA;AACA;AACA;AACA;AACA;;AAeA;AACA;AACA;AACA;AACA;AACA;;AA0MA;AACA;AACA;AACA;AACA;AACA;;AAsCA;AACA;AACA;AACA;AACA;;AAyBA;AACA;AACA;AACA;AACA;AACA;;AA8EA;AACA;AACA;AACA;AACA;AACA;;AAKA;AACA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;;AAUA;AACA;AACA;AACA;AACA;AACA;;AAgBA;AACA;AACA;AACA;;AAyDA;AACA;AACA;AACA;;AAuCA;AACA;AACA;AACA;;AAuDA;AACA;AACA;AACA;;AAMA;AACA;AACA;;AAaA;AACA;AACA;AACA;;AAaA;AACA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;;AAKA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;;AAKA;AACA;AACA;AACA;AACA;AACA;;AAmCA;AACA;AACA;AACA;AACA;;AAmDA;AACA;AACA;AACA;AACA;;AAuNA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAuJA,WAAYA,oBAAoB,0BAApBA,oBAAoB;EAApBA,oBAAoB;EAApBA,oBAAoB;EAApBA,oBAAoB;EAAA,OAApBA,oBAAoB;AAAA","ignoreList":[]}
+{"version":3,"names":["CONTENT_ENTRY_STATUS"],"sources":["types.ts"],"sourcesContent":["import type { Context, GenericRecord } from \"@webiny/api/types.js\";\nimport type {\n    GraphQLFieldResolver,\n    GraphQLRequestBody,\n    Resolvers\n} from \"@webiny/handler-graphql/types.js\";\nimport type { processRequestBody } from \"@webiny/handler-graphql\";\nimport type { DbContext } from \"@webiny/handler-db/types.js\";\nimport type { CmsModelConverterCallable } from \"~/utils/converters/ConverterCollection.js\";\nimport type { HeadlessCmsExport, HeadlessCmsImport } from \"~/export/types.js\";\nimport type { AccessControl } from \"~/crud/AccessControl/AccessControl.js\";\nimport type { CmsModelToAstConverter } from \"~/utils/contentModelAst/CmsModelToAstConverter.js\";\nimport type { CmsModelFieldToGraphQLPlugin } from \"./plugins.js\";\nimport type { CmsEntryContext } from \"./context.js\";\nimport type { CmsModelField, CmsModelFieldValidation, CmsModelUpdateInput } from \"./modelField.js\";\nimport type { CmsModel, CmsModelCreateFromInput, CmsModelCreateInput } from \"./model.js\";\nimport type { CmsGroup } from \"./modelGroup.js\";\nimport type { CmsIdentity } from \"./identity.js\";\nimport type { ApiCoreContext } from \"@webiny/api-core/types/core.js\";\nimport type { SecurityPermission } from \"@webiny/api-core/types/security.js\";\nimport type {\n    DateStringInterfaceGenerator,\n    IdentityInterfaceGenerator,\n    IdInterfaceGenerator,\n    IdMixedInterfaceGenerator,\n    NumericInterfaceGenerator,\n    TruthfulInterfaceGenerator\n} from \"@webiny/api\";\n\nexport type CmsIcon = {\n    type: string;\n    name: string;\n    value?: string;\n};\n\nexport interface CmsError {\n    message: string;\n    code: string;\n    data: GenericRecord;\n    stack?: string;\n}\n\nexport type ApiEndpoint = \"manage\" | \"preview\" | \"read\";\n\nexport interface HeadlessCms extends CmsGroupContext, CmsModelContext, CmsEntryContext {\n    /**\n     * API type\n     */\n    type: ApiEndpoint | null;\n    /**\n     * Means this request is a READ API\n     */\n    READ: boolean;\n    /**\n     * Means this request is a MANAGE API\n     */\n    MANAGE: boolean;\n    /**\n     * Means this request is a PREVIEW API\n     */\n    PREVIEW: boolean;\n    /**\n     * The storage operations loaded for current context.\n     */\n    storageOperations: HeadlessCmsStorageOperations;\n\n    /**\n     * Use to ensure perform authorization and ensure identities have access to the groups, models and entries.\n     */\n    accessControl: AccessControl;\n\n    /**\n     * Export operations.\n     */\n    export: HeadlessCmsExport;\n    importing: HeadlessCmsImport;\n    getExecutableSchema: GetExecutableSchema;\n}\n\nexport type GetExecutableSchema = (\n    type: ApiEndpoint\n) => Promise<\n    <TData = Record<string, any>, TExtensions = Record<string, any>>(\n        input: GraphQLRequestBody | GraphQLRequestBody[]\n    ) => ReturnType<typeof processRequestBody<TData, TExtensions>>\n>;\n\n/**\n * @description This combines all contexts used in the CMS into a single one.\n *\n * @category Context\n */\nexport interface CmsContext extends Context, DbContext, ApiCoreContext {\n    cms: HeadlessCms;\n}\n\n/**\n * Used for our internal functionality.\n */\nexport interface CmsModelFieldWithParent extends CmsModelField {\n    parent?: CmsModelFieldWithParent | null;\n}\n\n/**\n * A definition for dateTime field to show possible type of the field in settings.\n */\nexport interface CmsModelDateTimeField extends CmsModelField {\n    /**\n     * Settings object for the field. Contains `type` property.\n     */\n    settings: {\n        type: \"time\" | \"date\" | \"dateTimeWithoutTimezone\" | \"dateTimeWithTimezone\";\n    };\n}\n\n/**\n * Arguments for the field validator validate method.\n *\n * @category ModelField\n * @category FieldValidation\n */\nexport interface CmsModelFieldValidatorValidateParams<T extends CmsEntryValues = CmsEntryValues> {\n    /**\n     * A value to be validated.\n     */\n    value: T[keyof T];\n    /**\n     * Options from the CmsModelField validations.\n     *\n     * @see CmsModelField.validation\n     * @see CmsModelField.listValidation\n     */\n    validator: CmsModelFieldValidation;\n    /**\n     * An instance of the current context.\n     */\n    context: CmsContext;\n    /**\n     * Field being validated.\n     */\n    field: CmsModelField;\n    /**\n     * An instance of the content model being validated.\n     */\n    model: CmsModel;\n    /**\n     * If entry is sent it means it is an update operation.\n     * First usage is for the unique field value.\n     */\n    entry?: CmsEntry<T>;\n}\n\n/**\n * When sending model to the storage operations, it must contain createValueKeyToStorageConverter and createValueKeyFromStorageConverter\n *\n * @category CmsModel\n */\nexport interface StorageOperationsCmsModel<T extends CmsEntryValues = CmsEntryValues>\n    extends CmsModel {\n    convertValueKeyToStorage: CmsModelConverterCallable<T>;\n    convertValueKeyFromStorage: CmsModelConverterCallable<T>;\n}\n\n/**\n * @category ModelField\n */\nexport interface CmsModelFieldDefinition {\n    fields: string;\n    typeDefs?: string;\n}\n\nexport interface CmsModelFieldToGraphQLNormalizeInputParams<TField> {\n    model: CmsModel;\n    field: TField;\n    input: GenericRecord<string> | Array<GenericRecord<string>>;\n}\n\ninterface CmsModelFieldToGraphQLCreateResolverParams<TField> {\n    models: CmsModel[];\n    model: CmsModel;\n    graphQLType: string;\n    field: TField;\n    createFieldResolvers: any;\n    fieldTypePlugins: CmsFieldTypePlugins;\n}\n\nexport interface CmsModelFieldToGraphQLCreateResolver<TField = CmsModelField> {\n    (params: CmsModelFieldToGraphQLCreateResolverParams<TField>):\n        | GraphQLFieldResolver\n        | {\n              resolver: GraphQLFieldResolver | null;\n              typeResolvers: Resolvers<CmsContext>;\n          }\n        | false;\n}\n\nexport interface CmsModelFieldToGraphQLPluginValidateChildFieldsValidateParams<\n    TField extends CmsModelField = CmsModelField\n> {\n    fields: TField[];\n    originalFields: TField[];\n}\n\nexport interface CmsModelFieldToGraphQLPluginValidateChildFieldsValidate {\n    (params: CmsModelFieldToGraphQLPluginValidateChildFieldsValidateParams): void;\n}\n\nexport interface CmsModelFieldToGraphQLPluginValidateChildFieldsParams<\n    TField extends CmsModelField = CmsModelField\n> {\n    field: TField;\n    originalField?: TField;\n    validate: CmsModelFieldToGraphQLPluginValidateChildFieldsValidate;\n}\n\nexport interface CmsModelFieldToGraphQLPluginValidateChildFields<\n    TField extends CmsModelField = CmsModelField\n> {\n    (params: CmsModelFieldToGraphQLPluginValidateChildFieldsParams<TField>): void;\n}\n\n/**\n * @category ModelField\n */\nexport interface CmsFieldTypePlugins {\n    [key: string]: CmsModelFieldToGraphQLPlugin;\n}\n\n/**\n * A GraphQL `params.data` parameter received when creating content model group.\n *\n * @category CmsGroup\n * @category GraphQL params\n */\nexport interface CmsGroupCreateInput {\n    id?: string;\n    name: string;\n    slug?: string;\n    description?: string | null;\n    icon?: CmsIcon | null;\n}\n\n/**\n * A GraphQL `params.data` parameter received when updating content model group.\n *\n * @category CmsGroup\n * @category GraphQL params\n */\nexport interface CmsGroupUpdateInput {\n    name?: string;\n    slug?: string;\n    description?: string;\n    icon?: CmsIcon;\n}\n\n/**\n * A `data.where` parameter received when listing content model groups.\n *\n * @category CmsGroup\n * @category GraphQL params\n */\nexport interface CmsGroupListParams {\n    where: {\n        tenant: string;\n    };\n}\n\n/**\n * Cms Group in context.\n *\n * @category Context\n * @category CmsGroup\n */\nexport interface CmsGroupContext {\n    /**\n     * Gets content model group by given id.\n     */\n    getGroup: (id: string) => Promise<CmsGroup>;\n    /**\n     * List all content model groups. Filterable via params.\n     */\n    listGroups: (params?: CmsGroupListParams) => Promise<CmsGroup[]>;\n    /**\n     * Create a new content model group.\n     */\n    createGroup: (data: CmsGroupCreateInput) => Promise<CmsGroup>;\n    /**\n     * Update existing content model group.\n     */\n    updateGroup: (id: string, data: CmsGroupUpdateInput) => Promise<CmsGroup>;\n    /**\n     * Delete content model group by given id.\n     */\n    deleteGroup: (id: string) => Promise<boolean>;\n    /**\n     * Clear the cached groups.\n     */\n    clearGroupsCache: () => void;\n}\n\n/**\n * A content entry values definition for and from the database.\n *\n * @category Database model\n * @category CmsEntry\n */\nexport interface CmsEntryValues {\n    [key: string]: any;\n}\n\nexport interface ICmsEntryLocation {\n    folderId?: string;\n}\n\nexport interface ICmsEntryLive {\n    version: number;\n}\n\nexport interface ICmsEntrySystem {\n    // to be extended\n}\n/**\n * A content entry definition for and from the database.\n *\n * @category Database model\n * @category CmsEntry\n */\nexport interface CmsEntry<TValues extends CmsEntryValues = CmsEntryValues> {\n    /**\n     * Tenant id which is this entry for. Can be used in case of shared storage.\n     */\n    tenant: string;\n    /**\n     * Generated ID of the entry. It is shared across all the records in the database that represent a single entry.\n     * So version 1, 2, ..., 2371 will have the same value in this field to link them together.\n     */\n    entryId: string;\n    /**\n     * Generated ID + version of the entry.\n     */\n    id: string;\n\n    /**\n     * Revision-level meta fields. 👇\n     */\n\n    /**\n     * An ISO 8601 date/time string.\n     */\n    revisionCreatedOn: string;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    revisionSavedOn: string;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    revisionModifiedOn: string | null;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    revisionDeletedOn: string | null;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    revisionRestoredOn: string | null;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    revisionFirstPublishedOn: string | null;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    revisionLastPublishedOn: string | null;\n\n    /**\n     * Identity that last ionCreated the entry.\n     */\n    revisionCreatedBy: CmsIdentity;\n    /**\n     * Identity that last ionSaved the entry.\n     */\n    revisionSavedBy: CmsIdentity;\n    /**\n     * Identity that last ionModified the entry.\n     */\n    revisionModifiedBy: CmsIdentity | null;\n    /**\n     * Identity that last deleted the revision.\n     */\n    revisionDeletedBy: CmsIdentity | null;\n    /**\n     * Identity that last restored the revision.\n     */\n    revisionRestoredBy: CmsIdentity | null;\n    /**\n     * Identity that first published the entry.\n     */\n    revisionFirstPublishedBy: CmsIdentity | null;\n    /**\n     * Identity that last published the entry.\n     */\n    revisionLastPublishedBy: CmsIdentity | null;\n\n    /**\n     * An ISO 8601 date/time string.\n     */\n    createdOn: string;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    savedOn: string;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    modifiedOn: string | null;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    deletedOn: string | null;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    restoredOn: string | null;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    firstPublishedOn: string | null;\n    /**\n     * An ISO 8601 date/time string.\n     */\n    lastPublishedOn: string | null;\n\n    /**\n     * Identity that last created the entry.\n     */\n    createdBy: CmsIdentity;\n    /**\n     * Identity that last saved the entry.\n     */\n    savedBy: CmsIdentity;\n    /**\n     * Identity that last modified the entry.\n     */\n    modifiedBy: CmsIdentity | null;\n    /**\n     * Identity that last deleted the entry.\n     */\n    deletedBy: CmsIdentity | null;\n    /**\n     * Identity that last restored the entry.\n     */\n    restoredBy: CmsIdentity | null;\n    /**\n     * Identity that first published the entry.\n     */\n    firstPublishedBy: CmsIdentity | null;\n    /**\n     * Identity that last published the entry.\n     */\n    lastPublishedBy: CmsIdentity | null;\n\n    /**\n     * Model ID of the definition for the entry.\n     * @see CmsModel\n     */\n    modelId: string;\n    /**\n     * A revision version of the entry.\n     */\n    version: number;\n    /**\n     * Is the entry locked?\n     */\n    locked: boolean;\n    /**\n     * Status type of the entry.\n     */\n    status: CmsEntryStatus;\n    /**\n     * A mapped storageId -> value object.\n     *\n     * @see CmsModelField\n     */\n    values: TValues;\n    /**\n     * Advanced Content Organization\n     */\n    location?: ICmsEntryLocation;\n    /**\n     * Settings for the given entry.\n     *\n     * Introduced with Advanced Publishing Workflow. Will always be inserted once this PR is merged.\n     * Be aware that when accessing properties in it on old systems, it will break if not checked first.\n     *\n     * Available only on the Manage API in entry GraphQL type `meta.data` property.\n     */\n    meta?: GenericRecord;\n    /**\n     * Is the entry in the bin?\n     */\n    wbyDeleted?: boolean | null;\n    /**\n     * This field preserves the original folderId value, as the ROOT_FOLDER is set upon deletion.\n     * The value is used when restoring the entry from the trash bin.\n     */\n    binOriginalFolderId?: string;\n\n    system?: ICmsEntrySystem;\n    /**\n     * Is this CMS Entry live (no matter the revision).\n     */\n    live: ICmsEntryLive | null;\n}\n\nexport interface CmsStorageEntry<T extends CmsEntryValues = CmsEntryValues> extends CmsEntry<T> {\n    [key: string]: any;\n}\n\nexport interface CmsEntryUniqueValue {\n    value: string;\n    count: number;\n}\n\nexport interface ICmsModelListParams {\n    /**\n     * Defaults to true.\n     */\n    includePrivate?: boolean;\n    includePlugins?: boolean;\n}\n\n/**\n * Cms Model in the context.\n *\n * @category Context\n * @category CmsModel\n */\nexport interface CmsModelContext {\n    /**\n     * Get a single content model.\n     *\n     * @throws NotFoundError\n     */\n    getModel(modelId: string): Promise<CmsModel>;\n    /**\n     * Get model to AST converter.\n     */\n    getModelToAstConverter: () => CmsModelToAstConverter;\n    /**\n     * Get all content models.\n     */\n    listModels(params?: ICmsModelListParams): Promise<CmsModel[]>;\n    /**\n     * Create a content model.\n     */\n    createModel(data: CmsModelCreateInput): Promise<CmsModel>;\n    /**\n     * Create a content model from the given model - clone.\n     */\n    createModelFrom(modelId: string, data: CmsModelCreateFromInput): Promise<CmsModel>;\n    /**\n     * Update content model.\n     */\n    updateModel(modelId: string, data: CmsModelUpdateInput): Promise<CmsModel>;\n    /**\n     * Delete content model. Should not allow deletion if there are entries connected to it.\n     */\n    deleteModel(modelId: string): Promise<void>;\n    /**\n     * Clear all the model caches.\n     */\n    clearModelsCache(): void;\n}\n\n/**\n * Available statuses for content entry.\n *\n * @category CmsEntry\n */\nexport type CmsEntryStatus = \"published\" | \"unpublished\" | \"draft\";\n\nexport interface CmsEntryListWhereRef\n    extends IdInterfaceGenerator<\"id\">,\n        IdInterfaceGenerator<\"entryId\">,\n        IdInterfaceGenerator<\"modelId\"> {}\n\nexport interface CmsEntryListWhereValues {\n    /**\n     * This is to allow querying by any content model field defined by the user.\n     */\n    [key: string]:\n        | string\n        | number\n        | boolean\n        | Date\n        | undefined\n        | string[]\n        | number[]\n        | null\n        | CmsEntryListWhereValues[]\n        | CmsEntryListWhereValues\n        | CmsEntryListWhereRef;\n}\n/**\n * Entry listing where params.\n *\n * @category CmsEntry\n * @category GraphQL params\n */\n\nexport interface CmsEntryListWhere\n    extends IdMixedInterfaceGenerator<\"id\">,\n        IdMixedInterfaceGenerator<\"entryId\">,\n        IdInterfaceGenerator<\"status\", CmsEntryStatus>,\n        /**\n         * Revision-level meta fields. 👇\n         */\n        IdentityInterfaceGenerator<\"revisionCreatedBy\">,\n        IdentityInterfaceGenerator<\"revisionModifiedBy\">,\n        IdentityInterfaceGenerator<\"revisionSavedBy\">,\n        IdentityInterfaceGenerator<\"revisionFirstPublishedBy\">,\n        IdentityInterfaceGenerator<\"revisionLastPublishedBy\">,\n        /**\n         * Entry-level meta fields. 👇\n         */\n        IdentityInterfaceGenerator<\"createdBy\">,\n        IdentityInterfaceGenerator<\"modifiedBy\">,\n        IdentityInterfaceGenerator<\"savedBy\">,\n        IdentityInterfaceGenerator<\"firstPublishedBy\">,\n        IdentityInterfaceGenerator<\"lastPublishedBy\">,\n        DateStringInterfaceGenerator<\"createdOn\">,\n        DateStringInterfaceGenerator<\"savedOn\">,\n        DateStringInterfaceGenerator<\"deletedOn\">,\n        /**\n         * Version of the entry.\n         *\n         * It is not meant to be used via the API.\n         * @internal\n         */\n        NumericInterfaceGenerator<\"version\">,\n        /**\n         * Each storage operations implementation MUST determine how to use this field.\n         * In SQL, it can be a `published` field, and in DynamoDB it can be an SK.\n         *\n         * It is not meant to be used via the API.\n         * @internal\n         */\n        TruthfulInterfaceGenerator<\"published\">,\n        /**\n         * Each storage operations implementation MUST determine how to use this field.\n         * In SQL, it can be a `latest` field, and in DynamoDB it can be an SK.\n         *\n         * It is not meant to be used via the API.\n         * @internal\n         */\n        TruthfulInterfaceGenerator<\"latest\"> {\n    /**\n     * ACO related parameters.\n     */\n    wbyAco_location?: {\n        folderId?: string;\n        folderId_not?: string;\n        folderId_in?: string[];\n        folderId_not_in?: string[];\n    };\n    location?: {\n        folderId?: string;\n        folderId_not?: string;\n        folderId_in?: string[];\n        folderId_not_in?: string[];\n    };\n\n    values?: CmsEntryListWhereValues;\n    /**\n     * Is the entry in the bin?\n     */\n    wbyDeleted?: boolean;\n    wbyDeleted_not?: boolean;\n\n    /**\n     * To allow querying via nested queries, we added the AND / OR properties.\n     */\n    AND?: CmsEntryListWhere[];\n    OR?: CmsEntryListWhere[];\n}\n\n/**\n * Entry listing sort.\n *\n * @category CmsEntry\n * @category GraphQL params\n */\nexport type CmsEntryListSortAsc = `${string}_ASC`;\nexport type CmsEntryListSortDesc = `${string}_DESC`;\nexport type CmsEntryListSort = (CmsEntryListSortAsc | CmsEntryListSortDesc)[];\n\n/**\n * Get entry GraphQL resolver params.\n *\n * @category CmsEntry\n * @category GraphQL params\n */\nexport interface CmsEntryGetParams {\n    where: CmsEntryListWhere;\n    sort?: CmsEntryListSort;\n}\n\n/**\n * List entries GraphQL resolver params.\n *\n * @category CmsEntry\n * @category GraphQL params\n */\nexport interface CmsEntryListParams {\n    where?: CmsEntryListWhere;\n    sort?: CmsEntryListSort;\n    search?: string;\n    fields?: string[];\n    limit?: number;\n    after?: string | null;\n}\n\n/**\n * Meta information for GraphQL output.\n *\n * @category CmsEntry\n * @category GraphQL output\n */\nexport interface CmsEntryMeta {\n    /**\n     * A cursor for pagination.\n     */\n    cursor: string | null;\n    /**\n     * Is there more items to load?\n     */\n    hasMoreItems: boolean;\n    /**\n     * Total count of the items in the storage.\n     */\n    totalCount: number;\n}\n\n/**\n * @category Context\n * @category CmsEntry\n */\nexport interface CreateCmsEntryInput<TValues extends CmsEntryValues = CmsEntryValues> {\n    id?: string;\n    status?: CmsEntryStatus;\n\n    /**\n     * Entry-level meta fields. 👇\n     */\n    createdOn?: Date | string;\n    modifiedOn?: Date | string | null;\n    savedOn?: Date | string;\n    deletedOn?: Date | string | null;\n    restoredOn?: Date | string | null;\n    createdBy?: CmsIdentity;\n    modifiedBy?: CmsIdentity;\n    savedBy?: CmsIdentity;\n    deletedBy?: CmsIdentity | null;\n    restoredBy?: CmsIdentity | null;\n    firstPublishedOn?: Date | string;\n    lastPublishedOn?: Date | string;\n    firstPublishedBy?: CmsIdentity;\n    lastPublishedBy?: CmsIdentity;\n\n    /**\n     * Revision-level meta fields. 👇\n     */\n    revisionCreatedOn?: Date | string;\n    revisionModifiedOn?: Date | string | null;\n    revisionSavedOn?: Date | string;\n    revisionDeletedOn?: Date | string | null;\n    revisionRestoredOn?: Date | string | null;\n    revisionCreatedBy?: CmsIdentity;\n    revisionModifiedBy?: CmsIdentity | null;\n    revisionSavedBy?: CmsIdentity;\n    revisionDeletedBy?: CmsIdentity | null;\n    revisionRestoredBy?: CmsIdentity | null;\n    revisionFirstPublishedOn?: Date | string;\n    revisionLastPublishedOn?: Date | string;\n    revisionFirstPublishedBy?: CmsIdentity;\n    revisionLastPublishedBy?: CmsIdentity;\n    // TODO remove wbyAco_location\n    wbyAco_location?: {\n        folderId?: string | null;\n    };\n    location?: {\n        folderId?: string | null;\n    };\n\n    system?: Partial<ICmsEntrySystem>;\n\n    values: TValues | undefined;\n}\n\nexport interface CreateCmsEntryOptionsInput {\n    skipValidators?: string[];\n}\n\n/**\n * @category Context\n * @category CmsEntry\n */\nexport interface CreateFromCmsEntryInput<TValues extends CmsEntryValues = CmsEntryValues> {\n    /**\n     * Revision-level meta fields. 👇\n     */\n    revisionCreatedOn?: Date;\n    revisionSavedOn?: Date;\n    revisionModifiedOn?: Date;\n    revisionCreatedBy?: CmsIdentity;\n    revisionModifiedBy?: CmsIdentity;\n    revisionSavedBy?: CmsIdentity;\n    revisionFirstPublishedOn?: Date | string;\n    revisionLastPublishedOn?: Date | string;\n    revisionFirstPublishedBy?: CmsIdentity;\n    revisionLastPublishedBy?: CmsIdentity;\n\n    /**\n     * Entry-level meta fields. 👇\n     */\n    createdOn?: Date;\n    savedOn?: Date;\n    modifiedOn?: Date;\n    createdBy?: CmsIdentity;\n    modifiedBy?: CmsIdentity;\n    savedBy?: CmsIdentity;\n    firstPublishedOn?: Date | string;\n    lastPublishedOn?: Date | string;\n    firstPublishedBy?: CmsIdentity;\n    lastPublishedBy?: CmsIdentity;\n\n    system?: Partial<ICmsEntrySystem>;\n\n    values: TValues;\n}\n\nexport interface CreateRevisionCmsEntryOptionsInput {\n    skipValidators?: string[];\n}\n\n/**\n * @category Context\n * @category CmsEntry\n */\nexport interface UpdateCmsEntryInput<TValues extends CmsEntryValues = CmsEntryValues> {\n    /**\n     * Revision-level meta fields. 👇\n     */\n    revisionCreatedOn?: Date | string | null;\n    revisionModifiedOn?: Date | string | null;\n    revisionSavedOn?: Date | string | null;\n    revisionDeletedOn?: Date | string | null;\n    revisionRestoredOn?: Date | string | null;\n    revisionFirstPublishedOn?: Date | string | null;\n    revisionLastPublishedOn?: Date | string | null;\n    revisionModifiedBy?: CmsIdentity | null;\n    revisionCreatedBy?: CmsIdentity | null;\n    revisionSavedBy?: CmsIdentity | null;\n    revisionDeletedBy?: CmsIdentity | null;\n    revisionRestoredBy?: CmsIdentity | null;\n    revisionFirstPublishedBy?: CmsIdentity | null;\n    revisionLastPublishedBy?: CmsIdentity | null;\n\n    /**\n     * Entry-level meta fields. 👇\n     */\n    createdOn?: Date | string | null;\n    modifiedOn?: Date | string | null;\n    savedOn?: Date | string | null;\n    deletedOn?: Date | string | null;\n    restoredOn?: Date | string | null;\n    firstPublishedOn?: Date | string | null;\n    lastPublishedOn?: Date | string | null;\n    createdBy?: CmsIdentity | null;\n    modifiedBy?: CmsIdentity | null;\n    savedBy?: CmsIdentity | null;\n    deletedBy?: CmsIdentity | null;\n    restoredBy?: CmsIdentity | null;\n    firstPublishedBy?: CmsIdentity | null;\n    lastPublishedBy?: CmsIdentity | null;\n\n    wbyAco_location?: {\n        folderId?: string | null;\n    };\n\n    location?: {\n        folderId?: string | null;\n    };\n\n    system?: Partial<ICmsEntrySystem>;\n\n    values?: Partial<TValues>;\n}\n\nexport interface UpdateCmsEntryOptionsInput {\n    skipValidators?: string[];\n}\n\n/**\n * @category Context\n * @category CmsEntry\n */\nexport interface GetUniqueFieldValuesParams {\n    where: CmsEntryListWhere;\n    fieldId: string;\n}\n\n/**\n * @category CmsEntry\n */\nexport interface CmsDeleteEntryOptions {\n    /**\n     * Runs the delete commands even if the entry is not found in the DynamoDB.\n     * This is to force clean the entry records that might have been left behind a failed delete.\n     */\n    force?: boolean;\n    /**\n     * Destroying the entry directly, without moving it to the bin.\n     */\n    permanently?: boolean;\n}\n\n/**\n * @category Context\n * @category CmsEntry\n */\nexport interface DeleteMultipleEntriesParams {\n    entries: string[];\n}\n\nexport type DeleteMultipleEntriesResponse = {\n    id: string;\n}[];\n\nexport interface CmsEntryValidateResponse {\n    [key: string]: any;\n}\n\n/**\n * Parameters for CmsEntryResolverFactory.\n *\n * @category GraphQL resolver\n * @category CmsEntry\n */\ninterface CmsEntryResolverFactoryParams {\n    model: CmsModel;\n    fieldTypePlugins: CmsFieldTypePlugins;\n}\n\n/**\n * A type for EntryResolvers. Used when creating get, list, update, publish, ...etc.\n *\n * @category GraphQL resolver\n * @category CmsEntry\n */\nexport type CmsEntryResolverFactory<TSource = any, TArgs = any, TContext = CmsContext> = {\n    (params: CmsEntryResolverFactoryParams): GraphQLFieldResolver<TSource, TArgs, TContext>;\n};\n\n/**\n * A base security permission for CMS.\n *\n * @category SecurityPermission\n */\nexport interface BaseCmsSecurityPermission extends SecurityPermission {\n    own?: boolean;\n    rwd: string;\n}\n\n/**\n * A security permission for content model.\n *\n * @category SecurityPermission\n * @category CmsModel\n */\nexport interface CmsModelPermission extends BaseCmsSecurityPermission {\n    models?: string[];\n    groups?: string[];\n}\n\n/**\n * The security permission for content model groups.\n *\n * @category SecurityPermission\n * @category CmsGroup\n */\nexport interface CmsGroupPermission extends BaseCmsSecurityPermission {\n    groups?: string[];\n}\n\n/**\n * The security permission for content entry.\n *\n * @category SecurityPermission\n * @category CmsEntry\n */\nexport interface CmsEntryPermission extends BaseCmsSecurityPermission {\n    pw?: string;\n    models?: string[];\n    groups?: string[];\n}\n\nexport interface CmsGroupStorageOperationsGetParams {\n    id: string;\n    tenant: string;\n}\n\nexport interface CmsGroupStorageOperationsListWhereParams {\n    tenant: string;\n\n    [key: string]: any;\n}\n\nexport interface CmsGroupStorageOperationsListParams {\n    where: CmsGroupStorageOperationsListWhereParams;\n    sort?: string[];\n}\n\nexport interface CmsGroupStorageOperationsCreateParams {\n    group: CmsGroup;\n}\n\nexport interface CmsGroupStorageOperationsUpdateParams {\n    group: CmsGroup;\n}\n\nexport interface CmsGroupStorageOperationsDeleteParams {\n    group: CmsGroup;\n}\n\n/**\n * Description of the CmsGroup CRUD operations.\n * If user wants to add another database to the application, this is how it is done.\n * This is just plain read, update, write, delete and list - no authentication or permission checks.\n */\nexport interface CmsGroupStorageOperations {\n    /**\n     * Gets content model group by given id.\n     */\n    get: (params: CmsGroupStorageOperationsGetParams) => Promise<CmsGroup | null>;\n    /**\n     * List all content model groups. Filterable via params.\n     */\n    list: (params: CmsGroupStorageOperationsListParams) => Promise<CmsGroup[]>;\n    /**\n     * Create a new content model group.\n     */\n    create: (params: CmsGroupStorageOperationsCreateParams) => Promise<void>;\n    /**\n     * Update existing content model group.\n     */\n    update: (params: CmsGroupStorageOperationsUpdateParams) => Promise<void>;\n    /**\n     * Delete the content model group.\n     */\n    delete: (params: CmsGroupStorageOperationsDeleteParams) => Promise<void>;\n}\n\nexport interface CmsModelStorageOperationsGetParams {\n    tenant: string;\n    modelId: string;\n}\n\nexport interface CmsModelStorageOperationsListWhereParams {\n    tenant: string;\n\n    [key: string]: string;\n}\n\nexport interface CmsModelStorageOperationsListParams {\n    where: CmsModelStorageOperationsListWhereParams;\n}\n\nexport interface CmsModelStorageOperationsCreateParams {\n    model: CmsModel;\n}\n\nexport interface CmsModelStorageOperationsUpdateParams {\n    model: CmsModel;\n}\n\nexport interface CmsModelStorageOperationsDeleteParams {\n    model: CmsModel;\n}\n\n/**\n * Description of the CmsModel storage operations.\n * If user wants to add another database to the application, this is how it is done.\n * This is just plain read, update, write, delete and list - no authentication or permission checks.\n */\nexport interface CmsModelStorageOperations {\n    /**\n     * Gets content model by given id.\n     */\n    get: (params: CmsModelStorageOperationsGetParams) => Promise<CmsModel | null>;\n    /**\n     * List all content models. Filterable via params.\n     */\n    list: (params: CmsModelStorageOperationsListParams) => Promise<CmsModel[]>;\n    /**\n     * Create a new content model.\n     */\n    create: (params: CmsModelStorageOperationsCreateParams) => Promise<CmsModel>;\n    /**\n     * Update existing content model.\n     */\n    update: (params: CmsModelStorageOperationsUpdateParams) => Promise<CmsModel>;\n    /**\n     * Delete the content model.\n     */\n    delete: (params: CmsModelStorageOperationsDeleteParams) => Promise<CmsModel>;\n}\n\nexport interface CmsEntryStorageOperationsGetParams {\n    where: CmsEntryListWhere;\n    sort?: CmsEntryListSort;\n    limit?: number;\n}\n\nexport interface CmsEntryStorageOperationsListParams {\n    where: CmsEntryListWhere;\n    sort?: CmsEntryListSort;\n    search?: string;\n    fields?: string[];\n    limit: number;\n    after?: string | null;\n}\n\nexport interface CmsEntryStorageOperationsCreateParams<T extends CmsEntryValues = CmsEntryValues> {\n    /**\n     * Real entry, with no transformations on it.\n     */\n    entry: CmsEntry<T>;\n    /**\n     * Entry prepared for the storage.\n     */\n    storageEntry: CmsStorageEntry<T>;\n}\n\nexport interface CmsEntryStorageOperationsCreateRevisionFromParams<\n    T extends CmsEntryValues = CmsEntryValues\n> {\n    /**\n     * Real entry, with no transformations on it.\n     */\n    entry: CmsEntry<T>;\n    /**\n     * Entry prepared for the storage.\n     */\n    storageEntry: CmsStorageEntry<T>;\n}\n\nexport interface CmsEntryStorageOperationsUpdateParams<T extends CmsEntryValues = CmsEntryValues> {\n    /**\n     * Real entry, with no transformations on it.\n     */\n    entry: CmsEntry<T>;\n    /**\n     * Entry prepared for the storage.\n     */\n    storageEntry: CmsStorageEntry<T>;\n}\n\nexport interface CmsEntryStorageOperationsDeleteRevisionParams<\n    T extends CmsEntryValues = CmsEntryValues\n> {\n    /**\n     * Entry that was deleted.\n     */\n    entry: CmsEntry<T>;\n    /**\n     * Entry that was deleted, directly from storage, with transformations.\n     */\n    storageEntry: CmsStorageEntry<T>;\n    /**\n     * Entry that was set as latest.\n     */\n    latestEntry: CmsEntry | null;\n    /**\n     * Entry that was set as latest, directly from storage, with transformations.\n     */\n    latestStorageEntry: CmsStorageEntry<T> | null;\n}\n\nexport interface CmsEntryStorageOperationsDeleteParams<T extends CmsEntryValues = CmsEntryValues> {\n    entry: CmsEntry<T>;\n}\n\nexport interface CmsEntryStorageOperationsMoveToBinParams<\n    T extends CmsEntryValues = CmsEntryValues\n> {\n    /**\n     * The modified entry that is going to be saved as published.\n     * Entry is in its original form.\n     */\n    entry: CmsEntry<T>;\n    /**\n     * The modified entry and prepared for the storage.\n     */\n    storageEntry: CmsStorageEntry<T>;\n}\n\nexport interface CmsEntryStorageOperationsRestoreFromBinParams<\n    T extends CmsEntryValues = CmsEntryValues\n> {\n    /**\n     * The modified entry that is going to be saved as restored.\n     * Entry is in its original form.\n     */\n    entry: CmsEntry<T>;\n    /**\n     * The modified entry and prepared for the storage.\n     */\n    storageEntry: CmsStorageEntry<T>;\n}\n\nexport interface CmsEntryStorageOperationsDeleteEntriesParams {\n    entries: string[];\n}\n\nexport interface CmsEntryStorageOperationsPublishParams<T extends CmsEntryValues = CmsEntryValues> {\n    /**\n     * The modified entry that is going to be saved as published.\n     * Entry is in its original form.\n     */\n    entry: CmsEntry<T>;\n    /**\n     * The modified entry and prepared for the storage.\n     */\n    storageEntry: CmsStorageEntry<T>;\n}\n\nexport interface CmsEntryStorageOperationsUnpublishParams<\n    T extends CmsEntryValues = CmsEntryValues\n> {\n    /**\n     * The modified entry that is going to be saved as unpublished.\n     */\n    entry: CmsEntry<T>;\n    /**\n     * The modified entry that is going to be saved as unpublished, with transformations on it.\n     */\n    storageEntry: CmsStorageEntry<T>;\n}\n\nexport interface CmsEntryStorageOperationsGetUniqueFieldValuesParams {\n    where: CmsEntryListWhere;\n    fieldId: string;\n}\n\nexport interface CmsEntryStorageOperationsGetByIdsParams {\n    ids: readonly string[];\n}\n\nexport interface CmsEntryStorageOperationsGetLatestByIdsParams {\n    ids: readonly string[];\n}\n\nexport interface CmsEntryStorageOperationsGetPublishedByIdsParams {\n    ids: readonly string[];\n}\n\nexport interface CmsEntryStorageOperationsGetRevisionsParams {\n    id: string;\n}\n\nexport interface CmsEntryStorageOperationsGetRevisionParams {\n    id: string;\n}\n\nexport interface CmsEntryStorageOperationsGetPublishedRevisionParams {\n    id: string;\n}\n\nexport interface CmsEntryStorageOperationsGetLatestRevisionParams {\n    id: string;\n}\n\nexport interface CmsEntryStorageOperationsGetPreviousRevisionParams {\n    entryId: string;\n    version: number;\n}\n\nexport interface CmsEntryStorageOperationsListResponse<\n    T extends CmsStorageEntry = CmsStorageEntry\n> {\n    /**\n     * Has more items to load with the current filtering?\n     */\n    hasMoreItems: boolean;\n    /**\n     * Items loaded with current filtering.\n     */\n    items: T[];\n    /**\n     * Pointer for where to start the new item set.\n     */\n    cursor: string | null;\n    /**\n     * Total amount of items with the current filter.\n     */\n    totalCount: number;\n}\n\n/**\n * Description of the CmsModel storage operations.\n * If user wants to add another database to the application, this is how it is done.\n * This is just plain read, update, write, delete and list - no authentication or permission checks.\n *\n *\n * @category StorageOperations\n * @category CmsEntry\n */\nexport interface CmsEntryStorageOperations {\n    /**\n     * Get all the entries of the ids.\n     */\n    getByIds: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetByIdsParams\n    ) => Promise<CmsEntry<T>[]>;\n    /**\n     * Get all the published entries of the ids.\n     */\n    getPublishedByIds: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetPublishedByIdsParams\n    ) => Promise<CmsEntry<T>[]>;\n    /**\n     * Get all the latest entries of the ids.\n     */\n    getLatestByIds: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetLatestByIdsParams\n    ) => Promise<CmsEntry<T>[]>;\n    /**\n     * Get all revisions of the given entry id.\n     */\n    getRevisions: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetRevisionsParams\n    ) => Promise<CmsEntry<T>[]>;\n    /**\n     * Get the entry by the given revision id.\n     */\n    getRevisionById: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetRevisionParams\n    ) => Promise<CmsEntry<T> | null>;\n    /**\n     * Get the published entry by given entryId.\n     */\n    getPublishedRevisionByEntryId: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetPublishedRevisionParams\n    ) => Promise<CmsEntry<T> | null>;\n    /**\n     * Get the latest entry by given entryId.\n     */\n    getLatestRevisionByEntryId: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetLatestRevisionParams\n    ) => Promise<CmsEntry<T> | null>;\n    /**\n     * Get the revision of the entry before given one.\n     */\n    getPreviousRevision: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetPreviousRevisionParams\n    ) => Promise<CmsEntry<T> | null>;\n    /**\n     * Gets entry by given params.\n     */\n    get: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetParams\n    ) => Promise<CmsEntry<T> | null>;\n    /**\n     * List all entries. Filterable via params.\n     */\n    list: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsListParams\n    ) => Promise<CmsEntryStorageOperationsListResponse<CmsEntry<T>>>;\n    /**\n     * Create a new entry.\n     */\n    create: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsCreateParams<T>\n    ) => Promise<CmsEntry<T>>;\n    /**\n     * Create a new entry from existing one.\n     */\n    createRevisionFrom: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsCreateRevisionFromParams<T>\n    ) => Promise<CmsEntry<T>>;\n    /**\n     * Update existing entry.\n     */\n    update: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsUpdateParams<T>\n    ) => Promise<CmsEntry<T>>;\n    /**\n     * Move entry and all its entries into a new folder.\n     */\n    move: (model: CmsModel, id: string, folderId: string) => Promise<void>;\n    /**\n     * Delete the entry revision.\n     */\n    deleteRevision: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsDeleteRevisionParams<T>\n    ) => Promise<void>;\n    /**\n     * Delete the entry.\n     */\n    delete: (model: CmsModel, params: CmsEntryStorageOperationsDeleteParams) => Promise<void>;\n    /**\n     * Move the entry to bin.\n     */\n    moveToBin: (model: CmsModel, params: CmsEntryStorageOperationsMoveToBinParams) => Promise<void>;\n    /**\n     * Restore the entry from the bin.\n     */\n    restoreFromBin: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsRestoreFromBinParams<T>\n    ) => Promise<CmsEntry<T>>;\n    /**\n     * Delete multiple entries, with a limit on how much can be deleted in one call.\n     */\n    deleteMultipleEntries: (\n        model: CmsModel,\n        params: CmsEntryStorageOperationsDeleteEntriesParams\n    ) => Promise<void>;\n    /**\n     * Publish the entry.\n     */\n    publish: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsPublishParams<T>\n    ) => Promise<CmsEntry<T>>;\n    /**\n     * Unpublish the entry.\n     */\n    unpublish: <T extends CmsEntryValues = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryStorageOperationsUnpublishParams<T>\n    ) => Promise<CmsEntry<T>>;\n    /**\n     * Method to list all the unique values for the given field id.\n     * Simplest use case would be to aggregate tags for some content.\n     * @internal\n     */\n    getUniqueFieldValues: (\n        model: CmsModel,\n        params: CmsEntryStorageOperationsGetUniqueFieldValuesParams\n    ) => Promise<CmsEntryUniqueValue[]>;\n}\n\nexport enum CONTENT_ENTRY_STATUS {\n    DRAFT = \"draft\",\n    PUBLISHED = \"published\",\n    UNPUBLISHED = \"unpublished\"\n}\n\nexport interface HeadlessCmsStorageOperations<C = CmsContext> {\n    name: string;\n    groups: CmsGroupStorageOperations;\n    models: CmsModelStorageOperations;\n    entries: CmsEntryStorageOperations;\n    /**\n     * Either attach something from the storage operations or run something in it.\n     */\n    beforeInit: (context: C) => Promise<void>;\n    init?: (context: C) => Promise<void>;\n}\n"],"mappings":"AAuFA;AACA;AACA;AACA;AACA;;AAKA;AACA;AACA;;AAKA;AACA;AACA;;AAUA;AACA;AACA;AACA;AACA;AACA;;AAgCA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;;AAwDA;AACA;AACA;;AAKA;AACA;AACA;AACA;AACA;AACA;;AASA;AACA;AACA;AACA;AACA;AACA;;AAQA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;;AA4BA;AACA;AACA;AACA;AACA;AACA;;AAgBA;AACA;AACA;AACA;AACA;AACA;;AA8MA;AACA;AACA;AACA;AACA;AACA;;AAsCA;AACA;AACA;AACA;AACA;;AAyBA;AACA;AACA;AACA;AACA;AACA;;AA8EA;AACA;AACA;AACA;AACA;AACA;;AAKA;AACA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;;AAUA;AACA;AACA;AACA;AACA;AACA;;AAgBA;AACA;AACA;AACA;;AAyDA;AACA;AACA;AACA;;AAuCA;AACA;AACA;AACA;;AAuDA;AACA;AACA;AACA;;AAMA;AACA;AACA;;AAaA;AACA;AACA;AACA;;AAaA;AACA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;;AAKA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;;AAKA;AACA;AACA;AACA;AACA;AACA;;AAmCA;AACA;AACA;AACA;AACA;;AAmDA;AACA;AACA;AACA;AACA;;AAuNA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAuJA,WAAYA,oBAAoB,0BAApBA,oBAAoB;EAApBA,oBAAoB;EAApBA,oBAAoB;EAApBA,oBAAoB;EAAA,OAApBA,oBAAoB;AAAA","ignoreList":[]}

package/utils/createModelField.js

@@ -19,7 +19,8 @@ export const createModelField = params => {
     },
     help = null,
     placeholder = null,
-    renderer = null
+    renderer = null,
+    rules = []
   } = params;
 
   // TODO: ideally, initialFieldId should also be passed through `camelCase` but currently this would break `wbyAco_location` field.
@@ -39,7 +40,8 @@ export const createModelField = params => {
     predefinedValues,
     help,
     placeholder,
-    renderer
+    renderer,
+    rules
   };
 };
 

package/utils/createModelField.js.map

@@ -1 +1 @@
-{"version":3,"names":["camelCase","createModelField","params","id","label","fieldId","initialFieldId","storageId","type","tags","settings","listValidation","validation","list","predefinedValues","values","enabled","help","placeholder","renderer"],"sources":["createModelField.ts"],"sourcesContent":["import camelCase from \"lodash/camelCase.js\";\nimport type { CmsModelField, CmsModelFieldValidation } from \"~/types/index.js\";\n\nexport interface CreateModelFieldParams\n    extends Omit<CmsModelField, \"id\" | \"storageId\" | \"fieldId\" | \"validation\" | \"listValidation\"> {\n    id?: string;\n    fieldId?: string;\n    storageId?: string;\n    validation?: CmsModelFieldValidation[];\n    listValidation?: CmsModelFieldValidation[];\n}\n\nexport const createModelField = (params: CreateModelFieldParams): CmsModelField => {\n    // We are not just spreading `params` because we want to ensure\n    // a default value is set for every property of the model field.\n    const {\n        id,\n        label,\n        fieldId: initialFieldId,\n        storageId,\n        type,\n        tags = [],\n        settings = {},\n        listValidation = [],\n        validation = [],\n        list = false,\n        predefinedValues = {\n            values: [],\n            enabled: false\n        },\n        help = null,\n        placeholder = null,\n        renderer = null\n    } = params;\n\n    // TODO: ideally, initialFieldId should also be passed through `camelCase` but currently this would break `wbyAco_location` field.\n    // TODO: Once this legacy field is removed, we can enable camelCase on the initialFieldId.\n    const fieldId = initialFieldId ? initialFieldId : camelCase(label);\n\n    return {\n        id: id ?? fieldId,\n        storageId: storageId ?? `${type}@${id ?? fieldId}`,\n        fieldId,\n        label,\n        type,\n        settings,\n        tags,\n        listValidation,\n        validation,\n        list,\n        predefinedValues,\n        help,\n        placeholder,\n        renderer\n    };\n};\n"],"mappings":"AAAA,OAAOA,SAAS,MAAM,qBAAqB;AAY3C,OAAO,MAAMC,gBAAgB,GAAIC,MAA8B,IAAoB;EAC/E;EACA;EACA,MAAM;IACFC,EAAE;IACFC,KAAK;IACLC,OAAO,EAAEC,cAAc;IACvBC,SAAS;IACTC,IAAI;IACJC,IAAI,GAAG,EAAE;IACTC,QAAQ,GAAG,CAAC,CAAC;IACbC,cAAc,GAAG,EAAE;IACnBC,UAAU,GAAG,EAAE;IACfC,IAAI,GAAG,KAAK;IACZC,gBAAgB,GAAG;MACfC,MAAM,EAAE,EAAE;MACVC,OAAO,EAAE;IACb,CAAC;IACDC,IAAI,GAAG,IAAI;IACXC,WAAW,GAAG,IAAI;IAClBC,QAAQ,GAAG;EACf,CAAC,GAAGjB,MAAM;;EAEV;EACA;EACA,MAAMG,OAAO,GAAGC,cAAc,GAAGA,cAAc,GAAGN,SAAS,CAACI,KAAK,CAAC;EAElE,OAAO;IACHD,EAAE,EAAEA,EAAE,IAAIE,OAAO;IACjBE,SAAS,EAAEA,SAAS,IAAI,GAAGC,IAAI,IAAIL,EAAE,IAAIE,OAAO,EAAE;IAClDA,OAAO;IACPD,KAAK;IACLI,IAAI;IACJE,QAAQ;IACRD,IAAI;IACJE,cAAc;IACdC,UAAU;IACVC,IAAI;IACJC,gBAAgB;IAChBG,IAAI;IACJC,WAAW;IACXC;EACJ,CAAC;AACL,CAAC","ignoreList":[]}
+{"version":3,"names":["camelCase","createModelField","params","id","label","fieldId","initialFieldId","storageId","type","tags","settings","listValidation","validation","list","predefinedValues","values","enabled","help","placeholder","renderer","rules"],"sources":["createModelField.ts"],"sourcesContent":["import camelCase from \"lodash/camelCase.js\";\nimport type { CmsModelField, CmsModelFieldValidation } from \"~/types/index.js\";\n\nexport interface CreateModelFieldParams\n    extends Omit<CmsModelField, \"id\" | \"storageId\" | \"fieldId\" | \"validation\" | \"listValidation\"> {\n    id?: string;\n    fieldId?: string;\n    storageId?: string;\n    validation?: CmsModelFieldValidation[];\n    listValidation?: CmsModelFieldValidation[];\n}\n\nexport const createModelField = (params: CreateModelFieldParams): CmsModelField => {\n    // We are not just spreading `params` because we want to ensure\n    // a default value is set for every property of the model field.\n    const {\n        id,\n        label,\n        fieldId: initialFieldId,\n        storageId,\n        type,\n        tags = [],\n        settings = {},\n        listValidation = [],\n        validation = [],\n        list = false,\n        predefinedValues = {\n            values: [],\n            enabled: false\n        },\n        help = null,\n        placeholder = null,\n        renderer = null,\n        rules = []\n    } = params;\n\n    // TODO: ideally, initialFieldId should also be passed through `camelCase` but currently this would break `wbyAco_location` field.\n    // TODO: Once this legacy field is removed, we can enable camelCase on the initialFieldId.\n    const fieldId = initialFieldId ? initialFieldId : camelCase(label);\n\n    return {\n        id: id ?? fieldId,\n        storageId: storageId ?? `${type}@${id ?? fieldId}`,\n        fieldId,\n        label,\n        type,\n        settings,\n        tags,\n        listValidation,\n        validation,\n        list,\n        predefinedValues,\n        help,\n        placeholder,\n        renderer,\n        rules\n    };\n};\n"],"mappings":"AAAA,OAAOA,SAAS,MAAM,qBAAqB;AAY3C,OAAO,MAAMC,gBAAgB,GAAIC,MAA8B,IAAoB;EAC/E;EACA;EACA,MAAM;IACFC,EAAE;IACFC,KAAK;IACLC,OAAO,EAAEC,cAAc;IACvBC,SAAS;IACTC,IAAI;IACJC,IAAI,GAAG,EAAE;IACTC,QAAQ,GAAG,CAAC,CAAC;IACbC,cAAc,GAAG,EAAE;IACnBC,UAAU,GAAG,EAAE;IACfC,IAAI,GAAG,KAAK;IACZC,gBAAgB,GAAG;MACfC,MAAM,EAAE,EAAE;MACVC,OAAO,EAAE;IACb,CAAC;IACDC,IAAI,GAAG,IAAI;IACXC,WAAW,GAAG,IAAI;IAClBC,QAAQ,GAAG,IAAI;IACfC,KAAK,GAAG;EACZ,CAAC,GAAGlB,MAAM;;EAEV;EACA;EACA,MAAMG,OAAO,GAAGC,cAAc,GAAGA,cAAc,GAAGN,SAAS,CAACI,KAAK,CAAC;EAElE,OAAO;IACHD,EAAE,EAAEA,EAAE,IAAIE,OAAO;IACjBE,SAAS,EAAEA,SAAS,IAAI,GAAGC,IAAI,IAAIL,EAAE,IAAIE,OAAO,EAAE;IAClDA,OAAO;IACPD,KAAK;IACLI,IAAI;IACJE,QAAQ;IACRD,IAAI;IACJE,cAAc;IACdC,UAAU;IACVC,IAAI;IACJC,gBAAgB;IAChBG,IAAI;IACJC,WAAW;IACXC,QAAQ;IACRC;EACJ,CAAC;AACL,CAAC","ignoreList":[]}