@contractspec/lib.contracts 1.61.0 → 1.63.0

package/dist/node/docs/tech/contracts/openapi-import.docblock.js

@@ -1,207 +0,0 @@
-import { createRequire } from "node:module";
-var __defProp = Object.defineProperty;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __moduleCache = /* @__PURE__ */ new WeakMap;
-var __toCommonJS = (from) => {
-  var entry = __moduleCache.get(from), desc;
-  if (entry)
-    return entry;
-  entry = __defProp({}, "__esModule", { value: true });
-  if (from && typeof from === "object" || typeof from === "function")
-    __getOwnPropNames(from).map((key) => !__hasOwnProp.call(entry, key) && __defProp(entry, key, {
-      get: () => from[key],
-      enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
-    }));
-  __moduleCache.set(from, entry);
-  return entry;
-};
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, {
-      get: all[name],
-      enumerable: true,
-      configurable: true,
-      set: (newValue) => all[name] = () => newValue
-    });
-};
-var __esm = (fn, res) => () => (fn && (res = fn(fn = 0)), res);
-var __require = /* @__PURE__ */ createRequire(import.meta.url);
-
-// src/docs/presentations.ts
-var DEFAULT_TARGETS = [
-  "markdown",
-  "react"
-];
-function normalizeRoute(route) {
-  if (!route.length)
-    return "/";
-  const withLeading = route.startsWith("/") ? route : `/${route}`;
-  return withLeading === "/" ? "/" : withLeading.replace(/\/+$/, "");
-}
-function deriveRoute(block, routePrefix) {
-  if (block.route)
-    return normalizeRoute(block.route);
-  const prefix = routePrefix ?? "/docs";
-  const slug = block.id.replace(/^docs\.?/, "").replace(/\./g, "/").replace(/\/+/g, "/");
-  const path = slug.startsWith("/") ? slug : `${prefix}/${slug}`;
-  return normalizeRoute(path);
-}
-function buildName(block, namespace) {
-  return namespace ? `${namespace}.${block.id}` : block.id;
-}
-function docBlockToPresentationSpec(block, options) {
-  const targets = options?.defaultTargets ?? DEFAULT_TARGETS;
-  const version = block.version ?? options?.defaultVersion ?? "1.0.0";
-  const stability = block.stability ?? options?.defaultStability ?? "stable";
-  return {
-    meta: {
-      key: buildName(block, options?.namespace),
-      title: block.title,
-      version,
-      description: block.summary ?? block.title,
-      tags: block.tags || [],
-      owners: block.owners || [],
-      domain: block.domain || "",
-      stability,
-      goal: `Documentation of: ${block.summary}`,
-      context: `Auto-generated`
-    },
-    policy: block.visibility && block.visibility !== "public" ? { flags: [block.visibility] } : undefined,
-    source: {
-      type: "blocknotejs",
-      docJson: block.body
-    },
-    targets
-  };
-}
-function docBlocksToPresentationRoutes(blocks, options) {
-  return blocks.map((block) => ({
-    block,
-    route: deriveRoute(block, options?.routePrefix),
-    descriptor: docBlockToPresentationSpec(block, options)
-  }));
-}
-function docBlocksToPresentationSpecs(blocks, options) {
-  return blocks.map((block) => docBlockToPresentationSpec(block, options));
-}
-function mapDocRoutes(routes) {
-  return routes.map(({ route, descriptor }) => [route, descriptor]);
-}
-
-// src/docs/registry.ts
-class DocRegistry {
-  routes = new Map;
-  constructor(blocks = [], options) {
-    blocks.forEach((block) => this.register(block, options));
-  }
-  register(block, options) {
-    const [route] = docBlocksToPresentationRoutes([block], options);
-    if (route) {
-      this.routes.set(block.id, route);
-    }
-    return this;
-  }
-  list() {
-    return [...this.routes.values()];
-  }
-  get(id) {
-    return this.routes.get(id);
-  }
-  toRouteTuples() {
-    return this.list().map(({ route, descriptor }) => [route, descriptor]);
-  }
-  toPresentationSpecs(options) {
-    return this.list().map(({ block }) => docBlockToPresentationSpec(block, options));
-  }
-}
-var requiredFields = [
-  "id",
-  "title",
-  "body",
-  "kind",
-  "visibility",
-  "route"
-];
-var defaultDocRegistry = new DocRegistry;
-function registerDocBlocks(blocks) {
-  for (const block of blocks) {
-    for (const field of requiredFields) {
-      if (!block[field]) {
-        throw new Error(`DocBlock ${block.id ?? "<missing id>"} missing field ${String(field)}`);
-      }
-    }
-    defaultDocRegistry.register(block);
-  }
-}
-function listRegisteredDocBlocks() {
-  return defaultDocRegistry.list().map((r) => r.block);
-}
-function docId(id) {
-  const found = defaultDocRegistry.get(id);
-  if (!found)
-    throw new Error(`DocBlock not registered: ${id}`);
-  return id;
-}
-
-// src/docs/tech/contracts/openapi-import.docblock.ts
-var tech_contracts_openapi_import_DocBlocks = [
-  {
-    id: "docs.tech.contracts.openapi-import",
-    title: "OpenAPI Import (OpenAPI 3.1) to ContractSpec",
-    summary: "Import OpenAPI specifications into ContractSpec models, or generate pure Zod/JSON-Schema/GraphQL representations.",
-    kind: "reference",
-    visibility: "public",
-    route: "/docs/tech/contracts/openapi-import",
-    tags: ["contracts", "openapi", "import", "codegen"],
-    body: `## OpenAPI Import (OpenAPI 3.1)
-
-### Purpose
-
-Import external API definitions into your codebase. Supports both one-time scaffolding and multi-format generation for integration.
-
-### Modes
-
-#### 1. ContractSpec Scaffolding (Default)
-
-Generates standard \`defineSchemaModel\` definitions for full ContractSpec integration.
-
-\`\`\`bash
-contractspec openapi import --file api.json --output ./src/contracts
-\`\`\`
-
-#### 2. Multi-Format Generation
-
-Generate schemas in specific formats for direct use in other parts of your stack (adapters, UI, etc.).
-
-- **Zod**: Pure Zod schemas (\`z.object(...)\`).
-- **GraphQL**: GraphQL SDL type definitions.
-- **JSON Schema**: Standard JSON Schema objects.
-
-\`\`\`bash
-# Generate Zod schemas suitable for runtime validation
-contractspec openapi import --file api.json --output ./src/zod --schema-format zod
-\`\`\`
-
-### Library API
-
-- Function: \`importFromOpenApi(doc, options)\`
-- Location: \`@contractspec/lib.contracts-transformers/openapi\`
-- Options:
-  - \`schemaFormat\`: 'contractspec' | 'zod' | 'json-schema' | 'graphql'
-  - \`prefix\`: Prefix for model names
-  - \`tags\`: Filter by OpenAPI tags
-
-### CLI
-
-\`\`\`bash
-contractspec openapi import --file <path-or-url> --output <dir> [--schema-format <format>]
-\`\`\`
-`
-  }
-];
-registerDocBlocks(tech_contracts_openapi_import_DocBlocks);
-export {
-  tech_contracts_openapi_import_DocBlocks
-};

