@redocly/openapi-docs 0.0.0-beta-20240215154132

package/lib-esm/services/search/SearchWorker.worker.d.ts

@@ -0,0 +1,17 @@
+import type { SearchResult } from './types';
+export default class Worker {
+    add: typeof add;
+    done: typeof done;
+    search: typeof search;
+    toJS: typeof toJS;
+    load: typeof load;
+    dispose: typeof dispose;
+    fromExternalJS: typeof fromExternalJS;
+}
+export declare function add<T>(title: string, description: string, meta?: T): void;
+export declare function done(): Promise<void>;
+export declare function toJS(): Promise<any>;
+export declare function fromExternalJS(path: string, exportName: string): Promise<void>;
+export declare function load(state: GenericObject): Promise<void>;
+export declare function dispose(): Promise<void>;
+export declare function search<Meta = string>(q: string, limit?: number): Promise<Array<SearchResult<Meta>>>;

package/lib-esm/services/search/SearchWorker.worker.js

@@ -0,0 +1,2 @@
+var __awaiter=this&&this.__awaiter||function(e,r,t,i){return new(t||(t=Promise))((function(n,o){function a(e){try{u(i.next(e))}catch(e){o(e)}}function l(e){try{u(i.throw(e))}catch(e){o(e)}}function u(e){var r;e.done?n(e.value):(r=e.value,r instanceof t?r:new t((function(e){e(r)}))).then(a,l)}u((i=i.apply(e,r||[])).next())}))};import*as lunr from"lunr";export default class Worker{constructor(){Object.defineProperty(this,"add",{enumerable:!0,configurable:!0,writable:!0,value:add}),Object.defineProperty(this,"done",{enumerable:!0,configurable:!0,writable:!0,value:done}),Object.defineProperty(this,"search",{enumerable:!0,configurable:!0,writable:!0,value:search}),Object.defineProperty(this,"toJS",{enumerable:!0,configurable:!0,writable:!0,value:toJS}),Object.defineProperty(this,"load",{enumerable:!0,configurable:!0,writable:!0,value:load}),Object.defineProperty(this,"dispose",{enumerable:!0,configurable:!0,writable:!0,value:dispose}),Object.defineProperty(this,"fromExternalJS",{enumerable:!0,configurable:!0,writable:!0,value:fromExternalJS})}}let builder,resolveIndex,index,store=[];function initEmpty(){builder=new lunr.Builder,builder.field("title"),builder.field("description"),builder.ref("ref"),builder.pipeline.add(lunr.trimmer,lunr.stopWordFilter,lunr.stemmer),index=new Promise((e=>{resolveIndex=e}))}lunr.tokenizer.separator=/\s+/,initEmpty();const expandTerm=e=>"*"+lunr.stemmer(new lunr.Token(e,{}))+"*";export function add(e,r,t){const i=store.push(t)-1,n={title:e.toLowerCase(),description:r.toLowerCase(),ref:i};builder.add(n)}export function done(){return __awaiter(this,void 0,void 0,(function*(){resolveIndex(builder.build())}))}export function toJS(){return __awaiter(this,void 0,void 0,(function*(){return{store:store,index:(yield index).toJSON()}}))}export function fromExternalJS(e,r){return __awaiter(this,void 0,void 0,(function*(){try{if(importScripts(e),!self[r])throw new Error("Broken index file format");yield load(self[r])}catch(e){console.error("Failed to load search index: "+e.message)}}))}export function load(e){return __awaiter(this,void 0,void 0,(function*(){store=e.store,resolveIndex(lunr.Index.load(e.index))}))}export function dispose(){return __awaiter(this,void 0,void 0,(function*(){store=[],initEmpty()}))}export function search(e,r=0){return __awaiter(this,void 0,void 0,(function*(){if(0===e.trim().length)return[];let t=(yield index).query((r=>{e.trim().toLowerCase().split(/\s+/).forEach((e=>{if(1===e.length)return;const t=expandTerm(e);r.term(t,{})}))}));return r>0&&(t=t.slice(0,r)),t.map((e=>({meta:store[e.ref],score:e.score})))}))}
+//# sourceMappingURL=SearchWorker.worker.js.map

package/lib-esm/services/search/index.d.ts

