@firebase/remote-config 0.4.10 → 0.4.11

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

@@ -1,128 +1,128 @@
-/**
- * @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';
-/**
- * The Firebase Remote Config service interface.
- *
- * @public
- */
-export interface RemoteConfig {
-    /**
-     * The {@link @firebase/app#FirebaseApp} this `RemoteConfig` instance is associated with.
-     */
-    app: FirebaseApp;
-    /**
-     * Defines configuration for the Remote Config SDK.
-     */
-    settings: RemoteConfigSettings;
-    /**
-     * Object containing default values for configs.
-     */
-    defaultConfig: {
-        [key: string]: string | number | boolean;
-    };
-    /**
-     * The Unix timestamp in milliseconds of the last <i>successful</i> fetch, or negative one if
-     * the {@link RemoteConfig} instance either hasn't fetched or initialization
-     * is incomplete.
-     */
-    fetchTimeMillis: number;
-    /**
-     * The status of the last fetch <i>attempt</i>.
-     */
-    lastFetchStatus: FetchStatus;
-}
-/**
- * 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 fetched config.</li>
- * </ul>
- *
- * @public
- */
-export declare type ValueSource = 'static' | 'default' | 'remote';
-/**
- * Wraps a value with metadata and type-safe getters.
- *
- * @public
- */
-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;
-}
-/**
- * Defines configuration options for the Remote Config SDK.
- *
- * @public
- */
-export interface RemoteConfigSettings {
-    /**
-     * Defines the maximum age in milliseconds of an entry in the config cache before
-     * it is considered stale. Defaults to 43200000 (Twelve hours).
-     */
-    minimumFetchIntervalMillis: number;
-    /**
-     * Defines the maximum amount of milliseconds to wait for a response when fetching
-     * configuration from the Remote Config server. Defaults to 60000 (One minute).
-     */
-    fetchTimeoutMillis: number;
-}
-/**
- * Summarizes the outcome of the last attempt to fetch config from the Firebase Remote Config server.
- *
- * <ul>
- *   <li>"no-fetch-yet" indicates the {@link RemoteConfig} instance has not yet attempted
- *       to fetch config, or that SDK initialization is incomplete.</li>
- *   <li>"success" indicates the last attempt succeeded.</li>
- *   <li>"failure" indicates the last attempt failed.</li>
- *   <li>"throttle" indicates the last attempt was rate-limited.</li>
- * </ul>
- *
- * @public
- */
-export declare type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';
-/**
- * Defines levels of Remote Config logging.
- *
- * @public
- */
-export declare type LogLevel = 'debug' | 'error' | 'silent';
-declare module '@firebase/component' {
-    interface NameServiceMapping {
-        'remote-config': RemoteConfig;
-    }
-}
+/**
+ * @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';
+/**
+ * The Firebase Remote Config service interface.
+ *
+ * @public
+ */
+export interface RemoteConfig {
+    /**
+     * The {@link @firebase/app#FirebaseApp} this `RemoteConfig` instance is associated with.
+     */
+    app: FirebaseApp;
+    /**
+     * Defines configuration for the Remote Config SDK.
+     */
+    settings: RemoteConfigSettings;
+    /**
+     * Object containing default values for configs.
+     */
+    defaultConfig: {
+        [key: string]: string | number | boolean;
+    };
+    /**
+     * The Unix timestamp in milliseconds of the last <i>successful</i> fetch, or negative one if
+     * the {@link RemoteConfig} instance either hasn't fetched or initialization
+     * is incomplete.
+     */
+    fetchTimeMillis: number;
+    /**
+     * The status of the last fetch <i>attempt</i>.
+     */
+    lastFetchStatus: FetchStatus;
+}
+/**
+ * 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 fetched config.</li>
+ * </ul>
+ *
+ * @public
+ */
+export type ValueSource = 'static' | 'default' | 'remote';
+/**
+ * Wraps a value with metadata and type-safe getters.
+ *
+ * @public
+ */
+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;
+}
+/**
+ * Defines configuration options for the Remote Config SDK.
+ *
+ * @public
+ */
+export interface RemoteConfigSettings {
+    /**
+     * Defines the maximum age in milliseconds of an entry in the config cache before
+     * it is considered stale. Defaults to 43200000 (Twelve hours).
+     */
+    minimumFetchIntervalMillis: number;
+    /**
+     * Defines the maximum amount of milliseconds to wait for a response when fetching
+     * configuration from the Remote Config server. Defaults to 60000 (One minute).
+     */
+    fetchTimeoutMillis: number;
+}
+/**
+ * Summarizes the outcome of the last attempt to fetch config from the Firebase Remote Config server.
+ *
+ * <ul>
+ *   <li>"no-fetch-yet" indicates the {@link RemoteConfig} instance has not yet attempted
+ *       to fetch config, or that SDK initialization is incomplete.</li>
+ *   <li>"success" indicates the last attempt succeeded.</li>
+ *   <li>"failure" indicates the last attempt failed.</li>
+ *   <li>"throttle" indicates the last attempt was rate-limited.</li>
+ * </ul>
+ *
+ * @public
+ */
+export type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';
+/**
+ * Defines levels of Remote Config logging.
+ *
+ * @public
+ */
+export type LogLevel = 'debug' | 'error' | 'silent';
+declare module '@firebase/component' {
+    interface NameServiceMapping {
+        'remote-config': RemoteConfig;
+    }
+}

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

