@scalar/cli 2.1.0 → 2.5.1

package/chunks/action-FIXBOJEW.js

@@ -0,0 +1,244 @@
+import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
+import {
+  measureTime
+} from "./chunk-KHDYYVYF.js";
+import {
+  isAsyncApiDocument,
+  isDocument
+} from "./chunk-24WAOKGG.js";
+import "./chunk-CISTON3A.js";
+import "./chunk-Q7DOQHZN.js";
+import {
+  isUrl
+} from "./chunk-4ORL4MST.js";
+import {
+  output
+} from "./chunk-T5HJUAWB.js";
+import "./chunk-GSGZHE26.js";
+import "./chunk-IKT5F47M.js";
+import "./chunk-3MZYUBJ6.js";
+
+// src/domains/document/split/action.ts
+import fs2 from "node:fs/promises";
+import path2 from "node:path";
+import { text } from "@clack/prompts";
+import as from "ansis";
+import { bundle } from "@scalar/json-magic/bundle";
+import { fetchUrls, readFiles } from "@scalar/json-magic/bundle/plugins/node";
+import {
+  createServerWorkspaceStore,
+  WORKSPACE_FILE_NAME
+} from "@scalar/workspace-store/server";
+
+// src/domains/document/split/split-asyncapi.ts
+import { createHash } from "node:crypto";
+import fs from "node:fs/promises";
+import path from "node:path";
+import { extensions } from "@scalar/json-magic/bundle";
+import { escapeJsonPointer } from "@scalar/json-magic/helpers/escape-json-pointer";
+async function splitAsyncApi(document, outputPath) {
+  const chunks = /* @__PURE__ */ new Map();
+  const root = structuredClone(document);
+  const segmentNames = /* @__PURE__ */ new Map();
+  const usedNames = /* @__PURE__ */ new Set();
+  const shorten = (name) => name.length <= 240 ? name : `${name.slice(0, 170)}~5${createHash("sha256").update(name).digest("hex")}`;
+  const getFilePath = (segments) => {
+    const names = [];
+    for (const segment of segments) {
+      const directory = names.join("/");
+      const key = JSON.stringify([directory, segment]);
+      const existing = segmentNames.get(key);
+      if (existing !== void 0) {
+        names.push(existing);
+        continue;
+      }
+      const escaped = shorten(
+        encodeURIComponent(escapeJsonPointer(segment)).replaceAll("%", "~2").replaceAll(".", "~3").replaceAll("*", "~6") || "~7"
+      );
+      const name = shorten(
+        usedNames.has(`${directory}/${escaped}`.toLowerCase()) || /^(con|prn|aux|nul|com[1-9]|lpt[1-9])$/i.test(escaped) ? escaped.replace(
+          /[a-z]/gi,
+          (letter) => `~4${letter.charCodeAt(0).toString(16)}`
+        ) : escaped
+      );
+      segmentNames.set(key, name);
+      usedNames.add(`${directory}/${name}`.toLowerCase());
+      names.push(name);
+    }
+    return `chunks/default/${names.join("/")}.json`;
+  };
+  const extract = (parent, key, segments) => {
+    const pointer = `#/${segments.map(escapeJsonPointer).join("/")}`;
+    const file = getFilePath(segments);
+    chunks.set(pointer, { file, value: parent[key] });
+    parent[key] = {
+      $ref: `#/${segments.map((segment) => encodeURIComponent(escapeJsonPointer(segment))).join("/")}`
+    };
+  };
+  const extractMap = (value, segments) => {
+    if (!isDocument(value)) {
+      return;
+    }
+    for (const key of Object.keys(value)) {
+      extract(value, key, [...segments, key]);
+    }
+  };
+  const resolveChannel = (value, seen = /* @__PURE__ */ new Set()) => {
+    if (!isDocument(value) || typeof value.$ref !== "string" || !value.$ref.startsWith("#/") || seen.has(value.$ref)) {
+      return value;
+    }
+    seen.add(value.$ref);
+    const segments = decodeURIComponent(value.$ref.slice(2)).split("/").map((segment) => segment.replaceAll("~1", "/").replaceAll("~0", "~"));
+    const target = segments.reduce(
+      (node, segment) => isDocument(node) && Object.hasOwn(node, segment) ? node[segment] : void 0,
+      root
+    );
+    const resolved = resolveChannel(target, seen);
+    if (!isDocument(resolved)) {
+      return value;
+    }
+    const { $ref: _ref, ...siblings } = value;
+    return { ...resolved, ...siblings };
+  };
+  if (isDocument(root.channels)) {
+    for (const [name, value] of Object.entries(root.channels)) {
+      const channel = structuredClone(resolveChannel(value));
+      if (!isDocument(channel)) {
+        continue;
+      }
+      root.channels[name] = channel;
+      extractMap(channel.messages, ["channels", name, "messages"]);
+      for (const method of ["publish", "subscribe"]) {
+        if (isDocument(channel[method])) {
+          if (isDocument(channel[method].message)) {
+            extract(channel[method], "message", [
+              "channels",
+              name,
+              method,
+              "message"
+            ]);
+          }
+          extract(channel, method, ["channels", name, method]);
+        }
+      }
+    }
+  }
+  extractMap(root.channels, ["channels"]);
+  extractMap(root.operations, ["operations"]);
+  if (isDocument(root.components)) {
+    for (const [type, entries] of Object.entries(root.components)) {
+      if (!type.startsWith("x-")) {
+        extractMap(entries, ["components", type]);
+      }
+    }
+  }
+  if (isDocument(root[extensions.externalDocuments])) {
+    extractMap(root[extensions.externalDocuments], [
+      extensions.externalDocuments
+    ]);
+    extract(root, extensions.externalDocuments, [extensions.externalDocuments]);
+    delete root[extensions.externalDocuments];
+    delete root[extensions.externalDocumentsMappings];
+  }
+  const pointers = [...chunks.keys()].sort((a, b) => b.length - a.length);
+  const rebase = (value, sourceFile) => {
+    if (Array.isArray(value)) {
+      return value.map((entry) => rebase(entry, sourceFile));
+    }
+    if (!isDocument(value)) {
+      return value;
+    }
+    return Object.fromEntries(
+      Object.entries(value).map(([key, entry]) => {
+        if (key !== "$ref" || typeof entry !== "string" || !entry.startsWith("#")) {
+          return [key, rebase(entry, sourceFile)];
+        }
+        const pointer = decodeURIComponent(entry);
+        const target = pointers.find(
+          (candidate) => pointer === candidate || pointer.startsWith(`${candidate}/`)
+        );
+        const targetFile = target && chunks.get(target)?.file || "out.json";
+        const fragment = target ? `#${pointer.slice(target.length)}` : pointer;
+        const relativeFile = path.posix.relative(
+          path.posix.dirname(sourceFile),
+          targetFile
+        );
+        return [
+          key,
+          `${relativeFile.split("/").map(encodeURIComponent).join("/")}#${fragment.slice(1).split("/").map(encodeURIComponent).join("/")}`
+        ];
+      })
+    );
+  };
+  for (const { file, value } of [
+    ...chunks.values(),
+    { file: "out.json", value: root }
+  ]) {
+    const destination = path.join(outputPath, file);
+    await fs.mkdir(path.dirname(destination), { recursive: true });
+    await fs.writeFile(destination, JSON.stringify(rebase(value, file)));
+  }
+}
+
+// src/domains/document/split/action.ts
+async function splitAction(input, { output: __outputPath }) {
+  if (!input) {
+    return output.error().title("Missing input").message("Please provide a file path or URL to split").exit("error");
+  }
+  const getOutputPath = async () => {
+    if (__outputPath !== void 0 && typeof __outputPath === "string") {
+      return __outputPath;
+    }
+    const outputPath2 = await text({
+      message: "Where should the chunks be written?",
+      defaultValue: "./assets",
+      placeholder: "./assets"
+    });
+    if (typeof outputPath2 !== "string") {
+      return output.error().message("Operation cancelled by user").exit("error");
+    }
+    return outputPath2;
+  };
+  const outputPath = await getOutputPath();
+  const document = await bundle(isUrl(input) ? input : path2.resolve(input), {
+    plugins: [readFiles(), fetchUrls()],
+    treeShake: false,
+    hooks: {
+      onResolveError: ({ $ref }) => {
+        throw new Error(`Could not resolve reference: ${$ref}`);
+      }
+    }
+  }).catch(() => null);
+  if (!isDocument(document)) {
+    return output.error().title("Invalid input").message(
+      "Could not read an OpenAPI or AsyncAPI document from the input. Please provide a valid JSON or YAML file."
+    ).exit("error");
+  }
+  const { executionTimeMs } = await measureTime(async () => {
+    if (isAsyncApiDocument(document)) {
+      await splitAsyncApi(document, outputPath);
+      return;
+    }
+    const documentName = "default";
+    const store = await createServerWorkspaceStore({
+      mode: "static",
+      documents: [{ name: documentName, document }],
+      // The workspace writer prefixes its directory with cwd, including absolute paths.
+      directory: path2.relative(process.cwd(), path2.resolve(outputPath)) || "."
+    });
+    await store.generateWorkspaceChunks();
+    const workspaceFilePath = path2.join(outputPath, WORKSPACE_FILE_NAME);
+    const sparseDocument = JSON.parse(
+      await fs2.readFile(workspaceFilePath, { encoding: "utf-8" })
+    );
+    await fs2.writeFile(
+      path2.join(outputPath, "out.json"),
+      JSON.stringify(sparseDocument.documents[documentName])
+    );
+    await fs2.rm(workspaceFilePath);
+  });
+  output.info().line().title(as.green("Document Split Successfully! \u{1F389}")).line().message(`\u2728 Chunks have been generated at: ${as.blue(outputPath)}`).line(`\u23F1\uFE0F Split completed in ${as.yellow(executionTimeMs.toFixed(2))}ms`).line("").print();
+}
+export {
+  splitAction
+};

