@scalar/api-reference 1.32.9 → 1.32.10

package/dist/v2/blocks/scalar-request-example-block/helpers/generate-client-options.js

@@ -0,0 +1,35 @@
+import { snippetz as a } from "@scalar/snippetz";
+import { capitalize as r } from "vue";
+const f = (l) => `custom/${l.lang}`, u = (l, i) => {
+  const o = a().clients().flatMap((t) => {
+    const n = t.clients.flatMap((e) => {
+      const c = `${t.key}/${e.client}`;
+      return i && !i.includes(c) ? [] : {
+        id: c,
+        lang: e.client === "curl" ? "curl" : t.key,
+        title: `${r(t.title)} ${e.title}`,
+        label: e.title
+      };
+    });
+    return n.length === 0 ? [] : {
+      label: t.title,
+      options: n
+    };
+  }), s = l.map((t) => {
+    const n = f(t), e = t.label || t.lang || n;
+    return {
+      id: n,
+      lang: t.lang || "plaintext",
+      title: e,
+      label: e
+    };
+  });
+  return s.length > 0 && o.unshift({
+    label: "Code Examples",
+    options: s
+  }), o;
+};
+export {
+  u as generateClientOptions,
+  f as generateCustomId
+};

package/dist/v2/blocks/scalar-request-example-block/helpers/generate-code-snippet.js

@@ -0,0 +1,29 @@
+import { operationToHar as u } from "@scalar/oas-utils/helpers/operation-to-har";
+import { isReference as d } from "@scalar/workspace-store/schemas/v3.1/type-guard";
+import { getSnippet as l } from "@scalar/api-client/views/Components/CodeSnippet";
+const S = ({
+  clientId: t,
+  operation: e,
+  method: o,
+  path: n,
+  example: i,
+  contentType: p,
+  server: s,
+  securitySchemes: a
+}) => {
+  if (d(e))
+    return "";
+  const c = u({
+    operation: e,
+    contentType: p,
+    method: o,
+    path: n,
+    server: s,
+    securitySchemes: a,
+    example: i
+  }), [m, f] = t.split("/"), [r, g] = l(m, f, c);
+  return r ? r.message ?? "Error generating code snippet" : g;
+};
+export {
+  S as generateCodeSnippet
+};

package/dist/v2/blocks/scalar-request-example-block/helpers/get-secrets.js

@@ -0,0 +1,10 @@
+import { isDefined as o } from "@scalar/helpers/array/is-defined";
+const e = (t) => t.flatMap((r) => r.type === "apiKey" ? r["x-scalar-secret-token"] : (r == null ? void 0 : r.type) === "http" ? [
+  r["x-scalar-secret-token"],
+  r["x-scalar-secret-username"],
+  r["x-scalar-secret-password"],
+  btoa(`${r["x-scalar-secret-username"]}:${r["x-scalar-secret-password"]}`)
+] : r.type === "oauth2" ? Object.values(r.flows).map((a) => a["x-scalar-secret-token"]) : []).filter(o);
+export {
+  e as getSecrets
+};

package/dist/v2/blocks/scalar-request-example-block/index.d.ts

@@ -1,3 +1,3 @@
-export { default as RequestExample } from './components/RequestExample.vue';
-export { default as ExamplePicker } from './components/ExamplePicker.vue';
+export { default as RequestExample } from './components/RequestExample.vue.js';
+export { default as ExamplePicker } from './components/ExamplePicker.vue.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/v2/events/definitions.js

@@ -0,0 +1,7 @@
+function o(e, t, n) {
+  const c = new CustomEvent(t, { detail: n, bubbles: !0, composed: !0, cancelable: !0 });
+  e.dispatchEvent(c);
+}
+export {
+  o as emitCustomEvent
+};

package/dist/v2/events/index.d.ts

@@ -1,3 +1,3 @@
-export { type ApiReferenceEvents, type ApiReferenceEvent, emitCustomEvent } from './definitions';
+export { type ApiReferenceEvents, type ApiReferenceEvent, emitCustomEvent } from './definitions.js';
 export { onCustomEvent } from './listeners.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/v2/events/listeners.d.ts

