@hasura/ndc-sdk-typescript/dist/connector.d.ts

This SDK is mostly analogous to the Rust SDK, except where necessary.

import { Registry } from "prom-client";
import { Capabilities, QueryRequest, QueryResponse, SchemaResponse, ExplainResponse, MutationRequest, MutationResponse } from "./schema";
export interface Connector<Configuration, State> {
    /**
     * Validate the configuration files provided by the user, returning a validated 'Configuration',
     * or throwing an 'Error'. Throwing an error prevents Connector startup.
     * @param configuration
     */
    parseConfiguration(configurationDir: string): Promise<Configuration>;
    /**
     * Initialize the connector's in-memory state.
     *
     * For example, any connection pools, prepared queries,
     * or other managed resources would be allocated here.
     *
     * In addition, this function should register any
     * connector-specific metrics with the metrics registry.
     * @param configuration
     * @param metrics
     */
    tryInitState(configuration: Configuration, metrics: Registry): Promise<State>;
    /**
     *
     * Update any metrics from the state
     *
     * Note: some metrics can be updated directly, and do not
     * need to be updated here. This function can be useful to
     * query metrics which cannot be updated directly, e.g.
     * the number of idle connections in a connection pool
     * can be polled but not updated directly.
     * @param configuration
     * @param state
     */
    fetchMetrics(configuration: Configuration, state: State): Promise<undefined>;
    /**
     * Check the health of the connector.
     *
     * This should simply verify that the connector is ready to start accepting
     * requests. It should not verify that external data sources are available.
     *
     * This function is optional to implement; if left unimplemented, a default
     * implementation will be used that returns healthy once the connector
     * webserver is running.
     *
     * @param configuration
     * @param state
     */
    getHealthReadiness?(configuration: Configuration, state: State): Promise<undefined>;
    /**
     * Get the connector's capabilities.
     *
     * This function implements the [capabilities endpoint](https://hasura.github.io/ndc-spec/specification/capabilities.html)
     * from the NDC specification.
     *
     * This function should be synchronous
     * @param configuration
     */
    getCapabilities(configuration: Configuration): Capabilities;
    /**
     * Get the connector's schema.
     *
     * This function implements the [schema endpoint](https://hasura.github.io/ndc-spec/specification/schema/index.html)
     * from the NDC specification.
     * @param configuration
     */
    getSchema(configuration: Configuration): Promise<SchemaResponse>;
    /**
     * Explain a query by creating an execution plan
     *
     * This function implements the [explain endpoint](https://hasura.github.io/ndc-spec/specification/explain.html)
     * from the NDC specification.
     * @param configuration
     * @param state
     * @param request
     */
    queryExplain(configuration: Configuration, state: State, request: QueryRequest): Promise<ExplainResponse>;
    /**
     * Explain a mutation by creating an execution plan
     *
     * This function implements the [explain endpoint](https://hasura.github.io/ndc-spec/specification/explain.html)
     * from the NDC specification.
     * @param configuration
     * @param state
     * @param request
     */
    mutationExplain(configuration: Configuration, state: State, request: MutationRequest): Promise<ExplainResponse>;
    /**
     * Execute a mutation
     *
     * This function implements the [mutation endpoint](https://hasura.github.io/ndc-spec/specification/mutations/index.html)
     * from the NDC specification.
     * @param configuration
     * @param state
     * @param request
     */
    mutation(configuration: Configuration, state: State, request: MutationRequest): Promise<MutationResponse>;
    /**
     * Execute a query
     *
     * This function implements the [query endpoint](https://hasura.github.io/ndc-spec/specification/queries/index.html)
     * from the NDC specification.
     * @param configuration
     * @param state
     * @param request
     */
    query(configuration: Configuration, state: State, request: QueryRequest): Promise<QueryResponse>;
}
//# sourceMappingURL=connector.d.ts.map