@scalar/api-reference 1.32.0 → 1.32.4

package/dist/libs/openapi.d.ts

@@ -18,7 +18,7 @@ export declare function formatProperty(key: string, obj: PropertyObject): string
  */
 export declare function extractRequestBody(operation: OpenAPIV3_1.OperationObject): string[] | boolean;
 /**
- * Returns all models from the specification, no matter if it’s OpenAPI 3.x.
+ * Returns all models from the specification, no matter if it's OpenAPI 3.x.
  */
 export declare function getModels(document?: OpenAPIV3_1.Document): Record<string, OpenAPIV3_1.SchemaObject>;
 /**
@@ -50,5 +50,19 @@ export declare function getOperationStability(operation: OpenAPIV3_1.OperationOb
  * Get Operation stability color
  */
 export declare function getOperationStabilityColor(operation: OpenAPIV3_1.OperationObject): string;
+export type ParameterMap = {
+    path: OpenAPIV3_1.ParameterObject[];
+    query: OpenAPIV3_1.ParameterObject[];
+    header: OpenAPIV3_1.ParameterObject[];
+    cookie: OpenAPIV3_1.ParameterObject[];
+    body: OpenAPIV3_1.ParameterObject[];
+    formData: OpenAPIV3_1.ParameterObject[];
+};
+/**
+ * This function creates a parameter map from an Operation Object, that's easier to consume.
+ *
+ * TODO: Isn't it easier to just stick to the OpenAPI structure, without transforming it?
+ */
+export declare function createParameterMap(operation: OpenAPIV3_1.OperationObject): ParameterMap;
 export {};
 //# sourceMappingURL=openapi.d.ts.map

