@contractspec/lib.overlay-engine 3.7.10 → 3.7.12

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import type { DocBlock } from '@contractspec/lib.contracts-spec/docs';
 export * from './merger';
 export * from './registry';
 export * from './runtime';
@@ -5,3 +6,4 @@ export * from './signer';
 export * from './spec';
 export * from './types';
 export * from './validator';
+export declare const tech_contracts_overlays_DocBlocks: DocBlock[];

package/dist/index.js

@@ -520,9 +520,90 @@ var OVERLAY_SCOPE_ORDER = [
 function defineOverlay(spec) {
   return spec;
 }
+// src/index.ts
+var tech_contracts_overlays_DocBlocks = [
+  {
+    id: "docs.tech.contracts.overlays",
+    title: "OverlaySpec Implementation",
+    summary: "OverlaySpecs allow tenants/users to adapt presentation without duplicating code. Implementation lives in `@contractspec/lib.overlay-engine`.",
+    kind: "reference",
+    visibility: "public",
+    route: "/docs/tech/contracts/overlays",
+    tags: ["tech", "contracts", "overlays"],
+    body: `# OverlaySpec Implementation
+
+OverlaySpecs allow tenants/users to adapt presentation without duplicating code. Implementation lives in \`@contractspec/lib.overlay-engine\`.
+
+## Structure
+
+\`\`\`ts
+interface OverlaySpec {
+  overlayId: string;
+  version: string;
+  appliesTo: {
+    capability?: string;
+    workflow?: string;
+    dataView?: string;
+    presentation?: string;
+    tenantId?: string;
+    userId?: string;
+    role?: string;
+    device?: string;
+  };
+  modifications: OverlayModification[];
+}
+\`\`\`
+
+Supported modifications:
+
+- \`hideField\`
+- \`renameLabel\`
+- \`reorderFields\`
+- \`setDefault\`
+- \`addHelpText\`
+- \`makeRequired\`
+
+## Signing
+
+Overlays must be signed. Use the signer helper:
+
+\`\`\`ts
+import { signOverlay } from '@contractspec/lib.overlay-engine/signer';
+
+const signed = await signOverlay(overlay, privateKeyPem);
+registry.register(signed);
+\`\`\`
+
+Keys are stored in \`OverlaySigningKey\` (Prisma) and referenced by the \`Overlay\` model for auditing.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+`
+  }
+];
 export {
   verifyOverlaySignature,
   validateOverlaySpec,
+  tech_contracts_overlays_DocBlocks,
   stripSignature,
   signOverlay,
   defineOverlay,

package/dist/node/index.js

@@ -519,9 +519,90 @@ var OVERLAY_SCOPE_ORDER = [
 function defineOverlay(spec) {
   return spec;
 }
+// src/index.ts
+var tech_contracts_overlays_DocBlocks = [
+  {
+    id: "docs.tech.contracts.overlays",
+    title: "OverlaySpec Implementation",
+    summary: "OverlaySpecs allow tenants/users to adapt presentation without duplicating code. Implementation lives in `@contractspec/lib.overlay-engine`.",
+    kind: "reference",
+    visibility: "public",
+    route: "/docs/tech/contracts/overlays",
+    tags: ["tech", "contracts", "overlays"],
+    body: `# OverlaySpec Implementation
+
+OverlaySpecs allow tenants/users to adapt presentation without duplicating code. Implementation lives in \`@contractspec/lib.overlay-engine\`.
+
+## Structure
+
+\`\`\`ts
+interface OverlaySpec {
+  overlayId: string;
+  version: string;
+  appliesTo: {
+    capability?: string;
+    workflow?: string;
+    dataView?: string;
+    presentation?: string;
+    tenantId?: string;
+    userId?: string;
+    role?: string;
+    device?: string;
+  };
+  modifications: OverlayModification[];
+}
+\`\`\`
+
+Supported modifications:
+
+- \`hideField\`
+- \`renameLabel\`
+- \`reorderFields\`
+- \`setDefault\`
+- \`addHelpText\`
+- \`makeRequired\`
+
+## Signing
+
+Overlays must be signed. Use the signer helper:
+
+\`\`\`ts
+import { signOverlay } from '@contractspec/lib.overlay-engine/signer';
+
+const signed = await signOverlay(overlay, privateKeyPem);
+registry.register(signed);
+\`\`\`
+
+Keys are stored in \`OverlaySigningKey\` (Prisma) and referenced by the \`Overlay\` model for auditing.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+`
+  }
+];
 export {
   verifyOverlaySignature,
   validateOverlaySpec,
+  tech_contracts_overlays_DocBlocks,
   stripSignature,
   signOverlay,
   defineOverlay,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contractspec/lib.overlay-engine",
-  "version": "3.7.10",
+  "version": "3.7.12",
   "description": "Runtime overlay engine for ContractSpec personalization and adaptive UI rendering.",
   "keywords": [
     "contractspec",
@@ -32,7 +32,7 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@contractspec/lib.contracts-spec": "4.1.2",
+    "@contractspec/lib.contracts-spec": "5.0.0",
     "fast-json-stable-stringify": "^2.1.0"
   },
   "peerDependencies": {
@@ -44,9 +44,9 @@
     }
   },
   "devDependencies": {
-    "@contractspec/tool.typescript": "3.7.8",
+    "@contractspec/tool.typescript": "3.7.9",
     "typescript": "^5.9.3",
-    "@contractspec/tool.bun": "3.7.8"
+    "@contractspec/tool.bun": "3.7.9"
   },
   "exports": {
     ".": {