@contractspec/example.service-business-os 3.7.17 → 3.7.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (82) hide show
  1. package/dist/browser/client/client.operations.js +1 -72
  2. package/dist/browser/client/client.schema.js +1 -31
  3. package/dist/browser/client/index.js +1 -74
  4. package/dist/browser/docs/index.js +5 -49
  5. package/dist/browser/docs/service-business-os.docblock.js +5 -49
  6. package/dist/browser/entities/index.js +1 -246
  7. package/dist/browser/events.js +1 -135
  8. package/dist/browser/example.js +1 -39
  9. package/dist/browser/handlers/index.js +1 -5
  10. package/dist/browser/index.js +1 -766
  11. package/dist/browser/invoice/index.js +1 -77
  12. package/dist/browser/invoice/invoice.operations.js +1 -75
  13. package/dist/browser/invoice/invoice.schema.js +1 -34
  14. package/dist/browser/job/index.js +1 -175
  15. package/dist/browser/job/job.operations.js +1 -172
  16. package/dist/browser/job/job.schema.js +1 -41
  17. package/dist/browser/operations/index.js +1 -506
  18. package/dist/browser/payment/index.js +1 -69
  19. package/dist/browser/payment/payment.operations.js +1 -67
  20. package/dist/browser/payment/payment.schema.js +1 -30
  21. package/dist/browser/presentations/index.js +1 -13
  22. package/dist/browser/presentations.js +1 -175
  23. package/dist/browser/quote/index.js +1 -122
  24. package/dist/browser/quote/quote.operations.js +1 -119
  25. package/dist/browser/quote/quote.schema.js +1 -45
  26. package/dist/browser/service-business-os.capability.js +1 -31
  27. package/dist/browser/service.feature.js +1 -85
  28. package/dist/client/client.operations.js +1 -72
  29. package/dist/client/client.schema.js +1 -31
  30. package/dist/client/index.js +1 -74
  31. package/dist/docs/index.js +5 -49
  32. package/dist/docs/service-business-os.docblock.js +5 -49
  33. package/dist/entities/index.js +1 -246
  34. package/dist/events.js +1 -135
  35. package/dist/example.js +1 -39
  36. package/dist/handlers/index.js +1 -5
  37. package/dist/index.js +1 -766
  38. package/dist/invoice/index.js +1 -77
  39. package/dist/invoice/invoice.operations.js +1 -75
  40. package/dist/invoice/invoice.schema.js +1 -34
  41. package/dist/job/index.js +1 -175
  42. package/dist/job/job.operations.js +1 -172
  43. package/dist/job/job.schema.js +1 -41
  44. package/dist/node/client/client.operations.js +1 -72
  45. package/dist/node/client/client.schema.js +1 -31
  46. package/dist/node/client/index.js +1 -74
  47. package/dist/node/docs/index.js +5 -49
  48. package/dist/node/docs/service-business-os.docblock.js +5 -49
  49. package/dist/node/entities/index.js +1 -246
  50. package/dist/node/events.js +1 -135
  51. package/dist/node/example.js +1 -39
  52. package/dist/node/handlers/index.js +1 -5
  53. package/dist/node/index.js +1 -766
  54. package/dist/node/invoice/index.js +1 -77
  55. package/dist/node/invoice/invoice.operations.js +1 -75
  56. package/dist/node/invoice/invoice.schema.js +1 -34
  57. package/dist/node/job/index.js +1 -175
  58. package/dist/node/job/job.operations.js +1 -172
  59. package/dist/node/job/job.schema.js +1 -41
  60. package/dist/node/operations/index.js +1 -506
  61. package/dist/node/payment/index.js +1 -69
  62. package/dist/node/payment/payment.operations.js +1 -67
  63. package/dist/node/payment/payment.schema.js +1 -30
  64. package/dist/node/presentations/index.js +1 -13
  65. package/dist/node/presentations.js +1 -175
  66. package/dist/node/quote/index.js +1 -122
  67. package/dist/node/quote/quote.operations.js +1 -119
  68. package/dist/node/quote/quote.schema.js +1 -45
  69. package/dist/node/service-business-os.capability.js +1 -31
  70. package/dist/node/service.feature.js +1 -85
  71. package/dist/operations/index.js +1 -506
  72. package/dist/payment/index.js +1 -69
  73. package/dist/payment/payment.operations.js +1 -67
  74. package/dist/payment/payment.schema.js +1 -30
  75. package/dist/presentations/index.js +1 -13
  76. package/dist/presentations.js +1 -175
  77. package/dist/quote/index.js +1 -122
  78. package/dist/quote/quote.operations.js +1 -119
  79. package/dist/quote/quote.schema.js +1 -45
  80. package/dist/service-business-os.capability.js +1 -31
  81. package/dist/service.feature.js +1 -85
  82. package/package.json +5 -5
