/** * Firebase Data Connect * * @packageDocumentation */ import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types'; import { AppCheckTokenListener } from '@firebase/app-check-interop-types'; import { AppCheckTokenResult } from '@firebase/app-check-interop-types'; import { FirebaseApp } from '@firebase/app'; import { FirebaseAuthInternalName } from '@firebase/auth-interop-types'; import { FirebaseAuthTokenData } from '@firebase/auth-interop-types'; import { FirebaseError } from '@firebase/util'; import { LogLevelString } from '@firebase/logger'; import { Provider } from '@firebase/component'; /** * @internal * Abstraction around AppCheck's token fetching capabilities. */ declare class AppCheckTokenProvider { private appCheckProvider?; private appCheck?; private serverAppAppCheckToken?; constructor(app: FirebaseApp, appCheckProvider?: Provider); getToken(): Promise; addTokenChangeListener(listener: AppCheckTokenListener): void; } /** * @internal * @param transportOptions1 * @param transportOptions2 * @returns */ export declare function areTransportOptionsEqual(transportOptions1: TransportOptions, transportOptions2: TransportOptions): boolean; declare type AuthTokenListener = (token: string | null) => void; declare interface AuthTokenProvider { getToken(forceRefresh: boolean): Promise; addTokenChangeListener(listener: AuthTokenListener): void; } /** * enum representing different flavors of the SDK used by developers * use the CallerSdkType for type-checking, and the CallerSdkTypeEnum for value-checking/assigning */ export declare type CallerSdkType = 'Base' | 'Generated' | 'TanstackReactCore' | 'GeneratedReact' | 'TanstackAngularCore' | 'GeneratedAngular'; export declare const CallerSdkTypeEnum: { readonly Base: "Base"; readonly Generated: "Generated"; readonly TanstackReactCore: "TanstackReactCore"; readonly GeneratedReact: "GeneratedReact"; readonly TanstackAngularCore: "TanstackAngularCore"; readonly GeneratedAngular: "GeneratedAngular"; }; export declare type Code = DataConnectErrorCode; export declare const Code: { OTHER: DataConnectErrorCode; ALREADY_INITIALIZED: DataConnectErrorCode; NOT_INITIALIZED: DataConnectErrorCode; NOT_SUPPORTED: DataConnectErrorCode; INVALID_ARGUMENT: DataConnectErrorCode; PARTIAL_ERROR: DataConnectErrorCode; UNAUTHORIZED: DataConnectErrorCode; }; /** * Connect to the DataConnect Emulator * @param dc Data Connect instance * @param host host of emulator server * @param port port of emulator server * @param sslEnabled use https */ export declare function connectDataConnectEmulator(dc: DataConnect, host: string, port?: number, sslEnabled?: boolean): void; /** * Connector Config for calling Data Connect backend. */ export declare interface ConnectorConfig { location: string; connector: string; service: string; } /** * Class representing Firebase Data Connect */ export declare class DataConnect { readonly app: FirebaseApp; private readonly dataConnectOptions; private readonly _authProvider; private readonly _appCheckProvider; _queryManager: QueryManager; _mutationManager: MutationManager; isEmulator: boolean; _initialized: boolean; private _transport; private _transportClass; private _transportOptions?; private _authTokenProvider?; _isUsingGeneratedSdk: boolean; _callerSdkType: CallerSdkType; private _appCheckTokenProvider?; constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider, _appCheckProvider: Provider); _useGeneratedSdk(): void; _setCallerSdkType(callerSdkType: CallerSdkType): void; _delete(): Promise; getSettings(): ConnectorConfig; setInitialized(): void; enableEmulator(transportOptions: TransportOptions): void; } /** An error returned by a DataConnect operation. */ export declare class DataConnectError extends FirebaseError { /** @internal */ readonly name: string; constructor(code: Code, message: string); /** @internal */ toString(): string; } export declare type DataConnectErrorCode = 'other' | 'already-initialized' | 'not-initialized' | 'not-supported' | 'invalid-argument' | 'partial-error' | 'unauthorized'; /** An error returned by a DataConnect operation. */ export declare class DataConnectOperationError extends DataConnectError { /** @internal */ readonly name: string; /** The response received from the backend. */ readonly response: DataConnectOperationFailureResponse; /** @hideconstructor */ constructor(message: string, response: DataConnectOperationFailureResponse); } export declare interface DataConnectOperationFailureResponse { readonly data?: Record | null; readonly errors: DataConnectOperationFailureResponseErrorInfo[]; } export declare interface DataConnectOperationFailureResponseErrorInfo { readonly message: string; readonly path: Array; } /** * DataConnectOptions including project id */ export declare interface DataConnectOptions extends ConnectorConfig { projectId: string; } export declare interface DataConnectResult extends OpResult { ref: OperationRef; } /** * Representation of user provided subscription options. */ export declare interface DataConnectSubscription { userCallback: OnResultSubscription; errCallback?: (e?: DataConnectError) => void; unsubscribe: () => void; } /** * @internal */ export declare interface DataConnectTransport { invokeQuery(queryName: string, body?: U): Promise<{ data: T; errors: Error[]; }>; invokeMutation(queryName: string, body?: U): Promise<{ data: T; errors: Error[]; }>; useEmulator(host: string, port?: number, sslEnabled?: boolean): void; onTokenChanged: (token: string | null) => void; _setCallerSdkType(callerSdkType: CallerSdkType): void; } export declare type DataSource = typeof SOURCE_CACHE | typeof SOURCE_SERVER; /** * Execute Mutation * @param mutationRef mutation to execute * @returns `MutationRef` */ export declare function executeMutation(mutationRef: MutationRef): MutationPromise; /** * Execute Query * @param queryRef query to execute. * @returns `QueryPromise` */ export declare function executeQuery(queryRef: QueryRef): QueryPromise; /** * Initialize DataConnect instance * @param options ConnectorConfig */ export declare function getDataConnect(options: ConnectorConfig): DataConnect; /** * Initialize DataConnect instance * @param app FirebaseApp to initialize to. * @param options ConnectorConfig */ export declare function getDataConnect(app: FirebaseApp, options: ConnectorConfig): DataConnect; export declare const MUTATION_STR = "mutation"; /** * @internal */ export declare class MutationManager { private _transport; private _inflight; constructor(_transport: DataConnectTransport); executeMutation(mutationRef: MutationRef): MutationPromise; } /** * Mutation return value from `executeMutation` */ export declare interface MutationPromise extends Promise> { } export declare interface MutationRef extends OperationRef { refType: typeof MUTATION_STR; } /** * Creates a `MutationRef` * @param dcInstance Data Connect instance * @param mutationName name of mutation */ export declare function mutationRef(dcInstance: DataConnect, mutationName: string): MutationRef; /** * * @param dcInstance Data Connect instance * @param mutationName name of mutation * @param variables variables to send with mutation */ export declare function mutationRef(dcInstance: DataConnect, mutationName: string, variables: Variables): MutationRef; /** * Mutation Result from `executeMutation` */ export declare interface MutationResult extends DataConnectResult { ref: MutationRef; } /** * `OnCompleteSubscription` */ export declare type OnCompleteSubscription = () => void; /** * Signature for `OnErrorSubscription` for `subscribe` */ export declare type OnErrorSubscription = (err?: DataConnectError) => void; /** * Signature for `OnResultSubscription` for `subscribe` */ export declare type OnResultSubscription = (res: QueryResult) => void; export declare interface OperationRef<_Data, Variables> { name: string; variables: Variables; refType: ReferenceType; dataConnect: DataConnect; } export declare interface OpResult { data: Data; source: DataSource; fetchTime: string; } declare interface ParsedArgs { dc: DataConnect; vars: Variables; } /** * * @param fullHost * @returns TransportOptions * @internal */ export declare function parseOptions(fullHost: string): TransportOptions; export declare const QUERY_STR = "query"; declare class QueryManager { private transport; _queries: Map>; constructor(transport: DataConnectTransport); track(queryName: string, variables: Variables, initialCache?: OpResult): TrackedQuery; addSubscription(queryRef: OperationRef, onResultCallback: OnResultSubscription, onErrorCallback?: OnErrorSubscription, initialCache?: OpResult): () => void; executeQuery(queryRef: QueryRef): QueryPromise; enableEmulator(host: string, port: number): void; } /** * Promise returned from `executeQuery` */ export declare interface QueryPromise extends Promise> { } /** * QueryRef object */ export declare interface QueryRef extends OperationRef { refType: typeof QUERY_STR; } /** * Execute Query * @param dcInstance Data Connect instance to use. * @param queryName Query to execute * @returns `QueryRef` */ export declare function queryRef(dcInstance: DataConnect, queryName: string): QueryRef; /** * Execute Query * @param dcInstance Data Connect instance to use. * @param queryName Query to execute * @param variables Variables to execute with * @returns `QueryRef` */ export declare function queryRef(dcInstance: DataConnect, queryName: string, variables: Variables): QueryRef; /** * Result of `executeQuery` */ export declare interface QueryResult extends DataConnectResult { ref: QueryRef; toJSON: () => SerializedRef; } /** * Signature for unsubscribe from `subscribe` */ export declare type QueryUnsubscribe = () => void; export declare type ReferenceType = typeof QUERY_STR | typeof MUTATION_STR; /** * Serialized RefInfo as a result of `QueryResult.toJSON().refInfo` */ export declare interface RefInfo { name: string; variables: Variables; connectorConfig: DataConnectOptions; } /** * Serialized Ref as a result of `QueryResult.toJSON()` */ export declare interface SerializedRef extends OpResult { refInfo: RefInfo; } export declare function setLogLevel(logLevel: LogLevelString): void; export declare const SOURCE_CACHE = "CACHE"; export declare const SOURCE_SERVER = "SERVER"; /** * Subscribe to a `QueryRef` * @param queryRefOrSerializedResult query ref or serialized result. * @param observer observer object to use for subscribing. * @returns `SubscriptionOptions` */ export declare function subscribe(queryRefOrSerializedResult: QueryRef | SerializedRef, observer: SubscriptionOptions): QueryUnsubscribe; /** * Subscribe to a `QueryRef` * @param queryRefOrSerializedResult query ref or serialized result. * @param onNext Callback to call when result comes back. * @param onError Callback to call when error gets thrown. * @param onComplete Called when subscription completes. * @returns `SubscriptionOptions` */ export declare function subscribe(queryRefOrSerializedResult: QueryRef | SerializedRef, onNext: OnResultSubscription, onError?: OnErrorSubscription, onComplete?: OnCompleteSubscription): QueryUnsubscribe; /** * Representation of full observer options in `subscribe` */ export declare interface SubscriptionOptions { onNext?: OnResultSubscription; onErr?: OnErrorSubscription; onComplete?: OnCompleteSubscription; } /** * Delete DataConnect instance * @param dataConnect DataConnect instance * @returns */ export declare function terminate(dataConnect: DataConnect): Promise; /** * Converts serialized ref to query ref * @param serializedRef ref to convert to `QueryRef` * @returns `QueryRef` */ export declare function toQueryRef(serializedRef: SerializedRef): QueryRef; declare interface TrackedQuery { ref: Omit, 'dataConnect'>; subscriptions: Array>; currentCache: OpResult | null; lastError: DataConnectError | null; } /** * @internal */ export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, appId?: string, authProvider?: AuthTokenProvider, appCheckProvider?: AppCheckTokenProvider, transportOptions?: TransportOptions, _isUsingGen?: boolean, _callerSdkType?: CallerSdkType) => DataConnectTransport; /** * Options to connect to emulator */ export declare interface TransportOptions { host: string; sslEnabled?: boolean; port?: number; } /** * The generated SDK will allow the user to pass in either the variable or the data connect instance with the variable, * and this function validates the variables and returns back the DataConnect instance and variables based on the arguments passed in. * @param connectorConfig * @param dcOrVars * @param vars * @param validateVars * @returns {DataConnect} and {Variables} instance * @internal */ export declare function validateArgs(connectorConfig: ConnectorConfig, dcOrVars?: DataConnect | Variables, vars?: Variables, validateVars?: boolean): ParsedArgs; /** * * @param dcOptions * @returns {void} * @internal */ export declare function validateDCOptions(dcOptions: ConnectorConfig): boolean; export { }