firebase-admin 12.0.0 → 12.1.0

package/lib/remote-config/remote-config-api.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v12.0.0 */
+/*! firebase-admin v12.1.0 */
 /*!
  * Copyright 2021 Google Inc.
  *
@@ -47,6 +47,139 @@ export interface RemoteConfigCondition {
      */
     tagColor?: TagColor;
 }
+/**
+ * Represents a Remote Config condition in the dataplane.
+ * A condition targets a specific group of users. A list of these conditions
+ * comprise part of a Remote Config template.
+ */
+export interface NamedCondition {
+    /**
+     * 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.
+     */
+    condition: OneOfCondition;
+}
+/**
+ * Represents a condition that may be one of several types.
+ * Only the first defined field will be processed.
+ */
+export interface OneOfCondition {
+    /**
+     * Makes this condition an OR condition.
+     */
+    orCondition?: OrCondition;
+    /**
+     * Makes this condition an AND condition.
+     */
+    andCondition?: AndCondition;
+    /**
+     * Makes this condition a constant true.
+     */
+    true?: Record<string, never>;
+    /**
+     * Makes this condition a constant false.
+     */
+    false?: Record<string, never>;
+    /**
+     * Makes this condition a percent condition.
+     */
+    percent?: PercentCondition;
+}
+/**
+ * Represents a collection of conditions that evaluate to true if all are true.
+ */
+export interface AndCondition {
+    /**
+     * The collection of conditions.
+     */
+    conditions?: Array<OneOfCondition>;
+}
+/**
+ * Represents a collection of conditions that evaluate to true if any are true.
+ */
+export interface OrCondition {
+    /**
+     * The collection of conditions.
+     */
+    conditions?: Array<OneOfCondition>;
+}
+/**
+ * Defines supported operators for percent conditions.
+ */
+export declare enum PercentConditionOperator {
+    /**
+     * A catchall error case.
+     */
+    UNKNOWN = "UNKNOWN",
+    /**
+     * Target percentiles less than or equal to the target percent.
+     * A condition using this operator must specify microPercent.
+     */
+    LESS_OR_EQUAL = "LESS_OR_EQUAL",
+    /**
+     * Target percentiles greater than the target percent.
+     * A condition using this operator must specify microPercent.
+     */
+    GREATER_THAN = "GREATER_THAN",
+    /**
+     * Target percentiles within an interval defined by a lower bound and an
+     * upper bound. The lower bound is an exclusive (open) bound and the
+     * micro_percent_range_upper_bound is an inclusive (closed) bound.
+     * A condition using this operator must specify microPercentRange.
+     */
+    BETWEEN = "BETWEEN"
+}
+/**
+ * Represents the limit of percentiles to target in micro-percents.
+ * The value must be in the range [0 and 100000000]
+ */
+export interface MicroPercentRange {
+    /**
+     * The lower limit of percentiles to target in micro-percents.
+     * The value must be in the range [0 and 100000000].
+     */
+    microPercentLowerBound?: number;
+    /**
+     * The upper limit of percentiles to target in micro-percents.
+     * The value must be in the range [0 and 100000000].
+     */
+    microPercentUpperBound?: number;
+}
+/**
+ * Represents a condition that compares the instance pseudo-random
+ * percentile to a given limit.
+ */
+export interface PercentCondition {
+    /**
+     * The choice of percent operator to determine how to compare targets
+     * to percent(s).
+     */
+    percentOperator?: PercentConditionOperator;
+    /**
+     * The limit of percentiles to target in micro-percents when
+     * using the LESS_OR_EQUAL and GREATER_THAN operators. The value must
+     * be in the range [0 and 100000000].
+     */
+    microPercent?: number;
+    /**
+     * The seed used when evaluating the hash function to map an instance to
+     * a value in the hash space. This is a string which can have 0 - 32
+     * characters and can contain ASCII characters [-_.0-9a-zA-Z].The string
+     * is case-sensitive.
+     */
+    seed?: string;
+    /**
+     * The micro-percent interval to be used with the
+     * BETWEEN operator.
+     */
+    microPercentRange?: MicroPercentRange;
+}
 /**
  * Interface representing an explicit parameter value.
  */
