yuzutech · ggrossetie · Feb 8, 2023 · Jan 30, 2023 · Jan 30, 2023 · Jan 31, 2023
diff --git a/.github/workflows/cve-scan.yml b/.github/workflows/cve-scan.yml
@@ -10,7 +10,7 @@ jobs:
     continue-on-error: true
     strategy:
       matrix:
-        image: [ kroki, kroki-mermaid, kroki-bpmn, kroki-excalidraw, kroki-blockdiag, kroki-diagramsnet ]
+        image: [ kroki, kroki-mermaid, kroki-bpmn, kroki-excalidraw, kroki-blockdiag, kroki-diagramsnet, kroki-wireviz ]
         tag: [ latest ]
     steps:
       - name: Run Trivy vulnerability scanner

diff --git a/.github/workflows/dockerhub-description.yml b/.github/workflows/dockerhub-description.yml
@@ -64,3 +64,12 @@ jobs:
           repository: yuzutech/kroki-diagramsnet
           short-description: Companion server for Kroki that provides diagrams.net (formerly draw.io)
           readme-filepath: ./DOCKERHUB-COMPANION.md
+
+      - name: Docker Hub Description - wireviz
+        uses: peter-evans/[email protected]
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+          repository: yuzutech/kroki-wireviz
+          short-description: Companion server for Kroki that provides WireViz
+          readme-filepath: ./DOCKERHUB-COMPANION.md
diff --git a/DOCKERHUB.md b/DOCKERHUB.md
@@ -40,6 +40,7 @@ services:
       - KROKI_MERMAID_HOST=mermaid
       - KROKI_BPMN_HOST=bpmn
       - KROKI_EXCALIDRAW_HOST=excalidraw
+      - KROKI_WIREVIZ_HOST=wireviz
     ports:
       - "8000:8000"
   blockdiag:
@@ -58,6 +59,10 @@ services:
     image: yuzutech/kroki-excalidraw
     ports:
       - "8004:8004"
