@omnigraph/json-schema/types.d.ts

This package generates GraphQL Schema from JSON Schema and sample JSON request and responses. You can define your root field endpoints like below in your GraphQL Config for example;

import { ResolverData } from '@graphql-mesh/string-interpolation';
import { MeshPubSub, Logger } from '@graphql-mesh/types';
import { BaseLoaderOptions } from '@graphql-tools/utils';
import { OperationTypeNode } from 'graphql';
import { PromiseOrValue } from 'graphql/jsutils/PromiseOrValue';
import { JSONSchema, JSONSchemaObject } from 'json-machete';
import { IStringifyOptions } from 'qs';
export interface JSONSchemaLoaderOptions extends BaseLoaderOptions {
    baseUrl?: string;
    operationHeaders?: OperationHeadersConfiguration;
    schemaHeaders?: Record<string, string>;
    operations: JSONSchemaOperationConfig[];
    errorMessage?: string;
    logger?: Logger;
    pubsub?: MeshPubSub;
    fetch?: WindowOrWorkerGlobalScope['fetch'];
    ignoreErrorResponses?: boolean;
    queryParams?: Record<string, string | number | boolean>;
    queryStringOptions?: IStringifyOptions;
}
export interface JSONSchemaOperationResponseConfig {
    responseSchema?: string | JSONSchemaObject;
    responseSample?: any;
    responseTypeName?: string;
    exposeResponseMetadata?: boolean;
    links?: Record<string, JSONSchemaLinkConfig>;
}
export interface JSONSchemaLinkConfig {
    fieldName: string;
    args?: Record<string, string>;
    description?: string;
}
export declare type JSONSchemaBaseOperationConfig = {
    type: OperationTypeNode;
    field: string;
    description?: string;
    argTypeMap?: Record<string, string | JSONSchemaObject>;
    responseByStatusCode?: Record<string, JSONSchemaOperationResponseConfig>;
} & JSONSchemaOperationResponseConfig;
export declare type JSONSchemaBaseOperationConfigWithJSONRequest = JSONSchemaBaseOperationConfig & {
    requestSchema?: string | JSONSchema;
    requestSample?: any;
    requestTypeName?: string;
    requestBaseBody?: any;
};
export declare type HTTPMethod = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
export declare type JSONSchemaHTTPBaseOperationConfig = JSONSchemaBaseOperationConfig & {
    path: string;
    method?: HTTPMethod;
    headers?: Record<string, string>;
    queryParamArgMap?: Record<string, string>;
    queryStringOptionsByParam?: Record<string, IStringifyOptions & {
        destructObject?: boolean;
    }>;
};
export declare type JSONSchemaHTTPJSONOperationConfig = JSONSchemaHTTPBaseOperationConfig & JSONSchemaBaseOperationConfigWithJSONRequest;
export declare type JSONSchemaPubSubOperationConfig = JSONSchemaBaseOperationConfigWithJSONRequest & {
    pubsubTopic: string;
};
export declare type JSONSchemaHTTPBinaryConfig = JSONSchemaHTTPBaseOperationConfig & {
    path: string;
    method?: HTTPMethod;
    requestTypeName?: string;
    binary: true;
};
export declare type JSONSchemaOperationConfig = JSONSchemaHTTPJSONOperationConfig | JSONSchemaHTTPBinaryConfig | JSONSchemaPubSubOperationConfig;
export declare type OperationHeadersConfiguration = Record<string, string> | ((data: ResolverData, operationConfig: JSONSchemaOperationConfig) => PromiseOrValue<Record<string, string>>);