@@ -122,7 +255,7 @@ export interface RemoteConfigParameterGroup {
     };
 }
 /**
- * Interface representing a Remote Config template.
+ * Represents a Remote Config client template.
  */
 export interface RemoteConfigTemplate {
     /**
@@ -153,6 +286,92 @@ export interface RemoteConfigTemplate {
      */
     version?: Version;
 }
+/**
+ * Represents the data in a Remote Config server template.
+ */
+export interface ServerTemplateData {
+    /**
+     * A list of conditions in descending order by priority.
+     */
+    conditions: NamedCondition[];
+    /**
+     * Map of parameter keys to their optional default values and optional conditional values.
+     */
+    parameters: {
+        [key: string]: RemoteConfigParameter;
+    };
+    /**
+     * Current Remote Config template ETag (read-only).
+     */
+    readonly etag: string;
+    /**
+     * Version information for the current Remote Config template.
+     */
+    version?: Version;
+}
+/**
+ * Represents optional arguments that can be used when instantiating {@link ServerTemplate}.
+ */
+export interface GetServerTemplateOptions {
+    /**
+     * Defines in-app default parameter values, so that your app behaves as
+     * intended before it connects to the Remote Config backend, and so that
+     * default values are available if none are set on the backend.
+     */
+    defaultConfig?: DefaultConfig;
+}
+/**
+ * Represents the type of a Remote Config server template that can be set on
+ * {@link ServerTemplate}. This can either be a {@link ServerTemplateData} object
+ * or a template JSON string.
+ */
+export type ServerTemplateDataType = ServerTemplateData | string;
+/**
+ * Represents optional arguments that can be used when instantiating
+ * {@link ServerTemplate} synchronously.
+ */
+export interface InitServerTemplateOptions extends GetServerTemplateOptions {
+    /**
+     * Enables integrations to use template data loaded independently. For
+     * example, customers can reduce initialization latency by pre-fetching and
+     * caching template data and then using this option to initialize the SDK with
+     * that data.
+     */
+    template?: ServerTemplateDataType;
+}
+/**
+ * Represents a stateful abstraction for a Remote Config server template.
+ */
+export interface ServerTemplate {
+    /**
+     * Evaluates the current template to produce a {@link ServerConfig}.
+     */
+    evaluate(context?: EvaluationContext): ServerConfig;
+    /**
+     * Fetches and caches the current active version of the
+     * project's {@link ServerTemplate}.
+     */
+    load(): Promise<void>;
+    /**
+     * Sets and caches a {@link ServerTemplateData} or a JSON string representing
+     * the server template
+     */
+    set(template: ServerTemplateDataType): void;
+    /**
+     * Returns a JSON representation of {@link ServerTemplateData}
+     */
+    toJSON(): ServerTemplateData;
+}
+/**
+ * Represents template evaluation input signals.
+ */
+export type EvaluationContext = {
+    /**
+     * Defines the identifier to use when splitting a group. For example,
+     * this is used by the percent condition.
+     */
+    randomizationId?: string;
+};
 /**
  * Interface representing a Remote Config user.
  */
@@ -256,3 +475,92 @@ export interface ListVersionsOptions {
      */
     endTime?: Date | string;
 }