+  wireviz:
+    image: yuzutech/kroki-wireviz
+    ports:
+      - "8006:8006"
 ```
 
 If you don't want to use `docker-compose`, you can configure the host and port for each companion container using environment variables:
@@ -68,6 +73,7 @@ If you don't want to use `docker-compose`, you can configure the host and port f
 | `kroki-mermaid`    | `KROKI_MERMAID_HOST`    | `KROKI_MERMAID_PORT`    |
 | `kroki-bpmn`       | `KROKI_BPMN_HOST`       | `KROKI_BPMN_PORT`       |
 | `kroki-excalidraw` | `KROKI_EXCALIDRAW_HOST` | `KROKI_EXCALIDRAW_PORT` |
+| `kroki-wireviz`    | `KROKI_WIREVIZ_HOST`    | `KROKI_WIREVIZ_PORT`    |
 
 For Kubernetes installation follow the description in [install using Kubernetes](https://docs.kroki.io/kroki/setup/install/#_using_kubernetes) section.
 

diff --git a/README.adoc b/README.adoc
@@ -9,7 +9,7 @@ image:https://github.com/yuzutech/kroki/workflows/CI/badge.svg?branch=master[Git
 image:https://img.shields.io/badge/zulip-join_chat-brightgreen.svg[Zulip chat, link=https://kroki.zulipchat.com/]
 endif::[]
 
-{uri-kroki}[Kroki] provides a unified API with support for BlockDiag (BlockDiag, SeqDiag, ActDiag, NwDiag, PacketDiag, RackDiag), BPMN, Bytefield, C4 (with PlantUML), D2, DBML, Diagrams.net (experimental), Ditaa, Erd, Excalidraw, GraphViz, Mermaid, Nomnoml, Pikchr, PlantUML, SvgBob, UMLet, Vega, Vega-Lite and WaveDrom... and more to come!
+{uri-kroki}[Kroki] provides a unified API with support for BlockDiag (BlockDiag, SeqDiag, ActDiag, NwDiag, PacketDiag, RackDiag), BPMN, Bytefield, C4 (with PlantUML), D2, DBML, Diagrams.net (experimental), Ditaa, Erd, Excalidraw, GraphViz, Mermaid, Nomnoml, Pikchr, PlantUML, SvgBob, UMLet, Vega, Vega-Lite, WaveDrom and WireViz... and more to come!
 
 == Quickstart
 
@@ -109,6 +109,9 @@ A companion web server written in JavaScript (powered by _micro_) that provides
 diagrams.net::
 A companion web server written in JavaScript (powered by _micro_) that provides _diagrams.net_.
 
+wireviz::
+A companion web server written in Python (powered by _Flask_ and _Gunicorn_) that provides _WireViz_.
+
 == Build
 
 === Gateway Server
@@ -154,6 +157,9 @@ Excalidraw
 yuzutech/kroki-diagramsnet (experimental)::
 diagrams.net
 
+yuzutech/kroki-wireviz::
+WireViz
+
 You can use `docker-compose` to run multiple containers:
 
 .docker-compose.yml
@@ -168,6 +174,7 @@ services:
       - KROKI_MERMAID_HOST=mermaid
       - KROKI_BPMN_HOST=bpmn
       - KROKI_EXCALIDRAW_HOST=excalidraw
+      - KROKI_WIREVIZ_HOST=wireviz
     ports:
       - "8000:8000"
   blockdiag:
@@ -191,6 +198,10 @@ services:
     image: yuzutech/kroki-diagramsnet
     expose:
       - "8005"
+  wireviz:
+    image: yuzutech/kroki-wireviz
+    ports:
+      - "8006:8006"
 ----
 
  $ docker-compose up -d
diff --git a/ci/tasks/update-versions.js b/ci/tasks/update-versions.js
@@ -121,7 +121,8 @@ const diagramLibraryNames = [
   'umlet',
   'vega',
   'vegalite',
-  'wavedrom'
+  'wavedrom',
+  'wireviz'
 ]
 
 try {
@@ -250,6 +251,7 @@ try {
   await updateServiceGetVersion('Svgbob.java', diagramLibraryVersions.svgbob)
   await updateServiceGetVersion('Umlet.java', diagramLibraryVersions.umlet)
   await updateServiceGetVersion('Wavedrom.java', diagramLibraryVersions.wavedrom)
+  await updateServiceGetVersion('WireViz.java', diagramLibraryVersions.wireviz)
   await updateVegaServiceGetVersion(diagramLibraryVersions.vega, diagramLibraryVersions.vegalite)
 
 } catch (err) {

diff --git a/ci/tests/diagrams/wireviz.yaml b/ci/tests/diagrams/wireviz.yaml
@@ -0,0 +1,26 @@
+connectors:
+  X1:
+    type: D-Sub
+    subtype: female
+    pinlabels: [DCD, RX, TX, DTR, GND, DSR, RTS, CTS, RI]
+  X2:
+    type: Molex KK 254
+    subtype: female
+    pinlabels: [GND, RX, TX]
+
+cables:
+  W1:
+    gauge: 0.25 mm2
+    length: 0.2
+    color_code: DIN
+    wirecount: 3
+    shield: true
+
+connections:
+  -
+    - X1: [5,2,3]
+    - W1: [1,2,3]
+    - X2: [1,3,2]
+  -
+    - X1: 5
+    - W1: s
diff --git a/ci/tests/docker-compose.yaml b/ci/tests/docker-compose.yaml
@@ -14,6 +14,7 @@ services:
       - KROKI_BPMN_HOST=bpmn
       - KROKI_EXCALIDRAW_HOST=excalidraw
       - KROKI_DIAGRAMSNET_HOST=diagramsnet
+      - KROKI_WIREVIZ_HOST=wireviz
     ports:
       - "8000:8000"
 
@@ -41,3 +42,8 @@ services:
     image: yuzutech/kroki-diagramsnet:smoketests
     expose:
       - "8005"
+
+  wireviz:
+    image: yuzutech/kroki-wireviz:smoketests
+    ports:
+      - "8006:8006"
diff --git a/ci/tests/smoke.js b/ci/tests/smoke.js
@@ -36,7 +36,8 @@ const tests = [
   {engine: 'diagramsnet', file: 'diagramsnet-network.xml', outputFormat: ['svg', 'png']},
   {engine: 'diagramsnet', file: 'diagramsnet-ui.xml', outputFormat: ['svg', 'png']},
   {engine: 'diagramsnet', file: 'diagramsnet-venn.xml', outputFormat: ['svg', 'png']},
-  {engine: 'd2', file: 'connections.d2', outputFormat: ['svg']}
+  {engine: 'd2', file: 'connections.d2', outputFormat: ['svg']},
+  {engine: 'wireviz', file: 'wireviz.yaml', outputFormat: ['svg', 'png']}
 ]
 
 chai.use(chaiHttp)

diff --git a/docker-bake-release.hcl b/docker-bake-release.hcl
@@ -24,3 +24,7 @@ target "kroki-excalidraw" {
 target "kroki-diagramsnet" {
   tags = ["yuzutech/kroki-diagramsnet:${RELEASE_VERSION}", "yuzutech/kroki-diagramsnet:latest"]
 }
+
+target "kroki-wireviz" {
+  tags = ["yuzutech/kroki-wireviz:${RELEASE_VERSION}", "yuzutech/kroki-wireviz:latest"]
+}
diff --git a/docker-bake.hcl b/docker-bake.hcl
@@ -3,7 +3,7 @@ variable "TAG" {
 }
 
 group "default" {
-  targets = ["kroki", "kroki-blockdiag", "kroki-mermaid", "kroki-bpmn", "kroki-excalidraw", "kroki-diagramsnet"]
+  targets = ["kroki", "kroki-blockdiag", "kroki-mermaid", "kroki-bpmn", "kroki-excalidraw", "kroki-diagramsnet", "kroki-wireviz"]
 }
 
 target "kroki" {
@@ -44,3 +44,7 @@ target "kroki-diagramsnet" {
   tags = ["yuzutech/kroki-diagramsnet:${TAG}"]
 }
 
+target "kroki-wireviz" {
+  context = "wireviz"
+  tags = ["yuzutech/kroki-wireviz:${TAG}"]
+}
diff --git a/docs/antora.yml b/docs/antora.yml
@@ -29,6 +29,7 @@ asciidoc:
     vega-version: 5.22.1
     vegalite-version: 5.6.0
     wavedrom-version: 2.9.1
+    wireviz-version: 0.3.2
     uri-docker-get-started: https://docs.docker.com/get-started/
     uri-podman-get-started: https://podman.io/getting-started/
     uri-docker-compose-install: https://docs.docker.com/compose/install/

diff --git a/docs/modules/ROOT/pages/architecture.adoc b/docs/modules/ROOT/pages/architecture.adoc
@@ -21,6 +21,9 @@ A companion web server written in JavaScript (powered by _micro_) that provides
 Diagrams.net::
 A companion web server written in JavaScript (powered by _micro_) that provides https://www.diagrams.net/[_diagrams.net_] to render diagrams.
 
+WireViz::
+A companion web server written in Python (powered by _Flask_ and _Gunicorn_) that provides WireViz.
+
 == Gateway Server
 
 The `yuzutech/kroki` Docker image contains the following diagrams libraries out-of-the-box:
@@ -155,3 +158,14 @@ The `yuzutech/kroki-diagramsnet` Docker image contains the following diagrams li
 |https://www.diagrams.net/[diagrams.net]
 |{diagramsnet-version}
 |===
+
+=== WireViz
+
+The `yuzutech/kroki-wireviz` Docker image contains the following diagrams libraries out-of-the-box:
+
+[options="header",cols="1,1m"]
+|===
+|Diagram Type | Version
+|https://github.com/formatc1702/WireViz[WireViz]
+|{wireviz-version}
+|===
diff --git a/docs/modules/ROOT/pages/diagram-types.adoc b/docs/modules/ROOT/pages/diagram-types.adoc
@@ -40,6 +40,7 @@ Diagram::
 * Bytefield diagram
 * Excalidraw
 * https://www.diagrams.net/[diagrams.net] (experimental)
+* WireViz
 
 Visualization::
 * Bar charts

diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
@@ -6,7 +6,7 @@
 
 Kroki provides a unified HTTP API with support for BlockDiag (BlockDiag, SeqDiag, ActDiag, NwDiag, PacketDiag, RackDiag),
 BPMN, Bytefield, C4 (with PlantUML), Diagrams.net (experimental), Ditaa, Erd, Excalidraw, GraphViz, Mermaid, Nomnoml, PlantUML, Structurizr, SvgBob, UMLet,
-Vega, Vega-Lite and WaveDrom... and more to come!
+Vega, Vega-Lite, WaveDrom and WireViz... and more to come!
 
 Kroki is available as a Self-Managed instance. +
 We are also _actively_ looking for sponsors to provide Kroki as a free service:

diff --git a/docs/modules/setup/examples/k8s-multi-pod/kroki-deployment.yaml b/docs/modules/setup/examples/k8s-multi-pod/kroki-deployment.yaml
@@ -25,6 +25,8 @@ spec:
           value: excalidraw
         - name: KROKI_MERMAID_HOST
           value: mermaid
+        - name: KROKI_WIREVIZ_HOST
+          value: wireviz
         image: yuzutech/kroki
         name: kroki
         ports:

diff --git a/docs/modules/setup/examples/k8s-multi-pod/wireviz-deployment.yaml b/docs/modules/setup/examples/k8s-multi-pod/wireviz-deployment.yaml
@@ -0,0 +1,23 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  annotations:
+  labels:
+    app: wireviz
+  name: wireviz
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: wireviz
+  template:
+    metadata:
+      labels:
+        app: wireviz
+    spec:
+      containers:
+      - image: yuzutech/kroki-wireviz
+        name: wireviz
+        ports:
+        - containerPort: 8006
+      restartPolicy: Always
diff --git a/docs/modules/setup/examples/k8s-multi-pod/wireviz-service.yaml b/docs/modules/setup/examples/k8s-multi-pod/wireviz-service.yaml
@@ -0,0 +1,15 @@
+---
+apiVersion: v1
+kind: Service
+metadata:
+  annotations:
+  labels:
+    app: wireviz
+  name: wireviz
+spec:
+  ports:
+  - name: "8006"
+    port: 8006
+    targetPort: 8006
+  selector:
+    app: wireviz
diff --git a/docs/modules/setup/examples/k8s-single-pod/kroki-deployment.yaml b/docs/modules/setup/examples/k8s-single-pod/kroki-deployment.yaml
@@ -27,6 +27,8 @@ spec:
           value: localhost
         - name: KROKI_EXCALIDRAW_HOST
           value: localhost
+        - name: KROKI_WIREVIZ_HOST
+          value: localhost
         ports:
         - protocol: TCP
           containerPort: 8000
@@ -49,4 +51,9 @@ spec:
         image: docker.io/yuzutech/kroki-excalidraw:latest
         ports:
         - protocol: TCP
-          containerPort: 8004
+          containerPort: 8004
+      - name: kroki-wireviz
+        image: docker.io/yuzutech/kroki-wireviz:latest
+        ports:
+        - protocol: TCP
+          containerPort: 8006
diff --git a/docs/modules/setup/examples/kroki-docker-compose.yml b/docs/modules/setup/examples/kroki-docker-compose.yml
@@ -12,6 +12,7 @@ services:
       - KROKI_MERMAID_HOST=mermaid
       - KROKI_BPMN_HOST=bpmn
       - KROKI_EXCALIDRAW_HOST=excalidraw
+      - KROKI_WIREVIZ_HOST=wireviz
     ports:
       - "8000:8000"
   blockdiag:
@@ -31,3 +32,7 @@ services:
     expose:
       - "8004"
 
+  wireviz:
+    image: yuzutech/kroki-wireviz
+    ports:
+      - "8006"
diff --git a/docs/modules/setup/pages/configuration.adoc b/docs/modules/setup/pages/configuration.adoc
@@ -179,6 +179,8 @@ KROKI_BPMN_HOST:: Host of the BPMN container (default: `127.0.0.1`).
 KROKI_BPMN_PORT:: Port of the BPMN container (default: `8003`).
 KROKI_EXCALIDRAW_HOST:: Host of the Excalidraw container (default: `127.0.0.1`).
 KROKI_EXCALIDRAW_PORT:: Port of the Excalidraw container (default: `8004`).
+KROKI_WIREVIZ_HOST:: Host of the WireViz container (default: `127.0.0.1`).
+KROKI_WIREVIZ_PORT:: Port of the WireViz container (default: `8006`).
 
 NOTE: If you are using the default `docker-compose.yaml` file you can rely on the default values.
 

diff --git a/docs/modules/setup/pages/install.adoc b/docs/modules/setup/pages/install.adoc
@@ -6,6 +6,7 @@
 :uri-docker-kroki-bpmn-image: https://hub.docker.com/r/yuzutech/kroki-bpmn
 :uri-docker-kroki-excalidraw-image: https://hub.docker.com/r/yuzutech/kroki-excalidraw
 :uri-docker-kroki-diagramsnet-image: https://hub.docker.com/r/yuzutech/kroki-diagramsnet
+:uri-docker-kroki-wireviz-image: https://hub.docker.com/r/yuzutech/kroki-wireviz
 // URIs of diagram generation application sites by diagram name
 :uri-blockdiag: http://blockdiag.com/en/blockdiag/index.html
 :uri-seqdiag: http://blockdiag.com/en/seqdiag/index.html
@@ -17,6 +18,7 @@
 :uri-bpmn: https://bpmn.io/toolkit/bpmn-js/
 :uri-excalidraw: https://excalidraw.com/
 :uri-diagramsnet: https://diagrams.net/
+:uri-wireviz: https://github.com/formatc1702/WireViz
 
 This section covers installing Kroki locally.
 
@@ -117,6 +119,7 @@ These optional companion containers provide additional diagrams and require the
 // * <<yuzutech-kroki-bpmn,Kroki bpmn>>
 // * <<yuzutech-kroki-excalidraw,Kroki excalidraw>>
 // * <<yuzutech-kroki-mermaid,Kroki mermaid>>
+// * <<yuzutech-kroki-wireviz,Kroki wireviz>>
 
 [#yuzutech-kroki-blockdiag]
 {uri-docker-kroki-blockdiag-image}[yuzutech/kroki-blockdiag^]::
@@ -143,3 +146,7 @@ Provides flowchart, sequence and Gantt diagrams for Kroki using the {uri-mermaid
 [#yuzutech-kroki-diagramsnet]
 {uri-docker-kroki-diagramsnet-image}[yuzutech/kroki-diagramsnet^]  (experimental)::
 Provides diagrams for Kroki using the {uri-diagramsnet}[diagrams.net^] library.
+
+[#yuzutech-kroki-wireviz]
+{uri-docker-kroki-wireviz-image}[yuzutech/kroki-wireviz^]::
+Provides diagrams for Kroki using the {uri-wireviz}[WireViz^] library.
diff --git a/docs/modules/setup/pages/use-kubernetes.adoc b/docs/modules/setup/pages/use-kubernetes.adoc
@@ -96,6 +96,13 @@ kubectl apply -f {uri-k8s-kroki-examples}/excalidraw-deployment.yaml
 kubectl apply -f {uri-k8s-kroki-examples}/excalidraw-service.yaml
 ----
 
+.Add WireViz service
+[source,cli,subs=+attributes]
+----
+kubectl apply -f {uri-k8s-kroki-examples}/wireviz-deployment.yaml
+kubectl apply -f {uri-k8s-kroki-examples}/wireviz-service.yaml
+----
+
 .Add Kroki service
 [source,cli,subs=+attributes]
 ----
@@ -127,6 +134,7 @@ bpmn-6cfccf9bc4-6w4px         1/1     Running   0          24s
 excalidraw-5b84995fcb-dh57t   1/1     Running   0          24s
 kroki-6b49bcb7c4-x2ksc        1/1     Running   0          23s
 mermaid-7bff5c9959-hkrxx      1/1     Running   0          22s
+wireviz-8c778ff7a8-7ds7c      1/1     Running   0          24s
 ....
 
 . To make sure that Kroki is working, open a terminal and type: