buttplug 3.2.1 → 4.0.0

package/examples/node/device-enumeration-example.ts

@@ -0,0 +1,86 @@
+// Buttplug TypeScript - Device Enumeration Example
+//
+// This example demonstrates how to scan for devices and handle
+// device connection/disconnection events.
+//
+// Prerequisites:
+// 1. Install Intiface Central: https://intiface.com/central
+// 2. Start the server in Intiface Central
+// 3. Run: npx ts-node --esm device-enumeration-example.ts
+
+import {
+  ButtplugClient,
+  ButtplugNodeWebsocketClientConnector,
+  ButtplugClientDevice,
+} from 'buttplug';
+import * as readline from 'readline';
+
+async function waitForEnter(prompt: string): Promise<void> {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+  return new Promise((resolve) => {
+    rl.question(prompt, () => {
+      rl.close();
+      resolve();
+    });
+  });
+}
+
+async function main(): Promise<void> {
+  const client = new ButtplugClient('Device Enumeration Example');
+
+  // Set up event handlers BEFORE connecting.
+  // This ensures we don't miss any events.
+
+  client.addListener('deviceadded', (device: ButtplugClientDevice) => {
+    console.log(`Device connected: ${device.name}`);
+  });
+
+  client.addListener('deviceremoved', (device: ButtplugClientDevice) => {
+    console.log(`Device disconnected: ${device.name}`);
+  });
+
+  client.addListener('scanningfinished', () => {
+    console.log('Scanning finished.');
+  });
+
+  // Connect to the server
+  const connector = new ButtplugNodeWebsocketClientConnector(
+    'ws://127.0.0.1:12345'
+  );
+
+  console.log('Connecting...');
+  await client.connect(connector);
+  console.log('Connected!');
+
+  // Start scanning for devices.
+  // Devices will be announced via the 'deviceadded' event.
+  console.log('\nStarting device scan...');
+  console.log('Turn on your devices now!');
+  await client.startScanning();
+
+  await waitForEnter('\nPress Enter to stop scanning...');
+
+  // Stop scanning. Some protocols scan continuously until told to stop.
+  await client.stopScanning();
+
+  // The client maintains a map of all known devices.
+  // This map persists even after scanning stops.
+  console.log('\nCurrently connected devices:');
+  if (client.devices.size === 0) {
+    console.log('  (no devices connected)');
+  } else {
+    for (const [index, device] of client.devices) {
+      console.log(`  - ${device.name} (Index: ${index})`);
+    }
+  }
+
+  await waitForEnter('\nPress Enter to disconnect...');
+
+  await client.disconnect();
+  console.log('Disconnected.');
+}
+
+main().catch(console.error);

package/examples/node/device-info-example.ts

