@scalar/api-reference 1.25.10 → 1.25.12

package/dist/{components/Content/Operation/PathResponses/PathResponses.vue2.js → features/ExampleResponses/ExampleResponses.vue2.js}

@@ -1,22 +1,22 @@
-import { defineComponent as B, ref as S, computed as v, openBlock as t, createBlock as r, unref as s, withCtx as c, createVNode as b, createElementBlock as x, createCommentVNode as f, createTextVNode as g, withDirectives as M, createElementVNode as w, vModelCheckbox as N, Fragment as R, renderList as F, toDisplayString as O, pushScopeId as P, popScopeId as A } from "vue";
-import { ScalarIcon as D, ScalarCodeBlock as U, ScalarMarkdown as H } from "@scalar/components";
+import { defineComponent as B, ref as S, computed as v, openBlock as t, createBlock as r, unref as s, withCtx as c, createVNode as b, createElementBlock as x, createCommentVNode as f, createTextVNode as g, withDirectives as M, createElementVNode as E, vModelCheckbox as N, Fragment as R, renderList as F, toDisplayString as O, pushScopeId as A, popScopeId as D } from "vue";
+import { ScalarIcon as P, ScalarCodeBlock as U, ScalarMarkdown as H } from "@scalar/components";
 import { normalizeMimeTypeObject as J } from "@scalar/oas-utils/helpers";
 import T from "./ExampleResponse.vue.js";
