create-jen-app 1.2.1 → 1.2.3

package/templates/static/lib/db/connector.d.ts

@@ -1,4 +1,30 @@
 import { DBConfig, IDBDriver } from "./types";
+/**
+ * Factory class for creating database driver instances.
+ * The DBConnector uses the factory pattern to instantiate the appropriate driver
+ * based on the configured database type. This allows the application to support
+ * multiple database backends without tight coupling to any single implementation.
+ *
+ * Supported database types:
+ * - jdb: Embedded JSON database (built-in, no external dependencies)
+ * - sqlite: SQLite relational database
+ * - postgres: PostgreSQL relational database
+ * - mysql: MySQL relational database
+ */
 export declare class DBConnector {
-    static create(config: DBConfig): IDBDriver;
+  /**
+   * Creates and returns a database driver instance based on the configuration.
+   * The driver implements the IDBDriver interface and provides the same API
+   * regardless of the underlying database type.
+   *
+   * @param config The database configuration including type and connection parameters.
+   * @returns An IDBDriver instance for the specified database type.
+   * @throws Error if the configured database type is not supported.
+   *
+   * @example
+   * const config: DBConfig = { type: 'sqlite', path: './data.db' };
+   * const driver = DBConnector.create(config);
+   * const records = await driver.query('SELECT * FROM users');
+   */
+  static create(config: DBConfig): IDBDriver;
 }

package/templates/static/lib/db/connector.js

@@ -17,17 +17,43 @@
  */
 import { JDBDriver } from "./drivers/jdb";
 import { SQLDriver } from "./drivers/sql";
