@iotize/device-com-ble.cordova 3.7.2 → 4.0.0-alpha.2

package/{lib → src/lib}/cordova-service-adapter.d.ts

@@ -1,58 +1,58 @@
-import { ConnectionState } from "@iotize/tap/protocol/api";
-import { CharacteristicAdapterInterface, PeripheralAdapterInterface, ServiceAdapterInterface, DescriptorAdapterInterface, CharacteristicProperties } from "@iotize/tap/protocol/ble/common";
-import { Observable } from "rxjs";
-import { CharacteristicDescription, DescriptorDescription, ServiceDescription } from "./definitions";
-import { IoTizeBleCordovaPlugin } from "./iotize-ble-cordova-plugin";
-export declare class CordovaPeripheralAdapter implements PeripheralAdapterInterface<CordovaServiceAdapter> {
-    readonly deviceId: string;
-    readonly cordovaPlugin: IoTizeBleCordovaPlugin;
-    private _stateChange;
-    private connectionStateSubscription?;
-    private serviceListCache?;
-    get stateChange(): Observable<ConnectionState>;
-    get name(): string;
-    get id(): string;
-    constructor(deviceId: string, cordovaPlugin?: IoTizeBleCordovaPlugin);
-    get state(): string;
-    discoverServices<Key extends string = string>(serviceUUIDs?: Key[]): Promise<Partial<Record<Key, CordovaServiceAdapter>>>;
-    connect(): Promise<void>;
-    disconnect(): Promise<void>;
-    close(): Promise<void>;
-    getService(uuid: string): Promise<CordovaServiceAdapter>;
-}
-export declare class CordovaServiceAdapter implements ServiceAdapterInterface {
-    private readonly config;
-    readonly peripheral: CordovaPeripheralAdapter;
-    get uuid(): string;
-    constructor(config: ServiceDescription, peripheral: CordovaPeripheralAdapter);
-    getCharacteristic(charcUUID: string): Promise<CordovaCharacteristicAdapter>;
-    getCharacteristics(): Promise<CordovaCharacteristicAdapter[]>;
-}
-export declare class CordovaCharacteristicAdapter implements CharacteristicAdapterInterface {
-    readonly service: CordovaServiceAdapter;
-    readonly config: CharacteristicDescription;
-    private _dataStream?;
-    get uuid(): string;
-    constructor(service: CordovaServiceAdapter, config: CharacteristicDescription);
-    get properties(): CharacteristicProperties;
-    get data(): Observable<{
-        data: Uint8Array;
-        isNotification: boolean;
-    }>;
-    protected get deviceId(): string;
-    protected get pluginInterface(): IoTizeBleCordovaPlugin;
-    read(): Promise<Uint8Array>;
-    getDescriptor(): Promise<CordovaDescriptorAdapter>;
-    getDescriptors(): Promise<DescriptorAdapterInterface[]>;
-    write(data: Uint8Array, writeWithoutResponse: boolean): Promise<Uint8Array>;
-    enableNotifications(enabled?: boolean): Promise<void>;
-    setupDataStreamIfRequired(): Observable<Uint8Array>;
-}
-export declare class CordovaDescriptorAdapter implements DescriptorAdapterInterface {
-    readonly config: DescriptorDescription;
-    readonly characteristic: CordovaCharacteristicAdapter;
-    get uuid(): string;
-    constructor(config: DescriptorDescription, characteristic: CordovaCharacteristicAdapter);
-    readValue(): Promise<Uint8Array>;
-    writeValue(data: Uint8Array): Promise<void>;
-}
+import { ConnectionState } from '@iotize/tap/protocol/api';
+import { CharacteristicAdapterInterface, PeripheralAdapterInterface, ServiceAdapterInterface, DescriptorAdapterInterface, CharacteristicProperties } from '@iotize/tap/protocol/ble/common';
+import { Observable } from 'rxjs';
+import { CharacteristicDescription, DescriptorDescription, ServiceDescription } from './definitions';
+import { IoTizeBleCordovaPlugin } from './iotize-ble-cordova-plugin';
+export declare class CordovaPeripheralAdapter implements PeripheralAdapterInterface<CordovaServiceAdapter> {
+    readonly deviceId: string;
+    readonly cordovaPlugin: IoTizeBleCordovaPlugin;
+    private _stateChange;
+    private connectionStateSubscription?;
+    private serviceListCache?;
+    get stateChange(): Observable<ConnectionState>;
+    get name(): string;
+    get id(): string;
+    constructor(deviceId: string, cordovaPlugin?: IoTizeBleCordovaPlugin);
+    get state(): string;
+    discoverServices<Key extends string = string>(serviceUUIDs?: Key[]): Promise<Partial<Record<Key, CordovaServiceAdapter>>>;
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    close(): Promise<void>;
+    getService(uuid: string): Promise<CordovaServiceAdapter>;
+}
+export declare class CordovaServiceAdapter implements ServiceAdapterInterface {
+    private readonly config;
+    readonly peripheral: CordovaPeripheralAdapter;
+    get uuid(): string;
+    constructor(config: ServiceDescription, peripheral: CordovaPeripheralAdapter);
+    getCharacteristic(charcUUID: string): Promise<CordovaCharacteristicAdapter>;
+    getCharacteristics(): Promise<CordovaCharacteristicAdapter[]>;
+}
+export declare class CordovaCharacteristicAdapter implements CharacteristicAdapterInterface {
+    readonly service: CordovaServiceAdapter;
+    readonly config: CharacteristicDescription;
+    private _dataStream?;
+    get uuid(): string;
+    constructor(service: CordovaServiceAdapter, config: CharacteristicDescription);
+    get properties(): CharacteristicProperties;
+    get data(): Observable<{
+        data: Uint8Array;
+        isNotification: boolean;
+    }>;
+    protected get deviceId(): string;
+    protected get pluginInterface(): IoTizeBleCordovaPlugin;
+    read(): Promise<Uint8Array>;
+    getDescriptor(): Promise<CordovaDescriptorAdapter>;
+    getDescriptors(): Promise<DescriptorAdapterInterface[]>;
+    write(data: Uint8Array, writeWithoutResponse: boolean): Promise<Uint8Array>;
+    enableNotifications(enabled?: boolean): Promise<void>;
+    setupDataStreamIfRequired(): Observable<Uint8Array<ArrayBuffer>>;
+}
+export declare class CordovaDescriptorAdapter implements DescriptorAdapterInterface {
+    readonly config: DescriptorDescription;
+    readonly characteristic: CordovaCharacteristicAdapter;
+    get uuid(): string;
+    constructor(config: DescriptorDescription, characteristic: CordovaCharacteristicAdapter);
+    readValue(): Promise<Uint8Array>;
+    writeValue(data: Uint8Array): Promise<void>;
+}

