@twin.org/entity-storage-connector-cosmosdb 0.0.1 → 0.0.2-next.10

package/README.md

@@ -15,7 +15,7 @@ The tests developed are functional tests and need an instance of CosmosDB up and
 To run a Docker image of Azure CosmosDB:
 
 ```sh
-docker run -d --platform=linux/amd64 -p 8081:8081 -p 10250:10250 -p 10251:10251 -p 10252:10252 -p 10253:10253 -p 10254:10254 -m 3g --name twin-entity-storage-cosmos -e AZURE_COSMOS_EMULATOR_PARTITION_COUNT=10 -e AZURE_COSMOS_EMULATOR_ENABLE_DATA_PERSISTENCE=true -e AZURE_COSMOS_EMULATOR_IP_ADDRESS_OVERRIDE='127.0.0.1' mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator
+docker run -d --platform=linux/amd64 -p 8081:8081 -m 3g --name twin-entity-storage-cosmos -e AZURE_COSMOS_EMULATOR_PARTITION_COUNT=10 -e AZURE_COSMOS_EMULATOR_ENABLE_DATA_PERSISTENCE=true -e AZURE_COSMOS_EMULATOR_IP_ADDRESS_OVERRIDE='127.0.0.1' mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator
 ```
 
 Or

package/dist/cjs/index.cjs

@@ -3,7 +3,6 @@
 var cosmos = require('@azure/cosmos');
 var core = require('@twin.org/core');
 var entity = require('@twin.org/entity');
