@3sixty/auditable-item-graph-service 0.0.0-stage → 0.20.0-next.0

package/docs/reference/classes/AuditableItemGraphVertexIndexHelper.md

@@ -0,0 +1,84 @@
+# Class: AuditableItemGraphVertexIndexHelper
+
+Helper methods for building auditable item graph vertex index entries.
+
+## Constructors
+
+### Constructor
+
+> **new AuditableItemGraphVertexIndexHelper**(): `AuditableItemGraphVertexIndexHelper`
+
+#### Returns
+
+`AuditableItemGraphVertexIndexHelper`
+
+## Methods
+
+### createIndexEntry() {#createindexentry}
+
+> `static` **createIndexEntry**(`vertexId`, `type`, `value`, `dateCreated`, `dateModified?`): [`AuditableItemGraphVertexIndex`](AuditableItemGraphVertexIndex.md)
+
+Create the index entry for one type and value of a vertex. The value is case folded and
+hashed, and the id is derived from the content so the same entry always produces the same id.
+The modification date is excluded from the id as it is optional and changes over time.
+
+#### Parameters
+
+##### vertexId
+
+`string`
+
+The id of the vertex the entry refers to.
+
+##### type
+
+`string`
+
+The index type.
+
+##### value
+
+`string`
+
+The index value.
+
+##### dateCreated
+
+`string`
+
+The creation date of the vertex.
+
+##### dateModified?
+
+`string`
+
+The modification date of the vertex.
+
+#### Returns
+
+[`AuditableItemGraphVertexIndex`](AuditableItemGraphVertexIndex.md)
+
+The index entry.
+
+***
+
+### hashValue() {#hashvalue}
+
+> `static` **hashValue**(`value?`): `string` \| `undefined`
+
+Hash an index value so the composite index key has a fixed size whatever the value length.
+The value is case folded first so lookups are case insensitive.
+
+#### Parameters
+
+##### value?
+
+`string`
+
+The value to hash.
+
+#### Returns
+
+`string` \| `undefined`
+
+The base64 url encoded Blake2b-160 hash, or undefined when there is no value.

package/docs/reference/classes/AuditableItemGraphVertexV0.md

@@ -0,0 +1,101 @@
+# Class: AuditableItemGraphVertexV0
+
+Class describing the auditable item graph vertex, version 0.
+
+## Constructors
+
+### Constructor
+
+> **new AuditableItemGraphVertexV0**(): `AuditableItemGraphVertexV0`
+
+#### Returns
+
+`AuditableItemGraphVertexV0`
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+The id of the vertex.
+
+***
+
+### organizationIdentity {#organizationidentity}
+
+> **organizationIdentity**: `string`
+
+The identity of the organization which controls the vertex.
+
+***
+
+### dateCreated {#datecreated}
+
+> **dateCreated**: `string`
+
+The date/time of when the vertex was created.
+
+***
+
+### dateModified? {#datemodified}
+
+> `optional` **dateModified?**: `string`
+
+The date/time of when the vertex was last modified.
+
+***
+
+### aliasIndex? {#aliasindex}
+
+> `optional` **aliasIndex?**: `string`
+
+Combined alias index for the vertex used for querying.
+
+***
+
+### resourceTypeIndex? {#resourcetypeindex}
+
+> `optional` **resourceTypeIndex?**: `string`
+
+Combined resource type index for the vertex used for querying.
+
+***
+
+### annotationObject? {#annotationobject}
+
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
+
+Object to associate with the vertex as JSON-LD.
+
+***
+
+### aliases? {#aliases}
+
+> `optional` **aliases?**: [`AuditableItemGraphAlias`](AuditableItemGraphAlias.md)[]
+
+Alternative aliases that can be used to identify the vertex.
+
+***
+
+### resources? {#resources}
+
+> `optional` **resources?**: [`AuditableItemGraphResource`](AuditableItemGraphResource.md)[]
+
+The resources attached to the vertex.
+
+***
+
+### edges? {#edges}
+
+> `optional` **edges?**: [`AuditableItemGraphEdge`](AuditableItemGraphEdge.md)[]
+
+Edges connected to the vertex.
+
+***
+
+### version? {#version}
+
+> `optional` **version?**: `number`
+
+The current version of the vertex, incremented on each changeset.

package/docs/reference/classes/AuditableItemGraphVertexV1.md

