@firebase/remote-config 0.5.0 → 0.6.0-20250226000544

package/dist/esm/index.esm2017.js

@@ -1,11 +1,11 @@
 import { _getProvider, getApp, _registerComponent, registerVersion, SDK_VERSION } from '@firebase/app';
-import { ErrorFactory, FirebaseError, getModularInstance, calculateBackoffMillis, isIndexedDBAvailable, validateIndexedDBOpenable } from '@firebase/util';
+import { ErrorFactory, FirebaseError, getModularInstance, deepEqual, calculateBackoffMillis, isIndexedDBAvailable, validateIndexedDBOpenable } from '@firebase/util';
 import { Component } from '@firebase/component';
 import { LogLevel, Logger } from '@firebase/logger';
 import '@firebase/installations';
 
 const name = "@firebase/remote-config";
-const version = "0.5.0";
+const version = "0.6.0-20250226000544";
 
 /**
  * @license
@@ -81,6 +81,7 @@ const RC_CUSTOM_SIGNAL_VALUE_MAX_LENGTH = 500;
  * limitations under the License.
  */
 const ERROR_DESCRIPTION_MAP = {
+    ["already-initialized" /* ErrorCode.ALREADY_INITIALIZED */]: 'Remote Config already initialized',
     ["registration-window" /* ErrorCode.REGISTRATION_WINDOW */]: 'Undefined window object. This SDK only supports usage in a browser environment.',
     ["registration-project-id" /* ErrorCode.REGISTRATION_PROJECT_ID */]: 'Undefined project identifier. Check Firebase app initialization.',
     ["registration-api-key" /* ErrorCode.REGISTRATION_API_KEY */]: 'Undefined API key. Check Firebase app initialization.',
@@ -176,14 +177,40 @@ class Value {
 /**
  *
  * @param app - The {@link @firebase/app#FirebaseApp} instance.
+ * @param options - Optional. The {@link RemoteConfigOptions} with which to instantiate the
+ *     Remote Config instance.
  * @returns A {@link RemoteConfig} instance.
  *
  * @public
  */
-function getRemoteConfig(app = getApp()) {
+function getRemoteConfig(app = getApp(), options = {}) {
+    var _a, _b;
     app = getModularInstance(app);
     const rcProvider = _getProvider(app, RC_COMPONENT_NAME);
-    return rcProvider.getImmediate();
+    if (rcProvider.isInitialized()) {
+        const initialOptions = rcProvider.getOptions();
+        if (deepEqual(initialOptions, options)) {
+            return rcProvider.getImmediate();
+        }
+        throw ERROR_FACTORY.create("already-initialized" /* ErrorCode.ALREADY_INITIALIZED */);
+    }
+    rcProvider.initialize({ options });
+    const rc = rcProvider.getImmediate();
+    if (options.initialFetchResponse) {
+        // We use these initial writes as the initialization promise since they will hydrate the same
+        // fields that `storageCache.loadFromStorage` would set.
+        rc._initializePromise = Promise.all([
+            rc._storage.setLastSuccessfulFetchResponse(options.initialFetchResponse),
+            rc._storage.setActiveConfigEtag(((_a = options.initialFetchResponse) === null || _a === void 0 ? void 0 : _a.eTag) || ''),
+            rc._storageCache.setLastSuccessfulFetchTimestampMillis(Date.now()),
+            rc._storageCache.setLastFetchStatus('success'),
+            rc._storageCache.setActiveConfig(((_b = options.initialFetchResponse) === null || _b === void 0 ? void 0 : _b.config) || {})
+        ]).then();
+        // The `storageCache` methods above set their in-memory fields synchronously, so it's
+        // safe to declare our initialization complete at this point.
+        rc._isInitializationComplete = true;
+    }
+    return rc;
 }
 /**
  * Makes the last fetched config available to the getters.
@@ -805,7 +832,7 @@ const DEFAULT_CACHE_MAX_AGE_MILLIS = 12 * 60 * 60 * 1000; // Twelve hours.
 /**
  * Encapsulates business logic mapping network and storage dependencies to the public SDK API.
  *
- * See {@link https://github.com/firebase/firebase-js-sdk/blob/main/packages/firebase/index.d.ts|interface documentation} for method descriptions.
+ * See {@link https://github.com/firebase/firebase-js-sdk/blob/main/packages/firebase/compat/index.d.ts|interface documentation} for method descriptions.
  */
 class RemoteConfig {
     get fetchTimeMillis() {
@@ -929,17 +956,6 @@ function openDatabase() {
  * Abstracts data persistence.
  */
 class Storage {
-    /**
-     * @param appId enables storage segmentation by app (ID + name).
-     * @param appName enables storage segmentation by app (ID + name).
-     * @param namespace enables storage segmentation by namespace.
-     */
-    constructor(appId, appName, namespace, openDbPromise = openDatabase()) {
-        this.appId = appId;
-        this.appName = appName;
-        this.namespace = namespace;
-        this.openDbPromise = openDbPromise;
-    }
     getLastFetchStatus() {
         return this.get('last_fetch_status');
     }
@@ -984,28 +1000,25 @@ class Storage {
     getCustomSignals() {
         return this.get('custom_signals');
     }
+}
+class IndexedDbStorage extends Storage {
+    /**
+     * @param appId enables storage segmentation by app (ID + name).
+     * @param appName enables storage segmentation by app (ID + name).
+     * @param namespace enables storage segmentation by namespace.
+     */
+    constructor(appId, appName, namespace, openDbPromise = openDatabase()) {
+        super();
+        this.appId = appId;
+        this.appName = appName;
+        this.namespace = namespace;
+        this.openDbPromise = openDbPromise;
+    }
     async setCustomSignals(customSignals) {
         const db = await this.openDbPromise;
         const transaction = db.transaction([APP_NAMESPACE_STORE], 'readwrite');
         const storedSignals = await this.getWithTransaction('custom_signals', transaction);
-        const combinedSignals = Object.assign(Object.assign({}, storedSignals), customSignals);
-        // Filter out key-value assignments with null values since they are signals being unset
-        const updatedSignals = Object.fromEntries(Object.entries(combinedSignals)
-            .filter(([_, v]) => v !== null)
-            .map(([k, v]) => {
-            // Stringify numbers to store a map of string keys and values which can be sent
-            // as-is in a fetch call.
-            if (typeof v === 'number') {
-                return [k, v.toString()];
-            }
-            return [k, v];
-        }));
-        // Throw an error if the number of custom signals to be stored exceeds the limit
-        if (Object.keys(updatedSignals).length > RC_CUSTOM_SIGNAL_MAX_ALLOWED_SIGNALS) {
-            throw ERROR_FACTORY.create("custom-signal-max-allowed-signals" /* ErrorCode.CUSTOM_SIGNAL_MAX_ALLOWED_SIGNALS */, {
-                maxSignals: RC_CUSTOM_SIGNAL_MAX_ALLOWED_SIGNALS
-            });
-        }
+        const updatedSignals = mergeCustomSignals(customSignals, storedSignals || {});
         await this.setWithTransaction('custom_signals', updatedSignals, transaction);
         return updatedSignals;
     }
@@ -1110,6 +1123,50 @@ class Storage {
         return [this.appId, this.appName, this.namespace, key].join();
     }
 }
+class InMemoryStorage extends Storage {
+    constructor() {
+        super(...arguments);
+        this.storage = {};
+    }
+    async get(key) {
+        return Promise.resolve(this.storage[key]);
+    }
+    async set(key, value) {
+        this.storage[key] = value;
+        return Promise.resolve(undefined);
+    }
+    async delete(key) {
+        this.storage[key] = undefined;
+        return Promise.resolve();
+    }
+    async setCustomSignals(customSignals) {
+        const storedSignals = (this.storage['custom_signals'] ||
+            {});
+        this.storage['custom_signals'] = mergeCustomSignals(customSignals, storedSignals);
+        return Promise.resolve(this.storage['custom_signals']);
+    }
+}
+function mergeCustomSignals(customSignals, storedSignals) {
+    const combinedSignals = Object.assign(Object.assign({}, storedSignals), customSignals);
+    // Filter out key-value assignments with null values since they are signals being unset
+    const updatedSignals = Object.fromEntries(Object.entries(combinedSignals)
+        .filter(([_, v]) => v !== null)
+        .map(([k, v]) => {
+        // Stringify numbers to store a map of string keys and values which can be sent
+        // as-is in a fetch call.
+        if (typeof v === 'number') {
+            return [k, v.toString()];
+        }
+        return [k, v];
+    }));
+    // Throw an error if the number of custom signals to be stored exceeds the limit
+    if (Object.keys(updatedSignals).length > RC_CUSTOM_SIGNAL_MAX_ALLOWED_SIGNALS) {
+        throw ERROR_FACTORY.create("custom-signal-max-allowed-signals" /* ErrorCode.CUSTOM_SIGNAL_MAX_ALLOWED_SIGNALS */, {
+            maxSignals: RC_CUSTOM_SIGNAL_MAX_ALLOWED_SIGNALS
+        });
+    }
+    return updatedSignals;
+}
 
 /**
  * @license
@@ -1221,7 +1278,7 @@ function registerRemoteConfig() {
     registerVersion(name, version);
     // BUILD_TARGET will be replaced by values like esm2017, cjs2017, etc during the compilation
     registerVersion(name, version, 'esm2017');
-    function remoteConfigFactory(container, { instanceIdentifier: namespace }) {
+    function remoteConfigFactory(container, { options }) {
         /* Dependencies */
         // getImmediate for FirebaseApp will always succeed
         const app = container.getProvider('app').getImmediate();
@@ -1229,14 +1286,6 @@ function registerRemoteConfig() {
         const installations = container
             .getProvider('installations-internal')
             .getImmediate();
-        // Guards against the SDK being used in non-browser environments.
-        if (typeof window === 'undefined') {
-            throw ERROR_FACTORY.create("registration-window" /* ErrorCode.REGISTRATION_WINDOW */);
-        }
-        // Guards against the SDK being used when indexedDB is not available.
-        if (!isIndexedDBAvailable()) {
-            throw ERROR_FACTORY.create("indexed-db-unavailable" /* ErrorCode.INDEXED_DB_UNAVAILABLE */);
-        }
         // Normalizes optional inputs.
         const { projectId, apiKey, appId } = app.options;
         if (!projectId) {
@@ -1248,8 +1297,10 @@ function registerRemoteConfig() {
         if (!appId) {
             throw ERROR_FACTORY.create("registration-app-id" /* ErrorCode.REGISTRATION_APP_ID */);
         }
-        namespace = namespace || 'firebase';
-        const storage = new Storage(appId, app.name, namespace);
+        const namespace = (options === null || options === void 0 ? void 0 : options.templateId) || 'firebase';
+        const storage = isIndexedDBAvailable()
+            ? new IndexedDbStorage(appId, app.name, namespace)
+            : new InMemoryStorage();
         const storageCache = new StorageCache(storage);
         const logger = new Logger(name);
         // Sets ERROR as the default log level.