node-osc 9.0.1 → 9.1.0

package/.github/workflows/bump-version.yml

@@ -33,12 +33,12 @@ jobs:
     # run that runs on: tag. (Using the GitHub token would
     # not run the workflow to prevent infinite recursion.)
     - name: Check out source
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         ssh-key: ${{ secrets.DEPLOY_KEY }}
 
     - name: Setup Node.js
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: 20
         cache: 'npm'

package/.github/workflows/create-release.yml

@@ -13,9 +13,9 @@ jobs:
       id-token: write
     steps:
     - name: Checkout source
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Setup node
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: 20
         registry-url: 'https://registry.npmjs.org'
@@ -37,7 +37,7 @@ jobs:
       contents: write
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Create Release
         run: gh release create ${{ github.ref }} --generate-notes
         env:

package/.github/workflows/nodejs.yml

@@ -11,16 +11,16 @@ jobs:
   run-tests:
     strategy:
       matrix:
-        node-version: ['20', '18']
+        node-version: ['21', '20', '18']
         os: [ubuntu-latest, macos-latest, windows-latest]
 
     runs-on: ${{ matrix.os }}
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'

package/dist/lib/Message.js

@@ -1,5 +1,12 @@
 'use strict';
 
+const typeTags = {
+  s: 'string',
+  f: 'float',
+  i: 'integer',
+  b: 'blob'
+};
+
 class Argument {
   constructor(type, value) {
     this.type = type;
@@ -21,6 +28,7 @@ class Message {
       if (arg instanceof Array) {
         arg.forEach(a => this.append(a));
       } else if (arg.type) {
+        if (typeTags[arg.type]) arg.type = typeTags[arg.type];
         this.args.push(arg);
       } else {
         throw new Error(`don't know how to encode object ${arg}`);

package/dist/lib/Server.js

@@ -2,7 +2,7 @@
 
 var node_dgram = require('node:dgram');
 var node_events = require('node:events');
-var decode = require('./internal/decode.js');
+var decode = require('#decode');
 
 class Server extends node_events.EventEmitter {
   constructor(port, host='127.0.0.1', cb) {

package/dist/lib/internal/decode.js

@@ -27,6 +27,9 @@ function decode(data) {
   else if (decoded.oscType === 'message') {
     return sanitizeMessage(decoded);
   }
+  else {
+    throw new Error ('Malformed Packet');
+  }
 }
 
 module.exports = decode;

package/dist/test/{test/test-decode.js → test-decode.js}

@@ -1,7 +1,7 @@
 'use strict';
 
 var tap = require('tap');
-var decode = require('../lib/internal/decode.js');
+var decode = require('#decode');
 
 tap.test('decode: valid', (t) => {
   const buf = Buffer.from('/test\0\0\0,s\0,testing\0');
@@ -15,6 +15,14 @@ tap.test('decode: valid', (t) => {
   t.end();
 });
 
+tap.test('decode: malformed packet', (t) => {
+  t.throws(() => {
+    const buf = Buffer.from('/test\0\0');
+    decode(buf);
+  }, /Malformed Packet/);
+  t.end();
+});
+
 tap.test('decode: invalid typetags', (t) => {
   t.throws(() => {
     const buf = Buffer.from('/test\0\0\0,R\0');

package/dist/test/test-message.js

@@ -4,6 +4,10 @@ var tap = require('tap');
 var util = require('./util.js');
 var nodeOsc = require('node-osc');
 
+function round(num) {
+  return Math.round(num * 100) / 100;
+}
+
 tap.beforeEach(util.bootstrap);
 
 tap.test('message: basic usage', (t) => {
@@ -80,7 +84,40 @@ tap.test('message: float', (t) => {
       3.14
     ];
     t.equal(msg[0], expected[0], `We reveived the payload: ${msg}`);
-    t.equal(msg[1][0], expected[1][0], 'pie please');
+    t.equal(round(msg[1]), expected[1], 'pie please');
+    oscServer.close();
+    t.end();
+  });
+
+  client.send(m, () => {
+    client.close();
+  });
+});
+
+tap.test('message: alias messages', (t) => {
+  const oscServer = new nodeOsc.Server(t.context.port, '127.0.0.1');
+  const client = new nodeOsc.Client('127.0.0.1', t.context.port);
+  const m = new nodeOsc.Message('/address');
+  m.append({
+    type: 'i',
+    value: 123
+  });
+  m.append({
+    type: 'f',
+    value: 3.14
+  });
+
+  oscServer.on('message', (msg) => {
+    const expected = [
+      '/address',
+      123,
+      3.14
+    ];
+    t.equal(msg[0], expected[0], `We reveived the payload: ${msg}`);
+    t.equal(msg[1], expected[1], 'easy as abc');
+    t.ok(Number.isInteger(msg[1]), 'the first value is an int');
+    t.equal(round(msg[2]), expected[2], 'pie please');
+    t.ok(msg[2] % 1 !== 0, 'the second value is a float');
     oscServer.close();
     t.end();
   });
@@ -139,7 +176,7 @@ tap.test('message: blob', (t) => {
 // test('message: timetag', (t) => {
 //   const oscServer = new osc.Server(3333, '127.0.0.1');
 //   const client = new osc.Client('127.0.0.1', 3333);
-//   const m = new osc.Message('/address');z
+//   const m = new osc.Message('/address');
 //
 //   oscServer.on('message', (msg) => {
 //     const expected = [

package/lib/Message.mjs

@@ -1,3 +1,10 @@
+const typeTags = {
+  s: 'string',
+  f: 'float',
+  i: 'integer',
+  b: 'blob'
+};
+
 class Argument {
   constructor(type, value) {
     this.type = type;
@@ -19,6 +26,7 @@ class Message {
       if (arg instanceof Array) {
         arg.forEach(a => this.append(a));
       } else if (arg.type) {
+        if (typeTags[arg.type]) arg.type = typeTags[arg.type];
         this.args.push(arg);
       } else {
         throw new Error(`don't know how to encode object ${arg}`);

package/lib/Server.mjs

@@ -1,7 +1,7 @@
 import { createSocket } from 'node:dgram';
 import { EventEmitter } from 'node:events';
 
-import decode from './internal/decode.mjs';
+import decode from '#decode';
 
 class Server extends EventEmitter {
   constructor(port, host='127.0.0.1', cb) {

package/lib/internal/decode.mjs

@@ -25,6 +25,9 @@ function decode(data) {
   else if (decoded.oscType === 'message') {
     return sanitizeMessage(decoded);
   }
+  else {
+    throw new Error ('Malformed Packet');
+  }
 }
 
 export default decode;

package/package.json

@@ -1,11 +1,17 @@
 {
   "name": "node-osc",
   "description": "pyOSC inspired library for sending and receiving OSC messages",
-  "version": "9.0.1",
+  "version": "9.1.0",
   "exports": {
     "require": "./dist/lib/index.js",
     "default": "./lib/index.mjs"
   },
+  "imports": {
+    "#decode": {
+      "require": "./dist/lib/internal/decode.js",
+      "default": "./lib/internal/decode.mjs"
+    }
+  },
   "author": {
     "name": "Myles Borins",
     "email": "myles.borins@gmail.com"
@@ -18,9 +24,9 @@
     "clean": "rm -rf dist/",
     "build": "npm run clean && rollup --config rollup.config.mjs",
     "prepublishOnly": "npm run build",
-    "lint": "eslint \"lib/**/*.mjs\" test/* examples/*",
+    "lint": "eslint \"lib/**/*.mjs\" test/* examples/* rollup.config.mjs",
     "test": "npm run lint && npm run build && npm run test:esm && npm run test:cjs",
-    "test:esm": "tap  -j1 test/test-*.mjs",
+    "test:esm": "tap -j1 test/test-*.mjs",
     "test:cjs": "tap -j1 dist/test/test-*.js"
   },
   "contributors": [
@@ -42,7 +48,7 @@
   "devDependencies": {
     "eslint": "^8.36.0",
     "get-port": "^6.1.2",
-    "rollup": "^3.20.1",
+    "rollup": "^4.9.5",
     "tap": "^18.4.2"
   }
 }

package/rollup.config.mjs

@@ -1,4 +1,5 @@
 import { readdirSync as readdir, statSync as stat } from 'fs';
+import { join } from 'path';
 
 // Borrowed from the rollup docs
 // https://github.com/rollup/rollup/blob/d0db53459be43c5cc806cb91f14e82217950ba42/docs/05-plugin-development.md#renderdynamicimport
@@ -30,8 +31,8 @@ function walk(root, result=[]) {
     }
     else {
       result.push({
-        input: `${root}${path}`,
-        dir: `dist/${root}`
+        input: join(root, path),
+        dir: join('dist/', root)
       });
     }
   }
@@ -54,7 +55,8 @@ function walkLib(config) {
         'node:dgram',
         'node:events',
         'osc-min',
-        'jspack'
+        'jspack',
+        '#decode'
       ]
     });
   });
@@ -78,9 +80,10 @@ function walkTest(config) {
         'get-port',
         'node-osc',
         'osc-min',
-        'tap'
+        'tap',
+        '#decode'
       ]
-    })
+    });
   });
 }
 

package/test/test-decode.mjs

@@ -1,6 +1,6 @@
 import { test } from 'tap';
 
-import decode from '../lib/internal/decode.mjs';
+import decode from '#decode';
 
 test('decode: valid', (t) => {
   const buf = Buffer.from('/test\0\0\0,s\0,testing\0');
@@ -14,6 +14,14 @@ test('decode: valid', (t) => {
   t.end();
 });
 
+test('decode: malformed packet', (t) => {
+  t.throws(() => {
+    const buf = Buffer.from('/test\0\0');
+    decode(buf);
+  }, /Malformed Packet/);
+  t.end();
+});
+
 test('decode: invalid typetags', (t) => {
   t.throws(() => {
     const buf = Buffer.from('/test\0\0\0,R\0');

package/test/test-message.mjs

@@ -3,6 +3,10 @@ import { bootstrap } from './util.mjs';
 
 import { Server, Client, Message } from 'node-osc';
 
+function round(num) {
+  return Math.round(num * 100) / 100;
+}
+
 beforeEach(bootstrap);
 
 test('message: basic usage', (t) => {
@@ -79,7 +83,40 @@ test('message: float', (t) => {
       3.14
     ];
     t.equal(msg[0], expected[0], `We reveived the payload: ${msg}`);
-    t.equal(msg[1][0], expected[1][0], 'pie please');
+    t.equal(round(msg[1]), expected[1], 'pie please');
+    oscServer.close();
+    t.end();
+  });
+
+  client.send(m, () => {
+    client.close();
+  });
+});
+
+test('message: alias messages', (t) => {
+  const oscServer = new Server(t.context.port, '127.0.0.1');
+  const client = new Client('127.0.0.1', t.context.port);
+  const m = new Message('/address');
+  m.append({
+    type: 'i',
+    value: 123
+  });
+  m.append({
+    type: 'f',
+    value: 3.14
+  });
+
+  oscServer.on('message', (msg) => {
+    const expected = [
+      '/address',
+      123,
+      3.14
+    ];
+    t.equal(msg[0], expected[0], `We reveived the payload: ${msg}`);
+    t.equal(msg[1], expected[1], 'easy as abc');
+    t.ok(Number.isInteger(msg[1]), 'the first value is an int');
+    t.equal(round(msg[2]), expected[2], 'pie please');
+    t.ok(msg[2] % 1 !== 0, 'the second value is a float');
     oscServer.close();
     t.end();
   });
@@ -138,7 +175,7 @@ test('message: blob', (t) => {
 // test('message: timetag', (t) => {
 //   const oscServer = new osc.Server(3333, '127.0.0.1');
 //   const client = new osc.Client('127.0.0.1', 3333);
-//   const m = new osc.Message('/address');z
+//   const m = new osc.Message('/address');
 //
 //   oscServer.on('message', (msg) => {
 //     const expected = [

package/.github/workflows/codeql-analysis.yml

@@ -1,51 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: "CodeQL"
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ main ]
-  schedule:
-    - cron: '44 5 * * 1'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'javascript' ]
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1

package/dist/test/lib/internal/decode.js

@@ -1,32 +0,0 @@
-'use strict';
-
-var oscMin = require('osc-min');
-
-function sanitizeMessage(decoded) {
-  const message = [];
-  message.push(decoded.address);
-  decoded.args.forEach(arg => {
-    message.push(arg.value);
-  });
-  return message;
-}
-
-function sanitizeBundle(decoded) {
-  decoded.elements = decoded.elements.map(element => {
-    if (element.oscType === 'bundle') return sanitizeBundle(element);
-    else if (element.oscType === 'message') return sanitizeMessage(element);
-  });
-  return decoded;
-}
-
-function decode(data) {
-  const decoded = oscMin.fromBuffer(data);
-  if (decoded.oscType === 'bundle') {
-    return sanitizeBundle(decoded);
-  }
-  else if (decoded.oscType === 'message') {
-    return sanitizeMessage(decoded);
-  }
-}
-
-module.exports = decode;