@anjianshi/utils 3.7.1 → 3.7.4

package/env-node/logging/handlers.d.ts

@@ -1,5 +1,4 @@
-import { type ChalkInstance } from 'chalk';
-import { type LogInfo, LogHandler } from '../../logging/index.js';
+import { type LogInfo, LogLevel, LogHandler } from '../../logging/index.js';
 /**
  * 向 console 输出日志
  */
@@ -23,12 +22,8 @@ export declare class ConsoleHandler extends LogHandler {
             (message?: any, ...optionalParams: any[]): void;
         };
     };
-    static readonly levelColors: {
-        1: ChalkInstance;
-        2: ChalkInstance;
-        3: ChalkInstance;
-        4: ChalkInstance;
-    };
+    /** 注意：这里的颜色必须是 chalk 支持的有效颜色 */
+    static readonly levelColors: Record<LogLevel, string>;
     private static readonly loggerColors;
     private static readonly loggerColorMap;
     static getLoggerColor(logger: string): "green" | "yellow" | "blue" | "cyan" | "magenta" | "greenBright" | "yellowBright" | "blueBright" | "cyanBright" | "magentaBright";

package/env-node/logging/handlers.js

@@ -12,7 +12,8 @@ export class ConsoleHandler extends LogHandler {
     log(info) {
         const { logger, level, args } = info;
         const method = ConsoleHandler.consoleMethods[level];
-        const levelColor = ConsoleHandler.levelColors[level];
+        const levelColorName = ConsoleHandler.levelColors[level];
+        const levelColor = chalk[levelColorName] ?? chalk.white;
         const levelName = formatters.level(info);
         const loggerColor = chalk[ConsoleHandler.getLoggerColor(logger)];
         const prefix = [
@@ -28,12 +29,12 @@ export class ConsoleHandler extends LogHandler {
         [LogLevel.Warning]: console.warn.bind(console),
         [LogLevel.Error]: console.error.bind(console),
     };
+    /** 注意：这里的颜色必须是 chalk 支持的有效颜色 */
     static levelColors = {
-        // 不明确把类型标记为 ChalkInstance 的话，生成出的 .d.ts 会有问题。
-        [LogLevel.Debug]: chalk.whiteBright, // eslint-disable-line @typescript-eslint/no-unnecessary-type-assertion
-        [LogLevel.Info]: chalk.white, // eslint-disable-line @typescript-eslint/no-unnecessary-type-assertion
-        [LogLevel.Warning]: chalk.yellowBright, // eslint-disable-line @typescript-eslint/no-unnecessary-type-assertion
-        [LogLevel.Error]: chalk.redBright, // eslint-disable-line @typescript-eslint/no-unnecessary-type-assertion
+        [LogLevel.Debug]: 'whiteBright',
+        [LogLevel.Info]: 'white',
+        [LogLevel.Warning]: 'yellowBright',
+        [LogLevel.Error]: 'redBright',
     };
     // 可供 logger 选择的颜色
     static loggerColors = [

package/env-node/logging/index.d.ts

@@ -2,7 +2,7 @@
  * 针对 Node.js 环境定制 logging
  *
  * 使用前提：
- * - 安装 chalk 依赖
+ * - 依赖 chalk 库
  */
 import { type Logger } from '../../logging/index.js';
 export * from './handlers.js';

package/env-node/logging/index.js

@@ -2,7 +2,7 @@
  * 针对 Node.js 环境定制 logging
  *
  * 使用前提：
- * - 安装 chalk 依赖
+ * - 依赖 chalk 库
  */
 import { logger as defaultLogger } from '../../logging/index.js';
 import { ConsoleHandler } from './handlers.js';

package/env-service/prisma/adapt-logging.d.ts

@@ -25,8 +25,13 @@ export declare function getPrismaLoggingOptions(level: 'debug' | 'info' | 'warn'
         level: "error";
     })[];
 };
-/** 把 Prisma 日志重定向到 logger 中 */
-export declare function adaptPrismaLogging(prisma: Pick<PrismalClient, '$on'>, logger: Logger, enableDebugLog?: boolean): void;
-/** 开启调试日志，并改为通过 logger 记录日志内容 */
+/** 把 Prisma 日常日志重定向到 logger 中 */
+export declare function adaptPrismaLogging(prisma: Pick<PrismalClient, '$on'>, logger: Logger): void;
+/**
+ * 开启调试日志，并改为通过 logger 记录日志内容
+ *
+ * 注意：
+ * 因为 Prisma 在代码被引入时就会开始输出日志，若要记录下最完整的日志内容，应在初始化 Prisma Client 前调用此函数
+ */
 export declare function adaptPrismaDebugLogging(logger: Logger): void;
 export {};

package/env-service/prisma/adapt-logging.js

@@ -2,7 +2,7 @@
  * 对接 Prisma 的日志记录
  *
  * 使用前提：
- * - 安装 chalk 依赖
+ * - 依赖 chalk 库
  *
  * Prisma 输出的日志分两部分：
  * 1. 日常运行日志，可通过 PrismaClient 的 log 选项控制。
@@ -50,8 +50,8 @@ export function getPrismaLoggingOptions(level) {
         ],
     };
 }
