@sinclair/typebox 0.34.12 → 0.34.13

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

@@ -11,18 +11,31 @@ export type TRefUnsafe<Type extends TSchema> = TUnsafe<Static<Type>>;
 /** `[Json]` Creates a Ref type.*/
 export declare function Ref<Ref extends string>($ref: Ref, options?: SchemaOptions): TRef<Ref>;
 /**
- * @deprecated `[Json]` Creates a Ref type. The referenced type MUST contain a $id. The Ref(TSchema) signature was
- * deprecated on 0.34.0 in support of a new type referencing model (Module). Existing implementations using Ref(TSchema)
- * can migrate using the following. The Ref(TSchema) validation behavior of Ref will be preserved how the construction
- * of legacy Ref(TSchema) will require wrapping in TUnsafe (where TUnsafe is used for inference only)
+ * @deprecated `[Json]` Creates a Ref type. This signature was deprecated in 0.34.0 where Ref requires callers to pass
+ * a `string` value for the reference (and not a schema).
+ *
+ * To adhere to the 0.34.0 signature, Ref implementations should be updated to the following.
  *
  * ```typescript
+ * // pre-0.34.0
+ *
+ * const T = Type.String({ $id: 'T' })
+ *
  * const R = Type.Ref(T)
  * ```
- * to
+ * should be changed to the following
+ *
+ * ```typescript
+ * // post-0.34.0
+ *
+ * const T = Type.String({ $id: 'T' })
+ *
+ * const R = Type.Unsafe<Static<typeof T>>(Type.Ref('T'))
+ * ```
+ * You can also create a generic function to replicate the pre-0.34.0 signature if required
  *
  * ```typescript
- * const R = Type.Unsafe<Static<T>>(T.$id)
+ * const LegacyRef = <T extends TSchema>(schema: T) => Type.Unsafe<Static<T>>(Type.Ref(schema.$id!))
  * ```
  */
 export declare function Ref<Type extends TSchema>(type: Type, options?: SchemaOptions): TRefUnsafe<Type>;

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

