@redocly/reference-docs 2.43.3 → 2.43.5

package/lib-browser/services/ProMenu.d.ts

@@ -0,0 +1,105 @@
+import type { IMenuItem, ScrollService, HistoryService, MenuItemType, SchemaModel, SpecStore } from '../redoc-lib';
+import type { RedocProNormalizedOptions } from './ProStore';
+import { VersionedSpecStore } from './VersionedSpecStore';
+export declare type ExtendedMenuItem = Omit<IMenuItem, 'type'> & {
+    type: MenuItemType | 'spec';
+    linkable?: boolean;
+    href?: string;
+};
+/**
+ * Stores all side-menu related information
+ */
+export declare class ProMenu {
+    definition: SpecStore | VersionedSpecStore;
+    scroll: ScrollService;
+    options: RedocProNormalizedOptions;
+    history: HistoryService;
+    /**
+     * Statically try update scroll position
+     * Used before hydrating from server-side rendered html to scroll page faster
+     */
+    static updateOnHistory(id: string | undefined, scroll: ScrollService): void;
+    flatItems: (ExtendedMenuItem & IMenuItem)[];
+    items: (ExtendedMenuItem & IMenuItem)[];
+    activeRenderItemIdx: number;
+    renderItems: ExtendedMenuItem[];
+    /**
+     * active item absolute index (when flattened). -1 means nothing is selected
+     */
+    activeItemIdx: number;
+    /**
+     * whether sidebar with menu is opened or not
+     */
+    sideBarOpened: boolean;
+    private _unsubscribe;
+    private _hashUnsubscribe;
+    /**
+     *
+     * @param definition [SpecStore](#SpecStore) which contains page content structure
+     * @param scroll scroll service instance used by this menu
+     * @param options normalized options
+     * @param history
+     */
+    constructor(definition: SpecStore | VersionedSpecStore, scroll: ScrollService, options: RedocProNormalizedOptions, history: HistoryService);
+    subscribe(): void;
+    toggleSidebar(): void;
+    closeSidebar(): void;
+    /**
+     * get section/operation DOM Node related to the item or null if it doesn't exist
+     * @param idx item absolute index
+     */
+    getElementAt(idx: number): Element | null;
+    /**
+     * get section/operation DOM Node related to the item or if it is group item, returns first item of the group
+     * @param idx item absolute index
+     */
+    getElementAtOrFirstChild(idx: number): Element | null;
+    /**
+     * current active item
+     */
+    get activeItem(): IMenuItem;
+    getItemById: (id: string) => (ExtendedMenuItem & IMenuItem) | undefined;
+    /**
+     * update active items on initial page load
+     * @param currentId
+     */
+    initOnHistory: (currentId?: string) => void;
+    /**
+     * update active items on hash change
+     * @param currentId
+     */
+    updateOnHistory: (currentId?: string) => void;
+    updateVersionOnHistory: (id: string) => void;
+    updateItemsByVersionChange(updateLocation?: boolean, currentItemId?: string): void;
+    buildRenderItems(idx: number): ExtendedMenuItem[];
+    /**
+     * activate menu item
+     * @param item item to activate
+     * @param updateLocation [true] whether to update location
+     * @param rewriteHistory [false] whether to rewrite browser history (do not create new entry)
+     * @param fieldFullPath
+     */
+    activateBase(item: IMenuItem | undefined, updateLocation?: boolean, rewriteHistory?: boolean, fieldFullPath?: string): void;
+    activate(item: ExtendedMenuItem | undefined, updateLocation?: boolean, rewriteHistory?: boolean, scroll?: boolean, fieldFullPath?: string): void;
+    /**
+     * update active items on scroll
+     * @param isScrolledDown whether last scroll was downside
+     */
+    updateOnScroll: (isScrolledDown: boolean) => void;
+    activateField(pathArr: string[], schema?: SchemaModel): void;
+    /**
+     * makes item and all the parents not active
+     * @param item item to deactivate
+     */
+    deactivate(item: IMenuItem | undefined): void;
+    /**
+     * activate menu item and scroll to it
+     * @see MenuStore.activate
+     */
+    activateAndScroll(item?: IMenuItem | ExtendedMenuItem, updateLocation?: boolean, rewriteHistory?: boolean, currentId?: string): void;
+    /**
+     * scrolls to active section
+     */
+    scrollToActive(fieldPath?: string): void;
+    dispose(): void;
+}

package/lib-browser/services/ProMenu.js

