@twin.org/document-management-models 0.0.3-next.1 → 0.0.3-next.11

package/dist/es/dataTypes/documentManagementDataTypes.js

@@ -12,14 +12,14 @@ export class DocumentManagementDataTypes {
      * Register all the data types.
      */
     static registerTypes() {
-        DataTypeHandlerFactory.register(`${DocumentContexts.ContextRoot}${DocumentTypes.Document}`, () => ({
-            context: DocumentContexts.ContextRoot,
+        DataTypeHandlerFactory.register(`${DocumentContexts.Namespace}${DocumentTypes.Document}`, () => ({
+            namespace: DocumentContexts.Namespace,
             type: DocumentTypes.Document,
             defaultValue: {},
             jsonSchema: async () => DocumentSchema
         }));
-        DataTypeHandlerFactory.register(`${DocumentContexts.ContextRoot}${DocumentTypes.DocumentAttestation}`, () => ({
-            context: DocumentContexts.ContextRoot,
+        DataTypeHandlerFactory.register(`${DocumentContexts.Namespace}${DocumentTypes.DocumentAttestation}`, () => ({
+            namespace: DocumentContexts.Namespace,
             type: DocumentTypes.DocumentAttestation,
             defaultValue: {},
             jsonSchema: async () => DocumentSchema

package/dist/es/dataTypes/documentManagementDataTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"documentManagementDataTypes.js","sourceRoot":"","sources":["../../../src/dataTypes/documentManagementDataTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,sBAAsB,EAAoB,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,cAAc,MAAM,0BAA0B,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAE5E;;GAEG;AACH,MAAM,OAAO,2BAA2B;IACvC;;OAEG;IACI,MAAM,CAAC,aAAa;QAC1B,sBAAsB,CAAC,QAAQ,CAC9B,GAAG,gBAAgB,CAAC,WAAW,GAAG,aAAa,CAAC,QAAQ,EAAE,EAC1D,GAAG,EAAE,CAAC,CAAC;YACN,OAAO,EAAE,gBAAgB,CAAC,WAAW;YACrC,IAAI,EAAE,aAAa,CAAC,QAAQ;YAC5B,YAAY,EAAE,EAAE;YAChB,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,cAA6B;SACrD,CAAC,CACF,CAAC;QAEF,sBAAsB,CAAC,QAAQ,CAC9B,GAAG,gBAAgB,CAAC,WAAW,GAAG,aAAa,CAAC,mBAAmB,EAAE,EACrE,GAAG,EAAE,CAAC,CAAC;YACN,OAAO,EAAE,gBAAgB,CAAC,WAAW;YACrC,IAAI,EAAE,aAAa,CAAC,mBAAmB;YACvC,YAAY,EAAE,EAAE;YAChB,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,cAA6B;SACrD,CAAC,CACF,CAAC;IACH,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { DataTypeHandlerFactory, type IJsonSchema } from \"@twin.org/data-core\";\nimport { DocumentContexts } from \"../models/documentContexts.js\";\nimport { DocumentTypes } from \"../models/documentTypes.js\";\nimport DocumentSchema from \"../schemas/Document.json\" with { type: \"json\" };\n\n/**\n * Handle all the data types for document management.\n */\nexport class DocumentManagementDataTypes {\n\t/**\n\t * Register all the data types.\n\t */\n\tpublic static registerTypes(): void {\n\t\tDataTypeHandlerFactory.register(\n\t\t\t`${DocumentContexts.ContextRoot}${DocumentTypes.Document}`,\n\t\t\t() => ({\n\t\t\t\tcontext: DocumentContexts.ContextRoot,\n\t\t\t\ttype: DocumentTypes.Document,\n\t\t\t\tdefaultValue: {},\n\t\t\t\tjsonSchema: async () => DocumentSchema as IJsonSchema\n\t\t\t})\n\t\t);\n\n\t\tDataTypeHandlerFactory.register(\n\t\t\t`${DocumentContexts.ContextRoot}${DocumentTypes.DocumentAttestation}`,\n\t\t\t() => ({\n\t\t\t\tcontext: DocumentContexts.ContextRoot,\n\t\t\t\ttype: DocumentTypes.DocumentAttestation,\n\t\t\t\tdefaultValue: {},\n\t\t\t\tjsonSchema: async () => DocumentSchema as IJsonSchema\n\t\t\t})\n\t\t);\n\t}\n}\n"]}
+{"version":3,"file":"documentManagementDataTypes.js","sourceRoot":"","sources":["../../../src/dataTypes/documentManagementDataTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,sBAAsB,EAAoB,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,cAAc,MAAM,0BAA0B,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAE5E;;GAEG;AACH,MAAM,OAAO,2BAA2B;IACvC;;OAEG;IACI,MAAM,CAAC,aAAa;QAC1B,sBAAsB,CAAC,QAAQ,CAC9B,GAAG,gBAAgB,CAAC,SAAS,GAAG,aAAa,CAAC,QAAQ,EAAE,EACxD,GAAG,EAAE,CAAC,CAAC;YACN,SAAS,EAAE,gBAAgB,CAAC,SAAS;YACrC,IAAI,EAAE,aAAa,CAAC,QAAQ;YAC5B,YAAY,EAAE,EAAE;YAChB,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,cAA6B;SACrD,CAAC,CACF,CAAC;QAEF,sBAAsB,CAAC,QAAQ,CAC9B,GAAG,gBAAgB,CAAC,SAAS,GAAG,aAAa,CAAC,mBAAmB,EAAE,EACnE,GAAG,EAAE,CAAC,CAAC;YACN,SAAS,EAAE,gBAAgB,CAAC,SAAS;YACrC,IAAI,EAAE,aAAa,CAAC,mBAAmB;YACvC,YAAY,EAAE,EAAE;YAChB,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,cAA6B;SACrD,CAAC,CACF,CAAC;IACH,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { DataTypeHandlerFactory, type IJsonSchema } from \"@twin.org/data-core\";\nimport { DocumentContexts } from \"../models/documentContexts.js\";\nimport { DocumentTypes } from \"../models/documentTypes.js\";\nimport DocumentSchema from \"../schemas/Document.json\" with { type: \"json\" };\n\n/**\n * Handle all the data types for document management.\n */\nexport class DocumentManagementDataTypes {\n\t/**\n\t * Register all the data types.\n\t */\n\tpublic static registerTypes(): void {\n\t\tDataTypeHandlerFactory.register(\n\t\t\t`${DocumentContexts.Namespace}${DocumentTypes.Document}`,\n\t\t\t() => ({\n\t\t\t\tnamespace: DocumentContexts.Namespace,\n\t\t\t\ttype: DocumentTypes.Document,\n\t\t\t\tdefaultValue: {},\n\t\t\t\tjsonSchema: async () => DocumentSchema as IJsonSchema\n\t\t\t})\n\t\t);\n\n\t\tDataTypeHandlerFactory.register(\n\t\t\t`${DocumentContexts.Namespace}${DocumentTypes.DocumentAttestation}`,\n\t\t\t() => ({\n\t\t\t\tnamespace: DocumentContexts.Namespace,\n\t\t\t\ttype: DocumentTypes.DocumentAttestation,\n\t\t\t\tdefaultValue: {},\n\t\t\t\tjsonSchema: async () => DocumentSchema as IJsonSchema\n\t\t\t})\n\t\t);\n\t}\n}\n"]}

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 { UneceDocumentCodes } 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 DocumentContexts.ContextRoot,\n\t\ttypeof DocumentContexts.ContextRootCommon,\n\t\ttypeof SchemaOrgContexts.ContextRoot,\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 */\n\tdocumentId: string;\n\n\t/**\n\t * The format of the document id.\n\t */\n\tdocumentIdFormat?: string;\n\n\t/**\n\t * The code for the document type.\n\t */\n\tdocumentCode: UneceDocumentCodes;\n\n\t/**\n\t * The revision of the document as a 0 based index.\n\t */\n\tdocumentRevision: number;\n\n\t/**\n\t * Additional annotation information for the document.\n\t */\n\tannotationObject?: IJsonLdNodeObject;\n\n\t/**\n\t * The blob storage id for the document.\n\t */\n\tblobStorageId: string;\n\n\t/**\n\t * The hash of the blob data.\n\t */\n\tblobHash: string;\n\n\t/**\n\t * The additional JSON-LD for blob storage if it was requested.\n\t */\n\tblobStorageEntry?: IBlobStorageEntry;\n\n\t/**\n\t * The data extracted from the document using data extraction services.\n\t */\n\textractedData?: unknown;\n\n\t/**\n\t * The attestation for the document if one was created.\n\t */\n\tattestationId?: string;\n\n\t/**\n\t * The additional JSON-LD for attestation storage if it was requested.\n\t */\n\tattestationInformation?: IAttestationInformation;\n\n\t/**\n\t * The date/time of when the document was created.\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The date/time of when the document was modified.\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 */\n\tdateDeleted?: string;\n\n\t/**\n\t * The organization which added the document to the graph.\n\t */\n\torganizationIdentity?: string;\n\n\t/**\n\t * The user who added the document to the graph.\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 { UneceDocumentCodes } 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 DocumentContexts.ContextRoot,\n\t\ttypeof DocumentContexts.ContextRootCommon,\n\t\ttypeof SchemaOrgContexts.ContextRoot\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 */\n\tdocumentId: string;\n\n\t/**\n\t * The code for the document type.\n\t */\n\tdocumentCode: UneceDocumentCodes;\n\n\t/**\n\t * The revision of the document as a 0 based index.\n\t */\n\tdocumentRevision: number;\n\n\t/**\n\t * The date/time of when the document was created.\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The hash of the document being attested.\n\t */\n\tblobHash: 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.ContextRoot,\n\t\ttypeof DocumentContexts.ContextRoot,\n\t\ttypeof DocumentContexts.ContextRootCommon,\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 */\n\t[SchemaOrgTypes.ItemListElement]: IDocument[];\n\n\t/**\n\t * The ids of the other vertices which are connected to the document.\n\t */\n\tedges?: string[];\n\n\t/**\n\t * The cursor to get the next chunk of documents.\n\t */\n\t[SchemaOrgTypes.NextItem]?: 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/models/IDocumentManagementComponent.js.map

@@ -1 +1 @@
-{"version":3,"file":"IDocumentManagementComponent.js","sourceRoot":"","sources":["../../../src/models/IDocumentManagementComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuditableItemGraphVertexList } from \"@twin.org/auditable-item-graph-models\";\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { UneceDocumentCodes } from \"@twin.org/standards-unece\";\nimport type { IDocument } from \"./IDocument.js\";\nimport type { IDocumentList } from \"./IDocumentList.js\";\n\n/**\n * Interface describing an document management contract.\n */\nexport interface IDocumentManagementComponent extends IComponent {\n\t/**\n\t * Create a document as an auditable item graph vertex and add its content to blob storage.\n\t * If the document id already exists and the blob data is different a new revision will be created.\n\t * For any other changes the current revision will be updated.\n\t * @param documentId The document id to create.\n\t * @param documentIdFormat The format of the document identifier.\n\t * @param documentCode The code for the document type.\n\t * @param blob The data to create the document with.\n\t * @param annotationObject Additional information to associate with the document.\n\t * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to.\n\t * @param options Additional options for the set operation.\n\t * @param options.createAttestation Flag to create an attestation for the document, defaults to false.\n\t * @param options.addAlias Flag to add the document id as an alias to the aig vertex, defaults to true.\n\t * @param options.aliasAnnotationObject Annotation object for the alias.\n\t * @returns The auditable item graph vertex created for the document including its revision.\n\t */\n\tcreate(\n\t\tdocumentId: string,\n\t\tdocumentIdFormat: string | undefined,\n\t\tdocumentCode: UneceDocumentCodes,\n\t\tblob: Uint8Array,\n\t\tannotationObject?: IJsonLdNodeObject,\n\t\tauditableItemGraphEdges?: {\n\t\t\ttargetId: string;\n\t\t\taddAlias?: boolean;\n\t\t\taliasAnnotationObject?: IJsonLdNodeObject;\n\t\t}[],\n\t\toptions?: {\n\t\t\tcreateAttestation?: boolean;\n\t\t\taddAlias?: boolean;\n\t\t\taliasAnnotationObject?: IJsonLdNodeObject;\n\t\t}\n\t): Promise<string>;\n\n\t/**\n\t * Update a document as an auditable item graph vertex and add its content to blob storage.\n\t * If the blob data is different a new revision will be created.\n\t * For any other changes the current revision will be updated.\n\t * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.\n\t * @param blob The data to update the document with.\n\t * @param annotationObject Additional information to associate with the document.\n\t * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to, if undefined retains current connections.\n\t * @returns Nothing.\n\t */\n\tupdate(\n\t\tauditableItemGraphDocumentId: string,\n\t\tblob?: Uint8Array,\n\t\tannotationObject?: IJsonLdNodeObject,\n\t\tauditableItemGraphEdges?: {\n\t\t\ttargetId: string;\n\t\t\taddAlias?: boolean;\n\t\t\taliasAnnotationObject?: IJsonLdNodeObject;\n\t\t}[]\n\t): Promise<void>;\n\n\t/**\n\t * Get a document using it's auditable item graph vertex id and optional revision.\n\t * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.\n\t * @param options Additional options for the get operation.\n\t * @param options.includeBlobStorageMetadata Flag to include the blob storage metadata for the document, defaults to false.\n\t * @param options.includeBlobStorageData Flag to include the blob storage data for the document, defaults to false.\n\t * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.\n\t * @param options.includeRemoved Flag to include deleted documents, defaults to false.\n\t * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.\n\t * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.\n\t * @param cursor The cursor to get the next chunk of revisions.\n\t * @param limit Limit the number of items to return, defaults to 1 so only most recent is returned.\n\t * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.\n\t */\n\tget(\n\t\tauditableItemGraphDocumentId: string,\n\t\toptions?: {\n\t\t\tincludeBlobStorageMetadata?: boolean;\n\t\t\tincludeBlobStorageData?: boolean;\n\t\t\tincludeAttestation?: boolean;\n\t\t\tincludeRemoved?: boolean;\n\t\t\textractRuleGroupId?: string;\n\t\t\textractMimeType?: string;\n\t\t},\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<IDocumentList>;\n\n\t/**\n\t * Get a document revision using it's auditable item graph vertex id.\n\t * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.\n\t * @param revision The revision id of the document to get.\n\t * @param options Additional options for the get operation.\n\t * @param options.includeBlobStorageMetadata Flag to include the blob storage metadata for the document, defaults to false.\n\t * @param options.includeBlobStorageData Flag to include the blob storage data for the document, defaults to false.\n\t * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.\n\t * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.\n\t * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.\n\t * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.\n\t */\n\tgetRevision(\n\t\tauditableItemGraphDocumentId: string,\n\t\trevision: number,\n\t\toptions?: {\n\t\t\tincludeBlobStorageMetadata?: boolean;\n\t\t\tincludeBlobStorageData?: boolean;\n\t\t\tincludeAttestation?: boolean;\n\t\t\textractRuleGroupId?: string;\n\t\t\textractMimeType?: string;\n\t\t}\n\t): Promise<IDocument>;\n\n\t/**\n\t * Remove an auditable item graph vertex using it's id.\n\t * The document dateDeleted will be set, but can still be queried with the includeRemoved flag.\n\t * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.\n\t * @param revision The revision of the document to remove.\n\t * @returns Nothing.\n\t */\n\tremoveRevision(auditableItemGraphDocumentId: string, revision: number): Promise<void>;\n\n\t/**\n\t * Find all the document with a specific id.\n\t * @param documentId The document id to find in the graph.\n\t * @param cursor The cursor to get the next chunk of documents.\n\t * @param limit The limit to get the next chunk of documents.\n\t * @returns The graph vertices that contain documents referencing the specified document id.\n\t */\n\tquery(\n\t\tdocumentId: string,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<IAuditableItemGraphVertexList>;\n}\n"]}
+{"version":3,"file":"IDocumentManagementComponent.js","sourceRoot":"","sources":["../../../src/models/IDocumentManagementComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuditableItemGraphVertexList } from \"@twin.org/auditable-item-graph-models\";\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { UneceDocumentCodeList } from \"@twin.org/standards-unece\";\nimport type { IDocument } from \"./IDocument.js\";\nimport type { IDocumentList } from \"./IDocumentList.js\";\n\n/**\n * Interface describing an document management contract.\n */\nexport interface IDocumentManagementComponent extends IComponent {\n\t/**\n\t * Create a document as an auditable item graph vertex and add its content to blob storage.\n\t * If the document id already exists and the blob data is different a new revision will be created.\n\t * For any other changes the current revision will be updated.\n\t * @param documentId The document id to create.\n\t * @param documentIdFormat The format of the document identifier.\n\t * @param documentCode The code for the document type.\n\t * @param blob The data to create the document with.\n\t * @param annotationObject Additional information to associate with the document.\n\t * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to.\n\t * @param options Additional options for the set operation.\n\t * @param options.createAttestation Flag to create an attestation for the document, defaults to false.\n\t * @param options.addAlias Flag to add the document id as an alias to the aig vertex, defaults to true.\n\t * @param options.aliasAnnotationObject Annotation object for the alias.\n\t * @returns The auditable item graph vertex created for the document including its revision.\n\t */\n\tcreate(\n\t\tdocumentId: string,\n\t\tdocumentIdFormat: string | undefined,\n\t\tdocumentCode: UneceDocumentCodeList,\n\t\tblob: Uint8Array,\n\t\tannotationObject?: IJsonLdNodeObject,\n\t\tauditableItemGraphEdges?: {\n\t\t\ttargetId: string;\n\t\t\taddAlias?: boolean;\n\t\t\taliasAnnotationObject?: IJsonLdNodeObject;\n\t\t}[],\n\t\toptions?: {\n\t\t\tcreateAttestation?: boolean;\n\t\t\taddAlias?: boolean;\n\t\t\taliasAnnotationObject?: IJsonLdNodeObject;\n\t\t}\n\t): Promise<string>;\n\n\t/**\n\t * Update a document as an auditable item graph vertex and add its content to blob storage.\n\t * If the blob data is different a new revision will be created.\n\t * For any other changes the current revision will be updated.\n\t * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.\n\t * @param blob The data to update the document with.\n\t * @param annotationObject Additional information to associate with the document.\n\t * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to, if undefined retains current connections.\n\t * @returns Nothing.\n\t */\n\tupdate(\n\t\tauditableItemGraphDocumentId: string,\n\t\tblob?: Uint8Array,\n\t\tannotationObject?: IJsonLdNodeObject,\n\t\tauditableItemGraphEdges?: {\n\t\t\ttargetId: string;\n\t\t\taddAlias?: boolean;\n\t\t\taliasAnnotationObject?: IJsonLdNodeObject;\n\t\t}[]\n\t): Promise<void>;\n\n\t/**\n\t * Get a document using it's auditable item graph vertex id and optional revision.\n\t * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.\n\t * @param options Additional options for the get operation.\n\t * @param options.includeBlobStorageMetadata Flag to include the blob storage metadata for the document, defaults to false.\n\t * @param options.includeBlobStorageData Flag to include the blob storage data for the document, defaults to false.\n\t * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.\n\t * @param options.includeRemoved Flag to include deleted documents, defaults to false.\n\t * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.\n\t * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.\n\t * @param cursor The cursor to get the next chunk of revisions.\n\t * @param limit Limit the number of items to return, defaults to 1 so only most recent is returned.\n\t * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.\n\t */\n\tget(\n\t\tauditableItemGraphDocumentId: string,\n\t\toptions?: {\n\t\t\tincludeBlobStorageMetadata?: boolean;\n\t\t\tincludeBlobStorageData?: boolean;\n\t\t\tincludeAttestation?: boolean;\n\t\t\tincludeRemoved?: boolean;\n\t\t\textractRuleGroupId?: string;\n\t\t\textractMimeType?: string;\n\t\t},\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\tentries: IDocumentList;\n\t\tcursor?: string;\n\t}>;\n\n\t/**\n\t * Get a document revision using it's auditable item graph vertex id.\n\t * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.\n\t * @param revision The revision id of the document to get.\n\t * @param options Additional options for the get operation.\n\t * @param options.includeBlobStorageMetadata Flag to include the blob storage metadata for the document, defaults to false.\n\t * @param options.includeBlobStorageData Flag to include the blob storage data for the document, defaults to false.\n\t * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.\n\t * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.\n\t * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.\n\t * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.\n\t */\n\tgetRevision(\n\t\tauditableItemGraphDocumentId: string,\n\t\trevision: number,\n\t\toptions?: {\n\t\t\tincludeBlobStorageMetadata?: boolean;\n\t\t\tincludeBlobStorageData?: boolean;\n\t\t\tincludeAttestation?: boolean;\n\t\t\textractRuleGroupId?: string;\n\t\t\textractMimeType?: string;\n\t\t}\n\t): Promise<IDocument>;\n\n\t/**\n\t * Remove an auditable item graph vertex using it's id.\n\t * The document dateDeleted will be set, but can still be queried with the includeRemoved flag.\n\t * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.\n\t * @param revision The revision of the document to remove.\n\t * @returns Nothing.\n\t */\n\tremoveRevision(auditableItemGraphDocumentId: string, revision: number): Promise<void>;\n\n\t/**\n\t * Find all the document with a specific id.\n\t * @param documentId The document id to find in the graph.\n\t * @param cursor The cursor to get the next chunk of documents.\n\t * @param limit The limit to get the next chunk of documents.\n\t * @returns The graph vertices that contain documents referencing the specified document id.\n\t */\n\tquery(\n\t\tdocumentId: string,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\tentries: IAuditableItemGraphVertexList;\n\t\tcursor?: string;\n\t}>;\n}\n"]}

package/dist/es/models/api/IDocumentManagementCreateRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"IDocumentManagementCreateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementCreateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { UneceDocumentCodes } from \"@twin.org/standards-unece\";\n\n/**\n * Request to create a document as an auditable item graph vertex.\n */\nexport interface IDocumentManagementCreateRequest {\n\t/**\n\t * The body parameters.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The document id to create.\n\t\t */\n\t\tdocumentId: string;\n\n\t\t/**\n\t\t * The format of the document identifier.\n\t\t */\n\t\tdocumentIdFormat: string | undefined;\n\n\t\t/**\n\t\t * The code for the document type.\n\t\t */\n\t\tdocumentCode: UneceDocumentCodes;\n\n\t\t/**\n\t\t * The data to create the document with, in base64.\n\t\t */\n\t\tblob: string;\n\n\t\t/**\n\t\t * Additional information to associate with the document.\n\t\t */\n\t\tannotationObject?: IJsonLdNodeObject;\n\n\t\t/**\n\t\t * The auditable item graph vertices to connect the document to.\n\t\t */\n\t\tauditableItemGraphEdges?: {\n\t\t\ttargetId: string;\n\t\t\taddAlias?: boolean;\n\t\t\taliasAnnotationObject?: IJsonLdNodeObject;\n\t\t}[];\n\n\t\t/**\n\t\t * Flag to create an attestation for the document, defaults to false.\n\t\t */\n\t\tcreateAttestation?: boolean;\n\n\t\t/**\n\t\t * Flag to add the document id as an alias to the aig vertex, defaults to true.\n\t\t */\n\t\taddAlias?: boolean;\n\n\t\t/**\n\t\t * Annotation object for the alias.\n\t\t */\n\t\taliasAnnotationObject?: IJsonLdNodeObject;\n\t};\n}\n"]}
+{"version":3,"file":"IDocumentManagementCreateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementCreateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { UneceDocumentCodeList } from \"@twin.org/standards-unece\";\n\n/**\n * Request to create a document as an auditable item graph vertex.\n */\nexport interface IDocumentManagementCreateRequest {\n\t/**\n\t * The body parameters.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The document id to create.\n\t\t */\n\t\tdocumentId: string;\n\n\t\t/**\n\t\t * The format of the document identifier.\n\t\t */\n\t\tdocumentIdFormat: string | undefined;\n\n\t\t/**\n\t\t * The code for the document type.\n\t\t */\n\t\tdocumentCode: UneceDocumentCodeList;\n\n\t\t/**\n\t\t * The data to create the document with, in base64.\n\t\t */\n\t\tblob: string;\n\n\t\t/**\n\t\t * Additional information to associate with the document.\n\t\t */\n\t\tannotationObject?: IJsonLdNodeObject;\n\n\t\t/**\n\t\t * The auditable item graph vertices to connect the document to.\n\t\t */\n\t\tauditableItemGraphEdges?: {\n\t\t\ttargetId: string;\n\t\t\taddAlias?: boolean;\n\t\t\taliasAnnotationObject?: IJsonLdNodeObject;\n\t\t}[];\n\n\t\t/**\n\t\t * Flag to create an attestation for the document, defaults to false.\n\t\t */\n\t\tcreateAttestation?: boolean;\n\n\t\t/**\n\t\t * Flag to add the document id as an alias to the aig vertex, defaults to true.\n\t\t */\n\t\taddAlias?: boolean;\n\n\t\t/**\n\t\t * Annotation object for the alias.\n\t\t */\n\t\taliasAnnotationObject?: IJsonLdNodeObject;\n\t};\n}\n"]}

package/dist/es/models/api/IDocumentManagementGetRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"IDocumentManagementGetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementGetRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Request to get a document from an auditable item graph vertex.\n */\nexport interface IDocumentManagementGetRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The full id of the document to get.\n\t\t */\n\t\tauditableItemGraphDocumentId: string;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * Include the blob storage metadata in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageMetadata?: boolean | string;\n\n\t\t/**\n\t\t * Include the blob storage data in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageData?: boolean | string;\n\n\t\t/**\n\t\t * Include the attestation information in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeAttestation?: boolean | string;\n\n\t\t/**\n\t\t * Include deleted documents in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeRemoved?: boolean | string;\n\n\t\t/**\n\t\t * If provided will extract data from the document using the specified rule group id.\n\t\t */\n\t\textractRuleGroupId?: string;\n\n\t\t/**\n\t\t * By default extraction will auto detect the mime type of the document, this can be used to override the detection.\n\t\t */\n\t\textractMimeType?: string;\n\n\t\t/**\n\t\t * PLimit the number of items to return, defaults to 1 so only most recent is returned.\n\t\t * @default 1\n\t\t */\n\t\tlimit?: string;\n\n\t\t/**\n\t\t * The cursor to get the next chunk of revisions.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}
+{"version":3,"file":"IDocumentManagementGetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementGetRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Request to get a document from an auditable item graph vertex.\n */\nexport interface IDocumentManagementGetRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The full id of the document to get.\n\t\t */\n\t\tauditableItemGraphDocumentId: string;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * Include the blob storage metadata in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageMetadata?: string;\n\n\t\t/**\n\t\t * Include the blob storage data in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageData?: string;\n\n\t\t/**\n\t\t * Include the attestation information in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeAttestation?: string;\n\n\t\t/**\n\t\t * Include deleted documents in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeRemoved?: string;\n\n\t\t/**\n\t\t * If provided will extract data from the document using the specified rule group id.\n\t\t */\n\t\textractRuleGroupId?: string;\n\n\t\t/**\n\t\t * By default extraction will auto detect the mime type of the document, this can be used to override the detection.\n\t\t */\n\t\textractMimeType?: string;\n\n\t\t/**\n\t\t * PLimit the number of items to return, defaults to 1 so only most recent is returned.\n\t\t * @default 1\n\t\t */\n\t\tlimit?: string;\n\n\t\t/**\n\t\t * The cursor to get the next chunk of revisions.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IDocumentManagementGetResponse.js.map

@@ -1 +1 @@
-{"version":3,"file":"IDocumentManagementGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\nimport type { IDocumentList } from \"../IDocumentList.js\";\n\n/**\n * Response to get a document and optionally revisions from an auditable item graph vertex.\n */\nexport interface IDocumentManagementGetResponse {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The body parameters.\n\t */\n\tbody: IDocumentList;\n}\n"]}
+{"version":3,"file":"IDocumentManagementGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\nimport type { IDocumentList } from \"../IDocumentList.js\";\n\n/**\n * Response to get a document and optionally revisions from an auditable item graph vertex.\n */\nexport interface IDocumentManagementGetResponse {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t\t[HeaderTypes.Link]?: string | string[];\n\t};\n\n\t/**\n\t * The body parameters.\n\t */\n\tbody: IDocumentList;\n}\n"]}

package/dist/es/models/api/IDocumentManagementGetRevisionRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"IDocumentManagementGetRevisionRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementGetRevisionRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Request to get a document revision from an auditable item graph vertex.\n */\nexport interface IDocumentManagementGetRevisionRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The full id of the document to get.\n\t\t */\n\t\tauditableItemGraphDocumentId: string;\n\n\t\t/**\n\t\t * The revision of the document to get.\n\t\t */\n\t\trevision: string;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * Include the blob storage metadata in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageMetadata?: boolean | string;\n\n\t\t/**\n\t\t * Include the blob storage data in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageData?: boolean | string;\n\n\t\t/**\n\t\t * Include the attestation information in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeAttestation?: boolean | string;\n\n\t\t/**\n\t\t * If provided will extract data from the document using the specified rule group id.\n\t\t */\n\t\textractRuleGroupId?: string;\n\n\t\t/**\n\t\t * By default extraction will auto detect the mime type of the document, this can be used to override the detection.\n\t\t */\n\t\textractMimeType?: string;\n\t};\n}\n"]}
+{"version":3,"file":"IDocumentManagementGetRevisionRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementGetRevisionRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Request to get a document revision from an auditable item graph vertex.\n */\nexport interface IDocumentManagementGetRevisionRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The full id of the document to get.\n\t\t */\n\t\tauditableItemGraphDocumentId: string;\n\n\t\t/**\n\t\t * The revision of the document to get.\n\t\t */\n\t\trevision: string;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * Include the blob storage metadata in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageMetadata?: string;\n\n\t\t/**\n\t\t * Include the blob storage data in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageData?: string;\n\n\t\t/**\n\t\t * Include the attestation information in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeAttestation?: string;\n\n\t\t/**\n\t\t * If provided will extract data from the document using the specified rule group id.\n\t\t */\n\t\textractRuleGroupId?: string;\n\n\t\t/**\n\t\t * By default extraction will auto detect the mime type of the document, this can be used to override the detection.\n\t\t */\n\t\textractMimeType?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IDocumentManagementQueryResponse.js.map

@@ -1 +1 @@
-{"version":3,"file":"IDocumentManagementQueryResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementQueryResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuditableItemGraphVertexList } from \"@twin.org/auditable-item-graph-models\";\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Response to query the documents from an auditable item graph vertex.\n */\nexport interface IDocumentManagementQueryResponse {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The body parameters.\n\t */\n\tbody: IAuditableItemGraphVertexList;\n}\n"]}
+{"version":3,"file":"IDocumentManagementQueryResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementQueryResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuditableItemGraphVertexList } from \"@twin.org/auditable-item-graph-models\";\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Response to query the documents from an auditable item graph vertex.\n */\nexport interface IDocumentManagementQueryResponse {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t\t[HeaderTypes.Link]?: string | string[];\n\t};\n\n\t/**\n\t * The body parameters.\n\t */\n\tbody: IAuditableItemGraphVertexList;\n}\n"]}

package/dist/es/models/documentContexts.js

@@ -6,12 +6,28 @@
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export const DocumentContexts = {
     /**
-     * The context root for the document types.
+     * The canonical RDF namespace URI for Document Management.
      */
-    ContextRoot: "https://schema.twindev.org/documents/",
+    Namespace: "https://schema.twindev.org/documents/",
     /**
-     * The context root for the common types.
+     * The value to use in context for Document Management.
      */
-    ContextRootCommon: "https://schema.twindev.org/common/"
+    Context: "https://schema.twindev.org/documents/",
+    /**
+     * The JSON-LD Context URL for Document Management.
+     */
+    JsonLdContext: "https://schema.twindev.org/documents/types.jsonld",
+    /**
+     * The canonical RDF namespace URI for TWIN Common.
+     */
+    NamespaceCommon: "https://schema.twindev.org/common/",
+    /**
+     * The value to use in JSON-LD context for TWIN Common.
+     */
+    ContextCommon: "https://schema.twindev.org/common/",
+    /**
+     * The JSON-LD Context URL for TWIN Common.
+     */
+    JsonLdContextCommon: "https://schema.twindev.org/common/types.jsonld"
 };
 //# sourceMappingURL=documentContexts.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"documentContexts.js","sourceRoot":"","sources":["../../../src/models/documentContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC/B;;OAEG;IACH,WAAW,EAAE,uCAAuC;IAEpD;;OAEG;IACH,iBAAiB,EAAE,oCAAoC;CAC9C,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The contexts of document management objects.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DocumentContexts = {\n\t/**\n\t * The context root for the document types.\n\t */\n\tContextRoot: \"https://schema.twindev.org/documents/\",\n\n\t/**\n\t * The context root for the common types.\n\t */\n\tContextRootCommon: \"https://schema.twindev.org/common/\"\n} as const;\n\n/**\n * The contexts of document management objects.\n */\nexport type DocumentContexts = (typeof DocumentContexts)[keyof typeof DocumentContexts];\n"]}
+{"version":3,"file":"documentContexts.js","sourceRoot":"","sources":["../../../src/models/documentContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC/B;;OAEG;IACH,SAAS,EAAE,uCAAuC;IAElD;;OAEG;IACH,OAAO,EAAE,uCAAuC;IAEhD;;OAEG;IACH,aAAa,EAAE,mDAAmD;IAElE;;OAEG;IACH,eAAe,EAAE,oCAAoC;IAErD;;OAEG;IACH,aAAa,EAAE,oCAAoC;IAEnD;;OAEG;IACH,mBAAmB,EAAE,gDAAgD;CAC5D,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The contexts of document management objects.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DocumentContexts = {\n\t/**\n\t * The canonical RDF namespace URI for Document Management.\n\t */\n\tNamespace: \"https://schema.twindev.org/documents/\",\n\n\t/**\n\t * The value to use in context for Document Management.\n\t */\n\tContext: \"https://schema.twindev.org/documents/\",\n\n\t/**\n\t * The JSON-LD Context URL for Document Management.\n\t */\n\tJsonLdContext: \"https://schema.twindev.org/documents/types.jsonld\",\n\n\t/**\n\t * The canonical RDF namespace URI for TWIN Common.\n\t */\n\tNamespaceCommon: \"https://schema.twindev.org/common/\",\n\n\t/**\n\t * The value to use in JSON-LD context for TWIN Common.\n\t */\n\tContextCommon: \"https://schema.twindev.org/common/\",\n\n\t/**\n\t * The JSON-LD Context URL for TWIN Common.\n\t */\n\tJsonLdContextCommon: \"https://schema.twindev.org/common/types.jsonld\"\n} as const;\n\n/**\n * The contexts of document management objects.\n */\nexport type DocumentContexts = (typeof DocumentContexts)[keyof typeof DocumentContexts];\n"]}

package/dist/es/schemas/Document.json

@@ -11,15 +11,15 @@
             "prefixItems": [
                 {
                     "type": "string",
-                    "const": "https://schema.twindev.org/documents/"
+                    "const": "https://schema.org"
                 },
                 {
                     "type": "string",
-                    "const": "https://schema.twindev.org/common/"
+                    "const": "https://schema.twindev.org/documents/"
                 },
                 {
                     "type": "string",
-                    "const": "https://schema.org"
+                    "const": "https://schema.twindev.org/common/"
                 }
             ],
             "items": {
@@ -37,66 +37,66 @@
         },
         "documentId": {
             "type": "string",
-            "description": "The id of the document."
+            "description": "The id of the document. json-ld type:schema:identifier"
         },
         "documentIdFormat": {
             "type": "string",
-            "description": "The format of the document id."
+            "description": "The format of the document id. json-ld type:schema:Text"
         },
         "documentCode": {
-            "$ref": "https://vocabulary.uncefact.org/DocumentCodeList",
-            "description": "The code for the document type."
+            "$ref": "https://schema.twindev.org/unece/UneceDocumentCodeList",
+            "description": "The code for the document type. json-ld type:schema:identifier"
         },
         "documentRevision": {
             "type": "number",
-            "description": "The revision of the document as a 0 based index."
+            "description": "The revision of the document as a 0 based index. json-ld type:schema:Integer"
         },
         "annotationObject": {
             "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-            "description": "Additional annotation information for the document."
+            "description": "Additional annotation information for the document. json-ld namespace:twin-common"
         },
         "blobStorageId": {
             "type": "string",
-            "description": "The blob storage id for the document."
+            "description": "The blob storage id for the document. json-ld type:schema:identifier"
         },
-        "blobHash": {
+        "integrity": {
             "type": "string",
-            "description": "The hash of the blob data."
+            "description": "The integrity of the blob data. json-ld namespace:twin-common"
         },
         "blobStorageEntry": {
             "$ref": "https://schema.twindev.org/blob-storage/BlobStorageEntry",
-            "description": "The additional JSON-LD for blob storage if it was requested."
+            "description": "The additional JSON-LD for blob storage if it was requested. json-ld id"
         },
         "extractedData": {
-            "description": "The data extracted from the document using data extraction services."
+            "description": "The data extracted from the document using data extraction services. json-ld type:json"
         },
         "attestationId": {
             "type": "string",
-            "description": "The attestation for the document if one was created."
+            "description": "The attestation for the document if one was created. json-ld type:schema:identifier"
         },
         "attestationInformation": {
             "$ref": "https://schema.twindev.org/attestation/AttestationInformation",
-            "description": "The additional JSON-LD for attestation storage if it was requested."
+            "description": "The additional JSON-LD for attestation storage if it was requested. json-ld id"
         },
         "dateCreated": {
             "type": "string",
-            "description": "The date/time of when the document was created."
+            "description": "The date/time of when the document was created. json-ld namespace:schema"
         },
         "dateModified": {
             "type": "string",
-            "description": "The date/time of when the document was modified."
+            "description": "The date/time of when the document was modified. json-ld namespace:schema"
         },
         "dateDeleted": {
             "type": "string",
-            "description": "The date/time of when the document was deleted, as we never actually remove items."
+            "description": "The date/time of when the document was deleted, as we never actually remove items. json-ld namespace:schema"
         },
         "organizationIdentity": {
             "type": "string",
-            "description": "The organization which added the document to the graph."
+            "description": "The organization which added the document to the graph. json-ld namespace:twin-common"
         },
         "userIdentity": {
             "type": "string",
-            "description": "The user who added the document to the graph."
+            "description": "The user who added the document to the graph. json-ld namespace:twin-common"
         }
     },
     "required": [
@@ -107,8 +107,7 @@
         "documentCode",
         "documentRevision",
         "blobStorageId",
-        "blobHash",
+        "integrity",
         "dateCreated"
-    ],
-    "additionalProperties": false
+    ]
 }

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

@@ -2,7 +2,7 @@ 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 { SchemaOrgContexts } from "@twin.org/standards-schema-org";
-import type { UneceDocumentCodes } from "@twin.org/standards-unece";
+import type { UneceDocumentCodeList } from "@twin.org/standards-unece";
 import type { DocumentContexts } from "./documentContexts.js";
 import type { DocumentTypes } from "./documentTypes.js";
 /**
@@ -13,9 +13,9 @@ export interface IDocument {
      * JSON-LD Context.
      */
     "@context": [
-        typeof DocumentContexts.ContextRoot,
-        typeof DocumentContexts.ContextRootCommon,
-        typeof SchemaOrgContexts.ContextRoot,
+        typeof SchemaOrgContexts.Context,
+        typeof DocumentContexts.Context,
+        typeof DocumentContexts.ContextCommon,
         ...IJsonLdContextDefinitionElement[]
     ];
     /**
@@ -28,66 +28,82 @@ export interface IDocument {
     id: string;
     /**
      * The id of the document.
+     * json-ld type:schema:identifier
      */
     documentId: string;
     /**
      * The format of the document id.
+     * json-ld type:schema:Text
      */
     documentIdFormat?: string;
     /**
      * The code for the document type.
+     * json-ld type:schema:identifier
      */
-    documentCode: UneceDocumentCodes;
+    documentCode: UneceDocumentCodeList;
     /**
      * The revision of the document as a 0 based index.
+     * json-ld type:schema:Integer
      */
     documentRevision: number;
     /**
      * Additional annotation information for the document.
+     * json-ld namespace:twin-common
      */
     annotationObject?: IJsonLdNodeObject;
     /**
      * The blob storage id for the document.
+     * json-ld type:schema:identifier
      */
     blobStorageId: string;
     /**
-     * The hash of the blob data.
+     * The integrity of the blob data.
+     * json-ld namespace:twin-common
      */
-    blobHash: string;
+    integrity: string;
     /**
      * The additional JSON-LD for blob storage if it was requested.
+     * json-ld id
      */
     blobStorageEntry?: IBlobStorageEntry;
     /**
      * The data extracted from the document using data extraction services.
+     * json-ld type:json
      */
     extractedData?: unknown;
     /**
      * The attestation for the document if one was created.
+     * json-ld type:schema:identifier
      */
     attestationId?: string;
     /**
      * The additional JSON-LD for attestation storage if it was requested.
+     * json-ld id
      */
     attestationInformation?: IAttestationInformation;
     /**
      * The date/time of when the document was created.
+     * json-ld namespace:schema
      */
     dateCreated: string;
     /**
      * The date/time of when the document was modified.
+     * 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
      */
     dateDeleted?: string;
     /**
      * The organization which added the document to the graph.
+     * json-ld namespace:twin-common
      */
     organizationIdentity?: string;
     /**
      * The user who added the document to the graph.
+     * json-ld namespace:twin-common
      */
     userIdentity?: string;
 }

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

