@redocly/reference-docs 2.1.15 → 2.1.19

package/lib-esm/services/extendTheme.js

@@ -1,2 +1,2 @@
-import{__makeTemplateObject}from"tslib";import{mediaCSS,css}from"../redoc-lib";import merge from"deepmerge";export function extendTheme(e){var o,n,t,a,r,l,i;return e.theme?(e.theme=merge(defaultProTheme,e.theme),e.theme.extensionsHook=extensionsHook,(null===(o=e.theme)||void 0===o?void 0:o.menu)&&!(null===(n=e.theme)||void 0===n?void 0:n.sidebar)&&(console.warn('Theme setting "menu" is deprecated. Rename to "sidebar"'),e.theme.sidebar=e.theme.menu),(null===(t=e.theme)||void 0===t?void 0:t.codeSample)&&(console.warn('Theme setting "codeSample" is deprecated. Rename to "codeBlock"'),Object.assign(e.theme.codeBlock,e.theme.codeSample)),(null===(l=null===(r=null===(a=e.theme)||void 0===a?void 0:a.typography)||void 0===r?void 0:r.code)||void 0===l?void 0:l.tokens)&&(console.warn('Theme setting "typography.code.tokens" is deprecated. Move to "codeBlock.tokens"'),e.theme.codeBlock=(null===(i=e.theme)||void 0===i?void 0:i.codeBlock)||{},Object.assign(e.theme.codeBlock.tokens,e.theme.typography.code.tokens)),e):(e.theme=defaultProTheme,e)}var defaultProTheme={overrides:{DownloadButton:{custom:""},NextSectionButton:{custom:""}},codeBlock:{borderRadius:function(e){return e.components.panels.borderRadius},tokens:{}},schema:{constraints:{},examples:{}},rightPanel:{textColor:"#eeeeee"},typography:{heading1:{},heading2:{},heading3:{},rightPanelHeading:{}}};function optional(e,o){return o?e+": "+o+";":""}function typography(e){return e?css(templateObject_1||(templateObject_1=__makeTemplateObject(["\n    ","\n  "],["\n    ","\n  "])),mediaCSS({fontSize:e.fontSize||"",fontWeight:e.fontWeight||"",fontFamily:e.fontFamily||"",lineHeight:e.lineHeight||"",color:e.color||"",textTransform:e.transform||""})):""}function genTokens(e){if(!e)return"";for(var o="",n=0,t=Object.keys(e);n<t.length;n++){var a=t[n];"default"!==a&&(o+=".token."+a+" { color: "+e[a].color+"; }\n")}return e.default?css(templateObject_2||(templateObject_2=__makeTemplateObject(["\n      pre& {\n        ","\n      }\n      ","\n    "],["\n      pre& {\n        ","\n      }\n      ","\n    "])),typography(e.default),o):o}var templateObject_1,templateObject_2,templateObject_3,templateObject_4,templateObject_5,templateObject_6,EXTENSIONS={DownloadButton:function(e){var o=e.theme;return void 0!==o.overrides&&o.overrides.DownloadButton&&o.overrides.DownloadButton.custom||""},H1:function(e){return typography(e.theme.typography.heading1)},H2:function(e){return typography(e.theme.typography.heading2)},H3:function(e){return typography(e.theme.typography.heading3)},RightPanelHeader:function(e){return typography(e.theme.typography.rightPanelHeading)},PropertyNameCell:function(e){var o=e.theme;return o.schema.breakFieldNames?css(templateObject_3||(templateObject_3=__makeTemplateObject(["\n        ","\n        ","\n      "],["\n        ","\n        ","\n      "])),typography(o.typography.fieldName),"\n      && span:last-child {\n        white-space: normal;\n        word-break: break-word;\n        vertical-align: top;\n        max-width: calc(100% - 21px);\n        display: inline-block;\n      }\n    "):typography(o.typography.fieldName)},Markdown:function(e){var o,n,t,a,r=e.theme;return css(templateObject_4||(templateObject_4=__makeTemplateObject(["\n      h1 {\n        ","\n        clear: both;\n      }\n      h2 {\n        ","\n        clear: both;\n      }\n      h3 {\n        ","\n        clear: both;\n      }\n\n      pre {\n        border-radius: ",";\n      }\n\n      code {\n        ","\n      }\n    "],["\n      h1 {\n        ","\n        clear: both;\n      }\n      h2 {\n        ","\n        clear: both;\n      }\n      h3 {\n        ","\n        clear: both;\n      }\n\n      pre {\n        border-radius: ",";\n      }\n\n      code {\n        ","\n      }\n    "])),typography(r.typography.heading1),typography(r.typography.heading2),typography(r.typography.heading3),null!==(n=null===(o=r.codeBlock)||void 0===o?void 0:o.borderRadius)&&void 0!==n?n:0,optional("word-break",null===(a=null===(t=r.typography)||void 0===t?void 0:t.code)||void 0===a?void 0:a.wordBreak))},ConstraintItem:function(e){var o,n,t,a,r=e.theme;return css(templateObject_5||(templateObject_5=__makeTemplateObject(["\n      ",";\n      ",";\n      ","\n      ","\n    "],["\n      ",";\n      ",";\n      ","\n      ","\n    "])),typography(r.schema.constraints),optional("background-color",null===(o=r.schema.constraints)||void 0===o?void 0:o.backgroundColor),optional("border",null===(n=r.schema.constraints)||void 0===n?void 0:n.border),optional("word-break",null===(a=null===(t=r.typography)||void 0===t?void 0:t.code)||void 0===a?void 0:a.wordBreak))},ExampleValue:function(e){var o,n,t,a,r=e.theme;return css(templateObject_6||(templateObject_6=__makeTemplateObject(["\n      ",";\n      ",";\n      ","\n      ","\n    "],["\n      ",";\n      ",";\n      ","\n      ","\n    "])),typography(r.schema.examples),optional("background-color",null===(o=r.schema.examples)||void 0===o?void 0:o.backgroundColor),optional("border",null===(n=r.schema.examples)||void 0===n?void 0:n.border),optional("word-break",null===(a=null===(t=r.typography)||void 0===t?void 0:t.code)||void 0===a?void 0:a.wordBreak))},Prism:function(e){var o,n,t,a=e.theme;return genTokens(null===(o=null==a?void 0:a.codeBlock)||void 0===o?void 0:o.tokens)+optional("word-break",null===(t=null===(n=a.typography)||void 0===n?void 0:n.code)||void 0===t?void 0:t.wordBreak)}};function extensionsHook(e,o){return EXTENSIONS[e]&&EXTENSIONS[e](o)}
+import{__makeTemplateObject}from"tslib";import{mediaCSS,css}from"../redoc-lib";import merge from"deepmerge";export function extendTheme(e){var o,n,t,a,r,l,i,d,c,p,m,h;return e.theme?(e.theme=merge(defaultProTheme,e.theme),e.theme.extensionsHook=extensionsHook,(null===(o=e.theme)||void 0===o?void 0:o.menu)&&!(null===(n=e.theme)||void 0===n?void 0:n.sidebar)&&(console.warn('Theme setting "menu" is deprecated. Rename to "sidebar"'),e.theme.sidebar=e.theme.menu),(null===(t=e.theme)||void 0===t?void 0:t.codeSample)&&(console.warn('Theme setting "codeSample" is deprecated. Rename to "codeBlock"'),Object.assign(null===(a=e.theme)||void 0===a?void 0:a.codeBlock,e.theme.codeSample)),(null===(i=null===(l=null===(r=e.theme)||void 0===r?void 0:r.typography)||void 0===l?void 0:l.code)||void 0===i?void 0:i.tokens)&&(console.warn('Theme setting "typography.code.tokens" is deprecated. Move to "codeBlock.tokens"'),e.theme.codeBlock=(null===(d=e.theme)||void 0===d?void 0:d.codeBlock)||{},Object.assign(null===(p=null===(c=e.theme)||void 0===c?void 0:c.codeBlock)||void 0===p?void 0:p.tokens,(null===(h=null===(m=e.theme)||void 0===m?void 0:m.typography)||void 0===h?void 0:h.code).tokens)),e):(e.theme=defaultProTheme,e)}var defaultProTheme={overrides:{DownloadButton:{custom:""},NextSectionButton:{custom:""}},codeBlock:{borderRadius:function(e){return e.components.panels.borderRadius},tokens:{}},schema:{constraints:{},examples:{}},rightPanel:{textColor:"#eeeeee"},typography:{heading1:{},heading2:{},heading3:{},rightPanelHeading:{}}};function optional(e,o){return o?e+": "+o+";":""}function typography(e){return e?css(templateObject_1||(templateObject_1=__makeTemplateObject(["\n    ","\n  "],["\n    ","\n  "])),mediaCSS({fontSize:e.fontSize||"",fontWeight:e.fontWeight||"",fontFamily:e.fontFamily||"",lineHeight:e.lineHeight||"",color:e.color||"",textTransform:e.transform||""})):""}function genTokens(e){if(!e)return"";for(var o="",n=0,t=Object.keys(e);n<t.length;n++){var a=t[n];"default"!==a&&(o+=".token."+a+" { color: "+e[a].color+"; }\n")}return e.default?css(templateObject_2||(templateObject_2=__makeTemplateObject(["\n      pre& {\n        ","\n      }\n      ","\n    "],["\n      pre& {\n        ","\n      }\n      ","\n    "])),typography(e.default),o):o}var templateObject_1,templateObject_2,templateObject_3,templateObject_4,templateObject_5,templateObject_6,EXTENSIONS={DownloadButton:function(e){var o=e.theme;return void 0!==o.overrides&&o.overrides.DownloadButton&&o.overrides.DownloadButton.custom||""},H1:function(e){return typography(e.theme.typography.heading1)},H2:function(e){return typography(e.theme.typography.heading2)},H3:function(e){return typography(e.theme.typography.heading3)},RightPanelHeader:function(e){return typography(e.theme.typography.rightPanelHeading)},PropertyNameCell:function(e){var o=e.theme;return o.schema.breakFieldNames?css(templateObject_3||(templateObject_3=__makeTemplateObject(["\n        ","\n        ","\n      "],["\n        ","\n        ","\n      "])),typography(o.typography.fieldName),"\n      && span:last-child {\n        white-space: normal;\n        word-break: break-word;\n        vertical-align: top;\n        max-width: calc(100% - 21px);\n        display: inline-block;\n      }\n    "):typography(o.typography.fieldName)},Markdown:function(e){var o,n,t,a,r=e.theme;return css(templateObject_4||(templateObject_4=__makeTemplateObject(["\n      h1 {\n        ","\n        clear: both;\n      }\n      h2 {\n        ","\n        clear: both;\n      }\n      h3 {\n        ","\n        clear: both;\n      }\n\n      pre {\n        border-radius: ",";\n      }\n\n      code {\n        ","\n      }\n    "],["\n      h1 {\n        ","\n        clear: both;\n      }\n      h2 {\n        ","\n        clear: both;\n      }\n      h3 {\n        ","\n        clear: both;\n      }\n\n      pre {\n        border-radius: ",";\n      }\n\n      code {\n        ","\n      }\n    "])),typography(r.typography.heading1),typography(r.typography.heading2),typography(r.typography.heading3),null!==(n=null===(o=r.codeBlock)||void 0===o?void 0:o.borderRadius)&&void 0!==n?n:0,optional("word-break",null===(a=null===(t=r.typography)||void 0===t?void 0:t.code)||void 0===a?void 0:a.wordBreak))},ConstraintItem:function(e){var o,n,t,a,r=e.theme;return css(templateObject_5||(templateObject_5=__makeTemplateObject(["\n      ",";\n      ",";\n      ","\n      ","\n    "],["\n      ",";\n      ",";\n      ","\n      ","\n    "])),typography(r.schema.constraints),optional("background-color",null===(o=r.schema.constraints)||void 0===o?void 0:o.backgroundColor),optional("border",null===(n=r.schema.constraints)||void 0===n?void 0:n.border),optional("word-break",null===(a=null===(t=r.typography)||void 0===t?void 0:t.code)||void 0===a?void 0:a.wordBreak))},ExampleValue:function(e){var o,n,t,a,r=e.theme;return css(templateObject_6||(templateObject_6=__makeTemplateObject(["\n      ",";\n      ",";\n      ","\n      ","\n    "],["\n      ",";\n      ",";\n      ","\n      ","\n    "])),typography(r.schema.examples),optional("background-color",null===(o=r.schema.examples)||void 0===o?void 0:o.backgroundColor),optional("border",null===(n=r.schema.examples)||void 0===n?void 0:n.border),optional("word-break",null===(a=null===(t=r.typography)||void 0===t?void 0:t.code)||void 0===a?void 0:a.wordBreak))},Prism:function(e){var o,n,t,a=e.theme;return genTokens(null===(o=null==a?void 0:a.codeBlock)||void 0===o?void 0:o.tokens)+optional("word-break",null===(t=null===(n=a.typography)||void 0===n?void 0:n.code)||void 0===t?void 0:t.wordBreak)}};function extensionsHook(e,o){return EXTENSIONS[e]&&EXTENSIONS[e](o)}
 //# sourceMappingURL=extendTheme.js.map

