@microbit/microbit-connection 0.9.0-apps.alpha.14 → 0.9.0-apps.alpha.16

package/build/esm/usb.test.js

@@ -0,0 +1,254 @@
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * @jest-environment node
+ *
+ * Without node environment USB code fails with a buffer type check.
+ * It might be we could create a custom environment that was web but
+ * with a tweak to Buffer.
+ */
+import { ConnectionStatus } from "./device.js";
+import { applyDeviceFilters, createWebUSBConnection } from "./usb.js";
+import { beforeAll, beforeEach, expect, vi, describe, it } from "vitest";
+vi.mock("./usb-device-wrapper.js", () => ({
+    DAPWrapper: class DapWrapper {
+        constructor() {
+            Object.defineProperty(this, "startSerial", {
+                enumerable: true,
+                configurable: true,
+                writable: true,
+                value: vi.fn().mockReturnValue(Promise.resolve())
+            });
+            Object.defineProperty(this, "reconnectAsync", {
+                enumerable: true,
+                configurable: true,
+                writable: true,
+                value: vi.fn().mockResolvedValue(undefined)
+            });
+            Object.defineProperty(this, "disconnectAsync", {
+                enumerable: true,
+                configurable: true,
+                writable: true,
+                value: vi.fn().mockResolvedValue(undefined)
+            });
+            Object.defineProperty(this, "stopSerial", {
+                enumerable: true,
+                configurable: true,
+                writable: true,
+                value: vi.fn()
+            });
+        }
+    },
+}));
+const describeDeviceOnly = process.env.TEST_MODE_DEVICE
+    ? describe
+    : describe.skip;
+describe("MicrobitWebUSBConnection (WebUSB unsupported)", () => {
+    it("checkAvailability returns unsupported when WebUSB isn't available", async () => {
+        vi.stubGlobal("navigator", {});
+        const microbit = createWebUSBConnection();
+        expect(await microbit.checkAvailability()).toBe("unsupported");
+        vi.unstubAllGlobals();
+    });
+    it("still triggers afterrequestdevice if requestDevice throws", async () => {
+        vi.stubGlobal("navigator", {
+            usb: {
+                requestDevice: () => {
+                    throw new Error();
+                },
+            },
+        });
+        const microbit = createWebUSBConnection();
+        expect(microbit.status).toBe(ConnectionStatus.NO_AUTHORIZED_DEVICE);
+        const afterRequestDevice = vi.fn();
+        microbit.addEventListener("afterrequestdevice", afterRequestDevice);
+        await expect(() => microbit.connect()).rejects.toThrow();
+        expect(afterRequestDevice.mock.calls.length).toEqual(1);
+        vi.unstubAllGlobals();
+    });
+});
+describeDeviceOnly("MicrobitWebUSBConnection (WebUSB supported)", () => {
+    beforeAll(() => {
+        const usb = {
+            addEventListener: vi.fn(),
+            removeEventListener: vi.fn(),
+            requestDevice() {
+                const device = {};
+                return device;
+            },
+        };
+        // Maybe we can move this to a custom jest environment?
+        vi.stubGlobal("navigator", {
+            usb,
+        });
+    });
+    it("shows no device as initial status", () => {
+        const microbit = createWebUSBConnection();
+        expect(microbit.status).toBe(ConnectionStatus.NO_AUTHORIZED_DEVICE);
+    });
+    it("connects and disconnects updating status and events", async () => {
+        const events = [];
+        const connection = createWebUSBConnection();
+        connection.addEventListener("status", (event) => {
+            events.push(event.status);
+        });
+        await connection.connect();
+        expect(connection.status).toEqual(ConnectionStatus.CONNECTED);
+        expect(events).toEqual([ConnectionStatus.CONNECTED]);
+        // without this it breaks! something is up!
+        await new Promise((resolve) => setTimeout(resolve, 100));
+        await connection.disconnect();
+        connection.dispose();
+        expect(connection.status).toEqual(ConnectionStatus.DISCONNECTED);
+        expect(events).toEqual([
+            ConnectionStatus.CONNECTED,
+            ConnectionStatus.DISCONNECTED,
+        ]);
+    });
+});
+const mockDevice = (config) => ({
+    vendorId: config?.vendorId || 0x2341,
+    productId: config?.productId || 0x0043,
+    serialNumber: config?.serialNumber || "MOCK123456",
+    configuration: {
+        interfaces: config?.interfaces || [
+            {
+                alternates: [
+                    {
+                        alternateSetting: 0,
+                        interfaceClass: config?.interfaceClass || 2,
+                        interfaceSubclass: config?.interfaceSubclass || 2,
+                        interfaceProtocol: config?.interfaceProtocol || 0,
+                    },
+                ],
+            },
+        ],
+    },
+});
+const filter = {
+    classCode: 123,
+    productId: 456,
+    protocolCode: 789,
+    serialNumber: "012",
+    subclassCode: 345,
+    vendorId: 690,
+};
+describe("Tab visibility and PAUSED state", () => {
+    let visibilityState = "visible";
+    let visibilityListeners = [];
+    beforeAll(() => {
+        vi.stubGlobal("navigator", {
+            usb: {
+                addEventListener: vi.fn(),
+                removeEventListener: vi.fn(),
+                requestDevice: () => ({}),
+            },
+        });
+        vi.stubGlobal("document", {
+            get visibilityState() {
+                return visibilityState;
+            },
+            addEventListener: (_, listener) => {
+                visibilityListeners.push(listener);
+            },
+            removeEventListener: vi.fn(),
+        });
+        vi.stubGlobal("window", {
+            document,
+            addEventListener: vi.fn(),
+            removeEventListener: vi.fn(),
+        });
+    });
+    beforeEach(() => {
+        visibilityState = "visible";
+        visibilityListeners = [];
+    });
+    const waitForStatus = (connection, status) => new Promise((resolve) => {
+        if (connection.status === status) {
+            resolve();
+            return;
+        }
+        const listener = (event) => {
+            if (event.status === status) {
+                connection.removeEventListener("status", listener);
+                resolve();
+            }
+        };
+        connection.addEventListener("status", listener);
+    });
+    it("pauses when tab becomes hidden while connected", async () => {
+        const connection = createWebUSBConnection();
+        await connection.initialize();
+        await connection.connect();
+        expect(connection.status).toBe(ConnectionStatus.CONNECTED);
+        visibilityState = "hidden";
+        visibilityListeners.forEach((l) => l());
+        await waitForStatus(connection, ConnectionStatus.PAUSED);
+        expect(connection.status).toBe(ConnectionStatus.PAUSED);
+    });
+    it("reconnects when tab becomes visible while paused", async () => {
+        const connection = createWebUSBConnection();
+        await connection.initialize();
+        await connection.connect();
+        visibilityState = "hidden";
+        visibilityListeners.forEach((l) => l());
+        await waitForStatus(connection, ConnectionStatus.PAUSED);
+        visibilityState = "visible";
+        visibilityListeners.forEach((l) => l());
+        await waitForStatus(connection, ConnectionStatus.CONNECTED);
+        expect(connection.status).toBe(ConnectionStatus.CONNECTED);
+    });
+});
+describe("applyDevicesFilter", () => {
+    it("has no filter", () => {
+        const device = mockDevice();
+        expect(applyDeviceFilters(device, [], [])).toEqual(true);
+    });
+    it("satisfies filter", () => {
+        const device = mockDevice({
+            interfaceClass: filter.classCode,
+            productId: filter.productId,
+            interfaceProtocol: filter.protocolCode,
+            serialNumber: filter.serialNumber,
+            interfaceSubclass: filter.subclassCode,
+            vendorId: filter.vendorId,
+        });
+        expect(applyDeviceFilters(device, [filter], [])).toEqual(true);
+    });
+    it("does not satisfies filter", () => {
+        const device = mockDevice({
+            interfaceClass: filter.classCode,
+            productId: filter.productId,
+            interfaceProtocol: filter.protocolCode,
+            serialNumber: "something else",
+            interfaceSubclass: filter.subclassCode,
+            vendorId: filter.vendorId,
+        });
+        expect(applyDeviceFilters(device, [filter], [])).toEqual(false);
+    });
+    it("satisfies exclusion filter", () => {
+        const device = mockDevice({
+            interfaceClass: filter.classCode,
+            productId: filter.productId,
+            interfaceProtocol: filter.protocolCode,
+            serialNumber: filter.serialNumber,
+            interfaceSubclass: filter.subclassCode,
+            vendorId: filter.vendorId,
+        });
+        expect(applyDeviceFilters(device, [], [filter])).toEqual(false);
+    });
+    it("satifies filter and does not satisfy exclusion filter", () => {
+        const device = mockDevice({
+            interfaceClass: filter.classCode,
+            productId: filter.productId,
+            interfaceProtocol: filter.protocolCode,
+            serialNumber: filter.serialNumber,
+            interfaceSubclass: filter.subclassCode,
+            vendorId: filter.vendorId,
+        });
+        expect(applyDeviceFilters(device, [filter], [{ ...filter, serialNumber: "not satisfied" }])).toEqual(true);
+    });
+});
+//# sourceMappingURL=usb.test.js.map