@@ -0,0 +1,2 @@
+import{__decorate}from"tslib";import{action,observable,makeObservable}from"mobx";import{flattenByProp,querySelector,GROUP_DEPTH,escapeHTMLAttrChars}from"../redoc-lib";import{SECTION_ATTR}from"../redoc-lib/src/services/constants";import{history as historyInst}from"../redoc-lib/src/services/HistoryService";import{VersionedSpecStore}from"./VersionedSpecStore";export class ProMenu{constructor(e,t,i,s){Object.defineProperty(this,"definition",{enumerable:!0,configurable:!0,writable:!0,value:e}),Object.defineProperty(this,"scroll",{enumerable:!0,configurable:!0,writable:!0,value:t}),Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:i}),Object.defineProperty(this,"history",{enumerable:!0,configurable:!0,writable:!0,value:s}),Object.defineProperty(this,"flatItems",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"items",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"activeRenderItemIdx",{enumerable:!0,configurable:!0,writable:!0,value:-1}),Object.defineProperty(this,"renderItems",{enumerable:!0,configurable:!0,writable:!0,value:[]}),Object.defineProperty(this,"activeItemIdx",{enumerable:!0,configurable:!0,writable:!0,value:-1}),Object.defineProperty(this,"sideBarOpened",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"_unsubscribe",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"_hashUnsubscribe",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"getItemById",{enumerable:!0,configurable:!0,writable:!0,value:e=>this.flatItems.find((t=>t.id===e))}),Object.defineProperty(this,"initOnHistory",{enumerable:!0,configurable:!0,writable:!0,value:(e=this.history.currentId)=>{const[t]=e.split(this.options.deepLinkPrefix);if(!t)return;const i=this.flatItems.find((e=>e.id===t));i&&(this.activate(i,!1,!1,!1,e),i.active=!1)}}),Object.defineProperty(this,"updateOnHistory",{enumerable:!0,configurable:!0,writable:!0,value:(e=this.history.currentId)=>{const[t]=e.split(this.options.deepLinkPrefix);if(!t)return;const i=this.flatItems.find((e=>e.id===t));i?this.activateAndScroll(i,!1,void 0,e):(this.scroll.prevOffsetY=0,this.scroll.scrollIntoViewBySelector(`[${SECTION_ATTR}="${escapeHTMLAttrChars(t)}"]`))}}),Object.defineProperty(this,"updateVersionOnHistory",{enumerable:!0,configurable:!0,writable:!0,value:e=>{if(!("versionsInfo"in this.definition))return;const[t]=e.split("/");let i=this.definition.versionsInfo.findIndex((e=>e.id===t));i<0&&(i=this.definition.versionsInfo.findIndex((e=>e.isDefault))),this.definition.activeVersionIdx!==i&&(this.definition.changeVersion(i<0?0:i),this.updateItemsByVersionChange(!1,e))}}),Object.defineProperty(this,"updateOnScroll",{enumerable:!0,configurable:!0,writable:!0,value:e=>{const t=e?1:-1;let i=this.activeItemIdx;for(;(-1!==i||e)&&!(i>=this.flatItems.length-1&&e);){if(e){let e=!1;const t=this.flatItems[i+1];switch(this.options.pagination){case"section":e=t&&("spec"===t.type||"group"===t.type||"tag"===t.type);break;case"item":e="section"!==(null==t?void 0:t.type)}const s=this.getElementAt(i+1);if(-1===i&&"tag"===this.flatItems[0].type&&(e=!1),this.scroll.isElementBellow(s)||e)break}else{const e=this.flatItems[i]&&this.flatItems[i].type,t="section"===this.options.pagination&&("spec"===e||"group"===e||"tag"===e)||"item"===this.options.pagination&&"section"!==e,s=this.getElementAt(i);if(!s||this.scroll.isElementAbove(s)||t)break}i+=t}const s=this.flatItems[i];"none"===this.options.pagination||"section"===this.options.pagination?s&&s.active||this.activate(s,!0,!0,!1):s&&"section"===s.type&&(s.active||this.activate(s,!0,!0,!1))}}),makeObservable(this),this.items=e.contentItems,this.flatItems=flattenByProp(this.items||[],"items"),this.flatItems.forEach(((e,t)=>e.absoluteIdx=t)),i.disableSidebar||this.subscribe(),this.flatItems.forEach(((e,t)=>normalizeItem(e,t,i.pagination,this.definition instanceof VersionedSpecStore,this.history))),this.renderItems=this.buildRenderItems(0),this.activeItemIdx=-1,this.activeRenderItemIdx=-1,this.definition instanceof VersionedSpecStore&&this.history.subscribe(this.updateVersionOnHistory)}static updateOnHistory(e=historyInst.currentId,t){e&&t.scrollIntoViewBySelector(`[${SECTION_ATTR}="${escapeHTMLAttrChars(e)}"]`)}subscribe(){this._unsubscribe=this.scroll.subscribe(this.updateOnScroll),this._hashUnsubscribe=this.history.subscribe(this.updateOnHistory)}toggleSidebar(){this.sideBarOpened=!this.sideBarOpened}closeSidebar(){this.sideBarOpened=!1}getElementAt(e){const t=this.flatItems[e];return t&&querySelector(`[${SECTION_ATTR}="${escapeHTMLAttrChars(t.id)}"]`)||null}getElementAtOrFirstChild(e){let t=this.flatItems[e];return t&&"group"===t.type&&(t=t.items[0]),t&&querySelector(`[${SECTION_ATTR}="${escapeHTMLAttrChars(t.id)}"]`)||null}get activeItem(){return this.flatItems[this.activeItemIdx]||void 0}updateItemsByVersionChange(e,t){if(!("versionsInfo"in this.definition))return;const i=this.activeItem&&this.activeItem.active?this.activeItem.absoluteIdx:-1;t=t&&withoutVersion(t)||this.activeItem&&this.activeItem.active&&withoutVersion(this.activeItem.id)||"",this.deactivate(this.activeItem),this.items=this.definition.contentItems,this.flatItems=flattenByProp(this.items||[],"items"),this.flatItems.forEach(((e,t)=>normalizeItem(e,t,this.options.pagination,this.definition instanceof VersionedSpecStore,this.history)));const s=t?(this.flatItems.find((e=>withoutVersion(e.id)===t))||{absoluteIdx:-1}).absoluteIdx:-1;if(-1!==s&&"none"!==this.options.pagination||(this.renderItems=this.buildRenderItems(0)),this.activeItemIdx=-1,-1!==s)this.activate(this.flatItems[s],e);else if(-1!==i)this.activateAndScroll(this.flatItems[0],e);else if(e){const e=this.definition.versionsInfo[this.definition.activeVersionIdx];if(!this.history.currentId&&e.isDefault)return;this.history.replace(e.id)}}buildRenderItems(e){if("none"===this.options.pagination)return this.items;let t=this.flatItems[e];if(t||(t=this.flatItems[0]),"spec"===t.type)return this.buildRenderItems(e+1);if("section"===t.type){const e=[],i=getParentOfType(t,"tag");if("section"===this.options.pagination&&i)return[i];if("item"===this.options.pagination&&i)return[Object.assign(Object.assign({},i),{items:getLeadingSectionItems(i)})];const s=getParentSpecItem(t),n=(null==s?void 0:s.items)||this.items;for(let t=0;t<n.length&&"section"===n[t].type;t++)e.push(n[t]);return e}switch(this.options.pagination){case"section":if(("operation"===t.type||"schema"===t.type)&&t.parent)return[t.parent];if("group"!==t.type)return[t];case"item":return"operation"===t.type||"schema"===t.type?[t]:[Object.assign(Object.assign({},t),{items:getLeadingSectionItems(t)})];default:return[]}}activateBase(e,t=!0,i=!1,s){var n,o,r,a,l;if((null===(n=this.activeItem)||void 0===n?void 0:n.id)===(null==e?void 0:e.id)&&!s)return t&&e&&this.history.replace(encodeURI(e.id),i),void(e&&!e.active&&e.activate());if(e&&"group"===e.type)return;if(this.deactivate(this.activeItem),!e)return void this.history.replace("",i);if(e.depth<=GROUP_DEPTH)return;this.activeItemIdx=e.absoluteIdx,t&&this.history.replace(encodeURI(e.id),i),e.activate(),e.expand();const c=new URLSearchParams(s),d="request"===c.get("t"),h="response"===c.get("t"),u=c.get("c"),p=c.get("ct"),f=c.get("in"),m=c.get("path"),v=(null==m?void 0:m.split(this.options.deepLinkSeparator))||[],b=e;if(f){let e=b.parameters;for(const t of v){const i=null==e?void 0:e.find((e=>e.name===t));null==i||i.expand(),e=null===(o=null==i?void 0:i.schema)||void 0===o?void 0:o.fields}}else if(d){const e=null===(r=b.requestBody)||void 0===r?void 0:r.content;null===(a=b.activateMimeName)||void 0===a||a.call(b,p||b.activeMimeName),setTimeout((()=>{var t;return this.activateField(v,null===(t=null==e?void 0:e.active)||void 0===t?void 0:t.schema)}),0)}else if(h){const e=b.responses.find((e=>e.code===u));(null==e?void 0:e.expanded)||null==e||e.expand(),null===(l=b.activateMimeName)||void 0===l||l.call(b,p||b.activeMimeName),setTimeout((()=>{var t,i;return this.activateField(v,null===(i=null===(t=null==e?void 0:e.content)||void 0===t?void 0:t.active)||void 0===i?void 0:i.schema)}),0)}}activate(e,t=!0,i=!1,s=!0,n){if("none"===this.options.pagination)return this.activateBase(e,t,i,n),void(!e&&this.definition instanceof VersionedSpecStore&&this.history.replace(this.definition.currentVersionId,!0));if("group"!==(null==e?void 0:e.type)){if(e&&"item"===this.options.pagination&&"tag"===e.type&&!e.description){if(e.expanded)return void e.collapse();e.expand(),e=this.flatItems[e.absoluteIdx+1]}if(this.activateBase(e,e&&t,i,n),this.activeRenderItemIdx=e?e.absoluteIdx:this.activeRenderItemIdx,this.activeRenderItemIdx>=0){const e=this.buildRenderItems(this.activeRenderItemIdx);e.some(((e,t)=>e.id!==this.renderItems[t].id))&&(this.renderItems=e),this.renderItems[0]&&(this.activeRenderItemIdx=this.renderItems[0].absoluteIdx)}s&&setTimeout((()=>this.scrollToActive())),!e&&this.definition instanceof VersionedSpecStore&&this.history.replace(this.definition.currentVersionId,!0)}}activateField(e,t){var i;for(let s=0;s<e.length-1;s++){const n=e[s],o=s===e.length-1;if((null==t?void 0:t.hasType("array"))&&(null==t?void 0:t.items)&&(t=null==t?void 0:t.items),null==t?void 0:t.oneOf){const e=Number(n);if(isNaN(e))return;null==t||t.activateOneOf(e),t=null==t?void 0:t.oneOf[e];continue}(null==t?void 0:t.hasType("array"))&&(null==t?void 0:t.items)&&(t=null==t?void 0:t.items);const r=null===(i=null==t?void 0:t.fields)||void 0===i?void 0:i.find((e=>e.name===n));o||null==r||r.expand(),t=null==r?void 0:r.schema}}deactivate(e){if(void 0!==e)for(e.deactivate();void 0!==e;)e.collapse(),e=e.parent}activateAndScroll(e,t,i,s=""){const[,n]=s.split(this.options.deepLinkPrefix),o=e&&this.getItemById(e.id)||e;this.activate(o,t,i,!1,n),this.scrollToActive(n?s:""),o&&o.items.length||this.closeSidebar()}scrollToActive(e){e?setTimeout((()=>this.scroll.scrollIntoViewBySelector(`[${SECTION_ATTR}="${escapeHTMLAttrChars(e)}"]`)),0):this.scroll.scrollIntoView(this.getElementAt(this.activeItemIdx))}dispose(){var e,t;null===(e=this._unsubscribe)||void 0===e||e.call(this),null===(t=this._hashUnsubscribe)||void 0===t||t.call(this)}}function withoutVersion(e){return e.split("/").slice(1).join("/")}function getParentSpecItem(e){for(;e;){if("spec"===e.type)return e;e=e.parent}}function getParentOfType(e,t){if(e&&e.parent)return e.parent.type===t?e.parent:getParentOfType(e.parent,t)}function getLeadingSectionItems(e){const t=[];for(const i of e.items){if("section"!==i.type)break;t.push(i)}return t}function normalizeItem(e,t,i,s,n){if(e.absoluteIdx=t,"none"!==i){const t=getParentOfType(e,"tag");if(e.parent&&t&&!("_id_normalized"in e)){if(s){const[i,s]=e.id.split("/"),n=withoutVersion(e.id);if("operation"===e.type&&!s.startsWith("operation"))return;e.id=i+"/"+withoutVersion(t.id)+"/"+n}else{if("operation"===e.type&&!e.id.startsWith("operation"))return;e.id=t.id+"/"+e.id}e._id_normalized=!0}}"group"!==e.type&&(e.href=n.linkForId(e.id))}__decorate([observable],ProMenu.prototype,"flatItems",void 0),__decorate([observable],ProMenu.prototype,"items",void 0),__decorate([observable],ProMenu.prototype,"activeRenderItemIdx",void 0),__decorate([observable.ref],ProMenu.prototype,"renderItems",void 0),__decorate([observable],ProMenu.prototype,"activeItemIdx",void 0),__decorate([observable],ProMenu.prototype,"sideBarOpened",void 0),__decorate([action],ProMenu.prototype,"toggleSidebar",null),__decorate([action],ProMenu.prototype,"closeSidebar",null),__decorate([action],ProMenu.prototype,"activateBase",null),__decorate([action],ProMenu.prototype,"activate",null),__decorate([action.bound],ProMenu.prototype,"activateAndScroll",null);
+//# sourceMappingURL=ProMenu.js.map

package/lib-browser/services/ProStore.d.ts

