@scalar/api-reference 1.25.10 → 1.25.11

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,mBA8BjB"}

package/dist/helpers/getExampleCode.js

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