@firebase/data-connect 0.0.2-dataconnect-preview.388b61c7e → 0.0.3-dataconnect-preview.d986d4bf2

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';
 
@@ -58,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;
@@ -89,7 +91,7 @@ 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
@@ -233,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";
@@ -241,7 +248,7 @@ 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;
@@ -361,7 +368,7 @@ export declare function terminate(dataConnect: DataConnect): Promise<void>;
  * @param serializedRef ref to convert to `QueryRef`
  * @returns `QueryRef`
  */
-export declare function toQueryRef<Data, Variables>(serializedRef: SerializedRef<Data, Variables>): QueryRef<unknown, Variables>;
+export declare function toQueryRef<Data, Variables>(serializedRef: SerializedRef<Data, Variables>): QueryRef<Data, Variables>;
 
 declare interface TrackedQuery<Data, Variables> {
     ref: Omit<OperationRef<Data, Variables>, 'dataConnect'>;
@@ -370,7 +377,7 @@ 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
@@ -381,4 +388,8 @@ export declare interface TransportOptions {
     port?: number;
 }
 
+/* Excluded from this release type: validateArgs */
+
+/* Excluded from this release type: validateDCOptions */
+
 export { }

package/dist/public.d.ts

@@ -4,7 +4,7 @@
  * @packageDocumentation
  */
 import { FirebaseApp } from '@firebase/app';
-import { FirebaseOptions } from '@firebase/app';
+import { FirebaseOptions } from '@firebase/app-types';
 import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 import { FirebaseAuthTokenData } from '@firebase/auth-interop-types';
 import { Provider } from '@firebase/component';
@@ -262,8 +262,8 @@ export declare function terminate(dataConnect: DataConnect): Promise<void>;
  * @param serializedRef ref to convert to `QueryRef`
  * @returns `QueryRef`
  */
-export declare function toQueryRef<Data, Variables>(serializedRef: SerializedRef<Data, Variables>): QueryRef<unknown, Variables>;
-export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions) => DataConnectTransport;
+export declare function toQueryRef<Data, Variables>(serializedRef: SerializedRef<Data, Variables>): QueryRef<Data, Variables>;
+export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions, _isUsingGen?: boolean) => DataConnectTransport;
 /**
  * Options to connect to emulator
  */
@@ -272,4 +272,6 @@ export declare interface TransportOptions {
     sslEnabled?: boolean;
     port?: number;
 }
+/* Excluded from this release type: validateArgs */
+/* Excluded from this release type: validateDCOptions */
 export {};

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

@@ -64,7 +64,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;
@@ -89,6 +91,13 @@ export declare function getDataConnect(options: ConnectorConfig): DataConnect;
  * @param options ConnectorConfig
  */
 export declare function getDataConnect(app: FirebaseApp, options: ConnectorConfig): DataConnect;
+/**
+ *
+ * @param dcOptions
+ * @returns {void}
+ * @internal
+ */
+export declare function validateDCOptions(dcOptions: ConnectorConfig): boolean;
 /**
  * Delete DataConnect instance
  * @param dataConnect DataConnect instance

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

@@ -20,3 +20,4 @@ export * from './Reference';
 export * from './Mutation';
 export * from './query';
 export { setLogLevel } from '../logger';
+export { validateArgs } from '../util/validateArgs';

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

@@ -81,7 +81,7 @@ export declare function queryRef<Data, Variables>(dcInstance: DataConnect, query
  * @param serializedRef ref to convert to `QueryRef`
  * @returns `QueryRef`
  */
-export declare function toQueryRef<Data, Variables>(serializedRef: SerializedRef<Data, Variables>): QueryRef<unknown, Variables>;
+export declare function toQueryRef<Data, Variables>(serializedRef: SerializedRef<Data, Variables>): QueryRef<Data, Variables>;
 /**
  * `OnCompleteSubscription`
  */

package/dist/src/core/FirebaseAuthProvider.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { FirebaseOptions } from '@firebase/app';
+import { FirebaseOptions } from '@firebase/app-types';
 import { FirebaseAuthInternalName, FirebaseAuthTokenData } from '@firebase/auth-interop-types';
 import { Provider } from '@firebase/component';
 export interface AuthTokenProvider {

package/dist/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/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/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/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/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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/data-connect",
-  "version": "0.0.2-dataconnect-preview.388b61c7e",
+  "version": "0.0.3-dataconnect-preview.d986d4bf2",
   "description": "",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "main": "dist/index.node.cjs.js",
@@ -38,6 +38,7 @@
     "test:all": "npm run test:node",
     "test:browser": "karma start --single-run",
     "test:node": "TS_NODE_FILES=true TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --file src/index.node.ts --config ../../config/mocharc.node.js",
+    "test:unit": "TS_NODE_FILES=true TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/unit/**/*.test.ts' --file src/index.node.ts --config ../../config/mocharc.node.js",
     "test:emulator": "ts-node --compiler-options='{\"module\":\"commonjs\"}' ../../scripts/emulator-testing/dataconnect-test-runner.ts",
     "api-report": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' ts-node ../../repo-scripts/prune-dts/extract-public-api.ts --package data-connect --packageRoot . --typescriptDts ./dist/src/index.d.ts --rollupDts ./dist/private.d.ts --untrimmedRollupDts ./dist/internal.d.ts --publicDts ./dist/public.d.ts && yarn api-report:api-json",
     "api-report:api-json": "rm -rf temp && api-extractor run --local --verbose",
@@ -45,15 +46,18 @@
     "typings:public": "node ../../scripts/build/use_typings.js ./dist/public.d.ts"
   },
   "license": "Apache-2.0",
+  "peerDependencies": {
+    "@firebase/app": "0.10.7-dataconnect-preview.d986d4bf2"
+  },
   "dependencies": {
-    "@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",
+    "@firebase/auth-interop-types": "0.2.3-dataconnect-preview.d986d4bf2",
+    "@firebase/component": "0.6.8-dataconnect-preview.d986d4bf2",
+    "@firebase/logger": "0.4.2-dataconnect-preview.d986d4bf2",
+    "@firebase/util": "1.9.7-dataconnect-preview.d986d4bf2",
     "tslib": "^2.1.0"
   },
   "devDependencies": {
-    "@firebase/app": "0.10.3-dataconnect-preview.388b61c7e",
+    "@firebase/app": "0.10.7-dataconnect-preview.d986d4bf2",
     "rollup": "2.79.1",
     "rollup-plugin-typescript2": "0.31.2",
     "typescript": "4.7.4"