Migrate from @sinclair/typebox 0.34.x to typebox 1.0 by masad-frost · Pull Request #364 · replit/river

masad-frost · 2026-03-13T02:16:48Z

Why

TypeBox 1 has been out for some time now, we should start using it so that we're not left in the dust!

What changed

Do necessary work per

https://github.com/sinclairzx81/typebox/blob/4f0832d2f0e4b94c84d9f94c1318a5fc9d5015f4/changelog/1.0.0-migration.md
https://github.com/sinclairzx81/typebox/blob/4f0832d2f0e4b94c84d9f94c1318a5fc9d5015f4/changelog/1.1.0.md
The most notable change is the we now export our own schemas for UInt8Array and Date to preserve backwards compatibility from @replit/river/customSchemas. Longer term, we may want to evaluate more JSON Schema–native representations, as long as they do not undermine the efficiency of our MessagePack encoding.
Validation error messages changed

Versioning

No breaking schema-level or wire-format changes introduced at all, validated through a new tests

Breaking protocol change
Breaking ts/js API change
Consumers will have to now use typebox >=1.0.0 and use the exported UInt8ArrayType and DateType

Monkatraz

looks quite reasonable, surprised we didn't have to do more honestly

Monkatraz · 2026-03-13T02:19:56Z

__tests__/backwardsCompat/codec.test.ts

+        payload: {
+          code: 'SOME_ERROR',
+          message: 'something went wrong',
+          extras: { detail: 'extra info' },


did anyone accidentally shove entire error class instances in these things anywhere? wonder what 1. typebox does with that and 2. if it did "handle" it before, if it still does.

extras is just a generic Record so typebox didn't do anything with them, the codec probably resulted in Error objects being {} since the properties are usually non-enumerable.

Monkatraz · 2026-03-13T02:24:50Z

__tests__/backwardsCompat/schemaSerialization.test.ts

+    });
+  });
+
+  describe('composite types', () => {


we do use some Type.Intersect and other more esoteric types, might be worth checking those.

I'll throw them in

Monkatraz · 2026-03-13T02:25:19Z

__tests__/cancellation.test.ts

@@ -1,4 +1,4 @@
-import { TNever, TObject, Type } from '@sinclair/typebox';
+import { TNever, TObject, Type } from 'typebox';


oh wow, he actually got the typebox package name?

Monkatraz · 2026-03-13T02:27:29Z

customSchemas/index.ts

+      ...options,
+    }),
+    (value): value is Uint8Array => {
+      if (!(value instanceof Uint8Array)) return false;


sanity check: no insane bullshit with node Buffer right?

Whatever bullshit that may have been, it's preserved https://github.com/sinclairzx81/typebox/blob/0.34.41/src/value/guard/guard.ts#L101-L104

Monkatraz · 2026-03-13T02:27:49Z

customSchemas/index.ts

+      if (
+        typeof options.minByteLength === 'number' &&
+        value.byteLength < options.minByteLength
+      )
+        return false;
+      if (
+        typeof options.maxByteLength === 'number' &&
+        value.byteLength > options.maxByteLength
+      )
+        return false;


use some curlies bro

Monkatraz · 2026-03-13T02:28:02Z

customSchemas/index.ts

+      if (
+        typeof options.minimumTimestamp === 'number' &&
+        value.getTime() < options.minimumTimestamp
+      )
+        return false;
+      if (
+        typeof options.maximumTimestamp === 'number' &&
+        value.getTime() > options.maximumTimestamp
+      )
+        return false;


Lol, I'll throw in some lint rules

Monkatraz · 2026-03-13T02:28:58Z

testUtil/fixtures/services.ts

+const RecursivePayload = Type.Cyclic(
+  {
+    RecursivePayload: Type.Object({
+      n: Type.Number(),
+      next: Type.Optional(Type.Ref('RecursivePayload')),
+    }),
+  },
+  'RecursivePayload',
 );


it bothers me that he made the defs go first

Monkatraz · 2026-03-13T02:31:43Z

router/procedures.ts

+  // In TypeBox 1.0, TSchema is {} so Static<TSchema> doesn't resolve the same way
+  // as in 0.34. Using `any` for schema type params in the implementation signature
+  // is safe because the public overload signatures still enforce correct types for
+  // all callers. The implementation body doesn't inspect handler types at runtime.
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  handler: RpcProcedure<any, any, any, any, any, any>['handler'];


yeah this makes sense, it's annoying how you can't use describe unknown extends ... or infer or something.

Yeah was painful for me and my agent and it went in circles, until I realized who cares lol.

Monkatraz · 2026-03-13T02:32:22Z

router/errors.ts

+ * Flattens a union-nested error schema into a single level in order to
+ * satisfy ProcedureErrorSchemaType which accepts only a single level of union
+ * so that we can enforce a schema validation on the error schema.


yeah the original comment was quite spiteful wasn't it

Monkatraz · 2026-03-13T02:33:26Z

router/errors.ts

 type TLiteralString = TLiteral<string>;

-type TEnumString = TEnum<Record<string, string>>;
+type TEnumString = TEnum<Array<string>>;


huh. enums are no longer TypeScript shaped, I guess? that might be a really painful migration...

Yep, I think it's for the better, they're JSON Schema shaped.

Monkatraz

cache change looks fine

feat: migrate from @sinclair/typebox 0.34.x to typebox 1.0

b5cf42b

masad-frost requested a review from a team as a code owner March 13, 2026 02:16

masad-frost requested review from wernst and removed request for a team March 13, 2026 02:16

Monkatraz approved these changes Mar 13, 2026

View reviewed changes

masad-frost added 2 commits March 12, 2026 19:56

Use a cache for custom schemas and export a TSchema for them

597f9ce

oops forgot to actually use min-max in date

98c7f92

Monkatraz approved these changes Mar 13, 2026

View reviewed changes

		@@ -1,4 +1,4 @@
		import { TNever, TObject, Type } from '@sinclair/typebox';
		import { TNever, TObject, Type } from 'typebox';

Conversation

masad-frost commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why

What changed

Versioning

Uh oh!

Monkatraz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Monkatraz left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

masad-frost commented Mar 13, 2026 •

edited

Loading