@twin.org/document-management-models 0.0.3-next.10 → 0.0.3-next.12

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Document Management Models
 
-Models which define the structure of the document management contracts and connectors.
+This package defines the core document data structures, JSON-LD contexts, and schema-aligned model contracts used across the repository. It provides a single source of truth for payload shape and semantic consistency between services and client integrations.
 
 ## Installation
 

package/dist/es/models/IDocument.js.map

@@ -1 +1 @@
-{"version":3,"file":"IDocument.js","sourceRoot":"","sources":["../../../src/models/IDocument.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAttestationInformation } from \"@twin.org/attestation-models\";\nimport type { IBlobStorageEntry } from \"@twin.org/blob-storage-models\";\nimport type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { SchemaOrgContexts } from \"@twin.org/standards-schema-org\";\nimport type { UneceDocumentCodeList } from \"@twin.org/standards-unece\";\nimport type { DocumentContexts } from \"./documentContexts.js\";\nimport type { DocumentTypes } from \"./documentTypes.js\";\n\n/**\n * Interface describing a document.\n */\nexport interface IDocument {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof SchemaOrgContexts.Context,\n\t\ttypeof DocumentContexts.Context,\n\t\ttypeof DocumentContexts.ContextCommon,\n\t\t...IJsonLdContextDefinitionElement[]\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof DocumentTypes.Document;\n\n\t/**\n\t * The full id of the document.\n\t */\n\tid: string;\n\n\t/**\n\t * The id of the document.\n\t * json-ld type:schema:identifier\n\t */\n\tdocumentId: string;\n\n\t/**\n\t * The format of the document id.\n\t * json-ld type:schema:Text\n\t */\n\tdocumentIdFormat?: string;\n\n\t/**\n\t * The code for the document type.\n\t * json-ld type:schema:identifier\n\t */\n\tdocumentCode: UneceDocumentCodeList;\n\n\t/**\n\t * The revision of the document as a 0 based index.\n\t * json-ld type:schema:Integer\n\t */\n\tdocumentRevision: number;\n\n\t/**\n\t * Additional annotation information for the document.\n\t * json-ld namespace:twin-common\n\t */\n\tannotationObject?: IJsonLdNodeObject;\n\n\t/**\n\t * The blob storage id for the document.\n\t * json-ld type:schema:identifier\n\t */\n\tblobStorageId: string;\n\n\t/**\n\t * The integrity of the blob data.\n\t * json-ld namespace:twin-common\n\t */\n\tintegrity: string;\n\n\t/**\n\t * The additional JSON-LD for blob storage if it was requested.\n\t * json-ld id\n\t */\n\tblobStorageEntry?: IBlobStorageEntry;\n\n\t/**\n\t * The data extracted from the document using data extraction services.\n\t * json-ld type:json\n\t */\n\textractedData?: unknown;\n\n\t/**\n\t * The attestation for the document if one was created.\n\t * json-ld type:schema:identifier\n\t */\n\tattestationId?: string;\n\n\t/**\n\t * The additional JSON-LD for attestation storage if it was requested.\n\t * json-ld id\n\t */\n\tattestationInformation?: IAttestationInformation;\n\n\t/**\n\t * The date/time of when the document was created.\n\t * json-ld namespace:schema\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The date/time of when the document was modified.\n\t * json-ld namespace:schema\n\t */\n\tdateModified?: string;\n\n\t/**\n\t * The date/time of when the document was deleted, as we never actually remove items.\n\t * json-ld namespace:schema\n\t */\n\tdateDeleted?: string;\n\n\t/**\n\t * The organization which added the document to the graph.\n\t * json-ld namespace:twin-common\n\t */\n\torganizationIdentity?: string;\n\n\t/**\n\t * The user who added the document to the graph.\n\t * json-ld namespace:twin-common\n\t */\n\tuserIdentity?: string;\n}\n"]}
+{"version":3,"file":"IDocument.js","sourceRoot":"","sources":["../../../src/models/IDocument.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAttestationInformation } from \"@twin.org/attestation-models\";\nimport type { IBlobStorageEntry } from \"@twin.org/blob-storage-models\";\nimport type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { SchemaOrgContexts } from \"@twin.org/standards-schema-org\";\nimport type { UneceDocumentCodeList } from \"@twin.org/standards-unece\";\nimport type { DocumentContexts } from \"./documentContexts.js\";\nimport type { DocumentTypes } from \"./documentTypes.js\";\n\n/**\n * Interface describing a document.\n */\nexport interface IDocument {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof SchemaOrgContexts.Context,\n\t\ttypeof DocumentContexts.Context,\n\t\ttypeof DocumentContexts.ContextCommon,\n\t\t...IJsonLdContextDefinitionElement[]\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof DocumentTypes.Document;\n\n\t/**\n\t * The full id of the document.\n\t */\n\tid: string;\n\n\t/**\n\t * The id of the document.\n\t * @json-ld type:schema:identifier\n\t */\n\tdocumentId: string;\n\n\t/**\n\t * The format of the document id.\n\t * @json-ld type:schema:Text\n\t */\n\tdocumentIdFormat?: string;\n\n\t/**\n\t * The code for the document type.\n\t * @json-ld type:schema:identifier\n\t */\n\tdocumentCode: UneceDocumentCodeList;\n\n\t/**\n\t * The revision of the document as a 0 based index.\n\t * @json-ld type:schema:Integer\n\t */\n\tdocumentRevision: number;\n\n\t/**\n\t * Additional annotation information for the document.\n\t * @json-ld namespace:twin-common\n\t */\n\tannotationObject?: IJsonLdNodeObject;\n\n\t/**\n\t * The blob storage id for the document.\n\t * @json-ld type:schema:identifier\n\t */\n\tblobStorageId: string;\n\n\t/**\n\t * The integrity of the blob data.\n\t * @json-ld namespace:twin-common\n\t */\n\tintegrity: string;\n\n\t/**\n\t * The additional JSON-LD for blob storage if it was requested.\n\t * @json-ld id\n\t */\n\tblobStorageEntry?: IBlobStorageEntry;\n\n\t/**\n\t * The data extracted from the document using data extraction services.\n\t * @json-ld type:json\n\t */\n\textractedData?: unknown;\n\n\t/**\n\t * The attestation for the document if one was created.\n\t * @json-ld type:schema:identifier\n\t */\n\tattestationId?: string;\n\n\t/**\n\t * The additional JSON-LD for attestation storage if it was requested.\n\t * @json-ld id\n\t */\n\tattestationInformation?: IAttestationInformation;\n\n\t/**\n\t * The date/time of when the document was created.\n\t * @json-ld namespace:schema\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The date/time of when the document was modified.\n\t * @json-ld namespace:schema\n\t */\n\tdateModified?: string;\n\n\t/**\n\t * The date/time of when the document was deleted, as we never actually remove items.\n\t * @json-ld namespace:schema\n\t */\n\tdateDeleted?: string;\n\n\t/**\n\t * The organization which added the document to the graph.\n\t * @json-ld namespace:twin-common\n\t */\n\torganizationIdentity?: string;\n\n\t/**\n\t * The user who added the document to the graph.\n\t * @json-ld namespace:twin-common\n\t */\n\tuserIdentity?: string;\n}\n"]}

