@twin.org/auditable-item-stream-rest-client 0.0.2-next.3 → 0.0.2-next.5

package/dist/cjs/index.cjs

@@ -10,17 +10,17 @@ var web = require('@twin.org/web');
 /**
  * Client for performing auditable item stream through to REST endpoints.
  */
-class AuditableItemStreamClient extends apiCore.BaseRestClient {
+class AuditableItemStreamRestClient extends apiCore.BaseRestClient {
     /**
      * Runtime name for the class.
      */
-    CLASS_NAME = "AuditableItemStreamClient";
+    static CLASS_NAME = "AuditableItemStreamRestClient";
     /**
-     * Create a new instance of AuditableItemStreamClient.
+     * Create a new instance of AuditableItemStreamRestClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super("AuditableItemStreamClient", config, "auditable-item-stream");
+        super("AuditableItemStreamRestClient", config, "auditable-item-stream");
     }
     /**
      * Create a new stream.
@@ -33,7 +33,7 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
      * @returns The id of the new stream item.
      */
     async create(stream, options) {
-        core.Guards.object(this.CLASS_NAME, "stream", stream);
+        core.Guards.object(AuditableItemStreamRestClient.CLASS_NAME, "stream", stream);
         const response = await this.fetch("/", "POST", {
             body: {
                 ...stream,
@@ -54,7 +54,7 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
      * @throws NotFoundError if the stream is not found
      */
     async get(id, options) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "id", id);
         const response = await this.fetch("/:id", "GET", {
             headers: {
                 [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
@@ -79,8 +79,8 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
      * @returns Nothing.
      */
     async update(stream) {
-        core.Guards.object(this.CLASS_NAME, "stream", stream);
-        core.Guards.stringValue(this.CLASS_NAME, "stream.id", stream.id);
+        core.Guards.object(AuditableItemStreamRestClient.CLASS_NAME, "stream", stream);
+        core.Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "stream.id", stream.id);
         const { id, annotationObject } = stream;
         await this.fetch("/:id", "PUT", {
             pathParams: {
@@ -97,7 +97,7 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
      * @returns Nothing.
      */
     async remove(id) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "id", id);
         await this.fetch("/:id", "DELETE", {
             pathParams: {
                 id
@@ -110,11 +110,11 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
      * @param orderBy The order for the results, defaults to created.
      * @param orderByDirection The direction for the order, defaults to descending.
      * @param properties The properties to return, if not provided defaults to id, created and object.
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The maximum number of entities in a page.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit Limit the number of entities to return.
      * @returns The entities, which can be partial if a limited keys list was provided.
      */
-    async query(conditions, orderBy, orderByDirection, properties, cursor, pageSize) {
+    async query(conditions, orderBy, orderByDirection, properties, cursor, limit) {
         const response = await this.fetch("/", "GET", {
             headers: {
                 [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
@@ -125,7 +125,7 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
                 orderByDirection,
                 properties: apiModels.HttpParameterHelper.arrayToString(properties),
                 cursor,
-                pageSize: core.Coerce.string(pageSize)
+                limit: core.Coerce.string(limit)
             }
         });
         return response.body;
@@ -137,7 +137,7 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
      * @returns The id of the created entry, if not provided.
      */
     async createEntry(id, entryObject) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "id", id);
         const response = await this.fetch("/:id", "POST", {
             pathParams: {
                 id
@@ -158,8 +158,8 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
      * @throws NotFoundError if the stream is not found.
      */
     async getEntry(id, entryId, options) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
-        core.Guards.stringValue(this.CLASS_NAME, "entryId", entryId);
+        core.Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "id", id);
+        core.Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "entryId", entryId);
         const response = await this.fetch("/:id/:entryId", "GET", {
             headers: {
                 [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
@@ -182,8 +182,8 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
      * @throws NotFoundError if the stream is not found.
      */
     async getEntryObject(id, entryId) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
-        core.Guards.stringValue(this.CLASS_NAME, "entryId", entryId);
+        core.Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "id", id);
+        core.Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "entryId", entryId);
         const response = await this.fetch("/:id/:entryId/object", "GET", {
             headers: {
                 [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
@@ -203,8 +203,8 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
      * @returns Nothing.
      */
     async updateEntry(id, entryId, entryObject) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
-        core.Guards.stringValue(this.CLASS_NAME, "entryId", entryId);
+        core.Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "id", id);
+        core.Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "entryId", entryId);
         await this.fetch("/:id/:entryId", "PUT", {
             pathParams: {
                 id,
@@ -222,8 +222,8 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
      * @returns Nothing.
      */
     async removeEntry(id, entryId) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
-        core.Guards.stringValue(this.CLASS_NAME, "entryId", entryId);
+        core.Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "id", id);
+        core.Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "entryId", entryId);
         await this.fetch("/:id/:entryId", "DELETE", {
             pathParams: {
                 id,
@@ -238,14 +238,14 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
      * @param options.conditions The conditions to filter the stream.
      * @param options.includeDeleted Whether to include deleted entries, defaults to false.
      * @param options.verifyEntries Should the entries be verified, defaults to false.
-     * @param options.pageSize How many entries to return.
+     * @param options.limit How many entries to return.
      * @param options.cursor Cursor to use for next chunk of data.
      * @param options.order Retrieve the entries in ascending/descending time order, defaults to Ascending.
      * @returns The stream and entries if found.
      * @throws NotFoundError if the stream is not found.
      */
     async getEntries(id, options) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "id", id);
         const response = await this.fetch("/:id/entries", "GET", {
             headers: {
                 [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
@@ -257,7 +257,7 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
                 conditions: apiModels.HttpParameterHelper.objectToString(options?.conditions),
                 includeDeleted: core.Coerce.string(options?.includeDeleted),
                 verifyEntries: core.Coerce.string(options?.verifyEntries),
-                pageSize: core.Coerce.string(options?.pageSize),
+                limit: core.Coerce.string(options?.limit),
                 cursor: options?.cursor,
                 order: options?.order
             }
@@ -270,14 +270,14 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
      * @param options Additional options for the get operation.
      * @param options.conditions The conditions to filter the stream.
      * @param options.includeDeleted Whether to include deleted entries, defaults to false.
-     * @param options.pageSize How many entries to return.
+     * @param options.limit How many entries to return.
      * @param options.cursor Cursor to use for next chunk of data.
      * @param options.order Retrieve the entries in ascending/descending time order, defaults to Ascending.
      * @returns The stream and entries if found.
      * @throws NotFoundError if the stream is not found.
      */
     async getEntryObjects(id, options) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "id", id);
         const response = await this.fetch("/:id/entries/objects", "GET", {
             headers: {
                 [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
@@ -288,7 +288,7 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
             query: {
                 conditions: apiModels.HttpParameterHelper.objectToString(options?.conditions),
                 includeDeleted: core.Coerce.string(options?.includeDeleted),
-                pageSize: core.Coerce.string(options?.pageSize),
+                limit: core.Coerce.string(options?.limit),
                 cursor: core.Coerce.string(options?.cursor),
                 order: options?.order
             }
@@ -302,8 +302,10 @@ class AuditableItemStreamClient extends apiCore.BaseRestClient {
      * @throws NotFoundError if the vertex is not found.
      */
     async removeVerifiable(id) {
-        throw new core.NotSupportedError(this.CLASS_NAME, "removeVerifiable");
+        throw new core.NotSupportedError(AuditableItemStreamRestClient.CLASS_NAME, "notSupportedOnClient", {
+            methodName: "removeVerifiable"
+        });
     }
 }
 
-exports.AuditableItemStreamClient = AuditableItemStreamClient;
+exports.AuditableItemStreamRestClient = AuditableItemStreamRestClient;

package/dist/esm/index.mjs

@@ -8,17 +8,17 @@ import { HeaderTypes, MimeTypes } from '@twin.org/web';
 /**
  * Client for performing auditable item stream through to REST endpoints.
  */
-class AuditableItemStreamClient extends BaseRestClient {
+class AuditableItemStreamRestClient extends BaseRestClient {
     /**
      * Runtime name for the class.
      */
-    CLASS_NAME = "AuditableItemStreamClient";
+    static CLASS_NAME = "AuditableItemStreamRestClient";
     /**
-     * Create a new instance of AuditableItemStreamClient.
+     * Create a new instance of AuditableItemStreamRestClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super("AuditableItemStreamClient", config, "auditable-item-stream");
+        super("AuditableItemStreamRestClient", config, "auditable-item-stream");
     }
     /**
      * Create a new stream.
@@ -31,7 +31,7 @@ class AuditableItemStreamClient extends BaseRestClient {
      * @returns The id of the new stream item.
      */
     async create(stream, options) {
-        Guards.object(this.CLASS_NAME, "stream", stream);
+        Guards.object(AuditableItemStreamRestClient.CLASS_NAME, "stream", stream);
         const response = await this.fetch("/", "POST", {
             body: {
                 ...stream,
@@ -52,7 +52,7 @@ class AuditableItemStreamClient extends BaseRestClient {
      * @throws NotFoundError if the stream is not found
      */
     async get(id, options) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "id", id);
         const response = await this.fetch("/:id", "GET", {
             headers: {
                 [HeaderTypes.Accept]: MimeTypes.JsonLd
@@ -77,8 +77,8 @@ class AuditableItemStreamClient extends BaseRestClient {
      * @returns Nothing.
      */
     async update(stream) {
-        Guards.object(this.CLASS_NAME, "stream", stream);
-        Guards.stringValue(this.CLASS_NAME, "stream.id", stream.id);
+        Guards.object(AuditableItemStreamRestClient.CLASS_NAME, "stream", stream);
+        Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "stream.id", stream.id);
         const { id, annotationObject } = stream;
         await this.fetch("/:id", "PUT", {
             pathParams: {
@@ -95,7 +95,7 @@ class AuditableItemStreamClient extends BaseRestClient {
      * @returns Nothing.
      */
     async remove(id) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "id", id);
         await this.fetch("/:id", "DELETE", {
             pathParams: {
                 id
@@ -108,11 +108,11 @@ class AuditableItemStreamClient extends BaseRestClient {
      * @param orderBy The order for the results, defaults to created.
      * @param orderByDirection The direction for the order, defaults to descending.
      * @param properties The properties to return, if not provided defaults to id, created and object.
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The maximum number of entities in a page.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit Limit the number of entities to return.
      * @returns The entities, which can be partial if a limited keys list was provided.
      */
-    async query(conditions, orderBy, orderByDirection, properties, cursor, pageSize) {
+    async query(conditions, orderBy, orderByDirection, properties, cursor, limit) {
         const response = await this.fetch("/", "GET", {
             headers: {
                 [HeaderTypes.Accept]: MimeTypes.JsonLd
@@ -123,7 +123,7 @@ class AuditableItemStreamClient extends BaseRestClient {
                 orderByDirection,
                 properties: HttpParameterHelper.arrayToString(properties),
                 cursor,
-                pageSize: Coerce.string(pageSize)
+                limit: Coerce.string(limit)
             }
         });
         return response.body;
@@ -135,7 +135,7 @@ class AuditableItemStreamClient extends BaseRestClient {
      * @returns The id of the created entry, if not provided.
      */
     async createEntry(id, entryObject) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "id", id);
         const response = await this.fetch("/:id", "POST", {
             pathParams: {
                 id
@@ -156,8 +156,8 @@ class AuditableItemStreamClient extends BaseRestClient {
      * @throws NotFoundError if the stream is not found.
      */
     async getEntry(id, entryId, options) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
-        Guards.stringValue(this.CLASS_NAME, "entryId", entryId);
+        Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "id", id);
+        Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "entryId", entryId);
         const response = await this.fetch("/:id/:entryId", "GET", {
             headers: {
                 [HeaderTypes.Accept]: MimeTypes.JsonLd
@@ -180,8 +180,8 @@ class AuditableItemStreamClient extends BaseRestClient {
      * @throws NotFoundError if the stream is not found.
      */
     async getEntryObject(id, entryId) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
-        Guards.stringValue(this.CLASS_NAME, "entryId", entryId);
+        Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "id", id);
+        Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "entryId", entryId);
         const response = await this.fetch("/:id/:entryId/object", "GET", {
             headers: {
                 [HeaderTypes.Accept]: MimeTypes.JsonLd
@@ -201,8 +201,8 @@ class AuditableItemStreamClient extends BaseRestClient {
      * @returns Nothing.
      */
     async updateEntry(id, entryId, entryObject) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
-        Guards.stringValue(this.CLASS_NAME, "entryId", entryId);
+        Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "id", id);
+        Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "entryId", entryId);
         await this.fetch("/:id/:entryId", "PUT", {
             pathParams: {
                 id,
@@ -220,8 +220,8 @@ class AuditableItemStreamClient extends BaseRestClient {
      * @returns Nothing.
      */
     async removeEntry(id, entryId) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
-        Guards.stringValue(this.CLASS_NAME, "entryId", entryId);
+        Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "id", id);
+        Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "entryId", entryId);
         await this.fetch("/:id/:entryId", "DELETE", {
             pathParams: {
                 id,
@@ -236,14 +236,14 @@ class AuditableItemStreamClient extends BaseRestClient {
      * @param options.conditions The conditions to filter the stream.
      * @param options.includeDeleted Whether to include deleted entries, defaults to false.
      * @param options.verifyEntries Should the entries be verified, defaults to false.
-     * @param options.pageSize How many entries to return.
+     * @param options.limit How many entries to return.
      * @param options.cursor Cursor to use for next chunk of data.
      * @param options.order Retrieve the entries in ascending/descending time order, defaults to Ascending.
      * @returns The stream and entries if found.
      * @throws NotFoundError if the stream is not found.
      */
     async getEntries(id, options) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "id", id);
         const response = await this.fetch("/:id/entries", "GET", {
             headers: {
                 [HeaderTypes.Accept]: MimeTypes.JsonLd
@@ -255,7 +255,7 @@ class AuditableItemStreamClient extends BaseRestClient {
                 conditions: HttpParameterHelper.objectToString(options?.conditions),
                 includeDeleted: Coerce.string(options?.includeDeleted),
                 verifyEntries: Coerce.string(options?.verifyEntries),
-                pageSize: Coerce.string(options?.pageSize),
+                limit: Coerce.string(options?.limit),
                 cursor: options?.cursor,
                 order: options?.order
             }
@@ -268,14 +268,14 @@ class AuditableItemStreamClient extends BaseRestClient {
      * @param options Additional options for the get operation.
      * @param options.conditions The conditions to filter the stream.
      * @param options.includeDeleted Whether to include deleted entries, defaults to false.
-     * @param options.pageSize How many entries to return.
+     * @param options.limit How many entries to return.
      * @param options.cursor Cursor to use for next chunk of data.
      * @param options.order Retrieve the entries in ascending/descending time order, defaults to Ascending.
      * @returns The stream and entries if found.
      * @throws NotFoundError if the stream is not found.
      */
     async getEntryObjects(id, options) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(AuditableItemStreamRestClient.CLASS_NAME, "id", id);
         const response = await this.fetch("/:id/entries/objects", "GET", {
             headers: {
                 [HeaderTypes.Accept]: MimeTypes.JsonLd
@@ -286,7 +286,7 @@ class AuditableItemStreamClient extends BaseRestClient {
             query: {
                 conditions: HttpParameterHelper.objectToString(options?.conditions),
                 includeDeleted: Coerce.string(options?.includeDeleted),
-                pageSize: Coerce.string(options?.pageSize),
+                limit: Coerce.string(options?.limit),
                 cursor: Coerce.string(options?.cursor),
                 order: options?.order
             }
@@ -300,8 +300,10 @@ class AuditableItemStreamClient extends BaseRestClient {
      * @throws NotFoundError if the vertex is not found.
      */
     async removeVerifiable(id) {
-        throw new NotSupportedError(this.CLASS_NAME, "removeVerifiable");
+        throw new NotSupportedError(AuditableItemStreamRestClient.CLASS_NAME, "notSupportedOnClient", {
+            methodName: "removeVerifiable"
+        });
     }
 }
 
-export { AuditableItemStreamClient };
+export { AuditableItemStreamRestClient };

package/dist/types/{auditableItemStreamClient.d.ts → auditableItemStreamRestClient.d.ts}

@@ -6,13 +6,13 @@ import type { IComparator, SortDirection } from "@twin.org/entity";
 /**
  * Client for performing auditable item stream through to REST endpoints.
  */
-export declare class AuditableItemStreamClient extends BaseRestClient implements IAuditableItemStreamComponent {
+export declare class AuditableItemStreamRestClient extends BaseRestClient implements IAuditableItemStreamComponent {
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
-     * Create a new instance of AuditableItemStreamClient.
+     * Create a new instance of AuditableItemStreamRestClient.
      * @param config The configuration for the client.
      */
     constructor(config: IBaseRestClientConfig);
@@ -74,11 +74,11 @@ export declare class AuditableItemStreamClient extends BaseRestClient implements
      * @param orderBy The order for the results, defaults to created.
      * @param orderByDirection The direction for the order, defaults to descending.
      * @param properties The properties to return, if not provided defaults to id, created and object.
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The maximum number of entities in a page.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit Limit the number of entities to return.
      * @returns The entities, which can be partial if a limited keys list was provided.
      */
-    query(conditions?: IComparator[], orderBy?: keyof Pick<IAuditableItemStream, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, properties?: (keyof IAuditableItemStream)[], cursor?: string, pageSize?: number): Promise<IAuditableItemStreamList>;
+    query(conditions?: IComparator[], orderBy?: keyof Pick<IAuditableItemStream, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, properties?: (keyof IAuditableItemStream)[], cursor?: string, limit?: number): Promise<IAuditableItemStreamList>;
     /**
      * Create an entry in the stream.
      * @param id The id of the stream to update.
@@ -128,7 +128,7 @@ export declare class AuditableItemStreamClient extends BaseRestClient implements
      * @param options.conditions The conditions to filter the stream.
      * @param options.includeDeleted Whether to include deleted entries, defaults to false.
      * @param options.verifyEntries Should the entries be verified, defaults to false.
-     * @param options.pageSize How many entries to return.
+     * @param options.limit How many entries to return.
      * @param options.cursor Cursor to use for next chunk of data.
      * @param options.order Retrieve the entries in ascending/descending time order, defaults to Ascending.
      * @returns The stream and entries if found.
@@ -138,7 +138,7 @@ export declare class AuditableItemStreamClient extends BaseRestClient implements
         conditions?: IComparator[];
         includeDeleted?: boolean;
         verifyEntries?: boolean;
-        pageSize?: number;
+        limit?: number;
         cursor?: string;
         order?: SortDirection;
     }): Promise<IAuditableItemStreamEntryList>;
@@ -148,7 +148,7 @@ export declare class AuditableItemStreamClient extends BaseRestClient implements
      * @param options Additional options for the get operation.
      * @param options.conditions The conditions to filter the stream.
      * @param options.includeDeleted Whether to include deleted entries, defaults to false.
-     * @param options.pageSize How many entries to return.
+     * @param options.limit How many entries to return.
      * @param options.cursor Cursor to use for next chunk of data.
      * @param options.order Retrieve the entries in ascending/descending time order, defaults to Ascending.
      * @returns The stream and entries if found.
@@ -157,7 +157,7 @@ export declare class AuditableItemStreamClient extends BaseRestClient implements
     getEntryObjects(id: string, options?: {
         conditions?: IComparator[];
         includeDeleted?: boolean;
-        pageSize?: number;
+        limit?: number;
         cursor?: string;
         order?: SortDirection;
     }): Promise<IAuditableItemStreamEntryObjectList>;

package/dist/types/index.d.ts

@@ -1 +1 @@
-export * from "./auditableItemStreamClient";
+export * from "./auditableItemStreamRestClient";

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/auditable-item-stream-rest-client - Changelog
 
+## [0.0.2-next.5](https://github.com/twinfoundation/auditable-item-stream/compare/auditable-item-stream-rest-client-v0.0.2-next.4...auditable-item-stream-rest-client-v0.0.2-next.5) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([4babc73](https://github.com/twinfoundation/auditable-item-stream/commit/4babc7331f7fed61450fe2e2d8eccee52367f2be))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-stream-models bumped from 0.0.2-next.4 to 0.0.2-next.5
+
+## [0.0.2-next.4](https://github.com/twinfoundation/auditable-item-stream/compare/auditable-item-stream-rest-client-v0.0.2-next.3...auditable-item-stream-rest-client-v0.0.2-next.4) (2025-09-29)
+
+
+### Features
+
+* use new nameof operators ([d1a3bf8](https://github.com/twinfoundation/auditable-item-stream/commit/d1a3bf8369f899fff8fd9d7b3b068f270fd8603d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-stream-models bumped from 0.0.2-next.3 to 0.0.2-next.4
+
 ## [0.0.2-next.3](https://github.com/twinfoundation/auditable-item-stream/compare/auditable-item-stream-rest-client-v0.0.2-next.2...auditable-item-stream-rest-client-v0.0.2-next.3) (2025-08-29)
 
 

package/docs/reference/classes/{AuditableItemStreamClient.md → AuditableItemStreamRestClient.md}

@@ -1,4 +1,4 @@
-# Class: AuditableItemStreamClient
+# Class: AuditableItemStreamRestClient
 
 Client for performing auditable item stream through to REST endpoints.
 
@@ -14,9 +14,9 @@ Client for performing auditable item stream through to REST endpoints.
 
 ### Constructor
 
-> **new AuditableItemStreamClient**(`config`): `AuditableItemStreamClient`
+> **new AuditableItemStreamRestClient**(`config`): `AuditableItemStreamRestClient`
 
-Create a new instance of AuditableItemStreamClient.
+Create a new instance of AuditableItemStreamRestClient.
 
 #### Parameters
 
@@ -28,7 +28,7 @@ The configuration for the client.
 
 #### Returns
 
-`AuditableItemStreamClient`
+`AuditableItemStreamRestClient`
 
 #### Overrides
 
@@ -38,14 +38,10 @@ The configuration for the client.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
-#### Implementation of
-
-`IAuditableItemStreamComponent.CLASS_NAME`
-
 ## Methods
 
 ### create()
@@ -217,7 +213,7 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<`IAuditableItemStreamList`\>
+> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `limit?`): `Promise`\<`IAuditableItemStreamList`\>
 
 Query all the streams, will not return entries.
 
@@ -251,13 +247,13 @@ The properties to return, if not provided defaults to id, created and object.
 
 `string`
 
-The cursor to request the next page of entities.
+The cursor to request the next chunk of entities.
 
-##### pageSize?
+##### limit?
 
 `number`
 
-The maximum number of entities in a page.
+Limit the number of entities to return.
 
 #### Returns
 
@@ -491,7 +487,7 @@ Whether to include deleted entries, defaults to false.
 
 Should the entries be verified, defaults to false.
 
-###### pageSize?
+###### limit?
 
 `number`
 
@@ -555,7 +551,7 @@ The conditions to filter the stream.
 
 Whether to include deleted entries, defaults to false.
 
-###### pageSize?
+###### limit?
 
 `number`
 

package/docs/reference/index.md

@@ -2,4 +2,4 @@
 
 ## Classes
 
-- [AuditableItemStreamClient](classes/AuditableItemStreamClient.md)
+- [AuditableItemStreamRestClient](classes/AuditableItemStreamRestClient.md)

package/locales/en.json

@@ -1 +1,7 @@
-{}
+{
+	"error": {
+		"auditableItemStreamRestClient": {
+			"notSupportedOnClient": "The method \"{methodName}\" is not supported on the REST client, it can only be used on a server side component"
+		}
+	}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/auditable-item-stream-rest-client",
-	"version": "0.0.2-next.3",
+	"version": "0.0.2-next.5",
 	"description": "Auditable Item Stream contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -16,7 +16,7 @@
 	"dependencies": {
 		"@twin.org/api-core": "next",
 		"@twin.org/api-models": "next",
-		"@twin.org/auditable-item-stream-models": "0.0.2-next.3",
+		"@twin.org/auditable-item-stream-models": "0.0.2-next.5",
 		"@twin.org/core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
@@ -40,5 +40,17 @@
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"auditable-item-stream"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/auditable-item-stream/issues"
+	},
+	"homepage": "https://twindev.org"
 }