patram 0.10.0 → 0.12.0

package/lib/config/defaults.js

@@ -25,36 +25,12 @@ export function normalizeRepoConfig(repo_config) {
     queries: { ...repo_config.queries },
   };
 
-  assignOptionalRepoConfigField(
-    normalized_config,
-    'classes',
-    repo_config.classes,
-  );
-  assignOptionalRepoConfigField(
-    normalized_config,
-    'derived_summaries',
-    repo_config.derived_summaries,
-  );
   assignOptionalRepoConfigField(
     normalized_config,
     'fields',
     repo_config.fields,
   );
-  assignOptionalRepoConfigField(
-    normalized_config,
-    'mappings',
-    repo_config.mappings,
-  );
-  assignOptionalRepoConfigField(
-    normalized_config,
-    'path_classes',
-    repo_config.path_classes,
-  );
-  assignOptionalRepoConfigField(
-    normalized_config,
-    'relations',
-    repo_config.relations,
-  );
+  assignOptionalRepoConfigField(normalized_config, 'types', repo_config.types);
 
   return normalized_config;
 }
@@ -74,7 +50,39 @@ function assignOptionalRepoConfigField(
     return;
   }
 
+  if (field_name === 'types') {
+    normalized_config.types = normalizeTypes(
+      /** @type {PatramRepoConfig['types']} */ (field_value),
+    );
+    return;
+  }
+
   normalized_config[field_name] = /** @type {PatramRepoConfig[TKey]} */ (
     field_value
   );
 }
+
+/**
+ * @param {PatramRepoConfig['types']} types
+ * @returns {PatramRepoConfig['types']}
+ */
+function normalizeTypes(types) {
+  if (!types) {
+    return types;
+  }
+
+  /** @type {NonNullable<PatramRepoConfig['types']>} */
+  const normalized_types = {};
+
+  for (const [type_name, type_definition] of Object.entries(types)) {
+    normalized_types[type_name] = {
+      ...type_definition,
+    };
+
+    if (typeof type_definition.in === 'string') {
+      normalized_types[type_name].in = [type_definition.in];
+    }
+  }
+
+  return normalized_types;
+}

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

@@ -4,11 +4,11 @@
  * Reads `.patram.json`, applies defaults, and validates repo config and graph
  * schema before command execution.
  *
- * Kind: config
- * Status: active
- * Tracked in: ../../docs/plans/v0/source-anchor-dogfooding.md
- * Decided by: ../../docs/decisions/single-config-file.md
- * Decided by: ../../docs/decisions/optional-config-default-scan.md
+ * kind: config
+ * status: active
+ * tracked_in: ../../docs/plans/v0/source-anchor-dogfooding.md
+ * decided_by: ../../docs/decisions/single-config-file.md
+ * decided_by: ../../docs/decisions/optional-config-default-scan.md
  * @patram
  * @see {@link ./schema.js}
  * @see {@link ./validation.js}
@@ -24,24 +24,10 @@
  */
 /**
  * @typedef {object} LoadPatramConfigResult
- * @property {import('./schema.js').PatramRepoConfig | null} config
+ * @property {PatramRepoConfig | null} config
  * @property {string} config_path
  * @property {PatramDiagnostic[]} diagnostics
  */
-/**
- * @typedef {import('./schema.js').StoredQueryConfig} StoredQueryConfig
- * @typedef {import('./schema.js').FieldDisplayConfig} FieldDisplayConfig
- * @typedef {import('./schema.js').FieldQueryConfig} FieldQueryConfig
- * @typedef {import('./schema.js').MetadataFieldConfig} MetadataFieldConfig
- * @typedef {import('./schema.js').ClassFieldRuleConfig} ClassFieldRuleConfig
- * @typedef {import('./schema.js').ClassSchemaConfig} ClassSchemaConfig
- * @typedef {import('./schema.js').PathClassConfig} PathClassConfig
- * @typedef {import('./schema.js').DerivedSummaryScalar} DerivedSummaryScalar
- * @typedef {import('./schema.js').DerivedSummarySelectCaseConfig} DerivedSummarySelectCaseConfig
- * @typedef {import('./schema.js').DerivedSummaryFieldConfig} DerivedSummaryFieldConfig
- * @typedef {import('./schema.js').DerivedSummaryConfig} DerivedSummaryConfig
- * @typedef {import('./schema.js').PatramRepoConfig} PatramRepoConfig
- */
 /**
  * Load and validate the repo Patram config.
  *
@@ -49,6 +35,17 @@
  * @returns {Promise<LoadPatramConfigResult>}
  */
 export function loadPatramConfig(project_directory?: string): Promise<LoadPatramConfigResult>;
