redoc 2.5.4 → 3.0.0-rc.1

package/typings/utils/languages.d.ts

@@ -0,0 +1,18 @@
+import type { Language } from '../types/openapi.js';
+/** Every language `codeSamples.languages` accepts. `label` is what users write in config. */
+export declare const DEFAULT_LANGUAGES: Language[];
+/** Tab identity — a custom `label` names the tab. */
+export declare function getLangKey({ lang, label }: {
+    lang: string;
+    label?: string;
+}): string;
+/** Language to generate code in — a custom `label` never changes it. */
+export declare function getGeneratorKey({ lang }: {
+    lang: string;
+}): string;
+/**
+ * Grammar for the syntax highlighter, resolved from the configured language name. Keep this the
+ * only place a language is turned into a grammar: it is many-to-one (`Node.js` and `JavaScript`
+ * both highlight as JavaScript, `Payload` as JSON), so a grammar can never identify a language.
+ */
+export declare function getSyntaxHighlightLang(lang: string): string;

package/typings/utils/loadAndBundleSpec.d.ts

@@ -1,3 +1,4 @@
-import { OpenAPISpec } from '../types';
-export declare function loadAndBundleSpec(specUrlOrObject: object | string): Promise<OpenAPISpec>;
-export declare function convertSwagger2OpenAPI(spec: any): Promise<OpenAPISpec>;
+import type { RedocConfig } from '@redocly/config';
+import type { OpenAPIDefinition } from '../types/openapi.js';
+export declare function loadOpenapiConfig(): Promise<RedocConfig>;
+export declare function loadAndBundleDefinition(specUrlOrObject: Record<string, unknown> | string): Promise<OpenAPIDefinition>;

package/typings/utils/logo.d.ts

@@ -0,0 +1,8 @@
+import type { RawLogo, SidebarLogo } from '../types/common.js';
+/**
+ * Normalizes an authored `{ url }` logo (OpenAPI `info.x-logo`, the standalone `logo` prop) into
+ * the `{ imageUrl }` shape the sidebar renders. `hrefFallback` covers OpenAPI's `info.contact.url`,
+ * as legacy did. Without an image there is nothing to render, hence `undefined` — which is also
+ * what lets callers fall through to the next logo source with `??`.
+ */
+export declare function toSidebarLogo(raw: RawLogo | undefined, hrefFallback?: string): SidebarLogo | undefined;

package/typings/utils/media-type.d.ts

@@ -0,0 +1,7 @@
+import type { FormFieldEncoding } from './form-urlencoded.js';
+export declare function isSequentialMediaType(contentType: string | undefined): boolean;
+export declare function isJsonLikeMediaType(contentType: string | undefined): boolean;
+export declare function langFromMime(contentType: string | undefined): string;
+export declare function normalizeLanguageForHighlight(language: string | undefined): string;
+export declare function isSampleableMediaType(contentType: string | undefined): boolean;
+export declare function encodeExampleForMediaType(value: unknown, mimeType: string, encoding?: Record<string, FormFieldEncoding>): string;

package/typings/utils/multipart.d.ts

@@ -0,0 +1,7 @@
+export type ParsedMultipartPart = {
+    name: string;
+    value?: string;
+    fileName?: string;
+    contentType?: string;
+};
+export declare function parseMultipartFormData(text: string): ParsedMultipartPart[] | undefined;

package/typings/utils/overview-partial-sections.d.ts

@@ -0,0 +1,7 @@
+type Partials = Record<string, unknown>;
+/**
+ * Ids of the headings the overview renders from its `{% partial %}` tags, nested partials
+ * included. Partials are keyed by the resolved `file` attribute, as Markdoc looks them up.
+ */
+export declare function collectOverviewPartialSectionIds(overviewContent: unknown, partials: Partials | undefined): Set<string>;
+export {};

package/typings/utils/refPointer.d.ts

@@ -0,0 +1,2 @@
+export declare function encodeJsonPointerSegment(segment: string): string;
+export declare function refPointerToStoreId(ref: string | undefined): string | undefined;

package/typings/utils/resolveText.d.ts

@@ -0,0 +1,2 @@
+import type { TFunction } from '../hooks/useTranslate.js';
+export declare function resolveText(translate: TFunction, translationKey: string | undefined, text: string | undefined): string;

package/typings/utils/routeKind.d.ts

