@redocly/api-docs 0.2.0-next.4 → 0.2.0-next.6

package/lib/telemetry/RedocTelemetry.js

@@ -1 +1 @@
-import{Telemetry as o}from"@redocly/redoc-opentelemetry";import c from"../../package.json"with{type:"json"};const p="https://otel.cloud.redocly.com/v1/traces";class n extends o{specType;constructor(e){super(),this.specType=e.specType,this.init({otel:{isProd:process.env.NODE_ENV==="production"||process.env.ENABLE_LOCAL_TELEMETRY==="true",serviceVersion:e.serviceVersion||`${c.name}@${c.version}`,version:"1.0.0",collectorTraceUrl:e.collectorUrl||p,serviceName:e.serviceName||"redoc-ce",tracerName:"client-telemetry"},disabled:e.disabled||!1})}send(e,r){r&&Array.isArray(r)&&r.length>0&&(r=r.map(s=>s&&typeof s=="object"?{...s,specType:this.specType}:s)),super.send(e,r,{env:process.env.NODE_ENV})}}export{n as RedocTelemetry};
+import{Telemetry as p}from"@redocly/redoc-opentelemetry";import o from"../../package.json"with{type:"json"};import{DEFAULT_SERVICE_NAME as t,TELEMETRY_DISABLED_BY_DEFAULT as c}from"./defaults.js";const E="https://otel.cloud.redocly.com/v1/traces";class n extends p{specType;typeOfUsage;constructor(e){super(),this.specType=e.specType,this.typeOfUsage=e.typeOfUsage,this.init({otel:{isProd:process.env.NODE_ENV==="production"||process.env.ENABLE_LOCAL_TELEMETRY==="true",serviceVersion:e.serviceVersion||`${o.name}@${o.version}`,version:"1.0.0",collectorTraceUrl:e.collectorUrl||E,serviceName:e.serviceName||t,tracerName:"client-telemetry"},disabled:e.disabled??c})}send(e,s){s&&Array.isArray(s)&&s.length>0&&(s=s.map(r=>r&&typeof r=="object"?{...r,specType:this.specType}:r)),super.send(e,s,{env:process.env.NODE_ENV})}}export{n as RedocTelemetry};

package/lib/telemetry/defaults.d.ts

@@ -0,0 +1,2 @@
+export declare const TELEMETRY_DISABLED_BY_DEFAULT = true;
+export declare const DEFAULT_SERVICE_NAME = "realm-ui";

package/lib/telemetry/defaults.js

@@ -0,0 +1 @@
+const E=!0,t="realm-ui";export{t as DEFAULT_SERVICE_NAME,E as TELEMETRY_DISABLED_BY_DEFAULT};

package/lib/types/code-samples-config.d.ts

@@ -0,0 +1,68 @@
+export type Languages = 'JavaScript' | 'Node.js' | 'curl' | 'Java8+Apache' | 'Java' | 'Python' | 'Go' | 'PHP' | 'C#' | 'C#+Newtonsoft' | 'Ruby' | 'R';
+export interface BasicLanguageOptions {
+    indent?: string;
+    withImports?: boolean;
+    withComments?: boolean;
+}
+interface CodeSampleBasicConfig {
+    lang: Languages | 'Payload';
+    label: string;
+    key: string;
+    options?: BasicLanguageOptions;
+}
+export interface CurlCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'curl';
+    options?: BasicLanguageOptions & {
+        binary?: boolean;
+    };
+}
+export interface JavaScriptCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'JavaScript';
+    options?: BasicLanguageOptions & {
+        credentials?: 'omit' | 'same-origin' | 'include';
+    };
+}
+export interface GoCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'Go';
+}
+export interface NodeJsCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'Node.js';
+}
+export interface PythonCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'Python';
+}
+export interface Java8CodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'Java8+Apache';
+}
+export interface JavaCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'Java';
+}
+export interface CSharpCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'C#';
+}
+export interface CSharpNewtonsoftCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'C#+Newtonsoft';
+}
+export interface PHPCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'PHP';
+}
+export interface RubyCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'Ruby';
+}
+export interface RCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'R';
+}
+export interface PayloadCodeSampleConfig extends CodeSampleBasicConfig {
+    lang: 'Payload';
+}
+export interface CustomLanguageCodeSampleConfig extends Omit<CodeSampleBasicConfig, 'lang'> {
+    lang: string;
+}
+export type CodeSampleConfig = CurlCodeSampleConfig | JavaScriptCodeSampleConfig | NodeJsCodeSampleConfig | PythonCodeSampleConfig | Java8CodeSampleConfig | JavaCodeSampleConfig | CSharpCodeSampleConfig | CSharpNewtonsoftCodeSampleConfig | PHPCodeSampleConfig | GoCodeSampleConfig | RubyCodeSampleConfig | RCodeSampleConfig;
+export interface CodeSamplesConfig {
+    languages: (CodeSampleConfig | PayloadCodeSampleConfig | CustomLanguageCodeSampleConfig)[];
+    skipOptionalParameters?: boolean;
+    withOAuth2Call?: boolean;
+    onSampleTabClick?: (label: string) => void;
+}
+export {};