package/build/esm/usb.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usb.test.js","sourceRoot":"","sources":["../../src/usb.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,EAAE,gBAAgB,EAAyB,MAAM,aAAa,CAAC;AACtE,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAEzE,EAAE,CAAC,IAAI,CAAC,yBAAyB,EAAE,GAAG,EAAE,CAAC,CAAC;IACxC,UAAU,EAAE,MAAM,UAAU;QAAhB;YACV;;;;uBAAc,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;eAAC;YACzD;;;;uBAAiB,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC;eAAC;YACtD;;;;uBAAkB,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC;eAAC;YACvD;;;;uBAAa,EAAE,CAAC,EAAE,EAAE;eAAC;QACvB,CAAC;KAAA;CACF,CAAC,CAAC,CAAC;AAEJ,MAAM,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB;IACrD,CAAC,CAAC,QAAQ;IACV,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;AAElB,QAAQ,CAAC,+CAA+C,EAAE,GAAG,EAAE;IAC7D,EAAE,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;QACjF,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAC/B,MAAM,QAAQ,GAAG,sBAAsB,EAAE,CAAC;QAC1C,MAAM,CAAC,MAAM,QAAQ,CAAC,iBAAiB,EAAE,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC/D,EAAE,CAAC,gBAAgB,EAAE,CAAC;IACxB,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QACzE,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE;YACzB,GAAG,EAAE;gBACH,aAAa,EAAE,GAAG,EAAE;oBAClB,MAAM,IAAI,KAAK,EAAE,CAAC;gBACpB,CAAC;aACF;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,sBAAsB,EAAE,CAAC;QAC1C,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;QACpE,MAAM,kBAAkB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACnC,QAAQ,CAAC,gBAAgB,CAAC,oBAAoB,EAAE,kBAAkB,CAAC,CAAC;QAEpE,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QAEzD,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACxD,EAAE,CAAC,gBAAgB,EAAE,CAAC;IACxB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,kBAAkB,CAAC,6CAA6C,EAAE,GAAG,EAAE;IACrE,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,GAAG,GAAG;YACV,gBAAgB,EAAE,EAAE,CAAC,EAAE,EAAE;YACzB,mBAAmB,EAAE,EAAE,CAAC,EAAE,EAAE;YAC5B,aAAa;gBACX,MAAM,MAAM,GAAG,EAAE,CAAC;gBAClB,OAAO,MAAM,CAAC;YAChB,CAAC;SACF,CAAC;QACF,uDAAuD;QACvD,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE;YACzB,GAAG;SACJ,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,QAAQ,GAAG,sBAAsB,EAAE,CAAC;QAC1C,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACnE,MAAM,MAAM,GAAuB,EAAE,CAAC;QACtC,MAAM,UAAU,GAAG,sBAAsB,EAAE,CAAC;QAC5C,UAAU,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC,KAA4B,EAAE,EAAE;YACrE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC;QAE3B,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;QAErD,2CAA2C;QAC3C,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;QACzD,MAAM,UAAU,CAAC,UAAU,EAAE,CAAC;QAC9B,UAAU,CAAC,OAAO,EAAE,CAAC;QAErB,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;QACjE,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACrB,gBAAgB,CAAC,SAAS;YAC1B,gBAAgB,CAAC,YAAY;SAC9B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAuBH,MAAM,UAAU,GAAG,CAAC,MAA4B,EAAE,EAAE,CAAC,CAAC;IACpD,QAAQ,EAAE,MAAM,EAAE,QAAQ,IAAI,MAAM;IACpC,SAAS,EAAE,MAAM,EAAE,SAAS,IAAI,MAAM;IACtC,YAAY,EAAE,MAAM,EAAE,YAAY,IAAI,YAAY;IAClD,aAAa,EAAE;QACb,UAAU,EAAE,MAAM,EAAE,UAAU,IAAI;YAChC;gBACE,UAAU,EAAE;oBACV;wBACE,gBAAgB,EAAE,CAAC;wBACnB,cAAc,EAAE,MAAM,EAAE,cAAc,IAAI,CAAC;wBAC3C,iBAAiB,EAAE,MAAM,EAAE,iBAAiB,IAAI,CAAC;wBACjD,iBAAiB,EAAE,MAAM,EAAE,iBAAiB,IAAI,CAAC;qBAClD;iBACF;aACF;SACF;KACF;CACF,CAAC,CAAC;AAEH,MAAM,MAAM,GAAoB;IAC9B,SAAS,EAAE,GAAG;IACd,SAAS,EAAE,GAAG;IACd,YAAY,EAAE,GAAG;IACjB,YAAY,EAAE,KAAK;IACnB,YAAY,EAAE,GAAG;IACjB,QAAQ,EAAE,GAAG;CACd,CAAC;AAEF,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC/C,IAAI,eAAe,GAAG,SAAS,CAAC;IAChC,IAAI,mBAAmB,GAAsB,EAAE,CAAC;IAEhD,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE;YACzB,GAAG,EAAE;gBACH,gBAAgB,EAAE,EAAE,CAAC,EAAE,EAAE;gBACzB,mBAAmB,EAAE,EAAE,CAAC,EAAE,EAAE;gBAC5B,aAAa,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;aAC1B;SACF,CAAC,CAAC;QACH,EAAE,CAAC,UAAU,CAAC,UAAU,EAAE;YACxB,IAAI,eAAe;gBACjB,OAAO,eAAe,CAAC;YACzB,CAAC;YACD,gBAAgB,EAAE,CAAC,CAAS,EAAE,QAAoB,EAAE,EAAE;gBACpD,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACrC,CAAC;YACD,mBAAmB,EAAE,EAAE,CAAC,EAAE,EAAE;SAC7B,CAAC,CAAC;QACH,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;YACtB,QAAQ;YACR,gBAAgB,EAAE,EAAE,CAAC,EAAE,EAAE;YACzB,mBAAmB,EAAE,EAAE,CAAC,EAAE,EAAE;SAC7B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,GAAG,EAAE;QACd,eAAe,GAAG,SAAS,CAAC;QAC5B,mBAAmB,GAAG,EAAE,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,CACpB,UAAqD,EACrD,MAAwB,EACxB,EAAE,CACF,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;QAC5B,IAAI,UAAU,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YACjC,OAAO,EAAE,CAAC;YACV,OAAO;QACT,CAAC;QACD,MAAM,QAAQ,GAAG,CAAC,KAA4B,EAAE,EAAE;YAChD,IAAI,KAAK,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;gBAC5B,UAAU,CAAC,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;gBACnD,OAAO,EAAE,CAAC;YACZ,CAAC;QACH,CAAC,CAAC;QACF,UAAU,CAAC,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEL,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC9D,MAAM,UAAU,GAAG,sBAAsB,EAAE,CAAC;QAC5C,MAAM,UAAU,CAAC,UAAU,EAAE,CAAC;QAC9B,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC;QAC3B,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QAE3D,eAAe,GAAG,QAAQ,CAAC;QAC3B,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAExC,MAAM,aAAa,CAAC,UAAU,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC;QACzD,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAChE,MAAM,UAAU,GAAG,sBAAsB,EAAE,CAAC;QAC5C,MAAM,UAAU,CAAC,UAAU,EAAE,CAAC;QAC9B,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC;QAE3B,eAAe,GAAG,QAAQ,CAAC;QAC3B,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACxC,MAAM,aAAa,CAAC,UAAU,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAEzD,eAAe,GAAG,SAAS,CAAC;QAC5B,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAExC,MAAM,aAAa,CAAC,UAAU,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;QAC5D,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,eAAe,EAAE,GAAG,EAAE;QACvB,MAAM,MAAM,GAAG,UAAU,EAAe,CAAC;QACzC,MAAM,CAAC,kBAAkB,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAC1B,MAAM,MAAM,GAAG,UAAU,CAAC;YACxB,cAAc,EAAE,MAAM,CAAC,SAAS;YAChC,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,iBAAiB,EAAE,MAAM,CAAC,YAAY;YACtC,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,iBAAiB,EAAE,MAAM,CAAC,YAAY;YACtC,QAAQ,EAAE,MAAM,CAAC,QAAQ;SAC1B,CAAc,CAAC;QAChB,MAAM,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,MAAM,MAAM,GAAG,UAAU,CAAC;YACxB,cAAc,EAAE,MAAM,CAAC,SAAS;YAChC,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,iBAAiB,EAAE,MAAM,CAAC,YAAY;YACtC,YAAY,EAAE,gBAAgB;YAC9B,iBAAiB,EAAE,MAAM,CAAC,YAAY;YACtC,QAAQ,EAAE,MAAM,CAAC,QAAQ;SAC1B,CAAc,CAAC;QAChB,MAAM,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACpC,MAAM,MAAM,GAAG,UAAU,CAAC;YACxB,cAAc,EAAE,MAAM,CAAC,SAAS;YAChC,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,iBAAiB,EAAE,MAAM,CAAC,YAAY;YACtC,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,iBAAiB,EAAE,MAAM,CAAC,YAAY;YACtC,QAAQ,EAAE,MAAM,CAAC,QAAQ;SAC1B,CAAc,CAAC;QAChB,MAAM,CAAC,kBAAkB,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC/D,MAAM,MAAM,GAAG,UAAU,CAAC;YACxB,cAAc,EAAE,MAAM,CAAC,SAAS;YAChC,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,iBAAiB,EAAE,MAAM,CAAC,YAAY;YACtC,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,iBAAiB,EAAE,MAAM,CAAC,YAAY;YACtC,QAAQ,EAAE,MAAM,CAAC,QAAQ;SAC1B,CAAc,CAAC;QAChB,MAAM,CACJ,kBAAkB,CAChB,MAAM,EACN,CAAC,MAAM,CAAC,EACR,CAAC,EAAE,GAAG,MAAM,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC,CAC/C,CACF,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@microbit/microbit-connection",
-  "version": "0.9.0-apps.alpha.14",
+  "version": "0.9.0-apps.alpha.16",
   "main": "./build/cjs/index.js",
   "module": "./build/esm/index.js",
   "types": "./build/esm/index.d.ts",