@@ -0,0 +1,148 @@
+import type { IValueDidChange } from 'mobx';
+import type { ContentItemModel, IMenuItem, OpenAPIDefinition, OpenAPIExternalDocumentation, OperationModel, RedocRawOptions, SearchStore } from '../redoc-lib';
+import type { SearchResultMeta } from './SearchStore';
+import type { SpecVersions } from './VersionedSpecStore';
+import type { LicenseInfo } from './check';
+import type { CodeSamplesConfig, Languages } from './code-samples/';
+import type { ExternalLink, MarkdownItemsPagination, Normalized, Pagination, RedocProTheme } from './types';
+import type { Events } from '../events';
+import { MarkerService, RedocNormalizedOptions, SpecStore } from '../redoc-lib';
+import { ProMenu } from './ProMenu';
+import { VersionedSpecStore } from './VersionedSpecStore';
+import { LayoutVariant } from './store-types';
+import { SideNavStyle } from './types';
+export declare type RedocProUserOptionsExt = {
+    licenseKey?: string;
+    searchMode?: 'default' | 'path-only';
+    searchOperationTitleBoost?: number | string;
+    searchTagTitleBoost?: number | string;
+    searchFieldLevelBoost?: number | string;
+    searchAutoExpand?: boolean;
+    sideNavStyle?: SideNavStyle;
+    /** @deprecated use hideTryItPanel instead */
+    showConsole?: boolean;
+    hideTryItPanel?: boolean;
+    hideLogo?: boolean;
+    whiteLabel?: boolean;
+    disableErrorBoundary?: boolean;
+    hideInfoSection?: boolean;
+    pagination?: Pagination;
+    showNextButton?: boolean;
+    disableSidebar?: boolean;
+    skipBundleAndConvert?: boolean;
+    /** @deprecated */
+    routingStrategy?: 'hash' | 'browser';
+    routingBasePath?: string;
+    theme?: RedocProTheme;
+    downloadDefinitionUrl?: string;
+    ctrlFHijack?: boolean;
+    unstable_externalDescription?: string;
+    unstable_hideServerUrlInTryIt?: boolean;
+    linkForId?: ((id: string) => string) | null;
+    generateDeepLink?: ((fieldFragment: string, operationLink: any) => string) | undefined | null;
+    onDeepLinkClick?: ((link: string) => void) | undefined | null;
+    requestInterceptor?: ((req: Request, operation: OperationModel) => void) | undefined | null;
+    oAuth2RedirectURI?: string | null;
+    corsProxyUrl?: string | null;
+    authCorsProxyUrl?: string | null;
+    disablePaginationLoadingAnimation?: boolean | null;
+    generateCodeSamples?: CodeSamplesConfig;
+    showRightPanelToggle?: boolean;
+    showChangeLayoutButton?: boolean;
+    layout?: LayoutVariant;
+    defaultSampleLanguage?: Languages | string;
+    hideRightPanel?: boolean;
+    events?: Events;
+    deepLinkSeparator?: string;
+    deepLinkPrefix?: string;
+    disableDeepLinks?: boolean;
+    sidebarLinks?: {
+        beforeInfo?: Array<ExternalLink>;
+        end?: Array<ExternalLink>;
+    };
+    searchMaxDepth?: number;
+};
+declare type RedocProOptionsInternalExt = Omit<RedocProUserOptionsExt, 'hideTryItPanel'> & {
+    markdownItemsPagination?: MarkdownItemsPagination;
+};
+export declare type RedocProRawOptions = RedocRawOptions & RedocProUserOptionsExt;
+export declare type RedocProNormalizedOptions = RedocNormalizedOptions & Normalized<RedocProOptionsInternalExt>;
+export interface ProStoreState {
+    menu: {
+        activeItemIdx: number;
+    };
+    definition: {
+        url?: string;
+        data: GenericObject;
+        activeVersionIdx?: number;
+    };
+    searchIndex?: number;
+    tryItOperationId?: string;
+    options: RedocProRawOptions;
+    searchIndexPath?: string;
+    searchIndexExport?: string;
+}
+export declare class NestingGroup implements IMenuItem {
+    id: string;
+    absoluteIdx?: number;
+    name: string;
+    description?: string;
+    type: 'group';
+    linkable: boolean;
+    items: ContentItemModel[];
+    parent?: NestingGroup;
+    externalDocs?: OpenAPIExternalDocumentation;
+    active: boolean;
+    expanded: boolean;
+    depth: number;
+    level: number;
+    constructor(id: string, items: ContentItemModel[], name?: string, linkable?: boolean);
+    activate(): void;
+    expand(): void;
+    collapse(): void;
+    deactivate(): void;
+}
+export declare class ProStore {
+    rawOptions: RedocProRawOptions;
+    options: RedocProNormalizedOptions;
+    menu: ProMenu;
+    definition: SpecStore | VersionedSpecStore;
+    marker: MarkerService;
+    private readonly scroll;
+    private readonly disposer;
+    search?: SearchStore<SearchResultMeta>;
+    tryItOperation?: OperationModel;
+    showRightPanel: boolean;
+    layout: LayoutVariant;
+    activeSampleLanguage: string;
+    isLoading: boolean;
+    l: Promise<LicenseInfo>;
+    constructor(spec: OpenAPIDefinition | SpecVersions | Array<{
+        title: string;
+        url: string;
+    }> | string, specUrl?: string, options?: RedocProRawOptions, createIndex?: boolean);
+    initProOptions(options: RedocProRawOptions): void;
+    initSearch(options: RedocProNormalizedOptions, createIndex: boolean): void;
+    onDidMount(): void;
+    toggleRightPanel(value?: boolean): void;
+    toggleLayout(layout?: LayoutVariant): void;
+    disableConsole(): void;
+    enableConsole(): void;
+    tryItOut(operation?: OperationModel): void;
+    setActiveSampleLanguage(language: string): void;
+    activateSampleLanguage(language: string): void;
+    startLoader(): void;
+    stopLoader(): void;
+    dereferenceSpecForTryIt(operation: OperationModel): Promise<GenericObject>;
+    observeAllAndRemark(): void;
+    remark(change: IValueDidChange): void;
+    /**
+     * deserialize store
+     * **SUPER HACKY AND NOT OPTIMAL IMPLEMENTATION**
+     */
+    static fromJS(state: ProStoreState): ProStore;
+    toJS(): Promise<ProStoreState>;
+    dispose(): void;
+    private updateMarkOnMenu;
+}
+export {};

package/lib-browser/services/ProStore.js

