@omnigraph/json-schema 1.0.0-alpha-3fc47d119.0 → 1.0.0-alpha-20230420181317-a95037648

package/typings/loadGraphQLSchemaFromJSONSchemas.d.cts

@@ -0,0 +1,3 @@
+import { JSONSchemaLoaderOptions } from './types.cjs';
+export declare function loadNonExecutableGraphQLSchemaFromJSONSchemas(name: string, options: JSONSchemaLoaderOptions): Promise<import("graphql").GraphQLSchema>;
+export declare function loadGraphQLSchemaFromJSONSchemas(name: string, options: JSONSchemaLoaderOptions): Promise<import("graphql").GraphQLSchema>;

package/typings/loadGraphQLSchemaFromJSONSchemas.d.ts

@@ -0,0 +1,3 @@
+import { JSONSchemaLoaderOptions } from './types.js';
+export declare function loadNonExecutableGraphQLSchemaFromJSONSchemas(name: string, options: JSONSchemaLoaderOptions): Promise<import("graphql").GraphQLSchema>;
+export declare function loadGraphQLSchemaFromJSONSchemas(name: string, options: JSONSchemaLoaderOptions): Promise<import("graphql").GraphQLSchema>;

package/typings/resolveDataByUnionInputType.d.cts

@@ -0,0 +1,2 @@
+import { GraphQLInputType, GraphQLSchema } from 'graphql';
+export declare function resolveDataByUnionInputType(data: any, type: GraphQLInputType, schema: GraphQLSchema): any;

package/typings/resolveDataByUnionInputType.d.ts

@@ -0,0 +1,2 @@
+import { GraphQLInputType, GraphQLSchema } from 'graphql';
+export declare function resolveDataByUnionInputType(data: any, type: GraphQLInputType, schema: GraphQLSchema): any;

package/typings/scalars.d.cts

@@ -0,0 +1,4 @@
+import { GraphQLScalarType } from 'graphql';
+export declare const GraphQLFile: GraphQLScalarType<unknown, unknown>;
+export declare const GraphQLVoid: GraphQLScalarType<unknown, string>;
+export declare const ObjMapScalar: GraphQLScalarType<any, string>;

package/typings/scalars.d.ts

@@ -0,0 +1,4 @@
+import { GraphQLScalarType } from 'graphql';
+export declare const GraphQLFile: GraphQLScalarType<unknown, unknown>;
+export declare const GraphQLVoid: GraphQLScalarType<unknown, string>;
+export declare const ObjMapScalar: GraphQLScalarType<any, string>;

package/typings/types.d.cts

@@ -0,0 +1,76 @@
+import { OperationTypeNode } from 'graphql';
+import { PromiseOrValue } from 'graphql/jsutils/PromiseOrValue';
+import { JSONSchema, JSONSchemaObject } from 'json-machete';
+import { IStringifyOptions } from 'qs';
+import { ResolverData } from '@graphql-mesh/string-interpolation';
+import { Logger, MeshFetch, MeshPubSub } from '@graphql-mesh/types';
+import { BaseLoaderOptions } from '@graphql-tools/utils';
+export interface JSONSchemaLoaderOptions extends BaseLoaderOptions {
+    endpoint?: string;
+    operationHeaders?: OperationHeadersConfiguration;
+    timeout?: number;
+    schemaHeaders?: Record<string, string>;
+    operations: JSONSchemaOperationConfig[];
+    errorMessage?: string;
+    logger?: Logger;
+    pubsub?: MeshPubSub;
+    fetch?: MeshFetch;
+    ignoreErrorResponses?: boolean;
+    queryParams?: Record<string, string | number | boolean>;
+    queryStringOptions?: IStringifyOptions;
+    bundle?: boolean;
+}
+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 type JSONSchemaBaseOperationConfig = {
+    type: OperationTypeNode;
+    field: string;
+    description?: string;
+    argTypeMap?: Record<string, string | JSONSchemaObject>;
+    responseByStatusCode?: Record<string, JSONSchemaOperationResponseConfig>;
+} & JSONSchemaOperationResponseConfig;
+export type JSONSchemaBaseOperationConfigWithJSONRequest = JSONSchemaBaseOperationConfig & {
+    requestSchema?: string | JSONSchema;
+    requestSample?: any;
+    requestTypeName?: string;
+    requestBaseBody?: any;
+};
+export type HTTPMethod = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
+export type JSONSchemaHTTPBaseOperationConfig = JSONSchemaBaseOperationConfig & {
+    path: string;
+    method?: HTTPMethod;
+    headers?: Record<string, string>;
+    queryParamArgMap?: Record<string, string>;
+    queryStringOptionsByParam?: Record<string, IStringifyOptions & {
+        destructObject?: boolean;
+    }>;
+    queryParamsSample?: any;
+};
+export type JSONSchemaHTTPJSONOperationConfig = JSONSchemaHTTPBaseOperationConfig & JSONSchemaBaseOperationConfigWithJSONRequest;
+export type JSONSchemaPubSubOperationConfig = JSONSchemaBaseOperationConfigWithJSONRequest & {
+    pubsubTopic: string;
+};
+export type JSONSchemaHTTPBinaryConfig = JSONSchemaHTTPBaseOperationConfig & {
+    path: string;
+    method?: HTTPMethod;
+    requestTypeName?: string;
+    binary: true;
+};
+export type JSONSchemaOperationConfig = JSONSchemaHTTPJSONOperationConfig | JSONSchemaHTTPBinaryConfig | JSONSchemaPubSubOperationConfig;
+export type OperationHeadersConfiguration = Record<string, string> | OperationHeadersFactory;
+export type OperationHeadersFactory = (data: ResolverData, operationConfig: {
+    endpoint: string;
+    field: string;
+    path: string;
+    method: HTTPMethod;
+}) => PromiseOrValue<Record<string, string>>;

