@webiny/api-headless-cms 0.0.0-unstable.5e7233243f → 0.0.0-unstable.6e5425ee89

package/crud/contentModel.crud.js

@@ -1,90 +1,55 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createModelsCrud = void 0;
-
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
 var _dataloader = _interopRequireDefault(require("dataloader"));
-
 var _handlerGraphql = require("@webiny/handler-graphql");
-
 var _contentModelManagerFactory = require("./contentModel/contentModelManagerFactory");
-
 var _models = require("./contentModel/models");
-
 var _createFieldModels = require("./contentModel/createFieldModels");
-
 var _error = _interopRequireDefault(require("@webiny/error"));
-
 var _pubsub = require("@webiny/pubsub");
-
 var _beforeCreate = require("./contentModel/beforeCreate");
-
 var _beforeUpdate = require("./contentModel/beforeUpdate");
-
 var _beforeDelete = require("./contentModel/beforeDelete");
-
 var _afterCreate = require("./contentModel/afterCreate");
-
 var _afterUpdate = require("./contentModel/afterUpdate");
-
 var _afterDelete = require("./contentModel/afterDelete");
-
 var _afterCreateFrom = require("./contentModel/afterCreateFrom");
-
 var _CmsModelPlugin = require("../plugins/CmsModelPlugin");
-
 var _permissions = require("../utils/permissions");
-
 var _filterAsync = require("../utils/filterAsync");
-
 var _ownership = require("../utils/ownership");
-
 var _access = require("../utils/access");
-
 var _validateModelFields = require("./contentModel/validateModelFields");
-
 var _semver = _interopRequireDefault(require("semver"));
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
 /**
  * TODO: remove for 5.34.0
  * Required because of the 5.33.0 upgrade.
  * Until the upgrade is done, API will break because there is no storageId assigned.
  */
 const featureVersion = _semver.default.coerce("5.33.0");
-
 const attachStorageIdToFields = fields => {
   return fields.map(field => {
     var _field$settings;
-
     if ((_field$settings = field.settings) !== null && _field$settings !== void 0 && _field$settings.fields) {
       field.settings.fields = attachStorageIdToFields(field.settings.fields);
     }
-
     if (!field.storageId) {
       field.storageId = field.fieldId;
     }
-
     return field;
   });
 };
