@scalar/api-reference 1.44.2 → 1.44.4

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
+};