package/lib-esm/services/history/ProHashHistoryService.d.ts

@@ -14,7 +14,7 @@ export declare class ProHashHistoryService implements Interface<HistoryService>
     makeUrl(path: string, hash: string): string;
     linkForId(id: string): string;
     generateDeepLink(fieldFragment: string, operationLink?: string): string | undefined;
-    subscribe(cb: any): () => void;
+    subscribe(cb: (id: string) => void): () => void;
     emit: () => void;
     bind(): void;
     dispose(): void;

package/lib-esm/services/history/PushStateHistoryService.d.ts

@@ -12,7 +12,7 @@ export declare class PushStateHistoryService implements Interface<HistoryService
     makeUrl(path: string, hash: string): string;
     generateDeepLink(fieldFragment: string, operationLink?: string): string | null;
     linkForId(id?: string): string;
-    subscribe(cb: any): () => void;
+    subscribe(cb: (id: string) => void): () => void;
     emit: () => void;
     bind(): void;
     dispose(): void;

package/lib-esm/services/utils.d.ts

@@ -11,4 +11,4 @@ export declare function isSameMime(a?: string, b?: string): boolean;
  */
 export declare function normalizeMimeType(mimeType?: string): string | undefined;
 export declare function unescapeServerVariables(str: string): string;
-export declare function arrayMerge(target: any[], source: any[]): any[];
+export declare function arrayMerge<T>(target: T[], source: T[]): T[];

