@sinclair/typebox 0.34.0 → 0.34.2

package/build/esm/value/check/check.mjs

@@ -12,9 +12,9 @@ import { Never } from '../../type/never/index.mjs';
 // ------------------------------------------------------------------
 import { IsArray, IsUint8Array, IsDate, IsPromise, IsFunction, IsAsyncIterator, IsIterator, IsBoolean, IsNumber, IsBigInt, IsString, IsSymbol, IsInteger, IsNull, IsUndefined } from '../guard/index.mjs';
 // ------------------------------------------------------------------
-// TypeGuard
+// KindGuard
 // ------------------------------------------------------------------
-import { IsSchema } from '../../type/guard/type.mjs';
+import { IsSchema } from '../../type/guard/kind.mjs';
 // ------------------------------------------------------------------
 // Errors
 // ------------------------------------------------------------------

package/build/esm/value/transform/decode.mjs

@@ -9,9 +9,9 @@ import { Check } from '../check/index.mjs';
 // ------------------------------------------------------------------
 import { HasPropertyKey, IsObject, IsArray, IsValueType, IsUndefined as IsUndefinedValue } from '../guard/index.mjs';
 // ------------------------------------------------------------------
-// TypeGuard
+// KindGuard
 // ------------------------------------------------------------------
-import { IsTransform, IsSchema, IsUndefined } from '../../type/guard/type.mjs';
+import { IsTransform, IsSchema, IsUndefined } from '../../type/guard/kind.mjs';
 // ------------------------------------------------------------------
 // Errors
 // ------------------------------------------------------------------

package/build/esm/value/transform/encode.mjs

@@ -9,9 +9,9 @@ import { Check } from '../check/index.mjs';
 // ------------------------------------------------------------------
 import { HasPropertyKey, IsObject, IsArray, IsValueType, IsUndefined as IsUndefinedValue } from '../guard/index.mjs';
 // ------------------------------------------------------------------
-// TypeGuard
+// KindGuard
 // ------------------------------------------------------------------
-import { IsTransform, IsSchema, IsUndefined } from '../../type/guard/type.mjs';
+import { IsTransform, IsSchema, IsUndefined } from '../../type/guard/kind.mjs';
 // ------------------------------------------------------------------
 // Errors
 // ------------------------------------------------------------------

package/build/esm/value/transform/has.mjs

@@ -1,9 +1,9 @@
 import { Deref, Pushref } from '../deref/index.mjs';
 import { Kind } from '../../type/symbols/index.mjs';
 // ------------------------------------------------------------------
-// TypeGuard
+// KindGuard
 // ------------------------------------------------------------------
-import { IsTransform, IsSchema } from '../../type/guard/type.mjs';
+import { IsTransform, IsSchema } from '../../type/guard/kind.mjs';
 // ------------------------------------------------------------------
 // ValueGuard
 // ------------------------------------------------------------------

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sinclair/typebox",
-  "version": "0.34.0",
+  "version": "0.34.2",
   "description": "Json Schema Type Builder with Static Type Resolution for TypeScript",
   "keywords": [
     "typescript",

package/readme.md

@@ -4,7 +4,7 @@
 
 <p>Json Schema Type Builder with Static Type Resolution for TypeScript</p>
 
-<img src="https://github.com/sinclairzx81/typebox/blob/master/typebox.png?raw=true" />
+<img src="https://raw.githubusercontent.com/sinclairzx81/typebox/refs/heads/master/typebox.png" />
 
 <br />
 <br />
@@ -777,7 +777,8 @@ type T = Static<typeof T>                            // type T = string | null
 TypeBox Modules are containers for related types. They function as namespaces and enable internal types to reference each other via string references. Modules support both singular and mutually recursive types. They provide a mechanism to create circular types irrespective of the order in which types are defined.
 
 ```typescript
-// The following creates a circular recursive type.
+
+// The following creates a Module of circular recursive Types.
 
 const Module = Type.Module({
   A: Type.Object({ 
@@ -791,7 +792,7 @@ const Module = Type.Module({
   }),
 })
 
-// Module types must be imported before use.
+// Module Types must be imported before use.
 
 const A = Module.Import('A')                     // const A: TImport<{...}, 'A'>
 
@@ -1073,22 +1074,32 @@ const T = Type.Object({                             // const T: TObject<{
 
 ### Module
 
-Syntax Types support Module parsing, which is useful for processing multiple TypeScript types. Module parsing supports type alias and interface definitions. Generics are currently unsupported as of 0.34.0.
+Syntax Types also support Module parsing. This can provide a more terse syntax for creating Module definitions, but comes with an inference performance cost. Module parsing supports interface and type alias definitions. Generics types are currently unsupported. 
 
 ```typescript
-const Foo = Parse(`module Foo {
-
-  export type A = string
-
-  export type B = number
-
-  export type C = A | B
+const Module = Parse(`module {
+  
+  export interface User {
+    id: string
+    name: string
+    email: string
+  }
+ 
+  export type PartialUser = (
+    Pick<User, 'id'> &
+    Partial<Omit<User, 'id'>>
+  )
 
 }`)
 
-const C = Foo.Import('C')                           // const C: TImport<{
-                                                    //   ...
-                                                    // }, 'C'>
+const PartialUser = Module.Import('PartialUser')    // TImport<{...}, 'PartialUser'>
+
+type PartialUser = Static<typeof PartialUser>       // type PartialUser = {
+                                                    //   id: string,
+                                                    // } & {
+                                                    //   name?: string,
+                                                    //   email?: string,
+                                                    // }
 ```
 
 <a name='syntax-context'></a>
@@ -1882,12 +1893,12 @@ The following table lists esbuild compiled and minified sizes for each TypeBox m
 ┌──────────────────────┬────────────┬────────────┬─────────────┐
 │ (index)              │ Compiled   │ Minified   │ Compression │
 ├──────────────────────┼────────────┼────────────┼─────────────┤
-│ typebox/compiler     │ '121.7 kb' │ ' 53.4 kb' │ '2.28 x'    │
-│ typebox/errors       │ ' 75.3 kb' │ ' 33.4 kb' │ '2.25 x'    │
-│ typebox/syntax       │ '120.1 kb' │ ' 50.5 kb' │ '2.38 x'    │
+│ typebox/compiler     │ '122.4 kb' │ ' 53.4 kb' │ '2.29 x'    │
+│ typebox/errors       │ ' 67.6 kb' │ ' 29.6 kb' │ '2.28 x'    │
+│ typebox/syntax       │ '132.9 kb' │ ' 54.2 kb' │ '2.45 x'    │
 │ typebox/system       │ '  7.4 kb' │ '  3.2 kb' │ '2.33 x'    │
-│ typebox/value        │ '160.3 kb' │ ' 67.4 kb' │ '2.38 x'    │
-│ typebox              │ ' 96.2 kb' │ ' 40.2 kb' │ '2.39 x'    │
+│ typebox/value        │ '150.1 kb' │ ' 62.2 kb' │ '2.41 x'    │
+│ typebox              │ '106.8 kb' │ ' 43.2 kb' │ '2.47 x'    │
 └──────────────────────┴────────────┴────────────┴─────────────┘
 ```