@firebase/remote-config 0.4.10 → 0.4.11

package/dist/esm/src/api.d.ts

@@ -1,115 +1,115 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { FirebaseApp } from '@firebase/app';
-import { LogLevel as RemoteConfigLogLevel, RemoteConfig, Value } from './public_types';
-/**
- *
- * @param app - The {@link @firebase/app#FirebaseApp} instance.
- * @returns A {@link RemoteConfig} instance.
- *
- * @public
- */
-export declare function getRemoteConfig(app?: FirebaseApp): RemoteConfig;
-/**
- * Makes the last fetched config available to the getters.
- * @param remoteConfig - The {@link RemoteConfig} instance.
- * @returns A `Promise` which resolves to true if the current call activated the fetched configs.
- * If the fetched configs were already activated, the `Promise` will resolve to false.
- *
- * @public
- */
-export declare function activate(remoteConfig: RemoteConfig): Promise<boolean>;
-/**
- * Ensures the last activated config are available to the getters.
- * @param remoteConfig - The {@link RemoteConfig} instance.
- *
- * @returns A `Promise` that resolves when the last activated config is available to the getters.
- * @public
- */
-export declare function ensureInitialized(remoteConfig: RemoteConfig): Promise<void>;
-/**
- * Fetches and caches configuration from the Remote Config service.
- * @param remoteConfig - The {@link RemoteConfig} instance.
- * @public
- */
-export declare function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;
-/**
- * Gets all config.
- *
- * @param remoteConfig - The {@link RemoteConfig} instance.
- * @returns All config.
- *
- * @public
- */
-export declare function getAll(remoteConfig: RemoteConfig): Record<string, Value>;
-/**
- * Gets the value for the given key as a boolean.
- *
- * Convenience method for calling <code>remoteConfig.getValue(key).asBoolean()</code>.
- *
- * @param remoteConfig - The {@link RemoteConfig} instance.
- * @param key - The name of the parameter.
- *
- * @returns The value for the given key as a boolean.
- * @public
- */
-export declare function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;
-/**
- * Gets the value for the given key as a number.
- *
- * Convenience method for calling <code>remoteConfig.getValue(key).asNumber()</code>.
- *
- * @param remoteConfig - The {@link RemoteConfig} instance.
- * @param key - The name of the parameter.
- *
- * @returns The value for the given key as a number.
- *
- * @public
- */
-export declare function getNumber(remoteConfig: RemoteConfig, key: string): number;
-/**
- * Gets the value for the given key as a string.
- * Convenience method for calling <code>remoteConfig.getValue(key).asString()</code>.
- *
- * @param remoteConfig - The {@link RemoteConfig} instance.
- * @param key - The name of the parameter.
- *
- * @returns The value for the given key as a string.
- *
- * @public
- */
-export declare function getString(remoteConfig: RemoteConfig, key: string): string;
-/**
- * Gets the {@link Value} for the given key.
- *
- * @param remoteConfig - The {@link RemoteConfig} instance.
- * @param key - The name of the parameter.
- *
- * @returns The value for the given key.
- *
- * @public
- */
-export declare function getValue(remoteConfig: RemoteConfig, key: string): Value;
-/**
- * Defines the log level to use.
- *
- * @param remoteConfig - The {@link RemoteConfig} instance.
- * @param logLevel - The log level to set.
- *
- * @public
- */
-export declare function setLogLevel(remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel): void;
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { FirebaseApp } from '@firebase/app';
+import { LogLevel as RemoteConfigLogLevel, RemoteConfig, Value } from './public_types';
+/**
+ *
+ * @param app - The {@link @firebase/app#FirebaseApp} instance.
+ * @returns A {@link RemoteConfig} instance.
+ *
+ * @public
+ */
+export declare function getRemoteConfig(app?: FirebaseApp): RemoteConfig;
+/**
+ * Makes the last fetched config available to the getters.
+ * @param remoteConfig - The {@link RemoteConfig} instance.
+ * @returns A `Promise` which resolves to true if the current call activated the fetched configs.
+ * If the fetched configs were already activated, the `Promise` will resolve to false.
+ *
+ * @public
+ */
+export declare function activate(remoteConfig: RemoteConfig): Promise<boolean>;
+/**
+ * Ensures the last activated config are available to the getters.
+ * @param remoteConfig - The {@link RemoteConfig} instance.
+ *
+ * @returns A `Promise` that resolves when the last activated config is available to the getters.
+ * @public
+ */
+export declare function ensureInitialized(remoteConfig: RemoteConfig): Promise<void>;
+/**
+ * Fetches and caches configuration from the Remote Config service.
+ * @param remoteConfig - The {@link RemoteConfig} instance.
+ * @public
+ */
+export declare function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;
+/**
+ * Gets all config.
+ *
+ * @param remoteConfig - The {@link RemoteConfig} instance.
+ * @returns All config.
+ *
+ * @public
+ */
+export declare function getAll(remoteConfig: RemoteConfig): Record<string, Value>;
+/**
+ * Gets the value for the given key as a boolean.
+ *
+ * Convenience method for calling <code>remoteConfig.getValue(key).asBoolean()</code>.
+ *
+ * @param remoteConfig - The {@link RemoteConfig} instance.
+ * @param key - The name of the parameter.
+ *
+ * @returns The value for the given key as a boolean.
+ * @public
+ */
+export declare function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;
+/**
+ * Gets the value for the given key as a number.
+ *
+ * Convenience method for calling <code>remoteConfig.getValue(key).asNumber()</code>.
+ *
+ * @param remoteConfig - The {@link RemoteConfig} instance.
+ * @param key - The name of the parameter.
+ *
+ * @returns The value for the given key as a number.
+ *
+ * @public
+ */
+export declare function getNumber(remoteConfig: RemoteConfig, key: string): number;
+/**
+ * Gets the value for the given key as a string.
+ * Convenience method for calling <code>remoteConfig.getValue(key).asString()</code>.
+ *
+ * @param remoteConfig - The {@link RemoteConfig} instance.
+ * @param key - The name of the parameter.
+ *
+ * @returns The value for the given key as a string.
+ *
+ * @public
+ */
+export declare function getString(remoteConfig: RemoteConfig, key: string): string;
+/**
+ * Gets the {@link Value} for the given key.
+ *
+ * @param remoteConfig - The {@link RemoteConfig} instance.
+ * @param key - The name of the parameter.
+ *
+ * @returns The value for the given key.
+ *
+ * @public
+ */
+export declare function getValue(remoteConfig: RemoteConfig, key: string): Value;
+/**
+ * Defines the log level to use.
+ *
+ * @param remoteConfig - The {@link RemoteConfig} instance.
+ * @param logLevel - The log level to set.
+ *
+ * @public
+ */
+export declare function setLogLevel(remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel): void;

