@webiny/api-workflows 0.0.0-unstable.0d717d18dd

package/domain/workflowState/WorkflowState.d.ts

@@ -0,0 +1,56 @@
+import type { IWorkflowState, IWorkflowStateRecord, IWorkflowStateIdentity, IEnrichedWorkflowStateRecordStep } from "./abstractions.js";
+import { WorkflowStateRecordState } from "./abstractions.js";
+import { Result } from "@webiny/feature/api";
+import type { IWorkflowStepTeam } from "../workflow/abstractions.js";
+import { WorkflowStateNotAuthorizedError, WorkflowStateNoPendingStepError, WorkflowStateStepCannotReviewError, WorkflowStateStepCannotTakeOverError, WorkflowStateStepNotStepOwnerError, WorkflowStateInReviewError, WorkflowStateRejectedError, WorkflowStateNoCurrentStepError, WorkflowStateNotInReview } from "./errors.js";
+export declare class WorkflowState implements IWorkflowState {
+    private record;
+    private teams;
+    private currentIdentity;
+    constructor(record: IWorkflowStateRecord, teams: IWorkflowStepTeam[], currentIdentity: IWorkflowStateIdentity);
+    get id(): string;
+    get app(): string;
+    get title(): string;
+    get workflowId(): string;
+    get targetId(): string;
+    get targetRevisionId(): string;
+    get isActive(): boolean;
+    get comment(): string | undefined;
+    get state(): WorkflowStateRecordState;
+    get steps(): IEnrichedWorkflowStateRecordStep[];
+    get createdOn(): Date;
+    get savedOn(): Date;
+    get createdBy(): IWorkflowStateIdentity;
+    get savedBy(): IWorkflowStateIdentity;
+    get targetContext(): import("@webiny/api/types.js").GenericRecord;
+    get done(): boolean;
+    /**
+     * Current step can be:
+     * - in review step
+     * - rejected step - can only be one
+     * - first pending step
+     * - last approved step
+     */
+    get currentStep(): IEnrichedWorkflowStateRecordStep;
+    get nextStep(): IEnrichedWorkflowStateRecordStep | null;
+    get previousStep(): IEnrichedWorkflowStateRecordStep | null;
+    /**
+     * Active step is the one that is currently "inReview". If there is a rejected step, returns null.
+     */
+    getActiveStep(): IEnrichedWorkflowStateRecordStep | null;
+    start(): Result<void, WorkflowState.Error>;
+    takeOver(): Result<void, WorkflowState.Error>;
+    approve(comment?: string): Result<void, WorkflowState.Error>;
+    reject(comment: string): Result<void, WorkflowState.Error>;
+    private getPendingStep;
+    private updateRecord;
+    private updateStep;
+    private approveStep;
+    private rejectStep;
+    private getNextStep;
+    private enrichStep;
+    toRecord(): IWorkflowStateRecord;
+}
+export declare namespace WorkflowState {
+    type Error = WorkflowStateNotAuthorizedError | WorkflowStateNoPendingStepError | WorkflowStateStepCannotReviewError | WorkflowStateStepCannotTakeOverError | WorkflowStateStepNotStepOwnerError | WorkflowStateInReviewError | WorkflowStateNotInReview | WorkflowStateRejectedError | WorkflowStateNoCurrentStepError;
+}

package/domain/workflowState/WorkflowState.js

@@ -0,0 +1,227 @@
+import { WorkflowStateRecordState } from "./abstractions.js";
+import { Result } from "@webiny/feature/api";
+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 as canTakeOver_js_canTakeOver } from "./guards/canTakeOver.js";
+import { isInReview } from "./guards/isInReview.js";
+import { isStepOwner } from "./guards/isStepOwner.js";
+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 targetContext() {
+        return this.record.targetContext;
+    }
+    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

