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

package/dist/es/index.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./loggingRestClient.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,wBAAwB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./loggingRestClient.js\";\n"]}

package/dist/{cjs/index.cjs → es/loggingRestClient.js}

@@ -1,29 +1,28 @@
-'use strict';
-
-var apiCore = require('@twin.org/api-core');
-var core = require('@twin.org/core');
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
+import { BaseRestClient } from "@twin.org/api-core";
+import { Coerce, Guards } from "@twin.org/core";
 /**
  * Client for performing logging through to REST endpoints.
  */
-class LoggingClient extends apiCore.BaseRestClient {
+export class LoggingRestClient extends BaseRestClient {
     /**
      * Runtime name for the class.
-     * @internal
      */
-    static _CLASS_NAME = "LoggingClient";
+    static CLASS_NAME = "LoggingRestClient";
     /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = LoggingClient._CLASS_NAME;
-    /**
-     * Create a new instance of LoggingClient.
+     * Create a new instance of LoggingRestClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super(LoggingClient._CLASS_NAME, config, "logging");
+        super(LoggingRestClient.CLASS_NAME, config, "logging");
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return LoggingRestClient.CLASS_NAME;
     }
     /**
      * Log an entry to the connector.
@@ -31,7 +30,7 @@ class LoggingClient extends apiCore.BaseRestClient {
      * @returns Nothing.
      */
     async log(logEntry) {
-        core.Guards.object(this.CLASS_NAME, "logEntry", logEntry);
+        Guards.object(LoggingRestClient.CLASS_NAME, "logEntry", logEntry);
         await this.fetch("/", "POST", {
             body: logEntry
         });
@@ -42,12 +41,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 +54,10 @@ class LoggingClient extends apiCore.BaseRestClient {
                 timeStart,
                 timeEnd,
                 cursor,
-                pageSize
+                limit: Coerce.string(limit)
             }
         });
         return response.body;
     }
 }
-
-exports.LoggingClient = LoggingClient;
+//# sourceMappingURL=loggingRestClient.js.map

package/dist/es/loggingRestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loggingRestClient.js","sourceRoot":"","sources":["../../src/loggingRestClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAWhD;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,cAAc;IACpD;;OAEG;IACI,MAAM,CAAU,UAAU,uBAAuC;IAExE;;;OAGG;IACH,YAAY,MAA6B;QACxC,KAAK,CAAC,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,iBAAiB,CAAC,UAAU,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,GAAG,CAAC,QAAmB;QACnC,MAAM,CAAC,MAAM,CAAY,iBAAiB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAEnF,MAAM,IAAI,CAAC,KAAK,CAAqC,GAAG,EAAE,MAAM,EAAE;YACjE,IAAI,EAAE,QAAQ;SACd,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,KAAK,CACjB,KAAgB,EAChB,MAAe,EACf,SAAkB,EAClB,OAAgB,EAChB,MAAe,EACf,KAAc;QAWd,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAA4C,GAAG,EAAE,KAAK,EAAE;YACxF,KAAK,EAAE;gBACN,KAAK;gBACL,MAAM;gBACN,SAAS;gBACT,OAAO;gBACP,MAAM;gBACN,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;aAC3B;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseRestClient } from \"@twin.org/api-core\";\nimport type { IBaseRestClientConfig, IOkResponse } from \"@twin.org/api-models\";\nimport { Coerce, Guards } from \"@twin.org/core\";\nimport type {\n\tILogEntry,\n\tILoggingComponent,\n\tILoggingCreateRequest,\n\tILoggingListRequest,\n\tILoggingListResponse,\n\tLogLevel\n} from \"@twin.org/logging-models\";\nimport { nameof } from \"@twin.org/nameof\";\n\n/**\n * Client for performing logging through to REST endpoints.\n */\nexport class LoggingRestClient extends BaseRestClient implements ILoggingComponent {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<LoggingRestClient>();\n\n\t/**\n\t * Create a new instance of LoggingRestClient.\n\t * @param config The configuration for the client.\n\t */\n\tconstructor(config: IBaseRestClientConfig) {\n\t\tsuper(LoggingRestClient.CLASS_NAME, config, \"logging\");\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn LoggingRestClient.CLASS_NAME;\n\t}\n\n\t/**\n\t * Log an entry to the connector.\n\t * @param logEntry The entry to log.\n\t * @returns Nothing.\n\t */\n\tpublic async log(logEntry: ILogEntry): Promise<void> {\n\t\tGuards.object<ILogEntry>(LoggingRestClient.CLASS_NAME, nameof(logEntry), logEntry);\n\n\t\tawait this.fetch<ILoggingCreateRequest, IOkResponse>(\"/\", \"POST\", {\n\t\t\tbody: logEntry\n\t\t});\n\t}\n\n\t/**\n\t * Query the log entries.\n\t * @param level The level of the log entries.\n\t * @param source The source of the log entries.\n\t * @param timeStart The inclusive time as the start of the log entries.\n\t * @param timeEnd The inclusive time as the end of the log entries.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit Limit the number of entities to return.\n\t * @returns All the entities for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t */\n\tpublic async query(\n\t\tlevel?: LogLevel,\n\t\tsource?: string,\n\t\ttimeStart?: number,\n\t\ttimeEnd?: number,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The entities, which can be partial if a limited keys list was provided.\n\t\t */\n\t\tentities: ILogEntry[];\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t}> {\n\t\tconst response = await this.fetch<ILoggingListRequest, ILoggingListResponse>(\"/\", \"GET\", {\n\t\t\tquery: {\n\t\t\t\tlevel,\n\t\t\t\tsource,\n\t\t\t\ttimeStart,\n\t\t\t\ttimeEnd,\n\t\t\t\tcursor,\n\t\t\t\tlimit: Coerce.string(limit)\n\t\t\t}\n\t\t});\n\n\t\treturn response.body;\n\t}\n}\n"]}

