@microbit/microbit-connection 0.9.0-apps.alpha.15 → 0.9.0-apps.alpha.17

package/build/cjs/async-util.js.map

@@ -1 +1 @@
-{"version":3,"file":"async-util.js","sourceRoot":"","sources":["../../lib/async-util.ts"],"names":[],"mappings":";;;AAkBA,kCAQC;AAED,sBAEC;AAED,8CAMC;AAED,0DAMC;AA9CD;;;;GAIG;AACH,MAAa,YAAa,SAAQ,KAAK;CAAG;AAA1C,oCAA0C;AAE1C,MAAa,eAAgB,SAAQ,KAAK;IACxC,YAAY,UAAkB,YAAY;QACxC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;CACF;AAJD,0CAIC;AAED;;;;GAIG;AACI,KAAK,UAAU,WAAW,CAC/B,aAAyB,EACzB,OAAe;IAEf,OAAO,OAAO,CAAC,IAAI,CAAC;QAClB,aAAa;QACb,iBAAiB,CAAC,OAAO,CAAC;KAC3B,CAAe,CAAC;AACnB,CAAC;AAEM,KAAK,UAAU,KAAK,CAAC,MAAc;IACxC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AAC/D,CAAC;AAEM,KAAK,UAAU,iBAAiB,CACrC,MAAc,EACd,UAAkB,SAAS;IAE3B,MAAM,KAAK,CAAC,MAAM,CAAC,CAAC;IACpB,MAAM,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;AAClC,CAAC;AAED,SAAgB,uBAAuB,CAAI,UAAkB,YAAY;IACvE,IAAI,QAAgC,CAAC;IACrC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAI,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;QAC3C,QAAQ,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IACH,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAS,EAAE,CAAC;AAC1C,CAAC"}
+{"version":3,"file":"async-util.js","sourceRoot":"","sources":["../../src/async-util.ts"],"names":[],"mappings":";;;AAkBA,kCAQC;AAED,sBAEC;AAED,8CAMC;AAED,0DAMC;AA9CD;;;;GAIG;AACH,MAAa,YAAa,SAAQ,KAAK;CAAG;AAA1C,oCAA0C;AAE1C,MAAa,eAAgB,SAAQ,KAAK;IACxC,YAAY,UAAkB,YAAY;QACxC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;CACF;AAJD,0CAIC;AAED;;;;GAIG;AACI,KAAK,UAAU,WAAW,CAC/B,aAAyB,EACzB,OAAe;IAEf,OAAO,OAAO,CAAC,IAAI,CAAC;QAClB,aAAa;QACb,iBAAiB,CAAC,OAAO,CAAC;KAC3B,CAAe,CAAC;AACnB,CAAC;AAEM,KAAK,UAAU,KAAK,CAAC,MAAc;IACxC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AAC/D,CAAC;AAEM,KAAK,UAAU,iBAAiB,CACrC,MAAc,EACd,UAAkB,SAAS;IAE3B,MAAM,KAAK,CAAC,MAAM,CAAC,CAAC;IACpB,MAAM,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;AAClC,CAAC;AAED,SAAgB,uBAAuB,CAAI,UAAkB,YAAY;IACvE,IAAI,QAAgC,CAAC;IACrC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAI,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;QAC3C,QAAQ,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IACH,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAS,EAAE,CAAC;AAC1C,CAAC"}

package/build/cjs/async-util.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/cjs/async-util.test.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+const vitest_1 = require("vitest");
+const async_util_js_1 = require("./async-util.js");
+(0, vitest_1.describe)("withTimeout", () => {
+    (0, vitest_1.it)("times out", async () => {
+        const neverResolves = new Promise(() => { });
+        await (0, vitest_1.expect)(() => (0, async_util_js_1.withTimeout)(neverResolves, 0)).rejects.toThrowError(async_util_js_1.TimeoutError);
+    });
+    (0, vitest_1.it)("returns the value", async () => {
+        const resolvesWithValue = async () => "foo";
+        (0, vitest_1.expect)(await (0, async_util_js_1.withTimeout)(resolvesWithValue(), 10)).toEqual("foo");
+    });
+});
+//# sourceMappingURL=async-util.test.js.map

