feat: Remote Config Management API (#845)

Added support for the Remote Config API. This API enables Firebase developers to programmatically manage the set of JSON-formatted parameters and conditions known as the Remote Config template.

Author: lahirumaramba

docgen/content-sources/node/toc.yaml

@@ -255,3 +255,23 @@ toc:
   section:
   - title: "Storage"
     path: /docs/reference/admin/node/admin.storage.Storage
+
+- title: "admin.remoteConfig"
+  path: /docs/reference/admin/node/admin.remoteConfig
+  section:
+  - title: "RemoteConfig"
+    path: /docs/reference/admin/node/admin.remoteConfig.RemoteConfig
+  - title: "RemoteConfigTemplate"
+    path: /docs/reference/admin/node/admin.remoteConfig.RemoteConfigTemplate
+  - title: "RemoteConfigParameter"
+    path: /docs/reference/admin/node/admin.remoteConfig.RemoteConfigParameter
+  - title: "RemoteConfigParameterGroup"
+    path: /docs/reference/admin/node/admin.remoteConfig.RemoteConfigParameterGroup
+  - title: "RemoteConfigCondition"
+    path: /docs/reference/admin/node/admin.remoteConfig.RemoteConfigCondition
+  - title: "ExplicitParameterValue"
+    path: /docs/reference/admin/node/admin.remoteConfig.ExplicitParameterValue
+  - title: "InAppDefaultValue"
+    path: /docs/reference/admin/node/admin.remoteConfig.InAppDefaultValue
+  - title: "RemoteConfigParameterValue"
+    path: /docs/reference/admin/node/admin.remoteConfig.RemoteConfigParameterValue

src/firebase-app.ts

@@ -33,6 +33,7 @@ import {InstanceId} from './instance-id/instance-id';
 
 import {ProjectManagement} from './project-management/project-management';
 import {SecurityRules} from './security-rules/security-rules';
+import { RemoteConfig } from './remote-config/remote-config';
 
 import {Agent} from 'http';
 
@@ -395,6 +396,18 @@ export class FirebaseApp {
     });
   }
 
+  /**
+   * Returns the RemoteConfig service instance associated with this app.
+   *
+   * @return {RemoteConfig} The RemoteConfig service instance of this app.
+   */
+  public remoteConfig(): RemoteConfig {
+    return this.ensureService_('remoteConfig', () => {
+      const remoteConfigService: typeof RemoteConfig = require('./remote-config/remote-config').RemoteConfig;
+      return new remoteConfigService(this);
+    });
+  }
+
   /**
    * Returns the name of the FirebaseApp instance.
    *

src/firebase-namespace.ts

@@ -36,6 +36,7 @@ import {Firestore} from '@google-cloud/firestore';
 import {InstanceId} from './instance-id/instance-id';
 import {ProjectManagement} from './project-management/project-management';
 import { SecurityRules } from './security-rules/security-rules';
+import { RemoteConfig } from './remote-config/remote-config';
 
 import * as validator from './utils/validator';
 
@@ -451,6 +452,18 @@ export class FirebaseNamespace {
     return Object.assign(fn, {SecurityRules: securityRules});
   }
 
+  /**
+   * Gets the `RemoteConfig` service namespace. The returned namespace can be used to get the
+   * `RemoteConfig` service for the default app or an explicitly specified app.
+   */
+  get remoteConfig(): FirebaseServiceNamespace<RemoteConfig> {
+    const fn: FirebaseServiceNamespace<RemoteConfig> = (app?: FirebaseApp) => {
+      return this.ensureApp(app).remoteConfig();
+    };
+    const remoteConfig = require('./remote-config/remote-config').RemoteConfig;
+    return Object.assign(fn, { RemoteConfig: remoteConfig });
+  }
+
   /**
    * Initializes the FirebaseApp instance.
    *

src/index.d.ts

@@ -374,6 +374,37 @@ declare namespace admin {
   */
   function projectManagement(app?: admin.app.App): admin.projectManagement.ProjectManagement;
 
