@yrest/cli 0.11.1 → 0.12.0

package/dist/index.mjs

@@ -130,6 +130,49 @@ var init_parseRelations = __esm({
   }
 });
 
+// src/storage/parseSseRoutes.ts
+function parseSseRoutes(raw) {
+  if (!Array.isArray(raw)) return [];
+  return raw.map(normaliseSseRoute).filter((r) => r !== null);
+}
+function normaliseSseRoute(raw) {
+  if (!raw || typeof raw !== "object" || Array.isArray(raw)) return null;
+  const v = raw;
+  const method = typeof v["_method"] === "string" ? v["_method"].toUpperCase() : null;
+  const path2 = v["_path"];
+  const sse = v["_sse"];
+  if (method !== "SSE") return null;
+  if (typeof path2 !== "string" || !sse || typeof sse !== "object" || Array.isArray(sse)) {
+    return null;
+  }
+  const s = sse;
+  const rawEvents = s["_events"];
+  if (!Array.isArray(rawEvents)) return null;
+  const events = rawEvents.map(normaliseEvent).filter((e) => e !== null);
+  if (!events.length) return null;
+  return {
+    path: path2,
+    interval: typeof s["_interval"] === "number" ? s["_interval"] : 1e3,
+    loop: s["_loop"] !== false,
+    repeat: typeof s["_repeat"] === "number" ? s["_repeat"] : void 0,
+    events
+  };
+}
+function normaliseEvent(raw) {
+  if (!raw || typeof raw !== "object" || Array.isArray(raw)) return null;
+  const v = raw;
+  if (!("_data" in v)) return null;
+  const event = { data: v["_data"] };
+  if (typeof v["_event"] === "string") event.event = v["_event"];
+  return event;
+}
+var init_parseSseRoutes = __esm({
+  "src/storage/parseSseRoutes.ts"() {
+    "use strict";
+    init_esm_shims();
+  }
+});
+
 // src/storage/parseSchema.ts
 function parseSchema(raw) {
   if (!raw || typeof raw !== "object" || Array.isArray(raw)) return {};
@@ -151,18 +194,48 @@ function normaliseFieldDef(value) {
   const v = value;
   const def = {};
   if (v["_required"] === true || v["_required"] === false) def.required = v["_required"];
-  if (typeof v["_type"] === "string" && ["string", "integer", "number", "boolean", "object", "array"].includes(v["_type"]))
+  if (typeof v["_type"] === "string" && VALID_TYPES.has(v["_type"]))
     def.type = v["_type"];
   if (typeof v["_format"] === "string") def.format = v["_format"];
   if (Array.isArray(v["_enum"])) def.enum = v["_enum"];
   if (typeof v["_description"] === "string") def.description = v["_description"];
   if (v["_default"] !== void 0) def.default = v["_default"];
+  if (v["_example"] !== void 0) def.example = v["_example"];
+  if (v["_nullable"] === true || v["_nullable"] === false) def.nullable = v["_nullable"];
+  if (typeof v["_minLength"] === "number") def.minLength = v["_minLength"];
+  if (typeof v["_maxLength"] === "number") def.maxLength = v["_maxLength"];
+  if (typeof v["_pattern"] === "string") def.pattern = v["_pattern"];
+  if (typeof v["_minimum"] === "number") def.minimum = v["_minimum"];
+  if (typeof v["_maximum"] === "number") def.maximum = v["_maximum"];
+  if (typeof v["_exclusiveMinimum"] === "number") def.exclusiveMinimum = v["_exclusiveMinimum"];
+  if (typeof v["_exclusiveMaximum"] === "number") def.exclusiveMaximum = v["_exclusiveMaximum"];
+  if (typeof v["_multipleOf"] === "number") def.multipleOf = v["_multipleOf"];
+  if (typeof v["_minItems"] === "number") def.minItems = v["_minItems"];
+  if (typeof v["_maxItems"] === "number") def.maxItems = v["_maxItems"];
+  if (v["_uniqueItems"] === true || v["_uniqueItems"] === false)
+    def.uniqueItems = v["_uniqueItems"];
+  if (v["_items"] && typeof v["_items"] === "object" && !Array.isArray(v["_items"])) {
+    const items = v["_items"];
+    const itemsDef = {};
+    if (typeof items["_type"] === "string" && VALID_TYPES.has(items["_type"]))
+      itemsDef.type = items["_type"];
+    if (typeof items["_format"] === "string") itemsDef.format = items["_format"];
+    if (Array.isArray(items["_enum"])) itemsDef.enum = items["_enum"];
+    def.items = itemsDef;
+  }
+  if (v["_deprecated"] === true || v["_deprecated"] === false)
+    def.deprecated = v["_deprecated"];
+  if (v["_readOnly"] === true || v["_readOnly"] === false) def.readOnly = v["_readOnly"];
+  if (v["_writeOnly"] === true || v["_writeOnly"] === false)
+    def.writeOnly = v["_writeOnly"];
   return def;
 }
+var VALID_TYPES;
 var init_parseSchema = __esm({
   "src/storage/parseSchema.ts"() {
     "use strict";
     init_esm_shims();
+    VALID_TYPES = /* @__PURE__ */ new Set(["string", "integer", "number", "boolean", "object", "array"]);
   }
 });
 
@@ -188,6 +261,8 @@ function normaliseRoute(raw) {
   if (!raw || typeof raw !== "object" || Array.isArray(raw)) return null;
   const v = raw;
   const method = v["_method"];
+  if (typeof method === "string" && method.toUpperCase() === "SSE") return null;
+  if ("_sse" in v) return null;
   const path2 = v["_path"];
   if (typeof method !== "string" || typeof path2 !== "string") return null;
   const route = { method, path: path2 };
@@ -233,6 +308,30 @@ var init_parseRoutes = __esm({
   }
 });
 
+// src/storage/parseData.ts
+function parseData(raw) {
+  const block = raw["_data"];
+  const fromBlock = block && typeof block === "object" && !Array.isArray(block) ? Object.fromEntries(
+    Object.entries(block).filter(([, v]) => Array.isArray(v))
+  ) : {};
+  const fromRoot = Object.fromEntries(
+    Object.entries(raw).filter(([key, val]) => !RESERVED.has(key) && Array.isArray(val))
+  );
+  return { ...fromBlock, ...fromRoot };
+}
+function hasDataBlock(raw) {
+  const d = raw["_data"];
+  return d !== null && d !== void 0 && typeof d === "object" && !Array.isArray(d);
+}
+var RESERVED;
+var init_parseData = __esm({
+  "src/storage/parseData.ts"() {
+    "use strict";
+    init_esm_shims();
+    RESERVED = /* @__PURE__ */ new Set(["_rel", "_routes", "_schema", "_data"]);
+  }
+});
+
 // src/storage/yrestStorage.ts
 var yrestStorage_exports = {};
 __export(yrestStorage_exports, {
@@ -299,13 +398,12 @@ function serializeScenario(s) {
 function createYrestStorage(filePath) {
   const absPath = resolve(filePath);
   const raw = parse2(readFileSync2(absPath, "utf8")) ?? {};
-  const RESERVED = /* @__PURE__ */ new Set(["_rel", "_routes", "_schema"]);
   const relations = parseRelations(raw["_rel"]);
   const routes = parseRoutes(raw["_routes"]);
+  const sseRoutes = parseSseRoutes(raw["_routes"]);
   const schema = parseSchema(raw["_schema"]);
-  const data = Object.fromEntries(
-    Object.entries(raw).filter(([key]) => !RESERVED.has(key))
-  );
+  const dataBlock = hasDataBlock(raw);
+  const data = parseData(raw);
   let snapshot = {
     data: deepCopyData(data),
     relations: { ...relations },
@@ -324,6 +422,9 @@ function createYrestStorage(filePath) {
     getRoutes() {
       return routes;
     },
+    getSseRoutes() {
+      return sseRoutes;
+    },
     getCollection(name) {
       return data[name];
     },
@@ -334,7 +435,11 @@ function createYrestStorage(filePath) {
       const payload = {};
       if (Object.keys(relations).length > 0) payload._rel = serializeRelations(relations);
       if (routes.length > 0) payload._routes = serializeRoutes(routes);
-      Object.assign(payload, data);
+      if (dataBlock) {
+        payload._data = data;
+      } else {
+        Object.assign(payload, data);
+      }
       const tmp = resolve(dirname2(absPath), `.yrest-${randomUUID2()}.tmp`);
       writeFileSync(tmp, stringify2(payload), "utf8");
       renameSync(tmp, absPath);
@@ -342,9 +447,7 @@ function createYrestStorage(filePath) {
     reload() {
       const fresh = parse2(readFileSync2(absPath, "utf8")) ?? {};
       const freshRelations = parseRelations(fresh["_rel"]);
-      const freshData = Object.fromEntries(
-        Object.entries(fresh).filter(([key]) => !RESERVED.has(key))
-      );
+      const freshData = parseData(fresh);
       for (const key of Object.keys(data)) delete data[key];
       Object.assign(data, freshData);
       for (const key of Object.keys(relations)) delete relations[key];
@@ -376,7 +479,9 @@ var init_yrestStorage = __esm({
     init_esm_shims();
     init_parseRelations();
     init_parseRoutes();
+    init_parseSseRoutes();
     init_parseSchema();
+    init_parseData();
     init_deepCopy();
   }
 });
@@ -429,6 +534,7 @@ function dedent(str) {
 // src/api/yrestServer.ts
 init_esm_shims();
 init_parseRelations();
+init_parseSseRoutes();
 init_parseSchema();
 import { resolve as resolve2 } from "path";
 
@@ -541,6 +647,8 @@ var METHOD_COLOR = {
   PUT: "#d29922",
   PATCH: "#a371f7",
   DELETE: "#f85149",
+  SSE: "#0ea5e9",
+  WS: "#8b5cf6",
   fn: "#f0883e"
 };
 function escapeHtml(str) {
@@ -732,6 +840,30 @@ function handlersAccordion(handlers, routes, base) {
     </tbody></table>
   </details>`;
 }
+function sseRoutesAccordion(routes, base) {
+  if (!routes.length) return "";
+  const rows = routes.map((r) => {
+    const tags = [
+      `<span style="color:#0ea5e9;font-size:11px">interval\xB7${r.interval}ms</span>`,
+      `<span style="color:var(--text-muted);font-size:11px">${r.events.length} event${r.events.length !== 1 ? "s" : ""}</span>`
+    ];
+    if (!r.loop) tags.push(`<span style="color:var(--text-muted);font-size:11px">no\xB7loop</span>`);
+    if (r.repeat !== void 0)
+      tags.push(`<span style="color:var(--text-muted);font-size:11px">repeat\xB7${r.repeat}\xD7</span>`);
+    const desc = `SSE stream&ensp;${tags.join("&ensp;")}`;
+    return endpointRow("SSE", `${base}${r.path}`, desc);
+  });
+  return `
+  <details class="resource-card nested-card">
+    <summary>
+      <span class="resource-name">SSE streams</span>
+      <span class="route-count">${routes.length} stream${routes.length !== 1 ? "s" : ""}</span>
+    </summary>
+    <table><tbody>
+      ${rows.join("")}
+    </tbody></table>
+  </details>`;
+}
 function examplesBlock(collections, relations, base, host, options, firstCustomRoute) {
   const examples = [];
   const firstCol = collections[0];
@@ -1404,6 +1536,7 @@ function generateAboutHtml(storage, options, handlers = /* @__PURE__ */ new Map(
   const collections = Object.keys(storage.getData());
   const relations = storage.getRelations();
   const customRoutes = storage.getRoutes();
+  const sseRoutes = storage.getSseRoutes();
   const base = options.base;
   const host = `http://${options.host}:${options.port}`;
   const swaggerUrl = `https://petstore.swagger.io/?url=${encodeURIComponent(`${host}/_openapi.json`)}`;
@@ -1587,6 +1720,7 @@ function generateAboutHtml(storage, options, handlers = /* @__PURE__ */ new Map(
           ${accordions}
           ${nestedRoutesAccordion(relations, base)}
           ${options.snapshot ? snapshotAccordion() : ""}
+          ${sseRoutesAccordion(sseRoutes, base)}
           ${customRoutesAccordion(customRoutes, base, handlers)}
           ${handlersAccordion(handlers, customRoutes, base)}
         </div>
@@ -2025,15 +2159,19 @@ function resolveRequestPath(dotPath, req) {
   const [root, ...rest] = dotPath.split(".");
   let value;
   switch (root) {
+    case "_body":
     case "body":
       value = req.body;
       break;
+    case "_params":
     case "params":
       value = req.params;
       break;
+    case "_query":
     case "query":
       value = req.query;
       break;
+    case "_headers":
     case "headers":
       value = req.headers;
       break;
@@ -2334,6 +2472,23 @@ function buildCollectionSchema(items, fieldDefs = {}) {
     if (def?.description) prop.description = def.description;
     if (def?.enum) prop.enum = def.enum;
     if (def?.default !== void 0) prop.default = def.default;
+    if (def?.example !== void 0) prop.example = def.example;
+    if (def?.nullable) prop.nullable = def.nullable;
+    if (def?.minLength !== void 0) prop.minLength = def.minLength;
+    if (def?.maxLength !== void 0) prop.maxLength = def.maxLength;
+    if (def?.pattern) prop.pattern = def.pattern;
+    if (def?.minimum !== void 0) prop.minimum = def.minimum;
+    if (def?.maximum !== void 0) prop.maximum = def.maximum;
+    if (def?.exclusiveMinimum !== void 0) prop.exclusiveMinimum = def.exclusiveMinimum;
+    if (def?.exclusiveMaximum !== void 0) prop.exclusiveMaximum = def.exclusiveMaximum;
+    if (def?.multipleOf !== void 0) prop.multipleOf = def.multipleOf;
+    if (def?.items) prop.items = def.items;
+    if (def?.minItems !== void 0) prop.minItems = def.minItems;
+    if (def?.maxItems !== void 0) prop.maxItems = def.maxItems;
+    if (def?.uniqueItems !== void 0) prop.uniqueItems = def.uniqueItems;
+    if (def?.deprecated) prop.deprecated = def.deprecated;
+    if (def?.readOnly) prop.readOnly = def.readOnly;
+    if (def?.writeOnly) prop.writeOnly = def.writeOnly;
     properties[field] = prop;
     if (def?.required === true) required.push(field);
   }
@@ -2718,6 +2873,80 @@ var SnapshotRouteCommand = class {
   }
 };
 
+// src/router/routes/sse.routes.ts
+init_esm_shims();
+var SSERouteCommand = class {
+  constructor(storage, base) {
+    this.storage = storage;
+    this.base = base;
+  }
+  storage;
+  base;
+  register(server) {
+    for (const route of this.storage.getSseRoutes()) {
+      const url = `${this.base}${route.path}`;
+      server.route({
+        method: "GET",
+        url,
+        handler: async (req, reply) => {
+          reply.hijack();
+          const raw = reply.raw;
+          raw.setHeader("Content-Type", "text/event-stream");
+          raw.setHeader("Cache-Control", "no-cache");
+          raw.setHeader("Connection", "keep-alive");
+          raw.setHeader("Access-Control-Allow-Origin", "*");
+          raw.flushHeaders();
+          let alive = true;
+          req.raw.on("close", () => {
+            alive = false;
+          });
+          const keepAlive = setInterval(() => {
+            if (alive) raw.write(": ping\n\n");
+          }, 15e3);
+          let frameIndex = 0;
+          let cycleCount = 0;
+          function sendNext() {
+            if (!alive) {
+              clearInterval(keepAlive);
+              return;
+            }
+            const ev = route.events[frameIndex];
+            const ctx = {
+              params: req.params,
+              query: req.query,
+              body: null,
+              headers: req.headers
+            };
+            const data = hasTemplates(ev.data) ? interpolate(ev.data, ctx) : ev.data;
+            let chunk = "";
+            if (ev.event) chunk += `event: ${ev.event}
+`;
+            chunk += `data: ${JSON.stringify(data)}
+
+`;
+            raw.write(chunk);
+            frameIndex++;
+            if (frameIndex >= route.events.length) {
+              frameIndex = 0;
+              cycleCount++;
+              const done = !route.loop || route.repeat !== void 0 && cycleCount >= route.repeat;
+              if (done) {
+                clearInterval(keepAlive);
+                raw.end();
+                return;
+              }
+            }
+            if (alive) {
+              setTimeout(sendNext, route.interval);
+            }
+          }
+          sendNext();
+        }
+      });
+    }
+  }
+};
+
 // src/router/resource.router.ts
 function buildResourceRouteCommands(storage, options) {
   const commands = [];
@@ -2759,6 +2988,7 @@ async function createServer(storage, options, handlers = /* @__PURE__ */ new Map
     new AboutRouteCommand(storage, options, handlers),
     new OpenApiRouteCommand(storage, options),
     ...options.snapshot ? [new SnapshotRouteCommand(storage)] : [],
+    new SSERouteCommand(storage, options.base),
     new CustomRouteCommand(storage, options.base, handlers),
     ...buildResourceRouteCommands(storage, options)
   ];
@@ -2837,12 +3067,13 @@ function buildOptions(opts) {
 }
 function createInMemoryStorage(data) {
   const raw = data;
-  const RESERVED = /* @__PURE__ */ new Set(["_rel", "_routes", "_schema"]);
+  const RESERVED2 = /* @__PURE__ */ new Set(["_rel", "_routes", "_schema"]);
   const relations = parseRelations(raw["_rel"]);
   const routes = Array.isArray(raw["_routes"]) ? raw["_routes"] : [];
+  const sseRoutes = parseSseRoutes(raw["_routes"]);
   const schema = parseSchema(raw["_schema"]);
   const collections = Object.fromEntries(
-    Object.entries(raw).filter(([k]) => !RESERVED.has(k))
+    Object.entries(raw).filter(([k]) => !RESERVED2.has(k))
   );
   let snapshot = {
     data: deepCopyData(collections),
@@ -2854,6 +3085,7 @@ function createInMemoryStorage(data) {
     getRelations: () => relations,
     getSchema: () => schema,
     getRoutes: () => routes,
+    getSseRoutes: () => sseRoutes,
     getCollection: (name) => collections[name],
     setCollection: (name, items) => {
       collections[name] = items;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yrest/cli",
-  "version": "0.11.1",
+  "version": "0.12.0",
   "description": "YAML-powered json-server alternative. Zero-config REST API mock server with full CRUD, relations, filters and snapshots from a db.yml file.",
   "keywords": [
     "yrest",
@@ -60,12 +60,16 @@
     "dev": "tsup --watch",
     "test": "vitest",
     "test:run": "vitest run",
+    "test:unit": "vitest run tests/config tests/cli tests/storage tests/utils",
+    "test:integration": "vitest run tests/routes tests/openapi tests/security tests/api",
+    "test:e2e": "vitest run tests/e2e",
+    "test:preflight": "vitest run",
     "typecheck": "tsc --noEmit",
     "lint": "eslint src tests",
     "lint:fix": "eslint src tests --fix",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
-    "prepublishOnly": "npm run test:run && npm run build",
+    "prepublishOnly": "npm run build && npm run test:preflight",
     "version": "node scripts/update-version-badge.mjs && git add README.md"
   },
   "dependencies": {