@webiny/api-apw 5.23.0-beta.0

package/plugins/graphql.d.ts

@@ -0,0 +1,3 @@
+import { GraphQLSchemaPlugin } from "@webiny/handler-graphql/plugins";
+declare const _default: () => GraphQLSchemaPlugin<import("../types").ApwContext>[];
+export default _default;

package/plugins/graphql.js

@@ -0,0 +1,84 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _plugins = require("@webiny/handler-graphql/plugins");
+
+var _workflow = _interopRequireDefault(require("./graphql/workflow.gql"));
+
+var _contentReview = _interopRequireDefault(require("./graphql/contentReview.gql"));
+
+var _reviewer = _interopRequireDefault(require("./graphql/reviewer.gql"));
+
+var _comment = _interopRequireDefault(require("./graphql/comment.gql"));
+
+var _changeRequest = _interopRequireDefault(require("./graphql/changeRequest.gql"));
+
+const emptyResolver = () => ({});
+
+const baseSchema = new _plugins.GraphQLSchemaPlugin({
+  typeDefs:
+  /* GraphQL */
+  `
+        input ApwRefFieldInput {
+            id: ID!
+            modelId: String
+        }
+
+        input ApwRefFieldWhereInput {
+            id: String
+            id_not: String
+            id_in: [String!]
+            id_not_in: [String]
+            entryId: String
+            entryId_not: String
+            entryId_in: [String!]
+            entryId_not_in: [String!]
+        }
+
+        type ApwRefField {
+            modelId: String!
+            entryId: ID!
+            id: ID!
+        }
+
+        type ApwMeta {
+            hasMoreItems: Boolean
+            totalCount: Int
+            cursor: String
+        }
+        type ApwCreatedBy {
+            id: ID
+            displayName: String
+            type: String
+        }
+        type ApwError {
+            code: String
+            message: String
+            data: JSON
+        }
+        extend type Query {
+            apw: ApwQuery
+        }
+        extend type Mutation {
+            apw: ApwMutation
+        }
+    `,
+  resolvers: {
+    Query: {
+      apw: emptyResolver
+    },
+    Mutation: {
+      apw: emptyResolver
+    }
+  }
+});
+
+var _default = () => [baseSchema, _workflow.default, _contentReview.default, _reviewer.default, _comment.default, _changeRequest.default];
+
+exports.default = _default;

package/plugins/hooks/createReviewerFromIdentity.d.ts

@@ -0,0 +1,2 @@
+import { LifeCycleHookCallbackParams } from "../../types";
+export declare const createReviewerFromIdentity: ({ security, apw }: LifeCycleHookCallbackParams) => void;

package/plugins/hooks/createReviewerFromIdentity.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createReviewerFromIdentity = void 0;
+
+const createReviewerFromIdentity = ({
+  security,
+  apw
+}) => {
+  /**
+   * Replicate identity in "AdvancedPublishingWorkflow" system after login.
+   */
+  security.onAfterLogin.subscribe(async ({
+    identity
+  }) => {
+    let reviewer;
+
+    try {
+      [[reviewer]] = await apw.reviewer.list({
+        where: {
+          identityId: identity.id
+        },
+        limit: 1
+      });
+    } catch (e) {
+      if (e.message === "index_not_found_exception") {// Do nothing
+      } else {
+        throw e;
+      }
+    }
+
+    if (!reviewer) {
+      await apw.reviewer.create({
+        identityId: identity.id,
+        displayName: identity.displayName,
+        type: identity.type
+      });
+    }
+  });
+};
+
+exports.createReviewerFromIdentity = createReviewerFromIdentity;

package/plugins/hooks/deleteChangeRequestsAfterContentReview.d.ts

@@ -0,0 +1,2 @@
+import { LifeCycleHookCallbackParams } from "../../types";
+export declare const deleteChangeRequestsWithContentReview: ({ apw }: LifeCycleHookCallbackParams) => void;

package/plugins/hooks/deleteChangeRequestsAfterContentReview.js

