@contractspec/lib.contracts-spec 2.0.0

package/dist/node/resources.js

@@ -0,0 +1,83 @@
+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/resources.ts
+function defineResourceTemplate(spec) {
+  return spec;
+}
+
+class ResourceRegistry {
+  templates = [];
+  register(tmpl) {
+    this.templates.push(tmpl);
+    return this;
+  }
+  listTemplates() {
+    return [...this.templates];
+  }
+  match(uri) {
+    for (const tmpl of this.templates) {
+      const re = new RegExp("^" + tmpl.meta.uriTemplate.replace(/\{[^}]+\}/g, "([^/]+)") + "$");
+      const m = uri.match(re);
+      if (!m)
+        continue;
+      const names = [...tmpl.meta.uriTemplate.matchAll(/\{([^}]+)\}/g)].map((x) => x[1]);
+      const params = {};
+      names.forEach((n, i) => {
+        const val = m[i + 1];
+        if (n && val) {
+          params[n] = decodeURIComponent(val);
+        }
+      });
+      return { tmpl, params };
+    }
+    return;
+  }
+}
+function resourceRef(uriTemplate, opts) {
+  return {
+    kind: "resource_ref",
+    uriTemplate,
+    varName: opts.varName ?? "id",
+    graphQLType: opts.graphQLType,
+    many: opts.many
+  };
+}
+function isResourceRef(x) {
+  const o = x;
+  return !!o && o.kind === "resource_ref" && typeof o.uriTemplate === "string";
+}
+export {
+  resourceRef,
+  isResourceRef,
+  defineResourceTemplate,
+  ResourceRegistry
+};

package/dist/node/schema-to-markdown.js

