@scalar/api-reference 1.36.2 → 1.38.0

package/dist/v2/blocks/scalar-request-example-block/helpers/find-client.d.ts

@@ -1,41 +0,0 @@
-import type { ClientOption, ClientOptionGroup } from '../../../../v2/blocks/scalar-request-example-block/types';
-import { type AvailableClients } from '@scalar/snippetz';
-export declare const DEFAULT_CLIENT = "shell/curl";
-/** Type guard to check if a string is a valid client id */
-export declare const isClient: (id: any) => id is AvailableClients[number];
-/**
- * Finds and returns the appropriate client option from a list of client option groups.
- *
- * This function is used to determine which client should be initially selected in the
- * request example block. It prioritizes a specific client ID if provided, otherwise
- * falls back to the first available option.
- *
- * @param options - Array of client option groups, each containing a label and array of client options
- * @param id - Optional client identifier to search for (e.g., 'js/fetch', 'python/requests')
-
- * @returns The selected client option. If a specific ID is provided and found, returns that client.
- *          If the ID is not found or not provided, returns the first available client option.
- *
- * @example
- * ```typescript
- * const clientGroups = [
- *   {
- *     label: 'JavaScript',
- *     options: [
- *       { id: 'js/fetch', label: 'Fetch API', lang: 'js' },
- *       { id: 'js/axios', label: 'Axios', lang: 'js' }
- *     ]
- *   }
- * ]
- *
- * // Find specific client
- * const client = findClient(clientGroups, 'js/fetch')
- * // Returns: { id: 'js/fetch', label: 'Fetch API', lang: 'js' }
- *
- * // Find first available client
- * const firstClient = findClient(clientGroups)
- * // Returns: { id: 'js/fetch', label: 'Fetch API', lang: 'js' }
- * ```
- */
-export declare const findClient: (clientGroups: ClientOptionGroup[], clientId?: AvailableClients[number] | undefined) => ClientOption;
-//# sourceMappingURL=find-client.d.ts.map

package/dist/v2/blocks/scalar-request-example-block/helpers/find-client.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"find-client.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/scalar-request-example-block/helpers/find-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,gDAAgD,CAAA;AACrG,OAAO,EAAqB,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAE3E,eAAO,MAAM,cAAc,eAAe,CAAA;AAE1C,2DAA2D;AAC3D,eAAO,MAAM,QAAQ,GAAI,IAAI,GAAG,KAAG,EAAE,IAAI,gBAAgB,CAAC,MAAM,CAAmC,CAAA;AAEnG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,eAAO,MAAM,UAAU,GACrB,cAAc,iBAAiB,EAAE,EACjC,WAAW,gBAAgB,CAAC,MAAM,CAAC,GAAG,SAAS,KAC9C,YAwBF,CAAA"}

package/dist/v2/blocks/scalar-request-example-block/helpers/find-client.js

@@ -1,22 +0,0 @@
-import { AVAILABLE_CLIENTS as f } from "@scalar/snippetz";
-const c = "shell/curl", d = (o) => f.includes(o), u = (o, s) => {
-  const r = o[0]?.options[0];
-  if (s)
-    for (const i of o) {
-      const t = i.options.find((n) => n.id === s);
-      if (t)
-        return t;
-    }
-  if (!r?.id.startsWith("custom"))
-    for (const i of o) {
-      const t = i.options.find((n) => n.id === c);
-      if (t)
-        return t;
-    }
-  return r;
-};
-export {
-  c as DEFAULT_CLIENT,
-  u as findClient,
-  d as isClient
-};

package/dist/v2/blocks/scalar-request-example-block/helpers/generate-client-options.d.ts

@@ -1,20 +0,0 @@
-import type { ClientOptionGroup } from '../../../../v2/blocks/scalar-request-example-block/types';
-import type { XCodeSample } from '@scalar/openapi-types/schemas/extensions';
-import type { ApiReferenceConfiguration } from '@scalar/types/api-reference';
-/** Helper to generate an ID for custom code samples */
-export declare const generateCustomId: (example: XCodeSample) => string;
-/**
- * Generates client options for the request example block by filtering and organizing
- * built-in snippets based on the hiddenClients configuration. This function creates
- * a structured list of available client options that can be used to generate code
- * examples for different programming languages and frameworks.
- *
- * The function filters built-in clients based on the hiddenClients parameter and
- * groups them by their category (e.g., JavaScript, Python, etc.). The hiddenClients
- * parameter supports multiple formats:
- * - boolean: true to hide all clients
- * - array: ['fetch', 'axios'] to hide specific clients across all categories
- * - object: { node: true, python: ['requests'] } to hide entire categories or specific clients within categories
- */
-export declare const generateClientOptions: (hiddenClients: ApiReferenceConfiguration["hiddenClients"]) => ClientOptionGroup[];
-//# sourceMappingURL=generate-client-options.d.ts.map

