@scalar/nextjs-api-reference 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @scalar/nextjs-api-reference
 
+## 0.7.0
+
+### Minor Changes
+
+- 5f9a8a2: feat!: remove the spec prefix, make content and url top-level attributes
+
+### Patch Changes
+
+- Updated dependencies [5f9a8a2]
+  - @scalar/types@0.1.0
+  - @scalar/core@0.1.3
+
+## 0.6.1
+
+### Patch Changes
+
+- Updated dependencies [fc6a45e]
+  - @scalar/types@0.0.41
+  - @scalar/core@0.1.2
+
 ## 0.6.0
 
 ### Minor Changes

package/README.md

@@ -33,9 +33,7 @@ If you have a OpenAPI/Swagger file already, you can pass a URL to the plugin in
 import { ApiReference } from '@scalar/nextjs-api-reference'
 
 const config = {
-  spec: {
-    url: '/openapi.json',
-  },
+  url: '/openapi.json',
 }
 
 export const GET = ApiReference(config)
@@ -45,9 +43,7 @@ Or, if you just have a static OpenAPI spec, you can directly pass it as well:
 
 ```ts
 const config = {
-  spec: {
-    content: '...',
-  },
+  content: '{ "openapi": "3.1.1", … }',
 }
 ```
 
@@ -84,9 +80,7 @@ export default function References() {
   return (
     <ApiReferenceReact
       configuration={{
-        spec: {
-          url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.json',
-        },
+        url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.json',
       }}
     />
   )
@@ -106,9 +100,7 @@ You can find all available CDN versions [here](https://www.jsdelivr.com/package/
 import { ApiReference } from '@scalar/nextjs-api-reference'
 
 const config = {
-  spec: {
-    url: '/openapi.json',
-  },
+  url: '/openapi.json',
   cdn: 'https://cdn.jsdelivr.net/npm/@scalar/api-reference@latest',
 }
 

package/dist/index.cjs

@@ -3990,18 +3990,53 @@ const integrationEnum = z.enum([
   "vue"
 ]).nullable();
 const specConfigurationSchema = z.object({
-  /** URL to an OpenAPI/Swagger document */
+  /**
+   * URL to an OpenAPI/Swagger document
+   *
+   * @deprecated Please move `url` to the top level and remove the `spec` prefix.
+   *
+   * @example
+   * ```ts
+   * const oldConfiguration = {
+   *   spec: {
+   *     url: 'https://example.com/openapi.json',
+   *   },
+   * }
+   *
+   * const newConfiguration = {
+   *   url: 'https://example.com/openapi.json',
+   * }
+   * ```
+   **/
   url: z.string().optional(),
   /**
    * Directly embed the OpenAPI document.
    * Can be a string, object, function returning an object, or null.
+   *
    * @remarks It's recommended to pass a URL instead of content.
-   */
+   *
+   * @deprecated Please move `content` to the top level and remove the `spec` prefix.
+   *
+   * @example
+   * ```ts
+   * const oldConfiguration = {
+   *   spec: {
+   *     content: '…',
+   *   },
+   * }
+   *
+   * const newConfiguration = {
+   *   content: '…',
+   * }
+   * ```
+   **/
   content: z.union([z.string(), z.record(z.any()), z.function().returns(z.record(z.any())), z.null()]).optional(),
   /**
    * The title of the OpenAPI document.
    *
    * @example 'Scalar Galaxy'
+   *
+   * @deprecated Please move `title` to the top level and remove the `spec` prefix.
    */
   title: z.string().optional(),
   /**
@@ -4012,6 +4047,8 @@ const specConfigurationSchema = z.object({
    * If no title is used, it’ll just use the index.
    *
    * @example 'scalar-galaxy'
+   *
+   * @deprecated Please move `slug` to the top level and remove the `spec` prefix.
    */
   slug: z.string().optional()
 });
@@ -4020,6 +4057,39 @@ const pathRoutingSchema = z.object({
   basePath: z.string()
 });
 const apiClientConfigurationSchema = z.object({
+  /**
+   * URL to an OpenAPI/Swagger document
+   **/
+  url: z.string().optional(),
+  /**
+   * Directly embed the OpenAPI document.
+   * Can be a string, object, function returning an object, or null.
+   *
+   * @remarks It’s recommended to pass a URL instead of content.
+   **/
+  content: z.union([z.string(), z.record(z.any()), z.function().returns(z.record(z.any())), z.null()]).optional(),
+  /**
+   * The title of the OpenAPI document.
+   *
+   * @example 'Scalar Galaxy'
+   */
+  title: z.string().optional(),
+  /**
+   * The slug of the OpenAPI document used in the URL.
+   *
+   * If none is passed, the title will be used.
+   *
+   * If no title is used, it’ll just use the index.
+   *
+   * @example 'scalar-galaxy'
+   */
+  slug: z.string().optional(),
+  /**
+   * The OpenAPI/Swagger document to render
+   *
+   * @deprecated Use `url` and `content` on the top level instead.
+   **/
+  spec: specConfigurationSchema.optional(),
   /** Prefill authentication */
   authentication: z.any().optional(),
   // Temp until we bring in the new auth
@@ -4042,8 +4112,6 @@ const apiClientConfigurationSchema = z.object({
    * @default true
    */
   showSidebar: z.boolean().optional().default(true).catch(true),
-  /** The Swagger/OpenAPI spec to render */
-  spec: specConfigurationSchema.optional(),
   /** A string to use one of the color presets */
   theme: themeIdEnum.optional().default("default").catch("default"),
   /** Integration type identifier */
@@ -4216,12 +4284,21 @@ const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.ob
   operationsSorter: z.union([z.literal("alpha"), z.literal("method"), z.function().args(z.any(), z.any()).returns(z.number())]).optional()
 }));
 const _apiReferenceConfigurationWithSourcesSchema = _apiReferenceConfigurationSchema.merge(z.object({
-  spec: z.object({
-    sources: z.array(specConfigurationSchema)
-  })
+  sources: z.array(specConfigurationSchema)
 }));
 const migrateConfiguration = (_configuration) => {
+  var _a, _b;
   const configuration = { ..._configuration };
+  if ((_a = configuration.spec) == null ? void 0 : _a.url) {
+    console.warn(`[DEPRECATED] You’re using the deprecated 'spec.url' attribute. Remove the spec prefix and move the 'url' attribute to the top level.`);
+    configuration.url = configuration.spec.url;
+    delete configuration.spec;
+  }
+  if ((_b = configuration.spec) == null ? void 0 : _b.content) {
+    console.warn(`[DEPRECATED] You’re using the deprecated 'spec.content' attribute. Remove the spec prefix and move the 'content' attribute to the top level.`);
+    configuration.content = configuration.spec.content;
+    delete configuration.spec;
+  }
   if (configuration.customCss) {
     configuration.customCss = migrateThemeVariables(configuration.customCss);
   }
@@ -4291,21 +4368,15 @@ function getScriptTags(configuration, cdn) {
     `;
 }
 const getConfiguration = (givenConfiguration) => {
-  var _a, _b, _c;
   const configuration = {
     ...givenConfiguration
   };
-  if (!((_a = configuration.spec) == null ? void 0 : _a.url)) {
-    delete configuration.spec;
-  } else if ((_b = configuration.spec) == null ? void 0 : _b.content) {
-    (_c = configuration.spec) == null ? true : delete _c.content;
+  if (configuration.content) {
+    delete configuration.content;
   }
   return JSON.stringify(configuration).split('"').join(""");
 };
-const getScriptTagContent = (configuration) => {
-  var _a, _b, _c, _d;
-  return ((_a = configuration.spec) == null ? void 0 : _a.content) ? typeof ((_b = configuration.spec) == null ? void 0 : _b.content) === "function" ? JSON.stringify((_c = configuration.spec) == null ? void 0 : _c.content()) : JSON.stringify((_d = configuration.spec) == null ? void 0 : _d.content) : "";
-};
+const getScriptTagContent = (configuration) => configuration.content ? typeof configuration.content === "function" ? JSON.stringify(configuration.content()) : JSON.stringify(configuration.content) : "";
 const customTheme = `
 /* basic theme */
 .dark-mode {

package/dist/index.js

@@ -3988,18 +3988,53 @@ const integrationEnum = z.enum([
   "vue"
 ]).nullable();
 const specConfigurationSchema = z.object({
-  /** URL to an OpenAPI/Swagger document */
+  /**
+   * URL to an OpenAPI/Swagger document
+   *
+   * @deprecated Please move `url` to the top level and remove the `spec` prefix.
+   *
+   * @example
+   * ```ts
+   * const oldConfiguration = {
+   *   spec: {
+   *     url: 'https://example.com/openapi.json',
+   *   },
+   * }
+   *
+   * const newConfiguration = {
+   *   url: 'https://example.com/openapi.json',
+   * }
+   * ```
+   **/
   url: z.string().optional(),
   /**
    * Directly embed the OpenAPI document.
    * Can be a string, object, function returning an object, or null.
+   *
    * @remarks It's recommended to pass a URL instead of content.
-   */
+   *
+   * @deprecated Please move `content` to the top level and remove the `spec` prefix.
+   *
+   * @example
+   * ```ts
+   * const oldConfiguration = {
+   *   spec: {
+   *     content: '…',
+   *   },
+   * }
+   *
+   * const newConfiguration = {
+   *   content: '…',
+   * }
+   * ```
+   **/
   content: z.union([z.string(), z.record(z.any()), z.function().returns(z.record(z.any())), z.null()]).optional(),
   /**
    * The title of the OpenAPI document.
    *
    * @example 'Scalar Galaxy'
+   *
+   * @deprecated Please move `title` to the top level and remove the `spec` prefix.
    */
   title: z.string().optional(),
   /**
@@ -4010,6 +4045,8 @@ const specConfigurationSchema = z.object({
    * If no title is used, it’ll just use the index.
    *
    * @example 'scalar-galaxy'
+   *
+   * @deprecated Please move `slug` to the top level and remove the `spec` prefix.
    */
   slug: z.string().optional()
 });
@@ -4018,6 +4055,39 @@ const pathRoutingSchema = z.object({
   basePath: z.string()
 });
 const apiClientConfigurationSchema = z.object({
+  /**
+   * URL to an OpenAPI/Swagger document
+   **/
+  url: z.string().optional(),
+  /**
+   * Directly embed the OpenAPI document.
+   * Can be a string, object, function returning an object, or null.
+   *
+   * @remarks It’s recommended to pass a URL instead of content.
+   **/
+  content: z.union([z.string(), z.record(z.any()), z.function().returns(z.record(z.any())), z.null()]).optional(),
+  /**
+   * The title of the OpenAPI document.
+   *
+   * @example 'Scalar Galaxy'
+   */
+  title: z.string().optional(),
+  /**
+   * The slug of the OpenAPI document used in the URL.
+   *
+   * If none is passed, the title will be used.
+   *
+   * If no title is used, it’ll just use the index.
+   *
+   * @example 'scalar-galaxy'
+   */
+  slug: z.string().optional(),
+  /**
+   * The OpenAPI/Swagger document to render
+   *
+   * @deprecated Use `url` and `content` on the top level instead.
+   **/
+  spec: specConfigurationSchema.optional(),
   /** Prefill authentication */
   authentication: z.any().optional(),
   // Temp until we bring in the new auth
@@ -4040,8 +4110,6 @@ const apiClientConfigurationSchema = z.object({
    * @default true
    */
   showSidebar: z.boolean().optional().default(true).catch(true),
-  /** The Swagger/OpenAPI spec to render */
-  spec: specConfigurationSchema.optional(),
   /** A string to use one of the color presets */
   theme: themeIdEnum.optional().default("default").catch("default"),
   /** Integration type identifier */
@@ -4214,12 +4282,21 @@ const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.ob
   operationsSorter: z.union([z.literal("alpha"), z.literal("method"), z.function().args(z.any(), z.any()).returns(z.number())]).optional()
 }));
 const _apiReferenceConfigurationWithSourcesSchema = _apiReferenceConfigurationSchema.merge(z.object({
-  spec: z.object({
-    sources: z.array(specConfigurationSchema)
-  })
+  sources: z.array(specConfigurationSchema)
 }));
 const migrateConfiguration = (_configuration) => {
+  var _a, _b;
   const configuration = { ..._configuration };
+  if ((_a = configuration.spec) == null ? void 0 : _a.url) {
+    console.warn(`[DEPRECATED] You’re using the deprecated 'spec.url' attribute. Remove the spec prefix and move the 'url' attribute to the top level.`);
+    configuration.url = configuration.spec.url;
+    delete configuration.spec;
+  }
+  if ((_b = configuration.spec) == null ? void 0 : _b.content) {
+    console.warn(`[DEPRECATED] You’re using the deprecated 'spec.content' attribute. Remove the spec prefix and move the 'content' attribute to the top level.`);
+    configuration.content = configuration.spec.content;
+    delete configuration.spec;
+  }
   if (configuration.customCss) {
     configuration.customCss = migrateThemeVariables(configuration.customCss);
   }
@@ -4289,21 +4366,15 @@ function getScriptTags(configuration, cdn) {
     `;
 }
 const getConfiguration = (givenConfiguration) => {
-  var _a, _b, _c;
   const configuration = {
     ...givenConfiguration
   };
-  if (!((_a = configuration.spec) == null ? void 0 : _a.url)) {
-    delete configuration.spec;
-  } else if ((_b = configuration.spec) == null ? void 0 : _b.content) {
-    (_c = configuration.spec) == null ? true : delete _c.content;
+  if (configuration.content) {
+    delete configuration.content;
   }
   return JSON.stringify(configuration).split('"').join(""");
 };
-const getScriptTagContent = (configuration) => {
-  var _a, _b, _c, _d;
-  return ((_a = configuration.spec) == null ? void 0 : _a.content) ? typeof ((_b = configuration.spec) == null ? void 0 : _b.content) === "function" ? JSON.stringify((_c = configuration.spec) == null ? void 0 : _c.content()) : JSON.stringify((_d = configuration.spec) == null ? void 0 : _d.content) : "";
-};
+const getScriptTagContent = (configuration) => configuration.content ? typeof configuration.content === "function" ? JSON.stringify(configuration.content()) : JSON.stringify(configuration.content) : "";
 const customTheme = `
 /* basic theme */
 .dark-mode {

package/dist/index.umd.cjs

@@ -3992,18 +3992,53 @@
     "vue"
   ]).nullable();
   const specConfigurationSchema = z.object({
-    /** URL to an OpenAPI/Swagger document */
+    /**
+     * URL to an OpenAPI/Swagger document
+     *
+     * @deprecated Please move `url` to the top level and remove the `spec` prefix.
+     *
+     * @example
+     * ```ts
+     * const oldConfiguration = {
+     *   spec: {
+     *     url: 'https://example.com/openapi.json',
+     *   },
+     * }
+     *
+     * const newConfiguration = {
+     *   url: 'https://example.com/openapi.json',
+     * }
+     * ```
+     **/
     url: z.string().optional(),
     /**
      * Directly embed the OpenAPI document.
      * Can be a string, object, function returning an object, or null.
+     *
      * @remarks It's recommended to pass a URL instead of content.
-     */
+     *
+     * @deprecated Please move `content` to the top level and remove the `spec` prefix.
+     *
+     * @example
+     * ```ts
+     * const oldConfiguration = {
+     *   spec: {
+     *     content: '…',
+     *   },
+     * }
+     *
+     * const newConfiguration = {
+     *   content: '…',
+     * }
+     * ```
+     **/
     content: z.union([z.string(), z.record(z.any()), z.function().returns(z.record(z.any())), z.null()]).optional(),
     /**
      * The title of the OpenAPI document.
      *
      * @example 'Scalar Galaxy'
+     *
+     * @deprecated Please move `title` to the top level and remove the `spec` prefix.
      */
     title: z.string().optional(),
     /**
@@ -4014,6 +4049,8 @@
      * If no title is used, it’ll just use the index.
      *
      * @example 'scalar-galaxy'
+     *
+     * @deprecated Please move `slug` to the top level and remove the `spec` prefix.
      */
     slug: z.string().optional()
   });
@@ -4022,6 +4059,39 @@
     basePath: z.string()
   });
   const apiClientConfigurationSchema = z.object({
+    /**
+     * URL to an OpenAPI/Swagger document
+     **/
+    url: z.string().optional(),
+    /**
+     * Directly embed the OpenAPI document.
+     * Can be a string, object, function returning an object, or null.
+     *
+     * @remarks It’s recommended to pass a URL instead of content.
+     **/
+    content: z.union([z.string(), z.record(z.any()), z.function().returns(z.record(z.any())), z.null()]).optional(),
+    /**
+     * The title of the OpenAPI document.
+     *
+     * @example 'Scalar Galaxy'
+     */
+    title: z.string().optional(),
+    /**
+     * The slug of the OpenAPI document used in the URL.
+     *
+     * If none is passed, the title will be used.
+     *
+     * If no title is used, it’ll just use the index.
+     *
+     * @example 'scalar-galaxy'
+     */
+    slug: z.string().optional(),
+    /**
+     * The OpenAPI/Swagger document to render
+     *
+     * @deprecated Use `url` and `content` on the top level instead.
+     **/
+    spec: specConfigurationSchema.optional(),
     /** Prefill authentication */
     authentication: z.any().optional(),
     // Temp until we bring in the new auth
@@ -4044,8 +4114,6 @@
      * @default true
      */
     showSidebar: z.boolean().optional().default(true).catch(true),
-    /** The Swagger/OpenAPI spec to render */
-    spec: specConfigurationSchema.optional(),
     /** A string to use one of the color presets */
     theme: themeIdEnum.optional().default("default").catch("default"),
     /** Integration type identifier */
@@ -4218,12 +4286,21 @@
     operationsSorter: z.union([z.literal("alpha"), z.literal("method"), z.function().args(z.any(), z.any()).returns(z.number())]).optional()
   }));
   const _apiReferenceConfigurationWithSourcesSchema = _apiReferenceConfigurationSchema.merge(z.object({
-    spec: z.object({
-      sources: z.array(specConfigurationSchema)
-    })
+    sources: z.array(specConfigurationSchema)
   }));
   const migrateConfiguration = (_configuration) => {
+    var _a, _b;
     const configuration = { ..._configuration };
+    if ((_a = configuration.spec) == null ? void 0 : _a.url) {
+      console.warn(`[DEPRECATED] You’re using the deprecated 'spec.url' attribute. Remove the spec prefix and move the 'url' attribute to the top level.`);
+      configuration.url = configuration.spec.url;
+      delete configuration.spec;
+    }
+    if ((_b = configuration.spec) == null ? void 0 : _b.content) {
+      console.warn(`[DEPRECATED] You’re using the deprecated 'spec.content' attribute. Remove the spec prefix and move the 'content' attribute to the top level.`);
+      configuration.content = configuration.spec.content;
+      delete configuration.spec;
+    }
     if (configuration.customCss) {
       configuration.customCss = migrateThemeVariables(configuration.customCss);
     }
@@ -4293,21 +4370,15 @@
     `;
   }
   const getConfiguration = (givenConfiguration) => {
-    var _a, _b, _c;
     const configuration = {
       ...givenConfiguration
     };
-    if (!((_a = configuration.spec) == null ? void 0 : _a.url)) {
-      delete configuration.spec;
-    } else if ((_b = configuration.spec) == null ? void 0 : _b.content) {
-      (_c = configuration.spec) == null ? true : delete _c.content;
+    if (configuration.content) {
+      delete configuration.content;
     }
     return JSON.stringify(configuration).split('"').join(""");
   };
-  const getScriptTagContent = (configuration) => {
-    var _a, _b, _c, _d;
-    return ((_a = configuration.spec) == null ? void 0 : _a.content) ? typeof ((_b = configuration.spec) == null ? void 0 : _b.content) === "function" ? JSON.stringify((_c = configuration.spec) == null ? void 0 : _c.content()) : JSON.stringify((_d = configuration.spec) == null ? void 0 : _d.content) : "";
-  };
+  const getScriptTagContent = (configuration) => configuration.content ? typeof configuration.content === "function" ? JSON.stringify(configuration.content()) : JSON.stringify(configuration.content) : "";
   const customTheme = `
 /* basic theme */
 .dark-mode {

package/package.json

@@ -18,7 +18,7 @@
     "openapi",
     "swagger"
   ],
-  "version": "0.6.0",
+  "version": "0.7.0",
   "engines": {
     "node": ">=18"
   },
@@ -35,8 +35,8 @@
   ],
   "module": "./dist/index.js",
   "dependencies": {
-    "@scalar/core": "0.1.1",
-    "@scalar/types": "0.0.40"
+    "@scalar/types": "0.1.0",
+    "@scalar/core": "0.1.3"
   },
   "devDependencies": {
     "@types/node": "^20.17.10",
@@ -47,7 +47,7 @@
     "react-dom": "^19.0.0",
     "vite": "^5.4.10",
     "vite-plugin-dts": "^4.3.0",
-    "@scalar/api-reference": "1.26.1"
+    "@scalar/api-reference": "1.28.1"
   },
   "peerDependencies": {
     "react": "^19.0.0",