+/**
+ * Represents the configuration produced by evaluating a server template.
+ */
+export interface ServerConfig {
+    /**
+     * Gets the value for the given key as a boolean.
+     *
+     * Convenience method for calling <code>serverConfig.getValue(key).asBoolean()</code>.
+     *
+     * @param key - The name of the parameter.
+     *
+     * @returns The value for the given key as a boolean.
+     */
+    getBoolean(key: string): boolean;
+    /**
+     * Gets the value for the given key as a number.
+     *
+     * Convenience method for calling <code>serverConfig.getValue(key).asNumber()</code>.
+     *
+     * @param key - The name of the parameter.
+     *
+     * @returns The value for the given key as a number.
+     */
+    getNumber(key: string): number;
+    /**
+     * Gets the value for the given key as a string.
+     * Convenience method for calling <code>serverConfig.getValue(key).asString()</code>.
+     *
+     * @param key - The name of the parameter.
+     *
+     * @returns The value for the given key as a string.
+     */
+    getString(key: string): string;
+    /**
+     * Gets the {@link Value} for the given key.
+     *
+     * Ensures application logic will always have a type-safe reference,
+     * even if the parameter is removed remotely.
+     *
+     * @param key - The name of the parameter.
+     *
+     * @returns The value for the given key.
+     */
+    getValue(key: string): Value;
+}
+/**
+ * Wraps a parameter value with metadata and type-safe getters.
+ *
+ * Type-safe getters insulate application logic from remote
+ * changes to parameter names and types.
+ */
+export interface Value {
+    /**
+     * Gets the value as a boolean.
+     *
+     * The following values (case insensitive) are interpreted as true:
+     * "1", "true", "t", "yes", "y", "on". Other values are interpreted as false.
+     */
+    asBoolean(): boolean;
+    /**
+     * Gets the value as a number. Comparable to calling <code>Number(value) || 0</code>.
+     */
+    asNumber(): number;
+    /**
+     * Gets the value as a string.
+     */
+    asString(): string;
+    /**
+     * Gets the {@link ValueSource} for the given key.
+     */
+    getSource(): ValueSource;
+}
+/**
+ * Indicates the source of a value.
+ *
+ * <ul>
+ *   <li>"static" indicates the value was defined by a static constant.</li>
+ *   <li>"default" indicates the value was defined by default config.</li>
+ *   <li>"remote" indicates the value was defined by config produced by
+ *   evaluating a template.</li>
+ * </ul>
+ */
+export type ValueSource = 'static' | 'default' | 'remote';
+/**
+ * Defines the format for in-app default parameter values.
+ */
+export type DefaultConfig = {
+    [key: string]: string | number | boolean;
+};

package/lib/remote-config/remote-config-api.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v12.0.0 */
+/*! firebase-admin v12.1.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.
@@ -16,3 +16,31 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.PercentConditionOperator = void 0;
+/**
+ * Defines supported operators for percent conditions.
+ */
+var PercentConditionOperator;
+(function (PercentConditionOperator) {
+    /**
+     * A catchall error case.
+     */
+    PercentConditionOperator["UNKNOWN"] = "UNKNOWN";
+    /**
+     * Target percentiles less than or equal to the target percent.
+     * A condition using this operator must specify microPercent.
+     */
+    PercentConditionOperator["LESS_OR_EQUAL"] = "LESS_OR_EQUAL";
+    /**
+     * Target percentiles greater than the target percent.
+     * A condition using this operator must specify microPercent.
+     */
+    PercentConditionOperator["GREATER_THAN"] = "GREATER_THAN";
+    /**
+     * Target percentiles within an interval defined by a lower bound and an
+     * upper bound. The lower bound is an exclusive (open) bound and the
+     * micro_percent_range_upper_bound is an inclusive (closed) bound.
+     * A condition using this operator must specify microPercentRange.
+     */
+    PercentConditionOperator["BETWEEN"] = "BETWEEN";
+})(PercentConditionOperator || (exports.PercentConditionOperator = PercentConditionOperator = {}));

package/lib/remote-config/remote-config-namespace.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v12.0.0 */
+/*! firebase-admin v12.1.0 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/remote-config/remote-config-namespace.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v12.0.0 */
+/*! firebase-admin v12.1.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/remote-config/remote-config.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v12.0.0 */
+/*! firebase-admin v12.1.0 */
 /*!
  * Copyright 2020 Google Inc.
  *
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 import { App } from '../app';
-import { ListVersionsOptions, ListVersionsResult, RemoteConfigTemplate } from './remote-config-api';
+import { ListVersionsOptions, ListVersionsResult, ServerTemplate, RemoteConfigTemplate, GetServerTemplateOptions, InitServerTemplateOptions } from './remote-config-api';
 /**
  * The Firebase `RemoteConfig` service interface.
  */
@@ -91,4 +91,13 @@ export declare class RemoteConfig {
      * @returns A new template instance.
      */
     createTemplateFromJSON(json: string): RemoteConfigTemplate;
+    /**
+     * Instantiates {@link ServerTemplate} and then fetches and caches the latest
+     * template version of the project.
+     */
+    getServerTemplate(options?: GetServerTemplateOptions): Promise<ServerTemplate>;
+    /**
+     * Synchronously instantiates {@link ServerTemplate}.
+     */
+    initServerTemplate(options?: InitServerTemplateOptions): ServerTemplate;
 }

