Release v1.4.0 (#182)

* Updated documentation for v1.4.0

* Bump to v1.4.0 - Added MacOS signing and notarization

* Fixed notarization

Author: lvcabral

.github/workflows/build.yml

@@ -43,10 +43,17 @@ jobs:
           node-version: 20
 
       - name: Build/release Electron app for macOS
+        env:
+          APPLE_ID: ${{ secrets.APPLE_ID }}
+          APPLE_PASSWORD: ${{ secrets.APPLE_PASSWORD }}
+          APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
         if: matrix.os == 'macos-latest'
         uses: johannesjo/action-electron-builder@v1
         with:
           github_token: ${{ secrets.github_token }}
+          mac_certs: ${{ secrets.mac_certs }}
+          mac_certs_password: ${{ secrets.mac_certs_password }}
+          build_script_name: "release"
           release: ${{ startsWith(github.ref, 'refs/tags/v') }}
           args: "--universal"
 
@@ -55,4 +62,5 @@ jobs:
         uses: johannesjo/action-electron-builder@v1
         with:
           github_token: ${{ secrets.github_token }}
+          build_script_name: "release"
           release: ${{ startsWith(github.ref, 'refs/tags/v') }}

.gitignore

@@ -1,4 +1,5 @@
 .vscode
+.env
 node_modules*
 .DS_Store
 Thumbs.db

CHANGELOG.md

@@ -1,14 +1,65 @@
 # Changelog
 
+<a name="v1.4.0"></a>
+
+## [v1.4.0 - Editor Improvements](https://github.com/lvcabral/brs-desktop/releases/tag/v1.4.0) - 03 Feb 2025
+
+### Release Changes
+
+* Replaced the Delete button by new code snippet tools button by [@lvcabral](https://github.com/lvcabral) in [#167](https://github.com/lvcabral/brs-desktop/pull/167)
+* Added support for ECP `launch`, `input` and `exit-app` endpoints by [@lvcabral](https://github.com/lvcabral) in [#170](https://github.com/lvcabral/brs-desktop/pull/170)
+* Added Peer Roku device menu options by [@lvcabral](https://github.com/lvcabral) in [#172](https://github.com/lvcabral/brs-desktop/pull/172)
+* Remove locales not supported on Roku by [@lvcabral](https://github.com/lvcabral) in [#173](https://github.com/lvcabral/brs-desktop/pull/173)
+* Editor: Save single snippet and alert to changes by [@lvcabral](https://github.com/lvcabral) in [#174](https://github.com/lvcabral/brs-desktop/pull/174)
+* Added editor context menu and improved change control by [@lvcabral](https://github.com/lvcabral) in [#176](https://github.com/lvcabral/brs-desktop/pull/176)
+* Removed ECP service circular dependencies by [@lvcabral](https://github.com/lvcabral) in [#177](https://github.com/lvcabral/brs-desktop/pull/177)
+* Removed Installer service circular dependencies by [@lvcabral](https://github.com/lvcabral) in [#178](https://github.com/lvcabral/brs-desktop/pull/178)
+* Removed Telnet service circular dependencies by [@lvcabral](https://github.com/lvcabral) in [#179](https://github.com/lvcabral/brs-desktop/pull/179)
+* Close app on peer Roku device when closed on simulator by [@lvcabral](https://github.com/lvcabral) in [#180](https://github.com/lvcabral/brs-desktop/pull/180)
+* Improved `roDeviceInfo.getConnectionInfo()` by getting actual network information by [@lvcabral](https://github.com/lvcabral) in [#181](https://github.com/lvcabral/brs-desktop/pull/181)
+* Upgraded `brs-engine` to [v1.8.5](https://github.com/lvcabral/brs-engine/releases/tag/v1.8.5) - main changes since last release:
+  * Implemented BrightScript features up to Roku OS 14.0 by [@lvcabral](https://github.com/lvcabral) in [#420](https://github.com/lvcabral/brs-engine/pull/420)
+  * Several Registry improvements by [@lvcabral](https://github.com/lvcabral) in [#407](https://github.com/lvcabral/brs-engine/pull/407)
+  * Several App handling/management improvements by [@lvcabral](https://github.com/lvcabral) in [#413](https://github.com/lvcabral/brs-engine/pull/413)
+  * Added `Platform` info to the result of `roDeviceInfo.getModelDetails()` by [@lvcabral](https://github.com/lvcabral) in [#414](https://github.com/lvcabral/brs-engine/pull/414)
+  * Allowed `m` object to be re-assigned in Function scope by [@lvcabral](https://github.com/lvcabral) in [#417](https://github.com/lvcabral/brs-engine/pull/417)
+  * Implemented `global` static object by [@lvcabral](https://github.com/lvcabral) in [#418](https://github.com/lvcabral/brs-engine/pull/418)
+  * Add new supported control buttons and ECP command by [@lvcabral](https://github.com/lvcabral) in [#421](https://github.com/lvcabral/brs-engine/pull/421)
+  * Fixed `CreateObject` behavior to match Roku by [@lvcabral](https://github.com/lvcabral) in [#423](https://github.com/lvcabral/brs-engine/pull/423)
+  * Implemented `roSystemLog` and refactored `roMessagePort` by [@lvcabral](https://github.com/lvcabral) in [#426](https://github.com/lvcabral/brs-engine/pull/426)
+  * Implemented `roDeviceInfoEvent` by [@lvcabral](https://github.com/lvcabral) in [#429](https://github.com/lvcabral/brs-engine/pull/429)
+  * Implement `roCECStatus` component by [@lvcabral](https://github.com/lvcabral) in [#430](https://github.com/lvcabral/brs-engine/pull/430)
+  * Add fake server support to `roChannelStore` by [@lvcabral](https://github.com/lvcabral) in [#431](https://github.com/lvcabral/brs-engine/pull/431)
+  * Fixed `Int32` constructor handling of overflow to match Roku by [@lvcabral](https://github.com/lvcabral) in [#435](https://github.com/lvcabral/brs-engine/pull/435)
+  * Added new `roDateTime` methods: `asSecondsLong` and `fromSecondsLong` by [@lvcabral](https://github.com/lvcabral) in [#437](https://github.com/lvcabral/brs-engine/pull/437)
+  * Fixed `Int32` and `Int64` hex parsing and formatting by [@lvcabral](https://github.com/lvcabral) in [#438](https://github.com/lvcabral/brs-engine/pull/438)
+  * Improved `sprintf` formatting by [@lvcabral](https://github.com/lvcabral) in [#443](https://github.com/lvcabral/brs-engine/pull/443)
+  * Improved `IfToStr` type checking by [@lvcabral](https://github.com/lvcabral) in [#449](https://github.com/lvcabral/brs-engine/pull/449)
+  * Fixed `roVideoPlayer` method `getAudioTracks` by [@lvcabral](https://github.com/lvcabral) in [#457](https://github.com/lvcabral/brs-engine/pull/457)
+  * Added `serialNumber` to device info object and to response of `GetModelDetails()`
+  * Fixed behavior of `End` statement to terminate the app
+  * Improved and documented MicroDebugger functions
+  * Improvements on WAV handling
+  * Improved component `roURLTransfer` by [@lvcabral](https://github.com/lvcabral) in [#461](https://github.com/lvcabral/brs-engine/pull/461)
+  * Implemented `roHdmiStatus` and `roHdmiStatusEvent` components by [@lvcabral](https://github.com/lvcabral) in [#463](https://github.com/lvcabral/brs-engine/pull/463)
+  * Implemented `roTextureRequest` and `roTextureManager` by [@lvcabral](https://github.com/lvcabral) in [#465](https://github.com/lvcabral/brs-engine/pull/465)
+  * Implemented `roSocketAddress` by [@lvcabral](https://github.com/lvcabral) in [#460](https://github.com/lvcabral/brs-engine/pull/460)
+  * Implemented **mocked** `roStreamSocket` component by [@lvcabral](https://github.com/lvcabral) in [#462](https://github.com/lvcabral/brs-engine/pull/462)
+  * Implemented **mocked** `roDataGramSocket` and extracted common interfaces into `ifSocket` by [@lvcabral](https://github.com/lvcabral) in [#466](https://github.com/lvcabral/brs-engine/pull/466)
+* Fixed: Some menu options were disabled when Settings is opened with app running by [@lvcabral](https://github.com/lvcabral) in [#171](https://github.com/lvcabral/brs-desktop/pull/171)
+* Bump nanoid from 3.3.7 to 5.0.9 by **@dependabot** in [#]175](https://github.com/lvcabral/brs-desktop/pull/175)
+
+[Full Changelog][v1.4.0]
+
 <a name="v1.3.2"></a>
 
 ## [v1.3.2 - Checkbox to enable/disable Peer Roku](https://github.com/lvcabral/brs-desktop/releases/tag/v1.3.2) - 12 Nov 2024
 
 ### Release Changes
 
-* Added checkbox to enable/disable peer Roku device by [@lvcabral](https://github.com/lvcabral) in [164](https://github.com/lvcabral/brs-desktop/pull/164)
-* Bump elliptic from 6.5.7 to 6.6.0 by @dependabot in [165](https://github.com/lvcabral/brs-desktop/pull/165)
-* Fixed build on MacOS by [@lvcabral](https://github.com/lvcabral) in [166](https://github.com/lvcabral/brs-desktop/pull/166)
+* Added checkbox to enable/disable peer Roku device by [@lvcabral](https://github.com/lvcabral) in [#164](https://github.com/lvcabral/brs-desktop/pull/164)
+* Bump elliptic from 6.5.7 to 6.6.0 by @dependabot in [#165](https://github.com/lvcabral/brs-desktop/pull/165)
+* Fixed build on MacOS by [@lvcabral](https://github.com/lvcabral) in [#166](https://github.com/lvcabral/brs-desktop/pull/166)
 * Changed build to generate MacOS Universal installer (for both Intel and Arm machines)
 
 [Full Changelog][v1.3.2]
@@ -19,7 +70,7 @@
 
 ### Release Changes
 
-* Implemented option to Open from URL by [@lvcabral](https://github.com/lvcabral) in [163](https://github.com/lvcabral/brs-desktop/pull/163)
+* Implemented option to Open from URL by [@lvcabral](https://github.com/lvcabral) in [#163](https://github.com/lvcabral/brs-desktop/pull/163)
   * New option in File menu that allows to download and run any app package (zip/bpk) or code file (brs)
   * The downloaded file is also executed on the peer Roku device (if configured in the settings screen)
   * Updated documentation with the new recent features
@@ -42,7 +93,7 @@
   * Implemented support for multi-dimensional indexes of `roArray` and `roList` by [@lvcabral](https://github.com/lvcabral) in [#331](https://github.com/lvcabral/brs-engine/pull/331)
   * Implemented `ObjFun()` global function and support for `variadic` arguments on `Callable` by [@lvcabral](https://github.com/lvcabral) in [#375](https://github.com/lvcabral/brs-engine/pull/375)
   * Added support for `formatJson()` undocumented flags 256 and 512 by [@lvcabral](https://github.com/lvcabral) in [#377](https://github.com/lvcabral/brs-engine/pull/377)
-  * Implemented Micro Debugger commands:  `classes`,  `bscs` and `stats` by [@lvcabral](https://github.com/lvcabral) in [#385](https://github.com/lvcabral/brs-engine/pull/385)  
+  * Implemented Micro Debugger commands:  `classes`,  `bscs` and `stats` by [@lvcabral](https://github.com/lvcabral) in [#385](https://github.com/lvcabral/brs-engine/pull/385)
   * Improvements to `roPath` by [@lvcabral](https://github.com/lvcabral) in [#296](https://github.com/lvcabral/brs-engine/pull/296)
   * Changed `roUrlEvent` and `roUniversalControlEvent` to be comparable by [@lvcabral](https://github.com/lvcabral) in [#299](https://github.com/lvcabral/brs-engine/pull/299)
   * Updated Firmware Version to 11.5 as `continue for/while` is now supported by [@lvcabral](https://github.com/lvcabral) in [#357](https://github.com/lvcabral/brs-engine/pull/357)
@@ -63,7 +114,7 @@
 
 ### Release Changes
 
-* Implemented Code Editor and Console window by [@lvcabral](https://github.com/lvcabral) in [154](https://github.com/lvcabral/brs-desktop/pull/154)
+* Implemented Code Editor and Console window by [@lvcabral](https://github.com/lvcabral) in [#154](https://github.com/lvcabral/brs-desktop/pull/154)
   * Added editor and console code based on [brs-fiddle](https://github.com/lvcabral/brs-fiddle)
   * Removed app folder from git (all files are generated from `src` now)
   * Linked code editor to main simulator display
@@ -285,6 +336,7 @@ Binaries are published at the engine library repository: <https://github.com/lvc
 
 [Changes][v0.5.0-app]
 
+[v1.4.0]: https://github.com/lvcabral/brs-desktop/compare/v1.3.2...v1.4.0
 [v1.3.2]: https://github.com/lvcabral/brs-desktop/compare/v1.3.0...v1.3.2
 [v1.3.0]: https://github.com/lvcabral/brs-desktop/compare/v1.2.0...v1.3.0
 [v1.2.0]: https://github.com/lvcabral/brs-desktop/compare/v1.1.0...v1.2.0

build/entitlements.mac.plist

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <dict>
+    <key>com.apple.security.cs.allow-dyld-environment-variables</key>
+    <true/>
+    <key>com.apple.security.cs.disable-library-validation</key>
+    <true/>
+    <key>com.apple.security.cs.allow-jit</key>
+    <true/>
+    <key>com.apple.security.cs.allow-unsigned-executable-memory</key>
+    <true/>
+    <key>com.apple.security.cs.debugger</key>
+    <true/>
+    <key>com.apple.security.network.client</key>
+    <true/>
+    <key>com.apple.security.network.server</key>
+    <true/>
+    <key>com.apple.security.files.user-selected.read-only</key>
+    <true/>
+    <key>com.apple.security.inherit</key>
+    <true/>
+    <key>com.apple.security.automation.apple-events</key>
+    <true/>
+  </dict>
+</plist>

build/notarize.mac.js

@@ -0,0 +1,21 @@
+// remove comment to build locally:
+// require('dotenv').config();
+const { notarize } = require("electron-notarize");
+
+exports.default = async function notarizing(context) {
+  const { electronPlatformName, appOutDir } = context;
+  if (electronPlatformName !== "darwin") {
+    return;
+  }
+
+  const appName = context.packager.appInfo.productFilename;
+
+  return await notarize({
+    tool: 'notarytool',
+    teamId: process.env.APPLE_TEAM_ID,
+    appBundleId: "com.lvcabral.brs-desktop.app",
+    appPath: `${appOutDir}/${appName}.app`,
+    appleId: process.env.APPLE_ID,
+    appleIdPassword: process.env.APPLE_PASSWORD,
+  });
+};

docs/build-from-source.md

@@ -6,17 +6,17 @@ To build the project you will need `NodeJS`, so you'll need to [install that fir
 
 Once that's ready, install [yarn](https://yarnpkg.com).  Installing it with `npm` is probably the simplest:
 
-```shell
+```console
 $ npm install -g yarn
 ```
 ## Setup
 1. Clone this repo:
-   ```
+   ```console
    $ git clone https://github.com/lvcabral/brs-desktop.git
    ```
 
 2. Install dependencies:
-    ```shell
+    ```console
     $ yarn install     # or just `yarn`
     ```
 
@@ -25,7 +25,7 @@ $ npm install -g yarn
 
 If you want to run the application without packaging it, for debugging, just execute:
 
-```shell
+```console
 $ yarn start
 ```
 
@@ -38,30 +38,30 @@ Below the list of available build commands for each platform:
 #### macOS 64 bits (.dmg)
 
 Run from macOS `terminal`:
-```shell
+```console
 $ yarn dist
 ```
 #### Windows 32 & 64 bits (single installer)
 
 Run from Windows `command` or `PowerShell` prompt:
-```shell
+```console
 C:\git\brs-desktop> yarn dist-win
 ```
 #### Linux 32 bits (AppImage)
 
 Run from Linux `terminal`:
-```shell
+```console
 $ yarn dist-linux32
 ```
 #### Linux 64 bits (AppImage)
 
 Run from Linux `terminal`:
-```shell
+```console
 $ yarn dist-linux64
 ```
 #### Linux 64 bits (Debian)
 
 Run from Linux `terminal`:
-```shell
+```console
 $ yarn dist-deb64
 ```

docs/control-reference.md

@@ -2,22 +2,23 @@
 
 The simulator supports by default the following mapping of the keyboard and game pads to Roku remote control:
 
-| Keyboard    | Game Pad   | Roku Control | Description                                                           |
-|-------------|------------|--------------|-----------------------------------------------------------------------|
-| Escape      |     1      |    Back      | Return to the previous screen, some apps will close at the main menu. |
-| Home        |   7 or 9   |    Home      | Close the currently loaded app.                                       |
-| Arrow Keys  |Joys & D-Pad|    D-Pad     | Directional controls to navigate on menus and control game characters.|
-| Backspace   |   6 or 8   |    Replay    | Instant replay button. Check app instructions for custom usage.       |
-| Enter       |     0      |    OK        | Select options from a menu. Check app instructions for custom usage.  |
-| * or Insert |   4 or 16  |    Info      | Open app settings. Check app instructions for custom usage.           |
-| , (comma)   |     2      |    Rewind    | Reverse scan button. Check app instructions for custom usage.         |
-| . (dot)     |     3      | Fast Forward | Forward scan button. Check app instructions for custom usage.         |
-| (space bar) |     5      |  Play/Pause  | Play/Pause button. Check app instructions for custom usage.           |
-| A           |    10      |     A        | A game buttom. Check app instructions for custom usage.               |
-| Z           |    11      |     B        | B game buttom. Check app instructions for custom usage.               |
-| F10         |    17      | Volume Mute  | Button to toggle the simulator volume mute on/off.                    |
+| Browser Keys  | Game Pad   | Roku Control  | Description                                                           |
+|---------------|    :---:   |     :---:     |-----------------------------------------------------------------------|
+| Esc/Del       |      1     |     Back      | Return to the previous screen, some apps will close at the main menu. |
+| Home/Shift+Esc|      8     |     Home      | Close the currently loaded app.                                       |
+| Arrow Keys    |D-Pad & Joys|     D-Pad     | Directional controls to navigate on menus and control games.          |
+| Backspace     |   6 or 16  |     Replay    | Instant replay button.                                                |
+| Enter         |     0      |     OK        | Select button.                                                        |
+| Insert        |   4 or 7   |     Info      | Information/Settings button                                           |
+| PageDown      |     2      |     Rewind    | Reverse scan button.                                                  |
+| PageUp        |     3      |  Fast Forward | Forward scan button.                                                  |
+| End           |   5 or 9   |  Play/Pause   | Play/Pause button.                                                    |
+| Ctrl+A        |     10     |     A         | A game button.                                                        |
+| Ctrl+Z        |     11     |     B         | B game button.                                                        |
+| F10           |     17     |  Volume Mute  | Button to toggle the simulator audio mute on/off.                     |
 
-<p align="left">
+
+<p align="center">
 <img src="images/control-reference.png?raw=true"/>
 </p>