Update microbit-connection library (#1207)

Author: microbit-grace

package-lock.json

@@ -16,7 +16,7 @@
     "@codemirror/view": "^6.26.3",
     "@emotion/react": "^11.11.4",
     "@emotion/styled": "^11.11.5",
-    "@microbit/microbit-connection": "^0.0.0-alpha.33",
+    "@microbit/microbit-connection": "^0.0.0-alpha.35",
     "@microbit/microbit-fs": "^0.10.0",
     "@sanity/block-content-to-react": "^3.0.0",
     "@sanity/image-url": "^1.0.1",

package.json

@@ -10,7 +10,7 @@ import "./App.css";
 import { DialogProvider } from "./common/use-dialogs";
 import VisualViewPortCSSVariables from "./common/VisualViewportCSSVariables";
 import { deployment, useDeployment } from "./deployment";
-import { MicrobitWebUSBConnection } from "@microbit/microbit-connection";
+import { createWebUSBConnection } from "@microbit/microbit-connection";
 import { DeviceContextProvider } from "./device/device-hooks";
 import { MockDeviceConnection } from "./device/mock";
 import DocumentationProvider from "./documentation/documentation-hooks";
@@ -40,7 +40,7 @@ const isMockDeviceMode = () =>
 const logging = deployment.logging;
 const device = isMockDeviceMode()
   ? new MockDeviceConnection()
-  : new MicrobitWebUSBConnection({ logging });
+  : createWebUSBConnection({ logging });
 
 const host = createHost(logging);
 const fs = new FileSystem(logging, host, fetchMicroPython);

src/App.tsx

@@ -15,13 +15,13 @@ import { useFileSystem } from "../fs/fs-hooks";
 import { useLogging } from "../logging/logging-hooks";
 import {
   ConnectionStatus,
-  DeviceConnection,
+  MicrobitWebUSBConnection,
   SerialDataEvent,
   ConnectionStatusEvent,
 } from "@microbit/microbit-connection";
 import { SimulatorDeviceConnection } from "./simulator";
 
-const DeviceContext = React.createContext<undefined | DeviceConnection>(
+const DeviceContext = React.createContext<undefined | MicrobitWebUSBConnection>(
   undefined
 );
 
@@ -234,7 +234,7 @@ export const DeviceContextProvider = ({
   value: device,
   children,
 }: {
-  value: DeviceConnection;
+  value: MicrobitWebUSBConnection;
   children: ReactNode;
 }) => {
   const syncStatusState = useState<SyncStatus>(SyncStatus.OUT_OF_SYNC);

src/device/device-hooks.tsx

@@ -6,7 +6,6 @@
 import {
   BoardVersion,
   ConnectionStatus,
-  DeviceConnection,
   DeviceConnectionEventMap,
   FlashDataSource,
   FlashEvent,
@@ -15,6 +14,8 @@ import {
   DeviceError,
   DeviceErrorCode,
   TypedEventTarget,
+  MicrobitWebUSBConnection,
+  SerialConnectionEventMap,
 } from "@microbit/microbit-connection";
 
 /**
@@ -25,8 +26,8 @@ import {
  * the connected state without a real device.
  */
 export class MockDeviceConnection
-  extends TypedEventTarget<DeviceConnectionEventMap>
-  implements DeviceConnection
+  extends TypedEventTarget<DeviceConnectionEventMap & SerialConnectionEventMap>
+  implements MicrobitWebUSBConnection
 {
   status: ConnectionStatus = (navigator as any).usb
     ? ConnectionStatus.NO_AUTHORIZED_DEVICE
@@ -51,6 +52,12 @@ export class MockDeviceConnection
   async initialize(): Promise<void> {}
 
   dispose() {}
+  getDeviceId(): number | undefined {
+    return undefined;
+  }
+  setRequestDeviceExclusionFilters(): void {}
+  getDevice() {}
+  async softwareReset(): Promise<void> {}
 
   async connect(): Promise<ConnectionStatus> {
     const next = this.connectResults.shift();

src/device/mock.ts

@@ -7,9 +7,10 @@ import {
   BoardVersion,
   ConnectionStatus,
   ConnectionStatusEvent,
-  DeviceConnection,
   DeviceConnectionEventMap,
   FlashEvent,
+  MicrobitWebUSBConnection,
+  SerialConnectionEventMap,
   SerialDataEvent,
   SerialResetEvent,
   TypedEventTarget,
@@ -178,8 +179,8 @@ class SimulatorEventMap extends DeviceConnectionEventMap {
  * This communicates with the iframe that is used to embed the simulator.
  */
 export class SimulatorDeviceConnection
-  extends TypedEventTarget<SimulatorEventMap>
-  implements DeviceConnection
+  extends TypedEventTarget<SimulatorEventMap & SerialConnectionEventMap>
+  implements MicrobitWebUSBConnection
 {
   status: ConnectionStatus = ConnectionStatus.NO_AUTHORIZED_DEVICE;
   state: SimulatorState | undefined;
@@ -425,4 +426,12 @@ export class SimulatorDeviceConnection
       "*"
     );
   }
+
+  getDeviceId(): number | undefined {
+    return undefined;
+  }
+  setRequestDeviceExclusionFilters(): void {}
+  async flash(): Promise<void> {}
+  getDevice() {}
+  async softwareReset(): Promise<void> {}
 }

src/device/simulator.ts

@@ -7,7 +7,7 @@ import { Text } from "@codemirror/state";
 import * as LSP from "vscode-languageserver-protocol";
 import { Action, Diagnostic } from "../lint/lint";
 import { positionToOffset } from "./positions";
-import { DeviceConnection } from "@microbit/microbit-connection";
+import { MicrobitWebUSBConnection } from "@microbit/microbit-connection";
 
 const reportMicrobitVersionApiUnsupported =
   "reportMicrobitVersionApiUnsupported";
@@ -22,7 +22,7 @@ const severityMapping = {
 export const diagnosticsMapping = (
   document: Text,
   lspDiagnostics: LSP.Diagnostic[],
-  device: DeviceConnection,
+  device: MicrobitWebUSBConnection,
   warnOnV2OnlyFeatures: boolean,
   warnOnV2OnlyFeaturesAction: () => Action
 ): Diagnostic[] =>

src/editor/codemirror/language-server/diagnostics.ts

@@ -17,7 +17,7 @@ import { autocompletion } from "./autocompletion";
 import { BaseLanguageServerView, clientFacet, uriFacet } from "./common";
 import { diagnosticsMapping } from "./diagnostics";
 import { signatureHelp } from "./signatureHelp";
-import { DeviceConnection } from "@microbit/microbit-connection";
+import { MicrobitWebUSBConnection } from "@microbit/microbit-connection";
 
 /**
  * The main extension. This synchronises the diagnostics between the client
@@ -60,7 +60,7 @@ class LanguageServerView extends BaseLanguageServerView implements PluginValue {
 
   constructor(
     view: EditorView,
-    private device: DeviceConnection,
+    private device: MicrobitWebUSBConnection,
     private intl: IntlShape,
     private warnOnV2OnlyFeatures: boolean,
     private disableV2OnlyFeaturesWarning: () => void
@@ -126,7 +126,7 @@ interface Actions {
  */
 export function languageServer(
   client: LanguageServerClient,
-  device: DeviceConnection,
+  device: MicrobitWebUSBConnection,
   uri: string,
   intl: IntlShape,
   logging: Logging,

src/editor/codemirror/language-server/view.ts

@@ -19,7 +19,7 @@ import { ActionFeedback } from "../common/use-action-feedback";
 import { Dialogs } from "../common/use-dialogs";
 import {
   ConnectionStatus,
-  DeviceConnection,
+  MicrobitWebUSBConnection,
   AfterRequestDevice,
   FlashDataError,
   DeviceError,
@@ -105,7 +105,7 @@ export enum ConnectionAction {
 export class ProjectActions {
   constructor(
     private fs: FileSystem,
-    private device: DeviceConnection,
+    private device: MicrobitWebUSBConnection,
     private actionFeedback: ActionFeedback,
     private dialogs: Dialogs,
     private setSelection: (selection: WorkbenchSelection) => void,

src/project/project-actions.tsx

@@ -3,8 +3,8 @@
  *
  * SPDX-License-Identifier: MIT
  */
+import { MicrobitWebUSBConnection } from "@microbit/microbit-connection";
 import { Terminal } from "xterm";
-import { DeviceConnection } from "@microbit/microbit-connection";
 import { Logging } from "../logging/logging";
 
 /**
@@ -13,7 +13,7 @@ import { Logging } from "../logging/logging";
 export class SerialActions {
   constructor(
     private terminal: React.RefObject<Terminal | undefined>,
-    private device: DeviceConnection,
+    private device: MicrobitWebUSBConnection,
     private onSerialSizeChange: (size: "compact" | "open") => void,
     private logging: Logging
   ) {}