@scalar/api-reference 1.34.1 → 1.34.4

package/dist/libs/openapi.d.ts

@@ -1,24 +1,15 @@
 import type { OpenAPI, OpenAPIV3_1 } from '@scalar/openapi-types';
 import type { ParameterObject } from '@scalar/workspace-store/schemas/v3.1/strict/parameter';
 import type { OperationObject } from '@scalar/workspace-store/schemas/v3.1/strict/path-operations';
-import type { Dereference } from '@scalar/workspace-store/schemas/v3.1/type-guard';
-type PropertyObject = {
-    required?: string[];
-    properties: {
-        [key: string]: {
-            type: string;
-            description?: string;
-        };
-    };
-};
+import type { SchemaObject } from '@scalar/workspace-store/schemas/v3.1/strict/schema';
 /**
  * Formats a property object into a string.
  */
-export declare function formatProperty(key: string, obj: PropertyObject): string;
+export declare function formatProperty(key: string, obj: SchemaObject): string;
 /**
  * Extracts the request body from an operation.
  */
-export declare function extractRequestBody(operation: Dereference<OperationObject>): string[] | boolean;
+export declare function extractRequestBody(operation: OperationObject): string[] | boolean;
 /**
  * Returns all models from the specification, no matter if it's OpenAPI 3.x.
  */
