add cjs output

dist/index.d.cts

@@ -0,0 +1,90 @@
+import * as tracer from 'tracer';
+import * as _typegoose_typegoose from '@typegoose/typegoose';
+import { ReturnModelType } from '@typegoose/typegoose';
+import * as _typegoose_typegoose_lib_types from '@typegoose/typegoose/lib/types';
+import { AnyParamConstructor } from '@typegoose/typegoose/lib/types';
+import * as mongoose from 'mongoose';
+import { Connection } from 'mongoose';
+
+/**
+ * 为model指定数据库连接
+ * @param {string} name 数据库连接名字， 在config中必须要有对应的配置， 比如main， 则必须要有 db_main
+ * */
+declare function dbconn(name?: string): (target: any) => void;
+
+declare class NoJsonClass {
+    private noJsonPropSet;
+    addKey(className: string, propertyKey: string): void;
+    checkExist(className: string, propertyKey: string): boolean;
+}
+/**
+ * 在不需要toJson方法输出的字段上加上 @noJson
+ * @return {{(target: Function): void, (target: Object, propertyKey: (string | symbol)): void}}
+ */
+declare function noJson(): (target: Object, propertyKey: string) => void;
+declare function checkJson(target: any, propertyKey: string): boolean;
+
+declare const logger: tracer.Tracer.Logger<string>;
+
+declare abstract class BaseModule {
+    static db: Connection;
+    updateFromReq(data: any): void;
+    /**
+     * 插入或更新
+     * @param condition
+     * @param data
+     */
+    static insertOrUpdate<T extends BaseModule>(this: ReturnModelType<AnyParamConstructor<T>>, condition: any, data: any): mongoose.QueryWithHelpers<mongoose.IfAny<T, any, mongoose.Document<unknown, _typegoose_typegoose_lib_types.BeAnObject, T> & Omit<mongoose.Require_id<T>, "typegooseName"> & _typegoose_typegoose_lib_types.IObjectWithTypegooseFunction>, mongoose.IfAny<T, any, mongoose.Document<unknown, _typegoose_typegoose_lib_types.BeAnObject, T> & Omit<mongoose.Require_id<T>, "typegooseName"> & _typegoose_typegoose_lib_types.IObjectWithTypegooseFunction>, _typegoose_typegoose_lib_types.BeAnObject, T, "findOneAndUpdate">;
+    /**
+     * 虚拟删除
+     * @param {string[]} ids
+     */
+    static deleteVirtual<T extends BaseModule>(this: ReturnModelType<AnyParamConstructor<T>>, ids: string[]): mongoose.QueryWithHelpers<mongoose.UpdateWriteOpResult, mongoose.IfAny<T, any, mongoose.Document<unknown, _typegoose_typegoose_lib_types.BeAnObject, T> & Omit<mongoose.Require_id<T>, "typegooseName"> & _typegoose_typegoose_lib_types.IObjectWithTypegooseFunction>, _typegoose_typegoose_lib_types.BeAnObject, T, "updateMany">;
+    /**
+     * 自定义分页查询
+     * @param data
+     * @param {boolean} json
+     */
+    static pageQuery<T extends BaseModule>(this: ReturnModelType<AnyParamConstructor<T>>, data: any, json?: boolean): Promise<{
+        records: mongoose.IfAny<T, any, mongoose.Document<unknown, _typegoose_typegoose_lib_types.BeAnObject, T> & Omit<mongoose.Require_id<T>, "typegooseName"> & _typegoose_typegoose_lib_types.IObjectWithTypegooseFunction>[];
+        total: number;
+        start: any;
+        limit: any;
+    }>;
+    toJson(): any;
+    /**
+     * 通用的查询条件拼接方法
+     * @param {{}} params  req.params
+     * @param options
+     *          sort:     排序 比如: {createdAt: 1} 默认是 {_id: 1}
+     *          opt:      设置一些特殊的过滤条件, 比如{deleted: 0}
+     *          timeKey:  如果需要查询创建时间, 而且创建时间不为 createdAt, 可以用此字段设置
+     *          matchKey: 指定关键字查询的匹配字段, 可为string或[string]
+     *
+     * @return {{opt: any, sort: {_id: number}}}
+     */
+    static parseQueryParam(params: {}, options?: any): {
+        opt: any;
+        sort: {
+            _id: number;
+        };
+    };
+    getTimestampOfID(): any;
+}
+
+/**
+ * 用户操作记录
+ */
+declare class UserLogClass extends BaseModule {
+    user: string;
+    name: string;
+    method: string;
+    path: string;
+    referer: string;
+    user_agent: string;
+    ip: string;
+    params: any;
+}
+declare const UserLog: _typegoose_typegoose.ReturnModelType<typeof UserLogClass, _typegoose_typegoose_lib_types.BeAnObject>;
+
+export { BaseModule, NoJsonClass, UserLog, checkJson, dbconn, logger, noJson };

