@scalar/core 0.4.6 → 0.5.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @scalar/core
 
+## 0.5.1
+
+## 0.5.0
+
+### Minor Changes
+
+- [#8431](https://github.com/scalar/scalar/pull/8431): refactor: use new @scalar/client-side-rendering, deprecate everything
+
 ## 0.4.6
 
 ## 0.4.5

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

@@ -1,18 +1,22 @@
 import type { ApiReferenceConfigurationWithSource, HtmlRenderingConfiguration } from '@scalar/types/api-reference';
+/** @deprecated Use `@scalar/client-side-rendering` instead. */
 export type { HtmlRenderingConfiguration };
 /**
  * The HTML document to render the Scalar API reference.
  *
- * We must check the passed in configuration and not the configuration for the theme as the configuration will have it
- * defaulted to 'default'
+ * @deprecated Use `renderApiReference` from `@scalar/client-side-rendering` instead.
  */
 export declare const getHtmlDocument: (givenConfiguration: Partial<HtmlRenderingConfiguration>, customTheme?: string) => string;
 /**
  * The script tags to load the @scalar/api-reference package from the CDN.
+ *
+ * @deprecated Use `getScriptTags` from `@scalar/client-side-rendering` instead.
  */
 export declare function getScriptTags(configuration: Partial<ApiReferenceConfigurationWithSource>, cdn?: string): string;
 /**
  * The configuration to pass to the @scalar/api-reference package.
+ *
+ * @deprecated Use `getConfiguration` from `@scalar/client-side-rendering` instead.
  */
 export declare const getConfiguration: (givenConfiguration: Partial<ApiReferenceConfigurationWithSource>) => Partial<ApiReferenceConfigurationWithSource>;
 //# sourceMappingURL=html-rendering.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"html-rendering.d.ts","sourceRoot":"","sources":["../../../src/libs/html-rendering/html-rendering.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mCAAmC,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAA;AAGlH,YAAY,EAAE,0BAA0B,EAAE,CAAA;AA+C1C;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAAI,oBAAoB,OAAO,CAAC,0BAA0B,CAAC,EAAE,oBAAgB,WAwBxG,CAAA;AASD;;GAEG;AACH,wBAAgB,aAAa,CAAC,aAAa,EAAE,OAAO,CAAC,mCAAmC,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,UAiCtG;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,GAC3B,oBAAoB,OAAO,CAAC,mCAAmC,CAAC,KAC/D,OAAO,CAAC,mCAAmC,CAkB7C,CAAA"}
+{"version":3,"file":"html-rendering.d.ts","sourceRoot":"","sources":["../../../src/libs/html-rendering/html-rendering.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,mCAAmC,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAA;AAElH,+DAA+D;AAC/D,YAAY,EAAE,0BAA0B,EAAE,CAAA;AAE1C;;;;GAIG;AACH,eAAO,MAAM,eAAe,GAAI,oBAAoB,OAAO,CAAC,0BAA0B,CAAC,EAAE,oBAAgB,KAAG,MAI3G,CAAA;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,aAAa,EAAE,OAAO,CAAC,mCAAmC,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAE/G;AAED;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAC3B,oBAAoB,OAAO,CAAC,mCAAmC,CAAC,KAC/D,OAAO,CAAC,mCAAmC,CAI7C,CAAA"}

package/dist/libs/html-rendering/html-rendering.js

@@ -1,125 +1,26 @@
-/**
- * Helper function to add consistent indentation to multiline strings
- * @param str The string to indent
- * @param spaces Number of spaces for each level
- * @param initialIndent Whether to indent the first line
- */
-const addIndent = (str, spaces = 2, initialIndent = false) => {
-    const indent = ' '.repeat(spaces);
-    const lines = str.split('\n');
-    return lines
-        .map((line, index) => {
-        if (index === 0 && !initialIndent) {
-            return line;
-        }
-        return `${indent}${line}`;
-    })
-        .join('\n');
-};
-/**
- * Generate the style tag with custom theme if needed
- */
-const getStyles = (configuration, customTheme) => {
-    const styles = [];
-    if (configuration.customCss) {
-        styles.push('/* Custom CSS */');
-        styles.push(configuration.customCss);
-    }
-    if (!configuration.theme && customTheme) {
-        styles.push('/* Custom Theme */');
-        styles.push(customTheme);
-    }
-    if (styles.length === 0) {
-        return '';
-    }
-    return `
-    <style type="text/css">
-      ${addIndent(styles.join('\n\n'), 6)}
-    </style>`;
-};
+import { getConfiguration as _getConfiguration, getScriptTags as _getScriptTags, renderApiReference, } from '@scalar/client-side-rendering';
 /**
  * The HTML document to render the Scalar API reference.
  *
- * We must check the passed in configuration and not the configuration for the theme as the configuration will have it
- * defaulted to 'default'
+ * @deprecated Use `renderApiReference` from `@scalar/client-side-rendering` instead.
  */
 export const getHtmlDocument = (givenConfiguration, customTheme = '') => {
-    const { cdn, pageTitle, customCss, theme, ...rest } = givenConfiguration;
-    const configuration = getConfiguration({
-        ...rest,
-        ...(theme ? { theme } : {}),
-        customCss,
-    });
-    const content = `<!doctype html>
-<html>
-  <head>
-    <title>${pageTitle ?? 'Scalar API Reference'}</title>
-    <meta charset="utf-8" />
-    <meta
-      name="viewport"
-      content="width=device-width, initial-scale=1" />${getStyles(configuration, customTheme)}
-  </head>
-  <body>
-    <div id="app"></div>${getScriptTags(configuration, cdn)}
-  </body>
-</html>`;
-    return content;
-};
-/**
- * Helper function to serialize arrays that may contain functions
- */
-const serializeArrayWithFunctions = (arr) => {
-    return `[${arr.map((item) => (typeof item === 'function' ? item.toString() : JSON.stringify(item))).join(', ')}]`;
+    const { cdn, pageTitle, ...config } = givenConfiguration;
+    return renderApiReference({ config, pageTitle, cdn }, customTheme);
 };
 /**
  * The script tags to load the @scalar/api-reference package from the CDN.
+ *
+ * @deprecated Use `getScriptTags` from `@scalar/client-side-rendering` instead.
  */
 export function getScriptTags(configuration, cdn) {
-    const restConfig = { ...configuration };
-    const functionProps = [];
-    for (const [key, value] of Object.entries(configuration)) {
-        if (typeof value === 'function') {
-            functionProps.push(`"${key}": ${value.toString()}`);
-            delete restConfig[key];
-        }
-        else if (Array.isArray(value) && value.some((item) => typeof item === 'function')) {
-            // Handle arrays that contain functions (like plugins)
-            functionProps.push(`"${key}": ${serializeArrayWithFunctions(value)}`);
-            delete restConfig[key];
-        }
-    }
-    // Stringify the rest of the configuration
-    const configString = JSON.stringify(restConfig, null, 2)
-        .split('\n')
-        .map((line, index) => (index === 0 ? line : '      ' + line))
-        .join('\n')
-        .replace(/\s*}$/, ''); // Remove the closing brace and any whitespace before it
-    const functionPropsString = functionProps.length ? `,\n        ${functionProps.join(',\n        ')}\n      }` : '}';
-    return `
-    <!-- Load the Script -->
-    <script src="${cdn ?? 'https://cdn.jsdelivr.net/npm/@scalar/api-reference'}"></script>
-
-    <!-- Initialize the Scalar API Reference -->
-    <script type="text/javascript">
-      Scalar.createApiReference('#app', ${configString}${functionPropsString})
-    </script>`;
+    return _getScriptTags(configuration, cdn);
 }
 /**
  * The configuration to pass to the @scalar/api-reference package.
+ *
+ * @deprecated Use `getConfiguration` from `@scalar/client-side-rendering` instead.
  */
 export const getConfiguration = (givenConfiguration) => {
-    // Clone the given configuration
-    const configuration = {
-        ...givenConfiguration,
-    };
-    // Execute content if it's a function
-    if (typeof configuration.content === 'function') {
-        configuration.content = configuration.content();
-    }
-    // Only remove content if url is provided
-    if (configuration.content && configuration.url) {
-        delete configuration.content;
-    }
-    // Just return regular JSON string, no HTML escaping needed
-    return configuration;
+    return _getConfiguration(givenConfiguration);
 };

package/package.json

@@ -11,7 +11,7 @@
     "directory": "packages/core"
   },
   "keywords": [],
-  "version": "0.4.6",
+  "version": "0.5.1",
   "engines": {
     "node": ">=22"
   },
@@ -28,14 +28,15 @@
     "CHANGELOG.md"
   ],
   "dependencies": {
-    "@scalar/types": "0.7.6"
+    "@scalar/types": "0.9.0",
+    "@scalar/client-side-rendering": "0.1.1"
   },
   "devDependencies": {
     "vite": "8.0.0"
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",
-    "test": "vitest",
+    "test": "vitest --run",
     "types:check": "tsc --noEmit"
   }
 }