@3sixty/document-management-service 0.0.0-stage → 0.20.0-next.1

package/docs/reference/classes/DocumentManagementService.md

@@ -0,0 +1,464 @@
+# Class: DocumentManagementService
+
+Service for performing document management operations.
+
+## Implements
+
+- `IDocumentManagementComponent`
+- `IHealthProviderComponent`
+
+## Constructors
+
+### Constructor
+
+> **new DocumentManagementService**(`options?`): `DocumentManagementService`
+
+Create a new instance of DocumentManagementService.
+
+#### Parameters
+
+##### options?
+
+[`IDocumentManagementServiceConstructorOptions`](../interfaces/IDocumentManagementServiceConstructorOptions.md)
+
+The options for the service.
+
+#### Returns
+
+`DocumentManagementService`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IDocumentManagementComponent.className`
+
+***
+
+### healthApplication() {#healthapplication}
+
+> **healthApplication**(`callback`): `Promise`\<`IHealth`[] \| `undefined`\>
+
+Runs a blob lifecycle (create, get, remove) against the blob storage component to verify
+the service is operational.
+
+#### Parameters
+
+##### callback
+
+`HealthApplicationCallback`
+
+The callback to invoke when a deferred health result is ready.
+
+#### Returns
+
+`Promise`\<`IHealth`[] \| `undefined`\>
+
+The health status of the service.
+
+#### Implementation of
+
+`IHealthProviderComponent.healthApplication`
+
+***
+
+### start() {#start}
+
+> **start**(): `Promise`\<`void`\>
+
+Register all document management metrics with the telemetry component.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when metrics have been registered.
+
+#### Implementation of
+
+`IDocumentManagementComponent.start`
+
+***
+
+### create() {#create}
+
+> **create**(`document`, `blob`, `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.
+For any other changes the current revision will be updated.
+
+#### Parameters
+
+##### document
+
+`IDocumentBase`
+
+The document base properties.
+
+##### blob
+
+`string` \| `Uint8Array`\<`ArrayBufferLike`\>
+
+The data to create the document with as bytes, or an existing blob storage entry id.
+
+##### auditableItemGraphEdges?
+
+`IDocumentManagementEdgeEntry`[]
+
+The auditable item graph vertices to connect the document to.
+
+##### options?
+
+Additional options for the set operation.
+
+###### includeAttestation?
+
+`boolean`
+
+Flag to include an attestation for the document, defaults to false.
+
+###### includeAlias?
+
+`boolean`
+
+Flag to add the document id as an alias to the aig vertex, defaults to true.
+
+###### aliasAnnotationObject?
+
+`IJsonLdNodeObject`
+
+Annotation object for the alias.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The auditable item graph vertex created for the document including its revision.
+
+#### Implementation of
+
+`IDocumentManagementComponent.create`
+
+***
+
+### updatePartial() {#updatepartial}
+
+> **updatePartial**(`auditableItemGraphDocumentId`, `document?`, `blob?`, `auditableItemGraphEdges?`, `options?`): `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.
+For any other changes the current revision will be updated.
+
+#### Parameters
+
+##### auditableItemGraphDocumentId
+
+`string`
+
+The auditable item graph vertex id which contains the document.
+
+##### document?
+
+`Partial`\<`Pick`\<`IDocumentBase`, `"annotationObject"` \| `"documentIdFormat"` \| `"documentCode"`\>\>
+
+The document base properties to update. Only annotationObject is applied; other fields are ignored.
+
+##### blob?
+
+`string` \| `Uint8Array`\<`ArrayBufferLike`\>
+
+The data to update the document with as bytes, or an existing blob storage entry id.
+
+##### auditableItemGraphEdges?
+
+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`[]
+
+Target vertex IDs to disconnect; their back-edges are removed.
+
+##### options?
+
+Additional options for the update operation.
+
+###### includeAttestation?
+
+`boolean`
+
+Set to true to include an attestation for the document, or false to remove the existing attestation. Omit (undefined) to leave attestation state unchanged.
+
+###### includeAlias?
+
+`boolean`
+
+Set to true to add the document id as an alias on the aig vertex, or false to remove it. Omit to leave alias state unchanged.
+
+###### aliasAnnotationObject?
+
+`IJsonLdNodeObject`
+
+Annotation object for the alias when adding.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the document has been updated.
+
+#### Implementation of
+
+`IDocumentManagementComponent.updatePartial`
+
+***
+
+### get() {#get}
+
+> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IDocumentList`; `cursor?`: `string`; \}\>
+
+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?
+
+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.
+
+###### includeDeletedEdges?
+
+`boolean`
+
+Flag to include soft-deleted edges in the response, defaults to false.
+
+###### extractRuleGroupId?
+
+`string`
+
+If provided will extract data from the document using the specified rule group id.
+
+###### extractMimeType?
+
+`string`
+
+By default extraction will auto detect the mime type of the document, this can be used to override the detection.
+
+##### cursor?
+
+`string`
+
+The cursor to get the next chunk of revisions.
+
+##### limit?
+
+`number`
+
+Limit the number of items to return, defaults to 1 so only most recent is returned.
+
+#### Returns
+
+`Promise`\<\{ `entries`: `IDocumentList`; `cursor?`: `string`; \}\>
+
+The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+
+#### Implementation of
+
+`IDocumentManagementComponent.get`
+
+***
+
+### getRevision() {#getrevision}
+
+> **getRevision**(`auditableItemGraphDocumentId`, `revision`, `options?`): `Promise`\<`IDocumentHydrated`\>
+
+Get a document revision using it's auditable item graph vertex id.
+
+#### Parameters
+
+##### auditableItemGraphDocumentId
+
+`string`
+
+The auditable item graph vertex id which contains the document.
+
+##### revision
+
+`number`
+
+The revision id for the document.
+
+##### 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.
+
+###### extractRuleGroupId?
+
+`string`
+
+If provided will extract data from the document using the specified rule group id.
+
+###### extractMimeType?
+
+`string`
+
+By default extraction will auto detect the mime type of the document, this can be used to override the detection.
+
+#### Returns
+
+`Promise`\<`IDocumentHydrated`\>
+
+The document for the specified revision.
+
+#### Implementation of
+
+`IDocumentManagementComponent.getRevision`
+
+***
+
+### removeRevision() {#removerevision}
+
+> **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.
+
+#### Parameters
+
+##### auditableItemGraphDocumentId
+
+`string`
+
+The auditable item graph vertex id which contains the document.
+
+##### revision
+
+`number`
+
+The revision of the document to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the revision has been removed.
+
+#### Implementation of
+
+`IDocumentManagementComponent.removeRevision`
+
+***
+
+### query() {#query}
+
+> **query**(`documentId`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IAuditableItemGraphVertexList`; `cursor?`: `string`; \}\>
+
+Find all the document with a specific id.
+
+#### Parameters
+
+##### documentId
+
+`string`
+
+The document id to find in the graph.
+
+##### cursor?
+
+`string`
+
+The cursor to get the next chunk of documents.
+
+##### limit?
+
+`number`
+
+The limit to get the next chunk of documents.
+
+#### Returns
+
+`Promise`\<\{ `entries`: `IAuditableItemGraphVertexList`; `cursor?`: `string`; \}\>
+
+The graph vertices that contain documents referencing the specified document id.
+
+#### Implementation of
+
+`IDocumentManagementComponent.query`