package/lib/types/common.d.ts

@@ -1,6 +1,6 @@
 import type { Node } from '@markdoc/markdoc';
 import type { ConfigureRequestValues, ConfigureServerRequestValues } from '@redocly/theme/ext/configure';
-import type { UserClaims } from '@redocly/theme/core/types';
+import type { UserClaims } from '@redocly/theme/core/openapi';
 export type { ConfigureRequestValues, ConfigureServerRequestValues };
 export type { UserClaims };
 export type { RbacScopeItems } from '@redocly/config';

package/lib/types/content.d.ts

@@ -1,6 +1,7 @@
 import type { REDOCLY_TEAMS_RBAC } from '@redocly/config';
 import type { Node } from '@markdoc/markdoc';
-import type { OpenAPIOperation, OpenAPIResponse } from './openapi.js';
+import type { OpenAPIResponse } from './openapi.js';
+import type { OpenAPIOperation } from './openapi.js';
 import type { CodeSampleSource } from '../services/code-samples/index.js';
 import type { BadgeData, ServerData, nodeTypes, panelKind } from './common.js';
 import type { GroupItem, ApiItemContent, SecuritySchemeEntry } from './store.js';

package/lib/types/edition-config.d.ts

@@ -0,0 +1,4 @@
+import type { AsyncApiConfig, GraphQLConfig, RedocConfig } from '@redocly/config';
+export type EditionRedocConfig = RedocConfig;
+export type EditionAsyncApiConfig = AsyncApiConfig;
+export type EditionGraphQLConfig = GraphQLConfig;

package/lib/types/events.d.ts

@@ -1,8 +1,8 @@
 import type { Operation } from './options.js';