@@ -1,4 +1,4 @@
-import type { ApiReferenceEvent, ApiReferenceEvents } from './definitions';
+import type { ApiReferenceEvent, ApiReferenceEvents } from './definitions.js';
 import { type Ref } from 'vue';
 /**
  * Vue wrapper for attaching and removing event listeners

package/dist/v2/hooks/useStore.js

@@ -0,0 +1,14 @@
+import { provide as r, inject as n } from "vue";
+const o = Symbol(), a = (e) => {
+  if (e)
+    return r(o, e), e;
+  const t = n(o);
+  if (!t)
+    throw new Error(
+      "useStore() was called without a store and no store instance was found. Make sure to call useStore(store) in a parent component first."
+    );
+  return t;
+};
+export {
+  a as useStore
+};

package/package.json

@@ -20,7 +20,7 @@
     "vue",
     "vue3"
   ],
-  "version": "1.32.9",
+  "version": "1.32.10",
   "engines": {
     "node": ">=20"
   },
@@ -54,21 +54,21 @@
     "nanoid": "5.1.5",
     "vue": "^3.5.17",
     "zod": "3.24.1",
+    "@scalar/api-client": "2.5.19",
     "@scalar/code-highlight": "0.1.8",
-    "@scalar/api-client": "2.5.18",
+    "@scalar/components": "0.14.20",
     "@scalar/helpers": "0.0.6",
-    "@scalar/components": "0.14.19",
     "@scalar/icons": "0.4.6",
-    "@scalar/openapi-parser": "0.18.1",
+    "@scalar/oas-utils": "0.4.15",
+    "@scalar/openapi-parser": "0.18.2",
     "@scalar/object-utils": "1.2.2",
     "@scalar/openapi-types": "0.3.6",
-    "@scalar/types": "0.2.9",
-    "@scalar/oas-utils": "0.4.14",
-    "@scalar/themes": "0.13.10",
+    "@scalar/snippetz": "0.4.3",
+    "@scalar/types": "0.2.10",
     "@scalar/use-hooks": "0.2.4",
-    "@scalar/snippetz": "0.4.2",
     "@scalar/use-toasts": "0.8.0",
-    "@scalar/workspace-store": "0.10.1"
+    "@scalar/workspace-store": "0.10.2",
+    "@scalar/themes": "0.13.11"
   },
   "devDependencies": {
     "@tailwindcss/vite": "^4.1.7",
@@ -86,8 +86,8 @@
     "vite-plugin-css-injected-by-js": "^3.4.0",
     "vitest": "^1.6.1",
     "@scalar/build-tooling": "0.2.4",
-    "@scalar/react-renderer": "0.2.1",
-    "@scalar/galaxy": "0.5.4"
+    "@scalar/galaxy": "0.5.5",
+    "@scalar/react-renderer": "0.2.1"
   },
   "scripts": {
     "build": "pnpm build:default && pnpm build:standalone && pnpm types:build && tsc-alias -p tsconfig.build.json",

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023-present Scalar
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/dist/blocks/constants.js

@@ -1,6 +0,0 @@
-const t = {
-  EMPTY_PATH: "Path cannot be empty. Please provide a path to the operation you want to display."
-};
-export {
-  t as ERRORS
-};

package/dist/blocks/helpers/getPointer.js

@@ -1,12 +0,0 @@
-import { ERRORS as n } from "../constants.js";
-import { escapeJsonPointer as e } from "@scalar/openapi-parser";
-function m(o) {
-  o.unshift("#");
-  const r = o.map((t) => e(t.trim())).filter(Boolean).join("/");
-  if (r === "#")
-    throw new Error(n.EMPTY_PATH);
-  return r;
-}
-export {
-  m as getPointer
-};

package/dist/blocks/hooks/useBlockProps.d.ts

@@ -1,31 +0,0 @@
-import type { createWorkspaceStore } from '@scalar/api-client/store';
-import type { Collection } from '@scalar/oas-utils/entities/spec';
-import type { Request as RequestEntity } from '@scalar/oas-utils/entities/spec';
-import { type ComputedRef } from 'vue';
-export type StoreContext = ReturnType<typeof createWorkspaceStore>;
-export type BlockProps = {
-    /**
-     * The store created by `createStore`
-     */
-    store: StoreContext | undefined;
-    /**
-     * The JSON pointer to the operation to use
-     *
-     * @example
-     * ```
-     * #/paths/test/get
-     * ```
-     */
-    location: `#/${string}`;
-    /**
-     * The collection to use
-     */
-    collection: Collection;
-};
-/**
- * Provides computed properties for the block, based on the standardized interface of the `createStore` function.
- */
-export declare function useBlockProps({ store, location, collection }: BlockProps): {
-    operation: ComputedRef<RequestEntity | undefined>;
-};
-//# sourceMappingURL=useBlockProps.d.ts.map

