create-jen-app 1.2.2 → 1.2.4

package/templates/ssr-isr/lib/css/compiler.d.ts

@@ -0,0 +1,23 @@
+export interface CompileOptions {
+  inputPath: string;
+  outputPath?: string;
+  minified?: boolean;
+  sourceMap?: boolean;
+  watch?: boolean;
+}
+export interface CompileResult {
+  css: string;
+  sourceMap?: string;
+  error?: string;
+}
+export declare class ScssCompiler {
+  compile(options: CompileOptions): CompileResult;
+  compileString(
+    scss: string,
+    options?: {
+      minified?: boolean;
+    },
+  ): CompileResult;
+  compileGlob(pattern: string, outputDir: string, minified?: boolean): number;
+}
+export declare function createScssCompiler(): ScssCompiler;

package/templates/ssr-isr/lib/css/compiler.js

@@ -0,0 +1,74 @@
+import { compile, compileString } from "sass";
+import { globSync } from "glob";
+import { writeFileSync, existsSync, mkdirSync } from "node:fs";
+import { dirname, join, relative } from "node:path";
+import { log } from "../shared/log.js";
+export class ScssCompiler {
+  compile(options) {
+    const {
+      inputPath,
+      outputPath,
+      minified = false,
+      sourceMap = false,
+    } = options;
+    try {
+      if (!existsSync(inputPath)) {
+        return { css: "", error: `File not found: ${inputPath}` };
+      }
+      const result = compile(inputPath, {
+        style: minified ? "compressed" : "expanded",
+        sourceMap,
+      });
+      if (outputPath) {
+        mkdirSync(dirname(outputPath), { recursive: true });
+        writeFileSync(outputPath, result.css);
+        if (result.sourceMap && sourceMap) {
+          writeFileSync(outputPath + ".map", JSON.stringify(result.sourceMap));
+        }
+        log.info(
+          `[SCSS] ✓ ${relative(process.cwd(), inputPath)} → ${relative(process.cwd(), outputPath)}`,
+        );
+      }
+      return {
+        css: result.css,
+        sourceMap: result.sourceMap
+          ? JSON.stringify(result.sourceMap)
+          : undefined,
+      };
+    } catch (err) {
+      const message = err.message || String(err);
+      log.error(`[SCSS] ✗ ${inputPath}: ${message}`);
+      return { css: "", error: message };
+    }
+  }
+  compileString(scss, options) {
+    try {
+      const result = compileString(scss, {
+        style: options?.minified ? "compressed" : "expanded",
+      });
+      return { css: result.css };
+    } catch (err) {
+      const message = err.message || String(err);
+      log.error(`[SCSS] ✗ Inline compilation error: ${message}`);
+      return { css: "", error: message };
+    }
+  }
+  compileGlob(pattern, outputDir, minified = false) {
+    const files = globSync(pattern);
+    let count = 0;
+    files.forEach((file) => {
+      const rel = relative(outputDir, file);
+      const output = join(outputDir, rel.replace(/\.scss$/, ".css"));
+      const result = this.compile({
+        inputPath: file,
+        outputPath: output,
+        minified,
+      });
+      if (!result.error) count++;
+    });
+    return count;
+  }
+}
+export function createScssCompiler() {
+  return new ScssCompiler();
+}

package/templates/ssr-isr/lib/db/connector.d.ts