@@ -0,0 +1,6 @@
+import type { EventPayload } from '@redocly/redoc-opentelemetry';
+import type { ApiItemContent } from '../types/store.js';
+import type { RouteItem } from './routing.js';
+export type RouteKind = NonNullable<EventPayload<'com.redocly.page.viewed'>[0]['kind']>;
+export declare function kindOfContent(content: ApiItemContent | null | undefined): RouteKind;
+export declare function routeKindOf(route: RouteItem | undefined): RouteKind;

package/typings/utils/routing.d.ts

@@ -0,0 +1,51 @@
+import type { ApiItem, ApiItemContent } from '../types/store.js';
+import type { BadgeData } from '../types/common.js';
+export type RouteItem = {
+    path: string;
+    label: string;
+    content: ApiItemContent;
+    badges?: BadgeData[];
+    deprecated?: boolean;
+    eager?: boolean;
+};
+export type TagWithItems = {
+    tag: RouteItem;
+    items: RouteItem[];
+};
+export type RouteIndex = {
+    allRoutes: RouteItem[];
+    tagByPath: Map<string, TagWithItems>;
+    itemToParentTag: Map<string, TagWithItems>;
+    routeIndexByPath: Map<string, number>;
+    rootPage: RouteItem | undefined;
+    tags: RouteItem[];
+    /** Ids of overview headings rendered from partials; they have no route of their own. */
+    overviewPartialSectionIds?: ReadonlySet<string>;
+};
+type CollectRoutesParams = {
+    apiItems: ApiItem[];
+    allRoutes: RouteItem[];
+    tagsWithItems: TagWithItems[];
+    parentTag: TagWithItems | null;
+    allTagsWithItems?: TagWithItems[];
+};
+export declare function buildRouteIndex(allRoutes: RouteItem[], tagsWithItems: TagWithItems[], _basePath: string, allTagsWithItems?: TagWithItems[]): RouteIndex;
+export declare function resolveRouteByPathname(routeIndex: RouteIndex, pathname: string): RouteItem | undefined;
+export declare function collectRoutesRecursively({ apiItems, allRoutes, tagsWithItems, parentTag, allTagsWithItems }: CollectRoutesParams): void;
+export type FlatDescendant = RouteItem & {
+    /** Path of the hub whose open state gates this descendant's render. For
+     *  items under a GROUP sub-tag this is the sub-tag itself; items under a
+     *  non-GROUP sub-tag (an AsyncAPI channel) inherit the channel's own gate,
+     *  so a channel's operations render whenever the channel does. */
+    gatePath: string;
+};
+export type TopLevelEntry = {
+    sectionId: string;
+    content: NonNullable<RouteItem['content']>;
+    path: string;
+    /** Descendants flattened (tag's direct items + any nested sub-tags + their items, in source order). */
+    children: FlatDescendant[];
+};
+export declare function buildTopLevelEntries(routeIndex: RouteIndex): TopLevelEntry[];
+export declare function buildEagerSlugs(activeRoute: RouteItem | undefined, routeIndex: RouteIndex): Set<string>;
+export {};

package/typings/utils/scroll-anchoring.d.ts

@@ -0,0 +1,4 @@
+/** Keeps the section under the reading line in view across a content-height swap
+ *  (response code, oneOf, media type, example selection). Call synchronously from
+ *  the state write. */
+export declare function keepReadingSectionAnchored(): void;

package/typings/utils/security-scope.d.ts

@@ -0,0 +1,3 @@
+export declare function isScopeTruncated(scope: string, maxVisibleScopeChars: number): boolean;
+export declare function getVisibleScopeLabel(scope: string, maxVisibleScopeChars: number): string;
+export declare function normalizeScopes(scopes?: string[]): string[];

package/typings/utils/serialize-parameter.d.ts

@@ -0,0 +1,8 @@
+type ParameterLike = {
+    name: string;
+    in?: string;
+    style?: string;
+    explode?: boolean;
+};
+export declare function serializeParameterValue(param: ParameterLike, value: unknown): string;
+export {};

package/typings/utils/serialize-querystring.d.ts

@@ -0,0 +1,6 @@
+type HarParam = {
+    name: string;
+    value: string;
+};
+export declare function objectToHarParams(obj: unknown, parentKey?: string): HarParam[];
+export {};

package/typings/utils/session-storage.d.ts

@@ -0,0 +1,2 @@
+export declare function toSessionStorage(key: string, value: string): void;
+export declare function fromSessionStorage<T extends string>(key: string): T;

package/typings/utils/split-badges-by-position.d.ts

@@ -0,0 +1,5 @@
+import type { BadgeType } from '../types/schema.js';
+export declare function splitBadgesByPosition(badges: BadgeType[] | undefined): {
+    before: BadgeType[];
+    after: BadgeType[];
+};

