@scalar/api-reference 1.28.33 → 1.29.1

package/dist/helpers/hasWebhooks.js

@@ -1,4 +0,0 @@
-const t = (r) => r ? !!Object.keys((r == null ? void 0 : r.webhooks) ?? {}).length : !1;
-export {
-  t as hasWebhooks
-};

package/dist/helpers/index.d.ts

@@ -1,17 +0,0 @@
-export * from './createEmptySpecification.js';
-export * from './deepMerge.js';
-export * from './getHeadingsFromMarkdown.js';
-export * from './getLowestHeadingLevel.js';
-export * from './getModels.js';
-export * from './getVariableNames';
-export * from './hasModels.js';
-export * from './hasSecuritySchemes';
-export * from './hasWebhooks.js';
-export * from './isMacOs.js';
-export * from './mapFromObject';
-export * from './mergeAllObjects';
-export * from './parse.js';
-export * from './scrollToId.js';
-export * from './sleep.js';
-export * from './specDownloads.js';
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAA;AAC1C,cAAc,aAAa,CAAA;AAC3B,cAAc,2BAA2B,CAAA;AACzC,cAAc,yBAAyB,CAAA;AACvC,cAAc,aAAa,CAAA;AAC3B,cAAc,oBAAoB,CAAA;AAClC,cAAc,aAAa,CAAA;AAC3B,cAAc,sBAAsB,CAAA;AACpC,cAAc,eAAe,CAAA;AAC7B,cAAc,WAAW,CAAA;AACzB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,SAAS,CAAA;AACvB,cAAc,cAAc,CAAA;AAC5B,cAAc,SAAS,CAAA;AACvB,cAAc,iBAAiB,CAAA"}

package/dist/helpers/isMacOs.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"isMacOs.d.ts","sourceRoot":"","sources":["../../src/helpers/isMacOs.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,OAAO,eAAoF,CAAA"}

package/dist/helpers/mapFromObject.d.ts

@@ -1,8 +0,0 @@
-/**
- * Map an object to an array of key-value pairs.
- */
-export declare const mapFromObject: (object: Record<string, any>, keyName?: string) => {
-    [keyName: string]: any;
-    value: any;
-}[];
-//# sourceMappingURL=mapFromObject.d.ts.map

package/dist/helpers/mapFromObject.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"mapFromObject.d.ts","sourceRoot":"","sources":["../../src/helpers/mapFromObject.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,aAAa,WAChB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,YACjB,MAAM,KACf;IACD,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAA;IACtB,KAAK,EAAE,GAAG,CAAA;CACX,EAOA,CAAA"}

package/dist/helpers/mergeAllObjects.d.ts

@@ -1,5 +0,0 @@
-/**
- * Merges an array of objects into a single object.
- */
-export declare const mergeAllObjects: (items: Record<any, any>[]) => any;
-//# sourceMappingURL=mergeAllObjects.d.ts.map

package/dist/helpers/mergeAllObjects.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"mergeAllObjects.d.ts","sourceRoot":"","sources":["../../src/helpers/mergeAllObjects.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,eAAe,UAAW,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,KAAG,GAO3D,CAAA"}

package/dist/helpers/scrollToId.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"scrollToId.d.ts","sourceRoot":"","sources":["../../src/helpers/scrollToId.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,UAAU,OAAc,MAAM,UAAU,OAAO,kBAS3D,CAAA"}

package/dist/helpers/specDownloads.d.ts

@@ -1,7 +0,0 @@
-export declare const downloadSpecBus: import("@vueuse/core").UseEventBusReturn<{
-    id: string;
-    specTitle?: string;
-}, any>;
-/** Download the OAS file string */
-export declare function downloadSpecFile(spec: string, specTitle?: string): void;
-//# sourceMappingURL=specDownloads.d.ts.map

package/dist/helpers/specDownloads.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"specDownloads.d.ts","sourceRoot":"","sources":["../../src/helpers/specDownloads.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,eAAe;QADqB,MAAM;gBAAc,MAAM;OACR,CAAA;AAEnE,mCAAmC;AACnC,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,QAiChE"}

package/dist/helpers/specDownloads.js

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

package/dist/helpers/specHelpers.d.ts

@@ -1,16 +0,0 @@
-import type { Operation } from '@scalar/types/legacy';
-import type { ContentSchema } from '../types';
-type PropertyObject = {
-    required?: string[];
-    properties: {
-        [key: string]: {
-            type: string;
-            description?: string;
-        };
-    };
-};
-declare function formatProperty(key: string, obj: PropertyObject): string;
-declare function recursiveLogger(obj: ContentSchema): string[];
-declare function extractRequestBody(operation: Operation): string[] | boolean;
-export { formatProperty, recursiveLogger, extractRequestBody };
-//# sourceMappingURL=specHelpers.d.ts.map

