@webiny/api-apw 0.0.0-unstable.1e66d121db → 0.0.0-unstable.2696f9d9e8

package/crud/createContentReviewMethods.js

@@ -1,32 +1,19 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createContentReviewMethods = createContentReviewMethods;
-
-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 createContentReviewMethods(params) {
   const {
     getIdentity,
@@ -40,16 +27,19 @@ function createContentReviewMethods(params) {
     getTenant,
     getLocale,
     plugins
-  } = params; // create
+  } = params;
 
+  // create
   const onContentReviewBeforeCreate = (0, _pubsub.createTopic)("apw.onContentReviewBeforeCreate");
-  const onContentReviewAfterCreate = (0, _pubsub.createTopic)("apw.onContentReviewAfterCreate"); // update
-
+  const onContentReviewAfterCreate = (0, _pubsub.createTopic)("apw.onContentReviewAfterCreate");
+  // update
   const onContentReviewBeforeUpdate = (0, _pubsub.createTopic)("apw.onContentReviewBeforeUpdate");
-  const onContentReviewAfterUpdate = (0, _pubsub.createTopic)("apw.onContentReviewAfterUpdate"); // delete
-
+  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
@@ -60,32 +50,38 @@ function createContentReviewMethods(params) {
     onContentReviewAfterUpdate,
     onContentReviewBeforeDelete,
     onContentReviewAfterDelete,
-
+    onContentReviewBeforeList,
     async get(id) {
       return storageOperations.getContentReview({
         id
       });
     },
-
     async list(params) {
-      var _params$where;
-
-      if (((_params$where = params.where) === null || _params$where === void 0 ? void 0 : _params$where.reviewStatus) === "requiresMyAttention") {
+      const where = params.where || {};
+      await onContentReviewBeforeList.publish({
+        where
+      });
+      if (where.reviewStatus === "requiresMyAttention") {
         return (0, _utils2.filterContentReviewsByRequiresMyAttention)({
-          listParams: params,
+          listParams: {
+            ...params,
+            where
+          },
           listContentReviews: storageOperations.listContentReviews,
           getReviewer,
           getIdentity
         });
       }
-
-      return storageOperations.listContentReviews(params);
+      return storageOperations.listContentReviews({
+        ...params,
+        where
+      });
     },
-
     async create(data) {
-      const input = (0, _objectSpread2.default)((0, _objectSpread2.default)({}, data), {}, {
+      const input = {
+        ...data,
         reviewStatus: _types.ApwContentReviewStatus.UNDER_REVIEW
-      });
+      };
       await onContentReviewBeforeCreate.publish({
         input
       });
@@ -97,7 +93,6 @@ function createContentReviewMethods(params) {
       });
       return contentReview;
     },
-
     async update(id, data) {
       const original = await storageOperations.getContentReview({
         id
@@ -123,7 +118,6 @@ function createContentReviewMethods(params) {
       });
       return contentReview;
     },
-
     async delete(id) {
       const contentReview = await storageOperations.getContentReview({
         id
@@ -139,7 +133,6 @@ function createContentReviewMethods(params) {
       });
       return true;
     },
-
     async provideSignOff(id, stepId) {
       const entry = await this.get(id);
       const {
@@ -155,10 +148,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 +164,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 +176,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 +188,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,67 +197,62 @@ 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 (0, _objectSpread2.default)((0, _objectSpread2.default)({}, step), {}, {
+          return {
+            ...step,
             status: _types.ApwContentReviewStepStatus.DONE,
             signOffProvidedOn: new Date().toISOString(),
             signOffProvidedBy: identity
-          });
+          };
         }
         /**
          * Update next steps status based on type.
          */
-
-
         if (index > stepIndex) {
           const previousStep = steps[index - 1];
           previousStepStatus = (0, _utils.getNextStepStatus)(previousStep.type, previousStepStatus);
-          return (0, _objectSpread2.default)((0, _objectSpread2.default)({}, step), {}, {
+          return {
+            ...step,
             status: previousStepStatus
-          });
+          };
         }
-
         return step;
       });
       /**
        * Check for pending steps
        */
-
       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,
         reviewStatus: newStatus
       });
       return true;
     },
-
     async retractSignOff(id, stepId) {
-      const entry = await this.get(id);
+      const contentReview = await this.get(id);
       const {
         steps,
-        reviewStatus
-      } = entry;
+        reviewStatus,
+        content
+      } = contentReview;
       const stepIndex = steps.findIndex(step => step.id === stepId);
       const currentStep = steps[stepIndex];
       const identity = getIdentity();
