@webiny/api-headless-cms 0.0.0-unstable.496cf268ac → 0.0.0-unstable.606fc9c866

package/plugins/CmsModelPlugin.js.map

@@ -1 +1 @@
-{"version":3,"names":["transformNameToSingularApiName","name","upperFirst","camelCase","transformNameToPluralApiName","pluralize","CmsModelPlugin","Plugin","constructor","contentModel","options","buildModel","input","model","isPrivate","singularApiName","pluralApiName","fields","buildFields","validateLayout","inputFields","length","WebinyError","modelId","storageIdList","fieldIdList","fieldId","trim","field","lodashCamelCase","match","includes","storageId","createFieldStorageId","settings","childFields","type","push","total","row","layout","count","filter","cell","id","createCmsModel"],"sources":["CmsModelPlugin.ts"],"sourcesContent":["import WebinyError from \"@webiny/error\";\nimport lodashCamelCase from \"lodash/camelCase\";\nimport camelCase from \"lodash/camelCase\";\nimport upperFirst from \"lodash/upperFirst\";\nimport pluralize from \"pluralize\";\nimport { Plugin } from \"@webiny/plugins\";\nimport {\n    CmsModel as CmsModelBase,\n    CmsModelField as CmsModelFieldBase,\n    CmsModelFieldSettings as BaseCmsModelFieldSettings\n} from \"~/types\";\nimport { createFieldStorageId } from \"~/crud/contentModel/createFieldStorageId\";\n\nconst transformNameToSingularApiName = (name: string) => {\n    return upperFirst(camelCase(name));\n};\n\nconst transformNameToPluralApiName = (name: string) => {\n    return pluralize(transformNameToSingularApiName(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     * News 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\ninterface CmsApiModel\n    extends Omit<CmsModelBase, \"isPrivate\" | \"locale\" | \"tenant\" | \"webinyVersion\" | \"fields\"> {\n    isPrivate?: never;\n    fields: CmsModelFieldInput[];\n    locale?: string;\n    tenant?: string;\n}\n\ninterface CmsPrivateModel\n    extends Omit<\n        CmsModelBase,\n        | \"isPrivate\"\n        | \"singularApiName\"\n        | \"pluralApiName\"\n        | \"locale\"\n        | \"tenant\"\n        | \"webinyVersion\"\n        | \"fields\"\n    > {\n    singularApiName?: never;\n    pluralApiName?: never;\n    isPrivate: true;\n    fields: CmsModelFieldInput[];\n    locale?: string;\n    tenant?: string;\n}\n\ntype CmsModelInput = CmsApiModel | CmsPrivateModel;\n\ninterface CmsModel extends Omit<CmsModelBase, \"locale\" | \"tenant\" | \"webinyVersion\"> {\n    locale?: string;\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: CmsModel;\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): CmsModel {\n        const model: CmsModel = {\n            ...input,\n            isPrivate: input.isPrivate || false,\n            singularApiName: input.singularApiName || transformNameToSingularApiName(input.name),\n            pluralApiName: input.pluralApiName || transformNameToPluralApiName(input.name),\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) === true) {\n                throw new WebinyError(\n                    `Field's \"fieldId\" 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 ? lodashCamelCase(input.storageId) : null;\n            /**\n             * If defined, storageId MUST be camel cased string - for backward compatibility.\n             */\n            if (\n                storageId &&\n                (storageId.match(/^([a-zA-Z-0-9]+)$/) === null || storageId !== input.storageId)\n            ) {\n                throw new WebinyError(\n                    `Field's \"storageId\" of the field with \"fieldId\" ${input.fieldId} is not camel cased string in the content model \"${model.modelId}\".`,\n                    \"STORAGE_ID_NOT_CAMEL_CASED_ERROR\",\n                    {\n                        model,\n                        storageId,\n                        field: input\n                    }\n                );\n            } else if (!storageId) {\n                storageId = createFieldStorageId(input);\n            }\n\n            /**\n             * Fields storageId must be unique.\n             */\n            if (storageIdList.includes(storageId) === true) {\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-ignore\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: CmsModel): 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\nexport const createCmsModel = (\n    model: CmsModelInput,\n    options?: CmsModelPluginOptions\n): CmsModelPlugin => {\n    return new CmsModelPlugin(model, options);\n};\n"],"mappings":";;;;;;;;;AAAA;AACA;AAEA;AACA;AACA;AAMA;AAEA,MAAMA,8BAA8B,GAAIC,IAAY,IAAK;EACrD,OAAO,IAAAC,mBAAU,EAAC,IAAAC,kBAAS,EAACF,IAAI,CAAC,CAAC;AACtC,CAAC;AAED,MAAMG,4BAA4B,GAAIH,IAAY,IAAK;EACnD,OAAO,IAAAI,kBAAS,EAACL,8BAA8B,CAACC,IAAI,CAAC,CAAC;AAC1D,CAAC;AA8DM,MAAMK,cAAc,SAASC,eAAM,CAAC;EAMvCC,WAAW,CAACC,YAA2B,EAAEC,OAA+B,EAAE;IACtE,KAAK,EAAE;IAAC;IAAA;IACR,IAAI,CAACA,OAAO,GAAGA,OAAO,IAAI,CAAC,CAAC;IAC5B,IAAI,CAACD,YAAY,GAAG,IAAI,CAACE,UAAU,CAACF,YAAY,CAAC;EACrD;EAEQE,UAAU,CAACC,KAAoB,EAAY;IAC/C,MAAMC,KAAe,+DACdD,KAAK;MACRE,SAAS,EAAEF,KAAK,CAACE,SAAS,IAAI,KAAK;MACnCC,eAAe,EAAEH,KAAK,CAACG,eAAe,IAAIf,8BAA8B,CAACY,KAAK,CAACX,IAAI,CAAC;MACpFe,aAAa,EAAEJ,KAAK,CAACI,aAAa,IAAIZ,4BAA4B,CAACQ,KAAK,CAACX,IAAI,CAAC;MAC9EgB,MAAM,EAAE,IAAI,CAACC,WAAW,CAACN,KAAK,EAAEA,KAAK,CAACK,MAAM;IAAC,EAChD;IACD,IAAI,CAACE,cAAc,CAACN,KAAK,CAAC;IAC1B,OAAOA,KAAK;EAChB;EAEQK,WAAW,CACfL,KAAoB,EACpBO,WAAiC,EACd;IACnB,IAAIA,WAAW,CAACC,MAAM,KAAK,CAAC,EAAE;MAC1B,MAAM,IAAIC,cAAW,CAChB,yCAAwCT,KAAK,CAACU,OAAQ,IAAG,EAC1D,gBAAgB,EAChB;QACIV;MACJ,CAAC,CACJ;IACL;IACA,MAAMI,MAA2B,GAAG,EAAE;IACtC,MAAMO,aAAuB,GAAG,EAAE;IAClC,MAAMC,WAAqB,GAAG,EAAE;IAChC,KAAK,MAAMb,KAAK,IAAIQ,WAAW,EAAE;MAAA;MAC7B;AACZ;AACA;MACY,IAAI,CAAC,CAACR,KAAK,CAACc,OAAO,IAAI,EAAE,EAAEC,IAAI,EAAE,EAAE;QAC/B,MAAM,IAAIL,cAAW,CAChB,6DAA4DT,KAAK,CAACU,OAAQ,IAAG,EAC9E,gBAAgB,EAChB;UACIV,KAAK;UACLe,KAAK,EAAEhB;QACX,CAAC,CACJ;MACL;MACA,MAAMc,OAAO,GAAG,IAAAG,kBAAe,EAACjB,KAAK,CAACc,OAAO,CAAC;MAC9C;AACZ;AACA;MACY,IAAIA,OAAO,CAACI,KAAK,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;QAClC,MAAM,IAAIR,cAAW,CAChB,0EAAyET,KAAK,CAACU,OAAQ,iCAAgC,EACxH,sBAAsB,EACtB;UACIV,KAAK;UACLe,KAAK,EAAEhB;QACX,CAAC,CACJ;MACL;MACA;AACZ;AACA;MACY,IAAIc,OAAO,KAAKd,KAAK,CAACc,OAAO,EAAE;QAC3B,MAAM,IAAIJ,cAAW,CAChB,wEAAuET,KAAK,CAACU,OAAQ,IAAG,EACzF,sBAAsB,EACtB;UACIV,KAAK;UACLe,KAAK,EAAEhB;QACX,CAAC,CACJ;MACL;MACA;AACZ;AACA;MACY,IAAIa,WAAW,CAACM,QAAQ,CAACL,OAAO,CAAC,KAAK,IAAI,EAAE;QACxC,MAAM,IAAIJ,cAAW,CAChB,yDAAwDT,KAAK,CAACU,OAAQ,IAAG,EAC1E,2BAA2B,EAC3B;UACIV,KAAK;UACLe,KAAK,EAAEhB;QACX,CAAC,CACJ;MACL;MAEA,IAAIoB,SAAS,GAAGpB,KAAK,CAACoB,SAAS,GAAG,IAAAH,kBAAe,EAACjB,KAAK,CAACoB,SAAS,CAAC,GAAG,IAAI;MACzE;AACZ;AACA;MACY,IACIA,SAAS,KACRA,SAAS,CAACF,KAAK,CAAC,mBAAmB,CAAC,KAAK,IAAI,IAAIE,SAAS,KAAKpB,KAAK,CAACoB,SAAS,CAAC,EAClF;QACE,MAAM,IAAIV,cAAW,CAChB,mDAAkDV,KAAK,CAACc,OAAQ,oDAAmDb,KAAK,CAACU,OAAQ,IAAG,EACrI,kCAAkC,EAClC;UACIV,KAAK;UACLmB,SAAS;UACTJ,KAAK,EAAEhB;QACX,CAAC,CACJ;MACL,CAAC,MAAM,IAAI,CAACoB,SAAS,EAAE;QACnBA,SAAS,GAAG,IAAAC,0CAAoB,EAACrB,KAAK,CAAC;MAC3C;;MAEA;AACZ;AACA;MACY,IAAIY,aAAa,CAACO,QAAQ,CAACC,SAAS,CAAC,KAAK,IAAI,EAAE;QAC5C,MAAM,IAAIV,cAAW,CAChB,2DAA0DT,KAAK,CAACU,OAAQ,IAAG,EAC5E,kBAAkB,EAClB;UACIV,KAAK;UACLe,KAAK,EAAEhB;QACX,CAAC,CACJ;MACL;;MAEA;AACZ;AACA;MACY;MACA,IAAIsB,QAAmC,GAAGtB,KAAK,CAACsB,QAAQ;MAExD,MAAMC,WAAW,GAAG,cAAAD,QAAQ,8CAAR,UAAUjB,MAAM,KAAI,EAAE;MAC1C,IAAIL,KAAK,CAACwB,IAAI,KAAK,QAAQ,IAAID,WAAW,CAACd,MAAM,GAAG,CAAC,EAAE;QACnDa,QAAQ,+DACAA,QAAQ,IAAI,CAAC,CAAC;UAClBjB,MAAM,EAAE,IAAI,CAACC,WAAW,CAACL,KAAK,EAAEsB,WAAW;QAAC,EAC/C;MACL;MAEA,MAAMP,KAAwB,+DACvBhB,KAAK;QACRsB,QAAQ;QACRF;MAAS,EACZ;MACD;AACZ;AACA;MACYf,MAAM,CAACoB,IAAI,CAACT,KAAK,CAAC;MAClBJ,aAAa,CAACa,IAAI,CAACT,KAAK,CAACI,SAAS,CAAC;MACnCP,WAAW,CAACY,IAAI,CAACT,KAAK,CAACF,OAAO,CAAC;IACnC;IACA,OAAOT,MAAM;EACjB;EAEQE,cAAc,CAACN,KAAe,EAAQ;IAC1C;AACR;AACA;IACQ,IAAI,IAAI,CAACH,OAAO,CAACS,cAAc,KAAK,KAAK,EAAE;MACvC;IACJ;IACA,KAAK,MAAMS,KAAK,IAAIf,KAAK,CAACI,MAAM,EAAE;MAC9B,IAAIqB,KAAK,GAAG,CAAC;MACb,KAAK,MAAMC,GAAG,IAAI1B,KAAK,CAAC2B,MAAM,EAAE;QAC5B,MAAMC,KAAK,GAAGF,GAAG,CAACG,MAAM,CAACC,IAAI,IAAIA,IAAI,KAAKf,KAAK,CAACgB,EAAE,CAAC,CAACvB,MAAM;QAC1DiB,KAAK,GAAGA,KAAK,GAAGG,KAAK;MACzB;MACA,IAAIH,KAAK,KAAK,CAAC,EAAE;QACb;MACJ,CAAC,MAAM,IAAIA,KAAK,GAAG,CAAC,EAAE;QAClB,MAAM,IAAIhB,cAAW,CAChB,UAASM,KAAK,CAACgB,EAAG,oCAAmC,EACtD,2BAA2B,EAC3B;UACI/B,KAAK;UACLe;QACJ,CAAC,CACJ;MACL;MACA,MAAM,IAAIN,cAAW,CAChB,kBAAiBM,KAAK,CAACgB,EAAG,cAAa,EACxC,yBAAyB,EACzB;QACI/B,KAAK;QACLe;MACJ,CAAC,CACJ;IACL;EACJ;AACJ;AAAC;AAAA,8BAlMYtB,cAAc,UACwB,mBAAmB;AAmM/D,MAAMuC,cAAc,GAAG,CAC1BhC,KAAoB,EACpBH,OAA+B,KACd;EACjB,OAAO,IAAIJ,cAAc,CAACO,KAAK,EAAEH,OAAO,CAAC;AAC7C,CAAC;AAAC"}
+{"version":3,"names":["createApiName","name","upperFirst","camelCase","createPluralApiName","pluralize","CmsModelPlugin","Plugin","constructor","contentModel","options","buildModel","input","isPrivate","singularApiName","pluralApiName","noValidate","model","fields","buildFields","validateLayout","inputFields","length","WebinyError","modelId","storageIdList","fieldIdList","fieldId","trim","field","lodashCamelCase","match","includes","storageId","createFieldStorageId","settings","childFields","type","push","total","row","layout","count","filter","cell","id","createCmsModel"],"sources":["CmsModelPlugin.ts"],"sourcesContent":["import WebinyError from \"@webiny/error\";\nimport lodashCamelCase from \"lodash/camelCase\";\nimport camelCase from \"lodash/camelCase\";\nimport upperFirst from \"lodash/upperFirst\";\nimport pluralize from \"pluralize\";\nimport { Plugin } from \"@webiny/plugins\";\nimport {\n    CmsModel as CmsModelBase,\n    CmsModelField as CmsModelFieldBase,\n    CmsModelFieldSettings as BaseCmsModelFieldSettings\n} from \"~/types\";\nimport { createFieldStorageId } from \"~/crud/contentModel/createFieldStorageId\";\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     * News 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<CmsModel, \"isPrivate\" | \"fields\" | \"singularApiName\" | \"pluralApiName\"> {\n    isPrivate?: never;\n    noValidate?: never;\n    singularApiName?: string;\n    pluralApiName?: string;\n    fields: CmsModelFieldInput[];\n}\n\nexport interface CmsApiModelFull extends Omit<CmsApiModel, \"fields\" | \"noValidate\"> {\n    noValidate: true;\n    fields: CmsModelFieldBase[];\n}\n\ninterface CmsPrivateModel\n    extends Omit<CmsModel, \"isPrivate\" | \"singularApiName\" | \"pluralApiName\" | \"fields\"> {\n    noValidate?: never;\n    singularApiName?: never;\n    pluralApiName?: never;\n    isPrivate: true;\n    fields: CmsModelFieldInput[];\n}\n\nexport interface CmsPrivateModelFull extends Omit<CmsPrivateModel, \"fields\" | \"noValidate\"> {\n    fields: CmsModelFieldBase[];\n    noValidate: true;\n}\n\nexport type CmsModelInput = CmsApiModel | CmsPrivateModel | CmsApiModelFull | CmsPrivateModelFull;\n\ninterface CmsModel extends Omit<CmsModelBase, \"locale\" | \"tenant\" | \"webinyVersion\"> {\n    locale?: string;\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: CmsModel;\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): CmsModel {\n        const isPrivate = input.isPrivate || false;\n        const singularApiName = input.singularApiName\n            ? createApiName(input.singularApiName)\n            : createApiName(input.name);\n        const pluralApiName = input.pluralApiName\n            ? createApiName(input.pluralApiName)\n            : createPluralApiName(input.name);\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            // @ts-ignore\n            delete input[\"noValidate\"];\n            return {\n                ...input,\n                isPrivate,\n                singularApiName,\n                pluralApiName\n            };\n        }\n\n        const model: CmsModel = {\n            ...input,\n            isPrivate,\n            singularApiName,\n            pluralApiName,\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) === true) {\n                throw new WebinyError(\n                    `Field's \"fieldId\" 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 ? lodashCamelCase(input.storageId) : null;\n            /**\n             * If defined, storageId MUST be camel cased string - for backward compatibility.\n             */\n            if (\n                storageId &&\n                (storageId.match(/^([a-zA-Z-0-9]+)$/) === null || storageId !== input.storageId)\n            ) {\n                throw new WebinyError(\n                    `Field's \"storageId\" of the field with \"fieldId\" ${input.fieldId} is not camel cased string in the content model \"${model.modelId}\".`,\n                    \"STORAGE_ID_NOT_CAMEL_CASED_ERROR\",\n                    {\n                        model,\n                        storageId,\n                        field: input\n                    }\n                );\n            } else if (!storageId) {\n                storageId = createFieldStorageId(input);\n            }\n\n            /**\n             * Fields storageId must be unique.\n             */\n            if (storageIdList.includes(storageId) === true) {\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-ignore\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: CmsModel): 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\nexport const createCmsModel = (\n    model: CmsModelInput,\n    options?: CmsModelPluginOptions\n): CmsModelPlugin => {\n    return new CmsModelPlugin(model, options);\n};\n"],"mappings":";;;;;;;;;AAAA;AACA;AAEA;AACA;AACA;AAMA;AAEA,MAAMA,aAAa,GAAIC,IAAY,IAAK;EACpC,OAAO,IAAAC,mBAAU,EAAC,IAAAC,kBAAS,EAACF,IAAI,CAAC,CAAC;AACtC,CAAC;AAED,MAAMG,mBAAmB,GAAIH,IAAY,IAAK;EAC1C,OAAO,IAAAI,kBAAS,EAACL,aAAa,CAACC,IAAI,CAAC,CAAC;AACzC,CAAC;AA+DM,MAAMK,cAAc,SAASC,eAAM,CAAC;EAMvCC,WAAW,CAACC,YAA2B,EAAEC,OAA+B,EAAE;IACtE,KAAK,EAAE;IAAC;IAAA;IACR,IAAI,CAACA,OAAO,GAAGA,OAAO,IAAI,CAAC,CAAC;IAC5B,IAAI,CAACD,YAAY,GAAG,IAAI,CAACE,UAAU,CAACF,YAAY,CAAC;EACrD;EAEQE,UAAU,CAACC,KAAoB,EAAY;IAC/C,MAAMC,SAAS,GAAGD,KAAK,CAACC,SAAS,IAAI,KAAK;IAC1C,MAAMC,eAAe,GAAGF,KAAK,CAACE,eAAe,GACvCd,aAAa,CAACY,KAAK,CAACE,eAAe,CAAC,GACpCd,aAAa,CAACY,KAAK,CAACX,IAAI,CAAC;IAC/B,MAAMc,aAAa,GAAGH,KAAK,CAACG,aAAa,GACnCf,aAAa,CAACY,KAAK,CAACG,aAAa,CAAC,GAClCX,mBAAmB,CAACQ,KAAK,CAACX,IAAI,CAAC;IAErC,IAAIW,KAAK,CAACI,UAAU,EAAE;MAClB;AACZ;AACA;MACY;MACA,OAAOJ,KAAK,CAAC,YAAY,CAAC;MAC1B,mEACOA,KAAK;QACRC,SAAS;QACTC,eAAe;QACfC;MAAa;IAErB;IAEA,MAAME,KAAe,+DACdL,KAAK;MACRC,SAAS;MACTC,eAAe;MACfC,aAAa;MACbG,MAAM,EAAE,IAAI,CAACC,WAAW,CAACP,KAAK,EAAEA,KAAK,CAACM,MAAM;IAAC,EAChD;IACD,IAAI,CAACE,cAAc,CAACH,KAAK,CAAC;IAC1B,OAAOA,KAAK;EAChB;EAEQE,WAAW,CACfF,KAAoB,EACpBI,WAAiC,EACd;IACnB,IAAIA,WAAW,CAACC,MAAM,KAAK,CAAC,EAAE;MAC1B,MAAM,IAAIC,cAAW,CAChB,yCAAwCN,KAAK,CAACO,OAAQ,IAAG,EAC1D,gBAAgB,EAChB;QACIP;MACJ,CAAC,CACJ;IACL;IACA,MAAMC,MAA2B,GAAG,EAAE;IACtC,MAAMO,aAAuB,GAAG,EAAE;IAClC,MAAMC,WAAqB,GAAG,EAAE;IAChC,KAAK,MAAMd,KAAK,IAAIS,WAAW,EAAE;MAAA;MAC7B;AACZ;AACA;MACY,IAAI,CAAC,CAACT,KAAK,CAACe,OAAO,IAAI,EAAE,EAAEC,IAAI,EAAE,EAAE;QAC/B,MAAM,IAAIL,cAAW,CAChB,6DAA4DN,KAAK,CAACO,OAAQ,IAAG,EAC9E,gBAAgB,EAChB;UACIP,KAAK;UACLY,KAAK,EAAEjB;QACX,CAAC,CACJ;MACL;MACA,MAAMe,OAAO,GAAG,IAAAG,kBAAe,EAAClB,KAAK,CAACe,OAAO,CAAC;MAC9C;AACZ;AACA;MACY,IAAIA,OAAO,CAACI,KAAK,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;QAClC,MAAM,IAAIR,cAAW,CAChB,0EAAyEN,KAAK,CAACO,OAAQ,iCAAgC,EACxH,sBAAsB,EACtB;UACIP,KAAK;UACLY,KAAK,EAAEjB;QACX,CAAC,CACJ;MACL;MACA;AACZ;AACA;MACY,IAAIe,OAAO,KAAKf,KAAK,CAACe,OAAO,EAAE;QAC3B,MAAM,IAAIJ,cAAW,CAChB,wEAAuEN,KAAK,CAACO,OAAQ,IAAG,EACzF,sBAAsB,EACtB;UACIP,KAAK;UACLY,KAAK,EAAEjB;QACX,CAAC,CACJ;MACL;MACA;AACZ;AACA;MACY,IAAIc,WAAW,CAACM,QAAQ,CAACL,OAAO,CAAC,KAAK,IAAI,EAAE;QACxC,MAAM,IAAIJ,cAAW,CAChB,yDAAwDN,KAAK,CAACO,OAAQ,IAAG,EAC1E,2BAA2B,EAC3B;UACIP,KAAK;UACLY,KAAK,EAAEjB;QACX,CAAC,CACJ;MACL;MAEA,IAAIqB,SAAS,GAAGrB,KAAK,CAACqB,SAAS,GAAG,IAAAH,kBAAe,EAAClB,KAAK,CAACqB,SAAS,CAAC,GAAG,IAAI;MACzE;AACZ;AACA;MACY,IACIA,SAAS,KACRA,SAAS,CAACF,KAAK,CAAC,mBAAmB,CAAC,KAAK,IAAI,IAAIE,SAAS,KAAKrB,KAAK,CAACqB,SAAS,CAAC,EAClF;QACE,MAAM,IAAIV,cAAW,CAChB,mDAAkDX,KAAK,CAACe,OAAQ,oDAAmDV,KAAK,CAACO,OAAQ,IAAG,EACrI,kCAAkC,EAClC;UACIP,KAAK;UACLgB,SAAS;UACTJ,KAAK,EAAEjB;QACX,CAAC,CACJ;MACL,CAAC,MAAM,IAAI,CAACqB,SAAS,EAAE;QACnBA,SAAS,GAAG,IAAAC,0CAAoB,EAACtB,KAAK,CAAC;MAC3C;;MAEA;AACZ;AACA;MACY,IAAIa,aAAa,CAACO,QAAQ,CAACC,SAAS,CAAC,KAAK,IAAI,EAAE;QAC5C,MAAM,IAAIV,cAAW,CAChB,2DAA0DN,KAAK,CAACO,OAAQ,IAAG,EAC5E,kBAAkB,EAClB;UACIP,KAAK;UACLY,KAAK,EAAEjB;QACX,CAAC,CACJ;MACL;;MAEA;AACZ;AACA;MACY;MACA,IAAIuB,QAAmC,GAAGvB,KAAK,CAACuB,QAAQ;MAExD,MAAMC,WAAW,GAAG,cAAAD,QAAQ,8CAAR,UAAUjB,MAAM,KAAI,EAAE;MAC1C,IAAIN,KAAK,CAACyB,IAAI,KAAK,QAAQ,IAAID,WAAW,CAACd,MAAM,GAAG,CAAC,EAAE;QACnDa,QAAQ,+DACAA,QAAQ,IAAI,CAAC,CAAC;UAClBjB,MAAM,EAAE,IAAI,CAACC,WAAW,CAACF,KAAK,EAAEmB,WAAW;QAAC,EAC/C;MACL;MAEA,MAAMP,KAAwB,+DACvBjB,KAAK;QACRuB,QAAQ;QACRF;MAAS,EACZ;MACD;AACZ;AACA;MACYf,MAAM,CAACoB,IAAI,CAACT,KAAK,CAAC;MAClBJ,aAAa,CAACa,IAAI,CAACT,KAAK,CAACI,SAAS,CAAC;MACnCP,WAAW,CAACY,IAAI,CAACT,KAAK,CAACF,OAAO,CAAC;IACnC;IACA,OAAOT,MAAM;EACjB;EAEQE,cAAc,CAACH,KAAe,EAAQ;IAC1C;AACR;AACA;IACQ,IAAI,IAAI,CAACP,OAAO,CAACU,cAAc,KAAK,KAAK,EAAE;MACvC;IACJ;IACA,KAAK,MAAMS,KAAK,IAAIZ,KAAK,CAACC,MAAM,EAAE;MAC9B,IAAIqB,KAAK,GAAG,CAAC;MACb,KAAK,MAAMC,GAAG,IAAIvB,KAAK,CAACwB,MAAM,EAAE;QAC5B,MAAMC,KAAK,GAAGF,GAAG,CAACG,MAAM,CAACC,IAAI,IAAIA,IAAI,KAAKf,KAAK,CAACgB,EAAE,CAAC,CAACvB,MAAM;QAC1DiB,KAAK,GAAGA,KAAK,GAAGG,KAAK;MACzB;MACA,IAAIH,KAAK,KAAK,CAAC,EAAE;QACb;MACJ,CAAC,MAAM,IAAIA,KAAK,GAAG,CAAC,EAAE;QAClB,MAAM,IAAIhB,cAAW,CAChB,UAASM,KAAK,CAACgB,EAAG,oCAAmC,EACtD,2BAA2B,EAC3B;UACI5B,KAAK;UACLY;QACJ,CAAC,CACJ;MACL;MACA,MAAM,IAAIN,cAAW,CAChB,kBAAiBM,KAAK,CAACgB,EAAG,cAAa,EACxC,yBAAyB,EACzB;QACI5B,KAAK;QACLY;MACJ,CAAC,CACJ;IACL;EACJ;AACJ;AAAC;AAAA,8BAxNYvB,cAAc,UACwB,mBAAmB;AAyN/D,MAAMwC,cAAc,GAAG,CAC1B7B,KAAoB,EACpBP,OAA+B,KACd;EACjB,OAAO,IAAIJ,cAAc,CAACW,KAAK,EAAEP,OAAO,CAAC;AAC7C,CAAC;AAAC"}

