firebase-admin.data-connect.api.md

API Report File for "firebase-admin.data-connect"

Do not edit this file. It is a report generated by API Extractor.

import { Agent } from 'http';

// Warning: (ae-forgotten-export) The symbol "DecodedIdToken" needs to be exported by the entry point index.d.ts
//
// @public
export type AuthClaims = Partial<DecodedIdToken>;

// @public
export interface ConnectorConfig {
    location: string;
    serviceId: string;
}

// @public
export class DataConnect {
    // Warning: (ae-forgotten-export) The symbol "App" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    readonly app: App;
    // (undocumented)
    readonly connectorConfig: ConnectorConfig;
    // @beta
    executeGraphql<GraphqlResponse, Variables>(query: string, options?: GraphqlOptions<Variables>): Promise<ExecuteGraphqlResponse<GraphqlResponse>>;
    // @beta
    executeGraphqlRead<GraphqlResponse, Variables>(query: string, options?: GraphqlOptions<Variables>): Promise<ExecuteGraphqlResponse<GraphqlResponse>>;
    // @beta
    insert<GraphQlResponse, Variables extends object>(tableName: string, variables: Variables): Promise<ExecuteGraphqlResponse<GraphQlResponse>>;
    // @beta
    insertMany<GraphQlResponse, Variables extends Array<unknown>>(tableName: string, variables: Variables): Promise<ExecuteGraphqlResponse<GraphQlResponse>>;
    // @beta
    upsert<GraphQlResponse, Variables extends object>(tableName: string, variables: Variables): Promise<ExecuteGraphqlResponse<GraphQlResponse>>;
    // @beta
    upsertMany<GraphQlResponse, Variables extends Array<unknown>>(tableName: string, variables: Variables): Promise<ExecuteGraphqlResponse<GraphQlResponse>>;
}

// @public
export interface ExecuteGraphqlResponse<GraphqlResponse> {
    data: GraphqlResponse;
}

// @public
export function getDataConnect(connectorConfig: ConnectorConfig, app?: App): DataConnect;

// @public
export interface GraphqlOptions<Variables> {
    impersonate?: ImpersonateAuthenticated | ImpersonateUnauthenticated;
    operationName?: string;
    variables?: Variables;
}

// @public
export interface ImpersonateAuthenticated {
    authClaims: AuthClaims;
    unauthenticated?: never;
}

// @public
export interface ImpersonateUnauthenticated {
    authClaims?: never;
    unauthenticated: true;
}