@react-native-firebase/remote-config 24.1.0 → 25.0.0

package/lib/index.js

@@ -1,400 +0,0 @@
-/*
- * Copyright (c) 2016-present Invertase Limited & Contributors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this library 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 {
-  hasOwnProperty,
-  isNumber,
-  isObject,
-  isString,
-  isUndefined,
-  isIOS,
-  isFunction,
-  parseListenerOrObserver,
-} from '@react-native-firebase/app/dist/module/common';
-import Value from './RemoteConfigValue';
-import {
-  createModuleNamespace,
-  FirebaseModule,
-  getFirebaseRoot,
-} from '@react-native-firebase/app/dist/module/internal';
-import { setReactNativeModule } from '@react-native-firebase/app/dist/module/internal/nativeModule';
-import fallBackModule from './web/RNFBConfigModule';
-import version from './version';
-import { LastFetchStatus, ValueSource } from './statics';
-
-const statics = {
-  LastFetchStatus,
-  ValueSource,
-};
-
-const namespace = 'remoteConfig';
-const nativeModuleName = 'RNFBConfigModule';
-
-class FirebaseConfigModule extends FirebaseModule {
-  constructor(...args) {
-    super(...args);
-    this._settings = {
-      // defaults to 1 minute.
-      fetchTimeMillis: 60000,
-      // defaults to 12 hours.
-      minimumFetchIntervalMillis: 43200000,
-    };
-    this._lastFetchTime = -1;
-    this._values = {};
-    this._configUpdateListenerCount = 0;
-  }
-
-  get defaultConfig() {
-    const updatedDefaultConfig = {};
-    Object.keys(this._values).forEach(key => {
-      // Need to make it an object with key and literal value. Not `Value` instance.
-      updatedDefaultConfig[key] = this._values[key].value;
-    });
-
-    return updatedDefaultConfig;
-  }
-
-  set defaultConfig(defaults) {
-    if (!isObject(defaults)) {
-      throw new Error("firebase.remoteConfig().defaultConfig: 'defaults' must be an object.");
-    }
-    // To make Firebase web v9 API compatible, we update the config first so it immediately
-    // updates defaults on the instance. We then pass to underlying SDK to update. We do this because
-    // there is no way to "await" a setter.
-    this._updateFromConstants(defaults);
-    this.setDefaults.call(this, defaults, true);
-  }
-
-  get settings() {
-    return this._settings;
-  }
-
-  set settings(settings) {
-    // To make Firebase web v9 API compatible, we update the settings first so it immediately
-    // updates settings on the instance. We then pass to underlying SDK to update. We do this because
-    // there is no way to "await" a setter. We can't delegate to `setConfigSettings()` as it is setup
-    // for native.
-    this._updateFromConstants(settings);
-    this.setConfigSettings.call(this, settings, true);
-  }
-
-  getValue(key) {
-    if (!isString(key)) {
-      throw new Error("firebase.remoteConfig().getValue(): 'key' must be a string value.");
-    }
-
-    if (typeof this._values === 'undefined' || !hasOwnProperty(this._values, key)) {
-      return new Value({
-        value: '',
-        source: 'static',
-      });
-    }
-
-    return new Value({ value: `${this._values[key].value}`, source: this._values[key].source });
-  }
-
-  getBoolean(key) {
-    return this.getValue(key).asBoolean();
-  }
-
-  getNumber(key) {
-    return this.getValue(key).asNumber();
-  }
-
-  getString(key) {
-    return this.getValue(key).asString();
-  }
-
-  getAll() {
-    const values = {};
-    Object.keys(this._values).forEach(key => (values[key] = this.getValue(key)));
-    return values;
-  }
-
-  get fetchTimeMillis() {
-    // android returns -1 if no fetch yet and iOS returns 0
-    return this._lastFetchTime;
-  }
-
-  get lastFetchStatus() {
-    return this._lastFetchStatus;
-  }
-
-  /**
-   * Deletes all activated, fetched and defaults configs and resets all Firebase Remote Config settings.
-   * @returns {Promise<null>}
-   */
-  reset() {
-    if (isIOS) {
-      return Promise.resolve(null);
-    }
-
-    return this._promiseWithConstants(this.native.reset());
-  }
-
-  setConfigSettings(settings) {
-    const updatedSettings = {};
-
-    updatedSettings.fetchTimeout = this._settings.fetchTimeMillis / 1000;
-    updatedSettings.minimumFetchInterval = this._settings.minimumFetchIntervalMillis / 1000;
-
-    const apiCalled = arguments[1] == true ? 'settings' : 'setConfigSettings';
-    if (!isObject(settings)) {
-      throw new Error(`firebase.remoteConfig().${apiCalled}(*): settings must set an object.`);
-    }
-
-    if (hasOwnProperty(settings, 'minimumFetchIntervalMillis')) {
-      if (!isNumber(settings.minimumFetchIntervalMillis)) {
-        throw new Error(
-          `firebase.remoteConfig().${apiCalled}(): 'settings.minimumFetchIntervalMillis' must be a number type in milliseconds.`,
-        );
-      } else {
-        updatedSettings.minimumFetchInterval = settings.minimumFetchIntervalMillis / 1000;
-      }
-    }
-
-    if (hasOwnProperty(settings, 'fetchTimeMillis')) {
-      if (!isNumber(settings.fetchTimeMillis)) {
-        throw new Error(
-          `firebase.remoteConfig().${apiCalled}(): 'settings.fetchTimeMillis' must be a number type in milliseconds.`,
-        );
-      } else {
-        updatedSettings.fetchTimeout = settings.fetchTimeMillis / 1000;
-      }
-    }
-
-    return this._promiseWithConstants(this.native.setConfigSettings(updatedSettings));
-  }
-
-  /**
-   * Activates the Fetched RemoteConfig, so that the fetched key-values take effect.
-   * @returns {Promise<boolean>}
-   */
-  activate() {
-    return this._promiseWithConstants(this.native.activate());
-  }
-
-  /**
-   * Fetches parameter values for your app.
-
-   * @param {number} expirationDurationSeconds
-   * @returns {Promise}
-   */
-  fetch(expirationDurationSeconds) {
-    if (!isUndefined(expirationDurationSeconds) && !isNumber(expirationDurationSeconds)) {
-      throw new Error(
-        "firebase.remoteConfig().fetch(): 'expirationDurationSeconds' must be a number value.",
-      );
-    }
-
-    return this._promiseWithConstants(
-      this.native.fetch(expirationDurationSeconds !== undefined ? expirationDurationSeconds : -1),
-    );
-  }
-
-  fetchAndActivate() {
-    return this._promiseWithConstants(this.native.fetchAndActivate());
-  }
-
-  ensureInitialized() {
-    return this._promiseWithConstants(this.native.ensureInitialized());
-  }
-
-  /**
-   * Sets defaults.
-   *
-   * @param {object} defaults
-   */
-  setDefaults(defaults) {
-    const apiCalled = arguments[1] === true ? 'defaultConfig' : 'setDefaults';
-    if (!isObject(defaults)) {
-      throw new Error(`firebase.remoteConfig().${apiCalled}(): 'defaults' must be an object.`);
-    }
-
-    return this._promiseWithConstants(this.native.setDefaults(defaults));
-  }
-
-  /**
-   * Sets defaults based on resource.
-   * @param {string} resourceName
-   */
-  setDefaultsFromResource(resourceName) {
-    if (!isString(resourceName)) {
-      throw new Error(
-        "firebase.remoteConfig().setDefaultsFromResource(): 'resourceName' must be a string value.",
-      );
-    }
-
-    return this._promiseWithConstants(this.native.setDefaultsFromResource(resourceName));
-  }
-
-  /**
-   * Registers an observer to changes in the configuration.
-   *
-   * @param observer - The {@link ConfigUpdateObserver} to be notified of config updates.
-   * @returns An {@link Unsubscribe} function to remove the listener.
-   */
-  onConfigUpdate(observer) {
-    if (!isObject(observer) || !isFunction(observer.next) || !isFunction(observer.error)) {
-      throw new Error("'observer' expected an object with 'next' and 'error' functions.");
-    }
-
-    // We maintaine our pre-web-support native interface but bend it to match
-    // the official JS SDK API by assuming the callback is an Observer, and sending it a ConfigUpdate
-    // compatible parameter that implements the `getUpdatedKeys` method
-    let unsubscribed = false;
-    const subscription = this.emitter.addListener(
-      this.eventNameForApp('on_config_updated'),
-      event => {
-        const { resultType } = event;
-        if (resultType === 'success') {
-          observer.next({
-            getUpdatedKeys: () => {
-              return new Set(event.updatedKeys);
-            },
-          });
-          return;
-        }
-
-        observer.error({
-          code: event.code,
-          message: event.message,
-          nativeErrorMessage: event.nativeErrorMessage,
-        });
-      },
-    );
-    if (this._configUpdateListenerCount === 0) {
-      this.native.onConfigUpdated();
-    }
-
-    this._configUpdateListenerCount++;
-
-    return () => {
-      if (unsubscribed) {
-        // there is no harm in calling this multiple times to unsubscribe,
-        // but anything after the first call is a no-op
-        return;
-      } else {
-        unsubscribed = true;
-      }
-      subscription.remove();
-      this._configUpdateListenerCount--;
-      if (this._configUpdateListenerCount === 0) {
-        this.native.removeConfigUpdateRegistration();
-      }
-    };
-  }
-
-  /**
-   * Registers a listener to changes in the configuration.
-   *
-   * @param listenerOrObserver - function called on config change
-   * @returns {function} unsubscribe listener
-   * @deprecated use official firebase-js-sdk onConfigUpdate now that web supports realtime
-   */
-  onConfigUpdated(listenerOrObserver) {
-    const listener = parseListenerOrObserver(listenerOrObserver);
-    let unsubscribed = false;
-    const subscription = this.emitter.addListener(
-      this.eventNameForApp('on_config_updated'),
-      event => {
-        const { resultType } = event;
-        if (resultType === 'success') {
-          listener({ updatedKeys: event.updatedKeys }, undefined);
-          return;
-        }
-
-        listener(undefined, {
-          code: event.code,
-          message: event.message,
-          nativeErrorMessage: event.nativeErrorMessage,
-        });
-      },
-    );
-    if (this._configUpdateListenerCount === 0) {
-      this.native.onConfigUpdated();
-    }
-
-    this._configUpdateListenerCount++;
-
-    return () => {
-      if (unsubscribed) {
-        // there is no harm in calling this multiple times to unsubscribe,
-        // but anything after the first call is a no-op
-        return;
-      } else {
-        unsubscribed = true;
-      }
-      subscription.remove();
-      this._configUpdateListenerCount--;
-      if (this._configUpdateListenerCount === 0) {
-        this.native.removeConfigUpdateRegistration();
-      }
-    };
-  }
-
-  _updateFromConstants(constants) {
-    // Wrapped this as we update using sync getters initially for `defaultConfig` & `settings`
-    if (constants.lastFetchTime) {
-      this._lastFetchTime = constants.lastFetchTime;
-    }
-
-    // Wrapped this as we update using sync getters initially for `defaultConfig` & `settings`
-    if (constants.lastFetchStatus) {
-      this._lastFetchStatus = constants.lastFetchStatus;
-    }
-
-    this._settings = {
-      fetchTimeMillis: constants.fetchTimeout * 1000,
-      minimumFetchIntervalMillis: constants.minimumFetchInterval * 1000,
-    };
-
-    this._values = Object.freeze(constants.values);
-  }
-
-  _promiseWithConstants(promise) {
-    return promise.then(({ result, constants }) => {
-      this._updateFromConstants(constants);
-      return result;
-    });
-  }
-}
-
-// import { SDK_VERSION } from '@react-native-firebase/remote-config';
-export const SDK_VERSION = version;
-
-// import config from '@react-native-firebase/remote-config';
-// config().X(...);
-export default createModuleNamespace({
-  statics,
-  version,
-  namespace,
-  nativeModuleName,
-  nativeEvents: ['on_config_updated'],
-  hasMultiAppSupport: true,
-  hasCustomUrlOrRegionSupport: false,
-  ModuleClass: FirebaseConfigModule,
-});
-
-export * from './modular';
-
-// import config, { firebase } from '@react-native-firebase/remote-config';
-// config().X(...);
-// firebase.remoteConfig().X(...);
-export const firebase = getFirebaseRoot();
-
-setReactNativeModule(nativeModuleName, fallBackModule);

