@jayfong/x-server 2.106.5 → 2.107.0

package/lib/_cjs/services/random.js

@@ -0,0 +1,51 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.RandomService = void 0;
+var _cuid = require("@paralleldrive/cuid2");
+var _randomstring = _interopRequireDefault(require("randomstring"));
+class RandomService {
+  constructor() {
+    this.serviceName = 'random';
+  }
+  /**
+   * 24位。
+   *
+   * @see https://github.com/paralleldrive/cuid2
+   */
+  cuid2() {
+    return (0, _cuid.createId)();
+  }
+
+  /**
+   * [0-9 a-z A-Z]
+   */
+  generateAlphanumeric(length) {
+    return _randomstring.default.generate({
+      charset: 'alphanumeric',
+      length: length
+    });
+  }
+
+  /**
+   * [a-z A-Z]
+   */
+  generateAlphabetic(length) {
+    return _randomstring.default.generate({
+      charset: 'alphabetic',
+      length: length
+    });
+  }
+
+  /**
+   * [0-9]
+   */
+  generateNumeric(length) {
+    return _randomstring.default.generate({
+      charset: 'numeric',
+      length: length
+    });
+  }
+}
+exports.RandomService = RandomService;

package/lib/_cjs/x.js

@@ -3,8 +3,8 @@
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
 exports.__esModule = true;
 exports.x = void 0;
-var _os = _interopRequireDefault(require("os"));
-var _path = _interopRequireDefault(require("path"));
+var _nodeOs = _interopRequireDefault(require("node:os"));
+var _nodePath = _interopRequireDefault(require("node:path"));
 var _fsExtra = _interopRequireDefault(require("fs-extra"));
 var _ctx_storage = require("./core/ctx_storage");
 var _crypto = require("./services/crypto");
@@ -13,11 +13,12 @@ var _dispose = require("./services/dispose");
 var _emoji = require("./services/emoji");
 var _html = require("./services/html");
 var _log = require("./services/log");
+var _random = require("./services/random");
 const env = JSON.parse(process.env.X_SERVER_ENVS || '{}');
 const x = exports.x = {
   appId: env.APP_ID,
   env: env,
-  dataDir: _path.default.join(_os.default.homedir(), `.xs/${env.APP_ID}`),
+  dataDir: _nodePath.default.join(_nodeOs.default.homedir(), `.xs/${env.APP_ID}`),
   get ctx() {
     return _ctx_storage.ctxStorage.getStore();
   },
@@ -31,4 +32,4 @@ const x = exports.x = {
 _fsExtra.default.ensureDirSync(x.dataDir);
 x.register(new _dispose.DisposeService({
   disposeOnExit: true
-}), new _log.LogService(), new _emoji.EmojiService(), new _db_value.DbValueService(), new _crypto.CryptoService(), new _html.HtmlService());
+}), new _log.LogService(), new _emoji.EmojiService(), new _db_value.DbValueService(), new _crypto.CryptoService(), new _html.HtmlService(), new _random.RandomService());

package/lib/core/types.d.ts

@@ -1,15 +1,15 @@
-import type { IncomingHttpHeaders } from 'http';
+import type { IncomingHttpHeaders } from 'node:http';
 import type { MultipartFile } from '@fastify/multipart';
 import type { SocketStream } from '@fastify/websocket';
 import type { Queue } from 'bull';
-import { CronJob } from 'cron';
-import { FastifyReply, FastifyRequest, FastifyServerOptions } from 'fastify';
+import type { CronJob } from 'cron';
+import type { FastifyReply, FastifyRequest, FastifyServerOptions } from 'fastify';
 import type { MsValue } from 'vtils';
 import type { AsyncOrSync, LiteralUnion, OneOrMore, RequiredDeep } from 'vtils/types';
