@contractspec/lib.overlay-engine 1.57.0 → 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 (44) hide show
  1. package/dist/index.d.ts +8 -8
  2. package/dist/index.d.ts.map +1 -0
  3. package/dist/index.js +535 -8
  4. package/dist/merger.d.ts +5 -9
  5. package/dist/merger.d.ts.map +1 -1
  6. package/dist/merger.js +120 -101
  7. package/dist/node/index.js +534 -0
  8. package/dist/node/merger.js +125 -0
  9. package/dist/node/react.js +21 -0
  10. package/dist/node/registry.js +262 -0
  11. package/dist/node/runtime.js +176 -0
  12. package/dist/node/signer.js +81 -0
  13. package/dist/node/spec.js +15 -0
  14. package/dist/node/types.js +0 -0
  15. package/dist/node/validator.js +131 -0
  16. package/dist/react.d.ts +6 -9
  17. package/dist/react.d.ts.map +1 -1
  18. package/dist/react.js +17 -18
  19. package/dist/registry.d.ts +22 -25
  20. package/dist/registry.d.ts.map +1 -1
  21. package/dist/registry.js +254 -98
  22. package/dist/runtime.d.ts +19 -23
  23. package/dist/runtime.d.ts.map +1 -1
  24. package/dist/runtime.js +174 -51
  25. package/dist/signer.d.ts +13 -17
  26. package/dist/signer.d.ts.map +1 -1
  27. package/dist/signer.js +71 -52
  28. package/dist/spec.d.ts +65 -69
  29. package/dist/spec.d.ts.map +1 -1
  30. package/dist/spec.js +13 -12
  31. package/dist/types.d.ts +25 -28
  32. package/dist/types.d.ts.map +1 -1
  33. package/dist/types.js +1 -0
  34. package/dist/validator.d.ts +12 -16
  35. package/dist/validator.d.ts.map +1 -1
  36. package/dist/validator.js +123 -92
  37. package/package.json +75 -31
  38. package/dist/merger.js.map +0 -1
  39. package/dist/react.js.map +0 -1
  40. package/dist/registry.js.map +0 -1
  41. package/dist/runtime.js.map +0 -1
  42. package/dist/signer.js.map +0 -1
  43. package/dist/spec.js.map +0 -1
  44. package/dist/validator.js.map +0 -1
