Skip to content

Commit 60649e4

Browse files
committed
revert OperationRef.execute() API to executeOperation API
1 parent 12f1258 commit 60649e4

4 files changed

Lines changed: 19 additions & 25 deletions

File tree

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import {
2323
import { PrefixedFirebaseError } from '../utils/error';
2424
import * as utils from '../utils/index';
2525
import * as validator from '../utils/validator';
26-
import { ConnectorConfig, ExecuteGraphqlResponse, GraphqlOptions, RefOptions } from './data-connect-api';
26+
import { ConnectorConfig, ExecuteGraphqlResponse, GraphqlOptions, OperationOptions } from './data-connect-api';
2727

2828
const API_VERSION = 'v1';
2929

@@ -176,7 +176,7 @@ export class DataConnectApiClient {
176176
public async executeQuery<GraphqlResponse, Variables>(
177177
name: string,
178178
variables: Variables,
179-
options?: RefOptions
179+
options?: OperationOptions
180180
): Promise<ExecuteGraphqlResponse<GraphqlResponse>> {
181181
return this.executeOperationHelper(IMPERSONATE_QUERY_ENDPOINT, name, variables, options);
182182
}
@@ -190,7 +190,7 @@ export class DataConnectApiClient {
190190
public async executeMutation<GraphqlResponse, Variables>(
191191
name: string,
192192
variables: Variables,
193-
options?: RefOptions
193+
options?: OperationOptions
194194
): Promise<ExecuteGraphqlResponse<GraphqlResponse>> {
195195
return this.executeOperationHelper(IMPERSONATE_MUTATION_ENDPOINT, name, variables, options);
196196
}
@@ -207,7 +207,7 @@ export class DataConnectApiClient {
207207
endpoint: string,
208208
name: string,
209209
variables: Variables,
210-
options?: RefOptions
210+
options?: OperationOptions
211211
): Promise<ExecuteGraphqlResponse<GraphqlResponse>> {
212212
if (
213213
typeof name === 'undefined' ||

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export interface ExecuteGraphqlResponse<GraphqlResponse> {
4848
}
4949

5050
/**
51-
* Interface representing GraphQL options.
51+
* Interface representing GraphQL options for executing arbitrary GraphQL operations.
5252
*/
5353
export interface GraphqlOptions<Variables> {
5454
/**
@@ -71,9 +71,9 @@ export interface GraphqlOptions<Variables> {
7171
}
7272

7373
/**
74-
* Interface representing options for OperationRefs.
74+
* Interface representing options for executing defined operations.
7575
*/
76-
export interface RefOptions {
76+
export interface OperationOptions {
7777
/**
7878
* If set, impersonate a request with given Firebase Auth context and evaluate the auth
7979
* policies on the operation. If omitted, bypass any defined auth policies.

src/data-connect/data-connect.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import {
2222
ConnectorConfig,
2323
ExecuteGraphqlResponse,
2424
GraphqlOptions,
25-
RefOptions,
25+
OperationOptions,
2626
} from './data-connect-api';
2727

2828
export class DataConnectService {
@@ -160,7 +160,7 @@ export class DataConnect {
160160
}
161161

162162
/**
163-
* Executes a pre-defined GraphQL query with impersonation.
163+
* Executes a deployed GraphQL query, optionally with auth impersonation.
164164
*
165165
* The query must be defined in your Data Connect GraphQL files.
166166
*
@@ -169,11 +169,11 @@ export class DataConnect {
169169
*/
170170
public executeQuery<Data>(
171171
name: string,
172-
options?: RefOptions
172+
options?: OperationOptions
173173
): Promise<ExecuteGraphqlResponse<Data>>;
174174

175175
/**
176-
* Executes a pre-defined GraphQL query with impersonation.
176+
* Executes a pre-defined GraphQL query, optionally with auth impersonation.
177177
*
178178
* The query must be defined in your Data Connect GraphQL files.
179179
*
@@ -184,19 +184,19 @@ export class DataConnect {
184184
public executeQuery<Data, Variables>(
185185
name: string,
186186
variables: Variables,
187-
options?: RefOptions
187+
options?: OperationOptions
188188
): Promise<ExecuteGraphqlResponse<Data>>;
189189

190190
public executeQuery<Data, Variables>(
191191
name: string,
192192
variables: Variables,
193-
options?: RefOptions
193+
options?: OperationOptions
194194
): Promise<ExecuteGraphqlResponse<Data>> {
195195
return this.client.executeQuery<Data, Variables>(name, variables, options);
196196
}
197197

198198
/**
199-
* Executes a pre-defined GraphQL mutation with impersonation.
199+
* Executes a pre-defined GraphQL mutation, optionally with auth impersonation.
200200
*
201201
* The mutation must be defined in your Data Connect GQL files.
202202
*
@@ -205,11 +205,11 @@ export class DataConnect {
205205
*/
206206
public executeMutation<Data>(
207207
name: string,
208-
options?: RefOptions
208+
options?: OperationOptions
209209
): Promise<ExecuteGraphqlResponse<Data>>;
210210

211211
/**
212-
* Executes a pre-defined GraphQL mutation with impersonation.
212+
* Executes a pre-defined GraphQL mutation, optionally with auth impersonation.
213213
*
214214
* The mutation must be defined in your Data Connect GQL files.
215215
*
@@ -220,13 +220,13 @@ export class DataConnect {
220220
public executeMutation<Data, Variables>(
221221
name: string,
222222
variables: Variables,
223-
options?: RefOptions
223+
options?: OperationOptions
224224
): Promise<ExecuteGraphqlResponse<Data>>;
225225

226226
public executeMutation<Data, Variables>(
227227
name: string,
228228
variables: Variables,
229-
options?: RefOptions
229+
options?: OperationOptions
230230
): Promise<ExecuteGraphqlResponse<Data>> {
231231
return this.client.executeMutation<Data, Variables>(name, variables, options);
232232
}

src/data-connect/index.ts

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,10 @@ export {
3333
ImpersonateAuthenticated,
3434
ImpersonateUnauthenticated,
3535
AuthClaims,
36-
RefOptions,
36+
OperationOptions,
3737
} from './data-connect-api'
3838
export {
3939
DataConnect,
40-
OperationRef,
41-
QueryRef,
42-
MutationRef,
43-
OperationResult,
44-
QueryResult,
45-
MutationResult,
4640
} from './data-connect'
4741

4842
/**

0 commit comments

Comments
 (0)