@lark-apaas/devtool-kits 1.2.16-beta.0 → 1.2.17-alpha.0

package/README.md

@@ -92,6 +92,17 @@ import {
 } from '@apaas/fullstack-toolkits';
 ```
 
+### 兼容工具函数 (Compat)
+```typescript
+import {
+  sendJson,         // 发送 JSON 响应（兼容 Express/Connect）
+  sendError,        // 发送错误响应
+  sendSuccess,      // 发送成功响应
+  getQuery,         // 获取所有查询参数
+  getQueryParam,    // 获取单个查询参数
+} from '@apaas/fullstack-toolkits';
+```
+
 ### 类型定义 (Types)
 ```typescript
 import type {
@@ -171,6 +182,38 @@ export default {
 - 全局中间件应放在路由中间件之前
 - 路由中间件仅处理匹配其挂载路径的请求
 
+### Vite/Connect 兼容性
+
+本工具包原生支持 Vite 开发服务器。`registerMiddlewares` 会自动检测 Vite/Connect 环境，并添加必要的 Express API 兼容层：
+
+- `res.status()` - 设置响应状态码
+- `res.json()` - 发送 JSON 响应
+- `res.send()` - 发送响应
+- `req.query` - 解析后的查询参数
+
+这意味着您可以直接在 Vite 中使用本工具包，无需额外配置。
+
+**兼容工具函数（可选）：**
+
+如果您正在编写自定义中间件并希望同时支持 Express 和 Vite，可以使用导出的兼容工具函数：
+
+```typescript
+import { sendJson, sendError, sendSuccess, getQuery, getQueryParam } from '@lark-apaas/devtool-kits';
+
+// 发送 JSON 响应（自动检测 Express/Connect）
+sendJson(res, { data: 'value' }, 200);
+
+// 发送错误响应
+sendError(res, 'Not found', error, 404);
+
+// 发送成功响应
+sendSuccess(res, { id: 123 });
+
+// 获取查询参数（自动解析 URL 或使用 req.query）
+const query = getQuery(req);
+const page = getQueryParam(req, 'page');
+```
+
 ## 中间件详细说明
 ### Dev Logs 中间件
 

package/dist/index.cjs

@@ -34,11 +34,16 @@ __export(index_exports, {
   createCollectLogsMiddleware: () => createCollectLogsMiddleware,
   createDevLogsMiddleware: () => createDevLogsMiddleware,
   createOpenapiMiddleware: () => createOpenapiMiddleware,
+  getQuery: () => getQuery,
+  getQueryParam: () => getQueryParam,
   handleDevProxyError: () => handleDevProxyError,
   normalizeBasePath: () => normalizeBasePath,
   parseAndGenerateNestResourceTemplate: () => parseAndGenerateNestResourceTemplate,
   postprocessDrizzleSchema: () => postprocessDrizzleSchema,
-  registerMiddlewares: () => registerMiddlewares
+  registerMiddlewares: () => registerMiddlewares,
+  sendError: () => sendError,
+  sendJson: () => sendJson,
+  sendSuccess: () => sendSuccess
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -3490,7 +3495,100 @@ function createCollectLogsMiddleware(options = {}) {
 }
 __name(createCollectLogsMiddleware, "createCollectLogsMiddleware");
 
+// src/middlewares/compat.ts
+function sendJson(res, data, statusCode = 200) {
+  const statusFn = res.status;
+  const jsonFn = res.json;
+  if (typeof statusFn === "function" && typeof jsonFn === "function") {
+    statusFn.call(res, statusCode);
+    jsonFn.call(res, data);
+  } else {
+    res.statusCode = statusCode;
+    res.setHeader("Content-Type", "application/json");
+    res.end(JSON.stringify(data));
+  }
+}
+__name(sendJson, "sendJson");
+function sendError(res, message, error, statusCode = 500) {
+  const errorData = {
+    message,
+    ...error ? {
+      error: serializeError3(error)
+    } : {}
+  };
+  sendJson(res, errorData, statusCode);
+}
+__name(sendError, "sendError");
+function sendSuccess(res, data) {
+  sendJson(res, {
+    success: true,
+    ...data
+  }, 200);
+}
+__name(sendSuccess, "sendSuccess");
+function getQuery(req) {
+  if (req.query) {
+    return req.query;
+  }
+  const url = new URL(req.url || "", `http://${req.headers.host}`);
+  return Object.fromEntries(url.searchParams.entries());
+}
+__name(getQuery, "getQuery");
+function getQueryParam(req, key) {
+  const query = getQuery(req);
+  return query[key];
+}
+__name(getQueryParam, "getQueryParam");
+function serializeError3(error) {
+  if (error instanceof Error) {
+    return {
+      name: error.name,
+      message: error.message,
+      stack: error.stack
+    };
+  }
+  return {
+    message: String(error)
+  };
+}
+__name(serializeError3, "serializeError");
+
 // src/middlewares/index.ts
+function enhanceForCompat(req, res) {
+  if (!res.status) {
+    res.status = function(code) {
+      res.statusCode = code;
+      return res;
+    };
+  }
+  if (!res.json) {
+    res.json = function(data) {
+      res.setHeader("Content-Type", "application/json");
+      res.end(JSON.stringify(data));
+      return res;
+    };
+  }
+  if (!res.send) {
+    res.send = function(data) {
+      if (typeof data === "object" && data !== null) {
+        res.setHeader("Content-Type", "application/json");
+        res.end(JSON.stringify(data));
+      } else {
+        res.end(String(data));
+      }
+      return res;
+    };
+  }
+  if (!req.query) {
+    const url = new URL(req.url || "", `http://${req.headers.host || "localhost"}`);
+    req.query = Object.fromEntries(url.searchParams.entries());
+  }
+}
+__name(enhanceForCompat, "enhanceForCompat");
+function isConnectServer(server) {
+  return typeof server === "function" && !("set" in server) && !("engine" in server);
+}
+__name(isConnectServer, "isConnectServer");
 function isRouteMiddleware(middleware) {
   return "createRouter" in middleware && middleware.createRouter !== void 0;
 }
@@ -3543,6 +3641,13 @@ async function registerMiddlewares(server, middlewares, options) {
     rootDir: process.cwd(),
     ...options
   };
+  if (isConnectServer(server)) {
+    server.use((req, res, next) => {
+      enhanceForCompat(req, res);
+      next();
+    });
+    console.log("[Middleware] Registered Express compatibility layer for Connect/Vite");
+  }
   const allMiddlewares = [
     ...middlewares
   ];
@@ -3574,10 +3679,15 @@ __name(registerMiddlewares, "registerMiddlewares");
   createCollectLogsMiddleware,
   createDevLogsMiddleware,
   createOpenapiMiddleware,
+  getQuery,
+  getQueryParam,
   handleDevProxyError,
   normalizeBasePath,
   parseAndGenerateNestResourceTemplate,
   postprocessDrizzleSchema,
-  registerMiddlewares
+  registerMiddlewares,
+  sendError,
+  sendJson,
+  sendSuccess
 });
 //# sourceMappingURL=index.cjs.map