Merge pull request #30 from bocoup/remove-windows

Remove support for Windows

Author: jugglinmike

.gitattributes

@@ -8,26 +8,13 @@ jobs:
 
     strategy:
       matrix:
-        os: [windows-2022, macos-14]
+        os: [macos-14]
         node-version: ['18.x']
         test-command:
           - npm run test-style
           - npm run test-types
           - npm run test-unit
           - npm run test-macos-key-press
-        exclude:
-          # The `test-style` script is platform-independent, so there is no
-          # value in executing it in multiple operating systems.
-          - os: macos-14
-            test-command: npm run test-style
-          # The `test-types` script is platform-independent, so there is no
-          # value in executing it in multiple operating systems.
-          - os: macos-14
-            test-command: npm run test-types
-          # The `test-macos-key-press` script exercises macOS platform code,
-          # making it inappropriate for Windows environments.
-          - os: windows-2022
-            test-command: npm run test-macos-key-press
 
     steps:
       - uses: actions/checkout@v4

.github/workflows/node.yaml

@@ -202,4 +202,7 @@ gallery.xml
 project.lock.json
 
 # macOS System Files
-.DS_Store
+.DS_Store
+
+# npm package archive files (as generated by the command `npm pack`)
+bocoup-macos-at-driver-server-*.tgz

.gitignore

@@ -20,7 +20,7 @@ locally (that is, without publishing it for use by others).
 ### Instructions
 
 1. Build the Xcode project
-   1. Select `Open Existing Project...` from Xcode and navigate to `/packages/macos-at-driver-server/MacOSATDriverServer/MacOSATDriverServer.xcodeproj` in your local repository
+   1. Select `Open Existing Project...` from Xcode and navigate to `src/MacOSATDriverServer/MacOSATDriverServer.xcodeproj` in your local repository
    2. With the project open, select `Product>Build` from the top-level menu
 2. Execute the following command in a terminal:
 
