@webiny/api-workflows 0.0.0-unstable.61c048f412

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Webiny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,11 @@
+# @webiny/api-workflows
+
+> [!NOTE]
+> This package is part of the [Webiny](https://www.webiny.com) monorepo.
+> It’s **included in every Webiny project by default** and is not meant to be used as a standalone package.
+
+📘 **Documentation:** [https://www.webiny.com/docs](https://www.webiny.com/docs)
+
+---
+
+_This README file is automatically generated during the publish process._

package/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const WORKFLOW_MODEL_ID = "wbyWorkflow";
+export declare const WORKFLOW_STATE_MODEL_ID = "wbyWorkflowState";
+export declare const WORKFLOWS_PERMISSION = "workflows";

package/constants.js

@@ -0,0 +1,5 @@
+export const WORKFLOW_MODEL_ID = "wbyWorkflow";
+export const WORKFLOW_STATE_MODEL_ID = "wbyWorkflowState";
+export const WORKFLOWS_PERMISSION = "workflows";
+
+//# sourceMappingURL=constants.js.map

package/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["WORKFLOW_MODEL_ID","WORKFLOW_STATE_MODEL_ID","WORKFLOWS_PERMISSION"],"sources":["constants.ts"],"sourcesContent":["export const WORKFLOW_MODEL_ID = \"wbyWorkflow\";\nexport const WORKFLOW_STATE_MODEL_ID = \"wbyWorkflowState\";\nexport const WORKFLOWS_PERMISSION = \"workflows\";\n"],"mappings":"AAAA,OAAO,MAAMA,iBAAiB,GAAG,aAAa;AAC9C,OAAO,MAAMC,uBAAuB,GAAG,kBAAkB;AACzD,OAAO,MAAMC,oBAAoB,GAAG,WAAW","ignoreList":[]}

package/domain/notifications/abstractions.d.ts

@@ -0,0 +1,64 @@
+export interface INotificationTypeMessage {
+    title: string;
+    body: string;
+    url: string;
+}
+export declare const NotificationTypeMessageOnRequestReview: import("@webiny/di").Abstraction<INotificationTypeMessage>;
+export declare namespace NotificationTypeMessageOnRequestReview {
+    type Interface = INotificationTypeMessage;
+}
+export declare const NotificationTypeMessageOnRequestReviewCancel: import("@webiny/di").Abstraction<INotificationTypeMessage>;
+export declare namespace NotificationTypeMessageOnRequestReviewCancel {
+    type Interface = INotificationTypeMessage;
+}
+export declare const NotificationTypeMessageOnReviewStepStart: import("@webiny/di").Abstraction<INotificationTypeMessage>;
+export declare namespace NotificationTypeMessageOnReviewStepStart {
+    type Interface = INotificationTypeMessage;
+}
+export declare const NotificationTypeMessageOnReviewStepApprove: import("@webiny/di").Abstraction<INotificationTypeMessage>;
+export declare namespace NotificationTypeMessageOnReviewStepApprove {
+    type Interface = INotificationTypeMessage;
+}
+export declare const NotificationTypeMessageOnReviewReject: import("@webiny/di").Abstraction<INotificationTypeMessage>;
+export declare namespace NotificationTypeMessageOnReviewReject {
+    type Interface = INotificationTypeMessage;
+}
+export declare const NotificationTypeMessageOnReviewApprove: import("@webiny/di").Abstraction<INotificationTypeMessage>;
+export declare namespace NotificationTypeMessageOnReviewApprove {
+    type Interface = INotificationTypeMessage;
+}
+export type INotificationTypes = NotificationTypeMessageOnRequestReview.Interface | NotificationTypeMessageOnRequestReviewCancel.Interface | NotificationTypeMessageOnReviewStepStart.Interface | NotificationTypeMessageOnReviewStepApprove.Interface | NotificationTypeMessageOnReviewReject.Interface | NotificationTypeMessageOnReviewApprove.Interface;
+export interface INotificationTypeMessages {
+    /**
+     * User requests a review for a content.
+     */
+    onRequestReview: NotificationTypeMessageOnRequestReview.Interface;
+    /**
+     * User cancels a review for a content.
+     */
+    onRequestReviewCancel: NotificationTypeMessageOnRequestReviewCancel.Interface;
+    /**
+     * Reviewer starts a review step.
+     */
+    onReviewStepStart: NotificationTypeMessageOnReviewStepStart.Interface;
+    /**
+     * Reviewer approves a review step - there are more steps after this one.
+     */
+    onReviewStepApprove: NotificationTypeMessageOnReviewStepApprove.Interface;
+    /**
+     * Reviewer rejects a review - no step specific reject because as soon as step is rejected, whole review is rejected.
+     */
+    onReviewReject: NotificationTypeMessageOnReviewReject.Interface;
+    /**
+     * Reviewer approves a final review step.
+     */
+    onReviewApprove: NotificationTypeMessageOnReviewApprove.Interface;
+}
+export interface INotificationType {
+    id: string;
+    title: string;
+}
+export declare const NotificationType: import("@webiny/di").Abstraction<INotificationType>;
+export declare namespace NotificationType {
+    type Interface = INotificationType;
+}

package/domain/notifications/abstractions.js

@@ -0,0 +1,10 @@
+import { createAbstraction } from "@webiny/feature/api";
+export const NotificationTypeMessageOnRequestReview = createAbstraction("WorkflowNotificationTypeMessageOnRequestReview");
+export const NotificationTypeMessageOnRequestReviewCancel = createAbstraction("WorkflowNotificationTypeMessageOnRequestReviewCancel");
+export const NotificationTypeMessageOnReviewStepStart = createAbstraction("WorkflowNotificationTypeMessageOnReviewStepStart");
+export const NotificationTypeMessageOnReviewStepApprove = createAbstraction("WorkflowNotificationTypeMessageOnReviewStepApprove");
+export const NotificationTypeMessageOnReviewReject = createAbstraction("WorkflowNotificationTypeMessageOnReviewReject");
+export const NotificationTypeMessageOnReviewApprove = createAbstraction("WorkflowNotificationTypeMessageOnReviewApprove");
+export const NotificationType = createAbstraction("WorkflowNotificationType");
+
+//# sourceMappingURL=abstractions.js.map

package/domain/notifications/abstractions.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["createAbstraction","NotificationTypeMessageOnRequestReview","NotificationTypeMessageOnRequestReviewCancel","NotificationTypeMessageOnReviewStepStart","NotificationTypeMessageOnReviewStepApprove","NotificationTypeMessageOnReviewReject","NotificationTypeMessageOnReviewApprove","NotificationType"],"sources":["abstractions.ts"],"sourcesContent":["import { createAbstraction } from \"@webiny/feature/api\";\n\nexport interface INotificationTypeMessage {\n    title: string;\n    body: string;\n    url: string;\n}\n\nexport const NotificationTypeMessageOnRequestReview = createAbstraction<INotificationTypeMessage>(\n    \"WorkflowNotificationTypeMessageOnRequestReview\"\n);\n\nexport namespace NotificationTypeMessageOnRequestReview {\n    export type Interface = INotificationTypeMessage;\n}\n\nexport const NotificationTypeMessageOnRequestReviewCancel =\n    createAbstraction<INotificationTypeMessage>(\n        \"WorkflowNotificationTypeMessageOnRequestReviewCancel\"\n    );\n\nexport namespace NotificationTypeMessageOnRequestReviewCancel {\n    export type Interface = INotificationTypeMessage;\n}\n\nexport const NotificationTypeMessageOnReviewStepStart = createAbstraction<INotificationTypeMessage>(\n    \"WorkflowNotificationTypeMessageOnReviewStepStart\"\n);\n\nexport namespace NotificationTypeMessageOnReviewStepStart {\n    export type Interface = INotificationTypeMessage;\n}\n\nexport const NotificationTypeMessageOnReviewStepApprove =\n    createAbstraction<INotificationTypeMessage>(\n        \"WorkflowNotificationTypeMessageOnReviewStepApprove\"\n    );\n\nexport namespace NotificationTypeMessageOnReviewStepApprove {\n    export type Interface = INotificationTypeMessage;\n}\n\nexport const NotificationTypeMessageOnReviewReject = createAbstraction<INotificationTypeMessage>(\n    \"WorkflowNotificationTypeMessageOnReviewReject\"\n);\n\nexport namespace NotificationTypeMessageOnReviewReject {\n    export type Interface = INotificationTypeMessage;\n}\n\nexport const NotificationTypeMessageOnReviewApprove = createAbstraction<INotificationTypeMessage>(\n    \"WorkflowNotificationTypeMessageOnReviewApprove\"\n);\n\nexport namespace NotificationTypeMessageOnReviewApprove {\n    export type Interface = INotificationTypeMessage;\n}\n\nexport type INotificationTypes =\n    | NotificationTypeMessageOnRequestReview.Interface\n    | NotificationTypeMessageOnRequestReviewCancel.Interface\n    | NotificationTypeMessageOnReviewStepStart.Interface\n    | NotificationTypeMessageOnReviewStepApprove.Interface\n    | NotificationTypeMessageOnReviewReject.Interface\n    | NotificationTypeMessageOnReviewApprove.Interface;\n\nexport interface INotificationTypeMessages {\n    /**\n     * User requests a review for a content.\n     */\n    onRequestReview: NotificationTypeMessageOnRequestReview.Interface;\n    /**\n     * User cancels a review for a content.\n     */\n    onRequestReviewCancel: NotificationTypeMessageOnRequestReviewCancel.Interface;\n    /**\n     * Reviewer starts a review step.\n     */\n    onReviewStepStart: NotificationTypeMessageOnReviewStepStart.Interface;\n    /**\n     * Reviewer approves a review step - there are more steps after this one.\n     */\n    onReviewStepApprove: NotificationTypeMessageOnReviewStepApprove.Interface;\n    /**\n     * Reviewer rejects a review - no step specific reject because as soon as step is rejected, whole review is rejected.\n     */\n    onReviewReject: NotificationTypeMessageOnReviewReject.Interface;\n    /**\n     * Reviewer approves a final review step.\n     */\n    onReviewApprove: NotificationTypeMessageOnReviewApprove.Interface;\n}\n\nexport interface INotificationType {\n    id: string;\n    title: string;\n}\n\nexport const NotificationType = createAbstraction<INotificationType>(\"WorkflowNotificationType\");\n\nexport namespace NotificationType {\n    export type Interface = INotificationType;\n}\n"],"mappings":"AAAA,SAASA,iBAAiB,QAAQ,qBAAqB;AAQvD,OAAO,MAAMC,sCAAsC,GAAGD,iBAAiB,CACnE,gDACJ,CAAC;AAMD,OAAO,MAAME,4CAA4C,GACrDF,iBAAiB,CACb,sDACJ,CAAC;AAML,OAAO,MAAMG,wCAAwC,GAAGH,iBAAiB,CACrE,kDACJ,CAAC;AAMD,OAAO,MAAMI,0CAA0C,GACnDJ,iBAAiB,CACb,oDACJ,CAAC;AAML,OAAO,MAAMK,qCAAqC,GAAGL,iBAAiB,CAClE,+CACJ,CAAC;AAMD,OAAO,MAAMM,sCAAsC,GAAGN,iBAAiB,CACnE,gDACJ,CAAC;AA8CD,OAAO,MAAMO,gBAAgB,GAAGP,iBAAiB,CAAoB,0BAA0B,CAAC","ignoreList":[]}

