@firebase/data-connect 0.4.0 → 0.5.0

package/dist/internal.d.ts

@@ -342,6 +342,9 @@ export declare function executeMutation<Data, Variables>(mutationRef: MutationRe
  */
 export declare function executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>, options?: ExecuteQueryOptions): QueryPromise<Data, Variables>;
 
+/**
+ * Options for executing a query.
+ */
 export declare interface ExecuteQueryOptions {
     fetchPolicy: QueryFetchPolicy;
 }
@@ -512,6 +515,7 @@ export declare interface OpResult<Data> {
 declare interface ParsedArgs<Variables> {
     dc: DataConnect;
     vars: Variables;
+    options?: ExecuteQueryOptions;
 }
 
 /**
@@ -726,16 +730,39 @@ export declare interface TransportOptions {
 }
 
 /**
- * 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.
+ * The generated SDK will allow the user to pass in either the variables or the data connect instance
+ * with the variables. This function validates the variables and returns back the DataConnect instance
+ * and variables based on the arguments passed in.
+ *
+ * Generated SDKs generated from versions 3.2.0 and lower of the Data Connect emulator binary are
+ * NOT concerned with options, and will use this function to validate arguments.
+ *
  * @param connectorConfig
  * @param dcOrVars
  * @param vars
- * @param validateVars
+ * @param variablesRequired
  * @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 declare function validateArgs<Variables extends object>(connectorConfig: ConnectorConfig, dcOrVars?: DataConnect | Variables, vars?: Variables, variablesRequired?: boolean): ParsedArgs<Variables>;
+
+/**
+ * The generated SDK will allow the user to pass in either the variables or the data connect instance
+ * with the variables, and/or options. This function validates the variables and returns back the
+ * DataConnect instance and variables, and potentially options, based on the arguments passed in.
+ *
+ * Generated SDKs generated from versions 3.2.0 and higher of the Data Connect emulator binary are
+ * in fact concerned with options, and will use this function to validate arguments.
+ *
+ * @param connectorConfig
+ * @param dcOrVarsOrOptions
+ * @param varsOrOptions
+ * @param variablesRequired
+ * @param options
+ * @returns {DataConnect} and {Variables} instance, and optionally {ExecuteQueryOptions}
+ * @internal
+ */
+export declare function validateArgsWithOptions<Variables extends object>(connectorConfig: ConnectorConfig, dcOrVarsOrOptions?: DataConnect | Variables | ExecuteQueryOptions, varsOrOptions?: Variables | ExecuteQueryOptions, options?: ExecuteQueryOptions, hasVars?: boolean, variablesRequired?: boolean): ParsedArgs<Variables>;
 
 /**
  *

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

@@ -1,4 +1,4 @@
-import { FirebaseError, isCloudWorkstation, generateSHA256Hash, pingServer, updateEmulatorBanner } from '@firebase/util';
+import { FirebaseError, isCloudWorkstation, generateSHA256Hash, pingServer } from '@firebase/util';
 import { Logger } from '@firebase/logger';
 import { _isFirebaseServerApp, _removeServiceInstance, getApp, _getProvider, _registerComponent, registerVersion, SDK_VERSION as SDK_VERSION$1 } from '@firebase/app';
 import { Component } from '@firebase/component';
@@ -236,7 +236,7 @@ function getErrorMessage(obj) {
 }
 
 const name = "@firebase/data-connect";
-const version = "0.4.0";
+const version = "0.5.0";
 
 /**
  * @license
@@ -1714,7 +1714,6 @@ function connectDataConnectEmulator(dc, host, port, sslEnabled = false) {
     // Workaround to get cookies in Firebase Studio
     if (isCloudWorkstation(host)) {
         void pingServer(`https://${host}${port ? `:${port}` : ''}`);
-        updateEmulatorBanner('Data Connect', true);
     }
     dc.enableEmulator({ host, port, sslEnabled });
 }
@@ -1948,19 +1947,25 @@ function toQueryRef(serializedRef) {
  * 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.
+ * The generated SDK will allow the user to pass in either the variables or the data connect instance
+ * with the variables. This function validates the variables and returns back the DataConnect instance
+ * and variables based on the arguments passed in.
+ *
+ * Generated SDKs generated from versions 3.2.0 and lower of the Data Connect emulator binary are
+ * NOT concerned with options, and will use this function to validate arguments.
+ *
  * @param connectorConfig
  * @param dcOrVars
  * @param vars
- * @param validateVars
+ * @param variablesRequired
  * @returns {DataConnect} and {Variables} instance
  * @internal
  */
-function validateArgs(connectorConfig, dcOrVars, vars, validateVars) {
+function validateArgs(connectorConfig, dcOrVars, vars, variablesRequired) {
     let dcInstance;
     let realVars;
-    if (dcOrVars && 'enableEmulator' in dcOrVars) {
+    const dcFirstArg = dcOrVars && 'enableEmulator' in dcOrVars;
+    if (dcFirstArg) {
         dcInstance = dcOrVars;
         realVars = vars;
     }
@@ -1968,11 +1973,59 @@ function validateArgs(connectorConfig, dcOrVars, vars, validateVars) {
         dcInstance = getDataConnect(connectorConfig);
         realVars = dcOrVars;
     }
-    if (!dcInstance || (!realVars && validateVars)) {
+    if (!dcInstance || (!realVars && variablesRequired)) {
         throw new DataConnectError(Code.INVALID_ARGUMENT, 'Variables required.');
     }
     return { dc: dcInstance, vars: realVars };
 }
+/**
+ * The generated SDK will allow the user to pass in either the variables or the data connect instance
+ * with the variables, and/or options. This function validates the variables and returns back the
+ * DataConnect instance and variables, and potentially options, based on the arguments passed in.
+ *
+ * Generated SDKs generated from versions 3.2.0 and higher of the Data Connect emulator binary are
+ * in fact concerned with options, and will use this function to validate arguments.
+ *
+ * @param connectorConfig
+ * @param dcOrVarsOrOptions
+ * @param varsOrOptions
+ * @param variablesRequired
+ * @param options
+ * @returns {DataConnect} and {Variables} instance, and optionally {ExecuteQueryOptions}
+ * @internal
+ */
+function validateArgsWithOptions(connectorConfig, dcOrVarsOrOptions, varsOrOptions, options, hasVars, variablesRequired) {
+    let dcInstance;
+    let realVars;
+    let realOptions;
+    const dcFirstArg = dcOrVarsOrOptions && 'enableEmulator' in dcOrVarsOrOptions;
+    if (dcFirstArg) {
+        dcInstance = dcOrVarsOrOptions;
+        if (hasVars) {
+            realVars = varsOrOptions;
+            realOptions = options;
+        }
+        else {
+            realVars = undefined;
+            realOptions = varsOrOptions;
+        }
+    }
+    else {
+        dcInstance = getDataConnect(connectorConfig);
+        if (hasVars) {
+            realVars = dcOrVarsOrOptions;
+            realOptions = varsOrOptions;
+        }
+        else {
+            realVars = undefined;
+            realOptions = dcOrVarsOrOptions;
+        }
+    }
+    if (!dcInstance || (!realVars && variablesRequired)) {
+        throw new DataConnectError(Code.INVALID_ARGUMENT, 'Variables required.');
+    }
+    return { dc: dcInstance, vars: realVars, options: realOptions };
+}
 
 /**
  * @license
@@ -2050,5 +2103,5 @@ function subscribe(queryRefOrSerializedResult, observerOrOnNext, onError, onComp
 initializeFetch(fetch);
 registerDataConnect('node');
 
-export { CallerSdkTypeEnum, Code, DataConnect, DataConnectError, DataConnectOperationError, MUTATION_STR, MutationManager, QUERY_STR, QueryFetchPolicy, SOURCE_CACHE, SOURCE_SERVER, StorageType, areTransportOptionsEqual, connectDataConnectEmulator, executeMutation, executeQuery, getDataConnect, makeMemoryCacheProvider, mutationRef, parseOptions, queryRef, setLogLevel, subscribe, terminate, toQueryRef, validateArgs, validateDCOptions };
+export { CallerSdkTypeEnum, Code, DataConnect, DataConnectError, DataConnectOperationError, MUTATION_STR, MutationManager, QUERY_STR, QueryFetchPolicy, SOURCE_CACHE, SOURCE_SERVER, StorageType, areTransportOptionsEqual, connectDataConnectEmulator, executeMutation, executeQuery, getDataConnect, makeMemoryCacheProvider, mutationRef, parseOptions, queryRef, setLogLevel, subscribe, terminate, toQueryRef, validateArgs, validateArgsWithOptions, validateDCOptions };
 //# sourceMappingURL=index.node.esm.js.map