@forklaunch/validator 0.3.0 → 0.3.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 forklaunch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/eslint.config.d.mts

@@ -0,0 +1,3 @@
+declare const _default: any[];
+export default _default;
+//# sourceMappingURL=eslint.config.d.mts.map

package/lib/eslint.config.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eslint.config.d.mts","sourceRoot":"","sources":["../eslint.config.mjs"],"names":[],"mappings":""}

package/lib/eslint.config.mjs

@@ -0,0 +1,10 @@
+import pluginJs from '@eslint/js';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+export default [
+    { files: ['**/*.{ts}'] },
+    { ignores: ['tests/**/*', 'dist/**/*', 'node_modules/**/*'] },
+    { languageOptions: { globals: globals.browser } },
+    pluginJs.configs.recommended,
+    ...tseslint.configs.recommended
+];

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from './src/shared/types/schema.types';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAC"}

package/lib/index.js

@@ -0,0 +1 @@
+export * from './src/shared/types/schema.types';

package/lib/jest.config.d.ts

@@ -0,0 +1,4 @@
+import type { JestConfigWithTsJest } from 'ts-jest';
+declare const jestConfig: JestConfigWithTsJest;
+export default jestConfig;
+//# sourceMappingURL=jest.config.d.ts.map

package/lib/jest.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jest.config.d.ts","sourceRoot":"","sources":["../jest.config.ts"],"names":[],"mappings":"AAoBA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAEpD,QAAA,MAAM,UAAU,EAAE,oBAkBjB,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/lib/jest.config.js

@@ -0,0 +1,21 @@
+// import type { Config } from 'jest';
+const jestConfig = {
+    // [...]
+    preset: 'ts-jest/presets/default-esm', // or other ESM presets
+    moduleNameMapper: {
+        '^(\\.{1,2}/.*)\\.js$': '$1'
+    },
+    transform: {
+        // '^.+\\.[tj]sx?$' to process ts,js,tsx,jsx with `ts-jest`
+        // '^.+\\.m?[tj]sx?$' to process ts,js,tsx,jsx,mts,mjs,mtsx,mjsx with `ts-jest`
+        '^.+\\.[tj]sx?$': [
+            'ts-jest',
+            {
+                useESM: true
+            }
+        ],
+        '^.+\\.js$': 'babel-jest'
+    },
+    testPathIgnorePatterns: ['.*dist/', '.*node_modules/']
+};
+export default jestConfig;

package/{dist → lib/src/shared}/types/schema.types.d.ts

@@ -1,7 +1,18 @@
 import { Prettify } from '@forklaunch/common';
 import { SchemaObject } from 'openapi3-ts/oas31';
-import { TResolve, TSchemaTranslate } from '../typebox/types/typebox.schema.types';
-import { ZodResolve, ZodSchemaTranslate } from '../zod/types/zod.schema.types';
+import { TResolve, TSchemaTranslate } from '../../typebox/types/schema.types';
+import { ZodResolve, ZodSchemaTranslate } from '../../zod/types/schema.types';
+/**
+ * The result associated with an attempted parsing.
+ *
+ */
+export type ParseResult<T> = {
+    ok: true;
+    value: T;
+} | {
+    ok: false;
+    error?: string;
+};
 /**
  * Interface representing a schema validator.
  *
@@ -11,9 +22,10 @@ import { ZodResolve, ZodSchemaTranslate } from '../zod/types/zod.schema.types';
  * @template UnionFunction - The function type for unionizing multiple schemas.
  * @template LiteralFunction - The function type for creating a literal schema.
  * @template ValidationFunction - The function type for validating a value against a schema.
+ * @template ParseFunction - The function type for parsing a value against a schema.
  * @template OpenAPIFunction - The function type for converting a schema into an OpenAPI schema object.
  */