package/domain/notifications/errors.d.ts

@@ -0,0 +1,5 @@
+import { BaseError } from "@webiny/feature/api";
+export declare class NotificationAuthorizedError extends BaseError {
+    readonly code: "Workflows/Notification/NotAuthorized";
+    constructor(message?: string);
+}

package/domain/notifications/errors.js

@@ -0,0 +1,11 @@
+import { BaseError } from "@webiny/feature/api";
+export class NotificationAuthorizedError extends BaseError {
+  code = "Workflows/Notification/NotAuthorized";
+  constructor(message) {
+    super({
+      message: message || "Not authorized to access notifications."
+    });
+  }
+}
+
+//# sourceMappingURL=errors.js.map

package/domain/notifications/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["BaseError","NotificationAuthorizedError","code","constructor","message"],"sources":["errors.ts"],"sourcesContent":["import { BaseError } from \"@webiny/feature/api\";\n\nexport class NotificationAuthorizedError extends BaseError {\n    override readonly code = \"Workflows/Notification/NotAuthorized\" as const;\n\n    constructor(message?: string) {\n        super({\n            message: message || \"Not authorized to access notifications.\"\n        });\n    }\n}\n"],"mappings":"AAAA,SAASA,SAAS,QAAQ,qBAAqB;AAE/C,OAAO,MAAMC,2BAA2B,SAASD,SAAS,CAAC;EACrCE,IAAI,GAAG,sCAAsC;EAE/DC,WAAWA,CAACC,OAAgB,EAAE;IAC1B,KAAK,CAAC;MACFA,OAAO,EAAEA,OAAO,IAAI;IACxB,CAAC,CAAC;EACN;AACJ","ignoreList":[]}

