@webiny/api-headless-cms 0.0.0-ee-vpcs.549378cf03

package/parameters/index.js

@@ -0,0 +1,57 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _manual = require("./manual");
+
+Object.keys(_manual).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _manual[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _manual[key];
+    }
+  });
+});
+
+var _path = require("./path");
+
+Object.keys(_path).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _path[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _path[key];
+    }
+  });
+});
+
+var _context = require("./context");
+
+Object.keys(_context).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _context[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _context[key];
+    }
+  });
+});
+
+var _header = require("./header");
+
+Object.keys(_header).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _header[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _header[key];
+    }
+  });
+});

package/parameters/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export * from \"./manual\";\nexport * from \"./path\";\nexport * from \"./context\";\nexport * from \"./header\";\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"}

package/parameters/manual.d.ts

@@ -0,0 +1,6 @@
+import { CmsParametersPlugin, CmsParametersPluginResponseLocale, CmsParametersPluginResponseType } from "../plugins/CmsParametersPlugin";
+export interface ManualPluginParams {
+    endpointType?: CmsParametersPluginResponseType;
+    locale?: CmsParametersPluginResponseLocale;
+}
+export declare const createManualPlugin: (params: ManualPluginParams) => CmsParametersPlugin;

package/parameters/manual.js

@@ -0,0 +1,44 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createManualPlugin = void 0;
+
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+var _CmsParametersPlugin = require("../plugins/CmsParametersPlugin");
+
+/**
+ * This would be used for custom Lambdas when there is no path or header information about the endpoint type and locale.
+ */
+const createManualPlugin = params => {
+  return new _CmsParametersPlugin.CmsParametersPlugin(async () => {
+    const {
+      endpointType: type,
+      locale
+    } = params;
+    /**
+     * if both of parameters are not existing, just skip this plugin.
+     */
+
+    if (!type && !locale) {
+      return null;
+    } else if (!type) {
+      throw new _error.default(`There is defined "locale" CMS parameter but no "endpointType".`, "MALFORMED_ENDPOINT_TYPE", (0, _objectSpread2.default)({}, params));
+    } else if (!locale) {
+      throw new _error.default(`There is defined "endpointType" CMS parameter but no "locale".`, "MALFORMED_LOCALE_TYPE", (0, _objectSpread2.default)({}, params));
+    }
+
+    return {
+      type,
+      locale
+    };
+  });
+};
+
+exports.createManualPlugin = createManualPlugin;

package/parameters/manual.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["createManualPlugin","params","CmsParametersPlugin","endpointType","type","locale","WebinyError"],"sources":["manual.ts"],"sourcesContent":["/**\n * This would be used for custom Lambdas when there is no path or header information about the endpoint type and locale.\n */\nimport WebinyError from \"@webiny/error\";\nimport {\n    CmsParametersPlugin,\n    CmsParametersPluginResponseLocale,\n    CmsParametersPluginResponseType\n} from \"~/plugins/CmsParametersPlugin\";\n\nexport interface ManualPluginParams {\n    endpointType?: CmsParametersPluginResponseType;\n    locale?: CmsParametersPluginResponseLocale;\n}\n\nexport const createManualPlugin = (params: ManualPluginParams): CmsParametersPlugin => {\n    return new CmsParametersPlugin(async () => {\n        const { endpointType: type, locale } = params;\n        /**\n         * if both of parameters are not existing, just skip this plugin.\n         */\n        if (!type && !locale) {\n            return null;\n        } else if (!type) {\n            throw new WebinyError(\n                `There is defined \"locale\" CMS parameter but no \"endpointType\".`,\n                \"MALFORMED_ENDPOINT_TYPE\",\n                {\n                    ...params\n                }\n            );\n        } else if (!locale) {\n            throw new WebinyError(\n                `There is defined \"endpointType\" CMS parameter but no \"locale\".`,\n                \"MALFORMED_LOCALE_TYPE\",\n                {\n                    ...params\n                }\n            );\n        }\n\n        return {\n            type,\n            locale\n        };\n    });\n};\n"],"mappings":";;;;;;;;;;;AAGA;;AACA;;AAJA;AACA;AACA;AAaO,MAAMA,kBAAkB,GAAIC,MAAD,IAAqD;EACnF,OAAO,IAAIC,wCAAJ,CAAwB,YAAY;IACvC,MAAM;MAAEC,YAAY,EAAEC,IAAhB;MAAsBC;IAAtB,IAAiCJ,MAAvC;IACA;AACR;AACA;;IACQ,IAAI,CAACG,IAAD,IAAS,CAACC,MAAd,EAAsB;MAClB,OAAO,IAAP;IACH,CAFD,MAEO,IAAI,CAACD,IAAL,EAAW;MACd,MAAM,IAAIE,cAAJ,CACD,gEADC,EAEF,yBAFE,kCAIKL,MAJL,EAAN;IAOH,CARM,MAQA,IAAI,CAACI,MAAL,EAAa;MAChB,MAAM,IAAIC,cAAJ,CACD,gEADC,EAEF,uBAFE,kCAIKL,MAJL,EAAN;IAOH;;IAED,OAAO;MACHG,IADG;MAEHC;IAFG,CAAP;EAIH,CA7BM,CAAP;AA8BH,CA/BM"}

