@forklaunch/validator 0.5.4 → 0.6.0

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

@@ -1,9 +1,9 @@
 import * as openapi3_ts_oas31 from 'openapi3-ts/oas31';
 import * as _sinclair_typebox_compiler from '@sinclair/typebox/compiler';
-import { T as TypeboxSchemaValidator, f as TIdiomaticSchema, g as TResolve, h as TUnionTupleContainer, i as UnionTupleTResolve, L as LiteralSchema, j as TCatchall, a as ParseResult } from '../../schema.types-DyZIpu-x.mjs';
-export { m as TObject, l as TObjectShape, k as TOuterArray, n as TSchemaTranslate, o as UnboxedTObjectSchema } from '../../schema.types-DyZIpu-x.mjs';
+import { T as TypeboxSchemaValidator, f as TIdiomaticSchema, g as TResolve, h as TUnionTupleContainer, i as UnionTupleTResolve, L as LiteralSchema, j as TCatchall, a as ParseResult, k as TSchemaTranslate } from '../../schema.types-MvSNOCj2.mjs';
+export { n as TObject, m as TObjectShape, l as TOuterArray, o as UnboxedTObjectSchema } from '../../schema.types-MvSNOCj2.mjs';
+import * as _forklaunch_common from '@forklaunch/common';
 import * as _sinclair_typebox from '@sinclair/typebox';
-import '@forklaunch/common';
 import 'zod';
 
 /**
@@ -30,7 +30,7 @@ declare const email: _sinclair_typebox.TString;
 /**
  * TypeBox schema definition for number type.
  */
-declare const number: _sinclair_typebox.TTransform<_sinclair_typebox.TUnion<[_sinclair_typebox.TNumber, _sinclair_typebox.TString, _sinclair_typebox.TBoolean, _sinclair_typebox.TNull, _sinclair_typebox.TDate, _sinclair_typebox.TBigInt]>, number>;
+declare const number: _sinclair_typebox.TTransform<_sinclair_typebox.TUnion<[_sinclair_typebox.TNumber, _sinclair_typebox.TString, _sinclair_typebox.TBoolean, _sinclair_typebox.TNull, _sinclair_typebox.TBigInt, _sinclair_typebox.TDate]>, number>;
 /**
  * TypeBox schema definition for bigint type.
  */
