@scalar/cli 2.1.0 → 2.5.1

package/README.md

@@ -171,18 +171,18 @@ Options:
 
 Commands:
   bundle [options] [file|url]    Bundle an OpenAPI document by resolving all references and external dependencies
-  split [options] [file|url]     Split your OpenAPI documents on small chunks
-  join [options] <files...>      Merge multiple OpenAPI documents into a single unified document
-  format [options] [file|url]    Format an OpenAPI file
+  split [options] [file|url]     Split OpenAPI or AsyncAPI documents into small chunks
+  join [options] <files...>      Merge multiple OpenAPI or AsyncAPI documents into a single unified document
+  format [options] [file|url]    Format an OpenAPI or AsyncAPI file
   convert [options] [file|url]   Convert a Postman collection to an OpenAPI document
   markdown [options] [file|url]  Generate Markdown from an OpenAPI file
-  mock [options] [file|url]      Mock an API from an OpenAPI file
-  serve [options] [file|url]     Serve an API Reference from an OpenAPI file
-  share [options] [file]         Share an OpenAPI file
-  validate [file|url]            Validate an OpenAPI file
+  mock [options] [file|url]      Mock an OpenAPI API or AsyncAPI WebSocket and SSE channels
+  serve [options] [file|url]     Serve an API Reference from an OpenAPI or AsyncAPI file
+  share [options] [file]         Share an OpenAPI or AsyncAPI file
+  validate [file|url]            Validate an OpenAPI or AsyncAPI file
   void [options]                 Boot a server to mirror HTTP requests
-  lint [options] [file|url]      Lint your OpenAPI file using spectral rules
-  upgrade [options] [file|url]   Upgrade OpenAPI document to version 3.1
+  lint [options] [file|url]      Lint your OpenAPI or AsyncAPI file using spectral rules
+  upgrade [options] [file|url]   Upgrade an OpenAPI or AsyncAPI document to version 3.1
   help [command]                 display help for command
 ```
 
@@ -204,13 +204,16 @@ Options:
 ```
 
 #### split
+
+Splits AsyncAPI channels, operations, messages, and reusable components (including payload schemas) into JSON chunks. AsyncAPI versions are preserved, including 2.6, 3.0, and 3.1; splitting does not upgrade the document or add Scalar navigation metadata. Use `scalar document upgrade` separately to normalize versions. Nested external references are bundled relative to their source files or URLs, and chunk references resolve relative to the generated files. Both relative and absolute output directories are supported. The entry point is `out.json`.
+
 ```
 Usage: scalar document split [options] [file|url]
 
-Split your OpenAPI documents on small chunks
+Split OpenAPI or AsyncAPI documents into small chunks
 
 Arguments:
-  file|url             Path to OpenAPI file or URL to split
+  file|url             Path to OpenAPI or AsyncAPI file or URL to split
 
 Options:
   -o, --output <path>  Path to save the chunks
@@ -221,10 +224,10 @@ Options:
 ```
 Usage: scalar document join [options] <files...>
 
-Merge multiple OpenAPI documents into a single unified document
+Merge multiple OpenAPI or AsyncAPI documents into a single unified document
 
 Arguments:
-  files                                          Paths to the OpenAPI files to merge
+  files                                          Paths to the OpenAPI or AsyncAPI files to merge
 
 Options:
   --output -o <file>                             Path to save the merged output file
@@ -236,7 +239,7 @@ Options:
 ```
 Usage: scalar document format [options] [file|url]
 
-Format an OpenAPI file
+Format an OpenAPI or AsyncAPI file
 
 Arguments:
   file|url             File or URL to format
@@ -279,10 +282,10 @@ Options:
 ```
 Usage: scalar document mock [options] [file|url]
 
-Mock an API from an OpenAPI file
+Mock an OpenAPI API or AsyncAPI WebSocket and SSE channels
 
 Arguments:
-  file|url           OpenAPI file or URL to mock the server for
+  file|url           OpenAPI or AsyncAPI file or URL to mock
 
 Options:
   -w, --watch        watch the file for changes
@@ -295,10 +298,10 @@ Options:
 ```
 Usage: scalar document serve [options] [file|url]
 
-Serve an API Reference from an OpenAPI file
+Serve an API Reference from an OpenAPI or AsyncAPI file
 
 Arguments:
-  file|url           OpenAPI file or URL to show the reference for
+  file|url           OpenAPI or AsyncAPI file or URL to show the reference for
 
 Options:
   -w, --watch        watch the file for changes
@@ -311,7 +314,7 @@ Options:
 ```
 Usage: scalar document share [options] [file]
 
-Share an OpenAPI file
+Share an OpenAPI or AsyncAPI file
 
 Arguments:
   file                 file to share