-export type AnalyticsEventType = 'CodeSampleLanguageSwitched' | 'CodeSampleCopied' | 'OperationServerExpanded' | 'PanelToggle' | 'TargetServerSwitched' | 'TryItOpen' | 'TryItSent';
+export type AnalyticsEventType = 'CodeSampleLanguageSwitched' | 'CodeSampleCopied' | 'OperationServerExpanded' | 'PanelToggle' | 'TryItOpen' | 'TryItSent' | 'TargetServerSwitched';
 export type AnalyticsEvent = {
     eventType: AnalyticsEventType;
-    resource: 'Redocly_CodeSample' | 'Redocly_Operation' | 'Redocly_OperationTryIt';
+    resource: 'Redocly_CodeSample' | 'Redocly_OperationTryIt' | 'Redocly_Operation';
     action: 'LanguageSwitched' | 'PanelToggled' | 'Opened' | 'Closed' | 'NavigatedOverrideLink' | 'Sent' | 'ValidationFailed' | 'CodeSampleCopied' | 'TargetServerSwitched';
     operationId?: string;
     operationPath: string;

package/lib/types/openapi.d.ts

@@ -1,4 +1,5 @@
-import type { ENTITY_RELATION_TYPES, REDOCLY_TEAMS_RBAC, RbacScopeItems } from '@redocly/config';
+import type { REDOCLY_TEAMS_RBAC, RbacScopeItems } from '@redocly/config';
+import type { ENTITY_RELATION_TYPES } from '@redocly/config';
 import type { Node } from '@markdoc/markdoc';
 import type { SecurityDetails as ThemeSecurityDetails } from '@redocly/theme/ext/configure';
 import type { OpenAPIRef, RawLogo, Referenced, SeoData, ExternalDocsData, SecuritySchemeType, SecuritySchemeIn, ObjectValues } from './common.js';

package/lib/types/options.d.ts

@@ -1,7 +1,9 @@
-import type { AsyncApiConfig, GraphQLConfig, LayoutVariant, RedocConfig } from '@redocly/config';
+import type { LayoutVariant } from '@redocly/config';
+import type { RedocConfig } from '@redocly/config';
+import type { EditionAsyncApiConfig, EditionGraphQLConfig, EditionRedocConfig } from './edition-config.js';
 import type { ConfigFunction, Node, Schema } from '@markdoc/markdoc';
 import type { MarkdocTagSchema } from '@redocly/theme/markdoc/tags/types';
-import type { UserClaims } from '@redocly/theme/core/types';
+import type { UserClaims } from '@redocly/theme/core/openapi';
 import type { ConfigureRequestValues, ConfigureServerRequestValues } from '@redocly/theme/ext/configure';
 import type { ReactElement } from 'react';
 import type { ComponentType } from 'react';
@@ -9,8 +11,10 @@ import type { ApiSpecType, SidebarLogo } from './common.js';
 import type { ProtocolVariant } from './asyncapi.js';
 import type { GraphQLOptions } from './graphql.js';
 import type { Events } from './events.js';
+import type { CodeSamplesConfig } from './code-samples-config.js';
 import type { OpenAPIInfo, OpenAPIOperation as OpenAPIOperationType, OpenAPIParameter, OpenAPIServer, OpenAPITag } from './openapi.js';
 import type { Referenced } from './common.js';
+export type * from './code-samples-config.js';
 export type Operation = {
     id: string;
     path: string;
@@ -44,19 +48,30 @@ export type MarkdocOptions = {
  * host supplies the parser (the standalone build supplies a Markdoc-based one; see
  * `markdocParser`). It is the single seam where markdown text becomes an AST.
  */
-export type MarkdownParser = (markdown: string, sanitizeOptions?: Partial<Pick<ApiDocsOptions, 'sanitize' | 'unstable_hooks'>>) => Node | Node[] | undefined;
+export type MarkdownParser = (markdown: string, sanitizeOptions?: {
+    sanitize?: ApiDocsOptions['sanitize'];
+    unstable_hooks?: ApiDocsOptions['unstable_hooks'];
+}) => Node | Node[] | undefined;
 export type ApiDocsOptions = {
-    schemaDefinitionsTagName?: string;
     corsProxyUrl?: string;
+    hideInfoMetadata: boolean;
+    hideReplay: boolean;
+    oAuth2RedirectURI?: string;
+    showSchemaCatalogLinks?: boolean;
+    licenseKey?: string;
+    feedback: NonNullable<RedocConfig['feedback']>;
+    mockServer?: {
+        url: string;
+        position: 'first' | 'last' | 'replace' | 'off';
+        description: string;
+    };
+    schemaDefinitionsTagName?: string;
     jsonSamplesExpandLevel: number;
     generatedSamplesMaxDepth: number;
     hideDownloadButtons: boolean;
-    hideInfoMetadata: boolean;
     hideSchemaTitles: boolean;
     hideSchemaPattern: boolean;
     maxDisplayedEnumValues: number;
-    hideReplay: boolean;
-    oAuth2RedirectURI?: string;
     onlyRequiredInSamples: boolean;
     onDeepLinkClick: ((link: string) => void) | undefined | null;
     schemasExpansionLevel?: number;
@@ -72,7 +87,6 @@ export type ApiDocsOptions = {
     unstable_skipSamples?: boolean;
     unstable_externalCodeSamples: Unstable_ExternalCodeSample[];
     hidePropertiesPrefix: boolean;
-    showSchemaCatalogLinks?: boolean;
     dynamicRequestValues?: ConfigureRequestValues | ConfigureServerRequestValues;
     userClaims?: UserClaims;
     protocol?: ProtocolVariant;
@@ -80,25 +94,19 @@ export type ApiDocsOptions = {
     hideLoading: boolean;
     skipBundle: boolean;
     hideSidebar: boolean;
+    hideSearch: boolean;
     basePath: string;
     specType: ApiSpecType;
-    licenseKey?: string;
     metadata: ApiDocsMetadata;
     downloadUrls?: NormalizedDownloadUrl[];
     layout: LayoutVariant;
-    feedback: NonNullable<RedocConfig['feedback']>;
-    mockServer?: {
-        url: string;
-        position: 'first' | 'last' | 'replace' | 'off';
-        description: string;
-    };
     apiLogo?: SidebarLogo;
     jsonSamplesDepth: number;
     samplesMaxInlineArgs: number;
     fieldExpandLevel: number;
     baseUrlPath?: string;
 } & GraphQLOptions;
-export type RawApiDocsOptions = RedocConfig & AsyncApiConfig & GraphQLConfig & {
+export type RawApiDocsOptions = EditionRedocConfig & EditionAsyncApiConfig & EditionGraphQLConfig & {
     specType: ApiSpecType;
     markdownParser: MarkdownParser;
     basePath?: string;
@@ -107,77 +115,12 @@ export type RawApiDocsOptions = RedocConfig & AsyncApiConfig & GraphQLConfig & {
     licenseKey?: string;
     protocol?: ProtocolVariant;
     excludeFromSearch?: boolean;
+    /** Hides the standalone sidebar search. Portal embeds have their own search. */
+    hideSearch?: boolean;
     dynamicRequestValues?: ConfigureRequestValues | ConfigureServerRequestValues;
     userClaims?: UserClaims;
-    layout?: RedocConfig['layout'] | AsyncApiConfig['layout'] | GraphQLConfig['layout'];
+    layout?: EditionRedocConfig['layout'] | EditionAsyncApiConfig['layout'] | EditionGraphQLConfig['layout'];
 };
-export type Languages = 'JavaScript' | 'Node.js' | 'curl' | 'Java8+Apache' | 'Java' | 'Python' | 'Go' | 'PHP' | 'C#' | 'C#+Newtonsoft' | 'Ruby' | 'R';
-export interface BasicLanguageOptions {
-    indent?: string;
-    withImports?: boolean;
-    withComments?: boolean;
-}
-interface CodeSampleBasicConfig {
-    lang: Languages | 'Payload';
-    label: string;
-    key: string;
-    options?: BasicLanguageOptions;
-}
-export interface CurlCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'curl';
-    options?: BasicLanguageOptions & {
-        binary?: boolean;
-    };
-}
-export interface JavaScriptCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'JavaScript';
-    options?: BasicLanguageOptions & {
-        credentials?: 'omit' | 'same-origin' | 'include';
-    };
-}
-export interface GoCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'Go';
-}
-export interface NodeJsCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'Node.js';
-}
-export interface PythonCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'Python';
-}
-export interface Java8CodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'Java8+Apache';
-}
-export interface JavaCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'Java';
-}
-export interface CSharpCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'C#';
-}
-export interface CSharpNewtonsoftCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'C#+Newtonsoft';
-}
-export interface PHPCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'PHP';
-}
-export interface RubyCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'Ruby';
-}
-export interface RCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'R';
-}
-export interface PayloadCodeSampleConfig extends CodeSampleBasicConfig {
-    lang: 'Payload';
-}
-export interface CustomLanguageCodeSampleConfig extends Omit<CodeSampleBasicConfig, 'lang'> {
-    lang: string;
-}
-export type CodeSampleConfig = CurlCodeSampleConfig | JavaScriptCodeSampleConfig | NodeJsCodeSampleConfig | PythonCodeSampleConfig | Java8CodeSampleConfig | JavaCodeSampleConfig | CSharpCodeSampleConfig | CSharpNewtonsoftCodeSampleConfig | PHPCodeSampleConfig | GoCodeSampleConfig | RubyCodeSampleConfig | RCodeSampleConfig;
-export interface CodeSamplesConfig {
-    languages: (CodeSampleConfig | PayloadCodeSampleConfig | CustomLanguageCodeSampleConfig)[];
-    skipOptionalParameters?: boolean;
-    withOAuth2Call?: boolean;
-    onSampleTabClick?: (label: string) => void;
-}
 export type Normalized<T> = {
     [P in keyof T]-?: T[P];
 };
