@webiny/api-headless-cms 0.0.0-unstable.40876133bb → 0.0.0-unstable.496cf268ac

package/crud/contentModel.crud.js

@@ -1,106 +1,47 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createModelsCrud = void 0;
-
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
-
 var _dataloader = _interopRequireDefault(require("dataloader"));
-
+var _error = _interopRequireDefault(require("@webiny/error"));
 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"));
-
+var _validation = require("./contentModel/validation");
+var _utils = require("@webiny/utils");
+var _defaultFields = require("./contentModel/defaultFields");
+var _removeUndefinedValues = require("../utils/removeUndefinedValues");
+var _modelApiName = require("./contentModel/compatibility/modelApiName");
+const _excluded = ["defaultFields"];
 /**
- * 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.
+ * Given a model, return an array of tags ensuring the `type` tag is set.
  */
-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;
-  }
-  /**
-   * 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;
+const ensureTypeTag = model => {
+  // Let's make sure we have a `type` tag assigned.
+  // If `type` tag is not set, set it to a default one (`model`).
+  const tags = model.tags || [];
+  if (!tags.some(tag => tag.startsWith("type:"))) {
+    tags.push("type:model");
   }
-
-  return attachStorageIdToFields(model.fields);
+  return tags;
 };
-
 const createModelsCrud = params => {
   const {
     getTenant,
@@ -119,105 +60,86 @@ const createModelsCrud = params => {
       });
       return [models.map(model => {
         return (0, _objectSpread2.default)((0, _objectSpread2.default)({}, model), {}, {
-          fields: attachStorageIdToModelFields(model),
+          tags: ensureTypeTag(model),
           tenant: model.tenant || getTenant().id,
-          locale: model.locale || getLocale().code
+          locale: model.locale || getLocale().code,
+          /**
+           * TODO: remove in v5.36.0
+           * This is for backward compatibility while migrations are not yet executed.
+           */
+          singularApiName: (0, _modelApiName.ensureSingularApiName)(model),
+          pluralApiName: (0, _modelApiName.ensurePluralApiName)(model)
         });
       })];
     })
   };
-
   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;
-    const models = context.plugins.byType(_CmsModelPlugin.CmsModelPlugin.type)
+    return context.plugins.byType(_CmsModelPlugin.CmsModelPlugin.type)
     /**
      * 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
+        tenant: modelTenant,
+        locale: modelLocale
       } = plugin.contentModel;
-
-      if (t && t !== tenant) {
+      if (modelTenant && modelTenant !== tenant) {
         return false;
-      } else if (l && l !== locale) {
+      } else if (modelLocale && modelLocale !== locale) {
         return false;
       }
-
       return true;
     }).map(plugin => {
       return (0, _objectSpread2.default)((0, _objectSpread2.default)({}, plugin.contentModel), {}, {
+        tags: ensureTypeTag(plugin.contentModel),
         tenant,
         locale,
         webinyVersion: context.WEBINY_VERSION
       });
     });
-    /**
-     * 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 (0, _objectSpread2.default)((0, _objectSpread2.default)({}, model), {}, {
+      tags: ensureTypeTag(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();
@@ -225,11 +147,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);
@@ -237,45 +157,54 @@ 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);
-  }; // create
-
+  };
 
+  /**
+   * Create
+   */
   const onModelBeforeCreate = (0, _pubsub.createTopic)("cms.onModelBeforeCreate");
-  const onModelAfterCreate = (0, _pubsub.createTopic)("cms.onModelAfterCreate"); // create from
-
+  const onModelAfterCreate = (0, _pubsub.createTopic)("cms.onModelAfterCreate");
+  const onModelCreateError = (0, _pubsub.createTopic)("cms.onModelCreateError");
+  /**
+   * Create from / clone
+   */
   const onModelBeforeCreateFrom = (0, _pubsub.createTopic)("cms.onModelBeforeCreateFrom");
-  const onModelAfterCreateFrom = (0, _pubsub.createTopic)("cms.onModelAfterCreateFrom"); // update
-
+  const onModelAfterCreateFrom = (0, _pubsub.createTopic)("cms.onModelAfterCreateFrom");
+  const onModelCreateFromError = (0, _pubsub.createTopic)("cms.onModelCreateFromError");
+  /**
+   * Update
+   */
   const onModelBeforeUpdate = (0, _pubsub.createTopic)("cms.onModelBeforeUpdate");
-  const onModelAfterUpdate = (0, _pubsub.createTopic)("cms.onModelAfterUpdate"); // delete
-
+  const onModelAfterUpdate = (0, _pubsub.createTopic)("cms.onModelAfterUpdate");
+  const onModelUpdateError = (0, _pubsub.createTopic)("cms.onModelUpdateError");
+  /**
+   * Delete
+   */
   const onModelBeforeDelete = (0, _pubsub.createTopic)("cms.onModelBeforeDelete");
   const onModelAfterDelete = (0, _pubsub.createTopic)("cms.onModelAfterDelete");
