@webiny/api-apw 0.0.0-unstable.8c4d9f045a → 0.0.0-unstable.8feaff8c32

package/crud/createContentReviewMethods.js

@@ -1,36 +1,20 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createContentReviewMethods = createContentReviewMethods;
-
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
 var _get = _interopRequireDefault(require("lodash/get"));
-
 var _pubsub = require("@webiny/pubsub");
-
 var _error = _interopRequireDefault(require("@webiny/error"));
-
 var _types = require("../types");
-
 var _utils = require("../plugins/utils");
-
 var _errors = require("../utils/errors");
-
 var _types2 = require("../scheduler/types");
-
 var _utils2 = require("./utils");
-
 var _contentApwSettingsPlugin = require("../utils/contentApwSettingsPlugin");
-
-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 createContentReviewMethods(params) {
   const {
     getIdentity,
@@ -45,64 +29,73 @@ function createContentReviewMethods(params) {
     getLocale,
     plugins
   } = params;
-  const onBeforeContentReviewCreate = (0, _pubsub.createTopic)();
-  const onAfterContentReviewCreate = (0, _pubsub.createTopic)();
-  const onBeforeContentReviewUpdate = (0, _pubsub.createTopic)();
-  const onAfterContentReviewUpdate = (0, _pubsub.createTopic)();
-  const onBeforeContentReviewDelete = (0, _pubsub.createTopic)();
-  const onAfterContentReviewDelete = (0, _pubsub.createTopic)();
+
+  // create
+  const onContentReviewBeforeCreate = (0, _pubsub.createTopic)("apw.onContentReviewBeforeCreate");
+  const onContentReviewAfterCreate = (0, _pubsub.createTopic)("apw.onContentReviewAfterCreate");
+  // update
+  const onContentReviewBeforeUpdate = (0, _pubsub.createTopic)("apw.onContentReviewBeforeUpdate");
+  const onContentReviewAfterUpdate = (0, _pubsub.createTopic)("apw.onContentReviewAfterUpdate");
+  // delete
+  const onContentReviewBeforeDelete = (0, _pubsub.createTopic)("apw.onContentReviewBeforeDelete");
+  const onContentReviewAfterDelete = (0, _pubsub.createTopic)("apw.onContentReviewAfterDelete");
+  // list
+  const onContentReviewBeforeList = (0, _pubsub.createTopic)("apw.onContentReviewBeforeList");
   return {
     /**
      * Lifecycle events
      */
-    onBeforeContentReviewCreate,
-    onAfterContentReviewCreate,
-    onBeforeContentReviewUpdate,
-    onAfterContentReviewUpdate,
-    onBeforeContentReviewDelete,
-    onAfterContentReviewDelete,
-
+    onContentReviewBeforeCreate,
+    onContentReviewAfterCreate,
+    onContentReviewBeforeUpdate,
+    onContentReviewAfterUpdate,
+    onContentReviewBeforeDelete,
+    onContentReviewAfterDelete,
+    onContentReviewBeforeList,
     async get(id) {
       return storageOperations.getContentReview({
         id
       });
     },
-
     async list(params) {
-      if (params.where && params.where.status === "requiresMyAttention") {
+      const where = params.where || {};
+      await onContentReviewBeforeList.publish({
+        where
+      });
+      if (where.reviewStatus === "requiresMyAttention") {
         return (0, _utils2.filterContentReviewsByRequiresMyAttention)({
-          listParams: params,
+          listParams: (0, _objectSpread2.default)((0, _objectSpread2.default)({}, params), {}, {
+            where
+          }),
           listContentReviews: storageOperations.listContentReviews,
           getReviewer,
           getIdentity
         });
       }
-
-      return storageOperations.listContentReviews(params);
+      return storageOperations.listContentReviews((0, _objectSpread2.default)((0, _objectSpread2.default)({}, params), {}, {
+        where
+      }));
     },
-
     async create(data) {
-      const input = _objectSpread(_objectSpread({}, data), {}, {
-        status: _types.ApwContentReviewStatus.UNDER_REVIEW
+      const input = (0, _objectSpread2.default)((0, _objectSpread2.default)({}, data), {}, {
+        reviewStatus: _types.ApwContentReviewStatus.UNDER_REVIEW
       });
-
-      await onBeforeContentReviewCreate.publish({
+      await onContentReviewBeforeCreate.publish({
         input
       });
       const contentReview = await storageOperations.createContentReview({
         data: input
       });
-      await onAfterContentReviewCreate.publish({
+      await onContentReviewAfterCreate.publish({
         contentReview
       });
       return contentReview;
     },
-
     async update(id, data) {
       const original = await storageOperations.getContentReview({
         id
       });
-      await onBeforeContentReviewUpdate.publish({
+      await onContentReviewBeforeUpdate.publish({
         original,
         input: {
           id,
@@ -113,7 +106,7 @@ function createContentReviewMethods(params) {
         id,
         data
       });
-      await onAfterContentReviewUpdate.publish({
+      await onContentReviewAfterUpdate.publish({
         original,
         input: {
           id,
@@ -123,28 +116,26 @@ function createContentReviewMethods(params) {
       });
       return contentReview;
     },
-
     async delete(id) {
       const contentReview = await storageOperations.getContentReview({
         id
       });
-      await onBeforeContentReviewDelete.publish({
+      await onContentReviewBeforeDelete.publish({
         contentReview
       });
       await storageOperations.deleteContentReview({
         id
       });
-      await onAfterContentReviewDelete.publish({
+      await onContentReviewAfterDelete.publish({
         contentReview
       });
       return true;
     },
-
     async provideSignOff(id, stepId) {
       const entry = await this.get(id);
       const {
         steps,
-        status
+        reviewStatus
       } = entry;
       const stepIndex = steps.findIndex(step => step.id === stepId);
       const currentStep = steps[stepIndex];
@@ -155,10 +146,10 @@ function createContentReviewMethods(params) {
         identity,
         step: currentStep
       });
+
       /**
        *  Check whether the sign-off is requested by a reviewer.
        */
-
       if (!hasPermission) {
         throw new _errors.NotAuthorizedError({
           entry,
@@ -171,8 +162,6 @@ function createContentReviewMethods(params) {
       /**
        *  Don't allow sign off, if previous step is of "mandatory_blocking" type and undone.
        */
-
-
       if (previousStep && previousStep.status !== _types.ApwContentReviewStepStatus.DONE && previousStep.type === _types.ApwWorkflowStepTypes.MANDATORY_BLOCKING) {
         throw new _errors.StepMissingError({
           entry,
@@ -185,8 +174,6 @@ function createContentReviewMethods(params) {
       /**
        *  Don't allow sign off, if there are pending change requests.
        */
-
-
       if (currentStep.pendingChangeRequests > 0) {
         throw new _errors.PendingChangeRequestsError({
           entry,
@@ -199,8 +186,6 @@ function createContentReviewMethods(params) {
       /**
        *  Don't allow sign off, if current step is not in "active" state.
        */
-
-
       if (currentStep.status !== _types.ApwContentReviewStepStatus.ACTIVE) {
         throw new _errors.StepInActiveError({
           entry,
@@ -210,16 +195,14 @@ function createContentReviewMethods(params) {
           }
         });
       }
-
       let previousStepStatus;
       /*
        * Provide sign-off for give step.
        */
-
       const updatedSteps = steps.map((step, index) => {
         if (index === stepIndex) {
           previousStepStatus = _types.ApwContentReviewStepStatus.DONE;
-          return _objectSpread(_objectSpread({}, step), {}, {
+          return (0, _objectSpread2.default)((0, _objectSpread2.default)({}, step), {}, {
             status: _types.ApwContentReviewStepStatus.DONE,
             signOffProvidedOn: new Date().toISOString(),
             signOffProvidedBy: identity
@@ -228,49 +211,45 @@ function createContentReviewMethods(params) {
         /**
          * Update next steps status based on type.
          */
-
-
         if (index > stepIndex) {
           const previousStep = steps[index - 1];
           previousStepStatus = (0, _utils.getNextStepStatus)(previousStep.type, previousStepStatus);
-          return _objectSpread(_objectSpread({}, step), {}, {
+          return (0, _objectSpread2.default)((0, _objectSpread2.default)({}, step), {}, {
             status: previousStepStatus
           });
         }
-
         return step;
       });
       /**
        * Check for pending steps
        */
-
-      let newStatus = status;
+      let newStatus = reviewStatus;
       const pendingRequiredSteps = (0, _utils2.getPendingRequiredSteps)(updatedSteps, step => typeof step.signOffProvidedOn !== "string");
+
       /**
        * If there are no required steps that are pending, set the status to "READY_TO_BE_PUBLISHED".
        */
-
       if (pendingRequiredSteps.length === 0) {
         newStatus = _types.ApwContentReviewStatus.READY_TO_BE_PUBLISHED;
       }
+
       /**
        * Save updated steps.
        */
-
-
       await this.update(id, {
         steps: updatedSteps,
-        status: newStatus
+        reviewStatus: newStatus
       });
       return true;
     },
-
     async retractSignOff(id, stepId) {
-      const entry = await this.get(id);
+      var _contentReview$conten;
+      const contentReview = await this.get(id);
       const {
         steps,
-        status
-      } = entry;
+        reviewStatus,
+        content
+      } = contentReview;
       const stepIndex = steps.findIndex(step => step.id === stepId);
       const currentStep = steps[stepIndex];
       const identity = getIdentity();
@@ -279,13 +258,13 @@ function createContentReviewMethods(params) {
         identity,
         step: currentStep
       });
+
       /**
        *  Check whether the retract sign-off is requested by a reviewer.
        */
-
       if (!hasPermission) {
         throw new _errors.NotAuthorizedError({
-          entry,
+          entry: contentReview,
           input: {
             id,
             step: stepId
@@ -295,27 +274,24 @@ function createContentReviewMethods(params) {
       /**
        *  Don't allow, if step in not "done" i.e. no sign-off was provided for it.
        */
-
-
       if (currentStep.status !== _types.ApwContentReviewStepStatus.DONE) {
         throw new _errors.NoSignOffProvidedError({
-          entry,
+          entry: contentReview,
           input: {
             id,
             step: stepId
           }
         });
       }
-
       let previousStepStatus;
+
       /*
        * Retract sign-off for give step.
        */
-
       const updatedSteps = steps.map((step, index) => {
         if (index === stepIndex) {
           previousStepStatus = _types.ApwContentReviewStepStatus.ACTIVE;
-          return _objectSpread(_objectSpread({}, step), {}, {
+          return (0, _objectSpread2.default)((0, _objectSpread2.default)({}, step), {}, {
             status: previousStepStatus,
             signOffProvidedOn: null,
             signOffProvidedBy: null
@@ -324,39 +300,46 @@ function createContentReviewMethods(params) {
         /**
          * Set next step status as "inactive".
          */
-
-
         if (index > stepIndex) {
           const previousStep = steps[index - 1];
           previousStepStatus = (0, _utils.getNextStepStatus)(previousStep.type, previousStepStatus);
-          return _objectSpread(_objectSpread({}, step), {}, {
+          return (0, _objectSpread2.default)((0, _objectSpread2.default)({}, step), {}, {
             status: previousStepStatus
           });
         }
-
         return step;
       });
+
       /**
        * Check for pending steps
        */
-
-      let newStatus = status;
+      let newStatus = reviewStatus;
       const pendingRequiredSteps = (0, _utils2.getPendingRequiredSteps)(updatedSteps, step => step.signOffProvidedOn === null);
       /**
        * If there are required steps that are pending, set the status to "UNDER_REVIEW".
        */
-
       if (pendingRequiredSteps.length !== 0) {
         newStatus = _types.ApwContentReviewStatus.UNDER_REVIEW;
       }
 
+      /**
+       * We need to delete the scheduled action if one was created.
+       */
+      const scheduledActionId = (_contentReview$conten = contentReview.content) === null || _contentReview$conten === void 0 ? void 0 : _contentReview$conten.scheduledActionId;
+      if (!!scheduledActionId) {
+        await scheduler.delete(scheduledActionId);
+      }
       await this.update(id, {
+        content: (0, _objectSpread2.default)((0, _objectSpread2.default)({}, content), {}, {
+          scheduledOn: null,
+          scheduledBy: null,
+          scheduledActionId: null
+        }),
         steps: updatedSteps,
-        status: newStatus
+        reviewStatus: newStatus
       });
       return true;
     },
-
     async isReviewRequired(data) {
       const contentGetter = getContentGetter(data.type);
       const content = await contentGetter(data.id, data.settings);
@@ -366,55 +349,47 @@ function createContentReviewMethods(params) {
         plugins,
         type: data.type
       });
-
       if (contentApwSettingsPlugin) {
         contentReviewId = contentApwSettingsPlugin.getContentReviewId(content);
         const workflowId = contentApwSettingsPlugin.getWorkflowId(content);
-
         if (workflowId) {
           isReviewRequired = true;
         }
       }
-
       return {
         isReviewRequired,
         contentReviewId
       };
     },
-
     async publishContent(id, datetime) {
       var _content$settings;
-
       const {
         content,
-        status
+        reviewStatus
       } = await this.get(id);
       const identity = getIdentity();
-
-      if (status !== _types.ApwContentReviewStatus.READY_TO_BE_PUBLISHED) {
+      if (reviewStatus !== _types.ApwContentReviewStatus.READY_TO_BE_PUBLISHED) {
         throw new _error.default({
           message: `Cannot publish content because it is not yet ready to be published.`,
           code: "NOT_READY_TO_BE_PUBLISHED",
           data: {
             id,
-            status,
+            status: reviewStatus,
             content
           }
         });
       }
-
       (0, _utils2.checkValidDateTime)(datetime);
+
       /**
        * If datetime is present it means we're scheduling this action.
        * And if not, we are publishing immediately.
        */
-
       if (!datetime) {
         const contentPublisher = getContentPublisher(content.type);
         await contentPublisher(content.id, content.settings);
         return true;
       }
-
       const data = {
         action: _types2.ApwScheduleActionTypes.PUBLISH,
         type: content.type,
@@ -426,9 +401,8 @@ function createContentReviewMethods(params) {
       /**
        * Update scheduled related meta data.
        */
-
       await this.update(id, {
-        content: _objectSpread(_objectSpread({}, content), {}, {
+        content: (0, _objectSpread2.default)((0, _objectSpread2.default)({}, content), {}, {
           scheduledOn: datetime,
           scheduledBy: identity.id,
           scheduledActionId
@@ -436,40 +410,35 @@ function createContentReviewMethods(params) {
       });
       return true;
     },
-
     async unpublishContent(id, datetime) {
       var _content$settings2;
-
       const {
         content,
-        status
+        reviewStatus
       } = await this.get(id);
       const identity = getIdentity();
-
-      if (status !== _types.ApwContentReviewStatus.PUBLISHED) {
+      if (reviewStatus !== _types.ApwContentReviewStatus.PUBLISHED) {
         throw new _error.default({
           message: `Cannot unpublish content because it is not yet published.`,
           code: "NOT_YET_PUBLISHED",
           data: {
             id,
-            status,
+            status: reviewStatus,
             content
           }
         });
       }
-
       (0, _utils2.checkValidDateTime)(datetime);
+
       /**
        * If datetime is present it means we're scheduling this action.
        * If not, we are unpublishing immediately.
        */
-
       if (!datetime) {
         const contentUnPublisher = getContentUnPublisher(content.type);
         await contentUnPublisher(content.id, content.settings);
         return true;
       }
-
       const scheduledActionId = await this.scheduleAction({
         action: _types2.ApwScheduleActionTypes.UNPUBLISH,
         type: content.type,
@@ -480,9 +449,8 @@ function createContentReviewMethods(params) {
       /**
        * Update scheduled related meta data.
        */
-
       await this.update(id, {
-        content: _objectSpread(_objectSpread({}, content), {}, {
+        content: (0, _objectSpread2.default)((0, _objectSpread2.default)({}, content), {}, {
           scheduledOn: datetime,
           scheduledBy: identity.id,
           scheduledActionId
@@ -490,7 +458,6 @@ function createContentReviewMethods(params) {
       });
       return true;
     },
-
     async scheduleAction(data) {
       // Save input in DB
       const scheduledAction = await scheduler.create(data);
@@ -498,12 +465,10 @@ function createContentReviewMethods(params) {
        * This function contains logic of lambda invocation.
        * Current we're not mocking it, therefore, we're just returning true.
        */
-
       if (process.env.NODE_ENV === "test") {
         return scheduledAction.id;
-      } // Invoke handler
-
-
+      }
+      // Invoke handler
       await handlerClient.invoke({
         name: String(process.env.APW_SCHEDULER_SCHEDULE_ACTION_HANDLER),
         payload: {
@@ -515,14 +480,13 @@ function createContentReviewMethods(params) {
       });
       return scheduledAction.id;
     },
-
     async deleteScheduledAction(id) {
       const contentReview = await this.get(id);
       const scheduledActionId = (0, _get.default)(contentReview, "content.scheduledActionId");
+
       /**
        * Check if there is any action scheduled for this "content review".
        */
-
       if (!scheduledActionId) {
         throw new _error.default({
           message: `There is no action scheduled for content review.`,
@@ -535,18 +499,15 @@ function createContentReviewMethods(params) {
       /**
        * Delete scheduled action.
        */
-
-
       await scheduler.delete(scheduledActionId);
+
       /**
        * Reset scheduled related meta data.
        */
-
       await this.update(id, {
-        content: _objectSpread(_objectSpread({}, contentReview.content), _utils2.INITIAL_CONTENT_REVIEW_CONTENT_SCHEDULE_META)
+        content: (0, _objectSpread2.default)((0, _objectSpread2.default)({}, contentReview.content), _utils2.INITIAL_CONTENT_REVIEW_CONTENT_SCHEDULE_META)
       });
       return true;
     }
-
   };
 }