package/parameters/path.d.ts

@@ -0,0 +1,2 @@
+import { CmsParametersPlugin } from "../plugins/CmsParametersPlugin";
+export declare const createPathParameterPlugin: () => CmsParametersPlugin;

package/parameters/path.js

@@ -0,0 +1,51 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createPathParameterPlugin = void 0;
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+var _CmsParametersPlugin = require("../plugins/CmsParametersPlugin");
+
+const allowedEndpoints = ["manage", "read", "preview"];
+
+const createPathParameterPlugin = () => {
+  return new _CmsParametersPlugin.CmsParametersPlugin(async context => {
+    var _context$request;
+
+    /**
+     * If any of the properties is not defined, just ignore this plugin
+     */
+    if (!((_context$request = context.request) !== null && _context$request !== void 0 && _context$request.params)) {
+      return null;
+    }
+
+    const {
+      type,
+      locale
+    } = context.request.params;
+
+    if (!type && !locale) {
+      return null;
+    }
+
+    if (!type) {
+      throw new _error.default(`Missing request parameter "type".`);
+    } else if (!locale) {
+      throw new _error.default(`Missing request parameter "locale".`);
+    } else if (allowedEndpoints.includes(type) === false) {
+      throw new _error.default(`Endpoint "${type}" not allowed!`);
+    }
+
+    return {
+      type: type,
+      locale
+    };
+  });
+};
+
+exports.createPathParameterPlugin = createPathParameterPlugin;

package/parameters/path.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["allowedEndpoints","createPathParameterPlugin","CmsParametersPlugin","context","request","params","type","locale","WebinyError","includes"],"sources":["path.ts"],"sourcesContent":["import WebinyError from \"@webiny/error\";\nimport { CmsParametersPlugin } from \"~/plugins/CmsParametersPlugin\";\nimport { ApiEndpoint } from \"~/types\";\n\nconst allowedEndpoints: ApiEndpoint[] = [\"manage\", \"read\", \"preview\"];\n\nexport const createPathParameterPlugin = () => {\n    return new CmsParametersPlugin(async context => {\n        /**\n         * If any of the properties is not defined, just ignore this plugin\n         */\n        if (!context.request?.params) {\n            return null;\n        }\n\n        const { type, locale } = context.request.params as Record<string, string | null>;\n        if (!type && !locale) {\n            return null;\n        }\n\n        if (!type) {\n            throw new WebinyError(`Missing request parameter \"type\".`);\n        } else if (!locale) {\n            throw new WebinyError(`Missing request parameter \"locale\".`);\n        } else if (allowedEndpoints.includes(type as ApiEndpoint) === false) {\n            throw new WebinyError(`Endpoint \"${type}\" not allowed!`);\n        }\n\n        return {\n            type: type as ApiEndpoint,\n            locale\n        };\n    });\n};\n"],"mappings":";;;;;;;;;AAAA;;AACA;;AAGA,MAAMA,gBAA+B,GAAG,CAAC,QAAD,EAAW,MAAX,EAAmB,SAAnB,CAAxC;;AAEO,MAAMC,yBAAyB,GAAG,MAAM;EAC3C,OAAO,IAAIC,wCAAJ,CAAwB,MAAMC,OAAN,IAAiB;IAAA;;IAC5C;AACR;AACA;IACQ,IAAI,sBAACA,OAAO,CAACC,OAAT,6CAAC,iBAAiBC,MAAlB,CAAJ,EAA8B;MAC1B,OAAO,IAAP;IACH;;IAED,MAAM;MAAEC,IAAF;MAAQC;IAAR,IAAmBJ,OAAO,CAACC,OAAR,CAAgBC,MAAzC;;IACA,IAAI,CAACC,IAAD,IAAS,CAACC,MAAd,EAAsB;MAClB,OAAO,IAAP;IACH;;IAED,IAAI,CAACD,IAAL,EAAW;MACP,MAAM,IAAIE,cAAJ,CAAiB,mCAAjB,CAAN;IACH,CAFD,MAEO,IAAI,CAACD,MAAL,EAAa;MAChB,MAAM,IAAIC,cAAJ,CAAiB,qCAAjB,CAAN;IACH,CAFM,MAEA,IAAIR,gBAAgB,CAACS,QAAjB,CAA0BH,IAA1B,MAAmD,KAAvD,EAA8D;MACjE,MAAM,IAAIE,cAAJ,CAAiB,aAAYF,IAAK,gBAAlC,CAAN;IACH;;IAED,OAAO;MACHA,IAAI,EAAEA,IADH;MAEHC;IAFG,CAAP;EAIH,CAzBM,CAAP;AA0BH,CA3BM"}