package/{lib → src/lib}/definitions.d.ts

@@ -1,43 +1,43 @@
-import { CharacteristicProperties } from '@iotize/tap/protocol/ble/common';
-export interface CordovaBLEScanResult {
-    name: string;
-    address: string;
-    rssi?: number;
-    txPower?: number;
-    scanRecord?: number[];
-}
-/**
- * @deprecated
- * use CordovaBLEScanResult instead
- */
-export declare type DiscoveredDeviceType = CordovaBLEScanResult;
-export interface RequestDeviceOptions {
-    filters: BluetoothLEScanFilter[];
-    optionalServices?: BluetoothServiceUUID[] | undefined;
-    optionalManufacturerData?: number[] | undefined;
-}
-interface BluetoothLEScanFilter {
-    readonly services?: BluetoothServiceUUID[] | undefined;
-}
-declare type BluetoothServiceUUID = string;
-declare type BluetoothCharacteristicUUID = string;
-declare type BluetoothDescriptorUUID = string;
-export interface ServiceDescription {
-    uuid: BluetoothServiceUUID;
-    characteristics?: CharacteristicList;
-    [key: string]: any;
-}
-export declare type ServiceList = ServiceDescription[];
-export interface CharacteristicDescription {
-    uuid: BluetoothCharacteristicUUID;
-    descriptors?: DescriptorList;
-    properties: CharacteristicProperties;
-    [key: string]: any;
-}
-export declare type CharacteristicList = CharacteristicDescription[];
-export interface DescriptorDescription {
-    uuid: BluetoothDescriptorUUID;
-    [key: string]: any;
-}
-export declare type DescriptorList = DescriptorDescription[];
-export {};
+import { CharacteristicProperties } from '@iotize/tap/protocol/ble/common';
+export interface CordovaBLEScanResult {
+    name: string;
+    address: string;
+    rssi?: number;
+    txPower?: number;
+    scanRecord?: number[];
+}
+/**
+ * @deprecated
+ * use CordovaBLEScanResult instead
+ */
+export type DiscoveredDeviceType = CordovaBLEScanResult;
+export interface RequestDeviceOptions {
+    filters: BluetoothLEScanFilter[];
+    optionalServices?: BluetoothServiceUUID[] | undefined;
+    optionalManufacturerData?: number[] | undefined;
+}
+interface BluetoothLEScanFilter {
+    readonly services?: BluetoothServiceUUID[] | undefined;
+}
+type BluetoothServiceUUID = string;
+type BluetoothCharacteristicUUID = string;
+type BluetoothDescriptorUUID = string;
+export interface ServiceDescription {
+    uuid: BluetoothServiceUUID;
+    characteristics?: CharacteristicList;
+    [key: string]: any;
+}
+export type ServiceList = ServiceDescription[];
+export interface CharacteristicDescription {
+    uuid: BluetoothCharacteristicUUID;
+    descriptors?: DescriptorList;
+    properties: CharacteristicProperties;
+    [key: string]: any;
+}
+export type CharacteristicList = CharacteristicDescription[];
+export interface DescriptorDescription {
+    uuid: BluetoothDescriptorUUID;
+    [key: string]: any;
+}
+export type DescriptorList = DescriptorDescription[];
+export {};

