@webiny/api-headless-cms 0.0.0-unstable.b14eaecf38 → 0.0.0-unstable.b6d7105cee

package/plugins/CmsModelPlugin.js.map

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

package/plugins/CmsParametersPlugin.d.ts

@@ -1,13 +1,11 @@
 import { Plugin } from "@webiny/plugins";
-import { ApiEndpoint, CmsContext } from "../types";
+import type { ApiEndpoint, CmsContext } from "../types/index.js";
 /**
  * Type can be null because it might be that Headless CMS context is loaded on a different Lambda where there is no GraphQL Schema generated.
  */
-export declare type CmsParametersPluginResponseType = ApiEndpoint | null;
-export declare type CmsParametersPluginResponseLocale = string;
+export type CmsParametersPluginResponseType = ApiEndpoint | null;
 export interface CmsParametersPluginResponse {
     type: CmsParametersPluginResponseType;
-    locale: CmsParametersPluginResponseLocale;
 }
 export interface CmsParametersPluginCallable {
     (context: CmsContext): Promise<CmsParametersPluginResponse | null>;

package/plugins/CmsParametersPlugin.js

@@ -1,21 +1,16 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.CmsParametersPlugin = void 0;
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-var _plugins = require("@webiny/plugins");
-class CmsParametersPlugin extends _plugins.Plugin {
-  constructor(callable) {
-    super();
-    (0, _defineProperty2.default)(this, "callable", void 0);
-    this.callable = callable;
-  }
-  async getParameters(context) {
-    return this.callable(context);
-  }
+import { Plugin } from "@webiny/plugins";
+class CmsParametersPlugin extends Plugin {
+    static{
+        this.type = "cms-parameters-plugin";
+    }
+    constructor(callable){
+        super();
+        this.callable = callable;
+    }
+    async getParameters(context) {
+        return this.callable(context);
+    }
 }
-exports.CmsParametersPlugin = CmsParametersPlugin;
-(0, _defineProperty2.default)(CmsParametersPlugin, "type", "cms-parameters-plugin");
+export { CmsParametersPlugin };
+
+//# sourceMappingURL=CmsParametersPlugin.js.map

package/plugins/CmsParametersPlugin.js.map

@@ -1 +1 @@
-{"version":3,"names":["CmsParametersPlugin","Plugin","constructor","callable","getParameters","context"],"sources":["CmsParametersPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport { ApiEndpoint, CmsContext } from \"~/types\";\n\n/**\n * Type can be null because it might be that Headless CMS context is loaded on a different Lambda where there is no GraphQL Schema generated.\n */\nexport type CmsParametersPluginResponseType = ApiEndpoint | null;\nexport type CmsParametersPluginResponseLocale = string;\n\nexport interface CmsParametersPluginResponse {\n    type: CmsParametersPluginResponseType;\n    locale: CmsParametersPluginResponseLocale;\n}\n\nexport interface CmsParametersPluginCallable {\n    (context: CmsContext): Promise<CmsParametersPluginResponse | null>;\n}\n\nexport class CmsParametersPlugin extends Plugin {\n    public static override readonly type: string = \"cms-parameters-plugin\";\n\n    private readonly callable: CmsParametersPluginCallable;\n\n    public constructor(callable: CmsParametersPluginCallable) {\n        super();\n\n        this.callable = callable;\n    }\n\n    public async getParameters(context: CmsContext): Promise<CmsParametersPluginResponse | null> {\n        return this.callable(context);\n    }\n}\n"],"mappings":";;;;;;;;AAAA;AAkBO,MAAMA,mBAAmB,SAASC,eAAM,CAAC;EAKrCC,WAAW,CAACC,QAAqC,EAAE;IACtD,KAAK,EAAE;IAAC;IAER,IAAI,CAACA,QAAQ,GAAGA,QAAQ;EAC5B;EAEA,MAAaC,aAAa,CAACC,OAAmB,EAA+C;IACzF,OAAO,IAAI,CAACF,QAAQ,CAACE,OAAO,CAAC;EACjC;AACJ;AAAC;AAAA,8BAdYL,mBAAmB,UACmB,uBAAuB"}
+{"version":3,"file":"plugins/CmsParametersPlugin.js","sources":["../../src/plugins/CmsParametersPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport type { ApiEndpoint, CmsContext } from \"~/types/index.js\";\n\n/**\n * Type can be null because it might be that Headless CMS context is loaded on a different Lambda where there is no GraphQL Schema generated.\n */\nexport type CmsParametersPluginResponseType = ApiEndpoint | null;\n\nexport interface CmsParametersPluginResponse {\n    type: CmsParametersPluginResponseType;\n}\n\nexport interface CmsParametersPluginCallable {\n    (context: CmsContext): Promise<CmsParametersPluginResponse | null>;\n}\n\nexport class CmsParametersPlugin extends Plugin {\n    public static override readonly type: string = \"cms-parameters-plugin\";\n\n    private readonly callable: CmsParametersPluginCallable;\n\n    public constructor(callable: CmsParametersPluginCallable) {\n        super();\n\n        this.callable = callable;\n    }\n\n    public async getParameters(context: CmsContext): Promise<CmsParametersPluginResponse | null> {\n        return this.callable(context);\n    }\n}\n"],"names":["CmsParametersPlugin","Plugin","callable","context"],"mappings":";AAgBO,MAAMA,4BAA4BC;;aACL,IAAI,GAAW;;IAI/C,YAAmBC,QAAqC,CAAE;QACtD,KAAK;QAEL,IAAI,CAAC,QAAQ,GAAGA;IACpB;IAEA,MAAa,cAAcC,OAAmB,EAA+C;QACzF,OAAO,IAAI,CAAC,QAAQ,CAACA;IACzB;AACJ"}

package/plugins/StorageOperationsCmsModelPlugin.d.ts

@@ -1,5 +1,5 @@
 import { Plugin } from "@webiny/plugins";
-import { CmsModel, StorageOperationsCmsModel } from "../types";
+import type { CmsEntryValues, CmsModel, StorageOperationsCmsModel } from "../types/index.js";
 export interface StorageOperationsCmsModelPluginCallable {
     (model: CmsModel): StorageOperationsCmsModel;
 }
@@ -12,7 +12,7 @@ export declare class StorageOperationsCmsModelPlugin extends Plugin {
     private readonly models;
     private readonly cb;
     constructor(cb: StorageOperationsCmsModelPluginCallable);
-    getModel(input: CmsModel): StorageOperationsCmsModel;
+    getModel<T extends CmsEntryValues>(input: CmsModel): StorageOperationsCmsModel<T>;
     /**
      * 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.

package/plugins/StorageOperationsCmsModelPlugin.js

@@ -1,42 +1,27 @@
-"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];
+import { Plugin } from "@webiny/plugins";
+class StorageOperationsCmsModelPlugin extends Plugin {
+    static{
+        this.type = "cms.storageOperations.model";
+    }
+    constructor(cb){
+        super(), this.name = "cms.storageOperations.model", this.models = {};
+        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;
+    }
+    createCacheKey(model) {
+        return [
+            model.tenant,
+            model.modelId,
+            model.savedOn || "unknown"
+        ].join("#");
     }
-    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");
+export { StorageOperationsCmsModelPlugin };
+
+//# sourceMappingURL=StorageOperationsCmsModelPlugin.js.map

package/plugins/StorageOperationsCmsModelPlugin.js.map

@@ -1 +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"}
+{"version":3,"file":"plugins/StorageOperationsCmsModelPlugin.js","sources":["../../src/plugins/StorageOperationsCmsModelPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport type { CmsEntryValues, CmsModel, StorageOperationsCmsModel } from \"~/types/index.js\";\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<T extends CmsEntryValues>(input: CmsModel) {\n        const cacheKey = this.createCacheKey(input);\n        if (this.models[cacheKey]) {\n            return this.models[cacheKey] as unknown as StorageOperationsCmsModel<T>;\n        }\n        const model = this.cb(input);\n\n        this.models[cacheKey] = model;\n\n        return model as unknown as StorageOperationsCmsModel<T>;\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.modelId, model.savedOn || \"unknown\"].join(\"#\");\n    }\n}\n"],"names":["StorageOperationsCmsModelPlugin","Plugin","cb","input","cacheKey","model"],"mappings":";AAUO,MAAMA,wCAAwCC;;aACjB,IAAI,GAAW;;IAM/C,YAAmBC,EAA2C,CAAE;QAC5D,KAAK,SANO,IAAI,GAAG,oCAEN,MAAM,GAA8C,CAAC;QAKlE,IAAI,CAAC,EAAE,GAAGA;IACd;IAEO,SAAmCC,KAAe,EAAE;QACvD,MAAMC,WAAW,IAAI,CAAC,cAAc,CAACD;QACrC,IAAI,IAAI,CAAC,MAAM,CAACC,SAAS,EACrB,OAAO,IAAI,CAAC,MAAM,CAACA,SAAS;QAEhC,MAAMC,QAAQ,IAAI,CAAC,EAAE,CAACF;QAEtB,IAAI,CAAC,MAAM,CAACC,SAAS,GAAGC;QAExB,OAAOA;IACX;IAQQ,eAAeA,KAAe,EAAU;QAC5C,OAAO;YAACA,MAAM,MAAM;YAAEA,MAAM,OAAO;YAAEA,MAAM,OAAO,IAAI;SAAU,CAAC,IAAI,CAAC;IAC1E;AACJ"}

package/plugins/index.d.ts

@@ -1,8 +1,6 @@
-export * from "./CmsGroupPlugin";
-export * from "./CmsModelPlugin";
-export * from "./StorageTransformPlugin";
-export * from "./CmsParametersPlugin";
-export * from "./CmsModelFieldConverterPlugin";
-export * from "./CmsGraphQLSchemaPlugin";
-export * from "./CmsGraphQLSchemaSorterPlugin";
-export * from "./StorageOperationsCmsModelPlugin";
+export * from "./CmsGroupPlugin.js";
+export * from "./CmsModelPlugin.js";
+export * from "./CmsParametersPlugin.js";
+export * from "./CmsModelFieldConverterPlugin.js";
+export * from "./CmsGraphQLSchemaPlugin/index.js";
+export * from "./StorageOperationsCmsModelPlugin.js";

package/plugins/index.js

@@ -1,93 +1,6 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var _CmsGroupPlugin = require("./CmsGroupPlugin");
-Object.keys(_CmsGroupPlugin).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _CmsGroupPlugin[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _CmsGroupPlugin[key];
-    }
-  });
-});
-var _CmsModelPlugin = require("./CmsModelPlugin");
-Object.keys(_CmsModelPlugin).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _CmsModelPlugin[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _CmsModelPlugin[key];
-    }
-  });
-});
-var _StorageTransformPlugin = require("./StorageTransformPlugin");
-Object.keys(_StorageTransformPlugin).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _StorageTransformPlugin[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _StorageTransformPlugin[key];
-    }
-  });
-});
-var _CmsParametersPlugin = require("./CmsParametersPlugin");
-Object.keys(_CmsParametersPlugin).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _CmsParametersPlugin[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _CmsParametersPlugin[key];
-    }
-  });
-});
-var _CmsModelFieldConverterPlugin = require("./CmsModelFieldConverterPlugin");
-Object.keys(_CmsModelFieldConverterPlugin).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _CmsModelFieldConverterPlugin[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _CmsModelFieldConverterPlugin[key];
-    }
-  });
-});
-var _CmsGraphQLSchemaPlugin = require("./CmsGraphQLSchemaPlugin");
-Object.keys(_CmsGraphQLSchemaPlugin).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _CmsGraphQLSchemaPlugin[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _CmsGraphQLSchemaPlugin[key];
-    }
-  });
-});
-var _CmsGraphQLSchemaSorterPlugin = require("./CmsGraphQLSchemaSorterPlugin");
-Object.keys(_CmsGraphQLSchemaSorterPlugin).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _CmsGraphQLSchemaSorterPlugin[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      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];
-    }
-  });
-});
+export * from "./CmsGroupPlugin.js";
+export * from "./CmsModelPlugin.js";
+export * from "./CmsParametersPlugin.js";
+export * from "./CmsModelFieldConverterPlugin.js";
+export * from "./CmsGraphQLSchemaPlugin/index.js";
+export * from "./StorageOperationsCmsModelPlugin.js";

package/types/context.d.ts

@@ -0,0 +1,110 @@
+import type { CmsDeleteEntryOptions, CmsEntry, CmsEntryGetParams, CmsEntryListParams, CmsEntryMeta, CmsEntryUniqueValue, CmsEntryValidateResponse, CmsEntryValues, CreateCmsEntryInput, CreateCmsEntryOptionsInput, CreateFromCmsEntryInput, CreateRevisionCmsEntryOptionsInput, DeleteMultipleEntriesParams, DeleteMultipleEntriesResponse, GetUniqueFieldValuesParams, UpdateCmsEntryInput, UpdateCmsEntryOptionsInput } from "./types.js";
+import type { CmsModel } from "./model.js";
+/**
+ * Cms Entry CRUD methods in the context.
+ *
+ * @category Context
+ * @category CmsEntry
+ */
+export interface CmsEntryContext {
+    /**
+     * Get a single content entry for a model.
+     */
+    getEntry: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params: CmsEntryGetParams) => Promise<CmsEntry<T>>;
+    /**
+     * Get a list of entries for a model by a given ID (revision).
+     */
+    getEntriesByIds: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, revisions: string[]) => Promise<CmsEntry<T>[]>;
+    /**
+     * Get the entry for a model by a given ID.
+     */
+    getEntryById<T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, revision: string): Promise<CmsEntry<T>>;
+    /**
+     * List entries for a model. Internal method used by get, listLatest and listPublished.
+     */
+    listEntries: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params: CmsEntryListParams) => Promise<[CmsEntry<T>[], CmsEntryMeta]>;
+    /**
+     * Lists the latest entries. Used for manage API.
+     */
+    listLatestEntries: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params?: CmsEntryListParams) => Promise<[CmsEntry<T>[], CmsEntryMeta]>;
+    /**
+     * List published entries. Used for read API.
+     */
+    listPublishedEntries: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params?: CmsEntryListParams) => Promise<[CmsEntry<T>[], CmsEntryMeta]>;
+    /**
+     * Lists the deleted entries. Used for manage API.
+     */
+    listDeletedEntries: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params?: CmsEntryListParams) => Promise<[CmsEntry<T>[], CmsEntryMeta]>;
+    /**
+     * List published entries by IDs.
+     */
+    getPublishedEntriesByIds: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, ids: string[]) => Promise<CmsEntry<T>[]>;
+    /**
+     * List latest entries by IDs.
+     */
+    getLatestEntriesByIds: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, ids: string[]) => Promise<CmsEntry<T>[]>;
+    /**
+     * Create a new content entry.
+     */
+    createEntry: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, input: CreateCmsEntryInput<T>, options?: CreateCmsEntryOptionsInput) => Promise<CmsEntry<T>>;
+    /**
+     * Create a new entry from already existing entry.
+     */
+    createEntryRevisionFrom: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, id: string, input: CreateFromCmsEntryInput<T>, options?: CreateRevisionCmsEntryOptionsInput) => Promise<CmsEntry<T>>;
+    /**
+     * Update existing entry.
+     */
+    updateEntry: <TInput extends CmsEntryValues = CmsEntryValues>(model: CmsModel, id: string, input: UpdateCmsEntryInput<TInput>, options?: UpdateCmsEntryOptionsInput) => Promise<CmsEntry<TInput>>;
+    /**
+     * Update entry revision description.
+     * It does not matter if the entry is published/unpublished or any other state.
+     */
+    updateRevisionDescription: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, id: string, revisionDescription: string | undefined) => Promise<CmsEntry<T>>;
+    /**
+     * Validate the entry - either new one or existing one.
+     */
+    validateEntry: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, id: string, input: UpdateCmsEntryInput<T>) => Promise<CmsEntryValidateResponse>;
+    /**
+     * Move entry, and all its revisions, to a new folder.
+     */
+    moveEntry: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, id: string, folderId: string) => Promise<CmsEntry<T>>;
+    /**
+     * Method that republishes entry with given identifier.
+     * @internal
+     */
+    republishEntry: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, id: string) => Promise<CmsEntry<T>>;
+    /**
+     * Delete only a certain revision of the entry.
+     */
+    deleteEntryRevision: (model: CmsModel, id: string) => Promise<void>;
+    /**
+     * Delete entry with all its revisions.
+     */
+    deleteEntry: (model: CmsModel, id: string, options?: CmsDeleteEntryOptions) => Promise<void>;
+    /**
+     * Restore entry from trash bin with all its revisions.
+     */
+    restoreEntryFromBin: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, id: string) => Promise<CmsEntry<T>>;
+    /**
+     * Delete multiple entries
+     */
+    deleteMultipleEntries: (model: CmsModel, params: DeleteMultipleEntriesParams) => Promise<DeleteMultipleEntriesResponse>;
+    /**
+     * Publish entry.
+     */
+    publishEntry: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, id: string) => Promise<CmsEntry<T>>;
+    /**
+     * Unpublish entry.
+     */
+    unpublishEntry: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, id: string) => Promise<CmsEntry<T>>;
+    /**
+     * Get all entry revisions.
+     */
+    getEntryRevisions: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, id: string) => Promise<CmsEntry<T>[]>;
+    /**
+     * List all unique values for a given field.
+     *
+     * @internal
+     */
+    getUniqueFieldValues: (model: CmsModel, params: GetUniqueFieldValuesParams) => Promise<CmsEntryUniqueValue[]>;
+}

