bump @jwetzell/osc to v1.3.0

add support for osc array types

apps/makeosc/package.json

@@ -21,7 +21,7 @@
   "license": "MIT",
   "dependencies": {
     "@jwetzell/osc": "0.2.2",
-    "commander": "^11.0.0",
+    "commander": "^12.1.0",
     "slip": "^1.0.2"
   }
 }

apps/readosc/package.json

@@ -21,6 +21,6 @@
   "license": "MIT",
   "dependencies": {
     "@jwetzell/osc": "1.0.0",
-    "commander": "^11.0.0"
+    "commander": "^12.1.0"
   }
 }

apps/sendosc/package.json

@@ -21,7 +21,7 @@
   "license": "MIT",
   "dependencies": {
     "@jwetzell/osc": "0.2.2",
-    "commander": "^11.0.0",
+    "commander": "^12.1.0",
     "slip": "^1.0.2"
   }
 }

package-lock.json

@@ -23,7 +23,7 @@
       "license": "MIT",
       "dependencies": {
         "@jwetzell/osc": "0.2.2",
-        "commander": "^11.0.0",
+        "commander": "^12.1.0",
         "slip": "^1.0.2"
       },
       "bin": {
@@ -40,7 +40,7 @@
       "license": "MIT",
       "dependencies": {
         "@jwetzell/osc": "1.0.0",
-        "commander": "^11.0.0"
+        "commander": "^12.1.0"
       },
       "bin": {
         "readosc": "src/main.js"
@@ -56,7 +56,7 @@
       "license": "MIT",
       "dependencies": {
         "@jwetzell/osc": "0.2.2",
-        "commander": "^11.0.0",
+        "commander": "^12.1.0",
         "slip": "^1.0.2"
       },
       "bin": {
@@ -255,9 +255,10 @@
       "peer": true
     },
     "node_modules/@types/node": {
-      "version": "22.7.4",
+      "version": "22.7.5",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-22.7.5.tgz",
+      "integrity": "sha512-jML7s2NAzMWc//QSJ1a3prpk78cOPchGvXJsC3C6R6PSMoooztvRVQEz89gmBTBY1SPMaqo5teB4uNHPdetShQ==",
       "dev": true,
-      "license": "MIT",
       "dependencies": {
         "undici-types": "~6.19.2"
       }
@@ -611,10 +612,11 @@
       "license": "MIT"
     },
     "node_modules/commander": {
-      "version": "11.1.0",
-      "license": "MIT",
+      "version": "12.1.0",
+      "resolved": "https://registry.npmjs.org/commander/-/commander-12.1.0.tgz",
+      "integrity": "sha512-Vw8qHK3bZM9y/P10u3Vib8o/DdkvA2OtPtZvD871QKjy74Wj1WSKFILMPRPSdUSx5RFK1arlJzEtA4PkFgnbuA==",
       "engines": {
-        "node": ">=16"
+        "node": ">=18"
       }
     },
     "node_modules/concat-map": {
@@ -3406,9 +3408,10 @@
       }
     },
     "node_modules/typescript": {
-      "version": "5.6.2",
+      "version": "5.6.3",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.3.tgz",
+      "integrity": "sha512-hjcS1mhfuyi4WW8IWtjP7brDrG2cuDZukyrYrSauoXGNgx0S7zceP07adYkJycEr56BOUTNPzbInooiN3fn1qw==",
       "dev": true,
-      "license": "Apache-2.0",
       "bin": {
         "tsc": "bin/tsc",
         "tsserver": "bin/tsserver"
@@ -3648,12 +3651,12 @@
     },
     "packages/osc": {
       "name": "@jwetzell/osc",
-      "version": "1.1.0",
+      "version": "1.3.0",
       "license": "MIT",
       "devDependencies": {
-        "@types/node": "22.7.4",
+        "@types/node": "22.7.5",
         "rimraf": "6.0.1",
-        "typescript": "5.6.2"
+        "typescript": "5.6.3"
       }
     }
   }

packages/osc/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jwetzell/osc",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,8 +25,8 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "22.7.4",
+    "@types/node": "22.7.5",
     "rimraf": "6.0.1",
-    "typescript": "5.6.2"
+    "typescript": "5.6.3"
   }
 }

