@redocly/api-docs 0.0.2

package/lib/services/code-samples/replay/har-to-code-sample-har.d.ts

@@ -0,0 +1,41 @@
+import type { GeneratorOptions } from '../generators/types.js';
+import type { CodeSampleHAR } from '../sample-har.js';
+/**
+ * Replay `CodeSample` HAR shape (not exported from `@redocly/replay`).
+ * Kept in sync with `packages/replay/src/components/CodeSample/types.ts`.
+ */
+export type ReplayHar = {
+    httpVersion: string;
+    cookies: {
+        name: string;
+        value: string;
+    }[];
+    url: string;
+    method: string;
+    headers: {
+        name: string;
+        value: string;
+    }[];
+    postData: {
+        mimeType: string;
+        params?: {
+            name: string;
+            value?: string;
+            fileName?: string;
+            contentType?: string;
+        }[];
+        text?: string;
+    } | undefined;
+};
+/**
+ * Converts Replay Try-it / Generate code HAR into {@link CodeSampleHAR} for api-docs generators.
+ */
+export declare function replayHarToCodeSampleHar(replay: ReplayHar): CodeSampleHAR;
+/**
+ * Constructor/instances compatible with Replay `CodeSample` (`new HTTPSnippet(har)` + `convert`).
+ */
+export declare class ReplayCodeSampleHTTPSnippet {
+    private readonly har;
+    constructor(replayHar: ReplayHar);
+    convert(client: string, target: string, options?: GeneratorOptions): string;
+}

package/lib/services/code-samples/replay/har-to-code-sample-har.js

@@ -0,0 +1 @@
+import{generateCodeSample as d}from"../generators/index.js";function v(e){try{return JSON.parse(e)}catch{return}}function T(e){if(!e)return;const t=(e.params??[]).map(r=>({name:r.name,value:r.value,fileName:r.fileName,contentType:r.contentType}));return{mimeType:e.mimeType||"application/octet-stream",params:t,text:e.text??""}}function j(e){const t=e.url.trim();let r=t;const s=e.headers.map(n=>({name:n.name,value:n.value})),a={};for(const n of e.headers)a[n.name]=n.value;let u=[];const m={};try{const n=new URL(t.includes("://")?t:`https://${t.replace(/^\/\//,"")}`);r=n.href,n.searchParams.forEach((h,l)=>{u.push({name:l,value:h}),m[l]=h})}catch{u=[]}const i=e.cookies.map(n=>({name:n.name,value:n.value})),o=T(e.postData);let p;o?.text&&o.mimeType.includes("json")&&(p=v(o.text));const f={method:e.method,httpVersion:e.httpVersion||"HTTP/1.1",url:r,cookies:i,headers:s,queryString:u,postData:o,headersSize:-1,bodySize:-1},c={};return i.length&&(c.cookie=i.map(n=>`${encodeURIComponent(n.name)}=${encodeURIComponent(n.value)}`).join("; ")),Object.assign(c,a),{...f,fullUrl:r,headersObj:a,allHeaders:c,queryObj:m,jsonObj:p,pathParameters:{},serverVariables:{},pathname:r}}function y(e,t){if(e==="shell"&&t==="curl")return"curl";if(e==="javascript"&&t==="fetch")return"javascript";if(e==="node"&&t==="fetch")return"node";if(e==="python"&&t==="requests")return"python";if(e==="java"&&t==="httpclient")return"java"}class b{har;constructor(t){this.har=j(t)}convert(t,r,s){const a=y(t,r);return a?d(a,this.har,s):`// Unsupported client/target: ${t} / ${r}`}}export{b as ReplayCodeSampleHTTPSnippet,j as replayHarToCodeSampleHar};

package/lib/services/code-samples/replay/index.d.ts

@@ -0,0 +1,8 @@
+export { buildCodeSampleSourceFromDocument } from './from-openapi-document.js';
+export { REPLAY_TRY_IT_LOADING_STATE, type ReplayTryItLoadingState, } from '../constants/try-it-loading-state.js';
+export { createReplayOverlayConverter } from './overlay-converter.js';
+export { createReplayConverter, toReplayOperation } from './replay-adapter.js';
+export { handleReplayParamChange } from './replay-handler.js';
+export { pickRuntimeConfigureRequestValues } from './merge-configure-into-source.js';
+export type { ReplayOverlayApi, ReplayOverlayProps } from './replay-types.js';
+export { ReplayCodeSampleHTTPSnippet, replayHarToCodeSampleHar, type ReplayHar, } from './har-to-code-sample-har.js';

package/lib/services/code-samples/replay/index.js

@@ -0,0 +1 @@
+import{buildCodeSampleSourceFromDocument as o}from"./from-openapi-document.js";import{REPLAY_TRY_IT_LOADING_STATE as p}from"../constants/try-it-loading-state.js";import{createReplayOverlayConverter as m}from"./overlay-converter.js";import{createReplayConverter as n,toReplayOperation as R}from"./replay-adapter.js";import{handleReplayParamChange as u}from"./replay-handler.js";import{pickRuntimeConfigureRequestValues as y}from"./merge-configure-into-source.js";import{ReplayCodeSampleHTTPSnippet as T,replayHarToCodeSampleHar as i}from"./har-to-code-sample-har.js";export{p as REPLAY_TRY_IT_LOADING_STATE,T as ReplayCodeSampleHTTPSnippet,o as buildCodeSampleSourceFromDocument,n as createReplayConverter,m as createReplayOverlayConverter,u as handleReplayParamChange,y as pickRuntimeConfigureRequestValues,i as replayHarToCodeSampleHar,R as toReplayOperation};

package/lib/services/code-samples/replay/map-servers.d.ts

@@ -0,0 +1,19 @@
+import type { ReplayServer } from './replay-types.js';
+/**
+ * Minimal server shape shared by {@link CodeSampleSource} servers and pre-normalized OpenAPI servers.
+ */
+export type ReplayServerSource = {
+    url: string;
+    name?: string;
+    description?: string;
+    variables?: Record<string, {
+        default?: string;
+        enum?: string[];
+        description?: string;
+    }>;
+};
+/**
+ * Maps normalized server entries to `@redocly/replay` `Server[]`.
+ * Returns `[{ url: '/' }]` when the list is empty (Replay default).
+ */
+export declare function mapToReplayServers(sources: ReplayServerSource[]): ReplayServer[];

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

@@ -0,0 +1 @@
+function t(n){return n.length?n.map(e=>({url:e.url,name:e.name,description:e.description,variables:e.variables&&Object.keys(e.variables).length>0?Object.fromEntries(Object.entries(e.variables).map(([i,r])=>[i,{enum:r.enum,default:r.default??"",description:r.description}])):void 0})):[{url:"/"}]}export{t as mapToReplayServers};

package/lib/services/code-samples/replay/merge-configure-into-source.d.ts

