@firebase/data-connect - npm Package Compare versions

Comparing version 0.4.0 to 0.5.0-20260317152345

dist/internal.d.ts

@@ -345,2 +345,5 @@ /**
 
+/**
+ * Options for executing a query.
+ */
 export declare interface ExecuteQueryOptions {
@@ -516,2 +519,3 @@ fetchPolicy: QueryFetchPolicy;
     vars: Variables;
+    options?: ExecuteQueryOptions;
 }
@@ -731,15 +735,38 @@
 /**
- * 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>;
+
+/**
+ *
  * @param dcOptions
@@ -746,0 +773,0 @@ * @returns {void}

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

@@ -24,3 +24,3 @@ /**
 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';

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

@@ -23,4 +23,7 @@ /**
 export type QueryFetchPolicy = (typeof QueryFetchPolicy)[keyof typeof QueryFetchPolicy];
+/**
+ * Options for executing a query.
+ */
 export interface ExecuteQueryOptions {
     fetchPolicy: QueryFetchPolicy;
 }

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

@@ -17,2 +17,3 @@ /**
  */
+import { ExecuteQueryOptions } from '../api';
 import { ConnectorConfig, DataConnect } from '../api/DataConnect';
@@ -22,14 +23,37 @@ interface ParsedArgs<Variables> {
     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 {};

dist/private.d.ts

@@ -293,2 +293,5 @@ /**
 
+/**
+ * Options for executing a query.
+ */
 export declare interface ExecuteQueryOptions {
@@ -448,2 +451,3 @@ fetchPolicy: QueryFetchPolicy;
     vars: Variables;
+    options?: ExecuteQueryOptions;
 }
@@ -655,4 +659,6 @@
 
+/* Excluded from this release type: validateArgsWithOptions */
+
 /* Excluded from this release type: validateDCOptions */
 
 export { }

dist/public.d.ts

@@ -141,2 +141,5 @@ /**
 export declare function executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>, options?: ExecuteQueryOptions): QueryPromise<Data, Variables>;
+/**
+ * Options for executing a query.
+ */
 export declare interface ExecuteQueryOptions {
@@ -350,3 +353,4 @@ fetchPolicy: QueryFetchPolicy;
 /* Excluded from this release type: validateArgs */
+/* Excluded from this release type: validateArgsWithOptions */
 /* Excluded from this release type: validateDCOptions */
 export {};

dist/src/api/index.d.ts

@@ -24,3 +24,3 @@ /**
 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';

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

@@ -23,4 +23,7 @@ /**
 export type QueryFetchPolicy = (typeof QueryFetchPolicy)[keyof typeof QueryFetchPolicy];
+/**
+ * Options for executing a query.
+ */
 export interface ExecuteQueryOptions {
     fetchPolicy: QueryFetchPolicy;
 }

dist/src/util/validateArgs.d.ts

@@ -17,2 +17,3 @@ /**
  */
+import { ExecuteQueryOptions } from '../api';
 import { ConnectorConfig, DataConnect } from '../api/DataConnect';
@@ -22,14 +23,37 @@ interface ParsedArgs<Variables> {
     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.json

 {
   "name": "@firebase/data-connect",
-  "version": "0.4.0",
+  "version": "0.5.0-20260317152345",
   "description": "",
@@ -48,13 +48,13 @@ "author": "Firebase <[e-mail]> (https://firebase.google.com/)",
   "peerDependencies": {
-    "@firebase/app": "0.x"
+    "@firebase/app": "0.14.10-20260317152345"
   },
   "dependencies": {
     "@firebase/auth-interop-types": "0.2.4",
-    "@firebase/component": "0.7.1",
+    "@firebase/component": "0.7.2-20260317152345",
     "@firebase/logger": "0.5.0",
-    "@firebase/util": "1.14.0",
+    "@firebase/util": "1.15.0-20260317152345",
     "tslib": "^2.1.0"
   },
   "devDependencies": {
-    "@firebase/app": "0.14.9",
+    "@firebase/app": "0.14.10-20260317152345",
     "rollup": "2.79.2",
@@ -61,0 +61,0 @@ "rollup-plugin-typescript2": "0.36.0",

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1103574

2.38%

Lines of code

12693

2.47%

Dependency changes

• + Added

  @firebase/app@0.14.10-20260317152345
  (transitive)

• + Added

  @firebase/component@0.7.2-20260317152345
  (transitive)

• + Added

  @firebase/util@1.15.0-20260317152345
  (transitive)

• - Removed

  @firebase/app@0.14.12
  (transitive)

• - Removed

  @firebase/component@0.7.10.7.3
  (transitive)

• - Removed

  @firebase/logger@0.5.1
  (transitive)

• - Removed

  @firebase/util@1.14.01.15.1
  (transitive)

• Updated

  @firebase/component@0.7.2-20260317152345

• Updated

  @firebase/util@1.15.0-20260317152345