@lssm/example.workflow-system 0.0.0-canary-20251217060834 → 0.0.0-canary-20251217072406

package/dist/instance/instance.contracts.js

@@ -1 +1,334 @@
-import{InstanceStatusEnum as e}from"./instance.enum.js";import{StartWorkflowInputModel as t,TransitionInputModel as n,TransitionResultModel as r,WorkflowInstanceModel as i}from"./instance.schema.js";import{ScalarTypeEnum as a,defineSchemaModel as o}from"@lssm/lib.schema";import{defineCommand as s,defineQuery as c}from"@lssm/lib.contracts/spec";const l=[`@example.workflow-system`],u=s({meta:{name:`workflow.instance.start`,version:1,stability:`stable`,owners:[...l],tags:[`workflow`,`instance`,`start`],description:`Start a new workflow instance.`,goal:`Initiate a workflow for a business process.`,context:`Order creation, request submission, etc.`},io:{input:t,output:i},policy:{auth:`user`},sideEffects:{emits:[{name:`workflow.instance.started`,version:1,when:`Workflow starts`,payload:i},{name:`workflow.step.entered`,version:1,when:`First step entered`,payload:i}],audit:[`workflow.instance.started`]}}),d=s({meta:{name:`workflow.instance.transition`,version:1,stability:`stable`,owners:[...l],tags:[`workflow`,`instance`,`transition`,`state-machine`],description:`Transition a workflow instance to the next step.`,goal:`Move workflow forward based on action.`,context:`Task completion, approval decisions.`},io:{input:n,output:r},policy:{auth:`user`},sideEffects:{emits:[{name:`workflow.step.exited`,version:1,when:`Step is exited`,payload:i},{name:`workflow.step.entered`,version:1,when:`New step is entered`,payload:i},{name:`workflow.instance.completed`,version:1,when:`Workflow reaches end`,payload:i}],audit:[`workflow.instance.transitioned`]}}),f=s({meta:{name:`workflow.instance.pause`,version:1,stability:`stable`,owners:[...l],tags:[`workflow`,`instance`,`pause`],description:`Pause a running workflow instance.`,goal:`Temporarily halt workflow execution.`,context:`Administrative action, emergency stop.`},io:{input:o({name:`PauseResumeInput`,fields:{instanceId:{type:a.String_unsecure(),isOptional:!1},reason:{type:a.String_unsecure(),isOptional:!0}}}),output:i},policy:{auth:`user`},sideEffects:{emits:[{name:`workflow.instance.paused`,version:1,when:`Workflow is paused`,payload:i}],audit:[`workflow.instance.paused`]}}),p=s({meta:{name:`workflow.instance.resume`,version:1,stability:`stable`,owners:[...l],tags:[`workflow`,`instance`,`resume`],description:`Resume a paused workflow instance.`,goal:`Continue workflow execution.`,context:`Administrative action.`},io:{input:o({name:`PauseResumeInput`,fields:{instanceId:{type:a.String_unsecure(),isOptional:!1},reason:{type:a.String_unsecure(),isOptional:!0}}}),output:i},policy:{auth:`user`},sideEffects:{emits:[{name:`workflow.instance.resumed`,version:1,when:`Workflow is resumed`,payload:i}],audit:[`workflow.instance.resumed`]}}),m=s({meta:{name:`workflow.instance.cancel`,version:1,stability:`stable`,owners:[...l],tags:[`workflow`,`instance`,`cancel`],description:`Cancel a workflow instance.`,goal:`Terminate workflow without completion.`,context:`User request, system cancellation.`},io:{input:o({name:`CancelWorkflowInput`,fields:{instanceId:{type:a.String_unsecure(),isOptional:!1},reason:{type:a.String_unsecure(),isOptional:!1}}}),output:i},policy:{auth:`user`},sideEffects:{emits:[{name:`workflow.instance.cancelled`,version:1,when:`Workflow is cancelled`,payload:i}],audit:[`workflow.instance.cancelled`]}}),h=c({meta:{name:`workflow.instance.list`,version:1,stability:`stable`,owners:[...l],tags:[`workflow`,`instance`,`list`],description:`List workflow instances with filtering.`,goal:`Browse and search running workflows.`,context:`Dashboard, monitoring.`},io:{input:o({name:`ListInstancesInput`,fields:{workflowKey:{type:a.String_unsecure(),isOptional:!0},status:{type:e,isOptional:!0},referenceType:{type:a.String_unsecure(),isOptional:!0},referenceId:{type:a.String_unsecure(),isOptional:!0},triggeredBy:{type:a.String_unsecure(),isOptional:!0},limit:{type:a.Int_unsecure(),isOptional:!0,defaultValue:20},offset:{type:a.Int_unsecure(),isOptional:!0,defaultValue:0}}}),output:o({name:`ListInstancesOutput`,fields:{instances:{type:i,isArray:!0,isOptional:!1},total:{type:a.Int_unsecure(),isOptional:!1}}})},policy:{auth:`user`}}),g=c({meta:{name:`workflow.instance.get`,version:1,stability:`stable`,owners:[...l],tags:[`workflow`,`instance`,`get`],description:`Get a workflow instance with details.`,goal:`View workflow instance details.`,context:`Instance detail view.`},io:{input:o({name:`GetInstanceInput`,fields:{instanceId:{type:a.String_unsecure(),isOptional:!1}}}),output:i},policy:{auth:`user`}});export{m as CancelWorkflowContract,g as GetInstanceContract,h as ListInstancesContract,f as PauseWorkflowContract,p as ResumeWorkflowContract,u as StartWorkflowContract,d as TransitionWorkflowContract};
+import { ScalarTypeEnum } from "../libs/schema/dist/ScalarTypeEnum.js";
+import { defineSchemaModel } from "../libs/schema/dist/SchemaModel.js";
+import "../libs/schema/dist/index.js";
+import { defineCommand, defineQuery } from "../libs/contracts/dist/spec.js";
+import { InstanceStatusEnum } from "./instance.enum.js";
+import { StartWorkflowInputModel, TransitionInputModel, TransitionResultModel, WorkflowInstanceModel } from "./instance.schema.js";
+
+//#region src/instance/instance.contracts.ts
+const OWNERS = ["@example.workflow-system"];
+/**
+* Start a new workflow instance.
+*/
+const StartWorkflowContract = defineCommand({
+	meta: {
+		name: "workflow.instance.start",
+		version: 1,
+		stability: "stable",
+		owners: [...OWNERS],
+		tags: [
+			"workflow",
+			"instance",
+			"start"
+		],
+		description: "Start a new workflow instance.",
+		goal: "Initiate a workflow for a business process.",
+		context: "Order creation, request submission, etc."
+	},
+	io: {
+		input: StartWorkflowInputModel,
+		output: WorkflowInstanceModel
+	},
+	policy: { auth: "user" },
+	sideEffects: {
+		emits: [{
+			name: "workflow.instance.started",
+			version: 1,
+			when: "Workflow starts",
+			payload: WorkflowInstanceModel
+		}, {
+			name: "workflow.step.entered",
+			version: 1,
+			when: "First step entered",
+			payload: WorkflowInstanceModel
+		}],
+		audit: ["workflow.instance.started"]
+	}
+});
+/**
+* Transition workflow to next step.
+*/
+const TransitionWorkflowContract = defineCommand({
+	meta: {
+		name: "workflow.instance.transition",
+		version: 1,
+		stability: "stable",
+		owners: [...OWNERS],
+		tags: [
+			"workflow",
+			"instance",
+			"transition",
+			"state-machine"
+		],
+		description: "Transition a workflow instance to the next step.",
+		goal: "Move workflow forward based on action.",
+		context: "Task completion, approval decisions."
+	},
+	io: {
+		input: TransitionInputModel,
+		output: TransitionResultModel
+	},
+	policy: { auth: "user" },
+	sideEffects: {
+		emits: [
+			{
+				name: "workflow.step.exited",
+				version: 1,
+				when: "Step is exited",
+				payload: WorkflowInstanceModel
+			},
+			{
+				name: "workflow.step.entered",
+				version: 1,
+				when: "New step is entered",
+				payload: WorkflowInstanceModel
+			},
+			{
+				name: "workflow.instance.completed",
+				version: 1,
+				when: "Workflow reaches end",
+				payload: WorkflowInstanceModel
+			}
+		],
+		audit: ["workflow.instance.transitioned"]
+	}
+});
+/**
+* Pause a running workflow.
+*/
+const PauseWorkflowContract = defineCommand({
+	meta: {
+		name: "workflow.instance.pause",
+		version: 1,
+		stability: "stable",
+		owners: [...OWNERS],
+		tags: [
+			"workflow",
+			"instance",
+			"pause"
+		],
+		description: "Pause a running workflow instance.",
+		goal: "Temporarily halt workflow execution.",
+		context: "Administrative action, emergency stop."
+	},
+	io: {
+		input: defineSchemaModel({
+			name: "PauseResumeInput",
+			fields: {
+				instanceId: {
+					type: ScalarTypeEnum.String_unsecure(),
+					isOptional: false
+				},
+				reason: {
+					type: ScalarTypeEnum.String_unsecure(),
+					isOptional: true
+				}
+			}
+		}),
+		output: WorkflowInstanceModel
+	},
+	policy: { auth: "user" },
+	sideEffects: {
+		emits: [{
+			name: "workflow.instance.paused",
+			version: 1,
+			when: "Workflow is paused",
+			payload: WorkflowInstanceModel
+		}],
+		audit: ["workflow.instance.paused"]
+	}
+});
+/**
+* Resume a paused workflow.
+*/
+const ResumeWorkflowContract = defineCommand({
+	meta: {
+		name: "workflow.instance.resume",
+		version: 1,
+		stability: "stable",
+		owners: [...OWNERS],
+		tags: [
+			"workflow",
+			"instance",
+			"resume"
+		],
+		description: "Resume a paused workflow instance.",
+		goal: "Continue workflow execution.",
+		context: "Administrative action."
+	},
+	io: {
+		input: defineSchemaModel({
+			name: "PauseResumeInput",
+			fields: {
+				instanceId: {
+					type: ScalarTypeEnum.String_unsecure(),
+					isOptional: false
+				},
+				reason: {
+					type: ScalarTypeEnum.String_unsecure(),
+					isOptional: true
+				}
+			}
+		}),
+		output: WorkflowInstanceModel
+	},
+	policy: { auth: "user" },
+	sideEffects: {
+		emits: [{
+			name: "workflow.instance.resumed",
+			version: 1,
+			when: "Workflow is resumed",
+			payload: WorkflowInstanceModel
+		}],
+		audit: ["workflow.instance.resumed"]
+	}
+});
+/**
+* Cancel a workflow instance.
+*/
+const CancelWorkflowContract = defineCommand({
+	meta: {
+		name: "workflow.instance.cancel",
+		version: 1,
+		stability: "stable",
+		owners: [...OWNERS],
+		tags: [
+			"workflow",
+			"instance",
+			"cancel"
+		],
+		description: "Cancel a workflow instance.",
+		goal: "Terminate workflow without completion.",
+		context: "User request, system cancellation."
+	},
+	io: {
+		input: defineSchemaModel({
+			name: "CancelWorkflowInput",
+			fields: {
+				instanceId: {
+					type: ScalarTypeEnum.String_unsecure(),
+					isOptional: false
+				},
+				reason: {
+					type: ScalarTypeEnum.String_unsecure(),
+					isOptional: false
+				}
+			}
+		}),
+		output: WorkflowInstanceModel
+	},
+	policy: { auth: "user" },
+	sideEffects: {
+		emits: [{
+			name: "workflow.instance.cancelled",
+			version: 1,
+			when: "Workflow is cancelled",
+			payload: WorkflowInstanceModel
+		}],
+		audit: ["workflow.instance.cancelled"]
+	}
+});
+/**
+* List workflow instances.
+*/
+const ListInstancesContract = defineQuery({
+	meta: {
+		name: "workflow.instance.list",
+		version: 1,
+		stability: "stable",
+		owners: [...OWNERS],
+		tags: [
+			"workflow",
+			"instance",
+			"list"
+		],
+		description: "List workflow instances with filtering.",
+		goal: "Browse and search running workflows.",
+		context: "Dashboard, monitoring."
+	},
+	io: {
+		input: defineSchemaModel({
+			name: "ListInstancesInput",
+			fields: {
+				workflowKey: {
+					type: ScalarTypeEnum.String_unsecure(),
+					isOptional: true
+				},
+				status: {
+					type: InstanceStatusEnum,
+					isOptional: true
+				},
+				referenceType: {
+					type: ScalarTypeEnum.String_unsecure(),
+					isOptional: true
+				},
+				referenceId: {
+					type: ScalarTypeEnum.String_unsecure(),
+					isOptional: true
+				},
+				triggeredBy: {
+					type: ScalarTypeEnum.String_unsecure(),
+					isOptional: true
+				},
+				limit: {
+					type: ScalarTypeEnum.Int_unsecure(),
+					isOptional: true,
+					defaultValue: 20
+				},
+				offset: {
+					type: ScalarTypeEnum.Int_unsecure(),
+					isOptional: true,
+					defaultValue: 0
+				}
+			}
+		}),
+		output: defineSchemaModel({
+			name: "ListInstancesOutput",
+			fields: {
+				instances: {
+					type: WorkflowInstanceModel,
+					isArray: true,
+					isOptional: false
+				},
+				total: {
+					type: ScalarTypeEnum.Int_unsecure(),
+					isOptional: false
+				}
+			}
+		})
+	},
+	policy: { auth: "user" }
+});
+/**
+* Get a single workflow instance.
+*/
+const GetInstanceContract = defineQuery({
+	meta: {
+		name: "workflow.instance.get",
+		version: 1,
+		stability: "stable",
+		owners: [...OWNERS],
+		tags: [
+			"workflow",
+			"instance",
+			"get"
+		],
+		description: "Get a workflow instance with details.",
+		goal: "View workflow instance details.",
+		context: "Instance detail view."
+	},
+	io: {
+		input: defineSchemaModel({
+			name: "GetInstanceInput",
+			fields: { instanceId: {
+				type: ScalarTypeEnum.String_unsecure(),
+				isOptional: false
+			} }
+		}),
+		output: WorkflowInstanceModel
+	},
+	policy: { auth: "user" }
+});
+
+//#endregion
+export { CancelWorkflowContract, GetInstanceContract, ListInstancesContract, PauseWorkflowContract, ResumeWorkflowContract, StartWorkflowContract, TransitionWorkflowContract };

