CLI UI: add mermaid diagram (#562)

LangStream · Oct 11, 2023 · 69ce6e9 · 69ce6e9
1 parent 462c7e4
commit 69ce6e9
Show file tree

Hide file tree

Showing 14 changed files with 740 additions and 31,312 deletions.
diff --git a/langstream-cli/src/main/java/ai/langstream/cli/api/model/Gateways.java b/langstream-cli/src/main/java/ai/langstream/cli/api/model/Gateways.java
@@ -15,6 +15,7 @@
  */
 package ai.langstream.cli.api.model;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.util.List;
 import java.util.Map;
@@ -67,6 +68,8 @@ public static class Gateway {
         String type;
         List<String> parameters;
         Map<String, Object> authentication;
+
+        @JsonProperty("chat-options")
         Map<String, Object> chatOptions;
     }
 }
diff --git a/langstream-cli/src/main/java/ai/langstream/cli/commands/BaseCmd.java b/langstream-cli/src/main/java/ai/langstream/cli/commands/BaseCmd.java
@@ -43,6 +43,7 @@
 import java.security.DigestInputStream;
 import java.security.MessageDigest;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -60,7 +61,8 @@ public abstract class BaseCmd implements Runnable {
     public enum Formats {
         raw,
         json,
-        yaml
+        yaml,
+        mermaid
     }
 
     protected static final ObjectMapper yamlConfigReader = new ObjectMapper(new YAMLFactory());
@@ -572,4 +574,15 @@ protected String getAppDescriptionOrLoad(String application) {
         return applicationDescriptions.computeIfAbsent(
                 application, app -> getClient().applications().get(application, false));
     }
+
+    protected void ensureFormatIn(Formats value, Formats... allowed) {
+        final List<Formats> asList = Arrays.stream(allowed).collect(Collectors.toList());
+        if (!asList.contains(value)) {
+            throw new IllegalArgumentException(
+                    String.format(
+                            "Format %s is not allowed. Allowed formats are: %s",
+                            value,
+                            asList.stream().map(Enum::name).collect(Collectors.joining(","))));
+        }
+    }
 }
diff --git a/...i/src/main/java/ai/langstream/cli/commands/applications/AbstractDeployApplicationCmd.java b/...i/src/main/java/ai/langstream/cli/commands/applications/AbstractDeployApplicationCmd.java
@@ -63,8 +63,9 @@ public static class DeployApplicationCmd extends AbstractDeployApplicationCmd {
 
         @CommandLine.Option(
                 names = {"-o"},
-                description = "Output format for dry-run mode.")
-        private Formats format = Formats.raw;
+                description =
+                        "Output format for dry-run mode. Formats are: yaml, json. Default value is yaml.")
+        private Formats format = Formats.yaml;
 
         @Override
         String applicationId() {
@@ -98,6 +99,7 @@ boolean isDryRun() {
 
         @Override
         Formats format() {
+            ensureFormatIn(format, Formats.json, Formats.yaml);
             return format;
         }
     }

diff --git a/langstream-cli/src/main/java/ai/langstream/cli/commands/applications/GetApplicationCmd.java b/langstream-cli/src/main/java/ai/langstream/cli/commands/applications/GetApplicationCmd.java
@@ -24,10 +24,18 @@ public class GetApplicationCmd extends BaseApplicationCmd {
     @CommandLine.Parameters(description = "ID of the application")
     private String applicationId;
 
+    public enum GetAppFormats {
+        raw,
+        json,
+        yaml,
+        mermaid
+    }
+
     @CommandLine.Option(
             names = {"-o"},
-            description = "Output format")
-    private Formats format = Formats.raw;
+            description =
+                    "Output format. Formats are: yaml, json, raw, mermaid. Default value is raw.")
+    private GetAppFormats format = GetAppFormats.raw;
 
     @CommandLine.Option(
             names = {"-s", "--stats"},
@@ -38,8 +46,12 @@ public class GetApplicationCmd extends BaseApplicationCmd {
     @SneakyThrows
     public void run() {
         final String body = getClient().applications().get(applicationId, stats);
+        if (format == GetAppFormats.mermaid) {
+            log(MermaidAppDiagramGenerator.generate(body));
+            return;
+        }
         print(
-                format,
+                Formats.valueOf(format.name()),
                 body,
                 ListApplicationCmd.COLUMNS_FOR_RAW,
                 ListApplicationCmd.getRawFormatValuesSupplier());

diff --git a/langstream-cli/src/main/java/ai/langstream/cli/commands/applications/ListApplicationCmd.java b/langstream-cli/src/main/java/ai/langstream/cli/commands/applications/ListApplicationCmd.java
@@ -31,12 +31,13 @@ public class ListApplicationCmd extends BaseApplicationCmd {
 
     @CommandLine.Option(
             names = {"-o"},
-            description = "Output format")
+            description = "Output format. Formats are: yaml, json, raw. Default value is raw.")
     private Formats format = Formats.raw;
 
     @Override
     @SneakyThrows
     public void run() {
+        ensureFormatIn(format, Formats.raw, Formats.json, Formats.yaml);
         final String body = getClient().applications().list();
         print(format, body, COLUMNS_FOR_RAW, getRawFormatValuesSupplier());
     }