package/plugins/StorageOperationsCmsModelPlugin.d.ts

@@ -0,0 +1,23 @@
+import { Plugin } from "@webiny/plugins";
+import { CmsModel, StorageOperationsCmsModel } from "../types";
+export interface StorageOperationsCmsModelPluginCallable {
+    (model: CmsModel): StorageOperationsCmsModel;
+}
+/**
+ * This plugin should be initialized only once and hence the name.
+ */
+export declare class StorageOperationsCmsModelPlugin extends Plugin {
+    static readonly type: string;
+    name: string;
+    private readonly models;
+    private readonly cb;
+    constructor(cb: StorageOperationsCmsModelPluginCallable);
+    getModel(input: CmsModel): StorageOperationsCmsModel;
+    /**
+     * We can cache the converters by having a cache key that is a combination of model ID and savedOn.
+     * The models created via the code will not have savedOn, so they will be unknown - and that is ok as they cannot change in the middle of the call.
+     *
+     * The models created via the CRUD operations might get changed in the middle of the call, so we need to re-create the SO model.
+     */
+    private createCacheKey;
+}

package/plugins/StorageOperationsCmsModelPlugin.js

@@ -0,0 +1,42 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.StorageOperationsCmsModelPlugin = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _plugins = require("@webiny/plugins");
+/**
+ * This plugin should be initialized only once and hence the name.
+ */
+class StorageOperationsCmsModelPlugin extends _plugins.Plugin {
+  constructor(cb) {
+    super();
+    (0, _defineProperty2.default)(this, "name", "cms.storageOperations.model");
+    (0, _defineProperty2.default)(this, "models", {});
+    (0, _defineProperty2.default)(this, "cb", void 0);
+    this.cb = cb;
+  }
+  getModel(input) {
+    const cacheKey = this.createCacheKey(input);
+    if (this.models[cacheKey]) {
+      return this.models[cacheKey];
+    }
+    const model = this.cb(input);
+    this.models[cacheKey] = model;
+    return model;
+  }
+
+  /**
+   * We can cache the converters by having a cache key that is a combination of model ID and savedOn.
+   * The models created via the code will not have savedOn, so they will be unknown - and that is ok as they cannot change in the middle of the call.
+   *
+   * The models created via the CRUD operations might get changed in the middle of the call, so we need to re-create the SO model.
+   */
+  createCacheKey(model) {
+    return [model.tenant, model.locale, model.modelId, model.savedOn || "unknown"].join("#");
+  }
+}
+exports.StorageOperationsCmsModelPlugin = StorageOperationsCmsModelPlugin;
+(0, _defineProperty2.default)(StorageOperationsCmsModelPlugin, "type", "cms.storageOperations.model");

package/plugins/StorageOperationsCmsModelPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["StorageOperationsCmsModelPlugin","Plugin","constructor","cb","getModel","input","cacheKey","createCacheKey","models","model","tenant","locale","modelId","savedOn","join"],"sources":["StorageOperationsCmsModelPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport { CmsModel, StorageOperationsCmsModel } from \"~/types\";\n\nexport interface StorageOperationsCmsModelPluginCallable {\n    (model: CmsModel): StorageOperationsCmsModel;\n}\n\n/**\n * This plugin should be initialized only once and hence the name.\n */\nexport class StorageOperationsCmsModelPlugin extends Plugin {\n    public static override readonly type: string = \"cms.storageOperations.model\";\n    public override name = \"cms.storageOperations.model\";\n\n    private readonly models: Record<string, StorageOperationsCmsModel> = {};\n    private readonly cb: StorageOperationsCmsModelPluginCallable;\n\n    public constructor(cb: StorageOperationsCmsModelPluginCallable) {\n        super();\n        this.cb = cb;\n    }\n\n    public getModel(input: CmsModel) {\n        const cacheKey = this.createCacheKey(input);\n        if (this.models[cacheKey]) {\n            return this.models[cacheKey];\n        }\n        const model = this.cb(input);\n\n        this.models[cacheKey] = model;\n\n        return model;\n    }\n\n    /**\n     * We can cache the converters by having a cache key that is a combination of model ID and savedOn.\n     * The models created via the code will not have savedOn, so they will be unknown - and that is ok as they cannot change in the middle of the call.\n     *\n     * The models created via the CRUD operations might get changed in the middle of the call, so we need to re-create the SO model.\n     */\n    private createCacheKey(model: CmsModel): string {\n        return [model.tenant, model.locale, model.modelId, model.savedOn || \"unknown\"].join(\"#\");\n    }\n}\n"],"mappings":";;;;;;;;AAAA;AAOA;AACA;AACA;AACO,MAAMA,+BAA+B,SAASC,eAAM,CAAC;EAOjDC,WAAW,CAACC,EAA2C,EAAE;IAC5D,KAAK,EAAE;IAAC,4CANW,6BAA6B;IAAA,8CAEiB,CAAC,CAAC;IAAA;IAKnE,IAAI,CAACA,EAAE,GAAGA,EAAE;EAChB;EAEOC,QAAQ,CAACC,KAAe,EAAE;IAC7B,MAAMC,QAAQ,GAAG,IAAI,CAACC,cAAc,CAACF,KAAK,CAAC;IAC3C,IAAI,IAAI,CAACG,MAAM,CAACF,QAAQ,CAAC,EAAE;MACvB,OAAO,IAAI,CAACE,MAAM,CAACF,QAAQ,CAAC;IAChC;IACA,MAAMG,KAAK,GAAG,IAAI,CAACN,EAAE,CAACE,KAAK,CAAC;IAE5B,IAAI,CAACG,MAAM,CAACF,QAAQ,CAAC,GAAGG,KAAK;IAE7B,OAAOA,KAAK;EAChB;;EAEA;AACJ;AACA;AACA;AACA;AACA;EACYF,cAAc,CAACE,KAAe,EAAU;IAC5C,OAAO,CAACA,KAAK,CAACC,MAAM,EAAED,KAAK,CAACE,MAAM,EAAEF,KAAK,CAACG,OAAO,EAAEH,KAAK,CAACI,OAAO,IAAI,SAAS,CAAC,CAACC,IAAI,CAAC,GAAG,CAAC;EAC5F;AACJ;AAAC;AAAA,8BAjCYd,+BAA+B,UACO,6BAA6B"}