-import K from "../../../Card/Card.vue.js";
-import L from "../../../Card/CardTabHeader.vue.js";
-import W from "../../../Card/CardTab.vue.js";
-import q from "../../../Card/CardContent.vue.js";
-import G from "../../../Card/CardFooter.vue.js";
-import Q from "../../../../features/ExampleRequest/ExamplePicker.vue.js";
-import { useClipboard as X } from "../../../../hooks/useClipboard.js";
-const Y = (u) => (P("data-v-b976599a"), u = u(), A(), u), Z = {
+import K from "../../components/Card/Card.vue.js";
+import L from "../../components/Card/CardTabHeader.vue.js";
+import W from "../../components/Card/CardTab.vue.js";
+import q from "../../components/Card/CardContent.vue.js";
+import G from "../../components/Card/CardFooter.vue.js";
+import Q from "../ExampleRequest/ExamplePicker.vue.js";
+import { useClipboard as X } from "../../hooks/useClipboard.js";
+const Y = (u) => (A("data-v-0696399e"), u = u(), D(), u), Z = {
   key: 1,
   class: "scalar-card-checkbox"
-}, $ = /* @__PURE__ */ Y(() => /* @__PURE__ */ w("span", { class: "scalar-card-checkbox-checkmark" }, null, -1)), z = { class: "scalar-card-container custom-scroll" }, ee = {
+}, $ = /* @__PURE__ */ Y(() => /* @__PURE__ */ E("span", { class: "scalar-card-checkbox-checkmark" }, null, -1)), z = { class: "scalar-card-container custom-scroll" }, ee = {
   key: 1,
   class: "response-description"
 }, ie = /* @__PURE__ */ B({
-  __name: "PathResponses",
+  __name: "ExampleResponses",
   props: {
     operation: {}
   },
@@ -28,9 +28,9 @@ const Y = (u) => (P("data-v-b976599a"), u = u(), A(), u), Z = {
       }
     ), y = v(
       () => !!o.value.examples
-    ), E = S(0), m = v(() => {
+    ), w = S(0), m = v(() => {
       var a, i;
-      const e = C.value[E.value];
+      const e = C.value[w.value];
       return (i = (a = k.operation.information) == null ? void 0 : a.responses) == null ? void 0 : i[e];
     }), o = v(() => {
       var a;
@@ -55,7 +55,7 @@ const Y = (u) => (P("data-v-b976599a"), u = u(), A(), u), Z = {
       ...o.value,
       example: y.value && p.value ? o.value.examples[p.value].value ?? o.value.examples[p.value] : j()
     })), I = (e) => {
-      E.value = e, p.value = void 0;
+      w.value = e, p.value = void 0;
     }, _ = S(!1);
     return (e, a) => C.value.length ? (t(), r(s(K), { key: 0 }, {
       default: c(() => {
@@ -78,7 +78,7 @@ const Y = (u) => (P("data-v-b976599a"), u = u(), A(), u), Z = {
                     return s(V)((n = o.value) == null ? void 0 : n.example);
                   })
                 }, [
-                  b(s(D), {
+                  b(s(P), {
                     icon: "Clipboard",
                     width: "12px",
                     x: "asd"
@@ -86,7 +86,7 @@ const Y = (u) => (P("data-v-b976599a"), u = u(), A(), u), Z = {
                 ])) : f("", !0),
                 (d = o.value) != null && d.schema ? (t(), x("label", Z, [
                   g(" Show Schema "),
-                  M(w("input", {
+                  M(E("input", {
                     "onUpdate:modelValue": a[1] || (a[1] = (n) => _.value = n),
                     class: "scalar-card-checkbox-input",
                     type: "checkbox"
@@ -107,7 +107,7 @@ const Y = (u) => (P("data-v-b976599a"), u = u(), A(), u), Z = {
             ]),
             _: 1
           }),
-          w("div", z, [
+          E("div", z, [
             b(s(q), { muted: "" }, {
               default: c(() => {
                 var l;

package/dist/features/ExampleResponses/index.d.ts

@@ -0,0 +1,2 @@
+export { default as ExampleResponses } from './ExampleResponses.vue.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/features/ExampleResponses/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/features/ExampleResponses/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,wBAAwB,CAAA"}

package/dist/helpers/createRequest.d.ts

@@ -0,0 +1,6 @@
+import type { Request } from '@scalar/snippetz';
+/**
+ * Creates a complete HAR request, even if just passed a partial request.
+ */
+export declare function createRequest(partialRequest?: Partial<Request>): Request;
+//# sourceMappingURL=createRequest.d.ts.map

package/dist/helpers/createRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createRequest.d.ts","sourceRoot":"","sources":["../../src/helpers/createRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAE/C;;GAEG;AACH,wBAAgB,aAAa,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAYxE"}

package/dist/helpers/createRequest.js

@@ -0,0 +1,16 @@
+function t(e) {
+  return {
+    httpVersion: "http/2.0",
+    method: "GET",
+    url: "",
+    cookies: [],
+    headers: [],
+    headersSize: 0,
+    bodySize: 0,
+    queryString: [],
+    ...e ?? {}
+  };
+}
+export {
+  t as createRequest
+};

package/dist/helpers/getExampleCode.d.ts

@@ -0,0 +1,9 @@
+import { type Request, type ClientId as SnippetzClientId, type TargetId as SnippetzTargetId } from '@scalar/snippetz';
+import { type ClientId as HttpSnippetLiteClientId, type TargetId as HttpSnippetLiteTargetId } from 'httpsnippet-lite';
+export type TargetId = HttpSnippetLiteTargetId | SnippetzTargetId;
+export type ClientId = HttpSnippetLiteClientId | SnippetzClientId;
+/**
+ * Returns a code example for given HAR request
+ */
+export declare function getExampleCode(request: Request, target: TargetId, client: ClientId): Promise<string>;
+//# sourceMappingURL=getExampleCode.d.ts.map

package/dist/helpers/getExampleCode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getExampleCode.d.ts","sourceRoot":"","sources":["../../src/helpers/getExampleCode.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,QAAQ,IAAI,gBAAgB,EACjC,KAAK,QAAQ,IAAI,gBAAgB,EAElC,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAEL,KAAK,QAAQ,IAAI,uBAAuB,EACxC,KAAK,QAAQ,IAAI,uBAAuB,EACzC,MAAM,kBAAkB,CAAA;AAEzB,MAAM,MAAM,QAAQ,GAAG,uBAAuB,GAAG,gBAAgB,CAAA;AACjE,MAAM,MAAM,QAAQ,GAAG,uBAAuB,GAAG,gBAAgB,CAAA;AAEjE;;GAEG;AACH,wBAAsB,cAAc,CAClC,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,QAAQ,EAChB,MAAM,EAAE,QAAQ,mBAoCjB"}

package/dist/helpers/getExampleCode.js

@@ -0,0 +1,30 @@
+import { snippetz as o } from "@scalar/snippetz";
+import { HTTPSnippet as c } from "httpsnippet-lite";
+async function m(r, e, t) {
+  const i = e;
+  if (o().hasPlugin(i, t))
+    return o().print(
+      e,
+      t,
+      r
+    );
+  try {
+    const p = e.replace(
+      "js",
+      "javascript"
+    ), a = t, n = await new c(r).convert(
+      p,
+      a
+    );
+    if (typeof n == "string") return n;
+  } catch (p) {
+    console.error(
+      "[getExampleCode] Failed to generate example code with httpsnippet-lite:",
+      p
+    );
+  }
+  return "";
+}
+export {
+  m as getExampleCode
+};

package/dist/helpers/index.d.ts

@@ -1,6 +1,8 @@
 export * from './createEmptySpecification.js';
+export * from './createRequest.js';
 export * from './deepMerge.js';
 export * from './getApiClientRequest.js';
+export * from './getExampleCode.js';
 export * from './getHarRequest.js';
 export * from './getHeadingsFromMarkdown.js';
 export * from './getLowestHeadingLevel.js';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAA;AAC1C,cAAc,aAAa,CAAA;AAC3B,cAAc,uBAAuB,CAAA;AACrC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,2BAA2B,CAAA;AACzC,cAAc,yBAAyB,CAAA;AACvC,cAAc,aAAa,CAAA;AAC3B,cAAc,oBAAoB,CAAA;AAClC,cAAc,aAAa,CAAA;AAC3B,cAAc,sBAAsB,CAAA;AACpC,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,SAAS,CAAA;AACvB,cAAc,kBAAkB,CAAA;AAChC,cAAc,cAAc,CAAA;AAC5B,cAAc,SAAS,CAAA;AACvB,cAAc,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAA;AAC1C,cAAc,iBAAiB,CAAA;AAC/B,cAAc,aAAa,CAAA;AAC3B,cAAc,uBAAuB,CAAA;AACrC,cAAc,kBAAkB,CAAA;AAChC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,2BAA2B,CAAA;AACzC,cAAc,yBAAyB,CAAA;AACvC,cAAc,aAAa,CAAA;AAC3B,cAAc,oBAAoB,CAAA;AAClC,cAAc,aAAa,CAAA;AAC3B,cAAc,sBAAsB,CAAA;AACpC,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,SAAS,CAAA;AACvB,cAAc,kBAAkB,CAAA;AAChC,cAAc,cAAc,CAAA;AAC5B,cAAc,SAAS,CAAA;AACvB,cAAc,iBAAiB,CAAA"}

package/dist/helpers/mergeAllObjects.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Merges an array of objects into a single object.
+ */
 export declare const mergeAllObjects: (items: Record<any, any>[]) => any;
 //# sourceMappingURL=mergeAllObjects.d.ts.map

package/dist/helpers/mergeAllObjects.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mergeAllObjects.d.ts","sourceRoot":"","sources":["../../src/helpers/mergeAllObjects.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,eAAe,UAAW,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,KAAG,GAO3D,CAAA"}
+{"version":3,"file":"mergeAllObjects.d.ts","sourceRoot":"","sources":["../../src/helpers/mergeAllObjects.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,eAAe,UAAW,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,KAAG,GAO3D,CAAA"}

package/dist/hooks/useReactiveSpec.d.ts

@@ -43,8 +43,11 @@ export declare function useReactiveSpec({ specConfig, proxy, }: {
                         example?: any;
                         examples?: (Map<string, any> & Omit<Map<string, any>, keyof Map<any, any>>) | undefined;
                         content?: import("@scalar/types/legacy").RequestBodyMimeTypes;
+                        headers?: {
+                            [key: string]: import("@scalar/types/legacy").OpenAPI.HeaderObject;
+                        };
                     }[] | undefined;
-                    responses?: Record<string, import("@scalar/types/legacy").ScalarResponse>;
+                    responses?: Record<string, import("@scalar/types/legacy").OpenAPI.ResponseObject>;
                     security?: import("@scalar/types/legacy").OpenAPIV3.SecurityRequirementObject[];
                     requestBody?: {
                         description?: string;
@@ -92,6 +95,9 @@ export declare function useReactiveSpec({ specConfig, proxy, }: {
                     example?: any;
                     examples?: (Map<string, any> & Omit<Map<string, any>, keyof Map<any, any>>) | undefined;
                     content?: import("@scalar/types/legacy").RequestBodyMimeTypes;
+                    headers?: {
+                        [key: string]: import("@scalar/types/legacy").OpenAPI.HeaderObject;
+                    };
                 }[] | undefined;
             }[];
             'x-displayName'?: string;

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

@@ -1 +1 @@
-{"version":3,"file":"useReactiveSpec.d.ts","sourceRoot":"","sources":["../../src/hooks/useReactiveSpec.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAC7D,OAAO,EAAE,KAAK,gBAAgB,EAAiC,MAAM,KAAK,CAAA;AAmD1E;;GAEG;AACH,wBAAgB,eAAe,CAAC,EAC9B,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,CAAC,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,CAAA;IAChD,KAAK,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;CACjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwDA"}
+{"version":3,"file":"useReactiveSpec.d.ts","sourceRoot":"","sources":["../../src/hooks/useReactiveSpec.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAC7D,OAAO,EAAE,KAAK,gBAAgB,EAAiC,MAAM,KAAK,CAAA;AAmD1E;;GAEG;AACH,wBAAgB,eAAe,CAAC,EAC9B,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,CAAC,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,CAAA;IAChD,KAAK,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;CACjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwDA"}

package/dist/hooks/useResponses.d.ts

@@ -1,3 +1,4 @@
+import type { OpenAPI } from '@scalar/openapi-types';
 import type { RequestBodyMimeTypes, TransformedOperation } from '@scalar/types/legacy';
 /**
  * This hook is used to generate the responses for the request from the parameters in the swagger file
@@ -7,6 +8,9 @@ export declare function useResponses(operation: TransformedOperation): {
         name: string;
         description: string;
         content: RequestBodyMimeTypes;
+        headers?: {
+            [key: string]: OpenAPI.HeaderObject;
+        };
     }[]>;
 };
 //# sourceMappingURL=useResponses.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"useResponses.d.ts","sourceRoot":"","sources":["../../src/hooks/useResponses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,sBAAsB,CAAA;AAG7B;;GAEG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,oBAAoB;;cAOhD,MAAM;qBACC,MAAM;iBACV,oBAAoB;;EAiBlC"}
+{"version":3,"file":"useResponses.d.ts","sourceRoot":"","sources":["../../src/hooks/useResponses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,KAAK,EACV,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,sBAAsB,CAAA;AAG7B;;GAEG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,oBAAoB;;cAOhD,MAAM;qBACC,MAAM;iBACV,oBAAoB;kBACnB;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAA;SAAE;;EAkBtD"}

package/dist/hooks/useResponses.js

@@ -1,17 +1,18 @@
 import { computed as s } from "vue";
-function i(e) {
+function u(r) {
   return { responses: s(() => {
-    if (!e.information) return [];
-    const { responses: n } = e.information, o = [];
-    return n && Object.keys(n).forEach((r) => {
-      o.push({
-        name: r,
-        description: n[r].description,
-        content: n[r].content
+    if (!r.information) return [];
+    const { responses: t } = r.information, e = [];
+    return t && Object.entries(t).forEach(([o, n]) => {
+      e.push({
+        name: o,
+        description: n.description,
+        content: n.content,
+        headers: n.headers
       });
-    }), o;
+    }), e;
   }) };
 }
 export {
-  i as useResponses
+  u as useResponses
 };