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

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Webiny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,73 @@
+# @webiny/api-headless-cms
+
+[![](https://img.shields.io/npm/dw/@webiny/api-headless-cms.svg)](https://www.npmjs.com/package/@webiny/api-headless-cms)
+[![](https://img.shields.io/npm/v/@webiny/api-headless-cms.svg)](https://www.npmjs.com/package/@webiny/api-headless-cms)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+
+## Install
+
+```
+npm install --save @webiny/api-headless-cms
+```
+
+Or if you prefer yarn:
+
+```
+yarn add @webiny/api-headless-cms
+```
+
+## Testing
+Due to possibility of multiple storage operations, the tests are completely decoupled from those storage operations.
+
+The [jest.setup.js](./jest.setup.js) is using [@webiny/project-utils/testing/presets.js](../project-utils/testing/presets/index.js) to find and load all the packages containing `@webiny/api-headless-cms` and `storage-operations` keywords in their `package.json` file.
+Those packages are then used to build the test run - one for each of the packages. So depending on how many storage operations there are in the repository, that much of `api-headless-cms` tests will run.
+
+### Defining test environment
+To make it possible for api-headless-cms tests to run with a storage operations package you MUST create `presets.js` file in `storage-operations-package-path/__tests__/__api__/` directory. That file is loaded when setting up the api-headless-cms tests.
+
+It MUST contain the `testEnvironment` variable which contains path to the environment definition file.
+
+That environment file MUST define the test environment which extends `NodeEnvironment` class.
+
+Test environment MUST expose `__getStorageOperationsPlugins` method, via `this.global` property of the class, which will load the required plugins in the `api-headless-cms` tests.
+
+
+### Examples of preset and test environment files
+
+The first implementation of the decoupled storage operations is DynamoDB/Elasticsearch, which you can find in [@webiny/api-headless-cms-ddb-es](../api-headless-cms-ddb-es).
+Files which you can check to help you define your own presets and test environment are:
+* [presets.js](../api-headless-cms-ddb-es/__tests__/__api__/presets.js) - an array of presets of which last one defines the environment to be loaded
+* [environment.js](../api-headless-cms-ddb-es/__tests__/__api__/environment.js) - a class which extends NodeEnvironment and exposes `__getStorageOperationsPlugins` to the tests
+
+### Debugging when testing
+For the WebStorm (PhpStorm,...) when starting a test you must have some values defined in the run/debug configurations screen:
+#### Node options
+`````
+--inspect=9229
+`````
+#### Working directory
+`````
+PATH_TO_YOUR_PROJECT_ROOT
+`````
+example:
+````
+~/webiny/webiny-js/
+````
+#### Jest options
+For DynamoDB + Elasticsearch storage operations tests:
+`````
+--keyword=cms:base --keyword=cms:ddb-es
+`````
+For the DynamoDB storage operations tests:
+`````
+--keyword=cms:base --keyword=cms:ddb
+`````
+Note that base keyword is the `cms:base`. It tells Jest setup to load the `api-headless-cms` tests with the api-headless-cms-ddb-es tests.
+
+#### Environment variables
+If you want to use local Elasticsearch:
+`````
+ELASTICSEARCH_PORT=9200;LOCAL_ELASTICSEARCH=true
+`````
+Nothing if you do not want to use the local Elasticsearch.

package/context.d.ts

@@ -0,0 +1,3 @@
+import { CmsContext } from "./types";
+import { ContextPlugin } from "@webiny/api";
+export declare const createContextPlugin: () => ContextPlugin<CmsContext>;

package/context.js

@@ -0,0 +1,60 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createContextPlugin = void 0;
+
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+var _api = require("@webiny/api");
+
+var _CmsParametersPlugin = require("./plugins/CmsParametersPlugin");
+
+const getParameters = async context => {
+  const plugins = context.plugins.byType(_CmsParametersPlugin.CmsParametersPlugin.type);
+
+  for (const plugin of plugins) {
+    const result = await plugin.getParameters(context);
+
+    if (result !== null) {
+      return result;
+    }
+  }
+
+  throw new _error.default("Could not determine locale and/or type of the CMS.", "CMS_LOCALE_AND_TYPE_ERROR");
+};
+
+const createContextPlugin = () => {
+  return new _api.ContextPlugin(async context => {
+    const {
+      type,
+      locale
+    } = await getParameters(context);
+
+    const getLocale = () => {
+      const systemLocale = context.i18n.getLocale(locale);
+
+      if (!systemLocale) {
+        throw new _error.default(`There is no locale "${locale}" in the system.`);
+      }
+
+      return systemLocale;
+    };
+
+    context.cms = (0, _objectSpread2.default)((0, _objectSpread2.default)({}, context.cms || {}), {}, {
+      type,
+      locale,
+      getLocale,
+      READ: type === "read",
+      PREVIEW: type === "preview",
+      MANAGE: type === "manage"
+    });
+  });
+};
+
+exports.createContextPlugin = createContextPlugin;

package/context.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["getParameters","context","plugins","byType","CmsParametersPlugin","type","plugin","result","WebinyError","createContextPlugin","ContextPlugin","locale","getLocale","systemLocale","i18n","cms","READ","PREVIEW","MANAGE"],"sources":["context.ts"],"sourcesContent":["import { CmsContext } from \"~/types\";\nimport WebinyError from \"@webiny/error\";\nimport { ContextPlugin } from \"@webiny/api\";\nimport { CmsParametersPlugin, CmsParametersPluginResponse } from \"./plugins/CmsParametersPlugin\";\n\nconst getParameters = async (context: CmsContext): Promise<CmsParametersPluginResponse> => {\n    const plugins = context.plugins.byType<CmsParametersPlugin>(CmsParametersPlugin.type);\n\n    for (const plugin of plugins) {\n        const result = await plugin.getParameters(context);\n        if (result !== null) {\n            return result;\n        }\n    }\n    throw new WebinyError(\n        \"Could not determine locale and/or type of the CMS.\",\n        \"CMS_LOCALE_AND_TYPE_ERROR\"\n    );\n};\n\nexport const createContextPlugin = () => {\n    return new ContextPlugin<CmsContext>(async context => {\n        const { type, locale } = await getParameters(context);\n\n        const getLocale = () => {\n            const systemLocale = context.i18n.getLocale(locale);\n            if (!systemLocale) {\n                throw new WebinyError(`There is no locale \"${locale}\" in the system.`);\n            }\n            return systemLocale;\n        };\n\n        context.cms = {\n            ...(context.cms || {}),\n            type,\n            locale,\n            getLocale,\n            READ: type === \"read\",\n            PREVIEW: type === \"preview\",\n            MANAGE: type === \"manage\"\n        };\n    });\n};\n"],"mappings":";;;;;;;;;;;AACA;;AACA;;AACA;;AAEA,MAAMA,aAAa,GAAG,MAAOC,OAAP,IAAqE;EACvF,MAAMC,OAAO,GAAGD,OAAO,CAACC,OAAR,CAAgBC,MAAhB,CAA4CC,wCAAA,CAAoBC,IAAhE,CAAhB;;EAEA,KAAK,MAAMC,MAAX,IAAqBJ,OAArB,EAA8B;IAC1B,MAAMK,MAAM,GAAG,MAAMD,MAAM,CAACN,aAAP,CAAqBC,OAArB,CAArB;;IACA,IAAIM,MAAM,KAAK,IAAf,EAAqB;MACjB,OAAOA,MAAP;IACH;EACJ;;EACD,MAAM,IAAIC,cAAJ,CACF,oDADE,EAEF,2BAFE,CAAN;AAIH,CAbD;;AAeO,MAAMC,mBAAmB,GAAG,MAAM;EACrC,OAAO,IAAIC,kBAAJ,CAA8B,MAAMT,OAAN,IAAiB;IAClD,MAAM;MAAEI,IAAF;MAAQM;IAAR,IAAmB,MAAMX,aAAa,CAACC,OAAD,CAA5C;;IAEA,MAAMW,SAAS,GAAG,MAAM;MACpB,MAAMC,YAAY,GAAGZ,OAAO,CAACa,IAAR,CAAaF,SAAb,CAAuBD,MAAvB,CAArB;;MACA,IAAI,CAACE,YAAL,EAAmB;QACf,MAAM,IAAIL,cAAJ,CAAiB,uBAAsBG,MAAO,kBAA9C,CAAN;MACH;;MACD,OAAOE,YAAP;IACH,CAND;;IAQAZ,OAAO,CAACc,GAAR,+DACQd,OAAO,CAACc,GAAR,IAAe,EADvB;MAEIV,IAFJ;MAGIM,MAHJ;MAIIC,SAJJ;MAKII,IAAI,EAAEX,IAAI,KAAK,MALnB;MAMIY,OAAO,EAAEZ,IAAI,KAAK,SANtB;MAOIa,MAAM,EAAEb,IAAI,KAAK;IAPrB;EASH,CApBM,CAAP;AAqBH,CAtBM"}

package/crud/contentEntry/afterDelete.d.ts

@@ -0,0 +1,8 @@
+import { Topic } from "@webiny/pubsub/types";
+import { OnEntryAfterDeleteTopicParams, CmsContext } from "../../types";
+interface AssignAfterEntryDeleteParams {
+    context: CmsContext;
+    onEntryAfterDelete: Topic<OnEntryAfterDeleteTopicParams>;
+}
+export declare const assignAfterEntryDelete: (params: AssignAfterEntryDeleteParams) => void;
+export {};

package/crud/contentEntry/afterDelete.js

@@ -0,0 +1,41 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.assignAfterEntryDelete = void 0;
+
+var _markLockedFields = require("./markLockedFields");
+
+const assignAfterEntryDelete = params => {
+  const {
+    context,
+    onEntryAfterDelete
+  } = params;
+  onEntryAfterDelete.subscribe(async params => {
+    const {
+      entry,
+      model
+    } = params;
+    const {
+      items
+    } = await context.cms.storageOperations.entries.list(model, {
+      where: {
+        entryId_not: entry.entryId,
+        latest: true
+      },
+      limit: 1
+    });
+
+    if (items.length > 0) {
+      return;
+    }
+
+    await (0, _markLockedFields.markUnlockedFields)({
+      context,
+      model
+    });
+  });
+};
+
+exports.assignAfterEntryDelete = assignAfterEntryDelete;

package/crud/contentEntry/afterDelete.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["assignAfterEntryDelete","params","context","onEntryAfterDelete","subscribe","entry","model","items","cms","storageOperations","entries","list","where","entryId_not","entryId","latest","limit","length","markUnlockedFields"],"sources":["afterDelete.ts"],"sourcesContent":["import { Topic } from \"@webiny/pubsub/types\";\nimport { OnEntryAfterDeleteTopicParams, CmsContext } from \"~/types\";\nimport { markUnlockedFields } from \"./markLockedFields\";\n\ninterface AssignAfterEntryDeleteParams {\n    context: CmsContext;\n    onEntryAfterDelete: Topic<OnEntryAfterDeleteTopicParams>;\n}\nexport const assignAfterEntryDelete = (params: AssignAfterEntryDeleteParams) => {\n    const { context, onEntryAfterDelete } = params;\n\n    onEntryAfterDelete.subscribe(async params => {\n        const { entry, model } = params;\n\n        const { items } = await context.cms.storageOperations.entries.list(model, {\n            where: {\n                entryId_not: entry.entryId,\n                latest: true\n            },\n            limit: 1\n        });\n        if (items.length > 0) {\n            return;\n        }\n        await markUnlockedFields({\n            context,\n            model\n        });\n    });\n};\n"],"mappings":";;;;;;;AAEA;;AAMO,MAAMA,sBAAsB,GAAIC,MAAD,IAA0C;EAC5E,MAAM;IAAEC,OAAF;IAAWC;EAAX,IAAkCF,MAAxC;EAEAE,kBAAkB,CAACC,SAAnB,CAA6B,MAAMH,MAAN,IAAgB;IACzC,MAAM;MAAEI,KAAF;MAASC;IAAT,IAAmBL,MAAzB;IAEA,MAAM;MAAEM;IAAF,IAAY,MAAML,OAAO,CAACM,GAAR,CAAYC,iBAAZ,CAA8BC,OAA9B,CAAsCC,IAAtC,CAA2CL,KAA3C,EAAkD;MACtEM,KAAK,EAAE;QACHC,WAAW,EAAER,KAAK,CAACS,OADhB;QAEHC,MAAM,EAAE;MAFL,CAD+D;MAKtEC,KAAK,EAAE;IAL+D,CAAlD,CAAxB;;IAOA,IAAIT,KAAK,CAACU,MAAN,GAAe,CAAnB,EAAsB;MAClB;IACH;;IACD,MAAM,IAAAC,oCAAA,EAAmB;MACrBhB,OADqB;MAErBI;IAFqB,CAAnB,CAAN;EAIH,CAjBD;AAkBH,CArBM"}

package/crud/contentEntry/beforeCreate.d.ts

@@ -0,0 +1,8 @@
+import { Topic } from "@webiny/pubsub/types";
+import { OnEntryBeforeCreateTopicParams, CmsContext } from "../../types";
+interface AssignBeforeEntryCreateParams {
+    context: CmsContext;
+    onEntryBeforeCreate: Topic<OnEntryBeforeCreateTopicParams>;
+}
+export declare const assignBeforeEntryCreate: (params: AssignBeforeEntryCreateParams) => void;
+export {};

package/crud/contentEntry/beforeCreate.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.assignBeforeEntryCreate = void 0;
+
+var _markLockedFields = require("./markLockedFields");
+
+const assignBeforeEntryCreate = params => {
+  const {
+    context,
+    onEntryBeforeCreate
+  } = params;
+  onEntryBeforeCreate.subscribe(async params => {
+    const {
+      entry,
+      model
+    } = params;
+    await (0, _markLockedFields.markLockedFields)({
+      model,
+      entry,
+      context
+    });
+  });
+};
+
+exports.assignBeforeEntryCreate = assignBeforeEntryCreate;

package/crud/contentEntry/beforeCreate.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["assignBeforeEntryCreate","params","context","onEntryBeforeCreate","subscribe","entry","model","markLockedFields"],"sources":["beforeCreate.ts"],"sourcesContent":["import { Topic } from \"@webiny/pubsub/types\";\nimport { OnEntryBeforeCreateTopicParams, CmsContext } from \"~/types\";\nimport { markLockedFields } from \"./markLockedFields\";\n\ninterface AssignBeforeEntryCreateParams {\n    context: CmsContext;\n    onEntryBeforeCreate: Topic<OnEntryBeforeCreateTopicParams>;\n}\nexport const assignBeforeEntryCreate = (params: AssignBeforeEntryCreateParams) => {\n    const { context, onEntryBeforeCreate } = params;\n\n    onEntryBeforeCreate.subscribe(async params => {\n        const { entry, model } = params;\n\n        await markLockedFields({\n            model,\n            entry,\n            context\n        });\n    });\n};\n"],"mappings":";;;;;;;AAEA;;AAMO,MAAMA,uBAAuB,GAAIC,MAAD,IAA2C;EAC9E,MAAM;IAAEC,OAAF;IAAWC;EAAX,IAAmCF,MAAzC;EAEAE,mBAAmB,CAACC,SAApB,CAA8B,MAAMH,MAAN,IAAgB;IAC1C,MAAM;MAAEI,KAAF;MAASC;IAAT,IAAmBL,MAAzB;IAEA,MAAM,IAAAM,kCAAA,EAAiB;MACnBD,KADmB;MAEnBD,KAFmB;MAGnBH;IAHmB,CAAjB,CAAN;EAKH,CARD;AASH,CAZM"}

package/crud/contentEntry/beforeUpdate.d.ts

@@ -0,0 +1,8 @@
+import { Topic } from "@webiny/pubsub/types";
+import { OnEntryBeforeUpdateTopicParams, CmsContext } from "../../types";
+interface AssignBeforeEntryUpdateParams {
+    context: CmsContext;
+    onEntryBeforeUpdate: Topic<OnEntryBeforeUpdateTopicParams>;
+}
+export declare const assignBeforeEntryUpdate: (params: AssignBeforeEntryUpdateParams) => void;
+export {};

package/crud/contentEntry/beforeUpdate.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.assignBeforeEntryUpdate = void 0;
+
+var _markLockedFields = require("./markLockedFields");
+
+const assignBeforeEntryUpdate = params => {
+  const {
+    context,
+    onEntryBeforeUpdate
+  } = params;
+  onEntryBeforeUpdate.subscribe(async params => {
+    const {
+      entry,
+      model
+    } = params;
+    await (0, _markLockedFields.markLockedFields)({
+      model,
+      entry,
+      context
+    });
+  });
+};
+
+exports.assignBeforeEntryUpdate = assignBeforeEntryUpdate;

package/crud/contentEntry/beforeUpdate.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["assignBeforeEntryUpdate","params","context","onEntryBeforeUpdate","subscribe","entry","model","markLockedFields"],"sources":["beforeUpdate.ts"],"sourcesContent":["import { Topic } from \"@webiny/pubsub/types\";\nimport { OnEntryBeforeUpdateTopicParams, CmsContext } from \"~/types\";\nimport { markLockedFields } from \"./markLockedFields\";\n\ninterface AssignBeforeEntryUpdateParams {\n    context: CmsContext;\n    onEntryBeforeUpdate: Topic<OnEntryBeforeUpdateTopicParams>;\n}\nexport const assignBeforeEntryUpdate = (params: AssignBeforeEntryUpdateParams) => {\n    const { context, onEntryBeforeUpdate } = params;\n\n    onEntryBeforeUpdate.subscribe(async params => {\n        const { entry, model } = params;\n\n        await markLockedFields({\n            model,\n            entry,\n            context\n        });\n    });\n};\n"],"mappings":";;;;;;;AAEA;;AAMO,MAAMA,uBAAuB,GAAIC,MAAD,IAA2C;EAC9E,MAAM;IAAEC,OAAF;IAAWC;EAAX,IAAmCF,MAAzC;EAEAE,mBAAmB,CAACC,SAApB,CAA8B,MAAMH,MAAN,IAAgB;IAC1C,MAAM;MAAEI,KAAF;MAASC;IAAT,IAAmBL,MAAzB;IAEA,MAAM,IAAAM,kCAAA,EAAiB;MACnBD,KADmB;MAEnBD,KAFmB;MAGnBH;IAHmB,CAAjB,CAAN;EAKH,CARD;AASH,CAZM"}

