@contractspec/example.workflow-system 3.7.7 → 3.8.2

package/dist/ui/renderers/workflow.markdown.js

@@ -1,113 +1,448 @@
 // @bun
-// src/ui/renderers/workflow.markdown.ts
-var mockWorkflowDefinitions = [
+// src/shared/demo-scenario.ts
+var WORKFLOW_SYSTEM_DEMO_PROJECT_ID = "workflow-system-demo";
+var WORKFLOW_SYSTEM_DEMO_ORGANIZATION_ID = "org_demo";
+var WORKFLOW_SYSTEM_DEMO_DEFINITIONS = [
   {
-    id: "wf-1",
-    name: "Purchase Approval",
+    id: "wf_expense",
+    name: "Expense Approval",
+    description: "Approve non-trivial spend before finance releases budget.",
     type: "APPROVAL",
+    status: "ACTIVE",
+    createdAt: "2026-03-10T09:00:00.000Z",
+    updatedAt: "2026-03-20T08:15:00.000Z",
     steps: [
       {
-        id: "s1",
+        id: "wfstep_expense_manager",
         name: "Manager Review",
-        order: 1,
-        requiredRoles: ["manager"]
+        description: "Validate business value and team budget.",
+        stepOrder: 1,
+        type: "APPROVAL",
+        requiredRoles: ["manager"],
+        createdAt: "2026-03-10T09:00:00.000Z"
       },
       {
-        id: "s2",
+        id: "wfstep_expense_finance",
         name: "Finance Review",
-        order: 2,
-        requiredRoles: ["finance"]
-      },
-      { id: "s3", name: "Final Approval", order: 3, requiredRoles: ["admin"] }
-    ],
-    status: "ACTIVE"
+        description: "Confirm ledger coding and spending threshold.",
+        stepOrder: 2,
+        type: "APPROVAL",
+        requiredRoles: ["finance"],
+        createdAt: "2026-03-10T09:10:00.000Z"
+      }
+    ]
   },
   {
-    id: "wf-2",
-    name: "Leave Request",
-    type: "APPROVAL",
+    id: "wf_vendor",
+    name: "Vendor Onboarding",
+    description: "Sequence security, procurement, and legal before activation.",
+    type: "SEQUENTIAL",
+    status: "ACTIVE",
+    createdAt: "2026-03-08T11:00:00.000Z",
+    updatedAt: "2026-03-19T13:10:00.000Z",
     steps: [
       {
-        id: "s1",
-        name: "Supervisor Approval",
-        order: 1,
-        requiredRoles: ["supervisor"]
+        id: "wfstep_vendor_security",
+        name: "Security Check",
+        description: "Review data access and integration scope.",
+        stepOrder: 1,
+        type: "APPROVAL",
+        requiredRoles: ["security"],
+        createdAt: "2026-03-08T11:00:00.000Z"
       },
-      { id: "s2", name: "HR Review", order: 2, requiredRoles: ["hr"] }
-    ],
-    status: "ACTIVE"
+      {
+        id: "wfstep_vendor_procurement",
+        name: "Procurement Check",
+        description: "Validate pricing, procurement policy, and owner.",
+        stepOrder: 2,
+        type: "APPROVAL",
+        requiredRoles: ["procurement"],
+        createdAt: "2026-03-08T11:05:00.000Z"
+      },
+      {
+        id: "wfstep_vendor_legal",
+        name: "Legal Sign-off",
+        description: "Approve terms before the vendor goes live.",
+        stepOrder: 3,
+        type: "APPROVAL",
+        requiredRoles: ["legal"],
+        createdAt: "2026-03-08T11:10:00.000Z"
+      }
+    ]
   },
   {
-    id: "wf-3",
-    name: "Document Review",
-    type: "SEQUENTIAL",
+    id: "wf_policy_exception",
+    name: "Policy Exception",
+    description: "Escalate a temporary exception through team lead and compliance.",
+    type: "APPROVAL",
+    status: "DRAFT",
+    createdAt: "2026-03-15T07:30:00.000Z",
+    updatedAt: "2026-03-18T11:20:00.000Z",
     steps: [
-      { id: "s1", name: "Author Review", order: 1, requiredRoles: ["author"] },
-      { id: "s2", name: "Peer Review", order: 2, requiredRoles: ["reviewer"] },
-      { id: "s3", name: "Publish", order: 3, requiredRoles: ["publisher"] }
-    ],
-    status: "DRAFT"
+      {
+        id: "wfstep_policy_lead",
+        name: "Team Lead Review",
+        description: "Check urgency and expected blast radius.",
+        stepOrder: 1,
+        type: "APPROVAL",
+        requiredRoles: ["team-lead"],
+        createdAt: "2026-03-15T07:30:00.000Z"
+      },
+      {
+        id: "wfstep_policy_compliance",
+        name: "Compliance Review",
+        description: "Accept or reject the exception request.",
+        stepOrder: 2,
+        type: "APPROVAL",
+        requiredRoles: ["compliance"],
+        createdAt: "2026-03-15T07:40:00.000Z"
+      }
+    ]
   }
 ];