package/typings/utils/status-code.d.ts

@@ -0,0 +1 @@
+export declare function isStatusCode(code: string): boolean;

package/typings/utils/string.d.ts

@@ -0,0 +1,18 @@
+/** Spec values are untrusted: keep truthy scalars, drop objects, arrays and nullish. */
+export declare function asString(value: unknown): string | undefined;
+export declare function strikethroughText(text: string): string;
+export declare function encodeBackSlashes(str: string): string;
+export declare function tryDecodeURIComponent(str: string): string;
+/**
+ * slugify() returns empty string when failed to slugify.
+ * so try to return minimum slugified-string with failed one which keeps original value
+ * the regex codes are referenced with https://gist.github.com/mathewbyrne/1280286
+ */
+export declare function safeSlugify(value: string): string;
+export declare function safeJsonParse<T = unknown>(str: string, fallback?: T): T;
+/**
+ * Generates href from item id
+ */
+export declare function getHref(id: string): string;
+export declare function getFileExtension(value: string): string;
+export declare function transformStringToTelemetryId(...args: string[]): string;

package/typings/utils/telemetry.d.ts

@@ -0,0 +1 @@
+export declare function getDefaultCollectorUrl(): string;

package/typings/utils/url.d.ts

@@ -0,0 +1,9 @@
+export declare function joinWithSeparator(base?: string, path?: string, sep?: string): string;
+export declare function normalizePath(path: string): string;
+export declare function stripLeadingSlash(path: string): string;
+/**
+ * The relative item slug used as the wrapper element id (e.g. `pet/getpetbyid`).
+ * Legacy openapi-docs stamped this id, and e2e/consumer locators depend on it.
+ */
+export declare function toElementId(itemPath: string, basePath: string): string | undefined;
+export declare function toRelativePath(absolutePath: string, basePath: string): string;

package/typings/utils/x-logo.d.ts

@@ -0,0 +1,13 @@
+type XLogo = {
+    url?: string;
+    href?: string;
+    altText?: string;
+    backgroundColor?: string;
+};
+export type LogoConfig = XLogo;
+/**
+ * Derives the sidebar logo config from the spec's `info['x-logo']`
+ * extension, falling back to `info.contact.url` for the link.
+ */
+export declare function logoFromSpec(spec: Record<string, unknown> | string | undefined): LogoConfig | undefined;
+export {};

package/typings/utils/xml.d.ts

@@ -0,0 +1 @@
+export declare function jsonToXml(value: unknown): string;

package/typings/yaml-compat.d.ts

@@ -0,0 +1,7 @@
+export declare const parse: (str: any) => unknown;
+export declare const stringify: (obj: any) => string;
+declare const _default: {
+    parse: (str: any) => unknown;
+    stringify: (obj: any) => string;
+};
+export default _default;

package/bundles/d87bcbdbea8f8f5aa26f.worker.js.LICENSE.txt

@@ -1,68 +0,0 @@
-/*!
- * ReDoc - OpenAPI/Swagger-generated API Reference Documentation
- * -------------------------------------------------------------
- *   Version: "2.5.4"
- *   Repo: https://github.com/Redocly/redoc
- */
-
-/*!
- * lunr.Builder
- * Copyright (C) 2020 Oliver Nightingale
- */
-
-/*!
- * lunr.Index
- * Copyright (C) 2020 Oliver Nightingale
- */
-
-/*!
- * lunr.Pipeline
- * Copyright (C) 2020 Oliver Nightingale
- */
-
-/*!
- * lunr.Set
- * Copyright (C) 2020 Oliver Nightingale
- */
-
-/*!
- * lunr.TokenSet
- * Copyright (C) 2020 Oliver Nightingale
- */
-
-/*!
- * lunr.Vector
- * Copyright (C) 2020 Oliver Nightingale
- */
-
-/*!
- * lunr.stemmer
- * Copyright (C) 2020 Oliver Nightingale
- * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt
- */
-
-/*!
- * lunr.stopWordFilter
- * Copyright (C) 2020 Oliver Nightingale
- */
-
-/*!
- * lunr.tokenizer
- * Copyright (C) 2020 Oliver Nightingale
- */
-
-/*!
- * lunr.trimmer
- * Copyright (C) 2020 Oliver Nightingale
- */
-
-/*!
- * lunr.utils
- * Copyright (C) 2020 Oliver Nightingale
- */
-
-/**
- * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9
- * Copyright (C) 2020 Oliver Nightingale
- * @license MIT
- */