@contractspec/lib.personalization 1.56.1 → 1.58.0

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 (58) hide show
  1. package/dist/adapter.d.ts +15 -19
  2. package/dist/adapter.d.ts.map +1 -1
  3. package/dist/adapter.js +43 -38
  4. package/dist/analyzer.d.ts +15 -19
  5. package/dist/analyzer.d.ts.map +1 -1
  6. package/dist/analyzer.js +69 -51
  7. package/dist/browser/adapter.js +46 -0
  8. package/dist/browser/analyzer.js +72 -0
  9. package/dist/browser/docs/behavior-tracking.docblock.js +97 -0
  10. package/dist/browser/docs/index.js +271 -0
  11. package/dist/browser/docs/overlay-engine.docblock.js +98 -0
  12. package/dist/browser/docs/workflow-composition.docblock.js +83 -0
  13. package/dist/browser/index.js +555 -0
  14. package/dist/browser/store.js +75 -0
  15. package/dist/browser/tracker.js +94 -0
  16. package/dist/browser/types.js +0 -0
  17. package/dist/docs/behavior-tracking.docblock.d.ts +2 -6
  18. package/dist/docs/behavior-tracking.docblock.d.ts.map +1 -1
  19. package/dist/docs/behavior-tracking.docblock.js +95 -15
  20. package/dist/docs/index.d.ts +4 -3
  21. package/dist/docs/index.d.ts.map +1 -0
  22. package/dist/docs/index.js +272 -3
  23. package/dist/docs/overlay-engine.docblock.d.ts +2 -6
  24. package/dist/docs/overlay-engine.docblock.d.ts.map +1 -1
  25. package/dist/docs/overlay-engine.docblock.js +96 -15
  26. package/dist/docs/workflow-composition.docblock.d.ts +2 -6
  27. package/dist/docs/workflow-composition.docblock.d.ts.map +1 -1
  28. package/dist/docs/workflow-composition.docblock.js +81 -15
  29. package/dist/index.d.ts +7 -7
  30. package/dist/index.d.ts.map +1 -0
  31. package/dist/index.js +555 -6
  32. package/dist/node/adapter.js +46 -0
  33. package/dist/node/analyzer.js +72 -0
  34. package/dist/node/docs/behavior-tracking.docblock.js +97 -0
  35. package/dist/node/docs/index.js +271 -0
  36. package/dist/node/docs/overlay-engine.docblock.js +98 -0
  37. package/dist/node/docs/workflow-composition.docblock.js +83 -0
  38. package/dist/node/index.js +555 -0
  39. package/dist/node/store.js +75 -0
  40. package/dist/node/tracker.js +94 -0
  41. package/dist/node/types.js +0 -0
  42. package/dist/store.d.ts +14 -18
  43. package/dist/store.d.ts.map +1 -1
  44. package/dist/store.js +74 -57
  45. package/dist/tracker.d.ts +42 -46
  46. package/dist/tracker.d.ts.map +1 -1
  47. package/dist/tracker.js +93 -91
  48. package/dist/types.d.ts +48 -51
  49. package/dist/types.d.ts.map +1 -1
  50. package/dist/types.js +1 -0
  51. package/package.json +104 -37
  52. package/dist/adapter.js.map +0 -1
  53. package/dist/analyzer.js.map +0 -1
  54. package/dist/docs/behavior-tracking.docblock.js.map +0 -1
  55. package/dist/docs/overlay-engine.docblock.js.map +0 -1
  56. package/dist/docs/workflow-composition.docblock.js.map +0 -1
  57. package/dist/store.js.map +0 -1
  58. package/dist/tracker.js.map +0 -1
File without changes
@@ -1,7 +1,3 @@
1
- import { DocBlock } from "@contractspec/lib.contracts/docs";
2
-
3
- //#region src/docs/behavior-tracking.docblock.d.ts
4
- declare const personalization_behavior_tracking_DocBlocks: DocBlock[];
5
- //#endregion
6
- export { personalization_behavior_tracking_DocBlocks };
1
+ import type { DocBlock } from '@contractspec/lib.contracts/docs';
2
+ export declare const personalization_behavior_tracking_DocBlocks: DocBlock[];
7
3
  //# sourceMappingURL=behavior-tracking.docblock.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"behavior-tracking.docblock.d.ts","names":[],"sources":["../../src/docs/behavior-tracking.docblock.ts"],"sourcesContent":[],"mappings":";;;cAGa,6CAA6C"}
