firebase-tools 13.11.3 → 13.12.0

package/lib/init/index.js

@@ -11,6 +11,7 @@ const featureFns = new Map([
     ["database", features.database],
     ["firestore", features.firestore],
     ["dataconnect", features.dataconnect],
+    ["dataconnect:sdk", features.dataconnectSdk],
     ["functions", features.functions],
     ["hosting", features.hosting],
     ["storage", features.storage],

package/lib/listFiles.js

@@ -9,6 +9,7 @@ function listFiles(cwd, ignore = []) {
         follow: true,
         ignore: ["**/firebase-debug.log", "**/firebase-debug.*.log", ".firebase/*"].concat(ignore),
         nodir: true,
+        posix: true,
     });
 }
 exports.listFiles = listFiles;

package/lib/management/apps.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deleteAppAndroidSha = exports.createAppAndroidSha = exports.listAppAndroidSha = exports.getAppConfig = exports.getAppConfigFile = exports.listFirebaseApps = exports.createWebApp = exports.createAndroidApp = exports.createIosApp = exports.getAppPlatform = exports.ShaCertificateType = exports.AppPlatform = exports.APP_LIST_PAGE_SIZE = void 0;
-const fs = require("fs");
 const apiv2_1 = require("../apiv2");
 const api_1 = require("../api");
 const error_1 = require("../error");
 const logger_1 = require("../logger");
 const operation_poller_1 = require("../operation-poller");
+const templates_1 = require("../templates");
 const TIMEOUT_MILLIS = 30000;
 exports.APP_LIST_PAGE_SIZE = 100;
 const CREATE_APP_API_REQUEST_TIMEOUT_MILLIS = 15000;
