@firebase/data-connect 0.4.0 → 0.5.0

package/dist/node-esm/src/api/index.d.ts

@@ -21,5 +21,5 @@ export * from './Reference';
 export * from './Mutation';
 export * from './query';
 export { setLogLevel } from '../logger';
-export { validateArgs } from '../util/validateArgs';
+export { validateArgs, validateArgsWithOptions } from '../util/validateArgs';
 export { DataConnectErrorCode, Code, DataConnectError, DataConnectOperationError, DataConnectOperationFailureResponse, DataConnectOperationFailureResponseErrorInfo } from '../core/error';

package/dist/node-esm/src/core/query/queryOptions.d.ts

@@ -20,6 +20,9 @@ export declare const QueryFetchPolicy: {
     readonly SERVER_ONLY: "SERVER_ONLY";
 };
 export type QueryFetchPolicy = (typeof QueryFetchPolicy)[keyof typeof QueryFetchPolicy];
+/**
+ * Options for executing a query.
+ */
 export interface ExecuteQueryOptions {
     fetchPolicy: QueryFetchPolicy;
 }

package/dist/node-esm/src/util/validateArgs.d.ts

@@ -14,20 +14,44 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { ExecuteQueryOptions } from '../api';
 import { ConnectorConfig, DataConnect } from '../api/DataConnect';
 interface ParsedArgs<Variables> {
     dc: DataConnect;
     vars: Variables;
+    options?: ExecuteQueryOptions;
 }
 /**
- * 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>;
 export {};

package/dist/private.d.ts

@@ -290,6 +290,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;
 }
@@ -444,6 +447,7 @@ export declare interface OpResult<Data> {
 declare interface ParsedArgs<Variables> {
     dc: DataConnect;
     vars: Variables;
+    options?: ExecuteQueryOptions;
 }
 
 /* Excluded from this release type: parseOptions */
@@ -650,6 +654,8 @@ export declare interface TransportOptions {
 
 /* Excluded from this release type: validateArgs */
 
+/* Excluded from this release type: validateArgsWithOptions */
+
 /* Excluded from this release type: validateDCOptions */
 
 export { }

package/dist/public.d.ts

@@ -138,6 +138,9 @@ export declare function executeMutation<Data, Variables>(mutationRef: MutationRe
  * @returns `QueryPromise`
  */
 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;
 }
@@ -346,5 +349,6 @@ export declare interface TransportOptions {
     port?: number;
 }
 /* Excluded from this release type: validateArgs */
+/* Excluded from this release type: validateArgsWithOptions */
 /* Excluded from this release type: validateDCOptions */
 export {};

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

@@ -21,5 +21,5 @@ export * from './Reference';
 export * from './Mutation';
 export * from './query';
 export { setLogLevel } from '../logger';
-export { validateArgs } from '../util/validateArgs';
+export { validateArgs, validateArgsWithOptions } from '../util/validateArgs';
 export { DataConnectErrorCode, Code, DataConnectError, DataConnectOperationError, DataConnectOperationFailureResponse, DataConnectOperationFailureResponseErrorInfo } from '../core/error';

package/dist/src/core/query/queryOptions.d.ts

@@ -20,6 +20,9 @@ export declare const QueryFetchPolicy: {
     readonly SERVER_ONLY: "SERVER_ONLY";
 };
 export type QueryFetchPolicy = (typeof QueryFetchPolicy)[keyof typeof QueryFetchPolicy];
+/**
+ * Options for executing a query.
+ */
 export interface ExecuteQueryOptions {
     fetchPolicy: QueryFetchPolicy;
 }

package/dist/src/util/validateArgs.d.ts

@@ -14,20 +14,44 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { ExecuteQueryOptions } from '../api';
 import { ConnectorConfig, DataConnect } from '../api/DataConnect';
 interface ParsedArgs<Variables> {
     dc: DataConnect;
     vars: Variables;
+    options?: ExecuteQueryOptions;
 }
 /**
- * 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>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/data-connect",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "main": "dist/index.node.cjs.js",
@@ -49,13 +49,13 @@
   },
   "dependencies": {
     "@firebase/auth-interop-types": "0.2.4",
-    "@firebase/component": "0.7.1",
+    "@firebase/component": "0.7.2",
     "@firebase/logger": "0.5.0",
-    "@firebase/util": "1.14.0",
+    "@firebase/util": "1.15.0",
     "tslib": "^2.1.0"
   },
   "devDependencies": {
-    "@firebase/app": "0.14.9",
+    "@firebase/app": "0.14.10",
     "rollup": "2.79.2",
     "rollup-plugin-typescript2": "0.36.0",
     "typescript": "5.5.4"