@@ -0,0 +1,109 @@
+# Class: AuditableItemGraphVertexV1
+
+Class describing the auditable item graph vertex.
+
+## Constructors
+
+### Constructor
+
+> **new AuditableItemGraphVertexV1**(): `AuditableItemGraphVertexV1`
+
+#### Returns
+
+`AuditableItemGraphVertexV1`
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+The id of the vertex.
+
+***
+
+### organizationIdentity {#organizationidentity}
+
+> **organizationIdentity**: `string`
+
+The identity of the organization which controls the vertex.
+
+***
+
+### dateCreated {#datecreated}
+
+> **dateCreated**: `string`
+
+The date/time of when the vertex was created.
+
+***
+
+### dateModified? {#datemodified}
+
+> `optional` **dateModified?**: `string`
+
+The date/time of when the vertex was last modified.
+
+***
+
+### auditMode? {#auditmode}
+
+> `optional` **auditMode?**: `AuditableItemGraphAuditMode`
+
+How the mutations of the vertex are recorded, when absent the vertex behaves as audited.
+
+***
+
+### aliasIndex? {#aliasindex}
+
+> `optional` **aliasIndex?**: `string`
+
+Combined alias index for the vertex used for querying.
+
+***
+
+### resourceTypeIndex? {#resourcetypeindex}
+
+> `optional` **resourceTypeIndex?**: `string`
+
+Combined resource type index for the vertex used for querying.
+
+***
+
+### annotationObject? {#annotationobject}
+
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
+
+Object to associate with the vertex as JSON-LD.
+
+***
+
+### aliases? {#aliases}
+
+> `optional` **aliases?**: [`AuditableItemGraphAlias`](AuditableItemGraphAlias.md)[]
+
+Alternative aliases that can be used to identify the vertex.
+
+***
+
+### resources? {#resources}
+
+> `optional` **resources?**: [`AuditableItemGraphResource`](AuditableItemGraphResource.md)[]
+
+The resources attached to the vertex.
+
+***
+
+### edges? {#edges}
+
+> `optional` **edges?**: [`AuditableItemGraphEdge`](AuditableItemGraphEdge.md)[]
+
+Edges connected to the vertex.
+
+***
+
+### version? {#version}
+
+> `optional` **version?**: `number`
+
+The current version of the vertex, incremented on each changeset.

package/docs/reference/functions/auditableItemGraphChangesetGet.md

@@ -0,0 +1,31 @@
+# Function: auditableItemGraphChangesetGet()
+
+> **auditableItemGraphChangesetGet**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditableItemGraphChangesetGetResponse`\>
+
+Get the graph vertex changeset.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemGraphChangesetGetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IAuditableItemGraphChangesetGetResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/auditableItemGraphChangesetList.md

@@ -0,0 +1,31 @@
+# Function: auditableItemGraphChangesetList()
+
+> **auditableItemGraphChangesetList**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditableItemGraphChangesetListResponse`\>
+
+Get the graph vertex changeset list.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemGraphChangesetListRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IAuditableItemGraphChangesetListResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/auditableItemGraphCreate.md

@@ -0,0 +1,37 @@
+# Function: auditableItemGraphCreate()
+
+> **auditableItemGraphCreate**(`httpRequestContext`, `componentName`, `request`, `baseRouteName`): `Promise`\<`ICreatedResponse`\>
+
+Create the graph vertex.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemGraphCreateRequest`
+
+The request.
+
+### baseRouteName
+
+`string`
+
+The base route name for the API.
+
+## Returns
+
+`Promise`\<`ICreatedResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/auditableItemGraphGet.md

@@ -0,0 +1,31 @@
+# Function: auditableItemGraphGet()
+
+> **auditableItemGraphGet**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditableItemGraphGetResponse`\>
+
+Get the graph vertex.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemGraphGetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IAuditableItemGraphGetResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/auditableItemGraphList.md

@@ -0,0 +1,31 @@
+# Function: auditableItemGraphList()
+
+> **auditableItemGraphList**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditableItemGraphListResponse`\>
+
+Query the graph vertices.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemGraphListRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IAuditableItemGraphListResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/auditableItemGraphRemoveProof.md

@@ -0,0 +1,31 @@
+# Function: auditableItemGraphRemoveProof()
+
+> **auditableItemGraphRemoveProof**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Remove the notarization proof from all changesets of a graph vertex.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemGraphRemoveProofRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/auditableItemGraphUpdate.md

