@webiny/api-workflows 6.3.0 → 6.4.0-beta.1

package/domain/workflowState/WorkflowState.js

@@ -1,327 +1,224 @@
 import { WorkflowStateRecordState } from "./abstractions.js";
 import { Result } from "@webiny/feature/api";
-import { WorkflowStateNotAuthorizedError, WorkflowStateNoPendingStepError, WorkflowStateStepCannotReviewError, WorkflowStateStepCannotTakeOverError, WorkflowStateStepNotStepOwnerError, WorkflowStateInReviewError, WorkflowStateRejectedError, WorkflowStateNoCurrentStepError, WorkflowStateNotInReview } from "./errors.js";
-import { canReview } from "./guards/canReview.js";
+import { WorkflowStateInReviewError, WorkflowStateNoCurrentStepError, WorkflowStateNoPendingStepError, WorkflowStateNotAuthorizedError, WorkflowStateNotInReview, WorkflowStateRejectedError, WorkflowStateStepCannotReviewError, WorkflowStateStepCannotTakeOverError, WorkflowStateStepNotStepOwnerError } from "./errors.js";
+import { canReview as canReview_js_canReview } from "./guards/canReview.js";
 import { isRejected } from "./guards/isRejected.js";
-import { canTakeOver } from "./guards/canTakeOver.js";
+import { canTakeOver as canTakeOver_js_canTakeOver } from "./guards/canTakeOver.js";
 import { isInReview } from "./guards/isInReview.js";
 import { isStepOwner } from "./guards/isStepOwner.js";
