@contractspec/example.service-business-os 1.44.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Chaman Ventures, SASU
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,16 @@
+# @contractspec/example.service-business-os
+
+Website: https://contractspec.io/
+
+
+Service Business OS reference example (clients → quotes → jobs → invoices → payments).
+
+Highlights:
+
+- 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`
+
+Use this as a spec-first starting point for field services, agencies, or professional services teams.

package/dist/client/client.operations.d.ts

@@ -0,0 +1,65 @@
+import * as _contractspec_lib_schema279 from "@contractspec/lib.schema";
+import * as _contractspec_lib_contracts11 from "@contractspec/lib.contracts";
+
+//#region src/client/client.operations.d.ts
+/**
+ * Create a new client.
+ */
+declare const CreateClientContract: _contractspec_lib_contracts11.OperationSpec<_contractspec_lib_schema279.SchemaModel<{
+  name: {
+    type: _contractspec_lib_schema279.FieldType<string, string>;
+    isOptional: false;
+  };
+  contactEmail: {
+    type: _contractspec_lib_schema279.FieldType<string, string>;
+    isOptional: true;
+  };
+  phone: {
+    type: _contractspec_lib_schema279.FieldType<string, string>;
+    isOptional: true;
+  };
+  orgId: {
+    type: _contractspec_lib_schema279.FieldType<string, string>;
+    isOptional: false;
+  };
+  ownerId: {
+    type: _contractspec_lib_schema279.FieldType<string, string>;
+    isOptional: false;
+  };
+  metadata: {
+    type: _contractspec_lib_schema279.FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+}>, _contractspec_lib_schema279.SchemaModel<{
+  id: {
+    type: _contractspec_lib_schema279.FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: _contractspec_lib_schema279.FieldType<string, string>;
+    isOptional: false;
+  };
+  contactEmail: {
+    type: _contractspec_lib_schema279.FieldType<string, string>;
+    isOptional: true;
+  };
+  phone: {
+    type: _contractspec_lib_schema279.FieldType<string, string>;
+    isOptional: true;
+  };
+  orgId: {
+    type: _contractspec_lib_schema279.FieldType<string, string>;
+    isOptional: false;
+  };
+  ownerId: {
+    type: _contractspec_lib_schema279.FieldType<string, string>;
+    isOptional: false;
+  };
+  createdAt: {
+    type: _contractspec_lib_schema279.FieldType<Date, string>;
+    isOptional: false;
+  };
+}>, undefined>;
+//#endregion
+export { CreateClientContract };
+//# sourceMappingURL=client.operations.d.ts.map

package/dist/client/client.operations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.operations.d.ts","names":[],"sources":["../../src/client/client.operations.ts"],"sourcesContent":[],"mappings":";;;;;;;cAQa,oDAAoB,0CAAA;EAApB,IAAA,EAAA;IAqCX,IAAA,EAAA,2BAAA,CAAA,SAAA,CAAA,MAAA,EAAA,MAAA,CAAA;;;;;;;EArC+B,KAAA,EAAA;;;;;;;;;+CAAA,CAAA,MAAA,EAAA,MAAA,CAAA;IAAA,UAAA,EAAA,KAAA;;;;;;;;UAAA,2BAAA,CAAA"}

package/dist/client/client.operations.js

@@ -0,0 +1,53 @@
+import { ClientModel, CreateClientInputModel } from "./client.schema.js";
+import { defineCommand } from "@contractspec/lib.contracts";
+
+//#region src/client/client.operations.ts
+const OWNERS = ["@examples.service-business-os"];
+/**
+* Create a new client.
+*/
+const CreateClientContract = defineCommand({
+	meta: {
+		key: "service.client.create",
+		version: 1,
+		stability: "stable",
+		owners: [...OWNERS],
+		tags: [
+			"service-business-os",
+			"client",
+			"create"
+		],
+		description: "Create a new client.",
+		goal: "Onboard clients.",
+		context: "CRM."
+	},
+	io: {
+		input: CreateClientInputModel,
+		output: ClientModel
+	},
+	policy: { auth: "user" },
+	acceptance: {
+		scenarios: [{
+			key: "create-client-happy-path",
+			given: ["User is authenticated"],
+			when: ["User creates a new client"],
+			then: ["Client is created"]
+		}],
+		examples: [{
+			key: "create-basic",
+			input: {
+				name: "Acme Corp",
+				email: "contact@acme.com",
+				phone: "555-0123"
+			},
+			output: {
+				id: "client-123",
+				name: "Acme Corp"
+			}
+		}]
+	}
+});
+
+//#endregion
+export { CreateClientContract };
+//# sourceMappingURL=client.operations.js.map

package/dist/client/client.operations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.operations.js","names":[],"sources":["../../src/client/client.operations.ts"],"sourcesContent":["import { defineCommand } from '@contractspec/lib.contracts';\nimport { ClientModel, CreateClientInputModel } from './client.schema';\n\nconst OWNERS = ['@examples.service-business-os'] as const;\n\n/**\n * Create a new client.\n */\nexport const CreateClientContract = defineCommand({\n  meta: {\n    key: 'service.client.create',\n    version: 1,\n    stability: 'stable',\n    owners: [...OWNERS],\n    tags: ['service-business-os', 'client', 'create'],\n    description: 'Create a new client.',\n    goal: 'Onboard clients.',\n    context: 'CRM.',\n  },\n  io: {\n    input: CreateClientInputModel,\n    output: ClientModel,\n  },\n  policy: { auth: 'user' },\n  acceptance: {\n    scenarios: [\n      {\n        key: 'create-client-happy-path',\n        given: ['User is authenticated'],\n        when: ['User creates a new client'],\n        then: ['Client is created'],\n      },\n    ],\n    examples: [\n      {\n        key: 'create-basic',\n        input: {\n          name: 'Acme Corp',\n          email: 'contact@acme.com',\n          phone: '555-0123',\n        },\n        output: { id: 'client-123', name: 'Acme Corp' },\n      },\n    ],\n  },\n});\n"],"mappings":";;;;AAGA,MAAM,SAAS,CAAC,gCAAgC;;;;AAKhD,MAAa,uBAAuB,cAAc;CAChD,MAAM;EACJ,KAAK;EACL,SAAS;EACT,WAAW;EACX,QAAQ,CAAC,GAAG,OAAO;EACnB,MAAM;GAAC;GAAuB;GAAU;GAAS;EACjD,aAAa;EACb,MAAM;EACN,SAAS;EACV;CACD,IAAI;EACF,OAAO;EACP,QAAQ;EACT;CACD,QAAQ,EAAE,MAAM,QAAQ;CACxB,YAAY;EACV,WAAW,CACT;GACE,KAAK;GACL,OAAO,CAAC,wBAAwB;GAChC,MAAM,CAAC,4BAA4B;GACnC,MAAM,CAAC,oBAAoB;GAC5B,CACF;EACD,UAAU,CACR;GACE,KAAK;GACL,OAAO;IACL,MAAM;IACN,OAAO;IACP,OAAO;IACR;GACD,QAAQ;IAAE,IAAI;IAAc,MAAM;IAAa;GAChD,CACF;EACF;CACF,CAAC"}

package/dist/client/client.schema.d.ts

@@ -0,0 +1,68 @@
+import * as _contractspec_lib_schema110 from "@contractspec/lib.schema";
+
+//#region src/client/client.schema.d.ts
+/**
+ * Client profile.
+ */
+declare const ClientModel: _contractspec_lib_schema110.SchemaModel<{
+  id: {
+    type: _contractspec_lib_schema110.FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: _contractspec_lib_schema110.FieldType<string, string>;
+    isOptional: false;
+  };
+  contactEmail: {
+    type: _contractspec_lib_schema110.FieldType<string, string>;
+    isOptional: true;
+  };
+  phone: {
+    type: _contractspec_lib_schema110.FieldType<string, string>;
+    isOptional: true;
+  };
+  orgId: {
+    type: _contractspec_lib_schema110.FieldType<string, string>;
+    isOptional: false;
+  };
+  ownerId: {
+    type: _contractspec_lib_schema110.FieldType<string, string>;
+    isOptional: false;
+  };
+  createdAt: {
+    type: _contractspec_lib_schema110.FieldType<Date, string>;
+    isOptional: false;
+  };
+}>;
+/**
+ * Input for creating a client.
+ */
+declare const CreateClientInputModel: _contractspec_lib_schema110.SchemaModel<{
+  name: {
+    type: _contractspec_lib_schema110.FieldType<string, string>;
+    isOptional: false;
+  };
+  contactEmail: {
+    type: _contractspec_lib_schema110.FieldType<string, string>;
+    isOptional: true;
+  };
+  phone: {
+    type: _contractspec_lib_schema110.FieldType<string, string>;
+    isOptional: true;
+  };
+  orgId: {
+    type: _contractspec_lib_schema110.FieldType<string, string>;
+    isOptional: false;
+  };
+  ownerId: {
+    type: _contractspec_lib_schema110.FieldType<string, string>;
+    isOptional: false;
+  };
+  metadata: {
+    type: _contractspec_lib_schema110.FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+}>;
+//#endregion
+export { ClientModel, CreateClientInputModel };
+//# sourceMappingURL=client.schema.d.ts.map

package/dist/client/client.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.schema.d.ts","names":[],"sources":["../../src/client/client.schema.ts"],"sourcesContent":[],"mappings":";;;;;;AAKa,cAAA,WAYX,8BAZsB,WAYtB,CAAA;EAAA,EAAA,EAAA;UAAA,2BAAA,CAAA;;;;;;;;IAZsB,IAAA,uCAAA,CAAA,MAAA,EAAA,MAAA,CAAA;IAiBX,UAAA,EAAA,IAAA;EAWX,CAAA;;;;;;+CAXiC,CAAA,MAAA,EAAA,MAAA,CAAA;IAAA,UAAA,EAAA,KAAA;;;;;;;;;;;;;;cAAtB,oDAAsB;;UAWjC,2BAAA,CAAA"}

package/dist/client/client.schema.js

@@ -0,0 +1,77 @@
+import { ScalarTypeEnum, defineSchemaModel } from "@contractspec/lib.schema";
+
+//#region src/client/client.schema.ts
+/**
+* Client profile.
+*/
+const ClientModel = defineSchemaModel({
+	name: "Client",
+	description: "Client profile",
+	fields: {
+		id: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		name: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		contactEmail: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		phone: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		orgId: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		ownerId: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		createdAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: false
+		}
+	}
+});
+/**
+* Input for creating a client.
+*/
+const CreateClientInputModel = defineSchemaModel({
+	name: "CreateClientInput",
+	description: "Input for creating a client",
+	fields: {
+		name: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		contactEmail: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		phone: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		orgId: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		ownerId: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		metadata: {
+			type: ScalarTypeEnum.JSON(),
+			isOptional: true
+		}
+	}
+});
+
+//#endregion
+export { ClientModel, CreateClientInputModel };
+//# sourceMappingURL=client.schema.js.map

package/dist/client/client.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.schema.js","names":[],"sources":["../../src/client/client.schema.ts"],"sourcesContent":["import { defineSchemaModel, ScalarTypeEnum } from '@contractspec/lib.schema';\n\n/**\n * Client profile.\n */\nexport const ClientModel = defineSchemaModel({\n  name: 'Client',\n  description: 'Client profile',\n  fields: {\n    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n    contactEmail: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n    phone: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n    orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n    ownerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n    createdAt: { type: ScalarTypeEnum.DateTime(), isOptional: false },\n  },\n});\n\n/**\n * Input for creating a client.\n */\nexport const CreateClientInputModel = defineSchemaModel({\n  name: 'CreateClientInput',\n  description: 'Input for creating a client',\n  fields: {\n    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n    contactEmail: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n    phone: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n    orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n    ownerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n    metadata: { type: ScalarTypeEnum.JSON(), isOptional: true },\n  },\n});\n"],"mappings":";;;;;;AAKA,MAAa,cAAc,kBAAkB;CAC3C,MAAM;CACN,aAAa;CACb,QAAQ;EACN,IAAI;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACjE,MAAM;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACnE,cAAc;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EAC1E,OAAO;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EACnE,OAAO;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACpE,SAAS;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACtE,WAAW;GAAE,MAAM,eAAe,UAAU;GAAE,YAAY;GAAO;EAClE;CACF,CAAC;;;;AAKF,MAAa,yBAAyB,kBAAkB;CACtD,MAAM;CACN,aAAa;CACb,QAAQ;EACN,MAAM;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACnE,cAAc;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EAC1E,OAAO;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EACnE,OAAO;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACpE,SAAS;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACtE,UAAU;GAAE,MAAM,eAAe,MAAM;GAAE,YAAY;GAAM;EAC5D;CACF,CAAC"}

package/dist/client/index.d.ts

@@ -0,0 +1,3 @@
+import { CreateClientContract } from "./client.operations.js";
+import { ClientModel, CreateClientInputModel } from "./client.schema.js";
+export { ClientModel, CreateClientContract, CreateClientInputModel };

package/dist/client/index.js

@@ -0,0 +1,4 @@
+import { ClientModel, CreateClientInputModel } from "./client.schema.js";
+import { CreateClientContract } from "./client.operations.js";
+
+export { ClientModel, CreateClientContract, CreateClientInputModel };

package/dist/docs/index.d.ts

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

package/dist/docs/index.js

@@ -0,0 +1 @@
+import "./service-business-os.docblock.js";

package/dist/docs/service-business-os.docblock.d.ts

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

package/dist/docs/service-business-os.docblock.js

@@ -0,0 +1,109 @@
+import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
+
+//#region src/docs/service-business-os.docblock.ts
+registerDocBlocks([
+	{
+		id: "docs.examples.service-business-os",
+		title: "Service Business OS",
+		summary: "Field/service business flow from client intake to quote, job scheduling, invoicing, and payments with notifications and audit trail.",
+		kind: "reference",
+		visibility: "public",
+		route: "/docs/examples/service-business-os",
+		tags: [
+			"services",
+			"quotes",
+			"jobs",
+			"invoices",
+			"payments"
+		],
+		body: `## Flows
+
+1) **Client intake** → create client, capture contact + owner.
+2) **Quote** → draft, send, accept/reject (events + notifications).
+3) **Job** → schedule, assign technician, complete with notes and attachments.
+4) **Invoice** → issue after completion, track status.
+5) **Payment** → record payment and emit analytics/audit.
+
+## Modules reused
+- Identity/RBAC for org + roles
+- Files for attachments (proposals, receipts)
+- Notifications for quote sent/accepted, job reminders, overdue invoices
+- Jobs for reminder/schedule tasks
+- Audit trail for all lifecycle changes
+
+## Presentations
+- Dashboard, client list, quote list/detail, job board, invoice list, payment list (React + Markdown targets).
+`
+	},
+	{
+		id: "docs.examples.service-business-os.goal",
+		title: "Service Business OS — Goal",
+		summary: "Why this field-service OS exists and outcomes it targets.",
+		kind: "goal",
+		visibility: "public",
+		route: "/docs/examples/service-business-os/goal",
+		tags: ["services", "goal"],
+		body: `## Why it matters
+- Provides a regenerable, end-to-end service lifecycle (client → quote → job → invoice → payment).
+- Keeps pricing, scheduling, invoicing, and payments consistent across surfaces.
+
+## Business/Product goal
+- Deliver auditable quotes/jobs/invoices with notifications and reminders.
+- Support attachments and PII-safe flows; stage new payment rules via feature flags.
+
+## Success criteria
+- Spec changes regenerate UI/API/events cleanly across lifecycle steps.
+- Audit/Notifications/Jobs remain wired for every mutation.`
+	},
+	{
+		id: "docs.examples.service-business-os.usage",
+		title: "Service Business OS — Usage",
+		summary: "How to operate, extend, and regenerate the service OS safely.",
+		kind: "usage",
+		visibility: "public",
+		route: "/docs/examples/service-business-os/usage",
+		tags: ["services", "usage"],
+		body: `## Setup
+1) Seed (if provided) or create client → quote → job → invoice → payment via UI.
+2) Configure Files for attachments and Notifications for quote/job/invoice events.
+
+## Extend & regenerate
+1) Adjust schemas: quote line items, job statuses, invoice terms, payment methods.
+2) Regenerate to sync UI/API/events; mark PII paths in policy.
+3) Use Feature Flags to trial new payment rules or reminder cadences.
+
+## Guardrails
+- Emit events for quote accepted/rejected, job scheduled/completed, invoice overdue, payment recorded.
+- Keep pricing/tax rules explicit in spec; avoid implicit handler math.
+- Use Audit Trail for lifecycle mutations; schedule reminders via Jobs.`
+	},
+	{
+		id: "docs.examples.service-business-os.constraints",
+		title: "Service Business OS — Constraints & Safety",
+		summary: "Internal guardrails for quotes/jobs/invoices/payments and regeneration safety.",
+		kind: "reference",
+		visibility: "internal",
+		route: "/docs/examples/service-business-os/constraints",
+		tags: [
+			"services",
+			"constraints",
+			"internal"
+		],
+		body: `## Constraints
+- Commission/tax/payment rules must be explicit in spec; no hidden handler math.
+- Events to emit: quote.sent/accepted/rejected, job.scheduled/completed, invoice.issued/overdue, payment.recorded.
+- Regeneration must not alter payment semantics without reviewed spec changes.
+
+## PII & Attachments
+- Mark PII paths (client contact, address); redact in markdown/JSON.
+- Files (quotes, receipts) should use presigned URLs with scoped access.
+
+## Verification
+- Add fixtures for quote/job/invoice state transitions.
+- Ensure Notifications/Audit/Jobs wiring persists after regeneration.
+- Use Feature Flags to trial new payment rules/reminder cadences; default safe/off.`
+	}
+]);
+
+//#endregion
+//# sourceMappingURL=service-business-os.docblock.js.map

package/dist/docs/service-business-os.docblock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service-business-os.docblock.js","names":[],"sources":["../../src/docs/service-business-os.docblock.ts"],"sourcesContent":["import type { DocBlock } from '@contractspec/lib.contracts/docs';\nimport { registerDocBlocks } from '@contractspec/lib.contracts/docs';\n\nconst serviceBusinessDocBlocks: DocBlock[] = [\n  {\n    id: 'docs.examples.service-business-os',\n    title: 'Service Business OS',\n    summary:\n      'Field/service business flow from client intake to quote, job scheduling, invoicing, and payments with notifications and audit trail.',\n    kind: 'reference',\n    visibility: 'public',\n    route: '/docs/examples/service-business-os',\n    tags: ['services', 'quotes', 'jobs', 'invoices', 'payments'],\n    body: `## Flows\n\n1) **Client intake** → create client, capture contact + owner.\n2) **Quote** → draft, send, accept/reject (events + notifications).\n3) **Job** → schedule, assign technician, complete with notes and attachments.\n4) **Invoice** → issue after completion, track status.\n5) **Payment** → record payment and emit analytics/audit.\n\n## Modules reused\n- Identity/RBAC for org + roles\n- Files for attachments (proposals, receipts)\n- Notifications for quote sent/accepted, job reminders, overdue invoices\n- Jobs for reminder/schedule tasks\n- Audit trail for all lifecycle changes\n\n## Presentations\n- Dashboard, client list, quote list/detail, job board, invoice list, payment list (React + Markdown targets).\n`,\n  },\n  {\n    id: 'docs.examples.service-business-os.goal',\n    title: 'Service Business OS — Goal',\n    summary: 'Why this field-service OS exists and outcomes it targets.',\n    kind: 'goal',\n    visibility: 'public',\n    route: '/docs/examples/service-business-os/goal',\n    tags: ['services', 'goal'],\n    body: `## Why it matters\n- Provides a regenerable, end-to-end service lifecycle (client → quote → job → invoice → payment).\n- Keeps pricing, scheduling, invoicing, and payments consistent across surfaces.\n\n## Business/Product goal\n- Deliver auditable quotes/jobs/invoices with notifications and reminders.\n- Support attachments and PII-safe flows; stage new payment rules via feature flags.\n\n## Success criteria\n- Spec changes regenerate UI/API/events cleanly across lifecycle steps.\n- Audit/Notifications/Jobs remain wired for every mutation.`,\n  },\n  {\n    id: 'docs.examples.service-business-os.usage',\n    title: 'Service Business OS — Usage',\n    summary: 'How to operate, extend, and regenerate the service OS safely.',\n    kind: 'usage',\n    visibility: 'public',\n    route: '/docs/examples/service-business-os/usage',\n    tags: ['services', 'usage'],\n    body: `## Setup\n1) Seed (if provided) or create client → quote → job → invoice → payment via UI.\n2) Configure Files for attachments and Notifications for quote/job/invoice events.\n\n## Extend & regenerate\n1) Adjust schemas: quote line items, job statuses, invoice terms, payment methods.\n2) Regenerate to sync UI/API/events; mark PII paths in policy.\n3) Use Feature Flags to trial new payment rules or reminder cadences.\n\n## Guardrails\n- Emit events for quote accepted/rejected, job scheduled/completed, invoice overdue, payment recorded.\n- Keep pricing/tax rules explicit in spec; avoid implicit handler math.\n- Use Audit Trail for lifecycle mutations; schedule reminders via Jobs.`,\n  },\n  {\n    id: 'docs.examples.service-business-os.constraints',\n    title: 'Service Business OS — Constraints & Safety',\n    summary:\n      'Internal guardrails for quotes/jobs/invoices/payments and regeneration safety.',\n    kind: 'reference',\n    visibility: 'internal',\n    route: '/docs/examples/service-business-os/constraints',\n    tags: ['services', 'constraints', 'internal'],\n    body: `## Constraints\n- Commission/tax/payment rules must be explicit in spec; no hidden handler math.\n- Events to emit: quote.sent/accepted/rejected, job.scheduled/completed, invoice.issued/overdue, payment.recorded.\n- Regeneration must not alter payment semantics without reviewed spec changes.\n\n## PII & Attachments\n- Mark PII paths (client contact, address); redact in markdown/JSON.\n- Files (quotes, receipts) should use presigned URLs with scoped access.\n\n## Verification\n- Add fixtures for quote/job/invoice state transitions.\n- Ensure Notifications/Audit/Jobs wiring persists after regeneration.\n- Use Feature Flags to trial new payment rules/reminder cadences; default safe/off.`,\n  },\n];\n\nregisterDocBlocks(serviceBusinessDocBlocks);\n"],"mappings":";;;AAmGA,kBAhG6C;CAC3C;EACE,IAAI;EACJ,OAAO;EACP,SACE;EACF,MAAM;EACN,YAAY;EACZ,OAAO;EACP,MAAM;GAAC;GAAY;GAAU;GAAQ;GAAY;GAAW;EAC5D,MAAM;;;;;;;;;;;;;;;;;;EAkBP;CACD;EACE,IAAI;EACJ,OAAO;EACP,SAAS;EACT,MAAM;EACN,YAAY;EACZ,OAAO;EACP,MAAM,CAAC,YAAY,OAAO;EAC1B,MAAM;;;;;;;;;;;EAWP;CACD;EACE,IAAI;EACJ,OAAO;EACP,SAAS;EACT,MAAM;EACN,YAAY;EACZ,OAAO;EACP,MAAM,CAAC,YAAY,QAAQ;EAC3B,MAAM;;;;;;;;;;;;;EAaP;CACD;EACE,IAAI;EACJ,OAAO;EACP,SACE;EACF,MAAM;EACN,YAAY;EACZ,OAAO;EACP,MAAM;GAAC;GAAY;GAAe;GAAW;EAC7C,MAAM;;;;;;;;;;;;;EAaP;CACF,CAE0C"}