@@ -0,0 +1,2 @@
+import{__decorate}from"tslib";import{action,makeObservable,observable,observe}from"mobx";import{bundle,Config}from"@redocly/openapi-core";import{bind,debounce}from"decko";import{createParsedDocument,IS_BROWSER,MarkerService,RedocNormalizedOptions,SCHEMA_DEFINITION_JSX_NAME,SchemaDefinition,ScrollService,SECURITY_DEFINITIONS_COMPONENT_NAME,SECURITY_DEFINITIONS_JSX_NAME,SpecStore}from"../redoc-lib";import{PullRight,RedocResponse}from"../components/pluggable";import{fromLocalStorage,fromSessionStorage,getWindowReferenceOptions,setGlobalStore,toLocalStorage,toSessionStorage}from"../utils";import{SecurityDefs}from"../redoc-lib/src/components/SecurityRequirement/SecurityDefs";import{WindowReferenceOptions}from"../types";import{FakeHistoryService,ProHashHistoryService,PushStateHistoryService}from"./history";import{ProMenu}from"./ProMenu";import{DeepSearchStore,DEFAULT_SEARCH_MAX_DEPTH,RemoteSearch}from"./SearchStore";import{extendTheme}from"./extendTheme";import{VersionedSpecStore}from"./VersionedSpecStore";import parseToken from"./check";import{normalizePath}from"./utils";import{LayoutVariant}from"./store-types";import{SideNavStyle}from"./types";const global="undefined"==typeof window?{__REDOCLY_SEARCH_URL:void 0}:window;export class NestingGroup{constructor(e,t,i,o){Object.defineProperty(this,"id",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"absoluteIdx",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"name",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"description",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"type",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"linkable",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"items",{enumerable:!0,configurable:!0,writable:!0,value:[]}),Object.defineProperty(this,"parent",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"externalDocs",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"active",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"expanded",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"depth",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"level",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),makeObservable(this),this.id="section/"+e,this.type="nesting-group",this.name=i||"",this.level=1,this.depth=1,this.description="",this.parent=void 0,this.expanded=!1,this.items=t,this.linkable=!!o,t.forEach((e=>e.parent=this)),increaseDepthDeep(t)}activate(){this.active=!0}expand(){this.expanded=!0,this.parent&&this.parent.expand()}collapse(){this.expanded=!1}deactivate(){this.active=!1}}function increaseDepthDeep(e){Array.isArray(e)&&e.forEach((e=>{e.depth++,e.parent&&"group"===e.parent.type&&(e.depth=e.parent.depth),increaseDepthDeep(e.items)}))}__decorate([observable],NestingGroup.prototype,"active",void 0),__decorate([observable],NestingGroup.prototype,"expanded",void 0),__decorate([action],NestingGroup.prototype,"activate",null),__decorate([action],NestingGroup.prototype,"expand",null),__decorate([action],NestingGroup.prototype,"collapse",null),__decorate([action],NestingGroup.prototype,"deactivate",null);export class ProStore{constructor(e,t,i={},o=!0){Object.defineProperty(this,"rawOptions",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"menu",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"definition",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"marker",{enumerable:!0,configurable:!0,writable:!0,value:new MarkerService}),Object.defineProperty(this,"scroll",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"disposer",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"search",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"tryItOperation",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"showRightPanel",{enumerable:!0,configurable:!0,writable:!0,value:!0}),Object.defineProperty(this,"layout",{enumerable:!0,configurable:!0,writable:!0,value:fromLocalStorage("layoutVariant")||LayoutVariant.THREE_PANEL}),Object.defineProperty(this,"activeSampleLanguage",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"isLoading",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"l",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),makeObservable(this),this.initProOptions(i),IS_BROWSER&&(this.l=parseToken(i.licenseKey),this.l.then((e=>{e.valid&&e.allowed&&!e.expired||e.local||e.plugin||(this.menu.items=[],this.menu.flatItems=this.menu.flatItems.slice(0,1),this.menu.renderItems=[])})));const n="object"==typeof e&&"versions"in e,r=this.options.disableSidebar?new FakeHistoryService(this.options):"browser"===this.options.routingStrategy?new PushStateHistoryService(this.options,n):new ProHashHistoryService(this.options,n);this.definition=n?new VersionedSpecStore(e,this.options,r.currentId.split("/")[0]):new SpecStore(e,t,this.options),i.downloadDefinitionUrl&&(this.definition.info.downloadFileName=""),this.scroll=new ScrollService(this.options),this.options.disableSidebar||ProMenu.updateOnHistory(r.currentId,this.scroll),this.menu=new ProMenu(this.definition,this.scroll,this.options,r),this.menu.initOnHistory(),this.options.disableSearch||this.initSearch(this.options,o),this.disposer=observe(this.menu,"none"===this.options.pagination?"activeItemIdx":"activeRenderItemIdx",(e=>{setTimeout((()=>this.updateMarkOnMenu(e.newValue)))})),setGlobalStore(this)}initProOptions(e){var t,i,o,n,r,s;e=deepClone(e),this.rawOptions=extendTheme(e),this.options=new RedocNormalizedOptions(this.rawOptions,DEFAULT_OPTIONS),null!=this.rawOptions.showConsole&&console.warn('"showConsole" option is deprecated. Please, use "hideTryItPanel" instead.'),this.options.showConsole=null!=this.rawOptions.hideTryItPanel?!this.rawOptions.hideTryItPanel:null===(t=this.rawOptions.showConsole)||void 0===t||t,this.options.hideRightPanel=null!==(i=this.rawOptions.hideRightPanel)&&void 0!==i&&i,this.showRightPanel=!this.options.hideRightPanel,this.options.showRightPanelToggle=null===(o=this.rawOptions.showRightPanelToggle)||void 0===o||o,this.options.showChangeLayoutButton=null===(n=this.rawOptions.showChangeLayoutButton)||void 0===n||n,this.options.layout=this.rawOptions.layout||LayoutVariant.THREE_PANEL,this.options.defaultSampleLanguage=this.rawOptions.defaultSampleLanguage||"",this.options.deepLinkSeparator=this.rawOptions.deepLinkSeparator||"/",this.options.deepLinkPrefix=this.rawOptions.deepLinkPrefix||"!",this.options.disableDeepLinks=this.rawOptions.disableDeepLinks||!1,this.options.sideNavStyle=this.rawOptions.sideNavStyle||SideNavStyle.SummaryOnly,this.options.whiteLabel=!!this.rawOptions.whiteLabel,this.options.hideLogo=!!this.rawOptions.hideLogo,this.options.hideInfoSection=!!this.rawOptions.hideInfoSection,this.options.oAuth2RedirectURI=this.rawOptions.oAuth2RedirectURI||null,this.options.unstable_hideServerUrlInTryIt=this.rawOptions.unstable_hideServerUrlInTryIt||!1,this.options.oAuth2RedirectURI=this.rawOptions.oAuth2RedirectURI||null,this.options.events=this.rawOptions.events||{},this.options.mockServer=(null===(r=this.rawOptions.mockServer)||void 0===r?void 0:r.url)?{url:this.rawOptions.mockServer.url,position:this.rawOptions.mockServer.position||"first",description:this.rawOptions.mockServer.description||"Mock server"}:null,this.options.corsProxyUrl=this.rawOptions.corsProxyUrl?addTrailingSlash(this.rawOptions.corsProxyUrl):null,this.options.authCorsProxyUrl=this.rawOptions.authCorsProxyUrl?addTrailingSlash(this.rawOptions.authCorsProxyUrl):null,this.options.theme.scrollYOffset=this.options.scrollYOffset,this.options.linkForId=this.rawOptions.linkForId||getWindowReferenceOptions(WindowReferenceOptions.LINK_FOR_ID)||null,this.options.generateDeepLink=this.rawOptions.generateDeepLink||getWindowReferenceOptions(WindowReferenceOptions.GENERATE_DEEP_LINK)||null,this.options.onDeepLinkClick=this.rawOptions.onDeepLinkClick||getWindowReferenceOptions(WindowReferenceOptions.ON_DEEP_LINK_CLICK)||null,this.options.requestInterceptor=this.rawOptions.requestInterceptor||getWindowReferenceOptions(WindowReferenceOptions.REQUEST_INTERCEPTOR)||null,this.options.sidebarLinks=this.rawOptions.sidebarLinks||{};const a="object"==typeof this.rawOptions.layout?this.rawOptions.layout:null;if(this.options.pagination=this.rawOptions.pagination||"none",this.options.routingStrategy=void 0!==this.rawOptions.routingStrategy?this.rawOptions.routingStrategy:"none"===this.options.pagination?"hash":"browser",!(null===(s=this.rawOptions)||void 0===s?void 0:s.pagination)&&(null==a?void 0:a.scope))switch(console.warn('"layout.scope" and "routingStrategy" settings are deprecated. Please, use "pagination" instead.'),null==a?void 0:a.scope){case"all":default:this.options.pagination="none",this.options.routingStrategy="hash";break;case"section":this.options.pagination="section",this.options.routingStrategy="browser";break;case"item":this.options.pagination="item",this.options.routingStrategy="browser"}this.options.markdownItemsPagination="none",!1!==this.rawOptions.showNextButton&&(this.options.showNextButton=!0),this.options.disableSidebar=!!e.disableSidebar,this.options.disableSidebar&&(this.options.theme.sidebar.width="0px"),this.options.skipBundleAndConvert=!!e.skipBundleAndConvert,this.options.routingBasePath=e.routingBasePath&&normalizePath(e.routingBasePath)||"",this.options.searchAutoExpand=!1!==e.searchAutoExpand,this.options.searchMode=e.searchMode||"default",this.options.ctrlFHijack=void 0===e.ctrlFHijack||e.ctrlFHijack,this.options.disablePaginationLoadingAnimation=!!e.disablePaginationLoadingAnimation||"none"===this.options.pagination,this.options.showConsole,this.options.generateCodeSamples=e.generateCodeSamples||{languages:[]},this.options.searchMaxDepth=this.rawOptions.searchMaxDepth||DEFAULT_SEARCH_MAX_DEPTH}initSearch(e,t){global.__REDOCLY_SEARCH_URL?this.search=new RemoteSearch(global.__REDOCLY_SEARCH_URL):this.search=new DeepSearchStore(e),t&&setTimeout((()=>{var e;return null===(e=this.search)||void 0===e?void 0:e.indexItems(this.menu.items)}),50),this.definition instanceof VersionedSpecStore&&observe(this.definition,"activeVersionIdx",(t=>{var i,o;const n=this.definition;null===(i=this.search)||void 0===i||i.dispose(),this.search=new DeepSearchStore(e);const r=n.versions[t.newValue]._searchIndexName;if(IS_BROWSER&&r){const e=n.versions[t.newValue]._searchIndexName,i=new URL(window.location.href);i.pathname=joinURLs(this.options.routingBasePath,e),null===(o=this.search)||void 0===o||o.fromExternalJS(i.toString(),__redoc_state.searchIndexExport),this.observeAllAndRemark()}else setTimeout((()=>{var e;null===(e=this.search)||void 0===e||e.indexItems(this.menu.items)}),0)})),IS_BROWSER&&this.observeAllAndRemark()}onDidMount(){if(this.menu.updateOnHistory(),this.updateMarkOnMenu(this.menu.activeItemIdx),this.layout=fromLocalStorage("layoutVariant")||this.options.layout||this.layout,this.activeSampleLanguage=fromLocalStorage("activeSampleLanguage")||this.options.defaultSampleLanguage,this.options.showRightPanelToggle){const e=fromSessionStorage("showRightPanelToggleState");e&&(this.showRightPanel="true"===e)}}toggleRightPanel(e){this.showRightPanel=null!=e?e:!this.showRightPanel,toSessionStorage("showRightPanelToggleState",JSON.stringify(this.showRightPanel))}toggleLayout(e=LayoutVariant.THREE_PANEL){this.layout=e,toLocalStorage("layoutVariant",e)}disableConsole(){this.options.showConsole=!1}enableConsole(){this.options.showConsole=!0}tryItOut(e){this.tryItOperation=e}setActiveSampleLanguage(e){if(this.activeSampleLanguage===e)return this.stopLoader();this.activeSampleLanguage=e,toLocalStorage("activeSampleLanguage",e)}activateSampleLanguage(e){this.setActiveSampleLanguage(e)}startLoader(){this.isLoading||(this.isLoading=!0)}stopLoader(){this.isLoading&&(this.isLoading=!1)}async dereferenceSpecForTryIt(e){var t,i,o,n;const r=this.definition.parser.definition,s=JSON.parse(JSON.stringify(r)),a=Object.assign(Object.assign({},getSpecVersionObj(s)),{components:s.components,paths:{[e.path]:{[e.httpVerb]:null===(i=null===(t=s.paths)||void 0===t?void 0:t[e.path])||void 0===i?void 0:i[e.httpVerb],parameters:null===(n=null===(o=s.paths)||void 0===o?void 0:o[e.path])||void 0===n?void 0:n.parameters}}}),l={config:new Config({}),doc:createParsedDocument(a),dereference:!0};return await bundle(l),s}observeAllAndRemark(){const e=t=>{for(const i of t)if("operation"===i.type){const e=i.responses;for(const t of e)observe(t,"expanded",(e=>this.remark(e)))}else"tag"===i.type&&e(i.items||[])};e(this.menu.renderItems),"none"!==this.options.pagination&&observe(this.menu,"renderItems",(()=>e(this.menu.renderItems)))}remark(e){e.newValue&&setTimeout((()=>this.marker.mark()),0)}static fromJS(e){var t;const i=new ProStore(e.definition.data,e.definition.url,e.options,!1);setGlobalStore(i),i.menu.activeItemIdx=void 0!==e.menu.activeItemIdx?e.menu.activeItemIdx:-1,i.definition instanceof VersionedSpecStore&&e.definition.activeVersionIdx&&(i.definition.activeVersionIdx=e.definition.activeVersionIdx||0);const o=i.menu.flatItems[i.menu.activeItemIdx];if(o&&i.menu.activate(o,!1),!i.options.disableSearch){const o=new URL(window.location.href);o.pathname=e.searchIndexPath&&e.searchIndexPath.startsWith("/")?e.searchIndexPath:o.pathname+(o.pathname.endsWith("/")?"":"/")+e.searchIndexPath,null===(t=i.search)||void 0===t||t.fromExternalJS(o.toString(),e.searchIndexExport)}return e.tryItOperationId&&(i.tryItOperation=i.menu.flatItems.find((t=>t.id===e.tryItOperationId))),setTimeout((()=>i.observeAllAndRemark()),0),i}async toJS(){var e;return{menu:{activeItemIdx:this.menu.activeItemIdx},definition:this.definition instanceof VersionedSpecStore?{url:void 0,data:this.definition.toJS()}:{url:this.definition.parser.definitionUrl,data:this.definition.parser.definition},searchIndex:this.search?await this.search.toJS():void 0,options:this.rawOptions,tryItOperationId:null===(e=this.tryItOperation)||void 0===e?void 0:e.id}}dispose(){this.scroll.dispose(),this.menu.dispose(),this.search&&this.search.dispose(),this.disposer()}updateMarkOnMenu(e){const t=Math.max(0,e),i=Math.min(this.menu.flatItems.length,t+5),o=[];for(let e=t;e<i;e++){const t=this.menu.getElementAt(e);t&&(t&&o.push(t))}if("item"===this.options.pagination){const{parent:t}=this.menu.flatItems[e]||{};if(null==t?void 0:t.absoluteIdx){const e=this.menu.getElementAt(t.absoluteIdx);e&&o.push(e)}}this.marker.addOnly(o),this.marker.mark()}}__decorate([observable],ProStore.prototype,"search",void 0),__decorate([observable],ProStore.prototype,"tryItOperation",void 0),__decorate([observable],ProStore.prototype,"showRightPanel",void 0),__decorate([observable],ProStore.prototype,"layout",void 0),__decorate([observable],ProStore.prototype,"activeSampleLanguage",void 0),__decorate([observable],ProStore.prototype,"isLoading",void 0),__decorate([action],ProStore.prototype,"onDidMount",null),__decorate([action],ProStore.prototype,"toggleRightPanel",null),__decorate([action],ProStore.prototype,"toggleLayout",null),__decorate([action],ProStore.prototype,"disableConsole",null),__decorate([action],ProStore.prototype,"enableConsole",null),__decorate([action],ProStore.prototype,"tryItOut",null),__decorate([action],ProStore.prototype,"setActiveSampleLanguage",null),__decorate([bind,debounce(500)],ProStore.prototype,"activateSampleLanguage",null),__decorate([action],ProStore.prototype,"startLoader",null),__decorate([action],ProStore.prototype,"stopLoader",null);const DEFAULT_OPTIONS={ignoreNamedSchemas:["java.io.ObjectStreamField"],allowedMdComponents:{RedocResponse:{component:RedocResponse,propsSelector:e=>({store:e})},PullRight:{component:PullRight,propsSelector:()=>({})},[SCHEMA_DEFINITION_JSX_NAME]:{component:SchemaDefinition,propsSelector:e=>({parser:e.definition.parser,options:e.options,layout:e.layout,showRightPanel:e.showRightPanel})},[SECURITY_DEFINITIONS_COMPONENT_NAME]:{component:SecurityDefs,propsSelector:e=>({securitySchemes:e.definition.securitySchemes})},[SECURITY_DEFINITIONS_JSX_NAME]:{component:SecurityDefs,propsSelector:e=>({securitySchemes:e.definition.securitySchemes})}}};function joinURLs(e,t){return e.endsWith("/")&&(e=e.slice(0,-1)),t.startsWith("/")&&(t=t.substring(1)),`${e}/${t}`}function addTrailingSlash(e){return e.endsWith("/")?e:e+"/"}function getSpecVersionObj(e){return e.openapi?{openapi:e.openapi}:e.swagger?{swagger:e.swagger}:void 0}function deepClone(e){if("object"!=typeof e||null===e)return e;const t=Array.isArray(e)?[]:{};for(const i in e){const o=e[i];t[i]=deepClone(o)}return t}
+//# sourceMappingURL=ProStore.js.map

