@sndwrks/osc-cli 1.0.0 → 1.0.1

package/README.md

@@ -37,7 +37,7 @@ npm install
 ### Install from npm (if published)
 
 ```bash
-npm install -g osc-cli
+npm install -g @sndwrks/osc-cli
 ```
 
 ## Build
@@ -50,6 +50,12 @@ npm run build
 
 Once installed globally, use the `osc-cli` command. If not installed globally, use `npm start` instead.
 
+```bash
+npm start -- listen-udp <port>
+npm start -- listen-tcp <port>
+npm start -- listen-both <udp-port> <tcp-port>
+```
+
 ### Listen for OSC Messages
 
 **UDP (default port 57121):**
@@ -79,6 +85,7 @@ osc-cli send-udp /synth/note 440 0.5 localhost 8000
 ```
 
 **TCP:**
+NOTE: This is currently broken due to issue in osc.js
 ```bash
 osc-cli send-tcp /test hello 123 127.0.0.1 57122
 osc-cli send-tcp /synth/note 440 0.5 localhost 8001

package/dist/cli.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { listenUDP, listenTCP, sendUDP, sendTCP, logger } from './index.js';
+import { listenUDP, listenTCP, sendUDP, sendTCP, logger, } from './index.js';
 // CLI Interface
 const args = process.argv.slice(2);
 const command = args[0];
@@ -25,7 +25,7 @@ switch (command) {
             process.exit(1);
         }
         const udpAddress = args[1];
-        const udpArgs = args.slice(2, -2).map(arg => {
+        const udpArgs = args.slice(2, -2).map((arg) => {
             const num = parseFloat(arg);
             return isNaN(num) ? arg : num;
         });
@@ -39,7 +39,7 @@ switch (command) {
             process.exit(1);
         }
         const tcpAddress = args[1];
-        const tcpArgs = args.slice(2, -2).map(arg => {
+        const tcpArgs = args.slice(2, -2).map((arg) => {
             const num = parseFloat(arg);
             return isNaN(num) ? arg : num;
         });

package/dist/index.js

@@ -1,13 +1,14 @@
 import osc from 'osc';
 import { beginLogging, configureLogger } from '@sndwrks/lumberjack';
+import * as net from 'node:net';
 // Configure logger globally
 configureLogger({
     logToConsole: {
         enabled: true,
-        type: 'pretty'
+        type: 'pretty',
     },
     logLevel: 'info',
-    service: 'osc-cli'
+    service: 'osc-cli',
 });
 // Create logger instance
 const logger = beginLogging({ name: 'OSC-CLI' });
@@ -18,7 +19,7 @@ export function listenUDP(port = 57121) {
     const udpPort = new osc.UDPPort({
         localAddress: '0.0.0.0',
         localPort: port,
-        metadata: true
+        metadata: true,
     });
     udpPort.on('ready', () => {
         logger.info(`Listening for OSC over UDP on port ${port}`);
@@ -26,7 +27,7 @@ export function listenUDP(port = 57121) {
     udpPort.on('message', (oscMsg) => {
         logger.info('UDP OSC message received:', {
             address: oscMsg.address,
-            args: oscMsg.args
+            args: oscMsg.args,
         });
     });
     udpPort.on('error', (err) => {
@@ -39,25 +40,31 @@ export function listenUDP(port = 57121) {
  * Listen for OSC messages via TCP
  */
 export function listenTCP(port = 57122) {
-    const tcpPort = new osc.TCPSocketPort({
-        localAddress: '0.0.0.0',
-        localPort: port,
-        metadata: true
-    });
-    tcpPort.on('ready', () => {
-        logger.info(`Listening for OSC over TCP on port ${port}`);
-    });
-    tcpPort.on('message', (oscMsg) => {
-        logger.info('TCP OSC message received:', {
-            address: oscMsg.address,
-            args: oscMsg.args
+    let tcpPort;
+    const tcpServer = net.createServer((socket) => {
+        tcpPort = new osc.TCPSocketPort({
+            socket,
         });
+        tcpPort.on('ready', () => {
+            logger.info(`Listening for OSC over TCP on port ${port}`);
+        });
+        tcpPort.on('data', (oscMsg) => {
+            logger.info('TCP OSC message received:', {
+                address: oscMsg.address,
+                args: oscMsg.args,
+            });
+        });
+        tcpPort.on('error', (err) => {
+            logger.error('TCP Error:', err);
+        });
+        tcpPort.listen();
     });
-    tcpPort.on('error', (err) => {
-        logger.error('TCP Error:', err);
+    tcpServer.on('error', (e) => {
+        logger.error(e);
+    });
+    tcpServer.listen(port, '0.0.0.0', () => {
+        logger.info('TCP server listening on port');
     });
-    tcpPort.open();
-    return tcpPort;
 }
 /**
  * Send OSC message via UDP
@@ -66,13 +73,13 @@ export function sendUDP(address, args, host = '127.0.0.1', port = 57121) {
     const udpPort = new osc.UDPPort({
         localAddress: '0.0.0.0',
         localPort: 0,
-        metadata: true
+        metadata: true,
     });
     udpPort.on('ready', () => {
         logger.info(`Sending OSC message via UDP to ${host}:${port}`);
         udpPort.send({
-            address: address,
-            args: args
+            address,
+            args,
         }, host, port);
         logger.info('Message sent:', { address, args });
         // Close after sending
@@ -90,27 +97,28 @@ export function sendUDP(address, args, host = '127.0.0.1', port = 57121) {
  */
 export function sendTCP(address, args, host = '127.0.0.1', port = 57122) {
     const tcpPort = new osc.TCPSocketPort({
-        localAddress: '0.0.0.0',
-        localPort: 0,
-        remoteAddress: host,
-        remotePort: port,
-        metadata: true
+        address: '0.0.0.0',
+        port: 52000,
     });
+    logger.info(`Attempting send... address: ${address}, args: ${args}, host: ${host}, port: ${port}`);
+    logger.info({ tcpPort });
     tcpPort.on('ready', () => {
         logger.info(`Sending OSC message via TCP to ${host}:${port}`);
         tcpPort.send({
-            address: address,
-            args: args
+            address,
+            args,
         });
         logger.info('Message sent:', { address, args });
         // Close after sending
         setTimeout(() => {
             tcpPort.close();
+            logger.info('TCP Port closed.');
+            process.exit(0);
         }, 100);
     });
     tcpPort.on('error', (err) => {
         logger.error('TCP Send Error:', err);
     });
-    tcpPort.open();
+    tcpPort.open(host, port);
 }
 export { logger };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sndwrks/osc-cli",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Simple OSC command-line tool",
   "keywords": [
     "osc",
@@ -31,17 +31,22 @@
   ],
   "scripts": {
     "build": "tsc",
-    "start": "node dist/index.js",
-    "dev": "tsc && node dist/index.js",
+    "start": "node dist/cli.js",
+    "dev": "tsc && node dist/cli.js",
     "prepublishOnly": "npm run build",
     "prepack": "npm run build"
   },
   "dependencies": {
     "@sndwrks/lumberjack": "^0.8.0",
-    "osc": "^2.4.4"
+    "osc": "^2.4.5"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",
-    "typescript": "^5.0.0"
+    "typescript": "^5.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.50.1",
+    "@typescript-eslint/parser": "^8.34.1",
+    "eslint": "^8.57.1",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-import-resolver-typescript": "^4.4.3"
   }
 }