@redocly/reference-docs 2.25.1 → 2.26.1

package/lib-esm/redoc-lib/src/services/types.d.ts

@@ -0,0 +1,210 @@
+import type React from 'react';
+import type { OpenAPIOperation, OpenAPIParameter, OpenAPIServer, OpenAPITag, Referenced, OpenAPISchema, Server } from '../types';
+import type { ProStore } from '../../../services';
+import type { OAuth2 } from '../../../services/OAuth2';
+import type { ThemeInterface } from '../theme';
+import type { GroupModel, OperationModel, Sample } from './models';
+export declare type MenuItemGroupType = 'group' | 'tag' | 'section' | 'schema';
+export declare type MenuItemType = MenuItemGroupType | 'operation';
+/** Generic interface for MenuItems */
+export interface IMenuItem {
+    id: string;
+    absoluteIdx?: number;
+    name: string;
+    description?: string;
+    href?: string;
+    depth: number;
+    active: boolean;
+    expanded: boolean;
+    items: IMenuItem[];
+    parent?: IMenuItem;
+    deprecated?: boolean;
+    type: MenuItemType;
+    isSchema?: boolean;
+    deactivate(): void;
+    activate(): void;
+    collapse(): void;
+    expand(): void;
+}
+export declare type TagInfo = OpenAPITag & {
+    operations: ExtendedOpenAPIOperation[];
+    used?: boolean;
+    schemaRendersInTag?: boolean;
+    isSchema?: boolean;
+};
+export declare type ExtendedOpenAPIOperation = {
+    pointer: string;
+    pathName: string;
+    httpVerb: string;
+    pathParameters: Array<Referenced<OpenAPIParameter>>;
+    pathServers: Array<OpenAPIServer> | undefined;
+    isWebhook: boolean;
+    defaultSampleName?: string | false;
+    defaultMimeType?: string;
+} & OpenAPIOperation;
+export declare type TagsInfoMap = Record<string, TagInfo>;
+export interface TagGroup {
+    name: string;
+    tags: string[];
+}
+export declare type ContentItemModel = GroupModel | OperationModel;
+export declare type MergedOpenAPISchema = OpenAPISchema & {
+    parentRefs?: string[];
+};
+export interface MDXComponentMeta {
+    component: React.ComponentType;
+    propsSelector: (store?: ProStore) => GenericObject;
+    props?: GenericObject;
+}
+export interface MarkdownHeading {
+    id: string;
+    name: string;
+    level: number;
+    items?: MarkdownHeading[];
+    description?: string;
+}
+export interface LabelsConfig {
+    enum: string;
+    enumSingleValue: string;
+    enumArray: string;
+    default: string;
+    deprecated: string;
+    example: string;
+    examples: string;
+    recursive: string;
+    arrayOf: string;
+    webhook: string;
+    const: string;
+    authorizations: string;
+    tryItBody: string;
+    tryItParameters: string;
+    tryItAuth: string;
+    tryItAuthBasicUsername: string;
+    tryItAuthBasicPassword: string;
+    download: string;
+    downloadSpecification: string;
+    request: string;
+    responses: string;
+    callbackResponses: string;
+    callbacks: string;
+    requestSamples: string;
+    responseSamples: string;
+}
+export declare type LabelsConfigRaw = Partial<LabelsConfig>;
+export declare type Unstable_ExternalCodeSample = Sample & {
+    get: (source: ExternalSource) => string;
+};
+export interface ExternalSource {
+    sample: Unstable_ExternalCodeSample;
+    operation: OperationModel;
+    exampleName?: string;
+    pathParams?: any;
+    properties?: any;
+}
+export interface SecurityPanelHookProps {
+    operation: OperationModel;
+    server: Server;
+    onChange: (securityDetails: unknown) => void;
+    OAuth2: OAuth2;
+}
+export declare type AuthPanelHookProps = SecurityPanelHookProps;
+export interface HookRawHtml {
+    html: string;
+}
+declare type HookResult = JSX.Element | HookRawHtml | null;
+export declare type HookConfig<T> = (props: T) => HookResult;
+export interface HooksConfig {
+    BeforeOperation?: HookConfig<{
+        operation: OperationModel;
+    }>;
+    BeforeOperationSummary?: HookConfig<{
+        operation: OperationModel;
+    }>;
+    AfterOperationSummary?: HookConfig<{
+        operation: OperationModel;
+    }>;
+    AfterOperation?: HookConfig<{
+        operation: OperationModel;
+    }>;
+    ReplaceTryItSecurityPanel?: HookConfig<SecurityPanelHookProps>;
+    onInit?: (args: {
+        store: ProStore;
+    }) => void;
+    replaceSecurityLink?: (args: {
+        securityRequirementId: string;
+    }) => string;
+    sanitize?: (raw: string) => string;
+    /** @deprecated Use ReplaceTryItSecurityPanel instead */
+    ReplaceTryItAuthPanel?: HookConfig<SecurityPanelHookProps>;
+}
+export interface RedocRawOptions {
+    theme?: ThemeInterface;
+    scrollYOffset?: number | string | (() => number);
+    hideHostname?: boolean | string;
+    hideInfoDescription?: boolean | string;
+    expandResponses?: string | 'all';
+    requiredPropsFirst?: boolean | string;
+    sortPropsAlphabetically?: boolean | string;
+    sortEnumValuesAlphabetically?: boolean | string;
+    sortOperationsAlphabetically?: boolean | string;
+    sortTagsAlphabetically?: boolean | string;
+    nativeScrollbars?: boolean | string;
+    pathInMiddlePanel?: boolean | string;
+    untrustedDefinition?: boolean | string;
+    hideLoading?: boolean | string;
+    hideDownloadButton?: boolean | string;
+    downloadDefinitionUrl?: string;
+    disableSearch?: boolean | string;
+    showChangeLayoutButton?: boolean | string;
+    onlyRequiredInSamples?: boolean | string;
+    generatedPayloadSamplesMaxDepth?: number | string;
+    sendXUserAgentInTryIt?: boolean | string;
+    showExtensions?: boolean | string | string[];
+    hideSingleRequestSampleTab?: boolean | string;
+    hideRequestPayloadSample?: boolean;
+    menuToggle?: boolean | string;
+    jsonSampleExpandLevel?: number | string | 'all';
+    hideSchemaTitles?: boolean | string;
+    hideSecuritySection?: boolean;
+    showSecuritySchemeType?: boolean;
+    simpleOneOfTypeLabel?: boolean | string;
+    payloadSampleIdx?: number;
+    expandSingleSchemaField?: boolean | string;
+    schemaExpansionLevel?: number | string | 'all';
+    samplesTabsMaxCount?: number;
+    unstable_tryItButtonOverride?: {
+        label: string;
+        link: string;
+    };
+    allowedMdComponents?: Record<string, MDXComponentMeta>;
+    labels?: LabelsConfigRaw;
+    enumSkipQuotes?: boolean | string;
+    expandDefaultServerVariables?: boolean;
+    expandDefaultRequest?: boolean;
+    expandDefaultResponse?: boolean;
+    maxDisplayedEnumValues?: number;
+    ignoreNamedSchemas?: string[] | string;
+    unstable_externalCodeSamples?: Unstable_ExternalCodeSample[];
+    unstable_ignoreMimeParameters?: boolean;
+    hooks?: HooksConfig;
+    hideSchemaPattern?: boolean;
+    hideOneOfDescription?: boolean;
+    hideFab?: boolean;
+    markdownHeadingsAnchorLevel?: number;
+    schemaDefinitionsTagName?: string;
+    minCharacterLengthToInitSearch?: number;
+    maxResponseHeadersToShowInTryIt?: number;
+    showWebhookVerb?: boolean;
+    showObjectSchemaExamples?: boolean;
+    disableTryItRequestUrlEncoding?: boolean;
+}
+export interface SearchDocument {
+    title: string;
+    description: string;
+    id: string;
+}
+export interface SearchResult<T = string> {
+    meta: T;
+    score: number;
+}
+export {};

