@lytjs/api 6.5.0

package/README.md

@@ -0,0 +1,74 @@
+# @lytjs/api
+
+LytJS API 路由引擎，文件系统驱动的 API 路由解决方案。
+
+## 安装
+
+```bash
+pnpm add @lytjs/api
+```
+
+## 快速开始
+
+```typescript
+import { createApiRouter } from '@lytjs/api';
+
+const apiRouter = createApiRouter({
+  apiDir: './src/api',
+});
+
+// 处理请求
+const response = await apiRouter.handle({
+  url: 'http://localhost/api/users',
+  method: 'GET',
+  headers: {},
+});
+```
+
+## 特性
+
+- 文件系统 API 路由
+- RESTful API 规范
+- 支持中间件
+- 零外部依赖
+
+## API
+
+### createApiRouter(options)
+
+创建 API 路由引擎实例。
+
+```typescript
+import { createApiRouter } from '@lytjs/api';
+
+const router = createApiRouter({
+  apiDir: './src/api',
+});
+```
+
+### router.addRoute(route)
+
+添加 API 路由。
+
+### router.match(request)
+
+匹配 API 路由。
+
+### router.handle(request, context)
+
+处理 API 请求。
+
+## 文件结构约定
+
+```
+src/
+└── api/
+    ├── index.ts      # GET /api
+    └── users/
+        ├── index.ts  # GET /api/users, POST /api/users
+        └── [id].ts   # GET /api/users/:id, PUT /api/users/:id, etc.
+```
+
+## 许可证
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,222 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  createApiRouter: () => createApiRouter
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/utils.ts
+var import_fs = require("fs");
+var import_path = require("path");
+function isDirectory(path) {
+  return (0, import_fs.existsSync)(path) && (0, import_fs.statSync)(path).isDirectory();
+}
+function isFile(path) {
+  return (0, import_fs.existsSync)(path) && (0, import_fs.statSync)(path).isFile();
+}
+var HTTP_METHODS = ["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD"];
+function extractHttpMethods(filename) {
+  const lower = filename.toLowerCase();
+  const methods = [];
+  for (const method of HTTP_METHODS) {
+    if (lower.includes(method.toLowerCase())) {
+      methods.push(method);
+    }
+  }
+  return methods.length > 0 ? methods : ["GET"];
+}
+function filePathToApiPath(filePath, baseDir, extensions) {
+  let normalized = (0, import_path.normalize)((0, import_path.relative)(baseDir, filePath));
+  for (const ext of extensions) {
+    if (normalized.endsWith(ext)) {
+      normalized = normalized.slice(0, -ext.length);
+      break;
+    }
+  }
+  normalized = normalized.replace(/\\/g, "/");
+  for (const method of HTTP_METHODS) {
+    if (normalized.toLowerCase().endsWith("." + method.toLowerCase())) {
+      normalized = normalized.slice(0, -(method.length + 1));
+    }
+  }
+  if (normalized.endsWith("/index")) {
+    normalized = normalized.slice(0, -6);
+  } else if (normalized === "index") {
+    normalized = "";
+  }
+  normalized = normalized.replace(/\[(\w+)\]/g, ":$1");
+  return normalized.startsWith("/") ? normalized : `/${normalized}`;
+}
+function extractDynamicParams(apiPath) {
+  const matches = apiPath.match(/:(\w+)/g);
+  return matches ? matches.map((m) => m.slice(1)) : [];
+}
+function scanApiDirectory(dir, baseDir, extensions, ignorePatterns) {
+  const routes = [];
+  if (!isDirectory(dir)) return routes;
+  const files = (0, import_fs.readdirSync)(dir);
+  for (const file of files) {
+    const fullPath = (0, import_path.join)(dir, file);
+    const relativePath = (0, import_path.relative)(baseDir, fullPath);
+    if (ignorePatterns.some((pattern) => {
+      if (relativePath.includes(pattern)) return true;
+      return file.includes(pattern);
+    })) {
+      continue;
+    }
+    if (isDirectory(fullPath)) {
+      routes.push(...scanApiDirectory(fullPath, baseDir, extensions, ignorePatterns));
+    } else if (isFile(fullPath)) {
+      const ext = extensions.find((e) => file.endsWith(e));
+      if (ext) {
+        const apiPath = filePathToApiPath(fullPath, baseDir, extensions);
+        const params = extractDynamicParams(apiPath);
+        const methods = extractHttpMethods(file);
+        routes.push({
+          path: apiPath,
+          methods,
+          handlerPath: fullPath,
+          isDynamic: params.length > 0,
+          params
+        });
+      }
+    }
+  }
+  return routes;
+}
+
+// src/index.ts
+var DEFAULT_OPTIONS = {
+  apiDir: "src/api",
+  extensions: [".ts", ".tsx", ".js", ".jsx"],
+  middlewarePattern: "_middleware",
+  ignorePatterns: ["node_modules", ".git", "dist"],
+  strictMode: false
+};
+function createApiRouter(options) {
+  const config = { ...DEFAULT_OPTIONS, ...options };
+  let routes = [];
+  async function refresh() {
+    routes = scanApiDirectory(
+      config.apiDir,
+      config.apiDir,
+      config.extensions,
+      config.ignorePatterns
+    );
+  }
+  function match(method, path) {
+    for (const route of routes) {
+      if (route.path === path && route.methods.includes(method)) {
+        return {
+          route,
+          method,
+          params: {},
+          path
+        };
+      }
+    }
+    const pathSegments = path.split("/").filter(Boolean);
+    for (const route of routes) {
+      if (!route.methods.includes(method)) continue;
+      const routeSegments = route.path.split("/").filter(Boolean);
+      if (routeSegments.length !== pathSegments.length) continue;
+      const params = {};
+      let match2 = true;
+      for (let i = 0; i < routeSegments.length; i++) {
+        const routeSeg = routeSegments[i];
+        const pathSeg = pathSegments[i];
+        if (!routeSeg || !pathSeg) continue;
+        if (routeSeg.startsWith(":")) {
+          params[routeSeg.slice(1)] = pathSeg;
+        } else if (routeSeg !== pathSeg) {
+          match2 = false;
+          break;
+        }
+      }
+      if (match2) {
+        return {
+          route,
+          method,
+          params,
+          path
+        };
+      }
+    }
+    return null;
+  }
+  async function handleRequest(method, path, _context) {
+    const matched = match(method, path);
+    if (!matched) {
+      return {
+        status: 404,
+        headers: { "Content-Type": "application/json" },
+        body: { error: "Not Found" }
+      };
+    }
+    try {
+      return {
+        status: 200,
+        headers: { "Content-Type": "application/json" },
+        body: {
+          message: "API Route Matched",
+          method,
+          path,
+          params: matched.params
+        }
+      };
+    } catch (error) {
+      return {
+        status: 500,
+        headers: { "Content-Type": "application/json" },
+        body: { error: "Internal Server Error", message: String(error) }
+      };
+    }
+  }
+  function getRoutes() {
+    return [...routes];
+  }
+  function addRoute(route) {
+    routes.push(route);
+  }
+  function removeRoute(path) {
+    routes = routes.filter((r) => r.path !== path);
+  }
+  function clearRoutes() {
+    routes = [];
+  }
+  refresh().catch((err) => {
+    console.warn("Failed to scan API routes:", err);
+  });
+  return {
+    getRoutes,
+    match,
+    addRoute,
+    removeRoute,
+    clearRoutes,
+    refresh,
+    handleRequest
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createApiRouter
+});