@@ -41,7 +41,7 @@ Repository](https://npmjs.org).
 ### Instructions
 
 1. Build the Xcode project
-   1. Select `Open Existing Project...` from Xcode and navigate to `/packages/macos-at-driver-server/MacOSATDriverServer/MacOSATDriverServer.xcodeproj` in your local repository
+   1. Select `Open Existing Project...` from Xcode and navigate to `src/MacOSATDriverServer/MacOSATDriverServer.xcodeproj` in your local repository
    2. With the project open, select `Product>Build` from the top-level menu
 2. Execute the following command in a terminal:
 

…es/macos-at-driver-server/MAINTAINING.md MAINTAINING.mdpackages/macos-at-driver-server/MAINTAINING.md renamed to MAINTAINING.md packages/macos-at-driver-server/MAINTAINING.md renamed to MAINTAINING.md

@@ -1,79 +1,38 @@
-# ARIA-AT Automation Driver
+# macOS AT Driver Server
 
-A [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket)
-server which allows clients to observe the text enunciated by a screen reader
-and to simulate user input
+An implementation of the [AT Driver](https://w3c.github.io/at-driver/) remote
+end designed to work with screen readers on macOS.
 
 **[aria-at-automation](https://github.com/w3c/aria-at-automation)** · [aria-at-automation-harness](https://github.com/w3c/aria-at-automation-harness) · aria-at-automation-driver · [aria-at-automation-results-viewer](https://github.com/w3c/aria-at-automation-results-viewer)
 
 ## Requirements
 
-- Microsoft Windows
-- [Node.js](https://nodejs.org), including "Tools for Native Modules" as
-  offered by the Node.js installer
-- [the Microsoft Visual C++
-  runtime](https://aka.ms/vs/16/release/vc_redist.x86.exe)
-
-<details>
-  <summary>note for project maintainers</summary>
-
-"Tools for Native Modules" is required to install the "robotjs" npm module,
-which is a dependency of this project.
-
-[The Visual C++ runtime includes
-`VCRUNTIME140.dll`](https://answers.microsoft.com/en-us/windows/forum/all/vcruntime140dll/fc4c0470-4db0-4e7b-9537-58ea62f8ac05),
-which is required by the automation voice.
-
-</details>
-
-## Terminology
-
-- **message** - a [JSON](https://www.json.org)-formatted string that describes
-  some occurrence of interest, emitted at the moment it occurred; the message
-  should be a JSON object value with two string properties: `type` and `data`
-- **message type** - one of `"lifecycle"`, `"speech"`, or `"error"`
-  - `"lifecycle"` - signifies that the message data is an expected lifecycle of
-    the automation voice (e.g. initialization and destruction)
-  - `"speech"` - signifies that the message data is text which a screen reader
-    has requested the operating system annunciate
-  - `"error"` - signifies that an exceptional circumstances has occurred
-- **message data** - information which refines the meaning of the message type
-
-## Protocol
-
-This project implements [AT Driver](https://w3c.github.io/at-driver/), a
-protocol published in 2024 as [a W3C Draft Community Group
-Report](https://www.w3.org/standards/types/#CG-DRAFT). That document
-exhaustively describes the JSON-encoded WebSocket protocol. Please [file a bug
-report against this
-project](https://github.com/w3c/aria-at-automation-driver/issues/new) if you
-observe any discrepencies with AT Driver.
-
-## Architecture
-
-This tool is comprised of two main components: a text-to-speech voice and a
-WebSocket server.
-
-### Text-to-speech voice
-
-The text-to-speech voice is written in C++ and integrates with the [Microsoft
-Speech API
-(SAPI)](https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ee125663(v=vs.85)).
-Because it interfaces with the Windows operating system (that is: "below" the
-screen reader in the metaphorical software stack), it can observe speech from
-many screen readers without coupling to any particular screen reader.
-
-The voice has two responsibilities. First, it emits the observed speech data
-and related events to a [Windows named
-pipe](https://docs.microsoft.com/en-us/windows/win32/ipc/named-pipes). This
-allows the second component to present a robust public interface for
-programmatic consumption of the data. (The named pipe is an implementation
-detail. Neither its content nor its presence is guaranteed, making it
-inappropriate for external use.)
-
-Second, the voice annunciates speech data. It does this by forwarding speech
-data to the system's default text-to-speech voice. This ensures that a system
-configured to use the voice remains accessible to screen reader users.
+- macOS version 13 ("Ventura") or later
+- Node.js version 18 or later
+
+## Usage
+
+1.  Run the `install` sub-command in a terminal:
+
+        at-driver install
+
+    If prompted for system administration permission, grant permission.
+
+2.  Start the server by executing the `serve` sub-command in a terminal:
+
+        at-driver serve
+
+    The process will write a message to the standard error stream when the
+    WebSocket server is listening for connections. The `--help` flag will cause
+    the command to output advanced usage instructions (e.g. `at-driver --help`).
+
+3.  Configure any screen reader to use the text-to-speech voice named "Bocoup
+    Automation Voice."
+
+4.  Use any WebSocket client to connect to the server. The protocol is described
+    below. (The server will print protocol messages to its standard error stream
+    for diagnostic purposes only. Neither the format nor the availability of
+    this output is guaranteed, making it inappropriate for external use.)
 
 ### WebSocket server
 
@@ -92,10 +51,6 @@ For details on contributing to this project, please refer to the file named
 Licensed under the terms of the MIT Expat License; the complete text is
 available in the LICENSE file.
 
-Copyright for portions of AT Driver are held by Microsoft as part of the
-"Sample Text-to-Speech Engine and MakeVoice" project. All other copyright for
-AT Driver are held by Bocoup.
-
 ---
 
 ### [aria-at-automation](https://github.com/w3c/aria-at-automation)

README.md

@@ -1,6 +1,6 @@
 'use strict';
 
-const { loadOsModule } = require('../helpers/load-os-module');
+const installation = require('../installation');
 
 module.exports = /** @type {import('yargs').CommandModule} */ ({
   command: 'install',
@@ -12,10 +12,6 @@ module.exports = /** @type {import('yargs').CommandModule} */ ({
     });
   },
   async handler({ unattended }) {
-    const installDelegate = loadOsModule('install', {
-      darwin: () => require('../install/macos'),
-      win32: () => require('../install/win32'),
-    });
-    await installDelegate.install({ unattended });
+    await installation.install({ unattended });
   },
 });

shared/bin/at-driver lib/bin/at-drivershared/bin/at-driver renamed to lib/bin/at-driver

@@ -5,7 +5,6 @@ const fs = require('fs/promises');
 const createCommandServer = require('../create-command-server');
 const createVoiceServer = require('../create-voice-server');
 
-const WINDOWS_NAMED_PIPE = '\\\\?\\pipe\\my_pipe';
 const MACOS_SYSTEM_DIR = '/tmp/at_driver_generic';
 const MACOS_SOCKET_UNIX_PATH = '/tmp/at_driver_generic/driver.socket';
 const DEFAULT_PORT = 4382;
@@ -17,18 +16,13 @@ const DEFAULT_PORT = 4382;
 const log = (...args) => console.error(new Date().toISOString(), ...args);
 
 const prepareSocketPath = async () => {
-  if (process.platform === 'win32') {
-    return WINDOWS_NAMED_PIPE;
-  } else if (process.platform === 'darwin') {
-    await fs.mkdir(MACOS_SYSTEM_DIR, { recursive: true });
-    await fs.unlink(MACOS_SOCKET_UNIX_PATH).catch(error => {
-      if (!error || error.code !== 'ENOENT') {
-        throw error;
-      }
-    });
-    return MACOS_SOCKET_UNIX_PATH;
-  }
-  throw new Error(`unsupported host platform '${process.platform}'`);
+  await fs.mkdir(MACOS_SYSTEM_DIR, { recursive: true });
+  await fs.unlink(MACOS_SOCKET_UNIX_PATH).catch(error => {
+    if (!error || error.code !== 'ENOENT') {
+      throw error;
+    }
+  });
+  return MACOS_SOCKET_UNIX_PATH;
 };
 
 module.exports = /** @type {import('yargs').CommandModule} */ ({

shared/cli.js lib/cli.jsshared/cli.js renamed to lib/cli.js

@@ -1,16 +1,12 @@
 'use strict';
 
-const { loadOsModule } = require('../helpers/load-os-module');
+const installation = require('../installation');
 
 module.exports = /** @type {import('yargs').CommandModule} */ ({
   command: 'uninstall',
   describe: 'Uninstall text to speech extension and other support',
   async handler() {
-    const installDelegate = loadOsModule('install', {
-      darwin: () => require('../install/macos'),
-      win32: () => require('../install/win32'),
-    });
-    await installDelegate.uninstall();
+    await installation.uninstall();
 
     console.log('Uninstallation completed successfully.');
   },