@firebase/remote-config 0.6.6 → 0.7.0-canary.cb3bdd812

package/dist/src/public_types.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { FirebaseApp } from '@firebase/app';
+import { FirebaseApp, FirebaseError } from '@firebase/app';
 /**
  * The Firebase Remote Config service interface.
  *
@@ -48,6 +48,8 @@ export interface RemoteConfig {
 }
 /**
  * Defines a self-descriptive reference for config key-value pairs.
+ *
+ *  @public
  */
 export interface FirebaseRemoteConfigObject {
     [key: string]: string;
@@ -57,6 +59,8 @@ export interface FirebaseRemoteConfigObject {
  *
  * <p>Modeled after the native `Response` interface, but simplified for Remote Config's
  * use case.
+ *
+ * @public
  */
 export interface FetchResponse {
     /**
@@ -82,6 +86,10 @@ export interface FetchResponse {
      * <p>Only defined for 200 responses.
      */
     config?: FirebaseRemoteConfigObject;
+    /**
+     * The version number of the config template fetched from the server.
+     */
+    templateVersion?: number;
 }
 /**
  * Options for Remote Config initialization.
@@ -189,6 +197,57 @@ export type LogLevel = 'debug' | 'error' | 'silent';
 export interface CustomSignals {
     [key: string]: string | number | null;
 }
+/**
+ * Contains information about which keys have been updated.
+ *
+ * @public
+ */
+export interface ConfigUpdate {
+    /**
+     * Parameter keys whose values have been updated from the currently activated values.
+     * Includes keys that are added, deleted, or whose value, value source, or metadata has changed.
+     */
+    getUpdatedKeys(): Set<string>;
+}
+/**
+ * Observer interface for receiving real-time Remote Config update notifications.
+ *
+ * NOTE: Although an `complete` callback can be provided, it will
+ * never be called because the ConfigUpdate stream is never-ending.
+ *
+ * @public
+ */
+export interface ConfigUpdateObserver {
+    /**
+     * Called when a new ConfigUpdate is available.
+     */
+    next: (configUpdate: ConfigUpdate) => void;
+    /**
+     * Called if an error occurs during the stream.
+     */
+    error: (error: FirebaseError) => void;
+    /**
+     * Called when the stream is gracefully terminated.
+     */
+    complete: () => void;
+}
+/**
+ * A function that unsubscribes from a real-time event stream.
+ *
+ * @public
+ */
+export type Unsubscribe = () => void;
+/**
+ * Indicates the type of fetch request.
+ *
+ * <ul>
+ *   <li>"BASE" indicates a standard fetch request.</li>
+ *   <li>"REALTIME" indicates a fetch request triggered by a real-time update.</li>
+ * </ul>
+ *
+ * @public
+ */
+export type FetchType = 'BASE' | 'REALTIME';
 declare module '@firebase/component' {
     interface NameServiceMapping {
         'remote-config': RemoteConfig;

package/dist/src/remote_config.d.ts

@@ -20,6 +20,7 @@ import { StorageCache } from './storage/storage_cache';
 import { RemoteConfigFetchClient } from './client/remote_config_fetch_client';
 import { Storage } from './storage/storage';
 import { Logger } from '@firebase/logger';
+import { RealtimeHandler } from './client/realtime_handler';
 /**
  * Encapsulates business logic mapping network and storage dependencies to the public SDK API.
  *
@@ -43,6 +44,10 @@ export declare class RemoteConfig implements RemoteConfigType {
      * @internal
      */
     readonly _logger: Logger;
+    /**
+     * @internal
+     */
+    readonly _realtimeHandler: RealtimeHandler;
     /**
      * Tracks completion of initialization promise.
      * @internal
@@ -75,5 +80,9 @@ export declare class RemoteConfig implements RemoteConfigType {
     /**
      * @internal
      */
-    _logger: Logger);
+    _logger: Logger, 
+    /**
+     * @internal
+     */
+    _realtimeHandler: RealtimeHandler);
 }

package/dist/src/storage/storage.d.ts

@@ -34,12 +34,16 @@ export interface ThrottleMetadata {
     backoffCount: number;
     throttleEndTimeMillis: number;
 }
+export interface RealtimeBackoffMetadata {
+    numFailedStreams: number;
+    backoffEndTimeMillis: Date;
+}
 /**
  * Provides type-safety for the "key" field used by {@link APP_NAMESPACE_STORE}.
  *
  * <p>This seems like a small price to avoid potentially subtle bugs caused by a typo.
  */
-type ProjectNamespaceKeyFieldValue = 'active_config' | 'active_config_etag' | 'last_fetch_status' | 'last_successful_fetch_timestamp_millis' | 'last_successful_fetch_response' | 'settings' | 'throttle_metadata' | 'custom_signals';
+type ProjectNamespaceKeyFieldValue = 'active_config' | 'active_config_etag' | 'last_fetch_status' | 'last_successful_fetch_timestamp_millis' | 'last_successful_fetch_response' | 'settings' | 'throttle_metadata' | 'custom_signals' | 'realtime_backoff_metadata' | 'last_known_template_version';
 export declare function openDatabase(): Promise<IDBDatabase>;
 /**
  * Abstracts data persistence.
@@ -63,6 +67,10 @@ export declare abstract class Storage {
     abstract get<T>(key: ProjectNamespaceKeyFieldValue): Promise<T | undefined>;
     abstract set<T>(key: ProjectNamespaceKeyFieldValue, value: T): Promise<void>;
     abstract delete(key: ProjectNamespaceKeyFieldValue): Promise<void>;
+    getRealtimeBackoffMetadata(): Promise<RealtimeBackoffMetadata | undefined>;
+    setRealtimeBackoffMetadata(realtimeMetadata: RealtimeBackoffMetadata): Promise<void>;
+    getActiveConfigTemplateVersion(): Promise<number | undefined>;
+    setActiveConfigTemplateVersion(version: number): Promise<void>;
 }
 export declare class IndexedDbStorage extends Storage {
     private readonly appId;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/remote-config",
-  "version": "0.6.6",
+  "version": "0.7.0-canary.cb3bdd812",
   "description": "The Remote Config package of the Firebase JS SDK",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "main": "dist/index.cjs.js",
@@ -37,18 +37,18 @@
     "typings:internal": "node ../../scripts/build/use_typings.js ./dist/src/index.d.ts"
   },
   "peerDependencies": {
-    "@firebase/app": "0.x"
+    "@firebase/app": "0.14.3-canary.cb3bdd812"
   },
   "dependencies": {
-    "@firebase/installations": "0.6.19",
-    "@firebase/logger": "0.5.0",
-    "@firebase/util": "1.13.0",
-    "@firebase/component": "0.7.0",
+    "@firebase/installations": "0.6.19-canary.cb3bdd812",
+    "@firebase/logger": "0.5.0-canary.cb3bdd812",
+    "@firebase/util": "1.13.0-canary.cb3bdd812",
+    "@firebase/component": "0.7.0-canary.cb3bdd812",
     "tslib": "^2.1.0"
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@firebase/app": "0.14.0",
+    "@firebase/app": "0.14.3-canary.cb3bdd812",
     "rollup": "2.79.2",
     "rollup-plugin-dts": "5.3.1",
     "rollup-plugin-typescript2": "0.36.0",