@travetto/model-firestore 8.0.0-alpha.22 → 8.0.0-alpha.24

package/package.json

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

package/src/config.ts

@@ -6,13 +6,12 @@ import { PostConstruct } from '@travetto/di';
 @Schema()
 class FirestoreModelConfigCredentials {
   client_email: string;
-  project_id: string;
   private_key: string;
 }
 
 @Config('model.firestore')
 export class FirestoreModelConfig {
-  databaseURL?: string;
+  databaseId?: string;
   credentialsFile?: string;
   emulator?: string;
   projectId?: string;
@@ -22,8 +21,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/support/cli.firestore_indexes.ts

@@ -0,0 +1,93 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+
+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 { FirestoreModelConfig } from '../src/config.ts';
+
+/**
+ * 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: unknown[] = [];
+
+    for (const cls of ModelRegistryIndex.getClasses()) {
+      let collectionGroup = ModelRegistryIndex.getStoreName(cls);
+      if (config.namespace) {
+        collectionGroup = `${config.namespace}_${collectionGroup}`;
+      }
+
+      const indices = ModelRegistryIndex.getIndices(cls);
+      for (const idx of indices) {
+        if (isModelIndexedIndex(idx)) {
+          const fieldsCount = (idx.keyTemplate?.length ?? 0) + (idx.sortTemplate?.length ?? 0);
+          // Only create composite indexes if we have at least 2 fields
+          if (fieldsCount >= 2) {
+            const fields: { fieldPath: string, order: 'ASCENDING' | 'DESCENDING' }[] = [];
+
+            // Add key fields first
+            for (const part of idx.keyTemplate) {
+              fields.push({
+                fieldPath: part.path.join('.'),
+                order: 'ASCENDING'
+              });
+            }
+
+            // Add sort fields second
+            for (const part of idx.sortTemplate) {
+              fields.push({
+                fieldPath: part.path.join('.'),
+                order: part.value === 1 ? 'ASCENDING' : 'DESCENDING'
+              });
+            }
+
+            indexesList.push({
+              collectionGroup,
+              queryScope: 'COLLECTION',
+              fields
+            });
+          }
+        }
+      }
+    }
+
+    const outputData = {
+      indexes: indexesList,
+      fieldOverrides: []
+    };
+
+    const text = JSONUtil.toUTF8Pretty(outputData);
+
+    if (this.output === '-' || !this.output) {
+      console.log!(text);
+    } else {
+      await fs.mkdir(path.dirname(this.output), { recursive: true });
+      await fs.writeFile(this.output, text, 'utf8');
+    }
+  }
+}