@contractspec/example.workflow-system 1.57.0 → 1.58.0

package/dist/docs/workflow-system.docblock.js

@@ -1,21 +1,16 @@
+// @bun
+// src/docs/workflow-system.docblock.ts
 import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
-
-//#region src/docs/workflow-system.docblock.ts
-registerDocBlocks([
-	{
-		id: "docs.examples.workflow-system",
-		title: "Workflow / Approval System",
-		summary: "Reference app showing state-machine driven approvals with RBAC, audit trail, notifications, and jobs.",
-		kind: "reference",
-		visibility: "public",
-		route: "/docs/examples/workflow-system",
-		tags: [
-			"workflow",
-			"approval",
-			"state-machine",
-			"rbac"
-		],
-		body: `## Entities
+var workflowSystemDocBlocks = [
+  {
+    id: "docs.examples.workflow-system",
+    title: "Workflow / Approval System",
+    summary: "Reference app showing state-machine driven approvals with RBAC, audit trail, notifications, and jobs.",
+    kind: "reference",
+    visibility: "public",
+    route: "/docs/examples/workflow-system",
+    tags: ["workflow", "approval", "state-machine", "rbac"],
+    body: `## Entities
 
 - WorkflowDefinition, WorkflowStep, WorkflowInstance, Approval.
 - State machine expressed in \`src/state-machine\` with allowed transitions and role gates.
@@ -40,16 +35,16 @@ registerDocBlocks([
 - Keep transitions declarative to enable safe regeneration; role guards live in spec.
 - Use Notification Center for approval requests and outcomes; attach files via Files module if needed.
 `
-	},
-	{
-		id: "docs.examples.workflow-system.goal",
-		title: "Workflow System — Goal",
-		summary: "Why the workflow/approval template exists and outcomes it targets.",
-		kind: "goal",
-		visibility: "public",
-		route: "/docs/examples/workflow-system/goal",
-		tags: ["workflow", "goal"],
-		body: `## Why it matters
+  },
+  {
+    id: "docs.examples.workflow-system.goal",
+    title: "Workflow System \u2014 Goal",
+    summary: "Why the workflow/approval template exists and outcomes it targets.",
+    kind: "goal",
+    visibility: "public",
+    route: "/docs/examples/workflow-system/goal",
+    tags: ["workflow", "goal"],
+    body: `## Why it matters
 - Provides a regenerable, role-gated approval engine using declarative state machines.
 - Keeps workflow rules consistent across UI/API/events with auditability.
 
@@ -60,16 +55,16 @@ registerDocBlocks([
 ## Success criteria
 - State changes are declarative and regenerate cleanly.
 - Every transition emits auditable events and respects RBAC guards.`
-	},
-	{
-		id: "docs.examples.workflow-system.usage",
-		title: "Workflow System — Usage",
-		summary: "How to configure workflows, transitions, and regenerate safely.",
-		kind: "usage",
-		visibility: "public",
-		route: "/docs/examples/workflow-system/usage",
-		tags: ["workflow", "usage"],
-		body: `## Setup
+  },
+  {
+    id: "docs.examples.workflow-system.usage",
+    title: "Workflow System \u2014 Usage",
+    summary: "How to configure workflows, transitions, and regenerate safely.",
+    kind: "usage",
+    visibility: "public",
+    route: "/docs/examples/workflow-system/usage",
+    tags: ["workflow", "usage"],
+    body: `## Setup
 1) Define WorkflowDefinition steps and allowed transitions with role gates in spec.
 2) Seed sample workflows/instances (if provided) or create via UI; enable reminders via Jobs.
 
@@ -82,20 +77,16 @@ registerDocBlocks([
 - Emit events for every transition; log to Audit Trail.
 - Use Notifications for approvals/rejections; schedule reminders for pending steps.
 - Keep transitions declarative; avoid imperative branching in handlers.`
-	},
-	{
-		id: "docs.examples.workflow-system.constraints",
-		title: "Workflow System — Constraints & Safety",
-		summary: "Internal guardrails for state machines, RBAC, and regeneration semantics.",
-		kind: "reference",
-		visibility: "internal",
-		route: "/docs/examples/workflow-system/constraints",
-		tags: [
-			"workflow",
-			"constraints",
-			"internal"
-		],
-		body: `## Constraints
+  },
+  {
+    id: "docs.examples.workflow-system.constraints",
+    title: "Workflow System \u2014 Constraints & Safety",
+    summary: "Internal guardrails for state machines, RBAC, and regeneration semantics.",
+    kind: "reference",
+    visibility: "internal",
+    route: "/docs/examples/workflow-system/constraints",
+    tags: ["workflow", "constraints", "internal"],
+    body: `## Constraints
 - State machine (steps/transitions) must stay declarative in spec; no hidden code paths.
 - Events to emit: instance.started, step.completed/rejected, instance.finished.
 - Regeneration must not change approval logic without explicit spec diff.
@@ -108,8 +99,6 @@ registerDocBlocks([
 - Add fixtures for transition changes and role gates.
 - Validate reminders (Jobs) stay aligned with pending states after regeneration.
 - Use Feature Flags for new transitions/escalation rules; default safe/off.`
-	}
-]);
-
-//#endregion
-//# sourceMappingURL=workflow-system.docblock.js.map
+  }
+];
+registerDocBlocks(workflowSystemDocBlocks);

package/dist/entities/approval.d.ts

@@ -1,58 +1,53 @@
-import * as _contractspec_lib_schema0 from "@contractspec/lib.schema";
-
-//#region src/entities/approval.d.ts
 /**
  * Approval status enum.
  */
-declare const ApprovalStatusEnum: _contractspec_lib_schema0.EntityEnumDef;
+export declare const ApprovalStatusEnum: import("@contractspec/lib.schema").EntityEnumDef;
 /**
  * Approval decision enum.
  */
-declare const ApprovalDecisionEnum: _contractspec_lib_schema0.EntityEnumDef;
+export declare const ApprovalDecisionEnum: import("@contractspec/lib.schema").EntityEnumDef;
 /**
  * ApprovalRequest entity - a request for approval from a user.
  *
  * Created when a workflow reaches an APPROVAL step. Multiple requests
  * may be created depending on the approval mode.
  */
-declare const ApprovalRequestEntity: _contractspec_lib_schema0.EntitySpec<{
-  id: _contractspec_lib_schema0.EntityScalarField;
-  workflowInstanceId: _contractspec_lib_schema0.EntityScalarField;
-  stepExecutionId: _contractspec_lib_schema0.EntityScalarField;
-  approverId: _contractspec_lib_schema0.EntityScalarField;
-  approverRole: _contractspec_lib_schema0.EntityScalarField;
-  title: _contractspec_lib_schema0.EntityScalarField;
-  description: _contractspec_lib_schema0.EntityScalarField;
-  status: _contractspec_lib_schema0.EntityEnumField;
-  decision: _contractspec_lib_schema0.EntityEnumField;
-  decisionComment: _contractspec_lib_schema0.EntityScalarField;
-  decidedAt: _contractspec_lib_schema0.EntityScalarField;
-  delegatedTo: _contractspec_lib_schema0.EntityScalarField;
-  delegationReason: _contractspec_lib_schema0.EntityScalarField;
-  escalationLevel: _contractspec_lib_schema0.EntityScalarField;
-  escalatedAt: _contractspec_lib_schema0.EntityScalarField;
-  dueAt: _contractspec_lib_schema0.EntityScalarField;
-  reminderSentAt: _contractspec_lib_schema0.EntityScalarField;
-  contextSnapshot: _contractspec_lib_schema0.EntityScalarField;
-  sequenceOrder: _contractspec_lib_schema0.EntityScalarField;
-  createdAt: _contractspec_lib_schema0.EntityScalarField;
-  updatedAt: _contractspec_lib_schema0.EntityScalarField;
-  workflowInstance: _contractspec_lib_schema0.EntityRelationField;
-  stepExecution: _contractspec_lib_schema0.EntityRelationField;
+export declare const ApprovalRequestEntity: import("@contractspec/lib.schema").EntitySpec<{
+    id: import("@contractspec/lib.schema").EntityScalarField;
+    workflowInstanceId: import("@contractspec/lib.schema").EntityScalarField;
+    stepExecutionId: import("@contractspec/lib.schema").EntityScalarField;
+    approverId: import("@contractspec/lib.schema").EntityScalarField;
+    approverRole: import("@contractspec/lib.schema").EntityScalarField;
+    title: import("@contractspec/lib.schema").EntityScalarField;
+    description: import("@contractspec/lib.schema").EntityScalarField;
+    status: import("@contractspec/lib.schema").EntityEnumField;
+    decision: import("@contractspec/lib.schema").EntityEnumField;
+    decisionComment: import("@contractspec/lib.schema").EntityScalarField;
+    decidedAt: import("@contractspec/lib.schema").EntityScalarField;
+    delegatedTo: import("@contractspec/lib.schema").EntityScalarField;
+    delegationReason: import("@contractspec/lib.schema").EntityScalarField;
+    escalationLevel: import("@contractspec/lib.schema").EntityScalarField;
+    escalatedAt: import("@contractspec/lib.schema").EntityScalarField;
+    dueAt: import("@contractspec/lib.schema").EntityScalarField;
+    reminderSentAt: import("@contractspec/lib.schema").EntityScalarField;
+    contextSnapshot: import("@contractspec/lib.schema").EntityScalarField;
+    sequenceOrder: import("@contractspec/lib.schema").EntityScalarField;
+    createdAt: import("@contractspec/lib.schema").EntityScalarField;
+    updatedAt: import("@contractspec/lib.schema").EntityScalarField;
+    workflowInstance: import("@contractspec/lib.schema").EntityRelationField;
+    stepExecution: import("@contractspec/lib.schema").EntityRelationField;
 }>;
 /**
  * ApprovalComment entity - comments on approval requests.
  */
-declare const ApprovalCommentEntity: _contractspec_lib_schema0.EntitySpec<{
-  id: _contractspec_lib_schema0.EntityScalarField;
-  approvalRequestId: _contractspec_lib_schema0.EntityScalarField;
-  authorId: _contractspec_lib_schema0.EntityScalarField;
-  content: _contractspec_lib_schema0.EntityScalarField;
-  isInternal: _contractspec_lib_schema0.EntityScalarField;
-  createdAt: _contractspec_lib_schema0.EntityScalarField;
-  updatedAt: _contractspec_lib_schema0.EntityScalarField;
-  approvalRequest: _contractspec_lib_schema0.EntityRelationField;
+export declare const ApprovalCommentEntity: import("@contractspec/lib.schema").EntitySpec<{
+    id: import("@contractspec/lib.schema").EntityScalarField;
+    approvalRequestId: import("@contractspec/lib.schema").EntityScalarField;
+    authorId: import("@contractspec/lib.schema").EntityScalarField;
+    content: import("@contractspec/lib.schema").EntityScalarField;
+    isInternal: import("@contractspec/lib.schema").EntityScalarField;
+    createdAt: import("@contractspec/lib.schema").EntityScalarField;
+    updatedAt: import("@contractspec/lib.schema").EntityScalarField;
+    approvalRequest: import("@contractspec/lib.schema").EntityRelationField;
 }>;
-//#endregion
-export { ApprovalCommentEntity, ApprovalDecisionEnum, ApprovalRequestEntity, ApprovalStatusEnum };
 //# sourceMappingURL=approval.d.ts.map

package/dist/entities/approval.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"approval.d.ts","names":[],"sources":["../../src/entities/approval.ts"],"mappings":";;;;;;cAUa,kBAAA,EAaX,yBAAA,CAb6B,aAAA;;;;cAkBlB,oBAAA,EAWX,yBAAA,CAX+B,aAAA;AAAjC;;;;;AAmBA;AAnBA,cAmBa,qBAAA,4BAAqB,UAAA;MA4FhC,yBAAA,CAAA,iBAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;cAKW,qBAAA,4BAAqB,UAAA;MAmChC,yBAAA,CAAA,iBAAA"}
+{"version":3,"file":"approval.d.ts","sourceRoot":"","sources":["../../src/entities/approval.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,eAAO,MAAM,kBAAkB,kDAa7B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,oBAAoB,kDAW/B,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;EA4FhC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;EAmChC,CAAC"}

package/dist/entities/approval.js

@@ -1,128 +1,120 @@
-import { defineEntity, defineEntityEnum, field, index } from "@contractspec/lib.schema";
-
-//#region src/entities/approval.ts
-/**
-* Approval status enum.
-*/
-const ApprovalStatusEnum = defineEntityEnum({
-	name: "ApprovalStatus",
-	values: [
-		"PENDING",
-		"APPROVED",
-		"REJECTED",
-		"DELEGATED",
-		"ESCALATED",
-		"WITHDRAWN",
-		"EXPIRED"
-	],
-	schema: "workflow",
-	description: "Status of an approval request."
+// @bun
+// src/entities/approval.ts
+import {
+  defineEntity,
+  defineEntityEnum,
+  field,
+  index
+} from "@contractspec/lib.schema";
+var ApprovalStatusEnum = defineEntityEnum({
+  name: "ApprovalStatus",
+  values: [
+    "PENDING",
+    "APPROVED",
+    "REJECTED",
+    "DELEGATED",
+    "ESCALATED",
+    "WITHDRAWN",
+    "EXPIRED"
+  ],
+  schema: "workflow",
+  description: "Status of an approval request."
 });
-/**
-* Approval decision enum.
-*/
-const ApprovalDecisionEnum = defineEntityEnum({
-	name: "ApprovalDecision",
-	values: [
-		"APPROVE",
-		"REJECT",
-		"REQUEST_CHANGES",
-		"DELEGATE",
-		"ABSTAIN"
-	],
-	schema: "workflow",
-	description: "Possible approval decisions."
+var ApprovalDecisionEnum = defineEntityEnum({
+  name: "ApprovalDecision",
+  values: [
+    "APPROVE",
+    "REJECT",
+    "REQUEST_CHANGES",
+    "DELEGATE",
+    "ABSTAIN"
+  ],
+  schema: "workflow",
+  description: "Possible approval decisions."
 });
-/**
-* ApprovalRequest entity - a request for approval from a user.
-*
-* Created when a workflow reaches an APPROVAL step. Multiple requests
-* may be created depending on the approval mode.
-*/
-const ApprovalRequestEntity = defineEntity({
-	name: "ApprovalRequest",
-	description: "A pending approval request for a workflow step.",
-	schema: "workflow",
-	map: "approval_request",
-	fields: {
-		id: field.id({ description: "Unique approval request ID" }),
-		workflowInstanceId: field.foreignKey(),
-		stepExecutionId: field.foreignKey(),
-		approverId: field.foreignKey({ description: "User requested to approve" }),
-		approverRole: field.string({
-			isOptional: true,
-			description: "Role of the approver"
-		}),
-		title: field.string({ description: "Approval request title" }),
-		description: field.string({ isOptional: true }),
-		status: field.enum("ApprovalStatus", { default: "PENDING" }),
-		decision: field.enum("ApprovalDecision", { isOptional: true }),
-		decisionComment: field.string({
-			isOptional: true,
-			description: "Comment explaining decision"
-		}),
-		decidedAt: field.dateTime({ isOptional: true }),
-		delegatedTo: field.string({
-			isOptional: true,
-			description: "User delegated to"
-		}),
-		delegationReason: field.string({ isOptional: true }),
-		escalationLevel: field.int({
-			default: 0,
-			description: "Current escalation level"
-		}),
-		escalatedAt: field.dateTime({ isOptional: true }),
-		dueAt: field.dateTime({
-			isOptional: true,
-			description: "When approval is due"
-		}),
-		reminderSentAt: field.dateTime({ isOptional: true }),
-		contextSnapshot: field.json({
-			isOptional: true,
-			description: "Snapshot of relevant data for review"
-		}),
-		sequenceOrder: field.int({
-			default: 0,
-			description: "Order in approval chain"
-		}),
-		createdAt: field.createdAt(),
-		updatedAt: field.updatedAt(),
-		workflowInstance: field.belongsTo("WorkflowInstance", ["workflowInstanceId"], ["id"], { onDelete: "Cascade" }),
-		stepExecution: field.belongsTo("StepExecution", ["stepExecutionId"], ["id"])
-	},
-	indexes: [
-		index.on(["approverId", "status"]),
-		index.on(["workflowInstanceId", "status"]),
-		index.on(["stepExecutionId"]),
-		index.on(["status", "dueAt"]),
-		index.on(["createdAt"])
-	],
-	enums: [ApprovalStatusEnum, ApprovalDecisionEnum]
+var ApprovalRequestEntity = defineEntity({
+  name: "ApprovalRequest",
+  description: "A pending approval request for a workflow step.",
+  schema: "workflow",
+  map: "approval_request",
+  fields: {
+    id: field.id({ description: "Unique approval request ID" }),
+    workflowInstanceId: field.foreignKey(),
+    stepExecutionId: field.foreignKey(),
+    approverId: field.foreignKey({ description: "User requested to approve" }),
+    approverRole: field.string({
+      isOptional: true,
+      description: "Role of the approver"
+    }),
+    title: field.string({ description: "Approval request title" }),
+    description: field.string({ isOptional: true }),
+    status: field.enum("ApprovalStatus", { default: "PENDING" }),
+    decision: field.enum("ApprovalDecision", { isOptional: true }),
+    decisionComment: field.string({
+      isOptional: true,
+      description: "Comment explaining decision"
+    }),
+    decidedAt: field.dateTime({ isOptional: true }),
+    delegatedTo: field.string({
+      isOptional: true,
+      description: "User delegated to"
+    }),
+    delegationReason: field.string({ isOptional: true }),
+    escalationLevel: field.int({
+      default: 0,
+      description: "Current escalation level"
+    }),
+    escalatedAt: field.dateTime({ isOptional: true }),
+    dueAt: field.dateTime({
+      isOptional: true,
+      description: "When approval is due"
+    }),
+    reminderSentAt: field.dateTime({ isOptional: true }),
+    contextSnapshot: field.json({
+      isOptional: true,
+      description: "Snapshot of relevant data for review"
+    }),
+    sequenceOrder: field.int({
+      default: 0,
+      description: "Order in approval chain"
+    }),
+    createdAt: field.createdAt(),
+    updatedAt: field.updatedAt(),
+    workflowInstance: field.belongsTo("WorkflowInstance", ["workflowInstanceId"], ["id"], { onDelete: "Cascade" }),
+    stepExecution: field.belongsTo("StepExecution", ["stepExecutionId"], ["id"])
+  },
+  indexes: [
+    index.on(["approverId", "status"]),
+    index.on(["workflowInstanceId", "status"]),
+    index.on(["stepExecutionId"]),
+    index.on(["status", "dueAt"]),
+    index.on(["createdAt"])
+  ],
+  enums: [ApprovalStatusEnum, ApprovalDecisionEnum]
 });
-/**
-* ApprovalComment entity - comments on approval requests.
-*/
-const ApprovalCommentEntity = defineEntity({
-	name: "ApprovalComment",
-	description: "A comment on an approval request.",
-	schema: "workflow",
-	map: "approval_comment",
-	fields: {
-		id: field.id(),
-		approvalRequestId: field.foreignKey(),
-		authorId: field.foreignKey(),
-		content: field.string({ description: "Comment text" }),
-		isInternal: field.boolean({
-			default: false,
-			description: "Internal note vs public comment"
-		}),
-		createdAt: field.createdAt(),
-		updatedAt: field.updatedAt(),
-		approvalRequest: field.belongsTo("ApprovalRequest", ["approvalRequestId"], ["id"], { onDelete: "Cascade" })
-	},
-	indexes: [index.on(["approvalRequestId", "createdAt"])]
+var ApprovalCommentEntity = defineEntity({
+  name: "ApprovalComment",
+  description: "A comment on an approval request.",
+  schema: "workflow",
+  map: "approval_comment",
+  fields: {
+    id: field.id(),
+    approvalRequestId: field.foreignKey(),
+    authorId: field.foreignKey(),
+    content: field.string({ description: "Comment text" }),
+    isInternal: field.boolean({
+      default: false,
+      description: "Internal note vs public comment"
+    }),
+    createdAt: field.createdAt(),
+    updatedAt: field.updatedAt(),
+    approvalRequest: field.belongsTo("ApprovalRequest", ["approvalRequestId"], ["id"], { onDelete: "Cascade" })
+  },
+  indexes: [index.on(["approvalRequestId", "createdAt"])]
 });
-
-//#endregion
-export { ApprovalCommentEntity, ApprovalDecisionEnum, ApprovalRequestEntity, ApprovalStatusEnum };
-//# sourceMappingURL=approval.js.map
+export {
+  ApprovalStatusEnum,
+  ApprovalRequestEntity,
+  ApprovalDecisionEnum,
+  ApprovalCommentEntity
+};