@twin.org/auditable-item-stream-service 0.0.1-next.8 → 0.0.1

package/docs/reference/classes/AuditableItemStream.md

@@ -4,13 +4,13 @@ Class describing the auditable item stream.
 
 ## Constructors
 
-### new AuditableItemStream()
+### Constructor
 
-> **new AuditableItemStream**(): [`AuditableItemStream`](AuditableItemStream.md)
+> **new AuditableItemStream**(): `AuditableItemStream`
 
 #### Returns
 
-[`AuditableItemStream`](AuditableItemStream.md)
+`AuditableItemStream`
 
 ## Properties
 
@@ -54,9 +54,9 @@ The identity of the user which created the stream.
 
 ***
 
-### streamObject?
+### annotationObject?
 
-> `optional` **streamObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject**: `IJsonLdNodeObject`
 
 Object to associate with the stream as JSON-LD.
 

package/docs/reference/classes/AuditableItemStreamEntry.md

@@ -4,13 +4,13 @@ Class describing the auditable item stream entry.
 
 ## Constructors
 
-### new AuditableItemStreamEntry()
+### Constructor
 
-> **new AuditableItemStreamEntry**(): [`AuditableItemStreamEntry`](AuditableItemStreamEntry.md)
+> **new AuditableItemStreamEntry**(): `AuditableItemStreamEntry`
 
 #### Returns
 
-[`AuditableItemStreamEntry`](AuditableItemStreamEntry.md)
+`AuditableItemStreamEntry`
 
 ## Properties
 

package/docs/reference/classes/AuditableItemStreamService.md

@@ -8,37 +8,23 @@ Class for performing auditable item stream operations.
 
 ## Constructors
 
-### new AuditableItemStreamService()
+### Constructor
 
-> **new AuditableItemStreamService**(`options`?): [`AuditableItemStreamService`](AuditableItemStreamService.md)
+> **new AuditableItemStreamService**(`options?`): `AuditableItemStreamService`
 
 Create a new instance of AuditableItemStreamService.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-The dependencies for the auditable item stream connector.
-
-• **options.immutableProofComponentType?**: `string`
-
-The immutable proof component type, defaults to "immutable-proof".
-
-• **options.streamEntityStorageType?**: `string`
-
-The entity storage for stream, defaults to "auditable-item-stream".
-
-• **options.streamEntryEntityStorageType?**: `string`
+[`IAuditableItemStreamServiceConstructorOptions`](../interfaces/IAuditableItemStreamServiceConstructorOptions.md)
 
-The entity storage for stream entries, defaults to "auditable-item-stream-entry".
-
-• **options.config?**: [`IAuditableItemStreamServiceConfig`](../interfaces/IAuditableItemStreamServiceConfig.md)
-
-The configuration for the connector.
+The dependencies for the auditable item stream connector.
 
 #### Returns
 
-[`AuditableItemStreamService`](AuditableItemStreamService.md)
+`AuditableItemStreamService`
 
 ## Properties
 
@@ -64,34 +50,48 @@ Runtime name for the class.
 
 ### create()
 