package/lib-esm/redoc-lib/src/services/types.js

@@ -0,0 +1,2 @@
+export{};
+//# sourceMappingURL=types.js.map

package/lib-esm/redoc-lib/src/utils/argValuesHelpers.d.ts

@@ -1,4 +1,4 @@
 export declare function argValueToBoolean(val?: string | boolean, defaultValue?: boolean): boolean;
-export declare function argValueToNumber(value: number | string | undefined): number | undefined;
+export declare function argValueToNumber(value: number | string | undefined, defaultValue?: number): number;
 export declare function argValueToInt(value: number | string | undefined): number | undefined;
 export declare function argValueToExpandLevel(value?: number | string | undefined, defaultValue?: number): number;

package/lib-esm/redoc-lib/src/utils/argValuesHelpers.js

@@ -1,2 +1,2 @@
-export function argValueToBoolean(e,r){return void 0===e?r||!1:"string"==typeof e?"false"!==e:e}export function argValueToNumber(e){return"string"==typeof e?parseInt(e,10):"number"==typeof e?e:void 0}export function argValueToInt(e){return"string"==typeof e?parseInt(e,10):"number"==typeof e?Math.ceil(e):void 0}export function argValueToExpandLevel(e,r){return void 0===r&&(r=0),"all"===e?1/0:argValueToInt(e)||r}
+export function argValueToBoolean(e,r){return void 0===e?r||!1:"string"==typeof e?"false"!==e:e}export function argValueToNumber(e,r){return void 0===r&&(r=0),"string"==typeof e?parseInt(e,10):"number"==typeof e?e:r}export function argValueToInt(e){return"string"==typeof e?parseInt(e,10):"number"==typeof e?Math.ceil(e):void 0}export function argValueToExpandLevel(e,r){return void 0===r&&(r=0),"all"===e?1/0:argValueToInt(e)||r}
 //# sourceMappingURL=argValuesHelpers.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/reference-docs",
