Export firebaseExperimentDescription

Author: Athira M

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

@@ -41,7 +41,6 @@ export function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;
 export interface FetchResponse {
     config?: FirebaseRemoteConfigObject;
     eTag?: string;
-    // Warning: (ae-forgotten-export) The symbol "FirebaseExperimentDescription" needs to be exported by the entry point index.d.ts
     experiments?: FirebaseExperimentDescription[];
     status: number;
     templateVersion?: number;
@@ -53,6 +52,22 @@ export type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';
 // @public
 export type FetchType = 'BASE' | 'REALTIME';
 
+// @public
+export interface FirebaseExperimentDescription {
+    // (undocumented)
+    affectedParameterKeys?: string[];
+    // (undocumented)
+    experimentId: string;
+    // (undocumented)
+    experimentStartTime: string;
+    // (undocumented)
+    timeToLiveMillis: string;
+    // (undocumented)
+    triggerTimeoutMillis: string;
+    // (undocumented)
+    variantId: string;
+}
+
 // @public
 export interface FirebaseRemoteConfigObject {
     // (undocumented)

docs-devsite/_toc.yaml

@@ -649,6 +649,8 @@ toc:
     path: /docs/reference/js/remote-config.customsignals.md
   - title: FetchResponse
     path: /docs/reference/js/remote-config.fetchresponse.md
+  - title: FirebaseExperimentDescription
+    path: /docs/reference/js/remote-config.firebaseexperimentdescription.md
   - title: FirebaseRemoteConfigObject
     path: /docs/reference/js/remote-config.firebaseremoteconfigobject.md
   - title: RemoteConfig

docs-devsite/remote-config.fetchresponse.md

@@ -26,7 +26,7 @@ export interface FetchResponse
 |  --- | --- | --- |
 |  [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. |
-|  [experiments](./remote-config.fetchresponse.md#fetchresponseexperiments) | FirebaseExperimentDescription\[\] | A/B Test and Rollout experiment metadata. |
+|  [experiments](./remote-config.fetchresponse.md#fetchresponseexperiments) | [FirebaseExperimentDescription](./remote-config.firebaseexperimentdescription.md#firebaseexperimentdescription_interface)<!-- -->\[\] | A/B Test and Rollout experiment metadata. |
 |  [status](./remote-config.fetchresponse.md#fetchresponsestatus) | number | The HTTP status, which is useful for differentiating success responses with data from those without.<p>The Remote Config client is modeled after the native <code>Fetch</code> 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. |
 |  [templateVersion](./remote-config.fetchresponse.md#fetchresponsetemplateversion) | number | The version number of the config template fetched from the server. |
 

docs-devsite/remote-config.firebaseexperimentdescription.md

@@ -0,0 +1,78 @@
+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 %}
+
+# FirebaseExperimentDescription interface
+Defines experiment and variant attached to a config parameter.
+
+<b>Signature:</b>
+
+```typescript
+export interface FirebaseExperimentDescription 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [affectedParameterKeys](./remote-config.firebaseexperimentdescription.md#firebaseexperimentdescriptionaffectedparameterkeys) | string\[\] |  |
+|  [experimentId](./remote-config.firebaseexperimentdescription.md#firebaseexperimentdescriptionexperimentid) | string |  |
+|  [experimentStartTime](./remote-config.firebaseexperimentdescription.md#firebaseexperimentdescriptionexperimentstarttime) | string |  |
+|  [timeToLiveMillis](./remote-config.firebaseexperimentdescription.md#firebaseexperimentdescriptiontimetolivemillis) | string |  |
+|  [triggerTimeoutMillis](./remote-config.firebaseexperimentdescription.md#firebaseexperimentdescriptiontriggertimeoutmillis) | string |  |
+|  [variantId](./remote-config.firebaseexperimentdescription.md#firebaseexperimentdescriptionvariantid) | string |  |
+
+## FirebaseExperimentDescription.affectedParameterKeys
+
+<b>Signature:</b>
+
+```typescript
+affectedParameterKeys?: string[];
+```
+
+## FirebaseExperimentDescription.experimentId
+
+<b>Signature:</b>
+
+```typescript
+experimentId: string;
+```
+
+## FirebaseExperimentDescription.experimentStartTime
+
+<b>Signature:</b>
+
+```typescript
+experimentStartTime: string;
+```
+
+## FirebaseExperimentDescription.timeToLiveMillis
+
+<b>Signature:</b>
+
+```typescript
+timeToLiveMillis: string;
+```
+
+## FirebaseExperimentDescription.triggerTimeoutMillis
+
+<b>Signature:</b>
+
+```typescript
+triggerTimeoutMillis: string;
+```
+
+## FirebaseExperimentDescription.variantId
+
+<b>Signature:</b>
+
+```typescript
+variantId: string;
+```

docs-devsite/remote-config.md

@@ -42,6 +42,7 @@ The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environm
 |  [ConfigUpdateObserver](./remote-config.configupdateobserver.md#configupdateobserver_interface) | Observer interface for receiving real-time Remote Config update notifications.<!-- -->NOTE: Although an <code>complete</code> callback can be provided, it will never be called because the ConfigUpdate stream is never-ending. |
 |  [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 <code>Response</code> interface, but simplified for Remote Config's use case. |
+|  [FirebaseExperimentDescription](./remote-config.firebaseexperimentdescription.md#firebaseexperimentdescription_interface) | Defines experiment and variant attached to a config parameter. |
 |  [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. |

packages/remote-config/src/client/rest_client.ts

@@ -18,7 +18,8 @@
 import {
   CustomSignals,
   FetchResponse,
-  FirebaseRemoteConfigObject
+  FirebaseRemoteConfigObject,
+  FirebaseExperimentDescription
 } from '../public_types';
 import {
   RemoteConfigFetchClient,
@@ -48,32 +49,6 @@ interface FetchRequestBody {
   /* eslint-enable camelcase */
 }
 
-/**
- * Defines experiment and variant attached to a config parameter.
- */
-export interface FirebaseExperimentDescription {
-  // A string of max length 22 characters and of format: _exp_<experiment_id>
-  experimentId: string;
-
-  // The variant of the experiment assigned to the app instance.
-  variantId: string;
-
-  // When the experiment was started.
-  experimentStartTime: string;
-
-  // How long the experiment can remain in STANDBY state. Valid range from 1 ms
-  // to 6 months.
-  triggerTimeoutMillis: string;
-
-  // How long the experiment can remain in ON state. Valid range from 1 ms to 6
-  // months.
-  timeToLiveMillis: string;
-
-  // A repeated of Remote Config parameter keys that this experiment is
-  // affecting the value of.
-  affectedParameterKeys?: string[];
-}
-
 /**
  * Implements the Client abstraction for the Remote Config REST API.
  */

packages/remote-config/src/public_types.ts

@@ -16,7 +16,6 @@
  */
 
 import { FirebaseApp, FirebaseError } from '@firebase/app';
-import { FirebaseExperimentDescription } from './client/rest_client';
 
 /**
  * The Firebase Remote Config service interface.
@@ -60,6 +59,34 @@ export interface FirebaseRemoteConfigObject {
   [key: string]: string;
 }
 
+/**
+ * Defines experiment and variant attached to a config parameter.
+ *
+ * @public
+ */
+export interface FirebaseExperimentDescription {
+  // A string of max length 22 characters and of format: _exp_<experiment_id>
+  experimentId: string;
+
+  // The variant of the experiment assigned to the app instance.
+  variantId: string;
+
+  // When the experiment was started.
+  experimentStartTime: string;
+
+  // How long the experiment can remain in STANDBY state. Valid range from 1 ms
+  // to 6 months.
+  triggerTimeoutMillis: string;
+
+  // How long the experiment can remain in ON state. Valid range from 1 ms to 6
+  // months.
+  timeToLiveMillis: string;
+
+  // A repeated of Remote Config parameter keys that this experiment is
+  // affecting the value of.
+  affectedParameterKeys?: string[];
+}
+
 /**
  * Defines a successful response (200 or 304).
  *