package/plugins/CmsGroupPlugin.d.ts

@@ -0,0 +1,13 @@
+import { Plugin } from "@webiny/plugins";
+import { CmsGroup as BaseCmsGroup } from "../types";
+interface CmsGroup extends Omit<BaseCmsGroup, "locale" | "tenant" | "webinyVersion"> {
+    tenant?: string;
+    locale?: string;
+}
+export declare class CmsGroupPlugin extends Plugin {
+    static readonly type: string;
+    readonly contentModelGroup: CmsGroup;
+    constructor(contentModelGroup: CmsGroup);
+}
+export declare const createCmsGroup: (group: CmsGroup) => CmsGroupPlugin;
+export {};

package/plugins/CmsGroupPlugin.js

@@ -0,0 +1,30 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createCmsGroup = exports.CmsGroupPlugin = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _plugins = require("@webiny/plugins");
+
+class CmsGroupPlugin extends _plugins.Plugin {
+  constructor(contentModelGroup) {
+    super();
+    (0, _defineProperty2.default)(this, "contentModelGroup", void 0);
+    this.contentModelGroup = contentModelGroup;
+  }
+
+}
+
+exports.CmsGroupPlugin = CmsGroupPlugin;
+(0, _defineProperty2.default)(CmsGroupPlugin, "type", "cms-content-model-group");
+
+const createCmsGroup = group => {
+  return new CmsGroupPlugin(group);
+};
+
+exports.createCmsGroup = createCmsGroup;

package/plugins/CmsGroupPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["CmsGroupPlugin","Plugin","constructor","contentModelGroup","createCmsGroup","group"],"sources":["CmsGroupPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport { CmsGroup as BaseCmsGroup } from \"~/types\";\n\ninterface CmsGroup extends Omit<BaseCmsGroup, \"locale\" | \"tenant\" | \"webinyVersion\"> {\n    tenant?: string;\n    locale?: string;\n}\nexport class CmsGroupPlugin extends Plugin {\n    public static override readonly type: string = \"cms-content-model-group\";\n    public readonly contentModelGroup: CmsGroup;\n\n    constructor(contentModelGroup: CmsGroup) {\n        super();\n        this.contentModelGroup = contentModelGroup;\n    }\n}\n\nexport const createCmsGroup = (group: CmsGroup): CmsGroupPlugin => {\n    return new CmsGroupPlugin(group);\n};\n"],"mappings":";;;;;;;;;;;AAAA;;AAOO,MAAMA,cAAN,SAA6BC,eAA7B,CAAoC;EAIvCC,WAAW,CAACC,iBAAD,EAA8B;IACrC;IADqC;IAErC,KAAKA,iBAAL,GAAyBA,iBAAzB;EACH;;AAPsC;;;8BAA9BH,c,UACsC,yB;;AAS5C,MAAMI,cAAc,GAAIC,KAAD,IAAqC;EAC/D,OAAO,IAAIL,cAAJ,CAAmBK,KAAnB,CAAP;AACH,CAFM"}

package/plugins/CmsModelFieldConverterPlugin.d.ts

@@ -0,0 +1,14 @@
+import { Plugin } from "@webiny/plugins";
+import { CmsEntryValues, CmsModelFieldWithParent } from "../types";
+import { ConverterCollection } from "../utils/converters/ConverterCollection";
+export interface ConvertParams<F = CmsModelFieldWithParent> {
+    field: F;
+    value: any;
+    converterCollection: ConverterCollection;
+}
+export declare abstract class CmsModelFieldConverterPlugin extends Plugin {
+    static type: string;
+    abstract getFieldType(): string;
+    abstract convertToStorage(params: ConvertParams): CmsEntryValues;
+    abstract convertFromStorage(params: ConvertParams): CmsEntryValues;
+}

