Merge branch 'main' into marc/update-to-scalar-1.13.0

elysiajs · Jan 24, 2024 · 0e3e344 · 0e3e344
2 parents 702bf43 + d8e7294
commit 0e3e344
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 28 deletions.
diff --git a/src/scalar/index.ts b/src/scalar/index.ts
@@ -1,31 +1,27 @@
 import scalarElysiaTheme from './theme'
 import type { ReferenceConfiguration } from './types'
 
-export const ScalarRender = (version: string, config: ReferenceConfiguration, scalarCDN: string) => {
-  const overrideScalarCDN = scalarCDN ? scalarCDN : `https://cdn.jsdelivr.net/npm/@scalar/api-reference@${version}/dist/browser/standalone.min.js`
-
-  return `<!doctype html>
-    <html>
-      <head>
-        <title>API Reference</title>
-        <meta charset="utf-8" />
-        <meta
-          name="viewport"
-          content="width=device-width, initial-scale=1" />
-        <style>
-          body {
-            margin: 0;
-          }
-        </style>
-        <style>
-          ${config.customCss ?? scalarElysiaTheme}
-        </style>
-      </head>
-      <body>
-        <script
-          id="api-reference"
-          data-url="${config.spec?.url}"></script>
-        <script src="${overrideScalarCDN}"></script>
-      </body>
-    </html>`
-}
+export const ScalarRender = (version: string, config: ReferenceConfiguration, cdn: string) => `<!doctype html>
+<html>
+  <head>
+    <title>API Reference</title>
+    <meta charset="utf-8" />
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1" />
+    <style>
+      body {
+        margin: 0;
+      }
+    </style>
+    <style>
+      ${config.customCss ?? scalarElysiaTheme}
+    </style>
+  </head>
+  <body>
+    <script
+      id="api-reference"
+      data-configuration="JSON.stringify(${Bun.inspect(config)})"></script>
+    <script src="${cdn ? cdn:`https://cdn.jsdelivr.net/npm/@scalar/api-reference@${version}/dist/browser/standalone.min.js`}"></script>
+  </body>
+</html>`
diff --git a/src/types.ts b/src/types.ts
@@ -31,7 +31,13 @@ export interface ElysiaSwaggerConfig<Path extends string = '/swagger'> {
     /**
      * Optional override to specifying the path for the Scalar bundle
      *
+     * Custom URL or path to locally hosted Scalar bundle 
+     *
+     * Lease blank to use default jsdeliver.net CDN
+     *
      * @default ''
+     * @example 'https://unpkg.com/@scalar/[email protected]/dist/browser/standalone.js'
+     * @example '/public/standalone.js'
      * @see https://github.com/scalar/scalar
      */
     scalarCDN?: string