@redocly/realm 0.134.0-next.1 → 0.134.0-next.3

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @redocly/realm
 
+## 0.134.0-next.3
+
+### Patch Changes
+
+- 98c2a8d099e: Fixed scroll synchronization between the editor and the Webview.
+
+## 0.134.0-next.2
+
+### Minor Changes
+
+- 369752b7a65: Added `renderForLlms` to custom Markdoc tag schemas to control output for LLMs.
+
+### Patch Changes
+
+- 901291dbd68: Fixed an issue where in rare cases, clicking on a link on a Markdown page, could trigger navigation twice, taking the user to the first link on the target page.
+- 140606ccd0c: Fixed issue where the link checker incorrectly reported valid authentication links as broken.
+- 43168a71e27: Fixed an issue where IP addresses associated with submitted feedback were inaccurate due to proxy or CDN chains.
+- Updated dependencies [369752b7a65]
+- Updated dependencies [45d17147cbc]
+- Updated dependencies [082d73f2c3c]
+  - @redocly/theme@0.66.0-next.2
+  - @redocly/realm-asyncapi-sdk@0.12.0-next.2
+  - @redocly/openapi-docs@3.22.0-next.2
+  - @redocly/asyncapi-docs@1.11.0-next.2
+  - @redocly/graphql-docs@1.11.0-next.2
+  - @redocly/portal-plugin-mock-server@0.19.0-next.2
+
 ## 0.134.0-next.1
 
 ### Minor Changes
@@ -56,6 +83,15 @@
   - @redocly/graphql-docs@1.11.0-next.0
   - @redocly/openapi-docs@3.22.0-next.0
 
+## 0.133.1
+
+### Patch Changes
+
+- e69c304a76: Fixed an issue where in rare cases, clicking on a link on a Markdown page, could trigger navigation twice, taking the user to the first link on the target page.
+- Updated dependencies [3aa79f51c8]
+  - @redocly/realm-asyncapi-sdk@0.11.1
+  - @redocly/theme@0.65.0
+
 ## 0.133.0
 
 ### Minor Changes

package/dist/client/app/utils/getBlocksHeight.d.ts