package/plugins/CmsModelFieldConverterPlugin.js

@@ -0,0 +1,17 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CmsModelFieldConverterPlugin = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _plugins = require("@webiny/plugins");
+
+class CmsModelFieldConverterPlugin extends _plugins.Plugin {}
+
+exports.CmsModelFieldConverterPlugin = CmsModelFieldConverterPlugin;
+(0, _defineProperty2.default)(CmsModelFieldConverterPlugin, "type", "cms.field.converter");

package/plugins/CmsModelFieldConverterPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["CmsModelFieldConverterPlugin","Plugin"],"sources":["CmsModelFieldConverterPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport { CmsEntryValues, CmsModelFieldWithParent } from \"~/types\";\nimport { ConverterCollection } from \"~/utils/converters/ConverterCollection\";\n\nexport interface ConvertParams<F = CmsModelFieldWithParent> {\n    field: F;\n    value: any;\n    converterCollection: ConverterCollection;\n}\n\nexport abstract class CmsModelFieldConverterPlugin extends Plugin {\n    public static override type = \"cms.field.converter\";\n\n    public abstract getFieldType(): string;\n\n    public abstract convertToStorage(params: ConvertParams): CmsEntryValues;\n    public abstract convertFromStorage(params: ConvertParams): CmsEntryValues;\n}\n"],"mappings":";;;;;;;;;;;AAAA;;AAUO,MAAeA,4BAAf,SAAoDC,eAApD,CAA2D;;;8BAA5CD,4B,UACY,qB"}

package/plugins/CmsModelPlugin.d.ts

@@ -0,0 +1,45 @@
+import { Plugin } from "@webiny/plugins";
+import { CmsModel as CmsModelBase, CmsModelField as CmsModelFieldBase, CmsModelFieldSettings as BaseCmsModelFieldSettings } from "../types";
+interface CmsModelFieldSettings extends Omit<BaseCmsModelFieldSettings, "fields"> {
+    /**
+     * Object field has child fields.
+     */
+    fields?: CmsModelFieldInput[];
+}
+interface CmsModelFieldInput extends Omit<CmsModelFieldBase, "storageId" | "settings"> {
+    /**
+     * If defined, it must be camelCased string.
+     * This is for backwards compatibility - before fields had storageId.
+     *
+     * This should only be populated in old model fields.
+     * News ones must have this empty.
+     */
+    storageId?: string;
+    /**
+     * We must have a possibility to have a nested field defined without the storageId.
+     */
+    settings?: CmsModelFieldSettings;
+}
+interface CmsModelInput extends Omit<CmsModelBase, "locale" | "tenant" | "webinyVersion" | "fields"> {
+    fields: CmsModelFieldInput[];
+    locale?: string;
+    tenant?: string;
+}
+interface CmsModel extends Omit<CmsModelBase, "locale" | "tenant" | "webinyVersion"> {
+    locale?: string;
+    tenant?: string;
+}
+interface CmsModelPluginOptions {
+    validateLayout?: boolean;
+}
+export declare class CmsModelPlugin extends Plugin {
+    static readonly type: string;
+    readonly contentModel: CmsModel;
+    private readonly options;
+    constructor(contentModel: CmsModelInput, options?: CmsModelPluginOptions);
+    private buildModel;
+    private buildFields;
+    private validateLayout;
+}
+export declare const createCmsModel: (model: CmsModelInput, options?: CmsModelPluginOptions) => CmsModelPlugin;
+export {};

package/plugins/CmsModelPlugin.js

