redoc 2.0.0-rc.9 → 2.1.0

package/typings/theme.d.ts

@@ -10,6 +10,7 @@ export interface ColorSetting {
 export interface HTTPResponseColos {
     color: string;
     backgroundColor: string;
+    tabTextColor: string;
 }
 export interface FontSettings {
     fontSize: string;
@@ -18,6 +19,15 @@ export interface FontSettings {
     lineHeight: string;
     color: string;
 }
+export interface Servers {
+    overlay: {
+        backgroundColor: string;
+        textColor: string;
+    };
+    url: {
+        backgroundColor: string;
+    };
+}
 export interface ResolvedThemeInterface {
     spacing: {
         unit: number;
@@ -35,6 +45,10 @@ export interface ResolvedThemeInterface {
         success: ColorSetting;
         warning: ColorSetting;
         error: ColorSetting;
+        gray: {
+            50: string;
+            100: string;
+        };
         border: {
             light: string;
             dark: string;
@@ -97,16 +111,23 @@ export interface ResolvedThemeInterface {
             color: string;
             visited: string;
             hover: string;
+            textDecoration: string;
+            hoverTextDecoration: string;
         };
     };
-    menu: {
+    sidebar: {
         width: string;
         backgroundColor: string;
         textColor: string;
+        activeTextColor: string;
         groupItems: {
+            activeBackgroundColor: string;
+            activeTextColor: string;
             textTransform: string;
         };
         level1Items: {
+            activeBackgroundColor: string;
+            activeTextColor: string;
             textTransform: string;
         };
         arrow: {
@@ -123,15 +144,20 @@ export interface ResolvedThemeInterface {
         backgroundColor: string;
         textColor: string;
         width: string;
+        servers: Servers;
+    };
+    codeBlock: {
+        backgroundColor: string;
     };
-    codeSample: {
+    fab: {
         backgroundColor: string;
+        color: string;
     };
     extensionsHook?: (name: string, props: any) => string;
 }
-export declare type primitive = string | number | boolean | undefined | null;
-export declare type AdvancedThemeDeep<T> = T extends primitive ? T | ((theme: ResolvedThemeInterface) => T) : AdvancedThemeObject<T>;
-export declare type AdvancedThemeObject<T> = {
+export type primitive = string | number | boolean | undefined | null;
+export type AdvancedThemeDeep<T> = T extends primitive ? T | ((theme: ResolvedThemeInterface) => T) : AdvancedThemeObject<T>;
+export type AdvancedThemeObject<T> = {
     [P in keyof T]?: AdvancedThemeDeep<T[P]>;
 };
-export declare type ThemeInterface = AdvancedThemeObject<ResolvedThemeInterface>;
+export type ThemeInterface = AdvancedThemeObject<ResolvedThemeInterface>;

package/typings/types/index.d.ts

@@ -1,8 +1,2 @@
 export * from './open-api';
-
 export type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
-declare global {
-  type Dict<T> = {
-    [key: string]: T;
-  };
-}

package/typings/types/index.ts

@@ -0,0 +1,3 @@
+export * from './open-api';
+
+export type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;

package/typings/types/open-api.d.ts

@@ -1,270 +1,308 @@
-import { Omit } from './index';
-
+import type { Omit } from './index';
 export interface OpenAPISpec {
-  openapi: string;
-  info: OpenAPIInfo;
-  servers?: OpenAPIServer[];
-  paths: OpenAPIPaths;
-  components?: OpenAPIComponents;
-  security?: OpenAPISecurityRequirement[];
-  tags?: OpenAPITag[];
-  externalDocs?: OpenAPIExternalDocumentation;
+    openapi: string;
+    info: OpenAPIInfo;
+    servers?: OpenAPIServer[];
+    paths: OpenAPIPaths;
+    components?: OpenAPIComponents;
+    security?: OpenAPISecurityRequirement[];
+    tags?: OpenAPITag[];
+    externalDocs?: OpenAPIExternalDocumentation;
+    'x-webhooks'?: OpenAPIPaths;
+    webhooks?: OpenAPIPaths;
 }
-
 export interface OpenAPIInfo {
-  title: string;
-  version: string;
-
-  description?: string;
-  termsOfService?: string;
-  contact?: OpenAPIContact;
-  license?: OpenAPILicense;
+    title: string;
+    version: string;
+    description?: string;
+    summary?: string;
+    termsOfService?: string;
+    contact?: OpenAPIContact;
+    license?: OpenAPILicense;
 }
-
 export interface OpenAPIServer {
-  url: string;
-  description?: string;
-  variables?: { [name: string]: OpenAPIServerVariable };
+    url: string;
+    description?: string;
+    variables?: {
+        [name: string]: OpenAPIServerVariable;
+    };
 }
-
 export interface OpenAPIServerVariable {
-  enum?: string[];
-  default: string;
-  description?: string;
+    enum?: string[];
+    default: string;
+    description?: string;
 }
-
 export interface OpenAPIPaths {
-  [path: string]: OpenAPIPath;
+    [path: string]: OpenAPIPath;
 }
 export interface OpenAPIRef {
-  $ref: string;
+    'x-refsStack'?: string[];
+    $ref: string;
+    summary?: string;
+    description?: string;
 }
-
 export type Referenced<T> = OpenAPIRef | T;
-
 export interface OpenAPIPath {
-  summary?: string;
-  description?: string;
-  get?: OpenAPIOperation;
-  put?: OpenAPIOperation;
-  post?: OpenAPIOperation;
-  delete?: OpenAPIOperation;
-  options?: OpenAPIOperation;
-  head?: OpenAPIOperation;
-  patch?: OpenAPIOperation;
-  trace?: OpenAPIOperation;
-  servers?: OpenAPIServer[];
-  parameters?: Array<Referenced<OpenAPIParameter>>;
+    summary?: string;
+    description?: string;
+    get?: OpenAPIOperation;
+    put?: OpenAPIOperation;
+    post?: OpenAPIOperation;
+    delete?: OpenAPIOperation;
+    options?: OpenAPIOperation;
+    head?: OpenAPIOperation;
+    patch?: OpenAPIOperation;
+    trace?: OpenAPIOperation;
+    servers?: OpenAPIServer[];
+    parameters?: Array<Referenced<OpenAPIParameter>>;
+    $ref?: string;
 }
-
 export interface OpenAPIXCodeSample {
-  lang: string;
-  label?: string;
-  source: string;
+    lang: string;
+    label?: string;
+    source: string;
 }
-
 export interface OpenAPIOperation {
-  tags?: string[];
-  summary?: string;
-  description?: string;
-  externalDocs?: OpenAPIExternalDocumentation;
-  operationId?: string;
-  parameters?: Array<Referenced<OpenAPIParameter>>;
-  requestBody?: Referenced<OpenAPIRequestBody>;
-  responses: OpenAPIResponses;
-  callbacks?: { [name: string]: Referenced<OpenAPICallback> };
-  deprecated?: boolean;
-  security?: OpenAPISecurityRequirement[];
-  servers?: OpenAPIServer[];
-  'x-code-samples'?: OpenAPIXCodeSample[];
+    tags?: string[];
+    summary?: string;
+    description?: string;
+    externalDocs?: OpenAPIExternalDocumentation;
+    operationId?: string;
+    parameters?: Array<Referenced<OpenAPIParameter>>;
+    requestBody?: Referenced<OpenAPIRequestBody>;
+    responses: OpenAPIResponses;
+    callbacks?: {
+        [name: string]: Referenced<OpenAPICallback>;
+    };
+    deprecated?: boolean;
+    security?: OpenAPISecurityRequirement[];
+    servers?: OpenAPIServer[];
+    'x-codeSamples'?: OpenAPIXCodeSample[];
+    'x-code-samples'?: OpenAPIXCodeSample[];
 }
-
 export interface OpenAPIParameter {
-  name: string;
-  in?: OpenAPIParameterLocation;
-  description?: string;
-  required?: boolean;
-  deprecated?: boolean;
-  allowEmptyValue?: boolean;
-  style?: OpenAPIParameterStyle;
-  explode?: boolean;
-  allowReserved?: boolean;
-  schema?: Referenced<OpenAPISchema>;
-  example?: any;
-  examples?: { [media: string]: Referenced<OpenAPIExample> };
-  content?: { [media: string]: OpenAPIMediaType };
+    name: string;
+    in?: OpenAPIParameterLocation;
+    description?: string;
+    required?: boolean;
+    deprecated?: boolean;
+    allowEmptyValue?: boolean;
+    style?: OpenAPIParameterStyle;
+    explode?: boolean;
+    allowReserved?: boolean;
+    schema?: Referenced<OpenAPISchema>;
+    example?: any;
+    examples?: {
+        [media: string]: Referenced<OpenAPIExample>;
+    };
+    content?: {
+        [media: string]: OpenAPIMediaType;
+    };
+    encoding?: Record<string, OpenAPIEncoding>;
+    const?: any;
 }
-
 export interface OpenAPIExample {
-  value: any;
-  summary?: string;
-  description?: string;
-  externalValue?: string;
+    value: any;
+    summary?: string;
+    description?: string;
+    externalValue?: string;
 }
-
 export interface OpenAPISchema {
-  $ref?: string;
-  type?: string;
-  properties?: { [name: string]: OpenAPISchema };
-  additionalProperties?: boolean | OpenAPISchema;
-  description?: string;
-  default?: any;
-  items?: OpenAPISchema;
-  required?: string[];
-  readOnly?: boolean;
-  writeOnly?: boolean;
-  deprecated?: boolean;
-  format?: string;
-  externalDocs?: OpenAPIExternalDocumentation;
-  discriminator?: OpenAPIDiscriminator;
-  nullable?: boolean;
-  oneOf?: OpenAPISchema[];
-  anyOf?: OpenAPISchema[];
-  allOf?: OpenAPISchema[];
-  not?: OpenAPISchema;
-
-  title?: string;
-  multipleOf?: number;
-  maximum?: number;
-  exclusiveMaximum?: boolean;
-  minimum?: number;
-  exclusiveMinimum?: boolean;
-  maxLength?: number;
-  minLength?: number;
-  pattern?: string;
-  maxItems?: number;
-  minItems?: number;
-  uniqueItems?: boolean;
-  maxProperties?: number;
-  minProperties?: number;
-  enum?: any[];
-  example?: any;
+    $ref?: string;
+    type?: string | string[];
+    properties?: {
+        [name: string]: OpenAPISchema;
+    };
+    patternProperties?: {
+        [name: string]: OpenAPISchema;
+    };
+    additionalProperties?: boolean | OpenAPISchema;
+    unevaluatedProperties?: boolean | OpenAPISchema;
+    description?: string;
+    default?: any;
+    items?: OpenAPISchema | OpenAPISchema[] | boolean;
+    required?: string[];
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    deprecated?: boolean;
+    format?: string;
+    externalDocs?: OpenAPIExternalDocumentation;
+    discriminator?: OpenAPIDiscriminator;
+    nullable?: boolean;
+    oneOf?: OpenAPISchema[];
+    anyOf?: OpenAPISchema[];
+    allOf?: OpenAPISchema[];
+    not?: OpenAPISchema;
+    title?: string;
+    multipleOf?: number;
+    maximum?: number;
+    exclusiveMaximum?: boolean | number;
+    minimum?: number;
+    exclusiveMinimum?: boolean | number;
+    maxLength?: number;
+    minLength?: number;
+    pattern?: string;
+    maxItems?: number;
+    minItems?: number;
+    uniqueItems?: boolean;
+    maxProperties?: number;
+    minProperties?: number;
+    enum?: any[];
+    example?: any;
+    if?: OpenAPISchema;
+    else?: OpenAPISchema;
+    then?: OpenAPISchema;
+    examples?: any[];
+    const?: string;
+    contentEncoding?: string;
+    contentMediaType?: string;
+    prefixItems?: OpenAPISchema[];
+    additionalItems?: OpenAPISchema | boolean;
 }
-
 export interface OpenAPIDiscriminator {
-  propertyName: string;
-  mapping?: { [name: string]: string };
+    propertyName: string;
+    mapping?: {
+        [name: string]: string;
+    };
+    'x-explicitMappingOnly'?: boolean;
 }
-
 export interface OpenAPIMediaType {
-  schema?: Referenced<OpenAPISchema>;
-  example?: any;
-  examples?: { [name: string]: Referenced<OpenAPIExample> };
-  encoding?: { [field: string]: OpenAPIEncoding };
+    schema?: Referenced<OpenAPISchema>;
+    example?: any;
+    examples?: {
+        [name: string]: Referenced<OpenAPIExample>;
+    };
+    encoding?: {
+        [field: string]: OpenAPIEncoding;
+    };
 }
-
 export interface OpenAPIEncoding {
-  contentType: string;
-  headers?: { [name: string]: Referenced<OpenAPIHeader> };
-  style: OpenAPIParameterStyle;
-  explode: boolean;
-  allowReserved: boolean;
+    contentType: string;
+    headers?: {
+        [name: string]: Referenced<OpenAPIHeader>;
+    };
+    style: OpenAPIParameterStyle;
+    explode: boolean;
+    allowReserved: boolean;
 }
-
 export type OpenAPIParameterLocation = 'query' | 'header' | 'path' | 'cookie';
-export type OpenAPIParameterStyle =
-  | 'matrix'
-  | 'label'
-  | 'form'
-  | 'simple'
-  | 'spaceDelimited'
-  | 'pipeDelimited'
-  | 'deepObject';
-
+export type OpenAPIParameterStyle = 'matrix' | 'label' | 'form' | 'simple' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject';
 export interface OpenAPIRequestBody {
-  description?: string;
-  required?: boolean;
-  content: { [mime: string]: OpenAPIMediaType };
+    description?: string;
+    required?: boolean;
+    content: {
+        [mime: string]: OpenAPIMediaType;
+    };
+    'x-examples'?: {
+        [mime: string]: {
+            [name: string]: Referenced<OpenAPIExample>;
+        };
+    };
+    'x-example'?: {
+        [mime: string]: any;
+    };
 }
-
 export interface OpenAPIResponses {
-  [code: string]: OpenAPIResponse;
+    [code: string]: Referenced<OpenAPIResponse>;
 }
-
-export interface OpenAPIResponse {
-  description?: string;
-  headers?: { [name: string]: Referenced<OpenAPIHeader> };
-  content?: { [mime: string]: OpenAPIMediaType };
-  links?: { [name: string]: Referenced<OpenAPILink> };
+export interface OpenAPIResponse extends Pick<OpenAPIRequestBody, 'description' | 'x-examples' | 'x-example'> {
+    headers?: {
+        [name: string]: Referenced<OpenAPIHeader>;
+    };
+    links?: {
+        [name: string]: Referenced<OpenAPILink>;
+    };
+    content?: {
+        [mime: string]: OpenAPIMediaType;
+    };
 }
-
 export interface OpenAPILink {
-  $ref?: string;
+    $ref?: string;
 }
-
 export type OpenAPIHeader = Omit<OpenAPIParameter, 'in' | 'name'>;
-
 export interface OpenAPICallback {
-  $ref?: string;
+    [name: string]: OpenAPIPath;
 }
-
 export interface OpenAPIComponents {
-  schemas?: { [name: string]: Referenced<OpenAPISchema> };
-  responses?: { [name: string]: Referenced<OpenAPIResponse> };
-  parameters?: { [name: string]: Referenced<OpenAPIParameter> };
-  examples?: { [name: string]: Referenced<OpenAPIExample> };
-  requestBodies?: { [name: string]: Referenced<OpenAPIRequestBody> };
-  headers?: { [name: string]: Referenced<OpenAPIHeader> };
-  securitySchemes?: { [name: string]: Referenced<OpenAPISecurityScheme> };
-  links?: { [name: string]: Referenced<OpenAPILink> };
-  callbacks?: { [name: string]: Referenced<OpenAPICallback> };
+    schemas?: {
+        [name: string]: Referenced<OpenAPISchema>;
+    };
+    responses?: {
+        [name: string]: Referenced<OpenAPIResponse>;
+    };
+    parameters?: {
+        [name: string]: Referenced<OpenAPIParameter>;
+    };
+    examples?: {
+        [name: string]: Referenced<OpenAPIExample>;
+    };
+    requestBodies?: {
+        [name: string]: Referenced<OpenAPIRequestBody>;
+    };
+    headers?: {
+        [name: string]: Referenced<OpenAPIHeader>;
+    };
+    securitySchemes?: {
+        [name: string]: Referenced<OpenAPISecurityScheme>;
+    };
+    links?: {
+        [name: string]: Referenced<OpenAPILink>;
+    };
+    callbacks?: {
+        [name: string]: Referenced<OpenAPICallback>;
+    };
 }
-
 export interface OpenAPISecurityRequirement {
-  [name: string]: string[];
+    [name: string]: string[];
 }
-
 export interface OpenAPISecurityScheme {
-  type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
-  description?: string;
-  name?: string;
-  in?: 'query' | 'header' | 'cookie';
-  scheme?: string;
-  bearerFormat: string;
-  flows: {
-    implicit?: {
-      refreshUrl?: string;
-      scopes: Dict<string>;
-      authorizationUrl: string;
-    };
-    password?: {
-      refreshUrl?: string;
-      scopes: Dict<string>;
-      tokenUrl: string;
-    };
-    clientCredentials?: {
-      refreshUrl?: string;
-      scopes: Dict<string>;
-      tokenUrl: string;
-    };
-    authorizationCode?: {
-      refreshUrl?: string;
-      scopes: Dict<string>;
-      tokenUrl: string;
+    type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
+    description?: string;
+    name?: string;
+    in?: 'query' | 'header' | 'cookie';
+    scheme?: string;
+    bearerFormat: string;
+    flows: {
+        implicit?: {
+            refreshUrl?: string;
+            scopes: Record<string, string>;
+            authorizationUrl: string;
+        };
+        password?: {
+            refreshUrl?: string;
+            scopes: Record<string, string>;
+            tokenUrl: string;
+        };
+        clientCredentials?: {
+            refreshUrl?: string;
+            scopes: Record<string, string>;
+            tokenUrl: string;
+        };
+        authorizationCode?: {
+            refreshUrl?: string;
+            scopes: Record<string, string>;
+            tokenUrl: string;
+        };
     };
-  };
-  openIdConnectUrl?: string;
+    openIdConnectUrl?: string;
 }
-
 export interface OpenAPITag {
-  name: string;
-  description?: string;
-  externalDocs?: OpenAPIExternalDocumentation;
-  'x-displayName'?: string;
+    name: string;
+    description?: string;
+    externalDocs?: OpenAPIExternalDocumentation;
+    'x-displayName'?: string;
 }
-
 export interface OpenAPIExternalDocumentation {
-  description?: string;
-  url: string;
+    description?: string;
+    url: string;
 }
-
 export interface OpenAPIContact {
-  name?: string;
-  url?: string;
-  email?: string;
+    name?: string;
+    url?: string;
+    email?: string;
 }
-
 export interface OpenAPILicense {
-  name: string;
-  url?: string;
+    name: string;
+    url?: string;
+    identifier?: string;
 }