package/domain/workflowState/WorkflowState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"domain/workflowState/WorkflowState.js","sources":["../../../src/domain/workflowState/WorkflowState.ts"],"sourcesContent":["import type {\n    IWorkflowState,\n    IWorkflowStateRecord,\n    IWorkflowStateIdentity,\n    IEnrichedWorkflowStateRecordStep,\n    IWorkflowStateRecordStep\n} from \"./abstractions.js\";\nimport { WorkflowStateRecordState } from \"./abstractions.js\";\nimport { Result } from \"@webiny/feature/api\";\nimport type { IWorkflowStepTeam } from \"../workflow/abstractions.js\";\nimport {\n    WorkflowStateNotAuthorizedError,\n    WorkflowStateNoPendingStepError,\n    WorkflowStateStepCannotReviewError,\n    WorkflowStateStepCannotTakeOverError,\n    WorkflowStateStepNotStepOwnerError,\n    WorkflowStateInReviewError,\n    WorkflowStateRejectedError,\n    WorkflowStateNoCurrentStepError,\n    WorkflowStateNotInReview\n} from \"./errors.js\";\nimport { canReview } from \"./guards/canReview.js\";\nimport { isRejected } from \"./guards/isRejected.js\";\nimport { canTakeOver } from \"./guards/canTakeOver.js\";\nimport { isInReview } from \"./guards/isInReview.js\";\nimport { isStepOwner } from \"./guards/isStepOwner.js\";\n\ninterface IEnrichStepWithPermissionParams {\n    createdBy: Pick<IWorkflowStateIdentity, \"id\">;\n    step: IWorkflowStateRecordStep;\n}\n\nexport class WorkflowState implements IWorkflowState {\n    constructor(\n        private record: IWorkflowStateRecord,\n        private teams: IWorkflowStepTeam[],\n        private currentIdentity: IWorkflowStateIdentity\n    ) {}\n\n    get id() {\n        return this.record.id;\n    }\n\n    get app() {\n        return this.record.app;\n    }\n\n    get title() {\n        return this.record.title;\n    }\n\n    get workflowId() {\n        return this.record.workflowId;\n    }\n\n    get targetId() {\n        return this.record.targetId;\n    }\n\n    get targetRevisionId() {\n        return this.record.targetRevisionId;\n    }\n\n    get isActive() {\n        return this.record.isActive;\n    }\n\n    get comment() {\n        return this.record.comment;\n    }\n\n    get state() {\n        return this.record.state;\n    }\n\n    get steps() {\n        return this.record.steps.map(step => {\n            return this.enrichStep({ createdBy: this.record.createdBy, step });\n        });\n    }\n\n    get createdOn() {\n        return this.record.createdOn;\n    }\n\n    get savedOn() {\n        return this.record.savedOn;\n    }\n\n    get createdBy() {\n        return this.record.createdBy;\n    }\n\n    get savedBy() {\n        return this.record.savedBy;\n    }\n\n    get targetContext() {\n        return this.record.targetContext;\n    }\n\n    get done(): boolean {\n        /**\n         * A just-in-case check.\n         */\n        if (this.record.steps.length === 0) {\n            return false;\n        }\n        return this.record.steps.every(step => {\n            return step.state === WorkflowStateRecordState.approved;\n        });\n    }\n\n    /**\n     * Current step can be:\n     * - in review step\n     * - rejected step - can only be one\n     * - first pending step\n     * - last approved step\n     */\n    get currentStep(): IEnrichedWorkflowStateRecordStep {\n        const steps = this.steps;\n        const inReview = steps.find(step => step.state === WorkflowStateRecordState.inReview);\n        if (inReview) {\n            return inReview;\n        }\n\n        const rejected = steps.find(step => step.state === WorkflowStateRecordState.rejected);\n        if (rejected) {\n            return rejected;\n        }\n        const pending = steps.find(step => step.state === WorkflowStateRecordState.pending);\n        if (pending) {\n            return pending;\n        }\n        const approved = steps\n            .toReversed()\n            .find(step => step.state === WorkflowStateRecordState.approved);\n        if (approved) {\n            return approved;\n        }\n        throw new WorkflowStateNoCurrentStepError(steps);\n    }\n\n    get nextStep(): IEnrichedWorkflowStateRecordStep | null {\n        const steps = this.steps;\n        const currentStep = this.currentStep;\n        const currentIndex = steps.findIndex(step => step.id === currentStep.id);\n        if (currentIndex === -1) {\n            return null;\n        }\n        return steps[currentIndex + 1] || null;\n    }\n\n    get previousStep(): IEnrichedWorkflowStateRecordStep | null {\n        const steps = this.steps;\n        const currentStep = this.currentStep;\n        const currentIndex = steps.findIndex(step => step.id === currentStep.id);\n        if (currentIndex <= 0) {\n            return null;\n        }\n        return steps[currentIndex - 1] || null;\n    }\n\n    /**\n     * Active step is the one that is currently \"inReview\". If there is a rejected step, returns null.\n     */\n    getActiveStep(): IEnrichedWorkflowStateRecordStep | null {\n        const steps = this.steps;\n        const hasRejected = steps.some(step => {\n            return step.state === WorkflowStateRecordState.rejected;\n        });\n        if (hasRejected) {\n            return null;\n        }\n        const step = steps.find(step => {\n            return step.state === WorkflowStateRecordState.inReview;\n        });\n        return step || null;\n    }\n\n    start(): Result<void, WorkflowState.Error> {\n        const stepResult = this.getPendingStep();\n        if (stepResult.isFail()) {\n            return Result.fail(stepResult.error);\n        }\n\n        const step = stepResult.value;\n\n        if (!canReview(step)) {\n            return Result.fail(new WorkflowStateStepCannotReviewError(step));\n        }\n\n        const identity = {\n            id: this.currentIdentity.id,\n            displayName: this.currentIdentity.displayName,\n            type: this.currentIdentity.type\n        };\n\n        this.updateStep(step.id, {\n            savedBy: identity,\n            state: WorkflowStateRecordState.inReview\n        });\n        this.updateRecord({\n            savedBy: identity,\n            state: WorkflowStateRecordState.inReview\n        });\n\n        return Result.ok();\n    }\n\n    takeOver(): Result<void, WorkflowState.Error> {\n        if (isRejected(this.record)) {\n            return Result.fail(new WorkflowStateRejectedError(this.record));\n        }\n        const step = this.getActiveStep();\n        if (!step) {\n            return Result.fail(\n                new WorkflowStateNotAuthorizedError(\n                    `Cannot take over a workflow state that is not in review.`\n                )\n            );\n        }\n        if (!canTakeOver(step)) {\n            return Result.fail(new WorkflowStateStepCannotTakeOverError(step));\n        }\n        if (!canReview(step)) {\n            return Result.fail(new WorkflowStateStepCannotReviewError(step));\n        }\n\n        const identity = {\n            id: this.currentIdentity.id,\n            displayName: this.currentIdentity.displayName,\n            type: this.currentIdentity.type\n        };\n\n        this.updateStep(step.id, {\n            savedBy: identity\n        });\n        this.updateRecord({\n            savedBy: identity\n        });\n\n        return Result.ok();\n    }\n\n    approve(comment?: string): Result<void, WorkflowState.Error> {\n        if (isRejected(this.record)) {\n            return Result.fail(new WorkflowStateRejectedError(this.record));\n        }\n        const step = this.getActiveStep();\n        /**\n         * Step cannot be found - all steps are either approved or rejected.\n         */\n        if (!step) {\n            return Result.fail(\n                new WorkflowStateNotAuthorizedError(\n                    `Cannot approve a workflow state that is not in review.`\n                )\n            );\n        }\n        if (!canReview(step)) {\n            return Result.fail(new WorkflowStateStepCannotReviewError(step));\n        }\n        if (!isStepOwner(step)) {\n            return Result.fail(new WorkflowStateStepNotStepOwnerError(step));\n        }\n\n        this.approveStep(step.id, comment);\n\n        const nextStep = this.getNextStep(step.id);\n\n        this.updateRecord({\n            state: nextStep ? WorkflowStateRecordState.pending : WorkflowStateRecordState.approved\n        });\n\n        return Result.ok();\n    }\n\n    reject(comment: string): Result<void, WorkflowState.Error> {\n        if (isRejected(this.record)) {\n            return Result.fail(new WorkflowStateRejectedError(this.record));\n        }\n        const step = this.getActiveStep();\n        if (!step) {\n            return Result.fail(\n                new WorkflowStateNotInReview(\n                    `Cannot reject a workflow state that is not in review.`,\n                    this\n                )\n            );\n        }\n\n        if (!canReview(step)) {\n            return Result.fail(new WorkflowStateStepCannotReviewError(step));\n        }\n        if (!isStepOwner(step)) {\n            return Result.fail(new WorkflowStateStepNotStepOwnerError(step));\n        }\n\n        this.rejectStep(step.id, comment);\n        this.updateRecord({\n            state: WorkflowStateRecordState.rejected\n        });\n\n        return Result.ok();\n    }\n\n    private getPendingStep(): Result<\n        IEnrichedWorkflowStateRecordStep,\n        WorkflowStateRejectedError | WorkflowStateInReviewError | WorkflowStateNoPendingStepError\n    > {\n        if (isRejected(this.record)) {\n            return Result.fail(new WorkflowStateRejectedError(this.record));\n        }\n        if (isInReview(this.record)) {\n            return Result.fail(new WorkflowStateInReviewError(this.record));\n        }\n        for (const step of this.steps) {\n            if (step.state === WorkflowStateRecordState.pending) {\n                return Result.ok(step);\n            }\n        }\n        return Result.fail(new WorkflowStateNoPendingStepError());\n    }\n\n    private updateRecord(record: Partial<Omit<IWorkflowStateRecord, \"id\">>): void {\n        Object.assign(this.record, record);\n    }\n\n    private updateStep(id: string, input: Partial<Omit<IWorkflowStateRecordStep, \"id\">>): void {\n        const step = this.record.steps.find(s => s.id === id);\n        if (!step) {\n            throw new Error(`Step with ID \"${id}\" not found.`);\n        }\n        Object.assign(step, {\n            savedBy: {\n                id: this.currentIdentity.id,\n                displayName: this.currentIdentity.displayName,\n                type: this.currentIdentity.type\n            },\n            ...input\n        });\n    }\n\n    private approveStep(id: string, comment?: string): void {\n        this.updateStep(id, {\n            state: WorkflowStateRecordState.approved,\n            comment\n        });\n    }\n\n    private rejectStep(id: string, comment: string): void {\n        this.updateStep(id, {\n            state: WorkflowStateRecordState.rejected,\n            comment\n        });\n    }\n\n    private getNextStep(currentStepId: string): IWorkflowStateRecordStep | undefined {\n        const index = this.record.steps.findIndex(s => s.id === currentStepId);\n        if (index === -1) {\n            return undefined;\n        }\n        return this.record.steps[index + 1];\n    }\n\n    private enrichStep(params: IEnrichStepWithPermissionParams): IEnrichedWorkflowStateRecordStep {\n        const { step, createdBy } = params;\n        const identity = this.currentIdentity;\n        /**\n         * User who created the workflow state cannot take part in reviewing it.\n         */\n        if (createdBy.id === identity.id) {\n            return {\n                ...step,\n                isOwner: false,\n                canTakeOver: false,\n                canReview: false\n            };\n        }\n        /**\n         * Current user is step owner - they started the review.\n         */\n        const isOwner = step.savedBy?.id === identity.id;\n        /**\n         * Can current user actually review this step?\n         */\n        const canReview = step.teams.some(team => {\n            return this.teams.some(t => {\n                return t.id === team.id;\n            });\n        });\n        /**\n         * Can current user take over the review from another reviewer?\n         * Taking over is only possible if current user did not start the review of the step - and review was actually started.\n         */\n        const canTakeOver =\n            canReview && !!step.savedBy?.id && step.state === WorkflowStateRecordState.inReview;\n\n        return {\n            ...step,\n            canTakeOver: !isOwner ? canTakeOver : false,\n            isOwner,\n            canReview\n        };\n    }\n\n    toRecord(): IWorkflowStateRecord {\n        return this.record;\n    }\n}\n\nexport namespace WorkflowState {\n    export type Error =\n        | WorkflowStateNotAuthorizedError\n        | WorkflowStateNoPendingStepError\n        | WorkflowStateStepCannotReviewError\n        | WorkflowStateStepCannotTakeOverError\n        | WorkflowStateStepNotStepOwnerError\n        | WorkflowStateInReviewError\n        | WorkflowStateNotInReview\n        | WorkflowStateRejectedError\n        | WorkflowStateNoCurrentStepError;\n}\n"],"names":["WorkflowState","record","teams","currentIdentity","step","WorkflowStateRecordState","steps","inReview","rejected","pending","approved","WorkflowStateNoCurrentStepError","currentStep","currentIndex","hasRejected","stepResult","Result","canReview","WorkflowStateStepCannotReviewError","identity","isRejected","WorkflowStateRejectedError","WorkflowStateNotAuthorizedError","canTakeOver","WorkflowStateStepCannotTakeOverError","comment","isStepOwner","WorkflowStateStepNotStepOwnerError","nextStep","WorkflowStateNotInReview","isInReview","WorkflowStateInReviewError","WorkflowStateNoPendingStepError","Object","id","input","s","Error","currentStepId","index","params","createdBy","isOwner","team","t"],"mappings":";;;;;;;;AAgCO,MAAMA;IACT,YACYC,MAA4B,EAC5BC,KAA0B,EAC1BC,eAAuC,CACjD;aAHUF,MAAM,GAANA;aACAC,KAAK,GAALA;aACAC,eAAe,GAAfA;IACT;IAEH,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE;IACzB;IAEA,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG;IAC1B;IAEA,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK;IAC5B;IAEA,IAAI,aAAa;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU;IACjC;IAEA,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ;IAC/B;IAEA,IAAI,mBAAmB;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB;IACvC;IAEA,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ;IAC/B;IAEA,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO;IAC9B;IAEA,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK;IAC5B;IAEA,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAACC,CAAAA,OAClB,IAAI,CAAC,UAAU,CAAC;gBAAE,WAAW,IAAI,CAAC,MAAM,CAAC,SAAS;gBAAEA;YAAK;IAExE;IAEA,IAAI,YAAY;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS;IAChC;IAEA,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO;IAC9B;IAEA,IAAI,YAAY;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS;IAChC;IAEA,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO;IAC9B;IAEA,IAAI,gBAAgB;QAChB,OAAO,IAAI,CAAC,MAAM,CAAC,aAAa;IACpC;IAEA,IAAI,OAAgB;QAIhB,IAAI,AAA6B,MAA7B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EACxB,OAAO;QAEX,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAACA,CAAAA,OACpBA,KAAK,KAAK,KAAKC,yBAAyB,QAAQ;IAE/D;IASA,IAAI,cAAgD;QAChD,MAAMC,QAAQ,IAAI,CAAC,KAAK;QACxB,MAAMC,WAAWD,MAAM,IAAI,CAACF,CAAAA,OAAQA,KAAK,KAAK,KAAKC,yBAAyB,QAAQ;QACpF,IAAIE,UACA,OAAOA;QAGX,MAAMC,WAAWF,MAAM,IAAI,CAACF,CAAAA,OAAQA,KAAK,KAAK,KAAKC,yBAAyB,QAAQ;QACpF,IAAIG,UACA,OAAOA;QAEX,MAAMC,UAAUH,MAAM,IAAI,CAACF,CAAAA,OAAQA,KAAK,KAAK,KAAKC,yBAAyB,OAAO;QAClF,IAAII,SACA,OAAOA;QAEX,MAAMC,WAAWJ,MACZ,UAAU,GACV,IAAI,CAACF,CAAAA,OAAQA,KAAK,KAAK,KAAKC,yBAAyB,QAAQ;QAClE,IAAIK,UACA,OAAOA;QAEX,MAAM,IAAIC,gCAAgCL;IAC9C;IAEA,IAAI,WAAoD;QACpD,MAAMA,QAAQ,IAAI,CAAC,KAAK;QACxB,MAAMM,cAAc,IAAI,CAAC,WAAW;QACpC,MAAMC,eAAeP,MAAM,SAAS,CAACF,CAAAA,OAAQA,KAAK,EAAE,KAAKQ,YAAY,EAAE;QACvE,IAAIC,AAAiB,OAAjBA,cACA,OAAO;QAEX,OAAOP,KAAK,CAACO,eAAe,EAAE,IAAI;IACtC;IAEA,IAAI,eAAwD;QACxD,MAAMP,QAAQ,IAAI,CAAC,KAAK;QACxB,MAAMM,cAAc,IAAI,CAAC,WAAW;QACpC,MAAMC,eAAeP,MAAM,SAAS,CAACF,CAAAA,OAAQA,KAAK,EAAE,KAAKQ,YAAY,EAAE;QACvE,IAAIC,gBAAgB,GAChB,OAAO;QAEX,OAAOP,KAAK,CAACO,eAAe,EAAE,IAAI;IACtC;IAKA,gBAAyD;QACrD,MAAMP,QAAQ,IAAI,CAAC,KAAK;QACxB,MAAMQ,cAAcR,MAAM,IAAI,CAACF,CAAAA,OACpBA,KAAK,KAAK,KAAKC,yBAAyB,QAAQ;QAE3D,IAAIS,aACA,OAAO;QAEX,MAAMV,OAAOE,MAAM,IAAI,CAACF,CAAAA,OACbA,KAAK,KAAK,KAAKC,yBAAyB,QAAQ;QAE3D,OAAOD,QAAQ;IACnB;IAEA,QAA2C;QACvC,MAAMW,aAAa,IAAI,CAAC,cAAc;QACtC,IAAIA,WAAW,MAAM,IACjB,OAAOC,OAAO,IAAI,CAACD,WAAW,KAAK;QAGvC,MAAMX,OAAOW,WAAW,KAAK;QAE7B,IAAI,CAACE,uBAAUb,OACX,OAAOY,OAAO,IAAI,CAAC,IAAIE,mCAAmCd;QAG9D,MAAMe,WAAW;YACb,IAAI,IAAI,CAAC,eAAe,CAAC,EAAE;YAC3B,aAAa,IAAI,CAAC,eAAe,CAAC,WAAW;YAC7C,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI;QACnC;QAEA,IAAI,CAAC,UAAU,CAACf,KAAK,EAAE,EAAE;YACrB,SAASe;YACT,OAAOd,yBAAyB,QAAQ;QAC5C;QACA,IAAI,CAAC,YAAY,CAAC;YACd,SAASc;YACT,OAAOd,yBAAyB,QAAQ;QAC5C;QAEA,OAAOW,OAAO,EAAE;IACpB;IAEA,WAA8C;QAC1C,IAAII,WAAW,IAAI,CAAC,MAAM,GACtB,OAAOJ,OAAO,IAAI,CAAC,IAAIK,2BAA2B,IAAI,CAAC,MAAM;QAEjE,MAAMjB,OAAO,IAAI,CAAC,aAAa;QAC/B,IAAI,CAACA,MACD,OAAOY,OAAO,IAAI,CACd,IAAIM,gCACA;QAIZ,IAAI,CAACC,2BAAYnB,OACb,OAAOY,OAAO,IAAI,CAAC,IAAIQ,qCAAqCpB;QAEhE,IAAI,CAACa,uBAAUb,OACX,OAAOY,OAAO,IAAI,CAAC,IAAIE,mCAAmCd;QAG9D,MAAMe,WAAW;YACb,IAAI,IAAI,CAAC,eAAe,CAAC,EAAE;YAC3B,aAAa,IAAI,CAAC,eAAe,CAAC,WAAW;YAC7C,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI;QACnC;QAEA,IAAI,CAAC,UAAU,CAACf,KAAK,EAAE,EAAE;YACrB,SAASe;QACb;QACA,IAAI,CAAC,YAAY,CAAC;YACd,SAASA;QACb;QAEA,OAAOH,OAAO,EAAE;IACpB;IAEA,QAAQS,OAAgB,EAAqC;QACzD,IAAIL,WAAW,IAAI,CAAC,MAAM,GACtB,OAAOJ,OAAO,IAAI,CAAC,IAAIK,2BAA2B,IAAI,CAAC,MAAM;QAEjE,MAAMjB,OAAO,IAAI,CAAC,aAAa;QAI/B,IAAI,CAACA,MACD,OAAOY,OAAO,IAAI,CACd,IAAIM,gCACA;QAIZ,IAAI,CAACL,uBAAUb,OACX,OAAOY,OAAO,IAAI,CAAC,IAAIE,mCAAmCd;QAE9D,IAAI,CAACsB,YAAYtB,OACb,OAAOY,OAAO,IAAI,CAAC,IAAIW,mCAAmCvB;QAG9D,IAAI,CAAC,WAAW,CAACA,KAAK,EAAE,EAAEqB;QAE1B,MAAMG,WAAW,IAAI,CAAC,WAAW,CAACxB,KAAK,EAAE;QAEzC,IAAI,CAAC,YAAY,CAAC;YACd,OAAOwB,WAAWvB,yBAAyB,OAAO,GAAGA,yBAAyB,QAAQ;QAC1F;QAEA,OAAOW,OAAO,EAAE;IACpB;IAEA,OAAOS,OAAe,EAAqC;QACvD,IAAIL,WAAW,IAAI,CAAC,MAAM,GACtB,OAAOJ,OAAO,IAAI,CAAC,IAAIK,2BAA2B,IAAI,CAAC,MAAM;QAEjE,MAAMjB,OAAO,IAAI,CAAC,aAAa;QAC/B,IAAI,CAACA,MACD,OAAOY,OAAO,IAAI,CACd,IAAIa,yBACA,yDACA,IAAI;QAKhB,IAAI,CAACZ,uBAAUb,OACX,OAAOY,OAAO,IAAI,CAAC,IAAIE,mCAAmCd;QAE9D,IAAI,CAACsB,YAAYtB,OACb,OAAOY,OAAO,IAAI,CAAC,IAAIW,mCAAmCvB;QAG9D,IAAI,CAAC,UAAU,CAACA,KAAK,EAAE,EAAEqB;QACzB,IAAI,CAAC,YAAY,CAAC;YACd,OAAOpB,yBAAyB,QAAQ;QAC5C;QAEA,OAAOW,OAAO,EAAE;IACpB;IAEQ,iBAGN;QACE,IAAII,WAAW,IAAI,CAAC,MAAM,GACtB,OAAOJ,OAAO,IAAI,CAAC,IAAIK,2BAA2B,IAAI,CAAC,MAAM;QAEjE,IAAIS,WAAW,IAAI,CAAC,MAAM,GACtB,OAAOd,OAAO,IAAI,CAAC,IAAIe,2BAA2B,IAAI,CAAC,MAAM;QAEjE,KAAK,MAAM3B,QAAQ,IAAI,CAAC,KAAK,CACzB,IAAIA,KAAK,KAAK,KAAKC,yBAAyB,OAAO,EAC/C,OAAOW,OAAO,EAAE,CAACZ;QAGzB,OAAOY,OAAO,IAAI,CAAC,IAAIgB;IAC3B;IAEQ,aAAa/B,MAAiD,EAAQ;QAC1EgC,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,EAAEhC;IAC/B;IAEQ,WAAWiC,EAAU,EAAEC,KAAoD,EAAQ;QACvF,MAAM/B,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAACgC,CAAAA,IAAKA,EAAE,EAAE,KAAKF;QAClD,IAAI,CAAC9B,MACD,MAAM,IAAIiC,MAAM,CAAC,cAAc,EAAEH,GAAG,YAAY,CAAC;QAErDD,OAAO,MAAM,CAAC7B,MAAM;YAChB,SAAS;gBACL,IAAI,IAAI,CAAC,eAAe,CAAC,EAAE;gBAC3B,aAAa,IAAI,CAAC,eAAe,CAAC,WAAW;gBAC7C,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI;YACnC;YACA,GAAG+B,KAAK;QACZ;IACJ;IAEQ,YAAYD,EAAU,EAAET,OAAgB,EAAQ;QACpD,IAAI,CAAC,UAAU,CAACS,IAAI;YAChB,OAAO7B,yBAAyB,QAAQ;YACxCoB;QACJ;IACJ;IAEQ,WAAWS,EAAU,EAAET,OAAe,EAAQ;QAClD,IAAI,CAAC,UAAU,CAACS,IAAI;YAChB,OAAO7B,yBAAyB,QAAQ;YACxCoB;QACJ;IACJ;IAEQ,YAAYa,aAAqB,EAAwC;QAC7E,MAAMC,QAAQ,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAACH,CAAAA,IAAKA,EAAE,EAAE,KAAKE;QACxD,IAAIC,AAAU,OAAVA,OACA;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAACA,QAAQ,EAAE;IACvC;IAEQ,WAAWC,MAAuC,EAAoC;QAC1F,MAAM,EAAEpC,IAAI,EAAEqC,SAAS,EAAE,GAAGD;QAC5B,MAAMrB,WAAW,IAAI,CAAC,eAAe;QAIrC,IAAIsB,UAAU,EAAE,KAAKtB,SAAS,EAAE,EAC5B,OAAO;YACH,GAAGf,IAAI;YACP,SAAS;YACT,aAAa;YACb,WAAW;QACf;QAKJ,MAAMsC,UAAUtC,KAAK,OAAO,EAAE,OAAOe,SAAS,EAAE;QAIhD,MAAMF,YAAYb,KAAK,KAAK,CAAC,IAAI,CAACuC,CAAAA,OACvB,IAAI,CAAC,KAAK,CAAC,IAAI,CAACC,CAAAA,IACZA,EAAE,EAAE,KAAKD,KAAK,EAAE;QAO/B,MAAMpB,cACFN,aAAa,CAAC,CAACb,KAAK,OAAO,EAAE,MAAMA,KAAK,KAAK,KAAKC,yBAAyB,QAAQ;QAEvF,OAAO;YACH,GAAGD,IAAI;YACP,aAAa,AAACsC,UAAwB,QAAdnB;YACxBmB;YACAzB;QACJ;IACJ;IAEA,WAAiC;QAC7B,OAAO,IAAI,CAAC,MAAM;IACtB;AACJ"}