@@ -0,0 +1,194 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createCmsModel = exports.CmsModelPlugin = void 0;
+
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _plugins = require("@webiny/plugins");
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+var _createFieldStorageId = require("../crud/contentModel/createFieldStorageId");
+
+var _camelCase = _interopRequireDefault(require("lodash/camelCase"));
+
+class CmsModelPlugin extends _plugins.Plugin {
+  constructor(contentModel, options) {
+    super();
+    (0, _defineProperty2.default)(this, "contentModel", void 0);
+    (0, _defineProperty2.default)(this, "options", void 0);
+    this.options = options || {};
+    this.contentModel = this.buildModel(contentModel);
+  }
+
+  buildModel(input) {
+    const model = (0, _objectSpread2.default)((0, _objectSpread2.default)({}, input), {}, {
+      fields: this.buildFields(input, input.fields)
+    });
+    this.validateLayout(model);
+    return model;
+  }
+
+  buildFields(model, inputFields) {
+    if (inputFields.length === 0) {
+      throw new _error.default(`Missing fields for the defined model "${model.modelId}".`, "MISSING_FIELDS", {
+        model
+      });
+    }
+
+    const fields = [];
+    const storageIdList = [];
+    const fieldIdList = [];
+
+    for (const input of inputFields) {
+      var _settings;
+
+      /**
+       * Field must contain an fieldId. It is required in the graphql, but lets check it just in case
+       */
+      if (!(input.fieldId || "").trim()) {
+        throw new _error.default(`Field's "storageId" is not defined for the content model "${model.modelId}".`, "FIELD_ID_ERROR", {
+          model,
+          field: input
+        });
+      }
+
+      const fieldId = (0, _camelCase.default)(input.fieldId);
+      /**
+       * FieldID must be in correct pattern.
+       */
+
+      if (fieldId.match(/^[0-9]/) !== null) {
+        throw new _error.default(`Field's "fieldId" does not match correct pattern in the content model "${model.modelId}" - cannot start with a number.`, "FIELD_FIELD_ID_ERROR", {
+          model,
+          field: input
+        });
+      }
+      /**
+       * FieldID also must be camelCased.
+       */
+
+
+      if (fieldId !== input.fieldId) {
+        throw new _error.default(`Field's "fieldId" must be a camel cased string in the content model "${model.modelId}".`, "FIELD_FIELD_ID_ERROR", {
+          model,
+          field: input
+        });
+      }
+      /**
+       * ... and fieldId must be unique.
+       */
+
+
+      if (fieldIdList.includes(fieldId) === true) {
+        throw new _error.default(`Field's "fieldId" is not unique in the content model "${model.modelId}".`, "FIELD_ID_NOT_UNIQUE_ERROR", {
+          model,
+          field: input
+        });
+      }
+
+      let storageId = input.storageId ? (0, _camelCase.default)(input.storageId) : null;
+      /**
+       * If defined, storageId MUST be camel cased string - for backward compatibility.
+       */
+
+      if (storageId && (storageId.match(/^([a-zA-Z-0-9]+)$/) === null || storageId !== input.storageId)) {
+        throw new _error.default(`Field's "storageId" of the field with "fieldId" ${input.fieldId} is not camel cased string in the content model "${model.modelId}".`, "STORAGE_ID_NOT_CAMEL_CASED_ERROR", {
+          model,
+          storageId,
+          field: input
+        });
+      } else if (!storageId) {
+        storageId = (0, _createFieldStorageId.createFieldStorageId)(input);
+      }
+      /**
+       * Fields storageId must be unique.
+       */
+
+
+      if (storageIdList.includes(storageId) === true) {
+        throw new _error.default(`Field's "storageId" is not unique in the content model "${model.modelId}".`, "STORAGE_ID_ERROR", {
+          model,
+          field: input
+        });
+      }
+      /**
+       * We can safely ignore error because we are going through the fields and making sure each has storageId.
+       */
+      // @ts-ignore
+
+
+      let settings = input.settings;
+      const childFields = ((_settings = settings) === null || _settings === void 0 ? void 0 : _settings.fields) || [];
+
+      if (input.type === "object" && childFields.length > 0) {
+        settings = (0, _objectSpread2.default)((0, _objectSpread2.default)({}, settings || {}), {}, {
+          fields: this.buildFields(model, childFields)
+        });
+      }
+
+      const field = (0, _objectSpread2.default)((0, _objectSpread2.default)({}, input), {}, {
+        settings,
+        storageId
+      });
+      /**
+       * Add all relevant data to arrays.
+       */
+
+      fields.push(field);
+      storageIdList.push(field.storageId);
+      fieldIdList.push(field.fieldId);
+    }
+
+    return fields;
+  }
+
+  validateLayout(model) {
+    /**
+     * Only skip validation if option.validateLayout was set as false, explicitly.
+     */
+    if (this.options.validateLayout === false) {
+      return;
+    }
+
+    for (const field of model.fields) {
+      let total = 0;
+
+      for (const row of model.layout) {
+        const count = row.filter(cell => cell === field.id).length;
+        total = total + count;
+      }
+
+      if (total === 1) {
+        continue;
+      } else if (total > 1) {
+        throw new _error.default(`Field "${field.id}" is in more than one layout cell.`, "DUPLICATE_FIELD_IN_LAYOUT", {
+          model,
+          field
+        });
+      }
+
+      throw new _error.default(`Missing field "${field.id}" in layout.`, "MISSING_FIELD_IN_LAYOUT", {
+        model,
+        field
+      });
+    }
+  }
+
+}
+
+exports.CmsModelPlugin = CmsModelPlugin;
+(0, _defineProperty2.default)(CmsModelPlugin, "type", "cms-content-model");
+
+const createCmsModel = (model, options) => {
+  return new CmsModelPlugin(model, options);
+};
+
+exports.createCmsModel = createCmsModel;

