befly 3.21.1 → 3.22.0

package/README.md

@@ -9,3 +9,10 @@
 "bundle:min": "bun build ./index.js --outfile ./befly.min.js --target bun --format esm --packages bundle --minify",
 "build": "rimraf befly.js befly.min.js && bun run bundle && bun run bundle:min"
 ```
+
+我们把要求和实现对齐一下，要符合如下规范：
+
+1. 单表查询，不传fields或fields为空数组，表示查询所有字段。
+2. 单表查询，fields指定查询字段，表示明确只查询这些字段。
+3. 单表查询，fields用!感叹号开头，表示排除不查询这些字段。
+4. 单表查询，不存在明确查询字段又排除某些字段的混合情况。

package/apis/admin/list.js

@@ -17,7 +17,7 @@ export default {
             limit: ctx.body.limit,
             where: {
                 roleCode: {
-                    $ne: "dev"
+                    $not: "dev"
                 }
             },
             orderBy: ["createdAt#DESC"]

package/apis/admin/upd.js

@@ -39,7 +39,7 @@ export default {
         if (username && username !== admin.data.username) {
             const existingUsername = await befly.mysql.getOne({
                 table: "beflyAdmin",
-                where: { username: username, id: { $ne: id } }
+                where: { username: username, id: { $not: id } }
             });
             if (existingUsername.data?.id) {
                 return befly.tool.No("用户名已被使用");
@@ -50,7 +50,7 @@ export default {
         if (nickname && nickname !== admin.data.nickname) {
             const existingNickname = await befly.mysql.getOne({
                 table: "beflyAdmin",
-                where: { nickname: nickname, id: { $ne: id } }
+                where: { nickname: nickname, id: { $not: id } }
             });
             if (existingNickname.data?.id) {
                 return befly.tool.No("昵称已被使用");

package/apis/dict/all.js

@@ -12,7 +12,7 @@ export default {
         const result = await befly.mysql.getAll({
             table: ["beflyDict", "beflyDictType"],
             leftJoin: ["beflyDict.typeCode beflyDictType.code"],
-            fields: ["beflyDict.id", "beflyDict.typeCode", "beflyDict.key", "beflyDict.label", "beflyDict.sort", "beflyDict.remark", "beflyDict.createdAt", "beflyDict.updatedAt", "beflyDictType.name AS typeName"],
+            fields: ["beflyDict.id", "beflyDict.typeCode", "beflyDict.key", "beflyDict.label", "beflyDict.sort", "beflyDict.remark", "beflyDict.createdAt", "beflyDict.updatedAt", "beflyDictType.name typeName"],
             orderBy: ["beflyDict.sort#ASC", "beflyDict.id#ASC"]
         });
 

package/apis/dict/detail.js

@@ -11,7 +11,7 @@ export default {
         const dict = await befly.mysql.getOne({
             table: ["beflyDict", "beflyDictType"],
             leftJoin: ["beflyDict.typeCode beflyDictType.code"],
-            fields: ["beflyDict.id", "beflyDict.typeCode", "beflyDict.key", "beflyDict.label", "beflyDict.sort", "beflyDict.remark", "beflyDict.createdAt", "beflyDict.updatedAt", "beflyDictType.name AS typeName"],
+            fields: ["beflyDict.id", "beflyDict.typeCode", "beflyDict.key", "beflyDict.label", "beflyDict.sort", "beflyDict.remark", "beflyDict.createdAt", "beflyDict.updatedAt", "beflyDictType.name typeName"],
             where: { "beflyDict.id": ctx.body.id }
         });
 

package/apis/dict/list.js

@@ -16,7 +16,7 @@ export default {
         const result = await befly.mysql.getList({
             table: ["beflyDict", "beflyDictType"],
             leftJoin: ["beflyDict.typeCode beflyDictType.code"],
-            fields: ["beflyDict.id", "beflyDict.typeCode", "beflyDict.key", "beflyDict.label", "beflyDict.sort", "beflyDict.remark", "beflyDict.createdAt", "beflyDict.updatedAt", "beflyDictType.name AS typeName"],
+            fields: ["beflyDict.id", "beflyDict.typeCode", "beflyDict.key", "beflyDict.label", "beflyDict.sort", "beflyDict.remark", "beflyDict.createdAt", "beflyDict.updatedAt", "beflyDictType.name typeName"],
             where: {
                 "beflyDict.typeCode": ctx.body.typeCode
             },

package/apis/dict/upd.js

@@ -47,7 +47,7 @@ export default {
                 where: {
                     typeCode: checkTypeCode,
                     key: checkKey,
-                    id$ne: id
+                    id$not: id
                 }
             });
 

package/apis/dictType/upd.js

@@ -25,7 +25,7 @@ export default {
                 table: "beflyDictType",
                 where: {
                     code: code,
-                    id$ne: id
+                    id$not: id
                 }
             });
 

package/apis/role/all.js

@@ -10,7 +10,7 @@ export default {
             table: "beflyRole",
             where: {
                 code: {
-                    $ne: "dev"
+                    $not: "dev"
                 }
             },
             orderBy: ["sort#ASC", "id#ASC"]

package/apis/role/list.js

@@ -16,7 +16,7 @@ export default {
             table: "beflyRole",
             where: {
                 code: {
-                    $ne: "dev"
+                    $not: "dev"
                 }
             },
             orderBy: ["sort#ASC", "id#ASC"]

package/apis/role/upd.js

@@ -22,7 +22,7 @@ export default {
             table: "beflyRole",
             where: {
                 code: ctx.body.code,
-                id$ne: ctx.body.id
+                id$not: ctx.body.id
             }
         });
 

package/checks/config.js

@@ -29,9 +29,7 @@ const configSchema = z
                 excludeFields: z.array(noTrimString),
                 dir: noTrimString,
                 console: boolIntSchema,
-                maxSize: z.int().min(1),
-                maxStringLen: z.int().min(1),
-                maxArrayItems: z.int().min(1)
+                maxSize: z.int().min(1)
             })
             .strict(),
 

package/checks/table.js

@@ -76,20 +76,7 @@ const fieldDefSchema = z
     });
 
 const tableContentSchema = z.record(z.string().regex(lowerCamelRegex), fieldDefSchema);
-
-const tableItemSchema = z
-    .object({
-        source: noTrimString.min(1),
-        type: noTrimString.min(1),
-        filePath: noTrimString.min(1),
-        relativePath: noTrimString.min(1),
-        apiPath: noTrimString.min(1),
-        fileName: z.string().min(1).regex(lowerCamelRegex),
-        fieldsDef: tableContentSchema
-    })
-    .strict();
-
-const tableListSchema = z.array(tableItemSchema);
+const tableRegistrySchema = z.record(z.string().regex(lowerCamelRegex), tableContentSchema);
 
 /**
  * 检查表定义文件
@@ -99,7 +86,7 @@ export async function checkTable(tables) {
     // 收集所有表文件
     let hasError = false;
 
-    const schemaResult = tableListSchema.safeParse(tables);
+    const schemaResult = tableRegistrySchema.safeParse(tables);
     if (!schemaResult.success) {
         const errors = formatZodIssues(schemaResult.error.issues, { items: tables, itemLabel: "table" });
         Logger.warn("表结构校验失败", { errors: errors }, false);

package/configs/beflyConfig.json

@@ -14,9 +14,7 @@
         "excludeFields": ["password", "token", "secret"],
         "dir": "./logs",
         "console": 1,
-        "maxSize": 20,
-        "maxStringLen": 100,
-        "maxArrayItems": 100
+        "maxSize": 20
     },
 
     "mysql": {

package/index.js

@@ -26,13 +26,14 @@ import { syncApi } from "./sync/api.js";
 import { syncCache } from "./sync/cache.js";
 import { syncDev } from "./sync/dev.js";
 import { syncMenu } from "./sync/menu.js";
-import { syncDbApply, syncDbCheck } from "./scripts/syncDb/index.js";
 // 工具
 import { calcPerfTime } from "./utils/calcPerfTime.js";
 import { scanSources } from "./utils/scanSources.js";
 import { isPrimaryProcess } from "./utils/is.js";
 import { deepMerge } from "./utils/deepMerge.js";
 
+export { syncDbApply as syncDb } from "./scripts/syncDb/index.js";
+
 function prefixMenuPaths(menus, prefix) {
     const output = [];
     for (const menu of menus) {
@@ -94,14 +95,6 @@ async function ensureSyncPrerequisites(ctx) {
     }
 }
 
-export async function dbCheck(mysqlConfig) {
-    return syncDbCheck(mysqlConfig);
-}
-
-export async function dbApply(mysqlConfig) {
-    return syncDbApply(mysqlConfig);
-}
-
 export async function createBefly(env = {}, config = {}, menus = []) {
     const mergedConfig = deepMerge(beflyConfig, config);
     const mergedMenus = deepMerge(prefixMenuPaths(beflyMenus, "core"), menus);
@@ -127,6 +120,7 @@ export async function createBefly(env = {}, config = {}, menus = []) {
     return new Befly({
         env: env,
         config: mergedConfig,
+        tables: tables,
         menus: mergedMenus,
         apis: apis,
         hooks: hooks,
@@ -143,7 +137,8 @@ export class Befly {
     constructor(init = {}) {
         this.context = {
             env: init.env || {},
-            config: init.config || {}
+            config: init.config || {},
+            tables: init.tables || {}
         };
         this.menus = Array.isArray(init.menus) ? init.menus : [];
         this.hooks = Array.isArray(init.hooks) ? init.hooks : [];