package/{lib → src/lib}/iotize-ble-cordova-plugin.d.ts

@@ -1,27 +1,27 @@
-import { ConnectionState } from "@iotize/tap/protocol/api";
-import { Observable } from "rxjs";
-import { CordovaBLEScanResult, RequestDeviceOptions, ServiceList } from "./definitions";
-export declare class IoTizeBleCordovaPlugin {
-    checkAvailable(): Promise<boolean>;
-    requestEnableBle(): Promise<"OK">;
-    startScan(requestDeviceOptions: RequestDeviceOptions | undefined): Observable<CordovaBLEScanResult | "Ok">;
-    stopScan(): Promise<"OK">;
-    connect(deviceId: string, enableBleIfNot?: boolean): Observable<ConnectionState>;
-    askBleEnable(askEnable: boolean): Observable<void>;
-    requestMTU(deviceId: string, mtu: number): Promise<"OK">;
-    connectAndDiscoverTapServices(deviceId: string, enableBleIfNot?: boolean): Observable<ConnectionState>;
-    disConnect(deviceId: string): Promise<"OK">;
-    close(deviceId: string): Promise<"OK">;
-    isConnected(deviceId: string): Promise<boolean>;
-    send(deviceId: string, data: Uint8Array): Promise<Uint8Array>;
-    getLastError(): Promise<string>;
-    characteristicStartNotification(deviceId: string, serviceId: string, characId: string): Promise<"OK">;
-    characteristicChanged(deviceId: string, serviceId: string, characId: string): Observable<Uint8Array>;
-    characteristicStopNotification(deviceId: string, serviceId: string, characId: string): Promise<"OK">;
-    characteristicReadValue(deviceId: string, serviceId: string, characId: string): Promise<Uint8Array>;
-    characteristicWrite(deviceId: string, serviceId: string, characId: string, data: Uint8Array): Promise<"OK">;
-    characteristicWriteWithoutResponse(deviceId: string, serviceId: string, characId: string, data: Uint8Array): Promise<"OK">;
-    discoverServices(deviceId: string): Promise<ServiceList>;
-    private execSingleResult;
-    private execMultipleResult;
-}
+import { ConnectionState } from '@iotize/tap/protocol/api';
+import { Observable } from 'rxjs';
+import { CordovaBLEScanResult, RequestDeviceOptions, ServiceList } from './definitions';
+export declare class IoTizeBleCordovaPlugin {
+    checkAvailable(): Promise<boolean>;
+    requestEnableBle(): Promise<'OK'>;
+    startScan(requestDeviceOptions: RequestDeviceOptions | undefined): Observable<CordovaBLEScanResult | 'Ok'>;
+    stopScan(): Promise<"OK">;
+    connect(deviceId: string, enableBleIfNot?: boolean): Observable<ConnectionState>;
+    askBleEnable(askEnable: boolean): Observable<void>;
+    requestMTU(deviceId: string, mtu: number): Promise<"OK">;
+    connectAndDiscoverTapServices(deviceId: string, enableBleIfNot?: boolean): Observable<ConnectionState>;
+    disConnect(deviceId: string): Promise<"OK">;
+    close(deviceId: string): Promise<"OK">;
+    isConnected(deviceId: string): Promise<boolean>;
+    send(deviceId: string, data: Uint8Array): Promise<Uint8Array<ArrayBuffer>>;
+    getLastError(): Promise<string>;
+    characteristicStartNotification(deviceId: string, serviceId: string, characId: string): Promise<"OK">;
+    characteristicChanged(deviceId: string, serviceId: string, characId: string): Observable<Uint8Array>;
+    characteristicStopNotification(deviceId: string, serviceId: string, characId: string): Promise<"OK">;
+    characteristicReadValue(deviceId: string, serviceId: string, characId: string): Promise<Uint8Array>;
+    characteristicWrite(deviceId: string, serviceId: string, characId: string, data: Uint8Array): Promise<"OK">;
+    characteristicWriteWithoutResponse(deviceId: string, serviceId: string, characId: string, data: Uint8Array): Promise<"OK">;
+    discoverServices(deviceId: string): Promise<ServiceList>;
+    private execSingleResult;
+    private execMultipleResult;
+}

