@twin.org/document-management-service 0.0.2-next.4 → 0.0.3-next.10

package/docs/open-api/spec.json

@@ -68,7 +68,7 @@
 								"schema": {
 									"type": "string"
 								},
-								"description": "e.g. aig:123456"
+								"description": "e.g. aig%3A123456"
 							}
 						}
 					},
@@ -240,10 +240,10 @@
 																	"type": "DigitalDocument",
 																	"name": "bill-of-lading"
 																},
-																"blobHash": "sha256:E3Duqrp6bHojSx+CzDttAToAiP1eFkCDAPBbKLABVGM=",
+																"integrity": "sha256-E3Duqrp6bHojSx+CzDttAToAiP1eFkCDAPBbKLABVGM=",
 																"blobStorageId": "blob:memory:1370eeaaba7a6c7a234b1f82cc3b6d013a0088fd5e16408300f05b28b0015463",
 																"dateCreated": "2024-08-22T04:13:20.000Z",
-																"nodeIdentity": "did:entity-storage:0x0101010101010101010101010101010101010101010101010101010101010101",
+																"organizationIdentity": "did:entity-storage:0x0101010101010101010101010101010101010101010101010101010101010101",
 																"userIdentity": "did:entity-storage:0x0404040404040404040404040404040404040404040404040404040404040404"
 															}
 														}
@@ -451,10 +451,7 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"boolean",
-								"string"
-							]
+							"type": "string"
 						}
 					},
 					{
@@ -463,10 +460,7 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"boolean",
-								"string"
-							]
+							"type": "string"
 						}
 					},
 					{
@@ -475,10 +469,7 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"boolean",
-								"string"
-							]
+							"type": "string"
 						}
 					},
 					{
@@ -487,10 +478,7 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"boolean",
-								"string"
-							]
+							"type": "string"
 						}
 					},
 					{
@@ -564,9 +552,9 @@
 											"itemListElement": [
 												{
 													"@context": [
+														"https://schema.org",
 														"https://schema.twindev.org/documents/",
-														"https://schema.twindev.org/common/",
-														"https://schema.org"
+														"https://schema.twindev.org/common/"
 													],
 													"type": "Document",
 													"id": "2721000:0",
@@ -575,14 +563,14 @@
 													"documentCode": "unece:DocumentCodeList#705",
 													"documentRevision": 0,
 													"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
-													"blobHash": "sha256:123456",
+													"integrity": "sha256-123456",
 													"dateCreated": "2024-01-01T00:00:00Z",
 													"annotationObject": {
 														"@context": "https://schema.org",
 														"@type": "DigitalDocument",
 														"name": "myfile.pdf"
 													},
-													"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+													"organizationIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
 													"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
 												}
 											]
@@ -606,9 +594,9 @@
 											"itemListElement": [
 												{
 													"@context": [
+														"https://schema.org",
 														"https://schema.twindev.org/documents/",
-														"https://schema.twindev.org/common/",
-														"https://schema.org"
+														"https://schema.twindev.org/common/"
 													],
 													"type": "Document",
 													"id": "2721000:0",
@@ -617,14 +605,14 @@
 													"documentCode": "unece:DocumentCodeList#705",
 													"documentRevision": 0,
 													"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
-													"blobHash": "sha256:123456",
+													"integrity": "sha256-123456",
 													"dateCreated": "2024-01-01T00:00:00Z",
 													"annotationObject": {
 														"@context": "https://schema.org",
 														"@type": "DigitalDocument",
 														"name": "myfile.pdf"
 													},
-													"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+													"organizationIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
 													"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
 												}
 											]
@@ -763,9 +751,9 @@
 									"DocumentManagementGetRevisionResponseExample": {
 										"value": {
 											"@context": [
+												"https://schema.org",
 												"https://schema.twindev.org/documents/",
-												"https://schema.twindev.org/common/",
-												"https://schema.org"
+												"https://schema.twindev.org/common/"
 											],
 											"type": "Document",
 											"id": "2721000:0",
@@ -774,14 +762,14 @@
 											"documentCode": "unece:DocumentCodeList#705",
 											"documentRevision": 1,
 											"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
-											"blobHash": "sha256:123456",
+											"integrity": "sha256-123456",
 											"dateCreated": "2024-01-01T00:00:00Z",
 											"annotationObject": {
 												"@context": "https://schema.org",
 												"@type": "DigitalDocument",
 												"name": "myfile.pdf"
 											},
-											"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+											"organizationIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
 											"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
 										}
 									}
@@ -795,9 +783,9 @@
 									"DocumentManagementGetRevisionResponseExample": {
 										"value": {
 											"@context": [
+												"https://schema.org",
 												"https://schema.twindev.org/documents/",
-												"https://schema.twindev.org/common/",
-												"https://schema.org"
+												"https://schema.twindev.org/common/"
 											],
 											"type": "Document",
 											"id": "2721000:0",
@@ -806,14 +794,14 @@
 											"documentCode": "unece:DocumentCodeList#705",
 											"documentRevision": 1,
 											"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
-											"blobHash": "sha256:123456",
+											"integrity": "sha256-123456",
 											"dateCreated": "2024-01-01T00:00:00Z",
 											"annotationObject": {
 												"@context": "https://schema.org",
 												"@type": "DigitalDocument",
 												"name": "myfile.pdf"
 											},
-											"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+											"organizationIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
 											"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
 										}
 									}
@@ -1030,24 +1018,24 @@
 					"@context": {
 						"type": "array",
 						"minItems": 3,
-						"items": {
-							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-						},
 						"description": "JSON-LD Context.",
 						"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": {
+							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+						}
 					},
 					"type": {
 						"type": "string",
@@ -1060,62 +1048,62 @@
 					},
 					"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://schema.twindev.org/unece/UneceDocumentCodes"
+						"$ref": "https://schema.twindev.org/unece/UneceDocumentCodeList"
 					},
 					"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"
 					},
 					"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"
 					},
 					"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"
 					},
 					"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"
 					},
