ive-connect 0.1.1 → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 iveplay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,251 +1,109 @@
-# ive-connect
-
-A universal haptic device control library that provides a consistent interface for managing various haptic devices (Handy, Buttplug, etc.).
-
-## Features
-
-- Unified device control interface
-- Support for multiple device types
-- Event-based state management
-- TypeScript support
-
-## Installation
-
-```bash
-npm install ive-connect
-```
-
-## Quick Start
-
-```typescript
-import { DeviceManager, HandyDevice } from "ive-connect";
-
-// Create a device manager
-const manager = new DeviceManager();
-
-// Create and register a Handy device
-const handyDevice = new HandyDevice({
-  connectionKey: "your-connection-key",
-});
-manager.registerDevice(handyDevice);
-
-// Connect to the device
-await handyDevice.connect();
-
-// Load a script
-await handyDevice.loadScript({
-  type: "funscript",
-  url: "https://example.com/script.funscript",
-});
-
-// Start playback
-await handyDevice.play(0, 1.0, false);
-
-// Later, stop playback
-await handyDevice.stop();
-
-// Disconnect when done
-await handyDevice.disconnect();
-```
-
-## Supported Devices
-
-### Handy
-
-```typescript
-import { HandyDevice } from "ive-connect";
-
-const handy = new HandyDevice({
-  connectionKey: "your-connection-key",
-  // Optional custom configuration
-  baseV3Url: "https://www.handyfeeling.com/api/v3",
-  baseV2Url: "https://www.handyfeeling.com/api/v2",
-  applicationId: "YourAppName",
-});
-
-// Connect to the device
-await handy.connect();
-
-// Update configuration
-await handy.updateConfig({
-  offset: -200, // Timing offset in milliseconds
-  stroke: {
-    min: 0.1, // Min stroke position (0.0 to 1.0)
-    max: 0.9, // Max stroke position (0.0 to 1.0)
-  },
-});
-
-// Listen for events
-handy.on("connected", (deviceInfo) => {
-  console.log("Connected to Handy:", deviceInfo);
-});
-
-handy.on("playbackStateChanged", (state) => {
-  console.log("Playback state changed:", state.isPlaying);
-});
-```
-
-### Using the Device Manager
-
-```typescript
-import { DeviceManager, HandyDevice } from "ive-connect";
-
-// Create a device manager
-const manager = new DeviceManager();
-
-// Register devices
-const handy = new HandyDevice({
-  connectionKey: "your-connection-key",
-});
-manager.registerDevice(handy);
-
-// Connect all devices
-await manager.connectAll();
-
-// Load a script to all connected devices
-await manager.loadScriptAll({
-  type: "funscript",
-  url: "https://example.com/script.funscript",
-});
-
-// Start playback on all devices
-await manager.playAll(0, 1.0, false);
-
-// Sync time on all devices every second
-setInterval(() => {
-  manager.syncTimeAll(videoElement.currentTime * 1000);
-}, 1000);
-
-// Listen for events from any device
-manager.on("device:connected", ({ deviceId, data }) => {
-  console.log(`Device ${deviceId} connected:`, data);
-});
-
-// Listen for events from a specific device
-manager.on(`device:${handy.id}:error`, (error) => {
-  console.error(`Error from ${handy.id}:`, error);
-});
-```
-
-## API Reference
-
-### Core Classes
-
-#### `DeviceManager`
-
-Central manager for all haptic devices.
-
-- `registerDevice(device: HapticDevice): void` - Register a device
-- `unregisterDevice(deviceId: string): void` - Unregister a device
-- `getDevices(): HapticDevice[]` - Get all registered devices
-- `getDevice(deviceId: string): HapticDevice | undefined` - Get a specific device
-- `connectAll(): Promise<Record<string, boolean>>` - Connect all devices
-- `disconnectAll(): Promise<Record<string, boolean>>` - Disconnect all devices
-- `loadScriptAll(scriptData: ScriptData): Promise<Record<string, boolean>>` - Load script to all devices
-- `playAll(timeMs: number, playbackRate?: number, loop?: boolean): Promise<Record<string, boolean>>` - Start playback on all devices
-- `stopAll(): Promise<Record<string, boolean>>` - Stop playback on all devices
-- `syncTimeAll(timeMs: number): Promise<Record<string, boolean>>` - Sync time on all playing devices
-
-#### `HandyDevice`
-
-Implementation of the Handy device.
-
-- `connect(config?: Partial<HandySettings>): Promise<boolean>` - Connect to the device
-- `disconnect(): Promise<boolean>` - Disconnect from the device
-- `getConfig(): HandySettings` - Get current configuration
-- `updateConfig(config: Partial<HandySettings>): Promise<boolean>` - Update configuration
-- `loadScript(scriptData: ScriptData): Promise<boolean>` - Load a script
-- `play(timeMs: number, playbackRate?: number, loop?: boolean): Promise<boolean>` - Start playback
-- `stop(): Promise<boolean>` - Stop playback
-- `syncTime(timeMs: number): Promise<boolean>` - Sync time
-- `getDeviceInfo(): DeviceInfo | null` - Get device information
-
-### Events
-
-Devices and the DeviceManager emit various events that you can listen to:
-
-#### Device Events
-
-- `error` - Error occurred
-- `connected` - Device connected
-- `disconnected` - Device disconnected
-- `connectionStateChanged` - Connection state changed
-- `playbackStateChanged` - Playback state changed
-- `scriptLoaded` - Script loaded successfully
-- `configChanged` - Configuration changed
-
-#### DeviceManager Events
-
-- `deviceAdded` - Device was added to the manager
-- `deviceRemoved` - Device was removed from the manager
-- `device:{deviceId}:{eventName}` - Event from a specific device
-- `device:{eventName}` - Event from any device
-
-## Interfaces
-
-### `HapticDevice`
-
-Common interface for all haptic devices.
-
-```typescript
-interface HapticDevice {
-  readonly id: string;
-  readonly name: string;
-  readonly type: string;
-  readonly capabilities: DeviceCapability[];
-  readonly isConnected: boolean;
-  readonly isPlaying: boolean;
-
-  connect(config?: any): Promise<boolean>;
-  disconnect(): Promise<boolean>;
-  getConfig(): DeviceSettings;
-  updateConfig(config: Partial<DeviceSettings>): Promise<boolean>;
-  loadScript(scriptData: ScriptData): Promise<boolean>;
-  play(timeMs: number, playbackRate?: number, loop?: boolean): Promise<boolean>;
-  stop(): Promise<boolean>;
-  syncTime(timeMs: number): Promise<boolean>;
-  getDeviceInfo(): DeviceInfo | null;
-  on(event: string, callback: (data: any) => void): void;
-  off(event: string, callback: (data: any) => void): void;
-}
-```
-
-### `ScriptData`
-
-Data for scripts to be loaded.
-
-```typescript
-interface ScriptData {
-  type: string; // Script type (e.g., "funscript")
-  url?: string; // URL to script if remote
-  content?: any; // Script content if loaded directly
-}
-```
-
-### `DeviceSettings`
-
-Base interface for device settings.
-
-```typescript
-interface DeviceSettings {
-  id: string; // Device identifier
-  name: string; // Human-readable name
-  enabled: boolean; // Whether the device is enabled
-  [key: string]: any; // Additional device-specific settings
-}
-```
-
-### `HandySettings`
-
-Handy-specific settings.
-
-```typescript
-interface HandySettings extends DeviceSettings {
-  connectionKey: string; // Device connection key
-  offset: number; // Timing offset in milliseconds
-  stroke: {
-    min: number; // Min stroke position (0.0 to 1.0)
-    max: number; // Max stroke position (0.0 to 1.0)
-  };
-}
-```
+# ive-connect
+
+A universal haptic device control library that provides a consistent interface for managing various haptic devices (Handy, Buttplug, etc.).
+
+## Features
+
+- Unified device control interface
+- Support for multiple device types
+- Event-based state management
+- TypeScript support
+
+## Installation
+
+```bash
+npm install ive-connect
+```
+
+## Quick Start
+
+```typescript
+import { DeviceManager, HandyDevice } from "ive-connect";
+
+// Create a device manager
+const manager = new DeviceManager();
+
+// Create and register a Handy device
+const handyDevice = new HandyDevice({
+  connectionKey: "your-connection-key",
+});
+manager.registerDevice(handyDevice);
+
+// Connect to the device
+await handyDevice.connect();
+
+// Load a script
+await handyDevice.loadScript({
+  type: "funscript",
+  url: "https://example.com/script.funscript",
+});
+
+// Start playback
+await handyDevice.play(0, 1.0, false);
+
+// Later, stop playback
+await handyDevice.stop();
+
+// Disconnect when done
+await handyDevice.disconnect();
+```
+
+## Supported Devices
+
+### Handy
+
+```typescript
+import { HandyDevice } from "ive-connect";
+
+const handy = new HandyDevice({
+  connectionKey: "your-connection-key",
+  // Optional custom configuration
+  baseV3Url: "https://www.handyfeeling.com/api/v3",
+  baseV2Url: "https://www.handyfeeling.com/api/v2",
+  applicationId: "YourAppName",
+});
+
+// Connect to the device
+await handy.connect();
+
+// Update configuration
+await handy.updateConfig({
+  offset: -200, // Timing offset in milliseconds
+  stroke: {
+    min: 0.1, // Min stroke position (0.0 to 1.0)
+    max: 0.9, // Max stroke position (0.0 to 1.0)
+  },
+});
+
+// Listen for events
+handy.on("connected", (deviceInfo) => {
+  console.log("Connected to Handy:", deviceInfo);
+});
+
+handy.on("playbackStateChanged", (state) => {
+  console.log("Playback state changed:", state.isPlaying);
+});
+```
+
+### Using the Device Manager
+
+```typescript
+import { DeviceManager, HandyDevice } from "ive-connect";
+
+// Create a device manager
+const manager = new DeviceManager();
+
+// Register devices
+const handy = new HandyDevice({
+  connectionKey: "your-connection-key",
+});
+manager.registerDevice(handy);
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+This project uses [buttplug.io](https://buttplug.io) (BSD 3-Clause License) for device communication.

package/dist/devices/buttplug/buttplug-api.js

@@ -43,7 +43,7 @@ const buttplug_1 = require("buttplug");
 const buttplug_2 = require("buttplug");
 const events_1 = require("../../core/events");
 const types_1 = require("./types");
-const DEBUG_WEBSOCKET = true;
+const DEBUG_WEBSOCKET = false;
 class ButtplugApi extends events_1.EventEmitter {
     constructor(clientName = "IVE-Connect") {
         super();

package/dist/devices/buttplug/buttplug-device.js

@@ -411,11 +411,11 @@ class ButtplugDevice extends events_1.EventEmitter {
             const prevAction = actionIndex > 0
                 ? this._currentScriptActions[actionIndex - 1]
                 : { pos: 0 };
-            // Calculate duration for linear movement based on time to next action
+            // Calculate duration for linear movement based on time with previous action
             let durationMs = 500; // Default duration if we can't determine
             if (actionIndex < this._currentScriptActions.length - 1) {
-                const nextAction = this._currentScriptActions[actionIndex + 1];
-                durationMs = nextAction.at - action.at;
+                const prevAction = this._currentScriptActions[actionIndex - 1];
+                durationMs = action.at - prevAction.at;
                 // Enforce a minimum duration to prevent erratic movement
                 durationMs = Math.max(100, durationMs);
             }
@@ -458,7 +458,12 @@ class ButtplugDevice extends events_1.EventEmitter {
                 high = mid - 1;
             }
         }
-        return bestIndex;
+        // When returning bestIndex, we're always getting
+        // the last action that has a timestamp <= timeMs
+        // Let's return the next action instead
+        return bestIndex < this._currentScriptActions.length - 1
+            ? bestIndex + 1
+            : bestIndex;
     }
     /**
      * Set up event handlers for the Buttplug API

package/dist/devices/handy/handy-api.js

@@ -166,7 +166,7 @@ class HandyApi {
             const response = await this.request("/hssp/play", {
                 method: "PUT",
                 body: JSON.stringify({
-                    start_time: Math.round(videoTime * 1000),
+                    start_time: Math.round(videoTime),
                     server_time: this.estimateServerTime(),
                     playback_rate: playbackRate,
                     loop,
@@ -203,7 +203,7 @@ class HandyApi {
             const response = await this.request("/hssp/synctime", {
                 method: "PUT",
                 body: JSON.stringify({
-                    current_time: Math.round(videoTime * 1000),
+                    current_time: Math.round(videoTime),
                     server_time: this.estimateServerTime(),
                     filter,
                 }),

package/dist/devices/handy/handy-device.js

@@ -205,8 +205,32 @@ class HandyDevice extends events_1.EventEmitter {
             let scriptUrl;
             // Handle script data based on type
             if (scriptData.url) {
-                // If URL is provided, use it directly
-                scriptUrl = scriptData.url;
+                // If URL ends with .funscript and it's a direct URL, fetch and upload it
+                if (scriptData.url.toLowerCase().endsWith(".funscript")) {
+                    try {
+                        const response = await fetch(scriptData.url);
+                        if (!response.ok) {
+                            throw new Error(`Failed to fetch funscript: ${response.status}`);
+                        }
+                        const funscriptContent = await response.json();
+                        const blob = new Blob([JSON.stringify(funscriptContent)], {
+                            type: "application/json",
+                        });
+                        const uploadedUrl = await this._api.uploadScript(blob);
+                        if (!uploadedUrl) {
+                            throw new Error("Failed to upload funscript");
+                        }
+                        scriptUrl = uploadedUrl;
+                    }
+                    catch (error) {
+                        console.error("Error processing funscript URL:", error);
+                        // Fall back to using the original URL
+                        scriptUrl = scriptData.url;
+                    }
+                }
+                else {
+                    scriptUrl = scriptData.url;
+                }
             }
             else if (scriptData.content) {
                 // If content is provided, upload it

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ive-connect",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "A universal haptic device control library for interactive experiences",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,7 +10,8 @@
     "prebuild": "npm run clean",
     "prepare": "npm run build",
     "test": "jest",
-    "lint": "eslint src --ext .ts"
+    "lint": "eslint src --ext .ts",
+    "release": "release-it"
   },
   "keywords": [
     "haptic",
@@ -19,7 +20,7 @@
     "device-control",
     "interactive"
   ],
-  "author": "",
+  "author": "iveplay",
   "license": "MIT",
   "files": [
     "dist",
@@ -37,6 +38,7 @@
     "@typescript-eslint/parser": "^8.31.0",
     "eslint": "^9.25.1",
     "jest": "^29.7.0",
+    "release-it": "^19.0.2",
     "rimraf": "^6.0.1"
   },
   "engines": {