jax-hono 1.0.6 → 1.0.8

package/core/api-controller.ts

@@ -1,17 +1,23 @@
-import { Controller } from './controller';
-import { arrayFrom } from '../utils/array';
-import { escapeRegex } from '../utils/regexp';
-import type { Context } from 'hono';
+import { Controller } from "./controller";
+import { arrayFrom } from "../utils/array";
+import { escapeRegex } from "../utils/regexp";
+import type { Context } from "hono";
+import { omit, pick, queue } from "jax-hono/utils";
 
 const bodyCache = new WeakMap<Context, unknown>();
 
 export abstract class ApiController extends Controller {
+  declare protected omit?: string | string[];
+  declare protected pick?: string | string[];
+  declare protected output?: string | string[];
+  declare protected json?: string | string[];
+
   protected get Model(): any {
     return undefined;
   }
 
   protected get key() {
-    return '_id';
+    return "_id";
   }
 
   protected get sort() {
@@ -26,6 +32,10 @@ export abstract class ApiController extends Controller {
     return true;
   }
 
+  protected get formatConcurrency() {
+    return 50;
+  }
+
   protected get admin(): any {
     return this.state.admin;
   }
@@ -65,7 +75,7 @@ export abstract class ApiController extends Controller {
     const query = c.req.query();
     let options: Record<string, any> = { sort: this.sort };
 
-    if (typeof (this as any).beforeIndex === 'function') {
+    if (typeof (this as any).beforeIndex === "function") {
       options = { ...options, ...(await (this as any).beforeIndex()) };
     }
 
@@ -76,7 +86,7 @@ export abstract class ApiController extends Controller {
       data = await Model.findPage(filter, {
         ...options,
         page: query.page,
-        pageSize: query.pageSize
+        pageSize: query.pageSize,
       });
       data.list = await this.formatList(data.list);
     } else {
@@ -89,10 +99,10 @@ export abstract class ApiController extends Controller {
 
   async show(c: Context) {
     const Model = this.requireModel();
-    const doc = await Model.findOne({ [this.key]: c.req.param('id') });
+    const doc = await Model.findOne({ [this.key]: c.req.param("id") });
 
     if (!doc) {
-      return c.fail('数据获取失败');
+      return c.fail("数据获取失败");
     }
 
     return c.ok(await this.formatItem(doc));
@@ -104,40 +114,40 @@ export abstract class ApiController extends Controller {
 
     (this as any).isNew = true;
 
-    if (typeof (this as any).beforeCreate === 'function') {
+    if (typeof (this as any).beforeCreate === "function") {
       await (this as any).beforeCreate();
     }
 
-    if (typeof (this as any).beforeSave === 'function') {
+    if (typeof (this as any).beforeSave === "function") {
       await (this as any).beforeSave();
     }
 
     const doc = await Model.create(body);
 
-    if (typeof (this as any).afterSave === 'function') {
+    if (typeof (this as any).afterSave === "function") {
       await (this as any).afterSave(doc);
     }
 
-    return c.ok(undefined, '操作成功');
+    return c.ok(undefined, "操作成功");
   }
 
   async update(c: Context) {
     const Model = this.requireModel();
     const body = await this.body();
-    const ids = (c.req.param('id') ?? '').split(',').filter(Boolean);
+    const ids = (c.req.param("id") ?? "").split(",").filter(Boolean);
 
     (this as any).isUpdate = true;
     (this as any).isBatch = ids.length > 1;
 
     if ((this as any).isBatch && !this.batchAction) {
-      return c.fail('不可批量操作');
+      return c.fail("不可批量操作");
     }
 
-    if (typeof (this as any).beforeUpdate === 'function') {
+    if (typeof (this as any).beforeUpdate === "function") {
       await (this as any).beforeUpdate();
     }
 
-    if (typeof (this as any).beforeSave === 'function') {
+    if (typeof (this as any).beforeSave === "function") {
       await (this as any).beforeSave();
     }
 
@@ -146,27 +156,29 @@ export abstract class ApiController extends Controller {
     if ((this as any).isBatch) {
       await Model.updateMany({ [this.key]: { $in: ids } }, body);
     } else {
-      doc = await Model.findOneAndUpdate({ [this.key]: ids[0] }, body, { new: true });
+      doc = await Model.findOneAndUpdate({ [this.key]: ids[0] }, body, {
+        new: true,
+      });
     }
 
-    if (typeof (this as any).afterSave === 'function') {
+    if (typeof (this as any).afterSave === "function") {
       await (this as any).afterSave(doc);
     }
 
-    return c.ok(undefined, '操作成功');
+    return c.ok(undefined, "操作成功");
   }
 
   async delete(c: Context) {
     const Model = this.requireModel();
-    const ids = (c.req.param('id') ?? '').split(',').filter(Boolean);
+    const ids = (c.req.param("id") ?? "").split(",").filter(Boolean);
 
     if (ids.length > 1 && !this.batchAction) {
-      return c.fail('不可批量操作');
+      return c.fail("不可批量操作");
     }
 
     await Model.deleteMany({ [this.key]: { $in: ids } });
 
-    return c.ok(undefined, '操作成功');
+    return c.ok(undefined, "操作成功");
   }
 
   async destroy(c: Context) {
@@ -176,22 +188,30 @@ export abstract class ApiController extends Controller {
   protected async getFilter(extraFilter?: Record<string, any>) {
     const query = this.context.req.query();
     const filter: Record<string, any> = { ...(extraFilter ?? {}) };
-    const searchKeys = arrayFrom<string>((this as any).searchKey ?? (this as any).searchKeys);
-    const likeKeys = arrayFrom<string>((this as any).likeKey ?? (this as any).likeKeys);
+    const searchKeys = arrayFrom<string>(
+      (this as any).searchKey ?? (this as any).searchKeys,
+    );
+    const likeKeys = arrayFrom<string>(
+      (this as any).likeKey ?? (this as any).likeKeys,
+    );
 
     for (const key of searchKeys) {
-      if (query[key] !== undefined && query[key] !== '') {
+      if (query[key] !== undefined && query[key] !== "") {
         filter[key] = query[key];
       }
     }
 
     for (const key of likeKeys) {
-      if (query[key] !== undefined && query[key] !== '') {
-        filter[key] = new RegExp(escapeRegex(query[key]), 'i');
+      if (query[key] !== undefined && query[key] !== "") {
+        filter[key] = new RegExp(escapeRegex(query[key]), "i");
       }
     }
 
-    const customGetFilter = getCustomMethod(this, 'getFilter', ApiController.prototype.getFilter);
+    const customGetFilter = getCustomMethod(
+      this,
+      "getFilter",
+      ApiController.prototype.getFilter,
+    );
 
     if (customGetFilter) {
       Object.assign(filter, await customGetFilter.call(this, filter));
@@ -202,17 +222,44 @@ export abstract class ApiController extends Controller {
     return filter;
   }
 
+  // 过滤
+  async _omit(item: any) {
+    const keys = arrayFrom<string>(this.omit);
+
+    return keys.length ? omit(item, keys) : item;
+  }
+
+  // 挑选
+  async _pick(item: any) {
+    const keys = arrayFrom<string>(this.pick ?? this.output ?? this.json);
+
+    return keys.length ? pick(item, keys) : item;
+  }
+
   protected async formatList(list: any[]) {
-    return Promise.all(list.map((item) => this.formatItem(item)));
+    return queue(list, this._formatItem, {
+      concurrency: this.formatConcurrency,
+    });
   }
 
-  protected async formatItem(item: any) {
-    const data = item?.toJSON ? item.toJSON() : { ...item };
+  protected async _formatItem(item: any) {
+    let data = item;
 
-    if (typeof (this as any).formatData === 'function') {
-      const formatted = await (this as any).formatData(data);
+    try {
+      data = item?.toJSON ? item.toJSON() : { ...item };
+
+      if (typeof (this as any).formatItem === "function") {
+        const formatted = await (this as any).formatItem(data);
+
+        if (formatted) {
+          data = formatted;
+        }
+      }
 
-      return formatted ?? data;
+      data = await this._omit(data);
+      data = await this._pick(data);
+    } catch (error) {
+      console.error("[ApiController] formatItem failed:", error);
     }
 
     return data;
@@ -233,7 +280,10 @@ function getCustomMethod(target: object, name: string, baseMethod: Function) {
   while (prototype && prototype !== ApiController.prototype) {
     const descriptor = Object.getOwnPropertyDescriptor(prototype, name);
 
-    if (typeof descriptor?.value === 'function' && descriptor.value !== baseMethod) {
+    if (
+      typeof descriptor?.value === "function" &&
+      descriptor.value !== baseMethod
+    ) {
       return descriptor.value;
     }
 

package/helpers/index.ts

@@ -1,4 +1,4 @@
-export * from './route';
-export * from './config';
-export * from './crud';
-export * from '../plugins/define';
+export * from "./route";
+export * from "./config";
+export * from "./crud";
+export * from "../plugins/define";

package/middleware/api-response.ts

@@ -13,7 +13,7 @@ export type ApiFailResponse = {
 
 export type ApiResponse<T = unknown> = ApiSuccessResponse<T> | ApiFailResponse;
 
-export function ok<T>(c: Context, data?: T, msg = 'success') {
+export function ok<T>(c: Context, data?: T, msg = 'success'): Response {
   return c.json<ApiSuccessResponse<T>>({
     code: 0,
     msg,
@@ -21,7 +21,7 @@ export function ok<T>(c: Context, data?: T, msg = 'success') {
   });
 }
 
-export function fail(c: Context, msg: string) {
+export function fail(c: Context, msg: string): Response {
   return c.json<ApiFailResponse>({
     code: 1,
     msg

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jax-hono",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Lightweight framework layer on top of Hono, built for Bun",
   "type": "module",
   "main": "./index.ts",
@@ -82,7 +82,10 @@
   },
   "dependencies": {
     "@hono/session": "^0.2.1",
-    "cac": "^7.0.0"
+    "@types/lodash-es": "^4.17.12",
+    "cac": "^7.0.0",
+    "lodash-es": "^4.18.1",
+    "p-limit": "^7.3.0"
   },
   "peerDependencies": {
     "hono": "^4.12.27",

package/utils/async.ts

@@ -0,0 +1,47 @@
+import pLimit from "p-limit";
+
+export { pLimit };
+
+export type QueueErrorHandler<T, R> = (
+  error: unknown,
+  item: T,
+  index: number,
+) => Promise<R | T> | R | T;
+
+export interface QueueOptions<T, R> {
+  concurrency?: number;
+  continueOnError?: boolean;
+  onError?: QueueErrorHandler<T, R>;
+}
+
+export async function queue<T, R>(
+  data: readonly T[],
+  fn: (item: T, index: number) => Promise<R> | R,
+  options: number | QueueOptions<T, R> = {},
+) {
+  const config =
+    typeof options === "number" ? { concurrency: options } : options;
+  const concurrency = config.concurrency ?? 50;
+  const continueOnError = config.continueOnError ?? true;
+  const limit = pLimit(concurrency);
+
+  const input = data.map((item, index) => {
+    return limit(async () => {
+      try {
+        return await fn(item, index);
+      } catch (error) {
+        if (!continueOnError) {
+          throw error;
+        }
+
+        console.error("[queue] task failed:", error);
+
+        return config.onError ? config.onError(error, item, index) : item;
+      }
+    });
+  });
+
+  const result = await Promise.all(input);
+
+  return result;
+}

package/utils/index.ts

@@ -1,3 +1,5 @@
-export * from './array';
-export * from './crypto';
-export * from './regexp';
+export * from "./array";
+export * from "./async";
+export * from "./crypto";
+export * from "./regexp";
+export * from "./transform";