@scalar/api-reference 1.34.1 → 1.34.4

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

@@ -1,29 +1,26 @@
-import { operationToHar as u } from "@scalar/oas-utils/helpers/operation-to-har";
-import { isReference as d } from "@scalar/workspace-store/schemas/v3.1/type-guard";
+import { operationToHar as f } from "@scalar/oas-utils/helpers/operation-to-har";
 import { getSnippet as l } from "@scalar/api-client/views/Components/CodeSnippet";
-const S = ({
-  clientId: t,
-  operation: e,
+const K = ({
+  clientId: r,
+  operation: t,
   method: o,
   path: n,
-  example: i,
-  contentType: p,
-  server: s,
-  securitySchemes: a
+  example: p,
+  contentType: i,
+  server: a,
+  securitySchemes: s
 }) => {
-  if (d(e))
-    return "";
-  const c = u({
-    operation: e,
-    contentType: p,
+  const c = f({
+    operation: t,
+    contentType: i,
     method: o,
     path: n,
-    server: s,
-    securitySchemes: a,
-    example: i
-  }), [m, f] = t.split("/"), [r, g] = l(m, f, c);
-  return r ? r.message ?? "Error generating code snippet" : g;
+    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 {
-  S as generateCodeSnippet
+  K as generateCodeSnippet
 };

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

@@ -1 +1 @@
-{"version":3,"file":"get-secrets.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/scalar-request-example-block/helpers/get-secrets.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,6DAA6D,CAAA;AAEvG,4CAA4C;AAC5C,eAAO,MAAM,UAAU,oBAAqB,oBAAoB,EAAE,KAqBxC,MAAM,EAAE,CAAA"}
+{"version":3,"file":"get-secrets.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/scalar-request-example-block/helpers/get-secrets.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,6DAA6D,CAAA;AAEvG,4CAA4C;AAC5C,eAAO,MAAM,UAAU,oBAAqB,oBAAoB,EAAE,KAAG,MAAM,EAqBrD,CAAA"}

package/dist/v2/helpers/map-configuration.d.ts

@@ -0,0 +1,66 @@
+import type { ApiReferenceConfiguration } from '@scalar/types';
+/**
+ * Maps a partial ApiReferenceConfigurationWithSources object to a DocumentConfiguration
+ * for use in the API Reference. This function transforms configuration options
+ * into the expected structure for the 'x-scalar-reference-config' property.
+ *
+ * @param config - Partial configuration object for the API Reference
+ * @returns DocumentConfiguration object with mapped settings
+ */
+export declare const mapConfiguration: (config: Partial<ApiReferenceConfiguration>) => {
+    'x-scalar-reference-config': {
+        title: string | undefined;
+        slug: string | undefined;
+        features: {
+            showModels: boolean;
+            expandAllTagSections: boolean | undefined;
+            persistAuthenticationState: boolean | undefined;
+            showDarkModeToggle: boolean;
+            showDownload: boolean;
+            showSearch: boolean;
+            showSidebar: boolean | undefined;
+            showTestRequestButton: boolean;
+        };
+        appearance: {
+            css: string | undefined;
+            favicon: string | undefined;
+            forceColorMode: "dark" | "light" | undefined;
+            initialColorMode: "dark" | undefined;
+            layout: "modern" | "classic" | undefined;
+            loadDefaultFonts: boolean | undefined;
+            theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "laserwave" | "none" | undefined;
+        };
+        routing: {
+            basePath: string | undefined;
+        };
+        settings: {
+            proxyUrl: string | undefined;
+            searchKey: "a" | "b" | "i" | "p" | "q" | "s" | "u" | "g" | "c" | "r" | "d" | "e" | "f" | "h" | "j" | "k" | "l" | "m" | "n" | "o" | "t" | "v" | "w" | "x" | "y" | "z" | undefined;
+            baseServerUrl: string | undefined;
+            servers: any[] | undefined;
+        };
+        meta: any;
+        tagSort: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
+        operationsSorter: "alpha" | "method" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
+        generateHeadingSlug: ((args_0: {
+            slug?: string | undefined;
+        }, ...args: unknown[]) => string) | undefined;
+        generateModelSlug: ((args_0: {
+            name?: string | undefined;
+        }, ...args: unknown[]) => string) | undefined;
+        generateOperationSlug: ((args_0: {
+            path: string;
+            method: string;
+            operationId?: string | undefined;
+            summary?: string | undefined;
+        }, ...args: unknown[]) => string) | undefined;
+        generateTagSlug: ((args_0: {
+            name?: string | undefined;
+        }, ...args: unknown[]) => string) | undefined;
+        generateWebhookSlug: ((args_0: {
+            name: string;
+            method?: string | undefined;
+        }, ...args: unknown[]) => string) | undefined;
+    };
+};
+//# sourceMappingURL=map-configuration.d.ts.map

package/dist/v2/helpers/map-configuration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"map-configuration.d.ts","sourceRoot":"","sources":["../../../src/v2/helpers/map-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAA;AAG9D;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,WAAY,OAAO,CAAC,yBAAyB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBAiD65yC,CAAC;;;gBAAyH,CAAC;;;;;uBAA0S,CAAC;mBAAqC,CAAC;;;gBAA1N,CAAC;;;;kBAA4W,CAAC;;;CADvk0C,CAAA"}

package/dist/v2/helpers/map-configuration.js

@@ -0,0 +1,53 @@
+const a = (e) => {
+  var t;
+  return {
+    "x-scalar-reference-config": {
+      title: e.title,
+      slug: e.slug,
+      features: {
+        // Feature toggles for UI elements and behaviors
+        showModels: !e.hideModels,
+        expandAllTagSections: e.defaultOpenAllTags,
+        persistAuthenticationState: e.persistAuth,
+        showDarkModeToggle: !e.hideDarkModeToggle,
+        showDownload: !e.hideDownloadButton,
+        showSearch: !e.hideSearch,
+        showSidebar: e.showSidebar,
+        showTestRequestButton: !e.hideTestRequestButton
+      },
+      appearance: {
+        // Appearance-related configuration
+        css: e.customCss,
+        favicon: e.favicon,
+        forceColorMode: e.forceDarkModeState,
+        initialColorMode: e.darkMode ? "dark" : void 0,
+        layout: e.layout,
+        loadDefaultFonts: e.withDefaultFonts,
+        theme: e.theme
+      },
+      routing: {
+        // Routing configuration
+        basePath: (t = e.pathRouting) == null ? void 0 : t.basePath
+      },
+      settings: {
+        // Miscellaneous settings
+        proxyUrl: e.proxyUrl,
+        searchKey: e.searchHotKey,
+        baseServerUrl: e.baseServerURL,
+        servers: e.servers
+      },
+      meta: e.metaData,
+      // In memory configuration
+      tagSort: e.tagsSorter,
+      operationsSorter: e.operationsSorter,
+      generateHeadingSlug: e.generateHeadingSlug,
+      generateModelSlug: e.generateModelSlug,
+      generateOperationSlug: e.generateOperationSlug,
+      generateTagSlug: e.generateTagSlug,
+      generateWebhookSlug: e.generateWebhookSlug
+    }
+  };
+};
+export {
+  a as mapConfiguration
+};

package/dist/vitest.setup.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=vitest.setup.d.ts.map

package/dist/vitest.setup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vitest.setup.d.ts","sourceRoot":"","sources":["../src/vitest.setup.ts"],"names":[],"mappings":""}

package/package.json

@@ -20,7 +20,7 @@
     "vue",
     "vue3"
   ],
-  "version": "1.34.1",
+  "version": "1.34.4",
   "engines": {
     "node": ">=20"
   },
@@ -55,28 +55,32 @@
     "vue": "^3.5.17",
     "zod": "3.24.1",
     "@scalar/code-highlight": "0.1.9",
-    "@scalar/helpers": "0.0.7",
-    "@scalar/api-client": "2.5.22",
-    "@scalar/icons": "0.4.6",
-    "@scalar/components": "0.14.23",
-    "@scalar/object-utils": "1.2.3",
-    "@scalar/openapi-parser": "0.19.0",
+    "@scalar/components": "0.14.25",
+    "@scalar/api-client": "2.5.24",
+    "@scalar/helpers": "0.0.8",
+    "@scalar/icons": "0.4.7",
+    "@scalar/oas-utils": "0.4.20",
+    "@scalar/object-utils": "1.2.4",
+    "@scalar/json-magic": "0.3.0",
+    "@scalar/snippetz": "0.4.5",
+    "@scalar/openapi-parser": "0.20.0",
+    "@scalar/types": "0.2.12",
+    "@scalar/themes": "0.13.13",
+    "@scalar/use-hooks": "0.2.4",
     "@scalar/openapi-types": "0.3.7",
-    "@scalar/oas-utils": "0.4.18",
-    "@scalar/types": "0.2.11",
-    "@scalar/snippetz": "0.4.4",
     "@scalar/use-toasts": "0.8.0",
-    "@scalar/use-hooks": "0.2.4",
-    "@scalar/workspace-store": "0.12.0",
-    "@scalar/themes": "0.13.12"
+    "@scalar/workspace-store": "0.14.0"
   },
   "devDependencies": {
+    "@hono/node-server": "^1.11.0",
+    "@playwright/test": "1.54.0",
     "@tailwindcss/vite": "^4.1.7",
     "@types/react": "^19.1.8",
     "@types/react-dom": "^19.1.6",
     "@vitejs/plugin-vue": "^5.2.4",
     "@vue/server-renderer": "^3.5.17",
     "@vue/test-utils": "^2.4.1",
+    "hono": "^4.6.5",
     "react": "^19.1.0",
     "react-dom": "^19.1.0",
     "rollup-plugin-webpack-stats": "^0.2.5",
@@ -85,13 +89,10 @@
     "vite-plugin-banner": "^0.7.1",
     "vite-plugin-css-injected-by-js": "^3.4.0",
     "vitest": "^3.2.4",
-    "@hono/node-server": "^1.11.0",
-    "@playwright/test": "^1.49.1",
-    "hono": "^4.6.5",
-    "@scalar/build-tooling": "0.2.4",
-    "@scalar/react-renderer": "0.2.1",
-    "@scalar/galaxy": "0.5.5",
-    "@scalar/core": "0.3.11"
+    "@scalar/build-tooling": "0.2.6",
+    "@scalar/core": "0.3.13",
+    "@scalar/galaxy": "0.5.7",
+    "@scalar/react-renderer": "0.2.1"
   },
   "scripts": {
     "build": "pnpm build:default && pnpm build:standalone && pnpm types:build && tsc-alias -p tsconfig.build.json",
@@ -109,6 +110,9 @@
     "test": "vitest",
     "test:e2e": "playwright test",
     "test:e2e:ui": "playwright test --ui",
+    "test:e2e:snapshots": "PW_TEST_CONNECT_WS_ENDPOINT=ws://127.0.0.1:5001/ playwright test -c playwright.snapshots.config.ts",
+    "test:e2e:playwright": "docker-compose -f test-snapshots/compose.yml up",
+    "test:e2e:report": "playwright show-report",
     "types:build": "scalar-types-build-vue",
     "types:check": "scalar-types-check-vue"
   }