jax-hono 1.0.19 → 1.0.21

package/core/api-controller.ts

@@ -1,290 +1,290 @@
-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";
-  }
-
-  protected get sort() {
-    return { [this.key]: -1 };
-  }
-
-  protected get isPage() {
-    return true;
-  }
-
-  protected get batchAction() {
-    return true;
-  }
-
-  protected get formatConcurrency() {
-    return 50;
-  }
-
-  protected get admin(): any {
-    return this.state.admin;
-  }
-
-  protected get user(): any {
-    return this.state.user;
-  }
-
-  protected get query() {
-    return this.context.req.query();
-  }
-
-  protected get params() {
-    return this.context.req.param();
-  }
-
-  protected async body<T = Record<string, any>>() {
-    if (bodyCache.has(this.context)) {
-      return bodyCache.get(this.context) as T;
-    }
-
-    try {
-      const body = await this.context.req.json<T>();
-      bodyCache.set(this.context, body);
-
-      return body;
-    } catch {
-      const body = {} as T;
-      bodyCache.set(this.context, body);
-
-      return body;
-    }
-  }
-
-  async index(c: Context) {
-    const Model = this.requireModel();
-    const query = c.req.query();
-    let options: Record<string, any> = { sort: this.sort };
-
-    if (typeof (this as any).beforeIndex === "function") {
-      options = { ...options, ...(await (this as any).beforeIndex()) };
-    }
-
-    const filter = await this.getFilter(options.filter);
-    let data: any;
-
-    if (this.isPage) {
-      data = await Model.findPage(filter, {
-        ...options,
-        page: query.page,
-        pageSize: query.pageSize,
-      });
-      data.list = await this.formatList(data.list);
-    } else {
-      data = await Model.find(filter).sort(options.sort ?? this.sort);
-      data = await this.formatList(data);
-    }
-
-    return c.ok(data);
-  }
-
-  async show(c: Context) {
-    const Model = this.requireModel();
-    const doc = await Model.findOne({ [this.key]: c.req.param("id") });
-
-    if (!doc) {
-      return c.fail("数据获取失败");
-    }
-
-    return c.ok(await this._formatItem(doc));
-  }
-
-  async create(c: Context) {
-    const Model = this.requireModel();
-    const body = await this.body();
-
-    (this as any).isNew = true;
-
-    if (typeof (this as any).beforeCreate === "function") {
-      await (this as any).beforeCreate();
-    }
-
-    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") {
-      await (this as any).afterSave(doc);
-    }
-
-    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);
-
-    (this as any).isUpdate = true;
-    (this as any).isBatch = ids.length > 1;
-
-    if ((this as any).isBatch && !this.batchAction) {
-      return c.fail("不可批量操作");
-    }
-
-    if (typeof (this as any).beforeUpdate === "function") {
-      await (this as any).beforeUpdate();
-    }
-
-    if (typeof (this as any).beforeSave === "function") {
-      await (this as any).beforeSave();
-    }
-
-    let doc: any;
-
-    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,
-      });
-    }
-
-    if (typeof (this as any).afterSave === "function") {
-      await (this as any).afterSave(doc);
-    }
-
-    return c.ok(undefined, "操作成功");
-  }
-
-  async destroy(c: Context) {
-    const Model = this.requireModel();
-    const ids = (c.req.param("id") ?? "").split(",").filter(Boolean);
-
-    if (ids.length > 1 && !this.batchAction) {
-      return c.fail("不可批量操作");
-    }
-
-    await Model.deleteMany({ [this.key]: { $in: ids } });
-
-    return c.ok(undefined, "操作成功");
-  }
-
-  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,
-    );
-
-    for (const key of searchKeys) {
-      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");
-      }
-    }
-
-    const customGetFilter = getCustomMethod(
-      this,
-      "getFilter",
-      ApiController.prototype.getFilter,
-    );
-
-    if (customGetFilter) {
-      Object.assign(filter, await customGetFilter.call(this, filter));
-    } else if ((this as any).filter) {
-      Object.assign(filter, (this as any).filter);
-    }
-
-    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 queue(list, this._formatItem, {
-      concurrency: this.formatConcurrency,
-    });
-  }
-
-  protected async _formatItem(item: any) {
-    let data = item;
-
-    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;
-        }
-      }
-
-      data = await this._omit(data);
-      data = await this._pick(data);
-    } catch (error) {
-      console.error("[ApiController] formatItem failed:", error);
-    }
-
-    return data;
-  }
-
-  private requireModel() {
-    if (!this.Model) {
-      throw new Error(`${this.constructor.name} must define Model.`);
-    }
-
-    return this.Model;
-  }
-}
-
-function getCustomMethod(target: object, name: string, baseMethod: Function) {
-  let prototype = Object.getPrototypeOf(target);
-
-  while (prototype && prototype !== ApiController.prototype) {
-    const descriptor = Object.getOwnPropertyDescriptor(prototype, name);
-
-    if (
-      typeof descriptor?.value === "function" &&
-      descriptor.value !== baseMethod
-    ) {
-      return descriptor.value;
-    }
-
-    prototype = Object.getPrototypeOf(prototype);
-  }
-
-  return undefined;
-}
+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";
+  }
+
+  protected get sort() {
+    return { [this.key]: -1 };
+  }
+
+  protected get isPage() {
+    return true;
+  }
+
+  protected get batchAction() {
+    return true;
+  }
+
+  protected get formatConcurrency() {
+    return 50;
+  }
+
+  protected get admin(): any {
+    return this.state.admin;
+  }
+
+  protected get user(): any {
+    return this.state.user;
+  }
+
+  protected get query() {
+    return this.context.req.query();
+  }
+
+  protected get params() {
+    return this.context.req.param();
+  }
+
+  protected async body<T = Record<string, any>>() {
+    if (bodyCache.has(this.context)) {
+      return bodyCache.get(this.context) as T;
+    }
+
+    try {
+      const body = await this.context.req.json<T>();
+      bodyCache.set(this.context, body);
+
+      return body;
+    } catch {
+      const body = {} as T;
+      bodyCache.set(this.context, body);
+
+      return body;
+    }
+  }
+
+  async index(c: Context) {
+    const Model = this.requireModel();
+    const query = c.req.query();
+    let options: Record<string, any> = { sort: this.sort };
+
+    if (typeof (this as any).beforeIndex === "function") {
+      options = { ...options, ...(await (this as any).beforeIndex()) };
+    }
+
+    const filter = await this.getFilter(options.filter);
+    let data: any;
+
+    if (this.isPage) {
+      data = await Model.findPage(filter, {
+        ...options,
+        page: query.page,
+        pageSize: query.pageSize,
+      });
+      data.list = await this.formatList(data.list);
+    } else {
+      data = await Model.find(filter).sort(options.sort ?? this.sort);
+      data = await this.formatList(data);
+    }
+
+    return c.ok(data);
+  }
+
+  async show(c: Context) {
+    const Model = this.requireModel();
+    const doc = await Model.findOne({ [this.key]: c.req.param("id") });
+
+    if (!doc) {
+      return c.fail("数据获取失败");
+    }
+
+    return c.ok(await this._formatItem(doc));
+  }
+
+  async create(c: Context) {
+    const Model = this.requireModel();
+    const body = await this.body();
+
+    (this as any).isNew = true;
+
+    if (typeof (this as any).beforeCreate === "function") {
+      await (this as any).beforeCreate();
+    }
+
+    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") {
+      await (this as any).afterSave(doc);
+    }
+
+    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);
+
+    (this as any).isUpdate = true;
+    (this as any).isBatch = ids.length > 1;
+
+    if ((this as any).isBatch && !this.batchAction) {
+      return c.fail("不可批量操作");
+    }
+
+    if (typeof (this as any).beforeUpdate === "function") {
+      await (this as any).beforeUpdate();
+    }
+
+    if (typeof (this as any).beforeSave === "function") {
+      await (this as any).beforeSave();
+    }
+
+    let doc: any;
+
+    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,
+      });
+    }
+
+    if (typeof (this as any).afterSave === "function") {
+      await (this as any).afterSave(doc);
+    }
+
+    return c.ok(undefined, "操作成功");
+  }
+
+  async destroy(c: Context) {
+    const Model = this.requireModel();
+    const ids = (c.req.param("id") ?? "").split(",").filter(Boolean);
+
+    if (ids.length > 1 && !this.batchAction) {
+      return c.fail("不可批量操作");
+    }
+
+    await Model.deleteMany({ [this.key]: { $in: ids } });
+
+    return c.ok(undefined, "操作成功");
+  }
+
+  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,
+    );
+
+    for (const key of searchKeys) {
+      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");
+      }
+    }
+
+    const customGetFilter = getCustomMethod(
+      this,
+      "getFilter",
+      ApiController.prototype.getFilter,
+    );
+
+    if (customGetFilter) {
+      Object.assign(filter, await customGetFilter.call(this, filter));
+    } else if ((this as any).filter) {
+      Object.assign(filter, (this as any).filter);
+    }
+
+    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 queue(list, this._formatItem, {
+      concurrency: this.formatConcurrency,
+    });
+  }
+
+  protected async _formatItem(item: any) {
+    let data = item;
+
+    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;
+        }
+      }
+
+      data = await this._omit(data);
+      data = await this._pick(data);
+    } catch (error) {
+      console.error("[ApiController] formatItem failed:", error);
+    }
+
+    return data;
+  }
+
+  private requireModel() {
+    if (!this.Model) {
+      throw new Error(`${this.constructor.name} must define Model.`);
+    }
+
+    return this.Model;
+  }
+}
+
+function getCustomMethod(target: object, name: string, baseMethod: Function) {
+  let prototype = Object.getPrototypeOf(target);
+
+  while (prototype && prototype !== ApiController.prototype) {
+    const descriptor = Object.getOwnPropertyDescriptor(prototype, name);
+
+    if (
+      typeof descriptor?.value === "function" &&
+      descriptor.value !== baseMethod
+    ) {
+      return descriptor.value;
+    }
+
+    prototype = Object.getPrototypeOf(prototype);
+  }
+
+  return undefined;
+}