@scalar/hono-api-reference 0.10.2 → 0.10.4

package/dist/index.js

@@ -1,6 +1,6 @@
-import { Scalar } from "./scalar.js";
-export {
-  Scalar,
-  Scalar as apiReference
-};
-//# sourceMappingURL=index.js.map
+import { Scalar } from './scalar.js';
+export { Scalar, 
+/**
+ * @deprecated Use `Scalar` instead.
+ */
+Scalar as apiReference, };

package/dist/scalar.js

@@ -1,7 +1,13 @@
-import { getHtmlDocument } from "@scalar/core/libs/html-rendering";
+import { getHtmlDocument } from '@scalar/core/libs/html-rendering';
+/**
+ * The default configuration for the API Reference.
+ */
 const DEFAULT_CONFIGURATION = {
-  _integration: "hono"
+    _integration: 'hono',
 };
+/**
+ * The custom theme for Hono
+ */
 const customTheme = `
 .dark-mode {
   color-scheme: dark;
@@ -53,22 +59,24 @@ const customTheme = `
   --scalar-sidebar-search-color: var(--scalar-color-3);
 }
 `;
-const Scalar = (configOrResolver) => {
-  return async (c) => {
-    let resolvedConfig = {};
-    if (typeof configOrResolver === "function") {
-      resolvedConfig = await configOrResolver(c);
-    } else {
-      resolvedConfig = configOrResolver;
-    }
-    const configuration = {
-      ...DEFAULT_CONFIGURATION,
-      ...resolvedConfig
+/**
+ * The Hono middleware for the Scalar API Reference.
+ */
+export const Scalar = (configOrResolver) => {
+    return async (c) => {
+        let resolvedConfig = {};
+        if (typeof configOrResolver === 'function') {
+            resolvedConfig = await configOrResolver(c);
+        }
+        else {
+            resolvedConfig = configOrResolver;
+        }
+        // Merge the defaults
+        const configuration = {
+            ...DEFAULT_CONFIGURATION,
+            ...resolvedConfig,
+        };
+        // Respond with the HTML document
+        return c.html(getHtmlDocument(configuration, customTheme));
     };
-    return c.html(getHtmlDocument(configuration, customTheme));
-  };
 };
-export {
-  Scalar
-};
-//# sourceMappingURL=scalar.js.map

package/dist/scalar.test.js

@@ -0,0 +1,209 @@
+import { Hono } from 'hono';
+import { afterEach, describe, expect, it, vi } from 'vitest';
+import { Scalar } from './scalar.js';
+describe('Scalar', () => {
+    afterEach(() => {
+        vi.useRealTimers();
+    });
+    it('returns HTML with default theme CSS when theme is not provided', async () => {
+        const app = new Hono();
+        const config = {
+            cdn: 'https://cdn.example.com',
+            content: { info: { title: 'Test API' } },
+        };
+        app.get('/', Scalar(config));
+        const response = await app.request('/');
+        expect(response.status).toBe(200);
+        expect(response.headers.get('content-type')).toContain('text/html');
+        const text = await response.text();
+        expect(text).toContain('<title>Scalar API Reference</title>');
+        expect(text).toContain('https://cdn.example.com');
+        expect(text).toContain('Test API');
+        expect(text).toContain('--scalar-color-1: rgba(255, 255, 245, .86);');
+    });
+    it('excludes default theme CSS when theme is provided', async () => {
+        const app = new Hono();
+        app.get('/', Scalar({
+            content: { info: { title: 'Test API' } },
+            theme: 'kepler',
+            cdn: 'https://cdn.example.com',
+        }));
+        const response = await app.request('/');
+        expect(response.status).toBe(200);
+        expect(response.headers.get('content-type')).toContain('text/html');
+        const text = await response.text();
+        expect(text).toContain('<title>Scalar API Reference</title>');
+        expect(text).toContain('https://cdn.example.com');
+        expect(text).toContain('Test API');
+        // Ensure default theme CSS is not included
+        expect(text).not.toContain('--scalar-color-1');
+    });
+    it('handles missing spec content gracefully', async () => {
+        const app = new Hono();
+        const options = {
+            cdn: 'https://cdn.example.com',
+        };
+        app.get('/', Scalar(options));
+        const response = await app.request('/');
+        expect(response.status).toBe(200);
+        expect(response.headers.get('content-type')).toContain('text/html');
+        const text = await response.text();
+        expect(text).toContain('<title>Scalar API Reference</title>');
+        expect(text).toContain('https://cdn.example.com');
+        // Ensure no undefined content
+        expect(text).not.toContain('undefined');
+    });
+    it('uses default CDN when CDN is not provided', async () => {
+        const app = new Hono();
+        const options = {
+            content: { info: { title: 'Test API' } },
+        };
+        app.get('/', Scalar(options));
+        const response = await app.request('/');
+        expect(response.status).toBe(200);
+        expect(response.headers.get('content-type')).toContain('text/html');
+        const text = await response.text();
+        expect(text).toContain('<title>Scalar API Reference</title>');
+        expect(text).toContain('https://cdn.jsdelivr.net/npm/@scalar/api-reference');
+    });
+    it('includes content only once', async () => {
+        const app = new Hono();
+        app.get('/', Scalar({ content: { info: { title: 'Test API' } } }));
+        const response = await app.request('/');
+        expect(response.status).toBe(200);
+        const text = await response.text();
+        // Check the title is present
+        expect(text).toContain('Test API');
+        // Check that the title is only present once
+        const titleCount = (text.match(/Test API/g) || []).length;
+        expect(titleCount).toBe(1);
+    });
+    it('preserves URL in configuration', async () => {
+        const app = new Hono();
+        app.get('/', Scalar({
+            url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=json',
+        }));
+        const response = await app.request('/');
+        const text = await response.text();
+        // Check the URL is present
+        expect(text).toContain('https://registry.scalar.com/@scalar/apis/galaxy?format=json');
+    });
+    it('applies custom theme CSS without theme specified', async () => {
+        const app = new Hono();
+        app.get('/', Scalar({}));
+        const response = await app.request('/');
+        const text = await response.text();
+        expect(text).toContain('--scalar-color-1: rgba(255, 255, 245, .86);');
+        expect(text).toContain('--scalar-color-accent: #e36002');
+    });
+    it('excludes custom theme CSS when theme is specified', async () => {
+        const app = new Hono();
+        app.get('/', Scalar({ theme: 'none' }));
+        const response = await app.request('/');
+        const text = await response.text();
+        expect(text).not.toContain('--scalar-color-1: rgba(255, 255, 245, .86);');
+    });
+    it('includes hono integration in configuration', async () => {
+        const app = new Hono();
+        app.get('/', Scalar({}));
+        const response = await app.request('/');
+        const text = await response.text();
+        expect(text).toContain('_integration": "hono"');
+    });
+    it('handles content as function', async () => {
+        const app = new Hono();
+        const contentFn = () => ({ info: { title: 'Function API' } });
+        app.get('/', Scalar({ content: contentFn }));
+        const response = await app.request('/');
+        const text = await response.text();
+        expect(text).toContain('Function API');
+    });
+    it('removes content when URL is provided', async () => {
+        const app = new Hono();
+        app.get('/', Scalar({
+            url: 'https://example.com/api.json',
+            content: { info: { title: 'Test API' } },
+        }));
+        const response = await app.request('/');
+        const text = await response.text();
+        expect(text).toContain('https://example.com/api.json');
+        expect(text).not.toContain('Test API');
+    });
+    it('sets HTML content type and 200 status', async () => {
+        const app = new Hono();
+        app.get('/', Scalar({}));
+        const response = await app.request('/');
+        expect(response.status).toBe(200);
+        expect(response.headers.get('content-type')).toContain('text/html');
+    });
+    it('works with the deprecated export', async () => {
+        const app = new Hono();
+        const config = {
+            cdn: 'https://cdn.example.com',
+            content: { info: { title: 'Test API' } },
+        };
+        app.get('/', Scalar(config));
+        const response = await app.request('/');
+        expect(response.status).toBe(200);
+        expect(response.headers.get('content-type')).toContain('text/html');
+        const text = await response.text();
+        expect(text).toContain('<title>Scalar API Reference</title>');
+        expect(text).toContain('https://cdn.example.com');
+        expect(text).toContain('Test API');
+        expect(text).toContain('--scalar-color-1: rgba(255, 255, 245, .86);');
+    });
+    it('works with config resolver', async () => {
+        const app = new Hono();
+        // mock env
+        app.use('*', (c, next) => {
+            c.env = { SOME_VAR: 'SOME_VAR', ENVIRONMENT: 'development' };
+            return next();
+        });
+        const config = { content: { info: { title: 'Test API' } } };
+        app.get('/', Scalar((c) => {
+            expect(c.env.SOME_VAR).toBe('SOME_VAR');
+            expect(c.env.ENVIRONMENT).toBe('development');
+            return {
+                ...config,
+                proxyUrl: c.env.ENVIRONMENT === 'development' ? 'https://proxy.scalar.com' : undefined,
+            };
+        }));
+        const response = await app.request('/');
+        expect(response.status).toBe(200);
+        expect(response.headers.get('content-type')).toContain('text/html');
+        const text = await response.text();
+        expect(text).toContain('<title>Scalar API Reference</title>');
+        expect(text).toContain('Test API');
+        expect(text).toContain('https://proxy.scalar.com');
+    });
+    it('works with config resolver (async)', async () => {
+        vi.useFakeTimers();
+        const app = new Hono();
+        // mock env
+        app.use('*', (c, next) => {
+            c.env = { SOME_VAR: 'SOME_VAR', ENVIRONMENT: 'development' };
+            return next();
+        });
+        const config = { content: { info: { title: 'Test API' } } };
+        app.get('/', Scalar(async (c) => {
+            expect(c.env.SOME_VAR).toBe('SOME_VAR');
+            expect(c.env.ENVIRONMENT).toBe('development');
+            const theme = await new Promise((resolve) => {
+                setTimeout(() => resolve('deepSpace'), 
+                // advance time by the same amount below
+                100);
+            });
+            return { ...config, theme };
+        }));
+        const req = app.request('/');
+        // Same time of handler Promise above
+        vi.advanceTimersByTime(100);
+        const response = await req;
+        expect(response.status).toBe(200);
+        expect(response.headers.get('content-type')).toContain('text/html');
+        const text = await response.text();
+        expect(text).toContain('<title>Scalar API Reference</title>');
+        expect(text).toContain('Test API');
+        expect(text).toContain('deepSpace');
+    });
+});

package/dist/types.js

@@ -1 +1 @@
-//# sourceMappingURL=types.js.map
+export {};

package/package.json

@@ -10,7 +10,7 @@
     "url": "git+https://github.com/scalar/scalar.git",
     "directory": "integrations/hono"
   },
-  "version": "0.10.2",
+  "version": "0.10.4",
   "engines": {
     "node": ">=22"
   },
@@ -44,31 +44,25 @@
     "documentation": "https://scalar.com/products/api-references/integrations/hono"
   },
   "dependencies": {
-    "@scalar/core": "0.4.2"
+    "@scalar/core": "0.4.4"
   },
   "devDependencies": {
     "@hono/node-server": "^1.19.7",
     "@hono/zod-openapi": "^1.2.0",
     "hono": "4.12.4",
-    "vite": "^7.3.1",
-    "vitest": "4.0.16",
-    "@scalar/build-tooling": "0.5.0",
-    "@scalar/openapi-to-markdown": "0.4.4"
+    "vite": "8.0.0",
+    "vitest": "4.1.0",
+    "@scalar/openapi-to-markdown": "0.4.10"
   },
   "peerDependencies": {
     "hono": "^4.12.5"
   },
   "scripts": {
-    "build": "scalar-build-esbuild",
-    "dev": "nodemon --exec \"vite-node playground/index.ts\" --ext ts --quiet --watch ./",
+    "build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",
+    "dev": "tsx watch playground/index.ts",
     "docker:build": "docker buildx build --platform=linux/amd64 -t scalar-hono-reference --build-arg=\"BASE_IMAGE=scalar-base\" .",
     "docker:run": "docker run -t scalar-hono-reference",
-    "format": "scalar-format",
-    "format:check": "scalar-format-check",
-    "lint:check": "scalar-lint-check",
-    "lint:fix": "scalar-lint-fix",
     "test": "vitest",
-    "types:build": "scalar-types-build",
-    "types:check": "scalar-types-check"
+    "types:check": "tsc --noEmit"
   }
 }

package/dist/index.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../src/index.ts"],
-  "sourcesContent": ["import { Scalar } from './scalar'\n\nexport {\n  Scalar,\n  /**\n   * @deprecated Use `Scalar` instead.\n   */\n  Scalar as apiReference,\n}\n\nexport type { ApiReferenceConfiguration } from './types'\n"],
-  "mappings": "AAAA,SAAS,cAAc;",
-  "names": []
-}

package/dist/scalar.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../src/scalar.ts"],
-  "sourcesContent": ["import { getHtmlDocument } from '@scalar/core/libs/html-rendering'\nimport type { Context, Env, MiddlewareHandler } from 'hono'\n\nimport type { ApiReferenceConfiguration } from './types'\n\n/**\n * The default configuration for the API Reference.\n */\nconst DEFAULT_CONFIGURATION: Partial<ApiReferenceConfiguration> = {\n  _integration: 'hono',\n}\n\n/**\n * The custom theme for Hono\n */\nconst customTheme = `\n.dark-mode {\n  color-scheme: dark;\n  --scalar-color-1: rgba(255, 255, 245, .86);\n  --scalar-color-2: rgba(255, 255, 245, .6);\n  --scalar-color-3: rgba(255, 255, 245, .38);\n  --scalar-color-disabled: rgba(255, 255, 245, .25);\n  --scalar-color-ghost: rgba(255, 255, 245, .25);\n  --scalar-color-accent: #e36002;\n  --scalar-background-1: #1e1e20;\n  --scalar-background-2: #2a2a2a;\n  --scalar-background-3: #505053;\n  --scalar-background-4: rgba(255, 255, 255, 0.06);\n  --scalar-background-accent: #e360021f;\n\n  --scalar-border-color: rgba(255, 255, 255, 0.1);\n  --scalar-scrollbar-color: rgba(255, 255, 255, 0.24);\n  --scalar-scrollbar-color-active: rgba(255, 255, 255, 0.48);\n  --scalar-lifted-brightness: 1.45;\n  --scalar-backdrop-brightness: 0.5;\n\n  --scalar-shadow-1: 0 1px 3px 0 rgb(0, 0, 0, 0.1);\n  --scalar-shadow-2: rgba(15, 15, 15, 0.2) 0px 3px 6px,\n    rgba(15, 15, 15, 0.4) 0px 9px 24px, 0 0 0 1px rgba(255, 255, 255, 0.1);\n\n  --scalar-button-1: #f6f6f6;\n  --scalar-button-1-color: #000;\n  --scalar-button-1-hover: #e7e7e7;\n\n  --scalar-color-green: #3dd68c;\n  --scalar-color-red: #f66f81;\n  --scalar-color-yellow: #f9b44e;\n  --scalar-color-blue: #5c73e7;\n  --scalar-color-orange: #ff8d4d;\n  --scalar-color-purple: #b191f9;\n}\n/* Sidebar */\n.dark-mode .sidebar {\n  --scalar-sidebar-background-1: #161618;\n  --scalar-sidebar-item-hover-color: var(--scalar-color-accent);\n  --scalar-sidebar-item-hover-background: transparent;\n  --scalar-sidebar-item-active-background: transparent;\n  --scalar-sidebar-border-color: transparent;\n  --scalar-sidebar-color-1: var(--scalar-color-1);\n  --scalar-sidebar-color-2: var(--scalar-color-2);\n  --scalar-sidebar-color-active: var(--scalar-color-accent);\n  --scalar-sidebar-search-background: #252529;\n  --scalar-sidebar-search-border-color: transparent;\n  --scalar-sidebar-search-color: var(--scalar-color-3);\n}\n`\n\ntype Configuration<E extends Env> =\n  | Partial<ApiReferenceConfiguration>\n  | ((c: Context<E>) => Partial<ApiReferenceConfiguration> | Promise<Partial<ApiReferenceConfiguration>>)\n\n/**\n * The Hono middleware for the Scalar API Reference.\n */\nexport const Scalar = <E extends Env>(configOrResolver: Configuration<E>): MiddlewareHandler<E> => {\n  return async (c) => {\n    let resolvedConfig: Partial<ApiReferenceConfiguration> = {}\n\n    if (typeof configOrResolver === 'function') {\n      resolvedConfig = await configOrResolver(c)\n    } else {\n      resolvedConfig = configOrResolver\n    }\n\n    // Merge the defaults\n    const configuration = {\n      ...DEFAULT_CONFIGURATION,\n      ...resolvedConfig,\n    }\n\n    // Respond with the HTML document\n    return c.html(getHtmlDocument(configuration, customTheme))\n  }\n}\n"],
-  "mappings": "AAAA,SAAS,uBAAuB;AAQhC,MAAM,wBAA4D;AAAA,EAChE,cAAc;AAChB;AAKA,MAAM,cAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA2Db,MAAM,SAAS,CAAgB,qBAA6D;AACjG,SAAO,OAAO,MAAM;AAClB,QAAI,iBAAqD,CAAC;AAE1D,QAAI,OAAO,qBAAqB,YAAY;AAC1C,uBAAiB,MAAM,iBAAiB,CAAC;AAAA,IAC3C,OAAO;AACL,uBAAiB;AAAA,IACnB;AAGA,UAAM,gBAAgB;AAAA,MACpB,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAGA,WAAO,EAAE,KAAK,gBAAgB,eAAe,WAAW,CAAC;AAAA,EAC3D;AACF;",
-  "names": []
-}

package/dist/types.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": [],
-  "sourcesContent": [],
-  "mappings": "",
-  "names": []
-}