@contractspec/example.crm-pipeline 1.57.0 → 1.59.0

package/dist/browser/deal/deal.operation.js

@@ -0,0 +1,396 @@
+// src/deal/deal.enum.ts
+import { defineEnum } from "@contractspec/lib.schema";
+var DealStatusEnum = defineEnum("DealStatus", [
+  "OPEN",
+  "WON",
+  "LOST",
+  "STALE"
+]);
+var DealStatusFilterEnum = defineEnum("DealStatusFilter", [
+  "OPEN",
+  "WON",
+  "LOST",
+  "all"
+]);
+
+// src/deal/deal.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var DealModel = defineSchemaModel({
+  name: "Deal",
+  description: "A deal in the CRM pipeline",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    value: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+    currency: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    pipelineId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    stageId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    status: { type: DealStatusEnum, isOptional: false },
+    contactId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    companyId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    ownerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    expectedCloseDate: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    createdAt: { type: ScalarTypeEnum.DateTime(), isOptional: false },
+    updatedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var CreateDealInputModel = defineSchemaModel({
+  name: "CreateDealInput",
+  description: "Input for creating a deal",
+  fields: {
+    name: { type: ScalarTypeEnum.NonEmptyString(), isOptional: false },
+    value: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+    currency: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    pipelineId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    stageId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    contactId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    companyId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    expectedCloseDate: { type: ScalarTypeEnum.DateTime(), isOptional: true }
+  }
+});
+var MoveDealInputModel = defineSchemaModel({
+  name: "MoveDealInput",
+  description: "Input for moving a deal to another stage",
+  fields: {
+    dealId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    stageId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    position: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true }
+  }
+});
+var DealMovedPayloadModel = defineSchemaModel({
+  name: "DealMovedPayload",
+  fields: {
+    dealId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    fromStage: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    toStage: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var WinDealInputModel = defineSchemaModel({
+  name: "WinDealInput",
+  description: "Input for marking a deal as won",
+  fields: {
+    dealId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    wonSource: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    notes: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+var DealWonPayloadModel = defineSchemaModel({
+  name: "DealWonPayload",
+  fields: {
+    dealId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    value: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false }
+  }
+});
+var LoseDealInputModel = defineSchemaModel({
+  name: "LoseDealInput",
+  description: "Input for marking a deal as lost",
+  fields: {
+    dealId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    lostReason: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    notes: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+var DealLostPayloadModel = defineSchemaModel({
+  name: "DealLostPayload",
+  fields: {
+    dealId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    reason: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var ListDealsInputModel = defineSchemaModel({
+  name: "ListDealsInput",
+  description: "Input for listing deals",
+  fields: {
+    pipelineId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    stageId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    status: { type: DealStatusFilterEnum, isOptional: true },
+    ownerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    search: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    limit: {
+      type: ScalarTypeEnum.Int_unsecure(),
+      isOptional: true,
+      defaultValue: 20
+    },
+    offset: {
+      type: ScalarTypeEnum.Int_unsecure(),
+      isOptional: true,
+      defaultValue: 0
+    }
+  }
+});
+var ListDealsOutputModel = defineSchemaModel({
+  name: "ListDealsOutput",
+  description: "Output for listing deals",
+  fields: {
+    deals: { type: DealModel, isArray: true, isOptional: false },
+    total: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    totalValue: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false }
+  }
+});
+
+// src/deal/deal.operation.ts
+import {
+  defineCommand,
+  defineQuery
+} from "@contractspec/lib.contracts/operations";
+var OWNERS = ["@example.crm-pipeline"];
+var CreateDealContract = defineCommand({
+  meta: {
+    key: "crm.deal.create",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["crm", "deal", "create"],
+    description: "Create a new deal in the pipeline.",
+    goal: "Allow sales reps to create new opportunities.",
+    context: "Deal creation UI, quick add."
+  },
+  io: {
+    input: CreateDealInputModel,
+    output: DealModel
+  },
+  policy: {
+    auth: "user"
+  },
+  sideEffects: {
+    emits: [
+      {
+        key: "deal.created",
+        version: "1.0.0",
+        when: "Deal is created",
+        payload: DealModel
+      }
+    ],
+    audit: ["deal.created"]
+  },
+  acceptance: {
+    scenarios: [
+      {
+        key: "create-deal-happy-path",
+        given: ["User is authenticated"],
+        when: ["User creates a deal with valid data"],
+        then: ["Deal is created", "DealCreated event is emitted"]
+      }
+    ],
+    examples: [
+      {
+        key: "create-basic-deal",
+        input: {
+          title: "Big Corp Q3 License",
+          stageId: "stage-lead",
+          value: 50000,
+          companyId: "comp-123"
+        },
+        output: {
+          id: "deal-789",
+          title: "Big Corp Q3 License",
+          status: "open"
+        }
+      }
+    ]
+  }
+});
+var MoveDealContract = defineCommand({
+  meta: {
+    key: "crm.deal.move",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["crm", "deal", "move", "kanban"],
+    description: "Move a deal to a different stage.",
+    goal: "Allow drag-and-drop stage movement in Kanban.",
+    context: "Pipeline Kanban view."
+  },
+  io: {
+    input: MoveDealInputModel,
+    output: DealModel
+  },
+  policy: {
+    auth: "user"
+  },
+  sideEffects: {
+    emits: [
+      {
+        key: "deal.moved",
+        version: "1.0.0",
+        when: "Deal stage changed",
+        payload: DealMovedPayloadModel
+      }
+    ],
+    audit: ["deal.moved"]
+  },
+  acceptance: {
+    scenarios: [
+      {
+        key: "move-deal-happy-path",
+        given: ["Deal exists in stage A"],
+        when: ["User moves deal to stage B"],
+        then: ["Deal stage is updated", "DealMoved event is emitted"]
+      }
+    ],
+    examples: [
+      {
+        key: "move-to-negotiation",
+        input: { dealId: "deal-789", targetStageId: "stage-negotiation" },
+        output: {
+          id: "deal-789",
+          stageId: "stage-negotiation",
+          movedAt: "2025-01-15T10:00:00Z"
+        }
+      }
+    ]
+  }
+});
+var WinDealContract = defineCommand({
+  meta: {
+    key: "crm.deal.win",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["crm", "deal", "won"],
+    description: "Mark a deal as won.",
+    goal: "Close a deal as successful.",
+    context: "Deal closing flow."
+  },
+  io: {
+    input: WinDealInputModel,
+    output: DealModel
+  },
+  policy: {
+    auth: "user"
+  },
+  sideEffects: {
+    emits: [
+      {
+        key: "deal.won",
+        version: "1.0.0",
+        when: "Deal is won",
+        payload: DealWonPayloadModel
+      }
+    ],
+    audit: ["deal.won"]
+  },
+  acceptance: {
+    scenarios: [
+      {
+        key: "win-deal-happy-path",
+        given: ["Deal is open"],
+        when: ["User marks deal as won"],
+        then: ["Deal status becomes WON", "DealWon event is emitted"]
+      }
+    ],
+    examples: [
+      {
+        key: "mark-won",
+        input: {
+          dealId: "deal-789",
+          actualValue: 52000,
+          note: "Signed contract attached"
+        },
+        output: {
+          id: "deal-789",
+          status: "won",
+          closedAt: "2025-01-20T14:30:00Z"
+        }
+      }
+    ]
+  }
+});
+var LoseDealContract = defineCommand({
+  meta: {
+    key: "crm.deal.lose",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["crm", "deal", "lost"],
+    description: "Mark a deal as lost.",
+    goal: "Close a deal as unsuccessful.",
+    context: "Deal closing flow."
+  },
+  io: {
+    input: LoseDealInputModel,
+    output: DealModel
+  },
+  policy: {
+    auth: "user"
+  },
+  sideEffects: {
+    emits: [
+      {
+        key: "deal.lost",
+        version: "1.0.0",
+        when: "Deal is lost",
+        payload: DealLostPayloadModel
+      }
+    ],
+    audit: ["deal.lost"]
+  },
+  acceptance: {
+    scenarios: [
+      {
+        key: "lose-deal-happy-path",
+        given: ["Deal is open"],
+        when: ["User marks deal as lost"],
+        then: ["Deal status becomes LOST", "DealLost event is emitted"]
+      }
+    ],
+    examples: [
+      {
+        key: "mark-lost",
+        input: {
+          dealId: "deal-789",
+          reason: "competitor",
+          note: "Went with cheaper option"
+        },
+        output: {
+          id: "deal-789",
+          status: "lost",
+          closedAt: "2025-01-21T09:00:00Z"
+        }
+      }
+    ]
+  }
+});
+var ListDealsContract = defineQuery({
+  meta: {
+    key: "crm.deal.list",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["crm", "deal", "list"],
+    description: "List deals with filters.",
+    goal: "Show pipeline, deal lists, dashboards.",
+    context: "Pipeline view, deal list."
+  },
+  io: {
+    input: ListDealsInputModel,
+    output: ListDealsOutputModel
+  },
+  policy: {
+    auth: "user"
+  },
+  acceptance: {
+    scenarios: [
+      {
+        key: "list-deals-happy-path",
+        given: ["User has access to deals"],
+        when: ["User lists deals"],
+        then: ["List of deals is returned"]
+      }
+    ],
+    examples: [
+      {
+        key: "list-filter-stage",
+        input: { stageId: "stage-lead", limit: 20 },
+        output: { items: [], total: 5, hasMore: false }
+      }
+    ]
+  }
+});
+export {
+  WinDealContract,
+  MoveDealContract,
+  LoseDealContract,
+  ListDealsContract,
+  CreateDealContract
+};

package/dist/browser/deal/deal.schema.js

@@ -0,0 +1,141 @@
+// src/deal/deal.enum.ts
+import { defineEnum } from "@contractspec/lib.schema";
+var DealStatusEnum = defineEnum("DealStatus", [
+  "OPEN",
+  "WON",
+  "LOST",
+  "STALE"
+]);
+var DealStatusFilterEnum = defineEnum("DealStatusFilter", [
+  "OPEN",
+  "WON",
+  "LOST",
+  "all"
+]);
+
+// src/deal/deal.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var DealModel = defineSchemaModel({
+  name: "Deal",
+  description: "A deal in the CRM pipeline",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    value: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+    currency: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    pipelineId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    stageId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    status: { type: DealStatusEnum, isOptional: false },
+    contactId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    companyId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    ownerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    expectedCloseDate: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    createdAt: { type: ScalarTypeEnum.DateTime(), isOptional: false },
+    updatedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var CreateDealInputModel = defineSchemaModel({
+  name: "CreateDealInput",
+  description: "Input for creating a deal",
+  fields: {
+    name: { type: ScalarTypeEnum.NonEmptyString(), isOptional: false },
+    value: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
+    currency: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    pipelineId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    stageId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    contactId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    companyId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    expectedCloseDate: { type: ScalarTypeEnum.DateTime(), isOptional: true }
+  }
+});
+var MoveDealInputModel = defineSchemaModel({
+  name: "MoveDealInput",
+  description: "Input for moving a deal to another stage",
+  fields: {
+    dealId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    stageId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    position: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true }
+  }
+});
+var DealMovedPayloadModel = defineSchemaModel({
+  name: "DealMovedPayload",
+  fields: {
+    dealId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    fromStage: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    toStage: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var WinDealInputModel = defineSchemaModel({
+  name: "WinDealInput",
+  description: "Input for marking a deal as won",
+  fields: {
+    dealId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    wonSource: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    notes: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+var DealWonPayloadModel = defineSchemaModel({
+  name: "DealWonPayload",
+  fields: {
+    dealId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    value: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false }
+  }
+});
+var LoseDealInputModel = defineSchemaModel({
+  name: "LoseDealInput",
+  description: "Input for marking a deal as lost",
+  fields: {
+    dealId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    lostReason: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    notes: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+var DealLostPayloadModel = defineSchemaModel({
+  name: "DealLostPayload",
+  fields: {
+    dealId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    reason: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var ListDealsInputModel = defineSchemaModel({
+  name: "ListDealsInput",
+  description: "Input for listing deals",
+  fields: {
+    pipelineId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    stageId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    status: { type: DealStatusFilterEnum, isOptional: true },
+    ownerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    search: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    limit: {
+      type: ScalarTypeEnum.Int_unsecure(),
+      isOptional: true,
+      defaultValue: 20
+    },
+    offset: {
+      type: ScalarTypeEnum.Int_unsecure(),
+      isOptional: true,
+      defaultValue: 0
+    }
+  }
+});
+var ListDealsOutputModel = defineSchemaModel({
+  name: "ListDealsOutput",
+  description: "Output for listing deals",
+  fields: {
+    deals: { type: DealModel, isArray: true, isOptional: false },
+    total: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    totalValue: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false }
+  }
+});
+export {
+  WinDealInputModel,
+  MoveDealInputModel,
+  LoseDealInputModel,
+  ListDealsOutputModel,
+  ListDealsInputModel,
+  DealWonPayloadModel,
+  DealMovedPayloadModel,
+  DealModel,
+  DealLostPayloadModel,
+  CreateDealInputModel
+};

package/dist/browser/deal/deal.test-spec.js

@@ -0,0 +1,58 @@
+// src/deal/deal.test-spec.ts
+import { defineTestSpec } from "@contractspec/lib.contracts";
+var dealListTest = defineTestSpec({
+  meta: {
+    key: "test.crm.deal.list",
+    version: "1.0.0",
+    owners: ["@example.crm-pipeline"],
+    description: "Test for listing deals",
+    stability: "stable",
+    tags: ["test"]
+  },
+  target: {
+    type: "operation",
+    operation: { key: "crm.deal.list", version: "1.0.0" }
+  },
+  scenarios: [
+    {
+      key: "success",
+      when: { operation: { key: "crm.deal.list" } },
+      then: [{ type: "expectOutput", match: {} }]
+    },
+    {
+      key: "error",
+      when: { operation: { key: "crm.deal.list" } },
+      then: [{ type: "expectError" }]
+    }
+  ]
+});
+var dealMoveTest = defineTestSpec({
+  meta: {
+    key: "test.crm.deal.move",
+    version: "1.0.0",
+    owners: ["@example.crm-pipeline"],
+    description: "Test for moving deal",
+    stability: "stable",
+    tags: ["test"]
+  },
+  target: {
+    type: "operation",
+    operation: { key: "crm.deal.move", version: "1.0.0" }
+  },
+  scenarios: [
+    {
+      key: "success",
+      when: { operation: { key: "crm.deal.move" } },
+      then: [{ type: "expectOutput", match: {} }]
+    },
+    {
+      key: "error",
+      when: { operation: { key: "crm.deal.move" } },
+      then: [{ type: "expectError" }]
+    }
+  ]
+});
+export {
+  dealMoveTest,
+  dealListTest
+};