Version 1.0.39 (#1411)

* Add Anchor, DynamicAnchor, DynamicRef Guards

* ChangeLog

* Version

Author: sinclairzx81

changelog/1.0.0.md

@@ -3,6 +3,8 @@
 ---
 
 ### Version Updates
+- [Revision 1.0.39](https://github.com/sinclairzx81/typebox/pull/1411)
+  - Add IsAnchor, IsDynamicAnchor and IsDynamicRef Guards
 - [Revision 1.0.38](https://github.com/sinclairzx81/typebox/pull/1410)
   - Json Schema Inference: Progressive Constraint Inference for Items and PrefixItems
 - [Revision 1.0.37](https://github.com/sinclairzx81/typebox/pull/1406)
@@ -182,15 +184,11 @@ const X = Compile(Type.Script(`1 | 2 | 3`))
 
 const Y = Compile({ anyOf: [{ const: 1 }, { const: 2 }, { const: 3 }] })
 
-const Z = Compile(z.union([z.literal(1), z.literal(2), z.literal(3)])) // Zod
-
 // Unified Parse and Inference
 
 const A = X.Parse(1)                                // const A: 1 | 2 | 3
 
 const B = Y.Parse(2)                                // const B: 1 | 2 | 3
-
-const C = Z.Parse(3)                                // const C: 1 | 2 | 3
 ```
 
 

src/schema/types/anchor.ts

@@ -0,0 +1,49 @@
+/*--------------------------------------------------------------------------
+
+TypeBox
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2025 Haydn Paterson 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
+
+// deno-fmt-ignore-file
+
+import { Guard } from '../../guard/index.ts'
+import { type XSchemaObject } from './schema.ts'
+
+// ------------------------------------------------------------------
+// Type
+// ------------------------------------------------------------------
+export interface XAnchor<Anchor extends string = string> {
+  $anchor: Anchor
+}
+// ------------------------------------------------------------------
+// Guard
+// ------------------------------------------------------------------
+/** 
+ * Returns true if the schema contains a valid $anchor property
+ */
+export function IsAnchor(schema: XSchemaObject): schema is XAnchor {
+  return Guard.HasPropertyKey(schema, '$anchor') 
+    && Guard.IsString(schema.$anchor)
+}

src/schema/types/dynamicAnchor.ts

@@ -0,0 +1,49 @@
+/*--------------------------------------------------------------------------
+
+TypeBox
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2025 Haydn Paterson 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
+
+// deno-fmt-ignore-file
+
+import { Guard } from '../../guard/index.ts'
+import { type XSchemaObject } from './schema.ts'
+
+// ------------------------------------------------------------------
+// Type
+// ------------------------------------------------------------------
+export interface XDynamicAnchor<Anchor extends string = string> {
+  $dynamicAnchor: Anchor
+}
+// ------------------------------------------------------------------
+// Guard
+// ------------------------------------------------------------------
+/** 
+ * Returns true if the schema contains a valid $dynamicAnchor property
+ */
+export function IsDynamicAnchor(schema: XSchemaObject): schema is XDynamicAnchor {
+  return Guard.HasPropertyKey(schema, '$dynamicAnchor') 
+    && Guard.IsString(schema.$dynamicAnchor)
+}

src/schema/types/dynamicRef.ts

@@ -0,0 +1,49 @@
+/*--------------------------------------------------------------------------
+
+TypeBox
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2025 Haydn Paterson 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
+
+// deno-fmt-ignore-file
+
+import { Guard } from '../../guard/index.ts'
+import { type XSchemaObject } from './schema.ts'
+
+// ------------------------------------------------------------------
+// Type
+// ------------------------------------------------------------------
+export interface XDynamicRef<Ref extends string = string> {
+  $dynamicRef: Ref
+}
+// ------------------------------------------------------------------
+// Guard
+// ------------------------------------------------------------------
+/** 
+ * Returns true if the schema contains a valid $dynamicRef property
+ */
+export function IsDynamicRef(schema: XSchemaObject): schema is XDynamicRef {
+  return Guard.HasPropertyKey(schema, '$dynamicRef') 
+    && Guard.IsString(schema.$dynamicRef)
+}

src/schema/types/index.ts

@@ -35,9 +35,10 @@ export * from './_refine.ts'
 // ------------------------------------------------------------------
 // Standard
 // ------------------------------------------------------------------
-export * from './additionalProperties.ts'
 export * from './additionalItems.ts'
+export * from './additionalProperties.ts'
 export * from './allOf.ts'
+export * from './anchor.ts'
 export * from './anyOf.ts'
 export * from './const.ts'
 export * from './contains.ts'
@@ -46,6 +47,10 @@ export * from './contentMediaType.ts'
 export * from './default.ts'
 export * from './defs.ts'
 export * from './dependencies.ts'
+export * from './dependentRequired.ts'
+export * from './dependentSchemas.ts'
+export * from './dynamicAnchor.ts'
+export * from './dynamicRef.ts'
 export * from './else.ts'
 export * from './enum.ts'
 export * from './exclusiveMaximum.ts'
@@ -55,10 +60,12 @@ export * from './id.ts'
 export * from './if.ts'
 export * from './items.ts'
 export * from './maximum.ts'
+export * from './maxContains.ts'
 export * from './maxItems.ts'
 export * from './maxLength.ts'
 export * from './maxProperties.ts'
 export * from './minimum.ts'
+export * from './minContains.ts'
 export * from './minItems.ts'
 export * from './minLength.ts'
 export * from './minProperties.ts'
@@ -73,13 +80,9 @@ export * from './propertyNames.ts'
 export * from './ref.ts'
 export * from './required.ts'
 export * from './schema.ts'
+export * from './schema.ts'
 export * from './then.ts'
 export * from './type.ts'
 export * from './uniqueItems.ts'
-export * from './dependentRequired.ts'
-export * from './dependentSchemas.ts'
-export * from './minContains.ts'
-export * from './maxContains.ts'
 export * from './unevaluatedItems.ts'
 export * from './unevaluatedProperties.ts'
-export * from './schema.ts'

tasks.ts

@@ -8,7 +8,7 @@ import { Range } from './task/range/index.ts'
 import { Metrics } from './task/metrics/index.ts'
 import { Task } from 'tasksmith'
 
-const Version = '1.0.38'
+const Version = '1.0.39'
 
 // ------------------------------------------------------------------
 // Build

test/typebox/runtime/schema/types/anchor.ts

@@ -0,0 +1,17 @@
+import Schema from 'typebox/schema'
+import { Assert } from 'test'
+
+const Test = Assert.Context('Schema.IsAnchor')
+
+Test('Should Guard 1', () => {
+  Assert.IsTrue(Schema.IsAnchor({ $anchor: 'my-ref' }))
+})
+Test('Should Guard 2', () => {
+  Assert.IsFalse(Schema.IsAnchor({ $anchor: 123 }))
+})
+Test('Should Guard 3', () => {
+  Assert.IsFalse(Schema.IsAnchor({ $anchor: null }))
+})
+Test('Should Guard 4', () => {
+  Assert.IsFalse(Schema.IsAnchor({}))
+})

test/typebox/runtime/schema/types/dynamicAnchor.ts

@@ -0,0 +1,17 @@
+import Schema from 'typebox/schema'
+import { Assert } from 'test'
+
+const Test = Assert.Context('Schema.IsDynamicAnchor')
+
+Test('Should Guard 1', () => {
+  Assert.IsTrue(Schema.IsDynamicAnchor({ $dynamicAnchor: 'my-ref' }))
+})
+Test('Should Guard 2', () => {
+  Assert.IsFalse(Schema.IsDynamicAnchor({ $dynamicAnchor: 123 }))
+})
+Test('Should Guard 3', () => {
+  Assert.IsFalse(Schema.IsDynamicAnchor({ $dynamicAnchor: null }))
+})
+Test('Should Guard 4', () => {
+  Assert.IsFalse(Schema.IsDynamicAnchor({}))
+})

test/typebox/runtime/schema/types/dynamicRef.ts

@@ -0,0 +1,17 @@
+import Schema from 'typebox/schema'
+import { Assert } from 'test'
+
+const Test = Assert.Context('Schema.IsDynamicRef')
+
+Test('Should Guard 1', () => {
+  Assert.IsTrue(Schema.IsDynamicRef({ $dynamicRef: 'my-ref' }))
+})
+Test('Should Guard 2', () => {
+  Assert.IsFalse(Schema.IsDynamicRef({ $dynamicRef: 123 }))
+})
+Test('Should Guard 3', () => {
+  Assert.IsFalse(Schema.IsDynamicRef({ $dynamicRef: null }))
+})
+Test('Should Guard 4', () => {
+  Assert.IsFalse(Schema.IsDynamicRef({}))
+})