capacitor-firebase-kit
Version:
Provider-less Firebase Kit - Universal Firebase services integration for React, React Native, and Capacitor apps
97 lines (96 loc) • 3.26 kB
TypeScript
import type { FirebaseKitConfig } from './core/types';
export interface AnalyticsService {
logEvent(eventName: string, eventParams?: any): Promise<void>;
setUserId(userId: string): Promise<void>;
setUserProperties(properties: any): Promise<void>;
setCurrentScreen(screenName: string, screenClassOverride?: string): Promise<void>;
setEnabled(enabled: boolean): Promise<void>;
isSupported(): Promise<{
isSupported: boolean;
}>;
}
export interface AppCheckService {
initialize(options: any): Promise<void>;
getToken(forceRefresh?: boolean): Promise<{
token: string;
}>;
setTokenAutoRefreshEnabled(enabled: boolean): Promise<void>;
}
export interface AdMobService {
initialize(options?: any): Promise<void>;
showBanner(options: any): Promise<void>;
hideBanner(): Promise<void>;
resumeBanner(): Promise<void>;
removeBanner(): Promise<void>;
prepareInterstitial(options: any): Promise<void>;
showInterstitial(): Promise<void>;
prepareRewardVideoAd(options: any): Promise<void>;
showRewardVideoAd(): Promise<void>;
setApplicationMuted(muted: boolean): Promise<void>;
setApplicationVolume(volume: number): Promise<void>;
}
export interface CrashlyticsService {
crash(): Promise<void>;
setUserId(userId: string): Promise<void>;
log(message: string): Promise<void>;
setEnabled(enabled: boolean): Promise<void>;
isEnabled(): Promise<{
isEnabled: boolean;
}>;
recordException(error: any): Promise<void>;
setCustomKey(key: string, value: any): Promise<void>;
setCustomKeys(customKeys: any): Promise<void>;
}
export interface PerformanceService {
startTrace(traceName: string): Promise<{
traceName: string;
traceId: string;
}>;
stopTrace(traceName: string): Promise<void>;
incrementMetric(traceName: string, metricName: string, value: number): Promise<void>;
setEnabled(enabled: boolean): Promise<void>;
isEnabled(): Promise<{
isEnabled: boolean;
}>;
}
export interface RemoteConfigService {
initialize(options: any): Promise<void>;
fetchAndActivate(): Promise<{
activated: boolean;
}>;
fetchConfig(): Promise<void>;
activate(): Promise<{
activated: boolean;
}>;
getValue(key: string): Promise<{
value: string;
source: string;
}>;
getString(key: string): Promise<{
value: string;
}>;
getNumber(key: string): Promise<{
value: number;
}>;
getBoolean(key: string): Promise<{
value: boolean;
}>;
setLogLevel(logLevel: string): Promise<void>;
}
declare class FirebaseKit {
private analyticsService?;
private appCheckService?;
private adMobService?;
private crashlyticsService?;
private performanceService?;
private remoteConfigService?;
initialize(config: FirebaseKitConfig): Promise<void>;
get analytics(): AnalyticsService;
get appCheck(): AppCheckService;
get adMob(): AdMobService;
get crashlytics(): CrashlyticsService;
get performance(): PerformanceService;
get remoteConfig(): RemoteConfigService;
}
export declare const firebaseKit: FirebaseKit;
export type { FirebaseKitConfig } from './core/types';