package/domain/workflowState/WorkflowStateMapper.d.ts

@@ -0,0 +1,9 @@
+import type { IWorkflowStateMapper, IWorkflowStateTransformerFromCmsEntryInput, IWorkflowStateTransformerFromCmsEntryOutput, IWorkflowStateTransformerToCmsEntryInput, IWorkflowStateTransformerToCmsEntryOutput } from "./abstractions.js";
+declare class WorkflowStateMapperImpl implements IWorkflowStateMapper {
+    fromCmsEntry(input: IWorkflowStateTransformerFromCmsEntryInput): IWorkflowStateTransformerFromCmsEntryOutput;
+    toCmsEntry(input: IWorkflowStateTransformerToCmsEntryInput): IWorkflowStateTransformerToCmsEntryOutput;
+}
+export declare const WorkflowStateMapper: typeof WorkflowStateMapperImpl & {
+    __abstraction: import("@webiny/di").Abstraction<IWorkflowStateMapper>;
+};
+export {};

package/domain/workflowState/WorkflowStateMapper.js

@@ -0,0 +1,43 @@
+import { WorkflowStateMapper } from "./abstractions.js";
+class WorkflowStateMapperImpl {
+    fromCmsEntry(input) {
+        return {
+            id: input.id,
+            workflowId: input.values.workflowId,
+            title: input.values.title,
+            targetId: input.values.targetId,
+            targetRevisionId: input.values.targetRevisionId,
+            steps: input.values.steps,
+            isActive: input.values.isActive,
+            app: input.values.app,
+            state: input.values.state,
+            comment: input.values.comment,
+            savedBy: input.savedBy,
+            createdBy: input.createdBy,
+            savedOn: new Date(input.savedOn),
+            createdOn: new Date(input.createdOn),
+            targetContext: input.values.targetContext || {}
+        };
+    }
+    toCmsEntry(input) {
+        return {
+            isActive: input.isActive,
+            title: input.title,
+            workflowId: input.workflowId,
+            targetId: input.targetId,
+            targetRevisionId: input.targetRevisionId,
+            steps: input.steps,
+            app: input.app,
+            state: input.state,
+            comment: input.comment,
+            targetContext: input.targetContext || {}
+        };
+    }
+}
+const WorkflowStateMapper_WorkflowStateMapper = WorkflowStateMapper.createImplementation({
+    implementation: WorkflowStateMapperImpl,
+    dependencies: []
+});
+export { WorkflowStateMapper_WorkflowStateMapper as WorkflowStateMapper };
+
+//# sourceMappingURL=WorkflowStateMapper.js.map

