Run docgen

Author: kjelko

common/api-review/remote-config.api.md

@@ -24,9 +24,22 @@ export function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean>;
 // @public
 export function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;
 
+// @public
+export interface FetchResponse {
+    config?: FirebaseRemoteConfigObject;
+    eTag?: string;
+    status: number;
+}
+
 // @public
 export type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';
 
+// @public
+export interface FirebaseRemoteConfigObject {
+    // (undocumented)
+    [key: string]: string;
+}
+
 // @public
 export function getAll(remoteConfig: RemoteConfig): Record<string, Value>;
 
@@ -37,7 +50,7 @@ export function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;
 export function getNumber(remoteConfig: RemoteConfig, key: string): number;
 
 // @public (undocumented)
-export function getRemoteConfig(app?: FirebaseApp): RemoteConfig;
+export function getRemoteConfig(app?: FirebaseApp, options?: RemoteConfigOptions): RemoteConfig;
 
 // @public
 export function getString(remoteConfig: RemoteConfig, key: string): string;
@@ -62,6 +75,12 @@ export interface RemoteConfig {
     settings: RemoteConfigSettings;
 }
 
+// @public
+export interface RemoteConfigOptions {
+    initialFetchResponse?: FetchResponse;
+    templateId?: string;
+}
+
 // @public
 export interface RemoteConfigSettings {
     fetchTimeoutMillis: number;

docs-devsite/_toc.yaml

@@ -430,8 +430,14 @@ toc:
   section:
   - title: CustomSignals
     path: /docs/reference/js/remote-config.customsignals.md
+  - title: FetchResponse
+    path: /docs/reference/js/remote-config.fetchresponse.md
+  - title: FirebaseRemoteConfigObject
+    path: /docs/reference/js/remote-config.firebaseremoteconfigobject.md
   - title: RemoteConfig
     path: /docs/reference/js/remote-config.remoteconfig.md
+  - title: RemoteConfigOptions
+    path: /docs/reference/js/remote-config.remoteconfigoptions.md
   - title: RemoteConfigSettings
     path: /docs/reference/js/remote-config.remoteconfigsettings.md
   - title: Value

docs-devsite/remote-config.fetchresponse.md

@@ -0,0 +1,67 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# FetchResponse interface
+Defines a successful response (200 or 304).
+
+<p>Modeled after the native  interface, but simplified for Remote Config's use case.
+
+<b>Signature:</b>
+
+```typescript
+export interface FetchResponse 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [config](./remote-config.fetchresponse.md#fetchresponseconfig) | [FirebaseRemoteConfigObject](./remote-config.firebaseremoteconfigobject.md#firebaseremoteconfigobject_interface) | Defines the map of parameters returned as "entries" in the fetch response body.<p>Only defined for 200 responses. |
+|  [eTag](./remote-config.fetchresponse.md#fetchresponseetag) | string | Defines the ETag response header value.<p>Only defined for 200 and 304 responses. |
+|  [status](./remote-config.fetchresponse.md#fetchresponsestatus) | number | The HTTP status, which is useful for differentiating success responses with data from those without.<p> is modeled after the native  interface, so HTTP status is first-class.<p>Disambiguation: the fetch response returns a legacy "state" value that is redundant with the HTTP status code. The former is normalized into the latter. |
+
+## FetchResponse.config
+
+Defines the map of parameters returned as "entries" in the fetch response body.
+
+<p>Only defined for 200 responses.
+
+<b>Signature:</b>
+
+```typescript
+config?: FirebaseRemoteConfigObject;
+```
+
+## FetchResponse.eTag
+
+Defines the ETag response header value.
+
+<p>Only defined for 200 and 304 responses.
+
+<b>Signature:</b>
+
+```typescript
+eTag?: string;
+```
+
+## FetchResponse.status
+
+The HTTP status, which is useful for differentiating success responses with data from those without.
+
+<p> is modeled after the native  interface, so HTTP status is first-class.
+
+<p>Disambiguation: the fetch response returns a legacy "state" value that is redundant with the HTTP status code. The former is normalized into the latter.
+
+<b>Signature:</b>
+
+```typescript
+status: number;
+```

docs-devsite/remote-config.firebaseremoteconfigobject.md

@@ -0,0 +1,19 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# FirebaseRemoteConfigObject interface
+Defines a self-descriptive reference for config key-value pairs.
+
+<b>Signature:</b>
+
+```typescript
+export interface FirebaseRemoteConfigObject 
+```

docs-devsite/remote-config.md

@@ -17,7 +17,7 @@ The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environm
 |  Function | Description |
 |  --- | --- |
 |  <b>function(app, ...)</b> |
-|  [getRemoteConfig(app)](./remote-config.md#getremoteconfig_cf608e1) |  |
+|  [getRemoteConfig(app, options)](./remote-config.md#getremoteconfig_61d368f) |  |
 |  <b>function(remoteConfig, ...)</b> |
 |  [activate(remoteConfig)](./remote-config.md#activate_722a192) | Makes the last fetched config available to the getters. |
 |  [ensureInitialized(remoteConfig)](./remote-config.md#ensureinitialized_722a192) | Ensures the last activated config are available to the getters. |
@@ -38,7 +38,10 @@ The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environm
 |  Interface | Description |
 |  --- | --- |
 |  [CustomSignals](./remote-config.customsignals.md#customsignals_interface) | Defines the type for representing custom signals and their values.<p>The values in CustomSignals must be one of the following types:<ul> <li><code>string</code> <li><code>number</code> <li><code>null</code> </ul> |
+|  [FetchResponse](./remote-config.fetchresponse.md#fetchresponse_interface) | Defines a successful response (200 or 304).<p>Modeled after the native  interface, but simplified for Remote Config's use case. |
+|  [FirebaseRemoteConfigObject](./remote-config.firebaseremoteconfigobject.md#firebaseremoteconfigobject_interface) | Defines a self-descriptive reference for config key-value pairs. |
 |  [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) | The Firebase Remote Config service interface. |
+|  [RemoteConfigOptions](./remote-config.remoteconfigoptions.md#remoteconfigoptions_interface) | Options for Remote Config initialization. |
 |  [RemoteConfigSettings](./remote-config.remoteconfigsettings.md#remoteconfigsettings_interface) | Defines configuration options for the Remote Config SDK. |
 |  [Value](./remote-config.value.md#value_interface) | Wraps a value with metadata and type-safe getters. |
 
@@ -52,19 +55,20 @@ The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environm
 
 ## function(app, ...)
 
-### getRemoteConfig(app) {:#getremoteconfig_cf608e1}
+### getRemoteConfig(app, options) {:#getremoteconfig_61d368f}
 
 <b>Signature:</b>
 
 ```typescript
-export declare function getRemoteConfig(app?: FirebaseApp): RemoteConfig;
+export declare function getRemoteConfig(app?: FirebaseApp, options?: RemoteConfigOptions): RemoteConfig;
 ```
 
 #### Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  app | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) instance. |
+|  options | [RemoteConfigOptions](./remote-config.remoteconfigoptions.md#remoteconfigoptions_interface) |  |
 
 <b>Returns:</b>
 

docs-devsite/remote-config.remoteconfigoptions.md

@@ -0,0 +1,46 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# RemoteConfigOptions interface
+Options for Remote Config initialization.
+
+<b>Signature:</b>
+
+```typescript
+export interface RemoteConfigOptions 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [initialFetchResponse](./remote-config.remoteconfigoptions.md#remoteconfigoptionsinitialfetchresponse) | [FetchResponse](./remote-config.fetchresponse.md#fetchresponse_interface) | Hydrates the state with an initial fetch response. |
+|  [templateId](./remote-config.remoteconfigoptions.md#remoteconfigoptionstemplateid) | string | The ID of the template to use. If not provided, defaults to "firebase". |
+
+## RemoteConfigOptions.initialFetchResponse
+
+Hydrates the state with an initial fetch response.
+
+<b>Signature:</b>
+
+```typescript
+initialFetchResponse?: FetchResponse;
+```
+
+## RemoteConfigOptions.templateId
+
+The ID of the template to use. If not provided, defaults to "firebase".
+
+<b>Signature:</b>
+
+```typescript
+templateId?: string;
+```

packages/remote-config/src/public_types.ts

@@ -18,6 +18,8 @@
 import { FirebaseApp } from '@firebase/app';
 import { FetchResponse } from './client/remote_config_fetch_client';
 
+export { FetchResponse, FirebaseRemoteConfigObject } from './client/remote_config_fetch_client';
+
 /**
  * Options for Remote Config initialization.
  * 

packages/remote-config/test/storage/storage.test.ts

@@ -66,7 +66,7 @@ describe('Storage', () => {
         storage = getStorage();
       });
 
-      it(`sets and gets last fetch attempt status`, async () => {
+      it('sets and gets last fetch attempt status', async () => {
         const expectedStatus = 'success';
 
         await storage.setLastFetchStatus(expectedStatus);
@@ -76,7 +76,7 @@ describe('Storage', () => {
         expect(actualStatus).to.deep.eq(expectedStatus);
       });
 
-      it(`sets and gets last fetch success timestamp`, async () => {
+      it('sets and gets last fetch success timestamp', async () => {
         const lastSuccessfulFetchTimestampMillis = 123;
 
         await storage.setLastSuccessfulFetchTimestampMillis(
@@ -89,7 +89,7 @@ describe('Storage', () => {
         expect(actualMetadata).to.deep.eq(lastSuccessfulFetchTimestampMillis);
       });
 
-      it(`sets and gets last successful fetch response`, async () => {
+      it('sets and gets last successful fetch response', async () => {
         const lastSuccessfulFetchResponse = { status: 200 } as FetchResponse;
 
         await storage.setLastSuccessfulFetchResponse(lastSuccessfulFetchResponse);
@@ -99,7 +99,7 @@ describe('Storage', () => {
         expect(actualConfig).to.deep.eq(lastSuccessfulFetchResponse);
       });
 
-      it(`sets and gets active config`, async () => {
+      it('sets and gets active config', async () => {
         const expectedConfig = { key: 'value' };
 
         await storage.setActiveConfig(expectedConfig);
@@ -109,7 +109,7 @@ describe('Storage', () => {
         expect(storedConfig).to.deep.eq(expectedConfig);
       });
 
-      it(`sets and gets active config etag`, async () => {
+      it('sets and gets active config etag', async () => {
         const expectedEtag = 'etag';
 
         await storage.setActiveConfigEtag(expectedEtag);
@@ -119,7 +119,7 @@ describe('Storage', () => {
         expect(storedConfigEtag).to.deep.eq(expectedEtag);
       });
 
-      it(`sets, gets and deletes throttle metadata`, async () => {
+      it('sets, gets and deletes throttle metadata', async () => {
         const expectedMetadata = {
           throttleEndTimeMillis: 1
         } as ThrottleMetadata;
@@ -137,7 +137,7 @@ describe('Storage', () => {
         expect(actualMetadata).to.be.undefined;
       });
 
-      it(`sets and gets custom signals`, async () => {
+      it('sets and gets custom signals', async () => {
         const customSignals = { key: 'value', key1: 'value1', key2: 1 };
         const customSignalsInStorage = {
           key: 'value',
@@ -152,7 +152,7 @@ describe('Storage', () => {
         expect(storedCustomSignals).to.deep.eq(customSignalsInStorage);
       });
 
-      it(`upserts custom signals when key is present in storage`, async () => {
+      it('upserts custom signals when key is present in storage', async () => {
         const customSignals = { key: 'value', key1: 'value1' };
         const updatedSignals = { key: 'value', key1: 'value2' };
 
@@ -165,7 +165,7 @@ describe('Storage', () => {
         expect(storedCustomSignals).to.deep.eq(updatedSignals);
       });
 
-      it(`deletes custom signal when value supplied is null`, async () => {
+      it('deletes custom signal when value supplied is null', async () => {
         const customSignals = { key: 'value', key1: 'value1' };
         const updatedSignals = { key: 'value' };
 
@@ -178,7 +178,7 @@ describe('Storage', () => {
         expect(storedCustomSignals).to.deep.eq(updatedSignals);
       });
 
-      it(`throws an error when supplied with excess custom signals`, async () => {
+      it('throws an error when supplied with excess custom signals', async () => {
         const customSignals: { [key: string]: string } = {};
         for (let i = 0; i < 101; i++) {
           customSignals[`key${i}`] = `value${i}`;