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

package/dist/index.node.cjs.js

@@ -30,7 +30,8 @@ var Code = {
     NOT_INITIALIZED: 'not-initialized',
     NOT_SUPPORTED: 'not-supported',
     INVALID_ARGUMENT: 'invalid-argument',
-    PARTIAL_ERROR: 'partial-error'
+    PARTIAL_ERROR: 'partial-error',
+    UNAUTHORIZED: 'unauthorized'
 };
 /** An error returned by a DataConnect operation. */
 var DataConnectError = /** @class */ (function (_super) {
@@ -130,14 +131,22 @@ var connectFetch = globalThis.fetch;
 function initializeFetch(fetchImpl) {
     connectFetch = fetchImpl;
 }
-function dcFetch(url, body, _a, accessToken) {
+function getGoogApiClientValue(_isUsingGen) {
+    var str = 'gl-js/ fire/' + SDK_VERSION;
+    if (_isUsingGen) {
+        str += ' web/gen';
+    }
+    return str;
+}
+function dcFetch(url, body, _a, accessToken, _isUsingGen) {
     var _this = this;
     var signal = _a.signal;
     if (!connectFetch) {
         throw new DataConnectError(Code.OTHER, 'No Fetch Implementation detected!');
     }
     var headers = {
-        'Content-Type': 'application/json'
+        'Content-Type': 'application/json',
+        'X-Goog-Api-Client': getGoogApiClientValue(_isUsingGen)
     };
     if (accessToken) {
         headers['X-Firebase-Auth-Token'] = accessToken;
@@ -149,11 +158,12 @@ function dcFetch(url, body, _a, accessToken) {
         method: 'POST',
         headers: headers,
         signal: signal
-    }).catch(function (err) {
-        throw new DataConnectError(Code.OTHER, "Failed to fetch: " + JSON.stringify(err));
+    })
+        .catch(function (err) {
+        throw new DataConnectError(Code.OTHER, 'Failed to fetch: ' + JSON.stringify(err));
     })
         .then(function (response) { return tslib.__awaiter(_this, void 0, void 0, function () {
-        var jsonResponse, e_1;
+        var jsonResponse, e_1, message;
         return tslib.__generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
@@ -169,9 +179,13 @@ function dcFetch(url, body, _a, accessToken) {
                     e_1 = _a.sent();
                     throw new DataConnectError(Code.OTHER, JSON.stringify(e_1));
                 case 4:
+                    message = getMessage(jsonResponse);
                     if (response.status >= 400) {
                         logError('Error while performing request: ' + JSON.stringify(jsonResponse));
-                        throw new DataConnectError(Code.OTHER, JSON.stringify(jsonResponse));
+                        if (response.status === 401) {
+                            throw new DataConnectError(Code.UNAUTHORIZED, message);
+                        }
+                        throw new DataConnectError(Code.OTHER, message);
                     }
                     return [2 /*return*/, jsonResponse];
             }
@@ -185,10 +199,16 @@ function dcFetch(url, body, _a, accessToken) {
         }
         return res;
     });
+}
+function getMessage(obj) {
+    if ('message' in obj) {
+        return obj.message;
+    }
+    return JSON.stringify(obj);
 }
 
 var name = "@firebase/data-connect";
-var version = "0.0.2-dataconnect-preview.877f8b7d0";
+var version = "0.0.3-dataconnect-preview.d986d4bf2";
 
 /**
  * @license
@@ -250,7 +270,8 @@ var FirebaseAuthProvider = /** @class */ (function () {
     FirebaseAuthProvider.prototype.removeTokenChangeListener = function (listener) {
         this._authProvider
             .get()
-            .then(function (auth) { return auth.removeAuthTokenListener(listener); });
+            .then(function (auth) { return auth.removeAuthTokenListener(listener); })
+            .catch(function (err) { return logError(err); });
     };
     return FirebaseAuthProvider;
 }());
@@ -521,11 +542,13 @@ function addToken(url, apiKey) {
  * limitations under the License.
  */
 var RESTTransport = /** @class */ (function () {
-    function RESTTransport(options, apiKey, authProvider, transportOptions) {
+    function RESTTransport(options, apiKey, authProvider, transportOptions, _isUsingGen) {
+        if (_isUsingGen === void 0) { _isUsingGen = false; }
         var _this = this;
         var _a;
         this.apiKey = apiKey;
         this.authProvider = authProvider;
+        this._isUsingGen = _isUsingGen;
         this._host = '';
         this._location = 'l';
         this._connectorName = '';
@@ -533,30 +556,32 @@ var RESTTransport = /** @class */ (function () {
         this._project = 'p';
         this._accessToken = null;
         this._authInitialized = false;
+        this._lastToken = null;
         // TODO(mtewani): Update U to include shape of body defined in line 13.
         this.invokeQuery = function (queryName, body) {
             var abortController = new AbortController();
             // TODO(mtewani): Update to proper value
-            var withAuth = _this.getWithAuth().then(function () {
+            var withAuth = _this.withRetry(function () {
                 return dcFetch(addToken("".concat(_this.endpointUrl, ":executeQuery"), _this.apiKey), {
                     name: "projects/".concat(_this._project, "/locations/").concat(_this._location, "/services/").concat(_this._serviceName, "/connectors/").concat(_this._connectorName),
                     operationName: queryName,
                     variables: body
                 }, // TODO(mtewani): This is a patch, fix this.
-                abortController, _this._accessToken);
+                abortController, _this._accessToken, _this._isUsingGen);
             });
             return {
-                then: withAuth.then.bind(withAuth)
+                then: withAuth.then.bind(withAuth),
+                catch: withAuth.catch.bind(withAuth)
             };
         };
         this.invokeMutation = function (mutationName, body) {
             var abortController = new AbortController();
-            var taskResult = _this.getWithAuth().then(function () {
+            var taskResult = _this.withRetry(function () {
                 return dcFetch(addToken("".concat(_this.endpointUrl, ":executeMutation"), _this.apiKey), {
                     name: "projects/".concat(_this._project, "/locations/").concat(_this._location, "/services/").concat(_this._serviceName, "/connectors/").concat(_this._connectorName),
                     operationName: mutationName,
                     variables: body
-                }, abortController, _this._accessToken);
+                }, abortController, _this._accessToken, _this._isUsingGen);
             });
             return {
                 then: taskResult.then.bind(taskResult),
@@ -615,15 +640,16 @@ var RESTTransport = /** @class */ (function () {
     RESTTransport.prototype.onTokenChanged = function (newToken) {
         this._accessToken = newToken;
     };
-    RESTTransport.prototype.getWithAuth = function () {
+    RESTTransport.prototype.getWithAuth = function (forceToken) {
         var _this = this;
+        if (forceToken === void 0) { forceToken = false; }
         var starterPromise = new Promise(function (resolve) {
             return resolve(_this._accessToken);
         });
         if (!this._authInitialized) {
             if (this.authProvider) {
                 starterPromise = this.authProvider
-                    .getToken(/*forceToken=*/ false)
+                    .getToken(/*forceToken=*/ forceToken)
                     .then(function (data) {
                     if (!data) {
                         return null;
@@ -638,6 +664,32 @@ var RESTTransport = /** @class */ (function () {
         }
         return starterPromise;
     };
+    RESTTransport.prototype._setLastToken = function (lastToken) {
+        this._lastToken = lastToken;
+    };
+    RESTTransport.prototype.withRetry = function (promiseFactory, retry) {
+        var _this = this;
+        if (retry === void 0) { retry = false; }
+        var isNewToken = false;
+        return this.getWithAuth(retry)
+            .then(function (res) {
+            isNewToken = _this._lastToken !== res;
+            _this._lastToken = res;
+            return res;
+        })
+            .then(promiseFactory)
+            .catch(function (err) {
+            // Only retry if the result is unauthorized and the last token isn't the same as the new one.
+            if ('code' in err &&
+                err.code === Code.UNAUTHORIZED &&
+                !retry &&
+                isNewToken) {
+                logDebug('Retrying due to unauthorized');
+                return _this.withRetry(promiseFactory, true);
+            }
+            throw err;
+        });
+    };
     return RESTTransport;
 }());
 
@@ -657,16 +709,26 @@ var RESTTransport = /** @class */ (function () {
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-function mutationRef(dcInstance, queryName, variables) {
+/**
+ *
+ * @param dcInstance Data Connect instance
+ * @param mutationName name of mutation
+ * @param variables variables to send with mutation
+ * @returns `MutationRef`
+ */
+function mutationRef(dcInstance, mutationName, variables) {
     dcInstance.setInitialized();
     var ref = {
         dataConnect: dcInstance,
-        name: queryName,
+        name: mutationName,
         refType: MUTATION_STR,
         variables: variables
     };
     return ref;
 }
+/**
+ * @internal
+ */
 var MutationManager = /** @class */ (function () {
     function MutationManager(_transport) {
         this._transport = _transport;
@@ -688,6 +750,11 @@ var MutationManager = /** @class */ (function () {
     };
     return MutationManager;
 }());
+/**
+ * Execute Mutation
+ * @param mutationRef mutation to execute
+ * @returns `MutationRef`
+ */
 function executeMutation(mutationRef) {
     return mutationRef.dataConnect._mutationManager.executeMutation(mutationRef);
 }
@@ -722,6 +789,9 @@ function parseOptions(fullHost) {
     var port = Number(portAsString);
     return { host: host, port: port, sslEnabled: isSecure };
 }
+/**
+ * Class representing Firebase Data Connect
+ */
 var DataConnect = /** @class */ (function () {
     function DataConnect(app, 
     // TODO(mtewani): Replace with _dataConnectOptions in the future
@@ -731,6 +801,7 @@ var DataConnect = /** @class */ (function () {
         this._authProvider = _authProvider;
         this.isEmulator = false;
         this.initialized = false;
+        this._isUsingGeneratedSdk = false;
         if (typeof process !== 'undefined' && process.env) {
             var host = process.env[FIREBASE_DATA_CONNECT_EMULATOR_HOST_VAR];
             if (host) {
@@ -740,6 +811,14 @@ var DataConnect = /** @class */ (function () {
             }
         }
     }
+    /*
+      @internal
+    */
+    DataConnect.prototype._useGeneratedSdk = function () {
+        if (!this._isUsingGeneratedSdk) {
+            this._isUsingGeneratedSdk = true;
+        }
+    };
     DataConnect.prototype._delete = function () {
         app._removeServiceInstance(this.app, 'data-connect', JSON.stringify(this.getSettings()));
         return Promise.resolve();
@@ -761,7 +840,7 @@ var DataConnect = /** @class */ (function () {
             this._authTokenProvider = new FirebaseAuthProvider(this.app.name, this.app.options, this._authProvider);
         }
         this.initialized = true;
-        this._transport = new this._transportClass(this.dataConnectOptions, this.app.options.apiKey, this._authTokenProvider);
+        this._transport = new this._transportClass(this.dataConnectOptions, this.app.options.apiKey, this._authTokenProvider, undefined, this._isUsingGeneratedSdk);
         if (this._transportOptions) {
             this._transport.useEmulator(this._transportOptions.host, this._transportOptions.port, this._transportOptions.sslEnabled);
         }
@@ -778,6 +857,13 @@ var DataConnect = /** @class */ (function () {
     };
     return DataConnect;
 }());
+/**
+ * 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
+ */
 function connectDataConnectEmulator(dc, host, port, sslEnabled) {
     if (sslEnabled === void 0) { sslEnabled = false; }
     dc.enableEmulator({ host: host, port: port, sslEnabled: sslEnabled });
@@ -793,7 +879,7 @@ function getDataConnect(appOrOptions, optionalOptions) {
         dcOptions = optionalOptions;
         app$1 = appOrOptions;
     }
-    if (!app$1) {
+    if (!app$1 || Object.keys(app$1).length === 0) {
         app$1 = app.getApp();
     }
     var provider = app._getProvider(app$1, 'data-connect');
@@ -807,9 +893,7 @@ function getDataConnect(appOrOptions, optionalOptions) {
             return dcInstance;
         }
     }
-    if (!dcOptions) {
-        throw new DataConnectError(Code.INVALID_ARGUMENT, 'DC Option Required');
-    }
+    validateDCOptions(dcOptions);
     logDebug('Creating new DataConnect instance');
     // Initialize with options.
     return provider.initialize({
@@ -817,6 +901,29 @@ function getDataConnect(appOrOptions, optionalOptions) {
         options: dcOptions
     });
 }
+/**
+ *
+ * @param dcOptions
+ * @returns {void}
+ * @internal
+ */
+function validateDCOptions(dcOptions) {
+    var fields = ['connector', 'location', 'service'];
+    if (!dcOptions) {
+        throw new DataConnectError(Code.INVALID_ARGUMENT, 'DC Option Required');
+    }
+    fields.forEach(function (field) {
+        if (dcOptions[field] === null || dcOptions[field] === undefined) {
+            throw new DataConnectError(Code.INVALID_ARGUMENT, "".concat(field, " Required"));
+        }
+    });
+    return true;
+}
+/**
+ * Delete DataConnect instance
+ * @param dataConnect DataConnect instance
+ * @returns
+ */
 function terminate(dataConnect) {
     return dataConnect._delete();
     // TODO(mtewani): Stop pending tasks
@@ -832,6 +939,9 @@ function registerDataConnect(variant) {
         if (settings) {
             newOpts = JSON.parse(settings);
         }
+        if (!app.options.projectId) {
+            throw new DataConnectError(Code.INVALID_ARGUMENT, 'Project ID must be provided. Did you pass in a proper projectId to initializeApp?');
+        }
         return new DataConnect(app, tslib.__assign(tslib.__assign({}, newOpts), { projectId: app.options.projectId }), authProvider);
     }, "PUBLIC" /* ComponentType.PUBLIC */).setMultipleInstances(true));
     app.registerVersion(name, version, variant);
@@ -855,9 +965,22 @@ function registerDataConnect(variant) {
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * Execute Query
+ * @param queryRef query to execute.
+ * @returns `QueryPromise`
+ */
 function executeQuery(queryRef) {
     return queryRef.dataConnect._queryManager.executeQuery(queryRef);
 }
+/**
+ * Execute Query
+ * @param dcInstance Data Connect instance to use.
+ * @param queryName Query to execute
+ * @param variables Variables to execute with
+ * @param initialCache initial cache to use for client hydration
+ * @returns `QueryRef`
+ */
 function queryRef(dcInstance, queryName, variables, initialCache) {
     dcInstance.setInitialized();
     dcInstance._queryManager.track(queryName, variables, initialCache);
@@ -868,6 +991,11 @@ function queryRef(dcInstance, queryName, variables, initialCache) {
         variables: variables
     };
 }
+/**
+ * Converts serialized ref to query ref
+ * @param serializedRef ref to convert to `QueryRef`
+ * @returns `QueryRef`
+ */
 function toQueryRef(serializedRef) {
     var _a = serializedRef.refInfo, name = _a.name, variables = _a.variables, connectorConfig = _a.connectorConfig;
     return queryRef(getDataConnect(connectorConfig), name, variables);
@@ -889,6 +1017,57 @@ function toQueryRef(serializedRef) {
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * 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
+ */
+function validateArgs(connectorConfig, dcOrVars, vars, validateVars) {
+    var dcInstance;
+    var realVars;
+    if (dcOrVars && 'enableEmulator' in dcOrVars) {
+        dcInstance = dcOrVars;
+        realVars = vars;
+    }
+    else {
+        dcInstance = getDataConnect(connectorConfig);
+        realVars = dcOrVars;
+    }
+    if (!dcInstance || (!realVars && validateVars)) {
+        throw new DataConnectError(Code.INVALID_ARGUMENT, 'Variables required.');
+    }
+    return { dc: dcInstance, vars: realVars };
+}
+
+/**
+ * @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.
+ */
+/**
+ * Subscribe to a `QueryRef`
+ * @param queryRefOrSerializedResult query ref or serialized result.
+ * @param observerOrOnNext observer object or next function.
+ * @param onError Callback to call when error gets thrown.
+ * @param onComplete Called when subscription completes.
+ * @returns `SubscriptionOptions`
+ */
 function subscribe(queryRefOrSerializedResult, observerOrOnNext, onError, onComplete) {
     var ref;
     var initialCache;
@@ -958,4 +1137,6 @@ exports.setLogLevel = setLogLevel;
 exports.subscribe = subscribe;
 exports.terminate = terminate;
 exports.toQueryRef = toQueryRef;
+exports.validateArgs = validateArgs;
+exports.validateDCOptions = validateDCOptions;
 //# sourceMappingURL=index.node.cjs.js.map