@scalar/api-reference 1.35.7 → 1.36.1

package/dist/hooks/useNavState.d.ts

@@ -1,6 +1,5 @@
 import type { ApiReferenceConfiguration } from '@scalar/types/api-reference';
-import type { Heading, OpenAPIV3_1 } from '@scalar/types/legacy';
-import type { OperationObject, TagObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
+import type { Heading } from '@scalar/types/legacy';
 import { type InjectionKey, type Ref } from 'vue';
 export type NavState = {
     /** The URL hash without the #, also the "hash" pulled from pathRouting */
@@ -43,21 +42,8 @@ export declare const useNavState: (_config?: Ref<ApiReferenceConfiguration>) =>
      */
     replaceUrlState: (replacementHash: string, url?: string) => void;
     getReferenceId: () => string;
-    getWebhookId: (webhook?: {
-        name: string;
-        method?: string;
-    }, parentTag?: OpenAPIV3_1.TagObject) => string;
-    getModelId: (model?: {
-        name: string;
-    }, parentTag?: OpenAPIV3_1.TagObject) => string;
     getHeadingId: (heading: Heading) => string;
-    getOperationId: (operation: {
-        path: string;
-        method: OpenAPIV3_1.HttpMethods;
-    } & OperationObject, parentTag: TagObject) => string;
     getPathRoutingId: (pathName: string) => string;
-    getSectionId: (hashStr?: string) => string;
-    getTagId: (tag: OpenAPIV3_1.TagObject) => string;
     isIntersectionEnabled: Ref<boolean, boolean>;
     updateHash: () => string;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"useNavState.d.ts","sourceRoot":"","sources":["../../src/hooks/useNavState.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAC5E,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,8DAA8D,CAAA;AAE9G,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,GAAG,EAAe,MAAM,KAAK,CAAA;AAE9D,MAAM,MAAM,QAAQ,GAAG;IACrB,0EAA0E;IAC1E,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACjB,2CAA2C;IAC3C,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACvB,sFAAsF;IACtF,qBAAqB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;CACpC,CAAA;AACD,eAAO,MAAM,gBAAgB,EAAe,YAAY,CAAC,QAAQ,CAAC,CAAA;AAOlE;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,GAAI,UAAU,GAAG,CAAC,yBAAyB,CAAC;;IAoJhE,mCAAmC;4BACX,MAAM;IAG9B;;;;OAIG;+BAlF4B,MAAM;IAoFrC;;;;;OAKG;oCAxGkC,MAAM;IA0G3C;;;OAGG;uCA/HqC,MAAM;;6BA2FhB;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,cAAc,WAAW,CAAC,SAAS;yBAxCxE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,cAAc,WAAW,CAAC,SAAS;4BAXhD,OAAO;gCAiCzB;QACT,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,WAAW,CAAC,WAAW,CAAA;KAChC,GAAG,eAAe,aACR,SAAS;iCA7Gc,MAAM;;oBAiGnB,WAAW,CAAC,SAAS;;;CA2E7C,CAAA;AAED,mCAAmC;AACnC,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,WAAW,CAAC,CAAA"}
+{"version":3,"file":"useNavState.d.ts","sourceRoot":"","sources":["../../src/hooks/useNavState.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAC5E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AACnD,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,GAAG,EAAe,MAAM,KAAK,CAAA;AAI9D,MAAM,MAAM,QAAQ,GAAG;IACrB,0EAA0E;IAC1E,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACjB,2CAA2C;IAC3C,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACvB,sFAAsF;IACtF,qBAAqB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;CACpC,CAAA;AACD,eAAO,MAAM,gBAAgB,EAAe,YAAY,CAAC,QAAQ,CAAC,CAAA;AAOlE;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,GAAI,UAAU,GAAG,CAAC,yBAAyB,CAAC;;IAqFhE,mCAAmC;4BACX,MAAM;IAG9B;;;;OAIG;+BA5B4B,MAAM;IA8BrC;;;;;OAKG;oCAlDkC,MAAM;IAoD3C;;;OAGG;uCAzEqC,MAAM;;4BAwCjB,OAAO;iCA/DF,MAAM;;;CAwG3C,CAAA;AAED,mCAAmC;AACnC,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,WAAW,CAAC,CAAA"}

package/dist/hooks/useNavState.js

@@ -1,82 +1,58 @@
-import { useConfig as b } from "./useConfig.js";
-import { combineUrlAndPath as h } from "@scalar/helpers/url/merge-urls";
-import { slug as s } from "github-slugger";
-import { inject as R, ref as i } from "vue";
-const k = Symbol(), y = i(!1), P = i(""), U = i(""), M = (d) => {
-  const { isIntersectionEnabled: f, hash: r, hashPrefix: u } = R(k, {
-    isIntersectionEnabled: y,
-    hash: P,
-    hashPrefix: U
-  }), t = d ?? b(), c = (e) => {
+import { combineUrlAndPath as c } from "@scalar/helpers/url/merge-urls";
+import { inject as p, ref as i } from "vue";
+import { useConfig as d } from "./useConfig.js";
+const f = Symbol(), v = i(!1), w = i(""), R = i(""), E = (h) => {
+  const { isIntersectionEnabled: g, hash: s, hashPrefix: a } = p(f, {
+    isIntersectionEnabled: v,
+    hash: w,
+    hashPrefix: R
+  }), t = h ?? d(), l = (e) => {
     if (!t.value.pathRouting)
       return "";
     const n = new RegExp("^" + t.value.pathRouting?.basePath + "/?");
     return decodeURIComponent(e.replace(n, ""));
-  }, p = (e = r.value) => {
-    const n = e.match(/(tag\/[^/]+)/)?.[0], o = e.startsWith("model") ? "models" : "", a = e.startsWith("webhook") ? "webhooks" : "";
-    return n || o || a;
-  }, g = () => t.value.pathRouting ? c(window.location.pathname) : (
+  }, u = () => t.value.pathRouting ? l(window.location.pathname) : (
     // Must remove the prefix from the hash as the internal hash value should be pure
-    decodeURIComponent(window.location.hash.replace(/^#/, "")).slice(u.value.length)
-  ), m = () => r.value = g(), v = (e, n = window.location.href) => {
-    const o = new URL(n);
-    t.value.pathRouting ? o.pathname = h(t.value.pathRouting.basePath, e) : o.hash = u.value + e, r.value = e, window.history.replaceState({}, "", o);
-  }, $ = (e, n = window.location.href, o = window.location.search) => {
-    const a = new URL(n);
-    return t.value.pathRouting ? a.pathname = h(t.value.pathRouting.basePath, e) : a.hash = u.value + e, a.search = o, a.toString();
-  }, w = (e = r.value) => `${u.value}${e}`, I = (e) => typeof t.value.generateHeadingSlug == "function" ? `${t.value.generateHeadingSlug(e)}` : e.slug ? `description/${e.slug}` : "", S = (e, n) => {
-    if (!e?.name)
-      return "models";
-    const o = n ? `${l(n)}/` : "";
-    return typeof t.value.generateModelSlug == "function" ? `${o}model/${t.value.generateModelSlug(e)}` : `${o}model/${s(e.name)}`;
-  }, l = (e) => typeof t.value.generateTagSlug == "function" ? `tag/${t.value.generateTagSlug(e)}` : `tag/${s(e.name ?? "")}`;
+    decodeURIComponent(window.location.hash.replace(/^#/, "")).slice(a.value.length)
+  );
   return {
-    hash: r,
+    hash: s,
     /** Sets the prefix for the hash */
     setHashPrefix: (e) => {
-      u.value = 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: w,
+    getFullHash: (e = s.value) => `${a.value}${e}`,
     /**
      * 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: $,
+    getHashedUrl: (e, n = window.location.href, o = window.location.search) => {
+      const r = new URL(n);
+      return t.value.pathRouting ? r.pathname = c(t.value.pathRouting.basePath, e) : r.hash = a.value + e, r.search = o, r.toString();
+    },
     /**
      * 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: v,
-    getReferenceId: g,
-    getWebhookId: (e, n) => {
-      if (!e?.name)
-        return "webhooks";
-      const o = n ? `${l(n)}/` : "";
-      return typeof t.value.generateWebhookSlug == "function" ? `${o}webhook/${t.value.generateWebhookSlug(e)}` : `${o}webhook/${e.method}/${s(e.name)}`;
+    replaceUrlState: (e, n = window.location.href) => {
+      const o = new URL(n);
+      t.value.pathRouting ? o.pathname = c(t.value.pathRouting.basePath, e) : o.hash = a.value + e, s.value = e, window.history.replaceState({}, "", o);
     },
-    getModelId: S,
-    getHeadingId: I,
-    getOperationId: (e, n) => typeof t.value.generateOperationSlug == "function" ? `${l(n)}/${t.value.generateOperationSlug({
-      path: e.path,
-      operationId: e.operationId,
-      method: e.method,
-      summary: e.summary
-    })}` : `${l(n)}/${e.method}${e.path}`,
-    getPathRoutingId: c,
-    getSectionId: p,
-    getTagId: l,
-    isIntersectionEnabled: f,
-    updateHash: m
+    getReferenceId: u,
+    getHeadingId: (e) => typeof t.value.generateHeadingSlug == "function" ? `${t.value.generateHeadingSlug(e)}` : e.slug ? `description/${e.slug}` : "",
+    getPathRoutingId: l,
+    isIntersectionEnabled: g,
+    updateHash: () => s.value = u()
   };
 };
 export {
-  k as NAV_STATE_SYMBOL,
-  M as useNavState
+  f as NAV_STATE_SYMBOL,
+  E as useNavState
 };

package/dist/index.d.ts

@@ -1,12 +1,11 @@
 export { default as ApiReference } from './components/ApiReference.vue.js';
 export { default as ApiReferenceLayout } from './components/ApiReferenceLayout.vue.js';
-export { default as ApiReferenceWorkspace } from './v2/ApiReferenceWorkspace.vue.js';
-export { SearchButton, SearchModal } from './features/Search';
 export { default as GettingStarted } from './components/GettingStarted.vue.js';
-export { createApiReference } from './standalone/lib/html-api.js';
-export { useSidebar, Sidebar } from './features/sidebar';
-export { useWorkspaceStoreEvents } from './v2/hooks/use-workspace-store-events.js';
-export { createEmptySpecification } from './libs/openapi.js';
+export { SearchButton, SearchModal } from './features/Search';
 export { useNavState } from './hooks/useNavState.js';
+export { createEmptySpecification } from './libs/openapi.js';
+export { createApiReference } from './standalone/lib/html-api.js';
 export type { ApiReferenceConfiguration, ReferenceProps, } from './types';
+export { default as ApiReferenceWorkspace } from './v2/ApiReferenceWorkspace.vue.js';
+export { useWorkspaceStoreEvents } from './v2/hooks/use-workspace-store-events.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,qCAAqC,CAAA;AACnF,OAAO,EAAE,OAAO,IAAI,qBAAqB,EAAE,MAAM,gCAAgC,CAAA;AACjF,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE7D,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,iCAAiC,CAAA;AAE3E,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAA;AAE9D,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAGxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAA;AAG/E,OAAO,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACjD,YAAY,EACV,yBAAyB,EACzB,cAAc,GACf,MAAM,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,qCAAqC,CAAA;AAEnF,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAEjD,OAAO,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAA;AAC9D,YAAY,EACV,yBAAyB,EACzB,cAAc,GACf,MAAM,SAAS,CAAA;AAChB,OAAO,EAAE,OAAO,IAAI,qBAAqB,EAAE,MAAM,gCAAgC,CAAA;AAEjF,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAA"}