@twin.org/data-framework 0.0.1-next.3 → 0.0.1-next.30

package/dist/cjs/index.cjs

@@ -3,6 +3,19 @@
 var core = require('@twin.org/core');
 var dataCore = require('@twin.org/data-core');
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The contexts of framework data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const FrameworkContexts = {
+    /**
+     * Context Root.
+     */
+    ContextRoot: "https://schema.twindev.org/framework/"
+};
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -13,15 +26,15 @@ const FrameworkTypes = {
     /**
      * Represents a urn.
      */
-    Urn: "https://schema.twindev.org/framework/URN",
+    Urn: "URN",
     /**
      * Represents a timestamp as an integer, milliseconds since 1 Jan 1970.
      */
-    TimestampMilliseconds: "https://schema.twindev.org/framework/TimestampMilliseconds",
+    TimestampMilliseconds: "TimestampMilliseconds",
     /**
      * Represents a timestamp as an integer, seconds since 1 Jan 1970.
      */
-    TimestampSeconds: "https://schema.twindev.org/framework/TimestampSeconds"
+    TimestampSeconds: "TimestampSeconds"
 };
 
 var type$2 = "integer";
@@ -55,19 +68,19 @@ class FrameworkDataTypes {
      * Register all the data types.
      */
     static registerTypes() {
-        dataCore.DataTypeHandlerFactory.register(FrameworkTypes.Urn, () => ({
+        dataCore.DataTypeHandlerFactory.register(`${FrameworkContexts.ContextRoot}${FrameworkTypes.Urn}`, () => ({
             type: FrameworkTypes.Urn,
             defaultValue: "",
             jsonSchema: async () => URNSchema,
             validate: async (propertyName, value, failures, container) => core.Urn.validate(propertyName, value, failures)
         }));
-        dataCore.DataTypeHandlerFactory.register(FrameworkTypes.TimestampMilliseconds, () => ({
+        dataCore.DataTypeHandlerFactory.register(`${FrameworkContexts.ContextRoot}${FrameworkTypes.TimestampMilliseconds}`, () => ({
             type: FrameworkTypes.TimestampMilliseconds,
             defaultValue: Date.now(),
             jsonSchema: async () => TimestampMillisecondsSchema,
             validate: async (propertyName, value, failures, container) => core.Validation.timestampMilliseconds(propertyName, value, failures)
         }));
-        dataCore.DataTypeHandlerFactory.register(FrameworkTypes.TimestampSeconds, () => ({
+        dataCore.DataTypeHandlerFactory.register(`${FrameworkContexts.ContextRoot}${FrameworkTypes.TimestampSeconds}`, () => ({
             type: FrameworkTypes.TimestampSeconds,
             defaultValue: Math.floor(Date.now() / 1000),
             jsonSchema: async () => TimestampSecondsSchema,
@@ -76,5 +89,6 @@ class FrameworkDataTypes {
     }
 }
 
+exports.FrameworkContexts = FrameworkContexts;
 exports.FrameworkDataTypes = FrameworkDataTypes;
 exports.FrameworkTypes = FrameworkTypes;

package/dist/esm/index.mjs

@@ -1,6 +1,19 @@
 import { Urn, Validation } from '@twin.org/core';
 import { DataTypeHandlerFactory } from '@twin.org/data-core';
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The contexts of framework data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const FrameworkContexts = {
+    /**
+     * Context Root.
+     */
+    ContextRoot: "https://schema.twindev.org/framework/"
+};
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -11,15 +24,15 @@ const FrameworkTypes = {
     /**
      * Represents a urn.
      */
-    Urn: "https://schema.twindev.org/framework/URN",
+    Urn: "URN",
     /**
      * Represents a timestamp as an integer, milliseconds since 1 Jan 1970.
      */
-    TimestampMilliseconds: "https://schema.twindev.org/framework/TimestampMilliseconds",
+    TimestampMilliseconds: "TimestampMilliseconds",
     /**
      * Represents a timestamp as an integer, seconds since 1 Jan 1970.
      */
-    TimestampSeconds: "https://schema.twindev.org/framework/TimestampSeconds"
+    TimestampSeconds: "TimestampSeconds"
 };
 
 var type$2 = "integer";
@@ -53,19 +66,19 @@ class FrameworkDataTypes {
      * Register all the data types.
      */
     static registerTypes() {
-        DataTypeHandlerFactory.register(FrameworkTypes.Urn, () => ({
+        DataTypeHandlerFactory.register(`${FrameworkContexts.ContextRoot}${FrameworkTypes.Urn}`, () => ({
             type: FrameworkTypes.Urn,
             defaultValue: "",
             jsonSchema: async () => URNSchema,
             validate: async (propertyName, value, failures, container) => Urn.validate(propertyName, value, failures)
         }));
-        DataTypeHandlerFactory.register(FrameworkTypes.TimestampMilliseconds, () => ({
+        DataTypeHandlerFactory.register(`${FrameworkContexts.ContextRoot}${FrameworkTypes.TimestampMilliseconds}`, () => ({
             type: FrameworkTypes.TimestampMilliseconds,
             defaultValue: Date.now(),
             jsonSchema: async () => TimestampMillisecondsSchema,
             validate: async (propertyName, value, failures, container) => Validation.timestampMilliseconds(propertyName, value, failures)
         }));
-        DataTypeHandlerFactory.register(FrameworkTypes.TimestampSeconds, () => ({
+        DataTypeHandlerFactory.register(`${FrameworkContexts.ContextRoot}${FrameworkTypes.TimestampSeconds}`, () => ({
             type: FrameworkTypes.TimestampSeconds,
             defaultValue: Math.floor(Date.now() / 1000),
             jsonSchema: async () => TimestampSecondsSchema,
@@ -74,4 +87,4 @@ class FrameworkDataTypes {
     }
 }
 
-export { FrameworkDataTypes, FrameworkTypes };
+export { FrameworkContexts, FrameworkDataTypes, FrameworkTypes };

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./dataTypes/frameworkDataTypes";
+export * from "./models/frameworkContexts";
 export * from "./models/frameworkTypes";

package/dist/types/models/frameworkContexts.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The contexts of framework data.
+ */
+export declare const FrameworkContexts: {
+    /**
+     * Context Root.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/framework/";
+};
+/**
+ * The contexts of framework data.
+ */
+export type FrameworkContexts = (typeof FrameworkContexts)[keyof typeof FrameworkContexts];

package/dist/types/models/frameworkTypes.d.ts

@@ -5,15 +5,15 @@ export declare const FrameworkTypes: {
     /**
      * Represents a urn.
      */
-    readonly Urn: "https://schema.twindev.org/framework/URN";
+    readonly Urn: "URN";
     /**
      * Represents a timestamp as an integer, milliseconds since 1 Jan 1970.
      */
-    readonly TimestampMilliseconds: "https://schema.twindev.org/framework/TimestampMilliseconds";
+    readonly TimestampMilliseconds: "TimestampMilliseconds";
     /**
      * Represents a timestamp as an integer, seconds since 1 Jan 1970.
      */
-    readonly TimestampSeconds: "https://schema.twindev.org/framework/TimestampSeconds";
+    readonly TimestampSeconds: "TimestampSeconds";
 };
 /**
  * The types of framework data.

package/docs/changelog.md

@@ -1,5 +1,35 @@
 # @twin.org/data-framework - Changelog
 
-## v0.0.1-next.3
+## [0.0.1-next.30](https://github.com/twinfoundation/data/compare/data-framework-v0.0.1-next.29...data-framework-v0.0.1-next.30) (2025-04-17)
+
+
+### Features
+
+* use shared store mechanism ([#3](https://github.com/twinfoundation/data/issues/3)) ([33eb221](https://github.com/twinfoundation/data/commit/33eb221ccec2b4a79549c06e9a04225009b93a46))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-core bumped from 0.0.1-next.29 to 0.0.1-next.30
+    * @twin.org/data-json-ld bumped from 0.0.1-next.29 to 0.0.1-next.30
+
+## [0.0.1-next.29](https://github.com/twinfoundation/data/compare/data-framework-v0.0.1-next.28...data-framework-v0.0.1-next.29) (2025-03-28)
+
+
+### Features
+
+* add document cache access methods ([dbf1e36](https://github.com/twinfoundation/data/commit/dbf1e36d176c5f428f8c52628fb5a1ff7a6a174a))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-core bumped from 0.0.1-next.28 to 0.0.1-next.29
+    * @twin.org/data-json-ld bumped from 0.0.1-next.28 to 0.0.1-next.29
+
+## v0.0.1-next.28
 
 - Initial Release

package/docs/reference/classes/FrameworkDataTypes.md

@@ -4,13 +4,13 @@ Handle all the framework data types.
 
 ## Constructors
 
-### new FrameworkDataTypes()
+### Constructor
 
-> **new FrameworkDataTypes**(): [`FrameworkDataTypes`](FrameworkDataTypes.md)
+> **new FrameworkDataTypes**(): `FrameworkDataTypes`
 
 #### Returns
 
-[`FrameworkDataTypes`](FrameworkDataTypes.md)
+`FrameworkDataTypes`
 
 ## Methods
 

package/docs/reference/index.md

@@ -6,8 +6,10 @@
 
 ## Type Aliases
 
+- [FrameworkContexts](type-aliases/FrameworkContexts.md)
 - [FrameworkTypes](type-aliases/FrameworkTypes.md)
 
 ## Variables
 
+- [FrameworkContexts](variables/FrameworkContexts.md)
 - [FrameworkTypes](variables/FrameworkTypes.md)

package/docs/reference/type-aliases/FrameworkContexts.md

@@ -0,0 +1,5 @@
+# Type Alias: FrameworkContexts
+
+> **FrameworkContexts** = *typeof* [`FrameworkContexts`](../variables/FrameworkContexts.md)\[keyof *typeof* [`FrameworkContexts`](../variables/FrameworkContexts.md)\]
+
+The contexts of framework data.

package/docs/reference/type-aliases/FrameworkTypes.md

@@ -1,5 +1,5 @@
 # Type Alias: FrameworkTypes
 
-> **FrameworkTypes**: *typeof* [`FrameworkTypes`](../variables/FrameworkTypes.md)\[keyof *typeof* [`FrameworkTypes`](../variables/FrameworkTypes.md)\]
+> **FrameworkTypes** = *typeof* [`FrameworkTypes`](../variables/FrameworkTypes.md)\[keyof *typeof* [`FrameworkTypes`](../variables/FrameworkTypes.md)\]
 
 The types of framework data.

package/docs/reference/variables/FrameworkContexts.md

@@ -0,0 +1,13 @@
+# Variable: FrameworkContexts
+
+> `const` **FrameworkContexts**: `object`
+
+The contexts of framework data.
+
+## Type declaration
+
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://schema.twindev.org/framework/"` = `"https://schema.twindev.org/framework/"`
+
+Context Root.

package/docs/reference/variables/FrameworkTypes.md

@@ -8,18 +8,18 @@ The types of framework data.
 
 ### Urn
 
-> `readonly` **Urn**: `"https://schema.twindev.org/framework/URN"` = `"https://schema.twindev.org/framework/URN"`
+> `readonly` **Urn**: `"URN"` = `"URN"`
 
 Represents a urn.
 
 ### TimestampMilliseconds
 
-> `readonly` **TimestampMilliseconds**: `"https://schema.twindev.org/framework/TimestampMilliseconds"` = `"https://schema.twindev.org/framework/TimestampMilliseconds"`
+> `readonly` **TimestampMilliseconds**: `"TimestampMilliseconds"` = `"TimestampMilliseconds"`
 
 Represents a timestamp as an integer, milliseconds since 1 Jan 1970.
 
 ### TimestampSeconds
 
-> `readonly` **TimestampSeconds**: `"https://schema.twindev.org/framework/TimestampSeconds"` = `"https://schema.twindev.org/framework/TimestampSeconds"`
+> `readonly` **TimestampSeconds**: `"TimestampSeconds"` = `"TimestampSeconds"`
 
 Represents a timestamp as an integer, seconds since 1 Jan 1970.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/data-framework",
-	"version": "0.0.1-next.3",
+	"version": "0.0.1-next.30",
 	"description": "Models which define the structure of framework types",
 	"repository": {
 		"type": "git",
@@ -13,51 +13,24 @@
 	"engines": {
 		"node": ">=20.0.0"
 	},
-	"scripts": {
-		"clean": "rimraf dist coverage docs/reference",
-		"build": "tspc",
-		"test": "vitest --run --config ./vitest.config.ts --no-cache",
-		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
-		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
-		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
-		"bundle": "npm run bundle:esm && npm run bundle:cjs",
-		"docs:clean": "rimraf docs/reference",
-		"docs:generate": "typedoc",
-		"docs": "npm run docs:clean && npm run docs:generate",
-		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
-	},
 	"dependencies": {
 		"@twin.org/core": "next",
-		"@twin.org/data-core": "0.0.1-next.3",
-		"@twin.org/data-json-ld": "0.0.1-next.3",
+		"@twin.org/data-core": "0.0.1-next.30",
+		"@twin.org/data-json-ld": "0.0.1-next.30",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@types/json-schema": "7.0.15"
 	},
-	"devDependencies": {
-		"@twin.org/nameof-transformer": "next",
-		"@rollup/plugin-json": "6.1.0",
-		"@vitest/coverage-v8": "2.1.1",
-		"copyfiles": "2.4.1",
-		"rimraf": "6.0.1",
-		"rollup": "4.22.0",
-		"rollup-plugin-typescript2": "0.36.0",
-		"ts-patch": "3.2.1",
-		"typedoc": "0.26.7",
-		"typedoc-plugin-markdown": "4.2.7",
-		"typescript": "5.6.2",
-		"vitest": "2.1.1"
-	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
-		"./locales": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",