Updated version to 0.0.7

Added last few missing public api documentation
Added web as the only supported platform

Author: jeroen1602

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.0.7
+
+* Added `getCharacteristics` to the bluetooth service to get all the characteristics.
+* Set target platform to web for [pub.dev](https://pub.dev/packages/flutter_web_bluetooth/) target platform list (it will still compile when used in non-native programs.)
+* Added documentation to the last few public interfaces
+
 ## 0.0.6+2
 
 * Fixed the behavior subject stream not returning the stored value causing some implementations to wait forever.

lib/src/bluetooth_characteristic_properties.dart

@@ -9,6 +9,13 @@ part of flutter_web_bluetooth;
 /// then it will throw a [NotSupportedError].
 ///
 class BluetoothCharacteristicProperties {
+  ///
+  /// A constructor for new characteristic properties.
+  ///
+  /// **This should only be done by the library or if you're testing.**
+  ///
+  /// To get an instance use [BluetoothCharacteristic.properties].
+  ///
   BluetoothCharacteristicProperties(this._properties);
 
   final WebBluetoothCharacteristicProperties _properties;

lib/src/flutter_web_bluetooth_interface.dart

@@ -7,6 +7,14 @@ part of flutter_web_bluetooth;
 /// See: [FlutterWebBluetooth].
 ///
 abstract class FlutterWebBluetoothInterface {
+  ///
+  /// An interface for [FlutterWebBluetooth] to make sure that both the
+  /// unsupported and web version have the same api.
+  ///
+  /// See: [FlutterWebBluetooth].
+  ///
+  FlutterWebBluetoothInterface();
+
   ///
   /// Get if the bluetooth api is available in this browser. This will only
   /// check if the api is in the `navigator`. Not if anything is available.

lib/src/flutter_web_bluetooth_unsupported.dart

@@ -14,8 +14,8 @@ import 'dart:typed_data';
 import 'package:flutter_web_bluetooth/js_web_bluetooth.dart';
 import 'package:meta/meta.dart';
 
-import '../web_bluetooth_logger.dart';
 import '../shared/web_behavior_subject.dart';
+import '../web_bluetooth_logger.dart';
 
 part 'bluetooth_characteristic.dart';
 
@@ -61,6 +61,12 @@ class FlutterWebBluetooth extends FlutterWebBluetoothInterface {
 
   static FlutterWebBluetooth? _instance;
 
+  ///
+  /// Get an instance of the library. There will always only be one instance.
+  ///
+  /// **Note:** this is the unsupported variant that is exposed in io builds,
+  /// check the web version where the functions actually work!
+  ///
   static FlutterWebBluetoothInterface get instance {
     return _instance ??= FlutterWebBluetooth._();
   }

lib/web/bluetooth.dart

@@ -112,6 +112,19 @@ class _NativeBluetooth {
 ///
 @visibleForTesting
 class NativeBluetooth {
+  ///
+  /// Create a new instance of [NativeBluetooth] with the default
+  /// implementations for the methods that will call the actual methods
+  /// on the navigator in the background.
+  ///
+  /// Using the constructor can be used if you want to rest the native bluetooth
+  /// implementation for testing using [setNativeBluetooth].
+  ///
+  /// Otherwise the Fake library can be used to overwrite the methods for testing
+  ///
+  @visibleForTesting
+  NativeBluetooth();
+
   ///
   /// Should return a promise (which will be converted to a future using
   /// [JSUtils.promiseToFuture]) with a [bool] if bluetooth is available on

lib/web/web_bluetooth_remote_gatt_characteristic.dart

@@ -6,7 +6,6 @@ part of js_web_bluetooth;
 ///
 /// You can get a [WebBluetoothRemoteGATTCharacteristic] from
 /// [WebBluetoothRemoteGATTService.getCharacteristic], and
-/// ignore: deprecated_member_use_from_same_package
 /// [WebBluetoothRemoteGATTService.getCharacteristics].
 ///
 /// See:
@@ -484,7 +483,6 @@ class WebBluetoothRemoteGATTCharacteristic {
   /// **This should only be done by the library or if you're testing.**
   ///
   /// To get an instance use [WebBluetoothRemoteGATTService.getCharacteristic],
-  /// ignore: deprecated_member_use_from_same_package
   /// and [WebBluetoothRemoteGATTService.getCharacteristics].
   ///
   WebBluetoothRemoteGATTCharacteristic.fromJSObject(

lib/web/web_bluetooth_remote_gatt_service.dart

@@ -120,7 +120,6 @@ class WebBluetoothRemoteGATTService {
   ///
   /// See:
   ///
-  /// ignore: deprecated_member_use_from_same_package
   /// - [getCharacteristics]
   ///
   /// - https://developer.mozilla.org/en-US/docs/Web/API/BluetoothRemoteGATTService/getCharacteristic
@@ -136,14 +135,12 @@ class WebBluetoothRemoteGATTService {
   }
 
   ///
-  /// ignore: deprecated_member_use_from_same_package
   /// Check to see if the [getCharacteristics] function exists on the js object.
   ///
   /// It may not exist on some browsers.
   ///
   /// See:
   ///
-  ///  ignore: deprecated_member_use_from_same_package
   /// - [getCharacteristics]
   ///
   bool hasGetCharacteristicsFunction() {

lib/web_bluetooth_logger.dart

@@ -28,7 +28,7 @@ Logger get webBluetoothLogger {
 }
 
 ///
-/// Overwrite the logger used so you can do decide where the log messages go.
+/// Overwrite the logger used so you can decide where the log messages go.
 ///
 /// If you want to go back to the default logger at a later date then just call
 /// [initWebBluetoothLogger] to overwrite the user set logger for the default one.

pubspec.yaml

@@ -1,13 +1,16 @@
 name: flutter_web_bluetooth
 description: A library to use the web bluetooth api in your web project. Will play nice if used in IO projects.
-version: 0.0.6+2
+version: 0.0.7
 homepage: https://github.com/jeroen1602/flutter_web_bluetooth/
 repository: https://github.com/jeroen1602/flutter_web_bluetooth/
 issue_tracker: https://github.com/jeroen1602/flutter_web_bluetooth/issues/
 
 environment:
   sdk: ">=2.12.0 <3.0.0"
 
+platforms:
+  web:
+
 dependencies:
   js: '>=0.6.3 <0.7.0'
   meta: '>=1.3.0 <1.8.0'