package.json

@@ -6,6 +6,7 @@
   "exports": {
     ".": {
       "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
       "types": "./dist/index.d.ts"
     }
   },
@@ -19,6 +20,7 @@
   "license": "ISC",
   "dependencies": {
     "@typegoose/typegoose": "^12.1.0",
+    "bson": "^4.0.4",
     "mongoose": "^8.1.0",
     "tracer": "^1.3.0"
   },

tsup.config.ts

@@ -2,7 +2,7 @@ import { defineConfig } from "tsup";
 
 export default defineConfig({
   entry: ["src/index.ts"],
-  format: ["esm"], // Build for and ESmodules
+  format: ["cjs", "esm"], // Build for commonJS and ESmodules
   dts: true, // Generate declaration file (.d.ts)
   splitting: false,
   sourcemap: true,

yarn.lock

@@ -500,6 +500,11 @@ balanced-match@^1.0.0:
   resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee"
   integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==
 
+base64-js@^1.3.1:
+  version "1.5.1"
+  resolved "https://registry.yarnpkg.com/base64-js/-/base64-js-1.5.1.tgz#1b1b440160a5bf7ad40b650f095963481903930a"
+  integrity sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==
+
 binary-extensions@^2.0.0:
   version "2.2.0"
   resolved "https://registry.yarnpkg.com/binary-extensions/-/binary-extensions-2.2.0.tgz#75f502eeaf9ffde42fc98829645be4ea76bd9e2d"
@@ -519,11 +524,26 @@ braces@^3.0.2, braces@~3.0.2:
   dependencies:
     fill-range "^7.0.1"
 
+bson@^4.0.4:
+  version "4.7.2"
+  resolved "https://registry.yarnpkg.com/bson/-/bson-4.7.2.tgz#320f4ad0eaf5312dd9b45dc369cc48945e2a5f2e"
+  integrity sha512-Ry9wCtIZ5kGqkJoi6aD8KjxFZEx78guTQDnpXWiNthsxzrxAK/i8E6pCHAIZTbaEFWcOCvbecMukfK7XUvyLpQ==
+  dependencies:
+    buffer "^5.6.0"
+
 bson@^6.2.0:
   version "6.2.0"
   resolved "https://registry.yarnpkg.com/bson/-/bson-6.2.0.tgz#4b6acafc266ba18eeee111373c2699304a9ba0a3"
   integrity sha512-ID1cI+7bazPDyL9wYy9GaQ8gEEohWvcUl/Yf0dIdutJxnmInEEyCsb4awy/OiBfall7zBA179Pahi3vCdFze3Q==
 
+buffer@^5.6.0:
+  version "5.7.1"
+  resolved "https://registry.yarnpkg.com/buffer/-/buffer-5.7.1.tgz#ba62e7c13133053582197160851a8f648e99eed0"
+  integrity sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ==
+  dependencies:
+    base64-js "^1.3.1"
+    ieee754 "^1.1.13"
+
 bundle-require@^4.0.0:
   version "4.0.2"
   resolved "https://registry.yarnpkg.com/bundle-require/-/bundle-require-4.0.2.tgz#65fc74ff14eabbba36d26c9a6161bd78fff6b29e"
@@ -776,6 +796,11 @@ human-signals@^2.1.0:
   resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-2.1.0.tgz#dc91fcba42e4d06e4abaed33b3e7a3c02f514ea0"
   integrity sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==
 
+ieee754@^1.1.13:
+  version "1.2.1"
+  resolved "https://registry.yarnpkg.com/ieee754/-/ieee754-1.2.1.tgz#8eb7a10a63fff25d15a57b001586d177d1b0d352"
+  integrity sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==
+
 ignore@^5.2.0, ignore@^5.2.4:
   version "5.3.0"
   resolved "https://registry.yarnpkg.com/ignore/-/ignore-5.3.0.tgz#67418ae40d34d6999c95ff56016759c718c82f78"