package/dist/esm/src/api2.d.ts

@@ -1,40 +1,40 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { RemoteConfig } from './public_types';
-/**
- *
- * Performs fetch and activate operations, as a convenience.
- *
- * @param remoteConfig - The {@link RemoteConfig} instance.
- *
- * @returns A `Promise` which resolves to true if the current call activated the fetched configs.
- * If the fetched configs were already activated, the `Promise` will resolve to false.
- *
- * @public
- */
-export declare function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean>;
-/**
- * This method provides two different checks:
- *
- * 1. Check if IndexedDB exists in the browser environment.
- * 2. Check if the current browser context allows IndexedDB `open()` calls.
- *
- * @returns A `Promise` which resolves to true if a {@link RemoteConfig} instance
- * can be initialized in this environment, or false if it cannot.
- * @public
- */
-export declare function isSupported(): Promise<boolean>;
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { RemoteConfig } from './public_types';
+/**
+ *
+ * Performs fetch and activate operations, as a convenience.
+ *
+ * @param remoteConfig - The {@link RemoteConfig} instance.
+ *
+ * @returns A `Promise` which resolves to true if the current call activated the fetched configs.
+ * If the fetched configs were already activated, the `Promise` will resolve to false.
+ *
+ * @public
+ */
+export declare function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean>;
+/**
+ * This method provides two different checks:
+ *
+ * 1. Check if IndexedDB exists in the browser environment.
+ * 2. Check if the current browser context allows IndexedDB `open()` calls.
+ *
+ * @returns A `Promise` which resolves to true if a {@link RemoteConfig} instance
+ * can be initialized in this environment, or false if it cannot.
+ * @public
+ */
+export declare function isSupported(): Promise<boolean>;

package/dist/esm/src/client/caching_client.d.ts

