kmosc is cli now to send osc

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
   "[typescript]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
   },
   "[javascript]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"

km-plugin/kmosc/Action.jxa

@@ -8,9 +8,6 @@ const address = app.systemAttribute('KMPARAM_Address')
 const value = app.systemAttribute('KMPARAM_Value')
 const valueType = app.systemAttribute('KMPARAM_ValueType')
 
-const url = `kmosc://${host}:${port}${address}?value=${value}&valueType=${valueType}`
+const command = `/Applications/KMOSC.app/Contents/MacOS/KMOSC send ${host} ${port} "${address}" ${valueType} ${value}`
 
-// open a url in the default browser
-try {
-  app.openLocation(url)
-} catch (error) {}
+app.doShellScript(command)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "KMOSC",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Running Keyboards Maestro Macros with OSC",
   "main": "./out/main/index.js",
   "author": "Gareth Loot",
@@ -44,8 +44,10 @@
     "@electron-toolkit/utils": "^3.0.0",
     "@picocss/pico": "^2.0.3",
     "@types/node-osc": "^6.0.3",
+    "commander": "^12.0.0",
     "electron-updater": "^6.1.7",
-    "node-osc": "^9.1.0"
+    "node-osc": "^9.1.0",
+    "zod": "^3.22.4"
   },
   "devDependencies": {
     "@electron-toolkit/eslint-config-prettier": "^2.0.0",

src/main/OSCServer.ts

@@ -3,9 +3,7 @@ import { runMacro } from './macro'
 import Preferences from './preferences'
 
 const createOSCServer = (port: number): Server => {
-  const oscServer = new Server(port, '0.0.0.0', () => {
-    console.log('OSC Server is listening')
-  })
+  const oscServer = new Server(port, '0.0.0.0')
 
   return oscServer
 }
@@ -25,7 +23,6 @@ class OSCServer {
       const [address, ...args] = msg
       const macroName = this.preferences.slashRequired ? address : address.substring(1)
       const parameters = args.join(',')
-      console.log(`Running macro: ${macroName} with parameters: ${parameters}`)
       runMacro(macroName, parameters)
     })
   }

src/main/index.ts

@@ -1,26 +1,23 @@
 import { app, ipcMain } from 'electron'
-import { electronApp, optimizer } from '@electron-toolkit/utils'
+import { optimizer } from '@electron-toolkit/utils'
 import TrayMenu from './TrayMenu'
-import { resolve } from 'path'
 import Preferences from './preferences'
 import OSCServer from './OSCServer'
-import OSCClient from './OSCClient'
+import { runCLI } from './runCLI'
 
-if (process.defaultApp) {
-  if (process.argv.length >= 2) {
-    app.setAsDefaultProtocolClient('kmosc', process.execPath, [resolve(process.argv[1])])
+const checkIfCalledViaCLI = (args): boolean => {
+  if (!app.isPackaged) return false
+  if (args && args.length > 1) {
+    return true
   }
-} else {
-  app.setAsDefaultProtocolClient('kmosc')
+  return false
 }
 
-app.whenReady().then(() => {
-  electronApp.setAppUserModelId('nl.garethloot.KMOSC')
+const runApp = (): void => {
   app.dock.hide()
 
   const preferences = new Preferences()
   const oscServer = new OSCServer(preferences)
-  new OSCClient()
   new TrayMenu()
 
   ipcMain.on('changePort', (_, arg) => {
@@ -49,4 +46,13 @@ app.whenReady().then(() => {
   app.on('will-quit', () => {
     oscServer.close()
   })
+}
+
+app.whenReady().then(() => {
+  const cli = checkIfCalledViaCLI(process.argv)
+  if (cli) {
+    runCLI()
+  } else {
+    runApp()
+  }
 })

src/main/runCLI.ts

@@ -0,0 +1,29 @@
+import { app } from 'electron'
+import { sendOSCMessage } from './sendOSCMessage'
+import { Command } from 'commander'
+
+export const runCLI = (): void => {
+  const program = new Command()
+
+  program
+    .name('KMOSC')
+    .description('KMOSC CLI tool for sending OSC messages.')
+    .version(app.getVersion())
+    .command('send')
+    .argument('<host>')
+    .argument('<port>')
+    .argument('<address>')
+    .argument('<type>')
+    .argument('<message>')
+    .action((host, port, address, type, message) => {
+      if (!host || !port || !address || !type || !message) {
+        program.help()
+        process.exit(1)
+      } else {
+        sendOSCMessage(host, port, address, type, message)
+        app.quit()
+      }
+    })
+
+  program.parse()
+}

src/main/sendOSCMessage.ts

@@ -0,0 +1,74 @@
+import { Client, Message } from 'node-osc'
+import { z } from 'zod'
+
+const schema = z.object({
+  host: z
+    .string()
+    .ip({ message: 'Error: <host> must be a valid email address or localhost' })
+    .or(z.literal('localhost')),
+  port: z.coerce
+    .number()
+    .gt(1, { message: 'Error: <port> must be a number greater than 1' })
+    .refine((value) => !isNaN(value), {
+      message: 'Error: <port> must be a number greater than 1'
+    }),
+  address: z.string().startsWith('/', { message: 'Error: <address> must start with a /' }),
+  type: z.string().refine((value) => ['int', 'float', 'string', 'boolean'].includes(value), {
+    message: 'Error: <message> must be one of "int", "float", "string", or "boolean"'
+  }),
+  message: z.string().min(1, { message: 'Error: <message> must be a non-empty string' })
+})
+
+export const sendOSCMessage = (
+  host: string,
+  port: string,
+  address: string,
+  valueType: 'int' | 'boolean' | 'float' | 'string',
+  value: string
+): void => {
+  const parsed = schema.safeParse({
+    host,
+    port,
+    address,
+    type: valueType,
+    message: value
+  })
+
+  if (!parsed.success) {
+    console.error(parsed.error.errors.forEach((error) => console.error(error.message)))
+    return
+  }
+
+  const message: Message = new Message(parsed.data.address)
+
+  switch (parsed.data.type) {
+    case 'int':
+      message.append(parseInt(parsed.data.message))
+      break
+    case 'float':
+      message.append(parseFloat(parsed.data.message))
+      break
+    case 'boolean':
+      if (parsed.data.message === 'false' || parsed.data.message === '0') {
+        message.append(false)
+        break
+      } else if (parsed.data.message === 'true' || parsed.data.message === '1') {
+        message.append(true)
+        break
+      }
+      break
+    case 'string':
+      message.append(parsed.data.message)
+      break
+    default:
+      return
+  }
+
+  const oscClient = new Client(parsed.data.host, Number(parsed.data.port))
+  oscClient.send(message, (error) => {
+    if (error) {
+      console.error('Error sending OSC message:', error)
+    }
+    oscClient.close()
+  })
+}

src/renderer/src/App.svelte

@@ -1,15 +1,10 @@
 <script lang="ts">
   import { type PreferencesJSON } from '../../shared/types'
 
-  window.electron.ipcRenderer.on('log-item', (_, message) => {
-    console.log(message)
-  })
-
   let preferences: PreferencesJSON
 
   const getPreferences = (): void => {
     window.electron.ipcRenderer.invoke('getPreferences').then((res: PreferencesJSON) => {
-      console.log(res)
       preferences = res
     })
   }