@@ -0,0 +1,17 @@
+import type { ConfigureRequestValues, ConfigureServerRequestValues } from '@redocly/theme/ext/configure';
+import type { ApiDocsOptions } from '../../../types/options.js';
+import type { ExampleEntry } from '../../../types/store.js';
+import type { CodeSampleSource } from '../source.js';
+export declare function pickRuntimeConfigureRequestValues(options: ApiDocsOptions, hookConfig: ConfigureRequestValues | ConfigureServerRequestValues | null | undefined): ConfigureRequestValues | ConfigureServerRequestValues | undefined;
+/**
+ * Appends configure values whose names match no declared parameter as extra
+ * entries ({ required: false }, schema-less — `toReplayOperation` stringifies
+ * the example and tolerates a missing schema).
+ *
+ * Embedded (markdoc `replay-openapi` tag) path ONLY: legacy `convertParameters`
+ * appended undeclared extras for the embedded tag, but the legacy Try-It
+ * overlay never did — keep the overlay converter away from this to preserve
+ * parity.
+ */
+export declare function appendUndeclaredConfigureParameters(source: CodeSampleSource, configure: ConfigureRequestValues | ConfigureServerRequestValues): CodeSampleSource;
+export declare function mergeConfigureIntoSourceForReplay(source: CodeSampleSource, configure: ConfigureRequestValues | ConfigureServerRequestValues, exampleStore?: Record<string, ExampleEntry>): CodeSampleSource;

package/lib/services/code-samples/replay/merge-configure-into-source.js

@@ -0,0 +1 @@
+import{registerExample as b}from"../../../adapters/helpers.js";import{getEffectiveRequestValues as c,getParamValueMap as o,isDirectRequestValues as V,mergeBodyValue as v,mergeSecurityIntoScheme as h,withServerVariableDefaults as q}from"../../../adapters/openapi/configure/merge-utils.js";function E(e,r){const n=e.dynamicRequestValues;if(n&&Object.keys(n).length>0)return n;if(r&&Object.keys(r).length>0)return r}function g(e,r){return r?e.map(n=>({...n,schemes:n.schemes.map(t=>r[t.id]??r.default?h(t,r):t)})):e}function p(e,r,n){const t=o(r,n);return t?e.map(a=>{const s=t[a.name];return s!==void 0?{...a,example:s}:a}):e}const x=["path","query","header","cookie"];function I(e,r){const n=V(r)?r:c(r,e.servers);if(!n)return e;let t=e.parameters,a=!1;for(const s of x){const i=o(s,n);if(!i)continue;const d=new Set(t[s].map(u=>u.name));if(s==="query")for(const u of t.querystring)d.add(u.name);const m=Object.entries(i).filter(([u,l])=>l!==void 0&&!d.has(u)).map(([u,l])=>({name:u,in:s,required:!1,example:l}));m.length>0&&(t={...t,[s]:[...t[s],...m]},a=!0)}return a?{...e,parameters:t}:e}function y(e,r,n,t){const a=o(r,n);return a?e.map(s=>{const i=a[s.name];return i===void 0?s:{...s,serverValues:{...s.serverValues??{},[t]:{example:i}}}}):e}function O(e,r,n){return r?e.map(t=>({...t,schemes:t.schemes.map(a=>h(a,r,n))})):e}function k(e,r,n){if(!e||r===void 0||!n)return e;const t={};for(const[a,s]of Object.entries(e)){if(!s.exampleIds?.length){t[a]=s;continue}const i=[];for(const d of s.exampleIds){const m=n[d],u=v(m?.value,r),l=b(n,{value:u,summary:m?.summary});i.push(l)}t[a]={...s,exampleIds:i}}return t}function f(e,r,n){const t=r.serverVariables?q(e.servers,r.serverVariables):e.servers;return{...e,servers:t,parameters:{path:p(e.parameters.path,"path",r),query:p(e.parameters.query,"query",r),querystring:p(e.parameters.querystring,"query",r),header:p(e.parameters.header,"header",r),cookie:p(e.parameters.cookie,"cookie",r)},security:g(e.security,r.security),requestBody:k(e.requestBody,r.body,n),requestValues:{...e.requestValues,...r.body!==void 0&&{body:r.body},...r.security&&{security:{...e.requestValues?.security,...r.security}},...r.envVariables&&{envVariables:{...e.requestValues?.envVariables,...r.envVariables}}}}}function S(e,r){let n=e.servers,t=e.security,a=e.parameters;const s={...e.requestValues?.serverBody},i={...e.requestValues?.serverEnvVariables};let d=!1;for(const u of e.servers){const l=r[u.url];l&&(d=!0,l.serverVariables&&(n=q(n,l.serverVariables,u.url)),l.security&&(t=O(t,l.security,u.url)),a={...a,path:y(a.path,"path",l,u.url),query:y(a.query,"query",l,u.url),querystring:y(a.querystring,"query",l,u.url),header:y(a.header,"header",l,u.url),cookie:y(a.cookie,"cookie",l,u.url)},l.body!==void 0&&(s[u.url]=l.body),l.envVariables&&(i[u.url]={...i[u.url],...l.envVariables}))}if(!d)return e;const m={...e.requestValues,...Object.keys(s).length>0&&{serverBody:s},...Object.keys(i).length>0&&{serverEnvVariables:i}};return{...e,servers:n,security:t,parameters:a,requestValues:Object.keys(m).length>0?m:e.requestValues}}function P(e,r,n){if(!r||Object.keys(r).length===0)return e;if(V(r))return f(e,r,n);const t=c(r,e.servers);let a=e;return t&&Object.keys(t).length>0&&(a=f(a,t,n)),a=S(a,r),a}export{I as appendUndeclaredConfigureParameters,P as mergeConfigureIntoSourceForReplay,E as pickRuntimeConfigureRequestValues};

package/lib/services/code-samples/replay/normalize-servers.d.ts

@@ -0,0 +1,3 @@
+import type { OpenAPIServer } from '../../../types/openapi.js';
+export declare function resolveServerUrl(url: string, specUrl?: string): string;
+export declare function normalizeServers(specUrl: string | undefined, servers: OpenAPIServer[]): OpenAPIServer[];

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

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

package/lib/services/code-samples/replay/overlay-converter.d.ts

@@ -0,0 +1,15 @@
+import type { ConfigureRequestValues, ConfigureServerRequestValues } from '@redocly/theme/ext/configure';
+import type { ReplayNormalizedOpenAPIOperation } from './replay-types.js';
+import type { OpenAPIDefinition, OperationInfo } from '../../../types/openapi.js';
+import type { ApiDocsOptions } from '../../../types/options.js';
+import type { ExampleEntry } from '../../../types/store.js';
+import type { CodeSampleSource } from '../source.js';
+import type { HARBuildResolvers } from '../builder.js';
+/** Resolves adapter-time configure values for a fallback-built operation. Empty/undefined return = no overrides. */
+export type StaticConfigureResolver = (operationInfo: OperationInfo, doc: OpenAPIDefinition) => ConfigureRequestValues | ConfigureServerRequestValues | undefined;
+/**
+ * Replay overlay converter: serves operations from the prebuilt source map, falling back
+ * to building from the raw document. Both paths share the same `augmentSource` (runtime merge);
+ * fallback-built operations additionally run `staticConfigureResolver` when provided.
+ */
+export declare function createReplayOverlayConverter(operationSourceMap: Map<string, CodeSampleSource>, resolvers: HARBuildResolvers, options: ApiDocsOptions, configureReplayHook?: ConfigureRequestValues | ConfigureServerRequestValues | null | undefined, exampleStore?: Record<string, ExampleEntry>, staticConfigureResolver?: StaticConfigureResolver): (path: string, method: string, document: unknown) => ReplayNormalizedOpenAPIOperation | undefined;

package/lib/services/code-samples/replay/overlay-converter.js

