@firebase/data-connect 0.2.0-canary.2f92a7402 → 0.2.0-canary.313faf66b

package/dist/internal.d.ts

@@ -42,6 +42,21 @@ declare interface AuthTokenProvider {
     addTokenChangeListener(listener: AuthTokenListener): void;
 }
 
+/**
+ * enum representing different flavors of the SDK used by developers
+ * use the CallerSdkType for type-checking, and the CallerSdkTypeEnum for value-checking/assigning
+ */
+export declare type CallerSdkType = 'Base' | 'Generated' | 'TanstackReactCore' | 'GeneratedReact' | 'TanstackAngularCore' | 'GeneratedAngular';
+
+export declare const CallerSdkTypeEnum: {
+    readonly Base: "Base";
+    readonly Generated: "Generated";
+    readonly TanstackReactCore: "TanstackReactCore";
+    readonly GeneratedReact: "GeneratedReact";
+    readonly TanstackAngularCore: "TanstackAngularCore";
+    readonly GeneratedAngular: "GeneratedAngular";
+};
+
 /**
  * Connect to the DataConnect Emulator
  * @param dc Data Connect instance
@@ -77,9 +92,11 @@ export declare class DataConnect {
     private _transportOptions?;
     private _authTokenProvider?;
     _isUsingGeneratedSdk: boolean;
+    _callerSdkType: CallerSdkType;
     private _appCheckTokenProvider?;
     constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider<FirebaseAuthInternalName>, _appCheckProvider: Provider<AppCheckInternalComponentName>);
     _useGeneratedSdk(): void;
+    _setCallerSdkType(callerSdkType: CallerSdkType): void;
     _delete(): Promise<void>;
     getSettings(): ConnectorConfig;
     setInitialized(): void;
@@ -146,6 +163,7 @@ export declare interface DataConnectTransport {
     }>;
     useEmulator(host: string, port?: number, sslEnabled?: boolean): void;
     onTokenChanged: (token: string | null) => void;
+    _setCallerSdkType(callerSdkType: CallerSdkType): void;
 }
 
 export declare type DataSource = typeof SOURCE_CACHE | typeof SOURCE_SERVER;
@@ -392,7 +410,7 @@ declare interface TrackedQuery<Data, Variables> {
 /**
  * @internal
  */
-export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, appId?: string, authProvider?: AuthTokenProvider, appCheckProvider?: AppCheckTokenProvider, transportOptions?: TransportOptions, _isUsingGen?: boolean) => DataConnectTransport;
+export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, appId?: string, authProvider?: AuthTokenProvider, appCheckProvider?: AppCheckTokenProvider, transportOptions?: TransportOptions, _isUsingGen?: boolean, _callerSdkType?: CallerSdkType) => DataConnectTransport;
 
 /**
  * Options to connect to emulator

package/dist/node-esm/index.node.esm.js

@@ -103,6 +103,31 @@ function logError(msg) {
     logger.error(`DataConnect (${SDK_VERSION}): ${msg}`);
 }
 
+/**
+ * @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.
+ */
+const CallerSdkTypeEnum = {
+    Base: 'Base', // Core JS SDK
+    Generated: 'Generated', // Generated JS SDK
+    TanstackReactCore: 'TanstackReactCore', // Tanstack non-generated React SDK
+    GeneratedReact: 'GeneratedReact', // Tanstack non-generated Angular SDK
+    TanstackAngularCore: 'TanstackAngularCore', // Tanstack non-generated Angular SDK
+    GeneratedAngular: 'GeneratedAngular' // Generated Angular SDK
+};
+
 /**
  * @license
  * Copyright 2024 Google LLC
@@ -123,20 +148,24 @@ let connectFetch = globalThis.fetch;
 function initializeFetch(fetchImpl) {
     connectFetch = fetchImpl;
 }
-function getGoogApiClientValue(_isUsingGen) {
+function getGoogApiClientValue(_isUsingGen, _callerSdkType) {
     let str = 'gl-js/ fire/' + SDK_VERSION;
-    if (_isUsingGen) {
+    if (_callerSdkType !== CallerSdkTypeEnum.Base &&
+        _callerSdkType !== CallerSdkTypeEnum.Generated) {
+        str += ' js/' + _callerSdkType.toLowerCase();
+    }
+    else if (_isUsingGen || _callerSdkType === CallerSdkTypeEnum.Generated) {
         str += ' js/gen';
     }
     return str;
 }
-function dcFetch(url, body, { signal }, appId, accessToken, appCheckToken, _isUsingGen) {
+function dcFetch(url, body, { signal }, appId, accessToken, appCheckToken, _isUsingGen, _callerSdkType) {
     if (!connectFetch) {
         throw new DataConnectError(Code.OTHER, 'No Fetch Implementation detected!');
     }
     const headers = {
         'Content-Type': 'application/json',
-        'X-Goog-Api-Client': getGoogApiClientValue(_isUsingGen)
+        'X-Goog-Api-Client': getGoogApiClientValue(_isUsingGen, _callerSdkType)
     };
     if (accessToken) {
         headers['X-Firebase-Auth-Token'] = accessToken;
@@ -193,7 +222,7 @@ function getMessage(obj) {
 }
 
 const name = "@firebase/data-connect";
-const version = "0.2.0-canary.2f92a7402";
+const version = "0.2.0-canary.313faf66b";
 
 /**
  * @license
@@ -585,13 +614,14 @@ function addToken(url, apiKey) {
  * limitations under the License.
  */
 class RESTTransport {
-    constructor(options, apiKey, appId, authProvider, appCheckProvider, transportOptions, _isUsingGen = false) {
+    constructor(options, apiKey, appId, authProvider, appCheckProvider, transportOptions, _isUsingGen = false, _callerSdkType = CallerSdkTypeEnum.Base) {
         var _a, _b;
         this.apiKey = apiKey;
         this.appId = appId;
         this.authProvider = authProvider;
         this.appCheckProvider = appCheckProvider;
         this._isUsingGen = _isUsingGen;
+        this._callerSdkType = _callerSdkType;
         this._host = '';
         this._location = 'l';
         this._connectorName = '';
@@ -608,7 +638,7 @@ class RESTTransport {
                 name: `projects/${this._project}/locations/${this._location}/services/${this._serviceName}/connectors/${this._connectorName}`,
                 operationName: queryName,
                 variables: body
-            }, abortController, this.appId, this._accessToken, this._appCheckToken, this._isUsingGen));
+            }, abortController, this.appId, this._accessToken, this._appCheckToken, this._isUsingGen, this._callerSdkType));
             return withAuth;
         };
         this.invokeMutation = (mutationName, body) => {
@@ -618,7 +648,7 @@ class RESTTransport {
                     name: `projects/${this._project}/locations/${this._location}/services/${this._serviceName}/connectors/${this._connectorName}`,
                     operationName: mutationName,
                     variables: body
-                }, abortController, this.appId, this._accessToken, this._appCheckToken, this._isUsingGen);
+                }, abortController, this.appId, this._accessToken, this._appCheckToken, this._isUsingGen, this._callerSdkType);
             });
             return taskResult;
         };