-export class WorkflowState {
-  constructor(record, teams, currentIdentity) {
-    this.record = record;
-    this.teams = teams;
-    this.currentIdentity = currentIdentity;
-  }
-  get id() {
-    return this.record.id;
-  }
-  get app() {
-    return this.record.app;
-  }
-  get title() {
-    return this.record.title;
-  }
-  get workflowId() {
-    return this.record.workflowId;
-  }
-  get targetId() {
-    return this.record.targetId;
-  }
-  get targetRevisionId() {
-    return this.record.targetRevisionId;
-  }
-  get isActive() {
-    return this.record.isActive;
-  }
-  get comment() {
-    return this.record.comment;
-  }
-  get state() {
-    return this.record.state;
-  }
-  get steps() {
-    return this.record.steps.map(step => {
-      return this.enrichStep({
-        createdBy: this.record.createdBy,
-        step
-      });
-    });
-  }
-  get createdOn() {
-    return this.record.createdOn;
-  }
-  get savedOn() {
-    return this.record.savedOn;
-  }
-  get createdBy() {
-    return this.record.createdBy;
-  }
-  get savedBy() {
-    return this.record.savedBy;
-  }
-  get done() {
-    /**
-     * A just-in-case check.
-     */
-    if (this.record.steps.length === 0) {
-      return false;
-    }
-    return this.record.steps.every(step => {
-      return step.state === WorkflowStateRecordState.approved;
-    });
-  }
-
-  /**
-   * Current step can be:
-   * - in review step
-   * - rejected step - can only be one
-   * - first pending step
-   * - last approved step
-   */
-  get currentStep() {
-    const steps = this.steps;
-    const inReview = steps.find(step => step.state === WorkflowStateRecordState.inReview);
-    if (inReview) {
-      return inReview;
-    }
-    const rejected = steps.find(step => step.state === WorkflowStateRecordState.rejected);
-    if (rejected) {
-      return rejected;
-    }
-    const pending = steps.find(step => step.state === WorkflowStateRecordState.pending);
-    if (pending) {
-      return pending;
-    }
-    const approved = steps.toReversed().find(step => step.state === WorkflowStateRecordState.approved);
-    if (approved) {
-      return approved;
-    }
-    throw new WorkflowStateNoCurrentStepError(steps);
-  }
-  get nextStep() {
-    const steps = this.steps;
-    const currentStep = this.currentStep;
-    const currentIndex = steps.findIndex(step => step.id === currentStep.id);
-    if (currentIndex === -1) {
-      return null;
-    }
-    return steps[currentIndex + 1] || null;
-  }
-  get previousStep() {
-    const steps = this.steps;
-    const currentStep = this.currentStep;
-    const currentIndex = steps.findIndex(step => step.id === currentStep.id);
-    if (currentIndex <= 0) {
-      return null;
-    }
-    return steps[currentIndex - 1] || null;
-  }
-
-  /**
-   * Active step is the one that is currently "inReview". If there is a rejected step, returns null.
-   */
-  getActiveStep() {
-    const steps = this.steps;
-    const hasRejected = steps.some(step => {
-      return step.state === WorkflowStateRecordState.rejected;
-    });
-    if (hasRejected) {
-      return null;
-    }
-    const step = steps.find(step => {
-      return step.state === WorkflowStateRecordState.inReview;
-    });
-    return step || null;
-  }
-  start() {
-    const stepResult = this.getPendingStep();
-    if (stepResult.isFail()) {
-      return Result.fail(stepResult.error);
-    }
-    const step = stepResult.value;
-    if (!canReview(step)) {
-      return Result.fail(new WorkflowStateStepCannotReviewError(step));
-    }
-    const identity = {
-      id: this.currentIdentity.id,
-      displayName: this.currentIdentity.displayName,
-      type: this.currentIdentity.type
-    };
-    this.updateStep(step.id, {
-      savedBy: identity,
-      state: WorkflowStateRecordState.inReview
-    });
-    this.updateRecord({
-      savedBy: identity,
-      state: WorkflowStateRecordState.inReview
-    });
-    return Result.ok();
-  }
-  takeOver() {
-    if (isRejected(this.record)) {
-      return Result.fail(new WorkflowStateRejectedError(this.record));
-    }
-    const step = this.getActiveStep();
-    if (!step) {
-      return Result.fail(new WorkflowStateNotAuthorizedError(`Cannot take over a workflow state that is not in review.`));
-    }
-    if (!canTakeOver(step)) {
-      return Result.fail(new WorkflowStateStepCannotTakeOverError(step));
-    }
-    if (!canReview(step)) {
-      return Result.fail(new WorkflowStateStepCannotReviewError(step));
-    }
-    const identity = {
-      id: this.currentIdentity.id,
-      displayName: this.currentIdentity.displayName,
-      type: this.currentIdentity.type
-    };
-    this.updateStep(step.id, {
-      savedBy: identity
-    });
-    this.updateRecord({
-      savedBy: identity
-    });
-    return Result.ok();
-  }
-  approve(comment) {
-    if (isRejected(this.record)) {
-      return Result.fail(new WorkflowStateRejectedError(this.record));
-    }
-    const step = this.getActiveStep();
-    /**
-     * Step cannot be found - all steps are either approved or rejected.
-     */
-    if (!step) {
-      return Result.fail(new WorkflowStateNotAuthorizedError(`Cannot approve a workflow state that is not in review.`));
-    }
-    if (!canReview(step)) {
-      return Result.fail(new WorkflowStateStepCannotReviewError(step));
-    }
-    if (!isStepOwner(step)) {
-      return Result.fail(new WorkflowStateStepNotStepOwnerError(step));
-    }
-    this.approveStep(step.id, comment);
-    const nextStep = this.getNextStep(step.id);
-    this.updateRecord({
-      state: nextStep ? WorkflowStateRecordState.pending : WorkflowStateRecordState.approved
-    });
-    return Result.ok();
-  }
-  reject(comment) {
-    if (isRejected(this.record)) {
-      return Result.fail(new WorkflowStateRejectedError(this.record));
-    }
-    const step = this.getActiveStep();
-    if (!step) {
-      return Result.fail(new WorkflowStateNotInReview(`Cannot reject a workflow state that is not in review.`, this));
-    }
-    if (!canReview(step)) {
-      return Result.fail(new WorkflowStateStepCannotReviewError(step));
-    }
-    if (!isStepOwner(step)) {
-      return Result.fail(new WorkflowStateStepNotStepOwnerError(step));
-    }
-    this.rejectStep(step.id, comment);
-    this.updateRecord({
-      state: WorkflowStateRecordState.rejected
-    });
-    return Result.ok();
-  }
-  getPendingStep() {
-    if (isRejected(this.record)) {
-      return Result.fail(new WorkflowStateRejectedError(this.record));
-    }
-    if (isInReview(this.record)) {
-      return Result.fail(new WorkflowStateInReviewError(this.record));
-    }
-    for (const step of this.steps) {
-      if (step.state === WorkflowStateRecordState.pending) {
-        return Result.ok(step);
-      }
-    }
-    return Result.fail(new WorkflowStateNoPendingStepError());
-  }
-  updateRecord(record) {
-    Object.assign(this.record, record);
-  }
-  updateStep(id, input) {
-    const step = this.record.steps.find(s => s.id === id);
-    if (!step) {
-      throw new Error(`Step with ID "${id}" not found.`);
-    }
-    Object.assign(step, {
-      savedBy: {
-        id: this.currentIdentity.id,
-        displayName: this.currentIdentity.displayName,
-        type: this.currentIdentity.type
-      },
-      ...input
-    });
-  }
-  approveStep(id, comment) {
-    this.updateStep(id, {
-      state: WorkflowStateRecordState.approved,
-      comment
-    });
-  }
-  rejectStep(id, comment) {
-    this.updateStep(id, {
-      state: WorkflowStateRecordState.rejected,
-      comment
-    });
-  }
-  getNextStep(currentStepId) {
-    const index = this.record.steps.findIndex(s => s.id === currentStepId);
-    if (index === -1) {
-      return undefined;
-    }
-    return this.record.steps[index + 1];
-  }
-  enrichStep(params) {
-    const {
-      step,
-      createdBy
-    } = params;
-    const identity = this.currentIdentity;
-    /**
-     * User who created the workflow state cannot take part in reviewing it.
-     */
-    if (createdBy.id === identity.id) {
-      return {
-        ...step,
-        isOwner: false,
-        canTakeOver: false,
-        canReview: false
-      };
-    }
-    /**
-     * Current user is step owner - they started the review.
-     */
-    const isOwner = step.savedBy?.id === identity.id;
-    /**
-     * Can current user actually review this step?
-     */
-    const canReview = step.teams.some(team => {
-      return this.teams.some(t => {
-        return t.id === team.id;
-      });
-    });
-    /**
-     * Can current user take over the review from another reviewer?
-     * Taking over is only possible if current user did not start the review of the step - and review was actually started.
-     */
-    const canTakeOver = canReview && !!step.savedBy?.id && step.state === WorkflowStateRecordState.inReview;
-    return {
-      ...step,
-      canTakeOver: !isOwner ? canTakeOver : false,
-      isOwner,
-      canReview
-    };
-  }
-  toRecord() {
-    return this.record;
-  }
+class WorkflowState {
+    constructor(record, teams, currentIdentity){
+        this.record = record;
+        this.teams = teams;
+        this.currentIdentity = currentIdentity;
+    }
+    get id() {
+        return this.record.id;
+    }
+    get app() {
+        return this.record.app;
+    }
+    get title() {
+        return this.record.title;
+    }
+    get workflowId() {
+        return this.record.workflowId;
+    }
+    get targetId() {
+        return this.record.targetId;
+    }
+    get targetRevisionId() {
+        return this.record.targetRevisionId;
+    }
+    get isActive() {
+        return this.record.isActive;
+    }
+    get comment() {
+        return this.record.comment;
+    }
+    get state() {
+        return this.record.state;
+    }
+    get steps() {
+        return this.record.steps.map((step)=>this.enrichStep({
+                createdBy: this.record.createdBy,
+                step
+            }));
+    }
+    get createdOn() {
+        return this.record.createdOn;
+    }
+    get savedOn() {
+        return this.record.savedOn;
+    }
+    get createdBy() {
+        return this.record.createdBy;
+    }
+    get savedBy() {
+        return this.record.savedBy;
+    }
+    get done() {
+        if (0 === this.record.steps.length) return false;
+        return this.record.steps.every((step)=>step.state === WorkflowStateRecordState.approved);
+    }
+    get currentStep() {
+        const steps = this.steps;
+        const inReview = steps.find((step)=>step.state === WorkflowStateRecordState.inReview);
+        if (inReview) return inReview;
+        const rejected = steps.find((step)=>step.state === WorkflowStateRecordState.rejected);
+        if (rejected) return rejected;
+        const pending = steps.find((step)=>step.state === WorkflowStateRecordState.pending);
+        if (pending) return pending;
+        const approved = steps.toReversed().find((step)=>step.state === WorkflowStateRecordState.approved);
+        if (approved) return approved;
+        throw new WorkflowStateNoCurrentStepError(steps);
+    }
+    get nextStep() {
+        const steps = this.steps;
+        const currentStep = this.currentStep;
+        const currentIndex = steps.findIndex((step)=>step.id === currentStep.id);
+        if (-1 === currentIndex) return null;
+        return steps[currentIndex + 1] || null;
+    }
+    get previousStep() {
+        const steps = this.steps;
+        const currentStep = this.currentStep;
+        const currentIndex = steps.findIndex((step)=>step.id === currentStep.id);
+        if (currentIndex <= 0) return null;
+        return steps[currentIndex - 1] || null;
+    }
+    getActiveStep() {
+        const steps = this.steps;
+        const hasRejected = steps.some((step)=>step.state === WorkflowStateRecordState.rejected);
+        if (hasRejected) return null;
+        const step = steps.find((step)=>step.state === WorkflowStateRecordState.inReview);
+        return step || null;
+    }
+    start() {
+        const stepResult = this.getPendingStep();
+        if (stepResult.isFail()) return Result.fail(stepResult.error);
+        const step = stepResult.value;
+        if (!canReview_js_canReview(step)) return Result.fail(new WorkflowStateStepCannotReviewError(step));
+        const identity = {
+            id: this.currentIdentity.id,
+            displayName: this.currentIdentity.displayName,
+            type: this.currentIdentity.type
+        };
+        this.updateStep(step.id, {
+            savedBy: identity,
+            state: WorkflowStateRecordState.inReview
+        });
+        this.updateRecord({
+            savedBy: identity,
+            state: WorkflowStateRecordState.inReview
+        });
+        return Result.ok();
+    }
+    takeOver() {
+        if (isRejected(this.record)) return Result.fail(new WorkflowStateRejectedError(this.record));
+        const step = this.getActiveStep();
+        if (!step) return Result.fail(new WorkflowStateNotAuthorizedError("Cannot take over a workflow state that is not in review."));
+        if (!canTakeOver_js_canTakeOver(step)) return Result.fail(new WorkflowStateStepCannotTakeOverError(step));
+        if (!canReview_js_canReview(step)) return Result.fail(new WorkflowStateStepCannotReviewError(step));
+        const identity = {
+            id: this.currentIdentity.id,
+            displayName: this.currentIdentity.displayName,
+            type: this.currentIdentity.type
+        };
+        this.updateStep(step.id, {
+            savedBy: identity
+        });
+        this.updateRecord({
+            savedBy: identity
+        });
+        return Result.ok();
+    }
+    approve(comment) {
+        if (isRejected(this.record)) return Result.fail(new WorkflowStateRejectedError(this.record));
+        const step = this.getActiveStep();
+        if (!step) return Result.fail(new WorkflowStateNotAuthorizedError("Cannot approve a workflow state that is not in review."));
+        if (!canReview_js_canReview(step)) return Result.fail(new WorkflowStateStepCannotReviewError(step));
+        if (!isStepOwner(step)) return Result.fail(new WorkflowStateStepNotStepOwnerError(step));
+        this.approveStep(step.id, comment);
+        const nextStep = this.getNextStep(step.id);
+        this.updateRecord({
+            state: nextStep ? WorkflowStateRecordState.pending : WorkflowStateRecordState.approved
+        });
+        return Result.ok();
+    }
+    reject(comment) {
+        if (isRejected(this.record)) return Result.fail(new WorkflowStateRejectedError(this.record));
+        const step = this.getActiveStep();
+        if (!step) return Result.fail(new WorkflowStateNotInReview("Cannot reject a workflow state that is not in review.", this));
+        if (!canReview_js_canReview(step)) return Result.fail(new WorkflowStateStepCannotReviewError(step));
+        if (!isStepOwner(step)) return Result.fail(new WorkflowStateStepNotStepOwnerError(step));
+        this.rejectStep(step.id, comment);
+        this.updateRecord({
+            state: WorkflowStateRecordState.rejected
+        });
+        return Result.ok();
+    }
+    getPendingStep() {
+        if (isRejected(this.record)) return Result.fail(new WorkflowStateRejectedError(this.record));
+        if (isInReview(this.record)) return Result.fail(new WorkflowStateInReviewError(this.record));
+        for (const step of this.steps)if (step.state === WorkflowStateRecordState.pending) return Result.ok(step);
+        return Result.fail(new WorkflowStateNoPendingStepError());
+    }
+    updateRecord(record) {
+        Object.assign(this.record, record);
+    }
+    updateStep(id, input) {
+        const step = this.record.steps.find((s)=>s.id === id);
+        if (!step) throw new Error(`Step with ID "${id}" not found.`);
+        Object.assign(step, {
+            savedBy: {
+                id: this.currentIdentity.id,
+                displayName: this.currentIdentity.displayName,
+                type: this.currentIdentity.type
+            },
+            ...input
+        });
+    }
+    approveStep(id, comment) {
+        this.updateStep(id, {
+            state: WorkflowStateRecordState.approved,
+            comment
+        });
+    }
+    rejectStep(id, comment) {
+        this.updateStep(id, {
+            state: WorkflowStateRecordState.rejected,
+            comment
+        });
+    }
+    getNextStep(currentStepId) {
+        const index = this.record.steps.findIndex((s)=>s.id === currentStepId);
+        if (-1 === index) return;
+        return this.record.steps[index + 1];
+    }
+    enrichStep(params) {
+        const { step, createdBy } = params;
+        const identity = this.currentIdentity;
+        if (createdBy.id === identity.id) return {
+            ...step,
+            isOwner: false,
+            canTakeOver: false,
+            canReview: false
+        };
+        const isOwner = step.savedBy?.id === identity.id;
+        const canReview = step.teams.some((team)=>this.teams.some((t)=>t.id === team.id));
+        const canTakeOver = canReview && !!step.savedBy?.id && step.state === WorkflowStateRecordState.inReview;
+        return {
+            ...step,
+            canTakeOver: isOwner ? false : canTakeOver,
+            isOwner,
+            canReview
+        };
+    }
+    toRecord() {
+        return this.record;
+    }
 }
+export { WorkflowState };
 
 //# sourceMappingURL=WorkflowState.js.map