-  "version": "2.25.1",
+  "version": "2.26.1",
   "description": "Redocly Reference Docs",
   "main": "lib/index.js",
   "module": "lib-esm/index.js",
@@ -73,7 +73,8 @@
     "start": "webpack serve --mode=development --hot",
     "stats": "webpack --json --profile --mode=production -p > stats.json && npx webpack-bundle-analyzer stats.json",
     "prettier": "prettier --write \"src/cli/cli.ts\" \"src/**/*.{ts,tsx}\" \"playground/**/*.{ts,tsx}\"",
-    "lint": "eslint --fix . --ext .ts,.tsx --cache",
+    "lint": "eslint . --ext .ts,.tsx --cache",
+    "lint:fix": "npm run lint -- --fix",
     "prepublish-test": "scripts/prepublish-test.sh",
     "test": "npm run test:unit && npm run test:e2e",
     "test:unit": "jest",
@@ -86,8 +87,7 @@
     "ts-check": "tsc --noEmit --skipLibCheck",
     "precdn-serve": "mkdir -p playground/cdn-test/server-dist && cp -Rf dist/* playground/cdn-test/server-dist && cp -Rf playground/cdn-test/template-source/* playground/cdn-test/server-dist",
     "cdn-serve": "http-server playground/cdn-test/server-dist",
-    "prepare": "husky install",
-    "pre-commit": "pretty-quick --staged && npm run lint"
+    "prepare": "husky install"
   },
   "peerDependencies": {
     "core-js": "^3.1.4",
@@ -142,7 +142,6 @@
     "json-schema": "^0.4.0",
     "mobx": "^6.3.2",
     "prettier": "2.6.2",
-    "pretty-quick": "^3.0.0",
     "react": "^17.0.0",
     "react-dom": "^17.0.0",
     "react-hot-loader": "^4.12.18",
@@ -204,5 +203,13 @@
     "moduleNameMapper": {
       "\\.(css|less)$": "<rootDir>/src/empty.js"
     }
+  },
+  "lint-staged": {
+    "*.{ts,tsx}": [
+      "npm run lint:fix"
+    ],
+    "**/*": [
+      "prettier --write --ignore-unknown"
+    ]
   }
 }

package/lib/redoc-lib/src/components/Markdown/SanitizedMdBlock.js