@@ -53,6 +44,5 @@ export type ParameterMap = {
  *
  * TODO: Isn't it easier to just stick to the OpenAPI structure, without transforming it?
  */
-export declare function createParameterMap(operation: Dereference<OperationObject>): ParameterMap;
-export {};
+export declare function createParameterMap(operation: OperationObject): ParameterMap;
 //# 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;AAGjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uDAAuD,CAAA;AAC5F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6DAA6D,CAAA;AAClG,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iDAAiD,CAAA;AAGlF,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,CAAC,GAAG,MAAM,EAAE,GAAG,OAAO,CAa9F;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,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,eAAe,EAAE,CAAA;IACvB,KAAK,EAAE,eAAe,EAAE,CAAA;IACxB,MAAM,EAAE,eAAe,EAAE,CAAA;IACzB,MAAM,EAAE,eAAe,EAAE,CAAA;IACzB,IAAI,EAAE,eAAe,EAAE,CAAA;IACvB,QAAQ,EAAE,eAAe,EAAE,CAAA;CAC5B,CAAA;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,WAAW,CAAC,eAAe,CAAC,gBA2DzE"}
+{"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;AAGjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uDAAuD,CAAA;AAC5F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6DAA6D,CAAA;AAGlG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oDAAoD,CAAA;AAEtF;;GAEG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,YAAY,GAAG,MAAM,CAerE;AA+BD;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,eAAe,GAAG,MAAM,EAAE,GAAG,OAAO,CAYjF;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,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,eAAe,EAAE,CAAA;IACvB,KAAK,EAAE,eAAe,EAAE,CAAA;IACxB,MAAM,EAAE,eAAe,EAAE,CAAA;IACzB,MAAM,EAAE,eAAe,EAAE,CAAA;IACzB,IAAI,EAAE,eAAe,EAAE,CAAA;IACvB,QAAQ,EAAE,eAAe,EAAE,CAAA;CAC5B,CAAA;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,eAAe,gBA2D5D"}

package/dist/libs/openapi.js

@@ -1,42 +1,60 @@
-import { isDereferenced as p } from "@scalar/openapi-types/helpers";
-function d(t, i) {
-  var s;
-  let o = t;
-  const e = (s = i.required) == null ? void 0 : s.includes(t);
-  return o += e ? " REQUIRED " : " optional ", i.properties[t] && (o += i.properties[t].type, i.properties[t].description && (o += " " + i.properties[t].description)), o;
+import { isDereferenced as h } from "@scalar/openapi-types/helpers";
+import { getResolvedRef as c } from "@scalar/workspace-store/helpers/get-resolved-ref";
+function d(i, s) {
+  var r, n;
+  let o = i;
+  const e = (r = s.required) == null ? void 0 : r.includes(i);
+  o += e ? " REQUIRED " : " optional ";
+  const t = c((n = s.properties) == null ? void 0 : n[i]);
+  return t && (o += t.type, t.description && (o += " " + t.description)), o;
 }
-function h(t) {
-  var e;
-  const i = ["Body"], o = (e = t == null ? void 0 : t.schema) == null ? void 0 : e.properties;
-  return o && Object.keys(o).forEach((s) => {
-    if (!t.schema)
+function y(i) {
+  const s = ["Body"], o = c(i == null ? void 0 : i.schema), e = o == null ? void 0 : o.properties;
+  return e && Object.keys(e).forEach((t) => {
+    if (!i.schema)
       return;
-    i.push(d(s, t.schema));
-    const r = o[s];
-    r.type === "object" && !!r.properties && r.properties && Object.keys(r.properties).forEach((n) => {
-      var c, f;
-      i.push(`${n} ${(f = (c = r.properties) == null ? void 0 : c[n]) == null ? void 0 : f.type}`);
+    s.push(d(t, o));
+    const r = c(e[t]);
+    r.type === "object" && !!r.properties && r.properties && Object.keys(r.properties).forEach((f) => {
+      var p, u;
+      s.push(`${f} ${(u = c((p = r.properties) == null ? void 0 : p[f])) == null ? void 0 : u.type}`);
     });
-  }), i;
+  }), s;
 }
-function q(t) {
-  var i, o;
+function q(i) {
+  var s, o;
   try {
-    const e = (o = (i = t == null ? void 0 : t.requestBody) == null ? void 0 : i.content) == null ? void 0 : o["application/json"];
+    const e = (o = (s = c(i == null ? void 0 : i.requestBody)) == null ? void 0 : s.content) == null ? void 0 : o["application/json"];
     if (!e)
       throw new Error("Body not found");
-    return h(e);
+    return y(e);
   } catch {
     return !1;
   }
 }
-function u(t, i) {
-  for (const [o, e] of Object.entries(t))
-    e !== null && typeof e == "object" ? (i[o] ?? (i[o] = new e.__proto__.constructor()), u(e, i[o])) : typeof e < "u" && (i[o] = e);
-  return i;
+function a(i) {
+  var o, e;
+  if (!i)
+    return {};
+  const s = (
+    // OpenAPI 3.x
+    Object.keys(((o = i == null ? void 0 : i.components) == null ? void 0 : o.schemas) ?? {}).length ? (e = i == null ? void 0 : i.components) == null ? void 0 : e.schemas : (
+      // Fallback
+      {}
+    )
+  );
+  return Object.keys(s ?? {}).forEach((t) => {
+    var r, n;
+    (((r = s[t]) == null ? void 0 : r["x-internal"]) === !0 || ((n = s[t]) == null ? void 0 : n["x-scalar-ignore"]) === !0) && delete s[t];
+  }), s;
 }
-function E(t) {
-  return u(t ?? {}, {
+function l(i, s) {
+  for (const [o, e] of Object.entries(i))
+    e !== null && typeof e == "object" ? (s[o] ?? (s[o] = new e.__proto__.constructor()), l(e, s[o])) : typeof e < "u" && (s[o] = e);
+  return s;
+}
+function b(i) {
+  return l(i ?? {}, {
     info: {
       title: "",
       description: "",
@@ -54,23 +72,24 @@ function E(t) {
     tags: []
   });
 }
-function O(t) {
-  const i = {
+function v(i) {
+  const s = {
     path: [],
     query: [],
     header: [],
     cookie: [],
     body: [],
     formData: []
-  }, o = t.parameters ?? [];
+  }, o = i.parameters ?? [];
   return o && o.forEach((e) => {
-    p(e) && (typeof e == "object" && e !== null && "$ref" in 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;
+    h(e) && (typeof e == "object" && e !== null && "$ref" in e || (e.in === "path" ? s.path.push(e) : e.in === "query" ? s.query.push(e) : e.in === "header" ? s.header.push(e) : e.in === "cookie" ? s.cookie.push(e) : e.in === "body" ? s.body.push(e) : e.in === "formData" && s.formData.push(e)));
+  }), s;
 }
 export {
-  E as createEmptySpecification,
-  O as createParameterMap,
-  u as deepMerge,
+  b as createEmptySpecification,
+  v as createParameterMap,
+  l as deepMerge,
   q as extractRequestBody,
-  d as formatProperty
+  d as formatProperty,
+  a as getModels
 };