package/plugins/index.d.ts

@@ -5,3 +5,4 @@ export * from "./CmsParametersPlugin";
 export * from "./CmsModelFieldConverterPlugin";
 export * from "./CmsGraphQLSchemaPlugin";
 export * from "./CmsGraphQLSchemaSorterPlugin";
+export * from "./StorageOperationsCmsModelPlugin";

package/plugins/index.js

@@ -79,4 +79,15 @@ Object.keys(_CmsGraphQLSchemaSorterPlugin).forEach(function (key) {
       return _CmsGraphQLSchemaSorterPlugin[key];
     }
   });
+});
+var _StorageOperationsCmsModelPlugin = require("./StorageOperationsCmsModelPlugin");
+Object.keys(_StorageOperationsCmsModelPlugin).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _StorageOperationsCmsModelPlugin[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _StorageOperationsCmsModelPlugin[key];
+    }
+  });
 });

package/plugins/index.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export * from \"./CmsGroupPlugin\";\nexport * from \"./CmsModelPlugin\";\nexport * from \"./StorageTransformPlugin\";\nexport * from \"./CmsParametersPlugin\";\nexport * from \"./CmsModelFieldConverterPlugin\";\nexport * from \"./CmsGraphQLSchemaPlugin\";\nexport * from \"./CmsGraphQLSchemaSorterPlugin\";\n"],"mappings":";;;;;AAAA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA"}
+{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export * from \"./CmsGroupPlugin\";\nexport * from \"./CmsModelPlugin\";\nexport * from \"./StorageTransformPlugin\";\nexport * from \"./CmsParametersPlugin\";\nexport * from \"./CmsModelFieldConverterPlugin\";\nexport * from \"./CmsGraphQLSchemaPlugin\";\nexport * from \"./CmsGraphQLSchemaSorterPlugin\";\nexport * from \"./StorageOperationsCmsModelPlugin\";\n"],"mappings":";;;;;AAAA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA"}

