shokupan 0.10.0 → 0.10.2

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from './context';
 export * from './middleware';
+export * from './router';
 export * from './shokupan';
 export * from './util/decorators';
 export * from './util/di';
@@ -7,6 +8,7 @@ export * from './util/request';
 export * from './util/response';
 export * from './util/symbol';
 export * from './util/types';
+export * from './plugins/application/api-explorer/plugin';
 export * from './plugins/application/asyncapi/plugin';
 export * from './plugins/application/auth';
 export * from './plugins/application/cluster';

package/dist/index.js

@@ -1,19 +1,19 @@
 import { nanoid } from "nanoid";
 import { readFile } from "node:fs/promises";
 import { inspect } from "node:util";
-import { trace, SpanKind, SpanStatusCode, context } from "@opentelemetry/api";
-import { dump } from "js-yaml";
-import { AsyncLocalStorage } from "node:async_hooks";
 import { RecordId, Surreal } from "surrealdb";
 import { Eta } from "eta";
 import { stat, readdir, readFile as readFile$1 } from "fs/promises";
 import { resolve, join, sep, basename } from "path";
+import { trace, SpanKind, SpanStatusCode, context } from "@opentelemetry/api";
+import { dump } from "js-yaml";
+import { AsyncLocalStorage } from "node:async_hooks";
 import * as os from "node:os";
 import os__default from "node:os";
-import { dirname, join as join$1 } from "node:path";
-import { fileURLToPath } from "node:url";
 import renderToString from "preact-render-to-string";
 import { jsxs, jsx, Fragment } from "preact/jsx-runtime";
+import { dirname, join as join$1 } from "node:path";
+import { fileURLToPath } from "node:url";
 import cluster from "node:cluster";
 import net from "node:net";
 import { monitorEventLoopDelay } from "node:perf_hooks";
@@ -1317,40 +1317,6 @@ async function generateOpenApi(rootRouter, options = {}) {
     "x-tagGroups": xTagGroups
   };
 }
-class RequestContextStore {
-  request;
-  span;
-}
-const asyncContext = new AsyncLocalStorage();
-class HttpError extends Error {
-  status;
-  constructor(message, status) {
-    super(message);
-    this.name = "HttpError";
-    this.status = status;
-    if (Error.captureStackTrace) {
-      Error.captureStackTrace(this, HttpError);
-    }
-  }
-}
-function getErrorStatus(err) {
-  if (!err || typeof err !== "object") {
-    return 500;
-  }
-  if (typeof err.status === "number") {
-    return err.status;
-  }
-  if (typeof err.statusCode === "number") {
-    return err.statusCode;
-  }
-  return 500;
-}
-class EventError extends HttpError {
-  constructor(message = "Event Error") {
-    super(message, 500);
-    this.name = "EventError";
-  }
-}
 const eta = new Eta();
 function serveStatic(config, prefix) {
   const rootPath = resolve(config.root || ".");
@@ -1536,6 +1502,35 @@ function Inject(token) {
     });
   };
 }
