@redocly/realm 0.129.0-next.0 → 0.129.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,51 @@
 # @redocly/realm
 
+## 0.129.0-next.2
+
+### Minor Changes
+
+- 8fdaab071f: Added `useColorSwitcher` React hook to receive color mode updates in components.
+- dd42fb73d2: Added support for the `json-example` Markdoc tag to embed JSON snippets in documentation.
+
+### Patch Changes
+
+- 8d09c7d474: Updated `@redocly/openapi-core` to version `2.13.0`.
+- e408a095cf: Fixed a bug where scorecard custom targets did not match.
+- 49ddba9c14: Fixed dismissed banner briefly appearing after page refresh.
+- b28161bbc8: Added product-specific CSS class to the root element for targeted styling by product name.
+- 49ddba9c14: Fixed Y-axis scroll position when deep linking to pages with banners.
+- Updated dependencies [8d09c7d474]
+- Updated dependencies [49ddba9c14]
+- Updated dependencies [8fdaab071f]
+- Updated dependencies [b28161bbc8]
+- Updated dependencies [49ddba9c14]
+  - @redocly/openapi-docs@3.17.0-next.2
+  - @redocly/theme@0.61.0-next.2
+  - @redocly/asyncapi-docs@1.6.0-next.2
+  - @redocly/portal-plugin-mock-server@0.14.0-next.2
+  - @redocly/graphql-docs@1.6.0-next.0
+
+## 0.129.0-next.1
+
+### Minor Changes
+
+- eb3abbb06e: Added support for OpenAPI 3.2 Sequential and Streaming Data.
+
+### Patch Changes
+
+- edb34c5f33: Fixed an issue where breadcrumbs appeared on non-nested pages in projects with a path prefix.
+- 743e6e5736: Fixed an issue where the product picker was not properly aligned in the navbar.
+- Updated dependencies [edb34c5f33]
+- Updated dependencies [eb3abbb06e]
+- Updated dependencies [de9da5f2778]
+- Updated dependencies [743e6e5736]
+  - @redocly/theme@0.61.0-next.1
+  - @redocly/portal-plugin-mock-server@0.14.0-next.1
+  - @redocly/openapi-docs@3.17.0-next.1
+  - @redocly/realm-asyncapi-sdk@0.7.0-next.1
+  - @redocly/asyncapi-docs@1.6.0-next.1
+  - @redocly/graphql-docs@1.6.0-next.0
+
 ## 0.129.0-next.0
 
 ### Patch Changes

package/dist/client/app/Sidebar/useBreadcrumbs.js

@@ -1 +1 @@
-import{useMemo as k}from"react";import{useLocation as T}from"react-router-dom";import{useThemeConfig as y}from"@redocly/theme/core/hooks";import{usePageVersions as K,useTranslate as g,usePageSharedData as d}from"../hooks";import{useSidebarItems as v}from"./useSidebarItems";function A(){const a=d("sidebar")?.relatedNavbarItem,n=d("current-catalog-info"),l=y(),{translate:r}=g(),{versions:e=[]}=K()||{},c=e.find(b=>b?.active),{allSidebarItems:i}=v(c),t=T().pathname,o=n?.item,s=n?.catalog,m=l.breadcrumbs?.prefixItems,f=l.breadcrumbs?.hide;return k(()=>{const b=B({allSidebarItems:i,pathname:t,catalogItemInfo:o,relatedNavbarItem:a,catalogInfo:s,prefixItems:m,hide:f,translate:r}),h=x(i,b);return{breadcrumbs:b,currentItemSiblings:h}},[t,a,i,o,s,m,f,r])}const B=({allSidebarItems:a=[],pathname:n,catalogItemInfo:l,relatedNavbarItem:r,catalogInfo:e,prefixItems:c,hide:i,translate:u})=>{if(i===!0)return[];const t=p(a);if(t.length===0)return[];if(l){const o=t[t.length-1];o&&o.label!==l.label&&t.unshift({label:l.label,link:l.link})}if(r&&r.label!==t[0].label&&t.unshift(r),e&&t.unshift({label:u(e.labelTranslationKey,e.label),labelTranslationKey:e.labelTranslationKey,link:e.link,icon:e.icon}),c?.length){const o=c.map(s=>({label:u(s.labelTranslationKey,s.label),labelTranslationKey:s.labelTranslationKey,link:s.link,icon:s.icon}));t.unshift(...o)}return t.length===1&&(!t[0]?.link||t[0]?.link===n)?[]:t},x=(a,n)=>{if(n.length===0)return[];const l=(e,c)=>{for(const i of e){if(i.active)return{item:i,parent:c};if(i.items?.length){const u=l(i.items,i);if(u)return u}}},r=l(a);return r?.parent?r.parent.items?.filter(e=>!!(e.link&&e.link!==r.item.link&&e.label)).map(e=>({label:e.label,labelTranslationKey:e.labelTranslationKey,link:e.link,icon:e.icon}))||[]:[]},p=a=>{const n=a.find(({active:r,hasActiveSubItem:e})=>r||e);if(!n?.label)return[];const l={label:n.label,labelTranslationKey:n.labelTranslationKey,link:n.link,icon:n.icon};return n.type==="group"&&n.selectFirstItemOnExpand&&n.items?.[0]?.link&&(l.link=n.items[0].link),n.items?.length||(l.link=void 0),[l,...p(n.items||[])]};export{B as generateBreadcrumbs,x as generateSiblings,A as useBreadcrumbs};
+import{useMemo as k}from"react";import{useLocation as T}from"react-router-dom";import{useThemeConfig as y}from"@redocly/theme/core/hooks";import{withoutPathPrefix as K}from"@redocly/theme/core/utils";import{usePageVersions as g,useTranslate as v,usePageSharedData as d}from"../hooks";import{useSidebarItems as x}from"./useSidebarItems";function D(){const a=d("sidebar")?.relatedNavbarItem,n=d("current-catalog-info"),r=y(),{translate:l}=v(),{versions:e=[]}=g()||{},c=e.find(m=>m?.active),{allSidebarItems:i}=x(c),t=T().pathname,o=n?.item,s=n?.catalog,b=r.breadcrumbs?.prefixItems,f=r.breadcrumbs?.hide;return k(()=>{const m=B({allSidebarItems:i,pathname:K(t),catalogItemInfo:o,relatedNavbarItem:a,catalogInfo:s,prefixItems:b,hide:f,translate:l}),p=S(i,m);return{breadcrumbs:m,currentItemSiblings:p}},[t,a,i,o,s,b,f,l])}const B=({allSidebarItems:a=[],pathname:n,catalogItemInfo:r,relatedNavbarItem:l,catalogInfo:e,prefixItems:c,hide:i,translate:u})=>{if(i===!0)return[];const t=h(a);if(t.length===0)return[];if(r){const o=t[t.length-1];o&&o.label!==r.label&&t.unshift({label:r.label,link:r.link})}if(l&&l.label!==t[0].label&&t.unshift(l),e&&t.unshift({label:u(e.labelTranslationKey,e.label),labelTranslationKey:e.labelTranslationKey,link:e.link,icon:e.icon}),c?.length){const o=c.map(s=>({label:u(s.labelTranslationKey,s.label),labelTranslationKey:s.labelTranslationKey,link:s.link,icon:s.icon}));t.unshift(...o)}return t.length===1&&(!t[0]?.link||t[0]?.link===n)?[]:t},S=(a,n)=>{if(n.length===0)return[];const r=(e,c)=>{for(const i of e){if(i.active)return{item:i,parent:c};if(i.items?.length){const u=r(i.items,i);if(u)return u}}},l=r(a);return l?.parent?l.parent.items?.filter(e=>!!(e.link&&e.link!==l.item.link&&e.label)).map(e=>({label:e.label,labelTranslationKey:e.labelTranslationKey,link:e.link,icon:e.icon}))||[]:[]},h=a=>{const n=a.find(({active:l,hasActiveSubItem:e})=>l||e);if(!n?.label)return[];const r={label:n.label,labelTranslationKey:n.labelTranslationKey,link:n.link,icon:n.icon};return n.type==="group"&&n.selectFirstItemOnExpand&&n.items?.[0]?.link&&(r.link=n.items[0].link),n.items?.length||(r.link=void 0),[r,...h(n.items||[])]};export{B as generateBreadcrumbs,S as generateSiblings,D as useBreadcrumbs};

package/dist/client/app/hooks/codeHighlight/json-seq.d.ts

