@webiny/api-headless-cms 0.0.0-mt-1

package/content/plugins/crud/contentModel/validateLayout.js

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

package/content/plugins/crud/contentModel.crud.d.ts

@@ -0,0 +1,12 @@
+import { CmsContext, CmsModelContext, HeadlessCmsStorageOperations } from "../../../types";
+import { Tenant } from "@webiny/api-tenancy/types";
+import { I18NLocale } from "@webiny/api-i18n/types";
+import { SecurityIdentity } from "@webiny/api-security/types";
+export interface Params {
+    getTenant: () => Tenant;
+    getLocale: () => I18NLocale;
+    storageOperations: HeadlessCmsStorageOperations;
+    context: CmsContext;
+    getIdentity: () => SecurityIdentity;
+}
+export declare const createModelsCrud: (params: Params) => CmsModelContext;

package/content/plugins/crud/contentModel.crud.js

@@ -0,0 +1,425 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createModelsCrud = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var utils = _interopRequireWildcard(require("../../../utils"));
+
+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 _validateLayout = require("./contentModel/validateLayout");
+
+var _apiSecurity = require("@webiny/api-security");
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+var _CmsModelPlugin = require("../CmsModelPlugin");
+
+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");
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+const createModelsCrud = params => {
+  const {
+    getTenant,
+    getIdentity,
+    getLocale,
+    storageOperations,
+    context
+  } = params;
+  const loaders = {
+    listModels: new _dataloader.default(async () => {
+      const models = await storageOperations.models.list({
+        where: {
+          tenant: getTenant().id,
+          locale: getLocale().code
+        }
+      });
+      return [models.map(model => {
+        return _objectSpread(_objectSpread({}, model), {}, {
+          tenant: model.tenant || getTenant().id,
+          locale: model.locale || getLocale().code
+        });
+      })];
+    })
+  };
+  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 utils.checkPermissions(context, "cms.contentModel", {
+      rwd: check
+    });
+  };
+
+  const getModelsAsPlugins = () => {
+    const tenant = getTenant().id;
+    const locale = getLocale().code;
+    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 => {
+      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), {}, {
+        tenant,
+        locale,
+        webinyVersion: context.WEBINY_VERSION
+      });
+    });
+  };
+
+  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), {}, {
+      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 listOperations = async () => {
+    const permission = await checkModelPermissions("r");
+    const models = await modelsList();
+    return utils.filterAsync(models, async model => {
+      if (!utils.validateOwnership(context, permission, model)) {
+        return false;
+      }
+
+      return utils.validateModelAccess(context, model);
+    });
+  };
+
+  const get = async modelId => {
+    const permission = await checkModelPermissions("r");
+    const model = await modelsGet(modelId);
+    utils.checkOwnership(context, permission, model);
+    await utils.checkModelAccess(context, model);
+    return model;
+  };
+
+  const getManager = async 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 onBeforeCreate = (0, _pubsub.createTopic)();
+  const onAfterCreate = (0, _pubsub.createTopic)();
+  const onBeforeUpdate = (0, _pubsub.createTopic)();
+  const onAfterUpdate = (0, _pubsub.createTopic)();
+  const onBeforeDelete = (0, _pubsub.createTopic)();
+  const onAfterDelete = (0, _pubsub.createTopic)();
+  /**
+   * We need to assign some default behaviors.
+   */
+
+  (0, _beforeCreate.assignBeforeModelCreate)({
+    onBeforeCreate,
+    plugins: context.plugins,
+    storageOperations
+  });
+  (0, _afterCreate.assignAfterModelCreate)({
+    context,
+    onAfterCreate
+  });
+  (0, _beforeUpdate.assignBeforeModelUpdate)({
+    onBeforeUpdate,
+    plugins: context.plugins,
+    storageOperations
+  });
+  (0, _afterUpdate.assignAfterModelUpdate)({
+    context,
+    onAfterUpdate
+  });
+  (0, _beforeDelete.assignBeforeModelDelete)({
+    onBeforeDelete,
+    plugins: context.plugins,
+    storageOperations
+  });
+  (0, _afterDelete.assignAfterModelDelete)({
+    context,
+    onAfterDelete
+  });
+  return {
+    onBeforeModelCreate: onBeforeCreate,
+    onAfterModelCreate: onAfterCreate,
+    onBeforeModelUpdate: onBeforeUpdate,
+    onAfterModelUpdate: onAfterUpdate,
+    onBeforeModelDelete: onBeforeDelete,
+    onAfterModelDelete: onAfterDelete,
+    silentAuthModel: () => {
+      return {
+        list: async () => {
+          try {
+            return await listOperations();
+          } catch (ex) {
+            if (ex instanceof _apiSecurity.NotAuthorizedError) {
+              return [];
+            }
+
+            throw ex;
+          }
+        }
+      };
+    },
+    getModel: get,
+    listModels: listOperations,
+
+    async createModel(inputData) {
+      await checkModelPermissions("w");
+      const createdData = new _models.CreateContentModelModel().populate(inputData);
+      await createdData.validate();
+      const input = await createdData.toJSON();
+      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 identity = getIdentity();
+
+      const model = _objectSpread(_objectSpread({}, input), {}, {
+        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: [],
+        lockedFields: [],
+        layout: [],
+        webinyVersion: context.WEBINY_VERSION
+      });
+
+      await onBeforeCreate.publish({
+        model,
+        input
+      });
+      const createdModel = await storageOperations.models.create({
+        input,
+        model
+      });
+      loaders.listModels.clearAll();
+      await updateManager(context, model);
+      await onAfterCreate.publish({
+        input,
+        model: createdModel
+      });
+      return createdModel;
+    },
+
+    /**
+     * Method does not check for permissions or ownership.
+     * @internal
+     */
+    async updateModelDirect(params) {
+      const {
+        model: initialModel,
+        original
+      } = params;
+
+      const model = _objectSpread(_objectSpread({}, initialModel), {}, {
+        tenant: initialModel.tenant || getTenant().id,
+        locale: initialModel.locale || getLocale().code,
+        webinyVersion: context.WEBINY_VERSION
+      });
+
+      await onBeforeUpdate.publish({
+        input: {},
+        original,
+        model
+      });
+      const resultModel = await storageOperations.models.update({
+        original,
+        model,
+        input: {}
+      });
+      await updateManager(context, resultModel);
+      loaders.listModels.clearAll();
+      await onAfterUpdate.publish({
+        input: {},
+        original,
+        model: resultModel
+      });
+      return resultModel;
+    },
+
+    async updateModel(modelId, inputData) {
+      await checkModelPermissions("w"); // Get a model record; this will also perform ownership validation.
+
+      const original = await get(modelId);
+      const updatedData = new _models.UpdateContentModelModel().populate(inputData);
+      await updatedData.validate();
+      const input = await updatedData.toJSON({
+        onlyDirty: true
+      });
+
+      if (Object.keys(input).length === 0) {
+        return {};
+      }
+
+      if (input.group) {
+        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}".`);
+        }
+
+        input.group = {
+          id: group.id,
+          name: group.name
+        };
+      }
+
+      const modelFields = await (0, _createFieldModels.createFieldModels)(original, inputData);
+      (0, _validateLayout.validateLayout)(input, modelFields);
+
+      const model = _objectSpread(_objectSpread(_objectSpread({}, original), input), {}, {
+        tenant: original.tenant || getTenant().id,
+        locale: original.locale || getLocale().code,
+        webinyVersion: context.WEBINY_VERSION,
+        fields: modelFields,
+        savedOn: new Date().toISOString()
+      });
+
+      await onBeforeUpdate.publish({
+        input,
+        original,
+        model
+      });
+      const resultModel = await storageOperations.models.update({
+        original,
+        model,
+        input
+      });
+      await updateManager(context, resultModel);
+      await onAfterUpdate.publish({
+        original,
+        model: resultModel,
+        input
+      });
+      return resultModel;
+    },
+
+    async deleteModel(modelId) {
+      await checkModelPermissions("d");
+      const model = await get(modelId);
+      await onBeforeDelete.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 onAfterDelete.publish({
+        model
+      });
+      managers.delete(model.modelId);
+    },
+
+    getModelManager: getManager,
+    getManagers: () => managers
+  };
+};
+
+exports.createModelsCrud = createModelsCrud;

