Add 'db' export support and alias in REPL command

Updated the REPL CLI to recognize 'db' as a valid export from config files, in addition to 'app' and 'objectql'. Also added 'db' as an alias in the REPL context for easier access, and updated example config to use 'db' instead of 'app'.

Author: hotlong

examples/project-management/objectql.config.ts

@@ -1,21 +1,9 @@
-import { ObjectQL, MetadataLoader } from '@objectql/core';
-import { KnexDriver } from '@objectql/driver-knex';
+import { ObjectQL } from '@objectql/core';
 import * as path from 'path';
 
-const app = new ObjectQL({
-    datasources: {
-        default: new KnexDriver({
-            client: 'sqlite3',
-            connection: {
-                filename: path.join(__dirname, 'dev.sqlite3')
-            },
-            useNullAsDefault: true
-        })
-    }
+const db = new ObjectQL({
+    connection: `sqlite://${path.join(__dirname, 'dev.sqlite3')}`,
+    source: path.join(__dirname, 'src')
 });
 
-// Load objects from src
-const loader = new MetadataLoader(app.metadata);
-loader.load(path.join(__dirname, 'src')); 
-
-export default app;
+export default db;

packages/cli/src/commands/repl.ts

@@ -37,11 +37,11 @@ export async function startRepl(configPath?: string) {
 
     try {
         const configModule = require(path.join(cwd, configFile));
-        // Support default export or named export 'app' or 'objectql'
-        const app = configModule.default || configModule.app || configModule.objectql;
+        // Support default export or named export 'app' or 'objectql' or 'db'
+        const app = configModule.default || configModule.app || configModule.objectql || configModule.db;
 
         if (!(app instanceof ObjectQL)) {
-            console.error("❌ The config file must export an instance of 'ObjectQL' as default or 'app'.");
+            console.error("❌ The config file must export an instance of 'ObjectQL' as default or 'app'/'db'.");
             process.exit(1);
         }
 
@@ -75,6 +75,7 @@ export async function startRepl(configPath?: string) {
 
         // 4. Inject Context
         r.context.app = app;
+        r.context.db = app; // Alias for db
         r.context.object = (name: string) => app.getObject(name);
 
         // Helper to get a repo quickly: tasks.find() instead of app.object('tasks').find()
@@ -108,6 +109,9 @@ export async function startRepl(configPath?: string) {
 
         console.log(`\nAvailable Objects: ${objects.map((o: any) => o.name).join(', ')}`);
         console.log(`Usage: tasks.find()  (Auto-await enabled)`);
+        
+        // Fix for REPL sometimes not showing prompt immediately
+        r.displayPrompt();
 
     } catch (error) {
         console.error("Failed to load or start:", error);

packages/core/src/index.ts

@@ -26,7 +26,15 @@ export class ObjectQL implements IObjectQL {
     constructor(config: ObjectQLConfig) {
         this.metadata = config.registry || new MetadataRegistry();
         this.loader = new MetadataLoader(this.metadata);
-        this.datasources = config.datasources;
+        this.datasources = config.datasources || {};
+        
+        if (config.connection) {
+            this.loadDriverFromConnection(config.connection);
+        }
+
+        if (config.source) {
+            this.loader.load(config.source);
+        }
 
         if (config.objects) {
             for (const [key, obj] of Object.entries(config.objects)) {
@@ -175,6 +183,59 @@ export class ObjectQL implements IObjectQL {
             }
         }
     }
+
+    private loadDriverFromConnection(connection: string) {
+        let driverPackage = '';
+        let driverClass = '';
+        let driverConfig: any = {};
+        
+        if (connection.startsWith('mongodb://')) {
+            driverPackage = '@objectql/driver-mongo';
+            driverClass = 'MongoDriver';
+            driverConfig = { url: connection };
+        } 
+        else if (connection.startsWith('sqlite://')) {
+            driverPackage = '@objectql/driver-knex';
+            driverClass = 'KnexDriver';
+            const filename = connection.replace('sqlite://', '');
+            driverConfig = {
+                client: 'sqlite3',
+                connection: { filename },
+                useNullAsDefault: true
+            };
+        }
+        else if (connection.startsWith('postgres://') || connection.startsWith('postgresql://')) {
+            driverPackage = '@objectql/driver-knex';
+            driverClass = 'KnexDriver';
+            driverConfig = {
+                client: 'pg',
+                connection: connection
+            };
+        }
+        else if (connection.startsWith('mysql://')) {
+            driverPackage = '@objectql/driver-knex';
+            driverClass = 'KnexDriver';
+            driverConfig = {
+                client: 'mysql2',
+                connection: connection
+            };
+        }
+        else {
+            throw new Error(`Unsupported connection protocol: ${connection}`);
+        }
+
+        try {
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            const pkg = require(driverPackage);
+            const DriverClass = pkg[driverClass];
+            if (!DriverClass) {
+                throw new Error(`${driverClass} not found in ${driverPackage}`);
+            }
+            this.datasources['default'] = new DriverClass(driverConfig);
+        } catch (e: any) {
+            throw new Error(`Failed to load driver ${driverPackage}. Please install it: npm install ${driverPackage}. Error: ${e.message}`);
+        }
+    }
 }
 
 export * from './repository';

packages/types/src/types.ts

@@ -27,9 +27,17 @@ export interface IObjectRepository {
 }
 
 export interface ObjectQLConfig {
-
     registry?: MetadataRegistry;
-    datasources: Record<string, Driver>;
+    datasources?: Record<string, Driver>;
+    /**
+     * Optional connection string for auto-configuration.
+     * e.g. "sqlite://dev.db", "postgres://localhost/db", "mongodb://localhost/db"
+     */
+    connection?: string;
+    /**
+     * Path to the directory containing schema files (*.object.yml).
+     */
+    source?: string;
     objects?: Record<string, ObjectConfig>;
     packages?: string[];
 }