redoc 3.0.0-rc.3 → 3.0.0

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

@@ -1,5 +0,0 @@
-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 isFormUrlEncodedMediaType(contentType: string | undefined): boolean;

package/typings/utils/refPointer.d.ts

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

package/typings/utils/resolveSpec.d.ts

@@ -1,20 +0,0 @@
-import type { ApiSpecType } from '../types/common.js';
-/** `convertedFrom` is the AsyncAPI 2.x version the document was converted to 3.0 from. */
-export type ResolvedSpec = {
-    document: unknown;
-    type: ApiSpecType;
-    sdl?: string;
-    convertedFrom?: string;
-};
-export declare function convertedFileName(specUrl: string): string;
-/** A download URL serving the converted document, so Download matches what the page shows. */
-export declare function convertedDownloadUrl(document: unknown): string | undefined;
-/**
- * Loads `spec` (an object, its JSON or YAML text, or GraphQL SDL) or else `specUrl`, bundles it
- * unless `skipBundle`, and converts AsyncAPI documents to 3.x. Throws `DefinitionLoadError`.
- */
-export declare function resolveSpec({ spec, specUrl, skipBundle }: {
-    spec?: Record<string, unknown> | string;
-    specUrl?: string;
-    skipBundle: boolean;
-}): Promise<ResolvedSpec>;

package/typings/utils/resolveText.d.ts

@@ -1,2 +0,0 @@
-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

@@ -1,6 +0,0 @@
-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

@@ -1,49 +0,0 @@
-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[];
-};
-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

@@ -1,4 +0,0 @@
-/** 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

@@ -1,3 +0,0 @@
-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

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

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

@@ -1,2 +0,0 @@
-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

@@ -1,5 +0,0 @@
-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

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

package/typings/utils/string.d.ts

@@ -1,14 +0,0 @@
-/** 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;
-export declare function getFileExtension(value: string): string;
-export declare function transformStringToTelemetryId(...args: string[]): string;

package/typings/utils/url.d.ts

@@ -1,9 +0,0 @@
-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`).
- * e2e and 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

@@ -1,13 +0,0 @@
-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

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

package/typings/utils/yaml.d.ts

@@ -1,2 +0,0 @@
-/** Parses one YAML document. Throws on a syntax error or on more than one document. */
-export declare function parseYaml(text: string): unknown;