@twin.org/document-management-service 0.0.2-next.3 → 0.0.3-next.1

package/docs/open-api/spec.json

@@ -83,7 +83,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -104,7 +104,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "UnauthorizedError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -122,7 +122,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -158,15 +158,12 @@
 						}
 					},
 					{
-						"name": "pageSize",
+						"name": "limit",
 						"description": "The number of documents to return.",
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"number",
-								"string"
-							]
+							"type": "string"
 						}
 					},
 					{
@@ -246,7 +243,7 @@
 																"blobHash": "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"
 															}
 														}
@@ -270,7 +267,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -291,7 +288,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "UnauthorizedError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -309,7 +306,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -382,7 +379,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -403,7 +400,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "UnauthorizedError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -421,7 +418,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -515,15 +512,12 @@
 						}
 					},
 					{
-						"name": "pageSize",
-						"description": "Page size of items to return, defaults to 1 so only most recent is returned.",
+						"name": "limit",
+						"description": "PLimit the number of items to return, defaults to 1 so only most recent is returned.",
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"number",
-								"string"
-							]
+							"type": "string"
 						}
 					},
 					{
@@ -588,7 +582,7 @@
 														"@type": "DigitalDocument",
 														"name": "myfile.pdf"
 													},
-													"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+													"organizationIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
 													"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
 												}
 											]
@@ -630,7 +624,7 @@
 														"@type": "DigitalDocument",
 														"name": "myfile.pdf"
 													},
-													"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+													"organizationIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
 													"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
 												}
 											]
@@ -651,7 +645,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -672,7 +666,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "UnauthorizedError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -690,7 +684,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "NotFoundError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"notFoundId": "1"
 											}
@@ -711,7 +705,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -787,7 +781,7 @@
 												"@type": "DigitalDocument",
 												"name": "myfile.pdf"
 											},
-											"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+											"organizationIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
 											"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
 										}
 									}
@@ -819,7 +813,7 @@
 												"@type": "DigitalDocument",
 												"name": "myfile.pdf"
 											},
-											"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+											"organizationIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
 											"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
 										}
 									}
@@ -838,7 +832,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -859,7 +853,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "UnauthorizedError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -877,7 +871,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "NotFoundError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"notFoundId": "1"
 											}
@@ -898,7 +892,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -957,7 +951,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -978,7 +972,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "UnauthorizedError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -996,7 +990,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "NotFoundError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"notFoundId": "1"
 											}
@@ -1017,7 +1011,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -1036,9 +1030,6 @@
 					"@context": {
 						"type": "array",
 						"minItems": 3,
-						"items": {
-							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-						},
 						"description": "JSON-LD Context.",
 						"prefixItems": [
 							{
@@ -1053,7 +1044,10 @@
 								"type": "string",
 								"const": "https://schema.org"
 							}
-						]
+						],
+						"items": {
+							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+						}
 					},
 					"type": {
 						"type": "string",
@@ -1115,9 +1109,9 @@
 						"type": "string",
 						"description": "The date/time of when the document was deleted, as we never actually remove items."
 					},
-					"nodeIdentity": {
+					"organizationIdentity": {
 						"type": "string",
-						"description": "The node which added the document to the graph."
+						"description": "The organization which added the document to the graph."
 					},
 					"userIdentity": {
 						"type": "string",
@@ -1133,9 +1127,7 @@
 					"documentRevision",
 					"blobStorageId",
 					"blobHash",
-					"dateCreated",
-					"nodeIdentity",
-					"userIdentity"
+					"dateCreated"
 				],
 				"additionalProperties": false,
 				"description": "Interface describing a document."
@@ -1146,9 +1138,6 @@
 					"@context": {
 						"type": "array",
 						"minItems": 3,
-						"items": {
-							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-						},
 						"description": "JSON-LD Context.",
 						"prefixItems": [
 							{
@@ -1163,7 +1152,10 @@
 								"type": "string",
 								"const": "https://schema.twindev.org/common/"
 							}
-						]
+						],
+						"items": {
+							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+						}
 					},
 					"type": {
 						"type": "string",
@@ -1172,23 +1164,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."
 					},
 					"edges": {
 						"type": "array",
-						"items": false,
-						"description": "The ids of the other vertices which are connected to the document.",
-						"prefixItems": [
-							{
-								"type": "string"
-							}
-						]
+						"items": {
+							"type": "string"
+						},
+						"description": "The ids of the other vertices which are connected to the document."
 					},
 					"nextItem": {
 						"type": "string",
@@ -1226,28 +1212,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",
@@ -1281,28 +1264,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

@@ -30,19 +30,33 @@ The options for the service.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 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.CLASS_NAME`
+`IDocumentManagementComponent.className`
 
-## Methods
+***
 
 ### 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.
@@ -60,7 +74,7 @@ The document id to create.
 
 The format of the document identifier.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### documentCode
 
@@ -108,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`\>
@@ -134,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.
@@ -166,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`\>
@@ -192,7 +182,7 @@ Nothing.
 
 ### get()
 
-> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `pageSize?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IDocumentList`\>
+> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `limit?`): `Promise`\<`IDocumentList`\>
 
 Get a document using it's auditable item graph vertex id and optional revision.
 
@@ -250,23 +240,11 @@ By default extraction will auto detect the mime type of the document, this can b
 
 The cursor to get the next chunk of revisions.
 
-##### pageSize?
+##### limit?
 
 `number`
 
-Page size 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.
+Limit the number of items to return, defaults to 1 so only most recent is returned.
 
 #### Returns
 
@@ -282,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.
 
@@ -334,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`\>
@@ -360,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.
@@ -379,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`\>
@@ -405,7 +359,7 @@ Nothing.
 
 ### query()
 
-> **query**(`documentId`, `cursor?`, `pageSize?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IAuditableItemGraphVertexList`\>
+> **query**(`documentId`, `cursor?`, `limit?`): `Promise`\<`IAuditableItemGraphVertexList`\>
 
 Find all the document with a specific id.
 
@@ -423,23 +377,11 @@ The document id to find in the graph.
 
 The cursor to get the next chunk of documents.
 
-##### pageSize?
+##### limit?
 
 `number`
 
-The page size 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.
+The limit to get the next chunk of documents.
 
 #### Returns
 

package/locales/en.json

@@ -5,11 +5,10 @@
 			"updateFailed": "Failed to update document",
 			"getFailed": "Failed to get document",
 			"getRevisionFailed": "Failed to get document revision",
-			"removeRevision": "Failed to remove document revision",
 			"queryFailed": "Failed to query document",
 			"documentRevisionNone": "There are no revisions in the document",
 			"documentRevisionNotFound": "There is no revision number \"{notFoundId}\" in the document",
-			"namespaceMismatch": "The namespace in the urn \"{id}\" does not match the namespace of the Document Management component \"{namespace}\""
+			"removeRevisionFailed": "Failed to remove document revision"
 		}
 	}
 }