package/docs/reference/functions/documentManagementCreate.md

@@ -0,0 +1,37 @@
+# Function: documentManagementCreate()
+
+> **documentManagementCreate**(`httpRequestContext`, `componentName`, `request`, `baseRouteName`): `Promise`\<`ICreatedResponse`\>
+
+Create a document as 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
+
+`IDocumentManagementCreateRequest`
+
+The request.
+
+### baseRouteName
+
+`string`
+
+The base route name for constructing URLs.
+
+## Returns
+
+`Promise`\<`ICreatedResponse`\>
+
+The response object with additional http response properties.

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/documentManagementGetRevision.md

@@ -0,0 +1,31 @@
+# Function: documentManagementGetRevision()
+
+> **documentManagementGetRevision**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IDocumentManagementGetRevisionResponse`\>
+
+Get the document revision 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
+
+`IDocumentManagementGetRevisionRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IDocumentManagementGetRevisionResponse`\>
+
+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/documentManagementUpdatePartial.md

@@ -0,0 +1,31 @@
+# Function: documentManagementUpdatePartial()
+
+> **documentManagementUpdatePartial**(`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
+
+`IDocumentManagementUpdatePartialRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+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,25 @@
+# @3sixty/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)
+- [documentManagementCreate](functions/documentManagementCreate.md)
+- [documentManagementGet](functions/documentManagementGet.md)
+- [documentManagementGetRevision](functions/documentManagementGetRevision.md)
+- [documentManagementUpdatePartial](functions/documentManagementUpdatePartial.md)
+- [documentManagementRemove](functions/documentManagementRemove.md)
+- [documentManagementQuery](functions/documentManagementQuery.md)