buttplug 3.1.0 → 3.2.0

package/dist/web/client/ButtplugBrowserWebsocketClientConnector.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
+ * project root for full license information.
+ *
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
+ */
+import { IButtplugClientConnector } from './IButtplugClientConnector';
+import { ButtplugMessage } from '../core/Messages';
+import { ButtplugBrowserWebsocketConnector } from '../utils/ButtplugBrowserWebsocketConnector';
+export declare class ButtplugBrowserWebsocketClientConnector extends ButtplugBrowserWebsocketConnector implements IButtplugClientConnector {
+    send: (msg: ButtplugMessage) => void;
+}

package/dist/web/client/ButtplugClientConnectorException.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
+ * project root for full license information.
+ *
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
+ */
+import { ButtplugError } from '../core/Exceptions';
+export declare class ButtplugClientConnectorException extends ButtplugError {
+    constructor(message: string);
+}

package/dist/web/client/ButtplugClientDevice.d.ts

@@ -0,0 +1,67 @@
+/*!
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
+ * project root for full license information.
+ *
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
+ */
+import * as Messages from '../core/Messages';
+import { EventEmitter } from 'eventemitter3';
+/**
+ * Represents an abstract device, capable of taking certain kinds of messages.
+ */
+export declare class ButtplugClientDevice extends EventEmitter {
+    private _deviceInfo;
+    private _sendClosure;
+    /**
+     * Return the name of the device.
+     */
+    get name(): string;
+    /**
+     * Return the user set name of the device.
+     */
+    get displayName(): string | undefined;
+    /**
+     * Return the index of the device.
+     */
+    get index(): number;
+    /**
+     * Return the index of the device.
+     */
+    get messageTimingGap(): number | undefined;
+    /**
+     * Return a list of message types the device accepts.
+     */
+    get messageAttributes(): Messages.MessageAttributes;
+    static fromMsg(msg: Messages.DeviceInfo, sendClosure: (device: ButtplugClientDevice, msg: Messages.ButtplugDeviceMessage) => Promise<Messages.ButtplugMessage>): ButtplugClientDevice;
+    private allowedMsgs;
+    /**
+     * @param _index Index of the device, as created by the device manager.
+     * @param _name Name of the device.
+     * @param allowedMsgs Buttplug messages the device can receive.
+     */
+    constructor(_deviceInfo: Messages.DeviceInfo, _sendClosure: (device: ButtplugClientDevice, msg: Messages.ButtplugDeviceMessage) => Promise<Messages.ButtplugMessage>);
+    send(msg: Messages.ButtplugDeviceMessage): Promise<Messages.ButtplugMessage>;
+    sendExpectOk(msg: Messages.ButtplugDeviceMessage): Promise<void>;
+    scalar(scalar: Messages.ScalarSubcommand | Messages.ScalarSubcommand[]): Promise<void>;
+    private scalarCommandBuilder;
+    get vibrateAttributes(): Messages.GenericDeviceMessageAttributes[];
+    vibrate(speed: number | number[]): Promise<void>;
+    get oscillateAttributes(): Messages.GenericDeviceMessageAttributes[];
+    oscillate(speed: number | number[]): Promise<void>;
+    get rotateAttributes(): Messages.GenericDeviceMessageAttributes[];
+    rotate(values: number | [number, boolean][], clockwise?: boolean): Promise<void>;
+    get linearAttributes(): Messages.GenericDeviceMessageAttributes[];
+    linear(values: number | [number, number][], duration?: number): Promise<void>;
+    sensorRead(sensorIndex: number, sensorType: Messages.SensorType): Promise<number[]>;
+    get hasBattery(): boolean;
+    battery(): Promise<number>;
+    get hasRssi(): boolean;
+    rssi(): Promise<number>;
+    rawRead(endpoint: string, expectedLength: number, timeout: number): Promise<Uint8Array>;
+    rawWrite(endpoint: string, data: Uint8Array, writeWithResponse: boolean): Promise<void>;
+    rawSubscribe(endpoint: string): Promise<void>;
+    rawUnsubscribe(endpoint: string): Promise<void>;
+    stop(): Promise<void>;
+    emitDisconnected(): void;
+}