package/domain/workflowState/WorkflowStateMapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"domain/workflowState/WorkflowStateMapper.js","sources":["../../../src/domain/workflowState/WorkflowStateMapper.ts"],"sourcesContent":["import type {\n    IWorkflowStateMapper,\n    IWorkflowStateTransformerFromCmsEntryInput,\n    IWorkflowStateTransformerFromCmsEntryOutput,\n    IWorkflowStateTransformerToCmsEntryInput,\n    IWorkflowStateTransformerToCmsEntryOutput\n} from \"./abstractions.js\";\nimport { WorkflowStateMapper as WorkflowStateMapperAbstraction } from \"./abstractions.js\";\n\nclass WorkflowStateMapperImpl implements IWorkflowStateMapper {\n    public fromCmsEntry(\n        input: IWorkflowStateTransformerFromCmsEntryInput\n    ): IWorkflowStateTransformerFromCmsEntryOutput {\n        return {\n            id: input.id,\n            workflowId: input.values.workflowId,\n            title: input.values.title,\n            targetId: input.values.targetId,\n            targetRevisionId: input.values.targetRevisionId,\n            steps: input.values.steps,\n            isActive: input.values.isActive,\n            app: input.values.app,\n            state: input.values.state,\n            comment: input.values.comment,\n            savedBy: input.savedBy,\n            createdBy: input.createdBy,\n            savedOn: new Date(input.savedOn),\n            createdOn: new Date(input.createdOn),\n            targetContext: input.values.targetContext || {}\n        };\n    }\n\n    public toCmsEntry(\n        input: IWorkflowStateTransformerToCmsEntryInput\n    ): IWorkflowStateTransformerToCmsEntryOutput {\n        return {\n            isActive: input.isActive,\n            title: input.title,\n            workflowId: input.workflowId,\n            targetId: input.targetId,\n            targetRevisionId: input.targetRevisionId,\n            steps: input.steps,\n            app: input.app,\n            state: input.state,\n            comment: input.comment,\n            targetContext: input.targetContext || {}\n        };\n    }\n}\n\nexport const WorkflowStateMapper = WorkflowStateMapperAbstraction.createImplementation({\n    implementation: WorkflowStateMapperImpl,\n    dependencies: []\n});\n"],"names":["WorkflowStateMapperImpl","input","Date","WorkflowStateMapper","WorkflowStateMapperAbstraction"],"mappings":";AASA,MAAMA;IACK,aACHC,KAAiD,EACN;QAC3C,OAAO;YACH,IAAIA,MAAM,EAAE;YACZ,YAAYA,MAAM,MAAM,CAAC,UAAU;YACnC,OAAOA,MAAM,MAAM,CAAC,KAAK;YACzB,UAAUA,MAAM,MAAM,CAAC,QAAQ;YAC/B,kBAAkBA,MAAM,MAAM,CAAC,gBAAgB;YAC/C,OAAOA,MAAM,MAAM,CAAC,KAAK;YACzB,UAAUA,MAAM,MAAM,CAAC,QAAQ;YAC/B,KAAKA,MAAM,MAAM,CAAC,GAAG;YACrB,OAAOA,MAAM,MAAM,CAAC,KAAK;YACzB,SAASA,MAAM,MAAM,CAAC,OAAO;YAC7B,SAASA,MAAM,OAAO;YACtB,WAAWA,MAAM,SAAS;YAC1B,SAAS,IAAIC,KAAKD,MAAM,OAAO;YAC/B,WAAW,IAAIC,KAAKD,MAAM,SAAS;YACnC,eAAeA,MAAM,MAAM,CAAC,aAAa,IAAI,CAAC;QAClD;IACJ;IAEO,WACHA,KAA+C,EACN;QACzC,OAAO;YACH,UAAUA,MAAM,QAAQ;YACxB,OAAOA,MAAM,KAAK;YAClB,YAAYA,MAAM,UAAU;YAC5B,UAAUA,MAAM,QAAQ;YACxB,kBAAkBA,MAAM,gBAAgB;YACxC,OAAOA,MAAM,KAAK;YAClB,KAAKA,MAAM,GAAG;YACd,OAAOA,MAAM,KAAK;YAClB,SAASA,MAAM,OAAO;YACtB,eAAeA,MAAM,aAAa,IAAI,CAAC;QAC3C;IACJ;AACJ;AAEO,MAAME,0CAAsBC,oBAAAA,oBAAmD,CAAC;IACnF,gBAAgBJ;IAChB,cAAc,EAAE;AACpB"}

