@webiny/api-apw 5.23.0-beta.0

package/plugins/hooks/updatePendingChangeRequests.js

@@ -0,0 +1,107 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.updatePendingChangeRequestsCount = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+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; }
+
+const updatePendingChangeRequests = async ({
+  contentReviewMethods,
+  changeRequest,
+  delta
+}) => {
+  const {
+    step: stepSlug
+  } = changeRequest;
+  /*
+   * Get associated content review entry.
+   */
+
+  const [entryId, version, slug] = stepSlug.split("#");
+  const revisionId = `${entryId}#${version}`;
+  let contentReviewEntry;
+
+  try {
+    contentReviewEntry = await contentReviewMethods.get(revisionId);
+  } catch (e) {
+    if (e.message !== "index_not_found_exception" && e.code !== "NOT_FOUND") {
+      throw e;
+    }
+  }
+
+  if (contentReviewEntry) {
+    /**
+     * Update "pendingChangeRequests" count of corresponding step in content review entry.
+     */
+    await contentReviewMethods.update(contentReviewEntry.id, {
+      steps: contentReviewEntry.steps.map(step => {
+        if (step.slug === slug) {
+          return _objectSpread(_objectSpread({}, step), {}, {
+            pendingChangeRequests: step.pendingChangeRequests + delta
+          });
+        }
+
+        return step;
+      })
+    });
+  }
+};
+
+const updatePendingChangeRequestsCount = ({
+  apw
+}) => {
+  apw.changeRequest.onAfterChangeRequestDelete.subscribe(async ({
+    changeRequest
+  }) => {
+    /**
+     * After a "changeRequest" is deleted, decrement the "pendingChangeRequests" count
+     * in the corresponding step of the content review entry.
+     */
+    await updatePendingChangeRequests({
+      contentReviewMethods: apw.contentReview,
+      changeRequest: changeRequest,
+      delta: -1
+    });
+  });
+  apw.changeRequest.onAfterChangeRequestCreate.subscribe(async ({
+    changeRequest
+  }) => {
+    /**
+     * After a "changeRequest" is created, increment the "pendingChangeRequests" count
+     * of the corresponding step in the content review entry.
+     */
+    await updatePendingChangeRequests({
+      contentReviewMethods: apw.contentReview,
+      changeRequest,
+      delta: 1
+    });
+  });
+  apw.changeRequest.onAfterChangeRequestUpdate.subscribe(async ({
+    changeRequest,
+    original
+  }) => {
+    /**
+     * After a "changeRequest" is created, and the value of "resolved" field has changed;
+     * then we also need to update the "pendingChangeRequests" count of the corresponding step in the content review entry.
+     */
+    if (original.resolved !== changeRequest.resolved) {
+      const resolved = changeRequest.resolved;
+      const delta = resolved === true ? -1 : 1;
+      await updatePendingChangeRequests({
+        contentReviewMethods: apw.contentReview,
+        changeRequest,
+        delta
+      });
+    }
+  });
+};
+
+exports.updatePendingChangeRequestsCount = updatePendingChangeRequestsCount;

package/plugins/utils.d.ts

@@ -0,0 +1,15 @@
+import { CmsModelField } from "@webiny/api-headless-cms/types";
+import { ApwContentReviewStep, ApwContentReviewStepStatus, ApwReviewerCrud, ApwWorkflowStep, ApwWorkflowStepTypes } from "../types";
+import { SecurityIdentity } from "@webiny/api-security/types";
+export interface CreateModelFieldParams extends Omit<CmsModelField, "id" | "fieldId"> {
+    parent: string;
+}
+export interface HasReviewersParams {
+    identity: SecurityIdentity;
+    step: ApwContentReviewStep;
+    getReviewer: ApwReviewerCrud["get"];
+}
+export declare const hasReviewer: ({ getReviewer, identity, step }: HasReviewersParams) => Promise<Boolean>;
+export declare const getValue: (object: Record<string, any>, key: string) => any;
+export declare const getContentReviewStepInitialStatus: (workflowSteps: ApwWorkflowStep[], index: number, previousStepStatus: ApwContentReviewStepStatus) => ApwContentReviewStepStatus;
+export declare const getNextStepStatus: (previousStepType: ApwWorkflowStepTypes, previousStepStatus: ApwContentReviewStepStatus) => ApwContentReviewStepStatus;

