@contractspec/lib.contracts 1.51.0 → 1.53.0

package/dist/docs/tech/report-verification-table.docblock.js

@@ -0,0 +1,50 @@
+import { registerDocBlocks } from "../registry.js";
+
+//#region src/docs/tech/report-verification-table.docblock.ts
+registerDocBlocks([{
+	id: "docs.tech.report-verification-table",
+	title: "Contract Verification Table",
+	summary: "How the impact report renders per-contract verification status.",
+	kind: "how",
+	visibility: "public",
+	route: "/docs/tech/report/verification-table",
+	tags: [
+		"report",
+		"drift",
+		"verification",
+		"impact"
+	],
+	owners: ["platform.core"],
+	domain: "report",
+	body: `# Contract Verification Table
+
+The impact report includes an optional per-contract verification table that summarises the health of each contract at a glance.
+
+## Columns
+
+| Column | Description |
+|--------|-------------|
+| Contract / Endpoint / Event | Fully qualified contract name (e.g. \`user.create\`) |
+| Drift debt | Number of mismatches currently detected |
+| Time since verified | Human-friendly elapsed time (e.g. "23 days") or "Never" |
+| Surfaces covered | Comma-separated list (API, runtime validation, UI form, docs/examples, permissions) |
+| Last verified commit | Short SHA of the last drift-free commit |
+
+## Data flow
+
+1. The drift detector produces per-contract mismatch counts.
+2. \`.contractspec/verified.json\` records the last clean commit per contract.
+3. The report script reads both sources and renders the Markdown table.
+
+## Backward compatibility
+
+When \`contracts\` is absent from the report JSON, the table is skipped and the existing report sections render unchanged.
+
+## Contracts
+
+- Query: \`report.getContractVerificationStatus\` (v1.0.0)
+- Data view: \`report.contractVerificationTable\` (v1.0.0)
+`
+}]);
+
+//#endregion

package/dist/docs/views/contractReference.dataView.d.ts

@@ -0,0 +1,7 @@
+import { DataViewSpec } from "../../data-views/spec.js";
+import "../../index.js";
+
+//#region src/docs/views/contractReference.dataView.d.ts
+declare const ContractReferenceDataView: DataViewSpec;
+//#endregion
+export { ContractReferenceDataView };

package/dist/docs/views/contractReference.dataView.js

@@ -0,0 +1,80 @@
+import { defineDataView } from "../../data-views/spec.js";
+import "../../data-views/index.js";
+import { DOCS_DOMAIN, DOCS_OWNERS, DOCS_STABILITY, DOCS_TAGS } from "../constants.js";
+import { docId } from "../registry.js";
+import "../ensure-docblocks.js";
+import { ContractReferenceQuery } from "../queries/contractReference.query.js";
+
+//#region src/docs/views/contractReference.dataView.ts
+const ContractReferenceDataView = defineDataView({
+	meta: {
+		key: "docs.contract.reference.view",
+		title: "Contract Reference",
+		version: "1.0.0",
+		description: "Detail view for a single contract reference.",
+		domain: DOCS_DOMAIN,
+		owners: DOCS_OWNERS,
+		tags: [...DOCS_TAGS, "reference"],
+		stability: DOCS_STABILITY,
+		entity: "contract-reference",
+		docId: [docId("docs.tech.docs-reference")]
+	},
+	source: { primary: {
+		key: ContractReferenceQuery.meta.key,
+		version: ContractReferenceQuery.meta.version
+	} },
+	view: {
+		kind: "detail",
+		fields: [
+			{
+				key: "key",
+				label: "Key",
+				dataPath: "reference.key"
+			},
+			{
+				key: "version",
+				label: "Version",
+				dataPath: "reference.version"
+			},
+			{
+				key: "type",
+				label: "Type",
+				dataPath: "reference.type"
+			},
+			{
+				key: "title",
+				label: "Title",
+				dataPath: "reference.title"
+			},
+			{
+				key: "description",
+				label: "Description",
+				dataPath: "reference.description"
+			},
+			{
+				key: "tags",
+				label: "Tags",
+				dataPath: "reference.tags"
+			},
+			{
+				key: "owners",
+				label: "Owners",
+				dataPath: "reference.owners"
+			},
+			{
+				key: "stability",
+				label: "Stability",
+				dataPath: "reference.stability"
+			}
+		],
+		primaryField: "title",
+		secondaryFields: ["description"]
+	},
+	policy: {
+		flags: [],
+		pii: []
+	}
+});
+
+//#endregion
+export { ContractReferenceDataView };

