@contractspec/example.versioned-knowledge-base 1.56.1 → 1.58.0

package/dist/node/operations/index.js

@@ -0,0 +1,257 @@
+// src/entities/models.ts
+import { ScalarTypeEnum, defineSchemaModel } from "@contractspec/lib.schema";
+var SourceDocumentModel = defineSchemaModel({
+  name: "SourceDocument",
+  description: "Immutable raw source document metadata referencing a stored file.",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    jurisdiction: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    authority: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    title: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    fetchedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false },
+    hash: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    fileId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var SourceRefModel = defineSchemaModel({
+  name: "SourceRef",
+  description: "Reference to a source document used to justify a rule version.",
+  fields: {
+    sourceDocumentId: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    excerpt: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+var RuleModel = defineSchemaModel({
+  name: "Rule",
+  description: "Curated rule (stable identity) with topic + jurisdiction scope.",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    jurisdiction: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    topicKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var RuleVersionModel = defineSchemaModel({
+  name: "RuleVersion",
+  description: "A versioned rule content with source references and approval status.",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    ruleId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    jurisdiction: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    topicKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    version: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    content: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    sourceRefs: { type: SourceRefModel, isArray: true, isOptional: false },
+    status: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    approvedBy: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    approvedAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    createdAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var KBSnapshotModel = defineSchemaModel({
+  name: "KBSnapshot",
+  description: "Published KB snapshot (as-of) referencing approved rule versions.",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    jurisdiction: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    asOfDate: { type: ScalarTypeEnum.DateTime(), isOptional: false },
+    includedRuleVersionIds: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isArray: true,
+      isOptional: false
+    },
+    publishedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+
+// src/operations/kb.ts
+import { defineCommand, defineQuery } from "@contractspec/lib.contracts";
+import { ScalarTypeEnum as ScalarTypeEnum2, defineSchemaModel as defineSchemaModel2 } from "@contractspec/lib.schema";
+var IngestSourceInput = defineSchemaModel2({
+  name: "KbIngestSourceInput",
+  description: "Ingest immutable source metadata referencing a stored file.",
+  fields: {
+    jurisdiction: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    authority: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    title: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    fetchedAt: { type: ScalarTypeEnum2.DateTime(), isOptional: false },
+    hash: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    fileId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false }
+  }
+});
+var UpsertRuleVersionInput = defineSchemaModel2({
+  name: "KbUpsertRuleVersionInput",
+  description: "Create a new draft rule version (immutable history).",
+  fields: {
+    ruleId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    content: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    sourceRefs: { type: SourceRefModel, isArray: true, isOptional: false }
+  }
+});
+var ApproveRuleVersionInput = defineSchemaModel2({
+  name: "KbApproveRuleVersionInput",
+  description: "Approve a rule version (human verification).",
+  fields: {
+    ruleVersionId: {
+      type: ScalarTypeEnum2.String_unsecure(),
+      isOptional: false
+    },
+    approver: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false }
+  }
+});
+var PublishSnapshotInput = defineSchemaModel2({
+  name: "KbPublishSnapshotInput",
+  description: "Publish a snapshot for a jurisdiction as-of a date.",
+  fields: {
+    jurisdiction: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    asOfDate: { type: ScalarTypeEnum2.DateTime(), isOptional: false }
+  }
+});
+var SearchKbInput = defineSchemaModel2({
+  name: "KbSearchInput",
+  description: "Search within a published snapshot.",
+  fields: {
+    snapshotId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    jurisdiction: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    query: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false }
+  }
+});
+var SearchKbResultItem = defineSchemaModel2({
+  name: "KbSearchResultItem",
+  description: "Search result referencing a specific rule version.",
+  fields: {
+    ruleVersionId: {
+      type: ScalarTypeEnum2.String_unsecure(),
+      isOptional: false
+    },
+    excerpt: { type: ScalarTypeEnum2.String_unsecure(), isOptional: true }
+  }
+});
+var SearchKbOutput = defineSchemaModel2({
+  name: "KbSearchOutput",
+  description: "Search results constrained to snapshot + jurisdiction.",
+  fields: {
+    items: { type: SearchKbResultItem, isArray: true, isOptional: false }
+  }
+});
+var KbIngestSourceContract = defineCommand({
+  meta: {
+    key: "kb.ingestSource",
+    title: "Ingest Source",
+    version: "1.0.0",
+    stability: "experimental",
+    owners: ["@examples"],
+    tags: ["knowledge", "sources", "ingestion"],
+    description: "Ingest immutable source document metadata.",
+    goal: "Store traceable source documents for curated KB.",
+    context: "Called when an admin uploads/records authoritative sources."
+  },
+  io: {
+    input: IngestSourceInput,
+    output: SourceDocumentModel
+  },
+  policy: { auth: "user" }
+});
+var KbUpsertRuleVersionContract = defineCommand({
+  meta: {
+    key: "kb.upsertRuleVersion",
+    title: "Upsert Rule Version",
+    version: "1.0.0",
+    stability: "experimental",
+    owners: ["@examples"],
+    tags: ["knowledge", "rules", "versioning"],
+    description: "Create a new draft rule version with source references.",
+    goal: "Propose curated knowledge updates with traceability.",
+    context: "Automation or curators propose draft rule versions."
+  },
+  io: {
+    input: UpsertRuleVersionInput,
+    output: RuleVersionModel,
+    errors: {
+      SOURCE_REFS_REQUIRED: {
+        description: "Rule version must cite at least one sourceRef",
+        http: 400,
+        gqlCode: "SOURCE_REFS_REQUIRED",
+        when: "sourceRefs is empty"
+      },
+      RULE_NOT_FOUND: {
+        description: "Rule does not exist",
+        http: 404,
+        gqlCode: "RULE_NOT_FOUND",
+        when: "ruleId is unknown"
+      }
+    }
+  },
+  policy: { auth: "user" }
+});
+var KbApproveRuleVersionContract = defineCommand({
+  meta: {
+    key: "kb.approveRuleVersion",
+    title: "Approve Rule Version",
+    version: "1.0.0",
+    stability: "experimental",
+    owners: ["@examples"],
+    tags: ["knowledge", "rules", "approval"],
+    description: "Approve a draft rule version.",
+    goal: "Human verification step before publishing snapshots.",
+    context: "Curators/experts approve proposed KB changes."
+  },
+  io: {
+    input: ApproveRuleVersionInput,
+    output: RuleVersionModel
+  },
+  policy: { auth: "user" }
+});
+var KbPublishSnapshotContract = defineCommand({
+  meta: {
+    key: "kb.publishSnapshot",
+    title: "Publish Snapshot",
+    version: "1.0.0",
+    stability: "experimental",
+    owners: ["@examples"],
+    tags: ["knowledge", "snapshots", "publishing"],
+    description: "Publish a KB snapshot for a jurisdiction.",
+    goal: "Create a stable snapshot that assistant answers can cite.",
+    context: "Publishing happens after approvals; snapshot is referenced by answers."
+  },
+  io: {
+    input: PublishSnapshotInput,
+    output: KBSnapshotModel,
+    errors: {
+      NO_APPROVED_RULES: {
+        description: "No approved rule versions available to publish",
+        http: 409,
+        gqlCode: "NO_APPROVED_RULES",
+        when: "jurisdiction has zero approved rule versions"
+      }
+    }
+  },
+  policy: { auth: "user" }
+});
+var KbSearchContract = defineQuery({
+  meta: {
+    key: "kb.search",
+    title: "Search KB",
+    version: "1.0.0",
+    stability: "experimental",
+    owners: ["@examples"],
+    tags: ["knowledge", "search", "snapshots"],
+    description: "Search within a published KB snapshot.",
+    goal: "Provide scoped retrieval for assistant answers.",
+    context: "Assistant queries curated rules from a specific snapshot."
+  },
+  io: {
+    input: SearchKbInput,
+    output: SearchKbOutput
+  },
+  policy: { auth: "user" }
+});
+export {
+  KbUpsertRuleVersionContract,
+  KbSearchContract,
+  KbPublishSnapshotContract,
+  KbIngestSourceContract,
+  KbApproveRuleVersionContract
+};

package/dist/node/operations/kb.js

@@ -0,0 +1,257 @@
+// src/entities/models.ts
+import { ScalarTypeEnum, defineSchemaModel } from "@contractspec/lib.schema";
+var SourceDocumentModel = defineSchemaModel({
+  name: "SourceDocument",
+  description: "Immutable raw source document metadata referencing a stored file.",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    jurisdiction: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    authority: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    title: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    fetchedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false },
+    hash: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    fileId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var SourceRefModel = defineSchemaModel({
+  name: "SourceRef",
+  description: "Reference to a source document used to justify a rule version.",
+  fields: {
+    sourceDocumentId: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    excerpt: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+var RuleModel = defineSchemaModel({
+  name: "Rule",
+  description: "Curated rule (stable identity) with topic + jurisdiction scope.",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    jurisdiction: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    topicKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var RuleVersionModel = defineSchemaModel({
+  name: "RuleVersion",
+  description: "A versioned rule content with source references and approval status.",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    ruleId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    jurisdiction: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    topicKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    version: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    content: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    sourceRefs: { type: SourceRefModel, isArray: true, isOptional: false },
+    status: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    approvedBy: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    approvedAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    createdAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var KBSnapshotModel = defineSchemaModel({
+  name: "KBSnapshot",
+  description: "Published KB snapshot (as-of) referencing approved rule versions.",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    jurisdiction: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    asOfDate: { type: ScalarTypeEnum.DateTime(), isOptional: false },
+    includedRuleVersionIds: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isArray: true,
+      isOptional: false
+    },
+    publishedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+
+// src/operations/kb.ts
+import { defineCommand, defineQuery } from "@contractspec/lib.contracts";
+import { ScalarTypeEnum as ScalarTypeEnum2, defineSchemaModel as defineSchemaModel2 } from "@contractspec/lib.schema";
+var IngestSourceInput = defineSchemaModel2({
+  name: "KbIngestSourceInput",
+  description: "Ingest immutable source metadata referencing a stored file.",
+  fields: {
+    jurisdiction: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    authority: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    title: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    fetchedAt: { type: ScalarTypeEnum2.DateTime(), isOptional: false },
+    hash: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    fileId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false }
+  }
+});
+var UpsertRuleVersionInput = defineSchemaModel2({
+  name: "KbUpsertRuleVersionInput",
+  description: "Create a new draft rule version (immutable history).",
+  fields: {
+    ruleId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    content: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    sourceRefs: { type: SourceRefModel, isArray: true, isOptional: false }
+  }
+});
+var ApproveRuleVersionInput = defineSchemaModel2({
+  name: "KbApproveRuleVersionInput",
+  description: "Approve a rule version (human verification).",
+  fields: {
+    ruleVersionId: {
+      type: ScalarTypeEnum2.String_unsecure(),
+      isOptional: false
+    },
+    approver: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false }
+  }
+});
+var PublishSnapshotInput = defineSchemaModel2({
+  name: "KbPublishSnapshotInput",
+  description: "Publish a snapshot for a jurisdiction as-of a date.",
+  fields: {
+    jurisdiction: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    asOfDate: { type: ScalarTypeEnum2.DateTime(), isOptional: false }
+  }
+});
+var SearchKbInput = defineSchemaModel2({
+  name: "KbSearchInput",
+  description: "Search within a published snapshot.",
+  fields: {
+    snapshotId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    jurisdiction: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
+    query: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false }
+  }
+});
+var SearchKbResultItem = defineSchemaModel2({
+  name: "KbSearchResultItem",
+  description: "Search result referencing a specific rule version.",
+  fields: {
+    ruleVersionId: {
+      type: ScalarTypeEnum2.String_unsecure(),
+      isOptional: false
+    },
+    excerpt: { type: ScalarTypeEnum2.String_unsecure(), isOptional: true }
+  }
+});
+var SearchKbOutput = defineSchemaModel2({
+  name: "KbSearchOutput",
+  description: "Search results constrained to snapshot + jurisdiction.",
+  fields: {
+    items: { type: SearchKbResultItem, isArray: true, isOptional: false }
+  }
+});
+var KbIngestSourceContract = defineCommand({
+  meta: {
+    key: "kb.ingestSource",
+    title: "Ingest Source",
+    version: "1.0.0",
+    stability: "experimental",
+    owners: ["@examples"],
+    tags: ["knowledge", "sources", "ingestion"],
+    description: "Ingest immutable source document metadata.",
+    goal: "Store traceable source documents for curated KB.",
+    context: "Called when an admin uploads/records authoritative sources."
+  },
+  io: {
+    input: IngestSourceInput,
+    output: SourceDocumentModel
+  },
+  policy: { auth: "user" }
+});
+var KbUpsertRuleVersionContract = defineCommand({
+  meta: {
+    key: "kb.upsertRuleVersion",
+    title: "Upsert Rule Version",
+    version: "1.0.0",
+    stability: "experimental",
+    owners: ["@examples"],
+    tags: ["knowledge", "rules", "versioning"],
+    description: "Create a new draft rule version with source references.",
+    goal: "Propose curated knowledge updates with traceability.",
+    context: "Automation or curators propose draft rule versions."
+  },
+  io: {
+    input: UpsertRuleVersionInput,
+    output: RuleVersionModel,
+    errors: {
+      SOURCE_REFS_REQUIRED: {
+        description: "Rule version must cite at least one sourceRef",
+        http: 400,
+        gqlCode: "SOURCE_REFS_REQUIRED",
+        when: "sourceRefs is empty"
+      },
+      RULE_NOT_FOUND: {
+        description: "Rule does not exist",
+        http: 404,
+        gqlCode: "RULE_NOT_FOUND",
+        when: "ruleId is unknown"
+      }
+    }
+  },
+  policy: { auth: "user" }
+});
+var KbApproveRuleVersionContract = defineCommand({
+  meta: {
+    key: "kb.approveRuleVersion",
+    title: "Approve Rule Version",
+    version: "1.0.0",
+    stability: "experimental",
+    owners: ["@examples"],
+    tags: ["knowledge", "rules", "approval"],
+    description: "Approve a draft rule version.",
+    goal: "Human verification step before publishing snapshots.",
+    context: "Curators/experts approve proposed KB changes."
+  },
+  io: {
+    input: ApproveRuleVersionInput,
+    output: RuleVersionModel
+  },
+  policy: { auth: "user" }
+});
+var KbPublishSnapshotContract = defineCommand({
+  meta: {
+    key: "kb.publishSnapshot",
+    title: "Publish Snapshot",
+    version: "1.0.0",
+    stability: "experimental",
+    owners: ["@examples"],
+    tags: ["knowledge", "snapshots", "publishing"],
+    description: "Publish a KB snapshot for a jurisdiction.",
+    goal: "Create a stable snapshot that assistant answers can cite.",
+    context: "Publishing happens after approvals; snapshot is referenced by answers."
+  },
+  io: {
+    input: PublishSnapshotInput,
+    output: KBSnapshotModel,
+    errors: {
+      NO_APPROVED_RULES: {
+        description: "No approved rule versions available to publish",
+        http: 409,
+        gqlCode: "NO_APPROVED_RULES",
+        when: "jurisdiction has zero approved rule versions"
+      }
+    }
+  },
+  policy: { auth: "user" }
+});
+var KbSearchContract = defineQuery({
+  meta: {
+    key: "kb.search",
+    title: "Search KB",
+    version: "1.0.0",
+    stability: "experimental",
+    owners: ["@examples"],
+    tags: ["knowledge", "search", "snapshots"],
+    description: "Search within a published KB snapshot.",
+    goal: "Provide scoped retrieval for assistant answers.",
+    context: "Assistant queries curated rules from a specific snapshot."
+  },
+  io: {
+    input: SearchKbInput,
+    output: SearchKbOutput
+  },
+  policy: { auth: "user" }
+});
+export {
+  KbUpsertRuleVersionContract,
+  KbSearchContract,
+  KbPublishSnapshotContract,
+  KbIngestSourceContract,
+  KbApproveRuleVersionContract
+};

package/dist/node/versioned-knowledge-base.feature.js

@@ -0,0 +1,36 @@
+// src/versioned-knowledge-base.feature.ts
+import { defineFeature } from "@contractspec/lib.contracts";
+var VersionedKnowledgeBaseFeature = defineFeature({
+  meta: {
+    key: "versioned-knowledge-base",
+    version: "1.0.0",
+    title: "Versioned Knowledge Base",
+    description: "Curated KB with immutable sources, rule versions, and published snapshots.",
+    domain: "knowledge",
+    owners: ["@examples"],
+    tags: ["knowledge", "versioning", "snapshots"],
+    stability: "experimental"
+  },
+  operations: [
+    { key: "kb.ingestSource", version: "1.0.0" },
+    { key: "kb.upsertRuleVersion", version: "1.0.0" },
+    { key: "kb.approveRuleVersion", version: "1.0.0" },
+    { key: "kb.publishSnapshot", version: "1.0.0" },
+    { key: "kb.search", version: "1.0.0" }
+  ],
+  events: [
+    { key: "kb.source.ingested", version: "1.0.0" },
+    { key: "kb.ruleVersion.created", version: "1.0.0" },
+    { key: "kb.ruleVersion.approved", version: "1.0.0" },
+    { key: "kb.snapshot.published", version: "1.0.0" }
+  ],
+  presentations: [],
+  opToPresentation: [],
+  presentationsTargets: [],
+  capabilities: {
+    requires: [{ key: "knowledge", version: "1.0.0" }]
+  }
+});
+export {
+  VersionedKnowledgeBaseFeature
+};

package/dist/operations/index.d.ts

@@ -1,2 +1,2 @@
-import { KbApproveRuleVersionContract, KbIngestSourceContract, KbPublishSnapshotContract, KbSearchContract, KbUpsertRuleVersionContract } from "./kb.js";
-export { KbApproveRuleVersionContract, KbIngestSourceContract, KbPublishSnapshotContract, KbSearchContract, KbUpsertRuleVersionContract };
+export * from './kb';
+//# sourceMappingURL=index.d.ts.map

package/dist/operations/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/operations/index.ts"],"names":[],"mappings":"AAAA,cAAc,MAAM,CAAC"}