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

package/graphql/workflows.js

@@ -0,0 +1,213 @@
+import { NotFoundError, resolve, resolveList } from "@webiny/api-graphql";
+import { createZodError } from "@webiny/utils";
+import { listWorkflowsValidation } from "./validation/listWorkflows.js";
+import { getWorkflowValidation } from "./validation/getWorkflow.js";
+import { storeWorkflowValidation } from "./validation/storeWorkflow.js";
+import { deleteWorkflowValidation } from "./validation/deleteWorkflow.js";
+import { GetWorkflowUseCase } from "../features/workflow/GetWorkflow/index.js";
+import { ListWorkflowsUseCase } from "../features/workflow/ListWorkflows/index.js";
+import { StoreWorkflowUseCase } from "../features/workflow/StoreWorkflow/index.js";
+import { DeleteWorkflowUseCase } from "../features/workflow/DeleteWorkflow/index.js";
+const addWorkflowsSchema = (builder)=>{
+    builder.addTypeDefs(`
+        type WorkflowError {
+            code: String
+            message: String
+            data: JSON
+            stack: String
+        }
+
+        input WorkflowStepNotificationInput {
+            id: String!
+        }
+
+        input WorkflowStepTeamInput {
+            id: String!
+        }
+
+        input WorkflowStepInput {
+            id: String!
+            title: String!
+            color: String!
+            description: String
+            teams: [WorkflowStepTeamInput!]!
+            notifications: [WorkflowStepNotificationInput!]
+        }
+
+        input StoreWorkflowInput {
+            name: String!
+            steps: [WorkflowStepInput!]!
+        }
+
+        type WorkflowStepNotification {
+            id: String!
+        }
+
+        type WorkflowStepTeam {
+            id: String!
+        }
+
+        type WorkflowStep {
+            id: String!
+            title: String!
+            color: String!
+            description: String
+            teams: [WorkflowStepTeam!]!
+            notifications: [WorkflowStepNotification!]
+        }
+
+        type Workflow {
+            id: String!
+            app: String!
+            name: String!
+            steps: [WorkflowStep!]!
+        }
+
+        type ListWorkflowsMeta {
+            cursor: String
+            hasMoreItems: Boolean!
+            totalCount: Int!
+        }
+
+        type ListWorkflowsResponse {
+            data: [Workflow!]
+            meta: ListWorkflowsMeta
+            error: WorkflowError
+        }
+
+        type GetWorkflowResponse {
+            data: Workflow
+            error: WorkflowError
+        }
+
+        input ListWorkflowsWhereInput {
+            app: String
+            app_in: [String!]
+            id: String
+            id_in: [String!]
+        }
+
+        enum ListWorkflowsSort {
+            createdOn_ASC
+            createdOn_DESC
+        }
+
+        type WorkflowsQuery {
+            listWorkflows(
+                where: ListWorkflowsWhereInput
+                limit: Int
+                sort: [ListWorkflowsSort!]
+                after: String
+            ): ListWorkflowsResponse!
+            getWorkflow(app: String!, id: ID!): GetWorkflowResponse!
+        }
+
+        type CreateWorkflowResponse {
+            data: Workflow
+            error: WorkflowError
+        }
+
+        type StoreWorkflowResponse {
+            data: Workflow
+            error: WorkflowError
+        }
+
+        type DeleteWorkflowResponse {
+            data: Boolean
+            error: WorkflowError
+        }
+
+        type WorkflowsMutation {
+            storeWorkflow(app: String!, id: ID!, data: StoreWorkflowInput!): StoreWorkflowResponse!
+            deleteWorkflow(app: String!, id: ID!): DeleteWorkflowResponse!
+        }
+
+        extend type Query {
+            workflows: WorkflowsQuery
+        }
+
+        extend type Mutation {
+            workflows: WorkflowsMutation
+        }
+    `);
+    builder.addResolver({
+        path: "Query.workflows",
+        dependencies: [],
+        resolver: ()=>()=>({})
+    });
+    builder.addResolver({
+        path: "Mutation.workflows",
+        dependencies: [],
+        resolver: ()=>()=>({})
+    });
+    builder.addResolver({
+        path: "WorkflowsQuery.getWorkflow",
+        dependencies: [
+            GetWorkflowUseCase
+        ],
+        resolver (getWorkflow) {
+            return ({ args })=>resolve(async ()=>{
+                    const result = await getWorkflowValidation.safeParseAsync(args);
+                    if (!result.success) throw createZodError(result.error);
+                    const workflowResult = await getWorkflow.execute(args);
+                    if (workflowResult.isFail()) throw new NotFoundError(`Workflow in app "${args.app}" with id "${args.id}" was not found!`);
+                    return workflowResult.value;
+                });
+        }
+    });
+    builder.addResolver({
+        path: "WorkflowsQuery.listWorkflows",
+        dependencies: [
+            ListWorkflowsUseCase
+        ],
+        resolver (listWorkflows) {
+            return ({ args })=>resolveList(async ()=>{
+                    const result = await listWorkflowsValidation.safeParseAsync(args);
+                    if (!result.success) throw createZodError(result.error);
+                    const listResult = await listWorkflows.execute(result.data);
+                    if (listResult.isFail()) throw listResult.error;
+                    return listResult.value;
+                });
+        }
+    });
+    builder.addResolver({
+        path: "WorkflowsMutation.storeWorkflow",
+        dependencies: [
+            StoreWorkflowUseCase
+        ],
+        resolver (storeWorkflow) {
+            return ({ args })=>resolve(async ()=>{
+                    const result = await storeWorkflowValidation.safeParseAsync(args);
+                    if (!result.success) throw createZodError(result.error);
+                    const storeResult = await storeWorkflow.execute({
+                        app: result.data.app,
+                        id: result.data.id,
+                        ...result.data.data
+                    });
+                    if (storeResult.isFail()) throw storeResult.error;
+                    return storeResult.value;
+                });
+        }
+    });
+    builder.addResolver({
+        path: "WorkflowsMutation.deleteWorkflow",
+        dependencies: [
+            DeleteWorkflowUseCase
+        ],
+        resolver (deleteWorkflow) {
+            return ({ args })=>resolve(async ()=>{
+                    const result = await deleteWorkflowValidation.safeParseAsync(args);
+                    if (!result.success) throw createZodError(result.error);
+                    const deleteResult = await deleteWorkflow.execute({
+                        app: result.data.app,
+                        id: result.data.id
+                    });
+                    if (deleteResult.isFail()) throw deleteResult.error;
+                    return true;
+                });
+        }
+    });
+};
+export { addWorkflowsSchema };
+
+//# sourceMappingURL=workflows.js.map