package/domain/workflowState/abstractions.d.ts

@@ -0,0 +1,78 @@
+import type { CmsEntry, CmsModel } from "@webiny/api-headless-cms/types";
+import type { IWorkflowStep } from "../workflow/abstractions.js";
+import type { GenericRecord } from "@webiny/api/types.js";
+export declare enum WorkflowStateRecordState {
+    pending = "pending",
+    inReview = "inReview",
+    approved = "approved",
+    rejected = "rejected"
+}
+export interface IWorkflowStateIdentity {
+    id: string;
+    displayName: string;
+    type: string;
+}
+export interface IWorkflowStateRecordStep extends IWorkflowStep {
+    state: WorkflowStateRecordState;
+    comment: string | null;
+    savedBy: IWorkflowStateIdentity | null;
+}
+export interface IWorkflowStateRecord<Steps extends IWorkflowStateRecordStep = IWorkflowStateRecordStep> {
+    id: string;
+    app: string;
+    title: string;
+    workflowId: string;
+    targetId: string;
+    targetRevisionId: string;
+    isActive: boolean;
+    comment: string | undefined;
+    state: WorkflowStateRecordState;
+    steps: Steps[];
+    createdOn: Date;
+    savedOn: Date;
+    createdBy: IWorkflowStateIdentity;
+    savedBy: IWorkflowStateIdentity;
+    targetContext: GenericRecord;
+}
+export interface IEnrichedWorkflowStateRecordStep extends IWorkflowStateRecordStep {
+    isOwner: boolean;
+    canTakeOver: boolean;
+    canReview: boolean;
+}
+export interface IWorkflowState {
+    readonly id: string;
+    readonly app: string;
+    readonly title: string;
+    readonly workflowId: string;
+    readonly targetId: string;
+    readonly targetRevisionId: string;
+    readonly isActive: boolean;
+    readonly comment: string | undefined;
+    readonly state: WorkflowStateRecordState;
+    readonly steps: IEnrichedWorkflowStateRecordStep[];
+    readonly createdOn: Date;
+    readonly savedOn: Date;
+    readonly createdBy: IWorkflowStateIdentity;
+    readonly savedBy: IWorkflowStateIdentity;
+    readonly targetContext: GenericRecord;
+    readonly done: boolean;
+    readonly currentStep: IEnrichedWorkflowStateRecordStep;
+    readonly nextStep: IEnrichedWorkflowStateRecordStep | null;
+    readonly previousStep: IEnrichedWorkflowStateRecordStep | null;
+}
+export declare const WorkflowStateModel: import("@webiny/di").Abstraction<CmsModel>;
+export declare namespace WorkflowStateModel {
+    type Interface = CmsModel;
+}
+export type IWorkflowStateTransformerFromCmsEntryInput = CmsEntry<Omit<IWorkflowStateRecord, "id" | "savedOn" | "createdOn" | "savedBy" | "createdBy">>;
+export type IWorkflowStateTransformerFromCmsEntryOutput = IWorkflowStateRecord;
+export type IWorkflowStateTransformerToCmsEntryInput = Omit<IWorkflowStateRecord, "savedOn" | "createdOn" | "savedBy">;
+export type IWorkflowStateTransformerToCmsEntryOutput = Omit<IWorkflowStateRecord, "id" | "savedOn" | "createdOn" | "savedBy" | "createdBy">;
+export interface IWorkflowStateMapper {
+    fromCmsEntry(input: IWorkflowStateTransformerFromCmsEntryInput): IWorkflowStateTransformerFromCmsEntryOutput;
+    toCmsEntry(input: IWorkflowStateTransformerToCmsEntryInput): IWorkflowStateTransformerToCmsEntryOutput;
+}
+export declare const WorkflowStateMapper: import("@webiny/di").Abstraction<IWorkflowStateMapper>;
+export declare namespace WorkflowStateMapper {
+    type Interface = IWorkflowStateMapper;
+}