@@ -0,0 +1,278 @@
+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/schema-to-markdown.ts
+import { isSchemaModel } from "@contractspec/lib.schema/SchemaModel";
+function schemaToMarkdown(schema, data, options = {}) {
+  const { format = "auto", title, description, maxDepth = 2 } = options;
+  const lines = [];
+  if (title) {
+    lines.push(`# ${title}`, "");
+  }
+  if (description) {
+    lines.push(`> ${description}`, "");
+  }
+  const effectiveFormat = format === "auto" ? Array.isArray(data) ? "table" : "detail" : format;
+  if (effectiveFormat === "table" && Array.isArray(data)) {
+    lines.push(schemaToMarkdownTable(schema, data, options));
+  } else if (effectiveFormat === "list" && Array.isArray(data)) {
+    lines.push(schemaToMarkdownList(schema, data, options));
+  } else if (!Array.isArray(data) && data !== null && typeof data === "object") {
+    lines.push(schemaToMarkdownDetail(schema, data, { ...options, maxDepth }));
+  } else {
+    lines.push(`**Data:** ${String(data)}`, "");
+  }
+  return lines.join(`
+`);
+}
+function schemaToMarkdownTable(schema, items, options = {}) {
+  const { maxItems = 100, includeFields, excludeFields = [] } = options;
+  const fields = getFieldMeta(schema, includeFields, excludeFields);
+  if (fields.length === 0 || items.length === 0) {
+    return `_No data available_
+`;
+  }
+  const limitedItems = items.slice(0, maxItems);
+  const lines = [];
+  const headers = fields.map((f) => f.label);
+  lines.push(`| ${headers.join(" | ")} |`);
+  lines.push(`| ${headers.map(() => "---").join(" | ")} |`);
+  for (const item of limitedItems) {
+    const row = fields.map((f) => formatCellValue(getFieldValue(item, f.name)));
+    lines.push(`| ${row.join(" | ")} |`);
+  }
+  if (items.length > maxItems) {
+    lines.push("", `_Showing ${maxItems} of ${items.length} items_`);
+  }
+  lines.push("");
+  return lines.join(`
+`);
+}
+function schemaToMarkdownList(schema, items, options = {}) {
+  const {
+    maxItems = 50,
+    summaryFields,
+    includeFields,
+    excludeFields = []
+  } = options;
+  const fields = getFieldMeta(schema, includeFields, excludeFields);
+  const displayFields = summaryFields ? fields.filter((f) => summaryFields.includes(f.name)) : fields.slice(0, 3);
+  if (displayFields.length === 0 || items.length === 0) {
+    return `_No data available_
+`;
+  }
+  const limitedItems = items.slice(0, maxItems);
+  const lines = [];
+  for (const item of limitedItems) {
+    const primaryValue = formatCellValue(getFieldValue(item, displayFields[0]?.name ?? "id"));
+    const secondaryValues = displayFields.slice(1).map((f) => `${f.label}: ${formatCellValue(getFieldValue(item, f.name))}`).join(" · ");
+    const itemLine = secondaryValues ? `- **${primaryValue}** (${secondaryValues})` : `- **${primaryValue}**`;
+    lines.push(itemLine);
+  }
+  if (items.length > maxItems) {
+    lines.push("", `_Showing ${maxItems} of ${items.length} items_`);
+  }
+  lines.push("");
+  return lines.join(`
+`);
+}
+function schemaToMarkdownDetail(schema, item, options = {}) {
+  const { includeFields, excludeFields = [], maxDepth = 2 } = options;
+  if (item === null || typeof item !== "object") {
+    return `_No data available_
+`;
+  }
+  const fields = getFieldMeta(schema, includeFields, excludeFields);
+  if (fields.length === 0) {
+    return `_No fields to display_
+`;
+  }
+  const lines = [];
+  for (const field of fields) {
+    const value = getFieldValue(item, field.name);
+    const formattedValue = formatDetailValue(value, maxDepth, 0);
+    lines.push(`**${field.label}:** ${formattedValue}`);
+  }
+  lines.push("");
+  return lines.join(`
+`);
+}
+function schemaToMarkdownSummary(items, options = {}) {
+  const { numericFields = [], countByField } = options;
+  const lines = [];
+  lines.push(`**Total Items:** ${items.length}`);
+  for (const fieldName of numericFields) {
+    const values = items.map((item) => getFieldValue(item, fieldName)).filter((v) => typeof v === "number");
+    if (values.length > 0) {
+      const sum = values.reduce((a, b) => a + b, 0);
+      const avg = sum / values.length;
+      const min = Math.min(...values);
+      const max = Math.max(...values);
+      lines.push(`**${formatFieldName(fieldName)}:** Sum: ${formatNumber(sum)}, Avg: ${formatNumber(avg)}, Min: ${formatNumber(min)}, Max: ${formatNumber(max)}`);
+    }
+  }
+  if (countByField) {
+    const counts = {};
+    for (const item of items) {
+      const value = String(getFieldValue(item, countByField) ?? "Unknown");
+      counts[value] = (counts[value] ?? 0) + 1;
+    }
+    lines.push("", `**By ${formatFieldName(countByField)}:**`);
+    for (const [value, count] of Object.entries(counts)) {
+      lines.push(`- ${value}: ${count}`);
+    }
+  }
+  lines.push("");
+  return lines.join(`
+`);
+}
+function getFieldMeta(schema, includeFields, excludeFields = []) {
+  if (!isSchemaModel(schema)) {
+    return [];
+  }
+  const schemaFields = schema.config.fields;
+  const fieldNames = Object.keys(schemaFields);
+  const filteredFields = fieldNames.filter((name) => {
+    if (excludeFields.includes(name))
+      return false;
+    if (includeFields && !includeFields.includes(name))
+      return false;
+    return true;
+  });
+  return filteredFields.map((name) => {
+    const fieldConfig = schemaFields[name];
+    const isNested = Boolean(fieldConfig?.type && typeof fieldConfig.type === "object" && "config" in fieldConfig.type && typeof fieldConfig.type.config?.fields === "object");
+    return {
+      name,
+      label: formatFieldName(name),
+      isOptional: fieldConfig?.isOptional ?? false,
+      isArray: fieldConfig?.isArray === true,
+      isNested
+    };
+  });
+}
+function getFieldValue(item, fieldName) {
+  if (item === null || typeof item !== "object")
+    return;
+  const obj = item;
+  if (fieldName.includes(".")) {
+    const parts = fieldName.split(".");
+    let current = obj;
+    for (const part of parts) {
+      if (current === null || typeof current !== "object")
+        return;
+      current = current[part];
+    }
+    return current;
+  }
+  return obj[fieldName];
+}
+function formatCellValue(value) {
+  if (value === null || value === undefined)
+    return "-";
+  if (typeof value === "boolean")
+    return value ? "✓" : "✗";
+  if (typeof value === "number")
+    return formatNumber(value);
+  if (value instanceof Date)
+    return formatDate(value);
+  if (typeof value === "string" && isISODate(value))
+    return formatDate(new Date(value));
+  if (Array.isArray(value))
+    return `[${value.length} items]`;
+  if (typeof value === "object")
+    return "[Object]";
+  const str = String(value);
+  return str.length > 50 ? `${str.slice(0, 47)}...` : str.replace(/\|/g, "\\|");
+}
+function formatDetailValue(value, maxDepth, currentDepth) {
+  if (value === null || value === undefined)
+    return "_none_";
+  if (typeof value === "boolean")
+    return value ? "Yes" : "No";
+  if (typeof value === "number")
+    return formatNumber(value);
+  if (value instanceof Date)
+    return formatDate(value);
+  if (typeof value === "string" && isISODate(value))
+    return formatDate(new Date(value));
+  if (Array.isArray(value)) {
+    if (value.length === 0)
+      return "_empty list_";
+    if (currentDepth >= maxDepth)
+      return `[${value.length} items]`;
+    if (value.length <= 5 && value.every((v) => typeof v !== "object")) {
+      return value.map((v) => formatCellValue(v)).join(", ");
+    }
+    return `[${value.length} items]`;
+  }
+  if (typeof value === "object") {
+    if (currentDepth >= maxDepth)
+      return "[Object]";
+    const keys = Object.keys(value);
+    return `{${keys.length} fields}`;
+  }
+  return String(value);
+}
+function formatFieldName(name) {
+  return name.replace(/([a-z])([A-Z])/g, "$1 $2").replace(/_/g, " ").replace(/^\w/, (c) => c.toUpperCase());
+}
+function formatNumber(value) {
+  if (Math.abs(value) >= 1000) {
+    return new Intl.NumberFormat("en-US", {
+      maximumFractionDigits: 2
+    }).format(value);
+  }
+  if (Number.isInteger(value)) {
+    return String(value);
+  }
+  return value.toFixed(2);
+}
+function formatDate(date) {
+  return date.toLocaleDateString("en-US", {
+    year: "numeric",
+    month: "short",
+    day: "numeric"
+  });
+}
+function isISODate(str) {
+  if (!/^\d{4}-\d{2}-\d{2}/.test(str))
+    return false;
+  const date = new Date(str);
+  return !isNaN(date.getTime());
+}
+export {
+  schemaToMarkdownTable,
+  schemaToMarkdownSummary,
+  schemaToMarkdownList,
+  schemaToMarkdownDetail,
+  schemaToMarkdown
+};