@@ -1,2 +0,0 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.SanitizedMarkdownHTML=void 0;var tslib_1=require("tslib"),dompurify_1=(0,tslib_1.__importDefault)(require("dompurify")),React=(0,tslib_1.__importStar)(require("react")),OptionsProvider_1=require("../OptionsProvider"),styled_elements_1=require("./styled.elements");function SanitizedMarkdownHTML(e){var t,i,r,o=React.useContext(OptionsProvider_1.OptionsContext),n=e.inline?styled_elements_1.StyledMarkdownSpan:styled_elements_1.StyledMarkdownBlock,l=(null===(t=o.hooks)||void 0===t?void 0:t.sanitize)?null===(r=null===(i=o.hooks)||void 0===i?void 0:i.sanitize)||void 0===r?void 0:r.call(i,e.html):o.untrustedDefinition?dompurify_1.default.sanitize(e.html):e.html;return React.createElement(n,(0,tslib_1.__assign)({className:"redoc-markdown "+(e.className||""),dangerouslySetInnerHTML:{__html:l},"data-role":e["data-role"]},e))}exports.SanitizedMarkdownHTML=SanitizedMarkdownHTML;
-//# sourceMappingURL=SanitizedMdBlock.js.map

package/lib/redoc-lib/src/services/MenuStore.d.ts

@@ -1,22 +0,0 @@
-export declare type MenuItemGroupType = 'group' | 'tag' | 'section' | 'schema';
-export declare type MenuItemType = MenuItemGroupType | 'operation';
-/** Generic interface for MenuItems */
-export interface IMenuItem {
-    id: string;
-    absoluteIdx?: number;
-    name: string;
-    description?: string;
-    href?: string;
-    depth: number;
-    active: boolean;
-    expanded: boolean;
-    items: IMenuItem[];
-    parent?: IMenuItem;
-    deprecated?: boolean;
-    type: MenuItemType;
-    isSchema?: boolean;
-    deactivate(): void;
-    activate(): void;
-    collapse(): void;
-    expand(): void;
-}

package/lib-esm/redoc-lib/src/components/Markdown/SanitizedMdBlock.js

@@ -1,2 +0,0 @@
-import{__assign}from"tslib";import DOMPurify from"dompurify";import*as React from"react";import{OptionsContext}from"../OptionsProvider";import{StyledMarkdownBlock,StyledMarkdownSpan}from"./styled.elements";export function SanitizedMarkdownHTML(t){var o,e,n,i=React.useContext(OptionsContext),r=t.inline?StyledMarkdownSpan:StyledMarkdownBlock,a=(null===(o=i.hooks)||void 0===o?void 0:o.sanitize)?null===(n=null===(e=i.hooks)||void 0===e?void 0:e.sanitize)||void 0===n?void 0:n.call(e,t.html):i.untrustedDefinition?DOMPurify.sanitize(t.html):t.html;return React.createElement(r,__assign({className:"redoc-markdown "+(t.className||""),dangerouslySetInnerHTML:{__html:a},"data-role":t["data-role"]},t))}
-//# sourceMappingURL=SanitizedMdBlock.js.map

package/lib-esm/redoc-lib/src/services/MenuStore.d.ts

@@ -1,22 +0,0 @@
-export declare type MenuItemGroupType = 'group' | 'tag' | 'section' | 'schema';
-export declare type MenuItemType = MenuItemGroupType | 'operation';
-/** Generic interface for MenuItems */
-export interface IMenuItem {
-    id: string;
-    absoluteIdx?: number;
-    name: string;
-    description?: string;
-    href?: string;
-    depth: number;
-    active: boolean;
-    expanded: boolean;
-    items: IMenuItem[];
-    parent?: IMenuItem;
-    deprecated?: boolean;
-    type: MenuItemType;
-    isSchema?: boolean;
-    deactivate(): void;
-    activate(): void;
-    collapse(): void;
-    expand(): void;
-}

package/lib-esm/redoc-lib/src/services/MenuStore.js

@@ -1,2 +0,0 @@
-export{};
-//# sourceMappingURL=MenuStore.js.map