package/plugins/utils.js

@@ -0,0 +1,69 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.hasReviewer = exports.getValue = exports.getNextStepStatus = exports.getContentReviewStepInitialStatus = void 0;
+
+var _get = _interopRequireDefault(require("lodash/get"));
+
+var _types = require("../types");
+
+const hasReviewer = async ({
+  getReviewer,
+  identity,
+  step
+}) => {
+  for (const stepReviewer of step.reviewers) {
+    const entry = await getReviewer(stepReviewer.id);
+
+    if (entry.identityId === identity.id) {
+      return true;
+    }
+  }
+
+  return false;
+};
+
+exports.hasReviewer = hasReviewer;
+
+const getValue = (object, key) => {
+  return (0, _get.default)(object, `values.${key}`);
+};
+
+exports.getValue = getValue;
+
+const getContentReviewStepInitialStatus = (workflowSteps, index, previousStepStatus) => {
+  /**
+   * Always set first step 'active' by default.
+   */
+  if (index === 0) {
+    return _types.ApwContentReviewStepStatus.ACTIVE;
+  }
+
+  const previousStep = workflowSteps[index - 1];
+
+  if (previousStepStatus === _types.ApwContentReviewStepStatus.ACTIVE && previousStep.type !== _types.ApwWorkflowStepTypes.MANDATORY_BLOCKING) {
+    return _types.ApwContentReviewStepStatus.ACTIVE;
+  }
+
+  return _types.ApwContentReviewStepStatus.INACTIVE;
+};
+
+exports.getContentReviewStepInitialStatus = getContentReviewStepInitialStatus;
+
+const getNextStepStatus = (previousStepType, previousStepStatus) => {
+  if (previousStepStatus === _types.ApwContentReviewStepStatus.DONE) {
+    return _types.ApwContentReviewStepStatus.ACTIVE;
+  }
+
+  if (previousStepStatus === _types.ApwContentReviewStepStatus.ACTIVE && previousStepType !== _types.ApwWorkflowStepTypes.MANDATORY_BLOCKING) {
+    return _types.ApwContentReviewStepStatus.ACTIVE;
+  }
+
+  return _types.ApwContentReviewStepStatus.INACTIVE;
+};
+
+exports.getNextStepStatus = getNextStepStatus;

package/storageOperations/changeRequestStorageOperations.d.ts

@@ -0,0 +1,3 @@
+import { ApwChangeRequestStorageOperations } from "./types";
+import { CreateApwStorageOperationsParams } from "./index";
+export declare const createChangeRequestStorageOperations: ({ cms, getCmsContext }: CreateApwStorageOperationsParams) => ApwChangeRequestStorageOperations;

package/storageOperations/changeRequestStorageOperations.js

@@ -0,0 +1,96 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createChangeRequestStorageOperations = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _index = require("./index");
+
+var _fieldResolver = require("../utils/fieldResolver");
+
+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; }
+
+const createChangeRequestStorageOperations = ({
+  cms,
+  getCmsContext
+}) => {
+  const getChangeRequestModel = () => {
+    return cms.getModel("apwChangeRequestModelDefinition");
+  };
+
+  const getChangeRequest = async ({
+    id
+  }) => {
+    const model = await getChangeRequestModel();
+    const entry = await cms.getEntryById(model, id);
+    return (0, _fieldResolver.getFieldValues)({
+      entry,
+      fields: _index.baseFields,
+      context: getCmsContext(),
+      transformers: [(0, _fieldResolver.getTransformer)(model, "body")]
+    });
+  };
+
+  return {
+    getChangeRequestModel,
+    getChangeRequest,
+
+    async listChangeRequests(params) {
+      const model = await getChangeRequestModel();
+      const [entries, meta] = await cms.listLatestEntries(model, params);
+      const all = await Promise.all(entries.map(entry => (0, _fieldResolver.getFieldValues)({
+        entry,
+        fields: _index.baseFields,
+        context: getCmsContext(),
+        transformers: [(0, _fieldResolver.getTransformer)(model, "body")]
+      })));
+      return [all, meta];
+    },
+
+    async createChangeRequest(params) {
+      const model = await getChangeRequestModel();
+      const entry = await cms.createEntry(model, params.data);
+      return (0, _fieldResolver.getFieldValues)({
+        entry,
+        fields: _index.baseFields,
+        context: getCmsContext(),
+        transformers: [(0, _fieldResolver.getTransformer)(model, "body")]
+      });
+    },
+
+    async updateChangeRequest(params) {
+      const model = await getChangeRequestModel();
+      /**
+       * We're fetching the existing entry here because we're not accepting "app" field as input,
+       * but, we still need to retain its value after the "update" operation.
+       */
+
+      const existingEntry = await getChangeRequest({
+        id: params.id
+      });
+      const entry = await cms.updateEntry(model, params.id, _objectSpread(_objectSpread({}, existingEntry), params.data));
+      return (0, _fieldResolver.getFieldValues)({
+        entry,
+        fields: _index.baseFields,
+        context: getCmsContext(),
+        transformers: [(0, _fieldResolver.getTransformer)(model, "body")]
+      });
+    },
+
+    async deleteChangeRequest(params) {
+      const model = await getChangeRequestModel();
+      await cms.deleteEntry(model, params.id);
+      return true;
+    }
+
+  };
+};
+
+exports.createChangeRequestStorageOperations = createChangeRequestStorageOperations;