package/dist/v2/blocks/scalar-request-example-block/helpers/generate-client-options.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate-client-options.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/scalar-request-example-block/helpers/generate-client-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gDAAgD,CAAA;AACvF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0CAA0C,CAAA;AAE3E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAG5E,uDAAuD;AACvD,eAAO,MAAM,gBAAgB,GAAI,SAAS,WAAW,WAA6B,CAAA;AAElF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB,GAChC,eAAe,yBAAyB,CAAC,eAAe,CAAC,KACxD,iBAAiB,EAwDnB,CAAA"}

package/dist/v2/blocks/scalar-request-example-block/helpers/generate-client-options.js

@@ -1,33 +0,0 @@
-import { snippetz as l } from "@scalar/snippetz";
-import { capitalize as o } from "vue";
-const y = (t) => `custom/${t.lang}`, m = (t) => t === !0 ? [] : l().clients().flatMap((e) => {
-  const n = e.clients.flatMap((r) => {
-    const c = `${e.key}/${r.client}`;
-    if (Array.isArray(t) && t.includes(r.client))
-      return [];
-    if (typeof t == "object" && t !== null) {
-      const i = t[e.key];
-      if (i === !0)
-        return [];
-      if (Array.isArray(i) && i.includes(r.client))
-        return [];
-    }
-    return {
-      id: c,
-      lang: r.client === "curl" ? "curl" : e.key,
-      title: `${o(e.title)} ${r.title}`,
-      label: r.title,
-      targetKey: e.key,
-      targetTitle: e.title,
-      clientKey: r.client
-    };
-  });
-  return n.length === 0 ? [] : {
-    label: e.title,
-    options: n
-  };
-});
-export {
-  m as generateClientOptions,
-  y as generateCustomId
-};

package/dist/v2/blocks/scalar-request-example-block/helpers/generate-code-snippet.d.ts