package/dist/es/models/IDocumentAttestation.js.map

@@ -1 +1 @@
-{"version":3,"file":"IDocumentAttestation.js","sourceRoot":"","sources":["../../../src/models/IDocumentAttestation.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { SchemaOrgContexts } from \"@twin.org/standards-schema-org\";\nimport type { UneceDocumentCodeList } from \"@twin.org/standards-unece\";\nimport type { DocumentContexts } from \"./documentContexts.js\";\nimport type { DocumentTypes } from \"./documentTypes.js\";\n\n/**\n * Interface describing a document attestation.\n */\nexport interface IDocumentAttestation {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof SchemaOrgContexts.Context,\n\t\ttypeof DocumentContexts.Context,\n\t\ttypeof DocumentContexts.ContextCommon\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof DocumentTypes.DocumentAttestation;\n\n\t/**\n\t * The id of the document.\n\t * json-ld type:schema:identifier\n\t */\n\tdocumentId: string;\n\n\t/**\n\t * The code for the document type.\n\t * json-ld type:schema:identifier\n\t */\n\tdocumentCode: UneceDocumentCodeList;\n\n\t/**\n\t * The revision of the document as a 0 based index.\n\t * json-ld type:schema:Integer\n\t */\n\tdocumentRevision: number;\n\n\t/**\n\t * The date/time of when the document was created.\n\t * json-ld namespace:schema\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The integrity of the document being attested.\n\t * json-ld namespace:twin-common\n\t */\n\tintegrity: string;\n}\n"]}
+{"version":3,"file":"IDocumentAttestation.js","sourceRoot":"","sources":["../../../src/models/IDocumentAttestation.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { SchemaOrgContexts } from \"@twin.org/standards-schema-org\";\nimport type { UneceDocumentCodeList } from \"@twin.org/standards-unece\";\nimport type { DocumentContexts } from \"./documentContexts.js\";\nimport type { DocumentTypes } from \"./documentTypes.js\";\n\n/**\n * Interface describing a document attestation.\n */\nexport interface IDocumentAttestation {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof SchemaOrgContexts.Context,\n\t\ttypeof DocumentContexts.Context,\n\t\ttypeof DocumentContexts.ContextCommon\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof DocumentTypes.DocumentAttestation;\n\n\t/**\n\t * The id of the document.\n\t * @json-ld type:schema:identifier\n\t */\n\tdocumentId: string;\n\n\t/**\n\t * The code for the document type.\n\t * @json-ld type:schema:identifier\n\t */\n\tdocumentCode: UneceDocumentCodeList;\n\n\t/**\n\t * The revision of the document as a 0 based index.\n\t * @json-ld type:schema:Integer\n\t */\n\tdocumentRevision: number;\n\n\t/**\n\t * The date/time of when the document was created.\n\t * @json-ld namespace:schema\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The integrity of the document being attested.\n\t * @json-ld namespace:twin-common\n\t */\n\tintegrity: string;\n}\n"]}

