@settlemint/sdk-hasura

SettleMint SDK

✨ https://settlemint.com ✨
Integrate SettleMint into your application with ease.

Documentation   •   NPM   •   Issues

Table of Contents

• About
• API Reference
  • Functions
    • createHasuraClient()
    • createHasuraMetadataClient()
    • createPostgresPool()
    • trackAllTables()
  • Type Aliases
    • ClientOptions
    • RequestConfig
  • Variables
    • ClientOptionsSchema
• Contributing
• License

About

The SettleMint Hasura SDK provides a seamless way to interact with Hasura GraphQL APIs for managing application data. It enables you to easily query and mutate data stored in your SettleMint-powered PostgreSQL databases through a type-safe GraphQL interface.

API Reference

Functions

createHasuraClient()

createHasuraClient<Setup>(options, clientOptions?, logger?): object

Defined in: sdk/hasura/src/hasura.ts:83

Creates a Hasura GraphQL client with proper type safety using gql.tada

Type Parameters

Type Parameter
Setup extends AbstractSetupSchema

Parameters

Parameter	Type	Description
options	{ accessToken?: string; adminSecret: string; cache?: "default" | "force-cache" | "no-cache" | "no-store" | "only-if-cached" | "reload"; instance: string; }	Configuration options for the client
options.accessToken?	string	-
options.adminSecret?	string	-
options.cache?	"default" | "force-cache" | "no-cache" | "no-store" | "only-if-cached" | "reload"	-
options.instance?	string	-
clientOptions?	RequestConfig	Optional GraphQL client configuration options
logger?	Logger	Optional logger to use for logging the requests

Returns

object

An object containing: - client: The configured GraphQL client instance - graphql: The initialized gql.tada function for type-safe queries

Name	Type	Defined in
client	GraphQLClient	sdk/hasura/src/hasura.ts:88
graphql	initGraphQLTada<Setup>	sdk/hasura/src/hasura.ts:89

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);

createHasuraMetadataClient()

createHasuraMetadataClient(options, logger?): <T>(query) => Promise<{ data: T; ok: boolean; }>

Defined in: sdk/hasura/src/hasura.ts:132

Creates a Hasura Metadata client

Parameters

Parameter	Type	Description
options	{ accessToken?: string; adminSecret: string; cache?: "default" | "force-cache" | "no-cache" | "no-store" | "only-if-cached" | "reload"; instance: string; }	Configuration options for the client
options.accessToken?	string	-
options.adminSecret?	string	-
options.cache?	"default" | "force-cache" | "no-cache" | "no-store" | "only-if-cached" | "reload"	-
options.instance?	string	-
logger?	Logger	Optional logger to use for logging the requests

Returns

A function that can be used to make requests to the Hasura Metadata API

<T>(query): Promise<{ data: T; ok: boolean; }>

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
query	object

Returns

Promise<{ data: T; ok: boolean; }>

Throws

Will throw an error if the options fail validation against ClientOptionsSchema

Example

import { createHasuraMetadataClient } from '@settlemint/sdk-hasura';

const client = createHasuraMetadataClient({
  instance: process.env.SETTLEMINT_HASURA_ENDPOINT,
  accessToken: process.env.SETTLEMINT_ACCESS_TOKEN,
  adminSecret: process.env.SETTLEMINT_HASURA_ADMIN_SECRET,
});

const result = await client({
  type: "pg_get_source_tables",
  args: {
    source: "default",
  },
});

createPostgresPool()

createPostgresPool(databaseUrl): Pool

Defined in: sdk/hasura/src/postgres.ts:107

Creates a PostgreSQL connection pool with error handling and retry mechanisms

Parameters

Parameter	Type	Description
databaseUrl	string	The PostgreSQL connection URL

Returns

Pool

A configured PostgreSQL connection pool

Throws

Will throw an error if called from browser runtime

Example

import { createPostgresPool } from '@settlemint/sdk-hasura';

const pool = createPostgresPool(process.env.SETTLEMINT_HASURA_DATABASE_URL);

// The pool will automatically handle connection errors and retries
const client = await pool.connect();
try {
  const result = await client.query('SELECT NOW()');
  console.log(result.rows[0]);
} finally {
  client.release();
}

trackAllTables()

trackAllTables(databaseName, client, tableOptions): Promise<{ messages: string[]; result: "success" | "no-tables"; }>

Defined in: sdk/hasura/src/utils/track-all-tables.ts:30

Track all tables in a database

Parameters

Parameter	Type	Description
databaseName	string	The name of the database to track tables for
client	<T>(query) => Promise<{ data: T; ok: boolean; }>	The client options to use for the Hasura client
tableOptions	{ excludeSchemas?: string[]; includeSchemas?: string[]; }	The options to use for the table tracking
tableOptions.excludeSchemas?	string[]	The schemas to exclude from the tracking
tableOptions.includeSchemas?	string[]	The schemas to include in the tracking

Returns

Promise<{ messages: string[]; result: "success" | "no-tables"; }>

A promise that resolves to an object with a result property indicating success or failure

Example

import { trackAllTables } from "@settlemint/sdk-hasura/utils/track-all-tables";

const client = createHasuraMetadataClient({
  instance: "http://localhost:8080",
  accessToken: "test",
  adminSecret: "test",
});

const result = await trackAllTables("default", client, {
  excludeSchemas: ["drizzle"],
});
if (result.result === "success") {
  console.log("Tables tracked successfully");
} else {
  console.error("Failed to track tables");
}

Type Aliases

ClientOptions

ClientOptions = object

Defined in: sdk/hasura/src/hasura.ts:28

Type definition for client options derived from the ClientOptionsSchema.

Type declaration

Name	Type	Default value	Defined in
accessToken?	string	-	sdk/hasura/src/hasura.ts:20
adminSecret	string	-	sdk/hasura/src/hasura.ts:21
cache?	"default" | "force-cache" | "no-cache" | "no-store" | "only-if-cached" | "reload"	-	sdk/hasura/src/hasura.ts:22
instance	string	UrlOrPathSchema	sdk/hasura/src/hasura.ts:19

RequestConfig

RequestConfig = ConstructorParameters<typeof GraphQLClient>[1]

Defined in: sdk/hasura/src/hasura.ts:13

Type definition for GraphQL client configuration options

Variables

ClientOptionsSchema

const ClientOptionsSchema: ZodObject<ClientOptions>

Defined in: sdk/hasura/src/hasura.ts:18

Schema for validating client options for the Hasura client.

Contributing

We welcome contributions from the community! Please check out our Contributing guide to learn how you can help improve the SettleMint SDK through bug reports, feature requests, documentation updates, or code contributions.

License

The SettleMint SDK is released under the FSL Software License. See the LICENSE file for more details.