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

package/dist/cjs/index.cjs

@@ -24,18 +24,19 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
     }
     /**
      * Create a new stream.
-     * @param streamObject The object for the stream as JSON-LD.
-     * @param entries Entries to store in the stream.
+     * @param stream The stream to create.
+     * @param stream.annotationObject The object for the stream as JSON-LD.
+     * @param stream.entries Entries to store in the stream.
      * @param options Options for creating the stream.
      * @param options.immutableInterval After how many entries do we add immutable checks, defaults to service configured value.
-     * A value of 0 will disable immutable checks, 1 will be every item, or any other integer for an interval.
+     * A value of 0 will disable integrity checks, 1 will be every item, or any other integer for an interval.
      * @returns The id of the new stream item.
      */
-    async create(streamObject, entries, options) {
+    async create(stream, options) {
+        core.Guards.object(this.CLASS_NAME, "stream", stream);
         const response = await this.fetch("/", "POST", {
             body: {
-                streamObject,
-                entries,
+                ...stream,
                 immutableInterval: options?.immutableInterval
             }
         });
@@ -62,28 +63,44 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
                 id
             },
             query: {
-                includeEntries: options?.includeEntries,
-                includeDeleted: options?.includeDeleted,
-                verifyStream: options?.verifyStream,
-                verifyEntries: options?.verifyEntries
+                includeEntries: core.Coerce.string(options?.includeEntries),
+                includeDeleted: core.Coerce.string(options?.includeDeleted),
+                verifyStream: core.Coerce.string(options?.verifyStream),
+                verifyEntries: core.Coerce.string(options?.verifyEntries)
             }
         });
         return response.body;
     }
     /**
      * Update a stream.
-     * @param id The id of the stream to update.
-     * @param streamObject The object for the stream as JSON-LD.
+     * @param stream The stream to update.
+     * @param stream.id The id of the stream to update.
+     * @param stream.annotationObject The object for the stream as JSON-LD.
      * @returns Nothing.
      */
-    async update(id, streamObject) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+    async update(stream) {
+        core.Guards.object(this.CLASS_NAME, "stream", stream);
+        core.Guards.stringValue(this.CLASS_NAME, "stream.id", stream.id);
+        const { id, annotationObject } = stream;
         await this.fetch("/:id", "PUT", {
             pathParams: {
                 id
             },
             body: {
-                streamObject
+                annotationObject
+            }
+        });
+    }
+    /**
+     * Delete the stream.
+     * @param id The id of the stream to remove.
+     * @returns Nothing.
+     */
+    async remove(id) {
+        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        await this.fetch("/:id", "DELETE", {
+            pathParams: {
+                id
             }
         });
     }
@@ -103,12 +120,12 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
                 [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
             },
             query: {
-                conditions: apiModels.HttpParameterHelper.conditionsToString(conditions),
+                conditions: apiModels.HttpParameterHelper.objectToString(conditions),
                 orderBy,
                 orderByDirection,
                 properties: apiModels.HttpParameterHelper.arrayToString(properties),
                 cursor,
-                pageSize
+                pageSize: core.Coerce.string(pageSize)
             }
         });
         return response.body;
@@ -148,7 +165,7 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
                 [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
             },
             query: {
-                verifyEntry: options?.verifyEntry
+                verifyEntry: core.Coerce.string(options?.verifyEntry)
             },
             pathParams: {
                 id,
@@ -199,9 +216,9 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
         });
     }
     /**
-     * Delete from the stream.
-     * @param id The id of the stream to update.
-     * @param entryId The id of the entry to delete.
+     * Remove from the stream.
+     * @param id The id of the stream to remove from.
+     * @param entryId The id of the entry to remove.
      * @returns Nothing.
      */
     async removeEntry(id, entryId) {
@@ -237,10 +254,10 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
                 id
             },
             query: {
-                conditions: apiModels.HttpParameterHelper.conditionsToString(options?.conditions),
-                includeDeleted: options?.includeDeleted,
-                verifyEntries: options?.verifyEntries,
-                pageSize: options?.pageSize,
+                conditions: apiModels.HttpParameterHelper.objectToString(options?.conditions),
+                includeDeleted: core.Coerce.string(options?.includeDeleted),
+                verifyEntries: core.Coerce.string(options?.verifyEntries),
+                pageSize: core.Coerce.string(options?.pageSize),
                 cursor: options?.cursor,
                 order: options?.order
             }