package/domain/workflow/WorkflowMapper.d.ts

@@ -0,0 +1,12 @@
+import { type IWorkflowValues, WorkflowMapper as MapperAbstraction } from "./abstractions.js";
+import type { IWorkflow } from "./abstractions.js";
+import type { CmsEntry } from "@webiny/api-headless-cms/types/index.js";
+import type { IWorkflowInput } from "../../features/shared/abstractions.js";
+declare class WorkflowMapperImpl implements MapperAbstraction.Interface {
+    fromCmsEntry(entry: CmsEntry<IWorkflowValues>): IWorkflow;
+    toCmsEntry(workflow: IWorkflowInput): IWorkflow;
+}
+export declare const WorkflowMapper: typeof WorkflowMapperImpl & {
+    __abstraction: import("@webiny/di").Abstraction<import("./abstractions.js").IWorkflowMapper>;
+};
+export {};

package/domain/workflow/WorkflowMapper.js

@@ -0,0 +1,29 @@
+import { WorkflowMapper as MapperAbstraction } from "./abstractions.js";
+import { parseIdentifier } from "@webiny/utils/parseIdentifier.js";
+class WorkflowMapperImpl {
+  fromCmsEntry(entry) {
+    const {
+      id
+    } = parseIdentifier(entry.id);
+    return {
+      id,
+      app: entry.values.app,
+      name: entry.values.name,
+      steps: entry.values.steps
+    };
+  }
+  toCmsEntry(workflow) {
+    return {
+      id: workflow.id,
+      app: workflow.app,
+      name: workflow.name,
+      steps: workflow.steps
+    };
+  }
+}
+export const WorkflowMapper = MapperAbstraction.createImplementation({
+  implementation: WorkflowMapperImpl,
+  dependencies: []
+});
+
+//# sourceMappingURL=WorkflowMapper.js.map

