@serum-enterprises/schema 2.0.1-beta.0

package/tsconfig.json

@@ -0,0 +1,30 @@
+{
+	"compilerOptions": {
+		"target": "ES2024", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+		"module": "Node16", /* Specify what module code is generated. */
+		"lib": ["ES2024"], /* Specify library files to be included in the compilation. */
+		"rootDir": "./src", /* Specify the root folder within your source files. */
+		"outDir": "./build", /* Specify an output folder for all emitted files. */
+		"declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+		"declarationDir": "./types", /* Specify the output directory for generated declaration files. */
+		"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
+		/* Type Checking */
+		"strict": true, /* Enable all strict type-checking options. */
+		"noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+		"strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
+		"strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+		"strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+		"strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
+		"noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
+		"useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
+		"alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
+		"noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
+		"noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
+		"exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
+		"noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
+		"noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
+		"noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
+		"noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
+		"noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
+	}
+}

package/types/Schema.d.ts

@@ -0,0 +1,99 @@
+import * as JSON from '@serum-enterprises/json';
+import { Result } from '@serum-enterprises/result';
+export declare class SchemaError extends Error {
+}
+export declare class ValidationError extends Error {
+}
+export declare abstract class Schema {
+    static get Any(): AnyValidator;
+    static get Boolean(): BooleanValidator;
+    static get Number(): NumberValidator;
+    static get String(): StringValidator;
+    static get Array(): ArrayValidator;
+    static get Object(): ObjectValidator;
+    static get Or(): OrValidator;
+    static get And(): AndValidator;
+    static get defaultRegistry(): Map<string, typeof Schema>;
+    static fromJSON(schema: JSON.JSON, path?: string, registry?: Map<string, typeof Schema>): Result<Schema, SchemaError>;
+    abstract validate(data: unknown, path?: string): Result<void, ValidationError>;
+    abstract toJSON(): JSON.Object;
+}
+declare class AnyValidator extends Schema {
+    static fromJSON(schema: JSON.JSON, path?: string): Result<AnyValidator, SchemaError>;
+    constructor();
+    validate(data: unknown, path?: string): Result<void, ValidationError>;
+    toJSON(): JSON.Object;
+}
+declare class BooleanValidator extends Schema {
+    #private;
+    static fromJSON(schema: JSON.JSON, path?: string): Result<BooleanValidator, SchemaError>;
+    constructor();
+    nullable(flag: boolean): this;
+    equals(value: boolean): this;
+    validate(data: unknown, path?: string): Result<void, ValidationError>;
+    toJSON(): JSON.Object;
+}
+declare class NumberValidator extends Schema {
+    #private;
+    static fromJSON(schema: JSON.JSON, path?: string): Result<NumberValidator, SchemaError>;
+    constructor();
+    nullable(flag: boolean): this;
+    equals(value: number): this;
+    integer(flag?: boolean): this;
+    min(value: number): this;
+    max(value: number): this;
+    validate(data: unknown, path?: string): Result<void, ValidationError>;
+    toJSON(): JSON.Object;
+}
+declare class StringValidator extends Schema {
+    #private;
+    static fromJSON(schema: JSON.JSON, path?: string): Result<StringValidator, SchemaError>;
+    constructor();
+    nullable(flag: boolean): this;
+    equals(value: string): this;
+    min(value: number): this;
+    max(value: number): this;
+    validate(data: unknown, path?: string): Result<void, ValidationError>;
+    toJSON(): JSON.Object;
+}
+declare class ArrayValidator extends Schema {
+    #private;
+    static fromJSON(schema: JSON.JSON, path?: string, registry?: Map<string, typeof Schema>): Result<ArrayValidator, SchemaError>;
+    constructor();
+    nullable(flag?: boolean): this;
+    min(value: number): this;
+    max(value: number): this;
+    every(validator: Schema): this;
+    tuple(validators: Schema[]): this;
+    validate(data: unknown, path?: string): Result<void, ValidationError>;
+    toJSON(): JSON.Object;
+}
+declare class ObjectValidator extends Schema {
+    #private;
+    static fromJSON(schema: JSON.JSON, path?: string, registry?: Map<string, typeof Schema>): Result<ObjectValidator, SchemaError>;
+    constructor();
+    nullable(flag?: boolean): this;
+    inclusive(flag?: boolean): this;
+    schema(value: {
+        [key: string]: Schema;
+    }, flag?: boolean): this;
+    validate(data: unknown, path?: string): Result<void, ValidationError>;
+    toJSON(): JSON.Object;
+}
+declare class OrValidator extends Schema {
+    #private;
+    static fromJSON(schema: JSON.JSON, path?: string, registry?: Map<string, typeof Schema>): Result<OrValidator, SchemaError>;
+    constructor();
+    oneOf(validators: Schema[]): this;
+    validate(data: unknown, path?: string): Result<void, ValidationError>;
+    toJSON(): JSON.Object;
+}
+declare class AndValidator extends Schema {
+    #private;
+    static fromJSON(schema: JSON.JSON, path?: string, registry?: Map<string, typeof Schema>): Result<AndValidator, SchemaError>;
+    constructor();
+    allOf(validators: Schema[]): this;
+    validate(data: unknown, path?: string): Result<void, ValidationError>;
+    toJSON(): JSON.Object;
+}
+export {};