@scalar/api-reference 1.28.33 → 1.29.1

package/dist/legacy/fixtures/index.d.ts

@@ -1,2 +1,2 @@
-export * from './httpRequestMethods.js';
+export { validRequestMethods, type RequestMethod, requestMethodColors, requestMethodAbbreviations, } from './httpRequestMethods.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/legacy/fixtures/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/legacy/fixtures/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/legacy/fixtures/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,KAAK,aAAa,EAClB,mBAAmB,EACnB,0BAA0B,GAC3B,MAAM,sBAAsB,CAAA"}

package/dist/legacy/helpers/index.d.ts

@@ -1,2 +1,2 @@
-export * from './normalizeRequestMethod.js';
+export { normalizeRequestMethod } from './normalizeRequestMethod.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/legacy/helpers/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/legacy/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/legacy/helpers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA"}

package/dist/libs/download.d.ts

@@ -0,0 +1,9 @@
+export declare const downloadEventBus: import("@vueuse/core").UseEventBusReturn<{
+    id: string;
+    filename?: string;
+}, any>;
+/**
+ * Trigger the download of the OpenAPI document
+ */
+export declare function downloadDocument(content: string, filename?: string): void;
+//# sourceMappingURL=download.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../../src/libs/download.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,gBAAgB;QADgB,MAAM;eAAa,MAAM;OACN,CAAA;AAEhE;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,QAkClE"}

package/dist/libs/download.js

@@ -0,0 +1,19 @@
+import { isJsonString as d } from "@scalar/oas-utils/helpers";
+import { useEventBus as m } from "@vueuse/core";
+const r = Symbol("download"), p = m(r);
+function b(e, n) {
+  const t = d(e), c = t ? new Blob([e], { type: "application/json" }) : new Blob([e], { type: "application/x-yaml" }), s = URL.createObjectURL(c), a = t ? ".json" : ".yaml", l = "openapi" + a, i = n ? n + a : l, o = document.createElement("a");
+  o.href = s, o.download = i, o.dispatchEvent(
+    new MouseEvent("click", {
+      bubbles: !0,
+      cancelable: !0,
+      view: window
+    })
+  ), setTimeout(() => {
+    window.URL.revokeObjectURL(s), o.remove();
+  }, 100);
+}
+export {
+  b as downloadDocument,
+  p as downloadEventBus
+};

package/dist/{helpers/getLowestHeadingLevel.d.ts → libs/markdown.d.ts}

@@ -1,4 +1,8 @@
 import type { Heading } from '@scalar/types/legacy';
+/**
+ * Extracts all headings from a Markdown string.
+ */
+export declare function getHeadingsFromMarkdown(input: string): Heading[];
 export type HeadingLevels = 1 | 2 | 3 | 4 | 5 | 6;
 /**
  * Returns the lowest heading level from a list of headings.
@@ -6,4 +10,4 @@ export type HeadingLevels = 1 | 2 | 3 | 4 | 5 | 6;
  * If there are h1, h2, h3 … h1 is the lowest heading level.
  */
 export declare const getLowestHeadingLevel: (headings: Heading[]) => HeadingLevels;
-//# sourceMappingURL=getLowestHeadingLevel.d.ts.map
+//# sourceMappingURL=markdown.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../src/libs/markdown.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAWnD;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,CAMhE;AAED,MAAM,MAAM,aAAa,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;AAEjD;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,aAAc,OAAO,EAAE,KAAG,aAQ3D,CAAA"}

package/dist/libs/markdown.js

@@ -0,0 +1,18 @@
+import { getHeadings as r } from "@scalar/code-highlight/markdown";
+import o from "github-slugger";
+const s = (n, e) => n.map((t) => ({
+  ...t,
+  slug: e.slug(t.value)
+}));
+function i(n) {
+  const e = new o(), t = r(n);
+  return s(t, e);
+}
+const l = (n) => {
+  const e = Math.min(...n.map((t) => t.depth));
+  return e >= 1 && e <= 6 ? e : 1;
+};
+export {
+  i as getHeadingsFromMarkdown,
+  l as getLowestHeadingLevel
+};

package/dist/libs/openapi.d.ts