package/storageOperations/commentStorageOperations.d.ts

@@ -0,0 +1,3 @@
+import { ApwCommentStorageOperations } from "./types";
+import { CreateApwStorageOperationsParams } from "./index";
+export declare const createCommentStorageOperations: ({ cms, getCmsContext }: CreateApwStorageOperationsParams) => ApwCommentStorageOperations;

package/storageOperations/commentStorageOperations.js

@@ -0,0 +1,101 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createCommentStorageOperations = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _index = require("./index");
+
+var _fieldResolver = require("../utils/fieldResolver");
+
+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; }
+
+const createCommentStorageOperations = ({
+  cms,
+  getCmsContext
+}) => {
+  const getCommentModel = () => {
+    return cms.getModel("apwCommentModelDefinition");
+  };
+
+  const getComment = async ({
+    id
+  }) => {
+    const model = await getCommentModel();
+    const entry = await cms.getEntryById(model, id);
+    return (0, _fieldResolver.getFieldValues)({
+      entry,
+      fields: _index.baseFields,
+      context: getCmsContext(),
+      transformers: [(0, _fieldResolver.getTransformer)(model, "body")]
+    });
+  };
+
+  return {
+    getCommentModel,
+    getComment,
+
+    async listComments(params) {
+      const model = await getCommentModel();
+      const [entries, meta] = await cms.listLatestEntries(model, params);
+      const all = await Promise.all(entries.map(entry => (0, _fieldResolver.getFieldValues)({
+        entry,
+        fields: _index.baseFields,
+        context: getCmsContext(),
+        transformers: [(0, _fieldResolver.getTransformer)(model, "body")]
+      })));
+      return [all, meta];
+    },
+
+    async createComment(params) {
+      const model = await getCommentModel();
+      const refModel = await this.getChangeRequestModel();
+      const entry = await cms.createEntry(model, _objectSpread(_objectSpread({}, params.data), {}, {
+        changeRequest: _objectSpread(_objectSpread({}, params.data.changeRequest), {}, {
+          modelId: refModel.modelId
+        })
+      }));
+      return (0, _fieldResolver.getFieldValues)({
+        entry,
+        fields: _index.baseFields,
+        context: getCmsContext(),
+        transformers: [(0, _fieldResolver.getTransformer)(model, "body")]
+      });
+    },
+
+    async updateComment(params) {
+      const model = await getCommentModel();
+      /**
+       * We're fetching the existing entry here because we're not accepting "app" field as input,
+       * but, we still need to retain its value after the "update" operation.
+       */
+
+      const existingEntry = await getComment({
+        id: params.id
+      });
+      const entry = await cms.updateEntry(model, params.id, _objectSpread(_objectSpread({}, existingEntry), params.data));
+      return (0, _fieldResolver.getFieldValues)({
+        entry,
+        fields: _index.baseFields,
+        context: getCmsContext(),
+        transformers: [(0, _fieldResolver.getTransformer)(model, "body")]
+      });
+    },
+
+    async deleteComment(params) {
+      const model = await getCommentModel();
+      await cms.deleteEntry(model, params.id);
+      return true;
+    }
+
+  };
+};
+
+exports.createCommentStorageOperations = createCommentStorageOperations;

package/storageOperations/contentReviewStorageOperations.d.ts

