@contractspec/lib.contracts 1.48.0 → 1.49.0

package/dist/serialization/serializers.js

@@ -0,0 +1,148 @@
+//#region src/serialization/serializers.ts
+/**
+* Type guard to check if a value is a ResourceRefDescriptor.
+*/
+function isResourceRefDescriptor(value) {
+	return typeof value === "object" && value !== null && "kind" in value && value.kind === "resource_ref";
+}
+function getTypeName(type) {
+	if (!type) return "unknown";
+	if (typeof type === "string") return type;
+	if (typeof type === "object") {
+		if ("config" in type && type.config?.name) return type.config.name;
+		if ("name" in type && typeof type.name === "string") return type.name;
+	}
+	return "unknown";
+}
+/**
+* Serialize a SchemaModel to a plain JSON object.
+*/
+function serializeSchemaModel(model) {
+	if (!model) return null;
+	if (isResourceRefDescriptor(model)) return {
+		name: `ResourceRef<${model.graphQLType}>`,
+		description: `Reference to ${model.graphQLType} resource (${model.uriTemplate})`,
+		fields: {}
+	};
+	if ("config" in model && model.config) {
+		const config = model.config;
+		return {
+			name: config.name,
+			description: config.description,
+			fields: Object.fromEntries(Object.entries(config.fields).map(([key, field]) => [key, {
+				typeName: getTypeName(field.type),
+				isOptional: field.isOptional,
+				isArray: field.isArray
+			}]))
+		};
+	}
+	return {
+		name: "unknown",
+		fields: {}
+	};
+}
+/**
+* Serialize an OperationSpec to a plain JSON object.
+*/
+function serializeOperationSpec(spec) {
+	if (!spec) return null;
+	return {
+		meta: {
+			key: spec.meta.key,
+			version: spec.meta.version,
+			stability: spec.meta.stability,
+			owners: spec.meta.owners,
+			tags: spec.meta.tags,
+			description: spec.meta.description,
+			goal: spec.meta.goal,
+			context: spec.meta.context
+		},
+		io: {
+			input: serializeSchemaModel(spec.io.input),
+			output: serializeSchemaModel(spec.io.output)
+		},
+		policy: spec.policy ? { auth: spec.policy.auth } : void 0
+	};
+}
+/**
+* Serialize an EventSpec to a plain JSON object.
+*/
+function serializeEventSpec(spec) {
+	if (!spec) return null;
+	return {
+		meta: {
+			key: spec.meta.key,
+			version: spec.meta.version,
+			stability: spec.meta.stability,
+			owners: spec.meta.owners,
+			tags: spec.meta.tags,
+			description: spec.meta.description
+		},
+		payload: serializeSchemaModel(spec.payload)
+	};
+}
+/**
+* Serialize a PresentationSpec to a plain JSON object.
+*/
+function serializePresentationSpec(spec) {
+	if (!spec) return null;
+	return {
+		meta: {
+			key: spec.meta.key,
+			version: spec.meta.version,
+			stability: spec.meta.stability,
+			owners: spec.meta.owners,
+			tags: spec.meta.tags,
+			description: spec.meta.description,
+			goal: spec.meta.goal,
+			context: spec.meta.context
+		},
+		source: {
+			type: spec.source.type,
+			framework: spec.source.type === "component" ? spec.source.framework : void 0,
+			componentKey: spec.source.type === "component" ? spec.source.componentKey : void 0
+		},
+		targets: spec.targets
+	};
+}
+/**
+* Serialize a DataViewSpec to a plain JSON object.
+*/
+function serializeDataViewSpec(spec) {
+	if (!spec) return null;
+	return {
+		meta: {
+			key: spec.meta.key,
+			version: spec.meta.version,
+			stability: spec.meta.stability,
+			owners: spec.meta.owners,
+			tags: spec.meta.tags,
+			description: spec.meta.description,
+			title: spec.meta.title
+		},
+		source: spec.source,
+		view: spec.view
+	};
+}
+/**
+* Serialize a FormSpec to a plain JSON object.
+*/
+function serializeFormSpec(spec) {
+	if (!spec) return null;
+	return {
+		meta: {
+			key: spec.meta.key,
+			version: spec.meta.version,
+			stability: spec.meta.stability,
+			owners: spec.meta.owners,
+			tags: spec.meta.tags,
+			description: spec.meta.description,
+			title: spec.meta.title
+		},
+		fields: spec.fields,
+		actions: spec.actions
+	};
+}
+
+//#endregion
+export { serializeDataViewSpec, serializeEventSpec, serializeFormSpec, serializeOperationSpec, serializePresentationSpec, serializeSchemaModel };