+  /**
+   * Gets the {@link admin.remoteConfig.RemoteConfig `RemoteConfig`} service for the
+   * default app or a given app.
+   *
+   * `admin.remoteConfig()` can be called with no arguments to access the default
+   * app's {@link admin.remoteConfig.RemoteConfig `RemoteConfig`} service or as
+   * `admin.remoteConfig(app)` to access the
+   * {@link admin.remoteConfig.RemoteConfig `RemoteConfig`} service associated with a
+   * specific app.
+   *
+   * @example
+   * ```javascript
+   * // Get the `RemoteConfig` service for the default app
+   * var defaultRemoteConfig = admin.remoteConfig();
+   * ```
+   *
+   * @example
+   * ```javascript
+   * // Get the `RemoteConfig` service for a given app
+   * var otherRemoteConfig = admin.remoteConfig(otherApp);
+   * ```
+   *
+   * @param app Optional app for which to return the `RemoteConfig` service.
+   *   If not provided, the default `RemoteConfig` service is returned.
+   *
+   * @return The default `RemoteConfig` service if no
+   *   app is provided, or the `RemoteConfig` service associated with the provided
+   *   app.
+   */
+  function remoteConfig(app?: admin.app.App): admin.remoteConfig.RemoteConfig;
+
   /**
   * Gets the {@link admin.securityRules.SecurityRules
   * `SecurityRules`} service for the default app or a given app.
@@ -496,6 +527,7 @@ declare namespace admin.app {
     machineLearning(): admin.machineLearning.MachineLearning;
     messaging(): admin.messaging.Messaging;
     projectManagement(): admin.projectManagement.ProjectManagement;
+    remoteConfig(): admin.remoteConfig.RemoteConfig;
     securityRules(): admin.securityRules.SecurityRules;
     storage(): admin.storage.Storage;
 
@@ -812,6 +844,196 @@ declare namespace admin.projectManagement {
   export import ProjectManagement = _projectManagement.admin.projectManagement.ProjectManagement;
 }
 
+declare namespace admin.remoteConfig {
+
+  /**
+  * Colors that are associated with conditions for display purposes.
+  */
+  type TagColor = 'BLUE' | 'BROWN' | 'CYAN' | 'DEEP_ORANGE' | 'GREEN' |
+    'INDIGO' | 'LIME' | 'ORANGE' | 'PINK' | 'PURPLE' | 'TEAL';
+
+  /**
+  * Interface representing a Remote Config template.
+  */
+  interface RemoteConfigTemplate {
+    /**
+     * A list of conditions in descending order by priority.
+     */
+    conditions: RemoteConfigCondition[];
+
+    /**
+     * Map of parameter keys to their optional default values and optional conditional values.
+     */
+    parameters: { [key: string]: RemoteConfigParameter };
+
+    /**
+     * Map of parameter group names to their parameter group objects.
+     * A group's name is mutable but must be unique among groups in the Remote Config template.
+     * The name is limited to 256 characters and intended to be human-readable. Any Unicode
+     * characters are allowed.
+     */
+    parameterGroups: { [key: string]: RemoteConfigParameterGroup };
+
+    /**
+     * ETag of the current Remote Config template (readonly).
+     */
+    readonly etag: string;
+  }
+
+  /**
+   * Interface representing a Remote Config parameter.
+   * At minimum, a `defaultValue` or a `conditionalValues` entry must be present for the 
+   * parameter to have any effect.
+   */
+  interface RemoteConfigParameter {
+
+    /**
+     * The value to set the parameter to, when none of the named conditions evaluate to `true`.
+     */
+    defaultValue?: RemoteConfigParameterValue;
+
+    /**
+     * A `(condition name, value)` map. The condition name of the highest priority
+     * (the one listed first in the Remote Config template's conditions list) determines the value of 
+     * this parameter.
+     */
+    conditionalValues?: { [key: string]: RemoteConfigParameterValue };
+
+    /**
+     * A description for this parameter. Should not be over 100 characters and may contain any
+     * Unicode characters.
+     */
+    description?: string;
+  }
+
+  /**
+   * Interface representing a Remote Config parameter group.
+   * Grouping parameters is only for management purposes and does not affect client-side
+   * fetching of parameter values.
+   */
+  export interface RemoteConfigParameterGroup {
+    /**
+     * A description for the group. Its length must be less than or equal to 256 characters.
+     * A description may contain any Unicode characters.
+     */
+    description?: string;
+
+    /**
+     * Map of parameter keys to their optional default values and optional conditional values for
+     * parameters that belong to this group. A parameter only appears once per
+     * Remote Config template. An ungrouped parameter appears at the top level, whereas a
+     * parameter organized within a group appears within its group's map of parameters.
+     */
+    parameters: { [key: string]: RemoteConfigParameter };
+  }
+
+  /**
+   * Interface representing a Remote Config condition.
+   * A condition targets a specific group of users. A list of these conditions make up
+   * part of a Remote Config template.
+   */
+  interface RemoteConfigCondition {
+
+    /**
+     * A non-empty and unique name of this condition.
+     */
+    name: string;
+
+    /**
+     * The logic of this condition.
+     * See the documentation on
+     * {@link https://firebase.google.com/docs/remote-config/condition-reference condition expressions}
+     * for the expected syntax of this field.
+     */
+    expression: string;
+
+    /**
+     * The color associated with this condition for display purposes in the Firebase Console.
+     * Not specifying this value results in the console picking an arbitrary color to associate
+     * with the condition.
+     */
+    tagColor?: TagColor;
+  }
+
+  /**
+   * Interface representing an explicit parameter value.
+   */
+  interface ExplicitParameterValue {
+    /**
+     * The `string` value that the parameter is set to.
+     */
+    value: string;
+  }
+
+  /**
+   * Interface representing an in-app-default value.
+   */
+  interface InAppDefaultValue {
+    /**
+     * If `true`, the parameter is omitted from the parameter values returned to a client.
+     */
+    useInAppDefault: boolean;
+  }
+
+  /**
+   * Type representing a Remote Config parameter value.
+   * A `RemoteConfigParameterValue` could be either an `ExplicitParameterValue` or 
+   * an `InAppDefaultValue`.
+   */
+  type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;
+
+  /**
+   * The Firebase `RemoteConfig` service interface.
+   *
+   * Do not call this constructor directly. Instead, use
+   * [`admin.remoteConfig()`](admin.remoteConfig#remoteConfig).
+   */
+  interface RemoteConfig {
+    app: admin.app.App;
+
+    /**
+     * Gets the current active version of the {@link admin.remoteConfig.RemoteConfigTemplate
+     * `RemoteConfigTemplate`} of the project.
+     *
+     * @return A promise that fulfills with a `RemoteConfigTemplate`.
+     */
+    getTemplate(): Promise<RemoteConfigTemplate>;
+
+    /**
+     * Validates a {@link admin.remoteConfig.RemoteConfigTemplate `RemoteConfigTemplate`}.
+     *
+     * @param template The Remote Config template to be validated.
+     * @returns A promise that fulfills with the validated `RemoteConfigTemplate`.
+     */
+    validateTemplate(template: RemoteConfigTemplate): Promise<RemoteConfigTemplate>;
+
+    /**
+     * Publishes a Remote Config template.
+     *
+     * @param template The Remote Config template to be published.
+     * @param options Optional options object when publishing a Remote Config template:
+     *    - {boolean} `force` Setting this to `true` forces the Remote Config template to 
+     *      be updated and circumvent the ETag. This approach is not recommended 
+     *      because it risks causing the loss of updates to your Remote Config 
+     *      template if multiple clients are updating the Remote Config template.
+     *      See {@link https://firebase.google.com/docs/remote-config/use-config-rest#etag_usage_and_forced_updates 
+     *      ETag usage and forced updates}.
+     *
+     * @return A Promise that fulfills with the published `RemoteConfigTemplate`.
+     */
+    publishTemplate(template: RemoteConfigTemplate, options?: { force: boolean }): Promise<RemoteConfigTemplate>;
+
+    /**
+     * Creates and returns a new Remote Config template from a JSON string.
+     *
+     * @param json The JSON string to populate a Remote Config template.
+     *
+     * @return A new template instance.
+     */
+    createTemplateFromJSON(json: string): RemoteConfigTemplate;
+  }
+}
+
 declare namespace admin.securityRules {
   export import RulesFile = _securityRules.admin.securityRules.RulesFile;
   export import RulesetMetadata = _securityRules.admin.securityRules.RulesetMetadata;