@firebase/data-connect 0.0.2-dataconnect-preview.877f8b7d0 → 0.0.3-canary.beaa4dffb

package/dist/internal.d.ts

@@ -4,17 +4,32 @@
  * @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 { FirebaseOptions } from '@firebase/app';
 import { LogLevelString } from '@firebase/logger';
 import { Provider } from '@firebase/component';
 
-export declare type AuthTokenListener = (token: string | null) => void;
+/**
+ * @internal
+ * Abstraction around AppCheck's token fetching capabilities.
+ */
+declare class AppCheckTokenProvider {
+    private appName_;
+    private appCheckProvider?;
+    private appCheck?;
+    constructor(appName_: string, appCheckProvider?: Provider<AppCheckInternalComponentName>);
+    getToken(forceRefresh?: boolean): Promise<AppCheckTokenResult>;
+    addTokenChangeListener(listener: AppCheckTokenListener): void;
+}
 
-export declare interface AuthTokenProvider {
+declare type AuthTokenListener = (token: string | null) => void;
+
+declare interface AuthTokenProvider {
     getToken(forceRefresh: boolean): Promise<FirebaseAuthTokenData | null>;
     addTokenChangeListener(listener: AuthTokenListener): void;
 }
@@ -25,27 +40,44 @@ export declare interface CancellableOperation<T> extends PromiseLike<{
     cancel: () => void;
 }
 
+/**
+ * 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;
+    _initialized: boolean;
     private _transport;
     private _transportClass;
     private _transportOptions?;
     private _authTokenProvider?;
-    constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider<FirebaseAuthInternalName>);
+    _isUsingGeneratedSdk: boolean;
+    private _appCheckTokenProvider?;
+    constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider<FirebaseAuthInternalName>, _appCheckProvider: Provider<AppCheckInternalComponentName>);
+    _useGeneratedSdk(): void;
     _delete(): Promise<void>;
     getSettings(): ConnectorConfig;
     setInitialized(): void;
@@ -76,8 +108,11 @@ declare class DataConnectError extends FirebaseError {
     message: string);
 }
 
-declare type DataConnectErrorCode = 'other' | 'already-initialized' | 'not-initialized' | 'not-supported' | 'invalid-argument' | 'partial-error';
+declare type DataConnectErrorCode = 'other' | 'already-initialized' | 'not-initialized' | 'not-supported' | 'invalid-argument' | 'partial-error' | 'unauthorized';
 
+/**
+ * DataConnectOptions including project id
+ */
 export declare interface DataConnectOptions extends ConnectorConfig {
     projectId: string;
 }
@@ -86,12 +121,18 @@ export declare interface DataConnectResult<Data, Variables> extends OpResult<Dat
     ref: OperationRef<Data, Variables>;
 }
 
+/**
+ * Representation of user provided subscription options.
+ */
 export declare interface DataConnectSubscription<Data, Variables> {
     userCallback: OnResultSubscription<Data, Variables>;
     errCallback?: (e?: DataConnectError) => void;
     unsubscribe: () => void;
 }
 
