@anjianshi/utils 2.4.10 → 2.4.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anjianshi/utils",
-  "version": "2.4.10",
+  "version": "2.4.12",
   "description": "Common JavaScript Utils",
   "homepage": "https://github.com/anjianshi/js-packages/utils",
   "bugs": {
@@ -27,11 +27,11 @@
     "redis": "^4.7.0",
     "typescript": "^5.6.3",
     "vconsole": "^3.15.1",
-    "@anjianshi/presets-eslint-node": "4.0.13",
-    "@anjianshi/presets-eslint-react": "4.0.12",
-    "@anjianshi/presets-eslint-typescript": "5.0.10",
+    "@anjianshi/presets-eslint-node": "4.0.14",
+    "@anjianshi/presets-eslint-typescript": "5.0.11",
     "@anjianshi/presets-prettier": "3.0.1",
-    "@anjianshi/presets-typescript": "3.2.3"
+    "@anjianshi/presets-typescript": "3.2.3",
+    "@anjianshi/presets-eslint-react": "4.0.13"
   },
   "peerDependencies": {
     "@emotion/react": "^11.13.3",

package/validators/base.d.ts

@@ -12,7 +12,7 @@ export type PrimitiveType = string | boolean | number | PrimitiveType[] | [...Pr
 /**
  * validator 通用参数
  */
-export interface CommonOptions<Defaults = unknown> {
+export interface CommonOptions<Value = unknown> {
     /** 是否允许 null 值 @default false */
     null?: boolean;
     /** 字段是否必须有值（不能是 undefined） @default true */
@@ -21,7 +21,8 @@ export interface CommonOptions<Defaults = unknown> {
      * 默认值，字段无值（或值为 undefined）时生效，值为 null 不会生效。
      * 指定后 required 选项将失去作用。
      */
-    defaults?: Defaults;
+    defaults?: Value;
+    custom?: <T extends Value>(input: T) => MaySuccess<T>;
     [key: string]: unknown;
 }
 /**
@@ -33,6 +34,9 @@ type FullfiledOptions<Options extends Partial<CommonOptions>> = Omit<Options, ke
     defaults: Options extends {
         defaults: infer T;
     } ? T : undefined;
+    custom: Options extends {
+        custom: infer T;
+    } ? T : undefined;
 };
 /**
  * 验证完成后能得到的值类型

package/validators/base.js

@@ -7,7 +7,7 @@ import { success, failed } from '../lang/index.js';
 export function getValidatorGenerator(validate) {
     return function validatorGenerator(inputOptions) {
         function validator(field, input) {
-            const { null: allowNull = false, required = true, defaults } = inputOptions;
+            const { null: allowNull = false, required = true, defaults, custom } = inputOptions;
             if (typeof field !== 'string') {
                 input = field;
                 field = 'value';
@@ -25,7 +25,8 @@ export function getValidatorGenerator(validate) {
                 return failed(`${field} cannot be null`);
             if (value === null || value === undefined)
                 return success(value);
-            return validate(field, value, inputOptions);
+            const validated = validate(field, value, inputOptions);
+            return validated.success && custom ? custom(validated.data) : validated;
         }
         return validator;
     };

package/validators/factory.d.ts

@@ -6,6 +6,7 @@ import { type Validator, type CommonOptions, type Validated } from './base.js';
 import { type BooleanOptions } from './boolean.js';
 import { type NumberOptions, type NumberValueWithChoices } from './number.js';
 import { type RecordOptions, type StructOptions } from './object.js';
+import { type OneOfOptions } from './oneOf.js';
 import { type StringOptions, type StringValueWithChoices } from './string.js';
 export interface AnyDefinition extends CommonOptions {
     type: 'any';
@@ -35,12 +36,18 @@ export interface RecordDefinition extends Omit<RecordOptions, 'record'> {
     type: 'record';
     record: Definition;
 }
-export type Definition = AnyDefinition | BooleanDefinition | NumberDefinition | StringDefinition | ArrayDefinition | TupleDefinition | StructDefinition | RecordDefinition;
+export interface OneOfDefinition extends Omit<OneOfOptions, 'validators'> {
+    type: 'oneOf';
+    validators: Definition[];
+}
+export type Definition = AnyDefinition | BooleanDefinition | NumberDefinition | StringDefinition | ArrayDefinition | TupleDefinition | StructDefinition | RecordDefinition | OneOfDefinition;
 export type ValueOfDefinition<Def extends Definition> = Def extends AnyDefinition ? unknown : Def extends BooleanDefinition ? boolean : Def extends NumberDefinition ? NumberValueWithChoices<Def> : Def extends StringDefinition ? StringValueWithChoices<Def> : Def extends ArrayDefinition ? Validated<ValueOfDefinition<Def['item']>, Def['item']>[] : Def extends TupleDefinition ? {
     [Key in keyof Def['tuple']]: Def['tuple'][Key] extends Definition ? Validated<ValueOfDefinition<Def['tuple'][Key]>, Def['tuple'][Key]> : Def['tuple'][Key];
 } : Def extends StructDefinition ? {
     [Key in keyof Def['struct']]: Validated<ValueOfDefinition<Def['struct'][Key]>, Def['struct'][Key]>;
-} : Def extends RecordDefinition ? Record<string, Validated<ValueOfDefinition<Def['record']>, Def['record']>> : never;
+} : Def extends RecordDefinition ? Record<string, Validated<ValueOfDefinition<Def['record']>, Def['record']>> : Def extends OneOfDefinition ? {
+    [Key in keyof Def['validators']]: Def['validators'][Key] extends Definition ? Validated<ValueOfDefinition<Def['validators'][Key]>, Def['validators'][Key]> : Def['validators'][Key];
+}[number] : never;
 export type OptionsFromDefinition<Def extends Definition> = Def extends ArrayDefinition ? Omit<Def, 'item'> & {
     item: ValidatorForDefinition<Def['item']>;
 } : Def extends TupleDefinition ? Omit<Def, 'tuple'> & {

package/validators/factory.js

@@ -6,6 +6,7 @@ import { getAnyValidator } from './base.js';
 import { getBooleanValidator } from './boolean.js';
 import { getNumberValidator } from './number.js';
 import { getRecordValidator, getStructValidator, } from './object.js';
+import { getOneOfValidator } from './oneOf.js';
 import { getStringValidator } from './string.js';
 export function getValidator(definition) {
     switch (definition.type) {
@@ -22,23 +23,27 @@ export function getValidator(definition) {
             return getArrayValidator({
                 // @ts-ignore 允许递归类型推断
                 ...definition,
-                item: getValidator(definition['item']),
+                item: getValidator(definition.item),
             });
         case 'tuple':
             return getTupleValidator({
                 ...definition,
-                tuple: definition['tuple'].map(def => getValidator(def)),
+                tuple: definition.tuple.map(def => getValidator(def)),
             });
         case 'struct': {
             const struct = {};
-            for (const [key, def] of Object.entries(definition['struct']))
+            for (const [key, def] of Object.entries(definition.struct))
                 struct[key] = getValidator(def);
             return getStructValidator({ ...definition, struct });
         }
         case 'record':
             return getRecordValidator({
                 ...definition,
-                record: getValidator(definition['record']),
+                record: getValidator(definition.record),
+            });
+        case 'oneOf':
+            return getOneOfValidator({
+                validators: definition.validators.map(def => getValidator(def)),
             });
     }
 }
@@ -86,3 +91,11 @@ export function getValidator(definition) {
 //   type: 'record',
 //   record: { type: 'string', null: true, choices: ['a', 'b', 'c'] },
 // })(1)
+// const v10 = getValidator({
+//   type: 'oneOf',
+//   validators: [
+//     { type: 'string', choices: ['a', 'b', 'c'] },
+//     { type: 'number', null: true },
+//   ],
+//   defaults: true,
+// })(1)

package/validators/index.d.ts

@@ -4,4 +4,5 @@ export * from './boolean.js';
 export * from './number.js';
 export * from './object.js';
 export * from './string.js';
+export * from './oneOf.js';
 export * from './factory.js';

package/validators/index.js

@@ -4,4 +4,5 @@ export * from './boolean.js';
 export * from './number.js';
 export * from './object.js';
 export * from './string.js';
+export * from './oneOf.js';
 export * from './factory.js';

package/validators/oneOf.d.ts

@@ -0,0 +1,10 @@
+import { type CommonOptions, type Validator } from './base.js';
+/** 要求返回值通过其中一个验证器的检查 */
+export interface OneOfOptions extends CommonOptions {
+    /** 验证数组各元素 */
+    validators: Validator<unknown, CommonOptions>[];
+}
+export type OneOfValue<Options extends OneOfOptions> = Options extends {
+    validators: Validator<infer T, CommonOptions>[];
+} ? T : never;
+export declare function getOneOfValidator<const Options extends OneOfOptions>(options?: Options): Validator<OneOfValue<Options>, Options>;

package/validators/oneOf.js

@@ -0,0 +1,12 @@
+import { failed } from '../lang/index.js';
+import { getValidatorGenerator, } from './base.js';
+export function getOneOfValidator(options = {}) {
+    return getValidatorGenerator(function validate(field, value) {
+        for (const validator of options.validators) {
+            const result = validator(field, value);
+            if (result.success)
+                return result;
+        }
+        return failed(`${field} do not match any valid format`);
+    })(options);
+}