@@ -0,0 +1 @@
+import{buildCodeSampleSourceFromDocument as v}from"./from-openapi-document.js";import{mergeConfigureIntoSourceForReplay as S,pickRuntimeConfigureRequestValues as C}from"./merge-configure-into-source.js";import{createReplayConverter as R,toReplayOperation as b}from"./replay-adapter.js";import{applyRequestValuesToOperationInfo as k}from"../../../adapters/openapi/configure/apply-request-values.js";import{mergeInMockServer as O,pickOperationServers as T}from"../../../adapters/openapi/utils/merge-mock-server.js";import{openApiContext as q}from"../../../adapters/openapi/buildContext.js";function w(c,u,n){return{storeCtx:c,document:u,options:n,basePath:"/",downloadUrls:[],tagsMap:new Map,hasTopLevelTags:!1,collectedTagOrder:[],badgeTags:[],processContent:!0}}function A(c,u,n,f,m,i){const p=C(n,f),s=p?e=>S(e,p,m):void 0,d=i?(e,a,r)=>{const t=i(e,r);if(!t||Object.keys(t).length===0)return;const l=T(e.servers,r.servers).filter(y=>typeof y?.url=="string"),o=O(l,n.mockServer);q.run(w(a,r,n),()=>k(e,t,o))}:void 0,g=R(c,u,s);return(e,a,r)=>{try{const o=g(e,a,r);if(o)return o}catch(o){console.error("[Replay] createReplayConverter error:",o)}if(!r||typeof r!="object")return;const t=v(e,a,r,n,d);if(!t)return;const l=s?s(t):t;return b(l,u)}}export{A as createReplayOverlayConverter};

package/lib/services/code-samples/replay/replay-adapter.d.ts

@@ -0,0 +1,5 @@
+import type { ReplayNormalizedOpenAPIOperation } from './replay-types.js';
+import type { CodeSampleSource } from '../source.js';
+import type { HARBuildResolvers } from '../builder.js';
+export declare function toReplayOperation(source: CodeSampleSource, resolvers: HARBuildResolvers): ReplayNormalizedOpenAPIOperation;
+export declare function createReplayConverter(operationSourceMap: Map<string, CodeSampleSource>, resolvers: HARBuildResolvers, augmentSource?: (source: CodeSampleSource) => CodeSampleSource): (path: string, method: string, openAPI: unknown) => ReplayNormalizedOpenAPIOperation | undefined;

package/lib/services/code-samples/replay/replay-adapter.js

@@ -0,0 +1 @@
+import{isRecord as h}from"../../../adapters/helpers.js";import{mergeBodyValue as g}from"../../../adapters/openapi/configure/merge-utils.js";import{mapToReplayServers as O}from"./map-servers.js";function x(e){return e.startsWith("#/")?e.slice(2):e}function I(e,a){const t={},n=e.discriminator;if(n?.propertyName&&n.mapping){const i=n.propertyName;for(const[l,o]of Object.entries(n.mapping)){if(typeof o!="string")continue;const s=a.resolveSchema(x(o));if(!s)continue;const p=a.sampleFromSchema(s,{skipReadOnly:!0});p!=null&&(h(p)&&(p[i]=l),t[l]={value:p})}if(Object.keys(t).length>0)return t}if(Array.isArray(e.oneOf)&&e.oneOf.length>0){const i=e.oneOf;for(let l=0;l<i.length;l++){const o=i[l];let s;if(h(o)&&(s=o,typeof o.$ref=="string"&&(s=a.resolveSchema(x(o.$ref))??o)),!s)continue;const p=a.sampleFromSchema(s,{skipReadOnly:!0});if(p==null)continue;const d=typeof s.title=="string"?s.title:`option ${l+1}`;t[d]={value:p}}if(Object.keys(t).length>0)return t}const r=a.sampleFromSchema(e,{skipReadOnly:!0});return r!=null&&(t.default={value:r}),t}function S(e,a,t){const n={};if(e.exampleIds?.length)for(const r of e.exampleIds){const i=a.resolveExample(r);i&&(n[r]={value:i.value,summary:i.summary})}if(Object.keys(n).length===0&&e.schemaId){const r=a.resolveSchema(e.schemaId);r&&Object.assign(n,I(r,a))}if(t!==void 0)if(Object.keys(n).length===0)n.default={value:t};else for(const r of Object.keys(n)){const i=n[r];n[r]={...i,value:g(i.value,t)}}return n}function k(e,a){const t=[],n=(d,f)=>{for(const m of d){const c=m.example;let u;if(m.schemaId){const y=a.resolveSchema(m.schemaId);y&&(u={typePrefix:"",title:y.title??m.name,displayType:y.type??"string",displayFormat:y.format,constraints:[],enum:y.enum??void 0})}t.push({name:m.name,in:f,required:m.required??!1,example:c!=null?String(c):void 0,schema:u})}};n(e.parameters.path,"path"),n(e.parameters.query,"query"),n(e.parameters.header,"header"),n(e.parameters.cookie,"cookie");for(const d of e.parameters.querystring)t.push(v(d,a));const r=O(e.servers),i=e.security.map(d=>d.schemes.map(f=>R(f,d.scopes)));let l;if(e.requestBody){const d=e.requestValues?.body,f={};for(const[m,c]of Object.entries(e.requestBody)){const u=S(c,a,d);f[m]={name:m,examples:Object.keys(u).length>0?u:void 0,schema:c.schemaId?a.resolveSchema(c.schemaId):void 0,parameters:[]}}l={mediaTypes:f}}const o=e.method.toLowerCase(),s=`${o}:${e.path}`,p=e.openApiOperationId??s;return{id:p,name:e.summary||`${e.method.toUpperCase()} ${e.path}`,method:o,path:e.path,href:"",operationId:p,parameters:t,servers:r,security:i,body:l}}function v(e,a){const t=e.schemaId?a.resolveSchema(e.schemaId):void 0,n=e.example!=null?e.example:t?a.sampleFromSchema(t,{skipReadOnly:!0}):void 0,r=b(t,n),i={typePrefix:"",title:t?.title??e.name,displayType:t?.type??"object",constraints:[],...r&&r.length>0?{fields:r}:{},...n!==void 0?{example:n}:{}};return{name:e.name,in:"querystring",required:e.required??!1,schema:i}}function b(e,a){const t=e?.properties;if(!t)return;const n=h(a)?a:{};return Object.keys(t).map(r=>{const i=n[r]!==void 0?n[r]:t[r]?.example;return{name:r,example:i}})}function R(e,a){return{id:e.id,type:e.type,name:e.name,in:e.in==="querystring"?"query":e.in,scheme:e.scheme,openIdConnectUrl:e.openIdConnectUrl,scopes:a,flows:e.flows,"x-defaultAccessToken":e["x-defaultAccessToken"],"x-defaultTokenType":e["x-defaultTokenType"],"x-defaultClientId":e["x-defaultClientId"],"x-defaultClientSecret":e["x-defaultClientSecret"],"x-defaultUsername":e["x-defaultUsername"],"x-defaultPassword":e["x-defaultPassword"],serverValues:e.serverValues}}function C(e,a,t){return(n,r,i)=>{const l=`${r.toLowerCase()}:${n}`,o=e.get(l);if(!o)return;const s=t?t(o):o;return k(s,a)}}export{C as createReplayConverter,k as toReplayOperation};

package/lib/services/code-samples/replay/replay-handler.d.ts

