@microbit/microbit-connection 0.0.0-alpha.1

package/build/board-serial-info.js

@@ -0,0 +1,47 @@
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+import { BoardId } from "./board-id";
+export class BoardSerialInfo {
+    constructor(id, familyId, hic) {
+        Object.defineProperty(this, "id", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: id
+        });
+        Object.defineProperty(this, "familyId", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: familyId
+        });
+        Object.defineProperty(this, "hic", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: hic
+        });
+    }
+    static parse(device, log) {
+        const serial = device.serialNumber;
+        if (!serial) {
+            throw new Error("Could not detected ID from connected board.");
+        }
+        if (serial.length !== 48) {
+            log(`USB serial number unexpected length: ${serial.length}`);
+        }
+        const id = serial.substring(0, 4);
+        const familyId = serial.substring(4, 8);
+        const hic = serial.slice(-8);
+        return new BoardSerialInfo(BoardId.parse(id), familyId, hic);
+    }
+    eq(other) {
+        return (other.id === this.id &&
+            other.familyId === this.familyId &&
+            other.hic === this.hic);
+    }
+}
+//# sourceMappingURL=board-serial-info.js.map

package/build/board-serial-info.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"board-serial-info.js","sourceRoot":"","sources":["../lib/board-serial-info.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,MAAM,OAAO,eAAe;IAC1B,YACS,EAAW,EACX,QAAgB,EAChB,GAAW;QAFlB;;;;mBAAO,EAAE;WAAS;QAClB;;;;mBAAO,QAAQ;WAAQ;QACvB;;;;mBAAO,GAAG;WAAQ;IACjB,CAAC;IACJ,MAAM,CAAC,KAAK,CAAC,MAAiB,EAAE,GAA0B;QACxD,MAAM,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC;QACnC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,MAAM,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YACzB,GAAG,CAAC,wCAAwC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAC/D,CAAC;QACD,MAAM,EAAE,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACxC,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7B,OAAO,IAAI,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAC/D,CAAC;IAED,EAAE,CAAC,KAAsB;QACvB,OAAO,CACL,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE;YACpB,KAAK,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ;YAChC,KAAK,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,CACvB,CAAC;IACJ,CAAC;CACF"}

package/build/constants.d.ts

@@ -0,0 +1,47 @@
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+export declare const FICR: {
+    CODEPAGESIZE: number;
+    CODESIZE: number;
+};
+export declare const DapCmd: {
+    DAP_INFO: number;
+    DAP_CONNECT: number;
+    DAP_DISCONNECT: number;
+    DAP_TRANSFER: number;
+    DAP_TRANSFER_BLOCK: number;
+};
+export declare const Csw: {
+    CSW_SIZE: number;
+    CSW_SIZE32: number;
+    CSW_ADDRINC: number;
+    CSW_SADDRINC: number;
+    CSW_DBGSTAT: number;
+    CSW_HPROT: number;
+    CSW_MSTRDBG: number;
+    CSW_RESERVED: number;
+    CSW_VALUE: number;
+};
+export declare const DapVal: {
+    AP_ACC: number;
+    READ: number;
+    WRITE: number;
+};
+export declare const ApReg: {
+    CSW: number;
+    TAR: number;
+    DRW: number;
+};
+export declare const CortexSpecialReg: {
+    DEMCR: number;
+    DEMCR_VC_CORERESET: number;
+    CPUID: number;
+    DHCSR: number;
+    S_RESET_ST: number;
+    NVIC_AIRCR: number;
+    NVIC_AIRCR_VECTKEY: number;
+    NVIC_AIRCR_SYSRESETREQ: number;
+};

package/build/constants.js

