@twin.org/entity-storage-connector-gcp-firestore 0.0.2-next.9 → 0.0.3-next.2

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 8580: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 20200: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/{esm/index.mjs → es/firestoreEntityStorageConnector.js}

@@ -1,27 +1,32 @@
-import { Firestore } from '@google-cloud/firestore';
-import { Guards, Is, ObjectHelper, Converter, ComponentFactory, BaseError, GeneralError } from '@twin.org/core';
-import { EntitySchemaFactory, EntitySchemaHelper, SortDirection, ComparisonOperator } from '@twin.org/entity';
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
+import { Firestore } from "@google-cloud/firestore";
+import { ContextIdHelper, ContextIdStore } from "@twin.org/context";
+import { BaseError, ComponentFactory, Converter, GeneralError, Guards, Is, ObjectHelper } from "@twin.org/core";
+import { ComparisonOperator, EntityConditions, EntitySchemaFactory, EntitySchemaHelper, SortDirection } from "@twin.org/entity";
 /**
  * Class for performing entity storage operations using Firestore.
  */
-class FirestoreEntityStorageConnector {
+export 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
      */
     _entitySchema;
+    /**
+     * The keys to use from the context ids to create partitions.
+     * @internal
+     */
+    _partitionContextIds;
     /**
      * The primary key.
      * @internal
@@ -37,28 +42,24 @@ class FirestoreEntityStorageConnector {
      * @internal
      */
     _firestoreClient;
-    /**
-     * The Firestore collection.
-     * @internal
-     */
-    _collection;
     /**
      * Create a new instance of 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;
         this._entitySchema = EntitySchemaFactory.get(options.entitySchema);
+        this._partitionContextIds = options.partitionContextIds;
         this._primaryKey = EntitySchemaHelper.getPrimaryKey(this._entitySchema);
         const firestoreOptions = {
             projectId: this._config.projectId,
@@ -73,7 +74,20 @@ class FirestoreEntityStorageConnector {
             firestoreOptions.ssl = false;
         }
         this._firestoreClient = new Firestore(firestoreOptions);
-        this._collection = this._firestoreClient.collection(this._config.collectionName);
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return FirestoreEntityStorageConnector.CLASS_NAME;
+    }
+    /**
+     * Get the schema for the entities.
+     * @returns The schema for the entities.
+     */
+    getSchema() {
+        return this._entitySchema;
     }
     /**
      * Bootstrap the component by creating and initializing any resources it needs.
@@ -85,7 +99,7 @@ class FirestoreEntityStorageConnector {
         try {
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: FirestoreEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "firestoreCreating",
                 data: {
@@ -100,7 +114,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: {
@@ -113,7 +127,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),
@@ -125,13 +139,6 @@ class FirestoreEntityStorageConnector {
             return false;
         }
     }
-    /**
-     * Get the schema for the entities.
-     * @returns The schema for the entities.
-     */
-    getSchema() {
-        return this._entitySchema;
-    }
     /**
      * Get an entity.
      * @param id The id of the entity to get.
@@ -140,17 +147,20 @@ 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);
+        const contextIds = await ContextIdStore.getContextIds();
+        const partitionKey = ContextIdHelper.combinedContextKey(contextIds, this._partitionContextIds);
         try {
-            if (!Is.stringValue(secondaryIndex) && !Is.arrayValue(conditions)) {
-                const docRef = this._collection.doc(id);
+            const collection = this._firestoreClient.collection(this.collectionName(partitionKey));
+            if (!Is.arrayValue(conditions)) {
+                const docRef = collection.doc(id);
                 const doc = await docRef.get();
                 if (doc.exists) {
                     return doc.data();
                 }
             }
-            // Use secondaryIndex and/or conditions to construct a query
-            let query = this._collection;
+            // Use conditions to construct a query
+            let query = collection;
             if (secondaryIndex) {
                 query = query.where(secondaryIndex, "==", id);
             }
@@ -165,11 +175,12 @@ class FirestoreEntityStorageConnector {
             }
             const querySnapshot = await query.limit(1).get();
             if (!querySnapshot.empty) {
-                return querySnapshot.docs[0].data();
+                const entity = querySnapshot.docs[0].data();
+                return entity;
             }
         }
         catch (err) {
-            throw new GeneralError(this.CLASS_NAME, "getEntityFailed", { id }, err);
+            throw new GeneralError(FirestoreEntityStorageConnector.CLASS_NAME, "getEntityFailed", { id }, err);
         }
     }
     /**
@@ -179,46 +190,40 @@ class FirestoreEntityStorageConnector {
      * @returns Nothing.
      */
     async set(entity, conditions) {
-        Guards.object(this.CLASS_NAME, "entity", entity);
+        Guards.object(FirestoreEntityStorageConnector.CLASS_NAME, "entity", entity);
+        const contextIds = await ContextIdStore.getContextIds();
+        const partitionKey = ContextIdHelper.combinedContextKey(contextIds, this._partitionContextIds);
         EntitySchemaHelper.validateEntity(entity, this.getSchema());
         try {
             const id = entity[this._primaryKey.property];
-            const entityCopy = { ...entity };
-            // Handle indexing field
-            if (entityCopy.valueArray && Is.array(entityCopy.valueArray)) {
-                const valueArrayFields = entityCopy.valueArray
-                    .filter((item) => Is.notEmpty(item))
-                    .map(item => `${item.field}:${item.value}`);
-                entityCopy.valueArrayFields = valueArrayFields;
-            }
-            const docRef = this._collection.doc(id);
+            const collection = this._firestoreClient.collection(this.collectionName(partitionKey));
+            const docRef = collection.doc(id);
             if (!Is.arrayValue(conditions)) {
-                await docRef.set(entityCopy);
+                await docRef.set(entity);
             }
             else {
                 await this._firestoreClient.runTransaction(async (transaction) => {
                     const docSnapshot = await transaction.get(docRef);
                     if (!docSnapshot.exists) {
-                        transaction.set(docRef, entityCopy);
+                        transaction.set(docRef, entity);
                     }
                     else {
                         const data = docSnapshot.data();
-                        let conditionsMet = true;
-                        for (const condition of conditions) {
-                            if (data[condition.property] !== condition.value) {
-                                conditionsMet = false;
-                                break;
-                            }
-                        }
-                        if (conditionsMet) {
-                            transaction.set(docRef, entityCopy);
+                        if (EntityConditions.check(data, {
+                            conditions: conditions.map(c => ({
+                                property: c.property,
+                                comparison: ComparisonOperator.Equals,
+                                value: c.value
+                            }))
+                        })) {
+                            transaction.set(docRef, entity);
                         }
                     }
                 });
             }
         }
         catch (err) {
-            throw new GeneralError(this.CLASS_NAME, "setEntityFailed", { entity }, err);
+            throw new GeneralError(FirestoreEntityStorageConnector.CLASS_NAME, "setEntityFailed", { id: entity.id }, err);
         }
     }
     /**
@@ -228,9 +233,12 @@ class FirestoreEntityStorageConnector {
      * @returns Nothing.
      */
     async remove(id, conditions) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(FirestoreEntityStorageConnector.CLASS_NAME, "id", id);
+        const contextIds = await ContextIdStore.getContextIds();
+        const partitionKey = ContextIdHelper.combinedContextKey(contextIds, this._partitionContextIds);
         try {
-            const docRef = this._collection.doc(id);
+            const collection = this._firestoreClient.collection(this.collectionName(partitionKey));
+            const docRef = collection.doc(id);
             if (!Is.arrayValue(conditions)) {
                 await docRef.delete();
             }
@@ -239,14 +247,13 @@ class FirestoreEntityStorageConnector {
                     const docSnapshot = await transaction.get(docRef);
                     if (docSnapshot.exists) {
                         const data = docSnapshot.data();
-                        let conditionsMet = true;
-                        for (const condition of conditions) {
-                            if (data[condition.property] !== condition.value) {
-                                conditionsMet = false;
-                                break;
-                            }
-                        }
-                        if (conditionsMet) {
+                        if (EntityConditions.check(data, {
+                            conditions: conditions.map(c => ({
+                                property: c.property,
+                                comparison: ComparisonOperator.Equals,
+                                value: c.value
+                            }))
+                        })) {
                             transaction.delete(docRef);
                         }
                     }
@@ -254,7 +261,7 @@ class FirestoreEntityStorageConnector {
             }
         }
         catch (err) {
-            throw new GeneralError(this.CLASS_NAME, "removeEntityFailed", { id }, err);
+            throw new GeneralError(FirestoreEntityStorageConnector.CLASS_NAME, "removeEntityFailed", { id }, err);
         }
     }
     /**
@@ -262,15 +269,18 @@ 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 = [];
+        const contextIds = await ContextIdStore.getContextIds();
+        const partitionKey = ContextIdHelper.combinedContextKey(contextIds, this._partitionContextIds);
         try {
-            let query = this._collection;
-            if (conditions) {
+            const collection = this._firestoreClient.collection(this.collectionName(partitionKey));
+            let query = collection;
+            if (!Is.empty(conditions)) {
                 query = this.applyConditions(query, conditions);
                 queryDescription.push(`Conditions: ${JSON.stringify(conditions)}`);
             }
@@ -287,9 +297,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(", ")}`);
@@ -297,7 +307,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 {
@@ -306,7 +316,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);
         }
     }
     /**
@@ -315,14 +325,14 @@ class FirestoreEntityStorageConnector {
      * @internal
      */
     async collectionDelete() {
-        const collection = this._collection;
+        const collection = this._firestoreClient.collection(this.collectionName());
         const batchSize = 500;
         const query = collection.limit(batchSize);
         try {
             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);
         }
     }
     /**
@@ -359,8 +369,9 @@ class FirestoreEntityStorageConnector {
                 return query.where(property, "in", value);
             case ComparisonOperator.Includes:
                 return query.where(property, "array-contains", value);
+            case ComparisonOperator.NotIncludes:
             default:
-                throw new GeneralError(this.CLASS_NAME, "unsupportedComparisonOperator", { comparison });
+                throw new GeneralError(FirestoreEntityStorageConnector.CLASS_NAME, "unsupportedComparisonOperator", { comparison });
         }
     }
     /**
@@ -382,6 +393,13 @@ class FirestoreEntityStorageConnector {
             await this.deleteQueryBatch(query, batchSize);
         }
     }
+    /**
+     * Get the collection name based on partition key.
+     * @returns The collection name.
+     * @internal
+     */
+    collectionName(partitionKey) {
+        return `${this._config.collectionName}_${partitionKey ?? "default"}`;
+    }
 }
-
-export { FirestoreEntityStorageConnector };
+//# sourceMappingURL=firestoreEntityStorageConnector.js.map

package/dist/es/firestoreEntityStorageConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"firestoreEntityStorageConnector.js","sourceRoot":"","sources":["../../src/firestoreEntityStorageConnector.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAEN,SAAS,EAGT,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,EACN,SAAS,EACT,gBAAgB,EAChB,SAAS,EACT,YAAY,EACZ,MAAM,EACN,EAAE,EACF,YAAY,EACZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACN,kBAAkB,EAElB,gBAAgB,EAChB,mBAAmB,EACnB,kBAAkB,EAGlB,aAAa,EACb,MAAM,kBAAkB,CAAC;AAQ1B;;GAEG;AACH,MAAM,OAAO,+BAA+B;IAC3C;;OAEG;IACI,MAAM,CAAU,UAAU,qCAAqD;IAEtF;;;OAGG;IACK,MAAM,CAAU,cAAc,GAAW,EAAE,CAAC;IAEpD;;;OAGG;IACc,aAAa,CAAmB;IAEjD;;;OAGG;IACc,oBAAoB,CAAY;IAEjD;;;OAGG;IACc,WAAW,CAA2B;IAEvD;;;OAGG;IACc,OAAO,CAAyC;IAEjE;;;OAGG;IACc,gBAAgB,CAAY;IAE7C;;;OAGG;IACH,YAAY,OAA2D;QACtE,MAAM,CAAC,MAAM,CAAC,+BAA+B,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QACpF,MAAM,CAAC,WAAW,CACjB,+BAA+B,CAAC,UAAU,0BAE1C,OAAO,CAAC,YAAY,CACpB,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,+BAA+B,CAAC,UAAU,oBAE1C,OAAO,CAAC,MAAM,CACd,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,+BAA+B,CAAC,UAAU,8BAE1C,OAAO,CAAC,MAAM,CAAC,SAAS,CACxB,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,+BAA+B,CAAC,UAAU,mCAE1C,OAAO,CAAC,MAAM,CAAC,cAAc,CAC7B,CAAC;QAEF,IAAI,WAAiC,CAAC;QACtC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;YAC3C,MAAM,CAAC,YAAY,CAClB,+BAA+B,CAAC,UAAU,gCAE1C,OAAO,CAAC,MAAM,CAAC,WAAW,CAC1B,CAAC;YACF,WAAW,GAAG,YAAY,CAAC,SAAS,CACnC,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CACnD,CAAC;QACH,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;QAC9B,IAAI,CAAC,aAAa,GAAG,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACnE,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;QACxD,IAAI,CAAC,WAAW,GAAG,kBAAkB,CAAC,aAAa,CAAI,IAAI,CAAC,aAAa,CAAC,CAAC;QAE3E,MAAM,gBAAgB,GAAa;YAClC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;YACjC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;YACnC,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc;YAC3C,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,eAAe;YACvD,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO;YACvC,WAAW;SACX,CAAC;QAEF,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3C,gBAAgB,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;YAC9C,gBAAgB,CAAC,GAAG,GAAG,KAAK,CAAC;QAC9B,CAAC;QAED,IAAI,CAAC,gBAAgB,GAAG,IAAI,SAAS,CAAC,gBAAgB,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,+BAA+B,CAAC,UAAU,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,IAAI,CAAC,aAA8B,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,wBAAiC;QACvD,MAAM,WAAW,GAAG,gBAAgB,CAAC,WAAW,CAAoB,wBAAwB,CAAC,CAAC;QAE9F,IAAI,CAAC;YACJ,MAAM,WAAW,EAAE,GAAG,CAAC;gBACtB,KAAK,EAAE,MAAM;gBACb,MAAM,EAAE,+BAA+B,CAAC,UAAU;gBAClD,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBACd,OAAO,EAAE,mBAAmB;gBAC5B,IAAI,EAAE;oBACL,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;oBACjC,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc;iBAC3C;aACD,CAAC,CAAC;YAEH,yDAAyD;YACzD,yDAAyD;YACzD,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAC1F,MAAM,OAAO,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YAClC,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC;YAEvB,MAAM,WAAW,EAAE,GAAG,CAAC;gBACtB,KAAK,EAAE,MAAM;gBACb,MAAM,EAAE,+BAA+B,CAAC,UAAU;gBAClD,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBACd,OAAO,EAAE,kBAAkB;gBAC3B,IAAI,EAAE;oBACL,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;oBACjC,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc;iBAC3C;aACD,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,MAAM,WAAW,EAAE,GAAG,CAAC;gBACtB,KAAK,EAAE,OAAO;gBACd,MAAM,EAAE,+BAA+B,CAAC,UAAU;gBAClD,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBACd,OAAO,EAAE,yBAAyB;gBAClC,KAAK,EAAE,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC;gBAC/B,IAAI,EAAE;oBACL,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;oBACjC,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc;iBAC3C;aACD,CAAC,CAAC;YACH,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACf,EAAU,EACV,cAAwB,EACxB,UAAoD;QAEpD,MAAM,CAAC,WAAW,CAAC,+BAA+B,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAE/E,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,CAAC;QACxD,MAAM,YAAY,GAAG,eAAe,CAAC,kBAAkB,CAAC,UAAU,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAE/F,IAAI,CAAC;YACJ,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC;YAEvF,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBAChC,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAClC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC;gBAE/B,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;oBAChB,OAAO,GAAG,CAAC,IAAI,EAAO,CAAC;gBACxB,CAAC;YACF,CAAC;YAED,sCAAsC;YACtC,IAAI,KAAK,GAAU,UAAU,CAAC;YAE9B,IAAI,cAAc,EAAE,CAAC;gBACpB,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,cAAwB,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YACzD,CAAC;iBAAM,CAAC;gBACP,0DAA0D;gBAC1D,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,QAAkB,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YACpE,CAAC;YAED,IAAI,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC/B,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;oBACpC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,QAAkB,EAAE,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;gBAC1E,CAAC;YACF,CAAC;YAED,MAAM,aAAa,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;YACjD,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;gBAC1B,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAO,CAAC;gBACjD,OAAO,MAAM,CAAC;YACf,CAAC;QACF,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,MAAM,IAAI,YAAY,CACrB,+BAA+B,CAAC,UAAU,EAC1C,iBAAiB,EACjB,EAAE,EAAE,EAAE,EACN,GAAG,CACH,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CAAC,MAAS,EAAE,UAAoD;QAC/E,MAAM,CAAC,MAAM,CAAC,+BAA+B,CAAC,UAAU,YAAkB,MAAM,CAAC,CAAC;QAElF,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,CAAC;QACxD,MAAM,YAAY,GAAG,eAAe,CAAC,kBAAkB,CAAC,UAAU,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAE/F,kBAAkB,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QAE5D,IAAI,CAAC;YACJ,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAW,CAAC;YAEvD,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC;YAEvF,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAElC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBAChC,MAAM,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACP,MAAM,IAAI,CAAC,gBAAgB,CAAC,cAAc,CAAC,KAAK,EAAC,WAAW,EAAC,EAAE;oBAC9D,MAAM,WAAW,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;oBAElD,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;wBACzB,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;oBACjC,CAAC;yBAAM,CAAC;wBACP,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,EAAO,CAAC;wBAErC,IACC,gBAAgB,CAAC,KAAK,CAAC,IAAI,EAAE;4BAC5B,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gCAChC,QAAQ,EAAE,CAAC,CAAC,QAAkB;gCAC9B,UAAU,EAAE,kBAAkB,CAAC,MAAM;gCACrC,KAAK,EAAE,CAAC,CAAC,KAAK;6BACd,CAAC,CAAC;yBACH,CAAC,EACD,CAAC;4BACF,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;wBACjC,CAAC;oBACF,CAAC;gBACF,CAAC,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,MAAM,IAAI,YAAY,CACrB,+BAA+B,CAAC,UAAU,EAC1C,iBAAiB,EACjB,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,EACjB,GAAG,CACH,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAClB,EAAU,EACV,UAAoD;QAEpD,MAAM,CAAC,WAAW,CAAC,+BAA+B,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAE/E,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,CAAC;QACxD,MAAM,YAAY,GAAG,eAAe,CAAC,kBAAkB,CAAC,UAAU,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAE/F,IAAI,CAAC;YACJ,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC;YACvF,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAElC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBAChC,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC;YACvB,CAAC;iBAAM,CAAC;gBACP,MAAM,IAAI,CAAC,gBAAgB,CAAC,cAAc,CAAC,KAAK,EAAC,WAAW,EAAC,EAAE;oBAC9D,MAAM,WAAW,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;oBAElD,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;wBACxB,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,EAAO,CAAC;wBACrC,IACC,gBAAgB,CAAC,KAAK,CAAC,IAAI,EAAE;4BAC5B,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gCAChC,QAAQ,EAAE,CAAC,CAAC,QAAkB;gCAC9B,UAAU,EAAE,kBAAkB,CAAC,MAAM;gCACrC,KAAK,EAAE,CAAC,CAAC,KAAK;6BACd,CAAC,CAAC;yBACH,CAAC,EACD,CAAC;4BACF,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;wBAC5B,CAAC;oBACF,CAAC;gBACF,CAAC,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,MAAM,IAAI,YAAY,CACrB,+BAA+B,CAAC,UAAU,EAC1C,oBAAoB,EACpB,EAAE,EAAE,EAAE,EACN,GAAG,CACH,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,KAAK,CACjB,UAA+B,EAC/B,cAAsE,EACtE,UAAwB,EACxB,MAAe,EACf,KAAc;QAWd,MAAM,gBAAgB,GAAa,EAAE,CAAC;QAEtC,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,CAAC;QACxD,MAAM,YAAY,GAAG,eAAe,CAAC,kBAAkB,CAAC,UAAU,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAE/F,IAAI,CAAC;YACJ,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC;YACvF,IAAI,KAAK,GAAG,UAAmB,CAAC;YAEhC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC3B,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;gBAChD,gBAAgB,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YACpE,CAAC;YAED,IAAI,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;gBACnC,KAAK,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,cAAc,EAAE,CAAC;oBAC1D,KAAK,GAAG,KAAK,CAAC,OAAO,CACpB,QAAkB,EAClB,aAAa,KAAK,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAC1D,CAAC;gBACH,CAAC;gBACD,gBAAgB,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;YAClE,CAAC;YAED,IAAI,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC5B,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC;gBAChE,IAAI,SAAS,EAAE,MAAM,EAAE,CAAC;oBACvB,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;gBACrC,CAAC;gBACD,gBAAgB,CAAC,IAAI,CAAC,WAAW,MAAM,EAAE,CAAC,CAAC;YAC5C,CAAC;YAED,MAAM,UAAU,GAAG,KAAK,IAAI,+BAA+B,CAAC,cAAc,CAAC;YAC3E,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YAChC,gBAAgB,CAAC,IAAI,CAAC,UAAU,UAAU,EAAE,CAAC,CAAC;YAE9C,IAAI,UAAU,EAAE,CAAC;gBAChB,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,GAAI,UAAuB,CAAC,CAAC;gBAClD,gBAAgB,CAAC,IAAI,CAAC,eAAe,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAC/D,CAAC;YAED,MAAM,aAAa,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,CAAC;YACxC,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAqB,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAO,CAAC,CAAC;YAEpF,IAAI,UAA8B,CAAC;YACnC,IAAI,QAAQ,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;gBACpC,UAAU,GAAG,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;YACzE,CAAC;YAED,OAAO;gBACN,QAAQ;gBACR,MAAM,EAAE,UAAU;aAClB,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,MAAM,IAAI,YAAY,CACrB,+BAA+B,CAAC,UAAU,EAC1C,aAAa,EACb,EAAE,gBAAgB,EAAE,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EACjD,GAAG,CACH,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gBAAgB;QAC5B,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;QAC3E,MAAM,SAAS,GAAG,GAAG,CAAC;QACtB,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAE1C,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC/C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CACrB,+BAA+B,CAAC,UAAU,EAC1C,wBAAwB,EACxB,EAAE,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,EAC/C,KAAK,CACL,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACK,eAAe,CAAC,KAAY,EAAE,SAA6B;QAClE,IAAI,YAAY,IAAI,SAAS,EAAE,CAAC;YAC/B,6BAA6B;YAC7B,KAAK,MAAM,CAAC,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;gBACtC,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YACxC,CAAC;YACD,OAAO,KAAK,CAAC;QACd,CAAC;QACD,0BAA0B;QAC1B,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;QAClD,QAAQ,UAAU,EAAE,CAAC;YACpB,KAAK,kBAAkB,CAAC,MAAM;gBAC7B,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YAC3C,KAAK,kBAAkB,CAAC,SAAS;gBAChC,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YAC3C,KAAK,kBAAkB,CAAC,WAAW;gBAClC,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;YAC1C,KAAK,kBAAkB,CAAC,QAAQ;gBAC/B,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;YAC1C,KAAK,kBAAkB,CAAC,kBAAkB;gBACzC,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YAC3C,KAAK,kBAAkB,CAAC,eAAe;gBACtC,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YAC3C,KAAK,kBAAkB,CAAC,EAAE;gBACzB,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAkB,CAAC,CAAC;YACxD,KAAK,kBAAkB,CAAC,QAAQ;gBAC/B,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,gBAAgB,EAAE,KAAK,CAAC,CAAC;YACvD,KAAK,kBAAkB,CAAC,WAAW,CAAC;YACpC;gBACC,MAAM,IAAI,YAAY,CACrB,+BAA+B,CAAC,UAAU,EAC1C,+BAA+B,EAC/B,EAAE,UAAU,EAAE,CACd,CAAC;QACJ,CAAC;IACF,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,gBAAgB,CAAC,KAAY,EAAE,SAAiB;QAC7D,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,CAAC;QAEnC,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO;QACR,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAC5C,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;YACjC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC;QAED,MAAM,KAAK,CAAC,MAAM,EAAE,CAAC;QAErB,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC/C,CAAC;IACF,CAAC;IAED;;;;OAIG;IACK,cAAc,CAAC,YAAqB;QAC3C,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,YAAY,IAAI,SAAS,EAAE,CAAC;IACtE,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport {\n\ttype DocumentSnapshot,\n\tFirestore,\n\ttype Query,\n\ttype Settings\n} from \"@google-cloud/firestore\";\nimport { ContextIdHelper, ContextIdStore } from \"@twin.org/context\";\nimport {\n\tBaseError,\n\tComponentFactory,\n\tConverter,\n\tGeneralError,\n\tGuards,\n\tIs,\n\tObjectHelper\n} from \"@twin.org/core\";\nimport {\n\tComparisonOperator,\n\ttype EntityCondition,\n\tEntityConditions,\n\tEntitySchemaFactory,\n\tEntitySchemaHelper,\n\ttype IEntitySchema,\n\ttype IEntitySchemaProperty,\n\tSortDirection\n} from \"@twin.org/entity\";\nimport type { IEntityStorageConnector } from \"@twin.org/entity-storage-models\";\nimport type { ILoggingComponent } from \"@twin.org/logging-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { JWTInput } from \"google-auth-library\";\nimport type { IFirestoreEntityStorageConnectorConfig } from \"./models/IFirestoreEntityStorageConnectorConfig.js\";\nimport type { IFirestoreEntityStorageConnectorConstructorOptions } from \"./models/IFirestoreEntityStorageConnectorConstructorOptions.js\";\n\n/**\n * Class for performing entity storage operations using Firestore.\n */\nexport class FirestoreEntityStorageConnector<T = unknown> implements IEntityStorageConnector<T> {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<FirestoreEntityStorageConnector>();\n\n\t/**\n\t * Limit the number of entities when finding.\n\t * @internal\n\t */\n\tprivate static readonly _DEFAULT_LIMIT: number = 40;\n\n\t/**\n\t * The schema for the entity.\n\t * @internal\n\t */\n\tprivate readonly _entitySchema: IEntitySchema<T>;\n\n\t/**\n\t * The keys to use from the context ids to create partitions.\n\t * @internal\n\t */\n\tprivate readonly _partitionContextIds?: string[];\n\n\t/**\n\t * The primary key.\n\t * @internal\n\t */\n\tprivate readonly _primaryKey: IEntitySchemaProperty<T>;\n\n\t/**\n\t * The configuration for the connector.\n\t * @internal\n\t */\n\tprivate readonly _config: IFirestoreEntityStorageConnectorConfig;\n\n\t/**\n\t * The Firestore client.\n\t * @internal\n\t */\n\tprivate readonly _firestoreClient: Firestore;\n\n\t/**\n\t * Create a new instance of FirestoreEntityStorageConnector.\n\t * @param options The options for the connector.\n\t */\n\tconstructor(options: IFirestoreEntityStorageConnectorConstructorOptions) {\n\t\tGuards.object(FirestoreEntityStorageConnector.CLASS_NAME, nameof(options), options);\n\t\tGuards.stringValue(\n\t\t\tFirestoreEntityStorageConnector.CLASS_NAME,\n\t\t\tnameof(options.entitySchema),\n\t\t\toptions.entitySchema\n\t\t);\n\t\tGuards.object<IFirestoreEntityStorageConnectorConfig>(\n\t\t\tFirestoreEntityStorageConnector.CLASS_NAME,\n\t\t\tnameof(options.config),\n\t\t\toptions.config\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tFirestoreEntityStorageConnector.CLASS_NAME,\n\t\t\tnameof(options.config.projectId),\n\t\t\toptions.config.projectId\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tFirestoreEntityStorageConnector.CLASS_NAME,\n\t\t\tnameof(options.config.collectionName),\n\t\t\toptions.config.collectionName\n\t\t);\n\n\t\tlet credentials: JWTInput | undefined;\n\t\tif (!Is.empty(options.config.credentials)) {\n\t\t\tGuards.stringBase64(\n\t\t\t\tFirestoreEntityStorageConnector.CLASS_NAME,\n\t\t\t\tnameof(options.config.credentials),\n\t\t\t\toptions.config.credentials\n\t\t\t);\n\t\t\tcredentials = ObjectHelper.fromBytes<JWTInput>(\n\t\t\t\tConverter.base64ToBytes(options.config.credentials)\n\t\t\t);\n\t\t}\n\n\t\tthis._config = options.config;\n\t\tthis._entitySchema = EntitySchemaFactory.get(options.entitySchema);\n\t\tthis._partitionContextIds = options.partitionContextIds;\n\t\tthis._primaryKey = EntitySchemaHelper.getPrimaryKey<T>(this._entitySchema);\n\n\t\tconst firestoreOptions: Settings = {\n\t\t\tprojectId: this._config.projectId,\n\t\t\tdatabaseId: this._config.databaseId,\n\t\t\tcollectionName: this._config.collectionName,\n\t\t\tmaxIdleChannels: this._config.settings?.maxIdleChannels,\n\t\t\ttimeout: this._config.settings?.timeout,\n\t\t\tcredentials\n\t\t};\n\n\t\tif (Is.stringValue(this._config.endpoint)) {\n\t\t\tfirestoreOptions.host = this._config.endpoint;\n\t\t\tfirestoreOptions.ssl = false;\n\t\t}\n\n\t\tthis._firestoreClient = new Firestore(firestoreOptions);\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn FirestoreEntityStorageConnector.CLASS_NAME;\n\t}\n\n\t/**\n\t * Get the schema for the entities.\n\t * @returns The schema for the entities.\n\t */\n\tpublic getSchema(): IEntitySchema {\n\t\treturn this._entitySchema as IEntitySchema;\n\t}\n\n\t/**\n\t * Bootstrap the component by creating and initializing any resources it needs.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns True if the bootstrapping process was successful.\n\t */\n\tpublic async bootstrap(nodeLoggingComponentType?: string): Promise<boolean> {\n\t\tconst nodeLogging = ComponentFactory.getIfExists<ILoggingComponent>(nodeLoggingComponentType);\n\n\t\ttry {\n\t\t\tawait nodeLogging?.log({\n\t\t\t\tlevel: \"info\",\n\t\t\t\tsource: FirestoreEntityStorageConnector.CLASS_NAME,\n\t\t\t\tts: Date.now(),\n\t\t\t\tmessage: \"firestoreCreating\",\n\t\t\t\tdata: {\n\t\t\t\t\tprojectId: this._config.projectId,\n\t\t\t\t\tcollectionName: this._config.collectionName\n\t\t\t\t}\n\t\t\t});\n\n\t\t\t// Firestore doesn't require explicit collection creation\n\t\t\t// Perform a small write operation to ensure connectivity\n\t\t\tconst testDoc = this._firestoreClient.collection(this._config.collectionName).doc(\"test\");\n\t\t\tawait testDoc.set({ test: true });\n\t\t\tawait testDoc.delete();\n\n\t\t\tawait nodeLogging?.log({\n\t\t\t\tlevel: \"info\",\n\t\t\t\tsource: FirestoreEntityStorageConnector.CLASS_NAME,\n\t\t\t\tts: Date.now(),\n\t\t\t\tmessage: \"firestoreCreated\",\n\t\t\t\tdata: {\n\t\t\t\t\tprojectId: this._config.projectId,\n\t\t\t\t\tcollectionName: this._config.collectionName\n\t\t\t\t}\n\t\t\t});\n\n\t\t\treturn true;\n\t\t} catch (err) {\n\t\t\tawait nodeLogging?.log({\n\t\t\t\tlevel: \"error\",\n\t\t\t\tsource: FirestoreEntityStorageConnector.CLASS_NAME,\n\t\t\t\tts: Date.now(),\n\t\t\t\tmessage: \"firestoreCreationFailed\",\n\t\t\t\terror: BaseError.fromError(err),\n\t\t\t\tdata: {\n\t\t\t\t\tprojectId: this._config.projectId,\n\t\t\t\t\tcollectionName: this._config.collectionName\n\t\t\t\t}\n\t\t\t});\n\t\t\treturn false;\n\t\t}\n\t}\n\n\t/**\n\t * Get an entity.\n\t * @param id The id of the entity to get.\n\t * @param secondaryIndex The optional secondary index to use.\n\t * @param conditions The optional conditions to apply to the query.\n\t * @returns The object if it can be found or undefined.\n\t */\n\tpublic async get(\n\t\tid: string,\n\t\tsecondaryIndex?: keyof T,\n\t\tconditions?: { property: keyof T; value: unknown }[]\n\t): Promise<T | undefined> {\n\t\tGuards.stringValue(FirestoreEntityStorageConnector.CLASS_NAME, nameof(id), id);\n\n\t\tconst contextIds = await ContextIdStore.getContextIds();\n\t\tconst partitionKey = ContextIdHelper.combinedContextKey(contextIds, this._partitionContextIds);\n\n\t\ttry {\n\t\t\tconst collection = this._firestoreClient.collection(this.collectionName(partitionKey));\n\n\t\t\tif (!Is.arrayValue(conditions)) {\n\t\t\t\tconst docRef = collection.doc(id);\n\t\t\t\tconst doc = await docRef.get();\n\n\t\t\t\tif (doc.exists) {\n\t\t\t\t\treturn doc.data() as T;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Use conditions to construct a query\n\t\t\tlet query: Query = collection;\n\n\t\t\tif (secondaryIndex) {\n\t\t\t\tquery = query.where(secondaryIndex as string, \"==\", id);\n\t\t\t} else {\n\t\t\t\t// If no secondaryIndex, include primary key in conditions\n\t\t\t\tquery = query.where(this._primaryKey.property as string, \"==\", id);\n\t\t\t}\n\n\t\t\tif (Is.arrayValue(conditions)) {\n\t\t\t\tfor (const condition of conditions) {\n\t\t\t\t\tquery = query.where(condition.property as string, \"==\", condition.value);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tconst querySnapshot = await query.limit(1).get();\n\t\t\tif (!querySnapshot.empty) {\n\t\t\t\tconst entity = querySnapshot.docs[0].data() as T;\n\t\t\t\treturn entity;\n\t\t\t}\n\t\t} catch (err) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tFirestoreEntityStorageConnector.CLASS_NAME,\n\t\t\t\t\"getEntityFailed\",\n\t\t\t\t{ id },\n\t\t\t\terr\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Set an entity.\n\t * @param entity The entity to set.\n\t * @param conditions The optional conditions to apply to the update.\n\t * @returns Nothing.\n\t */\n\tpublic async set(entity: T, conditions?: { property: keyof T; value: unknown }[]): Promise<void> {\n\t\tGuards.object(FirestoreEntityStorageConnector.CLASS_NAME, nameof(entity), entity);\n\n\t\tconst contextIds = await ContextIdStore.getContextIds();\n\t\tconst partitionKey = ContextIdHelper.combinedContextKey(contextIds, this._partitionContextIds);\n\n\t\tEntitySchemaHelper.validateEntity(entity, this.getSchema());\n\n\t\ttry {\n\t\t\tconst id = entity[this._primaryKey.property] as string;\n\n\t\t\tconst collection = this._firestoreClient.collection(this.collectionName(partitionKey));\n\n\t\t\tconst docRef = collection.doc(id);\n\n\t\t\tif (!Is.arrayValue(conditions)) {\n\t\t\t\tawait docRef.set(entity);\n\t\t\t} else {\n\t\t\t\tawait this._firestoreClient.runTransaction(async transaction => {\n\t\t\t\t\tconst docSnapshot = await transaction.get(docRef);\n\n\t\t\t\t\tif (!docSnapshot.exists) {\n\t\t\t\t\t\ttransaction.set(docRef, entity);\n\t\t\t\t\t} else {\n\t\t\t\t\t\tconst data = docSnapshot.data() as T;\n\n\t\t\t\t\t\tif (\n\t\t\t\t\t\t\tEntityConditions.check(data, {\n\t\t\t\t\t\t\t\tconditions: conditions.map(c => ({\n\t\t\t\t\t\t\t\t\tproperty: c.property as string,\n\t\t\t\t\t\t\t\t\tcomparison: ComparisonOperator.Equals,\n\t\t\t\t\t\t\t\t\tvalue: c.value\n\t\t\t\t\t\t\t\t}))\n\t\t\t\t\t\t\t})\n\t\t\t\t\t\t) {\n\t\t\t\t\t\t\ttransaction.set(docRef, entity);\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t}\n\t\t} catch (err) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tFirestoreEntityStorageConnector.CLASS_NAME,\n\t\t\t\t\"setEntityFailed\",\n\t\t\t\t{ id: entity.id },\n\t\t\t\terr\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Remove the entity.\n\t * @param id The id of the entity to remove.\n\t * @param conditions The optional conditions to apply to the delete.\n\t * @returns Nothing.\n\t */\n\tpublic async remove(\n\t\tid: string,\n\t\tconditions?: { property: keyof T; value: unknown }[]\n\t): Promise<void> {\n\t\tGuards.stringValue(FirestoreEntityStorageConnector.CLASS_NAME, nameof(id), id);\n\n\t\tconst contextIds = await ContextIdStore.getContextIds();\n\t\tconst partitionKey = ContextIdHelper.combinedContextKey(contextIds, this._partitionContextIds);\n\n\t\ttry {\n\t\t\tconst collection = this._firestoreClient.collection(this.collectionName(partitionKey));\n\t\t\tconst docRef = collection.doc(id);\n\n\t\t\tif (!Is.arrayValue(conditions)) {\n\t\t\t\tawait docRef.delete();\n\t\t\t} else {\n\t\t\t\tawait this._firestoreClient.runTransaction(async transaction => {\n\t\t\t\t\tconst docSnapshot = await transaction.get(docRef);\n\n\t\t\t\t\tif (docSnapshot.exists) {\n\t\t\t\t\t\tconst data = docSnapshot.data() as T;\n\t\t\t\t\t\tif (\n\t\t\t\t\t\t\tEntityConditions.check(data, {\n\t\t\t\t\t\t\t\tconditions: conditions.map(c => ({\n\t\t\t\t\t\t\t\t\tproperty: c.property as string,\n\t\t\t\t\t\t\t\t\tcomparison: ComparisonOperator.Equals,\n\t\t\t\t\t\t\t\t\tvalue: c.value\n\t\t\t\t\t\t\t\t}))\n\t\t\t\t\t\t\t})\n\t\t\t\t\t\t) {\n\t\t\t\t\t\t\ttransaction.delete(docRef);\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t}\n\t\t} catch (err) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tFirestoreEntityStorageConnector.CLASS_NAME,\n\t\t\t\t\"removeEntityFailed\",\n\t\t\t\t{ id },\n\t\t\t\terr\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Find all the entities which match the conditions.\n\t * @param conditions The conditions to match for the entities.\n\t * @param sortProperties The optional sort order.\n\t * @param properties The optional properties to return, defaults to all.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit The suggested number of entities to return in each chunk.\n\t * @returns The matching entities and a cursor for the next page.\n\t */\n\tpublic async query(\n\t\tconditions?: EntityCondition<T>,\n\t\tsortProperties?: { property: keyof T; sortDirection: SortDirection }[],\n\t\tproperties?: (keyof T)[],\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The entities, which can be partial if a limited keys list was provided.\n\t\t */\n\t\tentities: Partial<T>[];\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t}> {\n\t\tconst queryDescription: string[] = [];\n\n\t\tconst contextIds = await ContextIdStore.getContextIds();\n\t\tconst partitionKey = ContextIdHelper.combinedContextKey(contextIds, this._partitionContextIds);\n\n\t\ttry {\n\t\t\tconst collection = this._firestoreClient.collection(this.collectionName(partitionKey));\n\t\t\tlet query = collection as Query;\n\n\t\t\tif (!Is.empty(conditions)) {\n\t\t\t\tquery = this.applyConditions(query, conditions);\n\t\t\t\tqueryDescription.push(`Conditions: ${JSON.stringify(conditions)}`);\n\t\t\t}\n\n\t\t\tif (Is.arrayValue(sortProperties)) {\n\t\t\t\tfor (const { property, sortDirection } of sortProperties) {\n\t\t\t\t\tquery = query.orderBy(\n\t\t\t\t\t\tproperty as string,\n\t\t\t\t\t\tsortDirection === SortDirection.Ascending ? \"asc\" : \"desc\"\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t\tqueryDescription.push(`Sort: ${JSON.stringify(sortProperties)}`);\n\t\t\t}\n\n\t\t\tif (Is.stringValue(cursor)) {\n\t\t\t\tconst cursorDoc = await this._firestoreClient.doc(cursor).get();\n\t\t\t\tif (cursorDoc?.exists) {\n\t\t\t\t\tquery = query.startAfter(cursorDoc);\n\t\t\t\t}\n\t\t\t\tqueryDescription.push(`Cursor: ${cursor}`);\n\t\t\t}\n\n\t\t\tconst finalLimit = limit ?? FirestoreEntityStorageConnector._DEFAULT_LIMIT;\n\t\t\tquery = query.limit(finalLimit);\n\t\t\tqueryDescription.push(`Limit: ${finalLimit}`);\n\n\t\t\tif (properties) {\n\t\t\t\tquery = query.select(...(properties as string[]));\n\t\t\t\tqueryDescription.push(`Properties: ${properties.join(\", \")}`);\n\t\t\t}\n\n\t\t\tconst querySnapshot = await query.get();\n\t\t\tconst entities = querySnapshot.docs.map((doc: DocumentSnapshot) => doc.data() as T);\n\n\t\t\tlet nextCursor: string | undefined;\n\t\t\tif (entities.length === finalLimit) {\n\t\t\t\tnextCursor = querySnapshot.docs[querySnapshot.docs.length - 1].ref.path;\n\t\t\t}\n\n\t\t\treturn {\n\t\t\t\tentities,\n\t\t\t\tcursor: nextCursor\n\t\t\t};\n\t\t} catch (err) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tFirestoreEntityStorageConnector.CLASS_NAME,\n\t\t\t\t\"queryFailed\",\n\t\t\t\t{ queryDescription: queryDescription.join(\"; \") },\n\t\t\t\terr\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Delete all entities in the collection.\n\t * @returns Nothing.\n\t * @internal\n\t */\n\tpublic async collectionDelete(): Promise<void> {\n\t\tconst collection = this._firestoreClient.collection(this.collectionName());\n\t\tconst batchSize = 500;\n\t\tconst query = collection.limit(batchSize);\n\n\t\ttry {\n\t\t\tawait this.deleteQueryBatch(query, batchSize);\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tFirestoreEntityStorageConnector.CLASS_NAME,\n\t\t\t\t\"collectionDeleteFailed\",\n\t\t\t\t{ collectionName: this._config.collectionName },\n\t\t\t\terror\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Apply conditions to a Firestore query.\n\t * @param query The initial query.\n\t * @param condition The condition to apply.\n\t * @returns The updated query.\n\t * @internal\n\t */\n\tprivate applyConditions(query: Query, condition: EntityCondition<T>): Query {\n\t\tif (\"conditions\" in condition) {\n\t\t\t// It's a group of conditions\n\t\t\tfor (const c of condition.conditions) {\n\t\t\t\tquery = this.applyConditions(query, c);\n\t\t\t}\n\t\t\treturn query;\n\t\t}\n\t\t// It's a single condition\n\t\tconst { property, value, comparison } = condition;\n\t\tswitch (comparison) {\n\t\t\tcase ComparisonOperator.Equals:\n\t\t\t\treturn query.where(property, \"==\", value);\n\t\t\tcase ComparisonOperator.NotEquals:\n\t\t\t\treturn query.where(property, \"!=\", value);\n\t\t\tcase ComparisonOperator.GreaterThan:\n\t\t\t\treturn query.where(property, \">\", value);\n\t\t\tcase ComparisonOperator.LessThan:\n\t\t\t\treturn query.where(property, \"<\", value);\n\t\t\tcase ComparisonOperator.GreaterThanOrEqual:\n\t\t\t\treturn query.where(property, \">=\", value);\n\t\t\tcase ComparisonOperator.LessThanOrEqual:\n\t\t\t\treturn query.where(property, \"<=\", value);\n\t\t\tcase ComparisonOperator.In:\n\t\t\t\treturn query.where(property, \"in\", value as unknown[]);\n\t\t\tcase ComparisonOperator.Includes:\n\t\t\t\treturn query.where(property, \"array-contains\", value);\n\t\t\tcase ComparisonOperator.NotIncludes:\n\t\t\tdefault:\n\t\t\t\tthrow new GeneralError(\n\t\t\t\t\tFirestoreEntityStorageConnector.CLASS_NAME,\n\t\t\t\t\t\"unsupportedComparisonOperator\",\n\t\t\t\t\t{ comparison }\n\t\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Delete all entities in the collection.\n\t * @returns Nothing.\n\t * @internal\n\t */\n\tprivate async deleteQueryBatch(query: Query, batchSize: number): Promise<void> {\n\t\tconst snapshot = await query.get();\n\n\t\tif (snapshot.size === 0) {\n\t\t\treturn;\n\t\t}\n\n\t\tconst batch = this._firestoreClient.batch();\n\t\tfor (const doc of snapshot.docs) {\n\t\t\tbatch.delete(doc.ref);\n\t\t}\n\n\t\tawait batch.commit();\n\n\t\tif (snapshot.size === batchSize) {\n\t\t\tawait this.deleteQueryBatch(query, batchSize);\n\t\t}\n\t}\n\n\t/**\n\t * Get the collection name based on partition key.\n\t * @returns The collection name.\n\t * @internal\n\t */\n\tprivate collectionName(partitionKey?: string): string {\n\t\treturn `${this._config.collectionName}_${partitionKey ?? \"default\"}`;\n\t}\n}\n"]}