@@ -1,2 +1,2 @@
-import '@firebase/installations';
-export declare function registerRemoteConfig(): void;
+import '@firebase/installations';
+export declare function registerRemoteConfig(): void;

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

@@ -1,79 +1,79 @@
-/**
- * @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 { FirebaseApp } from '@firebase/app';
-import { RemoteConfig as RemoteConfigType, FetchStatus, RemoteConfigSettings } from './public_types';
-import { StorageCache } from './storage/storage_cache';
-import { RemoteConfigFetchClient } from './client/remote_config_fetch_client';
-import { Storage } from './storage/storage';
-import { Logger } from '@firebase/logger';
-/**
- * Encapsulates business logic mapping network and storage dependencies to the public SDK API.
- *
- * See {@link https://github.com/firebase/firebase-js-sdk/blob/main/packages/firebase/index.d.ts|interface documentation} for method descriptions.
- */
-export declare class RemoteConfig implements RemoteConfigType {
-    readonly app: FirebaseApp;
-    /**
-     * @internal
-     */
-    readonly _client: RemoteConfigFetchClient;
-    /**
-     * @internal
-     */
-    readonly _storageCache: StorageCache;
-    /**
-     * @internal
-     */
-    readonly _storage: Storage;
-    /**
-     * @internal
-     */
-    readonly _logger: Logger;
-    /**
-     * Tracks completion of initialization promise.
-     * @internal
-     */
-    _isInitializationComplete: boolean;
-    /**
-     * De-duplicates initialization calls.
-     * @internal
-     */
-    _initializePromise?: Promise<void>;
-    settings: RemoteConfigSettings;
-    defaultConfig: {
-        [key: string]: string | number | boolean;
-    };
-    get fetchTimeMillis(): number;
-    get lastFetchStatus(): FetchStatus;
-    constructor(app: FirebaseApp, 
-    /**
-     * @internal
-     */
-    _client: RemoteConfigFetchClient, 
-    /**
-     * @internal
-     */
-    _storageCache: StorageCache, 
-    /**
-     * @internal
-     */
-    _storage: Storage, 
-    /**
-     * @internal
-     */
-    _logger: Logger);
-}
+/**
+ * @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 { FirebaseApp } from '@firebase/app';
+import { RemoteConfig as RemoteConfigType, FetchStatus, RemoteConfigSettings } from './public_types';
+import { StorageCache } from './storage/storage_cache';
+import { RemoteConfigFetchClient } from './client/remote_config_fetch_client';
+import { Storage } from './storage/storage';
+import { Logger } from '@firebase/logger';
+/**
+ * Encapsulates business logic mapping network and storage dependencies to the public SDK API.
+ *
+ * See {@link https://github.com/firebase/firebase-js-sdk/blob/main/packages/firebase/index.d.ts|interface documentation} for method descriptions.
+ */
+export declare class RemoteConfig implements RemoteConfigType {
+    readonly app: FirebaseApp;
+    /**
+     * @internal
+     */
+    readonly _client: RemoteConfigFetchClient;
+    /**
+     * @internal
+     */
+    readonly _storageCache: StorageCache;
+    /**
+     * @internal
+     */
+    readonly _storage: Storage;
+    /**
+     * @internal
+     */
+    readonly _logger: Logger;
+    /**
+     * Tracks completion of initialization promise.
+     * @internal
+     */
+    _isInitializationComplete: boolean;
+    /**
+     * De-duplicates initialization calls.
+     * @internal
+     */
+    _initializePromise?: Promise<void>;
+    settings: RemoteConfigSettings;
+    defaultConfig: {
+        [key: string]: string | number | boolean;
+    };
+    get fetchTimeMillis(): number;
+    get lastFetchStatus(): FetchStatus;
+    constructor(app: FirebaseApp, 
+    /**
+     * @internal
+     */
+    _client: RemoteConfigFetchClient, 
+    /**
+     * @internal
+     */
+    _storageCache: StorageCache, 
+    /**
+     * @internal
+     */
+    _storage: Storage, 
+    /**
+     * @internal
+     */
+    _logger: Logger);
+}

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

