@contractspec/example.workflow-system 1.57.0 → 1.58.0

package/dist/approval/index.js

@@ -1,6 +1,485 @@
-import { ApprovalDecisionEnum, ApprovalStatusEnum } from "./approval.enum.js";
-import { ApprovalCommentModel, ApprovalRequestModel } from "./approval.schema.js";
-import { AddApprovalCommentContract, DelegateApprovalContract, GetApprovalContract, ListMyApprovalsContract, SubmitDecisionContract } from "./approval.operations.js";
-import { ApprovalDecidedEvent, ApprovalDelegatedEvent, ApprovalEscalatedEvent, ApprovalRequestedEvent } from "./approval.event.js";
+// @bun
+// src/approval/approval.enum.ts
+import { defineEnum } from "@contractspec/lib.schema";
+var ApprovalStatusEnum = defineEnum("ApprovalStatus", [
+  "PENDING",
+  "APPROVED",
+  "REJECTED",
+  "DELEGATED",
+  "ESCALATED",
+  "WITHDRAWN",
+  "EXPIRED"
+]);
+var ApprovalDecisionEnum = defineEnum("ApprovalDecision", [
+  "APPROVE",
+  "REJECT",
+  "REQUEST_CHANGES",
+  "DELEGATE",
+  "ABSTAIN"
+]);
 