package/dist/docs/views/docsIndex.dataView.d.ts

@@ -0,0 +1,7 @@
+import { DataViewSpec } from "../../data-views/spec.js";
+import "../../index.js";
+
+//#region src/docs/views/docsIndex.dataView.d.ts
+declare const DocsIndexDataView: DataViewSpec;
+//#endregion
+export { DocsIndexDataView };

package/dist/docs/views/docsIndex.dataView.js

@@ -0,0 +1,136 @@
+import { defineDataView } from "../../data-views/spec.js";
+import "../../data-views/index.js";
+import { DOCS_DOMAIN, DOCS_OWNERS, DOCS_STABILITY, DOCS_TAGS } from "../constants.js";
+import { docId } from "../registry.js";
+import "../ensure-docblocks.js";
+import { DocsIndexQuery } from "../queries/docsIndex.query.js";
+
+//#region src/docs/views/docsIndex.dataView.ts
+const DocsIndexDataView = defineDataView({
+	meta: {
+		key: "docs.index.view",
+		title: "Docs Index",
+		version: "1.0.0",
+		description: "List and filter documentation entries.",
+		domain: DOCS_DOMAIN,
+		owners: DOCS_OWNERS,
+		tags: [...DOCS_TAGS, "index"],
+		stability: DOCS_STABILITY,
+		entity: "docs",
+		docId: [docId("docs.tech.docs-search")]
+	},
+	source: { primary: {
+		key: DocsIndexQuery.meta.key,
+		version: DocsIndexQuery.meta.version
+	} },
+	view: {
+		kind: "list",
+		fields: [
+			{
+				key: "id",
+				label: "ID",
+				dataPath: "id"
+			},
+			{
+				key: "title",
+				label: "Title",
+				dataPath: "title"
+			},
+			{
+				key: "summary",
+				label: "Summary",
+				dataPath: "summary"
+			},
+			{
+				key: "route",
+				label: "Route",
+				dataPath: "route"
+			},
+			{
+				key: "tags",
+				label: "Tags",
+				dataPath: "tags",
+				format: "badge"
+			},
+			{
+				key: "kind",
+				label: "Kind",
+				dataPath: "kind"
+			},
+			{
+				key: "visibility",
+				label: "Visibility",
+				dataPath: "visibility"
+			}
+		],
+		primaryField: "title",
+		secondaryFields: ["summary", "route"],
+		filters: [
+			{
+				key: "query",
+				label: "Search",
+				field: "query",
+				type: "search"
+			},
+			{
+				key: "visibility",
+				label: "Visibility",
+				field: "visibility",
+				type: "enum",
+				options: [
+					{
+						value: "public",
+						label: "Public"
+					},
+					{
+						value: "internal",
+						label: "Internal"
+					},
+					{
+						value: "mixed",
+						label: "Mixed"
+					}
+				]
+			},
+			{
+				key: "kind",
+				label: "Kind",
+				field: "kind",
+				type: "enum",
+				options: [
+					{
+						value: "goal",
+						label: "Goal"
+					},
+					{
+						value: "how",
+						label: "How"
+					},
+					{
+						value: "usage",
+						label: "Usage"
+					},
+					{
+						value: "reference",
+						label: "Reference"
+					},
+					{
+						value: "faq",
+						label: "FAQ"
+					},
+					{
+						value: "changelog",
+						label: "Changelog"
+					}
+				]
+			}
+		]
+	},
+	policy: {
+		flags: [],
+		pii: []
+	}
+});
+
+//#endregion
+export { DocsIndexDataView };

package/dist/docs/views/exampleCatalog.dataView.d.ts

@@ -0,0 +1,7 @@
+import { DataViewSpec } from "../../data-views/spec.js";
+import "../../index.js";
+
+//#region src/docs/views/exampleCatalog.dataView.d.ts
+declare const ExampleCatalogDataView: DataViewSpec;
+//#endregion
+export { ExampleCatalogDataView };

package/dist/docs/views/exampleCatalog.dataView.js

