@settlemint/sdk-hasura/dist/hasura.js

Hasura and PostgreSQL integration module for SettleMint SDK, enabling database operations and GraphQL queries

import { appendHeaders } from "@settlemint/sdk-utils/http";
import { requestLogger } from "@settlemint/sdk-utils/logging";
import { ensureServer } from "@settlemint/sdk-utils/runtime";
import { ApplicationAccessTokenSchema, UrlOrPathSchema, validate } from "@settlemint/sdk-utils/validation";
import { initGraphQLTada, readFragment } from "gql.tada";
import { GraphQLClient } from "graphql-request";
import { z } from "zod/v4";

//#region src/hasura.ts
/**
* Schema for validating client options for the Hasura client.
*/
const ClientOptionsSchema = z.object({
	instance: UrlOrPathSchema,
	accessToken: ApplicationAccessTokenSchema.optional(),
	adminSecret: z.string(),
	cache: z.enum([
		"default",
		"force-cache",
		"no-cache",
		"no-store",
		"only-if-cached",
		"reload"
	]).optional()
});
/**
* Creates a Hasura GraphQL client with proper type safety using gql.tada
*
* @param options - Configuration options for the client
* @param clientOptions - Optional GraphQL client configuration options
* @param logger - Optional logger to use for logging the requests
* @returns An object containing:
*          - client: The configured GraphQL client instance
*          - graphql: The initialized gql.tada function for type-safe queries
* @throws Will throw an error if the options fail validation against ClientOptionsSchema
* @example
* import { createHasuraClient } from '@settlemint/sdk-hasura';
* import type { introspection } from "@schemas/hasura-env";
* import { createLogger, requestLogger } from "@settlemint/sdk-utils/logging";
*
* const logger = createLogger();
*
* const { client, graphql } = createHasuraClient<{
*   introspection: introspection;
*   disableMasking: true;
*   scalars: {
*     timestamp: string;
*     timestampz: string;
*     uuid: string;
*     date: string;
*     time: string;
*     jsonb: string;
*     numeric: string;
*     interval: string;
*     geometry: string;
*     geography: string;
*   };
* }>({
*   instance: process.env.SETTLEMINT_HASURA_ENDPOINT,
*   accessToken: process.env.SETTLEMINT_ACCESS_TOKEN,
*   adminSecret: process.env.SETTLEMINT_HASURA_ADMIN_SECRET,
* }, {
*   fetch: requestLogger(logger, "hasura", fetch) as typeof fetch,
* });
*
* // Making GraphQL queries
* const query = graphql(`
*   query GetUsers {
*     users {
*       id
*       name
*       email
*     }
*   }
* `);
*
* const result = await client.request(query);
*/
function createHasuraClient(options, clientOptions, logger) {
	ensureServer();
	const validatedOptions = validate(ClientOptionsSchema, options);
	const graphql = initGraphQLTada();
	const fullUrl = new URL(validatedOptions.instance).toString();
	return {
		client: new GraphQLClient(fullUrl, {
			...clientOptions,
			headers: appendHeaders(clientOptions?.headers, {
				"x-auth-token": validatedOptions.accessToken,
				"x-hasura-admin-secret": validatedOptions.adminSecret
			}),
			fetch: logger ? requestLogger(logger, "hasura", fetch) : fetch
		}),
		graphql
	};
}

//#endregion
export { ClientOptionsSchema, createHasuraClient, readFragment };
//# sourceMappingURL=hasura.js.map