packages/osc/src/message.ts

@@ -33,12 +33,29 @@ export function messageToBuffer(message: OSCMessage): Uint8Array {
     throw new Error('problem encoding address');
   }
 
-  const typeString = message.args.map((arg) => arg.type).join('');
-  const typesBuffer = oscTypeConverterMap.s.toBuffer(`,${typeString}`);
+  let typeString = ','
+
+  const flatOSCArgs: OSCArg[] = []
+
+  message.args.forEach((oscArg)=> {
+    if(Array.isArray(oscArg)){
+      typeString += '['
+      oscArg.forEach((oscArg)=>{
+        typeString += oscArg.type
+        flatOSCArgs.push(oscArg)
+      })
+      typeString += ']'
+    }else {
+      typeString += oscArg.type
+      flatOSCArgs.push(oscArg)
+    }
+  })
+
+  const typesBuffer = oscTypeConverterMap.s.toBuffer(typeString);
   if (typesBuffer === undefined) {
     throw new Error('problem encoding types');
   }
-  const argsBuffer = argsToBuffer(message.args);
+  const argsBuffer = argsToBuffer(flatOSCArgs);
   const buffer = new Uint8Array(addressBuffer.length + typesBuffer.length + argsBuffer.length);
   buffer.set(addressBuffer, 0);
   buffer.set(typesBuffer, addressBuffer.length);
@@ -51,7 +68,7 @@ export function messageFromBuffer(bytes: Uint8Array): [OSCMessage | undefined, U
     throw new Error('osc message must start with a /');
   }
 
-  const oscArgs: OSCArg[] = [];
+  const oscArgs: (OSCArg | OSCArg[])[] = [];
 
   const [address, bytesAfterAddress] = oscTypeConverterMap.s.fromBuffer(bytes);
   if (typeof address === 'string') {
@@ -61,9 +78,30 @@ export function messageFromBuffer(bytes: Uint8Array): [OSCMessage | undefined, U
         throw new Error('osc type string must start with a ,');
       }
       let argsBuffer = bytesAfterType;
+      let oscArrayArg: OSCArg[] = [];
+      let insideArgArray = false;
       for (let index = 1; index < typeString.length; index++) {
         const argType = typeString.charAt(index) as OSCType;
 
+        if (argType === '['){
+          if (insideArgArray){
+            throw new Error('osc arg array opened without closing previous arg array')
+          }
+          oscArrayArg = [];
+          insideArgArray = true;
+          continue;
+        }
+
+        if (argType === ']'){
+          if (!insideArgArray){
+            throw new Error('osc arg array closed without opening arg array')
+          }
+          oscArgs.push(oscArrayArg);
+          oscArrayArg = [];
+          insideArgArray = false;
+          continue;
+        }
+
         const oscTypeConverter = oscTypeConverterMap[argType];
         if (oscTypeConverter === undefined) {
           throw new Error('unknown OSC type');
@@ -74,7 +112,11 @@ export function messageFromBuffer(bytes: Uint8Array): [OSCMessage | undefined, U
             type: argType,
             value: value,
           };
-          oscArgs.push(arg);
+          if(insideArgArray){
+            oscArrayArg.push(arg)
+          }else {
+            oscArgs.push(arg);
+          }
         }
         argsBuffer = remainingBytes;
       }

packages/osc/src/models.ts

@@ -1,7 +1,7 @@
-export type OSCType = 's' | 'i' | 'f' | 'b' | 'T' | 'F' | 't' | 'r';
+export type OSCType = 's' | 'i' | 'f' | 'b' | 'T' | 'F' | 't' | 'r' | 'N' | '[' | ']';
 export type OSCArg = {
   type: OSCType;
-  value: string | number | Uint8Array | boolean | OSCTimeTag | OSCColor;
+  value: string | number | Uint8Array | boolean | OSCTimeTag | OSCColor | bigint | null;
 };
 
 export type OSCTimeTag = [number, number];
@@ -20,12 +20,14 @@ export type OSCBundle = {
 
 export type OSCMessage = {
   address: string;
-  args: OSCArg[];
+  args: (OSCArg | OSCArg[])[];
 };
 
 export type OSCTypeConverter = {
-  toBuffer: (value: string | number | Uint8Array | boolean | OSCTimeTag | OSCColor) => Uint8Array | undefined;
+  toBuffer: (
+    value: string | number | Uint8Array | boolean | OSCTimeTag | OSCColor | null | bigint
+  ) => Uint8Array | undefined;
   fromBuffer: (
     buffer: Uint8Array
-  ) => [string | number | Uint8Array | boolean | OSCTimeTag | OSCColor | undefined, Uint8Array];
+  ) => [string | number | Uint8Array | boolean | OSCTimeTag | OSCColor | null | bigint | undefined, Uint8Array];
 };

packages/osc/src/osc-types.ts

@@ -160,7 +160,7 @@ export const oscTypeConverterMap: { [key: string]: OSCTypeConverter } = {
     },
     fromBuffer: (buffer) => {
       if (buffer.length < 8) {
-        throw new Error('osc time tag must be greater than 8 bytes');
+        throw new Error('osc time tag must be at least 8 bytes');
       }
       const [seconds, bytesAfterSeconds] = oscTypeConverterMap.i.fromBuffer(buffer);
       const [fractional, bytesAfterFractional] = oscTypeConverterMap.i.fromBuffer(bytesAfterSeconds);
@@ -173,6 +173,10 @@ export const oscTypeConverterMap: { [key: string]: OSCTypeConverter } = {
   },
   r: {
     toBuffer: (color) => {
+      if (color === undefined || color === null) {
+        throw new TypeError('osc type r called with undefined or null value');
+      }
+
       if (typeof color === 'object' && 'r' in color && 'g' in color && 'b' in color && 'a' in color) {
         const view = new DataView(new ArrayBuffer(4));
 
@@ -216,4 +220,69 @@ export const oscTypeConverterMap: { [key: string]: OSCTypeConverter } = {
       throw new Error('problem converting osc ');
     },
   },
+  N: {
+    toBuffer: () => {
+      return new Uint8Array(0);
+    },
+    fromBuffer: (buffer) => {
+      return [null, buffer];
+    },
+  },
+  I: {
+    toBuffer: () => {
+      return new Uint8Array();
+    },
+    fromBuffer: (buffer) => {
+      return [Number.MAX_SAFE_INTEGER, buffer];
+    },
+  },
+  h: {
+    toBuffer: (number) => {
+      const view = new DataView(new ArrayBuffer(8));
+
+      if (typeof number === 'number') {
+        view.setBigInt64(0, BigInt(number));
+      } else if (typeof number === 'bigint') {
+        view.setBigInt64(0, number);
+      } else {
+        throw new TypeError('osc type h toBuffer called with non number or bigint value');
+      }
+      return new Uint8Array(view.buffer);
+    },
+    fromBuffer: (buffer) => {
+      if (buffer.length < 8) {
+        throw new Error('osc int64 must be at least 8 bytes');
+      }
+
+      const view = new DataView(new ArrayBuffer(8));
+      buffer.subarray(0, 8).forEach((byte, index) => {
+        view.setUint8(index, byte);
+      });
+
+      return [view.getBigInt64(0), buffer.subarray(8)];
+    },
+  },
+  d: {
+    toBuffer: (number) => {
+      if (typeof number === 'number') {
+        const view = new DataView(new ArrayBuffer(8));
+        view.setFloat64(0, number);
+        return new Uint8Array(view.buffer);
+      }
+      throw new TypeError('osc type d toBuffer called with non number value');
+    },
+    fromBuffer: (buffer) => {
+      if (buffer.length < 8) {
+        throw new Error('not enough bytes to read a osc float');
+      }
+      const view = new DataView(new ArrayBuffer(8));
+
+      buffer.subarray(0, 8).forEach((byte, index) => {
+        view.setUint8(index, byte);
+      });
+
+      const value = view.getFloat64(0);
+      return [value, buffer.subarray(8)];
+    },
+  },
 };

packages/osc/tests/bundle-decode.test.js

@@ -21,7 +21,7 @@ const tests = [
     },
   },
   {
-    decription: 'resolume bundle example',
+    description: 'resolume bundle example',
     bytes: new Uint8Array([
       0x23, 0x62, 0x75, 0x6e, 0x64, 0x6c, 0x65, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00,
       0x28, 0x2f, 0x63, 0x6f, 0x6d, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x69, 0x6f, 0x6e, 0x2f, 0x6c, 0x61, 0x79, 0x65, 0x72,

packages/osc/tests/message-decode.test.js

@@ -43,6 +43,35 @@ const tests = [
     bytes: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 114, 0, 0, 20, 21, 22, 10]),
     expected: { address: '/hello', args: [{ type: 'r', value: { r: 20, g: 21, b: 22, a: 10 } }] },
   },
+  {
+    description: 'simple address nil arg',
+    bytes: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 78, 0, 0]),
+    expected: { address: '/hello', args: [{ type: 'N', value: null }] },
+  },
+  {
+    description: 'simple address Inifinitum arg',
+    bytes: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 73, 0, 0]),
+    expected: { address: '/hello', args: [{ type: 'I', value: Number.MAX_SAFE_INTEGER }] },
+  },
+  {
+    description: 'simple address int64 arg',
+    bytes: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 104, 0, 0, 0, 0, 255, 255, 255, 255, 255, 255]),
+    expected: { address: '/hello', args: [{ type: 'h', value: 281474976710655n }] },
+  },
+  {
+    description: 'simple address float64 arg',
+    bytes: new Uint8Array([
+      47, 104, 101, 108, 108, 111, 0, 0, 44, 100, 0, 0, 0x40, 0x29, 0x87, 0xec, 0x82, 0x74, 0xb9, 0xe6,
+    ]),
+    expected: { address: '/hello', args: [{ type: 'd', value: 12.7654763 }] },
+  },
+  {
+    description: 'simple address array arg',
+    bytes: new Uint8Array([
+      47, 104, 101, 108, 108, 111, 0, 0, 44, 91, 100, 105, 93, 0, 0, 0, 0x40, 0x29, 0x87, 0xec, 0x82, 0x74, 0xb9, 0xe6, 0, 0, 3, 232
+    ]),
+    expected: { address: '/hello', args: [[{ type: 'd', value: 12.7654763 }, { type: 'i', value: 1000}]] },
+  },
   {
     description: 'osc 1.0 spec example 1',
     bytes: new Uint8Array([

packages/osc/tests/message-encode.test.js

@@ -43,6 +43,30 @@ const tests = [
     message: { address: '/hello', args: [{ type: 'r', value: { r: 20, g: 21, b: 22, a: 10 } }] },
     expected: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 114, 0, 0, 20, 21, 22, 10]),
   },
+  {
+    description: 'simple address nil arg',
+    message: { address: '/hello', args: [{ type: 'N', value: null }] },
+    expected: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 78, 0, 0]),
+  },
+  {
+    description: 'simple address int64 arg',
+    message: { address: '/hello', args: [{ type: 'h', value: 281474976710655n }] },
+    expected: new Uint8Array([47, 104, 101, 108, 108, 111, 0, 0, 44, 104, 0, 0, 0, 0, 255, 255, 255, 255, 255, 255]),
+  },
+  {
+    description: 'simple address float64 arg',
+    message: { address: '/hello', args: [{ type: 'd', value: 12.7654763 }] },
+    expected: new Uint8Array([
+      47, 104, 101, 108, 108, 111, 0, 0, 44, 100, 0, 0, 0x40, 0x29, 0x87, 0xec, 0x82, 0x74, 0xb9, 0xe6,
+    ]),
+  },
+  {
+    description: 'simple address array arg',
+    message: { address: '/hello', args: [[{ type: 'd', value: 12.7654763 }, { type: 'i', value: 1000}]] },
+    expected: new Uint8Array([
+      47, 104, 101, 108, 108, 111, 0, 0, 44, 91, 100, 105, 93, 0, 0, 0, 0x40, 0x29, 0x87, 0xec, 0x82, 0x74, 0xb9, 0xe6, 0, 0, 3, 232
+    ]),
+  },
   {
     description: 'osc 1.0 spec example 1',
     message: { address: '/oscillator/4/frequency', args: [{ type: 'f', value: 440 }] },