+/**
+ * @param {string} config_source
+ * @returns {{ success: true, value: unknown } | { success: false, diagnostic: PatramDiagnostic }}
+ */
+export function parsePatramConfigSource(config_source: string): {
+    success: true;
+    value: unknown;
+} | {
+    success: false;
+    diagnostic: PatramDiagnostic;
+};
 export type PatramDiagnostic = {
     code: string;
     column: number;
@@ -58,19 +55,8 @@ export type PatramDiagnostic = {
     path: string;
 };
 export type LoadPatramConfigResult = {
-    config: import("./schema.js").PatramRepoConfig | null;
+    config: PatramRepoConfig | null;
     config_path: string;
     diagnostics: PatramDiagnostic[];
 };
-export type StoredQueryConfig = import("./schema.js").StoredQueryConfig;
-export type FieldDisplayConfig = import("./schema.js").FieldDisplayConfig;
-export type FieldQueryConfig = import("./schema.js").FieldQueryConfig;
-export type MetadataFieldConfig = import("./schema.js").MetadataFieldConfig;
-export type ClassFieldRuleConfig = import("./schema.js").ClassFieldRuleConfig;
-export type ClassSchemaConfig = import("./schema.js").ClassSchemaConfig;
-export type PathClassConfig = import("./schema.js").PathClassConfig;
-export type DerivedSummaryScalar = import("./schema.js").DerivedSummaryScalar;
-export type DerivedSummarySelectCaseConfig = import("./schema.js").DerivedSummarySelectCaseConfig;
-export type DerivedSummaryFieldConfig = import("./schema.js").DerivedSummaryFieldConfig;
-export type DerivedSummaryConfig = import("./schema.js").DerivedSummaryConfig;
-export type PatramRepoConfig = import("./schema.js").PatramRepoConfig;
+import type { PatramRepoConfig } from './load-patram-config.types.d.ts';

package/lib/config/load-patram-config.js

@@ -1,32 +1,17 @@
 /**
  * @import {
- *   ClassFieldRuleConfig,
- *   ClassSchemaConfig,
- *   DerivedSummaryConfig,
- *   DerivedSummaryFieldConfig,
- *   DerivedSummaryScalar,
- *   DerivedSummarySelectCaseConfig,
- *   FieldDisplayConfig,
- *   FieldQueryConfig,
- *   MetadataFieldConfig,
- *   PathClassConfig,
+ *   PatramRepoConfig,
  *   StoredQueryConfig,
- * } from './schema.js';
+ * } from './load-patram-config.types.ts';
  */
 
 import { readFile } from 'node:fs/promises';
 import { resolve } from 'node:path';
 import process from 'node:process';
 
-import { CONFIG_FILE_NAME, patram_repo_config_schema } from './schema.js';
-import { createDefaultRepoConfig, normalizeRepoConfig } from './defaults.js';
-import {
-  validateDerivedSummaries,
-  validateFieldSchemaConfig,
-  validateGraphSchema,
-  validateLegacyConfigShape,
-  validateStoredQueries,
-} from './validation.js';
+import { CONFIG_FILE_NAME } from './schema.js';
+import { createDefaultRepoConfig } from './defaults.js';
+import { validatePatramConfigValue } from './validate-patram-config-value.js';
 
 /**
  * Repo config loading.
@@ -34,11 +19,11 @@ import {
  * Reads `.patram.json`, applies defaults, and validates repo config and graph
  * schema before command execution.
  *
- * Kind: config
- * Status: active
- * Tracked in: ../../docs/plans/v0/source-anchor-dogfooding.md
- * Decided by: ../../docs/decisions/single-config-file.md
- * Decided by: ../../docs/decisions/optional-config-default-scan.md
+ * kind: config
+ * status: active
+ * tracked_in: ../../docs/plans/v0/source-anchor-dogfooding.md
+ * decided_by: ../../docs/decisions/single-config-file.md
+ * decided_by: ../../docs/decisions/optional-config-default-scan.md
  * @patram
  * @see {@link ./schema.js}
  * @see {@link ./validation.js}
@@ -56,26 +41,11 @@ import {
 
 /**
  * @typedef {object} LoadPatramConfigResult
- * @property {import('./schema.js').PatramRepoConfig | null} config
+ * @property {PatramRepoConfig | null} config
  * @property {string} config_path
  * @property {PatramDiagnostic[]} diagnostics
  */
 
-/**
- * @typedef {import('./schema.js').StoredQueryConfig} StoredQueryConfig
- * @typedef {import('./schema.js').FieldDisplayConfig} FieldDisplayConfig
- * @typedef {import('./schema.js').FieldQueryConfig} FieldQueryConfig
- * @typedef {import('./schema.js').MetadataFieldConfig} MetadataFieldConfig
- * @typedef {import('./schema.js').ClassFieldRuleConfig} ClassFieldRuleConfig
- * @typedef {import('./schema.js').ClassSchemaConfig} ClassSchemaConfig
- * @typedef {import('./schema.js').PathClassConfig} PathClassConfig
- * @typedef {import('./schema.js').DerivedSummaryScalar} DerivedSummaryScalar
- * @typedef {import('./schema.js').DerivedSummarySelectCaseConfig} DerivedSummarySelectCaseConfig
- * @typedef {import('./schema.js').DerivedSummaryFieldConfig} DerivedSummaryFieldConfig
- * @typedef {import('./schema.js').DerivedSummaryConfig} DerivedSummaryConfig
- * @typedef {import('./schema.js').PatramRepoConfig} PatramRepoConfig
- */
-
 /**
  * Load and validate the repo Patram config.
  *
@@ -90,56 +60,19 @@ export async function loadPatramConfig(project_directory = process.cwd()) {
     return createLoadResult(createDefaultRepoConfig(), []);
   }
 
-  const parse_result = parseConfigJson(config_source);
+  const parse_result = parsePatramConfigSource(config_source);
 
   if (!parse_result.success) {
     return createLoadResult(null, [parse_result.diagnostic]);
   }
 
-  const legacy_config_diagnostics = validateLegacyConfigShape(
-    parse_result.value,
-  );
-
-  if (legacy_config_diagnostics.length > 0) {
-    return createLoadResult(null, legacy_config_diagnostics);
-  }
-
-  const config_result = patram_repo_config_schema.safeParse(parse_result.value);
+  const validation_result = validatePatramConfigValue(parse_result.value);
 
-  if (!config_result.success) {
-    return createLoadResult(
-      null,
-      config_result.error.issues.map(createValidationDiagnostic),
-    );
+  if (!validation_result.success) {
+    return createLoadResult(null, validation_result.diagnostics);
   }
 
-  const graph_schema_diagnostics = validateGraphSchema(config_result.data);
-
-  if (graph_schema_diagnostics.length > 0) {
-    return createLoadResult(null, graph_schema_diagnostics);
-  }
-
-  const normalized_config = normalizeRepoConfig(config_result.data);
-  const field_schema_diagnostics = validateFieldSchemaConfig(normalized_config);
-
-  if (field_schema_diagnostics.length > 0) {
-    return createLoadResult(null, field_schema_diagnostics);
-  }
-
-  const stored_query_diagnostics = validateStoredQueries(normalized_config);
-
-  if (stored_query_diagnostics.length > 0) {
-    return createLoadResult(null, stored_query_diagnostics);
-  }
-
-  const derived_summary_diagnostics =
-    validateDerivedSummaries(normalized_config);
-
-  if (derived_summary_diagnostics.length > 0) {
-    return createLoadResult(null, derived_summary_diagnostics);
-  }
-
-  return createLoadResult(normalized_config, []);
+  return createLoadResult(validation_result.config, []);
 }
 
 /**
@@ -162,7 +95,7 @@ async function readConfigSource(config_file_path) {
  * @param {string} config_source
  * @returns {{ success: true, value: unknown } | { success: false, diagnostic: PatramDiagnostic }}
  */
-function parseConfigJson(config_source) {
+export function parsePatramConfigSource(config_source) {
   try {
     return {
       success: true,
@@ -181,7 +114,7 @@ function parseConfigJson(config_source) {
 }
 
 /**
- * @param {import('./schema.js').PatramRepoConfig | null} config
+ * @param {PatramRepoConfig | null} config
  * @param {PatramDiagnostic[]} diagnostics
  * @returns {LoadPatramConfigResult}
  */
@@ -211,34 +144,6 @@ function createInvalidJsonDiagnostic(config_source, error) {
   };
 }
 
-/**
- * @param {import('zod').core.$ZodIssue} issue
- * @returns {PatramDiagnostic}
- */
-function createValidationDiagnostic(issue) {
-  const issue_path = formatIssuePath(issue.path);
-
-  if (issue_path) {
-    return {
-      code: 'config.invalid',
-      column: 1,
-      level: 'error',
-      line: 1,
-      message: `Invalid config at "${issue_path}": ${issue.message}`,
-      path: CONFIG_FILE_NAME,
-    };
-  }
-
-  return {
-    code: 'config.invalid',
-    column: 1,
-    level: 'error',
-    line: 1,
-    message: `Invalid config: ${issue.message}`,
-    path: CONFIG_FILE_NAME,
-  };
-}
-
 /**
  * @param {unknown} error
  * @returns {error is NodeJS.ErrnoException}
@@ -281,14 +186,6 @@ function getJsonSyntaxOrigin(config_source, error_message) {
   };
 }
 
-/**
- * @param {(string | number | symbol | undefined)[]} issue_path
- * @returns {string}
- */
-function formatIssuePath(issue_path) {
-  return issue_path.map(String).join('.');
-}
-
 /**
  * @param {string} source_text
  * @param {number} offset

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

@@ -1,45 +1,8 @@
 export type StoredQueryConfig = import('./schema.js').StoredQueryConfig;
-export type FieldDisplayConfig = import('./schema.js').FieldDisplayConfig;
-export type FieldQueryConfig = import('./schema.js').FieldQueryConfig;
-export type FieldValueTypeName = import('./schema.js').MetadataFieldConfig['type'];
 export type MetadataFieldConfig = import('./schema.js').MetadataFieldConfig;
-export type StringFieldConfig = Extract<MetadataFieldConfig, {
-    type: 'string';
-}>;
-export type IntegerFieldConfig = Extract<MetadataFieldConfig, {
-    type: 'integer';
-}>;
-export type EnumFieldConfig = Extract<MetadataFieldConfig, {
-    type: 'enum';
-}>;
-export type PathFieldConfig = Extract<MetadataFieldConfig, {
-    type: 'path';
-}>;
-export type GlobFieldConfig = Extract<MetadataFieldConfig, {
-    type: 'glob';
-}>;
-export type DateFieldConfig = Extract<MetadataFieldConfig, {
-    type: 'date';
-}>;
-export type DateTimeFieldConfig = Extract<MetadataFieldConfig, {
-    type: 'date_time';
-}>;
-export type ClassFieldRuleConfig = import('./schema.js').ClassFieldRuleConfig;
-export type DirectiveTypeConfig = MetadataFieldConfig;
-export type MetadataDirectiveRuleConfig = ClassFieldRuleConfig;
-export type ClassSchemaConfig = import('./schema.js').ClassSchemaConfig;
-export type MetadataSchemaConfig = ClassSchemaConfig;
-export type PathClassConfig = import('./schema.js').PathClassConfig;
-export type DerivedSummaryScalar = import('./schema.js').DerivedSummaryScalar;
-export type DerivedSummarySelectCaseConfig = import('./schema.js').DerivedSummarySelectCaseConfig;
-export type DerivedSummaryFieldConfig = import('./schema.js').DerivedSummaryFieldConfig;
-export type DerivedSummaryCountFieldConfig = Extract<DerivedSummaryFieldConfig, {
-    count: unknown;
-}>;
-export type DerivedSummarySelectFieldConfig = Extract<DerivedSummaryFieldConfig, {
-    select: unknown;
-}>;
-export type DerivedSummaryConfig = import('./schema.js').DerivedSummaryConfig;
+export type ScalarFieldConfig = import('./schema.js').ScalarFieldConfig;
+export type RefFieldConfig = import('./schema.js').RefFieldConfig;
+export type TypeDefinitionConfig = import('./schema.js').TypeDefinitionConfig;
 export type PatramRepoConfig = import('./schema.js').PatramRepoConfig;
 export type PatramDiagnostic = import('./load-patram-config.js').PatramDiagnostic;
 export type LoadPatramConfigResult = import('./load-patram-config.js').LoadPatramConfigResult;

package/lib/config/manage-stored-queries-helpers.d.ts

@@ -0,0 +1,69 @@
+/**
+ * @param {string} config_file_path
+ * @returns {Promise<
+ *   | { success: true, value: Record<string, unknown> }
+ *   | { diagnostic: PatramDiagnostic, success: false }
+ * >}
+ */
+export function loadRawConfig(config_file_path: string): Promise<{
+    success: true;
+    value: Record<string, unknown>;
+} | {
+    diagnostic: PatramDiagnostic;
+    success: false;
+}>;
+/**
+ * @param {string} config_file_path
+ * @param {Record<string, unknown>} raw_config
+ * @param {StoredQueryMutationResult} mutation_result
+ * @returns {Promise<
+ *   | { success: true, value: StoredQueryMutationResult }
+ *   | { diagnostics: PatramDiagnostic[], success: false }
+ * >}
+ */
+export function persistStoredQueryMutation(config_file_path: string, raw_config: Record<string, unknown>, mutation_result: StoredQueryMutationResult): Promise<{
+    success: true;
+    value: StoredQueryMutationResult;
+} | {
+    diagnostics: PatramDiagnostic[];
+    success: false;
+}>;
+/**
+ * @param {string} query_text
+ * @param {string | undefined} description
+ * @returns {StoredQueryConfig}
+ */
+export function createStoredQueryDefinition(query_text: string, description: string | undefined): StoredQueryConfig;
+/**
+ * @param {Record<string, unknown> | null} raw_query_value
+ * @param {StoredQueryConfig} existing_query
+ * @param {{ cypher?: string, description?: string }} stored_query_mutation
+ * @returns {StoredQueryConfig}
+ */
+export function createUpdatedStoredQueryDefinition(raw_query_value: Record<string, unknown> | null, existing_query: StoredQueryConfig, stored_query_mutation: {
+    cypher?: string;
+    description?: string;
+}): StoredQueryConfig;
+/**
+ * @param {Record<string, unknown>} raw_config
+ * @returns {Record<string, unknown>}
+ */
+export function ensureRawQueries(raw_config: Record<string, unknown>): Record<string, unknown>;
+/**
+ * @param {unknown} raw_query_value
+ * @returns {Record<string, unknown> | null}
+ */
+export function rawQueryValueToRecord(raw_query_value: unknown): Record<string, unknown> | null;
+export type StoredQueryMutationResult = {
+    action: "added";
+    name: string;
+} | {
+    action: "removed";
+    name: string;
+} | {
+    action: "updated";
+    name: string;
+    previous_name?: string;
+};
+import type { PatramDiagnostic } from './load-patram-config.types.d.ts';
+import type { StoredQueryConfig } from './load-patram-config.types.d.ts';