@contractspec/lib.contracts 0.0.0-canary-20260119225944 → 0.0.0-canary-20260128200020

package/dist/docs/queries/contractReference.query.d.ts

@@ -0,0 +1,217 @@
+import { OperationSpec } from "../../operations/operation.js";
+import "../../index.js";
+import * as _contractspec_lib_schema326 from "@contractspec/lib.schema";
+import { SchemaModel } from "@contractspec/lib.schema";
+
+//#region src/docs/queries/contractReference.query.d.ts
+declare const ContractReferenceInput: SchemaModel<{
+  key: {
+    type: _contractspec_lib_schema326.FieldType<string, string>;
+    isOptional: false;
+  };
+  version: {
+    type: _contractspec_lib_schema326.FieldType<string, string>;
+    isOptional: true;
+  };
+  type: {
+    type: _contractspec_lib_schema326.FieldType<string, string>;
+    isOptional: true;
+  };
+  format: {
+    type: _contractspec_lib_schema326.FieldType<string, string>;
+    isOptional: true;
+  };
+  includeSchema: {
+    type: _contractspec_lib_schema326.FieldType<boolean, boolean>;
+    isOptional: true;
+  };
+}>;
+declare const ContractReferenceModel: SchemaModel<{
+  key: {
+    type: _contractspec_lib_schema326.FieldType<string, string>;
+    isOptional: false;
+  };
+  version: {
+    type: _contractspec_lib_schema326.FieldType<string, string>;
+    isOptional: false;
+  };
+  type: {
+    type: _contractspec_lib_schema326.FieldType<string, string>;
+    isOptional: false;
+  };
+  title: {
+    type: _contractspec_lib_schema326.FieldType<string, string>;
+    isOptional: true;
+  };
+  description: {
+    type: _contractspec_lib_schema326.FieldType<string, string>;
+    isOptional: true;
+  };
+  markdown: {
+    type: _contractspec_lib_schema326.FieldType<string, string>;
+    isOptional: true;
+  };
+  route: {
+    type: _contractspec_lib_schema326.FieldType<string, string>;
+    isOptional: true;
+  };
+  schema: {
+    type: _contractspec_lib_schema326.FieldType<Record<string, unknown>, Record<string, unknown>>;
+    isOptional: true;
+  };
+  policy: {
+    type: _contractspec_lib_schema326.FieldType<Record<string, unknown>, Record<string, unknown>>;
+    isOptional: true;
+  };
+  tags: {
+    type: _contractspec_lib_schema326.FieldType<string, string>;
+    isOptional: true;
+    isArray: true;
+  };
+  owners: {
+    type: _contractspec_lib_schema326.FieldType<string, string>;
+    isOptional: true;
+    isArray: true;
+  };
+  stability: {
+    type: _contractspec_lib_schema326.FieldType<string, string>;
+    isOptional: true;
+  };
+}>;
+declare const ContractReferenceOutput: SchemaModel<{
+  reference: {
+    type: SchemaModel<{
+      key: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: false;
+      };
+      version: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: false;
+      };
+      type: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: false;
+      };
+      title: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: true;
+      };
+      description: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: true;
+      };
+      markdown: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: true;
+      };
+      route: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: true;
+      };
+      schema: {
+        type: _contractspec_lib_schema326.FieldType<Record<string, unknown>, Record<string, unknown>>;
+        isOptional: true;
+      };
+      policy: {
+        type: _contractspec_lib_schema326.FieldType<Record<string, unknown>, Record<string, unknown>>;
+        isOptional: true;
+      };
+      tags: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: true;
+        isArray: true;
+      };
+      owners: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: true;
+        isArray: true;
+      };
+      stability: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: true;
+      };
+    }>;
+    isOptional: false;
+  };
+}>;
+declare const ContractReferenceQuery: OperationSpec<SchemaModel<{
+  key: {
+    type: _contractspec_lib_schema326.FieldType<string, string>;
+    isOptional: false;
+  };
+  version: {
+    type: _contractspec_lib_schema326.FieldType<string, string>;
+    isOptional: true;
+  };
+  type: {
+    type: _contractspec_lib_schema326.FieldType<string, string>;
+    isOptional: true;
+  };
+  format: {
+    type: _contractspec_lib_schema326.FieldType<string, string>;
+    isOptional: true;
+  };
+  includeSchema: {
+    type: _contractspec_lib_schema326.FieldType<boolean, boolean>;
+    isOptional: true;
+  };
+}>, SchemaModel<{
+  reference: {
+    type: SchemaModel<{
+      key: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: false;
+      };
+      version: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: false;
+      };
+      type: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: false;
+      };
+      title: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: true;
+      };
+      description: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: true;
+      };
+      markdown: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: true;
+      };
+      route: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: true;
+      };
+      schema: {
+        type: _contractspec_lib_schema326.FieldType<Record<string, unknown>, Record<string, unknown>>;
+        isOptional: true;
+      };
+      policy: {
+        type: _contractspec_lib_schema326.FieldType<Record<string, unknown>, Record<string, unknown>>;
+        isOptional: true;
+      };
+      tags: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: true;
+        isArray: true;
+      };
+      owners: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: true;
+        isArray: true;
+      };
+      stability: {
+        type: _contractspec_lib_schema326.FieldType<string, string>;
+        isOptional: true;
+      };
+    }>;
+    isOptional: false;
+  };
+}>, undefined>;
+//#endregion
+export { ContractReferenceInput, ContractReferenceModel, ContractReferenceOutput, ContractReferenceQuery };

