@react-native-firebase/remote-config 24.1.1 → 25.0.1

package/dist/typescript/lib/types/remote-config.d.ts

@@ -0,0 +1,37 @@
+import type { FirebaseApp } from '@firebase/app';
+import type { ReactNativeFirebase } from '@react-native-firebase/app';
+export type LogLevel = 'debug' | 'error' | 'silent';
+export type FetchStatus = 'success' | 'failure' | 'no_fetch_yet' | 'throttled';
+export type ValueSource = 'static' | 'default' | 'remote';
+export interface Value {
+    getSource(): ValueSource;
+    asBoolean(): boolean;
+    asNumber(): number;
+    asString(): string;
+}
+export interface RemoteConfigSettings {
+    minimumFetchIntervalMillis: number;
+    fetchTimeoutMillis: number;
+}
+export interface ConfigUpdate {
+    getUpdatedKeys(): Set<string>;
+}
+export interface ConfigUpdateObserver {
+    next: (configUpdate: ConfigUpdate) => void;
+    error: (error: ReactNativeFirebase.NativeFirebaseError) => void;
+    complete: () => void;
+}
+export type Unsubscribe = () => void;
+export interface CustomSignals {
+    [key: string]: string | number | null;
+}
+export interface RemoteConfig {
+    app: FirebaseApp;
+    fetchTimeMillis: number;
+    lastFetchStatus: FetchStatus;
+    settings: RemoteConfigSettings;
+    defaultConfig: {
+        [key: string]: string | number | boolean;
+    };
+}
+//# sourceMappingURL=remote-config.d.ts.map

package/dist/typescript/lib/types/remote-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-config.d.ts","sourceRoot":"","sources":["../../../../lib/types/remote-config.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC;AAEpD,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,SAAS,GAAG,cAAc,GAAG,WAAW,CAAC;AAE/E,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;AAE1D,MAAM,WAAW,KAAK;IACpB,SAAS,IAAI,WAAW,CAAC;IACzB,SAAS,IAAI,OAAO,CAAC;IACrB,QAAQ,IAAI,MAAM,CAAC;IACnB,QAAQ,IAAI,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,0BAA0B,EAAE,MAAM,CAAC;IACnC,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,YAAY;IAC3B,cAAc,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,CAAC,YAAY,EAAE,YAAY,KAAK,IAAI,CAAC;IAC3C,KAAK,EAAE,CAAC,KAAK,EAAE,mBAAmB,CAAC,mBAAmB,KAAK,IAAI,CAAC;IAChE,QAAQ,EAAE,MAAM,IAAI,CAAC;CACtB;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC;AAErC,MAAM,WAAW,aAAa;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;CACvC;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,WAAW,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,WAAW,CAAC;IAC7B,QAAQ,EAAE,oBAAoB,CAAC;IAC/B,aAAa,EAAE;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;KAC1C,CAAC;CACH"}

package/dist/typescript/lib/version.d.ts

@@ -0,0 +1,2 @@
+export declare const version = "25.0.1";
+//# sourceMappingURL=version.d.ts.map

package/dist/typescript/lib/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../lib/version.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/dist/typescript/lib/web/RNFBConfigModule.android.d.ts

@@ -0,0 +1,3 @@
+declare const noopNativeModule: Record<string, never>;
+export default noopNativeModule;
+//# sourceMappingURL=RNFBConfigModule.android.d.ts.map

package/dist/typescript/lib/web/RNFBConfigModule.android.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RNFBConfigModule.android.d.ts","sourceRoot":"","sources":["../../../../lib/web/RNFBConfigModule.android.ts"],"names":[],"mappings":"AACA,QAAA,MAAM,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAM,CAAC;AAEnD,eAAe,gBAAgB,CAAC"}

package/dist/typescript/lib/web/RNFBConfigModule.d.ts