@@ -0,0 +1,5 @@
+import type { ReplayOnChangeParams } from '@redocly/replay';
+export declare function handleReplayParamChange(params: ReplayOnChangeParams, setEnvironment: (payload: {
+    environment?: string;
+    environments?: Record<string, Record<string, string>>;
+}) => void, updateRequestValues: (operationPath: string, operationMethod: string, values: Record<string, unknown>) => void): void;

package/lib/services/code-samples/replay/replay-handler.js

@@ -0,0 +1 @@
+function m(n,a,r){(n.environment||n.environments)&&a({environment:n.environment,environments:n.environments});for(const h of n.operations??[]){const{apiPath:t,requestValues:e,activeSecuritySchemeIds:o,activeExampleName:c}=h,i={};e.header&&Object.keys(e.header).length>0&&(i.headers=e.header),e.query&&Object.keys(e.query).length>0&&(i.queryString=e.query),e.cookie&&Object.keys(e.cookie).length>0&&(i.cookies=e.cookie),e.body!==void 0&&(i.body=e.body),o?.length&&(i.activeSecuritySchemeIds=o),c&&(i.activeExampleName=c),n.activeMimeName&&(i.activeMimeName=n.activeMimeName),r(t.path,t.method,i)}}export{m as handleReplayParamChange};

package/lib/services/code-samples/replay/replay-predefined-env.d.ts

@@ -0,0 +1,4 @@
+import type { OpenAPIDefinition, OpenAPIServer } from '../../../types/openapi.js';
+import type { MockServerOptions } from '../../../adapters/openapi/utils/merge-mock-server.js';
+export declare function buildServerEnvValues(servers: OpenAPIServer[]): Record<string, Record<string, string>>;
+export declare function buildReplayPredefinedEnvValues(definition: OpenAPIDefinition, mockServer: MockServerOptions): Record<string, Record<string, string>>;

package/lib/services/code-samples/replay/replay-predefined-env.js

@@ -0,0 +1 @@
+import{mergeInMockServer as i}from"../../../adapters/openapi/utils/merge-mock-server.js";import{normalizeServers as m}from"./normalize-servers.js";import{getServerEnvName as l}from"../../../utils/environments.js";function f(r){const t=m(void 0,r);return Object.fromEntries(t.map(e=>[String(l(e)),{server:e.url,...Object.fromEntries(Object.entries(e.variables??{}).map(([n,o])=>[n,o.default||""]))}]))}function p(r,t){const e=i((r.servers??[]).filter(n=>typeof n?.url=="string"),t);return f(e)}export{p as buildReplayPredefinedEnvValues,f as buildServerEnvValues};

package/lib/services/code-samples/replay/replay-types.d.ts

@@ -0,0 +1,75 @@
+import type { ComponentProps } from 'react';
+import type { OperationIn, ReplayOverlay } from '@redocly/replay';
+import type { OpenAPIServer, OpenAPIServerVariable } from '../../../types/openapi.js';
+import type { SecuritySchemeEntry } from '../source.js';
+export type ReplayOverlayProps = ComponentProps<typeof ReplayOverlay>;
+export type ReplayOverlayApi = NonNullable<ReplayOverlayProps['api']>;
+type StringDescription = {
+    description?: string;
+};
+export type ReplayServer = Omit<OpenAPIServer, 'description' | 'variables'> & StringDescription & {
+    variables?: Record<string, Omit<OpenAPIServerVariable, 'description'> & StringDescription>;
+};
+export type ReplayOperationSecurity = Omit<SecuritySchemeEntry, 'in'> & {
+    in?: 'query' | 'header' | 'cookie';
+    scopes: string[];
+};
+export type ReplayQuerystringField = {
+    name: string;
+    example?: unknown;
+};
+export type ReplayOperationParameterSchema = {
+    typePrefix: string;
+    title: string;
+    displayType: string;
+    displayFormat?: string;
+    contentEncoding?: string;
+    constraints: string[];
+    enum?: string[];
+    fields?: ReplayQuerystringField[];
+    example?: unknown;
+};
+export type ReplayOperationParameter = {
+    name: string;
+    in: OperationIn;
+    required: boolean;
+    description?: string | {
+        raw: string;
+        result: unknown;
+    };
+    example?: unknown;
+    schema?: ReplayOperationParameterSchema;
+    allowReserved?: boolean;
+};
+export type ReplayMediaType = {
+    name: string;
+    examples?: Record<string, {
+        value: unknown;
+        summary?: string | Record<string, unknown>;
+        description?: string;
+    }>;
+    schema?: object;
+    parameters: {
+        inputType: 'file' | 'text';
+        name: string;
+        example: string;
+    }[];
+};
+export type ReplayMediaTypes = Record<string, ReplayMediaType>;
+export type ReplayNormalizedOpenAPIOperation = {
+    id: string;
+    name: string;
+    method: string;
+    path: string;
+    href: string;
+    operationId?: string;
+    parameters: ReplayOperationParameter[];
+    body?: {
+        mediaTypes: ReplayMediaTypes;
+        required?: boolean;
+        activeExampleName?: string;
+    };
+    servers: ReplayServer[];
+    security?: ReplayOperationSecurity[][];
+};
+export {};

package/lib/services/code-samples/resolvers.d.ts

@@ -0,0 +1,5 @@
+import type { HARBuildResolvers } from './builder.js';
+import type { SchemaEntry, ExampleEntry } from '../../types/store.js';
+import type { ApiDocsOptions } from '../../types/options.js';
+export declare function buildOpenApiStubForSampler(schemaStore: Record<string, SchemaEntry>, activeDiscriminator?: Record<string, number>, activeOneOf?: Record<string, number>): Record<string, unknown>;
+export declare function createCodeSampleResolvers(schemaStore: Record<string, SchemaEntry>, exampleStore: Record<string, ExampleEntry>, options: Pick<ApiDocsOptions, 'onlyRequiredInSamples' | 'generatedSamplesMaxDepth'>, activeDiscriminator?: Record<string, number>, activeOneOf?: Record<string, number>): HARBuildResolvers;

package/lib/services/code-samples/resolvers.js

@@ -0,0 +1 @@
+import*as p from"openapi-sampler";import{serializeParameterValue as l}from"../../utils/serialize-parameter.js";import{applyActiveVariantsToSchema as c,applyActiveVariantsToStore as u,applyDiscriminatorValue as y,hoistActiveVariantSchemaForSampling as d}from"./discriminator.js";function f(t,m,i){const o=u(t,m,i),n={};for(const[a,r]of Object.entries(o)){const e=a.startsWith("components/schemas/")?a.replace("components/schemas/",""):a;n[e]=r}return{openapi:"3.0.0",info:{title:"",version:""},paths:{},components:{schemas:n}}}function k(t,m,i,o,n){const a=f(t,o,n);return{resolveSchema(r){return t[r]?.data},resolveExample(r){const e=m[r];if(e)return{value:e.value,summary:e.summary,key:e.key}},sampleFromSchema(r,e){try{return p.sample(r,{skipReadOnly:e.skipReadOnly,skipWriteOnly:e.skipWriteOnly,quiet:!0,skipNonRequired:i.onlyRequiredInSamples,maxSampleDepth:e.maxDepth??i.generatedSamplesMaxDepth,...e.format==="xml"&&{format:"xml"}},a)}catch{return}},serializeParameter(r,e){return typeof e!="object"||e===null?String(e??""):l({name:r.name,in:r.in},e)},resolveVariantSchemaForSampling(r){const e=d(r,t,o,n),s=e?.schema??t[r]?.data;if(s)return{schema:c(s,t,n),variantSchemaId:e?.variantSchemaId??r}},applyDiscriminatorValue(r,e){!r||typeof r!="object"||Array.isArray(r)||y(r,e,t)}}}export{f as buildOpenApiStubForSampler,k as createCodeSampleResolvers};