package/dist/es/index.js

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

package/dist/es/index.js.map

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

package/dist/es/models/IFirestoreEntityStorageConnectorConfig.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IFirestoreEntityStorageConnectorConfig.js.map

package/dist/es/models/IFirestoreEntityStorageConnectorConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFirestoreEntityStorageConnectorConfig.js","sourceRoot":"","sources":["../../../src/models/IFirestoreEntityStorageConnectorConfig.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Configuration for the Firestore Entity Storage Connector.\n */\nexport interface IFirestoreEntityStorageConnectorConfig {\n\t/**\n\t * The GCP project ID.\n\t */\n\tprojectId: string;\n\n\t/**\n\t * The database ID, if omitted default database will be used.\n\t */\n\tdatabaseId?: string;\n\n\t/**\n\t * The name of the collection for the storage.\n\t */\n\tcollectionName: string;\n\n\t/**\n\t * The GCP credentials, a base64 encoded version of the JWTInput data type.\n\t */\n\tcredentials?: string;\n\n\t/**\n\t * It's usually only used with an emulator (e.g., \"localhost:20200\").\n\t */\n\tendpoint?: string;\n\n\t/**\n\t * Optional settings for Firestore client initialization.\n\t */\n\tsettings?: {\n\t\t/**\n\t\t * The maximum number of idle channels to keep open.\n\t\t */\n\t\tmaxIdleChannels?: number;\n\n\t\t/**\n\t\t * The custom timeout for requests (in milliseconds).\n\t\t */\n\t\ttimeout?: number;\n\t};\n}\n"]}