package/dist/node/docs/tech/contracts/ops-to-presentation-linking.docblock.js

@@ -1,225 +0,0 @@
-import { createRequire } from "node:module";
-var __defProp = Object.defineProperty;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __moduleCache = /* @__PURE__ */ new WeakMap;
-var __toCommonJS = (from) => {
-  var entry = __moduleCache.get(from), desc;
-  if (entry)
-    return entry;
-  entry = __defProp({}, "__esModule", { value: true });
-  if (from && typeof from === "object" || typeof from === "function")
-    __getOwnPropNames(from).map((key) => !__hasOwnProp.call(entry, key) && __defProp(entry, key, {
-      get: () => from[key],
-      enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
-    }));
-  __moduleCache.set(from, entry);
-  return entry;
-};
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, {
-      get: all[name],
-      enumerable: true,
-      configurable: true,
-      set: (newValue) => all[name] = () => newValue
-    });
-};
-var __esm = (fn, res) => () => (fn && (res = fn(fn = 0)), res);
-var __require = /* @__PURE__ */ createRequire(import.meta.url);
-
-// src/docs/presentations.ts
-var DEFAULT_TARGETS = [
-  "markdown",
-  "react"
-];
-function normalizeRoute(route) {
-  if (!route.length)
-    return "/";
-  const withLeading = route.startsWith("/") ? route : `/${route}`;
-  return withLeading === "/" ? "/" : withLeading.replace(/\/+$/, "");
-}
-function deriveRoute(block, routePrefix) {
-  if (block.route)
-    return normalizeRoute(block.route);
-  const prefix = routePrefix ?? "/docs";
-  const slug = block.id.replace(/^docs\.?/, "").replace(/\./g, "/").replace(/\/+/g, "/");
-  const path = slug.startsWith("/") ? slug : `${prefix}/${slug}`;
-  return normalizeRoute(path);
-}
-function buildName(block, namespace) {
-  return namespace ? `${namespace}.${block.id}` : block.id;
-}
-function docBlockToPresentationSpec(block, options) {
-  const targets = options?.defaultTargets ?? DEFAULT_TARGETS;
-  const version = block.version ?? options?.defaultVersion ?? "1.0.0";
-  const stability = block.stability ?? options?.defaultStability ?? "stable";
-  return {
-    meta: {
-      key: buildName(block, options?.namespace),
-      title: block.title,
-      version,
-      description: block.summary ?? block.title,
-      tags: block.tags || [],
-      owners: block.owners || [],
-      domain: block.domain || "",
-      stability,
-      goal: `Documentation of: ${block.summary}`,
-      context: `Auto-generated`
-    },
-    policy: block.visibility && block.visibility !== "public" ? { flags: [block.visibility] } : undefined,
-    source: {
-      type: "blocknotejs",
-      docJson: block.body
-    },
-    targets
-  };
-}
-function docBlocksToPresentationRoutes(blocks, options) {
-  return blocks.map((block) => ({
-    block,
-    route: deriveRoute(block, options?.routePrefix),
-    descriptor: docBlockToPresentationSpec(block, options)
-  }));
-}
-function docBlocksToPresentationSpecs(blocks, options) {
-  return blocks.map((block) => docBlockToPresentationSpec(block, options));
-}
-function mapDocRoutes(routes) {
-  return routes.map(({ route, descriptor }) => [route, descriptor]);
-}
-
-// src/docs/registry.ts
-class DocRegistry {
-  routes = new Map;
-  constructor(blocks = [], options) {
-    blocks.forEach((block) => this.register(block, options));
-  }
-  register(block, options) {
-    const [route] = docBlocksToPresentationRoutes([block], options);
-    if (route) {
-      this.routes.set(block.id, route);
-    }
-    return this;
-  }
-  list() {
-    return [...this.routes.values()];
-  }
-  get(id) {
-    return this.routes.get(id);
-  }
-  toRouteTuples() {
-    return this.list().map(({ route, descriptor }) => [route, descriptor]);
-  }
-  toPresentationSpecs(options) {
-    return this.list().map(({ block }) => docBlockToPresentationSpec(block, options));
-  }
-}
-var requiredFields = [
-  "id",
-  "title",
-  "body",
-  "kind",
-  "visibility",
-  "route"
-];
-var defaultDocRegistry = new DocRegistry;
-function registerDocBlocks(blocks) {
-  for (const block of blocks) {
-    for (const field of requiredFields) {
-      if (!block[field]) {
-        throw new Error(`DocBlock ${block.id ?? "<missing id>"} missing field ${String(field)}`);
-      }
-    }
-    defaultDocRegistry.register(block);
-  }
-}
-function listRegisteredDocBlocks() {
-  return defaultDocRegistry.list().map((r) => r.block);
-}
-function docId(id) {
-  const found = defaultDocRegistry.get(id);
-  if (!found)
-    throw new Error(`DocBlock not registered: ${id}`);
-  return id;
-}
-
-// src/docs/tech/contracts/ops-to-presentation-linking.docblock.ts
-var tech_contracts_ops_to_presentation_linking_DocBlocks = [
-  {
-    id: "docs.tech.contracts.ops-to-presentation-linking",
-    title: "Ops ↔ Presentation linking (V2)",
-    summary: "This document explains how operations (OperationSpec) are linked to Presentations (PresentationSpec) via Feature modules.",
-    kind: "reference",
-    visibility: "public",
-    route: "/docs/tech/contracts/ops-to-presentation-linking",
-    tags: ["tech", "contracts", "ops-to-presentation-linking"],
-    body: `### Ops ↔ Presentation linking (V2)
-
-This document explains how operations (OperationSpec) are linked to Presentations (PresentationSpec) via Feature modules.
-
-- Location: \`@contractspec/lib.contracts/src/features.ts\`
-- Field: \`FeatureModuleSpec.opToPresentation?: { op: { name; version }; pres: { name; version } }[]\`
-- Validation: \`installFeature()\` validates that linked ops exist in \`OperationSpecRegistry\` and linked presentations exist in the registry, and that declared targets are present.
-
-Example:
-
-\`\`\`ts
-import type { OperationSpecRegistry } from '@contractspec/lib.contracts/src/registry';
-import { FeatureRegistry, createFeatureModule } from '@contractspec/lib.contracts';
-
-export function buildFeaturesWithOps(ops: OperationSpecRegistry) {
-  const features = new FeatureRegistry();
-  features.register(
-    createFeatureModule(
-      {
-        key: 'myapp.widgets.linkage',
-        title: 'Widgets (linked)',
-        description: 'Links create/update ops to UI presentations',
-        domain: 'widgets',
-        tags: ['widgets', 'linkage'],
-        stability: 'beta',
-      },
-      {
-        operations: [
-          { name: 'widgets.create', version: '1.0.0' },
-          { name: 'widgets.update', version: '1.0.0' },
-        ],
-        presentations: [{ name: 'myapp.widgets.editor.page', version: '1.0.0' }],
-        opToPresentation: [
-          {
-            op: { name: 'widgets.create', version: '1.0.0' },
-            pres: { name: 'myapp.widgets.editor.page', version: '1.0.0' },
-          },
-          {
-            op: { name: 'widgets.update', version: '1.0.0' },
-            pres: { name: 'myapp.widgets.editor.page', version: '1.0.0' },
-          },
-        ],
-        presentationsTargets: [
-          {
-            name: 'myapp.widgets.editor.page',
-            version: '1.0.0',
-            targets: ['react', 'markdown'],
-          },
-        ],
-      }
-    )
-  );
-  return { features };
-}
-\`\`\`
-
-Notes
-
-- This enables traceability: the UI flow that realizes an op is discoverable via the feature catalog.
-- Presentations can target multiple outputs (\`react\`, \`markdown\`, \`application/json\`, \`application/xml\`).
-- Use \`renderFeaturePresentation()\` to render a descriptor to a given target with a component map.
-`
-  }
-];
-registerDocBlocks(tech_contracts_ops_to_presentation_linking_DocBlocks);
-export {
-  tech_contracts_ops_to_presentation_linking_DocBlocks
-};