@@ -1,5 +1,5 @@
 import type { SchemaOrgContexts } from "@twin.org/standards-schema-org";
-import type { UneceDocumentCodes } from "@twin.org/standards-unece";
+import type { UneceDocumentCodeList } from "@twin.org/standards-unece";
 import type { DocumentContexts } from "./documentContexts.js";
 import type { DocumentTypes } from "./documentTypes.js";
 /**
@@ -10,9 +10,9 @@ export interface IDocumentAttestation {
      * JSON-LD Context.
      */
     "@context": [
-        typeof DocumentContexts.ContextRoot,
-        typeof DocumentContexts.ContextRootCommon,
-        typeof SchemaOrgContexts.ContextRoot
+        typeof SchemaOrgContexts.Context,
+        typeof DocumentContexts.Context,
+        typeof DocumentContexts.ContextCommon
     ];
     /**
      * JSON-LD Type.
@@ -20,22 +20,27 @@ export interface IDocumentAttestation {
     type: typeof DocumentTypes.DocumentAttestation;
     /**
      * The id of the document.
+     * json-ld type:schema:identifier
      */
     documentId: string;
     /**
      * The code for the document type.
+     * json-ld type:schema:identifier
      */
-    documentCode: UneceDocumentCodes;
+    documentCode: UneceDocumentCodeList;
     /**
      * The revision of the document as a 0 based index.
+     * json-ld type:schema:Integer
      */
     documentRevision: number;
     /**
      * The date/time of when the document was created.
+     * json-ld namespace:schema
      */
     dateCreated: string;
     /**
-     * The hash of the document being attested.
+     * The integrity of the document being attested.
+     * json-ld namespace:twin-common
      */
