@scalar/express-api-reference 0.4.184 → 0.4.186

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # @scalar/express-api-reference
 
+## 0.4.186
+
+### Patch Changes
+
+- Updated dependencies [4db5161]
+  - @scalar/api-reference@1.25.124
+  - @scalar/types@0.0.36
+
+## 0.4.185
+
+### Patch Changes
+
+- 01882e5: fix: cloudbuild not running latest integrations
+- 43031e7: feat: new lib/html-rendering in @scalar/api-reference
+- Updated dependencies [50388ea]
+- Updated dependencies [43031e7]
+- Updated dependencies [946a5df]
+- Updated dependencies [b22f554]
+- Updated dependencies [c10bbf5]
+- Updated dependencies [0ba190a]
+- Updated dependencies [4f7b767]
+- Updated dependencies [78f0cdf]
+- Updated dependencies [bd70ab6]
+- Updated dependencies [577602f]
+- Updated dependencies [875ee2c]
+- Updated dependencies [cf14cbb]
+- Updated dependencies [e55bfd2]
+  - @scalar/api-reference@1.25.123
+  - @scalar/types@0.0.35
+
 ## 0.4.184
 
 ### Patch Changes

package/dist/apiReference.d.ts

@@ -1,11 +1,11 @@
-import type { ApiReferenceOptions } from './types';
+import type { ApiReferenceConfiguration } from './types';
 import type { Request, Response } from 'express';
 /**
- * The custom theme CSS for the Express theme.
+ * The custom theme CSS for the Express theme
  */
 export declare const customTheme = "\n/* basic theme */\n.light-mode {\n  --scalar-color-1: #353535;\n  --scalar-color-2: #555555;\n  --scalar-color-3: #aeaeae;\n  --scalar-color-accent: #259dff;\n\n  --scalar-background-1: #fff;\n  --scalar-background-2: #f7f7f7;\n  --scalar-background-3: #dadada;\n  --scalar-background-accent: #E0F5FF;\n\n  --scalar-border-color: rgba(0, 0, 0, 0.1);\n}\n.dark-mode {\n  --scalar-color-1: rgba(255, 255, 255, 0.9);\n  --scalar-color-2: rgba(255, 255, 255, 0.62);\n  --scalar-color-3: rgba(255, 255, 255, 0.44);\n  --scalar-color-accent: #8ab4f8;\n\n  --scalar-background-1: #1a1a1a;\n  --scalar-background-2: #252525;\n  --scalar-background-3: #323232;\n  --scalar-background-accent: #8ab4f81f;\n\n  --scalar-border-color: rgba(255, 255, 255, 0.1);\n}\n\n/* Document Sidebar */\n.light-mode .t-doc__sidebar {\n  --scalar-sidebar-background-1: var(--scalar-background-1);\n  --scalar-sidebar-item-hover-color: currentColor;\n  --scalar-sidebar-item-hover-background: var(--scalar-background-2);\n  --scalar-sidebar-item-active-background: var(--scalar-background-accent);\n  --scalar-sidebar-border-color: var(--scalar-border-color);\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: transparent;\n  --scalar-sidebar-search-border-color: var(--scalar-border-color);\n  --scalar-sidebar-search-color: var(--scalar-color-3);\n}\n\n.dark-mode .sidebar {\n  --scalar-sidebar-background-1: var(--scalar-background-1);\n  --scalar-sidebar-item-hover-color: currentColor;\n  --scalar-sidebar-item-hover-background: var(--scalar-background-2);\n  --scalar-sidebar-item-active-background: var(--scalar-background-accent);\n  --scalar-sidebar-border-color: var(--scalar-border-color);\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: transparent;\n  --scalar-sidebar-search-border-color: var(--scalar-border-color);\n  --scalar-sidebar-search-color: var(--scalar-color-3);\n}\n\n/* advanced */\n.light-mode {\n  --scalar-button-1: rgb(49 53 56);\n  --scalar-button-1-color: #fff;\n  --scalar-button-1-hover: rgb(28 31 33);\n\n  --scalar-color-green: #669900;\n  --scalar-color-red: #dc4a68;\n  --scalar-color-yellow: #edbe20;\n  --scalar-color-blue: #0277aa;\n  --scalar-color-orange: #fb892c;\n  --scalar-color-purple: #5203d1;\n\n  --scalar-scrollbar-color: rgba(0, 0, 0, 0.18);\n  --scalar-scrollbar-color-active: rgba(0, 0, 0, 0.36);\n}\n.dark-mode {\n  --scalar-button-1: #f6f6f6;\n  --scalar-button-1-color: #000;\n  --scalar-button-1-hover: #e7e7e7;\n\n  --scalar-color-green: #00b648;\n  --scalar-color-red: #dc1b19;\n  --scalar-color-yellow: #ffc90d;\n  --scalar-color-blue: #4eb3ec;\n  --scalar-color-orange: #ff8d4d;\n  --scalar-color-purple: #b191f9;\n\n  --scalar-scrollbar-color: rgba(255, 255, 255, 0.24);\n  --scalar-scrollbar-color-active: rgba(255, 255, 255, 0.48);\n}\n:root {\n  --scalar-radius: 3px;\n  --scalar-radius-lg: 3px;\n  --scalar-radius-xl: 3px;\n}\n";
 /**
- * The route handler to render the API Reference.
+ * The route handler to render the Scalar API Reference.
  */