-var loggingModels = require('@twin.org/logging-models');
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -11,11 +10,15 @@ var loggingModels = require('@twin.org/logging-models');
  * Class for performing entity storage operations using Cosmos DB.
  */
 class CosmosDbEntityStorageConnector {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "CosmosDbEntityStorageConnector";
     /**
      * Limit the number of entities when finding.
      * @internal
      */
-    static _PAGE_SIZE = 40;
+    static _DEFAULT_LIMIT = 40;
     /**
      * Partition id field name.
      * @internal
@@ -31,10 +34,6 @@ class CosmosDbEntityStorageConnector {
      * @internal
      */
     static _PARTITION_ID_VALUE = "1";
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "CosmosDbEntityStorageConnector";
     /**
      * The schema for the entity.
      * @internal
@@ -65,13 +64,13 @@ class CosmosDbEntityStorageConnector {
      * @param options The options for the connector.
      */
     constructor(options) {
-        core.Guards.object(this.CLASS_NAME, "options", options);
-        core.Guards.stringValue(this.CLASS_NAME, "options.entitySchema", options.entitySchema);
-        core.Guards.object(this.CLASS_NAME, "options.config", options.config);
-        core.Guards.stringValue(this.CLASS_NAME, "options.config.endpoint", options.config.endpoint);
-        core.Guards.stringValue(this.CLASS_NAME, "options.config.key", options.config.key);
-        core.Guards.stringValue(this.CLASS_NAME, "options.config.databaseId", options.config.databaseId);
-        core.Guards.stringValue(this.CLASS_NAME, "options.config.containerId", options.config.containerId);
+        core.Guards.object(CosmosDbEntityStorageConnector.CLASS_NAME, "options", options);
+        core.Guards.stringValue(CosmosDbEntityStorageConnector.CLASS_NAME, "options.entitySchema", options.entitySchema);
+        core.Guards.object(CosmosDbEntityStorageConnector.CLASS_NAME, "options.config", options.config);
+        core.Guards.stringValue(CosmosDbEntityStorageConnector.CLASS_NAME, "options.config.endpoint", options.config.endpoint);
+        core.Guards.stringValue(CosmosDbEntityStorageConnector.CLASS_NAME, "options.config.key", options.config.key);
+        core.Guards.stringValue(CosmosDbEntityStorageConnector.CLASS_NAME, "options.config.databaseId", options.config.databaseId);
+        core.Guards.stringValue(CosmosDbEntityStorageConnector.CLASS_NAME, "options.config.containerId", options.config.containerId);
         this._entitySchema = entity.EntitySchemaFactory.get(options.entitySchema);
         this._primaryKey = entity.EntitySchemaHelper.getPrimaryKey(this._entitySchema);
         this._config = options.config;
@@ -86,16 +85,16 @@ class CosmosDbEntityStorageConnector {
     }
     /**
      * Initialize the Cosmos DB environment.
-     * @param nodeLoggingConnectorType Optional type of the logging connector.
+     * @param nodeLoggingComponentType Optional type of the logging component.
      * @returns A promise that resolves to a boolean indicating success.
      */
-    async bootstrap(nodeLoggingConnectorType) {
-        const nodeLogging = loggingModels.LoggingConnectorFactory.getIfExists(nodeLoggingConnectorType ?? "node-logging");
+    async bootstrap(nodeLoggingComponentType) {
+        const nodeLogging = core.ComponentFactory.getIfExists(nodeLoggingComponentType);
         // Create the database if it does not exist
         try {
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: CosmosDbEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "databaseCreating",
                 data: {
@@ -105,10 +104,10 @@ class CosmosDbEntityStorageConnector {
             const { resource: databaseDefinition } = await this._client.databases.createIfNotExists({
                 id: this._config.databaseId
             });
-            core.Guards.stringValue(this.CLASS_NAME, "databaseDefinition.id", databaseDefinition?.id);
+            core.Guards.stringValue(CosmosDbEntityStorageConnector.CLASS_NAME, "databaseDefinition.id", databaseDefinition?.id);
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: CosmosDbEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "databaseExists",
                 data: {
@@ -120,28 +119,25 @@ class CosmosDbEntityStorageConnector {
             if (core.BaseError.isErrorCode(error, "Conflict")) {
                 await nodeLogging?.log({
                     level: "info",
-                    source: this.CLASS_NAME,
+                    source: CosmosDbEntityStorageConnector.CLASS_NAME,
                     ts: Date.now(),
-                    message: "databaseAlreadyExists",
+                    message: "databaseExists",
                     data: {
                         databaseId: this._config.databaseId
                     }
                 });
             }
             else {
-                const errors = error instanceof AggregateError ? error.errors : [error];
-                for (const err of errors) {
-                    await nodeLogging?.log({
-                        level: "error",
-                        source: this.CLASS_NAME,
-                        ts: Date.now(),
-                        message: "databaseCreateFailed",
-                        error: core.BaseError.fromError(err),
-                        data: {
-                            databaseId: this._config.databaseId
-                        }
-                    });
-                }
+                await nodeLogging?.log({
+                    level: "error",
+                    source: CosmosDbEntityStorageConnector.CLASS_NAME,
+                    ts: Date.now(),
+                    message: "databaseCreateFailed",
+                    error: core.BaseError.fromError(error),
+                    data: {
+                        databaseId: this._config.databaseId
+                    }
+                });
                 return false;
             }
         }
@@ -159,7 +155,7 @@ class CosmosDbEntityStorageConnector {
             if (containerDefinition) {
                 await nodeLogging?.log({
                     level: "info",
-                    source: this.CLASS_NAME,
+                    source: CosmosDbEntityStorageConnector.CLASS_NAME,
                     ts: Date.now(),
                     message: "containerExists",
                     data: {
@@ -170,7 +166,7 @@ class CosmosDbEntityStorageConnector {
             else {
                 await nodeLogging?.log({
                     level: "error",
-                    source: this.CLASS_NAME,
+                    source: CosmosDbEntityStorageConnector.CLASS_NAME,
                     ts: Date.now(),
                     message: "containerNotExisting",
                     data: {
@@ -183,7 +179,7 @@ class CosmosDbEntityStorageConnector {
         catch (error) {
             await nodeLogging?.log({
                 level: "error",
-                source: this.CLASS_NAME,
+                source: CosmosDbEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "containerCreateFailed",
                 error: core.BaseError.fromError(error),
@@ -210,7 +206,7 @@ class CosmosDbEntityStorageConnector {
      * @returns The object if it can be found or undefined.
      */
     async get(id, secondaryIndex, conditions) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(CosmosDbEntityStorageConnector.CLASS_NAME, "id", id);
         try {
             // No secondary index or conditions
             if (core.Is.empty(secondaryIndex) && !core.Is.arrayValue(conditions)) {
@@ -234,7 +230,9 @@ class CosmosDbEntityStorageConnector {
             if (core.Is.arrayValue(conditions)) {
                 for (const c of conditions) {
                     const schemaProp = this._entitySchema.properties?.find(p => p.property === c.property);
-                    whereQuery.push(`c.${String(c.property)} = ${this.propertyToDbValue(c.value, schemaProp?.type)}`);
+                    whereQuery.push(
+                    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+                    `c.${String(c.property)} = ${this.propertyToDbValue(c.value, schemaProp?.type)}`);
                 }
             }
             const query = {
@@ -251,11 +249,11 @@ class CosmosDbEntityStorageConnector {
         }
         catch (err) {
             if (core.BaseError.isErrorCode(err, "NotFound")) {
-                throw new core.GeneralError(this.CLASS_NAME, "containerDoesNotExist", {
-                    container: this._config.containerId
+                throw new core.GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "containerDoesNotExist", {
+                    containerId: this._config.containerId
                 }, err);
             }
-            throw new core.GeneralError(this.CLASS_NAME, "getFailed", {
+            throw new core.GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "getFailed", {
                 id
             }, err);
         }
@@ -268,7 +266,7 @@ class CosmosDbEntityStorageConnector {
      * @returns The id of the entity.
      */
     async set(entity$1, conditions) {
-        core.Guards.object(this.CLASS_NAME, "entity", entity$1);
+        core.Guards.object(CosmosDbEntityStorageConnector.CLASS_NAME, "entity", entity$1);
         entity.EntitySchemaHelper.validateEntity(entity$1, this.getSchema());
         const id = entity$1[this._primaryKey.property];
         try {
@@ -286,12 +284,15 @@ class CosmosDbEntityStorageConnector {
             });
         }
         catch (err) {
-            if (core.BaseError.isErrorCode(err, "ResourceNotFoundException")) {
-                throw new core.GeneralError(this.CLASS_NAME, "containerDoesNotExist", {
-                    containerId: this._config.containerId
-                }, err);
+            if (core.BaseError.isAggregateError(err)) {
+                const errors = core.BaseError.fromAggregate(err);
+                if (core.BaseError.someErrorCode(errors, "ResourceNotFoundException")) {
+                    throw new core.GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "containerDoesNotExist", {
+                        containerId: this._config.containerId
+                    }, err);
+                }
             }
-            throw new core.GeneralError(this.CLASS_NAME, "setFailed", {
+            throw new core.GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "setFailed", {
                 id
             }, err);
         }
@@ -303,7 +304,7 @@ class CosmosDbEntityStorageConnector {
      * @returns Nothing.
      */
     async remove(id, conditions) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(CosmosDbEntityStorageConnector.CLASS_NAME, "id", id);
         try {
             const item = await this._container.item(id, CosmosDbEntityStorageConnector._PARTITION_ID_VALUE);
             const { resource: itemData } = await item.read();
@@ -320,7 +321,7 @@ class CosmosDbEntityStorageConnector {
                 err.body?.code === "NotFound") {
                 return;
             }
-            throw new core.GeneralError(this.CLASS_NAME, "removeFailed", {
+            throw new core.GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "removeFailed", {
                 id
             }, err);
         }
@@ -330,19 +331,19 @@ class CosmosDbEntityStorageConnector {
      * @param conditions The conditions to match for the entities.
      * @param sortProperties The optional sort order.
      * @param properties The optional properties to return, defaults to all.
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
      * @returns All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      */
-    async query(conditions, sortProperties, properties, cursor, pageSize) {
+    async query(conditions, sortProperties, properties, cursor, limit) {
         const sql = "";
         try {
-            const returnSize = pageSize ?? CosmosDbEntityStorageConnector._PAGE_SIZE;
+            const returnSize = limit ?? CosmosDbEntityStorageConnector._DEFAULT_LIMIT;
             let orderByClause = "";
             if (Array.isArray(sortProperties)) {
                 if (sortProperties.length > 1) {
-                    throw new core.GeneralError(this.CLASS_NAME, "sortSingle");
+                    throw new core.GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "sortSingle");
                 }
                 for (const sortProperty of sortProperties) {
                     const propertySchema = this._entitySchema.properties?.find(e => e.property === sortProperty.property);
@@ -350,7 +351,7 @@ class CosmosDbEntityStorageConnector {
                         (!propertySchema.isPrimary &&
                             !propertySchema.isSecondary &&
                             !propertySchema.sortDirection)) {
-                        throw new core.GeneralError(this.CLASS_NAME, "sortNotIndexed", {
+                        throw new core.GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "sortNotIndexed", {
                             property: sortProperty.property
                         });
                     }
@@ -382,7 +383,7 @@ class CosmosDbEntityStorageConnector {
             };
         }
         catch (err) {
-            throw new core.GeneralError(this.CLASS_NAME, "queryFailed", { sql }, err);
+            throw new core.GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "queryFailed", { sql }, err);
         }
     }
     /**
@@ -501,7 +502,7 @@ class CosmosDbEntityStorageConnector {
         else if (comparator.comparison === entity.ComparisonOperator.In) {
             return `c.${propName} IN ${attributeName}`;
         }
-        throw new core.GeneralError(this.CLASS_NAME, "comparisonNotSupported", {
+        throw new core.GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "comparisonNotSupported", {
             comparison: comparator.comparison
         });
     }
@@ -564,7 +565,9 @@ class CosmosDbEntityStorageConnector {
         else if (operator === entity.LogicalOperator.Or) {
             return "OR";
         }
-        throw new core.GeneralError(this.CLASS_NAME, "conditionalNotSupported", { operator });
+        throw new core.GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "conditionalNotSupported", {
+            operator
+        });
     }
     /**
      * Verify the conditions for the entity.

package/dist/esm/index.mjs

@@ -1,7 +1,6 @@
 import { CosmosClient, CosmosDbDiagnosticLevel, PartitionKeyKind } from '@azure/cosmos';
-import { Guards, BaseError, Is, GeneralError, Coerce, ObjectHelper } from '@twin.org/core';
+import { Guards, ComponentFactory, BaseError, Is, GeneralError, Coerce, ObjectHelper } from '@twin.org/core';
 import { EntitySchemaFactory, EntitySchemaHelper, SortDirection, ComparisonOperator, LogicalOperator } from '@twin.org/entity';
-import { LoggingConnectorFactory } from '@twin.org/logging-models';
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -9,11 +8,15 @@ import { LoggingConnectorFactory } from '@twin.org/logging-models';
  * Class for performing entity storage operations using Cosmos DB.
  */
 class CosmosDbEntityStorageConnector {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "CosmosDbEntityStorageConnector";
     /**
      * Limit the number of entities when finding.
      * @internal
      */
-    static _PAGE_SIZE = 40;
+    static _DEFAULT_LIMIT = 40;
     /**
      * Partition id field name.
      * @internal
@@ -29,10 +32,6 @@ class CosmosDbEntityStorageConnector {
      * @internal
      */
     static _PARTITION_ID_VALUE = "1";
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "CosmosDbEntityStorageConnector";
     /**
      * The schema for the entity.
      * @internal
@@ -63,13 +62,13 @@ class CosmosDbEntityStorageConnector {
      * @param options The options for the connector.
      */
     constructor(options) {
-        Guards.object(this.CLASS_NAME, "options", options);
-        Guards.stringValue(this.CLASS_NAME, "options.entitySchema", options.entitySchema);
-        Guards.object(this.CLASS_NAME, "options.config", options.config);
-        Guards.stringValue(this.CLASS_NAME, "options.config.endpoint", options.config.endpoint);
-        Guards.stringValue(this.CLASS_NAME, "options.config.key", options.config.key);
-        Guards.stringValue(this.CLASS_NAME, "options.config.databaseId", options.config.databaseId);
-        Guards.stringValue(this.CLASS_NAME, "options.config.containerId", options.config.containerId);
+        Guards.object(CosmosDbEntityStorageConnector.CLASS_NAME, "options", options);
+        Guards.stringValue(CosmosDbEntityStorageConnector.CLASS_NAME, "options.entitySchema", options.entitySchema);
+        Guards.object(CosmosDbEntityStorageConnector.CLASS_NAME, "options.config", options.config);
+        Guards.stringValue(CosmosDbEntityStorageConnector.CLASS_NAME, "options.config.endpoint", options.config.endpoint);
+        Guards.stringValue(CosmosDbEntityStorageConnector.CLASS_NAME, "options.config.key", options.config.key);
+        Guards.stringValue(CosmosDbEntityStorageConnector.CLASS_NAME, "options.config.databaseId", options.config.databaseId);
+        Guards.stringValue(CosmosDbEntityStorageConnector.CLASS_NAME, "options.config.containerId", options.config.containerId);
         this._entitySchema = EntitySchemaFactory.get(options.entitySchema);
         this._primaryKey = EntitySchemaHelper.getPrimaryKey(this._entitySchema);
         this._config = options.config;
@@ -84,16 +83,16 @@ class CosmosDbEntityStorageConnector {
     }
     /**
      * Initialize the Cosmos DB environment.
-     * @param nodeLoggingConnectorType Optional type of the logging connector.
+     * @param nodeLoggingComponentType Optional type of the logging component.
      * @returns A promise that resolves to a boolean indicating success.
      */
-    async bootstrap(nodeLoggingConnectorType) {
-        const nodeLogging = LoggingConnectorFactory.getIfExists(nodeLoggingConnectorType ?? "node-logging");
+    async bootstrap(nodeLoggingComponentType) {
+        const nodeLogging = ComponentFactory.getIfExists(nodeLoggingComponentType);
         // Create the database if it does not exist
         try {
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: CosmosDbEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "databaseCreating",
                 data: {
@@ -103,10 +102,10 @@ class CosmosDbEntityStorageConnector {
             const { resource: databaseDefinition } = await this._client.databases.createIfNotExists({
                 id: this._config.databaseId
             });
-            Guards.stringValue(this.CLASS_NAME, "databaseDefinition.id", databaseDefinition?.id);
+            Guards.stringValue(CosmosDbEntityStorageConnector.CLASS_NAME, "databaseDefinition.id", databaseDefinition?.id);
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: CosmosDbEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "databaseExists",
                 data: {
@@ -118,28 +117,25 @@ class CosmosDbEntityStorageConnector {
             if (BaseError.isErrorCode(error, "Conflict")) {
                 await nodeLogging?.log({
                     level: "info",
-                    source: this.CLASS_NAME,
+                    source: CosmosDbEntityStorageConnector.CLASS_NAME,
                     ts: Date.now(),
-                    message: "databaseAlreadyExists",
+                    message: "databaseExists",
                     data: {
                         databaseId: this._config.databaseId
                     }
                 });
             }
             else {
-                const errors = error instanceof AggregateError ? error.errors : [error];
-                for (const err of errors) {
-                    await nodeLogging?.log({
-                        level: "error",
-                        source: this.CLASS_NAME,
-                        ts: Date.now(),
-                        message: "databaseCreateFailed",
-                        error: BaseError.fromError(err),
-                        data: {
-                            databaseId: this._config.databaseId
-                        }
-                    });
-                }
+                await nodeLogging?.log({
+                    level: "error",
+                    source: CosmosDbEntityStorageConnector.CLASS_NAME,
+                    ts: Date.now(),
+                    message: "databaseCreateFailed",
+                    error: BaseError.fromError(error),
+                    data: {
+                        databaseId: this._config.databaseId
+                    }
+                });
                 return false;
             }
         }
@@ -157,7 +153,7 @@ class CosmosDbEntityStorageConnector {
             if (containerDefinition) {
                 await nodeLogging?.log({
                     level: "info",
-                    source: this.CLASS_NAME,
+                    source: CosmosDbEntityStorageConnector.CLASS_NAME,
                     ts: Date.now(),
                     message: "containerExists",
                     data: {
@@ -168,7 +164,7 @@ class CosmosDbEntityStorageConnector {
             else {
                 await nodeLogging?.log({
                     level: "error",
-                    source: this.CLASS_NAME,
+                    source: CosmosDbEntityStorageConnector.CLASS_NAME,
                     ts: Date.now(),
                     message: "containerNotExisting",
                     data: {
@@ -181,7 +177,7 @@ class CosmosDbEntityStorageConnector {
         catch (error) {
             await nodeLogging?.log({
                 level: "error",
-                source: this.CLASS_NAME,
+                source: CosmosDbEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "containerCreateFailed",
                 error: BaseError.fromError(error),
@@ -208,7 +204,7 @@ class CosmosDbEntityStorageConnector {
      * @returns The object if it can be found or undefined.
      */
     async get(id, secondaryIndex, conditions) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(CosmosDbEntityStorageConnector.CLASS_NAME, "id", id);
         try {
             // No secondary index or conditions
             if (Is.empty(secondaryIndex) && !Is.arrayValue(conditions)) {
@@ -232,7 +228,9 @@ class CosmosDbEntityStorageConnector {
             if (Is.arrayValue(conditions)) {
                 for (const c of conditions) {
                     const schemaProp = this._entitySchema.properties?.find(p => p.property === c.property);
-                    whereQuery.push(`c.${String(c.property)} = ${this.propertyToDbValue(c.value, schemaProp?.type)}`);
+                    whereQuery.push(
+                    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+                    `c.${String(c.property)} = ${this.propertyToDbValue(c.value, schemaProp?.type)}`);
                 }
             }
             const query = {
@@ -249,11 +247,11 @@ class CosmosDbEntityStorageConnector {
         }
         catch (err) {
             if (BaseError.isErrorCode(err, "NotFound")) {
-                throw new GeneralError(this.CLASS_NAME, "containerDoesNotExist", {
-                    container: this._config.containerId
+                throw new GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "containerDoesNotExist", {
+                    containerId: this._config.containerId
                 }, err);
             }
-            throw new GeneralError(this.CLASS_NAME, "getFailed", {
+            throw new GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "getFailed", {
                 id
             }, err);
         }
@@ -266,7 +264,7 @@ class CosmosDbEntityStorageConnector {
      * @returns The id of the entity.
      */
     async set(entity, conditions) {
-        Guards.object(this.CLASS_NAME, "entity", entity);
+        Guards.object(CosmosDbEntityStorageConnector.CLASS_NAME, "entity", entity);
         EntitySchemaHelper.validateEntity(entity, this.getSchema());
         const id = entity[this._primaryKey.property];
         try {
@@ -284,12 +282,15 @@ class CosmosDbEntityStorageConnector {
             });
         }
         catch (err) {
-            if (BaseError.isErrorCode(err, "ResourceNotFoundException")) {
-                throw new GeneralError(this.CLASS_NAME, "containerDoesNotExist", {
-                    containerId: this._config.containerId
-                }, err);
+            if (BaseError.isAggregateError(err)) {
+                const errors = BaseError.fromAggregate(err);
+                if (BaseError.someErrorCode(errors, "ResourceNotFoundException")) {
+                    throw new GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "containerDoesNotExist", {
+                        containerId: this._config.containerId
+                    }, err);
+                }
             }
-            throw new GeneralError(this.CLASS_NAME, "setFailed", {
+            throw new GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "setFailed", {
                 id
             }, err);
         }
@@ -301,7 +302,7 @@ class CosmosDbEntityStorageConnector {
      * @returns Nothing.
      */
     async remove(id, conditions) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(CosmosDbEntityStorageConnector.CLASS_NAME, "id", id);
         try {
             const item = await this._container.item(id, CosmosDbEntityStorageConnector._PARTITION_ID_VALUE);
             const { resource: itemData } = await item.read();
@@ -318,7 +319,7 @@ class CosmosDbEntityStorageConnector {
                 err.body?.code === "NotFound") {
                 return;
             }
-            throw new GeneralError(this.CLASS_NAME, "removeFailed", {
+            throw new GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "removeFailed", {
                 id
             }, err);
         }
@@ -328,19 +329,19 @@ class CosmosDbEntityStorageConnector {
      * @param conditions The conditions to match for the entities.
      * @param sortProperties The optional sort order.
      * @param properties The optional properties to return, defaults to all.
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
      * @returns All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      */
-    async query(conditions, sortProperties, properties, cursor, pageSize) {
+    async query(conditions, sortProperties, properties, cursor, limit) {
         const sql = "";
         try {
-            const returnSize = pageSize ?? CosmosDbEntityStorageConnector._PAGE_SIZE;
+            const returnSize = limit ?? CosmosDbEntityStorageConnector._DEFAULT_LIMIT;
             let orderByClause = "";
             if (Array.isArray(sortProperties)) {
                 if (sortProperties.length > 1) {
-                    throw new GeneralError(this.CLASS_NAME, "sortSingle");
+                    throw new GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "sortSingle");
                 }
                 for (const sortProperty of sortProperties) {
                     const propertySchema = this._entitySchema.properties?.find(e => e.property === sortProperty.property);
@@ -348,7 +349,7 @@ class CosmosDbEntityStorageConnector {
                         (!propertySchema.isPrimary &&
                             !propertySchema.isSecondary &&
                             !propertySchema.sortDirection)) {
-                        throw new GeneralError(this.CLASS_NAME, "sortNotIndexed", {
+                        throw new GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "sortNotIndexed", {
                             property: sortProperty.property
                         });
                     }
@@ -380,7 +381,7 @@ class CosmosDbEntityStorageConnector {
             };
         }
         catch (err) {
-            throw new GeneralError(this.CLASS_NAME, "queryFailed", { sql }, err);
+            throw new GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "queryFailed", { sql }, err);
         }
     }
     /**
@@ -499,7 +500,7 @@ class CosmosDbEntityStorageConnector {
         else if (comparator.comparison === ComparisonOperator.In) {
             return `c.${propName} IN ${attributeName}`;
         }
-        throw new GeneralError(this.CLASS_NAME, "comparisonNotSupported", {
+        throw new GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "comparisonNotSupported", {
             comparison: comparator.comparison
         });
     }
@@ -562,7 +563,9 @@ class CosmosDbEntityStorageConnector {
         else if (operator === LogicalOperator.Or) {
             return "OR";
         }
-        throw new GeneralError(this.CLASS_NAME, "conditionalNotSupported", { operator });
+        throw new GeneralError(CosmosDbEntityStorageConnector.CLASS_NAME, "conditionalNotSupported", {
+            operator
+        });
     }
     /**
      * Verify the conditions for the entity.

package/dist/types/cosmosDbEntityStorageConnector.d.ts

@@ -8,7 +8,7 @@ export declare class CosmosDbEntityStorageConnector<T = unknown> implements IEnt
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of CosmosDbEntityStorageConnector.
      * @param options The options for the connector.
@@ -16,10 +16,10 @@ export declare class CosmosDbEntityStorageConnector<T = unknown> implements IEnt
     constructor(options: ICosmosDbEntityStorageConnectorConstructorOptions);
     /**
      * Initialize the Cosmos DB environment.
-     * @param nodeLoggingConnectorType Optional type of the logging connector.
+     * @param nodeLoggingComponentType Optional type of the logging component.
      * @returns A promise that resolves to a boolean indicating success.
      */
-    bootstrap(nodeLoggingConnectorType?: string): Promise<boolean>;
+    bootstrap(nodeLoggingComponentType?: string): Promise<boolean>;
     /**
      * Get the schema for the entities.
      * @returns The schema for the entities.
@@ -61,15 +61,15 @@ export declare class CosmosDbEntityStorageConnector<T = unknown> implements IEnt
      * @param conditions The conditions to match for the entities.
      * @param sortProperties The optional sort order.
      * @param properties The optional properties to return, defaults to all.
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
      * @returns All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      */
     query(conditions?: EntityCondition<T>, sortProperties?: {
         property: keyof T;
         sortDirection: SortDirection;
-    }[], properties?: (keyof T)[], cursor?: string, pageSize?: number): Promise<{
+    }[], properties?: (keyof T)[], cursor?: string, limit?: number): Promise<{
         entities: Partial<T>[];
         cursor?: string;
     }>;

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

@@ -8,10 +8,10 @@ export interface ICosmosDbEntityStorageConnectorConstructorOptions {
      */
     entitySchema: string;
     /**
-     * The type of logging connector to use.
+     * The type of logging component to use.
      * @default logging
      */
-    loggingConnectorType?: string;
+    loggingComponentType?: string;
     /**
      * The configuration for the connector.
      */

package/docs/changelog.md

@@ -1,5 +1,173 @@
 # @twin.org/entity-storage-connector-cosmosdb - Changelog
 
+## [0.0.2-next.10](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-cosmosdb-v0.0.2-next.9...entity-storage-connector-cosmosdb-v0.0.2-next.10) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([e66ef0d](https://github.com/twinfoundation/entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.2-next.9 to 0.0.2-next.10
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.9 to 0.0.2-next.10
+
+## [0.0.2-next.9](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-cosmosdb-v0.0.2-next.8...entity-storage-connector-cosmosdb-v0.0.2-next.9) (2025-10-02)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-cosmosdb:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.2-next.8 to 0.0.2-next.9
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.8 to 0.0.2-next.9
+
+## [0.0.2-next.8](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-cosmosdb-v0.0.2-next.7...entity-storage-connector-cosmosdb-v0.0.2-next.8) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([f033b64](https://github.com/twinfoundation/entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.2-next.7 to 0.0.2-next.8
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.7 to 0.0.2-next.8
+
+## [0.0.2-next.7](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-cosmosdb-v0.0.2-next.6...entity-storage-connector-cosmosdb-v0.0.2-next.7) (2025-08-20)
+
+
+### Features
+
+* logging naming consistency ([f99d12d](https://github.com/twinfoundation/entity-storage/commit/f99d12dea04b6d4f2b5632ff5473e9ec7d5f9055))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.2-next.6 to 0.0.2-next.7
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.6 to 0.0.2-next.7
+
+## [0.0.2-next.6](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-cosmosdb-v0.0.2-next.5...entity-storage-connector-cosmosdb-v0.0.2-next.6) (2025-08-19)
+
+
+### Features
+
+* update framework core ([b59a380](https://github.com/twinfoundation/entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.2-next.5 to 0.0.2-next.6
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.5 to 0.0.2-next.6
+
+## [0.0.2-next.5](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-cosmosdb-v0.0.2-next.4...entity-storage-connector-cosmosdb-v0.0.2-next.5) (2025-08-11)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-cosmosdb:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.2-next.4 to 0.0.2-next.5
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.4 to 0.0.2-next.5
+
+## [0.0.2-next.4](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-cosmosdb-v0.0.2-next.3...entity-storage-connector-cosmosdb-v0.0.2-next.4) (2025-08-08)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-cosmosdb:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.2-next.3 to 0.0.2-next.4
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.3 to 0.0.2-next.4
+
+## [0.0.2-next.3](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-cosmosdb-v0.0.2-next.2...entity-storage-connector-cosmosdb-v0.0.2-next.3) (2025-07-25)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-cosmosdb:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.2-next.2 to 0.0.2-next.3
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.2 to 0.0.2-next.3
+
+## [0.0.2-next.2](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-cosmosdb-v0.0.2-next.1...entity-storage-connector-cosmosdb-v0.0.2-next.2) (2025-07-24)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-cosmosdb:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.2-next.1 to 0.0.2-next.2
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.1 to 0.0.2-next.2
+
+## [0.0.2-next.1](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-cosmosdb-v0.0.2-next.0...entity-storage-connector-cosmosdb-v0.0.2-next.1) (2025-07-17)
+
+
+### Features
+
+* add production release automation ([1eb4c8e](https://github.com/twinfoundation/entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
+* CosmosDB Entity Storage Connector ([#20](https://github.com/twinfoundation/entity-storage/issues/20)) ([0ae8371](https://github.com/twinfoundation/entity-storage/commit/0ae8371d81ce7e20c0b0397144499dc3e17ffa0a))
+* update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
+* use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
+
+
+### Bug Fixes
+
+* query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.2-next.0 to 0.0.2-next.1
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.0 to 0.0.2-next.1
+
 ## 0.0.1 (2025-07-04)
 
 

package/docs/reference/classes/CosmosDbEntityStorageConnector.md

@@ -36,29 +36,25 @@ The options for the connector.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
-#### Implementation of
-
-`IEntityStorageConnector.CLASS_NAME`
-
 ## Methods
 
 ### bootstrap()
 
-> **bootstrap**(`nodeLoggingConnectorType?`): `Promise`\<`boolean`\>
+> **bootstrap**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
 
 Initialize the Cosmos DB environment.
 
 #### Parameters
 
-##### nodeLoggingConnectorType?
+##### nodeLoggingComponentType?
 
 `string`
 
-Optional type of the logging connector.
+Optional type of the logging component.
 
 #### Returns
 
@@ -194,7 +190,7 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
+> **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 
 Find all the entities which match the conditions.
 
@@ -222,9 +218,9 @@ The optional properties to return, defaults to all.
 
 `string`
 
-The cursor to request the next page of entities.
+The cursor to request the next chunk of entities.
 
-##### pageSize?
+##### limit?
 
 `number`
 

package/docs/reference/interfaces/ICosmosDbEntityStorageConnectorConstructorOptions.md

@@ -12,11 +12,11 @@ The schema for the entity.
 
 ***
 
-### loggingConnectorType?
+### loggingComponentType?
 
-> `optional` **loggingConnectorType**: `string`
+> `optional` **loggingComponentType**: `string`
 
-The type of logging connector to use.
+The type of logging component to use.
 
 #### Default
 

package/locales/en.json

@@ -1,9 +1,9 @@
 {
 	"info": {
 		"cosmosDbEntityStorageConnector": {
-			"databaseCreating": "Database \"{databaseName}\" creating",
-			"databaseExists": "Database \"{databaseName}\" created or it already exists",
-			"containerExists": "Container \"{containerName}\" created or it already exists"
+			"databaseCreating": "Database \"{databaseId}\" creating",
+			"databaseExists": "Database \"{databaseId}\" created or it already exists",
+			"containerExists": "Container \"{containerId}\" created or it already exists"
 		}
 	},
 	"error": {
@@ -17,7 +17,9 @@
 			"sortSingle": "You can only sort by a single property",
 			"sortNotIndexed": "The property \"{property}\" is not indexed and cannot be used for sorting",
 			"containerNotExisting": "The expected container definition is undefined",
-			"containerNotCreated": "The container couldn't be created"
+			"containerCreateFailed": "The container couldn't be created \"{containerId}\"",
+			"databaseCreateFailed": "Unable to create database \"{databaseId}\"",
+			"containerDoesNotExist": "Container \"{containerId}\" does not exist"
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-connector-cosmosdb",
-	"version": "0.0.1",
+	"version": "0.0.2-next.10",
 	"description": "Entity Storage connector implementation using CosmosDB storage",
 	"repository": {
 		"type": "git",
@@ -14,13 +14,13 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@azure/cosmos": "4.4.1",
-		"@azure/identity": "4.10.0",
-		"@twin.org/core": "^0.0.1",
-		"@twin.org/entity": "^0.0.1",
-		"@twin.org/entity-storage-models": "^0.0.1",
-		"@twin.org/logging-models": "^0.0.1",
-		"@twin.org/nameof": "^0.0.1"
+		"@azure/cosmos": "4.5.1",
+		"@azure/identity": "4.13.0",
+		"@twin.org/core": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/entity-storage-models": "0.0.2-next.10",
+		"@twin.org/logging-models": "next",
+		"@twin.org/nameof": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
@@ -39,5 +39,24 @@
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"entity-storage",
+		"entity",
+		"storage",
+		"persistence",
+		"database",
+		"connector",
+		"adapter",
+		"integration"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/entity-storage/issues"
+	},
+	"homepage": "https://twindev.org"
 }