@@ -269,25 +286,25 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
                 id
             },
             query: {
-                conditions: apiModels.HttpParameterHelper.conditionsToString(options?.conditions),
-                includeDeleted: options?.includeDeleted,
-                pageSize: options?.pageSize,
-                cursor: options?.cursor,
+                conditions: apiModels.HttpParameterHelper.objectToString(options?.conditions),
+                includeDeleted: core.Coerce.string(options?.includeDeleted),
+                pageSize: core.Coerce.string(options?.pageSize),
+                cursor: core.Coerce.string(options?.cursor),
                 order: options?.order
             }
         });
         return response.body;
     }
     /**
-     * Remove the immutable storage for the stream and entries.
+     * Remove the verifiable storage for the stream and entries.
      * @param id The id of the stream to remove the storage from.
      * @param nodeIdentity The node identity to use for vault operations.
      * @returns Nothing.
      * @throws NotFoundError if the vertex is not found.
      * @internal
      */
-    async removeImmutable(id, nodeIdentity) {
-        throw new core.NotSupportedError(this.CLASS_NAME, "removeImmutable");
+    async removeVerifiable(id, nodeIdentity) {
+        throw new core.NotSupportedError(this.CLASS_NAME, "removeVerifiable");
     }
 }
 

package/dist/esm/index.mjs

@@ -1,6 +1,6 @@
 import { BaseRestClient } from '@twin.org/api-core';
 import { HttpParameterHelper } from '@twin.org/api-models';
-import { Guards, NotSupportedError } from '@twin.org/core';
+import { Guards, Coerce, NotSupportedError } from '@twin.org/core';
 import { HeaderTypes, MimeTypes } from '@twin.org/web';
 
 // Copyright 2024 IOTA Stiftung.
@@ -22,18 +22,19 @@ class AuditableItemStreamClient extends BaseRestClient {
     }
     /**
      * Create a new stream.
-     * @param streamObject The object for the stream as JSON-LD.
-     * @param entries Entries to store in the stream.
+     * @param stream The stream to create.
+     * @param stream.annotationObject The object for the stream as JSON-LD.
+     * @param stream.entries Entries to store in the stream.
      * @param options Options for creating the stream.
      * @param options.immutableInterval After how many entries do we add immutable checks, defaults to service configured value.
-     * A value of 0 will disable immutable checks, 1 will be every item, or any other integer for an interval.
+     * A value of 0 will disable integrity checks, 1 will be every item, or any other integer for an interval.
      * @returns The id of the new stream item.
      */
-    async create(streamObject, entries, options) {
+    async create(stream, options) {
+        Guards.object(this.CLASS_NAME, "stream", stream);
         const response = await this.fetch("/", "POST", {
             body: {
-                streamObject,
-                entries,
+                ...stream,
                 immutableInterval: options?.immutableInterval
             }
         });
@@ -60,28 +61,44 @@ class AuditableItemStreamClient extends BaseRestClient {
                 id
             },
             query: {
-                includeEntries: options?.includeEntries,
-                includeDeleted: options?.includeDeleted,
-                verifyStream: options?.verifyStream,
-                verifyEntries: options?.verifyEntries
+                includeEntries: Coerce.string(options?.includeEntries),
+                includeDeleted: Coerce.string(options?.includeDeleted),
+                verifyStream: Coerce.string(options?.verifyStream),
+                verifyEntries: Coerce.string(options?.verifyEntries)
             }
         });
         return response.body;
     }
     /**
      * Update a stream.
-     * @param id The id of the stream to update.
-     * @param streamObject The object for the stream as JSON-LD.
+     * @param stream The stream to update.
+     * @param stream.id The id of the stream to update.
+     * @param stream.annotationObject The object for the stream as JSON-LD.
      * @returns Nothing.
      */