-/** 把 Prisma 日志重定向到 logger 中 */
-export function adaptPrismaLogging(prisma, logger, enableDebugLog = false) {
+/** 把 Prisma 日常日志重定向到 logger 中 */
+export function adaptPrismaLogging(prisma, logger) {
     const queryLogger = logger.getChild('query');
     prisma.$on('query', e => {
         queryLogger.debug(e.query, chalk.green(nodeUtil.format(e.params) + ` +${e.duration}ms`));
@@ -59,10 +59,13 @@ export function adaptPrismaLogging(prisma, logger, enableDebugLog = false) {
     prisma.$on('info', e => logger.info(e.message));
     prisma.$on('warn', e => logger.warn(e.message));
     prisma.$on('error', e => logger.error(e.message));
-    if (enableDebugLog)
-        adaptPrismaDebugLogging(logger);
 }
-/** 开启调试日志，并改为通过 logger 记录日志内容 */
+/**
+ * 开启调试日志，并改为通过 logger 记录日志内容
+ *
+ * 注意：
+ * 因为 Prisma 在代码被引入时就会开始输出日志，若要记录下最完整的日志内容，应在初始化 Prisma Client 前调用此函数
+ */
 export function adaptPrismaDebugLogging(logger) {
     ;
     globalThis.DEBUG = '*';

package/env-service/prisma/extensions/soft-delete.d.ts

@@ -1,7 +1,7 @@
 /**
  * 扩展 Prisma 实现软删除
  *
- * 1. 有 deleteTime 字段的 model 支持软删除。
+ * 1. 有 deleteTime daletedTime deletedAt 字段之一的 model 支持软删除。
  * 2. 执行 delete() 和 deleteMany() 时默认是进行软删除；可指定 soft 为 false 来彻底删除；执行软删除时可指定要额外更新的 data。
  * 2. 查询时会忽略被软删除的记录；可指定 withDeleted 为 true 来包含它们。
  * 4. 可通过 restore() 和 restoreMany() 恢复软删除的记录。

package/env-service/prisma/extensions/soft-delete.js

@@ -1,7 +1,7 @@
 /**
  * 扩展 Prisma 实现软删除
  *
- * 1. 有 deleteTime 字段的 model 支持软删除。
+ * 1. 有 deleteTime daletedTime deletedAt 字段之一的 model 支持软删除。
  * 2. 执行 delete() 和 deleteMany() 时默认是进行软删除；可指定 soft 为 false 来彻底删除；执行软删除时可指定要额外更新的 data。
  * 2. 查询时会忽略被软删除的记录；可指定 withDeleted 为 true 来包含它们。
  * 4. 可通过 restore() 和 restoreMany() 恢复软删除的记录。
@@ -14,6 +14,7 @@
  * 为保证其他扩展也应用到修改过的这些方法，此扩展应尽可能放在最前面。
  */
 import { Prisma } from '@prisma/client/extension.js';
+const fieldNames = ['deleteTime', 'deletedTime', 'deletedAt'];
 // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
 function getModel(that) {
     const context = Prisma.getExtensionContext(that);
@@ -25,16 +26,16 @@ function getModel(that) {
     do {
         model = model.$parent[context.$name];
     } while ('withSoftDeleteExtension' in model);
-    const supportSoftDelete = 'deleteTime' in model.fields;
-    return { model, supportSoftDelete };
+    const softDeleteField = fieldNames.find(field => field in model.fields);
+    return { model, softDeleteField };
 }
 function query(that, inputArgs, method) {
-    const { model, supportSoftDelete } = getModel(that);
+    const { model, softDeleteField } = getModel(that);
     // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
     const { withDeleted = false, ...args } = (inputArgs ?? {});
     return model[method]({
         ...args,
-        where: !supportSoftDelete || withDeleted ? args.where : { ...args.where, deleteTime: null },
+        where: !softDeleteField || withDeleted ? args.where : { ...args.where, [softDeleteField]: null },
     });
 }
 export const softDelete = Prisma.defineExtension({
@@ -46,12 +47,12 @@ export const softDelete = Prisma.defineExtension({
             // 操作
             // -----------------------------
             delete(rawArgs) {
-                const { model, supportSoftDelete } = getModel(this);
+                const { model, softDeleteField } = getModel(this);
                 const { soft = true, data, ...args } = rawArgs;
-                if (supportSoftDelete && soft) {
+                if (softDeleteField && soft) {
                     return model.update({
                         ...args, // .delete() 的参数 .update() 也都支持
-                        data: { ...(data ?? {}), deleteTime: new Date() },
+                        data: { ...(data ?? {}), [softDeleteField]: new Date() },
                     }); // .update() 的返回值和 .delete() 一样
                 }
                 else {
@@ -59,12 +60,12 @@ export const softDelete = Prisma.defineExtension({
                 }
             },
             deleteMany(rawArgs) {
-                const { model, supportSoftDelete } = getModel(this);
+                const { model, softDeleteField } = getModel(this);
                 const { soft = true, data, ...args } = rawArgs;
-                if (supportSoftDelete && soft) {
+                if (softDeleteField && soft) {
                     return model.updateMany({
                         ...args, // .deleteMany() 的参数 .updateMany() 也都支持
-                        data: { ...(data ?? {}), deleteTime: new Date() },
+                        data: { ...(data ?? {}), [softDeleteField]: new Date() },
                     }); // .updateMany() 的返回值和 .deleteMany() 一样
                 }
                 else {
@@ -73,22 +74,22 @@ export const softDelete = Prisma.defineExtension({
             },
             restore(rawArgs) {
                 const { data, ...args } = rawArgs;
-                const { model, supportSoftDelete } = getModel(this);
-                if (!supportSoftDelete)
+                const { model, softDeleteField } = getModel(this);
+                if (!softDeleteField)
                     throw new Error('当前模型不支持软删除，不能执行恢复');
                 return model.update({
                     ...args,
-                    data: { ...(data ?? {}), deleteTime: null },
+                    data: { ...(data ?? {}), [softDeleteField]: null },
                 });
             },
             restoreMany(rawArgs) {
                 const { data, ...args } = rawArgs;
-                const { model, supportSoftDelete } = getModel(this);
-                if (!supportSoftDelete)
+                const { model, softDeleteField } = getModel(this);
+                if (!softDeleteField)
                     throw new Error('当前模型不支持软删除，不能执行恢复');
                 return model.updateMany({
                     ...args,
-                    data: { ...(data ?? {}), deleteTime: new Date() },
+                    data: { ...(data ?? {}), [softDeleteField]: new Date() },
                 });
             },
             // -----------------------------

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anjianshi/utils",
-  "version": "3.7.1",
+  "version": "3.7.4",
   "description": "Common JavaScript Utils",
   "homepage": "https://github.com/anjianshi/js-packages/utils",
   "bugs": {
@@ -38,12 +38,12 @@
     "redis": "^5.5.6",
     "typescript": "^5.8.3",
     "vconsole": "^3.15.1",
+    "@anjianshi/presets-eslint-typescript": "6.1.2",
     "@anjianshi/presets-eslint-base": "6.1.2",
-    "@anjianshi/presets-eslint-node": "6.1.2",
     "@anjianshi/presets-eslint-react": "6.1.3",
-    "@anjianshi/presets-eslint-typescript": "6.1.2",
-    "@anjianshi/presets-prettier": "3.2.0",
-    "@anjianshi/presets-typescript": "3.2.5"
+    "@anjianshi/presets-eslint-node": "6.1.2",
+    "@anjianshi/presets-typescript": "3.2.5",
+    "@anjianshi/presets-prettier": "3.2.0"
   },
   "prettier": "@anjianshi/presets-prettier/prettierrc"
 }