package/dist/blocks/hooks/useBlockProps.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useBlockProps.d.ts","sourceRoot":"","sources":["../../../src/blocks/hooks/useBlockProps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AACpE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;AACjE,OAAO,KAAK,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iCAAiC,CAAA;AAE/E,OAAO,EAAE,KAAK,WAAW,EAAY,MAAM,KAAK,CAAA;AAGhD,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAElE,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,KAAK,EAAE,YAAY,GAAG,SAAS,CAAA;IAC/B;;;;;;;OAOG;IACH,QAAQ,EAAE,KAAK,MAAM,EAAE,CAAA;IACvB;;OAEG;IACH,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,UAAU,GAAG;IAC1E,SAAS,EAAE,WAAW,CAAC,aAAa,GAAG,SAAS,CAAC,CAAA;CAClD,CAgCA"}

package/dist/blocks/hooks/useBlockProps.js

@@ -1,24 +0,0 @@
-import { unescapeJsonPointer as a } from "@scalar/openapi-parser";
-import { computed as p } from "vue";
-function d({ store: t, location: e, collection: o }) {
-  return {
-    operation: p(() => {
-      if (!(t != null && t.collections) || !t.requests)
-        return;
-      const n = Object.values(t.requests).filter(
-        (s) => o.requests.includes(s.uid)
-      );
-      if (!e.startsWith("#/paths/") && !e.startsWith("#/webhooks/"))
-        throw new Error(
-          "Invalid location, try using #/paths/$YOUR_ENDPOINT/$HTTP_METHOD. You can use the getPointer helper to generate a valid location: getPointer(['paths', '/planets/{planetId}', 'get'])"
-        );
-      return n.find((s) => {
-        const r = a(e.split("/")[2]), i = e.split("/")[3].toLocaleLowerCase();
-        return s.method === i && s.path === r;
-      });
-    })
-  };
-}
-export {
-  d as useBlockProps
-};

package/dist/features/example-request/ExamplePicker.vue.d.ts

@@ -1,13 +0,0 @@
-type __VLS_Props = {
-    examples: Record<string, any>;
-};
-type __VLS_PublicProps = {
-    modelValue?: string;
-} & __VLS_Props;
-declare const _default: import("vue").DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "update:modelValue": (value: string) => any;
-}, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
-    "onUpdate:modelValue"?: ((value: string) => any) | undefined;
-}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, HTMLLabelElement>;
-export default _default;
-//# sourceMappingURL=ExamplePicker.vue.d.ts.map

package/dist/features/example-request/ExamplePicker.vue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ExamplePicker.vue.d.ts","sourceRoot":"","sources":["../../../src/features/example-request/ExamplePicker.vue"],"names":[],"mappings":"AAsEA,KAAK,WAAW,GAAG;IACjB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B,CAAC;AA0CF,KAAK,iBAAiB,GAAG;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;CACnB,GAAG,WAAW,CAAC;;;;;;AAsFhB,wBAQG"}

