@travetto/model-firestore 8.0.0-alpha.23 → 8.0.0-alpha.25

package/README.md

@@ -42,7 +42,7 @@ where the [FirestoreModelConfig](https://github.com/travetto/travetto/tree/main/
 ```typescript
 @Config('model.firestore')
 export class FirestoreModelConfig {
-  databaseURL?: string;
+  databaseId?: string;
   credentialsFile?: string;
   emulator?: string;
   projectId?: string;
@@ -52,8 +52,8 @@ export class FirestoreModelConfig {
 
   @PostConstruct()
   async finalizeConfig(): Promise<void> {
-    if (!this.databaseURL && !Runtime.production) {
-      this.projectId ??= 'trv-local-dev';
+    if (!this.projectId && !Runtime.production) {
+      this.projectId = 'trv-local-dev';
       this.emulator ??= 'localhost:7000'; // From docker
     }
     if (this.emulator) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-firestore",
-  "version": "8.0.0-alpha.23",
+  "version": "8.0.0-alpha.25",
   "description": "Firestore backing for the travetto model module.",
   "keywords": [
     "typescript",

package/src/service.ts

@@ -25,6 +25,14 @@ 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) {
+      table = `${namespace}_${table}`;
+    }
+    return table;
+  }
+
   idSource = ModelCrudUtil.uuidSource();
   client: Firestore;
   config: FirestoreModelConfig;
@@ -32,11 +40,7 @@ export class FirestoreModelService implements ModelCrudSupport, ModelStorageSupp
   constructor(config: FirestoreModelConfig) { this.config = config; }
 
   #resolveTable(cls: Class): string {
-    let table = ModelRegistryIndex.getStoreName(cls);
-    if (this.config.namespace) {
-      table = `${this.config.namespace}_${table}`;
-    }
-    return table;
+    return FirestoreModelService.resolveTable(cls, this.config.namespace);
   }
 
   #getCollection(cls: Class): FirebaseFirestore.CollectionReference<DocumentData> {

package/support/cli.firestore_indexes.ts

@@ -0,0 +1,83 @@
+import { type CliCommandShape, CliCommand, CliModuleFlag } from '@travetto/cli';
+import { JSONUtil, Env } from '@travetto/runtime';
+import { Registry } from '@travetto/registry';
+import { DependencyRegistryIndex } from '@travetto/di';
+import { ModelRegistryIndex } from '@travetto/model';
+import { isModelIndexedIndex } from '@travetto/model-indexed';
+import { ManifestFileUtil, ManifestUtil } from '@travetto/manifest';
+
+import { FirestoreModelConfig } from '../src/config.ts';
+import { FirestoreModelService } from '../src/service.ts';
+
+type FirestoreIndexField = {
+  fieldPath: string;
+  order: 'ASCENDING' | 'DESCENDING';
+};
+
+type FirestoreIndexDefinition = {
+  collectionGroup: string;
+  queryScope: 'COLLECTION' | 'COLLECTION_GROUP';
+  fields: FirestoreIndexField[];
+};
+
+type FirestoreIndexSet = {
+  indexes: FirestoreIndexDefinition[];
+  fieldOverrides: unknown[];
+};
+
+/**
+ * Generate the Firestore composite indexes JSON for all registered models.
+ *
+ * The resulting JSON can be written to stdout or to a file path for use in
+ * firebase-cli deployments.
+ */
+@CliCommand()
+export class FirestoreIndexesCommand implements CliCommandShape {
+
+  /** Output file */
+  output?: string;
+
+  @CliModuleFlag({ short: 'm' })
+  module: string;
+
+  finalize(): void {
+    Env.DEBUG.set(false);
+  }
+
+  async main(): Promise<void> {
+    await Registry.init();
+
+    const config = await DependencyRegistryIndex.getInstance(FirestoreModelConfig);
+
+    const indexesList: FirestoreIndexDefinition[] = [];
+
+    for (const cls of ModelRegistryIndex.getClasses()) {
+      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));
+
+      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' }))
+        });
+      }
+    }
+
+    const outputData: FirestoreIndexSet = {
+      indexes: indexesList,
+      fieldOverrides: []
+    };
+
+    const text = JSONUtil.toUTF8Pretty(outputData);
+
+    if (this.output === '-' || !this.output) {
+      console.log!(text);
+    } else {
+      await ManifestFileUtil.bufferedFileWrite(this.output, text);
+    }
+  }
+}