package/lib/services/code-samples/sample-har.d.ts

@@ -0,0 +1,41 @@
+import type * as HAR from './har.js';
+export type OAuth2PreRequest = HAR.Request & {
+    flowType: 'clientCredentials' | 'password' | 'deviceAuthorization';
+    tokenUrl: string;
+    clientId: string;
+    clientSecret?: string;
+    username?: string;
+    password?: string;
+    scopes?: string[];
+};
+export interface CodeSampleHAR extends HAR.Request {
+    /** Full URL with query string, server variables unescaped */
+    fullUrl: string;
+    /** Alias for generators that use `urlFieldName: 'pathname'` (e.g. Java); equals `fullUrl` from {@link buildCodeSampleHAR}. */
+    pathname?: string;
+    /** Headers as a plain object (convenience for generators) */
+    headersObj: Record<string, string>;
+    /** Headers + Cookie header synthesized from cookies (parity with openapi-docs prepare()) */
+    allHeaders: Record<string, string>;
+    /** Query params as a plain object. Duplicate keys collapse into arrays. */
+    queryObj: Record<string, string | string[]>;
+    /** Parsed JSON body (when postData is JSON) */
+    jsonObj?: Record<string, unknown>;
+    /** URL-encoded params as a plain object. Duplicate keys collapse into arrays. */
+    paramsObj?: Record<string, string | string[]>;
+    /** Extracted basic auth credentials (removed from headers) */
+    basicAuth?: {
+        username: string;
+        password: string;
+    };
+    /** Path parameters: { paramName → resolved value } */
+    pathParameters: Record<string, string>;
+    /** Server template variables: { varName → resolved value } */
+    serverVariables: Record<string, string>;
+    /** All response status codes from the operation */
+    responseCodes?: string[];
+    /** Alias for responseCodes (matches openapi-docs SnippetRequest field name) */
+    allResponseCodes?: string[];
+    /** OAuth2 pre-request calls for client credentials / device auth flows */
+    oAuth2PreRequests?: OAuth2PreRequest[];
+}

package/lib/services/code-samples/server-variables.d.ts

@@ -0,0 +1,11 @@
+type ServerWithVariables = {
+    url: string;
+    variables?: Record<string, {
+        default?: string;
+    }>;
+};
+/** Substitutes `{variable}` placeholders in a server URL with the variables' default values. */
+export declare function replaceServerVariables(server: ServerWithVariables): string;
+/** The environment may hold either the raw (templated) or the substituted server URL — match both. */
+export declare function serverMatchesUrl(server: ServerWithVariables, url: string | undefined): boolean;
+export {};

package/lib/services/code-samples/server-variables.js

@@ -0,0 +1 @@
+function a(r){let{url:e,variables:t}=r;if(t)for(const l in t){const n=t[l].default;n!==void 0&&(e=e.replaceAll(`{${l}}`,n))}return e}function f(r,e){return e?r.url===e||a(r)===e:!1}export{a as replaceServerVariables,f as serverMatchesUrl};

package/lib/services/code-samples/source.d.ts

@@ -0,0 +1,107 @@
+import type { OpenAPIParameterLocation } from '../../types/openapi.js';
+import type { SecuritySchemeIn, SecuritySchemeType } from '../../types/common.js';
+import type { OAuthFlowsData, SecuritySchemeCredentials } from '../../types/store.js';
+import type { securitySchemeType } from '../../types/common.js';
+import type { panelKind } from '../../types/common.js';
+export type { OAuthFlowsData, SecuritySchemeCredentials };
+export type ServerVariable = {
+    default?: string;
+    enum?: string[];
+    description?: string;
+};
+export type ServerEntry = {
+    url: string;
+    name?: string;
+    description?: string;
+    variables?: Record<string, ServerVariable>;
+    /** Set on entries injected by `mergeInMockServer` (never present in specs). */
+    isMockServer?: boolean;
+};
+export type ParameterEntry = {
+    name: string;
+    in: OpenAPIParameterLocation;
+    required?: boolean;
+    deprecated?: boolean;
+    example?: unknown;
+    schemaId?: string;
+    serializationMime?: string;
+    style?: string;
+    explode?: boolean;
+    /** Per-server example overrides: serverUrl → example value */
+    serverValues?: Record<string, {
+        example?: unknown;
+    }>;
+};
+export type SecuritySchemeEntry = {
+    id: string;
+    type: Exclude<SecuritySchemeType, typeof securitySchemeType.MUTUAL_TLS>;
+    name?: string;
+    in?: SecuritySchemeIn;
+    scheme?: string;
+    bearerFormat?: string;
+    openIdConnectUrl?: string;
+    flows?: OAuthFlowsData;
+    'x-defaultAccessToken'?: string;
+    'x-defaultTokenType'?: string;
+    'x-defaultClientId'?: string;
+    'x-defaultClientSecret'?: string;
+    'x-defaultUsername'?: string;
+    'x-defaultPassword'?: string;
+    /** Per-server auth overrides */
+    serverValues?: Record<string, SecuritySchemeCredentials>;
+};
+/** One AND-group: all schemes in the array must be satisfied together */
+export type SecurityRequirement = {
+    schemes: SecuritySchemeEntry[];
+    scopes: string[];
+};
+export type MediaTypeEntry = {
+    schemaId?: string;
+    exampleIds?: string[];
+};
+export type DefinitionCodeSample = {
+    lang: string;
+    label?: string;
+    source: string;
+};
+export type CodeSampleRequestValues = {
+    security?: Record<string, unknown>;
+    envVariables?: Record<string, string>;
+    serverEnvVariables?: Record<string, Record<string, string>>;
+    body?: unknown;
+    serverBody?: Record<string, unknown>;
+};
+export type CodeSampleSource = {
+    kind: typeof panelKind.CODE_SAMPLE;
+    operationType: 'http' | 'webhook' | 'callback';
+    method: string;
+    path: string;
+    servers: ServerEntry[];
+    parameters: {
+        path: ParameterEntry[];
+        query: ParameterEntry[];
+        querystring: ParameterEntry[];
+        header: ParameterEntry[];
+        cookie: ParameterEntry[];
+    };
+    security: SecurityRequirement[];
+    /** mediaType name → { schemaId, exampleIds } */
+    requestBody?: Record<string, MediaTypeEntry>;
+    /** Pre-authored code samples from the spec (x-codeSamples) */
+    definitionSamples?: DefinitionCodeSample[];
+    /** Response status codes (for generators that include expected status) */
+    responseCodes?: string[];
+    /** Configure request values (security credentials, env vars, per-server env vars) */
+    requestValues?: CodeSampleRequestValues;
+    /** Raw pointer into the spec (for deep linking) */
+    pointer?: string;
+    /** Docs route slug of the operation page, relative to the routing base path
+     * (e.g. `operations/getmuseumhours`) — used by Replay "View in description" */
+    href?: string;
+    /** OpenAPI `operationId` — should match the loaded spec so Replay `onRequestChange` can resolve steps */
+    openApiOperationId?: string;
+    /** OpenAPI operation `summary` — used as the human-readable operation name in Replay (Try It) */
+    summary?: string;
+    /** OpenAPI `security` array (AND-groups) for multi-scheme UI selection */
+    securityGroups?: Array<Record<string, string[]>>;
+};