package/dist/features/example-request/ExamplePicker.vue.js

@@ -1,7 +0,0 @@
-import o from "./ExamplePicker.vue2.js";
-/* empty css                   */
-import r from "../../_virtual/_plugin-vue_export-helper.js";
-const m = /* @__PURE__ */ r(o, [["__scopeId", "data-v-15f4f2cc"]]);
-export {
-  m as default
-};

package/dist/features/example-request/ExamplePicker.vue2.js

@@ -1,57 +0,0 @@
-import { defineComponent as u, mergeModels as i, useModel as d, watch as c, createBlock as f, openBlock as x, withCtx as s, createVNode as V, createTextVNode as n, toDisplayString as _ } from "vue";
-import b from "../../components/ScreenReader.vue.js";
-import v from "./TextSelect.vue.js";
-/* empty css                */
-const w = /* @__PURE__ */ u({
-  __name: "ExamplePicker",
-  props: /* @__PURE__ */ i({
-    examples: {}
-  }, {
-    modelValue: {},
-    modelModifiers: {}
-  }),
-  emits: ["update:modelValue"],
-  setup(m) {
-    const a = m, t = d(m, "modelValue");
-    function p(e) {
-      e && (t.value = e);
-    }
-    c(
-      () => a.examples,
-      () => {
-        a.examples[t.value ?? ""] || p(Object.keys(a.examples)[0]);
-      },
-      { immediate: !0 }
-    );
-    function r(e) {
-      if (!e)
-        return "Select an example";
-      const l = a.examples[e];
-      return (l == null ? void 0 : l.summary) ?? e;
-    }
-    return (e, l) => (x(), f(v, {
-      modelValue: t.value,
-      "onUpdate:modelValue": l[0] || (l[0] = (o) => t.value = o),
-      class: "example-selector",
-      options: Object.keys(e.examples).map((o) => ({
-        label: r(o),
-        value: o
-      }))
-    }, {
-      default: s(() => [
-        V(b, null, {
-          default: s(() => l[1] || (l[1] = [
-            n("Selected Example Values:")
-          ])),
-          _: 1,
-          __: [1]
-        }),
-        n(" " + _(r(t.value ?? "Unknown")), 1)
-      ]),
-      _: 1
-    }, 8, ["modelValue", "options"]));
-  }
-});
-export {
-  w as default
-};

package/dist/features/example-request/ExampleRequest.vue.d.ts

