@scalar/api-reference 1.31.17 → 1.32.0

package/dist/libs/openapi.d.ts

@@ -1,5 +1,4 @@
 import type { OpenAPI, OpenAPIV3_1 } from '@scalar/openapi-types';
-import type { Spec, TransformedOperation } from '@scalar/types/legacy';
 import { XScalarStability } from '@scalar/types/legacy';
 type PropertyObject = {
     required?: string[];
@@ -17,19 +16,19 @@ export declare function formatProperty(key: string, obj: PropertyObject): string
 /**
  * Extracts the request body from an operation.
  */
-export declare function extractRequestBody(operation: TransformedOperation): string[] | boolean;
+export declare function extractRequestBody(operation: OpenAPIV3_1.OperationObject): string[] | boolean;
 /**
  * Returns all models from the specification, no matter if it’s OpenAPI 3.x.
  */
-export declare function getModels(spec?: Spec): Record<string, OpenAPIV3_1.SchemaObject>;
+export declare function getModels(document?: OpenAPIV3_1.Document): Record<string, OpenAPIV3_1.SchemaObject>;
 /**
  * Checks if the OpenAPI document has schemas.
  */
-export declare const hasModels: (content?: Spec) => boolean;
+export declare const hasModels: (content?: OpenAPIV3_1.Document) => boolean;
 /**
  * Checks if the OpenAPI document has webhooks.
  */
-export declare const hasWebhooks: (content?: Spec) => boolean;
+export declare const hasWebhooks: (document?: OpenAPIV3_1.Document) => boolean;
 /**
  * Deep merge for objects
  */
@@ -38,7 +37,7 @@ export declare function deepMerge(source: Record<any, any>, target: Record<any,
  * Creates an empty specification object.
  * The returning object has the same structure as a valid OpenAPI specification, but everything is empty.
  */
-export declare function createEmptySpecification(partialSpecification?: Partial<OpenAPI.Document>): Spec;
+export declare function createEmptySpecification(partialSpecification?: Partial<OpenAPI.Document>): OpenAPI.Document;
 /**
  * Returns if an operation is considered deprecated.
  */

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,KAAK,EAAE,IAAI,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AACtE,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,oBAAoB,GAAG,MAAM,EAAE,GAAG,OAAO,CAYtF;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,4CAsBpC;AAED;;GAEG;AACH,eAAO,MAAM,SAAS,aAAc,IAAI,YAUvC,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,WAAW,aAAc,IAAI,YAUzC,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,IAAI,CACX;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;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"}

package/dist/libs/openapi.js

@@ -1,58 +1,57 @@
-import { XScalarStability as o } from "@scalar/types/legacy";
-function p(e, t) {
-  var n;
-  let r = e;
-  const i = (n = t.required) == null ? void 0 : n.includes(e);
-  return r += i ? " REQUIRED " : " optional ", t.properties[e] && (r += t.properties[e].type, t.properties[e].description && (r += " " + t.properties[e].description)), r;
+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;
 }
 function d(e) {
   var i;
-  const t = ["Body"], r = (i = e == null ? void 0 : e.schema) == null ? void 0 : i.properties;
-  return r && Object.keys(r).forEach((n) => {
+  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)
       return;
-    t.push(p(n, e.schema));
-    const s = r[n];
-    s.type === "object" && !!s.properties && s.properties && Object.keys(s.properties).forEach((u) => {
-      var a, f;
-      t.push(`${u} ${(f = (a = s.properties) == null ? void 0 : a[u]) == null ? void 0 : f.type}`);
+    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}`);
     });
-  }), t;
+  }), r;
 }
-function O(e) {
-  var t, r, i;
+function x(e) {
+  var r, t;
   try {
-    const n = (i = (r = (t = e == null ? void 0 : e.information) == null ? void 0 : t.requestBody) == null ? void 0 : r.content) == null ? void 0 : i["application/json"];
-    if (!n)
+    const i = (t = (r = e == null ? void 0 : e.requestBody) == null ? void 0 : r.content) == null ? void 0 : t["application/json"];
+    if (!i)
       throw new Error("Body not found");
-    return d(n);
+    return d(i);
   } catch {
     return !1;
   }
 }
-function y(e) {
-  var r, i;
+function O(e) {
+  var t, i;
   if (!e)
     return {};
-  const t = (
+  const r = (
     // OpenAPI 3.x
-    Object.keys(((r = e == null ? void 0 : e.components) == null ? void 0 : r.schemas) ?? {}).length ? (i = e == null ? void 0 : e.components) == null ? void 0 : i.schemas : (
+    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 : (
       // Fallback
       {}
     )
   );
-  return Object.keys(t ?? {}).forEach((n) => {
-    var s, c;
-    (((s = t[n]) == null ? void 0 : s["x-internal"]) === !0 || ((c = t[n]) == null ? void 0 : c["x-scalar-ignore"]) === !0) && delete t[n];
-  }), t;
+  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;
 }
-const x = (e) => e ? !!Object.keys(y(e) ?? {}).length : !1;
-function l(e, t) {
-  for (const [r, i] of Object.entries(e))
-    i !== null && typeof i == "object" ? (t[r] ??= new i.__proto__.constructor(), l(i, t[r])) : typeof i < "u" && (t[r] = i);
-  return t;
+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 g(e) {
+function E(e) {
   return l(e ?? {}, {
     info: {
       title: "",
@@ -72,23 +71,22 @@ function g(e) {
   });
 }
 function b(e) {
-  return e.deprecated !== void 0 ? e.deprecated : !!(e["x-scalar-stability"] && e["x-scalar-stability"] === o.Deprecated);
+  return e.deprecated !== void 0 ? e.deprecated : !!(e["x-scalar-stability"] && e["x-scalar-stability"] === c.Deprecated);
 }
-function m(e) {
-  return e.deprecated ? o.Deprecated : e["x-scalar-stability"];
+function y(e) {
+  return e.deprecated ? c.Deprecated : e["x-scalar-stability"];
 }
-function E(e) {
-  const t = m(e);
-  return t === o.Deprecated ? "text-red" : t === o.Experimental ? "text-orange" : t === o.Stable ? "text-green" : "";
+function S(e) {
+  const r = y(e);
+  return r === c.Deprecated ? "text-red" : r === c.Experimental ? "text-orange" : r === c.Stable ? "text-green" : "";
 }
 export {
-  g as createEmptySpecification,
+  E as createEmptySpecification,
   l as deepMerge,
-  O as extractRequestBody,
-  p as formatProperty,
-  y as getModels,
-  m as getOperationStability,
-  E as getOperationStabilityColor,
-  x as hasModels,
+  x as extractRequestBody,
+  u as formatProperty,
+  O as getModels,
+  y as getOperationStability,
+  S as getOperationStabilityColor,
   b as isOperationDeprecated
 };