@stoker-platform/cli 0.5.102 → 0.5.104

package/lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@stoker-platform/cli",
-    "version": "0.5.101",
+    "version": "0.5.103",
     "type": "module",
     "license": "SEE LICENSE IN LICENSE.md",
     "main": "./lib/src/main.js",
@@ -24,9 +24,9 @@
         "@google-cloud/secret-manager": "^6.1.2",
         "@google-cloud/storage": "^7.19.0",
         "@inquirer/prompts": "^8.5.2",
-        "@stoker-platform/node-client": "0.5.67",
-        "@stoker-platform/types": "0.5.46",
-        "@stoker-platform/utils": "0.5.58",
+        "@stoker-platform/node-client": "0.5.69",
+        "@stoker-platform/types": "0.5.48",
+        "@stoker-platform/utils": "0.5.60",
         "algoliasearch": "^5.53.0",
         "commander": "^15.0.0",
         "cross-spawn": "^7.0.6",

package/lib/src/deploy/firestore-export/exportFirestoreData.js

@@ -1,4 +1,5 @@
 import { initializeFirebase, fetchCurrentSchema, runChildProcess } from "@stoker-platform/node-client";
+import { getFirestoreDatabaseId } from "@stoker-platform/utils";
 export const exportFirestoreData = async () => {
     await initializeFirebase();
     const schema = await fetchCurrentSchema();
@@ -16,6 +17,8 @@ export const exportFirestoreData = async () => {
                     `gs://${bucket}/`,
                     `--collection-ids=${collections.join(",")}`,
                     `--project=${process.env.GCP_PROJECT}`,
+                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                    `--database=${getFirestoreDatabaseId(process.env.FB_FIRESTORE_EDITION, process.env.GCP_PROJECT)}`,
                     "--quiet",
                 ]);
                 collections = [];

package/lib/src/deploy/live-update/liveUpdate.js

@@ -1,10 +1,9 @@
-import { fetchCurrentSchema, initializeFirebase } from "@stoker-platform/node-client";
+import { fetchCurrentSchema, initializeFirebase, getStokerFirestore } from "@stoker-platform/node-client";
 import { FieldValue } from "firebase-admin/firestore";
