@firebase/data-connect 0.0.1-dataconnect-preview.81ee5169c → 0.0.2-dataconnect-preview.388b61c7e

package/dist/internal.d.ts

@@ -25,27 +25,40 @@ 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 _authProvider;
     _queryManager: QueryManager;
     _mutationManager: MutationManager;
     isEmulator: boolean;
     initialized: boolean;
     private _transport;
-    private transportClass;
-    private transportOptions?;
-    private authTokenProvider?;
-    constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, authProvider: Provider<FirebaseAuthInternalName>);
+    private _transportClass;
+    private _transportOptions?;
+    private _authTokenProvider?;
+    constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider<FirebaseAuthInternalName>);
     _delete(): Promise<void>;
     getSettings(): ConnectorConfig;
     setInitialized(): void;
@@ -78,6 +91,9 @@ declare class DataConnectError extends FirebaseError {
 
 declare type DataConnectErrorCode = 'other' | 'already-initialized' | 'not-initialized' | 'not-supported' | 'invalid-argument' | 'partial-error';
 
+/**
+ * DataConnectOptions including project id
+ */
 export declare interface DataConnectOptions extends ConnectorConfig {
     projectId: string;
 }
@@ -86,6 +102,9 @@ 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;
@@ -107,58 +126,106 @@ 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>);
+    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 _transport;
     private _inflight;
-    constructor(transport: DataConnectTransport);
-    executeMutation<Response, Variables>(mutationRef: MutationRef<Response, Variables>): MutationPromise<Response, Variables>;
+    constructor(_transport: DataConnectTransport);
+    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>> {
 }
 
-export declare interface MutationRef<Response, Variables> extends OperationRef<Response, Variables> {
-    refType: typeof MutationStr;
+export declare interface MutationRef<Data, Variables> extends OperationRef<Data, Variables> {
+    refType: typeof MUTATION_STR;
 }
 
-export declare function mutationRef<Response>(dcInstance: DataConnect, queryName: string): MutationRef<Response, 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>;
 
-export declare function mutationRef<Response, Variables>(dcInstance: DataConnect, queryName: string, variables: Variables): MutationRef<Response, Variables>;
+/**
+ *
+ * @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>;
 }
 
-export declare const MutationStr = "mutation";
-
+/**
+ * `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> {
@@ -182,48 +249,69 @@ export declare interface OpResult<Data> {
  */
 export declare function parseOptions(fullHost: string): TransportOptions;
 
-export declare interface ProjectOptions {
-    location: string;
-    connector: string;
-    service: string;
-    projectId: string;
-}
+export declare const QUERY_STR = "query";
 
 declare class QueryManager {
     private transport;
     _queries: Map<string, TrackedQuery<unknown, unknown>>;
     constructor(transport: DataConnectTransport);
-    track<Response, Variables>(queryName: string, variables: Variables, initialCache?: OpResult<Response>): TrackedQuery<unknown, unknown> | undefined;
-    addSubscription<Response, Variables>(queryRef: OperationRef<Response, Variables>, onResultCallback: OnResultSubscription<Response, Variables>, onErrorCallback?: OnErrorSubscription, initialCache?: OpResult<Response>): () => void;
-    executeQuery<Response, Variables>(queryRef: QueryRef<Response, Variables>): QueryPromise<Response, Variables>;
+    track<Data, Variables>(queryName: string, variables: Variables, initialCache?: OpResult<Data>): TrackedQuery<unknown, unknown>;
+    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 QueryStr;
+    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>;
 }
 
-export declare const QueryStr = "query";
-
+/**
+ * Signature for unsubscribe from `subscribe`
+ */
 export declare type QueryUnsubscribe = () => void;
 
-export declare type ReferenceType = typeof QueryStr | typeof MutationStr;
+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;
@@ -235,6 +323,9 @@ export declare interface Sender<T> {
     send: () => Promise<T>;
 }
 
+/**
+ * Serialized Ref as a result of `QueryResult.toJSON()`
+ */
 export declare interface SerializedRef<Data, Variables> extends OpResult<Data> {
     refInfo: RefInfo<Variables>;
 }
@@ -246,37 +337,58 @@ 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;
 }
 
-export declare function terminate(dataConnect: DataConnect): void;
+/**
+ * Delete DataConnect instance
+ * @param dataConnect DataConnect instance
+ * @returns
+ */
+export declare function terminate(dataConnect: DataConnect): Promise<void>;
 
+/**
+ * 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<unknown, Variables>;
 
-declare interface TrackedQuery<Response, Variables> {
-    ref: Omit<OperationRef<Response, Variables>, 'dataConnect'>;
-    subscriptions: Array<DataConnectSubscription<Response, Variables>>;
-    currentCache: OpResult<Response> | null;
+declare interface TrackedQuery<Data, Variables> {
+    ref: Omit<OperationRef<Data, Variables>, 'dataConnect'>;
+    subscriptions: Array<DataConnectSubscription<Data, Variables>>;
+    currentCache: OpResult<Data> | null;
     lastError: DataConnectError | null;
 }
 
 export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions) => DataConnectTransport;
 
+/**
+ * Options to connect to emulator
+ */
 export declare interface TransportOptions {
     host: string;
     sslEnabled?: boolean;