buttplug 1.0.17 → 3.0.0-alpha.1

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,166 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our
+project and our community a harassment-free experience for everyone,
+regardless of age (see addendum), body size, disability, ethnicity,
+gender identity and expression, level of experience, nationality,
+personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive
+environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of unnecessary sexualized language or imagery and unwelcome
+  sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political
+  attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or
+  electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in
+  a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of
+acceptable behavior and are expected to take appropriate and fair
+corrective action in response to any instances of unacceptable
+behavior.
+
+Project maintainers have the right and responsibility to remove, edit,
+or reject comments, commits, code, wiki edits, issues, and other
+contributions that are not aligned to this Code of Conduct, or to ban
+temporarily or permanently any contributor for other behaviors that
+they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public
+spaces when an individual is representing the project or its
+community. Examples of representing a project or community include
+using an official project e-mail address, posting via an official
+social media account, or acting as an appointed representative at an
+online or offline event. Representation of a project may be further
+defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior
+May be reported by contacting the project team at
+admin@metafetish.com. All complaints will be reviewed and investigated
+and will result in a response that is deemed necessary and appropriate
+to the circumstances. The project team is obligated to maintain
+confidentiality with regard to the reporter of an incident. Further
+details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct
+in good faith may face temporary or permanent repercussions as
+determined by other members of the project's leadership.
+
+## Addendum for Metafetish Related Projects
+
+While the project team seeks to welcome all contributors and
+participants, due to the sexual nature of projects related to the
+Metafetish organization, all contributors and participants should be
+of provable legal age.
+
+Working on projects related to the Metafetish organization may at
+times require sexual situations to be discussed in project forums, be
+they message boards, social media, chat systems, or other means not
+listed here. These discussions should pertain only to usage of the
+projects they involve, and should only include required details to
+express some sort of issue or feature request. If the discussion
+includes material that others may find objectionable for some reason,
+the discussions should be prepended with content warnings.
+
+While usage stories about projects are appreciated, unless they
+express some issue with specific usage, we ask that they be kept to
+outside forums, where they would be appropriate. There are many
+sub-reddits, fetlife groups, and forum instances available for a
+multitude of interests where usage can be discussed. If a proper venue
+is not known, please contact project maintainers, as they may be able
+to point to one.
+
+If any contributor or project member feels that these considerations
+have not been met, they should contact the project maintainers at
+admin@metafetish.com.
+
+# Moderation
+
+These are the policies for upholding our community's standards of
+conduct. If you feel that a thread needs moderation, please contact
+the [Metafetish moderation team](mailto:admin@metafetish.com).
+
+1. Remarks that violate the standard of conduct, including hateful,
+   hurtful, oppressive, or exclusionary remarks, are not allowed.
+   (Cursing is allowed, but never targeting another user, and never in
+   a hateful manner.)
+2. Remarks that moderators find inappropriate, whether listed in the
+   code of conduct or not, are also not allowed.
+3. Moderators will first respond to such remarks with a warning.
+4. If the warning is unheeded, the user will be "kicked," i.e., kicked
+   out of the communication channel to cool off.
+5. If the user comes back and continues to make trouble, they will be
+   banned, i.e., indefinitely excluded.
+6. Moderators may choose at their discretion to un-ban the user if it
+   was a first offense and they offer the offended party a genuine
+   apology.
+7. If a moderator bans someone and you think it was unjustified,
+   please take it up with that moderator, or with a different
+   moderator, **in private**. Complaints about bans in-channel are not
+   allowed.
+8. Moderators are held to a higher standard than other community
+   members. If a moderator creates an inappropriate situation, they
+   should expect less leeway than others.
+
+In this community we strive to go the extra step to look out for each
+other. Don't just aim to be technically unimpeachable, try to be your
+best self. In particular, avoid flirting with offensive or sensitive
+issues, particularly if they're off-topic; this all too often leads to
+unnecessary fights, hurt feelings, and damaged trust; worse, it can
+drive people away from the community entirely.
+
+And if someone takes issue with something you said or did, resist the
+urge to be defensive. Just stop doing what it was they complained
+about and apologize. Even if you feel you were misinterpreted or
+unfairly accused, chances are good there was something you could've
+communicated better — remember that it's your responsibility to make
+your fellow community members comfortable. Everyone wants to get along
+and we are all here first and foremost because we want to talk about
+cool technology. You will find that people will be eager to assume
+good intent and forgive as long as you earn their trust.
+
+The enforcement policies listed above apply to all official Metafetish
+venues; including all Slack channels and their related bridged IRC
+channels, repositories and their respective issue trackers/wikis/etc,
+message boards, and social media networks. For other projects adopting
+this Code of Conduct, please contact the maintainers of those projects
+for enforcement. If you wish to use this code of conduct for your own
+project, consider explicitly mentioning your moderation policy or
+making a copy with your own moderation policy so as to avoid
+confusion.
+
+# Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/
+
+The Moderation portion of this Code of Conduct is adapted from
+the
+[Rust Language Code of Conduct](https://www.rust-lang.org/en-US/conduct.html).

package/CONTRIBUTING.md

@@ -0,0 +1,169 @@
+# Contributing
+
+Thanks for your interest in contributing to the Metafetish
+Organization repo! We're looking forward to working with you to make
+this project better.
+
+## Code Of Conduct
+
+First off, you'll want to check out our [Code of Conduct](CODE_OF_CONDUCT.md), which
+should be alongside this document. It outlines the rules and
+expectations for interaction with our project.
+
+## For All Community
+
+This section contains information for everyone involved with the
+projects, whether developing or simply interested in using and
+recommending improvements.
+
+### Communication
+
+There are a couple of different ways in which you can interact with
+other members of Metafetish projects.
+
+- [We have a Slack instance](https://metafetish.slack.com). Note that an invitation is required
+  to join the slack instance. Please email admin@metafetish.com for an
+  invite, and include the email address you'd like to use to log in.
+- [We have message boards](http://metafetish.club). We have Discourse forums available that
+  cover most of our projects. For anything that doesn't fit into one
+  of the categories, there's the General forum.
+
+### Anonymous Accounts
+
+Due to the sensitive nature of Metafetish projects, some community
+members prefer to use anonymous accounts, on message boards as well as
+for contributing to code repos. We understand the need for this, and
+try to be as accepting of that as possible without letting it
+interfere with project progress. 
+
+Note that vetting by project leads will still need to occur before
+administration rights after given to any account on a project resource
+(forums, repos, etc), anonymous or otherwise.
+
+### Filing feature requests
+
+If there are features you'd like in a project, you may request them by:
+
+- If you have a github account, filing a github issue on the project.
+- Otherwise, make a post on the message board in the appropriate
+  category, or on the General category if a proper category does not
+  exist.
+  
+Please be specific in your feature request. We will ask followup
+questions for clarification, but the more information we have, the
+better.
+
+### Filing bug reports
+
+If you find a problem in a project, please do not hesitate to tell us.
+
+- If you find a security bug, please email [admin@metafetish.com](mailto:admin@metafetish.com)
+  immediately, and we will work with you to resolve it and get the
+  information out to the community ASAP.
+- For all other bugs:
+  - If you have a github account, filing a github issue on the project.
+  - Otherwise, make a post on the message board in the appropriate
+    category, or on the General category if a proper category does not
+    exist.
+
+In the issue or post, you should let us know:
+
+- The software you are using that has the bug
+- The version of the software
+- The operating system version of the computer you using the software
+  on.
+- The steps you took to get to the problem.
+- Whether the problem is repeatable.
+
+Someone should hopefully follow up on your problem soon.
+
+## For Developer Community
+
+This section contains information mainly related to helping in
+development of Metafetish projects.
+
+### Getting up and running on a project
+
+In many cases, if you are trying to start developing a new project,
+information about compiling and using the project will be in the
+README. If these instructions are missing or incomplete, you can ask
+in the [proper category on the message boards](   http://metafetish.club), or file an issue on
+the project if you have a github account. You can also contact us on
+Slack if you have an account there.
+
+Note that some of our projects are rather complicated, and span
+multiple repositories and/or technologies. We do our best to keep
+things up to date, but there may be times where we've missed updating
+documentation. If something seems wrong, or isn't working for you, ask
+us using one of the above methods.
+
+### Continuous Integration
+
+In as many cases as possible, we have added continuous integration
+services to run build checks on our software projects. These will
+normally be [Travis](http://travis-ci.org) for macOS and linux builds (or platform
+independent builds, like Node with no native requirements),
+and [Appveyor](http://appveyor.com) for Windows builds. CI Badges are usually added to
+the README.
+
+### Git/Github Workflow
+
+This section goes over our git workflow. We realize that git can be
+quite complicated and has a steep learning curve. We have done as much
+as we can to make sure Github makes this easy for contributors. If you
+are new to git, or if you do not understand some part of this section,
+please let us know when you make a pull request, and we'll help out.
+If you are not sure how to make a pull request on github,
+contact [admin@metafetish.com](mailto:admin@metafetish.com) and a project lead will help.
+
+As of this writing, Metafetish projects are maintained on
+the [Metafetish Organization on Github](http://github.com/metafetish). 'master' branches on
+Metafetish projects are kept as [Github protected branches](https://help.github.com/articles/about-protected-branches/), with
+the following settings.
+
+- All of the following rules apply to both users and administrators.
+- No direct pushes to 'master'. All changes must be via Pull Request
+  (PR).
+- No force pushes to 'master'. All rewrites must be done on feature
+  branches.
+- PRs must be off the end of the 'master' branch to merge to master.
+  Github will enforce this in PRs.
+- PRs must pass CI to merge. Due to the hardware focus of many
+  Metafetish projects, tests may be difficult to write in languages
+  without proper mocking utilities. Therefore, Code Coverage increase
+  is nice, but not required.
+- PRs should have a reviewer if possible, but this is not enforced.
+
+Metafetish organization projects maintain a 'rebase-only' workflow to
+master when possible, where all branches will be a fast-forward merge.
+Github PRs should manage this themselves, and will display an error if
+this is not possible. Project management will be happy to work with
+you to resolve the issue.
+
+In order to reduce workload of contributors, repo dependencies should
+be brought in by using the [git subtree method](https://developer.atlassian.com/blog/2015/05/the-power-of-git-subtree/) instead of git
+submodules. As this will require upkeep and documentation, please
+discuss possible repo inclusion with project leads before submitting
+pull requests with subtree merges.
+
+### Project Management
+
+For project management, we usually use either [Trello](http://trello.com)
+or [ZenHub](http://zenhub.io), depending on the level of integration needed with the
+source code repo itself. More information about this is usually
+included in the README for the specific project.
+
+### Documentation
+
+Non-code documentation for projects is usually done in one of two
+formats:
+
+- Markdown, for all README and contributor facing files.
+- org-mode, for large documentation sets and manuals.
+
+As there is currently only one project lead using org-mode (but they
+write most of the documentation), conversation from org-mode to
+markdown can happen on request. Similarly, markdown versions of
+org-mode documents may be checked in to documentation repos as needed.
+
+Large manuals are usually managed using the [gitbook](https://github.com/GitbookIO/gitbook) format.

package/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2017-2018, Nonpolynomial Labs LLC
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of buttplug-js nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,136 +1,33 @@
-# Buttplug Rust FFI - WASM/Typescript/Javascript
-
-[![NPM](https://img.shields.io/npm/v/buttplug.svg)](https://www.npmjs.com/package/buttplug)
+# Buttplug Typescript/JS Client Implementation
 
 [![Patreon donate button](https://img.shields.io/badge/patreon-donate-yellow.svg)](https://www.patreon.com/qdot)
-[![Discourse Forum](https://img.shields.io/badge/discourse-forum-blue.svg)](https://metafetish.club)
+[![Github donate button](https://img.shields.io/badge/github-donate-ff69b4.svg)](https://www.github.com/sponsors/qdot)
+
+[![Discourse Forum](https://img.shields.io/badge/discourse-forum-blue.svg)](https://discuss.buttplug.io)
 [![Discord](https://img.shields.io/discord/353303527587708932.svg?logo=discord)](https://discord.buttplug.io)
 [![Twitter](https://img.shields.io/twitter/follow/buttplugio.svg?style=social&logo=twitter)](https://twitter.com/buttplugio)
 
-Buttplug is a framework for hooking up hardware to interfaces, where hardware usually means sex
-toys, but could honestly be just about anything. Think of it as a userland HID manager for things
-that may not specifically be HID, but may go in your butt. 
-
-Or other places too! We're not completely butt-centric, despite the project name. And logo.
-
-## Support The Project
-
-If you find this project helpful, you can [support us via Patreon](http://patreon.com/qdot) or
-[Github Sponsors](https://github.com/sponsors/qdot)! Every donation helps us afford more research materials (sex toys).
-
-## Documentation
-
-The [Buttplug Developer Guide](https://buttplug-developer-guide.docs.buttplug.io) is your best
-source of information for developing with Buttplug. It contains many Javascript examples using this
-library.
-
-API documentation coming soon.
-
-## Supported Hardware
-
-See [IOSTIndex.com](https://iostindex.com/?filtersChanged=1&filter0ButtplugSupport=4) (link is filtered for hardware supported by this library) for a list of supported hardware.
-
-## Installation
-
-For node/webpack applications, Buttplug JS can be installed via npm, using the ["Buttplug" package](https://www.npmjs.com/package/buttplug)
-
-For using Buttplug directly on the web, it can be included from a CDN. See the "Using Buttplug On the Web" section below.
-
-Any package with the word "Buttplug" in it that is < v1 can be ignored, the older JS packages were broken into multiple modules to support native node. At the moment, Buttplug is a single package that comes with all parts required for the web, and the node packages are deprecated.
-
-## For Those Upgrading from Buttplug JS v0.x
-
-There are many breaking changes between Buttplug JS v0.x and Buttplug JS >= v1.x. It is recommended you check the examples in the [Developer Guide](https://buttplug-developer-guide.docs.buttplug.io) for updates between v0.x and v1.x+. Most of the logic should be the same, but there are some subtle differences in the API surface.
-
-If you have questions, you can [ask on the discord](https://discord.buttplug.io) or [file an issue](https://github.com/buttplugio/buttplug-rs-ffi/issues).
-
-## A Note on Architecture
-
-Buttplug JS is only about 10% JS. There's enough JS (ok actually it's typescript) to get us to Rust, but most of Buttplug's logic, including toy control, hardware access, network communications, etc, are in Rust, via [buttplug-rs](https://github.com/buttplugio/buttplug-rs) that is compiled to WASM. This means that if something fails in Rust/WASM, it may look somewhat opaque in JS. If you find yourself running into these cases, please [file an issue on this repo](https://github.com/buttplugio/buttplug-rs-ffi) and we'll try to get things cleared up. The goal for the future is to return rust panic stacks across the WASM boundary for better logging, but this is still something we're working on.
-
-If you are curious about how the FFI fits together, [see the root README for the project](https://github.com/buttplugio/buttplug-rs-ffi).
-
-## Platform Support and Runtimes
-
-Currently, Buttplug JS only supports usage on the web, either via packed web applications, or directly in webpages. Native Node access will be happening at some point in the future. For more info on native node access, [watch this issue in our repo](https://github.com/buttplugio/buttplug-rs-ffi/issues/11).
-
-## Using Buttplug With Webpack
-
-Packing Buttplug in Webpack may require some extra work, as Buttplug JS involves WASM, which means asynchronous loading and asset finding.
-
-The first issue you may run into is with asset loading, as webpack can only be so smart about where the WASM blob is. If you don't set the `output.publicPath` webpack configuration, you'll possibly have issues with the WASM loader not being able to find the blob (resulting in 404 errors in your web console and your app not loading). You've got 2 choices here:
-
-* If you know where your application will reside on your server and that location will never change, set `output.publicPath` in your webpack configuration to match where your generated webpack files will be. For instance, if you have webpack building chunks to `dist`, your `output.publicPath` would be `/dist/`. 
-* To handle your application being at *any* path, add the following code block and make sure it is run _before_ running `buttplugInit()`. This is a hack that finds the URL the current JS file is being loaded from, and uses that to load the WASM blob.
-
-```javascript
-// If using typescript, uncomment this declare line
-declare var __webpack_public_path__: any;
-
-var scripts = document.getElementsByTagName( "script" );
-var lastScript = scripts[scripts.length - 1].src;
-__webpack_public_path__ = lastScript.substr(0, lastScript.lastIndexOf('/') + 1);
-```
-
-After setting up your loading, you'll need to call buttplugInit() and make sure it succeeds before calling into Buttplug:
-
-```javascript
-// This could also be awaited, just depends on your calling context.
-buttplugInit().then(() => console.log("Ready to set up buttplug calls!"));
-```
-
-This will asynchronously load the library, in a way that webpack shouldn't complain about.
-
-Note that this has only been tested in Webpack 4. Webpack 5 has a mechanism for automating asynchronous loading, but this has not been experimented with in buttplug-js yet. If you try this and have suggestions, [please file an issue and let us know](https://github.com/buttplugio/buttplug-rs-ffi/issues).
-
-If you are using Webpack 5, you may need to use Webpack 4 style WASM loading for the time being. Add the following to your webpack config:
-
-```javascript
-// Needed for webpack 5 only
-experiments.syncWebAssembly: true
-```
-
-If you're seeing MIME issues (i.e. "unknown type" when trying load your app), you may need to set the MIME type in the Webpack configuration file. Add the following block to your rules object:
-
-```javascript
-{
-    test: /\.wasm$/,
-    type: "webassembly/experimental"
-}
-```
-
-If you still run into problems, [file an issue](https://github.com/buttplugio/buttplug-rs-ffi/issues) 
-
-## Using Buttplug On The Web
-
-Using the precompiled Buttplug library from a webpage (i.e. loading it as a script in an HTML file) will bring in a global named `Buttplug`. You'll need to run the init method in order to load the rest of the library from WASM, otherwise no calls to the library will work.
-
-```html
-<!-- Change library version here to match current NPM version -->
-<script lang="javascript" 
-   src="https://cdn.jsdelivr.net/npm/buttplug@1.0.1/dist/web/buttplug.min.js">
-</script>
-<script lang="javascript">
-  Buttplug.buttplugInit().then(() => console.log("Library loaded"));
-</script>
-```
-
-Each of the examples in the [Developer Guide](https://buttplug-developer-guide.docs.buttplug.io) contain this call, in order to make every example complete.
-
-## Support
-
-If you have questions, support is available via:
-
-- [Discord](https://discord.buttplug.io) - This is the best choice for support
-- [Mentions/DMs to @buttplugio on twitter](https://twitter.com/buttplugio)
+This repo houses are pure .Net version of the Buttplug Typescript/Javascript Client, implementing
+the Version 3 Buttplug Spec. It is expected to run from a browser against either [Intiface Central
+(GUI)](https://intiface.com/central) or [Initface Engine
+(CLI)](https://github.com/intiface/intiface-engine). No Rust FFI bindings are required.
 
-## Contributing
+## What happened? Why is buttplug-csharp back?
 
-If you have issues or feature requests, please feel free to [file an issue](https://github.com/buttplugio/buttplug-rs-ffi/issues).
+For those of you that have been around a while, you may remember that this used to be the main
+Typescript/Javascript implementation. From 2017 to 2020, it was a reference version of the Buttplug
+Intimate Haptics Control Standard. 
 
-We are not looking for code contributions or pull requests at this time, and will not accept pull requests that do not have a matching issue where the matter was previously discussed. Pull requests should only be submitted after talking to [qdot](https://github.com/qdot) via issues (or on [discord](https://discord.buttplug.io) or [twitter DMs](https://twitter.com/buttplugio) if you would like to stay anonymous and out of recorded info on the repo) before submitting PRs. Random PRs without matching issues and discussion are likely to be closed without merging. and receiving approval to develop code based on an issue. Any random or non-issue pull requests will most likely be closed without merging.
+Then I rewrote everything in Rust because I like Rust more and it's far easier for me to port across
+platforms. This repo was archived ~2 years ago in preference to seating the C# client *and* server
+on top of the [Rust implementation of Buttplug](https://github.com/buttplugio/buttplug), as part of
+the [Rust FFI Project](https://github.com/buttplugio/buttplug-rs-ffi).
 
-## License
+That project ended up being a partial failure.
 
-Buttplug is BSD 3-Clause licensed. More information is available in
-the LICENSE file.
+While the FFI system is handy for languages where it is very difficult to rebuild some parts of the
+library (C/C++/Java/etc...), for managed langauges like Javascript and C#, requiring both the client
+and server to use the FFI was overkill, and caused many extremely difficult-to-debug issues. With
+that in mind, the Typescript implementation in this repo is being turned into a Client only. The
+WASM server and Embedded Connector will stay in the FFI repo, but will be another NPM package that
+will be optional.

package/azure-pipelines.yml

@@ -0,0 +1,19 @@
+trigger:
+- master
+- dev
+
+jobs:
+  # - job: "MacOS"
+  #   pool:
+  #     vmImage: 'macos-10.13'
+  #   steps:
+  #     - template: 'build/build-test-freeze.yml'
+  #       parameters:
+  #         platform: "macos-x64"
+  - job: "Linux"
+    pool:
+      vmImage: 'ubuntu-16.04'
+    steps:
+      - template: 'build/build-test-freeze.yml'
+        parameters:
+          platform: "linux-x64"

package/dist/main/src/client/ButtplugBrowserWebsocketClientConnector.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 { IButtplugClientConnector } from "./IButtplugClientConnector";
+import { ButtplugMessage } from "../core/Messages";
+import { ButtplugBrowserWebsocketConnector } from "../utils/ButtplugBrowserWebsocketConnector";
+export declare class ButtplugBrowserWebsocketClientConnector extends ButtplugBrowserWebsocketConnector implements IButtplugClientConnector {
+    private _sorter;
+    protected _ws: WebSocket | undefined;
+    constructor(_url: string);
+    get Connected(): boolean;
+    Send: (msg: ButtplugMessage) => Promise<ButtplugMessage>;
+    protected ParseIncomingMessage: (event: MessageEvent) => void;
+    protected OnReaderLoad(event: Event): void;
+}

package/dist/main/src/client/ButtplugBrowserWebsocketClientConnector.js

@@ -0,0 +1,58 @@
+/*!
+ * 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.
+ */
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ButtplugBrowserWebsocketClientConnector = void 0;
+const MessageUtils_1 = require("../core/MessageUtils");
+const ButtplugMessageSorter_1 = require("../utils/ButtplugMessageSorter");
+const ButtplugBrowserWebsocketConnector_1 = require("../utils/ButtplugBrowserWebsocketConnector");
+class ButtplugBrowserWebsocketClientConnector extends ButtplugBrowserWebsocketConnector_1.ButtplugBrowserWebsocketConnector {
+    constructor(_url) {
+        super(_url);
+        this._sorter = new ButtplugMessageSorter_1.ButtplugMessageSorter(true);
+        this.Send = (msg) => __awaiter(this, void 0, void 0, function* () {
+            if (!this.Connected) {
+                throw new Error("ButtplugClient not connected");
+            }
+            const p = this._sorter.PrepareOutgoingMessage(msg);
+            this.SendMessage(msg);
+            return yield p;
+        });
+        this.ParseIncomingMessage = (event) => {
+            if (typeof (event.data) === "string") {
+                const msgs = (0, MessageUtils_1.FromJSON)(event.data);
+                const emitMsgs = this._sorter.ParseIncomingMessages(msgs);
+                this.emit("message", emitMsgs);
+            }
+            else if (event.data instanceof Blob) {
+                const reader = new FileReader();
+                reader.addEventListener("load", (ev) => { this.OnReaderLoad(ev); });
+                reader.readAsText(event.data);
+            }
+        };
+    }
+    get Connected() {
+        return this._ws !== undefined;
+    }
+    OnReaderLoad(event) {
+        const msgs = (0, MessageUtils_1.FromJSON)(event.target.result);
+        const emitMsgs = this._sorter.ParseIncomingMessages(msgs);
+        this.emit("message", emitMsgs);
+    }
+}
+exports.ButtplugBrowserWebsocketClientConnector = ButtplugBrowserWebsocketClientConnector;
+//# sourceMappingURL=ButtplugBrowserWebsocketClientConnector.js.map

package/dist/main/src/client/ButtplugBrowserWebsocketClientConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ButtplugBrowserWebsocketClientConnector.js","sourceRoot":"","sources":["../../../../src/client/ButtplugBrowserWebsocketClientConnector.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,YAAY,CAAC;;;;;;;;;;;;AAIb,uDAAgD;AAChD,0EAAuE;AACvE,kGAA+F;AAE/F,MAAa,uCAAwC,SAAQ,qEAAiC;IAK5F,YAAmB,IAAY;QAC7B,KAAK,CAAC,IAAI,CAAC,CAAC;QAJN,YAAO,GAA0B,IAAI,6CAAqB,CAAC,IAAI,CAAC,CAAC;QAWlE,SAAI,GAAG,CAAO,GAAoB,EAA4B,EAAE;YACrE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACnB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;aACjD;YACD,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;YACnD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YACtB,OAAO,MAAM,CAAC,CAAC;QACjB,CAAC,CAAA,CAAA;QAES,yBAAoB,GAAG,CAAC,KAAmB,EAAE,EAAE;YACvD,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,QAAQ,EAAE;gBACpC,MAAM,IAAI,GAAG,IAAA,uBAAQ,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;gBAC1D,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;aAChC;iBAAM,IAAI,KAAK,CAAC,IAAI,YAAY,IAAI,EAAE;gBACrC,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;gBAChC,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACpE,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;aAC/B;QACH,CAAC,CAAA;IAzBD,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,GAAG,KAAK,SAAS,CAAC;IAChC,CAAC;IAuBS,YAAY,CAAC,KAAY;QACjC,MAAM,IAAI,GAAG,IAAA,uBAAQ,EAAE,KAAK,CAAC,MAAqB,CAAC,MAAM,CAAC,CAAC;QAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAC1D,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACjC,CAAC;CACF;AAvCD,0FAuCC"}

package/dist/main/src/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 { ButtplugException } from "../core/Exceptions";
+export declare class ButtplugClientConnectorException extends ButtplugException {
+    constructor(message: string);
+}