package/dist/docs/queries/contractReference.query.js

@@ -0,0 +1,122 @@
+import { defineQuery } from "../../operations/operation.js";
+import "../../operations/index.js";
+import { DOCS_CAPABILITY_REF, DOCS_DOMAIN, DOCS_OWNERS, DOCS_STABILITY, DOCS_TAGS } from "../constants.js";
+import { docId } from "../registry.js";
+import "../ensure-docblocks.js";
+import { ScalarTypeEnum, SchemaModel } from "@contractspec/lib.schema";
+
+//#region src/docs/queries/contractReference.query.ts
+const ContractReferenceInput = new SchemaModel({
+	name: "ContractReferenceInput",
+	fields: {
+		key: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		version: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		type: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		format: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		includeSchema: {
+			type: ScalarTypeEnum.Boolean(),
+			isOptional: true
+		}
+	}
+});
+const ContractReferenceModel = new SchemaModel({
+	name: "ContractReference",
+	fields: {
+		key: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		version: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		type: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		title: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		description: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		markdown: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		route: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		schema: {
+			type: ScalarTypeEnum.JSONObject(),
+			isOptional: true
+		},
+		policy: {
+			type: ScalarTypeEnum.JSONObject(),
+			isOptional: true
+		},
+		tags: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true,
+			isArray: true
+		},
+		owners: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true,
+			isArray: true
+		},
+		stability: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		}
+	}
+});
+const ContractReferenceOutput = new SchemaModel({
+	name: "ContractReferenceOutput",
+	fields: { reference: {
+		type: ContractReferenceModel,
+		isOptional: false
+	} }
+});
+const ContractReferenceQuery = defineQuery({
+	meta: {
+		key: "docs.contract.reference",
+		title: "Contract Reference",
+		version: "1.0.0",
+		description: "Resolve a contract into a documentation-ready reference.",
+		goal: "Expose a canonical reference view for any ContractSpec surface.",
+		context: "Used by docs generators and UI to render consistent reference pages.",
+		domain: DOCS_DOMAIN,
+		owners: DOCS_OWNERS,
+		tags: [...DOCS_TAGS, "reference"],
+		stability: DOCS_STABILITY,
+		docId: [docId("docs.tech.docs-reference")]
+	},
+	capability: DOCS_CAPABILITY_REF,
+	io: {
+		input: ContractReferenceInput,
+		output: ContractReferenceOutput
+	},
+	policy: {
+		auth: "anonymous",
+		pii: []
+	}
+});
+
+//#endregion
+export { ContractReferenceInput, ContractReferenceModel, ContractReferenceOutput, ContractReferenceQuery };

package/dist/docs/queries/docsIndex.query.d.ts