+/**
+ * @internal
+ */
 export declare interface DataConnectTransport {
     invokeQuery<T, U>(queryName: string, body?: U): PromiseLike<{
         data: T;
@@ -107,29 +148,38 @@ export declare interface DataConnectTransport {
 
 export declare type DataSource = typeof SOURCE_CACHE | typeof SOURCE_SERVER;
 
+/**
+ * Execute Mutation
+ * @param mutationRef mutation to execute
+ * @returns `MutationRef`
+ */
 export declare function executeMutation<Data, Variables>(mutationRef: MutationRef<Data, Variables>): MutationPromise<Data, Variables>;
 
+/**
+ * Execute Query
+ * @param queryRef query to execute.
+ * @returns `QueryPromise`
+ */
 export declare function executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>): QueryPromise<Data, Variables>;
 
-export declare const FIREBASE_DATA_CONNECT_EMULATOR_HOST_VAR = "FIREBASE_DATA_CONNECT_EMULATOR_HOST";
-
-export declare class FirebaseAuthProvider implements AuthTokenProvider {
-    private _appName;
-    private _options;
-    private _authProvider;
-    private _auth;
-    constructor(_appName: string, _options: FirebaseOptions, _authProvider: Provider<FirebaseAuthInternalName>);
-    getToken(forceRefresh: boolean): Promise<FirebaseAuthTokenData | null>;
-    addTokenChangeListener(listener: AuthTokenListener): void;
-    removeTokenChangeListener(listener: (token: string | null) => void): void;
-}
-
+/**
+ * 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;
@@ -137,6 +187,9 @@ export declare class MutationManager {
     executeMutation<Data, Variables>(mutationRef: MutationRef<Data, Variables>): MutationPromise<Data, Variables>;
 }
 
+/**
+ * Mutation return value from `executeMutation`
+ */
 export declare interface MutationPromise<Data, Variables> extends PromiseLike<MutationResult<Data, Variables>> {
 }
 
@@ -144,21 +197,41 @@ export declare interface MutationRef<Data, Variables> extends OperationRef<Data,
     refType: typeof MUTATION_STR;
 }
 
-export declare function mutationRef<Data>(dcInstance: DataConnect, queryName: string): MutationRef<Data, undefined>;
+/**
+ * Creates a `MutationRef`
+ * @param dcInstance Data Connect instance
+ * @param mutationName name of mutation
+ */
+export declare function mutationRef<Data>(dcInstance: DataConnect, mutationName: string): MutationRef<Data, undefined>;
 
+/**
+ *
+ * @param dcInstance Data Connect instance
+ * @param mutationName name of mutation
+ * @param variables variables to send with mutation
+ */
 export declare function mutationRef<Data, Variables>(dcInstance: DataConnect, mutationName: string, variables: Variables): MutationRef<Data, Variables>;
 
-export declare interface MutationResponse<T> extends CancellableOperation<T> {
-}
-
+/**
+ * Mutation Result from `executeMutation`
+ */
 export declare interface MutationResult<Data, Variables> extends DataConnectResult<Data, Variables> {
     ref: MutationRef<Data, Variables>;
 }
 
+/**
+ * `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<Data, Variables> = (res: QueryResult<Data, Variables>) => void;
 
 export declare interface OperationRef<_Data, Variables> {
@@ -174,6 +247,11 @@ export declare interface OpResult<Data> {
     fetchTime: string;
 }
 
+declare interface ParsedArgs<Variables> {
+    dc: DataConnect;
+    vars: Variables;
+}
+
 /**
  *
  * @param fullHost
@@ -188,46 +266,69 @@ declare class QueryManager {
     private transport;
     _queries: Map<string, TrackedQuery<unknown, unknown>>;
     constructor(transport: DataConnectTransport);
-    track<Data, Variables>(queryName: string, variables: Variables, initialCache?: OpResult<Data>): TrackedQuery<unknown, unknown>;
+    track<Data, Variables>(queryName: string, variables: Variables, initialCache?: OpResult<Data>): TrackedQuery<Data, Variables>;
     addSubscription<Data, Variables>(queryRef: OperationRef<Data, Variables>, onResultCallback: OnResultSubscription<Data, Variables>, onErrorCallback?: OnErrorSubscription, initialCache?: OpResult<Data>): () => void;
     executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>): QueryPromise<Data, Variables>;
     enableEmulator(host: string, port: number): void;
 }
 
+/**
+ * Promise returned from `executeQuery`
+ */
 export declare interface QueryPromise<Data, Variables> extends PromiseLike<QueryResult<Data, Variables>> {
 }
 
+/**
+ * QueryRef object
+ */
 export declare interface QueryRef<Data, Variables> extends OperationRef<Data, Variables> {
     refType: typeof QUERY_STR;
 }
 
+/**
+ * Execute Query
+ * @param dcInstance Data Connect instance to use.
+ * @param queryName Query to execute
+ * @returns `QueryRef`
+ */
 export declare function queryRef<Data>(dcInstance: DataConnect, queryName: string): QueryRef<Data, undefined>;
 
+/**
+ * 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<Data, Variables>(dcInstance: DataConnect, queryName: string, variables: Variables): QueryRef<Data, Variables>;
 
-export declare interface QueryResponse<T> extends CancellableOperation<T> {
-}
-
+/**
+ * Result of `executeQuery`
+ */
 export declare interface QueryResult<Data, Variables> extends DataConnectResult<Data, Variables> {
     ref: QueryRef<Data, Variables>;
     toJSON: () => SerializedRef<Data, Variables>;
 }
 
+/**
+ * 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<Variables> {
     name: string;
     variables: Variables;
     connectorConfig: DataConnectOptions;
 }
 
-export declare interface Sender<T> {
-    abort: () => void;
-    send: () => Promise<T>;
-}
-
+/**
+ * Serialized Ref as a result of `QueryResult.toJSON()`
+ */
 export declare interface SerializedRef<Data, Variables> extends OpResult<Data> {
     refInfo: RefInfo<Variables>;
 }
@@ -239,27 +340,45 @@ export declare const SOURCE_CACHE = "CACHE";
 export declare const SOURCE_SERVER = "SERVER";
 
 /**
- *
- * @public
- * @param queryRef
- * @param onResult
- * @param onErr
- * @param initialCache
- * @returns
+ * 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<Data, Variables>(queryRefOrSerializedResult: QueryRef<Data, Variables> | SerializedRef<Data, Variables>, observer: SubscriptionOptions<Data, Variables>): 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<Data, Variables>(queryRefOrSerializedResult: QueryRef<Data, Variables> | SerializedRef<Data, Variables>, onNext: OnResultSubscription<Data, Variables>, onError?: OnErrorSubscription, onComplete?: OnCompleteSubscription): QueryUnsubscribe;
 
+/**
+ * Representation of full observer options in `subscribe`
+ */
 export declare interface SubscriptionOptions<Data, Variables> {
     onNext?: OnResultSubscription<Data, Variables>;
     onErr?: OnErrorSubscription;
     onComplete?: OnCompleteSubscription;
 }
 
+/**
+ * Delete DataConnect instance
+ * @param dataConnect DataConnect instance
+ * @returns
+ */
 export declare function terminate(dataConnect: DataConnect): Promise<void>;
 
-export declare function toQueryRef<Data, Variables>(serializedRef: SerializedRef<Data, Variables>): QueryRef<unknown, Variables>;
+/**
+ * Converts serialized ref to query ref
+ * @param serializedRef ref to convert to `QueryRef`
+ * @returns `QueryRef`
+ */
+export declare function toQueryRef<Data, Variables>(serializedRef: SerializedRef<Data, Variables>): QueryRef<Data, Variables>;
 
 declare interface TrackedQuery<Data, Variables> {
     ref: Omit<OperationRef<Data, Variables>, 'dataConnect'>;
@@ -268,12 +387,38 @@ declare interface TrackedQuery<Data, Variables> {
     lastError: DataConnectError | null;
 }
 
-export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions) => DataConnectTransport;
+/**
+ * @internal
+ */
+export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, appId?: string, authProvider?: AuthTokenProvider, appCheckProvider?: AppCheckTokenProvider, transportOptions?: TransportOptions, _isUsingGen?: boolean) => 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<Variables extends object>(connectorConfig: ConnectorConfig, dcOrVars?: DataConnect | Variables, vars?: Variables, validateVars?: boolean): ParsedArgs<Variables>;
+
+/**
+ *
+ * @param dcOptions
+ * @returns {void}
+ * @internal
+ */
+export declare function validateDCOptions(dcOptions: ConnectorConfig): boolean;
+
 export { }