@@ -325,7 +328,7 @@ Options:
 ```
 Usage: scalar document validate [options] [file|url]
 
-Validate an OpenAPI file
+Validate an OpenAPI or AsyncAPI file
 
 Arguments:
   file|url    File or URL to validate
@@ -350,10 +353,10 @@ Options:
 ```
 Usage: scalar document lint [options] [file|url]
 
-Lint your OpenAPI file using spectral rules
+Lint your OpenAPI or AsyncAPI file using spectral rules
 
 Arguments:
-  file|url               OpenAPI file path or url
+  file|url               OpenAPI or AsyncAPI file path or url
 
 Options:
   -r, --rule <file|url>  Rule path or url
@@ -364,10 +367,10 @@ Options:
 ```
 Usage: scalar document upgrade [options] [file|url]
 
-Upgrade OpenAPI document to version 3.1
+Upgrade an OpenAPI or AsyncAPI document to version 3.1
 
 Arguments:
-  file|url             File or URL to validate
+  file|url             File or URL to upgrade
 
 Options:
   -o, --output <file>  Path to save the upgraded output file
@@ -819,6 +822,7 @@ Options:
   --namespace <namespace>  Scalar team namespace
   --version <version>      API version (e.g. 0.1.0)
   --private                Make API private (default: false)
+  --force                  Force override an existing version (default: false)
   --bundle                 Bundle all external references before uploading
   --treeShake              Remove unused components from the bundled document
   --urlMap                 Generate a map of resolved URLs when bundling the document

package/chunks/{action-CYP4VDK3.js → action-37EV4UHW.js}

@@ -1,25 +1,28 @@
 import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
+import {
+  createError,
+  displayError
+} from "./chunk-3ZJYGGAA.js";
 import {
   readAndParseConfig,
   renderConfigError
-} from "./chunk-P2VH7DOC.js";
+} from "./chunk-7AGLC7WV.js";
 import {
   CONFIG_FILE_DEFAULT,
   findConfig,
   legacyTo2_0_0
-} from "./chunk-47Y4L5IT.js";
-import "./chunk-5BPPGTUU.js";
-import "./chunk-4QS7SJTG.js";
-import "./chunk-VTYTPSXO.js";
-import "./chunk-TLFMATXR.js";
+} from "./chunk-PBXZN65A.js";
 import {
   ConfigVersion
-} from "./chunk-ISGLWBXZ.js";
-import "./chunk-H2WRMLYY.js";
+} from "./chunk-OQKDBLOZ.js";
 import "./chunk-K74E42RV.js";
+import "./chunk-CISTON3A.js";
+import "./chunk-Q7DOQHZN.js";
 import {
   output
-} from "./chunk-X4QLDBB5.js";
+} from "./chunk-T5HJUAWB.js";
+import "./chunk-GSGZHE26.js";
+import "./chunk-IKT5F47M.js";
 import "./chunk-3MZYUBJ6.js";
 
 // src/domains/project/upgrade/action.ts
@@ -28,32 +31,6 @@ import path from "node:path";
 import { text } from "@clack/prompts";
 import as from "ansis";
 import { n } from "neverpanic";
-
-// src/errors.ts
-function createError(code, detail) {
-  return {
-    code,
-    detail
-  };
-}
-function displayError(error, fallback = "Unknown error occurred. Please contact support@scalar.com") {
-  try {
-    if (error instanceof Error) {
-      return error.message;
-    }
-    if (typeof error === "object") {
-      return JSON.stringify(error);
-    }
-    if (typeof error === "string") {
-      return error;
-    }
-    return fallback;
-  } catch {
-    return fallback;
-  }
-}
-
-// src/domains/project/upgrade/action.ts
 async function upgradeAction(__configPath) {
   const configPath = __configPath || findConfig() || await text({
     message: "Where is your configuration file located?",

package/chunks/{action-MENXFJH3.js → action-4XI7XJR4.js}

@@ -8,19 +8,19 @@ import {
   generateAccessByPersonalToken,
   setAuthData,
   tokenResponseSchema
-} from "./chunk-5BISXQX4.js";
+} from "./chunk-M37TP6U2.js";
 import {
   config
-} from "./chunk-OAXFCOJV.js";
-import "./chunk-4DGQIAJX.js";
-import "./chunk-ISGLWBXZ.js";
-import {
-  external_exports
-} from "./chunk-H2WRMLYY.js";
-import "./chunk-IX7LJ3AD.js";
+} from "./chunk-4ZDQXWBT.js";
+import "./chunk-VNYE4R7N.js";
+import "./chunk-OQKDBLOZ.js";
+import "./chunk-4ORL4MST.js";
 import {
   output
-} from "./chunk-X4QLDBB5.js";
+} from "./chunk-T5HJUAWB.js";
+import {
+  external_exports
+} from "./chunk-IKT5F47M.js";
 import "./chunk-3MZYUBJ6.js";
 
 // src/domains/auth/login/action.ts

package/chunks/{action-H5OHT2GV.js → action-5IU77OII.js}

@@ -1,16 +1,20 @@
 import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
 import {
   getFileOrUrl
-} from "./chunk-23I5PKZZ.js";
+} from "./chunk-24WAOKGG.js";
 import {
   require_dist
 } from "./chunk-K74E42RV.js";
+import "./chunk-CISTON3A.js";
+import "./chunk-Q7DOQHZN.js";
 import {
   isYamlFileName
-} from "./chunk-IX7LJ3AD.js";
+} from "./chunk-4ORL4MST.js";
 import {
   output
-} from "./chunk-X4QLDBB5.js";
+} from "./chunk-T5HJUAWB.js";
+import "./chunk-GSGZHE26.js";
+import "./chunk-IKT5F47M.js";
 import {
   __toESM
 } from "./chunk-3MZYUBJ6.js";

package/chunks/{action-STIEAXOE.js → action-B3KKREWQ.js}

@@ -1,15 +1,24 @@
 import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
+import {
+  isAsyncApiDocument
+} from "./chunk-24WAOKGG.js";
+import "./chunk-CISTON3A.js";
+import "./chunk-Q7DOQHZN.js";
+import "./chunk-4ORL4MST.js";
 import {
   output
-} from "./chunk-X4QLDBB5.js";
+} from "./chunk-T5HJUAWB.js";
+import "./chunk-GSGZHE26.js";
+import "./chunk-IKT5F47M.js";
 import "./chunk-3MZYUBJ6.js";
 
 // src/domains/document/validate/action.ts
 import as from "ansis";
 import prettyjson from "prettyjson";
+import { validate as validateAsyncApi } from "@scalar/asyncapi-validator";
 import { bundle } from "@scalar/json-magic/bundle";
 import { fetchUrls, readFiles } from "@scalar/json-magic/bundle/plugins/node";
-import { validate } from "@scalar/openapi-parser";
+import { validate as validateOpenApi } from "@scalar/openapi-validator";
 async function validateAction(inputArgument) {
   const startTime = performance.now();
   if (!inputArgument) {
@@ -20,12 +29,14 @@ async function validateAction(inputArgument) {
     treeShake: false,
     depth: -1
   });
-  const result = await validate(document);
+  const isAsyncApi = isAsyncApiDocument(document);
+  const specification = isAsyncApi ? "AsyncAPI" : "OpenAPI";
+  const result = isAsyncApi ? validateAsyncApi(document) : validateOpenApi(document);
   if (result.valid && result.version) {
     const endTime = performance.now();
     output.info().line(
       as.green(
-        `Matches the OpenAPI specification${as.white(` (OpenAPI ${as.bold(result.version)})`)}
+        `Matches the ${specification} specification${as.white(` (${specification} ${as.bold(result.version)})`)}
 `
       )
     ).line(
@@ -37,7 +48,7 @@ async function validateAction(inputArgument) {
   } else {
     output.error().message(prettyjson.render(result.errors)).message(
       as.red(
-        `File does not match the OpenAPI ${result.version ? `${result.version} ` : ""}specification.`
+        `File does not match the ${specification} ${result.version ? `${result.version} ` : ""}specification.`
       )
     ).message(
       as.red(

package/chunks/{action-BYZUBXVB.js → action-CH24QGTE.js}

@@ -2,20 +2,24 @@ import { createRequire as $$cR } from "node:module"; const require = $$cR(import
 import {
   measureTime
 } from "./chunk-KHDYYVYF.js";
-import "./chunk-23I5PKZZ.js";
+import "./chunk-24WAOKGG.js";
 import {
   DEFAULT_FETCH_CONCURRENCY
-} from "./chunk-AHWWJ3MD.js";
+} from "./chunk-K4DTP5TV.js";
 import {
   require_dist
 } from "./chunk-K74E42RV.js";
+import "./chunk-CISTON3A.js";
+import "./chunk-Q7DOQHZN.js";
 import {
   isUrl,
   isYamlFileName
-} from "./chunk-IX7LJ3AD.js";
+} from "./chunk-4ORL4MST.js";
 import {
   output
-} from "./chunk-X4QLDBB5.js";
+} from "./chunk-T5HJUAWB.js";
+import "./chunk-GSGZHE26.js";
+import "./chunk-IKT5F47M.js";
 import {
   __toESM
 } from "./chunk-3MZYUBJ6.js";