package/plugins/CmsModelPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["CmsModelPlugin","Plugin","constructor","contentModel","options","buildModel","input","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 { Plugin } from \"@webiny/plugins\";\nimport {\n    CmsModel as CmsModelBase,\n    CmsModelField as CmsModelFieldBase,\n    CmsModelFieldSettings as BaseCmsModelFieldSettings\n} from \"~/types\";\nimport WebinyError from \"@webiny/error\";\nimport { createFieldStorageId } from \"~/crud/contentModel/createFieldStorageId\";\nimport lodashCamelCase from \"lodash/camelCase\";\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 CmsModelInput\n    extends Omit<CmsModelBase, \"locale\" | \"tenant\" | \"webinyVersion\" | \"fields\"> {\n    fields: CmsModelFieldInput[];\n    locale?: string;\n    tenant?: string;\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            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;;AAMA;;AACA;;AACA;;AAuCO,MAAMA,cAAN,SAA6BC,eAA7B,CAAoC;EAMvCC,WAAW,CAACC,YAAD,EAA8BC,OAA9B,EAA+D;IACtE;IADsE;IAAA;IAEtE,KAAKA,OAAL,GAAeA,OAAO,IAAI,EAA1B;IACA,KAAKD,YAAL,GAAoB,KAAKE,UAAL,CAAgBF,YAAhB,CAApB;EACH;;EAEOE,UAAU,CAACC,KAAD,EAAiC;IAC/C,MAAMC,KAAe,+DACdD,KADc;MAEjBE,MAAM,EAAE,KAAKC,WAAL,CAAiBH,KAAjB,EAAwBA,KAAK,CAACE,MAA9B;IAFS,EAArB;IAIA,KAAKE,cAAL,CAAoBH,KAApB;IACA,OAAOA,KAAP;EACH;;EAEOE,WAAW,CACfF,KADe,EAEfI,WAFe,EAGI;IACnB,IAAIA,WAAW,CAACC,MAAZ,KAAuB,CAA3B,EAA8B;MAC1B,MAAM,IAAIC,cAAJ,CACD,yCAAwCN,KAAK,CAACO,OAAQ,IADrD,EAEF,gBAFE,EAGF;QACIP;MADJ,CAHE,CAAN;IAOH;;IACD,MAAMC,MAA2B,GAAG,EAApC;IACA,MAAMO,aAAuB,GAAG,EAAhC;IACA,MAAMC,WAAqB,GAAG,EAA9B;;IACA,KAAK,MAAMV,KAAX,IAAoBK,WAApB,EAAiC;MAAA;;MAC7B;AACZ;AACA;MACY,IAAI,CAAC,CAACL,KAAK,CAACW,OAAN,IAAiB,EAAlB,EAAsBC,IAAtB,EAAL,EAAmC;QAC/B,MAAM,IAAIL,cAAJ,CACD,6DAA4DN,KAAK,CAACO,OAAQ,IADzE,EAEF,gBAFE,EAGF;UACIP,KADJ;UAEIY,KAAK,EAAEb;QAFX,CAHE,CAAN;MAQH;;MACD,MAAMW,OAAO,GAAG,IAAAG,kBAAA,EAAgBd,KAAK,CAACW,OAAtB,CAAhB;MACA;AACZ;AACA;;MACY,IAAIA,OAAO,CAACI,KAAR,CAAc,QAAd,MAA4B,IAAhC,EAAsC;QAClC,MAAM,IAAIR,cAAJ,CACD,0EAAyEN,KAAK,CAACO,OAAQ,iCADtF,EAEF,sBAFE,EAGF;UACIP,KADJ;UAEIY,KAAK,EAAEb;QAFX,CAHE,CAAN;MAQH;MACD;AACZ;AACA;;;MACY,IAAIW,OAAO,KAAKX,KAAK,CAACW,OAAtB,EAA+B;QAC3B,MAAM,IAAIJ,cAAJ,CACD,wEAAuEN,KAAK,CAACO,OAAQ,IADpF,EAEF,sBAFE,EAGF;UACIP,KADJ;UAEIY,KAAK,EAAEb;QAFX,CAHE,CAAN;MAQH;MACD;AACZ;AACA;;;MACY,IAAIU,WAAW,CAACM,QAAZ,CAAqBL,OAArB,MAAkC,IAAtC,EAA4C;QACxC,MAAM,IAAIJ,cAAJ,CACD,yDAAwDN,KAAK,CAACO,OAAQ,IADrE,EAEF,2BAFE,EAGF;UACIP,KADJ;UAEIY,KAAK,EAAEb;QAFX,CAHE,CAAN;MAQH;;MAED,IAAIiB,SAAS,GAAGjB,KAAK,CAACiB,SAAN,GAAkB,IAAAH,kBAAA,EAAgBd,KAAK,CAACiB,SAAtB,CAAlB,GAAqD,IAArE;MACA;AACZ;AACA;;MACY,IACIA,SAAS,KACRA,SAAS,CAACF,KAAV,CAAgB,mBAAhB,MAAyC,IAAzC,IAAiDE,SAAS,KAAKjB,KAAK,CAACiB,SAD7D,CADb,EAGE;QACE,MAAM,IAAIV,cAAJ,CACD,mDAAkDP,KAAK,CAACW,OAAQ,oDAAmDV,KAAK,CAACO,OAAQ,IADhI,EAEF,kCAFE,EAGF;UACIP,KADJ;UAEIgB,SAFJ;UAGIJ,KAAK,EAAEb;QAHX,CAHE,CAAN;MASH,CAbD,MAaO,IAAI,CAACiB,SAAL,EAAgB;QACnBA,SAAS,GAAG,IAAAC,0CAAA,EAAqBlB,KAArB,CAAZ;MACH;MAED;AACZ;AACA;;;MACY,IAAIS,aAAa,CAACO,QAAd,CAAuBC,SAAvB,MAAsC,IAA1C,EAAgD;QAC5C,MAAM,IAAIV,cAAJ,CACD,2DAA0DN,KAAK,CAACO,OAAQ,IADvE,EAEF,kBAFE,EAGF;UACIP,KADJ;UAEIY,KAAK,EAAEb;QAFX,CAHE,CAAN;MAQH;MAED;AACZ;AACA;MACY;;;MACA,IAAImB,QAAmC,GAAGnB,KAAK,CAACmB,QAAhD;MAEA,MAAMC,WAAW,GAAG,cAAAD,QAAQ,UAAR,8CAAUjB,MAAV,KAAoB,EAAxC;;MACA,IAAIF,KAAK,CAACqB,IAAN,KAAe,QAAf,IAA2BD,WAAW,CAACd,MAAZ,GAAqB,CAApD,EAAuD;QACnDa,QAAQ,+DACAA,QAAQ,IAAI,EADZ;UAEJjB,MAAM,EAAE,KAAKC,WAAL,CAAiBF,KAAjB,EAAwBmB,WAAxB;QAFJ,EAAR;MAIH;;MAED,MAAMP,KAAwB,+DACvBb,KADuB;QAE1BmB,QAF0B;QAG1BF;MAH0B,EAA9B;MAKA;AACZ;AACA;;MACYf,MAAM,CAACoB,IAAP,CAAYT,KAAZ;MACAJ,aAAa,CAACa,IAAd,CAAmBT,KAAK,CAACI,SAAzB;MACAP,WAAW,CAACY,IAAZ,CAAiBT,KAAK,CAACF,OAAvB;IACH;;IACD,OAAOT,MAAP;EACH;;EAEOE,cAAc,CAACH,KAAD,EAAwB;IAC1C;AACR;AACA;IACQ,IAAI,KAAKH,OAAL,CAAaM,cAAb,KAAgC,KAApC,EAA2C;MACvC;IACH;;IACD,KAAK,MAAMS,KAAX,IAAoBZ,KAAK,CAACC,MAA1B,EAAkC;MAC9B,IAAIqB,KAAK,GAAG,CAAZ;;MACA,KAAK,MAAMC,GAAX,IAAkBvB,KAAK,CAACwB,MAAxB,EAAgC;QAC5B,MAAMC,KAAK,GAAGF,GAAG,CAACG,MAAJ,CAAWC,IAAI,IAAIA,IAAI,KAAKf,KAAK,CAACgB,EAAlC,EAAsCvB,MAApD;QACAiB,KAAK,GAAGA,KAAK,GAAGG,KAAhB;MACH;;MACD,IAAIH,KAAK,KAAK,CAAd,EAAiB;QACb;MACH,CAFD,MAEO,IAAIA,KAAK,GAAG,CAAZ,EAAe;QAClB,MAAM,IAAIhB,cAAJ,CACD,UAASM,KAAK,CAACgB,EAAG,oCADjB,EAEF,2BAFE,EAGF;UACI5B,KADJ;UAEIY;QAFJ,CAHE,CAAN;MAQH;;MACD,MAAM,IAAIN,cAAJ,CACD,kBAAiBM,KAAK,CAACgB,EAAG,cADzB,EAEF,yBAFE,EAGF;QACI5B,KADJ;QAEIY;MAFJ,CAHE,CAAN;IAQH;EACJ;;AA9LsC;;;8BAA9BnB,c,UACsC,mB;;AAgM5C,MAAMoC,cAAc,GAAG,CAC1B7B,KAD0B,EAE1BH,OAF0B,KAGT;EACjB,OAAO,IAAIJ,cAAJ,CAAmBO,KAAnB,EAA0BH,OAA1B,CAAP;AACH,CALM"}

