@twin.org/document-management-service 0.0.3-next.15 → 0.0.3-next.17

package/docs/open-api/spec.json

@@ -317,16 +317,16 @@
 			}
 		},
 		"/document-management/{auditableItemGraphDocumentId}": {
-			"put": {
-				"operationId": "DocumentManagementUpdate",
-				"summary": "Update a document in an auditable item graph vertex and add its content to blob storage.",
+			"patch": {
+				"operationId": "DocumentManagementUpdatePartial",
+				"summary": "Partially update a document in an auditable item graph vertex and add its content to blob storage.",
 				"tags": [
 					"Document Management"
 				],
 				"parameters": [
 					{
 						"name": "auditableItemGraphDocumentId",
-						"description": "The full id of the document to get.",
+						"description": "The full id of the document to update.",
 						"in": "path",
 						"required": true,
 						"schema": {
@@ -342,15 +342,15 @@
 					}
 				],
 				"requestBody": {
-					"description": "Request to update a document as an auditable item graph vertex.",
+					"description": "Request to partially update a document as an auditable item graph vertex.",
 					"required": true,
 					"content": {
 						"application/json": {
 							"schema": {
-								"$ref": "#/components/schemas/DocumentManagementUpdateRequest"
+								"$ref": "#/components/schemas/DocumentManagementUpdatePartialRequest"
 							},
 							"examples": {
-								"DocumentManagementUpdateRequestExample": {
+								"DocumentManagementUpdatePartialRequestExample": {
 									"value": {
 										"blob": "SGVsbG8gV29ybGQ=",
 										"annotationObject": {
@@ -481,6 +481,15 @@
 							"type": "string"
 						}
 					},
+					{
+						"name": "includeDeletedEdges",
+						"description": "Include soft-deleted edges in the response.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
 					{
 						"name": "extractRuleGroupId",
 						"description": "If provided will extract data from the document using the specified rule group id.",
@@ -501,7 +510,7 @@
 					},
 					{
 						"name": "limit",
-						"description": "PLimit the number of items to return, defaults to 1 so only most recent is returned.",
+						"description": "Limit the number of items to return, defaults to 1 so only most recent is returned.",
 						"in": "query",
 						"required": false,
 						"schema": {
@@ -1187,21 +1196,7 @@
 					"auditableItemGraphEdges": {
 						"type": "array",
 						"items": {
-							"type": "object",
-							"properties": {
-								"targetId": {
-									"type": "string"
-								},
-								"addAlias": {
-									"type": "boolean"
-								},
-								"aliasAnnotationObject": {
-									"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
-								}
-							},
-							"required": [
-								"targetId"
-							]
+							"$ref": "#/components/schemas/DocumentManagementEdgeEntry"
 						},
 						"description": "The auditable item graph vertices to connect the document to."
 					},
@@ -1225,36 +1220,55 @@
 				],
 				"description": "The body parameters."
 			},
-			"DocumentManagementUpdateRequest": {
+			"DocumentManagementEdgeEntry": {
+				"description": "A single edge entry used when connecting a document to an AIG vertex.",
+				"type": "object",
+				"properties": {
+					"targetId": {
+						"type": "string",
+						"description": "The target AIG vertex id to connect to."
+					},
+					"addAlias": {
+						"type": "boolean",
+						"description": "Whether to add the document id as an alias on the connected vertex, defaults to false."
+					},
+					"aliasAnnotationObject": {
+						"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+					}
+				},
+				"required": [
+					"targetId"
+				]
+			},
+			"DocumentManagementUpdatePartialRequest": {
 				"type": "object",
 				"properties": {
 					"blob": {
 						"type": "string",
-						"description": "The data to create the document with, in base64."
+						"description": "The data to update the document with, in base64."
 					},
 					"annotationObject": {
 						"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
 					},
 					"auditableItemGraphEdges": {
-						"type": "array",
-						"items": {
-							"type": "object",
-							"properties": {
-								"targetId": {
-									"type": "string"
-								},
-								"addAlias": {
-									"type": "boolean"
+						"type": "object",
+						"properties": {
+							"add": {
+								"type": "array",
+								"items": {
+									"$ref": "#/components/schemas/DocumentManagementEdgeEntry"
 								},
-								"aliasAnnotationObject": {
-									"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
-								}
+								"description": "Connections to add; each entry creates a back-edge on the connected vertex."
 							},
-							"required": [
-								"targetId"
-							]
+							"remove": {
+								"type": "array",
+								"items": {
+									"type": "string"
+								},
+								"description": "Target vertex IDs to disconnect; their back-edges are removed."
+							}
 						},
-						"description": "The auditable item graph vertices to connect the document to."
+						"description": "Explicit edge delta to apply. Use `add` to create new connections and `remove` to\ndisconnect existing ones by their target vertex id."
 					}
 				},
 				"description": "The body parameters."

package/docs/reference/classes/DocumentManagementService.md

@@ -64,6 +64,8 @@ Register all document management metrics with the telemetry component.
 
 `Promise`\<`void`\>
 
+A promise that resolves when metrics have been registered.
+
 #### Implementation of
 
 `IDocumentManagementComponent.start`
@@ -112,7 +114,7 @@ Additional information to associate with the document.
 
 ##### auditableItemGraphEdges?
 
-`object`[]
+`IDocumentManagementEdgeEntry`[]
 
 The auditable item graph vertices to connect the document to.
 
@@ -150,9 +152,9 @@ The auditable item graph vertex created for the document including its revision.
 
 ***
 
-### update() {#update}
+### updatePartial() {#updatepartial}
 
-> **update**(`auditableItemGraphDocumentId`, `blob?`, `annotationObject?`, `auditableItemGraphEdges?`): `Promise`\<`void`\>
+> **updatePartial**(`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.
@@ -180,19 +182,33 @@ Additional information to associate with the document.
 
 ##### auditableItemGraphEdges?
 
-`object`[]
+Explicit edge delta to apply. If undefined, existing connections
+are retained unchanged. Use `add` to create new connections and `remove` to disconnect existing
+ones by their target vertex id. To update alias metadata on an already-connected vertex, include
+it in `add` with the updated `aliasAnnotationObject` — AIG's alias patch is an upsert, so the
+alias is updated in place without creating a duplicate back-edge.
+
+###### add?
+
+`IDocumentManagementEdgeEntry`[]
+
+Connections to add; each creates a back-edge on the connected vertex.
+
+###### remove?
+
+`string`[]
 
-The auditable item graph vertices to connect the document to, if undefined retains current connections.
+Target vertex IDs to disconnect; their back-edges are removed.
 
 #### Returns
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the document has been updated.
 
 #### Implementation of
 
-`IDocumentManagementComponent.update`
+`IDocumentManagementComponent.updatePartial`
 
 ***
 
@@ -238,6 +254,12 @@ Flag to include the attestation information for the document, defaults to false.
 
 Flag to include deleted documents, defaults to false.
 
+###### includeDeletedEdges?
+
+`boolean`
+
+Flag to include soft-deleted edges in the response, defaults to false.
+
 ###### extractRuleGroupId?
 
 `string`
@@ -332,7 +354,7 @@ By default extraction will auto detect the mime type of the document, this can b
 
 `Promise`\<`IDocument`\>
 
-The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+The document for the specified revision.
 
 #### Implementation of
 
@@ -365,7 +387,7 @@ The revision of the document to remove.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the revision has been removed.
 
 #### Implementation of
 

package/docs/reference/functions/{documentManagementUpdate.md → documentManagementUpdatePartial.md}

@@ -1,6 +1,6 @@
-# Function: documentManagementUpdate()
+# Function: documentManagementUpdatePartial()
 
-> **documentManagementUpdate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+> **documentManagementUpdatePartial**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
 
 Update the document from the auditable item graph vertex.
 
@@ -20,7 +20,7 @@ The name of the component to use in the routes.
 
 ### request
 
-`IDocumentManagementUpdateRequest`
+`IDocumentManagementUpdatePartialRequest`
 
 The request.
 

package/docs/reference/index.md

@@ -20,6 +20,6 @@
 - [documentManagementCreate](functions/documentManagementCreate.md)
 - [documentManagementGet](functions/documentManagementGet.md)
 - [documentManagementGetRevision](functions/documentManagementGetRevision.md)
-- [documentManagementUpdate](functions/documentManagementUpdate.md)
+- [documentManagementUpdatePartial](functions/documentManagementUpdatePartial.md)
 - [documentManagementRemove](functions/documentManagementRemove.md)
 - [documentManagementQuery](functions/documentManagementQuery.md)

package/docs/reference/variables/restEntryPoints.md

@@ -1,3 +1,5 @@
 # Variable: restEntryPoints
 
 > `const` **restEntryPoints**: `IRestRouteEntryPoint`[]
+
+REST entry points for the document management service.

package/locales/en.json

@@ -2,12 +2,14 @@
 	"error": {
 		"documentManagementService": {
 			"createFailed": "Failed to create document",
+			"connectedVertexNotFound": "The connected vertex \"{notFoundId}\" does not exist",
 			"updateFailed": "Failed to update document",
 			"getFailed": "Failed to get document",
 			"getRevisionFailed": "Failed to get 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",
+			"documentRevisionMissingId": "Revision {revision} was found but has no resolvable resource id — possible data integrity issue",
 			"removeRevisionFailed": "Failed to remove document revision"
 		}
 	}

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/document-management-service",
-	"version": "0.0.3-next.15",
+	"version": "0.0.3-next.17",
 	"description": "Service-side document lifecycle operations and REST route generation for server integrations.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/iotaledger/document-management.git",
+		"url": "git+https://github.com/iotaledger/twin-document-management.git",
 		"directory": "packages/document-management-service"
 	},
 	"author": "martyn.janes@iota.org",
@@ -23,7 +23,7 @@
 		"@twin.org/crypto": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/data-processing-models": "next",
-		"@twin.org/document-management-models": "0.0.3-next.15",
+		"@twin.org/document-management-models": "0.0.3-next.17",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/nameof": "next",
@@ -64,7 +64,7 @@
 		"business-logic"
 	],
 	"bugs": {
-		"url": "git+https://github.com/iotaledger/document-management/issues"
+		"url": "git+https://github.com/iotaledger/twin-document-management/issues"
 	},
 	"homepage": "https://twindev.org"
 }