@@ -279,13 +261,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,68 +277,75 @@ 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 (0, _objectSpread2.default)((0, _objectSpread2.default)({}, step), {}, {
+          return {
+            ...step,
             status: previousStepStatus,
             signOffProvidedOn: null,
             signOffProvidedBy: null
-          });
+          };
         }
         /**
          * Set next step status as "inactive".
          */
-
-
         if (index > stepIndex) {
           const previousStep = steps[index - 1];
           previousStepStatus = (0, _utils.getNextStepStatus)(previousStep.type, previousStepStatus);
-          return (0, _objectSpread2.default)((0, _objectSpread2.default)({}, step), {}, {
+          return {
+            ...step,
             status: previousStepStatus
-          });
+          };
         }
-
         return step;
       });
+
       /**
        * Check for pending steps
        */
-
       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.content?.scheduledActionId;
+      if (!!scheduledActionId) {
+        await scheduler.delete(scheduledActionId);
+      }
       await this.update(id, {
+        content: {
+          ...content,
+          scheduledOn: null,
+          scheduledBy: null,
+          scheduledActionId: null
+        },
         steps: updatedSteps,
         reviewStatus: newStatus
       });
       return true;
     },
-
     async isReviewRequired(data) {
       const contentGetter = getContentGetter(data.type);
       const content = await contentGetter(data.id, data.settings);
@@ -366,31 +355,24 @@ 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,
         reviewStatus
       } = await this.get(id);
       const identity = getIdentity();
-
       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.`,
@@ -402,50 +384,44 @@ function createContentReviewMethods(params) {
           }
         });
       }
-
       (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,
         entryId: content.id,
-        modelId: (_content$settings = content.settings) === null || _content$settings === void 0 ? void 0 : _content$settings.modelId,
+        modelId: content.settings?.modelId,
         datetime
       };
       const scheduledActionId = await this.scheduleAction(data);
       /**
        * Update scheduled related meta data.
        */
-
       await this.update(id, {
-        content: (0, _objectSpread2.default)((0, _objectSpread2.default)({}, content), {}, {
+        content: {
+          ...content,
           scheduledOn: datetime,
           scheduledBy: identity.id,
           scheduledActionId
-        })
+        }
       });
       return true;
     },
-
     async unpublishContent(id, datetime) {
-      var _content$settings2;
-
       const {
         content,
         reviewStatus
       } = await this.get(id);
       const identity = getIdentity();
-
       if (reviewStatus !== _types.ApwContentReviewStatus.PUBLISHED) {
         throw new _error.default({
           message: `Cannot unpublish content because it is not yet published.`,
@@ -457,40 +433,37 @@ function createContentReviewMethods(params) {
           }
         });
       }
-
       (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,
         entryId: content.id,
-        modelId: (_content$settings2 = content.settings) === null || _content$settings2 === void 0 ? void 0 : _content$settings2.modelId,
+        modelId: content.settings?.modelId,
         datetime
       });
       /**
        * Update scheduled related meta data.
        */
-
       await this.update(id, {
-        content: (0, _objectSpread2.default)((0, _objectSpread2.default)({}, content), {}, {
+        content: {
+          ...content,
           scheduledOn: datetime,
           scheduledBy: identity.id,
           scheduledActionId
-        })
+        }
       });
       return true;
     },
-
     async scheduleAction(data) {
       // Save input in DB
       const scheduledAction = await scheduler.create(data);
@@ -498,12 +471,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 +486,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 +505,20 @@ function createContentReviewMethods(params) {
       /**
        * Delete scheduled action.
        */
-
-
       await scheduler.delete(scheduledActionId);
+
       /**
        * Reset scheduled related meta data.
        */
-
       await this.update(id, {
-        content: (0, _objectSpread2.default)((0, _objectSpread2.default)({}, contentReview.content), _utils2.INITIAL_CONTENT_REVIEW_CONTENT_SCHEDULE_META)
+        content: {
+          ...contentReview.content,
+          ..._utils2.INITIAL_CONTENT_REVIEW_CONTENT_SCHEDULE_META
+        }
       });
       return true;
     }
-
   };
-}
+}
+
+//# sourceMappingURL=createContentReviewMethods.js.map