@twin.org/logging-models 0.0.1-next.10 → 0.0.1-next.11

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/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/logging-models - Changelog
 
-## v0.0.1-next.10
+## v0.0.1-next.11
 
 - Initial Release

package/docs/reference/classes/MultiLoggingConnector.md

@@ -119,10 +119,6 @@ The maximum number of entities in a page.
 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

@@ -109,10 +109,6 @@ The maximum number of entities in a page.
 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

@@ -80,7 +80,3 @@ The maximum number of entities in a page.
 
 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.
 
@@ -74,7 +74,3 @@ The maximum number of entities in a page.
 
 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/package.json

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