@@ -1,45 +1,45 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { StorageCache } from '../storage/storage_cache';
-import { FetchResponse, RemoteConfigFetchClient, FetchRequest } from './remote_config_fetch_client';
-import { Storage } from '../storage/storage';
-import { Logger } from '@firebase/logger';
-/**
- * Implements the {@link RemoteConfigClient} abstraction with success response caching.
- *
- * <p>Comparable to the browser's Cache API for responses, but the Cache API requires a Service
- * Worker, which requires HTTPS, which would significantly complicate SDK installation. Also, the
- * Cache API doesn't support matching entries by time.
- */
-export declare class CachingClient implements RemoteConfigFetchClient {
-    private readonly client;
-    private readonly storage;
-    private readonly storageCache;
-    private readonly logger;
-    constructor(client: RemoteConfigFetchClient, storage: Storage, storageCache: StorageCache, logger: Logger);
-    /**
-     * Returns true if the age of the cached fetched configs is less than or equal to
-     * {@link Settings#minimumFetchIntervalInSeconds}.
-     *
-     * <p>This is comparable to passing `headers = { 'Cache-Control': max-age <maxAge> }` to the
-     * native Fetch API.
-     *
-     * <p>Visible for testing.
-     */
-    isCachedDataFresh(cacheMaxAgeMillis: number, lastSuccessfulFetchTimestampMillis: number | undefined): boolean;
-    fetch(request: FetchRequest): Promise<FetchResponse>;
-}
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { StorageCache } from '../storage/storage_cache';
+import { FetchResponse, RemoteConfigFetchClient, FetchRequest } from './remote_config_fetch_client';
+import { Storage } from '../storage/storage';
+import { Logger } from '@firebase/logger';
+/**
+ * Implements the {@link RemoteConfigClient} abstraction with success response caching.
+ *
+ * <p>Comparable to the browser's Cache API for responses, but the Cache API requires a Service
+ * Worker, which requires HTTPS, which would significantly complicate SDK installation. Also, the
+ * Cache API doesn't support matching entries by time.
+ */
+export declare class CachingClient implements RemoteConfigFetchClient {
+    private readonly client;
+    private readonly storage;
+    private readonly storageCache;
+    private readonly logger;
+    constructor(client: RemoteConfigFetchClient, storage: Storage, storageCache: StorageCache, logger: Logger);
+    /**
+     * Returns true if the age of the cached fetched configs is less than or equal to
+     * {@link Settings#minimumFetchIntervalInSeconds}.
+     *
+     * <p>This is comparable to passing `headers = { 'Cache-Control': max-age <maxAge> }` to the
+     * native Fetch API.
+     *
+     * <p>Visible for testing.
+     */
+    isCachedDataFresh(cacheMaxAgeMillis: number, lastSuccessfulFetchTimestampMillis: number | undefined): boolean;
+    fetch(request: FetchRequest): Promise<FetchResponse>;
+}

package/dist/esm/src/client/remote_config_fetch_client.d.ts