@@ -0,0 +1,91 @@
+import { defineDataView } from "../../data-views/spec.js";
+import "../../data-views/index.js";
+import { DOCS_DOMAIN, DOCS_OWNERS, DOCS_STABILITY, DOCS_TAGS } from "../constants.js";
+import { docId } from "../registry.js";
+import "../ensure-docblocks.js";
+import { DocsIndexQuery } from "../queries/docsIndex.query.js";
+
+//#region src/docs/views/exampleCatalog.dataView.ts
+const ExampleCatalogDataView = defineDataView({
+	meta: {
+		key: "docs.examples.catalog.view",
+		title: "Examples Catalog",
+		version: "1.0.0",
+		description: "Catalog view of ContractSpec examples and demos.",
+		domain: DOCS_DOMAIN,
+		owners: DOCS_OWNERS,
+		tags: [...DOCS_TAGS, "examples"],
+		stability: DOCS_STABILITY,
+		entity: "docs-examples",
+		docId: [docId("docs.tech.docs-examples")]
+	},
+	source: { primary: {
+		key: DocsIndexQuery.meta.key,
+		version: DocsIndexQuery.meta.version
+	} },
+	view: {
+		kind: "grid",
+		fields: [
+			{
+				key: "id",
+				label: "ID",
+				dataPath: "id"
+			},
+			{
+				key: "title",
+				label: "Title",
+				dataPath: "title"
+			},
+			{
+				key: "summary",
+				label: "Summary",
+				dataPath: "summary"
+			},
+			{
+				key: "route",
+				label: "Route",
+				dataPath: "route"
+			},
+			{
+				key: "tags",
+				label: "Tags",
+				dataPath: "tags",
+				format: "badge"
+			}
+		],
+		primaryField: "title",
+		secondaryFields: ["summary"],
+		filters: [{
+			key: "query",
+			label: "Search",
+			field: "query",
+			type: "search"
+		}, {
+			key: "tags",
+			label: "Tags",
+			field: "tag",
+			type: "enum",
+			options: [
+				{
+					value: "examples",
+					label: "Examples"
+				},
+				{
+					value: "templates",
+					label: "Templates"
+				},
+				{
+					value: "sandbox",
+					label: "Sandbox"
+				}
+			]
+		}]
+	},
+	policy: {
+		flags: [],
+		pii: []
+	}
+});
+
+//#endregion
+export { ExampleCatalogDataView };

package/dist/docs/views/index.d.ts

@@ -0,0 +1,4 @@
+import { DocsIndexDataView } from "./docsIndex.dataView.js";
+import { ContractReferenceDataView } from "./contractReference.dataView.js";
+import { ExampleCatalogDataView } from "./exampleCatalog.dataView.js";
+export { ContractReferenceDataView, DocsIndexDataView, ExampleCatalogDataView };

package/dist/docs/views/index.js

@@ -0,0 +1,5 @@
+import { DocsIndexDataView } from "./docsIndex.dataView.js";
+import { ContractReferenceDataView } from "./contractReference.dataView.js";
+import { ExampleCatalogDataView } from "./exampleCatalog.dataView.js";
+
+export { ContractReferenceDataView, DocsIndexDataView, ExampleCatalogDataView };

package/dist/events.d.ts

@@ -1,7 +1,7 @@
 import { CapabilityRef } from "./capabilities/capabilities.js";
+import { SpecContractRegistry } from "./registry.js";
 import { DocId } from "./docs/registry.js";
 import { OwnerShipMeta } from "./ownership.js";
-import { SpecContractRegistry } from "./registry.js";
 import { AnySchemaModel } from "@contractspec/lib.schema";
 
 //#region src/events.d.ts

package/dist/examples/schema.d.ts

