Add interface/type documentation & run apidocs

Author: ashish-kothari

etc/firebase-admin.remote-config.api.md

@@ -49,12 +49,32 @@ export type EvaluationContext = UserProvidedSignals & PredefinedSignals;
 
 // @public (undocumented)
 export interface ExperimentParameterValue {
-    // Warning: (ae-forgotten-export) The symbol "ExperimentValue" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
     experimentValue: ExperimentValue;
 }
 
+// @public
+export interface ExperimentValue {
+    experimentId: string;
+    variantValue: ExperimentVariantValue[];
+}
+
+// @public
+export interface ExperimentVariantExplicitValue {
+    noChange?: never;
+    value: string;
+    variantId: string;
+}
+
+// @public
+export interface ExperimentVariantNoChange {
+    noChange: true;
+    value?: never;
+    variantId: string;
+}
+
+// @public
+export type ExperimentVariantValue = ExperimentVariantExplicitValue | ExperimentVariantNoChange;
+
 // @public
 export interface ExplicitParameterValue {
     value: string;
@@ -150,14 +170,16 @@ export enum PercentConditionOperator {
     UNKNOWN = "UNKNOWN"
 }
 
-// @public (undocumented)
+// @public
 export interface PersonalizationParameterValue {
-    // Warning: (ae-forgotten-export) The symbol "PersonalizationValue" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
     personalizationValue: PersonalizationValue;
 }
 
+// @public
+export interface PersonalizationValue {
+    personalizationId: string;
+}
+
 // @public
 export type PredefinedSignals = {
     randomizationId?: string;
@@ -235,14 +257,18 @@ export interface RemoteConfigUser {
     name?: string;
 }
 
-// @public (undocumented)
+// @public
 export interface RolloutParameterValue {
-    // Warning: (ae-forgotten-export) The symbol "RolloutValue" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
     rolloutValue: RolloutValue;
 }
 
+// @public
+export interface RolloutValue {
+    percent: number;
+    rolloutId: string;
+    value: string;
+}
+
 // @public
 export interface ServerConfig {
     getAll(): {

src/remote-config/index.ts

@@ -48,8 +48,14 @@ export {
   RemoteConfigCondition,
   RemoteConfigParameter,
   ExperimentParameterValue,
+  ExperimentValue,
+  ExperimentVariantExplicitValue,
+  ExperimentVariantNoChange,
+  ExperimentVariantValue,
   PersonalizationParameterValue,
+  PersonalizationValue,
   RolloutParameterValue,
+  RolloutValue,
   RemoteConfigParameterGroup,
   RemoteConfigParameterValue,
   RemoteConfigTemplate,

src/remote-config/remote-config-api.ts

@@ -355,58 +355,128 @@ export interface InAppDefaultValue {
 }
 
 /**
- * Represents a Rollout value.
+ * Interface representing a value that is linked to a Rollout.
  */
 export interface RolloutValue {
+  /**
+   * The ID of the Rollout to which the value is linked.
+   */
   rolloutId: string;
+
+  /**
+   * The value that is being rolled out.
+   */
   value: string;
+
+  /**
+   * The rollout percentage representing the exposure of the rollout value in
+   * the target audience.
+   */
   percent: number; // Numeric value between 1-100
 }
 
 /**
- * Represents a Personalization value.
+ * Interface representing a value returned by Personalization.
  */
 export interface PersonalizationValue {
+  /**
+   * The ID of the Personalization to which the value is linked.
+   */
   personalizationId: string;
 }
 
 /**
- * Represents a specific variant value within an Experiment.
+ * Interface representing a specific variant value within an Experiment.
  */
 export interface ExperimentVariantExplicitValue {
+  /**
+   * ID of the variant value within an Experiment.
+   */
   variantId: string;
+
+  /**
+   * Value of the variant within an Experiment. 
+   */
   value: string;
+
+  /**
+   * Represents an unset `noChange` value. To set `noChange`, use
+   * `ExperimentVariantNoChange` instead.
+   */
   noChange?: never;
 }
 
 /**
  * Represents a no-change variant value within an Experiment.
  */
 export interface ExperimentVariantNoChange {
+  /**
+   * ID of the variant value within an Experiment.
+   */
   variantId: string;
+
+  /**
+   * Represents an unset value as only one of `noChange` or `value` can be set.
+   * To set a variant value, use `ExperimentVariantExplicitValue` instead. 
+   */
   value?: never;
+
+  /**
+   * Represents a no-change variant value within an Experiment. If `true`,
+   * the variant served to the client is equal to the value against the
+   * next condition in the evaluation order (or the default value if no
+   * conditions are applicable).
+   */
   noChange: true;
 }
 
+/**
+ * Type representing a Experiment variant value.
+ * A `ExperimentVariantValue` could be either an
+ * `ExperimentVariantExplicitValue` or an `ExperimentVariantNoChange`.
+ */
 export type ExperimentVariantValue = ExperimentVariantExplicitValue | ExperimentVariantNoChange;
 
 /**
  * Represents an Experiment value.
  */
 export interface ExperimentValue {
+  /** 
+   * ID of the Experiment to which the value is linked.
+  */
   experimentId: string;
+
+  /**
+   * Collection of `ExperimentVariantValue`s that represents the variants
+   * served by the Experiment.
+   */
   variantValue: ExperimentVariantValue[];
 }
 
+/**
+ * Interface representing a parameter value linked to a Rollout.
+ */
 export interface RolloutParameterValue {
+  /**
+   * The value returned by a Rollout.
+   */
   rolloutValue: RolloutValue;
 }
 
+/**
+ * Interface representing a parameter value linked to a Personalization.
+ */
 export interface PersonalizationParameterValue {
+  /**
+   * The value returned by a Personalization.
+   */
   personalizationValue: PersonalizationValue;
 }
 
 export interface ExperimentParameterValue {
+  /**
+   * The value returned by an Experiment.
+   */
   experimentValue: ExperimentValue;
 }