TypeBox adapter bumped to 1.0

Author: ciscoheat

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- TypeBox adapter has been bumped to 1.0! Check the [migration guide](https://github.com/sinclairzx81/typebox/blob/main/changelog/1.0.0-migration.md) to upgrade. Note that if you need to stay on 0.x for a while, you cannot upgrade to this version of Superforms.
+
 ### Fixed
 
 - Possibly fixed the SuperDebug broken import on Svelte 5 in enforced runes mode [#599](https://github.com/ciscoheat/sveltekit-superforms/issues/599)

package.json

@@ -115,7 +115,7 @@
 	],
 	"peerDependencies": {
 		"@exodus/schemasafe": "^1.3.0",
-		"@sinclair/typebox": "^0.34.28",
+		"typebox": "^1.0.36",
 		"@sveltejs/kit": "1.x || 2.x",
 		"@typeschema/class-validator": "^0.3.0",
 		"@vinejs/vine": "^1.8.0 || ^2.0.0 || ^3.0.0",
@@ -133,7 +133,7 @@
 		"@exodus/schemasafe": {
 			"optional": true
 		},
-		"@sinclair/typebox": {
+		"typebox": {
 			"optional": true
 		},
 		"@typeschema/class-validator": {
@@ -171,7 +171,7 @@
 		"@exodus/schemasafe": "^1.3.0",
 		"@finom/zod-to-json-schema": "^3.24.11",
 		"@gcornut/valibot-json-schema": "^0.42.0",
-		"@sinclair/typebox": "^0.34.41",
+		"typebox": "^1.0.36",
 		"@typeschema/class-validator": "^0.3.0",
 		"@vinejs/vine": "^3.0.1",
 		"arktype": "^2.1.22",

pnpm-lock.yaml

@@ -1,4 +1,4 @@
-import type { TSchema, Static as Static$1 } from '@sinclair/typebox';
+import type { TSchema, Static as Static$1 } from 'typebox';
 import type { type } from 'arktype';
 import type { AnySchema } from 'joi';
 import type {

src/lib/adapters/typeSchema.ts

@@ -6,18 +6,41 @@ import {
 	type ValidationResult,
 	type ClientValidationAdapter
 } from './adapters.js';
-import type { TSchema } from '@sinclair/typebox';
-import type { TypeCheck } from '@sinclair/typebox/compiler';
+import type { TSchema } from 'typebox';
+import type { Validator } from 'typebox/compile';
 import { memoize } from '$lib/memoize.js';
+import Type from 'typebox';
+
+/**
+ * Custom TypeBox type for Date for testing purposes.
+ */
+export class TDate extends Type.Base<globalThis.Date> {
+	public override Check(value: unknown): value is globalThis.Date {
+		return value instanceof globalThis.Date;
+	}
+	public override Errors(value: unknown): object[] {
+		return this.Check(value) ? [] : [{ message: 'must be Date' }];
+	}
+	public override Create(): globalThis.Date {
+		return new globalThis.Date(0);
+	}
+}
+
+/**
+ * Custom TypeBox type for Date for testing purposes.
+ */
+export function Date(): TDate {
+	return new TDate();
+}
 
 // From https://github.com/sinclairzx81/typebox/tree/ca4d771b87ee1f8e953036c95a21da7150786d3e/example/formats
 const Email =
 	/^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/i;
 
 async function modules() {
-	const { TypeCompiler } = await import(/* webpackIgnore: true */ '@sinclair/typebox/compiler');
-	const { FormatRegistry } = await import(/* webpackIgnore: true */ '@sinclair/typebox');
-	return { TypeCompiler, FormatRegistry };
+	const { Compile } = await import(/* webpackIgnore: true */ 'typebox/compile');
+	const Format = await import(/* webpackIgnore: true */ 'typebox/format');
+	return { Compile, Format };
 }
 
 const fetchModule = /* @__PURE__ */ memoize(modules);
@@ -26,14 +49,14 @@ async function validate<T extends TSchema>(
 	schema: T,
 	data: unknown
 ): Promise<ValidationResult<Infer<T, 'typebox'>>> {
-	const { TypeCompiler, FormatRegistry } = await fetchModule();
+	const { Compile, Format } = await fetchModule();
 
 	if (!compiled.has(schema)) {
-		compiled.set(schema, TypeCompiler.Compile<TSchema>(schema));
+		compiled.set(schema, Compile(schema));
 	}
 
-	if (!FormatRegistry.Has('email')) {
-		FormatRegistry.Set('email', (value) => Email.test(value));
+	if (!Format.Has('email')) {
+		Format.Set('email', (value: string) => Email.test(value));
 	}
 
 	const validator = compiled.get(schema);
@@ -46,7 +69,7 @@ async function validate<T extends TSchema>(
 	return {
 		success: false,
 		issues: errors.map((issue) => ({
-			path: issue.path.substring(1).split('/'),
+			path: issue.instancePath ? issue.instancePath.substring(1).split('/') : [],
 			message: issue.message
 		}))
 	};
@@ -74,4 +97,4 @@ function _typeboxClient<T extends TSchema>(
 export const typebox = /* @__PURE__ */ memoize(_typebox);
 export const typeboxClient = /* @__PURE__ */ memoize(_typeboxClient);
 
-const compiled = new WeakMap<TSchema, TypeCheck<TSchema>>();
+const compiled = new WeakMap<TSchema, Validator<{}, TSchema>>();

src/lib/adapters/typebox.ts

@@ -228,7 +228,7 @@ function _parseFormData<T extends Record<string, unknown>>(
 			return entry;
 		}
 
-		console.log(`Parsing entry for key "${key}":`, entry); //debug
+		//console.log(`Parsing entry for key "${key}":`, entry); //debug
 
 		if (entry && typeof entry !== 'string') {
 			const allowFiles = legacyMode ? options?.allowFiles === true : options?.allowFiles !== false;
@@ -317,10 +317,10 @@ function parseFormDataEntry(
 	info: SchemaInfo,
 	fromURL = false
 ): unknown {
-	console.log(`Parsing FormData ${key} (${type}): ${value ? `"${value}"` : 'undefined'}`, info); //debug
+	//console.log(`Parsing FormData ${key} (${type}): ${value ? `"${value}"` : 'undefined'}`, info); //debug
 
 	if (!value) {
-		console.log(`No FormData for "${key}" (${type}).`, info); //debug
+		//console.log(`No FormData for "${key}" (${type}).`, info); //debug
 
 		// Special case for booleans with default value true, *when posted* (not from URL)
 		if (!fromURL && type == 'boolean' && info.isOptional && info.schema.default === true) {

src/lib/formData.ts

@@ -1,4 +1,4 @@
-import { Type } from '@sinclair/typebox';
+import { Type } from 'typebox';
 
 export const schema = Type.Object({
 	name: Type.String({ minLength: 2 }),

src/routes/(v2)/v2/typebox/schema.ts

@@ -46,8 +46,8 @@ import {
 import { arktype } from '$lib/adapters/arktype.js';
 import { type } from 'arktype';
 
-import { typebox } from '$lib/adapters/typebox.js';
-import { Type } from '@sinclair/typebox';
+import { typebox, Date as TypeBoxDate } from '$lib/adapters/typebox.js';
+import { Type } from 'typebox';
 
 import { joi } from '$lib/adapters/joi.js';
 import Joi from 'joi';
@@ -241,7 +241,7 @@ describe('TypeBox', () => {
 		email: Type.String({ format: 'email' }),
 		tags: Type.Array(Type.String({ minLength: 2 }), { minItems: 3 }),
 		score: Type.Integer({ minimum: 0 }),
-		date: Type.Optional(Type.Date()),
+		date: Type.Optional(TypeBoxDate()),
 		nospace: Type.Optional(Type.String({ pattern: '^\\S*$' })),
 		extra: Type.Union([Type.String(), Type.Null()])
 	});