@@ -0,0 +1,4 @@
+export { SearchStore } from './SearchStore';
+export { DeepSearchStore } from './DeepSearchStore';
+export { RemoteSearch } from './RemoteSearch';
+export type { SearchResultMeta } from './types';

package/lib-esm/services/search/index.js

@@ -0,0 +1,2 @@
+export{SearchStore}from"./SearchStore";export{DeepSearchStore}from"./DeepSearchStore";export{RemoteSearch}from"./RemoteSearch";
+//# sourceMappingURL=index.js.map

package/lib-esm/services/search/types.d.ts

@@ -0,0 +1,15 @@
+export type SearchResultMeta = {
+    place?: string;
+    path?: string[];
+    menuId: string;
+    boost?: number;
+};
+export interface SearchDocument {
+    title: string;
+    description: string;
+    id: string;
+}
+export interface SearchResult<T = string> {
+    meta: T;
+    score: number;
+}

package/lib-esm/services/search/types.js

@@ -0,0 +1,2 @@
+export{};
+//# sourceMappingURL=types.js.map

package/lib-esm/services/search/useSearch.d.ts

@@ -0,0 +1,13 @@
+import type { Options } from '../Options';
+import type { SearchStore } from './SearchStore';
+import type { SearchResultMeta } from './types';
+import type { ContentItemModel } from '../../models';
+type UseSearchInput = {
+    options: Options;
+    contentItems: ContentItemModel[];
+};
+type UseSearchReturnType = {
+    search?: SearchStore<SearchResultMeta>;
+};
+export declare function useSearch({ options, contentItems }: UseSearchInput): UseSearchReturnType;
+export {};

package/lib-esm/services/search/useSearch.js

@@ -0,0 +1,2 @@
+import{RemoteSearch}from"./RemoteSearch";import{DeepSearchStore}from"./DeepSearchStore";const global="undefined"==typeof window?{__REDOCLY_SEARCH_URL:void 0}:window;export function useSearch({options:e,contentItems:o}){let r;return e.disableSearch||r||(r=initSearch(e),null==r||r.indexItems(o)),{search:r}}function initSearch(e){return global.__REDOCLY_SEARCH_URL?new RemoteSearch(global.__REDOCLY_SEARCH_URL):new DeepSearchStore(e)}
+//# sourceMappingURL=useSearch.js.map

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

