@yrest/cli 0.7.0 → 0.8.1

package/README.md

@@ -1,4 +1,8 @@
-# yRest
+<div align="center">
+  <img src="assets/yRest-banner.png" alt="yRest" width="100%" />
+</div>
+
+<br/>
 
 [![npm version](https://img.shields.io/npm/v/@yrest/cli)](https://www.npmjs.com/package/@yrest/cli)
 [![npm downloads](https://img.shields.io/npm/dw/@yrest/cli)](https://www.npmjs.com/package/@yrest/cli)
@@ -6,6 +10,7 @@
 [![CI](https://github.com/aggiovato/yRest/actions/workflows/ci.yml/badge.svg)](https://github.com/aggiovato/yRest/actions)
 [![Node](https://img.shields.io/node/v/@yrest/cli)](https://www.npmjs.com/package/@yrest/cli)
 [![TypeScript](https://img.shields.io/badge/TypeScript-ready-blue)](https://www.typescriptlang.org/)
+[![Socket](https://badge.socket.dev/npm/package/@yrest/cli/0.8.1)](https://socket.dev/npm/package/@yrest/cli)
 
 YAML-powered json-server alternative. Zero-config REST API mock server with full CRUD, relations, filters and snapshots from a `db.yml` file.
 
@@ -157,6 +162,7 @@ npx @yrest/cli serve db.yml --handlers yrest.handlers.js
 | `--pageable [n]`    | `false`     | Wrap GET collection responses in `{ data, pagination }`. Optional limit |
 | `--snapshot`        | `false`     | Save initial state snapshot and expose `/_snapshot` endpoints           |
 | `--handlers <file>` | _(none)_    | Path to a JS file exporting handler functions for custom routes         |
+| `--id-strategy`     | `increment` | Id generation for new items: `increment` (auto-int) or `uuid`           |
 
 All flags can also be set in `yrest.config.yml` (see below). CLI flags always take priority over the config file.
 
@@ -178,6 +184,7 @@ host: localhost
 # pageable: false   # true (limit 10), or a number (custom limit)
 # snapshot: false
 # handlers: yrest.handlers.js
+# idStrategy: increment   # increment or uuid
 ```
 
 **Priority order** (highest wins): CLI flags → `yrest.config.yml` → schema defaults.
@@ -595,6 +602,36 @@ _routes:
       body: { data: loaded }
 ```
 
+### Error injection
+
+Force a custom route to always return a specific HTTP error, regardless of handlers, scenarios or the static response. Useful for simulating outages, payment failures or auth errors:
+
+```yaml
+_routes:
+  - method: GET
+    path: /payments
+    error: 503
+    errorBody:
+      message: Service temporarily unavailable
+      retryAfter: 30
+
+  - method: POST
+    path: /checkout
+    error: 402
+    errorBody:
+      error: Payment required
+
+  - method: GET
+    path: /slow-failure
+    delay: 400
+    error: 500
+```
+
+- `error` takes priority over `handler`, `scenarios` and `response` — the route always returns this status.
+- `errorBody` is optional. If omitted, the default body is `{ "error": "Forced error NNN" }`.
+- `delay` still applies before the error is returned.
+- Shown in `/_about` with a red `error·NNN` badge.
+
 ### Handler functions
 
 For routes that need real logic (conditional responses, stateful mocks, request inspection), reference a JavaScript function via the `handler:` field:
@@ -960,6 +997,8 @@ const server = createYrestServer({
 | Request validation with JSON Schema                | 🔜     |
 | Conditional scenarios (`scenarios:`, `otherwise:`) | ✅     |
 | Per-route delay (`delay:`)                         | ✅     |
+| Error injection (`error:` in `_routes`)            | ✅     |
+| Configurable ID strategy (`idStrategy`)            | ✅     |
 
 ---
 

package/dist/cli/index.js

@@ -132,8 +132,8 @@ function registerInit(program2) {
 }
 
 // src/cli/commands/serve.ts
-var import_node_fs5 = require("fs");
-var import_node_path3 = require("path");
+var import_node_fs6 = require("fs");
+var import_node_path4 = require("path");
 
 // src/storage/yrestStorage.ts
 var import_node_fs2 = require("fs");
@@ -223,6 +223,11 @@ function createYrestStorage(filePath) {
 var import_fastify = __toESM(require("fastify"));
 var import_cors = __toESM(require("@fastify/cors"));
 
+// src/router/templates/about.template.ts
+var import_node_fs3 = require("fs");
+var import_node_path3 = require("path");
+var import_node_url = require("url");
+
 // src/utils/interpolate.ts
 var import_node_crypto2 = require("crypto");
 function getPath(obj, path) {
@@ -270,6 +275,15 @@ function hasTemplates(value) {
 }
 
 // src/router/templates/about.template.ts
+var _dir = (0, import_node_path3.dirname)((0, import_node_url.fileURLToPath)(importMetaUrl));
+var LOGO_SRC = (() => {
+  try {
+    const buf = (0, import_node_fs3.readFileSync)((0, import_node_path3.join)(_dir, "../../assets/logo-color.png"));
+    return `data:image/png;base64,${buf.toString("base64")}`;
+  } catch {
+    return "";
+  }
+})();
 var METHOD_COLOR = {
   GET: "#3fb950",
   POST: "#58a6ff",
@@ -278,8 +292,11 @@ var METHOD_COLOR = {
   DELETE: "#f85149",
   fn: "#f0883e"
 };
+function escapeHtml(str) {
+  return str.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#039;");
+}
 function badge(label, color, bg) {
-  return `<span class="badge" style="background:${bg};color:${color};border:1px solid ${color}40">${label}</span>`;
+  return `<span class="badge" style="background:${bg};color:${color};border:1px solid ${color}40">${escapeHtml(label)}</span>`;
 }
 function methodBadge(method) {
   const color = METHOD_COLOR[method] ?? "#7d8590";
@@ -289,7 +306,7 @@ function endpointRow(method, path, desc) {
   return `
     <tr>
       <td class="method-cell">${methodBadge(method)}</td>
-      <td class="path-cell"><code>${path}</code></td>
+      <td class="path-cell"><code>${escapeHtml(path)}</code></td>
       <td class="desc-cell">${desc}</td>
     </tr>`;
 }
@@ -323,7 +340,7 @@ function resourceAccordion(name, base, isOpen) {
   return `
   <details class="resource-card" ${isOpen ? "open" : ""}>
     <summary>
-      <span class="resource-name">/${name}</span>
+      <span class="resource-name">/${escapeHtml(name)}</span>
       <span class="route-count">6 routes</span>
     </summary>
     <table>
@@ -407,7 +424,7 @@ curl -X POST ${host}/_snapshot/reset`
   }
   if (firstCustomRoute) {
     const method = firstCustomRoute.method?.toUpperCase() ?? "GET";
-    const fullPath = `${host}${base}${firstCustomRoute.path}`;
+    const fullPath = `${host}${base}${escapeHtml(firstCustomRoute.path ?? "")}`;
     const curlFlag = method === "GET" ? "" : `-X ${method} `;
     examples.push(`# Custom route
 curl ${curlFlag}${fullPath}`);
@@ -428,6 +445,8 @@ function generateAboutHtml(storage, options, handlers = /* @__PURE__ */ new Map(
     modes.push(badge(`pageable \xB7 limit ${options.pageable.limit}`, "#34d399", "#34d39918"));
   if (options.snapshot) modes.push(badge("snapshot", "#c084fc", "#c084fc18"));
   if (handlers.size > 0) modes.push(badge(`handlers \xB7 ${handlers.size}`, "#f0883e", "#f0883e18"));
+  if (options.idStrategy !== "increment")
+    modes.push(badge(`id \xB7 ${options.idStrategy}`, "#a371f7", "#a371f718"));
   const accordions = collections.map((col, i) => resourceAccordion(col, base, i === 0)).join("");
   const nestedRows = [];
   for (const [child, fields] of Object.entries(relations)) {
@@ -470,6 +489,9 @@ function generateAboutHtml(storage, options, handlers = /* @__PURE__ */ new Map(
       ${customRoutes.map((r) => {
     const fullPath = `${base}${r.path}`;
     const tags = [];
+    if (r.error) {
+      tags.push(`<span style="color:#f85149;font-size:11px">error\xB7${r.error}</span>`);
+    }
     if (r.delay && r.delay > 0) {
       tags.push(`<span style="color:#fb923c;font-size:11px">delay\xB7${r.delay}ms</span>`);
     }
@@ -483,9 +505,12 @@ function generateAboutHtml(storage, options, handlers = /* @__PURE__ */ new Map(
       tags.push(`<span style="color:var(--text-muted);font-size:11px">otherwise</span>`);
     }
     let desc;
-    if (r.handler) {
+    if (r.error) {
+      desc = `Error injection \u2014 <code>${r.error}</code>`;
+    } else if (r.handler) {
       const found = handlers.has(r.handler);
-      desc = found ? `Handler \u2014 <code>${r.handler}()</code>` : `Handler \u2014 <code>${r.handler}()</code> <span style="color:#f85149">(not loaded)</span>`;
+      const handlerName = escapeHtml(r.handler);
+      desc = found ? `Handler \u2014 <code>${handlerName}()</code>` : `Handler \u2014 <code>${handlerName}()</code> <span style="color:#f85149">(not loaded)</span>`;
     } else if (r.scenarios?.length) {
       const hasTemplateInScenarios = r.scenarios.some((s) => s.response.body != null && hasTemplates(s.response.body)) || r.otherwise?.body != null && hasTemplates(r.otherwise.body);
       desc = hasTemplateInScenarios ? `Scenarios \u2014 <code>{{\u2026}}</code>` : `Scenarios`;
@@ -647,7 +672,7 @@ function generateAboutHtml(storage, options, handlers = /* @__PURE__ */ new Map(
 
   <div class="banner">
     <div class="banner-inner">
-      <h1><span class="y">y</span><span class="rest">Rest</span></h1>
+      ${LOGO_SRC ? `<img src="${LOGO_SRC}" alt="yRest" height="68" style="display:block;margin-bottom:0px" />` : `<h1><span class="y">y</span><span class="rest">Rest</span></h1>`}
       <p>Zero-config REST API mock server</p>
       <div class="banner-meta">
         <span>URL <strong>${host}</strong></span>
@@ -730,6 +755,10 @@ function nextId(items) {
   const ids = items.map((i) => i["id"]).filter((id) => typeof id === "number");
   return ids.length > 0 ? Math.max(...ids) + 1 : 1;
 }
+function generateId(items, strategy) {
+  if (strategy === "uuid") return crypto.randomUUID();
+  return nextId(items);
+}
 function firstParam(value) {
   if (value === void 0) return void 0;
   return Array.isArray(value) ? value[0] : value;
@@ -754,6 +783,7 @@ function applyOperator(itemValue, op, filterValue) {
     case "_start":
       return strItem.toLowerCase().startsWith(filterValue.toLowerCase());
     case "_regex": {
+      if (filterValue.length > 200) return false;
       try {
         return new RegExp(filterValue, "i").test(strItem);
       } catch {
@@ -817,10 +847,10 @@ function findById(items, id) {
 function findIndexById(items, id) {
   return items.findIndex((i) => String(i["id"]) === id);
 }
-function createItem(storage, resource, body) {
+function createItem(storage, resource, body, idStrategy = "increment") {
   const collection = storage.getCollection(resource) ?? [];
   const item = {
-    id: body["id"] !== void 0 ? body["id"] : nextId(collection),
+    id: body["id"] !== void 0 ? body["id"] : generateId(collection, idStrategy),
     ...body
   };
   storage.setCollection(resource, [...collection, item]);
@@ -998,7 +1028,12 @@ var CollectionRouteCommand = class {
       if (!req.body || typeof req.body !== "object" || Array.isArray(req.body)) {
         return reply.status(400).send({ error: "Request body must be a JSON object" });
       }
-      const item = createItem(this.storage, this.resource, req.body);
+      const item = createItem(
+        this.storage,
+        this.resource,
+        req.body,
+        this.options.idStrategy
+      );
       return reply.status(201).send(expandItems(item, req.query, this.resource, this.storage));
     });
   }
@@ -1088,6 +1123,10 @@ var CustomRouteCommand = class {
           if (route.delay && route.delay > 0) {
             await new Promise((resolve5) => setTimeout(resolve5, route.delay));
           }
+          if (route.error) {
+            const body2 = route.errorBody ?? { error: `Forced error ${route.error}` };
+            return reply.status(route.error).send(body2);
+          }
           for (const [key, value] of Object.entries(headers)) {
             reply.header(key, value);
           }
@@ -1384,22 +1423,36 @@ var yrestOptionsSchema = import_zod.z.object({
   pageable: import_zod.z.union([import_zod.z.boolean(), import_zod.z.coerce.number().int().positive()]).default(false).transform((v) => ({
     enabled: v !== false,
     limit: v === false || v === true ? 10 : v
-  }))
+  })),
+  /**
+   * Strategy used to generate `id` values for new items when no `id` is provided in the body.
+   *
+   * - `"increment"` (default) — next integer above the current max id in the collection.
+   * - `"uuid"` — a random UUID v4 string (`crypto.randomUUID()`).
+   */
+  idStrategy: import_zod.z.enum(["increment", "uuid"]).default("increment")
 });
 
 // src/config/loadConfigFile.ts
-var import_node_fs3 = require("fs");
+var import_node_fs4 = require("fs");
 var import_yaml2 = require("yaml");
 function loadConfigFile(configPath) {
-  if (!(0, import_node_fs3.existsSync)(configPath)) return {};
-  const raw = (0, import_node_fs3.readFileSync)(configPath, "utf8");
+  if (!(0, import_node_fs4.existsSync)(configPath)) return {};
+  const raw = (0, import_node_fs4.readFileSync)(configPath, "utf8");
   return (0, import_yaml2.parse)(raw) ?? {};
 }
 
 // src/utils/handlers.ts
-var import_node_fs4 = require("fs");
+var import_node_fs5 = require("fs");
+var ALLOWED_EXTENSIONS = [".js", ".mjs", ".cjs"];
 async function loadHandlers(filePath) {
-  if (!(0, import_node_fs4.existsSync)(filePath)) return /* @__PURE__ */ new Map();
+  if (!(0, import_node_fs5.existsSync)(filePath)) return /* @__PURE__ */ new Map();
+  if (!ALLOWED_EXTENSIONS.some((ext) => filePath.endsWith(ext))) {
+    console.error(
+      `  \x1B[31m[handlers] ${filePath} \u2014 only .js, .mjs and .cjs files are allowed\x1B[0m`
+    );
+    return /* @__PURE__ */ new Map();
+  }
   try {
     const mod = await import(filePath);
     const map = /* @__PURE__ */ new Map();
@@ -1429,8 +1482,12 @@ function registerServe(program2) {
   ).option(
     "--handlers <file>",
     "Path to a JavaScript file exporting custom route handler functions"
+  ).option(
+    "--id-strategy <strategy>",
+    "Id generation strategy for new items: increment (default) or uuid",
+    "increment"
   ).action(async (file, flags, cmd) => {
-    const fileConfig = loadConfigFile((0, import_node_path3.join)(process.cwd(), "yrest.config.yml"));
+    const fileConfig = loadConfigFile((0, import_node_path4.join)(process.cwd(), "yrest.config.yml"));
     const cliOverrides = Object.fromEntries(
       Object.entries(flags).filter(([key]) => cmd.getOptionValueSource(key) === "cli")
     );
@@ -1449,7 +1506,7 @@ function registerServe(program2) {
       console.error(`Error: cannot load "${options.file}" \u2014 ${msg}`);
       process.exit(1);
     }
-    const handlers = options.handlers ? await loadHandlers((0, import_node_path3.resolve)(options.handlers)) : /* @__PURE__ */ new Map();
+    const handlers = options.handlers ? await loadHandlers((0, import_node_path4.resolve)(options.handlers)) : /* @__PURE__ */ new Map();
     const yrestServer = createYrestServerFromStorage(storage, options, handlers);
     await yrestServer.start();
     const collections = Object.keys(storage.getData());
@@ -1511,9 +1568,9 @@ function registerServe(program2) {
   ${dim(modes.map((m) => `[${m}]`).join("  "))}`);
     console.log("");
     if (options.watch) {
-      const absFile = (0, import_node_path3.resolve)(options.file);
+      const absFile = (0, import_node_path4.resolve)(options.file);
       let debounce;
-      (0, import_node_fs5.watchFile)(absFile, { interval: 300 }, (curr, prev) => {
+      (0, import_node_fs6.watchFile)(absFile, { interval: 300 }, (curr, prev) => {
         if (curr.mtimeMs === prev.mtimeMs) return;
         clearTimeout(debounce);
         debounce = setTimeout(() => {
@@ -1533,8 +1590,8 @@ function registerServe(program2) {
 }
 
 // src/cli/commands/handler.ts
-var import_node_fs6 = require("fs");
-var import_node_path4 = require("path");
+var import_node_fs7 = require("fs");
+var import_node_path5 = require("path");
 var import_yaml3 = require("yaml");
 var HANDLERS_FILE_HEADER = `// yrest handlers \u2014 loaded via "handlers:" in yrest.config.yml
 // Handler signature: (req: HandlerRequest) => HandlerResponse | Promise<HandlerResponse>
@@ -1561,44 +1618,44 @@ function registerHandler(program2) {
     "--register",
     "Also add a _routes entry to db.yml linking this handler to method + path"
   ).action((name, flags) => {
-    const fileConfig = loadConfigFile((0, import_node_path4.join)(process.cwd(), "yrest.config.yml"));
-    const handlersPath = (0, import_node_path4.resolve)(
+    const fileConfig = loadConfigFile((0, import_node_path5.join)(process.cwd(), "yrest.config.yml"));
+    const handlersPath = (0, import_node_path5.resolve)(
       fileConfig.handlers ?? "yrest.handlers.js"
     );
-    const dbPath = (0, import_node_path4.resolve)(fileConfig.file ?? "db.yml");
-    if (!(0, import_node_fs6.existsSync)(handlersPath)) {
-      (0, import_node_fs6.writeFileSync)(
+    const dbPath = (0, import_node_path5.resolve)(fileConfig.file ?? "db.yml");
+    if (!(0, import_node_fs7.existsSync)(handlersPath)) {
+      (0, import_node_fs7.writeFileSync)(
         handlersPath,
         HANDLERS_FILE_HEADER + buildStub(name, flags.method, flags.path),
         "utf8"
       );
-      console.log(`  Created ${(0, import_node_path4.basename)(handlersPath)}`);
+      console.log(`  Created ${(0, import_node_path5.basename)(handlersPath)}`);
     } else {
-      const existing = (0, import_node_fs6.readFileSync)(handlersPath, "utf8");
+      const existing = (0, import_node_fs7.readFileSync)(handlersPath, "utf8");
       if (existing.includes(`function ${name}(`)) {
-        console.error(`  Error: handler "${name}" already exists in ${(0, import_node_path4.basename)(handlersPath)}`);
+        console.error(`  Error: handler "${name}" already exists in ${(0, import_node_path5.basename)(handlersPath)}`);
         process.exit(1);
       }
-      (0, import_node_fs6.appendFileSync)(handlersPath, buildStub(name, flags.method, flags.path), "utf8");
-      console.log(`  Added handler "${name}" to ${(0, import_node_path4.basename)(handlersPath)}`);
+      (0, import_node_fs7.appendFileSync)(handlersPath, buildStub(name, flags.method, flags.path), "utf8");
+      console.log(`  Added handler "${name}" to ${(0, import_node_path5.basename)(handlersPath)}`);
     }
     if (flags.register) {
       if (!flags.method || !flags.path) {
         console.error("  Error: --register requires --method and --path");
         process.exit(1);
       }
-      if (!(0, import_node_fs6.existsSync)(dbPath)) {
+      if (!(0, import_node_fs7.existsSync)(dbPath)) {
         console.error(`  Error: database file not found at ${dbPath}`);
         process.exit(1);
       }
-      const raw = (0, import_yaml3.parse)((0, import_node_fs6.readFileSync)(dbPath, "utf8")) ?? {};
+      const raw = (0, import_yaml3.parse)((0, import_node_fs7.readFileSync)(dbPath, "utf8")) ?? {};
       if (!Array.isArray(raw["_routes"])) raw["_routes"] = [];
       const routes = raw["_routes"];
       const alreadyRegistered = routes.some((r) => r["handler"] === name);
       if (!alreadyRegistered) {
         routes.push({ method: flags.method.toUpperCase(), path: flags.path, handler: name });
-        (0, import_node_fs6.writeFileSync)(dbPath, (0, import_yaml3.stringify)(raw), "utf8");
-        console.log(`  Added _routes entry to ${(0, import_node_path4.basename)(dbPath)}`);
+        (0, import_node_fs7.writeFileSync)(dbPath, (0, import_yaml3.stringify)(raw), "utf8");
+        console.log(`  Added _routes entry to ${(0, import_node_path5.basename)(dbPath)}`);
       } else {
         console.log(`  Handler "${name}" already in _routes \u2014 skipped`);
       }
@@ -1606,10 +1663,10 @@ function registerHandler(program2) {
     console.log(`
   Next steps:`);
     if (!fileConfig.handlers) {
-      console.log(`    1. Add  handlers: ${(0, import_node_path4.basename)(handlersPath)}  to yrest.config.yml`);
-      console.log(`    2. Implement the "${name}" function in ${(0, import_node_path4.basename)(handlersPath)}`);
+      console.log(`    1. Add  handlers: ${(0, import_node_path5.basename)(handlersPath)}  to yrest.config.yml`);
+      console.log(`    2. Implement the "${name}" function in ${(0, import_node_path5.basename)(handlersPath)}`);
     } else {
-      console.log(`    1. Implement the "${name}" function in ${(0, import_node_path4.basename)(handlersPath)}`);
+      console.log(`    1. Implement the "${name}" function in ${(0, import_node_path5.basename)(handlersPath)}`);
     }
     if (!flags.register) {
       console.log(