-
 const attachStorageIdToModelFields = model => {
   if (!model.webinyVersion) {
     return model.fields;
   }
-
   const version = _semver.default.coerce(model.webinyVersion);
-
   if (!version) {
     return model.fields;
   }
@@ -92,19 +57,14 @@ const attachStorageIdToModelFields = model => {
    * Unfortunately we need to check for beta and next.
    * TODO remove after 5.33.0
    */
-
-
   if (model.webinyVersion.match(/beta|next/)) {
     return attachStorageIdToFields(model.fields);
   }
-
   if (_semver.default.compare(version, featureVersion) >= 0) {
     return model.fields;
   }
-
   return attachStorageIdToFields(model.fields);
 };
-
 const createModelsCrud = params => {
   const {
     getTenant,
@@ -122,7 +82,7 @@ const createModelsCrud = params => {
         }
       });
       return [models.map(model => {
-        return _objectSpread(_objectSpread({}, model), {}, {
+        return (0, _objectSpread2.default)((0, _objectSpread2.default)({}, model), {}, {
           fields: attachStorageIdToModelFields(model),
           tenant: model.tenant || getTenant().id,
           locale: model.locale || getLocale().code
@@ -130,27 +90,22 @@ const createModelsCrud = params => {
       })];
     })
   };
-
   const clearModelsCache = () => {
     for (const loader of Object.values(loaders)) {
       loader.clearAll();
     }
   };
-
   const managers = new Map();
-
   const updateManager = async (context, model) => {
     const manager = await (0, _contentModelManagerFactory.contentModelManagerFactory)(context, model);
     managers.set(model.modelId, manager);
     return manager;
   };
-
   const checkModelPermissions = check => {
     return (0, _permissions.checkPermissions)(context, "cms.contentModel", {
       rwd: check
     });
   };
-
   const getModelsAsPlugins = () => {
     const tenant = getTenant().id;
     const locale = getLocale().code;
@@ -158,22 +113,19 @@ const createModelsCrud = params => {
     /**
      * We need to filter out models that are not for this tenant or locale.
      * If it does not have tenant or locale define, it is for every locale and tenant
-     */
-    .filter(plugin => {
+     */.filter(plugin => {
       const {
         tenant: t,
         locale: l
       } = plugin.contentModel;
-
       if (t && t !== tenant) {
         return false;
       } else if (l && l !== locale) {
         return false;
       }
-
       return true;
     }).map(plugin => {
-      return _objectSpread(_objectSpread({}, plugin.contentModel), {}, {
+      return (0, _objectSpread2.default)((0, _objectSpread2.default)({}, plugin.contentModel), {}, {
         tenant,
         locale,
         webinyVersion: context.WEBINY_VERSION
@@ -182,46 +134,37 @@ const createModelsCrud = params => {
     /**
      * Only point where we can truly validate the user model is in the runtime.
      */
-
     for (const model of models) {
       (0, _validateModelFields.validateModelFields)({
         model,
         plugins: context.plugins
       });
     }
-
     return models;
   };
-
   const modelsGet = async modelId => {
     const pluginModel = getModelsAsPlugins().find(model => model.modelId === modelId);
-
     if (pluginModel) {
       return pluginModel;
     }
-
     const model = await storageOperations.models.get({
       tenant: getTenant().id,
       locale: getLocale().code,
       modelId
     });
-
     if (!model) {
       throw new _handlerGraphql.NotFoundError(`Content model "${modelId}" was not found!`);
     }
-
-    return _objectSpread(_objectSpread({}, model), {}, {
+    return (0, _objectSpread2.default)((0, _objectSpread2.default)({}, model), {}, {
       tenant: model.tenant || getTenant().id,
       locale: model.locale || getLocale().code
     });
   };
-
   const modelsList = async () => {
     const databaseModels = await loaders.listModels.load("listModels");
     const pluginsModels = getModelsAsPlugins();
     return databaseModels.concat(pluginsModels);
   };
-
   const listModels = async () => {
     const permission = await checkModelPermissions("r");
     const models = await modelsList();
@@ -229,11 +172,9 @@ const createModelsCrud = params => {
       if (!(0, _ownership.validateOwnership)(context, permission, model)) {
         return false;
       }
-
       return (0, _access.validateModelAccess)(context, model);
     });
   };
-
   const getModel = async modelId => {
     const permission = await checkModelPermissions("r");
     const model = await modelsGet(modelId);
@@ -241,81 +182,94 @@ const createModelsCrud = params => {
     await (0, _access.checkModelAccess)(context, model);
     return model;
   };
-
   const getModelManager = async target => {
     const modelId = typeof target === "string" ? target : target.modelId;
-
     if (managers.has(modelId)) {
       return managers.get(modelId);
     }
-
     const models = await modelsList();
     const model = models.find(m => m.modelId === modelId);
-
     if (!model) {
       throw new _handlerGraphql.NotFoundError(`There is no content model "${modelId}".`);
     }
-
     return await updateManager(context, model);
   };
 
-  const onBeforeModelCreate = (0, _pubsub.createTopic)();
-  const onAfterModelCreate = (0, _pubsub.createTopic)();
-  const onBeforeModelCreateFrom = (0, _pubsub.createTopic)();
-  const onAfterModelCreateFrom = (0, _pubsub.createTopic)();
-  const onBeforeModelUpdate = (0, _pubsub.createTopic)();
-  const onAfterModelUpdate = (0, _pubsub.createTopic)();
-  const onBeforeModelDelete = (0, _pubsub.createTopic)();
-  const onAfterModelDelete = (0, _pubsub.createTopic)();
+  // create
+  const onModelBeforeCreate = (0, _pubsub.createTopic)("cms.onModelBeforeCreate");
+  const onModelAfterCreate = (0, _pubsub.createTopic)("cms.onModelAfterCreate");
+  // create from
+  const onModelBeforeCreateFrom = (0, _pubsub.createTopic)("cms.onModelBeforeCreateFrom");
+  const onModelAfterCreateFrom = (0, _pubsub.createTopic)("cms.onModelAfterCreateFrom");
+  // update
+  const onModelBeforeUpdate = (0, _pubsub.createTopic)("cms.onModelBeforeUpdate");
+  const onModelAfterUpdate = (0, _pubsub.createTopic)("cms.onModelAfterUpdate");
+  // delete
+  const onModelBeforeDelete = (0, _pubsub.createTopic)("cms.onModelBeforeDelete");
+  const onModelAfterDelete = (0, _pubsub.createTopic)("cms.onModelAfterDelete");
+  const onModelInitialize = (0, _pubsub.createTopic)("cms.onModelInitialize");
   /**
    * We need to assign some default behaviors.
    */
-
-  (0, _beforeCreate.assignBeforeModelCreate)({
-    onBeforeModelCreate,
-    onBeforeModelCreateFrom,
+  (0, _beforeCreate.assignModelBeforeCreate)({
+    onModelBeforeCreate,
+    onModelBeforeCreateFrom,
     plugins: context.plugins,
     storageOperations
   });
-  (0, _afterCreate.assignAfterModelCreate)({
+  (0, _afterCreate.assignModelAfterCreate)({
     context,
-    onAfterModelCreate
+    onModelAfterCreate
   });
-  (0, _beforeUpdate.assignBeforeModelUpdate)({
-    onBeforeModelUpdate,
+  (0, _beforeUpdate.assignModelBeforeUpdate)({
+    onModelBeforeUpdate,
     plugins: context.plugins,
     storageOperations
   });
-  (0, _afterUpdate.assignAfterModelUpdate)({
+  (0, _afterUpdate.assignModelAfterUpdate)({
     context,
-    onAfterModelUpdate
+    onModelAfterUpdate
   });
-  (0, _afterCreateFrom.assignAfterModelCreateFrom)({
+  (0, _afterCreateFrom.assignModelAfterCreateFrom)({
     context,
-    onAfterModelCreateFrom
+    onModelAfterCreateFrom
   });
-  (0, _beforeDelete.assignBeforeModelDelete)({
-    onBeforeModelDelete,
+  (0, _beforeDelete.assignModelBeforeDelete)({
+    onModelBeforeDelete,
     plugins: context.plugins,
     storageOperations
   });
-  (0, _afterDelete.assignAfterModelDelete)({
+  (0, _afterDelete.assignModelAfterDelete)({
     context,
-    onAfterModelDelete
+    onModelAfterDelete
   });
   return {
-    onBeforeModelCreate,
-    onAfterModelCreate,
-    onBeforeModelCreateFrom,
-    onAfterModelCreateFrom,
-    onBeforeModelUpdate,
-    onAfterModelUpdate,
-    onBeforeModelDelete,
-    onAfterModelDelete,
+    /**
+     * Deprecated - will be removed in 5.36.0
+     */
+    onBeforeModelCreate: onModelBeforeCreate,
+    onAfterModelCreate: onModelAfterCreate,
+    onBeforeModelCreateFrom: onModelBeforeCreateFrom,
+    onAfterModelCreateFrom: onModelAfterCreateFrom,
+    onBeforeModelUpdate: onModelBeforeUpdate,
+    onAfterModelUpdate: onModelAfterUpdate,
+    onBeforeModelDelete: onModelBeforeDelete,
+    onAfterModelDelete: onModelAfterDelete,
+    /**
+     * Released in 5.34.0
+     */
+    onModelBeforeCreate,
+    onModelAfterCreate,
+    onModelBeforeCreateFrom,
+    onModelAfterCreateFrom,
+    onModelBeforeUpdate,
+    onModelAfterUpdate,
+    onModelBeforeDelete,
+    onModelAfterDelete,
+    onModelInitialize,
     clearModelsCache,
     getModel,
     listModels,
-
     async createModel(inputData) {
       await checkModelPermissions("w");
       const createdData = new _models.CreateContentModelModel().populate(inputData);
@@ -324,11 +278,9 @@ const createModelsCrud = params => {
       context.security.disableAuthorization();
       const group = await context.cms.getGroup(input.group);
       context.security.enableAuthorization();
-
       if (!group) {
         throw new _handlerGraphql.NotFoundError(`There is no group "${input.group}".`);
       }
-
       const fields = await (0, _createFieldModels.createFieldModels)(input.fields);
       const identity = getIdentity();
       const model = {
@@ -354,7 +306,7 @@ const createModelsCrud = params => {
         layout: input.layout || [],
         webinyVersion: context.WEBINY_VERSION
       };
-      await onBeforeModelCreate.publish({
+      await onModelBeforeCreate.publish({
         input,
         model
       });
@@ -363,13 +315,12 @@ const createModelsCrud = params => {
       });
       loaders.listModels.clearAll();
       await updateManager(context, model);
-      await onAfterModelCreate.publish({
+      await onModelAfterCreate.publish({
         input,
         model: createdModel
       });
       return createdModel;
     },
-
     /**
      * Method does not check for permissions or ownership.
      * @internal
@@ -379,14 +330,12 @@ const createModelsCrud = params => {
         model: initialModel,
         original
       } = params;
-
-      const model = _objectSpread(_objectSpread({}, initialModel), {}, {
+      const model = (0, _objectSpread2.default)((0, _objectSpread2.default)({}, initialModel), {}, {
         tenant: initialModel.tenant || getTenant().id,
         locale: initialModel.locale || getLocale().code,
         webinyVersion: context.WEBINY_VERSION
       });
-
-      await onBeforeModelUpdate.publish({
+      await onModelBeforeUpdate.publish({
         input: {},
         original,
         model
@@ -396,20 +345,18 @@ const createModelsCrud = params => {
       });
       await updateManager(context, resultModel);
       loaders.listModels.clearAll();
-      await onAfterModelUpdate.publish({
+      await onModelAfterUpdate.publish({
         input: {},
         original,
         model: resultModel
       });
       return resultModel;
     },
-
     async createModelFrom(modelId, data) {
       await checkModelPermissions("w");
       /**
        * Get a model record; this will also perform ownership validation.
        */
-
       const original = await getModel(modelId);
       const createdData = new _models.CreateContentModelModelFrom().populate({
         name: data.name,
@@ -421,28 +368,22 @@ const createModelsCrud = params => {
       await createdData.validate();
       const input = await createdData.toJSON();
       const locale = await context.i18n.getLocale(input.locale || original.locale);
-
       if (!locale) {
         throw new _handlerGraphql.NotFoundError(`There is no locale "${input.locale}".`);
       }
       /**
        * Use storage operations directly because we cannot get group from different locale via context methods.
        */
-
-
       const group = await context.cms.storageOperations.groups.get({
         id: input.group,
         tenant: original.tenant,
         locale: locale.code
       });
-
       if (!group) {
         throw new _handlerGraphql.NotFoundError(`There is no group "${input.group}".`);
       }
-
       const identity = getIdentity();
-
-      const model = _objectSpread(_objectSpread({}, original), {}, {
+      const model = (0, _objectSpread2.default)((0, _objectSpread2.default)({}, original), {}, {
         locale: locale.code,
         group: {
           id: group.id,
@@ -461,8 +402,7 @@ const createModelsCrud = params => {
         lockedFields: [],
         webinyVersion: context.WEBINY_VERSION
       });
-
-      await onBeforeModelCreateFrom.publish({
+      await onModelBeforeCreateFrom.publish({
         input,
         model,
         original
@@ -472,54 +412,47 @@ const createModelsCrud = params => {
       });
       loaders.listModels.clearAll();
       await updateManager(context, model);
-      await onAfterModelCreateFrom.publish({
+      await onModelAfterCreateFrom.publish({
         input,
         original,
         model: createdModel
       });
       return createdModel;
     },
-
     async updateModel(modelId, inputData) {
-      await checkModelPermissions("w"); // Get a model record; this will also perform ownership validation.
+      await checkModelPermissions("w");
 
+      // Get a model record; this will also perform ownership validation.
       const original = await getModel(modelId);
       const updatedData = new _models.UpdateContentModelModel().populate(inputData);
       await updatedData.validate();
       const input = await updatedData.toJSON({
         onlyDirty: true
       });
-
       if (Object.keys(input).length === 0) {
         /**
          * We need to return the original if nothing is to be updated.
          */
         return original;
       }
-
       let group = {
         id: original.group.id,
         name: original.group.name
       };
-
       if (input.group) {
         context.security.disableAuthorization();
         const groupData = await context.cms.getGroup(input.group);
         context.security.enableAuthorization();
-
         if (!groupData) {
           throw new _handlerGraphql.NotFoundError(`There is no group "${input.group}".`);
         }
-
         group = {
           id: groupData.id,
           name: groupData.name
         };
       }
-
       const fields = await (0, _createFieldModels.createFieldModels)(inputData.fields);
-
-      const model = _objectSpread(_objectSpread(_objectSpread({}, original), input), {}, {
+      const model = (0, _objectSpread2.default)((0, _objectSpread2.default)((0, _objectSpread2.default)({}, original), input), {}, {
         group,
         tenant: original.tenant || getTenant().id,
         locale: original.locale || getLocale().code,
@@ -527,8 +460,7 @@ const createModelsCrud = params => {
         fields,
         savedOn: new Date().toISOString()
       });
-
-      await onBeforeModelUpdate.publish({
+      await onModelBeforeUpdate.publish({
         input,
         original,
         model
@@ -537,21 +469,19 @@ const createModelsCrud = params => {
         model
       });
       await updateManager(context, resultModel);
-      await onAfterModelUpdate.publish({
+      await onModelAfterUpdate.publish({
         input,
         original,
         model: resultModel
       });
       return resultModel;
     },
-
     async deleteModel(modelId) {
       await checkModelPermissions("d");
       const model = await getModel(modelId);
-      await onBeforeModelDelete.publish({
+      await onModelBeforeDelete.publish({
         model
       });
-
       try {
         await storageOperations.models.delete({
           model
@@ -562,13 +492,23 @@ const createModelsCrud = params => {
           modelId: model.modelId
         });
       }
-
-      await onAfterModelDelete.publish({
+      await onModelAfterDelete.publish({
         model
       });
       managers.delete(model.modelId);
     },
-
+    async initializeModel(modelId) {
+      /**
+       * We require that users have write permissions to initialize models.
+       * Maybe introduce another permission for it?
+       */
+      await checkModelPermissions("w");
+      const model = await getModel(modelId);
+      await onModelInitialize.publish({
+        model
+      });
+      return true;
+    },
     getModelManager,
     getEntryManager: async model => {
       return getModelManager(model);
@@ -577,5 +517,4 @@ const createModelsCrud = params => {
     getEntryManagers: () => managers
   };
 };
-
 exports.createModelsCrud = createModelsCrud;