package/dist/es/models/IFirestoreEntityStorageConnectorConstructorOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IFirestoreEntityStorageConnectorConstructorOptions.js.map

package/dist/es/models/IFirestoreEntityStorageConnectorConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFirestoreEntityStorageConnectorConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IFirestoreEntityStorageConnectorConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IFirestoreEntityStorageConnectorConfig } from \"./IFirestoreEntityStorageConnectorConfig.js\";\n\n/**\n * Options for the Firestore Entity Storage Connector constructor.\n */\nexport interface IFirestoreEntityStorageConnectorConstructorOptions {\n\t/**\n\t * The schema for the entity.\n\t */\n\tentitySchema: string;\n\n\t/**\n\t * The keys to use from the context ids to create partitions.\n\t */\n\tpartitionContextIds?: string[];\n\n\t/**\n\t * The type of logging component to use, defaults to no logging.\n\t */\n\tloggingComponentType?: string;\n\n\t/**\n\t * The configuration for the connector.\n\t */\n\tconfig: IFirestoreEntityStorageConnectorConfig;\n}\n"]}

package/dist/types/firestoreEntityStorageConnector.d.ts

@@ -1,6 +1,6 @@
 import { type EntityCondition, type IEntitySchema, SortDirection } from "@twin.org/entity";
 import type { IEntityStorageConnector } from "@twin.org/entity-storage-models";
