@twin.org/data-framework 0.0.1-next.26 → 0.0.1-next.28

package/dist/cjs/index.cjs

@@ -6,14 +6,23 @@ var dataCore = require('@twin.org/data-core');
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * The types of framework data.
+ * The contexts of framework data.
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const FrameworkTypes = {
+const FrameworkContexts = {
     /**
      * Context Root.
      */
-    ContextRoot: "https://schema.twindev.org/framework/",
+    ContextRoot: "https://schema.twindev.org/framework/"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of framework data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const FrameworkTypes = {
     /**
      * Represents a urn.
      */
@@ -59,19 +68,19 @@ class FrameworkDataTypes {
      * Register all the data types.
      */
     static registerTypes() {
-        dataCore.DataTypeHandlerFactory.register(`${FrameworkTypes.ContextRoot}${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.ContextRoot}${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.ContextRoot}${FrameworkTypes.TimestampSeconds}`, () => ({
+        dataCore.DataTypeHandlerFactory.register(`${FrameworkContexts.ContextRoot}${FrameworkTypes.TimestampSeconds}`, () => ({
             type: FrameworkTypes.TimestampSeconds,
             defaultValue: Math.floor(Date.now() / 1000),
             jsonSchema: async () => TimestampSecondsSchema,
@@ -80,5 +89,6 @@ class FrameworkDataTypes {
     }
 }
 
+exports.FrameworkContexts = FrameworkContexts;
 exports.FrameworkDataTypes = FrameworkDataTypes;
 exports.FrameworkTypes = FrameworkTypes;

package/dist/esm/index.mjs

@@ -4,14 +4,23 @@ import { DataTypeHandlerFactory } from '@twin.org/data-core';
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * The types of framework data.
+ * The contexts of framework data.
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const FrameworkTypes = {
+const FrameworkContexts = {
     /**
      * Context Root.
      */
-    ContextRoot: "https://schema.twindev.org/framework/",
+    ContextRoot: "https://schema.twindev.org/framework/"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of framework data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const FrameworkTypes = {
     /**
      * Represents a urn.
      */
@@ -57,19 +66,19 @@ class FrameworkDataTypes {
      * Register all the data types.
      */
     static registerTypes() {
-        DataTypeHandlerFactory.register(`${FrameworkTypes.ContextRoot}${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.ContextRoot}${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.ContextRoot}${FrameworkTypes.TimestampSeconds}`, () => ({
+        DataTypeHandlerFactory.register(`${FrameworkContexts.ContextRoot}${FrameworkTypes.TimestampSeconds}`, () => ({
             type: FrameworkTypes.TimestampSeconds,
             defaultValue: Math.floor(Date.now() / 1000),
             jsonSchema: async () => TimestampSecondsSchema,
@@ -78,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

@@ -2,10 +2,6 @@
  * The types of framework data.
  */
 export declare const FrameworkTypes: {
-    /**
-     * Context Root.
-     */
-    readonly ContextRoot: "https://schema.twindev.org/framework/";
     /**
      * Represents a urn.
      */

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/data-framework - Changelog
 
-## v0.0.1-next.26
+## v0.0.1-next.28
 
 - Initial Release

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/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

@@ -6,12 +6,6 @@ The types of framework data.
 
 ## Type declaration
 
-### ContextRoot
-
-> `readonly` **ContextRoot**: `"https://schema.twindev.org/framework/"` = `"https://schema.twindev.org/framework/"`
-
-Context Root.
-
 ### Urn
 
 > `readonly` **Urn**: `"URN"` = `"URN"`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/data-framework",
-	"version": "0.0.1-next.26",
+	"version": "0.0.1-next.28",
 	"description": "Models which define the structure of framework types",
 	"repository": {
 		"type": "git",
@@ -15,8 +15,8 @@
 	},
 	"dependencies": {
 		"@twin.org/core": "next",
-		"@twin.org/data-core": "0.0.1-next.26",
-		"@twin.org/data-json-ld": "0.0.1-next.26",
+		"@twin.org/data-core": "0.0.1-next.28",
+		"@twin.org/data-json-ld": "0.0.1-next.28",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@types/json-schema": "7.0.15"