@@ -1,123 +1,123 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/**
- * Defines a client, as in https://en.wikipedia.org/wiki/Client%E2%80%93server_model, for the
- * Remote Config server (https://firebase.google.com/docs/reference/remote-config/rest).
- *
- * <p>Abstracts throttle, response cache and network implementation details.
- *
- * <p>Modeled after the native {@link GlobalFetch} interface, which is relatively modern and
- * convenient, but simplified for Remote Config's use case.
- *
- * Disambiguation: {@link GlobalFetch} interface and the Remote Config service define "fetch"
- * methods. The RestClient uses the former to make HTTP calls. This interface abstracts the latter.
- */
-export interface RemoteConfigFetchClient {
-    /**
-     * @throws if response status is not 200 or 304.
-     */
-    fetch(request: FetchRequest): Promise<FetchResponse>;
-}
-/**
- * Defines a self-descriptive reference for config key-value pairs.
- */
-export interface FirebaseRemoteConfigObject {
-    [key: string]: string;
-}
-/**
- * Shims a minimal AbortSignal.
- *
- * <p>AbortController's AbortSignal conveniently decouples fetch timeout logic from other aspects
- * of networking, such as retries. Firebase doesn't use AbortController enough to justify a
- * polyfill recommendation, like we do with the Fetch API, but this minimal shim can easily be
- * swapped out if/when we do.
- */
-export declare class RemoteConfigAbortSignal {
-    listeners: Array<() => void>;
-    addEventListener(listener: () => void): void;
-    abort(): void;
-}
-/**
- * Defines per-request inputs for the Remote Config fetch request.
- *
- * <p>Modeled after the native {@link Request} interface, but simplified for Remote Config's
- * use case.
- */
-export interface FetchRequest {
-    /**
-     * Uses cached config if it is younger than this age.
-     *
-     * <p>Required because it's defined by settings, which always have a value.
-     *
-     * <p>Comparable to passing `headers = { 'Cache-Control': max-age <maxAge> }` to the native
-     * Fetch API.
-     */
-    cacheMaxAgeMillis: number;
-    /**
-     * An event bus for the signal to abort a request.
-     *
-     * <p>Required because all requests should be abortable.
-     *
-     * <p>Comparable to the native
-     * Fetch API's "signal" field on its request configuration object
-     * https://fetch.spec.whatwg.org/#dom-requestinit-signal.
-     *
-     * <p>Disambiguation: Remote Config commonly refers to API inputs as
-     * "signals". See the private ConfigFetchRequestBody interface for those:
-     * http://google3/firebase/remote_config/web/src/core/rest_client.ts?l=14&rcl=255515243.
-     */
-    signal: RemoteConfigAbortSignal;
-    /**
-     * The ETag header value from the last response.
-     *
-     * <p>Optional in case this is the first request.
-     *
-     * <p>Comparable to passing `headers = { 'If-None-Match': <eTag> }` to the native Fetch API.
-     */
-    eTag?: string;
-}
-/**
- * Defines a successful response (200 or 304).
- *
- * <p>Modeled after the native {@link Response} interface, but simplified for Remote Config's
- * use case.
- */
-export interface FetchResponse {
-    /**
-     * The HTTP status, which is useful for differentiating success responses with data from
-     * those without.
-     *
-     * <p>{@link RemoteConfigClient} is modeled after the native {@link GlobalFetch} 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.
-     */
-    status: number;
-    /**
-     * Defines the ETag response header value.
-     *
-     * <p>Only defined for 200 and 304 responses.
-     */
-    eTag?: string;
-    /**
-     * Defines the map of parameters returned as "entries" in the fetch response body.
-     *
-     * <p>Only defined for 200 responses.
-     */
-    config?: FirebaseRemoteConfigObject;
-}
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Defines a client, as in https://en.wikipedia.org/wiki/Client%E2%80%93server_model, for the
+ * Remote Config server (https://firebase.google.com/docs/reference/remote-config/rest).
+ *
+ * <p>Abstracts throttle, response cache and network implementation details.
+ *
+ * <p>Modeled after the native {@link GlobalFetch} interface, which is relatively modern and
+ * convenient, but simplified for Remote Config's use case.
+ *
+ * Disambiguation: {@link GlobalFetch} interface and the Remote Config service define "fetch"
+ * methods. The RestClient uses the former to make HTTP calls. This interface abstracts the latter.
+ */
+export interface RemoteConfigFetchClient {
+    /**
+     * @throws if response status is not 200 or 304.
+     */
+    fetch(request: FetchRequest): Promise<FetchResponse>;
+}
+/**
+ * Defines a self-descriptive reference for config key-value pairs.
+ */
+export interface FirebaseRemoteConfigObject {
+    [key: string]: string;
+}
+/**
+ * Shims a minimal AbortSignal.
+ *
+ * <p>AbortController's AbortSignal conveniently decouples fetch timeout logic from other aspects
+ * of networking, such as retries. Firebase doesn't use AbortController enough to justify a
+ * polyfill recommendation, like we do with the Fetch API, but this minimal shim can easily be
+ * swapped out if/when we do.
+ */
+export declare class RemoteConfigAbortSignal {
+    listeners: Array<() => void>;
+    addEventListener(listener: () => void): void;
+    abort(): void;
+}
+/**
+ * Defines per-request inputs for the Remote Config fetch request.
+ *
+ * <p>Modeled after the native {@link Request} interface, but simplified for Remote Config's
+ * use case.
+ */
+export interface FetchRequest {
+    /**
+     * Uses cached config if it is younger than this age.
+     *
+     * <p>Required because it's defined by settings, which always have a value.
+     *
+     * <p>Comparable to passing `headers = { 'Cache-Control': max-age <maxAge> }` to the native
+     * Fetch API.
+     */
+    cacheMaxAgeMillis: number;
+    /**
+     * An event bus for the signal to abort a request.
+     *
+     * <p>Required because all requests should be abortable.
+     *
+     * <p>Comparable to the native
+     * Fetch API's "signal" field on its request configuration object
+     * https://fetch.spec.whatwg.org/#dom-requestinit-signal.
+     *
+     * <p>Disambiguation: Remote Config commonly refers to API inputs as
+     * "signals". See the private ConfigFetchRequestBody interface for those:
+     * http://google3/firebase/remote_config/web/src/core/rest_client.ts?l=14&rcl=255515243.
+     */
+    signal: RemoteConfigAbortSignal;
+    /**
+     * The ETag header value from the last response.
+     *
+     * <p>Optional in case this is the first request.
+     *
+     * <p>Comparable to passing `headers = { 'If-None-Match': <eTag> }` to the native Fetch API.
+     */
+    eTag?: string;
+}
+/**
+ * Defines a successful response (200 or 304).
+ *
+ * <p>Modeled after the native {@link Response} interface, but simplified for Remote Config's
+ * use case.
+ */
+export interface FetchResponse {
+    /**
+     * The HTTP status, which is useful for differentiating success responses with data from
+     * those without.
+     *
+     * <p>{@link RemoteConfigClient} is modeled after the native {@link GlobalFetch} 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.
+     */
+    status: number;
+    /**
+     * Defines the ETag response header value.
+     *
+     * <p>Only defined for 200 and 304 responses.
+     */
+    eTag?: string;
+    /**
+     * Defines the map of parameters returned as "entries" in the fetch response body.
+     *
+     * <p>Only defined for 200 responses.
+     */
+    config?: FirebaseRemoteConfigObject;
+}