-import { getCLIFirestore } from "../../utils/getCLIFirestore.js";
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const liveUpdate = async (options) => {
     await initializeFirebase();
-    const db = getCLIFirestore();
+    const db = getStokerFirestore();
     const batch = db.batch();
     const currentSchema = await fetchCurrentSchema();
     const deployId = db.collection("system_deployment").doc("latest_deploy").collection("deploy_history").doc().id;

package/lib/src/deploy/maintenance/activateMaintenanceMode.js

@@ -1,8 +1,7 @@
-import { initializeFirebase } from "@stoker-platform/node-client";
-import { getCLIFirestore } from "../../utils/getCLIFirestore.js";
+import { initializeFirebase, getStokerFirestore } from "@stoker-platform/node-client";
 export const activateMaintenanceMode = async () => {
     await initializeFirebase();
-    const db = getCLIFirestore();
+    const db = getStokerFirestore();
     await db.collection("system_deployment").doc("maintenance_mode").set({ active: true });
     console.info("MAINTENANCE MODE ENGAGED");
     process.exit();

package/lib/src/deploy/maintenance/disableMaintenanceMode.js

@@ -1,8 +1,7 @@
-import { initializeFirebase } from "@stoker-platform/node-client";
-import { getCLIFirestore } from "../../utils/getCLIFirestore.js";
+import { initializeFirebase, getStokerFirestore } from "@stoker-platform/node-client";
 export const disableMaintenanceMode = async () => {
     await initializeFirebase();
-    const db = getCLIFirestore();
+    const db = getStokerFirestore();
     await db.collection("system_deployment").doc("maintenance_mode").set({ active: false });
     console.info("MAINTENANCE MODE DISENGAGED");
     process.exit();

package/lib/src/deploy/maintenance/setDeploymentStatus.js

@@ -1,9 +1,8 @@
-import { initializeFirebase } from "@stoker-platform/node-client";
-import { getCLIFirestore } from "../../utils/getCLIFirestore.js";
+import { initializeFirebase, getStokerFirestore } from "@stoker-platform/node-client";
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const setDeploymentStatus = async (status) => {
     await initializeFirebase();
-    const db = getCLIFirestore();
+    const db = getStokerFirestore();
     if (!["idle", "in_progress"].includes(status)) {
         throw new Error("Invalid deployment status");
     }

package/lib/src/migration/firestore/operations/deleteField.js

@@ -1,7 +1,7 @@
 import { FieldValue } from "firebase-admin/firestore";
 import { appendFileSync } from "fs";
 import { join } from "path";
-import { getCLIFirestore } from "../../../utils/getCLIFirestore.js";
+import { getStokerFirestore } from "@stoker-platform/node-client";
 export const deleteField = async (currentSchema, lastSchema) => {
     const deletedFields = [];
     const currentSchemaKeys = Object.keys(currentSchema.collections);
@@ -20,7 +20,7 @@ export const deleteField = async (currentSchema, lastSchema) => {
     });
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     const filePath = join(process.cwd(), ".migration", process.env.GCP_PROJECT, `v${currentSchema.version.toString()}`);
-    const db = getCLIFirestore();
+    const db = getStokerFirestore();
     const bulkWriter = db.bulkWriter();
     for (const field of deletedFields) {
         const [collection, fieldName] = field.split(".");

package/lib/src/ops/auditDenormalized.js

@@ -1,14 +1,13 @@
-import { fetchCurrentSchema, initializeStoker } from "@stoker-platform/node-client";
+import { fetchCurrentSchema, initializeStoker, getStokerFirestore } from "@stoker-platform/node-client";
 import { getDependencyIndexFields, getLowercaseFields, getRoleGroups, getSingleFieldRelations, isDependencyField, isRelationField, } from "@stoker-platform/utils";
 import { join } from "node:path";
-import { getCLIFirestore } from "../utils/getCLIFirestore.js";
 import isEqual from "lodash/isEqual.js";
 import isEmpty from "lodash/isEmpty.js";
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const auditDenormalized = async (options) => {
     await initializeStoker(options.mode || "production", options.tenant, join(process.cwd(), "lib", "main.js"), join(process.cwd(), "lib", "collections"));
     const schema = await fetchCurrentSchema();
-    const db = getCLIFirestore();
+    const db = getStokerFirestore();
     for (const [collectionName, collectionSchema] of Object.entries(schema.collections)) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const collectionData = {};

package/lib/src/ops/auditPermissions.js

@@ -1,11 +1,10 @@
-import { fetchCurrentSchema, initializeStoker } from "@stoker-platform/node-client";
+import { fetchCurrentSchema, initializeStoker, getStokerFirestore } from "@stoker-platform/node-client";
 import { join } from "node:path";
-import { getCLIFirestore } from "../utils/getCLIFirestore.js";
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const auditPermissions = async (options) => {
     await initializeStoker(options.mode || "production", options.tenant, join(process.cwd(), "lib", "main.js"), join(process.cwd(), "lib", "collections"));
     const schema = await fetchCurrentSchema();
-    const db = getCLIFirestore();
+    const db = getStokerFirestore();
     const mismatches = [];
     const permissions = await db.collection("tenants").doc(options.tenant).collection("system_user_permissions").get();
     for (const authCollection of Object.values(schema.collections)) {

package/lib/src/ops/auditRelations.js

@@ -1,13 +1,12 @@
-import { fetchCurrentSchema, getFirestorePathRef, initializeStoker } from "@stoker-platform/node-client";
+import { fetchCurrentSchema, getFirestorePathRef, initializeStoker, getStokerFirestore, } from "@stoker-platform/node-client";
 import { join } from "node:path";
-import { getCLIFirestore } from "../utils/getCLIFirestore.js";
 import isEqual from "lodash/isEqual.js";
 import { getField, getLowercaseFields, getSingleFieldRelations } from "@stoker-platform/utils";
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const auditRelations = async (options) => {
     await initializeStoker(options.mode || "production", options.tenant, join(process.cwd(), "lib", "main.js"), join(process.cwd(), "lib", "collections"));
     const schema = await fetchCurrentSchema();
-    const db = getCLIFirestore();
+    const db = getStokerFirestore();
     const tenantPrefix = `tenants/${options.tenant}`;
     const recordByDocumentPath = new Map();
     const collectionDocsByName = new Map();

package/lib/src/ops/explainPreloadQueries.js

@@ -1,14 +1,39 @@
-import { fetchCurrentSchema, getCollectionRefs, initializeStoker } from "@stoker-platform/node-client";
+import { fetchCurrentSchema, getCollectionRefs, initializeStoker, getStokerFirestore, } from "@stoker-platform/node-client";
 import { tryPromise, getRange } from "@stoker-platform/utils";
 import { Filter } from "firebase-admin/firestore";
 import { join } from "path";
-import { getCLIFirestore } from "../utils/getCLIFirestore.js";
+const explainQuery = async (_db, query, analyze) => {
+    const edition = process.env.FB_FIRESTORE_EDITION || "enterprise";
+    if (edition === "enterprise") {
+        /*
+        const pipeline = db.pipeline().createFrom(query)
+        const snapshot = analyze
+            ? await pipeline.execute({
+                  explainOptions: { mode: "analyze", outputFormat: "text" },
+              })
+            : await pipeline.execute({
+                  rawOptions: {
+                      "explain_options.mode": "explain",
+                      "explain_options.output_format": "text",
+                  },
+              })
+        const stats = snapshot.explainStats
+        if (!stats) {
+            throw new Error("No explain results")
+        }
+        return stats.text
+        */
+        return "Explain is temporarily disabled for enterprise edition.";
+    }
+    const results = await query.explain({ analyze });
+    return results.metrics;
+};
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const explainPreloadQueries = async (options) => {
     const { getGlobalConfigModule } = await initializeStoker("production", options.tenant, join(process.cwd(), "lib", "main.js"), join(process.cwd(), "lib", "collections"));
     const globalConfig = getGlobalConfigModule();
     const schema = await fetchCurrentSchema();
-    const db = getCLIFirestore();
+    const db = getStokerFirestore();
     const permissionsSnapshot = await db
         .collection("tenants")
         .doc(options.tenant)
@@ -57,8 +82,8 @@ export const explainPreloadQueries = async (options) => {
         });
         console.log(`${collection}:`);
         for (const query of queries) {
-            const metrics = await query.explain({ analyze: options.analyze });
-            console.log(JSON.stringify(metrics.metrics));
+            const metrics = await explainQuery(db, query, options.analyze);
+            console.log(typeof metrics === "string" ? metrics : JSON.stringify(metrics));
         }
         console.log("\n");
     }

package/lib/src/ops/getUserPermissions.js

@@ -1,9 +1,8 @@
-import { initializeFirebase } from "@stoker-platform/node-client";
-import { getCLIFirestore } from "../utils/getCLIFirestore.js";
+import { initializeFirebase, getStokerFirestore } from "@stoker-platform/node-client";
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const getUserPermissions = async (options) => {
     await initializeFirebase();
-    const db = getCLIFirestore();
+    const db = getStokerFirestore();
     const usersRef = await db
         .collection("tenants")
         .doc(options.tenant)

package/lib/src/ops/getUserRecord.js

@@ -1,9 +1,8 @@
-import { initializeFirebase } from "@stoker-platform/node-client";
-import { getCLIFirestore } from "../utils/getCLIFirestore.js";
+import { initializeFirebase, getStokerFirestore } from "@stoker-platform/node-client";
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const getUserRecord = async (options) => {
     await initializeFirebase();
-    const db = getCLIFirestore();
+    const db = getStokerFirestore();
     const usersRef = await db
         .collection("tenants")
         .doc(options.tenant)

package/lib/src/project/addProject.js

@@ -438,9 +438,9 @@ export const addProject = async (options) => {
             await runChildProcess("attrib", ["-H", firebasercPath]);
         }
         await runChildProcess("firebase", ["target:apply", "storage", "default", projectId, "--project", projectId]);
+        const firebaseJsonPath = join(process.cwd(), "firebase.json");
+        const firebaseJson = JSON.parse(await readFile(firebaseJsonPath, "utf8"));
         if ((process.env.FB_FIRESTORE_EDITION || "enterprise") === "enterprise") {
-            const firebaseJsonPath = join(process.cwd(), "firebase.json");
-            const firebaseJson = JSON.parse(await readFile(firebaseJsonPath, "utf8"));
             firebaseJson.firestore = [
                 {
                     database: projectId,
@@ -450,6 +450,13 @@ export const addProject = async (options) => {
             ];
             await writeFile(firebaseJsonPath, JSON.stringify(firebaseJson, null, 4), "utf8");
         }
+        else {
+            firebaseJson.firestore = {
+                rules: "firebase-rules/firestore.rules",
+                indexes: "firebase-rules/firestore.indexes.json",
+            };
+            await writeFile(firebaseJsonPath, JSON.stringify(firebaseJson, null, 4), "utf8");
+        }
         await updateProjectData(17);
     }
     if (getProgress() < 18) {

package/lib/src/project/addTenant.js

@@ -1,12 +1,11 @@
 import { input } from "@inquirer/prompts";
-import { fetchCurrentSchema, initializeFirebase, initializeStoker } from "@stoker-platform/node-client";
+import { fetchCurrentSchema, initializeFirebase, initializeStoker, getStokerFirestore, } from "@stoker-platform/node-client";
 import { join } from "path";
 import { retryOperation, isRelationField } from "@stoker-platform/utils";
 import { addRecordPrompt } from "./addRecordPrompt.js";
-import { getCLIFirestore } from "../utils/getCLIFirestore.js";
 export const addTenant = async () => {
     await initializeFirebase();
-    const db = getCLIFirestore();
+    const db = getStokerFirestore();
     const doc = await db.collection("tenants").add({});
     const tenantId = doc.id;
     await initializeStoker("production", tenantId, join(process.cwd(), "lib", "main.js"), join(process.cwd(), "lib", "collections"));

package/lib/src/project/deleteTenant.js

@@ -1,14 +1,13 @@
-import { fetchCurrentSchema, initializeFirebase } from "@stoker-platform/node-client";
+import { fetchCurrentSchema, initializeFirebase, getStokerFirestore } from "@stoker-platform/node-client";
 import { getAuth } from "firebase-admin/auth";
 import { getApp } from "firebase-admin/app";
 import { getStorage } from "firebase-admin/storage";
-import { getCLIFirestore } from "../utils/getCLIFirestore.js";
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const deleteTenant = async (options) => {
     await initializeFirebase();
     const app = getApp();
     const auth = getAuth();
-    const db = getCLIFirestore();
+    const db = getStokerFirestore();
     const storage = getStorage();
     const schema = await fetchCurrentSchema();
     const users = await db.collection("tenants").doc(options.tenant).collection("system_user_permissions").get();

package/lib/src/project/prepareEmulatorData.js

@@ -2,6 +2,7 @@ import { initializeFirebase, runChildProcess } from "@stoker-platform/node-clien
 import { getDatabase } from "firebase-admin/database";
 import { mkdir, rm, writeFile } from "fs/promises";
 import { join } from "path";
+import { getFirestoreDatabaseId } from "@stoker-platform/utils";
 export const prepareEmulatorData = async () => {
     if (!process.env.GCP_PROJECT) {
         throw new Error("GCP_PROJECT not set.");
@@ -94,6 +95,7 @@ export const prepareEmulatorData = async () => {
         "firestore",
         "export",
         `gs://${process.env.GCP_PROJECT}/firestore_export`,
+        `--database=${getFirestoreDatabaseId(process.env.FB_FIRESTORE_EDITION, process.env.GCP_PROJECT)}`,
         "--project",
         process.env.GCP_PROJECT,
     ]);

package/lib/src/utils/getCliFirestore.js

@@ -1,8 +1,4 @@
-import { getApp } from "firebase-admin/app";
-import { getFirestore } from "firebase-admin/firestore";
-import { getFirestoreDatabaseId } from "@stoker-platform/utils";
-export const getCLIFirestore = (app) => {
-    return getFirestore(app || getApp(), 
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    getFirestoreDatabaseId(process.env.FB_FIRESTORE_EDITION, process.env.GCP_PROJECT));
+import { getStokerFirestore } from "@stoker-platform/node-client";
+export const getCLIFirestore = () => {
+    return getStokerFirestore();
 };

package/lib/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["../src/main.ts","../src/data/exporttobigquery.ts","../src/data/seeddata.ts","../src/deploy/deployproject.ts","../src/deploy/cloud-functions/getfunctionsdata.ts","../src/deploy/firestore-export/exportfirestoredata.ts","../src/deploy/firestore-ttl/deployttls.ts","../src/deploy/live-update/liveupdate.ts","../src/deploy/maintenance/activatemaintenancemode.ts","../src/deploy/maintenance/disablemaintenancemode.ts","../src/deploy/maintenance/setdeploymentstatus.ts","../src/deploy/rules-indexes/generatefirestoreindexes.ts","../src/deploy/rules-indexes/generatefirestorerules.ts","../src/deploy/rules-indexes/generatestoragerules.ts","../src/deploy/schema/applyschema.ts","../src/deploy/schema/generateschema.ts","../src/deploy/schema/persistschema.ts","../src/deploy/schema/updateliveschema.ts","../src/lint/lintschema.ts","../src/lint/securityreport.ts","../src/migration/migrateall.ts","../src/migration/firestore/migratefirestore.ts","../src/migration/firestore/operations/deletefield.ts","../src/ops/auditdenormalized.ts","../src/ops/auditpermissions.ts","../src/ops/auditrelations.ts","../src/ops/explainpreloadqueries.ts","../src/ops/getuser.ts","../src/ops/getuserpermissions.ts","../src/ops/getuserrecord.ts","../src/ops/listprojects.ts","../src/ops/setusercollection.ts","../src/ops/setuserdocument.ts","../src/ops/setuserrole.ts","../src/project/addproject.ts","../src/project/addrecord.ts","../src/project/addrecordprompt.ts","../src/project/addtenant.ts","../src/project/buildwebapp.ts","../src/project/customdomain.ts","../src/project/deleteproject.ts","../src/project/deleterecord.ts","../src/project/deletetenant.ts","../src/project/getone.ts","../src/project/getsome.ts","../src/project/initproject.ts","../src/project/prepareemulatordata.ts","../src/project/setproject.ts","../src/project/startemulators.ts","../src/project/updaterecord.ts","../src/types/generatetypes.ts","../src/utils/getclifirestore.ts"],"version":"6.0.3"}
+{"root":["../src/main.ts","../src/data/exporttobigquery.ts","../src/data/seeddata.ts","../src/deploy/deployproject.ts","../src/deploy/cloud-functions/getfunctionsdata.ts","../src/deploy/firestore-export/exportfirestoredata.ts","../src/deploy/firestore-ttl/deployttls.ts","../src/deploy/live-update/liveupdate.ts","../src/deploy/maintenance/activatemaintenancemode.ts","../src/deploy/maintenance/disablemaintenancemode.ts","../src/deploy/maintenance/setdeploymentstatus.ts","../src/deploy/rules-indexes/generatefirestoreindexes.ts","../src/deploy/rules-indexes/generatefirestorerules.ts","../src/deploy/rules-indexes/generatestoragerules.ts","../src/deploy/schema/applyschema.ts","../src/deploy/schema/generateschema.ts","../src/deploy/schema/persistschema.ts","../src/deploy/schema/updateliveschema.ts","../src/lint/lintschema.ts","../src/lint/securityreport.ts","../src/migration/migrateall.ts","../src/migration/firestore/migratefirestore.ts","../src/migration/firestore/operations/deletefield.ts","../src/ops/auditdenormalized.ts","../src/ops/auditpermissions.ts","../src/ops/auditrelations.ts","../src/ops/explainpreloadqueries.ts","../src/ops/getuser.ts","../src/ops/getuserpermissions.ts","../src/ops/getuserrecord.ts","../src/ops/listprojects.ts","../src/ops/setusercollection.ts","../src/ops/setuserdocument.ts","../src/ops/setuserrole.ts","../src/project/addproject.ts","../src/project/addrecord.ts","../src/project/addrecordprompt.ts","../src/project/addtenant.ts","../src/project/buildwebapp.ts","../src/project/customdomain.ts","../src/project/deleteproject.ts","../src/project/deleterecord.ts","../src/project/deletetenant.ts","../src/project/getone.ts","../src/project/getsome.ts","../src/project/initproject.ts","../src/project/prepareemulatordata.ts","../src/project/setproject.ts","../src/project/startemulators.ts","../src/project/updaterecord.ts","../src/types/generatetypes.ts"],"version":"6.0.3"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@stoker-platform/cli",
-    "version": "0.5.102",
+    "version": "0.5.104",
     "type": "module",
     "license": "SEE LICENSE IN LICENSE.md",
     "main": "./lib/src/main.js",
@@ -24,9 +24,9 @@
         "@google-cloud/secret-manager": "^6.1.2",
         "@google-cloud/storage": "^7.19.0",
         "@inquirer/prompts": "^8.5.2",
-        "@stoker-platform/node-client": "0.5.68",
-        "@stoker-platform/types": "0.5.47",
-        "@stoker-platform/utils": "0.5.59",
+        "@stoker-platform/node-client": "0.5.69",
+        "@stoker-platform/types": "0.5.48",
+        "@stoker-platform/utils": "0.5.60",
         "algoliasearch": "^5.53.0",
         "commander": "^15.0.0",
         "cross-spawn": "^7.0.6",