package/dist/es/models/IDocumentList.js.map

@@ -1 +1 @@
-{"version":3,"file":"IDocumentList.js","sourceRoot":"","sources":["../../../src/models/IDocumentList.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement } from \"@twin.org/data-json-ld\";\nimport type { SchemaOrgContexts, SchemaOrgTypes } from \"@twin.org/standards-schema-org\";\nimport type { DocumentContexts } from \"./documentContexts.js\";\nimport type { IDocument } from \"./IDocument.js\";\n\n/**\n * Interface describing a list of document entries.\n */\nexport interface IDocumentList {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof SchemaOrgContexts.Context,\n\t\ttypeof DocumentContexts.Context,\n\t\ttypeof DocumentContexts.ContextCommon,\n\t\t...IJsonLdContextDefinitionElement[]\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof SchemaOrgTypes.ItemList;\n\n\t/**\n\t * The list of documents.\n\t * json-ld namespace:schema\n\t */\n\t[SchemaOrgTypes.ItemListElement]: IDocument[];\n\n\t/**\n\t * The ids of the other vertices which are connected to the document.\n\t * json-ld container:set\n\t */\n\tedges?: string[];\n}\n"]}
+{"version":3,"file":"IDocumentList.js","sourceRoot":"","sources":["../../../src/models/IDocumentList.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement } from \"@twin.org/data-json-ld\";\nimport type { SchemaOrgContexts, SchemaOrgTypes } from \"@twin.org/standards-schema-org\";\nimport type { DocumentContexts } from \"./documentContexts.js\";\nimport type { IDocument } from \"./IDocument.js\";\n\n/**\n * Interface describing a list of document entries.\n */\nexport interface IDocumentList {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof SchemaOrgContexts.Context,\n\t\ttypeof DocumentContexts.Context,\n\t\ttypeof DocumentContexts.ContextCommon,\n\t\t...IJsonLdContextDefinitionElement[]\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof SchemaOrgTypes.ItemList;\n\n\t/**\n\t * The list of documents.\n\t * @json-ld namespace:schema\n\t */\n\t[SchemaOrgTypes.ItemListElement]: IDocument[];\n\n\t/**\n\t * The ids of the other vertices which are connected to the document.\n\t * @json-ld container:set\n\t */\n\tedges?: string[];\n}\n"]}

package/dist/es/schemas/Document.json

@@ -1,33 +1,30 @@
 {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "$id": "https://schema.twindev.org/documents/Document",
+    "title": "Document",
     "description": "Interface describing a document.",
     "type": "object",
     "properties": {
         "@context": {
             "type": "array",
-            "minItems": 3,
-            "description": "JSON-LD Context.",
             "prefixItems": [
                 {
-                    "type": "string",
                     "const": "https://schema.org"
                 },
                 {
-                    "type": "string",
                     "const": "https://schema.twindev.org/documents/"
                 },
                 {
-                    "type": "string",
                     "const": "https://schema.twindev.org/common/"
                 }
             ],
             "items": {
                 "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-            }
+            },
+            "minItems": 3,
+            "description": "JSON-LD Context."
         },
         "type": {
-            "type": "string",
             "const": "Document",
             "description": "JSON-LD Type."
         },
@@ -37,66 +34,66 @@
         },
         "documentId": {
             "type": "string",
-            "description": "The id of the document. json-ld type:schema:identifier"
+            "description": "The id of the document."
         },
         "documentIdFormat": {
             "type": "string",
-            "description": "The format of the document id. json-ld type:schema:Text"
+            "description": "The format of the document id."
         },
         "documentCode": {
             "$ref": "https://schema.twindev.org/unece/UneceDocumentCodeList",
-            "description": "The code for the document type. json-ld type:schema:identifier"
+            "description": "The code for the document type."
         },
         "documentRevision": {
             "type": "number",
-            "description": "The revision of the document as a 0 based index. json-ld type:schema:Integer"
+            "description": "The revision of the document as a 0 based index."
         },
         "annotationObject": {
             "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-            "description": "Additional annotation information for the document. json-ld namespace:twin-common"
+            "description": "Additional annotation information for the document."
         },
         "blobStorageId": {
             "type": "string",
-            "description": "The blob storage id for the document. json-ld type:schema:identifier"
+            "description": "The blob storage id for the document."
         },
         "integrity": {
             "type": "string",
-            "description": "The integrity of the blob data. json-ld namespace:twin-common"
+            "description": "The integrity of the blob data."
         },
         "blobStorageEntry": {
             "$ref": "https://schema.twindev.org/blob-storage/BlobStorageEntry",
-            "description": "The additional JSON-LD for blob storage if it was requested. json-ld id"
+            "description": "The additional JSON-LD for blob storage if it was requested."
         },
         "extractedData": {
-            "description": "The data extracted from the document using data extraction services. json-ld type:json"
+            "description": "The data extracted from the document using data extraction services."
         },
         "attestationId": {
             "type": "string",
-            "description": "The attestation for the document if one was created. json-ld type:schema:identifier"
+            "description": "The attestation for the document if one was created."
         },
         "attestationInformation": {
             "$ref": "https://schema.twindev.org/attestation/AttestationInformation",
-            "description": "The additional JSON-LD for attestation storage if it was requested. json-ld id"
+            "description": "The additional JSON-LD for attestation storage if it was requested."
         },
         "dateCreated": {
             "type": "string",
-            "description": "The date/time of when the document was created. json-ld namespace:schema"
+            "description": "The date/time of when the document was created."
         },
         "dateModified": {
             "type": "string",
-            "description": "The date/time of when the document was modified. json-ld namespace:schema"
+            "description": "The date/time of when the document was modified."
         },
         "dateDeleted": {
             "type": "string",
-            "description": "The date/time of when the document was deleted, as we never actually remove items. json-ld namespace:schema"
+            "description": "The date/time of when the document was deleted, as we never actually remove items."
         },
         "organizationIdentity": {
             "type": "string",
-            "description": "The organization which added the document to the graph. json-ld namespace:twin-common"
+            "description": "The organization which added the document to the graph."
         },
         "userIdentity": {
             "type": "string",
-            "description": "The user who added the document to the graph. json-ld namespace:twin-common"
+            "description": "The user who added the document to the graph."
         }
     },
     "required": [
@@ -109,6 +106,5 @@
         "blobStorageId",
         "integrity",
         "dateCreated"
-    ],
-    "additionalProperties": false
+    ]
 }

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

