@travetto/model-firestore 7.1.4 → 8.0.0-alpha.1

package/README.md

@@ -36,7 +36,7 @@ export class Init {
 }
 ```
 
-where the [FirestoreModelConfig](https://github.com/travetto/travetto/tree/main/module/model-firestore/src/config.ts#L6) is defined by:
+where the [FirestoreModelConfig](https://github.com/travetto/travetto/tree/main/module/model-firestore/src/config.ts#L7) is defined by:
 
 **Code: Structure of FirestoreModelConfig**
 ```typescript
@@ -50,7 +50,8 @@ export class FirestoreModelConfig {
   modifyStorage?: boolean;
   credentials?: FirestoreModelConfigCredentials;
 
-  async postConstruct(): Promise<void> {
+  @PostConstruct()
+  async finalizeConfig(): Promise<void> {
     if (!this.databaseURL && !Runtime.production) {
       this.projectId ??= 'trv-local-dev';
       this.emulator ??= 'localhost:7000'; // From docker
@@ -59,9 +60,8 @@ export class FirestoreModelConfig {
       process.env.FIRESTORE_EMULATOR_HOST = this.emulator;
     }
     if (this.credentialsFile && !this.credentials) {
-      this.credentials = FirestoreModelConfigCredentials.from(
-        await RuntimeResources.readJSON(this.credentialsFile)
-      );
+      const bytes = await RuntimeResources.readBinaryArray(this.credentialsFile);
+      this.credentials = FirestoreModelConfigCredentials.from(JSONUtil.fromBinaryArray(bytes));
       await SchemaValidator.validate(FirestoreModelConfigCredentials, this.credentials);
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-firestore",
-  "version": "7.1.4",
+  "version": "8.0.0-alpha.1",
   "description": "Firestore backing for the travetto model module.",
   "keywords": [
     "typescript",
@@ -25,13 +25,13 @@
     "directory": "module/model-firestore"
   },
   "dependencies": {
-    "@google-cloud/firestore": "^8.1.0",
-    "@travetto/config": "^7.1.4",
-    "@travetto/model": "^7.1.4",
-    "@travetto/runtime": "^7.1.4"
+    "@google-cloud/firestore": "^8.3.0",
+    "@travetto/config": "^8.0.0-alpha.1",
+    "@travetto/model": "^8.0.0-alpha.1",
+    "@travetto/runtime": "^8.0.0-alpha.1"
   },
   "peerDependencies": {
-    "@travetto/cli": "^7.1.4"
+    "@travetto/cli": "^8.0.0-alpha.1"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/config.ts

@@ -1,6 +1,7 @@
-import { Runtime, RuntimeResources } from '@travetto/runtime';
+import { JSONUtil, Runtime, RuntimeResources } from '@travetto/runtime';
 import { Config } from '@travetto/config';
 import { Schema, SchemaValidator } from '@travetto/schema';
+import { PostConstruct } from '@travetto/di';
 
 @Schema()
 class FirestoreModelConfigCredentials {
@@ -19,7 +20,8 @@ export class FirestoreModelConfig {
   modifyStorage?: boolean;
   credentials?: FirestoreModelConfigCredentials;
 
-  async postConstruct(): Promise<void> {
+  @PostConstruct()
+  async finalizeConfig(): Promise<void> {
     if (!this.databaseURL && !Runtime.production) {
       this.projectId ??= 'trv-local-dev';
       this.emulator ??= 'localhost:7000'; // From docker
@@ -28,9 +30,8 @@ export class FirestoreModelConfig {
       process.env.FIRESTORE_EMULATOR_HOST = this.emulator;
     }
     if (this.credentialsFile && !this.credentials) {
-      this.credentials = FirestoreModelConfigCredentials.from(
-        await RuntimeResources.readJSON(this.credentialsFile)
-      );
+      const bytes = await RuntimeResources.readBinaryArray(this.credentialsFile);
+      this.credentials = FirestoreModelConfigCredentials.from(JSONUtil.fromBinaryArray(bytes));
       await SchemaValidator.validate(FirestoreModelConfigCredentials, this.credentials);
     }
   }

package/src/service.ts

@@ -1,7 +1,7 @@
-import { type DocumentData, FieldValue, Firestore, type PartialWithFieldValue, type Query } from '@google-cloud/firestore';
+import { type DocumentData, FieldValue, Firestore, type Query } from '@google-cloud/firestore';
 
 import { JSONUtil, ShutdownManager, type Class, type DeepPartial } from '@travetto/runtime';
-import { Injectable } from '@travetto/di';
+import { Injectable, PostConstruct } from '@travetto/di';
 import {
   type ModelCrudSupport, ModelRegistryIndex, type ModelStorageSupport,
   type ModelIndexedSupport, type ModelType, NotFoundError, type OptionalId,
@@ -10,10 +10,9 @@ import {
 
 import type { FirestoreModelConfig } from './config.ts';
 
-const clone = structuredClone;
-
-const toSimpleObject = <T>(input: T, missingValue: unknown = null): PartialWithFieldValue<DocumentData> =>
-  JSONUtil.parseSafe(JSON.stringify(input, (_, value) => value ?? null), (_, value) => value ?? missingValue);
+const clone = JSONUtil.clone;
+const setMissingValues = <T>(input: T, missingValue: unknown): T =>
+  JSONUtil.clone(input, { replacer: (_, value) => value ?? null, reviver: (_, value) => value ?? missingValue });
 
 /**
  * A model service backed by Firestore
@@ -39,8 +38,9 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
     return this.client.collection(this.#resolveTable(cls));
   }
 
-  async postConstruct(): Promise<void> {
-    this.client = new Firestore(this.config);
+  @PostConstruct()
+  async initializeClient(): Promise<void> {
+    this.client = new Firestore({ ...this.config, useBigInt: true });
     ShutdownManager.signal.addEventListener('abort', () => this.client.terminate());
   }
 
@@ -66,21 +66,21 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
 
   async create<T extends ModelType>(cls: Class<T>, item: OptionalId<T>): Promise<T> {
     const prepped = await ModelCrudUtil.preStore(cls, item, this);
-    await this.#getCollection(cls).doc(prepped.id).create(clone(prepped));
+    await this.#getCollection(cls).doc(prepped.id).create(clone<DocumentData>(prepped));
     return prepped;
   }
 
   async update<T extends ModelType>(cls: Class<T>, item: T): Promise<T> {
     ModelCrudUtil.ensureNotSubType(cls);
     const prepped = await ModelCrudUtil.preStore(cls, item, this);
-    await this.#getCollection(cls).doc(item.id).update(clone<DocumentData>(prepped));
+    await this.#getCollection(cls).doc(item.id).set(clone<DocumentData>(prepped), { merge: false });
     return prepped;
   }
 
   async upsert<T extends ModelType>(cls: Class<T>, item: OptionalId<T>): Promise<T> {
     ModelCrudUtil.ensureNotSubType(cls);
     const prepped = await ModelCrudUtil.preStore(cls, item, this);
-    await this.#getCollection(cls).doc(prepped.id).set(clone(prepped));
+    await this.#getCollection(cls).doc(prepped.id).set(clone<DocumentData>(prepped));
     return prepped;
   }
 
@@ -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 = toSimpleObject(full, FieldValue.delete());
+    const cleaned = setMissingValues(full, FieldValue.delete());
     await this.#getCollection(cls).doc(id).set(cleaned, { mergeFields: Object.keys(full) });
     return this.get(cls, id);
   }