package/domain/workflowState/abstractions.js

@@ -0,0 +1,13 @@
+import { createAbstraction } from "@webiny/feature/api";
+var abstractions_WorkflowStateRecordState = /*#__PURE__*/ function(WorkflowStateRecordState) {
+    WorkflowStateRecordState["pending"] = "pending";
+    WorkflowStateRecordState["inReview"] = "inReview";
+    WorkflowStateRecordState["approved"] = "approved";
+    WorkflowStateRecordState["rejected"] = "rejected";
+    return WorkflowStateRecordState;
+}({});
+const WorkflowStateModel = createAbstraction("WorkflowStateModel");
+const WorkflowStateMapper = createAbstraction("WorkflowStateMapper");
+export { WorkflowStateMapper, WorkflowStateModel, abstractions_WorkflowStateRecordState as WorkflowStateRecordState };
+
+//# sourceMappingURL=abstractions.js.map

package/domain/workflowState/abstractions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"domain/workflowState/abstractions.js","sources":["../../../src/domain/workflowState/abstractions.ts"],"sourcesContent":["import { createAbstraction } from \"@webiny/feature/api\";\nimport type { CmsEntry, CmsModel } from \"@webiny/api-headless-cms/types\";\nimport type { IWorkflowStep } from \"../workflow/abstractions.js\";\nimport type { GenericRecord } from \"@webiny/api/types.js\";\n\nexport enum WorkflowStateRecordState {\n    pending = \"pending\",\n    inReview = \"inReview\",\n    approved = \"approved\",\n    rejected = \"rejected\"\n}\n\nexport interface IWorkflowStateIdentity {\n    id: string;\n    displayName: string;\n    type: string;\n}\n\nexport interface IWorkflowStateRecordStep extends IWorkflowStep {\n    state: WorkflowStateRecordState;\n    comment: string | null;\n    savedBy: IWorkflowStateIdentity | null;\n}\n\nexport interface IWorkflowStateRecord<\n    Steps extends IWorkflowStateRecordStep = IWorkflowStateRecordStep\n> {\n    id: string;\n    app: string;\n    title: string;\n    workflowId: string;\n    targetId: string;\n    targetRevisionId: string;\n    isActive: boolean;\n    comment: string | undefined;\n    state: WorkflowStateRecordState;\n    steps: Steps[];\n    createdOn: Date;\n    savedOn: Date;\n    createdBy: IWorkflowStateIdentity;\n    savedBy: IWorkflowStateIdentity;\n    targetContext: GenericRecord;\n}\n\nexport interface IEnrichedWorkflowStateRecordStep extends IWorkflowStateRecordStep {\n    isOwner: boolean;\n    canTakeOver: boolean;\n    canReview: boolean;\n}\n\nexport interface IWorkflowState {\n    readonly id: string;\n    readonly app: string;\n    readonly title: string;\n    readonly workflowId: string;\n    readonly targetId: string;\n    readonly targetRevisionId: string;\n    readonly isActive: boolean;\n    readonly comment: string | undefined;\n    readonly state: WorkflowStateRecordState;\n    readonly steps: IEnrichedWorkflowStateRecordStep[];\n    readonly createdOn: Date;\n    readonly savedOn: Date;\n    readonly createdBy: IWorkflowStateIdentity;\n    readonly savedBy: IWorkflowStateIdentity;\n    readonly targetContext: GenericRecord;\n    readonly done: boolean;\n    readonly currentStep: IEnrichedWorkflowStateRecordStep;\n    readonly nextStep: IEnrichedWorkflowStateRecordStep | null;\n    readonly previousStep: IEnrichedWorkflowStateRecordStep | null;\n}\n\n// Abstractions\nexport const WorkflowStateModel = createAbstraction<CmsModel>(\"WorkflowStateModel\");\n\nexport namespace WorkflowStateModel {\n    export type Interface = CmsModel;\n}\n\nexport type IWorkflowStateTransformerFromCmsEntryInput = CmsEntry<\n    Omit<IWorkflowStateRecord, \"id\" | \"savedOn\" | \"createdOn\" | \"savedBy\" | \"createdBy\">\n>;\n\nexport type IWorkflowStateTransformerFromCmsEntryOutput = IWorkflowStateRecord;\n\nexport type IWorkflowStateTransformerToCmsEntryInput = Omit<\n    IWorkflowStateRecord,\n    \"savedOn\" | \"createdOn\" | \"savedBy\"\n>;\n\nexport type IWorkflowStateTransformerToCmsEntryOutput = Omit<\n    IWorkflowStateRecord,\n    \"id\" | \"savedOn\" | \"createdOn\" | \"savedBy\" | \"createdBy\"\n>;\n\nexport interface IWorkflowStateMapper {\n    fromCmsEntry(\n        input: IWorkflowStateTransformerFromCmsEntryInput\n    ): IWorkflowStateTransformerFromCmsEntryOutput;\n    toCmsEntry(\n        input: IWorkflowStateTransformerToCmsEntryInput\n    ): IWorkflowStateTransformerToCmsEntryOutput;\n}\n\nexport const WorkflowStateMapper = createAbstraction<IWorkflowStateMapper>(\"WorkflowStateMapper\");\n\nexport namespace WorkflowStateMapper {\n    export type Interface = IWorkflowStateMapper;\n}\n"],"names":["WorkflowStateRecordState","WorkflowStateModel","createAbstraction","WorkflowStateMapper"],"mappings":";AAKO,IAAKA,wCAAwBA,WAAAA,GAAAA,SAAxBA,wBAAwB;;;;;WAAxBA;;AAoEL,MAAMC,qBAAqBC,kBAA4B;AA+BvD,MAAMC,sBAAsBD,kBAAwC"}