package/dist/web/client/ButtplugNodeWebsocketClientConnector.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
+ * project root for full license information.
+ *
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
+ */
+import { ButtplugBrowserWebsocketClientConnector } from './ButtplugBrowserWebsocketClientConnector';
+export declare class ButtplugNodeWebsocketClientConnector extends ButtplugBrowserWebsocketClientConnector {
+    protected _websocketConstructor: {
+        new (url: string | URL, protocols?: string | string[] | undefined): WebSocket;
+        prototype: WebSocket;
+        readonly CONNECTING: 0;
+        readonly OPEN: 1;
+        readonly CLOSING: 2;
+        readonly CLOSED: 3;
+    };
+}

package/dist/web/client/Client.d.ts

@@ -0,0 +1,41 @@
+/*!
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
+ * project root for full license information.
+ *
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
+ */
+/// <reference types="node" />
+import { ButtplugLogger } from '../core/Logging';
+import { EventEmitter } from 'eventemitter3';
+import { ButtplugClientDevice } from './ButtplugClientDevice';
+import { IButtplugClientConnector } from './IButtplugClientConnector';
+import * as Messages from '../core/Messages';
+export declare class ButtplugClient extends EventEmitter {
+    protected _pingTimer: NodeJS.Timeout | null;
+    protected _connector: IButtplugClientConnector | null;
+    protected _devices: Map<number, ButtplugClientDevice>;
+    protected _clientName: string;
+    protected _logger: ButtplugLogger;
+    protected _isScanning: boolean;
+    private _sorter;
+    constructor(clientName?: string);
+    get connected(): boolean;
+    get devices(): ButtplugClientDevice[];
+    get isScanning(): boolean;
+    connect: (connector: IButtplugClientConnector) => Promise<void>;
+    disconnect: () => Promise<void>;
+    startScanning: () => Promise<void>;
+    stopScanning: () => Promise<void>;
+    stopAllDevices: () => Promise<void>;
+    private sendDeviceMessage;
+    protected disconnectHandler: () => void;
+    protected parseMessages: (msgs: Messages.ButtplugMessage[]) => void;
+    protected initializeConnection: () => Promise<boolean>;
+    protected requestDeviceList: () => Promise<void>;
+    protected shutdownConnection: () => Promise<void>;
+    protected sendMessage(msg: Messages.ButtplugMessage): Promise<Messages.ButtplugMessage>;
+    protected checkConnector(): void;
+    protected sendMsgExpectOk: (msg: Messages.ButtplugMessage) => Promise<void>;
+    protected sendDeviceMessageClosure: (device: ButtplugClientDevice, msg: Messages.ButtplugDeviceMessage) => Promise<Messages.ButtplugMessage>;
+}

package/dist/web/client/IButtplugClientConnector.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
+ * project root for full license information.
+ *
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
+ */
+import { ButtplugMessage } from '../core/Messages';
+import { EventEmitter } from 'eventemitter3';
+export interface IButtplugClientConnector extends EventEmitter {
+    connect: () => Promise<void>;
+    disconnect: () => Promise<void>;
+    initialize: () => Promise<void>;
+    send: (msg: ButtplugMessage) => void;
+    readonly Connected: boolean;
+}

package/dist/web/core/Exceptions.d.ts

@@ -0,0 +1,36 @@
+/*!
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
+ * project root for full license information.
+ *
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
+ */
+import * as Messages from './Messages';
+import { ButtplugLogger } from './Logging';
+export declare class ButtplugError extends Error {
+    get ErrorClass(): Messages.ErrorClass;
+    get InnerError(): Error | undefined;
+    get Id(): number | undefined;
+    get ErrorMessage(): Messages.ButtplugMessage;
+    static LogAndError<T extends ButtplugError>(constructor: new (str: string, num: number) => T, logger: ButtplugLogger, message: string, id?: number): T;
+    static FromError(error: Messages.Error): ButtplugDeviceError | ButtplugInitError | ButtplugUnknownError | ButtplugPingError | ButtplugMessageError;
+    errorClass: Messages.ErrorClass;
+    innerError: Error | undefined;
+    messageId: number | undefined;
+    protected constructor(message: string, errorClass: Messages.ErrorClass, id?: number, inner?: Error);
+}
+export declare class ButtplugInitError extends ButtplugError {
+    constructor(message: string, id?: number);
+}
+export declare class ButtplugDeviceError extends ButtplugError {
+    constructor(message: string, id?: number);
+}
+export declare class ButtplugMessageError extends ButtplugError {
+    constructor(message: string, id?: number);
+}
+export declare class ButtplugPingError extends ButtplugError {
+    constructor(message: string, id?: number);
+}
+export declare class ButtplugUnknownError extends ButtplugError {
+    constructor(message: string, id?: number);
+}