1
+ {"version":3,"file":"behavior-tracking.docblock.d.ts","sourceRoot":"","sources":["../../src/docs/behavior-tracking.docblock.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAGjE,eAAO,MAAM,2CAA2C,EAAE,QAAQ,EAYjE,CAAC"}
@@ -1,18 +1,98 @@
1
+ // @bun
2
+ // src/docs/behavior-tracking.docblock.ts
1
3
  import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
4
+ var personalization_behavior_tracking_DocBlocks = [
5
+ {
6
+ id: "docs.personalization.behavior-tracking",
7
+ title: "Behavior Tracking",
8
+ summary: "`@contractspec/lib.personalization` provides primitives to observe how tenants/users interact with specs and turn that telemetry into personalization insights.",
9
+ kind: "reference",
10
+ visibility: "public",
11
+ route: "/docs/personalization/behavior-tracking",
12
+ tags: ["personalization", "behavior-tracking"],
13
+ body: `# Behavior Tracking
14
+
15
+ \`@contractspec/lib.personalization\` provides primitives to observe how tenants/users interact with specs and turn that telemetry into personalization insights.
16
+
17
+ ## Tracker
18
+
19
+ \`\`\`ts
20
+ import { createBehaviorTracker } from '@contractspec/lib.personalization';
21
+ import { InMemoryBehaviorStore } from '@contractspec/lib.personalization/store';
22
+
23
+ const tracker = createBehaviorTracker({
24
+ store: new InMemoryBehaviorStore(),
25
+ context: { tenantId: ctx.tenant.id, userId: ctx.identity.userId },
26
+ autoFlushIntervalMs: 5000,
27
+ });
28
+
29
+ tracker.trackFieldAccess({ operation: 'billing.createOrder', field: 'internalNotes' });
30
+ tracker.trackFeatureUsage({ feature: 'workflow-editor', action: 'opened' });
31
+ tracker.trackWorkflowStep({ workflow: 'invoice-approval', step: 'review', status: 'entered' });
32
+ \`\`\`
33
+
34
+ All events are buffered and flushed either when the buffer hits 25 entries or when \`autoFlushIntervalMs\` elapses. Tracked metrics flow to OpenTelemetry via the meter/counter built into the tracker.
35
+
36
+ ## Analyzer
37
+
38
+ \`\`\`ts
39
+ import { BehaviorAnalyzer } from '@contractspec/lib.personalization/analyzer';
40
+
41
+ const analyzer = new BehaviorAnalyzer(store, { fieldInactivityThreshold: 2 });
42
+ const insights = await analyzer.analyze({ tenantId: 'acme', userId: 'manager-42', windowMs: 7 * 24 * 60 * 60 * 1000 });
43
+
44
+ /*
45
+ {
46
+ unusedFields: ['internalNotes'],
47
+ suggestedHiddenFields: ['internalNotes'],
48
+ frequentlyUsedFields: ['customerReference', 'items'],
49
+ workflowBottlenecks: [{ workflow: 'invoice-approval', step: 'finance-review', dropRate: 0.6 }],
50
+ layoutPreference: 'table'
51
+ }
52
+ */
53
+ \`\`\`
54
+
55
+ Use the analyzer output with the overlay adapter to generate suggestions automatically.
56
+
57
+ ## Adapter
58
+
59
+ \`\`\`ts
60
+ import { insightsToOverlaySuggestion } from '@contractspec/lib.personalization/adapter';
61
+
62
+ const overlay = insightsToOverlaySuggestion(insights, {
63
+ overlayId: 'acme-order-form',
64
+ tenantId: 'acme',
65
+ capability: 'billing.createOrder',
66
+ });
67
+ \`\`\`
68
+
69
+ When the adapter returns an overlay spec, pass it to the overlay engine to register or sign it.
70
+
71
+
72
+
2
73
 
3
- //#region src/docs/behavior-tracking.docblock.ts
4
- const personalization_behavior_tracking_DocBlocks = [{
5
- id: "docs.personalization.behavior-tracking",
6
- title: "Behavior Tracking",
7
- summary: "`@contractspec/lib.personalization` provides primitives to observe how tenants/users interact with specs and turn that telemetry into personalization insights.",
8
- kind: "reference",
9
- visibility: "public",
10
- route: "/docs/personalization/behavior-tracking",
11
- tags: ["personalization", "behavior-tracking"],
12
- body: "# Behavior Tracking\n\n`@contractspec/lib.personalization` provides primitives to observe how tenants/users interact with specs and turn that telemetry into personalization insights.\n\n## Tracker\n\n```ts\nimport { createBehaviorTracker } from '@contractspec/lib.personalization';\nimport { InMemoryBehaviorStore } from '@contractspec/lib.personalization/store';\n\nconst tracker = createBehaviorTracker({\n store: new InMemoryBehaviorStore(),\n context: { tenantId: ctx.tenant.id, userId: ctx.identity.userId },\n autoFlushIntervalMs: 5000,\n});\n\ntracker.trackFieldAccess({ operation: 'billing.createOrder', field: 'internalNotes' });\ntracker.trackFeatureUsage({ feature: 'workflow-editor', action: 'opened' });\ntracker.trackWorkflowStep({ workflow: 'invoice-approval', step: 'review', status: 'entered' });\n```\n\nAll events are buffered and flushed either when the buffer hits 25 entries or when `autoFlushIntervalMs` elapses. Tracked metrics flow to OpenTelemetry via the meter/counter built into the tracker.\n\n## Analyzer\n\n```ts\nimport { BehaviorAnalyzer } from '@contractspec/lib.personalization/analyzer';\n\nconst analyzer = new BehaviorAnalyzer(store, { fieldInactivityThreshold: 2 });\nconst insights = await analyzer.analyze({ tenantId: 'acme', userId: 'manager-42', windowMs: 7 * 24 * 60 * 60 * 1000 });\n\n/*\n{\n unusedFields: ['internalNotes'],\n suggestedHiddenFields: ['internalNotes'],\n frequentlyUsedFields: ['customerReference', 'items'],\n workflowBottlenecks: [{ workflow: 'invoice-approval', step: 'finance-review', dropRate: 0.6 }],\n layoutPreference: 'table'\n}\n*/\n```\n\nUse the analyzer output with the overlay adapter to generate suggestions automatically.\n\n## Adapter\n\n```ts\nimport { insightsToOverlaySuggestion } from '@contractspec/lib.personalization/adapter';\n\nconst overlay = insightsToOverlaySuggestion(insights, {\n overlayId: 'acme-order-form',\n tenantId: 'acme',\n capability: 'billing.createOrder',\n});\n```\n\nWhen the adapter returns an overlay spec, pass it to the overlay engine to register or sign it.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"
13
- }];
14
- registerDocBlocks(personalization_behavior_tracking_DocBlocks);
15
74
 
16
- //#endregion
17
- export { personalization_behavior_tracking_DocBlocks };
18
- //# sourceMappingURL=behavior-tracking.docblock.js.map
75
+
76
+
77
+
78
+
79
+
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+ `
93
+ }
94
+ ];
95
+ registerDocBlocks(personalization_behavior_tracking_DocBlocks);
96
+ export {
97
+ personalization_behavior_tracking_DocBlocks
98
+ };
@@ -1,3 +1,4 @@
1
- import "./behavior-tracking.docblock.js";
2
- import "./overlay-engine.docblock.js";
3
- import "./workflow-composition.docblock.js";
1
+ import './behavior-tracking.docblock';
2
+ import './overlay-engine.docblock';
3
+ import './workflow-composition.docblock';
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/docs/index.ts"],"names":[],"mappings":"AAAA,OAAO,8BAA8B,CAAC;AACtC,OAAO,2BAA2B,CAAC;AACnC,OAAO,iCAAiC,CAAC"}
@@ -1,3 +1,272 @@
1
- import "./behavior-tracking.docblock.js";
2
- import "./overlay-engine.docblock.js";
3
- import "./workflow-composition.docblock.js";
1
+ // @bun
2
+ // src/docs/behavior-tracking.docblock.ts
3
+ import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
4
+ var personalization_behavior_tracking_DocBlocks = [
5
+ {
6
+ id: "docs.personalization.behavior-tracking",
7
+ title: "Behavior Tracking",
8
+ summary: "`@contractspec/lib.personalization` provides primitives to observe how tenants/users interact with specs and turn that telemetry into personalization insights.",
9
+ kind: "reference",
10
+ visibility: "public",
11
+ route: "/docs/personalization/behavior-tracking",
12
+ tags: ["personalization", "behavior-tracking"],
13
+ body: `# Behavior Tracking
14
+
15
+ \`@contractspec/lib.personalization\` provides primitives to observe how tenants/users interact with specs and turn that telemetry into personalization insights.
16
+
17
+ ## Tracker
18
+
19
+ \`\`\`ts
20
+ import { createBehaviorTracker } from '@contractspec/lib.personalization';
21
+ import { InMemoryBehaviorStore } from '@contractspec/lib.personalization/store';
22
+
23
+ const tracker = createBehaviorTracker({
24
+ store: new InMemoryBehaviorStore(),
25
+ context: { tenantId: ctx.tenant.id, userId: ctx.identity.userId },
26
+ autoFlushIntervalMs: 5000,
27
+ });
28
+
29
+ tracker.trackFieldAccess({ operation: 'billing.createOrder', field: 'internalNotes' });
30
+ tracker.trackFeatureUsage({ feature: 'workflow-editor', action: 'opened' });
31
+ tracker.trackWorkflowStep({ workflow: 'invoice-approval', step: 'review', status: 'entered' });
32
+ \`\`\`
33
+
34
+ All events are buffered and flushed either when the buffer hits 25 entries or when \`autoFlushIntervalMs\` elapses. Tracked metrics flow to OpenTelemetry via the meter/counter built into the tracker.
35
+
36
+ ## Analyzer
37
+
38
+ \`\`\`ts
39
+ import { BehaviorAnalyzer } from '@contractspec/lib.personalization/analyzer';
40
+
41
+ const analyzer = new BehaviorAnalyzer(store, { fieldInactivityThreshold: 2 });
42
+ const insights = await analyzer.analyze({ tenantId: 'acme', userId: 'manager-42', windowMs: 7 * 24 * 60 * 60 * 1000 });
43
+
44
+ /*
45
+ {
46
+ unusedFields: ['internalNotes'],
47
+ suggestedHiddenFields: ['internalNotes'],
48
+ frequentlyUsedFields: ['customerReference', 'items'],
49
+ workflowBottlenecks: [{ workflow: 'invoice-approval', step: 'finance-review', dropRate: 0.6 }],
50
+ layoutPreference: 'table'
51
+ }
52
+ */
53
+ \`\`\`
54
+
55
+ Use the analyzer output with the overlay adapter to generate suggestions automatically.
56
+
57
+ ## Adapter
58
+
59
+ \`\`\`ts
60
+ import { insightsToOverlaySuggestion } from '@contractspec/lib.personalization/adapter';
61
+
62
+ const overlay = insightsToOverlaySuggestion(insights, {
63
+ overlayId: 'acme-order-form',
64
+ tenantId: 'acme',
65
+ capability: 'billing.createOrder',
66
+ });
67
+ \`\`\`
68
+
69
+ When the adapter returns an overlay spec, pass it to the overlay engine to register or sign it.
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+ `
93
+ }
94
+ ];
95
+ registerDocBlocks(personalization_behavior_tracking_DocBlocks);
96
+
97
+ // src/docs/overlay-engine.docblock.ts
98
+ import { registerDocBlocks as registerDocBlocks2 } from "@contractspec/lib.contracts/docs";
99
+ var personalization_overlay_engine_DocBlocks = [
100
+ {
101
+ id: "docs.personalization.overlay-engine",
102
+ title: "Overlay Engine",
103
+ summary: "`@contractspec/lib.overlay-engine` is the canonical runtime for OverlaySpecs. It validates specs, tracks scope precedence, and exposes hooks for React renderers.",
104
+ kind: "reference",
105
+ visibility: "public",
106
+ route: "/docs/personalization/overlay-engine",
107
+ tags: ["personalization", "overlay-engine"],
108
+ body: `# Overlay Engine
109
+
110
+ \`@contractspec/lib.overlay-engine\` is the canonical runtime for OverlaySpecs. It validates specs, tracks scope precedence, and exposes hooks for React renderers.
111
+
112
+ ## Key APIs
113
+
114
+ - \`defineOverlay(spec)\` \u2013 helper to keep specs typed.
115
+ - \`OverlayRegistry\` \u2013 register signed overlays and retrieve them per context.
116
+ - \`OverlayEngine\` \u2013 apply overlays to renderable targets, emit audit events, and merge modifications deterministically.
117
+ - \`signOverlay(spec, privateKey)\` \u2013 Ed25519/RSA-PSS signer.
118
+ - \`verifyOverlaySignature(overlay)\` \u2013 verify public key signatures.
119
+ - \`useOverlay(engine, params)\` \u2013 client hook that returns \`{ target, overlaysApplied }\`.
120
+
121
+ ## Scope Precedence
122
+
123
+ Registrations are sorted by specificity:
124
+
125
+ 1. Tenant overlays
126
+ 2. Role overlays
127
+ 3. User overlays
128
+ 4. Device overlays
129
+
130
+ Less specific overlays run first; more specific overlays override later.
131
+
132
+ ## Example
133
+
134
+ \`\`\`ts
135
+ const registry = new OverlayRegistry();
136
+ const engine = new OverlayEngine({
137
+ registry,
138
+ audit: (event) => auditLogService.record(event),
139
+ });
140
+
141
+ const overlay = defineOverlay({
142
+ overlayId: 'acme-order-form',
143
+ version: '1.0.0',
144
+ appliesTo: {
145
+ capability: 'billing.createOrder',
146
+ tenantId: 'acme',
147
+ },
148
+ modifications: [
149
+ { type: 'hideField', field: 'internalNotes' },
150
+ { type: 'renameLabel', field: 'customerReference', newLabel: 'PO Number' },
151
+ ],
152
+ });
153
+
154
+ const signedOverlay = await signOverlay(overlay, privateKeyPem);
155
+ registry.register(signedOverlay);
156
+
157
+ const result = engine.apply({
158
+ target: { fields: baseFields },
159
+ capability: 'billing.createOrder',
160
+ tenantId: 'acme',
161
+ userId: 'manager-7',
162
+ });
163
+ \`\`\`
164
+
165
+ \`result.target.fields\` now carries the hidden and renamed outputs ready for rendering.
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+ `
189
+ }
190
+ ];
191
+ registerDocBlocks2(personalization_overlay_engine_DocBlocks);
192
+
193
+ // src/docs/workflow-composition.docblock.ts
194
+ import { registerDocBlocks as registerDocBlocks3 } from "@contractspec/lib.contracts/docs";
195
+ var personalization_workflow_composition_DocBlocks = [
196
+ {
197
+ id: "docs.personalization.workflow-composition",
198
+ title: "Workflow Composition",
199
+ summary: "`@contractspec/lib.workflow-composer` composes base WorkflowSpecs with tenant/role/device-specific extensions.",
200
+ kind: "reference",
201
+ visibility: "public",
202
+ route: "/docs/personalization/workflow-composition",
203
+ tags: ["personalization", "workflow-composition"],
204
+ body: `# Workflow Composition
205
+
206
+ \`@contractspec/lib.workflow-composer\` composes base WorkflowSpecs with tenant/role/device-specific extensions.
207
+
208
+ ## Extensions
209
+
210
+ \`\`\`ts
211
+ import { WorkflowComposer } from '@contractspec/lib.workflow-composer';
212
+ import { approvalStepTemplate } from '@contractspec/lib.workflow-composer/templates';
213
+
214
+ const composer = new WorkflowComposer();
215
+
216
+ composer.register({
217
+ workflow: 'billing.invoiceApproval',
218
+ tenantId: 'acme',
219
+ priority: 10,
220
+ customSteps: [
221
+ {
222
+ after: 'validate-invoice',
223
+ inject: approvalStepTemplate({
224
+ id: 'acme-legal-review',
225
+ label: 'Legal Review (ACME)',
226
+ description: 'Tenant-specific compliance step.',
227
+ }),
228
+ transitionTo: 'final-approval',
229
+ },
230
+ ],
231
+ hiddenSteps: ['internal-audit'],
232
+ });
233
+ \`\`\`
234
+
235
+ ## Compose
236
+
237
+ \`\`\`ts
238
+ const runtimeSpec = composer.compose({
239
+ base: BaseInvoiceWorkflow,
240
+ tenantId: 'acme',
241
+ });
242
+
243
+ workflowRunner.execute(runtimeSpec, ctx);
244
+ \`\`\`
245
+
246
+ The composer uses anchor references (\`after\`/\`before\`) to place injected steps and cleans up transitions when steps are hidden.
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+ `
270
+ }
271
+ ];
272
+ registerDocBlocks3(personalization_workflow_composition_DocBlocks);
@@ -1,7 +1,3 @@
1
- import { DocBlock } from "@contractspec/lib.contracts/docs";
2
-
3
- //#region src/docs/overlay-engine.docblock.d.ts
4
- declare const personalization_overlay_engine_DocBlocks: DocBlock[];
5
- //#endregion
6
- export { personalization_overlay_engine_DocBlocks };
1
+ import type { DocBlock } from '@contractspec/lib.contracts/docs';
2
+ export declare const personalization_overlay_engine_DocBlocks: DocBlock[];
7
3
  //# sourceMappingURL=overlay-engine.docblock.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"overlay-engine.docblock.d.ts","names":[],"sources":["../../src/docs/overlay-engine.docblock.ts"],"sourcesContent":[],"mappings":";;;cAGa,0CAA0C"}
1
+ {"version":3,"file":"overlay-engine.docblock.d.ts","sourceRoot":"","sources":["../../src/docs/overlay-engine.docblock.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAGjE,eAAO,MAAM,wCAAwC,EAAE,QAAQ,EAY9D,CAAC"}
@@ -1,18 +1,99 @@
1
+ // @bun
2
+ // src/docs/overlay-engine.docblock.ts
1
3
  import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
4
+ var personalization_overlay_engine_DocBlocks = [
5
+ {
6
+ id: "docs.personalization.overlay-engine",
7
+ title: "Overlay Engine",
8
+ summary: "`@contractspec/lib.overlay-engine` is the canonical runtime for OverlaySpecs. It validates specs, tracks scope precedence, and exposes hooks for React renderers.",
9
+ kind: "reference",
10
+ visibility: "public",
11
+ route: "/docs/personalization/overlay-engine",
12
+ tags: ["personalization", "overlay-engine"],
13
+ body: `# Overlay Engine
14
+
15
+ \`@contractspec/lib.overlay-engine\` is the canonical runtime for OverlaySpecs. It validates specs, tracks scope precedence, and exposes hooks for React renderers.
16
+
17
+ ## Key APIs
18
+
19
+ - \`defineOverlay(spec)\` \u2013 helper to keep specs typed.
20
+ - \`OverlayRegistry\` \u2013 register signed overlays and retrieve them per context.
21
+ - \`OverlayEngine\` \u2013 apply overlays to renderable targets, emit audit events, and merge modifications deterministically.
22
+ - \`signOverlay(spec, privateKey)\` \u2013 Ed25519/RSA-PSS signer.
23
+ - \`verifyOverlaySignature(overlay)\` \u2013 verify public key signatures.
24
+ - \`useOverlay(engine, params)\` \u2013 client hook that returns \`{ target, overlaysApplied }\`.
25
+
26
+ ## Scope Precedence
27
+
28
+ Registrations are sorted by specificity:
29
+
30
+ 1. Tenant overlays
31
+ 2. Role overlays
32
+ 3. User overlays
33
+ 4. Device overlays
34
+
35
+ Less specific overlays run first; more specific overlays override later.
36
+
37
+ ## Example
38
+
39
+ \`\`\`ts
40
+ const registry = new OverlayRegistry();
41
+ const engine = new OverlayEngine({
42
+ registry,
43
+ audit: (event) => auditLogService.record(event),
44
+ });
45
+
46
+ const overlay = defineOverlay({
47
+ overlayId: 'acme-order-form',
48
+ version: '1.0.0',
49
+ appliesTo: {
50
+ capability: 'billing.createOrder',
51
+ tenantId: 'acme',
52
+ },
53
+ modifications: [
54
+ { type: 'hideField', field: 'internalNotes' },
55
+ { type: 'renameLabel', field: 'customerReference', newLabel: 'PO Number' },
56
+ ],
57
+ });
58
+
59
+ const signedOverlay = await signOverlay(overlay, privateKeyPem);
60
+ registry.register(signedOverlay);
61
+
62
+ const result = engine.apply({
63
+ target: { fields: baseFields },
64
+ capability: 'billing.createOrder',
65
+ tenantId: 'acme',
66
+ userId: 'manager-7',
67
+ });
68
+ \`\`\`
69
+
70
+ \`result.target.fields\` now carries the hidden and renamed outputs ready for rendering.
71
+
72
+
73
+
74
+
2
75
 
3
- //#region src/docs/overlay-engine.docblock.ts
4
- const personalization_overlay_engine_DocBlocks = [{
5
- id: "docs.personalization.overlay-engine",
6
- title: "Overlay Engine",
7
- summary: "`@contractspec/lib.overlay-engine` is the canonical runtime for OverlaySpecs. It validates specs, tracks scope precedence, and exposes hooks for React renderers.",
8
- kind: "reference",
9
- visibility: "public",
10
- route: "/docs/personalization/overlay-engine",
11
- tags: ["personalization", "overlay-engine"],
12
- body: "# Overlay Engine\n\n`@contractspec/lib.overlay-engine` is the canonical runtime for OverlaySpecs. It validates specs, tracks scope precedence, and exposes hooks for React renderers.\n\n## Key APIs\n\n- `defineOverlay(spec)` – helper to keep specs typed.\n- `OverlayRegistry` – register signed overlays and retrieve them per context.\n- `OverlayEngine` – apply overlays to renderable targets, emit audit events, and merge modifications deterministically.\n- `signOverlay(spec, privateKey)` – Ed25519/RSA-PSS signer.\n- `verifyOverlaySignature(overlay)` – verify public key signatures.\n- `useOverlay(engine, params)` – client hook that returns `{ target, overlaysApplied }`.\n\n## Scope Precedence\n\nRegistrations are sorted by specificity:\n\n1. Tenant overlays\n2. Role overlays\n3. User overlays\n4. Device overlays\n\nLess specific overlays run first; more specific overlays override later.\n\n## Example\n\n```ts\nconst registry = new OverlayRegistry();\nconst engine = new OverlayEngine({\n registry,\n audit: (event) => auditLogService.record(event),\n});\n\nconst overlay = defineOverlay({\n overlayId: 'acme-order-form',\n version: '1.0.0',\n appliesTo: {\n capability: 'billing.createOrder',\n tenantId: 'acme',\n },\n modifications: [\n { type: 'hideField', field: 'internalNotes' },\n { type: 'renameLabel', field: 'customerReference', newLabel: 'PO Number' },\n ],\n});\n\nconst signedOverlay = await signOverlay(overlay, privateKeyPem);\nregistry.register(signedOverlay);\n\nconst result = engine.apply({\n target: { fields: baseFields },\n capability: 'billing.createOrder',\n tenantId: 'acme',\n userId: 'manager-7',\n});\n```\n\n`result.target.fields` now carries the hidden and renamed outputs ready for rendering.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"
13
- }];
14
- registerDocBlocks(personalization_overlay_engine_DocBlocks);
15
76
 
16
- //#endregion
17
- export { personalization_overlay_engine_DocBlocks };
18
- //# sourceMappingURL=overlay-engine.docblock.js.map
77
+
78
+
79
+
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+ `
94
+ }
95
+ ];
96
+ registerDocBlocks(personalization_overlay_engine_DocBlocks);
97
+ export {
98
+ personalization_overlay_engine_DocBlocks
99
+ };
@@ -1,7 +1,3 @@
1
- import { DocBlock } from "@contractspec/lib.contracts/docs";
2
-
3
- //#region src/docs/workflow-composition.docblock.d.ts
4
- declare const personalization_workflow_composition_DocBlocks: DocBlock[];
5
- //#endregion
6
- export { personalization_workflow_composition_DocBlocks };
1
+ import type { DocBlock } from '@contractspec/lib.contracts/docs';
2
+ export declare const personalization_workflow_composition_DocBlocks: DocBlock[];
7
3
  //# sourceMappingURL=workflow-composition.docblock.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"workflow-composition.docblock.d.ts","names":[],"sources":["../../src/docs/workflow-composition.docblock.ts"],"sourcesContent":[],"mappings":";;;cAGa,gDAAgD"}
1
+ {"version":3,"file":"workflow-composition.docblock.d.ts","sourceRoot":"","sources":["../../src/docs/workflow-composition.docblock.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAGjE,eAAO,MAAM,8CAA8C,EAAE,QAAQ,EAYpE,CAAC"}
@@ -1,18 +1,84 @@
1
+ // @bun
2
+ // src/docs/workflow-composition.docblock.ts
1
3
  import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
4
+ var personalization_workflow_composition_DocBlocks = [
5
+ {
6
+ id: "docs.personalization.workflow-composition",
7
+ title: "Workflow Composition",
8
+ summary: "`@contractspec/lib.workflow-composer` composes base WorkflowSpecs with tenant/role/device-specific extensions.",
9
+ kind: "reference",
10
+ visibility: "public",
11
+ route: "/docs/personalization/workflow-composition",
12
+ tags: ["personalization", "workflow-composition"],
13
+ body: `# Workflow Composition
14
+
15
+ \`@contractspec/lib.workflow-composer\` composes base WorkflowSpecs with tenant/role/device-specific extensions.
16
+
17
+ ## Extensions
18
+
19
+ \`\`\`ts
20
+ import { WorkflowComposer } from '@contractspec/lib.workflow-composer';
21
+ import { approvalStepTemplate } from '@contractspec/lib.workflow-composer/templates';
22
+
23
+ const composer = new WorkflowComposer();
24
+
25
+ composer.register({
26
+ workflow: 'billing.invoiceApproval',
27
+ tenantId: 'acme',
28
+ priority: 10,
29
+ customSteps: [
30
+ {
31
+ after: 'validate-invoice',
32
+ inject: approvalStepTemplate({
33
+ id: 'acme-legal-review',
34
+ label: 'Legal Review (ACME)',
35
+ description: 'Tenant-specific compliance step.',
36
+ }),
37
+ transitionTo: 'final-approval',
38
+ },
39
+ ],
40
+ hiddenSteps: ['internal-audit'],
41
+ });
42
+ \`\`\`
43
+
44
+ ## Compose
45
+
46
+ \`\`\`ts
47
+ const runtimeSpec = composer.compose({
48
+ base: BaseInvoiceWorkflow,
49
+ tenantId: 'acme',
50
+ });
51
+
52
+ workflowRunner.execute(runtimeSpec, ctx);
53
+ \`\`\`
54
+
55
+ The composer uses anchor references (\`after\`/\`before\`) to place injected steps and cleans up transitions when steps are hidden.
56
+
57
+
58
+
59
+
60
+
61
+
2
62
 
3
- //#region src/docs/workflow-composition.docblock.ts
4
- const personalization_workflow_composition_DocBlocks = [{
5
- id: "docs.personalization.workflow-composition",
6
- title: "Workflow Composition",
7
- summary: "`@contractspec/lib.workflow-composer` composes base WorkflowSpecs with tenant/role/device-specific extensions.",
8
- kind: "reference",
9
- visibility: "public",
10
- route: "/docs/personalization/workflow-composition",
11
- tags: ["personalization", "workflow-composition"],
12
- body: "# Workflow Composition\n\n`@contractspec/lib.workflow-composer` composes base WorkflowSpecs with tenant/role/device-specific extensions.\n\n## Extensions\n\n```ts\nimport { WorkflowComposer } from '@contractspec/lib.workflow-composer';\nimport { approvalStepTemplate } from '@contractspec/lib.workflow-composer/templates';\n\nconst composer = new WorkflowComposer();\n\ncomposer.register({\n workflow: 'billing.invoiceApproval',\n tenantId: 'acme',\n priority: 10,\n customSteps: [\n {\n after: 'validate-invoice',\n inject: approvalStepTemplate({\n id: 'acme-legal-review',\n label: 'Legal Review (ACME)',\n description: 'Tenant-specific compliance step.',\n }),\n transitionTo: 'final-approval',\n },\n ],\n hiddenSteps: ['internal-audit'],\n});\n```\n\n## Compose\n\n```ts\nconst runtimeSpec = composer.compose({\n base: BaseInvoiceWorkflow,\n tenantId: 'acme',\n});\n\nworkflowRunner.execute(runtimeSpec, ctx);\n```\n\nThe composer uses anchor references (`after`/`before`) to place injected steps and cleans up transitions when steps are hidden.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"
13
- }];
14
- registerDocBlocks(personalization_workflow_composition_DocBlocks);
15
63
 
16
- //#endregion
17
- export { personalization_workflow_composition_DocBlocks };
18
- //# sourceMappingURL=workflow-composition.docblock.js.map
64
+
65
+
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+ `
79
+ }
80
+ ];
81
+ registerDocBlocks(personalization_workflow_composition_DocBlocks);
82
+ export {
83
+ personalization_workflow_composition_DocBlocks
84
+ };