@@ -257,4 +200,3 @@ export type HooksConfig = {
     MiddlePanelFooter?: HookConfig<undefined>;
     MiddlePanelHeader?: HookConfig<undefined>;
 };
-export {};

package/lib/types/store.d.ts

@@ -80,7 +80,7 @@ export type ExampleEntry = {
     value: unknown;
     key?: string;
     summary?: string;
-    description?: string;
+    description?: string | Node | Node[];
     mediaType?: string;
     externalValue?: string;
     [REDOCLY_TEAMS_RBAC]?: Record<string, string>;

package/lib/utils/deep-link.d.ts

@@ -112,6 +112,7 @@ export declare function isGraphqlDeepLinkAncestor(hash: string, path: string): b
  */
 export declare function getDeepLinkId(deepLink: string | undefined): string | undefined;
 export declare function appendVariantSuffix(fieldParentsName: string[] | undefined, suffix: string): string[];
+export declare function appendArraySuffix(fieldParentsName: string[]): string[];
 /**
  * Remove variant deep-link markers (`&oneof=N`, `&d=N`) from a field-parent path
  * piece, leaving the human-readable name(s). The markers can sit mid-path

package/lib/utils/deep-link.js

@@ -1 +1 @@
-import{encodeBackSlashes as k,tryDecodeURIComponent as a}from"./string.js";import{joinWithSeparator as i,normalizePath as x,toElementId as S}from"./url.js";import{resolveRouteByPathname as A}from"./routing.js";function C(t){const e=[];for(const[n,r]of Object.entries(t))r!==void 0&&e.push(`${n}=${r}`);return e.join("&")}function g(t,e){return t=k(t).replace(/^\/+/,""),(`/${t}#`+i(t,e)).toLowerCase()}function D(t,e,n){const r=g(e,n);return x(i(t,r))}function h(t){const e=t.startsWith("#")?t.slice(1):t;return a(e).toLowerCase()}function b(t){const e=a(t),n=e.indexOf("#");return n>=0?e.slice(n+1):""}function j(t){return C({t:t.t,in:t.in,c:t.c,cb:t.cb,ct:t.ct,path:t.path})}function F(t,e,n){let r=t;return n&&(r=`${r}&c=${n}`),e&&(r=i(r,e)),r}function I(t){const{section:e,messageKey:n,subsection:r}=t;if(!n)return e;let o=`${e}&m=${n}`;return r&&(o+=`&t=${r}`),o}function M(t){return C({t:t.t,path:t.path,arg:t.arg,rt:t.rt})}function P(t,e){return!t||!e?!1:a(t.startsWith("#")?t.slice(1):t).toLowerCase().includes(`path=${e.toLowerCase()}.`)}function v(t){return t&&b(t)||void 0}function z(t,e){const n=[...t??[]];return n.length>0?n[n.length-1]+=e:n.push(e),n}const E=/&(?:oneof|d)=\d+/g;function H(t){return t.replace(E,"")}function q(t){return t.replace(/\[\]/g,"")}function G(t){return(t??[]).filter(e=>e.includes("&")).map(e=>e.slice(e.indexOf("&")))}function U(t,e){return t?a(t.startsWith("#")?t.slice(1):t).toLowerCase().match(new RegExp(`(?:^|[&/])${e}=([^/&]+)`))?.[1]:void 0}const O="callbacks",f=`${O}/`,w="callback-request",T="callback-response",R=[`/${w}`,`/${T}`];function p(t){const e=t.indexOf("path=");return e===-1?t:t.slice(0,e)}function V(t){return t.replace(`/${f}`,"/")}function L(t,e){const n=`cb=${e}`;return t.endsWith(n)||t.includes(`${n}&`)}function W(t,e){const n=`/${e}`;return t.endsWith(n)||t.includes(`${n}/`)}function y(t,e){return t===e||t.startsWith(`${e}/`)}function Q(t,e,n){if(!t||!e||!n)return!1;const r=h(t);if(!y(r,e))return!1;const o=p(r),c=n.toLowerCase();return L(o,c)||W(o,c)}function J(t,e,n){const r=p(t),o=n.toLowerCase();return r.startsWith(i(e,`${f}${o}/`))||r.startsWith(i(e,`${o}/`))||L(r,o)}function X(t,e){const n=p(t).slice(e.length);return!(n.startsWith(`/${f}`)||n.includes("cb=")||R.some(o=>n.includes(o)))}function N(t){const e=["#tag","#operation","#paths"];for(const n of e)if(t.includes(n))return t.replace(n,"").toLowerCase();return""}function Y(t,e,n){const r=h(t);if(!r)return;const o=x(i(e,r));if(A(n,o))return o;const c=N(t);if(!c)return;const l=c.split("/").filter(Boolean);for(let s=l.length;s>0;s--){const $="/"+l.slice(0,s).join("/"),u=n.allRoutes.find(m=>m.path.endsWith($));if(!u)continue;const d=l.slice(s).join("/");return d?`${u.path}#${i(S(u.path,e),d)}`:u.path}}export{O as CALLBACKS_SECTION,w as CALLBACK_REQUEST_SECTION,T as CALLBACK_RESPONSE_SECTION,z as appendVariantSuffix,I as buildAsyncApiSuffix,D as buildDeepLinkUrl,M as buildGraphqlSuffix,j as buildOpenApiFieldSuffix,F as buildOpenApiSectionSuffix,b as deepLinkToId,U as extractDeepLinkParamFromHash,v as getDeepLinkId,N as getLegacyHash,y as hashIsForItem,J as hashIsInsideCallback,X as hashIsOutsideCallbacks,Q as hashTargetsCallback,h as hashToElementId,P as isGraphqlDeepLinkAncestor,g as makeDeepLink,Y as resolveLegacyHashToRoute,C as serializeFieldParams,q as stripArrayMarkers,V as stripCallbacksSegment,H as stripVariantMarkers,G as variantMarkersOnly};
+import{encodeBackSlashes as g,tryDecodeURIComponent as a}from"./string.js";import{joinWithSeparator as i,normalizePath as x,toElementId as k}from"./url.js";import{resolveRouteByPathname as A}from"./routing.js";function h(t){const e=[];for(const[n,r]of Object.entries(t))r!==void 0&&e.push(`${n}=${r}`);return e.join("&")}function b(t,e){return t=g(t).replace(/^\/+/,""),(`/${t}#`+i(t,e)).toLowerCase()}function N(t,e,n){const r=b(e,n);return x(i(t,r))}function C(t){const e=t.startsWith("#")?t.slice(1):t;return a(e).toLowerCase()}function m(t){const e=a(t),n=e.indexOf("#");return n>=0?e.slice(n+1):""}function j(t){return h({t:t.t,in:t.in,c:t.c,cb:t.cb,ct:t.ct,path:t.path})}function F(t,e,n){let r=t;return n&&(r=`${r}&c=${n}`),e&&(r=i(r,e)),r}function I(t){const{section:e,messageKey:n,subsection:r}=t;if(!n)return e;let o=`${e}&m=${n}`;return r&&(o+=`&t=${r}`),o}function M(t){return h({t:t.t,path:t.path,arg:t.arg,rt:t.rt})}function v(t,e){return!t||!e?!1:a(t.startsWith("#")?t.slice(1):t).toLowerCase().includes(`path=${e.toLowerCase()}.`)}function z(t){return t&&m(t)||void 0}function H(t,e){const n=[...t??[]];return n.length>0?n[n.length-1]+=e:n.push(e),n}function q(t){return t.length===0?t:[...t.slice(0,-1),t[t.length-1]+"[]"]}const E=/&(?:oneof|d)=\d+/g;function G(t){return t.replace(E,"")}function U(t){return t.replace(/\[\]/g,"")}function V(t){return(t??[]).filter(e=>e.includes("&")).map(e=>e.slice(e.indexOf("&")))}function P(t,e){return t?a(t.startsWith("#")?t.slice(1):t).toLowerCase().match(new RegExp(`(?:^|[&/])${e}=([^/&]+)`))?.[1]:void 0}const O="callbacks",f=`${O}/`,w="callback-request",T="callback-response",y=[`/${w}`,`/${T}`];function p(t){const e=t.indexOf("path=");return e===-1?t:t.slice(0,e)}function Q(t){return t.replace(`/${f}`,"/")}function L(t,e){const n=`cb=${e}`;return t.endsWith(n)||t.includes(`${n}&`)}function R(t,e){const n=`/${e}`;return t.endsWith(n)||t.includes(`${n}/`)}function W(t,e){return t===e||t.startsWith(`${e}/`)}function J(t,e,n){if(!t||!e||!n)return!1;const r=C(t);if(!W(r,e))return!1;const o=p(r),c=n.toLowerCase();return L(o,c)||R(o,c)}function X(t,e,n){const r=p(t),o=n.toLowerCase();return r.startsWith(i(e,`${f}${o}/`))||r.startsWith(i(e,`${o}/`))||L(r,o)}function Y(t,e){const n=p(t).slice(e.length);return!(n.startsWith(`/${f}`)||n.includes("cb=")||y.some(o=>n.includes(o)))}function _(t){const e=["#tag","#operation","#paths"];for(const n of e)if(t.includes(n))return t.replace(n,"").toLowerCase();return""}function Z(t,e,n){const r=C(t);if(!r)return;const o=x(i(e,r));if(A(n,o))return o;const c=_(t);if(!c)return;const l=c.split("/").filter(Boolean);for(let s=l.length;s>0;s--){const $="/"+l.slice(0,s).join("/"),u=n.allRoutes.find(S=>S.path.endsWith($));if(!u)continue;const d=l.slice(s).join("/");return d?`${u.path}#${i(k(u.path,e),d)}`:u.path}}export{O as CALLBACKS_SECTION,w as CALLBACK_REQUEST_SECTION,T as CALLBACK_RESPONSE_SECTION,q as appendArraySuffix,H as appendVariantSuffix,I as buildAsyncApiSuffix,N as buildDeepLinkUrl,M as buildGraphqlSuffix,j as buildOpenApiFieldSuffix,F as buildOpenApiSectionSuffix,m as deepLinkToId,P as extractDeepLinkParamFromHash,z as getDeepLinkId,_ as getLegacyHash,W as hashIsForItem,X as hashIsInsideCallback,Y as hashIsOutsideCallbacks,J as hashTargetsCallback,C as hashToElementId,v as isGraphqlDeepLinkAncestor,b as makeDeepLink,Z as resolveLegacyHashToRoute,h as serializeFieldParams,U as stripArrayMarkers,Q as stripCallbacksSegment,G as stripVariantMarkers,V as variantMarkersOnly};

package/lib/utils/extract-extensions.js

@@ -1 +1 @@
-const x={"x-circular-ref":!0,"x-complex":!0,"x-parentRefs":!0,"x-refsStack":!0,"x-codeSamples":!0,"x-displayName":!0,"x-examples":!0,"x-logo":!0,"x-nullable":!0,"x-servers":!0,"x-tagGroups":!0,"x-traitTag":!0,"x-additionalPropertiesName":!0,"x-explicitMappingOnly":!0,"x-enumDescriptions":!0,"x-badges":!0,"x-hideReplay":!0,"x-feedback":!0,"x-assertionType":!0,"x-rbac":!0,"x-seo":!0};function n(r){return r in x}function i(r,t){return Object.keys(r).filter(e=>t===!0?e.startsWith("x-")&&!n(e):e.startsWith("x-")&&t.indexOf(e)>-1).reduce((e,u)=>(e[u]=r[u],e),{})}function a(r,t){return t===!1||t===void 0?{}:i(r,t)}export{i as extractExtensions,a as getExtensionsForDisplay,n as isRedocExtension};
+const x={"x-circular-ref":!0,"x-complex":!0,"x-parentRefs":!0,"x-refsStack":!0,"x-codeSamples":!0,"x-displayName":!0,"x-examples":!0,"x-logo":!0,"x-nullable":!0,"x-servers":!0,"x-tagGroups":!0,"x-traitTag":!0,"x-additionalPropertiesName":!0,"x-explicitMappingOnly":!0,"x-enumDescriptions":!0,"x-badges":!0,"x-hideReplay":!0,"x-feedback":!0,"x-assertionType":!0,"x-rbac":!0,"x-seo":!0,"x-keywords":!0,"x-mcp":!0,"x-metadata":!0,"x-summary":!0,"x-tags":!0,"x-usePkce":!0,"x-webhooks":!0};function a(r){return r in x}function n(r,t){return Object.keys(r).filter(e=>t===!0?e.startsWith("x-")&&!a(e):e.startsWith("x-")&&t.indexOf(e)>-1).reduce((e,u)=>(e[u]=r[u],e),{})}function i(r,t){return t===!1||t===void 0?{}:n(r,t)}export{n as extractExtensions,i as getExtensionsForDisplay,a as isRedocExtension};

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

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

package/lib/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 definition's `info['x-logo']`
+ * extension, falling back to `info.contact.url` for the link.
+ */
+export declare function logoFromDefinition(definition: Record<string, unknown> | undefined): LogoConfig | undefined;
+export {};

package/lib/utils/x-logo.js

@@ -0,0 +1 @@
+function c(r){const n=r?.info,o=n?.["x-logo"];if(!o?.url)return;const t=n?.contact;return{url:o.url,href:o.href||t?.url,altText:o.altText,backgroundColor:o.backgroundColor}}export{c as logoFromDefinition};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/api-docs",
-  "version": "0.2.0-next.4",
+  "version": "0.2.0-next.6",
   "description": "Redocly API Documentation Library",
   "type": "module",
   "license": "SEE LICENSE IN LICENSE.md",
@@ -49,12 +49,15 @@
     "url-template": "^2.0.8",
     "web-vitals": "3.3.1",
     "@redocly/allof-merge": "0.6.9",
-    "@redocly/config": "0.53.1",
-    "@redocly/redoc-opentelemetry": "0.2.2",
-    "@redocly/replay": "0.28.0-next.4",
-    "@redocly/theme": "^0.69.0-next.4"
+    "@redocly/config": "0.54.0",
+    "@redocly/redoc-opentelemetry": "0.2.4",
+    "@redocly/replay": "0.28.0-next.6",
+    "@redocly/theme": "^0.69.0-next.6"
   },
   "devDependencies": {
+    "@microsoft/api-extractor": "7.58.2",
+    "@playwright/test": "1.60.0",
+    "@redocly/ajv": "8.18.0",
     "@testing-library/jest-dom": "6.6.3",
     "@testing-library/react": "16.3.0",
     "@types/js-yaml": "4.0.9",
@@ -64,11 +67,13 @@
     "@types/react": "^19.2.7",
     "@types/react-dom": "^19.2.3",
     "@types/swagger2openapi": "^7.0.4",
-    "@vitejs/plugin-react-swc": "4.3.1",
+    "@vitejs/plugin-react": "6.0.1",
     "@vitest/browser-playwright": "4.1.10",
     "@vitest/coverage-v8": "4.1.10",
     "esbuild": "0.28.1",
+    "flexsearch": "^0.8.2",
     "globals": "^16.5.0",
+    "http-server": "14.1.1",
     "jest-styled-components": "7.2.0",
     "react": "^19.2.7",
     "react-dom": "^19.2.7",
@@ -77,10 +82,19 @@
     "tsx": "^4.20.6",
     "typescript": "6.0.3",
     "url": "~0.11.0",
-    "vite": "^7.2.4",
+    "vite": "8.1.0",
     "vitest": "4.1.10",
     "vitest-browser-react": "^2.0.2"
   },