@@ -0,0 +1,154 @@
+import type { ComponentType, ReactElement } from 'react';
+import type { Node } from '@markdoc/markdoc';
+import type { OpenAPIDefinition, OpenAPIInfo, OpenAPIOperation, OpenAPIParameter, OpenAPISchema, OpenAPIServer, OpenAPITag, Referenced, Server } from '../types';
+import type { OperationModel, Sample } from '../models';
+import type { GlobalStoreAtom } from '../jotai/store';
+export declare enum SideNavStyle {
+    SummaryOnly = "summary-only",
+    PathFirst = "path-first",
+    IdOnly = "id-only"
+}
+export type Normalized<T> = {
+    [P in keyof T]-?: T[P];
+};
+export type ExternalLink = ExternalLinkLink | ExternalLinkSeparator;
+export type ExternalLinkLink = {
+    label: string;
+    link: string;
+    target?: string;
+    separatorLine?: boolean;
+};
+export type ExternalLinkSeparator = {
+    separator?: string;
+    separatorLine?: boolean;
+};
+export type MenuItemGroupType = 'group' | 'tag' | 'section' | 'schema';
+export type MenuItemType = MenuItemGroupType | 'operation';
+/** Generic interface for MenuItems */
+export interface IMenuItem {
+    id: string;
+    href: string;
+    name: string;
+    description?: string | GenericObject;
+    depth: number;
+    items: IMenuItem[];
+    parent?: IMenuItem;
+    deprecated?: boolean;
+    type: MenuItemType;
+    isSchema?: boolean;
+    httpVerb?: string;
+    path?: string;
+    definition?: OpenAPIDefinition;
+}
+export type TagInfo = OpenAPITag & {
+    operations: ExtendedOpenAPIOperation[];
+    used?: boolean;
+    schemaRendersInTag?: boolean;
+    isSchema?: boolean;
+};
+export type ExtendedOpenAPIOperation = {
+    pointer: string;
+    pathName: string;
+    httpVerb: string;
+    pathParameters: Array<Referenced<OpenAPIParameter>>;
+    pathServers: Array<OpenAPIServer> | undefined;
+    isWebhook: boolean;
+    defaultSampleName?: string | false;
+} & OpenAPIOperation;
+export type TagsInfoMap = Record<string, TagInfo>;
+export interface TagGroup {
+    name: string;
+    tags: string[];
+}
+export type MergedOpenAPISchema = OpenAPISchema & {
+    'x-refsStack'?: string[];
+    'x-parentRefs'?: string[];
+    'x-circular-ref'?: boolean;
+    absolutePointer?: string;
+};
+export interface MDXComponentMeta {
+    component: ComponentType;
+    propsSelector: (oldStore?: GlobalStoreAtom, store?: GlobalStoreAtom) => GenericObject;
+    props?: GenericObject;
+}
+export interface MarkdownHeading {
+    id: string;
+    name: string;
+    level: number;
+    items?: MarkdownHeading[];
+    description?: string | GenericObject;
+    ast?: Node[];
+}
+export type Unstable_ExternalCodeSample = Sample & {
+    get: (source: ExternalSource) => string;
+};
+export interface ExternalSource {
+    sample: Unstable_ExternalCodeSample;
+    operation: OperationModel;
+    exampleName?: string;
+    pathParams?: any;
+    properties?: any;
+}
+export interface SecurityPanelHookProps {
+    operation: OperationModel;
+    server: Server;
+    onChange: (securityDetails: unknown) => void;
+}
+export type AuthPanelHookProps = SecurityPanelHookProps;
+export interface HookRawHtml {
+    html: string;
+}
+type HookResult = ReactElement | HookRawHtml | null;
+export type HookConfig<T> = (props: T) => HookResult;
+export interface HooksConfig {
+    AfterApiTitle?: HookConfig<{
+        info: OpenAPIInfo;
+    }>;
+    BeforeOperation?: HookConfig<{
+        operation: OperationModel;
+    }>;
+    BeforeOperationSummary?: HookConfig<{
+        operation: OperationModel;
+    }>;
+    AfterOperationSummary?: HookConfig<{
+        operation: OperationModel;
+    }>;
+    AfterOperation?: HookConfig<{
+        operation: OperationModel;
+    }>;
+    onInit?: (args: {
+        store: GenericObject;
+    }) => void;
+    replaceSecurityLink?: (args: {
+        securityRequirementId: string;
+    }) => string;
+    sanitize?: (raw: string) => string;
+    MiddlePanelFooter?: HookConfig<undefined>;
+    MiddlePanelHeader?: HookConfig<undefined>;
+}
+export type ExtendedMenuItem = Omit<IMenuItem, 'type'> & {
+    type: MenuItemType | 'spec';
+    linkable?: boolean;
+    href?: string;
+    httpVerb?: string;
+    path?: string;
+};
+export interface SpecInfo {
+    id?: string;
+    title?: string;
+    spec?: OpenAPIDefinition;
+    url?: string;
+    items?: SpecInfo[];
+}
+export interface SpecVersions {
+    versions?: Array<VersionInfo>;
+}
+interface VersionInfo {
+    id: string;
+    title: string;
+    url?: string;
+    spec?: OpenAPIDefinition;
+    isDefault?: boolean;
+    _searchIndexName?: string;
+}
+export {};

package/lib-esm/services/types.js

@@ -0,0 +1,2 @@
+export var SideNavStyle;!function(t){t.SummaryOnly="summary-only",t.PathFirst="path-first",t.IdOnly="id-only"}(SideNavStyle||(SideNavStyle={}));
+//# sourceMappingURL=types.js.map

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

