langaro-api 1.2.5 → 1.2.7

package/bin/langaro-api.js

@@ -74,23 +74,23 @@ function confirm(question) {
 
 // ── Command runners ──
 
-function runGenerateTypes() {
+async function runGenerateTypes() {
   const { generateTypes } = require('../lib/index');
   const config = loadConfig();
-  generateTypes(config);
+  await generateTypes(config);
   console.log('[langaro-api] Types + JSDoc annotations generated.');
 }
 
-function runWatch() {
+async function runWatch() {
   const { generateTypes, getWatchDirs } = require('../lib/index');
 
-  function generate() {
+  async function generate() {
     const config = loadConfig();
-    generateTypes(config);
+    await generateTypes(config);
     console.log('[langaro-api] Types + JSDoc annotations generated.');
   }
 
-  generate();
+  await generate();
 
   const config = loadConfig();
   const dirs = getWatchDirs(config);
@@ -102,7 +102,7 @@ function runWatch() {
         if (filename && filename.endsWith('.js')) {
           if (debounceTimer) clearTimeout(debounceTimer);
           debounceTimer = setTimeout(() => {
-            try { generate(); } catch (err) { console.error('[langaro-api] Error:', err.message); }
+            generate().catch((err) => console.error('[langaro-api] Error:', err.message));
           }, 300);
         }
       });
@@ -153,13 +153,13 @@ async function main() {
   if (command === 'update-docs') { runUpdateDocs(); return process.exit(0); }
   if (command === '--watch') return runWatch();
   if (command === 'generate' || command === 'types') {
-    runGenerateTypes();
+    await runGenerateTypes();
     return process.exit(0);
   }
 
   // No args + non-TTY (e.g. piped, CI): just generate types
   if (!process.stdin.isTTY) {
-    runGenerateTypes();
+    await runGenerateTypes();
     return process.exit(0);
   }
 
@@ -176,7 +176,7 @@ async function main() {
 
   console.log('');
 
-  if (choice === 'types') { runGenerateTypes(); process.exit(0); }
+  if (choice === 'types') { await runGenerateTypes(); process.exit(0); }
   if (choice === 'new') return runNew();
   if (choice === 'migrate') return runMigrate();
   if (choice === 'init') return runInit();

package/lib/cli/new.js

@@ -2,6 +2,7 @@ const fs = require('fs');
 const path = require('path');
 const readline = require('readline');
 const { pascalCase } = require('../utils');
+const { fetchTablesFromDatabase } = require('../db');
 
 const DEFAULTS = {
   services: 'src/database/services',
@@ -181,44 +182,6 @@ function singleSelect(question, allOptions) {
   });
 }
 
-async function fetchTablesFromDatabase() {
-  try {
-    // Resolve modules from the project's node_modules, not langaro-api's
-    const projectRoot = process.cwd();
-    const resolveFrom = (mod) => require(require.resolve(mod, { paths: [projectRoot] }));
-
-    resolveFrom('dotenv').config({ path: path.join(projectRoot, '.env') });
-
-    const {
-      DB_HOST, DB_USER, DB_PASSWORD, DB_NAME, DB_PORT,
-    } = process.env;
-
-    if (!DB_NAME) {
-      console.log('\x1b[33m  Could not connect to database. DB_NAME not found in .env\x1b[0m');
-      return null;
-    }
-
-    const knex = resolveFrom('knex')({
-      client: 'mysql2',
-      connection: {
-        host: DB_HOST, user: DB_USER, password: DB_PASSWORD, database: DB_NAME, port: DB_PORT,
-      },
-    });
-
-    const results = await knex.raw(
-      'SELECT table_name FROM information_schema.tables WHERE table_schema = ?',
-      [DB_NAME],
-    );
-
-    const tables = results[0].map((row) => row.TABLE_NAME).sort();
-    await knex.destroy();
-    return tables;
-  } catch (err) {
-    console.log(`\x1b[33m  Could not connect to database: ${err.message}\x1b[0m`);
-    return null;
-  }
-}
-
 function multiSelect(rl, question, options) {
   return new Promise((resolve) => {
     const selected = new Set(options.map((_, i) => i));
@@ -393,7 +356,7 @@ async function run(config = {}) {
   if (created.length > 0) {
     // Auto-regenerate types so the new resource gets IntelliSense immediately
     const { generateTypes } = require('../index');
-    generateTypes(cfg);
+    await generateTypes(cfg);
     console.log(`\n\x1b[32mDone!\x1b[0m Created ${created.length} file(s). Types regenerated.\n`);
   } else {
     console.log('\nNo files created (all already exist).\n');

package/lib/db.js

@@ -0,0 +1,41 @@
+const path = require('path');
+
+async function fetchTablesFromDatabase() {
+  try {
+    // Resolve modules from the project's node_modules, not langaro-api's
+    const projectRoot = process.cwd();
+    const resolveFrom = (mod) => require(require.resolve(mod, { paths: [projectRoot] }));
+
+    resolveFrom('dotenv').config({ path: path.join(projectRoot, '.env') });
+
+    const {
+      DB_HOST, DB_USER, DB_PASSWORD, DB_NAME, DB_PORT,
+    } = process.env;
+
+    if (!DB_NAME) {
+      console.log('\x1b[33m  Could not connect to database. DB_NAME not found in .env\x1b[0m');
+      return null;
+    }
+
+    const knex = resolveFrom('knex')({
+      client: 'mysql2',
+      connection: {
+        host: DB_HOST, user: DB_USER, password: DB_PASSWORD, database: DB_NAME, port: DB_PORT,
+      },
+    });
+
+    const results = await knex.raw(
+      'SELECT table_name FROM information_schema.tables WHERE table_schema = ?',
+      [DB_NAME],
+    );
+
+    const tables = results[0].map((row) => row.TABLE_NAME).sort();
+    await knex.destroy();
+    return tables;
+  } catch (err) {
+    console.log(`\x1b[33m  Could not connect to database: ${err.message}\x1b[0m`);
+    return null;
+  }
+}
+
+module.exports = { fetchTablesFromDatabase };

package/lib/generators/crud.js

@@ -140,7 +140,7 @@ module.exports = function generateCrudDts(projectRoot, outputDir) {
 
   addMethodMapping(lines, 'appendItems');
   lines.push('  appendItems(');
-  lines.push('    items: any[], appendArr: string[], appendOptions?: Record<string, any>, transaction?: any');
+  lines.push('    items: any[], appendArr: string[], appendOptions?: Record<string, AppendTableOptions>, transaction?: any');
   lines.push('  ): Promise<any[]>;');
   addMethodMapping(lines, 'refreshCache');
   lines.push('  refreshCache(transaction?: any): Promise<void>;');
@@ -161,12 +161,32 @@ module.exports = function generateCrudDts(projectRoot, outputDir) {
 
   // Options interfaces (no source mappings needed)
   lines.push(
+    "declare type AndWhereOperator = '=' | '>' | '>=' | '<' | '<=' | '<>' | 'in' | 'not in' | 'between' | 'not between' | 'like' | 'json_overlaps';",
+    '',
+    '/** A condition with an explicit operator: [field, operator, value] */',
+    'declare type AndWhereConditionWithOperator = [string, AndWhereOperator, any];',
+    '/** A condition using the default "=" operator: [field, value] */',
+    'declare type AndWhereConditionWithoutOperator = [string, any];',
+    '',
+    'declare type AndWhereCondition = AndWhereConditionWithOperator | AndWhereConditionWithoutOperator;',
+    '',
+    '/** Options for an appended (related) table inside appendOptions */',
+    'declare interface AppendTableOptions {',
+    '  /** Filter conditions applied to the appended table */',
+    '  andWhere?: AndWhereCondition[];',
+    '  /** Select only these columns from the appended table */',
+    '  showOnly?: string | string[];',
+    '  /** Fields to show (overrides hide list) */',
+    '  show?: string[];',
+    '  [key: string]: any;',
+    '}',
+    '',
     'declare interface CRUDGetOptions {',
     '  perPage?: number;',
     '  currentPage?: number;',
     '  append?: string[];',
-    '  appendOptions?: Record<string, any>;',
-    '  andWhere?: Array<[string, string, any]>;',
+    '  appendOptions?: Record<string, AppendTableOptions>;',
+    '  andWhere?: AndWhereCondition[];',
     '  search?: string;',
     '  searchExactMatch?: boolean;',
     '  searchFields?: string[];',
@@ -189,7 +209,7 @@ module.exports = function generateCrudDts(projectRoot, outputDir) {
     '  allowForbiddenUpdates?: boolean;',
     '  extraValidations?: Array<(data: any) => void>;',
     '  where?: (query: any) => any;',
-    '  andWhere?: Array<[string, string, any]>;',
+    '  andWhere?: AndWhereCondition[];',
     '  whenSuccess?: (data: any) => void;',
     '  /** Skip automatic Redis query cache invalidation */',
     '  skipCacheInvalidation?: boolean;',
@@ -204,7 +224,7 @@ module.exports = function generateCrudDts(projectRoot, outputDir) {
     '',
     'declare interface CRUDDeleteOptions {',
     '  where?: (query: any) => any;',
-    '  andWhere?: Array<[string, string, any]>;',
+    '  andWhere?: AndWhereCondition[];',
     '  /** Skip automatic Redis query cache invalidation */',
     '  skipCacheInvalidation?: boolean;',
     '  [key: string]: any;',

package/lib/generators/services.js

@@ -3,7 +3,7 @@ const path = require('path');
 const { pascalCase, extractMethodsWithLocations, isCustomService } = require('../utils');
 const { generateSourceMap } = require('../sourcemap');
 
-module.exports = function generateServicesDts(servicesDir, modelsDir, outputDir) {
+module.exports = function generateServicesDts(servicesDir, modelsDir, outputDir, dbTableNames = []) {
   const lines = ['// Auto-generated by langaro-api — DO NOT EDIT', ''];
   const serviceEntries = [];
   const mappings = [];
@@ -89,6 +89,22 @@ module.exports = function generateServicesDts(servicesDir, modelsDir, outputDir)
       });
   }
 
+  // DB tables discovered via introspection — pure CRUD (no file on disk)
+  dbTableNames
+    .sort()
+    .forEach((tableName) => {
+      const serviceName = `${pascalCase(tableName)}Services`;
+      if (serviceEntries.find((e) => e.serviceName === serviceName)) return;
+      const interfaceName = `I${serviceName}`;
+      lines.push(`declare interface ${interfaceName} extends CRUD {}`, '');
+      serviceEntries.push({
+        interfaceName,
+        serviceName,
+        tableName,
+        custom: false,
+      });
+    });
+
   // ServicesMap
   lines.push('declare interface ServicesMap {');
   serviceEntries

package/lib/index.js

@@ -27,7 +27,7 @@ const DEFAULTS = {
   middlewares: 'src/middlewares',
 };
 
-function generateTypes(userConfig = {}) {
+async function generateTypes(userConfig = {}) {
   const config = { ...DEFAULTS, ...userConfig };
   const root = config.root;
 
@@ -51,7 +51,11 @@ function generateTypes(userConfig = {}) {
     fs.writeFileSync(path.join(outputDir, 'crud.d.ts.map'), crud.sourceMap);
   }
 
-  const services = generateServicesDts(servicesDir, modelsDir, outputDir);
+  // Discover DB tables via introspection (same as loadModels does at runtime)
+  const { fetchTablesFromDatabase } = require('./db');
+  const dbTableNames = await fetchTablesFromDatabase() || [];
+
+  const services = generateServicesDts(servicesDir, modelsDir, outputDir, dbTableNames);
   fs.writeFileSync(path.join(outputDir, 'services.d.ts'), services.content);
   fs.writeFileSync(path.join(outputDir, 'services.d.ts.map'), services.sourceMap);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "langaro-api",
-  "version": "1.2.5",
+  "version": "1.2.7",
   "description": "Auto-generate TypeScript types, JSDoc annotations, and boilerplate loaders for knex-extended-crud projects",
   "main": "lib/index.js",
   "bin": {
@@ -22,7 +22,7 @@
   ],
   "peerDependencies": {
     "cron": ">=3.0.0",
-    "knex-extended-crud": ">=2.1.3"
+    "knex-extended-crud": ">=2.1.5"
   },
   "peerDependenciesMeta": {
     "cron": {