@contractspec/example.service-business-os 1.56.1 → 1.58.0

package/dist/client/client.operations.js

@@ -1,53 +1,73 @@
-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.0.0",
-		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"
-			}
-		}]
-	}
+// @bun
+// src/client/client.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var 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 }
+  }
+});
+var 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 { CreateClientContract };
-//# sourceMappingURL=client.operations.js.map
+// src/client/client.operations.ts
+import { defineCommand } from "@contractspec/lib.contracts";
+var OWNERS = ["@examples.service-business-os"];
+var CreateClientContract = defineCommand({
+  meta: {
+    key: "service.client.create",
+    version: "1.0.0",
+    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" }
+      }
+    ]
+  }
+});
+export {
+  CreateClientContract
+};

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

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

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

@@ -1 +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"}
+{"version":3,"file":"client.schema.d.ts","sourceRoot":"","sources":["../../src/client/client.schema.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAYtB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;EAWjC,CAAC"}

package/dist/client/client.schema.js

@@ -1,77 +1,32 @@
-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
-		}
-	}
+// @bun
+// src/client/client.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var 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
-		}
-	}
+var 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
+export {
+  CreateClientInputModel,
+  ClientModel
+};

package/dist/client/index.d.ts

@@ -1,3 +1,6 @@
-import { CreateClientContract } from "./client.operations.js";
-import { ClientModel, CreateClientInputModel } from "./client.schema.js";
-export { ClientModel, CreateClientContract, CreateClientInputModel };
+/**
+ * Client domain - Client management.
+ */
+export { ClientModel, CreateClientInputModel } from './client.schema';
+export { CreateClientContract } from './client.operations';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/client/index.js

@@ -1,4 +1,75 @@
-import { ClientModel, CreateClientInputModel } from "./client.schema.js";
-import { CreateClientContract } from "./client.operations.js";
+// @bun
+// src/client/client.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var 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 }
+  }
+});
+var 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 }
+  }
+});
 
-export { ClientModel, CreateClientContract, CreateClientInputModel };
+// src/client/client.operations.ts
+import { defineCommand } from "@contractspec/lib.contracts";
+var OWNERS = ["@examples.service-business-os"];
+var CreateClientContract = defineCommand({
+  meta: {
+    key: "service.client.create",
+    version: "1.0.0",
+    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" }
+      }
+    ]
+  }
+});
+export {
+  CreateClientInputModel,
+  CreateClientContract,
+  ClientModel
+};

package/dist/docs/index.d.ts

@@ -1 +1,2 @@
-export { };
+import './service-business-os.docblock';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/docs/index.ts"],"names":[],"mappings":"AAAA,OAAO,gCAAgC,CAAC"}

package/dist/docs/index.js

@@ -1 +1,97 @@
-import "./service-business-os.docblock.js";
+// @bun
+// src/docs/service-business-os.docblock.ts
+import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
+var serviceBusinessDocBlocks = [
+  {
+    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** \u2192 create client, capture contact + owner.
+2) **Quote** \u2192 draft, send, accept/reject (events + notifications).
+3) **Job** \u2192 schedule, assign technician, complete with notes and attachments.
+4) **Invoice** \u2192 issue after completion, track status.
+5) **Payment** \u2192 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 \u2014 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 \u2192 quote \u2192 job \u2192 invoice \u2192 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 \u2014 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 \u2192 quote \u2192 job \u2192 invoice \u2192 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 \u2014 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.`
+  }
+];
+registerDocBlocks(serviceBusinessDocBlocks);

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

@@ -1 +1,2 @@
-export { };
+export {};
+//# sourceMappingURL=service-business-os.docblock.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"service-business-os.docblock.d.ts","sourceRoot":"","sources":["../../src/docs/service-business-os.docblock.ts"],"names":[],"mappings":""}