feat(remote-config): expose value source on Web (#979)

* feat(remote-config): expose value source on Web for getBoolean, getNumber, getString, and getAll

* fix(remote-config): keep `source` optional to avoid breaking change

Author: robingenz

.changeset/remote-config-source-on-web.md

@@ -0,0 +1,5 @@
+---
+'@capacitor-firebase/remote-config': minor
+---
+
+feat: expose value `source` on Web for `getBoolean(...)`, `getNumber(...)`, `getString(...)`, and `getAll()`

packages/remote-config/README.md

@@ -419,10 +419,10 @@ Remove all listeners for this plugin.
 
 #### GetBooleanResult
 
-| Prop         | Type                                                      | Description                                                                         | Since |
-| ------------ | --------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----- |
-| **`value`**  | <code>boolean</code>                                      | The value for the given key as a boolean.                                           | 1.3.0 |
-| **`source`** | <code><a href="#getvaluesource">GetValueSource</a></code> | Indicates at which source this value came from. Only available for Android and iOS. | 1.3.0 |
+| Prop         | Type                                                      | Description                                     | Since |
+| ------------ | --------------------------------------------------------- | ----------------------------------------------- | ----- |
+| **`value`**  | <code>boolean</code>                                      | The value for the given key as a boolean.       | 1.3.0 |
+| **`source`** | <code><a href="#getvaluesource">GetValueSource</a></code> | Indicates at which source this value came from. | 1.3.0 |
 
 
 #### GetOptions
@@ -434,18 +434,18 @@ Remove all listeners for this plugin.
 
 #### GetNumberResult
 
-| Prop         | Type                                                      | Description                                                                         | Since |
-| ------------ | --------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----- |
-| **`value`**  | <code>number</code>                                       | The value for the given key as a number.                                            | 1.3.0 |
-| **`source`** | <code><a href="#getvaluesource">GetValueSource</a></code> | Indicates at which source this value came from. Only available for Android and iOS. | 1.3.0 |
+| Prop         | Type                                                      | Description                                     | Since |
+| ------------ | --------------------------------------------------------- | ----------------------------------------------- | ----- |
+| **`value`**  | <code>number</code>                                       | The value for the given key as a number.        | 1.3.0 |
+| **`source`** | <code><a href="#getvaluesource">GetValueSource</a></code> | Indicates at which source this value came from. | 1.3.0 |
 
 
 #### GetStringResult
 
-| Prop         | Type                                                      | Description                                                                         | Since |
-| ------------ | --------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----- |
-| **`value`**  | <code>string</code>                                       | The value for the given key as a string.                                            | 1.3.0 |
-| **`source`** | <code><a href="#getvaluesource">GetValueSource</a></code> | Indicates at which source this value came from. Only available for Android and iOS. | 1.3.0 |
+| Prop         | Type                                                      | Description                                     | Since |
+| ------------ | --------------------------------------------------------- | ----------------------------------------------- | ----- |
+| **`value`**  | <code>string</code>                                       | The value for the given key as a string.        | 1.3.0 |
+| **`source`** | <code><a href="#getvaluesource">GetValueSource</a></code> | Indicates at which source this value came from. | 1.3.0 |
 
 
 #### GetAllResult
@@ -457,10 +457,10 @@ Remove all listeners for this plugin.
 
 #### GetAllResultValue
 
-| Prop         | Type                                                      | Description                                                                         | Since |
-| ------------ | --------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----- |
-| **`value`**  | <code>string</code>                                       | The value as a string.                                                              | 8.3.0 |
-| **`source`** | <code><a href="#getvaluesource">GetValueSource</a></code> | Indicates at which source this value came from. Only available for Android and iOS. | 8.3.0 |
+| Prop         | Type                                                      | Description                                     | Since |
+| ------------ | --------------------------------------------------------- | ----------------------------------------------- | ----- |
+| **`value`**  | <code>string</code>                                       | The value as a string.                          | 8.3.0 |
+| **`source`** | <code><a href="#getvaluesource">GetValueSource</a></code> | Indicates at which source this value came from. | 8.3.0 |
 
 
 #### GetInfoResult

packages/remote-config/src/definitions.ts

@@ -157,8 +157,6 @@ export interface GetBooleanResult {
   /**
    * Indicates at which source this value came from.
    *
-   * Only available for Android and iOS.
-   *
    * @since 1.3.0
    */
   source?: GetValueSource;
@@ -177,8 +175,6 @@ export interface GetNumberResult {
   /**
    * Indicates at which source this value came from.
    *
-   * Only available for Android and iOS.
-   *
    * @since 1.3.0
    */
   source?: GetValueSource;
@@ -197,8 +193,6 @@ export interface GetStringResult {
   /**
    * Indicates at which source this value came from.
    *
-   * Only available for Android and iOS.
-   *
    * @since 1.3.0
    */
   source?: GetValueSource;
@@ -229,8 +223,6 @@ export interface GetAllResultValue {
   /**
    * Indicates at which source this value came from.
    *
-   * Only available for Android and iOS.
-   *
    * @since 8.3.0
    */
   source?: GetValueSource;

packages/remote-config/src/web.ts

@@ -4,11 +4,10 @@ import {
   fetchAndActivate,
   fetchConfig,
   getAll,
-  getBoolean,
-  getNumber,
   getRemoteConfig,
-  getString,
+  getValue,
 } from 'firebase/remote-config';
+import type { Value } from 'firebase/remote-config';
 
 import type {
   AddConfigUpdateListenerOptionsCallback,
@@ -25,7 +24,7 @@ import type {
   SetDefaultsOptions,
   SetSettingsOptions,
 } from './definitions';
-import { LastFetchStatus } from './definitions';
+import { GetValueSource, LastFetchStatus } from './definitions';
 
 export class FirebaseRemoteConfigWeb
   extends WebPlugin
@@ -48,28 +47,41 @@ export class FirebaseRemoteConfigWeb
 
   public async getBoolean(options: GetOptions): Promise<GetBooleanResult> {
     const remoteConfig = getRemoteConfig();
-    const value = getBoolean(remoteConfig, options.key);
-    return { value };
+    const value = getValue(remoteConfig, options.key);
+    return {
+      value: value.asBoolean(),
+      source: this.mapValueSource(value.getSource()),
+    };
   }
 
   public async getNumber(options: GetOptions): Promise<GetNumberResult> {
     const remoteConfig = getRemoteConfig();
-    const value = getNumber(remoteConfig, options.key);
-    return { value };
+    const value = getValue(remoteConfig, options.key);
+    return {
+      value: value.asNumber(),
+      source: this.mapValueSource(value.getSource()),
+    };
   }
 
   public async getString(options: GetOptions): Promise<GetStringResult> {
     const remoteConfig = getRemoteConfig();
-    const value = getString(remoteConfig, options.key);
-    return { value };
+    const value = getValue(remoteConfig, options.key);
+    return {
+      value: value.asString(),
+      source: this.mapValueSource(value.getSource()),
+    };
   }
 
   public async getAll(): Promise<GetAllResult> {
     const remoteConfig = getRemoteConfig();
     const all = getAll(remoteConfig);
     const values: Record<string, GetAllResultValue> = {};
     for (const key of Object.keys(all)) {
-      values[key] = { value: all[key].asString() };
+      const value = all[key];
+      values[key] = {
+        value: value.asString(),
+        source: this.mapValueSource(value.getSource()),
+      };
     }
     return { values };
   }
@@ -127,6 +139,20 @@ export class FirebaseRemoteConfigWeb
     this.throwUnimplementedError();
   }
 
+  private mapValueSource(
+    source: ReturnType<Value['getSource']>,
+  ): GetValueSource {
+    switch (source) {
+      case 'default':
+        return GetValueSource.Default;
+      case 'remote':
+        return GetValueSource.Remote;
+      case 'static':
+      default:
+        return GetValueSource.Static;
+    }
+  }
+
   private throwUnimplementedError(): never {
     throw this.unimplemented('Not implemented on web.');
   }