-    async update(id, streamObject) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+    async update(stream) {
+        Guards.object(this.CLASS_NAME, "stream", stream);
+        Guards.stringValue(this.CLASS_NAME, "stream.id", stream.id);
+        const { id, annotationObject } = stream;
         await this.fetch("/:id", "PUT", {
             pathParams: {
                 id
             },
             body: {
-                streamObject
+                annotationObject
+            }
+        });
+    }
+    /**
+     * Delete the stream.
+     * @param id The id of the stream to remove.
+     * @returns Nothing.
+     */
+    async remove(id) {
+        Guards.stringValue(this.CLASS_NAME, "id", id);
+        await this.fetch("/:id", "DELETE", {
+            pathParams: {
+                id
             }
         });
     }
@@ -101,12 +118,12 @@ class AuditableItemStreamClient extends BaseRestClient {
                 [HeaderTypes.Accept]: MimeTypes.JsonLd
             },
             query: {
-                conditions: HttpParameterHelper.conditionsToString(conditions),
+                conditions: HttpParameterHelper.objectToString(conditions),
                 orderBy,
                 orderByDirection,
                 properties: HttpParameterHelper.arrayToString(properties),
                 cursor,
-                pageSize
+                pageSize: Coerce.string(pageSize)
             }
         });
         return response.body;
@@ -146,7 +163,7 @@ class AuditableItemStreamClient extends BaseRestClient {
                 [HeaderTypes.Accept]: MimeTypes.JsonLd
             },
             query: {
-                verifyEntry: options?.verifyEntry
+                verifyEntry: Coerce.string(options?.verifyEntry)
             },
             pathParams: {
                 id,
@@ -197,9 +214,9 @@ class AuditableItemStreamClient extends BaseRestClient {
         });
     }
     /**
-     * Delete from the stream.
-     * @param id The id of the stream to update.
-     * @param entryId The id of the entry to delete.
+     * Remove from the stream.
+     * @param id The id of the stream to remove from.
+     * @param entryId The id of the entry to remove.
      * @returns Nothing.
      */
     async removeEntry(id, entryId) {
@@ -235,10 +252,10 @@ class AuditableItemStreamClient extends BaseRestClient {
                 id
             },
             query: {
-                conditions: HttpParameterHelper.conditionsToString(options?.conditions),
-                includeDeleted: options?.includeDeleted,
-                verifyEntries: options?.verifyEntries,
-                pageSize: options?.pageSize,
+                conditions: HttpParameterHelper.objectToString(options?.conditions),
+                includeDeleted: Coerce.string(options?.includeDeleted),
+                verifyEntries: Coerce.string(options?.verifyEntries),
+                pageSize: Coerce.string(options?.pageSize),
                 cursor: options?.cursor,
                 order: options?.order
             }
@@ -267,25 +284,25 @@ class AuditableItemStreamClient extends BaseRestClient {
                 id
             },
             query: {
-                conditions: HttpParameterHelper.conditionsToString(options?.conditions),
-                includeDeleted: options?.includeDeleted,
-                pageSize: options?.pageSize,
-                cursor: options?.cursor,
+                conditions: HttpParameterHelper.objectToString(options?.conditions),
+                includeDeleted: Coerce.string(options?.includeDeleted),
+                pageSize: Coerce.string(options?.pageSize),
+                cursor: Coerce.string(options?.cursor),
                 order: options?.order
             }
         });
         return response.body;
     }
     /**
-     * Remove the immutable storage for the stream and entries.
+     * Remove the verifiable storage for the stream and entries.
      * @param id The id of the stream to remove the storage from.
      * @param nodeIdentity The node identity to use for vault operations.
      * @returns Nothing.
      * @throws NotFoundError if the vertex is not found.
      * @internal
      */
