@travetto/model-firestore 8.0.0-alpha.16 → 8.0.0-alpha.19

package/README.md

@@ -17,7 +17,7 @@ This module provides an [Firestore](https://firebase.google.com/docs/firestore)-
 
 Supported features:
    *  [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/types/crud.ts#L11)
-   *  [Indexed](https://github.com/travetto/travetto/tree/main/module/model-indexed/src/types/service.ts#L15)
+   *  [Indexed](https://github.com/travetto/travetto/tree/main/module/model-indexed/src/types/service.ts#L16)
 
 Out of the box, by installing the module, everything should be wired up by default.If you need to customize any aspect of the source or config, you can override and register it with the [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.") module.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-firestore",
-  "version": "8.0.0-alpha.16",
+  "version": "8.0.0-alpha.19",
   "description": "Firestore backing for the travetto model module.",
   "keywords": [
     "typescript",
@@ -25,14 +25,14 @@
     "directory": "module/model-firestore"
   },
   "dependencies": {
-    "@google-cloud/firestore": "^8.5.0",
-    "@travetto/config": "^8.0.0-alpha.14",
-    "@travetto/model": "^8.0.0-alpha.14",
-    "@travetto/model-indexed": "^8.0.0-alpha.16",
-    "@travetto/runtime": "^8.0.0-alpha.13"
+    "@google-cloud/firestore": "^8.6.0",
+    "@travetto/config": "^8.0.0-alpha.17",
+    "@travetto/model": "^8.0.0-alpha.17",
+    "@travetto/model-indexed": "^8.0.0-alpha.19",
+    "@travetto/runtime": "^8.0.0-alpha.16"
   },
   "peerDependencies": {
-    "@travetto/cli": "^8.0.0-alpha.19"
+    "@travetto/cli": "^8.0.0-alpha.22"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/service.ts

@@ -1,6 +1,6 @@
 import { type DocumentData, FieldValue, Firestore, type Query } from '@google-cloud/firestore';
 
-import { castTo, JSONUtil, ShutdownManager, type Class } from '@travetto/runtime';
+import { castTo, JSONUtil, ShutdownManager, type Class, RuntimeError } from '@travetto/runtime';
 import { Injectable, PostConstruct } from '@travetto/di';
 import {
   type ModelCrudSupport, ModelRegistryIndex, type ModelStorageSupport, type ModelType, NotFoundError, type OptionalId, ModelCrudUtil,
@@ -9,7 +9,8 @@ import {
 import {
   type ModelIndexedSupport, type KeyedIndexSelection, type KeyedIndexBody, type ModelPageOptions, ModelIndexedUtil,
   type SingleItemIndex, type SortedIndexSelection, type ModelPageResult, type SortedIndex, type FullKeyedIndexBody,
-  type FullKeyedIndexWithPartialBody, ModelIndexedComputedIndex, warnIfIndexedUniqueIndex, warnIfNonIndexedIndex
+  type FullKeyedIndexWithPartialBody, ModelIndexedComputedIndex, warnIfIndexedUniqueIndex, warnIfNonIndexedIndex,
+  type ModelIndexedSearchOptions, type SortedIndexSelectionType
 } from '@travetto/model-indexed';
 
 import type { FirestoreModelConfig } from './config.ts';
@@ -58,14 +59,13 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
     if (!item || item.empty) {
       throw new NotFoundError(`${cls.name} Index=${idx}`, computed.getKey());
     }
-    return item.docs[0].id;
+    if (item.size > 1) {
+      throw new RuntimeError(`Multiple items found for ${cls.name} Index=${idx}`);
+    }
+    return item.docs[0].data().id;
   }
 
-  #buildIndexQuery<
-    T extends ModelType,
-    K extends KeyedIndexSelection<T>,
-    S extends SortedIndexSelection<T>
-  >(cls: Class<T>, idx: SortedIndex<T, K, S>, body: KeyedIndexBody<T, K>): Query {
+  #buildIndexQuery<T extends ModelType>(cls: Class<T>, idx: SortedIndex<T>, body: KeyedIndexBody<T>): Query {
     ModelCrudUtil.ensureNotSubType(cls);
     const computed = ModelIndexedComputedIndex.get(idx, body).validate();
 
@@ -92,19 +92,17 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
     while (!(options?.abort?.aborted) && produced < limit) {
       const query = queryBuilder().limit(batchSize).offset(offset);
 
-      let { docs } = await query.get();
-      if (docs.length === 0) {
+      const { docs, size } = await query.get();
+      if (size === 0) {
         break;
       }
 
-      if (produced + docs.length > limit) {
-        docs = docs.slice(0, limit - produced);
-      }
+      const remaining = (produced + size > limit) ? docs.slice(0, limit - produced) : docs;
 
-      offset += docs.length;
+      offset += size;
 
       const items = await ModelCrudUtil.filterOutNotFound(
-        docs.map(item => ModelCrudUtil.load(cls, item.data()!)));
+        remaining.map(item => ModelCrudUtil.load(cls, item.data()!)));
       produced += items.length;
 
       yield { items, nextOffset: offset };
@@ -113,7 +111,6 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
 
   @PostConstruct()
   async initializeClient(): Promise<void> {
-    globalThis.devProcessWarningExclusions?.push((_, category) => category === 'MetadataLookupWarning');
     this.client = new Firestore({ ...this.config, useBigInt: true });
     ShutdownManager.signal.addEventListener('abort', () => this.client.terminate());
   }
@@ -269,4 +266,26 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
       yield items;
     }
   }
+
+  async suggestByIndex<
+    T extends ModelType,
+    S extends SortedIndexSelection<T>,
+    K extends KeyedIndexSelection<T>,
+    B extends SortedIndexSelectionType<T, S> & string
+  >(cls: Class<T>, idx: SortedIndex<T, K, S>, body: KeyedIndexBody<T, K>, prefix: B, options?: ModelIndexedSearchOptions): Promise<T[]> {
+    const results: T[] = [];
+
+    const field = idx.sortTemplate[0].path.join('.');
+
+    for await (const { items } of this.#scanCollection(cls,
+      () => this.#buildIndexQuery(cls, idx, body)
+        .where(field, '>=', prefix)
+        .where(field, '<', `${prefix}\uf8ff`),
+      { limit: 10, ...options })
+    ) {
+      results.push(...items);
+    }
+
+    return results;
+  }
 }