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

package/dist/node-esm/src/core/QueryManager.d.ts

@@ -28,7 +28,7 @@ export 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;

package/dist/node-esm/src/core/error.d.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 import { FirebaseError } from '@firebase/util';
-export declare type DataConnectErrorCode = 'other' | 'already-initialized' | 'not-initialized' | 'not-supported' | 'invalid-argument' | 'partial-error';
+export declare type DataConnectErrorCode = 'other' | 'already-initialized' | 'not-initialized' | 'not-supported' | 'invalid-argument' | 'partial-error' | 'unauthorized';
 export declare type Code = DataConnectErrorCode;
 export declare const Code: {
     OTHER: DataConnectErrorCode;
@@ -24,6 +24,7 @@ export declare const Code: {
     NOT_SUPPORTED: DataConnectErrorCode;
     INVALID_ARGUMENT: DataConnectErrorCode;
     PARTIAL_ERROR: DataConnectErrorCode;
+    UNAUTHORIZED: DataConnectErrorCode;
 };
 /** An error returned by a DataConnect operation. */
 export declare class DataConnectError extends FirebaseError {

package/dist/node-esm/src/network/fetch.d.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 export declare function initializeFetch(fetchImpl: typeof fetch): void;
-export declare function dcFetch<T, U>(url: string, body: U, { signal }: AbortController, accessToken: string | null): Promise<{
+export declare function dcFetch<T, U>(url: string, body: U, { signal }: AbortController, accessToken: string | null, _isUsingGen: boolean): Promise<{
     data: T;
     errors: Error[];
 }>;

package/dist/node-esm/src/network/transport/index.d.ts

@@ -41,5 +41,5 @@ export interface Sender<T> {
     abort: () => void;
     send: () => Promise<T>;
 }
-export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions) => DataConnectTransport;
+export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions, _isUsingGen?: boolean) => DataConnectTransport;
 export * from '../../core/FirebaseAuthProvider';

package/dist/node-esm/src/network/transport/rest.d.ts

@@ -20,6 +20,7 @@ import { DataConnectTransport } from '.';
 export declare class RESTTransport implements DataConnectTransport {
     private apiKey?;
     private authProvider?;
+    private _isUsingGen;
     private _host;
     private _port;
     private _location;
@@ -29,16 +30,26 @@ export declare class RESTTransport implements DataConnectTransport {
     private _serviceName;
     private _accessToken;
     private _authInitialized;
-    constructor(options: DataConnectOptions, apiKey?: string | undefined, authProvider?: AuthTokenProvider | undefined, transportOptions?: TransportOptions | undefined);
+    private _lastToken;
+    constructor(options: DataConnectOptions, apiKey?: string | undefined, authProvider?: AuthTokenProvider | undefined, transportOptions?: TransportOptions | undefined, _isUsingGen?: boolean);
     get endpointUrl(): string;
     useEmulator(host: string, port?: number, isSecure?: boolean): void;
     onTokenChanged(newToken: string | null): void;
-    getWithAuth(): Promise<string>;
-    invokeQuery: <T, U = unknown>(queryName: string, body: U) => {
-        then: any;
-    };
-    invokeMutation: <T, U = unknown>(mutationName: string, body: U) => {
-        then: any;
-        cancel: () => void;
-    };
+    getWithAuth(forceToken?: boolean): Promise<string>;
+    _setLastToken(lastToken: string | null): void;
+    withRetry<T>(promiseFactory: () => Promise<{
+        data: T;
+        errors: Error[];
+    }>, retry?: boolean): Promise<{
+        data: T;
+        errors: Error[];
+    }>;
+    invokeQuery: <T, U>(queryName: string, body?: U) => PromiseLike<{
+        data: T;
+        errors: Error[];
+    }>;
+    invokeMutation: <T, U>(queryName: string, body?: U) => PromiseLike<{
+        data: T;
+        errors: Error[];
+    }>;
 }

package/dist/node-esm/src/util/validateArgs.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ConnectorConfig, DataConnect } from '../api/DataConnect';
+interface ParsedArgs<Variables> {
+    dc: DataConnect;
+    vars: Variables;
+}
+/**
+ * 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>;
+export {};

package/dist/private.d.ts

@@ -8,7 +8,7 @@ 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 { FirebaseOptions } from '@firebase/app-types';
 import { LogLevelString } from '@firebase/logger';
 import { Provider } from '@firebase/component';
 
@@ -25,14 +25,27 @@ 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;
@@ -45,7 +58,9 @@ export declare class DataConnect {
     private _transportClass;
     private _transportOptions?;
     private _authTokenProvider?;
+    _isUsingGeneratedSdk: boolean;
     constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider<FirebaseAuthInternalName>);
+    _useGeneratedSdk(): void;
     _delete(): Promise<void>;
     getSettings(): ConnectorConfig;
     setInitialized(): void;
@@ -76,8 +91,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,6 +104,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,8 +128,18 @@ 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";
@@ -124,19 +155,26 @@ export declare class FirebaseAuthProvider implements AuthTokenProvider {
     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";
 
-export declare class MutationManager {
-    private _transport;
-    private _inflight;
-    constructor(_transport: DataConnectTransport);
-    executeMutation<Data, Variables>(mutationRef: MutationRef<Data, Variables>): MutationPromise<Data, Variables>;
-}
+/* Excluded from this release type: MutationManager */
 
+/**
+ * Mutation return value from `executeMutation`
+ */
 export declare interface MutationPromise<Data, Variables> extends PromiseLike<MutationResult<Data, Variables>> {
 }
 
@@ -144,21 +182,44 @@ 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 +235,11 @@ export declare interface OpResult<Data> {
     fetchTime: string;
 }
 
+declare interface ParsedArgs<Variables> {
+    dc: DataConnect;
+    vars: Variables;
+}
+
 /* Excluded from this release type: parseOptions */
 
 export declare const QUERY_STR = "query";
@@ -182,35 +248,63 @@ 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;
@@ -222,6 +316,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>;
 }
@@ -233,27 +330,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'>;
@@ -262,12 +377,19 @@ declare interface TrackedQuery<Data, Variables> {
     lastError: DataConnectError | null;
 }
 
-export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions) => DataConnectTransport;
+export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions, _isUsingGen?: boolean) => DataConnectTransport;
 
+/**
+ * Options to connect to emulator
+ */
 export declare interface TransportOptions {
     host: string;
     sslEnabled?: boolean;
     port?: number;
 }
 
+/* Excluded from this release type: validateArgs */
+
+/* Excluded from this release type: validateDCOptions */
+
 export { }