buttplug 1.0.16 → 3.0.0-alpha.0

package/CHANGELOG.md

@@ -1,10 +1,20 @@
-# v1.0.16 (2021/10/16)
+# v3.0.0 (2022/12/28)
+
+- Back to pure Typescript. Back to the good shit.
+
+# v2.0.0
+
+- There is no buttplug-js v2
+- There is no Miss Zarves
+- (Version skipped to align JS and C# implementation versions)
+
+# v1.0.16 (2021/10/16) (FFI Impl)
 
 ## Bugfixes
 
 - Revert WASM loading specification to fix webpack/MIME issues
 
-# v1.0.15 (2021/08/29)
+# v1.0.15 (2021/08/29) (FFI Impl)
 
 ## Features
 
@@ -15,13 +25,13 @@
 - Allow specification of WASM loading source for buttplug_init()
 - ButtplugClientDevice equality testing now works as expected
 
-# v1.0.14 (2021/03/21)
+# v1.0.14 (2021/03/21) (FFI Impl)
 
 ## Bugfixes
 
 - Actually fix #60 and #51
 
-# v1.0.13 (2021/03/21)
+# v1.0.13 (2021/03/21) (FFI Impl)
 
 ## Features
 
@@ -33,7 +43,7 @@
 - #59: Client device vibrate() call should take an array of numbers
 - #51: Fix ScanningFinished emission for WebBluetooth
 
-# v1.0.12 (2021/02/20)
+# v1.0.12 (2021/02/20) (FFI Impl)
 
 ## Bugfixes
 
@@ -46,21 +56,21 @@
 
 - Remove publicpath setting in CDN bundler.
 
-# v1.0.10 (2021/02/20)
+# v1.0.10 (2021/02/20) (FFI Impl)
 
 ## Bugfixes
 
 - Implement characteristic read in WebBluetooth WASM
   - Allows us to use the Handy on the web
 
-# v1.0.9 (2021/02/20)
+# v1.0.9 (2021/02/20) (FFI Impl)
 
 ## Bugfixes
 
 - Update to buttplug-rs v2.1.5. The Handy support, client connect race bugfixes, device
   disconnection panic bugfixes.
 
-# v1.0.8 (2021/02/10)
+# v1.0.8 (2021/02/10) (FFI Impl)
 
 ## Features
 
@@ -68,13 +78,13 @@
 - Update to buttplug-rs-ffi core v1.0.12, fixes disconnect issues in WebBluetooth, updates
   connector API for buttplug-rs v2.1.x API
 
-# v1.0.7 (2021/01/24)
+# v1.0.7 (2021/01/24) (FFI Impl)
 
 ## Bugfixes
 
 - Update to buttplug-rs v2.0.5, fixes issue with DeviceMessageInfo deserialization
 
-# v1.0.6 (2021/01/24)
+# v1.0.6 (2021/01/24) (FFI Impl)
 
 ## Bugfixes
 
@@ -84,20 +94,20 @@
 - Update to buttplug-rs v2.0.4, fixing issues with native timers being compiled instead of WASM
   timers.
 
-# v1.0.5 (2021/01/22)
+# v1.0.5 (2021/01/22) (FFI Impl)
 
 ## Bugfixes
 
 - #49: Fix issue with incorrect type check on linear commands.
 
-# v1.0.4 (2021/01/21)
+# v1.0.4 (2021/01/21) (FFI Impl)
 
 ## Features
 
 - Update to Buttplug-rs v2.0.3
   - Fixes issues with Strokers/rotators not showing up due to invalid message attributes.
 
-# v1.0.3 (2021/01/18)
+# v1.0.3 (2021/01/18) (FFI Impl)
 
 ## Features
 
@@ -106,38 +116,38 @@
   - Init/Event API cleanup
 - Panic messages/stacks now emitted on WASM panic
 
-# v1.0.2 (2021/01/10)
+# v1.0.2 (2021/01/10) (FFI Impl)
 
 ## Features
 
 - Update to Buttplug-rs v1.0.5, with Libo and Prettylove support
 
-# v1.0.1 (2020/12/29)
+# v1.0.1 (2020/12/29) (FFI Impl)
 
 ## Bugfixes
 
 - Add protobufjs to dependencies, otherwise typescript compilation files during type resolution.
 
-# v1.0.0 (2020/12/27)
+# v1.0.0 (2020/12/27) (FFI Impl)
 
 ## Features
 
 - Update to Buttplug v1, with new device config file format.
 - Change package name back to "buttplug"
 
-# v1.0.0 Beta 7 (2020/12/20)
+# v1.0.0 Beta 7 (2020/12/20) (FFI Impl)
 
 ## Bugfixes
 
 - Fix browser websockets not throwing errors on invalid URLs or connection errors.
 
-# v1.0.0 Beta 6 (2020/12/20)
+# v1.0.0 Beta 6 (2020/12/20) (FFI Impl)
 
 ## Bugfixes
 
 - Fix webpack build/load strategies for static (CDN loadable) web package.
 
-# v1.0.0 Beta 5 (2020/12/19)
+# v1.0.0 Beta 5 (2020/12/19) (FFI Impl)
 
 ## Features
 
@@ -145,7 +155,7 @@
   FFI layers.
 - Added log output capabilities (console only at the moment).
 
-# v1.0.0 Beta 4 (2020/12/05)
+# v1.0.0 Beta 4 (2020/12/05) (FFI Impl)
 
 ## Features
 
@@ -153,9 +163,358 @@
   verbose enums, but this is good enough.
 - Add stop() method to devices.
 
-# v1.0.0 Beta 3 (2020/12/04)
+# v1.0.0 Beta 3 (2020/12/04) (FFI Impl)
 
 ## API Changes
 
 - Make a single connect method on ButtplugClient
   - Brings API closer to other/old implementations
+
+# Version 0.13.2 - 2020/08/25
+
+## Bugfixes
+
+- Make Android use WebBluetooth's acceptAllDevices so Lovense shows up again
+  - namePrefix, which we use to wildcard Lovense devices, broke in Chrome 81.
+    Fix is tracked for Chrome 87.
+- Fix type mismatch in inherited methods in ForwardedDeviceProtocol.
+
+# Version 0.13.1 - 2020/04/04
+
+## Features
+
+- Added support for Connector Initializer
+  - Allows using the Buttplug connector for auth or other communication before
+    spinning up the protocol itself.
+
+# Version 0.13.0 - 2020/03/29
+
+## Features
+
+- Added Device Forwarder Support
+  - Allows developers to create a device manager that can accept "forwarded"
+    devices from another client. Basically turns Buttplug into a full
+    teledildonics system, using its own protocol.
+- ButtplugClientDevice now emits "deviceremoved" when it is disconnected.
+  - This is alongside the client emitting it.
+
+## Bugfixes
+
+- Fixed WeVibe Melt support
+- Fixed references to buttplug-server-cli in README
+  - This is now at https://github.com/intiface/intiface-node-cli
+
+# Version 0.12.3 - 2020/03/25
+
+## Features
+
+- Added Hardware Support
+  - WebGamepad Haptics on Chrome
+
+# Version 0.12.2 - 2019/12/06
+
+## Features
+
+- Added Hardware Support
+  - WeVibe Vector
+  - Magic Motion Vini, Fugu, Awaken, Equinox, Solstice
+
+# Version 0.12.1 - 2019/10/05
+
+## Features
+
+- Add Motorbunny Support
+
+# Version 0.12.0 - 2019/07/27
+
+## Features
+
+- Allow loading of device configuration file from CDN
+  (https://buttplug-device-config.buttplug.io)
+- Remove yaml requirement for device config file, just use JSON (Saves
+  30% library size)
+
+# Version 0.11.8 - 2019/07/09
+
+## Bugfixes
+
+- Updated built in device config file, including Cyclone SA fixes.
+
+# Version 0.11.7 - 2019/06/22
+
+## Bugfixes
+
+- Dependency security updates
+
+# Version 0.11.6 - 2019/05/27
+
+## Features
+
+- Added hardware support
+  - Kiiroo Onyx 2
+  - Kiiroo Pearl 2
+  - Kiiroo/OhMiBod Fuse
+  - Kiiroo Virtual Blowbot
+  - Kiiroo Titan
+  - Libo PiPiJing Elle/Whale
+  - Libo Xiao Lu (Lottie)
+  - Libo Lu Xiao Han (Lulu)
+  - Libo Suo Yin Qiu (Karen)
+  - Libo Bai Hu (LaLa)
+  - Libo/Sistalk MonsterPub
+  - Youcups Warrior 2
+  - Vorze Bach
+  - A whole bunch of Magic Motion toys I'm not gonna list here.
+
+# Version 0.11.5 - 2019/05/02
+
+## Features
+
+- Change WebBluetooth calls to work with iOS WebBLE app
+
+# Version 0.11.3 - 2019/04/11
+
+## Features
+
+- Updates dependencies, but otherwise this is a dependent library release.
+
+# Version 0.11.2 - 2019/03/16
+
+## Bugfixes
+
+- Roll back to using webpack for web libraries until Rollup is fixed.
+
+# Version 0.11.1 - 2019/03/15
+
+## Features
+
+- Update CLI to work with Intiface
+- That's it. No other changes. Maybe this Monorepo and lockstepped
+  versioning thing wasn't such a good idea. :/
+
+# Version 0.11.0 - 2019/03/09
+
+## Features
+
+- ButtplugBrowserWebsocketConnector now exported from library
+- Add ability to use Device Configuration files, eliminating need to
+  change code to add devices to protocols we already support.
+- Add Youou Wand support
+
+## Bugfixes
+
+- Fixed lots of unhandled promises, turning them into exception
+  throws. Also now have a linter rule to make sure this doesn't happen
+  again.
+
+## Other
+
+- Moved CI to Azure Pipelines
+- Moved project to being a monorepo for all buttplug-js core library,
+  device subtype manager, connector, and server CLI projects
+- Removed Devtools package for time being, needs to be turned into its
+  own module.
+- Not currently building CLIs for windows, because noble-uwp was
+  having some problems compiling.
+- Removed ConnectLocal/ConnectWebsocket functions from Client, now
+  requires a connector object.
+
+# Version 0.10.0 - 2018/12/03
+
+- Add way to pass loggers into DeviceSubtypeManagers (to bridge module scope issues)
+- Fix type error for Device Manager message callbacks
+
+# Version 0.9.0 - 2018/12/02
+
+- Move core/Device to client/ButtplugClientDevice, since only client uses it.
+- Create convenience Device command functions on ButtplugClientDevice.
+- Add specific Buttplug exception types.
+- Fix up error handling to always throw exceptions.
+- Add connection semantics to server.
+- Update dependencies.
+
+# Version 0.8.3 - 2018/11/24
+
+- Added Lovense Osci support
+- Updated schema with bugfixes to generic commands
+
+# Version 0.8.2 - 2018/07/12
+
+- Add Vorze UFO SA support
+
+# Version 0.8.1 - 2018/07/02
+
+- Make DevTools/Simulator loadable as a module
+- Fix bug in characteristic map calculation (caused Fleshlight Launch to stop working on 0.8.0)
+- Fix output of speed/position values in Simulator
+- Fix bug in DeviceList message construction in Server
+- Various other Simulator fixes.
+
+# Version 0.8.0 - 2018/06/27
+
+- Add BLE GATT Characteristic reading functions
+- Add ability to derive Lovense hardware info from device queries (no more name/UUID chasing)
+- Namespace devtools CSS rules to fix issue with CSS conflicts in devtools
+- Change Signature of CreateSimple*Message functions (breaking change)
+- Add IsScanning boolean getter to Client
+
+# Version 0.7.1 - 2018/05/02
+
+- Extra build config changes to fix webpack issues
+
+# Version 0.7.0 - 2018/05/02
+
+- Rolling version number due to device API change (added "Disconnect" method)
+- Update to Webpack 4
+- Fix server cleanup on shutdown (remove listeners, disconnect devices)
+- Add more Lovense device names/info
+
+# Version 0.6.1 - 2018/03/08
+
+- Expose feature counts of device command messages
+- Add CreateSimple*Cmd functions
+- Add new Lovense and WeVibe device names
+- Device counts now start at 0 instead of 1
+
+# Version 0.6.0 - 2018/02/05
+
+- Rolling version number due to devtools API change
+- TestDeviceManager no longer a singleton. That was a bad idea in the first place.
+- TestDeviceManagerPanel now requires a ButtplugServer as a parameter
+- Added Connector getter in ButtplugClient, as sometimes it's handy to pull an embedded connector
+  and get the Server from it (For things like the TestDeviceManagerPanel).
+- Devices now have internal IDs, so deviceadded isn't fired multiple times for the same device
+- Added basic MaxPro Smart Vibrator support
+
+# Version 0.5.3 - 2018/01/29
+
+- Fix bug in devtools web exports
+- Add more styles to log panel so outside styles don't affect it.
+
+# Version 0.5.2 - 2018/01/26
+
+- Fix webpack settings so mangling doesn't destroy parser
+- Add new IDs for Lovense Domi and Lush
+
+# Version 0.5.1 - 2018/01/23
+
+- Remove node websocket connector and server, since it doesn't build/include nicely as a submodule. (#87)
+
+# Version 0.5.0 - 2018/01/22
+
+- Added Buttplug Spec v1 implementation
+  - More generic message types (VibrateCmd, RotateCmd, LinearCmd)
+  - Message attributes (device feature counts)
+  - Message downgrading capabilities
+- Added tests. So many tests.
+- Divided devtools into core and web directories
+- Updated devtools to depend on buttplug as an external library (makes file sizes smaller)
+- Library now uses es6 by default
+- Lots of bug fixes due to aforementioned tests (Wevibe control issues, missing error message, etc...)
+
+# Version 0.4.3 - 2018/01/16
+
+- Fix many logging bugs
+- Add more log messages to library
+- Add devtools module, with log viewer, test device manager, and device visualizer
+- Add Node websocket connector and server, for native server capabilities
+
+# Version 0.4.2 - 2018/01/08
+
+- Added support for new Lovense devices (Domi with new firmware)
+
+# Version 0.4.1 - 2018/01/07
+
+- Message types can now be accessed via getter ([Message].Type)
+- Client now emits "disconnect" event on disconnection (either user or server triggered)
+- Fixed bug where ping timer wouldn't stop on disconnect
+- Moved test system to jest
+- Removed dependency on text-encoding package
+- Added support for new Lovense devices (Hush with new firmware)
+
+# Version 0.4.0 - 2017/12/03
+
+- Add webpack config to build library for web on release
+- Expose IButtplugConnector for building external connector interfaces
+- Actually write usage information in the README
+
+# Version 0.3.2 - 2017/12/02
+
+- Remove dist from .gitignore in release branch. Again. Ugh.
+
+# Version 0.3.1 - 2017/12/02
+
+- Create generic connect function to allow users to define their own connectors
+- Documentation updates
+- Added more WeVibe names
+
+# Version 0.3.0 - 2017/10/29
+
+- Remove all default exports, require verbose include
+- Prepare library for use with node servers as well as web browser servers
+
+# Version 0.2.2 - 2017/10/28
+
+- Fix emission of "scanningfinished" event and message in client/server
+
+# Version 0.2.1 - 2017/10/11
+
+- Added WebBluetooth support for the Vorze A10 Cyclone 
+- Fixed types in VorzeA10CycloneCmd message
+
+# Version 0.2.0 - 2017/10/08
+
+- Simplified Client types. Now one client type with Websocket and Local connection functions.
+- Fixed bug where outbound messages were not checked against the message schema.
+
+# Version 0.1.1 - 2017/10/06
+
+- Add Lovense Domi, WeVibe toy support to server
+- Add ability to query for browser Bluetooth Support in server
+
+# Version 0.1.0 - 2017/08/20
+
+- Added Server functionality, with WebBluetooth device manager
+- Added logging system
+- Fixed KiirooCmd format
+
+# Version 0.0.9 - 2017/07/22
+
+- Start cleaning up library to prepare for Server implementation
+- Add VorzeA10CycloneCmd message
+
+# Version 0.0.8 - 2017/07/21
+
+- Add JSON schema validation
+
+# Version 0.0.7 - 2017/07/19
+
+- Add StopAllDevices function to client
+
+# Version 0.0.6 - 2017/07/16
+
+- Update of v0.0.5 with built files included
+
+# Version 0.0.5 - 2017/07/16
+
+- Add client disconnect functionality
+- Test updates
+
+# Version 0.0.4 - 2017/07/13
+
+- Add ErrorCode support to error messages
+- tslint addition and cleanup
+
+# Version 0.0.3 - 2017/06/13
+
+- Repo cleanup, typescript library additions
+
+# Version 0.0.2 - 2017/06/11
+
+- First released version of library
+- Core device/message implementation
+- Simple webclient with ability to connect over websockets, get device lists, send device messages
+
+# Version 0.0.1 - 2016/07/08
+
+- Project Repo Started

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).