@depup/firebase__remote-config 0.8.1-depup.0

package/dist/src/public_types.d.ts

@@ -0,0 +1,274 @@
+/**
+ * @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, FirebaseError } 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;
+}
+/**
+ * Defines a self-descriptive reference for config key-value pairs.
+ *
+ *  @public
+ */
+export interface FirebaseRemoteConfigObject {
+    [key: string]: string;
+}
+/**
+ * Defines experiment and variant attached to a config parameter.
+ *
+ * @public
+ */
+export interface FirebaseExperimentDescription {
+    experimentId: string;
+    variantId: string;
+    experimentStartTime: string;
+    triggerTimeoutMillis: string;
+    timeToLiveMillis: string;
+    affectedParameterKeys?: string[];
+}
+/**
+ * Defines a successful response (200 or 304).
+ *
+ * <p>Modeled after the native `Response` interface, but simplified for Remote Config's
+ * use case.
+ *
+ * @public
+ */
+export interface FetchResponse {
+    /**
+     * The HTTP status, which is useful for differentiating success responses with data from
+     * those without.
+     *
+     * <p>The Remote Config client is modeled after the native `Fetch` 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;
+    /**
+     * The version number of the config template fetched from the server.
+     */
+    templateVersion?: number;
+    /**
+     * Metadata for A/B testing and Remote Config Rollout experiments.
+     *
+     * @remarks Only defined for 200 responses.
+     */
+    experiments?: FirebaseExperimentDescription[];
+}
+/**
+ * Options for Remote Config initialization.
+ *
+ * @public
+ */
+export interface RemoteConfigOptions {
+    /**
+     * The ID of the template to use. If not provided, defaults to "firebase".
+     */
+    templateId?: string;
+    /**
+     * Hydrates the state with an initial fetch response.
+     */
+    initialFetchResponse?: FetchResponse;
+}
+/**
+ * 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';
+/**
+ * Defines the type for representing custom signals and their values.
+ *
+ * <p>The values in CustomSignals must be one of the following types:
+ *
+ * <ul>
+ *   <li><code>string</code>
+ *   <li><code>number</code>
+ *   <li><code>null</code>
+ * </ul>
+ *
+ * @public
+ */
+export interface CustomSignals {
+    [key: string]: string | number | null;
+}
+/**
+ * Contains information about which keys have been updated.
+ *
+ * @public
+ */
+export interface ConfigUpdate {
+    /**
+     * Parameter keys whose values have been updated from the currently activated values.
+     * Includes keys that are added, deleted, or whose value, value source, or metadata has changed.
+     */
+    getUpdatedKeys(): Set<string>;
+}
+/**
+ * Observer interface for receiving real-time Remote Config update notifications.
+ *
+ * NOTE: Although an `complete` callback can be provided, it will
+ * never be called because the ConfigUpdate stream is never-ending.
+ *
+ * @public
+ */
+export interface ConfigUpdateObserver {
+    /**
+     * Called when a new ConfigUpdate is available.
+     */
+    next: (configUpdate: ConfigUpdate) => void;
+    /**
+     * Called if an error occurs during the stream.
+     */
+    error: (error: FirebaseError) => void;
+    /**
+     * Called when the stream is gracefully terminated.
+     */
+    complete: () => void;
+}
+/**
+ * A function that unsubscribes from a real-time event stream.
+ *
+ * @public
+ */
+export type Unsubscribe = () => void;
+/**
+ * Indicates the type of fetch request.
+ *
+ * <ul>
+ *   <li>"BASE" indicates a standard fetch request.</li>
+ *   <li>"REALTIME" indicates a fetch request triggered by a real-time update.</li>
+ * </ul>
+ *
+ * @public
+ */
+export type FetchType = 'BASE' | 'REALTIME';
+declare module '@firebase/component' {
+    interface NameServiceMapping {
+        'remote-config': RemoteConfig;
+    }
+}

package/dist/src/register.d.ts

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

package/dist/src/remote_config.d.ts

@@ -0,0 +1,98 @@
+/**
+ * @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';
+import { FirebaseAnalyticsInternalName } from '@firebase/analytics-interop-types';
+import { Provider } from '@firebase/component';
+import { RealtimeHandler } from './client/realtime_handler';
+/**
+ * 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/compat/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;
+    /**
+     * @internal
+     */
+    readonly _realtimeHandler: RealtimeHandler;
+    /**
+     * @internal
+     */
+    readonly _analyticsProvider: Provider<FirebaseAnalyticsInternalName>;
+    /**
+     * 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, 
+    /**
+     * @internal
+     */
+    _realtimeHandler: RealtimeHandler, 
+    /**
+     * @internal
+     */
+    _analyticsProvider: Provider<FirebaseAnalyticsInternalName>);
+}

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

