@redocly/openapi-docs 3.16.0 → 3.17.0-next.0

package/lib/constants.d.ts

@@ -10,11 +10,7 @@ export declare enum MediaTypes {
     XML = "application/xml"
 }
 export declare const SECTION_ATTR = "data-section-id";
-export declare const FIELD_ATTR = "data-field-id";
 export declare const GROUP_DEPTH = 0;
-export declare const LEGACY_REGEXP = "^ {0,3}<!-- ReDoc-Inject:\\s+?<({component}).*?/?>\\s+?-->\\s*$";
-export declare const MDX_COMPONENT_REGEXP: string;
-export declare const COMPONENT_REGEXP: string;
 export declare const DEFAULT_TAG_SLUG = "other";
 export declare const DEFAULT_WEBHOOKS_TAG_NAME = "webhooks";
 export declare const LOADING_STATE: {
@@ -22,7 +18,6 @@ export declare const LOADING_STATE: {
     LOADING: string;
     LOADED: string;
 };
-export declare const REDOCLY_CONFIG_FILE = "redocly.yaml";
 export declare const DISABLE_DEEP_LINK_IF_FIELDS_EXIST: string[];
 export declare const SEARCH_LIMIT = 100;
 export declare const HIGHLIGHTED_TEXT_MAX_LENGTH = 150;

package/lib/constants.js

@@ -1 +1 @@
-var o;(function(t){t.ON_DEEP_LINK_CLICK="onDeepLinkClick",t.HOOKS="hooks"})(o||(o={}));var E;(function(t){t.OCTET_STREAM="application/octet-stream",t.MULTIPART="multipart/form-data",t.URL_ENCODED="application/x-www-form-urlencoded",t.JSON="application/json",t.XML="application/xml"})(E||(E={}));const p="data-section-id",r="data-field-id",_=0,e="^ {0,3}<!-- ReDoc-Inject:\\s+?<({component}).*?/?>\\s+?-->\\s*$",n="(?:^ {0,3}<({component})([\\s\\S]*?)>([\\s\\S]*?)</\\2>|^ {0,3}<({component})([\\s\\S]*?)(?:/>|\\n{2,}))",c="(?:"+e+"|"+n+")",a="other",D="webhooks",s={NOT_LOADED:"NOT_LOADED",LOADING:"LOADING",LOADED:"LOADED"},L="redocly.yaml",O=["title"],T=100,A=150,I=["text","title","path","httpPath","parameters[]:name","parameters[]:description","parameters[]:place","parameters[]:path"];export{c as COMPONENT_REGEXP,a as DEFAULT_TAG_SLUG,D as DEFAULT_WEBHOOKS_TAG_NAME,O as DISABLE_DEEP_LINK_IF_FIELDS_EXIST,r as FIELD_ATTR,_ as GROUP_DEPTH,A as HIGHLIGHTED_TEXT_MAX_LENGTH,e as LEGACY_REGEXP,s as LOADING_STATE,n as MDX_COMPONENT_REGEXP,E as MediaTypes,L as REDOCLY_CONFIG_FILE,I as SEARCH_INDEX_FIELDS,T as SEARCH_LIMIT,p as SECTION_ATTR,o as WindowReferenceOptions};
+var o;(function(t){t.ON_DEEP_LINK_CLICK="onDeepLinkClick",t.HOOKS="hooks"})(o||(o={}));var E;(function(t){t.OCTET_STREAM="application/octet-stream",t.MULTIPART="multipart/form-data",t.URL_ENCODED="application/x-www-form-urlencoded",t.JSON="application/json",t.XML="application/xml"})(E||(E={}));const e="data-section-id",r=0,p="other",a="webhooks",_={NOT_LOADED:"NOT_LOADED",LOADING:"LOADING",LOADED:"LOADED"},n=["title"],D=100,L=150,c=["text","title","path","httpPath","parameters[]:name","parameters[]:description","parameters[]:place","parameters[]:path"];export{p as DEFAULT_TAG_SLUG,a as DEFAULT_WEBHOOKS_TAG_NAME,n as DISABLE_DEEP_LINK_IF_FIELDS_EXIST,r as GROUP_DEPTH,L as HIGHLIGHTED_TEXT_MAX_LENGTH,_ as LOADING_STATE,E as MediaTypes,c as SEARCH_INDEX_FIELDS,D as SEARCH_LIMIT,e as SECTION_ATTR,o as WindowReferenceOptions};

package/lib/hooks/useRouter.d.ts

@@ -3,6 +3,10 @@ import type { RouterType } from '../types/index.js';
 interface RouterProps {
     basename?: string;
     location?: string;
+    future?: {
+        v7_startTransition: boolean;
+        v7_relativeSplatPath: boolean;
+    };
 }
 export declare const useRouter: (router: RouterType, basePath: string) => {
     Router: ComponentType<{

package/lib/services/code-samples/httpsnippet/targets/__mocks__/mock.d.ts

@@ -1,3 +1,4 @@
+import type { SnippetRequest } from '../../index.js';
 export declare const originalOptions: {
     withImports: boolean;
     withComments: boolean;
@@ -1501,556 +1502,7 @@ export declare const originalOptions: {
         };
     };
 };
-export declare const source: {
-    "POST http://petstore.swagger.io/v2/pet": {
-        method: string;
-        url: string;
-        httpVersion: string;
-        cookies: {
-            name: string;
-            value: string;
-        }[];
-        headers: {
-            name: string;
-            value: string;
-        }[];
-        queryString: never[];
-        postData: {
-            mimeType: string;
-            text: string;
-            params: never[];
-            jsonObj: {
-                category: {
-                    name: string;
-                    sub: {
-                        prop1: string;
-                    };
-                };
-                name: string;
-                photoUrls: string[];
-                friend: {};
-                tags: {
-                    name: string;
-                }[];
-                status: string;
-                petType: string;
-                huntingSkill: string;
-            };
-        };
-        headersSize: number;
-        bodySize: number;
-        securityOAuth2ExtraCalls: {
-            method: string;
-            url: string;
-            httpVersion: string;
-            headers: {
-                name: string;
-                value: string;
-            }[];
-            queryString: never[];
-            postData: {
-                mimeType: string;
-                text: string;
-                params: {
-                    name: string;
-                    value: string;
-                }[];
-            };
-            cookies: never[];
-            headersSize: number;
-            bodySize: number;
-            securityOAuth2ExtraCalls: never[];
-        }[];
-        pathParameters: {};
-        serverVariables: {};
-        queryObj: {};
-        headersObj: {
-            'Content-Type': string;
-            'Accept-Language': string;
-            Authorization: string;
-        };
-        cookiesObj: {
-            cookieParam: string;
-        };
-        allHeaders: {
-            cookie: string;
-            'Content-Type': string;
-            'Accept-Language': string;
-            Authorization: string;
-        };
-        uriObj: {
-            protocol: string;
-            slashes: boolean;
-            auth: null;
-            host: string;
-            port: null;
-            hostname: string;
-            hash: null;
-            search: string;
-            query: {};
-            pathname: string;
-            path: string;
-            href: string;
-        };
-        fullUrl: string;
-    };
-    "POST http://petstore.swagger.io/v2/pet/{petId}/uploadImage/{data}": {
-        method: string;
-        url: string;
-        httpVersion: string;
-        cookies: never[];
-        headers: {
-            name: string;
-            value: string;
-        }[];
-        queryString: never[];
-        headersSize: number;
-        bodySize: number;
-        securityOAuth2ExtraCalls: {
-            method: string;
-            url: string;
-            httpVersion: string;
-            headers: {
-                name: string;
-                value: string;
-            }[];
-            queryString: never[];
-            postData: {
-                mimeType: string;
-                text: string;
-                params: {
-                    name: string;
-                    value: string;
-                }[];
-            };
-            cookies: never[];
-            headersSize: number;
-            bodySize: number;
-            securityOAuth2ExtraCalls: never[];
-        }[];
-        pathParameters: {
-            petId: string;
-            data: string;
-        };
-        serverVariables: {};
-        queryObj: {};
-        headersObj: {
-            'Content-Type': string;
-            Authorization: string;
-        };
-        cookiesObj: {};
-        allHeaders: {
-            'Content-Type': string;
-            Authorization: string;
-        };
-        uriObj: {
-            protocol: string;
-            slashes: boolean;
-            auth: null;
-            host: string;
-            port: null;
-            hostname: string;
-            hash: null;
-            search: string;
-            query: {};
-            pathname: string;
-            path: string;
-            href: string;
-        };
-        fullUrl: string;
-    };
-    "PUT http://petstore.swagger.io/v2/pet": {
-        method: string;
-        url: string;
-        httpVersion: string;
-        cookies: {
-            name: string;
-            value: string;
-        }[];
-        headers: {
-            name: string;
-            value: string;
-        }[];
-        queryString: never[];
-        postData: {
-            mimeType: string;
-            text: string;
-            params: never[];
-            jsonObj: {
-                category: {
-                    name: string;
-                    sub: {
-                        prop1: string;
-                    };
-                };
-                name: string;
-                photoUrls: string[];
-                friend: {};
-                tags: {
-                    name: string;
-                }[];
-                status: string;
-                petType: string;
-                huntingSkill: string;
-            };
-        };
-        headersSize: number;
-        bodySize: number;
-        securityOAuth2ExtraCalls: {
-            method: string;
-            url: string;
-            httpVersion: string;
-            headers: {
-                name: string;
-                value: string;
-            }[];
-            queryString: never[];
-            postData: {
-                mimeType: string;
-                text: string;
-                params: {
-                    name: string;
-                    value: string;
-                }[];
-            };
-            cookies: never[];
-            headersSize: number;
-            bodySize: number;
-            securityOAuth2ExtraCalls: never[];
-        }[];
-        pathParameters: {};
-        serverVariables: {};
-        queryObj: {};
-        headersObj: {
-            'Content-Type': string;
-            'Accept-Language': string;
-            Authorization: string;
-        };
-        cookiesObj: {
-            cookieParam: string;
-        };
-        allHeaders: {
-            cookie: string;
-            'Content-Type': string;
-            'Accept-Language': string;
-            Authorization: string;
-        };
-        uriObj: {
-            protocol: string;
-            slashes: boolean;
-            auth: null;
-            host: string;
-            port: null;
-            hostname: string;
-            hash: null;
-            search: string;
-            query: {};
-            pathname: string;
-            path: string;
-            href: string;
-        };
-        fullUrl: string;
-    };
-    "POST http://petstore.swagger.io/v2/pet/{petId}/uploadImage": {
-        method: string;
-        url: string;
-        httpVersion: string;
-        cookies: never[];
-        headers: {
-            name: string;
-            value: string;
-        }[];
-        queryString: never[];
-        headersSize: number;
-        bodySize: number;
-        securityOAuth2ExtraCalls: {
-            method: string;
-            url: string;
-            httpVersion: string;
-            headers: {
-                name: string;
-                value: string;
-            }[];
-            queryString: never[];
-            postData: {
-                mimeType: string;
-                text: string;
-                params: {
-                    name: string;
-                    value: string;
-                }[];
-            };
-            cookies: never[];
-            headersSize: number;
-            bodySize: number;
-            securityOAuth2ExtraCalls: never[];
-        }[];
-        pathParameters: {
-            petId: string;
-        };
-        serverVariables: {};
-        queryObj: {};
-        headersObj: {
-            'Content-Type': string;
-            Authorization: string;
-        };
-        cookiesObj: {};
-        allHeaders: {
-            'Content-Type': string;
-            Authorization: string;
-        };
-        uriObj: {
-            protocol: string;
-            slashes: boolean;
-            auth: null;
-            host: string;
-            port: null;
-            hostname: string;
-            hash: null;
-            search: string;
-            query: {};
-            pathname: string;
-            path: string;
-            href: string;
-        };
-        fullUrl: string;
-    };
-    "GET http://petstore.swagger.io/v2/pet/findByStatus/{id}": {
-        method: string;
-        url: string;
-        httpVersion: string;
-        cookies: never[];
-        headers: {
-            name: string;
-            value: string;
-        }[];
-        queryString: {
-            name: string;
-            value: string;
-        }[];
-        headersSize: number;
-        bodySize: number;
-        securityOAuth2ExtraCalls: {
-            method: string;
-            url: string;
-            httpVersion: string;
-            headers: {
-                name: string;
-                value: string;
-            }[];
-            queryString: never[];
-            postData: {
-                mimeType: string;
-                text: string;
-                params: {
-                    name: string;
-                    value: string;
-                }[];
-            };
-            cookies: never[];
-            headersSize: number;
-            bodySize: number;
-            securityOAuth2ExtraCalls: never[];
-        }[];
-        pathParameters: {
-            id: string;
-        };
-        serverVariables: {};
-        queryObj: {
-            status: string;
-        };
-        headersObj: {
-            Authorization: string;
-        };
-        cookiesObj: {};
-        allHeaders: {
-            Authorization: string;
-        };
-        uriObj: {
-            protocol: string;
-            slashes: boolean;
-            auth: null;
-            host: string;
-            port: null;
-            hostname: string;
-            hash: null;
-            search: string;
-            query: {
-                status: string;
-            };
-            pathname: string;
-            path: string;
-            href: string;
-        };
-        fullUrl: string;
-    };
-    "POST https://{customerId}.saas-app.com:{port}/v2": {
-        method: string;
-        url: string;
-        httpVersion: string;
-        cookies: {
-            name: string;
-            value: string;
-        }[];
-        headers: {
-            name: string;
-            value: string;
-        }[];
-        queryString: never[];
-        postData: {
-            mimeType: string;
-            text: string;
-            params: never[];
-            jsonObj: {
-                category: {
-                    name: string;
-                    sub: {
-                        prop1: string;
-                    };
-                };
-                name: string;
-                photoUrls: string[];
-                friend: {};
-                tags: {
-                    name: string;
-                }[];
-                cvv_check: string;
-                status: string;
-                petType: string;
-                huntingSkill: string;
-            };
-        };
-        headersSize: number;
-        bodySize: number;
-        securityOAuth2ExtraCalls: never[];
-        pathParameters: {};
-        serverVariables: {
-            customerId: string;
-            port: string;
-        };
-        queryObj: {};
-        headersObj: {
-            'Content-Type': string;
-            'Accept-Language': string;
-            Authorization: string;
-        };
-        cookiesObj: {
-            cookieParam: string;
-        };
-        allHeaders: {
-            cookie: string;
-            'Content-Type': string;
-            'Accept-Language': string;
-            Authorization: string;
-        };
-        uriObj: {
-            protocol: string;
-            slashes: boolean;
-            auth: null;
-            host: string;
-            port: null;
-            hostname: string;
-            hash: null;
-            search: string;
-            query: {};
-            pathname: string;
-            path: string;
-            href: string;
-        };
-        fullUrl: string;
-    };
-    "POST http://petstore.swagger.io/login": {
-        method: string;
-        url: string;
-        httpVersion: string;
-        headers: never[];
-        queryString: never[];
-        postData: {
-            mimeType: string;
-            text: string;
-            params: never[];
-            jsonObj: {};
-        };
-        basicAuth: {
-            username: string;
-            password: string;
-        };
-        headersSize: number;
-        bodySize: number;
-        securityOAuth2ExtraCalls: never[];
-        pathParameters: {};
-        queryObj: {};
-        headersObj: {};
-        cookiesObj: {};
-        allHeaders: {};
-        serverVariables: {};
-        cookies: {
-            name: string;
-            value: string;
-        }[];
-        uriObj: {
-            protocol: string;
-            slashes: boolean;
-            auth: null;
-            host: string;
-            port: null;
-            hostname: string;
-            hash: null;
-            search: string;
-            query: {};
-            pathname: string;
-            path: string;
-            href: string;
-        };
-        fullUrl: string;
-    };
-    "POST http://petstore.swagger.io/v2/uploadImage": {
-        httpVersion: string;
-        queryString: never[];
-        basicAuth: {
-            username: string;
-            password: string;
-        };
-        headersSize: number;
-        bodySize: number;
-        securityOAuth2ExtraCalls: never[];
-        pathParameters: {};
-        queryObj: {};
-        headersObj: {};
-        cookiesObj: {};
-        allHeaders: {};
-        serverVariables: {};
-        cookies: {
-            name: string;
-            value: string;
-        }[];
-        uriObj: {
-            protocol: string;
-            slashes: boolean;
-            auth: null;
-            host: string;
-            port: null;
-            hostname: string;
-            hash: null;
-            search: string;
-            query: {};
-            pathname: string;
-            path: string;
-            href: string;
-        };
-        fullUrl: string;
-        method: string;
-        url: string;
-        headers: never[];
-        postData: {
-            mimeType: string;
-            params: {
-                name: string;
-                value: string;
-            }[];
-        };
-    };
-};
+export declare const source: Record<string, SnippetRequest>;
 export declare const serverVariablesOptions: {
     withImports: boolean;
     withComments: boolean;

package/lib/services/history/helpers.d.ts

@@ -1,5 +1,4 @@
 import type { FieldModel } from '../../models/index.js';
-export declare function isSameHash(a: string, b: string): boolean;
 export declare function constructFieldDeepFragment(field: FieldModel, activeMimeName?: string): string;
 export declare function joinWithSeparator(base?: string, path?: string, sep?: string): string;
 export declare function makeDeepLink(operationId: string, suffix: string): string;

package/lib/services/history/helpers.js

@@ -1 +1 @@
-import{encodeBackSlashes as o,queryString as s}from"../../utils/index.js";import{getActiveMediaType as r}from"../../models/mediaContent.js";function d(e,n){return e===n||"#"+e===n||e==="#"+n}function p(e,n){if(!e.in){if(e.deps.type==="request"&&e.deps.operation?.requestBody?.content?.mediaTypes)return e.deps.operation?.requestBody?.content?.mediaTypes.length>1?e.deps.operation?.requestBody?.content&&r(e.deps.operation.requestBody.content,n).name:void 0;if(e.deps.type==="response"&&e.deps.response?.content?.mediaTypes)return e.deps.response?.content?.mediaTypes.length>1?e.deps.response?.content&&r(e.deps.response.content,n).name:void 0}}function y(e,n){if(!e)return"";const t={t:e.deps.type,in:e.in||e.deps.in,c:e.deps.type==="response"?e.deps.response?.code:void 0,cb:e.deps.operation?.isCallback?e.deps.operation.callbackId:void 0,ct:p(e,n),path:e.fieldFullPath};return s.stringify(t,{encode:!1,sort:!1})}function c(e="",n="",t="/"){return e.endsWith(t)&&e!==t&&(e=e.slice(0,-t.length)),n.startsWith(t)&&(n=n.slice(t.length)),!e||!n||e===t?e+n:e+t+n}function a(e,n){return e=o(e),(`/${e}#`+c(e,n)).toLowerCase()}export{y as constructFieldDeepFragment,d as isSameHash,c as joinWithSeparator,a as makeDeepLink};
+import{encodeBackSlashes as o,queryString as s}from"../../utils/index.js";import{getActiveMediaType as r}from"../../models/mediaContent.js";function p(e,n){if(!e.in){if(e.deps.type==="request"&&e.deps.operation?.requestBody?.content?.mediaTypes)return e.deps.operation?.requestBody?.content?.mediaTypes.length>1?e.deps.operation?.requestBody?.content&&r(e.deps.operation.requestBody.content,n).name:void 0;if(e.deps.type==="response"&&e.deps.response?.content?.mediaTypes)return e.deps.response?.content?.mediaTypes.length>1?e.deps.response?.content&&r(e.deps.response.content,n).name:void 0}}function d(e,n){if(!e)return"";const t={t:e.deps.type,in:e.in||e.deps.in,c:e.deps.type==="response"?e.deps.response?.code:void 0,cb:e.deps.operation?.isCallback?e.deps.operation.callbackId:void 0,ct:p(e,n),path:e.fieldFullPath};return s.stringify(t,{encode:!1,sort:!1})}function c(e="",n="",t="/"){return e.endsWith(t)&&e!==t&&(e=e.slice(0,-t.length)),n.startsWith(t)&&(n=n.slice(t.length)),!e||!n||e===t?e+n:e+t+n}function y(e,n){return e=o(e),(`/${e}#`+c(e,n)).toLowerCase()}export{d as constructFieldDeepFragment,c as joinWithSeparator,y as makeDeepLink};

package/lib/types/app.d.ts

@@ -1,6 +1 @@
 export type RouterType = 'history' | 'memory' | 'hash';
-export type MenuLink = {
-    id: string;
-    href: string;
-    name: string;
-};

package/lib/utils/index.d.ts

@@ -12,7 +12,6 @@ export * from './session-storage.js';
 export * from './local-storage.js';
 export * from './parameters.js';
 export * from './string.js';
-export * from './test-utils.js';
 export * from './compose.js';
 export * from './saveTextBeforeHeading.js';
 export * from './path.js';

package/lib/utils/index.js

@@ -1 +1 @@
-export*from"./JsonPointer.js";export*from"./openapi.js";export*from"./helpers.js";export*from"./dom.js";export*from"./debug.js";export*from"./sort.js";export*from"./argValuesHelpers.js";export*from"./theme-helpers.js";export*from"./debounce.js";export*from"./security-details.js";export*from"./session-storage.js";export*from"./local-storage.js";export*from"./parameters.js";export*from"./string.js";export*from"./test-utils.js";export*from"./compose.js";export*from"./saveTextBeforeHeading.js";export*from"./path.js";export*from"./queryString.js";export*from"./isMobile.js";export*from"./replaceVariables.js";export*from"./areArraysEqual.js";export*from"./hasNestedFields.js";export*from"./configure-helpers.js";export*from"./telemetry.js";
+export*from"./JsonPointer.js";export*from"./openapi.js";export*from"./helpers.js";export*from"./dom.js";export*from"./debug.js";export*from"./sort.js";export*from"./argValuesHelpers.js";export*from"./theme-helpers.js";export*from"./debounce.js";export*from"./security-details.js";export*from"./session-storage.js";export*from"./local-storage.js";export*from"./parameters.js";export*from"./string.js";export*from"./compose.js";export*from"./saveTextBeforeHeading.js";export*from"./path.js";export*from"./queryString.js";export*from"./isMobile.js";export*from"./replaceVariables.js";export*from"./areArraysEqual.js";export*from"./hasNestedFields.js";export*from"./configure-helpers.js";export*from"./telemetry.js";

package/lib/utils/openapi.d.ts

@@ -1,7 +1,6 @@
-import type { OpenAPIEncoding, OpenAPIMediaType, OpenAPIParameterStyle, OpenAPIRequestBody, OpenAPIResponse, OpenAPISchema, OpenAPIServer, Referenced } from '../types/index.js';
+import type { OpenAPIEncoding, OpenAPIMediaType, OpenAPIParameterStyle, OpenAPIRequestBody, OpenAPIResponse, OpenAPISchema, OpenAPIServer, Referenced, OpenAPIParameter } from '../types/index.js';
 import type { ExtendedOpenAPIOperation, OpenAPIParser } from '../services/index.js';
 import type { FieldModel, GroupModel } from '../models/index.js';
-import { OpenAPIParameter } from '../types/index.js';
 export declare function isStatusCode(statusCode: string): boolean;
 export declare function getStatusCodeType(statusCode: string | number, defaultAsError?: boolean): string;
 export declare function isOperationName(key: string): boolean;