package/src/lib/logger.d.ts

@@ -0,0 +1,2 @@
+import { createDebugger } from '@iotize/common/debug';
+export declare const debug: createDebugger.Debugger;

package/{lib → src/lib}/scanner.d.ts

@@ -1,55 +1,55 @@
-import { DeviceScanner, DeviceScannerOptions } from "@iotize/tap/scanner/api";
-import { Observable } from "rxjs";
-import { CordovaBLEScanResult, RequestDeviceOptions } from "./definitions";
-import { IoTizeBleCordovaPlugin } from "./iotize-ble-cordova-plugin";
-/**
- * BLE Tap scanner for cordova apps
- */
-export declare class BLEScanner implements DeviceScanner<CordovaBLEScanResult> {
-    private cordovaInterfaceOverwrite?;
-    /**
-     * Request device options used to filter scan results
-     */
-    readonly requestDeviceOptions?: RequestDeviceOptions | undefined;
-    private _results;
-    private _scanning$;
-    private scanSubscription?;
-    /**
-     * Lazy reference to iotizeBLE.
-     * We don't want to reference iotizeBLE in constructor as it may be referenced
-     * before cordova plugin is loaded
-     */
-    private get cordovaInterface();
-    /**
-     *
-     * @param cordovaInterfaceOverwrite overwrite cordova interface. Used for testing
-     */
-    constructor(cordovaInterfaceOverwrite?: IoTizeBleCordovaPlugin | undefined, 
-    /**
-     * Request device options used to filter scan results
-     */
-    requestDeviceOptions?: RequestDeviceOptions | undefined);
-    get scanning(): Observable<boolean>;
-    get isScanning(): boolean;
-    /**
-     * Gets the observable on the devices$ Subject
-     * @return
-     */
-    get results(): Observable<CordovaBLEScanResult[]>;
-    /**
-     * Launches the scan for BLE devices
-     * Throws if BLE is not available
-     */
-    start(options?: DeviceScannerOptions): Promise<void>;
-    /**
-     *
-     */
-    stop(): Promise<void>;
-    /**
-     * Returns true if this scanner is available
-     */
-    checkAvailable(): Promise<boolean>;
-    private get devices();
-    private clearResults;
-    private addOrRefreshDevice;
-}
+import type { DeviceScanner, DeviceScannerOptions } from '@iotize/tap/scanner/api';
+import { Observable } from 'rxjs';
+import { CordovaBLEScanResult, RequestDeviceOptions } from './definitions';
+import { IoTizeBleCordovaPlugin } from './iotize-ble-cordova-plugin';
+/**
+ * BLE Tap scanner for cordova apps
+ */
+export declare class BLEScanner implements DeviceScanner<CordovaBLEScanResult> {
+    private cordovaInterfaceOverwrite?;
+    /**
+     * Request device options used to filter scan results
+     */
+    readonly requestDeviceOptions?: RequestDeviceOptions | undefined;
+    private _results;
+    private _scanning$;
+    private scanSubscription?;
+    /**
+     * Lazy reference to iotizeBLE.
+     * We don't want to reference iotizeBLE in constructor as it may be referenced
+     * before cordova plugin is loaded
+     */
+    private get cordovaInterface();
+    /**
+     *
+     * @param cordovaInterfaceOverwrite overwrite cordova interface. Used for testing
+     */
+    constructor(cordovaInterfaceOverwrite?: IoTizeBleCordovaPlugin | undefined, 
+    /**
+     * Request device options used to filter scan results
+     */
+    requestDeviceOptions?: RequestDeviceOptions | undefined);
+    get scanning(): Observable<boolean>;
+    get isScanning(): boolean;
+    /**
+     * Gets the observable on the devices$ Subject
+     * @return
+     */
+    get results(): Observable<CordovaBLEScanResult[]>;
+    /**
+     * Launches the scan for BLE devices
+     * Throws if BLE is not available
+     */
+    start(options?: DeviceScannerOptions): Promise<void>;
+    /**
+     *
+     */
+    stop(): Promise<void>;
+    /**
+     * Returns true if this scanner is available
+     */
+    checkAvailable(): Promise<boolean>;
+    private get devices();
+    private clearResults;
+    private addOrRefreshDevice;
+}