package/domain/workflow/WorkflowMapper.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["WorkflowMapper","MapperAbstraction","parseIdentifier","WorkflowMapperImpl","fromCmsEntry","entry","id","app","values","name","steps","toCmsEntry","workflow","createImplementation","implementation","dependencies"],"sources":["WorkflowMapper.ts"],"sourcesContent":["import { type IWorkflowValues, WorkflowMapper as MapperAbstraction } from \"./abstractions.js\";\nimport type { IWorkflow } from \"./abstractions.js\";\nimport { parseIdentifier } from \"@webiny/utils/parseIdentifier.js\";\nimport type { CmsEntry } from \"@webiny/api-headless-cms/types/index.js\";\nimport type { IWorkflowInput } from \"~/features/shared/abstractions.js\";\n\nclass WorkflowMapperImpl implements MapperAbstraction.Interface {\n    fromCmsEntry(entry: CmsEntry<IWorkflowValues>): IWorkflow {\n        const { id } = parseIdentifier(entry.id);\n        return {\n            id,\n            app: entry.values.app,\n            name: entry.values.name,\n            steps: entry.values.steps\n        };\n    }\n\n    toCmsEntry(workflow: IWorkflowInput): IWorkflow {\n        return {\n            id: workflow.id,\n            app: workflow.app,\n            name: workflow.name,\n            steps: workflow.steps\n        };\n    }\n}\n\nexport const WorkflowMapper = MapperAbstraction.createImplementation({\n    implementation: WorkflowMapperImpl,\n    dependencies: []\n});\n"],"mappings":"AAAA,SAA+BA,cAAc,IAAIC,iBAAiB;AAElE,SAASC,eAAe,QAAQ,kCAAkC;AAIlE,MAAMC,kBAAkB,CAAwC;EAC5DC,YAAYA,CAACC,KAAgC,EAAa;IACtD,MAAM;MAAEC;IAAG,CAAC,GAAGJ,eAAe,CAACG,KAAK,CAACC,EAAE,CAAC;IACxC,OAAO;MACHA,EAAE;MACFC,GAAG,EAAEF,KAAK,CAACG,MAAM,CAACD,GAAG;MACrBE,IAAI,EAAEJ,KAAK,CAACG,MAAM,CAACC,IAAI;MACvBC,KAAK,EAAEL,KAAK,CAACG,MAAM,CAACE;IACxB,CAAC;EACL;EAEAC,UAAUA,CAACC,QAAwB,EAAa;IAC5C,OAAO;MACHN,EAAE,EAAEM,QAAQ,CAACN,EAAE;MACfC,GAAG,EAAEK,QAAQ,CAACL,GAAG;MACjBE,IAAI,EAAEG,QAAQ,CAACH,IAAI;MACnBC,KAAK,EAAEE,QAAQ,CAACF;IACpB,CAAC;EACL;AACJ;AAEA,OAAO,MAAMV,cAAc,GAAGC,iBAAiB,CAACY,oBAAoB,CAAC;EACjEC,cAAc,EAAEX,kBAAkB;EAClCY,YAAY,EAAE;AAClB,CAAC,CAAC","ignoreList":[]}