package/typings/types.d.ts

@@ -0,0 +1,76 @@
+import { OperationTypeNode } from 'graphql';
+import { PromiseOrValue } from 'graphql/jsutils/PromiseOrValue';
+import { JSONSchema, JSONSchemaObject } from 'json-machete';
+import { IStringifyOptions } from 'qs';
+import { ResolverData } from '@graphql-mesh/string-interpolation';
+import { Logger, MeshFetch, MeshPubSub } from '@graphql-mesh/types';
+import { BaseLoaderOptions } from '@graphql-tools/utils';
+export interface JSONSchemaLoaderOptions extends BaseLoaderOptions {
+    endpoint?: string;
+    operationHeaders?: OperationHeadersConfiguration;
+    timeout?: number;
+    schemaHeaders?: Record<string, string>;
+    operations: JSONSchemaOperationConfig[];
+    errorMessage?: string;
+    logger?: Logger;
+    pubsub?: MeshPubSub;
+    fetch?: MeshFetch;
+    ignoreErrorResponses?: boolean;
+    queryParams?: Record<string, string | number | boolean>;
+    queryStringOptions?: IStringifyOptions;
+    bundle?: boolean;
+}
+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 type JSONSchemaBaseOperationConfig = {
+    type: OperationTypeNode;
+    field: string;
+    description?: string;
+    argTypeMap?: Record<string, string | JSONSchemaObject>;
+    responseByStatusCode?: Record<string, JSONSchemaOperationResponseConfig>;
+} & JSONSchemaOperationResponseConfig;
+export type JSONSchemaBaseOperationConfigWithJSONRequest = JSONSchemaBaseOperationConfig & {
+    requestSchema?: string | JSONSchema;
+    requestSample?: any;
+    requestTypeName?: string;
+    requestBaseBody?: any;
+};
+export type HTTPMethod = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
+export type JSONSchemaHTTPBaseOperationConfig = JSONSchemaBaseOperationConfig & {
+    path: string;
+    method?: HTTPMethod;
+    headers?: Record<string, string>;
+    queryParamArgMap?: Record<string, string>;
+    queryStringOptionsByParam?: Record<string, IStringifyOptions & {
+        destructObject?: boolean;
+    }>;
+    queryParamsSample?: any;
+};
+export type JSONSchemaHTTPJSONOperationConfig = JSONSchemaHTTPBaseOperationConfig & JSONSchemaBaseOperationConfigWithJSONRequest;
+export type JSONSchemaPubSubOperationConfig = JSONSchemaBaseOperationConfigWithJSONRequest & {
+    pubsubTopic: string;
+};
+export type JSONSchemaHTTPBinaryConfig = JSONSchemaHTTPBaseOperationConfig & {
+    path: string;
+    method?: HTTPMethod;
+    requestTypeName?: string;
+    binary: true;
+};
+export type JSONSchemaOperationConfig = JSONSchemaHTTPJSONOperationConfig | JSONSchemaHTTPBinaryConfig | JSONSchemaPubSubOperationConfig;
+export type OperationHeadersConfiguration = Record<string, string> | OperationHeadersFactory;
+export type OperationHeadersFactory = (data: ResolverData, operationConfig: {
+    endpoint: string;
+    field: string;
+    path: string;
+    method: HTTPMethod;
+}) => PromiseOrValue<Record<string, string>>;

package/typings/utils.d.cts

