@redocly/openapi-docs 3.0.0-alpha.71 → 3.0.0-alpha.72.beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/console.redocly-openapi-docs.min.js +1 -1
- package/dist/oauth2-redirect.js +1 -1
- package/dist/redocly-openapi-docs.min.js +419 -419
- package/lib/components/Markdown/Markdown.js +1 -1
- package/lib/components/RedoclyOpenAPIDocs/Providers.js +1 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.js +1 -1
- package/lib/services/Options/normalizeOptions.js +1 -1
- package/lib/services/Options/types.d.ts +3 -3
- package/lib/services/menu/builder.js +1 -1
- package/lib/services/menu/markdown.js +1 -1
- package/lib/types/open-api.d.ts +4 -1
- package/lib/utils/saveTextBeforeHeading.js +1 -1
- package/lib-esm/components/Markdown/Markdown.js +1 -1
- package/lib-esm/components/RedoclyOpenAPIDocs/Providers.js +1 -1
- package/lib-esm/index.d.ts +1 -0
- package/lib-esm/index.js +1 -1
- package/lib-esm/services/Options/normalizeOptions.js +1 -1
- package/lib-esm/services/Options/types.d.ts +3 -3
- package/lib-esm/services/menu/builder.js +1 -1
- package/lib-esm/services/menu/markdown.js +1 -1
- package/lib-esm/types/open-api.d.ts +4 -1
- package/lib-esm/utils/saveTextBeforeHeading.js +1 -1
- package/package.json +3 -3
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,o){void 0===o&&(o=r);var
|
|
1
|
+
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,o){void 0===o&&(o=r);var i=Object.getOwnPropertyDescriptor(t,r);i&&!("get"in i?!t.__esModule:i.writable||i.configurable)||(i={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,o,i)}:function(e,t,r,o){void 0===o&&(o=r),e[o]=t[r]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),__importStar=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var r in e)"default"!==r&&Object.prototype.hasOwnProperty.call(e,r)&&__createBinding(t,e,r);return __setModuleDefault(t,e),t},__rest=this&&this.__rest||function(e,t){var r={};for(var o in e)Object.prototype.hasOwnProperty.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var i=0;for(o=Object.getOwnPropertySymbols(e);i<o.length;i++)t.indexOf(o[i])<0&&Object.prototype.propertyIsEnumerable.call(e,o[i])&&(r[o[i]]=e[o[i]])}return r},__importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.Markdown=void 0;const react_1=__importStar(require("react")),markdoc_1=require("@markdoc/markdoc"),jotai_1=require("jotai"),dompurify_1=__importDefault(require("dompurify")),theme_1=require("@redocly/theme"),store_1=require("../../jotai/store"),utils_1=require("../../utils"),Markdown=e=>{var t,r,o,i,n,a,l,s,u,{source:d,ast:c,htmlWrap:_}=e,f=__rest(e,["source","ast","htmlWrap"]);const m=(0,jotai_1.useAtomValue)(store_1.globalOptionsAtom);if(!d&&!c)return null;const p=(null==m?void 0:m.markdocOptions)&&{tags:null===(t=m.markdocOptions)||void 0===t?void 0:t.tags,nodes:null===(r=m.markdocOptions)||void 0===r?void 0:r.nodes,partials:null===(o=m.markdocOptions)||void 0===o?void 0:o.partials,variables:null===(i=m.markdocOptions)||void 0===i?void 0:i.variables,functions:null===(n=m.markdocOptions)||void 0===n?void 0:n.functions},v=(null==m?void 0:m.markdocOptions)&&{components:null===(a=m.markdocOptions)||void 0===a?void 0:a.components};let O;if(d)if((0,utils_1.isString)(d)){const e=(null===(l=null==m?void 0:m.hooks)||void 0===l?void 0:l.sanitize)?null===(u=null===(s=m.hooks)||void 0===s?void 0:s.sanitize)||void 0===u?void 0:u.call(s,d):(null==m?void 0:m.untrustedDefinition)?dompurify_1.default.sanitize(d):d,t=(0,markdoc_1.parse)(e);O=(0,markdoc_1.transform)(t,p)}else{const e=markdoc_1.Ast.fromJSON("object"==typeof d.result?JSON.stringify(d.result):d.result);O=(Array.isArray(e),(0,markdoc_1.transform)(e,p))}else c&&(O=(0,markdoc_1.transform)(c,p));const y=e=>{const t=markdoc_1.renderers.react(e,react_1.default,v);return react_1.default.createElement(theme_1.MarkdownWrapper,Object.assign({},f,{children:t,as:"div"}))};if(!_)return y(O);return O=Array.isArray(O)?O:O.children,react_1.default.createElement(react_1.default.Fragment,null," ",O.map(((e,t)=>{var r,o,i,n;return react_1.default.createElement(react_1.Fragment,{key:(null===(r=null==e?void 0:e.attributes)||void 0===r?void 0:r.id)||t},(n=null==e?void 0:e.attributes,o=!1!==(null==n?void 0:n.htmlWrap),i=e,o?_(y(i)):y(i)))})))};exports.Markdown=Markdown;
|
|
2
2
|
//# sourceMappingURL=Markdown.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,i,r){void 0===r&&(r=i);var n=Object.getOwnPropertyDescriptor(t,i);n&&!("get"in n?!t.__esModule:n.writable||n.configurable)||(n={enumerable:!0,get:function(){return t[i]}}),Object.defineProperty(e,r,n)}:function(e,t,i,r){void 0===r&&(r=i),e[r]=t[i]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),__importStar=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var i in e)"default"!==i&&Object.prototype.hasOwnProperty.call(e,i)&&__createBinding(t,e,i);return __setModuleDefault(t,e),t},__awaiter=this&&this.__awaiter||function(e,t,i,r){return new(i||(i=Promise))((function(n,o){function a(e){try{l(r.next(e))}catch(e){o(e)}}function s(e){try{l(r.throw(e))}catch(e){o(e)}}function l(e){var t;e.done?n(e.value):(t=e.value,t instanceof i?t:new i((function(e){e(t)}))).then(a,s)}l((r=r.apply(e,t||[])).next())}))},__importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.StoreProvider=exports.AppProvider=exports.ThemeProviders=void 0;const styled_components_1=require("styled-components"),react_1=__importStar(require("react")),markdoc_1=require("@markdoc/markdoc"),theme_1=require("@redocly/theme"),jotai_1=require("jotai"),services_1=require("../../services"),utils_1=require("./utils"),utils_2=require("../../utils"),Loading_1=require("../Loading"),constants_1=require("../../constants"),SecurityRequirement_1=require("../SecurityRequirement"),SchemaDefinition_1=require("../SchemaDefinition"),pluggable_1=require("../pluggable"),app_1=require("../../jotai/app"),store_1=require("../../jotai/store"),operation_1=require("../../jotai/operation"),nexus_1=__importDefault(require("../../jotai/nexus")),ThemeProviders=({options:e,children:t,customOptions:i={}})=>{const r=Object.assign(Object.assign({},e),i),n=(0,react_1.useMemo)((()=>({mediaQueries:r.mediaQueries,showAtBreakpoint:r.showAtBreakpoint})),[r.mediaQueries,r.showAtBreakpoint]);return react_1.default.createElement(styled_components_1.ThemeProvider,{theme:n},t)};exports.ThemeProviders=ThemeProviders;const AppProvider=({definitions:e,options:t,definitionUrl:i,definition:r,activeSampleLanguage:n,children:o})=>{const[,a]=(0,react_1.useState)(),[s,l]=(0,react_1.useState)(!0),[u,c]=(0,react_1.useState)(null);(0,react_1.useEffect)((()=>{!function(){__awaiter(this,void 0,void 0,(function*(){l(!0);try{c(e?yield(0,utils_1.loadMany)(e):yield(0,utils_1.loadSingle)(r,i,t))}catch(e){a((()=>{throw e}))}}))}()}),[e,r,i,t]);const d=(0,react_1.useMemo)((()=>{var e,r,o;if(u)return(null===(e=null==t?void 0:t.hooks)||void 0===e?void 0:e.onInit)&&(null===(o=null===(r=t.hooks)||void 0===r?void 0:r.onInit)||void 0===o||o.call(r,{store:{definition:u,options:t,definitionUrl:i,activeSampleLanguage:n}})),{definition:u,options:t,definitionUrl:i,activeSampleLanguage:n}}),(0,utils_1.useDeepCompareMemoize)([u,t,i]));return(0,react_1.useEffect)((()=>{d&&l(!1)}),[d]),d?s?(0,utils_2.argValueToBoolean)(null==t?void 0:t.hideLoading,!1)?null:react_1.default.createElement(Loading_1.Loading,{color:"--loading-spinner-color"}):react_1.default.isValidElement(o)?react_1.default.cloneElement(o,{store:d}):null:null};exports.AppProvider=AppProvider;const DEFAULT_OPTIONS={ignoreNamedSchemas:["java.io.ObjectStreamField"],breakpoints:constants_1.defaultTheme.breakpoints,showAtBreakpoint:constants_1.defaultTheme.showAtBreakpoint,
|
|
1
|
+
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,i,r){void 0===r&&(r=i);var n=Object.getOwnPropertyDescriptor(t,i);n&&!("get"in n?!t.__esModule:n.writable||n.configurable)||(n={enumerable:!0,get:function(){return t[i]}}),Object.defineProperty(e,r,n)}:function(e,t,i,r){void 0===r&&(r=i),e[r]=t[i]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),__importStar=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var i in e)"default"!==i&&Object.prototype.hasOwnProperty.call(e,i)&&__createBinding(t,e,i);return __setModuleDefault(t,e),t},__awaiter=this&&this.__awaiter||function(e,t,i,r){return new(i||(i=Promise))((function(n,o){function a(e){try{l(r.next(e))}catch(e){o(e)}}function s(e){try{l(r.throw(e))}catch(e){o(e)}}function l(e){var t;e.done?n(e.value):(t=e.value,t instanceof i?t:new i((function(e){e(t)}))).then(a,s)}l((r=r.apply(e,t||[])).next())}))},__importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.StoreProvider=exports.AppProvider=exports.ThemeProviders=void 0;const styled_components_1=require("styled-components"),react_1=__importStar(require("react")),markdoc_1=require("@markdoc/markdoc"),theme_1=require("@redocly/theme"),jotai_1=require("jotai"),services_1=require("../../services"),utils_1=require("./utils"),utils_2=require("../../utils"),Loading_1=require("../Loading"),constants_1=require("../../constants"),SecurityRequirement_1=require("../SecurityRequirement"),SchemaDefinition_1=require("../SchemaDefinition"),pluggable_1=require("../pluggable"),app_1=require("../../jotai/app"),store_1=require("../../jotai/store"),operation_1=require("../../jotai/operation"),nexus_1=__importDefault(require("../../jotai/nexus")),ThemeProviders=({options:e,children:t,customOptions:i={}})=>{const r=Object.assign(Object.assign({},e),i),n=(0,react_1.useMemo)((()=>({mediaQueries:r.mediaQueries,showAtBreakpoint:r.showAtBreakpoint})),[r.mediaQueries,r.showAtBreakpoint]);return react_1.default.createElement(styled_components_1.ThemeProvider,{theme:n},t)};exports.ThemeProviders=ThemeProviders;const AppProvider=({definitions:e,options:t,definitionUrl:i,definition:r,activeSampleLanguage:n,children:o})=>{const[,a]=(0,react_1.useState)(),[s,l]=(0,react_1.useState)(!0),[u,c]=(0,react_1.useState)(null);(0,react_1.useEffect)((()=>{!function(){__awaiter(this,void 0,void 0,(function*(){l(!0);try{c(e?yield(0,utils_1.loadMany)(e):yield(0,utils_1.loadSingle)(r,i,t))}catch(e){a((()=>{throw e}))}}))}()}),[e,r,i,t]);const d=(0,react_1.useMemo)((()=>{var e,r,o;if(u)return(null===(e=null==t?void 0:t.hooks)||void 0===e?void 0:e.onInit)&&(null===(o=null===(r=t.hooks)||void 0===r?void 0:r.onInit)||void 0===o||o.call(r,{store:{definition:u,options:t,definitionUrl:i,activeSampleLanguage:n}})),{definition:u,options:t,definitionUrl:i,activeSampleLanguage:n}}),(0,utils_1.useDeepCompareMemoize)([u,t,i]));return(0,react_1.useEffect)((()=>{d&&l(!1)}),[d]),d?s?(0,utils_2.argValueToBoolean)(null==t?void 0:t.hideLoading,!1)?null:react_1.default.createElement(Loading_1.Loading,{color:"--loading-spinner-color"}):react_1.default.isValidElement(o)?react_1.default.cloneElement(o,{store:d}):null:null};exports.AppProvider=AppProvider;const DEFAULT_OPTIONS={ignoreNamedSchemas:["java.io.ObjectStreamField"],breakpoints:constants_1.defaultTheme.breakpoints,showAtBreakpoint:constants_1.defaultTheme.showAtBreakpoint,markdocOptions:{tags:{securityDefinitions:{render:"SecurityDefinitions"},pullRight:{render:"PullRight",attributes:{htmlWrap:{type:String,default:!1}}},schemaDefinition:{render:"SchemaDefinition",attributes:{schemaRef:{type:String},exampleRef:{type:String},showReadOnly:{type:Boolean},showWriteOnly:{type:Boolean},htmlWrap:{type:String,default:!1}}}},nodes:{heading:{children:["inline"],attributes:{id:{type:String},level:{type:Number,required:!0,default:1}},transform(e,t){const i=e.transformAttributes(t),r=e.transformChildren(t),n="string"==typeof i.id?i.id:(0,utils_1.getMarkdownHeaderId)(r);return new markdoc_1.Tag("Heading",Object.assign(Object.assign({},i),{id:n,level:e.attributes.level}),r)}}},components:{SecurityDefinitions:SecurityRequirement_1.SecurityDefs,SchemaDefinition:SchemaDefinition_1.SchemaDefinition,RedocResponse:pluggable_1.RedocResponse,PullRight:pluggable_1.PullRight,Heading:theme_1.Heading}}};exports.StoreProvider=(0,react_1.memo)((({children:e,options:t,definitionUrl:i,definition:r,activeSampleLanguage:n,portalOptions:o})=>{const a=react_1.default.useRef(),s=react_1.default.useCallback((()=>{var e;const n=(0,services_1.normalizeOptions)(Object.assign({},t),DEFAULT_OPTIONS),o=isVersioned(r)?(null===(e=r.versions)||void 0===e?void 0:e.map((({spec:e,id:t,title:i,url:r},o)=>{if(e){const a=t||`Definition_${o}`;return{id:a,title:i||`Definition_${o}`,url:r,parser:new services_1.OpenAPIParser(e,void 0,Object.assign(Object.assign({},n),{versionId:a}))}}})).filter(Boolean))||[]:[{url:i,parser:new services_1.OpenAPIParser(r,i,n)}];return{options:n,versions:o}}),[r,i,t]),l=(0,react_1.useMemo)((()=>{const e=(0,jotai_1.createStore)();a.current=e.set;const t=s(),i=t.options,r=JSON.parse((0,utils_2.fromLocalStorage)("appLocalStore")||"{}"),l=JSON.parse((0,utils_2.fromSessionStorage)("appSessionStore")||"{}");if(e.set(app_1.appSessionStore,(e=>Object.assign(Object.assign({},e),{showRightPanelToggle:l.showRightPanelToggle||i.showRightPanelToggle,activeVersionIdx:0}))),e.set(app_1.appLocalStore,(e=>Object.assign(Object.assign({},e),{layout:r.layout||i.layout,activeSampleLanguage:n||r.activeSampleLanguage||i.defaultSampleLanguage}))),e.set(store_1.globalStore,(e=>Object.assign(Object.assign({},e),t))),e.set(app_1.appStore,{isSidebarOpened:!1,activeMimeName:(null==o?void 0:o.defaultMimeType)||"",menuNextLinks:[]}),null==o?void 0:o.operation){const{pointer:t,activeExampleName:i,activeServer:r}=o.operation;e.set((0,operation_1.operationStore)(t),(e=>Object.assign(Object.assign({},e),{activeExampleName:i,activeOneOf:{},activeServer:r,requestValues:{}})))}return e}),[n,s,null==o?void 0:o.defaultMimeType,null==o?void 0:o.operation]);return(0,react_1.useEffect)((()=>{a.current&&setTimeout((()=>{a.current(store_1.globalStore,s())}),0)}),[s,r]),react_1.default.createElement(jotai_1.Provider,{store:l,key:(null==o?void 0:o.definitionId)||"openapi"},react_1.default.createElement(nexus_1.default,null),e)}));const isVersioned=e=>"versions"in e;
|
|
2
2
|
//# sourceMappingURL=Providers.js.map
|
package/lib/index.d.ts
CHANGED
|
@@ -13,3 +13,4 @@ export { JsonPointer } from './utils/JsonPointer';
|
|
|
13
13
|
export { isOperationName } from './utils/openapi';
|
|
14
14
|
export { OpenAPIParser } from './services';
|
|
15
15
|
export { buildContentItems, normalizeOptions } from './services';
|
|
16
|
+
export declare function useOpenapiDocsOptions(): import("./services").Options;
|
package/lib/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.normalizeOptions=exports.buildContentItems=exports.OpenAPIParser=exports.isOperationName=exports.JsonPointer=exports.getMarkdownHeaderId=exports.StoreProvider=exports.AppProvider=exports.ThemeProviders=exports.RedoclyOpenAPIDocsStandalone=exports.RedoclyOpenAPIDocs=exports.RedocRequestBody=exports.RedocExample=exports.RedocSchema=exports.RedocResponse=exports.PullRight=exports.RequestSamples=exports.Console=exports.getOperation=void 0;var operation_1=require("./models/operation");Object.defineProperty(exports,"getOperation",{enumerable:!0,get:function(){return operation_1.getOperation}});var Console_1=require("./components/rightPanel/Console");Object.defineProperty(exports,"Console",{enumerable:!0,get:function(){return Console_1.Console}});var RequestSamples_1=require("./components/RequestSamples");Object.defineProperty(exports,"RequestSamples",{enumerable:!0,get:function(){return RequestSamples_1.RequestSamples}});var pluggable_1=require("./components/pluggable");Object.defineProperty(exports,"PullRight",{enumerable:!0,get:function(){return pluggable_1.PullRight}}),Object.defineProperty(exports,"RedocResponse",{enumerable:!0,get:function(){return pluggable_1.RedocResponse}}),Object.defineProperty(exports,"RedocSchema",{enumerable:!0,get:function(){return pluggable_1.RedocSchema}}),Object.defineProperty(exports,"RedocExample",{enumerable:!0,get:function(){return pluggable_1.RedocExample}}),Object.defineProperty(exports,"RedocRequestBody",{enumerable:!0,get:function(){return pluggable_1.RedocRequestBody}});var RedoclyOpenAPIDocs_1=require("./components/RedoclyOpenAPIDocs");Object.defineProperty(exports,"RedoclyOpenAPIDocs",{enumerable:!0,get:function(){return RedoclyOpenAPIDocs_1.RedoclyOpenAPIDocs}}),Object.defineProperty(exports,"RedoclyOpenAPIDocsStandalone",{enumerable:!0,get:function(){return RedoclyOpenAPIDocs_1.RedoclyOpenAPIDocsStandalone}}),Object.defineProperty(exports,"ThemeProviders",{enumerable:!0,get:function(){return RedoclyOpenAPIDocs_1.ThemeProviders}}),Object.defineProperty(exports,"AppProvider",{enumerable:!0,get:function(){return RedoclyOpenAPIDocs_1.AppProvider}}),Object.defineProperty(exports,"StoreProvider",{enumerable:!0,get:function(){return RedoclyOpenAPIDocs_1.StoreProvider}}),Object.defineProperty(exports,"getMarkdownHeaderId",{enumerable:!0,get:function(){return RedoclyOpenAPIDocs_1.getMarkdownHeaderId}});var JsonPointer_1=require("./utils/JsonPointer");Object.defineProperty(exports,"JsonPointer",{enumerable:!0,get:function(){return JsonPointer_1.JsonPointer}});var openapi_1=require("./utils/openapi");Object.defineProperty(exports,"isOperationName",{enumerable:!0,get:function(){return openapi_1.isOperationName}});var services_1=require("./services");Object.defineProperty(exports,"OpenAPIParser",{enumerable:!0,get:function(){return services_1.OpenAPIParser}});var services_2=require("./services");Object.defineProperty(exports,"buildContentItems",{enumerable:!0,get:function(){return services_2.buildContentItems}}),Object.defineProperty(exports,"normalizeOptions",{enumerable:!0,get:function(){return services_2.normalizeOptions}});
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.useOpenapiDocsOptions=exports.normalizeOptions=exports.buildContentItems=exports.OpenAPIParser=exports.isOperationName=exports.JsonPointer=exports.getMarkdownHeaderId=exports.StoreProvider=exports.AppProvider=exports.ThemeProviders=exports.RedoclyOpenAPIDocsStandalone=exports.RedoclyOpenAPIDocs=exports.RedocRequestBody=exports.RedocExample=exports.RedocSchema=exports.RedocResponse=exports.PullRight=exports.RequestSamples=exports.Console=exports.getOperation=void 0;const jotai_1=require("jotai"),store_1=require("./jotai/store");var operation_1=require("./models/operation");Object.defineProperty(exports,"getOperation",{enumerable:!0,get:function(){return operation_1.getOperation}});var Console_1=require("./components/rightPanel/Console");Object.defineProperty(exports,"Console",{enumerable:!0,get:function(){return Console_1.Console}});var RequestSamples_1=require("./components/RequestSamples");Object.defineProperty(exports,"RequestSamples",{enumerable:!0,get:function(){return RequestSamples_1.RequestSamples}});var pluggable_1=require("./components/pluggable");Object.defineProperty(exports,"PullRight",{enumerable:!0,get:function(){return pluggable_1.PullRight}}),Object.defineProperty(exports,"RedocResponse",{enumerable:!0,get:function(){return pluggable_1.RedocResponse}}),Object.defineProperty(exports,"RedocSchema",{enumerable:!0,get:function(){return pluggable_1.RedocSchema}}),Object.defineProperty(exports,"RedocExample",{enumerable:!0,get:function(){return pluggable_1.RedocExample}}),Object.defineProperty(exports,"RedocRequestBody",{enumerable:!0,get:function(){return pluggable_1.RedocRequestBody}});var RedoclyOpenAPIDocs_1=require("./components/RedoclyOpenAPIDocs");Object.defineProperty(exports,"RedoclyOpenAPIDocs",{enumerable:!0,get:function(){return RedoclyOpenAPIDocs_1.RedoclyOpenAPIDocs}}),Object.defineProperty(exports,"RedoclyOpenAPIDocsStandalone",{enumerable:!0,get:function(){return RedoclyOpenAPIDocs_1.RedoclyOpenAPIDocsStandalone}}),Object.defineProperty(exports,"ThemeProviders",{enumerable:!0,get:function(){return RedoclyOpenAPIDocs_1.ThemeProviders}}),Object.defineProperty(exports,"AppProvider",{enumerable:!0,get:function(){return RedoclyOpenAPIDocs_1.AppProvider}}),Object.defineProperty(exports,"StoreProvider",{enumerable:!0,get:function(){return RedoclyOpenAPIDocs_1.StoreProvider}}),Object.defineProperty(exports,"getMarkdownHeaderId",{enumerable:!0,get:function(){return RedoclyOpenAPIDocs_1.getMarkdownHeaderId}});var JsonPointer_1=require("./utils/JsonPointer");Object.defineProperty(exports,"JsonPointer",{enumerable:!0,get:function(){return JsonPointer_1.JsonPointer}});var openapi_1=require("./utils/openapi");Object.defineProperty(exports,"isOperationName",{enumerable:!0,get:function(){return openapi_1.isOperationName}});var services_1=require("./services");Object.defineProperty(exports,"OpenAPIParser",{enumerable:!0,get:function(){return services_1.OpenAPIParser}});var services_2=require("./services");function useOpenapiDocsOptions(){return(0,jotai_1.useAtomValue)(store_1.globalOptionsAtom)}Object.defineProperty(exports,"buildContentItems",{enumerable:!0,get:function(){return services_2.buildContentItems}}),Object.defineProperty(exports,"normalizeOptions",{enumerable:!0,get:function(){return services_2.normalizeOptions}}),exports.useOpenapiDocsOptions=useOpenapiDocsOptions;
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.normalizeOptions=void 0;const theme_1=require("@redocly/theme"),constants_1=require("../../constants"),types_1=require("./types"),utils_1=require("../../utils"),helpers_1=require("./helpers"),types_2=require("../types");function normalizeOptions(e,a){var o,l,n,i,s,t,r,u,d,g,p,h;e=Object.assign(Object.assign(Object.assign({},a),e),{
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.normalizeOptions=void 0;const theme_1=require("@redocly/theme"),constants_1=require("../../constants"),types_1=require("./types"),utils_1=require("../../utils"),helpers_1=require("./helpers"),types_2=require("../types");function normalizeOptions(e,a){var o,l,n,i,s,t,r,u,d,g,p,h;e=Object.assign(Object.assign(Object.assign({},a),e),{markdocOptions:Object.assign(Object.assign({},null==e?void 0:e.markdocOptions),{components:Object.assign(Object.assign({},null===(o=null==a?void 0:a.markdocOptions)||void 0===o?void 0:o.components),null===(l=null==e?void 0:e.markdocOptions)||void 0===l?void 0:l.components),tags:Object.assign(Object.assign({},null===(n=null==a?void 0:a.markdocOptions)||void 0===n?void 0:n.tags),null===(i=null==e?void 0:e.markdocOptions)||void 0===i?void 0:i.tags),nodes:Object.assign(Object.assign(Object.assign({},null===(s=null==a?void 0:a.markdocOptions)||void 0===s?void 0:s.nodes),null===(t=null==e?void 0:e.markdocOptions)||void 0===t?void 0:t.nodes),{heading:(null===(u=null===(r=null==a?void 0:a.markdocOptions)||void 0===r?void 0:r.nodes)||void 0===u?void 0:u.heading)||(null===(d=null==e?void 0:e.markdocOptions)||void 0===d?void 0:d.nodes.heading)})})});const c=Array.isArray(e.ignoreNamedSchemas)?e.ignoreNamedSchemas:null===(g=e.ignoreNamedSchemas)||void 0===g?void 0:g.split(",").map((e=>e.trim())),m={downloadDefinitionUrl:e.downloadDefinitionUrl,schemaDefinitionsTagName:e.schemaDefinitionsTagName,corsProxyUrl:(0,helpers_1.addTrailingSlash)(e.corsProxyUrl),authCorsProxyUrl:(0,helpers_1.addTrailingSlash)(e.authCorsProxyUrl),ctrlFHijack:(0,utils_1.argValueToBoolean)(e.ctrlFHijack,!0),disableDeepLinks:(0,utils_1.argValueToBoolean)(e.disableDeepLinks,!1),disableTryItRequestUrlEncoding:(0,utils_1.argValueToBoolean)(e.disableTryItRequestUrlEncoding,!1),minCharacterLengthToInitSearch:(0,utils_1.argValueToNumber)(e.minCharacterLengthToInitSearch,3),disableSearch:(0,utils_1.argValueToBoolean)(e.disableSearch,!1),disableSidebar:(0,utils_1.argValueToBoolean)(e.disableSidebar,!1),expandResponses:(0,helpers_1.normalizeExpandResponses)(e.expandResponses),jsonSampleExpandLevel:(0,utils_1.argValueToExpandLevel)(e.jsonSampleExpandLevel,2),expandDefaultServerVariables:(0,utils_1.argValueToBoolean)(e.expandDefaultServerVariables,!1),expandDefaultRequest:(0,utils_1.argValueToBoolean)(e.expandDefaultRequest,!0),expandDefaultResponse:(0,utils_1.argValueToBoolean)(e.expandDefaultResponse,!0),expandSingleSchemaField:(0,utils_1.argValueToBoolean)(e.expandSingleSchemaField,!1),generatedPayloadSamplesMaxDepth:(0,utils_1.argValueToInt)(e.generatedPayloadSamplesMaxDepth,8),hideDownloadButton:(0,utils_1.argValueToBoolean)(e.hideDownloadButton),hideInfoDescription:(0,utils_1.argValueToBoolean)(e.hideInfoDescription),hideHostname:(0,utils_1.argValueToBoolean)(e.hideHostname,!1),hideInfoSection:(0,utils_1.argValueToBoolean)(e.hideInfoSection,!1),hideLoading:(0,utils_1.argValueToBoolean)(e.hideLoading,!1),hideLogo:(0,utils_1.argValueToBoolean)(e.hideLogo,!1),hideFab:(0,utils_1.argValueToBoolean)(e.hideFab,!1),hideRequestPayloadSample:(0,utils_1.argValueToBoolean)(e.hideRequestPayloadSample,!1),hideRightPanel:(0,utils_1.argValueToBoolean)(e.hideRightPanel,!1),hideSchemaPattern:(0,utils_1.argValueToBoolean)(e.hideSchemaPattern,!1),hideOneOfDescription:(0,utils_1.argValueToBoolean)(e.hideOneOfDescription,!1),hideSchemaTitles:(0,utils_1.argValueToBoolean)(e.hideSchemaTitles,!1),hideSingleRequestSampleTab:(0,utils_1.argValueToBoolean)(e.hideSingleRequestSampleTab,!1),hideTryItPanel:(0,utils_1.argValueToBoolean)(e.hideTryItPanel,!1),showObjectSchemaExamples:(0,utils_1.argValueToBoolean)(e.showObjectSchemaExamples,!1),showAccessMode:(0,utils_1.argValueToBoolean)(e.showAccessMode,!1),maxDisplayedEnumValues:(0,utils_1.argValueToNumber)(e.maxDisplayedEnumValues),maxResponseHeadersToShowInTryIt:(0,utils_1.argValueToNumber)(e.maxResponseHeadersToShowInTryIt,0),menuToggle:(0,utils_1.argValueToBoolean)(e.menuToggle,!0),mockServer:(null===(p=e.mockServer)||void 0===p?void 0:p.url)?{url:e.mockServer.url,position:e.mockServer.position||"first",description:e.mockServer.description||"Mock server"}:void 0,nativeScrollbars:(0,utils_1.argValueToBoolean)(e.nativeScrollbars,!1),oAuth2RedirectURI:e.oAuth2RedirectURI||null,onlyRequiredInSamples:(0,utils_1.argValueToBoolean)(e.onlyRequiredInSamples,!1),pathInMiddlePanel:(0,utils_1.argValueToBoolean)(e.pathInMiddlePanel,!1),onDeepLinkClick:e.onDeepLinkClick||(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.ON_DEEP_LINK_CLICK),requestInterceptor:e.requestInterceptor||(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.REQUEST_INTERCEPTOR),routingBasePath:(0,utils_1.isUndefined)(e.enableRouter)?"":e.routingBasePath&&(0,utils_1.normalizePath)(e.routingBasePath)||"",schemaExpansionLevel:(0,utils_1.argValueToExpandLevel)(e.schemaExpansionLevel),pagination:e.pagination||types_2.Pagination.None,feedback:e.feedback||{hide:!1},payloadSampleIdx:(0,helpers_1.normalizePayloadSampleIdx)(e.payloadSampleIdx,0),requiredPropsFirst:(0,utils_1.argValueToBoolean)(e.requiredPropsFirst,!1),markdownHeadingsAnchorLevel:(0,utils_1.argValueToNumber)(e.markdownHeadingsAnchorLevel,2),samplesTabsMaxCount:(0,utils_1.argValueToInt)(e.samplesTabsMaxCount,5),scrollYOffset:(0,helpers_1.normalizeScrollYOffset)(e.scrollYOffset),searchAutoExpand:(0,utils_1.argValueToBoolean)(e.searchAutoExpand,!0),searchFieldLevelBoost:(0,utils_1.argValueToNumber)(e.searchFieldLevelBoost,.95),searchMaxDepth:(0,utils_1.argValueToNumber)(e.searchMaxDepth,constants_1.DEFAULT_SEARCH_MAX_DEPTH),searchOperationTitleBoost:(0,utils_1.argValueToNumber)(e.searchOperationTitleBoost,4),searchTagTitleBoost:(0,utils_1.argValueToNumber)(e.searchTagTitleBoost,8),sendXUserAgentInTryIt:(0,utils_1.argValueToBoolean)(e.sendXUserAgentInTryIt,!1),showWebhookVerb:(0,utils_1.argValueToBoolean)(e.showWebhookVerb,!1),showChangeLayoutButton:(0,utils_1.argValueToBoolean)(e.showChangeLayoutButton,!0),showConsole:null!=e.hideTryItPanel?!e.hideTryItPanel:null===(h=e.showConsole)||void 0===h||h,showExtensions:(0,helpers_1.normalizeShowExtensions)(e.showExtensions),preserveOriginalExtensionsName:(0,utils_1.argValueToBoolean)(e.preserveOriginalExtensionsName,!1),showNextButton:(0,utils_1.argValueToBoolean)(e.showNextButton,!0),showRightPanelToggle:(0,utils_1.argValueToBoolean)(e.showRightPanelToggle,!0),showSecuritySchemeType:(0,utils_1.argValueToBoolean)(e.showSecuritySchemeType,!0),hideSecuritySection:(0,utils_1.argValueToBoolean)(e.hideSecuritySection,!1),simpleOneOfTypeLabel:(0,utils_1.argValueToBoolean)(e.simpleOneOfTypeLabel,!1),sortEnumValuesAlphabetically:(0,utils_1.argValueToBoolean)(e.sortEnumValuesAlphabetically),sortOperationsAlphabetically:(0,utils_1.argValueToBoolean)(e.sortOperationsAlphabetically),sortPropsAlphabetically:(0,utils_1.argValueToBoolean)(e.sortPropsAlphabetically,!1),sortTagsAlphabetically:(0,utils_1.argValueToBoolean)(e.sortTagsAlphabetically,!1),unstable_ignoreMimeParameters:(0,utils_1.argValueToBoolean)(e.unstable_ignoreMimeParameters,!1),untrustedDefinition:(0,utils_1.argValueToBoolean)(e.untrustedDefinition,!1),enumSkipQuotes:(0,utils_1.argValueToBoolean)(e.enumSkipQuotes),whiteLabel:(0,utils_1.argValueToBoolean)(e.whiteLabel),skipBundleAndConvert:(0,utils_1.argValueToBoolean)(e.skipBundleAndConvert),disablePaginationLoadingAnimation:(0,utils_1.argValueToBoolean)(!!e.disablePaginationLoadingAnimation),disableErrorBoundary:(0,utils_1.argValueToBoolean)(e.disableErrorBoundary),ignoreNamedSchemas:new Set(c),mediaQueries:(0,theme_1.generateMediaQueries)((null==e?void 0:e.breakpoints)||{}),showAtBreakpoint:e.showAtBreakpoint,markdocOptions:null==e?void 0:e.markdocOptions,defaultSampleLanguage:e.defaultSampleLanguage||"",generateCodeSamples:e.generateCodeSamples||{languages:[]},layout:e.layout||theme_1.LayoutVariant.THREE_PANEL,sideNavStyle:e.sideNavStyle||types_2.SideNavStyle.SummaryOnly,searchMode:e.searchMode||types_1.SearchMode.Default,sidebarLinks:e.sidebarLinks||{},events:e.events||{},hooks:e.hooks||(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.HOOKS)||{},unstable_tryItButtonOverride:e.unstable_tryItButtonOverride||null,unstable_externalCodeSamples:e.unstable_externalCodeSamples||[],markdownItemsPagination:e.markdownItemsPagination||"none",infoLabel:null==e?void 0:e.infoLabel,showMetadata:(0,utils_1.argValueToBoolean)(null==e?void 0:e.showMetadata,!1)};return null!=e.showConsole&&console.warn('"showConsole" option is deprecated. Please, use "hideTryItPanel" instead.'),m.disablePaginationLoadingAnimation=!!e.disablePaginationLoadingAnimation||m.pagination===types_2.Pagination.None,m}exports.normalizeOptions=normalizeOptions;
|
|
2
2
|
//# sourceMappingURL=normalizeOptions.js.map
|
|
@@ -121,7 +121,7 @@ export interface RawOptions {
|
|
|
121
121
|
mediaQueries?: MediaQueries;
|
|
122
122
|
ignoreNamedSchemas?: string[] | string;
|
|
123
123
|
breakpoints?: Omit<MediaQueries, 'print'>;
|
|
124
|
-
|
|
124
|
+
markdocOptions?: {
|
|
125
125
|
tags: Record<string, Schema>;
|
|
126
126
|
nodes: Record<string, Schema>;
|
|
127
127
|
components: Record<string, React.ComponentType>;
|
|
@@ -142,7 +142,7 @@ export interface DefaultOptions {
|
|
|
142
142
|
sidebar?: keyof Omit<MediaQueries, 'print'>;
|
|
143
143
|
samplesPanel?: keyof Omit<MediaQueries, 'print'>;
|
|
144
144
|
};
|
|
145
|
-
|
|
145
|
+
markdocOptions?: {
|
|
146
146
|
tags: Record<string, Schema>;
|
|
147
147
|
nodes: Record<string, Schema>;
|
|
148
148
|
components: Record<string, React.ComponentType>;
|
|
@@ -206,7 +206,7 @@ export interface Options {
|
|
|
206
206
|
position: 'first' | 'last' | 'replace' | 'off';
|
|
207
207
|
description: string;
|
|
208
208
|
};
|
|
209
|
-
|
|
209
|
+
markdocOptions?: {
|
|
210
210
|
tags: Record<string, Schema>;
|
|
211
211
|
nodes: Record<string, Schema>;
|
|
212
212
|
components: Record<string, React.ComponentType>;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.buildContentItems=exports.buildMenuStructure=void 0;const tags_1=require("./tags"),markdown_1=require("./markdown"),utils_1=require("../../utils"),history_1=require("../history");function buildMenuStructure(e,t){var i,n;const{definition:
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.buildContentItems=exports.buildMenuStructure=void 0;const tags_1=require("./tags"),markdown_1=require("./markdown"),utils_1=require("../../utils"),history_1=require("../history");function buildMenuStructure(e,t){var i,n,o;const{definition:r}=e,{hideInfoSection:s,hideInfoDescription:u,pagination:d,schemaDefinitionsTagName:a,markdownHeadingsAnchorLevel:l,infoLabel:m}=t,f=s&&"none"!==d?[]:[{id:"",name:(null===(n=null===(i=null==r?void 0:r.info)||void 0===i?void 0:i["x-seo"])||void 0===n?void 0:n.title)||m||(null===(o=null==r?void 0:r.info)||void 0===o?void 0:o.title)||"Overview",href:"/",depth:s?-1:1,level:1,type:"section",infoDefinition:r.info,items:[]}],h=[...r.tags||[]];!h.find((e=>(null==e?void 0:e.name)===a))&&a&&h.push({name:a});const p=(0,tags_1.getTagsWithOperations)(e,h),v=r["x-tagGroups"];return s||u||f.push(...(0,markdown_1.addMarkdownItems)((0,utils_1.getValueFromMdParsedExtension)(r.info,"description")||"",void 0,1,l,d)),v&&v.length>0?f.push(...(0,tags_1.getTagGroupsItems)(e,void 0,v,p,t)):f.push(...(0,tags_1.getTagsItems)(e,p,void 0,void 0,t)),f}function addVersionToHref(e,t){return e.map((e=>(e.href&&(e.href=(0,utils_1.normalizePath)((0,history_1.joinWithSeparator)(t,e.href,"/"))),e.id&&"tag"===e.type&&(e.id=(0,utils_1.normalizePath)((0,history_1.joinWithSeparator)(t,e.id,"/"))),e.items&&addVersionToHref(e.items,t),e)))}function buildContentItems(e,t){const i=buildMenuStructure(e,t),n=e.versionPath?addVersionToHref(i,e.versionPath):i;return{contentItems:n,flatItems:(0,utils_1.flattenByProp)(n||[],"items")}}exports.buildMenuStructure=buildMenuStructure,exports.buildContentItems=buildContentItems;
|
|
2
2
|
//# sourceMappingURL=builder.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.addMarkdownItems=void 0;const markdoc_1=require("@markdoc/markdoc"),types_1=require("../types"),models_1=require("../../models"),utils_1=require("../../utils");function addMarkdownItems(e,t,i,n=2,o=types_1.Pagination.Section){const r=(0,utils_1.isString)(e)?(0,markdoc_1.parse)(e):markdoc_1.Ast.fromJSON(null==e?void 0:e.result),s=[];let d;const l=(e,t,i=s,n,o)=>{let r;e=(0,utils_1.unescapeHTMLChars)(e),n.attributes.id?r=n.attributes.id:(r=o?`${o}/${(0,utils_1.safeSlugify)(e)}`:`section/${(0,utils_1.safeSlugify)(e)}`,n.attributes.id=r);const d={id:r,name:e,level:t,items:[],ast:[n]};return i.push(d),d},a=(e,t)=>{var i,n;null===(n=null===(i=e[e.length-1])||void 0===i?void 0:i.ast)||void 0===n||n.push(t)},u=e=>{var t;for(const i of e.children){const e=getMarkdownContent(i)||"";"heading"===i.type&&1===i.attributes.level?d=l(e,i.attributes.level,void 0,i):i.attributes.level<=n?l(e,i.attributes.level,null==d?void 0:d.items,i,null==d?void 0:d.id):(null===(t=null==d?void 0:d.items)||void 0===t?void 0:t.length)?a(null==d?void 0:d.items,i):(null==s?void 0:s.length)&&a(s,i)}};if(Array.isArray(r))for(const e of r)u(e);else u(r);return mapHeadingsDeep(t,s,i,{pagination:o,markdownHeadingsAnchorLevel:n})}function mapHeadingsDeep(e,t,i=1,n){return t.map((t=>{const o=(0,models_1.getTagOrGroup)("section",t,n,e);return o.depth=i,t.items&&(o.items=mapHeadingsDeep(o,t.items,i+1,n)),o}))}function getMarkdownContent(e){var t,i;return"string"==typeof(null===(t=null==e?void 0:e.attributes)||void 0===t?void 0:t.content)?null===(i=e.attributes)||void 0===i?void 0:i.content:(null==e?void 0:e.children)?getMarkdownContent(e.children[0]):void 0}exports.addMarkdownItems=addMarkdownItems;
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.addMarkdownItems=void 0;const markdoc_1=require("@markdoc/markdoc"),types_1=require("../types"),models_1=require("../../models"),utils_1=require("../../utils");function addMarkdownItems(e,t,i,n=2,o=types_1.Pagination.Section){const r=(0,utils_1.isString)(e)?(0,markdoc_1.parse)(e):markdoc_1.Ast.fromJSON(JSON.stringify(null==e?void 0:e.result)),s=[];let d;const l=(e,t,i=s,n,o)=>{let r;e=(0,utils_1.unescapeHTMLChars)(e),n.attributes.id?r=n.attributes.id:(r=o?`${o}/${(0,utils_1.safeSlugify)(e)}`:`section/${(0,utils_1.safeSlugify)(e)}`,n.attributes.id=r);const d={id:r,name:e,level:t,items:[],ast:[n]};return i.push(d),d},a=(e,t)=>{var i,n;null===(n=null===(i=e[e.length-1])||void 0===i?void 0:i.ast)||void 0===n||n.push(t)},u=e=>{var t;for(const i of e.children){const e=getMarkdownContent(i)||"";"heading"===i.type&&1===i.attributes.level?d=l(e,i.attributes.level,void 0,i):i.attributes.level<=n?l(e,i.attributes.level,null==d?void 0:d.items,i,null==d?void 0:d.id):(null===(t=null==d?void 0:d.items)||void 0===t?void 0:t.length)?a(null==d?void 0:d.items,i):(null==s?void 0:s.length)&&a(s,i)}};if(Array.isArray(r))for(const e of r)u(e);else u(r);return mapHeadingsDeep(t,s,i,{pagination:o,markdownHeadingsAnchorLevel:n})}function mapHeadingsDeep(e,t,i=1,n){return t.map((t=>{const o=(0,models_1.getTagOrGroup)("section",t,n,e);return o.depth=i,t.items&&(o.items=mapHeadingsDeep(o,t.items,i+1,n)),o}))}function getMarkdownContent(e){var t,i;return"string"==typeof(null===(t=null==e?void 0:e.attributes)||void 0===t?void 0:t.content)?null===(i=e.attributes)||void 0===i?void 0:i.content:(null==e?void 0:e.children)?getMarkdownContent(e.children[0]):void 0}exports.addMarkdownItems=addMarkdownItems;
|
|
2
2
|
//# sourceMappingURL=markdown.js.map
|
package/lib/types/open-api.d.ts
CHANGED
|
@@ -27,7 +27,7 @@ export interface OpenAPIInfo extends ParsedDescriptionWithSummary {
|
|
|
27
27
|
license?: OpenAPILicense;
|
|
28
28
|
'x-logo'?: XLogo;
|
|
29
29
|
'x-metadata'?: XMetadata;
|
|
30
|
-
'x-
|
|
30
|
+
'x-seo'?: XSEO;
|
|
31
31
|
}
|
|
32
32
|
export interface XLogo {
|
|
33
33
|
url?: string;
|
|
@@ -39,6 +39,9 @@ export interface XMetadata {
|
|
|
39
39
|
apiId?: string;
|
|
40
40
|
[key: string]: unknown;
|
|
41
41
|
}
|
|
42
|
+
export interface XSEO {
|
|
43
|
+
title?: string;
|
|
44
|
+
}
|
|
42
45
|
export interface OpenAPIServer extends ParsedDescription {
|
|
43
46
|
url: string;
|
|
44
47
|
description?: string;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.saveTextBeforeHeading=void 0;const markdoc_1=require("@markdoc/markdoc"),typeGuards_1=require("./typeGuards"),utils_1=require("../services/utils");function saveTextBeforeHeading(e,r){if(!(0,typeGuards_1.isString)(e)&&(null==e?void 0:e.result)){const i=(0,utils_1.deepClone)(e),t=markdoc_1.Ast.fromJSON(null==i?void 0:i.result);if(Array.isArray(t))for(const e of t)modifyNodeByHeading(e,r);else modifyNodeByHeading(t,r);return i.result=JSON.stringify(t),i.raw=saveTextBeforeHeading(i.raw,r),i}const i=new RegExp(`^#{1,${r}}?\\s+`,"m"),t=e.search(i);return t>-1?e.substring(0,t):e}function modifyNodeByHeading(e,r){const i=e.children.findIndex((e=>"heading"===e.type&&e.attributes.level<=r));return-1===i||(e.children=e.children.slice(0,i)),e}exports.saveTextBeforeHeading=saveTextBeforeHeading;
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.saveTextBeforeHeading=void 0;const markdoc_1=require("@markdoc/markdoc"),typeGuards_1=require("./typeGuards"),utils_1=require("../services/utils");function saveTextBeforeHeading(e,r){if(!(0,typeGuards_1.isString)(e)&&(null==e?void 0:e.result)){const i=(0,utils_1.deepClone)(e),t=markdoc_1.Ast.fromJSON(JSON.stringify(null==i?void 0:i.result));if(Array.isArray(t))for(const e of t)modifyNodeByHeading(e,r);else modifyNodeByHeading(t,r);return i.result=JSON.stringify(t),i.raw=saveTextBeforeHeading(i.raw,r),i}const i=new RegExp(`^#{1,${r}}?\\s+`,"m"),t=e.search(i);return t>-1?e.substring(0,t):e}function modifyNodeByHeading(e,r){const i=e.children.findIndex((e=>"heading"===e.type&&e.attributes.level<=r));return-1===i||(e.children=e.children.slice(0,i)),e}exports.saveTextBeforeHeading=saveTextBeforeHeading;
|
|
2
2
|
//# sourceMappingURL=saveTextBeforeHeading.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
var __rest=this&&this.__rest||function(
|
|
1
|
+
var __rest=this&&this.__rest||function(r,t){var o={};for(var e in r)Object.prototype.hasOwnProperty.call(r,e)&&t.indexOf(e)<0&&(o[e]=r[e]);if(null!=r&&"function"==typeof Object.getOwnPropertySymbols){var i=0;for(e=Object.getOwnPropertySymbols(r);i<e.length;i++)t.indexOf(e[i])<0&&Object.prototype.propertyIsEnumerable.call(r,e[i])&&(o[e[i]]=r[e[i]])}return o};import React,{Fragment}from"react";import{parse,transform,renderers,Ast}from"@markdoc/markdoc";import{useAtomValue}from"jotai";import DOMPurify from"dompurify";import{MarkdownWrapper}from"@redocly/theme";import{globalOptionsAtom}from"../../jotai/store";import{isString}from"../../utils";export const Markdown=r=>{var t,o,e,i,n,a,s,l,d,{source:m,ast:c,htmlWrap:u}=r,p=__rest(r,["source","ast","htmlWrap"]);const v=useAtomValue(globalOptionsAtom);if(!m&&!c)return null;const f=(null==v?void 0:v.markdocOptions)&&{tags:null===(t=v.markdocOptions)||void 0===t?void 0:t.tags,nodes:null===(o=v.markdocOptions)||void 0===o?void 0:o.nodes,partials:null===(e=v.markdocOptions)||void 0===e?void 0:e.partials,variables:null===(i=v.markdocOptions)||void 0===i?void 0:i.variables,functions:null===(n=v.markdocOptions)||void 0===n?void 0:n.functions},O=(null==v?void 0:v.markdocOptions)&&{components:null===(a=v.markdocOptions)||void 0===a?void 0:a.components};let y;if(m)if(isString(m)){const r=(null===(s=null==v?void 0:v.hooks)||void 0===s?void 0:s.sanitize)?null===(d=null===(l=v.hooks)||void 0===l?void 0:l.sanitize)||void 0===d?void 0:d.call(l,m):(null==v?void 0:v.untrustedDefinition)?DOMPurify.sanitize(m):m,t=parse(r);y=transform(t,f)}else{const r=Ast.fromJSON("object"==typeof m.result?JSON.stringify(m.result):m.result);y=(Array.isArray(r),transform(r,f))}else c&&(y=transform(c,f));const k=r=>{const t=renderers.react(r,React,O);return React.createElement(MarkdownWrapper,Object.assign({},p,{children:t,as:"div"}))};if(!u)return k(y);return y=Array.isArray(y)?y:y.children,React.createElement(React.Fragment,null," ",y.map(((r,t)=>{var o,e,i,n;return React.createElement(Fragment,{key:(null===(o=null==r?void 0:r.attributes)||void 0===o?void 0:o.id)||t},(n=null==r?void 0:r.attributes,e=!1!==(null==n?void 0:n.htmlWrap),i=r,e?u(k(i)):k(i)))})))};
|
|
2
2
|
//# sourceMappingURL=Markdown.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
var __awaiter=this&&this.__awaiter||function(e,t,o,i){return new(o||(o=Promise))((function(n,r){function a(e){try{l(i.next(e))}catch(e){r(e)}}function s(e){try{l(i.throw(e))}catch(e){r(e)}}function l(e){var t;e.done?n(e.value):(t=e.value,t instanceof o?t:new o((function(e){e(t)}))).then(a,s)}l((i=i.apply(e,t||[])).next())}))};import{ThemeProvider}from"styled-components";import React,{memo,useEffect,useMemo,useState}from"react";import{Tag}from"@markdoc/markdoc";import{Heading}from"@redocly/theme";import{createStore,Provider}from"jotai";import{normalizeOptions,OpenAPIParser}from"../../services";import{getMarkdownHeaderId,loadMany,loadSingle,useDeepCompareMemoize}from"./utils";import{argValueToBoolean,fromLocalStorage,fromSessionStorage}from"../../utils";import{Loading}from"../Loading";import{defaultTheme}from"../../constants";import{SecurityDefs}from"../SecurityRequirement";import{SchemaDefinition}from"../SchemaDefinition";import{PullRight,RedocResponse}from"../pluggable";import{appLocalStore,appSessionStore,appStore}from"../../jotai/app";import{globalStore}from"../../jotai/store";import{operationStore}from"../../jotai/operation";import JotaiNexus from"../../jotai/nexus";export const ThemeProviders=({options:e,children:t,customOptions:o={}})=>{const i=Object.assign(Object.assign({},e),o),n=useMemo((()=>({mediaQueries:i.mediaQueries,showAtBreakpoint:i.showAtBreakpoint})),[i.mediaQueries,i.showAtBreakpoint]);return React.createElement(ThemeProvider,{theme:n},t)};export const AppProvider=({definitions:e,options:t,definitionUrl:o,definition:i,activeSampleLanguage:n,children:r})=>{const[,a]=useState(),[s,l]=useState(!0),[p
|
|
1
|
+
var __awaiter=this&&this.__awaiter||function(e,t,o,i){return new(o||(o=Promise))((function(n,r){function a(e){try{l(i.next(e))}catch(e){r(e)}}function s(e){try{l(i.throw(e))}catch(e){r(e)}}function l(e){var t;e.done?n(e.value):(t=e.value,t instanceof o?t:new o((function(e){e(t)}))).then(a,s)}l((i=i.apply(e,t||[])).next())}))};import{ThemeProvider}from"styled-components";import React,{memo,useEffect,useMemo,useState}from"react";import{Tag}from"@markdoc/markdoc";import{Heading}from"@redocly/theme";import{createStore,Provider}from"jotai";import{normalizeOptions,OpenAPIParser}from"../../services";import{getMarkdownHeaderId,loadMany,loadSingle,useDeepCompareMemoize}from"./utils";import{argValueToBoolean,fromLocalStorage,fromSessionStorage}from"../../utils";import{Loading}from"../Loading";import{defaultTheme}from"../../constants";import{SecurityDefs}from"../SecurityRequirement";import{SchemaDefinition}from"../SchemaDefinition";import{PullRight,RedocResponse}from"../pluggable";import{appLocalStore,appSessionStore,appStore}from"../../jotai/app";import{globalStore}from"../../jotai/store";import{operationStore}from"../../jotai/operation";import JotaiNexus from"../../jotai/nexus";export const ThemeProviders=({options:e,children:t,customOptions:o={}})=>{const i=Object.assign(Object.assign({},e),o),n=useMemo((()=>({mediaQueries:i.mediaQueries,showAtBreakpoint:i.showAtBreakpoint})),[i.mediaQueries,i.showAtBreakpoint]);return React.createElement(ThemeProvider,{theme:n},t)};export const AppProvider=({definitions:e,options:t,definitionUrl:o,definition:i,activeSampleLanguage:n,children:r})=>{const[,a]=useState(),[s,l]=useState(!0),[c,p]=useState(null);useEffect((()=>{!function(){__awaiter(this,void 0,void 0,(function*(){l(!0);try{p(e?yield loadMany(e):yield loadSingle(i,o,t))}catch(e){a((()=>{throw e}))}}))}()}),[e,i,o,t]);const m=useMemo((()=>{var e,i,r;if(c)return(null===(e=null==t?void 0:t.hooks)||void 0===e?void 0:e.onInit)&&(null===(r=null===(i=t.hooks)||void 0===i?void 0:i.onInit)||void 0===r||r.call(i,{store:{definition:c,options:t,definitionUrl:o,activeSampleLanguage:n}})),{definition:c,options:t,definitionUrl:o,activeSampleLanguage:n}}),useDeepCompareMemoize([c,t,o]));return useEffect((()=>{m&&l(!1)}),[m]),m?s?argValueToBoolean(null==t?void 0:t.hideLoading,!1)?null:React.createElement(Loading,{color:"--loading-spinner-color"}):React.isValidElement(r)?React.cloneElement(r,{store:m}):null:null};const DEFAULT_OPTIONS={ignoreNamedSchemas:["java.io.ObjectStreamField"],breakpoints:defaultTheme.breakpoints,showAtBreakpoint:defaultTheme.showAtBreakpoint,markdocOptions:{tags:{securityDefinitions:{render:"SecurityDefinitions"},pullRight:{render:"PullRight",attributes:{htmlWrap:{type:String,default:!1}}},schemaDefinition:{render:"SchemaDefinition",attributes:{schemaRef:{type:String},exampleRef:{type:String},showReadOnly:{type:Boolean},showWriteOnly:{type:Boolean},htmlWrap:{type:String,default:!1}}}},nodes:{heading:{children:["inline"],attributes:{id:{type:String},level:{type:Number,required:!0,default:1}},transform(e,t){const o=e.transformAttributes(t),i=e.transformChildren(t),n="string"==typeof o.id?o.id:getMarkdownHeaderId(i);return new Tag("Heading",Object.assign(Object.assign({},o),{id:n,level:e.attributes.level}),i)}}},components:{SecurityDefinitions:SecurityDefs,SchemaDefinition:SchemaDefinition,RedocResponse:RedocResponse,PullRight:PullRight,Heading:Heading}}};export const StoreProvider=memo((({children:e,options:t,definitionUrl:o,definition:i,activeSampleLanguage:n,portalOptions:r})=>{const a=React.useRef(),s=React.useCallback((()=>{var e;const n=normalizeOptions(Object.assign({},t),DEFAULT_OPTIONS),r=isVersioned(i)?(null===(e=i.versions)||void 0===e?void 0:e.map((({spec:e,id:t,title:o,url:i},r)=>{if(e){const a=t||`Definition_${r}`;return{id:a,title:o||`Definition_${r}`,url:i,parser:new OpenAPIParser(e,void 0,Object.assign(Object.assign({},n),{versionId:a}))}}})).filter(Boolean))||[]:[{url:o,parser:new OpenAPIParser(i,o,n)}];return{options:n,versions:r}}),[i,o,t]),l=useMemo((()=>{const e=createStore();a.current=e.set;const t=s(),o=t.options,i=JSON.parse(fromLocalStorage("appLocalStore")||"{}"),l=JSON.parse(fromSessionStorage("appSessionStore")||"{}");if(e.set(appSessionStore,(e=>Object.assign(Object.assign({},e),{showRightPanelToggle:l.showRightPanelToggle||o.showRightPanelToggle,activeVersionIdx:0}))),e.set(appLocalStore,(e=>Object.assign(Object.assign({},e),{layout:i.layout||o.layout,activeSampleLanguage:n||i.activeSampleLanguage||o.defaultSampleLanguage}))),e.set(globalStore,(e=>Object.assign(Object.assign({},e),t))),e.set(appStore,{isSidebarOpened:!1,activeMimeName:(null==r?void 0:r.defaultMimeType)||"",menuNextLinks:[]}),null==r?void 0:r.operation){const{pointer:t,activeExampleName:o,activeServer:i}=r.operation;e.set(operationStore(t),(e=>Object.assign(Object.assign({},e),{activeExampleName:o,activeOneOf:{},activeServer:i,requestValues:{}})))}return e}),[n,s,null==r?void 0:r.defaultMimeType,null==r?void 0:r.operation]);return useEffect((()=>{a.current&&setTimeout((()=>{a.current(globalStore,s())}),0)}),[s,i]),React.createElement(Provider,{store:l,key:(null==r?void 0:r.definitionId)||"openapi"},React.createElement(JotaiNexus,null),e)}));const isVersioned=e=>"versions"in e;
|
|
2
2
|
//# sourceMappingURL=Providers.js.map
|
package/lib-esm/index.d.ts
CHANGED
|
@@ -13,3 +13,4 @@ export { JsonPointer } from './utils/JsonPointer';
|
|
|
13
13
|
export { isOperationName } from './utils/openapi';
|
|
14
14
|
export { OpenAPIParser } from './services';
|
|
15
15
|
export { buildContentItems, normalizeOptions } from './services';
|
|
16
|
+
export declare function useOpenapiDocsOptions(): import("./services").Options;
|
package/lib-esm/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export{getOperation}from"./models/operation";export{Console}from"./components/rightPanel/Console";export{RequestSamples}from"./components/RequestSamples";export{PullRight,RedocResponse,RedocSchema,RedocExample,RedocRequestBody}from"./components/pluggable";export{RedoclyOpenAPIDocs,RedoclyOpenAPIDocsStandalone,ThemeProviders,AppProvider,StoreProvider,getMarkdownHeaderId}from"./components/RedoclyOpenAPIDocs";export{JsonPointer}from"./utils/JsonPointer";export{isOperationName}from"./utils/openapi";export{OpenAPIParser}from"./services";export{buildContentItems,normalizeOptions}from"./services";
|
|
1
|
+
import{useAtomValue}from"jotai";import{globalOptionsAtom}from"./jotai/store";export{getOperation}from"./models/operation";export{Console}from"./components/rightPanel/Console";export{RequestSamples}from"./components/RequestSamples";export{PullRight,RedocResponse,RedocSchema,RedocExample,RedocRequestBody}from"./components/pluggable";export{RedoclyOpenAPIDocs,RedoclyOpenAPIDocsStandalone,ThemeProviders,AppProvider,StoreProvider,getMarkdownHeaderId}from"./components/RedoclyOpenAPIDocs";export{JsonPointer}from"./utils/JsonPointer";export{isOperationName}from"./utils/openapi";export{OpenAPIParser}from"./services";export{buildContentItems,normalizeOptions}from"./services";export function useOpenapiDocsOptions(){return useAtomValue(globalOptionsAtom)}
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{generateMediaQueries,LayoutVariant}from"@redocly/theme";import{DEFAULT_SEARCH_MAX_DEPTH,WindowReferenceOptions}from"../../constants";import{SearchMode}from"./types";import{argValueToBoolean,argValueToExpandLevel,argValueToInt,argValueToNumber,getWindowReferenceOptions,isUndefined,normalizePath}from"../../utils";import{addTrailingSlash,normalizeExpandResponses,normalizePayloadSampleIdx,normalizeShowExtensions,normalizeScrollYOffset}from"./helpers";import{Pagination,SideNavStyle}from"../types";export function normalizeOptions(e,a){var o,n,l,i,r,s,t,d,u,g,p,h;e=Object.assign(Object.assign(Object.assign({},a),e),{
|
|
1
|
+
import{generateMediaQueries,LayoutVariant}from"@redocly/theme";import{DEFAULT_SEARCH_MAX_DEPTH,WindowReferenceOptions}from"../../constants";import{SearchMode}from"./types";import{argValueToBoolean,argValueToExpandLevel,argValueToInt,argValueToNumber,getWindowReferenceOptions,isUndefined,normalizePath}from"../../utils";import{addTrailingSlash,normalizeExpandResponses,normalizePayloadSampleIdx,normalizeShowExtensions,normalizeScrollYOffset}from"./helpers";import{Pagination,SideNavStyle}from"../types";export function normalizeOptions(e,a){var o,n,l,i,r,s,t,d,u,g,p,h;e=Object.assign(Object.assign(Object.assign({},a),e),{markdocOptions:Object.assign(Object.assign({},null==e?void 0:e.markdocOptions),{components:Object.assign(Object.assign({},null===(o=null==a?void 0:a.markdocOptions)||void 0===o?void 0:o.components),null===(n=null==e?void 0:e.markdocOptions)||void 0===n?void 0:n.components),tags:Object.assign(Object.assign({},null===(l=null==a?void 0:a.markdocOptions)||void 0===l?void 0:l.tags),null===(i=null==e?void 0:e.markdocOptions)||void 0===i?void 0:i.tags),nodes:Object.assign(Object.assign(Object.assign({},null===(r=null==a?void 0:a.markdocOptions)||void 0===r?void 0:r.nodes),null===(s=null==e?void 0:e.markdocOptions)||void 0===s?void 0:s.nodes),{heading:(null===(d=null===(t=null==a?void 0:a.markdocOptions)||void 0===t?void 0:t.nodes)||void 0===d?void 0:d.heading)||(null===(u=null==e?void 0:e.markdocOptions)||void 0===u?void 0:u.nodes.heading)})})});const m=Array.isArray(e.ignoreNamedSchemas)?e.ignoreNamedSchemas:null===(g=e.ignoreNamedSchemas)||void 0===g?void 0:g.split(",").map((e=>e.trim())),c={downloadDefinitionUrl:e.downloadDefinitionUrl,schemaDefinitionsTagName:e.schemaDefinitionsTagName,corsProxyUrl:addTrailingSlash(e.corsProxyUrl),authCorsProxyUrl:addTrailingSlash(e.authCorsProxyUrl),ctrlFHijack:argValueToBoolean(e.ctrlFHijack,!0),disableDeepLinks:argValueToBoolean(e.disableDeepLinks,!1),disableTryItRequestUrlEncoding:argValueToBoolean(e.disableTryItRequestUrlEncoding,!1),minCharacterLengthToInitSearch:argValueToNumber(e.minCharacterLengthToInitSearch,3),disableSearch:argValueToBoolean(e.disableSearch,!1),disableSidebar:argValueToBoolean(e.disableSidebar,!1),expandResponses:normalizeExpandResponses(e.expandResponses),jsonSampleExpandLevel:argValueToExpandLevel(e.jsonSampleExpandLevel,2),expandDefaultServerVariables:argValueToBoolean(e.expandDefaultServerVariables,!1),expandDefaultRequest:argValueToBoolean(e.expandDefaultRequest,!0),expandDefaultResponse:argValueToBoolean(e.expandDefaultResponse,!0),expandSingleSchemaField:argValueToBoolean(e.expandSingleSchemaField,!1),generatedPayloadSamplesMaxDepth:argValueToInt(e.generatedPayloadSamplesMaxDepth,8),hideDownloadButton:argValueToBoolean(e.hideDownloadButton),hideInfoDescription:argValueToBoolean(e.hideInfoDescription),hideHostname:argValueToBoolean(e.hideHostname,!1),hideInfoSection:argValueToBoolean(e.hideInfoSection,!1),hideLoading:argValueToBoolean(e.hideLoading,!1),hideLogo:argValueToBoolean(e.hideLogo,!1),hideFab:argValueToBoolean(e.hideFab,!1),hideRequestPayloadSample:argValueToBoolean(e.hideRequestPayloadSample,!1),hideRightPanel:argValueToBoolean(e.hideRightPanel,!1),hideSchemaPattern:argValueToBoolean(e.hideSchemaPattern,!1),hideOneOfDescription:argValueToBoolean(e.hideOneOfDescription,!1),hideSchemaTitles:argValueToBoolean(e.hideSchemaTitles,!1),hideSingleRequestSampleTab:argValueToBoolean(e.hideSingleRequestSampleTab,!1),hideTryItPanel:argValueToBoolean(e.hideTryItPanel,!1),showObjectSchemaExamples:argValueToBoolean(e.showObjectSchemaExamples,!1),showAccessMode:argValueToBoolean(e.showAccessMode,!1),maxDisplayedEnumValues:argValueToNumber(e.maxDisplayedEnumValues),maxResponseHeadersToShowInTryIt:argValueToNumber(e.maxResponseHeadersToShowInTryIt,0),menuToggle:argValueToBoolean(e.menuToggle,!0),mockServer:(null===(p=e.mockServer)||void 0===p?void 0:p.url)?{url:e.mockServer.url,position:e.mockServer.position||"first",description:e.mockServer.description||"Mock server"}:void 0,nativeScrollbars:argValueToBoolean(e.nativeScrollbars,!1),oAuth2RedirectURI:e.oAuth2RedirectURI||null,onlyRequiredInSamples:argValueToBoolean(e.onlyRequiredInSamples,!1),pathInMiddlePanel:argValueToBoolean(e.pathInMiddlePanel,!1),onDeepLinkClick:e.onDeepLinkClick||getWindowReferenceOptions(WindowReferenceOptions.ON_DEEP_LINK_CLICK),requestInterceptor:e.requestInterceptor||getWindowReferenceOptions(WindowReferenceOptions.REQUEST_INTERCEPTOR),routingBasePath:isUndefined(e.enableRouter)?"":e.routingBasePath&&normalizePath(e.routingBasePath)||"",schemaExpansionLevel:argValueToExpandLevel(e.schemaExpansionLevel),pagination:e.pagination||Pagination.None,feedback:e.feedback||{hide:!1},payloadSampleIdx:normalizePayloadSampleIdx(e.payloadSampleIdx,0),requiredPropsFirst:argValueToBoolean(e.requiredPropsFirst,!1),markdownHeadingsAnchorLevel:argValueToNumber(e.markdownHeadingsAnchorLevel,2),samplesTabsMaxCount:argValueToInt(e.samplesTabsMaxCount,5),scrollYOffset:normalizeScrollYOffset(e.scrollYOffset),searchAutoExpand:argValueToBoolean(e.searchAutoExpand,!0),searchFieldLevelBoost:argValueToNumber(e.searchFieldLevelBoost,.95),searchMaxDepth:argValueToNumber(e.searchMaxDepth,DEFAULT_SEARCH_MAX_DEPTH),searchOperationTitleBoost:argValueToNumber(e.searchOperationTitleBoost,4),searchTagTitleBoost:argValueToNumber(e.searchTagTitleBoost,8),sendXUserAgentInTryIt:argValueToBoolean(e.sendXUserAgentInTryIt,!1),showWebhookVerb:argValueToBoolean(e.showWebhookVerb,!1),showChangeLayoutButton:argValueToBoolean(e.showChangeLayoutButton,!0),showConsole:null!=e.hideTryItPanel?!e.hideTryItPanel:null===(h=e.showConsole)||void 0===h||h,showExtensions:normalizeShowExtensions(e.showExtensions),preserveOriginalExtensionsName:argValueToBoolean(e.preserveOriginalExtensionsName,!1),showNextButton:argValueToBoolean(e.showNextButton,!0),showRightPanelToggle:argValueToBoolean(e.showRightPanelToggle,!0),showSecuritySchemeType:argValueToBoolean(e.showSecuritySchemeType,!0),hideSecuritySection:argValueToBoolean(e.hideSecuritySection,!1),simpleOneOfTypeLabel:argValueToBoolean(e.simpleOneOfTypeLabel,!1),sortEnumValuesAlphabetically:argValueToBoolean(e.sortEnumValuesAlphabetically),sortOperationsAlphabetically:argValueToBoolean(e.sortOperationsAlphabetically),sortPropsAlphabetically:argValueToBoolean(e.sortPropsAlphabetically,!1),sortTagsAlphabetically:argValueToBoolean(e.sortTagsAlphabetically,!1),unstable_ignoreMimeParameters:argValueToBoolean(e.unstable_ignoreMimeParameters,!1),untrustedDefinition:argValueToBoolean(e.untrustedDefinition,!1),enumSkipQuotes:argValueToBoolean(e.enumSkipQuotes),whiteLabel:argValueToBoolean(e.whiteLabel),skipBundleAndConvert:argValueToBoolean(e.skipBundleAndConvert),disablePaginationLoadingAnimation:argValueToBoolean(!!e.disablePaginationLoadingAnimation),disableErrorBoundary:argValueToBoolean(e.disableErrorBoundary),ignoreNamedSchemas:new Set(m),mediaQueries:generateMediaQueries((null==e?void 0:e.breakpoints)||{}),showAtBreakpoint:e.showAtBreakpoint,markdocOptions:null==e?void 0:e.markdocOptions,defaultSampleLanguage:e.defaultSampleLanguage||"",generateCodeSamples:e.generateCodeSamples||{languages:[]},layout:e.layout||LayoutVariant.THREE_PANEL,sideNavStyle:e.sideNavStyle||SideNavStyle.SummaryOnly,searchMode:e.searchMode||SearchMode.Default,sidebarLinks:e.sidebarLinks||{},events:e.events||{},hooks:e.hooks||getWindowReferenceOptions(WindowReferenceOptions.HOOKS)||{},unstable_tryItButtonOverride:e.unstable_tryItButtonOverride||null,unstable_externalCodeSamples:e.unstable_externalCodeSamples||[],markdownItemsPagination:e.markdownItemsPagination||"none",infoLabel:null==e?void 0:e.infoLabel,showMetadata:argValueToBoolean(null==e?void 0:e.showMetadata,!1)};return null!=e.showConsole&&console.warn('"showConsole" option is deprecated. Please, use "hideTryItPanel" instead.'),c.disablePaginationLoadingAnimation=!!e.disablePaginationLoadingAnimation||c.pagination===Pagination.None,c}
|
|
2
2
|
//# sourceMappingURL=normalizeOptions.js.map
|
|
@@ -121,7 +121,7 @@ export interface RawOptions {
|
|
|
121
121
|
mediaQueries?: MediaQueries;
|
|
122
122
|
ignoreNamedSchemas?: string[] | string;
|
|
123
123
|
breakpoints?: Omit<MediaQueries, 'print'>;
|
|
124
|
-
|
|
124
|
+
markdocOptions?: {
|
|
125
125
|
tags: Record<string, Schema>;
|
|
126
126
|
nodes: Record<string, Schema>;
|
|
127
127
|
components: Record<string, React.ComponentType>;
|
|
@@ -142,7 +142,7 @@ export interface DefaultOptions {
|
|
|
142
142
|
sidebar?: keyof Omit<MediaQueries, 'print'>;
|
|
143
143
|
samplesPanel?: keyof Omit<MediaQueries, 'print'>;
|
|
144
144
|
};
|
|
145
|
-
|
|
145
|
+
markdocOptions?: {
|
|
146
146
|
tags: Record<string, Schema>;
|
|
147
147
|
nodes: Record<string, Schema>;
|
|
148
148
|
components: Record<string, React.ComponentType>;
|
|
@@ -206,7 +206,7 @@ export interface Options {
|
|
|
206
206
|
position: 'first' | 'last' | 'replace' | 'off';
|
|
207
207
|
description: string;
|
|
208
208
|
};
|
|
209
|
-
|
|
209
|
+
markdocOptions?: {
|
|
210
210
|
tags: Record<string, Schema>;
|
|
211
211
|
nodes: Record<string, Schema>;
|
|
212
212
|
components: Record<string, React.ComponentType>;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{getTagGroupsItems,getTagsItems,getTagsWithOperations}from"./tags";import{addMarkdownItems}from"./markdown";import{flattenByProp,getValueFromMdParsedExtension,normalizePath}from"../../utils";import{joinWithSeparator}from"../history";export function buildMenuStructure(e,t){var i,o;const{definition:
|
|
1
|
+
import{getTagGroupsItems,getTagsItems,getTagsWithOperations}from"./tags";import{addMarkdownItems}from"./markdown";import{flattenByProp,getValueFromMdParsedExtension,normalizePath}from"../../utils";import{joinWithSeparator}from"../history";export function buildMenuStructure(e,t){var i,o,n;const{definition:r}=e,{hideInfoSection:a,hideInfoDescription:s,pagination:d,schemaDefinitionsTagName:m,markdownHeadingsAnchorLevel:l,infoLabel:u}=t,f=a&&"none"!==d?[]:[{id:"",name:(null===(o=null===(i=null==r?void 0:r.info)||void 0===i?void 0:i["x-seo"])||void 0===o?void 0:o.title)||u||(null===(n=null==r?void 0:r.info)||void 0===n?void 0:n.title)||"Overview",href:"/",depth:a?-1:1,level:1,type:"section",infoDefinition:r.info,items:[]}],p=[...r.tags||[]];!p.find((e=>(null==e?void 0:e.name)===m))&&m&&p.push({name:m});const h=getTagsWithOperations(e,p),g=r["x-tagGroups"];return a||s||f.push(...addMarkdownItems(getValueFromMdParsedExtension(r.info,"description")||"",void 0,1,l,d)),g&&g.length>0?f.push(...getTagGroupsItems(e,void 0,g,h,t)):f.push(...getTagsItems(e,h,void 0,void 0,t)),f}function addVersionToHref(e,t){return e.map((e=>(e.href&&(e.href=normalizePath(joinWithSeparator(t,e.href,"/"))),e.id&&"tag"===e.type&&(e.id=normalizePath(joinWithSeparator(t,e.id,"/"))),e.items&&addVersionToHref(e.items,t),e)))}export function buildContentItems(e,t){const i=buildMenuStructure(e,t),o=e.versionPath?addVersionToHref(i,e.versionPath):i;return{contentItems:o,flatItems:flattenByProp(o||[],"items")}}
|
|
2
2
|
//# sourceMappingURL=builder.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{parse,Ast}from"@markdoc/markdoc";import{Pagination}from"../types";import{getTagOrGroup}from"../../models";import{isString,safeSlugify,unescapeHTMLChars}from"../../utils";export function addMarkdownItems(t,e,i,n=2,o=Pagination.Section){const r=isString(t)?parse(t):Ast.fromJSON(null==t?void 0:t.result),s=[];let l;const a=(t,e,i=s,n,o)=>{let r;t=unescapeHTMLChars(t),n.attributes.id?r=n.attributes.id:(r=o?`${o}/${safeSlugify(t)}`:`section/${safeSlugify(t)}`,n.attributes.id=r);const l={id:r,name:t,level:e,items:[],ast:[n]};return i.push(l),l},d=(t,e)=>{var i,n;null===(n=null===(i=t[t.length-1])||void 0===i?void 0:i.ast)||void 0===n||n.push(e)},u=t=>{var e;for(const i of t.children){const t=getMarkdownContent(i)||"";"heading"===i.type&&1===i.attributes.level?l=a(t,i.attributes.level,void 0,i):i.attributes.level<=n?a(t,i.attributes.level,null==l?void 0:l.items,i,null==l?void 0:l.id):(null===(e=null==l?void 0:l.items)||void 0===e?void 0:e.length)?d(null==l?void 0:l.items,i):(null==s?void 0:s.length)&&d(s,i)}};if(Array.isArray(r))for(const t of r)u(t);else u(r);return mapHeadingsDeep(e,s,i,{pagination:o,markdownHeadingsAnchorLevel:n})}function mapHeadingsDeep(t,e,i=1,n){return e.map((e=>{const o=getTagOrGroup("section",e,n,t);return o.depth=i,e.items&&(o.items=mapHeadingsDeep(o,e.items,i+1,n)),o}))}function getMarkdownContent(t){var e,i;return"string"==typeof(null===(e=null==t?void 0:t.attributes)||void 0===e?void 0:e.content)?null===(i=t.attributes)||void 0===i?void 0:i.content:(null==t?void 0:t.children)?getMarkdownContent(t.children[0]):void 0}
|
|
1
|
+
import{parse,Ast}from"@markdoc/markdoc";import{Pagination}from"../types";import{getTagOrGroup}from"../../models";import{isString,safeSlugify,unescapeHTMLChars}from"../../utils";export function addMarkdownItems(t,e,i,n=2,o=Pagination.Section){const r=isString(t)?parse(t):Ast.fromJSON(JSON.stringify(null==t?void 0:t.result)),s=[];let l;const a=(t,e,i=s,n,o)=>{let r;t=unescapeHTMLChars(t),n.attributes.id?r=n.attributes.id:(r=o?`${o}/${safeSlugify(t)}`:`section/${safeSlugify(t)}`,n.attributes.id=r);const l={id:r,name:t,level:e,items:[],ast:[n]};return i.push(l),l},d=(t,e)=>{var i,n;null===(n=null===(i=t[t.length-1])||void 0===i?void 0:i.ast)||void 0===n||n.push(e)},u=t=>{var e;for(const i of t.children){const t=getMarkdownContent(i)||"";"heading"===i.type&&1===i.attributes.level?l=a(t,i.attributes.level,void 0,i):i.attributes.level<=n?a(t,i.attributes.level,null==l?void 0:l.items,i,null==l?void 0:l.id):(null===(e=null==l?void 0:l.items)||void 0===e?void 0:e.length)?d(null==l?void 0:l.items,i):(null==s?void 0:s.length)&&d(s,i)}};if(Array.isArray(r))for(const t of r)u(t);else u(r);return mapHeadingsDeep(e,s,i,{pagination:o,markdownHeadingsAnchorLevel:n})}function mapHeadingsDeep(t,e,i=1,n){return e.map((e=>{const o=getTagOrGroup("section",e,n,t);return o.depth=i,e.items&&(o.items=mapHeadingsDeep(o,e.items,i+1,n)),o}))}function getMarkdownContent(t){var e,i;return"string"==typeof(null===(e=null==t?void 0:t.attributes)||void 0===e?void 0:e.content)?null===(i=t.attributes)||void 0===i?void 0:i.content:(null==t?void 0:t.children)?getMarkdownContent(t.children[0]):void 0}
|
|
2
2
|
//# sourceMappingURL=markdown.js.map
|
|
@@ -27,7 +27,7 @@ export interface OpenAPIInfo extends ParsedDescriptionWithSummary {
|
|
|
27
27
|
license?: OpenAPILicense;
|
|
28
28
|
'x-logo'?: XLogo;
|
|
29
29
|
'x-metadata'?: XMetadata;
|
|
30
|
-
'x-
|
|
30
|
+
'x-seo'?: XSEO;
|
|
31
31
|
}
|
|
32
32
|
export interface XLogo {
|
|
33
33
|
url?: string;
|
|
@@ -39,6 +39,9 @@ export interface XMetadata {
|
|
|
39
39
|
apiId?: string;
|
|
40
40
|
[key: string]: unknown;
|
|
41
41
|
}
|
|
42
|
+
export interface XSEO {
|
|
43
|
+
title?: string;
|
|
44
|
+
}
|
|
42
45
|
export interface OpenAPIServer extends ParsedDescription {
|
|
43
46
|
url: string;
|
|
44
47
|
description?: string;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{Ast}from"@markdoc/markdoc";import{isString}from"./typeGuards";import{deepClone}from"../services/utils";export function saveTextBeforeHeading(e,r){if(!isString(e)&&(null==e?void 0:e.result)){const i=deepClone(e),n=Ast.fromJSON(null==i?void 0:i.result);if(Array.isArray(n))for(const e of n)modifyNodeByHeading(e,r);else modifyNodeByHeading(n,r);return i.result=JSON.stringify(n),i.raw=saveTextBeforeHeading(i.raw,r),i}const i=new RegExp(`^#{1,${r}}?\\s+`,"m"),n=e.search(i);return n>-1?e.substring(0,n):e}function modifyNodeByHeading(e,r){const i=e.children.findIndex((e=>"heading"===e.type&&e.attributes.level<=r));return-1===i||(e.children=e.children.slice(0,i)),e}
|
|
1
|
+
import{Ast}from"@markdoc/markdoc";import{isString}from"./typeGuards";import{deepClone}from"../services/utils";export function saveTextBeforeHeading(e,r){if(!isString(e)&&(null==e?void 0:e.result)){const i=deepClone(e),n=Ast.fromJSON(JSON.stringify(null==i?void 0:i.result));if(Array.isArray(n))for(const e of n)modifyNodeByHeading(e,r);else modifyNodeByHeading(n,r);return i.result=JSON.stringify(n),i.raw=saveTextBeforeHeading(i.raw,r),i}const i=new RegExp(`^#{1,${r}}?\\s+`,"m"),n=e.search(i);return n>-1?e.substring(0,n):e}function modifyNodeByHeading(e,r){const i=e.children.findIndex((e=>"heading"===e.type&&e.attributes.level<=r));return-1===i||(e.children=e.children.slice(0,i)),e}
|
|
2
2
|
//# sourceMappingURL=saveTextBeforeHeading.js.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@redocly/openapi-docs",
|
|
3
|
-
"version": "3.0.0-alpha.
|
|
3
|
+
"version": "3.0.0-alpha.72.beta.0",
|
|
4
4
|
"description": "Redocly OpenAPI Docs",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"module": "lib-esm/index.js",
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
"styled-components": "^4.1.1 || ^5.1.1"
|
|
23
23
|
},
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@markdoc/markdoc": "0.
|
|
25
|
+
"@markdoc/markdoc": "0.3.3",
|
|
26
26
|
"@redocly/openapi-core": "^1.0.0-rc.1",
|
|
27
27
|
"@redocly/vscode-json-languageservice": "3.4.9",
|
|
28
28
|
"@wojtekmaj/enzyme-adapter-react-17": "^0.6.2",
|
|
@@ -114,7 +114,7 @@
|
|
|
114
114
|
"webpack-cli": "^5.1.4",
|
|
115
115
|
"webpack-dev-server": "^4.15.1",
|
|
116
116
|
"workerize-loader": "github:redocly/workerize-loader#webpack-5-dist",
|
|
117
|
-
"@redocly/theme": "0.30.
|
|
117
|
+
"@redocly/theme": "0.30.3"
|
|
118
118
|
},
|
|
119
119
|
"scripts": {
|
|
120
120
|
"start": "webpack serve --mode=development --hot",
|