@contractspec/example.personalization 1.44.0

package/src/overlay-customization.ts

@@ -0,0 +1,57 @@
+import { defineOverlay } from '@contractspec/lib.overlay-engine/spec';
+import { signOverlay } from '@contractspec/lib.overlay-engine/signer';
+import {
+  OverlayEngine,
+  OverlayRegistry,
+} from '@contractspec/lib.overlay-engine';
+import { Logger, LogLevel } from '@contractspec/lib.logger';
+
+const logger = new Logger({
+  level: process.env.NODE_ENV === 'production' ? LogLevel.INFO : LogLevel.DEBUG,
+  environment:
+    (process.env.NODE_ENV as 'production' | 'development' | 'test') ||
+    'development',
+  enableColors: process.env.NODE_ENV !== 'production',
+});
+
+export async function runOverlayCustomizationExample(): Promise<void> {
+  const registry = new OverlayRegistry({ allowUnsigned: true });
+  const engine = new OverlayEngine({ registry });
+
+  const overlay = defineOverlay({
+    overlayId: 'demo-overlay',
+    version: '1.0.0',
+    appliesTo: {
+      capability: 'billing.createOrder',
+      tenantId: 'demo',
+    },
+    modifications: [
+      { type: 'hideField', field: 'internalNotes' },
+      {
+        type: 'renameLabel',
+        field: 'customerReference',
+        newLabel: 'PO Number',
+      },
+    ],
+  });
+
+  const signed = await signOverlay(overlay, process.env.PRIVATE_KEY_PEM ?? '');
+  registry.register(signed);
+
+  const result = engine.apply({
+    target: {
+      fields: [
+        {
+          key: 'customerReference',
+          label: 'Customer Reference',
+          visible: true,
+        },
+        { key: 'internalNotes', label: 'Internal Notes', visible: true },
+      ],
+    },
+    capability: 'billing.createOrder',
+    tenantId: 'demo',
+  });
+
+  logger.info('Overlay applied', { fields: result.target.fields });
+}

package/src/workflow-extension.ts

@@ -0,0 +1,63 @@
+import { StabilityEnum } from '@contractspec/lib.contracts';
+import type { WorkflowSpec } from '@contractspec/lib.contracts/workflow/spec';
+import { WorkflowComposer } from '@contractspec/lib.workflow-composer';
+import { Logger, LogLevel } from '@contractspec/lib.logger';
+
+const logger = new Logger({
+  level: process.env.NODE_ENV === 'production' ? LogLevel.INFO : LogLevel.DEBUG,
+  environment:
+    (process.env.NODE_ENV as 'production' | 'development' | 'test') ||
+    'development',
+  enableColors: process.env.NODE_ENV !== 'production',
+});
+
+const BaseWorkflow: WorkflowSpec = {
+  meta: {
+    key: 'billing.invoiceApproval',
+    version: 1,
+    title: 'Invoice Approval',
+    owners: [],
+    tags: [],
+    description: '',
+    domain: 'billing',
+    stability: StabilityEnum.Stable,
+  },
+  definition: {
+    steps: [
+      { id: 'validate-invoice', type: 'automation', label: 'Validate Invoice' },
+      { id: 'final-approval', type: 'human', label: 'Final Approval' },
+    ],
+    transitions: [{ from: 'validate-invoice', to: 'final-approval' }],
+  },
+};
+
+export function composeTenantWorkflowExample(): WorkflowSpec {
+  const composer = new WorkflowComposer();
+  composer.register({
+    workflow: 'billing.invoiceApproval',
+    tenantId: 'acme',
+    customSteps: [
+      {
+        after: 'validate-invoice',
+        inject: {
+          id: 'acme-legal',
+          type: 'human',
+          label: 'ACME Legal Review',
+        },
+        transitionTo: 'final-approval',
+      },
+    ],
+  });
+
+  return composer.compose({
+    base: BaseWorkflow,
+    tenantId: 'acme',
+  });
+}
+
+export function logTenantWorkflowSteps(workflow: WorkflowSpec): void {
+  logger.info('Tenant workflow composed', {
+    workflow: workflow.meta.key,
+    steps: workflow.definition.steps.map((step) => step.id),
+  });
+}

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "extends": "@contractspec/tool.typescript/react-library.json",
+  "include": ["src"],
+  "exclude": ["node_modules", "dist"],
+  "compilerOptions": {
+    "outDir": "dist",
+    "paths": {
+      "@contractspec/lib.personalization/*": ["../../libs/personalization/src/*"],
+      "@contractspec/lib.contracts/*": ["../../libs/contracts/src/*"],
+      "@contractspec/lib.contracts": ["../../libs/contracts/src/index.ts"],
+      "@contractspec/lib.overlay-engine/*": ["../../libs/overlay-engine/src/*"],
+      "@contractspec/lib.overlay-engine": ["../../libs/overlay-engine/src/index.ts"]
+    }
+  }
+}
+
+

package/tsdown.config.js

@@ -0,0 +1,6 @@
+import { defineConfig } from 'tsdown';
+import { moduleLibrary } from '@contractspec/tool.tsdown';
+
+export default defineConfig(() => ({
+  ...moduleLibrary,
+}));