-import type { IFirestoreEntityStorageConnectorConstructorOptions } from "./models/IFirestoreEntityStorageConnectorConstructorOptions";
+import type { IFirestoreEntityStorageConnectorConstructorOptions } from "./models/IFirestoreEntityStorageConnectorConstructorOptions.js";
 /**
  * Class for performing entity storage operations using Firestore.
  */
@@ -8,23 +8,28 @@ 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.
      */
     constructor(options: IFirestoreEntityStorageConnectorConstructorOptions);
     /**
-     * Bootstrap the component by creating and initializing any resources it needs.
-     * @param nodeLoggingComponentType The node logging component type.
-     * @returns True if the bootstrapping process was successful.
+     * Returns the class name of the component.
+     * @returns The class name of the component.
      */
-    bootstrap(nodeLoggingComponentType?: string): Promise<boolean>;
+    className(): string;
     /**
      * Get the schema for the entities.
      * @returns The schema for the entities.
      */
     getSchema(): IEntitySchema;
+    /**
+     * Bootstrap the component by creating and initializing any resources it needs.
+     * @param nodeLoggingComponentType The node logging component type.
+     * @returns True if the bootstrapping process was successful.
+     */
+    bootstrap(nodeLoggingComponentType?: string): Promise<boolean>;
     /**
      * Get an entity.
      * @param id The id of the entity to get.
@@ -61,14 +66,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/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./firestoreEntityStorageConnector";
-export * from "./models/IFirestoreEntityStorageConnectorConfig";
-export * from "./models/IFirestoreEntityStorageConnectorConstructorOptions";
+export * from "./firestoreEntityStorageConnector.js";
+export * from "./models/IFirestoreEntityStorageConnectorConfig.js";
+export * from "./models/IFirestoreEntityStorageConnectorConstructorOptions.js";

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:8580").
+     * It's usually only used with an emulator (e.g., "localhost:20200").
      */
     endpoint?: string;
     /**

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

@@ -1,4 +1,4 @@
-import type { IFirestoreEntityStorageConnectorConfig } from "./IFirestoreEntityStorageConnectorConfig";
+import type { IFirestoreEntityStorageConnectorConfig } from "./IFirestoreEntityStorageConnectorConfig.js";
 /**
  * Options for the Firestore Entity Storage Connector constructor.
  */
