@travetto/model-firestore 8.0.0-alpha.27 → 8.0.0-alpha.29

package/README.md

@@ -13,11 +13,11 @@ npm install @travetto/model-firestore
 yarn add @travetto/model-firestore
 ```
 
-This module provides an [Firestore](https://firebase.google.com/docs/firestore)-based implementation of the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.").  This source allows the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") module to read, write and query against [Firestore](https://firebase.google.com/docs/firestore). 
+This module provides an [Firestore](https://firebase.google.com/docs/firestore)-based implementation of the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations."). This source allows the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") module to read, write and query against [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#L16)
+   *  [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/types/crud.ts#L10)
+   *  [Indexed](https://github.com/travetto/travetto/tree/main/module/model-indexed/src/types/service.ts#L21)
 
 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/__index__.ts

@@ -1,2 +1,2 @@
+export * from './src/config.ts';
 export * from './src/service.ts';
-export * from './src/config.ts';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-firestore",
-  "version": "8.0.0-alpha.27",
+  "version": "8.0.0-alpha.29",
   "description": "Firestore backing for the travetto model module.",
   "keywords": [
     "typescript",
@@ -26,13 +26,13 @@
   },
   "dependencies": {
     "@google-cloud/firestore": "^8.6.0",
-    "@travetto/config": "^8.0.0-alpha.20",
-    "@travetto/model": "^8.0.0-alpha.21",
-    "@travetto/model-indexed": "^8.0.0-alpha.23",
-    "@travetto/runtime": "^8.0.0-alpha.19"
+    "@travetto/config": "^8.0.0-alpha.22",
+    "@travetto/model": "^8.0.0-alpha.23",
+    "@travetto/model-indexed": "^8.0.0-alpha.25",
+    "@travetto/runtime": "^8.0.0-alpha.20"
   },
   "peerDependencies": {
-    "@travetto/cli": "^8.0.0-alpha.26"
+    "@travetto/cli": "^8.0.0-alpha.28"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/config.ts

@@ -1,7 +1,7 @@
-import { JSONUtil, Runtime, RuntimeResources } from '@travetto/runtime';
 import { Config } from '@travetto/config';
-import { Schema, SchemaValidator } from '@travetto/schema';
 import { PostConstruct } from '@travetto/di';
+import { JSONUtil, Runtime, RuntimeResources } from '@travetto/runtime';
+import { Schema, SchemaValidator } from '@travetto/schema';
 
 @Schema()
 class FirestoreModelConfigCredentials {
@@ -34,4 +34,4 @@ export class FirestoreModelConfig {
       await SchemaValidator.validate(FirestoreModelConfigCredentials, this.credentials);
     }
   }
-}
+}

package/src/service.ts

@@ -1,17 +1,35 @@
 import { type DocumentData, FieldValue, Firestore, type Query } from '@google-cloud/firestore';
 
-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,
+  type ModelCrudSupport,
+  ModelCrudUtil,
   type ModelListOptions,
+  ModelRegistryIndex,
+  type ModelStorageSupport,
+  type ModelType,
+  NotFoundError,
+  type OptionalId
 } from '@travetto/model';
 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 ModelIndexedSearchOptions, type SortedIndexSelectionType
+  type FullKeyedIndexBody,
+  type FullKeyedIndexWithPartialBody,
+  type KeyedIndexBody,
+  type KeyedIndexSelection,
+  ModelIndexedComputedIndex,
+  type ModelIndexedSearchOptions,
+  type ModelIndexedSupport,
+  ModelIndexedUtil,
+  type ModelPageOptions,
+  type ModelPageResult,
+  type SingleItemIndex,
+  type SortedIndex,
+  type SortedIndexSelection,
+  type SortedIndexSelectionType,
+  warnIfIndexedUniqueIndex,
+  warnIfNonIndexedIndex
 } from '@travetto/model-indexed';
+import { type Class, castTo, JSONUtil, RuntimeError, ShutdownManager } from '@travetto/runtime';
 
 import type { FirestoreModelConfig } from './config.ts';
 
@@ -24,7 +42,6 @@ const setMissingValues = <T>(input: T, missingValue: unknown): T =>
  */
 @Injectable()
 export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupport, ModelIndexedSupport {
-
   static resolveTable(cls: Class, namespace?: string): string {
     let table = ModelRegistryIndex.getStoreName(cls);
     if (namespace) {
@@ -37,7 +54,9 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
   client: Firestore;
   config: FirestoreModelConfig;
 
-  constructor(config: FirestoreModelConfig) { this.config = config; }
+  constructor(config: FirestoreModelConfig) {
+    this.config = config;
+  }
 
   #resolveTable(cls: Class): string {
     return FirestoreModelService.resolveTable(cls, this.config.namespace);
@@ -47,11 +66,11 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
     return this.client.collection(this.#resolveTable(cls));
   }
 
-  async #getIdByIndex<
-    T extends ModelType,
-    K extends KeyedIndexSelection<T>,
-    S extends SortedIndexSelection<T>
-  >(cls: Class<T>, idx: SingleItemIndex<T, K, S>, body: FullKeyedIndexBody<T, K, S>): Promise<string> {
+  async #getIdByIndex<T extends ModelType, K extends KeyedIndexSelection<T>, S extends SortedIndexSelection<T>>(
+    cls: Class<T>,
+    idx: SingleItemIndex<T, K, S>,
+    body: FullKeyedIndexBody<T, K, S>
+  ): Promise<string> {
     ModelCrudUtil.ensureNotSubType(cls);
     const computed = ModelIndexedComputedIndex.get(idx, body).validate({ sort: true });
     const query = [...computed.allParts, ...(computed.idPart ? [computed.idPart] : [])].reduce<Query>(
@@ -73,8 +92,10 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
     ModelCrudUtil.ensureNotSubType(cls);
     const computed = ModelIndexedComputedIndex.get(idx, body).validate();
 
-    let query = computed.keyedParts.reduce<Query>((result, { path, value, state }) =>
-      result.where(path.join('.'), '==', (state === 'empty' ? null : value)), this.#getCollection(cls));
+    let query = computed.keyedParts.reduce<Query>(
+      (result, { path, value, state }) => result.where(path.join('.'), '==', state === 'empty' ? null : value),
+      this.#getCollection(cls)
+    );
 
     for (const { path, value } of idx.sortTemplate) {
       query = query.orderBy(path.join('.'), value === 1 ? 'asc' : 'desc');
@@ -82,18 +103,18 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
     return query;
   }
 
-  async * #scanCollection<T extends ModelType>(
+  async *#scanCollection<T extends ModelType>(
     cls: Class<T>,
     queryBuilder: () => Query,
     options?: ModelListOptions & ModelPageOptions<number>
-  ): AsyncIterable<{ items: T[], nextOffset?: number }> {
+  ): AsyncIterable<{ items: T[]; nextOffset?: number }> {
     const limit = options?.limit ?? Number.MAX_SAFE_INTEGER;
     const batchSize = Math.min(options?.batchSizeHint ?? 100, limit);
 
     let offset = options?.offset ?? 0;
     let produced = 0;
 
-    while (!(options?.abort?.aborted) && produced < limit) {
+    while (!options?.abort?.aborted && produced < limit) {
       const query = queryBuilder().limit(batchSize).offset(offset);
 
       const { docs, size } = await query.get();
@@ -101,12 +122,11 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
         break;
       }
 
-      const remaining = (produced + size > limit) ? docs.slice(0, limit - produced) : docs;
+      const remaining = produced + size > limit ? docs.slice(0, limit - produced) : docs;
 
       offset += size;
 
-      const items = await ModelCrudUtil.filterOutNotFound(
-        remaining.map(item => ModelCrudUtil.load(cls, item.data()!)));
+      const items = await ModelCrudUtil.filterOutNotFound(remaining.map(item => ModelCrudUtil.load(cls, item.data()!)));
       produced += items.length;
 
       yield { items, nextOffset: offset };
@@ -126,7 +146,7 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
       warnIfNonIndexedIndex(this, cls, ModelRegistryIndex.getIndices(cls));
     }
   }
-  async deleteStorage(): Promise<void> { }
+  async deleteStorage(): Promise<void> {}
 
   async deleteModel<T extends ModelType>(cls: Class<T>): Promise<void> {
     await this.client.recursiveDelete(this.#getCollection(cls));
@@ -136,7 +156,7 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
   async get<T extends ModelType>(cls: Class<T>, id: string): Promise<T> {
     const result = await this.#getCollection(cls).doc(id).get();
 
-    if (result && result.exists) {
+    if (result?.exists) {
       return await ModelCrudUtil.load(cls, result.data()!);
     }
     throw new NotFoundError(cls, id);
@@ -167,7 +187,9 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
     const id = item.id;
     const full = await ModelCrudUtil.naivePartialUpdate(cls, () => this.get(cls, id), item, view);
     const cleaned = setMissingValues(full, FieldValue.delete());
-    await this.#getCollection(cls).doc(id).set(cleaned, { mergeFields: Object.keys(full) });
+    await this.#getCollection(cls)
+      .doc(id)
+      .set(cleaned, { mergeFields: Object.keys(full) });
     return this.get(cls, id);
   }
 
@@ -183,7 +205,7 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
     }
   }
 
-  async * list<T extends ModelType>(cls: Class<T>, options?: ModelListOptions): AsyncIterable<T[]> {
+  async *list<T extends ModelType>(cls: Class<T>, options?: ModelListOptions): AsyncIterable<T[]> {
     for await (const { items } of this.#scanCollection(cls, () => this.#getCollection(cls), options)) {
       yield items;
     }
@@ -191,56 +213,52 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
 
   // Indexed contract
 
-  async getByIndex<
-    T extends ModelType,
-    K extends KeyedIndexSelection<T>,
-    S extends SortedIndexSelection<T>
-  >(cls: Class<T>, idx: SingleItemIndex<T, K, S>, body: FullKeyedIndexBody<T, K, S>): Promise<T> {
+  async getByIndex<T extends ModelType, K extends KeyedIndexSelection<T>, S extends SortedIndexSelection<T>>(
+    cls: Class<T>,
+    idx: SingleItemIndex<T, K, S>,
+    body: FullKeyedIndexBody<T, K, S>
+  ): Promise<T> {
     return this.get(cls, await this.#getIdByIndex(cls, idx, body));
   }
 
-  async deleteByIndex<
-    T extends ModelType,
-    K extends KeyedIndexSelection<T>,
-    S extends SortedIndexSelection<T>
-  >(cls: Class<T>, idx: SingleItemIndex<T, K, S>, body: FullKeyedIndexBody<T, K, S>): Promise<void> {
+  async deleteByIndex<T extends ModelType, K extends KeyedIndexSelection<T>, S extends SortedIndexSelection<T>>(
+    cls: Class<T>,
+    idx: SingleItemIndex<T, K, S>,
+    body: FullKeyedIndexBody<T, K, S>
+  ): Promise<void> {
     return this.delete(cls, await this.#getIdByIndex(cls, idx, body));
   }
 
-  upsertByIndex<
-    T extends ModelType,
-    K extends KeyedIndexSelection<T>,
-    S extends SortedIndexSelection<T>
-  >(cls: Class<T>, idx: SingleItemIndex<T, K, S>, body: OptionalId<T>): Promise<T> {
+  upsertByIndex<T extends ModelType, K extends KeyedIndexSelection<T>, S extends SortedIndexSelection<T>>(
+    cls: Class<T>,
+    idx: SingleItemIndex<T, K, S>,
+    body: OptionalId<T>
+  ): Promise<T> {
     return ModelIndexedUtil.naiveUpsert(this, cls, idx, body);
   }
 
-  updateByIndex<
-    T extends ModelType,
-    K extends KeyedIndexSelection<T>,
-    S extends SortedIndexSelection<T>
-  >(cls: Class<T>, idx: SingleItemIndex<T, K, S>, body: T): Promise<T> {
+  updateByIndex<T extends ModelType, K extends KeyedIndexSelection<T>, S extends SortedIndexSelection<T>>(
+    cls: Class<T>,
+    idx: SingleItemIndex<T, K, S>,
+    body: T
+  ): Promise<T> {
     return ModelIndexedUtil.naiveUpdate(this, cls, idx, body);
   }
 
-  async updatePartialByIndex<
-    T extends ModelType,
-    K extends KeyedIndexSelection<T>,
-    S extends SortedIndexSelection<T>
-  >(cls: Class<T>, idx: SingleItemIndex<T, K, S>, body: FullKeyedIndexWithPartialBody<T, K, S>): Promise<T> {
+  async updatePartialByIndex<T extends ModelType, K extends KeyedIndexSelection<T>, S extends SortedIndexSelection<T>>(
+    cls: Class<T>,
+    idx: SingleItemIndex<T, K, S>,
+    body: FullKeyedIndexWithPartialBody<T, K, S>
+  ): Promise<T> {
     const item = await ModelCrudUtil.naivePartialUpdate(cls, () => this.getByIndex(cls, idx, castTo(body)), castTo(body));
     return this.update(cls, item);
   }
 
-  async pageByIndex<
-    T extends ModelType,
-    K extends KeyedIndexSelection<T>,
-    S extends SortedIndexSelection<T>
-  >(
+  async pageByIndex<T extends ModelType, K extends KeyedIndexSelection<T>, S extends SortedIndexSelection<T>>(
     cls: Class<T>,
     idx: SortedIndex<T, K, S>,
     body: KeyedIndexBody<T, K>,
-    options?: ModelPageOptions,
+    options?: ModelPageOptions
   ): Promise<ModelPageResult<T>> {
     const items: T[] = [];
     let nextOffset: number | undefined;
@@ -256,11 +274,7 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
     return { items, nextOffset: nextOffset ? JSONUtil.toBase64(nextOffset) : undefined };
   }
 
-  async * listByIndex<
-    T extends ModelType,
-    K extends KeyedIndexSelection<T>,
-    S extends SortedIndexSelection<T>
-  >(
+  async *listByIndex<T extends ModelType, K extends KeyedIndexSelection<T>, S extends SortedIndexSelection<T>>(
     cls: Class<T>,
     idx: SortedIndex<T, K, S>,
     body: KeyedIndexBody<T, K>,
@@ -281,15 +295,14 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
 
     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 })
-    ) {
+    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;
   }
-}
+}

package/support/cli.firestore_indexes.ts

@@ -1,13 +1,13 @@
 import cp from 'node:child_process';
 import fs from 'node:fs/promises';
 
-import { type CliCommandShape, CliCommand, CliModuleFlag } from '@travetto/cli';
-import { JSONUtil, Env, ExecUtil, Runtime } from '@travetto/runtime';
-import { Registry } from '@travetto/registry';
+import { CliCommand, type CliCommandShape, CliModuleFlag } from '@travetto/cli';
 import { DependencyRegistryIndex } from '@travetto/di';
+import { ManifestFileUtil } from '@travetto/manifest';
 import { ModelRegistryIndex } from '@travetto/model';
 import { isModelIndexedIndex } from '@travetto/model-indexed';
-import { ManifestFileUtil } from '@travetto/manifest';
+import { Registry } from '@travetto/registry';
+import { Env, ExecUtil, JSONUtil, Runtime } from '@travetto/runtime';
 
 import { FirestoreModelConfig } from '../src/config.ts';
 import { FirestoreModelService } from '../src/service.ts';
@@ -36,7 +36,6 @@ type FirestoreIndexSet = {
  */
 @CliCommand()
 export class FirestoreIndexesCommand implements CliCommandShape {
-
   indexFile = 'firestore.indexes.json';
   firebaseFile = 'firebase.json';
 
@@ -61,14 +60,16 @@ export class FirestoreIndexesCommand implements CliCommandShape {
       const indices = ModelRegistryIndex.getIndices(cls)
         .filter(isModelIndexedIndex)
         // We need at least 2 fields.  All 1 field indices are already handled
-        .filter((idx => (idx.keyTemplate?.length ?? 0) + (idx.sortTemplate?.length ?? 0) >= 2));
+        .filter(idx => (idx.keyTemplate?.length ?? 0) + (idx.sortTemplate?.length ?? 0) >= 2);
 
       for (const idx of indices) {
         indexesList.push({
           collectionGroup: FirestoreModelService.resolveTable(cls, config.namespace),
           queryScope: 'COLLECTION',
-          fields: [...idx.keyTemplate, ...idx.sortTemplate]
-            .map(part => ({ fieldPath: part.path.join('.'), order: part.value === -1 ? 'DESCENDING' : 'ASCENDING' }))
+          fields: [...idx.keyTemplate, ...idx.sortTemplate].map(part => ({
+            fieldPath: part.path.join('.'),
+            order: part.value === -1 ? 'DESCENDING' : 'ASCENDING'
+          }))
         });
       }
     }
@@ -83,17 +84,19 @@ export class FirestoreIndexesCommand implements CliCommandShape {
     await ManifestFileUtil.bufferedFileWrite(this.indexFile, text);
 
     const firebaseLocation = Runtime.workspaceRelative(this.firebaseFile);
-    if (!await fs.stat(firebaseLocation, { throwIfNoEntry: false })) {
+    if (!(await fs.stat(firebaseLocation, { throwIfNoEntry: false }))) {
       await ManifestFileUtil.bufferedFileWrite(firebaseLocation, '{}');
     }
 
-    const firebaseContext = JSONUtil.fromBinaryArray<{ firestore?: { database?: string, indexes?: string }[] }>(await fs.readFile(firebaseLocation));
+    const firebaseContext = JSONUtil.fromBinaryArray<{ firestore?: { database?: string; indexes?: string }[] }>(
+      await fs.readFile(firebaseLocation)
+    );
     const existing = (firebaseContext.firestore ??= []);
     const found = existing.find(x => x.database === config.databaseId);
 
     let changed = true;
     if (!found) {
-      existing.push(({ indexes: this.indexFile, database: config.databaseId }));
+      existing.push({ indexes: this.indexFile, database: config.databaseId });
     } else if (found.indexes !== this.indexFile) {
       found.indexes = this.indexFile;
     } else {
@@ -106,11 +109,12 @@ export class FirestoreIndexesCommand implements CliCommandShape {
 
     if (this.deploy) {
       const child = cp.spawn(
-        'firebase', ['deploy', '--only', 'firestore:indexes'],
+        'firebase',
+        ['deploy', '--only', 'firestore:indexes'],
         // Complete take over
-        { stdio: 'inherit' },
+        { stdio: 'inherit' }
       );
-      await ExecUtil.getResult(child)
+      await ExecUtil.getResult(child);
     }
   }
 }

package/support/service.firestore.ts

@@ -10,4 +10,4 @@ export const service: ServiceDescriptor = {
     FIRESTORE_PROJECT_ID: 'trv-local-dev'
   },
   image: `ridedott/firestore-emulator:${version}`
-};
+};