@@ -0,0 +1,43 @@
+declare const _default: (import("shiki").LanguageRegistration | {
+    displayName: string;
+    name: string;
+    scopeName: string;
+    patterns: {
+        include: string;
+    }[];
+    repository: {
+        'json-seq-record': {
+            comment: string;
+            begin: string;
+            end: string;
+            beginCaptures: {
+                '1': {
+                    name: string;
+                };
+            };
+            endCaptures: {
+                '1': {
+                    name: string;
+                };
+            };
+            patterns: {
+                comment: string;
+                begin: string;
+                end: string;
+                patterns: {
+                    include: string;
+                }[];
+            }[];
+        };
+        'record-separator': {
+            match: string;
+            name: string;
+        };
+        'line-feed': {
+            match: string;
+            name: string;
+        };
+    };
+})[];
+export default _default;
+//# sourceMappingURL=json-seq.d.ts.map

package/dist/client/app/hooks/codeHighlight/json-seq.js

@@ -0,0 +1 @@
+import e from"shiki/langs/json.mjs";const o={displayName:"JSON Sequence",name:"json-seq",scopeName:"source.json-seq",patterns:[{include:"#json-seq-record"}],repository:{"json-seq-record":{comment:"Match a complete json-seq record: 0x1E{...}0x0A",begin:"(0x1E)",end:"(0x0A)",beginCaptures:{1:{name:"keyword.control.record-separator.json-seq"}},endCaptures:{1:{name:"keyword.control.line-feed.json-seq"}},patterns:[{comment:"Highlight JSON content between separators",begin:"(?<=0x1E)(?=[\\[\\{])",end:"(?=0x0A)",patterns:[{include:"source.json"}]}]},"record-separator":{match:"0x1E",name:"keyword.control.record-separator.json-seq"},"line-feed":{match:"0x0A",name:"keyword.control.line-feed.json-seq"}}};var r=[...e,o];export{r as default};

package/dist/client/app/hooks/codeHighlight/map-lang.js

@@ -1 +1 @@
-function a(c){return{"c++":"c",cpp:"c",jsx:"tsx","c#":"csharp","c#+newtonsoft":"csharp","java8+apache":"java",objectivec:"objective-c",shell:"bash",viml:"vim",curl:"bash","node.js":"js"}[c]||c}export{a as mapLang};
+function c(s){return{"c++":"c",cpp:"c",jsx:"tsx","c#":"csharp","c#+newtonsoft":"csharp","java8+apache":"java",objectivec:"objective-c",shell:"bash",viml:"vim",curl:"bash","node.js":"js","multipart/mixed":"multipart-mixed","application/json-seq":"json-seq","json-seq":"json-seq"}[s]||s}export{c as mapLang};

package/dist/client/app/hooks/codeHighlight/multipart-mixed.d.ts

@@ -0,0 +1,40 @@
+declare const _default: (import("shiki").LanguageRegistration | {
+    displayName: string;
+    name: string;
+    scopeName: string;
+    patterns: {
+        include: string;
+    }[];
+    repository: {
+        boundary: {
+            match: string;
+            name: string;
+        };
+        headers: {
+            match: string;
+            captures: {
+                '1': {
+                    name: string;
+                };
+                '2': {
+                    name: string;
+                };
+            };
+        };
+        'json-body': {
+            comment: string;
+            begin: string;
+            end: string;
+            patterns: {
+                include: string;
+            }[];
+        };
+        'binary-body': {
+            comment: string;
+            match: string;
+            name: string;
+        };
+    };
+})[];
+export default _default;
+//# sourceMappingURL=multipart-mixed.d.ts.map

package/dist/client/app/hooks/codeHighlight/multipart-mixed.js

@@ -0,0 +1 @@
+import t from"shiki/langs/css.mjs";import r from"shiki/langs/graphql.mjs";import a from"shiki/langs/html.mjs";import e from"shiki/langs/javascript.mjs";import o from"shiki/langs/json.mjs";import m from"shiki/langs/sql.mjs";import i from"shiki/langs/xml.mjs";import n from"shiki/langs/yaml.mjs";const s={displayName:"Multipart Mixed",name:"multipart-mixed",scopeName:"source.multipart",patterns:[{include:"#boundary"},{include:"#headers"},{include:"#json-body"},{include:"#binary-body"}],repository:{boundary:{match:"^--[a-zA-Z0-9_\\-\\.]+(?:--)?$",name:"keyword.control.boundary.multipart"},headers:{match:"^([a-zA-Z0-9\\-]+):\\s*(.*)$",captures:{1:{name:"variable.other.header.name.multipart"},2:{name:"string.unquoted.header.value.multipart"}}},"json-body":{comment:"Detects if a block starts with { or [ and highlights it as JSON until the next boundary",begin:"^\\s*(?=[{\\[])",end:"(?=^--)",patterns:[{include:"source.json"}]},"binary-body":{comment:"Catch-all for content that isn't headers or JSON",match:".+",name:"text.plain"}}};var f=[...o,...a,...i,...e,...t,...n,...r,...m,s];export{f as default};

package/dist/client/app/hooks/codeHighlight/useCodeHighlight.js

@@ -1 +1 @@
-import u from"shiki/langs/bash.mjs";import w from"shiki/langs/c.mjs";import N from"shiki/langs/coffee.mjs";import b from"shiki/langs/csharp.mjs";import y from"shiki/langs/css.mjs";import H from"shiki/langs/go.mjs";import v from"shiki/langs/graphql.mjs";import L from"shiki/langs/html.mjs";import _ from"shiki/langs/http.mjs";import x from"shiki/langs/java.mjs";import T from"shiki/langs/javascript.mjs";import j from"shiki/langs/kotlin.mjs";import E from"shiki/langs/lua.mjs";import r from"shiki/langs/markdown.mjs";import M from"shiki/langs/objective-c.mjs";import q from"shiki/langs/perl.mjs";import A from"shiki/langs/php.mjs";import D from"shiki/langs/python.mjs";import F from"shiki/langs/scala.mjs";import R from"shiki/langs/sql.mjs";import a from"shiki/langs/swift.mjs";import S from"shiki/langs/tsx.mjs";import W from"shiki/langs/typescript.mjs";import C from"shiki/langs/vim.mjs";import G from"shiki/langs/xml.mjs";import J from"shiki/langs/yaml.mjs";import U from"shiki/langs/jsx.mjs";import{transformerNotationDiff as V,transformerNotationHighlight as $,transformerNotationWordHighlight as z,transformerNotationFocus as B,transformerNotationErrorLevel as I,transformerMetaHighlight as K,transformerMetaWordHighlight as O,transformerRemoveNotationEscape as P}from"@shikijs/transformers";import{createHighlighterCoreSync as s}from"shiki/core";import{createJavaScriptRegexEngine as n}from"shiki/engine/javascript";import Q from"./ruby";import f from"./theme";import X from"./treeview-transformer";import Y from"./node-transformer";import Z from"./line-numbers-transformer";import{mapLang as rr}from"./map-lang";const or=[{...r[0],displayName:"Markdoc",name:"markdoc",scopeName:"source.markdoc",aliases:[],repository:{...r[0].repository,fenced_code_block:{patterns:[...r[0].repository.fenced_code_block.patterns||[],{name:"markdoc",begin:".*{%",end:"%}",patterns:[{match:"(?<={%)\\s*(/\\w+(-\\w+)?|\\w+(-\\w+)?)",name:"markdoc.tag"},{match:"\\$\\w+",name:"markdoc.variable"},{match:'".*?"',name:"markdoc.string"},{match:"\\b\\w+(?=\\()",name:"markdoc.function"},{match:"\\s+\\w+(?==|\\s)",name:"markdoc.keyword"},{match:"(?<==)false|true(?=\\s)",name:"markdoc.boolean"}]}]}}}],p="text",c=s({themes:[f],langs:[u,w,N,b,y,H,v,L,_,x,T,j,E,r,M,q,A,D,Q,F,R,a,S,W,G,C,J,or,U],engine:n()}),tr=[V(),$(),z(),B(),I(),K(),O(),P(),Y()],mr=(o,m,h)=>{const{withLineNumbers:g,startLineNumber:l,highlight:d,customTransformer:e}=h||{},i=rr(m?.toLowerCase()||p),t={lang:i,theme:"theme",meta:{__raw:d},transformers:[...i==="treeview"?[X()]:[],...tr,...g?[Z(l)]:[],...e?[e]:[]]};try{return m==="swift"?s({themes:[f],langs:[a],engine:n({forgiving:!0})}).codeToHtml(o,t):c.codeToHtml(o,t)}catch{return c.codeToHtml(o,{...t,lang:p})}};function Jr(){return{highlight:mr}}export{mr as highlight,Jr as useCodeHighlight};
+import u from"shiki/langs/bash.mjs";import w from"shiki/langs/c.mjs";import N from"shiki/langs/coffee.mjs";import b from"shiki/langs/csharp.mjs";import y from"shiki/langs/css.mjs";import H from"shiki/langs/go.mjs";import v from"shiki/langs/graphql.mjs";import x from"shiki/langs/html.mjs";import L from"shiki/langs/http.mjs";import _ from"shiki/langs/java.mjs";import j from"shiki/langs/javascript.mjs";import T from"shiki/langs/kotlin.mjs";import E from"shiki/langs/lua.mjs";import r from"shiki/langs/markdown.mjs";import M from"shiki/langs/objective-c.mjs";import q from"shiki/langs/perl.mjs";import S from"shiki/langs/php.mjs";import A from"shiki/langs/python.mjs";import D from"shiki/langs/scala.mjs";import F from"shiki/langs/sql.mjs";import a from"shiki/langs/swift.mjs";import R from"shiki/langs/tsx.mjs";import W from"shiki/langs/typescript.mjs";import C from"shiki/langs/vim.mjs";import G from"shiki/langs/xml.mjs";import J from"shiki/langs/yaml.mjs";import U from"shiki/langs/jsx.mjs";import V from"shiki/langs/jsonl.mjs";import{transformerNotationDiff as $,transformerNotationHighlight as z,transformerNotationWordHighlight as B,transformerNotationFocus as I,transformerNotationErrorLevel as K,transformerMetaHighlight as O,transformerMetaWordHighlight as P,transformerRemoveNotationEscape as Q}from"@shikijs/transformers";import{createHighlighterCoreSync as s}from"shiki/core";import{createJavaScriptRegexEngine as n}from"shiki/engine/javascript";import X from"./ruby";import Y from"./multipart-mixed";import Z from"./json-seq";import f from"./theme";import rr from"./treeview-transformer";import or from"./node-transformer";import tr from"./line-numbers-transformer";import{mapLang as mr}from"./map-lang";const er=[{...r[0],displayName:"Markdoc",name:"markdoc",scopeName:"source.markdoc",aliases:[],repository:{...r[0].repository,fenced_code_block:{patterns:[...r[0].repository.fenced_code_block.patterns||[],{name:"markdoc",begin:".*{%",end:"%}",patterns:[{match:"(?<={%)\\s*(/\\w+(-\\w+)?|\\w+(-\\w+)?)",name:"markdoc.tag"},{match:"\\$\\w+",name:"markdoc.variable"},{match:'".*?"',name:"markdoc.string"},{match:"\\b\\w+(?=\\()",name:"markdoc.function"},{match:"\\s+\\w+(?==|\\s)",name:"markdoc.keyword"},{match:"(?<==)false|true(?=\\s)",name:"markdoc.boolean"}]}]}}}],p="text",c=s({themes:[f],langs:[u,w,N,b,y,H,v,x,L,_,j,T,E,r,M,q,S,A,X,D,F,a,R,W,G,C,J,er,U,V,Y,Z],engine:n()}),ir=[$(),z(),B(),I(),K(),O(),P(),Q(),or()],ar=(o,m,h)=>{const{withLineNumbers:l,startLineNumber:g,highlight:d,customTransformer:e}=h||{},i=mr(m?.toLowerCase()||p),t={lang:i,theme:"theme",meta:{__raw:d},transformers:[...i==="treeview"?[rr()]:[],...ir,...l?[tr(g)]:[],...e?[e]:[]]};try{return m==="swift"?s({themes:[f],langs:[a],engine:n({forgiving:!0})}).codeToHtml(o,t):c.codeToHtml(o,t)}catch{return c.codeToHtml(o,{...t,lang:p})}};function Ir(){return{highlight:ar}}export{ar as highlight,Ir as useCodeHighlight};