@@ -0,0 +1,31 @@
+# Function: auditableItemGraphUpdate()
+
+> **auditableItemGraphUpdate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Update the graph vertex (PUT - full replacement of vertex state).
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemGraphUpdateRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/auditableItemGraphUpdatePartial.md

@@ -0,0 +1,31 @@
+# Function: auditableItemGraphUpdatePartial()
+
+> **auditableItemGraphUpdatePartial**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Partially update the graph vertex (PATCH - optional scalars; list fields use `{ add, remove }`).
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemGraphUpdatePartialRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/auditableItemGraphVersionGet.md

@@ -0,0 +1,31 @@
+# Function: auditableItemGraphVersionGet()
+
+> **auditableItemGraphVersionGet**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditableItemGraphVersionGetResponse`\>
+
+Get the graph vertex at a specific version.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemGraphVersionGetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IAuditableItemGraphVersionGetResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/auditableItemGraphVersionList.md

@@ -0,0 +1,31 @@
+# Function: auditableItemGraphVersionList()
+
+> **auditableItemGraphVersionList**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditableItemGraphVersionListResponse`\>
+
+Get all versions of a graph vertex.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemGraphVersionListRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IAuditableItemGraphVersionListResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/generateRestRoutesAuditableItemGraph.md

@@ -0,0 +1,25 @@
+# Function: generateRestRoutesAuditableItemGraph()
+
+> **generateRestRoutesAuditableItemGraph**(`baseRouteName`, `componentName`): `IRestRoute`\<`any`, `any`\>[]
+
+The REST routes for auditable item graph.
+
+## 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/functions/initSchema.md

@@ -0,0 +1,9 @@
+# Function: initSchema()
+
+> **initSchema**(): `void`
+
+Initialize the schema for the auditable item graph entity storage connector.
+
+## Returns
+
+`void`

package/docs/reference/index.md

@@ -0,0 +1,40 @@
+# @3sixty/auditable-item-graph-service
+
+## Classes
+
+- [AuditableItemGraphService](classes/AuditableItemGraphService.md)
+- [AuditableItemGraphAlias](classes/AuditableItemGraphAlias.md)
+- [AuditableItemGraphChangeset](classes/AuditableItemGraphChangeset.md)
+- [AuditableItemGraphEdge](classes/AuditableItemGraphEdge.md)
+- [AuditableItemGraphPatch](classes/AuditableItemGraphPatch.md)
+- [AuditableItemGraphResource](classes/AuditableItemGraphResource.md)
+- [AuditableItemGraphVertex](classes/AuditableItemGraphVertex.md)
+- [AuditableItemGraphVertexIndex](classes/AuditableItemGraphVertexIndex.md)
+- [AuditableItemGraphVertexV0](classes/AuditableItemGraphVertexV0.md)
+- [AuditableItemGraphVertexV1](classes/AuditableItemGraphVertexV1.md)
+- [AuditableItemGraphVertexIndexHelper](classes/AuditableItemGraphVertexIndexHelper.md)
+
+## Interfaces
+
+- [IAuditableItemGraphServiceConfig](interfaces/IAuditableItemGraphServiceConfig.md)
+- [IAuditableItemGraphServiceConstructorOptions](interfaces/IAuditableItemGraphServiceConstructorOptions.md)
+
+## Variables
+
+- [tagsAuditableItemGraph](variables/tagsAuditableItemGraph.md)
+- [restEntryPoints](variables/restEntryPoints.md)
+
+## Functions
+
+- [generateRestRoutesAuditableItemGraph](functions/generateRestRoutesAuditableItemGraph.md)
+- [auditableItemGraphCreate](functions/auditableItemGraphCreate.md)
+- [auditableItemGraphGet](functions/auditableItemGraphGet.md)
+- [auditableItemGraphChangesetList](functions/auditableItemGraphChangesetList.md)
+- [auditableItemGraphChangesetGet](functions/auditableItemGraphChangesetGet.md)
+- [auditableItemGraphUpdate](functions/auditableItemGraphUpdate.md)
+- [auditableItemGraphUpdatePartial](functions/auditableItemGraphUpdatePartial.md)
+- [auditableItemGraphList](functions/auditableItemGraphList.md)
+- [auditableItemGraphVersionGet](functions/auditableItemGraphVersionGet.md)
+- [auditableItemGraphRemoveProof](functions/auditableItemGraphRemoveProof.md)
+- [auditableItemGraphVersionList](functions/auditableItemGraphVersionList.md)
+- [initSchema](functions/initSchema.md)