package/graphql/workflows.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"graphql/workflows.js","sources":["../../src/graphql/workflows.ts"],"sourcesContent":["import { NotFoundError, resolve, resolveList } from \"@webiny/api-graphql\";\nimport type { IGraphQLSchemaBuilder } from \"@webiny/api-graphql/features/GraphQLSchemaBuilder/abstractions.js\";\nimport { createZodError } from \"@webiny/utils\";\nimport { listWorkflowsValidation } from \"./validation/listWorkflows.js\";\nimport { getWorkflowValidation } from \"./validation/getWorkflow.js\";\nimport { storeWorkflowValidation } from \"./validation/storeWorkflow.js\";\nimport { deleteWorkflowValidation } from \"./validation/deleteWorkflow.js\";\nimport { GetWorkflowUseCase } from \"~/features/workflow/GetWorkflow/index.js\";\nimport { ListWorkflowsUseCase } from \"~/features/workflow/ListWorkflows/index.js\";\nimport { StoreWorkflowUseCase } from \"~/features/workflow/StoreWorkflow/index.js\";\nimport { DeleteWorkflowUseCase } from \"~/features/workflow/DeleteWorkflow/index.js\";\n\nexport const addWorkflowsSchema = (builder: IGraphQLSchemaBuilder): void => {\n    builder.addTypeDefs(/* GraphQL */ `\n        type WorkflowError {\n            code: String\n            message: String\n            data: JSON\n            stack: String\n        }\n\n        input WorkflowStepNotificationInput {\n            id: String!\n        }\n\n        input WorkflowStepTeamInput {\n            id: String!\n        }\n\n        input WorkflowStepInput {\n            id: String!\n            title: String!\n            color: String!\n            description: String\n            teams: [WorkflowStepTeamInput!]!\n            notifications: [WorkflowStepNotificationInput!]\n        }\n\n        input StoreWorkflowInput {\n            name: String!\n            steps: [WorkflowStepInput!]!\n        }\n\n        type WorkflowStepNotification {\n            id: String!\n        }\n\n        type WorkflowStepTeam {\n            id: String!\n        }\n\n        type WorkflowStep {\n            id: String!\n            title: String!\n            color: String!\n            description: String\n            teams: [WorkflowStepTeam!]!\n            notifications: [WorkflowStepNotification!]\n        }\n\n        type Workflow {\n            id: String!\n            app: String!\n            name: String!\n            steps: [WorkflowStep!]!\n        }\n\n        type ListWorkflowsMeta {\n            cursor: String\n            hasMoreItems: Boolean!\n            totalCount: Int!\n        }\n\n        type ListWorkflowsResponse {\n            data: [Workflow!]\n            meta: ListWorkflowsMeta\n            error: WorkflowError\n        }\n\n        type GetWorkflowResponse {\n            data: Workflow\n            error: WorkflowError\n        }\n\n        input ListWorkflowsWhereInput {\n            app: String\n            app_in: [String!]\n            id: String\n            id_in: [String!]\n        }\n\n        enum ListWorkflowsSort {\n            createdOn_ASC\n            createdOn_DESC\n        }\n\n        type WorkflowsQuery {\n            listWorkflows(\n                where: ListWorkflowsWhereInput\n                limit: Int\n                sort: [ListWorkflowsSort!]\n                after: String\n            ): ListWorkflowsResponse!\n            getWorkflow(app: String!, id: ID!): GetWorkflowResponse!\n        }\n\n        type CreateWorkflowResponse {\n            data: Workflow\n            error: WorkflowError\n        }\n\n        type StoreWorkflowResponse {\n            data: Workflow\n            error: WorkflowError\n        }\n\n        type DeleteWorkflowResponse {\n            data: Boolean\n            error: WorkflowError\n        }\n\n        type WorkflowsMutation {\n            storeWorkflow(app: String!, id: ID!, data: StoreWorkflowInput!): StoreWorkflowResponse!\n            deleteWorkflow(app: String!, id: ID!): DeleteWorkflowResponse!\n        }\n\n        extend type Query {\n            workflows: WorkflowsQuery\n        }\n\n        extend type Mutation {\n            workflows: WorkflowsMutation\n        }\n    `);\n\n    builder.addResolver({\n        path: \"Query.workflows\",\n        dependencies: [],\n        resolver: () => () => ({})\n    });\n\n    builder.addResolver({\n        path: \"Mutation.workflows\",\n        dependencies: [],\n        resolver: () => () => ({})\n    });\n\n    builder.addResolver({\n        path: \"WorkflowsQuery.getWorkflow\",\n        dependencies: [GetWorkflowUseCase],\n        resolver(getWorkflow) {\n            return ({ args }) =>\n                resolve(async () => {\n                    const result = await getWorkflowValidation.safeParseAsync(args);\n                    if (!result.success) {\n                        throw createZodError(result.error);\n                    }\n\n                    const workflowResult = await getWorkflow.execute(args);\n\n                    if (workflowResult.isFail()) {\n                        throw new NotFoundError(\n                            `Workflow in app \"${args.app}\" with id \"${args.id}\" was not found!`\n                        );\n                    }\n\n                    return workflowResult.value;\n                });\n        }\n    });\n\n    builder.addResolver({\n        path: \"WorkflowsQuery.listWorkflows\",\n        dependencies: [ListWorkflowsUseCase],\n        resolver(listWorkflows) {\n            return ({ args }) =>\n                resolveList(async () => {\n                    const result = await listWorkflowsValidation.safeParseAsync(args);\n                    if (!result.success) {\n                        throw createZodError(result.error);\n                    }\n\n                    const listResult = await listWorkflows.execute(result.data);\n\n                    if (listResult.isFail()) {\n                        throw listResult.error;\n                    }\n\n                    return listResult.value;\n                });\n        }\n    });\n\n    builder.addResolver({\n        path: \"WorkflowsMutation.storeWorkflow\",\n        dependencies: [StoreWorkflowUseCase],\n        resolver(storeWorkflow) {\n            return ({ args }) =>\n                resolve(async () => {\n                    const result = await storeWorkflowValidation.safeParseAsync(args);\n                    if (!result.success) {\n                        throw createZodError(result.error);\n                    }\n\n                    const storeResult = await storeWorkflow.execute({\n                        app: result.data.app,\n                        id: result.data.id,\n                        ...result.data.data\n                    });\n\n                    if (storeResult.isFail()) {\n                        throw storeResult.error;\n                    }\n\n                    return storeResult.value;\n                });\n        }\n    });\n\n    builder.addResolver({\n        path: \"WorkflowsMutation.deleteWorkflow\",\n        dependencies: [DeleteWorkflowUseCase],\n        resolver(deleteWorkflow) {\n            return ({ args }) =>\n                resolve(async () => {\n                    const result = await deleteWorkflowValidation.safeParseAsync(args);\n                    if (!result.success) {\n                        throw createZodError(result.error);\n                    }\n\n                    const deleteResult = await deleteWorkflow.execute({\n                        app: result.data.app,\n                        id: result.data.id\n                    });\n\n                    if (deleteResult.isFail()) {\n                        throw deleteResult.error;\n                    }\n\n                    return true;\n                });\n        }\n    });\n};\n"],"names":["addWorkflowsSchema","builder","GetWorkflowUseCase","getWorkflow","args","resolve","result","getWorkflowValidation","createZodError","workflowResult","NotFoundError","ListWorkflowsUseCase","listWorkflows","resolveList","listWorkflowsValidation","listResult","StoreWorkflowUseCase","storeWorkflow","storeWorkflowValidation","storeResult","DeleteWorkflowUseCase","deleteWorkflow","deleteWorkflowValidation","deleteResult"],"mappings":";;;;;;;;;;AAYO,MAAMA,qBAAqB,CAACC;IAC/BA,QAAQ,WAAW,CAAe,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAwHnC,CAAC;IAEDA,QAAQ,WAAW,CAAC;QAChB,MAAM;QACN,cAAc,EAAE;QAChB,UAAU,IAAM,IAAO,EAAC;IAC5B;IAEAA,QAAQ,WAAW,CAAC;QAChB,MAAM;QACN,cAAc,EAAE;QAChB,UAAU,IAAM,IAAO,EAAC;IAC5B;IAEAA,QAAQ,WAAW,CAAC;QAChB,MAAM;QACN,cAAc;YAACC;SAAmB;QAClC,UAASC,WAAW;YAChB,OAAO,CAAC,EAAEC,IAAI,EAAE,GACZC,QAAQ;oBACJ,MAAMC,SAAS,MAAMC,sBAAsB,cAAc,CAACH;oBAC1D,IAAI,CAACE,OAAO,OAAO,EACf,MAAME,eAAeF,OAAO,KAAK;oBAGrC,MAAMG,iBAAiB,MAAMN,YAAY,OAAO,CAACC;oBAEjD,IAAIK,eAAe,MAAM,IACrB,MAAM,IAAIC,cACN,CAAC,iBAAiB,EAAEN,KAAK,GAAG,CAAC,WAAW,EAAEA,KAAK,EAAE,CAAC,gBAAgB,CAAC;oBAI3E,OAAOK,eAAe,KAAK;gBAC/B;QACR;IACJ;IAEAR,QAAQ,WAAW,CAAC;QAChB,MAAM;QACN,cAAc;YAACU;SAAqB;QACpC,UAASC,aAAa;YAClB,OAAO,CAAC,EAAER,IAAI,EAAE,GACZS,YAAY;oBACR,MAAMP,SAAS,MAAMQ,wBAAwB,cAAc,CAACV;oBAC5D,IAAI,CAACE,OAAO,OAAO,EACf,MAAME,eAAeF,OAAO,KAAK;oBAGrC,MAAMS,aAAa,MAAMH,cAAc,OAAO,CAACN,OAAO,IAAI;oBAE1D,IAAIS,WAAW,MAAM,IACjB,MAAMA,WAAW,KAAK;oBAG1B,OAAOA,WAAW,KAAK;gBAC3B;QACR;IACJ;IAEAd,QAAQ,WAAW,CAAC;QAChB,MAAM;QACN,cAAc;YAACe;SAAqB;QACpC,UAASC,aAAa;YAClB,OAAO,CAAC,EAAEb,IAAI,EAAE,GACZC,QAAQ;oBACJ,MAAMC,SAAS,MAAMY,wBAAwB,cAAc,CAACd;oBAC5D,IAAI,CAACE,OAAO,OAAO,EACf,MAAME,eAAeF,OAAO,KAAK;oBAGrC,MAAMa,cAAc,MAAMF,cAAc,OAAO,CAAC;wBAC5C,KAAKX,OAAO,IAAI,CAAC,GAAG;wBACpB,IAAIA,OAAO,IAAI,CAAC,EAAE;wBAClB,GAAGA,OAAO,IAAI,CAAC,IAAI;oBACvB;oBAEA,IAAIa,YAAY,MAAM,IAClB,MAAMA,YAAY,KAAK;oBAG3B,OAAOA,YAAY,KAAK;gBAC5B;QACR;IACJ;IAEAlB,QAAQ,WAAW,CAAC;QAChB,MAAM;QACN,cAAc;YAACmB;SAAsB;QACrC,UAASC,cAAc;YACnB,OAAO,CAAC,EAAEjB,IAAI,EAAE,GACZC,QAAQ;oBACJ,MAAMC,SAAS,MAAMgB,yBAAyB,cAAc,CAAClB;oBAC7D,IAAI,CAACE,OAAO,OAAO,EACf,MAAME,eAAeF,OAAO,KAAK;oBAGrC,MAAMiB,eAAe,MAAMF,eAAe,OAAO,CAAC;wBAC9C,KAAKf,OAAO,IAAI,CAAC,GAAG;wBACpB,IAAIA,OAAO,IAAI,CAAC,EAAE;oBACtB;oBAEA,IAAIiB,aAAa,MAAM,IACnB,MAAMA,aAAa,KAAK;oBAG5B,OAAO;gBACX;QACR;IACJ;AACJ"}