package/plugins/CmsParametersPlugin.d.ts

@@ -0,0 +1,20 @@
+import { Plugin } from "@webiny/plugins";
+import { ApiEndpoint, CmsContext } from "../types";
+/**
+ * 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 interface CmsParametersPluginResponse {
+    type: CmsParametersPluginResponseType;
+    locale: CmsParametersPluginResponseLocale;
+}
+export interface CmsParametersPluginCallable {
+    (context: CmsContext): Promise<CmsParametersPluginResponse | null>;
+}
+export declare class CmsParametersPlugin extends Plugin {
+    static readonly type: string;
+    private readonly callable;
+    constructor(callable: CmsParametersPluginCallable);
+    getParameters(context: CmsContext): Promise<CmsParametersPluginResponse | null>;
+}

package/plugins/CmsParametersPlugin.js

@@ -0,0 +1,28 @@
+"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);
+  }
+
+}
+
+exports.CmsParametersPlugin = CmsParametersPlugin;
+(0, _defineProperty2.default)(CmsParametersPlugin, "type", "cms-parameters-plugin");

package/plugins/CmsParametersPlugin.js.map

@@ -0,0 +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,mBAAN,SAAkCC,eAAlC,CAAyC;EAKrCC,WAAW,CAACC,QAAD,EAAwC;IACtD;IADsD;IAGtD,KAAKA,QAAL,GAAgBA,QAAhB;EACH;;EAEyB,MAAbC,aAAa,CAACC,OAAD,EAAmE;IACzF,OAAO,KAAKF,QAAL,CAAcE,OAAd,CAAP;EACH;;AAb2C;;;8BAAnCL,mB,UACsC,uB"}

package/plugins/StorageTransformPlugin.d.ts

@@ -0,0 +1,31 @@
+import { Plugin } from "@webiny/plugins/Plugin";
+import { CmsModel, CmsModelField } from "../types";
+import { PluginsContainer } from "@webiny/plugins";
+export interface ToStorageParams<T, F extends CmsModelField> {
+    model: CmsModel;
+    field: F;
+    value: T;
+    getStoragePlugin(fieldType: string): StorageTransformPlugin<T>;
+    plugins: PluginsContainer;
+}
+export interface FromStorageParams<T, F extends CmsModelField> {
+    model: CmsModel;
+    field: Partial<F> & Pick<F, "id" | "fieldId" | "storageId" | "type" | "settings">;
+    value: T;
+    getStoragePlugin(fieldType: string): StorageTransformPlugin<T>;
+    plugins: PluginsContainer;
+}
+export interface StorageTransformPluginParams<T, R, F extends CmsModelField> {
+    name?: string;
+    fieldType: string;
+    toStorage: (params: ToStorageParams<T, F>) => Promise<R>;
+    fromStorage: (params: FromStorageParams<R, F>) => Promise<T>;
+}
+export declare class StorageTransformPlugin<T = any, R = any, F extends CmsModelField = CmsModelField> extends Plugin {
+    static readonly type: string;
+    get fieldType(): string;
+    private readonly config;
+    constructor(config: StorageTransformPluginParams<T, R, F>);
+    toStorage(params: ToStorageParams<T, F>): Promise<R>;
+    fromStorage(params: FromStorageParams<R, F>): Promise<T>;
+}