package/lib/services/code-samples/use-resolvers.d.ts

@@ -0,0 +1,2 @@
+import type { HARBuildResolvers } from './builder.js';
+export declare function useCodeSampleResolvers(): HARBuildResolvers;

package/lib/services/code-samples/use-resolvers.js

@@ -0,0 +1 @@
+import{useContext as n,useMemo as e}from"react";import{useAtomValue as o}from"jotai";import{schemaStoreAtom as a}from"../../jotai/schema.js";import{activeDiscriminatorSelectAtom as p,activeOneOfSelectAtom as f}from"../../jotai/itemStore.js";import{ItemIdContext as l}from"../../hooks/useDeepLinkSection.js";import{exampleStoreAtom as S}from"../../jotai/examples.js";import{globalOptionsAtom as u}from"../../jotai/store.js";import{createCodeSampleResolvers as v}from"./resolvers.js";function R(){const m=o(a),r=o(S),i=o(u),t=n(l),s=o(e(()=>p(t??""),[t])),c=o(e(()=>f(t??""),[t]));return e(()=>v(m,r,i,s,c),[m,r,i,s,c])}export{R as useCodeSampleResolvers};

package/lib/services/code-samples/utils/map-request-values.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Maps values stored from Replay (`handleReplayParamChange`) into the shape
+ * expected by `buildCodeSampleHAR` selections (`tryItValues` per location).
+ * Request body is passed separately as `HARBuildSelections.replayBody` (see `CodeSampleItem`).
+ */
+export declare function mapReplayAtomValuesToHarRequestValues(v: Record<string, unknown>): Record<string, Record<string, unknown>>;

package/lib/services/code-samples/utils/map-request-values.js

@@ -0,0 +1 @@
+function o(e){const t={};return e.headers&&typeof e.headers=="object"&&(t.header=e.headers),e.queryString&&typeof e.queryString=="object"&&(t.query=e.queryString),e.cookies&&typeof e.cookies=="object"&&(t.cookie=e.cookies),e.path&&typeof e.path=="object"&&(t.path=e.path),t}export{o as mapReplayAtomValuesToHarRequestValues};

package/lib/services/license/check.d.ts

@@ -0,0 +1,14 @@
+export type LicenseInfo = {
+    t?: boolean;
+    i?: number;
+    e?: number;
+    h?: string[] | true;
+    valid?: boolean;
+    expired?: boolean;
+    allowed?: boolean;
+    local?: boolean;
+    cryptoMissing?: boolean;
+};
+export declare function isHostAllowed(hostname: string, hosts: string[] | boolean | undefined): boolean;
+export declare function parseLicense(key?: string): Promise<LicenseInfo>;
+export default parseLicense;

package/lib/services/license/check.js

@@ -0,0 +1 @@
+const a="MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAMHjNir5fXx/ZXoaEeXQ5XyxbNJ4YJYczoCRdSkL6NLzw1FHnng5Vfcgk5+bvox9QRYRbuk84mA4f2NhywDbXKECAwEAAQ==",o=typeof window<"u"&&(window.crypto||window.msCrypto)||void 0;function u(e){return"then"in e?e:new Promise(t=>{e.oncomplete=n=>{t(n.target.result)}})}function f(e){const t=new ArrayBuffer(e.length),n=new Uint8Array(t);for(let i=0,r=e.length;i<r;i++)n[i]=e.charCodeAt(i);return t}function l(e){if(typeof TextEncoder<"u")return new TextEncoder().encode(e);const t=unescape(encodeURIComponent(e)),n=new Uint8Array(t.length);for(let i=0;i<t.length;i++)n[i]=t.charCodeAt(i);return n}function c(){const e=f(atob(typeof REDOCLY_PUBLIC_KEY<"u"?REDOCLY_PUBLIC_KEY:a));return u(o.subtle.importKey("spki",e,{name:"RSASSA-PKCS1-v1_5",hash:"SHA-256"},!0,["verify"]))}async function d(e,t){return u(o.subtle.verify({name:"RSASSA-PKCS1-v1_5",hash:"SHA-256"},await c(),f(atob(t)),l(e)))}function s(e,t){return t===!0?!0:Array.isArray(t)&&typeof window<"u"?e==="localhost"||e==="127.0.0.1"||e.endsWith(".localhost")||t.find(n=>n===e||e.endsWith("."+n))?!0:!!t.find(n=>{if(n.indexOf("*")!==n.lastIndexOf("*"))return!1;const[i,r]=n.split("*");return!!r&&e.startsWith(i)&&e.endsWith(r)&&r.split(".").length>2}):!1}async function w(e){if(process.env.NODE_ENV==="development")return{valid:!0,allowed:!0};const t=window.location.hostname;if(!e)return t==="localhost"||t==="127.0.0.1"||t.endsWith(".localhost")?{local:!0}:{};const[n,i]=e.split(".");let r;try{if(!await d(atob(n),i))return{valid:!1};r=JSON.parse(atob(n))}catch{return{valid:!1,cryptoMissing:!0}}return r.valid=!0,(!r.e||Date.now()/1e3>r.e)&&(r.expired=!0),r.allowed=s(t,r.h),r}var p=w;export{p as default,s as isHostAllowed,w as parseLicense};

package/lib/services/operation-samples/index.d.ts

@@ -0,0 +1,14 @@
+import type { OpenAPIDefinition } from '../../types/openapi.js';
+import type { ApiDocsOptions } from '../../types/options.js';
+import type { CodeSampleAttributes, CodeSampleBlock, MediaSampleBlock, OperationSampleContext, OperationSampleIdentifier } from './types.js';
+export type * from './types.js';
+export declare function resolveOperationSampleContext(doc: OpenAPIDefinition, options: ApiDocsOptions, identifier: OperationSampleIdentifier): OperationSampleContext | undefined;
+export declare function buildCodeSamples(ctx: OperationSampleContext, attributes?: CodeSampleAttributes): CodeSampleBlock[];
+export declare function getRequestBodySamples(ctx: OperationSampleContext, { exampleKey, mimeType, titlePrefix, }?: {
+    exampleKey?: string;
+    mimeType?: string;
+    titlePrefix?: string;
+}): MediaSampleBlock[];
+export declare function getResponseSamples(ctx: OperationSampleContext, { exampleKey }?: {
+    exampleKey?: string;
+}): MediaSampleBlock[];

package/lib/services/operation-samples/index.js

