@contractspec/example.workflow-system 3.7.6 → 3.8.2

package/dist/browser/visualizations/catalog.js

@@ -0,0 +1,132 @@
+// 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
+}));
+export {
+  WorkflowVisualizationSpecs,
+  WorkflowVisualizationRegistry,
+  WorkflowVisualizationRefs,
+  WorkflowThroughputVisualization,
+  WorkflowInstanceStatusVisualization,
+  WorkflowCompletedMetricVisualization,
+  WorkflowActiveMetricVisualization
+};

package/dist/browser/visualizations/index.js

@@ -0,0 +1,133 @@
+// 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
+}));
+export {
+  createWorkflowVisualizationSections,
+  WorkflowVisualizationSpecs,
+  WorkflowVisualizationRegistry,
+  WorkflowVisualizationRefs,
+  WorkflowThroughputVisualization,
+  WorkflowInstanceStatusVisualization,
+  WorkflowCompletedMetricVisualization,
+  WorkflowActiveMetricVisualization
+};

package/dist/browser/visualizations/selectors.js

@@ -0,0 +1,195 @@
+// 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
+  };
+}
+export {
+  createWorkflowVisualizationSections
+};

package/dist/entities/index.d.ts

@@ -1,7 +1,7 @@
-export { WorkflowStatusEnum, WorkflowTriggerTypeEnum, WorkflowDefinitionEntity, } from './workflow';
-export { StepTypeEnum, ApprovalModeEnum, WorkflowStepEntity } from './step';
-export { InstanceStatusEnum, StepExecutionStatusEnum, WorkflowInstanceEntity, StepExecutionEntity, } from './instance';
-export { ApprovalStatusEnum, ApprovalDecisionEnum, ApprovalRequestEntity, ApprovalCommentEntity, } from './approval';
+export { ApprovalCommentEntity, ApprovalDecisionEnum, ApprovalRequestEntity, ApprovalStatusEnum, } from './approval';
+export { InstanceStatusEnum, StepExecutionEntity, StepExecutionStatusEnum, WorkflowInstanceEntity, } from './instance';
+export { ApprovalModeEnum, StepTypeEnum, WorkflowStepEntity } from './step';
+export { WorkflowDefinitionEntity, WorkflowStatusEnum, WorkflowTriggerTypeEnum, } from './workflow';
 import type { ModuleSchemaContribution } from '@contractspec/lib.schema';
 export declare const workflowSystemEntities: (import("@contractspec/lib.schema").EntitySpec<{
     id: import("@contractspec/lib.schema").EntityScalarField;
@@ -36,55 +36,6 @@ export declare const workflowSystemEntities: (import("@contractspec/lib.schema")
     createdAt: import("@contractspec/lib.schema").EntityScalarField;
     updatedAt: import("@contractspec/lib.schema").EntityScalarField;
     approvalRequest: import("@contractspec/lib.schema").EntityRelationField;
-}> | import("@contractspec/lib.schema").EntitySpec<{
-    id: import("@contractspec/lib.schema").EntityScalarField;
-    name: import("@contractspec/lib.schema").EntityScalarField;
-    key: import("@contractspec/lib.schema").EntityScalarField;
-    description: import("@contractspec/lib.schema").EntityScalarField;
-    version: import("@contractspec/lib.schema").EntityScalarField;
-    status: import("@contractspec/lib.schema").EntityEnumField;
-    triggerType: import("@contractspec/lib.schema").EntityEnumField;
-    triggerConfig: import("@contractspec/lib.schema").EntityScalarField;
-    initialStepId: import("@contractspec/lib.schema").EntityScalarField;
-    featureFlagKey: import("@contractspec/lib.schema").EntityScalarField;
-    settings: import("@contractspec/lib.schema").EntityScalarField;
-    metadata: import("@contractspec/lib.schema").EntityScalarField;
-    organizationId: import("@contractspec/lib.schema").EntityScalarField;
-    createdBy: import("@contractspec/lib.schema").EntityScalarField;
-    createdAt: import("@contractspec/lib.schema").EntityScalarField;
-    updatedAt: import("@contractspec/lib.schema").EntityScalarField;
-    publishedAt: import("@contractspec/lib.schema").EntityScalarField;
-    steps: import("@contractspec/lib.schema").EntityRelationField;
-    instances: import("@contractspec/lib.schema").EntityRelationField;
-}> | import("@contractspec/lib.schema").EntitySpec<{
-    id: import("@contractspec/lib.schema").EntityScalarField;
-    workflowDefinitionId: import("@contractspec/lib.schema").EntityScalarField;
-    name: import("@contractspec/lib.schema").EntityScalarField;
-    key: import("@contractspec/lib.schema").EntityScalarField;
-    description: import("@contractspec/lib.schema").EntityScalarField;
-    type: import("@contractspec/lib.schema").EntityEnumField;
-    position: import("@contractspec/lib.schema").EntityScalarField;
-    transitions: import("@contractspec/lib.schema").EntityScalarField;
-    approvalMode: import("@contractspec/lib.schema").EntityEnumField;
-    approverRoles: import("@contractspec/lib.schema").EntityScalarField;
-    approverUserIds: import("@contractspec/lib.schema").EntityScalarField;
-    escalationConfig: import("@contractspec/lib.schema").EntityScalarField;
-    assigneeRoles: import("@contractspec/lib.schema").EntityScalarField;
-    taskTemplate: import("@contractspec/lib.schema").EntityScalarField;
-    conditionExpression: import("@contractspec/lib.schema").EntityScalarField;
-    waitDuration: import("@contractspec/lib.schema").EntityScalarField;
-    waitForEvent: import("@contractspec/lib.schema").EntityScalarField;
-    actionType: import("@contractspec/lib.schema").EntityScalarField;
-    actionConfig: import("@contractspec/lib.schema").EntityScalarField;
-    timeoutSeconds: import("@contractspec/lib.schema").EntityScalarField;
-    slaSeconds: import("@contractspec/lib.schema").EntityScalarField;
-    notifyOnEnter: import("@contractspec/lib.schema").EntityScalarField;
-    notifyOnExit: import("@contractspec/lib.schema").EntityScalarField;
-    metadata: import("@contractspec/lib.schema").EntityScalarField;
-    createdAt: import("@contractspec/lib.schema").EntityScalarField;
-    updatedAt: import("@contractspec/lib.schema").EntityScalarField;
-    workflowDefinition: import("@contractspec/lib.schema").EntityRelationField;
-    executions: import("@contractspec/lib.schema").EntityRelationField;
 }> | import("@contractspec/lib.schema").EntitySpec<{
     id: import("@contractspec/lib.schema").EntityScalarField;
     workflowDefinitionId: import("@contractspec/lib.schema").EntityScalarField;
@@ -129,5 +80,54 @@ export declare const workflowSystemEntities: (import("@contractspec/lib.schema")
     completedAt: import("@contractspec/lib.schema").EntityScalarField;
     workflowInstance: import("@contractspec/lib.schema").EntityRelationField;
     workflowStep: import("@contractspec/lib.schema").EntityRelationField;
+}> | import("@contractspec/lib.schema").EntitySpec<{
+    id: import("@contractspec/lib.schema").EntityScalarField;
+    workflowDefinitionId: import("@contractspec/lib.schema").EntityScalarField;
+    name: import("@contractspec/lib.schema").EntityScalarField;
+    key: import("@contractspec/lib.schema").EntityScalarField;
+    description: import("@contractspec/lib.schema").EntityScalarField;
+    type: import("@contractspec/lib.schema").EntityEnumField;
+    position: import("@contractspec/lib.schema").EntityScalarField;
+    transitions: import("@contractspec/lib.schema").EntityScalarField;
+    approvalMode: import("@contractspec/lib.schema").EntityEnumField;
+    approverRoles: import("@contractspec/lib.schema").EntityScalarField;
+    approverUserIds: import("@contractspec/lib.schema").EntityScalarField;
+    escalationConfig: import("@contractspec/lib.schema").EntityScalarField;
+    assigneeRoles: import("@contractspec/lib.schema").EntityScalarField;
+    taskTemplate: import("@contractspec/lib.schema").EntityScalarField;
+    conditionExpression: import("@contractspec/lib.schema").EntityScalarField;
+    waitDuration: import("@contractspec/lib.schema").EntityScalarField;
+    waitForEvent: import("@contractspec/lib.schema").EntityScalarField;
+    actionType: import("@contractspec/lib.schema").EntityScalarField;
+    actionConfig: import("@contractspec/lib.schema").EntityScalarField;
+    timeoutSeconds: import("@contractspec/lib.schema").EntityScalarField;
+    slaSeconds: import("@contractspec/lib.schema").EntityScalarField;
+    notifyOnEnter: import("@contractspec/lib.schema").EntityScalarField;
+    notifyOnExit: import("@contractspec/lib.schema").EntityScalarField;
+    metadata: import("@contractspec/lib.schema").EntityScalarField;
+    createdAt: import("@contractspec/lib.schema").EntityScalarField;
+    updatedAt: import("@contractspec/lib.schema").EntityScalarField;
+    workflowDefinition: import("@contractspec/lib.schema").EntityRelationField;
+    executions: import("@contractspec/lib.schema").EntityRelationField;
+}> | import("@contractspec/lib.schema").EntitySpec<{
+    id: import("@contractspec/lib.schema").EntityScalarField;
+    name: import("@contractspec/lib.schema").EntityScalarField;
+    key: import("@contractspec/lib.schema").EntityScalarField;
+    description: import("@contractspec/lib.schema").EntityScalarField;
+    version: import("@contractspec/lib.schema").EntityScalarField;
+    status: import("@contractspec/lib.schema").EntityEnumField;
+    triggerType: import("@contractspec/lib.schema").EntityEnumField;
+    triggerConfig: import("@contractspec/lib.schema").EntityScalarField;
+    initialStepId: import("@contractspec/lib.schema").EntityScalarField;
+    featureFlagKey: import("@contractspec/lib.schema").EntityScalarField;
+    settings: import("@contractspec/lib.schema").EntityScalarField;
+    metadata: import("@contractspec/lib.schema").EntityScalarField;
+    organizationId: import("@contractspec/lib.schema").EntityScalarField;
+    createdBy: import("@contractspec/lib.schema").EntityScalarField;
+    createdAt: import("@contractspec/lib.schema").EntityScalarField;
+    updatedAt: import("@contractspec/lib.schema").EntityScalarField;
+    publishedAt: import("@contractspec/lib.schema").EntityScalarField;
+    steps: import("@contractspec/lib.schema").EntityRelationField;
+    instances: import("@contractspec/lib.schema").EntityRelationField;
 }>)[];
 export declare const workflowSystemSchemaContribution: ModuleSchemaContribution;