@@ -0,0 +1,3 @@
+import { ApwContentReviewStorageOperations } from "./types";
+import { CreateApwStorageOperationsParams } from "./index";
+export declare const createContentReviewStorageOperations: ({ cms }: Pick<CreateApwStorageOperationsParams, "cms">) => ApwContentReviewStorageOperations;

package/storageOperations/contentReviewStorageOperations.js

@@ -0,0 +1,72 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createContentReviewStorageOperations = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _index = require("./index");
+
+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; }
+
+const createContentReviewStorageOperations = ({
+  cms
+}) => {
+  const getContentReviewModel = () => {
+    return cms.getModel("apwContentReviewModelDefinition");
+  };
+
+  const getContentReview = async ({
+    id
+  }) => {
+    const model = await getContentReviewModel();
+    const entry = await cms.getEntryById(model, id);
+    return (0, _index.getFieldValues)(entry, _index.baseFields);
+  };
+
+  return {
+    getContentReviewModel,
+    getContentReview,
+
+    async listContentReviews(params) {
+      const model = await getContentReviewModel();
+      const [entries, meta] = await cms.listLatestEntries(model, params);
+      return [entries.map(entry => (0, _index.getFieldValues)(entry, _index.baseFields)), meta];
+    },
+
+    async createContentReview(params) {
+      const model = await getContentReviewModel();
+      const entry = await cms.createEntry(model, params.data);
+      return (0, _index.getFieldValues)(entry, _index.baseFields);
+    },
+
+    async updateContentReview(params) {
+      const model = await getContentReviewModel();
+      /**
+       * We're fetching the existing entry here because we're not accepting "app" field as input,
+       * but, we still need to retain its value after the "update" operation.
+       */
+
+      const existingEntry = await getContentReview({
+        id: params.id
+      });
+      const entry = await cms.updateEntry(model, params.id, _objectSpread(_objectSpread({}, existingEntry), params.data));
+      return (0, _index.getFieldValues)(entry, _index.baseFields);
+    },
+
+    async deleteContentReview(params) {
+      const model = await getContentReviewModel();
+      await cms.deleteEntry(model, params.id);
+      return true;
+    }
+
+  };
+};
+
+exports.createContentReviewStorageOperations = createContentReviewStorageOperations;

package/storageOperations/index.d.ts

@@ -0,0 +1,9 @@
+import { CmsContext, HeadlessCms } from "@webiny/api-headless-cms/types";
+import { ApwStorageOperations } from "../types";
+export interface CreateApwStorageOperationsParams {
+    cms: HeadlessCms;
+    getCmsContext: () => CmsContext;
+}
+export declare function getFieldValues(object: any, fields: any): any;
+export declare const baseFields: string[];
+export declare const createStorageOperations: ({ cms, getCmsContext }: CreateApwStorageOperationsParams) => ApwStorageOperations;

package/storageOperations/index.js

@@ -0,0 +1,63 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createStorageOperations = exports.baseFields = void 0;
+exports.getFieldValues = getFieldValues;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _pick = _interopRequireDefault(require("lodash/pick"));
+
+var _reviewerStorageOperations = require("./reviewerStorageOperations");
+
+var _workflowStorageOperations = require("./workflowStorageOperations");
+
+var _contentReviewStorageOperations = require("./contentReviewStorageOperations");
+
+var _changeRequestStorageOperations = require("./changeRequestStorageOperations");
+
+var _commentStorageOperations = require("./commentStorageOperations");
+
+var _models = require("./models");
+
+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; }
+
+function getFieldValues(object, fields) {
+  return _objectSpread(_objectSpread({}, (0, _pick.default)(object, fields)), object.values);
+}
+
+const baseFields = ["id", "createdBy", "createdOn", "savedOn"];
+exports.baseFields = baseFields;
+
+const createStorageOperations = ({
+  cms,
+  getCmsContext
+}) => {
+  const context = getCmsContext();
+  /**
+   * Register Apw models.
+   */
+
+  (0, _models.createApwModels)(context);
+  return _objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread({}, (0, _reviewerStorageOperations.createReviewerStorageOperations)({
+    cms
+  })), (0, _workflowStorageOperations.createWorkflowStorageOperations)({
+    cms
+  })), (0, _contentReviewStorageOperations.createContentReviewStorageOperations)({
+    cms
+  })), (0, _changeRequestStorageOperations.createChangeRequestStorageOperations)({
+    cms,
+    getCmsContext
+  })), (0, _commentStorageOperations.createCommentStorageOperations)({
+    cms,
+    getCmsContext
+  }));
+};
+
+exports.createStorageOperations = createStorageOperations;