@@ -0,0 +1,18 @@
+/**
+ * Compare mime-types ignoring charset or other params (application/json;charset=UTF-8)
+ * @param a
+ * @param b
+ */
+export declare function isSameMime(a?: string, b?: string): boolean;
+/**
+ * Removes the mime-types params e.g. charset (application/json;charset=UTF-8))
+ * Removes any prefixes, e.g. application/hal+json => application/json
+ * Spec is type/subtype;param1=value or type/semantic+format;param1=value
+ * @param mimeType mime type string or undefined
+ */
+export declare function normalizeMimeType(mimeType?: string): string | undefined;
+export declare function unescapeServerVariables(str: string): string;
+export declare function arrayMergeStrategy<T>(target: T[], source: T[]): T[];
+export declare function isEmptyObject(obj: GenericObject): boolean;
+export declare const cryptoLib: Crypto | undefined;
+export declare function deepClone(inObject: any): any;

package/lib-esm/services/utils.js

@@ -0,0 +1,2 @@
+import merge from"deepmerge";import{isObject}from"@redocly/theme";import{isMergeableObject}from"../utils";export function isSameMime(e,r){return!(!e||!r)&&normalizeMimeType(e)===normalizeMimeType(r)}export function normalizeMimeType(e){if(!e)return;const r=e.split(";")[0].toLowerCase(),[t,n]=r.split("/");if(void 0===n)return t;return`${t}/${n.split("+").pop()}`}export function unescapeServerVariables(e){const r=new RegExp("%7B","g"),t=new RegExp("%7D","g");return e.replace(r,"{").replace(t,"}").replace("///","//")}export function arrayMergeStrategy(e,r){if(!e.length||!hasObjectOrArray(e))return r;const t=e.filter((e=>Object.keys(e).length>0));return r.forEach((function(r,n){isMergeableObject(r)?t[n]=merge(e[n],r,{arrayMerge:arrayMergeStrategy}):Array.isArray(r)?t.push(r):t[n]=r})),t}const hasObjectOrArray=e=>e.some((e=>isObject(e)&&Object.keys(e).length>0));export function isEmptyObject(e){return!!e&&0===Object.keys(e).length}export const cryptoLib="undefined"!=typeof window&&(window.crypto||window.msCrypto)||void 0;export function deepClone(e){if("object"!=typeof e||null===e)return e;const r=Array.isArray(e)?[]:{};for(const t in e){const n=e[t];r[t]=deepClone(n)}return r}
+//# sourceMappingURL=utils.js.map

package/lib-esm/setupTests.d.ts

@@ -0,0 +1,3 @@
+import 'raf/polyfill';
+import '@testing-library/jest-dom';
+import 'jest-styled-components';

package/lib-esm/setupTests.js

@@ -0,0 +1,2 @@
+import*as Enzyme from"enzyme";import Adapter from"@cfaester/enzyme-adapter-react-18";import"raf/polyfill";import"@testing-library/jest-dom";import"jest-styled-components";import{configure}from"@testing-library/react";Enzyme.configure({adapter:new Adapter}),configure({testIdAttribute:"data-cy"});
+//# sourceMappingURL=setupTests.js.map

package/lib-esm/standalone.d.ts

@@ -0,0 +1,27 @@
+import 'core-js/es/array/find-index';
+import 'core-js/es/array/find';
+import 'core-js/es/array/includes';
+import 'core-js/es/map';
+import 'core-js/es/number/is-integer';
+import 'core-js/es/object/assign';
+import 'core-js/es/object/entries';
+import 'core-js/es/object/is';
+import 'core-js/es/object/values';
+import 'core-js/es/promise';
+import 'core-js/es/string/ends-with';
+import 'core-js/es/string/starts-with';
+import 'core-js/es/symbol';
+import 'unfetch/polyfill/index';
+import 'url-polyfill';
+import { LayoutVariant } from '@redocly/theme';
+import type { OpenAPIDefinition } from './types';
+import type { RawOptions } from './services/Options/types';
+import type { StoreProviderProps } from './components';
+import type { SpecVersions } from './services/types';
+export { setSecurityDetails, setParameterValue, setSecurityDetailsVariants } from './utils';
+export declare function toggleLayout(layout?: LayoutVariant): void;
+export declare function hydrate(store: StoreProviderProps, element?: Element | null): void;
+export declare function init(definitionOrDefinitionUrl: string | OpenAPIDefinition | SpecVersions, options?: RawOptions, element?: Element | null): void;
+export declare function setPublicPath(path: string): void;
+export declare const version: string;
+export declare const revision: string;

package/lib-esm/standalone.js

