@twin.org/data-framework 0.0.3-next.16 → 0.0.3-next.17

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Framework Data
 
-Models which define the structure of framework types.
+This package provides framework data models that define common structures consumed by other packages in the repository. It centralises shared domain shapes so integrations can rely on clearer contracts and maintain semantic consistency as the ecosystem evolves.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,4 +1,19 @@
-# @twin.org/data-framework - Changelog
+# Changelog
+
+## [0.0.3-next.17](https://github.com/twinfoundation/data/compare/data-framework-v0.0.3-next.16...data-framework-v0.0.3-next.17) (2026-03-12)
+
+
+### Miscellaneous Chores
+
+* **data-framework:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-core bumped from 0.0.3-next.16 to 0.0.3-next.17
+    * @twin.org/data-json-ld bumped from 0.0.3-next.16 to 0.0.3-next.17
 
 ## [0.0.3-next.16](https://github.com/twinfoundation/data/compare/data-framework-v0.0.3-next.15...data-framework-v0.0.3-next.16) (2026-03-06)
 

package/docs/examples.md

@@ -1 +1,30 @@
-# @twin.org/data-framework - Examples
+# Data Framework Examples
+
+These examples show how to register framework data types and validate values against the registered handlers.
+
+## FrameworkDataTypes
+
+```typescript
+import { type IValidationFailure } from '@twin.org/core';
+import { DataTypeHelper, ValidationMode } from '@twin.org/data-core';
+import { FrameworkContexts, FrameworkDataTypes, FrameworkTypes } from '@twin.org/data-framework';
+
+FrameworkDataTypes.registerTypes();
+
+const failures: IValidationFailure[] = [];
+const urnType = `${FrameworkContexts.Namespace}${FrameworkTypes.Urn}`;
+
+const isValidUrn = await DataTypeHelper.validate(
+  'resourceId',
+  urnType,
+  'urn:example:12345',
+  failures,
+  {
+    validationMode: ValidationMode.Both,
+    failOnMissingType: true
+  }
+);
+
+console.log('URN validation result:', isValidUrn);
+console.log('Failure count:', failures.length);
+```

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/data-framework",
-	"version": "0.0.3-next.16",
-	"description": "Models which define the structure of framework types",
+	"version": "0.0.3-next.17",
+	"description": "Framework data models that define common structures used by other packages.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/data.git",
@@ -15,8 +15,8 @@
 	},
 	"dependencies": {
 		"@twin.org/core": "next",
-		"@twin.org/data-core": "0.0.3-next.16",
-		"@twin.org/data-json-ld": "0.0.3-next.16",
+		"@twin.org/data-core": "0.0.3-next.17",
+		"@twin.org/data-json-ld": "0.0.3-next.17",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next"
 	},