package/index.d.ts

@@ -0,0 +1 @@
+export { WorkflowsFeature } from "./WorkflowsFeature.js";

package/index.js

@@ -0,0 +1 @@
+export { WorkflowsFeature } from "./WorkflowsFeature.js";

package/package.json

@@ -0,0 +1,48 @@
+{
+	"name": "@webiny/api-workflows",
+	"version": "0.0.0-unstable.0d717d18dd",
+	"type": "module",
+	"exports": {
+		".": "./index.js",
+		"./*": "./*"
+	},
+	"description": "Workflows API",
+	"keywords": [
+		"api-workflows:base"
+	],
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git",
+		"directory": "packages/api-workflows"
+	},
+	"license": "MIT",
+	"dependencies": {
+		"@webiny/api": "0.0.0-unstable.0d717d18dd",
+		"@webiny/api-core": "0.0.0-unstable.0d717d18dd",
+		"@webiny/api-graphql": "0.0.0-unstable.0d717d18dd",
+		"@webiny/api-headless-cms": "0.0.0-unstable.0d717d18dd",
+		"@webiny/api-mailer": "0.0.0-unstable.0d717d18dd",
+		"@webiny/di": "1.0.2",
+		"@webiny/event-handler-core": "0.0.0-unstable.0d717d18dd",
+		"@webiny/feature": "0.0.0-unstable.0d717d18dd",
+		"@webiny/utils": "0.0.0-unstable.0d717d18dd",
+		"graphql": "16.14.2",
+		"zod": "4.4.3"
+	},
+	"devDependencies": {
+		"@webiny/api-core-testing": "0.0.0-unstable.0d717d18dd",
+		"@webiny/api-headless-cms-testing": "0.0.0-unstable.0d717d18dd",
+		"@webiny/build-tools": "0.0.0-unstable.0d717d18dd",
+		"@webiny/plugins": "0.0.0-unstable.0d717d18dd",
+		"@webiny/project-utils": "0.0.0-unstable.0d717d18dd",
+		"type-fest": "5.8.0",
+		"typescript": "7.0.2",
+		"vitest": "4.1.10"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"webiny": {
+		"publishFrom": "dist"
+	}
+}

package/types.d.ts

@@ -0,0 +1,20 @@
+import type { SecurityPermission } from "@webiny/api-core/types/security.js";
+export interface ICmsEntryWorkflowState {
+    state: string;
+    workflowId: string;
+    stepId: string;
+    stepName: string;
+}
+export interface IWorkflowsSecurityPermission extends SecurityPermission {
+    editor: boolean;
+}
+export interface IMeta {
+    totalCount: number;
+    hasMoreItems: boolean;
+    cursor: string | null;
+}
+declare module "@webiny/api-headless-cms/types/types.js" {
+    interface IEntrySystem {
+        workflow?: ICmsEntryWorkflowState | null;
+    }
+}