@twin.org/logging-models 0.0.1-next.9 → 0.0.2-next.1

package/dist/cjs/index.cjs

@@ -65,23 +65,19 @@ class MultiLoggingConnector {
      * @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.
-     * @throws NotImplementedError if the implementation does not support retrieval.
      */
     async query(conditions, sortProperties, properties, cursor, pageSize) {
         // See if we can find a connector that supports querying.
         // If it throws anything other than not implemented, we should throw it.
         for (const loggingConnector of this._loggingConnectors) {
-            try {
-                const result = await loggingConnector.query(conditions, sortProperties, properties, cursor, pageSize);
-                return result;
-            }
-            catch (error) {
-                if (!core.BaseError.isErrorName(error, core.NotImplementedError.CLASS_NAME)) {
-                    throw error;
-                }
+            // eslint-disable-next-line @typescript-eslint/unbound-method
+            if (core.Is.function(loggingConnector.query)) {
+                return loggingConnector.query(conditions, sortProperties, properties, cursor, pageSize);
             }
         }
-        throw new core.NotImplementedError(this.CLASS_NAME, "query");
+        return {
+            entities: []
+        };
     }
 }
 
@@ -112,7 +108,6 @@ class SilentLoggingConnector {
      * @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.
-     * @throws NotImplementedError if the implementation does not support retrieval.
      */
     async query(conditions, sortProperties, properties, cursor, pageSize) {
         return {

package/dist/esm/index.mjs

@@ -1,4 +1,4 @@
-import { Factory, Guards, BaseError, NotImplementedError, Is, StringHelper, I18n } from '@twin.org/core';
+import { Factory, Guards, Is, StringHelper, I18n } from '@twin.org/core';
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -63,23 +63,19 @@ class MultiLoggingConnector {
      * @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.
-     * @throws NotImplementedError if the implementation does not support retrieval.
      */
     async query(conditions, sortProperties, properties, cursor, pageSize) {
         // See if we can find a connector that supports querying.
         // If it throws anything other than not implemented, we should throw it.
         for (const loggingConnector of this._loggingConnectors) {
-            try {
-                const result = await loggingConnector.query(conditions, sortProperties, properties, cursor, pageSize);
-                return result;
-            }
-            catch (error) {
-                if (!BaseError.isErrorName(error, NotImplementedError.CLASS_NAME)) {
-                    throw error;
-                }
+            // eslint-disable-next-line @typescript-eslint/unbound-method
+            if (Is.function(loggingConnector.query)) {
+                return loggingConnector.query(conditions, sortProperties, properties, cursor, pageSize);
             }
         }
-        throw new NotImplementedError(this.CLASS_NAME, "query");
+        return {
+            entities: []
+        };
     }
 }
 
@@ -110,7 +106,6 @@ class SilentLoggingConnector {
      * @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.
-     * @throws NotImplementedError if the implementation does not support retrieval.
      */
     async query(conditions, sortProperties, properties, cursor, pageSize) {
         return {

package/dist/types/connectors/multiLoggingConnector.d.ts

@@ -34,7 +34,6 @@ export declare class MultiLoggingConnector implements ILoggingConnector {
      * @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.
-     * @throws NotImplementedError if the implementation does not support retrieval.
      */
     query(conditions?: EntityCondition<ILogEntry>, sortProperties?: {
         property: keyof Omit<ILogEntry, "error" | "data">;

package/dist/types/connectors/silentLoggingConnector.d.ts

@@ -28,7 +28,6 @@ export declare class SilentLoggingConnector implements ILoggingConnector {
      * @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.
-     * @throws NotImplementedError if the implementation does not support retrieval.
      */
     query(conditions?: EntityCondition<ILogEntry>, sortProperties?: {
         property: keyof Omit<ILogEntry, "error" | "data">;

package/dist/types/models/ILoggingComponent.d.ts

@@ -21,7 +21,6 @@ export interface ILoggingComponent extends IComponent {
      * @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.
-     * @throws NotImplementedError if the implementation does not support retrieval.
      */
     query(level?: LogLevel, source?: string, timeStart?: number, timeEnd?: number, cursor?: string, pageSize?: number): Promise<{
         /**

package/dist/types/models/ILoggingConnector.d.ts

@@ -20,9 +20,8 @@ export interface ILoggingConnector extends IComponent {
      * @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.
-     * @throws NotImplementedError if the implementation does not support retrieval.
      */
-    query(conditions?: EntityCondition<ILogEntry>, sortProperties?: {
+    query?(conditions?: EntityCondition<ILogEntry>, sortProperties?: {
         property: keyof Omit<ILogEntry, "error" | "data">;
         sortDirection: SortDirection;
     }[], properties?: (keyof ILogEntry)[], cursor?: string, pageSize?: number): Promise<{

package/dist/types/models/api/ILoggingListRequest.d.ts

@@ -6,7 +6,7 @@ export interface ILoggingListRequest {
     /**
      * The query parameters.
      */
-    query: {
+    query?: {
         /**
          * The level of the log entries to retrieve.
          */
@@ -18,11 +18,11 @@ export interface ILoggingListRequest {
         /**
          * The start time of the metrics to retrieve as a timestamp in ms.
          */
-        timeStart?: number;
+        timeStart?: number | string;
         /**
          * The end time of the metrics to retrieve as a timestamp in ms.
          */
-        timeEnd?: number;
+        timeEnd?: number | string;
         /**
          * The optional cursor to get next chunk.
          */
@@ -30,6 +30,6 @@ export interface ILoggingListRequest {
         /**
          * The maximum number of entities in a page.
          */
-        pageSize?: number;
+        pageSize?: number | string;
     };
 }

package/docs/changelog.md

@@ -1,5 +1,54 @@
 # @twin.org/logging-models - Changelog
 
-## v0.0.1-next.9
+## [0.0.2-next.1](https://github.com/twinfoundation/logging/compare/logging-models-v0.0.2-next.0...logging-models-v0.0.2-next.1) (2025-08-19)
+
+
+### Features
+
+* 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))
+
+
+### Bug Fixes
+
+* query params force coercion ([71c5329](https://github.com/twinfoundation/logging/commit/71c53292d300acae0369bd7937c5ca3ab5430689))
+
+## 0.0.1 (2025-07-03)
+
+
+### Features
+
+* release to production ([3458161](https://github.com/twinfoundation/logging/commit/3458161b4bb530f86e4d1fe06123d885cdcb114d))
+
+## [0.0.1-next.16](https://github.com/twinfoundation/logging/compare/logging-models-v0.0.1-next.15...logging-models-v0.0.1-next.16) (2025-06-20)
+
+
+### Bug Fixes
+
+* query params force coercion ([71c5329](https://github.com/twinfoundation/logging/commit/71c53292d300acae0369bd7937c5ca3ab5430689))
+
+## [0.0.1-next.15](https://github.com/twinfoundation/logging/compare/logging-models-v0.0.1-next.14...logging-models-v0.0.1-next.15) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([976fc06](https://github.com/twinfoundation/logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
+
+## [0.0.1-next.14](https://github.com/twinfoundation/logging/compare/logging-models-v0.0.1-next.13...logging-models-v0.0.1-next.14) (2025-04-17)
+
+
+### Features
+
+* use shared store mechanism ([#20](https://github.com/twinfoundation/logging/issues/20)) ([bbacd31](https://github.com/twinfoundation/logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
+
+## [0.0.1-next.13](https://github.com/twinfoundation/logging/compare/logging-models-v0.0.1-next.12...logging-models-v0.0.1-next.13) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **logging-models:** Synchronize repo versions
+
+## v0.0.1-next.12
 
 - Initial Release

package/docs/reference/classes/LogEntryHelper.md

@@ -4,13 +4,13 @@ Helper class for log entry operations.
 
 ## Constructors
 
-### new LogEntryHelper()
+### Constructor
 
-> **new LogEntryHelper**(): [`LogEntryHelper`](LogEntryHelper.md)
+> **new LogEntryHelper**(): `LogEntryHelper`
 
 #### Returns
 
-[`LogEntryHelper`](LogEntryHelper.md)
+`LogEntryHelper`
 
 ## Methods
 

package/docs/reference/classes/MultiLoggingConnector.md

@@ -8,9 +8,9 @@ Class for performing logging operations on multiple connectors.
 
 ## Constructors
 
-### new MultiLoggingConnector()
+### Constructor
 
-> **new MultiLoggingConnector**(`options`): [`MultiLoggingConnector`](MultiLoggingConnector.md)
+> **new MultiLoggingConnector**(`options`): `MultiLoggingConnector`
 
 Create a new instance of MultiLoggingConnector.
 
@@ -24,7 +24,7 @@ The options for the connector.
 
 #### Returns
 
-[`MultiLoggingConnector`](MultiLoggingConnector.md)
+`MultiLoggingConnector`
 
 ## Properties
 
@@ -76,7 +76,7 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]; `cursor`: `string`; \}\>
+> **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]; `cursor?`: `string`; \}\>
 
 Query the log entries.
 
@@ -114,15 +114,11 @@ The maximum number of entities in a page.
 
 #### Returns
 
-`Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]; `cursor`: `string`; \}\>
+`Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]; `cursor?`: `string`; \}\>
 
 All the entities for the storage matching the conditions,
 and a cursor which can be used to request more entities.
 
-#### Throws
-
-NotImplementedError if the implementation does not support retrieval.
-
 #### Implementation of
 
 [`ILoggingConnector`](../interfaces/ILoggingConnector.md).[`query`](../interfaces/ILoggingConnector.md#query)

package/docs/reference/classes/SilentLoggingConnector.md

@@ -8,13 +8,13 @@ Class for performing logging operations to nowhere.
 
 ## Constructors
 
-### new SilentLoggingConnector()
+### Constructor
 
-> **new SilentLoggingConnector**(): [`SilentLoggingConnector`](SilentLoggingConnector.md)
+> **new SilentLoggingConnector**(): `SilentLoggingConnector`
 
 #### Returns
 
-[`SilentLoggingConnector`](SilentLoggingConnector.md)
+`SilentLoggingConnector`
 
 ## Properties
 
@@ -66,7 +66,7 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]; `cursor`: `string`; \}\>
+> **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]; `cursor?`: `string`; \}\>
 
 Query the log entries.
 
@@ -104,15 +104,11 @@ The maximum number of entities in a page.
 
 #### Returns
 
-`Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]; `cursor`: `string`; \}\>
+`Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]; `cursor?`: `string`; \}\>
 
 All the entities for the storage matching the conditions,
 and a cursor which can be used to request more entities.
 
-#### Throws
-
-NotImplementedError if the implementation does not support retrieval.
-
 #### Implementation of
 
 [`ILoggingConnector`](../interfaces/ILoggingConnector.md).[`query`](../interfaces/ILoggingConnector.md#query)

package/docs/reference/interfaces/ILoggingComponent.md

@@ -32,7 +32,7 @@ Nothing.
 
 ### query()
 
-> **query**(`level`?, `source`?, `timeStart`?, `timeEnd`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: [`ILogEntry`](ILogEntry.md)[]; `cursor`: `string`; \}\>
+> **query**(`level?`, `source?`, `timeStart?`, `timeEnd?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: [`ILogEntry`](ILogEntry.md)[]; `cursor?`: `string`; \}\>
 
 Query the log entries.
 
@@ -76,11 +76,7 @@ The maximum number of entities in a page.
 
 #### Returns
 
-`Promise`\<\{ `entities`: [`ILogEntry`](ILogEntry.md)[]; `cursor`: `string`; \}\>
+`Promise`\<\{ `entities`: [`ILogEntry`](ILogEntry.md)[]; `cursor?`: `string`; \}\>
 
 All the entities for the storage matching the conditions,
 and a cursor which can be used to request more entities.
-
-#### Throws
-
-NotImplementedError if the implementation does not support retrieval.

package/docs/reference/interfaces/ILoggingConnector.md

@@ -30,9 +30,9 @@ Nothing.
 
 ***
 
-### query()
+### query()?
 
-> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](ILogEntry.md)\>[]; `cursor`: `string`; \}\>
+> `optional` **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](ILogEntry.md)\>[]; `cursor?`: `string`; \}\>
 
 Query the log entries.
 
@@ -70,11 +70,7 @@ The maximum number of entities in a page.
 
 #### Returns
 
-`Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](ILogEntry.md)\>[]; `cursor`: `string`; \}\>
+`Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](ILogEntry.md)\>[]; `cursor?`: `string`; \}\>
 
 All the entities for the storage matching the conditions,
 and a cursor which can be used to request more entities.
-
-#### Throws
-
-NotImplementedError if the implementation does not support retrieval.

package/docs/reference/interfaces/ILoggingListRequest.md

@@ -4,9 +4,9 @@ Get the a list of the log entries.
 
 ## Properties
 
-### query
+### query?
 
-> **query**: `object`
+> `optional` **query**: `object`
 
 The query parameters.
 
@@ -24,13 +24,13 @@ The source of the log entries to retrieve.
 
 #### timeStart?
 
-> `optional` **timeStart**: `number`
+> `optional` **timeStart**: `string` \| `number`
 
 The start time of the metrics to retrieve as a timestamp in ms.
 
 #### timeEnd?
 
-> `optional` **timeEnd**: `number`
+> `optional` **timeEnd**: `string` \| `number`
 
 The end time of the metrics to retrieve as a timestamp in ms.
 
@@ -42,6 +42,6 @@ The optional cursor to get next chunk.
 
 #### pageSize?
 
-> `optional` **pageSize**: `number`
+> `optional` **pageSize**: `string` \| `number`
 
 The maximum number of entities in a page.

package/docs/reference/type-aliases/LogLevel.md

@@ -1,5 +1,5 @@
 # Type Alias: LogLevel
 
-> **LogLevel**: `"info"` \| `"error"` \| `"warn"` \| `"trace"` \| `"debug"`
+> **LogLevel** = `"info"` \| `"error"` \| `"warn"` \| `"trace"` \| `"debug"`
 
 Log level.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/logging-models",
-	"version": "0.0.1-next.9",
+	"version": "0.0.2-next.1",
 	"description": "Models which define the structure of the logging connectors and services",
 	"repository": {
 		"type": "git",