package/content/plugins/crud/contentModelGroup/beforeCreate.d.ts

@@ -0,0 +1,9 @@
+import { BeforeGroupCreateTopicParams, HeadlessCmsStorageOperations } from "../../../../types";
+import { Topic } from "@webiny/pubsub/types";
+import { PluginsContainer } from "@webiny/plugins";
+export interface Params {
+    onBeforeCreate: Topic<BeforeGroupCreateTopicParams>;
+    plugins: PluginsContainer;
+    storageOperations: HeadlessCmsStorageOperations;
+}
+export declare const assignBeforeGroupCreate: (params: Params) => void;

package/content/plugins/crud/contentModelGroup/beforeCreate.js

@@ -0,0 +1,66 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.assignBeforeGroupCreate = void 0;
+
+var _CmsGroupPlugin = require("../../CmsGroupPlugin");
+
+var _utils = require("../../../../utils");
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+var _shortid = _interopRequireDefault(require("shortid"));
+
+const assignBeforeGroupCreate = params => {
+  const {
+    onBeforeCreate,
+    plugins,
+    storageOperations
+  } = params;
+  onBeforeCreate.subscribe(async params => {
+    const {
+      group
+    } = params;
+
+    if (group.slug && group.slug.trim()) {
+      const groups = await storageOperations.groups.list({
+        where: {
+          tenant: group.tenant,
+          locale: group.locale,
+          slug: group.slug
+        }
+      });
+
+      if (groups.length > 0) {
+        throw new _error.default(`Cms Group with the slug "${group.slug}" already exists.`, "SLUG_ALREADY_EXISTS");
+      }
+    } else {
+      const slug = (0, _utils.toSlug)(group.name);
+      const groups = await storageOperations.groups.list({
+        where: {
+          tenant: group.tenant,
+          locale: group.locale,
+          slug
+        }
+      });
+
+      if (groups.length === 0) {
+        group.slug = slug;
+      } else {
+        group.slug = `${slug}-${_shortid.default.generate()}`;
+      }
+    }
+
+    const groupPlugin = plugins.byType(_CmsGroupPlugin.CmsGroupPlugin.type).find(item => item.contentModelGroup.slug === group.slug);
+
+    if (groupPlugin) {
+      throw new Error(`Cannot create "${group.slug}" content model group because one is already registered via a plugin.`);
+    }
+  });
+};
+
+exports.assignBeforeGroupCreate = assignBeforeGroupCreate;