package/dist/web/core/Logging.d.ts

@@ -0,0 +1,112 @@
+/*!
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
+ * project root for full license information.
+ *
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
+ */
+import { EventEmitter } from 'eventemitter3';
+export declare enum ButtplugLogLevel {
+    Off = 0,
+    Error = 1,
+    Warn = 2,
+    Info = 3,
+    Debug = 4,
+    Trace = 5
+}
+/**
+ * Representation of log messages for the internal logging utility.
+ */
+export declare class LogMessage {
+    /** Timestamp for the log message */
+    private timestamp;
+    /** Log Message */
+    private logMessage;
+    /** Log Level */
+    private logLevel;
+    /**
+     * @param logMessage Log message.
+     * @param logLevel: Log severity level.
+     */
+    constructor(logMessage: string, logLevel: ButtplugLogLevel);
+    /**
+     * Returns the log message.
+     */
+    get Message(): string;
+    /**
+     * Returns the log message level.
+     */
+    get LogLevel(): ButtplugLogLevel;
+    /**
+     * Returns the log message timestamp.
+     */
+    get Timestamp(): string;
+    /**
+     * Returns a formatted string with timestamp, level, and message.
+     */
+    get FormattedMessage(): string;
+}
+/**
+ * Simple, global logging utility for the Buttplug client and server. Keeps an
+ * internal static reference to an instance of itself (singleton pattern,
+ * basically), and allows message logging throughout the module.
+ */
+export declare class ButtplugLogger extends EventEmitter {
+    /** Singleton instance for the logger */
+    protected static sLogger: ButtplugLogger | undefined;
+    /** Sets maximum log level to log to console */
+    protected maximumConsoleLogLevel: ButtplugLogLevel;
+    /** Sets maximum log level for all log messages */
+    protected maximumEventLogLevel: ButtplugLogLevel;
+    /**
+     * Returns the stored static instance of the logger, creating one if it
+     * doesn't currently exist.
+     */
+    static get Logger(): ButtplugLogger;
+    /**
+     * Constructor. Can only be called internally since we regulate ButtplugLogger
+     * ownership.
+     */
+    protected constructor();
+    /**
+     * Set the maximum log level to output to console.
+     */
+    get MaximumConsoleLogLevel(): ButtplugLogLevel;
+    /**
+     * Get the maximum log level to output to console.
+     */
+    set MaximumConsoleLogLevel(buttplugLogLevel: ButtplugLogLevel);
+    /**
+     * Set the global maximum log level
+     */
+    get MaximumEventLogLevel(): ButtplugLogLevel;
+    /**
+     * Get the global maximum log level
+     */
+    set MaximumEventLogLevel(logLevel: ButtplugLogLevel);
+    /**
+     * Log new message at Error level.
+     */
+    Error(msg: string): void;
+    /**
+     * Log new message at Warn level.
+     */
+    Warn(msg: string): void;
+    /**
+     * Log new message at Info level.
+     */
+    Info(msg: string): void;
+    /**
+     * Log new message at Debug level.
+     */
+    Debug(msg: string): void;
+    /**
+     * Log new message at Trace level.
+     */
+    Trace(msg: string): void;
+    /**
+     * Checks to see if message should be logged, and if so, adds message to the
+     * log buffer. May also print message and emit event.
+     */
+    protected AddLogMessage(msg: string, level: ButtplugLogLevel): void;
+}

package/dist/web/core/MessageUtils.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
+ * project root for full license information.
+ *
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
+ */
+import * as Messages from './Messages';
+export declare function fromJSON(str: any): Messages.ButtplugMessage[];

package/dist/web/core/Messages.d.ts

