@twin.org/auditable-item-stream-service 0.0.3-next.9 → 0.9.0

package/docs/reference/classes/AuditableItemStream.md

@@ -14,7 +14,7 @@ Class describing the auditable item stream.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -22,7 +22,7 @@ The id of the stream.
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
@@ -30,39 +30,39 @@ The date/time of when the stream was created.
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the stream was modified.
 
 ***
 
-### organizationIdentity?
+### organizationIdentity {#organizationidentity}
 
-> `optional` **organizationIdentity**: `string`
+> **organizationIdentity**: `string`
 
 The identity of the organization which controls the stream.
 
 ***
 
-### userIdentity?
+### userIdentity? {#useridentity}
 
-> `optional` **userIdentity**: `string`
+> `optional` **userIdentity?**: `string`
 
 The identity of the user which created the stream.
 
 ***
 
-### annotationObject?
+### annotationObject? {#annotationobject}
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
 
 Object to associate with the stream as JSON-LD.
 
 ***
 
-### numberOfItems
+### numberOfItems {#numberofitems}
 
 > **numberOfItems**: `number`
 
@@ -70,7 +70,7 @@ The number of items in the stream.
 
 ***
 
-### immutableInterval
+### immutableInterval {#immutableinterval}
 
 > **immutableInterval**: `number`
 
@@ -78,8 +78,24 @@ After how many entries do we add immutable checks.
 
 ***
 
-### proofId?
+### closed? {#closed}
 
-> `optional` **proofId**: `string`
+> `optional` **closed?**: `boolean`
+
+Is the stream closed for entry updates.
+
+***
+
+### mode? {#mode}
+
+> `optional` **mode?**: `AuditableItemStreamModes`
+
+The operation mode for the stream.
+
+***
+
+### proofId? {#proofid}
+
+> `optional` **proofId?**: `string`
 
 The immutable proof id.

package/docs/reference/classes/AuditableItemStreamEntry.md

@@ -14,7 +14,7 @@ Class describing the auditable item stream entry.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -22,7 +22,7 @@ The id of the entry.
 
 ***
 
-### streamId
+### streamId {#streamid}
 
 > **streamId**: `string`
 
@@ -30,7 +30,7 @@ The stream that the entry belongs to.
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
@@ -38,31 +38,31 @@ The date/time of when the entry was created.
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the entry was modified.
 
 ***
 
-### dateDeleted?
+### dateDeleted? {#datedeleted}
 
-> `optional` **dateDeleted**: `string`
+> `optional` **dateDeleted?**: `string`
 
 The date/time of when the entry was deleted, as we never actually remove items.
 
 ***
 
-### userIdentity?
+### userIdentity? {#useridentity}
 
-> `optional` **userIdentity**: `string`
+> `optional` **userIdentity?**: `string`
 
 The identity of the user that added the entry.
 
 ***
 
-### entryObject
+### entryObject {#entryobject}
 
 > **entryObject**: `IJsonLdNodeObject`
 
@@ -70,7 +70,7 @@ Object to associate with the entry as JSON-LD.
 
 ***
 
-### index
+### index {#index}
 
 > **index**: `number`
 
@@ -78,8 +78,8 @@ The index of the entry in the stream.
 
 ***
 
-### proofId?
+### proofId? {#proofid}
 
-> `optional` **proofId**: `string`
+> `optional` **proofId?**: `string`
 
 The immutable proof id.

package/docs/reference/classes/AuditableItemStreamService.md

@@ -28,7 +28,7 @@ The dependencies for the auditable item stream connector.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -36,7 +36,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -54,9 +54,27 @@ The class name of the component.
 
 ***
 
-### create()
+### start() {#start}
 
-> **create**(`stream`, `options?`): `Promise`\<`string`\>
+> **start**(): `Promise`\<`void`\>
+
+Register all AIS metrics with the telemetry component.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the metrics have been registered.
+
+#### Implementation of
+
+`IAuditableItemStreamComponent.start`
+
+***
+
+### create() {#create}
+
+> **create**(`stream`): `Promise`\<`string`\>
 
 Create a new stream.
 
@@ -64,46 +82,77 @@ Create a new stream.
 
 ##### stream
 
+`IAuditableItemStreamBase`
+
 The stream to create.
 
-###### annotationObject?
+#### Returns
 
-`IJsonLdNodeObject`
+`Promise`\<`string`\>
 
-The object for the stream as JSON-LD.
+The id of the new stream item.
 
-###### entries?
+#### Implementation of
 
-`object`[]
+`IAuditableItemStreamComponent.create`
 
-Entries to store in the stream.
+***
 
-##### options?
+### close() {#close}
 
-Options for creating the stream.
+> **close**(`id`): `Promise`\<`void`\>
 