package/dist/serialization/types.d.ts

@@ -0,0 +1,103 @@
+//#region src/serialization/types.d.ts
+/**
+ * Serialized types for Server -> Client Component transfer.
+ *
+ * These are plain JSON-serializable versions of spec types that can be
+ * safely passed from Server Components to Client Components in Next.js.
+ */
+/** Serialized schema model that can be passed to client components */
+interface SerializedSchemaModel {
+  name: string;
+  description?: string | null;
+  fields: Record<string, SerializedFieldConfig>;
+}
+interface SerializedFieldConfig {
+  typeName: string;
+  isOptional: boolean;
+  isArray?: boolean;
+}
+/** Serialized operation spec for client components */
+interface SerializedOperationSpec {
+  meta: {
+    key: string;
+    version: string;
+    stability?: string;
+    owners?: string[];
+    tags?: string[];
+    description?: string;
+    goal?: string;
+    context?: string;
+  };
+  io: {
+    input: SerializedSchemaModel | null;
+    output: SerializedSchemaModel | null;
+  };
+  policy?: {
+    auth?: string;
+  };
+}
+/** Serialized event spec for client components */
+interface SerializedEventSpec {
+  meta: {
+    key: string;
+    version: string;
+    stability?: string;
+    owners?: string[];
+    tags?: string[];
+    description?: string;
+  };
+  payload: SerializedSchemaModel | null;
+}
+/** Serialized presentation spec for client components */
+interface SerializedPresentationSpec {
+  meta: {
+    key: string;
+    version: string;
+    stability?: string;
+    owners?: string[];
+    tags?: string[];
+    description?: string;
+    goal?: string;
+    context?: string;
+  };
+  source: {
+    type: string;
+    framework?: string;
+    componentKey?: string;
+  };
+  targets?: string[];
+}
+/** Serialized data view spec for client components */
+interface SerializedDataViewSpec {
+  meta: {
+    key: string;
+    version: string;
+    stability?: string;
+    owners?: string[];
+    tags?: string[];
+    description?: string;
+    title?: string;
+  };
+  /** Serialized source configuration */
+  source?: unknown;
+  /** Serialized view configuration */
+  view?: unknown;
+}
+/** Serialized form spec for client components */
+interface SerializedFormSpec {
+  meta: {
+    key: string;
+    version?: string;
+    stability?: string;
+    owners?: string[];
+    tags?: string[];
+    description?: string;
+    title?: string;
+  };
+  /** Serialized form fields (passed through for display) */
+  fields?: unknown;
+  /** Serialized form actions (passed through for display) */
+  actions?: unknown;
+}
+//#endregion
+export { SerializedDataViewSpec, SerializedEventSpec, SerializedFieldConfig, SerializedFormSpec, SerializedOperationSpec, SerializedPresentationSpec, SerializedSchemaModel };

package/dist/workflow/index.d.ts

@@ -1,4 +1,5 @@
-import { CompensationStep, CompensationStrategy, FormRef, GuardCondition, GuardConditionKind, RetryPolicy, SLA, Step, StepAction, StepType, Transition, WorkflowDefinition, WorkflowMeta, WorkflowRegistry, WorkflowSpec, WorkflowStatus } from "./spec.js";
+import { FormRef } from "../features/types.js";
+import { CompensationStep, CompensationStrategy, GuardCondition, GuardConditionKind, RetryPolicy, SLA, Step, StepAction, StepType, Transition, WorkflowDefinition, WorkflowMeta, WorkflowRegistry, WorkflowSpec, WorkflowStatus } from "./spec.js";
 import { ValidateWorkflowSpecOptions, WorkflowValidationError, WorkflowValidationIssue, WorkflowValidationLevel, assertWorkflowSpecValid, validateWorkflowSpec } from "./validation.js";
 import { StateStore, StepExecution, WorkflowState, WorkflowStateFilters } from "./state.js";
 import { GuardContext, GuardEvaluator, OperationExecutor, OperationExecutorContext, WorkflowPreFlightError, WorkflowPreFlightIssue, WorkflowPreFlightIssueSeverity, WorkflowPreFlightIssueType, WorkflowPreFlightResult, WorkflowRunner, WorkflowRunnerConfig } from "./runner.js";

