@local901/validator 0.0.4 → 0.0.5

package/README.md

@@ -1,6 +1,6 @@
 # js-validator
 
-Validator for javascript and typescript. Do you have an object with uncertain contents. USe a validator to make sure what you have.
+Validator for javascript and typescript. Do you have an object with uncertain contents. Use a validator to make sure what you have.
 
 Quick start:
 ```shell

package/errors/ValidationError.d.ts

@@ -1,5 +1,5 @@
 import type { ErrorValue } from "./ErrorType";
-export type ErrorFields<T> = (T extends object ? {
+export type ErrorFields<T> = (T extends object ? T extends ReadonlyArray<infer ITEM> ? Record<number, ValidationError<ITEM> | undefined> : {
     [K in keyof T]: ValidationError<T[K]> | undefined;
 } : never) | Record<number, ValidationError<T>>;
 export declare class ValidationError<T extends unknown = unknown> extends Error {

package/errors/ValidationError.js.map

@@ -1 +1 @@
-{"version":3,"file":"ValidationError.js","sourceRoot":"","sources":["../../src/errors/ValidationError.ts"],"names":[],"mappings":";;;AAMA,MAAa,eAEX,SAAQ,KAAK;IACK,IAAI,CAAS;IACb,KAAK,CAAa;IAClB,MAAM,CAAiB;IAEvC,YAAmB,IAAY,EAAE,KAAiB,EAAE,OAAe,EAAE,MAAuB;QACxF,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;CACJ;AAbD,0CAaC"}
+{"version":3,"file":"ValidationError.js","sourceRoot":"","sources":["../../src/errors/ValidationError.ts"],"names":[],"mappings":";;;AAQA,MAAa,eAEX,SAAQ,KAAK;IACK,IAAI,CAAS;IACb,KAAK,CAAa;IAClB,MAAM,CAAiB;IAEvC,YAAmB,IAAY,EAAE,KAAiB,EAAE,OAAe,EAAE,MAAuB;QACxF,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;CACJ;AAbD,0CAaC"}

package/index.d.ts

@@ -6,14 +6,21 @@ import { OptionalValidator } from "./types/util/OptionalValidator";
 import { stringValidator, type StringValidationOptions } from "./types/string/StringValidator";
 import { Validator } from "./Validator";
 import { AnyValidator } from "./types/util/AnyValidator";
-import { AnyOfValidator, type AnyOfValidators } from "./types/util/AnyOfValidator";
-export declare namespace v {
-    const boolean: () => BooleanValidator;
-    const int: (options?: IntValidationOptions) => IntValidator;
-    const number: (options?: NumberValidationOptions) => NumberValidator;
-    const object: <T extends object>(fields: FieldValidators<T>) => ObjectValidator<T>;
-    const string: (options?: StringValidationOptions) => stringValidator;
-    const anyOf: <T>(validators: AnyOfValidators<T>) => AnyOfValidator<T>;
-    const any: <T>() => AnyValidator<T>;
-    const optional: <T>(val: Validator<Exclude<T, undefined | null>>) => OptionalValidator<T>;
+import { OrValidator, type OrValidators } from "./types/util/OrValidator";
+import { ArrayValidator } from "./types/object/ArrayValidator";
+import { EnumValidator, type EnumLike } from "./types/object/EnumValidator";
+export { Validator } from "./Validator";
+export { ErrorType, type ErrorValue } from "./errors/ErrorType";
+export { ValidationError, type ErrorFields } from "./errors/ValidationError";
+export declare class v {
+    static boolean: () => BooleanValidator;
+    static int: (options?: IntValidationOptions) => IntValidator;
+    static number: (options?: NumberValidationOptions) => NumberValidator;
+    static array: <T>(item: Validator<T>) => ArrayValidator<T>;
+    static enum: <T extends EnumLike>(enumInstance: T) => EnumValidator<T>;
+    static object: <T extends object>(fields: FieldValidators<T>) => ObjectValidator<T>;
+    static string: (options?: StringValidationOptions) => stringValidator;
+    static any: <T>() => AnyValidator<T>;
+    static optional: <T>(val: Validator<Exclude<T, undefined | null>>) => OptionalValidator<T>;
+    static or: <T>(validators: OrValidators<T>) => OrValidator<T>;
 }

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.v = void 0;
+exports.v = exports.ValidationError = exports.ErrorType = exports.Validator = void 0;
 const BooleanValidator_1 = require("./types/bool/BooleanValidator");
 const IntValidator_1 = require("./types/number/IntValidator");
 const NumberValidator_1 = require("./types/number/NumberValidator");
@@ -8,16 +8,26 @@ const ObjectValidator_1 = require("./types/object/ObjectValidator");
 const OptionalValidator_1 = require("./types/util/OptionalValidator");
 const StringValidator_1 = require("./types/string/StringValidator");
 const AnyValidator_1 = require("./types/util/AnyValidator");
-const AnyOfValidator_1 = require("./types/util/AnyOfValidator");
-var v;
-(function (v) {
-    v.boolean = () => new BooleanValidator_1.BooleanValidator();
-    v.int = (options) => new IntValidator_1.IntValidator(options);
-    v.number = (options) => new NumberValidator_1.NumberValidator(options);
-    v.object = (fields) => new ObjectValidator_1.ObjectValidator(fields);
-    v.string = (options) => new StringValidator_1.stringValidator(options);
-    v.anyOf = (validators) => new AnyOfValidator_1.AnyOfValidator(validators);
-    v.any = () => new AnyValidator_1.AnyValidator();
-    v.optional = (val) => new OptionalValidator_1.OptionalValidator(val);
-})(v || (exports.v = v = {}));
+const OrValidator_1 = require("./types/util/OrValidator");
+const ArrayValidator_1 = require("./types/object/ArrayValidator");
+const EnumValidator_1 = require("./types/object/EnumValidator");
+var Validator_1 = require("./Validator");
+Object.defineProperty(exports, "Validator", { enumerable: true, get: function () { return Validator_1.Validator; } });
+var ErrorType_1 = require("./errors/ErrorType");
+Object.defineProperty(exports, "ErrorType", { enumerable: true, get: function () { return ErrorType_1.ErrorType; } });
+var ValidationError_1 = require("./errors/ValidationError");
+Object.defineProperty(exports, "ValidationError", { enumerable: true, get: function () { return ValidationError_1.ValidationError; } });
+class v {
+    static boolean = () => new BooleanValidator_1.BooleanValidator();
+    static int = (options) => new IntValidator_1.IntValidator(options);
+    static number = (options) => new NumberValidator_1.NumberValidator(options);
+    static array = (item) => new ArrayValidator_1.ArrayValidator(item);
+    static enum = (enumInstance) => new EnumValidator_1.EnumValidator(enumInstance);
+    static object = (fields) => new ObjectValidator_1.ObjectValidator(fields);
+    static string = (options) => new StringValidator_1.stringValidator(options);
+    static any = () => new AnyValidator_1.AnyValidator();
+    static optional = (val) => new OptionalValidator_1.OptionalValidator(val);
+    static or = (validators) => new OrValidator_1.OrValidator(validators);
+}
+exports.v = v;
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,oEAAiE;AACjE,8DAAsF;AACtF,oEAA+F;AAC/F,oEAAuF;AACvF,sEAAmE;AACnE,oEAA+F;AAE/F,4DAAyD;AACzD,gEAAmF;AAEnF,IAAiB,CAAC,CAajB;AAbD,WAAiB,CAAC;IACD,SAAO,GAAG,GAAG,EAAE,CAAC,IAAI,mCAAgB,EAAE,CAAC;IAEvC,KAAG,GAAG,CAAC,OAA8B,EAAE,EAAE,CAAC,IAAI,2BAAY,CAAC,OAAO,CAAC,CAAC;IACpE,QAAM,GAAG,CAAC,OAAiC,EAAE,EAAE,CAAC,IAAI,iCAAe,CAAC,OAAO,CAAC,CAAC;IAE7E,QAAM,GAAG,CAAmB,MAA0B,EAAE,EAAE,CAAC,IAAI,iCAAe,CAAC,MAAM,CAAC,CAAC;IAEvF,QAAM,GAAG,CAAC,OAAiC,EAAE,EAAE,CAAC,IAAI,iCAAe,CAAC,OAAO,CAAC,CAAC;IAE7E,OAAK,GAAG,CAAI,UAA8B,EAAE,EAAE,CAAC,IAAI,+BAAc,CAAC,UAAU,CAAC,CAAC;IAC9E,KAAG,GAAG,GAAM,EAAE,CAAC,IAAI,2BAAY,EAAK,CAAC;IACrC,UAAQ,GAAG,CAAI,GAA4C,EAAE,EAAE,CAAC,IAAI,qCAAiB,CAAC,GAAG,CAAC,CAAC;AAC5G,CAAC,EAbgB,CAAC,iBAAD,CAAC,QAajB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,oEAAiE;AACjE,8DAAsF;AACtF,oEAA+F;AAC/F,oEAAuF;AACvF,sEAAmE;AACnE,oEAA+F;AAE/F,4DAAyD;AACzD,0DAA0E;AAC1E,kEAA+D;AAC/D,gEAA4E;AAE5E,yCAAwC;AAA/B,sGAAA,SAAS,OAAA;AAClB,gDAAgE;AAAvD,sGAAA,SAAS,OAAA;AAClB,4DAA6E;AAApE,kHAAA,eAAe,OAAA;AAExB,MAAa,CAAC;IACH,MAAM,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,mCAAgB,EAAE,CAAC;IAE9C,MAAM,CAAC,GAAG,GAAG,CAAC,OAA8B,EAAE,EAAE,CAAC,IAAI,2BAAY,CAAC,OAAO,CAAC,CAAC;IAC3E,MAAM,CAAC,MAAM,GAAG,CAAC,OAAiC,EAAE,EAAE,CAAC,IAAI,iCAAe,CAAC,OAAO,CAAC,CAAC;IAEpF,MAAM,CAAC,KAAK,GAAG,CAAI,IAAkB,EAAE,EAAE,CAAC,IAAI,+BAAc,CAAC,IAAI,CAAC,CAAC;IACnE,MAAM,CAAC,IAAI,GAAG,CAAqB,YAAe,EAAE,EAAE,CAAC,IAAI,6BAAa,CAAC,YAAY,CAAC,CAAC;IACvF,MAAM,CAAC,MAAM,GAAG,CAAmB,MAA0B,EAAE,EAAE,CAAC,IAAI,iCAAe,CAAC,MAAM,CAAC,CAAC;IAE9F,MAAM,CAAC,MAAM,GAAG,CAAC,OAAiC,EAAE,EAAE,CAAC,IAAI,iCAAe,CAAC,OAAO,CAAC,CAAC;IAEpF,MAAM,CAAC,GAAG,GAAG,GAAM,EAAE,CAAC,IAAI,2BAAY,EAAK,CAAC;IAC5C,MAAM,CAAC,QAAQ,GAAG,CAAI,GAA4C,EAAE,EAAE,CAAC,IAAI,qCAAiB,CAAC,GAAG,CAAC,CAAC;IAClG,MAAM,CAAC,EAAE,GAAG,CAAI,UAA2B,EAAE,EAAE,CAAC,IAAI,yBAAW,CAAC,UAAU,CAAC,CAAC;;AAdvF,cAeC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@local901/validator",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Type validator for javascript and typescript",
   "main": "index.js",
   "scripts": {

package/types/object/ArrayValidator.d.ts

@@ -0,0 +1,9 @@
+import type { ValidationError } from "../../errors/ValidationError";
+import { Validator } from "../../Validator";
+export declare class ArrayValidator<T> extends Validator<T[]> {
+    readonly item: Validator<T>;
+    type: string;
+    constructor(item: Validator<T>);
+    /** @inheritdoc */
+    validateReturn(input: unknown): ValidationError<T[]> | null;
+}

package/types/object/ArrayValidator.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArrayValidator = void 0;
+const ErrorType_1 = require("../../errors/ErrorType");
+const Validator_1 = require("../../Validator");
+class ArrayValidator extends Validator_1.Validator {
+    item;
+    type = "array";
+    constructor(item) {
+        super();
+        this.item = item;
+    }
+    /** @inheritdoc */
+    validateReturn(input) {
+        // Check type
+        if (typeof input !== "object" || input === null || !Array.isArray(input)) {
+            return this.createError(ErrorType_1.ErrorType.INCORRECT_TYPE, "Has to be an object.");
+        }
+        // Check item type
+        let hasError = false;
+        const fields = Object.fromEntries(input.entries().map(([key, item]) => {
+            const result = this.item.validateReturn(item);
+            if (result !== null) {
+                hasError = true;
+            }
+            return [key, result ?? undefined];
+        }));
+        if (hasError) {
+            return this.createError(ErrorType_1.ErrorType.INCORRECT_TYPE, "One or More items are incorrect.", fields);
+        }
+        return null;
+    }
+}
+exports.ArrayValidator = ArrayValidator;
+//# sourceMappingURL=ArrayValidator.js.map

package/types/object/ArrayValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArrayValidator.js","sourceRoot":"","sources":["../../../src/types/object/ArrayValidator.ts"],"names":[],"mappings":";;;AAAA,sDAAmD;AAEnD,+CAA4C;AAE5C,MAAa,cAAkB,SAAQ,qBAAc;IAGd;IAFnB,IAAI,GAAG,OAAO,CAAC;IAE/B,YAAmC,IAAkB;QACjD,KAAK,EAAE,CAAC;QADuB,SAAI,GAAJ,IAAI,CAAc;IAErD,CAAC;IAED,kBAAkB;IACF,cAAc,CAAC,KAAc;QACzC,aAAa;QACb,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACvE,OAAO,IAAI,CAAC,WAAW,CAAC,qBAAS,CAAC,cAAc,EAAE,sBAAsB,CAAC,CAAC;QAC9E,CAAC;QAED,kBAAkB;QAClB,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE;YAClE,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YAC9C,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;gBAClB,QAAQ,GAAG,IAAI,CAAC;YACpB,CAAC;YACD,OAAO,CAAC,GAAG,EAAE,MAAM,IAAI,SAAS,CAAC,CAAC;QACtC,CAAC,CAAC,CAAqB,CAAC;QACxB,IAAI,QAAQ,EAAE,CAAC;YACX,OAAO,IAAI,CAAC,WAAW,CAAC,qBAAS,CAAC,cAAc,EAAE,kCAAkC,EAAE,MAAM,CAAC,CAAC;QAClG,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AA7BD,wCA6BC"}

package/types/object/EnumValidator.d.ts

@@ -0,0 +1,11 @@
+import type { ValidationError } from "../../errors/ValidationError";
+import { Validator } from "../../Validator";
+export type EnumValue = string | number;
+export type EnumLike = Readonly<Record<string, EnumValue>>;
+export declare class EnumValidator<T extends EnumLike | unknown[]> extends Validator<T[keyof T]> {
+    type: string;
+    private readonly enumValues;
+    constructor(enumInstance: T);
+    /** @inheritdoc */
+    validateReturn(input: unknown): ValidationError<T[keyof T]> | null;
+}

package/types/object/EnumValidator.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnumValidator = void 0;
+const ErrorType_1 = require("../../errors/ErrorType");
+const Validator_1 = require("../../Validator");
+class EnumValidator extends Validator_1.Validator {
+    type = "enum";
+    enumValues;
+    constructor(enumInstance) {
+        super();
+        this.enumValues = Object.values(enumInstance);
+    }
+    /** @inheritdoc */
+    validateReturn(input) {
+        // Check type
+        if (!this.enumValues.includes(input)) {
+            return this.createError(ErrorType_1.ErrorType.INCORRECT_TYPE, "Has to be an object.");
+        }
+        return null;
+    }
+}
+exports.EnumValidator = EnumValidator;
+//# sourceMappingURL=EnumValidator.js.map

package/types/object/EnumValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnumValidator.js","sourceRoot":"","sources":["../../../src/types/object/EnumValidator.ts"],"names":[],"mappings":";;;AAAA,sDAAmD;AAEnD,+CAA4C;AAK5C,MAAa,aAA8C,SAAQ,qBAAqB;IACpE,IAAI,GAAG,MAAM,CAAC;IACb,UAAU,CAAY;IAEvC,YAAmB,YAAe;QAC9B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAClD,CAAC;IAED,kBAAkB;IACF,cAAc,CAAC,KAAc;QACzC,aAAa;QACb,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC,WAAW,CAAC,qBAAS,CAAC,cAAc,EAAE,sBAAsB,CAAC,CAAC;QAC9E,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAlBD,sCAkBC"}

package/types/util/OrValidator.d.ts

@@ -0,0 +1,9 @@
+import type { ValidationError } from "../../errors/ValidationError";
+import { Validator } from "../../Validator";
+export type OrValidators<T> = ReadonlyArray<T extends unknown ? Validator<T> : never>;
+export declare class OrValidator<T> extends Validator<T> {
+    readonly validators: OrValidators<T>;
+    type: string;
+    constructor(validators: OrValidators<T>);
+    validateReturn(input: unknown): ValidationError<T> | null;
+}

package/types/util/{AnyOfValidator.js → OrValidator.js}

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AnyOfValidator = void 0;
+exports.OrValidator = void 0;
 const ErrorType_1 = require("../../errors/ErrorType");
 const Validator_1 = require("../../Validator");
-class AnyOfValidator extends Validator_1.Validator {
+class OrValidator extends Validator_1.Validator {
     validators;
     type = "anyof";
     constructor(validators) {
@@ -23,5 +23,5 @@ class AnyOfValidator extends Validator_1.Validator {
         return this.createError(ErrorType_1.ErrorType.INCORRECT_TYPE, "Has to match at least one of the types.", errors);
     }
 }
-exports.AnyOfValidator = AnyOfValidator;
-//# sourceMappingURL=AnyOfValidator.js.map
+exports.OrValidator = OrValidator;
+//# sourceMappingURL=OrValidator.js.map

package/types/util/OrValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OrValidator.js","sourceRoot":"","sources":["../../../src/types/util/OrValidator.ts"],"names":[],"mappings":";;;AAAA,sDAAmD;AAEnD,+CAA4C;AAI5C,MAAa,WAAe,SAAQ,qBAAY;IAGT;IAFnB,IAAI,GAAG,OAAO,CAAC;IAE/B,YAAmC,UAA2B;QAC1D,KAAK,EAAE,CAAC;QADuB,eAAU,GAAV,UAAU,CAAiB;IAE9D,CAAC;IAEe,cAAc,CAAC,KAAc;QACzC,MAAM,MAAM,GAAuC,EAAE,CAAC;QACtD,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACtC,MAAM,MAAM,GAAG,SAAS,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAC/C,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;gBAClB,OAAO,IAAI,CAAC;YAChB,CAAC;YACD,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC;QACzB,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,qBAAS,CAAC,cAAc,EAAE,yCAAyC,EAAE,MAAM,CAAC,CAAC;IACzG,CAAC;CAEJ;AApBD,kCAoBC"}

package/types/util/AnyOfValidator.d.ts

@@ -1,9 +0,0 @@
-import type { ValidationError } from "../../errors/ValidationError";
-import { Validator } from "../../Validator";
-export type AnyOfValidators<T> = ReadonlyArray<T extends unknown ? Validator<T> : never>;
-export declare class AnyOfValidator<T> extends Validator<T> {
-    readonly validators: AnyOfValidators<T>;
-    type: string;
-    constructor(validators: AnyOfValidators<T>);
-    validateReturn(input: unknown): ValidationError<T> | null;
-}

package/types/util/AnyOfValidator.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"AnyOfValidator.js","sourceRoot":"","sources":["../../../src/types/util/AnyOfValidator.ts"],"names":[],"mappings":";;;AAAA,sDAAmD;AAEnD,+CAA4C;AAI5C,MAAa,cAAkB,SAAQ,qBAAY;IAGZ;IAFnB,IAAI,GAAG,OAAO,CAAC;IAE/B,YAAmC,UAA8B;QAC7D,KAAK,EAAE,CAAC;QADuB,eAAU,GAAV,UAAU,CAAoB;IAEjE,CAAC;IAEe,cAAc,CAAC,KAAc;QACzC,MAAM,MAAM,GAAuC,EAAE,CAAC;QACtD,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACtC,MAAM,MAAM,GAAG,SAAS,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAC/C,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;gBAClB,OAAO,IAAI,CAAC;YAChB,CAAC;YACD,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC;QACzB,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,qBAAS,CAAC,cAAc,EAAE,yCAAyC,EAAE,MAAM,CAAC,CAAC;IACzG,CAAC;CAEJ;AApBD,wCAoBC"}