@scalar/nextjs-api-reference 0.4.11 → 0.4.14

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @scalar/nextjs-api-reference
 
+## 0.4.14
+
+### Patch Changes
+
+- Updated dependencies [716811f]
+- Updated dependencies [5812c2f]
+- Updated dependencies [ee5fdee]
+  - @scalar/api-reference@1.24.16
+
+## 0.4.13
+
+### Patch Changes
+
+- Updated dependencies [d7a011a]
+- Updated dependencies [40d7c3d]
+  - @scalar/api-reference@1.24.15
+
+## 0.4.12
+
+### Patch Changes
+
+- 008ac8c: feat: add URL support
+- Updated dependencies [fb9baa5]
+  - @scalar/api-reference@1.24.14
+
 ## 0.4.11
 
 ### Patch Changes

package/README.md

@@ -46,7 +46,9 @@ const config = {
 }
 ```
 
-The Next.js handler takes our universal configuration object, [read more about configuration](https://github.com/scalar/scalar/tree/main/packages/api-reference#configuration) in the core package README.
+We wrote a [detailed integration guide for Next.js](/documentation/nextjs.md).
+
+The Next.js handler takes our universal configuration object, [read more about configuration](https://github.com/scalar/scalar/tree/main/documentation/configuration.md) in the core package README.
 
 ## Themes
 

package/dist/index.cjs

@@ -122,14 +122,20 @@ const nextjsThemeCss = `
   border: 1px solid var(--scalar-border-color);
 }
 `;
-const ApiReference = (refConfig) => {
-  const { spec, ...config } = refConfig;
-  if (!(spec == null ? void 0 : spec.content) && !(spec == null ? void 0 : spec.url)) {
+const ApiReference = (config) => {
+  var _a, _b, _c, _d, _e, _f;
+  if (!((_a = config.spec) == null ? void 0 : _a.content) && !((_b = config.spec) == null ? void 0 : _b.url)) {
     throw new Error(
       "[@scalar/nextjs-api-reference] You didn’t provide a spec.content or spec.url. Please provide one of these options."
     );
   }
-  const contentString = (spec == null ? void 0 : spec.content) ? typeof spec.content === "function" ? JSON.stringify(spec.content()) : JSON.stringify(spec.content) : "";
+  if (typeof ((_c = config.spec) == null ? void 0 : _c.content) === "function") {
+    config.spec.content = config.spec.content();
+  }
+  const documentString = ((_d = config == null ? void 0 : config.spec) == null ? void 0 : _d.content) ? typeof ((_e = config == null ? void 0 : config.spec) == null ? void 0 : _e.content) === "string" ? config.spec.content : JSON.stringify(config.spec.content) : "";
+  if ((_f = config == null ? void 0 : config.spec) == null ? void 0 : _f.content) {
+    delete config.spec.content;
+  }
   if (!(config == null ? void 0 : config.customCss) && !(config == null ? void 0 : config.theme)) {
     config.customCss = nextjsThemeCss;
   }
@@ -149,7 +155,7 @@ const ApiReference = (refConfig) => {
       id="api-reference"
       type="application/json"
       data-configuration="${configString}">
-      ${contentString}
+      ${documentString}
     <\/script>
     <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"><\/script>
   </body>

package/dist/index.d.ts

@@ -3,11 +3,11 @@ import { ReferenceConfiguration } from '@scalar/api-reference';
 /**
  * Next.js adapter for an Api Reference
  *
- * {@link https://github.com/scalar/scalar?tab=readme-ov-file#configuration Configuration}
+ * {@link https://github.com/scalar/scalar/tree/main/documentation/configuration.md Configuration}
  *
  * @params config - the Api Reference config object
  * @params options - reserved for future use to add customization to the response
  */
-export declare const ApiReference: (refConfig: ReferenceConfiguration) => () => Promise<Response>;
+export declare const ApiReference: (config: ReferenceConfiguration) => () => Promise<Response>;
 
 export { }

package/dist/index.js

@@ -120,14 +120,20 @@ const nextjsThemeCss = `
   border: 1px solid var(--scalar-border-color);
 }
 `;
-const ApiReference = (refConfig) => {
-  const { spec, ...config } = refConfig;
-  if (!(spec == null ? void 0 : spec.content) && !(spec == null ? void 0 : spec.url)) {
+const ApiReference = (config) => {
+  var _a, _b, _c, _d, _e, _f;
+  if (!((_a = config.spec) == null ? void 0 : _a.content) && !((_b = config.spec) == null ? void 0 : _b.url)) {
     throw new Error(
       "[@scalar/nextjs-api-reference] You didn’t provide a spec.content or spec.url. Please provide one of these options."
     );
   }
-  const contentString = (spec == null ? void 0 : spec.content) ? typeof spec.content === "function" ? JSON.stringify(spec.content()) : JSON.stringify(spec.content) : "";
+  if (typeof ((_c = config.spec) == null ? void 0 : _c.content) === "function") {
+    config.spec.content = config.spec.content();
+  }
+  const documentString = ((_d = config == null ? void 0 : config.spec) == null ? void 0 : _d.content) ? typeof ((_e = config == null ? void 0 : config.spec) == null ? void 0 : _e.content) === "string" ? config.spec.content : JSON.stringify(config.spec.content) : "";
+  if ((_f = config == null ? void 0 : config.spec) == null ? void 0 : _f.content) {
+    delete config.spec.content;
+  }
   if (!(config == null ? void 0 : config.customCss) && !(config == null ? void 0 : config.theme)) {
     config.customCss = nextjsThemeCss;
   }
@@ -147,7 +153,7 @@ const ApiReference = (refConfig) => {
       id="api-reference"
       type="application/json"
       data-configuration="${configString}">
-      ${contentString}
+      ${documentString}
     <\/script>
     <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"><\/script>
   </body>

package/dist/index.umd.cjs

@@ -124,14 +124,20 @@
   border: 1px solid var(--scalar-border-color);
 }
 `;