@@ -0,0 +1,69 @@
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+// https://github.com/mmoskal/dapjs/blob/a32f11f54e9e76a9c61896ddd425c1cb1a29c143/src/dap/constants.ts
+// https://github.com/mmoskal/dapjs/blob/a32f11f54e9e76a9c61896ddd425c1cb1a29c143/src/cortex/constants.ts
+// CRA's build tooling doesn't support const enums so we've converted them to prefixed constants here.
+// If we move this to a separate library then we can replace them.
+// In the meantime we should prune the list below to what we actually use.
+// FICR Registers
+export const FICR = {
+    CODEPAGESIZE: 0x10000000 | 0x10,
+    CODESIZE: 0x10000000 | 0x14,
+};
+export const DapCmd = {
+    DAP_INFO: 0x00,
+    DAP_CONNECT: 0x02,
+    DAP_DISCONNECT: 0x03,
+    DAP_TRANSFER: 0x05,
+    DAP_TRANSFER_BLOCK: 0x06,
+    // Many more.
+};
+export const Csw = {
+    CSW_SIZE: 0x00000007,
+    CSW_SIZE32: 0x00000002,
+    CSW_ADDRINC: 0x00000030,
+    CSW_SADDRINC: 0x00000010,
+    CSW_DBGSTAT: 0x00000040,
+    CSW_HPROT: 0x02000000,
+    CSW_MSTRDBG: 0x20000000,
+    CSW_RESERVED: 0x01000000,
+    CSW_VALUE: -1, // see below
+    // Many more.
+};
+Csw.CSW_VALUE =
+    Csw.CSW_RESERVED |
+        Csw.CSW_MSTRDBG |
+        Csw.CSW_HPROT |
+        Csw.CSW_DBGSTAT |
+        Csw.CSW_SADDRINC;
+export const DapVal = {
+    AP_ACC: 1 << 0,
+    READ: 1 << 1,
+    WRITE: 0 << 1,
+    // More.
+};
+export const ApReg = {
+    CSW: 0x00,
+    TAR: 0x04,
+    DRW: 0x0c,
+    // More.
+};
+export const CortexSpecialReg = {
+    // Debug Exception and Monitor Control Register
+    DEMCR: 0xe000edfc,
+    // DWTENA in armv6 architecture reference manual
+    DEMCR_VC_CORERESET: 1 << 0,
+    // CPUID Register
+    CPUID: 0xe000ed00,
+    // Debug Halting Control and Status Register
+    DHCSR: 0xe000edf0,
+    S_RESET_ST: 1 << 25,
+    NVIC_AIRCR: 0xe000ed0c,
+    NVIC_AIRCR_VECTKEY: 0x5fa << 16,
+    NVIC_AIRCR_SYSRESETREQ: 1 << 2,
+    // Many more.
+};
+//# sourceMappingURL=constants.js.map

package/build/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../lib/constants.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,sGAAsG;AACtG,yGAAyG;AAEzG,sGAAsG;AACtG,kEAAkE;AAClE,0EAA0E;AAE1E,iBAAiB;AACjB,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,YAAY,EAAE,UAAU,GAAG,IAAI;IAC/B,QAAQ,EAAE,UAAU,GAAG,IAAI;CAC5B,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,QAAQ,EAAE,IAAI;IACd,WAAW,EAAE,IAAI;IACjB,cAAc,EAAE,IAAI;IACpB,YAAY,EAAE,IAAI;IAClB,kBAAkB,EAAE,IAAI;IACxB,aAAa;CACd,CAAC;AAEF,MAAM,CAAC,MAAM,GAAG,GAAG;IACjB,QAAQ,EAAE,UAAU;IACpB,UAAU,EAAE,UAAU;IACtB,WAAW,EAAE,UAAU;IACvB,YAAY,EAAE,UAAU;IACxB,WAAW,EAAE,UAAU;IACvB,SAAS,EAAE,UAAU;IACrB,WAAW,EAAE,UAAU;IACvB,YAAY,EAAE,UAAU;IACxB,SAAS,EAAE,CAAC,CAAC,EAAE,YAAY;IAC3B,aAAa;CACd,CAAC;AACF,GAAG,CAAC,SAAS;IACX,GAAG,CAAC,YAAY;QAChB,GAAG,CAAC,WAAW;QACf,GAAG,CAAC,SAAS;QACb,GAAG,CAAC,WAAW;QACf,GAAG,CAAC,YAAY,CAAC;AAEnB,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,MAAM,EAAE,CAAC,IAAI,CAAC;IACd,IAAI,EAAE,CAAC,IAAI,CAAC;IACZ,KAAK,EAAE,CAAC,IAAI,CAAC;IACb,QAAQ;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,GAAG,EAAE,IAAI;IACT,GAAG,EAAE,IAAI;IACT,GAAG,EAAE,IAAI;IACT,QAAQ;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,+CAA+C;IAC/C,KAAK,EAAE,UAAU;IACjB,gDAAgD;IAChD,kBAAkB,EAAE,CAAC,IAAI,CAAC;IAE1B,iBAAiB;IACjB,KAAK,EAAE,UAAU;IAEjB,4CAA4C;IAC5C,KAAK,EAAE,UAAU;IACjB,UAAU,EAAE,CAAC,IAAI,EAAE;IAEnB,UAAU,EAAE,UAAU;IACtB,kBAAkB,EAAE,KAAK,IAAI,EAAE;IAC/B,sBAAsB,EAAE,CAAC,IAAI,CAAC;IAE9B,aAAa;CACd,CAAC"}

