@njinlabs/njin 0.3.0 → 0.5.0

package/README.md

@@ -1,5 +1,10 @@
 # njin
 
+[![CI](https://github.com/njinlabs/njin/actions/workflows/ci.yml/badge.svg)](https://github.com/njinlabs/njin/actions/workflows/ci.yml)
+[![CodeQL](https://github.com/njinlabs/njin/actions/workflows/codeql.yml/badge.svg)](https://github.com/njinlabs/njin/actions/workflows/codeql.yml)
+[![npm version](https://img.shields.io/npm/v/%40njinlabs%2Fnjin.svg)](https://www.npmjs.com/package/@njinlabs/njin)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
 A modern framework for building company profiles, landing pages, and content-driven websites. Define your data model once — get a full REST API, admin panel schema, and server-rendered website out of the box.
 
 ## Stack
@@ -13,7 +18,7 @@ A modern framework for building company profiles, landing pages, and content-dri
 ## Quick start
 
 ```bash
-bun create njin-app my-web
+bunx @njinlabs/njin create my-web
 cd my-web
 bunx njin dev
 ```
@@ -389,9 +394,11 @@ adapters: {
 ## Commands
 
 ```bash
+bunx @njinlabs/njin create my-web  # Scaffold a new project
 bunx njin dev       # Start dev server (Elysia + Vite HMR)
 bunx njin build     # Build for production -> ./out (public/, _admin/, views/, compiled server)
 bunx njin start     # Run from source in production mode (no compile)
+bunx njin update    # Update @njinlabs/njin to the latest version and refresh _admin/
 ```
 
 Wire these as `package.json` scripts (`"dev": "njin dev"`, etc.) if you'd rather run `bun run dev`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@njinlabs/njin",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "A modern framework for building company profiles, landing pages, and content-driven websites.",
   "type": "module",
   "keywords": ["bun", "elysia", "surrealdb", "edgejs", "cms", "framework"],

package/src/cli/create.ts

@@ -0,0 +1,82 @@
+import { existsSync, mkdirSync, readdirSync } from "node:fs";
+import { join, resolve } from "node:path";
+
+const c = { reset: "\x1b[0m", bold: "\x1b[1m", dim: "\x1b[2m", cyan: "\x1b[36m", green: "\x1b[32m" };
+
+const targetArg = process.argv[3] ?? ".";
+const targetDir = resolve(process.cwd(), targetArg);
+const projectName = targetArg === "." ? "njin-app" : targetArg.split(/[\\/]/).filter(Boolean).pop()!;
+
+if (existsSync(targetDir) && readdirSync(targetDir).length > 0) {
+  console.error(`✖ Directory "${targetArg}" already exists and is not empty.`);
+  process.exit(1);
+}
+
+// This CLI's own package.json — read at runtime (not a static JSON import) so it
+// resolves correctly whether njin is a project-local dependency or fetched fresh
+// by `bunx`. Doubles as the source of truth for which tagged template to fetch,
+// and for the version pin written into the scaffolded project below.
+const pkg = await Bun.file(join(import.meta.dir, "../../package.json")).json();
+const tag = `v${pkg.version}`;
+const tarballUrl = `https://codeload.github.com/njinlabs/njin/tar.gz/refs/tags/${tag}`;
+
+console.log(`\nFetching template for njin ${tag}...\n`);
+
+const res = await fetch(tarballUrl);
+if (!res.ok || !res.body) {
+  console.error(
+    `✖ Could not download the project template for njin ${tag} (HTTP ${res.status}).\n` +
+      `  Check your internet connection, or that tag "${tag}" exists at github.com/njinlabs/njin.`,
+  );
+  process.exit(1);
+}
+
+mkdirSync(targetDir, { recursive: true });
+
+// `--strip-components=2` drops the `njin-<version>/template/` prefix baked into
+// GitHub's tag-tarball layout, so template/ contents land directly in targetDir.
+const tar = Bun.spawn(["tar", "-xz", "-f", "-", "--strip-components=2", "-C", targetDir, `njin-${pkg.version}/template`], {
+  stdin: res.body,
+  stdout: "inherit",
+  stderr: "inherit",
+});
+
+const tarExitCode = await tar.exited;
+
+if (tarExitCode !== 0) {
+  console.error(
+    `✖ Failed to extract the template (tar exited with code ${tarExitCode}).\n` +
+      `  Make sure "tar" is installed and available on your PATH.`,
+  );
+  process.exit(tarExitCode);
+}
+
+const pkgPath = join(targetDir, "package.json");
+const scaffoldedPkg = await Bun.file(pkgPath).json();
+scaffoldedPkg.name = projectName;
+scaffoldedPkg.dependencies = { "@njinlabs/njin": `^${pkg.version}`, ...scaffoldedPkg.dependencies };
+await Bun.write(pkgPath, JSON.stringify(scaffoldedPkg, null, 2) + "\n");
+
+console.log("Installing dependencies...\n");
+
+const install = Bun.spawn(["bun", "install"], {
+  cwd: targetDir,
+  stdout: "inherit",
+  stderr: "inherit",
+});
+
+const installExitCode = await install.exited;
+
+if (installExitCode !== 0) {
+  console.error(`\n✖ "bun install" failed (exit code ${installExitCode}).`);
+  console.error(`  The project was scaffolded at ${targetDir}, but dependencies are not installed.`);
+  console.error(`  Run "cd ${targetArg} && bun install" manually to retry.\n`);
+  process.exit(installExitCode);
+}
+
+console.log(`
+  ${c.bold}${c.cyan}njin create${c.reset} ${c.dim}done${c.reset}
+
+  ${c.green}➜${c.reset}  cd ${targetArg === "." ? "." : targetArg}
+  ${c.green}➜${c.reset}  bunx njin dev
+`);

package/src/cli/index.ts

@@ -2,6 +2,9 @@
 const [command] = process.argv.slice(2);
 
 switch (command) {
+  case "create":
+    await import("./create");
+    break;
   case "dev":
     await import("./dev");
     break;
@@ -11,11 +14,16 @@ switch (command) {
   case "build":
     await import("./build");
     break;
+  case "update":
+    await import("./update");
+    break;
   default:
-    console.log(`Usage: njin <dev|build|start>
+    console.log(`Usage: njin <create|dev|build|start|update>
 
-  dev    Run the dev server (Vite HMR + live reload)
-  build  Build for production -> ./out (public/, _admin/, views/, server)
-  start  Run from source in production mode (no compile)`);
+  create <dir>  Scaffold a new project (defaults to current directory)
+  dev           Run the dev server (Vite HMR + live reload)
+  build         Build for production -> ./out (public/, _admin/, views/, server)
+  start         Run from source in production mode (no compile)
+  update        Update @njinlabs/njin to the latest version and refresh _admin/`);
     process.exit(command ? 1 : 0);
 }

package/src/cli/update.ts

@@ -0,0 +1,106 @@
+#!/usr/bin/env bun
+import { existsSync } from "node:fs";
+import { mkdir, rm } from "node:fs/promises";
+import { join } from "node:path";
+
+const c = { reset: "\x1b[0m", bold: "\x1b[1m", dim: "\x1b[2m", cyan: "\x1b[36m", green: "\x1b[32m" };
+
+const root = process.cwd();
+const pkgPath = join(root, "package.json");
+
+if (!existsSync(pkgPath)) {
+  console.error(`✖ No package.json found in ${root} — run this from an njin project root.`);
+  process.exit(1);
+}
+
+const pkg = await Bun.file(pkgPath).json();
+const depKey = pkg.dependencies?.["@njinlabs/njin"]
+  ? "dependencies"
+  : pkg.devDependencies?.["@njinlabs/njin"]
+    ? "devDependencies"
+    : undefined;
+
+if (!depKey) {
+  console.error(`✖ "@njinlabs/njin" is not listed in this project's package.json — run this from an njin project root.`);
+  process.exit(1);
+}
+
+const currentPinned = String(pkg[depKey]["@njinlabs/njin"]).replace(/^[\^~]/, "");
+
+console.log("Checking latest njin version...\n");
+
+const registryRes = await fetch("https://registry.npmjs.org/@njinlabs/njin/latest");
+if (!registryRes.ok) {
+  console.error(`✖ Could not reach the npm registry (HTTP ${registryRes.status}).`);
+  process.exit(1);
+}
+
+const { version: latest } = (await registryRes.json()) as { version: string };
+const adminDir = join(root, "_admin");
+
+if (currentPinned === latest && existsSync(adminDir)) {
+  console.log(`${c.green}✓${c.reset} Already on the latest version (${latest}) — nothing to update.`);
+  process.exit(0);
+}
+
+console.log(`Updating njin ${currentPinned} -> ${latest}...\n`);
+
+pkg[depKey]["@njinlabs/njin"] = `^${latest}`;
+await Bun.write(pkgPath, JSON.stringify(pkg, null, 2) + "\n");
+
+console.log("Installing dependencies...\n");
+
+const install = Bun.spawn(["bun", "install"], { cwd: root, stdout: "inherit", stderr: "inherit" });
+const installExitCode = await install.exited;
+
+if (installExitCode !== 0) {
+  console.error(`\n✖ "bun install" failed (exit code ${installExitCode}).`);
+  console.error(`  package.json now points at njin ${latest}; run "bun install" manually to retry.`);
+  process.exit(installExitCode);
+}
+
+console.log("\nSyncing admin panel...\n");
+
+// _admin/ is a prebuilt SPA baked into the tagged release tarball, not something published to
+// npm (package.json's "files" excludes template/) — so bumping the dependency above never
+// touches it. It's rebuilt with content-hashed asset filenames on every release, so the old
+// directory is removed first rather than merged, to avoid accumulating stale hashed files.
+const tag = `v${latest}`;
+const tarballUrl = `https://codeload.github.com/njinlabs/njin/tar.gz/refs/tags/${tag}`;
+
+const res = await fetch(tarballUrl);
+if (!res.ok || !res.body) {
+  console.error(
+    `✖ Could not download the admin panel for njin ${tag} (HTTP ${res.status}).\n` +
+      `  The dependency was updated to ${latest}, but _admin/ was not refreshed. Re-run "bunx njin update" to retry.`,
+  );
+  process.exit(1);
+}
+
+await rm(adminDir, { recursive: true, force: true });
+await mkdir(adminDir, { recursive: true });
+
+// --strip-components=3 drops the `njin-<version>/template/_admin/` prefix baked into GitHub's
+// tag-tarball layout, so _admin/'s own contents land directly in adminDir.
+const tar = Bun.spawn(["tar", "-xz", "-f", "-", "--strip-components=3", "-C", adminDir, `njin-${latest}/template/_admin`], {
+  stdin: res.body,
+  stdout: "inherit",
+  stderr: "inherit",
+});
+
+const tarExitCode = await tar.exited;
+
+if (tarExitCode !== 0) {
+  console.error(
+    `✖ Failed to extract the admin panel (tar exited with code ${tarExitCode}).\n` +
+      `  The dependency was updated to ${latest}, but _admin/ was not refreshed.`,
+  );
+  process.exit(tarExitCode);
+}
+
+console.log(`
+  ${c.bold}${c.cyan}njin update${c.reset} ${c.dim}done${c.reset}
+
+  ${c.green}➜${c.reset}  njin ${currentPinned} -> ${latest}
+  ${c.green}➜${c.reset}  _admin/ refreshed
+`);

package/src/modules/surreal.ts

@@ -62,10 +62,18 @@ const surreal = makeModule(() => {
     db = new Surreal({ engines });
     await db.connect(dbConfig.path, { authentication: dbConfig.auth });
     await db.use({ namespace: dbConfig.namespace, database: dbConfig.database });
-    await ensureTables(db);
 
     return {
-      spin: () => {
+      // Deferred to spin(), not run here — ensureTables() imports every registered model
+      // to read its prefix, which forces evaluation of data types like file()/multiFile()
+      // that depend on other modules' singletons (e.g. fileModule().model, only set once
+      // file.init() has run). Every module's init() — file's included — has already
+      // completed by the time any module's spin() starts, so this ordering is safe. It
+      // still runs before elysia's spin() (which calls app.listen()), since surreal is
+      // earlier in src/config/module.ts's array, so tables exist before the first request.
+      spin: async () => {
+        await ensureTables(db);
+
         const shutdown = async () => {
           await db.close();
           process.exit(0);