@@ -0,0 +1,2 @@
+import*as B from"openapi-sampler";import{createStoreContext as I,resolveContent as C,resolveRef as h,toRecord as u}from"../../adapters/helpers.js";import{populateOpenApiStore as M}from"../../adapters/openapi/store.js";import{buildCodeSampleSource as N}from"../../adapters/openapi/build-code-sample-source.js";import{resolveOpenApiExampleValue as w}from"../../adapters/openapi/resolve-openapi-example-value.js";import{JsonPointer as b}from"../../adapters/openapi/utils/JsonPointer.js";import{createCodeSampleResolvers as A}from"../code-samples/resolvers.js";import{buildCodeSampleHAR as P}from"../code-samples/builder.js";import{tryGenerateCodeSample as T}from"../code-samples/generators/index.js";import{convertSampleToString as E}from"../code-samples/convertSampleToString.js";import{encodeExampleForMediaType as K,isSampleableMediaType as D,isSequentialMediaType as V,langFromMime as W}from"../../utils/media-type.js";import{getGeneratorKey as $,getLangKey as g}from"../../utils/languages.js";import{getServerEnvName as q}from"../../utils/environments.js";import{isOperationName as R}from"../../utils/http-methods.js";import{isStatusCode as F}from"../../utils/status-code.js";let v=null;function G(t,e){const n=e.ignoreNamedSchemas,o=n?[...n].sort().join(`
+`):"";if(v?.doc===t&&v.optionsKey===o)return v.ctx;const r=I(u(t));return M(t,r,e),v={doc:t,optionsKey:o,ctx:r},r}function L(t,e){const n=t.paths;if(!(!n||typeof n!="object")){for(const[o,r]of Object.entries(n))if(!(!r||typeof r!="object"))for(const[s,i]of Object.entries(r)){if(!R(s)||!i||typeof i!="object")continue;const a=i;if(a.operationId===e)return{pathName:o,method:s,operation:a,pointer:b.compile(["paths",o,s])}}}}function U(t,e){const n=b.parse(e),o=n.indexOf("paths"),r=o>=0?n[o+1]:void 0,s=o>=0?n[o+2]:void 0;if(!r||!s||!R(s))return;const a=t.paths?.[r]?.[s];if(!(!a||typeof a!="object"))return{pathName:r,method:s,operation:a,pointer:b.compile(["paths",r,s])}}function H(t,{operationId:e,pointer:n}){if(e)return L(t,e);if(n)return U(t,n)}function ue(t,e,n){const o=H(t,n);if(!o)return;const{pathName:r,method:s,operation:i,pointer:a}=o,p=t.paths?.[r]??{},l={pointer:a,pathName:r,httpVerb:s.toUpperCase(),operationId:i.operationId,summary:typeof i.summary=="string"?i.summary:void 0,isWebhook:!1,isAdditionalOperation:!1,tags:i.tags??[],parameters:J(t,p.parameters,i.parameters),requestBody:i.requestBody,responses:i.responses,servers:i.servers??p.servers??t.servers,security:i.security},m=G(t,e),d=N(l,m,e,e.ignoreNamedSchemas),O=i["x-codeSamples"];O?.length&&(d.definitionSamples=O.map(({lang:S,label:c,source:f})=>({lang:S,label:c,source:f})));const y=A(m.schemaStore,m.exampleStore,e);return{doc:t,options:e,operation:i,pathName:r,method:s,source:d,storeCtx:m,resolvers:y}}function J(t,e,n){if(!e?.length)return n;if(!n?.length)return e;const o=u(t),r=a=>{const p=h(o,a)??a;return`${p.in}:${p.name}`},s=new Set(n.map(r));return[...e.filter(a=>!s.has(r(a))),...n]}function z(t,{environment:e,environments:n}){let o=t;if(e){const r=o.filter(s=>String(q(s))===e||s.url===e);o=r.length?r:o}return n&&(o=o.map(r=>{const s=n[String(q(r))]?.server;return s?{...r,url:s}:r})),o}function le(t,e={}){const{source:n,options:o}=t,r=o.codeSamples?.languages??[],s=new Map(r.map((c,f)=>[c.key,f])),i=z(n.servers,e),a=e.environment&&e.environments?.[e.environment]||{},p=(n.definitionSamples??[]).filter(c=>s.has(g(c))&&typeof c.source=="string"),l=new Set(p.map(g)),m={serverUrl:i[0]?.url??a.server,mediaType:e.mimeType,exampleName:e.exampleKey,environment:a,requestValues:e.parameters,replayBody:e.requestBody},d={skipOptionalParameters:o.codeSamples?.skipOptionalParameters,withOAuth2Call:o.codeSamples?.withOAuth2Call,generatedPayloadSamplesMaxDepth:o.generatedSamplesMaxDepth},y=n.operationType==="webhook"?void 0:P({...n,servers:i},m,d,t.resolvers),S=[];if(y)for(const c of r){const f=$(c);if(f==="payload"||l.has(c.key))continue;const x=T(f,y,c.options),k=x.kind==="ok"?x.source:x.kind==="unsupported-language"?"Language is not supported.":"Failed to generate code sample.";k&&S.push({lang:c.lang,label:c.label,source:k})}return[...p,...S].filter(c=>!!c.source).sort((c,f)=>(s.get(g(c))??9999)-(s.get(g(f))??9999))}function Q(t,e,n){if(e.examples&&typeof e.examples=="object"){const o=Object.keys(e.examples);if(o.length){const r=o.length===1?o[0]:n&&o.includes(n)?n:o[0],s=h(u(t),e.examples[r])??e.examples[r],i=w(s);if(i!==void 0)return i}}if(e.example!==void 0)return e.example}function X(t,e,n,o){const r=e.schema??e.itemSchema;if(!r)return;const s=h(u(t),r)??r;try{return B.sample(s,{skipReadOnly:o==="request",skipWriteOnly:o==="response",quiet:!0,skipNonRequired:n.onlyRequiredInSamples,maxSampleDepth:n.generatedSamplesMaxDepth},u(t))}catch{return}}function j(t,e,n,o,r,s){const i=[];if(!e)return i;for(const[a,p]of Object.entries(e)){if(!p||typeof p!="object"||s&&a!==s)continue;let l=Q(t.doc,p,n);const m=l===void 0&&D(a);if(m&&(l=X(t.doc,p,t.options,r)),l===void 0)continue;const d=E(l,a,p.schema??p.itemSchema,m&&V(a));d!==void 0&&i.push({lang:W(a),title:`${o} ${a}`,source:K(d,a,p.encoding)})}return i}function fe(t,{exampleKey:e,mimeType:n,titlePrefix:o="Payload"}={}){const r=h(u(t.doc),t.operation.requestBody)??t.operation.requestBody,s=C(u(t.doc),r);return j(t,s,e,o,"request",n)}function de(t,{exampleKey:e}={}){const n=t.operation.responses;if(!n||typeof n!="object")return[];const o=[];for(const[r,s]of Object.entries(n)){if(!F(r))continue;const i=h(u(t.doc),s)??s,a=C(u(t.doc),i);o.push(...j(t,a,e,r,"response"))}return o}export{le as buildCodeSamples,fe as getRequestBodySamples,de as getResponseSamples,ue as resolveOperationSampleContext};

package/lib/services/operation-samples/types.d.ts

@@ -0,0 +1,37 @@
+import type { OpenAPIDefinition, OpenAPIOperation } from '../../types/openapi.js';
+import type { ApiDocsOptions } from '../../types/options.js';
+import type { StoreContext } from '../../types/store.js';
+import type { CodeSampleSource } from '../code-samples/source.js';
+import type { HARBuildResolvers } from '../code-samples/builder.js';
+export type OperationSampleIdentifier = {
+    operationId?: string;
+    pointer?: string;
+};
+export type CodeSampleBlock = {
+    lang: string;
+    label?: string;
+    source: string;
+};
+export type MediaSampleBlock = {
+    lang: string;
+    title: string;
+    source: string;
+};
+export type CodeSampleAttributes = {
+    exampleKey?: string;
+    mimeType?: string;
+    parameters?: Record<string, Record<string, unknown>>;
+    requestBody?: unknown;
+    environments?: Record<string, Record<string, string>>;
+    environment?: string;
+};
+export type OperationSampleContext = {
+    doc: OpenAPIDefinition;
+    options: ApiDocsOptions;
+    operation: OpenAPIOperation;
+    pathName: string;
+    method: string;
+    source: CodeSampleSource;
+    storeCtx: StoreContext;
+    resolvers: HARBuildResolvers;
+};