package/dist/types.d.ts CHANGED
@@ -1,33 +1,30 @@
1
- import { OverlayScopeContext, OverlayTargetRef, SignedOverlaySpec } from "./spec.js";
2
-
3
- //#region src/types.d.ts
4
- interface OverlayRenderableField {
5
- key: string;
6
- label?: string;
7
- visible?: boolean;
8
- required?: boolean;
9
- helpText?: string;
10
- defaultValue?: unknown;
11
- metadata?: Record<string, unknown>;
12
- order?: number;
1
+ import type { SignedOverlaySpec, OverlayScopeContext, OverlayTargetRef } from './spec';
2
+ export interface OverlayRenderableField {
3
+ key: string;
4
+ label?: string;
5
+ visible?: boolean;
6
+ required?: boolean;
7
+ helpText?: string;
8
+ defaultValue?: unknown;
9
+ metadata?: Record<string, unknown>;
10
+ order?: number;
13
11
  }
14
- interface OverlayLayoutConfig {
15
- kind?: 'form' | 'list' | 'table' | 'grid';
16
- columns?: number;
17
- density?: 'comfortable' | 'compact';
18
- [key: string]: unknown;
12
+ export interface OverlayLayoutConfig {
13
+ kind?: 'form' | 'list' | 'table' | 'grid';
14
+ columns?: number;
15
+ density?: 'comfortable' | 'compact';
16
+ [key: string]: unknown;
19
17
  }
20
- interface OverlayRenderable<TField extends OverlayRenderableField = OverlayRenderableField> {
21
- fields: TField[];
22
- layout?: OverlayLayoutConfig;
23
- metadata?: Record<string, unknown>;
18
+ export interface OverlayRenderable<TField extends OverlayRenderableField = OverlayRenderableField> {
19
+ fields: TField[];
20
+ layout?: OverlayLayoutConfig;
21
+ metadata?: Record<string, unknown>;
24
22
  }
25
- interface OverlayMatchContext extends OverlayScopeContext, OverlayTargetRef {}
26
- interface OverlayAuditEvent {
27
- overlay: Pick<SignedOverlaySpec, 'overlayId' | 'version'>;
28
- context: OverlayScopeContext;
29
- timestamp: string;
23
+ export interface OverlayMatchContext extends OverlayScopeContext, OverlayTargetRef {
24
+ }
25
+ export interface OverlayAuditEvent {
26
+ overlay: Pick<SignedOverlaySpec, 'overlayId' | 'version'>;
27
+ context: OverlayScopeContext;
28
+ timestamp: string;
30
29
  }
31
- //#endregion
32
- export { OverlayAuditEvent, OverlayLayoutConfig, OverlayMatchContext, OverlayRenderable, OverlayRenderableField };
33
30
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","names":[],"sources":["../src/types.ts"],"mappings":";;;UAMiB,sBAAA;EACf,GAAA;EACA,KAAA;EACA,OAAA;EACA,QAAA;EACA,QAAA;EACA,YAAA;EACA,QAAA,GAAW,MAAA;EACX,KAAA;AAAA;AAAA,UAGe,mBAAA;EACf,IAAA;EACA,OAAA;EACA,OAAA;EAAA,CACC,GAAA;AAAA;AAAA,UAGc,iBAAA,gBACA,sBAAA,GAAyB,sBAAA;EAExC,MAAA,EAAQ,MAAA;EACR,MAAA,GAAS,mBAAA;EACT,QAAA,GAAW,MAAA;AAAA;AAAA,UAGI,mBAAA,SACP,mBAAA,EAAqB,gBAAA;AAAA,UAEd,iBAAA;EACf,OAAA,EAAS,IAAA,CAAK,iBAAA;EACd,OAAA,EAAS,mBAAA;EACT,SAAA;AAAA"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EACjB,MAAM,QAAQ,CAAC;AAEhB,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACpC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB,CAChC,MAAM,SAAS,sBAAsB,GAAG,sBAAsB;IAE9D,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,mBACf,SAAQ,mBAAmB,EAAE,gBAAgB;CAAG;AAElD,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,WAAW,GAAG,SAAS,CAAC,CAAC;IAC1D,OAAO,EAAE,mBAAmB,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;CACnB"}
package/dist/types.js CHANGED
@@ -0,0 +1 @@
1
+ // @bun
@@ -1,19 +1,15 @@
1
- import { OverlaySpec } from "./spec.js";
2
-
3
- //#region src/validator.d.ts
4
- interface OverlayValidationIssue {
5
- code: string;
6
- message: string;
7
- path?: string[];
1
+ import type { OverlaySpec } from './spec';
2
+ export interface OverlayValidationIssue {
3
+ code: string;
4
+ message: string;
5
+ path?: string[];
8
6
  }
9
- interface OverlayValidationResult {
10
- valid: boolean;
11
- issues: OverlayValidationIssue[];
7
+ export interface OverlayValidationResult {
8
+ valid: boolean;
9
+ issues: OverlayValidationIssue[];
12
10
  }
13
- type OverlayValidator = (spec: OverlaySpec) => OverlayValidationResult;
14
- declare const defaultOverlayValidator: OverlayValidator;
15
- declare function validateOverlaySpec(spec: OverlaySpec): OverlayValidationResult;
16
- declare function assertOverlayValid(spec: OverlaySpec, validator?: OverlayValidator): void;
17
- //#endregion
18
- export { OverlayValidationIssue, OverlayValidationResult, OverlayValidator, assertOverlayValid, defaultOverlayValidator, validateOverlaySpec };
11
+ export type OverlayValidator = (spec: OverlaySpec) => OverlayValidationResult;
12
+ export declare const defaultOverlayValidator: OverlayValidator;
13
+ export declare function validateOverlaySpec(spec: OverlaySpec): OverlayValidationResult;
14
+ export declare function assertOverlayValid(spec: OverlaySpec, validator?: OverlayValidator): void;
19
15
  //# sourceMappingURL=validator.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"validator.d.ts","names":[],"sources":["../src/validator.ts"],"mappings":";;;UAEiB,sBAAA;EACf,IAAA;EACA,OAAA;EACA,IAAA;AAAA;AAAA,UAGe,uBAAA;EACf,KAAA;EACA,MAAA,EAAQ,sBAAA;AAAA;AAAA,KAGE,gBAAA,IAAoB,IAAA,EAAM,WAAA,KAAgB,uBAAA;AAAA,cAUzC,uBAAA,EAAyB,gBAAA;AAAA,iBAGtB,mBAAA,CACd,IAAA,EAAM,WAAA,GACL,uBAAA;AAAA,iBA6Ia,kBAAA,CACd,IAAA,EAAM,WAAA,EACN,SAAA,GAAW,gBAAA"}
1
+ {"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../src/validator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAuB,WAAW,EAAE,MAAM,QAAQ,CAAC;AAE/D,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,sBAAsB,EAAE,CAAC;CAClC;AAED,MAAM,MAAM,gBAAgB,GAAG,CAAC,IAAI,EAAE,WAAW,KAAK,uBAAuB,CAAC;AAU9E,eAAO,MAAM,uBAAuB,EAAE,gBACX,CAAC;AAE5B,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,WAAW,GAChB,uBAAuB,CAkDzB;AA2FD,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,WAAW,EACjB,SAAS,GAAE,gBAA0C,QAStD"}
package/dist/validator.js CHANGED
@@ -1,101 +1,132 @@
1
- //#region src/validator.ts
2
- const TARGET_KEYS = [
3
- "capability",
4
- "workflow",
5
- "dataView",
6
- "presentation",
7
- "operation"
1
+ // @bun
2
+ // src/validator.ts
3
+ var TARGET_KEYS = [
4
+ "capability",
5
+ "workflow",
6
+ "dataView",
7
+ "presentation",
8
+ "operation"
8
9
  ];
9
- const defaultOverlayValidator = (spec) => validateOverlaySpec(spec);
10
+ var defaultOverlayValidator = (spec) => validateOverlaySpec(spec);
10
11
  function validateOverlaySpec(spec) {
11
- const issues = [];
12
- if (!spec.overlayId?.trim()) issues.push({
13
- code: "overlay.id",
14
- message: "overlayId is required",
15
- path: ["overlayId"]
16
- });
17
- if (!spec.version?.trim()) issues.push({
18
- code: "overlay.version",
19
- message: "version is required",
20
- path: ["version"]
21
- });
22
- if (!TARGET_KEYS.some((key) => {
23
- const value = spec.appliesTo?.[key];
24
- return typeof value === "string" && value.trim().length > 0;
25
- })) issues.push({
26
- code: "overlay.target",
27
- message: "Overlay must specify at least one target (capability, workflow, dataView, presentation, or operation).",
28
- path: ["appliesTo"]
29
- });
30
- if (!spec.modifications?.length) issues.push({
31
- code: "overlay.modifications.empty",
32
- message: "Overlay must include at least one modification.",
33
- path: ["modifications"]
34
- });
35
- else spec.modifications.forEach((mod, idx) => {
36
- validateModification(mod, ["modifications", String(idx)], issues);
37
- });
38
- return {
39
- valid: issues.length === 0,
40
- issues
41
- };
12
+ const issues = [];
13
+ if (!spec.overlayId?.trim()) {
14
+ issues.push({
15
+ code: "overlay.id",
16
+ message: "overlayId is required",
17
+ path: ["overlayId"]
18
+ });
19
+ }
20
+ if (!spec.version?.trim()) {
21
+ issues.push({
22
+ code: "overlay.version",
23
+ message: "version is required",
24
+ path: ["version"]
25
+ });
26
+ }
27
+ const hasTarget = TARGET_KEYS.some((key) => {
28
+ const value = spec.appliesTo?.[key];
29
+ return typeof value === "string" && value.trim().length > 0;
30
+ });
31
+ if (!hasTarget) {
32
+ issues.push({
33
+ code: "overlay.target",
34
+ message: "Overlay must specify at least one target (capability, workflow, dataView, presentation, or operation).",
35
+ path: ["appliesTo"]
36
+ });
37
+ }
38
+ if (!spec.modifications?.length) {
39
+ issues.push({
40
+ code: "overlay.modifications.empty",
41
+ message: "Overlay must include at least one modification.",
42
+ path: ["modifications"]
43
+ });
44
+ } else {
45
+ spec.modifications.forEach((mod, idx) => {
46
+ const path = ["modifications", String(idx)];
47
+ validateModification(mod, path, issues);
48
+ });
49
+ }
50
+ return {
51
+ valid: issues.length === 0,
52
+ issues
53
+ };
42
54
  }
43
55
  function validateModification(modification, path, issues) {
44
- const push = (code, message, extraPath) => {
45
- issues.push({
46
- code,
47
- message,
48
- path: extraPath ? [...path, ...extraPath] : path
49
- });
50
- };
51
- if (isFieldModification(modification)) {
52
- if (!modification.field?.trim()) push("overlay.mod.field", "field is required for this modification", ["field"]);
53
- }
54
- switch (modification.type) {
55
- case "renameLabel":
56
- if (!modification.newLabel?.trim()) push("overlay.mod.renameLabel.newLabel", "newLabel is required", ["newLabel"]);
57
- break;
58
- case "reorderFields": {
59
- if (!modification.fields?.length) push("overlay.mod.reorderFields.fields", "fields list cannot be empty", ["fields"]);
60
- const seen = /* @__PURE__ */ new Set();
61
- for (const field of modification.fields ?? []) {
62
- if (!field?.trim()) {
63
- push("overlay.mod.reorderFields.fields.blank", "fields entries must be non-empty");
64
- break;
65
- }
66
- if (seen.has(field)) {
67
- push("overlay.mod.reorderFields.fields.duplicate", `field "${field}" was listed multiple times`);
68
- break;
69
- }
70
- seen.add(field);
71
- }
72
- break;
73
- }
74
- case "setDefault":
75
- if (modification.value === void 0) push("overlay.mod.setDefault.value", "value is required", ["value"]);
76
- break;
77
- case "addHelpText":
78
- if (!modification.text?.trim()) push("overlay.mod.addHelpText.text", "text is required", ["text"]);
79
- break;
80
- case "makeRequired":
81
- case "hideField": break;
82
- default: {
83
- const exhaustive = modification;
84
- throw new Error(`Unsupported overlay modification ${exhaustive?.type ?? "unknown"}`);
85
- }
86
- }
56
+ const push = (code, message, extraPath) => {
57
+ issues.push({
58
+ code,
59
+ message,
60
+ path: extraPath ? [...path, ...extraPath] : path
61
+ });
62
+ };
63
+ if (isFieldModification(modification)) {
64
+ if (!modification.field?.trim()) {
65
+ push("overlay.mod.field", "field is required for this modification", [
66
+ "field"
67
+ ]);
68
+ }
69
+ }
70
+ switch (modification.type) {
71
+ case "renameLabel": {
72
+ if (!modification.newLabel?.trim()) {
73
+ push("overlay.mod.renameLabel.newLabel", "newLabel is required", [
74
+ "newLabel"
75
+ ]);
76
+ }
77
+ break;
78
+ }
79
+ case "reorderFields": {
80
+ if (!modification.fields?.length) {
81
+ push("overlay.mod.reorderFields.fields", "fields list cannot be empty", ["fields"]);
82
+ }
83
+ const seen = new Set;
84
+ for (const field of modification.fields ?? []) {
85
+ if (!field?.trim()) {
86
+ push("overlay.mod.reorderFields.fields.blank", "fields entries must be non-empty");
87
+ break;
88
+ }
89
+ if (seen.has(field)) {
90
+ push("overlay.mod.reorderFields.fields.duplicate", `field "${field}" was listed multiple times`);
91
+ break;
92
+ }
93
+ seen.add(field);
94
+ }
95
+ break;
96
+ }
97
+ case "setDefault": {
98
+ if (modification.value === undefined) {
99
+ push("overlay.mod.setDefault.value", "value is required", ["value"]);
100
+ }
101
+ break;
102
+ }
103
+ case "addHelpText": {
104
+ if (!modification.text?.trim()) {
105
+ push("overlay.mod.addHelpText.text", "text is required", ["text"]);
106
+ }
107
+ break;
108
+ }
109
+ case "makeRequired":
110
+ case "hideField":
111
+ break;
112
+ default: {
113
+ const exhaustive = modification;
114
+ throw new Error(`Unsupported overlay modification ${exhaustive?.type ?? "unknown"}`);
115
+ }
116
+ }
87
117
  }
88
118
  function isFieldModification(mod) {
89
- return "field" in mod;
119
+ return "field" in mod;
90
120
  }
91
121
  function assertOverlayValid(spec, validator = defaultOverlayValidator) {
92
- const result = validator(spec);
93
- if (!result.valid) {
94
- const message = result.issues.map((issue) => `${issue.code}: ${issue.message}`).join("; ");
95
- throw new Error(`Invalid OverlaySpec "${spec.overlayId}": ${message}`);
96
- }
122
+ const result = validator(spec);
123
+ if (!result.valid) {
124
+ const message = result.issues.map((issue) => `${issue.code}: ${issue.message}`).join("; ");
125
+ throw new Error(`Invalid OverlaySpec "${spec.overlayId}": ${message}`);
126
+ }
97
127
  }
98
-
99
- //#endregion
100
- export { assertOverlayValid, defaultOverlayValidator, validateOverlaySpec };
101
- //# sourceMappingURL=validator.js.map
128
+ export {
129
+ validateOverlaySpec,
130
+ defaultOverlayValidator,
131
+ assertOverlayValid
132
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@contractspec/lib.overlay-engine",
3
- "version": "1.57.0",
3
+ "version": "1.58.0",
4
4
  "description": "Runtime overlay engine for ContractSpec personalization and adaptive UI rendering.",
5
5
  "keywords": [
6
6
  "contractspec",
@@ -19,18 +19,20 @@
19
19
  "scripts": {
20
20
  "publish:pkg": "bun publish --tolerate-republish --ignore-scripts --verbose",
21
21
  "publish:pkg:canary": "bun publish:pkg --tag canary",
22
- "build": "bun build:types && bun build:bundle",
23
- "build:bundle": "tsdown",
24
- "build:types": "tsc --noEmit",
25
- "dev": "bun build:bundle --watch",
22
+ "build": "bun run prebuild && bun run build:bundle && bun run build:types",
23
+ "build:bundle": "contractspec-bun-build transpile",
24
+ "build:types": "contractspec-bun-build types",
25
+ "dev": "contractspec-bun-build dev",
26
26
  "clean": "rimraf dist .turbo",
27
27
  "lint": "bun lint:fix",
28
28
  "lint:fix": "eslint src --fix",
29
29
  "lint:check": "eslint src",
30
- "test": "bun test"
30
+ "test": "bun test",
31
+ "prebuild": "contractspec-bun-build prebuild",
32
+ "typecheck": "tsc --noEmit"
31
33
  },
32
34
  "dependencies": {
33
- "@contractspec/lib.contracts": "1.57.0",
35
+ "@contractspec/lib.contracts": "1.58.0",
34
36
  "fast-json-stable-stringify": "^2.1.0"
35
37
  },
36
38
  "peerDependencies": {
@@ -42,36 +44,78 @@
42
44
  }
43
45
  },
44
46
  "devDependencies": {
45
- "@contractspec/tool.tsdown": "1.57.0",
46
- "@contractspec/tool.typescript": "1.57.0",
47
- "tsdown": "^0.20.3",
48
- "typescript": "^5.9.3"
47
+ "@contractspec/tool.typescript": "1.58.0",
48
+ "typescript": "^5.9.3",
49
+ "@contractspec/tool.bun": "1.57.0"
49
50
  },
50
51
  "exports": {
51
- ".": "./dist/index.js",
52
- "./merger": "./dist/merger.js",
53
- "./react": "./dist/react.js",
54
- "./registry": "./dist/registry.js",
55
- "./runtime": "./dist/runtime.js",
56
- "./signer": "./dist/signer.js",
57
- "./spec": "./dist/spec.js",
58
- "./types": "./dist/types.js",
59
- "./validator": "./dist/validator.js",
60
- "./*": "./*"
52
+ ".": "./src/index.ts",
53
+ "./merger": "./src/merger.ts",
54
+ "./react": "./src/react.ts",
55
+ "./registry": "./src/registry.ts",
56
+ "./runtime": "./src/runtime.ts",
57
+ "./signer": "./src/signer.ts",
58
+ "./spec": "./src/spec.ts",
59
+ "./types": "./src/types.ts",
60
+ "./validator": "./src/validator.ts"
61
61
  },
62
62
  "publishConfig": {
63
63
  "access": "public",
64
64
  "exports": {
65
- ".": "./dist/index.js",
66
- "./merger": "./dist/merger.js",
67
- "./react": "./dist/react.js",
68
- "./registry": "./dist/registry.js",
69
- "./runtime": "./dist/runtime.js",
70
- "./signer": "./dist/signer.js",
71
- "./spec": "./dist/spec.js",
72
- "./types": "./dist/types.js",
73
- "./validator": "./dist/validator.js",
74
- "./*": "./*"
65
+ ".": {
66
+ "types": "./dist/index.d.ts",
67
+ "bun": "./dist/index.js",
68
+ "node": "./dist/node/index.mjs",
69
+ "default": "./dist/index.js"
70
+ },
71
+ "./merger": {
72
+ "types": "./dist/merger.d.ts",
73
+ "bun": "./dist/merger.js",
74
+ "node": "./dist/node/merger.mjs",
75
+ "default": "./dist/merger.js"
76
+ },
77
+ "./react": {
78
+ "types": "./dist/react.d.ts",
79
+ "bun": "./dist/react.js",
80
+ "node": "./dist/node/react.mjs",
81
+ "default": "./dist/react.js"
82
+ },
83
+ "./registry": {
84
+ "types": "./dist/registry.d.ts",
85
+ "bun": "./dist/registry.js",
86
+ "node": "./dist/node/registry.mjs",
87
+ "default": "./dist/registry.js"
88
+ },
89
+ "./runtime": {
90
+ "types": "./dist/runtime.d.ts",
91
+ "bun": "./dist/runtime.js",
92
+ "node": "./dist/node/runtime.mjs",
93
+ "default": "./dist/runtime.js"
94
+ },
95
+ "./signer": {
96
+ "types": "./dist/signer.d.ts",
97
+ "bun": "./dist/signer.js",
98
+ "node": "./dist/node/signer.mjs",
99
+ "default": "./dist/signer.js"
100
+ },
101
+ "./spec": {
102
+ "types": "./dist/spec.d.ts",
103
+ "bun": "./dist/spec.js",
104
+ "node": "./dist/node/spec.mjs",
105
+ "default": "./dist/spec.js"
106
+ },
107
+ "./types": {
108
+ "types": "./dist/types.d.ts",
109
+ "bun": "./dist/types.js",
110
+ "node": "./dist/node/types.mjs",
111
+ "default": "./dist/types.js"
112
+ },
113
+ "./validator": {
114
+ "types": "./dist/validator.d.ts",
115
+ "bun": "./dist/validator.js",
116
+ "node": "./dist/node/validator.mjs",
117
+ "default": "./dist/validator.js"
118
+ }
75
119
  },
76
120
  "registry": "https://registry.npmjs.org/"
77
121
  },
@@ -1 +0,0 @@
1
- {"version":3,"file":"merger.js","names":[],"sources":["../src/merger.ts"],"sourcesContent":["import type { SignedOverlaySpec } from './spec';\nimport type { OverlayRenderable, OverlayRenderableField } from './types';\n\nexport interface ApplyOverlayOptions {\n strict?: boolean;\n}\n\ninterface FieldState<TField extends OverlayRenderableField> {\n key: string;\n field: TField;\n hidden: boolean;\n}\n\nexport function applyOverlayModifications<T extends OverlayRenderable>(\n target: T,\n overlays: SignedOverlaySpec[],\n options: ApplyOverlayOptions = {}\n): T {\n if (!overlays.length) {\n return target;\n }\n\n const states = target.fields.map<FieldState<OverlayRenderableField>>(\n (field) => ({\n key: field.key,\n field: { ...field },\n hidden: field.visible === false,\n })\n );\n\n const fieldMap = new Map(states.map((state) => [state.key, state]));\n let orderSequence = target.fields.map((field) => field.key);\n\n const handleMissing = (field: string, overlayId: string) => {\n if (options.strict) {\n throw new Error(\n `Overlay \"${overlayId}\" referenced unknown field \"${field}\".`\n );\n }\n };\n\n overlays.forEach((overlay) => {\n overlay.modifications.forEach((modification) => {\n switch (modification.type) {\n case 'hideField': {\n const state = fieldMap.get(modification.field);\n if (!state)\n return handleMissing(modification.field, overlay.overlayId);\n state.hidden = true;\n state.field.visible = false;\n break;\n }\n case 'renameLabel': {\n const state = fieldMap.get(modification.field);\n if (!state)\n return handleMissing(modification.field, overlay.overlayId);\n state.field.label = modification.newLabel;\n break;\n }\n case 'setDefault': {\n const state = fieldMap.get(modification.field);\n if (!state)\n return handleMissing(modification.field, overlay.overlayId);\n state.field.defaultValue = modification.value;\n break;\n }\n case 'addHelpText': {\n const state = fieldMap.get(modification.field);\n if (!state)\n return handleMissing(modification.field, overlay.overlayId);\n state.field.helpText = modification.text;\n break;\n }\n case 'makeRequired': {\n const state = fieldMap.get(modification.field);\n if (!state)\n return handleMissing(modification.field, overlay.overlayId);\n state.field.required = modification.required ?? true;\n break;\n }\n case 'reorderFields': {\n const { filtered, missing } = normalizeOrderList(\n modification.fields,\n fieldMap\n );\n if (missing.length && options.strict) {\n missing.forEach((field) => handleMissing(field, overlay.overlayId));\n }\n orderSequence = applyReorder(orderSequence, filtered);\n break;\n }\n default:\n break;\n }\n });\n });\n\n const visibleFields: OverlayRenderableField[] = [];\n const seen = new Set<string>();\n orderSequence.forEach((key) => {\n const state = fieldMap.get(key);\n if (!state || state.hidden) {\n return;\n }\n seen.add(key);\n visibleFields.push(state.field);\n });\n\n // Handle any fields introduced dynamically that were not part of the original sequence.\n states.forEach((state) => {\n if (state.hidden || seen.has(state.key)) {\n return;\n }\n visibleFields.push(state.field);\n });\n\n visibleFields.forEach((field, index) => {\n field.order = index;\n field.visible = true;\n });\n\n return {\n ...(target as T),\n fields: visibleFields as T['fields'],\n };\n}\n\nfunction normalizeOrderList(\n fields: string[],\n fieldMap: Map<string, FieldState<OverlayRenderableField>>\n): { filtered: string[]; missing: string[] } {\n const filtered: string[] = [];\n const missing: string[] = [];\n const seen = new Set<string>();\n\n fields.forEach((field) => {\n if (!field?.trim()) {\n return;\n }\n if (!fieldMap.has(field)) {\n missing.push(field);\n return;\n }\n if (seen.has(field)) {\n return;\n }\n seen.add(field);\n filtered.push(field);\n });\n\n return { filtered, missing };\n}\n\nfunction applyReorder(sequence: string[], orderedFields: string[]): string[] {\n if (!orderedFields.length) {\n return sequence;\n }\n const orderedSet = new Set(orderedFields);\n const remainder = sequence.filter((key) => !orderedSet.has(key));\n return [...orderedFields, ...remainder];\n}\n"],"mappings":";AAaA,SAAgB,0BACd,QACA,UACA,UAA+B,EAAE,EAC9B;AACH,KAAI,CAAC,SAAS,OACZ,QAAO;CAGT,MAAM,SAAS,OAAO,OAAO,KAC1B,WAAW;EACV,KAAK,MAAM;EACX,OAAO,EAAE,GAAG,OAAO;EACnB,QAAQ,MAAM,YAAY;EAC3B,EACF;CAED,MAAM,WAAW,IAAI,IAAI,OAAO,KAAK,UAAU,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;CACnE,IAAI,gBAAgB,OAAO,OAAO,KAAK,UAAU,MAAM,IAAI;CAE3D,MAAM,iBAAiB,OAAe,cAAsB;AAC1D,MAAI,QAAQ,OACV,OAAM,IAAI,MACR,YAAY,UAAU,8BAA8B,MAAM,IAC3D;;AAIL,UAAS,SAAS,YAAY;AAC5B,UAAQ,cAAc,SAAS,iBAAiB;AAC9C,WAAQ,aAAa,MAArB;IACE,KAAK,aAAa;KAChB,MAAM,QAAQ,SAAS,IAAI,aAAa,MAAM;AAC9C,SAAI,CAAC,MACH,QAAO,cAAc,aAAa,OAAO,QAAQ,UAAU;AAC7D,WAAM,SAAS;AACf,WAAM,MAAM,UAAU;AACtB;;IAEF,KAAK,eAAe;KAClB,MAAM,QAAQ,SAAS,IAAI,aAAa,MAAM;AAC9C,SAAI,CAAC,MACH,QAAO,cAAc,aAAa,OAAO,QAAQ,UAAU;AAC7D,WAAM,MAAM,QAAQ,aAAa;AACjC;;IAEF,KAAK,cAAc;KACjB,MAAM,QAAQ,SAAS,IAAI,aAAa,MAAM;AAC9C,SAAI,CAAC,MACH,QAAO,cAAc,aAAa,OAAO,QAAQ,UAAU;AAC7D,WAAM,MAAM,eAAe,aAAa;AACxC;;IAEF,KAAK,eAAe;KAClB,MAAM,QAAQ,SAAS,IAAI,aAAa,MAAM;AAC9C,SAAI,CAAC,MACH,QAAO,cAAc,aAAa,OAAO,QAAQ,UAAU;AAC7D,WAAM,MAAM,WAAW,aAAa;AACpC;;IAEF,KAAK,gBAAgB;KACnB,MAAM,QAAQ,SAAS,IAAI,aAAa,MAAM;AAC9C,SAAI,CAAC,MACH,QAAO,cAAc,aAAa,OAAO,QAAQ,UAAU;AAC7D,WAAM,MAAM,WAAW,aAAa,YAAY;AAChD;;IAEF,KAAK,iBAAiB;KACpB,MAAM,EAAE,UAAU,YAAY,mBAC5B,aAAa,QACb,SACD;AACD,SAAI,QAAQ,UAAU,QAAQ,OAC5B,SAAQ,SAAS,UAAU,cAAc,OAAO,QAAQ,UAAU,CAAC;AAErE,qBAAgB,aAAa,eAAe,SAAS;AACrD;;IAEF,QACE;;IAEJ;GACF;CAEF,MAAM,gBAA0C,EAAE;CAClD,MAAM,uBAAO,IAAI,KAAa;AAC9B,eAAc,SAAS,QAAQ;EAC7B,MAAM,QAAQ,SAAS,IAAI,IAAI;AAC/B,MAAI,CAAC,SAAS,MAAM,OAClB;AAEF,OAAK,IAAI,IAAI;AACb,gBAAc,KAAK,MAAM,MAAM;GAC/B;AAGF,QAAO,SAAS,UAAU;AACxB,MAAI,MAAM,UAAU,KAAK,IAAI,MAAM,IAAI,CACrC;AAEF,gBAAc,KAAK,MAAM,MAAM;GAC/B;AAEF,eAAc,SAAS,OAAO,UAAU;AACtC,QAAM,QAAQ;AACd,QAAM,UAAU;GAChB;AAEF,QAAO;EACL,GAAI;EACJ,QAAQ;EACT;;AAGH,SAAS,mBACP,QACA,UAC2C;CAC3C,MAAM,WAAqB,EAAE;CAC7B,MAAM,UAAoB,EAAE;CAC5B,MAAM,uBAAO,IAAI,KAAa;AAE9B,QAAO,SAAS,UAAU;AACxB,MAAI,CAAC,OAAO,MAAM,CAChB;AAEF,MAAI,CAAC,SAAS,IAAI,MAAM,EAAE;AACxB,WAAQ,KAAK,MAAM;AACnB;;AAEF,MAAI,KAAK,IAAI,MAAM,CACjB;AAEF,OAAK,IAAI,MAAM;AACf,WAAS,KAAK,MAAM;GACpB;AAEF,QAAO;EAAE;EAAU;EAAS;;AAG9B,SAAS,aAAa,UAAoB,eAAmC;AAC3E,KAAI,CAAC,cAAc,OACjB,QAAO;CAET,MAAM,aAAa,IAAI,IAAI,cAAc;CACzC,MAAM,YAAY,SAAS,QAAQ,QAAQ,CAAC,WAAW,IAAI,IAAI,CAAC;AAChE,QAAO,CAAC,GAAG,eAAe,GAAG,UAAU"}
package/dist/react.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"react.js","names":[],"sources":["../src/react.ts"],"sourcesContent":["import { useMemo, type DependencyList } from 'react';\nimport type { OverlayRenderable } from './types';\nimport type { OverlayApplyParams, OverlayRuntimeResult } from './runtime';\nimport { OverlayEngine } from './runtime';\n\nexport function useOverlay<T extends OverlayRenderable>(\n engine: OverlayEngine | undefined,\n params: OverlayApplyParams<T>,\n deps: DependencyList = []\n): OverlayRuntimeResult<T> {\n return useMemo(() => {\n if (!engine) {\n return {\n target: params.target,\n overlaysApplied: [],\n };\n }\n return engine.apply(params);\n }, [engine, params, ...deps]);\n}\n\nexport function useOverlayFields<T extends OverlayRenderable>(\n engine: OverlayEngine | undefined,\n params: OverlayApplyParams<T>,\n deps: DependencyList = []\n): T['fields'] {\n const result = useOverlay(engine, params, deps);\n return result.target.fields;\n}\n"],"mappings":";;;AAKA,SAAgB,WACd,QACA,QACA,OAAuB,EAAE,EACA;AACzB,QAAO,cAAc;AACnB,MAAI,CAAC,OACH,QAAO;GACL,QAAQ,OAAO;GACf,iBAAiB,EAAE;GACpB;AAEH,SAAO,OAAO,MAAM,OAAO;IAC1B;EAAC;EAAQ;EAAQ,GAAG;EAAK,CAAC;;AAG/B,SAAgB,iBACd,QACA,QACA,OAAuB,EAAE,EACZ;AAEb,QADe,WAAW,QAAQ,QAAQ,KAAK,CACjC,OAAO"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"registry.js","names":[],"sources":["../src/registry.ts"],"sourcesContent":["import type {\n OverlayInput,\n OverlayAppliesTo,\n OverlayScopeContext,\n OverlayTargetRef,\n SignedOverlaySpec,\n} from './spec';\nimport type { OverlayValidator } from './validator';\nimport { defaultOverlayValidator } from './validator';\n\nexport interface OverlayRegistryOptions {\n validator?: OverlayValidator;\n allowUnsigned?: boolean;\n}\n\nexport interface OverlayLookup extends OverlayScopeContext, OverlayTargetRef {}\n\ninterface StoredOverlay {\n overlay: SignedOverlaySpec;\n specificity: number;\n registeredAt: number;\n}\n\nconst TARGET_KEYS: (keyof OverlayTargetRef)[] = [\n 'capability',\n 'workflow',\n 'dataView',\n 'presentation',\n 'operation',\n];\n\nconst SCOPE_WEIGHTS: Record<keyof OverlayScopeContext, number> = {\n tenantId: 8,\n role: 4,\n userId: 16,\n device: 2,\n tags: 1,\n};\n\nexport class OverlayRegistry {\n private readonly overlays = new Map<string, StoredOverlay>();\n\n constructor(private readonly options: OverlayRegistryOptions = {}) {}\n\n register(\n overlay: OverlayInput,\n options?: { skipValidation?: boolean }\n ): SignedOverlaySpec {\n if (!options?.skipValidation) {\n const validator = this.options.validator ?? defaultOverlayValidator;\n const result = validator(overlay as SignedOverlaySpec);\n if (!result.valid) {\n const reason = result.issues\n .map((issue) => `${issue.code}: ${issue.message}`)\n .join('; ');\n throw new Error(\n `Overlay \"${overlay.overlayId}\" failed validation: ${reason}`\n );\n }\n }\n\n const normalized = this.ensureSigned(overlay);\n const key = this.getKey(normalized.overlayId, normalized.version);\n const stored: StoredOverlay = {\n overlay: normalized,\n specificity: computeSpecificity(normalized.appliesTo),\n registeredAt: Date.now(),\n };\n this.overlays.set(key, stored);\n return normalized;\n }\n\n unregister(overlayId: string, version?: string) {\n if (version) {\n this.overlays.delete(this.getKey(overlayId, version));\n return;\n }\n\n for (const key of Array.from(this.overlays.keys())) {\n if (key.startsWith(`${overlayId}@`)) {\n this.overlays.delete(key);\n }\n }\n }\n\n list(): SignedOverlaySpec[] {\n return Array.from(this.overlays.values()).map((entry) => entry.overlay);\n }\n\n get(overlayId: string, version: string): SignedOverlaySpec | undefined {\n return this.overlays.get(this.getKey(overlayId, version))?.overlay;\n }\n\n forContext(query: OverlayLookup): SignedOverlaySpec[] {\n return Array.from(this.overlays.values())\n .filter((entry) => matches(entry.overlay.appliesTo, query))\n .sort((a, b) => {\n if (a.specificity !== b.specificity) {\n return a.specificity - b.specificity;\n }\n return a.registeredAt - b.registeredAt;\n })\n .map((entry) => entry.overlay);\n }\n\n clear() {\n this.overlays.clear();\n }\n\n size(): number {\n return this.overlays.size;\n }\n\n private ensureSigned(input: OverlayInput): SignedOverlaySpec {\n if (isSignedOverlay(input)) {\n if (!input.signature?.signature && !this.options.allowUnsigned) {\n throw new Error(`Overlay \"${input.overlayId}\" is missing a signature.`);\n }\n return input;\n }\n\n if (!this.options.allowUnsigned) {\n throw new Error(\n `Overlay \"${input.overlayId}\" must be signed before registration.`\n );\n }\n\n return input as SignedOverlaySpec;\n }\n\n private getKey(overlayId: string, version: string) {\n return `${overlayId}@${version}`;\n }\n}\n\nfunction isSignedOverlay(spec: OverlayInput): spec is SignedOverlaySpec {\n return Boolean((spec as SignedOverlaySpec).signature);\n}\n\nfunction computeSpecificity(appliesTo: OverlayAppliesTo): number {\n let score = 0;\n (Object.keys(SCOPE_WEIGHTS) as (keyof OverlayScopeContext)[]).forEach(\n (key) => {\n const hasValue =\n key === 'tags'\n ? Array.isArray(appliesTo.tags) && appliesTo.tags.length > 0\n : Boolean(appliesTo[key]);\n if (hasValue) {\n score += SCOPE_WEIGHTS[key];\n }\n }\n );\n return score;\n}\n\nfunction matches(appliesTo: OverlayAppliesTo, ctx: OverlayLookup): boolean {\n for (const key of TARGET_KEYS) {\n const expected = appliesTo[key];\n if (expected && expected !== ctx[key]) {\n return false;\n }\n }\n\n if (appliesTo.tenantId && appliesTo.tenantId !== ctx.tenantId) {\n return false;\n }\n if (appliesTo.role && appliesTo.role !== ctx.role) {\n return false;\n }\n if (appliesTo.userId && appliesTo.userId !== ctx.userId) {\n return false;\n }\n if (appliesTo.device && appliesTo.device !== ctx.device) {\n return false;\n }\n if (appliesTo.tags?.length) {\n if (!ctx.tags?.length) {\n return false;\n }\n const ctxTags = new Set(ctx.tags);\n const satisfies = appliesTo.tags.every((tag) => ctxTags.has(tag));\n if (!satisfies) {\n return false;\n }\n }\n\n return true;\n}\n"],"mappings":";;;AAuBA,MAAM,cAA0C;CAC9C;CACA;CACA;CACA;CACA;CACD;AAED,MAAM,gBAA2D;CAC/D,UAAU;CACV,MAAM;CACN,QAAQ;CACR,QAAQ;CACR,MAAM;CACP;AAED,IAAa,kBAAb,MAA6B;CAC3B,AAAiB,2BAAW,IAAI,KAA4B;CAE5D,YAAY,AAAiB,UAAkC,EAAE,EAAE;EAAtC;;CAE7B,SACE,SACA,SACmB;AACnB,MAAI,CAAC,SAAS,gBAAgB;GAE5B,MAAM,UADY,KAAK,QAAQ,aAAa,yBACnB,QAA6B;AACtD,OAAI,CAAC,OAAO,OAAO;IACjB,MAAM,SAAS,OAAO,OACnB,KAAK,UAAU,GAAG,MAAM,KAAK,IAAI,MAAM,UAAU,CACjD,KAAK,KAAK;AACb,UAAM,IAAI,MACR,YAAY,QAAQ,UAAU,uBAAuB,SACtD;;;EAIL,MAAM,aAAa,KAAK,aAAa,QAAQ;EAC7C,MAAM,MAAM,KAAK,OAAO,WAAW,WAAW,WAAW,QAAQ;EACjE,MAAM,SAAwB;GAC5B,SAAS;GACT,aAAa,mBAAmB,WAAW,UAAU;GACrD,cAAc,KAAK,KAAK;GACzB;AACD,OAAK,SAAS,IAAI,KAAK,OAAO;AAC9B,SAAO;;CAGT,WAAW,WAAmB,SAAkB;AAC9C,MAAI,SAAS;AACX,QAAK,SAAS,OAAO,KAAK,OAAO,WAAW,QAAQ,CAAC;AACrD;;AAGF,OAAK,MAAM,OAAO,MAAM,KAAK,KAAK,SAAS,MAAM,CAAC,CAChD,KAAI,IAAI,WAAW,GAAG,UAAU,GAAG,CACjC,MAAK,SAAS,OAAO,IAAI;;CAK/B,OAA4B;AAC1B,SAAO,MAAM,KAAK,KAAK,SAAS,QAAQ,CAAC,CAAC,KAAK,UAAU,MAAM,QAAQ;;CAGzE,IAAI,WAAmB,SAAgD;AACrE,SAAO,KAAK,SAAS,IAAI,KAAK,OAAO,WAAW,QAAQ,CAAC,EAAE;;CAG7D,WAAW,OAA2C;AACpD,SAAO,MAAM,KAAK,KAAK,SAAS,QAAQ,CAAC,CACtC,QAAQ,UAAU,QAAQ,MAAM,QAAQ,WAAW,MAAM,CAAC,CAC1D,MAAM,GAAG,MAAM;AACd,OAAI,EAAE,gBAAgB,EAAE,YACtB,QAAO,EAAE,cAAc,EAAE;AAE3B,UAAO,EAAE,eAAe,EAAE;IAC1B,CACD,KAAK,UAAU,MAAM,QAAQ;;CAGlC,QAAQ;AACN,OAAK,SAAS,OAAO;;CAGvB,OAAe;AACb,SAAO,KAAK,SAAS;;CAGvB,AAAQ,aAAa,OAAwC;AAC3D,MAAI,gBAAgB,MAAM,EAAE;AAC1B,OAAI,CAAC,MAAM,WAAW,aAAa,CAAC,KAAK,QAAQ,cAC/C,OAAM,IAAI,MAAM,YAAY,MAAM,UAAU,2BAA2B;AAEzE,UAAO;;AAGT,MAAI,CAAC,KAAK,QAAQ,cAChB,OAAM,IAAI,MACR,YAAY,MAAM,UAAU,uCAC7B;AAGH,SAAO;;CAGT,AAAQ,OAAO,WAAmB,SAAiB;AACjD,SAAO,GAAG,UAAU,GAAG;;;AAI3B,SAAS,gBAAgB,MAA+C;AACtE,QAAO,QAAS,KAA2B,UAAU;;AAGvD,SAAS,mBAAmB,WAAqC;CAC/D,IAAI,QAAQ;AACZ,CAAC,OAAO,KAAK,cAAc,CAAmC,SAC3D,QAAQ;AAKP,MAHE,QAAQ,SACJ,MAAM,QAAQ,UAAU,KAAK,IAAI,UAAU,KAAK,SAAS,IACzD,QAAQ,UAAU,KAAK,CAE3B,UAAS,cAAc;GAG5B;AACD,QAAO;;AAGT,SAAS,QAAQ,WAA6B,KAA6B;AACzE,MAAK,MAAM,OAAO,aAAa;EAC7B,MAAM,WAAW,UAAU;AAC3B,MAAI,YAAY,aAAa,IAAI,KAC/B,QAAO;;AAIX,KAAI,UAAU,YAAY,UAAU,aAAa,IAAI,SACnD,QAAO;AAET,KAAI,UAAU,QAAQ,UAAU,SAAS,IAAI,KAC3C,QAAO;AAET,KAAI,UAAU,UAAU,UAAU,WAAW,IAAI,OAC/C,QAAO;AAET,KAAI,UAAU,UAAU,UAAU,WAAW,IAAI,OAC/C,QAAO;AAET,KAAI,UAAU,MAAM,QAAQ;AAC1B,MAAI,CAAC,IAAI,MAAM,OACb,QAAO;EAET,MAAM,UAAU,IAAI,IAAI,IAAI,KAAK;AAEjC,MAAI,CADc,UAAU,KAAK,OAAO,QAAQ,QAAQ,IAAI,IAAI,CAAC,CAE/D,QAAO;;AAIX,QAAO"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"runtime.js","names":[],"sources":["../src/runtime.ts"],"sourcesContent":["import { applyOverlayModifications, type ApplyOverlayOptions } from './merger';\nimport { OverlayRegistry, type OverlayLookup } from './registry';\nimport type { SignedOverlaySpec } from './spec';\nimport type { OverlayRenderable, OverlayAuditEvent } from './types';\n\nexport interface OverlayEngineOptions {\n registry: OverlayRegistry;\n audit?: (event: OverlayAuditEvent) => void;\n}\n\nexport interface OverlayApplyParams<\n T extends OverlayRenderable,\n> extends OverlayLookup {\n target: T;\n overlays?: SignedOverlaySpec[];\n strict?: ApplyOverlayOptions['strict'];\n}\n\nexport interface OverlayRuntimeResult<T extends OverlayRenderable> {\n target: T;\n overlaysApplied: SignedOverlaySpec[];\n}\n\nexport class OverlayEngine {\n private readonly registry: OverlayRegistry;\n private readonly audit?: (event: OverlayAuditEvent) => void;\n\n constructor(options: OverlayEngineOptions) {\n this.registry = options.registry;\n this.audit = options.audit;\n }\n\n apply<T extends OverlayRenderable>(\n params: OverlayApplyParams<T>\n ): OverlayRuntimeResult<T> {\n const overlays =\n params.overlays ??\n this.registry.forContext({\n capability: params.capability,\n workflow: params.workflow,\n dataView: params.dataView,\n presentation: params.presentation,\n operation: params.operation,\n tenantId: params.tenantId,\n role: params.role,\n userId: params.userId,\n device: params.device,\n tags: params.tags,\n });\n\n const merged = applyOverlayModifications(params.target, overlays, {\n strict: params.strict,\n });\n\n const context = extractContext(params);\n overlays.forEach((overlay) => {\n this.audit?.({\n overlay: {\n overlayId: overlay.overlayId,\n version: overlay.version,\n },\n context,\n timestamp: new Date().toISOString(),\n });\n });\n\n return {\n target: merged,\n overlaysApplied: overlays,\n };\n }\n}\n\nfunction extractContext(params: OverlayLookup): OverlayAuditEvent['context'] {\n return {\n tenantId: params.tenantId,\n role: params.role,\n userId: params.userId,\n device: params.device,\n tags: params.tags,\n };\n}\n"],"mappings":";;;AAuBA,IAAa,gBAAb,MAA2B;CACzB,AAAiB;CACjB,AAAiB;CAEjB,YAAY,SAA+B;AACzC,OAAK,WAAW,QAAQ;AACxB,OAAK,QAAQ,QAAQ;;CAGvB,MACE,QACyB;EACzB,MAAM,WACJ,OAAO,YACP,KAAK,SAAS,WAAW;GACvB,YAAY,OAAO;GACnB,UAAU,OAAO;GACjB,UAAU,OAAO;GACjB,cAAc,OAAO;GACrB,WAAW,OAAO;GAClB,UAAU,OAAO;GACjB,MAAM,OAAO;GACb,QAAQ,OAAO;GACf,QAAQ,OAAO;GACf,MAAM,OAAO;GACd,CAAC;EAEJ,MAAM,SAAS,0BAA0B,OAAO,QAAQ,UAAU,EAChE,QAAQ,OAAO,QAChB,CAAC;EAEF,MAAM,UAAU,eAAe,OAAO;AACtC,WAAS,SAAS,YAAY;AAC5B,QAAK,QAAQ;IACX,SAAS;KACP,WAAW,QAAQ;KACnB,SAAS,QAAQ;KAClB;IACD;IACA,4BAAW,IAAI,MAAM,EAAC,aAAa;IACpC,CAAC;IACF;AAEF,SAAO;GACL,QAAQ;GACR,iBAAiB;GAClB;;;AAIL,SAAS,eAAe,QAAqD;AAC3E,QAAO;EACL,UAAU,OAAO;EACjB,MAAM,OAAO;EACb,QAAQ,OAAO;EACf,QAAQ,OAAO;EACf,MAAM,OAAO;EACd"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"signer.js","names":[],"sources":["../src/signer.ts"],"sourcesContent":["import stringify from 'fast-json-stable-stringify';\nimport {\n constants,\n createPrivateKey,\n createPublicKey,\n type KeyLike,\n sign,\n verify,\n} from 'crypto';\nimport type {\n OverlaySignatureAlgorithm,\n OverlaySpec,\n SignedOverlaySpec,\n} from './spec';\n\nexport interface SignOverlayOptions {\n algorithm?: OverlaySignatureAlgorithm;\n keyId?: string;\n issuedAt?: Date | string;\n expiresAt?: Date | string;\n metadata?: Record<string, unknown>;\n publicKey?: string;\n}\n\nexport function signOverlay(\n spec: OverlaySpec,\n privateKey: KeyLike | string | Buffer,\n options: SignOverlayOptions = {}\n): SignedOverlaySpec {\n const algorithm = options.algorithm ?? 'ed25519';\n const keyObject =\n typeof privateKey === 'string' || Buffer.isBuffer(privateKey)\n ? createPrivateKey(privateKey)\n : privateKey;\n const payload = Buffer.from(canonicalizeOverlay(spec), 'utf8');\n\n let rawSignature: Buffer;\n if (algorithm === 'ed25519') {\n rawSignature = sign(null, payload, keyObject);\n } else if (algorithm === 'rsa-pss-sha256') {\n rawSignature = sign('sha256', payload, {\n key: keyObject,\n padding: constants.RSA_PKCS1_PSS_PADDING,\n saltLength: 32,\n });\n } else {\n throw new Error(`Unsupported overlay signature algorithm: ${algorithm}`);\n }\n\n const publicKey =\n options.publicKey ??\n createPublicKey(keyObject)\n .export({ format: 'pem', type: 'spki' })\n .toString();\n\n return {\n ...spec,\n signature: {\n algorithm,\n signature: rawSignature.toString('base64'),\n publicKey,\n keyId: options.keyId,\n issuedAt: toIso(options.issuedAt) ?? new Date().toISOString(),\n expiresAt: toIso(options.expiresAt),\n metadata: options.metadata,\n },\n };\n}\n\nexport function verifyOverlaySignature(overlay: SignedOverlaySpec): boolean {\n if (!overlay.signature?.signature) {\n throw new Error(\n `Overlay \"${overlay.overlayId}\" is missing signature metadata.`\n );\n }\n const payload = Buffer.from(canonicalizeOverlay(overlay), 'utf8');\n const signature = Buffer.from(overlay.signature.signature, 'base64');\n const publicKey = createPublicKey(overlay.signature.publicKey);\n\n if (overlay.signature.algorithm === 'ed25519') {\n return verify(null, payload, publicKey, signature);\n }\n\n if (overlay.signature.algorithm === 'rsa-pss-sha256') {\n return verify(\n 'sha256',\n payload,\n {\n key: publicKey,\n padding: constants.RSA_PKCS1_PSS_PADDING,\n saltLength: 32,\n },\n signature\n );\n }\n\n throw new Error(\n `Unsupported overlay signature algorithm: ${overlay.signature.algorithm}`\n );\n}\n\nexport function canonicalizeOverlay(\n spec: OverlaySpec | SignedOverlaySpec\n): string {\n const { signature, ...rest } = spec as SignedOverlaySpec;\n return stringify(rest);\n}\n\nexport function stripSignature<T extends OverlaySpec | SignedOverlaySpec>(\n spec: T\n): OverlaySpec {\n const { signature, ...rest } = spec as SignedOverlaySpec;\n return { ...rest };\n}\n\nfunction toIso(value?: Date | string): string | undefined {\n if (!value) {\n return undefined;\n }\n if (typeof value === 'string') {\n return new Date(value).toISOString();\n }\n return value.toISOString();\n}\n"],"mappings":";;;;AAwBA,SAAgB,YACd,MACA,YACA,UAA8B,EAAE,EACb;CACnB,MAAM,YAAY,QAAQ,aAAa;CACvC,MAAM,YACJ,OAAO,eAAe,YAAY,OAAO,SAAS,WAAW,GACzD,iBAAiB,WAAW,GAC5B;CACN,MAAM,UAAU,OAAO,KAAK,oBAAoB,KAAK,EAAE,OAAO;CAE9D,IAAI;AACJ,KAAI,cAAc,UAChB,gBAAe,KAAK,MAAM,SAAS,UAAU;UACpC,cAAc,iBACvB,gBAAe,KAAK,UAAU,SAAS;EACrC,KAAK;EACL,SAAS,UAAU;EACnB,YAAY;EACb,CAAC;KAEF,OAAM,IAAI,MAAM,4CAA4C,YAAY;CAG1E,MAAM,YACJ,QAAQ,aACR,gBAAgB,UAAU,CACvB,OAAO;EAAE,QAAQ;EAAO,MAAM;EAAQ,CAAC,CACvC,UAAU;AAEf,QAAO;EACL,GAAG;EACH,WAAW;GACT;GACA,WAAW,aAAa,SAAS,SAAS;GAC1C;GACA,OAAO,QAAQ;GACf,UAAU,MAAM,QAAQ,SAAS,qBAAI,IAAI,MAAM,EAAC,aAAa;GAC7D,WAAW,MAAM,QAAQ,UAAU;GACnC,UAAU,QAAQ;GACnB;EACF;;AAGH,SAAgB,uBAAuB,SAAqC;AAC1E,KAAI,CAAC,QAAQ,WAAW,UACtB,OAAM,IAAI,MACR,YAAY,QAAQ,UAAU,kCAC/B;CAEH,MAAM,UAAU,OAAO,KAAK,oBAAoB,QAAQ,EAAE,OAAO;CACjE,MAAM,YAAY,OAAO,KAAK,QAAQ,UAAU,WAAW,SAAS;CACpE,MAAM,YAAY,gBAAgB,QAAQ,UAAU,UAAU;AAE9D,KAAI,QAAQ,UAAU,cAAc,UAClC,QAAO,OAAO,MAAM,SAAS,WAAW,UAAU;AAGpD,KAAI,QAAQ,UAAU,cAAc,iBAClC,QAAO,OACL,UACA,SACA;EACE,KAAK;EACL,SAAS,UAAU;EACnB,YAAY;EACb,EACD,UACD;AAGH,OAAM,IAAI,MACR,4CAA4C,QAAQ,UAAU,YAC/D;;AAGH,SAAgB,oBACd,MACQ;CACR,MAAM,EAAE,WAAW,GAAG,SAAS;AAC/B,QAAO,UAAU,KAAK;;AAGxB,SAAgB,eACd,MACa;CACb,MAAM,EAAE,WAAW,GAAG,SAAS;AAC/B,QAAO,EAAE,GAAG,MAAM;;AAGpB,SAAS,MAAM,OAA2C;AACxD,KAAI,CAAC,MACH;AAEF,KAAI,OAAO,UAAU,SACnB,QAAO,IAAI,KAAK,MAAM,CAAC,aAAa;AAEtC,QAAO,MAAM,aAAa"}
package/dist/spec.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"spec.js","names":[],"sources":["../src/spec.ts"],"sourcesContent":["import type { AnyOperationSpec } from '@contractspec/lib.contracts';\n\nexport type OverlayScopeKey =\n | 'tenantId'\n | 'role'\n | 'userId'\n | 'device'\n | 'tags';\n\nexport interface OverlayScopeContext {\n tenantId?: string;\n role?: string;\n userId?: string;\n device?: string;\n tags?: string[];\n}\n\nexport interface OverlayTargetRef {\n capability?: string;\n workflow?: string;\n dataView?: string;\n presentation?: string;\n operation?: AnyOperationSpec['meta']['key'];\n}\n\nexport interface OverlayAppliesTo\n extends OverlayScopeContext, OverlayTargetRef {\n /**\n * Optional label to describe why this overlay exists (displayed in tooling).\n */\n label?: string;\n}\n\nexport type OverlayModification =\n | HideFieldModification\n | RenameLabelModification\n | ReorderFieldsModification\n | SetDefaultModification\n | AddHelpTextModification\n | MakeRequiredModification;\n\nexport interface OverlayFieldModificationBase {\n field: string;\n description?: string;\n}\n\nexport interface HideFieldModification extends OverlayFieldModificationBase {\n type: 'hideField';\n reason?: string;\n}\n\nexport interface RenameLabelModification extends OverlayFieldModificationBase {\n type: 'renameLabel';\n newLabel: string;\n}\n\nexport interface ReorderFieldsModification {\n type: 'reorderFields';\n fields: string[];\n description?: string;\n}\n\nexport interface SetDefaultModification extends OverlayFieldModificationBase {\n type: 'setDefault';\n value: unknown;\n}\n\nexport interface AddHelpTextModification extends OverlayFieldModificationBase {\n type: 'addHelpText';\n text: string;\n}\n\nexport interface MakeRequiredModification extends OverlayFieldModificationBase {\n type: 'makeRequired';\n required?: boolean;\n}\n\nexport interface OverlaySpec {\n overlayId: string;\n version: string;\n description?: string;\n appliesTo: OverlayAppliesTo;\n modifications: OverlayModification[];\n metadata?: Record<string, unknown>;\n createdBy?: string;\n createdAt?: string;\n}\n\nexport type OverlaySignatureAlgorithm = 'ed25519' | 'rsa-pss-sha256';\n\nexport interface OverlaySignatureBlock {\n algorithm: OverlaySignatureAlgorithm;\n signature: string;\n publicKey: string;\n keyId?: string;\n issuedAt?: string;\n expiresAt?: string;\n metadata?: Record<string, unknown>;\n}\n\nexport type SignedOverlaySpec = OverlaySpec & {\n signature: OverlaySignatureBlock;\n};\n\nexport type OverlayInput = OverlaySpec | SignedOverlaySpec;\n\nexport const OVERLAY_SCOPE_ORDER: OverlayScopeKey[] = [\n 'tenantId',\n 'role',\n 'userId',\n 'device',\n 'tags',\n];\n\nexport function defineOverlay<T extends OverlaySpec>(spec: T): T {\n return spec;\n}\n"],"mappings":";AA0GA,MAAa,sBAAyC;CACpD;CACA;CACA;CACA;CACA;CACD;AAED,SAAgB,cAAqC,MAAY;AAC/D,QAAO"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"validator.js","names":[],"sources":["../src/validator.ts"],"sourcesContent":["import type { OverlayModification, OverlaySpec } from './spec';\n\nexport interface OverlayValidationIssue {\n code: string;\n message: string;\n path?: string[];\n}\n\nexport interface OverlayValidationResult {\n valid: boolean;\n issues: OverlayValidationIssue[];\n}\n\nexport type OverlayValidator = (spec: OverlaySpec) => OverlayValidationResult;\n\nconst TARGET_KEYS = [\n 'capability',\n 'workflow',\n 'dataView',\n 'presentation',\n 'operation',\n] as const;\n\nexport const defaultOverlayValidator: OverlayValidator = (spec) =>\n validateOverlaySpec(spec);\n\nexport function validateOverlaySpec(\n spec: OverlaySpec\n): OverlayValidationResult {\n const issues: OverlayValidationIssue[] = [];\n\n if (!spec.overlayId?.trim()) {\n issues.push({\n code: 'overlay.id',\n message: 'overlayId is required',\n path: ['overlayId'],\n });\n }\n\n if (!spec.version?.trim()) {\n issues.push({\n code: 'overlay.version',\n message: 'version is required',\n path: ['version'],\n });\n }\n\n const hasTarget = TARGET_KEYS.some((key) => {\n const value = spec.appliesTo?.[key as keyof typeof spec.appliesTo];\n return typeof value === 'string' && value.trim().length > 0;\n });\n\n if (!hasTarget) {\n issues.push({\n code: 'overlay.target',\n message:\n 'Overlay must specify at least one target (capability, workflow, dataView, presentation, or operation).',\n path: ['appliesTo'],\n });\n }\n\n if (!spec.modifications?.length) {\n issues.push({\n code: 'overlay.modifications.empty',\n message: 'Overlay must include at least one modification.',\n path: ['modifications'],\n });\n } else {\n spec.modifications.forEach((mod, idx) => {\n const path = ['modifications', String(idx)];\n validateModification(mod, path, issues);\n });\n }\n\n return {\n valid: issues.length === 0,\n issues,\n };\n}\n\nfunction validateModification(\n modification: OverlayModification,\n path: string[],\n issues: OverlayValidationIssue[]\n) {\n const push = (code: string, message: string, extraPath?: string[]) => {\n issues.push({\n code,\n message,\n path: extraPath ? [...path, ...extraPath] : path,\n });\n };\n\n if (isFieldModification(modification)) {\n if (!modification.field?.trim()) {\n push('overlay.mod.field', 'field is required for this modification', [\n 'field',\n ]);\n }\n }\n\n switch (modification.type) {\n case 'renameLabel': {\n if (!modification.newLabel?.trim()) {\n push('overlay.mod.renameLabel.newLabel', 'newLabel is required', [\n 'newLabel',\n ]);\n }\n break;\n }\n case 'reorderFields': {\n if (!modification.fields?.length) {\n push(\n 'overlay.mod.reorderFields.fields',\n 'fields list cannot be empty',\n ['fields']\n );\n }\n const seen = new Set<string>();\n for (const field of modification.fields ?? []) {\n if (!field?.trim()) {\n push(\n 'overlay.mod.reorderFields.fields.blank',\n 'fields entries must be non-empty'\n );\n break;\n }\n if (seen.has(field)) {\n push(\n 'overlay.mod.reorderFields.fields.duplicate',\n `field \"${field}\" was listed multiple times`\n );\n break;\n }\n seen.add(field);\n }\n break;\n }\n case 'setDefault': {\n if (modification.value === undefined) {\n push('overlay.mod.setDefault.value', 'value is required', ['value']);\n }\n break;\n }\n case 'addHelpText': {\n if (!modification.text?.trim()) {\n push('overlay.mod.addHelpText.text', 'text is required', ['text']);\n }\n break;\n }\n case 'makeRequired':\n case 'hideField':\n // no extra validation\n break;\n default: {\n const exhaustive: never = modification;\n throw new Error(\n `Unsupported overlay modification ${(exhaustive as { type: string })?.type ?? 'unknown'}`\n );\n }\n }\n}\n\nfunction isFieldModification(\n mod: OverlayModification\n): mod is Extract<OverlayModification, { field: string }> {\n return 'field' in mod;\n}\n\nexport function assertOverlayValid(\n spec: OverlaySpec,\n validator: OverlayValidator = defaultOverlayValidator\n) {\n const result = validator(spec);\n if (!result.valid) {\n const message = result.issues\n .map((issue) => `${issue.code}: ${issue.message}`)\n .join('; ');\n throw new Error(`Invalid OverlaySpec \"${spec.overlayId}\": ${message}`);\n }\n}\n"],"mappings":";AAeA,MAAM,cAAc;CAClB;CACA;CACA;CACA;CACA;CACD;AAED,MAAa,2BAA6C,SACxD,oBAAoB,KAAK;AAE3B,SAAgB,oBACd,MACyB;CACzB,MAAM,SAAmC,EAAE;AAE3C,KAAI,CAAC,KAAK,WAAW,MAAM,CACzB,QAAO,KAAK;EACV,MAAM;EACN,SAAS;EACT,MAAM,CAAC,YAAY;EACpB,CAAC;AAGJ,KAAI,CAAC,KAAK,SAAS,MAAM,CACvB,QAAO,KAAK;EACV,MAAM;EACN,SAAS;EACT,MAAM,CAAC,UAAU;EAClB,CAAC;AAQJ,KAAI,CALc,YAAY,MAAM,QAAQ;EAC1C,MAAM,QAAQ,KAAK,YAAY;AAC/B,SAAO,OAAO,UAAU,YAAY,MAAM,MAAM,CAAC,SAAS;GAC1D,CAGA,QAAO,KAAK;EACV,MAAM;EACN,SACE;EACF,MAAM,CAAC,YAAY;EACpB,CAAC;AAGJ,KAAI,CAAC,KAAK,eAAe,OACvB,QAAO,KAAK;EACV,MAAM;EACN,SAAS;EACT,MAAM,CAAC,gBAAgB;EACxB,CAAC;KAEF,MAAK,cAAc,SAAS,KAAK,QAAQ;AAEvC,uBAAqB,KADR,CAAC,iBAAiB,OAAO,IAAI,CAAC,EACX,OAAO;GACvC;AAGJ,QAAO;EACL,OAAO,OAAO,WAAW;EACzB;EACD;;AAGH,SAAS,qBACP,cACA,MACA,QACA;CACA,MAAM,QAAQ,MAAc,SAAiB,cAAyB;AACpE,SAAO,KAAK;GACV;GACA;GACA,MAAM,YAAY,CAAC,GAAG,MAAM,GAAG,UAAU,GAAG;GAC7C,CAAC;;AAGJ,KAAI,oBAAoB,aAAa,EACnC;MAAI,CAAC,aAAa,OAAO,MAAM,CAC7B,MAAK,qBAAqB,2CAA2C,CACnE,QACD,CAAC;;AAIN,SAAQ,aAAa,MAArB;EACE,KAAK;AACH,OAAI,CAAC,aAAa,UAAU,MAAM,CAChC,MAAK,oCAAoC,wBAAwB,CAC/D,WACD,CAAC;AAEJ;EAEF,KAAK,iBAAiB;AACpB,OAAI,CAAC,aAAa,QAAQ,OACxB,MACE,oCACA,+BACA,CAAC,SAAS,CACX;GAEH,MAAM,uBAAO,IAAI,KAAa;AAC9B,QAAK,MAAM,SAAS,aAAa,UAAU,EAAE,EAAE;AAC7C,QAAI,CAAC,OAAO,MAAM,EAAE;AAClB,UACE,0CACA,mCACD;AACD;;AAEF,QAAI,KAAK,IAAI,MAAM,EAAE;AACnB,UACE,8CACA,UAAU,MAAM,6BACjB;AACD;;AAEF,SAAK,IAAI,MAAM;;AAEjB;;EAEF,KAAK;AACH,OAAI,aAAa,UAAU,OACzB,MAAK,gCAAgC,qBAAqB,CAAC,QAAQ,CAAC;AAEtE;EAEF,KAAK;AACH,OAAI,CAAC,aAAa,MAAM,MAAM,CAC5B,MAAK,gCAAgC,oBAAoB,CAAC,OAAO,CAAC;AAEpE;EAEF,KAAK;EACL,KAAK,YAEH;EACF,SAAS;GACP,MAAM,aAAoB;AAC1B,SAAM,IAAI,MACR,oCAAqC,YAAiC,QAAQ,YAC/E;;;;AAKP,SAAS,oBACP,KACwD;AACxD,QAAO,WAAW;;AAGpB,SAAgB,mBACd,MACA,YAA8B,yBAC9B;CACA,MAAM,SAAS,UAAU,KAAK;AAC9B,KAAI,CAAC,OAAO,OAAO;EACjB,MAAM,UAAU,OAAO,OACpB,KAAK,UAAU,GAAG,MAAM,KAAK,IAAI,MAAM,UAAU,CACjD,KAAK,KAAK;AACb,QAAM,IAAI,MAAM,wBAAwB,KAAK,UAAU,KAAK,UAAU"}