+  const onModelDeleteError = (0, _pubsub.createTopic)("cms.onModelDeleteError");
+  /**
+   * Initialize
+   */
   const onModelInitialize = (0, _pubsub.createTopic)("cms.onModelInitialize");
   /**
    * We need to assign some default behaviors.
    */
-
   (0, _beforeCreate.assignModelBeforeCreate)({
     onModelBeforeCreate,
     onModelBeforeCreateFrom,
-    plugins: context.plugins,
+    context,
     storageOperations
   });
   (0, _afterCreate.assignModelAfterCreate)({
@@ -284,8 +213,7 @@ const createModelsCrud = params => {
   });
   (0, _beforeUpdate.assignModelBeforeUpdate)({
     onModelBeforeUpdate,
-    plugins: context.plugins,
-    storageOperations
+    context
   });
   (0, _afterUpdate.assignModelAfterUpdate)({
     context,
@@ -316,43 +244,57 @@ const createModelsCrud = params => {
     onAfterModelUpdate: onModelAfterUpdate,
     onBeforeModelDelete: onModelBeforeDelete,
     onAfterModelDelete: onModelAfterDelete,
-
     /**
      * Released in 5.34.0
      */
     onModelBeforeCreate,
     onModelAfterCreate,
+    onModelCreateError,
     onModelBeforeCreateFrom,
     onModelAfterCreateFrom,
+    onModelCreateFromError,
     onModelBeforeUpdate,
     onModelAfterUpdate,
+    onModelUpdateError,
     onModelBeforeDelete,
     onModelAfterDelete,
+    onModelDeleteError,
     onModelInitialize,
     clearModelsCache,
     getModel,
     listModels,
-
-    async createModel(inputData) {
+    async createModel(input) {
       await checkModelPermissions("w");
-      const createdData = new _models.CreateContentModelModel().populate(inputData);
-      await createdData.validate();
-      const input = await createdData.toJSON();
+      const result = await (0, _validation.createModelCreateValidation)().safeParseAsync(input);
+      if (!result.success) {
+        throw (0, _utils.createZodError)(result.error);
+      }
+      /**
+       * We need to extract the defaultFields because it is not for the CmsModel object.
+       */
+      const _removeUndefinedValue = (0, _removeUndefinedValues.removeUndefinedValues)(result.data),
+        {
+          defaultFields
+        } = _removeUndefinedValue,
+        data = (0, _objectWithoutProperties2.default)(_removeUndefinedValue, _excluded);
+      if (defaultFields) {
+        (0, _defaultFields.assignModelDefaultFields)(data);
+      }
       context.security.disableAuthorization();
-      const group = await context.cms.getGroup(input.group);
+      const group = await context.cms.getGroup(data.group);
       context.security.enableAuthorization();
-
       if (!group) {
-        throw new _handlerGraphql.NotFoundError(`There is no group "${input.group}".`);
+        throw new _handlerGraphql.NotFoundError(`There is no group "${data.group}".`);
       }
-
-      const fields = await (0, _createFieldModels.createFieldModels)(input.fields);
       const identity = getIdentity();
-      const model = {
-        name: input.name,
-        description: input.description || "",
-        modelId: input.modelId || "",
+      const model = (0, _objectSpread2.default)((0, _objectSpread2.default)({}, data), {}, {
+        modelId: data.modelId || "",
+        singularApiName: data.singularApiName,
+        pluralApiName: data.pluralApiName,
         titleFieldId: "id",
+        descriptionFieldId: null,
+        imageFieldId: null,
+        description: data.description || "",
         locale: getLocale().code,
         tenant: getTenant().id,
         group: {
@@ -366,27 +308,34 @@ const createModelsCrud = params => {
         },
         createdOn: new Date().toISOString(),
         savedOn: new Date().toISOString(),
-        fields,
         lockedFields: [],
-        layout: input.layout || [],
         webinyVersion: context.WEBINY_VERSION
-      };
-      await onModelBeforeCreate.publish({
-        input,
-        model
-      });
-      const createdModel = await storageOperations.models.create({
-        model
       });
-      loaders.listModels.clearAll();
-      await updateManager(context, model);
-      await onModelAfterCreate.publish({
-        input,
-        model: createdModel
-      });
-      return createdModel;
+      model.tags = ensureTypeTag(model);
+      try {
+        await onModelBeforeCreate.publish({
+          input: data,
+          model
+        });
+        const createdModel = await storageOperations.models.create({
+          model
+        });
+        loaders.listModels.clearAll();
+        await updateManager(context, model);
+        await onModelAfterCreate.publish({
+          input: data,
+          model: createdModel
+        });
+        return createdModel;
+      } catch (ex) {
+        await onModelCreateError.publish({
+          input: data,
+          model,
+          error: ex
+        });
+        throw ex;
+      }
     },
-
     /**
      * Method does not check for permissions or ownership.
      * @internal
@@ -401,70 +350,74 @@ const createModelsCrud = params => {
         locale: initialModel.locale || getLocale().code,
         webinyVersion: context.WEBINY_VERSION
       });
-      await onModelBeforeUpdate.publish({
-        input: {},
-        original,
-        model
-      });
-      const resultModel = await storageOperations.models.update({
-        model
-      });
-      await updateManager(context, resultModel);
-      loaders.listModels.clearAll();
-      await onModelAfterUpdate.publish({
-        input: {},
-        original,
-        model: resultModel
-      });
-      return resultModel;
+      try {
+        await onModelBeforeUpdate.publish({
+          input: {},
+          original,
+          model
+        });
+        const resultModel = await storageOperations.models.update({
+          model
+        });
+        await updateManager(context, resultModel);
+        loaders.listModels.clearAll();
+        await onModelAfterUpdate.publish({
+          input: {},
+          original,
+          model: resultModel
+        });
+        return resultModel;
+      } catch (ex) {
+        await onModelUpdateError.publish({
+          input: {},
+          original,
+          model,
+          error: ex
+        });
+        throw ex;
+      }
     },
-
-    async createModelFrom(modelId, data) {
+    async createModelFrom(modelId, userInput) {
       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,
-        modelId: data.modelId,
-        description: data.description || original.description,
-        group: data.group,
-        locale: data.locale
-      });
-      await createdData.validate();
-      const input = await createdData.toJSON();
-      const locale = await context.i18n.getLocale(input.locale || original.locale);
-
+      const result = await (0, _validation.createModelCreateFromValidation)().safeParseAsync((0, _objectSpread2.default)((0, _objectSpread2.default)({}, userInput), {}, {
+        description: userInput.description || original.description
+      }));
+      if (!result.success) {
+        throw (0, _utils.createZodError)(result.error);
+      }
+      const data = (0, _removeUndefinedValues.removeUndefinedValues)(result.data);
+      const locale = await context.i18n.getLocale(data.locale || original.locale);
       if (!locale) {
-        throw new _handlerGraphql.NotFoundError(`There is no locale "${input.locale}".`);
+        throw new _handlerGraphql.NotFoundError(`There is no locale "${data.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,
+        id: data.group,
         tenant: original.tenant,
         locale: locale.code
       });
-
       if (!group) {
-        throw new _handlerGraphql.NotFoundError(`There is no group "${input.group}".`);
+        throw new _handlerGraphql.NotFoundError(`There is no group "${data.group}".`);
       }
-
       const identity = getIdentity();
       const model = (0, _objectSpread2.default)((0, _objectSpread2.default)({}, original), {}, {
+        singularApiName: data.singularApiName,
+        pluralApiName: data.pluralApiName,
         locale: locale.code,
         group: {
           id: group.id,
           name: group.name
         },
-        name: input.name,
-        modelId: input.modelId || "",
-        description: input.description || "",
+        icon: data.icon,
+        name: data.name,
+        modelId: data.modelId || "",
+        description: data.description || "",
         createdBy: {
           id: identity.id,
           displayName: identity.displayName,
@@ -475,112 +428,133 @@ const createModelsCrud = params => {
         lockedFields: [],
         webinyVersion: context.WEBINY_VERSION
       });
-      await onModelBeforeCreateFrom.publish({
-        input,
-        model,
-        original
-      });
-      const createdModel = await storageOperations.models.create({
-        model
-      });
-      loaders.listModels.clearAll();
-      await updateManager(context, model);
-      await onModelAfterCreateFrom.publish({
-        input,
-        original,
-        model: createdModel
-      });
-      return createdModel;
+      try {
+        await onModelBeforeCreateFrom.publish({
+          input: data,
+          model,
+          original
+        });
+        const createdModel = await storageOperations.models.create({
+          model
+        });
+        loaders.listModels.clearAll();
+        await updateManager(context, model);
+        await onModelAfterCreateFrom.publish({
+          input: data,
+          original,
+          model: createdModel
+        });
+        return createdModel;
+      } catch (ex) {
+        await onModelCreateFromError.publish({
+          input: data,
+          original,
+          model,
+          error: ex
+        });
+        throw ex;
+      }
     },
+    async updateModel(modelId, input) {
+      await checkModelPermissions("w");
 
-    async updateModel(modelId, inputData) {
-      await checkModelPermissions("w"); // Get a model record; this will also perform ownership validation.
-
+      // 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) {
+      const result = await (0, _validation.createModelUpdateValidation)().safeParseAsync(input);
+      if (!result.success) {
+        throw (0, _utils.createZodError)(result.error);
+      }
+      const data = (0, _removeUndefinedValues.removeUndefinedValues)(result.data);
+      if (Object.keys(data).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) {
+      if (data.group) {
         context.security.disableAuthorization();
-        const groupData = await context.cms.getGroup(input.group);
+        const groupData = await context.cms.getGroup(data.group);
         context.security.enableAuthorization();
-
         if (!groupData) {
-          throw new _handlerGraphql.NotFoundError(`There is no group "${input.group}".`);
+          throw new _handlerGraphql.NotFoundError(`There is no group "${data.group}".`);
         }
-
         group = {
           id: groupData.id,
           name: groupData.name
         };
       }
-
-      const fields = await (0, _createFieldModels.createFieldModels)(inputData.fields);
-      const model = (0, _objectSpread2.default)((0, _objectSpread2.default)((0, _objectSpread2.default)({}, original), input), {}, {
+      const model = (0, _objectSpread2.default)((0, _objectSpread2.default)((0, _objectSpread2.default)({}, original), data), {}, {
+        titleFieldId: data.titleFieldId === undefined ? original.titleFieldId : data.titleFieldId,
+        descriptionFieldId: data.descriptionFieldId === undefined ? original.descriptionFieldId : data.descriptionFieldId,
+        imageFieldId: data.imageFieldId === undefined ? original.imageFieldId : data.imageFieldId,
         group,
+        description: data.description || original.description,
         tenant: original.tenant || getTenant().id,
         locale: original.locale || getLocale().code,
         webinyVersion: context.WEBINY_VERSION,
-        fields,
         savedOn: new Date().toISOString()
       });
-      await onModelBeforeUpdate.publish({
-        input,
-        original,
-        model
-      });
-      const resultModel = await storageOperations.models.update({
-        model
-      });
-      await updateManager(context, resultModel);
-      await onModelAfterUpdate.publish({
-        input,
-        original,
-        model: resultModel
-      });
-      return resultModel;
+      model.tags = ensureTypeTag(model);
+      try {
+        await onModelBeforeUpdate.publish({
+          input: data,
+          original,
+          model
+        });
+        const resultModel = await storageOperations.models.update({
+          model
+        });
+        await updateManager(context, resultModel);
+        await onModelAfterUpdate.publish({
+          input: data,
+          original,
+          model: resultModel
+        });
+        return resultModel;
+      } catch (ex) {
+        await onModelUpdateError.publish({
+          input: data,
+          model,
+          original,
+          error: ex
+        });
+        throw ex;
+      }
     },
-
     async deleteModel(modelId) {
       await checkModelPermissions("d");
       const model = await getModel(modelId);
-      await onModelBeforeDelete.publish({
-        model
-      });
-
       try {
-        await storageOperations.models.delete({
+        await onModelBeforeDelete.publish({
+          model
+        });
+        try {
+          await storageOperations.models.delete({
+            model
+          });
+        } catch (ex) {
+          throw new _error.default(ex.message || "Could not delete the content model", ex.code || "CONTENT_MODEL_DELETE_ERROR", {
+            error: ex,
+            modelId: model.modelId
+          });
+        }
+        await onModelAfterDelete.publish({
           model
         });
+        managers.delete(model.modelId);
       } catch (ex) {
-        throw new _error.default(ex.message || "Could not delete the content model", ex.code || "CONTENT_MODEL_DELETE_ERROR", {
-          error: ex,
-          modelId: model.modelId
+        await onModelDeleteError.publish({
+          model,
+          error: ex
         });
+        throw ex;
       }
-
-      await onModelAfterDelete.publish({
-        model
-      });
-      managers.delete(model.modelId);
     },
-
-    async initializeModel(modelId) {
+    async initializeModel(modelId, data) {
       /**
        * We require that users have write permissions to initialize models.
        * Maybe introduce another permission for it?
@@ -588,11 +562,11 @@ const createModelsCrud = params => {
       await checkModelPermissions("w");
       const model = await getModel(modelId);
       await onModelInitialize.publish({
-        model
+        model,
+        data
       });
       return true;
     },
-
     getModelManager,
     getEntryManager: async model => {
       return getModelManager(model);
@@ -601,5 +575,4 @@ const createModelsCrud = params => {
     getEntryManagers: () => managers
   };
 };
-
 exports.createModelsCrud = createModelsCrud;