@@ -28,82 +28,82 @@ export interface IDocument {
     id: string;
     /**
      * The id of the document.
-     * json-ld type:schema:identifier
+     * @json-ld type:schema:identifier
      */
     documentId: string;
     /**
      * The format of the document id.
-     * json-ld type:schema:Text
+     * @json-ld type:schema:Text
      */
     documentIdFormat?: string;
     /**
      * The code for the document type.
-     * json-ld type:schema:identifier
+     * @json-ld type:schema:identifier
      */
     documentCode: UneceDocumentCodeList;
     /**
      * The revision of the document as a 0 based index.
-     * json-ld type:schema:Integer
+     * @json-ld type:schema:Integer
      */
     documentRevision: number;
     /**
      * Additional annotation information for the document.
-     * json-ld namespace:twin-common
+     * @json-ld namespace:twin-common
      */
     annotationObject?: IJsonLdNodeObject;
     /**
      * The blob storage id for the document.
-     * json-ld type:schema:identifier
+     * @json-ld type:schema:identifier
      */
     blobStorageId: string;
     /**
      * The integrity of the blob data.
-     * json-ld namespace:twin-common
+     * @json-ld namespace:twin-common
      */
     integrity: string;
     /**
      * The additional JSON-LD for blob storage if it was requested.
-     * json-ld id
+     * @json-ld id
      */
     blobStorageEntry?: IBlobStorageEntry;
     /**
      * The data extracted from the document using data extraction services.
-     * json-ld type:json
+     * @json-ld type:json
      */
     extractedData?: unknown;
     /**
      * The attestation for the document if one was created.
-     * json-ld type:schema:identifier
+     * @json-ld type:schema:identifier
      */
     attestationId?: string;
     /**
      * The additional JSON-LD for attestation storage if it was requested.
-     * json-ld id
+     * @json-ld id
      */
     attestationInformation?: IAttestationInformation;
     /**
      * The date/time of when the document was created.
-     * json-ld namespace:schema
+     * @json-ld namespace:schema
      */
     dateCreated: string;
     /**
      * The date/time of when the document was modified.
-     * json-ld namespace:schema
+     * @json-ld namespace:schema
      */
     dateModified?: string;
     /**
      * The date/time of when the document was deleted, as we never actually remove items.
-     * json-ld namespace:schema
+     * @json-ld namespace:schema
      */
     dateDeleted?: string;
     /**
      * The organization which added the document to the graph.
-     * json-ld namespace:twin-common
+     * @json-ld namespace:twin-common
      */
     organizationIdentity?: string;
     /**
      * The user who added the document to the graph.
-     * json-ld namespace:twin-common
+     * @json-ld namespace:twin-common
      */
     userIdentity?: string;
 }

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

@@ -20,27 +20,27 @@ export interface IDocumentAttestation {
     type: typeof DocumentTypes.DocumentAttestation;
     /**
      * The id of the document.
-     * json-ld type:schema:identifier
+     * @json-ld type:schema:identifier
      */
     documentId: string;
     /**
      * The code for the document type.
-     * json-ld type:schema:identifier
+     * @json-ld type:schema:identifier
      */
     documentCode: UneceDocumentCodeList;
     /**
      * The revision of the document as a 0 based index.
-     * json-ld type:schema:Integer
+     * @json-ld type:schema:Integer
      */
     documentRevision: number;
     /**
      * The date/time of when the document was created.
-     * json-ld namespace:schema
+     * @json-ld namespace:schema
      */
     dateCreated: string;
     /**
      * The integrity of the document being attested.
-     * json-ld namespace:twin-common
+     * @json-ld namespace:twin-common
      */
     integrity: string;
 }

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

