@redocly/reference-docs 2.40.2 → 2.41.1
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/bin/cli/commands/redocly-docs-cli.min.js +9 -9
- package/bin/cli/commands/redocly-docs-cli.min.js.LICENSE.txt +1 -1
- package/dist/console.redocly-reference-docs.min.js +66 -66
- package/dist/oauth2-redirect.js +1 -1
- package/dist/redocly-reference-docs.min.js +552 -548
- package/lib/components/Endpoint/Endpoint.js +1 -1
- package/lib/components/console/ServersDropdown/ServersDropdown.js +1 -1
- package/lib/events/index.d.ts +2 -1
- package/lib/events/index.js +1 -1
- package/lib/events/panelToggle.d.ts +1 -1
- package/lib/events/panelToggle.js +1 -1
- package/lib/events/serverSwitch.d.ts +2 -0
- package/lib/events/serverSwitch.js +2 -0
- package/lib/events/types.d.ts +11 -2
- package/lib/events/types.js +1 -1
- package/lib/redoc-lib/src/components/Operation/Operation.js +1 -1
- package/lib/redoc-lib/src/components/RequestSamples/RequestSamples.js +1 -1
- package/lib/redoc-lib/src/components/ResponseSamples/ResponseSamples.js +1 -1
- package/lib-esm/components/Endpoint/Endpoint.js +1 -1
- package/lib-esm/components/console/ServersDropdown/ServersDropdown.js +1 -1
- package/lib-esm/events/index.d.ts +2 -1
- package/lib-esm/events/index.js +1 -1
- package/lib-esm/events/panelToggle.d.ts +1 -1
- package/lib-esm/events/panelToggle.js +1 -1
- package/lib-esm/events/serverSwitch.d.ts +2 -0
- package/lib-esm/events/serverSwitch.js +2 -0
- package/lib-esm/events/types.d.ts +11 -2
- package/lib-esm/events/types.js +1 -1
- package/lib-esm/redoc-lib/src/components/Operation/Operation.js +1 -1
- package/lib-esm/redoc-lib/src/components/RequestSamples/RequestSamples.js +1 -1
- package/lib-esm/redoc-lib/src/components/ResponseSamples/ResponseSamples.js +1 -1
- package/package.json +2 -2
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Endpoint=void 0;var tslib_1=require("tslib"),jsx_runtime_1=require("react/jsx-runtime"),react_1=require("react"),StoreBuilder_1=require("../../redoc-lib/src/components/StoreBuilder"),ConsoleLazy_1=require("../console/ConsoleLazy"),Panel_1=require("../Panel"),events_1=require("../../events"),ServerList_1=require("./ServerList"),Summary_1=require("./Summary"),Endpoint=function(e){var r=e.operation,t=e.hideHostname,o=(0,react_1.useState)(!1),n=o[0],i=o[1],s=(0,react_1.useContext)(StoreBuilder_1.StoreContext),a=function(){var e,t;i(
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Endpoint=void 0;var tslib_1=require("tslib"),jsx_runtime_1=require("react/jsx-runtime"),react_1=require("react"),StoreBuilder_1=require("../../redoc-lib/src/components/StoreBuilder"),ConsoleLazy_1=require("../console/ConsoleLazy"),Panel_1=require("../Panel"),events_1=require("../../events"),ServerList_1=require("./ServerList"),Summary_1=require("./Summary"),Endpoint=function(e){var r=e.operation,t=e.hideHostname,o=(0,react_1.useState)(!1),n=o[0],i=o[1],s=(0,react_1.useContext)(StoreBuilder_1.StoreContext),a=function(){var e,t,o=!n;i(o),o&&(null===(t=null===(e=null==s?void 0:s.options.events)||void 0===e?void 0:e.tryItOpen)||void 0===t||t.call(e,{eventType:events_1.AnalyticsEventType.TryItOpen,resource:"Redocly_OperationTryIt",action:(null==s?void 0:s.options.unstable_tryItButtonOverride)?"NavigatedOverrideLink":"Opened",operationId:r.operationId,operationPath:r.path,operationHttpVerb:r.httpVerb,operationSummary:r.description}))};return(0,jsx_runtime_1.jsx)(jsx_runtime_1.Fragment,{children:n&&s?(0,jsx_runtime_1.jsx)(ConsoleLazy_1.Console,{store:s,operation:r,onClose:a},void 0):(0,jsx_runtime_1.jsx)(Panel_1.CodePanel,(0,tslib_1.__assign)({header:function(e){var t=e.toggle,o=e.expanded,n=!!(null==s?void 0:s.options.showConsole)&&!r.hideTryItPanel;return(0,jsx_runtime_1.jsx)(Summary_1.Summary,{operation:r,expanded:o,toggle:t,showConsole:n,onToggleConsole:a,tryItOverride:null==s?void 0:s.options.unstable_tryItButtonOverride},void 0)},expanded:!1},{children:(0,jsx_runtime_1.jsx)(ServerList_1.ServerList,{servers:r.servers,path:r.path,expandVariables:Boolean(null==s?void 0:s.options.expandDefaultServerVariables),hideHostname:t||Boolean(null==s?void 0:s.options.hideHostname)},void 0)}),void 0)},void 0)};exports.Endpoint=Endpoint;
|
|
2
2
|
//# sourceMappingURL=Endpoint.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ServersDropdown=void 0;var tslib_1=require("tslib"),jsx_runtime_1=require("react/jsx-runtime"),react_1=require("react"),mobx_react_1=require("mobx-react"),redoc_lib_1=require("../../../redoc-lib"),utils_1=require("../../../utils"),form_1=require("../../common/form"),Dropdown_1=require("../../common/Dropdown"),utils_2=require("../utils"),ServerVariable_1=(0,tslib_1.__importDefault)(require("../ServerVariable")),hooks_1=require("../../../hooks");exports.ServersDropdown=(0,mobx_react_1.observer)((function(e){var r=e.operation,t=e.onChange,i=(0,utils_1.fromSessionStorage)("serverUrl"),
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ServersDropdown=void 0;var tslib_1=require("tslib"),jsx_runtime_1=require("react/jsx-runtime"),react_1=require("react"),mobx_react_1=require("mobx-react"),redoc_lib_1=require("../../../redoc-lib"),utils_1=require("../../../utils"),form_1=require("../../common/form"),Dropdown_1=require("../../common/Dropdown"),utils_2=require("../utils"),ServerVariable_1=(0,tslib_1.__importDefault)(require("../ServerVariable")),hooks_1=require("../../../hooks"),events_1=require("../../../events");exports.ServersDropdown=(0,mobx_react_1.observer)((function(e){var r=e.operation,t=e.onChange,i=r.servers,o=(0,utils_1.fromSessionStorage)("serverUrl"),a=i.findIndex((function(e){return e.url===o})),n=(0,react_1.useState)(a<0?0:a),s=n[0],l=n[1],u=(0,react_1.useState)({}),_=u[0],v=u[1],d=(0,redoc_lib_1.useStore)(),c=null==d?void 0:d.options.unstable_hideServerUrlInTryIt;(0,hooks_1.useMount)((function(){var e=(0,utils_2.getServerWithVariables)(i,s);t(e),v(e.variables)}));var b=i.map((function(e,r){var t=(0,utils_2.expandDefaultServerVariables)((0,utils_2.expandVariables)(e.url,_),e.variables),i=c?e.description||t:(e.description?e.description+" - ":"")+t;return{idx:r,serverUrl:e.url,value:i}})),m=Object.keys(_);return(0,jsx_runtime_1.jsxs)(ServerDropdownWrap,(0,tslib_1.__assign)({"data-cy":"console-target-server"},{children:[(0,jsx_runtime_1.jsx)(form_1.FormLabel,(0,tslib_1.__assign)({htmlFor:"server"},{children:"Target server: "}),void 0),(0,jsx_runtime_1.jsx)(form_1.FormControl,{children:(0,jsx_runtime_1.jsx)(Dropdown_1.Dropdown,{variant:"dark",value:b[s].value,options:b,fullWidth:!0,onChange:function(e){var o,a,n=e.serverUrl,s=void 0===n?"":n,u=i.find((function(e){return e.url===s})),_=i.findIndex((function(e){return e.url===s})),c=(0,utils_2.getDefaultOrStoredVariables)(u);t({url:s,variables:c}),(0,utils_1.toSessionStorage)("serverUrl",s),l(_),v(c);var b=(0,events_1.createServerSwitchEvent)({operation:r,serverUrl:s});null===(a=null==d?void 0:(o=d.options.events).targetServerSwitch)||void 0===a||a.call(o,b)}},void 0)},void 0),null==m?void 0:m.map((function(e){var r,o=null===(r=i[s].variables)||void 0===r?void 0:r[e];if(o)return(0,jsx_runtime_1.jsx)(ServerVariable_1.default,{name:e,value:_[e],defaultValue:o.default,onChange:function(r){return function(e,r){var o,a=i[s],n=r||""===r?r:(0,utils_2.getDefaultOrStoredVariables)(a)[e],l=(0,tslib_1.__assign)((0,tslib_1.__assign)({},_),((o={})[e]=n,o));v(l),(0,utils_2.updateVariablesStorage)(e,n),t((0,tslib_1.__assign)((0,tslib_1.__assign)({},a),{variables:l}))}(e,r)},variableEnum:o.enum,description:o.description},e)}))]}),void 0)}));var templateObject_1,ServerDropdownWrap=redoc_lib_1.styled.div(templateObject_1||(templateObject_1=(0,tslib_1.__makeTemplateObject)(["\n margin-bottom: 20px;\n"],["\n margin-bottom: 20px;\n"])));
|
|
2
2
|
//# sourceMappingURL=ServersDropdown.js.map
|
package/lib/events/index.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export type { Events } from './types';
|
|
2
2
|
export { AnalyticsEventType } from './types';
|
|
3
3
|
export { createLanguageSwitchEvent } from './languageSwitch';
|
|
4
|
-
export {
|
|
4
|
+
export { createPanelToggleEvent } from './panelToggle';
|
|
5
5
|
export { createCodeSampleCopyEvent } from './codeSampleCopy';
|
|
6
|
+
export { createServerSwitchEvent } from './serverSwitch';
|
package/lib/events/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.createCodeSampleCopyEvent=exports.
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.createServerSwitchEvent=exports.createCodeSampleCopyEvent=exports.createPanelToggleEvent=exports.createLanguageSwitchEvent=exports.AnalyticsEventType=void 0;var types_1=require("./types");Object.defineProperty(exports,"AnalyticsEventType",{enumerable:!0,get:function(){return types_1.AnalyticsEventType}});var languageSwitch_1=require("./languageSwitch");Object.defineProperty(exports,"createLanguageSwitchEvent",{enumerable:!0,get:function(){return languageSwitch_1.createLanguageSwitchEvent}});var panelToggle_1=require("./panelToggle");Object.defineProperty(exports,"createPanelToggleEvent",{enumerable:!0,get:function(){return panelToggle_1.createPanelToggleEvent}});var codeSampleCopy_1=require("./codeSampleCopy");Object.defineProperty(exports,"createCodeSampleCopyEvent",{enumerable:!0,get:function(){return codeSampleCopy_1.createCodeSampleCopyEvent}});var serverSwitch_1=require("./serverSwitch");Object.defineProperty(exports,"createServerSwitchEvent",{enumerable:!0,get:function(){return serverSwitch_1.createServerSwitchEvent}});
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
import type { PanelToggleEvent, PanelToggleProps } from './types';
|
|
2
|
-
export declare const
|
|
2
|
+
export declare const createPanelToggleEvent: ({ operation, isExpanded, panelType, }: PanelToggleProps) => PanelToggleEvent;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.createPanelToggleEvent=void 0;var creator_1=require("./creator"),types_1=require("./types"),panelToggleEvent=(0,creator_1.createTrackingEvent)(types_1.AnalyticsEventType.PanelToggle),createPanelToggleEvent=function(e){var t=e.operation,a=e.isExpanded,r=e.panelType;return panelToggleEvent({resource:"Redocly_Operation",action:"PanelToggled",operationId:t.id,operationPath:t.path,operationHttpVerb:t.httpVerb,operationSummary:t.name,panelType:r,state:a?"expanded":"collapsed"})};exports.createPanelToggleEvent=createPanelToggleEvent;
|
|
2
2
|
//# sourceMappingURL=panelToggle.js.map
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.createServerSwitchEvent=void 0;var creator_1=require("./creator"),types_1=require("./types"),targetServerSwitchEvent=(0,creator_1.createTrackingEvent)(types_1.AnalyticsEventType.TargetServerSwitched),createServerSwitchEvent=function(e){var r=e.operation,t=e.serverUrl;return targetServerSwitchEvent({resource:"Redocly_OperationTryIt",action:"TargetServerSwitched",operationId:r.id,operationPath:r.path,operationHttpVerb:r.httpVerb,operationSummary:r.name,serverUrl:t})};exports.createServerSwitchEvent=createServerSwitchEvent;
|
|
2
|
+
//# sourceMappingURL=serverSwitch.js.map
|
package/lib/events/types.d.ts
CHANGED
|
@@ -15,18 +15,23 @@ export interface CodeSampleCopyProps {
|
|
|
15
15
|
type: 'request' | 'response';
|
|
16
16
|
exampleId?: string;
|
|
17
17
|
}
|
|
18
|
+
export interface TargetServerSwitchProps {
|
|
19
|
+
operation: OperationModel;
|
|
20
|
+
serverUrl: string;
|
|
21
|
+
}
|
|
18
22
|
export declare enum AnalyticsEventType {
|
|
19
23
|
CodeSampleLanguageSwitched = "CodeSampleLanguageSwitched",
|
|
20
24
|
CodeSampleCopied = "CodeSampleCopied",
|
|
21
25
|
OperationServerExpanded = "OperationServerExpanded",
|
|
22
26
|
PanelToggle = "PanelToggle",
|
|
23
27
|
TryItOpen = "TryItOpen",
|
|
24
|
-
TryItSent = "TryItSent"
|
|
28
|
+
TryItSent = "TryItSent",
|
|
29
|
+
TargetServerSwitched = "TargetServerSwitched"
|
|
25
30
|
}
|
|
26
31
|
export interface AnalyticsEvent {
|
|
27
32
|
eventType: AnalyticsEventType;
|
|
28
33
|
resource: 'Redocly_CodeSample' | 'Redocly_Operation' | 'Redocly_OperationTryIt';
|
|
29
|
-
action: 'LanguageSwitched' | 'PanelToggled' | 'Opened' | 'NavigatedOverrideLink' | 'Sent' | 'ValidationFailed' | 'CodeSampleCopied';
|
|
34
|
+
action: 'LanguageSwitched' | 'PanelToggled' | 'Opened' | 'NavigatedOverrideLink' | 'Sent' | 'ValidationFailed' | 'CodeSampleCopied' | 'TargetServerSwitched';
|
|
30
35
|
operationId?: string;
|
|
31
36
|
operationPath: string;
|
|
32
37
|
operationHttpVerb: string;
|
|
@@ -53,11 +58,15 @@ export interface PanelToggleEvent extends AnalyticsEvent {
|
|
|
53
58
|
operationHttpVerb: string;
|
|
54
59
|
operationSummary?: string;
|
|
55
60
|
}
|
|
61
|
+
export interface TargetServerSwitchedEvent extends AnalyticsEvent {
|
|
62
|
+
serverUrl: string;
|
|
63
|
+
}
|
|
56
64
|
export declare type Events = {
|
|
57
65
|
codeSamplesLanguageSwitch?: (event: CodeSamplesLanguageSwitchedEvent) => void;
|
|
58
66
|
codeSamplesCopy?: (event: CodeSamplesCopiedEvent) => void;
|
|
59
67
|
tryItOpen?: (event: TryItOpenedEvent) => void;
|
|
60
68
|
tryItSent?: (event: TryItOpenedEvent) => void;
|
|
61
69
|
panelToggle?: (event: PanelToggleEvent) => void;
|
|
70
|
+
targetServerSwitch?: (event: TargetServerSwitchedEvent) => void;
|
|
62
71
|
};
|
|
63
72
|
export {};
|
package/lib/events/types.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var AnalyticsEventType;Object.defineProperty(exports,"__esModule",{value:!0}),exports.AnalyticsEventType=void 0,function(e){e.CodeSampleLanguageSwitched="CodeSampleLanguageSwitched",e.CodeSampleCopied="CodeSampleCopied",e.OperationServerExpanded="OperationServerExpanded",e.PanelToggle="PanelToggle",e.TryItOpen="TryItOpen",e.TryItSent="TryItSent"}(AnalyticsEventType=exports.AnalyticsEventType||(exports.AnalyticsEventType={}));
|
|
1
|
+
"use strict";var AnalyticsEventType;Object.defineProperty(exports,"__esModule",{value:!0}),exports.AnalyticsEventType=void 0,function(e){e.CodeSampleLanguageSwitched="CodeSampleLanguageSwitched",e.CodeSampleCopied="CodeSampleCopied",e.OperationServerExpanded="OperationServerExpanded",e.PanelToggle="PanelToggle",e.TryItOpen="TryItOpen",e.TryItSent="TryItSent",e.TargetServerSwitched="TargetServerSwitched"}(AnalyticsEventType=exports.AnalyticsEventType||(exports.AnalyticsEventType={}));
|
|
2
2
|
//# sourceMappingURL=types.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Operation=void 0;var templateObject_1,templateObject_2,tslib_1=require("tslib"),jsx_runtime_1=require("react/jsx-runtime"),mobx_react_1=require("mobx-react"),react_1=require("react"),Endpoint_1=require("../../../../components/Endpoint"),common_elements_1=require("../../common-elements"),styled_components_1=(0,tslib_1.__importDefault)(require("../../styled-components")),Callbacks_1=require("../Callbacks"),CallbackSamples_1=require("../CallbackSamples/CallbackSamples"),ExternalDocumentation_1=require("../ExternalDocumentation/ExternalDocumentation"),Extensions_1=require("../Fields/Extensions"),Markdown_1=require("../Markdown"),Parameters_1=require("../Parameters/Parameters"),RequestSamples_1=require("../RequestSamples/RequestSamples"),Responses_1=require("../Responses"),ResponseSamples_1=require("../ResponseSamples/ResponseSamples"),SecurityRequirement_1=require("../SecurityRequirement/SecurityRequirement"),StoreBuilder_1=require("../StoreBuilder"),Panel_1=require("../../../../components/Panel"),store_types_1=require("../../../../services/store-types"),RenderHook_1=require("../RenderHook"),Labels_1=require("../../services/Labels"),events_1=require("../../../../events"),OperationRow=(0,styled_components_1.default)(common_elements_1.Row)(templateObject_1||(templateObject_1=(0,tslib_1.__makeTemplateObject)(["\n backface-visibility: hidden;\n contain: content;\n overflow: hidden;\n"],["\n backface-visibility: hidden;\n contain: content;\n overflow: hidden;\n"]))),Description=styled_components_1.default.div(templateObject_2||(templateObject_2=(0,tslib_1.__makeTemplateObject)(["\n margin-bottom: ","px;\n"],["\n margin-bottom: ","px;\n"])),(function(e){return 4*e.theme.spacing.unit}));exports.Operation=(0,mobx_react_1.observer)((function(e){var n,s,o,t=e.operation,i=t.name,r=t.description,l=t.deprecated,a=t.externalDocs,_=t.isWebhook,d=t.httpVerb,u=e.operation,m=e.layout,p=(0,react_1.useContext)(StoreBuilder_1.StoreContext),c=!(!r&&!a),x=null==p?void 0:p.options.hooks,j=null==p?void 0:p.options.events,v=(0,react_1.useCallback)((function(e){return function(n){var s,o=(0,events_1.
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Operation=void 0;var templateObject_1,templateObject_2,tslib_1=require("tslib"),jsx_runtime_1=require("react/jsx-runtime"),mobx_react_1=require("mobx-react"),react_1=require("react"),Endpoint_1=require("../../../../components/Endpoint"),common_elements_1=require("../../common-elements"),styled_components_1=(0,tslib_1.__importDefault)(require("../../styled-components")),Callbacks_1=require("../Callbacks"),CallbackSamples_1=require("../CallbackSamples/CallbackSamples"),ExternalDocumentation_1=require("../ExternalDocumentation/ExternalDocumentation"),Extensions_1=require("../Fields/Extensions"),Markdown_1=require("../Markdown"),Parameters_1=require("../Parameters/Parameters"),RequestSamples_1=require("../RequestSamples/RequestSamples"),Responses_1=require("../Responses"),ResponseSamples_1=require("../ResponseSamples/ResponseSamples"),SecurityRequirement_1=require("../SecurityRequirement/SecurityRequirement"),StoreBuilder_1=require("../StoreBuilder"),Panel_1=require("../../../../components/Panel"),store_types_1=require("../../../../services/store-types"),RenderHook_1=require("../RenderHook"),Labels_1=require("../../services/Labels"),events_1=require("../../../../events"),OperationRow=(0,styled_components_1.default)(common_elements_1.Row)(templateObject_1||(templateObject_1=(0,tslib_1.__makeTemplateObject)(["\n backface-visibility: hidden;\n contain: content;\n overflow: hidden;\n"],["\n backface-visibility: hidden;\n contain: content;\n overflow: hidden;\n"]))),Description=styled_components_1.default.div(templateObject_2||(templateObject_2=(0,tslib_1.__makeTemplateObject)(["\n margin-bottom: ","px;\n"],["\n margin-bottom: ","px;\n"])),(function(e){return 4*e.theme.spacing.unit}));exports.Operation=(0,mobx_react_1.observer)((function(e){var n,s,o,t=e.operation,i=t.name,r=t.description,l=t.deprecated,a=t.externalDocs,_=t.isWebhook,d=t.httpVerb,u=e.operation,m=e.layout,p=(0,react_1.useContext)(StoreBuilder_1.StoreContext),c=!(!r&&!a),x=null==p?void 0:p.options.hooks,j=null==p?void 0:p.options.events,v=(0,react_1.useCallback)((function(e){return function(n){var s,o=(0,events_1.createPanelToggleEvent)({operation:u,isExpanded:n,panelType:e});null===(s=null==j?void 0:j.panelToggle)||void 0===s||s.call(j,o)}}),[j,u]);return(0,jsx_runtime_1.jsxs)(OperationRow,(0,tslib_1.__assign)({layout:m},{children:[(0,jsx_runtime_1.jsxs)(common_elements_1.MiddlePanel,(0,tslib_1.__assign)({isStacked:m===store_types_1.LayoutVariant.STACKED},{children:[(0,jsx_runtime_1.jsx)(RenderHook_1.RenderHook,{Hook:null==x?void 0:x.BeforeOperation,props:{operation:u}},void 0),(0,jsx_runtime_1.jsxs)(common_elements_1.H2,{children:[(0,jsx_runtime_1.jsx)(common_elements_1.ShareLink,{to:u.id},void 0),(0,jsx_runtime_1.jsx)(RenderHook_1.RenderHook,{Hook:null==x?void 0:x.BeforeOperationSummary,props:{operation:u}},void 0),i,(0,jsx_runtime_1.jsx)(RenderHook_1.RenderHook,{Hook:null==x?void 0:x.AfterOperationSummary,props:{operation:u}},void 0),l&&(0,jsx_runtime_1.jsx)(common_elements_1.Badge,(0,tslib_1.__assign)({type:"warning"},{children:"Deprecated"}),void 0),_&&(0,jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment,{children:[(0,jsx_runtime_1.jsx)(common_elements_1.Badge,(0,tslib_1.__assign)({type:"primary"},{children:"Webhook "}),void 0),(null==p?void 0:p.options.showWebhookVerb)&&d&&(0,jsx_runtime_1.jsx)(common_elements_1.Badge,(0,tslib_1.__assign)({type:"primary"},{children:d.toUpperCase()}),void 0)]},void 0)]},void 0),(null==p?void 0:p.options.pathInMiddlePanel)&&!_&&(0,jsx_runtime_1.jsx)(Endpoint_1.Endpoint,{operation:u},void 0),c&&(0,jsx_runtime_1.jsxs)(Description,{children:[void 0!==r&&(0,jsx_runtime_1.jsx)(Markdown_1.Markdown,{source:r},void 0),a&&(0,jsx_runtime_1.jsx)(ExternalDocumentation_1.ExternalDocumentation,{externalDocs:a},void 0),Object.keys(u.extensions||{}).length?(0,jsx_runtime_1.jsx)(Extensions_1.Extensions,{extensions:u.extensions},void 0):null]},void 0),(0,jsx_runtime_1.jsx)(SecurityRequirement_1.SecurityRequirements,{securities:u.security},void 0),(null===(n=u.parameters)||void 0===n?void 0:n.length)||u.requestBody?(0,jsx_runtime_1.jsx)(Panel_1.ScrollableContentPanel,(0,tslib_1.__assign)({header:(0,Labels_1.l)("request"),onToggle:v("request"),expanded:null==p?void 0:p.options.expandDefaultRequest},{children:(0,jsx_runtime_1.jsx)(Parameters_1.Parameters,{parameters:u.parameters,body:u.requestBody},void 0)}),void 0):null,(null===(s=u.responses)||void 0===s?void 0:s.length)?(0,jsx_runtime_1.jsx)(Panel_1.ScrollableContentPanel,(0,tslib_1.__assign)({header:(0,Labels_1.l)("responses"),onToggle:v("responses"),expanded:null==p?void 0:p.options.expandDefaultResponse},{children:(0,jsx_runtime_1.jsx)(Responses_1.ResponsesList,{responses:u.responses},void 0)}),void 0):null,(null===(o=u.callbacks)||void 0===o?void 0:o.length)?(0,jsx_runtime_1.jsx)(Panel_1.ScrollableContentPanel,(0,tslib_1.__assign)({header:(0,Labels_1.l)("callbacks")},{children:(0,jsx_runtime_1.jsx)(Callbacks_1.CallbacksList,{callbacks:u.callbacks},void 0)}),void 0):null,(0,jsx_runtime_1.jsx)(RenderHook_1.RenderHook,{Hook:null==x?void 0:x.AfterOperation,props:{operation:u}},void 0)]}),void 0),(null==p?void 0:p.showRightPanel)?(0,jsx_runtime_1.jsxs)(common_elements_1.RightPanel,(0,tslib_1.__assign)({"data-cy":"samples-block"},{children:[!(null==p?void 0:p.options.pathInMiddlePanel)&&!_&&(0,jsx_runtime_1.jsx)(Endpoint_1.Endpoint,{operation:u},void 0),(0,jsx_runtime_1.jsx)(RequestSamples_1.RequestSamples,{operation:u},void 0),(0,jsx_runtime_1.jsx)(ResponseSamples_1.ResponseSamples,{operation:u},void 0),(0,jsx_runtime_1.jsx)(CallbackSamples_1.CallbackSamples,{callbacks:u.callbacks},void 0)]}),void 0):null]}),void 0)}));
|
|
2
2
|
//# sourceMappingURL=Operation.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.RequestSamples=void 0;var tslib_1=require("tslib"),jsx_runtime_1=require("react/jsx-runtime"),react_1=require("react"),mobx_react_1=require("mobx-react"),Panel_1=require("../../../../components/Panel"),Tabs_1=require("../../../../components/Tabs"),Samples_1=require("../../../../components/Samples"),services_1=require("../../services"),PayloadSamples_1=require("../PayloadSamples"),OptionsProvider_1=require("../OptionsProvider"),Labels_1=require("../../services/Labels"),events_1=require("../../../../events"),CodeSample_1=require("./CodeSample"),useCodeSamples_1=require("./useCodeSamples");exports.RequestSamples=(0,mobx_react_1.observer)((function(e){var a=e.operation,s=e.defaultLanguage,t=e.disableHeader,n=(e.content,(0,tslib_1.__rest)(e,["operation","defaultLanguage","disableHeader","content"])),l=(0,react_1.useContext)(OptionsProvider_1.OptionsContext),r=l.events,o=l.hideSingleRequestSampleTab,i=l.collapseRequestSamplePanel;(0,react_1.useEffect)((function(){}),[a.activeServer,a.requestValues]);var u=(0,useCodeSamples_1.useCodeSamples)(a),d=u.samples,p=u.payload,_=1===d.length&&o,c=(0,react_1.useCallback)((function(e){var s=e.lang,t=e.title;return function(){var e,n=(0,events_1.createCodeSampleCopyEvent)({operation:a,label:t,lang:s,type:"request"});null===(e=null==r?void 0:r.codeSamplesCopy)||void 0===e||e.call(r,n)}}),[a,r]);return d.length?(0,jsx_runtime_1.jsx)(Panel_1.CodePanel,(0,tslib_1.__assign)({dataHeaderTestId:"request-samples",header:t?void 0:(0,Labels_1.l)("requestSamples"),onToggle:function(e){var s,t=(0,events_1.
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.RequestSamples=void 0;var tslib_1=require("tslib"),jsx_runtime_1=require("react/jsx-runtime"),react_1=require("react"),mobx_react_1=require("mobx-react"),Panel_1=require("../../../../components/Panel"),Tabs_1=require("../../../../components/Tabs"),Samples_1=require("../../../../components/Samples"),services_1=require("../../services"),PayloadSamples_1=require("../PayloadSamples"),OptionsProvider_1=require("../OptionsProvider"),Labels_1=require("../../services/Labels"),events_1=require("../../../../events"),CodeSample_1=require("./CodeSample"),useCodeSamples_1=require("./useCodeSamples");exports.RequestSamples=(0,mobx_react_1.observer)((function(e){var a=e.operation,s=e.defaultLanguage,t=e.disableHeader,n=(e.content,(0,tslib_1.__rest)(e,["operation","defaultLanguage","disableHeader","content"])),l=(0,react_1.useContext)(OptionsProvider_1.OptionsContext),r=l.events,o=l.hideSingleRequestSampleTab,i=l.collapseRequestSamplePanel;(0,react_1.useEffect)((function(){}),[a.activeServer,a.requestValues]);var u=(0,useCodeSamples_1.useCodeSamples)(a),d=u.samples,p=u.payload,_=1===d.length&&o,c=(0,react_1.useCallback)((function(e){var s=e.lang,t=e.title;return function(){var e,n=(0,events_1.createCodeSampleCopyEvent)({operation:a,label:t,lang:s,type:"request"});null===(e=null==r?void 0:r.codeSamplesCopy)||void 0===e||e.call(r,n)}}),[a,r]);return d.length?(0,jsx_runtime_1.jsx)(Panel_1.CodePanel,(0,tslib_1.__assign)({dataHeaderTestId:"request-samples",header:t?void 0:(0,Labels_1.l)("requestSamples"),onToggle:function(e){var s,t=(0,events_1.createPanelToggleEvent)({operation:a,isExpanded:e,panelType:"request-samples"});null===(s=null==r?void 0:r.panelToggle)||void 0===s||s.call(r,t)},expanded:!i},{children:(0,jsx_runtime_1.jsx)(Samples_1.SamplesTabs,(0,tslib_1.__assign)({operation:a,tabs:d,onChange:function(e){var s,t=(0,events_1.createLanguageSwitchEvent)({operation:a,sample:e});null===(s=null==r?void 0:r.codeSamplesLanguageSwitch)||void 0===s||s.call(r,t)},hidden:_,defaultLanguage:s,id:a.id+"/request-tab"},{children:d.map((function(e){return(0,jsx_runtime_1.jsx)(Tabs_1.TabPanel,{children:(0,services_1.isPayloadSample)(e)?(0,jsx_runtime_1.jsx)(PayloadSamples_1.PayloadSamples,(0,tslib_1.__assign)({content:e.requestBodyContent,operation:a,onCopyClick:c(e)},n),void 0):(0,jsx_runtime_1.jsx)(CodeSample_1.CodeSample,(0,tslib_1.__assign)({lang:e.lang,source:e.source,externalSample:e,content:null==p?void 0:p.requestBodyContent,operation:a,onCopyClick:c(e)},n),void 0)},e.key+a.id)}))}),void 0)}),void 0):null}));
|
|
2
2
|
//# sourceMappingURL=RequestSamples.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ResponseSamples=void 0;var tslib_1=require("tslib"),jsx_runtime_1=require("react/jsx-runtime"),react_1=require("react"),Panel_1=require("../../../../components/Panel"),Tabs_1=require("../../../../components/Tabs"),OptionsProvider_1=require("../OptionsProvider"),PayloadSamples_1=require("../PayloadSamples"),Labels_1=require("../../services/Labels"),events_1=require("../../../../events"),ResponseSamples=function(e){var s=e.operation,n=(0,react_1.useContext)(OptionsProvider_1.OptionsContext),a=n.events,r=n.collapseResponseSamplePanel,o=s.responses.filter((function(e){var s,n;return null!==(n=null===(s=e.content)||void 0===s?void 0:s.hasSample)&&void 0!==n&&n})),l=(0,react_1.useCallback)((function(){var e,n=(0,events_1.createCodeSampleCopyEvent)({operation:s,type:"response"});null===(e=null==a?void 0:a.codeSamplesCopy)||void 0===e||e.call(a,n)}),[s,a]);if(!o.length)return null;var t=o.map((function(e){var s=e.code;return{key:s,title:s}}));return(0,jsx_runtime_1.jsx)(Panel_1.CodePanel,(0,tslib_1.__assign)({dataHeaderTestId:"response-samples",header:(0,Labels_1.l)("responseSamples"),onToggle:function(e){var n,r=(0,events_1.
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ResponseSamples=void 0;var tslib_1=require("tslib"),jsx_runtime_1=require("react/jsx-runtime"),react_1=require("react"),Panel_1=require("../../../../components/Panel"),Tabs_1=require("../../../../components/Tabs"),OptionsProvider_1=require("../OptionsProvider"),PayloadSamples_1=require("../PayloadSamples"),Labels_1=require("../../services/Labels"),events_1=require("../../../../events"),ResponseSamples=function(e){var s=e.operation,n=(0,react_1.useContext)(OptionsProvider_1.OptionsContext),a=n.events,r=n.collapseResponseSamplePanel,o=s.responses.filter((function(e){var s,n;return null!==(n=null===(s=e.content)||void 0===s?void 0:s.hasSample)&&void 0!==n&&n})),l=(0,react_1.useCallback)((function(){var e,n=(0,events_1.createCodeSampleCopyEvent)({operation:s,type:"response"});null===(e=null==a?void 0:a.codeSamplesCopy)||void 0===e||e.call(a,n)}),[s,a]);if(!o.length)return null;var t=o.map((function(e){var s=e.code;return{key:s,title:s}}));return(0,jsx_runtime_1.jsx)(Panel_1.CodePanel,(0,tslib_1.__assign)({dataHeaderTestId:"response-samples",header:(0,Labels_1.l)("responseSamples"),onToggle:function(e){var n,r=(0,events_1.createPanelToggleEvent)({operation:s,isExpanded:e,panelType:"response-samples"});null===(n=null==a?void 0:a.panelToggle)||void 0===n||n.call(a,r)},expanded:!r},{children:(0,jsx_runtime_1.jsx)(Tabs_1.CollapsingTabs,(0,tslib_1.__assign)({tabs:t,operation:s},{children:o.map((function(e){return(0,jsx_runtime_1.jsx)(Tabs_1.TabPanel,(0,tslib_1.__assign)({value:e.code},{children:(0,jsx_runtime_1.jsx)("div",{children:(0,jsx_runtime_1.jsx)(PayloadSamples_1.PayloadSamples,{content:e.content,onCopyClick:l},void 0)},void 0)}),e.code)}))}),void 0)}),void 0)};exports.ResponseSamples=ResponseSamples;
|
|
2
2
|
//# sourceMappingURL=ResponseSamples.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{__assign}from"tslib";import{jsx as _jsx,Fragment as _Fragment}from"react/jsx-runtime";import{useState,useContext}from"react";import{StoreContext}from"../../redoc-lib/src/components/StoreBuilder";import{Console}from"../console/ConsoleLazy";import{CodePanel}from"../Panel";import{AnalyticsEventType}from"../../events";import{ServerList}from"./ServerList";import{Summary}from"./Summary";export var Endpoint=function(e){var o=e.operation,t=e.hideHostname,r=useState(!1),n=r[0],i=r[1],a=useContext(StoreContext),s=function(){var e,t;i(
|
|
1
|
+
import{__assign}from"tslib";import{jsx as _jsx,Fragment as _Fragment}from"react/jsx-runtime";import{useState,useContext}from"react";import{StoreContext}from"../../redoc-lib/src/components/StoreBuilder";import{Console}from"../console/ConsoleLazy";import{CodePanel}from"../Panel";import{AnalyticsEventType}from"../../events";import{ServerList}from"./ServerList";import{Summary}from"./Summary";export var Endpoint=function(e){var o=e.operation,t=e.hideHostname,r=useState(!1),n=r[0],i=r[1],a=useContext(StoreContext),s=function(){var e,t,r=!n;i(r),r&&(null===(t=null===(e=null==a?void 0:a.options.events)||void 0===e?void 0:e.tryItOpen)||void 0===t||t.call(e,{eventType:AnalyticsEventType.TryItOpen,resource:"Redocly_OperationTryIt",action:(null==a?void 0:a.options.unstable_tryItButtonOverride)?"NavigatedOverrideLink":"Opened",operationId:o.operationId,operationPath:o.path,operationHttpVerb:o.httpVerb,operationSummary:o.description}))};return _jsx(_Fragment,{children:n&&a?_jsx(Console,{store:a,operation:o,onClose:s},void 0):_jsx(CodePanel,__assign({header:function(e){var t=e.toggle,r=e.expanded,n=!!(null==a?void 0:a.options.showConsole)&&!o.hideTryItPanel;return _jsx(Summary,{operation:o,expanded:r,toggle:t,showConsole:n,onToggleConsole:s,tryItOverride:null==a?void 0:a.options.unstable_tryItButtonOverride},void 0)},expanded:!1},{children:_jsx(ServerList,{servers:o.servers,path:o.path,expandVariables:Boolean(null==a?void 0:a.options.expandDefaultServerVariables),hideHostname:t||Boolean(null==a?void 0:a.options.hideHostname)},void 0)}),void 0)},void 0)};
|
|
2
2
|
//# sourceMappingURL=Endpoint.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{__assign,__makeTemplateObject}from"tslib";import{jsx as _jsx,jsxs as _jsxs}from"react/jsx-runtime";import{useState}from"react";import{observer}from"mobx-react";import{styled,useStore}from"../../../redoc-lib";import{fromSessionStorage,toSessionStorage}from"../../../utils";import{FormControl,FormLabel}from"../../common/form";import{Dropdown}from"../../common/Dropdown";import{expandDefaultServerVariables,expandVariables,getServerWithVariables,getDefaultOrStoredVariables,updateVariablesStorage}from"../utils";import ServerVariable from"../ServerVariable";import{useMount}from"../../../hooks";export var ServersDropdown=observer((function(r){var e=r.operation,
|
|
1
|
+
import{__assign,__makeTemplateObject}from"tslib";import{jsx as _jsx,jsxs as _jsxs}from"react/jsx-runtime";import{useState}from"react";import{observer}from"mobx-react";import{styled,useStore}from"../../../redoc-lib";import{fromSessionStorage,toSessionStorage}from"../../../utils";import{FormControl,FormLabel}from"../../common/form";import{Dropdown}from"../../common/Dropdown";import{expandDefaultServerVariables,expandVariables,getServerWithVariables,getDefaultOrStoredVariables,updateVariablesStorage}from"../utils";import ServerVariable from"../ServerVariable";import{useMount}from"../../../hooks";import{createServerSwitchEvent}from"../../../events";export var ServersDropdown=observer((function(r){var e=r.operation,t=r.onChange,o=e.servers,a=fromSessionStorage("serverUrl"),i=o.findIndex((function(r){return r.url===a})),n=useState(i<0?0:i),s=n[0],l=n[1],v=useState({}),u=v[0],m=v[1],d=useStore(),p=null==d?void 0:d.options.unstable_hideServerUrlInTryIt;useMount((function(){var r=getServerWithVariables(o,s);t(r),m(r.variables)}));var c=o.map((function(r,e){var t=expandDefaultServerVariables(expandVariables(r.url,u),r.variables),o=p?r.description||t:(r.description?r.description+" - ":"")+t;return{idx:e,serverUrl:r.url,value:o}})),f=Object.keys(u);return _jsxs(ServerDropdownWrap,__assign({"data-cy":"console-target-server"},{children:[_jsx(FormLabel,__assign({htmlFor:"server"},{children:"Target server: "}),void 0),_jsx(FormControl,{children:_jsx(Dropdown,{variant:"dark",value:c[s].value,options:c,fullWidth:!0,onChange:function(r){var a,i,n=r.serverUrl,s=void 0===n?"":n,v=o.find((function(r){return r.url===s})),u=o.findIndex((function(r){return r.url===s})),p=getDefaultOrStoredVariables(v);t({url:s,variables:p}),toSessionStorage("serverUrl",s),l(u),m(p);var c=createServerSwitchEvent({operation:e,serverUrl:s});null===(i=null==d?void 0:(a=d.options.events).targetServerSwitch)||void 0===i||i.call(a,c)}},void 0)},void 0),null==f?void 0:f.map((function(r){var e,a=null===(e=o[s].variables)||void 0===e?void 0:e[r];if(a)return _jsx(ServerVariable,{name:r,value:u[r],defaultValue:a.default,onChange:function(e){return function(r,e){var a,i=o[s],n=e||""===e?e:getDefaultOrStoredVariables(i)[r],l=__assign(__assign({},u),((a={})[r]=n,a));m(l),updateVariablesStorage(r,n),t(__assign(__assign({},i),{variables:l}))}(r,e)},variableEnum:a.enum,description:a.description},r)}))]}),void 0)}));var templateObject_1,ServerDropdownWrap=styled.div(templateObject_1||(templateObject_1=__makeTemplateObject(["\n margin-bottom: 20px;\n"],["\n margin-bottom: 20px;\n"])));
|
|
2
2
|
//# sourceMappingURL=ServersDropdown.js.map
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export type { Events } from './types';
|
|
2
2
|
export { AnalyticsEventType } from './types';
|
|
3
3
|
export { createLanguageSwitchEvent } from './languageSwitch';
|
|
4
|
-
export {
|
|
4
|
+
export { createPanelToggleEvent } from './panelToggle';
|
|
5
5
|
export { createCodeSampleCopyEvent } from './codeSampleCopy';
|
|
6
|
+
export { createServerSwitchEvent } from './serverSwitch';
|
package/lib-esm/events/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export{AnalyticsEventType}from"./types";export{createLanguageSwitchEvent}from"./languageSwitch";export{
|
|
1
|
+
export{AnalyticsEventType}from"./types";export{createLanguageSwitchEvent}from"./languageSwitch";export{createPanelToggleEvent}from"./panelToggle";export{createCodeSampleCopyEvent}from"./codeSampleCopy";export{createServerSwitchEvent}from"./serverSwitch";
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
import type { PanelToggleEvent, PanelToggleProps } from './types';
|
|
2
|
-
export declare const
|
|
2
|
+
export declare const createPanelToggleEvent: ({ operation, isExpanded, panelType, }: PanelToggleProps) => PanelToggleEvent;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{createTrackingEvent}from"./creator";import{AnalyticsEventType}from"./types";var panelToggleEvent=createTrackingEvent(AnalyticsEventType.PanelToggle);export var
|
|
1
|
+
import{createTrackingEvent}from"./creator";import{AnalyticsEventType}from"./types";var panelToggleEvent=createTrackingEvent(AnalyticsEventType.PanelToggle);export var createPanelToggleEvent=function(e){var t=e.operation,a=e.isExpanded,n=e.panelType;return panelToggleEvent({resource:"Redocly_Operation",action:"PanelToggled",operationId:t.id,operationPath:t.path,operationHttpVerb:t.httpVerb,operationSummary:t.name,panelType:n,state:a?"expanded":"collapsed"})};
|
|
2
2
|
//# sourceMappingURL=panelToggle.js.map
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import{createTrackingEvent}from"./creator";import{AnalyticsEventType}from"./types";var targetServerSwitchEvent=createTrackingEvent(AnalyticsEventType.TargetServerSwitched);export var createServerSwitchEvent=function(e){var r=e.operation,t=e.serverUrl;return targetServerSwitchEvent({resource:"Redocly_OperationTryIt",action:"TargetServerSwitched",operationId:r.id,operationPath:r.path,operationHttpVerb:r.httpVerb,operationSummary:r.name,serverUrl:t})};
|
|
2
|
+
//# sourceMappingURL=serverSwitch.js.map
|
|
@@ -15,18 +15,23 @@ export interface CodeSampleCopyProps {
|
|
|
15
15
|
type: 'request' | 'response';
|
|
16
16
|
exampleId?: string;
|
|
17
17
|
}
|
|
18
|
+
export interface TargetServerSwitchProps {
|
|
19
|
+
operation: OperationModel;
|
|
20
|
+
serverUrl: string;
|
|
21
|
+
}
|
|
18
22
|
export declare enum AnalyticsEventType {
|
|
19
23
|
CodeSampleLanguageSwitched = "CodeSampleLanguageSwitched",
|
|
20
24
|
CodeSampleCopied = "CodeSampleCopied",
|
|
21
25
|
OperationServerExpanded = "OperationServerExpanded",
|
|
22
26
|
PanelToggle = "PanelToggle",
|
|
23
27
|
TryItOpen = "TryItOpen",
|
|
24
|
-
TryItSent = "TryItSent"
|
|
28
|
+
TryItSent = "TryItSent",
|
|
29
|
+
TargetServerSwitched = "TargetServerSwitched"
|
|
25
30
|
}
|
|
26
31
|
export interface AnalyticsEvent {
|
|
27
32
|
eventType: AnalyticsEventType;
|
|
28
33
|
resource: 'Redocly_CodeSample' | 'Redocly_Operation' | 'Redocly_OperationTryIt';
|
|
29
|
-
action: 'LanguageSwitched' | 'PanelToggled' | 'Opened' | 'NavigatedOverrideLink' | 'Sent' | 'ValidationFailed' | 'CodeSampleCopied';
|
|
34
|
+
action: 'LanguageSwitched' | 'PanelToggled' | 'Opened' | 'NavigatedOverrideLink' | 'Sent' | 'ValidationFailed' | 'CodeSampleCopied' | 'TargetServerSwitched';
|
|
30
35
|
operationId?: string;
|
|
31
36
|
operationPath: string;
|
|
32
37
|
operationHttpVerb: string;
|
|
@@ -53,11 +58,15 @@ export interface PanelToggleEvent extends AnalyticsEvent {
|
|
|
53
58
|
operationHttpVerb: string;
|
|
54
59
|
operationSummary?: string;
|
|
55
60
|
}
|
|
61
|
+
export interface TargetServerSwitchedEvent extends AnalyticsEvent {
|
|
62
|
+
serverUrl: string;
|
|
63
|
+
}
|
|
56
64
|
export declare type Events = {
|
|
57
65
|
codeSamplesLanguageSwitch?: (event: CodeSamplesLanguageSwitchedEvent) => void;
|
|
58
66
|
codeSamplesCopy?: (event: CodeSamplesCopiedEvent) => void;
|
|
59
67
|
tryItOpen?: (event: TryItOpenedEvent) => void;
|
|
60
68
|
tryItSent?: (event: TryItOpenedEvent) => void;
|
|
61
69
|
panelToggle?: (event: PanelToggleEvent) => void;
|
|
70
|
+
targetServerSwitch?: (event: TargetServerSwitchedEvent) => void;
|
|
62
71
|
};
|
|
63
72
|
export {};
|
package/lib-esm/events/types.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export var AnalyticsEventType;!function(e){e.CodeSampleLanguageSwitched="CodeSampleLanguageSwitched",e.CodeSampleCopied="CodeSampleCopied",e.OperationServerExpanded="OperationServerExpanded",e.PanelToggle="PanelToggle",e.TryItOpen="TryItOpen",e.TryItSent="TryItSent"}(AnalyticsEventType||(AnalyticsEventType={}));
|
|
1
|
+
export var AnalyticsEventType;!function(e){e.CodeSampleLanguageSwitched="CodeSampleLanguageSwitched",e.CodeSampleCopied="CodeSampleCopied",e.OperationServerExpanded="OperationServerExpanded",e.PanelToggle="PanelToggle",e.TryItOpen="TryItOpen",e.TryItSent="TryItSent",e.TargetServerSwitched="TargetServerSwitched"}(AnalyticsEventType||(AnalyticsEventType={}));
|
|
2
2
|
//# sourceMappingURL=types.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{__assign,__makeTemplateObject}from"tslib";import{jsx as _jsx,Fragment as _Fragment,jsxs as _jsxs}from"react/jsx-runtime";import{observer}from"mobx-react";import{useContext,useCallback}from"react";import{Endpoint}from"../../../../components/Endpoint";import{Badge,H2,MiddlePanel,RightPanel,Row,ShareLink}from"../../common-elements";import styled from"../../styled-components";import{CallbacksList}from"../Callbacks";import{CallbackSamples}from"../CallbackSamples/CallbackSamples";import{ExternalDocumentation}from"../ExternalDocumentation/ExternalDocumentation";import{Extensions}from"../Fields/Extensions";import{Markdown}from"../Markdown";import{Parameters}from"../Parameters/Parameters";import{RequestSamples}from"../RequestSamples/RequestSamples";import{ResponsesList}from"../Responses";import{ResponseSamples}from"../ResponseSamples/ResponseSamples";import{SecurityRequirements}from"../SecurityRequirement/SecurityRequirement";import{StoreContext}from"../StoreBuilder";import{ScrollableContentPanel}from"../../../../components/Panel";import{LayoutVariant}from"../../../../services/store-types";import{RenderHook}from"../RenderHook";import{l}from"../../services/Labels";import{
|
|
1
|
+
import{__assign,__makeTemplateObject}from"tslib";import{jsx as _jsx,Fragment as _Fragment,jsxs as _jsxs}from"react/jsx-runtime";import{observer}from"mobx-react";import{useContext,useCallback}from"react";import{Endpoint}from"../../../../components/Endpoint";import{Badge,H2,MiddlePanel,RightPanel,Row,ShareLink}from"../../common-elements";import styled from"../../styled-components";import{CallbacksList}from"../Callbacks";import{CallbackSamples}from"../CallbackSamples/CallbackSamples";import{ExternalDocumentation}from"../ExternalDocumentation/ExternalDocumentation";import{Extensions}from"../Fields/Extensions";import{Markdown}from"../Markdown";import{Parameters}from"../Parameters/Parameters";import{RequestSamples}from"../RequestSamples/RequestSamples";import{ResponsesList}from"../Responses";import{ResponseSamples}from"../ResponseSamples/ResponseSamples";import{SecurityRequirements}from"../SecurityRequirement/SecurityRequirement";import{StoreContext}from"../StoreBuilder";import{ScrollableContentPanel}from"../../../../components/Panel";import{LayoutVariant}from"../../../../services/store-types";import{RenderHook}from"../RenderHook";import{l}from"../../services/Labels";import{createPanelToggleEvent}from"../../../../events";var templateObject_1,templateObject_2,OperationRow=styled(Row)(templateObject_1||(templateObject_1=__makeTemplateObject(["\n backface-visibility: hidden;\n contain: content;\n overflow: hidden;\n"],["\n backface-visibility: hidden;\n contain: content;\n overflow: hidden;\n"]))),Description=styled.div(templateObject_2||(templateObject_2=__makeTemplateObject(["\n margin-bottom: ","px;\n"],["\n margin-bottom: ","px;\n"])),(function(e){return 4*e.theme.spacing.unit}));export var Operation=observer((function(e){var o,n,t,s=e.operation,i=s.name,a=s.description,r=s.deprecated,p=s.externalDocs,d=s.isWebhook,m=s.httpVerb,c=e.operation,u=e.layout,v=useContext(StoreContext),_=!(!a&&!p),x=null==v?void 0:v.options.hooks,b=null==v?void 0:v.options.events,j=useCallback((function(e){return function(o){var n,t=createPanelToggleEvent({operation:c,isExpanded:o,panelType:e});null===(n=null==b?void 0:b.panelToggle)||void 0===n||n.call(b,t)}}),[b,c]);return _jsxs(OperationRow,__assign({layout:u},{children:[_jsxs(MiddlePanel,__assign({isStacked:u===LayoutVariant.STACKED},{children:[_jsx(RenderHook,{Hook:null==x?void 0:x.BeforeOperation,props:{operation:c}},void 0),_jsxs(H2,{children:[_jsx(ShareLink,{to:c.id},void 0),_jsx(RenderHook,{Hook:null==x?void 0:x.BeforeOperationSummary,props:{operation:c}},void 0),i,_jsx(RenderHook,{Hook:null==x?void 0:x.AfterOperationSummary,props:{operation:c}},void 0),r&&_jsx(Badge,__assign({type:"warning"},{children:"Deprecated"}),void 0),d&&_jsxs(_Fragment,{children:[_jsx(Badge,__assign({type:"primary"},{children:"Webhook "}),void 0),(null==v?void 0:v.options.showWebhookVerb)&&m&&_jsx(Badge,__assign({type:"primary"},{children:m.toUpperCase()}),void 0)]},void 0)]},void 0),(null==v?void 0:v.options.pathInMiddlePanel)&&!d&&_jsx(Endpoint,{operation:c},void 0),_&&_jsxs(Description,{children:[void 0!==a&&_jsx(Markdown,{source:a},void 0),p&&_jsx(ExternalDocumentation,{externalDocs:p},void 0),Object.keys(c.extensions||{}).length?_jsx(Extensions,{extensions:c.extensions},void 0):null]},void 0),_jsx(SecurityRequirements,{securities:c.security},void 0),(null===(o=c.parameters)||void 0===o?void 0:o.length)||c.requestBody?_jsx(ScrollableContentPanel,__assign({header:l("request"),onToggle:j("request"),expanded:null==v?void 0:v.options.expandDefaultRequest},{children:_jsx(Parameters,{parameters:c.parameters,body:c.requestBody},void 0)}),void 0):null,(null===(n=c.responses)||void 0===n?void 0:n.length)?_jsx(ScrollableContentPanel,__assign({header:l("responses"),onToggle:j("responses"),expanded:null==v?void 0:v.options.expandDefaultResponse},{children:_jsx(ResponsesList,{responses:c.responses},void 0)}),void 0):null,(null===(t=c.callbacks)||void 0===t?void 0:t.length)?_jsx(ScrollableContentPanel,__assign({header:l("callbacks")},{children:_jsx(CallbacksList,{callbacks:c.callbacks},void 0)}),void 0):null,_jsx(RenderHook,{Hook:null==x?void 0:x.AfterOperation,props:{operation:c}},void 0)]}),void 0),(null==v?void 0:v.showRightPanel)?_jsxs(RightPanel,__assign({"data-cy":"samples-block"},{children:[!(null==v?void 0:v.options.pathInMiddlePanel)&&!d&&_jsx(Endpoint,{operation:c},void 0),_jsx(RequestSamples,{operation:c},void 0),_jsx(ResponseSamples,{operation:c},void 0),_jsx(CallbackSamples,{callbacks:c.callbacks},void 0)]}),void 0):null]}),void 0)}));
|
|
2
2
|
//# sourceMappingURL=Operation.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{__assign,__rest}from"tslib";import{jsx as _jsx}from"react/jsx-runtime";import{useCallback,useContext,useEffect}from"react";import{observer}from"mobx-react";import{CodePanel}from"../../../../components/Panel";import{TabPanel}from"../../../../components/Tabs";import{SamplesTabs}from"../../../../components/Samples";import{isPayloadSample}from"../../services";import{PayloadSamples}from"../PayloadSamples";import{OptionsContext}from"../OptionsProvider";import{l}from"../../services/Labels";import{createCodeSampleCopyEvent,createLanguageSwitchEvent,
|
|
1
|
+
import{__assign,__rest}from"tslib";import{jsx as _jsx}from"react/jsx-runtime";import{useCallback,useContext,useEffect}from"react";import{observer}from"mobx-react";import{CodePanel}from"../../../../components/Panel";import{TabPanel}from"../../../../components/Tabs";import{SamplesTabs}from"../../../../components/Samples";import{isPayloadSample}from"../../services";import{PayloadSamples}from"../PayloadSamples";import{OptionsContext}from"../OptionsProvider";import{l}from"../../services/Labels";import{createCodeSampleCopyEvent,createLanguageSwitchEvent,createPanelToggleEvent}from"../../../../events";import{CodeSample}from"./CodeSample";import{useCodeSamples}from"./useCodeSamples";export var RequestSamples=observer((function(e){var a=e.operation,o=e.defaultLanguage,t=e.disableHeader,n=(e.content,__rest(e,["operation","defaultLanguage","disableHeader","content"])),s=useContext(OptionsContext),r=s.events,i=s.hideSingleRequestSampleTab,p=s.collapseRequestSamplePanel;useEffect((function(){}),[a.activeServer,a.requestValues]);var m=useCodeSamples(a),d=m.samples,u=m.payload,c=1===d.length&&i,v=useCallback((function(e){var o=e.lang,t=e.title;return function(){var e,n=createCodeSampleCopyEvent({operation:a,label:t,lang:o,type:"request"});null===(e=null==r?void 0:r.codeSamplesCopy)||void 0===e||e.call(r,n)}}),[a,r]);return d.length?_jsx(CodePanel,__assign({dataHeaderTestId:"request-samples",header:t?void 0:l("requestSamples"),onToggle:function(e){var o,t=createPanelToggleEvent({operation:a,isExpanded:e,panelType:"request-samples"});null===(o=null==r?void 0:r.panelToggle)||void 0===o||o.call(r,t)},expanded:!p},{children:_jsx(SamplesTabs,__assign({operation:a,tabs:d,onChange:function(e){var o,t=createLanguageSwitchEvent({operation:a,sample:e});null===(o=null==r?void 0:r.codeSamplesLanguageSwitch)||void 0===o||o.call(r,t)},hidden:c,defaultLanguage:o,id:a.id+"/request-tab"},{children:d.map((function(e){return _jsx(TabPanel,{children:isPayloadSample(e)?_jsx(PayloadSamples,__assign({content:e.requestBodyContent,operation:a,onCopyClick:v(e)},n),void 0):_jsx(CodeSample,__assign({lang:e.lang,source:e.source,externalSample:e,content:null==u?void 0:u.requestBodyContent,operation:a,onCopyClick:v(e)},n),void 0)},e.key+a.id)}))}),void 0)}),void 0):null}));
|
|
2
2
|
//# sourceMappingURL=RequestSamples.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{__assign}from"tslib";import{jsx as _jsx}from"react/jsx-runtime";import{useContext,useCallback}from"react";import{CodePanel}from"../../../../components/Panel";import{CollapsingTabs,TabPanel}from"../../../../components/Tabs";import{OptionsContext}from"../OptionsProvider";import{PayloadSamples}from"../PayloadSamples";import{l}from"../../services/Labels";import{createCodeSampleCopyEvent,
|
|
1
|
+
import{__assign}from"tslib";import{jsx as _jsx}from"react/jsx-runtime";import{useContext,useCallback}from"react";import{CodePanel}from"../../../../components/Panel";import{CollapsingTabs,TabPanel}from"../../../../components/Tabs";import{OptionsContext}from"../OptionsProvider";import{PayloadSamples}from"../PayloadSamples";import{l}from"../../services/Labels";import{createCodeSampleCopyEvent,createPanelToggleEvent}from"../../../../events";export var ResponseSamples=function(e){var o=e.operation,n=useContext(OptionsContext),a=n.events,s=n.collapseResponseSamplePanel,t=o.responses.filter((function(e){var o,n;return null!==(n=null===(o=e.content)||void 0===o?void 0:o.hasSample)&&void 0!==n&&n})),r=useCallback((function(){var e,n=createCodeSampleCopyEvent({operation:o,type:"response"});null===(e=null==a?void 0:a.codeSamplesCopy)||void 0===e||e.call(a,n)}),[o,a]);if(!t.length)return null;var i=t.map((function(e){var o=e.code;return{key:o,title:o}}));return _jsx(CodePanel,__assign({dataHeaderTestId:"response-samples",header:l("responseSamples"),onToggle:function(e){var n,l=createPanelToggleEvent({operation:o,isExpanded:e,panelType:"response-samples"});null===(n=null==a?void 0:a.panelToggle)||void 0===n||n.call(a,l)},expanded:!s},{children:_jsx(CollapsingTabs,__assign({tabs:i,operation:o},{children:t.map((function(e){return _jsx(TabPanel,__assign({value:e.code},{children:_jsx("div",{children:_jsx(PayloadSamples,{content:e.content,onCopyClick:r},void 0)},void 0)}),e.code)}))}),void 0)}),void 0)};
|
|
2
2
|
//# sourceMappingURL=ResponseSamples.js.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@redocly/reference-docs",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.41.1",
|
|
4
4
|
"description": "Redocly Reference Docs",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"module": "lib-esm/index.js",
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
"reference-docs": "bin/cli/commands/redocly-docs-cli.min.js"
|
|
16
16
|
},
|
|
17
17
|
"dependencies": {
|
|
18
|
-
"@redocly/openapi-core": "1.0.0-beta.
|
|
18
|
+
"@redocly/openapi-core": "1.0.0-beta.131",
|
|
19
19
|
"@redocly/vscode-json-languageservice": "3.4.9",
|
|
20
20
|
"@wojtekmaj/enzyme-adapter-react-17": "^0.6.2",
|
|
21
21
|
"codemirror": "^5.65.0",
|