@@ -182,7 +182,7 @@ function getAppConfigResourceString(appId, platform) {
 }
 function parseConfigFromResponse(responseBody, platform) {
     if (platform === AppPlatform.WEB) {
-        const JS_TEMPLATE = fs.readFileSync(__dirname + "/../../templates/setup/web.js", "utf8");
+        const JS_TEMPLATE = (0, templates_1.readTemplateSync)("setup/web.js");
         return {
             fileName: WEB_CONFIG_FILE_NAME,
             fileContents: JS_TEMPLATE.replace("{/*--CONFIG--*/}", JSON.stringify(responseBody, null, 2)),

package/lib/templates.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readTemplate = exports.readTemplateSync = exports.absoluteTemplateFilePath = void 0;
+const fs_1 = require("fs");
+const promises_1 = require("fs/promises");
+const path_1 = require("path");
+const utils_1 = require("./utils");
+const TEMPLATE_ENCODING = "utf8";
+function absoluteTemplateFilePath(relPath) {
+    if ((0, utils_1.isVSCodeExtension)()) {
+        return (0, path_1.resolve)(__dirname, "templates", relPath);
+    }
+    return (0, path_1.resolve)(__dirname, "../templates", relPath);
+}
+exports.absoluteTemplateFilePath = absoluteTemplateFilePath;
+function readTemplateSync(relPath) {
+    return (0, fs_1.readFileSync)(absoluteTemplateFilePath(relPath), TEMPLATE_ENCODING);
+}
+exports.readTemplateSync = readTemplateSync;
+function readTemplate(relPath) {
+    return (0, promises_1.readFile)(absoluteTemplateFilePath(relPath), TEMPLATE_ENCODING);
+}
+exports.readTemplate = readTemplate;

package/lib/utils.js

@@ -23,6 +23,7 @@ const configstore_1 = require("./configstore");
 const error_1 = require("./error");
 const logger_1 = require("./logger");
 const prompt_1 = require("./prompt");
+const templates_1 = require("./templates");
 exports.IS_WINDOWS = process.platform === "win32";
 const SUCCESS_CHAR = exports.IS_WINDOWS ? "+" : "✔";
 const WARNING_CHAR = exports.IS_WINDOWS ? "!" : "⚠";
@@ -504,8 +505,7 @@ async function openInBrowser(url) {
 }
 exports.openInBrowser = openInBrowser;
 async function openInBrowserPopup(url, buttonText) {
-    const popupPage = fs
-        .readFileSync(path.join(__dirname, "../templates/popup.html"), { encoding: "utf-8" })
+    const popupPage = (0, templates_1.readTemplateSync)("popup.html")
         .replace("${url}", url)
         .replace("${buttonText}", buttonText);
     const port = await (0, portfinder_1.getPortPromise)();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-tools",
-  "version": "13.11.3",
+  "version": "13.12.0",
   "description": "Command-Line Interface for Firebase",
   "main": "./lib/index.js",
   "bin": {

package/schema/connector-yaml.json

@@ -2,7 +2,39 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "additionalProperties": false,
   "definitions": {
-    "generatable": {
+    "javascriptSdk": {
+      "additionalProperties": true,
+      "type": "object",
+      "properties": {
+        "outputDir": {
+          "type": "string",
+          "description": "Path to the directory where generated files should be written to."
+        },
+        "package": {
+          "type": "string",
+          "description": "The package name to use for the generated code."
+        },
+        "packageJSONDir": {
+          "type": "string",
+          "description": "The directory containining the package.json to install the generated package in."
+        }
+      }
+    },
+    "kotlinSdk": {
+      "additionalProperties": true,
+      "type": "object",
+      "properties": {
+        "outputDir": {
+          "type": "string",
+          "description": "Path to the directory where generated files should be written to."
+        },
+        "package": {
+          "type": "string",
+          "description": "The package name to use for the generated code."
+        }
+      }
+    },
+    "swiftSdk": {
       "additionalProperties": true,
       "type": "object",
       "properties": {
@@ -30,21 +62,21 @@
         "javascriptSdk": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/generatable"
+            "$ref": "#/definitions/javascriptSdk"
           },
           "description": "Configuration for a generated Javascript SDK"
         },
         "kotlinSdk": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/generatable"
+            "$ref": "#/definitions/kotlinSdk"
           },
           "description": "Configuration for a generated Kotlin SDK"
         },
         "swiftSdk": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/generatable"
+            "$ref": "#/definitions/swiftSdk"
           },
           "description": "Configuration for a generated Swift SDK"
         }

package/schema/dataconnect-yaml.json

@@ -58,6 +58,10 @@
       "type": "string",
       "description": "The ID of the Firebase Data Connect service."
     },
+    "location": {
+      "type": "string",
+      "description": "The region of the Firebase Data Connect service."
+    },
     "connectorDirs": {
       "type": "array",
       "items": {

package/schema/firebase-config.json

@@ -276,9 +276,6 @@
                 {
                     "additionalProperties": false,
                     "properties": {
-                        "location": {
-                            "type": "string"
-                        },
                         "postdeploy": {
                             "anyOf": [
                                 {
@@ -310,7 +307,6 @@
                         }
                     },
                     "required": [
-                        "location",
                         "source"
                     ],
                     "type": "object"
@@ -319,9 +315,6 @@
                     "items": {
                         "additionalProperties": false,
                         "properties": {
-                            "location": {
-                                "type": "string"
-                            },
                             "postdeploy": {
                                 "anyOf": [
                                     {
@@ -353,7 +346,6 @@
                             }
                         },
                         "required": [
-                            "location",
                             "source"
                         ],
                         "type": "object"

package/templates/_gitignore

@@ -64,3 +64,6 @@ node_modules/
 
 # dotenv environment variables file
 .env
+
+# dataconnect generated files
+.dataconnect

package/templates/init/dataconnect/connector.yaml

@@ -1,2 +1,13 @@
 connectorId: "__connectorId__"
 authMode: "PUBLIC" 
+## ## Here's an example of how to add generated SDKs.
+## ## You'll need to replace the outputDirs with ones pointing to where you want the generated code in your app.
+# generate:
+#   javascriptSdk:
+#     outputDir: <Path where you want the generated SDK to be written to, relative to this file>
+#     package: "@firebasegen/my-connector"
+#     packageJSONDir: < Optional. Path to your Javascript app's package.json>
+#   swiftSdk:
+#     outputDir: <Path where you want the generated SDK to be written to, relative to this file>
+#   kotlinSdk:
+#     outputDir: <Path where you want the generated SDK to be written to, relative to this file>

package/templates/init/dataconnect/dataconnect.yaml

@@ -1,5 +1,6 @@
 specVersion: "v1alpha"
 serviceId: "__serviceId__"
+location: "__location__"
 schema:
   source: "./schema"
   datasource: