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

package/dist/node/entities/index.js

@@ -0,0 +1,74 @@
+// 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 }
+  }
+});
+export {
+  SourceRefModel,
+  SourceDocumentModel,
+  RuleVersionModel,
+  RuleModel,
+  KBSnapshotModel
+};

package/dist/node/entities/models.js

@@ -0,0 +1,74 @@
+// 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 }
+  }
+});
+export {
+  SourceRefModel,
+  SourceDocumentModel,
+  RuleVersionModel,
+  RuleModel,
+  KBSnapshotModel
+};

package/dist/node/events.js

@@ -0,0 +1,101 @@
+// src/events.ts
+import { defineEvent, defineSchemaModel } from "@contractspec/lib.contracts";
+import { ScalarTypeEnum } from "@contractspec/lib.schema";
+var KbSourceIngestedPayload = defineSchemaModel({
+  name: "KbSourceIngestedPayload",
+  description: "Emitted when a source document is ingested.",
+  fields: {
+    sourceDocumentId: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    jurisdiction: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    hash: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var KbSourceIngestedEvent = defineEvent({
+  meta: {
+    key: "kb.source.ingested",
+    version: "1.0.0",
+    description: "Source document ingested (immutable).",
+    stability: "experimental",
+    owners: ["@examples"],
+    tags: ["knowledge"]
+  },
+  payload: KbSourceIngestedPayload
+});
+var KbRuleVersionCreatedPayload = defineSchemaModel({
+  name: "KbRuleVersionCreatedPayload",
+  description: "Emitted when a rule version draft is created.",
+  fields: {
+    ruleVersionId: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    ruleId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    jurisdiction: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    status: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var KbRuleVersionCreatedEvent = defineEvent({
+  meta: {
+    key: "kb.ruleVersion.created",
+    version: "1.0.0",
+    description: "Rule version created (draft).",
+    stability: "experimental",
+    owners: ["@examples"],
+    tags: ["knowledge"]
+  },
+  payload: KbRuleVersionCreatedPayload
+});
+var KbRuleVersionApprovedPayload = defineSchemaModel({
+  name: "KbRuleVersionApprovedPayload",
+  description: "Emitted when a rule version is approved.",
+  fields: {
+    ruleVersionId: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    approver: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var KbRuleVersionApprovedEvent = defineEvent({
+  meta: {
+    key: "kb.ruleVersion.approved",
+    version: "1.0.0",
+    description: "Rule version approved (human verified).",
+    stability: "experimental",
+    owners: ["@examples"],
+    tags: ["knowledge"]
+  },
+  payload: KbRuleVersionApprovedPayload
+});
+var KbSnapshotPublishedPayload = defineSchemaModel({
+  name: "KbSnapshotPublishedPayload",
+  description: "Emitted when a KB snapshot is published.",
+  fields: {
+    snapshotId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    jurisdiction: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    includedRuleVersionsCount: {
+      type: ScalarTypeEnum.Int_unsecure(),
+      isOptional: false
+    }
+  }
+});
+var KbSnapshotPublishedEvent = defineEvent({
+  meta: {
+    key: "kb.snapshot.published",
+    version: "1.0.0",
+    description: "KB snapshot published.",
+    stability: "experimental",
+    owners: ["@examples"],
+    tags: ["knowledge"]
+  },
+  payload: KbSnapshotPublishedPayload
+});
+export {
+  KbSourceIngestedEvent,
+  KbSnapshotPublishedEvent,
+  KbRuleVersionCreatedEvent,
+  KbRuleVersionApprovedEvent
+};

package/dist/node/example.js

@@ -0,0 +1,35 @@
+// src/example.ts
+import { defineExample } from "@contractspec/lib.contracts";
+var example = defineExample({
+  meta: {
+    key: "versioned-knowledge-base",
+    version: "1.0.0",
+    title: "Versioned Knowledge Base",
+    description: "Curated KB with immutable sources, reviewable rule versions, and published snapshots.",
+    kind: "knowledge",
+    visibility: "public",
+    stability: "experimental",
+    owners: ["@platform.core"],
+    tags: ["knowledge", "versioning", "snapshots"]
+  },
+  docs: {
+    rootDocId: "docs.examples.versioned-knowledge-base"
+  },
+  entrypoints: {
+    packageName: "@contractspec/example.versioned-knowledge-base",
+    feature: "./feature",
+    contracts: "./contracts",
+    handlers: "./handlers",
+    docs: "./docs"
+  },
+  surfaces: {
+    templates: true,
+    sandbox: { enabled: true, modes: ["markdown", "specs", "builder"] },
+    studio: { enabled: true, installable: true },
+    mcp: { enabled: true }
+  }
+});
+var example_default = example;
+export {
+  example_default as default
+};

package/dist/node/handlers/index.js

@@ -0,0 +1,115 @@
+// src/handlers/memory.handlers.ts
+function createMemoryKbStore() {
+  return {
+    sources: new Map,
+    rules: new Map,
+    ruleVersions: new Map,
+    snapshots: new Map,
+    nextRuleVersionNumberByRuleId: new Map
+  };
+}
+function stableId(prefix, value) {
+  return `${prefix}_${value.replace(/[^a-zA-Z0-9_-]/g, "_")}`;
+}
+function createMemoryKbHandlers(store) {
+  async function createRule(rule) {
+    store.rules.set(rule.id, rule);
+    return rule;
+  }
+  async function ingestSource(input) {
+    const id = stableId("src", `${input.jurisdiction}_${input.hash}`);
+    const doc = { id, ...input };
+    store.sources.set(id, doc);
+    return doc;
+  }
+  async function upsertRuleVersion(input) {
+    if (!input.sourceRefs.length) {
+      throw new Error("SOURCE_REFS_REQUIRED");
+    }
+    const rule = store.rules.get(input.ruleId);
+    if (!rule) {
+      throw new Error("RULE_NOT_FOUND");
+    }
+    const next = (store.nextRuleVersionNumberByRuleId.get(input.ruleId) ?? 0) + 1;
+    const id = stableId("rv", `${input.ruleId}_${next}`);
+    const ruleVersion = {
+      id,
+      ruleId: input.ruleId,
+      jurisdiction: rule.jurisdiction,
+      topicKey: rule.topicKey,
+      version: next.toString(),
+      content: input.content,
+      sourceRefs: input.sourceRefs,
+      status: "draft",
+      createdAt: new Date,
+      approvedAt: undefined,
+      approvedBy: undefined
+    };
+    store.ruleVersions.set(id, ruleVersion);
+    return ruleVersion;
+  }
+  async function approveRuleVersion(input) {
+    const existing = store.ruleVersions.get(input.ruleVersionId);
+    if (!existing) {
+      throw new Error("RULE_VERSION_NOT_FOUND");
+    }
+    const approved = {
+      ...existing,
+      status: "approved",
+      approvedBy: input.approver,
+      approvedAt: new Date
+    };
+    store.ruleVersions.set(approved.id, approved);
+    return approved;
+  }
+  async function publishSnapshot(input) {
+    const approved = [...store.ruleVersions.values()].filter((rv) => rv.status === "approved" && rv.jurisdiction === input.jurisdiction);
+    if (approved.length === 0) {
+      throw new Error("NO_APPROVED_RULES");
+    }
+    const includedRuleVersionIds = approved.map((rv) => rv.id).sort();
+    const id = stableId("snap", `${input.jurisdiction}_${input.asOfDate.toISOString().slice(0, 10)}_${includedRuleVersionIds.length}`);
+    const snapshot = {
+      id,
+      jurisdiction: input.jurisdiction,
+      asOfDate: input.asOfDate,
+      includedRuleVersionIds,
+      publishedAt: new Date
+    };
+    store.snapshots.set(id, snapshot);
+    return snapshot;
+  }
+  async function search(input) {
+    const snapshot = store.snapshots.get(input.snapshotId);
+    if (!snapshot) {
+      throw new Error("SNAPSHOT_NOT_FOUND");
+    }
+    if (snapshot.jurisdiction !== input.jurisdiction) {
+      throw new Error("JURISDICTION_MISMATCH");
+    }
+    const q = input.query.toLowerCase();
+    const tokens = q.split(/\s+/).map((t) => t.trim()).filter(Boolean);
+    const items = snapshot.includedRuleVersionIds.map((id) => store.ruleVersions.get(id)).filter((rv) => Boolean(rv)).filter((rv) => {
+      if (tokens.length === 0)
+        return true;
+      const hay = rv.content.toLowerCase();
+      return tokens.every((token) => hay.includes(token));
+    }).map((rv) => ({
+      ruleVersionId: rv.id,
+      excerpt: rv.content.slice(0, 120)
+    }));
+    return { items };
+  }
+  return {
+    createRule,
+    ingestSource,
+    upsertRuleVersion,
+    approveRuleVersion,
+    publishSnapshot,
+    search
+  };
+}
+export {
+  createMemoryKbStore,
+  createMemoryKbHandlers
+};

package/dist/node/handlers/memory.handlers.js

@@ -0,0 +1,115 @@
+// src/handlers/memory.handlers.ts
+function createMemoryKbStore() {
+  return {
+    sources: new Map,
+    rules: new Map,
+    ruleVersions: new Map,
+    snapshots: new Map,
+    nextRuleVersionNumberByRuleId: new Map
+  };
+}
+function stableId(prefix, value) {
+  return `${prefix}_${value.replace(/[^a-zA-Z0-9_-]/g, "_")}`;
+}
+function createMemoryKbHandlers(store) {
+  async function createRule(rule) {
+    store.rules.set(rule.id, rule);
+    return rule;
+  }
+  async function ingestSource(input) {
+    const id = stableId("src", `${input.jurisdiction}_${input.hash}`);
+    const doc = { id, ...input };
+    store.sources.set(id, doc);
+    return doc;
+  }
+  async function upsertRuleVersion(input) {
+    if (!input.sourceRefs.length) {
+      throw new Error("SOURCE_REFS_REQUIRED");
+    }
+    const rule = store.rules.get(input.ruleId);
+    if (!rule) {
+      throw new Error("RULE_NOT_FOUND");
+    }
+    const next = (store.nextRuleVersionNumberByRuleId.get(input.ruleId) ?? 0) + 1;
+    const id = stableId("rv", `${input.ruleId}_${next}`);
+    const ruleVersion = {
+      id,
+      ruleId: input.ruleId,
+      jurisdiction: rule.jurisdiction,
+      topicKey: rule.topicKey,
+      version: next.toString(),
+      content: input.content,
+      sourceRefs: input.sourceRefs,
+      status: "draft",
+      createdAt: new Date,
+      approvedAt: undefined,
+      approvedBy: undefined
+    };
+    store.ruleVersions.set(id, ruleVersion);
+    return ruleVersion;
+  }
+  async function approveRuleVersion(input) {
+    const existing = store.ruleVersions.get(input.ruleVersionId);
+    if (!existing) {
+      throw new Error("RULE_VERSION_NOT_FOUND");
+    }
+    const approved = {
+      ...existing,
+      status: "approved",
+      approvedBy: input.approver,
+      approvedAt: new Date
+    };
+    store.ruleVersions.set(approved.id, approved);
+    return approved;
+  }
+  async function publishSnapshot(input) {
+    const approved = [...store.ruleVersions.values()].filter((rv) => rv.status === "approved" && rv.jurisdiction === input.jurisdiction);
+    if (approved.length === 0) {
+      throw new Error("NO_APPROVED_RULES");
+    }
+    const includedRuleVersionIds = approved.map((rv) => rv.id).sort();
+    const id = stableId("snap", `${input.jurisdiction}_${input.asOfDate.toISOString().slice(0, 10)}_${includedRuleVersionIds.length}`);
+    const snapshot = {
+      id,
+      jurisdiction: input.jurisdiction,
+      asOfDate: input.asOfDate,
+      includedRuleVersionIds,
+      publishedAt: new Date
+    };
+    store.snapshots.set(id, snapshot);
+    return snapshot;
+  }
+  async function search(input) {
+    const snapshot = store.snapshots.get(input.snapshotId);
+    if (!snapshot) {
+      throw new Error("SNAPSHOT_NOT_FOUND");
+    }
+    if (snapshot.jurisdiction !== input.jurisdiction) {
+      throw new Error("JURISDICTION_MISMATCH");
+    }
+    const q = input.query.toLowerCase();
+    const tokens = q.split(/\s+/).map((t) => t.trim()).filter(Boolean);
+    const items = snapshot.includedRuleVersionIds.map((id) => store.ruleVersions.get(id)).filter((rv) => Boolean(rv)).filter((rv) => {
+      if (tokens.length === 0)
+        return true;
+      const hay = rv.content.toLowerCase();
+      return tokens.every((token) => hay.includes(token));
+    }).map((rv) => ({
+      ruleVersionId: rv.id,
+      excerpt: rv.content.slice(0, 120)
+    }));
+    return { items };
+  }
+  return {
+    createRule,
+    ingestSource,
+    upsertRuleVersion,
+    approveRuleVersion,
+    publishSnapshot,
+    search
+  };
+}
+export {
+  createMemoryKbStore,
+  createMemoryKbHandlers
+};