@@ -1,85 +0,0 @@
-import { type Collection, type Request, type Server } from '@scalar/oas-utils/entities/spec';
-import type { OpenAPIV3_1 } from '@scalar/types/legacy';
-import { type ComponentPublicInstance } from 'vue';
-import type { Schemas } from '../../features/Operation/types/schemas';
-type __VLS_Props = {
-    server: Server | undefined;
-    collection: Collection;
-    operation: OpenAPIV3_1.OperationObject;
-    request: Request | undefined;
-    method: OpenAPIV3_1.HttpMethods;
-    /** Show a simplified card if no example are available */
-    fallback?: boolean;
-    schemas?: Schemas;
-};
-declare function __VLS_template(): {
-    attrs: Partial<{}>;
-    slots: {
-        header?(_: {}): any;
-        header?(_: {}): any;
-        footer?(_: {}): any;
-        footer?(_: {}): any;
-    };
-    refs: {
-        elem: ({
-            $: import("vue").ComponentInternalInstance;
-            $data: {};
-            $props: {
-                readonly label?: string | undefined;
-            } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps;
-            $attrs: {
-                [x: string]: unknown;
-            };
-            $refs: {
-                [x: string]: unknown;
-            };
-            $slots: Readonly<{
-                [name: string]: import("vue").Slot<any> | undefined;
-            }>;
-            $root: ComponentPublicInstance | null;
-            $parent: ComponentPublicInstance | null;
-            $host: Element | null;
-            $emit: (event: string, ...args: any[]) => void;
-            $el: any;
-            $options: import("vue").ComponentOptionsBase<Readonly<{
-                label?: string;
-            }> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {}, {}, string, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & {
-                beforeCreate?: (() => void) | (() => void)[];
-                created?: (() => void) | (() => void)[];
-                beforeMount?: (() => void) | (() => void)[];
-                mounted?: (() => void) | (() => void)[];
-                beforeUpdate?: (() => void) | (() => void)[];
-                updated?: (() => void) | (() => void)[];
-                activated?: (() => void) | (() => void)[];
-                deactivated?: (() => void) | (() => void)[];
-                beforeDestroy?: (() => void) | (() => void)[];
-                beforeUnmount?: (() => void) | (() => void)[];
-                destroyed?: (() => void) | (() => void)[];
-                unmounted?: (() => void) | (() => void)[];
-                renderTracked?: ((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[];
-                renderTriggered?: ((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[];
-                errorCaptured?: ((err: unknown, instance: ComponentPublicInstance | null, info: string) => boolean | void) | ((err: unknown, instance: ComponentPublicInstance | null, info: string) => boolean | void)[];
-            };
-            $forceUpdate: () => void;
-            $nextTick: typeof import("vue").nextTick;
-            $watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (...args: [R, R, import("@vue/reactivity").OnCleanup]) => any : (...args: [any, any, import("@vue/reactivity").OnCleanup]) => any, options?: import("vue").WatchOptions): import("vue").WatchStopHandle;
-        } & Readonly<{}> & Omit<Readonly<{
-            label?: string;
-        }> & Readonly<{}>, never> & import("vue").ShallowUnwrapRef<{}> & {} & import("vue").ComponentCustomProperties & {} & {
-            $slots: {
-                default?(_: {}): any;
-            };
-        }) | null;
-    };
-    rootEl: any;
-};
-type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
-declare const __VLS_component: 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 _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
-export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & {
-    new (): {
-        $slots: S;
-    };
-};
-//# sourceMappingURL=ExampleRequest.vue.d.ts.map

package/dist/features/example-request/ExampleRequest.vue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ExampleRequest.vue.d.ts","sourceRoot":"","sources":["../../../src/features/example-request/ExampleRequest.vue"],"names":[],"mappings":"AA0jBA,OAAO,EAGL,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,MAAM,EACZ,MAAM,iCAAiC,CAAA;AAGxC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AACvD,OAAO,EAOL,KAAK,uBAAuB,EAC7B,MAAM,KAAK,CAAA;AAIZ,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oCAAoC,CAAA;AAiBjE,KAAK,WAAW,GAAG;IACjB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,UAAU,EAAE,UAAU,CAAA;IACtB,SAAS,EAAE,WAAW,CAAC,eAAe,CAAA;IACtC,OAAO,EAAE,OAAO,GAAG,SAAS,CAAA;IAC5B,MAAM,EAAE,WAAW,CAAC,WAAW,CAAA;IAC/B,yDAAyD;IACzD,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAC;AAuXF,iBAAS,cAAc;WAwOT,OAAO,IAA6B;;wBAZrB,GAAG;wBAEH,GAAG;wBADH,GAAG;wBAEH,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wCAzPxB,GAAH,8CACK,GAAL,yBAAyB,GAAG,6DACH,GAAG;;;;;;;;;;EAqQhC;AAkCD,KAAK,oBAAoB,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAC9D,QAAA,MAAM,eAAe,kSAMnB,CAAC;wBACkB,uBAAuB,CAAC,OAAO,eAAe,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;AAAnG,wBAAoG;AAWpG,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IACxC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KAEV,CAAA;CACD,CAAC"}

package/dist/features/example-request/ExampleRequest.vue.js

@@ -1,7 +0,0 @@
-import o from "./ExampleRequest.vue2.js";
-/* empty css                    */
-import t from "../../_virtual/_plugin-vue_export-helper.js";
-const r = /* @__PURE__ */ t(o, [["__scopeId", "data-v-39e129cd"]]);
-export {
-  r as default
-};