-  const ApiReference = (refConfig) => {
-    const { spec, ...config } = refConfig;
-    if (!(spec == null ? void 0 : spec.content) && !(spec == null ? void 0 : spec.url)) {
+  const ApiReference = (config) => {
+    var _a, _b, _c, _d, _e, _f;
+    if (!((_a = config.spec) == null ? void 0 : _a.content) && !((_b = config.spec) == null ? void 0 : _b.url)) {
       throw new Error(
         "[@scalar/nextjs-api-reference] You didn’t provide a spec.content or spec.url. Please provide one of these options."
       );
     }
-    const contentString = (spec == null ? void 0 : spec.content) ? typeof spec.content === "function" ? JSON.stringify(spec.content()) : JSON.stringify(spec.content) : "";
+    if (typeof ((_c = config.spec) == null ? void 0 : _c.content) === "function") {
+      config.spec.content = config.spec.content();
+    }
+    const documentString = ((_d = config == null ? void 0 : config.spec) == null ? void 0 : _d.content) ? typeof ((_e = config == null ? void 0 : config.spec) == null ? void 0 : _e.content) === "string" ? config.spec.content : JSON.stringify(config.spec.content) : "";
+    if ((_f = config == null ? void 0 : config.spec) == null ? void 0 : _f.content) {
+      delete config.spec.content;
+    }
     if (!(config == null ? void 0 : config.customCss) && !(config == null ? void 0 : config.theme)) {
       config.customCss = nextjsThemeCss;
     }
@@ -151,7 +157,7 @@
       id="api-reference"
       type="application/json"
       data-configuration="${configString}">
-      ${contentString}
+      ${documentString}
     <\/script>
     <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"><\/script>
   </body>

package/package.json

@@ -18,7 +18,7 @@
     "openapi",
     "swagger"
   ],
-  "version": "0.4.11",
+  "version": "0.4.14",
   "engines": {
     "node": ">=18"
   },
@@ -37,7 +37,7 @@
   "dependencies": {
     "next": "^14.1.1",
     "react": "^18.3.1",
-    "@scalar/api-reference": "1.24.13"
+    "@scalar/api-reference": "1.24.16"
   },
   "devDependencies": {
     "@types/node": "^20.8.4",
@@ -49,7 +49,7 @@
     "react-dom": "^18.3.1",
     "vite": "^5.2.10",
     "vite-plugin-dts": "^3.6.3",
-    "@scalar/api-reference": "1.24.13"
+    "@scalar/api-reference": "1.24.16"
   },
   "scripts": {
     "build": "pnpm types:check && pnpm build-only",