spread GraphqlOptions arguments in OperationRefs and executeOperation functions

Author: stephenarosaj

src/data-connect/data-connect-api-client-internal.ts

@@ -23,7 +23,7 @@ import {
 import { PrefixedFirebaseError } from '../utils/error';
 import * as utils from '../utils/index';
 import * as validator from '../utils/validator';
-import { ConnectorConfig, ExecuteGraphqlResponse, GraphqlOptions } from './data-connect-api';
+import { ConnectorConfig, ExecuteGraphqlResponse, GraphqlOptions, RefOptions } from './data-connect-api';
 
 const API_VERSION = 'v1';
 
@@ -152,9 +152,11 @@ export class DataConnectApiClient {
    * @returns A promise that fulfills with the GraphQL response.
    */
   public async executeQuery<GraphqlResponse, Variables>(
-    options: GraphqlOptions<Variables>
+    name: string,
+    variables: Variables, 
+    options?: RefOptions
   ): Promise<ExecuteGraphqlResponse<GraphqlResponse>> {
-    return this.executeOperationHelper(IMPERSONATE_QUERY_ENDPOINT, options);
+    return this.executeOperationHelper(IMPERSONATE_QUERY_ENDPOINT, name, variables, options);
   }
 
   /**
@@ -164,9 +166,11 @@ export class DataConnectApiClient {
    * @returns A promise that fulfills with the GraphQL response.
    */
   public async executeMutation<GraphqlResponse, Variables>(
-    options: GraphqlOptions<Variables>
+    name: string,
+    variables: Variables, 
+    options?: RefOptions
   ): Promise<ExecuteGraphqlResponse<GraphqlResponse>> {
-    return this.executeOperationHelper(IMPERSONATE_MUTATION_ENDPOINT, options);
+    return this.executeOperationHelper(IMPERSONATE_MUTATION_ENDPOINT, name, variables, options);
   }
 
   /**
@@ -179,24 +183,17 @@ export class DataConnectApiClient {
    */
   private async executeOperationHelper<GraphqlResponse, Variables>(
     endpoint: string,
-    options: GraphqlOptions<Variables>
+    name: string,
+    variables: Variables, 
+    options?: RefOptions
   ): Promise<ExecuteGraphqlResponse<GraphqlResponse>> {
     if (
-      typeof options.operationName === 'undefined' ||
-      !validator.isNonEmptyString(options.operationName)
+      typeof name === 'undefined' ||
+      !validator.isNonEmptyString(name)
     ) {
       throw new FirebaseDataConnectError(
         DATA_CONNECT_ERROR_CODE_MAPPING.INVALID_ARGUMENT,
-        '`options.operationName` must be a non-empty string.'
-      );
-    }
-    if (
-      typeof options.impersonate === 'undefined' || 
-      !validator.isNonNullObject(options?.impersonate)
-    ) {
-      throw new FirebaseDataConnectError(
-        DATA_CONNECT_ERROR_CODE_MAPPING.INVALID_ARGUMENT,
-        '`options.impersonate` must be a non-null object.'
+        '`name` must be a non-empty string.'
       );
     }
 
@@ -208,9 +205,9 @@ export class DataConnectApiClient {
     }
 
     const data = {
-      ...(options.variables && { variables: options?.variables }),
-      operationName: options.operationName,
-      extensions: { impersonate: options.impersonate },
+      ...(variables && { variables: variables }),
+      operationName: name,
+      extensions: { impersonate: options?.impersonate },
     };
     const url = await this.getUrl(
       API_VERSION,

src/data-connect/data-connect-api.ts

@@ -33,7 +33,6 @@ export interface ConnectorConfig {
 
   /**
    * Name of the Data Connect connector.
-   * Required for operations that interact with connectors, such as executeQuery and executeMutation.
    */
   connector?: string;
 }
@@ -59,7 +58,6 @@ export interface GraphqlOptions<Variables> {
 
   /**
    * The name of the GraphQL operation.
-   * Required for operations that interact with connectors, such as executeQuery and executeMutation.
    * Required for operations that interact with services, such as executeGraphql, if 
    * `query` contains multiple operations.
    */
@@ -72,6 +70,17 @@ export interface GraphqlOptions<Variables> {
   impersonate?: ImpersonateAuthenticated | ImpersonateUnauthenticated;
 }
 
+/**
+ * Interface representing options for OperationRefs.
+ */
+export interface RefOptions {
+  /**
+   * If set, impersonate a request with given Firebase Auth context and evaluate the auth
+   * policies on the operation. If omitted, bypass any defined auth policies.
+   */
+  impersonate?: ImpersonateAuthenticated | ImpersonateUnauthenticated;
+}
+
 /**
  * Type representing the partial claims of a Firebase Auth token used to evaluate the
  * Data Connect auth policy.

src/data-connect/data-connect.ts

@@ -25,6 +25,7 @@ import {
   ConnectorConfig,
   ExecuteGraphqlResponse,
   GraphqlOptions,
+  RefOptions,
 } from './data-connect-api';
 
 export class DataConnectService {
@@ -162,78 +163,97 @@ export class DataConnect {
   }
 
   /** @internal */
-  public executeQuery<Data, Variables>(options: GraphqlOptions<Variables>): Promise<ExecuteGraphqlResponse<Data>> {
-    return this.client.executeQuery<Data, Variables>(options);
+  public executeQuery<Data, Variables>(
+    name: string,
+    variables: Variables, 
+    options?: RefOptions
+  ): Promise<ExecuteGraphqlResponse<Data>> {
+    return this.client.executeQuery<Data, Variables>(name, variables, options);
   }
 
   /** @internal */
-  public executeMutation<Data, Variables>(options: GraphqlOptions<Variables>): Promise<ExecuteGraphqlResponse<Data>> {
-    return this.client.executeMutation<Data, Variables>(options);
+  public executeMutation<Data, Variables>(
+    name: string,
+    variables: Variables, 
+    options?: RefOptions
+  ): Promise<ExecuteGraphqlResponse<Data>> {
+    return this.client.executeMutation<Data, Variables>(name, variables, options);
   }
 
   /**
    * Create a reference to a specific "instance" of a named query.
-   * @param options - Required {@link GraphqlOptions} when executing a GraphQL query.
-   * @returns an reference to the named query with the specified impersonation and variables. 
+   * @param name - The name of the query.
+   * @param options - The RefOptions for the query (optional).
+   * @returns A reference to the named query with the specified impersonation and variables. 
    */
   public queryRef<Data>(
-    options: GraphqlOptions<undefined>
+    name: string,
+    options?: RefOptions
   ): QueryRef<Data, undefined>;
 
   /**
    * Create a reference to a specific "instance" of a named query.
-   * @param options - Required {@link GraphqlOptions} when executing a GraphQL query.
-   * @returns an reference to the named query with the specified impersonation and variables. 
+   * @param name - The name of the query.
+   * @param variables - The variables for the query. May be optional if the query's variables are optional.
+   * @param options - The RefOptions for the query (optional).
+   * @returns A reference to the named query with the specified impersonation and variables. 
    */
   public queryRef<Data, Variables>(
-    options: GraphqlOptions<Variables>
+    name: string,
+    variables: Variables, 
+    options?: RefOptions
   ): QueryRef<Data, Variables>;
 
   public queryRef<Data, Variables>(
-    options: GraphqlOptions<Variables>
+    name: string,
+    variables: Variables, 
+    options?: RefOptions
   ): QueryRef<Data, Variables> {
     if (!('connector' in this.connectorConfig)){
       throw new FirebaseDataConnectError(
         DATA_CONNECT_ERROR_CODE_MAPPING.INVALID_ARGUMENT,
         `The 'connectorConfig.connector' field used to instantiate your Data Connect
         instance must be a non-empty string (the connectorId) when creating a queryRef.`);
     }
-    return new QueryRef(this, options);
+    return new QueryRef(this, name, variables, options);
   }
 
   /**
    * Create a reference to a specific "instance" of a named mutation.
-   * @param options - Required {@link GraphqlOptions} when executing a GraphQL mutation.
-   * @returns an reference to the named mutation with the specified impersonation and variables. 
+   * @param name - The name of the mutation.
+   * @param options - The RefOptions for the mutation (optional).
+   * @returns A reference to the named mutation with the specified impersonation and variables. 
    */
   public mutationRef<Data>(
-    options: GraphqlOptions<undefined>
+    name: string,
+    options?: RefOptions
   ): MutationRef<Data, undefined>
 
   /**
    * Create a reference to a specific "instance" of a named mutation.
-   * @param options - Required {@link GraphqlOptions} when executing a GraphQL mutation.
-   * @returns an reference to the named mutation with the specified impersonation and variables. 
+   * @param name - The name of the mutation.
+   * @param variables - The variables for the mutation. May be optional if the mutation's variables are optional.
+   * @param options - The RefOptions for the mutation (optional).
+   * @returns A reference to the named mutation with the specified impersonation and variables. 
    */
   public mutationRef<Data, Variables>(
-    options: GraphqlOptions<Variables>
+    name: string,
+    variables: Variables, 
+    options?: RefOptions
   ): MutationRef<Data, Variables>;
 
-  /**
-   * Create a reference to a specific "instance" of a named mutation.
-   * @param options - Required {@link GraphqlOptions} when executing a GraphQL mutation.
-   * @returns an reference to the named mutation with the specified impersonation and variables. 
-   */
   public mutationRef<Data, Variables>(
-    options: GraphqlOptions<Variables>
+    name: string,
+    variables: Variables, 
+    options?: RefOptions
   ): MutationRef<Data, Variables> {
     if (!('connector' in this.connectorConfig)){
       throw new FirebaseDataConnectError(
         DATA_CONNECT_ERROR_CODE_MAPPING.INVALID_ARGUMENT,
         `The 'connectorConfig.connector' field used to instantiate your Data Connect
         instance must be a non-empty string (the connectorId) when creating a mutationRef.`);
     }
-    return new MutationRef(this, options);
+    return new MutationRef(this, name, variables, options);
   }
 }
 
@@ -244,54 +264,49 @@ interface OperationResult<Data, Variables> {
   dataConnect: DataConnect;
 }
 
+/**
+ * The result of executing a query.
+ */
 export interface QueryResult<Data, Variables> extends OperationResult<Data, Variables> {
   ref: QueryRef<Data, Variables>;
 }
 
+/**
+ * The result of executing a mutation.
+ */
 export interface MutationResult<Data, Variables> extends OperationResult<Data, Variables> {
   ref: MutationRef<Data, Variables>;
 }
 
 abstract class OperationRef<Data, Variables> {
   constructor(
     public readonly dataConnect: DataConnect,
-    public readonly options: GraphqlOptions<Variables>,
-  ) {
-    if (typeof options.operationName === 'undefined') {
-      throw new FirebaseDataConnectError(
-        DATA_CONNECT_ERROR_CODE_MAPPING.INVALID_ARGUMENT,
-        `The 'options.operationName' field must be provided when creating a queryRef
-        or mutationRef.`);
-    }
-    if (typeof options.impersonate === 'undefined') {
-      throw new FirebaseDataConnectError(
-        DATA_CONNECT_ERROR_CODE_MAPPING.INVALID_ARGUMENT,
-        `The 'options.impersonate' field must be provided when creating a queryRef
-        or mutationRef.`);
-    }
-  }
+    public readonly name: string,
+    public readonly variables: Variables,
+    public readonly options?: RefOptions
+  ) {}
   abstract execute(): Promise<OperationResult<Data, Variables>>;
 }
 
 class QueryRef<Data, Variables> extends OperationRef<Data, Variables> {
   async execute(): Promise<QueryResult<Data, Variables>> {
-    const { data } = await this.dataConnect.executeQuery<Data, Variables>(this.options);    
+    const { data } = await this.dataConnect.executeQuery<Data, Variables>(this.name, this.variables, this.options);    
     return {
       ref: this,
       data: data,
-      variables: this.options.variables as Variables,
+      variables: this.variables,
       dataConnect: this.dataConnect
     }
   }
 }
 
 class MutationRef<Data, Variables> extends OperationRef<Data, Variables> {
   async execute(): Promise<MutationResult<Data, Variables>> {
-    const { data } = await this.dataConnect.executeMutation<Data, Variables>(this.options)
+    const { data } = await this.dataConnect.executeMutation<Data, Variables>(this.name, this.variables, this.options)
     return {
       ref: this,
       data: data,
-      variables: this.options.variables as Variables,
+      variables: this.variables,
       dataConnect: this.dataConnect
     }
   }