-export { AddApprovalCommentContract, ApprovalCommentModel, ApprovalDecidedEvent, ApprovalDecisionEnum, ApprovalDelegatedEvent, ApprovalEscalatedEvent, ApprovalRequestModel, ApprovalRequestedEvent, ApprovalStatusEnum, DelegateApprovalContract, GetApprovalContract, ListMyApprovalsContract, SubmitDecisionContract };
+// src/approval/approval.event.ts
+import { defineEvent, defineSchemaModel } from "@contractspec/lib.contracts";
+import { ScalarTypeEnum } from "@contractspec/lib.schema";
+var ApprovalRequestedPayload = defineSchemaModel({
+  name: "ApprovalRequestedEventPayload",
+  description: "Payload when approval is requested",
+  fields: {
+    requestId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    instanceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    workflowKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    approverId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    approverRole: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: true
+    },
+    title: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    dueAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var ApprovalDecidedPayload = defineSchemaModel({
+  name: "ApprovalDecidedEventPayload",
+  description: "Payload when approval decision is made",
+  fields: {
+    requestId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    instanceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    decision: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    decidedBy: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    comment: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var ApprovalDelegatedPayload = defineSchemaModel({
+  name: "ApprovalDelegatedEventPayload",
+  description: "Payload when approval is delegated",
+  fields: {
+    requestId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    instanceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    fromUserId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    toUserId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    reason: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var ApprovalEscalatedPayload = defineSchemaModel({
+  name: "ApprovalEscalatedEventPayload",
+  description: "Payload when approval is escalated",
+  fields: {
+    requestId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    instanceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    escalationLevel: {
+      type: ScalarTypeEnum.Int_unsecure(),
+      isOptional: false
+    },
+    escalatedTo: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    reason: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var ApprovalRequestedEvent = defineEvent({
+  meta: {
+    key: "workflow.approval.requested",
+    version: "1.0.0",
+    description: "An approval has been requested.",
+    stability: "stable",
+    owners: ["@workflow-team"],
+    tags: ["workflow", "approval", "requested"]
+  },
+  payload: ApprovalRequestedPayload
+});
+var ApprovalDecidedEvent = defineEvent({
+  meta: {
+    key: "workflow.approval.decided",
+    version: "1.0.0",
+    description: "An approval decision has been made.",
+    stability: "stable",
+    owners: ["@workflow-team"],
+    tags: ["workflow", "approval", "decided"]
+  },
+  payload: ApprovalDecidedPayload
+});
+var ApprovalDelegatedEvent = defineEvent({
+  meta: {
+    key: "workflow.approval.delegated",
+    version: "1.0.0",
+    description: "An approval has been delegated.",
+    stability: "stable",
+    owners: ["@workflow-team"],
+    tags: ["workflow", "approval", "delegated"]
+  },
+  payload: ApprovalDelegatedPayload
+});
+var ApprovalEscalatedEvent = defineEvent({
+  meta: {
+    key: "workflow.approval.escalated",
+    version: "1.0.0",
+    description: "An approval has been escalated.",
+    stability: "stable",
+    owners: ["@workflow-team"],
+    tags: ["workflow", "approval", "escalated"]
+  },
+  payload: ApprovalEscalatedPayload
+});
+
+// src/approval/approval.schema.ts
+import { defineSchemaModel as defineSchemaModel2, ScalarTypeEnum as ScalarTypeEnum2 } from "@contractspec/lib.schema";
+var ApprovalRequestModel = defineSchemaModel2({
+  name: "ApprovalRequestModel",
+  description: "An approval request",
+  fields: {
+    id: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    workflowInstanceId: {
+      type: ScalarTypeEnum2.String_unsecure(),
+      isOptional: false
+    },
+    stepExecutionId: {
+      type: ScalarTypeEnum2.String_unsecure(),
+      isOptional: false
+    },
+    approverId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    approverRole: {
+      type: ScalarTypeEnum2.String_unsecure(),
+      isOptional: true
+    },
+    title: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    description: { type: ScalarTypeEnum2.String_unsecure(), isOptional: true },
+    status: { type: ApprovalStatusEnum, isOptional: false },
+    decision: { type: ApprovalDecisionEnum, isOptional: true },
+    decisionComment: {
+      type: ScalarTypeEnum2.String_unsecure(),
+      isOptional: true
+    },
+    decidedAt: { type: ScalarTypeEnum2.DateTime(), isOptional: true },
+    dueAt: { type: ScalarTypeEnum2.DateTime(), isOptional: true },
+    contextSnapshot: { type: ScalarTypeEnum2.JSON(), isOptional: true },
+    sequenceOrder: { type: ScalarTypeEnum2.Int_unsecure(), isOptional: false },
+    createdAt: { type: ScalarTypeEnum2.DateTime(), isOptional: false }
+  }
+});
+var ApprovalCommentModel = defineSchemaModel2({
+  name: "ApprovalCommentModel",
+  description: "A comment on an approval",
+  fields: {
+    id: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    approvalRequestId: {
+      type: ScalarTypeEnum2.String_unsecure(),
+      isOptional: false
+    },
+    authorId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    content: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    isInternal: { type: ScalarTypeEnum2.Boolean(), isOptional: false },
+    createdAt: { type: ScalarTypeEnum2.DateTime(), isOptional: false }
+  }
+});
+
+// src/approval/approval.operations.ts
+import {
+  defineCommand,
+  defineQuery
+} from "@contractspec/lib.contracts/operations";
+import { defineSchemaModel as defineSchemaModel3, ScalarTypeEnum as ScalarTypeEnum3 } from "@contractspec/lib.schema";
+var OWNERS = ["@example.workflow-system"];
+var SubmitDecisionContract = defineCommand({
+  meta: {
+    key: "workflow.approval.decide",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["workflow", "approval", "decision"],
+    description: "Submit an approval decision (approve/reject).",
+    goal: "Allow approvers to make decisions on requests.",
+    context: "Approval inbox, workflow detail."
+  },
+  io: {
+    input: defineSchemaModel3({
+      name: "ApproveRejectInput",
+      fields: {
+        requestId: {
+          type: ScalarTypeEnum3.String_unsecure(),
+          isOptional: false
+        },
+        decision: { type: ApprovalDecisionEnum, isOptional: false },
+        comment: { type: ScalarTypeEnum3.String_unsecure(), isOptional: true },
+        data: { type: ScalarTypeEnum3.JSON(), isOptional: true }
+      }
+    }),
+    output: ApprovalRequestModel
+  },
+  policy: { auth: "user" },
+  sideEffects: {
+    emits: [
+      {
+        key: "workflow.approval.decided",
+        version: "1.0.0",
+        when: "Decision is made",
+        payload: ApprovalRequestModel
+      }
+    ],
+    audit: ["workflow.approval.decided"]
+  },
+  acceptance: {
+    scenarios: [
+      {
+        key: "approve-request-happy-path",
+        given: ["Approval request is pending", "User is assignee"],
+        when: ["User approves request"],
+        then: ["Request is approved", "ApprovalDecided event is emitted"]
+      }
+    ],
+    examples: [
+      {
+        key: "approve-basic",
+        input: {
+          requestId: "req-123",
+          decision: "approve",
+          comment: "Looks good"
+        },
+        output: { id: "req-123", status: "approved" }
+      }
+    ]
+  }
+});
+var DelegateApprovalContract = defineCommand({
+  meta: {
+    key: "workflow.approval.delegate",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["workflow", "approval", "delegate"],
+    description: "Delegate an approval request to another user.",
+    goal: "Allow approvers to pass approval to others.",
+    context: "Approval inbox."
+  },
+  io: {
+    input: defineSchemaModel3({
+      name: "DelegateInput",
+      fields: {
+        requestId: {
+          type: ScalarTypeEnum3.String_unsecure(),
+          isOptional: false
+        },
+        delegateTo: {
+          type: ScalarTypeEnum3.String_unsecure(),
+          isOptional: false
+        },
+        reason: { type: ScalarTypeEnum3.String_unsecure(), isOptional: true }
+      }
+    }),
+    output: ApprovalRequestModel
+  },
+  policy: { auth: "user" },
+  sideEffects: {
+    emits: [
+      {
+        key: "workflow.approval.delegated",
+        version: "1.0.0",
+        when: "Approval is delegated",
+        payload: ApprovalRequestModel
+      }
+    ],
+    audit: ["workflow.approval.delegated"]
+  },
+  acceptance: {
+    scenarios: [
+      {
+        key: "delegate-approval-happy-path",
+        given: ["Approval request is pending", "User is assignee"],
+        when: ["User delegates to another user"],
+        then: ["Assignee is updated", "ApprovalDelegated event is emitted"]
+      }
+    ],
+    examples: [
+      {
+        key: "delegate-to-manager",
+        input: {
+          requestId: "req-123",
+          delegateTo: "user-456",
+          reason: "Out of office"
+        },
+        output: { id: "req-123", assigneeId: "user-456" }
+      }
+    ]
+  }
+});
+var AddApprovalCommentContract = defineCommand({
+  meta: {
+    key: "workflow.approval.comment.add",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["workflow", "approval", "comment"],
+    description: "Add a comment to an approval request.",
+    goal: "Allow discussion on approval requests.",
+    context: "Approval detail view."
+  },
+  io: {
+    input: defineSchemaModel3({
+      name: "AddCommentInput",
+      fields: {
+        requestId: {
+          type: ScalarTypeEnum3.String_unsecure(),
+          isOptional: false
+        },
+        content: { type: ScalarTypeEnum3.NonEmptyString(), isOptional: false },
+        isInternal: { type: ScalarTypeEnum3.Boolean(), isOptional: true }
+      }
+    }),
+    output: ApprovalCommentModel
+  },
+  policy: { auth: "user" },
+  sideEffects: {
+    emits: [
+      {
+        key: "workflow.approval.comment.added",
+        version: "1.0.0",
+        when: "Comment is added",
+        payload: ApprovalCommentModel
+      }
+    ]
+  },
+  acceptance: {
+    scenarios: [
+      {
+        key: "add-comment-happy-path",
+        given: ["Approval request exists"],
+        when: ["User adds a comment"],
+        then: ["Comment is added", "CommentAdded event is emitted"]
+      }
+    ],
+    examples: [
+      {
+        key: "add-question",
+        input: {
+          requestId: "req-123",
+          content: "Can you clarify budget?",
+          isInternal: false
+        },
+        output: { id: "com-789", content: "Can you clarify budget?" }
+      }
+    ]
+  }
+});
+var ListMyApprovalsContract = defineQuery({
+  meta: {
+    key: "workflow.approval.list.mine",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["workflow", "approval", "list", "inbox"],
+    description: "List approval requests assigned to current user.",
+    goal: "Show pending approvals in user inbox.",
+    context: "Approval inbox, dashboard widget."
+  },
+  io: {
+    input: defineSchemaModel3({
+      name: "ListMyApprovalsInput",
+      fields: {
+        status: { type: ApprovalStatusEnum, isOptional: true },
+        limit: {
+          type: ScalarTypeEnum3.Int_unsecure(),
+          isOptional: true,
+          defaultValue: 20
+        },
+        offset: {
+          type: ScalarTypeEnum3.Int_unsecure(),
+          isOptional: true,
+          defaultValue: 0
+        }
+      }
+    }),
+    output: defineSchemaModel3({
+      name: "ListMyApprovalsOutput",
+      fields: {
+        requests: {
+          type: ApprovalRequestModel,
+          isArray: true,
+          isOptional: false
+        },
+        total: { type: ScalarTypeEnum3.Int_unsecure(), isOptional: false },
+        pendingCount: {
+          type: ScalarTypeEnum3.Int_unsecure(),
+          isOptional: false
+        }
+      }
+    })
+  },
+  policy: { auth: "user" },
+  acceptance: {
+    scenarios: [
+      {
+        key: "list-approvals-happy-path",
+        given: ["User has assigned approvals"],
+        when: ["User lists approvals"],
+        then: ["List of requests is returned"]
+      }
+    ],
+    examples: [
+      {
+        key: "list-pending",
+        input: { status: "pending", limit: 10 },
+        output: { requests: [], total: 2, pendingCount: 2 }
+      }
+    ]
+  }
+});
+var GetApprovalContract = defineQuery({
+  meta: {
+    key: "workflow.approval.get",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["workflow", "approval", "get"],
+    description: "Get an approval request with details.",
+    goal: "View approval request details.",
+    context: "Approval detail view."
+  },
+  io: {
+    input: defineSchemaModel3({
+      name: "GetApprovalInput",
+      fields: {
+        requestId: {
+          type: ScalarTypeEnum3.String_unsecure(),
+          isOptional: false
+        }
+      }
+    }),
+    output: ApprovalRequestModel
+  },
+  policy: { auth: "user" },
+  acceptance: {
+    scenarios: [
+      {
+        key: "get-approval-happy-path",
+        given: ["Approval request exists"],
+        when: ["User requests approval details"],
+        then: ["Approval details are returned"]
+      }
+    ],
+    examples: [
+      {
+        key: "get-basic",
+        input: { requestId: "req-123" },
+        output: { id: "req-123", status: "pending" }
+      }
+    ]
+  }
+});
+export {
+  SubmitDecisionContract,
+  ListMyApprovalsContract,
+  GetApprovalContract,
+  DelegateApprovalContract,
+  ApprovalStatusEnum,
+  ApprovalRequestedEvent,
+  ApprovalRequestModel,
+  ApprovalEscalatedEvent,
+  ApprovalDelegatedEvent,
+  ApprovalDecisionEnum,
+  ApprovalDecidedEvent,
+  ApprovalCommentModel,
+  AddApprovalCommentContract
+};

package/dist/browser/approval/approval.enum.js

@@ -0,0 +1,22 @@
+// src/approval/approval.enum.ts
+import { defineEnum } from "@contractspec/lib.schema";
+var ApprovalStatusEnum = defineEnum("ApprovalStatus", [
+  "PENDING",
+  "APPROVED",
+  "REJECTED",
+  "DELEGATED",
+  "ESCALATED",
+  "WITHDRAWN",
+  "EXPIRED"
+]);
+var ApprovalDecisionEnum = defineEnum("ApprovalDecision", [
+  "APPROVE",
+  "REJECT",
+  "REQUEST_CHANGES",
+  "DELEGATE",
+  "ABSTAIN"
+]);
+export {
+  ApprovalStatusEnum,
+  ApprovalDecisionEnum
+};

package/dist/browser/approval/approval.event.js

@@ -0,0 +1,112 @@
+// src/approval/approval.event.ts
+import { defineEvent, defineSchemaModel } from "@contractspec/lib.contracts";
+import { ScalarTypeEnum } from "@contractspec/lib.schema";
+var ApprovalRequestedPayload = defineSchemaModel({
+  name: "ApprovalRequestedEventPayload",
+  description: "Payload when approval is requested",
+  fields: {
+    requestId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    instanceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    workflowKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    approverId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    approverRole: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: true
+    },
+    title: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    dueAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var ApprovalDecidedPayload = defineSchemaModel({
+  name: "ApprovalDecidedEventPayload",
+  description: "Payload when approval decision is made",
+  fields: {
+    requestId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    instanceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    decision: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    decidedBy: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    comment: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var ApprovalDelegatedPayload = defineSchemaModel({
+  name: "ApprovalDelegatedEventPayload",
+  description: "Payload when approval is delegated",
+  fields: {
+    requestId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    instanceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    fromUserId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    toUserId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    reason: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var ApprovalEscalatedPayload = defineSchemaModel({
+  name: "ApprovalEscalatedEventPayload",
+  description: "Payload when approval is escalated",
+  fields: {
+    requestId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    instanceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    escalationLevel: {
+      type: ScalarTypeEnum.Int_unsecure(),
+      isOptional: false
+    },
+    escalatedTo: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    reason: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var ApprovalRequestedEvent = defineEvent({
+  meta: {
+    key: "workflow.approval.requested",
+    version: "1.0.0",
+    description: "An approval has been requested.",
+    stability: "stable",
+    owners: ["@workflow-team"],
+    tags: ["workflow", "approval", "requested"]
+  },
+  payload: ApprovalRequestedPayload
+});
+var ApprovalDecidedEvent = defineEvent({
+  meta: {
+    key: "workflow.approval.decided",
+    version: "1.0.0",
+    description: "An approval decision has been made.",
+    stability: "stable",
+    owners: ["@workflow-team"],
+    tags: ["workflow", "approval", "decided"]
+  },
+  payload: ApprovalDecidedPayload
+});
+var ApprovalDelegatedEvent = defineEvent({
+  meta: {
+    key: "workflow.approval.delegated",
+    version: "1.0.0",
+    description: "An approval has been delegated.",
+    stability: "stable",
+    owners: ["@workflow-team"],
+    tags: ["workflow", "approval", "delegated"]
+  },
+  payload: ApprovalDelegatedPayload
+});
+var ApprovalEscalatedEvent = defineEvent({
+  meta: {
+    key: "workflow.approval.escalated",
+    version: "1.0.0",
+    description: "An approval has been escalated.",
+    stability: "stable",
+    owners: ["@workflow-team"],
+    tags: ["workflow", "approval", "escalated"]
+  },
+  payload: ApprovalEscalatedPayload
+});
+export {
+  ApprovalRequestedEvent,
+  ApprovalEscalatedEvent,
+  ApprovalDelegatedEvent,
+  ApprovalDecidedEvent
+};