@@ -1,76 +1,76 @@
-/**
- * @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 { FetchStatus } from '@firebase/remote-config-types';
-import { FetchResponse, FirebaseRemoteConfigObject } from '../client/remote_config_fetch_client';
-/**
- * A general-purpose store keyed by app + namespace + {@link
- * ProjectNamespaceKeyFieldValue}.
- *
- * <p>The Remote Config SDK can be used with multiple app installations, and each app can interact
- * with multiple namespaces, so this store uses app (ID + name) and namespace as common parent keys
- * for a set of key-value pairs. See {@link Storage#createCompositeKey}.
- *
- * <p>Visible for testing.
- */
-export declare const APP_NAMESPACE_STORE = "app_namespace_store";
-/**
- * Encapsulates metadata concerning throttled fetch requests.
- */
-export interface ThrottleMetadata {
-    backoffCount: number;
-    throttleEndTimeMillis: number;
-}
-/**
- * Provides type-safety for the "key" field used by {@link APP_NAMESPACE_STORE}.
- *
- * <p>This seems like a small price to avoid potentially subtle bugs caused by a typo.
- */
-declare type ProjectNamespaceKeyFieldValue = 'active_config' | 'active_config_etag' | 'last_fetch_status' | 'last_successful_fetch_timestamp_millis' | 'last_successful_fetch_response' | 'settings' | 'throttle_metadata';
-export declare function openDatabase(): Promise<IDBDatabase>;
-/**
- * Abstracts data persistence.
- */
-export declare class Storage {
-    private readonly appId;
-    private readonly appName;
-    private readonly namespace;
-    private readonly openDbPromise;
-    /**
-     * @param appId enables storage segmentation by app (ID + name).
-     * @param appName enables storage segmentation by app (ID + name).
-     * @param namespace enables storage segmentation by namespace.
-     */
-    constructor(appId: string, appName: string, namespace: string, openDbPromise?: Promise<IDBDatabase>);
-    getLastFetchStatus(): Promise<FetchStatus | undefined>;
-    setLastFetchStatus(status: FetchStatus): Promise<void>;
-    getLastSuccessfulFetchTimestampMillis(): Promise<number | undefined>;
-    setLastSuccessfulFetchTimestampMillis(timestamp: number): Promise<void>;
-    getLastSuccessfulFetchResponse(): Promise<FetchResponse | undefined>;
-    setLastSuccessfulFetchResponse(response: FetchResponse): Promise<void>;
-    getActiveConfig(): Promise<FirebaseRemoteConfigObject | undefined>;
-    setActiveConfig(config: FirebaseRemoteConfigObject): Promise<void>;
-    getActiveConfigEtag(): Promise<string | undefined>;
-    setActiveConfigEtag(etag: string): Promise<void>;
-    getThrottleMetadata(): Promise<ThrottleMetadata | undefined>;
-    setThrottleMetadata(metadata: ThrottleMetadata): Promise<void>;
-    deleteThrottleMetadata(): Promise<void>;
-    get<T>(key: ProjectNamespaceKeyFieldValue): Promise<T | undefined>;
-    set<T>(key: ProjectNamespaceKeyFieldValue, value: T): Promise<void>;
-    delete(key: ProjectNamespaceKeyFieldValue): Promise<void>;
-    createCompositeKey(key: ProjectNamespaceKeyFieldValue): string;
-}
-export {};
+/**
+ * @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 { FetchStatus } from '@firebase/remote-config-types';
+import { FetchResponse, FirebaseRemoteConfigObject } from '../client/remote_config_fetch_client';
+/**
+ * A general-purpose store keyed by app + namespace + {@link
+ * ProjectNamespaceKeyFieldValue}.
+ *
+ * <p>The Remote Config SDK can be used with multiple app installations, and each app can interact
+ * with multiple namespaces, so this store uses app (ID + name) and namespace as common parent keys
+ * for a set of key-value pairs. See {@link Storage#createCompositeKey}.
+ *
+ * <p>Visible for testing.
+ */
+export declare const APP_NAMESPACE_STORE = "app_namespace_store";
+/**
+ * Encapsulates metadata concerning throttled fetch requests.
+ */
+export interface ThrottleMetadata {
+    backoffCount: number;
+    throttleEndTimeMillis: number;
+}
+/**
+ * Provides type-safety for the "key" field used by {@link APP_NAMESPACE_STORE}.
+ *
+ * <p>This seems like a small price to avoid potentially subtle bugs caused by a typo.
+ */
+type ProjectNamespaceKeyFieldValue = 'active_config' | 'active_config_etag' | 'last_fetch_status' | 'last_successful_fetch_timestamp_millis' | 'last_successful_fetch_response' | 'settings' | 'throttle_metadata';
+export declare function openDatabase(): Promise<IDBDatabase>;
+/**
+ * Abstracts data persistence.
+ */
+export declare class Storage {
+    private readonly appId;
+    private readonly appName;
+    private readonly namespace;
+    private readonly openDbPromise;
+    /**
+     * @param appId enables storage segmentation by app (ID + name).
+     * @param appName enables storage segmentation by app (ID + name).
+     * @param namespace enables storage segmentation by namespace.
+     */
+    constructor(appId: string, appName: string, namespace: string, openDbPromise?: Promise<IDBDatabase>);
+    getLastFetchStatus(): Promise<FetchStatus | undefined>;
+    setLastFetchStatus(status: FetchStatus): Promise<void>;
+    getLastSuccessfulFetchTimestampMillis(): Promise<number | undefined>;
+    setLastSuccessfulFetchTimestampMillis(timestamp: number): Promise<void>;
+    getLastSuccessfulFetchResponse(): Promise<FetchResponse | undefined>;
+    setLastSuccessfulFetchResponse(response: FetchResponse): Promise<void>;
+    getActiveConfig(): Promise<FirebaseRemoteConfigObject | undefined>;
+    setActiveConfig(config: FirebaseRemoteConfigObject): Promise<void>;
+    getActiveConfigEtag(): Promise<string | undefined>;
+    setActiveConfigEtag(etag: string): Promise<void>;
+    getThrottleMetadata(): Promise<ThrottleMetadata | undefined>;
+    setThrottleMetadata(metadata: ThrottleMetadata): Promise<void>;
+    deleteThrottleMetadata(): Promise<void>;
+    get<T>(key: ProjectNamespaceKeyFieldValue): Promise<T | undefined>;
+    set<T>(key: ProjectNamespaceKeyFieldValue, value: T): Promise<void>;
+    delete(key: ProjectNamespaceKeyFieldValue): Promise<void>;
+    createCompositeKey(key: ProjectNamespaceKeyFieldValue): string;
+}
+export {};