package/lib-esm/standalone.d.ts

@@ -13,12 +13,13 @@ import 'core-js/es/string/starts-with';
 import 'core-js/es/symbol';
 import 'unfetch/polyfill/index';
 import 'url-polyfill';
+import { ProStoreState, RedocProRawOptions } from './services/ProStore';
 import { LayoutVariant } from './services/store-types';
 export { setSecurityDetails, setParameterValue, setSecurityDetailsVariants } from './utils';
 export declare function toggleLayout(layout?: LayoutVariant): void;
 export declare function toggleRightPanel(value?: boolean): void;
-export declare function hydrate(state: any, element?: Element | null): void;
-export declare function init(definitionOrDefinitionUrl: string | any, options?: any, element?: Element | null, callback?: () => void): void;
-export declare function setPublicPath(path: any): void;
+export declare function hydrate(state: ProStoreState, element?: Element | null): void;
+export declare function init(definitionOrDefinitionUrl: string | any, options?: RedocProRawOptions, element?: Element | null, callback?: () => void): void;
+export declare function setPublicPath(path: string): void;
 export declare const version: string;
 export declare const revision: string;

package/lib-esm/standalone.js

@@ -1,2 +1,2 @@
-import{__assign}from"tslib";import"core-js/es/array/find-index";import"core-js/es/array/find";import"core-js/es/array/includes";import"core-js/es/map";import"core-js/es/number/is-integer";import"core-js/es/object/assign";import"core-js/es/object/entries";import"core-js/es/object/is";import"core-js/es/object/values";import"core-js/es/promise";import"core-js/es/string/ends-with";import"core-js/es/string/starts-with";import"core-js/es/symbol";import"unfetch/polyfill/index";import"url-polyfill";import{dirname}from"path";import*as React from"react";import{hydrate as hydrateComponent,render}from"react-dom";import{querySelector,IS_BROWSER}from"./redoc-lib";import{ProStore}from"./services/ProStore";import{LayoutVariant}from"./services/store-types";import{RedoclyReferenceDocs,RedoclyReferenceDocsStandalone,RedoclyReferenceDocsMultiStandalone}from"./components/RedoclyReferenceDocs";import{getGlobalStore}from"./utils";export{setSecurityDetails,setParameterValue,setSecurityDetailsVariants}from"./utils";export function toggleLayout(e){var r=getGlobalStore();r&&r.toggleLayout((null!=e?e:r.layout===LayoutVariant.STACKED)?LayoutVariant.THREE_PANEL:LayoutVariant.STACKED)}export function toggleRightPanel(e){var r=getGlobalStore();r&&r.toggleRightPanel(e)}var url=getJsUrl(),__dirname=url?dirname(url)+"/":"";function attributesMap(e){for(var r={},t=e.attributes,o=0;o<t.length;o++){var i=t[o];r[i.name]=i.value}return r}function parseOptionsFromElement(e){var r=attributesMap(e),t={};for(var o in r){t[o.replace(/-(.)/g,(function(e,r){return r.toUpperCase()}))]=r[o]}return t}export function hydrate(e,r){void 0===r&&(r=document.querySelector("redoc"));var t=ProStore.fromJS(e);hydrateComponent(React.createElement(RedoclyReferenceDocs,{store:t}),r)}export function init(e,r,t,o){if(void 0===r&&(r={}),void 0===t&&(t=querySelector("redoc")),null===t)throw new Error('"element" argument is not provided and <redoc> tag is not found on the page');var i,n;Array.isArray(e)||e&&e.versions?render(React.createElement(RedoclyReferenceDocsMultiStandalone,{definitions:e,options:__assign(__assign({},r),parseOptionsFromElement(t))},["Loading..."]),t,o):("string"==typeof e?i=e:"object"==typeof e&&(n=e),render(React.createElement(RedoclyReferenceDocsStandalone,{definition:n,definitionUrl:i,options:__assign(__assign({},r),parseOptionsFromElement(t))},["Loading..."]),t,o))}export function setPublicPath(e){__webpack_public_path__=e}export var version=__REDOCLY_API_REFERENCE_VERSION__;export var revision=__REDOCLY_API_REFERENCE_REVISION__;function autoInit(){var e=querySelector("redoc");if(e){var r=e.getAttribute("spec-url");r&&init(r,{},e)}}function getJsUrl(){if(!IS_BROWSER)return"";var e=+new Date+Math.random();try{return document.currentScript&&(document.currentScript.async||document.currentScript.defer)||document.write('<script id="dummy'+e+'"><\/script>'),document.getElementById("dummy"+e).previousSibling.src}catch(e){return""}}IS_BROWSER&&setPublicPath(__dirname),autoInit();
+import{__assign}from"tslib";import"core-js/es/array/find-index";import"core-js/es/array/find";import"core-js/es/array/includes";import"core-js/es/map";import"core-js/es/number/is-integer";import"core-js/es/object/assign";import"core-js/es/object/entries";import"core-js/es/object/is";import"core-js/es/object/values";import"core-js/es/promise";import"core-js/es/string/ends-with";import"core-js/es/string/starts-with";import"core-js/es/symbol";import"unfetch/polyfill/index";import"url-polyfill";import{dirname}from"path";import*as React from"react";import{hydrate as hydrateComponent,render}from"react-dom";import{querySelector,IS_BROWSER}from"./redoc-lib";import{ProStore}from"./services/ProStore";import{LayoutVariant}from"./services/store-types";import{RedoclyReferenceDocs,RedoclyReferenceDocsStandalone,RedoclyReferenceDocsMultiStandalone}from"./components/RedoclyReferenceDocs";import{getGlobalStore}from"./utils";export{setSecurityDetails,setParameterValue,setSecurityDetailsVariants}from"./utils";export function toggleLayout(e){var r=getGlobalStore();r&&r.toggleLayout((null!=e?e:r.layout===LayoutVariant.STACKED)?LayoutVariant.THREE_PANEL:LayoutVariant.STACKED)}export function toggleRightPanel(e){var r=getGlobalStore();r&&r.toggleRightPanel(e)}var url=getJsUrl(),__dirname=url?dirname(url)+"/":"";function attributesMap(e){for(var r={},t=e.attributes,o=0;o<t.length;o++){var i=t[o];r[i.name]=i.value}return r}function parseOptionsFromElement(e){var r=attributesMap(e),t={};for(var o in r){t[o.replace(/-(.)/g,(function(e,r){return r.toUpperCase()}))]=r[o]}return t}export function hydrate(e,r){void 0===r&&(r=document.querySelector("redoc"));var t=ProStore.fromJS(e);hydrateComponent(React.createElement(RedoclyReferenceDocs,{store:t}),r)}export function init(e,r,t,o){if(void 0===r&&(r={}),void 0===t&&(t=querySelector("redoc")),null===t)throw new Error('"element" argument is not provided and <redoc> tag is not found on the page');var i,n;Array.isArray(e)||e&&e.versions?render(React.createElement(RedoclyReferenceDocsMultiStandalone,{definitions:e,options:__assign(__assign({},r),parseOptionsFromElement(t))},["Loading..."]),t,o):("string"==typeof e?i=e:"object"==typeof e&&(n=e),render(React.createElement(RedoclyReferenceDocsStandalone,{definition:n,definitionUrl:i,options:__assign(__assign({},r),parseOptionsFromElement(t))},["Loading..."]),t,o))}export function setPublicPath(e){__webpack_public_path__=e}export var version=__REDOCLY_API_REFERENCE_VERSION__;export var revision=__REDOCLY_API_REFERENCE_REVISION__;function autoInit(){var e=querySelector("redoc");if(e){var r=e.getAttribute("spec-url");r&&init(r,{},e)}}function getJsUrl(){var e;if(!IS_BROWSER)return"";var r=+new Date+Math.random();try{return document.currentScript&&(document.currentScript.async||document.currentScript.defer)||document.write('<script id="dummy'+r+'"><\/script>'),(null===(e=document.getElementById("dummy"+r))||void 0===e?void 0:e.previousSibling).src}catch(e){return""}}IS_BROWSER&&setPublicPath(__dirname),autoInit();
 //# sourceMappingURL=standalone.js.map

package/lib-esm/utils.d.ts

@@ -4,7 +4,7 @@ export declare const setGlobalStore: (store: ProStore) => ProStore;
 export declare function debounce<T extends unknown>(fn: (...args: T[]) => void, threshold: number, leading?: boolean): (...args: T[]) => void;
 export declare function toStorage(key: string, value: string): void;
 export declare function fromStorage(key: string): string;
-export declare function setParameterValue(_in: string, name: string, value: any): void;
+export declare function setParameterValue(_in: string, name: string, value: GenericObject): void;
 export declare function getParameterValue(_in: string, name: string): string | null;
 export declare function toLocalStorage(key: string, value: string): void;
 export declare function fromLocalStorage(key: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/reference-docs",
-  "version": "2.1.15",
+  "version": "2.1.19",
   "description": "Redocly Reference Docs",
   "main": "lib/index.js",
   "module": "lib-esm/index.js",
@@ -72,7 +72,7 @@
     "start": "webpack-dev-server --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 . --ext .ts --cache",
+    "lint": "eslint --fix . --ext .ts,.tsx --cache",
     "prepublish-test": "scripts/prepublish-test.sh",
     "test": "npm run test:unit && npm run test:e2e",
     "test:unit": "jest",