patram 0.2.0 → 0.4.0

package/lib/load-patram-config.types.ts

@@ -1,5 +1,5 @@
 import type {
-  KindDefinition,
+  ClassDefinition,
   MappingDefinition,
   RelationDefinition,
 } from './patram-config.types.ts';
@@ -8,6 +8,98 @@ export interface StoredQueryConfig {
   where: string;
 }
 
+export type FieldValueTypeName =
+  | 'string'
+  | 'integer'
+  | 'enum'
+  | 'path'
+  | 'glob'
+  | 'date'
+  | 'date_time';
+
+export interface FieldDisplayConfig {
+  hidden?: boolean;
+  order?: number;
+}
+
+export interface FieldQueryConfig {
+  contains?: boolean;
+  prefix?: boolean;
+}
+
+export interface StringFieldConfig {
+  display?: FieldDisplayConfig;
+  multiple?: boolean;
+  query?: FieldQueryConfig;
+  type: 'string';
+}
+
+export interface IntegerFieldConfig {
+  display?: FieldDisplayConfig;
+  multiple?: boolean;
+  type: 'integer';
+}
+
+export interface EnumFieldConfig {
+  display?: FieldDisplayConfig;
+  multiple?: boolean;
+  type: 'enum';
+  values: string[];
+}
+
+export interface PathFieldConfig {
+  display?: FieldDisplayConfig;
+  multiple?: boolean;
+  path_class?: string;
+  type: 'path';
+}
+
+export interface GlobFieldConfig {
+  display?: FieldDisplayConfig;
+  multiple?: boolean;
+  type: 'glob';
+}
+
+export interface DateFieldConfig {
+  display?: FieldDisplayConfig;
+  multiple?: boolean;
+  type: 'date';
+}
+
+export interface DateTimeFieldConfig {
+  display?: FieldDisplayConfig;
+  multiple?: boolean;
+  type: 'date_time';
+}
+
+export type MetadataFieldConfig =
+  | DateFieldConfig
+  | DateTimeFieldConfig
+  | EnumFieldConfig
+  | GlobFieldConfig
+  | IntegerFieldConfig
+  | PathFieldConfig
+  | StringFieldConfig;
+
+export interface ClassFieldRuleConfig {
+  presence: 'required' | 'optional' | 'forbidden';
+}
+
+export type DirectiveTypeConfig = MetadataFieldConfig;
+export type MetadataDirectiveRuleConfig = ClassFieldRuleConfig;
+
+export interface ClassSchemaConfig {
+  document_path_class?: string;
+  fields: Record<string, ClassFieldRuleConfig>;
+  unknown_fields?: 'ignore' | 'error';
+}
+
+export type MetadataSchemaConfig = ClassSchemaConfig;
+
+export interface PathClassConfig {
+  prefixes: string[];
+}
+
 export type DerivedSummaryScalar = boolean | number | string | null;
 
 export interface DerivedSummaryCountFieldConfig {
@@ -34,15 +126,18 @@ export type DerivedSummaryFieldConfig =
   | DerivedSummarySelectFieldConfig;
 
 export interface DerivedSummaryConfig {
+  classes: string[];
   fields: DerivedSummaryFieldConfig[];
-  kinds: string[];
 }
 
 export interface PatramRepoConfig {
+  class_schemas?: Record<string, ClassSchemaConfig>;
+  classes?: Record<string, ClassDefinition>;
   derived_summaries?: Record<string, DerivedSummaryConfig>;
+  fields?: Record<string, MetadataFieldConfig>;
   include: string[];
-  kinds?: Record<string, KindDefinition>;
   mappings?: Record<string, MappingDefinition>;
+  path_classes?: Record<string, PathClassConfig>;
   queries: Record<string, StoredQueryConfig>;
   relations?: Record<string, RelationDefinition>;
 }

package/lib/load-project-graph.js

@@ -36,13 +36,14 @@ import { resolvePatramGraphConfig } from './resolve-patram-graph-config.js';
  * project directory.
  *
  * @param {string} project_directory
- * @returns {Promise<{ config: PatramRepoConfig, diagnostics: PatramDiagnostic[], graph: BuildGraphResult, source_file_paths: string[] }>}
+ * @returns {Promise<{ claims: PatramClaim[], config: PatramRepoConfig, diagnostics: PatramDiagnostic[], graph: BuildGraphResult, source_file_paths: string[] }>}
  */
 export async function loadProjectGraph(project_directory) {
   const load_result = await loadPatramConfig(project_directory);
 
   if (load_result.diagnostics.length > 0) {
     return {
+      claims: [],
       config: {
         include: [],
         queries: {},
@@ -74,6 +75,7 @@ export async function loadProjectGraph(project_directory) {
 
   if (collect_result.diagnostics.length > 0) {
     return {
+      claims: collect_result.claims,
       config: repo_config,
       diagnostics: collect_result.diagnostics,
       graph: {
@@ -85,6 +87,7 @@ export async function loadProjectGraph(project_directory) {
   }
 
   return {
+    claims: collect_result.claims,
     config: repo_config,
     diagnostics: [],
     graph: buildGraph(graph_config, collect_result.claims),

package/lib/output-view.types.ts

@@ -12,6 +12,11 @@ export interface OutputDerivedSummary {
   name: string;
 }
 
+export interface OutputMetadataField {
+  name: string;
+  value: string | string[];
+}
+
 export interface OutputViewSummary {
   count: number;
   kind: 'resolved_link_list' | 'result_list' | 'stored_query_list';
@@ -26,12 +31,13 @@ export interface QueryOutputViewSummary extends OutputViewSummary {
 
 export interface OutputNodeItem {
   derived_summary?: OutputDerivedSummary;
+  fields: Record<string, string | string[]>;
   id: string;
   kind: 'node';
-  node_kind: GraphNode['kind'];
-  path: string;
-  status?: string;
+  node_kind: string;
+  path?: string;
   title: string;
+  visible_fields: OutputMetadataField[];
 }
 
 export interface OutputStoredQueryItem {
@@ -42,10 +48,12 @@ export interface OutputStoredQueryItem {
 
 export interface OutputResolvedLinkTarget {
   derived_summary?: OutputDerivedSummary;
-  kind?: string;
-  path: string;
-  status?: string;
+  fields: Record<string, string | string[]>;
+  id: string;
+  kind: string;
+  path?: string;
   title: string;
+  visible_fields: OutputMetadataField[];
 }
 
 export interface OutputResolvedLinkItem {

package/lib/parse-cli-arguments.types.ts

@@ -1,4 +1,4 @@
-export type CliCommandName = 'check' | 'query' | 'queries' | 'show';
+export type CliCommandName = 'check' | 'fields' | 'query' | 'queries' | 'show';
 export type CliHelpTopicName = 'query-language';
 export type CliHelpTargetKind = 'root' | 'command' | 'topic';