patram 0.2.0 → 0.3.0

package/lib/render-output-view.js

@@ -1,9 +1,11 @@
 /** @import * as $k$$l$output$j$view$k$types$k$ts from './output-view.types.ts'; */
+/* eslint-disable max-lines */
 /**
  * @import { BuildGraphResult, GraphNode } from './build-graph.types.ts';
  * @import { DerivedSummaryEvaluator } from './derived-summary.js';
+ * @import { PatramRepoConfig } from './load-patram-config.types.ts';
  * @import { ParsedCliArguments } from './parse-cli-arguments.types.ts';
- * @import { OutputStoredQueryItem, OutputView, ResolvedOutputMode, ShowOutputView } from './output-view.types.ts';
+ * @import { OutputMetadataField, OutputStoredQueryItem, OutputView, ResolvedOutputMode, ShowOutputView } from './output-view.types.ts';
  */
 
 import { renderJsonOutput } from './render-json-output.js';
@@ -30,7 +32,7 @@ import { renderRichOutput } from './render-rich-output.js';
  *
  * @param {'query' | 'queries'} command_name
  * @param {GraphNode[] | { name: string, where: string }[]} command_items
- * @param {{ derived_summary_evaluator?: DerivedSummaryEvaluator, hints?: string[], limit?: number, offset?: number, total_count?: number }=} command_options
+ * @param {{ derived_summary_evaluator?: DerivedSummaryEvaluator, hints?: string[], limit?: number, offset?: number, repo_config?: PatramRepoConfig, total_count?: number }=} command_options
  * @returns {OutputView}
  */
 export function createOutputView(command_name, command_items, command_options) {
@@ -54,7 +56,7 @@ export function createOutputView(command_name, command_items, command_options) {
  * Create a shared output view for the show command.
  *
  * @param {{ path: string, rendered_source: string, resolved_links: Array<{ label: string, reference: number, target: { kind?: string, path: string, status?: string, title: string } }>, source: string }} show_output
- * @param {{ derived_summary_evaluator?: DerivedSummaryEvaluator, graph_nodes?: BuildGraphResult['nodes'] }=} command_options
+ * @param {{ derived_summary_evaluator?: DerivedSummaryEvaluator, graph_nodes?: BuildGraphResult['nodes'], repo_config?: PatramRepoConfig }=} command_options
  * @returns {ShowOutputView}
  */
 export function createShowOutputView(show_output, command_options = {}) {
@@ -69,6 +71,7 @@ export function createShowOutputView(show_output, command_options = {}) {
           command_options.derived_summary_evaluator?.evaluate(
             shown_document_node,
           ) ?? null,
+          command_options.repo_config?.fields ?? {},
         )
       : undefined,
     hints: [],
@@ -78,6 +81,7 @@ export function createShowOutputView(show_output, command_options = {}) {
       reference: resolved_link.reference,
       target: createResolvedLinkTarget(
         resolved_link.target,
+        command_options.repo_config?.fields ?? {},
         command_options.graph_nodes?.[`doc:${resolved_link.target.path}`]
           ? (command_options.derived_summary_evaluator?.evaluate(
               command_options.graph_nodes[`doc:${resolved_link.target.path}`],
@@ -124,7 +128,7 @@ export async function renderOutputView(
 
 /**
  * @param {GraphNode[]} graph_nodes
- * @param {{ derived_summary_evaluator?: DerivedSummaryEvaluator, hints?: string[], limit?: number, offset?: number, total_count?: number }=} command_options
+ * @param {{ derived_summary_evaluator?: DerivedSummaryEvaluator, hints?: string[], limit?: number, offset?: number, repo_config?: PatramRepoConfig, total_count?: number }=} command_options
  * @returns {OutputView}
  */
 function createQueryOutputView(graph_nodes, command_options = {}) {
@@ -134,11 +138,12 @@ function createQueryOutputView(graph_nodes, command_options = {}) {
     command: 'query',
     hints:
       command_options.hints ??
-      (total_count === 0 ? ['Try: patram query --where "kind=task"'] : []),
+      (total_count === 0 ? ['Try: patram query --where "$class=task"'] : []),
     items: graph_nodes.map((graph_node) =>
       createOutputNodeItem(
         graph_node,
         command_options.derived_summary_evaluator?.evaluate(graph_node) ?? null,
+        command_options.repo_config?.fields ?? {},
       ),
     ),
     summary: {
@@ -174,13 +179,17 @@ function createStoredQueriesOutputView(stored_queries) {
 /**
  * @param {GraphNode} graph_node
  * @param {import('./output-view.types.ts').OutputDerivedSummary | null} derived_summary
+ * @param {NonNullable<PatramRepoConfig['fields']>} field_definitions
  * @returns {$k$$l$output$j$view$k$types$k$ts.OutputNodeItem}
  */
-function createOutputNodeItem(graph_node, derived_summary) {
-  const title =
-    graph_node.title ?? graph_node.label ?? graph_node.path ?? graph_node.key;
+function createOutputNodeItem(graph_node, derived_summary, field_definitions) {
+  const title = getOutputNodeTitle(graph_node);
+  const path = getOutputNodePath(graph_node);
+  const node_class = getOutputNodeClass(graph_node);
+  const fields = collectOutputFields(graph_node, field_definitions);
+  const visible_fields = createVisibleOutputFields(fields, field_definitions);
 
-  if (!title || !graph_node.path) {
+  if (!title || !node_class) {
     throw new Error(
       `Expected graph node "${graph_node.id}" to have a title and path.`,
     );
@@ -188,35 +197,247 @@ function createOutputNodeItem(graph_node, derived_summary) {
 
   return {
     derived_summary: derived_summary ?? undefined,
-    id: graph_node.id,
+    fields,
+    id: getOutputNodeId(graph_node),
     kind: 'node',
-    node_kind: graph_node.kind,
-    path: graph_node.path,
-    status: graph_node.status,
+    node_kind: node_class,
+    path,
     title,
+    visible_fields,
   };
 }
 
 /**
  * @param {{ kind?: string, path: string, status?: string, title: string }} target
+ * @param {NonNullable<PatramRepoConfig['fields']>} field_definitions
  * @param {import('./output-view.types.ts').OutputDerivedSummary | null} derived_summary
  * @returns {$k$$l$output$j$view$k$types$k$ts.OutputResolvedLinkTarget}
  */
-function createResolvedLinkTarget(target, derived_summary) {
+function createResolvedLinkTarget(target, field_definitions, derived_summary) {
+  /** @type {Record<string, string | string[]>} */
+  const fields = {};
+
+  if (target.status) {
+    fields.status = target.status;
+  }
+
   /** @type {$k$$l$output$j$view$k$types$k$ts.OutputResolvedLinkTarget} */
   const resolved_target = {
     derived_summary: derived_summary ?? undefined,
+    fields,
+    id: `doc:${target.path}`,
+    kind: target.kind ?? 'document',
     path: target.path,
     title: target.title,
+    visible_fields: createVisibleOutputFields(fields, field_definitions),
   };
 
-  if (target.kind && target.kind !== 'document') {
-    resolved_target.kind = target.kind;
+  return resolved_target;
+}
+
+/**
+ * @param {string | string[] | undefined} field_value
+ * @returns {string | undefined}
+ */
+function getScalarGraphNodeField(field_value) {
+  if (Array.isArray(field_value)) {
+    return field_value[0];
   }
 
-  if (target.status) {
-    resolved_target.status = target.status;
+  return field_value;
+}
+
+/**
+ * @param {GraphNode} graph_node
+ * @returns {string | undefined}
+ */
+function getOutputNodeTitle(graph_node) {
+  return (
+    getScalarGraphNodeField(graph_node.title) ??
+    getScalarGraphNodeField(graph_node.label) ??
+    getOutputNodePath(graph_node) ??
+    getScalarGraphNodeField(graph_node.key)
+  );
+}
+
+/**
+ * @param {GraphNode} graph_node
+ * @returns {string | undefined}
+ */
+function getOutputNodePath(graph_node) {
+  return getScalarGraphNodeField(graph_node.$path ?? graph_node.path);
+}
+
+/**
+ * @param {GraphNode} graph_node
+ * @returns {string | undefined}
+ */
+function getOutputNodeClass(graph_node) {
+  return getScalarGraphNodeField(graph_node.$class ?? graph_node.kind);
+}
+
+/**
+ * @param {GraphNode} graph_node
+ * @returns {string}
+ */
+function getOutputNodeId(graph_node) {
+  return (
+    getScalarGraphNodeField(graph_node.$id ?? graph_node.id) ?? graph_node.id
+  );
+}
+
+/**
+ * @param {GraphNode} graph_node
+ * @param {NonNullable<PatramRepoConfig['fields']>} field_definitions
+ * @returns {Record<string, string | string[]>}
+ */
+function collectOutputFields(graph_node, field_definitions) {
+  /** @type {Record<string, string | string[]>} */
+  const fields = {};
+
+  for (const [field_name, field_value] of Object.entries(graph_node)) {
+    const normalized_value = getCollectedOutputFieldValue(
+      graph_node,
+      field_name,
+      field_value,
+    );
+
+    if (normalized_value === undefined) {
+      continue;
+    }
+
+    fields[field_name] = normalized_value;
   }
 
-  return resolved_target;
+  for (const field_name of Object.keys(field_definitions)) {
+    if (fields[field_name] !== undefined) {
+      continue;
+    }
+
+    const field_value = normalizeOutputFieldValue(graph_node[field_name]);
+
+    if (field_value !== undefined) {
+      fields[field_name] = field_value;
+    }
+  }
+
+  return fields;
+}
+
+/**
+ * @param {GraphNode} graph_node
+ * @param {string} field_name
+ * @param {unknown} field_value
+ * @returns {string | string[] | undefined}
+ */
+function getCollectedOutputFieldValue(graph_node, field_name, field_value) {
+  if (isInternalOutputField(field_name)) {
+    return undefined;
+  }
+
+  const normalized_value = normalizeOutputFieldValue(field_value);
+
+  if (normalized_value === undefined) {
+    return undefined;
+  }
+
+  if (isLegacyMirrorOutputField(graph_node, field_name, normalized_value)) {
+    return undefined;
+  }
+
+  return normalized_value;
+}
+
+/**
+ * @param {GraphNode} graph_node
+ * @param {string} field_name
+ * @param {string | string[]} normalized_value
+ * @returns {boolean}
+ */
+function isLegacyMirrorOutputField(graph_node, field_name, normalized_value) {
+  if (Array.isArray(normalized_value)) {
+    return false;
+  }
+
+  if (field_name === 'kind') {
+    return normalized_value === graph_node.$class;
+  }
+
+  if (field_name === 'path') {
+    return normalized_value === graph_node.$path;
+  }
+
+  if (field_name === 'id') {
+    return normalized_value === graph_node.$id;
+  }
+
+  return false;
+}
+
+/**
+ * @param {Record<string, string | string[]>} fields
+ * @param {NonNullable<PatramRepoConfig['fields']>} field_definitions
+ * @returns {OutputMetadataField[]}
+ */
+function createVisibleOutputFields(fields, field_definitions) {
+  return Object.entries(fields)
+    .filter(
+      ([field_name]) => field_definitions[field_name]?.display?.hidden !== true,
+    )
+    .sort(([left_name], [right_name]) =>
+      compareOutputFieldNames(left_name, right_name, field_definitions),
+    )
+    .map(([name, value]) => ({ name, value }));
+}
+
+/**
+ * @param {string} field_name
+ * @returns {boolean}
+ */
+function isInternalOutputField(field_name) {
+  return (
+    field_name === '$class' ||
+    field_name === '$id' ||
+    field_name === '$path' ||
+    field_name === 'id' ||
+    field_name === 'key' ||
+    field_name === 'label' ||
+    field_name === 'path' ||
+    field_name === 'title'
+  );
+}
+
+/**
+ * @param {string} left_name
+ * @param {string} right_name
+ * @param {NonNullable<PatramRepoConfig['fields']>} field_definitions
+ * @returns {number}
+ */
+function compareOutputFieldNames(left_name, right_name, field_definitions) {
+  const left_order =
+    field_definitions[left_name]?.display?.order ?? Number.MAX_SAFE_INTEGER;
+  const right_order =
+    field_definitions[right_name]?.display?.order ?? Number.MAX_SAFE_INTEGER;
+
+  if (left_order !== right_order) {
+    return left_order - right_order;
+  }
+
+  return left_name.localeCompare(right_name, 'en');
+}
+
+/**
+ * @param {unknown} field_value
+ * @returns {string | string[] | undefined}
+ */
+function normalizeOutputFieldValue(field_value) {
+  if (Array.isArray(field_value)) {
+    const string_values = field_value.flatMap((value) =>
+      typeof value === 'string' ? [value] : [],
+    );
+
+    return string_values.length > 0 ? string_values : undefined;
+  }
+
+  return typeof field_value === 'string' ? field_value : undefined;
 }

package/lib/render-plain-output.js

@@ -128,7 +128,7 @@ function formatPlainStoredQueryLine(line_segments) {
  */
 function formatPlainResolvedLinkItem(output_item) {
   return formatOutputItemBlock({
-    header: `[${output_item.reference}] document ${output_item.target.path}`,
+    header: `[${output_item.reference}] ${output_item.target.kind} ${output_item.target.path ?? output_item.target.id}`,
     metadata_rows: formatResolvedLinkMetadataRows(output_item.target),
     metadata_indent: '    ',
     title: output_item.target.title,

package/lib/render-rich-output.js

@@ -155,7 +155,7 @@ function formatRichStoredQueryLine(line_segments, ansi) {
  */
 function formatRichResolvedLinkItem(output_item, ansi) {
   return formatOutputItemBlock({
-    header: `${ansi.gray(`[${output_item.reference}]`)} ${ansi.green(`document ${output_item.target.path}`)}`,
+    header: `${ansi.gray(`[${output_item.reference}]`)} ${ansi.green(`${output_item.target.kind} ${output_item.target.path ?? output_item.target.id}`)}`,
     metadata_rows: formatResolvedLinkMetadataRows(output_item.target),
     metadata_indent: '    ',
     title: output_item.target.title,

package/lib/resolve-patram-graph-config.js

@@ -21,7 +21,7 @@ import { parsePatramConfig } from './patram-config.js';
  */
 
 const BUILT_IN_PATRAM_CONFIG = {
-  kinds: {
+  classes: {
     document: {
       builtin: true,
       label: 'Document',
@@ -30,28 +30,28 @@ const BUILT_IN_PATRAM_CONFIG = {
   mappings: {
     'document.title': {
       node: {
+        class: 'document',
         field: 'title',
-        kind: 'document',
       },
     },
     'document.description': {
       node: {
+        class: 'document',
         field: 'description',
-        kind: 'document',
       },
     },
     'jsdoc.link': {
       emit: {
         relation: 'links_to',
         target: 'path',
-        target_kind: 'document',
+        target_class: 'document',
       },
     },
     'markdown.link': {
       emit: {
         relation: 'links_to',
         target: 'path',
-        target_kind: 'document',
+        target_class: 'document',
       },
     },
   },
@@ -71,10 +71,10 @@ const BUILT_IN_PATRAM_CONFIG = {
  * @returns {PatramConfig}
  */
 export function resolvePatramGraphConfig(repo_config) {
-  return parsePatramConfig({
-    kinds: {
-      ...BUILT_IN_PATRAM_CONFIG.kinds,
-      ...repo_config.kinds,
+  const graph_config = parsePatramConfig({
+    classes: {
+      ...BUILT_IN_PATRAM_CONFIG.classes,
+      ...repo_config.classes,
     },
     mappings: {
       ...BUILT_IN_PATRAM_CONFIG.mappings,
@@ -85,4 +85,10 @@ export function resolvePatramGraphConfig(repo_config) {
       ...repo_config.relations,
     },
   });
+
+  return {
+    ...graph_config,
+    class_schemas: repo_config.class_schemas,
+    fields: repo_config.fields,
+  };
 }

package/lib/show-document.js

@@ -212,17 +212,15 @@ function createResolvedLinkSummary(
     claim_value.target,
   );
   const target_node = graph_nodes[`doc:${target_path}`];
-  const target_title = target_node?.title ?? claim_value.text;
 
   return {
     label: claim_value.text,
     reference,
-    target: {
-      kind: target_node?.kind,
-      path: target_node?.path ?? target_path,
-      status: target_node?.status,
-      title: target_title,
-    },
+    target: createResolvedLinkTarget(
+      target_node,
+      target_path,
+      claim_value.text,
+    ),
   };
 }
 
@@ -239,6 +237,52 @@ function resolveShowTargetPath(source_file_path, raw_target) {
   return normalizeRepoRelativePath(posix.join(source_directory, raw_target));
 }
 
+/**
+ * @param {string | string[] | undefined} field_value
+ * @returns {string | undefined}
+ */
+function getScalarGraphField(field_value) {
+  if (Array.isArray(field_value)) {
+    return field_value[0];
+  }
+
+  return field_value;
+}
+
+/**
+ * @param {GraphNode | undefined} target_node
+ * @param {string} target_path
+ * @param {string} fallback_title
+ * @returns {{ kind?: string, path: string, status?: string, title: string }}
+ */
+function createResolvedLinkTarget(target_node, target_path, fallback_title) {
+  return {
+    kind: getResolvedLinkTargetKind(target_node),
+    path: getResolvedLinkTargetPath(target_node, target_path),
+    status: getScalarGraphField(target_node?.status),
+    title: getScalarGraphField(target_node?.title) ?? fallback_title,
+  };
+}
+
+/**
+ * @param {GraphNode | undefined} target_node
+ * @returns {string | undefined}
+ */
+function getResolvedLinkTargetKind(target_node) {
+  return getScalarGraphField(target_node?.$class ?? target_node?.kind);
+}
+
+/**
+ * @param {GraphNode | undefined} target_node
+ * @param {string} target_path
+ * @returns {string}
+ */
+function getResolvedLinkTargetPath(target_node, target_path) {
+  return (
+    getScalarGraphField(target_node?.$path ?? target_node?.path) ?? target_path
+  );
+}
+
 /**
  * @param {PatramClaim} claim
  * @returns {claim is PatramClaim & { type: 'markdown.link', value: { target: string, text: string } }}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "patram",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "type": "module",
   "main": "./lib/patram.js",
   "exports": {
@@ -65,8 +65,8 @@
   "devDependencies": {
     "@eslint/js": "^10.0.1",
     "@types/node": "^24.12.0",
-    "@vitest/coverage-v8": "^4.1.0",
-    "eslint": "^10.0.3",
+    "@vitest/coverage-v8": "^4.1.1",
+    "eslint": "^10.1.0",
     "eslint-plugin-jsdoc": "^62.8.0",
     "globals": "^17.4.0",
     "husky": "^9.1.7",
@@ -74,7 +74,7 @@
     "lint-staged": "^16.2.6",
     "prettier": "^3.5.3",
     "slice-ansi": "^8.0.0",
-    "typescript": "^5.8.2",
-    "vitest": "^4.1.0"
+    "typescript": "^6.0.2",
+    "vitest": "^4.1.1"
   }
 }