@twin.org/auditable-item-graph-service 0.0.1-next.10

package/docs/reference/classes/AuditableItemGraphAlias.md

@@ -0,0 +1,61 @@
+# Class: AuditableItemGraphAlias
+
+Class describing the auditable item graph alias.
+
+## Constructors
+
+### new AuditableItemGraphAlias()
+
+> **new AuditableItemGraphAlias**(): [`AuditableItemGraphAlias`](AuditableItemGraphAlias.md)
+
+#### Returns
+
+[`AuditableItemGraphAlias`](AuditableItemGraphAlias.md)
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The alternative alias for the vertex.
+
+***
+
+### aliasFormat?
+
+> `optional` **aliasFormat**: `string`
+
+The format of the alias for the vertex.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The date/time of when the alias was created.
+
+***
+
+### dateModified?
+
+> `optional` **dateModified**: `string`
+
+The date/time of when the alias was last modified.
+
+***
+
+### dateDeleted?
+
+> `optional` **dateDeleted**: `string`
+
+The timestamp of when the alias was deleted, as we never actually remove items.
+
+***
+
+### aliasObject?
+
+> `optional` **aliasObject**: `IJsonLdNodeObject`
+
+Object to associate with the alias as JSON-LD.

package/docs/reference/classes/AuditableItemGraphChangeset.md

@@ -0,0 +1,61 @@
+# Class: AuditableItemGraphChangeset
+
+Class describing a set of updates to the vertex.
+
+## Constructors
+
+### new AuditableItemGraphChangeset()
+
+> **new AuditableItemGraphChangeset**(): [`AuditableItemGraphChangeset`](AuditableItemGraphChangeset.md)
+
+#### Returns
+
+[`AuditableItemGraphChangeset`](AuditableItemGraphChangeset.md)
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The id of the changeset.
+
+***
+
+### vertexId
+
+> **vertexId**: `string`
+
+The vertex the changeset belongs to.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The date/time of when the changeset was created.
+
+***
+
+### userIdentity
+
+> **userIdentity**: `string`
+
+The identity of the user who made the changeset.
+
+***
+
+### patches
+
+> **patches**: [`AuditableItemGraphPatch`](AuditableItemGraphPatch.md)[]
+
+The patches in the changeset.
+
+***
+
+### proofId
+
+> **proofId**: `string`
+
+The immutable proof id which contains the signature for this changeset.

package/docs/reference/classes/AuditableItemGraphEdge.md

@@ -0,0 +1,61 @@
+# Class: AuditableItemGraphEdge
+
+Class describing the auditable item graph edge.
+
+## Constructors
+
+### new AuditableItemGraphEdge()
+
+> **new AuditableItemGraphEdge**(): [`AuditableItemGraphEdge`](AuditableItemGraphEdge.md)
+
+#### Returns
+
+[`AuditableItemGraphEdge`](AuditableItemGraphEdge.md)
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The id of the edge.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The date/time of when the edge was created.
+
+***
+
+### dateModified?
+
+> `optional` **dateModified**: `string`
+
+The date/time of when the edge was last modified.
+
+***
+
+### dateDeleted?
+
+> `optional` **dateDeleted**: `string`
+
+The timestamp of when the edge was deleted, as we never actually remove items.
+
+***
+
+### edgeRelationship
+
+> **edgeRelationship**: `string`
+
+The relationship between the two vertices.
+
+***
+
+### edgeObject?
+
+> `optional` **edgeObject**: `IJsonLdNodeObject`
+
+Object to associate with the edge as JSON-LD.

package/docs/reference/classes/AuditableItemGraphPatch.md

@@ -0,0 +1,45 @@
+# Class: AuditableItemGraphPatch
+
+Class describing the auditable item graph patches.
+
+## Constructors
+
+### new AuditableItemGraphPatch()
+
+> **new AuditableItemGraphPatch**(): [`AuditableItemGraphPatch`](AuditableItemGraphPatch.md)
+
+#### Returns
+
+[`AuditableItemGraphPatch`](AuditableItemGraphPatch.md)
+
+## Properties
+
+### op
+
+> **op**: `"replace"` \| `"add"` \| `"remove"` \| `"copy"` \| `"move"` \| `"test"`
+
+The operation for the patch.
+
+***
+
+### path
+
+> **path**: `string`
+
+The path for the patch.
+
+***
+
+### from?
+
+> `optional` **from**: `string`
+
+The from for the patch.
+
+***
+
+### value?
+
+> `optional` **value**: `unknown`
+
+The value for the patch.