-var mockWorkflowInstances = [
+var WORKFLOW_SYSTEM_DEMO_INSTANCES = [
   {
-    id: "inst-1",
-    definitionId: "wf-1",
-    definitionName: "Purchase Approval",
+    id: "wfinst_expense_open",
+    definitionId: "wf_expense",
     status: "IN_PROGRESS",
-    currentStepId: "s2",
-    startedAt: "2024-01-15T10:00:00Z",
-    requestedBy: "John Doe"
+    currentStepId: "wfstep_expense_finance",
+    data: {
+      amount: 4200,
+      currency: "EUR",
+      vendor: "Nimbus AI"
+    },
+    requestedBy: "sarah@contractspec.io",
+    startedAt: "2026-03-20T08:00:00.000Z",
+    approvals: [
+      {
+        id: "wfappr_expense_manager",
+        stepId: "wfstep_expense_manager",
+        status: "APPROVED",
+        actorId: "manager.demo",
+        comment: "Approved for the Q2 automation budget.",
+        decidedAt: "2026-03-20T08:15:00.000Z",
+        createdAt: "2026-03-20T08:05:00.000Z"
+      },
+      {
+        id: "wfappr_expense_finance",
+        stepId: "wfstep_expense_finance",
+        status: "PENDING",
+        createdAt: "2026-03-20T08:15:00.000Z"
+      }
+    ]
   },
   {
-    id: "inst-2",
-    definitionId: "wf-1",
-    definitionName: "Purchase Approval",
+    id: "wfinst_vendor_done",
+    definitionId: "wf_vendor",
     status: "COMPLETED",
-    currentStepId: null,
-    startedAt: "2024-01-10T09:00:00Z",
-    completedAt: "2024-01-12T14:00:00Z",
-    requestedBy: "Jane Smith"
+    data: {
+      vendor: "Acme Cloud",
+      riskTier: "medium"
+    },
+    requestedBy: "leo@contractspec.io",
+    startedAt: "2026-03-19T09:30:00.000Z",
+    completedAt: "2026-03-19T13:10:00.000Z",
+    approvals: [
+      {
+        id: "wfappr_vendor_security",
+        stepId: "wfstep_vendor_security",
+        status: "APPROVED",
+        actorId: "security.demo",
+        comment: "SOC2 scope is acceptable.",
+        decidedAt: "2026-03-19T10:10:00.000Z",
+        createdAt: "2026-03-19T09:35:00.000Z"
+      },
+      {
+        id: "wfappr_vendor_procurement",
+        stepId: "wfstep_vendor_procurement",
+        status: "APPROVED",
+        actorId: "procurement.demo",
+        comment: "Commercial terms match the preferred vendor tier.",
+        decidedAt: "2026-03-19T11:25:00.000Z",
+        createdAt: "2026-03-19T10:15:00.000Z"
+      },
+      {
+        id: "wfappr_vendor_legal",
+        stepId: "wfstep_vendor_legal",
+        status: "APPROVED",
+        actorId: "legal.demo",
+        comment: "MSA redlines are complete.",
+        decidedAt: "2026-03-19T13:05:00.000Z",
+        createdAt: "2026-03-19T11:30:00.000Z"
+      }
+    ]
   },
   {
-    id: "inst-3",
-    definitionId: "wf-2",
-    definitionName: "Leave Request",
-    status: "PENDING",
-    currentStepId: "s1",
-    startedAt: "2024-01-16T08:00:00Z",
-    requestedBy: "Bob Wilson"
+    id: "wfinst_policy_rejected",
+    definitionId: "wf_policy_exception",
+    status: "REJECTED",
+    currentStepId: "wfstep_policy_compliance",
+    data: {
+      policy: "Model rollout freeze",
+      durationDays: 14
+    },
+    requestedBy: "maya@contractspec.io",
+    startedAt: "2026-03-18T10:00:00.000Z",
+    completedAt: "2026-03-18T11:20:00.000Z",
+    approvals: [
+      {
+        id: "wfappr_policy_lead",
+        stepId: "wfstep_policy_lead",
+        status: "APPROVED",
+        actorId: "lead.demo",
+        comment: "Escalation justified for the release train.",
+        decidedAt: "2026-03-18T10:30:00.000Z",
+        createdAt: "2026-03-18T10:05:00.000Z"
+      },
+      {
+        id: "wfappr_policy_compliance",
+        stepId: "wfstep_policy_compliance",
+        status: "REJECTED",
+        actorId: "compliance.demo",
+        comment: "Exception exceeds the allowed blast radius.",
+        decidedAt: "2026-03-18T11:15:00.000Z",
+        createdAt: "2026-03-18T10:35:00.000Z"
+      }
+    ]
   }
 ];
+
+// src/visualizations/catalog.ts
+import {
+  defineVisualization,
+  VisualizationRegistry
+} from "@contractspec/lib.contracts-spec/visualizations";
+var INSTANCE_LIST_REF = {
+  key: "workflow.instance.list",
+  version: "1.0.0"
+};
+var META = {
+  version: "1.0.0",
+  domain: "workflow",
+  stability: "experimental",
+  owners: ["@example.workflow-system"],
+  tags: ["workflow", "visualization", "operations"]
+};
+var WorkflowInstanceStatusVisualization = defineVisualization({
+  meta: {
+    ...META,
+    key: "workflow-system.visualization.instance-status",
+    title: "Instance Status Breakdown",
+    description: "Distribution of workflow instance states.",
+    goal: "Surface the current workload mix.",
+    context: "Workflow operations overview."
+  },
+  source: { primary: INSTANCE_LIST_REF, resultPath: "data" },
+  visualization: {
+    kind: "pie",
+    nameDimension: "status",
+    valueMeasure: "instances",
+    dimensions: [
+      { key: "status", label: "Status", dataPath: "status", type: "category" }
+    ],
+    measures: [
+      {
+        key: "instances",
+        label: "Instances",
+        dataPath: "instances",
+        format: "number"
+      }
+    ],
+    table: { caption: "Workflow instance counts by status." }
+  }
+});
+var WorkflowThroughputVisualization = defineVisualization({
+  meta: {
+    ...META,
+    key: "workflow-system.visualization.throughput",
+    title: "Run Throughput",
+    description: "Daily workflow instance starts.",
+    goal: "Show operational throughput over time.",
+    context: "Workflow trend monitoring."
+  },
+  source: { primary: INSTANCE_LIST_REF, resultPath: "data" },
+  visualization: {
+    kind: "cartesian",
+    variant: "line",
+    xDimension: "day",
+    yMeasures: ["instances"],
+    dimensions: [{ key: "day", label: "Day", dataPath: "day", type: "time" }],
+    measures: [
+      {
+        key: "instances",
+        label: "Instances",
+        dataPath: "instances",
+        format: "number",
+        color: "#0f766e"
+      }
+    ],
+    table: { caption: "Daily workflow instance starts." }
+  }
+});
+var WorkflowActiveMetricVisualization = defineVisualization({
+  meta: {
+    ...META,
+    key: "workflow-system.visualization.active-work",
+    title: "Active Work",
+    description: "Current in-flight or pending workflow instances.",
+    goal: "Expose active operational workload.",
+    context: "Workflow workload comparison."
+  },
+  source: { primary: INSTANCE_LIST_REF, resultPath: "data" },
+  visualization: {
+    kind: "metric",
+    measure: "value",
+    measures: [
+      { key: "value", label: "Instances", dataPath: "value", format: "number" }
+    ],
+    table: { caption: "Active workflow count." }
+  }
+});
+var WorkflowCompletedMetricVisualization = defineVisualization({
+  meta: {
+    ...META,
+    key: "workflow-system.visualization.completed-work",
+    title: "Completed Work",
+    description: "Completed workflow instances in the current sample.",
+    goal: "Show output against active workload.",
+    context: "Workflow workload comparison."
+  },
+  source: { primary: INSTANCE_LIST_REF, resultPath: "data" },
+  visualization: {
+    kind: "metric",
+    measure: "value",
+    measures: [
+      { key: "value", label: "Instances", dataPath: "value", format: "number" }
+    ],
+    table: { caption: "Completed workflow count." }
+  }
+});
+var WorkflowVisualizationSpecs = [
+  WorkflowInstanceStatusVisualization,
+  WorkflowThroughputVisualization,
+  WorkflowActiveMetricVisualization,
+  WorkflowCompletedMetricVisualization
+];
+var WorkflowVisualizationRegistry = new VisualizationRegistry([
+  ...WorkflowVisualizationSpecs
+]);
+var WorkflowVisualizationRefs = WorkflowVisualizationSpecs.map((spec) => ({
+  key: spec.meta.key,
+  version: spec.meta.version
+}));
+
+// src/visualizations/selectors.ts
+function toDayKey(value) {
+  const date = value instanceof Date ? value : new Date(value);
+  return date.toISOString().slice(0, 10);
+}
+function createWorkflowVisualizationSections(instances) {
+  const statusCounts = new Map;
+  const throughput = new Map;
+  let activeCount = 0;
+  let completedCount = 0;
+  for (const instance of instances) {
+    statusCounts.set(instance.status, (statusCounts.get(instance.status) ?? 0) + 1);
+    const day = toDayKey(instance.startedAt);
+    throughput.set(day, (throughput.get(day) ?? 0) + 1);
+    if (instance.status === "PENDING" || instance.status === "IN_PROGRESS") {
+      activeCount += 1;
+    }
+    if (instance.status === "COMPLETED") {
+      completedCount += 1;
+    }
+  }
+  const primaryItems = [
+    {
+      key: "workflow-status",
+      spec: WorkflowInstanceStatusVisualization,
+      data: {
+        data: Array.from(statusCounts.entries()).map(([status, count]) => ({
+          status,
+          instances: count
+        }))
+      },
+      title: "Instance Status Breakdown",
+      description: "Status mix across workflow instances.",
+      height: 260
+    },
+    {
+      key: "workflow-throughput",
+      spec: WorkflowThroughputVisualization,
+      data: {
+        data: Array.from(throughput.entries()).sort(([left], [right]) => left.localeCompare(right)).map(([day, count]) => ({ day, instances: count }))
+      },
+      title: "Run Throughput",
+      description: "Daily workflow starts from current instances."
+    }
+  ];
+  const comparisonItems = [
+    {
+      key: "workflow-active",
+      spec: WorkflowActiveMetricVisualization,
+      data: { data: [{ value: activeCount }] },
+      title: "Active Work",
+      description: "Pending and in-progress workflows.",
+      height: 200
+    },
+    {
+      key: "workflow-completed",
+      spec: WorkflowCompletedMetricVisualization,
+      data: { data: [{ value: completedCount }] },
+      title: "Completed Work",
+      description: "Completed workflows in the current sample.",
+      height: 200
+    }
+  ];
+  return {
+    primaryItems,
+    comparisonItems
+  };
+}
+// src/ui/renderers/workflow.markdown.ts
+var workflowDefinitions = WORKFLOW_SYSTEM_DEMO_DEFINITIONS;
+var workflowInstances = WORKFLOW_SYSTEM_DEMO_INSTANCES;
+var workflowDefinitionById = new Map(workflowDefinitions.map((definition) => [definition.id, definition]));
+function formatDate(value) {
+  return new Date(value).toISOString().slice(0, 10);
+}
 var workflowDashboardMarkdownRenderer = {
   target: "markdown",
   render: async (desc) => {
     if (desc.source.type !== "component" || desc.source.componentKey !== "WorkflowDashboard") {
       throw new Error("workflowDashboardMarkdownRenderer: not WorkflowDashboard");
     }
-    const definitions = mockWorkflowDefinitions;
-    const instances = mockWorkflowInstances;
+    const definitions = workflowDefinitions;
+    const instances = workflowInstances;
+    const visualizations = createWorkflowVisualizationSections(instances);
     const activeDefinitions = definitions.filter((d) => d.status === "ACTIVE");
-    const pendingInstances = instances.filter((i) => i.status === "PENDING");
-    const inProgressInstances = instances.filter((i) => i.status === "IN_PROGRESS");
-    const completedInstances = instances.filter((i) => i.status === "COMPLETED");
+    const awaitingActionInstances = instances.filter((i) => i.status === "PENDING" || i.status === "IN_PROGRESS");
     const lines = [
       "# Workflow Dashboard",
       "",
-      "> Workflow and approval management overview",
+      "> Seeded workflow and approval overview for the sandbox demo.",
       "",
       "## Summary",
       "",
       "| Metric | Value |",
       "|--------|-------|",
       `| Active Workflows | ${activeDefinitions.length} |`,
-      `| Pending Approvals | ${pendingInstances.length} |`,
-      `| In Progress | ${inProgressInstances.length} |`,
-      `| Completed | ${completedInstances.length} |`,
-      "",
-      "## Active Workflow Definitions",
+      `| Awaiting Action | ${awaitingActionInstances.length} |`,
+      `| Completed | ${instances.filter((i) => i.status === "COMPLETED").length} |`,
+      `| Rejected | ${instances.filter((i) => i.status === "REJECTED").length} |`,
       ""
     ];
+    lines.push("## Visualization Overview");
+    lines.push("");
+    for (const item of [
+      ...visualizations.primaryItems,
+      ...visualizations.comparisonItems
+    ]) {
+      lines.push(`- **${item.title}** via \`${item.spec.meta.key}\``);
+    }
+    lines.push("");
+    lines.push("## Active Workflow Definitions");
+    lines.push("");
     if (activeDefinitions.length === 0) {
       lines.push("_No active workflow definitions._");
     } else {
@@ -126,8 +461,9 @@ var workflowDashboardMarkdownRenderer = {
       lines.push("| Workflow | Requested By | Status | Started |");
       lines.push("|----------|--------------|--------|---------|");
       for (const inst of instances.slice(0, 10)) {
-        const startedDate = new Date(inst.startedAt).toLocaleDateString();
-        lines.push(`| ${inst.definitionName} | ${inst.requestedBy} | ${inst.status} | ${startedDate} |`);
+        const startedDate = formatDate(inst.startedAt);
+        const definitionName = workflowDefinitionById.get(inst.definitionId)?.name ?? inst.definitionId;
+        lines.push(`| ${definitionName} | ${inst.requestedBy} | ${inst.status} | ${startedDate} |`);
       }
     }
     return {
@@ -143,7 +479,7 @@ var workflowDefinitionListMarkdownRenderer = {
     if (desc.source.type !== "component" || desc.source.componentKey !== "WorkflowDefinitionList") {
       throw new Error("workflowDefinitionListMarkdownRenderer: not WorkflowDefinitionList");
     }
-    const definitions = mockWorkflowDefinitions;
+    const definitions = workflowDefinitions;
     const lines = [
       "# Workflow Definitions",
       "",
@@ -158,7 +494,7 @@ var workflowDefinitionListMarkdownRenderer = {
       lines.push("### Steps");
       lines.push("");
       for (const step of def.steps) {
-        lines.push(`${step.order}. **${step.name}** - Roles: ${step.requiredRoles.join(", ")}`);
+        lines.push(`${step.stepOrder}. **${step.name}** - Roles: ${step.requiredRoles.join(", ")}`);
       }
       lines.push("");
     }
@@ -175,7 +511,7 @@ var workflowInstanceDetailMarkdownRenderer = {
     if (desc.source.type !== "component" || desc.source.componentKey !== "WorkflowInstanceDetail") {
       throw new Error("workflowInstanceDetailMarkdownRenderer: not WorkflowInstanceDetail");
     }
-    const instance = mockWorkflowInstances[0];
+    const instance = workflowInstances.find((workflowInstance) => workflowInstance.status === "IN_PROGRESS") ?? workflowInstances[0];
     if (!instance) {
       return {
         mimeType: "text/markdown",
@@ -184,14 +520,14 @@ var workflowInstanceDetailMarkdownRenderer = {
 No workflow instances available.`
       };
     }
-    const definition = mockWorkflowDefinitions.find((d) => d.id === instance.definitionId);
+    const definition = workflowDefinitions.find((d) => d.id === instance.definitionId);
     const lines = [
-      `# Workflow: ${instance.definitionName}`,
+      `# Workflow: ${definition?.name ?? instance.definitionId}`,
       "",
       `**Instance ID:** ${instance.id}`,
       `**Status:** ${instance.status}`,
       `**Requested By:** ${instance.requestedBy}`,
-      `**Started:** ${new Date(instance.startedAt).toLocaleString()}`,
+      `**Started:** ${formatDate(instance.startedAt)}`,
       "",
       "## Steps Progress",
       ""
@@ -212,7 +548,7 @@ No workflow instances available.`
     lines.push("## Actions");
     lines.push("");
     lines.push("- **Approve** - Move to next step");
-    lines.push("- **Reject** - Reject and return");
+    lines.push("- **Reject** - End the workflow with a rejection outcome");
     lines.push("- **Delegate** - Assign to another approver");
     return {
       mimeType: "text/markdown",

package/dist/visualizations/catalog.d.ts

@@ -0,0 +1,11 @@
+import { VisualizationRegistry } from '@contractspec/lib.contracts-spec/visualizations';
+export declare const WorkflowInstanceStatusVisualization: import("@contractspec/lib.contracts-spec").VisualizationSpec;
+export declare const WorkflowThroughputVisualization: import("@contractspec/lib.contracts-spec").VisualizationSpec;
+export declare const WorkflowActiveMetricVisualization: import("@contractspec/lib.contracts-spec").VisualizationSpec;
+export declare const WorkflowCompletedMetricVisualization: import("@contractspec/lib.contracts-spec").VisualizationSpec;
+export declare const WorkflowVisualizationSpecs: readonly [import("@contractspec/lib.contracts-spec").VisualizationSpec, import("@contractspec/lib.contracts-spec").VisualizationSpec, import("@contractspec/lib.contracts-spec").VisualizationSpec, import("@contractspec/lib.contracts-spec").VisualizationSpec];
+export declare const WorkflowVisualizationRegistry: VisualizationRegistry;
+export declare const WorkflowVisualizationRefs: {
+    key: string;
+    version: string;
+}[];