@webiny/api-headless-cms 0.0.0-unstable.d65ec29d44 → 0.0.0-unstable.da99e0b846

package/crud/contentModel.crud.js

@@ -5,6 +5,7 @@ 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"));
@@ -25,6 +26,9 @@ var _ownership = require("../utils/ownership");
 var _access = require("../utils/access");
 var _validation = require("./contentModel/validation");
 var _utils = require("@webiny/utils");
+var _defaultFields = require("./contentModel/defaultFields");
+var _modelApiName = require("./contentModel/compatibility/modelApiName");
+const _excluded = ["defaultFields"];
 /**
  * Given a model, return an array of tags ensuring the `type` tag is set.
  */
@@ -57,7 +61,13 @@ const createModelsCrud = params => {
         return (0, _objectSpread2.default)((0, _objectSpread2.default)({}, 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)
         });
       })];
     })
@@ -130,21 +140,25 @@ const createModelsCrud = params => {
     return databaseModels.concat(pluginsModels);
   };
   const listModels = async () => {
-    const permission = await checkModelPermissions("r");
-    const models = await modelsList();
-    return (0, _filterAsync.filterAsync)(models, async model => {
-      if (!(0, _ownership.validateOwnership)(context, permission, model)) {
-        return false;
-      }
-      return (0, _access.validateModelAccess)(context, model);
+    return context.benchmark.measure("headlessCms.crud.models.listModels", async () => {
+      const permission = await checkModelPermissions("r");
+      const models = await modelsList();
+      return (0, _filterAsync.filterAsync)(models, async model => {
+        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);
-    (0, _ownership.checkOwnership)(context, permission, model);
-    await (0, _access.checkModelAccess)(context, model);
-    return model;
+    return context.benchmark.measure("headlessCms.crud.models.getModel", async () => {
+      const permission = await checkModelPermissions("r");
+      const model = await modelsGet(modelId);
+      (0, _ownership.checkOwnership)(context, permission, model);
+      await (0, _access.checkModelAccess)(context, model);
+      return model;
+    });
   };
   const getModelManager = async target => {
     const modelId = typeof target === "string" ? target : target.modelId;
@@ -221,6 +235,311 @@ const createModelsCrud = params => {
     context,
     onModelAfterDelete
   });
+
+  /**
+   * CRUD methods
+   */
+  const createModel = async input => {
+    await checkModelPermissions("w");
+    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, _utils.removeUndefinedValues)(result.data),
+      {
+        defaultFields
+      } = _removeUndefinedValue,
+      data = (0, _objectWithoutProperties2.default)(_removeUndefinedValue, _excluded);
+    if (defaultFields) {
+      (0, _defaultFields.assignModelDefaultFields)(data);
+    }
+    const group = await context.security.withoutAuthorization(async () => {
+      return context.cms.getGroup(data.group);
+    });
+    if (!group) {
+      throw new _handlerGraphql.NotFoundError(`There is no group "${data.group}".`);
+    }
+    const identity = getIdentity();
+    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: {
+        id: group.id,
+        name: group.name
+      },
+      createdBy: {
+        id: identity.id,
+        displayName: identity.displayName,
+        type: identity.type
+      },
+      createdOn: new Date().toISOString(),
+      savedOn: new Date().toISOString(),
+      lockedFields: [],
+      webinyVersion: context.WEBINY_VERSION
+    });
+    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;
+    }
+  };
+  const updateModel = async (modelId, input) => {
+    await checkModelPermissions("w");
+
+    // Get a model record; this will also perform ownership validation.
+    const original = await getModel(modelId);
+    const result = await (0, _validation.createModelUpdateValidation)().safeParseAsync(input);
+    if (!result.success) {
+      throw (0, _utils.createZodError)(result.error);
+    }
+    const data = (0, _utils.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
+    };
+    const groupId = data.group;
+    if (groupId) {
+      const groupData = await context.security.withoutAuthorization(async () => {
+        return context.cms.getGroup(groupId);
+      });
+      if (!groupData) {
+        throw new _handlerGraphql.NotFoundError(`There is no group "${groupId}".`);
+      }
+      group = {
+        id: groupData.id,
+        name: groupData.name
+      };
+    }
+    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,
+      savedOn: new Date().toISOString()
+    });
+    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;
+    }
+  };
+  const updateModelDirect = async params => {
+    const {
+      model: initialModel,
+      original
+    } = params;
+    const model = (0, _objectSpread2.default)((0, _objectSpread2.default)({}, initialModel), {}, {
+      tenant: initialModel.tenant || getTenant().id,
+      locale: initialModel.locale || getLocale().code,
+      webinyVersion: context.WEBINY_VERSION
+    });
+    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;
+    }
+  };
+  const createModelFrom = async (modelId, input) => {
+    await checkModelPermissions("w");
+    /**
+     * Get a model record; this will also perform ownership validation.
+     */
+    const original = await getModel(modelId);
+    const result = await (0, _validation.createModelCreateFromValidation)().safeParseAsync((0, _objectSpread2.default)((0, _objectSpread2.default)({}, input), {}, {
+      description: input.description || original.description
+    }));
+    if (!result.success) {
+      throw (0, _utils.createZodError)(result.error);
+    }
+    const data = (0, _utils.removeUndefinedValues)(result.data);
+    const locale = await context.i18n.getLocale(data.locale || original.locale);
+    if (!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: data.group,
+      tenant: original.tenant,
+      locale: locale.code
+    });
+    if (!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
+      },
+      icon: data.icon,
+      name: data.name,
+      modelId: data.modelId || "",
+      description: data.description || "",
+      createdBy: {
+        id: identity.id,
+        displayName: identity.displayName,
+        type: identity.type
+      },
+      createdOn: new Date().toISOString(),
+      savedOn: new Date().toISOString(),
+      lockedFields: [],
+      webinyVersion: context.WEBINY_VERSION
+    });
+    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;
+    }
+  };
+  const deleteModel = async modelId => {
+    await checkModelPermissions("d");
+    const model = await getModel(modelId);
+    try {
+      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) {
+      await onModelDeleteError.publish({
+        model,
+        error: ex
+      });
+      throw ex;
+    }
+  };
+  const initializeModel = async (modelId, data) => {
+    /**
+     * 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,
+      data
+    });
+    return true;
+  };
   return {
     /**
      * Deprecated - will be removed in 5.36.0
@@ -253,296 +572,38 @@ const createModelsCrud = params => {
     getModel,
     listModels,
     async createModel(input) {
-      await checkModelPermissions("w");
-      const result = await (0, _validation.createModelCreateValidation)().safeParseAsync(input);
-      if (!result.success) {
-        throw (0, _utils.createZodError)(result.error);
-      }
-      const data = result.data;
-      context.security.disableAuthorization();
-      const group = await context.cms.getGroup(data.group);
-      context.security.enableAuthorization();
-      if (!group) {
-        throw new _handlerGraphql.NotFoundError(`There is no group "${data.group}".`);
-      }
-      const identity = getIdentity();
-      const model = {
-        name: data.name,
-        description: data.description || "",
-        modelId: data.modelId || "",
-        titleFieldId: "id",
-        locale: getLocale().code,
-        tenant: getTenant().id,
-        group: {
-          id: group.id,
-          name: group.name
-        },
-        createdBy: {
-          id: identity.id,
-          displayName: identity.displayName,
-          type: identity.type
-        },
-        createdOn: new Date().toISOString(),
-        savedOn: new Date().toISOString(),
-        fields: data.fields,
-        lockedFields: [],
-        layout: data.layout || [],
-        tags: [...(data.tags || [])],
-        webinyVersion: context.WEBINY_VERSION
-      };
-      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;
-      }
+      return context.benchmark.measure("headlessCms.crud.models.createModel", async () => {
+        return createModel(input);
+      });
     },
     /**
      * Method does not check for permissions or ownership.
      * @internal
      */
     async updateModelDirect(params) {
-      const {
-        model: initialModel,
-        original
-      } = params;
-      const model = (0, _objectSpread2.default)((0, _objectSpread2.default)({}, initialModel), {}, {
-        tenant: initialModel.tenant || getTenant().id,
-        locale: initialModel.locale || getLocale().code,
-        webinyVersion: context.WEBINY_VERSION
+      return context.benchmark.measure("headlessCms.crud.models.updateModelDirect", async () => {
+        return updateModelDirect(params);
       });
-      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, userInput) {
-      await checkModelPermissions("w");
-      /**
-       * Get a model record; this will also perform ownership validation.
-       */
-      const original = await getModel(modelId);
-      const result = await (0, _validation.createModelCreateFromValidation)().safeParseAsync({
-        name: userInput.name,
-        modelId: userInput.modelId,
-        description: userInput.description || original.description,
-        group: userInput.group,
-        locale: userInput.locale
-      });
-      if (!result.success) {
-        throw (0, _utils.createZodError)(result.error);
-      }
-      const data = result.data;
-      const locale = await context.i18n.getLocale(data.locale || original.locale);
-      if (!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: data.group,
-        tenant: original.tenant,
-        locale: locale.code
-      });
-      if (!group) {
-        throw new _handlerGraphql.NotFoundError(`There is no group "${data.group}".`);
-      }
-      const identity = getIdentity();
-      const model = (0, _objectSpread2.default)((0, _objectSpread2.default)({}, original), {}, {
-        locale: locale.code,
-        group: {
-          id: group.id,
-          name: group.name
-        },
-        name: data.name,
-        modelId: data.modelId || "",
-        description: data.description || "",
-        createdBy: {
-          id: identity.id,
-          displayName: identity.displayName,
-          type: identity.type
-        },
-        createdOn: new Date().toISOString(),
-        savedOn: new Date().toISOString(),
-        lockedFields: [],
-        webinyVersion: context.WEBINY_VERSION
+      return context.benchmark.measure("headlessCms.crud.models.createModelFrom", async () => {
+        return createModelFrom(modelId, userInput);
       });
-      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");
-
-      // Get a model record; this will also perform ownership validation.
-      const original = await getModel(modelId);
-      const result = await (0, _validation.createModelUpdateValidation)().safeParseAsync(input);
-      if (!result.success) {
-        throw (0, _utils.createZodError)(result.error);
-      }
-      const data = 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 (data.group) {
-        context.security.disableAuthorization();
-        const groupData = await context.cms.getGroup(data.group);
-        context.security.enableAuthorization();
-        if (!groupData) {
-          throw new _handlerGraphql.NotFoundError(`There is no group "${data.group}".`);
-        }
-        group = {
-          id: groupData.id,
-          name: groupData.name
-        };
-      }
-      const model = (0, _objectSpread2.default)((0, _objectSpread2.default)((0, _objectSpread2.default)({}, original), data), {}, {
-        group,
-        description: data.description || original.description,
-        tenant: original.tenant || getTenant().id,
-        locale: original.locale || getLocale().code,
-        webinyVersion: context.WEBINY_VERSION,
-        savedOn: new Date().toISOString()
+      return context.benchmark.measure("headlessCms.crud.models.updateModel", async () => {
+        return updateModel(modelId, input);
       });
-      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);
-      try {
-        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) {
-        await onModelDeleteError.publish({
-          model,
-          error: ex
-        });
-        throw ex;
-      }
+      return context.benchmark.measure("headlessCms.crud.models.deleteModel", async () => {
+        return deleteModel(modelId);
+      });
     },
     async initializeModel(modelId, data) {
-      /**
-       * 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,
-        data
+      return context.benchmark.measure("headlessCms.crud.models.initializeModel", async () => {
+        return initializeModel(modelId, data);
       });
-      return true;
     },
     getModelManager,
     getEntryManager: async model => {