package/dist/node/serialization/index.js

@@ -0,0 +1,179 @@
+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/serialization/serializers.ts
+function isResourceRefDescriptor(value) {
+  return typeof value === "object" && value !== null && "kind" in value && value.kind === "resource_ref";
+}
+function getTypeName(type) {
+  if (!type)
+    return "unknown";
+  if (typeof type === "string")
+    return type;
+  if (typeof type === "object") {
+    if ("config" in type && type.config?.name) {
+      return type.config.name;
+    }
+    if ("name" in type && typeof type.name === "string") {
+      return type.name;
+    }
+  }
+  return "unknown";
+}
+function serializeSchemaModel(model) {
+  if (!model)
+    return null;
+  if (isResourceRefDescriptor(model)) {
+    return {
+      name: `ResourceRef<${model.graphQLType}>`,
+      description: `Reference to ${model.graphQLType} resource (${model.uriTemplate})`,
+      fields: {}
+    };
+  }
+  if ("config" in model && model.config) {
+    const config = model.config;
+    return {
+      name: config.name,
+      description: config.description,
+      fields: Object.fromEntries(Object.entries(config.fields).map(([key, field]) => [
+        key,
+        {
+          typeName: getTypeName(field.type),
+          isOptional: field.isOptional,
+          isArray: field.isArray
+        }
+      ]))
+    };
+  }
+  return {
+    name: "unknown",
+    fields: {}
+  };
+}
+function serializeOperationSpec(spec) {
+  if (!spec)
+    return null;
+  return {
+    meta: {
+      key: spec.meta.key,
+      version: spec.meta.version,
+      stability: spec.meta.stability,
+      owners: spec.meta.owners,
+      tags: spec.meta.tags,
+      description: spec.meta.description,
+      goal: spec.meta.goal,
+      context: spec.meta.context
+    },
+    io: {
+      input: serializeSchemaModel(spec.io.input),
+      output: serializeSchemaModel(spec.io.output)
+    },
+    policy: spec.policy ? { auth: spec.policy.auth } : undefined
+  };
+}
+function serializeEventSpec(spec) {
+  if (!spec)
+    return null;
+  return {
+    meta: {
+      key: spec.meta.key,
+      version: spec.meta.version,
+      stability: spec.meta.stability,
+      owners: spec.meta.owners,
+      tags: spec.meta.tags,
+      description: spec.meta.description
+    },
+    payload: serializeSchemaModel(spec.payload)
+  };
+}
+function serializePresentationSpec(spec) {
+  if (!spec)
+    return null;
+  return {
+    meta: {
+      key: spec.meta.key,
+      version: spec.meta.version,
+      stability: spec.meta.stability,
+      owners: spec.meta.owners,
+      tags: spec.meta.tags,
+      description: spec.meta.description,
+      goal: spec.meta.goal,
+      context: spec.meta.context
+    },
+    source: {
+      type: spec.source.type,
+      framework: spec.source.type === "component" ? spec.source.framework : undefined,
+      componentKey: spec.source.type === "component" ? spec.source.componentKey : undefined
+    },
+    targets: spec.targets
+  };
+}
+function serializeDataViewSpec(spec) {
+  if (!spec)
+    return null;
+  return {
+    meta: {
+      key: spec.meta.key,
+      version: spec.meta.version,
+      stability: spec.meta.stability,
+      owners: spec.meta.owners,
+      tags: spec.meta.tags,
+      description: spec.meta.description,
+      title: spec.meta.title
+    },
+    source: spec.source,
+    view: spec.view
+  };
+}
+function serializeFormSpec(spec) {
+  if (!spec)
+    return null;
+  return {
+    meta: {
+      key: spec.meta.key,
+      version: spec.meta.version,
+      stability: spec.meta.stability,
+      owners: spec.meta.owners,
+      tags: spec.meta.tags,
+      description: spec.meta.description,
+      title: spec.meta.title
+    },
+    fields: spec.fields,
+    actions: spec.actions
+  };
+}
+export {
+  serializeSchemaModel,
+  serializePresentationSpec,
+  serializeOperationSpec,
+  serializeFormSpec,
+  serializeEventSpec,
+  serializeDataViewSpec
+};