@probitas/client-graphql

GraphQL client for Probitas scenario testing framework.

This package provides a GraphQL client designed for integration testing of GraphQL APIs.

Features

• Query & Mutation: Full support for GraphQL operations
• Variables Support: Pass typed variables to queries and mutations
• Duration Tracking: Built-in timing for performance monitoring
• Error Inspection: Inspect GraphQL errors and their structure
• Resource Management: Implements AsyncDisposable for proper cleanup
• Template Literals: Re-exports outdent for clean multi-line queries

Installation

deno add jsr:@probitas/client-graphql

Quick Start

import { createGraphqlClient, outdent } from "@probitas/client-graphql";

const client = createGraphqlClient({ url: "http://localhost:4000/graphql" });

// Query with variables
const res = await client.query(outdent`
  query GetUser($id: ID!) {
    user(id: $id) { id name email }
  }
`, { id: "123" });
console.log("User:", res.data);

// Mutation
const created = await client.mutation(outdent`
  mutation CreateUser($input: CreateUserInput!) {
    createUser(input: $input) { id name }
  }
`, { input: { name: "Jane", email: "jane@example.com" } });
console.log("Created:", created.data);

await client.close();

Using with using Statement

import { createGraphqlClient } from "@probitas/client-graphql";

await using client = createGraphqlClient({ url: "http://localhost:4000/graphql" });

const res = await client.query(`{ __typename }`);
console.log(res.data);
// Client automatically closed when block exits

Related Packages

Links

• GitHub Repository
• Probitas Framework

deno add jsr:@probitas/client-graphql

class GraphqlExecutionError extends ClientError

new GraphqlExecutionError(
  errors: readonly GraphqlErrorItem[],
  options?: ErrorOptions,
)

class GraphqlNetworkError extends ClientError

new GraphqlNetworkError(message: string, options?: ErrorOptions)

interface GraphqlClient extends AsyncDisposable

query<TData = any, TVariables = Record<string, any>>(
  query: string,
  variables?: TVariables,
  options?: GraphqlOptions,
): Promise<GraphqlResponse<TData>>

mutation<TData = any, TVariables = Record<string, any>>(
  mutation: string,
  variables?: TVariables,
  options?: GraphqlOptions,
): Promise<GraphqlResponse<TData>>

execute<TData = any, TVariables = Record<string, any>>(
  document: string,
  variables?: TVariables,
  options?: GraphqlOptions,
): Promise<GraphqlResponse<TData>>

subscribe<TData = any, TVariables = Record<string, any>>(
  document: string,
  variables?: TVariables,
  options?: GraphqlOptions,
): AsyncIterable<GraphqlResponse<TData>>

close(): Promise<void>

interface GraphqlClientConfig extends CommonOptions

interface GraphqlConnectionConfig extends CommonConnectionConfig

interface GraphqlErrorItem

interface GraphqlOptions extends CommonOptions

interface GraphqlResponseError<T = any> extends GraphqlResponseBase<T>

interface GraphqlResponseErrorParams<T>

interface GraphqlResponseFailure<T = any> extends GraphqlResponseBase<T>

interface GraphqlResponseFailureParams

interface GraphqlResponseSuccess<T = any> extends GraphqlResponseBase<T>

interface GraphqlResponseSuccessParams<T>

function createGraphqlClient(config: GraphqlClientConfig): GraphqlClient

import { createGraphqlClient } from "@probitas/client-graphql";

const client = createGraphqlClient({
  url: "http://localhost:4000/graphql",
});

const response = await client.query(`
  query GetUser($id: ID!) {
    user(id: $id) { id name email }
  }
`, { id: "123" });

console.log(response.data);
await client.close();

import { createGraphqlClient } from "@probitas/client-graphql";

const client = createGraphqlClient({
  url: { host: "api.example.com", port: 443, protocol: "https" },
});
await client.close();

import { createGraphqlClient } from "@probitas/client-graphql";

const client = createGraphqlClient({ url: "http://localhost:4000/graphql" });

const response = await client.mutation(`
  mutation CreateUser($input: CreateUserInput!) {
    createUser(input: $input) { id }
  }
`, { input: { name: "Alice", email: "alice@example.com" } });

if (response.ok) {
  console.log("Created user:", (response.data as any).createUser.id);
}

await client.close();

import { createGraphqlClient } from "@probitas/client-graphql";

await using client = createGraphqlClient({
  url: "http://localhost:4000/graphql",
});
const response = await client.query(`{ __typename }`);
// Client automatically closed when scope exits

type GraphqlFailureError = GraphqlNetworkError | AbortError | TimeoutError

type GraphqlResponse<T = any> = GraphqlResponseSuccess<T> | GraphqlResponseError<T> | GraphqlResponseFailure<T>

const outdent: Outdent