package/build/device.d.ts

@@ -0,0 +1,202 @@
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+import { TypedEventTarget } from "./events";
+import { BoardId } from "./board-id";
+/**
+ * Specific identified error types.
+ *
+ * New members may be added over time.
+ */
+export type DeviceErrorCode = 
+/**
+ * Device not selected, e.g. because the user cancelled the dialog.
+ */
+"no-device-selected"
+/**
+ * Device not found, perhaps because it doesn't have new enough firmware (for V1).
+ */
+ | "update-req"
+/**
+ * Unable to claim the interface, usually because it's in use in another tab/window.
+ */
+ | "clear-connect"
+/**
+ * The device was found to be disconnected.
+ */
+ | "device-disconnected"
+/**
+ * A communication timeout occurred.
+ */
+ | "timeout-error"
+/**
+ * This is the fallback error case suggesting that the user reconnects their device.
+ */
+ | "reconnect-microbit";
+/**
+ * Error type used for all interactions with this module.
+ *
+ * The code indicates the error type and may be suitable for providing
+ * translated error messages.
+ *
+ * The message is the underlying message text and will usually be in
+ * English.
+ */
+export declare class DeviceError extends Error {
+    code: DeviceErrorCode;
+    constructor({ code, message }: {
+        code: DeviceErrorCode;
+        message?: string;
+    });
+}
+/**
+ * Tracks connection status,
+ */
+export declare enum ConnectionStatus {
+    /**
+     * Determining whether the connection type is supported requires
+     * initialize() to complete.
+     */
+    SUPPORT_NOT_KNOWN = 0,
+    /**
+     * Not supported.
+     */
+    NOT_SUPPORTED = "NOT_SUPPORTED",
+    /**
+     * Supported but no device available.
+     *
+     * This will be the case even when a device is physically connected
+     * but has not been connected via the browser security UI.
+     */
+    NO_AUTHORIZED_DEVICE = "NO_DEVICE",
+    /**
+     * Authorized device available but we haven't connected to it.
+     */
+    NOT_CONNECTED = "NOT_CONNECTED",
+    /**
+     * Connected.
+     */
+    CONNECTED = "CONNECTED"
+}
+export declare class FlashDataError extends Error {
+}
+export interface FlashDataSource {
+    /**
+     * For now we only support partially flashing contiguous data.
+     * This can be generated from microbit-fs directly (via getIntelHexBytes())
+     * or from an existing Intel Hex via slicePad.
+     *
+     * This interface is quite confusing and worth revisiting.
+     *
+     * @param boardId the id of the board.
+     * @throws FlashDataError if we cannot generate hex data.
+     */
+    partialFlashData(boardId: BoardId): Promise<Uint8Array>;
+    /**
+     * @param boardId the id of the board.
+     * @returns A board-specific (non-universal) Intel Hex file for the given board id.
+     * @throws FlashDataError if we cannot generate hex data.
+     */
+    fullFlashData(boardId: BoardId): Promise<string>;
+}
+export interface ConnectOptions {
+    serial?: boolean;
+    name?: string;
+}
+export type BoardVersion = "V1" | "V2";
+export declare class ConnectionStatusEvent extends Event {
+    readonly status: ConnectionStatus;
+    constructor(status: ConnectionStatus);
+}
+export declare class SerialDataEvent extends Event {
+    readonly data: string;
+    constructor(data: string);
+}
+export declare class SerialResetEvent extends Event {
+    constructor();
+}
+export declare class SerialErrorEvent extends Event {
+    readonly error: unknown;
+    constructor(error: unknown);
+}
+export declare class FlashEvent extends Event {
+    constructor();
+}
+export declare class BeforeRequestDevice extends Event {
+    constructor();
+}
+export declare class AfterRequestDevice extends Event {
+    constructor();
+}
+export declare class DeviceConnectionEventMap {
+    "status": ConnectionStatusEvent;
+    "serialdata": SerialDataEvent;
+    "serialreset": Event;
+    "serialerror": Event;
+    "flash": Event;
+    "beforerequestdevice": Event;
+    "afterrequestdevice": Event;
+}
+export interface DeviceConnection extends TypedEventTarget<DeviceConnectionEventMap> {
+    status: ConnectionStatus;
+    /**
+     * Initializes the device.
+     */
+    initialize(): Promise<void>;
+    /**
+     * Removes all listeners.
+     */
+    dispose(): void;
+    /**
+     * Connects to a currently paired device or requests pairing.
+     * Throws on error.
+     *
+     * @returns the final connection status.
+     */
+    connect(options?: ConnectOptions): Promise<ConnectionStatus>;
+    /**
+     * Get the board version.
+     *
+     * @returns the board version or null if there is no connection.
+     */
+    getBoardVersion(): BoardVersion | undefined;
+    /**
+     * Flash the micro:bit.
+     *
+     * @param dataSource The data to use.
+     * @param options Flash options and progress callback.
+     */
+    flash?(dataSource: FlashDataSource, options: {
+        /**
+         * True to use a partial flash where possible, false to force a full flash.
+         */
+        partial: boolean;
+        /**
+         * A progress callback. Called with undefined when the process is complete or has failed.
+         *
+         * Requesting a partial flash doesn't guarantee one is performed. Partial flashes are avoided
+         * if too many blocks have changed and failed partial flashes are retried as full flashes.
+         * The partial parameter reports the flash type currently in progress.
+         */
+        progress: (percentage: number | undefined, partial: boolean) => void;
+    }): Promise<void>;
+    /**
+     * Disconnect from the device.
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Write serial data to the device.
+     *
+     * Does nothting if there is no connection.
+     *
+     * @param data The data to write.
+     * @returns A promise that resolves when the write is complete.
+     */
+    serialWrite(data: string): Promise<void>;
+    /**
+     * Clear device to enable chooseDevice.
+     */
+    clearDevice(): void;
+}

