@twin.org/document-management-models 0.0.1-next.4 → 0.0.1-next.6

package/dist/cjs/index.cjs

@@ -3,10 +3,10 @@
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * The types of document management objects.
+ * The contexts of document management objects.
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const DocumentTypes = {
+const DocumentContexts = {
     /**
      * The context root for the document types.
      */
@@ -14,7 +14,16 @@ const DocumentTypes = {
     /**
      * The context root for the common types.
      */
-    ContextRootCommon: "https://schema.twindev.org/common/",
+    ContextRootCommon: "https://schema.twindev.org/common/"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of document management objects.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const DocumentTypes = {
     /**
      * Represents a document.
      */
@@ -29,4 +38,5 @@ const DocumentTypes = {
     DocumentList: "DocumentList"
 };
 
+exports.DocumentContexts = DocumentContexts;
 exports.DocumentTypes = DocumentTypes;

package/dist/esm/index.mjs

@@ -1,10 +1,10 @@
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * The types of document management objects.
+ * The contexts of document management objects.
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const DocumentTypes = {
+const DocumentContexts = {
     /**
      * The context root for the document types.
      */
@@ -12,7 +12,16 @@ const DocumentTypes = {
     /**
      * The context root for the common types.
      */
-    ContextRootCommon: "https://schema.twindev.org/common/",
+    ContextRootCommon: "https://schema.twindev.org/common/"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of document management objects.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const DocumentTypes = {
     /**
      * Represents a document.
      */
@@ -27,4 +36,4 @@ const DocumentTypes = {
     DocumentList: "DocumentList"
 };
 
-export { DocumentTypes };
+export { DocumentContexts, DocumentTypes };

package/dist/types/index.d.ts

@@ -4,7 +4,8 @@ export * from "./models/api/IDocumentManagementQueryRequest";
 export * from "./models/api/IDocumentManagementQueryResponse";
 export * from "./models/api/IDocumentManagementRemoveRequest";
 export * from "./models/api/IDocumentManagementSetRequest";
-export * from "./models/documentDataTypes";
+export * from "./models/documentContexts";
+export * from "./models/documentTypes";
 export * from "./models/IDocument";
 export * from "./models/IDocumentAttestation";
 export * from "./models/IDocumentList";

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

@@ -1,9 +1,10 @@
 import type { IAttestationInformation } from "@twin.org/attestation-models";
 import type { IBlobStorageEntry } from "@twin.org/blob-storage-models";
 import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { SchemaOrgTypes } from "@twin.org/standards-schema-org";
+import type { SchemaOrgContexts } from "@twin.org/standards-schema-org";
 import type { UneceDocumentCodes } from "@twin.org/standards-unece";
-import type { DocumentTypes } from "./documentDataTypes";
+import type { DocumentContexts } from "./documentContexts";
+import type { DocumentTypes } from "./documentTypes";
 /**
  * Interface describing a document.
  */
@@ -12,9 +13,9 @@ export interface IDocument {
      * JSON-LD Context.
      */
     "@context": [
-        typeof DocumentTypes.ContextRoot,
-        typeof DocumentTypes.ContextRootCommon,
-        typeof SchemaOrgTypes.ContextRoot,
+        typeof DocumentContexts.ContextRoot,
+        typeof DocumentContexts.ContextRootCommon,
+        typeof SchemaOrgContexts.ContextRoot,
         ...IJsonLdContextDefinitionElement[]
     ];
     /**

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

@@ -1,6 +1,7 @@
-import type { SchemaOrgTypes } from "@twin.org/standards-schema-org";
+import type { SchemaOrgContexts } from "@twin.org/standards-schema-org";
 import type { UneceDocumentCodes } from "@twin.org/standards-unece";
-import type { DocumentTypes } from "./documentDataTypes";
+import type { DocumentContexts } from "./documentContexts";
+import type { DocumentTypes } from "./documentTypes";
 /**
  * Interface describing a document attestation.
  */
@@ -9,9 +10,9 @@ export interface IDocumentAttestation {
      * JSON-LD Context.
      */
     "@context": [
-        typeof DocumentTypes.ContextRoot,
-        typeof DocumentTypes.ContextRootCommon,
-        typeof SchemaOrgTypes.ContextRoot
+        typeof DocumentContexts.ContextRoot,
+        typeof DocumentContexts.ContextRootCommon,
+        typeof SchemaOrgContexts.ContextRoot
     ];
     /**
      * JSON-LD Type.

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

@@ -1,5 +1,6 @@
 import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
-import type { DocumentTypes } from "./documentDataTypes";
+import type { DocumentContexts } from "./documentContexts";
+import type { DocumentTypes } from "./documentTypes";
 import type { IDocument } from "./IDocument";
 /**
  * Interface describing a document entry list.
@@ -9,8 +10,8 @@ export interface IDocumentList {
      * JSON-LD Context.
      */
     "@context": [
-        typeof DocumentTypes.ContextRoot,
-        typeof DocumentTypes.ContextRootCommon,
+        typeof DocumentContexts.ContextRoot,
+        typeof DocumentContexts.ContextRootCommon,
         ...IJsonLdContextDefinitionElement[]
     ];
     /**

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

@@ -0,0 +1,17 @@
+/**
+ * The contexts of document management objects.
+ */
+export declare const DocumentContexts: {
+    /**
+     * The context root for the document types.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/documents/";
+    /**
+     * The context root for the common types.
+     */
+    readonly ContextRootCommon: "https://schema.twindev.org/common/";
+};
+/**
+ * The contexts of document management objects.
+ */
+export type DocumentContexts = (typeof DocumentContexts)[keyof typeof DocumentContexts];

package/dist/types/models/{documentDataTypes.d.ts → documentTypes.d.ts}

@@ -2,14 +2,6 @@
  * The types of document management objects.
  */
 export declare const DocumentTypes: {
-    /**
-     * The context root for the document types.
-     */
-    readonly ContextRoot: "https://schema.twindev.org/documents/";
-    /**
-     * The context root for the common types.
-     */
-    readonly ContextRootCommon: "https://schema.twindev.org/common/";
     /**
      * Represents a document.
      */

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/document-management-models - Changelog
 
-## v0.0.1-next.4
+## v0.0.1-next.6
 
 - Initial Release

package/docs/reference/index.md

@@ -15,8 +15,10 @@
 
 ## Type Aliases
 
+- [DocumentContexts](type-aliases/DocumentContexts.md)
 - [DocumentTypes](type-aliases/DocumentTypes.md)
 
 ## Variables
 
+- [DocumentContexts](variables/DocumentContexts.md)
 - [DocumentTypes](variables/DocumentTypes.md)

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

@@ -0,0 +1,5 @@
+# Type Alias: DocumentContexts
+
+> **DocumentContexts**: *typeof* [`DocumentContexts`](../variables/DocumentContexts.md)\[keyof *typeof* [`DocumentContexts`](../variables/DocumentContexts.md)\]
+
+The contexts of document management objects.

package/docs/reference/variables/DocumentContexts.md

@@ -0,0 +1,19 @@
+# Variable: DocumentContexts
+
+> `const` **DocumentContexts**: `object`
+
+The contexts of document management objects.
+
+## Type declaration
+
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://schema.twindev.org/documents/"` = `"https://schema.twindev.org/documents/"`
+
+The context root for the document 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/DocumentTypes.md

@@ -6,18 +6,6 @@ The types of document management objects.
 
 ## Type declaration
 
-### ContextRoot
-
-> `readonly` **ContextRoot**: `"https://schema.twindev.org/documents/"` = `"https://schema.twindev.org/documents/"`
-
-The context root for the document types.
-
-### ContextRootCommon
-
-> `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
-
-The context root for the common types.
-
 ### Document
 
 > `readonly` **Document**: `"Document"` = `"Document"`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/document-management-models",
-	"version": "0.0.1-next.4",
+	"version": "0.0.1-next.6",
 	"description": "Models which define the structure of the document management connectors and services",
 	"repository": {
 		"type": "git",