-    async removeImmutable(id, nodeIdentity) {
-        throw new NotSupportedError(this.CLASS_NAME, "removeImmutable");
+    async removeVerifiable(id, nodeIdentity) {
+        throw new NotSupportedError(this.CLASS_NAME, "removeVerifiable");
     }
 }
 

package/dist/types/auditableItemStreamClient.d.ts

@@ -18,16 +18,20 @@ export declare class AuditableItemStreamClient extends BaseRestClient implements
     constructor(config: IBaseRestClientConfig);
     /**
      * Create a new stream.
-     * @param streamObject The object for the stream as JSON-LD.
-     * @param entries Entries to store in the stream.
+     * @param stream The stream to create.
+     * @param stream.annotationObject The object for the stream as JSON-LD.
+     * @param stream.entries Entries to store in the stream.
      * @param options Options for creating the stream.
      * @param options.immutableInterval After how many entries do we add immutable checks, defaults to service configured value.
-     * A value of 0 will disable immutable checks, 1 will be every item, or any other integer for an interval.
+     * A value of 0 will disable integrity checks, 1 will be every item, or any other integer for an interval.
      * @returns The id of the new stream item.
      */
-    create(streamObject?: IJsonLdNodeObject, entries?: {
-        entryObject: IJsonLdNodeObject;
-    }[], options?: {
+    create(stream: {
+        annotationObject?: IJsonLdNodeObject;
+        entries?: {
+            entryObject: IJsonLdNodeObject;
+        }[];
+    }, options?: {
         immutableInterval?: number;
     }): Promise<string>;
     /**
@@ -49,11 +53,21 @@ export declare class AuditableItemStreamClient extends BaseRestClient implements
     }): Promise<IAuditableItemStream>;
     /**
      * Update a stream.
-     * @param id The id of the stream to update.
-     * @param streamObject The object for the stream as JSON-LD.
+     * @param stream The stream to update.
+     * @param stream.id The id of the stream to update.
+     * @param stream.annotationObject The object for the stream as JSON-LD.
      * @returns Nothing.
      */
-    update(id: string, streamObject?: IJsonLdNodeObject): Promise<void>;
+    update(stream: {
+        id: string;
+        annotationObject?: IJsonLdNodeObject;
+    }): Promise<void>;
+    /**
+     * Delete the stream.
+     * @param id The id of the stream to remove.
+     * @returns Nothing.
+     */
+    remove(id: string): Promise<void>;
     /**
      * Query all the streams, will not return entries.
      * @param conditions Conditions to use in the query.
@@ -101,9 +115,9 @@ export declare class AuditableItemStreamClient extends BaseRestClient implements
      */
     updateEntry(id: string, entryId: string, entryObject: IJsonLdNodeObject): Promise<void>;
     /**
-     * Delete from the stream.
-     * @param id The id of the stream to update.
-     * @param entryId The id of the entry to delete.
+     * Remove from the stream.
+     * @param id The id of the stream to remove from.
+     * @param entryId The id of the entry to remove.
      * @returns Nothing.
      */
     removeEntry(id: string, entryId: string): Promise<void>;

package/docs/changelog.md

@@ -1,5 +1,194 @@
 # @twin.org/auditable-item-stream-rest-client - Changelog
 
-## v0.0.1-next.8
+## 0.0.1 (2025-07-09)
+
+
+### Features
+
+* release to production ([94d5757](https://github.com/twinfoundation/auditable-item-stream/commit/94d5757ff28b5462564f4ded56c8a3db781f2901))
+* update dependencies ([9ff038b](https://github.com/twinfoundation/auditable-item-stream/commit/9ff038b7e76e9fb586be4f2321231f04258ef794))
+* use shared store mechanism ([#7](https://github.com/twinfoundation/auditable-item-stream/issues/7)) ([2aca4b8](https://github.com/twinfoundation/auditable-item-stream/commit/2aca4b85b0102f91c90619f02b116541786cf539))
+
+
+### Bug Fixes
+
+* query params force coercion ([fcdd52c](https://github.com/twinfoundation/auditable-item-stream/commit/fcdd52cf8262a3bc19f6e7e9e6ef145890a9c8aa))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-stream-models bumped from ^0.0.0 to ^0.0.1
+
+## [0.0.1-next.37](https://github.com/twinfoundation/auditable-item-stream/compare/auditable-item-stream-rest-client-v0.0.1-next.36...auditable-item-stream-rest-client-v0.0.1-next.37) (2025-06-20)
+
+
+### Bug Fixes
+
+* query params force coercion ([fcdd52c](https://github.com/twinfoundation/auditable-item-stream/commit/fcdd52cf8262a3bc19f6e7e9e6ef145890a9c8aa))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-stream-models bumped from 0.0.1-next.36 to 0.0.1-next.37
+
+## [0.0.1-next.36](https://github.com/twinfoundation/auditable-item-stream/compare/auditable-item-stream-rest-client-v0.0.1-next.35...auditable-item-stream-rest-client-v0.0.1-next.36) (2025-06-18)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-stream-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-stream-models bumped from 0.0.1-next.35 to 0.0.1-next.36
+
+## [0.0.1-next.35](https://github.com/twinfoundation/auditable-item-stream/compare/auditable-item-stream-rest-client-v0.0.1-next.34...auditable-item-stream-rest-client-v0.0.1-next.35) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([9ff038b](https://github.com/twinfoundation/auditable-item-stream/commit/9ff038b7e76e9fb586be4f2321231f04258ef794))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-stream-models bumped from 0.0.1-next.34 to 0.0.1-next.35
+
+## [0.0.1-next.34](https://github.com/twinfoundation/auditable-item-stream/compare/auditable-item-stream-rest-client-v0.0.1-next.33...auditable-item-stream-rest-client-v0.0.1-next.34) (2025-06-03)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-stream-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-stream-models bumped from 0.0.1-next.33 to 0.0.1-next.34
+
+## [0.0.1-next.33](https://github.com/twinfoundation/auditable-item-stream/compare/auditable-item-stream-rest-client-v0.0.1-next.32...auditable-item-stream-rest-client-v0.0.1-next.33) (2025-05-28)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-stream-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-stream-models bumped from 0.0.1-next.32 to 0.0.1-next.33
+
+## [0.0.1-next.32](https://github.com/twinfoundation/auditable-item-stream/compare/auditable-item-stream-rest-client-v0.0.1-next.31...auditable-item-stream-rest-client-v0.0.1-next.32) (2025-05-08)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-stream-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-stream-models bumped from 0.0.1-next.31 to 0.0.1-next.32
+
+## [0.0.1-next.31](https://github.com/twinfoundation/auditable-item-stream/compare/auditable-item-stream-rest-client-v0.0.1-next.30...auditable-item-stream-rest-client-v0.0.1-next.31) (2025-04-25)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-stream-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-stream-models bumped from 0.0.1-next.30 to 0.0.1-next.31
+
+## [0.0.1-next.30](https://github.com/twinfoundation/auditable-item-stream/compare/auditable-item-stream-rest-client-v0.0.1-next.29...auditable-item-stream-rest-client-v0.0.1-next.30) (2025-04-25)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-stream-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-stream-models bumped from 0.0.1-next.29 to 0.0.1-next.30
+
+## [0.0.1-next.29](https://github.com/twinfoundation/auditable-item-stream/compare/auditable-item-stream-rest-client-v0.0.1-next.28...auditable-item-stream-rest-client-v0.0.1-next.29) (2025-04-25)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-stream-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-stream-models bumped from 0.0.1-next.28 to 0.0.1-next.29
+
+## [0.0.1-next.28](https://github.com/twinfoundation/auditable-item-stream/compare/auditable-item-stream-rest-client-v0.0.1-next.27...auditable-item-stream-rest-client-v0.0.1-next.28) (2025-04-17)
+
+
+### Features
+
+* use shared store mechanism ([#7](https://github.com/twinfoundation/auditable-item-stream/issues/7)) ([2aca4b8](https://github.com/twinfoundation/auditable-item-stream/commit/2aca4b85b0102f91c90619f02b116541786cf539))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-stream-models bumped from 0.0.1-next.27 to 0.0.1-next.28
+
+## [0.0.1-next.27](https://github.com/twinfoundation/auditable-item-stream/compare/auditable-item-stream-rest-client-v0.0.1-next.26...auditable-item-stream-rest-client-v0.0.1-next.27) (2025-04-11)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-stream-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-stream-models bumped from 0.0.1-next.26 to 0.0.1-next.27
+
+## [0.0.1-next.26](https://github.com/twinfoundation/auditable-item-stream/compare/auditable-item-stream-rest-client-v0.0.1-next.25...auditable-item-stream-rest-client-v0.0.1-next.26) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-stream-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-stream-models bumped from 0.0.1-next.25 to 0.0.1-next.26
+
+## v0.0.1-next.25
 
 - Initial Release

package/docs/reference/classes/AuditableItemStreamClient.md

@@ -12,21 +12,23 @@ Client for performing auditable item stream through to REST endpoints.
 
 ## Constructors
 
-### new AuditableItemStreamClient()
+### Constructor
 
-> **new AuditableItemStreamClient**(`config`): [`AuditableItemStreamClient`](AuditableItemStreamClient.md)
+> **new AuditableItemStreamClient**(`config`): `AuditableItemStreamClient`
 
 Create a new instance of AuditableItemStreamClient.
 
 #### Parameters
 
-• **config**: `IBaseRestClientConfig`
+##### config
+
+`IBaseRestClientConfig`
 
 The configuration for the client.
 
 #### Returns
 
-[`AuditableItemStreamClient`](AuditableItemStreamClient.md)
+`AuditableItemStreamClient`
 
 #### Overrides
 
@@ -48,28 +50,38 @@ Runtime name for the class.
 
 ### create()
 
-> **create**(`streamObject`?, `entries`?, `options`?): `Promise`\<`string`\>
+> **create**(`stream`, `options?`): `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 immutable checks, 1 will be every item, or any other integer for an interval.
+A value of 0 will disable integrity checks, 1 will be every item, or any other integer for an interval.
 
 #### Returns
 
@@ -85,33 +97,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.
 
@@ -133,17 +155,25 @@ NotFoundError if the stream is not found
 
 ### update()
 
-> **update**(`id`, `streamObject`?): `Promise`\<`void`\>
+> **update**(`stream`): `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.
 
@@ -159,35 +189,73 @@ Nothing.
 
 ***
 
+### remove()
+
+> **remove**(`id`): `Promise`\<`void`\>
+
+Delete the stream.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the stream to remove.
+
+#### 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.
 
@@ -211,11 +279,15 @@ Create an entry in the stream.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the stream to update.
 
-• **entryObject**: `IJsonLdNodeObject`
+##### entryObject
+
+`IJsonLdNodeObject`
 
 The object for the stream as JSON-LD.
 
@@ -233,25 +305,31 @@ The id of the created entry, if not provided.
 
 ### getEntry()
 
-> **getEntry**(`id`, `entryId`, `options`?): `Promise`\<`IAuditableItemStreamEntry`\>
+> **getEntry**(`id`, `entryId`, `options?`): `Promise`\<`IAuditableItemStreamEntry`\>
 
 Get the entry from the stream.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`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.
 
@@ -279,11 +357,15 @@ Get the entry object from the stream.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the stream to get.
 
-• **entryId**: `string`
+##### entryId
+
+`string`
 
 The id of the stream entry to get.
 
@@ -311,15 +393,21 @@ Update an entry in the stream.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`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.
 
@@ -339,17 +427,21 @@ Nothing.
 
 > **removeEntry**(`id`, `entryId`): `Promise`\<`void`\>
 
-Delete from the stream.
+Remove from the stream.
 
 #### Parameters
 
-• **id**: `string`
+##### id
 
-The id of the stream to update.
+`string`
+
+The id of the stream to remove from.
 
-• **entryId**: `string`
+##### entryId
 
-The id of the entry to delete.
+`string`
+
+The id of the entry to remove.
 
 #### Returns
 
@@ -365,41 +457,55 @@ Nothing.
 
 ### getEntries()
 
-> **getEntries**(`id`, `options`?): `Promise`\<`IAuditableItemStreamEntryList`\>
+> **getEntries**(`id`, `options?`): `Promise`\<`IAuditableItemStreamEntryList`\>
 
 Get the entries for the stream.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`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.
 
@@ -421,37 +527,49 @@ NotFoundError if the stream is not found.
 
 ### getEntryObjects()
 
-> **getEntryObjects**(`id`, `options`?): `Promise`\<`IAuditableItemStreamEntryObjectList`\>
+> **getEntryObjects**(`id`, `options?`): `Promise`\<`IAuditableItemStreamEntryObjectList`\>
 
 Get the entry objects for the stream.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`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.
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/auditable-item-stream-rest-client",
-	"version": "0.0.1-next.8",
+	"version": "0.0.1",
 	"description": "Auditable Item Stream contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -13,26 +13,56 @@
 	"engines": {
 		"node": ">=20.0.0"
 	},
+	"scripts": {
+		"clean": "rimraf dist coverage docs/reference",
+		"build": "tsc",
+		"dev": "nodemon --watch src --ext ts --exec \"npm run build && npm run bundle:esm\"",
+		"test": "vitest --run --config ./vitest.config.ts --no-cache",
+		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
+		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
+		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
+		"bundle": "npm run bundle:esm && npm run bundle:cjs",
+		"docs:clean": "rimraf docs/reference",
+		"docs:generate": "typedoc",
+		"docs": "npm run docs:clean && npm run docs:generate",
+		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs",
+		"dist:no-test": "npm run clean && npm run build && npm run bundle && npm run docs",
+		"prepare": "ts-patch install -s"
+	},
 	"dependencies": {
-		"@twin.org/api-core": "next",
-		"@twin.org/api-models": "next",
-		"@twin.org/auditable-item-stream-models": "0.0.1-next.8",
-		"@twin.org/core": "next",
-		"@twin.org/data-json-ld": "next",
-		"@twin.org/entity": "next",
-		"@twin.org/nameof": "next",
-		"@twin.org/web": "next"
+		"@twin.org/api-core": "^0.0.2-next.1",
+		"@twin.org/api-models": "^0.0.2-next.1",
+		"@twin.org/auditable-item-stream-models": "^0.0.1",
+		"@twin.org/core": "^0.0.1",
+		"@twin.org/data-json-ld": "^0.0.1",
+		"@twin.org/entity": "^0.0.1",
+		"@twin.org/nameof": "^0.0.1",
+		"@twin.org/web": "^0.0.1"
+	},
+	"devDependencies": {
+		"@twin.org/nameof-transformer": "^0.0.1",
+		"@twin.org/nameof-vitest-plugin": "^0.0.1",
+		"@vitest/coverage-v8": "3.2.3",
+		"copyfiles": "2.4.1",
+		"nodemon": "3.1.10",
+		"rimraf": "6.0.1",
+		"rollup": "4.43.0",
+		"ts-patch": "3.3.0",
+		"typedoc": "0.28.5",
+		"typedoc-plugin-markdown": "4.6.4",
+		"typescript": "5.8.3",
+		"vitest": "3.2.3"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
-		"./locales": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",