-export declare function apiReference(options: ApiReferenceOptions): (_: Request, res: Response) => void;
+export declare function apiReference(givenConfiguration: ApiReferenceConfiguration): (_: Request, res: Response) => void;
 //# sourceMappingURL=apiReference.d.ts.map

package/dist/apiReference.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"apiReference.d.ts","sourceRoot":"","sources":["../src/apiReference.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAClD,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAEhD;;GAEG;AACH,eAAO,MAAM,WAAW,mnGA8FvB,CAAA;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,mBAAmB,OAC5C,OAAO,OAAO,QAAQ,UAGlC"}
+{"version":3,"file":"apiReference.d.ts","sourceRoot":"","sources":["../src/apiReference.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAA;AAExD,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAShD;;GAEG;AACH,eAAO,MAAM,WAAW,mnGA8FvB,CAAA;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,kBAAkB,EAAE,yBAAyB,OAQ7D,OAAO,OAAO,QAAQ,UAGlC"}

package/dist/apiReference.js

@@ -1,7 +1,13 @@
-import { getHtmlDocument } from './lib/static-rendering.js';
+import { getHtmlDocument } from '@scalar/api-reference/lib/html-rendering';
 
 /**
- * The custom theme CSS for the Express theme.
+ * The default configuration for the API Reference.
+ */
+const DEFAULT_CONFIGURATION = {
+    _integration: 'express',
+};
+/**
+ * The custom theme CSS for the Express theme
  */
 const customTheme = `
 /* basic theme */
@@ -99,11 +105,17 @@ const customTheme = `
 }
 `;
 /**
- * The route handler to render the API Reference.
+ * The route handler to render the Scalar API Reference.
  */
-function apiReference(options) {
+function apiReference(givenConfiguration) {
+    // Merge the defaults
+    const configuration = {
+        ...DEFAULT_CONFIGURATION,
+        ...givenConfiguration,
+    };
+    // Respond with the HTML document
     return (_, res) => {
-        res.type('text/html').send(getHtmlDocument(options, customTheme));
+        res.type('text/html').send(getHtmlDocument(configuration, customTheme));
     };
 }
 

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from './apiReference.js';
+export * from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,SAAS,CAAA"}

package/dist/types.d.ts

@@ -1,5 +1,6 @@
-import type { ReferenceConfiguration } from '@scalar/types/legacy';
-export type ApiReferenceOptions = ReferenceConfiguration & {
-    cdn?: string;
-};
+import type { HtmlRenderingConfiguration } from '@scalar/api-reference/lib/html-rendering';
+/**
+ * The configuration for the Scalar API Reference for Express
+ */
+export type ApiReferenceConfiguration = HtmlRenderingConfiguration;
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAElE,MAAM,MAAM,mBAAmB,GAAG,sBAAsB,GAAG;IACzD,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,0CAA0C,CAAA;AAE1F;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,0BAA0B,CAAA"}

package/package.json

@@ -10,7 +10,7 @@
     "url": "git+https://github.com/scalar/scalar.git",
     "directory": "integrations/express"
   },
-  "version": "0.4.184",
+  "version": "0.4.186",
   "engines": {
     "node": ">=18"
   },
@@ -30,16 +30,17 @@
   ],
   "module": "dist/index.js",
   "dependencies": {
-    "@scalar/types": "0.0.34"
+    "@scalar/api-reference": "1.25.124",
+    "@scalar/types": "0.0.36"
   },
   "devDependencies": {
     "@types/express": "^4.17.21",
     "@types/supertest": "^2.0.12",
     "express": "^4.21.2",
     "supertest": "^6.3.3",
+    "vite": "^5.4.10",
     "vitest": "^1.6.0",
-    "@scalar/api-reference": "1.25.121",
-    "@scalar/build-tooling": "0.1.14"
+    "@scalar/build-tooling": "0.1.15"
   },
   "scripts": {
     "build": "scalar-build-rollup",

package/dist/lib/static-rendering.d.ts

@@ -1,22 +0,0 @@
-import type { ApiReferenceOptions } from '../types';
-/**
- * The HTML document to render the Scalar API reference.
- */
-export declare function getHtmlDocument(options: ApiReferenceOptions, customTheme?: string): string;
-/**
- * The script tags to load the @scalar/api-reference package from the CDN.
- */
-export declare function getScriptTags(configuration: ApiReferenceOptions): string;
-/**
- * The configuration to pass to the @scalar/api-reference package.
- */
-export declare function getConfiguration(givenConfiguration: ApiReferenceOptions): string;
-/**
- * The content to pass to the @scalar/api-reference package as the <script> tag content.
- */
-export declare function getScriptTagContent(configuration: ApiReferenceOptions): string;
-/**
- * The CDN URL to load the @scalar/api-reference package from.
- */
-export declare function getCdnUrl(configuration: ApiReferenceOptions): string;
-//# sourceMappingURL=static-rendering.d.ts.map

package/dist/lib/static-rendering.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"static-rendering.d.ts","sourceRoot":"","sources":["../../src/lib/static-rendering.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAOlD;;GAEG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,mBAAmB,EAAE,WAAW,CAAC,EAAE,MAAM,UAmBjF;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,aAAa,EAAE,mBAAmB,UAQ/D;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,kBAAkB,EAAE,mBAAmB,UAavE;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,mBAAmB,UAMrE;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,aAAa,EAAE,mBAAmB,UAE3D"}

package/dist/lib/static-rendering.js

@@ -1,72 +0,0 @@
-const DEFAULT_CONFIGURATION = {
-    _integration: 'express',
-};
-/**
- * The HTML document to render the Scalar API reference.
- */
-function getHtmlDocument(options, customTheme) {
-    return `
-    <!DOCTYPE html>
-    <html>
-      <head>
-        <title>Scalar API Reference</title>
-        <meta charset="utf-8" />
-        <meta
-          name="viewport"
-          content="width=device-width, initial-scale=1" />
-        <style>
-          ${options.theme ? null : (customTheme)}
-        </style>
-      </head>
-      <body>
-        ${getScriptTags(options)}
-      </body>
-    </html>
-  `;
-}
-/**
- * The script tags to load the @scalar/api-reference package from the CDN.
- */
-function getScriptTags(configuration) {
-    return `
-      <script
-        id="api-reference"
-        type="application/json"
-        data-configuration="${getConfiguration(configuration)}">${getScriptTagContent(configuration)}</script>
-        <script src="${getCdnUrl(configuration)}"></script>
-    `;
-}
-/**
- * The configuration to pass to the @scalar/api-reference package.
- */
-function getConfiguration(givenConfiguration) {
-    const configuration = {
-        ...DEFAULT_CONFIGURATION,
-        ...givenConfiguration,
-    };
-    if (!configuration.spec?.url) {
-        delete configuration.spec;
-    }
-    else if (configuration.spec?.content) {
-        delete configuration.spec?.content;
-    }
-    return JSON.stringify(configuration).split('"').join('&quot;');
-}
-/**
- * The content to pass to the @scalar/api-reference package as the <script> tag content.
- */
-function getScriptTagContent(configuration) {
-    return configuration.spec?.content
-        ? typeof configuration.spec?.content === 'function'
-            ? JSON.stringify(configuration.spec?.content())
-            : JSON.stringify(configuration.spec?.content)
-        : '';
-}
-/**
- * The CDN URL to load the @scalar/api-reference package from.
- */
-function getCdnUrl(configuration) {
-    return configuration.cdn || 'https://cdn.jsdelivr.net/npm/@scalar/api-reference';
-}
-
-export { getCdnUrl, getConfiguration, getHtmlDocument, getScriptTagContent, getScriptTags };