@scalar/api-reference 1.59.3 → 1.60.0

package/dist/components/Section/SectionContent.vue.js

@@ -1,8 +1,13 @@
 import _plugin_vue_export_helper_default from "../../_virtual/_plugin-vue_export-helper.js";
-import SectionContent_vue_vue_type_script_setup_true_lang_default from "./SectionContent.vue.script.js";
 /* empty css                             */
+import { createElementBlock, openBlock, renderSlot } from "vue";
 //#region src/components/Section/SectionContent.vue
-var SectionContent_default = /* @__PURE__ */ _plugin_vue_export_helper_default(SectionContent_vue_vue_type_script_setup_true_lang_default, [["__scopeId", "data-v-9735459e"]]);
+var _sfc_main = {};
+var _hoisted_1 = { class: "section-content" };
+function _sfc_render(_ctx, _cache) {
+	return openBlock(), createElementBlock("div", _hoisted_1, [renderSlot(_ctx.$slots, "default", {}, void 0, true)]);
+}
+var SectionContent_default = /* @__PURE__ */ _plugin_vue_export_helper_default(_sfc_main, [["render", _sfc_render], ["__scopeId", "data-v-6101128d"]]);
 //#endregion
 export { SectionContent_default as default };
 

package/dist/components/Section/SectionContent.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"SectionContent.vue.js","names":[],"sources":["../../../src/components/Section/SectionContent.vue"],"sourcesContent":["<script setup lang=\"ts\">\nimport LoadingSkeleton from '../LoadingSkeleton.vue'\n\nwithDefaults(\n  defineProps<{\n    loading?: boolean\n  }>(),\n  {\n    loading: false,\n  },\n)\n</script>\n\n<template>\n  <div class=\"section-content\">\n    <slot v-if=\"!loading\" />\n    <template v-else>\n      <LoadingSkeleton :lines=\"8\" />\n    </template>\n  </div>\n</template>\n\n<style scoped>\n@container narrow-references-container (max-width: 900px) {\n  .section-content--with-columns {\n    flex-direction: column;\n    gap: 24px;\n  }\n}\n</style>\n"],"mappings":""}
+{"version":3,"file":"SectionContent.vue.js","names":[],"sources":["../../../src/components/Section/SectionContent.vue"],"sourcesContent":["<template>\n  <div class=\"section-content\">\n    <slot />\n  </div>\n</template>\n\n<style scoped>\n@container narrow-references-container (max-width: 900px) {\n  .section-content--with-columns {\n    flex-direction: column;\n    gap: 24px;\n  }\n}\n</style>\n"],"mappings":";;;;;mBACO,OAAM,mBAAiB;;qBAA5B,mBAEM,OAFN,YAEM,CADJ,WAAQ,KAAA,QAAA,WAAA,EAAA,EAAA,KAAA,GAAA,KAAA,CAAA,CAAA"}

package/dist/components/Section/SectionHeader.vue.d.ts

@@ -1,13 +1,12 @@
 type __VLS_Props = {
-    loading?: boolean;
     tight?: boolean;
     removeMargin?: boolean;
 };
-declare var __VLS_6: {}, __VLS_8: {};
+declare var __VLS_1: {}, __VLS_3: {};
 type __VLS_Slots = {} & {
-    default?: (props: typeof __VLS_6) => any;
+    default?: (props: typeof __VLS_1) => any;
 } & {
-    links?: (props: typeof __VLS_8) => any;
+    links?: (props: typeof __VLS_3) => any;
 };
 declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;

package/dist/components/Section/SectionHeader.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SectionHeader.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Section/SectionHeader.vue"],"names":[],"mappings":"AAkEA,KAAK,WAAW,GAAG;IACjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAC;AA0DF,QAAA,IAAI,OAAO,IAAU,EAAE,OAAO,IAAW,CAAE;AAC3C,KAAK,WAAW,GAAG,EAAE,GACnB;IAAE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,OAAO,KAAK,GAAG,CAAA;CAAE,GAC5C;IAAE,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,OAAO,KAAK,GAAG,CAAA;CAAE,CAAC;AAK7C,QAAA,MAAM,UAAU,kSAEd,CAAC;AACH,QAAA,MAAM,YAAY,EAAS,eAAe,CAAC,OAAO,UAAU,EAAE,WAAW,CAAC,CAAC;wBACtD,OAAO,YAAY;AAAxC,wBAAyC;AACzC,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAChC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KACV,CAAA;CACD,CAAC"}
+{"version":3,"file":"SectionHeader.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Section/SectionHeader.vue"],"names":[],"mappings":"AAmDA,KAAK,WAAW,GAAG;IACjB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAC;AA0CF,QAAA,IAAI,OAAO,IAAU,EAAE,OAAO,IAAW,CAAE;AAC3C,KAAK,WAAW,GAAG,EAAE,GACnB;IAAE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,OAAO,KAAK,GAAG,CAAA;CAAE,GAC5C;IAAE,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,OAAO,KAAK,GAAG,CAAA;CAAE,CAAC;AAK7C,QAAA,MAAM,UAAU,kSAEd,CAAC;AACH,QAAA,MAAM,YAAY,EAAS,eAAe,CAAC,OAAO,UAAU,EAAE,WAAW,CAAC,CAAC;wBACtD,OAAO,YAAY;AAAxC,wBAAyC;AACzC,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAChC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KACV,CAAA;CACD,CAAC"}

package/dist/components/Section/SectionHeader.vue.js

@@ -2,7 +2,7 @@ import _plugin_vue_export_helper_default from "../../_virtual/_plugin-vue_export
 import SectionHeader_vue_vue_type_script_setup_true_lang_default from "./SectionHeader.vue.script.js";
 /* empty css                            */
 //#region src/components/Section/SectionHeader.vue
-var SectionHeader_default = /* @__PURE__ */ _plugin_vue_export_helper_default(SectionHeader_vue_vue_type_script_setup_true_lang_default, [["__scopeId", "data-v-8a5913a9"]]);
+var SectionHeader_default = /* @__PURE__ */ _plugin_vue_export_helper_default(SectionHeader_vue_vue_type_script_setup_true_lang_default, [["__scopeId", "data-v-09a18ec6"]]);
 //#endregion
 export { SectionHeader_default as default };
 

package/dist/components/Section/SectionHeader.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"SectionHeader.vue.js","names":[],"sources":["../../../src/components/Section/SectionHeader.vue"],"sourcesContent":["<script setup lang=\"ts\">\nimport LoadingSkeleton from '../LoadingSkeleton.vue'\n\nconst {\n  loading,\n  tight,\n  removeMargin = false,\n} = defineProps<{\n  loading?: boolean\n  tight?: boolean\n  removeMargin?: boolean\n}>()\n</script>\n\n<template>\n  <div class=\"section-header-wrapper xl:gap-12\">\n    <LoadingSkeleton v-if=\"loading\" />\n    <div\n      v-else\n      class=\"section-header\"\n      :class=\"{ tight, 'mb-3': !removeMargin }\">\n      <slot />\n    </div>\n    <slot\n      v-if=\"$slots.links\"\n      name=\"links\" />\n  </div>\n</template>\n\n<style scoped>\n@reference \"@/style.css\";\n\n.section-header-wrapper {\n  display: grid;\n  grid-template-columns: 1fr;\n}\n\n@variant xl {\n  .section-header-wrapper {\n    grid-template-columns: repeat(2, 1fr);\n  }\n}\n\n.section-header {\n  font-size: var(--font-size, var(--scalar-heading-1));\n  font-weight: var(--font-weight, var(--scalar-bold));\n  /* prettier-ignore */\n  color: var(--scalar-color-1);\n  word-wrap: break-word;\n  line-height: 1.45;\n  margin-top: 0;\n}\n\n.section-header.tight {\n  margin-bottom: 6px;\n}\n\n.section-header.loading {\n  width: 80%;\n}\n</style>\n"],"mappings":""}
+{"version":3,"file":"SectionHeader.vue.js","names":[],"sources":["../../../src/components/Section/SectionHeader.vue"],"sourcesContent":["<script setup lang=\"ts\">\nconst { tight, removeMargin = false } = defineProps<{\n  tight?: boolean\n  removeMargin?: boolean\n}>()\n</script>\n\n<template>\n  <div class=\"section-header-wrapper xl:gap-12\">\n    <div\n      class=\"section-header\"\n      :class=\"{ tight, 'mb-3': !removeMargin }\">\n      <slot />\n    </div>\n    <slot\n      v-if=\"$slots.links\"\n      name=\"links\" />\n  </div>\n</template>\n\n<style scoped>\n@reference \"@/style.css\";\n\n.section-header-wrapper {\n  display: grid;\n  grid-template-columns: 1fr;\n}\n\n@variant xl {\n  .section-header-wrapper {\n    grid-template-columns: repeat(2, 1fr);\n  }\n}\n\n.section-header {\n  font-size: var(--font-size, var(--scalar-heading-1));\n  font-weight: var(--font-weight, var(--scalar-bold));\n  /* prettier-ignore */\n  color: var(--scalar-color-1);\n  word-wrap: break-word;\n  line-height: 1.45;\n  margin-top: 0;\n}\n\n.section-header.tight {\n  margin-bottom: 6px;\n}\n</style>\n"],"mappings":""}

package/dist/components/Section/SectionHeader.vue.script.js