package/dist/instance/instance.enum.d.ts

@@ -1,9 +1,9 @@
-import * as _lssm_lib_schema315 from "@lssm/lib.schema";
+import * as _lssm_lib_schema508 from "@lssm/lib.schema";
 
 //#region src/instance/instance.enum.d.ts
 /**
  * Instance status enum.
  */
-declare const InstanceStatusEnum: _lssm_lib_schema315.EnumType<[string, string, string, string, string, string, string, string]>;
+declare const InstanceStatusEnum: _lssm_lib_schema508.EnumType<[string, string, string, string, string, string, string, string]>;
 //#endregion
 export { InstanceStatusEnum };

package/dist/instance/instance.enum.js

@@ -1 +1,20 @@
-import{defineEnum as e}from"@lssm/lib.schema";const t=e(`InstanceStatus`,[`PENDING`,`RUNNING`,`WAITING`,`PAUSED`,`COMPLETED`,`CANCELLED`,`FAILED`,`TIMEOUT`]);export{t as InstanceStatusEnum};
+import { defineEnum } from "../libs/schema/dist/EnumType.js";
+import "../libs/schema/dist/index.js";
+
+//#region src/instance/instance.enum.ts
+/**
+* Instance status enum.
+*/
+const InstanceStatusEnum = defineEnum("InstanceStatus", [
+	"PENDING",
+	"RUNNING",
+	"WAITING",
+	"PAUSED",
+	"COMPLETED",
+	"CANCELLED",
+	"FAILED",
+	"TIMEOUT"
+]);
+
+//#endregion
+export { InstanceStatusEnum };