@@ -0,0 +1,274 @@
+/*!
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
+ * project root for full license information.
+ *
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
+ */
+export declare const SYSTEM_MESSAGE_ID = 0;
+export declare const DEFAULT_MESSAGE_ID = 1;
+export declare const MAX_ID = 4294967295;
+export declare const MESSAGE_SPEC_VERSION = 3;
+export declare class MessageAttributes {
+    ScalarCmd?: Array<GenericDeviceMessageAttributes>;
+    RotateCmd?: Array<GenericDeviceMessageAttributes>;
+    LinearCmd?: Array<GenericDeviceMessageAttributes>;
+    RawReadCmd?: RawDeviceMessageAttributes;
+    RawWriteCmd?: RawDeviceMessageAttributes;
+    RawSubscribeCmd?: RawDeviceMessageAttributes;
+    SensorReadCmd?: Array<SensorDeviceMessageAttributes>;
+    SensorSubscribeCmd?: Array<SensorDeviceMessageAttributes>;
+    StopDeviceCmd: {};
+    constructor(data: Partial<MessageAttributes>);
+    update(): void;
+}
+export declare enum ActuatorType {
+    Unknown = "Unknown",
+    Vibrate = "Vibrate",
+    Rotate = "Rotate",
+    Oscillate = "Oscillate",
+    Constrict = "Constrict",
+    Inflate = "Inflate",
+    Position = "Position"
+}
+export declare enum SensorType {
+    Unknown = "Unknown",
+    Battery = "Battery",
+    RSSI = "RSSI",
+    Button = "Button",
+    Pressure = "Pressure"
+}
+export declare class GenericDeviceMessageAttributes {
+    FeatureDescriptor: string;
+    ActuatorType: ActuatorType;
+    StepCount: number;
+    Index: number;
+    constructor(data: Partial<GenericDeviceMessageAttributes>);
+}
+export declare class RawDeviceMessageAttributes {
+    Endpoints: Array<string>;
+    constructor(Endpoints: Array<string>);
+}
+export declare class SensorDeviceMessageAttributes {
+    FeatureDescriptor: string;
+    SensorType: SensorType;
+    StepRange: Array<number>;
+    Index: number;
+    constructor(data: Partial<GenericDeviceMessageAttributes>);
+}
+export declare abstract class ButtplugMessage {
+    Id: number;
+    constructor(Id: number);
+    get Type(): Function;
+    toJSON(): string;
+    toProtocolFormat(): object;
+    update(): void;
+}
+export declare abstract class ButtplugDeviceMessage extends ButtplugMessage {
+    DeviceIndex: number;
+    Id: number;
+    constructor(DeviceIndex: number, Id: number);
+}
+export declare abstract class ButtplugSystemMessage extends ButtplugMessage {
+    Id: number;
+    constructor(Id?: number);
+}
+export declare class Ok extends ButtplugSystemMessage {
+    Id: number;
+    static Name: string;
+    constructor(Id?: number);
+}
+export declare class Ping extends ButtplugMessage {
+    Id: number;
+    static Name: string;
+    constructor(Id?: number);
+}
+export declare enum ErrorClass {
+    ERROR_UNKNOWN = 0,
+    ERROR_INIT = 1,
+    ERROR_PING = 2,
+    ERROR_MSG = 3,
+    ERROR_DEVICE = 4
+}
+export declare class Error extends ButtplugMessage {
+    ErrorMessage: string;
+    ErrorCode: ErrorClass;
+    Id: number;
+    static Name: string;
+    constructor(ErrorMessage: string, ErrorCode?: ErrorClass, Id?: number);
+    get Schemversion(): number;
+}
+export declare class DeviceInfo {
+    DeviceIndex: number;
+    DeviceName: string;
+    DeviceMessages: MessageAttributes;
+    DeviceDisplayName?: string;
+    DeviceMessageTimingGap?: number;
+    constructor(data: Partial<DeviceInfo>);
+}
+export declare class DeviceList extends ButtplugMessage {
+    static Name: string;
+    Devices: DeviceInfo[];
+    Id: number;
+    constructor(devices: DeviceInfo[], id?: number);
+    update(): void;
+}
+export declare class DeviceAdded extends ButtplugSystemMessage {
+    static Name: string;
+    DeviceIndex: number;
+    DeviceName: string;
+    DeviceMessages: MessageAttributes;
+    DeviceDisplayName?: string;
+    DeviceMessageTimingGap?: number;
+    constructor(data: Partial<DeviceAdded>);
+    update(): void;
+}
+export declare class DeviceRemoved extends ButtplugSystemMessage {
+    DeviceIndex: number;
+    static Name: string;
+    constructor(DeviceIndex: number);
+}
+export declare class RequestDeviceList extends ButtplugMessage {
+    Id: number;
+    static Name: string;
+    constructor(Id?: number);
+}
+export declare class StartScanning extends ButtplugMessage {
+    Id: number;
+    static Name: string;
+    constructor(Id?: number);
+}
+export declare class StopScanning extends ButtplugMessage {
+    Id: number;
+    static Name: string;
+    constructor(Id?: number);
+}
+export declare class ScanningFinished extends ButtplugSystemMessage {
+    static Name: string;
+    constructor();
+}
+export declare class RequestServerInfo extends ButtplugMessage {
+    ClientName: string;
+    MessageVersion: number;
+    Id: number;
+    static Name: string;
+    constructor(ClientName: string, MessageVersion?: number, Id?: number);
+}
+export declare class ServerInfo extends ButtplugSystemMessage {
+    MessageVersion: number;
+    MaxPingTime: number;
+    ServerName: string;
+    Id: number;
+    static Name: string;
+    constructor(MessageVersion: number, MaxPingTime: number, ServerName: string, Id?: number);
+}
+export declare class StopDeviceCmd extends ButtplugDeviceMessage {
+    DeviceIndex: number;
+    Id: number;
+    static Name: string;
+    constructor(DeviceIndex?: number, Id?: number);
+}
+export declare class StopAllDevices extends ButtplugMessage {
+    Id: number;
+    static Name: string;
+    constructor(Id?: number);
+}
+export declare class GenericMessageSubcommand {
+    Index: number;
+    protected constructor(Index: number);
+}
+export declare class ScalarSubcommand extends GenericMessageSubcommand {
+    Scalar: number;
+    ActuatorType: ActuatorType;
+    constructor(Index: number, Scalar: number, ActuatorType: ActuatorType);
+}
+export declare class ScalarCmd extends ButtplugDeviceMessage {
+    Scalars: ScalarSubcommand[];
+    DeviceIndex: number;
+    Id: number;
+    static Name: string;
+    constructor(Scalars: ScalarSubcommand[], DeviceIndex?: number, Id?: number);
+}
+export declare class RotateSubcommand extends GenericMessageSubcommand {
+    Speed: number;
+    Clockwise: boolean;
+    constructor(Index: number, Speed: number, Clockwise: boolean);
+}
+export declare class RotateCmd extends ButtplugDeviceMessage {
+    Rotations: RotateSubcommand[];
+    DeviceIndex: number;
+    Id: number;
+    static Name: string;
+    static Create(deviceIndex: number, commands: [number, boolean][]): RotateCmd;
+    constructor(Rotations: RotateSubcommand[], DeviceIndex?: number, Id?: number);
+}
+export declare class VectorSubcommand extends GenericMessageSubcommand {
+    Position: number;
+    Duration: number;
+    constructor(Index: number, Position: number, Duration: number);
+}
+export declare class LinearCmd extends ButtplugDeviceMessage {
+    Vectors: VectorSubcommand[];
+    DeviceIndex: number;
+    Id: number;
+    static Name: string;
+    static Create(deviceIndex: number, commands: [number, number][]): LinearCmd;
+    constructor(Vectors: VectorSubcommand[], DeviceIndex?: number, Id?: number);
+}
+export declare class SensorReadCmd extends ButtplugDeviceMessage {
+    DeviceIndex: number;
+    SensorIndex: number;
+    SensorType: SensorType;
+    Id: number;
+    static Name: string;
+    constructor(DeviceIndex: number, SensorIndex: number, SensorType: SensorType, Id?: number);
+}
+export declare class SensorReading extends ButtplugDeviceMessage {
+    DeviceIndex: number;
+    SensorIndex: number;
+    SensorType: SensorType;
+    Data: number[];
+    Id: number;
+    static Name: string;
+    constructor(DeviceIndex: number, SensorIndex: number, SensorType: SensorType, Data: number[], Id?: number);
+}
+export declare class RawReadCmd extends ButtplugDeviceMessage {
+    DeviceIndex: number;
+    Endpoint: string;
+    ExpectedLength: number;
+    Timeout: number;
+    Id: number;
+    static Name: string;
+    constructor(DeviceIndex: number, Endpoint: string, ExpectedLength: number, Timeout: number, Id?: number);
+}
+export declare class RawWriteCmd extends ButtplugDeviceMessage {
+    DeviceIndex: number;
+    Endpoint: string;
+    Data: Uint8Array;
+    WriteWithResponse: boolean;
+    Id: number;
+    static Name: string;
+    constructor(DeviceIndex: number, Endpoint: string, Data: Uint8Array, WriteWithResponse: boolean, Id?: number);
+}
+export declare class RawSubscribeCmd extends ButtplugDeviceMessage {
+    DeviceIndex: number;
+    Endpoint: string;
+    Id: number;
+    static Name: string;
+    constructor(DeviceIndex: number, Endpoint: string, Id?: number);
+}
+export declare class RawUnsubscribeCmd extends ButtplugDeviceMessage {
+    DeviceIndex: number;
+    Endpoint: string;
+    Id: number;
+    static Name: string;
+    constructor(DeviceIndex: number, Endpoint: string, Id?: number);
+}
+export declare class RawReading extends ButtplugDeviceMessage {
+    DeviceIndex: number;
+    Endpoint: string;
+    Data: number[];
+    Id: number;
+    static Name: string;
+    constructor(DeviceIndex: number, Endpoint: string, Data: number[], Id?: number);
+}