package/dist/helpers/specHelpers.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"specHelpers.d.ts","sourceRoot":"","sources":["../../src/helpers/specHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAErD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAE7C,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,iBAAS,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,cAAc,GAAG,MAAM,CAchE;AAED,iBAAS,eAAe,CAAC,GAAG,EAAE,aAAa,GAAG,MAAM,EAAE,CAuBrD;AAED,iBAAS,kBAAkB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,EAAE,GAAG,OAAO,CAYpE;AAED,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,kBAAkB,EAAE,CAAA"}

package/dist/helpers/specHelpers.js

@@ -1,36 +0,0 @@
-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 f(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)
-      return;
-    r.push(u(s, e.schema));
-    const p = t[s];
-    p.type === "object" && !!p.properties && p.properties && Object.keys(p.properties).forEach((o) => {
-      var c, n;
-      r.push(`${o} ${(n = (c = p.properties) == null ? void 0 : c[o]) == null ? void 0 : n.type}`);
-    });
-  }), r;
-}
-function a(e) {
-  var r, t, i;
-  try {
-    const s = (i = (t = (r = e == null ? void 0 : e.information) == null ? void 0 : r.requestBody) == null ? void 0 : t.content) == null ? void 0 : i["application/json"];
-    if (!s)
-      throw new Error("Body not found");
-    return f(s);
-  } catch {
-    return !1;
-  }
-}
-export {
-  a as extractRequestBody,
-  u as formatProperty,
-  f as recursiveLogger
-};

package/dist/helpers/waitFor.d.ts

@@ -1,5 +0,0 @@
-/**
- * Wait for a condition to be met
- */
-export declare const waitFor: (checkFn: () => boolean, timeout?: number, interval?: number) => Promise<void>;
-//# sourceMappingURL=waitFor.d.ts.map

package/dist/helpers/waitFor.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"waitFor.d.ts","sourceRoot":"","sources":["../../src/helpers/waitFor.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,OAAO,YAAmB,MAAM,OAAO,0CAAkC,OAAO,CAAC,IAAI,CAgBjG,CAAA"}

package/dist/hooks/index.d.ts

@@ -1,5 +0,0 @@
-export * from './useNavState.js';
-export * from './useOperation.js';
-export * from './useReactiveSpec.js';
-export * from './useSidebar.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/hooks/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,mBAAmB,CAAA;AACjC,cAAc,cAAc,CAAA"}

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

@@ -1,5 +0,0 @@
-/**
- * Encodes a given string as Base64. In Node.js (Buffer) and Browser environments (btoa).
- */
-export declare function encodeStringAsBase64(value: string): string;
-//# sourceMappingURL=encodeStringAsBase64.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"encodeStringAsBase64.d.ts","sourceRoot":"","sources":["../../../src/legacy/helpers/encodeStringAsBase64.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,UAQjD"}

package/dist/legacy/index.d.ts

@@ -1,5 +0,0 @@
-export * from './fixtures';
-export * from './helpers';
-export * from './stores';
-export * from './types';
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/legacy/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA"}

package/dist/legacy/types.d.ts