-    blobHash: string;
+    integrity: string;
 }

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

@@ -10,9 +10,9 @@ export interface IDocumentList {
      * JSON-LD Context.
      */
     "@context": [
-        typeof SchemaOrgContexts.ContextRoot,
-        typeof DocumentContexts.ContextRoot,
-        typeof DocumentContexts.ContextRootCommon,
+        typeof SchemaOrgContexts.Context,
+        typeof DocumentContexts.Context,
+        typeof DocumentContexts.ContextCommon,
         ...IJsonLdContextDefinitionElement[]
     ];
     /**
@@ -21,14 +21,12 @@ export interface IDocumentList {
     type: typeof SchemaOrgTypes.ItemList;
     /**
      * The list of documents.
+     * json-ld namespace:schema
      */
     [SchemaOrgTypes.ItemListElement]: IDocument[];
     /**
      * The ids of the other vertices which are connected to the document.
+     * json-ld container:set
      */
     edges?: string[];
-    /**
-     * The cursor to get the next chunk of documents.
-     */
-    [SchemaOrgTypes.NextItem]?: string;
 }

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

@@ -1,7 +1,7 @@
 import type { IAuditableItemGraphVertexList } from "@twin.org/auditable-item-graph-models";
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { UneceDocumentCodes } from "@twin.org/standards-unece";
+import type { UneceDocumentCodeList } from "@twin.org/standards-unece";
 import type { IDocument } from "./IDocument.js";
 import type { IDocumentList } from "./IDocumentList.js";
 /**
@@ -24,7 +24,7 @@ export interface IDocumentManagementComponent extends IComponent {
      * @param options.aliasAnnotationObject Annotation object for the alias.
      * @returns The auditable item graph vertex created for the document including its revision.
      */