@@ -719,6 +749,9 @@ class RESTTransport {
             throw err;
         });
     }
+    _setCallerSdkType(callerSdkType) {
+        this._callerSdkType = callerSdkType;
+    }
 }
 
 /**
@@ -828,6 +861,7 @@ class DataConnect {
         this.isEmulator = false;
         this._initialized = false;
         this._isUsingGeneratedSdk = false;
+        this._callerSdkType = CallerSdkTypeEnum.Base;
         if (typeof process !== 'undefined' && process.env) {
             const host = process.env[FIREBASE_DATA_CONNECT_EMULATOR_HOST_VAR];
             if (host) {
@@ -843,6 +877,12 @@ class DataConnect {
             this._isUsingGeneratedSdk = true;
         }
     }
+    _setCallerSdkType(callerSdkType) {
+        this._callerSdkType = callerSdkType;
+        if (this._initialized) {
+            this._transport._setCallerSdkType(callerSdkType);
+        }
+    }
     _delete() {
         _removeServiceInstance(this.app, 'data-connect', JSON.stringify(this.getSettings()));
         return Promise.resolve();
@@ -869,7 +909,7 @@ class DataConnect {
             this._appCheckTokenProvider = new AppCheckTokenProvider(this.app, this._appCheckProvider);
         }
         this._initialized = true;
-        this._transport = new this._transportClass(this.dataConnectOptions, this.app.options.apiKey, this.app.options.appId, this._authTokenProvider, this._appCheckTokenProvider, undefined, this._isUsingGeneratedSdk);
+        this._transport = new this._transportClass(this.dataConnectOptions, this.app.options.apiKey, this.app.options.appId, this._authTokenProvider, this._appCheckTokenProvider, undefined, this._isUsingGeneratedSdk, this._callerSdkType);
         if (this._transportOptions) {
             this._transport.useEmulator(this._transportOptions.host, this._transportOptions.port, this._transportOptions.sslEnabled);
         }
@@ -1174,5 +1214,5 @@ function subscribe(queryRefOrSerializedResult, observerOrOnNext, onError, onComp
 initializeFetch(fetch);
 registerDataConnect('node');
 
-export { DataConnect, MUTATION_STR, MutationManager, QUERY_STR, SOURCE_CACHE, SOURCE_SERVER, areTransportOptionsEqual, connectDataConnectEmulator, executeMutation, executeQuery, getDataConnect, mutationRef, parseOptions, queryRef, setLogLevel, subscribe, terminate, toQueryRef, validateArgs, validateDCOptions };
+export { CallerSdkTypeEnum, DataConnect, MUTATION_STR, MutationManager, QUERY_STR, SOURCE_CACHE, SOURCE_SERVER, areTransportOptionsEqual, connectDataConnectEmulator, executeMutation, executeQuery, getDataConnect, mutationRef, parseOptions, queryRef, setLogLevel, subscribe, terminate, toQueryRef, validateArgs, validateDCOptions };
 //# sourceMappingURL=index.node.esm.js.map