package/dist/client/app/hooks/useBanner.d.ts

@@ -3,6 +3,10 @@ type BannerResult = {
     banner: BannerConfig | undefined;
     dismissBanner: (content: string) => void;
 };
+export declare const STORAGE_KEY = "redocly-dismissed-banners";
+export declare const STORAGE_KEY_PER_SLUG = "redocly-dismissed-banners-per-slug";
+export declare function getDismissedBannersFromStorage(): Set<string>;
+export declare function getDismissedSlugsFromStorage(): Set<string>;
 export declare function useBanner(): BannerResult;
 export {};
 //# sourceMappingURL=useBanner.d.ts.map

package/dist/client/app/hooks/useBanner.js

@@ -1 +1 @@
-import{useMemo as g,useState as f,useEffect as l}from"react";import{useLocation as p}from"react-router-dom";import{useThemeConfig as y}from"@redocly/theme/core/hooks";import{usePageData as A}from"../../providers/page-data/hooks";import{getBannerForSlug as w}from"./utils/match-banner-target.js";const c="redocly-dismissed-banners",u="redocly-dismissed-banners-per-slug";function N(){const{banner:s}=y()||{},t=A()?.props?.frontmatter?.banner,S=p(),[o,d]=f(new Set),[i,m]=f(new Set);l(()=>{const r=localStorage.getItem(c),n=localStorage.getItem(u);if(r){const e=JSON.parse(r);Array.isArray(e)&&d(new Set(e))}if(n){const e=JSON.parse(n);Array.isArray(e)&&m(new Set(e))}},[]);const a=S.pathname;return{banner:g(()=>{if(t&&Array.isArray(t)&&t.length){if(i.has(a))return;for(const r of t)if(!o.has(r.content))return r;return}if(!(!s||!Array.isArray(s)||s.length===0)&&!i.has(a))return w(s,a,o)},[s,t,a,o,i]),dismissBanner:r=>{const n=new Set(o);n.add(r),d(n);const e=new Set(i);e.add(a),m(e),localStorage.setItem(c,JSON.stringify(Array.from(n))),localStorage.setItem(u,JSON.stringify(Array.from(e)))}}}export{N as useBanner};
+import{useMemo as p,useState as f}from"react";import{useLocation as l}from"react-router-dom";import{useThemeConfig as y}from"@redocly/theme/core/hooks";import{usePageData as w}from"../../providers/page-data/hooks";import{getBannerForSlug as A}from"./utils/match-banner-target.js";const u="redocly-dismissed-banners",m="redocly-dismissed-banners-per-slug";function B(){if(typeof window>"u")return new Set;const e=localStorage.getItem(u);if(e){const r=JSON.parse(e);if(Array.isArray(r))return new Set(r)}return new Set}function D(){if(typeof window>"u")return new Set;const e=localStorage.getItem(m);if(e){const r=JSON.parse(e);if(Array.isArray(r))return new Set(r)}return new Set}function N(){const{banner:e}=y()||{},n=w()?.props?.frontmatter?.banner,c=l(),[s,S]=f(B()),[o,g]=f(D()),t=c.pathname;return{banner:p(()=>{if(n&&Array.isArray(n)&&n.length){if(o.has(t))return;for(const a of n)if(!s.has(a.content))return a;return}if(!(!e||!Array.isArray(e)||e.length===0)&&!o.has(t))return A(e,t,s)},[e,n,t,s,o]),dismissBanner:a=>{const i=new Set(s);i.add(a),S(i);const d=new Set(o);d.add(t),g(d),localStorage.setItem(u,JSON.stringify(Array.from(i))),localStorage.setItem(m,JSON.stringify(Array.from(d)))}}}export{u as STORAGE_KEY,m as STORAGE_KEY_PER_SLUG,B as getDismissedBannersFromStorage,D as getDismissedSlugsFromStorage,N as useBanner};

package/dist/client/app/utils/loadAndNavigate.js

@@ -1 +1 @@
-import{withPathPrefix as f}from"@redocly/theme/core/utils";import{isLocalLink as u}from"../../../utils/path/is-local-link.js";import{withLoadProgress as p}from"./withLoadProgress";let l;async function L({navigate:i,to:o,origin:r="browser",options:a}){o===""&&(o="/"),l=o;const{pathname:n,hash:w,search:c}=new URL(o,window.location.origin+window.location.pathname),t=decodeURIComponent(w),h=decodeURIComponent(window.location.hash),m=window.__LOADER,e=await p(m.tryLoad(n));if(e?.redirectTo){if(!u(e.redirectTo)){window.location.href=e.redirectTo;return}return L({navigate:i,to:e.redirectTo,origin:r,options:a})}if(o.startsWith(f("/_auth/"))){window.location.href=o;return}if(e&&l===o){if((n!==window.location.pathname||c!==window.location.search||t!==h)&&i({pathname:n,search:c,hash:t},{...a,state:{origin:r},unstable_flushSync:!0}),e.props?.disableAutoScroll)return;requestAnimationFrame(()=>{if(t){const s=t.slice(1),d=document.getElementById(s)||document.getElementsByName(s)[0];d&&d.scrollIntoView()}else window.scrollTo(0,0)})}}export{L as loadAndNavigate};
+import{withPathPrefix as p,getNavbarElement as g}from"@redocly/theme/core/utils";import{isLocalLink as b}from"../../../utils/path/is-local-link.js";import{withLoadProgress as T}from"./withLoadProgress";let d;async function v({navigate:i,to:o,origin:r="browser",options:a}){o===""&&(o="/"),d=o;const{pathname:n,hash:w,search:s}=new URL(o,window.location.origin+window.location.pathname),e=decodeURIComponent(w),h=decodeURIComponent(window.location.hash),m=window.__LOADER,t=await T(m.tryLoad(n));if(t?.redirectTo){if(!b(t.redirectTo)){window.location.href=t.redirectTo;return}return v({navigate:i,to:t.redirectTo,origin:r,options:a})}if(o.startsWith(p("/_auth/"))){window.location.href=o;return}if(t&&d===o){if((n!==window.location.pathname||s!==window.location.search||e!==h)&&i({pathname:n,search:s,hash:e},{...a,state:{origin:r},unstable_flushSync:!0}),t.props?.disableAutoScroll)return;requestAnimationFrame(()=>{if(e){const c=e.slice(1),l=document.getElementById(c)||document.getElementsByName(c)[0];if(l){const f=g()?.offsetHeight??0,u=l.getBoundingClientRect().top+window.scrollY-f;window.scrollTo({top:u,behavior:"smooth"})}}else window.scrollTo(0,0)})}}export{v as loadAndNavigate};