-export interface SchemaValidator<SchematicFunction = <T>(schema: T) => unknown, OptionalFunction = <T>(schema: T) => unknown, ArrayFunction = <T>(schema: T) => unknown, UnionFunction = <T>(schemas: T[]) => unknown, LiteralFunction = <T extends LiteralSchema>(schema: T) => unknown, ValidationFunction = <T>(schema: T, value: unknown) => boolean, OpenAPIFunction = <T>(schema: T) => SchemaObject> {
+export interface SchemaValidator<CompilationFunction = <T>(schema: T) => unknown, SchematicFunction = <T>(schema: T) => unknown, OptionalFunction = <T>(schema: T) => unknown, ArrayFunction = <T>(schema: T) => unknown, UnionFunction = <T>(schemas: T[]) => unknown, LiteralFunction = <T extends LiteralSchema>(schema: T) => unknown, ValidationFunction = <T>(schema: T, value: unknown) => boolean, ParseFunction = <T>(schema: T, value: unknown) => ParseResult<SchemaResolve<T>>, OpenAPIFunction = <T>(schema: T) => SchemaObject> {
     /**
      * The type of the schema validator. Meant to be used with non-null assertions.
      */
@@ -30,6 +42,18 @@ export interface SchemaValidator<SchematicFunction = <T>(schema: T) => unknown,
      * Validator for string type.
      */
     string: unknown;
+    /**
+     * Validator for uuid type.
+     */
+    uuid: unknown;
+    /**
+     * Validator for uri type.
+     */
+    uri: unknown;
+    /**
+     * Validator for email type.
+     */
+    email: unknown;
     /**
      * Validator for number type.
      */
@@ -51,9 +75,9 @@ export interface SchemaValidator<SchematicFunction = <T>(schema: T) => unknown,
      */
     symbol: unknown;
     /**
-     * Validator for empty type.
+     * Validator for nullish type.
      */
-    empty: unknown;
+    nullish: unknown;
     /**
      * Validator for any type.
      */
@@ -66,6 +90,13 @@ export interface SchemaValidator<SchematicFunction = <T>(schema: T) => unknown,
      * Validator for never type.
      */
     never: unknown;
+    /**
+     * Compiles schema if this exists, for optimal performance.
+     *
+     * @param {T} schema - The schema to compile.
+     * @returns {unknown} - The compiled schema.
+     */
+    compile: CompilationFunction;
     /**
      * Converts a valid schema input into a schemified form.
      *
@@ -109,6 +140,14 @@ export interface SchemaValidator<SchematicFunction = <T>(schema: T) => unknown,
      * @returns {boolean} - Whether the value is valid according to the schema.
      */
     validate: ValidationFunction;
+    /**
+     * Parses a value to a schema validation.
+     *
+     * @param {T} schema - The schema to validate against.
+     * @param {unknown} value - The value to validate.
+     * @returns {ParseResult} - The discrimintated parsed value if successful, the error if unsuccessful.
+     */
+    parse: ParseFunction;
     /**
      * Converts a schema into an OpenAPI schema object.
      *
@@ -120,7 +159,7 @@ export interface SchemaValidator<SchematicFunction = <T>(schema: T) => unknown,
 /**
  * Type representing any schema validator.
  */
-export type AnySchemaValidator = SchemaValidator<unknown, unknown, unknown, unknown, unknown, unknown, unknown> & {
+export type AnySchemaValidator = SchemaValidator<unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown> & {
     /**
      * The type of the schema resolver.
      */
@@ -187,7 +226,7 @@ export type LiteralSchema = string | number | boolean;
  *
  * @template SV - The type of the schema validator.
  */
-export type IdiomaticSchema<SV extends AnySchemaValidator> = UnboxedObjectSchema<SV> | LiteralSchema | SV['_SchemaCatchall'];
+export type IdiomaticSchema<SV extends AnySchemaValidator> = LiteralSchema | SV['_SchemaCatchall'] | UnboxedObjectSchema<SV>;
 /**
  * Increments a number type by one, with support up to 50.
  *
@@ -199,3 +238,4 @@ export type Increment<T extends number> = T extends 0 ? 1 : T extends 1 ? 2 : T
  */
 export type KeyTypes = string | number;
 export {};
+//# sourceMappingURL=schema.types.d.ts.map

package/lib/src/shared/types/schema.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.types.d.ts","sourceRoot":"","sources":["../../../../src/shared/types/schema.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAE9E;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IACrB;IACE,EAAE,EAAE,IAAI,CAAC;IACT,KAAK,EAAE,CAAC,CAAC;CACV,GACD;IACE,EAAE,EAAE,KAAK,CAAC;IACV,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEN;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,eAAe,CAC9B,mBAAmB,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,OAAO,EAC/C,iBAAiB,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,OAAO,EAC7C,gBAAgB,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,OAAO,EAC5C,aAAa,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,OAAO,EACzC,aAAa,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,OAAO,EAC5C,eAAe,GAAG,CAAC,CAAC,SAAS,aAAa,EAAE,MAAM,EAAE,CAAC,KAAK,OAAO,EACjE,kBAAkB,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,EAC9D,aAAa,GAAG,CAAC,CAAC,EAChB,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,OAAO,KACX,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAClC,eAAe,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,YAAY;IAEhD;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,GAAG,EAAE,OAAO,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,GAAG,EAAE,OAAO,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;;;;OAKG;IACH,OAAO,EAAE,mBAAmB,CAAC;IAE7B;;;;;OAKG;IACH,QAAQ,EAAE,iBAAiB,CAAC;IAE5B;;;;;OAKG;IACH,QAAQ,EAAE,gBAAgB,CAAC;IAE3B;;;;;OAKG;IACH,KAAK,EAAE,aAAa,CAAC;IAErB;;;;;OAKG;IACH,KAAK,EAAE,aAAa,CAAC;IAErB;;;;;OAKG;IACH,OAAO,EAAE,eAAe,CAAC;IAEzB;;;;;;OAMG;IACH,QAAQ,EAAE,kBAAkB,CAAC;IAE7B;;;;;;OAMG;IACH,KAAK,EAAE,aAAa,CAAC;IAErB;;;;;OAKG;IACH,OAAO,EAAE,eAAe,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,eAAe,CAC9C,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,CACR,GAAG;IACF;;OAEG;IACH,KAAK,EAAE,MAAM,aAAa,CAAC,OAAO,CAAC,CAAC;CACrC,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B;;OAEG;IACH,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC;IAChC;;OAEG;IACH,GAAG,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;CAC9B;AAED;;;;;GAKG;AACH,KAAK,cAAc,CAAC,CAAC,EAAE,EAAE,SAAS,kBAAkB,IAAI,QAAQ,CAC9D,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAChC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,MAAM,CAChB,CAAC,SAAS,EAAE,CAAC,oBAAoB,CAAC,GAAG,eAAe,CAAC,EAAE,CAAC,EACxD,EAAE,SAAS,kBAAkB,IAC3B,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAEtD;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,EAAE,SAAS,kBAAkB,IAAI;IAC/D,CAAC,GAAG,EAAE,QAAQ,GAAG,eAAe,CAAC,EAAE,CAAC,CAAC;CACtC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEtD;;;;GAIG;AACH,MAAM,MAAM,eAAe,CAAC,EAAE,SAAS,kBAAkB,IACrD,aAAa,GACb,EAAE,CAAC,iBAAiB,CAAC,GACrB,mBAAmB,CAAC,EAAE,CAAC,CAAC;AAE5B;;;;GAIG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,CAAC,GACjD,CAAC,GACD,CAAC,SAAS,CAAC,GACT,CAAC,GACD,CAAC,SAAS,CAAC,GACT,CAAC,GACD,CAAC,SAAS,CAAC,GACT,CAAC,GACD,CAAC,SAAS,CAAC,GACT,CAAC,GACD,CAAC,SAAS,CAAC,GACT,CAAC,GACD,CAAC,SAAS,CAAC,GACT,CAAC,GACD,CAAC,SAAS,CAAC,GACT,CAAC,GACD,CAAC,SAAS,CAAC,GACT,CAAC,GACD,CAAC,SAAS,CAAC,GACT,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,SAAS,EAAE,GACV,EAAE,GACF,EAAE,CAAC;AAEzG;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC"}

package/lib/src/typebox/index.d.ts

@@ -0,0 +1,3 @@
+export * from './staticSchemaValidator';
+export type { TypeboxSchemaValidator } from './typeboxSchemaValidator';
+//# sourceMappingURL=index.d.ts.map

package/lib/src/typebox/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/typebox/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,YAAY,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC"}

package/lib/src/typebox/index.js

@@ -0,0 +1 @@
+export * from './staticSchemaValidator';

package/lib/src/typebox/staticSchemaValidator.d.ts

@@ -0,0 +1,93 @@
+import { TypeboxSchemaValidator } from './typeboxSchemaValidator';
+/**
+ * Factory function for creating a TypeboxSchemaValidator instance.
+ * @returns {TypeboxSchemaValidator} The TypeboxSchemaValidator instance.
+ */
+export declare const SchemaValidator: () => TypeboxSchemaValidator;
+declare const StaticSchemaValidator: TypeboxSchemaValidator;
+/**
+ * TypeBox schema definition for string type.
+ */
+export declare const string: typeof StaticSchemaValidator.string;
+/**
+ * TypeBox schema definition for UUID type.
+ */
+export declare const uuid: typeof StaticSchemaValidator.uuid;
+/**
+ * TypeBox schema definition for URI type.
+ */
+export declare const uri: typeof StaticSchemaValidator.uri;
+/**
+ * TypeBox schema definition for email type.
+ */
+export declare const email: typeof StaticSchemaValidator.email;
+/**
+ * TypeBox schema definition for number type.
+ */
+export declare const number: typeof StaticSchemaValidator.number;
+/**
+ * TypeBox schema definition for bigint type.
+ */
+export declare const bigint: typeof StaticSchemaValidator.bigint;
+/**
+ * TypeBox schema definition for boolean type.
+ */
+export declare const boolean: typeof StaticSchemaValidator.boolean;
+/**
+ * TypeBox schema definition for date type.
+ */
+export declare const date: typeof StaticSchemaValidator.date;
+/**
+ * TypeBox schema definition for symbol type.
+ */
+export declare const symbol: typeof StaticSchemaValidator.symbol;
+/**
+ * TypeBox schema definition for undefined, null, void types.
+ */
+export declare const nullish: typeof StaticSchemaValidator.nullish;
+/**
+ * TypeBox schema definition for any type.
+ */
+export declare const any: typeof StaticSchemaValidator.any;
+/**
+ * TypeBox schema definition for unknown type.
+ */
+export declare const unknown: typeof StaticSchemaValidator.unknown;
+/**
+ * TypeBox schema definition for never type.
+ */
+export declare const never: typeof StaticSchemaValidator.never;
+/**
+ * Transforms valid schema into TypeBox schema.
+ */
+export declare const schemify: typeof StaticSchemaValidator.schemify;
+/**
+ * Makes a valid schema optional.
+ */
+export declare const optional: typeof StaticSchemaValidator.optional;
+/**
+ * Defines an array for a valid schema.
+ */
+export declare const array: typeof StaticSchemaValidator.array;
+/**
+ * Defines a union for a valid schema.
+ */
+export declare const union: typeof StaticSchemaValidator.union;
+/**
+ * Defines a literal for a valid schema.
+ */
+export declare const literal: typeof StaticSchemaValidator.literal;
+/**
+ * Validates a value against a valid schema.
+ */
+export declare const validate: typeof StaticSchemaValidator.validate;
+/**
+ * Parses a value against a valid schema.
+ */
+export declare const parse: typeof StaticSchemaValidator.parse;
+/**
+ * Generates an OpenAPI schema object from a valid schema.
+ */
+export declare const openapi: typeof StaticSchemaValidator.openapi;
+export {};
+//# sourceMappingURL=staticSchemaValidator.d.ts.map

package/lib/src/typebox/staticSchemaValidator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"staticSchemaValidator.d.ts","sourceRoot":"","sources":["../../../src/typebox/staticSchemaValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE;;;GAGG;AACH,eAAO,MAAM,eAAe,8BAAqC,CAAC;AAElE,QAAA,MAAM,qBAAqB,wBAAoB,CAAC;AAEhD;;GAEG;AACH,eAAO,MAAM,MAAM,EAAE,OAAO,qBAAqB,CAAC,MACpB,CAAC;AAE/B;;GAEG;AACH,eAAO,MAAM,IAAI,EAAE,OAAO,qBAAqB,CAAC,IACpB,CAAC;AAE7B;;GAEG;AACH,eAAO,MAAM,GAAG,EAAE,OAAO,qBAAqB,CAAC,GAA+B,CAAC;AAE/E;;GAEG;AACH,eAAO,MAAM,KAAK,EAAE,OAAO,qBAAqB,CAAC,KACpB,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,MAAM,EAAE,OAAO,qBAAqB,CAAC,MACpB,CAAC;AAE/B;;GAEG;AACH,eAAO,MAAM,MAAM,EAAE,OAAO,qBAAqB,CAAC,MACpB,CAAC;AAE/B;;GAEG;AACH,eAAO,MAAM,OAAO,EAAE,OAAO,qBAAqB,CAAC,OACpB,CAAC;AAEhC;;GAEG;AACH,eAAO,MAAM,IAAI,EAAE,OAAO,qBAAqB,CAAC,IACpB,CAAC;AAE7B;;GAEG;AACH,eAAO,MAAM,MAAM,EAAE,OAAO,qBAAqB,CAAC,MACpB,CAAC;AAE/B;;GAEG;AACH,eAAO,MAAM,OAAO,EAAE,OAAO,qBAAqB,CAAC,OACpB,CAAC;AAEhC;;GAEG;AACH,eAAO,MAAM,GAAG,EAAE,OAAO,qBAAqB,CAAC,GAA+B,CAAC;AAE/E;;GAEG;AACH,eAAO,MAAM,OAAO,EAAE,OAAO,qBAAqB,CAAC,OACpB,CAAC;AAEhC;;GAEG;AACH,eAAO,MAAM,KAAK,EAAE,OAAO,qBAAqB,CAAC,KACpB,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE,OAAO,qBAAqB,CAAC,QACQ,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE,OAAO,qBAAqB,CAAC,QACQ,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,KAAK,EAAE,OAAO,qBAAqB,CAAC,KACQ,CAAC;AAE1D;;GAEG;AACH,eAAO,MAAM,KAAK,EAAE,OAAO,qBAAqB,CAAC,KACQ,CAAC;AAE1D;;GAEG;AACH,eAAO,MAAM,OAAO,EAAE,OAAO,qBAAqB,CAAC,OACQ,CAAC;AAE5D;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE,OAAO,qBAAqB,CAAC,QACQ,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,KAAK,EAAE,OAAO,qBAAqB,CAAC,KACQ,CAAC;AAE1D;;GAEG;AACH,eAAO,MAAM,OAAO,EAAE,OAAO,qBAAqB,CAAC,OACQ,CAAC"}

package/lib/src/typebox/staticSchemaValidator.js

@@ -0,0 +1,91 @@
+import { TypeboxSchemaValidator } from './typeboxSchemaValidator';
+/**
+ * Factory function for creating a TypeboxSchemaValidator instance.
+ * @returns {TypeboxSchemaValidator} The TypeboxSchemaValidator instance.
+ */
+export const SchemaValidator = () => new TypeboxSchemaValidator();
+const StaticSchemaValidator = SchemaValidator();
+/**
+ * TypeBox schema definition for string type.
+ */
+export const string = StaticSchemaValidator.string;
+/**
+ * TypeBox schema definition for UUID type.
+ */
+export const uuid = StaticSchemaValidator.uuid;
+/**
+ * TypeBox schema definition for URI type.
+ */
+export const uri = StaticSchemaValidator.uri;
+/**
+ * TypeBox schema definition for email type.
+ */
+export const email = StaticSchemaValidator.email;
+/**
+ * TypeBox schema definition for number type.
+ */
+export const number = StaticSchemaValidator.number;
+/**
+ * TypeBox schema definition for bigint type.
+ */
+export const bigint = StaticSchemaValidator.bigint;
+/**
+ * TypeBox schema definition for boolean type.
+ */
+export const boolean = StaticSchemaValidator.boolean;
+/**
+ * TypeBox schema definition for date type.
+ */
+export const date = StaticSchemaValidator.date;
+/**
+ * TypeBox schema definition for symbol type.
+ */
+export const symbol = StaticSchemaValidator.symbol;
+/**
+ * TypeBox schema definition for undefined, null, void types.
+ */
+export const nullish = StaticSchemaValidator.nullish;
+/**
+ * TypeBox schema definition for any type.
+ */
+export const any = StaticSchemaValidator.any;
+/**
+ * TypeBox schema definition for unknown type.
+ */
+export const unknown = StaticSchemaValidator.unknown;
+/**
+ * TypeBox schema definition for never type.
+ */
+export const never = StaticSchemaValidator.never;
+/**
+ * Transforms valid schema into TypeBox schema.
+ */
+export const schemify = StaticSchemaValidator.schemify.bind(StaticSchemaValidator);
+/**
+ * Makes a valid schema optional.
+ */
+export const optional = StaticSchemaValidator.optional.bind(StaticSchemaValidator);
+/**
+ * Defines an array for a valid schema.
+ */
+export const array = StaticSchemaValidator.array.bind(StaticSchemaValidator);
+/**
+ * Defines a union for a valid schema.
+ */
+export const union = StaticSchemaValidator.union.bind(StaticSchemaValidator);
+/**
+ * Defines a literal for a valid schema.
+ */
+export const literal = StaticSchemaValidator.literal.bind(StaticSchemaValidator);
+/**
+ * Validates a value against a valid schema.
+ */
+export const validate = StaticSchemaValidator.validate.bind(StaticSchemaValidator);
+/**
+ * Parses a value against a valid schema.
+ */
+export const parse = StaticSchemaValidator.parse.bind(StaticSchemaValidator);
+/**
+ * Generates an OpenAPI schema object from a valid schema.
+ */
+export const openapi = StaticSchemaValidator.openapi.bind(StaticSchemaValidator);

package/lib/src/typebox/typeboxSchemaValidator.d.ts

@@ -0,0 +1,110 @@
+/**
+ * This module provides a TypeScript-based schema definition using the TypeBox library.
+ * It includes various types, schema creation, validation, and OpenAPI integration.
+ *
+ * @module TypeboxSchemaValidator
+ */
+import { TArray, TKind, TLiteral, TOptional, TProperties, TSchema, TUnion } from '@sinclair/typebox';
+import { TypeCheck } from '@sinclair/typebox/compiler';
+import { SchemaObject } from 'openapi3-ts/oas31';
+import { LiteralSchema, ParseResult, SchemaValidator as SV } from '../shared/types/schema.types';
+import { TIdiomaticSchema, TObject, TResolve, TUnionContainer, UnionTResolve } from './types/schema.types';
+/**
+ * Class representing a TypeBox schema definition.
+ * @implements {SchemaValidator}
+ */
+export declare class TypeboxSchemaValidator implements SV<(<T extends TObject<TProperties>>(schema: T) => TypeCheck<T>), <T extends TIdiomaticSchema>(schema: T) => TResolve<T>, <T extends TIdiomaticSchema>(schema: T) => TOptional<TResolve<T>>, <T extends TIdiomaticSchema>(schema: T) => TArray<TResolve<T>>, <T extends TUnionContainer>(schemas: [...T]) => TUnion<UnionTResolve<T>>, <T extends LiteralSchema>(value: T) => TLiteral<T>, <T extends TIdiomaticSchema>(schema: T, value: unknown) => boolean, <T extends TIdiomaticSchema>(schema: T, value: unknown) => ParseResult<TResolve<T>>, <T extends TIdiomaticSchema>(schema: T) => SchemaObject> {
+    _Type: 'TypeBox';
+    _SchemaCatchall: TKind;
+    _ValidSchemaObject: TObject<TProperties> | TArray<TObject<TProperties>>;
+    string: import("@sinclair/typebox").TString;
+    uuid: import("@sinclair/typebox").TString;
+    uri: import("@sinclair/typebox").TString;
+    email: import("@sinclair/typebox").TString;
+    number: import("@sinclair/typebox").TTransform<TUnion<[import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TString, import("@sinclair/typebox").TBoolean, import("@sinclair/typebox").TNull, import("@sinclair/typebox").TDate, import("@sinclair/typebox").TBigInt]>, number>;
+    bigint: import("@sinclair/typebox").TTransform<TUnion<[import("@sinclair/typebox").TBigInt, import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TString, import("@sinclair/typebox").TBoolean, import("@sinclair/typebox").TDate]>, bigint>;
+    boolean: import("@sinclair/typebox").TTransform<TUnion<[import("@sinclair/typebox").TBoolean, import("@sinclair/typebox").TString]>, boolean | undefined>;
+    date: import("@sinclair/typebox").TTransform<TUnion<[import("@sinclair/typebox").TDate, import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TString, import("@sinclair/typebox").TBoolean, import("@sinclair/typebox").TNull]>, Date>;
+    symbol: import("@sinclair/typebox").TSymbol;
+    nullish: TUnion<[import("@sinclair/typebox").TVoid, import("@sinclair/typebox").TNull, import("@sinclair/typebox").TUndefined]>;
+    any: import("@sinclair/typebox").TAny;
+    unknown: import("@sinclair/typebox").TUnknown;
+    never: import("@sinclair/typebox").TNever;
+    /**
+     * Extracts the error type of a schema for error messages.
+     *
+     * @param {TCatchall} schema - A schema that contains some type information.
+     * @returns The type of the schema for error messages.
+     */
+    private errorType;
+    /**
+     * Pretty print TypeBox errors.
+     *
+     * @param {ValueError[]} errors
+     * @returns
+     */
+    private prettyPrintTypeBoxErrors;
+    /**
+     * Compiles schema if this exists, for optimal performance.
+     *
+     * @param {TObject<TProperties>} schema - The schema to compile.
+     * @returns {TypeCheck<T>} - The compiled schema.
+     */
+    compile<T extends TObject<TProperties>>(schema: T): TypeCheck<T>;
+    /**
+     * Convert a schema to a TypeBox schema.
+     * @param {TIdiomaticSchema} schema - The schema to convert.
+     * @returns {TResolve<T>} The resolved schema.
+     */
+    schemify<T extends TIdiomaticSchema>(schema: T): TResolve<T>;
+    /**
+     * Make a schema optional.
+     * @param {TIdiomaticSchema} schema - The schema to make optional.
+     * @returns {TOptional<TResolve<T>>} The optional schema.
+     */
+    optional<T extends TIdiomaticSchema>(schema: T): TOptional<TResolve<T>>;
+    /**
+     * Create an array schema.
+     * @param {TIdiomaticSchema} schema - The schema to use for array items.
+     * @returns {TArray<TResolve<T>>} The array schema.
+     */
+    array<T extends TIdiomaticSchema>(schema: T): TArray<TResolve<T>>;
+    /**
+     * Create a union schema.
+     * @param {TUnionContainer} schemas - The schemas to union.
+     * @returns {TUnion<UnionTResolve<T>>} The union schema.
+     *
+     * WARNING: If "nullish" or TUndefined is included in the union, the key will still be expected.
+     * This is a limitation of TypeBox. Consider using "optional" instead.
+     */
+    union<T extends TUnionContainer>(schemas: [...T]): TUnion<UnionTResolve<T>>;
+    /**
+     * Create a literal schema.
+     * @param {LiteralSchema} value - The literal value.
+     * @returns {TLiteral<T>} The literal schema.
+     */
+    literal<T extends LiteralSchema>(value: T): TLiteral<T>;
+    /**
+     * Validate a value against a schema.
+     *
+     * @param {TSchema} schema - The schema to validate against.
+     * @param {unknown} value - The value to validate.
+     * @returns {boolean} True if valid, otherwise false.
+     */
+    validate<T extends TIdiomaticSchema | TSchema>(schema: T | TypeCheck<TResolve<T>>, value: unknown): boolean;
+    /**
+     * Parse a value against a schema.
+     *
+     * @param {TSchema} schema - The schema to validate against.
+     * @param {unknown} value - The value to validate.
+     * @returns {ParseResult<TResolve<T>>} The parsing result.
+     */
+    parse<T extends TIdiomaticSchema | TSchema>(schema: T | TypeCheck<TResolve<T>>, value: unknown): ParseResult<TResolve<T>>;
+    /**
+     * Convert a schema to an OpenAPI schema object.
+     * @param {TIdiomaticSchema | TSchema} schema - The schema to convert.
+     * @returns {SchemaObject} The OpenAPI schema object.
+     */
+    openapi<T extends TIdiomaticSchema | TSchema>(schema: T): SchemaObject;
+}
+//# sourceMappingURL=typeboxSchemaValidator.d.ts.map

package/lib/src/typebox/typeboxSchemaValidator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeboxSchemaValidator.d.ts","sourceRoot":"","sources":["../../../src/typebox/typeboxSchemaValidator.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAGL,MAAM,EACN,KAAK,EACL,QAAQ,EACR,SAAS,EACT,WAAW,EACX,OAAO,EACP,MAAM,EAEP,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,SAAS,EAAgB,MAAM,4BAA4B,CAAC;AAOrE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EACL,aAAa,EACb,WAAW,EACX,eAAe,IAAI,EAAE,EACtB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAEL,gBAAgB,EAChB,OAAO,EAEP,QAAQ,EACR,eAAe,EACf,aAAa,EACd,MAAM,sBAAsB,CAAC;AAmB9B;;;GAGG;AACH,qBAAa,sBACX,YACE,EAAE,EACA,CAAC,CAAC,SAAS,OAAO,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAC3D,CAAC,CAAC,SAAS,gBAAgB,EAAE,MAAM,EAAE,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,EACtD,CAAC,CAAC,SAAS,gBAAgB,EAAE,MAAM,EAAE,CAAC,KAAK,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EACjE,CAAC,CAAC,SAAS,gBAAgB,EAAE,MAAM,EAAE,CAAC,KAAK,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAC9D,CAAC,CAAC,SAAS,eAAe,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EACxE,CAAC,CAAC,SAAS,aAAa,EAAE,KAAK,EAAE,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,EAClD,CAAC,CAAC,SAAS,gBAAgB,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,EAClE,CAAC,CAAC,SAAS,gBAAgB,EACzB,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,OAAO,KACX,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAC7B,CAAC,CAAC,SAAS,gBAAgB,EAAE,MAAM,EAAE,CAAC,KAAK,YAAY,CACxD;IAEH,KAAK,EAAG,SAAS,CAAC;IAClB,eAAe,EAAG,KAAK,CAAC;IACxB,kBAAkB,EAAG,OAAO,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;IAEzE,MAAM,sCAAiB;IAEvB,IAAI,sCAID;IACH,GAAG,sCAGA;IACH,KAAK,sCAIF;IACH,MAAM,sRA2BY;IAClB,MAAM,mPAyBY;IAClB,OAAO,mJAsBY;IACnB,IAAI,+OA2BkC;IACtC,MAAM,sCAAiB;IACvB,OAAO,yHAEJ;IACH,GAAG,mCAAc;IACjB,OAAO,uCAAkB;IACzB,KAAK,qCAAgB;IAErB;;;;;OAKG;IACH,OAAO,CAAC,SAAS;IAOjB;;;;;OAKG;IACH,OAAO,CAAC,wBAAwB;IAWhC;;;;;OAKG;IACH,OAAO,CAAC,CAAC,SAAS,OAAO,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IAIhE;;;;OAIG;IACH,QAAQ,CAAC,CAAC,SAAS,gBAAgB,EAAE,MAAM,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC;IA0B5D;;;;OAIG;IACH,QAAQ,CAAC,CAAC,SAAS,gBAAgB,EAAE,MAAM,EAAE,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAOvE;;;;OAIG;IACH,KAAK,CAAC,CAAC,SAAS,gBAAgB,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IASjE;;;;;;;OAOG;IACH,KAAK,CAAC,CAAC,SAAS,eAAe,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAa3E;;;;OAIG;IACH,OAAO,CAAC,CAAC,SAAS,aAAa,EAAE,KAAK,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC;IAMvD;;;;;;OAMG;IACH,QAAQ,CAAC,CAAC,SAAS,gBAAgB,GAAG,OAAO,EAC3C,MAAM,EAAE,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAClC,KAAK,EAAE,OAAO,GACb,OAAO;IAWV;;;;;;OAMG;IACH,KAAK,CAAC,CAAC,SAAS,gBAAgB,GAAG,OAAO,EACxC,MAAM,EAAE,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAClC,KAAK,EAAE,OAAO,GACb,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAgC3B;;;;OAIG;IACH,OAAO,CAAC,CAAC,SAAS,gBAAgB,GAAG,OAAO,EAAE,MAAM,EAAE,CAAC,GAAG,YAAY;CA0BvE"}