@twin.org/document-management-service 0.0.1-next.2

package/docs/reference/classes/DocumentManagementService.md

@@ -0,0 +1,328 @@
+# Class: DocumentManagementService
+
+Service for performing document management operations.
+
+## Implements
+
+- `IDocumentManagementComponent`
+
+## Constructors
+
+### new DocumentManagementService()
+
+> **new DocumentManagementService**(`options`?): [`DocumentManagementService`](DocumentManagementService.md)
+
+Create a new instance of DocumentManagementService.
+
+#### Parameters
+
+##### options?
+
+[`IDocumentManagementServiceConstructorOptions`](../interfaces/IDocumentManagementServiceConstructorOptions.md)
+
+The options for the service.
+
+#### Returns
+
+[`DocumentManagementService`](DocumentManagementService.md)
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"documents"`
+
+The namespace supported by the document management service.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IDocumentManagementComponent.CLASS_NAME`
+
+## Methods
+
+### set()
+
+> **set**(`auditableItemGraphId`, `documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject`?, `createAttestation`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+
+Store a document in 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`
+
+The document id to create.
+
+##### documentIdFormat
+
+The format of the document identifier.
+
+`undefined` | `string`
+
+##### documentCode
+
+`string`
+
+The code for the document type.
+
+##### blob
+
+`Uint8Array`
+
+The data to create the document.
+
+##### annotationObject?
+
+`IJsonLdNodeObject`
+
+Additional information to associate with the document.
+
+##### createAttestation?
+
+`boolean`
+
+Flag to create an attestation for the document, defaults to false.
+
+##### 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`\>
+
+The identifier for the document which includes the auditable item graph identifier.
+
+#### Implementation of
+
+`IDocumentManagementComponent.set`
+
+***
+
+### get()
+
+> **get**(`auditableItemGraphId`, `identifier`, `options`?, `revisionCursor`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`IDocument`\>
+
+Get a specific document from an auditable item graph vertex.
+
+#### Parameters
+
+##### auditableItemGraphId
+
+`string`
+
+The auditable item graph vertex id to get the document from.
+
+##### identifier
+
+`string`
+
+The identifier of the document to get.
+
+##### options?
+
+Additional options for the get operation.
+
+###### includeBlobStorageMetadata?
+
+`boolean`
+
+Flag to include the blob storage metadata for the document, defaults to false.
+
+###### includeBlobStorageData?
+
+`boolean`
+
+Flag to include the blob storage data for the document, defaults to false.
+
+###### includeAttestation?
+
+`boolean`
+
+Flag to include the attestation information for the document, defaults to false.
+
+###### includeRemoved?
+
+`boolean`
+
+Flag to include deleted documents, defaults to false.
+
+###### maxRevisionCount?
+
+`number`
+
+Max number of revisions to return, defaults to 0.
+
+##### revisionCursor?
+
+`string`
+
+The cursor to get the next chunk of revisions.
+
+##### 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`\>
+
+The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+
+#### Implementation of
+
+`IDocumentManagementComponent.get`
+
+***
+
+### remove()
+
+> **remove**(`auditableItemGraphId`, `identifier`, `options`?, `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.
+
+#### Parameters
+
+##### auditableItemGraphId
+
+`string`
+
+The auditable item graph vertex id to remove the document from.
+
+##### identifier
+
+`string`
+
+The identifier of the document to remove.
+
+##### options?
+
+Additional options for the remove operation.
+
+###### removeAllRevisions?
+
+`boolean`
+
+Flag to remove all revisions of the document, defaults to false.
+
+##### 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`\>
+
+Nothing.
+
+#### Implementation of
+
+`IDocumentManagementComponent.remove`
+
+***
+
+### query()
+
+> **query**(`auditableItemGraphId`, `documentCodes`?, `options`?, `cursor`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`IDocumentList`\>
+
+Query an auditable item graph vertex for documents.
+
+#### Parameters
+
+##### auditableItemGraphId
+
+`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.
+
+##### cursor?
+
+`string`
+
+The cursor 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`\<`IDocumentList`\>
+
+The most recent revisions of each document, cursor is set if there are more documents.
+
+#### Implementation of
+
+`IDocumentManagementComponent.query`

package/docs/reference/functions/documentManagementGet.md

@@ -0,0 +1,31 @@
+# Function: documentManagementGet()
+
+> **documentManagementGet**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IDocumentManagementGetResponse`\>
+
+Get 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
+
+`IDocumentManagementGetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IDocumentManagementGetResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/documentManagementQuery.md

@@ -0,0 +1,31 @@
+# Function: documentManagementQuery()
+
+> **documentManagementQuery**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IDocumentManagementQueryResponse`\>
+
+Query the documents from an 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
+
+`IDocumentManagementQueryRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IDocumentManagementQueryResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/documentManagementRemove.md

@@ -0,0 +1,31 @@
+# Function: documentManagementRemove()
+
+> **documentManagementRemove**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Remove 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
+
+`IDocumentManagementRemoveRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/documentManagementSet.md

@@ -0,0 +1,31 @@
+# Function: documentManagementSet()
+
+> **documentManagementSet**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`ICreatedResponse`\>
+
+Set a document in to an 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
+
+`IDocumentManagementSetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`ICreatedResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/generateRestRoutesDocumentManagement.md

@@ -0,0 +1,25 @@
+# Function: generateRestRoutesDocumentManagement()
+
+> **generateRestRoutesDocumentManagement**(`baseRouteName`, `componentName`): `IRestRoute`\<`any`, `any`\>[]
+
+The REST routes for document management.
+
+## Parameters
+
+### baseRouteName
+
+`string`
+
+Prefix to prepend to the paths.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+## Returns
+
+`IRestRoute`\<`any`, `any`\>[]
+
+The generated routes.

package/docs/reference/index.md

@@ -0,0 +1,23 @@
+# @twin.org/document-management-service
+
+## Classes
+
+- [DocumentManagementService](classes/DocumentManagementService.md)
+
+## Interfaces
+
+- [IDocumentManagementServiceConfig](interfaces/IDocumentManagementServiceConfig.md)
+- [IDocumentManagementServiceConstructorOptions](interfaces/IDocumentManagementServiceConstructorOptions.md)
+
+## Variables
+
+- [tagsDocumentManagement](variables/tagsDocumentManagement.md)
+- [restEntryPoints](variables/restEntryPoints.md)
+
+## Functions
+
+- [generateRestRoutesDocumentManagement](functions/generateRestRoutesDocumentManagement.md)
+- [documentManagementSet](functions/documentManagementSet.md)
+- [documentManagementGet](functions/documentManagementGet.md)
+- [documentManagementRemove](functions/documentManagementRemove.md)
+- [documentManagementQuery](functions/documentManagementQuery.md)

package/docs/reference/interfaces/IDocumentManagementServiceConfig.md

@@ -0,0 +1,3 @@
+# Interface: IDocumentManagementServiceConfig
+
+Configuration for the document management service.

package/docs/reference/interfaces/IDocumentManagementServiceConstructorOptions.md

@@ -0,0 +1,53 @@
+# Interface: IDocumentManagementServiceConstructorOptions
+
+Options for the document management Service constructor.
+
+## Properties
+
+### auditableItemGraphComponentType?
+
+> `optional` **auditableItemGraphComponentType**: `string`
+
+The type of the auditable item graph component.
+
+#### Default
+
+```ts
+auditable-item-graph
+```
+
+***
+
+### blobStorageComponentType?
+
+> `optional` **blobStorageComponentType**: `string`
+
+The type of the blob storage component.
+
+#### Default
+
+```ts
+blob-storage
+```
+
+***
+
+### attestationComponentType?
+
+> `optional` **attestationComponentType**: `string`
+
+The type of the attestation component.
+
+#### Default
+
+```ts
+attestation
+```
+
+***
+
+### config?
+
+> `optional` **config**: [`IDocumentManagementServiceConfig`](IDocumentManagementServiceConfig.md)
+
+The configuration for the service.

package/docs/reference/variables/restEntryPoints.md

@@ -0,0 +1,3 @@
+# Variable: restEntryPoints
+
+> `const` **restEntryPoints**: `IRestRouteEntryPoint`[]

package/docs/reference/variables/tagsDocumentManagement.md

@@ -0,0 +1,5 @@
+# Variable: tagsDocumentManagement
+
+> `const` **tagsDocumentManagement**: `ITag`[]
+
+The tag to associate with the routes.

package/locales/en.json

@@ -0,0 +1,14 @@
+{
+	"error": {
+		"documentManagementService": {
+			"setFailed": "Failed to set document",
+			"getFailed": "Failed to get document",
+			"removeFailed": "Failed to remove document",
+			"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}\"",
+			"namespaceMismatch": "The namespace in the urn \"{id}\" does not match the namespace of the Document Management component \"{namespace}\""
+		}
+	}
+}

package/package.json

@@ -0,0 +1,50 @@
+{
+	"name": "@twin.org/document-management-service",
+	"version": "0.0.1-next.2",
+	"description": "Document management contract implementation and REST endpoint definitions",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/document-management.git",
+		"directory": "packages/document-management-service"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/api-models": "next",
+		"@twin.org/attestation-models": "next",
+		"@twin.org/auditable-item-graph-models": "next",
+		"@twin.org/blob-storage-models": "next",
+		"@twin.org/core": "next",
+		"@twin.org/crypto": "next",
+		"@twin.org/data-json-ld": "next",
+		"@twin.org/document-management-models": "0.0.1-next.2",
+		"@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/web": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}