@webiny/api-headless-cms 0.0.0-mt-2 → 0.0.0-unstable.13771d80a8

package/{content/plugins/crud → crud}/contentModel/models.js

@@ -1,41 +1,31 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.UpdateContentModelModel = exports.CreateContentModelModel = exports.ContentModelFieldModel = void 0;
+exports.UpdateContentModelModel = exports.CreateContentModelModelFrom = exports.CreateContentModelModel = exports.ContentModelFieldModel = void 0;
 
 var _validation = require("@webiny/validation");
 
-var _flow = _interopRequireDefault(require("lodash/flow"));
-
 var _commodoFieldsObject = require("commodo-fields-object");
 
 var _fields = require("@commodo/fields");
 
-var _idValidation = _interopRequireDefault(require("./idValidation"));
+var _fieldIdValidation = require("./fieldIdValidation");
+
+/**
+ * Package commodo-fields-object does not have types
+ */
+// @ts-ignore
 
+/**
+ * Package commodo-fields does not have object.
+ */
+// @ts-ignore
 const requiredShortString = _validation.validation.create("required,maxLength:255");
 
 const shortString = _validation.validation.create("maxLength:255");
 
-const CreateContentModelModel = (0, _fields.withFields)({
-  name: (0, _fields.string)({
-    validation: requiredShortString
-  }),
-  modelId: (0, _fields.string)({
-    validation: shortString
-  }),
-  description: (0, _fields.string)({
-    validation: shortString
-  }),
-  group: (0, _fields.string)({
-    validation: requiredShortString
-  })
-})();
-exports.CreateContentModelModel = CreateContentModelModel;
 const RendererModel = (0, _fields.withFields)({
   name: (0, _fields.string)({
     validation: requiredShortString
@@ -45,9 +35,9 @@ const ContentModelFieldModel = (0, _fields.withFields)({
   id: (0, _fields.string)({
     validation: requiredShortString
   }),
-  fieldId: (0, _flow.default)((0, _fields.onSet)(value => value && value.trim()), (0, _fields.setOnce)())((0, _fields.string)({
-    validation: _idValidation.default
-  })),
+  fieldId: (0, _fields.string)({
+    validation: _fieldIdValidation.validateFieldId
+  }),
   label: (0, _fields.string)({
     validation: requiredShortString
   }),
@@ -60,6 +50,10 @@ const ContentModelFieldModel = (0, _fields.withFields)({
   type: (0, _fields.setOnce)()((0, _fields.string)({
     validation: requiredShortString
   })),
+  tags: (0, _commodoFieldsObject.object)({
+    value: [],
+    required: false
+  }),
   multipleValues: (0, _fields.boolean)({
     value: false
   }),
@@ -72,7 +66,8 @@ const ContentModelFieldModel = (0, _fields.withFields)({
         list: true,
         instanceOf: (0, _fields.withFields)({
           label: (0, _fields.string)(),
-          value: (0, _fields.string)()
+          value: (0, _fields.string)(),
+          selected: (0, _fields.boolean)()
         })()
       })
     })()
@@ -114,8 +109,60 @@ const ContentModelFieldModel = (0, _fields.withFields)({
   settings: (0, _commodoFieldsObject.object)({
     value: {}
   })
+  /**
+   * By the default, field is not deleted.
+   */
+  // isDeleted: boolean({ value: false })
+
 })();
 exports.ContentModelFieldModel = ContentModelFieldModel;
+const CreateContentModelModel = (0, _fields.withFields)({
+  name: (0, _fields.string)({
+    validation: requiredShortString
+  }),
+  modelId: (0, _fields.string)({
+    validation: shortString
+  }),
+  description: (0, _fields.string)({
+    validation: shortString
+  }),
+  group: (0, _fields.string)({
+    validation: requiredShortString
+  }),
+  fields: (0, _fields.fields)({
+    instanceOf: ContentModelFieldModel,
+    value: [],
+    list: true,
+    required: true
+  }),
+  layout: (0, _commodoFieldsObject.object)({
+    value: [],
+    required: true
+  }),
+  tags: (0, _commodoFieldsObject.object)({
+    value: [],
+    required: false
+  })
+})();
+exports.CreateContentModelModel = CreateContentModelModel;
+const CreateContentModelModelFrom = (0, _fields.withFields)({
+  name: (0, _fields.string)({
+    validation: requiredShortString
+  }),
+  modelId: (0, _fields.string)({
+    validation: shortString
+  }),
+  description: (0, _fields.string)({
+    validation: shortString
+  }),
+  group: (0, _fields.string)({
+    validation: requiredShortString
+  }),
+  locale: (0, _fields.string)({
+    validation: shortString
+  })
+})();
+exports.CreateContentModelModelFrom = CreateContentModelModelFrom;
 const UpdateContentModelModel = (0, _fields.withFields)({
   name: (0, _fields.string)({
     validation: shortString
@@ -136,6 +183,10 @@ const UpdateContentModelModel = (0, _fields.withFields)({
   layout: (0, _commodoFieldsObject.object)({
     value: [],
     required: true
+  }),
+  tags: (0, _commodoFieldsObject.object)({
+    value: [],
+    required: false
   })
 })();
 exports.UpdateContentModelModel = UpdateContentModelModel;

package/crud/contentModel/models.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["requiredShortString","validation","create","shortString","RendererModel","withFields","name","string","ContentModelFieldModel","id","fieldId","validateFieldId","label","helpText","placeholderText","type","setOnce","tags","object","value","required","multipleValues","boolean","predefinedValues","fields","instanceOf","enabled","values","list","selected","renderer","message","settings","listValidation","CreateContentModelModel","modelId","description","group","layout","CreateContentModelModelFrom","locale","UpdateContentModelModel","titleFieldId"],"sources":["models.ts"],"sourcesContent":["import { validation } from \"@webiny/validation\";\n/**\n * Package commodo-fields-object does not have types\n */\n// @ts-ignore\nimport { object } from \"commodo-fields-object\";\n/**\n * Package commodo-fields does not have object.\n */\n// @ts-ignore\nimport { withFields, string, setOnce, boolean, fields } from \"@commodo/fields\";\nimport { validateFieldId } from \"./fieldIdValidation\";\n\nconst requiredShortString = validation.create(\"required,maxLength:255\");\nconst shortString = validation.create(\"maxLength:255\");\n\nconst RendererModel = withFields({\n    name: string({ validation: requiredShortString })\n})();\n\nexport const ContentModelFieldModel = withFields({\n    id: string({ validation: requiredShortString }),\n    fieldId: string({\n        validation: validateFieldId\n    }),\n    label: string({ validation: requiredShortString }),\n    helpText: string({ validation: shortString }),\n    placeholderText: string({ validation: shortString }),\n    type: setOnce()(string({ validation: requiredShortString })),\n    tags: object({ value: [], required: false }),\n    multipleValues: boolean({ value: false }),\n    predefinedValues: fields({\n        value: {},\n        instanceOf: withFields({\n            enabled: boolean(),\n            values: fields({\n                value: [],\n                list: true,\n                instanceOf: withFields({\n                    label: string(),\n                    value: string(),\n                    selected: boolean()\n                })()\n            })\n        })()\n    }),\n    renderer: fields({ instanceOf: RendererModel, validation: shortString }),\n    validation: fields({\n        list: true,\n        value: [],\n        instanceOf: withFields({\n            name: string({ validation: requiredShortString }),\n            message: string({ validation: shortString }),\n            settings: object({ value: {} })\n        })()\n    }),\n    listValidation: fields({\n        list: true,\n        value: [],\n        instanceOf: withFields({\n            name: string({ validation: requiredShortString }),\n            message: string({ validation: shortString }),\n            settings: object({ value: {} })\n        })()\n    }),\n    settings: object({ value: {} })\n    /**\n     * By the default, field is not deleted.\n     */\n    // isDeleted: boolean({ value: false })\n})();\n\nexport const CreateContentModelModel = withFields({\n    name: string({ validation: requiredShortString }),\n    modelId: string({ validation: shortString }),\n    description: string({ validation: shortString }),\n    group: string({ validation: requiredShortString }),\n    fields: fields({ instanceOf: ContentModelFieldModel, value: [], list: true, required: true }),\n    layout: object({ value: [], required: true }),\n    tags: object({ value: [], required: false })\n})();\n\nexport const CreateContentModelModelFrom = withFields({\n    name: string({ validation: requiredShortString }),\n    modelId: string({ validation: shortString }),\n    description: string({ validation: shortString }),\n    group: string({ validation: requiredShortString }),\n    locale: string({ validation: shortString })\n})();\n\nexport const UpdateContentModelModel = withFields({\n    name: string({ validation: shortString }),\n    description: string({ validation: shortString }),\n    group: string({ validation: shortString }),\n    titleFieldId: string(),\n    fields: fields({ instanceOf: ContentModelFieldModel, value: [], list: true, required: true }),\n    layout: object({ value: [], required: true }),\n    tags: object({ value: [], required: false })\n})();\n"],"mappings":";;;;;;;AAAA;;AAKA;;AAKA;;AACA;;AAVA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AAIA,MAAMA,mBAAmB,GAAGC,sBAAA,CAAWC,MAAX,CAAkB,wBAAlB,CAA5B;;AACA,MAAMC,WAAW,GAAGF,sBAAA,CAAWC,MAAX,CAAkB,eAAlB,CAApB;;AAEA,MAAME,aAAa,GAAG,IAAAC,kBAAA,EAAW;EAC7BC,IAAI,EAAE,IAAAC,cAAA,EAAO;IAAEN,UAAU,EAAED;EAAd,CAAP;AADuB,CAAX,GAAtB;AAIO,MAAMQ,sBAAsB,GAAG,IAAAH,kBAAA,EAAW;EAC7CI,EAAE,EAAE,IAAAF,cAAA,EAAO;IAAEN,UAAU,EAAED;EAAd,CAAP,CADyC;EAE7CU,OAAO,EAAE,IAAAH,cAAA,EAAO;IACZN,UAAU,EAAEU;EADA,CAAP,CAFoC;EAK7CC,KAAK,EAAE,IAAAL,cAAA,EAAO;IAAEN,UAAU,EAAED;EAAd,CAAP,CALsC;EAM7Ca,QAAQ,EAAE,IAAAN,cAAA,EAAO;IAAEN,UAAU,EAAEE;EAAd,CAAP,CANmC;EAO7CW,eAAe,EAAE,IAAAP,cAAA,EAAO;IAAEN,UAAU,EAAEE;EAAd,CAAP,CAP4B;EAQ7CY,IAAI,EAAE,IAAAC,eAAA,IAAU,IAAAT,cAAA,EAAO;IAAEN,UAAU,EAAED;EAAd,CAAP,CAAV,CARuC;EAS7CiB,IAAI,EAAE,IAAAC,2BAAA,EAAO;IAAEC,KAAK,EAAE,EAAT;IAAaC,QAAQ,EAAE;EAAvB,CAAP,CATuC;EAU7CC,cAAc,EAAE,IAAAC,eAAA,EAAQ;IAAEH,KAAK,EAAE;EAAT,CAAR,CAV6B;EAW7CI,gBAAgB,EAAE,IAAAC,cAAA,EAAO;IACrBL,KAAK,EAAE,EADc;IAErBM,UAAU,EAAE,IAAApB,kBAAA,EAAW;MACnBqB,OAAO,EAAE,IAAAJ,eAAA,GADU;MAEnBK,MAAM,EAAE,IAAAH,cAAA,EAAO;QACXL,KAAK,EAAE,EADI;QAEXS,IAAI,EAAE,IAFK;QAGXH,UAAU,EAAE,IAAApB,kBAAA,EAAW;UACnBO,KAAK,EAAE,IAAAL,cAAA,GADY;UAEnBY,KAAK,EAAE,IAAAZ,cAAA,GAFY;UAGnBsB,QAAQ,EAAE,IAAAP,eAAA;QAHS,CAAX;MAHD,CAAP;IAFW,CAAX;EAFS,CAAP,CAX2B;EA0B7CQ,QAAQ,EAAE,IAAAN,cAAA,EAAO;IAAEC,UAAU,EAAErB,aAAd;IAA6BH,UAAU,EAAEE;EAAzC,CAAP,CA1BmC;EA2B7CF,UAAU,EAAE,IAAAuB,cAAA,EAAO;IACfI,IAAI,EAAE,IADS;IAEfT,KAAK,EAAE,EAFQ;IAGfM,UAAU,EAAE,IAAApB,kBAAA,EAAW;MACnBC,IAAI,EAAE,IAAAC,cAAA,EAAO;QAAEN,UAAU,EAAED;MAAd,CAAP,CADa;MAEnB+B,OAAO,EAAE,IAAAxB,cAAA,EAAO;QAAEN,UAAU,EAAEE;MAAd,CAAP,CAFU;MAGnB6B,QAAQ,EAAE,IAAAd,2BAAA,EAAO;QAAEC,KAAK,EAAE;MAAT,CAAP;IAHS,CAAX;EAHG,CAAP,CA3BiC;EAoC7Cc,cAAc,EAAE,IAAAT,cAAA,EAAO;IACnBI,IAAI,EAAE,IADa;IAEnBT,KAAK,EAAE,EAFY;IAGnBM,UAAU,EAAE,IAAApB,kBAAA,EAAW;MACnBC,IAAI,EAAE,IAAAC,cAAA,EAAO;QAAEN,UAAU,EAAED;MAAd,CAAP,CADa;MAEnB+B,OAAO,EAAE,IAAAxB,cAAA,EAAO;QAAEN,UAAU,EAAEE;MAAd,CAAP,CAFU;MAGnB6B,QAAQ,EAAE,IAAAd,2BAAA,EAAO;QAAEC,KAAK,EAAE;MAAT,CAAP;IAHS,CAAX;EAHO,CAAP,CApC6B;EA6C7Ca,QAAQ,EAAE,IAAAd,2BAAA,EAAO;IAAEC,KAAK,EAAE;EAAT,CAAP;EACV;AACJ;AACA;EACI;;AAjD6C,CAAX,GAA/B;;AAoDA,MAAMe,uBAAuB,GAAG,IAAA7B,kBAAA,EAAW;EAC9CC,IAAI,EAAE,IAAAC,cAAA,EAAO;IAAEN,UAAU,EAAED;EAAd,CAAP,CADwC;EAE9CmC,OAAO,EAAE,IAAA5B,cAAA,EAAO;IAAEN,UAAU,EAAEE;EAAd,CAAP,CAFqC;EAG9CiC,WAAW,EAAE,IAAA7B,cAAA,EAAO;IAAEN,UAAU,EAAEE;EAAd,CAAP,CAHiC;EAI9CkC,KAAK,EAAE,IAAA9B,cAAA,EAAO;IAAEN,UAAU,EAAED;EAAd,CAAP,CAJuC;EAK9CwB,MAAM,EAAE,IAAAA,cAAA,EAAO;IAAEC,UAAU,EAAEjB,sBAAd;IAAsCW,KAAK,EAAE,EAA7C;IAAiDS,IAAI,EAAE,IAAvD;IAA6DR,QAAQ,EAAE;EAAvE,CAAP,CALsC;EAM9CkB,MAAM,EAAE,IAAApB,2BAAA,EAAO;IAAEC,KAAK,EAAE,EAAT;IAAaC,QAAQ,EAAE;EAAvB,CAAP,CANsC;EAO9CH,IAAI,EAAE,IAAAC,2BAAA,EAAO;IAAEC,KAAK,EAAE,EAAT;IAAaC,QAAQ,EAAE;EAAvB,CAAP;AAPwC,CAAX,GAAhC;;AAUA,MAAMmB,2BAA2B,GAAG,IAAAlC,kBAAA,EAAW;EAClDC,IAAI,EAAE,IAAAC,cAAA,EAAO;IAAEN,UAAU,EAAED;EAAd,CAAP,CAD4C;EAElDmC,OAAO,EAAE,IAAA5B,cAAA,EAAO;IAAEN,UAAU,EAAEE;EAAd,CAAP,CAFyC;EAGlDiC,WAAW,EAAE,IAAA7B,cAAA,EAAO;IAAEN,UAAU,EAAEE;EAAd,CAAP,CAHqC;EAIlDkC,KAAK,EAAE,IAAA9B,cAAA,EAAO;IAAEN,UAAU,EAAED;EAAd,CAAP,CAJ2C;EAKlDwC,MAAM,EAAE,IAAAjC,cAAA,EAAO;IAAEN,UAAU,EAAEE;EAAd,CAAP;AAL0C,CAAX,GAApC;;AAQA,MAAMsC,uBAAuB,GAAG,IAAApC,kBAAA,EAAW;EAC9CC,IAAI,EAAE,IAAAC,cAAA,EAAO;IAAEN,UAAU,EAAEE;EAAd,CAAP,CADwC;EAE9CiC,WAAW,EAAE,IAAA7B,cAAA,EAAO;IAAEN,UAAU,EAAEE;EAAd,CAAP,CAFiC;EAG9CkC,KAAK,EAAE,IAAA9B,cAAA,EAAO;IAAEN,UAAU,EAAEE;EAAd,CAAP,CAHuC;EAI9CuC,YAAY,EAAE,IAAAnC,cAAA,GAJgC;EAK9CiB,MAAM,EAAE,IAAAA,cAAA,EAAO;IAAEC,UAAU,EAAEjB,sBAAd;IAAsCW,KAAK,EAAE,EAA7C;IAAiDS,IAAI,EAAE,IAAvD;IAA6DR,QAAQ,EAAE;EAAvE,CAAP,CALsC;EAM9CkB,MAAM,EAAE,IAAApB,2BAAA,EAAO;IAAEC,KAAK,EAAE,EAAT;IAAaC,QAAQ,EAAE;EAAvB,CAAP,CANsC;EAO9CH,IAAI,EAAE,IAAAC,2BAAA,EAAO;IAAEC,KAAK,EAAE,EAAT;IAAaC,QAAQ,EAAE;EAAvB,CAAP;AAPwC,CAAX,GAAhC"}

package/crud/contentModel/systemFields.d.ts

@@ -0,0 +1 @@
+export declare const fieldSystemFields: string[];

package/crud/contentModel/systemFields.js

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.fieldSystemFields = void 0;
+const fieldSystemFields = ["id", "fieldId", "storageId", "label", "helpText", "placeholderText", "type", "multipleValues", "predefinedValues", "renderer", "validation", "listValidation", "settings"];
+exports.fieldSystemFields = fieldSystemFields;

package/crud/contentModel/systemFields.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["fieldSystemFields"],"sources":["systemFields.ts"],"sourcesContent":["export const fieldSystemFields: string[] = [\n    \"id\",\n    \"fieldId\",\n    \"storageId\",\n    \"label\",\n    \"helpText\",\n    \"placeholderText\",\n    \"type\",\n    \"multipleValues\",\n    \"predefinedValues\",\n    \"renderer\",\n    \"validation\",\n    \"listValidation\",\n    \"settings\"\n];\n"],"mappings":";;;;;;AAAO,MAAMA,iBAA2B,GAAG,CACvC,IADuC,EAEvC,SAFuC,EAGvC,WAHuC,EAIvC,OAJuC,EAKvC,UALuC,EAMvC,iBANuC,EAOvC,MAPuC,EAQvC,gBARuC,EASvC,kBATuC,EAUvC,UAVuC,EAWvC,YAXuC,EAYvC,gBAZuC,EAavC,UAbuC,CAApC"}

package/crud/contentModel/validateLayout.d.ts

@@ -0,0 +1,2 @@
+import { CmsModelField, CmsModel } from "../../types";
+export declare const validateLayout: (layout: CmsModel["layout"], fields?: CmsModelField[]) => void;

package/{content/plugins/crud → crud}/contentModel/validateLayout.js

@@ -4,35 +4,25 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.validateLayout = void 0;
-
-const validateLayout = ({
-  layout
-}, fields) => {
+const validateLayout = (layout, fields = []) => {
   const flatLayoutIdList = layout.reduce((acc, id) => {
     return acc.concat(Array.isArray(id) ? id : [id]);
   }, []);
-
   if (flatLayoutIdList.length !== fields.length) {
     throw new Error(`There are ${flatLayoutIdList.length} IDs in the layout and ${fields.length} in fields, which cannot be - numbers must be the same.`);
   }
-
   for (const field of fields) {
     if (flatLayoutIdList.includes(field.id)) {
       continue;
     }
-
     throw new Error(`Field "${field.id}" is not defined in layout.`);
   }
-
   for (const id of flatLayoutIdList) {
     const fieldFound = fields.some(f => f.id === id);
-
     if (fieldFound) {
       continue;
     }
-
     throw new Error(`Field id "${id}" is in layout but not in fields.`);
   }
 };
-
 exports.validateLayout = validateLayout;

package/crud/contentModel/validateLayout.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["validateLayout","layout","fields","flatLayoutIdList","reduce","acc","id","concat","Array","isArray","length","Error","field","includes","fieldFound","some","f"],"sources":["validateLayout.ts"],"sourcesContent":["import { CmsModelField, CmsModel } from \"~/types\";\n\nexport const validateLayout = (layout: CmsModel[\"layout\"], fields: CmsModelField[] = []): void => {\n    const flatLayoutIdList = layout.reduce((acc, id) => {\n        return acc.concat(Array.isArray(id) ? id : [id]);\n    }, []);\n    if (flatLayoutIdList.length !== fields.length) {\n        throw new Error(\n            `There are ${flatLayoutIdList.length} IDs in the layout and ${fields.length} in fields, which cannot be - numbers must be the same.`\n        );\n    }\n    for (const field of fields) {\n        if (flatLayoutIdList.includes(field.id)) {\n            continue;\n        }\n        throw new Error(`Field \"${field.id}\" is not defined in layout.`);\n    }\n    for (const id of flatLayoutIdList) {\n        const fieldFound = fields.some(f => f.id === id);\n        if (fieldFound) {\n            continue;\n        }\n        throw new Error(`Field id \"${id}\" is in layout but not in fields.`);\n    }\n};\n"],"mappings":";;;;;;AAEO,MAAMA,cAAc,GAAG,CAACC,MAA0B,EAAEC,MAAuB,GAAG,EAAE,KAAW;EAC9F,MAAMC,gBAAgB,GAAGF,MAAM,CAACG,MAAM,CAAC,CAACC,GAAG,EAAEC,EAAE,KAAK;IAChD,OAAOD,GAAG,CAACE,MAAM,CAACC,KAAK,CAACC,OAAO,CAACH,EAAE,CAAC,GAAGA,EAAE,GAAG,CAACA,EAAE,CAAC,CAAC;EACpD,CAAC,EAAE,EAAE,CAAC;EACN,IAAIH,gBAAgB,CAACO,MAAM,KAAKR,MAAM,CAACQ,MAAM,EAAE;IAC3C,MAAM,IAAIC,KAAK,CACV,aAAYR,gBAAgB,CAACO,MAAO,0BAAyBR,MAAM,CAACQ,MAAO,yDAAwD,CACvI;EACL;EACA,KAAK,MAAME,KAAK,IAAIV,MAAM,EAAE;IACxB,IAAIC,gBAAgB,CAACU,QAAQ,CAACD,KAAK,CAACN,EAAE,CAAC,EAAE;MACrC;IACJ;IACA,MAAM,IAAIK,KAAK,CAAE,UAASC,KAAK,CAACN,EAAG,6BAA4B,CAAC;EACpE;EACA,KAAK,MAAMA,EAAE,IAAIH,gBAAgB,EAAE;IAC/B,MAAMW,UAAU,GAAGZ,MAAM,CAACa,IAAI,CAACC,CAAC,IAAIA,CAAC,CAACV,EAAE,KAAKA,EAAE,CAAC;IAChD,IAAIQ,UAAU,EAAE;MACZ;IACJ;IACA,MAAM,IAAIH,KAAK,CAAE,aAAYL,EAAG,mCAAkC,CAAC;EACvE;AACJ,CAAC;AAAC"}

package/crud/contentModel/validateModel.d.ts

@@ -0,0 +1,9 @@
+import { CmsContext, CmsModel } from "../../types";
+interface ValidateModelParams {
+    models: CmsModel[];
+    model: CmsModel;
+    original?: CmsModel;
+    context: CmsContext;
+}
+export declare const validateModel: (params: ValidateModelParams) => Promise<void>;
+export {};

package/crud/contentModel/validateModel.js

@@ -0,0 +1,27 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.validateModel = void 0;
+var _error = _interopRequireDefault(require("@webiny/error"));
+var _CmsModelPlugin = require("../../plugins/CmsModelPlugin");
+var _validateModelFields = require("./validateModelFields");
+const validateModel = async params => {
+  const {
+    model,
+    context
+  } = params;
+  const {
+    plugins
+  } = context;
+  const modelPlugin = plugins.byType(_CmsModelPlugin.CmsModelPlugin.type).find(item => item.contentModel.modelId === model.modelId);
+  if (modelPlugin) {
+    throw new _error.default("Content models defined via plugins cannot be updated.", "CONTENT_MODEL_UPDATE_ERROR", {
+      modelId: model.modelId
+    });
+  }
+  await (0, _validateModelFields.validateModelFields)(params);
+};
+exports.validateModel = validateModel;

package/crud/contentModel/validateModel.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["validateModel","params","model","context","plugins","modelPlugin","byType","CmsModelPlugin","type","find","item","contentModel","modelId","WebinyError","validateModelFields"],"sources":["validateModel.ts"],"sourcesContent":["import WebinyError from \"@webiny/error\";\nimport { CmsModelPlugin } from \"~/plugins/CmsModelPlugin\";\nimport { CmsContext, CmsModel } from \"~/types\";\nimport { validateModelFields } from \"~/crud/contentModel/validateModelFields\";\n\ninterface ValidateModelParams {\n    models: CmsModel[];\n    model: CmsModel;\n    original?: CmsModel;\n    context: CmsContext;\n}\n\nexport const validateModel = async (params: ValidateModelParams): Promise<void> => {\n    const { model, context } = params;\n\n    const { plugins } = context;\n\n    const modelPlugin = plugins\n        .byType<CmsModelPlugin>(CmsModelPlugin.type)\n        .find(item => item.contentModel.modelId === model.modelId);\n\n    if (modelPlugin) {\n        throw new WebinyError(\n            \"Content models defined via plugins cannot be updated.\",\n            \"CONTENT_MODEL_UPDATE_ERROR\",\n            {\n                modelId: model.modelId\n            }\n        );\n    }\n\n    await validateModelFields(params);\n};\n"],"mappings":";;;;;;;AAAA;AACA;AAEA;AASO,MAAMA,aAAa,GAAG,MAAOC,MAA2B,IAAoB;EAC/E,MAAM;IAAEC,KAAK;IAAEC;EAAQ,CAAC,GAAGF,MAAM;EAEjC,MAAM;IAAEG;EAAQ,CAAC,GAAGD,OAAO;EAE3B,MAAME,WAAW,GAAGD,OAAO,CACtBE,MAAM,CAAiBC,8BAAc,CAACC,IAAI,CAAC,CAC3CC,IAAI,CAACC,IAAI,IAAIA,IAAI,CAACC,YAAY,CAACC,OAAO,KAAKV,KAAK,CAACU,OAAO,CAAC;EAE9D,IAAIP,WAAW,EAAE;IACb,MAAM,IAAIQ,cAAW,CACjB,uDAAuD,EACvD,4BAA4B,EAC5B;MACID,OAAO,EAAEV,KAAK,CAACU;IACnB,CAAC,CACJ;EACL;EAEA,MAAM,IAAAE,wCAAmB,EAACb,MAAM,CAAC;AACrC,CAAC;AAAC"}

package/crud/contentModel/validateModelFields.d.ts

@@ -0,0 +1,9 @@
+import { CmsModel, CmsContext } from "../../types";
+interface ValidateModelFieldsParams {
+    models: CmsModel[];
+    model: CmsModel;
+    original?: CmsModel;
+    context: CmsContext;
+}
+export declare const validateModelFields: (params: ValidateModelFieldsParams) => Promise<void>;
+export {};

package/crud/contentModel/validateModelFields.js

@@ -0,0 +1,343 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.validateModelFields = void 0;
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
+var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
+var _error = _interopRequireDefault(require("@webiny/error"));
+var _createManageSDL = require("../../graphql/schema/createManageSDL");
+var _createFieldStorageId = require("./createFieldStorageId");
+var _getBaseFieldType = require("../../utils/getBaseFieldType");
+var _titleField = require("./fields/titleField");
+var _descriptionField = require("./fields/descriptionField");
+var _imageField = require("./fields/imageField");
+var _plugins = require("../../plugins");
+var _buildSchemaPlugins = require("../../graphql/buildSchemaPlugins");
+var _createExecutableSchema = require("../../graphql/createExecutableSchema");
+var _handlerGraphql = require("@webiny/handler-graphql");
+var _utils = require("@webiny/utils");
+const extractInvalidField = (model, err) => {
+  var _err$source;
+  const sdl = ((_err$source = err.source) === null || _err$source === void 0 ? void 0 : _err$source.body) || "";
+
+  /**
+   * Find the invalid type
+   */
+  const {
+    line: lineNumber
+  } = err.locations ? err.locations[0] : {
+    line: 0
+  };
+  const sdlLines = sdl.split("\n");
+  let sdlLine;
+  let gqlType;
+  for (let i = lineNumber; i > 0; i--) {
+    if (sdlLine && sdlLine.includes("type ")) {
+      gqlType = sdlLine.match(/type\s+(.*?)\s+{/);
+      break;
+    }
+    sdlLine = sdlLines[i];
+  }
+  let invalidField = undefined;
+  if (Array.isArray(gqlType)) {
+    const fieldRegex = new RegExp(`([^\\s+].*?):\\s+\\[?${gqlType[1]}!?\\]?`);
+    const matched = sdl.match(fieldRegex);
+    if (matched) {
+      invalidField = matched[1];
+    }
+  }
+  let message = `See more details in the browser console.`;
+  if (invalidField) {
+    message = `Please review the definition of "${invalidField}" field.`;
+  }
+  return {
+    data: {
+      modelId: model.modelId,
+      sdl,
+      invalidField
+    },
+    code: "INVALID_MODEL_DEFINITION",
+    message: [`Model "${model.modelId}" was not saved!`, message].join("\n")
+  };
+};
+const createValidateChildFields = plugins => {
+  return ({
+    fields,
+    originalFields
+  }) => {
+    if (fields.length === 0 && originalFields.length === 0) {
+      return;
+    }
+    validateFields({
+      fields,
+      originalFields,
+      plugins,
+      lockedFields: []
+    });
+  };
+};
+const validateFields = params => {
+  const {
+    plugins,
+    fields,
+    originalFields,
+    lockedFields
+  } = params;
+  const idList = [];
+  const fieldIdList = [];
+  const storageIdList = [];
+  for (const field of fields) {
+    const baseType = (0, _getBaseFieldType.getBaseFieldType)(field);
+    const plugin = plugins.find(plugin => plugin.fieldType === baseType);
+    if (!plugin) {
+      throw new Error(`Cannot update content model because of the unknown "${baseType}" field.`);
+    }
+    /**
+     * Check the field's id against existing ones.
+     * There cannot be two fields with the same id.
+     */
+    if (idList.includes(field.id)) {
+      throw new _error.default(`Cannot update content model because field "${field.storageId || field.fieldId}" has id "${field.id}", which is already used.`);
+    }
+    idList.push(field.id);
+    const originalField = originalFields.find(f => f.id === field.id);
+    /**
+     * Field MUST have an fieldId defined.
+     */
+    if (!field.fieldId) {
+      throw new _error.default(`Field does not have an "fieldId" defined.`, "MISSING_FIELD_ID", {
+        field
+      });
+    }
+    /**
+     * If storageId does not match a certain pattern, add that pattern, but only if field is not locked (used) already.
+     * This is to avoid errors in the already installed systems.
+     *
+     * Why are we using the @?
+     *
+     * It is not part of special characters for the query syntax in the Lucene.
+     *
+     * Relevant links:
+     * https://lucene.apache.org/core/3_4_0/queryparsersyntax.html
+     * https://discuss.elastic.co/t/special-characters-in-field-names/10658/3
+     * https://discuss.elastic.co/t/illegal-characters-in-elasticsearch-field-names/17196/2
+     */
+    const isLocked = lockedFields.some(lockedField => {
+      return lockedField.fieldId === field.storageId || lockedField.fieldId === field.fieldId;
+    });
+    if (!field.storageId) {
+      /**
+       * In case field is locked, we must set the storageId to the fieldId value.
+       * This should not happen, because we upgrade all the fields in 5.33.0, but let's have a check just in case of some upgrade miss.
+       */
+      //
+      if (isLocked) {
+        field.storageId = field.fieldId;
+      }
+      /**
+       * When having original field, just set the storageId to value from the originalField
+       */
+      //
+      else if (originalField) {
+        field.storageId = originalField.storageId;
+      }
+      /**
+       * The last case is when no original field and not locked - so this is a completely new field.
+       */
+      //
+      else {
+        field.storageId = (0, _createFieldStorageId.createFieldStorageId)(field);
+      }
+    }
+    /**
+     * Check the field's fieldId against existing ones.
+     * There cannot be two fields with the same fieldId - outside world identifier.
+     */
+    if (fieldIdList.includes(field.fieldId)) {
+      throw new _error.default(`Cannot update content model because field "${field.storageId}" has fieldId "${field.fieldId}", which is already used.`);
+    }
+    fieldIdList.push(field.fieldId);
+    /**
+     * Check the field's storageId against the existing ones.
+     * There cannot be two fields with the same storageId.
+     */
+    if (storageIdList.includes(field.storageId)) {
+      throw new _error.default(`Cannot update content model because field "${field.label}" has storageId "${field.storageId}", which is already used.`);
+    }
+    storageIdList.push(field.storageId);
+    /**
+     * There might be some plugins which allow child fields.
+     * We use this method to validate them as well.
+     */
+    if (!plugin.validateChildFields) {
+      continue;
+    }
+    const validateChildFields = createValidateChildFields(plugins);
+    plugin.validateChildFields({
+      field,
+      originalField,
+      validate: validateChildFields
+    });
+  }
+};
+const createGraphQLSchema = async params => {
+  const {
+    context,
+    model
+  } = params;
+  context.security.disableAuthorization();
+  const models = (await context.cms.listModels()).filter(model => {
+    return !model.isPrivate;
+  });
+  context.security.enableAuthorization();
+  const modelPlugins = await (0, _buildSchemaPlugins.buildSchemaPlugins)({
+    context,
+    models: models.concat([model])
+  });
+  const plugins = context.plugins.byType(_handlerGraphql.GraphQLSchemaPlugin.type).reduce((collection, plugin) => {
+    const name = plugin.name || `${plugin.type}-${(0, _utils.generateAlphaNumericId)(16)}`;
+    collection[name] = plugin;
+    return collection;
+  }, {});
+  for (const plugin of modelPlugins) {
+    const name = plugin.name || `${plugin.type}-${(0, _utils.generateAlphaNumericId)(16)}`;
+    plugins[name] = plugin;
+  }
+  return (0, _createExecutableSchema.createExecutableSchema)({
+    plugins: Object.values(plugins)
+  });
+};
+const extractErrorObject = error => {
+  return ["message", "code", "data", "stack"].reduce((output, key) => {
+    if (!error[key]) {
+      return output;
+    }
+    output[key] = error[key];
+    return output;
+  }, {});
+};
+const validateModelFields = async params => {
+  const {
+    models,
+    model,
+    original,
+    context
+  } = params;
+  const {
+    titleFieldId,
+    descriptionFieldId,
+    imageFieldId
+  } = model;
+  const {
+    plugins
+  } = context;
+
+  /**
+   * There should be fields/locked fields in either model or data to be updated.
+   */
+  const {
+    fields = [],
+    lockedFields = []
+  } = model;
+
+  /**
+   * Let's inspect the fields of the received content model. We prevent saving of a content model if it
+   * contains a field for which a "cms-model-field-to-graphql" plugin does not exist on the backend.
+   */
+  const fieldTypePlugins = plugins.byType("cms-model-field-to-graphql");
+  validateFields({
+    fields,
+    originalFields: (original === null || original === void 0 ? void 0 : original.fields) || [],
+    lockedFields,
+    plugins: fieldTypePlugins
+  });
+  if (fields.length) {
+    const sorterPlugins = plugins.byType(_plugins.CmsGraphQLSchemaSorterPlugin.type);
+    /**
+     * Make sure that this model can be safely converted to a GraphQL SDL
+     */
+    const schema = (0, _createManageSDL.createManageSDL)({
+      models,
+      model,
+      fieldTypePlugins: fieldTypePlugins.reduce((acc, pl) => (0, _objectSpread2.default)((0, _objectSpread2.default)({}, acc), {}, {
+        [pl.fieldType]: pl
+      }), {}),
+      sorterPlugins
+    });
+    try {
+      (0, _graphqlTag.default)(schema);
+    } catch (err) {
+      throw new _error.default(extractInvalidField(model, err));
+    }
+    /**
+     *
+     */
+    try {
+      await createGraphQLSchema({
+        context,
+        model
+      });
+    } catch (err) {
+      throw new _error.default({
+        message: "Cannot generate GraphQL schema when testing with the given model. Please check the response for more details.",
+        code: "GRAPHQL_SCHEMA_ERROR",
+        data: {
+          modelId: model.modelId,
+          error: extractErrorObject(err)
+        }
+      });
+    }
+  }
+  model.titleFieldId = (0, _titleField.getContentModelTitleFieldId)(fields, titleFieldId);
+  model.descriptionFieldId = (0, _descriptionField.getContentModelDescriptionFieldId)(fields, descriptionFieldId);
+  model.imageFieldId = (0, _imageField.getContentModelImageFieldId)(fields, imageFieldId);
+  const cmsLockedFieldPlugins = plugins.byType("cms-model-locked-field");
+
+  /**
+   * We must not allow removal or changes in fields that are already in use in content entries.
+   * Locked fields still have fieldId (should be storageId) because of the old existing locked fields in the models.
+   */
+  for (const lockedField of lockedFields) {
+    const existingField = fields.find(item => item.storageId === lockedField.fieldId);
+
+    /**
+     * Starting with 5.33.0 fields can be deleted.
+     * Our UI gives a warning upon locked field deletion, but if user is managing fields through API directly - we cannot do anything.
+     */
+    if (!existingField) {
+      continue;
+    }
+    if (lockedField.multipleValues !== existingField.multipleValues) {
+      throw new _error.default(`Cannot change "multipleValues" for the "${lockedField.fieldId}" field because it's already in use in created content.`, "ENTRY_FIELD_USED", {
+        reason: `"multipleValues" changed`,
+        field: existingField
+      });
+    }
+    const fieldType = (0, _getBaseFieldType.getBaseFieldType)(existingField);
+    if (lockedField.type !== fieldType) {
+      throw new _error.default(`Cannot change field type for the "${lockedField.fieldId}" field because it's already in use in created content.`, "ENTRY_FIELD_USED", {
+        reason: `"type" changed`,
+        lockedFieldType: lockedField.type,
+        existingFieldType: fieldType
+      });
+    }
+
+    /**
+     * Check `lockedField` invariant for specific field
+     */
+    const lockedFieldsByType = cmsLockedFieldPlugins.filter(pl => pl.fieldType === (0, _getBaseFieldType.getBaseFieldType)(lockedField));
+    for (const plugin of lockedFieldsByType) {
+      if (typeof plugin.checkLockedField !== "function") {
+        continue;
+      }
+      plugin.checkLockedField({
+        lockedField,
+        field: existingField
+      });
+    }
+  }
+};
+exports.validateModelFields = validateModelFields;