package/types.d.ts

@@ -118,6 +118,7 @@ export interface CmsModelFieldSettings {
      */
     [key: string]: any;
 }
+export declare type CmsModelFieldType = "boolean" | "datetime" | "file" | "long-text" | "number" | "object" | "ref" | "rich-text" | "text" | "dynamicZone" | string;
 /**
  * A definition for content model field. This type exists on the app side as well.
  *
@@ -138,18 +139,16 @@ export interface CmsModelField {
      * A type of the field.
      * We are defining our built-in fields, so people know which are available by the default.
      */
-    type: "boolean" | "datetime" | "file" | "long-text" | "number" | "object" | "ref" | "rich-text" | "text" | "dynamicZone" | string;
+    type: CmsModelFieldType;
     /**
      * A unique storage ID for storing actual values.
-     * Must in form of a-zA-Z0-9@a-zA-Z0-9@a-zA-Z0-9.
+     * Must in form of a-zA-Z0-9@a-zA-Z0-9
      *
      * This is an auto-generated value: uses `id` and `type`
      *
      * This is used as path for the entry value.
-     *
-     * @internal
      */
-    storageId: string;
+    storageId: `${string}@${string}` | string;
     /**
      * Field identifier for the model field that will be available to the outside world.
      * `storageId` is used as path (or column) to store the data.
@@ -515,6 +514,7 @@ interface CmsModelFieldToGraphQLCreateResolverParams<TField> {
     graphQLType: string;
     field: TField;
     createFieldResolvers: any;
+    fieldTypePlugins: CmsFieldTypePlugins;
 }
 export interface CmsModelFieldToGraphQLCreateResolver<TField = CmsModelField> {
     (params: CmsModelFieldToGraphQLCreateResolverParams<TField>): GraphQLFieldResolver | {
@@ -894,7 +894,7 @@ export interface CmsSettingsContext {
     /**
      * Get the datetime when content model last changed.
      */