package/dist/types/index.d.ts

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

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

@@ -4,16 +4,21 @@ 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.
+     * Create a new instance of LoggingRestClient.
      * @param config The configuration for the client.
      */
     constructor(config: IBaseRestClientConfig);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * Log an entry to the connector.
      * @param logEntry The entry to log.
@@ -26,12 +31,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,38 @@
 # @twin.org/logging-rest-client - Changelog
 
+## [0.0.3-next.1](https://github.com/twinfoundation/logging/compare/logging-rest-client-v0.0.3-next.0...logging-rest-client-v0.0.3-next.1) (2025-11-10)
+
+
+### Features
+
+* add context id features ([#33](https://github.com/twinfoundation/logging/issues/33)) ([38e982c](https://github.com/twinfoundation/logging/commit/38e982c9f009019fc02b67d919444b52657c9021))
+* add validate-locales ([df53f13](https://github.com/twinfoundation/logging/commit/df53f1331394f2f9333e91e4995a88dded90e484))
+* eslint migration to flat config ([1f9fdde](https://github.com/twinfoundation/logging/commit/1f9fddedfdcce9942afed431d9460a0f22092744))
+* update dependencies ([976fc06](https://github.com/twinfoundation/logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
+* update framework core ([aac823c](https://github.com/twinfoundation/logging/commit/aac823c2ead88843618b8a82b308d5a793411764))
+* use shared store mechanism ([#20](https://github.com/twinfoundation/logging/issues/20)) ([bbacd31](https://github.com/twinfoundation/logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/logging-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+
+## [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,9 +14,9 @@ Client for performing logging through to REST endpoints.
 
 ### Constructor
 
-> **new LoggingClient**(`config`): `LoggingClient`
+> **new LoggingRestClient**(`config`): `LoggingRestClient`
 
-Create a new instance of LoggingClient.
+Create a new instance of LoggingRestClient.
 
 #### Parameters
 
@@ -28,7 +28,7 @@ The configuration for the client.
 
 #### Returns
 
-`LoggingClient`
+`LoggingRestClient`
 
 #### Overrides
 
@@ -38,15 +38,29 @@ The configuration for the client.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string` = `LoggingClient._CLASS_NAME`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
 #### Implementation of
 
-`ILoggingComponent.CLASS_NAME`
+`ILoggingComponent.className`
 
-## Methods
+***
 
 ### log()
 
@@ -76,7 +90,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 +124,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.3-next.1",
 	"description": "Logging contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -18,25 +18,35 @@
 		"@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.3-next.1",
 		"@twin.org/nameof": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"logging"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/logging/issues"
+	},
+	"homepage": "https://twindev.org"
 }

package/dist/esm/index.mjs

@@ -1,63 +0,0 @@
-import { BaseRestClient } from '@twin.org/api-core';
-import { Guards } 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 {
-    /**
-     * Runtime name for the class.
-     * @internal
-     */
-    static _CLASS_NAME = "LoggingClient";
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = LoggingClient._CLASS_NAME;
-    /**
-     * Create a new instance of LoggingClient.
-     * @param config The configuration for the client.
-     */
-    constructor(config) {
-        super(LoggingClient._CLASS_NAME, config, "logging");
-    }
-    /**
-     * Log an entry to the connector.
-     * @param logEntry The entry to log.
-     * @returns Nothing.
-     */
-    async log(logEntry) {
-        Guards.object(this.CLASS_NAME, "logEntry", logEntry);
-        await this.fetch("/", "POST", {
-            body: logEntry
-        });
-    }
-    /**
-     * Query the log entries.
-     * @param level The level of the log entries.
-     * @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.
-     * @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) {
-        const response = await this.fetch("/", "GET", {
-            query: {
-                level,
-                source,
-                timeStart,
-                timeEnd,
-                cursor,
-                pageSize
-            }
-        });
-        return response.body;
-    }
-}
-
-export { LoggingClient };