package/lib/modular/index.d.ts

@@ -1,265 +0,0 @@
-/*
- * Copyright (c) 2016-present Invertase Limited & Contributors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this library 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 { ReactNativeFirebase } from '@react-native-firebase/app';
-import { FirebaseRemoteConfigTypes } from '..';
-
-import RemoteConfig = FirebaseRemoteConfigTypes.Module;
-import ConfigValues = FirebaseRemoteConfigTypes.ConfigValues;
-import ConfigValue = FirebaseRemoteConfigTypes.ConfigValue;
-import ConfigDefaults = FirebaseRemoteConfigTypes.ConfigDefaults;
-import ConfigSettings = FirebaseRemoteConfigTypes.ConfigSettings;
-import LastFetchStatusType = FirebaseRemoteConfigTypes.LastFetchStatusType;
-import RemoteConfigLogLevel = FirebaseRemoteConfigTypes.RemoteConfigLogLevel;
-import FirebaseApp = ReactNativeFirebase.FirebaseApp;
-import LastFetchStatusInterface = FirebaseRemoteConfigTypes.LastFetchStatus;
-import ValueSourceInterface = FirebaseRemoteConfigTypes.ValueSource;
-import ConfigUpdateObserver = FirebaseRemoteConfigTypes.ConfigUpdateObserver;
-import Unsubscribe = FirebaseRemoteConfigTypes.Unsubscribe;
-// deprecated: from pre-Web realtime remote-config support - remove with onConfigUpdated
-import CallbackOrObserver = FirebaseRemoteConfigTypes.CallbackOrObserver;
-// deprecated: from pre-Web realtime remote-config support - remove with onConfigUpdated
-import OnConfigUpdatedListenerCallback = FirebaseRemoteConfigTypes.OnConfigUpdatedListenerCallback;
-
-export const LastFetchStatus: LastFetchStatusInterface;
-export const ValueSource: ValueSourceInterface;
-
-/**
- * Returns a RemoteConfig instance for the given app.
- * @param app - FirebaseApp. Optional.
- * @returns {RemoteConfig}
- */
-export function getRemoteConfig(app?: FirebaseApp): RemoteConfig;
-
-/**
- * Returns a Boolean which resolves to true if the current call
- * activated the fetched configs.
- * @param remoteConfig - RemoteConfig instance
- * @returns {Promise<boolean>}
- */
-export function activate(remoteConfig: RemoteConfig): Promise<boolean>;
-
-/**
- * Ensures the last activated config are available to the getters.
- * @param remoteConfig - RemoteConfig instance
- * @returns {Promise<void>}
- */
-export function ensureInitialized(remoteConfig: RemoteConfig): Promise<void>;
-
-/**
- * Performs a fetch and returns a Boolean which resolves to true
- * if the current call activated the fetched configs.
- * @param remoteConfig - RemoteConfig instance
- * @returns {Promise<boolean>}
- */
-export function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean>;
-
-/**
- * Fetches and caches configuration from the Remote Config service.
- * @param remoteConfig - RemoteConfig instance
- * @returns {Promise<void>}
- */
-export function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;
-
-/**
- * Gets all config.
- * @param remoteConfig - RemoteConfig instance
- * @returns {ConfigValues}
- */
-export function getAll(remoteConfig: RemoteConfig): ConfigValues;
-
-/**
- * Gets the value for the given key as a boolean.
- * @param remoteConfig - RemoteConfig instance
- * @param key - key for boolean value
- * @returns {boolean}
- */
-export function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;
-
-/**
- * Gets the value for the given key as a number.
- * @param remoteConfig - RemoteConfig instance
- * @param key - key for number value
- * @returns {number}
- */
-export function getNumber(remoteConfig: RemoteConfig, key: string): number;
-
-/**
- * Gets the value for the given key as a string.
- * @param remoteConfig - RemoteConfig instance
- * @param key - key for string value
- * @returns {string}
- */
-export function getString(remoteConfig: RemoteConfig, key: string): string;
-
-/**
- * Gets the value for the given key
- * @param remoteConfig - RemoteConfig instance
- * @param key - key for the given value
- * @returns {ConfigValue}
- */
-export function getValue(remoteConfig: RemoteConfig, key: string): ConfigValue;
-
-/**
- * Defines the log level to use.
- * @param remoteConfig - RemoteConfig instance
- * @param logLevel - The log level to set
- * @returns {RemoteConfigLogLevel}
- */
-export function setLogLevel(
-  remoteConfig: RemoteConfig,
-  logLevel: RemoteConfigLogLevel,
-): RemoteConfigLogLevel;
-
-/**
- * Checks two different things.
- * 1. Check if IndexedDB exists in the browser environment.
- * 2. Check if the current browser context allows IndexedDB open() calls.
- * @returns {Promise<boolean>}
- */
-export function isSupported(): Promise<boolean>;
-
-/**
- * Indicates the default value in milliseconds to abandon a pending fetch
- * request made to the Remote Config server. Defaults to 60000 (One minute).
- * @param remoteConfig - RemoteConfig instance
- * @returns {number}
- */
-export function fetchTimeMillis(remoteConfig: RemoteConfig): number;
-
-/**
- * Returns a ConfigSettings object which provides the properties `minimumFetchIntervalMillis` & `fetchTimeMillis` if they have been set
- * using setConfigSettings({ fetchTimeMillis: number, minimumFetchIntervalMillis: number }).
- * @param remoteConfig - RemoteConfig instance
- * @returns {ConfigSettings}
- */
-export function settings(remoteConfig: RemoteConfig): ConfigSettings;
-
-/**
- * The status of the latest Remote RemoteConfig fetch action.
- * @param remoteConfig - RemoteConfig instance
- * @returns {LastFetchStatusType}
- */
-export function lastFetchStatus(remoteConfig: RemoteConfig): LastFetchStatusType;
-
-/**
- * Deletes all activated, fetched and defaults configs and
- * resets all Firebase Remote Config settings.
- * Android only. iOS does not reset anything.
- * @param remoteConfig - RemoteConfig instance
- * @returns {Promise<void>}
- */
-export function reset(remoteConfig: RemoteConfig): Promise<void>;
-
-/**
- * Set the Remote RemoteConfig settings, currently able to set
- * `fetchTimeMillis` & `minimumFetchIntervalMillis`
- * @param remoteConfig - RemoteConfig instance
- * @param settings - ConfigSettings instance
- * @returns {Promise<void>}
- */
-export function setConfigSettings(
-  remoteConfig: RemoteConfig,
-  settings: ConfigSettings,
-): Promise<void>;
-
-/**
- * Fetches parameter values for your app.
- * @param remoteConfig - RemoteConfig instance
- * @param expirationDurationSeconds - number
- * @returns {Promise<void>}
- */
-export function fetch(
-  remoteConfig: RemoteConfig,
-  expirationDurationSeconds?: number,
-): Promise<void>;
-
-/**
- * Fetches parameter values for your app.
- * @param remoteConfig - RemoteConfig instance
- * @param defaults - ConfigDefaults
- * @returns {Promise<void>}
- */
-export function setDefaults(remoteConfig: RemoteConfig, defaults: ConfigDefaults): Promise<void>;
-
-/**
- * Fetches parameter values for your app.
- * @param remoteConfig - RemoteConfig instance
- * @param resourceName - string
- * @returns {Promise<null>}
- */
-export function setDefaultsFromResource(
-  remoteConfig: RemoteConfig,
-  resourceName: string,
-): Promise<null>;
-
-/**
- * Starts listening for real-time config updates from the Remote Config backend and automatically
- * fetches updates from the Remote Config backend when they are available.
- *
- * @remarks
- * If a connection to the Remote Config backend is not already open, calling this method will
- * open it. Multiple listeners can be added by calling this method again, but subsequent calls
- * re-use the same connection to the backend.
- *
- * The list of updated keys passed to the callback will include all keys not currently active,
- * and the config update process fetches the new config but does not automatically activate
- * it for you. Typically you will activate the config in your callback to use the new values.
- *
- * @param remoteConfig - The {@link RemoteConfig} instance.
- * @param observer - The {@link ConfigUpdateObserver} to be notified of config updates.
- * @returns An {@link Unsubscribe} function to remove the listener.
- */
-export function onConfigUpdate(
-  remoteConfig: RemoteConfig,
-  observer: ConfigUpdateObserver,
-): Unsubscribe;
-
-/**
- * Registers a listener to changes in the configuration.
- *
- * @param remoteConfig - RemoteConfig instance
- * @param callback - function called on config change
- * @returns {function} unsubscribe listener
- * @deprecated use official firebase-js-sdk onConfigUpdate now that web supports realtime
- */
-export function onConfigUpdated(
-  remoteConfig: RemoteConfig,
-  callback: CallbackOrObserver<OnConfigUpdatedListenerCallback>,
-): () => void;
-
-/**
- * Defines the type for representing custom signals and their values.
- * The values in CustomSignals must be one of the following types: string, number, or null.
- * There are additional limitations on key and value length, for a full description see https://firebase.google.com/docs/remote-config/parameters?template_type=client#custom_signal_conditions
- * Failing to stay within these limitations will result in a silent API failure with only a warning in device logs
- */
-
-export interface CustomSignals {
-  [key: string]: string | number | null;
-}
-
-/**
- * Sets the custom signals for the app instance.
- * @param {RemoteConfig} remoteConfig - RemoteConfig instance
- * @param {CustomSignals} customSignals - CustomSignals
- * @returns {Promise<void>}
- */
-
-export declare function setCustomSignals(
-  remoteConfig: RemoteConfig,
-  customSignals: CustomSignals,
-): Promise<void>;