@@ -0,0 +1,17 @@
+import '../polyfills';
+import type { RNFBConfigModule } from '../types/internal';
+type WithAppName<F> = F extends (...args: infer P) => infer R ? (appName: string, ...args: P) => R : never;
+interface RNFBConfigModuleWeb {
+    activate: WithAppName<RNFBConfigModule['activate']>;
+    setConfigSettings: WithAppName<RNFBConfigModule['setConfigSettings']>;
+    fetch: WithAppName<RNFBConfigModule['fetch']>;
+    fetchAndActivate: WithAppName<RNFBConfigModule['fetchAndActivate']>;
+    ensureInitialized: WithAppName<RNFBConfigModule['ensureInitialized']>;
+    setDefaults: WithAppName<RNFBConfigModule['setDefaults']>;
+    setCustomSignals: WithAppName<RNFBConfigModule['setCustomSignals']>;
+    onConfigUpdated: WithAppName<RNFBConfigModule['onConfigUpdated']>;
+    removeConfigUpdateRegistration: WithAppName<RNFBConfigModule['removeConfigUpdateRegistration']>;
+}
+declare const remoteConfigWebModule: RNFBConfigModuleWeb;
+export default remoteConfigWebModule;
+//# sourceMappingURL=RNFBConfigModule.d.ts.map

package/dist/typescript/lib/web/RNFBConfigModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RNFBConfigModule.d.ts","sourceRoot":"","sources":["../../../../lib/web/RNFBConfigModule.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,CAAC;AAmBtB,OAAO,KAAK,EAGV,gBAAgB,EACjB,MAAM,mBAAmB,CAAC;AAkB3B,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,MAAM,CAAC,GACzD,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,GAClC,KAAK,CAAC;AAEV,UAAU,mBAAmB;IAC3B,QAAQ,EAAE,WAAW,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;IACpD,iBAAiB,EAAE,WAAW,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACtE,KAAK,EAAE,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;IAC9C,gBAAgB,EAAE,WAAW,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IACpE,iBAAiB,EAAE,WAAW,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACtE,WAAW,EAAE,WAAW,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC;IAC1D,gBAAgB,EAAE,WAAW,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IACpE,eAAe,EAAE,WAAW,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAClE,8BAA8B,EAAE,WAAW,CAAC,gBAAgB,CAAC,gCAAgC,CAAC,CAAC,CAAC;CACjG;AAyFD,QAAA,MAAM,qBAAqB,EAAE,mBA2G5B,CAAC;AAEF,eAAe,qBAAqB,CAAC"}

package/dist/typescript/lib/web/RNFBConfigModule.ios.d.ts

@@ -0,0 +1,3 @@
+declare const noopNativeModule: Record<string, never>;
+export default noopNativeModule;
+//# sourceMappingURL=RNFBConfigModule.ios.d.ts.map

package/dist/typescript/lib/web/RNFBConfigModule.ios.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RNFBConfigModule.ios.d.ts","sourceRoot":"","sources":["../../../../lib/web/RNFBConfigModule.ios.ts"],"names":[],"mappings":"AACA,QAAA,MAAM,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAM,CAAC;AAEnD,eAAe,gBAAgB,CAAC"}

package/dist/typescript/package.json

@@ -0,0 +1 @@
+{"type":"module"}

package/ios/RNFBConfig/RNFBConfigModule.m

@@ -136,7 +136,7 @@ RCT_EXPORT_METHOD(ensureInitialized
     if (error) {
       [RNFBSharedUtils rejectPromiseWithNSError:reject error:error];
     } else {
-      resolve([self resultWithConstants:[NSNull null] firebaseApp:firebaseApp]);
+      resolve([self resultWithVoidConstantsForApp:firebaseApp]);
     }
   };
 
@@ -160,7 +160,7 @@ RCT_EXPORT_METHOD(fetch
                                      convertFIRRemoteConfigFetchStatusToNSStringDescription(status)
                                } mutableCopy]];
         } else {
-          resolve([self resultWithConstants:[NSNull null] firebaseApp:firebaseApp]);
+          resolve([self resultWithVoidConstantsForApp:firebaseApp]);
         }
       };
 
@@ -236,7 +236,7 @@ RCT_EXPORT_METHOD(setConfigSettings
   }
 
   [FIRRemoteConfig remoteConfigWithApp:firebaseApp].configSettings = remoteConfigSettings;
-  resolve([self resultWithConstants:[NSNull null] firebaseApp:firebaseApp]);
+  resolve([self resultWithVoidConstantsForApp:firebaseApp]);
 }
 
 RCT_EXPORT_METHOD(setDefaults
@@ -316,7 +316,7 @@ RCT_EXPORT_METHOD(setCustomSignals
           if (error != nil) {
             [RNFBSharedUtils rejectPromiseWithNSError:reject error:error];
           } else {
-            resolve([self resultWithConstants:[NSNull null] firebaseApp:firebaseApp]);
+            resolve([self resultWithVoidConstantsForApp:firebaseApp]);
           }
         }];
 }