@@ -0,0 +1,15 @@
+import { OperationTypeNode } from 'graphql';
+import { HTTPMethod, JSONSchemaOperationConfig, JSONSchemaPubSubOperationConfig } from './types.cjs';
+export declare function isPubSubOperationConfig(operationConfig: JSONSchemaOperationConfig): operationConfig is JSONSchemaPubSubOperationConfig;
+export declare function getOperationMetadata(operationConfig: JSONSchemaOperationConfig): {
+    httpMethod: HTTPMethod;
+    operationType: OperationTypeNode;
+    rootTypeName: "Query" | "Mutation" | "Subscription";
+    fieldName: string;
+};
+export declare function cleanObject(obj: any): any;
+export declare function isFileUpload(obj: any): obj is {
+    createReadStream: () => AsyncIterable<Uint8Array>;
+    mimetype: string;
+};
+export declare function isFile(obj: any): obj is File;

package/{utils.d.ts → typings/utils.d.ts}

@@ -1,5 +1,5 @@
 import { OperationTypeNode } from 'graphql';
-import { JSONSchemaOperationConfig, JSONSchemaPubSubOperationConfig, HTTPMethod } from './types';
+import { HTTPMethod, JSONSchemaOperationConfig, JSONSchemaPubSubOperationConfig } from './types.js';
 export declare function isPubSubOperationConfig(operationConfig: JSONSchemaOperationConfig): operationConfig is JSONSchemaPubSubOperationConfig;
 export declare function getOperationMetadata(operationConfig: JSONSchemaOperationConfig): {
     httpMethod: HTTPMethod;

package/addExecutionLogicToComposer.d.ts

@@ -1,15 +0,0 @@
-import { SchemaComposer } from 'graphql-compose';
-import { Logger, MeshPubSub } from '@graphql-mesh/types';
-import { JSONSchemaOperationConfig } from './types';
-import { IStringifyOptions } from 'qs';
-export interface AddExecutionLogicToComposerOptions {
-    baseUrl: string;
-    operations: JSONSchemaOperationConfig[];
-    operationHeaders?: Record<string, string>;
-    fetch: WindowOrWorkerGlobalScope['fetch'];
-    logger: Logger;
-    pubsub?: MeshPubSub;
-    queryParams?: Record<string, string>;
-    queryStringOptions?: IStringifyOptions;
-}
-export declare function addExecutionLogicToComposer(schemaComposer: SchemaComposer, { fetch: globalFetch, logger, operations, operationHeaders, baseUrl, pubsub: globalPubsub, queryParams, queryStringOptions, }: AddExecutionLogicToComposerOptions): Promise<SchemaComposer<any>>;

package/bundle.d.ts

@@ -1,39 +0,0 @@
-import { JSONSchemaObject } from 'json-machete';
-import { Logger, MeshPubSub } from '@graphql-mesh/types';
-import { JSONSchemaOperationConfig } from './types';
-import { GraphQLSchema } from 'graphql';
-import type { IStringifyOptions } from 'qs';
-export interface JSONSchemaLoaderBundle {
-    name?: string;
-    baseUrl?: string;
-    operations: JSONSchemaOperationConfig[];
-    operationHeaders?: Record<string, string>;
-    referencedSchema: JSONSchemaObject;
-}
-export interface JSONSchemaLoaderBundleOptions {
-    baseUrl?: string;
-    operations: JSONSchemaOperationConfig[];
-    schemaHeaders?: Record<string, string>;
-    operationHeaders?: Record<string, string>;
-    cwd?: string;
-    ignoreErrorResponses?: boolean;
-    noDeduplication?: boolean;
-    fetch?: WindowOrWorkerGlobalScope['fetch'];
-    logger?: Logger;
-}
-export declare function createBundle(name: string, { baseUrl, operations, schemaHeaders, operationHeaders, cwd, fetch, logger, ignoreErrorResponses, noDeduplication, }: JSONSchemaLoaderBundleOptions): Promise<JSONSchemaLoaderBundle>;
-export interface JSONSchemaLoaderBundleToGraphQLSchemaOptions {
-    cwd?: string;
-    fetch?: WindowOrWorkerGlobalScope['fetch'];
-    pubsub?: MeshPubSub;
-    logger?: Logger;
-    baseUrl?: string;
-    operationHeaders?: Record<string, string>;
-    queryParams?: Record<string, string>;
-    queryStringOptions?: IStringifyOptions;
-}
-/**
- * Generates a local GraphQLSchema instance from
- * previously generated JSON Schema bundle
- */
-export declare function getGraphQLSchemaFromBundle({ name, baseUrl: bundledBaseUrl, operations, operationHeaders: bundledOperationHeaders, referencedSchema, }: JSONSchemaLoaderBundle, { cwd, fetch, pubsub, logger, baseUrl: overwrittenBaseUrl, operationHeaders: additionalOperationHeaders, queryParams, queryStringOptions, }?: JSONSchemaLoaderBundleToGraphQLSchemaOptions): Promise<GraphQLSchema>;

package/getGenericJSONScalar.d.ts

@@ -1,8 +0,0 @@
-import { JSONSchemaObject } from 'json-machete';
-import { SchemaComposer } from 'graphql-compose';
-export declare function getGenericJSONScalar({ isInput, subSchema, schemaComposer, validateWithJSONSchema, }: {
-    isInput: boolean;
-    subSchema: JSONSchemaObject;
-    schemaComposer: SchemaComposer<any>;
-    validateWithJSONSchema: (data: any) => boolean;
-}): import("graphql-compose").ScalarTypeComposer<any>;

package/getGraphQLSchemaFromDereferencedJSONSchema.d.ts

@@ -1,5 +0,0 @@
-import { JSONSchemaObject } from 'json-machete';
-import { AddExecutionLogicToComposerOptions } from './addExecutionLogicToComposer';
-export declare function getGraphQLSchemaFromDereferencedJSONSchema(fullyDeferencedSchema: JSONSchemaObject, { fetch, logger, operations, operationHeaders, baseUrl, pubsub, generateInterfaceFromSharedFields, queryParams, queryStringOptions, }: AddExecutionLogicToComposerOptions & {
-    generateInterfaceFromSharedFields?: boolean;
-}): Promise<import("graphql").GraphQLSchema>;

package/getJSONSchemaStringFormatScalarMap.d.ts

@@ -1,3 +0,0 @@
-import Ajv from 'ajv';
-import { GraphQLScalarType } from 'graphql';
-export declare function getJSONSchemaStringFormatScalarMap(ajv: Ajv): Map<string, GraphQLScalarType>;

package/getTypeResolverFromOutputTCs.d.ts

@@ -1,4 +0,0 @@
-import { GraphQLTypeResolver } from 'graphql';
-import { ObjectTypeComposer, UnionTypeComposer } from 'graphql-compose';
-import Ajv from 'ajv';
-export declare function getTypeResolverFromOutputTCs(ajv: Ajv, outputTypeComposers: (ObjectTypeComposer | UnionTypeComposer)[], statusCodeOneOfIndexMap?: Record<string, number>): GraphQLTypeResolver<any, any>;

package/getUnionTypeComposers.d.ts

@@ -1,21 +0,0 @@
-import { JSONSchemaObject } from '@json-schema-tools/meta-schema';
-import Ajv from 'ajv';
-import { AnyTypeComposer, ObjectTypeComposer, SchemaComposer, UnionTypeComposer } from 'graphql-compose';
-export interface GetUnionTypeComposersOpts {
-    schemaComposer: SchemaComposer;
-    ajv: Ajv;
-    typeComposersList: {
-        input?: AnyTypeComposer<any>;
-        output?: ObjectTypeComposer | UnionTypeComposer;
-    }[];
-    subSchema: JSONSchemaObject;
-    generateInterfaceFromSharedFields: boolean;
-    statusCodeOneOfIndexMap?: Record<string, number>;
-}
-export declare function getUnionTypeComposers({ schemaComposer, ajv, typeComposersList, subSchema, generateInterfaceFromSharedFields, statusCodeOneOfIndexMap, }: GetUnionTypeComposersOpts): {
-    input?: AnyTypeComposer<any>;
-    output?: ObjectTypeComposer<any, any> | UnionTypeComposer<any, any>;
-} | {
-    input: import("graphql-compose").InputTypeComposer<any>;
-    output: import("graphql-compose").InterfaceTypeComposer<any, any> | UnionTypeComposer<any, any>;
-};

package/getValidateFnForSchemaPath.d.ts

@@ -1,3 +0,0 @@
-import { JSONSchema } from 'json-machete';
-import Ajv from 'ajv';
-export declare function getValidateFnForSchemaPath(ajv: Ajv, path: string, schema: JSONSchema): (data: any) => boolean;

package/index.d.ts

@@ -1,9 +0,0 @@
-import { loadGraphQLSchemaFromJSONSchemas } from './loadGraphQLSchemaFromJSONSchemas';
-export default loadGraphQLSchemaFromJSONSchemas;
-export { loadGraphQLSchemaFromJSONSchemas };
-export * from './getComposerFromJSONSchema';
-export * from './getDereferencedJSONSchemaFromOperations';
-export * from './getReferencedJSONSchemaFromOperations';
-export * from './getGraphQLSchemaFromDereferencedJSONSchema';
-export * from './types';
-export * from './bundle';