package/{lib → src/lib}/utility.d.ts

@@ -1,6 +1,6 @@
-import { IoTizeBleCordovaPlugin } from "./iotize-ble-cordova-plugin";
-export declare function getIoTizeBleCordovaPlugin(): IoTizeBleCordovaPlugin;
-export declare function getScanRecordsFromBytes(bytes: Uint8Array): {
-    type: number;
-    data: Uint8Array;
-}[];
+import { IoTizeBleCordovaPlugin } from './iotize-ble-cordova-plugin';
+export declare function getIoTizeBleCordovaPlugin(): IoTizeBleCordovaPlugin;
+export declare function getScanRecordsFromBytes(bytes: Uint8Array): {
+    type: number;
+    data: Uint8Array;
+}[];

package/src/plugin.d.ts

@@ -0,0 +1,8 @@
+export { BLEComProtocol } from './lib/ble-com-protocol';
+export { CordovaCharacteristicAdapter, CordovaPeripheralAdapter, CordovaServiceAdapter, } from './lib/cordova-service-adapter';
+export * from './lib/definitions';
+export { BLEScanner } from './lib/scanner';
+export { getIoTizeBleCordovaPlugin, getScanRecordsFromBytes, } from './lib/utility';
+import { IoTizeBleCordovaPlugin } from './lib/iotize-ble-cordova-plugin';
+export { IoTizeBleCordovaPlugin };
+export declare const iotizeBLE: IoTizeBleCordovaPlugin;

package/src/windows/iotize-ble-com.js

@@ -30,10 +30,10 @@ function handleConnectionErrorCallback() {
   }
 }
 
-cordova.commandProxy.add("BLECom", {
+cordova.commandProxy.add('BLECom', {
   getLastError: function (successCallback, errorCallback) {
     if (!checkProxy()) {
-      errorCallback("Internal Error!");
+      errorCallback('Internal Error!');
       return;
     }
 
@@ -42,7 +42,7 @@ cordova.commandProxy.add("BLECom", {
 
   startScan: function (successCallback, errorCallback) {
     if (!checkProxy()) {
-      errorCallback("Internal Error!");
+      errorCallback('Internal Error!');
       return;
     }
 
@@ -56,13 +56,13 @@ cordova.commandProxy.add("BLECom", {
 
   stopScan: function (successCallback, errorCallback) {
     if (!checkProxy()) {
-      errorCallback("Internal Error!");
+      errorCallback('Internal Error!');
       return;
     }
 
     var res = iotizeProxy.stopScan();
     if (res == true) {
-      successCallback("Ok");
+      successCallback('Ok');
     } else {
       errorCallback(iotizeProxy.getLastError());
     }
@@ -70,7 +70,7 @@ cordova.commandProxy.add("BLECom", {
 
   connect: async function (successCallback, errorCallback, device) {
     if (!checkProxy()) {
-      errorCallback("Internal Error!");
+      errorCallback('Internal Error!');
       return;
     }
 
@@ -87,7 +87,7 @@ cordova.commandProxy.add("BLECom", {
     }
 
     if (success) {
-      successCallback("Ok");
+      successCallback('Ok');
     } else {
       handleConnectionErrorCallback();
     }
@@ -95,7 +95,7 @@ cordova.commandProxy.add("BLECom", {
 
   disConnect: async function (successCallback, errorCallback, device) {
     if (!checkProxy()) {
-      errorCallback("Internal Error!");
+      errorCallback('Internal Error!');
       return;
     }
     var success = false;
@@ -106,7 +106,7 @@ cordova.commandProxy.add("BLECom", {
     }
 
     if (success) {
-      successCallback("Ok");
+      successCallback('Ok');
     } else {
       errorCallback(iotizeProxy.getLastError());
     }
@@ -114,7 +114,7 @@ cordova.commandProxy.add("BLECom", {
 
   isConnected: async function (successCallback, errorCallback, device) {
     if (!checkProxy()) {
-      errorCallback("Internal Error!");
+      errorCallback('Internal Error!');
       return;
     }
     var success = false;
@@ -145,7 +145,7 @@ cordova.commandProxy.add("BLECom", {
 
   sendRequest: async function (successCallback, errorCallback, request) {
     if (!checkProxy()) {
-      errorCallback("Internal Error!");
+      errorCallback('Internal Error!');
       return;
     }
 

package/LICENSE

@@ -1,23 +0,0 @@
-Copyright 2018 IoTize SAS
-http://iotize.com
-
-MIT License
-
-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.