package/dist/web/index.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
+ * project root for full license information.
+ *
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
+ */
+export * from './client/Client';
+export * from './client/ButtplugClientDevice';
+export * from './client/ButtplugBrowserWebsocketClientConnector';
+export * from './client/ButtplugNodeWebsocketClientConnector';
+export * from './client/ButtplugClientConnectorException';
+export * from './utils/ButtplugMessageSorter';
+export * from './client/IButtplugClientConnector';
+export * from './core/Messages';
+export * from './core/MessageUtils';
+export * from './core/Logging';
+export * from './core/Exceptions';

package/dist/web/utils/ButtplugBrowserWebsocketConnector.d.ts

@@ -0,0 +1,22 @@
+/*!
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
+ * project root for full license information.
+ *
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
+ */
+import { EventEmitter } from 'eventemitter3';
+import { ButtplugMessage } from '../core/Messages';
+export declare class ButtplugBrowserWebsocketConnector extends EventEmitter {
+    private _url;
+    protected _ws: WebSocket | undefined;
+    protected _websocketConstructor: typeof WebSocket | null;
+    constructor(_url: string);
+    get Connected(): boolean;
+    connect: () => Promise<void>;
+    disconnect: () => Promise<void>;
+    sendMessage(msg: ButtplugMessage): void;
+    initialize: () => Promise<void>;
+    protected parseIncomingMessage(event: MessageEvent): void;
+    protected onReaderLoad(event: Event): void;
+}

package/dist/web/utils/ButtplugMessageSorter.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
+ * project root for full license information.
+ *
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
+ */
+import * as Messages from '../core/Messages';
+export declare class ButtplugMessageSorter {
+    private _useCounter;
+    protected _counter: number;
+    protected _waitingMsgs: Map<number, [
+        (val: Messages.ButtplugMessage) => void,
+        (err: Error) => void
+    ]>;
+    constructor(_useCounter: boolean);
+    PrepareOutgoingMessage(msg: Messages.ButtplugMessage): Promise<Messages.ButtplugMessage>;
+    ParseIncomingMessages(msgs: Messages.ButtplugMessage[]): Messages.ButtplugMessage[];
+}

package/dist/web/utils/Utils.d.ts

@@ -0,0 +1 @@
+export declare function getRandomInt(max: number): number;

package/node-test.ts

@@ -0,0 +1,5 @@
+import { ButtplugClient, ButtplugNodeWebsocketClientConnector } from '.';
+
+const client = new ButtplugClient('Test Client');
+client.connect(new ButtplugNodeWebsocketClientConnector('ws://127.0.0.1:12345'));
+