befly 3.76.1 → 3.76.2

package/router/api.js

@@ -3,20 +3,19 @@
  * 处理 /api/* 路径的请求
  */
 
-import picomatch from "picomatch";
+import { Logger } from "#befly/libs/logger/index.js";
 
-import { Logger } from "../lib/logger.js";
 // 相对导入
 import { setCorsOptions } from "../utils/cors.js";
 import { createError } from "../utils/error.js";
-import { getClientIp } from "../utils/getClientIp.js";
+import { isNonEmptyString } from "../utils/is.js";
 import { ErrorResponse, FinalResponse } from "../utils/response.js";
 import { genShortId } from "../utils/util.js";
 
 function createExcludeApisLogMatchers(excludeApisLog) {
     return excludeApisLog.map((pattern) => {
         try {
-            return picomatch(pattern);
+            return new Bun.Glob(pattern);
         } catch (error) {
             throw createError(`excludeApisLog glob 无效: ${pattern}`, { cause: error, code: "validation", subsystem: "config", operation: "excludeApisLog" });
         }
@@ -53,7 +52,8 @@ export function apiHandler(apis, hooks, context) {
         // 只用接口路径做存在性判断与匹配：不要把 method 拼进 key
         // 说明：apisMap 的 key 来源于 scanFiles/loadApis 生成的 path（例如 /api/core/xxx）
 
-        const clientIp = getClientIp(req, server);
+        const forwardedFor = context.config.trustProxy ? req.headers.get("x-forwarded-for") : "";
+        const clientIp = isNonEmptyString(forwardedFor) ? forwardedFor.split(",")[0].trim() : server?.requestIP(req)?.address?.trim() || "unknown";
 
         const apiData = apis[url.pathname];
         if (!apiData) {
@@ -63,6 +63,7 @@ export function apiHandler(apis, hooks, context) {
                     msg: "接口不存在"
                 },
                 {
+                    status: 404,
                     headers: corsHeaders
                 }
             );
@@ -88,18 +89,20 @@ export function apiHandler(apis, hooks, context) {
             apiAuth: apiData.auth,
             apiFields: apiData.fields,
             apiRequired: apiData.required,
+            apiConstraints: apiData.constraints,
             apiFile: apiData.filePath
         };
 
-        if (ctx.apiMethod !== "ALL" && ctx.method !== ctx.apiMethod) {
+        const allowedMethods = apiData.method === "ALL" ? ["GET", "POST"] : [apiData.method];
+        if (!allowedMethods.includes(ctx.method)) {
             return ErrorResponse(
                 ctx,
-                `请求方法不允许，请使用 ${ctx.apiMethod}`,
+                `请求方法不允许，请使用 ${allowedMethods.join(" 或 ")}`,
                 1,
                 null,
                 {
                     method: ctx.method,
-                    allowMethod: ctx.apiMethod,
+                    allowMethod: allowedMethods,
                     apiPath: ctx.apiPath
                 },
                 "method"
@@ -136,7 +139,7 @@ export function apiHandler(apis, hooks, context) {
                 logData["body"] = ctx.body;
             }
 
-            const shouldSkipRequestLog = excludeApisLogMatchers.some((isMatch) => isMatch(ctx.apiPath));
+            const shouldSkipRequestLog = excludeApisLogMatchers.some((matcher) => matcher.match(ctx.apiPath));
 
             if (!shouldSkipRequestLog) {
                 Logger.info("请求", logData);
@@ -176,7 +179,8 @@ export function apiHandler(apis, hooks, context) {
                 code: 1,
                 msg: "内部服务错误"
             };
-            return FinalResponse(ctx);
+            const response = FinalResponse(ctx);
+            return new Response(response.body, { status: 500, headers: response.headers });
         }
     };
 }

package/router/root.js

@@ -0,0 +1,14 @@
+import { formatYmdHms } from "../utils/datetime.js";
+
+export function rootHandler(config) {
+    return () =>
+        Response.json({
+            code: 0,
+            msg: "success",
+            data: {
+                name: config.appName,
+                mode: config.runMode,
+                time: formatYmdHms(Date.now())
+            }
+        });
+}

package/router/static.js

@@ -3,10 +3,10 @@
  * 处理 /* 路径的静态文件请求
  */
 
-// 外部依赖
-import { basename, extname, isAbsolute, normalize, relative, resolve } from "pathe";
+import { basename, extname, isAbsolute, normalize, relative, resolve } from "node:path";
+
+import { Logger } from "#befly/libs/logger/index.js";
 
-import { Logger } from "../lib/logger.js";
 // 相对导入
 import { getAppPublicDir } from "../paths.js";
 import { setCorsOptions } from "../utils/cors.js";

package/schemas/api.json

@@ -0,0 +1,99 @@
+{
+    "paramType": "array",
+    "items": {
+        "paramType": "object",
+        "fields": {
+            "source": {
+                "paramType": "string",
+                "enum": ["core", "app"]
+            },
+            "filePath": {
+                "paramType": "string",
+                "minValue": 1
+            },
+            "relativePath": {
+                "paramType": "string",
+                "minValue": 1
+            },
+            "fileName": {
+                "paramType": "string",
+                "minValue": 1
+            },
+            "apiPath": {
+                "paramType": "string",
+                "minValue": 1,
+                "pattern": "^/api/[a-z][a-zA-Z0-9]*(?:/[a-z][a-zA-Z0-9]*)*$"
+            },
+            "name": {
+                "paramType": "string",
+                "minValue": 1,
+                "maxValue": 100
+            },
+            "handler": {
+                "paramType": "function"
+            },
+            "method": {
+                "paramType": "string",
+                "enum": ["GET", "POST", "ALL"]
+            },
+            "body": {
+                "paramType": "string",
+                "enum": ["none", "raw"]
+            },
+            "auth": {
+                "anyOf": [
+                    {
+                        "paramType": "boolean"
+                    },
+                    {
+                        "paramType": "array",
+                        "minItem": 1,
+                        "items": {
+                            "paramType": "string",
+                            "minValue": 1
+                        }
+                    }
+                ]
+            },
+            "fields": {
+                "paramType": "record",
+                "keys": {
+                    "paramType": "string",
+                    "minValue": 1,
+                    "pattern": "^[a-z][a-zA-Z0-9]*$"
+                },
+                "values": {
+                    "paramType": "object",
+                    "extra": true
+                }
+            },
+            "required": {
+                "paramType": "array",
+                "unique": true,
+                "items": {
+                    "paramType": "string",
+                    "minValue": 1,
+                    "pattern": "^[a-z][a-zA-Z0-9]*$"
+                }
+            },
+            "constraints": {
+                "paramType": "array",
+                "minItem": 1,
+                "items": {
+                    "paramType": "object",
+                    "extra": true
+                },
+                "optional": true
+            },
+            "category": {
+                "paramType": "string",
+                "enum": ["select", "insert", "delete", "update", "other"],
+                "paramDefault": "other"
+            },
+            "type": {
+                "paramType": "string",
+                "minValue": 1
+            }
+        }
+    }
+}

package/schemas/config.json

@@ -0,0 +1,255 @@
+{
+    "paramType": "object",
+    "fields": {
+        "appName": {
+            "paramType": "string"
+        },
+        "appPort": {
+            "paramType": "integer",
+            "minValue": 1,
+            "maxValue": 65535
+        },
+        "appHost": {
+            "paramType": "string"
+        },
+        "apiHost": {
+            "paramType": "string"
+        },
+        "devEmail": {
+            "paramType": "string",
+            "pattern": "^(|[^\\s@]+@[^\\s@]+\\.[^\\s@]+)$"
+        },
+        "devPassword": {
+            "paramType": "string",
+            "minValue": 6
+        },
+        "trustProxy": {
+            "paramType": "boolean"
+        },
+        "bodyLimit": {
+            "paramType": "integer",
+            "minValue": 1
+        },
+        "tz": {
+            "paramType": "string"
+        },
+        "excludeApisLog": {
+            "paramType": "array",
+            "items": {
+                "paramType": "string"
+            }
+        },
+        "upload": {
+            "paramType": "object",
+            "fields": {
+                "maxSize": {
+                    "paramType": "integer",
+                    "minValue": 1
+                },
+                "publicDir": {
+                    "paramType": "string",
+                    "minValue": 1
+                },
+                "publicHost": {
+                    "paramType": "string"
+                },
+                "allowedExtensions": {
+                    "paramType": "string",
+                    "pattern": "^\\.[a-z0-9]+(?:,\\.[a-z0-9]+)*$"
+                },
+                "allowedMimeTypes": {
+                    "paramType": "string",
+                    "pattern": "^[a-z0-9][a-z0-9.+-]*\\/[a-z0-9][a-z0-9.+-]*(?:,[a-z0-9][a-z0-9.+-]*\\/[a-z0-9][a-z0-9.+-]*)*$"
+                },
+                "forceDownloadExtensions": {
+                    "paramType": "string",
+                    "pattern": "^(|\\.[a-z0-9]+(?:,\\.[a-z0-9]+)*)$"
+                }
+            }
+        },
+        "logger": {
+            "paramType": "object",
+            "fields": {
+                "debug": {
+                    "paramType": "boolean"
+                },
+                "excludeFields": {
+                    "paramType": "array",
+                    "items": {
+                        "paramType": "string"
+                    }
+                }
+            }
+        },
+        "mysql": {
+            "paramType": "object",
+            "fields": {
+                "hostname": {
+                    "paramType": "string"
+                },
+                "port": {
+                    "paramType": "integer",
+                    "minValue": 1,
+                    "maxValue": 65535
+                },
+                "username": {
+                    "paramType": "string"
+                },
+                "password": {
+                    "paramType": "string"
+                },
+                "database": {
+                    "paramType": "string"
+                },
+                "beflyMode": {
+                    "paramType": "string",
+                    "enum": ["manual", "auto"],
+                    "optional": true
+                },
+                "idleTimeout": {
+                    "paramType": "number",
+                    "minValue": 1,
+                    "optional": true
+                },
+                "maxLifetime": {
+                    "paramType": "number",
+                    "minValue": 0,
+                    "optional": true
+                },
+                "connectionTimeout": {
+                    "paramType": "number",
+                    "minValue": 1,
+                    "optional": true
+                },
+                "queryTimeout": {
+                    "paramType": "number",
+                    "minValue": 1,
+                    "optional": true
+                },
+                "max": {
+                    "paramType": "number",
+                    "minValue": 1
+                }
+            }
+        },
+        "redis": {
+            "paramType": "object",
+            "fields": {
+                "hostname": {
+                    "paramType": "string"
+                },
+                "port": {
+                    "paramType": "integer",
+                    "minValue": 1,
+                    "maxValue": 65535
+                },
+                "username": {
+                    "paramType": "string"
+                },
+                "password": {
+                    "paramType": "string"
+                },
+                "db": {
+                    "paramType": "integer",
+                    "minValue": 0,
+                    "maxValue": 16
+                },
+                "prefix": {
+                    "paramType": "string",
+                    "pattern": "^[^:]*$"
+                }
+            }
+        },
+        "session": {
+            "paramType": "object",
+            "fields": {
+                "expireDays": {
+                    "paramType": "integer",
+                    "minValue": 1
+                }
+            }
+        },
+        "email": {
+            "paramType": "object",
+            "optional": true,
+            "fields": {
+                "host": {
+                    "paramType": "string"
+                },
+                "port": {
+                    "paramType": "integer",
+                    "minValue": 1,
+                    "maxValue": 65535
+                },
+                "secure": {
+                    "paramType": "boolean"
+                },
+                "user": {
+                    "paramType": "string"
+                },
+                "pass": {
+                    "paramType": "string"
+                },
+                "label": {
+                    "paramType": "string",
+                    "optional": true
+                }
+            }
+        },
+        "cors": {
+            "paramType": "object",
+            "fields": {
+                "origins": {
+                    "paramType": "array",
+                    "optional": true,
+                    "minItem": 1,
+                    "items": {
+                        "paramType": "string",
+                        "minValue": 1
+                    }
+                },
+                "allowedHeaders": {
+                    "paramType": "string"
+                },
+                "exposedHeaders": {
+                    "paramType": "string"
+                },
+                "maxAge": {
+                    "paramType": "integer",
+                    "minValue": 0
+                },
+                "credentials": {
+                    "paramType": "boolean"
+                }
+            }
+        },
+        "rateLimit": {
+            "paramType": "object",
+            "fields": {
+                "enable": {
+                    "paramType": "boolean"
+                },
+                "failOpen": {
+                    "paramType": "boolean"
+                },
+                "defaultLimit": {
+                    "paramType": "integer",
+                    "minValue": 1
+                },
+                "defaultWindow": {
+                    "paramType": "integer",
+                    "minValue": 1
+                },
+                "key": {
+                    "paramType": "string"
+                },
+                "skipRoutes": {
+                    "paramType": "array",
+                    "items": {
+                        "paramType": "string"
+                    }
+                }
+            }
+        }
+    }
+}

package/schemas/corn.json

@@ -0,0 +1,39 @@
+{
+    "paramType": "array",
+    "items": {
+        "paramType": "object",
+        "fields": {
+            "source": {
+                "paramType": "string",
+                "enum": ["core", "app"]
+            },
+            "filePath": {
+                "paramType": "string",
+                "minValue": 1
+            },
+            "relativePath": {
+                "paramType": "string",
+                "minValue": 1
+            },
+            "fileName": {
+                "paramType": "string",
+                "minValue": 1
+            },
+            "apiPath": {
+                "paramType": "string",
+                "minValue": 1
+            },
+            "schedule": {
+                "paramType": "string",
+                "minValue": 1
+            },
+            "handler": {
+                "paramType": "function"
+            },
+            "type": {
+                "paramType": "string",
+                "minValue": 1
+            }
+        }
+    }
+}

package/schemas/item.json

@@ -0,0 +1,43 @@
+{
+    "paramType": "array",
+    "uniqueBy": "order",
+    "items": {
+        "paramType": "object",
+        "fields": {
+            "name": {
+                "paramType": "string",
+                "minValue": 1
+            },
+            "source": {
+                "paramType": "string",
+                "enum": ["core", "app"]
+            },
+            "filePath": {
+                "paramType": "string",
+                "minValue": 1
+            },
+            "relativePath": {
+                "paramType": "string",
+                "minValue": 1
+            },
+            "fileName": {
+                "paramType": "string",
+                "minValue": 1
+            },
+            "apiPath": {
+                "paramType": "string",
+                "minValue": 1
+            },
+            "handler": {
+                "paramType": "function"
+            },
+            "order": {
+                "paramType": "number"
+            },
+            "type": {
+                "paramType": "string",
+                "minValue": 1
+            }
+        }
+    }
+}

package/schemas/menu.json

@@ -0,0 +1,44 @@
+{
+    "paramType": "array",
+    "items": {
+        "paramType": "object",
+        "fields": {
+            "path": {
+                "paramType": "string",
+                "pattern": "^/(?:core(?:/[a-z][a-z0-9]*(?:-[a-z0-9]+)*)*|(?:[a-z][a-z0-9]*(?:-[a-z0-9]+)*(?:/[a-z][a-z0-9]*(?:-[a-z0-9]+)*)*)?)$"
+            },
+            "name": {
+                "paramType": "string",
+                "minValue": 1
+            },
+            "sort": {
+                "paramType": "number"
+            },
+            "children": {
+                "paramType": "array",
+                "optional": true,
+                "items": {
+                    "paramType": "object",
+                    "fields": {
+                        "path": {
+                            "paramType": "string",
+                            "pattern": "^/[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
+                        },
+                        "name": {
+                            "paramType": "string",
+                            "minValue": 1
+                        },
+                        "sort": {
+                            "paramType": "number"
+                        },
+                        "children": {
+                            "paramType": "array",
+                            "maxItem": 0,
+                            "optional": true
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

package/schemas/table.json

@@ -0,0 +1,80 @@
+{
+    "paramType": "record",
+    "keys": {
+        "paramType": "string",
+        "minValue": 1,
+        "pattern": "^[a-z][a-zA-Z0-9]*$"
+    },
+    "values": {
+        "paramType": "object",
+        "fields": {
+            "name": {
+                "paramType": "string",
+                "minValue": 1
+            },
+            "source": {
+                "paramType": "string",
+                "enum": ["core", "app"]
+            },
+            "fileName": {
+                "paramType": "string",
+                "minValue": 1,
+                "pattern": "^[a-z][a-zA-Z0-9]*$"
+            },
+            "codeName": {
+                "paramType": "string",
+                "minValue": 1,
+                "pattern": "^[a-z][a-zA-Z0-9]*$"
+            },
+            "dbName": {
+                "paramType": "string",
+                "minValue": 1,
+                "pattern": "^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$"
+            },
+            "primary": {
+                "paramType": "string",
+                "minValue": 1,
+                "pattern": "^[a-z][a-zA-Z0-9]*$"
+            },
+            "indexes": {
+                "paramType": "record",
+                "keys": {
+                    "paramType": "string",
+                    "minValue": 1,
+                    "pattern": "^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$"
+                },
+                "values": {
+                    "paramType": "object",
+                    "fields": {
+                        "fields": {
+                            "paramType": "array",
+                            "minItem": 1,
+                            "unique": true,
+                            "items": {
+                                "paramType": "string",
+                                "minValue": 1,
+                                "pattern": "^[a-z][a-zA-Z0-9]*$"
+                            }
+                        },
+                        "type": {
+                            "enum": ["index", "unique"],
+                            "paramType": "string"
+                        }
+                    }
+                }
+            },
+            "fields": {
+                "paramType": "record",
+                "keys": {
+                    "paramType": "string",
+                    "minValue": 1,
+                    "pattern": "^[a-z][a-zA-Z0-9]*$"
+                },
+                "values": {
+                    "paramType": "object",
+                    "extra": true
+                }
+            }
+        }
+    }
+}