@@ -0,0 +1,56 @@
+import type { Operation } from '@scalar/oas-utils/entities/spec';
+import type { OpenAPI, OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from '@scalar/openapi-types';
+import type { Spec, TransformedOperation } from '@scalar/types/legacy';
+import { XScalarStability } from '@scalar/types/legacy';
+type PropertyObject = {
+    required?: string[];
+    properties: {
+        [key: string]: {
+            type: string;
+            description?: string;
+        };
+    };
+};
+/**
+ * Formats a property object into a string.
+ */
+export declare function formatProperty(key: string, obj: PropertyObject): string;
+/**
+ * Extracts the request body from an operation.
+ */
+export declare function extractRequestBody(operation: TransformedOperation): string[] | boolean;
+/**
+ * Returns all models from the specification, no matter if it’s Swagger 2.0 or OpenAPI 3.x.
+ */
+export declare function getModels(spec?: Spec): Record<string, OpenAPIV3_1.SchemaObject> | OpenAPIV2.DefinitionsObject | Record<string, OpenAPIV3.SchemaObject>;
+/**
+ * Checks if the OpenAPI document has schemas.
+ */
+export declare const hasModels: (content?: Spec) => boolean;
+/**
+ * Checks if the OpenAPI document has webhooks.
+ */
+export declare const hasWebhooks: (content?: Spec) => boolean;
+/**
+ * Deep merge for objects
+ */
+export declare function deepMerge(source: Record<any, any>, target: Record<any, any>): Record<any, 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;
+/**
+ * Returns if an operation is considered deprecated.
+ */
+export declare function isOperationDeprecated(operation: Pick<Operation, 'deprecated' | 'x-scalar-stability'>): boolean;
+/**
+ * Get operation stability.
+ */
+export declare function getOperationStability(operation: Pick<Operation, 'deprecated' | 'x-scalar-stability'>): XScalarStability | undefined;
+/**
+ * Get Operation stability color
+ */
+export declare function getOperationStabilityColor(operation: Pick<Operation, 'deprecated' | 'x-scalar-stability'>): string;
+export {};
+//# sourceMappingURL=openapi.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"openapi.d.ts","sourceRoot":"","sources":["../../src/libs/openapi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAA;AAChE,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACvF,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,mHAyBpC;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,GAqBjF,IAAI,CACX;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,YAAY,GAAG,oBAAoB,CAAC,GAAG,OAAO,CAQ9G;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,YAAY,GAAG,oBAAoB,CAAC,GAC9D,gBAAgB,GAAG,SAAS,CAK9B;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,YAAY,GAAG,oBAAoB,CAAC,GAAG,MAAM,CAYlH"}

package/dist/libs/openapi.js

@@ -0,0 +1,102 @@
+import { XScalarStability as o } from "@scalar/types/legacy";
+function l(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;
+}
+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) => {
+    if (!e.schema)
+      return;
+    t.push(l(n, e.schema));
+    const s = r[n];
+    s.type === "object" && !!s.properties && s.properties && Object.keys(s.properties).forEach((u) => {
+      var f, c;
+      t.push(`${u} ${(c = (f = s.properties) == null ? void 0 : f[u]) == null ? void 0 : c.type}`);
+    });
+  }), t;
+}
+function O(e) {
+  var t, r, i;
+  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)
+      throw new Error("Body not found");
+    return d(n);
+  } catch {
+    return !1;
+  }
+}
+function p(e) {
+  var r, i;
+  if (!e)
+    return {};
+  const t = (
+    // 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 : (
+      // Swagger 2.0
+      Object.keys((e == null ? void 0 : e.definitions) ?? {}).length ? e == null ? void 0 : e.definitions : (
+        // Fallback
+        {}
+      )
+    )
+  );
+  return Object.keys(t ?? {}).forEach((n) => {
+    var s;
+    ((s = t[n]) == null ? void 0 : s["x-internal"]) === !0 && delete t[n];
+  }), t;
+}
+const b = (e) => e ? !!Object.keys(p(e) ?? {}).length : !1, x = (e) => e ? !!Object.keys((e == null ? void 0 : e.webhooks) ?? {}).length : !1;
+function a(e, t) {
+  for (const [r, i] of Object.entries(e))
+    i !== null && typeof i == "object" ? (t[r] ?? (t[r] = new i.__proto__.constructor()), a(i, t[r])) : typeof i < "u" && (t[r] = i);
+  return t;
+}
+function E(e) {
+  return a(e ?? {}, {
+    info: {
+      title: "",
+      description: "",
+      termsOfService: "",
+      version: "",
+      license: {
+        name: "",
+        url: ""
+      },
+      contact: {
+        email: ""
+      }
+    },
+    externalDocs: {
+      description: "",
+      url: ""
+    },
+    servers: [],
+    tags: []
+  });
+}
+function S(e) {
+  return e.deprecated !== void 0 ? e.deprecated : !!(e["x-scalar-stability"] && e["x-scalar-stability"] === o.Deprecated);
+}
+function h(e) {
+  return e.deprecated ? o.Deprecated : e["x-scalar-stability"];
+}
+function g(e) {
+  const t = h(e);
+  return t === o.Deprecated ? "text-red" : t === o.Experimental ? "text-orange" : t === o.Stable ? "text-green" : "";
+}
+export {
+  E as createEmptySpecification,
+  a as deepMerge,
+  O as extractRequestBody,
+  l as formatProperty,
+  p as getModels,
+  h as getOperationStability,
+  g as getOperationStabilityColor,
+  b as hasModels,
+  x as hasWebhooks,
+  S as isOperationDeprecated
+};