-> **create**(`streamObject`?, `entries`?, `options`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **create**(`stream`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
 
 Create a new stream.
 
 #### Parameters
 
-• **streamObject?**: `IJsonLdNodeObject`
+##### stream
+
+The stream to create.
+
+###### annotationObject?
+
+`IJsonLdNodeObject`
 
 The object for the stream as JSON-LD.
 
-• **entries?**: `object`[]
+###### entries?
+
+`object`[]
 
 Entries to store in the stream.
 
-• **options?**
+##### options?
 
 Options for creating the stream.
 
-• **options.immutableInterval?**: `number`
+###### immutableInterval?
+
+`number`
 
 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.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The identity to create the auditable item stream operation with.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use for vault operations.
 
@@ -109,33 +109,43 @@ The id of the new stream item.
 
 ### get()
 
-> **get**(`id`, `options`?): `Promise`\<`IAuditableItemStream`\>
+> **get**(`id`, `options?`): `Promise`\<`IAuditableItemStream`\>
 
 Get a stream header without the entries.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the stream to get.
 
-• **options?**
+##### options?
 
 Additional options for the get operation.
 
-• **options.includeEntries?**: `boolean`
+###### includeEntries?
+
+`boolean`
 
 Whether to include the entries, defaults to false.
 
-• **options.includeDeleted?**: `boolean`
+###### includeDeleted?
+
+`boolean`
 
 Whether to include deleted entries, defaults to false.
 
-• **options.verifyStream?**: `boolean`
+###### verifyStream?
+
+`boolean`
 
 Should the stream be verified, defaults to false.
 
-• **options.verifyEntries?**: `boolean`
+###### verifyEntries?
+
+`boolean`
 
 Should the entries be verified, defaults to false.
 
@@ -157,25 +167,37 @@ NotFoundError if the stream is not found
 
 ### update()
 
-> **update**(`id`, `streamObject`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+> **update**(`stream`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
 
 Update a stream.
 
 #### Parameters
 
-• **id**: `string`
+##### stream
+
+The stream to update.
+
+###### id
+
+`string`
 
 The id of the stream to update.
 
-• **streamObject?**: `IJsonLdNodeObject`
+###### annotationObject?
+
+`IJsonLdNodeObject`
 
 The object for the stream as JSON-LD.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The identity to create the auditable item stream operation with.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use for vault operations.
 
@@ -191,35 +213,85 @@ Nothing.
 
 ***
 
+### remove()
+
+> **remove**(`id`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
+
+Delete the stream.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the stream to remove.
+
+##### userIdentity?
+
+`string`
+
+The identity to create the auditable item stream operation with.
+
+##### nodeIdentity?
+
+`string`
+
+The node identity to use for vault operations.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IAuditableItemStreamComponent.remove`
+
+***
+
 ### query()
 
-> **query**(`conditions`?, `orderBy`?, `orderByDirection`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<`IAuditableItemStreamList`\>
+> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<`IAuditableItemStreamList`\>
 
 Query all the streams, will not return entries.
 
 #### Parameters
 
-• **conditions?**: `IComparator`[]
+##### conditions?
+
+`IComparator`[]
 
 Conditions to use in the query.
 
-• **orderBy?**: `"dateCreated"` \| `"dateModified"`
+##### orderBy?
 
 The order for the results, defaults to created.
 
-• **orderByDirection?**: `SortDirection`
+`"dateCreated"` | `"dateModified"`
+
+##### orderByDirection?
+
+`SortDirection`
 
 The direction for the order, defaults to descending.
 
-• **properties?**: keyof `IAuditableItemStream`[]
+##### properties?
+
+keyof `IAuditableItemStream`[]
 
 The properties to return, if not provided defaults to id, created and object.
 
-• **cursor?**: `string`
+##### cursor?
+
+`string`
 
 The cursor to request the next page of entities.
 
-• **pageSize?**: `number`
+##### pageSize?
+
+`number`
 
 The maximum number of entities in a page.
 
@@ -237,25 +309,33 @@ The entities, which can be partial if a limited keys list was provided.
 
 ### createEntry()
 
-> **createEntry**(`id`, `entryObject`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **createEntry**(`streamId`, `entryObject`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
 
 Create an entry in the stream.
 
 #### Parameters
 
-• **id**: `string`
+##### streamId
+
+`string`
 
 The id of the stream to update.
 
-• **entryObject**: `IJsonLdNodeObject`
+##### entryObject
+
+`IJsonLdNodeObject`
 
 The object for the stream as JSON-LD.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The identity to create the auditable item stream operation with.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use for vault operations.
 
@@ -273,25 +353,31 @@ The id of the created entry, if not provided.
 
 ### getEntry()
 
-> **getEntry**(`id`, `entryId`, `options`?): `Promise`\<`IAuditableItemStreamEntry`\>
+> **getEntry**(`streamId`, `entryId`, `options?`): `Promise`\<`IAuditableItemStreamEntry`\>
 
 Get the entry from the stream.
 
 #### Parameters
 
-• **id**: `string`
+##### streamId
+
+`string`
 
 The id of the stream to get.
 
-• **entryId**: `string`
+##### entryId
+
+`string`
 
 The id of the stream entry to get.
 
-• **options?**
+##### options?
 
 Additional options for the get operation.
 
-• **options.verifyEntry?**: `boolean`
+###### verifyEntry?
+
+`boolean`
 
 Should the entry be verified, defaults to false.
 
@@ -313,17 +399,21 @@ NotFoundError if the stream is not found.
 
 ### getEntryObject()
 
-> **getEntryObject**(`id`, `entryId`): `Promise`\<`IJsonLdNodeObject`\>
+> **getEntryObject**(`streamId`, `entryId`): `Promise`\<`IJsonLdNodeObject`\>
 
 Get the entry object from the stream.
 
 #### Parameters
 
-• **id**: `string`
+##### streamId
+
+`string`
 
 The id of the stream to get.
 
-• **entryId**: `string`
+##### entryId
+
+`string`
 
 The id of the stream entry to get.
 
@@ -345,29 +435,39 @@ NotFoundError if the stream is not found.
 
 ### updateEntry()
 
-> **updateEntry**(`id`, `entryId`, `entryObject`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+> **updateEntry**(`streamId`, `entryId`, `entryObject`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
 
 Update an entry in the stream.
 
 #### Parameters
 
-• **id**: `string`
+##### streamId
+
+`string`
 
 The id of the stream to update.
 
-• **entryId**: `string`
+##### entryId
+
+`string`
 
 The id of the entry to update.
 
-• **entryObject**: `IJsonLdNodeObject`
+##### entryObject
+
+`IJsonLdNodeObject`
 
 The object for the entry as JSON-LD.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The identity to create the auditable item stream operation with.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use for vault operations.
 
@@ -385,25 +485,33 @@ Nothing.
 
 ### removeEntry()
 
-> **removeEntry**(`id`, `entryId`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+> **removeEntry**(`streamId`, `entryId`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
 
 Delete from the stream.
 
 #### Parameters
 
-• **id**: `string`
+##### streamId
 
-The id of the stream to update.
+`string`
+
+The id of the stream to remove from.
+
+##### entryId
 
-• **entryId**: `string`
+`string`
 
-The id of the entry to delete.
+The id of the entry to remove.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The identity to create the auditable item stream operation with.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use for vault operations.
 
@@ -421,41 +529,55 @@ Nothing.
 
 ### getEntries()
 
-> **getEntries**(`id`, `options`?): `Promise`\<`IAuditableItemStreamEntryList`\>
+> **getEntries**(`streamId`, `options?`): `Promise`\<`IAuditableItemStreamEntryList`\>
 
 Get the entries for the stream.
 
 #### Parameters
 
-• **id**: `string`
+##### streamId
+
+`string`
 
 The id of the stream to get.
 
-• **options?**
+##### options?
 
 Additional options for the get operation.
 
-• **options.conditions?**: `IComparator`[]
+###### conditions?
+
+`IComparator`[]
 
 The conditions to filter the stream.
 
-• **options.includeDeleted?**: `boolean`
+###### includeDeleted?
+
+`boolean`
 
 Whether to include deleted entries, defaults to false.
 
-• **options.verifyEntries?**: `boolean`
+###### verifyEntries?
+
+`boolean`
 
 Should the entries be verified, defaults to false.
 
-• **options.pageSize?**: `number`
+###### pageSize?
+
+`number`
 
 How many entries to return.
 
-• **options.cursor?**: `string`
+###### cursor?
+
+`string`
 
 Cursor to use for next chunk of data.
 
-• **options.order?**: `SortDirection`
+###### order?
+
+`SortDirection`
 
 Retrieve the entries in ascending/descending time order, defaults to Ascending.
 
@@ -477,37 +599,49 @@ NotFoundError if the stream is not found.
 
 ### getEntryObjects()
 
-> **getEntryObjects**(`id`, `options`?): `Promise`\<`IAuditableItemStreamEntryObjectList`\>
+> **getEntryObjects**(`streamId`, `options?`): `Promise`\<`IAuditableItemStreamEntryObjectList`\>
 
 Get the entry objects for the stream.
 
 #### Parameters
 
-• **id**: `string`
+##### streamId
+
+`string`
 
 The id of the stream to get.
 
-• **options?**
+##### options?
 
 Additional options for the get operation.
 
-• **options.conditions?**: `IComparator`[]
+###### conditions?
+
+`IComparator`[]
 
 The conditions to filter the stream.
 
-• **options.includeDeleted?**: `boolean`
+###### includeDeleted?
+
+`boolean`
 
 Whether to include deleted entries, defaults to false.
 
-• **options.pageSize?**: `number`
+###### pageSize?
+
+`number`
 
 How many entries to return.
 
-• **options.cursor?**: `string`
+###### cursor?
+
+`string`
 
 Cursor to use for next chunk of data.
 
-• **options.order?**: `SortDirection`
+###### order?
+
+`SortDirection`
 
 Retrieve the entries in ascending/descending time order, defaults to Ascending.
 
@@ -527,19 +661,23 @@ NotFoundError if the stream is not found.
 
 ***
 
-### removeImmutable()
+### removeVerifiable()
 
-> **removeImmutable**(`id`, `nodeIdentity`?): `Promise`\<`void`\>
+> **removeVerifiable**(`streamId`, `nodeIdentity?`): `Promise`\<`void`\>
 
-Remove the immutable storage for the stream and entries.
+Remove the verifiable storage for the stream and entries.
 
 #### Parameters
 
-• **id**: `string`
+##### streamId
+
+`string`
 
 The id of the stream to remove the storage from.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use for vault operations.
 
@@ -555,4 +693,4 @@ NotFoundError if the vertex is not found.
 
 #### Implementation of
 
-`IAuditableItemStreamComponent.removeImmutable`
+`IAuditableItemStreamComponent.removeVerifiable`

package/docs/reference/functions/auditableItemStreamCreate.md

@@ -6,15 +6,21 @@ Create the stream.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `IAuditableItemStreamCreateRequest`
+### request
+
+`IAuditableItemStreamCreateRequest`
 
 The request.