@@ -21,12 +21,12 @@ export interface IDocumentList {
     type: typeof SchemaOrgTypes.ItemList;
     /**
      * The list of documents.
-     * json-ld namespace:schema
+     * @json-ld namespace:schema
      */
     [SchemaOrgTypes.ItemListElement]: IDocument[];
     /**
      * The ids of the other vertices which are connected to the document.
-     * json-ld container:set
+     * @json-ld container:set
      */
     edges?: string[];
 }

package/docs/changelog.md

@@ -1,4 +1,18 @@
-# @twin.org/document-management-models - Changelog
+# Changelog
+
+## [0.0.3-next.12](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.11...document-management-models-v0.0.3-next.12) (2026-03-26)
+
+
+### Features
+
+* update to latest aig method shapes ([497e895](https://github.com/twinfoundation/document-management/commit/497e8954f24774db628e057ebb9d158a1fd9d92a))
+
+## [0.0.3-next.11](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.10...document-management-models-v0.0.3-next.11) (2026-02-25)
+
+
+### Features
+
+* update schemas ([310261d](https://github.com/twinfoundation/document-management/commit/310261d620254d9c00dfa8fbb470948af9101778))
 
 ## [0.0.3-next.10](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.9...document-management-models-v0.0.3-next.10) (2026-02-11)
 

package/docs/examples.md

@@ -1 +1,23 @@
-# @twin.org/document-management-models - Examples
+# Document Management Models Examples
+
+These snippets show typical setup steps for registering data types and creating document-shaped data that can be validated and exchanged consistently.
+
+## DocumentManagementDataTypes
+
+```typescript
+import { DataTypeHandlerFactory } from '@twin.org/data-core';
+import {
+  DocumentContexts,
+  DocumentManagementDataTypes,
+  DocumentTypes
+} from '@twin.org/document-management-models';
+
+DocumentManagementDataTypes.registerTypes();
+
+const handler = DataTypeHandlerFactory.get(
+  `${DocumentContexts.Namespace}${DocumentTypes.Document}`
+);
+
+console.log(handler.namespace); // https://schema.twindev.org/document-management/
+console.log(handler.type); // Document
+```

package/docs/reference/classes/DocumentManagementDataTypes.md

@@ -14,7 +14,7 @@ Handle all the data types for document management.
 
 ## Methods
 
-### registerTypes()
+### registerTypes() {#registertypes}
 
 > `static` **registerTypes**(): `void`
 

package/docs/reference/interfaces/IDocument.md

@@ -4,7 +4,7 @@ Interface describing a document.
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/documents/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
@@ -12,7 +12,7 @@ JSON-LD Context.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"Document"`
 
@@ -20,7 +20,7 @@ JSON-LD Type.
 
 ***
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -28,144 +28,128 @@ The full id of the document.
 
 ***
 
-### documentId
+### documentId {#documentid}
 
 > **documentId**: `string`
 
 The id of the document.
-json-ld type:schema:identifier
 
 ***
 
-### documentIdFormat?
+### documentIdFormat? {#documentidformat}
 
-> `optional` **documentIdFormat**: `string`
+> `optional` **documentIdFormat?**: `string`
 
 The format of the document id.
-json-ld type:schema:Text
 
 ***
 
-### documentCode
+### documentCode {#documentcode}
 
 > **documentCode**: `UneceDocumentCodeList`
 
 The code for the document type.
-json-ld type:schema:identifier
 
 ***
 
-### documentRevision
+### documentRevision {#documentrevision}
 
 > **documentRevision**: `number`
 
 The revision of the document as a 0 based index.
-json-ld type:schema:Integer
 
 ***
 
-### annotationObject?
+### annotationObject? {#annotationobject}
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
 
 Additional annotation information for the document.
-json-ld namespace:twin-common
 
 ***
 
-### blobStorageId
+### blobStorageId {#blobstorageid}
 
 > **blobStorageId**: `string`
 
 The blob storage id for the document.
-json-ld type:schema:identifier
 
 ***
 
-### integrity
+### integrity {#integrity}
 
 > **integrity**: `string`
 
 The integrity of the blob data.
-json-ld namespace:twin-common
 
 ***
 
-### blobStorageEntry?
+### blobStorageEntry? {#blobstorageentry}
 
-> `optional` **blobStorageEntry**: `IBlobStorageEntry`
+> `optional` **blobStorageEntry?**: `IBlobStorageEntry`
 
 The additional JSON-LD for blob storage if it was requested.
-json-ld id
 
 ***
 
-### extractedData?
+### extractedData? {#extracteddata}
 
-> `optional` **extractedData**: `unknown`
+> `optional` **extractedData?**: `unknown`
 
 The data extracted from the document using data extraction services.
-json-ld type:json
 
 ***
 
-### attestationId?
+### attestationId? {#attestationid}
 
-> `optional` **attestationId**: `string`
+> `optional` **attestationId?**: `string`
 
 The attestation for the document if one was created.
-json-ld type:schema:identifier
 
 ***
 
-### attestationInformation?
+### attestationInformation? {#attestationinformation}
 
-> `optional` **attestationInformation**: `IAttestationInformation`
+> `optional` **attestationInformation?**: `IAttestationInformation`
 
 The additional JSON-LD for attestation storage if it was requested.
-json-ld id
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
 The date/time of when the document was created.
-json-ld namespace:schema
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the document was modified.
-json-ld namespace:schema
 
 ***
 
-### dateDeleted?
+### dateDeleted? {#datedeleted}
 
-> `optional` **dateDeleted**: `string`
+> `optional` **dateDeleted?**: `string`
 
 The date/time of when the document was deleted, as we never actually remove items.
-json-ld namespace:schema
 
 ***
 
-### organizationIdentity?
+### organizationIdentity? {#organizationidentity}
 
-> `optional` **organizationIdentity**: `string`
+> `optional` **organizationIdentity?**: `string`
 
 The organization which added the document to the graph.
-json-ld namespace:twin-common
 
 ***
 
-### userIdentity?
+### userIdentity? {#useridentity}
 
-> `optional` **userIdentity**: `string`
+> `optional` **userIdentity?**: `string`
 
 The user who added the document to the graph.
-json-ld namespace:twin-common

package/docs/reference/interfaces/IDocumentAttestation.md

@@ -4,7 +4,7 @@ Interface describing a document attestation.
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/documents/"`, `"https://schema.twindev.org/common/"`\]
 
@@ -12,7 +12,7 @@ JSON-LD Context.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"DocumentAttestation"`
 
@@ -20,45 +20,40 @@ JSON-LD Type.
 
 ***
 
-### documentId
+### documentId {#documentid}
 
 > **documentId**: `string`
 
 The id of the document.
-json-ld type:schema:identifier
 
 ***
 
-### documentCode
+### documentCode {#documentcode}
 
 > **documentCode**: `UneceDocumentCodeList`
 
 The code for the document type.
-json-ld type:schema:identifier
 
 ***
 
-### documentRevision
+### documentRevision {#documentrevision}
 
 > **documentRevision**: `number`
 
 The revision of the document as a 0 based index.
-json-ld type:schema:Integer
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
 The date/time of when the document was created.
-json-ld namespace:schema
 
 ***
 
-### integrity
+### integrity {#integrity}
 
 > **integrity**: `string`
 
 The integrity of the document being attested.
-json-ld namespace:twin-common

package/docs/reference/interfaces/IDocumentList.md

@@ -4,7 +4,7 @@ Interface describing a list of document entries.
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/documents/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
@@ -12,7 +12,7 @@ JSON-LD Context.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"ItemList"`
 
@@ -20,18 +20,16 @@ JSON-LD Type.
 
 ***
 
-### itemListElement
+### itemListElement {#itemlistelement}
 
 > **itemListElement**: [`IDocument`](IDocument.md)[]
 
 The list of documents.
-json-ld namespace:schema
 
 ***
 
-### edges?
+### edges? {#edges}
 
-> `optional` **edges**: `string`[]
+> `optional` **edges?**: `string`[]
 
 The ids of the other vertices which are connected to the document.
-json-ld container:set

package/docs/reference/interfaces/IDocumentManagementComponent.md

@@ -8,7 +8,7 @@ Interface describing an document management contract.
 
 ## Methods
 
-### create()
+### create() {#create}
 
 > **create**(`documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject?`, `auditableItemGraphEdges?`, `options?`): `Promise`\<`string`\>
 
@@ -26,9 +26,9 @@ The document id to create.
 
 ##### documentIdFormat
 
-The format of the document identifier.
+`string` \| `undefined`
 
-`string` | `undefined`
+The format of the document identifier.
 
 ##### documentCode
 
@@ -84,7 +84,7 @@ The auditable item graph vertex created for the document including its revision.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`auditableItemGraphDocumentId`, `blob?`, `annotationObject?`, `auditableItemGraphEdges?`): `Promise`\<`void`\>
 
@@ -126,7 +126,7 @@ Nothing.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: [`IDocumentList`](IDocumentList.md); `cursor?`: `string`; \}\>
 
@@ -200,7 +200,7 @@ The documents and revisions if requested, ordered by revision descending, cursor
 
 ***
 
-### getRevision()
+### getRevision() {#getrevision}
 
 > **getRevision**(`auditableItemGraphDocumentId`, `revision`, `options?`): `Promise`\<[`IDocument`](IDocument.md)\>
 
@@ -262,7 +262,7 @@ The documents and revisions if requested, ordered by revision descending, cursor
 
 ***
 
-### removeRevision()
+### removeRevision() {#removerevision}
 
 > **removeRevision**(`auditableItemGraphDocumentId`, `revision`): `Promise`\<`void`\>
 
@@ -291,7 +291,7 @@ Nothing.
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`documentId`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IAuditableItemGraphVertexList`; `cursor?`: `string`; \}\>
 

package/docs/reference/interfaces/IDocumentManagementCreateRequest.md

@@ -4,7 +4,7 @@ Request to create a document as an auditable item graph vertex.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -36,30 +36,30 @@ The data to create the document with, in base64.
 
 #### annotationObject?
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
 
 Additional information to associate with the document.
 
 #### auditableItemGraphEdges?
 
-> `optional` **auditableItemGraphEdges**: `object`[]
+> `optional` **auditableItemGraphEdges?**: `object`[]
 
 The auditable item graph vertices to connect the document to.
 
 #### createAttestation?
 
-> `optional` **createAttestation**: `boolean`
+> `optional` **createAttestation?**: `boolean`
 
 Flag to create an attestation for the document, defaults to false.
 
 #### addAlias?
 
-> `optional` **addAlias**: `boolean`
+> `optional` **addAlias?**: `boolean`
 
 Flag to add the document id as an alias to the aig vertex, defaults to true.
 
 #### aliasAnnotationObject?
 
-> `optional` **aliasAnnotationObject**: `IJsonLdNodeObject`
+> `optional` **aliasAnnotationObject?**: `IJsonLdNodeObject`
 
 Annotation object for the alias.

package/docs/reference/interfaces/IDocumentManagementGetRequest.md

@@ -4,9 +4,9 @@ Request to get a document from an auditable item graph vertex.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -30,15 +30,15 @@ The full id of the document to get.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The query parameters.
 
 #### includeBlobStorageMetadata?
 
-> `optional` **includeBlobStorageMetadata**: `string`
+> `optional` **includeBlobStorageMetadata?**: `string`
 
 Include the blob storage metadata in the response.
 
@@ -50,7 +50,7 @@ false
 
 #### includeBlobStorageData?
 
-> `optional` **includeBlobStorageData**: `string`
+> `optional` **includeBlobStorageData?**: `string`
 
 Include the blob storage data in the response.
 
@@ -62,7 +62,7 @@ false
 
 #### includeAttestation?
 
-> `optional` **includeAttestation**: `string`
+> `optional` **includeAttestation?**: `string`
 
 Include the attestation information in the response.
 
@@ -74,7 +74,7 @@ false
 
 #### includeRemoved?
 
-> `optional` **includeRemoved**: `string`
+> `optional` **includeRemoved?**: `string`
 
 Include deleted documents in the response.
 
@@ -86,19 +86,19 @@ false
 
 #### extractRuleGroupId?
 
-> `optional` **extractRuleGroupId**: `string`
+> `optional` **extractRuleGroupId?**: `string`
 
 If provided will extract data from the document using the specified rule group id.
 
 #### extractMimeType?
 
-> `optional` **extractMimeType**: `string`
+> `optional` **extractMimeType?**: `string`
 
 By default extraction will auto detect the mime type of the document, this can be used to override the detection.
 
 #### limit?
 
-> `optional` **limit**: `string`
+> `optional` **limit?**: `string`
 
 PLimit the number of items to return, defaults to 1 so only most recent is returned.
 
@@ -110,6 +110,6 @@ PLimit the number of items to return, defaults to 1 so only most recent is retur
 
 #### cursor?
 
-> `optional` **cursor**: `string`
+> `optional` **cursor?**: `string`
 
 The cursor to get the next chunk of revisions.

package/docs/reference/interfaces/IDocumentManagementGetResponse.md

@@ -4,9 +4,9 @@ Response to get a document and optionally revisions from an auditable item graph
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,11 +16,11 @@ The headers which can be used to determine the response data type.
 
 #### link?
 
-> `optional` **link**: `string` \| `string`[]
+> `optional` **link?**: `string` \| `string`[]
 
 ***
 
-### body
+### body {#body}
 
 > **body**: [`IDocumentList`](IDocumentList.md)
 

package/docs/reference/interfaces/IDocumentManagementGetRevisionRequest.md

@@ -4,9 +4,9 @@ Request to get a document revision from an auditable item graph vertex.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -36,15 +36,15 @@ The revision of the document to get.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The query parameters.
 
 #### includeBlobStorageMetadata?
 
-> `optional` **includeBlobStorageMetadata**: `string`
+> `optional` **includeBlobStorageMetadata?**: `string`
 
 Include the blob storage metadata in the response.
 
@@ -56,7 +56,7 @@ false
 
 #### includeBlobStorageData?
 
-> `optional` **includeBlobStorageData**: `string`
+> `optional` **includeBlobStorageData?**: `string`
 
 Include the blob storage data in the response.
 
@@ -68,7 +68,7 @@ false
 
 #### includeAttestation?
 
-> `optional` **includeAttestation**: `string`
+> `optional` **includeAttestation?**: `string`
 
 Include the attestation information in the response.
 
@@ -80,12 +80,12 @@ false
 
 #### extractRuleGroupId?
 
-> `optional` **extractRuleGroupId**: `string`
+> `optional` **extractRuleGroupId?**: `string`
 
 If provided will extract data from the document using the specified rule group id.
 
 #### extractMimeType?
 
-> `optional` **extractMimeType**: `string`
+> `optional` **extractMimeType?**: `string`
 
 By default extraction will auto detect the mime type of the document, this can be used to override the detection.

package/docs/reference/interfaces/IDocumentManagementGetRevisionResponse.md

@@ -4,9 +4,9 @@ Response to get a document revision from an auditable item graph vertex.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: [`IDocument`](IDocument.md)
 

package/docs/reference/interfaces/IDocumentManagementQueryRequest.md

@@ -4,9 +4,9 @@ Request to get a list of document from an auditable item graph vertex.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### query
+### query {#query}
 
 > **query**: `object`
 
@@ -30,12 +30,12 @@ The id of the document id we are trying to find.
 
 #### cursor?
 
-> `optional` **cursor**: `string`
+> `optional` **cursor?**: `string`
 
 The cursor to get the next chunk of documents.
 
 #### limit?
 
-> `optional` **limit**: `string`
+> `optional` **limit?**: `string`
 
 The number of documents to return.

package/docs/reference/interfaces/IDocumentManagementQueryResponse.md

@@ -4,9 +4,9 @@ Response to query the documents from an auditable item graph vertex.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,11 +16,11 @@ The headers which can be used to determine the response data type.
 
 #### link?
 
-> `optional` **link**: `string` \| `string`[]
+> `optional` **link?**: `string` \| `string`[]
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `IAuditableItemGraphVertexList`
 

package/docs/reference/interfaces/IDocumentManagementRemoveRequest.md

@@ -4,7 +4,7 @@ Request to remove a document revision from an auditable item graph.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/IDocumentManagementUpdateRequest.md

@@ -4,7 +4,7 @@ Request to update a document as an auditable item graph vertex.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -18,7 +18,7 @@ The full id of the document to get.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -26,18 +26,18 @@ The body parameters.
 
 #### blob?
 
-> `optional` **blob**: `string`
+> `optional` **blob?**: `string`
 
 The data to create the document with, in base64.
 
 #### annotationObject?
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
 
 Additional information to associate with the document.
 
 #### auditableItemGraphEdges?
 
-> `optional` **auditableItemGraphEdges**: `object`[]
+> `optional` **auditableItemGraphEdges?**: `object`[]
 
 The auditable item graph vertices to connect the document to.

package/docs/reference/variables/DocumentContexts.md

@@ -6,37 +6,37 @@ The contexts of document management objects.
 
 ## Type Declaration
 
-### Namespace
+### Namespace {#namespace}
 
 > `readonly` **Namespace**: `"https://schema.twindev.org/documents/"` = `"https://schema.twindev.org/documents/"`
 
 The canonical RDF namespace URI for Document Management.
 
-### Context
+### Context {#context}
 
 > `readonly` **Context**: `"https://schema.twindev.org/documents/"` = `"https://schema.twindev.org/documents/"`
 
 The value to use in context for Document Management.
 
-### JsonLdContext
+### JsonLdContext {#jsonldcontext}
 
 > `readonly` **JsonLdContext**: `"https://schema.twindev.org/documents/types.jsonld"` = `"https://schema.twindev.org/documents/types.jsonld"`
 
 The JSON-LD Context URL for Document Management.
 
-### NamespaceCommon
+### NamespaceCommon {#namespacecommon}
 
 > `readonly` **NamespaceCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
 
 The canonical RDF namespace URI for TWIN Common.
 
-### ContextCommon
+### ContextCommon {#contextcommon}
 
 > `readonly` **ContextCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
 
 The value to use in JSON-LD context for TWIN Common.
 
-### JsonLdContextCommon
+### JsonLdContextCommon {#jsonldcontextcommon}
 
 > `readonly` **JsonLdContextCommon**: `"https://schema.twindev.org/common/types.jsonld"` = `"https://schema.twindev.org/common/types.jsonld"`
 

package/docs/reference/variables/DocumentTypes.md

@@ -6,13 +6,13 @@ The types of document management objects.
 
 ## Type Declaration
 
-### Document
+### Document {#document}
 
 > `readonly` **Document**: `"Document"` = `"Document"`
 
 Represents a document.
 
-### DocumentAttestation
+### DocumentAttestation {#documentattestation}
 
 > `readonly` **DocumentAttestation**: `"DocumentAttestation"` = `"DocumentAttestation"`
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/document-management-models",
-	"version": "0.0.3-next.10",
-	"description": "Models which define the structure of the document management connectors and services",
+	"version": "0.0.3-next.12",
+	"description": "Shared data models, schemas, and context definitions for document lifecycle records.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/document-management.git",