@scalar/express-api-reference 0.9.3 → 0.9.5

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @scalar/express-api-reference
 
+## 0.9.5
+
+## 0.9.4
+
+### Patch Changes
+
+- [#8466](https://github.com/scalar/scalar/pull/8466): chore: new build pipeline
+
 ## 0.9.3
 
 ### Patch Changes

package/dist/apiReference.js

@@ -1,17 +1,21 @@
-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: "express"
+    _integration: 'express',
 };
-function apiReference(givenConfiguration) {
-  const configuration = {
-    ...DEFAULT_CONFIGURATION,
-    ...givenConfiguration
-  };
-  return (_, res) => {
-    res.type("text/html").send(getHtmlDocument(configuration));
-  };
+/**
+ * The route handler to render the Scalar API Reference.
+ */
+export function apiReference(givenConfiguration) {
+    // Merge the defaults
+    const configuration = {
+        ...DEFAULT_CONFIGURATION,
+        ...givenConfiguration,
+    };
+    // Respond with the HTML document
+    return (_, res) => {
+        res.type('text/html').send(getHtmlDocument(configuration));
+    };
 }
-export {
-  apiReference
-};
-//# sourceMappingURL=apiReference.js.map

package/dist/apiReference.test.js

@@ -0,0 +1,83 @@
+import express from 'express';
+import request from 'supertest';
+import { describe, expect, it } from 'vitest';
+import { apiReference } from './apiReference.js';
+describe('apiReference', () => {
+    it('should handle missing spec content gracefully', async () => {
+        const app = express();
+        const options = {
+            cdn: 'https://cdn.example.com',
+        };
+        app.use(apiReference(options));
+        const response = await request(app).get('/');
+        expect(response.status).toBe(200);
+        expect(response.type).toBe('text/html');
+        expect(response.text).toContain('<title>Scalar API Reference</title>');
+        expect(response.text).toContain('https://cdn.example.com');
+        // Ensure no undefined content
+        expect(response.text).not.toContain('undefined');
+    });
+    it('should use default CDN when no CDN is provided', async () => {
+        const app = express();
+        const options = {
+            content: { info: { title: 'Test API' } },
+        };
+        app.use(apiReference(options));
+        const response = await request(app).get('/');
+        expect(response.status).toBe(200);
+        expect(response.type).toBe('text/html');
+        expect(response.text).toContain('<title>Scalar API Reference</title>');
+        expect(response.text).toContain('https://cdn.jsdelivr.net/npm/@scalar/api-reference');
+    });
+    it('does not have the content twice', async () => {
+        const app = express();
+        app.use(apiReference({ content: { info: { title: 'Test API' } } }));
+        const response = await request(app).get('/');
+        expect(response.status).toBe(200);
+        // Check the title is present
+        expect(response.text).toContain('Test API');
+        // Check that the title is only present once
+        const text = response.text;
+        const titleCount = (text.match(/Test API/g) || []).length;
+        expect(titleCount).toBe(1);
+    });
+    it('keeps the URL in the configuration', async () => {
+        const app = express();
+        app.use(apiReference({
+            url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=json',
+        }));
+        const response = await request(app).get('/');
+        // Check the URL is present
+        expect(response.text).toContain('https://registry.scalar.com/@scalar/apis/galaxy?format=json');
+    });
+    it('includes _integration: "express" in configuration', async () => {
+        const app = express();
+        app.use(apiReference({}));
+        const response = await request(app).get('/');
+        expect(response.text).toContain('"_integration": "express"');
+    });
+    it('handles content as function', async () => {
+        const app = express();
+        const contentFn = () => ({ info: { title: 'Function API' } });
+        app.use(apiReference({ content: contentFn }));
+        const response = await request(app).get('/');
+        expect(response.text).toContain('Function API');
+    });
+    it('removes spec.content when spec.url is provided', async () => {
+        const app = express();
+        app.use(apiReference({
+            url: 'https://example.com/api.json',
+            content: { info: { title: 'Test API' } },
+        }));
+        const response = await request(app).get('/');
+        expect(response.text).toContain('https://example.com/api.json');
+        expect(response.text).not.toContain('Test API');
+    });
+    it('sets correct content type and status', async () => {
+        const app = express();
+        app.use(apiReference({}));
+        const response = await request(app).get('/');
+        expect(response.status).toBe(200);
+        expect(response.type).toBe('text/html');
+    });
+});

package/dist/index.js

@@ -1,5 +1 @@
-import { apiReference } from "./apiReference.js";
-export {
-  apiReference
-};
-//# sourceMappingURL=index.js.map
+export { apiReference } from './apiReference.js';

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/express"
   },
