@voltro/cms 0.85.0 → 0.86.0

package/dist/workflow.js

@@ -0,0 +1,322 @@
+import { asTyped as e } from "./effectForm.js";
+import { ContentNotFound as t } from "./errors.js";
+import { and as n, eq as r, id as i, json as a, table as o, text as s, timestamp as c } from "@voltro/database";
+import { tenant as l } from "@voltro/plugin-multitenancy/mixin";
+//#region src/workflow.ts
+var u = "cms_workflow_instances", d = "cms_workflow_decisions", f = (e) => {
+	if (!/^[a-z][a-zA-Z0-9]*$/.test(e.id)) throw Error(`defineReviewWorkflow('${e.id}'): the id must be camelCase letters and digits.`);
+	if (!Number.isInteger(e.version) || e.version < 1) throw Error(`defineReviewWorkflow('${e.id}'): version is a whole number from 1.`);
+	if (e.steps.length === 0) throw Error(`defineReviewWorkflow('${e.id}'): name at least one step.`);
+	let t = /* @__PURE__ */ new Set();
+	for (let n of e.steps) {
+		if (!/^[a-z][a-zA-Z0-9]*$/.test(n.id) || t.has(n.id)) throw Error(`defineReviewWorkflow('${e.id}'): step '${n.id}' must be a unique camelCase id.`);
+		t.add(n.id);
+	}
+	for (let n of e.steps) for (let r of n.after ?? []) if (!t.has(r)) throw Error(`defineReviewWorkflow('${e.id}'): step '${n.id}' waits for unknown step '${r}'.`);
+	let n = new Map(e.steps.map((e) => [e.id, e.after ?? []])), r = /* @__PURE__ */ new Set(), i = /* @__PURE__ */ new Set(), a = (t) => {
+		if (!i.has(t)) {
+			if (r.has(t)) throw Error(`defineReviewWorkflow('${e.id}'): steps wait for each other in a cycle at '${t}'.`);
+			r.add(t);
+			for (let e of n.get(t) ?? []) a(e);
+			r.delete(t), i.add(t);
+		}
+	};
+	for (let t of e.steps) a(t.id);
+	return e;
+}, p = o(u, {
+	id: i({ prefix: "cwfi" }),
+	contentType: s().maxLength(64),
+	variantId: s().maxLength(64),
+	documentId: s().maxLength(64),
+	site: s().maxLength(64),
+	environment: s().maxLength(64),
+	locale: s().maxLength(64),
+	revisionId: s().maxLength(64),
+	workflowId: s().maxLength(64),
+	workflowVersion: s().maxLength(16),
+	steps: a(),
+	status: s().oneOf([
+		"open",
+		"approved",
+		"changesRequested",
+		"superseded"
+	]),
+	requestedBy: s().maxLength(64),
+	requestedAt: c(),
+	closedAt: c().nullable()
+}).with(l()).index("cms_workflow_instances_by_variant", ["contentType", "variantId"]), m = o(d, {
+	id: i({ prefix: "cwfd" }),
+	instanceId: s().maxLength(64),
+	stepId: s().maxLength(64),
+	action: s().oneOf([
+		"approved",
+		"changesRequested",
+		"delegated",
+		"suggested"
+	]),
+	actorId: s().maxLength(64),
+	delegateTo: s().maxLength(64).nullable(),
+	candidateId: s().maxLength(64).nullable(),
+	evidence: s().nullable(),
+	note: s().nullable(),
+	decidedAt: c()
+}).with(l()).index("cms_workflow_decisions_by_instance", ["instanceId"]), h = (e) => e instanceof Date ? e : new Date(String(e)), g = (e) => typeof e == "string" && e !== "" ? e : null, _ = (e) => [
+	r("site", e.site),
+	r("environment", e.environment),
+	r("locale", e.locale)
+], v = async (e, i, a, o, s, c, l = /* @__PURE__ */ new Date()) => {
+	let [d] = await e.query({
+		table: `${i.name}_drafts`,
+		predicate: n(r("id", o), ..._(s)),
+		order: [],
+		take: 1,
+		skip: void 0,
+		projection: void 0
+	});
+	if (d === void 0) throw new t({
+		contentType: i.name,
+		id: o,
+		stage: "draft"
+	});
+	await e.updateMany(u, {
+		status: "superseded",
+		closedAt: l
+	}, { where: n(r("contentType", i.name), r("variantId", o), r("status", "open")) });
+	let f = a.steps.map((e) => ({
+		id: e.id,
+		label: e.label,
+		approverScope: e.approverScope,
+		after: [...e.after ?? []],
+		applies: e.when === void 0 || e.when(d),
+		slaHours: e.slaHours ?? null,
+		evidence: e.evidence === !0
+	})), p = await e.insert(u, {
+		contentType: i.name,
+		variantId: o,
+		documentId: d.documentId,
+		...s,
+		revisionId: String(d.revisionId),
+		workflowId: a.id,
+		workflowVersion: String(a.version),
+		steps: f,
+		status: "open",
+		requestedBy: c.actorId,
+		requestedAt: l,
+		closedAt: null,
+		...d.tenantId !== void 0 && d.tenantId !== null ? { tenantId: d.tenantId } : {}
+	});
+	return {
+		id: String(p.id),
+		revisionId: String(d.revisionId)
+	};
+}, y = (e, t, n) => {
+	let r = t.map((e) => ({
+		stepId: String(e.stepId),
+		action: String(e.action),
+		actorId: String(e.actorId),
+		delegateTo: g(e.delegateTo),
+		candidateId: g(e.candidateId),
+		evidence: g(e.evidence),
+		note: g(e.note),
+		decidedAt: h(e.decidedAt)
+	})).sort((e, t) => e.decidedAt.getTime() - t.decidedAt.getTime()), i = e.steps ?? [], a = h(e.requestedAt), o = /* @__PURE__ */ new Map();
+	for (let e of r) e.action === "approved" && o.set(e.stepId, e.decidedAt);
+	let s = new Map(i.map((e) => [e.id, e.applies])), c = (e) => s.get(e) === !1 ? a : o.get(e) ?? null, l = i.map((e) => {
+		let t = r.filter((t) => t.stepId === e.id), i = [...t].reverse().find((e) => e.action === "approved" || e.action === "changesRequested"), o = [...t].reverse().find((e) => e.action === "delegated"), s = e.after.map(c), l = s.some((e) => e === null) ? null : new Date(Math.max(a.getTime(), ...s.map((e) => e.getTime()))), u = e.applies ? i?.action === "approved" ? "approved" : i?.action === "changesRequested" ? "changesRequested" : l === null ? "waiting" : "open" : "notApplicable", d = l !== null && e.slaHours !== null ? new Date(l.getTime() + e.slaHours * 36e5) : null;
+		return {
+			...e,
+			status: u,
+			openedAt: l,
+			dueAt: d,
+			overdue: u === "open" && d !== null && n.getTime() > d.getTime(),
+			delegateTo: o?.delegateTo ?? null,
+			decidedBy: i?.actorId ?? null,
+			evidenceGiven: i?.action === "approved" ? i.evidence : null
+		};
+	});
+	return {
+		id: String(e.id),
+		contentType: String(e.contentType),
+		variantId: String(e.variantId),
+		revisionId: String(e.revisionId),
+		workflowId: String(e.workflowId),
+		workflowVersion: Number(e.workflowVersion),
+		status: e.status,
+		requestedBy: String(e.requestedBy),
+		requestedAt: a,
+		steps: l,
+		decisions: r
+	};
+}, b = async (e, t) => (await e.query({
+	table: u,
+	predicate: r("id", t),
+	order: [],
+	take: 1,
+	skip: void 0,
+	projection: void 0
+}))[0], x = (e, t) => e.query({
+	table: d,
+	predicate: r("instanceId", t),
+	order: [],
+	take: void 0,
+	skip: void 0,
+	projection: void 0
+}), S = async (e, t, n = /* @__PURE__ */ new Date()) => {
+	let r = await b(e, t);
+	return r === void 0 ? null : y(r, await x(e, t), n);
+}, C = async (e, t, i, a = /* @__PURE__ */ new Date()) => {
+	let o = await e.query({
+		table: u,
+		predicate: n(r("contentType", t.name), r("variantId", i)),
+		order: [{
+			column: "requestedAt",
+			direction: "desc"
+		}],
+		take: 1,
+		skip: void 0,
+		projection: void 0
+	});
+	return o[0] === void 0 ? null : y(o[0], await x(e, String(o[0].id)), a);
+}, w = async (e, t, n, i, a) => {
+	let o = await b(e, t);
+	if (o === void 0) return {
+		ok: !1,
+		reason: "notFound"
+	};
+	let s = y(o, await x(e, t), a);
+	if (s.status !== "open") return {
+		ok: !1,
+		reason: "closed"
+	};
+	let [c] = await e.query({
+		table: `${s.contentType}_drafts`,
+		predicate: r("id", s.variantId),
+		order: [],
+		take: 1,
+		skip: void 0,
+		projection: ["revisionId"]
+	});
+	if (c === void 0) return {
+		ok: !1,
+		reason: "notFound"
+	};
+	if (c.revisionId !== s.revisionId) return {
+		ok: !1,
+		reason: "revisionMoved"
+	};
+	let l = s.steps.find((e) => e.id === n);
+	return l === void 0 ? {
+		ok: !1,
+		reason: "unknownStep"
+	} : l.status === "notApplicable" ? {
+		ok: !1,
+		reason: "notApplicable"
+	} : l.status === "waiting" ? {
+		ok: !1,
+		reason: "waiting"
+	} : l.status === "open" ? i.actorId === s.requestedBy ? {
+		ok: !1,
+		reason: "selfApproval"
+	} : (l.delegateTo === null ? i.scopes.has(l.approverScope) : l.delegateTo === i.actorId) ? {
+		ok: !0,
+		instance: s,
+		step: l
+	} : {
+		ok: !1,
+		reason: "notAllowed"
+	} : {
+		ok: !1,
+		reason: "decided"
+	};
+}, T = async (e, t, n, r, i, a = /* @__PURE__ */ new Date()) => {
+	let o = await w(e, t, n, r, a);
+	if (!o.ok) return o;
+	let s = i.evidence?.trim() ?? "", c = i.note?.trim() ?? "";
+	if (i.action === "approve" && o.step.evidence && s === "") return {
+		ok: !1,
+		reason: "noEvidence"
+	};
+	if (i.action === "requestChanges" && c === "") return {
+		ok: !1,
+		reason: "noNote"
+	};
+	await e.insert(d, {
+		instanceId: t,
+		stepId: n,
+		action: i.action === "approve" ? "approved" : "changesRequested",
+		actorId: r.actorId,
+		delegateTo: null,
+		candidateId: null,
+		evidence: s === "" ? null : s.slice(0, 1e3),
+		note: c === "" ? null : c.slice(0, 1e3),
+		decidedAt: a,
+		...E(await b(e, t))
+	});
+	let l = y(await b(e, t), await x(e, t), a), f = l.steps.some((e) => e.status === "changesRequested") ? "changesRequested" : l.steps.every((e) => e.status === "approved" || e.status === "notApplicable") ? "approved" : "open";
+	return f !== "open" && await e.update(u, t, {
+		status: f,
+		closedAt: a
+	}), {
+		ok: !0,
+		instanceStatus: f
+	};
+}, E = (e) => e?.tenantId !== void 0 && e.tenantId !== null ? { tenantId: e.tenantId } : {}, D = async (e, t, n, r, i, a = /* @__PURE__ */ new Date()) => {
+	let o = await w(e, t, n, r, a);
+	return o.ok ? i === r.actorId || i === o.instance.requestedBy ? {
+		ok: !1,
+		reason: "selfDelegation"
+	} : (await e.insert(d, {
+		instanceId: t,
+		stepId: n,
+		action: "delegated",
+		actorId: r.actorId,
+		delegateTo: i,
+		candidateId: null,
+		evidence: null,
+		note: null,
+		decidedAt: a,
+		...E(await b(e, t))
+	}), { ok: !0 }) : o;
+}, O = async (e, t, n, r, i, a = /* @__PURE__ */ new Date()) => {
+	let o = await w(e, t, n, r, a);
+	if (!o.ok) return o;
+	let s = i.note?.trim() ?? "";
+	return await e.insert(d, {
+		instanceId: t,
+		stepId: n,
+		action: "suggested",
+		actorId: r.actorId,
+		delegateTo: null,
+		candidateId: i.candidateId,
+		evidence: null,
+		note: s === "" ? null : s.slice(0, 1e3),
+		decidedAt: a,
+		...E(await b(e, t))
+	}), { ok: !0 };
+}, k = async (e, t, n) => {
+	let i = await e.query({
+		table: u,
+		predicate: r("status", "open"),
+		order: [],
+		take: 500,
+		skip: void 0,
+		projection: void 0
+	}), a = [];
+	for (let r of i) {
+		let i = y(r, await x(e, String(r.id)), n);
+		for (let e of i.steps) e.status === "open" && e.dueAt !== null && e.dueAt.getTime() > t.getTime() && e.dueAt.getTime() <= n.getTime() && a.push({
+			instance: i,
+			step: e
+		});
+	}
+	return a;
+}, A = async (e, t, i, a) => (await e.query({
+	table: u,
+	predicate: n(r("contentType", t.name), r("variantId", i), r("revisionId", a), r("status", "approved")),
+	order: [],
+	take: 1,
+	skip: void 0,
+	projection: ["id"]
+})).length > 0, j = (...n) => e(() => v(...n), t), M = (...t) => e(() => T(...t)), N = (...t) => e(() => D(...t)), P = (...t) => e(() => S(...t)), F = (...t) => e(() => C(...t)), I = (...t) => e(() => O(...t)), L = (...t) => e(() => k(...t)), R = (...t) => e(() => A(...t));
+//#endregion
+export { d as CMS_WORKFLOW_DECISIONS_TABLE, u as CMS_WORKFLOW_INSTANCES_TABLE, A as approvedByWorkflow, R as approvedByWorkflowEffect, m as cmsWorkflowDecisionsTable, p as cmsWorkflowInstancesTable, T as decideStep, M as decideStepEffect, f as defineReviewWorkflow, D as delegateStep, N as delegateStepEffect, C as latestWorkflow, F as latestWorkflowEffect, k as overdueSteps, L as overdueStepsEffect, v as startWorkflow, j as startWorkflowEffect, O as suggestOnStep, I as suggestOnStepEffect, S as workflowState, P as workflowStateEffect };