package/dist/index.d.cts

@@ -0,0 +1,104 @@
+/**
+ * @lytjs/api - 类型定义
+ */
+/** HTTP 请求方法 */
+type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS' | 'HEAD';
+/** API 路由配置 */
+interface ApiRouteConfig {
+    /** 路由路径 */
+    path: string;
+    /** HTTP 方法 */
+    methods: HttpMethod[];
+    /** 处理函数路径 */
+    handlerPath: string;
+    /** 是否为动态路由 */
+    isDynamic: boolean;
+    /** 动态路由参数名 */
+    params?: string[];
+    /** 中间件路径 */
+    middlewarePaths?: string[];
+}
+/** API 路由器配置选项 */
+interface ApiRouterOptions {
+    /** API 目录路径 */
+    apiDir: string;
+    /** API 处理函数扩展名 */
+    extensions?: string[];
+    /** 中间件文件名称模式 */
+    middlewarePattern?: string;
+    /** 忽略文件模式 */
+    ignorePatterns?: string[];
+    /** 是否启用严格模式 */
+    strictMode?: boolean;
+}
+/** API 请求上下文 */
+interface ApiRequestContext {
+    /** 请求方法 */
+    method: HttpMethod;
+    /** 请求路径 */
+    path: string;
+    /** 请求头 */
+    headers: Record<string, string>;
+    /** 请求参数 */
+    params: Record<string, string>;
+    /** 查询参数 */
+    query: Record<string, string | string[]>;
+    /** 请求体 */
+    body?: unknown;
+}
+/** API 响应对象 */
+interface ApiResponse {
+    /** 状态码 */
+    status: number;
+    /** 响应头 */
+    headers: Record<string, string>;
+    /** 响应体 */
+    body?: unknown;
+}
+/** API 处理函数 */
+type ApiHandler = (context: ApiRequestContext) => Promise<ApiResponse> | ApiResponse;
+/** API 中间件函数 */
+type ApiMiddleware = (context: ApiRequestContext, next: () => Promise<ApiResponse>) => Promise<ApiResponse>;
+/** API 匹配结果 */
+interface ApiMatch {
+    /** 匹配的路由配置 */
+    route: ApiRouteConfig;
+    /** 请求方法 */
+    method: HttpMethod;
+    /** 路由参数 */
+    params: Record<string, string>;
+    /** 请求路径 */
+    path: string;
+}
+/** API 路由器接口 */
+interface ApiRouter {
+    /** 获取所有 API 路由配置 */
+    getRoutes(): ApiRouteConfig[];
+    /** 匹配 API 路由 */
+    match(method: HttpMethod, path: string): ApiMatch | null;
+    /** 添加 API 路由 */
+    addRoute(route: ApiRouteConfig): void;
+    /** 移除 API 路由 */
+    removeRoute(path: string): void;
+    /** 清除所有 API 路由 */
+    clearRoutes(): void;
+    /** 重新扫描文件系统 */
+    refresh(): Promise<void>;
+    /** 处理 API 请求 */
+    handleRequest(method: HttpMethod, path: string, context: ApiRequestContext): Promise<ApiResponse>;
+}
+
+/**
+ * @lytjs/api
+ *
+ * LytJS API Router Engine
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * 创建 API 路由器
+ */
+declare function createApiRouter(options?: ApiRouterOptions): ApiRouter;
+
+export { type ApiHandler, type ApiMatch, type ApiMiddleware, type ApiRequestContext, type ApiResponse, type ApiRouteConfig, type ApiRouter, type ApiRouterOptions, type HttpMethod, createApiRouter };

