speechflow 0.9.2 → 0.9.4

package/README.md

@@ -15,8 +15,16 @@ About
 -----
 
 **SpeechFlow** is a command-line interface based tool for establishing a
-directed data flow graph of audio and text processing nodes. This way it
-allows to perform various speech processing tasks in a flexible way.
+directed data flow graph of audio and text processing nodes. This way,
+it allows to perform various speech processing tasks in a flexible way.
+Currently, **SpeechFlow** comes with graph nodes for local file I/O, local audio
+device I/O, local/remote WebSocket network I/O, cloud-based [Deepgram](https://deepgram.com)
+speech-to-text conversion, cloud-based [DeepL](https://deepl.com) text-to-text
+translation, local [Gemma/Ollama](https://ollama.com/library/gemma3)
+text-to-text translation, cloud-based [ElevenLabs](https://elevenlabs.io/)
+text-to-speech conversion, and local [FFmpeg](https://ffmpeg.org/)
+speech-to-speech encoding. **SpeechFlow** is written in TypeScript and
+ships as a package for the Node Package Manager (NPM).
 
 Installation
 ------------

package/dst/speechflow.d.ts

@@ -1 +1,6 @@
+/*!
+**  SpeechFlow - Speech Processing Flow Graph
+**  Copyright (c) 2024-2025 Dr. Ralf S. Engelschall <rse@engelschall.com>
+**  Licensed under GPL 3.0 <https://spdx.org/licenses/GPL-3.0-only>
+*/
 export {};

package/dst/speechflow.js

@@ -1,5 +1,6 @@
+#!/usr/bin/env node
 "use strict";
-/*
+/*!
 **  SpeechFlow - Speech Processing Flow Graph
 **  Copyright (c) 2024-2025 Dr. Ralf S. Engelschall <rse@engelschall.com>
 **  Licensed under GPL 3.0 <https://spdx.org/licenses/GPL-3.0-only>
@@ -296,6 +297,12 @@ let cli = null;
     process.on("SIGINT", () => {
         shutdown("SIGINT");
     });
+    process.on("SIGUSR1", () => {
+        shutdown("SIGUSR1");
+    });
+    process.on("SIGUSR2", () => {
+        shutdown("SIGUSR2");
+    });
     process.on("SIGTERM", () => {
         shutdown("SIGTERM");
     });

package/etc/nps.yaml

@@ -8,9 +8,9 @@ scripts:
     #   multiview-style development dashboard
     dev: >
                             stmux -w always -m beep -e "built.in.+ms" --
-                            [ -s 40% "npm start lint-watch" :
-                            -s 40% "npm start build-watch" :
-                            -s 20% "npm start server-delay server-dev-watch" ]
+                            [ -s 35% "npm start lint-watch" :
+                            -s 15% "npm start build-watch" :
+                            -s 30% "npm start server-delay server-watch" ]
 
     #   static code analysis (linting)
     lint-watch:             nodemon --exec "npm start lint" --watch src --ext ts
@@ -21,18 +21,18 @@ scripts:
     lint-eslint:            eslint --config etc/eslint.mjs src/**/*.ts
 
     #   code compilation/transpiling (building)
-    build:                  tsc --project etc/tsconfig.json
+    build: >
+                            tsc --project etc/tsconfig.json &&
+                            (echo "#!/usr/bin/env node"; cat dst/speechflow.js) >dst/speechflow.js.new &&
+                            mv dst/speechflow.js.new dst/speechflow.js
     build-watch:            nodemon --exec "npm start build" --watch src --ext ts
 
     #   start server run-time
     server-delay:           delay 2.0
-    server-dev-watch: >
+    server:                 node dst/speechflow.js -v info -c sample@sample.yaml
+    server-watch: >
                             cross-env NODE_OPTIONS="--enable-source-maps"
-                            nodemon --exec "npm start server" --watch src --ext ts --delay 1.0
-    server: >
-                            node --env-file=.env                             dst/speechflow.js -v debug -c sample@sample.yaml
-    server-dev:             node --env-file=.env -r ts-node/register --watch src/speechflow.ts -v debug -c sample@sample.yaml
-    server-prd:             node --env-file=.env -r ts-node/register         src/speechflow.ts -v info  -c sample@sample.yaml
+                            nodemon --exec "npm start server" --watch dst --ext ts --delay 1.0
 
     #   cleanup filesystem
     clean:                  rimraf dst

package/package.json

@@ -1,7 +1,7 @@
 {
     "name":                                 "speechflow",
-    "version":                              "0.9.2",
-    "x-stdver":                             "0.9.1-EA",
+    "version":                              "0.9.4",
+    "x-stdver":                             "0.9.4-EA",
     "x-release":                            "2025-04-27",
     "homepage":                             "https://github.com/rse/speechflow",
     "description":                          "Speech Processing Flow Graph",
@@ -60,9 +60,7 @@
         "@types/ws":                        "8.18.1",
         "@types/resolve":                   "1.20.6",
 
-        "ts-node":                          "10.9.2",
         "stmux":                            "1.8.10",
-        "patch-package":                    "8.0.0",
         "nodemon":                          "3.1.10",
         "rimraf":                           "6.0.1",
         "typescript":                       "5.8.3",
@@ -85,6 +83,7 @@
         }
     },
     "scripts": {
-        "start":                            "nps -c etc/nps.yaml"
+        "start":                            "nps -c etc/nps.yaml",
+        "speechflow":                       "node dst/speechflow.js"
     }
 }

package/sample.yaml

@@ -26,7 +26,8 @@ translation: |
      deepl(key: env.SPEECHFLOW_KEY_DEEPL, src: "de", dst: "en-US") |
      file(path: "-", mode: "w", type: "text")
 
+#  sample for development
 sample: |
-     device(device: "wasapi:Voicemeeter Out B1", mode: "r") |
+     device(device: "coreaudio:Elgato Wave:3", mode: "r") |
      file(path: "capture.pcm", mode: "w", type: "audio")
 

package/src/speechflow.ts

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 /*!
 **  SpeechFlow - Speech Processing Flow Graph
 **  Copyright (c) 2024-2025 Dr. Ralf S. Engelschall <rse@engelschall.com>
@@ -326,6 +325,12 @@ let cli: CLIio | null = null
     process.on("SIGINT", () => {
         shutdown("SIGINT")
     })
+    process.on("SIGUSR1", () => {
+        shutdown("SIGUSR1")
+    })
+    process.on("SIGUSR2", () => {
+        shutdown("SIGUSR2")
+    })
     process.on("SIGTERM", () => {
         shutdown("SIGTERM")
     })