@@ -0,0 +1,66 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.deleteChangeRequestsWithContentReview = void 0;
+
+const deleteChangeRequestsWithContentReview = ({
+  apw
+}) => {
+  apw.contentReview.onAfterContentReviewDelete.subscribe(async ({
+    contentReview
+  }) => {
+    /**
+     * Also delete all associated "changeRequest" when a "contentReview" is deleted.
+     */
+    const steps = contentReview.steps;
+    /**
+     * For each step get associated change requests and delete them.
+     */
+
+    for (let i = 0; i < steps.length; i++) {
+      const {
+        slug
+      } = steps[i];
+      let meta = {
+        hasMoreItems: true,
+        cursor: null
+      };
+      let changeRequests = [];
+      /**
+       * Paginate through change requests.
+       */
+
+      while (meta.hasMoreItems) {
+        /**
+         * Get all change requests.
+         */
+        try {
+          [changeRequests, meta] = await apw.changeRequest.list({
+            where: {
+              step: `${contentReview.id}#${slug}`
+            },
+            after: meta.cursor
+          });
+        } catch (e) {
+          meta.hasMoreItems = false;
+
+          if (e.message !== "index_not_found_exception") {
+            throw e;
+          }
+        }
+        /**
+         * Delete change requests one by one.
+         */
+
+
+        for (const changeRequest of changeRequests) {
+          await apw.changeRequest.delete(changeRequest.id);
+        }
+      }
+    }
+  });
+};
+
+exports.deleteChangeRequestsWithContentReview = deleteChangeRequestsWithContentReview;

package/plugins/hooks/deleteCommentsAfterChangeRequest.d.ts

@@ -0,0 +1,2 @@
+import { LifeCycleHookCallbackParams } from "../../types";
+export declare const deleteCommentsAfterChangeRequest: ({ apw }: LifeCycleHookCallbackParams) => void;

package/plugins/hooks/deleteCommentsAfterChangeRequest.js

@@ -0,0 +1,58 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.deleteCommentsAfterChangeRequest = void 0;
+
+const deleteCommentsAfterChangeRequest = ({
+  apw
+}) => {
+  apw.changeRequest.onAfterChangeRequestDelete.subscribe(async ({
+    changeRequest
+  }) => {
+    /**
+     * Also delete all associated comments with "changeRequest".
+     */
+    let meta = {
+      hasMoreItems: true,
+      cursor: null
+    };
+    let comments = [];
+    /**
+     * Paginate through comments.
+     */
+
+    while (meta.hasMoreItems) {
+      /**
+       * Get all comments.
+       */
+      try {
+        [comments, meta] = await apw.comment.list({
+          where: {
+            changeRequest: {
+              id: changeRequest.id
+            }
+          },
+          after: meta.cursor
+        });
+      } catch (e) {
+        meta.hasMoreItems = false;
+
+        if (e.message !== "index_not_found_exception") {
+          throw e;
+        }
+      }
+      /**
+       * Delete comments one by one.
+       */
+
+
+      for (const comment of comments) {
+        await apw.comment.delete(comment.id);
+      }
+    }
+  });
+};
+
+exports.deleteCommentsAfterChangeRequest = deleteCommentsAfterChangeRequest;

package/plugins/hooks/extendPbPageSchema.d.ts

@@ -0,0 +1,4 @@
+import { GraphQLSchemaPlugin } from "@webiny/handler-graphql/plugins";
+import { ApwContext } from "../../types";
+declare const _default: () => GraphQLSchemaPlugin<ApwContext>;
+export default _default;

package/plugins/hooks/extendPbPageSchema.js

@@ -0,0 +1,24 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _plugins = require("@webiny/handler-graphql/plugins");
+
+var _default = () => new _plugins.GraphQLSchemaPlugin({
+  typeDefs:
+  /* GraphQL */
+  `
+            type PbApwPageSettings {
+                workflowId: ID
+            }
+
+            extend type PbPageSettings {
+                apw: PbApwPageSettings
+            }
+        `
+});
+
+exports.default = _default;

package/plugins/hooks/index.d.ts

@@ -0,0 +1,4 @@
+import { ContextPlugin } from "@webiny/handler/plugins/ContextPlugin";
+import { ApwContext } from "../../types";
+declare const _default: () => (import("@webiny/handler-graphql/plugins").GraphQLSchemaPlugin<ApwContext> | ContextPlugin<ApwContext>)[];
+export default _default;

package/plugins/hooks/index.js