@@ -0,0 +1,131 @@
+// Buttplug TypeScript - Device Info Example
+//
+// This example demonstrates how to introspect device features
+// and capabilities in detail.
+//
+// Prerequisites:
+// 1. Install Intiface Central: https://intiface.com/central
+// 2. Start the server in Intiface Central
+// 3. Run: npx ts-node --esm device-info-example.ts
+
+import {
+  ButtplugClient,
+  ButtplugNodeWebsocketClientConnector,
+  ButtplugClientDevice,
+  OutputType,
+  InputType,
+} from 'buttplug';
+import * as readline from 'readline';
+
+async function waitForEnter(prompt: string): Promise<void> {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+  return new Promise((resolve) => {
+    rl.question(prompt, () => {
+      rl.close();
+      resolve();
+    });
+  });
+}
+
+function printDeviceInfo(device: ButtplugClientDevice): void {
+  console.log(`\n${'='.repeat(50)}`);
+  console.log(`Device: ${device.name}`);
+  if (device.displayName) {
+    console.log(`Display Name: ${device.displayName}`);
+  }
+  console.log(`Index: ${device.index}`);
+  if (device.messageTimingGap !== undefined) {
+    console.log(`Message Timing Gap: ${device.messageTimingGap}ms`);
+  }
+  console.log(`${'='.repeat(50)}`);
+
+  // Collect output capabilities
+  const outputTypes: string[] = [];
+  if (device.hasOutput(OutputType.Vibrate)) outputTypes.push('Vibrate');
+  if (device.hasOutput(OutputType.Rotate)) outputTypes.push('Rotate');
+  if (device.hasOutput(OutputType.Oscillate)) outputTypes.push('Oscillate');
+  if (device.hasOutput(OutputType.Position)) outputTypes.push('Position');
+  if (device.hasOutput(OutputType.Constrict)) outputTypes.push('Constrict');
+  if (device.hasOutput(OutputType.Inflate)) outputTypes.push('Inflate');
+  if (device.hasOutput(OutputType.Temperature)) outputTypes.push('Temperature');
+  if (device.hasOutput(OutputType.Led)) outputTypes.push('LED');
+
+  if (outputTypes.length > 0) {
+    console.log(`\nOutput Capabilities: ${outputTypes.join(', ')}`);
+  }
+
+  // Collect input capabilities
+  const inputTypes: string[] = [];
+  if (device.hasInput(InputType.Battery)) inputTypes.push('Battery');
+  if (device.hasInput(InputType.RSSI)) inputTypes.push('RSSI');
+  if (device.hasInput(InputType.Button)) inputTypes.push('Button');
+  if (device.hasInput(InputType.Pressure)) inputTypes.push('Pressure');
+
+  if (inputTypes.length > 0) {
+    console.log(`Input Capabilities: ${inputTypes.join(', ')}`);
+  }
+
+  // Detailed feature breakdown
+  console.log('\nDetailed Features:');
+  for (const [index, feature] of device.features) {
+    // Access the underlying feature definition
+    const def = (feature as any)._feature;
+    console.log(`\n  Feature ${index}: ${def.FeatureDescriptor}`);
+
+    if (def.Output) {
+      console.log('    Outputs:');
+      for (const [type, config] of Object.entries(def.Output)) {
+        const cfg = config as { Value: number[] };
+        console.log(
+          `      - ${type}: steps ${cfg.Value[0]}-${cfg.Value[1]}`
+        );
+      }
+    }
+
+    if (def.Input) {
+      console.log('    Inputs:');
+      for (const [type, config] of Object.entries(def.Input)) {
+        const cfg = config as { Value: number[]; Command: string[] };
+        console.log(
+          `      - ${type}: commands [${cfg.Command.join(', ')}]`
+        );
+      }
+    }
+  }
+}
+
+async function main(): Promise<void> {
+  const client = new ButtplugClient('Device Info Example');
+
+  // Connect
+  const connector = new ButtplugNodeWebsocketClientConnector(
+    'ws://127.0.0.1:12345'
+  );
+
+  console.log('Connecting...');
+  await client.connect(connector);
+  console.log('Connected! Scanning for devices...');
+
+  await client.startScanning();
+  await waitForEnter('Turn on your devices, then press Enter...');
+  await client.stopScanning();
+
+  // Display info for all connected devices
+  if (client.devices.size === 0) {
+    console.log('No devices found.');
+  } else {
+    console.log(`\nFound ${client.devices.size} device(s):`);
+    for (const [_, device] of client.devices) {
+      printDeviceInfo(device);
+    }
+  }
+
+  await waitForEnter('\nPress Enter to disconnect...');
+  await client.disconnect();
+  console.log('Disconnected.');
+}
+
+main().catch(console.error);

package/examples/node/errors-example.ts

