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

package/README.md

@@ -13,7 +13,7 @@ npm install @twin.org/entity-storage-connector-gcp-firestore
 The tests developed are functional tests and need an instance of Firestore up and running. To run Firestore locally:
 
 ```sh
-docker run -d --name twin-entity-storage-firestore -p 8080:8080 gcr.io/google.com/cloudsdktool/cloud-sdk:emulators gcloud beta emulators firestore start --host-port=0.0.0.0:8080
+docker run -d --name twin-entity-storage-firestore -p 8580:8080 gcr.io/google.com/cloudsdktool/cloud-sdk:emulators gcloud beta emulators firestore start --host-port=0.0.0.0:8080
 ```
 
 Afterwards you can run the tests as follows:

package/dist/cjs/index.cjs

@@ -3,7 +3,6 @@
 var firestore = require('@google-cloud/firestore');
 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.
@@ -12,14 +11,14 @@ var loggingModels = require('@twin.org/logging-models');
  */
 class FirestoreEntityStorageConnector {
     /**
-     * Limit the number of entities when finding.
-     * @internal
+     * Runtime name for the class.
      */
-    static _PAGE_SIZE = 40;
+    static CLASS_NAME = "FirestoreEntityStorageConnector";
     /**
-     * Runtime name for the class.
+     * Limit the number of entities when finding.
+     * @internal
      */
-    CLASS_NAME = "FirestoreEntityStorageConnector";
+    static _DEFAULT_LIMIT = 40;
     /**
      * The schema for the entity.
      * @internal
@@ -50,14 +49,14 @@ class FirestoreEntityStorageConnector {
      * @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.projectId", options.config.projectId);
-        core.Guards.stringValue(this.CLASS_NAME, "options.config.collectionName", options.config.collectionName);
+        core.Guards.object(FirestoreEntityStorageConnector.CLASS_NAME, "options", options);
+        core.Guards.stringValue(FirestoreEntityStorageConnector.CLASS_NAME, "options.entitySchema", options.entitySchema);
+        core.Guards.object(FirestoreEntityStorageConnector.CLASS_NAME, "options.config", options.config);
+        core.Guards.stringValue(FirestoreEntityStorageConnector.CLASS_NAME, "options.config.projectId", options.config.projectId);
+        core.Guards.stringValue(FirestoreEntityStorageConnector.CLASS_NAME, "options.config.collectionName", options.config.collectionName);
         let credentials;
         if (!core.Is.empty(options.config.credentials)) {
-            core.Guards.stringBase64(this.CLASS_NAME, "options.config.credentials", options.config.credentials);
+            core.Guards.stringBase64(FirestoreEntityStorageConnector.CLASS_NAME, "options.config.credentials", options.config.credentials);
             credentials = core.ObjectHelper.fromBytes(core.Converter.base64ToBytes(options.config.credentials));
         }
         this._config = options.config;
@@ -80,15 +79,15 @@ class FirestoreEntityStorageConnector {
     }
     /**
      * Bootstrap the component by creating and initializing any resources it needs.
-     * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @param nodeLoggingComponentType The node logging component type.
      * @returns True if the bootstrapping process was successful.
      */
-    async bootstrap(nodeLoggingConnectorType) {
-        const nodeLogging = loggingModels.LoggingConnectorFactory.getIfExists(nodeLoggingConnectorType ?? "node-logging");
+    async bootstrap(nodeLoggingComponentType) {
+        const nodeLogging = core.ComponentFactory.getIfExists(nodeLoggingComponentType);
         try {
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: FirestoreEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "firestoreCreating",
                 data: {
@@ -103,7 +102,7 @@ class FirestoreEntityStorageConnector {
             await testDoc.delete();
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: FirestoreEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "firestoreCreated",
                 data: {
@@ -116,7 +115,7 @@ class FirestoreEntityStorageConnector {
         catch (err) {
             await nodeLogging?.log({
                 level: "error",
-                source: this.CLASS_NAME,
+                source: FirestoreEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "firestoreCreationFailed",
                 error: core.BaseError.fromError(err),
@@ -143,7 +142,7 @@ class FirestoreEntityStorageConnector {
      * @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(FirestoreEntityStorageConnector.CLASS_NAME, "id", id);
         try {
             if (!core.Is.stringValue(secondaryIndex) && !core.Is.arrayValue(conditions)) {
                 const docRef = this._collection.doc(id);
@@ -172,7 +171,7 @@ class FirestoreEntityStorageConnector {
             }
         }
         catch (err) {
-            throw new core.GeneralError(this.CLASS_NAME, "getEntityFailed", { id }, err);
+            throw new core.GeneralError(FirestoreEntityStorageConnector.CLASS_NAME, "getEntityFailed", { id }, err);
         }
     }
     /**
@@ -182,7 +181,7 @@ class FirestoreEntityStorageConnector {
      * @returns Nothing.
      */
     async set(entity$1, conditions) {
-        core.Guards.object(this.CLASS_NAME, "entity", entity$1);
+        core.Guards.object(FirestoreEntityStorageConnector.CLASS_NAME, "entity", entity$1);
         entity.EntitySchemaHelper.validateEntity(entity$1, this.getSchema());
         try {
             const id = entity$1[this._primaryKey.property];
@@ -221,7 +220,7 @@ class FirestoreEntityStorageConnector {
             }
         }
         catch (err) {
-            throw new core.GeneralError(this.CLASS_NAME, "setEntityFailed", { entity: entity$1 }, err);
+            throw new core.GeneralError(FirestoreEntityStorageConnector.CLASS_NAME, "setEntityFailed", { id: entity$1.id }, err);
         }
     }
     /**
@@ -231,7 +230,7 @@ class FirestoreEntityStorageConnector {
      * @returns Nothing.
      */
     async remove(id, conditions) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(FirestoreEntityStorageConnector.CLASS_NAME, "id", id);
         try {
             const docRef = this._collection.doc(id);
             if (!core.Is.arrayValue(conditions)) {
@@ -257,7 +256,7 @@ class FirestoreEntityStorageConnector {
             }
         }
         catch (err) {
-            throw new core.GeneralError(this.CLASS_NAME, "removeEntityFailed", { id }, err);
+            throw new core.GeneralError(FirestoreEntityStorageConnector.CLASS_NAME, "removeEntityFailed", { id }, err);
         }
     }
     /**
@@ -265,11 +264,11 @@ class FirestoreEntityStorageConnector {
      * @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.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit The suggested number of entities to return in each chunk.
      * @returns The matching entities and a cursor for the next page.
      */
-    async query(conditions, sortProperties, properties, cursor, pageSize) {
+    async query(conditions, sortProperties, properties, cursor, limit) {
         const queryDescription = [];
         try {
             let query = this._collection;
@@ -290,9 +289,9 @@ class FirestoreEntityStorageConnector {
                 }
                 queryDescription.push(`Cursor: ${cursor}`);
             }
-            const limit = pageSize ?? FirestoreEntityStorageConnector._PAGE_SIZE;
-            query = query.limit(limit);
-            queryDescription.push(`Limit: ${limit}`);
+            const finalLimit = limit ?? FirestoreEntityStorageConnector._DEFAULT_LIMIT;
+            query = query.limit(finalLimit);
+            queryDescription.push(`Limit: ${finalLimit}`);
             if (properties) {
                 query = query.select(...properties);
                 queryDescription.push(`Properties: ${properties.join(", ")}`);
@@ -300,7 +299,7 @@ class FirestoreEntityStorageConnector {
             const querySnapshot = await query.get();
             const entities = querySnapshot.docs.map((doc) => doc.data());
             let nextCursor;
-            if (entities.length === limit) {
+            if (entities.length === finalLimit) {
                 nextCursor = querySnapshot.docs[querySnapshot.docs.length - 1].ref.path;
             }
             return {
@@ -309,7 +308,7 @@ class FirestoreEntityStorageConnector {
             };
         }
         catch (err) {
-            throw new core.GeneralError(this.CLASS_NAME, "queryFailed", { queryDescription: queryDescription.join("; ") }, err);
+            throw new core.GeneralError(FirestoreEntityStorageConnector.CLASS_NAME, "queryFailed", { queryDescription: queryDescription.join("; ") }, err);
         }
     }
     /**
@@ -325,7 +324,7 @@ class FirestoreEntityStorageConnector {
             await this.deleteQueryBatch(query, batchSize);
         }
         catch (error) {
-            throw new core.GeneralError(this.CLASS_NAME, "collectionDeleteFailed", { collectionName: this._config.collectionName }, error);
+            throw new core.GeneralError(FirestoreEntityStorageConnector.CLASS_NAME, "collectionDeleteFailed", { collectionName: this._config.collectionName }, error);
         }
     }
     /**
@@ -363,7 +362,7 @@ class FirestoreEntityStorageConnector {
             case entity.ComparisonOperator.Includes:
                 return query.where(property, "array-contains", value);
             default:
-                throw new core.GeneralError(this.CLASS_NAME, "unsupportedComparisonOperator", { comparison });
+                throw new core.GeneralError(FirestoreEntityStorageConnector.CLASS_NAME, "unsupportedComparisonOperator", { comparison });
         }
     }
     /**

package/dist/esm/index.mjs

@@ -1,7 +1,6 @@
 import { Firestore } from '@google-cloud/firestore';
-import { Guards, Is, ObjectHelper, Converter, BaseError, GeneralError } from '@twin.org/core';
+import { Guards, Is, ObjectHelper, Converter, ComponentFactory, BaseError, GeneralError } from '@twin.org/core';
 import { EntitySchemaFactory, EntitySchemaHelper, SortDirection, ComparisonOperator } from '@twin.org/entity';
-import { LoggingConnectorFactory } from '@twin.org/logging-models';
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -10,14 +9,14 @@ import { LoggingConnectorFactory } from '@twin.org/logging-models';
  */
 class FirestoreEntityStorageConnector {
     /**
-     * Limit the number of entities when finding.
-     * @internal
+     * Runtime name for the class.
      */
-    static _PAGE_SIZE = 40;
+    static CLASS_NAME = "FirestoreEntityStorageConnector";
     /**
-     * Runtime name for the class.
+     * Limit the number of entities when finding.
+     * @internal
      */
-    CLASS_NAME = "FirestoreEntityStorageConnector";
+    static _DEFAULT_LIMIT = 40;
     /**
      * The schema for the entity.
      * @internal
@@ -48,14 +47,14 @@ class FirestoreEntityStorageConnector {
      * @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.projectId", options.config.projectId);
-        Guards.stringValue(this.CLASS_NAME, "options.config.collectionName", options.config.collectionName);
+        Guards.object(FirestoreEntityStorageConnector.CLASS_NAME, "options", options);
+        Guards.stringValue(FirestoreEntityStorageConnector.CLASS_NAME, "options.entitySchema", options.entitySchema);
+        Guards.object(FirestoreEntityStorageConnector.CLASS_NAME, "options.config", options.config);
+        Guards.stringValue(FirestoreEntityStorageConnector.CLASS_NAME, "options.config.projectId", options.config.projectId);
+        Guards.stringValue(FirestoreEntityStorageConnector.CLASS_NAME, "options.config.collectionName", options.config.collectionName);
         let credentials;
         if (!Is.empty(options.config.credentials)) {
-            Guards.stringBase64(this.CLASS_NAME, "options.config.credentials", options.config.credentials);
+            Guards.stringBase64(FirestoreEntityStorageConnector.CLASS_NAME, "options.config.credentials", options.config.credentials);
             credentials = ObjectHelper.fromBytes(Converter.base64ToBytes(options.config.credentials));
         }
         this._config = options.config;
@@ -78,15 +77,15 @@ class FirestoreEntityStorageConnector {
     }
     /**
      * Bootstrap the component by creating and initializing any resources it needs.
-     * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @param nodeLoggingComponentType The node logging component type.
      * @returns True if the bootstrapping process was successful.
      */
-    async bootstrap(nodeLoggingConnectorType) {
-        const nodeLogging = LoggingConnectorFactory.getIfExists(nodeLoggingConnectorType ?? "node-logging");
+    async bootstrap(nodeLoggingComponentType) {
+        const nodeLogging = ComponentFactory.getIfExists(nodeLoggingComponentType);
         try {
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: FirestoreEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "firestoreCreating",
                 data: {
@@ -101,7 +100,7 @@ class FirestoreEntityStorageConnector {
             await testDoc.delete();
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: FirestoreEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "firestoreCreated",
                 data: {
@@ -114,7 +113,7 @@ class FirestoreEntityStorageConnector {
         catch (err) {
             await nodeLogging?.log({
                 level: "error",
-                source: this.CLASS_NAME,
+                source: FirestoreEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "firestoreCreationFailed",
                 error: BaseError.fromError(err),
@@ -141,7 +140,7 @@ class FirestoreEntityStorageConnector {
      * @returns The object if it can be found or undefined.
      */
     async get(id, secondaryIndex, conditions) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(FirestoreEntityStorageConnector.CLASS_NAME, "id", id);
         try {
             if (!Is.stringValue(secondaryIndex) && !Is.arrayValue(conditions)) {
                 const docRef = this._collection.doc(id);
@@ -170,7 +169,7 @@ class FirestoreEntityStorageConnector {
             }
         }
         catch (err) {
-            throw new GeneralError(this.CLASS_NAME, "getEntityFailed", { id }, err);
+            throw new GeneralError(FirestoreEntityStorageConnector.CLASS_NAME, "getEntityFailed", { id }, err);
         }
     }
     /**
@@ -180,7 +179,7 @@ class FirestoreEntityStorageConnector {
      * @returns Nothing.
      */
     async set(entity, conditions) {
-        Guards.object(this.CLASS_NAME, "entity", entity);
+        Guards.object(FirestoreEntityStorageConnector.CLASS_NAME, "entity", entity);
         EntitySchemaHelper.validateEntity(entity, this.getSchema());
         try {
             const id = entity[this._primaryKey.property];
@@ -219,7 +218,7 @@ class FirestoreEntityStorageConnector {
             }
         }
         catch (err) {
-            throw new GeneralError(this.CLASS_NAME, "setEntityFailed", { entity }, err);
+            throw new GeneralError(FirestoreEntityStorageConnector.CLASS_NAME, "setEntityFailed", { id: entity.id }, err);
         }
     }
     /**
@@ -229,7 +228,7 @@ class FirestoreEntityStorageConnector {
      * @returns Nothing.
      */
     async remove(id, conditions) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(FirestoreEntityStorageConnector.CLASS_NAME, "id", id);
         try {
             const docRef = this._collection.doc(id);
             if (!Is.arrayValue(conditions)) {
@@ -255,7 +254,7 @@ class FirestoreEntityStorageConnector {
             }
         }
         catch (err) {
-            throw new GeneralError(this.CLASS_NAME, "removeEntityFailed", { id }, err);
+            throw new GeneralError(FirestoreEntityStorageConnector.CLASS_NAME, "removeEntityFailed", { id }, err);
         }
     }
     /**
@@ -263,11 +262,11 @@ class FirestoreEntityStorageConnector {
      * @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.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit The suggested number of entities to return in each chunk.
      * @returns The matching entities and a cursor for the next page.
      */
-    async query(conditions, sortProperties, properties, cursor, pageSize) {
+    async query(conditions, sortProperties, properties, cursor, limit) {
         const queryDescription = [];
         try {
             let query = this._collection;
@@ -288,9 +287,9 @@ class FirestoreEntityStorageConnector {
                 }
                 queryDescription.push(`Cursor: ${cursor}`);
             }
-            const limit = pageSize ?? FirestoreEntityStorageConnector._PAGE_SIZE;
-            query = query.limit(limit);
-            queryDescription.push(`Limit: ${limit}`);
+            const finalLimit = limit ?? FirestoreEntityStorageConnector._DEFAULT_LIMIT;
+            query = query.limit(finalLimit);
+            queryDescription.push(`Limit: ${finalLimit}`);
             if (properties) {
                 query = query.select(...properties);
                 queryDescription.push(`Properties: ${properties.join(", ")}`);
@@ -298,7 +297,7 @@ class FirestoreEntityStorageConnector {
             const querySnapshot = await query.get();
             const entities = querySnapshot.docs.map((doc) => doc.data());
             let nextCursor;
-            if (entities.length === limit) {
+            if (entities.length === finalLimit) {
                 nextCursor = querySnapshot.docs[querySnapshot.docs.length - 1].ref.path;
             }
             return {
@@ -307,7 +306,7 @@ class FirestoreEntityStorageConnector {
             };
         }
         catch (err) {
-            throw new GeneralError(this.CLASS_NAME, "queryFailed", { queryDescription: queryDescription.join("; ") }, err);
+            throw new GeneralError(FirestoreEntityStorageConnector.CLASS_NAME, "queryFailed", { queryDescription: queryDescription.join("; ") }, err);
         }
     }
     /**
@@ -323,7 +322,7 @@ class FirestoreEntityStorageConnector {
             await this.deleteQueryBatch(query, batchSize);
         }
         catch (error) {
-            throw new GeneralError(this.CLASS_NAME, "collectionDeleteFailed", { collectionName: this._config.collectionName }, error);
+            throw new GeneralError(FirestoreEntityStorageConnector.CLASS_NAME, "collectionDeleteFailed", { collectionName: this._config.collectionName }, error);
         }
     }
     /**
@@ -361,7 +360,7 @@ class FirestoreEntityStorageConnector {
             case ComparisonOperator.Includes:
                 return query.where(property, "array-contains", value);
             default:
-                throw new GeneralError(this.CLASS_NAME, "unsupportedComparisonOperator", { comparison });
+                throw new GeneralError(FirestoreEntityStorageConnector.CLASS_NAME, "unsupportedComparisonOperator", { comparison });
         }
     }
     /**

package/dist/types/firestoreEntityStorageConnector.d.ts

@@ -8,7 +8,7 @@ export declare class FirestoreEntityStorageConnector<T = unknown> implements IEn
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of FirestoreEntityStorageConnector.
      * @param options The options for the connector.
@@ -16,10 +16,10 @@ export declare class FirestoreEntityStorageConnector<T = unknown> implements IEn
     constructor(options: IFirestoreEntityStorageConnectorConstructorOptions);
     /**
      * Bootstrap the component by creating and initializing any resources it needs.
-     * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @param nodeLoggingComponentType The node logging component type.
      * @returns True if the bootstrapping process was successful.
      */
-    bootstrap(nodeLoggingConnectorType?: string): Promise<boolean>;
+    bootstrap(nodeLoggingComponentType?: string): Promise<boolean>;
     /**
      * Get the schema for the entities.
      * @returns The schema for the entities.
@@ -61,14 +61,14 @@ export declare class FirestoreEntityStorageConnector<T = unknown> implements IEn
      * @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.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit The suggested number of entities to return in each chunk.
      * @returns The matching entities and a cursor for the next page.
      */
     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<{
         /**
          * The entities, which can be partial if a limited keys list was provided.
          */

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

@@ -19,7 +19,7 @@ export interface IFirestoreEntityStorageConnectorConfig {
      */
     credentials?: string;
     /**
-     * It's usually only used with an emulator (e.g., "localhost:8080").
+     * It's usually only used with an emulator (e.g., "localhost:8580").
      */
     endpoint?: string;
     /**

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

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

package/docs/changelog.md

@@ -1,5 +1,174 @@
 # @twin.org/entity-storage-connector-gcp-firestore - Changelog
 
+## [0.0.2-next.10](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-gcp-firestore-v0.0.2-next.9...entity-storage-connector-gcp-firestore-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-gcp-firestore-v0.0.2-next.8...entity-storage-connector-gcp-firestore-v0.0.2-next.9) (2025-10-02)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-gcp-firestore:** 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-gcp-firestore-v0.0.2-next.7...entity-storage-connector-gcp-firestore-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-gcp-firestore-v0.0.2-next.6...entity-storage-connector-gcp-firestore-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-gcp-firestore-v0.0.2-next.5...entity-storage-connector-gcp-firestore-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-gcp-firestore-v0.0.2-next.4...entity-storage-connector-gcp-firestore-v0.0.2-next.5) (2025-08-11)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-gcp-firestore:** 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-gcp-firestore-v0.0.2-next.3...entity-storage-connector-gcp-firestore-v0.0.2-next.4) (2025-08-08)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-gcp-firestore:** 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-gcp-firestore-v0.0.2-next.2...entity-storage-connector-gcp-firestore-v0.0.2-next.3) (2025-07-25)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-gcp-firestore:** 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-gcp-firestore-v0.0.2-next.1...entity-storage-connector-gcp-firestore-v0.0.2-next.2) (2025-07-24)
+
+
+### Features
+
+* synchronised storage ([#44](https://github.com/twinfoundation/entity-storage/issues/44)) ([94e10e2](https://github.com/twinfoundation/entity-storage/commit/94e10e26d1feec801449dc04af7a9757ac7495ff))
+
+
+### 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-gcp-firestore-v0.0.2-next.0...entity-storage-connector-gcp-firestore-v0.0.2-next.1) (2025-07-17)
+
+
+### Features
+
+* Add entity storage connector for GCP Firestore ([#21](https://github.com/twinfoundation/entity-storage/issues/21)) ([10bfbf0](https://github.com/twinfoundation/entity-storage/commit/10bfbf0ba7dfe1e9de14d8059426c370476749d4))
+* 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/FirestoreEntityStorageConnector.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`\>
 
 Bootstrap the component by creating and initializing any resources it needs.
 
 #### Parameters
 
-##### nodeLoggingConnectorType?
+##### nodeLoggingComponentType?
 
 `string`
 
-The node logging connector type, defaults to "node-logging".
+The node logging component type.
 
 #### 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/IFirestoreEntityStorageConnectorConfig.md

@@ -40,7 +40,7 @@ The GCP credentials, a base64 encoded version of the JWTInput data type.
 
 > `optional` **endpoint**: `string`
 
-It's usually only used with an emulator (e.g., "localhost:8080").
+It's usually only used with an emulator (e.g., "localhost:8580").
 
 ***
 

package/docs/reference/interfaces/IFirestoreEntityStorageConnectorConstructorOptions.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, defaults to no logging.
+The type of logging component to use, defaults to no logging.
 
 ***
 

package/locales/en.json

@@ -13,11 +13,7 @@
 			"removeEntityFailed": "Failed to remove entity \"{id}\"",
 			"queryFailed": "The query failed when issuing the following command \"{queryDescription}\"",
 			"collectionDeleteFailed": "Failed to delete collection \"{collectionName}\"",
-			"unsupportedComparisonOperator": "Comparison operator \"{comparison}\" is not supported",
-			"firestoreClientNotInitialized": "Firestore client not initialized",
-			"undefinedProperty": "Property \"{key}\" is undefined. Firestore does not support undefined values.",
-			"missingProjectId": "Project ID is required",
-			"documentDoesNotExist": "The document with id {id} does not exist."
+			"unsupportedComparisonOperator": "Comparison operator \"{comparison}\" is not supported"
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-connector-gcp-firestore",
-	"version": "0.0.1",
+	"version": "0.0.2-next.10",
 	"description": "Entity Storage connector implementation using GCP Firestore storage",
 	"repository": {
 		"type": "git",
@@ -14,12 +14,12 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@google-cloud/firestore": "7.11.1",
-		"@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"
+		"@google-cloud/firestore": "7.11.6",
+		"@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",
@@ -38,5 +38,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"
 }