@microbit/microbit-connection 0.0.0-alpha.1

package/build/usb.js

@@ -0,0 +1,451 @@
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+import { NullLogging } from "./logging";
+import { withTimeout, TimeoutError } from "./async-util";
+import { DAPWrapper } from "./usb-device-wrapper";
+import { PartialFlashing } from "./usb-partial-flashing";
+import { ConnectionStatus, AfterRequestDevice, FlashEvent, FlashDataError, SerialDataEvent, SerialErrorEvent, SerialResetEvent, BeforeRequestDevice, ConnectionStatusEvent, DeviceError, } from "./device";
+import { TypedEventTarget } from "./events";
+// Temporary workaround for ChromeOS 105 bug.
+// See https://bugs.chromium.org/p/chromium/issues/detail?id=1363712&q=usb&can=2
+export const isChromeOS105 = () => {
+    const userAgent = navigator.userAgent;
+    return /CrOS/.test(userAgent) && /Chrome\/105\b/.test(userAgent);
+};
+/**
+ * A WebUSB connection to a micro:bit device.
+ */
+export class MicrobitWebUSBConnection extends TypedEventTarget {
+    constructor(options = { logging: new NullLogging() }) {
+        super();
+        Object.defineProperty(this, "status", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: navigator.usb && !isChromeOS105()
+                ? ConnectionStatus.NO_AUTHORIZED_DEVICE
+                : ConnectionStatus.NOT_SUPPORTED
+        });
+        /**
+         * The USB device we last connected to.
+         * Cleared if it is disconnected.
+         */
+        Object.defineProperty(this, "device", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * The connection to the device.
+         */
+        Object.defineProperty(this, "connection", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * DAPLink gives us a promise that lasts as long as we're serial reading.
+         * When stopping serial we await it to be sure we're done.
+         */
+        Object.defineProperty(this, "serialReadInProgress", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "serialListener", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (data) => {
+                this.dispatchTypedEvent("serialdata", new SerialDataEvent(data));
+            }
+        });
+        Object.defineProperty(this, "flashing", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "disconnectAfterFlash", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "visibilityReconnect", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "visibilityChangeListener", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: () => {
+                if (document.visibilityState === "visible") {
+                    if (this.visibilityReconnect &&
+                        this.status !== ConnectionStatus.CONNECTED) {
+                        this.disconnectAfterFlash = false;
+                        this.visibilityReconnect = false;
+                        if (!this.flashing) {
+                            this.log("Reconnecting visible tab");
+                            this.connect();
+                        }
+                    }
+                }
+                else {
+                    if (!this.unloading && this.status === ConnectionStatus.CONNECTED) {
+                        if (!this.flashing) {
+                            this.log("Disconnecting hidden tab");
+                            this.disconnect().then(() => {
+                                this.visibilityReconnect = true;
+                            });
+                        }
+                        else {
+                            this.log("Scheduling disconnect of hidden tab for after flash");
+                            this.disconnectAfterFlash = true;
+                        }
+                    }
+                }
+            }
+        });
+        Object.defineProperty(this, "unloading", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "beforeUnloadListener", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: () => {
+                // If serial is in progress when the page unloads with V1 DAPLink 0254 or V2 0255
+                // then it'll fail to reconnect with mismatched command/response errors.
+                // Try hard to disconnect as a workaround.
+                // https://github.com/microbit-foundation/python-editor-v3/issues/89
+                this.unloading = true;
+                this.stopSerialInternal();
+                // The user might stay on the page if they have unsaved changes and there's another beforeunload listener.
+                window.addEventListener("focus", () => {
+                    const assumePageIsStayingOpenDelay = 1000;
+                    setTimeout(() => {
+                        if (this.status === ConnectionStatus.CONNECTED) {
+                            this.unloading = false;
+                            this.startSerialInternal();
+                        }
+                    }, assumePageIsStayingOpenDelay);
+                }, { once: true });
+            }
+        });
+        Object.defineProperty(this, "logging", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "handleDisconnect", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (event) => {
+                if (event.device === this.device) {
+                    this.connection = undefined;
+                    this.device = undefined;
+                    this.setStatus(ConnectionStatus.NO_AUTHORIZED_DEVICE);
+                }
+            }
+        });
+        this.logging = options.logging;
+    }
+    log(v) {
+        this.logging.log(v);
+    }
+    async initialize() {
+        if (navigator.usb) {
+            navigator.usb.addEventListener("disconnect", this.handleDisconnect);
+        }
+        if (typeof window !== "undefined") {
+            window.addEventListener("beforeunload", this.beforeUnloadListener);
+            if (window.document) {
+                window.document.addEventListener("visibilitychange", this.visibilityChangeListener);
+            }
+        }
+    }
+    dispose() {
+        if (navigator.usb) {
+            navigator.usb.removeEventListener("disconnect", this.handleDisconnect);
+        }
+        if (typeof window !== "undefined") {
+            window.removeEventListener("beforeunload", this.beforeUnloadListener);
+            if (window.document) {
+                window.document.removeEventListener("visibilitychange", this.visibilityChangeListener);
+            }
+        }
+    }
+    async connect(options = {}) {
+        return this.withEnrichedErrors(async () => {
+            await this.connectInternal(options);
+            return this.status;
+        });
+    }
+    getBoardVersion() {
+        return this.connection?.boardSerialInfo?.id.toBoardVersion();
+    }
+    async flash(dataSource, options) {
+        this.flashing = true;
+        try {
+            const startTime = new Date().getTime();
+            await this.withEnrichedErrors(() => this.flashInternal(dataSource, options));
+            this.dispatchTypedEvent("flash", new FlashEvent());
+            const flashTime = new Date().getTime() - startTime;
+            this.logging.event({
+                type: "WebUSB-time",
+                detail: {
+                    flashTime,
+                },
+            });
+            this.logging.log("Flash complete");
+        }
+        finally {
+            this.flashing = false;
+        }
+    }
+    async flashInternal(dataSource, options) {
+        this.log("Stopping serial before flash");
+        await this.stopSerialInternal();
+        this.log("Reconnecting before flash");
+        await this.connectInternal({
+            serial: false,
+        });
+        if (!this.connection) {
+            throw new Error("Must be connected now");
+        }
+        const partial = options.partial;
+        const progress = options.progress || (() => { });
+        const boardId = this.connection.boardSerialInfo.id;
+        const flashing = new PartialFlashing(this.connection, this.logging);
+        let wasPartial = false;
+        try {
+            if (partial) {
+                wasPartial = await flashing.flashAsync(boardId, dataSource, progress);
+            }
+            else {
+                await flashing.fullFlashAsync(boardId, dataSource, progress);
+            }
+        }
+        finally {
+            progress(undefined, wasPartial);
+            if (this.disconnectAfterFlash) {
+                this.log("Disconnecting after flash due to tab visibility");
+                this.disconnectAfterFlash = false;
+                await this.disconnect();
+                this.visibilityReconnect = true;
+            }
+            else {
+                // This might not strictly be "reinstating". We should make this
+                // behaviour configurable when pulling out a library.
+                this.log("Reinstating serial after flash");
+                if (this.connection.daplink) {
+                    await this.connection.daplink.connect();
+                    await this.startSerialInternal();
+                }
+            }
+        }
+    }
+    async startSerialInternal() {
+        if (!this.connection) {
+            // As connecting then starting serial are async we could disconnect between them,
+            // so handle this gracefully.
+            return;
+        }
+        if (this.serialReadInProgress) {
+            await this.stopSerialInternal();
+        }
+        // This is async but won't return until we stop serial so we error handle with an event.
+        this.serialReadInProgress = this.connection
+            .startSerial(this.serialListener)
+            .then(() => this.log("Finished listening for serial data"))
+            .catch((e) => {
+            this.dispatchTypedEvent("serialerror", new SerialErrorEvent(e));
+        });
+    }
+    async stopSerialInternal() {
+        if (this.connection && this.serialReadInProgress) {
+            this.connection.stopSerial(this.serialListener);
+            await this.serialReadInProgress;
+            this.serialReadInProgress = undefined;
+            this.dispatchTypedEvent("serialreset", new SerialResetEvent());
+        }
+    }
+    async disconnect() {
+        try {
+            if (this.connection) {
+                await this.stopSerialInternal();
+                await this.connection.disconnectAsync();
+            }
+        }
+        catch (e) {
+            this.log("Error during disconnection:\r\n" + e);
+            this.logging.event({
+                type: "WebUSB-error",
+                message: "error-disconnecting",
+            });
+        }
+        finally {
+            this.connection = undefined;
+            this.setStatus(ConnectionStatus.NOT_CONNECTED);
+            this.logging.log("Disconnection complete");
+            this.logging.event({
+                type: "WebUSB-info",
+                message: "disconnected",
+            });
+        }
+    }
+    setStatus(newStatus) {
+        this.status = newStatus;
+        this.visibilityReconnect = false;
+        this.log("Device status " + newStatus);
+        this.dispatchTypedEvent("status", new ConnectionStatusEvent(newStatus));
+    }
+    async withEnrichedErrors(f) {
+        try {
+            return await f();
+        }
+        catch (e) {
+            if (e instanceof FlashDataError) {
+                throw e;
+            }
+            // Log error to console for feedback
+            this.log("An error occurred whilst attempting to use WebUSB.");
+            this.log("Details of the error can be found below, and may be useful when trying to replicate and debug the error.");
+            this.log(e);
+            // Disconnect from the microbit.
+            // Any new connection reallocates all the internals.
+            // Use the top-level API so any listeners reflect that we're disconnected.
+            await this.disconnect();
+            const enriched = enrichedError(e);
+            // Sanitise error message, replace all special chars with '-', if last char is '-' remove it
+            const errorMessage = e.message
+                ? e.message.replace(/\W+/g, "-").replace(/\W$/, "").toLowerCase()
+                : "";
+            this.logging.event({
+                type: "WebUSB-error",
+                message: e.code + "/" + errorMessage,
+            });
+            throw enriched;
+        }
+    }
+    serialWrite(data) {
+        return this.withEnrichedErrors(async () => {
+            if (this.connection) {
+                // Using WebUSB/DAPJs we're limited to 64 byte packet size with a two byte header.
+                // https://github.com/microbit-foundation/python-editor-v3/issues/215
+                const maxSerialWrite = 62;
+                let start = 0;
+                while (start < data.length) {
+                    const end = Math.min(start + maxSerialWrite, data.length);
+                    const chunkData = data.slice(start, end);
+                    await this.connection.daplink.serialWrite(chunkData);
+                    start = end;
+                }
+            }
+        });
+    }
+    async clearDevice() {
+        await this.disconnect();
+        this.device = undefined;
+        this.setStatus(ConnectionStatus.NO_AUTHORIZED_DEVICE);
+    }
+    async connectInternal(options) {
+        if (!this.connection) {
+            const device = await this.chooseDevice();
+            this.connection = new DAPWrapper(device, this.logging);
+        }
+        await withTimeout(this.connection.reconnectAsync(), 10_000);
+        if (options.serial === undefined || options.serial) {
+            this.startSerialInternal();
+        }
+        this.setStatus(ConnectionStatus.CONNECTED);
+    }
+    async chooseDevice() {
+        if (this.device) {
+            return this.device;
+        }
+        this.dispatchTypedEvent("beforerequestdevice", new BeforeRequestDevice());
+        this.device = await navigator.usb.requestDevice({
+            filters: [{ vendorId: 0x0d28, productId: 0x0204 }],
+        });
+        this.dispatchTypedEvent("afterrequestdevice", new AfterRequestDevice());
+        return this.device;
+    }
+}
+const genericErrorSuggestingReconnect = (e) => new DeviceError({
+    code: "reconnect-microbit",
+    message: e.message,
+});
+// tslint:disable-next-line: no-any
+const enrichedError = (err) => {
+    if (err instanceof DeviceError) {
+        return err;
+    }
+    if (err instanceof TimeoutError) {
+        return new DeviceError({
+            code: "timeout-error",
+            message: err.message,
+        });
+    }
+    switch (typeof err) {
+        case "object":
+            // We might get Error objects as Promise rejection arguments
+            if (!err.message && err.promise && err.reason) {
+                err = err.reason;
+            }
+            // This is somewhat fragile but worth it for scenario specific errors.
+            // These messages changed to be prefixed in 2023 so we've relaxed the checks.
+            if (/No valid interfaces found/.test(err.message)) {
+                // This comes from DAPjs's WebUSB open.
+                return new DeviceError({
+                    code: "update-req",
+                    message: err.message,
+                });
+            }
+            else if (/No device selected/.test(err.message)) {
+                return new DeviceError({
+                    code: "no-device-selected",
+                    message: err.message,
+                });
+            }
+            else if (/Unable to claim interface/.test(err.message)) {
+                return new DeviceError({
+                    code: "clear-connect",
+                    message: err.message,
+                });
+            }
+            else if (err.name === "device-disconnected") {
+                return new DeviceError({
+                    code: "device-disconnected",
+                    message: err.message,
+                });
+            }
+            else {
+                // Unhandled error. User will need to reconnect their micro:bit
+                return genericErrorSuggestingReconnect(err);
+            }
+        case "string": {
+            // Caught a string. Example case: "Flash error" from DAPjs
+            return genericErrorSuggestingReconnect(err);
+        }
+        default: {
+            return genericErrorSuggestingReconnect(err);
+        }
+    }
+};
+//# sourceMappingURL=usb.js.map

