@twin.org/tools-core 0.0.3-next.20 → 0.0.3-next.21

package/dist/types/utils/jsonSchemaBuilder.d.ts

@@ -33,6 +33,16 @@ export declare class JsonSchemaBuilder {
      * @throws GeneralError Thrown when a tag key is not supported by IJsonSchema.
      */
     static applyJsonSchemaTags(schema: Partial<IJsonSchema>, node: ts.Node): void;
+    /**
+     * Validate that a @json-schema constraint key is compatible with the given schema type,
+     * and that the raw value is valid for the constraint.
+     * @param schemaKey The mapped schema key being applied.
+     * @param schemaType The type already set on the schema, if any.
+     * @param rawValue The raw string value from the JSDoc tag.
+     * @throws GeneralError Thrown when the constraint is not valid for the schema type.
+     * @throws GeneralError Thrown when the format value is not a recognised JSON Schema format.
+     */
+    static validateJsonSchemaTagConstraint(schemaKey: string, schemaType: string | string[] | undefined, rawValue: string): void;
     /**
      * Determine whether a mapped @json-schema tag key is supported.
      * @param key The mapped schema key.

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.0.3-next.21](https://github.com/twinfoundation/tools/compare/tools-core-v0.0.3-next.20...tools-core-v0.0.3-next.21) (2026-03-20)
+
+
+### Features
+
+* add jsdoc tag validation ([971b8d3](https://github.com/twinfoundation/tools/commit/971b8d3817d40467bfd7549c99af602f0c590299))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/tools-models bumped from 0.0.3-next.20 to 0.0.3-next.21
+
 ## [0.0.3-next.20](https://github.com/twinfoundation/tools/compare/tools-core-v0.0.3-next.19...tools-core-v0.0.3-next.20) (2026-03-20)
 
 

package/docs/reference/classes/JsonSchemaBuilder.md

@@ -100,6 +100,46 @@ GeneralError Thrown when a tag key is not supported by IJsonSchema.
 
 ***
 
+### validateJsonSchemaTagConstraint() {#validatejsonschematagconstraint}
+
+> `static` **validateJsonSchemaTagConstraint**(`schemaKey`, `schemaType`, `rawValue`): `void`
+
+Validate that a
+
+#### Parameters
+
+##### schemaKey
+
+`string`
+
+The mapped schema key being applied.
+
+##### schemaType
+
+`string` \| `string`[] \| `undefined`
+
+The type already set on the schema, if any.
+
+##### rawValue
+
+`string`
+
+The raw string value from the JSDoc tag.
+
+#### Returns
+
+`void`
+
+#### Throws
+
+GeneralError Thrown when the constraint is not valid for the schema type.
+
+#### Throws
+
+GeneralError Thrown when the format value is not a recognised JSON Schema format.
+
+***
+
 ### isAllowedJsonSchemaTagKey() {#isallowedjsonschematagkey}
 
 > `static` **isAllowedJsonSchemaTagKey**(`key`): `boolean`

package/locales/en.json

@@ -2,6 +2,8 @@
 	"error": {
 		"jsonSchemaBuilder": {
 			"invalidJsonSchemaTagKey": "Ignoring invalid @json-schema tag key \"{rawKey}\". Mapped key \"{schemaKey}\" is not supported by JSON Schema.",
+			"constraintOnIncompatibleType": "The @json-schema \"{schemaKey}\" constraint requires type \"{requiredType}\" but the type is \"{schemaType}\".",
+			"invalidFormatValue": "The @json-schema \"format\" value \"{formatValue}\" is not a recognised JSON Schema format. Valid values are: {validFormats}.",
 			"missingTypeReferenceSchema": "Unable to resolve type \"{typeName}\"{importSource} required as base type for utility type. Ensure the type is in the configured packages list or its external package exports TypeScript source files that can be parsed via the AST."
 		}
 	},

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/tools-core",
-	"version": "0.0.3-next.20",
+	"version": "0.0.3-next.21",
 	"description": "Shared utilities and models for tooling packages",
 	"repository": {
 		"type": "git",
@@ -16,7 +16,7 @@
 	"dependencies": {
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",
-		"@twin.org/tools-models": "0.0.3-next.20",
+		"@twin.org/tools-models": "0.0.3-next.21",
 		"glob": "13.0.6"
 	},
 	"main": "./dist/es/index.js",