+  "files": [
+    "build"
+  ],
   "exports": {
     ".": {
       "import": {
@@ -17,35 +20,31 @@
     }
   },
   "scripts": {
-    "dev": "vite",
     "build:esm": "tsc -p tsconfig.json && echo '{\"type\": \"module\"}' > build/esm/package.json",
     "build:cjs": "tsc -p tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > build/cjs/package.json",
     "build:lib": "npm run build:esm && npm run build:cjs",
-    "build:demo": "vite build --mode=demo",
-    "build": "npm run build:lib && npm run build:demo",
+    "build": "npm run build:lib",
     "docs": "typedoc",
-    "ci": "npm run build:lib && npm run test && npx prettier --check lib src",
-    "test": "vitest",
-    "preview": "vite preview"
+    "ci": "npm run build:lib && npm run test",
+    "test": "vitest"
   },
   "devDependencies": {
     "@types/node": "^20.14.10",
     "jsdom": "^24.1.0",
-    "prettier": "3.3.2",
     "typedoc": "^0.27.6",
     "typescript": "^5.2.2",
-    "vite": "^6.3.5",
     "vitest": "^3.2.4"
   },
   "dependencies": {
-    "@capacitor-community/bluetooth-le": "^7.3.0",
-    "@capacitor/core": "^7.4.4",
-    "@capacitor/filesystem": "^7.1.6",
-    "@microbit/capacitor-community-nordic-dfu": "^7.0.0-microbit.3",
     "@microbit/microbit-universal-hex": "^0.2.2",
     "@types/web-bluetooth": "^0.0.20",
-    "crelt": "^1.0.6",
     "dapjs": "^2.3.0",
     "nrf-intel-hex": "^1.4.0"
+  },
+  "peerDependencies": {
+    "@capacitor-community/bluetooth-le": "^7.3.0",
+    "@capacitor/core": "^7.4.4",
+    "@capacitor/filesystem": "^7.1.6",
+    "@microbit/capacitor-community-nordic-dfu": "v7.0.0-microbit.4"
   }
 }

