statikapi 0.3.0 → 0.5.0

package/README.md

@@ -23,10 +23,8 @@ pnpm add -D statikapi
 statikapi <command> [options]
 
 Commands:
-  init        Scaffold a new StatikAPI project
   build       Build static JSON endpoints
   dev         Watch & rebuild on changes
-  preview     Serve the built JSON files + UI
 
 Global:
   -h, --help      Show help
@@ -124,10 +122,6 @@ You can override via flags: `--srcDir <dir>`, `--outDir <dir>`.
 - Rebuilds on changes, updates the preview UI via SSE.
 - `--previewHost`, `--previewPort` — where to notify the preview server.
 - `--srcDir`, `--outDir` — override config paths.
-
-`preview`
-
-- Serves `api-out/` and the UI at `/\_ui`.
 - `--host` (default 127.0.0.1)
 - `--port` (default 8788)
 - `--open` — try to open the browser
@@ -144,15 +138,17 @@ There are two example projects in this repo under `example/`:
 # from repo root
 
 pnpm -C example/basic dev
-pnpm -C example/basic preview
+pnpm -C example/basic build
 
 pnpm -C example/dynamic dev
-pnpm -C example/dynamic preview
+pnpm -C example/dynamic build
+
+pnpm -C example/showcase dev
+pnpm -C example/showcase build
 ```
 
 ## Troubleshooting
 
-- UI doesn’t load: ensure `preview` is running; if you’re developing the UI separately, start Vite on port 5173 or pass `--uiDir` to serve a built UI.
 - Dynamic routes not emitted: make sure the file exports a valid `paths()` function returning strings (or arrays of strings for catch-all).
 
 License

package/package.json

@@ -1,21 +1,47 @@
 {
   "name": "statikapi",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/zonayedpca/statikapi",
     "directory": "packages/cli"
   },
-  "bugs": { "url": "https://github.com/zonayedpca/statikapi/issues" },
+  "bugs": {
+    "url": "https://github.com/zonayedpca/statikapi/issues"
+  },
   "homepage": "https://github.com/zonayedpca/statikapi#readme",
   "type": "module",
-  "bin": { "statikapi": "bin/statikapi.js" },
-  "files": ["bin", "dist", "ui", "src", "README.md", "LICENSE"],
-  "exports": { ".": { "import": "./src/index.js" } },
-  "engines": { "node": ">=18" },
+  "bin": {
+    "statikapi": "bin/statikapi.js"
+  },
+  "files": [
+    "bin",
+    "dist",
+    "ui",
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": {
+      "import": "./src/index.js"
+    }
+  },
+  "engines": {
+    "node": ">=18"
+  },
   "license": "MIT",
-  "keywords": ["static", "json", "api", "cli", "ssg"],
-  "publishConfig": { "access": "public", "provenance": true },
+  "keywords": [
+    "static",
+    "json",
+    "api",
+    "cli",
+    "ssg"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "dependencies": {
     "chokidar": "^3.6.0",
     "sirv": "^2.0.4",

package/src/commands/dev.js

@@ -1,10 +1,10 @@
 import chokidar from 'chokidar';
 import path from 'node:path';
 import fs from 'node:fs/promises';
-import fss from 'node:fs'; // NEW: for createReadStream
+import fss from 'node:fs';
 import crypto from 'node:crypto';
-import http from 'node:http'; // NEW: tiny HTTP server
-import { fileURLToPath } from 'node:url'; // NEW: resolve UI dist
+import http from 'node:http';
+import { fileURLToPath } from 'node:url';
 
 import { loadConfig } from '../config/loadConfig.js';
 import { loadModuleValue } from '../loader/loadModuleValue.js';
@@ -72,13 +72,11 @@ export default async function devCmd(argv) {
   const { config } = await loadConfig({ flags });
 
   // Where to notify preview
-  // NEW: dev server + UI defaults
   const host = String(flags.host ?? '127.0.0.1');
   const port = Number.isFinite(flags.port) ? Number(flags.port) : 8788;
   const noUi = !!(flags['no-ui'] || flags.noUi);
   const noOpen = !!(flags['no-open'] || flags.noOpen);
 
-  // NEW: live SSE clients
   const sseClients = new Set(); // each entry: { id, res }
   function sseBroadcast(msg) {
     const line = `data: ${msg}\n\n`;
@@ -274,7 +272,6 @@ export default async function devCmd(argv) {
   await writeManifest();
   console.log(`[statikapi] ready. Watching ${path.relative(process.cwd(), config.paths.srcAbs)}/`);
 
-  // NEW: start HTTP server (UI + JSON helpers + SSE)
   const server = http.createServer(async (req, res) => {
     try {
       let url;
@@ -286,7 +283,6 @@ export default async function devCmd(argv) {
       }
       const pathname = url.pathname;
 
-      // 1) SSE: /_ui/events
       if (pathname === '/_ui/events') {
         res.writeHead(200, {
           'Content-Type': 'text/event-stream',
@@ -301,7 +297,6 @@ export default async function devCmd(argv) {
         return;
       }
 
-      // 2) Manifest JSON for UI: /ui/index
       if (pathname === '/ui/index' && req.method === 'GET') {
         const list = Array.from(manifestByRoute.values()).sort((a, b) =>
           a.route.localeCompare(b.route)
@@ -312,7 +307,6 @@ export default async function devCmd(argv) {
         return;
       }
 
-      // 3) Serve built file content: /_ui/file?route=/path
       if (pathname === '/_ui/file' && req.method === 'GET') {
         const route = url.searchParams.get('route') || '';
         const outFile = routeToOutPath({ outAbs: config.paths.outAbs, route });
@@ -332,7 +326,6 @@ export default async function devCmd(argv) {
         return;
       }
 
-      // 4) Static React UI at /_ui/* (unless --no-ui)
       if (!noUi && pathname.startsWith('/_ui/')) {
         const uiRoot = resolveUiDist();
         const rel = pathname.replace(/^\/_ui\//, '') || 'index.html';
@@ -360,13 +353,45 @@ export default async function devCmd(argv) {
         return;
       }
 
-      // 5) Root → redirect to UI (unless --no-ui)
       if (!noUi && pathname === '/') {
         res.writeHead(302, { Location: '/_ui/' });
         res.end();
         return;
       }
 
+      // Serve built JSON directly from api-out
+      {
+        const outRoot = config.paths.outAbs;
+        // strip leading slash and normalize
+        const rel = pathname.replace(/^\/+/, '');
+        const candidates = [];
+
+        // If the request ends with .json, try that file directly
+        if (rel.endsWith('.json')) {
+          candidates.push(path.join(outRoot, rel));
+        } else {
+          // Otherwise, try a folder with index.json (e.g. "/" or "/users/1/")
+          candidates.push(path.join(outRoot, rel, 'index.json'));
+        }
+
+        for (const cand of candidates) {
+          const file = path.resolve(cand);
+          // prevent path traversal
+          if (!file.startsWith(path.resolve(outRoot))) continue;
+
+          try {
+            const st = await fs.stat(file);
+            if (st.isFile()) {
+              res.setHeader('Content-Type', 'application/json; charset=utf-8');
+              fss.createReadStream(file).pipe(res);
+              return; // served
+            }
+          } catch {
+            // try next candidate
+          }
+        }
+      }
+
       // Otherwise: 404
       res.statusCode = 404;
       res.end('Not Found');
@@ -406,7 +431,6 @@ export default async function devCmd(argv) {
   return 0;
 }
 
-// NEW: helpers (static file & UI dist resolver & opener)
 function streamFile(file, res) {
   const ext = path.extname(file).toLowerCase();
   const ctype =
@@ -428,19 +452,19 @@ function streamFile(file, res) {
 }
 
 function resolveUiDist() {
-  // 0) Optional override for power users
+  // Optional override for power users
   const fromEnv = process.env.STATIKAPI_UI_DIR;
   if (fromEnv && hasIndex(fromEnv)) return fromEnv;
 
-  // 1) Bundled with the CLI: packages/cli/ui/  (your screenshot)
+  // Bundled with the CLI: packages/cli/ui/
   const bundled = path.resolve(__dirname, '..', '..', 'ui');
   if (hasIndex(bundled)) return bundled;
 
-  // 2) Monorepo dev fallback: packages/ui/dist
+  // Monorepo dev fallback: packages/ui/dist
   const monorepoDist = path.resolve(__dirname, '..', '..', '..', 'ui', 'dist');
   if (hasIndex(monorepoDist)) return monorepoDist;
 
-  // 3) Last resort: throw with a helpful hint
+  // Last resort: throw with a helpful hint
   throw new Error(
     'StatikAPI UI build not found. ' +
       'Either keep a built UI at packages/cli/ui/ (index.html present), ' +

package/src/help.js

@@ -3,11 +3,9 @@ export const HELP = `statikapi — Static API generator
 Usage:
   statikapi <command> [options]
 
-Commands:
-  init        Scaffold a new StatikAPI project
+Commands:Scaffold a new StatikAPI project
   build       Build static JSON endpoints
   dev         Start dev mode (watch & rebuild)
-  preview     Serve the built JSON files
 
 Global options:
   -h, --help      Show help