@manablox/workflows 0.3.0 → 0.4.0

package/dist/index.d.ts

@@ -251,6 +251,7 @@ export declare class WorkflowService {
     };
   }, userAgent: string | null): Promise<PushSubscriptionRow>;
   unsubscribe(userId: string, endpoint: string): Promise<void>;
+  private audit;
   private find;
   private validationEnvironment;
 }

package/dist/index.js

@@ -1,5 +1,5 @@
+import { ManabloxError, WORKFLOW_CONDITION_OPERATORS, WORKFLOW_CONDITION_OPERATOR_LABELS, WORKFLOW_EVENTS, WORKFLOW_EVENT_LABELS, WORKFLOW_STEP_LABELS, WORKFLOW_STEP_TYPES, diffRecords, isEmailAddress, runAsActor, snapshotChanges } from "@manablox/core";
 import { createHmac, randomUUID } from "node:crypto";
-import { ManabloxError, WORKFLOW_CONDITION_OPERATORS, WORKFLOW_CONDITION_OPERATOR_LABELS, WORKFLOW_EVENTS, WORKFLOW_EVENT_LABELS, WORKFLOW_STEP_LABELS, WORKFLOW_STEP_TYPES, isEmailAddress } from "@manablox/core";
 import nodemailer from "nodemailer";
 import webpush from "web-push";
 import { requireInSpace } from "@manablox/services";
@@ -674,11 +674,22 @@ var WorkflowEngine = class {
 			});
 			return;
 		}