package/LICENSE.md

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024-2025 Micro:bit Educational Foundation and contributors
-
-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.

package/README.md

@@ -1,125 +0,0 @@
-# micro:bit connection library
-
-<a href="https://microbit-foundation.github.io/microbit-connection/" class="typedoc-ignore">This documentation is best viewed on the documentation site rather than GitHub or NPM package site.</a>
-
-This is a JavaScript library for micro:bit connections in browsers via USB and Bluetooth.
-
-This project is a work in progress. We are extracting WebUSB and Web Bluetooth code from the [micro:bit Python Editor](https://github.com/microbit-foundation/python-editor-v3/) and other projects. The API is not stable and it's not yet recommended that third parties use this project unless they are happy to update usage as the API evolves.
-
-[Demo page](https://microbit-connection.pages.dev/) for this library.
-
-[Alpha releases are now on NPM](https://www.npmjs.com/package/@microbit/microbit-connection).
-
-[micro:bit CreateAI](https://github.com/microbit-foundation/ml-trainer/) is already using this library for WebUSB and Web Bluetooth.
-
-[This Python Editor PR](https://github.com/microbit-foundation/python-editor-v3/pull/1190) tracks updating the micro:bit Python Editor to use this library.
-
-## Usage
-
-### Flash a micro:bit
-
-Instantiate a WebUSB connection using {@link createWebUSBConnection} class and use it to connect to a micro:bit.
-
-```ts
-import { createWebUSBConnection } from "@microbit/microbit-connection";
-
-const usb = createWebUSBConnection();
-const connectionStatus = await usb.connect();
-
-console.log("Connection status: ", connectionStatus);
-```
-
-{@link ConnectionStatus | Connection status} is `"CONNECTED"` if connection succeeds.
-
-Flash a universal hex that supports both V1 and V2:
-
-```ts
-import { createUniversalHexFlashDataSource } from "@microbit/microbit-connection";
-
-await usb.flash(createUniversalHexFlashDataSource(universalHexString), {
-  partial: true,
-  progress: (stage, percentage) => {
-    console.log(stage, percentage);
-  },
-});
-```
-
-This code will also work for non-universal hex files so is a good default for unknown hex files.
-
-Alternatively, you can create and flash a hex for a specific micro:bit version by providing a function that takes a {@link BoardVersion} and returns a hex.
-This can reduce download size or help integrate with APIs that produce a hex for a particular device version.
-This example uses the [@microbit/microbit-fs library](https://microbit-foundation.github.io/microbit-fs/) which can return a hex based on board id.
-
-```ts
-import { MicropythonFsHex, microbitBoardId } from "@microbit/microbit-fs";
-import { BoardId } from "@microbit/microbit-connection";
-
-const micropythonFs = new MicropythonFsHex([
-  { hex: microPythonV1HexFile, boardId: microbitBoardId.V1 },
-  { hex: microPythonV2HexFile, boardId: microbitBoardId.V2 },
-]);
-// Add files to MicroPython file system here (omitted for simplicity)
-// Flash the device
-await usb.flash(
-  async (boardVersion) => {
-    const boardId = BoardId.forVersion(boardVersion).id;
-    return micropythonFs.getIntelHex(boardId);
-  },
-  {
-    partial: true,
-    progress: (stage, percentage) => {
-      console.log(stage, percentage);
-    },
-  },
-);
-```
-
-For more examples of using other methods in the {@link MicrobitWebUSBConnection} class, see our [demo code](https://github.com/microbit-foundation/microbit-connection/blob/main/src/demo.ts) for our [demo site](https://microbit-connection.pages.dev/).
-
-### Connect via Bluetooth
-
-By default, the micro:bit's Bluetooth service is not enabled. Visit our [Bluetooth tech site page](https://tech.microbit.org/bluetooth/) to download a hex file that would enable the bluetooth service.
-
-Instantiate a Bluetooth connection using {@link createWebBluetoothConnection} class and use it to connect to a micro:bit.
-
-```ts
-import { createWebBluetoothConnection } from "@microbit/microbit-connection";
-
-const bluetooth = createWebBluetoothConnection();
-const connectionStatus = await bluetooth.connect();
-
-console.log("Connection status: ", connectionStatus);
-```
-
-{@link ConnectionStatus | Connection status} is `"CONNECTED"` if connection succeeds.
-
-For more examples of using other methods in the {@link createWebBluetoothConnection} class, see our [demo code](https://github.com/microbit-foundation/microbit-connection/blob/main/src/demo.ts) for our [demo site](https://microbit-connection.pages.dev/).
-
-## License
-
-This software is under the MIT open source license.
-
-[SPDX-License-Identifier: MIT](LICENSE)
-
-We use dependencies via the NPM registry as specified by the package.json file under common Open Source licenses.
-
-Full details of each package can be found by running `license-checker`:
-
-```bash
-$ npx license-checker --direct --summary --production
-```
-
-Omit the flags as desired to obtain more detail.
-
-## Code of conduct
-
-Trust, partnership, simplicity and passion are our core values we live and
-breathe in our daily work life and within our projects. Our open-source
-projects are no exception. We have an active community which spans the globe
-and we welcome and encourage participation and contributions to our projects
-by everyone. We work to foster a positive, open, inclusive and supportive
-environment and trust that our community respects the micro:bit code of
-conduct. Please see our [code of conduct](https://microbit.org/safeguarding/)
-which outlines our expectations for all those that participate in our
-community and details on how to report any concerns and what would happen
-should breaches occur.

package/typedoc.json

@@ -1,14 +0,0 @@
-{
-  "name": "micro:bit connection library",
-  "navigationLinks": {
-    "micro:bit tech site": "https://tech.microbit.org",
-    "GitHub": "https://github.com/microbit-foundation/microbit-connection"
-  },
-  "entryPoints": ["./lib/index.ts"],
-  "out": "./docs/build",
-  "readme": "./README.md",
-  "headings": {
-    "readme": false
-  },
-  "customCss": "./docs/custom.css"
-}