@@ -1,72 +1 @@
1
- // src/client/client.schema.ts
2
- import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
3
- var ClientModel = defineSchemaModel({
4
- name: "Client",
5
- description: "Client profile",
6
- fields: {
7
- id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
8
- name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
9
- contactEmail: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
10
- phone: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
11
- orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
12
- ownerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
13
- createdAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
14
- }
15
- });
16
- var CreateClientInputModel = defineSchemaModel({
17
- name: "CreateClientInput",
18
- description: "Input for creating a client",
19
- fields: {
20
- name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
21
- contactEmail: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
22
- phone: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
23
- orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
24
- ownerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
25
- metadata: { type: ScalarTypeEnum.JSON(), isOptional: true }
26
- }
27
- });
28
-
29
- // src/client/client.operations.ts
30
- import { defineCommand } from "@contractspec/lib.contracts-spec";
31
- var OWNERS = ["@examples.service-business-os"];
32
- var CreateClientContract = defineCommand({
33
- meta: {
34
- key: "service.client.create",
35
- version: "1.0.0",
36
- stability: "stable",
37
- owners: [...OWNERS],
38
- tags: ["service-business-os", "client", "create"],
39
- description: "Create a new client.",
40
- goal: "Onboard clients.",
41
- context: "CRM."
42
- },
43
- io: {
44
- input: CreateClientInputModel,
45
- output: ClientModel
46
- },
47
- policy: { auth: "user" },
48
- acceptance: {
49
- scenarios: [
50
- {
51
- key: "create-client-happy-path",
52
- given: ["User is authenticated"],
53
- when: ["User creates a new client"],
54
- then: ["Client is created"]
55
- }
56
- ],
57
- examples: [
58
- {
59
- key: "create-basic",
60
- input: {
61
- name: "Acme Corp",
62
- email: "contact@acme.com",
63
- phone: "555-0123"
64
- },
65
- output: { id: "client-123", name: "Acme Corp" }
66
- }
67
- ]
68
- }
69
- });
70
- export {
71
- CreateClientContract
72
- };
1
+ import{defineSchemaModel as k,ScalarTypeEnum as j}from"@contractspec/lib.schema";var q=k({name:"Client",description:"Client profile",fields:{id:{type:j.String_unsecure(),isOptional:!1},name:{type:j.String_unsecure(),isOptional:!1},contactEmail:{type:j.String_unsecure(),isOptional:!0},phone:{type:j.String_unsecure(),isOptional:!0},orgId:{type:j.String_unsecure(),isOptional:!1},ownerId:{type:j.String_unsecure(),isOptional:!1},createdAt:{type:j.DateTime(),isOptional:!1}}}),v=k({name:"CreateClientInput",description:"Input for creating a client",fields:{name:{type:j.String_unsecure(),isOptional:!1},contactEmail:{type:j.String_unsecure(),isOptional:!0},phone:{type:j.String_unsecure(),isOptional:!0},orgId:{type:j.String_unsecure(),isOptional:!1},ownerId:{type:j.String_unsecure(),isOptional:!1},metadata:{type:j.JSON(),isOptional:!0}}});import{defineCommand as w}from"@contractspec/lib.contracts-spec";var x=["@examples.service-business-os"],F=w({meta:{key:"service.client.create",version:"1.0.0",stability:"stable",owners:[...x],tags:["service-business-os","client","create"],description:"Create a new client.",goal:"Onboard clients.",context:"CRM."},io:{input:v,output:q},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{F as CreateClientContract};
@@ -1,31 +1 @@
1
- // src/client/client.schema.ts
2
- import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
3
- var ClientModel = defineSchemaModel({
4
- name: "Client",
5
- description: "Client profile",
6
- fields: {
7
- id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
8
- name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
9
- contactEmail: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
10
- phone: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
11
- orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
12
- ownerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
13
- createdAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
14
- }
15
- });
16
- var CreateClientInputModel = defineSchemaModel({
17
- name: "CreateClientInput",
18
- description: "Input for creating a client",
19
- fields: {
20
- name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
21
- contactEmail: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
22
- phone: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
23
- orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
24
- ownerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
25
- metadata: { type: ScalarTypeEnum.JSON(), isOptional: true }
26
- }
27
- });
28
- export {
29
- CreateClientInputModel,
30
- ClientModel
31
- };
1
+ import{defineSchemaModel as k,ScalarTypeEnum as j}from"@contractspec/lib.schema";var v=k({name:"Client",description:"Client profile",fields:{id:{type:j.String_unsecure(),isOptional:!1},name:{type:j.String_unsecure(),isOptional:!1},contactEmail:{type:j.String_unsecure(),isOptional:!0},phone:{type:j.String_unsecure(),isOptional:!0},orgId:{type:j.String_unsecure(),isOptional:!1},ownerId:{type:j.String_unsecure(),isOptional:!1},createdAt:{type:j.DateTime(),isOptional:!1}}}),w=k({name:"CreateClientInput",description:"Input for creating a client",fields:{name:{type:j.String_unsecure(),isOptional:!1},contactEmail:{type:j.String_unsecure(),isOptional:!0},phone:{type:j.String_unsecure(),isOptional:!0},orgId:{type:j.String_unsecure(),isOptional:!1},ownerId:{type:j.String_unsecure(),isOptional:!1},metadata:{type:j.JSON(),isOptional:!0}}});export{w as CreateClientInputModel,v as ClientModel};
@@ -1,74 +1 @@
1
- // src/client/client.schema.ts
2
- import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
3
- var ClientModel = defineSchemaModel({
4
- name: "Client",
5
- description: "Client profile",
6
- fields: {
7
- id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
8
- name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
9
- contactEmail: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
10
- phone: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
11
- orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
12
- ownerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
13
- createdAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
14
- }
15
- });
16
- var CreateClientInputModel = defineSchemaModel({
17
- name: "CreateClientInput",
18
- description: "Input for creating a client",
19
- fields: {
20
- name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
21
- contactEmail: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
22
- phone: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
23
- orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
24
- ownerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
25
- metadata: { type: ScalarTypeEnum.JSON(), isOptional: true }
26
- }
27
- });
28
-
29
- // src/client/client.operations.ts
30
- import { defineCommand } from "@contractspec/lib.contracts-spec";
31
- var OWNERS = ["@examples.service-business-os"];
32
- var CreateClientContract = defineCommand({
33
- meta: {
34
- key: "service.client.create",
35
- version: "1.0.0",
36
- stability: "stable",
37
- owners: [...OWNERS],
38
- tags: ["service-business-os", "client", "create"],
39
- description: "Create a new client.",
40
- goal: "Onboard clients.",
41
- context: "CRM."
42
- },
43
- io: {
44
- input: CreateClientInputModel,
45
- output: ClientModel
46
- },
47
- policy: { auth: "user" },
48
- acceptance: {
49
- scenarios: [
50
- {
51
- key: "create-client-happy-path",
52
- given: ["User is authenticated"],
53
- when: ["User creates a new client"],
54
- then: ["Client is created"]
55
- }
56
- ],
57
- examples: [
58
- {
59
- key: "create-basic",
60
- input: {
61
- name: "Acme Corp",
62
- email: "contact@acme.com",
63
- phone: "555-0123"
64
- },
65
- output: { id: "client-123", name: "Acme Corp" }
66
- }
67
- ]
68
- }
69
- });
70
- export {
71
- CreateClientInputModel,
72
- CreateClientContract,
73
- ClientModel
74
- };
1
+ import{defineSchemaModel as j,ScalarTypeEnum as C}from"@contractspec/lib.schema";var x=j({name:"Client",description:"Client profile",fields:{id:{type:C.String_unsecure(),isOptional:!1},name:{type:C.String_unsecure(),isOptional:!1},contactEmail:{type:C.String_unsecure(),isOptional:!0},phone:{type:C.String_unsecure(),isOptional:!0},orgId:{type:C.String_unsecure(),isOptional:!1},ownerId:{type:C.String_unsecure(),isOptional:!1},createdAt:{type:C.DateTime(),isOptional:!1}}}),g=j({name:"CreateClientInput",description:"Input for creating a client",fields:{name:{type:C.String_unsecure(),isOptional:!1},contactEmail:{type:C.String_unsecure(),isOptional:!0},phone:{type:C.String_unsecure(),isOptional:!0},orgId:{type:C.String_unsecure(),isOptional:!1},ownerId:{type:C.String_unsecure(),isOptional:!1},metadata:{type:C.JSON(),isOptional:!0}}});import{defineCommand as k}from"@contractspec/lib.contracts-spec";var q=["@examples.service-business-os"],v=k({meta:{key:"service.client.create",version:"1.0.0",stability:"stable",owners:[...q],tags:["service-business-os","client","create"],description:"Create a new client.",goal:"Onboard clients.",context:"CRM."},io:{input:g,output:x},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{g as CreateClientInputModel,v as CreateClientContract,x as ClientModel};
@@ -1,15 +1,4 @@
1
- // src/docs/service-business-os.docblock.ts
2
- import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
3
- var serviceBusinessDocBlocks = [
4
- {
5
- id: "docs.examples.service-business-os",
6
- title: "Service Business OS",
7
- summary: "Field/service business flow from client intake to quote, job scheduling, invoicing, and payments with notifications and audit trail.",
8
- kind: "reference",
9
- visibility: "public",
10
- route: "/docs/examples/service-business-os",
11
- tags: ["services", "quotes", "jobs", "invoices", "payments"],
12
- body: `## Flows
1
+ import{registerDocBlocks as m}from"@contractspec/lib.contracts-spec/docs";var f=[{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
13
2
 
14
3
  1) **Client intake** → create client, capture contact + owner.
15
4
  2) **Quote** → draft, send, accept/reject (events + notifications).
@@ -26,17 +15,7 @@ var serviceBusinessDocBlocks = [
26
15
 
27
16
  ## Presentations
28
17
  - Dashboard, client list, quote list/detail, job board, invoice list, payment list (React + Markdown targets).
29
- `
30
- },
31
- {
32
- id: "docs.examples.service-business-os.goal",
33
- title: "Service Business OS — Goal",
34
- summary: "Why this field-service OS exists and outcomes it targets.",
35
- kind: "goal",
36
- visibility: "public",
37
- route: "/docs/examples/service-business-os/goal",
38
- tags: ["services", "goal"],
39
- body: `## Why it matters
18
+ `},{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
40
19
  - Provides a regenerable, end-to-end service lifecycle (client → quote → job → invoice → payment).
41
20
  - Keeps pricing, scheduling, invoicing, and payments consistent across surfaces.
42
21
 
@@ -46,17 +25,7 @@ var serviceBusinessDocBlocks = [
46
25
 
47
26
  ## Success criteria
48
27
  - Spec changes regenerate UI/API/events cleanly across lifecycle steps.
49
- - Audit/Notifications/Jobs remain wired for every mutation.`
50
- },
51
- {
52
- id: "docs.examples.service-business-os.usage",
53
- title: "Service Business OS — Usage",
54
- summary: "How to operate, extend, and regenerate the service OS safely.",
55
- kind: "usage",
56
- visibility: "public",
57
- route: "/docs/examples/service-business-os/usage",
58
- tags: ["services", "usage"],
59
- body: `## Setup
28
+ - 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
60
29
  1) Seed (if provided) or create client → quote → job → invoice → payment via UI.
61
30
  2) Configure Files for attachments and Notifications for quote/job/invoice events.
62
31
 
@@ -68,17 +37,7 @@ var serviceBusinessDocBlocks = [
68
37
  ## Guardrails
69
38
  - Emit events for quote accepted/rejected, job scheduled/completed, invoice overdue, payment recorded.
70
39
  - Keep pricing/tax rules explicit in spec; avoid implicit handler math.
71
- - Use Audit Trail for lifecycle mutations; schedule reminders via Jobs.`
72
- },
73
- {
74
- id: "docs.examples.service-business-os.constraints",
75
- title: "Service Business OS — Constraints & Safety",
76
- summary: "Internal guardrails for quotes/jobs/invoices/payments and regeneration safety.",
77
- kind: "reference",
78
- visibility: "internal",
79
- route: "/docs/examples/service-business-os/constraints",
80
- tags: ["services", "constraints", "internal"],
81
- body: `## Constraints
40
+ - 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
82
41
  - Commission/tax/payment rules must be explicit in spec; no hidden handler math.
83
42
  - Events to emit: quote.sent/accepted/rejected, job.scheduled/completed, invoice.issued/overdue, payment.recorded.
84
43
  - Regeneration must not alter payment semantics without reviewed spec changes.
@@ -90,7 +49,4 @@ var serviceBusinessDocBlocks = [
90
49
  ## Verification
91
50
  - Add fixtures for quote/job/invoice state transitions.
92
51
  - Ensure Notifications/Audit/Jobs wiring persists after regeneration.
93
- - Use Feature Flags to trial new payment rules/reminder cadences; default safe/off.`
94
- }
95
- ];
96
- registerDocBlocks(serviceBusinessDocBlocks);
52
+ - Use Feature Flags to trial new payment rules/reminder cadences; default safe/off.`}];m(f);
@@ -1,15 +1,4 @@
1
- // src/docs/service-business-os.docblock.ts
2
- import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
3
- var serviceBusinessDocBlocks = [
4
- {
5
- id: "docs.examples.service-business-os",
6
- title: "Service Business OS",
7
- summary: "Field/service business flow from client intake to quote, job scheduling, invoicing, and payments with notifications and audit trail.",
8
- kind: "reference",
9
- visibility: "public",
10
- route: "/docs/examples/service-business-os",
11
- tags: ["services", "quotes", "jobs", "invoices", "payments"],
12
- body: `## Flows
1
+ import{registerDocBlocks as f}from"@contractspec/lib.contracts-spec/docs";var h=[{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
13
2
 
14
3
  1) **Client intake** → create client, capture contact + owner.
15
4
  2) **Quote** → draft, send, accept/reject (events + notifications).
@@ -26,17 +15,7 @@ var serviceBusinessDocBlocks = [
26
15
 
27
16
  ## Presentations
28
17
  - Dashboard, client list, quote list/detail, job board, invoice list, payment list (React + Markdown targets).
29
- `
30
- },
31
- {
32
- id: "docs.examples.service-business-os.goal",
33
- title: "Service Business OS — Goal",
34
- summary: "Why this field-service OS exists and outcomes it targets.",
35
- kind: "goal",
36
- visibility: "public",
37
- route: "/docs/examples/service-business-os/goal",
38
- tags: ["services", "goal"],
39
- body: `## Why it matters
18
+ `},{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
40
19
  - Provides a regenerable, end-to-end service lifecycle (client → quote → job → invoice → payment).
41
20
  - Keeps pricing, scheduling, invoicing, and payments consistent across surfaces.
42
21
 
@@ -46,17 +25,7 @@ var serviceBusinessDocBlocks = [
46
25
 
47
26
  ## Success criteria
48
27
  - Spec changes regenerate UI/API/events cleanly across lifecycle steps.
49
- - Audit/Notifications/Jobs remain wired for every mutation.`
50
- },
51
- {
52
- id: "docs.examples.service-business-os.usage",
53
- title: "Service Business OS — Usage",
54
- summary: "How to operate, extend, and regenerate the service OS safely.",
55
- kind: "usage",
56
- visibility: "public",
57
- route: "/docs/examples/service-business-os/usage",
58
- tags: ["services", "usage"],
59
- body: `## Setup
28
+ - 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
60
29
  1) Seed (if provided) or create client → quote → job → invoice → payment via UI.
61
30
  2) Configure Files for attachments and Notifications for quote/job/invoice events.
62
31
 
@@ -68,17 +37,7 @@ var serviceBusinessDocBlocks = [
68
37
  ## Guardrails
69
38
  - Emit events for quote accepted/rejected, job scheduled/completed, invoice overdue, payment recorded.
70
39
  - Keep pricing/tax rules explicit in spec; avoid implicit handler math.
71
- - Use Audit Trail for lifecycle mutations; schedule reminders via Jobs.`
72
- },
73
- {
74
- id: "docs.examples.service-business-os.constraints",
75
- title: "Service Business OS — Constraints & Safety",
76
- summary: "Internal guardrails for quotes/jobs/invoices/payments and regeneration safety.",
77
- kind: "reference",
78
- visibility: "internal",
79
- route: "/docs/examples/service-business-os/constraints",
80
- tags: ["services", "constraints", "internal"],
81
- body: `## Constraints
40
+ - 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
82
41
  - Commission/tax/payment rules must be explicit in spec; no hidden handler math.
83
42
  - Events to emit: quote.sent/accepted/rejected, job.scheduled/completed, invoice.issued/overdue, payment.recorded.
84
43
  - Regeneration must not alter payment semantics without reviewed spec changes.
@@ -90,7 +49,4 @@ var serviceBusinessDocBlocks = [
90
49
  ## Verification
91
50
  - Add fixtures for quote/job/invoice state transitions.
92
51
  - Ensure Notifications/Audit/Jobs wiring persists after regeneration.
93
- - Use Feature Flags to trial new payment rules/reminder cadences; default safe/off.`
94
- }
95
- ];
96
- registerDocBlocks(serviceBusinessDocBlocks);
52
+ - Use Feature Flags to trial new payment rules/reminder cadences; default safe/off.`}];f(h);
@@ -1,246 +1 @@
1
- // src/entities/index.ts
2
- import {
3
- defineEntity,
4
- defineEntityEnum,
5
- field,
6
- index
7
- } from "@contractspec/lib.schema";
8
- var schema = "lssm_service_os";
9
- var QuoteStatusEnum = defineEntityEnum({
10
- name: "QuoteStatus",
11
- schema,
12
- values: ["DRAFT", "SENT", "ACCEPTED", "REJECTED", "EXPIRED"],
13
- description: "Lifecycle for quotes/proposals."
14
- });
15
- var JobStatusEnum = defineEntityEnum({
16
- name: "JobStatus",
17
- schema,
18
- values: ["SCHEDULED", "IN_PROGRESS", "COMPLETED", "CANCELLED"],
19
- description: "Lifecycle for service jobs/interventions."
20
- });
21
- var InvoiceStatusEnum = defineEntityEnum({
22
- name: "InvoiceStatus",
23
- schema,
24
- values: ["DRAFT", "SENT", "PAID", "OVERDUE", "CANCELLED"],
25
- description: "Lifecycle for invoices."
26
- });
27
- var PaymentMethodEnum = defineEntityEnum({
28
- name: "PaymentMethod",
29
- schema,
30
- values: ["CARD", "BANK_TRANSFER", "CASH", "CHECK"],
31
- description: "Payment method used."
32
- });
33
- var ClientEntity = defineEntity({
34
- name: "Client",
35
- description: "Customer organization or individual.",
36
- schema,
37
- map: "client",
38
- fields: {
39
- id: field.id({ description: "Unique client identifier" }),
40
- name: field.string({ description: "Client display name" }),
41
- contactEmail: field.string({
42
- description: "Primary contact email",
43
- isOptional: true
44
- }),
45
- phone: field.string({ description: "Primary phone", isOptional: true }),
46
- address: field.json({ description: "Mailing address", isOptional: true }),
47
- industry: field.string({
48
- description: "Industry/vertical",
49
- isOptional: true
50
- }),
51
- orgId: field.string({ description: "Owning organization" }),
52
- ownerId: field.string({ description: "Account owner" }),
53
- metadata: field.json({
54
- description: "Additional metadata",
55
- isOptional: true
56
- }),
57
- createdAt: field.createdAt(),
58
- updatedAt: field.updatedAt(),
59
- quotes: field.hasMany("Quote"),
60
- jobs: field.hasMany("Job")
61
- },
62
- indexes: [index.on(["orgId"]), index.on(["ownerId"]), index.on(["name"])]
63
- });
64
- var QuoteEntity = defineEntity({
65
- name: "Quote",
66
- description: "Proposal/quote for a job.",
67
- schema,
68
- map: "quote",
69
- fields: {
70
- id: field.id({ description: "Unique quote identifier" }),
71
- clientId: field.foreignKey({ description: "Client receiving quote" }),
72
- title: field.string({ description: "Quote title" }),
73
- description: field.string({
74
- description: "Work summary",
75
- isOptional: true
76
- }),
77
- amount: field.float({ description: "Total quoted amount" }),
78
- currency: field.string({ description: "Currency code", default: '"USD"' }),
79
- status: field.enum("QuoteStatus", {
80
- description: "Quote status",
81
- default: "DRAFT"
82
- }),
83
- validUntil: field.dateTime({
84
- description: "Expiration date",
85
- isOptional: true
86
- }),
87
- terms: field.string({
88
- description: "Payment/engagement terms",
89
- isOptional: true
90
- }),
91
- orgId: field.string({ description: "Owning organization" }),
92
- ownerId: field.string({ description: "Account owner" }),
93
- createdAt: field.createdAt(),
94
- updatedAt: field.updatedAt(),
95
- client: field.belongsTo("Client", ["clientId"], ["id"], {
96
- onDelete: "Cascade"
97
- }),
98
- jobs: field.hasMany("Job")
99
- },
100
- enums: [QuoteStatusEnum],
101
- indexes: [
102
- index.on(["orgId", "status"]),
103
- index.on(["clientId"]),
104
- index.on(["validUntil"])
105
- ]
106
- });
107
- var JobEntity = defineEntity({
108
- name: "Job",
109
- description: "Service job/intervention derived from an accepted quote.",
110
- schema,
111
- map: "job",
112
- fields: {
113
- id: field.id({ description: "Unique job identifier" }),
114
- quoteId: field.foreignKey({ description: "Source quote" }),
115
- clientId: field.foreignKey({ description: "Client receiving service" }),
116
- title: field.string({ description: "Job title" }),
117
- status: field.enum("JobStatus", {
118
- description: "Job status",
119
- default: "SCHEDULED"
120
- }),
121
- scheduledAt: field.dateTime({
122
- description: "Scheduled start date/time",
123
- isOptional: true
124
- }),
125
- completedAt: field.dateTime({
126
- description: "Completion timestamp",
127
- isOptional: true
128
- }),
129
- assignedTo: field.string({
130
- description: "Assignee/technician user ID",
131
- isOptional: true
132
- }),
133
- location: field.json({ description: "Location details", isOptional: true }),
134
- notes: field.string({ description: "Internal notes", isOptional: true }),
135
- orgId: field.string({ description: "Owning organization" }),
136
- createdAt: field.createdAt(),
137
- updatedAt: field.updatedAt(),
138
- quote: field.belongsTo("Quote", ["quoteId"], ["id"], {
139
- onDelete: "SetNull"
140
- }),
141
- client: field.belongsTo("Client", ["clientId"], ["id"], {
142
- onDelete: "Cascade"
143
- }),
144
- invoices: field.hasMany("Invoice")
145
- },
146
- enums: [JobStatusEnum],
147
- indexes: [
148
- index.on(["orgId", "status"]),
149
- index.on(["clientId"]),
150
- index.on(["assignedTo", "status"]),
151
- index.on(["scheduledAt"])
152
- ]
153
- });
154
- var InvoiceEntity = defineEntity({
155
- name: "Invoice",
156
- description: "Invoice issued for a completed job.",
157
- schema,
158
- map: "invoice",
159
- fields: {
160
- id: field.id({ description: "Unique invoice identifier" }),
161
- jobId: field.foreignKey({ description: "Related job" }),
162
- invoiceNumber: field.string({
163
- description: "Invoice number",
164
- isUnique: true
165
- }),
166
- amount: field.decimal({ description: "Invoice amount" }),
167
- currency: field.string({ description: "Currency code", default: '"USD"' }),
168
- status: field.enum("InvoiceStatus", {
169
- description: "Invoice status",
170
- default: "DRAFT"
171
- }),
172
- dueDate: field.dateTime({ description: "Due date", isOptional: true }),
173
- issuedAt: field.dateTime({
174
- description: "Issued timestamp",
175
- isOptional: true
176
- }),
177
- paidAt: field.dateTime({ description: "Paid timestamp", isOptional: true }),
178
- orgId: field.string({ description: "Owning organization" }),
179
- notes: field.string({ description: "Invoice notes", isOptional: true }),
180
- metadata: field.json({ description: "Metadata", isOptional: true }),
181
- createdAt: field.createdAt(),
182
- updatedAt: field.updatedAt(),
183
- job: field.belongsTo("Job", ["jobId"], ["id"], { onDelete: "Cascade" }),
184
- payments: field.hasMany("Payment")
185
- },
186
- enums: [InvoiceStatusEnum],
187
- indexes: [
188
- index.on(["invoiceNumber"]),
189
- index.on(["orgId", "status"]),
190
- index.on(["dueDate"])
191
- ]
192
- });
193
- var PaymentEntity = defineEntity({
194
- name: "Payment",
195
- description: "Payment received for an invoice.",
196
- schema,
197
- map: "payment",
198
- fields: {
199
- id: field.id({ description: "Unique payment identifier" }),
200
- invoiceId: field.foreignKey({ description: "Invoice being paid" }),
201
- amount: field.decimal({ description: "Payment amount" }),
202
- currency: field.string({ description: "Currency code", default: '"USD"' }),
203
- method: field.enum("PaymentMethod", { description: "Payment method" }),
204
- reference: field.string({
205
- description: "Payment reference/transaction ID",
206
- isOptional: true
207
- }),
208
- receivedAt: field.dateTime({ description: "When payment was received" }),
209
- orgId: field.string({ description: "Owning organization" }),
210
- createdAt: field.createdAt(),
211
- invoice: field.belongsTo("Invoice", ["invoiceId"], ["id"], {
212
- onDelete: "Cascade"
213
- })
214
- },
215
- enums: [PaymentMethodEnum],
216
- indexes: [
217
- index.on(["invoiceId"]),
218
- index.on(["orgId"]),
219
- index.on(["receivedAt"])
220
- ]
221
- });
222
- var serviceBusinessEntities = [
223
- ClientEntity,
224
- QuoteEntity,
225
- JobEntity,
226
- InvoiceEntity,
227
- PaymentEntity
228
- ];
229
- var serviceBusinessSchemaContribution = {
230
- moduleId: "@contractspec/example.service-business-os",
231
- entities: serviceBusinessEntities,
232
- enums: [QuoteStatusEnum, JobStatusEnum, InvoiceStatusEnum, PaymentMethodEnum]
233
- };
234
- export {
235
- serviceBusinessSchemaContribution,
236
- serviceBusinessEntities,
237
- QuoteStatusEnum,
238
- QuoteEntity,
239
- PaymentMethodEnum,
240
- PaymentEntity,
241
- JobStatusEnum,
242
- JobEntity,
243
- InvoiceStatusEnum,
244
- InvoiceEntity,
245
- ClientEntity
246
- };
1
+ import{defineEntity as n,defineEntityEnum as o,field as e,index as t}from"@contractspec/lib.schema";var i="lssm_service_os",s=o({name:"QuoteStatus",schema:i,values:["DRAFT","SENT","ACCEPTED","REJECTED","EXPIRED"],description:"Lifecycle for quotes/proposals."}),r=o({name:"JobStatus",schema:i,values:["SCHEDULED","IN_PROGRESS","COMPLETED","CANCELLED"],description:"Lifecycle for service jobs/interventions."}),d=o({name:"InvoiceStatus",schema:i,values:["DRAFT","SENT","PAID","OVERDUE","CANCELLED"],description:"Lifecycle for invoices."}),a=o({name:"PaymentMethod",schema:i,values:["CARD","BANK_TRANSFER","CASH","CHECK"],description:"Payment method used."}),c=n({name:"Client",description:"Customer organization or individual.",schema:i,map:"client",fields:{id:e.id({description:"Unique client identifier"}),name:e.string({description:"Client display name"}),contactEmail:e.string({description:"Primary contact email",isOptional:!0}),phone:e.string({description:"Primary phone",isOptional:!0}),address:e.json({description:"Mailing address",isOptional:!0}),industry:e.string({description:"Industry/vertical",isOptional:!0}),orgId:e.string({description:"Owning organization"}),ownerId:e.string({description:"Account owner"}),metadata:e.json({description:"Additional metadata",isOptional:!0}),createdAt:e.createdAt(),updatedAt:e.updatedAt(),quotes:e.hasMany("Quote"),jobs:e.hasMany("Job")},indexes:[t.on(["orgId"]),t.on(["ownerId"]),t.on(["name"])]}),u=n({name:"Quote",description:"Proposal/quote for a job.",schema:i,map:"quote",fields:{id:e.id({description:"Unique quote identifier"}),clientId:e.foreignKey({description:"Client receiving quote"}),title:e.string({description:"Quote title"}),description:e.string({description:"Work summary",isOptional:!0}),amount:e.float({description:"Total quoted amount"}),currency:e.string({description:"Currency code",default:'"USD"'}),status:e.enum("QuoteStatus",{description:"Quote status",default:"DRAFT"}),validUntil:e.dateTime({description:"Expiration date",isOptional:!0}),terms:e.string({description:"Payment/engagement terms",isOptional:!0}),orgId:e.string({description:"Owning organization"}),ownerId:e.string({description:"Account owner"}),createdAt:e.createdAt(),updatedAt:e.updatedAt(),client:e.belongsTo("Client",["clientId"],["id"],{onDelete:"Cascade"}),jobs:e.hasMany("Job")},enums:[s],indexes:[t.on(["orgId","status"]),t.on(["clientId"]),t.on(["validUntil"])]}),p=n({name:"Job",description:"Service job/intervention derived from an accepted quote.",schema:i,map:"job",fields:{id:e.id({description:"Unique job identifier"}),quoteId:e.foreignKey({description:"Source quote"}),clientId:e.foreignKey({description:"Client receiving service"}),title:e.string({description:"Job title"}),status:e.enum("JobStatus",{description:"Job status",default:"SCHEDULED"}),scheduledAt:e.dateTime({description:"Scheduled start date/time",isOptional:!0}),completedAt:e.dateTime({description:"Completion timestamp",isOptional:!0}),assignedTo:e.string({description:"Assignee/technician user ID",isOptional:!0}),location:e.json({description:"Location details",isOptional:!0}),notes:e.string({description:"Internal notes",isOptional:!0}),orgId:e.string({description:"Owning organization"}),createdAt:e.createdAt(),updatedAt:e.updatedAt(),quote:e.belongsTo("Quote",["quoteId"],["id"],{onDelete:"SetNull"}),client:e.belongsTo("Client",["clientId"],["id"],{onDelete:"Cascade"}),invoices:e.hasMany("Invoice")},enums:[r],indexes:[t.on(["orgId","status"]),t.on(["clientId"]),t.on(["assignedTo","status"]),t.on(["scheduledAt"])]}),l=n({name:"Invoice",description:"Invoice issued for a completed job.",schema:i,map:"invoice",fields:{id:e.id({description:"Unique invoice identifier"}),jobId:e.foreignKey({description:"Related job"}),invoiceNumber:e.string({description:"Invoice number",isUnique:!0}),amount:e.decimal({description:"Invoice amount"}),currency:e.string({description:"Currency code",default:'"USD"'}),status:e.enum("InvoiceStatus",{description:"Invoice status",default:"DRAFT"}),dueDate:e.dateTime({description:"Due date",isOptional:!0}),issuedAt:e.dateTime({description:"Issued timestamp",isOptional:!0}),paidAt:e.dateTime({description:"Paid timestamp",isOptional:!0}),orgId:e.string({description:"Owning organization"}),notes:e.string({description:"Invoice notes",isOptional:!0}),metadata:e.json({description:"Metadata",isOptional:!0}),createdAt:e.createdAt(),updatedAt:e.updatedAt(),job:e.belongsTo("Job",["jobId"],["id"],{onDelete:"Cascade"}),payments:e.hasMany("Payment")},enums:[d],indexes:[t.on(["invoiceNumber"]),t.on(["orgId","status"]),t.on(["dueDate"])]}),m=n({name:"Payment",description:"Payment received for an invoice.",schema:i,map:"payment",fields:{id:e.id({description:"Unique payment identifier"}),invoiceId:e.foreignKey({description:"Invoice being paid"}),amount:e.decimal({description:"Payment amount"}),currency:e.string({description:"Currency code",default:'"USD"'}),method:e.enum("PaymentMethod",{description:"Payment method"}),reference:e.string({description:"Payment reference/transaction ID",isOptional:!0}),receivedAt:e.dateTime({description:"When payment was received"}),orgId:e.string({description:"Owning organization"}),createdAt:e.createdAt(),invoice:e.belongsTo("Invoice",["invoiceId"],["id"],{onDelete:"Cascade"})},enums:[a],indexes:[t.on(["invoiceId"]),t.on(["orgId"]),t.on(["receivedAt"])]}),g=[c,u,p,l,m],v={moduleId:"@contractspec/example.service-business-os",entities:g,enums:[s,r,d,a]};export{v as serviceBusinessSchemaContribution,g as serviceBusinessEntities,s as QuoteStatusEnum,u as QuoteEntity,a as PaymentMethodEnum,m as PaymentEntity,r as JobStatusEnum,p as JobEntity,d as InvoiceStatusEnum,l as InvoiceEntity,c as ClientEntity};