package/build/device.js

@@ -0,0 +1,153 @@
+/**
+ * Error type used for all interactions with this module.
+ *
+ * The code indicates the error type and may be suitable for providing
+ * translated error messages.
+ *
+ * The message is the underlying message text and will usually be in
+ * English.
+ */
+export class DeviceError extends Error {
+    constructor({ code, message }) {
+        super(message);
+        Object.defineProperty(this, "code", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.code = code;
+    }
+}
+/**
+ * Tracks connection status,
+ */
+export var ConnectionStatus;
+(function (ConnectionStatus) {
+    /**
+     * Determining whether the connection type is supported requires
+     * initialize() to complete.
+     */
+    ConnectionStatus[ConnectionStatus["SUPPORT_NOT_KNOWN"] = 0] = "SUPPORT_NOT_KNOWN";
+    /**
+     * Not supported.
+     */
+    ConnectionStatus["NOT_SUPPORTED"] = "NOT_SUPPORTED";
+    /**
+     * Supported but no device available.
+     *
+     * This will be the case even when a device is physically connected
+     * but has not been connected via the browser security UI.
+     */
+    ConnectionStatus["NO_AUTHORIZED_DEVICE"] = "NO_DEVICE";
+    /**
+     * Authorized device available but we haven't connected to it.
+     */
+    ConnectionStatus["NOT_CONNECTED"] = "NOT_CONNECTED";
+    /**
+     * Connected.
+     */
+    ConnectionStatus["CONNECTED"] = "CONNECTED";
+})(ConnectionStatus || (ConnectionStatus = {}));
+export class FlashDataError extends Error {
+}
+export class ConnectionStatusEvent extends Event {
+    constructor(status) {
+        super("status");
+        Object.defineProperty(this, "status", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: status
+        });
+    }
+}
+export class SerialDataEvent extends Event {
+    constructor(data) {
+        super("serialdata");
+        Object.defineProperty(this, "data", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: data
+        });
+    }
+}
+export class SerialResetEvent extends Event {
+    constructor() {
+        super("serialreset");
+    }
+}
+export class SerialErrorEvent extends Event {
+    constructor(error) {
+        super("serialerror");
+        Object.defineProperty(this, "error", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: error
+        });
+    }
+}
+export class FlashEvent extends Event {
+    constructor() {
+        super("flash");
+    }
+}
+export class BeforeRequestDevice extends Event {
+    constructor() {
+        super("beforerequestdevice");
+    }
+}
+export class AfterRequestDevice extends Event {
+    constructor() {
+        super("afterrequestdevice");
+    }
+}
+export class DeviceConnectionEventMap {
+    constructor() {
+        Object.defineProperty(this, "status", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "serialdata", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "serialreset", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "serialerror", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "flash", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "beforerequestdevice", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "afterrequestdevice", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+    }
+}
+//# sourceMappingURL=device.js.map

package/build/device.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"device.js","sourceRoot":"","sources":["../lib/device.ts"],"names":[],"mappings":"AAuCA;;;;;;;;GAQG;AACH,MAAM,OAAO,WAAY,SAAQ,KAAK;IAEpC,YAAY,EAAE,IAAI,EAAE,OAAO,EAA+C;QACxE,KAAK,CAAC,OAAO,CAAC,CAAC;QAFjB;;;;;WAAsB;QAGpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,gBAyBX;AAzBD,WAAY,gBAAgB;IAC1B;;;OAGG;IACH,iFAAiB,CAAA;IACjB;;OAEG;IACH,mDAA+B,CAAA;IAC/B;;;;;OAKG;IACH,sDAAkC,CAAA;IAClC;;OAEG;IACH,mDAA+B,CAAA;IAC/B;;OAEG;IACH,2CAAuB,CAAA;AACzB,CAAC,EAzBW,gBAAgB,KAAhB,gBAAgB,QAyB3B;AAED,MAAM,OAAO,cAAe,SAAQ,KAAK;CAAG;AA+B5C,MAAM,OAAO,qBAAsB,SAAQ,KAAK;IAC9C,YAA4B,MAAwB;QAClD,KAAK,CAAC,QAAQ,CAAC,CAAC;QADN;;;;mBAAgB,MAAM;WAAkB;IAEpD,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACxC,YAA4B,IAAY;QACtC,KAAK,CAAC,YAAY,CAAC,CAAC;QADV;;;;mBAAgB,IAAI;WAAQ;IAExC,CAAC;CACF;AAED,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IACzC;QACE,KAAK,CAAC,aAAa,CAAC,CAAC;IACvB,CAAC;CACF;AAED,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IACzC,YAA4B,KAAc;QACxC,KAAK,CAAC,aAAa,CAAC,CAAC;QADX;;;;mBAAgB,KAAK;WAAS;IAE1C,CAAC;CACF;AAED,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC;QACE,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAC5C;QACE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAC/B,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3C;QACE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAC9B,CAAC;CACF;AAED,MAAM,OAAO,wBAAwB;IAArC;QACE,4BAAA,QAAQ;;;;;WAAwB;QAChC,4BAAA,YAAY;;;;;WAAkB;QAC9B,4BAAA,aAAa;;;;;WAAQ;QACrB,4BAAA,aAAa;;;;;WAAQ;QACrB,4BAAA,OAAO;;;;;WAAQ;QACf,4BAAA,qBAAqB;;;;;WAAQ;QAC7B,4BAAA,oBAAoB;;;;;WAAQ;IAC9B,CAAC;CAAA"}

