@react-native-firebase/remote-config/lib/types/remote-config.ts

React Native Firebase - React Native Firebase provides native integration with Remote Config, allowing you to change the appearance and/or functionality of your app without requiring an app update.

/*
 * Copyright (c) 2016-present Invertase Limited & Contributors
 *
 * 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 type { FirebaseApp, FirebaseError } from '@firebase/app';

export type LogLevel = 'debug' | 'error' | 'silent';

export type FetchStatus = 'success' | 'failure' | 'no_fetch_yet' | 'throttled';

export type ValueSource = 'static' | 'default' | 'remote';

export interface FirebaseRemoteConfigObject {
  [key: string]: string;
}

export interface FirebaseExperimentDescription {
  experimentId: string;
  variantId: string;
  experimentStartTime: string;
  triggerTimeoutMillis: string;
  timeToLiveMillis: string;
  affectedParameterKeys?: string[];
}

export interface FetchResponse {
  status: number;
  eTag?: string;
  config?: FirebaseRemoteConfigObject;
  templateVersion?: number;
  experiments?: FirebaseExperimentDescription[];
}

export interface RemoteConfigOptions {
  templateId?: string;
  initialFetchResponse?: FetchResponse;
}

export interface Value {
  getSource(): ValueSource;
  asBoolean(): boolean;
  asNumber(): number;
  asString(): string;
}

export interface RemoteConfigSettings {
  minimumFetchIntervalMillis: number;
  fetchTimeoutMillis: number;
}

export interface ConfigUpdate {
  getUpdatedKeys(): Set<string>;
}

export interface ConfigUpdateObserver {
  next: (configUpdate: ConfigUpdate) => void;
  error: (error: FirebaseError) => void;
  complete: () => void;
}

export type Unsubscribe = () => void;

export interface CustomSignals {
  [key: string]: string | number | null;
}

export interface RemoteConfig {
  app: FirebaseApp;
  fetchTimeMillis: number;
  lastFetchStatus: FetchStatus;
  settings: RemoteConfigSettings;
  defaultConfig: {
    [key: string]: string | number | boolean;
  };
}