package/content/plugins/crud/contentModelGroup/beforeDelete.d.ts

@@ -0,0 +1,9 @@
+import { Topic } from "@webiny/pubsub/types";
+import { BeforeGroupDeleteTopicParams, HeadlessCmsStorageOperations } from "../../../../types";
+import { PluginsContainer } from "@webiny/plugins";
+export interface Params {
+    onBeforeDelete: Topic<BeforeGroupDeleteTopicParams>;
+    plugins: PluginsContainer;
+    storageOperations: HeadlessCmsStorageOperations;
+}
+export declare const assignBeforeGroupDelete: (params: Params) => void;

package/content/plugins/crud/contentModelGroup/beforeDelete.js

@@ -0,0 +1,48 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.assignBeforeGroupDelete = void 0;
+
+var _CmsGroupPlugin = require("../../CmsGroupPlugin");
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+const assignBeforeGroupDelete = params => {
+  const {
+    onBeforeDelete,
+    plugins,
+    storageOperations
+  } = params;
+  onBeforeDelete.subscribe(async params => {
+    const {
+      group
+    } = params;
+    const groupPlugin = plugins.byType(_CmsGroupPlugin.CmsGroupPlugin.type).find(item => item.contentModelGroup.slug === group.slug);
+
+    if (groupPlugin) {
+      throw new Error(`Cms Groups defined via plugins cannot be deleted.`);
+    }
+
+    const models = await storageOperations.models.list({
+      where: {
+        tenant: group.tenant,
+        locale: group.locale
+      }
+    });
+    const items = models.filter(model => {
+      return model.group.id === group.id;
+    });
+
+    if (items.length > 0) {
+      throw new _error.default("Cannot delete this group because there are models that belong to it.", "BEFORE_DELETE_ERROR", {
+        group
+      });
+    }
+  });
+};
+
+exports.assignBeforeGroupDelete = assignBeforeGroupDelete;

package/content/plugins/crud/contentModelGroup/beforeUpdate.d.ts

@@ -0,0 +1,8 @@
+import { Topic } from "@webiny/pubsub/types";
+import { BeforeGroupUpdateTopicParams } from "../../../../types";
+import { PluginsContainer } from "@webiny/plugins";
+export interface Params {
+    onBeforeUpdate: Topic<BeforeGroupUpdateTopicParams>;
+    plugins: PluginsContainer;
+}
+export declare const assignBeforeGroupUpdate: (params: Params) => void;

package/content/plugins/crud/contentModelGroup/beforeUpdate.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.assignBeforeGroupUpdate = void 0;
+
+var _CmsGroupPlugin = require("../../CmsGroupPlugin");
+
+const assignBeforeGroupUpdate = params => {
+  const {
+    onBeforeUpdate,
+    plugins
+  } = params;
+  onBeforeUpdate.subscribe(({
+    group
+  }) => {
+    const groupPlugin = plugins.byType(_CmsGroupPlugin.CmsGroupPlugin.type).find(item => item.contentModelGroup.slug === group.slug);
+
+    if (!groupPlugin) {
+      return;
+    }
+
+    throw new Error(`Cms Groups defined via plugins cannot be updated.`);
+  });
+};
+
+exports.assignBeforeGroupUpdate = assignBeforeGroupUpdate;

package/content/plugins/crud/contentModelGroup.crud.d.ts

@@ -0,0 +1,12 @@
+import { CmsGroupContext, CmsContext, HeadlessCmsStorageOperations } from "../../../types";
+import { Tenant } from "@webiny/api-tenancy/types";
+import { I18NLocale } from "@webiny/api-i18n/types";
+import { SecurityIdentity } from "@webiny/api-security/types";
+export interface Params {
+    getTenant: () => Tenant;
+    getLocale: () => I18NLocale;
+    storageOperations: HeadlessCmsStorageOperations;
+    context: CmsContext;
+    getIdentity: () => SecurityIdentity;
+}
+export declare const createModelGroupsCrud: (params: Params) => CmsGroupContext;