package/lib-browser/services/SearchStore.d.ts

@@ -0,0 +1,37 @@
+import type { IMenuItem, OperationModel, RedocNormalizedOptions, SearchResult } from '../redoc-lib';
+import type { RedocProUserOptionsExt } from './ProStore';
+import { SearchStore } from '../redoc-lib';
+export declare type SearchResultMeta = {
+    place?: string;
+    path?: string[];
+    menuId: string;
+    boost?: number;
+};
+export declare const DEFAULT_SEARCH_MAX_DEPTH = 1;
+export declare class DeepSearchStore extends SearchStore<SearchResultMeta> {
+    operationTitleBoost: number;
+    tagTitleBoost: number;
+    fieldLevelBoost: number;
+    pathOnly: boolean;
+    searchMaxDepth: number;
+    constructor(options: RedocProUserOptionsExt & RedocNormalizedOptions);
+    indexItems(groups: Array<IMenuItem | OperationModel>): void;
+    private indexSchema;
+    add(title: string, body: string, meta?: SearchResultMeta): void;
+    search<T = SearchResultMeta>(q: string): Promise<Array<SearchResult<T>>>;
+    toJS(): Promise<void>;
+    dispose(): void;
+}
+export declare class RemoteSearch extends SearchStore<SearchResultMeta> {
+    private url;
+    operationTitleBoost: number;
+    tagTitleBoost: number;
+    fieldLevelBoost: number;
+    constructor(url: string);
+    indexItems(_groups: Array<IMenuItem | OperationModel>): void;
+    add(_title: string, _body: string, _meta?: SearchResultMeta): void;
+    search(q: string): Promise<SearchResult<SearchResultMeta>[]>;
+    dispose(): void;
+    load(): void;
+    toJS(): Promise<void>;
+}

package/lib-browser/services/SearchStore.js

@@ -0,0 +1,2 @@
+import{SearchStore}from"../redoc-lib";function removeMarkdown(e){return e.replace(/\[(.*?)][[(].*?[\])]/g,"$1")}export const DEFAULT_SEARCH_MAX_DEPTH=1;export class DeepSearchStore extends SearchStore{constructor(e){super(),Object.defineProperty(this,"operationTitleBoost",{enumerable:!0,configurable:!0,writable:!0,value:4}),Object.defineProperty(this,"tagTitleBoost",{enumerable:!0,configurable:!0,writable:!0,value:8}),Object.defineProperty(this,"fieldLevelBoost",{enumerable:!0,configurable:!0,writable:!0,value:.95}),Object.defineProperty(this,"pathOnly",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"searchMaxDepth",{enumerable:!0,configurable:!0,writable:!0,value:1}),e.searchOperationTitleBoost&&(this.operationTitleBoost=parseInt(e.searchOperationTitleBoost,10)),e.searchTagTitleBoost&&(this.tagTitleBoost=parseInt(e.searchTagTitleBoost,10)),e.searchFieldLevelBoost&&(this.fieldLevelBoost=parseInt(e.searchFieldLevelBoost,10)),"path-only"===e.searchMode&&(this.pathOnly=!0),e.searchMaxDepth&&(this.searchMaxDepth=e.searchMaxDepth)}indexItems(e){const t=e=>{e.forEach((e=>{if("operation"===e.type&&this.pathOnly){const t=e;this.add(t.path,"",{menuId:t.id,boost:this.operationTitleBoost})}else{if("group"===e.type||this.pathOnly||(this.add(e.name,"operation"===e.type?e.path:"",{menuId:e.id,boost:"operation"===e.type?this.operationTitleBoost:this.tagTitleBoost}),e.description&&this.add("",removeMarkdown(e.description||""),{menuId:e.id})),"operation"===e.type){const t=e;for(const r of t.parameters||[])this.add(r.name,removeMarkdown(r.description),{menuId:e.id,place:"parameters",path:[r.name]});const r=t.requestBody&&t.requestBody.content&&t.requestBody.content.active&&t.requestBody.content.active.schema;this.indexSchema(r,e.id,"request fields"),t.responses.forEach((t=>{const r=t.content&&t.content.active&&t.content.active.schema;r&&this.indexSchema(r,e.id,`response ${t.code} fields`)}))}t(e.items)}}))};t(e),this.searchWorker.done()}indexSchema(e,t,r,o=[],a=0){if(e&&!(a>this.searchMaxDepth||e.isCircular)){if((e=e.oneOf&&e.oneOf[e.activeOneOf]||e).fields)for(const s of e.fields){const e=o.concat([s.name]);"additionalProperties"!==s.kind&&(this.add(s.name,removeMarkdown(s.description),{menuId:t,place:r,path:e,boost:Math.pow(this.fieldLevelBoost,a)}),this.indexSchema(s.schema,t,r,e,a+1))}e.items&&this.indexSchema(e.items,t,r,o,a+1)}}add(e,t,r){this.searchWorker.add(e,t,r)}async search(e){return await this.searchWorker.search(e)}async toJS(){return this.searchWorker.toJS()}dispose(){"terminate"in this.searchWorker&&this.searchWorker.terminate(),this.searchWorker.dispose&&this.searchWorker.dispose()}}export class RemoteSearch extends SearchStore{constructor(e){super(),Object.defineProperty(this,"url",{enumerable:!0,configurable:!0,writable:!0,value:e}),Object.defineProperty(this,"operationTitleBoost",{enumerable:!0,configurable:!0,writable:!0,value:4}),Object.defineProperty(this,"tagTitleBoost",{enumerable:!0,configurable:!0,writable:!0,value:8}),Object.defineProperty(this,"fieldLevelBoost",{enumerable:!0,configurable:!0,writable:!0,value:.95})}indexItems(e){}add(e,t,r){throw new Error("Not implemented")}async search(e){let t=[];try{const r=await fetch(this.url+"?q="+encodeURIComponent(e));if(t=await r.json(),!Array.isArray(t))throw t=[],new Error("wrong search results format")}catch(e){console.error("Failed to load search results: "+e.message)}return t}dispose(){super.dispose()}load(){}async toJS(){throw new Error("Not implemented")}}
+//# sourceMappingURL=SearchStore.js.map

package/lib-browser/services/VersionedSpecStore.d.ts

@@ -0,0 +1,40 @@
+import type { OpenAPIDefinition, ApiInfoModel, OpenAPIParser, OpenAPIExternalDocumentation, SecuritySchemesModel, ContentItemModel } from '../redoc-lib';
+import type { RedocProNormalizedOptions } from './ProStore';
+import { SpecStore } from '../redoc-lib';
+interface VersionInfo {
+    id: string;
+    title: string;
+    url?: string;
+    spec?: OpenAPIDefinition;
+    isDefault?: boolean;
+    _searchIndexName?: string;
+}
+export interface SpecVersions {
+    versions?: Array<VersionInfo>;
+}
+export interface SpecInfo {
+    id?: string;
+    title?: string;
+    spec?: OpenAPIDefinition;
+    url?: string;
+    items?: SpecInfo[];
+}
+export declare class VersionedSpecStore {
+    config: SpecVersions;
+    options: RedocProNormalizedOptions;
+    versions: (SpecStore & {
+        _searchIndexName?: string;
+    })[];
+    activeVersionIdx: number;
+    constructor(config: SpecVersions, options: RedocProNormalizedOptions, currentId: string);
+    get versionsInfo(): Array<VersionInfo>;
+    get currentVersionId(): string;
+    get contentItems(): ContentItemModel[];
+    get securitySchemes(): SecuritySchemesModel;
+    get externalDocs(): OpenAPIExternalDocumentation | undefined;
+    get parser(): OpenAPIParser;
+    get info(): ApiInfoModel;
+    changeVersion(idx: number): void;
+    toJS(): SpecVersions;
+}
+export {};

package/lib-browser/services/VersionedSpecStore.js