@@ -0,0 +1,68 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _ContextPlugin = require("@webiny/handler/plugins/ContextPlugin");
+
+var _extendPbPageSchema = _interopRequireDefault(require("./extendPbPageSchema"));
+
+var _linkWorkflowToPage = require("./linkWorkflowToPage");
+
+var _deleteCommentsAfterChangeRequest = require("./deleteCommentsAfterChangeRequest");
+
+var _deleteChangeRequestsAfterContentReview = require("./deleteChangeRequestsAfterContentReview");
+
+var _createReviewerFromIdentity = require("./createReviewerFromIdentity");
+
+var _initializeContentReviewSteps = require("./initializeContentReviewSteps");
+
+var _updatePendingChangeRequests = require("./updatePendingChangeRequests");
+
+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; }
+
+var _default = () => [(0, _extendPbPageSchema.default)(),
+/**
+ * Hook into CMS events and execute business logic.
+ */
+new _ContextPlugin.ContextPlugin(async context => {
+  const {
+    security,
+    apw,
+    pageBuilder
+  } = context;
+  const pageMethods = {
+    onBeforePageCreate: pageBuilder.onBeforePageCreate,
+    getPage: pageBuilder.getPage,
+    updatePage: pageBuilder.updatePage
+  };
+  (0, _createReviewerFromIdentity.createReviewerFromIdentity)({
+    security,
+    apw
+  });
+  (0, _linkWorkflowToPage.linkWorkflowToPage)(_objectSpread({
+    apw
+  }, pageMethods));
+  (0, _initializeContentReviewSteps.initializeContentReviewSteps)({
+    apw
+  });
+  (0, _updatePendingChangeRequests.updatePendingChangeRequestsCount)({
+    apw
+  });
+  (0, _deleteCommentsAfterChangeRequest.deleteCommentsAfterChangeRequest)({
+    apw
+  });
+  (0, _deleteChangeRequestsAfterContentReview.deleteChangeRequestsWithContentReview)({
+    apw
+  });
+})];
+
+exports.default = _default;

package/plugins/hooks/initializeContentReviewSteps.d.ts

@@ -0,0 +1,7 @@
+import { AdvancedPublishingWorkflow, ApwContentTypes, LifeCycleHookCallbackParams } from "../../types";
+export declare const getWorkflowIdFromContent: (apw: AdvancedPublishingWorkflow, params: {
+    type: ApwContentTypes;
+    id: string;
+    settings: Record<string, any>;
+}) => Promise<string>;
+export declare const initializeContentReviewSteps: ({ apw }: LifeCycleHookCallbackParams) => void;

package/plugins/hooks/initializeContentReviewSteps.js

@@ -0,0 +1,70 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.initializeContentReviewSteps = exports.getWorkflowIdFromContent = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _set = _interopRequireDefault(require("lodash/set"));
+
+var _types = require("../../types");
+
+var _utils = require("../utils");
+
+var _handlerGraphql = require("@webiny/handler-graphql");
+
+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 getWorkflowIdFromContent = async (apw, params) => {
+  switch (params.type) {
+    case _types.ApwContentTypes.PAGE:
+      const getWorkflowFromPage = apw.getWorkflowGetter(_types.ApwContentTypes.PAGE);
+      return getWorkflowFromPage(params.id, {});
+
+    case _types.ApwContentTypes.CMS_ENTRY:
+      const getWorkflowFromCmsEntry = apw.getWorkflowGetter(_types.ApwContentTypes.CMS_ENTRY);
+      return getWorkflowFromCmsEntry(params.id, params.settings);
+  }
+
+  return null;
+};
+
+exports.getWorkflowIdFromContent = getWorkflowIdFromContent;
+
+const initializeContentReviewSteps = ({
+  apw
+}) => {
+  apw.contentReview.onBeforeContentReviewCreate.subscribe(async ({
+    input
+  }) => {
+    /**
+     * Let's initialize the "ContentReview" steps.
+     */
+    const workflowId = await getWorkflowIdFromContent(apw, input.content);
+
+    if (!workflowId) {
+      throw new _handlerGraphql.NotFoundError(`Unable to initiate a "Content review". No workflow found!`);
+    }
+
+    const workflow = await apw.workflow.get(workflowId);
+    const workflowSteps = workflow.steps;
+    let previousStepStatus;
+    const updatedSteps = workflow.steps.map((step, index) => {
+      const status = (0, _utils.getContentReviewStepInitialStatus)(workflowSteps, index, previousStepStatus);
+      previousStepStatus = status;
+      return _objectSpread(_objectSpread({}, step), {}, {
+        status,
+        pendingChangeRequests: 0
+      });
+    });
+    input = (0, _set.default)(input, "steps", updatedSteps);
+  });
+};
+
+exports.initializeContentReviewSteps = initializeContentReviewSteps;

package/plugins/hooks/linkWorkflowToPage.d.ts

@@ -0,0 +1,9 @@
+import { LifeCycleHookCallbackParams } from "../../types";
+import { PageBuilderContextObject } from "@webiny/api-page-builder/graphql/types";
+interface PageMethods {
+    getPage: PageBuilderContextObject["getPage"];
+    updatePage: PageBuilderContextObject["updatePage"];
+    onBeforePageCreate: PageBuilderContextObject["onBeforePageCreate"];
+}
+export declare const linkWorkflowToPage: ({ apw, getPage, updatePage, onBeforePageCreate }: LifeCycleHookCallbackParams & PageMethods) => void;
+export {};

package/plugins/hooks/linkWorkflowToPage.js

