firebase-tools 13.7.5 → 13.8.1

package/lib/init/index.js

@@ -10,6 +10,7 @@ const featureFns = new Map([
     ["account", features.account],
     ["database", features.database],
     ["firestore", features.firestore],
+    ["dataconnect", features.dataconnect],
     ["functions", features.functions],
     ["hosting", features.hosting],
     ["storage", features.storage],

package/lib/logger.js

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logger = void 0;
+exports.logger = exports.vsceLogEmitter = void 0;
 const winston = require("winston");
+const utils_1 = require("./utils");
+const events_1 = require("events");
+exports.vsceLogEmitter = new events_1.EventEmitter();
 function expandErrors(logger) {
     const oldLogFunc = logger.log.bind(logger);
     const newLogFunc = function (levelOrEntry, message, ...meta) {
@@ -25,7 +28,24 @@ function annotateDebugLines(logger) {
     logger.debug = newDebug;
     return logger;
 }
+function maybeUseVSCodeLogger(logger) {
+    if (!(0, utils_1.isVSCodeExtension)()) {
+        return logger;
+    }
+    const oldLogFunc = logger.log.bind(logger);
+    const vsceLogger = function (levelOrEntry, message, ...meta) {
+        if (message) {
+            exports.vsceLogEmitter.emit("log", { level: levelOrEntry, message });
+        }
+        else {
+            exports.vsceLogEmitter.emit("log", levelOrEntry);
+        }
+        return oldLogFunc(levelOrEntry, message, ...meta);
+    };
+    logger.log = vsceLogger;
+    return logger;
+}
 const rawLogger = winston.createLogger();
 rawLogger.add(new winston.transports.Console({ silent: true }));
 rawLogger.exitOnError = false;
-exports.logger = annotateDebugLines(expandErrors(rawLogger));
+exports.logger = maybeUseVSCodeLogger(annotateDebugLines(expandErrors(rawLogger)));

package/lib/operation-poller.js

@@ -21,7 +21,7 @@ class OperationPoller {
         if (error) {
             throw error instanceof error_1.FirebaseError
                 ? error
-                : new error_1.FirebaseError(error.message, { status: error.code });
+                : new error_1.FirebaseError(error.message, { status: error.code, original: error });
         }
         return response;
     }
@@ -45,7 +45,13 @@ class OperationPoller {
             if (options.onPoll) {
                 options.onPoll(res.body);
             }
-            if (!res.body.done) {
+            if (options.doneFn) {
+                const done = options.doneFn(res.body);
+                if (!done) {
+                    throw new Error("Polling incomplete, should trigger retry with backoff");
+                }
+            }
+            else if (!res.body.done) {
                 throw new Error("Polling incomplete, should trigger retry with backoff");
             }
             return res.body;

package/lib/rc.js

@@ -37,7 +37,7 @@ class RC {
     }
     constructor(rcpath, data) {
         this.path = rcpath;
-        this.data = Object.assign({ projects: {}, targets: {}, etags: {} }, data);
+        this.data = Object.assign({ projects: {}, targets: {}, etags: {}, dataconnectEmulatorConfig: {} }, data);
     }
     set(key, value) {
         _.set(this.data, key, value);
@@ -152,6 +152,15 @@ class RC {
         this.data.etags[projectId][resourceType] = etagData;
         this.save();
     }
+    getDataconnect() {
+        var _a;
+        return (_a = this.data.dataconnectEmulatorConfig) !== null && _a !== void 0 ? _a : {};
+    }
+    setDataconnect(localConnectionString) {
+        if (!this.data.dataconnectEmulatorConfig) {
+            this.data.dataconnectEmulatorConfig = { postgres: { localConnectionString } };
+        }
+    }
     save() {
         if (this.path) {
             fs.writeFileSync(this.path, JSON.stringify(this.data, null, 2), {

package/lib/requireAuth.js

@@ -77,5 +77,6 @@ async function requireAuth(options) {
         throw new error_1.FirebaseError(AUTH_ERROR_MESSAGE);
     }
     (0, auth_1.setActiveAccount)(options, { user, tokens });
+    return user.email;
 }
 exports.requireAuth = requireAuth;

package/lib/requireTosAcceptance.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requireTosAcceptance = void 0;
+const error_1 = require("./error");
+const firedata_1 = require("./gcp/firedata");
+const api_1 = require("./api");
+const consoleLandingPage = new Map([
+    [firedata_1.APPHOSTING_TOS_ID, `${(0, api_1.consoleOrigin)()}/project/_/apphosting`],
+]);
+function requireTosAcceptance(tosId) {
+    return () => requireTos(tosId);
+}
+exports.requireTosAcceptance = requireTosAcceptance;
+async function requireTos(tosId) {
+    const res = await (0, firedata_1.getTosStatus)();
+    if ((0, firedata_1.isProductTosAccepted)(res, tosId)) {
+        return;
+    }
+    const console = consoleLandingPage.get(tosId) || (0, api_1.consoleOrigin)();
+    throw new error_1.FirebaseError(`Your account has not accepted the required Terms of Service for this action. Please accept the Terms of Service and try again. ${console}`);
+}

package/lib/utils.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHostnameFromUrl = exports.openInBrowserPopup = exports.openInBrowser = exports.connectableHostname = exports.randomInt = exports.debounce = exports.last = exports.cloneDeep = exports.groupBy = exports.assertIsStringOrUndefined = exports.assertIsNumber = exports.assertIsString = exports.thirtyDaysFromNow = exports.isRunningInWSL = exports.isVSCodeExtension = exports.isCloudEnvironment = exports.datetimeString = exports.createDestroyer = exports.promiseWithSpinner = exports.setupLoggers = exports.tryParse = exports.tryStringify = exports.promiseProps = exports.withTimeout = exports.promiseWhile = exports.promiseAllSettled = exports.getFunctionsEventProvider = exports.endpoint = exports.makeActiveProject = exports.streamToString = exports.stringToStream = exports.explainStdin = exports.allSettled = exports.reject = exports.logLabeledError = exports.logLabeledWarning = exports.logWarning = exports.logLabeledBullet = exports.logBullet = exports.logLabeledSuccess = exports.logSuccess = exports.addSubdomain = exports.addDatabaseNamespace = exports.getDatabaseViewDataUrl = exports.getDatabaseUrl = exports.envOverride = exports.getInheritedOption = exports.consoleUrl = exports.envOverrides = exports.IS_WINDOWS = void 0;
-exports.readSecretValue = void 0;
-const fs = require("node:fs");
+exports.connectableHostname = exports.randomInt = exports.debounce = exports.last = exports.cloneDeep = exports.groupBy = exports.assertIsStringOrUndefined = exports.assertIsNumber = exports.assertIsString = exports.thirtyDaysFromNow = exports.isRunningInWSL = exports.isVSCodeExtension = exports.isCloudEnvironment = exports.datetimeString = exports.createDestroyer = exports.sleep = exports.promiseWithSpinner = exports.setupLoggers = exports.tryParse = exports.tryStringify = exports.promiseProps = exports.withTimeout = exports.promiseWhile = exports.promiseAllSettled = exports.getFunctionsEventProvider = exports.endpoint = exports.makeActiveProject = exports.streamToString = exports.stringToStream = exports.explainStdin = exports.allSettled = exports.reject = exports.logLabeledError = exports.logLabeledWarning = exports.logWarning = exports.logLabeledBullet = exports.logBullet = exports.logLabeledSuccess = exports.logSuccess = exports.addSubdomain = exports.addDatabaseNamespace = exports.getDatabaseViewDataUrl = exports.getDatabaseUrl = exports.envOverride = exports.setVSCodeEnvVars = exports.getInheritedOption = exports.consoleUrl = exports.vscodeEnvVars = exports.envOverrides = exports.IS_WINDOWS = void 0;
+exports.readSecretValue = exports.generateId = exports.wrappedSafeLoad = exports.readFileFromDirectory = exports.getHostnameFromUrl = exports.openInBrowserPopup = exports.openInBrowser = void 0;
+const fs = require("fs-extra");
 const tty = require("tty");
 const path = require("node:path");
+const yaml = require("yaml");
 const _ = require("lodash");
 const url = require("url");
 const http = require("http");
@@ -28,6 +29,7 @@ const WARNING_CHAR = exports.IS_WINDOWS ? "!" : "⚠";
 const ERROR_CHAR = exports.IS_WINDOWS ? "!!" : "⬢";
 const THIRTY_DAYS_IN_MILLISECONDS = 30 * 24 * 60 * 60 * 1000;
 exports.envOverrides = [];
+exports.vscodeEnvVars = {};
 function consoleUrl(project, path) {
     const api = require("./api");
     return `${api.consoleOrigin()}/project/${project}${path}`;
@@ -43,8 +45,12 @@ function getInheritedOption(options, key) {
     }
 }
 exports.getInheritedOption = getInheritedOption;
+function setVSCodeEnvVars(envVar, value) {
+    exports.vscodeEnvVars[envVar] = value;
+}
+exports.setVSCodeEnvVars = setVSCodeEnvVars;
 function envOverride(envname, value, coerce) {
-    const currentEnvValue = process.env[envname];
+    const currentEnvValue = isVSCodeExtension() && exports.vscodeEnvVars[envname] ? exports.vscodeEnvVars[envname] : process.env[envname];
     if (currentEnvValue && currentEnvValue.length) {
         exports.envOverrides.push(envname);
         if (coerce) {
@@ -336,6 +342,10 @@ async function promiseWithSpinner(action, message) {
     return data;
 }
 exports.promiseWithSpinner = promiseWithSpinner;
+function sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+exports.sleep = sleep;
 function createDestroyer(server) {
     const connections = new Set();
     server.on("connection", (conn) => {
@@ -527,6 +537,47 @@ function getHostnameFromUrl(url) {
     }
 }
 exports.getHostnameFromUrl = getHostnameFromUrl;
+function readFileFromDirectory(directory, file) {
+    return new Promise((resolve, reject) => {
+        fs.readFile(path.resolve(directory, file), "utf8", (err, data) => {
+            if (err) {
+                if (err.code === "ENOENT") {
+                    return reject(new error_1.FirebaseError(`Could not find "${file}" in "${directory}"`, { original: err }));
+                }
+                reject(new error_1.FirebaseError(`Failed to read file "${file}" in "${directory}"`, { original: err }));
+            }
+            else {
+                resolve(data);
+            }
+        });
+    }).then((source) => {
+        return {
+            source,
+            sourceDirectory: directory,
+        };
+    });
+}
+exports.readFileFromDirectory = readFileFromDirectory;
+function wrappedSafeLoad(source) {
+    try {
+        return yaml.parse(source);
+    }
+    catch (err) {
+        throw new error_1.FirebaseError(`YAML Error: ${err.message}`, { original: err });
+    }
+}
+exports.wrappedSafeLoad = wrappedSafeLoad;
+function generateId(n = 6) {
+    const letters = "abcdefghijklmnopqrstuvwxyz";
+    const allChars = "01234567890-abcdefghijklmnopqrstuvwxyz";
+    let id = letters[Math.floor(Math.random() * letters.length)];
+    for (let i = 1; i < n; i++) {
+        const idx = Math.floor(Math.random() * allChars.length);
+        id += allChars[idx];
+    }
+    return id;
+}
+exports.generateId = generateId;
 function readSecretValue(prompt, dataFile) {
     if ((!dataFile || dataFile === "-") && tty.isatty(0)) {
         return (0, prompt_1.promptOnce)({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-tools",
-  "version": "13.7.5",
+  "version": "13.8.1",
   "description": "Command-Line Interface for Firebase",
   "main": "./lib/index.js",
   "bin": {
@@ -58,6 +58,7 @@
     ]
   },
   "dependencies": {
+    "@google-cloud/cloud-sql-connector": "^1.2.3",
     "@google-cloud/pubsub": "^3.0.1",
     "abort-controller": "^3.0.0",
     "ajv": "^6.12.6",
@@ -82,8 +83,9 @@
     "form-data": "^4.0.0",
     "fs-extra": "^10.1.0",
     "fuzzy": "^0.1.3",
+    "gaxios": "^6.1.1",
     "glob": "^7.1.2",
-    "google-auth-library": "^7.11.0",
+    "google-auth-library": "^9.7.0",
     "inquirer": "^8.2.6",
     "inquirer-autocomplete-prompt": "^2.0.1",
     "jsonwebtoken": "^9.0.0",
@@ -99,12 +101,14 @@
     "open": "^6.3.0",
     "ora": "^5.4.1",
     "p-limit": "^3.0.1",
+    "pg": "^8.11.3",
     "portfinder": "^1.0.32",
     "progress": "^2.0.3",
     "proxy-agent": "^6.3.0",
     "retry": "^0.13.1",
     "rimraf": "^3.0.0",
     "semver": "^7.5.2",
+    "sql-formatter": "^15.3.0",
     "stream-chain": "^2.2.4",
     "stream-json": "^1.7.3",
     "strip-ansi": "^6.0.1",

package/schema/connector-yaml.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": false,
+  "definitions": {
+    "generatable": {
+      "additionalProperties": true,
+      "type": "object",
+      "properties": {
+        "outputDir": {
+          "type": "string",
+          "description": "Path to the directory where generated files should be written to."
+        }
+      }
+    }
+  },
+  "properties": {
+    "connectorId": {
+      "type": "string",
+      "description": "The ID of the Firebase Data Connect connector."
+    },
+    "authMode": {
+      "type": "string",
+      "description": "The authentication strategy to use for this connector"
+
+    },
+    "generate": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "javascriptSdk": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/generatable"
+          },
+          "description": "Configuration for a generated Javascript SDK"
+        },
+        "kotlinSdk": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/generatable"
+          },
+          "description": "Configuration for a generated Kotlin SDK"
+        },
+        "swiftSdk": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/generatable"
+          },
+          "description": "Configuration for a generated Swift SDK"
+        }
+      }
+    }
+  }
+}

package/schema/dataconnect-yaml.json

@@ -0,0 +1,72 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": false,
+  "definitions": {
+    "postgresql": {
+      "additionalProperties": false,
+      "type": "object",
+      "properties": {
+        "database": {
+          "type": "string",
+          "description": "The name of the PostgreSQL database."
+        },
+        "cloudSql": {
+          "additionalProperties": false,
+          "type": "object",
+          "properties": {
+            "instanceId": {
+              "type": "string",
+              "description": "The ID of the CloudSQL instance for this database"
+            }
+          }
+        }
+      }
+    },
+    "dataSource": {
+      "oneOf": [
+        {  
+          "additionalProperties": false,
+          "type": "object",
+          "properties": {
+            "postgresql": {
+              "$ref": "#/definitions/postgresql"
+            }
+          }
+        }
+      ]
+    },
+    "schema": {
+      "additionalProperties": false,
+      "type": "object",
+      "properties": {
+        "source": {
+          "type": "string",
+          "description": "Relative path to directory containing GQL files defining the schema. If omitted, defaults to ./schema."
+        },
+        "datasource": {
+          "$ref": "#/definitions/dataSource"
+        }
+      }
+    }
+  },
+  "properties": {
+    "specVersion": {
+      "type": "string",
+      "description": "The Firebase Data Connect API version to target. If omitted, defaults to the latest version"
+    },
+    "serviceId": {
+      "type": "string",
+      "description": "The ID of the Firebase Data Connect service."
+    },
+    "connectorDirs": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "A list of directories containing conector.yaml files describing a connector to deploy."
+    },
+    "schema": {
+      "$ref": "#/definitions/schema"
+    }
+  }
+}

package/schema/firebase-config.json

@@ -271,6 +271,97 @@
                 }
             ]
         },
+        "dataconnect": {
+            "anyOf": [
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "location": {
+                            "type": "string"
+                        },
+                        "postdeploy": {
+                            "anyOf": [
+                                {
+                                    "items": {
+                                        "type": "string"
+                                    },
+                                    "type": "array"
+                                },
+                                {
+                                    "type": "string"
+                                }
+                            ]
+                        },
+                        "predeploy": {
+                            "anyOf": [
+                                {
+                                    "items": {
+                                        "type": "string"
+                                    },
+                                    "type": "array"
+                                },
+                                {
+                                    "type": "string"
+                                }
+                            ]
+                        },
+                        "source": {
+                            "type": "string"
+                        }
+                    },
+                    "required": [
+                        "location",
+                        "source"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "items": {
+                        "additionalProperties": false,
+                        "properties": {
+                            "location": {
+                                "type": "string"
+                            },
+                            "postdeploy": {
+                                "anyOf": [
+                                    {
+                                        "items": {
+                                            "type": "string"
+                                        },
+                                        "type": "array"
+                                    },
+                                    {
+                                        "type": "string"
+                                    }
+                                ]
+                            },
+                            "predeploy": {
+                                "anyOf": [
+                                    {
+                                        "items": {
+                                            "type": "string"
+                                        },
+                                        "type": "array"
+                                    },
+                                    {
+                                        "type": "string"
+                                    }
+                                ]
+                            },
+                            "source": {
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "location",
+                            "source"
+                        ],
+                        "type": "object"
+                    },
+                    "type": "array"
+                }
+            ]
+        },
         "emulators": {
             "additionalProperties": false,
             "properties": {
@@ -298,6 +389,18 @@
                     },
                     "type": "object"
                 },
+                "dataconnect": {
+                    "additionalProperties": false,
+                    "properties": {
+                        "host": {
+                            "type": "string"
+                        },
+                        "port": {
+                            "type": "number"
+                        }
+                    },
+                    "type": "object"
+                },
                 "eventarc": {
                     "additionalProperties": false,
                     "properties": {

package/templates/extensions/javascript/package.lint.json

@@ -3,8 +3,8 @@
   "description": "Greet the world",
   "main": "index.js",
   "dependencies": {
-    "firebase-admin": "^11.5.0",
-    "firebase-functions": "^4.2.0"
+    "firebase-admin": "^12.1.0",
+    "firebase-functions": "^5.0.0"
   },
   "devDependencies": {
     "eslint": "^8.15.1",

package/templates/extensions/javascript/package.nolint.json

@@ -3,8 +3,8 @@
   "description": "Greet the world",
   "main": "index.js",
   "dependencies": {
-    "firebase-admin": "^11.5.0",
-    "firebase-functions": "^4.2.0"
+    "firebase-admin": "^12.1.0",
+    "firebase-functions": "^5.0.0"
   },
   "devDependencies": {
     "axios": "^1.3.2",

package/templates/extensions/typescript/package.lint.json

@@ -10,8 +10,8 @@
   },
   "main": "lib/index.js",
   "dependencies": {
-    "firebase-admin": "^11.5.0",
-    "firebase-functions": "^4.2.0"
+    "firebase-admin": "^12.1.0",
+    "firebase-functions": "^5.0.0"
   },
   "devDependencies": {
     "@types/chai": "^4.3.4",

package/templates/extensions/typescript/package.nolint.json

@@ -8,8 +8,8 @@
   },
   "main": "lib/index.js",
   "dependencies": {
-    "firebase-admin": "^11.5.0",
-    "firebase-functions": "^4.2.0"
+    "firebase-admin": "^12.1.0",
+    "firebase-functions": "^5.0.0"
   },
   "devDependencies": {
     "@types/chai": "^4.3.4",

package/templates/init/dataconnect/connector.yaml

@@ -0,0 +1,2 @@
+connectorId: "__connectorId__"
+authMode: "PUBLIC" 

package/templates/init/dataconnect/dataconnect.yaml

@@ -0,0 +1,10 @@
+specVersion: "v1alpha"
+serviceId: "__serviceId__"
+schema:
+  source: "./schema"
+  datasource:
+    postgresql:
+      database: "__cloudSqlDatabase__"
+      cloudSql:
+        instanceId: "__cloudSqlInstanceId__"
+connectorDirs: ["./connector"]

package/templates/init/dataconnect/mutations.gql

@@ -0,0 +1,4 @@
+# # Example mutations
+# mutation createOrder($name: String!) {
+#   order_insert(data : {name: $name})
+# }

package/templates/init/dataconnect/queries.gql

@@ -0,0 +1,6 @@
+# # Example query
+# query listOrders {
+#   orders {
+#     name
+#   }
+# }

package/templates/init/dataconnect/schema.gql

@@ -0,0 +1,15 @@
+# # Example schema
+# type Product @table {
+#   name: String!
+#   price: Int!
+# }
+
+# type Order @table {
+#   name: String!
+# }
+
+# type OrderItem @table(key: ["order", "product"]) {
+#   order: Order!
+#   product: Product!
+#   quantity: Int!
+# }

package/templates/init/functions/javascript/_gitignore

@@ -1 +1,2 @@
-node_modules/
+node_modules/
+*.local

package/templates/init/functions/javascript/package.lint.json

@@ -14,8 +14,8 @@
   },
   "main": "index.js",
   "dependencies": {
-    "firebase-admin": "^11.8.0",
-    "firebase-functions": "^4.3.1"
+    "firebase-admin": "^12.1.0",
+    "firebase-functions": "^5.0.0"
   },
   "devDependencies": {
     "eslint": "^8.15.0",

package/templates/init/functions/javascript/package.nolint.json

@@ -13,8 +13,8 @@
   },
   "main": "index.js",
   "dependencies": {
-    "firebase-admin": "^11.8.0",
-    "firebase-functions": "^4.3.1"
+    "firebase-admin": "^12.1.0",
+    "firebase-functions": "^5.0.0"
   },
   "devDependencies": {
     "firebase-functions-test": "^3.1.0"

package/templates/init/functions/python/_gitignore

@@ -0,0 +1 @@
+*.local

package/templates/init/functions/typescript/_gitignore

@@ -7,3 +7,4 @@ typings/
 
 # Node.js dependency directory
 node_modules/
+*.local

package/templates/init/functions/typescript/package.lint.json

@@ -15,8 +15,8 @@
   },
   "main": "lib/index.js",
   "dependencies": {
-    "firebase-admin": "^11.8.0",
-    "firebase-functions": "^4.3.1"
+    "firebase-admin": "^12.1.0",
+    "firebase-functions": "^5.0.0"
   },
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^5.12.0",