-		const log = [...run.log];
-		const outcome = await this.runChain(run, workflow, workflow.steps, [], run.cursor, log);
-		if (outcome.kind === "done") await this.finish(run, workflow, "succeeded", [], log, null);
-		else if (outcome.kind === "stop") await this.finish(run, workflow, "skipped", outcome.cursor, log, null);
-		else if (outcome.kind === "fail") await this.finish(run, workflow, "failed", outcome.cursor, log, outcome.error);
+		const actor = {
+			kind: "workflow",
+			id: workflow.id,
+			label: workflow.name,
+			detail: {
+				runId: run.id,
+				trigger: run.trigger
+			}
+		};
+		await runAsActor(actor, async () => {
+			const log = [...run.log];
+			const outcome = await this.runChain(run, workflow, workflow.steps, [], run.cursor, log);
+			if (outcome.kind === "done") await this.finish(run, workflow, "succeeded", [], log, null);
+			else if (outcome.kind === "stop") await this.finish(run, workflow, "skipped", outcome.cursor, log, null);
+			else if (outcome.kind === "fail") await this.finish(run, workflow, "failed", outcome.cursor, log, outcome.error);
+		});
 	}
 	/**
 	* Walks one chain — the top level, or a side of a fork — from `resume` when the run is
@@ -791,6 +802,24 @@ var WorkflowEngine = class {
 			manablox: this.manablox,
 			spaceId: workflow.spaceId
 		});
+		await this.repos.audit.record({
+			spaceId: workflow.spaceId,
+			action: "workflowRun.finish",
+			targetKind: "workflowRun",
+			targetId: run.id,
+			targetLabel: workflow.name,
+			meta: {
+				workflowId: workflow.id,
+				status,
+				trigger: run.trigger,
+				error,
+				contentId: run.context.content?.id ?? null,
+				steps: log.map((entry) => ({
+					step: entry.name || entry.type,
+					status: entry.status
+				}))
+			}
+		});
 	}
 	async spaceInfo(spaceId) {
 		const space = await this.repos.spaces.findById(spaceId);
@@ -1088,6 +1117,8 @@ function isHttpUrl(value) {
 const clamp = (value, min, max) => Math.min(max, Math.max(min, value));
 //#endregion
 //#region src/service.ts
+/** The scheduler's bookkeeping columns change on their own; the log records what people set. */
+const WORKFLOW_DIFF = { ignore: ["lastScheduledAt", "lastRunAt"] };
 /**
 * Workflows: the rules — a trigger that exists, steps with somewhere to go, a run that
 * belongs to the space it is asked for in — with the engine doing the running.
@@ -1132,24 +1163,35 @@ var WorkflowService = class {
 	}
 	async create(spaceId, input) {
 		const valid = validateWorkflow(input, this.validationEnvironment());
-		return this.repos.workflows.create({
+		const row = await this.repos.workflows.create({
 			spaceId,
 			...valid
 		});
+		await this.audit("workflow.create", row, snapshotChanges(row, "created", WORKFLOW_DIFF));
+		return row;
 	}
 	async update(spaceId, id, input) {
-		await this.find(spaceId, id);
+		const before = await this.find(spaceId, id);
 		const valid = validateWorkflow(input, this.validationEnvironment());
-		return this.repos.workflows.update(id, valid);
+		const row = await this.repos.workflows.update(id, valid);
+		await this.audit("workflow.update", row, diffRecords(before, row, WORKFLOW_DIFF));
+		return row;
 	}
 	/** The on/off switch, kept apart from a full save so the list can flip it. */
 	async setEnabled(spaceId, id, enabled) {
-		await this.find(spaceId, id);
-		return this.repos.workflows.update(id, { enabled });
+		const before = await this.find(spaceId, id);
+		const row = await this.repos.workflows.update(id, { enabled });
+		await this.audit("workflow.setEnabled", row, [{
+			path: "enabled",
+			from: before.enabled,
+			to: row.enabled
+		}]);
+		return row;
 	}
 	async delete(spaceId, id) {
-		await this.find(spaceId, id);
+		const row = await this.find(spaceId, id);
 		await this.repos.workflows.delete(id);
+		await this.audit("workflow.delete", row, snapshotChanges(row, "deleted", WORKFLOW_DIFF));
 	}
 	async runs(spaceId, id, limit = 50) {
 		await this.find(spaceId, id);
@@ -1168,7 +1210,13 @@ var WorkflowService = class {
 		let document = null;
 		if (contentId) document = requireInSpace(await this.repos.content.findById(contentId), spaceId, "content.notFound", { id: contentId });
 		else if (workflow.trigger.kind === "event") throw ManabloxError.badRequest("workflow.run.documentRequired");
-		return this.engine.runManually(workflow, document);
+		const run = await this.engine.runManually(workflow, document);
+		await this.audit("workflow.runNow", workflow, [], {
+			runId: run.id,
+			status: run.status,
+			contentId: document?.id ?? null
+		});
+		return run;
 	}
 	subscriptions(userId) {
 		return this.repos.workflows.subscriptionsOf(userId);
@@ -1185,6 +1233,17 @@ var WorkflowService = class {
 	unsubscribe(userId, endpoint) {
 		return this.repos.workflows.unsubscribe(userId, endpoint);
 	}
+	audit(action, workflow, changes, meta = null) {
+		return this.repos.audit.record({
+			spaceId: workflow.spaceId,
+			action,
+			targetKind: "workflow",
+			targetId: workflow.id,
+			targetLabel: workflow.name,
+			changes,
+			meta
+		});
+	}
 	async find(spaceId, id) {
 		return requireInSpace(await this.repos.workflows.findById(id), spaceId, "workflow.notFound", { id });
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manablox/workflows",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "type": "module",
   "exports": {
     ".": {
@@ -11,15 +11,15 @@
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@manablox/core": "0.3.0",
-    "@manablox/db": "0.3.0",
+    "@manablox/core": "0.4.0",
+    "@manablox/db": "0.4.0",
     "nodemailer": "^10.0.0",
     "web-push": "^3.6.7"
   },
   "devDependencies": {
     "@manablox/config-typescript": "0.0.0",
-    "@manablox/fields": "0.3.0",
-    "@manablox/services": "0.3.0",
+    "@manablox/fields": "0.4.0",
+    "@manablox/services": "0.4.0",
     "@types/node": "^26.4.1",
     "@types/nodemailer": "^8.0.1",
     "@types/web-push": "^3.6.4",