package/dist/workflow/spec.d.ts

@@ -2,18 +2,11 @@ import { OwnerShipMeta } from "../ownership.js";
 import { CapabilityRef } from "../capabilities/capabilities.js";
 import "../capabilities/index.js";
 import { ExperimentRef } from "../experiments/spec.js";
-import { OpRef } from "../features/types.js";
+import { FormRef, OpRef } from "../features/types.js";
 import "../features/index.js";
 import { SpecContractRegistry } from "../registry.js";
 
 //#region src/workflow/spec.d.ts
-/**
- * Reference to a form spec declared in {@link FormRegistry}.
- */
-interface FormRef {
-  key: string;
-  version: string;
-}
 type StepType = 'human' | 'automation' | 'decision';
 type WorkflowStatus = 'running' | 'paused' | 'completed' | 'failed' | 'cancelled';
 type GuardConditionKind = 'policy' | 'expression';
@@ -90,4 +83,4 @@ declare class WorkflowRegistry extends SpecContractRegistry<'workflow', Workflow
   constructor(items?: WorkflowSpec[]);
 }
 //#endregion
-export { CompensationStep, CompensationStrategy, FormRef, GuardCondition, GuardConditionKind, RetryPolicy, SLA, Step, StepAction, StepType, Transition, WorkflowDefinition, WorkflowMeta, WorkflowRegistry, WorkflowSpec, WorkflowStatus };
+export { CompensationStep, CompensationStrategy, type FormRef, GuardCondition, GuardConditionKind, RetryPolicy, SLA, Step, StepAction, StepType, Transition, WorkflowDefinition, WorkflowMeta, WorkflowRegistry, WorkflowSpec, WorkflowStatus };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contractspec/lib.contracts",
-  "version": "1.48.0",
+  "version": "1.49.0",
   "description": "Core contract specification definitions and runtime",
   "keywords": [
     "contractspec",
@@ -25,8 +25,8 @@
     "test": "bun test"
   },
   "devDependencies": {
-    "@contractspec/tool.tsdown": "1.48.0",
-    "@contractspec/tool.typescript": "1.48.0",
+    "@contractspec/tool.tsdown": "1.49.0",
+    "@contractspec/tool.typescript": "1.49.0",
     "@types/express": "^5.0.3",
     "@types/turndown": "^5.0.6",
     "tsdown": "^0.19.0",
@@ -35,8 +35,8 @@
   "dependencies": {
     "@aws-sdk/client-secrets-manager": "^3.966.0",
     "@aws-sdk/client-sqs": "^3.966.0",
-    "@contractspec/lib.logger": "1.48.0",
-    "@contractspec/lib.schema": "1.48.0",
+    "@contractspec/lib.logger": "1.49.0",
+    "@contractspec/lib.schema": "1.49.0",
     "@elevenlabs/elevenlabs-js": "^2.30.0",
     "@google-cloud/secret-manager": "^6.1.1",
     "@google-cloud/storage": "^7.18.0",
@@ -306,6 +306,9 @@
     "./registry-utils": "./dist/registry-utils.js",
     "./resources": "./dist/resources.js",
     "./schema-to-markdown": "./dist/schema-to-markdown.js",
+    "./serialization": "./dist/serialization/index.js",
+    "./serialization/serializers": "./dist/serialization/serializers.js",
+    "./serialization/types": "./dist/serialization/types.js",
     "./server": "./dist/server/index.js",
     "./server/contracts-adapter-hydration": "./dist/server/contracts-adapter-hydration.js",
     "./server/contracts-adapter-input": "./dist/server/contracts-adapter-input.js",