@@ -0,0 +1,118 @@
+/**
+ * @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, CustomSignals } from '@firebase/remote-config-types';
+import { FetchResponse, FirebaseRemoteConfigObject } from '../public_types';
+/**
+ * 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;
+}
+export interface RealtimeBackoffMetadata {
+    numFailedStreams: number;
+    backoffEndTimeMillis: Date;
+}
+/**
+ * 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' | 'active_experiments' | 'last_fetch_status' | 'last_successful_fetch_timestamp_millis' | 'last_successful_fetch_response' | 'settings' | 'throttle_metadata' | 'custom_signals' | 'realtime_backoff_metadata' | 'last_known_template_version';
+export declare function openDatabase(): Promise<IDBDatabase>;
+/**
+ * Abstracts data persistence.
+ */
+export declare abstract class Storage {
+    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>;
+    getActiveExperiments(): Promise<Set<string> | undefined>;
+    setActiveExperiments(experiments: Set<string>): Promise<void>;
+    getThrottleMetadata(): Promise<ThrottleMetadata | undefined>;
+    setThrottleMetadata(metadata: ThrottleMetadata): Promise<void>;
+    deleteThrottleMetadata(): Promise<void>;
+    getCustomSignals(): Promise<CustomSignals | undefined>;
+    abstract setCustomSignals(customSignals: CustomSignals): Promise<CustomSignals>;
+    abstract get<T>(key: ProjectNamespaceKeyFieldValue): Promise<T | undefined>;
+    abstract set<T>(key: ProjectNamespaceKeyFieldValue, value: T): Promise<void>;
+    abstract delete(key: ProjectNamespaceKeyFieldValue): Promise<void>;
+    getRealtimeBackoffMetadata(): Promise<RealtimeBackoffMetadata | undefined>;
+    setRealtimeBackoffMetadata(realtimeMetadata: RealtimeBackoffMetadata): Promise<void>;
+    getActiveConfigTemplateVersion(): Promise<number | undefined>;
+    setActiveConfigTemplateVersion(version: number): Promise<void>;
+}
+export declare class IndexedDbStorage extends 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>);
+    setCustomSignals(customSignals: CustomSignals): Promise<CustomSignals>;
+    /**
+     * Gets a value from the database using the provided transaction.
+     *
+     * @param key The key of the value to get.
+     * @param transaction The transaction to use for the operation.
+     * @returns The value associated with the key, or undefined if no such value exists.
+     */
+    getWithTransaction<T>(key: ProjectNamespaceKeyFieldValue, transaction: IDBTransaction): Promise<T | undefined>;
+    /**
+     * Sets a value in the database using the provided transaction.
+     *
+     * @param key The key of the value to set.
+     * @param value The value to set.
+     * @param transaction The transaction to use for the operation.
+     * @returns A promise that resolves when the operation is complete.
+     */
+    setWithTransaction<T>(key: ProjectNamespaceKeyFieldValue, value: T, transaction: IDBTransaction): 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 declare class InMemoryStorage extends Storage {
+    private storage;
+    get<T>(key: ProjectNamespaceKeyFieldValue): Promise<T>;
+    set<T>(key: ProjectNamespaceKeyFieldValue, value: T): Promise<void>;
+    delete(key: ProjectNamespaceKeyFieldValue): Promise<void>;
+    setCustomSignals(customSignals: CustomSignals): Promise<CustomSignals>;
+}
+export {};

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

@@ -0,0 +1,51 @@
+/**
+ * @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, CustomSignals } from '@firebase/remote-config-types';
+import { FirebaseRemoteConfigObject } from '../public_types';
+import { Storage } from './storage';
+/**
+ * A memory cache layer over storage to support the SDK's synchronous read requirements.
+ */
+export declare class StorageCache {
+    private readonly storage;
+    constructor(storage: Storage);
+    /**
+     * Memory caches.
+     */
+    private lastFetchStatus?;
+    private lastSuccessfulFetchTimestampMillis?;
+    private activeConfig?;
+    private customSignals?;
+    /**
+     * Memory-only getters
+     */
+    getLastFetchStatus(): FetchStatus | undefined;
+    getLastSuccessfulFetchTimestampMillis(): number | undefined;
+    getActiveConfig(): FirebaseRemoteConfigObject | undefined;
+    getCustomSignals(): CustomSignals | undefined;
+    /**
+     * Read-ahead getter
+     */
+    loadFromStorage(): Promise<void>;
+    /**
+     * Write-through setters
+     */
+    setLastFetchStatus(status: FetchStatus): Promise<void>;
+    setLastSuccessfulFetchTimestampMillis(timestampMillis: number): Promise<void>;
+    setActiveConfig(activeConfig: FirebaseRemoteConfigObject): Promise<void>;
+    setCustomSignals(customSignals: CustomSignals): Promise<void>;
+}

package/dist/src/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "0.1.2"
+    }
+  ]
+}

package/dist/src/value.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @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 { Value as ValueType, ValueSource } from '@firebase/remote-config-types';
+export declare class Value implements ValueType {
+    private readonly _source;
+    private readonly _value;
+    constructor(_source: ValueSource, _value?: string);
+    asString(): string;
+    asBoolean(): boolean;
+    asNumber(): number;
+    getSource(): ValueSource;
+}

package/dist/test/setup.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @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.
+ */
+export {};