package/lib/services/schema/dialects/graphqlSchema.d.ts

@@ -0,0 +1 @@
+export declare const GraphqlSchemaDialectId: 'graphql-schema';

package/lib/services/schema/dialects/graphqlSchema.js

@@ -0,0 +1 @@
+const a="graphql-schema";export{a as GraphqlSchemaDialectId};

package/lib/services/schema/dialects/jsonSchema.d.ts

@@ -0,0 +1,3 @@
+import type { SchemaProcessorDialect } from '../../../types/schema.js';
+export declare const JsonSchemaDialectId: "json-schema";
+export declare const jsonSchemaDialect: SchemaProcessorDialect;

package/lib/services/schema/dialects/jsonSchema.js

@@ -0,0 +1 @@
+import{merge as $,openApiJsonSchemaMergeRules as A}from"@redocly/allof-merge";import{schemaKind as M}from"../../../types/common.js";import{isSchemaNode as p}from"../../../types/schema.js";import{encodeJsonPointerSegment as w}from"../../../utils/refPointer.js";import{buildPropertyTree as j}from"../propertyTreeBuilder.js";function k(e){return e.replace(/~1/g,"/").replace(/~0/g,"~")}function S(e,i){if(!i.startsWith("#/"))return;const c=i.slice(2).split("/").map(k);let n=e;for(const t of c){if(!p(n))return;n=n[t]}return p(n)?n:void 0}function g(e,i,c,n){if(!e||typeof e!="object")return e;if(Array.isArray(e)){const r=c??new Set;return e.map(f=>g(f,i,r,n))}if(!p(e))return e;const t=c??new Set;if(e.$ref!==void 0){const r=e.$ref;if(typeof r!="string")return e;if(t.has(r)){const o=S(i,r);return p(o)?{...o,"x-circular-ref":!0,"x-original-ref":r}:{"x-circular-ref":!0}}const f=n?.get(r);if(f&&p(f)){const o={};for(const[m,d]of Object.entries(e))m!=="$ref"&&(o[m]=g(d,i,t,n));return{...f,...o,"x-original-ref":r}}const l=S(i,r);if(!l)return e;t.add(r);const s=g(l,i,t,n);t.delete(r);const a={};for(const[o,m]of Object.entries(e))o!=="$ref"&&(a[o]=g(m,i,t,n));return p(s)?(n?.set(r,s),{...s,...a,"x-original-ref":r}):s}return Object.fromEntries(Object.entries(e).map(([r,f])=>[r,g(f,i,t,n)]))}function b(e,i,c,n){const t="openapi"in i?i.openapi:void 0,r=typeof t=="string"&&t.startsWith("3.0")?"3.0.x":"3.1.x",f=g(e,i,n,c),l=p(f)?f:e,s=$(l,{mergeCombinarySibling:!0,applyAdditionalPropertiesToSiblings:!1,rules:A(r)});return p(s)?s:l}const x=new WeakMap;function P(e){const i=x.get(e);if(i)return i;const c=e.components?.schemas,n={};if(c&&typeof c=="object")for(const[t,r]of Object.entries(c)){if(!p(r)||!Array.isArray(r.allOf))continue;const f=typeof r["x-discriminator-value"]=="string"?r["x-discriminator-value"]:t,l=`#/components/schemas/${w(t)}`;for(const s of r.allOf)p(s)&&typeof s.$ref=="string"&&(n[s.$ref]??=[]).push({ref:l,value:f})}return x.set(e,n),n}const O=new WeakMap;function y(e,i){if(!p(e)){if(Array.isArray(e))for(const t of e)y(t,i);return}for(const[t,r]of Object.entries(e))t==="$ref"&&typeof r=="string"?i.add(r):y(r,i);const c=e.discriminator??e["x-discriminator"],n=p(c)?c.mapping:void 0;if(p(n))for(const t of Object.values(n))typeof t=="string"&&i.add(t)}function D(e){const i=new Set;let c=0;const n=new Map,t=new Map,r=new Set,f=[];for(const l of e.keys()){if(n.has(l))continue;const s=[{node:l,edge:0}];for(;s.length>0;){const a=s[s.length-1],{node:o}=a;a.edge===0&&(n.set(o,c),t.set(o,c),c++,f.push(o),r.add(o));const m=e.get(o)??[];if(a.edge<m.length){const u=m[a.edge];if(a.edge++,!e.has(u))continue;n.has(u)?r.has(u)&&t.set(o,Math.min(t.get(o)??0,n.get(u)??0)):s.push({node:u,edge:0});continue}if((t.get(o)??0)===(n.get(o)??0)){const u=[];let h="";do h=f.pop()??o,r.delete(h),u.push(h);while(h!==o);const R=(e.get(u[0])??[]).includes(u[0]);if(u.length>1||R)for(const v of u)i.add(v)}s.pop();const d=s[s.length-1];d&&t.set(d.node,Math.min(t.get(d.node)??0,t.get(o)??0))}}return i}function J(e){const i=O.get(e);if(i)return i;const c=e.components?.schemas,n=new Map;if(c&&typeof c=="object"){const r=s=>`#/components/schemas/${w(s)}`,f=s=>s.replace(/^#\/components\/schemas\//,"").replace(/~1/g,"/").replace(/~0/g,"~"),l=s=>{const a=c[f(s)];return p(a)&&!!(a.discriminator||a["x-discriminator"])};for(const[s,a]of Object.entries(c)){const o=new Set;y(a,o),n.set(r(s),[...o])}for(const[s,a]of Object.entries(c))if(!(!p(a)||!Array.isArray(a.allOf)))for(const o of a.allOf)p(o)&&typeof o.$ref=="string"&&l(o.$ref)&&n.get(o.$ref)?.push(r(s))}const t=D(n);return O.set(e,t),t}const W=M.JSON_SCHEMA,q={id:W,process(e,i,c){const n=new Map,t=c?.rootJsonPointer??"#",r=t.startsWith("#/")&&e.$ref!==t?new Set([t]):void 0,f=b(e,i,n,r),l={prepareVariant:s=>b(s,i,n),propertyRefCache:new Map,variantResolutionCache:new Map,implicitDiscriminatorChildren:P(i),exampleSerializer:c?.exampleSerializer,sortRequiredPropsFirst:c?.sortRequiredPropsFirst,activeRefs:t.startsWith("#/")?new Set([t]):new Set,depth:0,recursiveRefs:J(i)};return j(f,l,t)}};export{W as JsonSchemaDialectId,q as jsonSchemaDialect};

package/lib/services/schema/index.d.ts

@@ -0,0 +1 @@
+export { schemaProcessor as processSchema } from './schemaProcessor.js';

package/lib/services/schema/index.js

@@ -0,0 +1 @@
+import{schemaProcessor as o}from"./schemaProcessor.js";export{o as processSchema};