@@ -1,94 +0,0 @@
-import type { BaseParameter } from '@scalar/types/legacy';
-export type Header = BaseParameter;
-export type Query = BaseParameter;
-export type Cookie = BaseParameter;
-export type FormDataItem = BaseParameter;
-export type GeneratedParameter = {
-    name: string;
-    value: string;
-};
-/** Complete request state for a client request */
-export type ClientRequestConfig = {
-    id?: string;
-    name?: string;
-    url: string;
-    /** HTTP Request Method */
-    type: string;
-    /** Request path */
-    path: string;
-    /** Variables */
-    variables?: BaseParameter[];
-    /** Query parameters */
-    query?: Query[];
-    /** Cookies */
-    cookies?: Cookie[];
-    /** Request headers */
-    headers?: Header[];
-    /** Content type matched body */
-    body?: string;
-    /** Optional form data body */
-    formData?: FormDataItem[];
-};
-/** Formatted request for the proxy server */
-export type ProxyPayload = {
-    method: string;
-    url: string;
-    body: string;
-    headers: Header[];
-    auth: Record<string, string>;
-    grpc: boolean;
-};
-/** Client response from the proxy */
-export type ClientResponse = {
-    cookies: Record<string, string>;
-    headers: Record<string, string>;
-    statusCode: number;
-    statusText: string;
-    data: string;
-    query: Record<string, any>;
-    duration: number;
-};
-export type SendRequestConfig = Partial<ClientRequestConfig> & Required<Pick<ClientRequestConfig, 'url'>>;
-export type RequestResult = {
-    request: ClientRequestConfig;
-    response: ClientResponse;
-    responseId: string;
-    sentTime: number;
-};
-export type Schema = {
-    format: string;
-    type: string;
-};
-export type Security = Record<string, any>;
-export type ContentProperties = {
-    [key: string]: {
-        type: string;
-        format: string;
-        example: string;
-        required: string[];
-        description?: string;
-        properties?: ContentProperties;
-    };
-};
-export type ContentSchemaSchema = {
-    type: string;
-    required: string[];
-    properties: ContentProperties;
-};
-export type ContentSchema = {
-    schema: ContentSchemaSchema;
-};
-export type ContentType = 'application/json' | 'application/xml' | 'text/plain' | 'text/html' | 'application/x-www-form-urlencoded' | 'multipart/form-data';
-export type Content = {
-    [key in ContentType]: ContentSchema;
-};
-export type RequestBody = {
-    description: string;
-    content: Content;
-    required: boolean;
-};
-export type Response = {
-    description: string;
-    content: any;
-};
-//# sourceMappingURL=types.d.ts.map

package/dist/legacy/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/legacy/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AAEzD,MAAM,MAAM,MAAM,GAAG,aAAa,CAAA;AAElC,MAAM,MAAM,KAAK,GAAG,aAAa,CAAA;AAEjC,MAAM,MAAM,MAAM,GAAG,aAAa,CAAA;AAElC,MAAM,MAAM,YAAY,GAAG,aAAa,CAAA;AAExC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,kDAAkD;AAClD,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;IACX,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,gBAAgB;IAChB,SAAS,CAAC,EAAE,aAAa,EAAE,CAAA;IAC3B,uBAAuB;IACvB,KAAK,CAAC,EAAE,KAAK,EAAE,CAAA;IACf,cAAc;IACd,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,gCAAgC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;CAC1B,CAAA;AAED,6CAA6C;AAC7C,MAAM,MAAM,YAAY,GAAG;IACzB,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC5B,IAAI,EAAE,OAAO,CAAA;CACd,CAAA;AAED,qCAAqC;AACrC,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC1B,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC,CAAA;AAEzG,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,mBAAmB,CAAA;IAC5B,QAAQ,EAAE,cAAc,CAAA;IACxB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAE1C,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,MAAM,CAAA;QACd,OAAO,EAAE,MAAM,CAAA;QACf,QAAQ,EAAE,MAAM,EAAE,CAAA;QAClB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,UAAU,CAAC,EAAE,iBAAiB,CAAA;KAC/B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,UAAU,EAAE,iBAAiB,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,mBAAmB,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,WAAW,GACnB,kBAAkB,GAClB,iBAAiB,GACjB,YAAY,GACZ,WAAW,GACX,mCAAmC,GACnC,qBAAqB,CAAA;AAEzB,MAAM,MAAM,OAAO,GAAG;KACnB,GAAG,IAAI,WAAW,GAAG,aAAa;CACpC,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,GAAG,CAAA;CACb,CAAA"}

package/dist/libs/operation.d.ts

@@ -1,15 +0,0 @@
-import type { Operation } from '@scalar/oas-utils/entities/spec';
-import { XScalarStability } from '@scalar/types/legacy';
-/**
- * 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;
-//# sourceMappingURL=operation.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../src/libs/operation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAA;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAEvD;;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/operation.js

@@ -1,16 +0,0 @@
-import { XScalarStability as e } from "@scalar/types/legacy";
-function n(t) {
-  return t.deprecated !== void 0 ? t.deprecated : !!(t["x-scalar-stability"] && t["x-scalar-stability"] === e.Deprecated);
-}
-function i(t) {
-  return t.deprecated ? e.Deprecated : t["x-scalar-stability"];
-}
-function c(t) {
-  const r = i(t);
-  return r === e.Deprecated ? "text-red" : r === e.Experimental ? "text-orange" : r === e.Stable ? "text-green" : "";
-}
-export {
-  i as getOperationStability,
-  c as getOperationStabilityColor,
-  n as isOperationDeprecated
-};

package/dist/stores/index.d.ts

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

package/dist/stores/index.d.ts.map

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