@travetto/model-firestore 6.0.0-rc.0 → 6.0.0-rc.2

package/README.md

@@ -16,8 +16,8 @@ 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). 
 
 Supported features:
-   *  [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/service/crud.ts#L11)
-   *  [Indexed](https://github.com/travetto/travetto/tree/main/module/model/src/service/indexed.ts#L12)
+   *  [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/src/types/indexed.ts#L11)
 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.
 
 **Code: Wiring up a custom Model Source**
@@ -35,34 +35,29 @@ export class Init {
 }
 ```
 
-where the [FirestoreModelConfig](https://github.com/travetto/travetto/tree/main/module/model-firestore/src/config.ts#L5) is defined by:
+where the [FirestoreModelConfig](https://github.com/travetto/travetto/tree/main/module/model-firestore/src/config.ts#L6) is defined by:
 
 **Code: Structure of FirestoreModelConfig**
 ```typescript
-import { RuntimeResources } from '@travetto/runtime';
-import { Config } from '@travetto/config';
-
 @Config('model.firestore')
 export class FirestoreModelConfig {
-
   databaseURL?: string;
   credentialsFile?: string;
   emulator?: string;
   projectId: string;
   namespace?: string;
   autoCreate?: boolean;
-  credentials?: {
-    client_email: string;
-    project_id: string;
-    private_key: string;
-  };
+  credentials?: FirestoreModelConfigCredentials;
 
   async postConstruct(): Promise<void> {
     if (this.emulator) {
       process.env.FIRESTORE_EMULATOR_HOST = this.emulator;
     }
     if (this.credentialsFile && !this.credentials) {
-      this.credentials = JSON.parse(await RuntimeResources.read(this.credentialsFile));
+      this.credentials = FirestoreModelConfigCredentials.from(
+        JSON.parse(await RuntimeResources.read(this.credentialsFile))
+      );
+      await SchemaValidator.validate(FirestoreModelConfigCredentials, this.credentials);
     }
   }
 }

package/__index__.ts

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

package/package.json

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

package/src/config.ts

@@ -1,27 +1,33 @@
 import { RuntimeResources } from '@travetto/runtime';
 import { Config } from '@travetto/config';
+import { Schema, SchemaValidator } from '@travetto/schema';
+
+@Schema()
+class FirestoreModelConfigCredentials {
+  client_email: string;
+  project_id: string;
+  private_key: string;
+}
 
 @Config('model.firestore')
 export class FirestoreModelConfig {
-
   databaseURL?: string;
   credentialsFile?: string;
   emulator?: string;
   projectId: string;
   namespace?: string;
   autoCreate?: boolean;
-  credentials?: {
-    client_email: string;
-    project_id: string;
-    private_key: string;
-  };
+  credentials?: FirestoreModelConfigCredentials;
 
   async postConstruct(): Promise<void> {
     if (this.emulator) {
       process.env.FIRESTORE_EMULATOR_HOST = this.emulator;
     }
     if (this.credentialsFile && !this.credentials) {
-      this.credentials = JSON.parse(await RuntimeResources.read(this.credentialsFile));
+      this.credentials = FirestoreModelConfigCredentials.from(
+        JSON.parse(await RuntimeResources.read(this.credentialsFile))
+      );
+      await SchemaValidator.validate(FirestoreModelConfigCredentials, this.credentials);
     }
   }
 }

package/src/service.ts

@@ -5,12 +5,10 @@ import { Injectable } from '@travetto/di';
 import {
   ModelCrudSupport, ModelRegistry, ModelStorageSupport,
   ModelIndexedSupport, ModelType, NotFoundError, OptionalId,
+  ModelCrudUtil, ModelIndexedUtil,
 } from '@travetto/model';
 
-import { ModelCrudUtil } from '@travetto/model/src/internal/service/crud';
-import { ModelIndexedUtil } from '@travetto/model/src/internal/service/indexed';
-
-import { FirestoreModelConfig } from './config';
+import { FirestoreModelConfig } from './config.ts';
 
 const clone = structuredClone;
 
@@ -58,10 +56,10 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
 
   // Crud
   async get<T extends ModelType>(cls: Class<T>, id: string): Promise<T> {
-    const res = await this.#getCollection(cls).doc(id).get();
+    const result = await this.#getCollection(cls).doc(id).get();
 
-    if (res && res.exists) {
-      return await ModelCrudUtil.load(cls, res.data()!);
+    if (result && result.exists) {
+      return await ModelCrudUtil.load(cls, result.data()!);
     }
     throw new NotFoundError(cls, id);
   }