package/build/cjs/async-util.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-util.test.js","sourceRoot":"","sources":["../../src/async-util.test.ts"],"names":[],"mappings":";;AAAA;;;;GAIG;AACH,mCAA8C;AAC9C,mDAA4D;AAE5D,IAAA,iBAAQ,EAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,IAAA,WAAE,EAAC,WAAW,EAAE,KAAK,IAAI,EAAE;QACzB,MAAM,aAAa,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAC5C,MAAM,IAAA,eAAM,EAAC,GAAG,EAAE,CAAC,IAAA,2BAAW,EAAC,aAAa,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CACpE,4BAAY,CACb,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,IAAA,WAAE,EAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;QACjC,MAAM,iBAAiB,GAAG,KAAK,IAAI,EAAE,CAAC,KAAK,CAAC;QAC5C,IAAA,eAAM,EAAC,MAAM,IAAA,2BAAW,EAAC,iBAAiB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/build/cjs/availability.js.map

@@ -1 +1 @@
-{"version":3,"file":"availability.js","sourceRoot":"","sources":["../../lib/availability.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,2CAAwE;AAExE;;;;;;GAMG;AACI,MAAM,kBAAkB,GAAG,CAChC,MAAoC,EAC9B,EAAE;IACR,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,WAAW;YACd,OAAO;QACT,KAAK,aAAa;YAChB,MAAM,IAAI,uBAAW,CAAC;gBACpB,IAAI,EAAE,aAAa;gBACnB,OAAO,EAAE,+BAA+B;aACzC,CAAC,CAAC;QACL,KAAK,UAAU;YACb,MAAM,IAAI,uBAAW,CAAC;gBACpB,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,wBAAwB;aAClC,CAAC,CAAC;QACL,KAAK,mBAAmB;YACtB,MAAM,IAAI,uBAAW,CAAC;gBACpB,IAAI,EAAE,mBAAmB;gBACzB,OAAO,EAAE,mBAAmB;aAC7B,CAAC,CAAC;QACL,KAAK,mBAAmB;YACtB,MAAM,IAAI,uBAAW,CAAC;gBACpB,IAAI,EAAE,mBAAmB;gBACzB,OAAO,EAAE,4BAA4B;aACtC,CAAC,CAAC;IACP,CAAC;AACH,CAAC,CAAC;AA3BW,QAAA,kBAAkB,sBA2B7B"}
+{"version":3,"file":"availability.js","sourceRoot":"","sources":["../../src/availability.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,2CAAwE;AAExE;;;;;;GAMG;AACI,MAAM,kBAAkB,GAAG,CAChC,MAAoC,EAC9B,EAAE;IACR,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,WAAW;YACd,OAAO;QACT,KAAK,aAAa;YAChB,MAAM,IAAI,uBAAW,CAAC;gBACpB,IAAI,EAAE,aAAa;gBACnB,OAAO,EAAE,+BAA+B;aACzC,CAAC,CAAC;QACL,KAAK,UAAU;YACb,MAAM,IAAI,uBAAW,CAAC;gBACpB,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,wBAAwB;aAClC,CAAC,CAAC;QACL,KAAK,mBAAmB;YACtB,MAAM,IAAI,uBAAW,CAAC;gBACpB,IAAI,EAAE,mBAAmB;gBACzB,OAAO,EAAE,mBAAmB;aAC7B,CAAC,CAAC;QACL,KAAK,mBAAmB;YACtB,MAAM,IAAI,uBAAW,CAAC;gBACpB,IAAI,EAAE,mBAAmB;gBACzB,OAAO,EAAE,4BAA4B;aACtC,CAAC,CAAC;IACP,CAAC;AACH,CAAC,CAAC;AA3BW,QAAA,kBAAkB,sBA2B7B"}

package/build/{esm/bluetooth.d.ts → cjs/bluetooth/connection.d.ts}

@@ -1,15 +1,12 @@
-import { AccelerometerData } from "./accelerometer.js";
-import { DeviceConnection, FlashDataSource, FlashOptions } from "./device.js";
-import { LedMatrix } from "./led.js";
-import { Logging } from "./logging.js";
-import { MagnetometerData } from "./magnetometer.js";
-import { ServiceConnectionEventMap } from "./service-events.js";
+import { DeviceConnection, FlashDataSource, FlashOptions } from "../device.js";
+import { Logging } from "../logging.js";
+import { AccelerometerData, LedMatrix, MagnetometerData, ServiceConnectionEventMap } from "../service-events.js";
 import { DeviceBondState } from "./device-bond-state.js";
-export interface MicrobitWebBluetoothConnectionOptions {
+export interface MicrobitBluetoothConnectionOptions {
     logging?: Logging;
     deviceBondState?: DeviceBondState;
 }
-export interface MicrobitWebBluetoothConnection extends DeviceConnection<ServiceConnectionEventMap> {
+export interface MicrobitBluetoothConnection extends DeviceConnection<ServiceConnectionEventMap> {
     /**
      * Sets micro:bit name filter for device requesting.
      *
@@ -19,96 +16,103 @@ export interface MicrobitWebBluetoothConnection extends DeviceConnection<Service
     /**
      * Gets micro:bit accelerometer data.
      *
-     * @returns accelerometer data or undefined if there is no connection.
+     * @returns accelerometer data.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
      */
-    getAccelerometerData(): Promise<AccelerometerData | undefined>;
+    getAccelerometerData(): Promise<AccelerometerData>;
     /**
      * Gets micro:bit accelerometer period.
      *
-     * @returns accelerometer period or undefined if there is no connection.
+     * @returns accelerometer period.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
      */
-    getAccelerometerPeriod(): Promise<number | undefined>;
+    getAccelerometerPeriod(): Promise<number>;
     /**
      * Sets micro:bit accelerometer period.
      *
      * @param value The accelerometer period.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
      */
     setAccelerometerPeriod(value: number): Promise<void>;
     /**
      * Sets micro:bit LED text.
      *
      * @param text The text displayed on micro:bit LED.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
      */
     setLedText(text: string): Promise<void>;
     /**
      * Gets micro:bit LED scrolling delay.
      *
      * @returns LED scrolling delay in milliseconds.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
      */
-    getLedScrollingDelay(): Promise<number | undefined>;
+    getLedScrollingDelay(): Promise<number>;
     /**
      * Sets micro:bit LED scrolling delay.
      *
      * @param delayInMillis LED scrolling delay in milliseconds.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
      */
     setLedScrollingDelay(delayInMillis: number): Promise<void>;
     /**
      * Gets micro:bit LED matrix.
      *
      * @returns a boolean matrix representing the micro:bit LED display.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
      */
-    getLedMatrix(): Promise<LedMatrix | undefined>;
+    getLedMatrix(): Promise<LedMatrix>;
     /**
      * Sets micro:bit LED matrix.
      *
      * @param matrix an boolean matrix representing the micro:bit LED display.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
      */
     setLedMatrix(matrix: LedMatrix): Promise<void>;
     /**
      * Gets micro:bit magnetometer data.
      *
      * @returns magnetometer data.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
      */
-    getMagnetometerData(): Promise<MagnetometerData | undefined>;
+    getMagnetometerData(): Promise<MagnetometerData>;
     /**
      * Gets micro:bit magnetometer bearing.
      *
      * @returns magnetometer bearing.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
      */
-    getMagnetometerBearing(): Promise<number | undefined>;
+    getMagnetometerBearing(): Promise<number>;
     /**
      * Gets micro:bit magnetometer period.
      *
      * @returns magnetometer period.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
      */
-    getMagnetometerPeriod(): Promise<number | undefined>;
+    getMagnetometerPeriod(): Promise<number>;
     /**
      * Sets micro:bit magnetometer period.
      *
      * @param value magnetometer period.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
      */
     setMagnetometerPeriod(value: number): Promise<void>;
     /**
      * Triggers micro:bit magnetometer calibration.
+     *
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
      */
     triggerMagnetometerCalibration(): Promise<void>;
     /**
      * Write UART messages.
      *
      * @param data UART message.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
      */
     uartWrite(data: Uint8Array): Promise<void>;
-    /**
-     * Flash the micro:bit.
-     *
-     * @param dataSource The data to use.
-     * @param options Flash options and progress callback.
-     * @throws {DeviceError} On flash failure. The error.code property indicates the failure type.
-     * @throws {FlashDataError} If data preparation fails.
-     */
     flash(dataSource: FlashDataSource, options: FlashOptions): Promise<void>;
 }
 /**
  * A Bluetooth connection factory.
  */
-export declare const createWebBluetoothConnection: (options?: MicrobitWebBluetoothConnectionOptions) => MicrobitWebBluetoothConnection;
+export declare const createBluetoothConnection: (options?: MicrobitBluetoothConnectionOptions) => MicrobitBluetoothConnection;