@@ -0,0 +1,2 @@
+import{__decorate}from"tslib";import{action,observable,makeObservable}from"mobx";import{SpecStore}from"../redoc-lib";function assignSpecIdxDeep(e,s,i){e.forEach((e=>{if(e.items&&assignSpecIdxDeep(e.items,s,i),e.id=i+"/"+e.id,"operation"===e.type){e.specIdx=s;for(const s of e.security)for(const e of s.schemes)e.sectionId=i+"/"+e.sectionId}}))}export class VersionedSpecStore{constructor(e,s,i){if(Object.defineProperty(this,"config",{enumerable:!0,configurable:!0,writable:!0,value:e}),Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:s}),Object.defineProperty(this,"versions",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"activeVersionIdx",{enumerable:!0,configurable:!0,writable:!0,value:-1}),makeObservable(this),this.versions=[],!e.versions)return;let t=0,r=0;for(const o of e.versions||[]){o.isDefault&&(r=t);const e=new SpecStore(o.spec,void 0,s);this.versions.push(e),assignSpecIdxDeep(e.contentItems,t,o.id);for(const s of e.securitySchemes.schemes)s.sectionId=o.id+"/"+s.sectionId;o.id===i&&(this.activeVersionIdx=t),t++,o._searchIndexName&&(e._searchIndexName=o._searchIndexName)}-1===this.activeVersionIdx&&(this.activeVersionIdx=r),e.versions[r].isDefault=!0}get versionsInfo(){return this.config.versions||[]}get currentVersionId(){return this.versionsInfo[this.activeVersionIdx]&&this.versionsInfo[this.activeVersionIdx].id}get contentItems(){return this.versions[this.activeVersionIdx].contentItems}get securitySchemes(){return this.versions[this.activeVersionIdx].securitySchemes}get externalDocs(){return this.versions[this.activeVersionIdx].externalDocs}get parser(){return this.versions[this.activeVersionIdx].parser}get info(){return this.versions[this.activeVersionIdx].info}changeVersion(e){this.activeVersionIdx=e}toJS(){return this.config}}__decorate([observable],VersionedSpecStore.prototype,"activeVersionIdx",void 0),__decorate([action],VersionedSpecStore.prototype,"changeVersion",null);
+//# sourceMappingURL=VersionedSpecStore.js.map

package/lib-browser/services/check.d.ts

@@ -0,0 +1,19 @@
+import type { UtmParameters } from '../components/Overlay/types';
+export declare type LicenseInfo = {
+    t?: boolean;
+    i?: number;
+    e?: number;
+    h?: string[] | true;
+    s?: string;
+    valid?: boolean;
+    expired?: boolean;
+    allowed?: boolean;
+    local?: boolean;
+    cryptoMissing?: boolean;
+    plugin?: {
+        valid: boolean;
+        utms: UtmParameters;
+    };
+};
+export declare function isHostAllowed(hostname: string, hosts: string[] | boolean | undefined): boolean;
+export default function parse(key?: string): Promise<LicenseInfo>;

package/lib-browser/services/check.js

@@ -0,0 +1,2 @@
+import{IS_BROWSER}from"../redoc-lib/src/utils";import{cryptoLib}from"./utils";function promisifyIECryptoRes(t){return"then"in t?t:new Promise((e=>{t.oncomplete=t=>{e(t.target.result)}}))}function str2ab(t){const e=new ArrayBuffer(t.length),n=new Uint8Array(e);for(let e=0,o=t.length;e<o;e++)n[e]=t.charCodeAt(e);return e}const getKey=()=>{var t;const e=str2ab(atob("undefined"!=typeof REDOCLY_PUBLIC_KEY?REDOCLY_PUBLIC_KEY:"MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAMHjNir5fXx/ZXoaEeXQ5XyxbNJ4YJYczoCRdSkL6NLzw1FHnng5Vfcgk5+bvox9QRYRbuk84mA4f2NhywDbXKECAwEAAQ=="));return promisifyIECryptoRes(null===(t=cryptoLib)||void 0===t?void 0:t.subtle.importKey("spki",e,{name:"RSASSA-PKCS1-v1_5",hash:"SHA-256"},!0,["verify"]))};function textEncode(t){if(window.TextEncoder)return(new TextEncoder).encode(t);const e=unescape(encodeURIComponent(t)),n=new Uint8Array(e.length);for(let t=0;t<e.length;t++)n[t]=e.charCodeAt(t);return n}async function verify(t,e){var n;return promisifyIECryptoRes(null===(n=cryptoLib)||void 0===n?void 0:n.subtle.verify({name:"RSASSA-PKCS1-v1_5",hash:"SHA-256"},await getKey(),str2ab(atob(e)),textEncode(t)))}export function isHostAllowed(t,e){return!0===e||!(!Array.isArray(e)||"undefined"==typeof window)&&(!("localhost"!==t&&"127.0.0.1"!==t&&!t.endsWith(".localhost")&&!e.find((e=>e===t||t.endsWith("."+e))))||!!e.find((e=>{if(e.indexOf("*")!==e.lastIndexOf("*"))return;const[n,o]=e.split("*");return o&&t.startsWith(n)&&t.endsWith(o)&&o.split(".").length>2})))}export default async function parse(t){if("development"===process.env.NODE_ENV)return{valid:!0,allowed:!0};const e=IS_BROWSER&&window.location.hostname||"";if(!t)return"localhost"===e||"127.0.0.1"===e||e.endsWith(".localhost")?{local:!0}:{};const[n,o]=t.split(".");let r;try{if(!await verify(atob(n),o))return{valid:!1};r=JSON.parse(atob(n))}catch(t){return{valid:!1,cryptoMissing:!0}}return r.valid=!0,(!r.e||Date.now()/1e3>r.e)&&(r.expired=!0),r.allowed=isHostAllowed(e,r.h),"plugin"===(null==r?void 0:r.s)?{plugin:{valid:!0,utms:{utm_campaign:Array.isArray(null==r?void 0:r.h)&&(null==r?void 0:r.h[0])||"preview-docs"}}}:r}
+//# sourceMappingURL=check.js.map

package/lib-browser/services/code-samples/generator.d.ts

@@ -0,0 +1,25 @@
+import type { OperationModel, ServerVariables } from '../../redoc-lib';
+import type * as HAR from './har';
+import type { Languages } from './types';
+export declare type CustomHAR = HAR.Request & {
+    securityOAuth2ExtraCalls?: HAR.Request[];
+    basicAuth?: {
+        username: string;
+        password: string;
+    };
+    pathParameters?: {
+        [key in string]: string;
+    };
+    serverVariables?: ServerVariables;
+    allResponseCodes?: string[];
+};
+export declare function getCodeSample({ lang, operation, exampleName, pathParams, properties, options, }: {
+    lang: Languages;
+    operation: OperationModel;
+    exampleName?: string;
+    pathParams?: GenericObject;
+    properties?: GenericObject;
+    options?: GenericObject;
+}): string;
+export declare function isDefined<T>(arg?: T): arg is T;
+export declare function capitalizeFirst(str: string): string;

package/lib-browser/services/code-samples/generator.js