-###### immutableInterval?
+Close a stream.
 
-`number`
+#### Parameters
 
-After how many entries do we add immutable checks, defaults to service configured value.
-A value of 0 will disable integrity checks, 1 will be every item, or any other integer for an interval.
+##### id
+
+`string`
+
+The id of the stream to close.
 
 #### Returns
 
-`Promise`\<`string`\>
+`Promise`\<`void`\>
 
-The id of the new stream item.
+A promise that resolves when the stream has been closed.
 
 #### Implementation of
 
-`IAuditableItemStreamComponent.create`
+`IAuditableItemStreamComponent.close`
+
+***
+
+### update() {#update}
+
+> **update**(`stream`): `Promise`\<`void`\>
+
+Update a stream.
+
+#### Parameters
+
+##### stream
+
+`Pick`\<`IAuditableItemStream`, `"@context"` \| `"type"` \| `"id"` \| `"annotationObject"`\>
+
+The stream to update, does not update entries.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the stream has been updated.
+
+#### Implementation of
+
+`IAuditableItemStreamComponent.update`
 
 ***
 
-### get()
+### get() {#get}
 
-> **get**(`id`, `options?`): `Promise`\<`IAuditableItemStream`\>
+> **get**(`id`, `cursor?`, `limit?`, `options?`): `Promise`\<\{ `stream`: `IAuditableItemStream`; `cursor?`: `string`; \}\>
 
 Get a stream header without the entries.
 
@@ -115,6 +164,18 @@ Get a stream header without the entries.
 
 The id of the stream to get.
 
+##### cursor?
+
+`string`
+
+Cursor to use for next chunk of entries.
+
+##### limit?
+
+`number`
+
+Limit the number of entries to return, only applicable if includeEntries is true.
+
 ##### options?
 
 Additional options for the get operation.
@@ -145,7 +206,7 @@ Should the entries be verified, defaults to false.
 
 #### Returns
 
-`Promise`\<`IAuditableItemStream`\>
+`Promise`\<\{ `stream`: `IAuditableItemStream`; `cursor?`: `string`; \}\>
 
 The stream and entries if found.
 
@@ -159,43 +220,7 @@ NotFoundError if the stream is not found
 
 ***
 
-### update()
-
-> **update**(`stream`): `Promise`\<`void`\>
-
-Update a stream.
-
-#### Parameters
-
-##### stream
-
-The stream to update.
-
-###### id
-
-`string`
-
-The id of the stream to update.
-
-###### annotationObject?
-
-`IJsonLdNodeObject`
-
-The object for the stream as JSON-LD.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-Nothing.
-
-#### Implementation of
-
-`IAuditableItemStreamComponent.update`
-
-***
-
-### remove()
+### remove() {#remove}
 
 > **remove**(`id`): `Promise`\<`void`\>
 
@@ -213,7 +238,7 @@ The id of the stream to remove.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the stream has been removed.
 
 #### Implementation of
 