package/dist/entities/index.d.ts

@@ -0,0 +1,168 @@
+import * as _contractspec_lib_schema125 from "@contractspec/lib.schema";
+import { ModuleSchemaContribution } from "@contractspec/lib.schema";
+
+//#region src/entities/index.d.ts
+declare const QuoteStatusEnum: _contractspec_lib_schema125.EntityEnumDef;
+declare const JobStatusEnum: _contractspec_lib_schema125.EntityEnumDef;
+declare const InvoiceStatusEnum: _contractspec_lib_schema125.EntityEnumDef;
+declare const PaymentMethodEnum: _contractspec_lib_schema125.EntityEnumDef;
+declare const ClientEntity: _contractspec_lib_schema125.EntitySpec<{
+  id: _contractspec_lib_schema125.EntityScalarField;
+  name: _contractspec_lib_schema125.EntityScalarField;
+  contactEmail: _contractspec_lib_schema125.EntityScalarField;
+  phone: _contractspec_lib_schema125.EntityScalarField;
+  address: _contractspec_lib_schema125.EntityScalarField;
+  industry: _contractspec_lib_schema125.EntityScalarField;
+  orgId: _contractspec_lib_schema125.EntityScalarField;
+  ownerId: _contractspec_lib_schema125.EntityScalarField;
+  metadata: _contractspec_lib_schema125.EntityScalarField;
+  createdAt: _contractspec_lib_schema125.EntityScalarField;
+  updatedAt: _contractspec_lib_schema125.EntityScalarField;
+  quotes: _contractspec_lib_schema125.EntityRelationField;
+  jobs: _contractspec_lib_schema125.EntityRelationField;
+}>;
+declare const QuoteEntity: _contractspec_lib_schema125.EntitySpec<{
+  id: _contractspec_lib_schema125.EntityScalarField;
+  clientId: _contractspec_lib_schema125.EntityScalarField;
+  title: _contractspec_lib_schema125.EntityScalarField;
+  description: _contractspec_lib_schema125.EntityScalarField;
+  amount: _contractspec_lib_schema125.EntityScalarField;
+  currency: _contractspec_lib_schema125.EntityScalarField;
+  status: _contractspec_lib_schema125.EntityEnumField;
+  validUntil: _contractspec_lib_schema125.EntityScalarField;
+  terms: _contractspec_lib_schema125.EntityScalarField;
+  orgId: _contractspec_lib_schema125.EntityScalarField;
+  ownerId: _contractspec_lib_schema125.EntityScalarField;
+  createdAt: _contractspec_lib_schema125.EntityScalarField;
+  updatedAt: _contractspec_lib_schema125.EntityScalarField;
+  client: _contractspec_lib_schema125.EntityRelationField;
+  jobs: _contractspec_lib_schema125.EntityRelationField;
+}>;
+declare const JobEntity: _contractspec_lib_schema125.EntitySpec<{
+  id: _contractspec_lib_schema125.EntityScalarField;
+  quoteId: _contractspec_lib_schema125.EntityScalarField;
+  clientId: _contractspec_lib_schema125.EntityScalarField;
+  title: _contractspec_lib_schema125.EntityScalarField;
+  status: _contractspec_lib_schema125.EntityEnumField;
+  scheduledAt: _contractspec_lib_schema125.EntityScalarField;
+  completedAt: _contractspec_lib_schema125.EntityScalarField;
+  assignedTo: _contractspec_lib_schema125.EntityScalarField;
+  location: _contractspec_lib_schema125.EntityScalarField;
+  notes: _contractspec_lib_schema125.EntityScalarField;
+  orgId: _contractspec_lib_schema125.EntityScalarField;
+  createdAt: _contractspec_lib_schema125.EntityScalarField;
+  updatedAt: _contractspec_lib_schema125.EntityScalarField;
+  quote: _contractspec_lib_schema125.EntityRelationField;
+  client: _contractspec_lib_schema125.EntityRelationField;
+  invoices: _contractspec_lib_schema125.EntityRelationField;
+}>;
+declare const InvoiceEntity: _contractspec_lib_schema125.EntitySpec<{
+  id: _contractspec_lib_schema125.EntityScalarField;
+  jobId: _contractspec_lib_schema125.EntityScalarField;
+  invoiceNumber: _contractspec_lib_schema125.EntityScalarField;
+  amount: _contractspec_lib_schema125.EntityScalarField;
+  currency: _contractspec_lib_schema125.EntityScalarField;
+  status: _contractspec_lib_schema125.EntityEnumField;
+  dueDate: _contractspec_lib_schema125.EntityScalarField;
+  issuedAt: _contractspec_lib_schema125.EntityScalarField;
+  paidAt: _contractspec_lib_schema125.EntityScalarField;
+  orgId: _contractspec_lib_schema125.EntityScalarField;
+  notes: _contractspec_lib_schema125.EntityScalarField;
+  metadata: _contractspec_lib_schema125.EntityScalarField;
+  createdAt: _contractspec_lib_schema125.EntityScalarField;
+  updatedAt: _contractspec_lib_schema125.EntityScalarField;
+  job: _contractspec_lib_schema125.EntityRelationField;
+  payments: _contractspec_lib_schema125.EntityRelationField;
+}>;
+declare const PaymentEntity: _contractspec_lib_schema125.EntitySpec<{
+  id: _contractspec_lib_schema125.EntityScalarField;
+  invoiceId: _contractspec_lib_schema125.EntityScalarField;
+  amount: _contractspec_lib_schema125.EntityScalarField;
+  currency: _contractspec_lib_schema125.EntityScalarField;
+  method: _contractspec_lib_schema125.EntityEnumField;
+  reference: _contractspec_lib_schema125.EntityScalarField;
+  receivedAt: _contractspec_lib_schema125.EntityScalarField;
+  orgId: _contractspec_lib_schema125.EntityScalarField;
+  createdAt: _contractspec_lib_schema125.EntityScalarField;
+  invoice: _contractspec_lib_schema125.EntityRelationField;
+}>;
+declare const serviceBusinessEntities: (_contractspec_lib_schema125.EntitySpec<{
+  id: _contractspec_lib_schema125.EntityScalarField;
+  name: _contractspec_lib_schema125.EntityScalarField;
+  contactEmail: _contractspec_lib_schema125.EntityScalarField;
+  phone: _contractspec_lib_schema125.EntityScalarField;
+  address: _contractspec_lib_schema125.EntityScalarField;
+  industry: _contractspec_lib_schema125.EntityScalarField;
+  orgId: _contractspec_lib_schema125.EntityScalarField;
+  ownerId: _contractspec_lib_schema125.EntityScalarField;
+  metadata: _contractspec_lib_schema125.EntityScalarField;
+  createdAt: _contractspec_lib_schema125.EntityScalarField;
+  updatedAt: _contractspec_lib_schema125.EntityScalarField;
+  quotes: _contractspec_lib_schema125.EntityRelationField;
+  jobs: _contractspec_lib_schema125.EntityRelationField;
+}> | _contractspec_lib_schema125.EntitySpec<{
+  id: _contractspec_lib_schema125.EntityScalarField;
+  clientId: _contractspec_lib_schema125.EntityScalarField;
+  title: _contractspec_lib_schema125.EntityScalarField;
+  description: _contractspec_lib_schema125.EntityScalarField;
+  amount: _contractspec_lib_schema125.EntityScalarField;
+  currency: _contractspec_lib_schema125.EntityScalarField;
+  status: _contractspec_lib_schema125.EntityEnumField;
+  validUntil: _contractspec_lib_schema125.EntityScalarField;
+  terms: _contractspec_lib_schema125.EntityScalarField;
+  orgId: _contractspec_lib_schema125.EntityScalarField;
+  ownerId: _contractspec_lib_schema125.EntityScalarField;
+  createdAt: _contractspec_lib_schema125.EntityScalarField;
+  updatedAt: _contractspec_lib_schema125.EntityScalarField;
+  client: _contractspec_lib_schema125.EntityRelationField;
+  jobs: _contractspec_lib_schema125.EntityRelationField;
+}> | _contractspec_lib_schema125.EntitySpec<{
+  id: _contractspec_lib_schema125.EntityScalarField;
+  quoteId: _contractspec_lib_schema125.EntityScalarField;
+  clientId: _contractspec_lib_schema125.EntityScalarField;
+  title: _contractspec_lib_schema125.EntityScalarField;
+  status: _contractspec_lib_schema125.EntityEnumField;
+  scheduledAt: _contractspec_lib_schema125.EntityScalarField;
+  completedAt: _contractspec_lib_schema125.EntityScalarField;
+  assignedTo: _contractspec_lib_schema125.EntityScalarField;
+  location: _contractspec_lib_schema125.EntityScalarField;
+  notes: _contractspec_lib_schema125.EntityScalarField;
+  orgId: _contractspec_lib_schema125.EntityScalarField;
+  createdAt: _contractspec_lib_schema125.EntityScalarField;
+  updatedAt: _contractspec_lib_schema125.EntityScalarField;
+  quote: _contractspec_lib_schema125.EntityRelationField;
+  client: _contractspec_lib_schema125.EntityRelationField;
+  invoices: _contractspec_lib_schema125.EntityRelationField;
+}> | _contractspec_lib_schema125.EntitySpec<{
+  id: _contractspec_lib_schema125.EntityScalarField;
+  jobId: _contractspec_lib_schema125.EntityScalarField;
+  invoiceNumber: _contractspec_lib_schema125.EntityScalarField;
+  amount: _contractspec_lib_schema125.EntityScalarField;
+  currency: _contractspec_lib_schema125.EntityScalarField;
+  status: _contractspec_lib_schema125.EntityEnumField;
+  dueDate: _contractspec_lib_schema125.EntityScalarField;
+  issuedAt: _contractspec_lib_schema125.EntityScalarField;
+  paidAt: _contractspec_lib_schema125.EntityScalarField;
+  orgId: _contractspec_lib_schema125.EntityScalarField;
+  notes: _contractspec_lib_schema125.EntityScalarField;
+  metadata: _contractspec_lib_schema125.EntityScalarField;
+  createdAt: _contractspec_lib_schema125.EntityScalarField;
+  updatedAt: _contractspec_lib_schema125.EntityScalarField;
+  job: _contractspec_lib_schema125.EntityRelationField;
+  payments: _contractspec_lib_schema125.EntityRelationField;
+}> | _contractspec_lib_schema125.EntitySpec<{
+  id: _contractspec_lib_schema125.EntityScalarField;
+  invoiceId: _contractspec_lib_schema125.EntityScalarField;
+  amount: _contractspec_lib_schema125.EntityScalarField;
+  currency: _contractspec_lib_schema125.EntityScalarField;
+  method: _contractspec_lib_schema125.EntityEnumField;
+  reference: _contractspec_lib_schema125.EntityScalarField;
+  receivedAt: _contractspec_lib_schema125.EntityScalarField;
+  orgId: _contractspec_lib_schema125.EntityScalarField;
+  createdAt: _contractspec_lib_schema125.EntityScalarField;
+  invoice: _contractspec_lib_schema125.EntityRelationField;
+}>)[];
+declare const serviceBusinessSchemaContribution: ModuleSchemaContribution;
+//#endregion
+export { ClientEntity, InvoiceEntity, InvoiceStatusEnum, JobEntity, JobStatusEnum, PaymentEntity, PaymentMethodEnum, QuoteEntity, QuoteStatusEnum, serviceBusinessEntities, serviceBusinessSchemaContribution };
+//# sourceMappingURL=index.d.ts.map

