update executeOperation API to return executeOperationResponse

Author: stephenarosaj

etc/firebase-admin.data-connect.api.md

@@ -28,10 +28,10 @@ export class DataConnect {
     readonly connectorConfig: ConnectorConfig;
     executeGraphql<GraphqlResponse, Variables>(query: string, options?: GraphqlOptions<Variables>): Promise<ExecuteGraphqlResponse<GraphqlResponse>>;
     executeGraphqlRead<GraphqlResponse, Variables>(query: string, options?: GraphqlOptions<Variables>): Promise<ExecuteGraphqlResponse<GraphqlResponse>>;
-    executeMutation<Data>(name: string, options?: OperationOptions): Promise<ExecuteGraphqlResponse<Data>>;
-    executeMutation<Data, Variables>(name: string, variables: Variables, options?: OperationOptions): Promise<ExecuteGraphqlResponse<Data>>;
-    executeQuery<Data>(name: string, options?: OperationOptions): Promise<ExecuteGraphqlResponse<Data>>;
-    executeQuery<Data, Variables>(name: string, variables: Variables, options?: OperationOptions): Promise<ExecuteGraphqlResponse<Data>>;
+    executeMutation<Data>(name: string, options?: OperationOptions): Promise<ExecuteOperationResponse<Data>>;
+    executeMutation<Data, Variables>(name: string, variables: Variables, options?: OperationOptions): Promise<ExecuteOperationResponse<Data>>;
+    executeQuery<Data>(name: string, options?: OperationOptions): Promise<ExecuteOperationResponse<Data>>;
+    executeQuery<Data, Variables>(name: string, variables: Variables, options?: OperationOptions): Promise<ExecuteOperationResponse<Data>>;
     insert<GraphQlResponse, Variables extends object>(tableName: string, variables: Variables): Promise<ExecuteGraphqlResponse<GraphQlResponse>>;
     insertMany<GraphQlResponse, Variables extends Array<unknown>>(tableName: string, variables: Variables): Promise<ExecuteGraphqlResponse<GraphQlResponse>>;
     upsert<GraphQlResponse, Variables extends object>(tableName: string, variables: Variables): Promise<ExecuteGraphqlResponse<GraphQlResponse>>;
@@ -43,6 +43,11 @@ export interface ExecuteGraphqlResponse<GraphqlResponse> {
     data: GraphqlResponse;
 }
 
+// @public
+export interface ExecuteOperationResponse<GraphqlResponse> {
+    data: GraphqlResponse;
+}
+
 // @public
 export function getDataConnect(connectorConfig: ConnectorConfig, app?: App): DataConnect;
 

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

@@ -38,7 +38,7 @@ export interface ConnectorConfig {
 }
 
 /**
- * Interface representing GraphQL response.
+ * Interface representing ExecuteGraphQL response.
  */
 export interface ExecuteGraphqlResponse<GraphqlResponse> {
   /**
@@ -47,6 +47,16 @@ export interface ExecuteGraphqlResponse<GraphqlResponse> {
   data: GraphqlResponse;
 }
 
+/**
+ * Interface representing ExecuteOperation response.
+ */
+export interface ExecuteOperationResponse<GraphqlResponse> {
+  /**
+   * Data payload of the GraphQL response.
+   */
+  data: GraphqlResponse;
+}
+
 /**
  * Interface representing GraphQL options for executing arbitrary GraphQL operations.
  */

src/data-connect/data-connect.ts

@@ -21,6 +21,7 @@ import { DataConnectApiClient } from './data-connect-api-client-internal';
 import {
   ConnectorConfig,
   ExecuteGraphqlResponse,
+  ExecuteOperationResponse,
   GraphqlOptions,
   OperationOptions,
 } from './data-connect-api';
@@ -178,7 +179,7 @@ export class DataConnect {
   public executeQuery<Data>(
     name: string,
     options?: OperationOptions
-  ): Promise<ExecuteGraphqlResponse<Data>>;
+  ): Promise<ExecuteOperationResponse<Data>>;
 
   /**
    * Executes a pre-defined GraphQL query, optionally with auth impersonation.
@@ -193,13 +194,13 @@ export class DataConnect {
     name: string,
     variables: Variables, 
     options?: OperationOptions
-  ): Promise<ExecuteGraphqlResponse<Data>>;
+  ): Promise<ExecuteOperationResponse<Data>>;
 
   public executeQuery<Data, Variables>(
     name: string,
     variables: Variables, 
     options?: OperationOptions
-  ): Promise<ExecuteGraphqlResponse<Data>> {
+  ): Promise<ExecuteOperationResponse<Data>> {
     return this.client.executeQuery<Data, Variables>(name, variables, options);
   }
 
@@ -214,7 +215,7 @@ export class DataConnect {
   public executeMutation<Data>(
     name: string,
     options?: OperationOptions
-  ): Promise<ExecuteGraphqlResponse<Data>>;
+  ): Promise<ExecuteOperationResponse<Data>>;
 
   /**
    * Executes a pre-defined GraphQL mutation, optionally with auth impersonation.
@@ -229,13 +230,13 @@ export class DataConnect {
     name: string,
     variables: Variables, 
     options?: OperationOptions
-  ): Promise<ExecuteGraphqlResponse<Data>>;
+  ): Promise<ExecuteOperationResponse<Data>>;
 
   public executeMutation<Data, Variables>(
     name: string,
     variables: Variables, 
     options?: OperationOptions
-  ): Promise<ExecuteGraphqlResponse<Data>> {
+  ): Promise<ExecuteOperationResponse<Data>> {
     return this.client.executeMutation<Data, Variables>(name, variables, options);
   }
 }

src/data-connect/index.ts

@@ -29,6 +29,7 @@ import { ConnectorConfig } from './data-connect-api';
 export {
   GraphqlOptions,
   ExecuteGraphqlResponse,
+  ExecuteOperationResponse,
   ConnectorConfig,
   ImpersonateAuthenticated,
   ImpersonateUnauthenticated,