@twin.org/document-management-service 0.0.1-next.8 → 0.0.1-next.9

package/docs/reference/classes/DocumentManagementService.md

@@ -8,9 +8,9 @@ Service for performing document management operations.
 
 ## Constructors
 
-### new DocumentManagementService()
+### Constructor
 
-> **new DocumentManagementService**(`options`?): [`DocumentManagementService`](DocumentManagementService.md)
+> **new DocumentManagementService**(`options?`): `DocumentManagementService`
 
 Create a new instance of DocumentManagementService.
 
@@ -24,7 +24,7 @@ The options for the service.
 
 #### Returns
 
-[`DocumentManagementService`](DocumentManagementService.md)
+`DocumentManagementService`
 
 ## Properties
 
@@ -48,22 +48,16 @@ Runtime name for the class.
 
 ## Methods
 
-### set()
+### create()
 
-> **set**(`auditableItemGraphId`, `documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject`?, `options`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **create**(`documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject?`, `auditableItemGraphEdges?`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
 
-Store a document in an auditable item graph vertex and add its content to blob storage.
+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.
 For any other changes the current revision will be updated.
 
 #### Parameters
 
-##### auditableItemGraphId
-
-`string`
-
-The auditable item graph vertex id to create the document on.
-
 ##### documentId
 
 `string`
@@ -86,7 +80,7 @@ The code for the document type.
 
 `Uint8Array`
 
-The data to create the document.
+The data to create the document with.
 
 ##### annotationObject?
 
@@ -94,6 +88,12 @@ The data to create the document.
 
 Additional information to associate with the document.
 
+##### auditableItemGraphEdges?
+
+`object`[]
+
+The auditable item graph vertices to connect the document to.
+
 ##### options?
 
 Additional options for the set operation.
@@ -104,17 +104,17 @@ Additional options for the set operation.
 
 Flag to create an attestation for the document, defaults to false.
 
-###### includeIdAsAlias?
+###### addAlias?
 
 `boolean`
 
-Include the document id as an alias to the aig vertex, defaults to false.
+Flag to add the document id as an alias to the aig vertex, defaults to true.
 
 ###### aliasAnnotationObject?
 
 `IJsonLdNodeObject`
 
-Additional information to associate with the alias.
+Annotation object for the alias.
 
 ##### userIdentity?
 
@@ -132,33 +132,85 @@ The node identity to use for vault operations.
 
 `Promise`\<`string`\>
 
-The identifier for the document which includes the auditable item graph identifier.
+The auditable item graph vertex created for the document including its revision.
 
 #### Implementation of
 
-`IDocumentManagementComponent.set`
+`IDocumentManagementComponent.create`
 
 ***
 
-### get()
+### update()
 
-> **get**(`auditableItemGraphId`, `identifier`, `options`?, `revisionCursor`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`IDocument`\>
+> **update**(`auditableItemGraphDocumentId`, `blob?`, `annotationObject?`, `auditableItemGraphEdges?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
 
-Get a specific document from an auditable item graph vertex.
+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.
+For any other changes the current revision will be updated.
 
 #### Parameters
 
-##### auditableItemGraphId
+##### auditableItemGraphDocumentId
 
 `string`
 
-The auditable item graph vertex id to get the document from.
+The auditable item graph vertex id which contains the document.
 
-##### identifier
+##### blob?
+
+`Uint8Array`\<`ArrayBufferLike`\>
+
+The data to update the document with.
+
+##### annotationObject?
+
+`IJsonLdNodeObject`
+
+Additional information to associate with the document.
+
+##### auditableItemGraphEdges?
+
+`object`[]
+
+The auditable item graph vertices to connect the document to, if undefined retains current connections.
+
+##### userIdentity?
 
 `string`
 
-The identifier of the document to get.
+The identity to perform the auditable item graph operation with.
+
+##### nodeIdentity?
+
+`string`
+
+The node identity to use for vault operations.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IDocumentManagementComponent.update`
+
+***
+
+### get()
+
+> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `pageSize?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IDocumentList`\>
+
+Get a document using it's auditable item graph vertex id and optional revision.
+
+#### Parameters
+
+##### auditableItemGraphDocumentId
+
+`string`
+
+The auditable item graph vertex id which contains the document.
 
 ##### options?
 
@@ -188,17 +240,17 @@ Flag to include the attestation information for the document, defaults to false.
 
 Flag to include deleted documents, defaults to false.
 
-###### maxRevisionCount?
+##### cursor?
 
-`number`
+`string`
 
-Max number of revisions to return, defaults to 0.
+The cursor to get the next chunk of revisions.
 
-##### revisionCursor?
+##### pageSize?
 
-`string`
+`number`
 
-The cursor to get the next chunk of revisions.
+Page size of items to return, defaults to 1 so only most recent is returned.
 
 ##### userIdentity?
 
@@ -214,7 +266,7 @@ The node identity to use for vault operations.
 
 #### Returns
 
-`Promise`\<`IDocument`\>
+`Promise`\<`IDocumentList`\>
 
 The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
 
@@ -224,36 +276,26 @@ The documents and revisions if requested, ordered by revision descending, cursor
 
 ***
 
-### remove()
+### removeRevision()
 
-> **remove**(`auditableItemGraphId`, `identifier`, `options`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+> **removeRevision**(`auditableItemGraphDocumentId`, `revision`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
 
-Remove a specific document from an auditable item graph vertex.
-The documents dateDeleted will be set, but can still be queried with the includeRemoved flag.
+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.
 
 #### Parameters
 
-##### auditableItemGraphId
+##### auditableItemGraphDocumentId
 
 `string`
 
-The auditable item graph vertex id to remove the document from.
-
-##### identifier
+The auditable item graph vertex id which contains the document.
 
-`string`
-
-The identifier of the document to remove.
+##### revision
 
-##### options?
-
-Additional options for the remove operation.
-
-###### removeAllRevisions?
-
-`boolean`
+`number`
 
-Flag to remove all revisions of the document, defaults to false.
+The revision of the document to remove.
 
 ##### userIdentity?
 
@@ -275,45 +317,23 @@ Nothing.
 
 #### Implementation of
 
-`IDocumentManagementComponent.remove`
+`IDocumentManagementComponent.removeRevision`
 
 ***
 
 ### query()
 
-> **query**(`auditableItemGraphId`, `documentCodes`?, `options`?, `cursor`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`IDocumentList`\>
+> **query**(`documentId`, `cursor?`, `pageSize?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IAuditableItemGraphVertexList`\>
 
-Query an auditable item graph vertex for documents.
+Find all the document with a specific id.
 
 #### Parameters
 
-##### auditableItemGraphId
+##### documentId
 
 `string`
 
-The auditable item graph vertex to get the documents from.
-
-##### documentCodes?
-
-`string`[]
-
-The document codes to query for, if undefined gets all document codes.
-
-##### options?
-
-Additional options for the query operation.
-
-###### includeMostRecentRevisions?
-
-`boolean`
-
-Include the most recent 5 revisions, use the individual get to retrieve more.
-
-###### includeRemoved?
-
-`boolean`
-
-Flag to include deleted documents, defaults to false.
+The document id to find in the graph.
 
 ##### cursor?
 
@@ -321,6 +341,12 @@ Flag to include deleted documents, defaults to false.
 
 The cursor to get the next chunk of documents.
 
+##### pageSize?
+
+`number`
+
+The page size to get the next chunk of documents.
+
 ##### userIdentity?
 
 `string`
@@ -335,9 +361,9 @@ The node identity to use for vault operations.
 
 #### Returns
 
-`Promise`\<`IDocumentList`\>
+`Promise`\<`IAuditableItemGraphVertexList`\>
 
-The most recent revisions of each document, cursor is set if there are more documents.
+The graph vertices that contain documents referencing the specified document id.
 
 #### Implementation of
 

package/docs/reference/functions/{documentManagementSet.md → documentManagementCreate.md}

@@ -1,8 +1,8 @@
-# Function: documentManagementSet()
+# Function: documentManagementCreate()
 
-> **documentManagementSet**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`ICreatedResponse`\>
+> **documentManagementCreate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`ICreatedResponse`\>
 
-Set a document in to an auditable item graph vertex.
+Create a document as an auditable item graph vertex.
 
 ## Parameters
 
@@ -20,7 +20,7 @@ The name of the component to use in the routes.
 
 ### request
 
-`IDocumentManagementSetRequest`
+`IDocumentManagementCreateRequest`
 
 The request.
 

package/docs/reference/functions/documentManagementUpdate.md

@@ -0,0 +1,31 @@
+# Function: documentManagementUpdate()
+
+> **documentManagementUpdate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+UPdate the document from the auditable item graph vertex.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IDocumentManagementUpdateRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/index.md

@@ -17,7 +17,8 @@
 ## Functions
 
 - [generateRestRoutesDocumentManagement](functions/generateRestRoutesDocumentManagement.md)
-- [documentManagementSet](functions/documentManagementSet.md)
+- [documentManagementCreate](functions/documentManagementCreate.md)
 - [documentManagementGet](functions/documentManagementGet.md)
+- [documentManagementUpdate](functions/documentManagementUpdate.md)
 - [documentManagementRemove](functions/documentManagementRemove.md)
 - [documentManagementQuery](functions/documentManagementQuery.md)

package/locales/en.json

@@ -1,13 +1,13 @@
 {
 	"error": {
 		"documentManagementService": {
-			"setFailed": "Failed to set document",
+			"createFailed": "Failed to create document",
+			"updateFailed": "Failed to update document",
 			"getFailed": "Failed to get document",
-			"removeFailed": "Failed to remove document",
+			"removeRevision": "Failed to remove document revision",
 			"queryFailed": "Failed to query document",
-			"invalidDocumentId": "The document id not in the correct format, it is \"{identifier}\"",
-			"invalidDocumentCode": "The document code does not follow the format unece:DocumentCodeList#1, it is \"{documentCode}\"",
-			"documentRevisionNotFound": "The document revision was not found \"{identifier}\"",
+			"documentRevisionNone": "There are no revisions in the document",
+			"documentRevisionNotFound": "There is no revision number \"{revision}\" in the document",
 			"namespaceMismatch": "The namespace in the urn \"{id}\" does not match the namespace of the Document Management component \"{namespace}\""
 		}
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/document-management-service",
-	"version": "0.0.1-next.8",
+	"version": "0.0.1-next.9",
 	"description": "Document management contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -21,7 +21,7 @@
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/data-json-ld": "next",
-		"@twin.org/document-management-models": "0.0.1-next.8",
+		"@twin.org/document-management-models": "0.0.1-next.9",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/nameof": "next",