@anjianshi/utils 2.3.10 → 2.4.0

package/env-node/crypto-random.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 返回随机数，包含 min 和 max
+ */
+export declare function getCryptoRandomInt(min: number, max: number): number;
+/**
+ * 返回随机字符串
+ */
+export declare function getCryptoRandomString(length?: number, seed?: string): string;
+/**
+ * 从给定的选择中随机选中一项
+ * 如果数组为空，会返回 undefined
+ */
+export declare function cryptoChoiceRandom<T>(choices: T[]): T | undefined;

package/env-node/{random.js → crypto-random.js}

@@ -5,7 +5,7 @@ import crypto from 'node:crypto';
 /**
  * 返回随机数，包含 min 和 max
  */
-export function getRandomInt(min, max) {
+export function getCryptoRandomInt(min, max) {
     // 如果传入的 max 小于 min，把它拉到和 min 一样。不然 crypto.randomInt 无法处理
     const fixedMax = Math.max(min, max);
     return crypto.randomInt(min, fixedMax + 1);
@@ -13,16 +13,16 @@ export function getRandomInt(min, max) {
 /**
  * 返回随机字符串
  */
-export function getRandomString(length = 6, seed = '0123456789abcdefghijklmnopqrstuvwxyz') {
+export function getCryptoRandomString(length = 6, seed = '0123456789abcdefghijklmnopqrstuvwxyz') {
     let result = '';
     while (result.length < length)
-        result += seed[getRandomInt(0, seed.length - 1)];
+        result += seed[getCryptoRandomInt(0, seed.length - 1)];
     return result;
 }
 /**
  * 从给定的选择中随机选中一项
  * 如果数组为空，会返回 undefined
  */
-export function choiceRandom(choices) {
-    return choices[getRandomInt(0, choices.length - 1)];
+export function cryptoChoiceRandom(choices) {
+    return choices[getCryptoRandomInt(0, choices.length - 1)];
 }

package/env-node/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * Node 环境下的工具函数
+ * Node.js 环境下的工具函数
  */
 export * from './fs.js';
-export * from './random.js';
+export * from './crypto-random.js';

package/env-node/index.js

@@ -1,5 +1,5 @@
 /**
- * Node 环境下的工具函数
+ * Node.js 环境下的工具函数
  */
 export * from './fs.js';
-export * from './random.js';
+export * from './crypto-random.js';

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

@@ -30,7 +30,7 @@ export declare class ConsoleHandler extends LogHandler {
     };
     private static readonly loggerColors;
     private static readonly loggerColorMap;
-    static getLoggerColor(logger: string): "blue" | "blueBright" | "cyan" | "cyanBright" | "green" | "greenBright" | "magenta" | "magentaBright" | "yellow" | "yellowBright";
+    static getLoggerColor(logger: string): "green" | "yellow" | "blue" | "cyan" | "magenta" | "greenBright" | "yellowBright" | "blueBright" | "cyanBright" | "magentaBright";
 }
 /**
  * 写入文件日志

package/env-service/controllers.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 把业务功能整理成各个 Controller，
+ * 并整合成一个 controllers 对象方便外部引用和 Controller 之间互相引用。
+ *
+ * 支持自定义 Controller 类，例如把 context 中的内容定义成属性。
+ */
+type AnyObject = Record<string, unknown>;
+type AnyController<Context> = Controller<Context, any>;
+type AnyControllerClass<Context> = typeof Controller<Context, any>;
+export type ControllersFrom<Context, T extends AnyObject> = {
+    [K in keyof T]: T[K] extends AnyControllerClass<Context> ? InstanceType<T[K]> : never;
+};
+/**
+ * Controller 基类
+ */
+export declare class Controller<Context, AllControllers extends Record<string, AnyController<Context>>> {
+    /** 调用其他 controllers */
+    protected readonly controllers: AllControllers;
+    protected readonly context: Context;
+    constructor(
+    /** 调用其他 controllers */
+    controllers: AllControllers, context: Context);
+}
+/**
+ * 传入 Controller 类列表，返回 controller 实例集合。
+ * 为优化性能，每个 controller 只有在被使用到时才会实例化。
+ */
+export declare function initializeControllers<Context, T extends AnyObject>(controllerClasses: T, context: Context): ControllersFrom<Context, T>;
+export {};

package/env-service/controllers.js

@@ -0,0 +1,39 @@
+/**
+ * 把业务功能整理成各个 Controller，
+ * 并整合成一个 controllers 对象方便外部引用和 Controller 之间互相引用。
+ *
+ * 支持自定义 Controller 类，例如把 context 中的内容定义成属性。
+ */
+/**
+ * Controller 基类
+ */
+export class Controller {
+    controllers;
+    context;
+    constructor(
+    /** 调用其他 controllers */
+    controllers, context) {
+        this.controllers = controllers;
+        this.context = context;
+    }
+}
+/**
+ * 传入 Controller 类列表，返回 controller 实例集合。
+ * 为优化性能，每个 controller 只有在被使用到时才会实例化。
+ */
+export function initializeControllers(controllerClasses, context) {
+    const proxy = new Proxy({}, {
+        get(controllers, prop) {
+            if (typeof prop !== 'string')
+                return;
+            if (prop in controllers)
+                return controllers[prop];
+            if (prop in controllerClasses) {
+                const Class = controllerClasses[prop];
+                controllers[prop] = new Class(proxy, context);
+                return controllers[prop];
+            }
+        },
+    });
+    return proxy;
+}

package/{env-node → env-service}/env-reader.d.ts

@@ -35,7 +35,7 @@ export declare class EnvReader {
      * 同 envReader.get()，只不过是通过对象指定各 env 的默认值来批量获取
      * envReader.batchGet({ port: 8000, debug: false, mobiles: ['123', '456'] }
      */
-    batchGet<Defs extends Record<string, EnvValue>>(definitions: Defs): Defs;
+    batchGet<Defs extends Record<string, EnvValue>>(definitions: Defs): { [K in keyof Defs]: Defs[K] extends string ? string : Defs[K] extends number ? number : Defs[K] extends boolean ? boolean : Defs[K]; };
     /**
      * 同 envReader.getByType()，只不过是通过对象指定各 env 的类型来批量获取。
      *

package/{env-node → env-service}/env-reader.js

@@ -62,6 +62,7 @@ export class EnvReader {
         for (const [key, defaults] of Object.entries(definitions)) {
             result[key] = this.get(key, defaults);
         }
+        // 保证返回的值类型是“通用化”的，例如不是 `false` 而是 `boolean`
         return result;
     }
     batchGetByType(definitions, required = false) {

package/env-service/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 开发后端服务能用到的工具库
+ */
+export * from './env-reader.js';
+export * from './redis-cache.js';
+export * from './controllers.js';
+export * from './tasks.js';

package/env-service/index.js

@@ -0,0 +1,7 @@
+/**
+ * 开发后端服务能用到的工具库
+ */
+export * from './env-reader.js';
+export * from './redis-cache.js';
+export * from './controllers.js';
+export * from './tasks.js';

package/env-service/tasks.d.ts

@@ -0,0 +1,12 @@
+import { type Logger } from '../logging/index.js';
+/** 返回 false 可结束任务 */
+export type TaskExecutor<Context> = (context: Context) => Promise<undefined | false>;
+/**
+ * 执行定期任务
+ */
+export declare abstract class TaskManager<Context> {
+    protected baseLogger: Logger;
+    constructor(baseLogger?: Logger);
+    abstract getContext(taskName: string): Context;
+    run(name: string, interval: number, executor: TaskExecutor<Context>): Promise<void>;
+}

package/env-service/tasks.js

@@ -0,0 +1,37 @@
+import { sleep } from '../lang/async.js';
+import { logger as rootLogger } from '../logging/index.js';
+/**
+ * 执行定期任务
+ */
+export class TaskManager {
+    baseLogger;
+    constructor(baseLogger = rootLogger.getChild('task')) {
+        this.baseLogger = baseLogger;
+    }
+    async run(name, interval, executor) {
+        await sleep(1000);
+        const logger = this.baseLogger.getChild(name);
+        let nextId = 1;
+        while (true) {
+            const id = nextId++;
+            if (id >= Number.MAX_SAFE_INTEGER)
+                nextId = 1;
+            const start = Date.now();
+            logger.info(`#${id} 任务开始`);
+            try {
+                const context = this.getContext(name);
+                const result = await executor(context);
+                const cost = (Date.now() - start) / 1000;
+                logger.info(`#${id} 任务完成，耗时 ${cost}s`);
+                if (result === false) {
+                    logger.info('任务结束');
+                    break;
+                }
+            }
+            catch (err) {
+                logger.error(`#${id} 任务失败`, err);
+            }
+            await sleep(interval);
+        }
+    }
+}

package/logging/index.d.ts

@@ -1,6 +1,6 @@
+import { type Dayjs } from 'dayjs';
 export { default as formatters } from './formatters.js';
 export * from './adapt.js';
-import { type Dayjs } from 'dayjs';
 export declare enum LogLevel {
     Debug = 1,
     Info = 2,

package/logging/index.js

@@ -1,6 +1,6 @@
+import dayjs from 'dayjs';
 export { default as formatters } from './formatters.js';
 export * from './adapt.js';
-import dayjs from 'dayjs';
 import { initDayJs } from '../init-dayjs.js';
 // 引入 logging 库会自动初始化 dayjs
 initDayJs();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anjianshi/utils",
-  "version": "2.3.10",
+  "version": "2.4.0",
   "description": "Common JavaScript Utils",
   "homepage": "https://github.com/anjianshi/js-packages/utils",
   "bugs": {
@@ -20,17 +20,18 @@
     "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "@types/lodash": "^4.17.7",
-    "@types/node": "^20.16.2",
-    "@types/react": "^18.3.5",
+    "@types/lodash": "^4.17.10",
+    "@types/node": "^20.16.11",
+    "@types/react": "^18.3.11",
     "dotenv": "^16.4.5",
-    "typescript": "^5.5.4",
+    "redis": "^4.7.0",
+    "typescript": "^5.6.3",
     "vconsole": "^3.15.1",
-    "@anjianshi/presets-eslint-node": "4.0.8",
-    "@anjianshi/presets-eslint-typescript": "5.0.5",
+    "@anjianshi/presets-eslint-react": "4.0.7",
     "@anjianshi/presets-typescript": "3.2.2",
     "@anjianshi/presets-prettier": "3.0.1",
-    "@anjianshi/presets-eslint-react": "4.0.7"
+    "@anjianshi/presets-eslint-typescript": "5.0.5",
+    "@anjianshi/presets-eslint-node": "4.0.8"
   },
   "peerDependencies": {
     "@emotion/react": "^11.13.3",
@@ -39,8 +40,8 @@
     "@prisma/client": "^5.20.0",
     "chalk": "^5.3.0",
     "dayjs": "^1.11.10",
-    "react": "^18.3.1",
-    "redis": "^4.7.0"
+    "dotenv": "^16.4.5",
+    "react": "^18.3.1"
   },
   "peerDependenciesMeta": {
     "@emotion/react": {
@@ -61,10 +62,10 @@
     "dayjs": {
       "optional": true
     },
-    "react": {
+    "dotenv": {
       "optional": true
     },
-    "redis": {
+    "react": {
       "optional": true
     }
   },

package/env-node/random.d.ts

@@ -1,13 +0,0 @@
-/**
- * 返回随机数，包含 min 和 max
- */
-export declare function getRandomInt(min: number, max: number): number;
-/**
- * 返回随机字符串
- */
-export declare function getRandomString(length?: number, seed?: string): string;
-/**
- * 从给定的选择中随机选中一项
- * 如果数组为空，会返回 undefined
- */
-export declare function choiceRandom<T>(choices: T[]): T | undefined;