patram 0.3.0 → 0.4.0

package/lib/query-inspection.js

@@ -1,10 +1,9 @@
-/** @import * as $k$$l$parse$j$where$j$clause$k$types$k$ts from './parse-where-clause.types.ts'; */
 /* eslint-disable max-lines */
 /**
  * @import { PatramDiagnostic, PatramRepoConfig } from './load-patram-config.types.ts';
  * @import { ResolvedOutputMode } from './output-view.types.ts';
  * @import {
- *   ParsedClause,
+ *   ParsedExpression,
  *   ParsedRelationTargetTerm,
  *   ParsedRelationTerm,
  *   ParsedTerm,
@@ -38,10 +37,10 @@ import { parseWhereClause } from './parse-where-clause.js';
  *     limit: number | null,
  *     offset: number,
  *   },
+ *   expression?: ParsedExpression,
  *   inspection_mode: 'explain' | 'lint',
  *   query_source: QuerySource,
  *   where_clause: string,
- *   clauses?: ParsedClause[],
  * }} QueryInspectionSuccess
  */
 
@@ -75,7 +74,7 @@ export function inspectQuery(
   const diagnostics = getQuerySemanticDiagnostics(
     repo_config,
     resolved_where_clause.query_source,
-    parse_result.clauses,
+    parse_result.expression,
   );
 
   if (diagnostics.length > 0) {
@@ -99,11 +98,11 @@ export function inspectQuery(
   return {
     success: true,
     value: {
-      clauses: parse_result.clauses,
       execution: {
         limit: inspection_options.limit,
         offset: inspection_options.offset,
       },
+      expression: parse_result.expression,
       inspection_mode: 'explain',
       query_source: resolved_where_clause.query_source,
       where_clause: resolved_where_clause.where_clause,
@@ -143,20 +142,26 @@ export function renderQueryInspection(query_inspection, output_mode) {
 }
 
 /**
+ * Collect schema-aware diagnostics for one parsed where clause.
+ *
  * @param {PatramRepoConfig} repo_config
  * @param {QuerySource} query_source
- * @param {ParsedClause[]} clauses
+ * @param {ParsedExpression} expression
  * @returns {PatramDiagnostic[]}
  */
-function collectSemanticDiagnostics(repo_config, query_source, clauses) {
+export function getQuerySemanticDiagnostics(
+  repo_config,
+  query_source,
+  expression,
+) {
   const known_relation_names = new Set(
     Object.keys(repo_config.relations ?? {}),
   );
   /** @type {PatramDiagnostic[]} */
   const diagnostics = [];
 
-  collectClauseDiagnostics(
-    clauses,
+  collectExpressionDiagnostics(
+    expression,
     diagnostics,
     known_relation_names,
     repo_config.fields ?? {},
@@ -167,44 +172,58 @@ function collectSemanticDiagnostics(repo_config, query_source, clauses) {
 }
 
 /**
- * Collect schema-aware diagnostics for one parsed where clause.
- *
- * @param {PatramRepoConfig} repo_config
- * @param {QuerySource} query_source
- * @param {ParsedClause[]} clauses
- * @returns {PatramDiagnostic[]}
- */
-export function getQuerySemanticDiagnostics(
-  repo_config,
-  query_source,
-  clauses,
-) {
-  return collectSemanticDiagnostics(repo_config, query_source, clauses);
-}
-
-/**
- * @param {ParsedClause[]} clauses
+ * @param {ParsedExpression} expression
  * @param {PatramDiagnostic[]} diagnostics
  * @param {Set<string>} known_relation_names
  * @param {Record<string, import('./load-patram-config.types.ts').MetadataFieldConfig>} known_field_definitions
  * @param {string} diagnostic_path
  */
-function collectClauseDiagnostics(
-  clauses,
+function collectExpressionDiagnostics(
+  expression,
   diagnostics,
   known_relation_names,
   known_field_definitions,
   diagnostic_path,
 ) {
-  for (const clause of clauses) {
+  if (expression.kind === 'and' || expression.kind === 'or') {
+    for (const subexpression of expression.expressions) {
+      collectExpressionDiagnostics(
+        subexpression,
+        diagnostics,
+        known_relation_names,
+        known_field_definitions,
+        diagnostic_path,
+      );
+    }
+
+    return;
+  }
+
+  if (expression.kind === 'not') {
+    collectExpressionDiagnostics(
+      expression.expression,
+      diagnostics,
+      known_relation_names,
+      known_field_definitions,
+      diagnostic_path,
+    );
+
+    return;
+  }
+
+  if (expression.kind === 'term') {
     collectTermDiagnostics(
-      clause.term,
+      expression.term,
       diagnostics,
       known_relation_names,
       known_field_definitions,
       diagnostic_path,
     );
+
+    return;
   }
+
+  throw new Error('Unsupported query inspection expression.');
 }
 
 /**
@@ -228,8 +247,8 @@ function collectTermDiagnostics(
       known_relation_names,
       diagnostic_path,
     );
-    collectClauseDiagnostics(
-      term.clauses,
+    collectExpressionDiagnostics(
+      term.expression,
       diagnostics,
       known_relation_names,
       known_field_definitions,
@@ -577,9 +596,9 @@ function formatJsonQueryInspection(query_inspection) {
   }
 
   return {
-    clauses: query_inspection.clauses,
     diagnostics: [],
     execution: query_inspection.execution,
+    expression: query_inspection.expression,
     mode: 'explain',
     source: query_inspection.query_source,
     where: query_inspection.where_clause,
@@ -625,9 +644,12 @@ function renderTextQueryInspection(query_inspection, render_options) {
         : String(query_inspection.execution?.limit ?? ''),
     ),
     '',
-    `${render_options.label('clauses:')}`,
-    ...formatExplainClauseBlock(
-      query_inspection.clauses ?? [],
+    `${render_options.label('expression:')}`,
+    ...formatExplainExpressionBlock(
+      query_inspection.expression ?? {
+        expressions: [],
+        kind: 'and',
+      },
       render_options,
       '',
     ),
@@ -637,42 +659,49 @@ function renderTextQueryInspection(query_inspection, render_options) {
 }
 
 /**
- * @param {ParsedClause[]} clauses
+ * @param {ParsedExpression} expression
  * @param {{ header: (value: string) => string, label: (value: string) => string }} render_options
  * @param {string} indentation
  * @returns {string[]}
  */
-function formatExplainClauseBlock(clauses, render_options, indentation) {
-  /** @type {string[]} */
-  const output_lines = [];
+function formatExplainExpressionBlock(expression, render_options, indentation) {
+  if (expression.kind === 'and') {
+    return formatExplainExpressionItems(
+      expression.expressions,
+      render_options,
+      indentation,
+    );
+  }
 
-  clauses.forEach((clause, clause_index) => {
-    const clause_number = clause_index + 1;
-    const clause_text = formatClauseSummary(clause);
+  return formatExplainExpressionItems(
+    [expression],
+    render_options,
+    indentation,
+  );
+}
 
-    output_lines.push(`${indentation}${clause_number}. ${clause_text}`);
+/**
+ * @param {ParsedExpression[]} expressions
+ * @param {{ header: (value: string) => string, label: (value: string) => string }} render_options
+ * @param {string} indentation
+ * @returns {string[]}
+ */
+function formatExplainExpressionItems(
+  expressions,
+  render_options,
+  indentation,
+) {
+  /** @type {string[]} */
+  const output_lines = [];
 
-    if (clause.term.kind !== 'aggregate') {
-      return;
-    }
+  expressions.forEach((expression, expression_index) => {
+    const expression_number = expression_index + 1;
 
     output_lines.push(
-      `${indentation}   ${render_options.label('traversal:')} ${formatTraversal(clause.term.traversal)}`,
+      `${indentation}${expression_number}. ${formatExpressionSummary(expression)}`,
     );
-
-    if (clause.term.aggregate_name === 'count') {
-      output_lines.push(
-        `${indentation}   ${render_options.label('comparison:')} ${clause.term.comparison} ${clause.term.value}`,
-      );
-    }
-
     output_lines.push(
-      `${indentation}   ${render_options.label('nested clauses:')}`,
-      ...formatExplainClauseBlock(
-        clause.term.clauses,
-        render_options,
-        `${indentation}     `,
-      ),
+      ...formatExpressionDetailLines(expression, render_options, indentation),
     );
   });
 
@@ -680,17 +709,89 @@ function formatExplainClauseBlock(clauses, render_options, indentation) {
 }
 
 /**
- * @param {ParsedClause} clause
+ * @param {ParsedExpression} expression
  * @returns {string}
  */
-function formatClauseSummary(clause) {
-  const clause_prefix = clause.is_negated ? 'not ' : '';
+function formatExpressionSummary(expression) {
+  if (expression.kind === 'and') {
+    return 'all of';
+  }
 
-  if (clause.term.kind === 'aggregate') {
-    return `${clause_prefix}aggregate ${clause.term.aggregate_name}`;
+  if (expression.kind === 'or') {
+    return 'any of';
   }
 
-  return `${clause_prefix}${formatTermSummary(clause.term)}`;
+  if (expression.kind === 'not') {
+    if (expression.expression.kind === 'term') {
+      return `not ${formatTermSummary(expression.expression.term)}`;
+    }
+
+    return 'not';
+  }
+
+  if (expression.kind === 'term') {
+    return formatTermSummary(expression.term);
+  }
+
+  throw new Error('Unsupported explain expression.');
+}
+
+/**
+ * @param {ParsedExpression} expression
+ * @param {{ header: (value: string) => string, label: (value: string) => string }} render_options
+ * @param {string} indentation
+ * @returns {string[]}
+ */
+function formatExpressionDetailLines(expression, render_options, indentation) {
+  if (expression.kind === 'and' || expression.kind === 'or') {
+    return formatExplainExpressionItems(
+      expression.expressions,
+      render_options,
+      `${indentation}   `,
+    );
+  }
+
+  if (expression.kind === 'not') {
+    if (expression.expression.kind === 'term') {
+      return [];
+    }
+
+    return formatExplainExpressionBlock(
+      expression.expression,
+      render_options,
+      `${indentation}   `,
+    );
+  }
+
+  if (expression.kind !== 'term') {
+    throw new Error('Unsupported explain expression details.');
+  }
+
+  if (expression.term.kind !== 'aggregate') {
+    return [];
+  }
+
+  /** @type {string[]} */
+  const output_lines = [
+    `${indentation}   ${render_options.label('traversal:')} ${formatTraversal(expression.term.traversal)}`,
+  ];
+
+  if (expression.term.aggregate_name === 'count') {
+    output_lines.push(
+      `${indentation}   ${render_options.label('comparison:')} ${expression.term.comparison} ${expression.term.value}`,
+    );
+  }
+
+  output_lines.push(
+    `${indentation}   ${render_options.label('nested expression:')}`,
+    ...formatExplainExpressionBlock(
+      expression.term.expression,
+      render_options,
+      `${indentation}     `,
+    ),
+  );
+
+  return output_lines;
 }
 
 /**
@@ -698,6 +799,10 @@ function formatClauseSummary(clause) {
  * @returns {string}
  */
 function formatTermSummary(term) {
+  if (term.kind === 'aggregate') {
+    return `aggregate ${term.aggregate_name}`;
+  }
+
   if (term.kind === 'field') {
     return `${term.field_name} ${term.operator} ${term.value}`;
   }
@@ -714,7 +819,7 @@ function formatTermSummary(term) {
     return `${term.relation_name} = ${term.target_id}`;
   }
 
-  throw new Error('Expected a non-aggregate query term.');
+  throw new Error('Expected a parsed query term.');
 }
 
 /**

package/lib/render-field-discovery.js

@@ -5,6 +5,8 @@
 
 import { Ansis } from 'ansis';
 
+const MAX_TEXT_EVIDENCE_ROWS = 5;
+
 /**
  * Render field discovery output.
  *
@@ -109,21 +111,21 @@ function formatTextFieldSuggestion(field_suggestion, render_options) {
   );
 
   if (field_suggestion.evidence_references.length > 0) {
-    lines.push(render_options.label('  evidence:'));
     lines.push(
-      ...field_suggestion.evidence_references.map(
-        (evidence_reference) =>
-          `${render_options.label('    ')}${formatEvidenceReference(evidence_reference)}`,
+      ...formatTextEvidenceSection(
+        '  evidence:',
+        field_suggestion.evidence_references,
+        render_options,
       ),
     );
   }
 
   if (field_suggestion.conflicting_evidence.length > 0) {
-    lines.push(render_options.label('  conflicting evidence:'));
     lines.push(
-      ...field_suggestion.conflicting_evidence.map(
-        (evidence_reference) =>
-          `${render_options.label('    ')}${formatEvidenceReference(evidence_reference)}`,
+      ...formatTextEvidenceSection(
+        '  conflicting evidence:',
+        field_suggestion.conflicting_evidence,
+        render_options,
       ),
     );
   }
@@ -131,6 +133,40 @@ function formatTextFieldSuggestion(field_suggestion, render_options) {
   return lines;
 }
 
+/**
+ * @param {string} section_title
+ * @param {import('./discover-fields.types.ts').FieldDiscoveryEvidenceReference[]} evidence_references
+ * @param {{ header: (value: string) => string, label: (value: string) => string }} render_options
+ * @returns {string[]}
+ */
+function formatTextEvidenceSection(
+  section_title,
+  evidence_references,
+  render_options,
+) {
+  /** @type {string[]} */
+  const lines = [render_options.label(section_title)];
+  const visible_evidence_references = evidence_references.slice(
+    0,
+    MAX_TEXT_EVIDENCE_ROWS,
+  );
+
+  lines.push(
+    ...visible_evidence_references.map(
+      (evidence_reference) =>
+        `${render_options.label('    ')}${formatEvidenceReference(evidence_reference)}`,
+    ),
+  );
+
+  if (evidence_references.length > MAX_TEXT_EVIDENCE_ROWS) {
+    const remaining_count = evidence_references.length - MAX_TEXT_EVIDENCE_ROWS;
+
+    lines.push(render_options.label(`    ${remaining_count} more ...`));
+  }
+
+  return lines;
+}
+
 /**
  * @param {import('./discover-fields.types.ts').FieldDiscoveryEvidenceReference} evidence_reference
  * @returns {string}

package/lib/render-output-view.js

@@ -11,6 +11,7 @@
 import { renderJsonOutput } from './render-json-output.js';
 import { renderPlainOutput } from './render-plain-output.js';
 import { renderRichOutput } from './render-rich-output.js';
+import { resolveDocumentNodeId } from './build-graph-identity.js';
 
 /**
  * Shared command output views.
@@ -56,12 +57,15 @@ 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'], repo_config?: PatramRepoConfig }=} command_options
+ * @param {{ derived_summary_evaluator?: DerivedSummaryEvaluator, document_node_ids?: BuildGraphResult['document_node_ids'], graph_nodes?: BuildGraphResult['nodes'], repo_config?: PatramRepoConfig }=} command_options
  * @returns {ShowOutputView}
  */
 export function createShowOutputView(show_output, command_options = {}) {
-  const shown_document_node =
-    command_options.graph_nodes?.[`doc:${show_output.path}`];
+  const shown_document_node = resolveDocumentGraphNode(
+    command_options.graph_nodes,
+    command_options.document_node_ids,
+    show_output.path,
+  );
 
   return {
     command: 'show',
@@ -75,20 +79,9 @@ export function createShowOutputView(show_output, command_options = {}) {
         )
       : undefined,
     hints: [],
-    items: show_output.resolved_links.map((resolved_link) => ({
-      kind: 'resolved_link',
-      label: resolved_link.label,
-      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}`],
-            ) ?? null)
-          : null,
-      ),
-    })),
+    items: show_output.resolved_links.map((resolved_link) =>
+      createResolvedLinkOutputItem(resolved_link, command_options),
+    ),
     path: show_output.path,
     rendered_source: show_output.rendered_source,
     source: show_output.source,
@@ -211,9 +204,15 @@ function createOutputNodeItem(graph_node, derived_summary, field_definitions) {
  * @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
+ * @param {GraphNode | undefined} graph_node
  * @returns {$k$$l$output$j$view$k$types$k$ts.OutputResolvedLinkTarget}
  */
-function createResolvedLinkTarget(target, field_definitions, derived_summary) {
+function createResolvedLinkTarget(
+  target,
+  field_definitions,
+  derived_summary,
+  graph_node,
+) {
   /** @type {Record<string, string | string[]>} */
   const fields = {};
 
@@ -225,7 +224,7 @@ function createResolvedLinkTarget(target, field_definitions, derived_summary) {
   const resolved_target = {
     derived_summary: derived_summary ?? undefined,
     fields,
-    id: `doc:${target.path}`,
+    id: graph_node ? getOutputNodeId(graph_node) : `doc:${target.path}`,
     kind: target.kind ?? 'document',
     path: target.path,
     title: target.title,
@@ -286,6 +285,53 @@ function getOutputNodeId(graph_node) {
   );
 }
 
+/**
+ * @param {{ label: string, reference: number, target: { kind?: string, path: string, status?: string, title: string } }} resolved_link
+ * @param {{ derived_summary_evaluator?: DerivedSummaryEvaluator, document_node_ids?: BuildGraphResult['document_node_ids'], graph_nodes?: BuildGraphResult['nodes'], repo_config?: PatramRepoConfig }} command_options
+ * @returns {$k$$l$output$j$view$k$types$k$ts.OutputResolvedLinkItem}
+ */
+function createResolvedLinkOutputItem(resolved_link, command_options) {
+  const target_graph_node = resolveDocumentGraphNode(
+    command_options.graph_nodes,
+    command_options.document_node_ids,
+    resolved_link.target.path,
+  );
+
+  return {
+    kind: 'resolved_link',
+    label: resolved_link.label,
+    reference: resolved_link.reference,
+    target: createResolvedLinkTarget(
+      resolved_link.target,
+      command_options.repo_config?.fields ?? {},
+      target_graph_node
+        ? (command_options.derived_summary_evaluator?.evaluate(
+            target_graph_node,
+          ) ?? null)
+        : null,
+      target_graph_node,
+    ),
+  };
+}
+
+/**
+ * @param {BuildGraphResult['nodes'] | undefined} graph_nodes
+ * @param {BuildGraphResult['document_node_ids'] | undefined} document_node_ids
+ * @param {string} document_path
+ * @returns {GraphNode | undefined}
+ */
+function resolveDocumentGraphNode(
+  graph_nodes,
+  document_node_ids,
+  document_path,
+) {
+  if (!graph_nodes) {
+    return undefined;
+  }
+
+  return graph_nodes[resolveDocumentNodeId(document_node_ids, document_path)];
+}
+
 /**
  * @param {GraphNode} graph_node
  * @param {NonNullable<PatramRepoConfig['fields']>} field_definitions