diff options
Diffstat (limited to 'frontend-old/node_modules/@firebase/remote-config/dist/remote-config.d.ts')
| -rw-r--r-- | frontend-old/node_modules/@firebase/remote-config/dist/remote-config.d.ts | 421 |
1 files changed, 421 insertions, 0 deletions
diff --git a/frontend-old/node_modules/@firebase/remote-config/dist/remote-config.d.ts b/frontend-old/node_modules/@firebase/remote-config/dist/remote-config.d.ts new file mode 100644 index 0000000..58c2bbc --- /dev/null +++ b/frontend-old/node_modules/@firebase/remote-config/dist/remote-config.d.ts @@ -0,0 +1,421 @@ +/** + * The Firebase Remote Config Web SDK. + * This SDK does not work in a Node.js environment. + * + * @packageDocumentation + */ + +import { FirebaseApp } from '@firebase/app'; +import { FirebaseError } from '@firebase/app'; + +/** + * 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>; + +/** + * Contains information about which keys have been updated. + * + * @public + */ +export declare 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 declare 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; +} + +/** + * 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 declare interface CustomSignals { + [key: string]: string | number | null; +} + +/** + * 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>; + +/** + * + * 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>; + +/** + * Fetches and caches configuration from the Remote Config service. + * @param remoteConfig - The {@link RemoteConfig} instance. + * @public + */ +export declare function fetchConfig(remoteConfig: RemoteConfig): Promise<void>; + +/** + * Defines a successful response (200 or 304). + * + * <p>Modeled after the native `Response` interface, but simplified for Remote Config's + * use case. + * + * @public + */ +export declare 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; +} + +/** + * 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'; + +/** + * 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 declare type FetchType = 'BASE' | 'REALTIME'; + +/** + * Defines a self-descriptive reference for config key-value pairs. + * + * @public + */ +export declare interface FirebaseRemoteConfigObject { + [key: string]: string; +} + +/** + * 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; + +/** + * + * @param app - The {@link @firebase/app#FirebaseApp} instance. + * @param options - Optional. The {@link RemoteConfigOptions} with which to instantiate the + * Remote Config instance. + * @returns A {@link RemoteConfig} instance. + * + * @public + */ +export declare function getRemoteConfig(app?: FirebaseApp, options?: RemoteConfigOptions): RemoteConfig; + +/** + * 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; + +/** + * 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>; + +/** + * Defines levels of Remote Config logging. + * + * @public + */ +export declare type LogLevel = 'debug' | 'error' | 'silent'; + +/** + * Starts listening for real-time config updates from the Remote Config backend and automatically + * fetches updates from the Remote Config backend when they are available. + * + * @remarks + * If a connection to the Remote Config backend is not already open, calling this method will + * open it. Multiple listeners can be added by calling this method again, but subsequent calls + * re-use the same connection to the backend. + * + * @param remoteConfig - The {@link RemoteConfig} instance. + * @param observer - The {@link ConfigUpdateObserver} to be notified of config updates. + * @returns An {@link Unsubscribe} function to remove the listener. + * + * @public + */ +export declare function onConfigUpdate(remoteConfig: RemoteConfig, observer: ConfigUpdateObserver): Unsubscribe; + +/** + * The Firebase Remote Config service interface. + * + * @public + */ +export declare 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; +} + +/** + * Options for Remote Config initialization. + * + * @public + */ +export declare 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; +} + +/** + * Defines configuration options for the Remote Config SDK. + * + * @public + */ +export declare 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; +} + +/** + * Sets the custom signals for the app instance. + * + * @param remoteConfig - The {@link RemoteConfig} instance. + * @param customSignals - Map (key, value) of the custom signals to be set for the app instance. If + * a key already exists, the value is overwritten. Setting the value of a custom signal to null + * unsets the signal. The signals will be persisted locally on the client. + * + * @public + */ +export declare function setCustomSignals(remoteConfig: RemoteConfig, customSignals: CustomSignals): Promise<void>; + +/** + * 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: LogLevel): void; + +/** + * A function that unsubscribes from a real-time event stream. + * + * @public + */ +export declare type Unsubscribe = () => void; + +/** + * Wraps a value with metadata and type-safe getters. + * + * @public + */ +export declare 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 fetched config.</li> + * </ul> + * + * @public + */ +export declare type ValueSource = 'static' | 'default' | 'remote'; + +export { } |