package/docs/reference/classes/AuditableItemGraphResource.md

@@ -0,0 +1,53 @@
+# Class: AuditableItemGraphResource
+
+Class describing the auditable item graph vertex resource.
+
+## Constructors
+
+### new AuditableItemGraphResource()
+
+> **new AuditableItemGraphResource**(): [`AuditableItemGraphResource`](AuditableItemGraphResource.md)
+
+#### Returns
+
+[`AuditableItemGraphResource`](AuditableItemGraphResource.md)
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The id of the resource.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The date/time of when the resource was created.
+
+***
+
+### dateModified?
+
+> `optional` **dateModified**: `string`
+
+The date/time of when the resource was last modified.
+
+***
+
+### dateDeleted?
+
+> `optional` **dateDeleted**: `string`
+
+The timestamp of when the resource was deleted, as we never actually remove items.
+
+***
+
+### resourceObject?
+
+> `optional` **resourceObject**: `IJsonLdNodeObject`
+
+Object to associate with the resource as JSON-LD.

package/docs/reference/classes/AuditableItemGraphService.md

@@ -0,0 +1,289 @@
+# Class: AuditableItemGraphService
+
+Class for performing auditable item graph operations.
+
+## Implements
+
+- `IAuditableItemGraphComponent`
+
+## Constructors
+
+### new AuditableItemGraphService()
+
+> **new AuditableItemGraphService**(`options`?): [`AuditableItemGraphService`](AuditableItemGraphService.md)
+
+Create a new instance of AuditableItemGraphService.
+
+#### Parameters
+
+• **options?**
+
+The dependencies for the auditable item graph connector.
+
+• **options.immutableProofComponentType?**: `string`
+
+The immutable proof component type, defaults to "immutable-proof".
+
+• **options.vertexEntityStorageType?**: `string`
+
+The entity storage for vertices, defaults to "auditable-item-graph-vertex".
+
+• **options.changesetEntityStorageType?**: `string`
+
+The entity storage for changesets, defaults to "auditable-item-graph-changeset".
+
+• **options.config?**: [`IAuditableItemGraphServiceConfig`](../interfaces/IAuditableItemGraphServiceConfig.md)
+
+The configuration for the connector.
+
+#### Returns
+
+[`AuditableItemGraphService`](AuditableItemGraphService.md)
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"aig"`
+
+The namespace for the service.
+
+***
+
+### NAMESPACE\_CHANGESET
+
+> `readonly` `static` **NAMESPACE\_CHANGESET**: `string` = `"changeset"`
+
+The namespace for the service changeset.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.CLASS_NAME`
+
+## Methods
+
+### create()
+
+> **create**(`vertexObject`?, `aliases`?, `resources`?, `edges`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+
+Create a new graph vertex.
+
+#### Parameters
+
+• **vertexObject?**: `IJsonLdNodeObject`
+
+The object for the vertex as JSON-LD.
+
+• **aliases?**: `object`[]
+
+Alternative aliases that can be used to identify the vertex.
+
+• **resources?**: `object`[]
+
+The resources attached to the vertex.
+
+• **edges?**: `object`[]
+
+The edges connected to the vertex.
+
+• **userIdentity?**: `string`
+
+The identity to create the auditable item graph operation with.
+
+• **nodeIdentity?**: `string`
+
+The node identity to include in the auditable item graph.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The id of the new graph item.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.create`
+
+***
+
+### get()
+
+> **get**(`id`, `options`?): `Promise`\<`IAuditableItemGraphVertex`\>
+
+Get a graph vertex.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the vertex to get.
+
+• **options?**
+
+Additional options for the get operation.
+
+• **options.includeDeleted?**: `boolean`
+
+Whether to include deleted/updated aliases, resource, edges, defaults to false.
+
+• **options.includeChangesets?**: `boolean`
+
+Whether to include the changesets of the vertex, defaults to false.
+
+• **options.verifySignatureDepth?**: `VerifyDepth`
+
+How many signatures to verify, defaults to "none".
+
+#### Returns
+
+`Promise`\<`IAuditableItemGraphVertex`\>
+
+The vertex if found.
+
+#### Throws
+
+NotFoundError if the vertex is not found.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.get`
+
+***
+
+### update()
+
+> **update**(`id`, `vertexObject`?, `aliases`?, `resources`?, `edges`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+
+Update a graph vertex.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the vertex to update.
+
+• **vertexObject?**: `IJsonLdNodeObject`
+
+The object for the vertex.
+
+• **aliases?**: `object`[]
+
+Alternative aliases that can be used to identify the vertex.
+
+• **resources?**: `object`[]
+
+The resources attached to the vertex.
+
+• **edges?**: `object`[]
+
+The edges connected to the vertex.
+
+• **userIdentity?**: `string`
+
+The identity to create the auditable item graph operation with.
+
+• **nodeIdentity?**: `string`
+
+The node identity to include in the auditable item graph.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.update`
+
+***
+
+### removeImmutable()
+
+> **removeImmutable**(`id`, `nodeIdentity`?): `Promise`\<`void`\>
+
+Remove the immutable storage for an item.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the vertex to get.
+
+• **nodeIdentity?**: `string`
+
+The node identity to use for vault operations.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Throws
+
+NotFoundError if the vertex is not found.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.removeImmutable`
+
+***
+
+### query()
+
+> **query**(`options`?, `orderBy`?, `orderByDirection`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<`IAuditableItemGraphVertexList`\>
+
+Query the graph for vertices.
+
+#### Parameters
+
+• **options?**
+
+The query options.
+
+• **options.id?**: `string`
+
+The optional id to look for.
+
+• **options.idMode?**: `"both"` \| `"id"` \| `"alias"`
+
+Look in id, alias or both, defaults to both.
+
+• **orderBy?**: `"dateCreated"` \| `"dateModified"`
+
+The order for the results, defaults to created.
+
+• **orderByDirection?**: `SortDirection`
+
+The direction for the order, defaults to desc.
+
+• **properties?**: keyof `IAuditableItemGraphVertex`[]
+
+The properties to return, if not provided defaults to id, created, aliases and object.
+
+• **cursor?**: `string`
+
+The cursor to request the next page of entities.
+
+• **pageSize?**: `number`
+
+The maximum number of entities in a page.
+
+#### Returns
+
+`Promise`\<`IAuditableItemGraphVertexList`\>
+
+The entities, which can be partial if a limited keys list was provided.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.query`

package/docs/reference/classes/AuditableItemGraphVertex.md

@@ -0,0 +1,85 @@
+# Class: AuditableItemGraphVertex
+
+Class describing the auditable item graph vertex.
+
+## Constructors
+
+### new AuditableItemGraphVertex()
+
+> **new AuditableItemGraphVertex**(): [`AuditableItemGraphVertex`](AuditableItemGraphVertex.md)
+
+#### Returns
+
+[`AuditableItemGraphVertex`](AuditableItemGraphVertex.md)
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The id of the vertex.
+
+***
+
+### nodeIdentity?
+
+> `optional` **nodeIdentity**: `string`
+
+The identity of the node which controls the vertex.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The date/time of when the vertex was created.
+
+***
+
+### dateModified?
+
+> `optional` **dateModified**: `string`
+
+The date/time of when the vertex was last modified.
+
+***
+
+### aliasIndex?
+
+> `optional` **aliasIndex**: `string`
+
+Combined alias index for the vertex used for querying.
+
+***
+
+### vertexObject?
+
+> `optional` **vertexObject**: `IJsonLdNodeObject`
+
+Object to associate with the vertex as JSON-LD.
+
+***
+
+### aliases?
+
+> `optional` **aliases**: [`AuditableItemGraphAlias`](AuditableItemGraphAlias.md)[]
+
+Alternative aliases that can be used to identify the vertex.
+
+***
+
+### resources?
+
+> `optional` **resources**: [`AuditableItemGraphResource`](AuditableItemGraphResource.md)[]
+
+The resources attached to the vertex.
+
+***
+
+### edges?
+
+> `optional` **edges**: [`AuditableItemGraphEdge`](AuditableItemGraphEdge.md)[]
+
+Edges connected to the vertex.

package/docs/reference/functions/auditableItemGraphCreate.md

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

package/docs/reference/functions/auditableItemGraphGet.md

@@ -0,0 +1,25 @@
+# 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.