-import * as vae from 'vtils/vae';
-import { yup } from 'vtils/validator';
-import { BasePlugin } from '../plugins/base';
-import { BaseService } from '../services/base';
+import type * as vae from 'vtils/vae';
+import type { yup } from 'vtils/validator';
+import type { BasePlugin } from '../plugins/base';
+import type { BaseService } from '../services/base';
 import type { DisposeService } from '../services/dispose';
 import type { Handler } from './handler';
 export declare namespace XServer {
@@ -117,7 +117,7 @@ export declare namespace XHandler {
     ctx: Context) => AsyncOrSync<TResData>;
     interface ExtraOptions {
     }
-    interface Options<TReqData extends any = void, TResData extends any = void, TReqMethod extends Method = Method> extends ExtraOptions {
+    interface Options<TReqData extends any = void, TResData extends any = void, TReqMethod extends Method = Method, TReqDataRequired = RequiredDeep<TReqData>> extends ExtraOptions {
         /**
          * 请求方法
          *
@@ -156,11 +156,11 @@ export declare namespace XHandler {
         /**
          * 请求数据验证结构(yup)
          */
-        requestDataSchema?: (_: typeof yup) => yup.GetSchema<RequiredDeep<TReqData>>;
+        requestDataSchema?: (_: typeof yup) => yup.GetSchema<TReqDataRequired>;
         /**
          * 请求数据验证结构(vae)
          */
-        requestDataSchemaVae?: vae.VaeSchemaOf<TReqData> | ((_: vae.VaeSchemaBuilder<TReqData>) => vae.VaeSchemaOf<TReqData> | vae.VaeObjectSchemaShapeOf<TReqData>);
+        requestDataSchemaVae?: vae.VaeSchemaOf<TReqDataRequired> | ((_: vae.VaeSchemaBuilder<TReqDataRequired>) => vae.VaeSchemaOf<TReqDataRequired> | vae.VaeObjectSchemaShapeOf<TReqDataRequired>);
         /**
          * 是否使用异步上下文
          *

package/lib/services/random.d.ts

@@ -0,0 +1,27 @@
+import type { BaseService } from './base';
+export declare class RandomService implements BaseService {
+    serviceName: string;
+    /**
+     * 24位。
+     *
+     * @see https://github.com/paralleldrive/cuid2
+     */
+    cuid2(): string;
+    /**
+     * [0-9 a-z A-Z]
+     */
+    generateAlphanumeric(length: number): string;
+    /**
+     * [a-z A-Z]
+     */
+    generateAlphabetic(length: number): string;
+    /**
+     * [0-9]
+     */
+    generateNumeric(length: number): string;
+}
+declare module '../x' {
+    interface X {
+        random: RandomService;
+    }
+}

package/lib/services/random.js

@@ -0,0 +1,45 @@
+import { createId as cuid2 } from '@paralleldrive/cuid2';
+import randomstring from 'randomstring';
+export class RandomService {
+  constructor() {
+    this.serviceName = 'random';
+  }
+  /**
+   * 24位。
+   *
+   * @see https://github.com/paralleldrive/cuid2
+   */
+  cuid2() {
+    return cuid2();
+  }
+
+  /**
+   * [0-9 a-z A-Z]
+   */
+  generateAlphanumeric(length) {
+    return randomstring.generate({
+      charset: 'alphanumeric',
+      length: length
+    });
+  }
+
+  /**
+   * [a-z A-Z]
+   */
+  generateAlphabetic(length) {
+    return randomstring.generate({
+      charset: 'alphabetic',
+      length: length
+    });
+  }
+
+  /**
+   * [0-9]
+   */
+  generateNumeric(length) {
+    return randomstring.generate({
+      charset: 'numeric',
+      length: length
+    });
+  }
+}

package/lib/x.d.ts

@@ -1,11 +1,12 @@
-import { XHandler } from './core/types';
-import { BaseService } from './services/base';
+import type { XHandler } from './core/types';
+import type { BaseService } from './services/base';
 import './services/crypto';
 import './services/db_value';
 import './services/dispose';
 import './services/emoji';
 import './services/html';
 import './services/log';
+import './services/random';
 export interface X {
     readonly appId: string;
     readonly env: NodeJS.ProcessEnv;

package/lib/x.js

@@ -1,5 +1,5 @@
-import os from 'os';
-import path from 'path';
+import os from 'node:os';
+import path from 'node:path';
 import fs from 'fs-extra';
 import { ctxStorage } from "./core/ctx_storage";
 import { CryptoService } from "./services/crypto";
@@ -8,6 +8,7 @@ import { DisposeService } from "./services/dispose";
 import { EmojiService } from "./services/emoji";
 import { HtmlService } from "./services/html";
 import { LogService } from "./services/log";
+import { RandomService } from "./services/random";
 const env = JSON.parse(process.env.X_SERVER_ENVS || '{}');
 export const x = {
   appId: env.APP_ID,
@@ -26,4 +27,4 @@ export const x = {
 fs.ensureDirSync(x.dataDir);
 x.register(new DisposeService({
   disposeOnExit: true
-}), new LogService(), new EmojiService(), new DbValueService(), new CryptoService(), new HtmlService());
+}), new LogService(), new EmojiService(), new DbValueService(), new CryptoService(), new HtmlService(), new RandomService());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jayfong/x-server",
-  "version": "2.106.5",
+  "version": "2.107.0",
   "license": "ISC",
   "sideEffects": false,
   "main": "lib/_cjs/index.js",
@@ -27,6 +27,7 @@
     "@fastify/formbody": "^7.4.0",
     "@fastify/multipart": "^7.7.0",
     "@fastify/websocket": "^8.1.0",
+    "@paralleldrive/cuid2": "^3.0.4",
     "@prisma/adapter-mariadb": "^7.1.0",
     "@prisma/client": "^7.1.0",
     "@types/busboy": "^0.3.2",
@@ -67,6 +68,7 @@
     "pinyin-pro": "^3.26.0",
     "pirates": "^4.0.6",
     "prisma": "^7.1.0",
+    "randomstring": "^1.3.1",
     "select-run": "^1.1.2",
     "supports-color": "^8",
     "svg-captcha": "^1.4.0",
@@ -86,6 +88,7 @@
     "@types/ioredis": "^5.0.0",
     "@types/json-schema": "^7.0.11",
     "@types/lz-string": "^1.3.34",
+    "@types/randomstring": "^1.3.0",
     "axios": "^1.4.0",
     "ioredis-mock": "^8.7.0",
     "json-xml-parse": "^1.2.4",