UNPKG

2.67 kBTypeScriptView Raw
1import { PreprocessingData, ProcessedSecurityScheme } from './types/preprocessing_data';
2export declare enum MitigationTypes {
3 /**
4 * Problems with the OAS
5 *
6 * Should be caught by the module oas-validator
7 */
8 INVALID_OAS = "INVALID_OAS",
9 UNNAMED_PARAMETER = "UNNAMED_PARAMETER",
10 AMBIGUOUS_UNION_MEMBERS = "AMBIGUOUS_UNION_MEMBERS",
11 CANNOT_GET_FIELD_TYPE = "CANNOT_GET_FIELD_TYPE",
12 COMBINE_SCHEMAS = "COMBINE_SCHEMAS",
13 DUPLICATE_FIELD_NAME = "DUPLICATE_FIELD_NAME",
14 DUPLICATE_LINK_KEY = "DUPLICATE_LINK_KEY",
15 INVALID_HTTP_METHOD = "INVALID_HTTP_METHOD",
16 INPUT_UNION = "INPUT_UNION",
17 MISSING_RESPONSE_SCHEMA = "MISSING_RESPONSE_SCHEMA",
18 MISSING_SCHEMA = "MISSING_SCHEMA",
19 MULTIPLE_RESPONSES = "MULTIPLE_RESPONSES",
20 NON_APPLICATION_JSON_SCHEMA = "NON_APPLICATION_JSON_SCHEMA",
21 OBJECT_MISSING_PROPERTIES = "OBJECT_MISSING_PROPERTIES",
22 UNKNOWN_TARGET_TYPE = "UNKNOWN_TARGET_TYPE",
23 UNRESOLVABLE_SCHEMA = "UNRESOLVABLE_SCHEMA",
24 UNSUPPORTED_HTTP_SECURITY_SCHEME = "UNSUPPORTED_HTTP_SECURITY_SCHEME",
25 UNSUPPORTED_JSON_SCHEMA_KEYWORD = "UNSUPPORTED_JSON_SCHEMA_KEYWORD",
26 CALLBACKS_MULTIPLE_OPERATION_OBJECTS = "CALLBACKS_MULTIPLE_OPERATION_OBJECTS",
27 AMBIGUOUS_LINK = "AMBIGUOUS_LINK",
28 LINK_NAME_COLLISION = "LINK_NAME_COLLISION",
29 UNRESOLVABLE_LINK = "UNRESOLVABLE_LINK",
30 DUPLICATE_OPERATIONID = "DUPLICATE_OPERATIONID",
31 DUPLICATE_SECURITY_SCHEME = "DUPLICATE_SECURITY_SCHEME",
32 MULTIPLE_OAS_SAME_TITLE = "MULTIPLE_OAS_SAME_TITLE",
33 CUSTOM_RESOLVER_UNKNOWN_OAS = "CUSTOM_RESOLVER_UNKNOWN_OAS",
34 CUSTOM_RESOLVER_UNKNOWN_PATH_METHOD = "CUSTOM_RESOLVER_UNKNOWN_PATH_METHOD",
35 LIMIT_ARGUMENT_NAME_COLLISION = "LIMIT_ARGUMENT_NAME_COLLISION",
36 OAUTH_SECURITY_SCHEME = "OAUTH_SECURITY_SCHEME"
37}
38export declare const mitigations: {
39 [mitigationType in MitigationTypes]: string;
40};
41/**
42 * Utilities that are specific to OpenAPI-to-GraphQL
43 */
44export declare function handleWarning<TSource, TContext, TArgs>({ mitigationType, message, mitigationAddendum, path, data, log, }: {
45 mitigationType: MitigationTypes;
46 message: string;
47 mitigationAddendum?: string;
48 path?: string[];
49 data: PreprocessingData<TSource, TContext, TArgs>;
50 log?: Function;
51}): void;
52export declare function sortObject<T>(o: T): T;
53/**
54 * Finds the common property names between two objects
55 */
56export declare function getCommonPropertyNames(object1: {
57 [key: string]: ProcessedSecurityScheme;
58}, object2: {
59 [key: string]: ProcessedSecurityScheme;
60}): (string | number)[];
61export declare function mockDebug(...args1: any[]): (...args2: any[]) => void;