package/chunks/{action-DFKHSDFV.js → action-G26LSVZ7.js}

@@ -1,11 +1,15 @@
 import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
 import {
   getFileOrUrl
-} from "./chunk-23I5PKZZ.js";
-import "./chunk-IX7LJ3AD.js";
+} 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/markdown/action.ts

package/chunks/{action-Q5UJ32D6.js → action-H3RTILLM.js}

@@ -1,7 +1,7 @@
 import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
 import {
   output
-} from "./chunk-X4QLDBB5.js";
+} from "./chunk-T5HJUAWB.js";
 import "./chunk-3MZYUBJ6.js";
 
 // src/domains/document/void/action.ts

package/chunks/{action-GEBRPNRT.js → action-HGBBV353.js}

@@ -1,29 +1,28 @@
 import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
 import {
   fetchFromRegistry
-} from "./chunk-NUXPNUSS.js";
-import "./chunk-T7MDADON.js";
+} from "./chunk-UGGNHILG.js";
+import "./chunk-COBPBRQF.js";
 import {
   registry
-} from "./chunk-DOVIWNKQ.js";
-import "./chunk-4QS7SJTG.js";
-import "./chunk-VTYTPSXO.js";
+} from "./chunk-XCSR4RIT.js";
 import {
   getAuthData
-} from "./chunk-5BISXQX4.js";
-import "./chunk-OAXFCOJV.js";
-import "./chunk-TLFMATXR.js";
-import "./chunk-4DGQIAJX.js";
+} from "./chunk-M37TP6U2.js";
+import "./chunk-4ZDQXWBT.js";
+import "./chunk-VNYE4R7N.js";
+import "./chunk-OQKDBLOZ.js";
+import "./chunk-CISTON3A.js";
+import "./chunk-Q7DOQHZN.js";
+import "./chunk-4ORL4MST.js";
 import {
-  docVersionSchema
-} from "./chunk-ISGLWBXZ.js";
+  output
+} from "./chunk-T5HJUAWB.js";
+import "./chunk-GSGZHE26.js";
 import {
+  docVersionSchema,
   external_exports
-} from "./chunk-H2WRMLYY.js";
-import "./chunk-IX7LJ3AD.js";
-import {
-  output
-} from "./chunk-X4QLDBB5.js";
+} from "./chunk-IKT5F47M.js";
 import "./chunk-3MZYUBJ6.js";
 
 // src/domains/registry/get/action.ts

