@contractspec/example.personalization 3.7.6 → 3.7.10

package/src/personalization.experiment.ts

@@ -0,0 +1,61 @@
+import type { ExperimentSpec } from '@contractspec/lib.contracts-spec/experiments/spec';
+import {
+	OwnersEnum,
+	StabilityEnum,
+} from '@contractspec/lib.contracts-spec/ownership';
+
+export const PersonalizationExperiment: ExperimentSpec = {
+	meta: {
+		key: 'personalization.experiment.overlay-copy',
+		version: '1.0.0',
+		title: 'Personalization Overlay Copy Experiment',
+		description:
+			'Tests a control onboarding copy against a personalized overlay variant.',
+		domain: 'personalization',
+		owners: [OwnersEnum.PlatformCore],
+		tags: ['personalization', 'experiment', 'overlay'],
+		stability: StabilityEnum.Experimental,
+	},
+	controlVariant: 'control',
+	variants: [
+		{
+			id: 'control',
+			key: 'control',
+			description: 'Default onboarding copy and standard workflow.',
+		},
+		{
+			id: 'personalized-overlay',
+			key: 'personalized-overlay',
+			description: 'Personalized copy with a branded theme override.',
+			overrides: [
+				{
+					type: 'theme',
+					target: 'personalization.theme.guided-onboarding',
+					version: '1.0.0',
+				},
+				{
+					type: 'workflow',
+					target: 'billing.invoiceApproval',
+					version: '1.0.0',
+				},
+			],
+		},
+	],
+	allocation: {
+		type: 'sticky',
+		attribute: 'userId',
+		salt: 'personalization-overlay-copy',
+	},
+	successMetrics: [
+		{
+			key: 'checklist-completion-rate',
+			telemetryEvent: {
+				key: 'personalization.assignment.completed',
+				version: '1.0.0',
+			},
+			aggregation: 'count',
+			target: 1,
+		},
+	],
+	tags: ['personalization', 'experiment'],
+};

package/src/personalization.feature.ts

@@ -1,22 +1,22 @@
 import { defineFeature } from '@contractspec/lib.contracts-spec';
 
 export const PersonalizationFeature = defineFeature({
-  meta: {
-    key: 'personalization',
-    version: '1.0.0',
-    title: 'Personalization Patterns',
-    description:
-      'Behavior tracking, overlay customization, and workflow extension patterns',
-    domain: 'personalization',
-    owners: ['@examples'],
-    tags: ['personalization', 'behavior', 'overlay', 'workflow'],
-    stability: 'experimental',
-  },
+	meta: {
+		key: 'personalization',
+		version: '1.0.0',
+		title: 'Personalization Patterns',
+		description:
+			'Behavior tracking, overlay customization, and workflow extension patterns',
+		domain: 'personalization',
+		owners: ['@examples'],
+		tags: ['personalization', 'behavior', 'overlay', 'workflow'],
+		stability: 'experimental',
+	},
 
-  telemetry: [{ key: 'personalization.telemetry', version: '1.0.0' }],
+	telemetry: [{ key: 'personalization.telemetry', version: '1.0.0' }],
 
-  docs: [
-    'docs.examples.personalization',
-    'docs.examples.personalization.usage',
-  ],
+	docs: [
+		'docs.examples.personalization',
+		'docs.examples.personalization.usage',
+	],
 });

package/src/personalization.theme.ts

@@ -0,0 +1,63 @@
+import {
+	OwnersEnum,
+	StabilityEnum,
+} from '@contractspec/lib.contracts-spec/ownership';
+import type { ThemeSpec } from '@contractspec/lib.contracts-spec/themes';
+
+export const PersonalizationTheme: ThemeSpec = {
+	meta: {
+		key: 'personalization.theme.guided-onboarding',
+		version: '1.0.0',
+		title: 'Guided Onboarding Theme',
+		description:
+			'Theme tokens used when the personalized onboarding experience is active.',
+		domain: 'personalization',
+		owners: [OwnersEnum.PlatformCore],
+		tags: ['personalization', 'theme', 'onboarding'],
+		stability: StabilityEnum.Experimental,
+		scopes: ['tenant', 'user'],
+	},
+	tokens: {
+		colors: {
+			surface: { value: '#FCF6E8' },
+			accent: { value: '#C8742A' },
+			text: { value: '#2F2419' },
+		},
+		radii: {
+			card: { value: 18 },
+		},
+		space: {
+			panel: { value: 24 },
+		},
+		typography: {
+			body: { value: 16 },
+			title: { value: 28 },
+		},
+		motion: {
+			stagger: { value: '180ms' },
+		},
+	},
+	components: [
+		{
+			component: 'OnboardingChecklist',
+			variants: {
+				guided: {
+					props: {
+						emphasis: 'warm',
+					},
+				},
+			},
+		},
+	],
+	overrides: [
+		{
+			scope: 'tenant',
+			target: 'tenant:acme',
+			tokens: {
+				colors: {
+					accent: { value: '#8A4B12' },
+				},
+			},
+		},
+	],
+};

package/src/workflow-extension.ts

@@ -1,63 +1,63 @@
 import { StabilityEnum } from '@contractspec/lib.contracts-spec';
 import type { WorkflowSpec } from '@contractspec/lib.contracts-spec/workflow/spec';
-import { WorkflowComposer } from '@contractspec/lib.workflow-composer';
 import { Logger, LogLevel } from '@contractspec/lib.logger';
+import { WorkflowComposer } from '@contractspec/lib.workflow-composer';
 
 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',
+	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.0.0',
-    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' }],
-  },
+	meta: {
+		key: 'billing.invoiceApproval',
+		version: '1.0.0',
+		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',
-      },
-    ],
-  });
+	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',
-  });
+	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),
-  });
+	logger.info('Tenant workflow composed', {
+		workflow: workflow.meta.key,
+		steps: workflow.definition.steps.map((step) => step.id),
+	});
 }

package/tsconfig.json

@@ -1,17 +1,19 @@
 {
-  "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-spec/*": ["../../libs/contracts/src/*"],
-      "@contractspec/lib.contracts-spec": ["../../libs/contracts/src/index.ts"],
-      "@contractspec/lib.overlay-engine/*": ["../../libs/overlay-engine/src/*"],
-      "@contractspec/lib.overlay-engine": ["../../libs/overlay-engine/src/index.ts"]
-    }
-  }
+	"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-spec/*": ["../../libs/contracts/src/*"],
+			"@contractspec/lib.contracts-spec": ["../../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

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