@twin.org/logging-rest-client 0.0.2-next.2 → 0.0.2-next.3

package/dist/cjs/index.cjs

@@ -8,22 +8,17 @@ var core = require('@twin.org/core');
 /**
  * Client for performing logging through to REST endpoints.
  */
-class LoggingClient extends apiCore.BaseRestClient {
+class LoggingRestClient extends apiCore.BaseRestClient {
     /**
      * Runtime name for the class.
-     * @internal
      */
-    static _CLASS_NAME = "LoggingClient";
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = LoggingClient._CLASS_NAME;
+    static CLASS_NAME = "LoggingRestClient";
     /**
      * Create a new instance of LoggingClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super(LoggingClient._CLASS_NAME, config, "logging");
+        super(LoggingRestClient.CLASS_NAME, config, "logging");
     }
     /**
      * Log an entry to the connector.
@@ -31,7 +26,7 @@ class LoggingClient extends apiCore.BaseRestClient {
      * @returns Nothing.
      */
     async log(logEntry) {
-        core.Guards.object(this.CLASS_NAME, "logEntry", logEntry);
+        core.Guards.object(LoggingRestClient.CLASS_NAME, "logEntry", logEntry);
         await this.fetch("/", "POST", {
             body: logEntry
         });
@@ -42,12 +37,12 @@ class LoggingClient extends apiCore.BaseRestClient {
      * @param source The source of the log entries.
      * @param timeStart The inclusive time as the start of the log entries.
      * @param timeEnd The inclusive time as the end of the log entries.
-     * @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 All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      */
-    async query(level, source, timeStart, timeEnd, cursor, pageSize) {
+    async query(level, source, timeStart, timeEnd, cursor, limit) {
         const response = await this.fetch("/", "GET", {
             query: {
                 level,
@@ -55,11 +50,11 @@ class LoggingClient extends apiCore.BaseRestClient {
                 timeStart,
                 timeEnd,
                 cursor,
-                pageSize
+                limit: core.Coerce.string(limit)
             }
         });
         return response.body;
     }
 }
 
-exports.LoggingClient = LoggingClient;
+exports.LoggingRestClient = LoggingRestClient;

package/dist/esm/index.mjs

@@ -1,27 +1,22 @@
 import { BaseRestClient } from '@twin.org/api-core';
-import { Guards } from '@twin.org/core';
+import { Guards, Coerce } from '@twin.org/core';
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
  * Client for performing logging through to REST endpoints.
  */
-class LoggingClient extends BaseRestClient {
+class LoggingRestClient extends BaseRestClient {
     /**
      * Runtime name for the class.
-     * @internal
      */
-    static _CLASS_NAME = "LoggingClient";
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = LoggingClient._CLASS_NAME;
+    static CLASS_NAME = "LoggingRestClient";
     /**
      * Create a new instance of LoggingClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super(LoggingClient._CLASS_NAME, config, "logging");
+        super(LoggingRestClient.CLASS_NAME, config, "logging");
     }
     /**
      * Log an entry to the connector.
@@ -29,7 +24,7 @@ class LoggingClient extends BaseRestClient {
      * @returns Nothing.
      */
     async log(logEntry) {
-        Guards.object(this.CLASS_NAME, "logEntry", logEntry);
+        Guards.object(LoggingRestClient.CLASS_NAME, "logEntry", logEntry);
         await this.fetch("/", "POST", {
             body: logEntry
         });
@@ -40,12 +35,12 @@ class LoggingClient extends BaseRestClient {
      * @param source The source of the log entries.
      * @param timeStart The inclusive time as the start of the log entries.
      * @param timeEnd The inclusive time as the end of the log entries.
-     * @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 All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      */
-    async query(level, source, timeStart, timeEnd, cursor, pageSize) {
+    async query(level, source, timeStart, timeEnd, cursor, limit) {
         const response = await this.fetch("/", "GET", {
             query: {
                 level,
@@ -53,11 +48,11 @@ class LoggingClient extends BaseRestClient {
                 timeStart,
                 timeEnd,
                 cursor,
-                pageSize
+                limit: Coerce.string(limit)
             }
         });
         return response.body;
     }
 }
 
-export { LoggingClient };
+export { LoggingRestClient };

package/dist/types/index.d.ts

@@ -1 +1 @@
-export * from "./loggingClient";
+export * from "./loggingRestClient";

package/dist/types/{loggingClient.d.ts → loggingRestClient.d.ts}

@@ -4,11 +4,11 @@ import type { ILogEntry, ILoggingComponent, LogLevel } from "@twin.org/logging-m
 /**
  * Client for performing logging through to REST endpoints.
  */
-export declare class LoggingClient extends BaseRestClient implements ILoggingComponent {
+export declare class LoggingRestClient extends BaseRestClient implements ILoggingComponent {
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of LoggingClient.
      * @param config The configuration for the client.
@@ -26,12 +26,12 @@ export declare class LoggingClient extends BaseRestClient implements ILoggingCom
      * @param source The source of the log entries.
      * @param timeStart The inclusive time as the start of the log entries.
      * @param timeEnd The inclusive time as the end of the log entries.
-     * @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 All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      */
-    query(level?: LogLevel, source?: string, timeStart?: number, timeEnd?: number, cursor?: string, pageSize?: number): Promise<{
+    query(level?: LogLevel, source?: string, timeStart?: number, timeEnd?: number, cursor?: string, limit?: number): Promise<{
         /**
          * The entities, which can be partial if a limited keys list was provided.
          */

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # @twin.org/logging-rest-client - Changelog
 
+## [0.0.2-next.3](https://github.com/twinfoundation/logging/compare/logging-rest-client-v0.0.2-next.2...logging-rest-client-v0.0.2-next.3) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([df53f13](https://github.com/twinfoundation/logging/commit/df53f1331394f2f9333e91e4995a88dded90e484))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/logging-models bumped from 0.0.2-next.2 to 0.0.2-next.3
+
 ## [0.0.2-next.2](https://github.com/twinfoundation/logging/compare/logging-rest-client-v0.0.2-next.1...logging-rest-client-v0.0.2-next.2) (2025-08-29)
 
 

package/docs/reference/classes/{LoggingClient.md → LoggingRestClient.md}

@@ -1,4 +1,4 @@
-# Class: LoggingClient
+# Class: LoggingRestClient
 
 Client for performing logging through to REST endpoints.
 
@@ -14,7 +14,7 @@ Client for performing logging through to REST endpoints.
 
 ### Constructor
 
-> **new LoggingClient**(`config`): `LoggingClient`
+> **new LoggingRestClient**(`config`): `LoggingRestClient`
 
 Create a new instance of LoggingClient.
 
@@ -28,7 +28,7 @@ The configuration for the client.
 
 #### Returns
 
-`LoggingClient`
+`LoggingRestClient`
 
 #### Overrides
 
@@ -38,14 +38,10 @@ The configuration for the client.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string` = `LoggingClient._CLASS_NAME`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
-#### Implementation of
-
-`ILoggingComponent.CLASS_NAME`
-
 ## Methods
 
 ### log()
@@ -76,7 +72,7 @@ Nothing.
 
 ### query()
 
-> **query**(`level?`, `source?`, `timeStart?`, `timeEnd?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `ILogEntry`[]; `cursor?`: `string`; \}\>
+> **query**(`level?`, `source?`, `timeStart?`, `timeEnd?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `ILogEntry`[]; `cursor?`: `string`; \}\>
 
 Query the log entries.
 
@@ -110,13 +106,13 @@ The inclusive time as the end of the log entries.
 
 `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
 

package/docs/reference/index.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/logging-rest-client",
-	"version": "0.0.2-next.2",
+	"version": "0.0.2-next.3",
 	"description": "Logging contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -18,7 +18,7 @@
 		"@twin.org/api-models": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/logging-models": "0.0.2-next.2",
+		"@twin.org/logging-models": "0.0.2-next.3",
 		"@twin.org/nameof": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
@@ -38,5 +38,17 @@
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"logging"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/logging/issues"
+	},
+	"homepage": "https://twindev.org"
 }