-    create(documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodes, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
+    create(documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodeList, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
         targetId: string;
         addAlias?: boolean;
         aliasAnnotationObject?: IJsonLdNodeObject;
@@ -69,7 +69,10 @@ export interface IDocumentManagementComponent extends IComponent {
         includeRemoved?: boolean;
         extractRuleGroupId?: string;
         extractMimeType?: string;
-    }, cursor?: string, limit?: number): Promise<IDocumentList>;
+    }, cursor?: string, limit?: number): Promise<{
+        entries: IDocumentList;
+        cursor?: string;
+    }>;
     /**
      * Get a document revision using it's auditable item graph vertex id.
      * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
@@ -104,5 +107,8 @@ export interface IDocumentManagementComponent extends IComponent {
      * @param limit The limit to get the next chunk of documents.
      * @returns The graph vertices that contain documents referencing the specified document id.
      */
-    query(documentId: string, cursor?: string, limit?: number): Promise<IAuditableItemGraphVertexList>;
+    query(documentId: string, cursor?: string, limit?: number): Promise<{
+        entries: IAuditableItemGraphVertexList;
+        cursor?: string;
+    }>;
 }

package/dist/types/models/api/IDocumentManagementCreateRequest.d.ts

@@ -1,5 +1,5 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { UneceDocumentCodes } from "@twin.org/standards-unece";
+import type { UneceDocumentCodeList } from "@twin.org/standards-unece";
 /**
  * Request to create a document as an auditable item graph vertex.
  */