+  "nx": {
+    "targets": {
+      "vitest:test": {
+        "dependsOn": [
+          "build"
+        ]
+      }
+    }
+  },
   "scripts": {
     "start": "vite --open /docs",
     "build": "pnpm run clean && pnpm run ts:check && pnpm run build:lib && pnpm run build:standalone && pnpm run build:minify",
@@ -90,10 +104,17 @@
     "analyze:bundle": "vite build --mode analyze",
     "watch": "tsgo -w -p tsconfig.build.json",
     "clean": "rimraf bundle lib",
+    "prepare:community-source": "tsx ./scripts/prepare-community-source.ts",
+    "prepare:community-dependencies": "tsx ./scripts/prepare-community-dependencies.ts",
+    "apply:community-source": "tsx ./scripts/apply-changes-from-community-source.ts",
+    "stage:ce": "pnpm run prepare:community-dependencies && pnpm run prepare:community-source",
+    "e2e:ce": "pnpm run stage:ce && cd redoc && REDOC_THEME_PATH=../../theme/src npm run e2e",
+    "lint:ce": "cd redoc && test -d src && test -d e2e && test -f vitest.setup.ts && find src e2e vitest.setup.ts -type f \\( -name '*.ts' -o -name '*.tsx' -o -name '*.cts' -o -name '*.mts' \\) -print0 | xargs -0 ./node_modules/.bin/oxlint --max-warnings=0",
     "test": "nx run vitest:test",
     "test:update": "nx run vitest:test -u --skip-nx-cache",
     "test:coverage:html": "nx run vitest:test --coverage --coverage.reporter=html --exclude 'tools/**'",
     "test:tools": "vitest run tools",
+    "test:ce": "pnpm run stage:ce && cd redoc && npm run unit",
     "ts:check": "tsgo -p tsconfig.build.json --noEmit --skipLibCheck"
   }
 }

package/lib/services/code-samples/replay/normalize-servers.js

@@ -1 +0,0 @@
-import{isAbsoluteUrl as l,removeQueryStringAndHash as o,resolveUrl as s}from"../../../adapters/openapi/utils/helpers.js";import{getUrlDirname as i}from"../../../adapters/openapi/utils/url.js";import{IS_BROWSER as u}from"../../../utils/environments.js";function f(e){const t=o(e);if(!t||t.endsWith("/"))return t;const r=t.lastIndexOf("/");return r===-1?"":t.slice(0,r)}function a(e){return e===void 0?o((()=>{if(!u)return globalThis.SSR_HOSTNAME||"";const r=window.location.href;return r.endsWith(".html")&&i(r)||r})()):l(e)?i(e):f(e)}function m(e,t){const r=a(t);return r?s(r,e):e}function S(e,t){let r=t;return r.length===0&&(r=[{url:"/"}]),r.map(n=>({...n,url:m(n.url,e),description:n.description||""}))}export{S as normalizeServers,m as resolveServerUrl};