package/lib/remote-config/remote-config.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v12.0.0 */
+/*! firebase-admin v12.1.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.
@@ -19,6 +19,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RemoteConfig = void 0;
 const validator = require("../utils/validator");
 const remote_config_api_client_internal_1 = require("./remote-config-api-client-internal");
+const condition_evaluator_internal_1 = require("./condition-evaluator-internal");
+const value_impl_1 = require("./internal/value-impl");
 /**
  * The Firebase `RemoteConfig` service interface.
  */
@@ -144,6 +146,25 @@ class RemoteConfig {
         }
         return new RemoteConfigTemplateImpl(template);
     }
+    /**
+     * Instantiates {@link ServerTemplate} and then fetches and caches the latest
+     * template version of the project.
+     */
+    async getServerTemplate(options) {
+        const template = this.initServerTemplate(options);
+        await template.load();
+        return template;
+    }
+    /**
+     * Synchronously instantiates {@link ServerTemplate}.
+     */
+    initServerTemplate(options) {
+        const template = new ServerTemplateImpl(this.client, new condition_evaluator_internal_1.ConditionEvaluator(), options?.defaultConfig);
+        if (options?.template) {
+            template.set(options?.template);
+        }
+        return template;
+    }
 }
 exports.RemoteConfig = RemoteConfig;
 /**
@@ -210,6 +231,160 @@ class RemoteConfigTemplateImpl {
         };
     }
 }
+/**
+ * Remote Config dataplane template data implementation.
+ */
+class ServerTemplateImpl {
+    constructor(apiClient, conditionEvaluator, defaultConfig = {}) {
+        this.apiClient = apiClient;
+        this.conditionEvaluator = conditionEvaluator;
+        this.defaultConfig = defaultConfig;
+        this.stringifiedDefaultConfig = {};
+        // RC stores all remote values as string, but it's more intuitive
+        // to declare default values with specific types, so this converts
+        // the external declaration to an internal string representation.
+        for (const key in defaultConfig) {
+            this.stringifiedDefaultConfig[key] = String(defaultConfig[key]);
+        }
+    }
+    /**
+     * Fetches and caches the current active version of the project's {@link ServerTemplate}.
+     */
+    load() {
+        return this.apiClient.getServerTemplate()
+            .then((template) => {
+            this.cache = new ServerTemplateDataImpl(template);
+        });
+    }
+    /**
+     * Parses a {@link ServerTemplateDataType} and caches it.
+     */
+    set(template) {
+        let parsed;
+        if (validator.isString(template)) {
+            try {
+                parsed = JSON.parse(template);
+            }
+            catch (e) {
+                // Transforms JSON parse errors to Firebase error.
+                throw new remote_config_api_client_internal_1.FirebaseRemoteConfigError('invalid-argument', `Failed to parse the JSON string: ${template}. ` + e);
+            }
+        }
+        else {
+            parsed = template;
+        }
+        // Throws template parse errors.
+        this.cache = new ServerTemplateDataImpl(parsed);
+    }
+    /**
+     * Evaluates the current template in cache to produce a {@link ServerConfig}.
+     */
+    evaluate(context = {}) {
+        if (!this.cache) {
+            // This is the only place we should throw during evaluation, since it's under the
+            // control of application logic. To preserve forward-compatibility, we should only
+            // return false in cases where the SDK is unsure how to evaluate the fetched template.
+            throw new remote_config_api_client_internal_1.FirebaseRemoteConfigError('failed-precondition', 'No Remote Config Server template in cache. Call load() before calling evaluate().');
+        }
+        const evaluatedConditions = this.conditionEvaluator.evaluateConditions(this.cache.conditions, context);
+        const configValues = {};
+        // Initializes config Value objects with default values.
+        for (const key in this.stringifiedDefaultConfig) {
+            configValues[key] = new value_impl_1.ValueImpl('default', this.stringifiedDefaultConfig[key]);
+        }
+        // Overlays config Value objects derived by evaluating the template.
+        for (const [key, parameter] of Object.entries(this.cache.parameters)) {
+            const { conditionalValues, defaultValue } = parameter;
+            // Supports parameters with no conditional values.
+            const normalizedConditionalValues = conditionalValues || {};
+            let parameterValueWrapper = undefined;
+            // Iterates in order over condition list. If there is a value associated
+            // with a condition, this checks if the condition is true.
+            for (const [conditionName, conditionEvaluation] of evaluatedConditions) {
+                if (normalizedConditionalValues[conditionName] && conditionEvaluation) {
+                    parameterValueWrapper = normalizedConditionalValues[conditionName];
+                    break;
+                }
+            }
+            if (parameterValueWrapper && parameterValueWrapper.useInAppDefault) {
+                // TODO: add logging once we have a wrapped logger.
+                continue;
+            }
+            if (parameterValueWrapper) {
+                const parameterValue = parameterValueWrapper.value;
+                configValues[key] = new value_impl_1.ValueImpl('remote', parameterValue);
+                continue;
+            }
+            if (!defaultValue) {
+                // TODO: add logging once we have a wrapped logger.
+                continue;
+            }
+            if (defaultValue.useInAppDefault) {
+                // TODO: add logging once we have a wrapped logger.
+                continue;
+            }
+            const parameterDefaultValue = defaultValue.value;
+            configValues[key] = new value_impl_1.ValueImpl('remote', parameterDefaultValue);
+        }
+        return new ServerConfigImpl(configValues);
+    }
+    /**
+     * @returns JSON representation of the server template
+     */
+    toJSON() {
+        return this.cache;
+    }
+}
+class ServerConfigImpl {
+    constructor(configValues) {
+        this.configValues = configValues;
+    }
+    getBoolean(key) {
+        return this.getValue(key).asBoolean();
+    }
+    getNumber(key) {
+        return this.getValue(key).asNumber();
+    }
+    getString(key) {
+        return this.getValue(key).asString();
+    }
+    getValue(key) {
+        return this.configValues[key] || new value_impl_1.ValueImpl('static');
+    }
+}
+/**
+ * Remote Config dataplane template data implementation.
+ */
+class ServerTemplateDataImpl {
+    constructor(template) {
+        if (!validator.isNonNullObject(template) ||
+            !validator.isNonEmptyString(template.etag)) {
+            throw new remote_config_api_client_internal_1.FirebaseRemoteConfigError('invalid-argument', `Invalid Remote Config template: ${JSON.stringify(template)}`);
+        }
+        this.etag = template.etag;
+        if (typeof template.parameters !== 'undefined') {
+            if (!validator.isNonNullObject(template.parameters)) {
+                throw new remote_config_api_client_internal_1.FirebaseRemoteConfigError('invalid-argument', 'Remote Config parameters must be a non-null object');
+            }
+            this.parameters = template.parameters;
+        }
+        else {
+            this.parameters = {};
+        }
+        if (typeof template.conditions !== 'undefined') {
+            if (!validator.isArray(template.conditions)) {
+                throw new remote_config_api_client_internal_1.FirebaseRemoteConfigError('invalid-argument', 'Remote Config conditions must be an array');
+            }
+            this.conditions = template.conditions;
+        }
+        else {
+            this.conditions = [];
+        }
+        if (typeof template.version !== 'undefined') {
+            this.version = new VersionImpl(template.version);
+        }
+    }
+}
 /**
 * Remote Config Version internal implementation.
 */