@@ -151,18 +151,31 @@ export declare class JsonTypeBuilder {
     /** `[Json]` Creates a Ref type.*/
     Ref<Ref extends string>($ref: Ref, options?: SchemaOptions): TRef<Ref>;
     /**
-     * @deprecated `[Json]` Creates a Ref type. The referenced type MUST contain a $id. The Ref(TSchema) signature was
-     * deprecated on 0.34.0 in support of a new type referencing model (Module). Existing implementations using Ref(TSchema)
-     * can migrate using the following. The Ref(TSchema) validation behavior of Ref will be preserved how the construction
-     * of legacy Ref(TSchema) will require wrapping in TUnsafe (where TUnsafe is used for inference only)
+     * @deprecated `[Json]` Creates a Ref type. This signature was deprecated in 0.34.0 where Ref requires callers to pass
+     * a `string` value for the reference (and not a schema).
+     *
+     * To adhere to the 0.34.0 signature, Ref implementations should be updated to the following.
      *
      * ```typescript
+     * // pre-0.34.0
+     *
+     * const T = Type.String({ $id: 'T' })
+     *
      * const R = Type.Ref(T)
      * ```
-     * to
+     * should be changed to the following
+     *
+     * ```typescript
+     * // post-0.34.0
+     *
+     * const T = Type.String({ $id: 'T' })
+     *
+     * const R = Type.Unsafe<Static<typeof T>>(Type.Ref('T'))
+     * ```
+     * You can also create a generic function to replicate the pre-0.34.0 signature if required
      *
      * ```typescript
-     * const R = Type.Unsafe<Static<T>>(T.$id)
+     * const LegacyRef = <T extends TSchema>(schema: T) => Type.Unsafe<Static<T>>(Type.Ref(schema.$id!))
      * ```
      */
     Ref<Type extends TSchema>(type: Type, options?: SchemaOptions): TRefUnsafe<Type>;

package/build/cjs/value/convert/convert.js

@@ -70,7 +70,7 @@ function TryConvertBigInt(value) {
     return IsStringNumeric(value) ? BigInt(truncateInteger(value)) : (0, index_5.IsNumber)(value) ? BigInt(Math.trunc(value)) : IsValueFalse(value) ? BigInt(0) : IsValueTrue(value) ? BigInt(1) : value;
 }
 function TryConvertString(value) {
-    return IsValueToString(value) ? value.toString() : (0, index_5.IsSymbol)(value) && value.description !== undefined ? value.description.toString() : value;
+    return (0, index_5.IsSymbol)(value) && value.description !== undefined ? value.description.toString() : IsValueToString(value) ? value.toString() : value;
 }
 function TryConvertNumber(value) {
     return IsStringNumeric(value) ? parseFloat(value) : IsValueTrue(value) ? 1 : IsValueFalse(value) ? 0 : value;

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

@@ -11,18 +11,31 @@ export type TRefUnsafe<Type extends TSchema> = TUnsafe<Static<Type>>;
 /** `[Json]` Creates a Ref type.*/
 export declare function Ref<Ref extends string>($ref: Ref, options?: SchemaOptions): TRef<Ref>;
 /**
- * @deprecated `[Json]` Creates a Ref type. The referenced type MUST contain a $id. The Ref(TSchema) signature was
- * deprecated on 0.34.0 in support of a new type referencing model (Module). Existing implementations using Ref(TSchema)
- * can migrate using the following. The Ref(TSchema) validation behavior of Ref will be preserved how the construction
- * of legacy Ref(TSchema) will require wrapping in TUnsafe (where TUnsafe is used for inference only)
+ * @deprecated `[Json]` Creates a Ref type. This signature was deprecated in 0.34.0 where Ref requires callers to pass
+ * a `string` value for the reference (and not a schema).
+ *
+ * To adhere to the 0.34.0 signature, Ref implementations should be updated to the following.
  *
  * ```typescript
+ * // pre-0.34.0
+ *
+ * const T = Type.String({ $id: 'T' })
+ *
  * const R = Type.Ref(T)
  * ```
- * to
+ * should be changed to the following
+ *
+ * ```typescript
+ * // post-0.34.0
+ *
+ * const T = Type.String({ $id: 'T' })
+ *
+ * const R = Type.Unsafe<Static<typeof T>>(Type.Ref('T'))
+ * ```
+ * You can also create a generic function to replicate the pre-0.34.0 signature if required
  *
  * ```typescript
- * const R = Type.Unsafe<Static<T>>(T.$id)
+ * const LegacyRef = <T extends TSchema>(schema: T) => Type.Unsafe<Static<T>>(Type.Ref(schema.$id!))
  * ```
  */
 export declare function Ref<Type extends TSchema>(type: Type, options?: SchemaOptions): TRefUnsafe<Type>;

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

@@ -151,18 +151,31 @@ export declare class JsonTypeBuilder {
     /** `[Json]` Creates a Ref type.*/
     Ref<Ref extends string>($ref: Ref, options?: SchemaOptions): TRef<Ref>;
     /**
-     * @deprecated `[Json]` Creates a Ref type. The referenced type MUST contain a $id. The Ref(TSchema) signature was
-     * deprecated on 0.34.0 in support of a new type referencing model (Module). Existing implementations using Ref(TSchema)
-     * can migrate using the following. The Ref(TSchema) validation behavior of Ref will be preserved how the construction
-     * of legacy Ref(TSchema) will require wrapping in TUnsafe (where TUnsafe is used for inference only)
+     * @deprecated `[Json]` Creates a Ref type. This signature was deprecated in 0.34.0 where Ref requires callers to pass
+     * a `string` value for the reference (and not a schema).
+     *
+     * To adhere to the 0.34.0 signature, Ref implementations should be updated to the following.
      *
      * ```typescript
+     * // pre-0.34.0
+     *
+     * const T = Type.String({ $id: 'T' })
+     *
      * const R = Type.Ref(T)
      * ```
-     * to
+     * should be changed to the following
+     *
+     * ```typescript
+     * // post-0.34.0
+     *
+     * const T = Type.String({ $id: 'T' })
+     *
+     * const R = Type.Unsafe<Static<typeof T>>(Type.Ref('T'))
+     * ```
+     * You can also create a generic function to replicate the pre-0.34.0 signature if required
      *
      * ```typescript
-     * const R = Type.Unsafe<Static<T>>(T.$id)
+     * const LegacyRef = <T extends TSchema>(schema: T) => Type.Unsafe<Static<T>>(Type.Ref(schema.$id!))
      * ```
      */
     Ref<Type extends TSchema>(type: Type, options?: SchemaOptions): TRefUnsafe<Type>;

package/build/esm/value/convert/convert.mjs

@@ -66,7 +66,7 @@ function TryConvertBigInt(value) {
     return IsStringNumeric(value) ? BigInt(truncateInteger(value)) : IsNumber(value) ? BigInt(Math.trunc(value)) : IsValueFalse(value) ? BigInt(0) : IsValueTrue(value) ? BigInt(1) : value;
 }
 function TryConvertString(value) {
-    return IsValueToString(value) ? value.toString() : IsSymbol(value) && value.description !== undefined ? value.description.toString() : value;
+    return IsSymbol(value) && value.description !== undefined ? value.description.toString() : IsValueToString(value) ? value.toString() : value;
 }
 function TryConvertNumber(value) {
     return IsStringNumeric(value) ? parseFloat(value) : IsValueTrue(value) ? 1 : IsValueFalse(value) ? 0 : value;

package/package.json

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