create-jen-app 1.2.1 → 1.2.3

package/templates/static/lib/build-tools/build-site.d.ts

@@ -1,6 +1,6 @@
 export interface BuildOptions {
-    minify?: boolean;
-    sourcemap?: boolean;
-    optimize?: boolean;
+  minify?: boolean;
+  sourcemap?: boolean;
+  optimize?: boolean;
 }
 export declare function buildSite(opts?: BuildOptions): Promise<void>;

package/templates/static/lib/build-tools/build-site.js

@@ -17,40 +17,37 @@
  */
 // Site build utilities
 // Migrated from Python src/python/build.py
-import { copyFileSync, rmSync, mkdirSync, readdirSync, } from "node:fs";
+import { copyFileSync, rmSync, mkdirSync, readdirSync } from "node:fs";
 import { join } from "node:path";
 import { log } from "../shared/log.js";
 function copyDir(src, dst) {
-    if (!readdirSync(src, { withFileTypes: true }).length)
-        return;
-    mkdirSync(dst, { recursive: true });
-    for (const file of readdirSync(src, { withFileTypes: true })) {
-        const srcPath = join(src, file.name);
-        const dstPath = join(dst, file.name);
-        if (file.isDirectory()) {
-            copyDir(srcPath, dstPath);
-        }
-        else {
-            copyFileSync(srcPath, dstPath);
-        }
+  if (!readdirSync(src, { withFileTypes: true }).length) return;
+  mkdirSync(dst, { recursive: true });
+  for (const file of readdirSync(src, { withFileTypes: true })) {
+    const srcPath = join(src, file.name);
+    const dstPath = join(dst, file.name);
+    if (file.isDirectory()) {
+      copyDir(srcPath, dstPath);
+    } else {
+      copyFileSync(srcPath, dstPath);
     }
+  }
 }
 export async function buildSite(opts = {}) {
-    log.info("Building site...");
-    const srcDir = "site";
-    const distDir = "dist";
-    // Clean dist
-    try {
-        rmSync(distDir, { recursive: true, force: true });
-    }
-    catch { }
-    // Copy assets
-    copyDir(srcDir, distDir);
-    log.info(`Copied ${srcDir} → ${distDir}`);
-    // Minify if requested
-    if (opts.minify) {
-        log.info("Minifying assets...");
-        // Placeholder: integrate image/font minifiers
-    }
-    log.info("Build complete.");
+  log.info("Building site...");
+  const srcDir = "site";
+  const distDir = "dist";
+  // Clean dist
+  try {
+    rmSync(distDir, { recursive: true, force: true });
+  } catch {}
+  // Copy assets
+  copyDir(srcDir, distDir);
+  log.info(`Copied ${srcDir} → ${distDir}`);
+  // Minify if requested
+  if (opts.minify) {
+    log.info("Minifying assets...");
+    // Placeholder: integrate image/font minifiers
+  }
+  log.info("Build complete.");
 }

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

@@ -1,2 +1,10 @@
+/**
+ * Cache layer module providing two implementations:
+ * - MemoryCache: In-memory Map-based cache for single-process deployments.
+ * - RedisCache: API contract for distributed caching (requires external redis library).
+ *
+ * Choose MemoryCache for development/testing or single-instance production.
+ * Choose RedisCache for multi-process or distributed environments (must install redis separately).
+ */
 export * from "./memory";
 export * from "./redis";

package/templates/static/lib/cache/index.js

@@ -15,5 +15,13 @@
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <https://www.gnu.org/licenses/>.
  */
+/**
+ * Cache layer module providing two implementations:
+ * - MemoryCache: In-memory Map-based cache for single-process deployments.
+ * - RedisCache: API contract for distributed caching (requires external redis library).
+ *
+ * Choose MemoryCache for development/testing or single-instance production.
+ * Choose RedisCache for multi-process or distributed environments (must install redis separately).
+ */
 export * from "./memory";
 export * from "./redis";

package/templates/static/lib/cache/memory.d.ts

@@ -1,6 +1,33 @@
+/**
+ * In-memory cache implementation using a JavaScript Map.
+ * Stores key-value pairs with optional time-to-live (TTL) expiration.
+ * Useful for development, testing, or single-process deployments.
+ * Not suitable for multi-process environments (values isolated per process).
+ * Note: Expired entries are deleted asynchronously via setTimeout; memory is not
+ * compacted if clear() or delete() are never called on expired keys.
+ */
 export declare class MemoryCache {
-    private store;
-    set(key: string, value: any, ttlMs?: number): void;
-    get(key: string): any;
-    delete(key: string): void;
+  /** Internal store mapping cache keys to arbitrary values. */
+  private store;
+  /**
+   * Store a value in cache with optional time-to-live.
+   * If TTL is specified, the entry is automatically deleted after ttlMs milliseconds.
+   * @param key - Cache key identifier.
+   * @param value - Value to store (can be any type; recommend serializable for consistency).
+   * @param ttlMs - Time-to-live in milliseconds. If omitted, entry persists until delete() or process restart.
+   */
+  set(key: string, value: any, ttlMs?: number): void;
+  /**
+   * Retrieve a value from cache.
+   * Returns undefined if key does not exist or has expired.
+   * @param key - Cache key identifier.
+   * @returns Stored value or undefined if not found.
+   */
+  get(key: string): any;
+  /**
+   * Remove a value from cache.
+   * Safe to call on non-existent keys (no-op).
+   * @param key - Cache key identifier.
+   */
+  delete(key: string): void;
 }

package/templates/static/lib/cache/memory.js

@@ -15,17 +15,43 @@
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <https://www.gnu.org/licenses/>.
  */
+/**
+ * In-memory cache implementation using a JavaScript Map.
+ * Stores key-value pairs with optional time-to-live (TTL) expiration.
+ * Useful for development, testing, or single-process deployments.
+ * Not suitable for multi-process environments (values isolated per process).
+ * Note: Expired entries are deleted asynchronously via setTimeout; memory is not
+ * compacted if clear() or delete() are never called on expired keys.
+ */
 export class MemoryCache {
-    store = new Map();
-    set(key, value, ttlMs) {
-        this.store.set(key, value);
-        if (ttlMs)
-            setTimeout(() => this.store.delete(key), ttlMs);
-    }
-    get(key) {
-        return this.store.get(key);
-    }
-    delete(key) {
-        this.store.delete(key);
-    }
+  /** Internal store mapping cache keys to arbitrary values. */
+  store = new Map();
+  /**
+   * Store a value in cache with optional time-to-live.
+   * If TTL is specified, the entry is automatically deleted after ttlMs milliseconds.
+   * @param key - Cache key identifier.
+   * @param value - Value to store (can be any type; recommend serializable for consistency).
+   * @param ttlMs - Time-to-live in milliseconds. If omitted, entry persists until delete() or process restart.
+   */
+  set(key, value, ttlMs) {
+    this.store.set(key, value);
+    if (ttlMs) setTimeout(() => this.store.delete(key), ttlMs);
+  }
+  /**
+   * Retrieve a value from cache.
+   * Returns undefined if key does not exist or has expired.
+   * @param key - Cache key identifier.
+   * @returns Stored value or undefined if not found.
+   */
+  get(key) {
+    return this.store.get(key);
+  }
+  /**
+   * Remove a value from cache.
+   * Safe to call on non-existent keys (no-op).
+   * @param key - Cache key identifier.
+   */
+  delete(key) {
+    this.store.delete(key);
+  }
 }

package/templates/static/lib/cache/redis.d.ts

@@ -1,6 +1,45 @@
+/**
+ * Placeholder Redis cache implementation.
+ * The framework does not include the Redis library; users must install it separately.
+ * This class provides the API contract; actual implementation requires external redis library.
+ * Install with: npm install redis
+ *
+ * Usage example:
+ *   import { RedisCache } from "jenjs";
+ *   const cache = new RedisCache();
+ *   await cache.connect();
+ *   await cache.set("key", { data: "value" }, 3600);
+ *   const val = await cache.get("key");
+ *
+ * Suitable for distributed/multi-process deployments where shared cache is needed.
+ */
 export declare class RedisCache {
-    connect(): Promise<void>;
-    set(key: string, value: any, ttlSec?: number): Promise<void>;
-    get(key: string): Promise<void>;
-    delete(key: string): Promise<void>;
+  /**
+   * Connect to Redis server.
+   * Requires external redis library to be installed.
+   * @throws Always throws if called without external library.
+   */
+  connect(): Promise<void>;
+  /**
+   * Store a value in Redis with optional time-to-live.
+   * @param key - Cache key identifier.
+   * @param value - Value to store (should be serializable to JSON).
+   * @param ttlSec - Time-to-live in seconds. If omitted, key persists indefinitely.
+   * @throws Always throws if called without external library.
+   */
+  set(key: string, value: any, ttlSec?: number): Promise<void>;
+  /**
+   * Retrieve a value from Redis.
+   * @param key - Cache key identifier.
+   * @returns Stored value or undefined if key does not exist.
+   * @throws Always throws if called without external library.
+   */
+  get(key: string): Promise<void>;
+  /**
+   * Delete a value from Redis.
+   * Safe to call on non-existent keys (no-op in Redis).
+   * @param key - Cache key identifier.
+   * @throws Always throws if called without external library.
+   */
+  delete(key: string): Promise<void>;
 }

package/templates/static/lib/cache/redis.js

@@ -15,19 +15,64 @@
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <https://www.gnu.org/licenses/>.
  */
-// Redis cache utilities - external Redis library not included
-// Users should implement with their own redis library (e.g., npm install redis)
+/**
+ * Placeholder Redis cache implementation.
+ * The framework does not include the Redis library; users must install it separately.
+ * This class provides the API contract; actual implementation requires external redis library.
+ * Install with: npm install redis
+ *
+ * Usage example:
+ *   import { RedisCache } from "jenjs";
+ *   const cache = new RedisCache();
+ *   await cache.connect();
+ *   await cache.set("key", { data: "value" }, 3600);
+ *   const val = await cache.get("key");
+ *
+ * Suitable for distributed/multi-process deployments where shared cache is needed.
+ */
 export class RedisCache {
-    async connect() {
-        throw new Error("Redis implementation requires external library. Install: npm install redis");
-    }
-    async set(key, value, ttlSec) {
-        throw new Error("Redis implementation requires external library. Install: npm install redis");
-    }
-    async get(key) {
-        throw new Error("Redis implementation requires external library. Install: npm install redis");
-    }
-    async delete(key) {
-        throw new Error("Redis implementation requires external library. Install: npm install redis");
-    }
+  /**
+   * Connect to Redis server.
+   * Requires external redis library to be installed.
+   * @throws Always throws if called without external library.
+   */
+  async connect() {
+    throw new Error(
+      "Redis implementation requires external library. Install: npm install redis",
+    );
+  }
+  /**
+   * Store a value in Redis with optional time-to-live.
+   * @param key - Cache key identifier.
+   * @param value - Value to store (should be serializable to JSON).
+   * @param ttlSec - Time-to-live in seconds. If omitted, key persists indefinitely.
+   * @throws Always throws if called without external library.
+   */
+  async set(key, value, ttlSec) {
+    throw new Error(
+      "Redis implementation requires external library. Install: npm install redis",
+    );
+  }
+  /**
+   * Retrieve a value from Redis.
+   * @param key - Cache key identifier.
+   * @returns Stored value or undefined if key does not exist.
+   * @throws Always throws if called without external library.
+   */
+  async get(key) {
+    throw new Error(
+      "Redis implementation requires external library. Install: npm install redis",
+    );
+  }
+  /**
+   * Delete a value from Redis.
+   * Safe to call on non-existent keys (no-op in Redis).
+   * @param key - Cache key identifier.
+   * @throws Always throws if called without external library.
+   */
+  async delete(key) {
+    throw new Error(
+      "Redis implementation requires external library. Install: npm install redis",
+    );
+  }
 }

package/templates/static/lib/cli/banner.d.ts

@@ -1 +1,5 @@
-export declare function printBanner(port: number, env: string, version?: string): void;
+export declare function printBanner(
+  port: number,
+  env: string,
+  version?: string,
+): void;

package/templates/static/lib/cli/banner.js

@@ -24,18 +24,22 @@ const GRAY = "\x1b[90m";
 const BOLD = "\x1b[1m";
 const DIM = "\x1b[2m";
 export function printBanner(port, env, version = "1.0.0") {
-    // Clear screen mostly
-    // console.log("\x1b[2J\x1b[3J\x1b[H");
-    console.log();
-    console.log(`  ${PURPLE}       __               ${CYAN}   _     ${RES}`);
-    console.log(`  ${PURPLE}      / /__  ____       ${CYAN}  (_)____${RES}`);
-    console.log(`  ${PURPLE} __  / / _ \/ __ \      ${CYAN} / / ___/${RES}`);
-    console.log(`  ${PURPLE}/ /_/ /  __/ / / /${GRAY}_____${CYAN}/ / (__  )${RES}`);
-    console.log(`  ${PURPLE}\____/\___/_/ /_/${GRAY}_____/${CYAN}_/____/ ${RES}`);
-    console.log();
-    console.log(`  ${GRAY}Jen.js Framework ${DIM}v${version}${RES}`);
-    console.log();
-    console.log(`  ${GRAY}➜${RES}  ${BOLD}Local:${RES}   ${CYAN}http://localhost:${port}/${RES}`);
-    console.log(`  ${GRAY}➜${RES}  ${BOLD}Mode:${RES}    ${PURPLE}${env}${RES}`);
-    console.log();
+  // Clear screen mostly
+  // console.log("\x1b[2J\x1b[3J\x1b[H");
+  console.log();
+  console.log(`  ${PURPLE}       __               ${CYAN}   _     ${RES}`);
+  console.log(`  ${PURPLE}      / /__  ____       ${CYAN}  (_)____${RES}`);
+  console.log(`  ${PURPLE} __  / / _ \/ __ \      ${CYAN} / / ___/${RES}`);
+  console.log(
+    `  ${PURPLE}/ /_/ /  __/ / / /${GRAY}_____${CYAN}/ / (__  )${RES}`,
+  );
+  console.log(`  ${PURPLE}\____/\___/_/ /_/${GRAY}_____/${CYAN}_/____/ ${RES}`);
+  console.log();
+  console.log(`  ${GRAY}Jen.js Framework ${DIM}v${version}${RES}`);
+  console.log();
+  console.log(
+    `  ${GRAY}➜${RES}  ${BOLD}Local:${RES}   ${CYAN}http://localhost:${port}/${RES}`,
+  );
+  console.log(`  ${GRAY}➜${RES}  ${BOLD}Mode:${RES}    ${PURPLE}${env}${RES}`);
+  console.log();
 }

package/templates/static/lib/cli/templates/ssg/jen.config.js

@@ -16,34 +16,34 @@
  * along with this program. If not, see <https://www.gnu.org/licenses/>.
  */
 const config = {
-    siteDir: "site",
-    distDir: "dist",
-    routes: {
-        fileExtensions: [".tsx", ".jsx", ".ts", ".js"],
-        routeFilePattern: /^\((.+)\)\.(t|j)sx?$/,
-        enableIndexFallback: true,
-    },
-    rendering: {
-        defaultMode: "ssg",
-        defaultRevalidateSeconds: 60,
-    },
-    assets: {
-        publicDir: "site/assets",
-        cacheControl: "public, max-age=31536000, immutable",
-    },
-    inject: {
-        head: [
-            `<meta charset="utf-8">`,
-            `<meta name="viewport" content="width=device-width, initial-scale=1">`,
-        ],
-        bodyEnd: [],
-    },
-    css: {
-        globalScss: "site/styles/global.scss",
-    },
-    server: {
-        port: 3000,
-        hostname: "0.0.0.0",
-    },
+  siteDir: "site",
+  distDir: "dist",
+  routes: {
+    fileExtensions: [".tsx", ".jsx", ".ts", ".js"],
+    routeFilePattern: /^\((.+)\)\.(t|j)sx?$/,
+    enableIndexFallback: true,
+  },
+  rendering: {
+    defaultMode: "ssg",
+    defaultRevalidateSeconds: 60,
+  },
+  assets: {
+    publicDir: "site/assets",
+    cacheControl: "public, max-age=31536000, immutable",
+  },
+  inject: {
+    head: [
+      `<meta charset="utf-8">`,
+      `<meta name="viewport" content="width=device-width, initial-scale=1">`,
+    ],
+    bodyEnd: [],
+  },
+  css: {
+    globalScss: "site/styles/global.scss",
+  },
+  server: {
+    port: 3000,
+    hostname: "0.0.0.0",
+  },
 };
 export default config;

package/templates/static/lib/cli/templates/ssg/site/index.js

@@ -1,4 +1,9 @@
 import { jsx as _jsx, jsxs as _jsxs } from "preact/jsx-runtime";
 export default function Home() {
-    return (_jsxs("div", { children: [_jsx("h1", { children: "Welcome to My SSG App" }), _jsx("p", { children: "This page was generated from the SSG template." })] }));
+  return _jsxs("div", {
+    children: [
+      _jsx("h1", { children: "Welcome to My SSG App" }),
+      _jsx("p", { children: "This page was generated from the SSG template." }),
+    ],
+  });
 }

package/templates/static/lib/cli/templates/ssr/jen.config.js

@@ -16,34 +16,34 @@
  * along with this program. If not, see <https://www.gnu.org/licenses/>.
  */
 const config = {
-    siteDir: "site",
-    distDir: "dist",
-    routes: {
-        fileExtensions: [".tsx", ".jsx", ".ts", ".js"],
-        routeFilePattern: /^\((.+)\)\.(t|j)sx?$/,
-        enableIndexFallback: true,
-    },
-    rendering: {
-        defaultMode: "ssr",
-        defaultRevalidateSeconds: 60,
-    },
-    assets: {
-        publicDir: "site/assets",
-        cacheControl: "public, max-age=31536000, immutable",
-    },
-    inject: {
-        head: [
-            `<meta charset="utf-8">`,
-            `<meta name="viewport" content="width=device-width, initial-scale=1">`,
-        ],
-        bodyEnd: [],
-    },
-    css: {
-        globalScss: "site/styles/global.scss",
-    },
-    server: {
-        port: 3000,
-        hostname: "0.0.0.0",
-    },
+  siteDir: "site",
+  distDir: "dist",
+  routes: {
+    fileExtensions: [".tsx", ".jsx", ".ts", ".js"],
+    routeFilePattern: /^\((.+)\)\.(t|j)sx?$/,
+    enableIndexFallback: true,
+  },
+  rendering: {
+    defaultMode: "ssr",
+    defaultRevalidateSeconds: 60,
+  },
+  assets: {
+    publicDir: "site/assets",
+    cacheControl: "public, max-age=31536000, immutable",
+  },
+  inject: {
+    head: [
+      `<meta charset="utf-8">`,
+      `<meta name="viewport" content="width=device-width, initial-scale=1">`,
+    ],
+    bodyEnd: [],
+  },
+  css: {
+    globalScss: "site/styles/global.scss",
+  },
+  server: {
+    port: 3000,
+    hostname: "0.0.0.0",
+  },
 };
 export default config;

package/templates/static/lib/cli/templates/ssr/site/index.js

@@ -1,4 +1,9 @@
 import { jsx as _jsx, jsxs as _jsxs } from "preact/jsx-runtime";
 export default function Home() {
-    return (_jsxs("div", { children: [_jsx("h1", { children: "Welcome to My SSR App" }), _jsx("p", { children: "This page is rendered on the server." })] }));
+  return _jsxs("div", {
+    children: [
+      _jsx("h1", { children: "Welcome to My SSR App" }),
+      _jsx("p", { children: "This page is rendered on the server." }),
+    ],
+  });
 }