package/dist/client/types/post-message.d.ts

@@ -1,4 +1,5 @@
 import type { HistoryOrigin } from '@redocly/theme/core/utils';
+import type { ColorMode } from '@redocly/theme/core/types';
 export type RouteUpdateIncomingMessage = {
     type: 'route-update';
     path: string;
@@ -26,7 +27,7 @@ export type EditorScrollUpdateIncomingMessage = {
 };
 export type ColorSchemaUpdateIncomingMessage = {
     type: 'color-schema-update';
-    colorSchema: 'light' | 'dark';
+    colorSchema: ColorMode;
 };
 export type IncomingMessage = RouteUpdateIncomingMessage | InitializeIncomingMessage | LocationUpdateIncomingMessage | ScrollUpdateIncomingMessage | EditorScrollUpdateIncomingMessage | ColorSchemaUpdateIncomingMessage;
 export type OutgoingMessage = InitializedOutgoingMessage | RouteUpdatedOutgoingMessage | AddReviewCommentOutgoingMessage | ReviewHoverLinesOutgoingMessage | ScrollOutgoingMessage | EditorScrollOutgoingMessage;

package/dist/server/persistence/kv/helpers/decode-cursor.d.ts

@@ -0,0 +1,2 @@
+export declare function decodeCursor(cursor: string): string;
+//# sourceMappingURL=decode-cursor.d.ts.map

package/dist/server/persistence/kv/helpers/decode-cursor.js

@@ -0,0 +1 @@
+function e(r){return Buffer.from(r,"base64url").toString()}export{e as decodeCursor};

package/dist/server/persistence/kv/helpers/encode-cursor.d.ts

@@ -0,0 +1,2 @@
+export declare function encodeCursor(key: string): string;
+//# sourceMappingURL=encode-cursor.d.ts.map

package/dist/server/persistence/kv/helpers/encode-cursor.js

@@ -0,0 +1 @@
+function e(r){return Buffer.from(r).toString("base64url")}export{e as encodeCursor};

package/dist/server/persistence/kv/mappers/create-kv-list-entry.d.ts

@@ -0,0 +1,5 @@
+import type { KvKey, KvListEntry, KvValue } from '@redocly/config';
+import type { DatabaseKvDbSchema } from '../../../providers/database/databases/sqld-sqlite/schemas/kv-table.js';
+export declare function createKvListEntry<T extends KvValue>(kvDbEntry: Pick<DatabaseKvDbSchema, 'encodedKey' | 'value'>): KvListEntry<T>;
+export declare function decodeKvKey(encodedKey: string): KvKey;
+//# sourceMappingURL=create-kv-list-entry.d.ts.map

package/dist/server/persistence/kv/mappers/create-kv-list-entry.js

@@ -0,0 +1 @@
+import{KV_KEY_SEPARATOR as r}from"./create-kv-db-record.js";import{createKvValue as o}from"./create-kv-value.js";function u(e){const t=o(e);return{key:n(e.encodedKey),value:t}}function n(e){return e.split(r).map(String)}export{u as createKvListEntry,n as decodeKvKey};

package/dist/server/persistence/kv/mappers/create-kv-value.d.ts

@@ -0,0 +1,4 @@
+import type { KvValue } from '@redocly/config';
+import type { DatabaseKvDbSchema } from '../../../providers/database/databases/sqld-sqlite/schemas/kv-table.js';
+export declare function createKvValue<T extends KvValue>(kvDbEntry: Pick<DatabaseKvDbSchema, 'encodedKey' | 'value'>): T | null;
+//# sourceMappingURL=create-kv-value.d.ts.map

package/dist/server/persistence/kv/mappers/create-kv-value.js

@@ -0,0 +1 @@
+import{safeParse as a}from"../../../utils/safe-parse.js";function n(r){const e=a(r.value);return"error"in e?null:e.value}export{n as createKvValue};

package/dist/server/persistence/kv/repositories/kv-remote-repository.d.ts

@@ -1,4 +1,4 @@
-import type { KvKey, KvReadSchema, KvSetOptions, KvValue, KvListSelector, KvListOptions, KvListResponse, KvTransaction } from '@redocly/config';
+import type { KvKey, KvListEntry, KvSetOptions, KvValue, KvListSelector, KvListOptions, KvListResponse, KvTransaction } from '@redocly/config';
 import type { DatabaseConnection, RepositoryInstanceOptions } from '../../../providers/database/types.js';
 import { BaseRepository } from '../../../providers/database/base-repository.js';
 export declare const KV_KEY_END_BOUNDARY = "\u0002";
@@ -6,11 +6,11 @@ export declare class KvRemoteRepository extends BaseRepository {
     #private;
     constructor(dbConnection: DatabaseConnection);
     static getInstance(options: RepositoryInstanceOptions): Promise<KvRemoteRepository | null>;
-    get<T extends KvValue = KvValue>(key: KvKey): Promise<KvReadSchema<T> | null>;
-    getMany<T extends KvValue = KvValue>(keys: KvKey[]): Promise<(KvReadSchema<T> | null)[]>;
+    get<T extends KvValue = KvValue>(key: KvKey): Promise<T | null>;
+    getMany<T extends KvValue = KvValue>(keys: KvKey[]): Promise<(KvListEntry<T> | null)[]>;
     list<T extends KvValue = KvValue>(selector: KvListSelector, options?: KvListOptions): Promise<KvListResponse<T>>;
-    set<T extends KvValue = KvValue>(key: KvKey, value: T, options?: KvSetOptions): Promise<string | null>;
-    delete(key: KvKey): Promise<boolean>;
+    set<T extends KvValue = KvValue>(key: KvKey, value: T, options?: KvSetOptions): Promise<KvListEntry<T> | null>;
+    delete(key: KvKey): Promise<void>;
     clearExpired(): Promise<void>;
     transaction<T>(operation: (tx: KvTransaction) => Promise<T>): Promise<T>;
 }

package/dist/server/persistence/kv/repositories/kv-remote-repository.js

@@ -1 +1 @@
-import{eq as C,and as K,gte as p,gt as k,lt as g,asc as D,desc as M,or as v,isNull as E,sql as y,inArray as B,count as q}from"drizzle-orm";import{logger as d}from"../../../tools/notifiers/logger.js";import{kvTable as r}from"../../../providers/database/databases/sqld-sqlite/schemas/kv-table.js";import{BaseRepository as I}from"../../../providers/database/base-repository.js";import{DatabaseConnectionFactory as N}from"../../../providers/database/database-connection-factory.js";import{createKvReadRecord as x}from"../mappers/create-kv-read-record.js";import{createKvDbRecord as S,encodeKvKey as i}from"../mappers/create-kv-db-record.js";const $="";class l extends I{static#e;constructor(e){super(e)}static async getInstance(e){if(!l.#e)try{const t=await N.create("sqld-remote",e);if(!t)return l.#e=null,null;l.#e=new l(t)}catch(t){return d.error("Error creating kv remote repository",t),l.#e=null,null}return l.#e}async get(e){try{const t=i(e),n=await this.databaseClient.client.select().from(r).where(K(C(r.encodedKey,t),v(E(r.expiresAt),p(y`datetime(${r.expiresAt})`,y`datetime('now')`)))).get();return n?x(n):null}catch(t){return d.error("Error getting kv entry by key",t),null}}async getMany(e){try{if(e.length===0)return[];const t=e.map(o=>i(o)),n=await this.databaseClient.client.select().from(r).where(B(r.encodedKey,t)).all(),a=new Map(n.map(o=>[o.encodedKey,o]));return e.map((o,h)=>{const f=t[h],u=a.get(f);return!u||this.#t(u.expiresAt)?null:x(u)})}catch(t){return d.error("Error getting multiple kv entries",t),[]}}async list(e,t){try{const n=t?.limit??100,a=t?.reverse??!1,s=[],o=v(E(r.expiresAt),p(y`datetime(${r.expiresAt})`,y`datetime('now')`));if(s.push(o),"prefix"in e){const c=i(e.prefix),w="start"in e?i(e.start):c,A="end"in e?i(e.end):c+$;s.push(p(r.encodedKey,w)),s.push(g(r.encodedKey,A))}else if("start"in e&&"end"in e){const c=i(e.start),w=i(e.end);s.push(p(r.encodedKey,c)),s.push(g(r.encodedKey,w))}if(t?.cursor){const c=a?g(r.encodedKey,t.cursor):k(r.encodedKey,t.cursor);s.push(c)}const h=this.databaseClient.client.select().from(r),f=s.length>0?h.where(K(...s)):h,u=this.databaseClient.client.select({count:q()}).from(r),b=(await(s.length>0?u.where(K(...s)):u).get())?.count??0,m=await f.orderBy(a?M(r.encodedKey):D(r.encodedKey)).limit(n).all();return{items:m.map(c=>x(c)),total:b,cursor:b>m.length?m[m.length-1]?.encodedKey??null:null}}catch(n){return d.error("Error listing kv entries",n),{items:[],total:0,cursor:null}}}async set(e,t,n){try{const a=S({key:e,value:t,ttlInSeconds:n?.ttlInSeconds});return await this.databaseClient.client.insert(r).values(a).onConflictDoUpdate({target:[r.encodedKey],set:{value:a.value,expiresAt:a.expiresAt,updatedAt:a.updatedAt}}),a.encodedKey}catch(a){return d.error("Error saving kv entry",a),null}}async delete(e){try{const t=i(e);return await this.databaseClient.client.delete(r).where(C(r.encodedKey,t)),!0}catch(t){return d.error("Error deleting kv entry by key",t),!1}}async clearExpired(){try{await this.databaseClient.client.delete(r).where(g(y`datetime(${r.expiresAt})`,y`datetime('now')`))}catch(e){d.error("Error clearing expired kv entries",e)}}async transaction(e){return this.databaseClient.transactionsManager.transaction(async()=>e({get:async n=>this.get(n),getMany:async n=>this.getMany(n),set:async(n,a,s)=>this.set(n,a,s),delete:async n=>this.delete(n)}))}#t(e){return e?new Date(e)<new Date:!1}}export{$ as KV_KEY_END_BOUNDARY,l as KvRemoteRepository};
+import{eq as E,and as g,gte as m,gt as M,lt as f,asc as B,desc as D,or as K,isNull as C,sql as c,inArray as q,count as $}from"drizzle-orm";import{logger as l}from"../../../tools/notifiers/logger.js";import{kvTable as t}from"../../../providers/database/databases/sqld-sqlite/schemas/kv-table.js";import{BaseRepository as I}from"../../../providers/database/base-repository.js";import{DatabaseConnectionFactory as N}from"../../../providers/database/database-connection-factory.js";import{createKvValue as S}from"../mappers/create-kv-value.js";import{createKvDbRecord as Q,encodeKvKey as d}from"../mappers/create-kv-db-record.js";import{decodeCursor as U}from"../helpers/decode-cursor.js";import{encodeCursor as V}from"../helpers/encode-cursor.js";import{createKvListEntry as b}from"../mappers/create-kv-list-entry.js";const Y="";class u extends I{static#e;constructor(e){super(e)}static async getInstance(e){if(!u.#e)try{const r=await N.create("sqld-remote",e);if(!r)return u.#e=null,null;u.#e=new u(r)}catch(r){return l.error("Error creating kv remote repository",r),u.#e=null,null}return u.#e}async get(e){try{const r=d(e),n=await this.databaseClient.client.select().from(t).where(g(E(t.encodedKey,r),K(C(t.expiresAt),m(c`datetime(${t.expiresAt})`,c`datetime('now')`)))).get();return n?S(n):null}catch(r){return l.error("Error getting kv entry by key",r),null}}async getMany(e){try{if(e.length===0)return[];const r=e.map(i=>d(i)),n=K(C(t.expiresAt),m(c`datetime(${t.expiresAt})`,c`datetime('now')`)),s=await this.databaseClient.client.select().from(t).where(g(q(t.encodedKey,r),n)).all(),o=new Map(s.map(i=>[i.encodedKey,i]));return e.map((i,x)=>{const p=r[x],w=o.get(p);return w?b(w):null})}catch(r){return l.error("Error getting multiple kv entries",r),[]}}async list(e,r){try{const n=r?.limit??100,s=r?.reverse??!1,o=[],v=K(C(t.expiresAt),m(c`datetime(${t.expiresAt})`,c`datetime('now')`));if(o.push(v),"prefix"in e){const a=d(e.prefix),y="start"in e?d(e.start):a,k="end"in e?d(e.end):a+Y;o.push(m(t.encodedKey,y)),o.push(f(t.encodedKey,k))}else if("start"in e&&"end"in e){const a=d(e.start),y=d(e.end);o.push(m(t.encodedKey,a)),o.push(f(t.encodedKey,y))}if(r?.cursor){const a=U(r.cursor),y=s?f(t.encodedKey,a):M(t.encodedKey,a);o.push(y)}const i=this.databaseClient.client.select().from(t),x=o.length>0?i.where(g(...o)):i,p=this.databaseClient.client.select({count:$()}).from(t),A=(await(o.length>0?p.where(g(...o)):p).get())?.count??0,h=await x.orderBy(s?D(t.encodedKey):B(t.encodedKey)).limit(n).all();return{items:h.map(a=>b(a)),total:A,cursor:A>h.length?V(h[h.length-1]?.encodedKey):null}}catch(n){return l.error("Error listing kv entries",n),{items:[],total:0,cursor:null}}}async set(e,r,n){try{const s=Q({key:e,value:r,ttlInSeconds:n?.ttlInSeconds});return await this.databaseClient.client.insert(t).values(s).onConflictDoUpdate({target:[t.encodedKey],set:{value:s.value,expiresAt:s.expiresAt,updatedAt:s.updatedAt}}),b(s)}catch(s){return l.error("Error saving kv entry",s),null}}async delete(e){try{const r=d(e);await this.databaseClient.client.delete(t).where(E(t.encodedKey,r))}catch(r){l.error("Error deleting kv entry by key",r)}}async clearExpired(){try{await this.databaseClient.client.delete(t).where(f(c`datetime(${t.expiresAt})`,c`datetime('now')`))}catch(e){l.error("Error clearing expired kv entries",e)}}async transaction(e){return this.databaseClient.transactionsManager.transaction(async()=>e({get:async n=>this.get(n),getMany:async n=>this.getMany(n),set:async(n,s,o)=>this.set(n,s,o),delete:async n=>this.delete(n)}))}}export{Y as KV_KEY_END_BOUNDARY,u as KvRemoteRepository};

package/dist/server/persistence/kv/schemas/kv-schemas.d.ts

@@ -0,0 +1,10 @@
+import type { KvKey, KvListOptions, KvListSelector, KvSetOptions } from '@redocly/config';
+type Validator<T> = {
+    parse: (data: unknown) => T;
+};
+export declare const kvKeyValidator: Validator<KvKey>;
+export declare const kvListOptionsValidator: Validator<KvListOptions>;
+export declare const kvListSelectorValidator: Validator<KvListSelector>;
+export declare const kvSetOptionsValidator: Validator<KvSetOptions>;
+export {};
+//# sourceMappingURL=kv-schemas.d.ts.map

package/dist/server/persistence/kv/schemas/kv-schemas.js

@@ -0,0 +1 @@
+import s from"@redocly/ajv";const a=new s({coerceTypes:!1,removeAdditional:!0,strictSchema:!1,allowUnionTypes:!0,useDefaults:!0,allErrors:!0,strictTypes:!1}),n=t=>t?.map(e=>`${e.instancePath} ${e.message}`.trim())||["Validation failed"],r={title:"KV key",type:"array",items:{anyOf:[{type:"string"},{type:"number"},{type:"boolean"}]},minItems:1},l={title:"KV list options",type:"object",properties:{limit:{type:"number",minimum:1,maximum:1e3},reverse:{type:"boolean"},cursor:{type:"string"}},additionalProperties:!1,required:[]},p={title:"KV list selector",type:"object",properties:{prefix:r,start:r,end:r},anyOf:[{required:["prefix"]},{required:["start","end"]}],additionalProperties:!1},c={title:"KV set arguments",type:"object",properties:{ttlInSeconds:{type:"number",minimum:1}},additionalProperties:!1,required:[]};function i(t){const e=a.compile(t);return{parse:o=>{if(!e(o))throw new Error(`Invalid ${t.title}: ${n(e.errors).join(", ")}`);return o}}}const u=i(r),y=i(l),f=i(p),v=i(c);export{u as kvKeyValidator,y as kvListOptionsValidator,f as kvListSelectorValidator,v as kvSetOptionsValidator};

package/dist/server/persistence/kv/services/kv-service.d.ts

@@ -1,5 +1,5 @@
+import type { KvValue, KvKey, KvListEntry, KvSetOptions, KvListOptions, KvListResponse, KvListSelector, KvTransaction } from '@redocly/config';
 import type { ServiceInstanceOptions } from '../../../providers/database/types.js';
-import type { KvValue, KvKey, KvReadSchema, KvSetOptions, KvListOptions, KvListResponse, KvListSelector, KvTransaction } from '@redocly/config';
 import { KvRemoteRepository } from '../repositories/kv-remote-repository.js';
 export declare class KvService {
     #private;
@@ -8,23 +8,23 @@ export declare class KvService {
     /**
      * Get a kv entry by key
      */
-    get<T extends KvValue = KvValue>(key: KvKey): Promise<KvReadSchema<T> | null>;
+    get<T extends KvValue = KvValue>(rawKey: KvKey): Promise<T | null>;
     /**
      * Get multiple kv entries by keys
      */
-    getMany<T extends KvValue = KvValue>(keys: KvKey[]): Promise<(KvReadSchema<T> | null)[]>;
+    getMany<T extends KvValue = KvValue>(rawKeys: KvKey[]): Promise<(KvListEntry<T> | null)[]>;
     /**
      * List kv entries by prefix
      */
-    list<T extends KvValue = KvValue>(selector: KvListSelector, options?: KvListOptions): Promise<KvListResponse<T>>;
+    list<T extends KvValue = KvValue>(rawSelector: KvListSelector, rawOptions?: KvListOptions): Promise<KvListResponse<T>>;
     /**
      * Set a kv entry with optional TTL
      */
-    set(key: KvKey, value: KvValue, options?: KvSetOptions): Promise<string | null>;
+    set<T extends KvValue = KvValue>(rawKey: KvKey, value: T, rawOptions?: KvSetOptions): Promise<KvListEntry<T> | null>;
     /**
      * Delete a specific kv entry by key
      */
-    delete(key: KvKey): Promise<boolean>;
+    delete(rawKey: KvKey): Promise<void>;
     /**
      * Clear all expired kv entries
      */

package/dist/server/persistence/kv/services/kv-service.js

@@ -1 +1 @@
-import{isTtlCorrect as o}from"../../../utils/is-ttl-correct.js";import{KvRemoteRepository as c}from"../repositories/kv-remote-repository.js";class n{static#e;#t;constructor(t){this.#t=t}static async#n(t){const e=await c.getInstance(t),s=new n(e);n.#e=s}static async getInstance(t){return n.#e||await n.#n(t),n.#e}async get(t){return await this.#t?.sync(),await this.#t?.get(t)??null}async getMany(t){return await this.#t?.sync(),await this.#t?.getMany(t)??[]}async list(t,e){return await this.#t?.sync(),await this.#t?.list(t,e)??{items:[],total:0,cursor:null}}async set(t,e,s){if(this.#r(e),this.#s(e),!o(s?.ttlInSeconds))throw new Error("TTL must be null or a positive number");return await this.#t?.set(t,e,s)??null}async delete(t){return!!await this.#t?.delete(t)}async clearExpired(){return await this.#t?.clearExpired()}async transaction(t){if(!this.#t)throw new Error("Remote repository not available for transactions");return await this.#t.sync(),this.#t.transaction(async e=>t({get:async r=>e.get(r),getMany:async r=>e.getMany(r),set:async(r,a,i)=>{if(this.#r(a),this.#s(a),!o(i?.ttlInSeconds))throw new Error("TTL must be null or a positive number");return e.set(r,a,i)},delete:async r=>e.delete(r)}))}#r(t){try{JSON.stringify(t)}catch(e){const s=e instanceof Error?e.message:"Unknown error";throw new Error(`Value is not JSON serializable: ${s}`)}}#s(t){const s=JSON.stringify(t),r=Buffer.byteLength(s,"utf8");if(r>1048576){const a=(r/1024).toFixed(2);throw new Error(`Value size (${a} KB) exceeds the maximum allowed size of 1 MB (1024 KB)`)}}}export{n as KvService};
+import{KvRemoteRepository as l}from"../repositories/kv-remote-repository.js";import{kvKeyValidator as a,kvListOptionsValidator as h,kvListSelectorValidator as u,kvSetOptionsValidator as c}from"../schemas/kv-schemas.js";class i{static#s;#t;constructor(t){this.#t=t}static async#r(t){const s=await l.getInstance(t),n=new i(s);i.#s=n}static async getInstance(t){return i.#s||await i.#r(t),i.#s}async get(t){const s=a.parse(t);return await this.#t?.sync(),await this.#t?.get(s)??null}async getMany(t){if(t.length===0)return[];const s=t.map(n=>a.parse(n));return await this.#t?.sync(),await this.#t?.getMany(s)??[]}async list(t,s){const n=u.parse(t),e=h.parse(s??{});return await this.#t?.sync(),await this.#t?.list(n,e)??{items:[],total:0,cursor:null}}async set(t,s,n){const e=a.parse(t),r=c.parse(n??{});return this.#e(s),this.#n(s),await this.#t?.set(e,s,r)??null}async delete(t){const s=a.parse(t);return this.#t?.delete(s)}async clearExpired(){return await this.#t?.clearExpired()}async transaction(t){if(!this.#t)throw new Error("Remote repository not available for transactions");return await this.#t.sync(),this.#t.transaction(async s=>t({get:async e=>{const r=a.parse(e);return s.get(r)},getMany:async e=>{const r=e.map(o=>a.parse(o));return s.getMany(r)},set:async(e,r,o)=>{const y=a.parse(e),p=c.parse(o);return this.#e(r),this.#n(r),s.set(y,r,p)},delete:async e=>{const r=a.parse(e);return s.delete(r)}}))}#e(t){try{JSON.stringify(t)}catch(s){const n=s instanceof Error?s.message:"Unknown error";throw new Error(`Value is not JSON serializable: ${n}`)}}#n(t){const n=JSON.stringify(t),e=Buffer.byteLength(n,"utf8");if(e>1048576){const r=(e/1024).toFixed(2);throw new Error(`Value size (${r} KB) exceeds the maximum allowed size of 1 MB (1024 KB)`)}}}export{i as KvService};

package/dist/server/plugins/markdown/attribute-resolvers/helpers/dereference-json-schema-refs.d.ts

@@ -0,0 +1,14 @@
+import { type NormalizedProblem } from '@redocly/openapi-core';
+import type { ContentFs } from '../../../../fs/content-fs.js';
+type Opts = {
+    schemaOrRef: unknown;
+    fs: ContentFs;
+    filePath: string;
+};
+export declare function dereferenceJsonSchemaRefs({ schemaOrRef, filePath, fs }: Opts): Promise<{
+    schema: unknown;
+    oas: unknown;
+    problems: NormalizedProblem[];
+} | undefined>;
+export {};
+//# sourceMappingURL=dereference-json-schema-refs.d.ts.map

package/dist/server/plugins/markdown/attribute-resolvers/helpers/dereference-json-schema-refs.js

@@ -0,0 +1 @@
+import f from"node:path";import{bundle as m,createConfig as d,Source as l}from"@redocly/openapi-core";import{ExternalResolver as u}from"../../../../fs/utils/external-ref-resolver.js";async function h({schemaOrRef:e,filePath:n,fs:c}){if(typeof e!="object"||!e)return;const a={config:await d({}),base:f.dirname(n),doc:{source:new l(n,""),parsed:JSON.parse(JSON.stringify({openapi:"3.1.0",components:{schemas:{__root:e}}}))},externalRefResolver:new u(c)},{bundle:{parsed:p},problems:i}=await m(a),s=p,o=s?.components?.schemas,r=o?.__root?.$ref,t=typeof r=="string"?r.split("/").at(-1):void 0;return{schema:t?o?.[t]:o?.__root,problems:i,oas:s}}export{h as dereferenceJsonSchemaRefs};

package/dist/server/plugins/markdown/attribute-resolvers/helpers/generate-sample-from-schema.d.ts

@@ -0,0 +1,62 @@
+type GenerateSampleOptions = Partial<{
+    mode: 'read' | 'write';
+    spec: object;
+}>;
+/**
+ * Generates a sample JSON value from a JSON Schema using openapi-sampler.
+ *
+ * @param schema - A JSON Schema object to generate a sample from.
+ *   Must be a plain JavaScript object (not null, array, or primitive).
+ *
+ * @param options - Optional configuration for sample generation.
+ *   - `mode`: Filter properties by read/write semantics (`'read'` | `'write'`).
+ *   - `spec`: Full OpenAPI specification, required if schema contains `$ref` references.
+ *
+ * @returns An object containing either the generated value or an error message.
+ *   - `value`: The generated sample (object or array), or `null` if generation failed.
+ *   - `error`: A descriptive error message if generation failed, or `null` on success.
+ *
+ * @example
+ * // Basic object schema
+ * generateSampleFromSchema({
+ *   type: 'object',
+ *   properties: { name: { type: 'string' } }
+ * });
+ * // Returns: { value: { name: 'string' }, error: null }
+ *
+ * @example
+ * // Using read mode to exclude writeOnly properties
+ * generateSampleFromSchema(
+ *   {
+ *     type: 'object',
+ *     properties: {
+ *       id: { type: 'integer', readOnly: true },
+ *       password: { type: 'string', writeOnly: true }
+ *     }
+ *   },
+ *   { mode: 'read' }
+ * );
+ * // Returns: { value: { id: 0 }, error: null }
+ *
+ * @example
+ * // Schema with $ref requires spec
+ * generateSampleFromSchema(
+ *   { $ref: '#/components/schemas/User' },
+ *   { spec: openApiDocument }
+ * );
+ *
+ * @example
+ * // Empty schema returns error
+ * generateSampleFromSchema({ type: 'object' });
+ * // Returns: { value: null, error: 'Invalid JSON Schema: schema must include properties, items, allOf/anyOf/oneOf, or example/enum/const/default' }
+ *
+ * @remarks
+ * - Primitive schemas (`type: 'string'`, `type: 'integer'`, etc.) are not supported.
+ * - See `../__tests__/generate-sample-from-schema.test.ts` for comprehensive usage examples.
+ */
+export declare function generateSampleFromSchema(schema: unknown, options?: GenerateSampleOptions): {
+    value: unknown;
+    error: string | null;
+};
+export {};
+//# sourceMappingURL=generate-sample-from-schema.d.ts.map

package/dist/server/plugins/markdown/attribute-resolvers/helpers/generate-sample-from-schema.js

@@ -0,0 +1,2 @@
+import i from"@redocly/ajv";import*as s from"openapi-sampler";import{isObject as t}from"../../../../../utils/guards/is-object.js";function p(a,o){if(!t(a))return{value:null,error:"Invalid JSON Schema: schema must be a plain object."};const{mode:l,spec:u}=o??{};let e;try{e=s.sample(a,{...l==="read"?{skipWriteOnly:!0}:void 0,...l==="write"?{skipReadOnly:!0}:void 0},u)}catch(r){return{value:null,error:`Failed to generate sample from schema. Spec is required for schemas with $ref: ${r?.message||""}`}}if(e==null||t(e)&&Object.keys(e).length===0||Array.isArray(e)&&e.length===1&&e[0]===null){const r=new i({}),n=r.validateSchema(a);return typeof n!="boolean"?{value:null,error:"Invalid JSON Schema: Async schemas are not supported."}:!n&&r.errors?.length?{value:null,error:`Invalid JSON Schema: ${r.errorsText(r.errors,{separator:`
+`})}`}:{value:e,error:null}}return{value:e,error:null}}export{p as generateSampleFromSchema};

package/dist/server/plugins/markdown/attribute-resolvers/index.js

@@ -1 +1 @@
-import{resolveOpenApiRef as e}from"./resolve-open-api-ref.js";import{resolveJsonSchemaRef as r}from"./resolve-json-schema-ref.js";import{resolveParsedYaml as o}from"./resolve-parsed-yaml.js";import{resolveRawContent as t}from"./resolve-raw-content.js";import{resolveSvgContent as m}from"./resolve-svg-content.js";import{resolveRelativePath as i}from"./resolve-relative-path.js";import{resolveLink as l}from"./resolve-link.js";import{resolveNativeMdLink as s}from"./resolve-native-md-link.js";import{resolveCodeSnippetFromFile as n}from"./resolve-code-snippet-from-file.js";import{resolveHtmlSourceAttribute as v}from"./resolve-html-source-attribute.js";import{resolveHtmlHref as a}from"./resolve-html-href.js";import{resolveImageSrc as p}from"./resolve-image-src.js";import{resolveImageSrcSet as f}from"./resolve-image-src-set.js";import{resolveNavLinks as c}from"./resolve-nav-links.js";import{resolveRelativeOrCdnIcon as S}from"./resolve-relative-or-cdn-icon.js";import{resolveCodeWalkthroughFilesets as d}from"./code-walkthrough/filesets-resolver.js";const N={openapiRef:e,jsonSchemaRef:r,parsedYaml:o,rawContent:t,svgContent:m,relativePath:i,link:l,nativeMdLink:s,codeSnippetFile:n,htmlSourceAttribute:v,htmlHref:a,imageSrc:p,imageSrcSet:f,navLinks:c,relativeOrCdnIcon:S,codeWalkthroughFilesets:d};export{N as attributeResolvers};
+import{resolveOpenApiRef as e}from"./resolve-open-api-ref.js";import{resolveJsonSchemaRef as o}from"./resolve-json-schema-ref.js";import{resolveParsedYaml as r}from"./resolve-parsed-yaml.js";import{resolveRawContent as m}from"./resolve-raw-content.js";import{resolveSvgContent as t}from"./resolve-svg-content.js";import{resolveRelativePath as i}from"./resolve-relative-path.js";import{resolveLink as l}from"./resolve-link.js";import{resolveNativeMdLink as s}from"./resolve-native-md-link.js";import{resolveCodeSnippetFromFile as a}from"./resolve-code-snippet-from-file.js";import{resolveHtmlSourceAttribute as p}from"./resolve-html-source-attribute.js";import{resolveHtmlHref as n}from"./resolve-html-href.js";import{resolveImageSrc as v}from"./resolve-image-src.js";import{resolveImageSrcSet as f}from"./resolve-image-src-set.js";import{resolveNavLinks as S}from"./resolve-nav-links.js";import{resolveRelativeOrCdnIcon as c}from"./resolve-relative-or-cdn-icon.js";import{resolveCodeWalkthroughFilesets as h}from"./code-walkthrough/filesets-resolver.js";import{resolveJsonExampleRef as d}from"./resolve-json-example-ref.js";import{resolveSampleFromJsonSchema as R}from"./resolve-sample-from-json-schema.js";const N={openapiRef:e,jsonSchemaRef:o,parsedYaml:r,rawContent:m,svgContent:t,relativePath:i,link:l,nativeMdLink:s,codeSnippetFile:a,htmlSourceAttribute:p,htmlHref:n,imageSrc:v,imageSrcSet:f,navLinks:S,relativeOrCdnIcon:c,codeWalkthroughFilesets:h,jsonExampleRef:d,sampleFromJsonSchema:R};export{N as attributeResolvers};

package/dist/server/plugins/markdown/attribute-resolvers/resolve-json-example-ref.d.ts

@@ -0,0 +1,4 @@
+import type { Node } from '@markdoc/markdoc';
+import type { MarkdocResolveContext } from '../../../types';
+export declare function resolveJsonExampleRef(node: Node, attrName: string, relativePath: string, { context, actions }: MarkdocResolveContext): Promise<void>;
+//# sourceMappingURL=resolve-json-example-ref.d.ts.map

package/dist/server/plugins/markdown/attribute-resolvers/resolve-json-example-ref.js

@@ -0,0 +1 @@
+import{JsonPointer as w}from"@redocly/openapi-docs";import{isObject as d}from"../../../../utils/guards/is-object.js";import{getNodeAttribute as u}from"../markdoc/helpers/get-node-attribute.js";import{setNodeAttributeValue as s}from"../markdoc/helpers/set-node-attribute-value.js";import{MdResolveError as p}from"./md-resolve-error.js";import{resolvePathInMarkdown as $}from"../resolve-path-in-markdown.js";async function b(e,o,m,{context:n,actions:h}){const r=u(e,o);try{if(!d(r)||typeof r.$ref!="string"){try{JSON.stringify(r)}catch(i){throw new Error(`Invalid JSON value: ${i.message}`)}s(e,o+"Resolved",r);return}const[t,f]=r.$ref.split("#");if(!t)throw new Error(`Invalid $ref. Path to file is required: ${r.$ref}`);const l=$(t,m,h.contentDir),c=await n.fs.getFileInfo(l);if(!c)throw new Error(`Invalid $ref. No such file: ${l}`);let a;try{a=(await n.cache.load(c.realRelativePath,"yaml")).data}catch(i){throw new Error(`Invalid file format. File must be valid json or yaml: ${l} ${i?.message||""}`)}if(!f){s(e,o+"Resolved",a);return}const v=w.get(a,f);s(e,o+"Resolved",v)}catch(t){throw s(e,o+"ResolvedErrors",[t.message]),new p(t.message,{rawLink:""})}}export{b as resolveJsonExampleRef};

package/dist/server/plugins/markdown/attribute-resolvers/resolve-json-schema-ref.js

@@ -1 +1 @@
-import a from"node:path";import{bundle as b,createConfig as R}from"@redocly/openapi-core";import{getNodeAttribute as v}from"../markdoc/helpers/get-node-attribute.js";import{setNodeAttributeValue as c}from"../markdoc/helpers/set-node-attribute-value.js";import{ExternalResolver as w}from"../../../fs/utils/external-ref-resolver.js";import{formatBundleFromMarkdocError as g}from"../errors.js";import{MdResolveError as h}from"./md-resolve-error.js";async function k(o,e,t,{context:p,actions:f}){const r=v(o,e),s=f.contentDir;if(typeof r!="object"||!r)return;const n=a.resolve(s,t),l={config:await R({}),base:a.dirname(n),doc:{source:{absoluteRef:n},parsed:JSON.parse(JSON.stringify({openapi:"3.1.0",components:{schemas:{__root:r}}}))},externalRefResolver:new w(p.fs)},{bundle:{parsed:d},problems:u}=await b(l);c(o,e+"Resolved",d);const i=u[0];if(!i)return{};const m=g(i,t,s);throw c(o,e+"ResolvedErrors",[m]),new h(m,{rawLink:""})}export{k as resolveJsonSchemaRef};
+import a from"node:path";import{getNodeAttribute as u}from"../markdoc/helpers/get-node-attribute.js";import{setNodeAttributeValue as f}from"../markdoc/helpers/set-node-attribute-value.js";import{formatBundleFromMarkdocError as b}from"../errors.js";import{MdResolveError as d}from"./md-resolve-error.js";import{dereferenceJsonSchemaRefs as h}from"./helpers/dereference-json-schema-refs.js";async function k(o,r,e,{context:c,actions:i}){const l=u(o,r),t=i.contentDir,p=a.resolve(t,e),s=await h({schemaOrRef:l,filePath:p,fs:c.fs});f(o,r+"Resolved",s?.oas);const n=s?.problems[0];if(!n)return{};const m=b(n,e,t);throw f(o,r+"ResolvedErrors",[m]),new d(m,{rawLink:""})}export{k as resolveJsonSchemaRef};

package/dist/server/plugins/markdown/attribute-resolvers/resolve-sample-from-json-schema.d.ts

@@ -0,0 +1,4 @@
+import type { Node } from '@markdoc/markdoc';
+import type { MarkdocResolveContext } from '../../../types';
+export declare function resolveSampleFromJsonSchema(node: Node, attrName: string, relativePath: string, { context, actions }: MarkdocResolveContext): Promise<void>;
+//# sourceMappingURL=resolve-sample-from-json-schema.d.ts.map

package/dist/server/plugins/markdown/attribute-resolvers/resolve-sample-from-json-schema.js

@@ -0,0 +1 @@
+import S from"node:path";import{getNodeAttribute as f}from"../markdoc/helpers/get-node-attribute.js";import{setNodeAttributeValue as i}from"../markdoc/helpers/set-node-attribute-value.js";import{MdResolveError as a}from"./md-resolve-error.js";import{generateSampleFromSchema as g}from"./helpers/generate-sample-from-schema.js";import{formatBundleFromMarkdocError as k}from"../errors.js";import{dereferenceJsonSchemaRefs as E}from"./helpers/dereference-json-schema-refs.js";async function y(o,e,r,{context:p,actions:l}){const h=f(o,e),t=l.contentDir,d=S.resolve(t,r),s=await E({schemaOrRef:h,filePath:d,fs:p.fs});if(!s)return;const{schema:u,problems:w,oas:b}=s,m=w[0];if(m){const c=k(m,r,t);throw i(o,e+"ResolvedErrors",[c]),new a(c,{rawLink:""})}const R=f(o,"mode"),{value:v,error:n}=g(u,{mode:R,spec:b});if(i(o,e+"Resolved",v),n)throw new a(n,{rawLink:""})}export{y as resolveSampleFromJsonSchema};

package/dist/server/plugins/markdown/markdoc/attributes/index.d.ts

@@ -2,4 +2,6 @@ export * from './definition-path.js';
 export * from './parsed-yaml.js';
 export * from './raw-content.js';
 export * from './json-schema-ref.js';
+export * from './json-example-ref.js';
+export * from './sample-from-json-schema.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/server/plugins/markdown/markdoc/attributes/index.js

@@ -1 +1 @@
-export*from"./definition-path.js";export*from"./parsed-yaml.js";export*from"./raw-content.js";export*from"./json-schema-ref.js";
+export*from"./definition-path.js";export*from"./parsed-yaml.js";export*from"./raw-content.js";export*from"./json-schema-ref.js";export*from"./json-example-ref.js";export*from"./sample-from-json-schema.js";

package/dist/server/plugins/markdown/markdoc/attributes/json-example-ref.d.ts

@@ -0,0 +1,6 @@
+import type { CustomAttributeTypeInterface, ValidationError } from '@markdoc/markdoc';
+export declare class JsonExampleRef implements CustomAttributeTypeInterface {
+    validate(_value: string): ValidationError[];
+    static resolver: string;
+}
+//# sourceMappingURL=json-example-ref.d.ts.map

package/dist/server/plugins/markdown/markdoc/attributes/json-example-ref.js

@@ -0,0 +1 @@
+class l{validate(a){return[]}static resolver="jsonExampleRef"}export{l as JsonExampleRef};

package/dist/server/plugins/markdown/markdoc/attributes/sample-from-json-schema.d.ts

@@ -0,0 +1,6 @@
+import type { CustomAttributeTypeInterface, ValidationError } from '@markdoc/markdoc';
+export declare class SampleFromJsonSchema implements CustomAttributeTypeInterface {
+    validate(_value: string): ValidationError[];
+    static resolver: string;
+}
+//# sourceMappingURL=sample-from-json-schema.d.ts.map

package/dist/server/plugins/markdown/markdoc/attributes/sample-from-json-schema.js

@@ -0,0 +1 @@
+class r{validate(a){return[]}static resolver="sampleFromJsonSchema"}export{r as SampleFromJsonSchema};

package/dist/server/plugins/markdown/markdoc/custom-components/openapi/index.d.ts

@@ -5,4 +5,5 @@ export * from './openapi-example.js';
 export * from './step-by-step-wrapper.js';
 export * from './replay-openapi.js';
 export * from './openapi-response-sample.js';
+export * from './json-example.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/server/plugins/markdown/markdoc/custom-components/openapi/index.js

@@ -1 +1 @@
-export*from"./json-schema.js";export*from"./explain-step.js";export*from"./openapi-code-sample.js";export*from"./openapi-example.js";export*from"./step-by-step-wrapper.js";export*from"./replay-openapi.js";export*from"./openapi-response-sample.js";
+export*from"./json-schema.js";export*from"./explain-step.js";export*from"./openapi-code-sample.js";export*from"./openapi-example.js";export*from"./step-by-step-wrapper.js";export*from"./replay-openapi.js";export*from"./openapi-response-sample.js";export*from"./json-example.js";

package/dist/server/plugins/markdown/markdoc/custom-components/openapi/json-example.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+export type JsonExampleProps = {
+    title?: string;
+    json: unknown;
+    errors: string[];
+};
+export declare function JsonExample(props: JsonExampleProps): React.JSX.Element;
+//# sourceMappingURL=json-example.d.ts.map

package/dist/server/plugins/markdown/markdoc/custom-components/openapi/json-example.js

@@ -0,0 +1,7 @@
+import r from"react";import l from"styled-components";import{JsonViewer as n}from"@redocly/theme/components/JsonViewer/JsonViewer";import{ClipboardService as a}from"@redocly/theme/core/utils";function E(c){const{json:e,title:t,errors:o}=c;return o.length?r.createElement(i,null,r.createElement(p,null,"error"),r.createElement(n,{data:o,expandLevel:3,onCopyClick:()=>{a.copyCustom(JSON.stringify(o))},title:t})):r.createElement(n,{data:e,expandLevel:3,onCopyClick:()=>{a.copyCustom(JSON.stringify(e))},title:t})}const i=l.div`
+  background-color: var(--code-block-bg-color);
+  border: 2px solid var(--color-error-border);
+`,p=l.p`
+  color: var(--color-error-text);
+  padding-left: var(--spacing-xs);
+`;export{E as JsonExample};