-  "version": "0.9.3",
+  "version": "0.9.5",
   "engines": {
     "node": ">=22"
   },
@@ -45,7 +45,7 @@
     "documentation": "https://scalar.com/products/api-references/integrations/express"
   },
   "dependencies": {
-    "@scalar/core": "0.4.3"
+    "@scalar/core": "0.4.5"
   },
   "devDependencies": {
     "@types/express": "5.0.3",
@@ -54,22 +54,16 @@
     "express": "5.1.0",
     "supertest": "7.2.2",
     "swagger-jsdoc": "^6.2.8",
-    "vite": "^7.3.1",
-    "vitest": "4.0.16",
-    "@scalar/build-tooling": "0.5.0"
+    "vite": "8.0.0",
+    "vitest": "4.1.0"
   },
   "scripts": {
-    "build": "scalar-build-esbuild",
+    "build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",
     "build:playground": "cd playground && pnpm build",
-    "dev": "nodemon --exec \"vite-node playground/index.ts\" --watch playground --ext ts --quiet",
+    "dev": "tsx watch playground/index.ts",
     "docker:build": "docker build --build-arg BASE_IMAGE=scalar-base -t express-api-reference -f Dockerfile .",
     "docker:run": "docker run -p 5055:5055 express-api-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/apiReference.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../src/apiReference.ts"],
-  "sourcesContent": ["import { getHtmlDocument } from '@scalar/core/libs/html-rendering'\nimport type { RequestHandler } from 'express'\n\nimport type { ApiReferenceConfiguration } from './types'\n\n/**\n * The default configuration for the API Reference.\n */\nconst DEFAULT_CONFIGURATION: Partial<ApiReferenceConfiguration> = {\n  _integration: 'express',\n}\n\n/**\n * The route handler to render the Scalar API Reference.\n */\nexport function apiReference(givenConfiguration: Partial<ApiReferenceConfiguration>): RequestHandler<never, string> {\n  // Merge the defaults\n  const configuration = {\n    ...DEFAULT_CONFIGURATION,\n    ...givenConfiguration,\n  }\n\n  // Respond with the HTML document\n  return (_, res) => {\n    res.type('text/html').send(getHtmlDocument(configuration))\n  }\n}\n"],
-  "mappings": "AAAA,SAAS,uBAAuB;AAQhC,MAAM,wBAA4D;AAAA,EAChE,cAAc;AAChB;AAKO,SAAS,aAAa,oBAAuF;AAElH,QAAM,gBAAgB;AAAA,IACpB,GAAG;AAAA,IACH,GAAG;AAAA,EACL;AAGA,SAAO,CAAC,GAAG,QAAQ;AACjB,QAAI,KAAK,WAAW,EAAE,KAAK,gBAAgB,aAAa,CAAC;AAAA,EAC3D;AACF;",
-  "names": []
-}

package/dist/index.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../src/index.ts"],
-  "sourcesContent": ["export { apiReference } from './apiReference'\nexport type { ApiReferenceConfiguration } from './types'\n"],
-  "mappings": "AAAA,SAAS,oBAAoB;",
-  "names": []
-}

package/dist/types.js.map

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