@@ -0,0 +1,2 @@
+import{parse as parseQueryString,stringify as stringifyQueryString}from"query-string";import*as Sampler from"openapi-sampler";import merge from"deepmerge";import{toJS}from"mobx";import{deleteEmptyArrayItem,isArrayOfObjects,serializeParameterValue}from"../../redoc-lib";import{getSecurityDetails,getParameterValue}from"../../utils";import{normalizeMimeType,arrayMergeStrategy}from"../utils";import{MediaTypes}from"../../types";import{l}from"../../redoc-lib/src/services/Labels";import{HTTPSnippet}from"./httpsnippet";import StringUtility from"./httpsnippet/helpers/string-utility";function mapOperationToHAR(e,{exampleName:t="",skipOptionalParameters:a=!1,withOAuth2Call:r=!1,spec:i,generatedPayloadSamplesMaxDepth:s=8,pathParams:o={},properties:n={}}){var l,u,p,c,d,m,h,y,v,f;const{securityHeaders:g,securityCookies:O,securityQueries:S,securityOAuth2ExtraCalls:T,basicAuth:C}=getSecurityData(null===(l=e.security)||void 0===l?void 0:l[0],r),b=null===(p=null===(u=e.requestBody)||void 0===u?void 0:u.content)||void 0===p?void 0:p.active,E={skipNonRequired:a,skipReadOnly:!0,maxSampleDepth:s},A={path:toJS(null===(c=null==e?void 0:e.requestValues)||void 0===c?void 0:c.path),cookie:toJS(null===(d=null==e?void 0:e.requestValues)||void 0===d?void 0:d.cookie),header:toJS(null===(m=null==e?void 0:e.requestValues)||void 0===m?void 0:m.header),query:toJS(null===(h=null==e?void 0:e.requestValues)||void 0===h?void 0:h.query),body:toJS(null===(y=null==e?void 0:e.requestValues)||void 0===y?void 0:y.body)};let _=!1;const P=e.parameters.filter((e=>"header"===e.in)).filter((e=>!(a&&!e.required))).map((e=>{var t;return{name:e.name,value:(null===(t=A.header)||void 0===t?void 0:t[e.name])||getParameterValue("header",e.name)||serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,E,i))}})).map((e=>((null==b?void 0:b.name)&&"content-type"===e.name.toLowerCase()&&(_=!0,e.value=b.name),e))).concat(g);!_&&(null==b?void 0:b.name)&&P.unshift({name:"Content-Type",value:null==b?void 0:b.name});const j=e.parameters.filter((e=>"cookie"===e.in)).filter((e=>!(a&&!e.required))).map((e=>parseQueryString(serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,E,i))))).reduce(((e,t)=>{var a;for(const[r,i]of Object.entries(t))e.push({name:r,value:String((null===(a=A.cookie)||void 0===a?void 0:a[r])||i)});return e}),[]).concat(O),w=e.parameters.filter((e=>"query"===e.in)).filter((e=>!(a&&!e.required))).map((e=>parseQueryString(serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,E,i))))).reduce(((e,t)=>{var a,r,i;for(const[s,o]of Object.entries(t))e.push({name:s,value:isArrayOfObjects(null===(a=A.query)||void 0===a?void 0:a[s])&&JSON.stringify(deleteEmptyArrayItem(null===(r=A.query)||void 0===r?void 0:r[s]))||String((null===(i=A.query)||void 0===i?void 0:i[s])||o)});return e}),[]).concat(S),R=null===(v=e.activeServer)||void 0===v?void 0:v.url.replace(/\/$/,""),D=e.path.replace(/^\//,""),[k]=R.split("#"),q=`${k}/${D}`,H=e.parameters.filter((e=>"path"===e.in)).reduce(((e,t)=>{var a;const{in:r,name:i}=t;return e[i]=(null===(a=A.path)||void 0===a?void 0:a[i])||o[i]||getParameterValue(r,i),e}),{}),M=null===(f=null==b?void 0:b.examples)||void 0===f?void 0:f[t],N=(null==b?void 0:b.examples)||{},[x]=Object.values(N),U=A.body||(null==M?void 0:M.value)||(null==x?void 0:x.value)||(null==b?void 0:b.schema)&&Sampler.sample(null==b?void 0:b.schema.rawSchema,E,i),z=null==b?void 0:b.name.toLowerCase();let V,I=[];switch(normalizeMimeType(z)){case MediaTypes.JSON:case MediaTypes.XML:V=JSON.stringify(getDataRequest(U,n));break;case MediaTypes.URL_ENCODED:case MediaTypes.MULTIPART:V=stringifyQueryString(getDataRequest(U,n)),I=objectToHarParams(getDataRequest(U,n));break;default:V=String(U||"")}const J=V?{mimeType:(null==b?void 0:b.name)||MediaTypes.OCTET_STREAM,text:V,params:I}:void 0,L=e.responses.map((e=>e.code));return{method:e.httpVerb,url:q,httpVersion:"HTTP/1.1",cookies:j,headers:P,queryString:w,postData:J,headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:T,basicAuth:C,pathParameters:H,serverVariables:e.activeServer.variables,allResponseCodes:L}}const defaultOptions={withImports:!0,withComments:!1},langToSnippetConfig={curl:{code:"shell",defaultTarget:"curl",defaultOptions:Object.assign(Object.assign({},defaultOptions),{short:!0})},JavaScript:{code:"javascript",defaultTarget:"fetch",defaultOptions:Object.assign(Object.assign({},defaultOptions),{withImports:!1})},"Node.js":{code:"node",defaultTarget:"fetch",defaultOptions:Object.assign({},defaultOptions)},Python:{code:"python",defaultTarget:"requests",defaultOptions:Object.assign({},defaultOptions)},"Java8+Apache":{code:"java8",defaultTarget:"apachehttp",defaultOptions:Object.assign({},defaultOptions)},Java:{code:"java",defaultTarget:"httpclient",defaultOptions:Object.assign({},defaultOptions)},"C#":{code:"csharp",defaultTarget:"httpclient",defaultOptions:Object.assign({},defaultOptions)},"C#+Newtonsoft":{code:"csharpNewtonsoft",defaultTarget:"httpclient",defaultOptions:Object.assign({},defaultOptions)},Go:{code:"go",defaultTarget:"http.DefaultClient",defaultOptions:Object.assign({},defaultOptions)},PHP:{code:"php",defaultTarget:"curl",defaultOptions:Object.assign({},defaultOptions)},Ruby:{code:"ruby",defaultTarget:"net::http",defaultOptions:Object.assign({},defaultOptions)},R:{code:"r",defaultTarget:"httr",defaultOptions:Object.assign({},defaultOptions)}};export function getCodeSample({lang:e,operation:t,exampleName:a,pathParams:r,properties:i,options:s={}}){try{const{skipOptionalParameters:o,withOAuth2Call:n,spec:l,generatedPayloadSamplesMaxDepth:u}=s,p=mapOperationToHAR(t,{exampleName:a,pathParams:r,properties:i,skipOptionalParameters:o,withOAuth2Call:n,spec:l,generatedPayloadSamplesMaxDepth:u}),c=new HTTPSnippet(p);return langToSnippetConfig[e]?c.convert(langToSnippetConfig[e].code,langToSnippetConfig[e].defaultTarget,Object.assign(Object.assign({},langToSnippetConfig[e].defaultOptions),s)):"Language is not supported."}catch(e){return console.error(e),"Failed to generate code sample."}}function getSecurityData(e,t){var a,r,i,s;const o={securityHeaders:[],securityCookies:[],securityQueries:[],securityOAuth2ExtraCalls:[],basicAuth:void 0};for(const n of(null==e?void 0:e.schemes)||[]){const e=getSecurityDetails(n.id);switch(n.type){case"openIdConnect":null===(a=o.securityHeaders)||void 0===a||a.push({name:"Authorization",value:"Bearer <YOUR_TOKEN_HERE>"});break;case"oauth2":{const a=e.token?`${e.token.token_type||"Bearer"} ${e.token.access_token}`:"Bearer <YOUR_TOKEN_HERE>";n.flows.clientCredentials&&t?o.securityOAuth2ExtraCalls.push(getOAuth2ClientCredsCallHar(n.flows.clientCredentials,n.scopes,e)):n.flows.password&&t&&o.securityOAuth2ExtraCalls.push(getOAuth2PasswordCallHar(n.flows.password,n.scopes,e)),null===(r=o.securityHeaders)||void 0===r||r.push({name:"Authorization",value:a});break}case"apiKey":{const t=e.raw||"YOUR_API_KEY_HERE";"header"===n.in&&(null===(i=o.securityHeaders)||void 0===i||i.push({name:n.name,value:t})),"cookie"===n.in&&o.securityCookies.push({name:n.name,value:t}),"query"===n.in&&o.securityQueries.push({name:n.name,value:t});break}case"http":"basic"===n.scheme?o.basicAuth={username:e.username||`<${StringUtility.toSnakeCase(l("tryItAuthBasicUsername"))}>`,password:e.password||`<${StringUtility.toSnakeCase(l("tryItAuthBasicPassword"))}>`}:null===(s=o.securityHeaders)||void 0===s||s.push({name:"Authorization",value:`${capitalizeFirst(n.scheme||"bearer")} <YOUR_${n.bearerFormat||"TOKEN"}_HERE>`})}}return o}function getOAuth2PasswordCallHar(e,t,a){return{method:"POST",url:e.tokenUrl,httpVersion:"HTTP/1.1",headers:[{name:"Content-Type",value:MediaTypes.URL_ENCODED},{name:"Accept",value:MediaTypes.JSON}],queryString:[],postData:{mimeType:MediaTypes.URL_ENCODED,text:"",params:[{name:"grant_type",value:"password"},{name:"client_id",value:a.client_id||"YOUR_CLIENT_ID"},{name:"client_secret",value:a.client_secret||"YOUR_CLIENT_SECRET"},{name:"username",value:a.username||"<username>"},{name:"password",value:a.password||"<password>"},t.length?{name:"scope",value:t.join(" ")}:void 0].filter(isDefined)},cookies:[],headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:[]}}function getOAuth2ClientCredsCallHar(e,t,a){return{method:"POST",url:e.tokenUrl,httpVersion:"HTTP/1.1",headers:[{name:"Content-Type",value:MediaTypes.URL_ENCODED},{name:"Accept",value:MediaTypes.JSON}],queryString:[],postData:{mimeType:MediaTypes.URL_ENCODED,text:"",params:[{name:"grant_type",value:"client_credentials"},{name:"client_id",value:a.client_id||"YOUR_CLIENT_ID"},{name:"client_secret",value:a.client_secret||"YOUR_CLIENT_SECRET"},t.length?{name:"scope",value:t.join(" ")}:void 0].filter(isDefined)},cookies:[],headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:[]}}function getDataRequest(e,t){if(e){if("object"==typeof e)return merge(e,t,{arrayMerge:arrayMergeStrategy});try{return merge(JSON.parse(e),t,{arrayMerge:arrayMergeStrategy})}catch(e){return!1}}return!1}function objectToHarParams(e,t=""){const a=[];for(const[r,i]of Object.entries(e)){const e=t?`${t}[${r}]`:r;"object"==typeof i&&null!==i?a.push(...objectToHarParams(i,e)):a.push({name:e,value:String(i)})}return a}export function isDefined(e){return void 0!==e}export function capitalizeFirst(e){return e.charAt(0).toUpperCase()+e.slice(1)}
+//# sourceMappingURL=generator.js.map

package/lib-browser/services/code-samples/httpsnippet/helpers/code-builder.d.ts

@@ -0,0 +1,82 @@
+import { VariableType } from './constants';
+/**
+ * Helper object to format and aggragate lines of code.
+ * Lines are aggregated in a `code` array, and need to be joined to obtain a proper code snippet.
+ *
+ * @param {string} indentation Desired indentation character for aggregated lines of code
+ * @param {string} lineJoin Desired character to join each line of code
+ */
+export declare class CodeBuilder {
+    private code;
+    private indentation;
+    private variablesPrefix;
+    private lineJoin;
+    private capitalize;
+    private lang;
+    langOptions: {
+        stringLiteral: (t: string) => string;
+        variableWrapperFn: (variableName: string, variableValue?: string) => string;
+        variableDeclaration: (v: string) => string;
+        joinSymbol: string;
+        urlFieldName: string;
+        rawName: boolean;
+    };
+    constructor({ indentation, lineJoin, variablesPrefix, capitalize, lang, }: {
+        indentation: string;
+        lineJoin?: string;
+        variablesPrefix?: string;
+        capitalize?: boolean;
+        lang?: string;
+    });
+    /**
+     * Add given indentation level to given string and format the string (variadic)
+     * @param {number} [indentationLevel=0] - Desired level of indentation for this line
+     * @param {string} line - Line of code. Can contain formatting placeholders
+     * @param rest
+     * @param {...object} - Parameter to bind to `line`'s formatting placeholders
+     * @return {string}
+     *
+     * @example
+     *   const builder = CodeBuilder('\t')
+     *
+     *   builder.buildLine('console.log("hello world")')
+     *   // returns: 'console.log("hello world")'
+     *
+     *   builder.buildLine(2, 'console.log("hello world")')
+     *   // returns: 'console.log("\t\thello world")'
+     *
+     *   builder.buildLine(2, 'console.log("%s %s")', 'hello', 'world')
+     *   // returns: 'console.log("\t\thello world")'
+     */
+    buildLine(indentationLevel: number | string, line: string): string | null;
+    /**
+     * Invoke buildLine() and add the line at the top of current lines
+     * @return {this}
+     * @param args
+     */
+    unshift(...args: Array<string | number | undefined | unknown>): CodeBuilder;
+    /**
+     * Invoke buildLine() and add the line at the bottom of current lines
+     * @return {this}
+     * @param args
+     */
+    push(...args: Array<string | number | undefined | unknown>): CodeBuilder;
+    /**
+     * Add an empty line at the end of current lines
+     * @return {this}
+     */
+    blank(): CodeBuilder;
+    /**
+     * Concatenate all current lines using the given lineJoin
+     * @return {string}
+     */
+    join(): string;
+    clean(): void;
+    /**
+     * Get variable name, use variablesPrefix if specified
+     * @param {string} name
+     * @param {VariableType} type
+     * @return {string}
+     */
+    var(name: string, type?: VariableType): string;
+}

package/lib-browser/services/code-samples/httpsnippet/helpers/code-builder.js

@@ -0,0 +1,2 @@
+import*as util from"util";import{Lang,NamingVariableConventions,VariableType}from"./constants";import StringUtility from"./string-utility";const langToVarNameConvention={[Lang.NODEJS]:NamingVariableConventions.CAMEL_CASE,[Lang.JAVASCRIPT]:NamingVariableConventions.CAMEL_CASE,[Lang.PYTHON]:NamingVariableConventions.UNDER_SCORES,[Lang.JAVA8]:NamingVariableConventions.CAMEL_CASE,[Lang.JAVA]:NamingVariableConventions.CAMEL_CASE,[Lang.CSHARP]:NamingVariableConventions.PASCAL_CASE,[Lang.CSHARPNEWTONSOFT]:NamingVariableConventions.PASCAL_CASE,[Lang.CURL]:NamingVariableConventions.CAMEL_CASE,[Lang.GO]:NamingVariableConventions.CAMEL_CASE,[Lang.PHP]:NamingVariableConventions.CAMEL_CASE,[Lang.RUBY]:NamingVariableConventions.UNDER_SCORES,[Lang.R]:NamingVariableConventions.UNDER_SCORES},langOptions={default:{joinSymbol:"",variableWrapperFn:a=>a,stringLiteral:a=>a,variableDeclaration:a=>a,urlFieldName:"url"},[Lang.CSHARP]:{joinSymbol:" + ",stringLiteral:a=>`"${a}"`,variableDeclaration:a=>`var ${a} = "%s";`,urlFieldName:"fullUrl"},[Lang.CSHARPNEWTONSOFT]:{joinSymbol:" + ",stringLiteral:a=>`"${a}"`,variableDeclaration:a=>`var ${a} = "%s";`,urlFieldName:"fullUrl"},[Lang.GO]:{joinSymbol:" + ",stringLiteral:a=>`"${a}"`,variableDeclaration:a=>`${a} := "%s";`},[Lang.JAVA]:{joinSymbol:" + ",stringLiteral:a=>`"${a}"`,variableDeclaration:a=>`var ${a} = "%s";`,urlFieldName:"pathname"},[Lang.JAVA8]:{joinSymbol:" + ",stringLiteral:a=>`"${a}"`,variableDeclaration:a=>`String ${a} = "%s";`,urlFieldName:"fullUrl"},[Lang.JAVASCRIPT]:{variableWrapperFn:a=>"${"+a+"}",variableDeclaration:a=>`const ${a} = '%s';`},[Lang.NODEJS]:{variableWrapperFn:a=>"${"+a+"}",variableDeclaration:a=>`const ${a} = '%s';`},[Lang.PHP]:{joinSymbol:" . ",stringLiteral:a=>`"${a}"`,variableDeclaration:a=>`const ${a} = "%s";`},[Lang.PYTHON]:{stringLiteral:a=>`"${a}"`,joinSymbol:" + ",variableDeclaration:a=>`${a} = "%s"`},[Lang.RUBY]:{joinSymbol:" + ",stringLiteral:a=>`'${a}'`,variableDeclaration:a=>`${a} = '%s'`},[Lang.CURL]:{variableWrapperFn:(a,i)=>i||`{${a}}`,urlFieldName:"fullUrl",rawName:!0},[Lang.R]:{joinSymbol:" %&% ",variableDeclaration:a=>`${a} = "%s"`,urlFieldName:"fullUrl",stringLiteral:a=>`"${a}"`,variableWrapperFn:a=>`${a}`}},reservedVariableNames=["response","request","requests","data","url","payload","main","accessToken","resp","Program","client","postData","App","httpClient","params","pathname","host","body","fetch","query"];export class CodeBuilder{constructor({indentation:a,lineJoin:i="\n",variablesPrefix:e="",capitalize:n=!1,lang:r=Lang.CURL}){Object.defineProperty(this,"code",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"indentation",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"variablesPrefix",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"lineJoin",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"capitalize",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"lang",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"langOptions",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),this.code=[],this.indentation=a,this.variablesPrefix=e,this.lineJoin=i||"\n",this.capitalize=n,this.lang=r,this.langOptions=Object.assign(Object.assign({},langOptions.default),langOptions[r])}buildLine(a,i){let e="",n=2;if("string"==typeof a)n=1,i=a,a=0;else if(null===a)return null;for(;a;)e+=this.indentation,a--;const r=Array.prototype.slice.call(arguments,n,arguments.length);return r.unshift(e+i),util.format.apply(this,r)}unshift(...a){return this.code.unshift(this.buildLine.apply(this,a)),this}push(...a){return this.code.push(this.buildLine.apply(this,a)),this}blank(){return this.code.push(null),this}join(){return this.code.join(this.lineJoin)}clean(){this.code.splice(1)}var(a,i=VariableType.CUSTOM){if(i===VariableType.PATH){let i=this.variablesPrefix+a;switch(reservedVariableNames.includes(i)&&(i=`${i}_path`),langToVarNameConvention[this.lang]){case NamingVariableConventions.UNDER_SCORES:i=StringUtility.toSnakeCase(i);break;case NamingVariableConventions.PASCAL_CASE:i=StringUtility.toPascalCase(i);break;case NamingVariableConventions.CAMEL_CASE:default:i=StringUtility.toCamelCase(i)}return i}return this.variablesPrefix?this.variablesPrefix+(this.capitalize?StringUtility.toPascalCase(a):a):a}}
+//# sourceMappingURL=code-builder.js.map

package/lib-browser/services/code-samples/httpsnippet/helpers/code-helpers.d.ts

@@ -0,0 +1,29 @@
+import type { SnippetRequest } from '../index';
+import type { CodeBuilder } from './code-builder';
+export declare function getPreserveTransformer({ body, authorizationHeader, }: {
+    body?: boolean;
+    authorizationHeader?: boolean;
+}): (input: GenericObject, prop: string, originalResult: string) => string;
+export declare function addIndentation(str: string, { level, indent, firstLine }?: {
+    level?: number | undefined;
+    indent?: string | undefined;
+    firstLine?: boolean | undefined;
+}): string;
+export declare type CodeOperand = {
+    type: 'string';
+    value: string;
+} | {
+    type: 'variable';
+    name: string;
+};
+/**
+ * Parse url with arguments into concatenation operands array so it can be manipulated easily language-independently
+ *
+ * @example
+ * // returns [{type: 'string', value: '/var/'}, {type: 'variable', name: 'test'}, {type: "string", value: "/"}]
+ * parseUrlIntoOperands("/url/:test/", {test: 1})
+ **/
+export declare function parseUrlIntoOperands(url: string, params: Record<string, unknown>): CodeOperand[];
+export declare function buildUrlExpression(source: SnippetRequest, code: CodeBuilder): string;
+export declare function printUrlVariablesDeclarations({ pathParameters, serverVariables }: SnippetRequest, code: CodeBuilder, indentationLevel?: number): void;
+export declare function paramsToObject(params: URLSearchParams): Record<string, any>;

package/lib-browser/services/code-samples/httpsnippet/helpers/code-helpers.js

@@ -0,0 +1,2 @@
+import{VariableType}from"./constants";export function getPreserveTransformer({body:r,authorizationHeader:e}){return function(t,n,a){return r&&"body"===n&&"string"==typeof t.body?t.body:e&&"Authorization"===n&&"string"==typeof t.Authorization?t.Authorization:a}}export function addIndentation(r,{level:e=0,indent:t="  ",firstLine:n=!0}={}){const a=t.repeat(e),i=r.replace(/(\r\n|\n|\r)/gm,`\n${a}`);return n?a.concat(i):i}export function parseUrlIntoOperands(r,e){const t=Object.keys(e).map((e=>({name:e,idx:r.indexOf(`{${e}}`)}))).filter((({idx:r})=>r>-1)).sort(((r,e)=>r.idx-e.idx)),n=[];let a=0;for(const{name:e,idx:i}of t)i>a&&n.push({type:"string",value:r.substring(a,i)}),n.push({type:"variable",name:e}),a=i+e.length+2;return a<r.length&&n.push({type:"string",value:r.substring(a)}),n}export function buildUrlExpression(r,e){const{joinSymbol:t,variableWrapperFn:n,stringLiteral:a,urlFieldName:i,rawName:o}=e.langOptions,{pathParameters:s={},serverVariables:p={}}=r,l=Object.assign(Object.assign({},s),p);return parseUrlIntoOperands(r[i]||"",l).map((r=>{if("variable"===r.type){const t=l[r.name],a=o?r.name:e.var(r.name,VariableType.PATH);return n(a,t)}return a(r.value)})).join(t)}export function printUrlVariablesDeclarations({pathParameters:r={},serverVariables:e={}},t,n){Object.entries(Object.assign(Object.assign({},r),e)).forEach((([r,e])=>{const a=e||`YOUR_${r}_PARAMETER`,i=t.var(r,VariableType.PATH);void 0!==n?t.push(n,t.langOptions.variableDeclaration(i),a):t.push(t.langOptions.variableDeclaration(i),a)}))}export function paramsToObject(r){const e={};return r.forEach(((r,t)=>{Object.prototype.hasOwnProperty.call(e,t)?Array.isArray(e[t])?e[t].push(r):e[t]=[e[t],r]:e[t]=r})),e}
+//# sourceMappingURL=code-helpers.js.map