package/domain/workflowState/errors.d.ts

@@ -0,0 +1,86 @@
+import { BaseError } from "@webiny/feature/api";
+import type { IWorkflowStateRecord, IWorkflowStateRecordStep } from "./abstractions.js";
+export declare class WorkflowStateNotFoundError extends BaseError<{
+    id?: string;
+    app?: string;
+    targetRevisionId?: string;
+}> {
+    readonly code: "Workflows/State/NotFound";
+    constructor(data: {
+        id?: string;
+        app?: string;
+        targetRevisionId?: string;
+    });
+}
+export declare class WorkflowStateNotAuthorizedError extends BaseError {
+    readonly code: "Workflows/State/NotAuthorized";
+    constructor(message: string);
+}
+export declare class WorkflowStatePersistenceError extends BaseError {
+    readonly code: "Workflows/State/Persistence";
+    constructor(error: Error);
+}
+export declare class WorkflowStateValidationError extends BaseError {
+    readonly code: "Workflows/State/Validation";
+    constructor(message: string);
+}
+export declare class ActiveStateExistsError extends BaseError<{
+    app: string;
+    targetRevisionId: string;
+}> {
+    readonly code: "Workflows/State/ActiveExists";
+    constructor(data: {
+        app: string;
+        targetRevisionId: string;
+    });
+}
+export declare class MultipleWorkflowsFoundError extends BaseError {
+    readonly code: "Workflows/State/MultipleFound";
+    constructor(data: any);
+}
+export declare class WorkflowStateNoPendingStepError extends BaseError {
+    readonly code: "Workflows/State/NoPendingStep";
+    constructor();
+}
+export declare class WorkflowStateStepCannotReviewError extends BaseError<{
+    step: IWorkflowStateRecordStep;
+}> {
+    readonly code: "Workflows/State/Step/CannotReview";
+    constructor(step: IWorkflowStateRecordStep);
+}
+export declare class WorkflowStateStepCannotTakeOverError extends BaseError<{
+    step: IWorkflowStateRecordStep;
+}> {
+    readonly code: "Workflows/State/Step/CannotTakeOver";
+    constructor(step: IWorkflowStateRecordStep);
+}
+export declare class WorkflowStateStepNotStepOwnerError extends BaseError<{
+    step: IWorkflowStateRecordStep;
+}> {
+    readonly code: "Workflows/State/Step/NotStepOwner";
+    constructor(step: IWorkflowStateRecordStep);
+}
+export declare class WorkflowStateInReviewError extends BaseError<{
+    state: IWorkflowStateRecord;
+}> {
+    readonly code: "Workflows/State/InReview";
+    constructor(state: IWorkflowStateRecord);
+}
+export declare class WorkflowStateRejectedError extends BaseError<{
+    state: IWorkflowStateRecord;
+}> {
+    readonly code: "Workflows/State/Rejected";
+    constructor(state: IWorkflowStateRecord);
+}
+export declare class WorkflowStateNotInReview extends BaseError<{
+    state: IWorkflowStateRecord;
+}> {
+    readonly code: "Workflows/State/NotInReview";
+    constructor(message: string, state: IWorkflowStateRecord);
+}
+export declare class WorkflowStateNoCurrentStepError extends BaseError<{
+    steps: IWorkflowStateRecordStep[];
+}> {
+    readonly code: "Workflows/State/NoCurrentStep";
+    constructor(steps: IWorkflowStateRecordStep[]);
+}