@housekit/kit 0.1.12 → 0.1.14

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 #!/usr/bin/env node
 export { type HouseKitConfig } from './config';
+export { validateConfig } from './validation';

package/dist/index.js

@@ -229,11 +229,11 @@ import chalk2 from "chalk";
 import { createRequire } from "module";
 
 // src/commands/generate.ts
-import { existsSync, mkdirSync, readFileSync, writeFileSync } from "fs";
+import { existsSync as existsSync2, mkdirSync, readFileSync, writeFileSync } from "fs";
 import { join } from "path";
 
 // src/loader.ts
-import { resolve } from "path";
+import { resolve as resolve2 } from "path";
 
 // ../../node_modules/.bun/minimatch@9.0.5/node_modules/minimatch/dist/esm/index.js
 var import_brace_expansion = __toESM(require_brace_expansion(), 1);
@@ -5646,6 +5646,132 @@ function quoteComment(comment) {
 
 // src/loader.ts
 import { createJiti } from "jiti";
+
+// src/validation.ts
+import { existsSync } from "fs";
+import { resolve } from "path";
+function validateConfig(config, options = {}) {
+  const errors = [];
+  const warnings = [];
+  const rootDir = options.rootDir || process.cwd();
+  validateRequiredFields(config, errors);
+  if (!options.skipPathValidation) {
+    validateSchemaPath(config, rootDir, errors, warnings);
+    validateOutPath(config, rootDir, errors);
+  }
+  validateDatabases(config, errors, warnings);
+  validateSchemaMapping(config, errors, warnings);
+  return {
+    valid: errors.length === 0,
+    errors,
+    warnings
+  };
+}
+function validateRequiredFields(config, errors) {
+  if (!config.schema) {
+    errors.push({
+      field: "schema",
+      message: "Schema path is required",
+      severity: "error"
+    });
+  }
+  if (!config.out) {
+    errors.push({
+      field: "out",
+      message: "Output directory is required",
+      severity: "error"
+    });
+  }
+  if (!config.databases || Object.keys(config.databases).length === 0) {
+    errors.push({
+      field: "databases",
+      message: "At least one database must be configured",
+      severity: "error"
+    });
+  }
+}
+function validateSchemaPath(config, rootDir, errors, warnings) {
+  const schemaPath = typeof config.schema === "string" ? config.schema : Object.values(config.schema)[0];
+  if (!schemaPath)
+    return;
+  const fullPath = resolve(rootDir, schemaPath);
+  if (!existsSync(fullPath)) {
+    warnings.push({
+      field: "schema",
+      message: `Schema directory does not exist: ${schemaPath}`,
+      severity: "warning"
+    });
+  }
+}
+function validateOutPath(config, rootDir, errors) {
+  const fullPath = resolve(rootDir, config.out);
+  if (!existsSync(fullPath)) {
+    errors.push({
+      field: "out",
+      message: `Output directory does not exist: ${config.out}`,
+      severity: "error"
+    });
+  }
+}
+function validateDatabases(config, errors, warnings) {
+  if (!config.databases)
+    return;
+  for (const [name, db] of Object.entries(config.databases)) {
+    const prefix2 = `databases.${name}`;
+    if (!db.database) {
+      errors.push({
+        field: `${prefix2}.database`,
+        message: `Database name is required for "${name}"`,
+        severity: "error"
+      });
+    }
+    if (db.url && db.host) {
+      warnings.push({
+        field: `${prefix2}`,
+        message: `Both url and host are specified for "${name}". Using url.`,
+        severity: "warning"
+      });
+    }
+    if (db.port !== undefined && (db.port < 1 || db.port > 65535)) {
+      errors.push({
+        field: `${prefix2}.port`,
+        message: `Invalid port ${db.port} for "${name}". Port must be between 1 and 65535.`,
+        severity: "error"
+      });
+    }
+    if (!db.url && !db.host) {
+      warnings.push({
+        field: `${prefix2}`,
+        message: `No url or host specified for "${name}". Using default http://localhost:8123.`,
+        severity: "warning"
+      });
+    }
+  }
+}
+function validateSchemaMapping(config, errors, warnings) {
+  if (typeof config.schema !== "string" && config.schema) {
+    const schemaDatabases = Object.keys(config.schema);
+    const configDatabases = Object.keys(config.databases || {});
+    const missingInSchema = configDatabases.filter((db) => !schemaDatabases.includes(db));
+    const missingInConfig = schemaDatabases.filter((db) => !configDatabases.includes(db));
+    if (missingInSchema.length > 0) {
+      errors.push({
+        field: "schema",
+        message: `Databases defined in config but not in schema mapping: ${missingInSchema.join(", ")}`,
+        severity: "error"
+      });
+    }
+    if (missingInConfig.length > 0) {
+      warnings.push({
+        field: "schema",
+        message: `Databases defined in schema mapping but not in config: ${missingInConfig.join(", ")}`,
+        severity: "warning"
+      });
+    }
+  }
+}
+
+// src/loader.ts
 var jiti = createJiti(import.meta.url);
 async function loadSchema(schemaPath, options) {
   if (!options?.quiet) {
@@ -5661,7 +5787,7 @@ async function loadSchema(schemaPath, options) {
   }
   const foundTables = [];
   for (const file of allFiles) {
-    const fullPath = resolve(process.cwd(), file);
+    const fullPath = resolve2(process.cwd(), file);
     try {
       const module = await jiti.import(fullPath);
       for (const [key, value] of Object.entries(module)) {
@@ -5704,7 +5830,7 @@ async function findConfigPaths(root) {
     for await (const file of glob2) {
       if (file.includes("node_modules") || file.includes(".git"))
         continue;
-      matches.push(resolve(root, file));
+      matches.push(resolve2(root, file));
       if (matches.length > 1)
         break;
     }
@@ -5726,7 +5852,20 @@ async function getConfigPath(root = process.cwd()) {
 async function loadConfig() {
   const configPath = await getConfigPath();
   const module = await jiti.import(configPath);
-  return module.default;
+  const config = module.default;
+  const validation = validateConfig(config);
+  if (validation.warnings.length > 0) {
+    for (const warning of validation.warnings) {
+      warn(`Config warning [${warning.field}]: ${warning.message}`);
+    }
+  }
+  if (!validation.valid) {
+    for (const err of validation.errors) {
+      error(`Config error [${err.field}]: ${err.message}`);
+    }
+    throw new Error("Configuration validation failed");
+  }
+  return config;
 }
 
 // src/config.ts
@@ -5750,7 +5889,7 @@ async function generateCommand() {
   const databases = getDatabaseConfigs(config);
   const schemaMapping = getSchemaMapping(config);
   const outDir = config.out || "./housekit";
-  if (!existsSync(outDir))
+  if (!existsSync2(outDir))
     mkdirSync(outDir, { recursive: true });
   let hasChanges = false;
   for (const [dbName, dbConfig] of Object.entries(databases)) {
@@ -5765,11 +5904,11 @@ async function generateCommand() {
       continue;
     }
     const dbOutDir = join(outDir, dbName);
-    if (!existsSync(dbOutDir))
+    if (!existsSync2(dbOutDir))
       mkdirSync(dbOutDir, { recursive: true });
     const snapshotPath = join(dbOutDir, "snapshot.json");
     let previousTables = {};
-    if (existsSync(snapshotPath)) {
+    if (existsSync2(snapshotPath)) {
       previousTables = JSON.parse(readFileSync(snapshotPath, "utf-8"));
     }
     const sqlStatements = [];
@@ -5825,7 +5964,7 @@ async function generateCommand() {
 }
 
 // src/commands/push.ts
-import { existsSync as existsSync2, writeFileSync as writeFileSync2, mkdirSync as mkdirSync2 } from "fs";
+import { existsSync as existsSync3, writeFileSync as writeFileSync2, mkdirSync as mkdirSync2 } from "fs";
 import { join as join2 } from "path";
 
 // src/db.ts
@@ -6833,7 +6972,7 @@ async function dumpExplain(client, statements, tableName, shadow = false) {
     return;
   try {
     const outDir = join2(process.cwd(), ".housekit");
-    if (!existsSync2(outDir))
+    if (!existsSync3(outDir))
       mkdirSync2(outDir, { recursive: true });
     const explains = [];
     for (const stmt of statements) {
@@ -7014,7 +7153,7 @@ async function migrateCommand(options) {
 }
 
 // src/commands/pull.ts
-import { existsSync as existsSync3, mkdirSync as mkdirSync3, writeFileSync as writeFileSync3, readFileSync as readFileSync3 } from "fs";
+import { existsSync as existsSync4, mkdirSync as mkdirSync3, writeFileSync as writeFileSync3, readFileSync as readFileSync3 } from "fs";
 import { join as join4 } from "path";
 function sanitizeName(name) {
   const cleaned = name.replace(/[^a-zA-Z0-9_]/g, "_");
@@ -7295,7 +7434,7 @@ async function pullCommand(options) {
         return true;
       });
       const migrationDir = join4(process.cwd(), outDir, migrationFolderName);
-      if (!existsSync3(migrationDir))
+      if (!existsSync4(migrationDir))
         mkdirSync3(migrationDir, { recursive: true });
       const downloadMode2 = await listPrompt("How would you like to download the tables?", [
         { name: "Download all tables", value: "all" },
@@ -7379,7 +7518,7 @@ async function pullCommand(options) {
     if (useSubdirectory && subdirectoryName) {
       targetDir = join4(targetDir, subdirectoryName);
     }
-    if (!existsSync3(targetDir))
+    if (!existsSync4(targetDir))
       mkdirSync3(targetDir, { recursive: true });
     let downloadedCount = 0;
     const fileExtension = fileFormat;
@@ -7852,7 +7991,7 @@ async function schemaCommand(options) {
 }
 
 // src/commands/check.ts
-import { existsSync as existsSync4, readFileSync as readFileSync4, readdirSync as readdirSync3 } from "fs";
+import { existsSync as existsSync5, readFileSync as readFileSync4, readdirSync as readdirSync3 } from "fs";
 import { join as join5 } from "path";
 function validateMigrationFile(file, content, previousTimestamp) {
   const issues = [];
@@ -7935,7 +8074,7 @@ async function checkCommand() {
   let totalWarnings = 0;
   for (const dbName of Object.keys(databases)) {
     const dbOutDir = join5(outDir, dbName);
-    if (!existsSync4(dbOutDir)) {
+    if (!existsSync5(dbOutDir)) {
       warn(`Migration directory not found for ${quoteName(dbName)}: ${dbOutDir}`);
       continue;
     }
@@ -7976,7 +8115,7 @@ async function checkCommand() {
       }
     }
     const snapshotPath = join5(dbOutDir, "snapshot.json");
-    if (existsSync4(snapshotPath)) {
+    if (existsSync5(snapshotPath)) {
       try {
         const snapshot = JSON.parse(readFileSync4(snapshotPath, "utf-8"));
         const snapshotTables = Object.keys(snapshot);
@@ -8400,7 +8539,7 @@ async function dryRunCommand(options) {
 }
 
 // src/commands/status.ts
-import { readFileSync as readFileSync5, readdirSync as readdirSync4, existsSync as existsSync5 } from "fs";
+import { readFileSync as readFileSync5, readdirSync as readdirSync4, existsSync as existsSync6 } from "fs";
 import { join as join6 } from "path";
 import Table2 from "cli-table3";
 async function isStatementAlreadyApplied2(client, parsed) {
@@ -8447,7 +8586,7 @@ async function statusCommand(options) {
     const { client, name: dbName } = resolveDatabase(config, options.database);
     const outDir = config.out || "./housekit";
     const dbOutDir = join6(outDir, dbName);
-    if (!existsSync5(dbOutDir)) {
+    if (!existsSync6(dbOutDir)) {
       spinner.warn("No migration directory found");
       info(`Migration directory: ${dbOutDir}`);
       info('Run "housekit generate" to create migrations.');
@@ -8557,12 +8696,12 @@ async function statusCommand(options) {
 }
 
 // src/commands/init.ts
-import { existsSync as existsSync6, writeFileSync as writeFileSync4, mkdirSync as mkdirSync4 } from "fs";
+import { existsSync as existsSync7, writeFileSync as writeFileSync4, mkdirSync as mkdirSync4 } from "fs";
 import { join as join7 } from "path";
 async function initCommand() {
   const schemaDir = "./src/schema";
   const migrationsDir = "./housekit";
-  if (existsSync6("housekit.config.js") || existsSync6("housekit.config.ts") || existsSync6("housekit.config.mjs") || existsSync6("housekit.config.cjs")) {
+  if (existsSync7("housekit.config.js") || existsSync7("housekit.config.ts") || existsSync7("housekit.config.mjs") || existsSync7("housekit.config.cjs")) {
     const overwrite = await confirmPrompt("Configuration file already exists. Overwrite?", false);
     if (!overwrite) {
       info("Initialization cancelled.");
@@ -8588,7 +8727,7 @@ async function initCommand() {
   const schemaPath = await inputPrompt("Schema directory", schemaDir);
   const migrationsPath = await inputPrompt("Migrations output directory", migrationsDir);
   const configPath = `housekit.config.${fileType}`;
-  const configContent = fileType === "ts" ? `import type { HouseKitConfig } from '@housekit/kit';
+  const configContent = fileType === "ts" ? `import type { HouseKitConfig } from '@housekit/orm';
 
 export default {
     schema: "${schemaPath}",
@@ -8621,25 +8760,24 @@ export default {
 `;
   writeFileSync4(configPath, configContent);
   success(`Created ${quoteName(configPath)}`);
-  if (!existsSync6(schemaPath)) {
+  if (!existsSync7(schemaPath)) {
     mkdirSync4(schemaPath, { recursive: true });
     success(`Created schema directory: ${quoteName(schemaPath)}`);
     const exampleSchemaPath = join7(schemaPath, `logs.${fileType}`);
     const exampleSchemaContent = `// Example table - This is a sample schema file to demonstrate HouseKit usage
 import { t, defineTable, Engine } from '@housekit/orm';
 
-export const logs = defineTable('logs', (t) => ({
+export const logs = defineTable('logs', {
     id: t.uuid('id').autoGenerate().primaryKey(),
-    message: t.text('message').comment('Log message content'),
+    message: t.string('message').comment('Log message content'),
     level: t.enum('level', ['info', 'warning', 'error']).default('info').comment('Log severity level'),
-    tags: t.array(t.text('tag')).nullable().comment('Array of tags for categorizing logs'),
+    tags: t.array(t.string('tag')).nullable().comment('Array of tags for categorizing logs'),
     metadata: t.json('metadata').nullable().comment('Additional log metadata'),
     createdAt: t.timestamp('created_at').default('now()'),
-}), {
+}, {
     engine: Engine.MergeTree(),
     orderBy: ['createdAt', 'id'],
-    appendOnly: false,
-    metadataVersion: "1.2.0"
+    appendOnly: false
 });
 `;
     writeFileSync4(exampleSchemaPath, exampleSchemaContent);
@@ -8647,7 +8785,7 @@ export const logs = defineTable('logs', (t) => ({
   } else {
     info(`Schema directory already exists: ${quoteName(schemaPath)}`);
   }
-  if (!existsSync6(migrationsPath)) {
+  if (!existsSync7(migrationsPath)) {
     mkdirSync4(migrationsPath, { recursive: true });
     success(`Created migrations directory: ${quoteName(migrationsPath)}`);
   } else {
@@ -8972,3 +9110,6 @@ program.command("list").description("List all tables in the database with basic
 program.command("validate").description("Validate that code schema matches the database schema").option("-d, --database <name>", "Database to use").option("--auto-upgrade-metadata", "Automatically upgrade housekit metadata to the version declared in code").action(withErrorHandling(validateCommand));
 program.command("help").description("Show help").action(() => program.outputHelp());
 await program.parseAsync(process.argv);
+export {
+  validateConfig
+};

package/dist/validation.d.ts

@@ -0,0 +1,19 @@
+import type { HouseKitConfig } from './config';
+export interface ValidationError {
+    field: string;
+    message: string;
+    severity: 'error' | 'warning';
+}
+export interface ValidationResult {
+    valid: boolean;
+    errors: ValidationError[];
+    warnings: ValidationError[];
+}
+export interface ValidateConfigOptions {
+    rootDir?: string;
+    skipPathValidation?: boolean;
+}
+/**
+ * Validate HouseKit configuration
+ */
+export declare function validateConfig(config: HouseKitConfig, options?: ValidateConfigOptions): ValidationResult;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@housekit/kit",
-    "version": "0.1.12",
+    "version": "0.1.14",
     "description": "CLI tool for HouseKit - manage ClickHouse schemas, migrations, and database operations with type-safe workflows.",
     "type": "module",
     "main": "./dist/index.js",
@@ -48,7 +48,7 @@
     },
     "dependencies": {
         "@clickhouse/client": "^1.14.0",
-        "@housekit/orm": "^0.1.12",
+        "@housekit/orm": "^0.1.13",
         "chalk": "^5.6.2",
         "cli-table3": "^0.6.5",
         "commander": "^12.0.0",
@@ -67,4 +67,4 @@
     "engines": {
         "node": ">=18.0.0"
     }
-}
+}