@@ -19,7 +19,7 @@ export interface IDocumentManagementCreateRequest {
         /**
          * The code for the document type.
          */
-        documentCode: UneceDocumentCodes;
+        documentCode: UneceDocumentCodeList;
         /**
          * The data to create the document with, in base64.
          */

package/dist/types/models/api/IDocumentManagementGetRequest.d.ts

@@ -26,22 +26,22 @@ export interface IDocumentManagementGetRequest {
          * Include the blob storage metadata in the response.
          * @default false
          */
-        includeBlobStorageMetadata?: boolean | string;
+        includeBlobStorageMetadata?: string;
         /**
          * Include the blob storage data in the response.
          * @default false
          */
-        includeBlobStorageData?: boolean | string;
+        includeBlobStorageData?: string;
         /**
          * Include the attestation information in the response.
          * @default false
          */
-        includeAttestation?: boolean | string;
+        includeAttestation?: string;
         /**
          * Include deleted documents in the response.
          * @default false
          */
-        includeRemoved?: boolean | string;
+        includeRemoved?: string;
         /**
          * If provided will extract data from the document using the specified rule group id.
          */

package/dist/types/models/api/IDocumentManagementGetResponse.d.ts

@@ -9,6 +9,7 @@ export interface IDocumentManagementGetResponse {
      */
     headers?: {
         [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+        [HeaderTypes.Link]?: string | string[];
     };
     /**
      * The body parameters.

package/dist/types/models/api/IDocumentManagementGetRevisionRequest.d.ts

@@ -30,17 +30,17 @@ export interface IDocumentManagementGetRevisionRequest {
          * Include the blob storage metadata in the response.
          * @default false
          */
-        includeBlobStorageMetadata?: boolean | string;
+        includeBlobStorageMetadata?: string;
         /**
          * Include the blob storage data in the response.
          * @default false
          */
-        includeBlobStorageData?: boolean | string;
+        includeBlobStorageData?: string;
         /**
          * Include the attestation information in the response.
          * @default false
          */
-        includeAttestation?: boolean | string;
+        includeAttestation?: string;
         /**
          * If provided will extract data from the document using the specified rule group id.
          */

package/dist/types/models/api/IDocumentManagementQueryResponse.d.ts

@@ -9,6 +9,7 @@ export interface IDocumentManagementQueryResponse {
      */
     headers?: {
         [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+        [HeaderTypes.Link]?: string | string[];
     };
     /**
      * The body parameters.

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

@@ -3,13 +3,29 @@
  */
 export declare const DocumentContexts: {
     /**
-     * The context root for the document types.
+     * The canonical RDF namespace URI for Document Management.
      */
-    readonly ContextRoot: "https://schema.twindev.org/documents/";
+    readonly Namespace: "https://schema.twindev.org/documents/";
     /**
-     * The context root for the common types.
+     * The value to use in context for Document Management.
      */
-    readonly ContextRootCommon: "https://schema.twindev.org/common/";
+    readonly Context: "https://schema.twindev.org/documents/";
+    /**
+     * The JSON-LD Context URL for Document Management.
+     */
+    readonly JsonLdContext: "https://schema.twindev.org/documents/types.jsonld";
+    /**
+     * The canonical RDF namespace URI for TWIN Common.
+     */
+    readonly NamespaceCommon: "https://schema.twindev.org/common/";
+    /**
+     * The value to use in JSON-LD context for TWIN Common.
+     */
+    readonly ContextCommon: "https://schema.twindev.org/common/";
+    /**
+     * The JSON-LD Context URL for TWIN Common.
+     */
+    readonly JsonLdContextCommon: "https://schema.twindev.org/common/types.jsonld";
 };
 /**
  * The contexts of document management objects.

package/docs/changelog.md

@@ -1,5 +1,76 @@
 # @twin.org/document-management-models - Changelog
 
+## [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)
+
+
+### Features
+
+* add ts-to-jsonld-context tool ([da11115](https://github.com/twinfoundation/document-management/commit/da111155614dc7f7789480c8b0d2f03c66a16ae4))
+* blobHash to integrity ([#38](https://github.com/twinfoundation/document-management/issues/38)) ([2d45756](https://github.com/twinfoundation/document-management/commit/2d457565ba61d260ace12a762e592b6b1a65788d))
+
+## [0.0.3-next.9](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.8...document-management-models-v0.0.3-next.9) (2026-01-26)
+
+
+### Miscellaneous Chores
+
+* **document-management-models:** Synchronize repo versions
+
+## [0.0.3-next.8](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.7...document-management-models-v0.0.3-next.8) (2026-01-26)
+
+
+### Miscellaneous Chores
+
+* **document-management-models:** Synchronize repo versions
+
+## [0.0.3-next.7](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.6...document-management-models-v0.0.3-next.7) (2026-01-23)
+
+
+### Features
+
+* replace nextItem property with Link header ([#34](https://github.com/twinfoundation/document-management/issues/34)) ([3f04c3f](https://github.com/twinfoundation/document-management/commit/3f04c3fb5c9ec0c56f213089a15cc247fbfbd59c))
+
+## [0.0.3-next.6](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.5...document-management-models-v0.0.3-next.6) (2026-01-22)
+
+
+### Features
+
+* update contexts ([#32](https://github.com/twinfoundation/document-management/issues/32)) ([2fc1d92](https://github.com/twinfoundation/document-management/commit/2fc1d9200ecd8b755efb552c5f84f996cb61e64a))
+
+## [0.0.3-next.5](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.4...document-management-models-v0.0.3-next.5) (2026-01-14)
+
+
+### Features
+
+* update contexts and namespaces ([#29](https://github.com/twinfoundation/document-management/issues/29)) ([ef7abc0](https://github.com/twinfoundation/document-management/commit/ef7abc01d10b3f9528be8afaa21dbd00181939ae))
+
+## [0.0.3-next.4](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.3...document-management-models-v0.0.3-next.4) (2026-01-06)
+
+
+### Features
+
+* update unece dependencies ([a27548c](https://github.com/twinfoundation/document-management/commit/a27548cdebbe1d9577fc8341166538c2f07348a3))
+
+## [0.0.3-next.3](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.2...document-management-models-v0.0.3-next.3) (2025-12-03)
+
+
+### Features
+
+* use updated unece types ([c141a89](https://github.com/twinfoundation/document-management/commit/c141a895138cb45fa0b1e95c42f56e31708c846c))
+
+## [0.0.3-next.2](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.1...document-management-models-v0.0.3-next.2) (2025-11-28)
+
+
+### Features
+
+* update background task service ([5c380dc](https://github.com/twinfoundation/document-management/commit/5c380dca3114254201768f184f9486828501ff66))
+
 ## [0.0.3-next.1](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.0...document-management-models-v0.0.3-next.1) (2025-11-12)
 
 

package/docs/reference/interfaces/IDocument.md

@@ -6,7 +6,7 @@ Interface describing a document.
 
 ### @context
 
-> **@context**: \[`"https://schema.twindev.org/documents/"`, `"https://schema.twindev.org/common/"`, `"https://schema.org"`, `...IJsonLdContextDefinitionElement[]`\]
+> **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/documents/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
@@ -33,6 +33,7 @@ The full id of the document.
 > **documentId**: `string`
 
 The id of the document.
+json-ld type:schema:identifier
 
 ***
 
@@ -41,14 +42,16 @@ The id of the document.
 > `optional` **documentIdFormat**: `string`
 
 The format of the document id.
+json-ld type:schema:Text
 
 ***
 
 ### documentCode
 
-> **documentCode**: `string`
+> **documentCode**: `UneceDocumentCodeList`
 
 The code for the document type.
+json-ld type:schema:identifier
 
 ***
 
@@ -57,6 +60,7 @@ The code for the document type.
 > **documentRevision**: `number`
 
 The revision of the document as a 0 based index.
+json-ld type:schema:Integer
 
 ***
 
@@ -65,6 +69,7 @@ The revision of the document as a 0 based index.
 > `optional` **annotationObject**: `IJsonLdNodeObject`
 
 Additional annotation information for the document.
+json-ld namespace:twin-common
 
 ***
 
@@ -73,14 +78,16 @@ Additional annotation information for the document.
 > **blobStorageId**: `string`
 
 The blob storage id for the document.
+json-ld type:schema:identifier
 
 ***
 
-### blobHash
+### integrity
 
-> **blobHash**: `string`
+> **integrity**: `string`
 
-The hash of the blob data.
+The integrity of the blob data.
+json-ld namespace:twin-common
 
 ***
 
@@ -89,6 +96,7 @@ The hash of the blob data.
 > `optional` **blobStorageEntry**: `IBlobStorageEntry`
 
 The additional JSON-LD for blob storage if it was requested.
+json-ld id
 
 ***
 
@@ -97,6 +105,7 @@ The additional JSON-LD for blob storage if it was requested.
 > `optional` **extractedData**: `unknown`
 
 The data extracted from the document using data extraction services.
+json-ld type:json
 
 ***
 
@@ -105,6 +114,7 @@ The data extracted from the document using data extraction services.
 > `optional` **attestationId**: `string`
 
 The attestation for the document if one was created.
+json-ld type:schema:identifier
 
 ***
 
@@ -113,6 +123,7 @@ The attestation for the document if one was created.
 > `optional` **attestationInformation**: `IAttestationInformation`
 
 The additional JSON-LD for attestation storage if it was requested.
+json-ld id
 
 ***
 
@@ -121,6 +132,7 @@ The additional JSON-LD for attestation storage if it was requested.
 > **dateCreated**: `string`
 
 The date/time of when the document was created.
+json-ld namespace:schema
 
 ***
 
@@ -129,6 +141,7 @@ The date/time of when the document was created.
 > `optional` **dateModified**: `string`
 
 The date/time of when the document was modified.
+json-ld namespace:schema
 
 ***
 
@@ -137,6 +150,7 @@ The date/time of when the document was modified.
 > `optional` **dateDeleted**: `string`
 
 The date/time of when the document was deleted, as we never actually remove items.
+json-ld namespace:schema
 
 ***
 
@@ -145,6 +159,7 @@ The date/time of when the document was deleted, as we never actually remove item
 > `optional` **organizationIdentity**: `string`
 
 The organization which added the document to the graph.
+json-ld namespace:twin-common
 
 ***
 
@@ -153,3 +168,4 @@ The organization which added the document to the graph.
 > `optional` **userIdentity**: `string`
 
 The user who added the document to the graph.
+json-ld namespace:twin-common

package/docs/reference/interfaces/IDocumentAttestation.md

@@ -6,7 +6,7 @@ Interface describing a document attestation.
 
 ### @context
 
-> **@context**: \[`"https://schema.twindev.org/documents/"`, `"https://schema.twindev.org/common/"`, `"https://schema.org"`\]
+> **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/documents/"`, `"https://schema.twindev.org/common/"`\]
 
 JSON-LD Context.
 
@@ -25,14 +25,16 @@ JSON-LD Type.
 > **documentId**: `string`
 
 The id of the document.
+json-ld type:schema:identifier
 
 ***
 
 ### documentCode
 
-> **documentCode**: `string`
+> **documentCode**: `UneceDocumentCodeList`
 
 The code for the document type.
+json-ld type:schema:identifier
 
 ***
 
@@ -41,6 +43,7 @@ The code for the document type.
 > **documentRevision**: `number`
 
 The revision of the document as a 0 based index.
+json-ld type:schema:Integer
 
 ***
 
@@ -49,11 +52,13 @@ The revision of the document as a 0 based index.
 > **dateCreated**: `string`
 
 The date/time of when the document was created.
+json-ld namespace:schema
 
 ***
 
-### blobHash
+### integrity
 
-> **blobHash**: `string`
+> **integrity**: `string`
 
-The hash of the document being attested.
+The integrity of the document being attested.
+json-ld namespace:twin-common

package/docs/reference/interfaces/IDocumentList.md

@@ -25,6 +25,7 @@ JSON-LD Type.
 > **itemListElement**: [`IDocument`](IDocument.md)[]
 
 The list of documents.
+json-ld namespace:schema
 
 ***
 
@@ -33,11 +34,4 @@ The list of documents.
 > `optional` **edges**: `string`[]
 
 The ids of the other vertices which are connected to the document.
-
-***
-
-### nextItem?
-
-> `optional` **nextItem**: `string`
-
-The cursor to get the next chunk of documents.
+json-ld container:set

package/docs/reference/interfaces/IDocumentManagementComponent.md

@@ -32,7 +32,7 @@ The format of the document identifier.
 
 ##### documentCode
 
-`string`
+`UneceDocumentCodeList`
 
 The code for the document type.
 
@@ -128,7 +128,7 @@ Nothing.
 
 ### get()
 
-> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `limit?`): `Promise`\<[`IDocumentList`](IDocumentList.md)\>
+> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: [`IDocumentList`](IDocumentList.md); `cursor?`: `string`; \}\>
 
 Get a document using it's auditable item graph vertex id and optional revision.
 
@@ -194,7 +194,7 @@ Limit the number of items to return, defaults to 1 so only most recent is return
 
 #### Returns
 
-`Promise`\<[`IDocumentList`](IDocumentList.md)\>
+`Promise`\<\{ `entries`: [`IDocumentList`](IDocumentList.md); `cursor?`: `string`; \}\>
 
 The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
 
@@ -293,7 +293,7 @@ Nothing.
 
 ### query()
 
-> **query**(`documentId`, `cursor?`, `limit?`): `Promise`\<`IAuditableItemGraphVertexList`\>
+> **query**(`documentId`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IAuditableItemGraphVertexList`; `cursor?`: `string`; \}\>
 
 Find all the document with a specific id.
 
@@ -319,6 +319,6 @@ The limit to get the next chunk of documents.
 
 #### Returns
 
-`Promise`\<`IAuditableItemGraphVertexList`\>
+`Promise`\<\{ `entries`: `IAuditableItemGraphVertexList`; `cursor?`: `string`; \}\>
 
 The graph vertices that contain documents referencing the specified document id.

package/docs/reference/interfaces/IDocumentManagementCreateRequest.md

@@ -24,7 +24,7 @@ The format of the document identifier.
 
 #### documentCode
 
-> **documentCode**: `string`
+> **documentCode**: `UneceDocumentCodeList`
 
 The code for the document type.
 

package/docs/reference/interfaces/IDocumentManagementGetRequest.md

@@ -38,7 +38,7 @@ The query parameters.
 
 #### includeBlobStorageMetadata?
 
-> `optional` **includeBlobStorageMetadata**: `string` \| `boolean`
+> `optional` **includeBlobStorageMetadata**: `string`
 
 Include the blob storage metadata in the response.
 
@@ -50,7 +50,7 @@ false
 
 #### includeBlobStorageData?
 
-> `optional` **includeBlobStorageData**: `string` \| `boolean`
+> `optional` **includeBlobStorageData**: `string`
 
 Include the blob storage data in the response.
 
@@ -62,7 +62,7 @@ false
 
 #### includeAttestation?
 
-> `optional` **includeAttestation**: `string` \| `boolean`
+> `optional` **includeAttestation**: `string`
 
 Include the attestation information in the response.
 
@@ -74,7 +74,7 @@ false
 
 #### includeRemoved?
 
-> `optional` **includeRemoved**: `string` \| `boolean`
+> `optional` **includeRemoved**: `string`
 
 Include deleted documents in the response.
 

package/docs/reference/interfaces/IDocumentManagementGetResponse.md

@@ -14,6 +14,10 @@ The headers which can be used to determine the response data type.
 
 > **content-type**: `"application/json"` \| `"application/ld+json"`
 
+#### link?
+
+> `optional` **link**: `string` \| `string`[]
+
 ***
 
 ### body

package/docs/reference/interfaces/IDocumentManagementGetRevisionRequest.md

@@ -44,7 +44,7 @@ The query parameters.
 
 #### includeBlobStorageMetadata?
 
-> `optional` **includeBlobStorageMetadata**: `string` \| `boolean`
+> `optional` **includeBlobStorageMetadata**: `string`
 
 Include the blob storage metadata in the response.
 
@@ -56,7 +56,7 @@ false
 
 #### includeBlobStorageData?
 
-> `optional` **includeBlobStorageData**: `string` \| `boolean`
+> `optional` **includeBlobStorageData**: `string`
 
 Include the blob storage data in the response.
 
@@ -68,7 +68,7 @@ false
 
 #### includeAttestation?
 
-> `optional` **includeAttestation**: `string` \| `boolean`
+> `optional` **includeAttestation**: `string`
 
 Include the attestation information in the response.
 

package/docs/reference/interfaces/IDocumentManagementQueryResponse.md

@@ -14,6 +14,10 @@ The headers which can be used to determine the response data type.
 
 > **content-type**: `"application/json"` \| `"application/ld+json"`
 
+#### link?
+
+> `optional` **link**: `string` \| `string`[]
+
 ***
 
 ### body

package/docs/reference/variables/DocumentContexts.md

@@ -6,14 +6,38 @@ The contexts of document management objects.
 
 ## Type Declaration
 
-### ContextRoot
+### Namespace
 
-> `readonly` **ContextRoot**: `"https://schema.twindev.org/documents/"` = `"https://schema.twindev.org/documents/"`
+> `readonly` **Namespace**: `"https://schema.twindev.org/documents/"` = `"https://schema.twindev.org/documents/"`
 
-The context root for the document types.
+The canonical RDF namespace URI for Document Management.
 
-### ContextRootCommon
+### Context
 
-> `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
+> `readonly` **Context**: `"https://schema.twindev.org/documents/"` = `"https://schema.twindev.org/documents/"`
 
-The context root for the common types.
+The value to use in context for Document Management.
+
+### 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
+
+> `readonly` **NamespaceCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
+
+The canonical RDF namespace URI for TWIN Common.
+
+### 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
+
+> `readonly` **JsonLdContextCommon**: `"https://schema.twindev.org/common/types.jsonld"` = `"https://schema.twindev.org/common/types.jsonld"`
+
+The JSON-LD Context URL for TWIN Common.

package/package.json

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