package/dist/node/docs/tech/contracts/overlays.docblock.js

@@ -1,231 +0,0 @@
-import { createRequire } from "node:module";
-var __defProp = Object.defineProperty;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __moduleCache = /* @__PURE__ */ new WeakMap;
-var __toCommonJS = (from) => {
-  var entry = __moduleCache.get(from), desc;
-  if (entry)
-    return entry;
-  entry = __defProp({}, "__esModule", { value: true });
-  if (from && typeof from === "object" || typeof from === "function")
-    __getOwnPropNames(from).map((key) => !__hasOwnProp.call(entry, key) && __defProp(entry, key, {
-      get: () => from[key],
-      enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
-    }));
-  __moduleCache.set(from, entry);
-  return entry;
-};
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, {
-      get: all[name],
-      enumerable: true,
-      configurable: true,
-      set: (newValue) => all[name] = () => newValue
-    });
-};
-var __esm = (fn, res) => () => (fn && (res = fn(fn = 0)), res);
-var __require = /* @__PURE__ */ createRequire(import.meta.url);
-
-// src/docs/presentations.ts
-var DEFAULT_TARGETS = [
-  "markdown",
-  "react"
-];
-function normalizeRoute(route) {
-  if (!route.length)
-    return "/";
-  const withLeading = route.startsWith("/") ? route : `/${route}`;
-  return withLeading === "/" ? "/" : withLeading.replace(/\/+$/, "");
-}
-function deriveRoute(block, routePrefix) {
-  if (block.route)
-    return normalizeRoute(block.route);
-  const prefix = routePrefix ?? "/docs";
-  const slug = block.id.replace(/^docs\.?/, "").replace(/\./g, "/").replace(/\/+/g, "/");
-  const path = slug.startsWith("/") ? slug : `${prefix}/${slug}`;
-  return normalizeRoute(path);
-}
-function buildName(block, namespace) {
-  return namespace ? `${namespace}.${block.id}` : block.id;
-}
-function docBlockToPresentationSpec(block, options) {
-  const targets = options?.defaultTargets ?? DEFAULT_TARGETS;
-  const version = block.version ?? options?.defaultVersion ?? "1.0.0";
-  const stability = block.stability ?? options?.defaultStability ?? "stable";
-  return {
-    meta: {
-      key: buildName(block, options?.namespace),
-      title: block.title,
-      version,
-      description: block.summary ?? block.title,
-      tags: block.tags || [],
-      owners: block.owners || [],
-      domain: block.domain || "",
-      stability,
-      goal: `Documentation of: ${block.summary}`,
-      context: `Auto-generated`
-    },
-    policy: block.visibility && block.visibility !== "public" ? { flags: [block.visibility] } : undefined,
-    source: {
-      type: "blocknotejs",
-      docJson: block.body
-    },
-    targets
-  };
-}
-function docBlocksToPresentationRoutes(blocks, options) {
-  return blocks.map((block) => ({
-    block,
-    route: deriveRoute(block, options?.routePrefix),
-    descriptor: docBlockToPresentationSpec(block, options)
-  }));
-}
-function docBlocksToPresentationSpecs(blocks, options) {
-  return blocks.map((block) => docBlockToPresentationSpec(block, options));
-}
-function mapDocRoutes(routes) {
-  return routes.map(({ route, descriptor }) => [route, descriptor]);
-}
-
-// src/docs/registry.ts
-class DocRegistry {
-  routes = new Map;
-  constructor(blocks = [], options) {
-    blocks.forEach((block) => this.register(block, options));
-  }
-  register(block, options) {
-    const [route] = docBlocksToPresentationRoutes([block], options);
-    if (route) {
-      this.routes.set(block.id, route);
-    }
-    return this;
-  }
-  list() {
-    return [...this.routes.values()];
-  }
-  get(id) {
-    return this.routes.get(id);
-  }
-  toRouteTuples() {
-    return this.list().map(({ route, descriptor }) => [route, descriptor]);
-  }
-  toPresentationSpecs(options) {
-    return this.list().map(({ block }) => docBlockToPresentationSpec(block, options));
-  }
-}
-var requiredFields = [
-  "id",
-  "title",
-  "body",
-  "kind",
-  "visibility",
-  "route"
-];
-var defaultDocRegistry = new DocRegistry;
-function registerDocBlocks(blocks) {
-  for (const block of blocks) {
-    for (const field of requiredFields) {
-      if (!block[field]) {
-        throw new Error(`DocBlock ${block.id ?? "<missing id>"} missing field ${String(field)}`);
-      }
-    }
-    defaultDocRegistry.register(block);
-  }
-}
-function listRegisteredDocBlocks() {
-  return defaultDocRegistry.list().map((r) => r.block);
-}
-function docId(id) {
-  const found = defaultDocRegistry.get(id);
-  if (!found)
-    throw new Error(`DocBlock not registered: ${id}`);
-  return id;
-}
-
-// src/docs/tech/contracts/overlays.docblock.ts
-var tech_contracts_overlays_DocBlocks = [
-  {
-    id: "docs.tech.contracts.overlays",
-    title: "OverlaySpec Implementation",
-    summary: "OverlaySpecs allow tenants/users to adapt presentation without duplicating code. Implementation lives in `@contractspec/lib.overlay-engine`.",
-    kind: "reference",
-    visibility: "public",
-    route: "/docs/tech/contracts/overlays",
-    tags: ["tech", "contracts", "overlays"],
-    body: `# OverlaySpec Implementation
-
-OverlaySpecs allow tenants/users to adapt presentation without duplicating code. Implementation lives in \`@contractspec/lib.overlay-engine\`.
-
-## Structure
-
-\`\`\`ts
-interface OverlaySpec {
-  overlayId: string;
-  version: string;
-  appliesTo: {
-    capability?: string;
-    workflow?: string;
-    dataView?: string;
-    presentation?: string;
-    tenantId?: string;
-    userId?: string;
-    role?: string;
-    device?: string;
-  };
-  modifications: OverlayModification[];
-}
-\`\`\`
-
-Supported modifications:
-
-- \`hideField\`
-- \`renameLabel\`
-- \`reorderFields\`
-- \`setDefault\`
-- \`addHelpText\`
-- \`makeRequired\`
-
-## Signing
-
-Overlays must be signed. Use the signer helper:
-
-\`\`\`ts
-import { signOverlay } from '@contractspec/lib.overlay-engine/signer';
-
-const signed = await signOverlay(overlay, privateKeyPem);
-registry.register(signed);
-\`\`\`
-
-Keys are stored in \`OverlaySigningKey\` (Prisma) and referenced by the \`Overlay\` model for auditing.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-`
-  }
-];
-registerDocBlocks(tech_contracts_overlays_DocBlocks);
-export {
-  tech_contracts_overlays_DocBlocks
-};