@@ -0,0 +1,166 @@
+// Buttplug TypeScript - Error Handling Example
+//
+// This example demonstrates the different error types in Buttplug
+// and how to handle them. This is a reference for error handling patterns.
+//
+// Prerequisites:
+// 1. Install Intiface Central: https://intiface.com/central
+// 2. Start the server in Intiface Central
+// 3. Run: npx ts-node --esm errors-example.ts
+
+import {
+  ButtplugClient,
+  ButtplugNodeWebsocketClientConnector,
+  ButtplugClientConnectorException,
+  ButtplugError,
+  ButtplugDeviceError,
+  ButtplugInitError,
+  ButtplugMessageError,
+  ButtplugPingError,
+  DeviceOutput,
+} from 'buttplug';
+import * as readline from 'readline';
+
+async function waitForEnter(prompt: string): Promise<void> {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+  return new Promise((resolve) => {
+    rl.question(prompt, () => {
+      rl.close();
+      resolve();
+    });
+  });
+}
+
+function delay(ms: number): Promise<void> {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+// All Buttplug errors inherit from ButtplugError.
+// Here's the hierarchy:
+//
+// ButtplugError (base class)
+// +-- ButtplugClientConnectorException - Connection/transport issues
+// +-- ButtplugInitError                - Client/server version mismatch
+// +-- ButtplugDeviceError              - Device communication errors
+// +-- ButtplugMessageError             - Invalid message format/content
+// +-- ButtplugPingError                - Server ping timeout
+
+function handleButtplugError(e: unknown): void {
+  if (e instanceof ButtplugClientConnectorException) {
+    // The connector couldn't establish or maintain connection.
+    // Causes: server not running, wrong address, network issues,
+    // SSL/TLS problems, connection dropped.
+    console.log(`[Connector Error] ${e.message}`);
+    console.log('Check that the server is running and accessible.');
+  } else if (e instanceof ButtplugInitError) {
+    // Client and server couldn't agree on protocol version.
+    // Usually means you need to upgrade client or server.
+    console.log(`[Init/Handshake Error] ${e.message}`);
+    console.log('Client and server versions may be incompatible.');
+  } else if (e instanceof ButtplugDeviceError) {
+    // Something went wrong communicating with a device.
+    // Causes: device disconnected, invalid command for device,
+    // device rejected command, hardware error.
+    console.log(`[Device Error] ${e.message}`);
+    console.log(
+      "The device may have disconnected or doesn't support this command."
+    );
+  } else if (e instanceof ButtplugMessageError) {
+    // The message sent was invalid.
+    // Causes: malformed message, missing required fields,
+    // invalid parameter values.
+    console.log(`[Message Error] ${e.message}`);
+    console.log(
+      'This usually indicates a bug in the client library or application.'
+    );
+  } else if (e instanceof ButtplugPingError) {
+    // Server didn't receive ping in time, connection terminated.
+    // The ping system ensures dead connections are detected.
+    console.log(`[Ping Error] ${e.message}`);
+    console.log('Connection was lost due to ping timeout.');
+  } else if (e instanceof ButtplugError) {
+    // Unknown or future error type
+    console.log(`[Buttplug Error] ${e.message}`);
+  } else if (e instanceof Error) {
+    // Non-Buttplug error
+    console.log(`[System Error] ${e.message}`);
+  } else {
+    console.log(`[Unknown Error] ${e}`);
+  }
+}
+
+async function main(): Promise<void> {
+  console.log('Error Handling Example');
+  console.log('======================\n');
+
+  // Example 1: Connection error (server not running)
+  console.log('1. Attempting to connect to non-existent server...');
+  const client1 = new ButtplugClient('Error Example');
+  try {
+    const badConnector = new ButtplugNodeWebsocketClientConnector(
+      'ws://127.0.0.1:99999'
+    );
+    await client1.connect(badConnector);
+  } catch (e) {
+    handleButtplugError(e);
+  }
+
+  // Example 2: Demonstrating promise-based error handling
+  console.log('\n2. Demonstrating promise-based error handling...');
+  const client2 = new ButtplugClient('Promise Error Example');
+  const badConnector2 = new ButtplugNodeWebsocketClientConnector(
+    'ws://127.0.0.1:99998'
+  );
+
+  // You can also catch errors using .catch() on promises
+  await client2
+    .connect(badConnector2)
+    .then(() => {
+      console.log('Connected (unexpected!)');
+    })
+    .catch((e) => {
+      console.log('Caught error using .catch():');
+      handleButtplugError(e);
+    });
+
+  // Example 3: Handling errors when sending commands after disconnect
+  console.log('\n3. Demonstrating error after disconnect...');
+  const client3 = new ButtplugClient('Disconnect Error Example');
+  try {
+    const connector = new ButtplugNodeWebsocketClientConnector(
+      'ws://127.0.0.1:12345'
+    );
+    await client3.connect(connector);
+    console.log('Connected successfully.');
+
+    // Scan briefly to get a device
+    await client3.startScanning();
+    await delay(1000);
+    await client3.stopScanning();
+
+    if (client3.devices.size > 0) {
+      const device = client3.devices.values().next().value!;
+      console.log(`Found device: ${device.name}`);
+
+      // Disconnect
+      await client3.disconnect();
+      console.log('Disconnected.');
+
+      // Now try to send a command - this will throw
+      console.log('Attempting to send command after disconnect...');
+      await device.runOutput(DeviceOutput.Vibrate.percent(0.5));
+    } else {
+      console.log('No devices found to test with.');
+      await client3.disconnect();
+    }
+  } catch (e) {
+    handleButtplugError(e);
+  }
+
+  await waitForEnter('\nPress Enter to exit...');
+}
+
+main().catch(console.error);

package/examples/node/package-lock.json

@@ -0,0 +1,281 @@
+{
+  "name": "buttplug-examples",
+  "version": "1.0.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "buttplug-examples",
+      "version": "1.0.0",
+      "dependencies": {
+        "buttplug": "file:../js"
+      },
+      "devDependencies": {
+        "@types/node": "^22.0.0",
+        "ts-node": "^10.9.2",
+        "typescript": "^5.6.0"
+      }
+    },
+    "../js": {
+      "name": "buttplug",
+      "version": "4.0.0",
+      "license": "BSD-3-Clause",
+      "dependencies": {
+        "eventemitter3": "^5.0.1",
+        "ws": "^8.18.3"
+      },
+      "devDependencies": {
+        "@types/commander": "^2.12.5",
+        "@types/expect-puppeteer": "^5.0.6",
+        "@types/jest": "^30.0.0",
+        "@types/jest-environment-puppeteer": "^5.0.6",
+        "@types/node": "^24.10.1",
+        "@types/uuid-parse": "^1.0.2",
+        "@types/ws": "^8.18.1",
+        "@typescript-eslint/eslint-plugin": "^8.47.0",
+        "@typescript-eslint/parser": "^8.47.0",
+        "copyfiles": "^2.4.1",
+        "cross-env": "^10.1.0",
+        "eslint": "^9.39.1",
+        "eslint-plugin-node": "^11.1.0",
+        "gts": "^6.0.2",
+        "jest": "^30.2.0",
+        "mock-socket": "^9.3.1",
+        "pkg": "^5.8.1",
+        "tmp": "^0.2.5",
+        "trash": "^10.0.0",
+        "trash-cli": "^7.0.0",
+        "ts-jest": "^29.4.5",
+        "ts-node": "^10.9.2",
+        "tslib": "^2.8.1",
+        "typedoc": "^0.28.14",
+        "typescript": "^5.9.3",
+        "vite": "^7.2.4",
+        "vite-plugin-dts": "^4.5.4",
+        "yarn": "^1.22.22"
+      }
+    },
+    "node_modules/@cspotcode/source-map-support": {
+      "version": "0.8.1",
+      "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz",
+      "integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "@jridgewell/trace-mapping": "0.3.9"
+      },
+      "engines": {
+        "node": ">=12"
+      }
+    },
+    "node_modules/@jridgewell/resolve-uri": {
+      "version": "3.1.2",
+      "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz",
+      "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==",
+      "dev": true,
+      "license": "MIT",
+      "engines": {
+        "node": ">=6.0.0"
+      }
+    },
+    "node_modules/@jridgewell/sourcemap-codec": {
+      "version": "1.5.5",
+      "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz",
+      "integrity": "sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==",
+      "dev": true,
+      "license": "MIT"
+    },
+    "node_modules/@jridgewell/trace-mapping": {
+      "version": "0.3.9",
+      "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz",
+      "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "@jridgewell/resolve-uri": "^3.0.3",
+        "@jridgewell/sourcemap-codec": "^1.4.10"
+      }
+    },
+    "node_modules/@tsconfig/node10": {
+      "version": "1.0.12",
+      "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.12.tgz",
+      "integrity": "sha512-UCYBaeFvM11aU2y3YPZ//O5Rhj+xKyzy7mvcIoAjASbigy8mHMryP5cK7dgjlz2hWxh1g5pLw084E0a/wlUSFQ==",
+      "dev": true,
+      "license": "MIT"
+    },
+    "node_modules/@tsconfig/node12": {
+      "version": "1.0.11",
+      "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.11.tgz",
+      "integrity": "sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag==",
+      "dev": true,
+      "license": "MIT"
+    },
+    "node_modules/@tsconfig/node14": {
+      "version": "1.0.3",
+      "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.3.tgz",
+      "integrity": "sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow==",
+      "dev": true,
+      "license": "MIT"
+    },
+    "node_modules/@tsconfig/node16": {
+      "version": "1.0.4",
+      "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.4.tgz",
+      "integrity": "sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA==",
+      "dev": true,
+      "license": "MIT"
+    },
+    "node_modules/@types/node": {
+      "version": "22.19.7",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-22.19.7.tgz",
+      "integrity": "sha512-MciR4AKGHWl7xwxkBa6xUGxQJ4VBOmPTF7sL+iGzuahOFaO0jHCsuEfS80pan1ef4gWId1oWOweIhrDEYLuaOw==",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "undici-types": "~6.21.0"
+      }
+    },
+    "node_modules/acorn": {
+      "version": "8.15.0",
+      "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.15.0.tgz",
+      "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==",
+      "dev": true,
+      "license": "MIT",
+      "bin": {
+        "acorn": "bin/acorn"
+      },
+      "engines": {
+        "node": ">=0.4.0"
+      }
+    },
+    "node_modules/acorn-walk": {
+      "version": "8.3.4",
+      "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.4.tgz",
+      "integrity": "sha512-ueEepnujpqee2o5aIYnvHU6C0A42MNdsIDeqy5BydrkuC5R1ZuUFnm27EeFJGoEHJQgn3uleRvmTXaJgfXbt4g==",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "acorn": "^8.11.0"
+      },
+      "engines": {
+        "node": ">=0.4.0"
+      }
+    },
+    "node_modules/arg": {
+      "version": "4.1.3",
+      "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz",
+      "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==",
+      "dev": true,
+      "license": "MIT"
+    },
+    "node_modules/buttplug": {
+      "resolved": "../js",
+      "link": true
+    },
+    "node_modules/create-require": {
+      "version": "1.1.1",
+      "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz",
+      "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==",
+      "dev": true,
+      "license": "MIT"
+    },
+    "node_modules/diff": {
+      "version": "4.0.4",
+      "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.4.tgz",
+      "integrity": "sha512-X07nttJQkwkfKfvTPG/KSnE2OMdcUCao6+eXF3wmnIQRn2aPAHH3VxDbDOdegkd6JbPsXqShpvEOHfAT+nCNwQ==",
+      "dev": true,
+      "license": "BSD-3-Clause",
+      "engines": {
+        "node": ">=0.3.1"
+      }
+    },
+    "node_modules/make-error": {
+      "version": "1.3.6",
+      "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz",
+      "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==",
+      "dev": true,
+      "license": "ISC"
+    },
+    "node_modules/ts-node": {
+      "version": "10.9.2",
+      "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.2.tgz",
+      "integrity": "sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ==",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "@cspotcode/source-map-support": "^0.8.0",
+        "@tsconfig/node10": "^1.0.7",
+        "@tsconfig/node12": "^1.0.7",
+        "@tsconfig/node14": "^1.0.0",
+        "@tsconfig/node16": "^1.0.2",
+        "acorn": "^8.4.1",
+        "acorn-walk": "^8.1.1",
+        "arg": "^4.1.0",
+        "create-require": "^1.1.0",
+        "diff": "^4.0.1",
+        "make-error": "^1.1.1",
+        "v8-compile-cache-lib": "^3.0.1",
+        "yn": "3.1.1"
+      },
+      "bin": {
+        "ts-node": "dist/bin.js",
+        "ts-node-cwd": "dist/bin-cwd.js",
+        "ts-node-esm": "dist/bin-esm.js",
+        "ts-node-script": "dist/bin-script.js",
+        "ts-node-transpile-only": "dist/bin-transpile.js",
+        "ts-script": "dist/bin-script-deprecated.js"
+      },
+      "peerDependencies": {
+        "@swc/core": ">=1.2.50",
+        "@swc/wasm": ">=1.2.50",
+        "@types/node": "*",
+        "typescript": ">=2.7"
+      },
+      "peerDependenciesMeta": {
+        "@swc/core": {
+          "optional": true
+        },
+        "@swc/wasm": {
+          "optional": true
+        }
+      }
+    },
+    "node_modules/typescript": {
+      "version": "5.9.3",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz",
+      "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==",
+      "dev": true,
+      "license": "Apache-2.0",
+      "bin": {
+        "tsc": "bin/tsc",
+        "tsserver": "bin/tsserver"
+      },
+      "engines": {
+        "node": ">=14.17"
+      }
+    },
+    "node_modules/undici-types": {
+      "version": "6.21.0",
+      "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.21.0.tgz",
+      "integrity": "sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ==",
+      "dev": true,
+      "license": "MIT"
+    },
+    "node_modules/v8-compile-cache-lib": {
+      "version": "3.0.1",
+      "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz",
+      "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==",
+      "dev": true,
+      "license": "MIT"
+    },
+    "node_modules/yn": {
+      "version": "3.1.1",
+      "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz",
+      "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==",
+      "dev": true,
+      "license": "MIT",
+      "engines": {
+        "node": ">=6"
+      }
+    }
+  }
+}

package/examples/node/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "buttplug-examples",
+  "version": "1.0.0",
+  "description": "Example code for the Buttplug TypeScript/JavaScript library",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "connection": "npx ts-node --esm connection-example.ts",
+    "device-enumeration": "npx ts-node --esm device-enumeration-example.ts",
+    "device-control": "npx ts-node --esm device-control-example.ts",
+    "device-info": "npx ts-node --esm device-info-example.ts",
+    "async": "npx ts-node --esm async-example.ts",
+    "errors": "npx ts-node --esm errors-example.ts",
+    "remote-connector": "npx ts-node --esm remote-connector-example.ts",
+    "application": "npx ts-node --esm application-example.ts"
+  },
+  "dependencies": {
+    "buttplug": "file:../js"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.6.0"
+  }
+}