@contractspec/example.service-business-os 3.7.6 → 3.7.7

package/README.md

@@ -1,16 +1,73 @@
 # @contractspec/example.service-business-os
 
-Website: https://contractspec.io/
+Website: https://contractspec.io
 
+**Service Business OS example (clients, quotes, jobs, invoices) for ContractSpec.**
 
-Service Business OS reference example (clients → quotes → jobs → invoices → payments).
+## What This Demonstrates
 
-Highlights:
+- Multi-entity domain modeling (client, quote, job, invoice, payment).
+- Per-entity schema and operations pattern.
+- Capability and feature definition patterns.
+- Presentation layer and event-driven architecture.
+- Handler aggregation.
+- `src/docs/` contains docblocks and documentation-facing exports.
 
-- Multi-tenant clients with role-based access via `@contractspec/lib.identity-rbac`
-- Quote lifecycle (draft → sent → accepted/rejected)
-- Jobs scheduling and completion with reminders via `@contractspec/lib.jobs`
-- Invoicing and payments with audit trail + notifications
-- Attachments for proposals and receipts via `@contractspec/lib.files`
+## Running Locally
 
-Use this as a spec-first starting point for field services, agencies, or professional services teams.
+From `packages/examples/service-business-os`:
+- `bun run dev`
+- `bun run build`
+- `bun run typecheck`
+
+## Usage
+
+Use `@contractspec/example.service-business-os` as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.
+
+## Architecture
+
+- `src/client` is part of the package's public or composition surface.
+- `src/docs/` contains docblocks and documentation-facing exports.
+- `src/entities/` contains domain entities and value objects.
+- `src/events.ts` is package-level event definitions.
+- `src/example.ts` is the runnable example entrypoint.
+- `src/handlers/` contains handlers or demo adapters wired to contract surfaces.
+- `src/index.ts` is the root public barrel and package entrypoint.
+
+## Public Entry Points
+
+- Export `.` resolves through `./src/index.ts`.
+- Export `./client` resolves through `./src/client/index.ts`.
+- Export `./client/client.operations` resolves through `./src/client/client.operations.ts`.
+- Export `./client/client.schema` resolves through `./src/client/client.schema.ts`.
+- Export `./docs` resolves through `./src/docs/index.ts`.
+- Export `./docs/service-business-os.docblock` resolves through `./src/docs/service-business-os.docblock.ts`.
+- Export `./entities` resolves through `./src/entities/index.ts`.
+- Export `./events` resolves through `./src/events.ts`.
+- Export `./example` resolves through `./src/example.ts`.
+- Export `./handlers` resolves through `./src/handlers/index.ts`.
+- The package publishes 26 total export subpaths; keep docs aligned with `package.json`.
+
+## Local Commands
+
+- `bun run dev` — contractspec-bun-build dev
+- `bun run build` — bun run prebuild && bun run build:bundle && bun run build:types
+- `bun run lint` — bun lint:fix
+- `bun run lint:check` — biome check .
+- `bun run lint:fix` — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
+- `bun run typecheck` — tsc --noEmit
+- `bun run publish:pkg` — bun publish --tolerate-republish --ignore-scripts --verbose
+- `bun run publish:pkg:canary` — bun publish:pkg --tag canary
+- `bun run clean` — rimraf dist .turbo
+- `bun run build:bundle` — contractspec-bun-build transpile
+- `bun run build:types` — contractspec-bun-build types
+- `bun run prebuild` — contractspec-bun-build prebuild
+
+## Recent Updates
+
+- Replace eslint+prettier by biomejs to optimize speed.
+- Missing contract layers.
+
+## Notes
+
+- Works alongside `@contractspec/lib.contracts-spec`, `@contractspec/lib.schema`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.

package/dist/browser/events.js

@@ -1,6 +1,6 @@
 // src/events.ts
-import { ScalarTypeEnum, defineSchemaModel } from "@contractspec/lib.schema";
 import { defineEvent } from "@contractspec/lib.contracts-spec";
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
 var QuoteEventPayload = defineSchemaModel({
   name: "QuoteEventPayload",
   description: "Event payload for quote lifecycle",

package/dist/browser/index.js

@@ -67,117 +67,74 @@ var CreateClientContract = defineCommand({
     ]
   }
 });
