Support SSRC conditions

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

@@ -8,6 +8,16 @@
 
 import { Agent } from 'http';
 
+// @public
+export interface AndServerCondition {
+    conditions?: Array<ServerCondition>;
+}
+
+// @public
+export type EvaluationContext = {
+    randomizationId?: string;
+};
+
 // @public
 export interface ExplicitParameterValue {
     value: string;
@@ -44,6 +54,17 @@ export interface MicroPercentRange {
     microPercentUpperBound?: number;
 }
 
+// @public
+export interface NamedServerCondition {
+    condition: ServerCondition;
+    name: string;
+}
+
+// @public
+export interface OrServerCondition {
+    conditions?: Array<ServerCondition>;
+}
+
 // @public
 export type ParameterValueType = 'STRING' | 'BOOLEAN' | 'NUMBER' | 'JSON';
 
@@ -55,15 +76,23 @@ export enum PercentConditionOperator {
     UNKNOWN = "UNKNOWN"
 }
 
+// @public
+export interface PercentServerCondition {
+    microPercent?: number;
+    microPercentRange?: MicroPercentRange;
+    operator?: PercentConditionOperator;
+    seed?: string;
+}
+
 // @public
 export class RemoteConfig {
     // (undocumented)
     readonly app: App;
     createTemplateFromJSON(json: string): RemoteConfigTemplate;
-    getServerTemplate(options?: RemoteConfigServerTemplateOptions): Promise<RemoteConfigServerTemplate>;
+    getServerTemplate(options?: ServerTemplateOptions): Promise<ServerTemplate>;
     getTemplate(): Promise<RemoteConfigTemplate>;
     getTemplateAtVersion(versionNumber: number | string): Promise<RemoteConfigTemplate>;
-    initServerTemplate(options?: RemoteConfigServerTemplateOptions): RemoteConfigServerTemplate;
+    initServerTemplate(options?: ServerTemplateOptions): ServerTemplate;
     listVersions(options?: ListVersionsOptions): Promise<ListVersionsResult>;
     publishTemplate(template: RemoteConfigTemplate, options?: {
         force: boolean;
@@ -101,90 +130,61 @@ export interface RemoteConfigParameterGroup {
 export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;
 
 // @public
-export interface RemoteConfigServerAndCondition {
-    conditions?: Array<RemoteConfigServerCondition>;
+export interface RemoteConfigTemplate {
+    conditions: RemoteConfigCondition[];
+    readonly etag: string;
+    parameterGroups: {
+        [key: string]: RemoteConfigParameterGroup;
+    };
+    parameters: {
+        [key: string]: RemoteConfigParameter;
+    };
+    version?: Version;
+}
+
+// @public
+export interface RemoteConfigUser {
+    email: string;
+    imageUrl?: string;
+    name?: string;
 }
 
 // @public
-export interface RemoteConfigServerCondition {
-    and?: RemoteConfigServerAndCondition;
+export interface ServerCondition {
+    and?: AndServerCondition;
     false?: Record<string, never>;
-    or?: RemoteConfigServerOrCondition;
-    percent?: RemoteConfigServerPercentCondition;
+    or?: OrServerCondition;
+    percent?: PercentServerCondition;
     true?: Record<string, never>;
 }
 
 // @public
-export type RemoteConfigServerConfig = {
+export type ServerConfig = {
     [key: string]: string | boolean | number;
 };
 
 // @public
-export type RemoteConfigServerContext = {
-    randomizationId?: string;
-};
-
-// @public
-export interface RemoteConfigServerNamedCondition {
-    condition: RemoteConfigServerCondition;
-    name: string;
-}
-
-// @public
-export interface RemoteConfigServerOrCondition {
-    conditions?: Array<RemoteConfigServerCondition>;
-}
-
-// @public
-export interface RemoteConfigServerPercentCondition {
-    microPercent?: number;
-    microPercentRange?: MicroPercentRange;
-    operator?: PercentConditionOperator;
-    seed?: string;
-}
-
-// @public
-export interface RemoteConfigServerTemplate {
-    cache: RemoteConfigServerTemplateData;
-    defaultConfig: RemoteConfigServerConfig;
-    evaluate(context?: RemoteConfigServerContext): RemoteConfigServerConfig;
+export interface ServerTemplate {
+    cache: ServerTemplateData;
+    defaultConfig: ServerConfig;
+    evaluate(context?: EvaluationContext): ServerConfig;
     load(): Promise<void>;
 }
 
 // @public
-export interface RemoteConfigServerTemplateData {
-    conditions: RemoteConfigServerNamedCondition[];
-    readonly etag: string;
-    parameters: {
-        [key: string]: RemoteConfigParameter;
-    };
-    version?: Version;
-}
-
-// @public
-export interface RemoteConfigServerTemplateOptions {
-    defaultConfig?: RemoteConfigServerConfig;
-    template?: RemoteConfigServerTemplateData;
-}
-
-// @public
-export interface RemoteConfigTemplate {
-    conditions: RemoteConfigCondition[];
+export interface ServerTemplateData {
+    conditions: NamedServerCondition[];
     readonly etag: string;
-    parameterGroups: {
-        [key: string]: RemoteConfigParameterGroup;
-    };
     parameters: {
         [key: string]: RemoteConfigParameter;
     };
     version?: Version;
 }
 
 // @public
-export interface RemoteConfigUser {
-    email: string;
-    imageUrl?: string;
-    name?: string;
+export interface ServerTemplateOptions {
+    defaultConfig?: ServerConfig;
+    template?: ServerTemplateData;
 }
 
 // @public

src/remote-config/index.ts

@@ -25,29 +25,29 @@ import { FirebaseApp } from '../app/firebase-app';
 import { RemoteConfig } from './remote-config';
 
 export {
+  AndServerCondition,
+  EvaluationContext,
   ExplicitParameterValue,
   InAppDefaultValue,
   ListVersionsOptions,
   ListVersionsResult,
   MicroPercentRange,
+  NamedServerCondition,
+  OrServerCondition,
   ParameterValueType,
   PercentConditionOperator,
+  PercentServerCondition,
   RemoteConfigCondition,
   RemoteConfigParameter,
   RemoteConfigParameterGroup,
   RemoteConfigParameterValue,
   RemoteConfigTemplate,
+  RemoteConfigUser,
   ServerCondition,
-  EvaluationContext,
-  AndServerCondition,
-  NamedServerCondition,
-  OrServerCondition,
-  PercentServerCondition,
   ServerConfig,
-  RemoteConfigServerTemplate,
-  RemoteConfigServerTemplateData,
-  RemoteConfigServerTemplateOptions,
-  RemoteConfigUser,
+  ServerTemplate,
+  ServerTemplateData,
+  ServerTemplateOptions,
   TagColor,
   Version,
 } from './remote-config-api';

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

@@ -25,7 +25,7 @@ import {
   ListVersionsOptions,
   ListVersionsResult,
   RemoteConfigTemplate,
-  RemoteConfigServerTemplateData
+  ServerTemplateData
 } from './remote-config-api';
 
 // Remote Config backend constants
@@ -175,7 +175,7 @@ export class RemoteConfigApiClient {
       });
   }
 
-  public getServerTemplate(): Promise<RemoteConfigServerTemplateData> {
+  public getServerTemplate(): Promise<ServerTemplateData> {
     return this.getUrl()
       .then((url) => {
         const request: HttpRequestConfig = {
@@ -289,7 +289,7 @@ export class RemoteConfigApiClient {
    * @param {HttpResponse} resp API response object.
    * @param {string} customEtag A custom etag to replace the etag fom the API response (Optional).
    */
-  private toRemoteConfigServerTemplate(resp: HttpResponse, customEtag?: string): RemoteConfigServerTemplateData {
+  private toRemoteConfigServerTemplate(resp: HttpResponse, customEtag?: string): ServerTemplateData {
     const etag = (typeof customEtag === 'undefined') ? resp.headers['etag'] : customEtag;
     this.validateEtag(etag);
     return {

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

@@ -329,7 +329,7 @@ export interface RemoteConfigTemplate {
 /**
  * Represents the data in a Remote Config server template.
  */
-export interface RemoteConfigServerTemplateData {
+export interface ServerTemplateData {
   /**
    * A list of conditions in descending order by priority.
    */
@@ -352,9 +352,9 @@ export interface RemoteConfigServerTemplateData {
 }
 
 /**
- * Represents optional arguments that can be used when instantiating {@link RemoteConfigServerTemplate}.
+ * Represents optional arguments that can be used when instantiating {@link ServerTemplate}.
  */
-export interface RemoteConfigServerTemplateOptions {
+export interface ServerTemplateOptions {
 
   /**
    * Defines in-app default parameter values, so that your app behaves as
@@ -369,18 +369,18 @@ export interface RemoteConfigServerTemplateOptions {
    * caching template data and then using this option to initialize the SDK with
    * that data.
    */
-  template?: RemoteConfigServerTemplateData,
+  template?: ServerTemplateData,
 }
 
 /**
  * Represents a stateful abstraction for a Remote Config server template.
  */
-export interface RemoteConfigServerTemplate {
+export interface ServerTemplate {
 
   /**
-   * Cached {@link RemoteConfigServerTemplateData}.
+   * Cached {@link ServerTemplateData}.
    */
-  cache: RemoteConfigServerTemplateData;
+  cache: ServerTemplateData;
 
   /**
    * A {@link ServerConfig} that contains default Config values.
@@ -394,7 +394,7 @@ export interface RemoteConfigServerTemplate {
 
   /**
    * Fetches and caches the current active version of the
-   * project's {@link RemoteConfigServerTemplate}.
+   * project's {@link ServerTemplate}.
    */
   load(): Promise<void>;
 }

src/remote-config/remote-config.ts

@@ -24,19 +24,19 @@ import {
   RemoteConfigCondition,
   RemoteConfigParameter,
   RemoteConfigParameterGroup,
-  RemoteConfigServerTemplate,
+  ServerTemplate,
   RemoteConfigTemplate,
   RemoteConfigUser,
   Version,
   ExplicitParameterValue,
   InAppDefaultValue,
   ParameterValueType,
   ServerConfig,
-  RemoteConfigServerTemplateData,
-  RemoteConfigServerTemplateOptions,
   RemoteConfigParameterValue,
-  NamedServerCondition,
   EvaluationContext,
+  ServerTemplateData,
+  ServerTemplateOptions,
+  NamedServerCondition,
 } from './remote-config-api';
 
 /**
@@ -181,19 +181,19 @@ export class RemoteConfig {
   }
 
   /**
-   * Instantiates {@link RemoteConfigServerTemplate} and then fetches and caches the latest
+   * Instantiates {@link ServerTemplate} and then fetches and caches the latest
    * template version of the project.
    */
-  public async getServerTemplate(options?: RemoteConfigServerTemplateOptions): Promise<RemoteConfigServerTemplate> {
+  public async getServerTemplate(options?: ServerTemplateOptions): Promise<ServerTemplate> {
     const template = this.initServerTemplate(options);
     await template.load();
     return template;
   }
 
   /**
-   * Synchronously instantiates {@link RemoteConfigServerTemplate}.
+   * Synchronously instantiates {@link ServerTemplate}.
    */
-  public initServerTemplate(options?: RemoteConfigServerTemplateOptions): RemoteConfigServerTemplate {
+  public initServerTemplate(options?: ServerTemplateOptions): ServerTemplate {
     const template = new RemoteConfigServerTemplateImpl(
       this.client, new RemoteConfigConditionEvaluator(), options?.defaultConfig);
     if (options?.template) {
@@ -290,8 +290,8 @@ class RemoteConfigTemplateImpl implements RemoteConfigTemplate {
 /**
  * Remote Config dataplane template data implementation.
  */
-class RemoteConfigServerTemplateImpl implements RemoteConfigServerTemplate {
-  public cache: RemoteConfigServerTemplateData;
+class RemoteConfigServerTemplateImpl implements ServerTemplate {
+  public cache: ServerTemplateData;
 
   constructor(
     private readonly apiClient: RemoteConfigApiClient,
@@ -300,7 +300,7 @@ class RemoteConfigServerTemplateImpl implements RemoteConfigServerTemplate {
   ) { }
 
   /**
-   * Fetches and caches the current active version of the project's {@link RemoteConfigServerTemplate}.
+   * Fetches and caches the current active version of the project's {@link ServerTemplate}.
    */
   public load(): Promise<void> {
     return this.apiClient.getServerTemplate()
@@ -411,14 +411,14 @@ class RemoteConfigServerTemplateImpl implements RemoteConfigServerTemplate {
 /**
  * Remote Config dataplane template data implementation.
  */
-class RemoteConfigServerTemplateDataImpl implements RemoteConfigServerTemplateData {
+class RemoteConfigServerTemplateDataImpl implements ServerTemplateData {
   public parameters: { [key: string]: RemoteConfigParameter };
   public parameterGroups: { [key: string]: RemoteConfigParameterGroup };
   public conditions: NamedServerCondition[];
   public readonly etag: string;
   public version?: Version;
 
-  constructor(template: RemoteConfigServerTemplateData) {
+  constructor(template: ServerTemplateData) {
     if (!validator.isNonNullObject(template) ||
       !validator.isNonEmptyString(template.etag)) {
       throw new FirebaseRemoteConfigError(