+/**
+ * Factory class for creating database driver instances.
+ * The DBConnector uses the factory pattern to instantiate the appropriate driver
+ * based on the configured database type. This allows the application to support
+ * multiple database backends without tight coupling to any single implementation.
+ *
+ * Supported database types:
+ * - jdb: Embedded JSON database (built-in, no external dependencies)
+ * - sqlite: SQLite relational database
+ * - postgres: PostgreSQL relational database
+ * - mysql: MySQL relational database
+ */
 export class DBConnector {
-    static create(config) {
-        switch (config.type) {
-            case "jdb":
-                return new JDBDriver(config);
-            case "sqlite":
-            case "postgres":
-            case "mysql":
-                return new SQLDriver(config);
-            default:
-                throw new Error(`Unsupported DB type: ${config.type}`);
-        }
+  /**
+   * Creates and returns a database driver instance based on the configuration.
+   * The driver implements the IDBDriver interface and provides the same API
+   * regardless of the underlying database type.
+   *
+   * @param config The database configuration including type and connection parameters.
+   * @returns An IDBDriver instance for the specified database type.
+   * @throws Error if the configured database type is not supported.
+   *
+   * @example
+   * const config: DBConfig = { type: 'sqlite', path: './data.db' };
+   * const driver = DBConnector.create(config);
+   * const records = await driver.query('SELECT * FROM users');
+   */
+  static create(config) {
+    switch (config.type) {
+      case "jdb":
+        return new JDBDriver(config);
+      case "sqlite":
+      case "postgres":
+      case "mysql":
+        return new SQLDriver(config);
+      default:
+        throw new Error(`Unsupported DB type: ${config.type}`);
     }
+  }
 }

package/templates/static/lib/db/drivers/jdb.d.ts

@@ -1,13 +1,17 @@
 import { IDBDriver, DBConfig, UnifiedQuery } from "../types";
 import { Filter, Update } from "../../jdb/types";
 export declare class JDBDriver implements IDBDriver {
-    private engine;
-    constructor(config: DBConfig);
-    connect(): Promise<void>;
-    disconnect(): Promise<void>;
-    query<T = any>(q: UnifiedQuery<T>): Promise<T[]>;
-    create<T = any>(collection: string, data: any): Promise<T>;
-    update<T = any>(collection: string, filter: Filter<T>, update: Update<T>): Promise<number>;
-    delete<T = any>(collection: string, filter: Filter<T>): Promise<number>;
-    count<T = any>(collection: string, filter: Filter<T>): Promise<number>;
+  private engine;
+  constructor(config: DBConfig);
+  connect(): Promise<void>;
+  disconnect(): Promise<void>;
+  query<T = any>(q: UnifiedQuery<T>): Promise<T[]>;
+  create<T = any>(collection: string, data: any): Promise<T>;
+  update<T = any>(
+    collection: string,
+    filter: Filter<T>,
+    update: Update<T>,
+  ): Promise<number>;
+  delete<T = any>(collection: string, filter: Filter<T>): Promise<number>;
+  count<T = any>(collection: string, filter: Filter<T>): Promise<number>;
 }

package/templates/static/lib/db/drivers/jdb.js

@@ -17,43 +17,45 @@
  */
 import { JDBEngine } from "../../jdb";
 export class JDBDriver {
-    engine;
-    constructor(config) {
-        const jdbConfig = config.jdb || {
-            root: "./data",
-            inMemory: false,
-        };
-        this.engine = new JDBEngine(jdbConfig);
-    }
-    async connect() {
-        await this.engine.connect();
-    }
-    async disconnect() {
-        await this.engine.disconnect();
-    }
-    async query(q) {
-        if (typeof q === "string") {
-            throw new Error("Raw string queries not supported in JDB directly. Use object syntax.");
-        }
-        if ("sql" in q) {
-            throw new Error("SQL queries not supported in JDB driver.");
-        }
-        const query = q;
-        const coll = this.engine.collection(query.find);
-        return await coll.find(query.where || {}, query.options);
-    }
-    async create(collection, data) {
-        return await this.engine.collection(collection).insert(data);
-    }
-    async update(collection, filter, update) {
-        return await this.engine
-            .collection(collection)
-            .update(filter, update, true);
-    }
-    async delete(collection, filter) {
-        return await this.engine.collection(collection).delete(filter, true);
-    }
-    async count(collection, filter) {
-        return await this.engine.collection(collection).count(filter);
-    }
+  engine;
+  constructor(config) {
+    const jdbConfig = config.jdb || {
+      root: "./data",
+      inMemory: false,
+    };
+    this.engine = new JDBEngine(jdbConfig);
+  }
+  async connect() {
+    await this.engine.connect();
+  }
+  async disconnect() {
+    await this.engine.disconnect();
+  }
+  async query(q) {
+    if (typeof q === "string") {
+      throw new Error(
+        "Raw string queries not supported in JDB directly. Use object syntax.",
+      );
+    }
+    if ("sql" in q) {
+      throw new Error("SQL queries not supported in JDB driver.");
+    }
+    const query = q;
+    const coll = this.engine.collection(query.find);
+    return await coll.find(query.where || {}, query.options);
+  }
+  async create(collection, data) {
+    return await this.engine.collection(collection).insert(data);
+  }
+  async update(collection, filter, update) {
+    return await this.engine
+      .collection(collection)
+      .update(filter, update, true);
+  }
+  async delete(collection, filter) {
+    return await this.engine.collection(collection).delete(filter, true);
+  }
+  async count(collection, filter) {
+    return await this.engine.collection(collection).count(filter);
+  }
 }

package/templates/static/lib/db/drivers/sql.d.ts

@@ -1,18 +1,22 @@
 import { IDBDriver, DBConfig, UnifiedQuery } from "../types";
 import { Filter, Update } from "../../jdb/types";
 /**
-  * Validate and register allowed table/collection names for security
-  */
+ * Validate and register allowed table/collection names for security
+ */
 export declare function registerAllowedTable(tableName: string): void;
 export declare class SQLDriver implements IDBDriver {
-    private executor;
-    constructor(config: DBConfig);
-    connect(): Promise<void>;
-    disconnect(): Promise<void>;
-    query<T = any>(q: UnifiedQuery<T>): Promise<T[]>;
-    private translateQuery;
-    create<T = any>(collection: string, data: any): Promise<T>;
-    update<T = any>(collection: string, filter: Filter<T>, update: Update<T>): Promise<number>;
-    delete<T = any>(collection: string, filter: Filter<T>): Promise<number>;
-    count<T = any>(collection: string, filter: Filter<T>): Promise<number>;
+  private executor;
+  constructor(config: DBConfig);
+  connect(): Promise<void>;
+  disconnect(): Promise<void>;
+  query<T = any>(q: UnifiedQuery<T>): Promise<T[]>;
+  private translateQuery;
+  create<T = any>(collection: string, data: any): Promise<T>;
+  update<T = any>(
+    collection: string,
+    filter: Filter<T>,
+    update: Update<T>,
+  ): Promise<number>;
+  delete<T = any>(collection: string, filter: Filter<T>): Promise<number>;
+  count<T = any>(collection: string, filter: Filter<T>): Promise<number>;
 }

package/templates/static/lib/db/drivers/sql.js

@@ -18,165 +18,182 @@
 // Whitelist of allowed identifiers (table/column names) - must be explicitly allowed
 const ALLOWED_IDENTIFIERS = new Set();
 /**
-  * Safely quote SQL identifier to prevent injection
-  * Only accepts alphanumeric, underscore, dollar sign
-  * Note: Hyphen is NOT allowed as it can cause confusion with operators
-  */
+ * Safely quote SQL identifier to prevent injection
+ * Only accepts alphanumeric, underscore, dollar sign
+ * Note: Hyphen is NOT allowed as it can cause confusion with operators
+ */
 function quoteIdentifier(id) {
-    if (!id || !/^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(id)) {
-        throw new Error(`Invalid SQL identifier: ${id}. Only alphanumeric, underscore, and dollar sign allowed. Must start with letter, underscore, or dollar.`);
-    }
-    return `\`${id}\``; // Use backticks for MySQL, adjust for other databases
+  if (!id || !/^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(id)) {
+    throw new Error(
+      `Invalid SQL identifier: ${id}. Only alphanumeric, underscore, and dollar sign allowed. Must start with letter, underscore, or dollar.`,
+    );
+  }
+  return `\`${id}\``; // Use backticks for MySQL, adjust for other databases
 }
 /**
-  * Validate and register allowed table/collection names for security
-  */
+ * Validate and register allowed table/collection names for security
+ */
 export function registerAllowedTable(tableName) {
-    if (/^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(tableName)) {
-        ALLOWED_IDENTIFIERS.add(tableName);
-    }
-    else {
-        throw new Error(`Invalid table name: ${tableName}. Must start with letter, underscore, or dollar. Only alphanumeric, underscore, and dollar allowed.`);
-    }
+  if (/^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(tableName)) {
+    ALLOWED_IDENTIFIERS.add(tableName);
+  } else {
+    throw new Error(
+      `Invalid table name: ${tableName}. Must start with letter, underscore, or dollar. Only alphanumeric, underscore, and dollar allowed.`,
+    );
+  }
 }
 /**
  * Check if table is in allowed list
  */
 function isTableAllowed(tableName) {
-    return ALLOWED_IDENTIFIERS.has(tableName);
+  return ALLOWED_IDENTIFIERS.has(tableName);
 }
 /**
  * Validate integer value (for LIMIT/OFFSET)
  */
 function validateInteger(value) {
-    const num = parseInt(value, 10);
-    if (isNaN(num) || num < 0) {
-        throw new Error(`Invalid integer value: ${value}`);
-    }
-    return num;
+  const num = parseInt(value, 10);
+  if (isNaN(num) || num < 0) {
+    throw new Error(`Invalid integer value: ${value}`);
+  }
+  return num;
 }
 export class SQLDriver {
-    executor;
-    constructor(config) {
-        if (typeof config.connection === "function") {
-            this.executor = config.connection;
-        }
-        else if (config.connection && config.connection.query) {
-            // Support objects like Pool or Client from pg/mysql
-            this.executor = (sql, params) => config.connection.query(sql, params);
-        }
-        else {
-            // Default stub that warns if no connection provided, or we could try to load a default
-            this.executor = async () => {
-                throw new Error("No SQL connection provided to SQLDriver");
-            };
-        }
+  executor;
+  constructor(config) {
+    if (typeof config.connection === "function") {
+      this.executor = config.connection;
+    } else if (config.connection && config.connection.query) {
+      // Support objects like Pool or Client from pg/mysql
+      this.executor = (sql, params) => config.connection.query(sql, params);
+    } else {
+      // Default stub that warns if no connection provided, or we could try to load a default
+      this.executor = async () => {
+        throw new Error("No SQL connection provided to SQLDriver");
+      };
     }
-    async connect() {
-        // Connection management usually handled by the pool passed in, but we can add logic here if needed
+  }
+  async connect() {
+    // Connection management usually handled by the pool passed in, but we can add logic here if needed
+  }
+  async disconnect() {
+    // No-op or close pool
+  }
+  async query(q) {
+    if (typeof q === "string") {
+      return this.executor(q, []);
     }
-    async disconnect() {
-        // No-op or close pool
+    if ("sql" in q) {
+      return this.executor(q.sql, q.params || []);
     }
-    async query(q) {
-        if (typeof q === "string") {
-            return this.executor(q, []);
-        }
-        if ("sql" in q) {
-            return this.executor(q.sql, q.params || []);
-        }
-        // Convert NoSQL style to SQL (Basic translation)
-        const query = q;
-        const { sql, params } = this.translateQuery(query);
-        return this.executor(sql, params);
+    // Convert NoSQL style to SQL (Basic translation)
+    const query = q;
+    const { sql, params } = this.translateQuery(query);
+    return this.executor(sql, params);
+  }
+  translateQuery(q) {
+    // Security: Validate table name
+    if (!isTableAllowed(q.find)) {
+      throw new Error(
+        `Table '${q.find}' not registered. Call registerAllowedTable() first.`,
+      );
     }
-    translateQuery(q) {
-        // Security: Validate table name
-        if (!isTableAllowed(q.find)) {
-            throw new Error(`Table '${q.find}' not registered. Call registerAllowedTable() first.`);
+    let sql = `SELECT * FROM ${quoteIdentifier(q.find)}`;
+    const params = [];
+    if (q.where && Object.keys(q.where).length > 0) {
+      const conditions = [];
+      const whereRecord = q.where;
+      for (const key in whereRecord) {
+        // Security: Validate column name
+        if (!/^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(key)) {
+          throw new Error(
+            `Invalid column name: ${key}. Must start with letter, underscore, or dollar. Only alphanumeric, underscore, and dollar allowed.`,
+          );
         }
-        let sql = `SELECT * FROM ${quoteIdentifier(q.find)}`;
-        const params = [];
-        if (q.where && Object.keys(q.where).length > 0) {
-            const conditions = [];
-            const whereRecord = q.where;
-            for (const key in whereRecord) {
-                // Security: Validate column name
-                if (!/^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(key)) {
-                    throw new Error(`Invalid column name: ${key}. Must start with letter, underscore, or dollar. Only alphanumeric, underscore, and dollar allowed.`);
-                }
-                // Safely access where property
-                const val = whereRecord[key];
-                conditions.push(`${quoteIdentifier(key)} = ?`);
-                params.push(val);
-            }
-            sql += ` WHERE ${conditions.join(" AND ")}`;
-        }
-        if (q.options?.limit) {
-            // Security: Validate limit is a positive integer
-            const limit = validateInteger(q.options.limit);
-            sql += ` LIMIT ${limit}`;
-        }
-        if (q.options?.skip) {
-            // Security: Validate offset is a non-negative integer
-            const skip = validateInteger(q.options.skip);
-            sql += ` OFFSET ${skip}`;
-        }
-        return { sql, params };
+        // Safely access where property
+        const val = whereRecord[key];
+        conditions.push(`${quoteIdentifier(key)} = ?`);
+        params.push(val);
+      }
+      sql += ` WHERE ${conditions.join(" AND ")}`;
     }
-    async create(collection, data) {
-        // Security: Validate table name
-        if (!isTableAllowed(collection)) {
-            throw new Error(`Table '${collection}' not registered. Call registerAllowedTable() first.`);
-        }
-        const keys = Object.keys(data);
-        // Security: Validate all column names
-        for (const key of keys) {
-            if (!/^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(key)) {
-                throw new Error(`Invalid column name: ${key}. Must start with letter, underscore, or dollar. Only alphanumeric, underscore, and dollar allowed.`);
-            }
-        }
-        const placeholders = keys.map(() => "?").join(",");
-        const quotedKeys = keys.map((k) => quoteIdentifier(k)).join(",");
-        const sql = `INSERT INTO ${quoteIdentifier(collection)} (${quotedKeys}) VALUES (${placeholders})`;
-        const params = keys.map((k) => data[k]);
-        await this.executor(sql, params);
-        // Retrieve generic - this might need adjustment per driver for "returning" support
-        return data;
+    if (q.options?.limit) {
+      // Security: Validate limit is a positive integer
+      const limit = validateInteger(q.options.limit);
+      sql += ` LIMIT ${limit}`;
     }
-    async update(collection, filter, update) {
-        // Basic implementation requiring WHERE clause
-        // This is complex to map generic Mongo-style updates to SQL without a robust builder
-        throw new Error("Complex update translation not implemented for Generic SQL Driver yet. Use raw SQL.");
+    if (q.options?.skip) {
+      // Security: Validate offset is a non-negative integer
+      const skip = validateInteger(q.options.skip);
+      sql += ` OFFSET ${skip}`;
     }
-    async delete(collection, filter) {
-        // Security: Validate table name
-        if (!isTableAllowed(collection)) {
-            throw new Error(`Table '${collection}' not registered. Call registerAllowedTable() first.`);
-        }
-        // Validate that filter is not empty to prevent accidental full table delete
-        if (!filter || Object.keys(filter).length === 0) {
-            throw new Error("Delete requires at least one filter condition. Use truncate or raw SQL for full table deletion.");
-        }
-        const { sql, params } = this.translateQuery({
-            find: collection,
-            where: filter,
-        });
-        const deleteSql = sql.replace("SELECT \\*", "DELETE");
-        await this.executor(deleteSql, params);
-        return 1; // Unknown count without driver specific result
+    return { sql, params };
+  }
+  async create(collection, data) {
+    // Security: Validate table name
+    if (!isTableAllowed(collection)) {
+      throw new Error(
+        `Table '${collection}' not registered. Call registerAllowedTable() first.`,
+      );
     }
-    async count(collection, filter) {
-        // Security: Validate table name
-        if (!isTableAllowed(collection)) {
-            throw new Error(`Table '${collection}' not registered. Call registerAllowedTable() first.`);
-        }
-        const { sql, params } = this.translateQuery({
-            find: collection,
-            where: filter,
-        });
-        const countSql = sql.replace("SELECT *", "SELECT COUNT(*) as count");
-        const res = await this.executor(countSql, params);
-        return res[0]?.count || 0;
+    const keys = Object.keys(data);
+    // Security: Validate all column names
+    for (const key of keys) {
+      if (!/^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(key)) {
+        throw new Error(
+          `Invalid column name: ${key}. Must start with letter, underscore, or dollar. Only alphanumeric, underscore, and dollar allowed.`,
+        );
+      }
+    }
+    const placeholders = keys.map(() => "?").join(",");
+    const quotedKeys = keys.map((k) => quoteIdentifier(k)).join(",");
+    const sql = `INSERT INTO ${quoteIdentifier(collection)} (${quotedKeys}) VALUES (${placeholders})`;
+    const params = keys.map((k) => data[k]);
+    await this.executor(sql, params);
+    // Retrieve generic - this might need adjustment per driver for "returning" support
+    return data;
+  }
+  async update(collection, filter, update) {
+    // Basic implementation requiring WHERE clause
+    // This is complex to map generic Mongo-style updates to SQL without a robust builder
+    throw new Error(
+      "Complex update translation not implemented for Generic SQL Driver yet. Use raw SQL.",
+    );
+  }
+  async delete(collection, filter) {
+    // Security: Validate table name
+    if (!isTableAllowed(collection)) {
+      throw new Error(
+        `Table '${collection}' not registered. Call registerAllowedTable() first.`,
+      );
+    }
+    // Validate that filter is not empty to prevent accidental full table delete
+    if (!filter || Object.keys(filter).length === 0) {
+      throw new Error(
+        "Delete requires at least one filter condition. Use truncate or raw SQL for full table deletion.",
+      );
+    }
+    const { sql, params } = this.translateQuery({
+      find: collection,
+      where: filter,
+    });
+    const deleteSql = sql.replace("SELECT \\*", "DELETE");
+    await this.executor(deleteSql, params);
+    return 1; // Unknown count without driver specific result
+  }
+  async count(collection, filter) {
+    // Security: Validate table name
+    if (!isTableAllowed(collection)) {
+      throw new Error(
+        `Table '${collection}' not registered. Call registerAllowedTable() first.`,
+      );
     }
+    const { sql, params } = this.translateQuery({
+      find: collection,
+      where: filter,
+    });
+    const countSql = sql.replace("SELECT *", "SELECT COUNT(*) as count");
+    const res = await this.executor(countSql, params);
+    return res[0]?.count || 0;
+  }
 }

package/templates/static/lib/db/index.d.ts

@@ -4,16 +4,24 @@ export * from "./types";
 export * from "./drivers/jdb";
 export * from "./drivers/sql";
 export declare class DB {
-    private driver;
-    private config;
-    constructor(config: DBConfig);
-    connect(): Promise<void>;
-    disconnect(): Promise<void>;
-    query<T = any>(q: UnifiedQuery<T> | string, params?: any[]): Promise<T[]>;
-    find<T = any>(collection: string, filter?: Filter<T>, options?: any): Promise<T[]>;
-    findOne<T = any>(collection: string, filter: Filter<T>): Promise<T | null>;
-    create<T = any>(collection: string, data: any): Promise<T>;
-    update<T = any>(collection: string, filter: Filter<T>, update: Update<T>): Promise<number>;
-    delete<T = any>(collection: string, filter: Filter<T>): Promise<number>;
-    count<T = any>(collection: string, filter: Filter<T>): Promise<number>;
+  private driver;
+  private config;
+  constructor(config: DBConfig);
+  connect(): Promise<void>;
+  disconnect(): Promise<void>;
+  query<T = any>(q: UnifiedQuery<T> | string, params?: any[]): Promise<T[]>;
+  find<T = any>(
+    collection: string,
+    filter?: Filter<T>,
+    options?: any,
+  ): Promise<T[]>;
+  findOne<T = any>(collection: string, filter: Filter<T>): Promise<T | null>;
+  create<T = any>(collection: string, data: any): Promise<T>;
+  update<T = any>(
+    collection: string,
+    filter: Filter<T>,
+    update: Update<T>,
+  ): Promise<number>;
+  delete<T = any>(collection: string, filter: Filter<T>): Promise<number>;
+  count<T = any>(collection: string, filter: Filter<T>): Promise<number>;
 }