package/dist/index.d.ts

@@ -0,0 +1,104 @@
+/**
+ * @lytjs/api - 类型定义
+ */
+/** HTTP 请求方法 */
+type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS' | 'HEAD';
+/** API 路由配置 */
+interface ApiRouteConfig {
+    /** 路由路径 */
+    path: string;
+    /** HTTP 方法 */
+    methods: HttpMethod[];
+    /** 处理函数路径 */
+    handlerPath: string;
+    /** 是否为动态路由 */
+    isDynamic: boolean;
+    /** 动态路由参数名 */
+    params?: string[];
+    /** 中间件路径 */
+    middlewarePaths?: string[];
+}
+/** API 路由器配置选项 */
+interface ApiRouterOptions {
+    /** API 目录路径 */
+    apiDir: string;
+    /** API 处理函数扩展名 */
+    extensions?: string[];
+    /** 中间件文件名称模式 */
+    middlewarePattern?: string;
+    /** 忽略文件模式 */
+    ignorePatterns?: string[];
+    /** 是否启用严格模式 */
+    strictMode?: boolean;
+}
+/** API 请求上下文 */
+interface ApiRequestContext {
+    /** 请求方法 */
+    method: HttpMethod;
+    /** 请求路径 */
+    path: string;
+    /** 请求头 */
+    headers: Record<string, string>;
+    /** 请求参数 */
+    params: Record<string, string>;
+    /** 查询参数 */
+    query: Record<string, string | string[]>;
+    /** 请求体 */
+    body?: unknown;
+}
+/** API 响应对象 */
+interface ApiResponse {
+    /** 状态码 */
+    status: number;
+    /** 响应头 */
+    headers: Record<string, string>;
+    /** 响应体 */
+    body?: unknown;
+}
+/** API 处理函数 */
+type ApiHandler = (context: ApiRequestContext) => Promise<ApiResponse> | ApiResponse;
+/** API 中间件函数 */
+type ApiMiddleware = (context: ApiRequestContext, next: () => Promise<ApiResponse>) => Promise<ApiResponse>;
+/** API 匹配结果 */
+interface ApiMatch {
+    /** 匹配的路由配置 */
+    route: ApiRouteConfig;
+    /** 请求方法 */
+    method: HttpMethod;
+    /** 路由参数 */
+    params: Record<string, string>;
+    /** 请求路径 */
+    path: string;
+}
+/** API 路由器接口 */
+interface ApiRouter {
+    /** 获取所有 API 路由配置 */
+    getRoutes(): ApiRouteConfig[];
+    /** 匹配 API 路由 */
+    match(method: HttpMethod, path: string): ApiMatch | null;
+    /** 添加 API 路由 */
+    addRoute(route: ApiRouteConfig): void;
+    /** 移除 API 路由 */
+    removeRoute(path: string): void;
+    /** 清除所有 API 路由 */
+    clearRoutes(): void;
+    /** 重新扫描文件系统 */
+    refresh(): Promise<void>;
+    /** 处理 API 请求 */
+    handleRequest(method: HttpMethod, path: string, context: ApiRequestContext): Promise<ApiResponse>;
+}
+
+/**
+ * @lytjs/api
+ *
+ * LytJS API Router Engine
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * 创建 API 路由器
+ */
+declare function createApiRouter(options?: ApiRouterOptions): ApiRouter;
+
+export { type ApiHandler, type ApiMatch, type ApiMiddleware, type ApiRequestContext, type ApiResponse, type ApiRouteConfig, type ApiRouter, type ApiRouterOptions, type HttpMethod, createApiRouter };