package/dist/entities/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/entities/index.ts"],"sourcesContent":[],"mappings":";;;;cAUa,iBAKX,2BAAA,CAL0B;cAOf,eAKX,2BAAA,CALwB;cAOb,mBAKX,2BAAA,CAL4B;AAdjB,cAqBA,iBAhBX,EAqBA,2BAAA,CAL4B,aAhB5B;AAEW,cAqBA,YAhBX,8BAgBuB,UAhBvB,CAAA;EAEW,EAAA,EA4CX,2BAAA,CAAA,iBAvCA;EAEW,IAAA,+CAKX;EAEW,YAAA,+CA8BX;EAAA,KAAA,+CAAA;;;;;;;;;;;cAEW,yCAAW;MA0CtB,2BAAA,CAAA;yDA1EuB;EAAA,KAAA,+CAAA;EAgCZ,WAAA,+CA0CX;EAAA,MAAA,+CAAA;;;;;;;;;;;;cAEW,uCAAS;MA8CpB,2BAAA,CAAA;;yDA1FsB;EAAA,KAAA,+CAAA;EA4CX,MAAA,6CA8CX;EAAA,WAAA,+CAAA;;;;;;;;;;;;cAEW,2CAAa;MAsCxB,2BAAA,CAAA;;;uDAtFoB;EAAA,QAAA,+CAAA;EAgDT,MAAA,6CAsCX;EAAA,OAAA,+CAAA;;;;;;;;;;;cAEW,2CAAa;MA4BxB,2BAAA,CAAA;;;;qDApEwB;EAAA,SAAA,+CAAA;EAwCb,UAAA,+CA4BX;EAAA,KAAA,+CAAA;;;;cAEW,sDAAuB;MAMnC,2BAAA,CAAA;;;;;yDApCyB;EAAA,KAAA,+CAAA;EA8Bb,OAAA,+CAMZ;EAAA,QAAA,+CAAA;;;;;;MANmC,2BAAA,CAAA;;;;;;;2DAAA;EAAA,KAAA,+CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAQvB,mCAAmC"}