@scalar/cli 2.0.0 → 2.1.0

package/README.md

@@ -170,7 +170,7 @@ Options:
   -h, --help                     display help for command
 
 Commands:
-  bundle [options] [file|url]    Bundle an OpenAPI specification by resolving all references and external dependencies
+  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
@@ -190,7 +190,7 @@ Commands:
 ```
 Usage: scalar document bundle [options] [file|url]
 
-Bundle an OpenAPI specification by resolving all references and external dependencies
+Bundle an OpenAPI document by resolving all references and external dependencies
 
 Arguments:
   file|url              Path to OpenAPI file or URL to bundle
@@ -389,6 +389,8 @@ Commands:
   create [options]            Create a new project that is not linked to a github project.
   preview [options] [config]  Preview scalar guides
   publish [options]           Publish new build for a github sync project that is not linked.
+  rollback [options]          Roll the live deployment back to a previously deployed build.
+  deployments                 Inspect a project deployment history.
   upgrade [config]            Upgrade scalar project
   help [command]              display help for command
 ```
@@ -462,6 +464,44 @@ Options:
   -h, --help             display help for command
 ```
 
+#### rollback
+```
+Usage: scalar project rollback [options]
+
+Roll the live deployment back to a previously deployed build.
+
+Options:
+  -s, --slug [slug]      Project slug found in Scalar Dashboard
+  -t, --to <publishUid>  Roll back to a specific build id (defaults to the next older deployed build)
+  -y, --yes              Skip the confirmation prompt
+  -h, --help             display help for command
+```
+
+#### deployments
+```
+Usage: scalar project deployments [options] [command]
+
+Inspect a project deployment history.
+
+Options:
+  -h, --help      display help for command
+
+Commands:
+  list [options]  List the production deployment history for a project.
+  help [command]  display help for command
+```
+
+##### list
+```
+Usage: scalar project deployments list [options]
+
+List the production deployment history for a project.
+
+Options:
+  -s, --slug [slug]  Project slug found in Scalar Dashboard
+  -h, --help         display help for command
+```
+
 #### upgrade
 ```
 Usage: scalar project upgrade [options] [config]

package/chunks/action-45OGQB2M.js

@@ -0,0 +1,138 @@
+import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
+import {
+  loadOpenApiFile,
+  printSpecificationBanner
+} from "./chunk-23I5PKZZ.js";
+import {
+  watchFile
+} from "./chunk-5BISXQX4.js";
+import "./chunk-OAXFCOJV.js";
+import "./chunk-4DGQIAJX.js";
+import "./chunk-ISGLWBXZ.js";
+import "./chunk-H2WRMLYY.js";
+import "./chunk-IX7LJ3AD.js";
+import {
+  output
+} from "./chunk-X4QLDBB5.js";
+import "./chunk-3MZYUBJ6.js";
+
+// src/domains/document/mock/action.ts
+import as2 from "ansis";
+
+// src/domains/document/mock/helpers.ts
+import { serve } from "@hono/node-server";
+import as from "ansis";
+import { createMockServer } from "@scalar/mock-server";
+var bootServer = async ({
+  specification,
+  port
+}) => {
+  const app = await createMockServer({
+    specification,
+    onRequest
+  });
+  return serve(
+    {
+      fetch: app.fetch,
+      port: port ?? 3e3
+    },
+    (info) => {
+      output.info().message(
+        `${as.green.bold("\u279C Mock Server")} ${as.white(
+          "listening on"
+        )} ${as.cyan(`http://localhost:${info.port}`)}`
+      ).print();
+    }
+  );
+};
+var printAvailablePaths = (specification) => {
+  output.info().message(as.white.bold("Available Paths")).print();
+  if (specification?.paths === void 0 || Object.keys(specification?.paths).length === 0) {
+    output.warn().title(as.grey("Could not find any paths in the OpenAPI file.")).print();
+  }
+  for (const path in specification?.paths ?? []) {
+    if (specification?.paths?.[path] === void 0) {
+      continue;
+    }
+    for (const method in specification.paths[path]) {
+      if (specification.paths[path][method] === void 0) {
+        continue;
+      }
+      output.info().line(
+        `${as[getMethodColor(method)].bold(method.toUpperCase().padEnd(6))} ${as.grey(`${path}`)}`
+      ).print();
+    }
+  }
+  output.info().line().print();
+};
+var onRequest = ({
+  context,
+  operation
+}) => {
+  const { method } = context.req;
+  output.info().line(
+    `${as[getMethodColor(method)].bold(method.toUpperCase().padEnd(6))} ${as.grey(`${context.req.path}`)} ${as.grey("\u2192")} ${operation?.operationId ? as.white(operation.operationId) : as.red("[ERROR] 404 Not Found")}`
+  ).print();
+};
+function getMethodColor(method) {
+  const colors = {
+    get: "green",
+    post: "cyan",
+    put: "yellow",
+    delete: "red",
+    patch: "magenta"
+  };
+  return colors[method.toLowerCase()] ?? "grey";
+}
+
+// src/domains/document/mock/action.ts
+async function mockAction(fileArgument, { watch, once, port }) {
+  let server;
+  const result = await loadOpenApiFile(fileArgument);
+  if (!result.valid) {
+    return output.error().title("Invalid OpenAPI document").exit("error");
+  }
+  printSpecificationBanner({
+    version: result.version,
+    schema: result.schema
+  });
+  let { specification } = result;
+  if (watch) {
+    await watchFile(fileArgument, async () => {
+      const newResult = await loadOpenApiFile(fileArgument);
+      const specificationHasChanged = newResult?.specification && JSON.stringify(specification) !== JSON.stringify(newResult.specification);
+      if (specificationHasChanged && newResult.valid) {
+        output.info().title(as2.grey("OpenAPI file modified")).print();
+        printSpecificationBanner({
+          version: newResult.version,
+          schema: newResult.schema
+        });
+        specification = newResult.specification;
+        if (specification) {
+          server.close();
+          server = await bootServer({
+            specification,
+            port
+          });
+        }
+      }
+    });
+  }
+  if (!specification) {
+    output.warn().title("Could not find any paths in the OpenAPI file.").print();
+    return;
+  }
+  printAvailablePaths(specification);
+  server = await bootServer({
+    specification,
+    port
+  });
+  if (once) {
+    setTimeout(() => {
+      server.close();
+    }, 2e3);
+  }
+}
+export {
+  mockAction
+};