package/build/events.d.ts

@@ -0,0 +1,101 @@
+/**
+ * Copyright (c) 2022 Jonas "DerZade" Schade
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * https://github.com/DerZade/typescript-event-target/blob/master/src/TypedEventTarget.ts
+ */
+/**
+ * A function that can be passed to the `listener` parameter of {@link TypedEventTarget.addEventListener} and {@link TypedEventTarget.removeEventListener}.
+ *
+ * @template M A map of event types to their respective event classes.
+ * @template T The type of event to listen for (has to be keyof `M`).
+ */
+export type TypedEventListener<M, T extends keyof M> = (evt: M[T]) => void | Promise<void>;
+/**
+ * An object that can be passed to the `listener` parameter of {@link TypedEventTarget.addEventListener} and {@link TypedEventTarget.removeEventListener}.
+ *
+ * @template M A map of event types to their respective event classes.
+ * @template T The type of event to listen for (has to be keyof `M`).
+ */
+export interface TypedEventListenerObject<M, T extends keyof M> {
+    handleEvent: (evt: M[T]) => void | Promise<void>;
+}
+/**
+ * Type of parameter `listener` in {@link TypedEventTarget.addEventListener} and {@link TypedEventTarget.removeEventListener}.
+ *
+ * The object that receives a notification (an object that implements the Event interface) when an event of the specified type occurs.
+ *
+ * Can be either an object with a handleEvent() method, or a JavaScript function.
+ *
+ * @template M A map of event types to their respective event classes.
+ * @template T The type of event to listen for (has to be keyof `M`).
+ */
+export type TypedEventListenerOrEventListenerObject<M, T extends keyof M> = TypedEventListener<M, T> | TypedEventListenerObject<M, T>;
+type ValueIsEvent<T> = {
+    [key in keyof T]: Event;
+};
+/**
+ * Typescript friendly version of {@link EventTarget}
+ *
+ * @template M A map of event types to their respective event classes.
+ *
+ * @example
+ * ```typescript
+ * interface MyEventMap {
+ *     hello: Event;
+ *     time: CustomEvent<number>;
+ * }
+ *
+ * const eventTarget = new TypedEventTarget<MyEventMap>();
+ *
+ * eventTarget.addEventListener('time', (event) => {
+ *     // event is of type CustomEvent<number>
+ * });
+ * ```
+ */
+export interface TypedEventTarget<M extends ValueIsEvent<M>> {
+    /** Appends an event listener for events whose type attribute value is type.
+     * The callback argument sets the callback that will be invoked when the event
+     * is dispatched.
+     *
+     * The options argument sets listener-specific options. For compatibility this
+     * can be a boolean, in which case the method behaves exactly as if the value
+     * was specified as options's capture.
+     *
+     * When set to true, options's capture prevents callback from being invoked
+     * when the event's eventPhase attribute value is BUBBLING_PHASE. When false
+     * (or not present), callback will not be invoked when event's eventPhase
+     * attribute value is CAPTURING_PHASE. Either way, callback will be invoked if
+     * event's eventPhase attribute value is AT_TARGET.
+     *
+     * When set to true, options's passive indicates that the callback will not
+     * cancel the event by invoking preventDefault(). This is used to enable
+     * performance optimizations described in § 2.8 Observing event listeners.
+     *
+     * When set to true, options's once indicates that the callback will only be
+     * invoked once after which the event listener will be removed.
+     *
+     * The event listener is appended to target's event listener list and is not
+     * appended if it has the same type, callback, and capture. */
+    addEventListener: <T extends keyof M & string>(type: T, listener: TypedEventListenerOrEventListenerObject<M, T> | null, options?: boolean | AddEventListenerOptions) => void;
+    /** Removes the event listener in target's event listener list with the same
+     * type, callback, and options. */
+    removeEventListener: <T extends keyof M & string>(type: T, callback: TypedEventListenerOrEventListenerObject<M, T> | null, options?: EventListenerOptions | boolean) => void;
+    /**
+     * Dispatches a synthetic event event to target and returns true if either
+     * event's cancelable attribute value is false or its preventDefault() method
+     * was not invoked, and false otherwise.
+     * @deprecated To ensure type safety use `dispatchTypedEvent` instead.
+     */
+    dispatchEvent: (event: Event) => boolean;
+}
+export declare class TypedEventTarget<M extends ValueIsEvent<M>> extends EventTarget {
+    /**
+     * Dispatches a synthetic event event to target and returns true if either
+     * event's cancelable attribute value is false or its preventDefault() method
+     * was not invoked, and false otherwise.
+     */
+    dispatchTypedEvent<T extends keyof M>(_type: T, event: M[T]): boolean;
+}
+export {};

package/build/events.js

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) 2022 Jonas "DerZade" Schade
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * https://github.com/DerZade/typescript-event-target/blob/master/src/TypedEventTarget.ts
+ */
+// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
+export class TypedEventTarget extends EventTarget {
+    /**
+     * Dispatches a synthetic event event to target and returns true if either
+     * event's cancelable attribute value is false or its preventDefault() method
+     * was not invoked, and false otherwise.
+     */
+    dispatchTypedEvent(_type, event) {
+        return super.dispatchEvent(event);
+    }
+}
+//# sourceMappingURL=events.js.map

package/build/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../lib/events.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAyGH,4EAA4E;AAC5E,MAAM,OAAO,gBAA4C,SAAQ,WAAW;IAC1E;;;;OAIG;IACI,kBAAkB,CAAoB,KAAQ,EAAE,KAAW;QAChE,OAAO,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;CACF"}

package/build/hex-flash-data-source.d.ts

@@ -0,0 +1,9 @@
+import { BoardId } from "./board-id";
+import { FlashDataSource } from "./device";
+export declare class HexFlashDataSource implements FlashDataSource {
+    private hex;
+    constructor(hex: string);
+    partialFlashData(boardId: BoardId): Promise<Uint8Array>;
+    fullFlashData(boardId: BoardId): Promise<string>;
+    private matchingPart;
+}