@twin.org/document-management-service 0.0.3-next.14 → 0.0.3-next.16

package/docs/reference/classes/DocumentManagementService.md

@@ -54,6 +54,22 @@ The class name of the component.
 
 ***
 
+### start() {#start}
+
+> **start**(): `Promise`\<`void`\>
+
+Register all document management metrics with the telemetry component.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+`IDocumentManagementComponent.start`
+
+***
+
 ### create() {#create}
 
 > **create**(`documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject?`, `auditableItemGraphEdges?`, `options?`): `Promise`\<`string`\>
@@ -96,7 +112,7 @@ Additional information to associate with the document.
 
 ##### auditableItemGraphEdges?
 
-`object`[]
+`IDocumentManagementEdgeEntry`[]
 
 The auditable item graph vertices to connect the document to.
 
@@ -134,9 +150,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.
@@ -164,9 +180,23 @@ 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?
 
-The auditable item graph vertices to connect the document to, if undefined retains current connections.
+`string`[]
+
+Target vertex IDs to disconnect; their back-edges are removed.
 
 #### Returns
 
@@ -176,7 +206,7 @@ Nothing.
 
 #### Implementation of
 
-`IDocumentManagementComponent.update`
+`IDocumentManagementComponent.updatePartial`
 
 ***
 
@@ -222,6 +252,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`

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/interfaces/IDocumentManagementServiceConstructorOptions.md

@@ -60,6 +60,14 @@ data-processing
 
 ***
 
+### telemetryComponentType? {#telemetrycomponenttype}
+
+> `optional` **telemetryComponentType?**: `string`
+
+The type of the telemetry component used for event metrics.
+
+***
+
 ### config? {#config}
 
 > `optional` **config?**: [`IDocumentManagementServiceConfig`](IDocumentManagementServiceConfig.md)

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.14",
+	"version": "0.0.3-next.16",
 	"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,12 +23,13 @@
 		"@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.14",
+		"@twin.org/document-management-models": "0.0.3-next.16",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-schema-org": "next",
 		"@twin.org/standards-unece": "next",
+		"@twin.org/telemetry-models": "next",
 		"@twin.org/web": "next"
 	},
 	"main": "./dist/es/index.js",
@@ -63,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"
 }