@firebase/util 1.10.3 → 1.11.0

package/dist/node-esm/src/postinstall.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { FirebaseDefaults } from './defaults';
+export declare const getDefaultsFromPostinstall: () => FirebaseDefaults | undefined;

package/dist/postinstall.js

@@ -0,0 +1,24 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// This value is retrieved and hardcoded by the NPM postinstall script
+const getDefaultsFromPostinstall = () => undefined;
+
+exports.getDefaultsFromPostinstall = getDefaultsFromPostinstall;

package/dist/postinstall.mjs

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// This value is retrieved and hardcoded by the NPM postinstall script
+const getDefaultsFromPostinstall = () => undefined;
+
+export { getDefaultsFromPostinstall };

package/dist/src/postinstall.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { FirebaseDefaults } from './defaults';
+export declare const getDefaultsFromPostinstall: () => FirebaseDefaults | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/util",
-  "version": "1.10.3",
+  "version": "1.11.0",
   "description": "",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "main": "dist/index.node.cjs.js",
@@ -22,7 +22,8 @@
     "./package.json": "./package.json"
   },
   "files": [
-    "dist"
+    "dist",
+    "postinstall.js"
   ],
   "scripts": {
     "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
@@ -38,15 +39,17 @@
     "test:node": "TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha test/**/*.test.* --config ../../config/mocharc.node.js",
     "trusted-type-check": "tsec -p tsconfig.json --noEmit",
     "api-report": "api-extractor run --local --verbose",
-    "typings:public": "node ../../scripts/build/use_typings.js ./dist/util-public.d.ts"
+    "typings:public": "node ../../scripts/build/use_typings.js ./dist/util-public.d.ts",
+    "postinstall": "node ./postinstall.js"
   },
   "license": "Apache-2.0",
   "dependencies": {
     "tslib": "^2.1.0"
   },
   "devDependencies": {
-    "rollup": "2.79.1",
-    "rollup-plugin-typescript2": "0.31.2",
+    "@rollup/plugin-replace": "6.0.2",
+    "rollup": "2.79.2",
+    "rollup-plugin-typescript2": "0.36.0",
     "typescript": "5.5.4"
   },
   "repository": {

package/postinstall.js

@@ -0,0 +1,153 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const { writeFile, readFile } = require('node:fs/promises');
+const { pathToFileURL } = require('node:url');
+const { isAbsolute, join } = require('node:path');
+
+const ENV_VARIABLE = 'FIREBASE_WEBAPP_CONFIG';
+
+async function getPartialConfig() {
+  const envVariable = process.env[ENV_VARIABLE]?.trim();
+
+  if (!envVariable) {
+    return undefined;
+  }
+
+  // Like FIREBASE_CONFIG (admin autoinit) FIREBASE_WEBAPP_CONFIG can be
+  // either a JSON representation of FirebaseOptions or the path to a filename
+  if (envVariable.startsWith('{"')) {
+    try {
+      return JSON.parse(envVariable);
+    } catch (e) {
+      console.warn(
+        `JSON payload in \$${ENV_VARIABLE} could not be parsed, ignoring.\n`,
+        e
+      );
+      return undefined;
+    }
+  }
+
+  const fileURL = pathToFileURL(
+    isAbsolute(envVariable) ? envVariable : join(process.cwd(), envVariable)
+  );
+
+  try {
+    const fileContents = await readFile(fileURL, 'utf-8');
+    return JSON.parse(fileContents);
+  } catch (e) {
+    console.warn(
+      `Contents of "${envVariable}" could not be parsed, ignoring \$${ENV_VARIABLE}.\n`,
+      e
+    );
+    return undefined;
+  }
+}
+
+async function getFinalConfig(partialConfig) {
+  if (!partialConfig) {
+    return undefined;
+  }
+  // In Firebase App Hosting the config provided to the environment variable is up-to-date and
+  // "complete" we should not reach out to the webConfig endpoint to freshen it
+  if (process.env.X_GOOGLE_TARGET_PLATFORM === 'fah') {
+    return partialConfig;
+  }
+  const projectId = partialConfig.projectId || '-';
+  // If the projectId starts with demo- this is an demo project from the firebase emulators
+  // treat the config as whole
+  if (projectId.startsWith('demo-')) {
+    return partialConfig;
+  }
+  const appId = partialConfig.appId;
+  const apiKey = partialConfig.apiKey;
+  if (!appId || !apiKey) {
+    console.warn(
+      `Unable to fetch Firebase config, appId and apiKey are required, ignoring \$${ENV_VARIABLE}.`
+    );
+    return undefined;
+  }
+
+  const url = `https://firebase.googleapis.com/v1alpha/projects/${projectId}/apps/${appId}/webConfig`;
+
+  try {
+    const response = await fetch(url, {
+      headers: { 'x-goog-api-key': apiKey }
+    });
+    if (!response.ok) {
+      console.warn(
+        `Unable to fetch Firebase config, ignoring \$${ENV_VARIABLE}.`
+      );
+      console.warn(
+        `${url} returned ${response.statusText} (${response.status})`
+      );
+      try {
+        console.warn((await response.json()).error.message);
+      } catch (e) {}
+      return undefined;
+    }
+    const json = await response.json();
+    return { ...json, apiKey };
+  } catch (e) {
+    console.warn(
+      `Unable to fetch Firebase config, ignoring \$${ENV_VARIABLE}.\n`,
+      e
+    );
+    return undefined;
+  }
+}
+
+function handleUnexpectedError(e) {
+  console.warn(
+    `Unexpected error encountered in @firebase/util postinstall script, ignoring \$${ENV_VARIABLE}.`
+  );
+  console.warn(e);
+  process.exit(0);
+}
+
+getPartialConfig()
+  .catch(handleUnexpectedError)
+  .then(getFinalConfig)
+  .catch(handleUnexpectedError)
+  .then(async finalConfig => {
+    const defaults = finalConfig && {
+      config: finalConfig,
+      emulatorHosts: {
+        firestore: process.env.FIRESTORE_EMULATOR_HOST,
+        database: process.env.FIREBASE_DATABASE_EMULATOR_HOST,
+        storage: process.env.FIREBASE_STORAGE_EMULATOR_HOST,
+        auth: process.env.FIREBASE_AUTH_EMULATOR_HOST
+      }
+    };
+
+    await Promise.all([
+      writeFile(
+        join(__dirname, 'dist', 'postinstall.js'),
+        `'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.getDefaultsFromPostinstall = () => (${JSON.stringify(defaults)});`
+      ),
+      writeFile(
+        join(__dirname, 'dist', 'postinstall.mjs'),
+        `const getDefaultsFromPostinstall = () => (${JSON.stringify(defaults)});
+export { getDefaultsFromPostinstall };`
+      )
+    ]);
+
+    process.exit(0);
+  })
+  .catch(handleUnexpectedError);