@sinclair/typebox 0.34.24 → 0.34.25

package/build/cjs/syntax/syntax.d.ts

@@ -2,15 +2,15 @@ import * as t from '../type/index';
 import { Static } from '../parser/index';
 import { Type, GenericArguments } from './static';
 type TParseSyntax<Context extends Record<PropertyKey, t.TSchema>, Code extends string> = (Static.Parse<GenericArguments, Code, {}> extends [infer Args extends t.TProperties, infer Rest extends string] ? Static.Parse<Type, Rest, Context & Args> : Static.Parse<Type, Code, Context>);
-/** Parses a TypeScript annotation into a TypeBox type but does not infer schematics */
+/** `[Experimental]` Parses a TypeScript annotation into a TypeBox type but does not infer schematics */
 export declare function NoInfer<Context extends Record<PropertyKey, t.TSchema>, Code extends string>(context: Context, code: Code, options?: t.SchemaOptions): t.TSchema;
-/** Parses a TypeScript annotation into a TypeBox type but does not infer schematics */
+/** `[Experimental]` Parses a TypeScript annotation into a TypeBox type but does not infer schematics */
 export declare function NoInfer<Code extends string>(code: Code, options?: t.SchemaOptions): t.TSchema;
-/** Parses a TypeScript annotation into a TypeBox type */
+/** `[Experimental]` Parses a TypeScript annotation into a TypeBox type */
 export type TSyntax<Context extends Record<PropertyKey, t.TSchema>, Code extends string> = (TParseSyntax<Context, Code> extends [infer Type extends t.TSchema, string] ? Type : t.TNever);
-/** Parses a TypeScript annotation into a TypeBox type */
+/** `[Experimental]` Parses a TypeScript annotation into a TypeBox type */
 export declare function Syntax<Context extends Record<PropertyKey, t.TSchema>, Annotation extends string>(context: Context, annotation: Annotation, options?: t.SchemaOptions): TSyntax<Context, Annotation>;
-/** Parses a TypeScript annotation into a TypeBox type */
+/** `[Experimental]` Parses a TypeScript annotation into a TypeBox type */
 export declare function Syntax<Annotation extends string>(annotation: Annotation, options?: t.SchemaOptions): TSyntax<{}, Annotation>;
 /**
  * @deprecated Use Syntax() function

package/build/cjs/syntax/syntax.js

@@ -14,7 +14,7 @@ function ParseSyntax(context, code) {
         ? runtime_1.Module.Parse('Type', results[1], { ...context, ...results[0] })
         : runtime_1.Module.Parse('Type', code, context));
 }
-/** Parses a TypeScript annotation into a TypeBox type but does not infer schematics */
+/** `[Experimental]` Parses a TypeScript annotation into a TypeBox type but does not infer schematics */
 // prettier-ignore
 function NoInfer(...args) {
     const withContext = typeof args[0] === 'string' ? false : true;
@@ -24,7 +24,7 @@ function NoInfer(...args) {
         ? t.CloneType(result, options)
         : t.Never(options);
 }
-/** Parses a TypeScript annotation into a TypeBox type */
+/** `[Experimental]` Parses a TypeScript annotation into a TypeBox type */
 function Syntax(...args) {
     return NoInfer.apply(null, args);
 }

package/build/cjs/type/instantiate/instantiate.d.ts

@@ -24,7 +24,7 @@ type TFromArray<Args extends TSchema[], Type extends TSchema, Result extends TAr
 type TFromAsyncIterator<Args extends TSchema[], Type extends TSchema, Result extends TAsyncIterator = TAsyncIterator<TFromType<Args, Type>>> = Result;
 type TFromIterator<Args extends TSchema[], Type extends TSchema, Result extends TIterator = TIterator<TFromType<Args, Type>>> = Result;
 type TFromPromise<Args extends TSchema[], Type extends TSchema, Result extends TPromise = TPromise<TFromType<Args, Type>>> = Result;
-type TFromObject<Args extends TSchema[], Properties extends TProperties, Result extends TProperties = TFromProperties<Args, Properties>> = TObject<Result>;
+type TFromObject<Args extends TSchema[], Properties extends TProperties, MappedProperties extends TProperties = TFromProperties<Args, Properties>, Result extends TObject = TObject<MappedProperties>> = Result;
 type TFromRecord<Args extends TSchema[], Key extends TSchema, Value extends TSchema, MappedKey extends TSchema = TFromType<Args, Key>, MappedValue extends TSchema = TFromType<Args, Value>, Result extends TSchema = TRecordOrObject<MappedKey, MappedValue>> = Result;
 type TFromArgument<Args extends TSchema[], Index extends number, Result extends TSchema = Index extends keyof Args[Index] ? Args[Index] : TUnknown> = Result;
 type TFromProperty<Args extends TSchema[], Type extends TSchema, IsReadonly extends boolean = Type extends TReadonly<Type> ? true : false, IsOptional extends boolean = Type extends TOptional<Type> ? true : false, Mapped extends TSchema = TFromType<Args, Type>, Result extends TSchema = ([

package/build/cjs/type/instantiate/instantiate.js

@@ -63,8 +63,8 @@ function FromPromise(args, type) {
 }
 // prettier-ignore
 function FromObject(args, type) {
-    const properties = FromProperties(args, type.properties);
-    return { ...type, ...(0, index_5.Object)(properties) }; // retain options
+    const mappedProperties = FromProperties(args, type.properties);
+    return { ...type, ...(0, index_5.Object)(mappedProperties) }; // retain options
 }
 // prettier-ignore
 function FromRecord(args, type) {

package/build/esm/syntax/syntax.d.mts

@@ -2,15 +2,15 @@ import * as t from '../type/index.mjs';
 import { Static } from '../parser/index.mjs';
 import { Type, GenericArguments } from './static.mjs';
 type TParseSyntax<Context extends Record<PropertyKey, t.TSchema>, Code extends string> = (Static.Parse<GenericArguments, Code, {}> extends [infer Args extends t.TProperties, infer Rest extends string] ? Static.Parse<Type, Rest, Context & Args> : Static.Parse<Type, Code, Context>);
-/** Parses a TypeScript annotation into a TypeBox type but does not infer schematics */
+/** `[Experimental]` Parses a TypeScript annotation into a TypeBox type but does not infer schematics */
 export declare function NoInfer<Context extends Record<PropertyKey, t.TSchema>, Code extends string>(context: Context, code: Code, options?: t.SchemaOptions): t.TSchema;
-/** Parses a TypeScript annotation into a TypeBox type but does not infer schematics */
+/** `[Experimental]` Parses a TypeScript annotation into a TypeBox type but does not infer schematics */
 export declare function NoInfer<Code extends string>(code: Code, options?: t.SchemaOptions): t.TSchema;
-/** Parses a TypeScript annotation into a TypeBox type */
+/** `[Experimental]` Parses a TypeScript annotation into a TypeBox type */
 export type TSyntax<Context extends Record<PropertyKey, t.TSchema>, Code extends string> = (TParseSyntax<Context, Code> extends [infer Type extends t.TSchema, string] ? Type : t.TNever);
-/** Parses a TypeScript annotation into a TypeBox type */
+/** `[Experimental]` Parses a TypeScript annotation into a TypeBox type */
 export declare function Syntax<Context extends Record<PropertyKey, t.TSchema>, Annotation extends string>(context: Context, annotation: Annotation, options?: t.SchemaOptions): TSyntax<Context, Annotation>;
-/** Parses a TypeScript annotation into a TypeBox type */
+/** `[Experimental]` Parses a TypeScript annotation into a TypeBox type */
 export declare function Syntax<Annotation extends string>(annotation: Annotation, options?: t.SchemaOptions): TSyntax<{}, Annotation>;
 /**
  * @deprecated Use Syntax() function

package/build/esm/syntax/syntax.mjs

@@ -7,7 +7,7 @@ function ParseSyntax(context, code) {
         ? Module.Parse('Type', results[1], { ...context, ...results[0] })
         : Module.Parse('Type', code, context));
 }
-/** Parses a TypeScript annotation into a TypeBox type but does not infer schematics */
+/** `[Experimental]` Parses a TypeScript annotation into a TypeBox type but does not infer schematics */
 // prettier-ignore
 export function NoInfer(...args) {
     const withContext = typeof args[0] === 'string' ? false : true;
@@ -17,7 +17,7 @@ export function NoInfer(...args) {
         ? t.CloneType(result, options)
         : t.Never(options);
 }
-/** Parses a TypeScript annotation into a TypeBox type */
+/** `[Experimental]` Parses a TypeScript annotation into a TypeBox type */
 export function Syntax(...args) {
     return NoInfer.apply(null, args);
 }

package/build/esm/type/instantiate/instantiate.d.mts

@@ -24,7 +24,7 @@ type TFromArray<Args extends TSchema[], Type extends TSchema, Result extends TAr
 type TFromAsyncIterator<Args extends TSchema[], Type extends TSchema, Result extends TAsyncIterator = TAsyncIterator<TFromType<Args, Type>>> = Result;
 type TFromIterator<Args extends TSchema[], Type extends TSchema, Result extends TIterator = TIterator<TFromType<Args, Type>>> = Result;
 type TFromPromise<Args extends TSchema[], Type extends TSchema, Result extends TPromise = TPromise<TFromType<Args, Type>>> = Result;
-type TFromObject<Args extends TSchema[], Properties extends TProperties, Result extends TProperties = TFromProperties<Args, Properties>> = TObject<Result>;
+type TFromObject<Args extends TSchema[], Properties extends TProperties, MappedProperties extends TProperties = TFromProperties<Args, Properties>, Result extends TObject = TObject<MappedProperties>> = Result;
 type TFromRecord<Args extends TSchema[], Key extends TSchema, Value extends TSchema, MappedKey extends TSchema = TFromType<Args, Key>, MappedValue extends TSchema = TFromType<Args, Value>, Result extends TSchema = TRecordOrObject<MappedKey, MappedValue>> = Result;
 type TFromArgument<Args extends TSchema[], Index extends number, Result extends TSchema = Index extends keyof Args[Index] ? Args[Index] : TUnknown> = Result;
 type TFromProperty<Args extends TSchema[], Type extends TSchema, IsReadonly extends boolean = Type extends TReadonly<Type> ? true : false, IsOptional extends boolean = Type extends TOptional<Type> ? true : false, Mapped extends TSchema = TFromType<Args, Type>, Result extends TSchema = ([

package/build/esm/type/instantiate/instantiate.mjs

@@ -58,8 +58,8 @@ function FromPromise(args, type) {
 }
 // prettier-ignore
 function FromObject(args, type) {
-    const properties = FromProperties(args, type.properties);
-    return { ...type, ...Object(properties) }; // retain options
+    const mappedProperties = FromProperties(args, type.properties);
+    return { ...type, ...Object(mappedProperties) }; // retain options
 }
 // prettier-ignore
 function FromRecord(args, type) {

package/package.json

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

package/readme.md

@@ -100,6 +100,7 @@ License MIT
   - [Parameters](#syntax-parameters)
   - [Generics](#syntax-generics)
   - [Options](#syntax-options)
+  - [NoInfer](#syntax-no-infer)
 - [TypeRegistry](#typeregistry)
   - [Type](#typeregistry-type)
   - [Format](#typeregistry-format)
@@ -1306,7 +1307,7 @@ ValuePointer.Set(A, '/z', 1)                         // A' = { x: 1, y: 1, z: 1
 
 ## Syntax Types
 
-TypeBox includes support for parsing TypeScript annotation syntax into TypeBox schematics.
+TypeBox provides experimental support for parsing TypeScript annotation syntax into TypeBox types.
 
 This feature is provided via optional import.
 
@@ -1391,6 +1392,23 @@ const T = Syntax(`number`, { minimum: 42 })       // const T = {
                                                   // }
 ```
 
+<a name='syntax-no-infer'></a>
+
+### NoInfer
+
+Syntax parsing is an expensive type level operation and can impact on language service performance. Use the NoInfer function parse syntax at runtime only.
+
+```typescript
+import { NoInfer } from '@sinclair/typebox/syntax'
+
+const T = NoInfer(`number | string`)                // const T: TSchema = {
+                                                    //   anyOf: [
+                                                    //     { type: 'number' },
+                                                    //     { type: 'string' }
+                                                    //   ]
+                                                    // }
+```
+
 <a name='typeregistry'></a>
 
 ## TypeRegistry