@@ -0,0 +1,154 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.linkWorkflowToPage = void 0;
+
+var _get = _interopRequireDefault(require("lodash/get"));
+
+var _set = _interopRequireDefault(require("lodash/set"));
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+var _types = require("../../types");
+
+const WORKFLOW_PRECEDENCE = {
+  [_types.WorkflowScopeTypes.DEFAULT]: 0,
+  [_types.WorkflowScopeTypes.PB]: 1,
+  [_types.WorkflowScopeTypes.CMS]: 1
+};
+
+const workflowByPrecedenceDesc = (a, b) => {
+  const scoreA = WORKFLOW_PRECEDENCE[a.scope.type];
+  const scoreB = WORKFLOW_PRECEDENCE[b.scope.type];
+  /**
+   * In descending order of workflow precedence.
+   */
+
+  return scoreB - scoreA;
+};
+
+const workflowByCreatedOnDesc = (a, b) => {
+  const createdOnA = (0, _get.default)(a, "createdOn");
+  const createdOnB = (0, _get.default)(b, "createdOn");
+  /**
+   * In descending order of workflow createdOn i.e. the most recent one first.
+   */
+
+  return new Date(createdOnB).getTime() - new Date(createdOnA).getTime();
+};
+
+const isWorkflowApplicable = (page, workflow) => {
+  const application = workflow.app;
+
+  if (application !== _types.ApwWorkflowApplications.PB) {
+    return false;
+  }
+
+  const scopeType = workflow.scope.type;
+
+  if (scopeType === _types.WorkflowScopeTypes.DEFAULT) {
+    return true;
+  }
+
+  if (scopeType === _types.WorkflowScopeTypes.PB) {
+    const categories = (0, _get.default)(workflow, "scope.data.categories");
+
+    if (Array.isArray(categories) && categories.includes(page.category)) {
+      return true;
+    }
+
+    const pages = (0, _get.default)(workflow, "scope.data.pages");
+
+    if (Array.isArray(pages) && pages.includes(page.pid)) {
+      return true;
+    }
+  }
+
+  return false;
+};
+
+const linkWorkflowToPage = ({
+  apw,
+  getPage,
+  updatePage,
+  onBeforePageCreate
+}) => {
+  onBeforePageCreate.subscribe(async ({
+    page
+  }) => {
+    try {
+      /*
+       * List all workflows for app pageBuilder
+       */
+      const [entries] = await apw.workflow.list({
+        where: {
+          app: _types.ApwWorkflowApplications.PB
+        }
+      });
+      /*
+       *  Re-order them based on workflow scope and pre-defined rule i.e.
+       *  "specific" entry -> entry for a "category" -> "default".
+       *  There can be more than one workflow with same "scope" and "app".
+       *  Therefore, we are also sorting the workflows by `createdOn` to get the latest workflow.
+       */
+
+      const sortedWorkflows = entries.sort(workflowByPrecedenceDesc).sort(workflowByCreatedOnDesc);
+
+      for (const workflow of sortedWorkflows) {
+        /**
+         * We workflow if applicable to this page, we're done here.
+         * Assign the workflow to the page and exit.
+         */
+        if (isWorkflowApplicable(page, workflow)) {
+          page.settings.apw = {
+            workflowId: workflow.id
+          };
+          break;
+        }
+      }
+    } catch (e) {
+      throw new _error.default(`Failed to assign workflow to page "${page.pid}".`, e.code, e.data);
+    }
+  });
+  apw.workflow.onAfterWorkflowCreate.subscribe(async ({
+    workflow
+  }) => {
+    const {
+      app,
+      scope
+    } = workflow;
+    /**
+     * If the workflow is applicable PB application and pages are provided,
+     * we'll assign workflow for each of those provided page.
+     */
+
+    if (app === _types.ApwWorkflowApplications.PB && scope.type === _types.WorkflowScopeTypes.PB && scope.data && Array.isArray(scope.data.pages)) {
+      for (const pid of scope.data.pages) {
+        try {
+          /**
+           * Currently, we only assign "workflow" to latest page.
+           */
+          const page = await getPage(pid);
+          /**
+           * There can be more than one workflow with same `scope` for same `app`. That is why;
+           * We'll update the workflow reference even though it already had one assign.
+           */
+
+          await updatePage(page.id, {
+            settings: (0, _set.default)(page.settings, "apw.workflowId", workflow.id)
+          });
+        } catch (e) {
+          if (e.code !== "NOT_FOUND") {
+            throw e;
+          }
+        }
+      }
+    }
+  });
+};
+
+exports.linkWorkflowToPage = linkWorkflowToPage;

package/plugins/hooks/updatePendingChangeRequests.d.ts

@@ -0,0 +1,2 @@
+import { LifeCycleHookCallbackParams } from "../../types";
+export declare const updatePendingChangeRequestsCount: ({ apw }: LifeCycleHookCallbackParams) => void;