@@ -3,10 +3,10 @@ import { z as z$1 } from "zod";
 
 //#region src/examples/schema.d.ts
 declare const ExampleKindSchema: z$1.ZodEnum<{
-  knowledge: "knowledge";
+  integration: "integration";
   template: "template";
   workflow: "workflow";
-  integration: "integration";
+  knowledge: "knowledge";
   blueprint: "blueprint";
   ui: "ui";
   script: "script";
@@ -104,10 +104,10 @@ declare const ExampleMetaSchema: z$1.ZodObject<{
   tags: z$1.ZodArray<z$1.ZodString>;
   docId: z$1.ZodOptional<z$1.ZodArray<z$1.ZodString>>;
   kind: z$1.ZodEnum<{
-    knowledge: "knowledge";
+    integration: "integration";
     template: "template";
     workflow: "workflow";
-    integration: "integration";
+    knowledge: "knowledge";
     blueprint: "blueprint";
     ui: "ui";
     script: "script";
@@ -152,10 +152,10 @@ declare const ExampleSpecSchema: z$1.ZodObject<{
     tags: z$1.ZodArray<z$1.ZodString>;
     docId: z$1.ZodOptional<z$1.ZodArray<z$1.ZodString>>;
     kind: z$1.ZodEnum<{
-      knowledge: "knowledge";
+      integration: "integration";
       template: "template";
       workflow: "workflow";
-      integration: "integration";
+      knowledge: "knowledge";
       blueprint: "blueprint";
       ui: "ui";
       script: "script";
@@ -224,7 +224,7 @@ declare function safeParseExampleSpec(data: unknown): z$1.ZodSafeParseResult<{
     stability: "idea" | "in_creation" | "experimental" | "beta" | "stable" | "deprecated";
     owners: string[];
     tags: string[];
-    kind: "knowledge" | "template" | "workflow" | "integration" | "blueprint" | "ui" | "script" | "library";
+    kind: "integration" | "template" | "workflow" | "knowledge" | "blueprint" | "ui" | "script" | "library";
     visibility: "experimental" | "public" | "internal";
     title?: string | undefined;
     domain?: string | undefined;

package/dist/examples/types.d.ts

@@ -1,7 +1,7 @@
-import { OwnerShipMeta } from "../ownership.js";
 import { FeatureModuleSpec, FeatureRef } from "../features/types.js";
 import "../features/index.js";
 import { AppBlueprintSpec, SpecPointer } from "../app-config/spec.js";
+import { OwnerShipMeta } from "../ownership.js";
 
 //#region src/examples/types.d.ts
 /** Kind of example - determines how it's presented in catalogs */

package/dist/experiments/spec.d.ts

@@ -1,8 +1,8 @@
 import { OptionalVersionedSpecRef } from "../versioning/refs.js";
-import { OwnerShipMeta } from "../ownership.js";
 import { PolicyRef } from "../policy/spec.js";
-import { TelemetryEventDef } from "../telemetry/spec.js";
 import { SpecContractRegistry } from "../registry.js";
+import { TelemetryEventDef } from "../telemetry/spec.js";
+import { OwnerShipMeta } from "../ownership.js";
 
 //#region src/experiments/spec.d.ts
 /** Metadata for an experiment spec. */

package/dist/features/install.d.ts

@@ -1,11 +1,11 @@
 import { CapabilityRegistry } from "../capabilities/capabilities.js";
 import { PresentationSpec } from "../presentations/presentations.js";
-import { OperationSpecRegistry } from "../operations/registry.js";
 import { PresentationRegistry } from "../presentations/registry.js";
 import "../presentations/index.js";
 import "../capabilities/index.js";
 import { FeatureModuleSpec } from "./types.js";
 import { FeatureRegistry } from "./registry.js";
+import { OperationSpecRegistry } from "../operations/registry.js";
 
 //#region src/features/install.d.ts
 /** Dependencies for installing a feature. */

package/dist/features/types.d.ts

@@ -1,11 +1,11 @@
 import { SpecKeyRef, VersionedSpecRef } from "../versioning/refs.js";
 import { CapabilityRef, CapabilityRequirement } from "../capabilities/capabilities.js";
-import { PresentationTarget } from "../presentations/presentations.js";
-import { OwnerShipMeta } from "../ownership.js";
 import { ImplementationRef } from "../operations/operation.js";
-import "../operations/index.js";
+import { PresentationTarget } from "../presentations/presentations.js";
 import "../capabilities/index.js";
 import { ExperimentRef } from "../experiments/spec.js";
+import "../operations/index.js";
+import { OwnerShipMeta } from "../ownership.js";
 
 //#region src/features/types.d.ts
 /** Minimal metadata to identify and categorize a feature module. */

package/dist/forms/forms.d.ts

@@ -1,5 +1,5 @@
-import { OwnerShipMeta } from "../ownership.js";
 import { GroupKeyFn, RegistryFilter } from "../registry-utils.js";
+import { OwnerShipMeta } from "../ownership.js";
 import { AnySchemaModel, ZodSchemaModel } from "@contractspec/lib.schema";
 
 //#region src/forms/forms.d.ts