-    getModelLastChange: () => Promise<Date>;
+    getModelLastChange: () => Promise<Date | null>;
 }
 export interface OnSystemBeforeInstallTopicParams {
     tenant: string;
@@ -1311,7 +1311,7 @@ export interface CmsModelFieldInput {
     /**
      * @see CmsModelField.listValidation
      */
-    listValidation: CmsModelFieldValidation[];
+    listValidation?: CmsModelFieldValidation[];
     /**
      * User defined settings.
      */
@@ -1882,12 +1882,12 @@ export interface CmsEntryMeta {
 export interface OnEntryBeforeCreateTopicParams {
     input: CreateCmsEntryInput;
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryAfterCreateTopicParams {
     input: CreateCmsEntryInput;
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
     storageEntry: CmsEntry;
 }
 export interface OnEntryCreateErrorTopicParams {
@@ -1903,13 +1903,13 @@ export interface OnEntryRevisionBeforeCreateTopicParams {
     input: CreateFromCmsEntryInput;
     entry: CmsEntry;
     original: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryRevisionAfterCreateTopicParams {
     input: CreateFromCmsEntryInput;
     entry: CmsEntry;
     original: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
     storageEntry: CmsEntry;
 }
 export interface OnEntryCreateRevisionErrorTopicParams {
@@ -1926,13 +1926,13 @@ export interface OnEntryBeforeUpdateTopicParams {
     input: UpdateCmsEntryInput;
     original: CmsEntry;
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryAfterUpdateTopicParams {
     input: UpdateCmsEntryInput;
     original: CmsEntry;
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
     storageEntry: CmsEntry;
 }
 export interface OnEntryUpdateErrorTopicParams {
@@ -1946,45 +1946,45 @@ export interface OnEntryUpdateErrorTopicParams {
  */
 export interface OnEntryBeforePublishTopicParams {
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryAfterPublishTopicParams {
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
     storageEntry: CmsEntry;
 }
 export interface OnEntryPublishErrorTopicParams {
     error: Error;
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 /**
  * Republish
  */
 export interface OnEntryBeforeRepublishTopicParams {
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryAfterRepublishTopicParams {
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
     storageEntry: CmsEntry;
 }
 export interface OnEntryRepublishErrorTopicParams {
     error: Error;
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 /**
  * Unpublish
  */
 export interface OnEntryBeforeUnpublishTopicParams {
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryAfterUnpublishTopicParams {
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
     storageEntry: CmsEntry;
 }
 export interface OnEntryUnpublishErrorTopicParams {
@@ -1994,37 +1994,37 @@ export interface OnEntryUnpublishErrorTopicParams {
 }
 export interface OnEntryBeforeDeleteTopicParams {
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryAfterDeleteTopicParams {
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryDeleteErrorTopicParams {
     error: Error;
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryRevisionBeforeDeleteTopicParams {
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryRevisionAfterDeleteTopicParams {
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryRevisionDeleteErrorTopicParams {
     error: Error;
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryBeforeGetTopicParams {
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
     where: CmsEntryListWhere;
 }
 export interface EntryBeforeListTopicParams {
     where: CmsEntryListWhere;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 /**
  * @category Context
@@ -2048,6 +2048,14 @@ export interface CreateFromCmsEntryInput {
 export interface UpdateCmsEntryInput {
     [key: string]: any;
 }
+/**
+ * @category Context
+ * @category CmsEntry
+ */
+export interface GetUniqueFieldValuesParams {
+    where: CmsEntryListWhere;
+    fieldId: string;
+}
 /**
  * Cms Entry CRUD methods in the context.
  *
@@ -2125,7 +2133,13 @@ export interface CmsEntryContext {
      */
     getEntryRevisions: (model: CmsModel, id: string) => Promise<CmsEntry[]>;
     /**
-     * Lifecyle events - deprecated.
+     * List all unique values for a given field.
+     *
+     * @internal
+     */
+    getUniqueFieldValues: (model: CmsModel, params: GetUniqueFieldValuesParams) => Promise<string[]>;
+    /**
+     * Lifecycle events - deprecated.
      */
     /**
      * @deprecated
@@ -2497,6 +2511,10 @@ export interface CmsEntryStorageOperationsUnpublishParams<T extends CmsStorageEn
      */
     storageEntry: T;
 }
+export interface CmsEntryStorageOperationsGetUniqueFieldValuesParams {
+    where: CmsEntryListWhere;
+    fieldId: string;
+}
 export interface CmsEntryStorageOperationsGetByIdsParams {
     ids: readonly string[];
 }
@@ -2553,71 +2571,77 @@ export interface CmsEntryStorageOperations<T extends CmsStorageEntry = CmsStorag
     /**
      * Get all the entries of the ids.
      */
-    getByIds: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsGetByIdsParams) => Promise<T[]>;
+    getByIds: (model: CmsModel, params: CmsEntryStorageOperationsGetByIdsParams) => Promise<T[]>;
     /**
      * Get all the published entries of the ids.
      */
-    getPublishedByIds: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsGetPublishedByIdsParams) => Promise<T[]>;
+    getPublishedByIds: (model: CmsModel, params: CmsEntryStorageOperationsGetPublishedByIdsParams) => Promise<T[]>;
     /**
      * Get all the latest entries of the ids.
      */
-    getLatestByIds: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsGetLatestByIdsParams) => Promise<T[]>;
+    getLatestByIds: (model: CmsModel, params: CmsEntryStorageOperationsGetLatestByIdsParams) => Promise<T[]>;
     /**
      * Get all revisions of the given entry id.
      */
-    getRevisions: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsGetRevisionsParams) => Promise<T[]>;
+    getRevisions: (model: CmsModel, params: CmsEntryStorageOperationsGetRevisionsParams) => Promise<T[]>;
     /**
      * Get the entry by the given revision id.
      */
-    getRevisionById: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsGetRevisionParams) => Promise<T | null>;
+    getRevisionById: (model: CmsModel, params: CmsEntryStorageOperationsGetRevisionParams) => Promise<T | null>;
     /**
      * Get the published entry by given entryId.
      */
-    getPublishedRevisionByEntryId: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsGetPublishedRevisionParams) => Promise<T | null>;
+    getPublishedRevisionByEntryId: (model: CmsModel, params: CmsEntryStorageOperationsGetPublishedRevisionParams) => Promise<T | null>;
     /**
      * Get the latest entry by given entryId.
      */
-    getLatestRevisionByEntryId: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsGetLatestRevisionParams) => Promise<T | null>;
+    getLatestRevisionByEntryId: (model: CmsModel, params: CmsEntryStorageOperationsGetLatestRevisionParams) => Promise<T | null>;
     /**
      * Get the revision of the entry before given one.
      */
-    getPreviousRevision: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsGetPreviousRevisionParams) => Promise<T | null>;
+    getPreviousRevision: (model: CmsModel, params: CmsEntryStorageOperationsGetPreviousRevisionParams) => Promise<T | null>;
     /**
      * Gets entry by given params.
      */
-    get: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsGetParams) => Promise<T | null>;
+    get: (model: CmsModel, params: CmsEntryStorageOperationsGetParams) => Promise<T | null>;
     /**
      * List all entries. Filterable via params.
      */
-    list: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsListParams) => Promise<CmsEntryStorageOperationsListResponse<T>>;
+    list: (model: CmsModel, params: CmsEntryStorageOperationsListParams) => Promise<CmsEntryStorageOperationsListResponse<T>>;
     /**
      * Create a new entry.
      */
-    create: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsCreateParams<T>) => Promise<T>;
+    create: (model: CmsModel, params: CmsEntryStorageOperationsCreateParams<T>) => Promise<T>;
     /**
      * Create a new entry from existing one.
      */
-    createRevisionFrom: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsCreateRevisionFromParams<T>) => Promise<T>;
+    createRevisionFrom: (model: CmsModel, params: CmsEntryStorageOperationsCreateRevisionFromParams<T>) => Promise<T>;
     /**
      * Update existing entry.
      */
-    update: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsUpdateParams<T>) => Promise<T>;
+    update: (model: CmsModel, params: CmsEntryStorageOperationsUpdateParams<T>) => Promise<T>;
     /**
      * Delete the entry revision.
      */
-    deleteRevision: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsDeleteRevisionParams<T>) => Promise<void>;
+    deleteRevision: (model: CmsModel, params: CmsEntryStorageOperationsDeleteRevisionParams<T>) => Promise<void>;
     /**
      * Delete the entry.
      */
-    delete: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsDeleteParams) => Promise<void>;
+    delete: (model: CmsModel, params: CmsEntryStorageOperationsDeleteParams) => Promise<void>;
     /**
      * Publish the entry.
      */
-    publish: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsPublishParams<T>) => Promise<T>;
+    publish: (model: CmsModel, params: CmsEntryStorageOperationsPublishParams<T>) => Promise<T>;
     /**
      * Unpublish the entry.
      */
-    unpublish: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsUnpublishParams<T>) => Promise<T>;
+    unpublish: (model: CmsModel, params: CmsEntryStorageOperationsUnpublishParams<T>) => Promise<T>;
+    /**
+     * Method to list all the unique values for the given field id.
+     * Simplest use case would be to aggregate tags for some content.
+     * @internal
+     */
+    getUniqueFieldValues: (model: CmsModel, params: CmsEntryStorageOperationsGetUniqueFieldValuesParams) => Promise<string[]>;
 }
 export declare enum CONTENT_ENTRY_STATUS {
     DRAFT = "draft",
@@ -2689,7 +2713,7 @@ export interface HeadlessCmsStorageOperations<C = CmsContext> {
     /**
      * Either attach something from the storage operations or run something in it.
      */
-    beforeInit?: (context: C) => Promise<void>;
+    beforeInit: (context: C) => Promise<void>;
     init?: (context: C) => Promise<void>;
 }
 export {};

package/types.js

@@ -334,6 +334,10 @@ exports.CONTENT_ENTRY_STATUS = void 0;
  * @category Context
  * @category CmsEntry
  */
+/**
+ * @category Context
+ * @category CmsEntry
+ */
 /**
  * Cms Entry CRUD methods in the context.
  *