package/chunks/{action-5R5FDF6S.js → action-IUE4IOWO.js}

@@ -6,19 +6,34 @@ import {
   findConfig,
   getCurrentFolderName,
   scalarConfigSchema
-} 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 {
-  slugify
-} from "./chunk-ISGLWBXZ.js";
-import "./chunk-H2WRMLYY.js";
+  apiService
+} from "./chunk-AO3F5XWR.js";
+import "./chunk-HCPN3KNF.js";
+import "./chunk-B2MHTD3R.js";
+import "./chunk-3L6DLIXJ.js";
+import "./chunk-P7H7GY5A.js";
+import "./chunk-HPL3ZZ2P.js";
+import {
+  getMetadata
+} from "./chunk-M37TP6U2.js";
+import {
+  config
+} from "./chunk-4ZDQXWBT.js";
+import "./chunk-VNYE4R7N.js";
+import "./chunk-OQKDBLOZ.js";
 import "./chunk-K74E42RV.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 {
+  slugify
+} from "./chunk-IKT5F47M.js";
 import "./chunk-3MZYUBJ6.js";
 
 // src/domains/project/init/action.ts
@@ -27,13 +42,13 @@ import path from "node:path";
 import { cancel, confirm, isCancel, text } from "@clack/prompts";
 import as from "ansis";
 
