sailfork / t3code-github / .repos/ alchemy-effect/ packages/ gcp/ src/ FirebaseDataConnect/ ExecuteGraphqlRead.ts

import type * as firebasedataconnect from "@distilled.cloud/gcp/firebasedataconnect_v1";
import * as Binding from "alchemy/Binding";
import type { RuntimeContext } from "alchemy/RuntimeContext";
import type * as Effect from "effect/Effect";
import type { Service } from "./Service.ts";

export interface ExecuteGraphqlReadRequest extends Omit<
  firebasedataconnect.ExecuteGraphqlReadProjectsLocationsServicesRequest,
  "name"
> {}

/**
 * Runtime binding for Data Connect `services.executeGraphqlRead`.
 *
 * Same as {@link ExecuteGraphql} but rejects mutations. Provide
 * {@link ExecuteGraphqlReadHttp}.
 *
 * ### Reading GraphQL
 * **Example:** Read-only query
 * ```typescript
 * const executeGraphqlRead =
 *   yield* GCP.FirebaseDataConnect.ExecuteGraphqlRead(service);
 * const result = yield* executeGraphqlRead({
 *   body: { query: "{ __typename }" },
 * });
 * ```
 *
 * @binding
 * @category FirebaseDataConnect
 */
export interface ExecuteGraphqlRead extends Binding.Service<
  ExecuteGraphqlRead,
  "GCP.FirebaseDataConnect.ExecuteGraphqlRead",
  (
    service: Service,
  ) => Effect.Effect<
    (
      request: ExecuteGraphqlReadRequest,
    ) => Effect.Effect<
      firebasedataconnect.GraphqlResponse,
      firebasedataconnect.ExecuteGraphqlReadProjectsLocationsServicesError,
      RuntimeContext
    >
  >
> {}

export const ExecuteGraphqlRead = Binding.Service<ExecuteGraphqlRead>(
  "GCP.FirebaseDataConnect.ExecuteGraphqlRead",
);