package/crud/contentEntry/entryDataValidation.d.ts

@@ -0,0 +1,10 @@
+import { CmsModel, CmsContext, CmsEntry } from "../../types";
+declare type InputData = Record<string, any>;
+export interface ValidateModelEntryDataParams {
+    context: CmsContext;
+    model: CmsModel;
+    data: InputData;
+    entry?: CmsEntry;
+}
+export declare const validateModelEntryData: (params: ValidateModelEntryDataParams) => Promise<void>;
+export {};

package/crud/contentEntry/entryDataValidation.js

@@ -0,0 +1,200 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.validateModelEntryData = void 0;
+
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+const validateValue = async (args, fieldValidators, value) => {
+  if (!fieldValidators) {
+    return null;
+  }
+
+  const {
+    validatorList,
+    context,
+    field,
+    model,
+    entry
+  } = args;
+
+  try {
+    for (const fieldValidator of fieldValidators) {
+      const name = fieldValidator.name;
+      const validations = validatorList[name];
+
+      if (!validations || validations.length === 0) {
+        return `There are no "${name}" validators defined.`;
+      }
+
+      for (const validate of validations) {
+        const result = await validate({
+          value,
+          context,
+          validator: fieldValidator,
+          field,
+          model,
+          entry
+        });
+
+        if (!result) {
+          return fieldValidator.message;
+        }
+      }
+    }
+  } catch (ex) {
+    return ex.message;
+  }
+
+  return null;
+};
+
+const validatePredefinedValue = (field, value) => {
+  const {
+    enabled = false,
+    values: predefinedValues = []
+  } = field.predefinedValues || {};
+
+  if (!enabled) {
+    return null;
+  } else if (Array.isArray(predefinedValues) === false || predefinedValues.length === 0) {
+    return "Missing predefined values to validate against.";
+  }
+
+  for (const predefinedValue of predefinedValues) {
+    if (predefinedValue.value == value) {
+      return null;
+    }
+  }
+
+  return "Value sent does not match any of the available predefined values.";
+};
+/**
+ * When multiple values is selected we must run validations on the array containing the values
+ * And then on each value in the array
+ */
+
+
+const runFieldMultipleValuesValidations = async args => {
+  const {
+    field,
+    data
+  } = args;
+  const values = data[field.fieldId] || [];
+
+  if (Array.isArray(values) === false) {
+    return `Value of the field "${field.fieldId}" is not an array.`;
+  }
+
+  const valuesError = await validateValue(args, field.listValidation || [], values);
+
+  if (valuesError) {
+    return valuesError;
+  }
+
+  for (const value of values) {
+    const valueError = await validateValue(args, field.validation || [], value);
+
+    if (valueError) {
+      return valueError;
+    }
+
+    const predefinedValueError = validatePredefinedValue(field, value);
+
+    if (predefinedValueError) {
+      return predefinedValueError;
+    }
+  }
+
+  return null;
+};
+/**
+ * Runs validation on given value.
+ */
+
+
+const runFieldValueValidations = async args => {
+  const {
+    data,
+    field
+  } = args;
+  const value = data[field.fieldId];
+  const error = await validateValue(args, field.validation || [], value);
+
+  if (error) {
+    return error;
+  }
+
+  return validatePredefinedValue(field, value);
+};
+
+const execValidation = async args => {
+  if (args.field.multipleValues) {
+    return await runFieldMultipleValuesValidations(args);
+  }
+
+  return await runFieldValueValidations(args);
+};
+
+const validateModelEntryData = async params => {
+  const {
+    context,
+    model,
+    entry,
+    data
+  } = params;
+  /**
+   * To later simplify searching for the validations we map them to a name.
+   * @see CmsModelFieldValidatorPlugin.validator.validate
+   */
+
+  const validatorList = context.plugins.byType("cms-model-field-validator").reduce((acc, plugin) => {
+    const name = plugin.validator.name;
+
+    if (!acc[name]) {
+      acc[name] = [];
+    }
+
+    acc[name].push(plugin.validator.validate);
+    return acc;
+  }, {});
+  /**
+   * Loop through model fields and validate the corresponding data.
+   * Run validation only if the field has validation configured.
+   */
+
+  const invalidFields = [];
+
+  for (const field of model.fields) {
+    const error = await execValidation({
+      model,
+      validatorList,
+      field,
+      data: (0, _objectSpread2.default)((0, _objectSpread2.default)({}, (entry === null || entry === void 0 ? void 0 : entry.values) || {}), data),
+      context,
+      entry
+    });
+
+    if (!error) {
+      continue;
+    }
+
+    invalidFields.push({
+      fieldId: field.fieldId,
+      storageId: field.storageId,
+      error
+    });
+  }
+
+  if (invalidFields.length > 0) {
+    throw new _error.default("Validation failed.", "VALIDATION_FAILED", invalidFields);
+  }
+};
+
+exports.validateModelEntryData = validateModelEntryData;