@@ -0,0 +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 {
+  /**
+   * 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/ssr-isr/lib/db/connector.js

@@ -0,0 +1,42 @@
+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 {
+  /**
+   * 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/ssr-isr/lib/db/drivers/jdb.d.ts

@@ -0,0 +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>;
+}

package/templates/ssr-isr/lib/db/drivers/jdb.js

@@ -0,0 +1,44 @@
+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);
+  }
+}

package/templates/ssr-isr/lib/db/drivers/sql.d.ts

@@ -0,0 +1,22 @@
+import { IDBDriver, DBConfig, UnifiedQuery } from "../types";
+import { Filter, Update } from "../../jdb/types";
+/**
+ * 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>;
+}

package/templates/ssr-isr/lib/db/drivers/sql.js

@@ -0,0 +1,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
+ */
+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
+}
+/**
+ * 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.`,
+    );
+  }
+}
+/**
+ * Check if table is in allowed list
+ */
+function isTableAllowed(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;
+}
+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");
+      };
+    }
+  }
+  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, []);
+    }
+    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);
+  }
+  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.`,
+          );
+        }
+        // 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 };
+  }
+  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;
+  }
+  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/ssr-isr/lib/db/index.d.ts

@@ -0,0 +1,27 @@
+import { DBConfig, UnifiedQuery } from "./types";
+import { Filter, Update } from "../jdb/types";
+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>;
+}

package/templates/ssr-isr/lib/db/index.js

@@ -0,0 +1,48 @@
+import { DBConnector } from "./connector";
+export * from "./types";
+export * from "./drivers/jdb";
+export * from "./drivers/sql";
+export class DB {
+  driver;
+  config;
+  constructor(config) {
+    this.config = config;
+    this.driver = DBConnector.create(config);
+  }
+  async connect() {
+    await this.driver.connect();
+  }
+  async disconnect() {
+    await this.driver.disconnect();
+  }
+  async query(q, params) {
+    if (typeof q === "string") {
+      return this.driver.query({ sql: q, params });
+    }
+    return this.driver.query(q);
+  }
+  // Fluent API Shortcuts
+  find(collection, filter, options) {
+    return this.driver.query({ find: collection, where: filter, options });
+  }
+  async findOne(collection, filter) {
+    const res = await this.driver.query({
+      find: collection,
+      where: filter,
+      options: { limit: 1 },
+    });
+    return res[0] || null;
+  }
+  create(collection, data) {
+    return this.driver.create(collection, data);
+  }
+  update(collection, filter, update) {
+    return this.driver.update(collection, filter, update);
+  }
+  delete(collection, filter) {
+    return this.driver.delete(collection, filter);
+  }
+  count(collection, filter) {
+    return this.driver.count(collection, filter);
+  }
+}

package/templates/ssr-isr/lib/db/types.d.ts

@@ -0,0 +1,33 @@
+import { Filter, Update, QueryOptions } from "../jdb/types";
+export type DBType = "jdb" | "sqlite" | "mysql" | "postgres";
+export interface DBConfig {
+  type: DBType;
+  connection?: any;
+  jdb?: {
+    root: string;
+    inMemory?: boolean;
+  };
+}
+export type FindQuery<T = any> = {
+  find: string;
+  where?: Filter<T>;
+  options?: QueryOptions;
+};
+export type SQLQuery = {
+  sql: string;
+  params?: any[];
+};
+export type UnifiedQuery<T = any> = FindQuery<T> | SQLQuery | string;
+export interface IDBDriver {
+  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/ssr-isr/lib/db/types.js

@@ -0,0 +1 @@
+export {};

package/templates/ssr-isr/lib/graphql/index.d.ts

@@ -0,0 +1,48 @@
+/**
+ * GraphQL integration utilities for Jen.js applications.
+ *
+ * Jen.js does not include GraphQL as a built-in dependency. This module provides
+ * a placeholder for GraphQL query execution and can be extended with custom implementations
+ * that use your chosen GraphQL library.
+ *
+ * To integrate GraphQL:
+ * 1. Install: npm install graphql
+ * 2. Import the graphql library: import { graphql } from 'graphql';
+ * 3. Implement query execution using your schema
+ * 4. Use in API routes or loaders
+ *
+ * @example
+ * // In an API route:
+ * import { runQuery } from '@src/graphql';
+ *
+ * export default {
+ *   handler: async (ctx) => {
+ *     const result = await runQuery(ctx.body.query, ctx.body.variables);
+ *     ctx.response.json(result);
+ *   }
+ * };
+ */
+/**
+ * Execute a GraphQL query.
+ * This is a placeholder function that must be implemented with your GraphQL library.
+ *
+ * @param query The GraphQL query string.
+ * @param variables Optional variables object for parameterized queries.
+ * @returns The query result object with data and errors (if any).
+ * @throws Error indicating GraphQL library must be installed.
+ *
+ * @example
+ * // Once graphql is installed:
+ * import { graphql } from 'graphql';
+ * import { schema } from './schema';
+ *
+ * export async function runQuery(query: string, variables?: any) {
+ *   const result = await graphql({
+ *     schema,
+ *     source: query,
+ *     variableValues: variables
+ *   });
+ *   return result;
+ * }
+ */
+export declare function runQuery(query: string, variables?: any): Promise<void>;

package/templates/ssr-isr/lib/graphql/index.js

@@ -0,0 +1,52 @@
+/**
+ * GraphQL integration utilities for Jen.js applications.
+ *
+ * Jen.js does not include GraphQL as a built-in dependency. This module provides
+ * a placeholder for GraphQL query execution and can be extended with custom implementations
+ * that use your chosen GraphQL library.
+ *
+ * To integrate GraphQL:
+ * 1. Install: npm install graphql
+ * 2. Import the graphql library: import { graphql } from 'graphql';
+ * 3. Implement query execution using your schema
+ * 4. Use in API routes or loaders
+ *
+ * @example
+ * // In an API route:
+ * import { runQuery } from '@src/graphql';
+ *
+ * export default {
+ *   handler: async (ctx) => {
+ *     const result = await runQuery(ctx.body.query, ctx.body.variables);
+ *     ctx.response.json(result);
+ *   }
+ * };
+ */
+/**
+ * Execute a GraphQL query.
+ * This is a placeholder function that must be implemented with your GraphQL library.
+ *
+ * @param query The GraphQL query string.
+ * @param variables Optional variables object for parameterized queries.
+ * @returns The query result object with data and errors (if any).
+ * @throws Error indicating GraphQL library must be installed.
+ *
+ * @example
+ * // Once graphql is installed:
+ * import { graphql } from 'graphql';
+ * import { schema } from './schema';
+ *
+ * export async function runQuery(query: string, variables?: any) {
+ *   const result = await graphql({
+ *     schema,
+ *     source: query,
+ *     variableValues: variables
+ *   });
+ *   return result;
+ * }
+ */
+export async function runQuery(query, variables) {
+  throw new Error(
+    "GraphQL implementation requires external library. Install: npm install graphql",
+  );
+}