package/domain/workflow/abstractions.d.ts

@@ -0,0 +1,37 @@
+import type { CmsEntry, CmsModel } from "@webiny/api-headless-cms/types";
+import type { NonEmptyArray } from "@webiny/api/types.js";
+import type { IWorkflowInput } from "../../features/shared/abstractions.js";
+export interface IWorkflowStepNotification {
+    id: string;
+}
+export interface IWorkflowStepTeam {
+    id: string;
+}
+export interface IWorkflowStep {
+    id: string;
+    title: string;
+    color: string;
+    description?: string;
+    teams: NonEmptyArray<IWorkflowStepTeam>;
+    notifications?: IWorkflowStepNotification[];
+}
+export interface IWorkflowValues {
+    app: string;
+    name: string;
+    steps: NonEmptyArray<IWorkflowStep>;
+}
+export interface IWorkflow extends IWorkflowValues {
+    id: string;
+}
+export declare const WorkflowModel: import("@webiny/di").Abstraction<CmsModel>;
+export declare namespace WorkflowModel {
+    type Interface = CmsModel;
+}
+export interface IWorkflowMapper {
+    fromCmsEntry(input: CmsEntry<Omit<IWorkflow, "id">>): IWorkflow;
+    toCmsEntry(input: IWorkflowInput): IWorkflow;
+}
+export declare const WorkflowMapper: import("@webiny/di").Abstraction<IWorkflowMapper>;
+export declare namespace WorkflowMapper {
+    type Interface = IWorkflowMapper;
+}

package/domain/workflow/abstractions.js

@@ -0,0 +1,6 @@
+import { createAbstraction } from "@webiny/feature/api";
+// Abstractions
+export const WorkflowModel = createAbstraction("WorkflowModel");
+export const WorkflowMapper = createAbstraction("WorkflowMapper");
+
+//# sourceMappingURL=abstractions.js.map

package/domain/workflow/abstractions.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["createAbstraction","WorkflowModel","WorkflowMapper"],"sources":["abstractions.ts"],"sourcesContent":["import { createAbstraction } from \"@webiny/feature/api\";\nimport type { CmsEntry, CmsModel } from \"@webiny/api-headless-cms/types\";\nimport type { NonEmptyArray } from \"@webiny/api/types.js\";\nimport type { IWorkflowInput } from \"~/features/shared/abstractions.js\";\n\nexport interface IWorkflowStepNotification {\n    id: string;\n}\n\nexport interface IWorkflowStepTeam {\n    id: string;\n}\n\nexport interface IWorkflowStep {\n    id: string;\n    title: string;\n    color: string;\n    description?: string;\n    teams: NonEmptyArray<IWorkflowStepTeam>;\n    notifications?: IWorkflowStepNotification[];\n}\n\nexport interface IWorkflowValues {\n    app: string;\n    name: string;\n    steps: NonEmptyArray<IWorkflowStep>;\n}\n\nexport interface IWorkflow extends IWorkflowValues {\n    id: string;\n}\n\n// Abstractions\nexport const WorkflowModel = createAbstraction<CmsModel>(\"WorkflowModel\");\n\nexport namespace WorkflowModel {\n    export type Interface = CmsModel;\n}\n\nexport interface IWorkflowMapper {\n    fromCmsEntry(input: CmsEntry<Omit<IWorkflow, \"id\">>): IWorkflow;\n    toCmsEntry(input: IWorkflowInput): IWorkflow;\n}\n\nexport const WorkflowMapper = createAbstraction<IWorkflowMapper>(\"WorkflowMapper\");\n\nexport namespace WorkflowMapper {\n    export type Interface = IWorkflowMapper;\n}\n"],"mappings":"AAAA,SAASA,iBAAiB,QAAQ,qBAAqB;AAgCvD;AACA,OAAO,MAAMC,aAAa,GAAGD,iBAAiB,CAAW,eAAe,CAAC;AAWzE,OAAO,MAAME,cAAc,GAAGF,iBAAiB,CAAkB,gBAAgB,CAAC","ignoreList":[]}

package/domain/workflow/errors.d.ts