package/types/fields/dynamicZoneField.d.ts

@@ -0,0 +1,25 @@
+import type { CmsModelField, CmsModelFieldValidation } from "../modelField.js";
+import type { CmsIcon, CmsModelLayoutCell } from "../../types/index.js";
+export interface CmsDynamicZoneTemplate {
+    id: string;
+    name: string;
+    gqlTypeName: string;
+    description: string;
+    icon?: CmsIcon;
+    fields: CmsModelField[];
+    layout: CmsModelLayoutCell[][];
+    validation: CmsModelFieldValidation[];
+    tags?: string[];
+    componentName?: string;
+}
+/**
+ * A definition for dynamic-zone field to show possible type of the field in settings.
+ */
+export interface CmsModelDynamicZoneField extends CmsModelField {
+    /**
+     * Settings object for the field. Contains `templates` property.
+     */
+    settings: {
+        templates: CmsDynamicZoneTemplate[];
+    };
+}

package/types/fields/objectField.d.ts

@@ -0,0 +1,15 @@
+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.
+ */
+export interface CmsModelObjectField extends CmsModelField {
+    /**
+     * Settings object for the field. Contains `templates` property.
+     */
+    settings: {
+        fields: CmsModelField[];
+        layout?: CmsModelLayout;
+        parents?: string[];
+    };
+}

package/types/identity.d.ts

@@ -0,0 +1,19 @@
+/**
+ * An interface describing the reference to a user that created some data in the database.
+ *
+ * @category General
+ */
+export interface CmsIdentity {
+    /**
+     * ID if the user.
+     */
+    id: string;
+    /**
+     * Full name of the user.
+     */
+    displayName: string;
+    /**
+     * Type of the user (admin, user)
+     */
+    type: string;
+}

package/types/index.d.ts

@@ -0,0 +1,10 @@
+export * from "./types.js";
+export type * from "./modelAst.js";
+export type * from "./context.js";
+export type * from "./identity.js";
+export type * from "./model.js";
+export type * from "./modelField.js";
+export type * from "./modelGroup.js";
+export type * from "./plugins.js";
+export type * from "./fields/dynamicZoneField.js";
+export type * from "./fields/objectField.js";

package/types/index.js

@@ -0,0 +1 @@
+export * from "./types.js";