@@ -221,7 +246,7 @@ Nothing.
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IAuditableItemStreamList`; `cursor?`: `string`; \}\>
 
@@ -237,9 +262,9 @@ Conditions to use in the query.
 
 ##### orderBy?
 
-The order for the results, defaults to created.
+`"dateCreated"` \| `"dateModified"`
 
-`"dateCreated"` | `"dateModified"`
+The order for the results, defaults to created.
 
 ##### orderByDirection?
 
@@ -277,7 +302,7 @@ The entities, which can be partial if a limited keys list was provided.
 
 ***
 
-### createEntry()
+### createEntry() {#createentry}
 
 > **createEntry**(`streamId`, `entryObject`): `Promise`\<`string`\>
 
@@ -309,7 +334,7 @@ The id of the created entry, if not provided.
 
 ***
 
-### getEntry()
+### getEntry() {#getentry}
 
 > **getEntry**(`streamId`, `entryId`, `options?`): `Promise`\<`IAuditableItemStreamEntry`\>
 
@@ -355,7 +380,7 @@ NotFoundError if the stream is not found.
 
 ***
 
-### getEntryObject()
+### getEntryObject() {#getentryobject}
 
 > **getEntryObject**(`streamId`, `entryId`): `Promise`\<`IJsonLdNodeObject`\>
 
@@ -391,7 +416,7 @@ NotFoundError if the stream is not found.
 
 ***
 
-### updateEntry()
+### updateEntry() {#updateentry}
 
 > **updateEntry**(`streamId`, `entryId`, `entryObject`): `Promise`\<`void`\>
 
@@ -421,7 +446,7 @@ The object for the entry as JSON-LD.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the entry has been updated.
 
 #### Implementation of
 
@@ -429,7 +454,7 @@ Nothing.
 
 ***
 
-### removeEntry()
+### removeEntry() {#removeentry}
 
 > **removeEntry**(`streamId`, `entryId`): `Promise`\<`void`\>
 
@@ -453,7 +478,7 @@ The id of the entry to remove.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the entry has been removed.
 
 #### Implementation of
 
@@ -461,19 +486,19 @@ Nothing.
 
 ***
 
-### getEntries()
+### getEntries() {#getentries}
 
-> **getEntries**(`streamId`, `options?`): `Promise`\<\{ `entries`: `IAuditableItemStreamEntryList`; `cursor?`: `string`; \}\>
+> **getEntries**(`streamId?`, `options?`): `Promise`\<\{ `entries`: `IAuditableItemStreamEntryList`; `cursor?`: `string`; \}\>
 
 Get the entries for the stream.
 
 #### Parameters
 
-##### streamId
+##### streamId?
 
 `string`
 
-The id of the stream to get.
+The id of the stream to get, if undefined returns all matching entries.
 
 ##### options?
 
@@ -531,19 +556,19 @@ NotFoundError if the stream is not found.
 
 ***
 
-### getEntryObjects()
+### getEntryObjects() {#getentryobjects}
 
-> **getEntryObjects**(`streamId`, `options?`): `Promise`\<\{ `entries`: `IAuditableItemStreamEntryObjectList`; `cursor?`: `string`; \}\>
+> **getEntryObjects**(`streamId?`, `options?`): `Promise`\<\{ `entries`: `IAuditableItemStreamEntryObjectList`; `cursor?`: `string`; \}\>
 
 Get the entry objects for the stream.
 
 #### Parameters
 
-##### streamId
+##### streamId?
 
 `string`
 
-The id of the stream to get.
+The id of the stream to get, if undefined returns all matching entries.
 
 ##### options?
 
@@ -595,11 +620,11 @@ NotFoundError if the stream is not found.
 
 ***
 
-### removeVerifiable()
+### removeProof() {#removeproof}
 
-> **removeVerifiable**(`streamId`): `Promise`\<`void`\>
+> **removeProof**(`streamId`): `Promise`\<`void`\>
 
-Remove the verifiable storage for the stream and entries.
+Remove the proof for the stream and entries.
 
 #### Parameters
 
@@ -607,13 +632,13 @@ Remove the verifiable storage for the stream and entries.
 
 `string`
 
-The id of the stream to remove the storage from.
+The id of the stream to remove the proof from.
 
 #### Returns
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the proof has been removed.
 
 #### Throws
 
@@ -621,4 +646,4 @@ NotFoundError if the vertex is not found.
 
 #### Implementation of
 
-`IAuditableItemStreamComponent.removeVerifiable`
+`IAuditableItemStreamComponent.removeProof`

package/docs/reference/functions/auditableItemStreamClose.md

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

package/docs/reference/functions/auditableItemStreamDeleteEntry.md

@@ -2,7 +2,7 @@
 
 > **auditableItemStreamDeleteEntry**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
 
-Get the stream.
+Delete an entry from the stream.
 
 ## Parameters
 

package/docs/reference/functions/auditableItemStreamList.md

@@ -2,7 +2,7 @@
 
 > **auditableItemStreamList**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditableItemStreamListResponse`\>
 
-Query the stream.
+List all streams.
 
 ## Parameters
 

package/docs/reference/functions/auditableItemStreamListEntries.md

@@ -2,7 +2,7 @@
 
 > **auditableItemStreamListEntries**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditableItemStreamListEntriesResponse`\>
 
-Query the stream.
+List the entries for a stream.
 
 ## Parameters
 

package/docs/reference/functions/auditableItemStreamListEntriesNoStream.md

@@ -0,0 +1,31 @@
+# Function: auditableItemStreamListEntriesNoStream()
+
+> **auditableItemStreamListEntriesNoStream**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditableItemStreamListEntriesResponse`\>
+
+List entries across all streams.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemStreamListEntriesNoStreamRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IAuditableItemStreamListEntriesResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/auditableItemStreamListEntryObjects.md

@@ -2,7 +2,7 @@
 
 > **auditableItemStreamListEntryObjects**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditableItemStreamListEntryObjectsResponse`\>
 
-Query the stream objects.
+List the entry objects for a stream.
 
 ## Parameters
 

package/docs/reference/functions/auditableItemStreamListEntryObjectsNoStream.md

@@ -0,0 +1,31 @@
+# Function: auditableItemStreamListEntryObjectsNoStream()
+
+> **auditableItemStreamListEntryObjectsNoStream**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditableItemStreamListEntryObjectsResponse`\>
+
+List entry objects across all streams.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemStreamListEntryObjectsNoStreamRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IAuditableItemStreamListEntryObjectsResponse`\>
+
+The response object with additional http response properties.