package/storageOperations/models/changeRequest.model.d.ts

@@ -0,0 +1,7 @@
+export declare const createChangeRequestModelDefinition: () => {
+    name: string;
+    modelId: string;
+    titleFieldId: string;
+    layout: string[][];
+    fields: import("@webiny/api-headless-cms/types").CmsModelField[];
+};

package/storageOperations/models/changeRequest.model.js

@@ -0,0 +1,52 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createChangeRequestModelDefinition = void 0;
+
+var _utils = require("./utils");
+
+const bodyField = () => (0, _utils.createModelField)({
+  label: "Body",
+  type: "rich-text",
+  parent: "changeRequest"
+});
+
+const titleField = () => (0, _utils.createModelField)({
+  label: "Title",
+  type: "text",
+  parent: "changeRequest"
+});
+
+const resolvedField = () => (0, _utils.createModelField)({
+  label: "Resolved",
+  type: "boolean",
+  parent: "changeRequest"
+});
+
+const mediaField = () => (0, _utils.createModelField)({
+  label: "Media",
+  type: "file",
+  parent: "changeRequest"
+});
+
+const stepField = () => (0, _utils.createModelField)({
+  label: "Step",
+  type: "text",
+  parent: "changeRequest",
+  validation: [{
+    name: "required",
+    message: "Value is required"
+  }]
+});
+
+const createChangeRequestModelDefinition = () => ({
+  name: "APW - Change Request",
+  modelId: "apwChangeRequestModelDefinition",
+  titleFieldId: "changeRequest_title",
+  layout: [["changeRequest_body"], ["changeRequest_title"]],
+  fields: [bodyField(), titleField(), resolvedField(), mediaField(), stepField()]
+});
+
+exports.createChangeRequestModelDefinition = createChangeRequestModelDefinition;

package/storageOperations/models/comment.model.d.ts

@@ -0,0 +1,9 @@
+export declare const createCommentModelDefinition: ({ modelId }: {
+    modelId: any;
+}) => {
+    name: string;
+    modelId: string;
+    titleFieldId: string;
+    layout: string[][];
+    fields: import("@webiny/api-headless-cms/types").CmsModelField[];
+};

package/storageOperations/models/comment.model.js

@@ -0,0 +1,37 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createCommentModelDefinition = void 0;
+
+var _utils = require("./utils");
+
+const commentBody = () => (0, _utils.createModelField)({
+  label: "Body",
+  type: "rich-text",
+  parent: "comment"
+});
+
+const changeRequestRef = modelId => (0, _utils.createModelField)({
+  label: "Change Request",
+  type: "ref",
+  parent: "comment",
+  settings: {
+    models: [{
+      modelId
+    }]
+  }
+});
+
+const createCommentModelDefinition = ({
+  modelId
+}) => ({
+  name: "APW - Comment",
+  modelId: "apwCommentModelDefinition",
+  titleFieldId: "displayName",
+  layout: [["comment_body"], ["comment_displayName"]],
+  fields: [commentBody(), changeRequestRef(modelId)]
+});
+
+exports.createCommentModelDefinition = createCommentModelDefinition;

package/storageOperations/models/contentModelPluginFactory.d.ts

@@ -0,0 +1,17 @@
+import { CmsGroup } from "@webiny/api-headless-cms/content/plugins/CmsGroupPlugin";
+import { CmsModelPlugin } from "@webiny/api-headless-cms/content/plugins/CmsModelPlugin";
+import { CmsModel } from "@webiny/api-headless-cms/types";
+declare type ModelDefinition = Omit<CmsModel, "locale" | "tenant" | "webinyVersion" | "group">;
+interface Params {
+    group: CmsGroup;
+    /**
+     * Locale and tenant do not need to be defined.
+     * In that case model is not bound to any locale or tenant.
+     * You can bind it to locale, tenant, both or none.
+     */
+    locale?: string;
+    tenant?: string;
+    modelDefinition: ModelDefinition;
+}
+declare const contentModelPluginFactory: (params: Params) => CmsModelPlugin;
+export default contentModelPluginFactory;