@scalar/api-reference 1.25.80 → 1.25.82

package/dist/helpers/getExampleCode.js

@@ -1,35 +1,16 @@
 import { snippetz as i } from "@scalar/snippetz";
-import { HTTPSnippet as c } from "httpsnippet-lite";
-import { convertRequestToHarRequest as l } from "./convertRequestToHarRequest.js";
-async function h(t, e, r) {
-  const p = await l(t), s = e;
-  if (i().hasPlugin(s, r))
-    return i().print(
-      e,
-      r,
-      // TODO: We shouldn’t cast the type here.
-      // Luckily, the difference between those two types is tiny. We’ll get rid of this compatibility issue soon.
-      p
-    );
-  if (t.url.startsWith("__"))
-    return t.url;
-  try {
-    const o = e == null ? void 0 : e.replace(
-      "js",
-      "javascript"
-    ), a = r, n = await new c(p).convert(
-      o,
-      a
-    );
-    if (typeof n == "string") return n;
-  } catch (o) {
-    console.error(
-      "[getExampleCode] Failed to generate example code with httpsnippet-lite:",
-      o
-    );
-  }
-  return "";
+import { convertRequestToHarRequest as p } from "./convertRequestToHarRequest.js";
+async function u(r, n, t) {
+  const o = await p(r), e = n == null ? void 0 : n.replace(
+    "javascript",
+    "js"
+  );
+  return i().hasPlugin(e, t) ? i().print(
+    e,
+    t,
+    o
+  ) : r.url.startsWith("__") ? r.url : "";
 }
 export {
-  h as getExampleCode
+  u as getExampleCode
 };

package/dist/hooks/useNavState.d.ts

@@ -9,6 +9,28 @@ import type { PathRouting } from '../types';
  */
 export declare const useNavState: () => {
     hash: import("vue").Ref<string, string>;
+    /** Sets the prefix for the hash */
+    setHashPrefix: (prefix: string) => void;
+    /**
+     * Gets the full hash with the prefix
+     * @param hashTarget The hash to target with the return
+     * @returns The full hash
+     */
+    getFullHash: (hashTarget?: string) => string;
+    /**
+     * Gets the hashed url with the prefix
+     * @param replacementHash The hash to replace the current hash with
+     * @param url The url to get the hashed url from
+     * @returns The hashed url
+     */
+    getHashedUrl: (replacementHash: string, url?: string, search?: string) => string;
+    /**
+     * Replaces the URL state with the new url and hash
+     * Replacement is used so that hash changes don't trigger the url hash watcher and cause a scroll
+     */
+    replaceUrlState: (replacementHash: string, url?: string) => void;
+    /** Gets the portion of the hash used by the references */
+    getReferenceHash: () => string;
     getWebhookId: (name?: string, httpVerb?: string) => string;
     getModelId: (name?: string) => string;
     getHeadingId: (heading: Heading) => string;

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

@@ -1 +1 @@
-{"version":3,"file":"useNavState.d.ts","sourceRoot":"","sources":["../../src/hooks/useNavState.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAI9E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AA2E3C;;;;;;GAMG;AACH,eAAO,MAAM,WAAW;;0BArDK,MAAM,aAAa,MAAM;wBAU3B,MAAM;4BAzBF,OAAO;gCAmCH,oBAAoB,aAAa,GAAG;iCA3BnC,MAAM;;yBA8Bd,GAAG;;;;CA0C7B,CAAA"}
+{"version":3,"file":"useNavState.d.ts","sourceRoot":"","sources":["../../src/hooks/useNavState.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAI9E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAsH3C;;;;;;GAMG;AACH,eAAO,MAAM,WAAW;;IAEtB,mCAAmC;4BACX,MAAM;IAG9B;;;;OAIG;+BAhC4B,MAAM;IAkCrC;;;;;OAKG;oCAjDc,MAAM;IAmDvB;;;OAGG;uCA3Ec,MAAM;IA6EvB,0DAA0D;;0BAtH/B,MAAM,aAAa,MAAM;wBAQ3B,MAAM;4BAvBF,OAAO;gCA+BH,oBAAoB,aAAa,GAAG;iCAvBnC,MAAM;;yBA0Bd,GAAG;;;;CA+G7B,CAAA"}

package/dist/hooks/useNavState.js

@@ -1,43 +1,66 @@
-import { ssrState as g } from "@scalar/oas-utils/helpers";
+import { ssrState as d } from "@scalar/oas-utils/helpers";
 import { slug as c } from "github-slugger";
-import { ref as d } from "vue";
-const r = d(g.hash ?? ""), n = d(), i = d(!1), h = (e) => e.slug ? `description/${e.slug}` : "", u = (e) => {
-  var t;
+import { ref as l } from "vue";
+import { joinWithSlash as g } from "../helpers/joinWithSlash.js";
+const a = l(""), r = l(d.hash ?? ""), n = l(), w = l(!1), p = (e) => e.slug ? `description/${e.slug}` : "", h = (e) => {
+  var o;
   if (!n.value) return "";
-  const o = new RegExp("^" + ((t = n.value) == null ? void 0 : t.basePath) + "/?");
-  return decodeURIComponent(e.replace(o, ""));
-}, p = (e, o) => {
-  if (!e)
-    return "webhooks";
-  const t = c(e), s = encodeURIComponent(t);
-  return `webhook/${o}/${s}`;
-}, m = (e) => {
-  if (!e)
-    return "models";
-  const o = c(e);
-  return `model/${encodeURIComponent(o)}`;
-}, I = (e, o) => `${l(o)}/${e.httpVerb}${e.path}`, l = ({ name: e }) => {
-  const o = c(e);
-  return `tag/${encodeURIComponent(o)}`;
-}, w = (e = r.value) => {
-  var a;
-  const o = (a = e.match(/(tag\/[^/]+)/)) == null ? void 0 : a[0], t = e.startsWith("model") ? "models" : "", s = e.startsWith("webhook") ? "webhooks" : "";
-  return o || t || s;
+  const t = new RegExp("^" + ((o = n.value) == null ? void 0 : o.basePath) + "/?");
+  return decodeURIComponent(e.replace(t, ""));
+}, f = (e, t) => e ? `webhook/${t}/${c(e)}` : "webhooks", v = (e) => e ? `model/${c(e)}` : "models", m = (e, t) => `${u(t)}/${e.httpVerb}${e.path}`, u = ({ name: e }) => `tag/${c(e)}`, I = (e = r.value) => {
+  var i;
+  const t = (i = e.match(/(tag\/[^/]+)/)) == null ? void 0 : i[0], o = e.startsWith("model") ? "models" : "", s = e.startsWith("webhook") ? "webhooks" : "";
+  return t || o || s;
 }, b = () => {
-  r.value = n.value ? u(window.location.pathname) : decodeURIComponent(window.location.hash.replace(/^#/, ""));
-}, $ = () => ({
+  r.value = n.value ? h(window.location.pathname) : (
+    // Must remove the prefix from the hash as the internal hash value should be pure
+    window.location.hash.replace(/^#/, "").slice(a.value.length)
+  );
+}, $ = (e, t = window.location.href) => {
+  const o = new URL(t);
+  n.value ? o.pathname = g(n.value.basePath, e) : o.hash = a.value + e, r.value = e, window.history.replaceState({}, "", o);
+}, R = (e, t = window.location.href, o = window.location.search) => {
+  const s = new URL(t);
+  return s.hash = a.value + e, s.search = o, s.toString();
+}, U = (e = r.value) => `${a.value}${e}`, k = () => decodeURIComponent(
+  window.location.hash.replace(/^#/, "").slice(a.value.length)
+), W = () => ({
   hash: r,
-  getWebhookId: p,
-  getModelId: m,
-  getHeadingId: h,
-  getOperationId: I,
-  getPathRoutingId: u,
-  getSectionId: w,
-  getTagId: l,
-  isIntersectionEnabled: i,
+  /** Sets the prefix for the hash */
+  setHashPrefix: (e) => {
+    a.value = e;
+  },
+  /**
+   * Gets the full hash with the prefix
+   * @param hashTarget The hash to target with the return
+   * @returns The full hash
+   */
+  getFullHash: U,
+  /**
+   * Gets the hashed url with the prefix
+   * @param replacementHash The hash to replace the current hash with
+   * @param url The url to get the hashed url from
+   * @returns The hashed url
+   */
+  getHashedUrl: R,
+  /**
+   * Replaces the URL state with the new url and hash
+   * Replacement is used so that hash changes don't trigger the url hash watcher and cause a scroll
+   */
+  replaceUrlState: $,
+  /** Gets the portion of the hash used by the references */
+  getReferenceHash: k,
+  getWebhookId: f,
+  getModelId: v,
+  getHeadingId: p,
+  getOperationId: m,
+  getPathRoutingId: h,
+  getSectionId: I,
+  getTagId: u,
+  isIntersectionEnabled: w,
   pathRouting: n,
   updateHash: b
 });
 export {
-  $ as useNavState
+  W as useNavState
 };