@@ -0,0 +1,2 @@
+import"core-js/es/array/find-index";import"core-js/es/array/find";import"core-js/es/array/includes";import"core-js/es/map";import"core-js/es/number/is-integer";import"core-js/es/object/assign";import"core-js/es/object/entries";import"core-js/es/object/is";import"core-js/es/object/values";import"core-js/es/promise";import"core-js/es/string/ends-with";import"core-js/es/string/starts-with";import"core-js/es/symbol";import"unfetch/polyfill/index";import"url-polyfill";import{dirname}from"path";import React,{createElement}from"react";import{createRoot,hydrateRoot}from"react-dom/client";import{LayoutVariant,IS_BROWSER}from"@redocly/theme";import{writeAtom,readAtom}from"./jotai/nexus";import{querySelector,getJsUrl}from"./utils";import{RedoclyOpenAPIDocs,RedoclyOpenAPIDocsStandalone}from"./components";import{RedoclyOpenAPIDocsMultiStandalone}from"./components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocsMultiStandalone";import{appLocalStore}from"./jotai/app";export{setSecurityDetails,setParameterValue,setSecurityDetailsVariants}from"./utils";export function toggleLayout(e=LayoutVariant.THREE_PANEL){const t=readAtom(appLocalStore);writeAtom(appLocalStore,Object.assign(Object.assign({},t),{layout:e}))}const url=getJsUrl(),__dirname=url?dirname(url)+"/":"";function attributesMap(e){const t={},o=e.attributes;for(let e=0;e<o.length;e++){const r=o[e];t[r.name]=r.value}return t}function parseOptionsFromElement(e){const t=attributesMap(e),o={};for(const e in t){o[e.replace(/-(.)/g,((e,t)=>t.toUpperCase()))]=t[e]}return o}export function hydrate(e,t=document.querySelector("redoc")){hydrateRoot(t,React.createElement(RedoclyOpenAPIDocs,{store:e}))}export function init(e,t={},o=querySelector("redoc")){if(null===o)throw new Error('"element" argument is not provided and <redoc> tag is not found on the page');let r,n;if("object"==typeof e&&"versions"in e){return void createRoot(o).render(createElement(RedoclyOpenAPIDocsMultiStandalone,{definitions:e,options:Object.assign(Object.assign({},t),parseOptionsFromElement(o))},["Loading..."]))}"string"==typeof e?r=e:"object"==typeof e&&(n=e);createRoot(o).render(createElement(RedoclyOpenAPIDocsStandalone,{definition:n,definitionUrl:r,options:Object.assign(Object.assign({},t),parseOptionsFromElement(o))},["Loading..."]))}export function setPublicPath(e){__webpack_public_path__=e}export const version=__REDOCLY_API_REFERENCE_VERSION__;export const revision=__REDOCLY_API_REFERENCE_REVISION__;function autoInit(){const e=querySelector("redoc");if(!e)return;const t=e.getAttribute("spec-url");t&&init(t,{},e)}IS_BROWSER&&setPublicPath(__dirname),autoInit();
+//# sourceMappingURL=standalone.js.map

package/lib-esm/testProviders.d.ts

@@ -0,0 +1,3 @@
+import type { ReactNode, ReactElement } from 'react';
+import type { StoreProviderProps } from './components';
+export declare function withTestProviders(children: ReactNode, store?: StoreProviderProps): ReactElement;

package/lib-esm/testProviders.js

@@ -0,0 +1,2 @@
+import React,{Children}from"react";import{StoreProvider}from"./components";export function withTestProviders(e,r){return React.createElement(StoreProvider,Object.assign({},r||{definition:{openapi:"3.0.0"}}),Children.only(e))}
+//# sourceMappingURL=testProviders.js.map

package/lib-esm/types/app.d.ts

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

package/lib-esm/types/app.js

@@ -0,0 +1,2 @@
+export{};
+//# sourceMappingURL=app.js.map

package/lib-esm/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from './open-api';
+export * from './server';
+export * from './security';
+export * from './app';

package/lib-esm/types/index.js

@@ -0,0 +1,2 @@
+export*from"./open-api";export*from"./server";export*from"./security";export*from"./app";
+//# sourceMappingURL=index.js.map