@@ -1,17 +0,0 @@
-import type { AvailableClients } from '@scalar/snippetz';
-import type { HttpMethod } from '@scalar/helpers/http/http-methods';
-import type { ServerObject, OperationObject, SecuritySchemeObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
-type Props = {
-    clientId: AvailableClients[number];
-    operation: OperationObject;
-    example: unknown;
-    method: HttpMethod;
-    path: string;
-    contentType?: string | undefined;
-    server?: ServerObject | undefined;
-    securitySchemes?: SecuritySchemeObject[] | undefined;
-};
-/** Generate the code snippet for the selected example OR operation */
-export declare const generateCodeSnippet: ({ clientId, operation, method, path, example, contentType, server, securitySchemes, }: Props) => string;
-export {};
-//# sourceMappingURL=generate-code-snippet.d.ts.map

package/dist/v2/blocks/scalar-request-example-block/helpers/generate-code-snippet.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate-code-snippet.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/scalar-request-example-block/helpers/generate-code-snippet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAsB,MAAM,kBAAkB,CAAA;AAG5E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AACnE,OAAO,KAAK,EACV,YAAY,EACZ,eAAe,EACf,oBAAoB,EACrB,MAAM,8DAA8D,CAAA;AAErE,KAAK,KAAK,GAAG;IACX,QAAQ,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;IAClC,SAAS,EAAE,eAAe,CAAA;IAC1B,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,UAAU,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,MAAM,CAAC,EAAE,YAAY,GAAG,SAAS,CAAA;IACjC,eAAe,CAAC,EAAE,oBAAoB,EAAE,GAAG,SAAS,CAAA;CACrD,CAAA;AAED,sEAAsE;AACtE,eAAO,MAAM,mBAAmB,GAAI,uFASjC,KAAK,KAAG,MAmBV,CAAA"}

package/dist/v2/blocks/scalar-request-example-block/helpers/generate-code-snippet.js

@@ -1,26 +0,0 @@
-import { operationToHar as f } from "@scalar/oas-utils/helpers/operation-to-har";
-import { getSnippet as l } from "@scalar/api-client/views/Components/CodeSnippet";
-const K = ({
-  clientId: r,
-  operation: t,
-  method: o,
-  path: n,
-  example: p,
-  contentType: i,
-  server: a,
-  securitySchemes: s
-}) => {
-  const c = f({
-    operation: t,
-    contentType: i,
-    method: o,
-    path: n,
-    server: a,
-    securitySchemes: s,
-    example: p
-  }), [g, m] = r.split("/"), [e, d] = l(g, m, c);
-  return e ? e.message ?? "Error generating code snippet" : d;
-};
-export {
-  K as generateCodeSnippet
-};

package/dist/v2/blocks/scalar-request-example-block/helpers/get-secrets.d.ts

@@ -1,4 +0,0 @@
-import type { SecuritySchemeObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
-/** Extract secrets from security schemes */
-export declare const getSecrets: (securitySchemes: SecuritySchemeObject[]) => string[];
-//# sourceMappingURL=get-secrets.d.ts.map

package/dist/v2/blocks/scalar-request-example-block/helpers/get-secrets.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-secrets.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/scalar-request-example-block/helpers/get-secrets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8DAA8D,CAAA;AAGxG,4CAA4C;AAC5C,eAAO,MAAM,UAAU,GAAI,iBAAiB,oBAAoB,EAAE,KAAG,MAAM,EAqBvD,CAAA"}

package/dist/v2/blocks/scalar-request-example-block/helpers/get-secrets.js

@@ -1,10 +0,0 @@
-import { encode as e } from "js-base64";
-const l = (t) => t.flatMap((r) => r.type === "apiKey" ? r["x-scalar-secret-token"] : r?.type === "http" ? [
-  r["x-scalar-secret-token"],
-  r["x-scalar-secret-username"],
-  r["x-scalar-secret-password"],
-  e(`${r["x-scalar-secret-username"]}:${r["x-scalar-secret-password"]}`)
-] : r.type === "oauth2" ? Object.values(r.flows).map((a) => a["x-scalar-secret-token"]) : []).filter(Boolean);
-export {
-  l as getSecrets
-};

package/dist/v2/blocks/scalar-request-example-block/index.d.ts

@@ -1,3 +0,0 @@
-export { default as RequestExample } from './components/RequestExample.vue.js';
-export { default as ExamplePicker } from './components/ExamplePicker.vue.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/v2/blocks/scalar-request-example-block/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/v2/blocks/scalar-request-example-block/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,gCAAgC,CAAA"}

package/dist/v2/blocks/scalar-request-example-block/types.d.ts

@@ -1,29 +0,0 @@
-import type { ScalarComboboxOption, ScalarComboboxOptionGroup } from '@scalar/components';
-import type { AvailableClients, ClientId, TargetId } from '@scalar/snippetz';
-/**
- * Represents a client option in the request example block.
- * Extends the base combobox option with language-specific information
- * for generating code examples in different programming languages.
- */
-export type ClientOption = ScalarComboboxOption & {
-    /** A more specific ID */
-    id: AvailableClients[number];
-    /** Programming language or tool for code generation (e.g., 'javascript', 'python', 'curl') */
-    lang: TargetId | 'curl' | 'plaintext';
-    /** Title shows when the client is selected in the dropdown */
-    title: string;
-    /** Target key for the client, differs from the lang due to the curl thing */
-    targetKey: TargetId;
-    /** Title of the target */
-    targetTitle: string;
-    /** Client key for the client */
-    clientKey: ClientId<TargetId>;
-};
-/**
- * Augments the base combobox option group with ClientOptions
- */
-export type ClientOptionGroup = Omit<ScalarComboboxOptionGroup, 'options'> & {
-    /** Array of client options that belong to this group */
-    options: ClientOption[];
-};
-//# sourceMappingURL=types.d.ts.map

package/dist/v2/blocks/scalar-request-example-block/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/v2/blocks/scalar-request-example-block/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAA;AACzF,OAAO,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAE5E;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,oBAAoB,GAAG;IAChD,yBAAyB;IACzB,EAAE,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;IAC5B,8FAA8F;IAC9F,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAA;IACrC,8DAA8D;IAC9D,KAAK,EAAE,MAAM,CAAA;IACb,6EAA6E;IAC7E,SAAS,EAAE,QAAQ,CAAA;IACnB,0BAA0B;IAC1B,WAAW,EAAE,MAAM,CAAA;IACnB,gCAAgC;IAChC,SAAS,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAA;CAC9B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,yBAAyB,EAAE,SAAS,CAAC,GAAG;IAC3E,wDAAwD;IACxD,OAAO,EAAE,YAAY,EAAE,CAAA;CACxB,CAAA"}