@contractspec/example.workflow-system 1.57.0 → 1.58.0

package/dist/browser/presentations/index.js

@@ -0,0 +1,109 @@
+// src/instance/instance.enum.ts
+import { defineEnum } from "@contractspec/lib.schema";
+var InstanceStatusEnum = defineEnum("InstanceStatus", [
+  "PENDING",
+  "RUNNING",
+  "WAITING",
+  "PAUSED",
+  "COMPLETED",
+  "CANCELLED",
+  "FAILED",
+  "TIMEOUT"
+]);
+
+// src/instance/instance.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var WorkflowInstanceModel = defineSchemaModel({
+  name: "WorkflowInstanceModel",
+  description: "A running workflow instance",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    workflowDefinitionId: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    referenceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    referenceType: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: true
+    },
+    status: { type: InstanceStatusEnum, isOptional: false },
+    currentStepId: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: true
+    },
+    contextData: { type: ScalarTypeEnum.JSON(), isOptional: true },
+    triggeredBy: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    organizationId: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    priority: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    dueAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    outcome: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    resultData: { type: ScalarTypeEnum.JSON(), isOptional: true },
+    errorMessage: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: true
+    },
+    createdAt: { type: ScalarTypeEnum.DateTime(), isOptional: false },
+    startedAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    completedAt: { type: ScalarTypeEnum.DateTime(), isOptional: true }
+  }
+});
+var StartWorkflowInputModel = defineSchemaModel({
+  name: "StartWorkflowInput",
+  description: "Input for starting a workflow",
+  fields: {
+    workflowKey: { type: ScalarTypeEnum.NonEmptyString(), isOptional: false },
+    contextData: { type: ScalarTypeEnum.JSON(), isOptional: true },
+    referenceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    referenceType: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: true
+    },
+    priority: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },
+    dueAt: { type: ScalarTypeEnum.DateTime(), isOptional: true }
+  }
+});
+var TransitionInputModel = defineSchemaModel({
+  name: "TransitionInput",
+  description: "Input for transitioning a workflow",
+  fields: {
+    instanceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    action: { type: ScalarTypeEnum.NonEmptyString(), isOptional: false },
+    data: { type: ScalarTypeEnum.JSON(), isOptional: true },
+    comment: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+var TransitionResultModel = defineSchemaModel({
+  name: "TransitionResult",
+  description: "Result of a workflow transition",
+  fields: {
+    success: { type: ScalarTypeEnum.Boolean(), isOptional: false },
+    instance: { type: WorkflowInstanceModel, isOptional: false },
+    previousStepKey: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: true
+    },
+    currentStepKey: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: true
+    },
+    message: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+export {
+  WorkflowSystemPresentations,
+  WorkflowMetricsPresentation,
+  WorkflowListPresentation,
+  WorkflowDetailPresentation,
+  WorkflowDesignerPresentation,
+  ProgressTrackerPresentation,
+  PendingApprovalsBadgePresentation,
+  InstanceListPresentation,
+  InstanceDetailPresentation,
+  ApprovalInboxPresentation,
+  ApprovalFormPresentation,
+  ApprovalDetailPresentation
+};

package/dist/browser/seeders/index.js

@@ -0,0 +1,3 @@
+export {
+  seedWorkflowSystem
+};

package/dist/browser/shared/index.js

@@ -0,0 +1,3 @@
+export {
+  mockDataStore
+};

package/dist/browser/shared/mock-data.js

@@ -0,0 +1,11 @@
+// src/shared/mock-data.ts
+var mockDataStore = {
+  workflows: new Map,
+  steps: new Map,
+  instances: new Map,
+  approvals: new Map,
+  stepExecutions: new Map
+};
+export {
+  mockDataStore
+};

package/dist/browser/state-machine/index.js

@@ -0,0 +1,6 @@
+export {
+  createStateMachineEngine,
+  createInitialState,
+  buildStateMachineDefinition,
+  BasicStateMachineEngine
+};

package/dist/browser/tests/operations.test-spec.js

@@ -0,0 +1,6 @@
+export {
+  InstanceListTest,
+  DefinitionListTest,
+  ApprovalListMineTest,
+  ApprovalDecideTest
+};

package/dist/browser/ui/WorkflowDashboard.js

@@ -0,0 +1,3 @@
+export {
+  WorkflowDashboard
+};

package/dist/browser/ui/hooks/index.js

@@ -0,0 +1,50 @@
+// src/ui/hooks/useWorkflowList.ts
+import { useCallback, useEffect, useState } from "react";
+import { useTemplateRuntime } from "@contractspec/lib.example-shared-ui";
+"use client";
+function useWorkflowList(projectId = "local-project") {
+  const { handlers } = useTemplateRuntime();
+  const workflow = handlers.workflow;
+  const [definitions, setDefinitions] = useState([]);
+  const [instances, setInstances] = useState([]);
+  const [loading, setLoading] = useState(true);
+  const [error, setError] = useState(null);
+  const fetchData = useCallback(async () => {
+    try {
+      setLoading(true);
+      setError(null);
+      const [defResult, instResult] = await Promise.all([
+        workflow.listDefinitions({ projectId, limit: 100 }),
+        workflow.listInstances({ projectId, limit: 100 })
+      ]);
+      setDefinitions(defResult.definitions);
+      setInstances(instResult.instances);
+    } catch (err) {
+      setError(err instanceof Error ? err : new Error("Failed to load workflows"));
+    } finally {
+      setLoading(false);
+    }
+  }, [handlers, projectId]);
+  useEffect(() => {
+    fetchData();
+  }, [fetchData]);
+  const stats = {
+    totalDefinitions: definitions.length,
+    activeDefinitions: definitions.filter((d) => d.status === "ACTIVE").length,
+    totalInstances: instances.length,
+    pendingInstances: instances.filter((i) => i.status === "PENDING").length,
+    completedInstances: instances.filter((i) => i.status === "COMPLETED").length,
+    rejectedInstances: instances.filter((i) => i.status === "REJECTED").length
+  };
+  return {
+    definitions,
+    instances,
+    loading,
+    error,
+    stats,
+    refetch: fetchData
+  };
+}
+export {
+  useWorkflowList
+};

package/dist/browser/ui/hooks/useWorkflowList.js

@@ -0,0 +1,50 @@
+// src/ui/hooks/useWorkflowList.ts
+import { useCallback, useEffect, useState } from "react";
+import { useTemplateRuntime } from "@contractspec/lib.example-shared-ui";
+"use client";
+function useWorkflowList(projectId = "local-project") {
+  const { handlers } = useTemplateRuntime();
+  const workflow = handlers.workflow;
+  const [definitions, setDefinitions] = useState([]);
+  const [instances, setInstances] = useState([]);
+  const [loading, setLoading] = useState(true);
+  const [error, setError] = useState(null);
+  const fetchData = useCallback(async () => {
+    try {
+      setLoading(true);
+      setError(null);
+      const [defResult, instResult] = await Promise.all([
+        workflow.listDefinitions({ projectId, limit: 100 }),
+        workflow.listInstances({ projectId, limit: 100 })
+      ]);
+      setDefinitions(defResult.definitions);
+      setInstances(instResult.instances);
+    } catch (err) {
+      setError(err instanceof Error ? err : new Error("Failed to load workflows"));
+    } finally {
+      setLoading(false);
+    }
+  }, [handlers, projectId]);
+  useEffect(() => {
+    fetchData();
+  }, [fetchData]);
+  const stats = {
+    totalDefinitions: definitions.length,
+    activeDefinitions: definitions.filter((d) => d.status === "ACTIVE").length,
+    totalInstances: instances.length,
+    pendingInstances: instances.filter((i) => i.status === "PENDING").length,
+    completedInstances: instances.filter((i) => i.status === "COMPLETED").length,
+    rejectedInstances: instances.filter((i) => i.status === "REJECTED").length
+  };
+  return {
+    definitions,
+    instances,
+    loading,
+    error,
+    stats,
+    refetch: fetchData
+  };
+}
+export {
+  useWorkflowList
+};

package/dist/browser/ui/index.js

@@ -0,0 +1,54 @@
+// src/ui/hooks/useWorkflowList.ts
+import { useCallback, useEffect, useState } from "react";
+import { useTemplateRuntime } from "@contractspec/lib.example-shared-ui";
+"use client";
+function useWorkflowList(projectId = "local-project") {
+  const { handlers } = useTemplateRuntime();
+  const workflow = handlers.workflow;
+  const [definitions, setDefinitions] = useState([]);
+  const [instances, setInstances] = useState([]);
+  const [loading, setLoading] = useState(true);
+  const [error, setError] = useState(null);
+  const fetchData = useCallback(async () => {
+    try {
+      setLoading(true);
+      setError(null);
+      const [defResult, instResult] = await Promise.all([
+        workflow.listDefinitions({ projectId, limit: 100 }),
+        workflow.listInstances({ projectId, limit: 100 })
+      ]);
+      setDefinitions(defResult.definitions);
+      setInstances(instResult.instances);
+    } catch (err) {
+      setError(err instanceof Error ? err : new Error("Failed to load workflows"));
+    } finally {
+      setLoading(false);
+    }
+  }, [handlers, projectId]);
+  useEffect(() => {
+    fetchData();
+  }, [fetchData]);
+  const stats = {
+    totalDefinitions: definitions.length,
+    activeDefinitions: definitions.filter((d) => d.status === "ACTIVE").length,
+    totalInstances: instances.length,
+    pendingInstances: instances.filter((i) => i.status === "PENDING").length,
+    completedInstances: instances.filter((i) => i.status === "COMPLETED").length,
+    rejectedInstances: instances.filter((i) => i.status === "REJECTED").length
+  };
+  return {
+    definitions,
+    instances,
+    loading,
+    error,
+    stats,
+    refetch: fetchData
+  };
+}
+export {
+  workflowInstanceDetailMarkdownRenderer,
+  workflowDefinitionListMarkdownRenderer,
+  workflowDashboardMarkdownRenderer,
+  useWorkflowList,
+  WorkflowDashboard
+};

package/dist/browser/ui/renderers/index.js

@@ -0,0 +1,227 @@
+// src/ui/renderers/workflow.markdown.ts
+var mockWorkflowDefinitions = [
+  {
+    id: "wf-1",
+    name: "Purchase Approval",
+    type: "APPROVAL",
+    steps: [
+      {
+        id: "s1",
+        name: "Manager Review",
+        order: 1,
+        requiredRoles: ["manager"]
+      },
+      {
+        id: "s2",
+        name: "Finance Review",
+        order: 2,
+        requiredRoles: ["finance"]
+      },
+      { id: "s3", name: "Final Approval", order: 3, requiredRoles: ["admin"] }
+    ],
+    status: "ACTIVE"
+  },
+  {
+    id: "wf-2",
+    name: "Leave Request",
+    type: "APPROVAL",
+    steps: [
+      {
+        id: "s1",
+        name: "Supervisor Approval",
+        order: 1,
+        requiredRoles: ["supervisor"]
+      },
+      { id: "s2", name: "HR Review", order: 2, requiredRoles: ["hr"] }
+    ],
+    status: "ACTIVE"
+  },
+  {
+    id: "wf-3",
+    name: "Document Review",
+    type: "SEQUENTIAL",
+    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"
+  }
+];
+var mockWorkflowInstances = [
+  {
+    id: "inst-1",
+    definitionId: "wf-1",
+    definitionName: "Purchase Approval",
+    status: "IN_PROGRESS",
+    currentStepId: "s2",
+    startedAt: "2024-01-15T10:00:00Z",
+    requestedBy: "John Doe"
+  },
+  {
+    id: "inst-2",
+    definitionId: "wf-1",
+    definitionName: "Purchase Approval",
+    status: "COMPLETED",
+    currentStepId: null,
+    startedAt: "2024-01-10T09:00:00Z",
+    completedAt: "2024-01-12T14:00:00Z",
+    requestedBy: "Jane Smith"
+  },
+  {
+    id: "inst-3",
+    definitionId: "wf-2",
+    definitionName: "Leave Request",
+    status: "PENDING",
+    currentStepId: "s1",
+    startedAt: "2024-01-16T08:00:00Z",
+    requestedBy: "Bob Wilson"
+  }
+];
+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 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 lines = [
+      "# Workflow Dashboard",
+      "",
+      "> Workflow and approval management overview",
+      "",
+      "## Summary",
+      "",
+      "| Metric | Value |",
+      "|--------|-------|",
+      `| Active Workflows | ${activeDefinitions.length} |`,
+      `| Pending Approvals | ${pendingInstances.length} |`,
+      `| In Progress | ${inProgressInstances.length} |`,
+      `| Completed | ${completedInstances.length} |`,
+      "",
+      "## Active Workflow Definitions",
+      ""
+    ];
+    if (activeDefinitions.length === 0) {
+      lines.push("_No active workflow definitions._");
+    } else {
+      lines.push("| Name | Type | Steps | Status |");
+      lines.push("|------|------|-------|--------|");
+      for (const def of activeDefinitions) {
+        lines.push(`| ${def.name} | ${def.type} | ${def.steps.length} | ${def.status} |`);
+      }
+    }
+    lines.push("");
+    lines.push("## Recent Instances");
+    lines.push("");
+    if (instances.length === 0) {
+      lines.push("_No workflow instances._");
+    } else {
+      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} |`);
+      }
+    }
+    return {
+      mimeType: "text/markdown",
+      body: lines.join(`
+`)
+    };
+  }
+};
+var workflowDefinitionListMarkdownRenderer = {
+  target: "markdown",
+  render: async (desc) => {
+    if (desc.source.type !== "component" || desc.source.componentKey !== "WorkflowDefinitionList") {
+      throw new Error("workflowDefinitionListMarkdownRenderer: not WorkflowDefinitionList");
+    }
+    const definitions = mockWorkflowDefinitions;
+    const lines = [
+      "# Workflow Definitions",
+      "",
+      "> Configure automated approval and process workflows",
+      ""
+    ];
+    for (const def of definitions) {
+      lines.push(`## ${def.name}`);
+      lines.push("");
+      lines.push(`**Type:** ${def.type} | **Status:** ${def.status}`);
+      lines.push("");
+      lines.push("### Steps");
+      lines.push("");
+      for (const step of def.steps) {
+        lines.push(`${step.order}. **${step.name}** - Roles: ${step.requiredRoles.join(", ")}`);
+      }
+      lines.push("");
+    }
+    return {
+      mimeType: "text/markdown",
+      body: lines.join(`
+`)
+    };
+  }
+};
+var workflowInstanceDetailMarkdownRenderer = {
+  target: "markdown",
+  render: async (desc) => {
+    if (desc.source.type !== "component" || desc.source.componentKey !== "WorkflowInstanceDetail") {
+      throw new Error("workflowInstanceDetailMarkdownRenderer: not WorkflowInstanceDetail");
+    }
+    const instance = mockWorkflowInstances[0];
+    if (!instance) {
+      return {
+        mimeType: "text/markdown",
+        body: `# No Workflow Instances
+
+No workflow instances available.`
+      };
+    }
+    const definition = mockWorkflowDefinitions.find((d) => d.id === instance.definitionId);
+    const lines = [
+      `# Workflow: ${instance.definitionName}`,
+      "",
+      `**Instance ID:** ${instance.id}`,
+      `**Status:** ${instance.status}`,
+      `**Requested By:** ${instance.requestedBy}`,
+      `**Started:** ${new Date(instance.startedAt).toLocaleString()}`,
+      "",
+      "## Steps Progress",
+      ""
+    ];
+    if (definition) {
+      for (const step of definition.steps) {
+        const isCurrent = step.id === instance.currentStepId;
+        const isCompleted = definition.steps.indexOf(step) < definition.steps.findIndex((s) => s.id === instance.currentStepId);
+        let status = "⬜ Pending";
+        if (isCompleted)
+          status = "✅ Completed";
+        if (isCurrent)
+          status = "\uD83D\uDD04 In Progress";
+        lines.push(`- ${status} **${step.name}**`);
+      }
+    }
+    lines.push("");
+    lines.push("## Actions");
+    lines.push("");
+    lines.push("- **Approve** - Move to next step");
+    lines.push("- **Reject** - Reject and return");
+    lines.push("- **Delegate** - Assign to another approver");
+    return {
+      mimeType: "text/markdown",
+      body: lines.join(`
+`)
+    };
+  }
+};
+export {
+  workflowInstanceDetailMarkdownRenderer,
+  workflowDefinitionListMarkdownRenderer,
+  workflowDashboardMarkdownRenderer
+};