@@ -1,11 +1,9 @@
-import LoadingSkeleton_default from "../LoadingSkeleton.vue.js";
-import { createBlock, createCommentVNode, createElementBlock, defineComponent, normalizeClass, openBlock, renderSlot } from "vue";
+import { createCommentVNode, createElementBlock, createElementVNode, defineComponent, normalizeClass, openBlock, renderSlot } from "vue";
 //#region src/components/Section/SectionHeader.vue?vue&type=script&setup=true&lang.ts
 var _hoisted_1 = { class: "section-header-wrapper xl:gap-12" };
 var SectionHeader_vue_vue_type_script_setup_true_lang_default = /* @__PURE__ */ defineComponent({
 	__name: "SectionHeader",
 	props: {
-		loading: { type: Boolean },
 		tight: { type: Boolean },
 		removeMargin: {
 			type: Boolean,
@@ -14,13 +12,10 @@ var SectionHeader_vue_vue_type_script_setup_true_lang_default = /* @__PURE__ */
 	},
 	setup(__props) {
 		return (_ctx, _cache) => {
-			return openBlock(), createElementBlock("div", _hoisted_1, [__props.loading ? (openBlock(), createBlock(LoadingSkeleton_default, { key: 0 })) : (openBlock(), createElementBlock("div", {
-				key: 1,
-				class: normalizeClass(["section-header", {
-					tight: __props.tight,
-					"mb-3": !__props.removeMargin
-				}])
-			}, [renderSlot(_ctx.$slots, "default", {}, void 0, true)], 2)), _ctx.$slots.links ? renderSlot(_ctx.$slots, "links", { key: 2 }, void 0, true) : createCommentVNode("", true)]);
+			return openBlock(), createElementBlock("div", _hoisted_1, [createElementVNode("div", { class: normalizeClass(["section-header", {
+				tight: __props.tight,
+				"mb-3": !__props.removeMargin
+			}]) }, [renderSlot(_ctx.$slots, "default", {}, void 0, true)], 2), _ctx.$slots.links ? renderSlot(_ctx.$slots, "links", { key: 0 }, void 0, true) : createCommentVNode("", true)]);
 		};
 	}
 });

package/dist/components/Section/SectionHeader.vue.script.js.map

@@ -1 +1 @@
-{"version":3,"file":"SectionHeader.vue.script.js","names":["$slots"],"sources":["../../../src/components/Section/SectionHeader.vue"],"sourcesContent":["<script setup lang=\"ts\">\nimport LoadingSkeleton from '../LoadingSkeleton.vue'\n\nconst {\n  loading,\n  tight,\n  removeMargin = false,\n} = defineProps<{\n  loading?: boolean\n  tight?: boolean\n  removeMargin?: boolean\n}>()\n</script>\n\n<template>\n  <div class=\"section-header-wrapper xl:gap-12\">\n    <LoadingSkeleton v-if=\"loading\" />\n    <div\n      v-else\n      class=\"section-header\"\n      :class=\"{ tight, 'mb-3': !removeMargin }\">\n      <slot />\n    </div>\n    <slot\n      v-if=\"$slots.links\"\n      name=\"links\" />\n  </div>\n</template>\n\n<style scoped>\n@reference \"@/style.css\";\n\n.section-header-wrapper {\n  display: grid;\n  grid-template-columns: 1fr;\n}\n\n@variant xl {\n  .section-header-wrapper {\n    grid-template-columns: repeat(2, 1fr);\n  }\n}\n\n.section-header {\n  font-size: var(--font-size, var(--scalar-heading-1));\n  font-weight: var(--font-weight, var(--scalar-bold));\n  /* prettier-ignore */\n  color: var(--scalar-color-1);\n  word-wrap: break-word;\n  line-height: 1.45;\n  margin-top: 0;\n}\n\n.section-header.tight {\n  margin-bottom: 6px;\n}\n\n.section-header.loading {\n  width: 80%;\n}\n</style>\n"],"mappings":";;;;;;;;;;;;;;;;uBAeE,mBAWM,OAXN,YAWM,CAVmB,QAAA,WAAA,WAAA,EAAvB,YAAkC,yBAAA,EAAA,KAAA,GAAA,CAAA,KAAA,WAAA,EAClC,mBAKM,OAAA;;IAHJ,OAAK,eAAA,CAAC,kBAAgB;KAAA,OACZ,QAAA;KAAK,QAAA,CAAW,QAAA;KAAY,CAAA,CAAA;OACtC,WAAQ,KAAA,QAAA,WAAA,EAAA,EAAA,KAAA,GAAA,KAAA,CAAA,EAAA,EAAA,GAGFA,KAAAA,OAAO,QADf,WAEiB,KAAA,QAAA,SAAA,EAAA,KAAA,GAAA,EAAA,KAAA,GAAA,KAAA,GAAA,mBAAA,IAAA,KAAA,CAAA,CAAA"}
+{"version":3,"file":"SectionHeader.vue.script.js","names":["$slots"],"sources":["../../../src/components/Section/SectionHeader.vue"],"sourcesContent":["<script setup lang=\"ts\">\nconst { tight, removeMargin = false } = defineProps<{\n  tight?: boolean\n  removeMargin?: boolean\n}>()\n</script>\n\n<template>\n  <div class=\"section-header-wrapper xl:gap-12\">\n    <div\n      class=\"section-header\"\n      :class=\"{ tight, 'mb-3': !removeMargin }\">\n      <slot />\n    </div>\n    <slot\n      v-if=\"$slots.links\"\n      name=\"links\" />\n  </div>\n</template>\n\n<style scoped>\n@reference \"@/style.css\";\n\n.section-header-wrapper {\n  display: grid;\n  grid-template-columns: 1fr;\n}\n\n@variant xl {\n  .section-header-wrapper {\n    grid-template-columns: repeat(2, 1fr);\n  }\n}\n\n.section-header {\n  font-size: var(--font-size, var(--scalar-heading-1));\n  font-weight: var(--font-weight, var(--scalar-bold));\n  /* prettier-ignore */\n  color: var(--scalar-color-1);\n  word-wrap: break-word;\n  line-height: 1.45;\n  margin-top: 0;\n}\n\n.section-header.tight {\n  margin-bottom: 6px;\n}\n</style>\n"],"mappings":";;;;;;;;;;;;;;uBAQE,mBASM,OATN,YASM,CARJ,mBAIM,OAAA,EAHJ,OAAK,eAAA,CAAC,kBAAgB;IAAA,OACZ,QAAA;IAAK,QAAA,CAAW,QAAA;IAAY,CAAA,CAAA,EAAA,EAAA,CACtC,WAAQ,KAAA,QAAA,WAAA,EAAA,EAAA,KAAA,GAAA,KAAA,CAAA,EAAA,EAAA,EAGFA,KAAAA,OAAO,QADf,WAEiB,KAAA,QAAA,SAAA,EAAA,KAAA,GAAA,EAAA,KAAA,GAAA,KAAA,GAAA,mBAAA,IAAA,KAAA,CAAA,CAAA"}

package/dist/helpers/lazy-bus.d.ts

@@ -1,5 +1,15 @@
 /** Tracks when the initial load is complete. */
 export declare const firstLazyLoadComplete: import("vue").Ref<boolean, boolean>;
+/**
+ * The id of the element we are currently scrolling to (the anchor target).
+ *
+ * Schema properties live inside collapsible disclosures that are not part of the
+ * navigation tree, so the lazy bus cannot expand them the way it expands sidebar
+ * parents. Instead we publish the active target here and let each collapsible
+ * schema disclosure open itself when its breadcrumb is on the path to the target.
+ * This is what makes deep links to hidden (collapsed) schema properties work.
+ */
+export declare const scrollTargetId: import("vue").Ref<string, string>;
 export declare const getLazyPlaceholderHeight: (id: string) => number | undefined;
 export declare const setLazyPlaceholderHeight: (id: string, height: number) => void;
 type UnblockFn = () => void;

package/dist/helpers/lazy-bus.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lazy-bus.d.ts","sourceRoot":"","sources":["../../src/helpers/lazy-bus.ts"],"names":[],"mappings":"AAuBA,gDAAgD;AAChD,eAAO,MAAM,qBAAqB,qCAAa,CAAA;AAU/C,eAAO,MAAM,wBAAwB,GAAI,IAAI,MAAM,KAAG,MAAM,GAAG,SAA2C,CAAA;AAE1G,eAAO,MAAM,wBAAwB,GAAI,IAAI,MAAM,EAAE,QAAQ,MAAM,KAAG,IAKrE,CAAA;AASD,KAAK,SAAS,GAAG,MAAM,IAAI,CAAA;AAE3B;;;GAGG;AACH,eAAO,MAAM,iBAAiB,QAAO,SAMpC,CAAA;AAED,2EAA2E;AAC3E,eAAO,MAAM,mBAAmB,oCAAkD,CAAA;AAsFlF;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAAI,IAAI,MAAM,GAAG,SAAS,SAIxD,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,iBAAiB,GAAI,IAAI,MAAM,GAAG,SAAS,EAAE,kBAAgB,KAAG,IAY5E,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,QAAO,IAM9C,CAAA;AAYD;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM;;EAQpC;AAED;;;GAGG;AACH,eAAO,MAAM,YAAY,GACvB,IAAI,MAAM,EACV,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,EACjD,cAAc,CAAC,EAAE,EAAE,MAAM,KAAK;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC;IAAC,QAAQ,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAAE,GAAG,SAAS,SAwD/G,CAAA"}
+{"version":3,"file":"lazy-bus.d.ts","sourceRoot":"","sources":["../../src/helpers/lazy-bus.ts"],"names":[],"mappings":"AAuBA,gDAAgD;AAChD,eAAO,MAAM,qBAAqB,qCAAa,CAAA;AAE/C;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,mCAAkB,CAAA;AAqB7C,eAAO,MAAM,wBAAwB,GAAI,IAAI,MAAM,KAAG,MAAM,GAAG,SAA2C,CAAA;AAE1G,eAAO,MAAM,wBAAwB,GAAI,IAAI,MAAM,EAAE,QAAQ,MAAM,KAAG,IAKrE,CAAA;AASD,KAAK,SAAS,GAAG,MAAM,IAAI,CAAA;AAE3B;;;GAGG;AACH,eAAO,MAAM,iBAAiB,QAAO,SAMpC,CAAA;AAED,2EAA2E;AAC3E,eAAO,MAAM,mBAAmB,oCAAkD,CAAA;AAsFlF;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAAI,IAAI,MAAM,GAAG,SAAS,SAIxD,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,iBAAiB,GAAI,IAAI,MAAM,GAAG,SAAS,EAAE,kBAAgB,KAAG,IAY5E,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,QAAO,IAM9C,CAAA;AAYD;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM;;EAQpC;AAED;;;GAGG;AACH,eAAO,MAAM,YAAY,GACvB,IAAI,MAAM,EACV,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,EACjD,cAAc,CAAC,EAAE,EAAE,MAAM,KAAK;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC;IAAC,QAAQ,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAAE,GAAG,SAAS,SA6D/G,CAAA"}

package/dist/helpers/lazy-bus.js

@@ -20,6 +20,24 @@ var isRunning = ref(false);
 var SCROLL_RETRY_MS = 3e3;
 /** Tracks when the initial load is complete. */
 var firstLazyLoadComplete = ref(false);
+/**
+* The id of the element we are currently scrolling to (the anchor target).
+*
+* Schema properties live inside collapsible disclosures that are not part of the
+* navigation tree, so the lazy bus cannot expand them the way it expands sidebar
+* parents. Instead we publish the active target here and let each collapsible
+* schema disclosure open itself when its breadcrumb is on the path to the target.
+* This is what makes deep links to hidden (collapsed) schema properties work.
+*/
+var scrollTargetId = ref("");
+/**
+* Clears the scroll target once we are done with it, so a stale target cannot
+* re-open a disclosure the user later collapsed (or that remounts). Guarded by
+* the id so a newer navigation that started during the scroll retry is kept.
+*/
+var clearScrollTarget = (id) => {
+	if (scrollTargetId.value === id) scrollTargetId.value = "";
+};
 /** List of unique identifiers that are blocking intersection */
 var intersectionBlockers = reactive(/* @__PURE__ */ new Set());
 var onRenderComplete = /* @__PURE__ */ new Set();
@@ -163,6 +181,7 @@ var scrollToLazy = (id, setExpanded, getEntryById) => {
 	addLazyCompleteCallback(unfreeze);
 	const unblock = blockIntersection();
 	const { rawId } = getSchemaParamsFromId(id);
+	scrollTargetId.value = id;
 	addToPriorityQueue(id);
 	addToPriorityQueue(rawId);
 	if (item?.children) item.children.slice(0, 2).forEach((child) => addToPriorityQueue(child.id));
@@ -201,9 +220,11 @@ var tryScroll = (id, stopTime, onComplete, onFailure) => {
 	const element = document.getElementById(id);
 	if (element) {
 		element.scrollIntoView({ block: "start" });
+		clearScrollTarget(id);
 		onComplete();
 	} else if (Date.now() < stopTime) requestAnimationFrame(() => tryScroll(id, stopTime, onComplete, onFailure));
 	else {
+		clearScrollTarget(id);
 		onComplete();
 		onFailure?.();
 	}
@@ -225,6 +246,6 @@ var freeze = (id) => {
 	};
 };
 //#endregion
-export { addToPriorityQueue, blockIntersection, firstLazyLoadComplete, getLazyPlaceholderHeight, intersectionEnabled, requestLazyRender, scheduleInitialLoadComplete, scrollToLazy, setLazyPlaceholderHeight, useLazyBus };
+export { addToPriorityQueue, blockIntersection, firstLazyLoadComplete, getLazyPlaceholderHeight, intersectionEnabled, requestLazyRender, scheduleInitialLoadComplete, scrollTargetId, scrollToLazy, setLazyPlaceholderHeight, useLazyBus };
 
 //# sourceMappingURL=lazy-bus.js.map

package/dist/helpers/lazy-bus.js.map

@@ -1 +1 @@
-{"version":3,"file":"lazy-bus.js","names":[],"sources":["../../src/helpers/lazy-bus.ts"],"sourcesContent":["import { watchDebounced } from '@vueuse/core'\nimport { nanoid } from 'nanoid'\nimport { computed, nextTick, onBeforeUnmount, reactive, ref } from 'vue'\n\nimport { getSchemaParamsFromId } from './id-routing'\n\n/**\n * List of items that are in the priority queue and will be rendered first (e.g. scroll target).\n */\nconst priorityQueue = reactive<Set<string>>(new Set())\n/** List of items that are pending to be loaded (in viewport overscan). */\nconst pendingQueue = reactive<Set<string>>(new Set())\n/** List of items that are already loaded and stay mounted (no eviction). */\nconst readyQueue = reactive<Set<string>>(new Set())\n/**\n * Flag to indicate if the lazy bus is currently running\n * Blocks ID changes while running\n */\nconst isRunning = ref(false)\n\n/** How long tryScroll keeps retrying to find the element (ms). */\nconst SCROLL_RETRY_MS = 3000\n\n/** Tracks when the initial load is complete. */\nexport const firstLazyLoadComplete = ref(false)\n\n/** List of unique identifiers that are blocking intersection */\nconst intersectionBlockers = reactive<Set<string>>(new Set())\n\nconst onRenderComplete = new Set<() => void>()\n\n/** Cached content heights so placeholders can match when not rendered. */\nconst lazyPlaceholderHeights = reactive<Map<string, number>>(new Map())\n\nexport const getLazyPlaceholderHeight = (id: string): number | undefined => lazyPlaceholderHeights.get(id)\n\nexport const setLazyPlaceholderHeight = (id: string, height: number): void => {\n  if (!Number.isFinite(height) || height <= 0) {\n    return\n  }\n  lazyPlaceholderHeights.set(id, Math.round(height))\n}\n\n/** Adds a one time callback to be executed when the lazy bus has finished loading */\nconst addLazyCompleteCallback = (callback: (() => void) | undefined) => {\n  if (callback) {\n    onRenderComplete.add(callback)\n  }\n}\n\ntype UnblockFn = () => void\n\n/**\n * Blocks intersection until the returned unblock callback is run.\n * Prevents scroll jump while we render new lazy content.\n */\nexport const blockIntersection = (): UnblockFn => {\n  const blockId = nanoid()\n  intersectionBlockers.add(blockId)\n\n  /** Unblock uses a small delay to ensure the scroll is complete before enabling intersection */\n  return () => setTimeout(() => intersectionBlockers.delete(blockId), 100)\n}\n\n/** If there are any pending blocking operations we disable intersection */\nexport const intersectionEnabled = computed(() => intersectionBlockers.size === 0)\n\n/**\n * Processes the full queue: priority first, then pending. Blocks intersection while\n * rendering so the viewport does not jump. No eviction — items stay in readyQueue.\n */\nconst runLazyBus = () => {\n  // We always render the lazy bus when the window is undefined (see useLazyBus)\n  if (typeof window === 'undefined') {\n    return\n  }\n\n  if (isRunning.value) {\n    return\n  }\n\n  isRunning.value = true\n\n  /**\n   * Sets all the pending elements into the ready queue\n   * After waiting for Vue to update the DOM we execute the callbacks and unblock intersection\n   */\n  const processQueue = async () => {\n    const priorityIds = [...priorityQueue]\n    const pendingIds = [...pendingQueue]\n\n    if (priorityIds.length === 0 && pendingIds.length === 0) {\n      onRenderComplete.forEach((fn) => fn())\n      onRenderComplete.clear()\n      isRunning.value = false\n      firstLazyLoadComplete.value = true\n      return\n    }\n\n    for (const id of priorityIds) {\n      readyQueue.add(id)\n      priorityQueue.delete(id)\n    }\n    for (const id of pendingIds) {\n      readyQueue.add(id)\n      pendingQueue.delete(id)\n    }\n\n    await nextTick()\n\n    onRenderComplete.forEach((fn) => fn())\n    onRenderComplete.clear()\n    isRunning.value = false\n    firstLazyLoadComplete.value = true\n  }\n\n  if (window.requestIdleCallback) {\n    window.requestIdleCallback(processQueue, { timeout: 1500 })\n  } else {\n    // biome-ignore lint/nursery/noFloatingPromises: Expected floating promise\n    nextTick(processQueue)\n  }\n}\n\n/**\n * Run the lazy bus when the queue changes and is not currently running\n * Debounce so that multiple changes to the queue are batched together\n *\n * We must run when the priority queue changes because we rely on finish callbacks\n * anytime we request potentially lazy elements. If we don't run when the priority queue changes\n * we may not have a finish callback even though the element is set to load.\n */\nwatchDebounced(\n  [() => pendingQueue.size, () => priorityQueue.size, () => isRunning.value],\n  () => {\n    if ((pendingQueue.size > 0 || priorityQueue.size > 0) && !isRunning.value) {\n      runLazyBus()\n    }\n  },\n  { debounce: 300, maxWait: 1500 },\n)\n\n/**\n * We only make elements pending if they are not already in the priority or ready queue\n */\nconst addToPendingQueue = (id: string | undefined) => {\n  if (id && !readyQueue.has(id) && !priorityQueue.has(id)) {\n    pendingQueue.add(id)\n  }\n}\n\n/**\n * Add elements to the priority queue for immediate rendering.\n * We allow adding items already in readyQueue so that callbacks are still triggered,\n * but processQueue will skip actual re-rendering for items already ready.\n */\nexport const addToPriorityQueue = (id: string | undefined) => {\n  if (id && !priorityQueue.has(id)) {\n    priorityQueue.add(id)\n  }\n}\n\n/**\n * Request an item to be rendered (e.g. when it re-enters the overscan zone).\n */\nexport const requestLazyRender = (id: string | undefined, priority = false): void => {\n  if (!id || readyQueue.has(id)) {\n    return\n  }\n  if (priority) {\n    addToPriorityQueue(id)\n  } else {\n    addToPendingQueue(id)\n  }\n  if (!isRunning.value) {\n    runLazyBus()\n  }\n}\n\n/**\n * Schedules a single run of the lazy bus so that documents with no Lazy components\n * (e.g. no operations, tags, or models) still get firstLazyLoadComplete set and the\n * full-viewport placeholder can be hidden. Call from content root on mount.\n */\nexport const scheduleInitialLoadComplete = (): void => {\n  if (typeof window === 'undefined') {\n    return\n  }\n  const delay = 400\n  window.setTimeout(() => runLazyBus(), delay)\n}\n\n/** When an element is unmounted we remove it from all queues */\nconst resetLazyElement = (id: string) => {\n  priorityQueue.delete(id)\n  pendingQueue.delete(id)\n  readyQueue.delete(id)\n  lazyPlaceholderHeights.delete(id)\n}\n\n// ---------------------------------------------------------------------------\n\n/**\n * Tracks the lazy loading state of an element.\n * Use isReady (or expanded) to decide whether to render the slot or show a placeholder.\n * The element is only added to the queue when it enters the viewport overscan (see Lazy.vue).\n */\nexport function useLazyBus(id: string) {\n  onBeforeUnmount(() => {\n    resetLazyElement(id)\n  })\n\n  return {\n    isReady: computed(() => typeof window === 'undefined' || priorityQueue.has(id) || readyQueue.has(id)),\n  }\n}\n\n/**\n * Scroll to a possibly lazy-loaded element. Expands parents and adds target (and\n * parents) to the priority queue, then scrolls after Vue has flushed.\n */\nexport const scrollToLazy = (\n  id: string,\n  setExpanded: (id: string, value: boolean) => void,\n  getEntryById: (id: string) => { id: string; parent?: { id: string }; children?: { id: string }[] } | undefined,\n) => {\n  const item = getEntryById(id)\n\n  /**\n   * If the element is lazy we must freeze the element so that it does not move until after the next lazy bus run\n   * If the element never loads then the scroll onFailure callback will be run to unfreeze the element\n   *\n   * If the readyQueue does not have the item we must freeze it while it renders\n   * If the item has lazy children we must freeze the item while the children are (potentially) loaded\n   */\n  const isLazy = !readyQueue.has(id) || item?.children?.some((child) => !readyQueue.has(child.id))\n\n  const unfreeze = isLazy ? freeze(id) : undefined\n  addLazyCompleteCallback(unfreeze)\n\n  // Disable intersection while we scroll to the element\n  const unblock = blockIntersection()\n  const { rawId } = getSchemaParamsFromId(id)\n\n  addToPriorityQueue(id)\n  addToPriorityQueue(rawId)\n\n  // When there are children we ensure the first 2 are loaded\n  if (item?.children) {\n    item.children.slice(0, 2).forEach((child) => addToPriorityQueue(child.id))\n  }\n\n  // When there are sibling items we attempt to load the next 2 to better fill the viewport\n  if (item?.parent) {\n    const parent = getEntryById(item.parent.id)\n    const elementIdx = parent?.children?.findIndex((child) => child.id === id)\n    if (elementIdx !== undefined && elementIdx >= 0) {\n      parent?.children?.slice(elementIdx, elementIdx + 2).forEach((child) => addToPriorityQueue(child.id))\n    }\n  }\n\n  setExpanded(rawId, true)\n  /**\n   * Recursively expand the parents and set them as a loading priority\n   * This ensures all parents will be immediately loaded and open\n   */\n  const addParents = (currentId: string) => {\n    const parent = getEntryById(currentId)?.parent\n    if (parent) {\n      addToPriorityQueue(parent.id)\n      setExpanded(parent.id, true)\n      addParents(parent.id)\n    }\n  }\n  /** Must use the rawId as schema params are not in the navigation tree */\n  addParents(rawId)\n\n  void nextTick(() => {\n    tryScroll(id, Date.now() + SCROLL_RETRY_MS, unblock, unfreeze)\n  })\n}\n\n/**\n * Tiny wrapper around the scrollIntoView API\n * Retries up to the stopTime in case the element is not yet rendered\n *\n * @param id - The id of the element to scroll to\n * @param stopTime - The time to stop retrying in unix milliseconds\n */\nconst tryScroll = (id: string, stopTime: number, onComplete: UnblockFn, onFailure?: () => void): void => {\n  const element = document.getElementById(id)\n  if (element) {\n    element.scrollIntoView({ block: 'start' })\n    onComplete()\n  } else if (Date.now() < stopTime) {\n    requestAnimationFrame(() => tryScroll(id, stopTime, onComplete, onFailure))\n  } else {\n    // If the scroll has expired we enable intersection again\n    onComplete()\n    onFailure?.()\n  }\n}\n\nconst freeze = (id: string): (() => void) => {\n  let stop = false\n\n  /**\n   * Runs until the stop flag is set\n   * Executes the final frame after stop changes to true\n   */\n  const runFrame = (stopAfterFrame: boolean) => {\n    const element = document.getElementById(id)\n    if (element) {\n      element.scrollIntoView({ block: 'start' })\n    }\n    if (!stopAfterFrame) {\n      requestAnimationFrame(() => runFrame(stop))\n    }\n  }\n\n  runFrame(false)\n\n  return () => {\n    stop = true\n  }\n}\n"],"mappings":";;;;;;;;AASA,IAAM,gBAAgB,yBAAsB,IAAI,KAAK,CAAC;;AAEtD,IAAM,eAAe,yBAAsB,IAAI,KAAK,CAAC;;AAErD,IAAM,aAAa,yBAAsB,IAAI,KAAK,CAAC;;;;;AAKnD,IAAM,YAAY,IAAI,MAAM;;AAG5B,IAAM,kBAAkB;;AAGxB,IAAa,wBAAwB,IAAI,MAAM;;AAG/C,IAAM,uBAAuB,yBAAsB,IAAI,KAAK,CAAC;AAE7D,IAAM,mCAAmB,IAAI,KAAiB;;AAG9C,IAAM,yBAAyB,yBAA8B,IAAI,KAAK,CAAC;AAEvE,IAAa,4BAA4B,OAAmC,uBAAuB,IAAI,GAAG;AAE1G,IAAa,4BAA4B,IAAY,WAAyB;AAC5E,KAAI,CAAC,OAAO,SAAS,OAAO,IAAI,UAAU,EACxC;AAEF,wBAAuB,IAAI,IAAI,KAAK,MAAM,OAAO,CAAC;;;AAIpD,IAAM,2BAA2B,aAAuC;AACtE,KAAI,SACF,kBAAiB,IAAI,SAAS;;;;;;AAUlC,IAAa,0BAAqC;CAChD,MAAM,UAAU,QAAQ;AACxB,sBAAqB,IAAI,QAAQ;;AAGjC,cAAa,iBAAiB,qBAAqB,OAAO,QAAQ,EAAE,IAAI;;;AAI1E,IAAa,sBAAsB,eAAe,qBAAqB,SAAS,EAAE;;;;;AAMlF,IAAM,mBAAmB;AAEvB,KAAI,OAAO,WAAW,YACpB;AAGF,KAAI,UAAU,MACZ;AAGF,WAAU,QAAQ;;;;;CAMlB,MAAM,eAAe,YAAY;EAC/B,MAAM,cAAc,CAAC,GAAG,cAAc;EACtC,MAAM,aAAa,CAAC,GAAG,aAAa;AAEpC,MAAI,YAAY,WAAW,KAAK,WAAW,WAAW,GAAG;AACvD,oBAAiB,SAAS,OAAO,IAAI,CAAC;AACtC,oBAAiB,OAAO;AACxB,aAAU,QAAQ;AAClB,yBAAsB,QAAQ;AAC9B;;AAGF,OAAK,MAAM,MAAM,aAAa;AAC5B,cAAW,IAAI,GAAG;AAClB,iBAAc,OAAO,GAAG;;AAE1B,OAAK,MAAM,MAAM,YAAY;AAC3B,cAAW,IAAI,GAAG;AAClB,gBAAa,OAAO,GAAG;;AAGzB,QAAM,UAAU;AAEhB,mBAAiB,SAAS,OAAO,IAAI,CAAC;AACtC,mBAAiB,OAAO;AACxB,YAAU,QAAQ;AAClB,wBAAsB,QAAQ;;AAGhC,KAAI,OAAO,oBACT,QAAO,oBAAoB,cAAc,EAAE,SAAS,MAAM,CAAC;KAG3D,UAAS,aAAa;;;;;;;;;;AAY1B,eACE;OAAO,aAAa;OAAY,cAAc;OAAY,UAAU;CAAM,QACpE;AACJ,MAAK,aAAa,OAAO,KAAK,cAAc,OAAO,MAAM,CAAC,UAAU,MAClE,aAAY;GAGhB;CAAE,UAAU;CAAK,SAAS;CAAM,CACjC;;;;AAKD,IAAM,qBAAqB,OAA2B;AACpD,KAAI,MAAM,CAAC,WAAW,IAAI,GAAG,IAAI,CAAC,cAAc,IAAI,GAAG,CACrD,cAAa,IAAI,GAAG;;;;;;;AASxB,IAAa,sBAAsB,OAA2B;AAC5D,KAAI,MAAM,CAAC,cAAc,IAAI,GAAG,CAC9B,eAAc,IAAI,GAAG;;;;;AAOzB,IAAa,qBAAqB,IAAwB,WAAW,UAAgB;AACnF,KAAI,CAAC,MAAM,WAAW,IAAI,GAAG,CAC3B;AAEF,KAAI,SACF,oBAAmB,GAAG;KAEtB,mBAAkB,GAAG;AAEvB,KAAI,CAAC,UAAU,MACb,aAAY;;;;;;;AAShB,IAAa,oCAA0C;AACrD,KAAI,OAAO,WAAW,YACpB;AAGF,QAAO,iBAAiB,YAAY,EADtB,IAC8B;;;AAI9C,IAAM,oBAAoB,OAAe;AACvC,eAAc,OAAO,GAAG;AACxB,cAAa,OAAO,GAAG;AACvB,YAAW,OAAO,GAAG;AACrB,wBAAuB,OAAO,GAAG;;;;;;;AAUnC,SAAgB,WAAW,IAAY;AACrC,uBAAsB;AACpB,mBAAiB,GAAG;GACpB;AAEF,QAAO,EACL,SAAS,eAAe,OAAO,WAAW,eAAe,cAAc,IAAI,GAAG,IAAI,WAAW,IAAI,GAAG,CAAC,EACtG;;;;;;AAOH,IAAa,gBACX,IACA,aACA,iBACG;CACH,MAAM,OAAO,aAAa,GAAG;CAW7B,MAAM,WAFS,CAAC,WAAW,IAAI,GAAG,IAAI,MAAM,UAAU,MAAM,UAAU,CAAC,WAAW,IAAI,MAAM,GAAG,CAAC,GAEtE,OAAO,GAAG,GAAG,KAAA;AACvC,yBAAwB,SAAS;CAGjC,MAAM,UAAU,mBAAmB;CACnC,MAAM,EAAE,UAAU,sBAAsB,GAAG;AAE3C,oBAAmB,GAAG;AACtB,oBAAmB,MAAM;AAGzB,KAAI,MAAM,SACR,MAAK,SAAS,MAAM,GAAG,EAAE,CAAC,SAAS,UAAU,mBAAmB,MAAM,GAAG,CAAC;AAI5E,KAAI,MAAM,QAAQ;EAChB,MAAM,SAAS,aAAa,KAAK,OAAO,GAAG;EAC3C,MAAM,aAAa,QAAQ,UAAU,WAAW,UAAU,MAAM,OAAO,GAAG;AAC1E,MAAI,eAAe,KAAA,KAAa,cAAc,EAC5C,SAAQ,UAAU,MAAM,YAAY,aAAa,EAAE,CAAC,SAAS,UAAU,mBAAmB,MAAM,GAAG,CAAC;;AAIxG,aAAY,OAAO,KAAK;;;;;CAKxB,MAAM,cAAc,cAAsB;EACxC,MAAM,SAAS,aAAa,UAAU,EAAE;AACxC,MAAI,QAAQ;AACV,sBAAmB,OAAO,GAAG;AAC7B,eAAY,OAAO,IAAI,KAAK;AAC5B,cAAW,OAAO,GAAG;;;;AAIzB,YAAW,MAAM;AAEZ,gBAAe;AAClB,YAAU,IAAI,KAAK,KAAK,GAAG,iBAAiB,SAAS,SAAS;GAC9D;;;;;;;;;AAUJ,IAAM,aAAa,IAAY,UAAkB,YAAuB,cAAiC;CACvG,MAAM,UAAU,SAAS,eAAe,GAAG;AAC3C,KAAI,SAAS;AACX,UAAQ,eAAe,EAAE,OAAO,SAAS,CAAC;AAC1C,cAAY;YACH,KAAK,KAAK,GAAG,SACtB,6BAA4B,UAAU,IAAI,UAAU,YAAY,UAAU,CAAC;MACtE;AAEL,cAAY;AACZ,eAAa;;;AAIjB,IAAM,UAAU,OAA6B;CAC3C,IAAI,OAAO;;;;;CAMX,MAAM,YAAY,mBAA4B;EAC5C,MAAM,UAAU,SAAS,eAAe,GAAG;AAC3C,MAAI,QACF,SAAQ,eAAe,EAAE,OAAO,SAAS,CAAC;AAE5C,MAAI,CAAC,eACH,6BAA4B,SAAS,KAAK,CAAC;;AAI/C,UAAS,MAAM;AAEf,cAAa;AACX,SAAO"}
+{"version":3,"file":"lazy-bus.js","names":[],"sources":["../../src/helpers/lazy-bus.ts"],"sourcesContent":["import { watchDebounced } from '@vueuse/core'\nimport { nanoid } from 'nanoid'\nimport { computed, nextTick, onBeforeUnmount, reactive, ref } from 'vue'\n\nimport { getSchemaParamsFromId } from './id-routing'\n\n/**\n * List of items that are in the priority queue and will be rendered first (e.g. scroll target).\n */\nconst priorityQueue = reactive<Set<string>>(new Set())\n/** List of items that are pending to be loaded (in viewport overscan). */\nconst pendingQueue = reactive<Set<string>>(new Set())\n/** List of items that are already loaded and stay mounted (no eviction). */\nconst readyQueue = reactive<Set<string>>(new Set())\n/**\n * Flag to indicate if the lazy bus is currently running\n * Blocks ID changes while running\n */\nconst isRunning = ref(false)\n\n/** How long tryScroll keeps retrying to find the element (ms). */\nconst SCROLL_RETRY_MS = 3000\n\n/** Tracks when the initial load is complete. */\nexport const firstLazyLoadComplete = ref(false)\n\n/**\n * The id of the element we are currently scrolling to (the anchor target).\n *\n * Schema properties live inside collapsible disclosures that are not part of the\n * navigation tree, so the lazy bus cannot expand them the way it expands sidebar\n * parents. Instead we publish the active target here and let each collapsible\n * schema disclosure open itself when its breadcrumb is on the path to the target.\n * This is what makes deep links to hidden (collapsed) schema properties work.\n */\nexport const scrollTargetId = ref<string>('')\n\n/**\n * Clears the scroll target once we are done with it, so a stale target cannot\n * re-open a disclosure the user later collapsed (or that remounts). Guarded by\n * the id so a newer navigation that started during the scroll retry is kept.\n */\nconst clearScrollTarget = (id: string): void => {\n  if (scrollTargetId.value === id) {\n    scrollTargetId.value = ''\n  }\n}\n\n/** List of unique identifiers that are blocking intersection */\nconst intersectionBlockers = reactive<Set<string>>(new Set())\n\nconst onRenderComplete = new Set<() => void>()\n\n/** Cached content heights so placeholders can match when not rendered. */\nconst lazyPlaceholderHeights = reactive<Map<string, number>>(new Map())\n\nexport const getLazyPlaceholderHeight = (id: string): number | undefined => lazyPlaceholderHeights.get(id)\n\nexport const setLazyPlaceholderHeight = (id: string, height: number): void => {\n  if (!Number.isFinite(height) || height <= 0) {\n    return\n  }\n  lazyPlaceholderHeights.set(id, Math.round(height))\n}\n\n/** Adds a one time callback to be executed when the lazy bus has finished loading */\nconst addLazyCompleteCallback = (callback: (() => void) | undefined) => {\n  if (callback) {\n    onRenderComplete.add(callback)\n  }\n}\n\ntype UnblockFn = () => void\n\n/**\n * Blocks intersection until the returned unblock callback is run.\n * Prevents scroll jump while we render new lazy content.\n */\nexport const blockIntersection = (): UnblockFn => {\n  const blockId = nanoid()\n  intersectionBlockers.add(blockId)\n\n  /** Unblock uses a small delay to ensure the scroll is complete before enabling intersection */\n  return () => setTimeout(() => intersectionBlockers.delete(blockId), 100)\n}\n\n/** If there are any pending blocking operations we disable intersection */\nexport const intersectionEnabled = computed(() => intersectionBlockers.size === 0)\n\n/**\n * Processes the full queue: priority first, then pending. Blocks intersection while\n * rendering so the viewport does not jump. No eviction — items stay in readyQueue.\n */\nconst runLazyBus = () => {\n  // We always render the lazy bus when the window is undefined (see useLazyBus)\n  if (typeof window === 'undefined') {\n    return\n  }\n\n  if (isRunning.value) {\n    return\n  }\n\n  isRunning.value = true\n\n  /**\n   * Sets all the pending elements into the ready queue\n   * After waiting for Vue to update the DOM we execute the callbacks and unblock intersection\n   */\n  const processQueue = async () => {\n    const priorityIds = [...priorityQueue]\n    const pendingIds = [...pendingQueue]\n\n    if (priorityIds.length === 0 && pendingIds.length === 0) {\n      onRenderComplete.forEach((fn) => fn())\n      onRenderComplete.clear()\n      isRunning.value = false\n      firstLazyLoadComplete.value = true\n      return\n    }\n\n    for (const id of priorityIds) {\n      readyQueue.add(id)\n      priorityQueue.delete(id)\n    }\n    for (const id of pendingIds) {\n      readyQueue.add(id)\n      pendingQueue.delete(id)\n    }\n\n    await nextTick()\n\n    onRenderComplete.forEach((fn) => fn())\n    onRenderComplete.clear()\n    isRunning.value = false\n    firstLazyLoadComplete.value = true\n  }\n\n  if (window.requestIdleCallback) {\n    window.requestIdleCallback(processQueue, { timeout: 1500 })\n  } else {\n    // biome-ignore lint/nursery/noFloatingPromises: Expected floating promise\n    nextTick(processQueue)\n  }\n}\n\n/**\n * Run the lazy bus when the queue changes and is not currently running\n * Debounce so that multiple changes to the queue are batched together\n *\n * We must run when the priority queue changes because we rely on finish callbacks\n * anytime we request potentially lazy elements. If we don't run when the priority queue changes\n * we may not have a finish callback even though the element is set to load.\n */\nwatchDebounced(\n  [() => pendingQueue.size, () => priorityQueue.size, () => isRunning.value],\n  () => {\n    if ((pendingQueue.size > 0 || priorityQueue.size > 0) && !isRunning.value) {\n      runLazyBus()\n    }\n  },\n  { debounce: 300, maxWait: 1500 },\n)\n\n/**\n * We only make elements pending if they are not already in the priority or ready queue\n */\nconst addToPendingQueue = (id: string | undefined) => {\n  if (id && !readyQueue.has(id) && !priorityQueue.has(id)) {\n    pendingQueue.add(id)\n  }\n}\n\n/**\n * Add elements to the priority queue for immediate rendering.\n * We allow adding items already in readyQueue so that callbacks are still triggered,\n * but processQueue will skip actual re-rendering for items already ready.\n */\nexport const addToPriorityQueue = (id: string | undefined) => {\n  if (id && !priorityQueue.has(id)) {\n    priorityQueue.add(id)\n  }\n}\n\n/**\n * Request an item to be rendered (e.g. when it re-enters the overscan zone).\n */\nexport const requestLazyRender = (id: string | undefined, priority = false): void => {\n  if (!id || readyQueue.has(id)) {\n    return\n  }\n  if (priority) {\n    addToPriorityQueue(id)\n  } else {\n    addToPendingQueue(id)\n  }\n  if (!isRunning.value) {\n    runLazyBus()\n  }\n}\n\n/**\n * Schedules a single run of the lazy bus so that documents with no Lazy components\n * (e.g. no operations, tags, or models) still get firstLazyLoadComplete set and the\n * full-viewport placeholder can be hidden. Call from content root on mount.\n */\nexport const scheduleInitialLoadComplete = (): void => {\n  if (typeof window === 'undefined') {\n    return\n  }\n  const delay = 400\n  window.setTimeout(() => runLazyBus(), delay)\n}\n\n/** When an element is unmounted we remove it from all queues */\nconst resetLazyElement = (id: string) => {\n  priorityQueue.delete(id)\n  pendingQueue.delete(id)\n  readyQueue.delete(id)\n  lazyPlaceholderHeights.delete(id)\n}\n\n// ---------------------------------------------------------------------------\n\n/**\n * Tracks the lazy loading state of an element.\n * Use isReady (or expanded) to decide whether to render the slot or show a placeholder.\n * The element is only added to the queue when it enters the viewport overscan (see Lazy.vue).\n */\nexport function useLazyBus(id: string) {\n  onBeforeUnmount(() => {\n    resetLazyElement(id)\n  })\n\n  return {\n    isReady: computed(() => typeof window === 'undefined' || priorityQueue.has(id) || readyQueue.has(id)),\n  }\n}\n\n/**\n * Scroll to a possibly lazy-loaded element. Expands parents and adds target (and\n * parents) to the priority queue, then scrolls after Vue has flushed.\n */\nexport const scrollToLazy = (\n  id: string,\n  setExpanded: (id: string, value: boolean) => void,\n  getEntryById: (id: string) => { id: string; parent?: { id: string }; children?: { id: string }[] } | undefined,\n) => {\n  const item = getEntryById(id)\n\n  /**\n   * If the element is lazy we must freeze the element so that it does not move until after the next lazy bus run\n   * If the element never loads then the scroll onFailure callback will be run to unfreeze the element\n   *\n   * If the readyQueue does not have the item we must freeze it while it renders\n   * If the item has lazy children we must freeze the item while the children are (potentially) loaded\n   */\n  const isLazy = !readyQueue.has(id) || item?.children?.some((child) => !readyQueue.has(child.id))\n\n  const unfreeze = isLazy ? freeze(id) : undefined\n  addLazyCompleteCallback(unfreeze)\n\n  // Disable intersection while we scroll to the element\n  const unblock = blockIntersection()\n  const { rawId } = getSchemaParamsFromId(id)\n\n  // Publish the target so collapsible schema disclosures on the path can open\n  // themselves. Schema properties are not in the navigation tree, so this is the\n  // only way the scroll target inside a collapsed schema becomes reachable.\n  scrollTargetId.value = id\n\n  addToPriorityQueue(id)\n  addToPriorityQueue(rawId)\n\n  // When there are children we ensure the first 2 are loaded\n  if (item?.children) {\n    item.children.slice(0, 2).forEach((child) => addToPriorityQueue(child.id))\n  }\n\n  // When there are sibling items we attempt to load the next 2 to better fill the viewport\n  if (item?.parent) {\n    const parent = getEntryById(item.parent.id)\n    const elementIdx = parent?.children?.findIndex((child) => child.id === id)\n    if (elementIdx !== undefined && elementIdx >= 0) {\n      parent?.children?.slice(elementIdx, elementIdx + 2).forEach((child) => addToPriorityQueue(child.id))\n    }\n  }\n\n  setExpanded(rawId, true)\n  /**\n   * Recursively expand the parents and set them as a loading priority\n   * This ensures all parents will be immediately loaded and open\n   */\n  const addParents = (currentId: string) => {\n    const parent = getEntryById(currentId)?.parent\n    if (parent) {\n      addToPriorityQueue(parent.id)\n      setExpanded(parent.id, true)\n      addParents(parent.id)\n    }\n  }\n  /** Must use the rawId as schema params are not in the navigation tree */\n  addParents(rawId)\n\n  void nextTick(() => {\n    tryScroll(id, Date.now() + SCROLL_RETRY_MS, unblock, unfreeze)\n  })\n}\n\n/**\n * Tiny wrapper around the scrollIntoView API\n * Retries up to the stopTime in case the element is not yet rendered\n *\n * @param id - The id of the element to scroll to\n * @param stopTime - The time to stop retrying in unix milliseconds\n */\nconst tryScroll = (id: string, stopTime: number, onComplete: UnblockFn, onFailure?: () => void): void => {\n  const element = document.getElementById(id)\n  if (element) {\n    element.scrollIntoView({ block: 'start' })\n    clearScrollTarget(id)\n    onComplete()\n  } else if (Date.now() < stopTime) {\n    requestAnimationFrame(() => tryScroll(id, stopTime, onComplete, onFailure))\n  } else {\n    // If the scroll has expired we enable intersection again\n    clearScrollTarget(id)\n    onComplete()\n    onFailure?.()\n  }\n}\n\nconst freeze = (id: string): (() => void) => {\n  let stop = false\n\n  /**\n   * Runs until the stop flag is set\n   * Executes the final frame after stop changes to true\n   */\n  const runFrame = (stopAfterFrame: boolean) => {\n    const element = document.getElementById(id)\n    if (element) {\n      element.scrollIntoView({ block: 'start' })\n    }\n    if (!stopAfterFrame) {\n      requestAnimationFrame(() => runFrame(stop))\n    }\n  }\n\n  runFrame(false)\n\n  return () => {\n    stop = true\n  }\n}\n"],"mappings":";;;;;;;;AASA,IAAM,gBAAgB,yBAAsB,IAAI,KAAK,CAAC;;AAEtD,IAAM,eAAe,yBAAsB,IAAI,KAAK,CAAC;;AAErD,IAAM,aAAa,yBAAsB,IAAI,KAAK,CAAC;;;;;AAKnD,IAAM,YAAY,IAAI,MAAM;;AAG5B,IAAM,kBAAkB;;AAGxB,IAAa,wBAAwB,IAAI,MAAM;;;;;;;;;;AAW/C,IAAa,iBAAiB,IAAY,GAAG;;;;;;AAO7C,IAAM,qBAAqB,OAAqB;AAC9C,KAAI,eAAe,UAAU,GAC3B,gBAAe,QAAQ;;;AAK3B,IAAM,uBAAuB,yBAAsB,IAAI,KAAK,CAAC;AAE7D,IAAM,mCAAmB,IAAI,KAAiB;;AAG9C,IAAM,yBAAyB,yBAA8B,IAAI,KAAK,CAAC;AAEvE,IAAa,4BAA4B,OAAmC,uBAAuB,IAAI,GAAG;AAE1G,IAAa,4BAA4B,IAAY,WAAyB;AAC5E,KAAI,CAAC,OAAO,SAAS,OAAO,IAAI,UAAU,EACxC;AAEF,wBAAuB,IAAI,IAAI,KAAK,MAAM,OAAO,CAAC;;;AAIpD,IAAM,2BAA2B,aAAuC;AACtE,KAAI,SACF,kBAAiB,IAAI,SAAS;;;;;;AAUlC,IAAa,0BAAqC;CAChD,MAAM,UAAU,QAAQ;AACxB,sBAAqB,IAAI,QAAQ;;AAGjC,cAAa,iBAAiB,qBAAqB,OAAO,QAAQ,EAAE,IAAI;;;AAI1E,IAAa,sBAAsB,eAAe,qBAAqB,SAAS,EAAE;;;;;AAMlF,IAAM,mBAAmB;AAEvB,KAAI,OAAO,WAAW,YACpB;AAGF,KAAI,UAAU,MACZ;AAGF,WAAU,QAAQ;;;;;CAMlB,MAAM,eAAe,YAAY;EAC/B,MAAM,cAAc,CAAC,GAAG,cAAc;EACtC,MAAM,aAAa,CAAC,GAAG,aAAa;AAEpC,MAAI,YAAY,WAAW,KAAK,WAAW,WAAW,GAAG;AACvD,oBAAiB,SAAS,OAAO,IAAI,CAAC;AACtC,oBAAiB,OAAO;AACxB,aAAU,QAAQ;AAClB,yBAAsB,QAAQ;AAC9B;;AAGF,OAAK,MAAM,MAAM,aAAa;AAC5B,cAAW,IAAI,GAAG;AAClB,iBAAc,OAAO,GAAG;;AAE1B,OAAK,MAAM,MAAM,YAAY;AAC3B,cAAW,IAAI,GAAG;AAClB,gBAAa,OAAO,GAAG;;AAGzB,QAAM,UAAU;AAEhB,mBAAiB,SAAS,OAAO,IAAI,CAAC;AACtC,mBAAiB,OAAO;AACxB,YAAU,QAAQ;AAClB,wBAAsB,QAAQ;;AAGhC,KAAI,OAAO,oBACT,QAAO,oBAAoB,cAAc,EAAE,SAAS,MAAM,CAAC;KAG3D,UAAS,aAAa;;;;;;;;;;AAY1B,eACE;OAAO,aAAa;OAAY,cAAc;OAAY,UAAU;CAAM,QACpE;AACJ,MAAK,aAAa,OAAO,KAAK,cAAc,OAAO,MAAM,CAAC,UAAU,MAClE,aAAY;GAGhB;CAAE,UAAU;CAAK,SAAS;CAAM,CACjC;;;;AAKD,IAAM,qBAAqB,OAA2B;AACpD,KAAI,MAAM,CAAC,WAAW,IAAI,GAAG,IAAI,CAAC,cAAc,IAAI,GAAG,CACrD,cAAa,IAAI,GAAG;;;;;;;AASxB,IAAa,sBAAsB,OAA2B;AAC5D,KAAI,MAAM,CAAC,cAAc,IAAI,GAAG,CAC9B,eAAc,IAAI,GAAG;;;;;AAOzB,IAAa,qBAAqB,IAAwB,WAAW,UAAgB;AACnF,KAAI,CAAC,MAAM,WAAW,IAAI,GAAG,CAC3B;AAEF,KAAI,SACF,oBAAmB,GAAG;KAEtB,mBAAkB,GAAG;AAEvB,KAAI,CAAC,UAAU,MACb,aAAY;;;;;;;AAShB,IAAa,oCAA0C;AACrD,KAAI,OAAO,WAAW,YACpB;AAGF,QAAO,iBAAiB,YAAY,EADtB,IAC8B;;;AAI9C,IAAM,oBAAoB,OAAe;AACvC,eAAc,OAAO,GAAG;AACxB,cAAa,OAAO,GAAG;AACvB,YAAW,OAAO,GAAG;AACrB,wBAAuB,OAAO,GAAG;;;;;;;AAUnC,SAAgB,WAAW,IAAY;AACrC,uBAAsB;AACpB,mBAAiB,GAAG;GACpB;AAEF,QAAO,EACL,SAAS,eAAe,OAAO,WAAW,eAAe,cAAc,IAAI,GAAG,IAAI,WAAW,IAAI,GAAG,CAAC,EACtG;;;;;;AAOH,IAAa,gBACX,IACA,aACA,iBACG;CACH,MAAM,OAAO,aAAa,GAAG;CAW7B,MAAM,WAFS,CAAC,WAAW,IAAI,GAAG,IAAI,MAAM,UAAU,MAAM,UAAU,CAAC,WAAW,IAAI,MAAM,GAAG,CAAC,GAEtE,OAAO,GAAG,GAAG,KAAA;AACvC,yBAAwB,SAAS;CAGjC,MAAM,UAAU,mBAAmB;CACnC,MAAM,EAAE,UAAU,sBAAsB,GAAG;AAK3C,gBAAe,QAAQ;AAEvB,oBAAmB,GAAG;AACtB,oBAAmB,MAAM;AAGzB,KAAI,MAAM,SACR,MAAK,SAAS,MAAM,GAAG,EAAE,CAAC,SAAS,UAAU,mBAAmB,MAAM,GAAG,CAAC;AAI5E,KAAI,MAAM,QAAQ;EAChB,MAAM,SAAS,aAAa,KAAK,OAAO,GAAG;EAC3C,MAAM,aAAa,QAAQ,UAAU,WAAW,UAAU,MAAM,OAAO,GAAG;AAC1E,MAAI,eAAe,KAAA,KAAa,cAAc,EAC5C,SAAQ,UAAU,MAAM,YAAY,aAAa,EAAE,CAAC,SAAS,UAAU,mBAAmB,MAAM,GAAG,CAAC;;AAIxG,aAAY,OAAO,KAAK;;;;;CAKxB,MAAM,cAAc,cAAsB;EACxC,MAAM,SAAS,aAAa,UAAU,EAAE;AACxC,MAAI,QAAQ;AACV,sBAAmB,OAAO,GAAG;AAC7B,eAAY,OAAO,IAAI,KAAK;AAC5B,cAAW,OAAO,GAAG;;;;AAIzB,YAAW,MAAM;AAEZ,gBAAe;AAClB,YAAU,IAAI,KAAK,KAAK,GAAG,iBAAiB,SAAS,SAAS;GAC9D;;;;;;;;;AAUJ,IAAM,aAAa,IAAY,UAAkB,YAAuB,cAAiC;CACvG,MAAM,UAAU,SAAS,eAAe,GAAG;AAC3C,KAAI,SAAS;AACX,UAAQ,eAAe,EAAE,OAAO,SAAS,CAAC;AAC1C,oBAAkB,GAAG;AACrB,cAAY;YACH,KAAK,KAAK,GAAG,SACtB,6BAA4B,UAAU,IAAI,UAAU,YAAY,UAAU,CAAC;MACtE;AAEL,oBAAkB,GAAG;AACrB,cAAY;AACZ,eAAa;;;AAIjB,IAAM,UAAU,OAA6B;CAC3C,IAAI,OAAO;;;;;CAMX,MAAM,YAAY,mBAA4B;EAC5C,MAAM,UAAU,SAAS,eAAe,GAAG;AAC3C,MAAI,QACF,SAAQ,eAAe,EAAE,OAAO,SAAS,CAAC;AAE5C,MAAI,CAAC,eACH,6BAA4B,SAAS,KAAK,CAAC;;AAI/C,UAAS,MAAM;AAEf,cAAa;AACX,SAAO"}

package/dist/plugins/index.d.ts

@@ -1,4 +1,4 @@
 export { PLUGIN_MANAGER_SYMBOL, usePluginManager } from '../plugins/hooks/usePluginManager.js';
-export { type ApiReferencePlugin, type PluginManager, createPluginManager, } from '../plugins/plugin-manager.js';
+export { type ApiReferencePlugin, type PluginManager, type PluginViewComponent, createPluginManager, } from '../plugins/plugin-manager.js';
 export { persistencePlugin } from './persistence-plugin.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/plugins/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/plugins/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAA;AAC1F,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,aAAa,EAClB,mBAAmB,GACpB,MAAM,0BAA0B,CAAA;AAEjC,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/plugins/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAA;AAC1F,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,aAAa,EAClB,KAAK,mBAAmB,EACxB,mBAAmB,GACpB,MAAM,0BAA0B,CAAA;AAEjC,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA"}

package/dist/plugins/plugin-manager.d.ts

@@ -4,6 +4,19 @@ export type ApiReferencePlugin = OriginalApiReferencePlugin;
 type CreatePluginManagerParams = {
     plugins?: ApiReferencePlugin[];
 };
+/** Plugin view slots that can render custom components in the content area */
+declare const PLUGIN_VIEW_NAMES: readonly ["content.start", "content.end"];
+type PluginViewName = (typeof PLUGIN_VIEW_NAMES)[number];
+/** A plugin view component paired with the stable id used for the DOM and sidebar navigation */
+export type PluginViewComponent = ViewComponent & {
+    id: string;
+};
+/** A sidebar entry contributed by a plugin view */
+type PluginSidebarEntry = {
+    id: string;
+    label: string;
+    viewName: PluginViewName;
+};
 /**
  * Create the plugin manager store
  *
@@ -15,9 +28,13 @@ export declare const createPluginManager: ({ plugins }: CreatePluginManagerParam
      */
     getSpecificationExtensions: (name: `x-${string}`) => SpecificationExtension[];
     /**
-     * Get all components for a specific view from registered plugins
+     * Get all components for a specific view from registered plugins.
+     *
+     * Each component carries a stable `id` (scoped to the active document slug) so the rendered
+     * DOM element and the sidebar entry (see `getSidebarEntries`) share the same id and stay in
+     * sync for scroll navigation and deep-linking.
      */
-    getViewComponents: (viewName: "content.end") => ViewComponent[];
+    getViewComponents: (viewName: PluginViewName, documentSlug: string) => PluginViewComponent[];
     /**
      * Notify all plugins that the API Reference has been initialized
      */
@@ -34,6 +51,14 @@ export declare const createPluginManager: ({ plugins }: CreatePluginManagerParam
      * Get all client plugins provided by registered plugins
      */
     getApiClientPlugins: () => ClientPlugin[];
+    /**
+     * Get all sidebar entries contributed by plugin views.
+     *
+     * Only views that opt in via `sidebar.show` are returned. Each entry's `id` matches the
+     * id of the rendered component (see `getViewComponents`), so the API Reference can add it
+     * to the sidebar navigation and scrolling/active-tracking work out of the box.
+     */
+    getSidebarEntries: (documentSlug: string) => PluginSidebarEntry[];
 };
 export type PluginManager = ReturnType<typeof createPluginManager>;
 export {};

package/dist/plugins/plugin-manager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin-manager.d.ts","sourceRoot":"","sources":["../../src/plugins/plugin-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EACV,kBAAkB,IAAI,0BAA0B,EAChD,sBAAsB,EACtB,aAAa,EACd,MAAM,6BAA6B,CAAA;AAEpC,MAAM,MAAM,kBAAkB,GAAG,0BAA0B,CAAA;AAE3D,KAAK,yBAAyB,GAAG;IAC/B,OAAO,CAAC,EAAE,kBAAkB,EAAE,CAAA;CAC/B,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,aAAkB,yBAAyB;IAU3E;;OAEG;uCACgC,KAAK,MAAM,EAAE,KAAG,sBAAsB,EAAE;IAc3E;;OAEG;kCAC2B,aAAa,KAAG,aAAa,EAAE;IAa7D;;OAEG;yBACkB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAG,IAAI;IAMnD;;OAEG;iCAC0B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAG,IAAI;IAM3D;;OAEG;yBACgB,IAAI;IAMvB;;OAEG;+BACsB,YAAY,EAAE;CAY1C,CAAA;AAED,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAA"}
+{"version":3,"file":"plugin-manager.d.ts","sourceRoot":"","sources":["../../src/plugins/plugin-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EACV,kBAAkB,IAAI,0BAA0B,EAChD,sBAAsB,EACtB,aAAa,EACd,MAAM,6BAA6B,CAAA;AAEpC,MAAM,MAAM,kBAAkB,GAAG,0BAA0B,CAAA;AAE3D,KAAK,yBAAyB,GAAG;IAC/B,OAAO,CAAC,EAAE,kBAAkB,EAAE,CAAA;CAC/B,CAAA;AAED,8EAA8E;AAC9E,QAAA,MAAM,iBAAiB,2CAA4C,CAAA;AAEnE,KAAK,cAAc,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAA;AAExD,gGAAgG;AAChG,MAAM,MAAM,mBAAmB,GAAG,aAAa,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAA;AAEhE,mDAAmD;AACnD,KAAK,kBAAkB,GAAG;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,cAAc,CAAA;CACzB,CAAA;AAgBD;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,aAAkB,yBAAyB;IAU3E;;OAEG;uCACgC,KAAK,MAAM,EAAE,KAAG,sBAAsB,EAAE;IAc3E;;;;;;OAMG;kCAC2B,cAAc,gBAAgB,MAAM,KAAG,mBAAmB,EAAE;IAe1F;;OAEG;yBACkB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAG,IAAI;IAMnD;;OAEG;iCAC0B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAG,IAAI;IAM3D;;OAEG;yBACgB,IAAI;IAMvB;;OAEG;+BACsB,YAAY,EAAE;IAYvC;;;;;;OAMG;sCAC+B,MAAM,KAAG,kBAAkB,EAAE;CAqBlE,CAAA;AAED,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAA"}

package/dist/plugins/plugin-manager.js

@@ -1,4 +1,18 @@
 //#region src/plugins/plugin-manager.ts
+/** Plugin view slots that can render custom components in the content area */
+var PLUGIN_VIEW_NAMES = ["content.start", "content.end"];
+/**
+* Build a stable, unique id for a plugin view component.
+*
+* The same id is used as the DOM element id (so scroll navigation can find it) and as the
+* sidebar navigation entry id (so clicking it scrolls to the element). Keeping both in sync
+* is what lets plugin views participate in the existing scroll-spy and navigation logic.
+*
+* The id is prefixed with the document slug so it matches the navigation id convention. That is
+* what lets URL deep-linking work: `getIdFromUrl` re-prepends the document slug on initial load,
+* so a hash like `plugin-view/<plugin>/<view>/<index>` resolves back to this exact id.
+*/
+var getPluginViewId = (documentSlug, pluginName, viewName, index) => `${documentSlug}/plugin-view/${pluginName}/${viewName}/${index}`;
 /**
 * Create the plugin manager store
 *
@@ -16,11 +30,16 @@ var createPluginManager = ({ plugins = [] }) => {
 			for (const plugin of registeredPlugins.values()) for (const extension of plugin.extensions) if (extension.name === name) extensions.push(extension);
 			return extensions;
 		},
-		getViewComponents: (viewName) => {
+		getViewComponents: (viewName, documentSlug) => {
 			const components = [];
 			for (const plugin of registeredPlugins.values()) {
 				const viewComponents = plugin.views?.[viewName];
-				if (viewComponents) components.push(...viewComponents);
+				if (viewComponents) viewComponents.forEach((component, index) => {
+					components.push({
+						...component,
+						id: getPluginViewId(documentSlug, plugin.name, viewName, index)
+					});
+				});
 			}
 			return components;
 		},
@@ -37,6 +56,17 @@ var createPluginManager = ({ plugins = [] }) => {
 			const apiClientPlugins = [];
 			for (const plugin of registeredPlugins.values()) if (plugin.apiClientPlugins) apiClientPlugins.push(...plugin.apiClientPlugins);
 			return apiClientPlugins;
+		},
+		getSidebarEntries: (documentSlug) => {
+			const entries = [];
+			for (const plugin of registeredPlugins.values()) for (const viewName of PLUGIN_VIEW_NAMES) (plugin.views?.[viewName])?.forEach((component, index) => {
+				if (component.sidebar?.show && component.sidebar.label) entries.push({
+					id: getPluginViewId(documentSlug, plugin.name, viewName, index),
+					label: component.sidebar.label,
+					viewName
+				});
+			});
+			return entries;
 		}
 	};
 };

package/dist/plugins/plugin-manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin-manager.js","names":[],"sources":["../../src/plugins/plugin-manager.ts"],"sourcesContent":["import type { ClientPlugin } from '@scalar/oas-utils/helpers'\nimport type {\n  ApiReferencePlugin as OriginalApiReferencePlugin,\n  SpecificationExtension,\n  ViewComponent,\n} from '@scalar/types/api-reference'\n\nexport type ApiReferencePlugin = OriginalApiReferencePlugin\n\ntype CreatePluginManagerParams = {\n  plugins?: ApiReferencePlugin[]\n}\n\n/**\n * Create the plugin manager store\n *\n * This store manages all plugins registered with the API client\n */\nexport const createPluginManager = ({ plugins = [] }: CreatePluginManagerParams) => {\n  const registeredPlugins = new Map<string, ReturnType<ApiReferencePlugin>>()\n\n  // Register initial plugins\n  plugins.forEach((plugin) => {\n    const pluginInstance = plugin()\n    registeredPlugins.set(pluginInstance.name, pluginInstance)\n  })\n\n  return {\n    /**\n     * Get all extensions with the given name from registered plugins\n     */\n    getSpecificationExtensions: (name: `x-${string}`): SpecificationExtension[] => {\n      const extensions: SpecificationExtension[] = []\n\n      for (const plugin of registeredPlugins.values()) {\n        for (const extension of plugin.extensions) {\n          if (extension.name === name) {\n            extensions.push(extension)\n          }\n        }\n      }\n\n      return extensions\n    },\n\n    /**\n     * Get all components for a specific view from registered plugins\n     */\n    getViewComponents: (viewName: 'content.end'): ViewComponent[] => {\n      const components: ViewComponent[] = []\n\n      for (const plugin of registeredPlugins.values()) {\n        const viewComponents = plugin.views?.[viewName]\n        if (viewComponents) {\n          components.push(...viewComponents)\n        }\n      }\n\n      return components\n    },\n\n    /**\n     * Notify all plugins that the API Reference has been initialized\n     */\n    notifyInit: (config: Record<string, unknown>): void => {\n      for (const plugin of registeredPlugins.values()) {\n        plugin.hooks?.onInit?.({ config })\n      }\n    },\n\n    /**\n     * Notify all plugins that the configuration has changed\n     */\n    notifyConfigChange: (config: Record<string, unknown>): void => {\n      for (const plugin of registeredPlugins.values()) {\n        plugin.hooks?.onConfigChange?.({ config })\n      }\n    },\n\n    /**\n     * Notify all plugins that the API Reference is being destroyed\n     */\n    notifyDestroy: (): void => {\n      for (const plugin of registeredPlugins.values()) {\n        plugin.hooks?.onDestroy?.()\n      }\n    },\n\n    /**\n     * Get all client plugins provided by registered plugins\n     */\n    getApiClientPlugins: (): ClientPlugin[] => {\n      const apiClientPlugins: ClientPlugin[] = []\n\n      for (const plugin of registeredPlugins.values()) {\n        if (plugin.apiClientPlugins) {\n          apiClientPlugins.push(...(plugin.apiClientPlugins as ClientPlugin[]))\n        }\n      }\n\n      return apiClientPlugins\n    },\n  }\n}\n\nexport type PluginManager = ReturnType<typeof createPluginManager>\n"],"mappings":";;;;;;AAkBA,IAAa,uBAAuB,EAAE,UAAU,EAAE,OAAkC;CAClF,MAAM,oCAAoB,IAAI,KAA6C;AAG3E,SAAQ,SAAS,WAAW;EAC1B,MAAM,iBAAiB,QAAQ;AAC/B,oBAAkB,IAAI,eAAe,MAAM,eAAe;GAC1D;AAEF,QAAO;EAIL,6BAA6B,SAAkD;GAC7E,MAAM,aAAuC,EAAE;AAE/C,QAAK,MAAM,UAAU,kBAAkB,QAAQ,CAC7C,MAAK,MAAM,aAAa,OAAO,WAC7B,KAAI,UAAU,SAAS,KACrB,YAAW,KAAK,UAAU;AAKhC,UAAO;;EAMT,oBAAoB,aAA6C;GAC/D,MAAM,aAA8B,EAAE;AAEtC,QAAK,MAAM,UAAU,kBAAkB,QAAQ,EAAE;IAC/C,MAAM,iBAAiB,OAAO,QAAQ;AACtC,QAAI,eACF,YAAW,KAAK,GAAG,eAAe;;AAItC,UAAO;;EAMT,aAAa,WAA0C;AACrD,QAAK,MAAM,UAAU,kBAAkB,QAAQ,CAC7C,QAAO,OAAO,SAAS,EAAE,QAAQ,CAAC;;EAOtC,qBAAqB,WAA0C;AAC7D,QAAK,MAAM,UAAU,kBAAkB,QAAQ,CAC7C,QAAO,OAAO,iBAAiB,EAAE,QAAQ,CAAC;;EAO9C,qBAA2B;AACzB,QAAK,MAAM,UAAU,kBAAkB,QAAQ,CAC7C,QAAO,OAAO,aAAa;;EAO/B,2BAA2C;GACzC,MAAM,mBAAmC,EAAE;AAE3C,QAAK,MAAM,UAAU,kBAAkB,QAAQ,CAC7C,KAAI,OAAO,iBACT,kBAAiB,KAAK,GAAI,OAAO,iBAAoC;AAIzE,UAAO;;EAEV"}
+{"version":3,"file":"plugin-manager.js","names":[],"sources":["../../src/plugins/plugin-manager.ts"],"sourcesContent":["import type { ClientPlugin } from '@scalar/oas-utils/helpers'\nimport type {\n  ApiReferencePlugin as OriginalApiReferencePlugin,\n  SpecificationExtension,\n  ViewComponent,\n} from '@scalar/types/api-reference'\n\nexport type ApiReferencePlugin = OriginalApiReferencePlugin\n\ntype CreatePluginManagerParams = {\n  plugins?: ApiReferencePlugin[]\n}\n\n/** Plugin view slots that can render custom components in the content area */\nconst PLUGIN_VIEW_NAMES = ['content.start', 'content.end'] as const\n\ntype PluginViewName = (typeof PLUGIN_VIEW_NAMES)[number]\n\n/** A plugin view component paired with the stable id used for the DOM and sidebar navigation */\nexport type PluginViewComponent = ViewComponent & { id: string }\n\n/** A sidebar entry contributed by a plugin view */\ntype PluginSidebarEntry = {\n  id: string\n  label: string\n  viewName: PluginViewName\n}\n\n/**\n * Build a stable, unique id for a plugin view component.\n *\n * The same id is used as the DOM element id (so scroll navigation can find it) and as the\n * sidebar navigation entry id (so clicking it scrolls to the element). Keeping both in sync\n * is what lets plugin views participate in the existing scroll-spy and navigation logic.\n *\n * The id is prefixed with the document slug so it matches the navigation id convention. That is\n * what lets URL deep-linking work: `getIdFromUrl` re-prepends the document slug on initial load,\n * so a hash like `plugin-view/<plugin>/<view>/<index>` resolves back to this exact id.\n */\nconst getPluginViewId = (documentSlug: string, pluginName: string, viewName: PluginViewName, index: number): string =>\n  `${documentSlug}/plugin-view/${pluginName}/${viewName}/${index}`\n\n/**\n * Create the plugin manager store\n *\n * This store manages all plugins registered with the API client\n */\nexport const createPluginManager = ({ plugins = [] }: CreatePluginManagerParams) => {\n  const registeredPlugins = new Map<string, ReturnType<ApiReferencePlugin>>()\n\n  // Register initial plugins\n  plugins.forEach((plugin) => {\n    const pluginInstance = plugin()\n    registeredPlugins.set(pluginInstance.name, pluginInstance)\n  })\n\n  return {\n    /**\n     * Get all extensions with the given name from registered plugins\n     */\n    getSpecificationExtensions: (name: `x-${string}`): SpecificationExtension[] => {\n      const extensions: SpecificationExtension[] = []\n\n      for (const plugin of registeredPlugins.values()) {\n        for (const extension of plugin.extensions) {\n          if (extension.name === name) {\n            extensions.push(extension)\n          }\n        }\n      }\n\n      return extensions\n    },\n\n    /**\n     * Get all components for a specific view from registered plugins.\n     *\n     * Each component carries a stable `id` (scoped to the active document slug) so the rendered\n     * DOM element and the sidebar entry (see `getSidebarEntries`) share the same id and stay in\n     * sync for scroll navigation and deep-linking.\n     */\n    getViewComponents: (viewName: PluginViewName, documentSlug: string): PluginViewComponent[] => {\n      const components: PluginViewComponent[] = []\n\n      for (const plugin of registeredPlugins.values()) {\n        const viewComponents = plugin.views?.[viewName]\n        if (viewComponents) {\n          viewComponents.forEach((component: ViewComponent, index: number) => {\n            components.push({ ...component, id: getPluginViewId(documentSlug, plugin.name, viewName, index) })\n          })\n        }\n      }\n\n      return components\n    },\n\n    /**\n     * Notify all plugins that the API Reference has been initialized\n     */\n    notifyInit: (config: Record<string, unknown>): void => {\n      for (const plugin of registeredPlugins.values()) {\n        plugin.hooks?.onInit?.({ config })\n      }\n    },\n\n    /**\n     * Notify all plugins that the configuration has changed\n     */\n    notifyConfigChange: (config: Record<string, unknown>): void => {\n      for (const plugin of registeredPlugins.values()) {\n        plugin.hooks?.onConfigChange?.({ config })\n      }\n    },\n\n    /**\n     * Notify all plugins that the API Reference is being destroyed\n     */\n    notifyDestroy: (): void => {\n      for (const plugin of registeredPlugins.values()) {\n        plugin.hooks?.onDestroy?.()\n      }\n    },\n\n    /**\n     * Get all client plugins provided by registered plugins\n     */\n    getApiClientPlugins: (): ClientPlugin[] => {\n      const apiClientPlugins: ClientPlugin[] = []\n\n      for (const plugin of registeredPlugins.values()) {\n        if (plugin.apiClientPlugins) {\n          apiClientPlugins.push(...(plugin.apiClientPlugins as ClientPlugin[]))\n        }\n      }\n\n      return apiClientPlugins\n    },\n\n    /**\n     * Get all sidebar entries contributed by plugin views.\n     *\n     * Only views that opt in via `sidebar.show` are returned. Each entry's `id` matches the\n     * id of the rendered component (see `getViewComponents`), so the API Reference can add it\n     * to the sidebar navigation and scrolling/active-tracking work out of the box.\n     */\n    getSidebarEntries: (documentSlug: string): PluginSidebarEntry[] => {\n      const entries: PluginSidebarEntry[] = []\n\n      for (const plugin of registeredPlugins.values()) {\n        for (const viewName of PLUGIN_VIEW_NAMES) {\n          const viewComponents = plugin.views?.[viewName]\n          viewComponents?.forEach((component: ViewComponent, index: number) => {\n            if (component.sidebar?.show && component.sidebar.label) {\n              entries.push({\n                id: getPluginViewId(documentSlug, plugin.name, viewName, index),\n                label: component.sidebar.label,\n                viewName,\n              })\n            }\n          })\n        }\n      }\n\n      return entries\n    },\n  }\n}\n\nexport type PluginManager = ReturnType<typeof createPluginManager>\n"],"mappings":";;AAcA,IAAM,oBAAoB,CAAC,iBAAiB,cAAc;;;;;;;;;;;;AAyB1D,IAAM,mBAAmB,cAAsB,YAAoB,UAA0B,UAC3F,GAAG,aAAa,eAAe,WAAW,GAAG,SAAS,GAAG;;;;;;AAO3D,IAAa,uBAAuB,EAAE,UAAU,EAAE,OAAkC;CAClF,MAAM,oCAAoB,IAAI,KAA6C;AAG3E,SAAQ,SAAS,WAAW;EAC1B,MAAM,iBAAiB,QAAQ;AAC/B,oBAAkB,IAAI,eAAe,MAAM,eAAe;GAC1D;AAEF,QAAO;EAIL,6BAA6B,SAAkD;GAC7E,MAAM,aAAuC,EAAE;AAE/C,QAAK,MAAM,UAAU,kBAAkB,QAAQ,CAC7C,MAAK,MAAM,aAAa,OAAO,WAC7B,KAAI,UAAU,SAAS,KACrB,YAAW,KAAK,UAAU;AAKhC,UAAO;;EAUT,oBAAoB,UAA0B,iBAAgD;GAC5F,MAAM,aAAoC,EAAE;AAE5C,QAAK,MAAM,UAAU,kBAAkB,QAAQ,EAAE;IAC/C,MAAM,iBAAiB,OAAO,QAAQ;AACtC,QAAI,eACF,gBAAe,SAAS,WAA0B,UAAkB;AAClE,gBAAW,KAAK;MAAE,GAAG;MAAW,IAAI,gBAAgB,cAAc,OAAO,MAAM,UAAU,MAAM;MAAE,CAAC;MAClG;;AAIN,UAAO;;EAMT,aAAa,WAA0C;AACrD,QAAK,MAAM,UAAU,kBAAkB,QAAQ,CAC7C,QAAO,OAAO,SAAS,EAAE,QAAQ,CAAC;;EAOtC,qBAAqB,WAA0C;AAC7D,QAAK,MAAM,UAAU,kBAAkB,QAAQ,CAC7C,QAAO,OAAO,iBAAiB,EAAE,QAAQ,CAAC;;EAO9C,qBAA2B;AACzB,QAAK,MAAM,UAAU,kBAAkB,QAAQ,CAC7C,QAAO,OAAO,aAAa;;EAO/B,2BAA2C;GACzC,MAAM,mBAAmC,EAAE;AAE3C,QAAK,MAAM,UAAU,kBAAkB,QAAQ,CAC7C,KAAI,OAAO,iBACT,kBAAiB,KAAK,GAAI,OAAO,iBAAoC;AAIzE,UAAO;;EAUT,oBAAoB,iBAA+C;GACjE,MAAM,UAAgC,EAAE;AAExC,QAAK,MAAM,UAAU,kBAAkB,QAAQ,CAC7C,MAAK,MAAM,YAAY,kBAErB,EADuB,OAAO,QAAQ,YACtB,SAAS,WAA0B,UAAkB;AACnE,QAAI,UAAU,SAAS,QAAQ,UAAU,QAAQ,MAC/C,SAAQ,KAAK;KACX,IAAI,gBAAgB,cAAc,OAAO,MAAM,UAAU,MAAM;KAC/D,OAAO,UAAU,QAAQ;KACzB;KACD,CAAC;KAEJ;AAIN,UAAO;;EAEV"}