@@ -0,0 +1,23 @@
+import { BaseError } from "@webiny/feature/api";
+export declare class WorkflowNotFoundError extends BaseError<{
+    id: string;
+    app: string;
+}> {
+    readonly code: "Workflows/Workflow/NotFound";
+    constructor(data: {
+        id: string;
+        app: string;
+    });
+}
+export declare class WorkflowNotAuthorizedError extends BaseError {
+    readonly code: "Workflows/Workflow/NotAuthorized";
+    constructor(message?: string);
+}
+export declare class WorkflowPersistenceError extends BaseError {
+    readonly code: "Workflows/Workflow/Persistence";
+    constructor(error: Error);
+}
+export declare class WorkflowValidationError extends BaseError {
+    readonly code: "Workflows/Workflow/Validation";
+    constructor(message: string);
+}

package/domain/workflow/errors.js

@@ -0,0 +1,36 @@
+import { BaseError } from "@webiny/feature/api";
+export class WorkflowNotFoundError extends BaseError {
+  code = "Workflows/Workflow/NotFound";
+  constructor(data) {
+    super({
+      message: `Workflow in app "${data.app}" with id "${data.id}" was not found!`,
+      data
+    });
+  }
+}
+export class WorkflowNotAuthorizedError extends BaseError {
+  code = "Workflows/Workflow/NotAuthorized";
+  constructor(message) {
+    super({
+      message: message || "Not authorized to access workflow"
+    });
+  }
+}
+export class WorkflowPersistenceError extends BaseError {
+  code = "Workflows/Workflow/Persistence";
+  constructor(error) {
+    super({
+      message: error.message
+    });
+  }
+}
+export class WorkflowValidationError extends BaseError {
+  code = "Workflows/Workflow/Validation";
+  constructor(message) {
+    super({
+      message
+    });
+  }
+}
+
+//# sourceMappingURL=errors.js.map

package/domain/workflow/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["BaseError","WorkflowNotFoundError","code","constructor","data","message","app","id","WorkflowNotAuthorizedError","WorkflowPersistenceError","error","WorkflowValidationError"],"sources":["errors.ts"],"sourcesContent":["import { BaseError } from \"@webiny/feature/api\";\n\nexport class WorkflowNotFoundError extends BaseError<{ id: string; app: string }> {\n    override readonly code = \"Workflows/Workflow/NotFound\" as const;\n\n    constructor(data: { id: string; app: string }) {\n        super({\n            message: `Workflow in app \"${data.app}\" with id \"${data.id}\" was not found!`,\n            data\n        });\n    }\n}\n\nexport class WorkflowNotAuthorizedError extends BaseError {\n    override readonly code = \"Workflows/Workflow/NotAuthorized\" as const;\n\n    constructor(message?: string) {\n        super({\n            message: message || \"Not authorized to access workflow\"\n        });\n    }\n}\n\nexport class WorkflowPersistenceError extends BaseError {\n    override readonly code = \"Workflows/Workflow/Persistence\" as const;\n\n    constructor(error: Error) {\n        super({\n            message: error.message\n        });\n    }\n}\n\nexport class WorkflowValidationError extends BaseError {\n    override readonly code = \"Workflows/Workflow/Validation\" as const;\n\n    constructor(message: string) {\n        super({\n            message\n        });\n    }\n}\n"],"mappings":"AAAA,SAASA,SAAS,QAAQ,qBAAqB;AAE/C,OAAO,MAAMC,qBAAqB,SAASD,SAAS,CAA8B;EAC5DE,IAAI,GAAG,6BAA6B;EAEtDC,WAAWA,CAACC,IAAiC,EAAE;IAC3C,KAAK,CAAC;MACFC,OAAO,EAAE,oBAAoBD,IAAI,CAACE,GAAG,cAAcF,IAAI,CAACG,EAAE,kBAAkB;MAC5EH;IACJ,CAAC,CAAC;EACN;AACJ;AAEA,OAAO,MAAMI,0BAA0B,SAASR,SAAS,CAAC;EACpCE,IAAI,GAAG,kCAAkC;EAE3DC,WAAWA,CAACE,OAAgB,EAAE;IAC1B,KAAK,CAAC;MACFA,OAAO,EAAEA,OAAO,IAAI;IACxB,CAAC,CAAC;EACN;AACJ;AAEA,OAAO,MAAMI,wBAAwB,SAAST,SAAS,CAAC;EAClCE,IAAI,GAAG,gCAAgC;EAEzDC,WAAWA,CAACO,KAAY,EAAE;IACtB,KAAK,CAAC;MACFL,OAAO,EAAEK,KAAK,CAACL;IACnB,CAAC,CAAC;EACN;AACJ;AAEA,OAAO,MAAMM,uBAAuB,SAASX,SAAS,CAAC;EACjCE,IAAI,GAAG,+BAA+B;EAExDC,WAAWA,CAACE,OAAe,EAAE;IACzB,KAAK,CAAC;MACFA;IACJ,CAAC,CAAC;EACN;AACJ","ignoreList":[]}