package/crud/contentEntry/entryDataValidation.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["validateValue","args","fieldValidators","value","validatorList","context","field","model","entry","fieldValidator","name","validations","length","validate","result","validator","message","ex","validatePredefinedValue","enabled","values","predefinedValues","Array","isArray","predefinedValue","runFieldMultipleValuesValidations","data","fieldId","valuesError","listValidation","valueError","validation","predefinedValueError","runFieldValueValidations","error","execValidation","multipleValues","validateModelEntryData","params","plugins","byType","reduce","acc","plugin","push","invalidFields","fields","storageId","WebinyError"],"sources":["entryDataValidation.ts"],"sourcesContent":["import {\n    CmsModel,\n    CmsModelField,\n    CmsModelFieldValidation,\n    CmsContext,\n    CmsModelFieldValidatorPlugin,\n    CmsModelFieldValidatorValidateParams,\n    CmsEntry\n} from \"~/types\";\nimport WebinyError from \"@webiny/error\";\n\ntype PluginValidationCallable = (params: CmsModelFieldValidatorValidateParams) => Promise<boolean>;\ntype PluginValidationList = Record<string, PluginValidationCallable[]>;\ntype InputData = Record<string, any>;\n\ninterface ValidateArgs {\n    validatorList: PluginValidationList;\n    field: CmsModelField;\n    model: CmsModel;\n    data: InputData;\n    context: CmsContext;\n    entry?: CmsEntry;\n}\n\ntype PossibleValue = boolean | number | string | null | undefined;\n\nconst validateValue = async (\n    args: ValidateArgs,\n    fieldValidators: CmsModelFieldValidation[],\n    value: PossibleValue | PossibleValue[]\n): Promise<string | null> => {\n    if (!fieldValidators) {\n        return null;\n    }\n\n    const { validatorList, context, field, model, entry } = args;\n    try {\n        for (const fieldValidator of fieldValidators) {\n            const name = fieldValidator.name;\n            const validations = validatorList[name];\n            if (!validations || validations.length === 0) {\n                return `There are no \"${name}\" validators defined.`;\n            }\n            for (const validate of validations) {\n                const result = await validate({\n                    value,\n                    context,\n                    validator: fieldValidator,\n                    field,\n                    model,\n                    entry\n                });\n                if (!result) {\n                    return fieldValidator.message;\n                }\n            }\n        }\n    } catch (ex) {\n        return ex.message;\n    }\n\n    return null;\n};\n\nconst validatePredefinedValue = (field: CmsModelField, value: any | any[]): string | null => {\n    const { enabled = false, values: predefinedValues = [] } = field.predefinedValues || {};\n    if (!enabled) {\n        return null;\n    } else if (Array.isArray(predefinedValues) === false || predefinedValues.length === 0) {\n        return \"Missing predefined values to validate against.\";\n    }\n    for (const predefinedValue of predefinedValues) {\n        if (predefinedValue.value == value) {\n            return null;\n        }\n    }\n    return \"Value sent does not match any of the available predefined values.\";\n};\n/**\n * When multiple values is selected we must run validations on the array containing the values\n * And then on each value in the array\n */\nconst runFieldMultipleValuesValidations = async (args: ValidateArgs): Promise<string | null> => {\n    const { field, data } = args;\n    const values = data[field.fieldId] || [];\n    if (Array.isArray(values) === false) {\n        return `Value of the field \"${field.fieldId}\" is not an array.`;\n    }\n    const valuesError = await validateValue(args, field.listValidation || [], values);\n    if (valuesError) {\n        return valuesError;\n    }\n    for (const value of values) {\n        const valueError = await validateValue(args, field.validation || [], value);\n        if (valueError) {\n            return valueError;\n        }\n        const predefinedValueError = validatePredefinedValue(field, value);\n        if (predefinedValueError) {\n            return predefinedValueError;\n        }\n    }\n    return null;\n};\n/**\n * Runs validation on given value.\n */\nconst runFieldValueValidations = async (args: ValidateArgs): Promise<string | null> => {\n    const { data, field } = args;\n    const value = data[field.fieldId];\n    const error = await validateValue(args, field.validation || [], value);\n    if (error) {\n        return error;\n    }\n    return validatePredefinedValue(field, value);\n};\n\nconst execValidation = async (args: ValidateArgs): Promise<string | null> => {\n    if (args.field.multipleValues) {\n        return await runFieldMultipleValuesValidations(args);\n    }\n    return await runFieldValueValidations(args);\n};\n\nexport interface ValidateModelEntryDataParams {\n    context: CmsContext;\n    model: CmsModel;\n    data: InputData;\n    entry?: CmsEntry;\n}\nexport const validateModelEntryData = async (params: ValidateModelEntryDataParams) => {\n    const { context, model, entry, data } = params;\n    /**\n     * To later simplify searching for the validations we map them to a name.\n     * @see CmsModelFieldValidatorPlugin.validator.validate\n     */\n    const validatorList: PluginValidationList = context.plugins\n        .byType<CmsModelFieldValidatorPlugin>(\"cms-model-field-validator\")\n        .reduce((acc, plugin) => {\n            const name = plugin.validator.name;\n            if (!acc[name]) {\n                acc[name] = [];\n            }\n            acc[name].push(plugin.validator.validate);\n\n            return acc;\n        }, {} as PluginValidationList);\n\n    /**\n     * Loop through model fields and validate the corresponding data.\n     * Run validation only if the field has validation configured.\n     */\n    const invalidFields = [];\n    for (const field of model.fields) {\n        const error = await execValidation({\n            model,\n            validatorList,\n            field,\n            data: {\n                ...(entry?.values || {}),\n                ...data\n            },\n            context,\n            entry\n        });\n        if (!error) {\n            continue;\n        }\n        invalidFields.push({\n            fieldId: field.fieldId,\n            storageId: field.storageId,\n            error\n        });\n    }\n\n    if (invalidFields.length > 0) {\n        throw new WebinyError(\"Validation failed.\", \"VALIDATION_FAILED\", invalidFields);\n    }\n};\n"],"mappings":";;;;;;;;;;;AASA;;AAiBA,MAAMA,aAAa,GAAG,OAClBC,IADkB,EAElBC,eAFkB,EAGlBC,KAHkB,KAIO;EACzB,IAAI,CAACD,eAAL,EAAsB;IAClB,OAAO,IAAP;EACH;;EAED,MAAM;IAAEE,aAAF;IAAiBC,OAAjB;IAA0BC,KAA1B;IAAiCC,KAAjC;IAAwCC;EAAxC,IAAkDP,IAAxD;;EACA,IAAI;IACA,KAAK,MAAMQ,cAAX,IAA6BP,eAA7B,EAA8C;MAC1C,MAAMQ,IAAI,GAAGD,cAAc,CAACC,IAA5B;MACA,MAAMC,WAAW,GAAGP,aAAa,CAACM,IAAD,CAAjC;;MACA,IAAI,CAACC,WAAD,IAAgBA,WAAW,CAACC,MAAZ,KAAuB,CAA3C,EAA8C;QAC1C,OAAQ,iBAAgBF,IAAK,uBAA7B;MACH;;MACD,KAAK,MAAMG,QAAX,IAAuBF,WAAvB,EAAoC;QAChC,MAAMG,MAAM,GAAG,MAAMD,QAAQ,CAAC;UAC1BV,KAD0B;UAE1BE,OAF0B;UAG1BU,SAAS,EAAEN,cAHe;UAI1BH,KAJ0B;UAK1BC,KAL0B;UAM1BC;QAN0B,CAAD,CAA7B;;QAQA,IAAI,CAACM,MAAL,EAAa;UACT,OAAOL,cAAc,CAACO,OAAtB;QACH;MACJ;IACJ;EACJ,CArBD,CAqBE,OAAOC,EAAP,EAAW;IACT,OAAOA,EAAE,CAACD,OAAV;EACH;;EAED,OAAO,IAAP;AACH,CApCD;;AAsCA,MAAME,uBAAuB,GAAG,CAACZ,KAAD,EAAuBH,KAAvB,KAA6D;EACzF,MAAM;IAAEgB,OAAO,GAAG,KAAZ;IAAmBC,MAAM,EAAEC,gBAAgB,GAAG;EAA9C,IAAqDf,KAAK,CAACe,gBAAN,IAA0B,EAArF;;EACA,IAAI,CAACF,OAAL,EAAc;IACV,OAAO,IAAP;EACH,CAFD,MAEO,IAAIG,KAAK,CAACC,OAAN,CAAcF,gBAAd,MAAoC,KAApC,IAA6CA,gBAAgB,CAACT,MAAjB,KAA4B,CAA7E,EAAgF;IACnF,OAAO,gDAAP;EACH;;EACD,KAAK,MAAMY,eAAX,IAA8BH,gBAA9B,EAAgD;IAC5C,IAAIG,eAAe,CAACrB,KAAhB,IAAyBA,KAA7B,EAAoC;MAChC,OAAO,IAAP;IACH;EACJ;;EACD,OAAO,mEAAP;AACH,CAbD;AAcA;AACA;AACA;AACA;;;AACA,MAAMsB,iCAAiC,GAAG,MAAOxB,IAAP,IAAsD;EAC5F,MAAM;IAAEK,KAAF;IAASoB;EAAT,IAAkBzB,IAAxB;EACA,MAAMmB,MAAM,GAAGM,IAAI,CAACpB,KAAK,CAACqB,OAAP,CAAJ,IAAuB,EAAtC;;EACA,IAAIL,KAAK,CAACC,OAAN,CAAcH,MAAd,MAA0B,KAA9B,EAAqC;IACjC,OAAQ,uBAAsBd,KAAK,CAACqB,OAAQ,oBAA5C;EACH;;EACD,MAAMC,WAAW,GAAG,MAAM5B,aAAa,CAACC,IAAD,EAAOK,KAAK,CAACuB,cAAN,IAAwB,EAA/B,EAAmCT,MAAnC,CAAvC;;EACA,IAAIQ,WAAJ,EAAiB;IACb,OAAOA,WAAP;EACH;;EACD,KAAK,MAAMzB,KAAX,IAAoBiB,MAApB,EAA4B;IACxB,MAAMU,UAAU,GAAG,MAAM9B,aAAa,CAACC,IAAD,EAAOK,KAAK,CAACyB,UAAN,IAAoB,EAA3B,EAA+B5B,KAA/B,CAAtC;;IACA,IAAI2B,UAAJ,EAAgB;MACZ,OAAOA,UAAP;IACH;;IACD,MAAME,oBAAoB,GAAGd,uBAAuB,CAACZ,KAAD,EAAQH,KAAR,CAApD;;IACA,IAAI6B,oBAAJ,EAA0B;MACtB,OAAOA,oBAAP;IACH;EACJ;;EACD,OAAO,IAAP;AACH,CArBD;AAsBA;AACA;AACA;;;AACA,MAAMC,wBAAwB,GAAG,MAAOhC,IAAP,IAAsD;EACnF,MAAM;IAAEyB,IAAF;IAAQpB;EAAR,IAAkBL,IAAxB;EACA,MAAME,KAAK,GAAGuB,IAAI,CAACpB,KAAK,CAACqB,OAAP,CAAlB;EACA,MAAMO,KAAK,GAAG,MAAMlC,aAAa,CAACC,IAAD,EAAOK,KAAK,CAACyB,UAAN,IAAoB,EAA3B,EAA+B5B,KAA/B,CAAjC;;EACA,IAAI+B,KAAJ,EAAW;IACP,OAAOA,KAAP;EACH;;EACD,OAAOhB,uBAAuB,CAACZ,KAAD,EAAQH,KAAR,CAA9B;AACH,CARD;;AAUA,MAAMgC,cAAc,GAAG,MAAOlC,IAAP,IAAsD;EACzE,IAAIA,IAAI,CAACK,KAAL,CAAW8B,cAAf,EAA+B;IAC3B,OAAO,MAAMX,iCAAiC,CAACxB,IAAD,CAA9C;EACH;;EACD,OAAO,MAAMgC,wBAAwB,CAAChC,IAAD,CAArC;AACH,CALD;;AAaO,MAAMoC,sBAAsB,GAAG,MAAOC,MAAP,IAAgD;EAClF,MAAM;IAAEjC,OAAF;IAAWE,KAAX;IAAkBC,KAAlB;IAAyBkB;EAAzB,IAAkCY,MAAxC;EACA;AACJ;AACA;AACA;;EACI,MAAMlC,aAAmC,GAAGC,OAAO,CAACkC,OAAR,CACvCC,MADuC,CACF,2BADE,EAEvCC,MAFuC,CAEhC,CAACC,GAAD,EAAMC,MAAN,KAAiB;IACrB,MAAMjC,IAAI,GAAGiC,MAAM,CAAC5B,SAAP,CAAiBL,IAA9B;;IACA,IAAI,CAACgC,GAAG,CAAChC,IAAD,CAAR,EAAgB;MACZgC,GAAG,CAAChC,IAAD,CAAH,GAAY,EAAZ;IACH;;IACDgC,GAAG,CAAChC,IAAD,CAAH,CAAUkC,IAAV,CAAeD,MAAM,CAAC5B,SAAP,CAAiBF,QAAhC;IAEA,OAAO6B,GAAP;EACH,CAVuC,EAUrC,EAVqC,CAA5C;EAYA;AACJ;AACA;AACA;;EACI,MAAMG,aAAa,GAAG,EAAtB;;EACA,KAAK,MAAMvC,KAAX,IAAoBC,KAAK,CAACuC,MAA1B,EAAkC;IAC9B,MAAMZ,KAAK,GAAG,MAAMC,cAAc,CAAC;MAC/B5B,KAD+B;MAE/BH,aAF+B;MAG/BE,KAH+B;MAI/BoB,IAAI,8DACI,CAAAlB,KAAK,SAAL,IAAAA,KAAK,WAAL,YAAAA,KAAK,CAAEY,MAAP,KAAiB,EADrB,GAEGM,IAFH,CAJ2B;MAQ/BrB,OAR+B;MAS/BG;IAT+B,CAAD,CAAlC;;IAWA,IAAI,CAAC0B,KAAL,EAAY;MACR;IACH;;IACDW,aAAa,CAACD,IAAd,CAAmB;MACfjB,OAAO,EAAErB,KAAK,CAACqB,OADA;MAEfoB,SAAS,EAAEzC,KAAK,CAACyC,SAFF;MAGfb;IAHe,CAAnB;EAKH;;EAED,IAAIW,aAAa,CAACjC,MAAd,GAAuB,CAA3B,EAA8B;IAC1B,MAAM,IAAIoC,cAAJ,CAAgB,oBAAhB,EAAsC,mBAAtC,EAA2DH,aAA3D,CAAN;EACH;AACJ,CAhDM"}

package/crud/contentEntry/markLockedFields.d.ts

@@ -0,0 +1,13 @@
+import { CmsEntry, CmsModel, CmsContext } from "../../types";
+interface MarkLockedFieldsParams {
+    model: CmsModel;
+    entry: CmsEntry;
+    context: CmsContext;
+}
+export declare const markLockedFields: (params: MarkLockedFieldsParams) => Promise<void>;
+export interface MarkFieldsUnlockedParams {
+    context: CmsContext;
+    model: CmsModel;
+}
+export declare const markUnlockedFields: (params: MarkFieldsUnlockedParams) => Promise<void>;
+export {};