+class HttpError extends Error {
+  status;
+  constructor(message, status) {
+    super(message);
+    this.name = "HttpError";
+    this.status = status;
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, HttpError);
+    }
+  }
+}
+function getErrorStatus(err) {
+  if (!err || typeof err !== "object") {
+    return 500;
+  }
+  if (typeof err.status === "number") {
+    return err.status;
+  }
+  if (typeof err.statusCode === "number") {
+    return err.statusCode;
+  }
+  return 500;
+}
+class EventError extends HttpError {
+  constructor(message = "Event Error") {
+    super(message, 500);
+    this.name = "EventError";
+  }
+}
 const tracer = trace.getTracer("shokupan.middleware");
 function traceHandler(fn, name) {
   return async function(...args) {
@@ -1725,6 +1720,8 @@ var RouteParamType = /* @__PURE__ */ ((RouteParamType2) => {
   RouteParamType2["CONTEXT"] = "CONTEXT";
   return RouteParamType2;
 })(RouteParamType || {});
+const RouterRegistry = /* @__PURE__ */ new Map();
+const ShokupanApplicationTree = {};
 class ShokupanRouter {
   constructor(config) {
     this.config = config;
@@ -2719,6 +2716,11 @@ class ShokupanRouter {
     }
   }
 }
+class RequestContextStore {
+  request;
+  span;
+}
+const asyncContext = new AsyncLocalStorage();
 class SystemCpuMonitor {
   constructor(intervalMs = 1e3) {
     this.intervalMs = intervalMs;
@@ -3523,6 +3525,281 @@ function Event(eventName) {
 function RateLimit(options) {
   return Use(RateLimitMiddleware(options));
 }
+function ApiExplorerApp({ spec, asyncSpec, config }) {
+  const hierarchy = /* @__PURE__ */ new Map();
+  const addRoute = (groupKey, route) => {
+    if (!hierarchy.has(groupKey)) {
+      hierarchy.set(groupKey, []);
+    }
+    hierarchy.get(groupKey).push(route);
+  };
+  const getGroupKey = (op, source) => {
+    if (op.tags && op.tags.length > 0) {
+      const tag = typeof op.tags[0] === "string" ? op.tags[0] : op.tags[0].name;
+      if (!tag.startsWith("/")) return tag;
+    }
+    if (source?.className) return source.className;
+    if (source?.file) {
+      const parts = source.file.split("/");
+      const filename = parts[parts.length - 1].replace(/\.(ts|js)$/, "");
+      return filename.split(/[-_]/).map((w) => w.charAt(0).toUpperCase() + w.slice(1)).join(" ");
+    }
+    if (op.tags && op.tags.length > 0) {
+      const tag = typeof op.tags[0] === "string" ? op.tags[0] : op.tags[0].name;
+      return tag;
+    }
+    return "Ungrouped";
+  };
+  const createSubgroups = (routes, depth = 0) => {
+    if (routes.length < 3 || depth > 5) {
+      return routes.map((route) => ({
+        name: route.path,
+        type: "route",
+        path: route.path,
+        routes: [route]
+      }));
+    }
+    const pathSegments = routes.map((r) => {
+      const cleaned = r.path.replace(/^\/|\/$/g, "");
+      return cleaned.split("/");
+    });
+    const prefixGroups = /* @__PURE__ */ new Map();
+    const ungrouped = [];
+    routes.forEach((route, idx) => {
+      const segments = pathSegments[idx];
+      if (segments.length <= depth) {
+        ungrouped.push(route);
+        return;
+      }
+      const prefix = segments.slice(0, depth + 1).join("/");
+      if (!prefixGroups.has(prefix)) {
+        prefixGroups.set(prefix, []);
+      }
+      prefixGroups.get(prefix).push(route);
+    });
+    const result = [];
+    prefixGroups.forEach((groupRoutes, prefix) => {
+      if (groupRoutes.length >= 3) {
+        const prefixName = prefix.split("/").pop() || prefix;
+        result.push({
+          name: prefixName,
+          type: "subgroup",
+          path: "/" + prefix,
+          children: createSubgroups(groupRoutes, depth + 1)
+        });
+      } else {
+        ungrouped.push(...groupRoutes);
+      }
+    });
+    ungrouped.forEach((route) => {
+      result.push({
+        name: route.path,
+        type: "route",
+        path: route.path,
+        routes: [route]
+      });
+    });
+    result.sort((a, b) => {
+      if (a.type === "subgroup" && b.type !== "subgroup") return -1;
+      if (a.type !== "subgroup" && b.type === "subgroup") return 1;
+      return a.name.localeCompare(b.name);
+    });
+    return result;
+  };
+  Object.entries(spec.paths || {}).forEach(([path, methods]) => {
+    Object.entries(methods).forEach(([method, op]) => {
+      if (!op.operationId) {
+        op.operationId = `${method}-${path.replace(/\//g, "-").replace(/[{}:]/g, "")}`;
+      }
+      const route = { method, path, op };
+      const source = op["x-shokupan-source"];
+      const groupKey = getGroupKey(op, source);
+      addRoute(groupKey, route);
+    });
+  });
+  Object.entries(asyncSpec?.channels || {}).forEach(([name, ch]) => {
+    const operations = [];
+    if (ch.publish) operations.push({ method: "recv", op: ch.publish });
+    if (ch.subscribe) operations.push({ method: "send", op: ch.subscribe });
+    operations.forEach(({ method, op }) => {
+      if (!op.operationId) op.operationId = `${method}-${name.replace(/[^a-zA-Z0-9]/g, "-")}`;
+      const route = { method, path: name, op };
+      const source = op["x-shokupan-source"] || op["x-source-info"];
+      const groupKey = getGroupKey(op, source);
+      addRoute(groupKey, route);
+    });
+  });
+  const hierarchicalGroups = Array.from(hierarchy.entries()).map(([name, routes]) => {
+    routes.sort((a, b) => a.path.localeCompare(b.path));
+    const children = createSubgroups(routes);
+    return {
+      name,
+      type: "group",
+      children
+    };
+  }).sort((a, b) => {
+    if (a.name === "Ungrouped") return 1;
+    if (b.name === "Ungrouped") return -1;
+    return a.name.localeCompare(b.name);
+  });
+  const allRoutes = Array.from(hierarchy.values()).flat();
+  return /* @__PURE__ */ jsxs("html", { lang: "en", children: [
+    /* @__PURE__ */ jsxs("head", { children: [
+      /* @__PURE__ */ jsx("meta", { charSet: "UTF-8" }),
+      /* @__PURE__ */ jsx("meta", { name: "viewport", content: "width=device-width, initial-scale=1.0" }),
+      /* @__PURE__ */ jsx("title", { children: spec.info?.title || "API Explorer" }),
+      /* @__PURE__ */ jsx("link", { rel: "stylesheet", href: "style.css" }),
+      /* @__PURE__ */ jsx("link", { rel: "stylesheet", href: "theme.css" }),
+      /* @__PURE__ */ jsx("script", { src: "https://cdn.jsdelivr.net/npm/marked@4.3.0/marked.min.js" }),
+      /* @__PURE__ */ jsx("script", { src: "https://cdn.jsdelivr.net/npm/monaco-editor@0.45.0/min/vs/loader.js" }),
+      /* @__PURE__ */ jsx("script", { dangerouslySetInnerHTML: {
+        __html: `
+                    (function() {
+                        if (!window.location.pathname.endsWith('/') && !window.location.pathname.split('/').pop().includes('.')) {
+                            var newUrl = window.location.pathname + '/' + window.location.search + window.location.hash;
+                            window.history.replaceState(null, null, newUrl);
+                            window.location.reload(); 
+                        }
+                    })();
+                `
+      } })
+    ] }),
+    /* @__PURE__ */ jsxs("body", { class: "dark-theme", children: [
+      /* @__PURE__ */ jsxs("div", { id: "app", children: [
+        /* @__PURE__ */ jsx(Sidebar$1, { spec, hierarchicalGroups }),
+        /* @__PURE__ */ jsx(MainContent$1, { allRoutes, config, spec })
+      ] }),
+      /* @__PURE__ */ jsx("script", { src: "explorer-client.mjs", type: "module" })
+    ] })
+  ] });
+}
+function Sidebar$1({ spec, hierarchicalGroups }) {
+  const renderNavNode = (node, depth = 0) => {
+    if (node.type === "route") {
+      const route = node.routes[0];
+      const source = route.op["x-shokupan-source"] || route.op["x-source-info"];
+      const isRuntime = route.op["x-source-info"]?.isRuntime;
+      return /* @__PURE__ */ jsxs("div", { class: "nav-item-wrapper", style: `padding-left: ${depth * 12}px;`, children: [
+        /* @__PURE__ */ jsxs(
+          "a",
+          {
+            href: `#${route.op.operationId}`,
+            class: "nav-item",
+            "data-id": route.op.operationId,
+            title: route.path,
+            children: [
+              /* @__PURE__ */ jsx("span", { class: `badge badge-${route.method.toUpperCase()}`, children: route.method.toUpperCase() }),
+              /* @__PURE__ */ jsx("span", { class: "nav-label", children: node.name }),
+              isRuntime && /* @__PURE__ */ jsx("span", { class: "nav-warning", title: "Static Analysis Failed", children: /* @__PURE__ */ jsxs("svg", { width: "12", height: "12", viewBox: "0 0 24 24", fill: "none", stroke: "currentColor", "stroke-width": "2", "stroke-linecap": "round", "stroke-linejoin": "round", children: [
+                /* @__PURE__ */ jsx("path", { d: "M10.29 3.86L1.82 18a2 2 0 0 0 1.71 3h16.94a2 2 0 0 0 1.71-3L13.71 3.86a2 2 0 0 0-3.42 0z" }),
+                /* @__PURE__ */ jsx("line", { x1: "12", y1: "9", x2: "12", y2: "13" }),
+                /* @__PURE__ */ jsx("line", { x1: "12", y1: "17", x2: "12.01", y2: "17" })
+              ] }) })
+            ]
+          },
+          route.op.operationId
+        ),
+        source?.file && /* @__PURE__ */ jsx(
+          "a",
+          {
+            href: `vscode://file/${source.file}:${source.line || 1}`,
+            class: "nav-source-link",
+            title: `${source.file}:${source.line || 1}`,
+            children: /* @__PURE__ */ jsxs("svg", { width: "12", height: "12", viewBox: "0 0 24 24", fill: "none", stroke: "currentColor", "stroke-width": "2", children: [
+              /* @__PURE__ */ jsx("polyline", { points: "16 18 22 12 16 6" }),
+              /* @__PURE__ */ jsx("polyline", { points: "8 6 2 12 8 18" })
+            ] })
+          }
+        )
+      ] });
+    } else if (node.type === "subgroup") {
+      return /* @__PURE__ */ jsxs("div", { class: "nav-subgroup collapsed", style: `padding-left: ${depth * 12}px;`, children: [
+        /* @__PURE__ */ jsxs("div", { class: "nav-subgroup-title", children: [
+          /* @__PURE__ */ jsx("span", { class: "chevron", children: /* @__PURE__ */ jsx("svg", { width: "10", height: "10", viewBox: "0 0 24 24", fill: "none", stroke: "currentColor", "stroke-width": "2", "stroke-linecap": "round", "stroke-linejoin": "round", children: /* @__PURE__ */ jsx("polyline", { points: "9 18 15 12 9 6" }) }) }),
+          /* @__PURE__ */ jsx("span", { children: node.name })
+        ] }),
+        /* @__PURE__ */ jsx("div", { class: "nav-subgroup-items", children: node.children?.map((child) => renderNavNode(child, depth + 1)) })
+      ] });
+    }
+  };
+  return /* @__PURE__ */ jsxs("aside", { class: "sidebar", children: [
+    /* @__PURE__ */ jsx("div", { class: "resize-handle" }),
+    /* @__PURE__ */ jsxs("header", { class: "sidebar-header", children: [
+      /* @__PURE__ */ jsx("button", { class: "toggle-sidebar", children: "☰" }),
+      /* @__PURE__ */ jsx("h1", { children: spec.info?.title }),
+      /* @__PURE__ */ jsx("div", { class: "version", children: spec.info?.version })
+    ] }),
+    /* @__PURE__ */ jsx("div", { class: "sidebar-collapse-trigger", children: "➔" }),
+    /* @__PURE__ */ jsx("nav", { class: "nav-groups", children: hierarchicalGroups.map((group) => /* @__PURE__ */ jsxs("div", { class: "nav-group collapsed", children: [
+      /* @__PURE__ */ jsxs("div", { class: "nav-group-title", children: [
+        /* @__PURE__ */ jsx("span", { class: "chevron", children: /* @__PURE__ */ jsx("svg", { width: "12", height: "12", viewBox: "0 0 24 24", fill: "none", stroke: "currentColor", "stroke-width": "2", "stroke-linecap": "round", "stroke-linejoin": "round", children: /* @__PURE__ */ jsx("polyline", { points: "9 18 15 12 9 6" }) }) }),
+        " ",
+        group.name
+      ] }),
+      /* @__PURE__ */ jsx("div", { class: "nav-items", children: group.children?.map((child) => renderNavNode(child, 0)) })
+    ] }, group.name)) })
+  ] });
+}
+function MainContent$1({ allRoutes, config, spec }) {
+  const explorerData = JSON.stringify({
+    routes: allRoutes,
+    config,
+    info: spec.info
+  });
+  const safeJson = explorerData.replace(/<\/script>/g, "<\\/script>");
+  return /* @__PURE__ */ jsxs("main", { class: "content", id: "main-content", children: [
+    /* @__PURE__ */ jsx("div", { id: "ide-container", children: /* @__PURE__ */ jsx("div", { class: "empty-state", children: "Select a request to view details" }) }),
+    /* @__PURE__ */ jsx("script", { id: "explorer-data", type: "application/json", dangerouslySetInnerHTML: { __html: safeJson } })
+  ] });
+}
+class ApiExplorerPlugin extends ShokupanRouter {
+  constructor(pluginOptions) {
+    super({ renderer: renderToString });
+    this.pluginOptions = pluginOptions;
+    pluginOptions.path ??= "/explorer";
+    const serveFile = async (ctx, file, type) => {
+      const content = await readFile$1(join(__dirname, "static", file), "utf-8");
+      ctx.set("Content-Type", type);
+      return ctx.send(content);
+    };
+    const stripSourceCode = (spec) => {
+      if (!spec || !spec.paths) return spec;
+      Object.values(spec.paths).forEach((methods) => {
+        Object.values(methods).forEach((op) => {
+          if (op["x-source-info"]?.snippet) {
+            delete op["x-source-info"].snippet;
+          }
+          if (op["x-shokupan-source"]?.code) {
+            delete op["x-shokupan-source"].code;
+          }
+        });
+      });
+      return spec;
+    };
+    this.get("/style.css", (ctx) => serveFile(ctx, "style.css", "text/css"));
+    this.get("/theme.css", (ctx) => serveFile(ctx, "theme.css", "text/css"));
+    this.get("/explorer-client.mjs", (ctx) => serveFile(ctx, "explorer-client.mjs", "application/javascript"));
+    this.get("/_source", async (ctx) => {
+      const file = ctx.query["file"];
+      if (!file) return ctx.text("Missing file parameter", 400);
+      try {
+        const content = await readFile$1(file, "utf-8");
+        return ctx.text(content);
+      } catch (err) {
+        return ctx.text("File not found", 404);
+      }
+    });
+    this.get("/openapi.json", async (ctx) => {
+      const spec = this.root.openApiSpec ? structuredClone(this.root.openApiSpec) : await (this.root || this).generateApiSpec();
+      return ctx.json(stripSourceCode(spec));
+    });
+    this.get("/", async (ctx) => {
+      const spec = this.root.openApiSpec ? structuredClone(this.root.openApiSpec) : await (this.root || this).generateApiSpec();
+      const asyncSpec = ctx.app.asyncApiSpec;
+      return ctx.jsx(ApiExplorerApp({ spec: stripSourceCode(spec), asyncSpec }));
+    });
+  }
+}
 function AsyncApiApp({ spec, serverUrl, base, disableSourceView, navTree }) {
   return /* @__PURE__ */ jsxs("html", { lang: "en", children: [
     /* @__PURE__ */ jsxs("head", { children: [
@@ -6364,6 +6641,7 @@ export {
   $url,
   $ws,
   All,
+  ApiExplorerPlugin,
   AsyncApiPlugin,
   AuthPlugin,
   Body,
@@ -6394,13 +6672,16 @@ export {
   RateLimitMiddleware,
   Req,
   RouteParamType,
+  RouterRegistry,
   ScalarPlugin,
   SecurityHeaders,
   Session,
   Shokupan,
+  ShokupanApplicationTree,
   ShokupanContext,
   ShokupanRequest,
   ShokupanResponse,
+  ShokupanRouter,
   Spec,
   Use,
   ValidationError,