package/domain/workflow/workflowModel.d.ts

@@ -0,0 +1,9 @@
+import { ModelFactory } from "@webiny/api-headless-cms/features/modelBuilder/index.js";
+import { WORKFLOW_MODEL_ID } from "../../constants.js";
+export { WORKFLOW_MODEL_ID };
+declare class WorkflowModelImpl implements ModelFactory.Interface {
+    execute(builder: ModelFactory.Builder): Promise<import("@webiny/api-headless-cms/features/modelBuilder/index.js").PrivateModelBuilder[]>;
+}
+export declare const WorkflowModel: typeof WorkflowModelImpl & {
+    __abstraction: import("@webiny/di").Abstraction<import("@webiny/api-headless-cms/features/modelBuilder/abstractions").IModelFactory>;
+};

package/domain/workflow/workflowModel.js

@@ -0,0 +1,32 @@
+import { ModelFactory } from "@webiny/api-headless-cms/features/modelBuilder/index.js";
+import { WORKFLOW_MODEL_ID } from "../../constants.js";
+export { WORKFLOW_MODEL_ID };
+class WorkflowModelImpl {
+  async execute(builder) {
+    return [builder.private({
+      modelId: WORKFLOW_MODEL_ID,
+      name: "Workflow"
+    }).fields(fields => ({
+      name: fields.text().label("Name").required("Workflow name is required."),
+      app: fields.text().label("App").required("App is required."),
+      steps: fields.object().label("Steps").list().required("Steps are required.").listMinLength(1, "At least one step is required.").fields(fields => ({
+        id: fields.text().label("ID").required("ID is required."),
+        title: fields.text().label("Title").required("Title is required."),
+        color: fields.text().label("Color"),
+        description: fields.text().label("Description"),
+        teams: fields.object().label("Teams").list().fields(teamFields => ({
+          id: teamFields.text().label("ID").required("ID is required.")
+        })),
+        notifications: fields.object().list().label("Notifications").fields(fields => ({
+          id: fields.text().label("Id").required("Id is required.")
+        }))
+      }))
+    }))];
+  }
+}
+export const WorkflowModel = ModelFactory.createImplementation({
+  implementation: WorkflowModelImpl,
+  dependencies: []
+});
+
+//# sourceMappingURL=workflowModel.js.map