-// src/quote/quote.schema.ts
+// src/invoice/invoice.schema.ts
 import { defineSchemaModel as defineSchemaModel2, ScalarTypeEnum as ScalarTypeEnum2 } from "@contractspec/lib.schema";
-var QuoteModel = defineSchemaModel2({
-  name: "Quote",
-  description: "Quote/proposal",
+var InvoiceModel = defineSchemaModel2({
+  name: "Invoice",
+  description: "Invoice issued for a job",
   fields: {
     id: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
-    clientId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
-    title: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
-    description: { type: ScalarTypeEnum2.String_unsecure(), isOptional: true },
+    jobId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    invoiceNumber: {
+      type: ScalarTypeEnum2.String_unsecure(),
+      isOptional: false
+    },
     amount: { type: ScalarTypeEnum2.Float_unsecure(), isOptional: false },
     currency: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
     status: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
-    validUntil: { type: ScalarTypeEnum2.DateTime(), isOptional: true },
-    createdAt: { type: ScalarTypeEnum2.DateTime(), isOptional: false }
-  }
-});
-var CreateQuoteInputModel = defineSchemaModel2({
-  name: "CreateQuoteInput",
-  description: "Input for creating a quote",
-  fields: {
-    clientId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
-    title: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
-    description: { type: ScalarTypeEnum2.String_unsecure(), isOptional: true },
-    amount: { type: ScalarTypeEnum2.Float_unsecure(), isOptional: false },
-    currency: { type: ScalarTypeEnum2.String_unsecure(), isOptional: true },
-    validUntil: { type: ScalarTypeEnum2.DateTime(), isOptional: true },
-    orgId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
-    ownerId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false }
+    dueDate: { type: ScalarTypeEnum2.DateTime(), isOptional: true },
+    issuedAt: { type: ScalarTypeEnum2.DateTime(), isOptional: true },
+    paidAt: { type: ScalarTypeEnum2.DateTime(), isOptional: true }
   }
 });
-var AcceptQuoteInputModel = defineSchemaModel2({
-  name: "AcceptQuoteInput",
-  description: "Input for accepting a quote",
+var IssueInvoiceInputModel = defineSchemaModel2({
+  name: "IssueInvoiceInput",
+  description: "Input for issuing an invoice",
   fields: {
-    quoteId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
-    acceptedBy: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
-    notes: { type: ScalarTypeEnum2.String_unsecure(), isOptional: true }
+    jobId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    dueDate: { type: ScalarTypeEnum2.DateTime(), isOptional: true },
+    notes: { type: ScalarTypeEnum2.String_unsecure(), isOptional: true },
+    lineItems: { type: ScalarTypeEnum2.JSON(), isOptional: true }
   }
 });
 
-// src/quote/quote.operations.ts
+// src/invoice/invoice.operations.ts
 import { defineCommand as defineCommand2 } from "@contractspec/lib.contracts-spec";
 var OWNERS2 = ["@examples.service-business-os"];
-var CreateQuoteContract = defineCommand2({
+var IssueInvoiceContract = defineCommand2({
   meta: {
-    key: "service.quote.create",
+    key: "service.invoice.issue",
     version: "1.0.0",
     stability: "stable",
     owners: [...OWNERS2],
-    tags: ["service-business-os", "quote", "create"],
-    description: "Create a quote/proposal.",
-    goal: "Quote clients.",
-    context: "Quote creation."
+    tags: ["service-business-os", "invoice", "issue"],
+    description: "Issue an invoice for a job.",
+    goal: "Bill clients.",
+    context: "Billing."
   },
   io: {
-    input: CreateQuoteInputModel,
-    output: QuoteModel
+    input: IssueInvoiceInputModel,
+    output: InvoiceModel
   },
   policy: { auth: "user" },
   acceptance: {
     scenarios: [
       {
-        key: "create-quote-happy-path",
-        given: ["Client exists"],
-        when: ["User creates quote"],
-        then: ["Quote is created"]
+        key: "issue-invoice-happy-path",
+        given: ["Job is complete"],
+        when: ["User issues invoice"],
+        then: ["Invoice is created and sent"]
       }
     ],
     examples: [
       {
-        key: "create-proposal",
+        key: "issue-standard",
         input: {
-          clientId: "client-123",
-          items: [{ description: "Project A", price: 5000 }]
+          jobId: "job-123",
+          dueDate: "2025-02-01",
+          items: [{ description: "Service", amount: 100 }]
         },
-        output: { id: "quote-123", status: "draft", total: 5000 }
-      }
-    ]
-  }
-});
-var AcceptQuoteContract = defineCommand2({
-  meta: {
-    key: "service.quote.accept",
-    version: "1.0.0",
-    stability: "stable",
-    owners: [...OWNERS2],
-    tags: ["service-business-os", "quote", "accept"],
-    description: "Accept a quote.",
-    goal: "Confirm quote.",
-    context: "Quote acceptance."
-  },
-  io: {
-    input: AcceptQuoteInputModel,
-    output: QuoteModel
-  },
-  policy: { auth: "user" },
-  acceptance: {
-    scenarios: [
-      {
-        key: "accept-quote-happy-path",
-        given: ["Quote is open"],
-        when: ["Client accepts quote"],
-        then: ["Quote status becomes ACCEPTED"]
-      }
-    ],
-    examples: [
-      {
-        key: "client-accepts",
-        input: { quoteId: "quote-123", signature: "John Doe" },
-        output: { id: "quote-123", status: "accepted" }
+        output: { id: "inv-456", status: "issued", total: 100 }
       }
     ]
   }
@@ -347,114 +304,42 @@ var CompleteJobContract = defineCommand3({
     ]
   }
 });
-// src/invoice/invoice.schema.ts
+// src/payment/payment.schema.ts
 import { defineSchemaModel as defineSchemaModel5, ScalarTypeEnum as ScalarTypeEnum5 } from "@contractspec/lib.schema";
-var InvoiceModel = defineSchemaModel5({
-  name: "Invoice",
-  description: "Invoice issued for a job",
+var PaymentModel = defineSchemaModel5({
+  name: "Payment",
+  description: "Payment applied to invoice",
   fields: {
     id: { type: ScalarTypeEnum5.String_unsecure(), isOptional: false },
-    jobId: { type: ScalarTypeEnum5.String_unsecure(), isOptional: false },
-    invoiceNumber: {
-      type: ScalarTypeEnum5.String_unsecure(),
-      isOptional: false
-    },
+    invoiceId: { type: ScalarTypeEnum5.String_unsecure(), isOptional: false },
     amount: { type: ScalarTypeEnum5.Float_unsecure(), isOptional: false },
     currency: { type: ScalarTypeEnum5.String_unsecure(), isOptional: false },
-    status: { type: ScalarTypeEnum5.String_unsecure(), isOptional: false },
-    dueDate: { type: ScalarTypeEnum5.DateTime(), isOptional: true },
-    issuedAt: { type: ScalarTypeEnum5.DateTime(), isOptional: true },
-    paidAt: { type: ScalarTypeEnum5.DateTime(), isOptional: true }
-  }
-});
-var IssueInvoiceInputModel = defineSchemaModel5({
-  name: "IssueInvoiceInput",
-  description: "Input for issuing an invoice",
-  fields: {
-    jobId: { type: ScalarTypeEnum5.String_unsecure(), isOptional: false },
-    dueDate: { type: ScalarTypeEnum5.DateTime(), isOptional: true },
-    notes: { type: ScalarTypeEnum5.String_unsecure(), isOptional: true },
-    lineItems: { type: ScalarTypeEnum5.JSON(), isOptional: true }
-  }
-});
-
-// src/invoice/invoice.operations.ts
-import { defineCommand as defineCommand4 } from "@contractspec/lib.contracts-spec";
-var OWNERS4 = ["@examples.service-business-os"];
-var IssueInvoiceContract = defineCommand4({
-  meta: {
-    key: "service.invoice.issue",
-    version: "1.0.0",
-    stability: "stable",
-    owners: [...OWNERS4],
-    tags: ["service-business-os", "invoice", "issue"],
-    description: "Issue an invoice for a job.",
-    goal: "Bill clients.",
-    context: "Billing."
-  },
-  io: {
-    input: IssueInvoiceInputModel,
-    output: InvoiceModel
-  },
-  policy: { auth: "user" },
-  acceptance: {
-    scenarios: [
-      {
-        key: "issue-invoice-happy-path",
-        given: ["Job is complete"],
-        when: ["User issues invoice"],
-        then: ["Invoice is created and sent"]
-      }
-    ],
-    examples: [
-      {
-        key: "issue-standard",
-        input: {
-          jobId: "job-123",
-          dueDate: "2025-02-01",
-          items: [{ description: "Service", amount: 100 }]
-        },
-        output: { id: "inv-456", status: "issued", total: 100 }
-      }
-    ]
-  }
-});
-// src/payment/payment.schema.ts
-import { defineSchemaModel as defineSchemaModel6, ScalarTypeEnum as ScalarTypeEnum6 } from "@contractspec/lib.schema";
-var PaymentModel = defineSchemaModel6({
-  name: "Payment",
-  description: "Payment applied to invoice",
-  fields: {
-    id: { type: ScalarTypeEnum6.String_unsecure(), isOptional: false },
-    invoiceId: { type: ScalarTypeEnum6.String_unsecure(), isOptional: false },
-    amount: { type: ScalarTypeEnum6.Float_unsecure(), isOptional: false },
-    currency: { type: ScalarTypeEnum6.String_unsecure(), isOptional: false },
-    method: { type: ScalarTypeEnum6.String_unsecure(), isOptional: false },
-    reference: { type: ScalarTypeEnum6.String_unsecure(), isOptional: true },
-    receivedAt: { type: ScalarTypeEnum6.DateTime(), isOptional: false }
+    method: { type: ScalarTypeEnum5.String_unsecure(), isOptional: false },
+    reference: { type: ScalarTypeEnum5.String_unsecure(), isOptional: true },
+    receivedAt: { type: ScalarTypeEnum5.DateTime(), isOptional: false }
   }
 });
-var RecordPaymentInputModel = defineSchemaModel6({
+var RecordPaymentInputModel = defineSchemaModel5({
   name: "RecordPaymentInput",
   description: "Input for recording a payment",
   fields: {
-    invoiceId: { type: ScalarTypeEnum6.String_unsecure(), isOptional: false },
-    amount: { type: ScalarTypeEnum6.Float_unsecure(), isOptional: false },
-    method: { type: ScalarTypeEnum6.String_unsecure(), isOptional: false },
-    reference: { type: ScalarTypeEnum6.String_unsecure(), isOptional: true },
-    receivedAt: { type: ScalarTypeEnum6.DateTime(), isOptional: true }
+    invoiceId: { type: ScalarTypeEnum5.String_unsecure(), isOptional: false },
+    amount: { type: ScalarTypeEnum5.Float_unsecure(), isOptional: false },
+    method: { type: ScalarTypeEnum5.String_unsecure(), isOptional: false },
+    reference: { type: ScalarTypeEnum5.String_unsecure(), isOptional: true },
+    receivedAt: { type: ScalarTypeEnum5.DateTime(), isOptional: true }
   }
 });
 
 // src/payment/payment.operations.ts
-import { defineCommand as defineCommand5 } from "@contractspec/lib.contracts-spec";
-var OWNERS5 = ["@examples.service-business-os"];
-var RecordPaymentContract = defineCommand5({
+import { defineCommand as defineCommand4 } from "@contractspec/lib.contracts-spec";
+var OWNERS4 = ["@examples.service-business-os"];
+var RecordPaymentContract = defineCommand4({
   meta: {
     key: "service.payment.record",
     version: "1.0.0",
     stability: "stable",
-    owners: [...OWNERS5],
+    owners: [...OWNERS4],
     tags: ["service-business-os", "payment", "record"],
     description: "Record a payment.",
     goal: "Track payments.",
@@ -650,6 +535,121 @@ var PaymentListPresentation = definePresentation({
   }
 });
 
+// src/quote/quote.schema.ts
+import { defineSchemaModel as defineSchemaModel6, ScalarTypeEnum as ScalarTypeEnum6 } from "@contractspec/lib.schema";
+var QuoteModel = defineSchemaModel6({
+  name: "Quote",
+  description: "Quote/proposal",
+  fields: {
+    id: { type: ScalarTypeEnum6.String_unsecure(), isOptional: false },
+    clientId: { type: ScalarTypeEnum6.String_unsecure(), isOptional: false },
+    title: { type: ScalarTypeEnum6.String_unsecure(), isOptional: false },
+    description: { type: ScalarTypeEnum6.String_unsecure(), isOptional: true },
+    amount: { type: ScalarTypeEnum6.Float_unsecure(), isOptional: false },
+    currency: { type: ScalarTypeEnum6.String_unsecure(), isOptional: false },
+    status: { type: ScalarTypeEnum6.String_unsecure(), isOptional: false },
+    validUntil: { type: ScalarTypeEnum6.DateTime(), isOptional: true },
+    createdAt: { type: ScalarTypeEnum6.DateTime(), isOptional: false }
+  }
+});
+var CreateQuoteInputModel = defineSchemaModel6({
+  name: "CreateQuoteInput",
+  description: "Input for creating a quote",
+  fields: {
+    clientId: { type: ScalarTypeEnum6.String_unsecure(), isOptional: false },
+    title: { type: ScalarTypeEnum6.String_unsecure(), isOptional: false },
+    description: { type: ScalarTypeEnum6.String_unsecure(), isOptional: true },
+    amount: { type: ScalarTypeEnum6.Float_unsecure(), isOptional: false },
+    currency: { type: ScalarTypeEnum6.String_unsecure(), isOptional: true },
+    validUntil: { type: ScalarTypeEnum6.DateTime(), isOptional: true },
+    orgId: { type: ScalarTypeEnum6.String_unsecure(), isOptional: false },
+    ownerId: { type: ScalarTypeEnum6.String_unsecure(), isOptional: false }
+  }
+});
+var AcceptQuoteInputModel = defineSchemaModel6({
+  name: "AcceptQuoteInput",
+  description: "Input for accepting a quote",
+  fields: {
+    quoteId: { type: ScalarTypeEnum6.String_unsecure(), isOptional: false },
+    acceptedBy: { type: ScalarTypeEnum6.String_unsecure(), isOptional: false },
+    notes: { type: ScalarTypeEnum6.String_unsecure(), isOptional: true }
+  }
+});
+
+// src/quote/quote.operations.ts
+import { defineCommand as defineCommand5 } from "@contractspec/lib.contracts-spec";
+var OWNERS5 = ["@examples.service-business-os"];
+var CreateQuoteContract = defineCommand5({
+  meta: {
+    key: "service.quote.create",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS5],
+    tags: ["service-business-os", "quote", "create"],
+    description: "Create a quote/proposal.",
+    goal: "Quote clients.",
+    context: "Quote creation."
+  },
+  io: {
+    input: CreateQuoteInputModel,
+    output: QuoteModel
+  },
+  policy: { auth: "user" },
+  acceptance: {
+    scenarios: [
+      {
+        key: "create-quote-happy-path",
+        given: ["Client exists"],
+        when: ["User creates quote"],
+        then: ["Quote is created"]
+      }
+    ],
+    examples: [
+      {
+        key: "create-proposal",
+        input: {
+          clientId: "client-123",
+          items: [{ description: "Project A", price: 5000 }]
+        },
+        output: { id: "quote-123", status: "draft", total: 5000 }
+      }
+    ]
+  }
+});
+var AcceptQuoteContract = defineCommand5({
+  meta: {
+    key: "service.quote.accept",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS5],
+    tags: ["service-business-os", "quote", "accept"],
+    description: "Accept a quote.",
+    goal: "Confirm quote.",
+    context: "Quote acceptance."
+  },
+  io: {
+    input: AcceptQuoteInputModel,
+    output: QuoteModel
+  },
+  policy: { auth: "user" },
+  acceptance: {
+    scenarios: [
+      {
+        key: "accept-quote-happy-path",
+        given: ["Quote is open"],
+        when: ["Client accepts quote"],
+        then: ["Quote status becomes ACCEPTED"]
+      }
+    ],
+    examples: [
+      {
+        key: "client-accepts",
+        input: { quoteId: "quote-123", signature: "John Doe" },
+        output: { id: "quote-123", status: "accepted" }
+      }
+    ]
+  }
+});
 // src/service.feature.ts
 import { defineFeature } from "@contractspec/lib.contracts-spec";
 var ServiceBusinessFeature = defineFeature({