@@ -7,6 +7,10 @@ export interface IFirestoreEntityStorageConnectorConstructorOptions {
      * The schema for the entity.
      */
     entitySchema: string;
+    /**
+     * The keys to use from the context ids to create partitions.
+     */
+    partitionContextIds?: string[];
     /**
      * The type of logging component to use, defaults to no logging.
      */

package/docs/changelog.md

@@ -1,5 +1,68 @@
 # @twin.org/entity-storage-connector-gcp-firestore - Changelog
 
+## [0.0.3-next.2](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-gcp-firestore-v0.0.3-next.1...entity-storage-connector-gcp-firestore-v0.0.3-next.2) (2025-11-13)
+
+
+### 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.3-next.1 to 0.0.3-next.2
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.1 to 0.0.3-next.2
+
+## [0.0.3-next.1](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-gcp-firestore-v0.0.3-next.0...entity-storage-connector-gcp-firestore-v0.0.3-next.1) (2025-11-10)
+
+
+### Features
+
+* add context id features ([#55](https://github.com/twinfoundation/entity-storage/issues/55)) ([99c15a2](https://github.com/twinfoundation/entity-storage/commit/99c15a257539b61d9da63649ce573ebf47699fc9))
+* 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))
+* add validate-locales ([e66ef0d](https://github.com/twinfoundation/entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
+* CosmosDB Entity Storage Connector ([#20](https://github.com/twinfoundation/entity-storage/issues/20)) ([0ae8371](https://github.com/twinfoundation/entity-storage/commit/0ae8371d81ce7e20c0b0397144499dc3e17ffa0a))
+* eslint migration to flat config ([f033b64](https://github.com/twinfoundation/entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
+* logging naming consistency ([f99d12d](https://github.com/twinfoundation/entity-storage/commit/f99d12dea04b6d4f2b5632ff5473e9ec7d5f9055))
+* synchronised storage ([#44](https://github.com/twinfoundation/entity-storage/issues/44)) ([94e10e2](https://github.com/twinfoundation/entity-storage/commit/94e10e26d1feec801449dc04af7a9757ac7495ff))
+* update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
+* update framework core ([b59a380](https://github.com/twinfoundation/entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
+* 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.3-next.0 to 0.0.3-next.1
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.0 to 0.0.3-next.1
+
+## [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)
 
 

package/docs/reference/classes/FirestoreEntityStorageConnector.md

@@ -36,39 +36,27 @@ 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**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
-
-Bootstrap the component by creating and initializing any resources it needs.
-
-#### Parameters
-
-##### nodeLoggingComponentType?
+### className()
 
-`string`
+> **className**(): `string`
 
-The node logging component type.
+Returns the class name of the component.
 
 #### Returns
 
-`Promise`\<`boolean`\>
+`string`
 
-True if the bootstrapping process was successful.
+The class name of the component.
 
 #### Implementation of
 
-`IEntityStorageConnector.bootstrap`
+`IEntityStorageConnector.className`
 
 ***
 
@@ -90,9 +78,35 @@ The schema for the entities.
 
 ***
 
+### bootstrap()
+
+> **bootstrap**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
+
+Bootstrap the component by creating and initializing any resources it needs.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the bootstrapping process was successful.
+
+#### Implementation of
+
+`IEntityStorageConnector.bootstrap`
+
+***
+
 ### get()
 
-> **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`undefined` \| `T`\>
+> **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`T` \| `undefined`\>
 
 Get an entity.
 
@@ -118,7 +132,7 @@ The optional conditions to apply to the query.
 
 #### Returns
 
-`Promise`\<`undefined` \| `T`\>
+`Promise`\<`T` \| `undefined`\>
 
 The object if it can be found or undefined.
 
@@ -194,7 +208,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 +236,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:8580").
+It's usually only used with an emulator (e.g., "localhost:20200").
 
 ***
 

package/docs/reference/interfaces/IFirestoreEntityStorageConnectorConstructorOptions.md

@@ -12,6 +12,14 @@ The schema for the entity.
 
 ***
 
+### partitionContextIds?
+
+> `optional` **partitionContextIds**: `string`[]
+
+The keys to use from the context ids to create partitions.
+
+***
+
 ### loggingComponentType?
 
 > `optional` **loggingComponentType**: `string`

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.2-next.9",
+	"version": "0.0.3-next.2",
 	"description": "Entity Storage connector implementation using GCP Firestore storage",
 	"repository": {
 		"type": "git",
@@ -14,27 +14,26 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@google-cloud/firestore": "7.11.6",
+		"@google-cloud/firestore": "8.0.0",
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "0.0.2-next.9",
+		"@twin.org/entity-storage-models": "0.0.3-next.2",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
@@ -53,5 +52,9 @@
 		"connector",
 		"adapter",
 		"integration"
-	]
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/entity-storage/issues"
+	},
+	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,389 +0,0 @@
-'use strict';
-
-var firestore = require('@google-cloud/firestore');
-var core = require('@twin.org/core');
-var entity = require('@twin.org/entity');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class for performing entity storage operations using Firestore.
- */
-class FirestoreEntityStorageConnector {
-    /**
-     * Limit the number of entities when finding.
-     * @internal
-     */
-    static _PAGE_SIZE = 40;
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "FirestoreEntityStorageConnector";
-    /**
-     * The schema for the entity.
-     * @internal
-     */
-    _entitySchema;
-    /**
-     * The primary key.
-     * @internal
-     */
-    _primaryKey;
-    /**
-     * The configuration for the connector.
-     * @internal
-     */
-    _config;
-    /**
-     * The Firestore client.
-     * @internal
-     */
-    _firestoreClient;
-    /**
-     * The Firestore collection.
-     * @internal
-     */
-    _collection;
-    /**
-     * Create a new instance of 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);
-        let credentials;
-        if (!core.Is.empty(options.config.credentials)) {
-            core.Guards.stringBase64(this.CLASS_NAME, "options.config.credentials", options.config.credentials);
-            credentials = core.ObjectHelper.fromBytes(core.Converter.base64ToBytes(options.config.credentials));
-        }
-        this._config = options.config;
-        this._entitySchema = entity.EntitySchemaFactory.get(options.entitySchema);
-        this._primaryKey = entity.EntitySchemaHelper.getPrimaryKey(this._entitySchema);
-        const firestoreOptions = {
-            projectId: this._config.projectId,
-            databaseId: this._config.databaseId,
-            collectionName: this._config.collectionName,
-            maxIdleChannels: this._config.settings?.maxIdleChannels,
-            timeout: this._config.settings?.timeout,
-            credentials
-        };
-        if (core.Is.stringValue(this._config.endpoint)) {
-            firestoreOptions.host = this._config.endpoint;
-            firestoreOptions.ssl = false;
-        }
-        this._firestoreClient = new firestore.Firestore(firestoreOptions);
-        this._collection = this._firestoreClient.collection(this._config.collectionName);
-    }
-    /**
-     * Bootstrap the component by creating and initializing any resources it needs.
-     * @param nodeLoggingComponentType The node logging component type.
-     * @returns True if the bootstrapping process was successful.
-     */
-    async bootstrap(nodeLoggingComponentType) {
-        const nodeLogging = core.ComponentFactory.getIfExists(nodeLoggingComponentType);
-        try {
-            await nodeLogging?.log({
-                level: "info",
-                source: this.CLASS_NAME,
-                ts: Date.now(),
-                message: "firestoreCreating",
-                data: {
-                    projectId: this._config.projectId,
-                    collectionName: this._config.collectionName
-                }
-            });
-            // Firestore doesn't require explicit collection creation
-            // Perform a small write operation to ensure connectivity
-            const testDoc = this._firestoreClient.collection(this._config.collectionName).doc("test");
-            await testDoc.set({ test: true });
-            await testDoc.delete();
-            await nodeLogging?.log({
-                level: "info",
-                source: this.CLASS_NAME,
-                ts: Date.now(),
-                message: "firestoreCreated",
-                data: {
-                    projectId: this._config.projectId,
-                    collectionName: this._config.collectionName
-                }
-            });
-            return true;
-        }
-        catch (err) {
-            await nodeLogging?.log({
-                level: "error",
-                source: this.CLASS_NAME,
-                ts: Date.now(),
-                message: "firestoreCreationFailed",
-                error: core.BaseError.fromError(err),
-                data: {
-                    projectId: this._config.projectId,
-                    collectionName: this._config.collectionName
-                }
-            });
-            return false;
-        }
-    }
-    /**
-     * Get the schema for the entities.
-     * @returns The schema for the entities.
-     */
-    getSchema() {
-        return this._entitySchema;
-    }
-    /**
-     * Get an entity.
-     * @param id The id of the entity to get.
-     * @param secondaryIndex The optional secondary index to use.
-     * @param conditions The optional conditions to apply to the query.
-     * @returns The object if it can be found or undefined.
-     */
-    async get(id, secondaryIndex, conditions) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
-        try {
-            if (!core.Is.stringValue(secondaryIndex) && !core.Is.arrayValue(conditions)) {
-                const docRef = this._collection.doc(id);
-                const doc = await docRef.get();
-                if (doc.exists) {
-                    return doc.data();
-                }
-            }
-            // Use secondaryIndex and/or conditions to construct a query
-            let query = this._collection;
-            if (secondaryIndex) {
-                query = query.where(secondaryIndex, "==", id);
-            }
-            else {
-                // If no secondaryIndex, include primary key in conditions
-                query = query.where(this._primaryKey.property, "==", id);
-            }
-            if (core.Is.arrayValue(conditions)) {
-                for (const condition of conditions) {
-                    query = query.where(condition.property, "==", condition.value);
-                }
-            }
-            const querySnapshot = await query.limit(1).get();
-            if (!querySnapshot.empty) {
-                return querySnapshot.docs[0].data();
-            }
-        }
-        catch (err) {
-            throw new core.GeneralError(this.CLASS_NAME, "getEntityFailed", { id }, err);
-        }
-    }
-    /**
-     * Set an entity.
-     * @param entity The entity to set.
-     * @param conditions The optional conditions to apply to the update.
-     * @returns Nothing.
-     */
-    async set(entity$1, conditions) {
-        core.Guards.object(this.CLASS_NAME, "entity", entity$1);
-        entity.EntitySchemaHelper.validateEntity(entity$1, this.getSchema());
-        try {
-            const id = entity$1[this._primaryKey.property];
-            const entityCopy = { ...entity$1 };
-            // Handle indexing field
-            if (entityCopy.valueArray && core.Is.array(entityCopy.valueArray)) {
-                const valueArrayFields = entityCopy.valueArray
-                    .filter((item) => core.Is.notEmpty(item))
-                    .map(item => `${item.field}:${item.value}`);
-                entityCopy.valueArrayFields = valueArrayFields;
-            }
-            const docRef = this._collection.doc(id);
-            if (!core.Is.arrayValue(conditions)) {
-                await docRef.set(entityCopy);
-            }
-            else {
-                await this._firestoreClient.runTransaction(async (transaction) => {
-                    const docSnapshot = await transaction.get(docRef);
-                    if (!docSnapshot.exists) {
-                        transaction.set(docRef, entityCopy);
-                    }
-                    else {
-                        const data = docSnapshot.data();
-                        let conditionsMet = true;
-                        for (const condition of conditions) {
-                            if (data[condition.property] !== condition.value) {
-                                conditionsMet = false;
-                                break;
-                            }
-                        }
-                        if (conditionsMet) {
-                            transaction.set(docRef, entityCopy);
-                        }
-                    }
-                });
-            }
-        }
-        catch (err) {
-            throw new core.GeneralError(this.CLASS_NAME, "setEntityFailed", { entity: entity$1 }, err);
-        }
-    }
-    /**
-     * Remove the entity.
-     * @param id The id of the entity to remove.
-     * @param conditions The optional conditions to apply to the delete.
-     * @returns Nothing.
-     */
-    async remove(id, conditions) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
-        try {
-            const docRef = this._collection.doc(id);
-            if (!core.Is.arrayValue(conditions)) {
-                await docRef.delete();
-            }
-            else {
-                await this._firestoreClient.runTransaction(async (transaction) => {
-                    const docSnapshot = await transaction.get(docRef);
-                    if (docSnapshot.exists) {
-                        const data = docSnapshot.data();
-                        let conditionsMet = true;
-                        for (const condition of conditions) {
-                            if (data[condition.property] !== condition.value) {
-                                conditionsMet = false;
-                                break;
-                            }
-                        }
-                        if (conditionsMet) {
-                            transaction.delete(docRef);
-                        }
-                    }
-                });
-            }
-        }
-        catch (err) {
-            throw new core.GeneralError(this.CLASS_NAME, "removeEntityFailed", { id }, err);
-        }
-    }
-    /**
-     * Find all the entities which match the conditions.
-     * @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.
-     * @returns The matching entities and a cursor for the next page.
-     */
-    async query(conditions, sortProperties, properties, cursor, pageSize) {
-        const queryDescription = [];
-        try {
-            let query = this._collection;
-            if (conditions) {
-                query = this.applyConditions(query, conditions);
-                queryDescription.push(`Conditions: ${JSON.stringify(conditions)}`);
-            }
-            if (core.Is.arrayValue(sortProperties)) {
-                for (const { property, sortDirection } of sortProperties) {
-                    query = query.orderBy(property, sortDirection === entity.SortDirection.Ascending ? "asc" : "desc");
-                }
-                queryDescription.push(`Sort: ${JSON.stringify(sortProperties)}`);
-            }
-            if (core.Is.stringValue(cursor)) {
-                const cursorDoc = await this._firestoreClient.doc(cursor).get();
-                if (cursorDoc?.exists) {
-                    query = query.startAfter(cursorDoc);
-                }
-                queryDescription.push(`Cursor: ${cursor}`);
-            }
-            const limit = pageSize ?? FirestoreEntityStorageConnector._PAGE_SIZE;
-            query = query.limit(limit);
-            queryDescription.push(`Limit: ${limit}`);
-            if (properties) {
-                query = query.select(...properties);
-                queryDescription.push(`Properties: ${properties.join(", ")}`);
-            }
-            const querySnapshot = await query.get();
-            const entities = querySnapshot.docs.map((doc) => doc.data());
-            let nextCursor;
-            if (entities.length === limit) {
-                nextCursor = querySnapshot.docs[querySnapshot.docs.length - 1].ref.path;
-            }
-            return {
-                entities,
-                cursor: nextCursor
-            };
-        }
-        catch (err) {
-            throw new core.GeneralError(this.CLASS_NAME, "queryFailed", { queryDescription: queryDescription.join("; ") }, err);
-        }
-    }
-    /**
-     * Delete all entities in the collection.
-     * @returns Nothing.
-     * @internal
-     */
-    async collectionDelete() {
-        const collection = this._collection;
-        const batchSize = 500;
-        const query = collection.limit(batchSize);
-        try {
-            await this.deleteQueryBatch(query, batchSize);
-        }
-        catch (error) {
-            throw new core.GeneralError(this.CLASS_NAME, "collectionDeleteFailed", { collectionName: this._config.collectionName }, error);
-        }
-    }
-    /**
-     * Apply conditions to a Firestore query.
-     * @param query The initial query.
-     * @param condition The condition to apply.
-     * @returns The updated query.
-     * @internal
-     */
-    applyConditions(query, condition) {
-        if ("conditions" in condition) {
-            // It's a group of conditions
-            for (const c of condition.conditions) {
-                query = this.applyConditions(query, c);
-            }
-            return query;
-        }
-        // It's a single condition
-        const { property, value, comparison } = condition;
-        switch (comparison) {
-            case entity.ComparisonOperator.Equals:
-                return query.where(property, "==", value);
-            case entity.ComparisonOperator.NotEquals:
-                return query.where(property, "!=", value);
-            case entity.ComparisonOperator.GreaterThan:
-                return query.where(property, ">", value);
-            case entity.ComparisonOperator.LessThan:
-                return query.where(property, "<", value);
-            case entity.ComparisonOperator.GreaterThanOrEqual:
-                return query.where(property, ">=", value);
-            case entity.ComparisonOperator.LessThanOrEqual:
-                return query.where(property, "<=", value);
-            case entity.ComparisonOperator.In:
-                return query.where(property, "in", value);
-            case entity.ComparisonOperator.Includes:
-                return query.where(property, "array-contains", value);
-            default:
-                throw new core.GeneralError(this.CLASS_NAME, "unsupportedComparisonOperator", { comparison });
-        }
-    }
-    /**
-     * Delete all entities in the collection.
-     * @returns Nothing.
-     * @internal
-     */
-    async deleteQueryBatch(query, batchSize) {
-        const snapshot = await query.get();
-        if (snapshot.size === 0) {
-            return;
-        }
-        const batch = this._firestoreClient.batch();
-        for (const doc of snapshot.docs) {
-            batch.delete(doc.ref);
-        }
-        await batch.commit();
-        if (snapshot.size === batchSize) {
-            await this.deleteQueryBatch(query, batchSize);
-        }
-    }
-}
-
-exports.FirestoreEntityStorageConnector = FirestoreEntityStorageConnector;

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

@@ -1,14 +0,0 @@
-import type { IValueType } from "./IValueType";
-/**
- * Interface representing an entity with indexing fields.
- */
-export interface IEntityWithIndexing {
-    /**
-     * The value array.
-     */
-    valueArray?: IValueType[];
-    /**
-     * The value array fields.
-     */
-    valueArrayFields?: string[];
-}

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

@@ -1,13 +0,0 @@
-/**
- * Interface representing a value type with a field and a value.
- */
-export interface IValueType {
-    /**
-     * The field name.
-     */
-    field: string;
-    /**
-     * The value.
-     */
-    value: string;
-}