@@ -42,7 +42,7 @@ declare const boolean: _sinclair_typebox.TTransform<_sinclair_typebox.TUnion<[_s
 /**
  * TypeBox schema definition for date type.
  */
-declare const date: _sinclair_typebox.TTransform<_sinclair_typebox.TUnion<[_sinclair_typebox.TDate, _sinclair_typebox.TNumber, _sinclair_typebox.TString, _sinclair_typebox.TBoolean, _sinclair_typebox.TNull]>, Date>;
+declare const date: _sinclair_typebox.TTransform<_sinclair_typebox.TUnion<[_sinclair_typebox.TString, _sinclair_typebox.TNumber, _sinclair_typebox.TDate]>, Date>;
 /**
  * TypeBox schema definition for symbol type.
  */
@@ -75,6 +75,14 @@ declare const unknown: _sinclair_typebox.TUnknown;
  * TypeBox schema definition for never type.
  */
 declare const never: _sinclair_typebox.TNever;
+/**
+ * TypeBox schema definition for blob type.
+ */
+declare const binary: _sinclair_typebox.TTransform<_sinclair_typebox.TString, Buffer<ArrayBuffer>>;
+/**
+ * TypeBox schema definition for file type.
+ */
+declare const file: (name: string, type: _forklaunch_common.MimeType) => _sinclair_typebox.TTransform<_sinclair_typebox.TString, File>;
 /**
  * Transforms valid schema into TypeBox schema.
  */
@@ -122,10 +130,10 @@ declare const validate: <T extends TIdiomaticSchema | TCatchall>(schema: T | _si
 /**
  * Parses a value against a valid schema.
  */
-declare const parse: <T extends TIdiomaticSchema | TCatchall>(schema: T | _sinclair_typebox_compiler.TypeCheck<TResolve<T>>, value: unknown) => ParseResult<TResolve<T>>;
+declare const parse: <T extends TIdiomaticSchema | TCatchall>(schema: T | _sinclair_typebox_compiler.TypeCheck<TResolve<T>>, value: unknown) => ParseResult<TSchemaTranslate<TResolve<T>>>;
 /**
  * Generates an OpenAPI schema object from a valid schema.
  */
 declare const openapi: <T extends TIdiomaticSchema | TCatchall>(schema: T) => openapi3_ts_oas31.SchemaObject;
 
-export { SchemaValidator, TCatchall, TIdiomaticSchema, TResolve, TUnionTupleContainer, TypeboxSchemaValidator, UnionTupleTResolve, any, array, bigint, boolean, date, email, enum_, function_, isSchema, literal, never, null_, nullish, number, openapi, optional, parse, promise, record, schemify, string, symbol, undefined_, union, unknown, uri, uuid, validate, void_ };
+export { SchemaValidator, TCatchall, TIdiomaticSchema, TResolve, TSchemaTranslate, TUnionTupleContainer, TypeboxSchemaValidator, UnionTupleTResolve, any, array, bigint, binary, boolean, date, email, enum_, file, function_, isSchema, literal, never, null_, nullish, number, openapi, optional, parse, promise, record, schemify, string, symbol, undefined_, union, unknown, uri, uuid, validate, void_ };

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

@@ -1,9 +1,9 @@
 import * as openapi3_ts_oas31 from 'openapi3-ts/oas31';
 import * as _sinclair_typebox_compiler from '@sinclair/typebox/compiler';
-import { T as TypeboxSchemaValidator, f as TIdiomaticSchema, g as TResolve, h as TUnionTupleContainer, i as UnionTupleTResolve, L as LiteralSchema, j as TCatchall, a as ParseResult } from '../../schema.types-DyZIpu-x.js';
-export { m as TObject, l as TObjectShape, k as TOuterArray, n as TSchemaTranslate, o as UnboxedTObjectSchema } from '../../schema.types-DyZIpu-x.js';
+import { T as TypeboxSchemaValidator, f as TIdiomaticSchema, g as TResolve, h as TUnionTupleContainer, i as UnionTupleTResolve, L as LiteralSchema, j as TCatchall, a as ParseResult, k as TSchemaTranslate } from '../../schema.types-MvSNOCj2.js';
+export { n as TObject, m as TObjectShape, l as TOuterArray, o as UnboxedTObjectSchema } from '../../schema.types-MvSNOCj2.js';
+import * as _forklaunch_common from '@forklaunch/common';
 import * as _sinclair_typebox from '@sinclair/typebox';
-import '@forklaunch/common';
 import 'zod';
 
 /**
@@ -30,7 +30,7 @@ declare const email: _sinclair_typebox.TString;
 /**
  * TypeBox schema definition for number type.
  */
-declare const number: _sinclair_typebox.TTransform<_sinclair_typebox.TUnion<[_sinclair_typebox.TNumber, _sinclair_typebox.TString, _sinclair_typebox.TBoolean, _sinclair_typebox.TNull, _sinclair_typebox.TDate, _sinclair_typebox.TBigInt]>, number>;
+declare const number: _sinclair_typebox.TTransform<_sinclair_typebox.TUnion<[_sinclair_typebox.TNumber, _sinclair_typebox.TString, _sinclair_typebox.TBoolean, _sinclair_typebox.TNull, _sinclair_typebox.TBigInt, _sinclair_typebox.TDate]>, number>;
 /**
  * TypeBox schema definition for bigint type.
  */
@@ -42,7 +42,7 @@ declare const boolean: _sinclair_typebox.TTransform<_sinclair_typebox.TUnion<[_s
 /**
  * TypeBox schema definition for date type.
  */
-declare const date: _sinclair_typebox.TTransform<_sinclair_typebox.TUnion<[_sinclair_typebox.TDate, _sinclair_typebox.TNumber, _sinclair_typebox.TString, _sinclair_typebox.TBoolean, _sinclair_typebox.TNull]>, Date>;
+declare const date: _sinclair_typebox.TTransform<_sinclair_typebox.TUnion<[_sinclair_typebox.TString, _sinclair_typebox.TNumber, _sinclair_typebox.TDate]>, Date>;
 /**
  * TypeBox schema definition for symbol type.
  */
@@ -75,6 +75,14 @@ declare const unknown: _sinclair_typebox.TUnknown;
  * TypeBox schema definition for never type.
  */
 declare const never: _sinclair_typebox.TNever;
+/**
+ * TypeBox schema definition for blob type.
+ */
+declare const binary: _sinclair_typebox.TTransform<_sinclair_typebox.TString, Buffer<ArrayBuffer>>;
+/**
+ * TypeBox schema definition for file type.
+ */
+declare const file: (name: string, type: _forklaunch_common.MimeType) => _sinclair_typebox.TTransform<_sinclair_typebox.TString, File>;
 /**
  * Transforms valid schema into TypeBox schema.
  */
@@ -122,10 +130,10 @@ declare const validate: <T extends TIdiomaticSchema | TCatchall>(schema: T | _si
 /**
  * Parses a value against a valid schema.
  */
-declare const parse: <T extends TIdiomaticSchema | TCatchall>(schema: T | _sinclair_typebox_compiler.TypeCheck<TResolve<T>>, value: unknown) => ParseResult<TResolve<T>>;
+declare const parse: <T extends TIdiomaticSchema | TCatchall>(schema: T | _sinclair_typebox_compiler.TypeCheck<TResolve<T>>, value: unknown) => ParseResult<TSchemaTranslate<TResolve<T>>>;
 /**
  * Generates an OpenAPI schema object from a valid schema.
  */
 declare const openapi: <T extends TIdiomaticSchema | TCatchall>(schema: T) => openapi3_ts_oas31.SchemaObject;
 
-export { SchemaValidator, TCatchall, TIdiomaticSchema, TResolve, TUnionTupleContainer, TypeboxSchemaValidator, UnionTupleTResolve, any, array, bigint, boolean, date, email, enum_, function_, isSchema, literal, never, null_, nullish, number, openapi, optional, parse, promise, record, schemify, string, symbol, undefined_, union, unknown, uri, uuid, validate, void_ };
+export { SchemaValidator, TCatchall, TIdiomaticSchema, TResolve, TSchemaTranslate, TUnionTupleContainer, TypeboxSchemaValidator, UnionTupleTResolve, any, array, bigint, binary, boolean, date, email, enum_, file, function_, isSchema, literal, never, null_, nullish, number, openapi, optional, parse, promise, record, schemify, string, symbol, undefined_, union, unknown, uri, uuid, validate, void_ };

package/lib/src/typebox/index.js

@@ -24,10 +24,12 @@ __export(typebox_exports, {
   any: () => any,
   array: () => array,
   bigint: () => bigint,
+  binary: () => binary,
   boolean: () => boolean,
   date: () => date,
   email: () => email,
   enum_: () => enum_,
+  file: () => file,
   function_: () => function_,
   isSchema: () => isSchema,
   literal: () => literal,
@@ -54,10 +56,12 @@ __export(typebox_exports, {
 module.exports = __toCommonJS(typebox_exports);
 
 // src/typebox/typeboxSchemaValidator.ts
+var import_common = require("@forklaunch/common");
 var import_typebox = require("@sinclair/typebox");
 var import_compiler = require("@sinclair/typebox/compiler");
 var import_errors = require("@sinclair/typebox/errors");
 var import_value = require("@sinclair/typebox/value");
+import_typebox.FormatRegistry.Set("binary", (value) => typeof value === "string");
 (0, import_errors.SetErrorFunction)((params) => {
   switch (params.errorType) {
     case import_errors.ValueErrorType.Union:
@@ -73,18 +77,27 @@ var TypeboxSchemaValidator = class {
   _Type = "TypeBox";
   _SchemaCatchall;
   _ValidSchemaObject;
-  string = import_typebox.Type.String();
+  string = import_typebox.Type.String({
+    example: "a string",
+    title: "String"
+  });
   uuid = import_typebox.Type.String({
     pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
-    errorType: "uuid"
-  });
-  uri = import_typebox.Type.String({
-    pattern: "^[a-zA-Z][a-zA-Z\\d+-.]*:[^\\s]*$",
-    errorType: "uri"
+    errorType: "uuid",
+    example: "a8b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
+    title: "UUID"
   });
   email = import_typebox.Type.String({
     pattern: `(?:[a-z0-9!#$%&'*+/=?^_{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_{|}~-]+)*|"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)])`,
-    errorType: "email"
+    errorType: "email",
+    example: "a@b.com",
+    title: "Email"
+  });
+  uri = import_typebox.Type.String({
+    pattern: "^[a-zA-Z][a-zA-Z\\d+-.]*:[^\\s]*$",
+    errorType: "uri",
+    example: "https://forklaunch.com",
+    title: "URI"
   });
   number = import_typebox.Type.Transform(
     import_typebox.Type.Union(
@@ -93,12 +106,13 @@ var TypeboxSchemaValidator = class {
         import_typebox.Type.String({ pattern: "^[0-9]+$" }),
         import_typebox.Type.Boolean(),
         import_typebox.Type.Null(),
-        import_typebox.Type.Date(),
-        import_typebox.Type.BigInt()
+        import_typebox.Type.BigInt(),
+        import_typebox.Type.Date()
       ],
       {
         errorType: "number-like",
-        openapiType: import_typebox.Type.Number()
+        example: 123,
+        title: "Number"
       }
     )
   ).Decode((value) => {
@@ -117,19 +131,23 @@ var TypeboxSchemaValidator = class {
       [
         import_typebox.Type.BigInt(),
         import_typebox.Type.Number(),
-        import_typebox.Type.String({ pattern: "^[0-9]+$" }),
+        import_typebox.Type.String({ pattern: "^[0-9]+n?$" }),
         import_typebox.Type.Boolean(),
         import_typebox.Type.Date()
       ],
       {
         errorType: "BigInt-like",
-        openapiType: import_typebox.Type.BigInt()
+        example: 123n,
+        title: "BigInt"
       }
     )
   ).Decode((value) => {
     if (typeof value !== "bigint") {
       try {
-        return BigInt(value instanceof Date ? value.getTime() : value);
+        if (value instanceof Date) {
+          return BigInt(value.getTime());
+        }
+        return BigInt(value);
       } catch {
         throw new Error("Invalid bigint");
       }
@@ -146,7 +164,8 @@ var TypeboxSchemaValidator = class {
       ],
       {
         errorType: "boolean-like",
-        openapiType: import_typebox.Type.Boolean()
+        example: true,
+        title: "Boolean"
       }
     )
   ).Decode((value) => {
@@ -160,38 +179,80 @@ var TypeboxSchemaValidator = class {
   date = import_typebox.Type.Transform(
     import_typebox.Type.Union(
       [
-        import_typebox.Type.Date(),
-        import_typebox.Type.Number(),
         import_typebox.Type.String({
           pattern: "^\\d{4}(-\\d{2}){0,2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,3})?)?(Z|([+-]\\d{2}:\\d{2}))?)?$|^\\d{1,2}\\/\\d{1,2}\\/\\d{4}$|^\\d{4}\\/\\d{1,2}\\/\\d{1,2}$|^\\d+$"
         }),
-        import_typebox.Type.Boolean(),
-        import_typebox.Type.Null()
+        import_typebox.Type.Number(),
+        import_typebox.Type.Date()
       ],
       {
         errorType: "date",
-        openapiType: import_typebox.Type.Date()
+        example: "2025-05-16T21:13:04.123Z",
+        title: "Date"
       }
     )
   ).Decode((value) => {
-    if (!(value instanceof Date)) {
-      if (value === null || typeof value === "boolean") {
-        return /* @__PURE__ */ new Date(value ? 1 : 0);
-      }
-      return new Date(value);
+    if (value === null || typeof value === "boolean") {
+      return /* @__PURE__ */ new Date(value ? 1 : 0);
     }
-    return value;
-  }).Encode((value) => new Date(value));
-  symbol = import_typebox.Type.Symbol();
+    return new Date(value);
+  }).Encode((value) => new Date(value).toISOString());
+  symbol = import_typebox.Type.Symbol({
+    title: "Symbol"
+  });
   nullish = import_typebox.Type.Union([import_typebox.Type.Void(), import_typebox.Type.Null(), import_typebox.Type.Undefined()], {
-    errorType: "nullish"
+    errorType: "nullish",
+    type: "null",
+    example: "null",
+    title: "Nullish"
+  });
+  void = import_typebox.Type.Void({
+    type: "null",
+    example: "void",
+    title: "Void"
   });
-  void = import_typebox.Type.Void();
-  null = import_typebox.Type.Null();
-  undefined = import_typebox.Type.Undefined();
-  any = import_typebox.Type.Any();
-  unknown = import_typebox.Type.Unknown();
-  never = import_typebox.Type.Never();
+  null = import_typebox.Type.Null({
+    type: "null",
+    example: "null",
+    title: "Null"
+  });
+  undefined = import_typebox.Type.Undefined({
+    type: "null",
+    example: "undefined",
+    title: "Undefined"
+  });
+  any = import_typebox.Type.Any({
+    type: "object",
+    example: "any",
+    title: "Any"
+  });
+  unknown = import_typebox.Type.Unknown({
+    type: "object",
+    example: "unknown",
+    title: "Unknown"
+  });
+  never = import_typebox.Type.Never({
+    type: "null",
+    example: "never",
+    title: "Never"
+  });
+  binary = import_typebox.Type.Transform(
+    import_typebox.Type.String({
+      errorType: "binary",
+      format: "binary",
+      example: "a utf-8 encodable string",
+      title: "Binary"
+    })
+  ).Decode(Buffer.from).Encode((value) => value.toString());
+  file = (name, type) => import_typebox.Type.Transform(
+    import_typebox.Type.String({
+      errorType: "binary",
+      format: "binary",
+      contentMediaType: type,
+      example: "a utf-8 encodable string",
+      title: "File"
+    })
+  ).Decode((value) => new import_common.InMemoryFile(value, name, { type })).Encode((value) => value.content);
   /**
    * Extracts the error type of a schema for error messages.
    *
@@ -221,12 +282,12 @@ var TypeboxSchemaValidator = class {
    * @returns {TResolve<T>} The resolved schema.
    */
   schemify(schema) {
-    if (typeof schema === "string" || typeof schema === "number" || typeof schema === "boolean") {
-      return import_typebox.Type.Literal(schema);
-    }
     if (import_typebox.KindGuard.IsSchema(schema) || schema instanceof import_compiler.TypeCheck) {
       return schema;
     }
+    if (typeof schema === "string" || typeof schema === "number" || typeof schema === "boolean") {
+      return import_typebox.Type.Literal(schema);
+    }
     const newSchema = {};
     Object.getOwnPropertyNames(schema).forEach((key) => {
       if (import_typebox.KindGuard.IsSchema(schema[key])) {
@@ -335,6 +396,15 @@ var TypeboxSchemaValidator = class {
   isSchema(value) {
     return import_typebox.KindGuard.IsSchema(value);
   }
+  /**
+   * Check if a value is an instance of a TypeBox schema.
+   * @param {object} value - The value to check.
+   * @param {TCatchall} type - The schema to check against.
+   * @returns {boolean} True if the value is an instance of the schema.
+   */
+  isInstanceOf(value, type) {
+    return typeof value === "object" && value != null && import_typebox.Kind in value && value[import_typebox.Kind] === type[import_typebox.Kind];
+  }
   /**
    * Validate a value against a schema.
    *
@@ -408,21 +478,38 @@ var TypeboxSchemaValidator = class {
    * @returns {SchemaObject} The OpenAPI schema object.
    */
   openapi(schema) {
-    const schemified = this.schemify(schema);
-    if (Object.hasOwn(schemified, "openapiType") || import_typebox.KindGuard.IsLiteral(schemified)) {
-      return schemified.openapiType;
+    let schemified = this.schemify(schema);
+    if (import_typebox.KindGuard.IsDate(schemified)) {
+      schemified = import_typebox.Type.String({
+        format: "date-time"
+      });
     }
     const newSchema = Object.assign({}, schemified);
     if (Object.hasOwn(newSchema, "properties")) {
-      newSchema.properties = { ...schemified.properties };
       if (newSchema.properties) {
-        Object.entries(newSchema.properties).forEach(([key, value]) => {
+        Object.entries({ ...schemified.properties }).forEach(([key, value]) => {
           if (import_typebox.KindGuard.IsSchema(value) && newSchema.properties) {
             newSchema.properties[key] = this.openapi(value);
           }
         });
       }
     }
+    if (Object.hasOwn(newSchema, "items")) {
+      newSchema.items = this.openapi(newSchema.items);
+    }
+    if (Array.isArray(newSchema.anyOf)) {
+      newSchema.anyOf = newSchema.anyOf.map(
+        (item) => this.openapi(item)
+      );
+    }
+    if (Array.isArray(newSchema.oneOf)) {
+      newSchema.oneOf = newSchema.oneOf.map(
+        (item) => this.openapi(item)
+      );
+    }
+    if ("errorType" in newSchema) {
+      delete newSchema["errorType"];
+    }
     return newSchema;
   }
 };
@@ -446,6 +533,8 @@ var undefined_ = StaticSchemaValidator.undefined;
 var any = StaticSchemaValidator.any;
 var unknown = StaticSchemaValidator.unknown;
 var never = StaticSchemaValidator.never;
+var binary = StaticSchemaValidator.binary;
+var file = StaticSchemaValidator.file;
 var schemify = StaticSchemaValidator.schemify.bind(
   StaticSchemaValidator
 );
@@ -481,10 +570,12 @@ var openapi = StaticSchemaValidator.openapi.bind(
   any,
   array,
   bigint,
+  binary,
   boolean,
   date,
   email,
   enum_,
+  file,
   function_,
   isSchema,
   literal,