@scalar/api-reference 1.44.3 → 1.44.6

package/dist/components/Content/Schema/helpers/get-schema-type.js

@@ -47,8 +47,14 @@ const getSchemaType = (valueOrRef) => {
   if ("type" in value && value.type && value.contentEncoding) {
     return `${value.type} • ${value.contentEncoding}`;
   }
+  if ("originalRef" in valueOrRef && valueOrRef.originalRef) {
+    const refName = getRefName(valueOrRef.originalRef);
+    if (refName) {
+      return refName;
+    }
+  }
   if ("$ref" in valueOrRef) {
-    const refName = getRefName(valueOrRef);
+    const refName = getRefName(valueOrRef.$ref);
     if (refName) {
       return refName;
     }

package/dist/components/Content/Schema/helpers/optimize-value-for-display.d.ts

@@ -1,8 +1,12 @@
 import type { SchemaObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
+/** We need to keep the original ref after we resolve for display purposes */
+export type SchemaWithOriginalRef = SchemaObject & {
+    originalRef?: string;
+};
 /**
  * Optimize the value by removing nulls from compositions and merging root properties.
  *
  * TODO: figure out what this does
  */
-export declare function optimizeValueForDisplay(value: SchemaObject | undefined): SchemaObject | undefined;
+export declare function optimizeValueForDisplay(value: SchemaObject | undefined): SchemaWithOriginalRef | undefined;
 //# sourceMappingURL=optimize-value-for-display.d.ts.map

package/dist/components/Content/Schema/helpers/optimize-value-for-display.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"optimize-value-for-display.d.ts","sourceRoot":"","sources":["../../../../../src/components/Content/Schema/helpers/optimize-value-for-display.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8DAA8D,CAAA;AAIhG;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,YAAY,GAAG,SAAS,GAAG,YAAY,GAAG,SAAS,CAsFjG"}
+{"version":3,"file":"optimize-value-for-display.d.ts","sourceRoot":"","sources":["../../../../../src/components/Content/Schema/helpers/optimize-value-for-display.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8DAA8D,CAAA;AAIhG,6EAA6E;AAC7E,MAAM,MAAM,qBAAqB,GAAG,YAAY,GAAG;IAAE,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA;AAE3E;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,YAAY,GAAG,SAAS,GAAG,qBAAqB,GAAG,SAAS,CA0F1G"}

package/dist/components/Content/Schema/helpers/optimize-value-for-display.js

@@ -19,6 +19,8 @@ function optimizeValueForDisplay(value) {
       const schema = getResolvedRef(_schema);
       if ("type" in schema && schema.type === "null") {
         acc.hasNullSchema = true;
+      } else if ("$ref" in _schema && _schema.$ref) {
+        acc.filteredSchemas.push({ ...schema, originalRef: _schema.$ref });
       } else {
         acc.filteredSchemas.push(schema);
       }

package/dist/components/Content/Schema/helpers/schema-name.js

@@ -6,7 +6,7 @@ const getModelNameFromSchema = (schemaOrRef) => {
     return null;
   }
   if ("$ref" in schemaOrRef) {
-    const refName = getRefName(schemaOrRef);
+    const refName = getRefName(schemaOrRef.$ref);
     if (refName) {
       return refName;
     }

package/dist/components/MobileHeader.vue.js

@@ -20,7 +20,7 @@ const _sfc_main = /* @__PURE__ */ defineComponent({
     const emit = __emit;
     const { mediaQueries } = useBreakpoints();
     const variants = cva({
-      base: "items-center bg-b-1 sticky top-(--scalar-custom-header-height) z-10",
+      base: "items-center bg-b-1 sticky top-(--scalar-custom-header-height,0) z-10",
       variants: {
         open: {
           true: "h-(--refs-sidebar-height) custom-scrollbar flex flex-col"
@@ -32,7 +32,7 @@ const _sfc_main = /* @__PURE__ */ defineComponent({
     });
     return (_ctx, _cache) => {
       return unref(mediaQueries).lg.value ? renderSlot(_ctx.$slots, "sidebar", normalizeProps(mergeProps({ key: 0 }, {
-        sidebarClasses: "sticky top-(--refs-header-height) h-(--refs-sidebar-height) [grid-area:navigation]"
+        sidebarClasses: "sticky top-(--refs-header-height) h-(--refs-sidebar-height) w-(--refs-sidebar-width) [grid-area:navigation]"
       }))) : (openBlock(), createElementBlock("div", {
         key: 1,
         class: normalizeClass(["t-doc__header", unref(variants)({ open: __props.isSidebarOpen, lg: unref(mediaQueries).lg.value })])

package/dist/features/Operation/layouts/ModernLayout.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ModernLayout.vue.d.ts","sourceRoot":"","sources":["../../../../src/features/Operation/layouts/ModernLayout.vue"],"names":[],"mappings":"AAyPA,OAAO,KAAK,EACV,eAAe,EACf,oBAAoB,EACpB,YAAY,EACb,MAAM,8DAA8D,CAAA;AAoBrE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAA;AAMxE,KAAK,WAAW,GAAG,IAAI,CACnB,cAAc,EACd,UAAU,GAAG,WAAW,GAAG,QAAQ,GAAG,aAAa,GAAG,iBAAiB,CACxE,GAAG;IACF,wCAAwC;IACxC,SAAS,EAAE,eAAe,CAAA;IAC1B,4CAA4C;IAC5C,cAAc,EAAE,YAAY,GAAG,IAAI,CAAA;IACnC,sDAAsD;IACtD,uBAAuB,EAAE,oBAAoB,EAAE,CAAA;CAChD,CAAC;;AAufJ,wBAMG"}
+{"version":3,"file":"ModernLayout.vue.d.ts","sourceRoot":"","sources":["../../../../src/features/Operation/layouts/ModernLayout.vue"],"names":[],"mappings":"AA2PA,OAAO,KAAK,EACV,eAAe,EACf,oBAAoB,EACpB,YAAY,EACb,MAAM,8DAA8D,CAAA;AAqBrE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAA;AAMxE,KAAK,WAAW,GAAG,IAAI,CACnB,cAAc,EACd,UAAU,GAAG,WAAW,GAAG,QAAQ,GAAG,aAAa,GAAG,iBAAiB,CACxE,GAAG;IACF,wCAAwC;IACxC,SAAS,EAAE,eAAe,CAAA;IAC1B,4CAA4C;IAC5C,cAAc,EAAE,YAAY,GAAG,IAAI,CAAA;IACnC,sDAAsD;IACtD,uBAAuB,EAAE,oBAAoB,EAAE,CAAA;CAChD,CAAC;;AA8fJ,wBAMG"}

package/dist/features/Operation/layouts/ModernLayout.vue.js

@@ -1,7 +1,7 @@
 import _sfc_main from "./ModernLayout.vue2.js";
 /* empty css                  */
 import _export_sfc from "../../../_virtual/_plugin-vue_export-helper.js";
-const ModernLayout = /* @__PURE__ */ _export_sfc(_sfc_main, [["__scopeId", "data-v-a158242e"]]);
+const ModernLayout = /* @__PURE__ */ _export_sfc(_sfc_main, [["__scopeId", "data-v-e67d0b83"]]);
 export {
   ModernLayout as default
 };

package/dist/features/Operation/layouts/ModernLayout.vue2.js

@@ -5,6 +5,7 @@ import { ScalarIconWebhooksLogo } from "@scalar/icons";
 import { getOperationStability, getOperationStabilityColor, isOperationDeprecated } from "@scalar/oas-utils/helpers";
 import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
 import OperationPath from "../../../components/OperationPath.vue.js";
+import AskAgentButton from "../../ask-agent-button/AskAgentButton.vue.js";
 import _sfc_main$6 from "../components/callbacks/Callbacks.vue.js";
 import _sfc_main$4 from "../components/OperationParameters.vue.js";
 import _sfc_main$5 from "../components/OperationResponses.vue.js";
@@ -205,6 +206,7 @@ const _sfc_main = /* @__PURE__ */ defineComponent({
                               !__props.isWebhook ? {
                                 name: "footer",
                                 fn: withCtx(() => [
+                                  createVNode(AskAgentButton),
                                   !__props.options.hideTestRequestButton ? (openBlock(), createBlock(unref(TestRequestButton), {
                                     key: 0,
                                     id: __props.id,

package/dist/features/ask-agent-button/AskAgentButton.vue.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+export default _default;
+//# sourceMappingURL=AskAgentButton.vue.d.ts.map

package/dist/features/ask-agent-button/AskAgentButton.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AskAgentButton.vue.d.ts","sourceRoot":"","sources":["../../../src/features/ask-agent-button/AskAgentButton.vue"],"names":[],"mappings":";AAiPA,wBAKG"}

package/dist/features/ask-agent-button/AskAgentButton.vue.js

@@ -0,0 +1,7 @@
+import _sfc_main from "./AskAgentButton.vue2.js";
+/* empty css                    */
+import _export_sfc from "../../_virtual/_plugin-vue_export-helper.js";
+const AskAgentButton = /* @__PURE__ */ _export_sfc(_sfc_main, [["__scopeId", "data-v-b5a61e43"]]);
+export {
+  AskAgentButton as default
+};

package/dist/features/ask-agent-button/AskAgentButton.vue2.js

@@ -0,0 +1,47 @@
+import { defineComponent, ref, createElementBlock, createCommentVNode, unref, openBlock, createVNode, withDirectives, createElementVNode, withKeys, withModifiers, vModelText } from "vue";
+import { ScalarIconSparkle, ScalarIconArrowUp } from "@scalar/icons";
+import { useAgentContext } from "../../hooks/use-agent.js";
+const _hoisted_1 = {
+  key: 0,
+  class: "agent-button-container flex"
+};
+const _sfc_main = /* @__PURE__ */ defineComponent({
+  __name: "AskAgentButton",
+  setup(__props) {
+    const agentContext = useAgentContext();
+    const message = ref("");
+    function handleSubmit() {
+      agentContext.value?.openAgent(message.value);
+      message.value = "";
+    }
+    return (_ctx, _cache) => {
+      return unref(agentContext)?.agentEnabled.value ? (openBlock(), createElementBlock("div", _hoisted_1, [
+        createVNode(unref(ScalarIconSparkle), {
+          class: "size-3 shrink-0",
+          weight: "fill"
+        }),
+        withDirectives(createElementVNode("input", {
+          "onUpdate:modelValue": _cache[0] || (_cache[0] = ($event) => message.value = $event),
+          class: "ask-agent-scalar-input",
+          placeholder: "Ask AI Agent",
+          onKeydown: _cache[1] || (_cache[1] = withKeys(withModifiers(($event) => handleSubmit(), ["stop"]), ["enter"]))
+        }, null, 544), [
+          [vModelText, message.value]
+        ]),
+        createElementVNode("button", {
+          class: "ask-agent-scalar-send",
+          type: "button",
+          onClick: _cache[2] || (_cache[2] = ($event) => handleSubmit())
+        }, [
+          createVNode(unref(ScalarIconArrowUp), {
+            class: "size-3",
+            weight: "bold"
+          })
+        ])
+      ])) : createCommentVNode("", true);
+    };
+  }
+});
+export {
+  _sfc_main as default
+};

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":"AAqBA;;;GAGG;AACH,eAAO,MAAM,qBAAqB,qCAAa,CAAA;AAc/C,KAAK,SAAS,GAAG,MAAM,IAAI,CAAA;AAE3B;;;GAGG;AACH,eAAO,MAAM,iBAAiB,QAAO,SAMpC,CAAA;AAED,2EAA2E;AAC3E,eAAO,MAAM,mBAAmB,oCAAkD,CAAA;AA6FlF;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM;;EAUpC;AAED;;;;;;;;;;GAUG;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,SA2D/G,CAAA"}
+{"version":3,"file":"lazy-bus.d.ts","sourceRoot":"","sources":["../../src/helpers/lazy-bus.ts"],"names":[],"mappings":"AAqBA;;;GAGG;AACH,eAAO,MAAM,qBAAqB,qCAAa,CAAA;AAc/C,KAAK,SAAS,GAAG,MAAM,IAAI,CAAA;AAE3B;;;GAGG;AACH,eAAO,MAAM,iBAAiB,QAAO,SAMpC,CAAA;AAED,2EAA2E;AAC3E,eAAO,MAAM,mBAAmB,oCAAkD,CAAA;AAkGlF;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM;;EAUpC;AAED;;;;;;;;;;GAUG;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,SA2D/G,CAAA"}

package/dist/helpers/lazy-bus.js

@@ -29,7 +29,9 @@ const runLazyBus = () => {
     if (pendingQueue.size > 0 || priorityQueue.size > 0) {
       isRunning.value = true;
       for (const id of [...pendingQueue, ...priorityQueue]) {
-        readyQueue.add(id);
+        if (!readyQueue.has(id)) {
+          readyQueue.add(id);
+        }
         pendingQueue.delete(id);
         priorityQueue.delete(id);
       }
@@ -57,12 +59,12 @@ watchDebounced(
   { debounce: 300, maxWait: 1500 }
 );
 const addToPendingQueue = (id) => {
-  if (!!id && !priorityQueue.has(id)) {
+  if (!!id && !readyQueue.has(id) && !priorityQueue.has(id)) {
     pendingQueue.add(id);
   }
 };
 const addToPriorityQueue = (id) => {
-  if (id) {
+  if (id && !priorityQueue.has(id)) {
     priorityQueue.add(id);
   }
 };

package/dist/helpers/storage.d.ts

@@ -31,8 +31,8 @@ export declare const authStorage: () => {
             'x-scalar-secret-token': string;
         } & {
             type: "apiKey";
-            name: string;
             in: "header" | "query" | "cookie";
+            name: string;
         }) | ({
             description?: string | undefined;
         } & {
@@ -181,8 +181,8 @@ export declare const authStorage: () => {
                 'x-scalar-secret-token': string;
             } & {
                 type: "apiKey";
-                name: string;
                 in: "header" | "query" | "cookie";
+                name: string;
             }) | ({
                 description?: string | undefined;
             } & {

package/dist/hooks/index.d.ts

@@ -1,2 +1,3 @@
+export { AGENT_CONTEXT_SYMBOL, useAgent, useAgentContext, } from './use-agent.js';
 export { useIntersection } from './use-intersection.js';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,QAAQ,EACR,eAAe,GAChB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA"}

package/dist/hooks/index.js

@@ -1,4 +1,8 @@
+import { AGENT_CONTEXT_SYMBOL, useAgent, useAgentContext } from "./use-agent.js";
 import { useIntersection } from "./use-intersection.js";
 export {
+  AGENT_CONTEXT_SYMBOL,
+  useAgent,
+  useAgentContext,
   useIntersection
 };

package/dist/hooks/use-agent.d.ts

@@ -0,0 +1,36 @@
+import type { ComputedRef, Ref } from 'vue';
+import { type InjectionKey } from 'vue';
+type UseAgentOptions = {
+    /** Optional. When provided, controls whether the agent UI is enabled (e.g. from doc config). Defaults to isLocalUrl. */
+    agentEnabled?: ComputedRef<boolean>;
+};
+type UseAgentReturn = {
+    showAgent: Ref<boolean>;
+    agentEnabled: ComputedRef<boolean>;
+    /** Ref used to pass a prefill message into the agent when opening. Cleared on close. */
+    prefilledMessage: Ref<string>;
+    openAgent: (message?: string) => void;
+    closeAgent: () => void;
+    toggleAgent: () => void;
+};
+export declare const AGENT_CONTEXT_SYMBOL: InjectionKey<UseAgentReturn>;
+/**
+ * Hook for agent visibility and enabled state.
+ * Call from the API Reference root (e.g. ApiReference.vue) with options to create the state, then provide it so descendants can inject it.
+ *
+ * Returns:
+ * - showAgent: whether the agent panel is visible
+ * - agentEnabled: whether the agent is enabled
+ * - openAgent, closeAgent, toggleAgent: imperative controls
+ */
+export declare function useAgent(options: UseAgentOptions): UseAgentReturn;
+/**
+ * Inject the agent context provided by ApiReference.
+ * Falls back to module-level state when inject is undefined (e.g. async boundary or mount order).
+ * Use in descendant components (e.g. AskAgentButton) to open the agent or check if it is enabled.
+ *
+ * Returns a computed ref; use v-if="agentContext?.agentEnabled" so the button only renders when context exists and agent is enabled.
+ */
+export declare function useAgentContext(): ComputedRef<UseAgentReturn | undefined>;
+export {};
+//# sourceMappingURL=use-agent.d.ts.map

package/dist/hooks/use-agent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-agent.d.ts","sourceRoot":"","sources":["../../src/hooks/use-agent.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AAC3C,OAAO,EAAE,KAAK,YAAY,EAAyB,MAAM,KAAK,CAAA;AAE9D,KAAK,eAAe,GAAG;IACrB,wHAAwH;IACxH,YAAY,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;CACpC,CAAA;AAED,KAAK,cAAc,GAAG;IACpB,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACvB,YAAY,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAClC,wFAAwF;IACxF,gBAAgB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAC7B,SAAS,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;IACrC,UAAU,EAAE,MAAM,IAAI,CAAA;IACtB,WAAW,EAAE,MAAM,IAAI,CAAA;CACxB,CAAA;AAED,eAAO,MAAM,oBAAoB,EAAe,YAAY,CAAC,cAAc,CAAC,CAAA;AAQ5E;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,cAAc,CAiCjE;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,IAAI,WAAW,CAAC,cAAc,GAAG,SAAS,CAAC,CAGzE"}

package/dist/hooks/use-agent.js

@@ -0,0 +1,42 @@
+import { isLocalUrl } from "@scalar/helpers/url/is-local-url";
+import { ref, computed, inject } from "vue";
+const AGENT_CONTEXT_SYMBOL = /* @__PURE__ */ Symbol();
+const agentStateRef = ref(null);
+function useAgent(options) {
+  const showAgent = ref(false);
+  const prefilledMessage = ref("");
+  const agentEnabled = options.agentEnabled ?? computed(() => isLocalUrl(window.location.href));
+  const openAgent = (message) => {
+    prefilledMessage.value = message ?? "";
+    showAgent.value = true;
+  };
+  const closeAgent = () => {
+    showAgent.value = false;
+    prefilledMessage.value = "";
+  };
+  const toggleAgent = () => {
+    showAgent.value = !showAgent.value;
+    if (!showAgent.value) {
+      prefilledMessage.value = "";
+    }
+  };
+  const state = {
+    showAgent,
+    agentEnabled,
+    prefilledMessage,
+    openAgent,
+    closeAgent,
+    toggleAgent
+  };
+  agentStateRef.value = state;
+  return state;
+}
+function useAgentContext() {
+  const injected = inject(AGENT_CONTEXT_SYMBOL, void 0);
+  return computed(() => injected ?? agentStateRef.value ?? void 0);
+}
+export {
+  AGENT_CONTEXT_SYMBOL,
+  useAgent,
+  useAgentContext
+};