@twin.org/auditable-item-graph-models 0.0.1-next.28 → 0.0.1-next.29

package/dist/cjs/index.cjs

@@ -9,14 +9,6 @@ var dataCore = require('@twin.org/data-core');
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const AuditableItemGraphTypes = {
-    /**
-     * The context root for the auditable item graph types.
-     */
-    ContextRoot: "https://schema.twindev.org/aig/",
-    /**
-     * The context root for the common types.
-     */
-    ContextRootCommon: "https://schema.twindev.org/common/",
     /**
      * Represents auditable item graph vertex.
      */
@@ -591,6 +583,23 @@ class AuditableItemGraphDataTypes {
     }
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The contexts of auditable item graph data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const AuditableItemGraphContexts = {
+    /**
+     * The context root for the auditable item graph types.
+     */
+    ContextRoot: "https://schema.twindev.org/aig/",
+    /**
+     * The context root for the common types.
+     */
+    ContextRootCommon: "https://schema.twindev.org/common/"
+};
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -629,6 +638,7 @@ const VerifyDepth = {
     All: "all"
 };
 
+exports.AuditableItemGraphContexts = AuditableItemGraphContexts;
 exports.AuditableItemGraphDataTypes = AuditableItemGraphDataTypes;
 exports.AuditableItemGraphTopics = AuditableItemGraphTopics;
 exports.AuditableItemGraphTypes = AuditableItemGraphTypes;

package/dist/esm/index.mjs

@@ -7,14 +7,6 @@ import { DataTypeHandlerFactory } from '@twin.org/data-core';
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const AuditableItemGraphTypes = {
-    /**
-     * The context root for the auditable item graph types.
-     */
-    ContextRoot: "https://schema.twindev.org/aig/",
-    /**
-     * The context root for the common types.
-     */
-    ContextRootCommon: "https://schema.twindev.org/common/",
     /**
      * Represents auditable item graph vertex.
      */
@@ -589,6 +581,23 @@ class AuditableItemGraphDataTypes {
     }
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The contexts of auditable item graph data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const AuditableItemGraphContexts = {
+    /**
+     * The context root for the auditable item graph types.
+     */
+    ContextRoot: "https://schema.twindev.org/aig/",
+    /**
+     * The context root for the common types.
+     */
+    ContextRootCommon: "https://schema.twindev.org/common/"
+};
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -627,4 +636,4 @@ const VerifyDepth = {
     All: "all"
 };
 
-export { AuditableItemGraphDataTypes, AuditableItemGraphTopics, AuditableItemGraphTypes, VerifyDepth };
+export { AuditableItemGraphContexts, AuditableItemGraphDataTypes, AuditableItemGraphTopics, AuditableItemGraphTypes, VerifyDepth };

package/dist/types/index.d.ts

@@ -5,6 +5,7 @@ export * from "./models/api/IAuditableItemGraphGetResponse";
 export * from "./models/api/IAuditableItemGraphListRequest";
 export * from "./models/api/IAuditableItemGraphListResponse";
 export * from "./models/api/IAuditableItemGraphUpdateRequest";
+export * from "./models/auditableItemGraphContexts";
 export * from "./models/auditableItemGraphTopics";
 export * from "./models/auditableItemGraphTypes";
 export * from "./models/eventBus/IAuditableItemGraphEventBusVertexCreated";

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

@@ -1,4 +1,5 @@
 import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts";
 import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
 import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement";
 /**
@@ -8,7 +9,7 @@ export interface IAuditableItemGraphAlias extends IAuditableItemGraphAuditedElem
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
+    "@context": typeof AuditableItemGraphContexts.ContextRoot | [typeof AuditableItemGraphContexts.ContextRoot, ...IJsonLdContextDefinitionElement[]];
     /**
      * The id of the element.
      */

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

@@ -1,5 +1,6 @@
 import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
 import type { IImmutableProofVerification } from "@twin.org/immutable-proof-models";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts";
 import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
 import type { IAuditableItemGraphPatchOperation } from "./IAuditableItemGraphPatchOperation";
 /**
@@ -10,8 +11,8 @@ export interface IAuditableItemGraphChangeset {
      * JSON-LD Context.
      */
     "@context": [
-        typeof AuditableItemGraphTypes.ContextRoot,
-        typeof AuditableItemGraphTypes.ContextRootCommon,
+        typeof AuditableItemGraphContexts.ContextRoot,
+        typeof AuditableItemGraphContexts.ContextRootCommon,
         ...IJsonLdContextDefinitionElement[]
     ];
     /**

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

@@ -1,4 +1,5 @@
 import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts";
 import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
 import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement";
 /**
@@ -8,7 +9,7 @@ export interface IAuditableItemGraphEdge extends IAuditableItemGraphAuditedEleme
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
+    "@context": typeof AuditableItemGraphContexts.ContextRoot | [typeof AuditableItemGraphContexts.ContextRoot, ...IJsonLdContextDefinitionElement[]];
     /**
      * The id of the element.
      */

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

@@ -1,4 +1,5 @@
 import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts";
 import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
 /**
  * The patch operation for JSON diffs.
@@ -7,7 +8,7 @@ export interface IAuditableItemGraphPatchOperation {
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
+    "@context": typeof AuditableItemGraphContexts.ContextRoot | [typeof AuditableItemGraphContexts.ContextRoot, ...IJsonLdContextDefinitionElement[]];
     /**
      * JSON-LD Type.
      */

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

@@ -1,4 +1,5 @@
 import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts";
 import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
 import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement";
 /**
@@ -8,7 +9,7 @@ export interface IAuditableItemGraphResource extends IAuditableItemGraphAuditedE
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
+    "@context": typeof AuditableItemGraphContexts.ContextRoot | [typeof AuditableItemGraphContexts.ContextRoot, ...IJsonLdContextDefinitionElement[]];
     /**
      * JSON-LD Type.
      */

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

@@ -1,4 +1,5 @@
 import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts";
 import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
 import type { IAuditableItemGraphAlias } from "./IAuditableItemGraphAlias";
 import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement";
@@ -13,8 +14,8 @@ export interface IAuditableItemGraphVertex extends Omit<IAuditableItemGraphAudit
      * JSON-LD Context.
      */
     "@context": [
-        typeof AuditableItemGraphTypes.ContextRoot,
-        typeof AuditableItemGraphTypes.ContextRootCommon,
+        typeof AuditableItemGraphContexts.ContextRoot,
+        typeof AuditableItemGraphContexts.ContextRootCommon,
         ...IJsonLdContextDefinitionElement[]
     ];
     /**

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

@@ -1,4 +1,5 @@
 import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts";
 import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
 import type { IAuditableItemGraphVertex } from "./IAuditableItemGraphVertex";
 /**
@@ -8,7 +9,7 @@ export interface IAuditableItemGraphVertexList {
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
+    "@context": typeof AuditableItemGraphContexts.ContextRoot | [typeof AuditableItemGraphContexts.ContextRoot, ...IJsonLdContextDefinitionElement[]];
     /**
      * JSON-LD Type.
      */

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

@@ -0,0 +1,17 @@
+/**
+ * The contexts of auditable item graph data.
+ */
+export declare const AuditableItemGraphContexts: {
+    /**
+     * The context root for the auditable item graph types.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/aig/";
+    /**
+     * The context root for the common types.
+     */
+    readonly ContextRootCommon: "https://schema.twindev.org/common/";
+};
+/**
+ * The contexts of auditable item graph data.
+ */
+export type AuditableItemGraphContexts = (typeof AuditableItemGraphContexts)[keyof typeof AuditableItemGraphContexts];

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

@@ -2,14 +2,6 @@
  * The types of auditable item graph data.
  */
 export declare const AuditableItemGraphTypes: {
-    /**
-     * The context root for the auditable item graph types.
-     */
-    readonly ContextRoot: "https://schema.twindev.org/aig/";
-    /**
-     * The context root for the common types.
-     */
-    readonly ContextRootCommon: "https://schema.twindev.org/common/";
     /**
      * Represents auditable item graph vertex.
      */

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/auditable-item-graph-models - Changelog
 
-## v0.0.1-next.28
+## v0.0.1-next.29
 
 - Initial Release

package/docs/reference/index.md

@@ -26,12 +26,14 @@
 
 ## Type Aliases
 
+- [AuditableItemGraphContexts](type-aliases/AuditableItemGraphContexts.md)
 - [AuditableItemGraphTopics](type-aliases/AuditableItemGraphTopics.md)
 - [AuditableItemGraphTypes](type-aliases/AuditableItemGraphTypes.md)
 - [VerifyDepth](type-aliases/VerifyDepth.md)
 
 ## Variables
 
+- [AuditableItemGraphContexts](variables/AuditableItemGraphContexts.md)
 - [AuditableItemGraphTopics](variables/AuditableItemGraphTopics.md)
 - [AuditableItemGraphTypes](variables/AuditableItemGraphTypes.md)
 - [VerifyDepth](variables/VerifyDepth.md)

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

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

package/docs/reference/variables/AuditableItemGraphContexts.md

@@ -0,0 +1,19 @@
+# Variable: AuditableItemGraphContexts
+
+> `const` **AuditableItemGraphContexts**: `object`
+
+The contexts of auditable item graph data.
+
+## Type declaration
+
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://schema.twindev.org/aig/"` = `"https://schema.twindev.org/aig/"`
+
+The context root for the auditable item graph types.
+
+### ContextRootCommon
+
+> `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
+
+The context root for the common types.

package/docs/reference/variables/AuditableItemGraphTypes.md

@@ -6,18 +6,6 @@ The types of auditable item graph data.
 
 ## Type declaration
 
-### ContextRoot
-
-> `readonly` **ContextRoot**: `"https://schema.twindev.org/aig/"` = `"https://schema.twindev.org/aig/"`
-
-The context root for the auditable item graph types.
-
-### ContextRootCommon
-
-> `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
-
-The context root for the common types.
-
 ### Vertex
 
 > `readonly` **Vertex**: `"AuditableItemGraphVertex"` = `"AuditableItemGraphVertex"`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/auditable-item-graph-models",
-	"version": "0.0.1-next.28",
+	"version": "0.0.1-next.29",
 	"description": "Models which define the structure of the auditable item graph connectors and services",
 	"repository": {
 		"type": "git",