@firebase/data-connect 0.0.2-dataconnect-preview.877f8b7d0 → 0.0.2-dataconnect-preview.388b61c7e

package/dist/src/api/Mutation.d.ts

@@ -20,17 +20,42 @@ import { DataConnectResult, MUTATION_STR, OperationRef } from './Reference';
 export interface MutationRef<Data, Variables> extends OperationRef<Data, Variables> {
     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>;
+/**
+ * @internal
+ */
 export declare class MutationManager {
     private _transport;
     private _inflight;
     constructor(_transport: DataConnectTransport);
     executeMutation<Data, Variables>(mutationRef: MutationRef<Data, Variables>): MutationPromise<Data, Variables>;
 }
+/**
+ * Mutation Result from `executeMutation`
+ */
 export interface MutationResult<Data, Variables> extends DataConnectResult<Data, Variables> {
     ref: MutationRef<Data, Variables>;
 }
+/**
+ * Mutation return value from `executeMutation`
+ */
 export interface MutationPromise<Data, Variables> extends PromiseLike<MutationResult<Data, Variables>> {
 }
+/**
+ * Execute Mutation
+ * @param mutationRef mutation to execute
+ * @returns `MutationRef`
+ */
 export declare function executeMutation<Data, Variables>(mutationRef: MutationRef<Data, Variables>): MutationPromise<Data, Variables>;

package/dist/src/api/Reference.d.ts

@@ -35,11 +35,17 @@ export interface OperationRef<_Data, Variables> {
 export interface DataConnectResult<Data, Variables> extends OpResult<Data> {
     ref: OperationRef<Data, Variables>;
 }
+/**
+ * Serialized RefInfo as a result of `QueryResult.toJSON().refInfo`
+ */
 export interface RefInfo<Variables> {
     name: string;
     variables: Variables;
     connectorConfig: DataConnectOptions;
 }
+/**
+ * Serialized Ref as a result of `QueryResult.toJSON()`
+ */
 export interface SerializedRef<Data, Variables> extends OpResult<Data> {
     refInfo: RefInfo<Variables>;
 }

package/dist/src/api/query.d.ts

@@ -17,28 +17,78 @@
 import { DataConnectError } from '../core/error';
 import { DataConnect } from './DataConnect';
 import { OperationRef, QUERY_STR, DataConnectResult, SerializedRef } from './Reference';
+/**
+ * Signature for `OnResultSubscription` for `subscribe`
+ */
 export declare type OnResultSubscription<Data, Variables> = (res: QueryResult<Data, Variables>) => void;
+/**
+ * Signature for `OnErrorSubscription` for `subscribe`
+ */
 export declare type OnErrorSubscription = (err?: DataConnectError) => void;
+/**
+ * Signature for unsubscribe from `subscribe`
+ */
 export declare type QueryUnsubscribe = () => void;
+/**
+ * Representation of user provided subscription options.
+ */
 export interface DataConnectSubscription<Data, Variables> {
     userCallback: OnResultSubscription<Data, Variables>;
     errCallback?: (e?: DataConnectError) => void;
     unsubscribe: () => void;
 }
+/**
+ * QueryRef object
+ */
 export interface QueryRef<Data, Variables> extends OperationRef<Data, Variables> {
     refType: typeof QUERY_STR;
 }
+/**
+ * Result of `executeQuery`
+ */
 export interface QueryResult<Data, Variables> extends DataConnectResult<Data, Variables> {
     ref: QueryRef<Data, Variables>;
     toJSON: () => SerializedRef<Data, Variables>;
 }
+/**
+ * Promise returned from `executeQuery`
+ */
 export interface QueryPromise<Data, Variables> extends PromiseLike<QueryResult<Data, Variables>> {
 }
+/**
+ * Execute Query
+ * @param queryRef query to execute.
+ * @returns `QueryPromise`
+ */
 export declare function executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>): QueryPromise<Data, Variables>;
+/**
+ * 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>;
+/**
+ * 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>;
+/**
+ * `OnCompleteSubscription`
+ */
 export declare type OnCompleteSubscription = () => void;
+/**
+ * Representation of full observer options in `subscribe`
+ */
 export interface SubscriptionOptions<Data, Variables> {
     onNext?: OnResultSubscription<Data, Variables>;
     onErr?: OnErrorSubscription;

package/dist/src/api.browser.d.ts

@@ -17,13 +17,18 @@
 import { OnCompleteSubscription, OnErrorSubscription, OnResultSubscription, QueryRef, QueryUnsubscribe, SubscriptionOptions } from './api/query';
 import { SerializedRef } from './api/Reference';
 /**
- *
- * @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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/data-connect",
-  "version": "0.0.2-dataconnect-preview.877f8b7d0",
+  "version": "0.0.2-dataconnect-preview.388b61c7e",
   "description": "",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "main": "dist/index.node.cjs.js",
@@ -46,14 +46,14 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@firebase/auth-interop-types": "0.2.3-dataconnect-preview.877f8b7d0",
-    "@firebase/component": "0.6.7-dataconnect-preview.877f8b7d0",
-    "@firebase/logger": "0.4.2-dataconnect-preview.877f8b7d0",
-    "@firebase/util": "1.9.6-dataconnect-preview.877f8b7d0",
+    "@firebase/auth-interop-types": "0.2.3-dataconnect-preview.388b61c7e",
+    "@firebase/component": "0.6.7-dataconnect-preview.388b61c7e",
+    "@firebase/logger": "0.4.2-dataconnect-preview.388b61c7e",
+    "@firebase/util": "1.9.6-dataconnect-preview.388b61c7e",
     "tslib": "^2.1.0"
   },
   "devDependencies": {
-    "@firebase/app": "0.10.3-dataconnect-preview.877f8b7d0",
+    "@firebase/app": "0.10.3-dataconnect-preview.388b61c7e",
     "rollup": "2.79.1",
     "rollup-plugin-typescript2": "0.31.2",
     "typescript": "4.7.4"