package/dist/libs/openapi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"openapi.d.ts","sourceRoot":"","sources":["../../src/libs/openapi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAIvD,KAAK,cAAc,GAAG;IACpB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,UAAU,EAAE;QACV,CAAC,GAAG,EAAE,MAAM,GAAG;YACb,IAAI,EAAE,MAAM,CAAA;YACZ,WAAW,CAAC,EAAE,MAAM,CAAA;SACrB,CAAA;KACF,CAAA;CACF,CAAA;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,cAAc,GAAG,MAAM,CAcvE;AA8BD;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,WAAW,CAAC,eAAe,GAAG,MAAM,EAAE,GAAG,OAAO,CAY7F;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,QAAQ,CAAC,EAAE,WAAW,CAAC,QAAQ,4CAsBxD;AAED;;GAEG;AACH,eAAO,MAAM,SAAS,aAAc,WAAW,CAAC,QAAQ,YAUvD,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,WAAW,cAAe,WAAW,CAAC,QAAQ,YAU1D,CAAA;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,oBAW3E;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,GAiBjF,OAAO,CAAC,QAAQ,CACvB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,WAAW,CAAC,eAAe,GAAG,OAAO,CAQrF;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,WAAW,CAAC,eAAe,GAAG,gBAAgB,GAAG,SAAS,CAK1G;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,WAAW,CAAC,eAAe,GAAG,MAAM,CAYzF"}
+{"version":3,"file":"openapi.d.ts","sourceRoot":"","sources":["../../src/libs/openapi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAEjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAIvD,KAAK,cAAc,GAAG;IACpB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,UAAU,EAAE;QACV,CAAC,GAAG,EAAE,MAAM,GAAG;YACb,IAAI,EAAE,MAAM,CAAA;YACZ,WAAW,CAAC,EAAE,MAAM,CAAA;SACrB,CAAA;KACF,CAAA;CACF,CAAA;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,cAAc,GAAG,MAAM,CAcvE;AA8BD;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,WAAW,CAAC,eAAe,GAAG,MAAM,EAAE,GAAG,OAAO,CAY7F;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,QAAQ,CAAC,EAAE,WAAW,CAAC,QAAQ,4CAsBxD;AAED;;GAEG;AACH,eAAO,MAAM,SAAS,aAAc,WAAW,CAAC,QAAQ,YAUvD,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,WAAW,cAAe,WAAW,CAAC,QAAQ,YAU1D,CAAA;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,oBAW3E;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,GAiBjF,OAAO,CAAC,QAAQ,CACvB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,WAAW,CAAC,eAAe,GAAG,OAAO,CAQrF;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,WAAW,CAAC,eAAe,GAAG,gBAAgB,GAAG,SAAS,CAK1G;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,WAAW,CAAC,eAAe,GAAG,MAAM,CAYzF;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,WAAW,CAAC,eAAe,EAAE,CAAA;IACnC,KAAK,EAAE,WAAW,CAAC,eAAe,EAAE,CAAA;IACpC,MAAM,EAAE,WAAW,CAAC,eAAe,EAAE,CAAA;IACrC,MAAM,EAAE,WAAW,CAAC,eAAe,EAAE,CAAA;IACrC,IAAI,EAAE,WAAW,CAAC,eAAe,EAAE,CAAA;IACnC,QAAQ,EAAE,WAAW,CAAC,eAAe,EAAE,CAAA;CACxC,CAAA;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,WAAW,CAAC,eAAe,gBAqDxE"}

package/dist/libs/openapi.js

@@ -1,58 +1,59 @@
-import { XScalarStability as c } from "@scalar/types/legacy";
-function u(e, r) {
-  var s;
-  let t = e;
-  const i = (s = r.required) == null ? void 0 : s.includes(e);
-  return t += i ? " REQUIRED " : " optional ", r.properties[e] && (t += r.properties[e].type, r.properties[e].description && (t += " " + r.properties[e].description)), t;
+import { isDereferenced as h } from "@scalar/openapi-types/helpers";
+import { XScalarStability as o } from "@scalar/types/legacy";
+function d(t, i) {
+  var r;
+  let s = t;
+  const e = (r = i.required) == null ? void 0 : r.includes(t);
+  return s += e ? " REQUIRED " : " optional ", i.properties[t] && (s += i.properties[t].type, i.properties[t].description && (s += " " + i.properties[t].description)), s;
 }
-function d(e) {
-  var i;
-  const r = ["Body"], t = (i = e == null ? void 0 : e.schema) == null ? void 0 : i.properties;
-  return t && Object.keys(t).forEach((s) => {
-    if (!e.schema)
+function a(t) {
+  var e;
+  const i = ["Body"], s = (e = t == null ? void 0 : t.schema) == null ? void 0 : e.properties;
+  return s && Object.keys(s).forEach((r) => {
+    if (!t.schema)
       return;
-    r.push(u(s, e.schema));
-    const n = t[s];
-    n.type === "object" && !!n.properties && n.properties && Object.keys(n.properties).forEach((p) => {
-      var f, a;
-      r.push(`${p} ${(a = (f = n.properties) == null ? void 0 : f[p]) == null ? void 0 : a.type}`);
+    i.push(d(r, t.schema));
+    const n = s[r];
+    n.type === "object" && !!n.properties && n.properties && Object.keys(n.properties).forEach((f) => {
+      var u, p;
+      i.push(`${f} ${(p = (u = n.properties) == null ? void 0 : u[f]) == null ? void 0 : p.type}`);
     });
-  }), r;
+  }), i;
 }
-function x(e) {
-  var r, t;
+function D(t) {
+  var i, s;
   try {
-    const i = (t = (r = e == null ? void 0 : e.requestBody) == null ? void 0 : r.content) == null ? void 0 : t["application/json"];
-    if (!i)
+    const e = (s = (i = t == null ? void 0 : t.requestBody) == null ? void 0 : i.content) == null ? void 0 : s["application/json"];
+    if (!e)
       throw new Error("Body not found");
-    return d(i);
+    return a(e);
   } catch {
     return !1;
   }
 }
-function O(e) {
-  var t, i;
-  if (!e)
+function O(t) {
+  var s, e;
+  if (!t)
     return {};
-  const r = (
+  const i = (
     // OpenAPI 3.x
-    Object.keys(((t = e == null ? void 0 : e.components) == null ? void 0 : t.schemas) ?? {}).length ? (i = e == null ? void 0 : e.components) == null ? void 0 : i.schemas : (
+    Object.keys(((s = t == null ? void 0 : t.components) == null ? void 0 : s.schemas) ?? {}).length ? (e = t == null ? void 0 : t.components) == null ? void 0 : e.schemas : (
       // Fallback
       {}
     )
   );
-  return Object.keys(r ?? {}).forEach((s) => {
-    var n, o;
-    (((n = r[s]) == null ? void 0 : n["x-internal"]) === !0 || ((o = r[s]) == null ? void 0 : o["x-scalar-ignore"]) === !0) && delete r[s];
-  }), r;
+  return Object.keys(i ?? {}).forEach((r) => {
+    var n, c;
+    (((n = i[r]) == null ? void 0 : n["x-internal"]) === !0 || ((c = i[r]) == null ? void 0 : c["x-scalar-ignore"]) === !0) && delete i[r];
+  }), i;
 }
-function l(e, r) {
-  for (const [t, i] of Object.entries(e))
-    i !== null && typeof i == "object" ? (r[t] ?? (r[t] = new i.__proto__.constructor()), l(i, r[t])) : typeof i < "u" && (r[t] = i);
-  return r;
+function l(t, i) {
+  for (const [s, e] of Object.entries(t))
+    e !== null && typeof e == "object" ? (i[s] ?? (i[s] = new e.__proto__.constructor()), l(e, i[s])) : typeof e < "u" && (i[s] = e);
+  return i;
 }
-function E(e) {
-  return l(e ?? {}, {
+function E(t) {
+  return l(t ?? {}, {
     info: {
       title: "",
       description: "",
@@ -70,23 +71,41 @@ function E(e) {
     tags: []
   });
 }
-function b(e) {
-  return e.deprecated !== void 0 ? e.deprecated : !!(e["x-scalar-stability"] && e["x-scalar-stability"] === c.Deprecated);
+function q(t) {
+  return t.deprecated !== void 0 ? t.deprecated : !!(t["x-scalar-stability"] && t["x-scalar-stability"] === o.Deprecated);
 }
-function y(e) {
-  return e.deprecated ? c.Deprecated : e["x-scalar-stability"];
+function y(t) {
+  return t.deprecated ? o.Deprecated : t["x-scalar-stability"];
 }
-function S(e) {
-  const r = y(e);
-  return r === c.Deprecated ? "text-red" : r === c.Experimental ? "text-orange" : r === c.Stable ? "text-green" : "";
+function S(t) {
+  const i = y(t);
+  return i === o.Deprecated ? "text-red" : i === o.Experimental ? "text-orange" : i === o.Stable ? "text-green" : "";
+}
+function v(t) {
+  const i = {
+    path: [],
+    query: [],
+    header: [],
+    cookie: [],
+    body: [],
+    formData: []
+  };
+  t.pathParameters && t.pathParameters.forEach((e) => {
+    e.in === "path" ? i.path.push(e) : e.in === "query" ? i.query.push(e) : e.in === "header" ? i.header.push(e) : e.in === "cookie" ? i.cookie.push(e) : e.in === "body" ? i.body.push(e) : e.in === "formData" && i.formData.push(e);
+  });
+  const s = t.parameters ?? [];
+  return s && s.forEach((e) => {
+    h(e) && (e.in === "path" ? i.path.push(e) : e.in === "query" ? i.query.push(e) : e.in === "header" ? i.header.push(e) : e.in === "cookie" ? i.cookie.push(e) : e.in === "body" ? i.body.push(e) : e.in === "formData" && i.formData.push(e));
+  }), i;
 }
 export {
   E as createEmptySpecification,
+  v as createParameterMap,
   l as deepMerge,
-  x as extractRequestBody,
-  u as formatProperty,
+  D as extractRequestBody,
+  d as formatProperty,
   O as getModels,
   y as getOperationStability,
   S as getOperationStabilityColor,
-  b as isOperationDeprecated
+  q as isOperationDeprecated
 };

package/dist/standalone/lib/html-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"html-api.d.ts","sourceRoot":"","sources":["../../../src/standalone/lib/html-api.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,yBAAyB,EAE9B,KAAK,kBAAkB,EACxB,MAAM,6BAA6B,CAAA;AAQpC;;GAEG;AACH,wBAAgB,kCAAkC,CAAC,GAAG,EAAE,QAAQ,GAAG,yBAAyB,CA+G3F;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,yBAAyB,QAiBzF;AAID,eAAO,MAAM,eAAe,QAAS,QAAQ,YAAY,OAAO,GAAG,IAAI,mBAatE,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,EAAE,kBAwHhC,CAAA"}
+{"version":3,"file":"html-api.d.ts","sourceRoot":"","sources":["../../../src/standalone/lib/html-api.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,EAExB,MAAM,6BAA6B,CAAA;AAQpC;;GAEG;AACH,wBAAgB,kCAAkC,CAAC,GAAG,EAAE,QAAQ,GAAG,yBAAyB,CA+G3F;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,yBAAyB,QAiBzF;AAID,eAAO,MAAM,eAAe,QAAS,QAAQ,YAAY,OAAO,GAAG,IAAI,mBAatE,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,EAAE,kBAwHhC,CAAA"}

package/dist/stores/useHttpClientStore.js

@@ -19,9 +19,9 @@ function b(t, n) {
   return n.value === !0 ? [] : t.flatMap((e) => {
     var i;
     return typeof n.value != "object" ? [] : Array.isArray(n.value) ? (e.clients = e.clients.filter(
-      // @ts-expect-error Typescript, chill. It’s all good. It has to be an array.
+      // @ts-expect-error Typescript, chill. It's all good. It has to be an array.
       (s) => !n.value.includes(s.client)
-    ), e.clients.length ? [e] : []) : n.value[e.key] === !0 ? [] : (Array.isArray(n.value[e.key]) && (e.clients = e.clients.filter((s) => !// @ts-expect-error We checked whether it’s an Array already.
+    ), e.clients.length ? [e] : []) : n.value[e.key] === !0 ? [] : (Array.isArray(n.value[e.key]) && (e.clients = e.clients.filter((s) => !// @ts-expect-error We checked whether it's an Array already.
     n.value[e.key].includes(s.client))), (i = e == null ? void 0 : e.clients) != null && i.length ? [e] : []);
   });
 }