package/build/usb.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usb.js","sourceRoot":"","sources":["../lib/usb.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAW,WAAW,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAEL,gBAAgB,EAIhB,kBAAkB,EAElB,UAAU,EACV,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,EACrB,WAAW,GACZ,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C,6CAA6C;AAC7C,gFAAgF;AAChF,MAAM,CAAC,MAAM,aAAa,GAAG,GAAY,EAAE;IACzC,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC;IACtC,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACnE,CAAC,CAAC;AASF;;GAEG;AACH,MAAM,OAAO,wBACX,SAAQ,gBAA0C;IAsFlD,YACE,UAA2C,EAAE,OAAO,EAAE,IAAI,WAAW,EAAE,EAAE;QAEzE,KAAK,EAAE,CAAC;QAtFV;;;;mBACE,SAAS,CAAC,GAAG,IAAI,CAAC,aAAa,EAAE;gBAC/B,CAAC,CAAC,gBAAgB,CAAC,oBAAoB;gBACvC,CAAC,CAAC,gBAAgB,CAAC,aAAa;WAAC;QAErC;;;WAGG;QACK;;;;;WAA8B;QACtC;;WAEG;QACK;;;;;WAAmC;QAE3C;;;WAGG;QACK;;;;;WAAgD;QAEhD;;;;mBAAiB,CAAC,IAAY,EAAE,EAAE;gBACxC,IAAI,CAAC,kBAAkB,CAAC,YAAY,EAAE,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;YACnE,CAAC;WAAC;QAEM;;;;mBAAoB,KAAK;WAAC;QAC1B;;;;mBAAgC,KAAK;WAAC;QACtC;;;;mBAA+B,KAAK;WAAC;QACrC;;;;mBAA2B,GAAG,EAAE;gBACtC,IAAI,QAAQ,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;oBAC3C,IACE,IAAI,CAAC,mBAAmB;wBACxB,IAAI,CAAC,MAAM,KAAK,gBAAgB,CAAC,SAAS,EAC1C,CAAC;wBACD,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC;wBAClC,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC;wBACjC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;4BACnB,IAAI,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;4BACrC,IAAI,CAAC,OAAO,EAAE,CAAC;wBACjB,CAAC;oBACH,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,gBAAgB,CAAC,SAAS,EAAE,CAAC;wBAClE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;4BACnB,IAAI,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;4BACrC,IAAI,CAAC,UAAU,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;gCAC1B,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC;4BAClC,CAAC,CAAC,CAAC;wBACL,CAAC;6BAAM,CAAC;4BACN,IAAI,CAAC,GAAG,CAAC,qDAAqD,CAAC,CAAC;4BAChE,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;wBACnC,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;WAAC;QAEM;;;;mBAAY,KAAK;WAAC;QAElB;;;;mBAAuB,GAAG,EAAE;gBAClC,iFAAiF;gBACjF,wEAAwE;gBACxE,0CAA0C;gBAC1C,oEAAoE;gBACpE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;gBACtB,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBAC1B,0GAA0G;gBAC1G,MAAM,CAAC,gBAAgB,CACrB,OAAO,EACP,GAAG,EAAE;oBACH,MAAM,4BAA4B,GAAG,IAAI,CAAC;oBAC1C,UAAU,CAAC,GAAG,EAAE;wBACd,IAAI,IAAI,CAAC,MAAM,KAAK,gBAAgB,CAAC,SAAS,EAAE,CAAC;4BAC/C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;4BACvB,IAAI,CAAC,mBAAmB,EAAE,CAAC;wBAC7B,CAAC;oBACH,CAAC,EAAE,4BAA4B,CAAC,CAAC;gBACnC,CAAC,EACD,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,CAAC;YACJ,CAAC;WAAC;QAEM;;;;;WAAiB;QA+OjB;;;;mBAAmB,CAAC,KAAyB,EAAE,EAAE;gBACvD,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;oBACjC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;oBAC5B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;oBACxB,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;gBACxD,CAAC;YACH,CAAC;WAAC;QA/OA,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IACjC,CAAC;IAEO,GAAG,CAAC,CAAM;QAChB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,UAAU;QACd,IAAI,SAAS,CAAC,GAAG,EAAE,CAAC;YAClB,SAAS,CAAC,GAAG,CAAC,gBAAgB,CAAC,YAAY,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACtE,CAAC;QACD,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;YAClC,MAAM,CAAC,gBAAgB,CAAC,cAAc,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;YACnE,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;gBACpB,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAC9B,kBAAkB,EAClB,IAAI,CAAC,wBAAwB,CAC9B,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO;QACL,IAAI,SAAS,CAAC,GAAG,EAAE,CAAC;YAClB,SAAS,CAAC,GAAG,CAAC,mBAAmB,CAAC,YAAY,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACzE,CAAC;QACD,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;YAClC,MAAM,CAAC,mBAAmB,CAAC,cAAc,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;YACtE,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;gBACpB,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CACjC,kBAAkB,EAClB,IAAI,CAAC,wBAAwB,CAC9B,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,UAA0B,EAAE;QACxC,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAAE;YACxC,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YACpC,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,eAAe;QACb,OAAO,IAAI,CAAC,UAAU,EAAE,eAAe,EAAE,EAAE,CAAC,cAAc,EAAE,CAAC;IAC/D,CAAC;IAED,KAAK,CAAC,KAAK,CACT,UAA2B,EAC3B,OAGC;QAED,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YACvC,MAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,CACxC,CAAC;YACF,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,IAAI,UAAU,EAAE,CAAC,CAAC;YAEnD,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC;YACnD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;gBACjB,IAAI,EAAE,aAAa;gBACnB,MAAM,EAAE;oBACN,SAAS;iBACV;aACF,CAAC,CAAC;YACH,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACrC,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACxB,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,aAAa,CACzB,UAA2B,EAC3B,OAGC;QAED,IAAI,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;QACzC,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAChC,IAAI,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;QACtC,MAAM,IAAI,CAAC,eAAe,CAAC;YACzB,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,CAAC;QAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAChC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAEhD,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;QACnD,MAAM,QAAQ,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACpE,IAAI,UAAU,GAAY,KAAK,CAAC;QAChC,IAAI,CAAC;YACH,IAAI,OAAO,EAAE,CAAC;gBACZ,UAAU,GAAG,MAAM,QAAQ,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;YACxE,CAAC;iBAAM,CAAC;gBACN,MAAM,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;YAC/D,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YAEhC,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;gBAC9B,IAAI,CAAC,GAAG,CAAC,iDAAiD,CAAC,CAAC;gBAC5D,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC;gBAClC,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;gBACxB,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC;YAClC,CAAC;iBAAM,CAAC;gBACN,gEAAgE;gBAChE,qDAAqD;gBACrD,IAAI,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;gBAC3C,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;oBAC5B,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;oBACxC,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACnC,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,mBAAmB;QAC/B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,iFAAiF;YACjF,6BAA6B;YAC7B,OAAO;QACT,CAAC;QACD,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC9B,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAClC,CAAC;QACD,wFAAwF;QACxF,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,UAAU;aACxC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC;aAChC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;aAC1D,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACX,IAAI,CAAC,kBAAkB,CAAC,aAAa,EAAE,IAAI,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;QAClE,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,KAAK,CAAC,kBAAkB;QAC9B,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YACjD,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAChD,MAAM,IAAI,CAAC,oBAAoB,CAAC;YAChC,IAAI,CAAC,oBAAoB,GAAG,SAAS,CAAC;YACtC,IAAI,CAAC,kBAAkB,CAAC,aAAa,EAAE,IAAI,gBAAgB,EAAE,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAED,KAAK,CAAC,UAAU;QACd,IAAI,CAAC;YACH,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACpB,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBAChC,MAAM,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC;YAC1C,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,GAAG,CAAC,iCAAiC,GAAG,CAAC,CAAC,CAAC;YAChD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;gBACjB,IAAI,EAAE,cAAc;gBACpB,OAAO,EAAE,qBAAqB;aAC/B,CAAC,CAAC;QACL,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;YAC5B,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;YAC/C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;YAC3C,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;gBACjB,IAAI,EAAE,aAAa;gBACnB,OAAO,EAAE,cAAc;aACxB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAEO,SAAS,CAAC,SAA2B;QAC3C,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC;QACjC,IAAI,CAAC,GAAG,CAAC,gBAAgB,GAAG,SAAS,CAAC,CAAC;QACvC,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,IAAI,qBAAqB,CAAC,SAAS,CAAC,CAAC,CAAC;IAC1E,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAI,CAAmB;QACrD,IAAI,CAAC;YACH,OAAO,MAAM,CAAC,EAAE,CAAC;QACnB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,IAAI,CAAC,YAAY,cAAc,EAAE,CAAC;gBAChC,MAAM,CAAC,CAAC;YACV,CAAC;YAED,oCAAoC;YACpC,IAAI,CAAC,GAAG,CAAC,oDAAoD,CAAC,CAAC;YAC/D,IAAI,CAAC,GAAG,CACN,0GAA0G,CAC3G,CAAC;YACF,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAEZ,gCAAgC;YAChC,oDAAoD;YACpD,0EAA0E;YAC1E,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;YAExB,MAAM,QAAQ,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;YAClC,4FAA4F;YAC5F,MAAM,YAAY,GAAG,CAAC,CAAC,OAAO;gBAC5B,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE;gBACjE,CAAC,CAAC,EAAE,CAAC;YAEP,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;gBACjB,IAAI,EAAE,cAAc;gBACpB,OAAO,EAAE,CAAC,CAAC,IAAI,GAAG,GAAG,GAAG,YAAY;aACrC,CAAC,CAAC;YACH,MAAM,QAAQ,CAAC;QACjB,CAAC;IACH,CAAC;IAED,WAAW,CAAC,IAAY;QACtB,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAAE;YACxC,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACpB,kFAAkF;gBAClF,qEAAqE;gBACrE,MAAM,cAAc,GAAG,EAAE,CAAC;gBAC1B,IAAI,KAAK,GAAG,CAAC,CAAC;gBACd,OAAO,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;oBAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,cAAc,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;oBAC1D,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;oBACzC,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;oBACrD,KAAK,GAAG,GAAG,CAAC;gBACd,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAUD,KAAK,CAAC,WAAW;QACf,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;IACxD,CAAC;IAEO,KAAK,CAAC,eAAe,CAAC,OAAuB;QACnD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;YACzC,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,CAAC;QACD,MAAM,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,MAAM,CAAC,CAAC;QAC5D,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YACnD,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC7B,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC7C,CAAC;IAEO,KAAK,CAAC,YAAY;QACxB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,kBAAkB,CAAC,qBAAqB,EAAE,IAAI,mBAAmB,EAAE,CAAC,CAAC;QAC1E,IAAI,CAAC,MAAM,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC;YAC9C,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC;SACnD,CAAC,CAAC;QACH,IAAI,CAAC,kBAAkB,CAAC,oBAAoB,EAAE,IAAI,kBAAkB,EAAE,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF;AAED,MAAM,+BAA+B,GAAG,CAAC,CAAM,EAAE,EAAE,CACjD,IAAI,WAAW,CAAC;IACd,IAAI,EAAE,oBAAoB;IAC1B,OAAO,EAAE,CAAC,CAAC,OAAO;CACnB,CAAC,CAAC;AAEL,mCAAmC;AACnC,MAAM,aAAa,GAAG,CAAC,GAAQ,EAAe,EAAE;IAC9C,IAAI,GAAG,YAAY,WAAW,EAAE,CAAC;QAC/B,OAAO,GAAG,CAAC;IACb,CAAC;IACD,IAAI,GAAG,YAAY,YAAY,EAAE,CAAC;QAChC,OAAO,IAAI,WAAW,CAAC;YACrB,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE,GAAG,CAAC,OAAO;SACrB,CAAC,CAAC;IACL,CAAC;IAED,QAAQ,OAAO,GAAG,EAAE,CAAC;QACnB,KAAK,QAAQ;YACX,4DAA4D;YAC5D,IAAI,CAAC,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;gBAC9C,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC;YACnB,CAAC;YACD,sEAAsE;YACtE,6EAA6E;YAC7E,IAAI,2BAA2B,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;gBAClD,uCAAuC;gBACvC,OAAO,IAAI,WAAW,CAAC;oBACrB,IAAI,EAAE,YAAY;oBAClB,OAAO,EAAE,GAAG,CAAC,OAAO;iBACrB,CAAC,CAAC;YACL,CAAC;iBAAM,IAAI,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;gBAClD,OAAO,IAAI,WAAW,CAAC;oBACrB,IAAI,EAAE,oBAAoB;oBAC1B,OAAO,EAAE,GAAG,CAAC,OAAO;iBACrB,CAAC,CAAC;YACL,CAAC;iBAAM,IAAI,2BAA2B,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;gBACzD,OAAO,IAAI,WAAW,CAAC;oBACrB,IAAI,EAAE,eAAe;oBACrB,OAAO,EAAE,GAAG,CAAC,OAAO;iBACrB,CAAC,CAAC;YACL,CAAC;iBAAM,IAAI,GAAG,CAAC,IAAI,KAAK,qBAAqB,EAAE,CAAC;gBAC9C,OAAO,IAAI,WAAW,CAAC;oBACrB,IAAI,EAAE,qBAAqB;oBAC3B,OAAO,EAAE,GAAG,CAAC,OAAO;iBACrB,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,+DAA+D;gBAC/D,OAAO,+BAA+B,CAAC,GAAG,CAAC,CAAC;YAC9C,CAAC;QACH,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,0DAA0D;YAC1D,OAAO,+BAA+B,CAAC,GAAG,CAAC,CAAC;QAC9C,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,OAAO,+BAA+B,CAAC,GAAG,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;AACH,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@microbit/microbit-connection",
+  "version": "0.0.0-alpha.1",
+  "type": "module",
+  "module": "./build/index.js",
+  "exports": {
+    ".": {
+      "import": "./build/index.js"
+    }
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc",
+    "ci": "npm run build && npm run test && npx prettier --check lib src",
+    "test": "vitest",
+    "preview": "vite preview"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.10",
+    "jsdom": "^24.1.0",
+    "prettier": "3.3.2",
+    "typescript": "^5.2.2",
+    "vite": "^5.3.1",
+    "vitest": "^2.0.0"
+  },
+  "dependencies": {
+    "@microbit/microbit-universal-hex": "^0.2.2",
+    "@types/web-bluetooth": "^0.0.20",
+    "dapjs": "^2.2.0",
+    "nrf-intel-hex": "^1.4.0"
+  }
+}

package/vite.config.ts

@@ -0,0 +1,32 @@
+/**
+ * (c) 2024, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+import { resolve } from "path";
+import { loadEnv } from "vite";
+import { configDefaults, defineConfig, UserConfig } from "vitest/config";
+
+export default defineConfig(({ mode }) => {
+  process.env = { ...process.env, ...loadEnv(mode, process.cwd()) };
+  const config: UserConfig = {
+    base: process.env.BASE_URL ?? "/",
+    build: {
+      sourcemap: true,
+      lib: {
+        // Could also be a dictionary or array of multiple entry points
+        entry: resolve(__dirname, "lib/index.ts"),
+        name: "MicrobitConnection",
+        // the proper extensions will be added
+        fileName: "microbit-connection",
+      },
+    },
+    test: {
+      exclude: [...configDefaults.exclude, "**/e2e/**"],
+      environment: "jsdom",
+      setupFiles: "./lib/setupTests.ts",
+      mockReset: true,
+    },
+  };
+  return config;
+});