-// ../../node_modules/.pnpm/@scalar+galaxy@0.6.12/node_modules/@scalar/galaxy/dist/3.1.json
+// ../../node_modules/.pnpm/@scalar+galaxy@0.7.0/node_modules/@scalar/galaxy/dist/3.1.json
 var __default = {
   openapi: "3.1.1",
   info: {
     title: "Scalar Galaxy",
     description: "The Scalar Galaxy is an example OpenAPI document to test OpenAPI tools and libraries. It's a fictional universe with fictional planets and fictional data.\n\n## Resources\n\n* https://github.com/scalar/scalar\n* https://github.com/OAI/OpenAPI-Specification\n* https://scalar.com\n\n## Markdown Support\n\nAll descriptions *can* contain ~~tons of text~~ **Markdown**. [If GitHub supports the syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax), chances are we're supporting it, too.\n\n<details>\n  <summary>Examples</summary>\n\n  **Blockquotes**\n\n  > I love OpenAPI. <3\n\n  **Tables**\n\n  | Feature          | Availability |\n  | ---------------- | ------------ |\n  | Markdown Support | \u2713            |\n\n  **Accordion**\n\n  ```html\n  <details>\n    <summary>Using Details Tags</summary>\n    <p>HTML Example</p>\n  </details>\n  ```\n\n  **Images**\n\n  Yes, there's support for images, too!\n\n  ![Empty placeholder image showing the width/height](https://images.placeholders.dev/?width=1280&height=720)\n\n  **Alerts**\n\n  > [!tip]\n  > You can use Markdown alerts in your descriptions.\n\n</details>\n",
-    version: "0.6.12",
+    version: "0.7.0",
     contact: {
       name: "Scalar Support",
       url: "https://scalar.com",
@@ -1991,7 +2006,6 @@ async function initAction({
   force
 }) {
   const configFile = findConfig() || CONFIG_FILE_DEFAULT;
-  let validInput;
   const nextSteps = () => {
     output.info().line("What to do next:").line(
       `  ${as.cyan("scalar project preview")} to preview your project locally`
@@ -2053,26 +2067,57 @@ async function initAction({
       }
     }
   });
-  validInput = !!subdomain;
+  const { auth } = await getMetadata();
+  const apiClient = auth ? await apiService({ noExit: true }).catch(() => null) : void 0;
+  if (!apiClient) {
+    output.warn().message(
+      "Subdomain availability was not checked. Run scalar auth login to check availability."
+    ).print();
+  }
   const folderName = getCurrentFolderName();
-  while (!validInput) {
-    const response = await text({
+  const suppliedSubdomain = typeof subdomain === "string" ? subdomain.trim().toLowerCase() : void 0;
+  if (subdomain !== void 0 && !suppliedSubdomain) {
+    return output.error().message("Provide a name with --subdomain.").exit("error");
+  }
+  while (true) {
+    const response = suppliedSubdomain ?? await text({
       message: "What is the name of your project?",
       defaultValue: folderName,
       placeholder: folderName
     });
     if (isCancel(response)) {
-      handleCancel();
-    } else {
-      validInput = true;
+      return handleCancel();
     }
     const title = response.toString();
-    const slug = slugify(title);
+    const slug = suppliedSubdomain ?? slugify(title);
+    const validSubdomain = /^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$/.test(slug);
+    if (!validSubdomain) {
+      const message = "Use a subdomain with 1 to 63 letters, numbers, or hyphens, starting and ending with a letter or number.";
+      if (suppliedSubdomain) {
+        return output.error().message(message).exit("error");
+      }
+      output.error().message(message).print();
+      continue;
+    }
+    if (apiClient) {
+      const result = await apiClient.publish.getDomainAvailability(`${slug}.${config.publishTld}`).catch(() => null);
+      if (!result || result.error) {
+        return output.error().message("Could not check subdomain availability. Please try again.").exit("error");
+      }
+      if (!result.data.available) {
+        const message = `Subdomain "${slug}" is already taken. Choose another name.`;
+        if (suppliedSubdomain) {
+          return output.error().message(message).exit("error");
+        }
+        output.error().message(message).print();
+        continue;
+      }
+    }
     configuration.info = { title, description: `Documentation for ${title}` };
-    subdomain = slug;
-    output.info().line(`${as.green("\u2714")} Subdomain: ${as.green(subdomain)}`).print();
+    configuration.siteConfig.subdomain = slug;
+    output.info().line(`${as.green("\u2714")} Subdomain: ${as.green(slug)}`).print();
+    break;
   }
-  configuration.siteConfig.subdomain = subdomain.trim();
   const content = JSON.stringify(configuration, null, 2);
   await fs.writeFile(configFile, content);
   await fs.writeFile(

package/chunks/{action-TPBKPHNS.js → action-JZLZ7ZAD.js}

@@ -1,7 +1,7 @@
 import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
 import {
   getProjectDeployments
-} from "./chunk-HQKBZOYU.js";
+} from "./chunk-PT5TI77I.js";
 import {
   resolveProject
 } from "./chunk-T7B6WNZC.js";
@@ -10,33 +10,33 @@ import {
 } from "./chunk-AEFPCC4U.js";
 import {
   apiService
-} from "./chunk-SXYALPYK.js";
-import "./chunk-2BSG2QHO.js";
-import "./chunk-SHSHFGA7.js";
-import "./chunk-UPUTMFD4.js";
-import "./chunk-B6QZJWCQ.js";
-import "./chunk-5BPPGTUU.js";
-import "./chunk-P646T2WH.js";
-import "./chunk-4QS7SJTG.js";
-import "./chunk-VTYTPSXO.js";
+} from "./chunk-AO3F5XWR.js";
+import "./chunk-F467BYYR.js";
+import "./chunk-Z2KMGFE6.js";
+import "./chunk-HCPN3KNF.js";
+import "./chunk-B2MHTD3R.js";
+import "./chunk-3L6DLIXJ.js";
+import "./chunk-P7H7GY5A.js";
+import "./chunk-HPL3ZZ2P.js";
 import {
   getAuthData
-} from "./chunk-5BISXQX4.js";
-import "./chunk-OAXFCOJV.js";
-import "./chunk-TLFMATXR.js";
-import "./chunk-4DGQIAJX.js";
-import {
-  slugSchema
-} from "./chunk-ISGLWBXZ.js";
-import {
-  external_exports
-} from "./chunk-H2WRMLYY.js";
+} from "./chunk-M37TP6U2.js";
+import "./chunk-4ZDQXWBT.js";
+import "./chunk-VNYE4R7N.js";
+import "./chunk-OQKDBLOZ.js";
 import "./chunk-K74E42RV.js";
-import "./chunk-IX7LJ3AD.js";
+import "./chunk-CISTON3A.js";
+import "./chunk-Q7DOQHZN.js";
+import "./chunk-4ORL4MST.js";
 import {
   output,
   printTable
-} from "./chunk-X4QLDBB5.js";
+} from "./chunk-T5HJUAWB.js";
+import "./chunk-GSGZHE26.js";
+import {
+  external_exports,
+  slugSchema
+} from "./chunk-IKT5F47M.js";
 import "./chunk-3MZYUBJ6.js";
 
 // src/domains/project/deployments/list/action.ts