@@ -0,0 +1,272 @@
+import { OperationSpec } from "../../operations/operation.js";
+import "../../index.js";
+import * as _contractspec_lib_schema372 from "@contractspec/lib.schema";
+import { SchemaModel } from "@contractspec/lib.schema";
+
+//#region src/docs/queries/docsIndex.query.d.ts
+declare const DocSummaryModel: SchemaModel<{
+  id: {
+    type: _contractspec_lib_schema372.FieldType<string, string>;
+    isOptional: false;
+  };
+  title: {
+    type: _contractspec_lib_schema372.FieldType<string, string>;
+    isOptional: false;
+  };
+  summary: {
+    type: _contractspec_lib_schema372.FieldType<string, string>;
+    isOptional: true;
+  };
+  route: {
+    type: _contractspec_lib_schema372.FieldType<string, string>;
+    isOptional: true;
+  };
+  visibility: {
+    type: _contractspec_lib_schema372.FieldType<string, string>;
+    isOptional: true;
+  };
+  kind: {
+    type: _contractspec_lib_schema372.FieldType<string, string>;
+    isOptional: true;
+  };
+  version: {
+    type: _contractspec_lib_schema372.FieldType<string, string>;
+    isOptional: true;
+  };
+  tags: {
+    type: _contractspec_lib_schema372.FieldType<string, string>;
+    isOptional: true;
+    isArray: true;
+  };
+}>;
+declare const DocsIndexInput: SchemaModel<{
+  query: {
+    type: _contractspec_lib_schema372.FieldType<string, string>;
+    isOptional: true;
+  };
+  tag: {
+    type: _contractspec_lib_schema372.FieldType<string, string>;
+    isOptional: true;
+    isArray: true;
+  };
+  visibility: {
+    type: _contractspec_lib_schema372.FieldType<string, string>;
+    isOptional: true;
+  };
+  kind: {
+    type: _contractspec_lib_schema372.FieldType<string, string>;
+    isOptional: true;
+  };
+  limit: {
+    type: _contractspec_lib_schema372.FieldType<number, number>;
+    isOptional: true;
+  };
+  offset: {
+    type: _contractspec_lib_schema372.FieldType<number, number>;
+    isOptional: true;
+  };
+}>;
+declare const DocsIndexOutput: SchemaModel<{
+  items: {
+    type: SchemaModel<{
+      id: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: false;
+      };
+      title: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: false;
+      };
+      summary: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      route: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      visibility: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      kind: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      version: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      tags: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+        isArray: true;
+      };
+    }>;
+    isOptional: true;
+    isArray: true;
+  };
+  docs: {
+    type: SchemaModel<{
+      id: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: false;
+      };
+      title: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: false;
+      };
+      summary: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      route: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      visibility: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      kind: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      version: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      tags: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+        isArray: true;
+      };
+    }>;
+    isOptional: false;
+    isArray: true;
+  };
+  total: {
+    type: _contractspec_lib_schema372.FieldType<number, number>;
+    isOptional: true;
+  };
+  nextOffset: {
+    type: _contractspec_lib_schema372.FieldType<number, number>;
+    isOptional: true;
+  };
+}>;
+declare const DocsIndexQuery: OperationSpec<SchemaModel<{
+  query: {
+    type: _contractspec_lib_schema372.FieldType<string, string>;
+    isOptional: true;
+  };
+  tag: {
+    type: _contractspec_lib_schema372.FieldType<string, string>;
+    isOptional: true;
+    isArray: true;
+  };
+  visibility: {
+    type: _contractspec_lib_schema372.FieldType<string, string>;
+    isOptional: true;
+  };
+  kind: {
+    type: _contractspec_lib_schema372.FieldType<string, string>;
+    isOptional: true;
+  };
+  limit: {
+    type: _contractspec_lib_schema372.FieldType<number, number>;
+    isOptional: true;
+  };
+  offset: {
+    type: _contractspec_lib_schema372.FieldType<number, number>;
+    isOptional: true;
+  };
+}>, SchemaModel<{
+  items: {
+    type: SchemaModel<{
+      id: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: false;
+      };
+      title: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: false;
+      };
+      summary: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      route: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      visibility: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      kind: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      version: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      tags: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+        isArray: true;
+      };
+    }>;
+    isOptional: true;
+    isArray: true;
+  };
+  docs: {
+    type: SchemaModel<{
+      id: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: false;
+      };
+      title: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: false;
+      };
+      summary: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      route: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      visibility: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      kind: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      version: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+      };
+      tags: {
+        type: _contractspec_lib_schema372.FieldType<string, string>;
+        isOptional: true;
+        isArray: true;
+      };
+    }>;
+    isOptional: false;
+    isArray: true;
+  };
+  total: {
+    type: _contractspec_lib_schema372.FieldType<number, number>;
+    isOptional: true;
+  };
+  nextOffset: {
+    type: _contractspec_lib_schema372.FieldType<number, number>;
+    isOptional: true;
+  };
+}>, undefined>;
+//#endregion
+export { DocSummaryModel, DocsIndexInput, DocsIndexOutput, DocsIndexQuery };