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

package/dist/index.cjs.js

@@ -8,7 +8,7 @@ var util = require('@firebase/util');
 var logger$1 = require('@firebase/logger');
 
 const name = "@firebase/data-connect";
-const version = "0.0.2-dataconnect-preview.877f8b7d0";
+const version = "0.0.3-canary.beaa4dffb";
 
 /**
  * @license
@@ -36,6 +36,60 @@ function setSDKVersion(version) {
     SDK_VERSION = version;
 }
 
+/**
+ * @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.
+ */
+/**
+ * @internal
+ * Abstraction around AppCheck's token fetching capabilities.
+ */
+class AppCheckTokenProvider {
+    constructor(appName_, appCheckProvider) {
+        this.appName_ = appName_;
+        this.appCheckProvider = appCheckProvider;
+        this.appCheck = appCheckProvider === null || appCheckProvider === void 0 ? void 0 : appCheckProvider.getImmediate({ optional: true });
+        if (!this.appCheck) {
+            void (appCheckProvider === null || appCheckProvider === void 0 ? void 0 : appCheckProvider.get().then(appCheck => (this.appCheck = appCheck)).catch());
+        }
+    }
+    getToken(forceRefresh) {
+        if (!this.appCheck) {
+            return new Promise((resolve, reject) => {
+                // Support delayed initialization of FirebaseAppCheck. This allows our
+                // customers to initialize the RTDB SDK before initializing Firebase
+                // AppCheck and ensures that all requests are authenticated if a token
+                // becomes available before the timoeout below expires.
+                setTimeout(() => {
+                    if (this.appCheck) {
+                        this.getToken(forceRefresh).then(resolve, reject);
+                    }
+                    else {
+                        resolve(null);
+                    }
+                }, 0);
+            });
+        }
+        return this.appCheck.getToken(forceRefresh);
+    }
+    addTokenChangeListener(listener) {
+        var _a;
+        void ((_a = this.appCheckProvider) === null || _a === void 0 ? void 0 : _a.get().then(appCheck => appCheck.addTokenListener(listener)));
+    }
+}
+
 /**
  * @license
  * Copyright 2024 Google LLC
@@ -58,7 +112,8 @@ const 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. */
 class DataConnectError extends util.FirebaseError {
@@ -125,6 +180,7 @@ function logError(msg) {
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+// @internal
 class FirebaseAuthProvider {
     constructor(_appName, _options, _authProvider) {
         this._appName = _appName;
@@ -167,7 +223,8 @@ class FirebaseAuthProvider {
     removeTokenChangeListener(listener) {
         this._authProvider
             .get()
-            .then(auth => auth.removeAuthTokenListener(listener));
+            .then(auth => auth.removeAuthTokenListener(listener))
+            .catch(err => logError(err));
     }
 }
 
@@ -407,7 +464,7 @@ function urlBuilder(projectConfig, transportOptions) {
         logError('Port type is of an invalid type');
         throw new DataConnectError(Code.INVALID_ARGUMENT, 'Incorrect type for port passed in!');
     }
-    return `${baseUrl}/v1alpha/projects/${project}/locations/${location}/services/${service}/connectors/${connector}`;
+    return `${baseUrl}/v1beta/projects/${project}/locations/${location}/services/${service}/connectors/${connector}`;
 }
 function addToken(url, apiKey) {
     if (!apiKey) {
@@ -435,16 +492,30 @@ function addToken(url, apiKey) {
  * limitations under the License.
  */
 let connectFetch = globalThis.fetch;
-function dcFetch(url, body, { signal }, accessToken) {
+function getGoogApiClientValue(_isUsingGen) {
+    let str = 'gl-js/ fire/' + SDK_VERSION;
+    if (_isUsingGen) {
+        str += ' web/gen';
+    }
+    return str;
+}
+function dcFetch(url, body, { signal }, appId, accessToken, appCheckToken, _isUsingGen) {
     if (!connectFetch) {
         throw new DataConnectError(Code.OTHER, 'No Fetch Implementation detected!');
     }
     const headers = {
-        'Content-Type': 'application/json'
+        'Content-Type': 'application/json',
+        'X-Goog-Api-Client': getGoogApiClientValue(_isUsingGen)
     };
     if (accessToken) {
         headers['X-Firebase-Auth-Token'] = accessToken;
     }
+    if (appId) {
+        headers['x-firebase-gmpid'] = appId;
+    }
+    if (appCheckToken) {
+        headers['X-Firebase-AppCheck'] = appCheckToken;
+    }
     const bodyStr = JSON.stringify(body);
     logDebug(`Making request out to ${url} with body: ${bodyStr}`);
     return connectFetch(url, {
@@ -452,8 +523,9 @@ function dcFetch(url, body, { signal }, accessToken) {
         method: 'POST',
         headers,
         signal
-    }).catch(err => {
-        throw new DataConnectError(Code.OTHER, "Failed to fetch: " + JSON.stringify(err));
+    })
+        .catch(err => {
+        throw new DataConnectError(Code.OTHER, 'Failed to fetch: ' + JSON.stringify(err));
     })
         .then(async (response) => {
         let jsonResponse = null;
@@ -463,9 +535,13 @@ function dcFetch(url, body, { signal }, accessToken) {
         catch (e) {
             throw new DataConnectError(Code.OTHER, JSON.stringify(e));
         }
+        const 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 jsonResponse;
     })
@@ -477,6 +553,12 @@ function dcFetch(url, body, { signal }, accessToken) {
         }
         return res;
     });
+}
+function getMessage(obj) {
+    if ('message' in obj) {
+        return obj.message;
+    }
+    return JSON.stringify(obj);
 }
 
 /**
@@ -496,41 +578,44 @@ function dcFetch(url, body, { signal }, accessToken) {
  * limitations under the License.
  */
 class RESTTransport {
-    constructor(options, apiKey, authProvider, transportOptions) {
-        var _a;
+    constructor(options, apiKey, appId, authProvider, appCheckProvider, transportOptions, _isUsingGen = false) {
+        var _a, _b;
         this.apiKey = apiKey;
+        this.appId = appId;
         this.authProvider = authProvider;
+        this.appCheckProvider = appCheckProvider;
+        this._isUsingGen = _isUsingGen;
         this._host = '';
         this._location = 'l';
         this._connectorName = '';
         this._secure = true;
         this._project = 'p';
         this._accessToken = null;
-        this._authInitialized = false;
+        this._appCheckToken = null;
+        this._lastToken = null;
         // TODO(mtewani): Update U to include shape of body defined in line 13.
         this.invokeQuery = (queryName, body) => {
             const abortController = new AbortController();
             // TODO(mtewani): Update to proper value
-            const withAuth = this.getWithAuth().then(() => {
-                return dcFetch(addToken(`${this.endpointUrl}:executeQuery`, this.apiKey), {
-                    name: `projects/${this._project}/locations/${this._location}/services/${this._serviceName}/connectors/${this._connectorName}`,
-                    operationName: queryName,
-                    variables: body
-                }, // TODO(mtewani): This is a patch, fix this.
-                abortController, this._accessToken);
-            });
+            const withAuth = this.withRetry(() => dcFetch(addToken(`${this.endpointUrl}:executeQuery`, this.apiKey), {
+                name: `projects/${this._project}/locations/${this._location}/services/${this._serviceName}/connectors/${this._connectorName}`,
+                operationName: queryName,
+                variables: body
+            }, // TODO(mtewani): This is a patch, fix this.
+            abortController, this.appId, this._accessToken, this._appCheckToken, this._isUsingGen));
             return {
-                then: withAuth.then.bind(withAuth)
+                then: withAuth.then.bind(withAuth),
+                catch: withAuth.catch.bind(withAuth)
             };
         };
         this.invokeMutation = (mutationName, body) => {
             const abortController = new AbortController();
-            const taskResult = this.getWithAuth().then(() => {
+            const taskResult = this.withRetry(() => {
                 return dcFetch(addToken(`${this.endpointUrl}:executeMutation`, this.apiKey), {
                     name: `projects/${this._project}/locations/${this._location}/services/${this._serviceName}/connectors/${this._connectorName}`,
                     operationName: mutationName,
                     variables: body
-                }, abortController, this._accessToken);
+                }, abortController, this.appId, this._accessToken, this._appCheckToken, this._isUsingGen);
             });
             return {
                 then: taskResult.then.bind(taskResult),
@@ -564,6 +649,11 @@ class RESTTransport {
             logDebug(`New Token Available: ${token}`);
             this._accessToken = token;
         });
+        (_b = this.appCheckProvider) === null || _b === void 0 ? void 0 : _b.addTokenChangeListener(result => {
+            const { token } = result;
+            logDebug(`New App Check Token Available: ${token}`);
+            this._appCheckToken = token;
+        });
     }
     get endpointUrl() {
         return urlBuilder({
@@ -585,26 +675,52 @@ class RESTTransport {
     onTokenChanged(newToken) {
         this._accessToken = newToken;
     }
-    getWithAuth() {
+    async getWithAuth(forceToken = false) {
+        var _a;
         let starterPromise = new Promise(resolve => resolve(this._accessToken));
-        if (!this._authInitialized) {
-            if (this.authProvider) {
-                starterPromise = this.authProvider
-                    .getToken(/*forceToken=*/ false)
-                    .then(data => {
-                    if (!data) {
-                        return null;
-                    }
-                    this._accessToken = data.accessToken;
-                    return this._accessToken;
-                });
-            }
-            else {
-                starterPromise = new Promise(resolve => resolve(''));
-            }
+        if (this.appCheckProvider) {
+            this._appCheckToken = (_a = (await this.appCheckProvider.getToken())) === null || _a === void 0 ? void 0 : _a.token;
+        }
+        if (this.authProvider) {
+            starterPromise = this.authProvider
+                .getToken(/*forceToken=*/ forceToken)
+                .then(data => {
+                if (!data) {
+                    return null;
+                }
+                this._accessToken = data.accessToken;
+                return this._accessToken;
+            });
+        }
+        else {
+            starterPromise = new Promise(resolve => resolve(''));
         }
         return starterPromise;
     }
+    _setLastToken(lastToken) {
+        this._lastToken = lastToken;
+    }
+    withRetry(promiseFactory, retry = false) {
+        let isNewToken = false;
+        return this.getWithAuth(retry)
+            .then(res => {
+            isNewToken = this._lastToken !== res;
+            this._lastToken = res;
+            return res;
+        })
+            .then(promiseFactory)
+            .catch(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;
+        });
+    }
 }
 
 /**
@@ -623,16 +739,26 @@ class RESTTransport {
  * 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();
     const ref = {
         dataConnect: dcInstance,
-        name: queryName,
+        name: mutationName,
         refType: MUTATION_STR,
         variables: variables
     };
     return ref;
 }
+/**
+ * @internal
+ */
 class MutationManager {
     constructor(_transport) {
         this._transport = _transport;
@@ -650,6 +776,11 @@ class MutationManager {
         return withRefPromise;
     }
 }
+/**
+ * Execute Mutation
+ * @param mutationRef mutation to execute
+ * @returns `MutationRef`
+ */
 function executeMutation(mutationRef) {
     return mutationRef.dataConnect._mutationManager.executeMutation(mutationRef);
 }
@@ -684,15 +815,21 @@ function parseOptions(fullHost) {
     const port = Number(portAsString);
     return { host, port, sslEnabled: isSecure };
 }
+/**
+ * Class representing Firebase Data Connect
+ */
 class DataConnect {
+    // @internal
     constructor(app, 
     // TODO(mtewani): Replace with _dataConnectOptions in the future
-    dataConnectOptions, _authProvider) {
+    dataConnectOptions, _authProvider, _appCheckProvider) {
         this.app = app;
         this.dataConnectOptions = dataConnectOptions;
         this._authProvider = _authProvider;
+        this._appCheckProvider = _appCheckProvider;
         this.isEmulator = false;
-        this.initialized = false;
+        this._initialized = false;
+        this._isUsingGeneratedSdk = false;
         if (typeof process !== 'undefined' && process.env) {
             const host = process.env[FIREBASE_DATA_CONNECT_EMULATOR_HOST_VAR];
             if (host) {
@@ -702,17 +839,25 @@ class DataConnect {
             }
         }
     }
+    // @internal
+    _useGeneratedSdk() {
+        if (!this._isUsingGeneratedSdk) {
+            this._isUsingGeneratedSdk = true;
+        }
+    }
     _delete() {
         app._removeServiceInstance(this.app, 'data-connect', JSON.stringify(this.getSettings()));
         return Promise.resolve();
     }
+    // @internal
     getSettings() {
         const copy = JSON.parse(JSON.stringify(this.dataConnectOptions));
         delete copy.projectId;
         return copy;
     }
+    // @internal
     setInitialized() {
-        if (this.initialized) {
+        if (this._initialized) {
             return;
         }
         if (this._transportClass === undefined) {
@@ -722,16 +867,20 @@ class DataConnect {
         if (this._authProvider) {
             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);
+        if (this._appCheckProvider) {
+            this._appCheckTokenProvider = new AppCheckTokenProvider(this.app.name, 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);
         if (this._transportOptions) {
             this._transport.useEmulator(this._transportOptions.host, this._transportOptions.port, this._transportOptions.sslEnabled);
         }
         this._queryManager = new QueryManager(this._transport);
         this._mutationManager = new MutationManager(this._transport);
     }
+    // @internal
     enableEmulator(transportOptions) {
-        if (this.initialized) {
+        if (this._initialized) {
             logError('enableEmulator called after initialization');
             throw new DataConnectError(Code.ALREADY_INITIALIZED, 'DataConnect instance already initialized!');
         }
@@ -739,6 +888,13 @@ class DataConnect {
         this.isEmulator = true;
     }
 }
+/**
+ * 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 = false) {
     dc.enableEmulator({ host, port, sslEnabled });
 }
@@ -753,7 +909,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();
     }
     const provider = app._getProvider(app$1, 'data-connect');
@@ -767,9 +923,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({
@@ -777,6 +931,29 @@ function getDataConnect(appOrOptions, optionalOptions) {
         options: dcOptions
     });
 }
+/**
+ *
+ * @param dcOptions
+ * @returns {void}
+ * @internal
+ */
+function validateDCOptions(dcOptions) {
+    const fields = ['connector', 'location', 'service'];
+    if (!dcOptions) {
+        throw new DataConnectError(Code.INVALID_ARGUMENT, 'DC Option Required');
+    }
+    fields.forEach(field => {
+        if (dcOptions[field] === null || dcOptions[field] === undefined) {
+            throw new DataConnectError(Code.INVALID_ARGUMENT, `${field} Required`);
+        }
+    });
+    return true;
+}
+/**
+ * Delete DataConnect instance
+ * @param dataConnect DataConnect instance
+ * @returns
+ */
 function terminate(dataConnect) {
     return dataConnect._delete();
     // TODO(mtewani): Stop pending tasks
@@ -803,11 +980,15 @@ function registerDataConnect(variant) {
     app._registerComponent(new component.Component('data-connect', (container, { instanceIdentifier: settings, options }) => {
         const app = container.getProvider('app').getImmediate();
         const authProvider = container.getProvider('auth-internal');
+        const appCheckProvider = container.getProvider('app-check-internal');
         let newOpts = options;
         if (settings) {
             newOpts = JSON.parse(settings);
         }
-        return new DataConnect(app, Object.assign(Object.assign({}, newOpts), { projectId: app.options.projectId }), authProvider);
+        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, Object.assign(Object.assign({}, newOpts), { projectId: app.options.projectId }), authProvider, appCheckProvider);
     }, "PUBLIC" /* ComponentType.PUBLIC */).setMultipleInstances(true));
     app.registerVersion(name, version, variant);
     // BUILD_TARGET will be replaced by values like esm5, esm2017, cjs5, etc during the compilation
@@ -830,9 +1011,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);
@@ -843,6 +1037,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) {
     const { refInfo: { name, variables, connectorConfig } } = serializedRef;
     return queryRef(getDataConnect(connectorConfig), name, variables);
@@ -864,6 +1063,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) {
+    let dcInstance;
+    let 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) {
     let ref;
     let initialCache;
@@ -903,8 +1153,6 @@ function subscribe(queryRefOrSerializedResult, observerOrOnNext, onError, onComp
 registerDataConnect();
 
 exports.DataConnect = DataConnect;
-exports.FIREBASE_DATA_CONNECT_EMULATOR_HOST_VAR = FIREBASE_DATA_CONNECT_EMULATOR_HOST_VAR;
-exports.FirebaseAuthProvider = FirebaseAuthProvider;
 exports.MUTATION_STR = MUTATION_STR;
 exports.MutationManager = MutationManager;
 exports.QUERY_STR = QUERY_STR;
@@ -921,4 +1169,6 @@ exports.setLogLevel = setLogLevel;
 exports.subscribe = subscribe;
 exports.terminate = terminate;
 exports.toQueryRef = toQueryRef;
+exports.validateArgs = validateArgs;
+exports.validateDCOptions = validateDCOptions;
 //# sourceMappingURL=index.cjs.js.map