-					"nodeIdentity": {
+					"organizationIdentity": {
 						"type": "string",
-						"description": "The node 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": [
@@ -1126,10 +1114,8 @@
 					"documentCode",
 					"documentRevision",
 					"blobStorageId",
-					"blobHash",
-					"dateCreated",
-					"nodeIdentity",
-					"userIdentity"
+					"integrity",
+					"dateCreated"
 				],
 				"additionalProperties": false,
 				"description": "Interface describing a document."
@@ -1140,9 +1126,6 @@
 					"@context": {
 						"type": "array",
 						"minItems": 3,
-						"items": {
-							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-						},
 						"description": "JSON-LD Context.",
 						"prefixItems": [
 							{
@@ -1157,7 +1140,10 @@
 								"type": "string",
 								"const": "https://schema.twindev.org/common/"
 							}
-						]
+						],
+						"items": {
+							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+						}
 					},
 					"type": {
 						"type": "string",
@@ -1166,27 +1152,17 @@
 					},
 					"itemListElement": {
 						"type": "array",
-						"items": false,
-						"description": "The list of documents.",
-						"prefixItems": [
-							{
-								"$ref": "#/components/schemas/Document"
-							}
-						]
+						"items": {
+							"$ref": "#/components/schemas/Document"
+						},
+						"description": "The list of documents. json-ld namespace:schema"
 					},
 					"edges": {
 						"type": "array",
-						"items": false,
-						"description": "The ids of the other vertices which are connected to the document.",
-						"prefixItems": [
-							{
-								"type": "string"
-							}
-						]
-					},
-					"nextItem": {
-						"type": "string",
-						"description": "The cursor to get the next chunk of documents."
+						"items": {
+							"type": "string"
+						},
+						"description": "The ids of the other vertices which are connected to the document. json-ld container:set"
 					}
 				},
 				"required": [
@@ -1209,7 +1185,7 @@
 						"description": "The format of the document identifier."
 					},
 					"documentCode": {
-						"$ref": "https://schema.twindev.org/unece/UneceDocumentCodes"
+						"$ref": "https://schema.twindev.org/unece/UneceDocumentCodeList"
 					},
 					"blob": {
 						"type": "string",
@@ -1220,28 +1196,25 @@
 					},
 					"auditableItemGraphEdges": {
 						"type": "array",
-						"items": false,
-						"description": "The auditable item graph vertices to connect the document to.",
-						"prefixItems": [
-							{
-								"type": "object",
-								"properties": {
-									"targetId": {
-										"type": "string"
-									},
-									"addAlias": {
-										"type": "boolean"
-									},
-									"aliasAnnotationObject": {
-										"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
-									}
+						"items": {
+							"type": "object",
+							"properties": {
+								"targetId": {
+									"type": "string"
 								},
-								"required": [
-									"targetId"
-								],
-								"additionalProperties": false
-							}
-						]
+								"addAlias": {
+									"type": "boolean"
+								},
+								"aliasAnnotationObject": {
+									"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+								}
+							},
+							"required": [
+								"targetId"
+							],
+							"additionalProperties": false
+						},
+						"description": "The auditable item graph vertices to connect the document to."
 					},
 					"createAttestation": {
 						"type": "boolean",
@@ -1275,28 +1248,25 @@
 					},
 					"auditableItemGraphEdges": {
 						"type": "array",
-						"items": false,
-						"description": "The auditable item graph vertices to connect the document to.",
-						"prefixItems": [
-							{
-								"type": "object",
-								"properties": {
-									"targetId": {
-										"type": "string"
-									},
-									"addAlias": {
-										"type": "boolean"
-									},
-									"aliasAnnotationObject": {
-										"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
-									}
+						"items": {
+							"type": "object",
+							"properties": {
+								"targetId": {
+									"type": "string"
 								},
-								"required": [
-									"targetId"
-								],
-								"additionalProperties": false
-							}
-						]
+								"addAlias": {
+									"type": "boolean"
+								},
+								"aliasAnnotationObject": {
+									"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+								}
+							},
+							"required": [
+								"targetId"
+							],
+							"additionalProperties": false
+						},
+						"description": "The auditable item graph vertices to connect the document to."
 					}
 				},
 				"additionalProperties": false,

package/docs/reference/classes/DocumentManagementService.md

@@ -36,9 +36,27 @@ Runtime name for the class.
 
 ## Methods
 
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IDocumentManagementComponent.className`
+
+***
+
 ### create()
 
-> **create**(`documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject?`, `auditableItemGraphEdges?`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
+> **create**(`documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject?`, `auditableItemGraphEdges?`, `options?`): `Promise`\<`string`\>
 
 Store a document as an auditable item graph vertex and add its content to blob storage.
 If the document id already exists and the blob data is different a new revision will be created.
@@ -56,11 +74,11 @@ The document id to create.
 
 The format of the document identifier.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### documentCode
 
-`string`
+`UneceDocumentCodeList`
 
 The code for the document type.
 
@@ -104,18 +122,6 @@ Flag to add the document id as an alias to the aig vertex, defaults to true.
 
 Annotation object for the alias.
 
-##### userIdentity?
-
-`string`
-
-The identity to perform the auditable item graph operation with.
-
-##### nodeIdentity?
-
-`string`
-
-The node identity to use for vault operations.
-
 #### Returns
 
 `Promise`\<`string`\>
@@ -130,7 +136,7 @@ The auditable item graph vertex created for the document including its revision.
 
 ### update()
 
-> **update**(`auditableItemGraphDocumentId`, `blob?`, `annotationObject?`, `auditableItemGraphEdges?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
+> **update**(`auditableItemGraphDocumentId`, `blob?`, `annotationObject?`, `auditableItemGraphEdges?`): `Promise`\<`void`\>
 
 Update a document as an auditable item graph vertex and add its content to blob storage.
 If the blob data is different a new revision will be created.
@@ -162,18 +168,6 @@ Additional information to associate with the document.
 
 The auditable item graph vertices to connect the document to, if undefined retains current connections.
 
-##### userIdentity?
-
-`string`
-
-The identity to perform the auditable item graph operation with.
-
-##### nodeIdentity?
-
-`string`
-
-The node identity to use for vault operations.
-
 #### Returns
 
 `Promise`\<`void`\>
@@ -188,7 +182,7 @@ Nothing.
 
 ### get()
 
-> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `limit?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IDocumentList`\>
+> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IDocumentList`; `cursor?`: `string`; \}\>
 
 Get a document using it's auditable item graph vertex id and optional revision.
 
@@ -252,21 +246,9 @@ The cursor to get the next chunk of revisions.
 
 Limit the number of items to return, defaults to 1 so only most recent is returned.
 
-##### userIdentity?
-
-`string`
-
-The identity to perform the auditable item graph operation with.
-
-##### nodeIdentity?
-
-`string`
-
-The node identity to use for vault operations.
-
 #### Returns
 
-`Promise`\<`IDocumentList`\>
+`Promise`\<\{ `entries`: `IDocumentList`; `cursor?`: `string`; \}\>
 
 The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
 
@@ -278,7 +260,7 @@ The documents and revisions if requested, ordered by revision descending, cursor
 
 ### getRevision()
 
-> **getRevision**(`auditableItemGraphDocumentId`, `revision`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IDocument`\>
+> **getRevision**(`auditableItemGraphDocumentId`, `revision`, `options?`): `Promise`\<`IDocument`\>
 
 Get a document revision using it's auditable item graph vertex id.
 
@@ -330,18 +312,6 @@ If provided will extract data from the document using the specified rule group i
 
 By default extraction will auto detect the mime type of the document, this can be used to override the detection.
 
-##### userIdentity?
-
-`string`
-
-The identity to perform the auditable item graph operation with.
-
-##### nodeIdentity?
-
-`string`
-
-The node identity to use for vault operations.
-
 #### Returns
 
 `Promise`\<`IDocument`\>
@@ -356,7 +326,7 @@ The documents and revisions if requested, ordered by revision descending, cursor
 
 ### removeRevision()
 
-> **removeRevision**(`auditableItemGraphDocumentId`, `revision`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
+> **removeRevision**(`auditableItemGraphDocumentId`, `revision`): `Promise`\<`void`\>
 
 Remove an auditable item graph vertex using it's id.
 The document dateDeleted will be set, but can still be queried with the includeRemoved flag.
@@ -375,18 +345,6 @@ The auditable item graph vertex id which contains the document.
 
 The revision of the document to remove.
 
-##### userIdentity?
-
-`string`
-
-The identity to perform the auditable item graph operation with.
-
-##### nodeIdentity?
-
-`string`
-
-The node identity to use for vault operations.
-
 #### Returns
 
 `Promise`\<`void`\>
@@ -401,7 +359,7 @@ Nothing.
 
 ### query()
 
-> **query**(`documentId`, `cursor?`, `limit?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IAuditableItemGraphVertexList`\>
+> **query**(`documentId`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IAuditableItemGraphVertexList`; `cursor?`: `string`; \}\>
 
 Find all the document with a specific id.
 
@@ -425,21 +383,9 @@ The cursor to get the next chunk of documents.
 
 The limit to get the next chunk of documents.
 
-##### userIdentity?
-
-`string`
-
-The identity to perform the auditable item graph operation with.
-
-##### nodeIdentity?
-
-`string`
-
-The node identity to use for vault operations.
-
 #### Returns
 
-`Promise`\<`IAuditableItemGraphVertexList`\>
+`Promise`\<\{ `entries`: `IAuditableItemGraphVertexList`; `cursor?`: `string`; \}\>
 
 The graph vertices that contain documents referencing the specified document id.