@scalar/api-reference 1.33.0 → 1.34.0

package/dist/libs/openapi.d.ts

@@ -1,4 +1,7 @@
 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: {
@@ -15,7 +18,7 @@ export declare function formatProperty(key: string, obj: PropertyObject): string
 /**
  * Extracts the request body from an operation.
  */
-export declare function extractRequestBody(operation: OpenAPIV3_1.OperationObject): string[] | boolean;
+export declare function extractRequestBody(operation: Dereference<OperationObject>): string[] | boolean;
 /**
  * Returns all models from the specification, no matter if it's OpenAPI 3.x.
  */
@@ -38,18 +41,18 @@ export declare function deepMerge(source: Record<any, any>, target: Record<any,
  */
 export declare function createEmptySpecification(partialSpecification?: Partial<OpenAPI.Document>): OpenAPI.Document;
 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[];
+    path: ParameterObject[];
+    query: ParameterObject[];
+    header: ParameterObject[];
+    cookie: ParameterObject[];
+    body: ParameterObject[];
+    formData: 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 declare function createParameterMap(operation: Dereference<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;AAKjE,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,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"}
+{"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"}

package/dist/libs/openapi.js

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