package/lib/security-rules/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v12.0.0 */
+/*! firebase-admin v12.1.0 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/security-rules/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v12.0.0 */
+/*! firebase-admin v12.1.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

package/lib/security-rules/security-rules-api-client-internal.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v12.0.0 */
+/*! firebase-admin v12.1.0 */
 /*!
  * Copyright 2019 Google Inc.
  *

package/lib/security-rules/security-rules-api-client-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v12.0.0 */
+/*! firebase-admin v12.1.0 */
 "use strict";
 /*!
  * Copyright 2019 Google Inc.

package/lib/security-rules/security-rules-internal.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v12.0.0 */
+/*! firebase-admin v12.1.0 */
 /*!
  * Copyright 2019 Google Inc.
  *

package/lib/security-rules/security-rules-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v12.0.0 */
+/*! firebase-admin v12.1.0 */
 "use strict";
 /*!
  * Copyright 2019 Google Inc.

package/lib/security-rules/security-rules-namespace.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v12.0.0 */
+/*! firebase-admin v12.1.0 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/security-rules/security-rules-namespace.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v12.0.0 */
+/*! firebase-admin v12.1.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/security-rules/security-rules.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v12.0.0 */
+/*! firebase-admin v12.1.0 */
 /*!
  * Copyright 2019 Google Inc.
  *

package/lib/security-rules/security-rules.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v12.0.0 */
+/*! firebase-admin v12.1.0 */
 "use strict";
 /*!
  * Copyright 2019 Google Inc.