@scalar/client-side-rendering 0.2.6 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scalar/client-side-rendering
 
+## 0.3.0
+
+### Minor Changes
+
+- [#9588](https://github.com/scalar/scalar/pull/9588): Fix function-valued configuration options (like `onBeforeRequest` and the request hooks) being dropped in the Docusaurus integration. Docusaurus JSON-serializes route props, which silently strips functions, so the config is now serialized to JavaScript in the plugin and injected as a script. Exposes a reusable `serializeConfigToJs` helper from `@scalar/client-side-rendering`.
+
 ## 0.2.6
 
 ## 0.2.5

package/dist/html-rendering.d.ts

@@ -30,6 +30,18 @@ export declare function renderApiReference(options: {
      */
     nonce?: string;
 }, customTheme?: string): string;
+/**
+ * Serialize a configuration object to a JavaScript object literal string.
+ *
+ * Unlike `JSON.stringify`, this preserves function-valued properties (for example `onBeforeRequest`
+ * or the request hooks) by emitting them as literal JavaScript source via `Function.prototype.toString()`.
+ * That is what lets callbacks survive being written into an inline `<script>` tag, or across any other
+ * boundary that would otherwise JSON-serialize the configuration and silently drop functions.
+ *
+ * Note: functions must be arrow functions or `function` expressions. Object method shorthand
+ * (`onBeforeRequest(request) {}`) does not serialize to a valid standalone expression.
+ */
+export declare function serializeConfigToJs(configuration: Record<string, unknown>): string;
 /**
  * The script tags to load the @scalar/api-reference package from the CDN.
  *

package/dist/html-rendering.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"html-rendering.d.ts","sourceRoot":"","sources":["../src/html-rendering.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAA;AAE3G,YAAY,EAAE,4BAA4B,EAAE,0BAA0B,EAAE,CAAA;AAExE,uEAAuE;AACvE,eAAO,MAAM,WAAW,uDAAuD,CAAA;AAoE/E;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE;IACP,uCAAuC;IACvC,MAAM,EAAE,4BAA4B,CAAA;IACpC,sDAAsD;IACtD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,+DAA+D;IAC/D,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,EACD,WAAW,SAAK,GACf,MAAM,CA8BR;AASD;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CA0C1G;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,GAC3B,oBAAoB,OAAO,CAAC,0BAA0B,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAChF,MAAM,CAAC,MAAM,EAAE,OAAO,CAcxB,CAAA"}
+{"version":3,"file":"html-rendering.d.ts","sourceRoot":"","sources":["../src/html-rendering.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAA;AAE3G,YAAY,EAAE,4BAA4B,EAAE,0BAA0B,EAAE,CAAA;AAExE,uEAAuE;AACvE,eAAO,MAAM,WAAW,uDAAuD,CAAA;AAoE/E;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE;IACP,uCAAuC;IACvC,MAAM,EAAE,4BAA4B,CAAA;IACpC,sDAAsD;IACtD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,+DAA+D;IAC/D,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,EACD,WAAW,SAAK,GACf,MAAM,CA8BR;AASD;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CA+BlF;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAa1G;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,GAC3B,oBAAoB,OAAO,CAAC,0BAA0B,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAChF,MAAM,CAAC,MAAM,EAAE,OAAO,CAcxB,CAAA"}

package/dist/html-rendering.js

@@ -99,12 +99,17 @@ const serializeArrayWithFunctions = (arr) => {
     return `[${arr.map((item) => (typeof item === 'function' ? item.toString() : JSON.stringify(item))).join(', ')}]`;
 };
 /**
- * The script tags to load the @scalar/api-reference package from the CDN.
+ * Serialize a configuration object to a JavaScript object literal string.
  *
- * When a `nonce` is provided it is applied to both script tags so they are allowed under a strict
- * `script-src` Content Security Policy.
+ * Unlike `JSON.stringify`, this preserves function-valued properties (for example `onBeforeRequest`
+ * or the request hooks) by emitting them as literal JavaScript source via `Function.prototype.toString()`.
+ * That is what lets callbacks survive being written into an inline `<script>` tag, or across any other
+ * boundary that would otherwise JSON-serialize the configuration and silently drop functions.
+ *
+ * Note: functions must be arrow functions or `function` expressions. Object method shorthand
+ * (`onBeforeRequest(request) {}`) does not serialize to a valid standalone expression.
  */
-export function getScriptTags(configuration, cdn, nonce) {
+export function serializeConfigToJs(configuration) {
     const restConfig = { ...configuration };
     const functionProps = [];
     for (const [key, value] of Object.entries(configuration)) {
@@ -122,16 +127,23 @@ export function getScriptTags(configuration, cdn, nonce) {
         .split('\n')
         .map((line, index) => (index === 0 ? line : `      ${line}`))
         .join('\n');
-    let configString = indentedJsonString;
-    if (functionProps.length > 0) {
-        if (jsonString === '{}') {
-            configString = `{\n        ${functionProps.join(',\n        ')}\n      }`;
-        }
-        else {
-            const jsonWithoutClosingBrace = indentedJsonString.split('\n').slice(0, -1).join('\n');
-            configString = `${jsonWithoutClosingBrace},\n        ${functionProps.join(',\n        ')}\n      }`;
-        }
+    if (functionProps.length === 0) {
+        return indentedJsonString;
+    }
+    if (jsonString === '{}') {
+        return `{\n        ${functionProps.join(',\n        ')}\n      }`;
     }
+    const jsonWithoutClosingBrace = indentedJsonString.split('\n').slice(0, -1).join('\n');
+    return `${jsonWithoutClosingBrace},\n        ${functionProps.join(',\n        ')}\n      }`;
+}
+/**
+ * The script tags to load the @scalar/api-reference package from the CDN.
+ *
+ * When a `nonce` is provided it is applied to both script tags so they are allowed under a strict
+ * `script-src` Content Security Policy.
+ */
+export function getScriptTags(configuration, cdn, nonce) {
+    const configString = serializeConfigToJs(configuration);
     const nonceAttr = nonceAttribute(nonce);
     return `
     <!-- Load the Script -->

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export { type AnyApiReferenceConfiguration, DEFAULT_CDN, type HtmlRenderingConfiguration, getConfiguration, getScriptTags, renderApiReference, } from './html-rendering.js';
+export { type AnyApiReferenceConfiguration, DEFAULT_CDN, type HtmlRenderingConfiguration, getConfiguration, getScriptTags, renderApiReference, serializeConfigToJs, } from './html-rendering.js';
 //# 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,OAAO,EACL,KAAK,4BAA4B,EACjC,WAAW,EACX,KAAK,0BAA0B,EAC/B,gBAAgB,EAChB,aAAa,EACb,kBAAkB,GACnB,MAAM,kBAAkB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,4BAA4B,EACjC,WAAW,EACX,KAAK,0BAA0B,EAC/B,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,kBAAkB,CAAA"}

package/dist/index.js

@@ -1 +1 @@
-export { DEFAULT_CDN, getConfiguration, getScriptTags, renderApiReference, } from './html-rendering.js';
+export { DEFAULT_CDN, getConfiguration, getScriptTags, renderApiReference, serializeConfigToJs, } from './html-rendering.js';

package/package.json

@@ -11,11 +11,12 @@
     "directory": "packages/client-side-rendering"
   },
   "keywords": [],
-  "version": "0.2.6",
+  "version": "0.3.0",
   "engines": {
     "node": ">=22"
   },
   "type": "module",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "import": "./dist/index.js",
@@ -28,8 +29,8 @@
     "CHANGELOG.md"
   ],
   "dependencies": {
-    "@scalar/schemas": "0.7.0",
     "@scalar/validation": "0.6.0",
+    "@scalar/schemas": "0.7.0",
     "@scalar/types": "0.16.0"
   },
   "devDependencies": {