package/dist/index.mjs

@@ -0,0 +1,195 @@
+// src/utils.ts
+import { existsSync, readdirSync, statSync } from "fs";
+import { join, normalize, relative } from "path";
+function isDirectory(path) {
+  return existsSync(path) && statSync(path).isDirectory();
+}
+function isFile(path) {
+  return existsSync(path) && statSync(path).isFile();
+}
+var HTTP_METHODS = ["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD"];
+function extractHttpMethods(filename) {
+  const lower = filename.toLowerCase();
+  const methods = [];
+  for (const method of HTTP_METHODS) {
+    if (lower.includes(method.toLowerCase())) {
+      methods.push(method);
+    }
+  }
+  return methods.length > 0 ? methods : ["GET"];
+}
+function filePathToApiPath(filePath, baseDir, extensions) {
+  let normalized = normalize(relative(baseDir, filePath));
+  for (const ext of extensions) {
+    if (normalized.endsWith(ext)) {
+      normalized = normalized.slice(0, -ext.length);
+      break;
+    }
+  }
+  normalized = normalized.replace(/\\/g, "/");
+  for (const method of HTTP_METHODS) {
+    if (normalized.toLowerCase().endsWith("." + method.toLowerCase())) {
+      normalized = normalized.slice(0, -(method.length + 1));
+    }
+  }
+  if (normalized.endsWith("/index")) {
+    normalized = normalized.slice(0, -6);
+  } else if (normalized === "index") {
+    normalized = "";
+  }
+  normalized = normalized.replace(/\[(\w+)\]/g, ":$1");
+  return normalized.startsWith("/") ? normalized : `/${normalized}`;
+}
+function extractDynamicParams(apiPath) {
+  const matches = apiPath.match(/:(\w+)/g);
+  return matches ? matches.map((m) => m.slice(1)) : [];
+}
+function scanApiDirectory(dir, baseDir, extensions, ignorePatterns) {
+  const routes = [];
+  if (!isDirectory(dir)) return routes;
+  const files = readdirSync(dir);
+  for (const file of files) {
+    const fullPath = join(dir, file);
+    const relativePath = relative(baseDir, fullPath);
+    if (ignorePatterns.some((pattern) => {
+      if (relativePath.includes(pattern)) return true;
+      return file.includes(pattern);
+    })) {
+      continue;
+    }
+    if (isDirectory(fullPath)) {
+      routes.push(...scanApiDirectory(fullPath, baseDir, extensions, ignorePatterns));
+    } else if (isFile(fullPath)) {
+      const ext = extensions.find((e) => file.endsWith(e));
+      if (ext) {
+        const apiPath = filePathToApiPath(fullPath, baseDir, extensions);
+        const params = extractDynamicParams(apiPath);
+        const methods = extractHttpMethods(file);
+        routes.push({
+          path: apiPath,
+          methods,
+          handlerPath: fullPath,
+          isDynamic: params.length > 0,
+          params
+        });
+      }
+    }
+  }
+  return routes;
+}
+
+// src/index.ts
+var DEFAULT_OPTIONS = {
+  apiDir: "src/api",
+  extensions: [".ts", ".tsx", ".js", ".jsx"],
+  middlewarePattern: "_middleware",
+  ignorePatterns: ["node_modules", ".git", "dist"],
+  strictMode: false
+};
+function createApiRouter(options) {
+  const config = { ...DEFAULT_OPTIONS, ...options };
+  let routes = [];
+  async function refresh() {
+    routes = scanApiDirectory(
+      config.apiDir,
+      config.apiDir,
+      config.extensions,
+      config.ignorePatterns
+    );
+  }
+  function match(method, path) {
+    for (const route of routes) {
+      if (route.path === path && route.methods.includes(method)) {
+        return {
+          route,
+          method,
+          params: {},
+          path
+        };
+      }
+    }
+    const pathSegments = path.split("/").filter(Boolean);
+    for (const route of routes) {
+      if (!route.methods.includes(method)) continue;
+      const routeSegments = route.path.split("/").filter(Boolean);
+      if (routeSegments.length !== pathSegments.length) continue;
+      const params = {};
+      let match2 = true;
+      for (let i = 0; i < routeSegments.length; i++) {
+        const routeSeg = routeSegments[i];
+        const pathSeg = pathSegments[i];
+        if (!routeSeg || !pathSeg) continue;
+        if (routeSeg.startsWith(":")) {
+          params[routeSeg.slice(1)] = pathSeg;
+        } else if (routeSeg !== pathSeg) {
+          match2 = false;
+          break;
+        }
+      }
+      if (match2) {
+        return {
+          route,
+          method,
+          params,
+          path
+        };
+      }
+    }
+    return null;
+  }
+  async function handleRequest(method, path, _context) {
+    const matched = match(method, path);
+    if (!matched) {
+      return {
+        status: 404,
+        headers: { "Content-Type": "application/json" },
+        body: { error: "Not Found" }
+      };
+    }
+    try {
+      return {
+        status: 200,
+        headers: { "Content-Type": "application/json" },
+        body: {
+          message: "API Route Matched",
+          method,
+          path,
+          params: matched.params
+        }
+      };
+    } catch (error) {
+      return {
+        status: 500,
+        headers: { "Content-Type": "application/json" },
+        body: { error: "Internal Server Error", message: String(error) }
+      };
+    }
+  }
+  function getRoutes() {
+    return [...routes];
+  }
+  function addRoute(route) {
+    routes.push(route);
+  }
+  function removeRoute(path) {
+    routes = routes.filter((r) => r.path !== path);
+  }
+  function clearRoutes() {
+    routes = [];
+  }
+  refresh().catch((err) => {
+    console.warn("Failed to scan API routes:", err);
+  });
+  return {
+    getRoutes,
+    match,
+    addRoute,
+    removeRoute,
+    clearRoutes,
+    refresh,
+    handleRequest
+  };
+}
+export {
+  createApiRouter
+};

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@lytjs/api",
+  "version": "6.5.0",
+  "description": "LytJS API Router Engine",
+  "author": "lytjs",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "type-check": "tsc --noEmit",
+    "clean": "rm -rf dist node_modules .turbo"
+  },
+  "dependencies": {
+    "@lytjs/common-http": "^6.5.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.6",
+    "typescript": "^5.7.3",
+    "vitest": "^3.0.0"
+  },
+  "peerDependencies": {},
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitee.com/lytjs/lytjs.git",
+    "directory": "packages/ecosystem/packages/api"
+  },
+  "keywords": [
+    "lytjs",
+    "api",
+    "router",
+    "file-system"
+  ],
+  "homepage": "https://gitee.com/lytjs/lytjs",
+  "bugs": {
+    "url": "https://gitee.com/lytjs/lytjs/issues"
+  }
+}