package/domain/workflow/workflowModel.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["ModelFactory","WORKFLOW_MODEL_ID","WorkflowModelImpl","execute","builder","private","modelId","name","fields","text","label","required","app","steps","object","list","listMinLength","id","title","color","description","teams","teamFields","notifications","WorkflowModel","createImplementation","implementation","dependencies"],"sources":["workflowModel.ts"],"sourcesContent":["import { ModelFactory } from \"@webiny/api-headless-cms/features/modelBuilder/index.js\";\nimport { WORKFLOW_MODEL_ID } from \"~/constants.js\";\n\nexport { WORKFLOW_MODEL_ID };\n\nclass WorkflowModelImpl implements ModelFactory.Interface {\n    public async execute(builder: ModelFactory.Builder) {\n        return [\n            builder\n                .private({\n                    modelId: WORKFLOW_MODEL_ID,\n                    name: \"Workflow\"\n                })\n                .fields(fields => ({\n                    name: fields.text().label(\"Name\").required(\"Workflow name is required.\"),\n                    app: fields.text().label(\"App\").required(\"App is required.\"),\n                    steps: fields\n                        .object()\n                        .label(\"Steps\")\n                        .list()\n                        .required(\"Steps are required.\")\n                        .listMinLength(1, \"At least one step is required.\")\n                        .fields(fields => ({\n                            id: fields.text().label(\"ID\").required(\"ID is required.\"),\n                            title: fields.text().label(\"Title\").required(\"Title is required.\"),\n                            color: fields.text().label(\"Color\"),\n                            description: fields.text().label(\"Description\"),\n                            teams: fields\n                                .object()\n                                .label(\"Teams\")\n                                .list()\n                                .fields(teamFields => ({\n                                    id: teamFields.text().label(\"ID\").required(\"ID is required.\")\n                                })),\n                            notifications: fields\n                                .object()\n                                .list()\n                                .label(\"Notifications\")\n                                .fields(fields => ({\n                                    id: fields.text().label(\"Id\").required(\"Id is required.\")\n                                }))\n                        }))\n                }))\n        ];\n    }\n}\n\nexport const WorkflowModel = ModelFactory.createImplementation({\n    implementation: WorkflowModelImpl,\n    dependencies: []\n});\n"],"mappings":"AAAA,SAASA,YAAY,QAAQ,yDAAyD;AACtF,SAASC,iBAAiB;AAE1B,SAASA,iBAAiB;AAE1B,MAAMC,iBAAiB,CAAmC;EACtD,MAAaC,OAAOA,CAACC,OAA6B,EAAE;IAChD,OAAO,CACHA,OAAO,CACFC,OAAO,CAAC;MACLC,OAAO,EAAEL,iBAAiB;MAC1BM,IAAI,EAAE;IACV,CAAC,CAAC,CACDC,MAAM,CAACA,MAAM,KAAK;MACfD,IAAI,EAAEC,MAAM,CAACC,IAAI,CAAC,CAAC,CAACC,KAAK,CAAC,MAAM,CAAC,CAACC,QAAQ,CAAC,4BAA4B,CAAC;MACxEC,GAAG,EAAEJ,MAAM,CAACC,IAAI,CAAC,CAAC,CAACC,KAAK,CAAC,KAAK,CAAC,CAACC,QAAQ,CAAC,kBAAkB,CAAC;MAC5DE,KAAK,EAAEL,MAAM,CACRM,MAAM,CAAC,CAAC,CACRJ,KAAK,CAAC,OAAO,CAAC,CACdK,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,qBAAqB,CAAC,CAC/BK,aAAa,CAAC,CAAC,EAAE,gCAAgC,CAAC,CAClDR,MAAM,CAACA,MAAM,KAAK;QACfS,EAAE,EAAET,MAAM,CAACC,IAAI,CAAC,CAAC,CAACC,KAAK,CAAC,IAAI,CAAC,CAACC,QAAQ,CAAC,iBAAiB,CAAC;QACzDO,KAAK,EAAEV,MAAM,CAACC,IAAI,CAAC,CAAC,CAACC,KAAK,CAAC,OAAO,CAAC,CAACC,QAAQ,CAAC,oBAAoB,CAAC;QAClEQ,KAAK,EAAEX,MAAM,CAACC,IAAI,CAAC,CAAC,CAACC,KAAK,CAAC,OAAO,CAAC;QACnCU,WAAW,EAAEZ,MAAM,CAACC,IAAI,CAAC,CAAC,CAACC,KAAK,CAAC,aAAa,CAAC;QAC/CW,KAAK,EAAEb,MAAM,CACRM,MAAM,CAAC,CAAC,CACRJ,KAAK,CAAC,OAAO,CAAC,CACdK,IAAI,CAAC,CAAC,CACNP,MAAM,CAACc,UAAU,KAAK;UACnBL,EAAE,EAAEK,UAAU,CAACb,IAAI,CAAC,CAAC,CAACC,KAAK,CAAC,IAAI,CAAC,CAACC,QAAQ,CAAC,iBAAiB;QAChE,CAAC,CAAC,CAAC;QACPY,aAAa,EAAEf,MAAM,CAChBM,MAAM,CAAC,CAAC,CACRC,IAAI,CAAC,CAAC,CACNL,KAAK,CAAC,eAAe,CAAC,CACtBF,MAAM,CAACA,MAAM,KAAK;UACfS,EAAE,EAAET,MAAM,CAACC,IAAI,CAAC,CAAC,CAACC,KAAK,CAAC,IAAI,CAAC,CAACC,QAAQ,CAAC,iBAAiB;QAC5D,CAAC,CAAC;MACV,CAAC,CAAC;IACV,CAAC,CAAC,CAAC,CACV;EACL;AACJ;AAEA,OAAO,MAAMa,aAAa,GAAGxB,YAAY,CAACyB,oBAAoB,CAAC;EAC3DC,cAAc,EAAExB,iBAAiB;EACjCyB,YAAY,EAAE;AAClB,CAAC,CAAC","ignoreList":[]}

package/domain/workflowState/WorkflowState.d.ts

@@ -0,0 +1,55 @@
+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 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;
+}