@scalar/docusaurus 0.4.13 → 0.4.16

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @scalar/docusaurus
 
+## 0.4.16
+
+### Patch Changes
+
+- 5812c2f: feat: allow custom headers
+- b11d4a9: feat: add support for relative URLs
+  - @scalar/api-reference-react@0.3.14
+
+## 0.4.15
+
+### Patch Changes
+
+- 40d7c3d: fix: remove layers in docusaurus and fix precedence issue
+  - @scalar/api-reference-react@0.3.13
+
+## 0.4.14
+
+### Patch Changes
+
+- @scalar/api-reference-react@0.3.12
+
 ## 0.4.13
 
 ### Patch Changes

package/README.md

@@ -15,8 +15,7 @@ npm install @scalar/docusaurus
 
 ## Usage
 
-Simple add to the plugins section of your Docusaurus config. If you are using
-typescript you can import the type options type as well
+Simply add to the plugins section of your Docusaurus config. If you are using Typescript you can import the type options type as well.
 
 ```ts
 import type { ScalarOptions } from '@scalar/docusaurus'
@@ -37,9 +36,11 @@ plugins: [
 ],
 ```
 
+We wrote a [detailed integration guide for Docusaurus](https://github.com/scalar/scalar/tree/main/documentation/docusaurus.md).
+
 ### Multiple API descriptions
 
-Is it possible to add show multiple API descriptions? Yes, it is! :)
+Is it possible to show multiple API descriptions? Yes, it is! :)
 
 ```ts
 import type { ScalarOptions } from '@scalar/docusaurus'

package/dist/ScalarDocusaurus.js

@@ -9,12 +9,14 @@ require("@scalar/api-reference-react/style.css");
 const Layout_1 = __importDefault(require("@theme/Layout"));
 const react_1 = __importDefault(require("react"));
 require("./theme.css");
-const ScalarDocusaurus = ({ route }) => (react_1.default.createElement(Layout_1.default, null,
-    react_1.default.createElement(BrowserOnly_1.default, null, () => {
-        const ApiReferenceReact = 
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
-        require('@scalar/api-reference-react').ApiReferenceReact;
-        return react_1.default.createElement(ApiReferenceReact, { configuration: route.configuration });
-    })));
+const ScalarDocusaurus = ({ route }) => {
+    return (react_1.default.createElement(Layout_1.default, null,
+        react_1.default.createElement(BrowserOnly_1.default, null, () => {
+            const ApiReferenceReact = 
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            require('@scalar/api-reference-react').ApiReferenceReact;
+            return react_1.default.createElement(ApiReferenceReact, { configuration: route.configuration });
+        })));
+};
 exports.ScalarDocusaurus = ScalarDocusaurus;
 exports.default = exports.ScalarDocusaurus;

package/dist/ScalarDocusaurusCommonJS.js

@@ -51,20 +51,31 @@ class ScalarDocusaurusCommonJS extends react_1.Component {
                 if (container &&
                     this.props.route.configuration &&
                     !document.getElementById('api-reference')) {
-                    const { spec, ...config } = this.props.route.configuration;
-                    const apiReferenceScript = document.createElement('script');
-                    apiReferenceScript.id = 'api-reference';
-                    apiReferenceScript.type = 'application/json';
-                    const contentString = spec?.content
-                        ? typeof spec.content === 'function'
-                            ? JSON.stringify(spec.content())
-                            : JSON.stringify(spec.content)
+                    const config = this.props.route.configuration;
+                    // Execute content function if it exists
+                    if (typeof config.spec?.content === 'function') {
+                        config.spec.content = config.spec.content();
+                    }
+                    // Convert the document to a string
+                    const documentString = config?.spec?.content
+                        ? typeof config?.spec?.content === 'string'
+                            ? config.spec.content
+                            : JSON.stringify(config.spec.content)
                         : '';
+                    // Delete content from configuration
+                    if (config?.spec?.content) {
+                        delete config.spec.content;
+                    }
+                    // Convert the configuration to a string
                     const configString = JSON.stringify(config ?? {})
                         .split('"')
                         .join('"');
+                    // Create and append a script element with the configuration and the content
+                    const apiReferenceScript = document.createElement('script');
+                    apiReferenceScript.id = 'api-reference';
+                    apiReferenceScript.type = 'application/json';
                     apiReferenceScript.dataset.configuration = configString;
-                    apiReferenceScript.innerHTML = contentString;
+                    apiReferenceScript.innerHTML = documentString;
                     container.appendChild(apiReferenceScript);
                     // Creating and appending the script element
                     const script = document.createElement('script');

package/dist/index.js

@@ -11,14 +11,6 @@ const ScalarDocusaurus = (context, options) => {
     return {
         name: '@scalar/docusaurus',
         async loadContent() {
-            // Check if we need to download a spec
-            if (options.configuration?.spec?.url) {
-                const resp = await fetch(options.configuration.spec.url);
-                const content = await resp.text();
-                return {
-                    configuration: { ...options.configuration, spec: { content } },
-                };
-            }
             return options;
         },
         async contentLoaded({ content, actions }) {