@@ -1,24 +1,16 @@
-type BlockHeight = {
+export type BlockHeight = {
     height: number;
     offset: number;
 };
 /**
- * Calculates the height of each block element within an article, accounting for margins between blocks.
- * A block is defined as content between two heading elements or from start/end of article.
+ * Calculates the height of each block element within markdown content, accounting for margins between blocks.
+ * A block is defined as content between two heading elements or from start/end of the content root.
  * @returns An array containing the heights and offsets of all block elements.
  */
 export declare function getBlocksHeight(): BlockHeight[];
 /**
- * Calculates the offset top position of a block element in an HTML document.
- * A block element is determined by its sequence number in relation to heading elements.
- * @param sequenceNumber - The sequence number of the block element (0-based index).
- * @returns The offset top position of the block element with the specified sequenceNumber, adjusted for nav height.
- * Returns 0 if the sequence number is invalid or no block is found.
- */
-export declare function getBlockOffsetTop(sequenceNumber: number): number;
-/**
- * Calculates the offset top position of an article element, adjusted for navigation height.
- * @returns The offset top position of the article relative to the viewport, accounting for fixed navigation.
+ * Calculates the offset top position of markdown content, adjusted for navigation height.
+ * @returns The offset top position of the content relative to the viewport, accounting for fixed navigation.
  */
 export declare const getArticleOffsetTop: () => number;
 /**
@@ -26,5 +18,4 @@ export declare const getArticleOffsetTop: () => number;
  * @returns The height of the navigation element in pixels, or 0 if no nav element exists.
  */
 export declare const getNavHeight: () => number;
-export {};
 //# sourceMappingURL=getBlocksHeight.d.ts.map

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

@@ -1 +1 @@
-function f(t){const o=window.getComputedStyle(t);return{marginTop:parseFloat(o.getPropertyValue("margin-top"))||0,marginBottom:parseFloat(o.getPropertyValue("margin-bottom"))||0}}const s=t=>!!t&&(t instanceof HTMLHeadingElement||/^H[1-6]$/.test(t.tagName));function p(){const t=[],o=Array.from(document.querySelectorAll("article > *")??[]);let e=0,r=l(o[0]),a=0;return o.forEach(n=>{const{marginTop:i,marginBottom:c}=f(n);s(n)&&e&&(t.push({height:e,offset:r}),r=n.offsetTop-Math.max(a,i),e=0),e+=n.offsetHeight,e+=Math.max(a,i),a=c}),e!==0&&t.push({height:e,offset:r}),t}function u(t){if(t===0)return 0;const e=Array.from(document.querySelectorAll("article > *")).filter(r=>s(r));if(t<e.length){const r=document.querySelector("nav")?.offsetHeight??0;return e[t].offsetTop-r}return 0}const m=()=>{const t=document.querySelector("article")?.offsetTop??0,o=g();return t-o},g=()=>document.querySelector("nav")?.offsetHeight??0;function l(t){if(!t)return 0;const o=window.getComputedStyle(t),e=parseFloat(o.getPropertyValue("margin-top"))||0;return t.offsetTop-e}export{m as getArticleOffsetTop,u as getBlockOffsetTop,p as getBlocksHeight,g as getNavHeight};
+const g='main[data-component-name="Markdown/Markdown"]',h='[data-component-name="Markdoc/Heading/Heading"]';function a(){return document.querySelector(g)}function u(t){const e=Array.from(t.querySelectorAll(h));return e.length>0?e:Array.from(t.querySelectorAll("h1, h2, h3, h4, h5, h6"))}function l(){const t=a();if(!t)return[];const e=u(t);if(e.length===0)return[{offset:n(t),height:t.offsetHeight}];const o=[],f=n(t),s=n(e[0]);s>f&&o.push({offset:f,height:s-f});for(let r=0;r<e.length;r++){const c=n(e[r]),i=(r+1<e.length?n(e[r+1]):n(t)+t.offsetHeight)-c;i>0&&o.push({height:i,offset:c})}return o}const m=()=>{const t=a(),e=t?n(t):0,o=d();return e-o},d=()=>document.querySelector("nav")?.offsetHeight??0;function n(t){if(!t)return 0;const e=window.getComputedStyle(t),o=parseFloat(e.getPropertyValue("margin-top"))||0;return t.offsetTop-o}export{m as getArticleOffsetTop,l as getBlocksHeight,d as getNavHeight};

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

@@ -1 +1 @@
-import{isLocalLink as f}from"../../../utils/path/is-local-link.js";import{isAuthRoutePath as m}from"../../utils/auth/is-auth-route-path.js";import{withLoadProgress as u}from"./withLoadProgress";import{scrollToAnchor as p}from"./scroll-to-anchor";let s;async function A({navigate:i,to:o,origin:a="browser",options:c}){o===""&&(o="/"),s=o;const{pathname:n,hash:d,search:t}=new URL(o,window.location.origin+window.location.pathname),r=decodeURIComponent(d),l=decodeURIComponent(window.location.hash);if(m(n)){window.location.href=o;return}const w=window.__LOADER,e=await u(w.tryLoad(n,void 0,t));if(e?.redirectTo){if(!f(e.redirectTo)){window.location.href=e.redirectTo;return}return A({navigate:i,to:e.redirectTo,origin:a,options:c})}if(e&&s===o){if((n!==window.location.pathname||t!==window.location.search||r!==l)&&i({pathname:n,search:t,hash:r},{...c,state:{origin:a},unstable_flushSync:!0}),e.props?.disableAutoScroll)return;requestAnimationFrame(()=>{if(r){const h=r.slice(1);p(h)}else window.scrollTo(0,0)})}}export{A as loadAndNavigate};
+import{isLocalLink as f}from"../../../utils/path/is-local-link.js";import{isAuthRoutePath as m}from"../../../utils/auth/is-auth-route-path.js";import{withLoadProgress as u}from"./withLoadProgress";import{scrollToAnchor as p}from"./scroll-to-anchor";let s;async function A({navigate:i,to:o,origin:a="browser",options:c}){o===""&&(o="/"),s=o;const{pathname:n,hash:d,search:t}=new URL(o,window.location.origin+window.location.pathname),r=decodeURIComponent(d),l=decodeURIComponent(window.location.hash);if(m(n)){window.location.href=o;return}const w=window.__LOADER,e=await u(w.tryLoad(n,void 0,t));if(e?.redirectTo){if(!f(e.redirectTo)){window.location.href=e.redirectTo;return}return A({navigate:i,to:e.redirectTo,origin:a,options:c})}if(e&&s===o){if((n!==window.location.pathname||t!==window.location.search||r!==l)&&i({pathname:n,search:t,hash:r},{...c,state:{origin:a},unstable_flushSync:!0}),e.props?.disableAutoScroll)return;requestAnimationFrame(()=>{if(r){const h=r.slice(1);p(h)}else window.scrollTo(0,0)})}}export{A as loadAndNavigate};

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

@@ -1 +1 @@
-import{getBlocksHeight as s,getArticleOffsetTop as f,getNavHeight as h}from"./getBlocksHeight.js";function g(t,e=0){if(typeof t>"u"){window.scrollTo({top:0,behavior:"smooth"});return}const o=s(),n=h();if(!o[e])return;const{height:r,offset:c}=o[e],i=Math.round(c-n+r*(Math.round(t)/100));window.scrollTo({top:i,behavior:"smooth"})}const p=t=>{const e=f(),o=h();if(t<e)return{percentScrolled:0,sequenceNumber:-1};const n=s(),r=l(t+o,n),{height:c,offset:i}=n[r];return{percentScrolled:Math.round((t+o-i)/c*100),sequenceNumber:r}};function l(t,e){return e.findIndex(({offset:o,height:n})=>t>=o&&t<o+n)}export{g as syncScrollWithEditor,p as syncScrollWithProject};
+import{getBlocksHeight as s,getArticleOffsetTop as f,getNavHeight as u}from"./getBlocksHeight.js";function m(t,n=0){if(typeof t>"u"){window.scrollTo({top:0,behavior:"smooth"});return}const o=s(),e=u();if(!o[n])return;const{height:r,offset:c}=o[n],i=Math.round(c-e+r*(Math.round(t)/100));window.scrollTo({top:i,behavior:"instant"})}const p=t=>{const n=f(),o=u();if(t<n)return{percentScrolled:0,sequenceNumber:-1};const e=s(),r=h(t+o,e);if(r===-1||!e[r])return{percentScrolled:0,sequenceNumber:-1};const{height:c,offset:i}=e[r];return c<=0?{percentScrolled:0,sequenceNumber:-1}:{percentScrolled:l(Math.round((t+o-i)/c*100)),sequenceNumber:r}};function l(t){return Math.max(0,Math.min(100,t))}function h(t,n){const o=n.findIndex(({offset:e,height:r})=>t>=e&&t<e+r);if(o!==-1)return o;for(let e=n.length-1;e>=0;e--)if(t>=n[e].offset)return e;return-1}export{m as syncScrollWithEditor,p as syncScrollWithProject};

package/dist/client/providers/hooks.js

@@ -1 +1 @@
-import{useEffect as c,useState as s}from"react";import{useNavigate as l}from"react-router-dom";import{isLocalLink as m}from"../../utils/path/is-local-link.js";import{isJsProtocolLink as a}from"../../utils/path/is-js-protocol-link.js";import{isAssetsLink as u}from"../../utils/path/is-assets-link.js";import{isHostnameOnDomain as f}from"../app/utils/isHostnameOnDomain.js";import{loadAndNavigate as d}from"../app/utils/loadAndNavigate.js";import{isForcedNavigationLinkClick as p}from"../utils/utils.js";export*from"./page-data/hooks.js";function E(){const e=l();c(()=>{const t=n=>{const i=n.target;if(i.tagName!=="A"||p(n,i.getAttribute("target")||""))return;const r=i.getAttribute("href");!m(r)||u(r)||a(r)||(n.preventDefault(),d({navigate:e,to:r||""}))};return document.addEventListener("click",t),()=>{document.removeEventListener("click",t)}},[e])}function b(){const[e,t]=s(null);return c(()=>{if(process.env.NODE_ENV==="development"&&typeof window<"u"&&!o("localhost")&&!o("127.0.0.1")&&!o("")&&!o("redocly-local.com")&&!o("editor.redocly.xyz")&&!o("apps.codespaces.githubusercontent.com")&&!o("blueharvest.cloud")&&!o("bhstage.cloud")&&!o("cloud.redocly.com")&&!o("cloud.eu.redocly.com")&&!o("cba.au.redocly.com"))return t("Development mode is only allowed in localhost")},[typeof window]),e}function o(e){return f(window.location.hostname,e)}export{E as useRouterForLocalLinks,b as useRunningEnvironmentCheck};
+import{useEffect as c,useState as s}from"react";import{useNavigate as l}from"react-router-dom";import{isLocalLink as u}from"../../utils/path/is-local-link.js";import{isJsProtocolLink as a}from"../../utils/path/is-js-protocol-link.js";import{isAssetsLink as m}from"../../utils/path/is-assets-link.js";import{isHostnameOnDomain as f}from"../app/utils/isHostnameOnDomain.js";import{loadAndNavigate as d}from"../app/utils/loadAndNavigate.js";import{isForcedNavigationLinkClick as p}from"../utils/utils.js";export*from"./page-data/hooks.js";function E(){const o=l();c(()=>{const r=t=>{if(t.defaultPrevented)return;const i=t.target;if(i.tagName!=="A"||p(t,i.getAttribute("target")||""))return;const n=i.getAttribute("href");!u(n)||m(n)||a(n)||(t.preventDefault(),d({navigate:o,to:n||""}))};return document.addEventListener("click",r),()=>{document.removeEventListener("click",r)}},[o])}function b(){const[o,r]=s(null);return c(()=>{if(process.env.NODE_ENV==="development"&&typeof window<"u"&&!e("localhost")&&!e("127.0.0.1")&&!e("")&&!e("redocly-local.com")&&!e("editor.redocly.xyz")&&!e("apps.codespaces.githubusercontent.com")&&!e("blueharvest.cloud")&&!e("bhstage.cloud")&&!e("cloud.redocly.com")&&!e("cloud.eu.redocly.com")&&!e("cba.au.redocly.com"))return r("Development mode is only allowed in localhost")},[typeof window]),o}function e(o){return f(window.location.hostname,o)}export{E as useRouterForLocalLinks,b as useRunningEnvironmentCheck};

package/dist/client/templates/asyncapi-docs/helpers.d.ts

@@ -3,22 +3,12 @@ export declare function useCollectMarkdocOptions({ markdown }: PageProps): {
     partials: Record<string, import("@markdoc/markdoc").Node | import("@markdoc/markdoc").Node[]> | undefined;
     variables?: Record<string, any>;
     tags: {
-        [x: string]: (import("@markdoc/markdoc").Schema<Readonly<Partial<{
-            nodes: Partial<Record<import("@markdoc/markdoc").NodeType, import("@markdoc/markdoc").Schema<Partial</*elided*/ any>, string>>>;
-            tags: Record<string, import("@markdoc/markdoc").Schema>;
-            variables: Record<string, any>;
-            functions: Record<string, import("@markdoc/markdoc").ConfigFunction>;
-            partials: Record<string, any>;
-            validation?: {
-                parents?: import("@markdoc/markdoc").Node[];
-                validateFunctions?: boolean;
-                environment?: string;
-            };
-        }>>, string> & {
+        [x: string]: import("@redocly/theme/markdoc/tags/types").MarkdocTagSchema | (import("@markdoc/markdoc").Schema & {
             attributes?: Record<string, import("@markdoc/markdoc").SchemaAttribute & {
                 resolver?: string;
             }>;
-        }) | (import("@markdoc/markdoc").Schema & {
+            renderForLlms?: import("@redocly/theme/markdoc/tags/types").RenderForLlmsFn;
+        } & {
             dynamicComponentLib?: string;
         });
     };