@@ -331,6 +331,12 @@ RCT_EXPORT_METHOD(setCustomSignals
   return responseDict;
 }
 
+- (NSDictionary *)resultWithVoidConstantsForApp:(FIRApp *)firebaseApp {
+  NSMutableDictionary *responseDict = [NSMutableDictionary new];
+  responseDict[@"constants"] = [self getConstantsForApp:firebaseApp];
+  return responseDict;
+}
+
 - (NSDictionary *)getConstantsForApp:(FIRApp *)firebaseApp {
   FIRRemoteConfig *remoteConfig = [FIRRemoteConfig remoteConfigWithApp:firebaseApp];
 

package/lib/RemoteConfigValue.ts

@@ -0,0 +1,66 @@
+/*
+ * 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 type { Value } from './types/remote-config';
+
+// as per firebase web sdk specification
+const BOOL_VALUES = ['1', 'true', 't', 'yes', 'y', 'on'];
+
+interface ConfigValueInit {
+  value: string;
+  source: ReturnType<Value['getSource']>;
+}
+
+export default class RemoteConfigValue implements Value {
+  private readonly _value: string;
+  private readonly _source: ReturnType<Value['getSource']>;
+
+  constructor({ value, source }: ConfigValueInit) {
+    this._value = value;
+    this._source = source;
+  }
+
+  asBoolean(): boolean {
+    if (this._source === 'static') {
+      return false;
+    }
+
+    return BOOL_VALUES.includes(this._value.toLowerCase());
+  }
+
+  asNumber(): number {
+    if (this._source === 'static') {
+      return 0;
+    }
+
+    const num = Number(this._value);
+
+    if (Number.isNaN(num)) {
+      return 0;
+    }
+
+    return num;
+  }
+
+  asString(): string {
+    return this._value;
+  }
+
+  getSource(): ReturnType<Value['getSource']> {
+    return this._source;
+  }
+}

package/lib/index.ts

@@ -0,0 +1,25 @@
+/*
+ * 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.
+ *
+ */
+
+// Export modular API
+export * from './modular';
+export type * from './types/remote-config';
+
+// Export namespaced API
+export type { FirebaseRemoteConfigTypes } from './types/namespaced';
+export { SDK_VERSION, firebase } from './namespaced';
+export { default } from './namespaced';

package/lib/modular.ts

@@ -0,0 +1,197 @@
+/*
+ * 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 type { FirebaseApp } from '@firebase/app';
+import { getApp } from '@react-native-firebase/app';
+import {
+  MODULAR_DEPRECATION_ARG,
+  withModularFlag,
+} from '@react-native-firebase/app/dist/module/common';
+import type {
+  ConfigUpdateObserver,
+  CustomSignals,
+  LogLevel,
+  RemoteConfig,
+  Unsubscribe,
+  Value,
+} from './types/remote-config';
+import type { AppWithRemoteConfigInternal, RemoteConfigInternal } from './types/internal';
+
+function rc(remoteConfig: RemoteConfig): RemoteConfigInternal {
+  return remoteConfig as RemoteConfigInternal;
+}
+
+export type { CustomSignals } from './types/remote-config';
+
+/**
+ * Returns a RemoteConfig instance for the given app.
+ * @param app - FirebaseApp. Optional.
+ */
+export function getRemoteConfig(app?: FirebaseApp): RemoteConfig {
+  if (app) {
+    return withModularFlag(() =>
+      (getApp(app.name) as unknown as AppWithRemoteConfigInternal).remoteConfig(
+        MODULAR_DEPRECATION_ARG,
+      ),
+    );
+  }
+
+  return withModularFlag(() =>
+    (getApp() as unknown as AppWithRemoteConfigInternal).remoteConfig(MODULAR_DEPRECATION_ARG),
+  );
+}
+
+/**
+ * Returns a Boolean which resolves to true if the current call
+ * activated the fetched configs.
+ */
+export function activate(remoteConfig: RemoteConfig): Promise<boolean> {
+  return rc(remoteConfig).activate.call(remoteConfig, MODULAR_DEPRECATION_ARG);
+}
+
+/**
+ * Ensures the last activated config are available to the getters.
+ */
+export function ensureInitialized(remoteConfig: RemoteConfig): Promise<void> {
+  return rc(remoteConfig).ensureInitialized.call(remoteConfig, MODULAR_DEPRECATION_ARG);
+}
+
+/**
+ * Performs a fetch and returns a Boolean which resolves to true
+ * if the current call activated the fetched configs.
+ */
+export function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean> {
+  return rc(remoteConfig).fetchAndActivate.call(remoteConfig, MODULAR_DEPRECATION_ARG);
+}
+
+/**
+ * Fetches and caches configuration from the Remote Config service.
+ */
+export function fetchConfig(remoteConfig: RemoteConfig): Promise<void> {
+  return rc(remoteConfig).fetch.call(remoteConfig, undefined, MODULAR_DEPRECATION_ARG);
+}
+
+/**
+ * Gets all config.
+ */
+export function getAll(remoteConfig: RemoteConfig): Record<string, Value> {
+  return rc(remoteConfig).getAll.call(remoteConfig, MODULAR_DEPRECATION_ARG);
+}
+
+/**
+ * Gets the value for the given key as a boolean.
+ */
+export function getBoolean(remoteConfig: RemoteConfig, key: string): boolean {
+  return rc(remoteConfig).getBoolean.call(remoteConfig, key, MODULAR_DEPRECATION_ARG);
+}
+
+/**
+ * Gets the value for the given key as a number.
+ */
+export function getNumber(remoteConfig: RemoteConfig, key: string): number {
+  return rc(remoteConfig).getNumber.call(remoteConfig, key, MODULAR_DEPRECATION_ARG);
+}
+
+/**
+ * Gets the value for the given key as a string.
+ */
+export function getString(remoteConfig: RemoteConfig, key: string): string {
+  return rc(remoteConfig).getString.call(remoteConfig, key, MODULAR_DEPRECATION_ARG);
+}
+
+/**
+ * Gets the value for the given key.
+ */
+export function getValue(remoteConfig: RemoteConfig, key: string): Value {
+  return rc(remoteConfig).getValue.call(remoteConfig, key, MODULAR_DEPRECATION_ARG);
+}
+
+/**
+ * Defines the log level to use.
+ */
+export function setLogLevel(remoteConfig: RemoteConfig, logLevel: LogLevel): void {
+  void remoteConfig;
+  void logLevel;
+  // Intentionally ignored on native. The modular API matches the JS SDK and returns void.
+}
+
+/**
+ * Checks two different things.
+ * 1. Check if IndexedDB exists in the browser environment.
+ * 2. Check if the current browser context allows IndexedDB open() calls.
+ */
+export function isSupported(): Promise<boolean> {
+  // always return "true" for now. Web only.
+  return Promise.resolve(true);
+}
+
+/**
+ * Deletes all activated, fetched and defaults configs and
+ * resets all Firebase Remote Config settings.
+ * Android only. iOS does not reset anything.
+ */
+export function reset(remoteConfig: RemoteConfig): Promise<void> {
+  return rc(remoteConfig).reset.call(remoteConfig, MODULAR_DEPRECATION_ARG);
+}
+
+/**
+ * Sets defaults based on a native resource.
+ */
+export function setDefaultsFromResource(
+  remoteConfig: RemoteConfig,
+  resourceName: string,
+): Promise<null> {
+  return rc(remoteConfig).setDefaultsFromResource.call(
+    remoteConfig,
+    resourceName,
+    MODULAR_DEPRECATION_ARG,
+  );
+}
+
+/**
+ * Registers a listener to changes in the configuration.
+ *
+ */
+export function onConfigUpdate(
+  remoteConfig: RemoteConfig,
+  observer: ConfigUpdateObserver,
+): Unsubscribe {
+  return rc(remoteConfig).onConfigUpdate.call(remoteConfig, observer, MODULAR_DEPRECATION_ARG);
+}
+
+/**
+ * Sets the custom signals for the app instance.
+ */
+export async function setCustomSignals(
+  remoteConfig: RemoteConfig,
+  customSignals: CustomSignals,
+): Promise<void> {
+  for (const [key, value] of Object.entries(customSignals)) {
+    if (typeof value !== 'string' && typeof value !== 'number' && value !== null) {
+      throw new Error(
+        `firebase.remoteConfig().setCustomSignals(): Invalid type for custom signal '${key}': ${typeof value}. Expected 'string', 'number', or 'null'.`,
+      );
+    }
+  }
+
+  return withModularFlag(() =>
+    rc(remoteConfig)._promiseWithConstants(
+      rc(remoteConfig).native.setCustomSignals(customSignals),
+      MODULAR_DEPRECATION_ARG,
+    ),
+  );
+}