@travetto/model-firestore 7.0.0-rc.1 → 7.0.0-rc.3

package/README.md

@@ -30,8 +30,8 @@ export class Init {
   @InjectableFactory({
     primary: true
   })
-  static getModelSource(conf: FirestoreModelConfig) {
-    return new FirestoreModelService(conf);
+  static getModelSource(config: FirestoreModelConfig) {
+    return new FirestoreModelService(config);
   }
 }
 ```
@@ -47,7 +47,7 @@ export class FirestoreModelConfig {
   emulator?: string;
   projectId: string;
   namespace?: string;
-  autoCreate?: boolean;
+  modifyStorage?: boolean;
   credentials?: FirestoreModelConfigCredentials;
 
   async postConstruct(): Promise<void> {
@@ -56,7 +56,7 @@ export class FirestoreModelConfig {
     }
     if (this.credentialsFile && !this.credentials) {
       this.credentials = FirestoreModelConfigCredentials.from(
-        JSON.parse(await RuntimeResources.read(this.credentialsFile))
+        await RuntimeResources.readJSON(this.credentialsFile)
       );
       await SchemaValidator.validate(FirestoreModelConfigCredentials, this.credentials);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-firestore",
-  "version": "7.0.0-rc.1",
+  "version": "7.0.0-rc.3",
   "description": "Firestore backing for the travetto model module.",
   "keywords": [
     "typescript",
@@ -26,10 +26,10 @@
   },
   "dependencies": {
     "@google-cloud/firestore": "^7.11.6",
-    "@travetto/cli": "^7.0.0-rc.1",
-    "@travetto/config": "^7.0.0-rc.1",
-    "@travetto/model": "^7.0.0-rc.1",
-    "@travetto/runtime": "^7.0.0-rc.1"
+    "@travetto/cli": "^7.0.0-rc.3",
+    "@travetto/config": "^7.0.0-rc.3",
+    "@travetto/model": "^7.0.0-rc.3",
+    "@travetto/runtime": "^7.0.0-rc.3"
   },
   "travetto": {
     "displayName": "Firestore Model Support"

package/src/config.ts

@@ -1,4 +1,4 @@
-import { RuntimeResources } from '@travetto/runtime';
+import { Runtime, RuntimeResources } from '@travetto/runtime';
 import { Config } from '@travetto/config';
 import { Schema, SchemaValidator } from '@travetto/schema';
 
@@ -14,18 +14,22 @@ export class FirestoreModelConfig {
   databaseURL?: string;
   credentialsFile?: string;
   emulator?: string;
-  projectId: string;
+  projectId?: string;
   namespace?: string;
-  autoCreate?: boolean;
+  modifyStorage?: boolean;
   credentials?: FirestoreModelConfigCredentials;
 
   async postConstruct(): Promise<void> {
+    if (!this.databaseURL && !Runtime.production) {
+      this.projectId ??= 'trv-local-dev';
+      this.emulator ??= 'localhost:7000'; // From docker
+    }
     if (this.emulator) {
       process.env.FIRESTORE_EMULATOR_HOST = this.emulator;
     }
     if (this.credentialsFile && !this.credentials) {
       this.credentials = FirestoreModelConfigCredentials.from(
-        JSON.parse(await RuntimeResources.read(this.credentialsFile))
+        await RuntimeResources.readJSON(this.credentialsFile)
       );
       await SchemaValidator.validate(FirestoreModelConfigCredentials, this.credentials);
     }

package/src/service.ts

@@ -1,6 +1,6 @@
 import { DocumentData, FieldValue, Firestore, PartialWithFieldValue, Query } from '@google-cloud/firestore';
 
-import { ShutdownManager, type Class, type DeepPartial } from '@travetto/runtime';
+import { JSONUtil, ShutdownManager, type Class, type DeepPartial } from '@travetto/runtime';
 import { Injectable } from '@travetto/di';
 import {
   ModelCrudSupport, ModelRegistryIndex, ModelStorageSupport,
@@ -12,8 +12,8 @@ import { FirestoreModelConfig } from './config.ts';
 
 const clone = structuredClone;
 
-const toSimpleObj = <T>(inp: T, missingValue: unknown = null): PartialWithFieldValue<DocumentData> =>
-  JSON.parse(JSON.stringify(inp, (_, v) => v ?? null), (_, v) => v ?? missingValue);
+const toSimpleObject = <T>(input: T, missingValue: unknown = null): PartialWithFieldValue<DocumentData> =>
+  JSONUtil.parseSafe(JSON.stringify(input, (_, value) => value ?? null), (_, value) => value ?? missingValue);
 
 /**
  * A model service backed by Firestore
@@ -49,8 +49,8 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
   async deleteStorage(): Promise<void> { }
 
   async deleteModel(cls: Class): Promise<void> {
-    for await (const el of this.list(cls)) {
-      await this.delete(cls, el.id);
+    for await (const item of this.list(cls)) {
+      await this.delete(cls, item.id);
     }
   }
 
@@ -88,7 +88,7 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
     ModelCrudUtil.ensureNotSubType(cls);
     const id = item.id;
     const full = await ModelCrudUtil.naivePartialUpdate(cls, () => this.get(cls, id), item, view);
-    const cleaned = toSimpleObj(full, FieldValue.delete());
+    const cleaned = toSimpleObject(full, FieldValue.delete());
     await this.#getCollection(cls).doc(id).set(cleaned, { mergeFields: Object.keys(full) });
     return this.get(cls, id);
   }
@@ -97,22 +97,22 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
     ModelCrudUtil.ensureNotSubType(cls);
     try {
       await this.#getCollection(cls).doc(id).delete({ exists: true });
-    } catch (err) {
-      if (err && err instanceof Error && err.message.includes('NOT_FOUND')) {
+    } catch (error) {
+      if (error && error instanceof Error && error.message.includes('NOT_FOUND')) {
         throw new NotFoundError(cls, id);
       }
-      throw err;
+      throw error;
     }
   }
 
   async * list<T extends ModelType>(cls: Class<T>): AsyncIterable<T> {
     const batch = await this.#getCollection(cls).select().get();
-    for (const el of batch.docs) {
+    for (const item of batch.docs) {
       try {
-        yield await this.get(cls, el.id);
-      } catch (err) {
-        if (!(err instanceof NotFoundError)) {
-          throw err;
+        yield await this.get(cls, item.id);
+      } catch (error) {
+        if (!(error instanceof NotFoundError)) {
+          throw error;
         }
       }
     }
@@ -124,7 +124,7 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
 
     const { fields } = ModelIndexedUtil.computeIndexParts(cls, idx, body);
     const query = fields.reduce<Query>(
-      (q, { path, value }) => q.where(path.join('.'), '==', value),
+      (result, { path, value }) => result.where(path.join('.'), '==', value),
       this.#getCollection(cls)
     );
 
@@ -133,7 +133,7 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
     if (item && !item.empty) {
       return item.docs[0].id;
     }
-    throw new NotFoundError(`${cls.name} Index=${idx}`, ModelIndexedUtil.computeIndexKey(cls, idx, body, { sep: '; ' })?.key);
+    throw new NotFoundError(`${cls.name} Index=${idx}`, ModelIndexedUtil.computeIndexKey(cls, idx, body, { separator: '; ' })?.key);
   }
 
   async getByIndex<T extends ModelType>(cls: Class<T>, idx: string, body: DeepPartial<T>): Promise<T> {
@@ -151,17 +151,17 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
   async * listByIndex<T extends ModelType>(cls: Class<T>, idx: string, body: DeepPartial<T>): AsyncIterable<T> {
     ModelCrudUtil.ensureNotSubType(cls);
 
-    const cfg = ModelRegistryIndex.getIndex(cls, idx, ['sorted', 'unsorted']);
-    const { fields, sorted } = ModelIndexedUtil.computeIndexParts(cls, cfg, body, { emptySortValue: null });
-    let query = fields.reduce<Query>((q, { path, value }) =>
-      q.where(path.join('.'), '==', value), this.#getCollection(cls));
+    const config = ModelRegistryIndex.getIndex(cls, idx, ['sorted', 'unsorted']);
+    const { fields, sorted } = ModelIndexedUtil.computeIndexParts(cls, config, body, { emptySortValue: null });
+    let query = fields.reduce<Query>((result, { path, value }) =>
+      result.where(path.join('.'), '==', value), this.#getCollection(cls));
 
     if (sorted) {
       query = query.orderBy(sorted.path.join('.'), sorted.dir === 1 ? 'asc' : 'desc');
     }
 
-    for (const el of (await query.get()).docs) {
-      yield await ModelCrudUtil.load(cls, el.data()!);
+    for (const item of (await query.get()).docs) {
+      yield await ModelCrudUtil.load(cls, item.data()!);
     }
   }
 }