win: improve output/user feedback capabilities

- Improve error handling.
- Provide more detailed user feedback with meaningful messages.
- Check if capability exists before performing operations.
- Inform system restart is needed.

.editorconfig

@@ -5,7 +5,3 @@ end_of_line = lf
 trim_trailing_whitespace = true
 insert_final_newline = true
 max_line_length = 100
-
-[{Dockerfile}]
-indent_style = space
-indent_size = 4

.eslintignore

@@ -0,0 +1 @@
+dist/

.eslintrc.js

@@ -6,25 +6,53 @@ module.exports = {
   root: true,
   env: {
     node: true,
-    es2022: true, // add globals and sets parserOptions.ecmaVersion to 2022
   },
   extends: [
     // Vue specific rules, eslint-plugin-vue
-    'plugin:vue/vue3-recommended',
+    // Added by Vue CLI
+    'plugin:vue/essential',
 
     // Extends eslint-config-airbnb
     '@vue/eslint-config-airbnb-with-typescript',
 
     // Extends @typescript-eslint/recommended
     // Uses the recommended rules from the @typescript-eslint/eslint-plugin
+    // Added by Vue CLI
     '@vue/typescript/recommended',
   ],
+  parserOptions: {
+    ecmaVersion: 12, // ECMA 2021
+    /*
+      Having 'latest' leads to:
+      ```
+        Parsing error: ecmaVersion must be a number. Received value of type string instead
+      ```
+      For .js files in the project
+    */
+  },
   rules: {
     ...getOwnRules(),
     ...getTurnedOffBrokenRules(),
     ...getOpinionatedRuleOverrides(),
     ...getTodoRules(),
   },
+  overrides: [
+    {
+      files: [
+        '**/__tests__/*.{j,t}s?(x)',
+        '**/tests/unit/**/*.spec.{j,t}s?(x)',
+      ],
+      env: {
+        mocha: true,
+      },
+    },
+    {
+      files: ['**/tests/**/*.{j,t}s?(x)'],
+      rules: {
+        'no-console': 'off',
+      },
+    },
+  ],
 };
 
 function getOwnRules() {

.github/actions/npm-install-dependencies/action.yml

@@ -1,12 +0,0 @@
-inputs:
-  working-directory:
-    required: false
-    default: '.'
-runs:
-  using: composite
-  steps:
-    -
-      name: Run `npm ci` with retries
-      shell: bash
-      run: npm run install-deps -- --ci
-      working-directory: ${{ inputs.working-directory }}

.github/actions/setup-node/action.yml

@@ -3,6 +3,6 @@ runs:
   steps:
     -
       name: Setup node
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v2
       with:
         node-version: 16.x

.github/workflows/checks.build.yaml

@@ -1,4 +1,4 @@
-name: checks.build
+name: build-checks
 
 on:
   push:
@@ -9,92 +9,67 @@ jobs:
     strategy:
       matrix:
         os: [ macos, ubuntu, windows ]
-        mode: [
+        mode: [ development, test, production ]
-          # Vite mode: https://vitejs.dev/guide/env-and-mode.html
-          development,  # Used by `dev` command
-          production,   # Used by `build` command
-          # Vitest mode: https://vitest.dev/guide/cli.html
-          test,         # Used by Vitest
-        ]
       fail-fast: false # Allows to see results from other combinations
     runs-on: ${{ matrix.os }}-latest
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v2
       -
         name: Setup node
         uses: ./.github/actions/setup-node
       -
         name: Install dependencies
-        uses: ./.github/actions/npm-install-dependencies
+        run: npm ci
       -
-        name: Build web
+        name: Build
         run: npm run build -- --mode ${{ matrix.mode }}
-      -
-        name: Verify web build artifacts
-        run: npm run check:verify-build-artifacts -- --web
 
+  # A new job is used due to environments/modes different from Vue CLI, https://github.com/nklayman/vue-cli-plugin-electron-builder/issues/1626
   build-desktop:
     strategy:
       matrix:
         os: [ macos, ubuntu, windows ]
-        mode: [
+        mode: [ development, production ] # "test" is not supported https://github.com/nklayman/vue-cli-plugin-electron-builder/issues/1627
-          # electron-vite modes: https://electron-vite.org/guide/env-and-mode.html#global-env-variables
-          development,  # Used by `dev` command
-          production,   # Used by `build` and `preview` commands
-        ]
       fail-fast: false # Allows to see results from other combinations
     runs-on: ${{ matrix.os }}-latest
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v2
       -
         name: Setup node
         uses: ./.github/actions/setup-node
       -
         name: Install dependencies
-        uses: ./.github/actions/npm-install-dependencies
+        run: npm ci
       -
-        name: Prebuild desktop
+        name: Install cross-env
-        run: npm run electron:prebuild -- --mode ${{ matrix.mode }}
+        # Used to set NODE_ENV due to https://github.com/nklayman/vue-cli-plugin-electron-builder/issues/1626
+        run: npm install --global cross-env
       -
-        name: Verify unbundled desktop build artifacts
+        name: Build
-        run: npm run check:verify-build-artifacts -- --electron-unbundled
+        run: |-  
-      -
+          cross-env-shell NODE_ENV=${{ matrix.mode }}
-        name: Build (bundle and package) desktop application
+          npm run electron:build -- --publish never --mode ${{ matrix.mode }}
-        run: npm run electron:build -- --publish never
-      -
-        name: Verify bundled desktop build artifacts
-        run: npm run check:verify-build-artifacts -- --electron-bundled
 
-  build-docker:
+  create-icons:
     strategy:
       matrix:
-        os: [ macos, ubuntu ] # Windows runners do not support Linux containers
+        os: [ macos, ubuntu, windows ]
       fail-fast: false # Allows to see results from other combinations
     runs-on: ${{ matrix.os }}-latest
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v2
       -
-        name: Install Docker on macOS
+        name: Setup node
-        if: matrix.os == 'macos' # macOS runner is missing Docker
+        uses: ./.github/actions/setup-node
-        run: |-
-          # Install Docker
-          brew install docker
-          # Docker on macOS misses daemon due to licensing, so install colima as runtime
-          brew install colima
-          # Start the daemon
-          colima start
       -
-        name: Build Docker image
+        name: Install dependencies
-        run: docker build -t undergroundwires/privacy.sexy:latest .
+        run: npm ci
       -
-        name: Run Docker image on port 8080
+        name: Create icons
-        run: docker run -d -p 8080:80 --rm --name privacy.sexy undergroundwires/privacy.sexy:latest
+        run: npm run create-icons
-      -
-        name: Check server is up and returns HTTP 200
-        run: node ./scripts/verify-web-server-status.js --url http://localhost:8080

.github/workflows/checks.desktop-runtime-errors.yaml

@@ -1,72 +0,0 @@
-name: checks.desktop-runtime-errors
-# Verifies desktop builds for Electron applications across multiple OS platforms (macOS ,Ubuntu, and Windows).
-
-on:
-  push:
-  pull_request:
-
-jobs:
-  run-check:
-    strategy:
-      matrix:
-        os: [ macos, ubuntu, windows ]
-      fail-fast: false # Allows to see results from other combinations
-    runs-on: ${{ matrix.os }}-latest
-    steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v4
-      -
-        name: Setup node
-        uses: ./.github/actions/setup-node
-      -
-        name: Install dependencies
-        uses: ./.github/actions/npm-install-dependencies
-      -
-        name: Configure Ubuntu
-        if: matrix.os == 'ubuntu'
-        shell: bash
-        run: |-
-          sudo apt update
-
-          # Configure AppImage dependencies
-          sudo apt install -y libfuse2
-
-          # Configure DBUS (fixes `Failed to connect to the bus: Could not parse server address: Unknown address type`)
-           if ! command -v 'dbus-launch' &> /dev/null; then
-            echo 'DBUS does not exist, installing...'
-            sudo apt install -y dbus-x11 # Gives both dbus and dbus-launch utility
-          fi
-          sudo systemctl start dbus
-          DBUS_LAUNCH_OUTPUT=$(dbus-launch)
-          if [ $? -eq 0 ]; then
-            echo "${DBUS_LAUNCH_OUTPUT}" >> $GITHUB_ENV
-          else
-            echo 'Error: dbus-launch command did not execute successfully. Exiting.' >&2
-            echo "${DBUS_LAUNCH_OUTPUT}" >&2
-            exit 1
-          fi
-
-          # Configure fake (virtual) display
-          sudo apt install -y xvfb
-          sudo Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
-          echo "DISPLAY=:99" >> $GITHUB_ENV
-
-          # Install ImageMagick for screenshots
-          sudo apt install -y imagemagick
-
-          # Install xdotool and xprop (from x11-utils) for window title capturing
-          sudo apt install -y xdotool x11-utils
-      -
-        name: Test
-        shell: bash
-        run: |-
-          export SCREENSHOT=true
-          npm run check:desktop
-      -
-        name: Upload screenshot
-        if: always() # Run even if previous step fails
-        uses: actions/upload-artifact@v3
-        with:
-          name: screenshot-${{ matrix.os }}
-          path: screenshot.png

.github/workflows/checks.external-urls.yaml

@@ -1,22 +0,0 @@
-name: checks.external-urls
-
-on:
-  schedule:
-    - cron: '0 0 * * 0' # at 00:00 on every Sunday
-
-jobs:
-  run-check:
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v4
-      -
-        name: Setup node
-        uses: ./.github/actions/setup-node
-      -
-        name: Install dependencies
-        uses: ./.github/actions/npm-install-dependencies
-      -
-        name: Test
-        run: npm run check:external-urls

.github/workflows/checks.quality.yaml

@@ -16,15 +16,11 @@ jobs:
         os: [ macos, ubuntu, windows ]
       fail-fast: false # Still interested to see results from other combinations
     steps:
-      -
+      - name: Checkout
-        name: Checkout
+        uses: actions/checkout@v2
-        uses: actions/checkout@v4
+      - name: Setup node
-      -
-        name: Setup node
         uses: ./.github/actions/setup-node
-      -
+      - name: Install dependencies
-        name: Install dependencies
+        run: npm ci
-        uses: ./.github/actions/npm-install-dependencies
+      - name: Lint
-      -
-        name: Lint
         run: ${{ matrix.lint-command }}

.github/workflows/checks.scripts.yaml

@@ -1,55 +0,0 @@
-name: checks.scripts
-
-on:
-  push:
-  pull_request:
-
-jobs:
-  icons-build:
-    runs-on: ${{ matrix.os }}-latest
-    strategy:
-      matrix:
-        os: [ macos, ubuntu, windows ]
-      fail-fast: false # Still interested to see results from other combinations
-    steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v4
-      -
-        name: Setup node
-        uses: ./.github/actions/setup-node
-      -
-        name: Install dependencies
-        uses: ./.github/actions/npm-install-dependencies
-      -
-        name: Create icons
-        run: npm run icons:build
-
-  install-deps:
-    runs-on: ${{ matrix.os }}-latest
-    strategy:
-      matrix:
-        install-deps-before: [true, false]
-        install-command:
-          - npm run install-deps
-          - npm run install-deps -- --no-errors
-          - npm run install-deps -- --ci
-          - npm run install-deps -- --fresh --non-deterministic
-          - npm run install-deps -- --fresh
-          - npm run install-deps -- --non-deterministic
-        os: [ macos, ubuntu, windows ]
-      fail-fast: false # Still interested to see results from other combinations
-    steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v4
-      -
-        name: Setup node
-        uses: ./.github/actions/setup-node
-      -
-        name: Install dependencies
-        if: matrix.install-deps-before == true
-        uses: ./.github/actions/npm-install-dependencies
-      -
-        name: Run install-deps
-        run: ${{ matrix.install-command }}

.github/workflows/checks.security.sast.yaml

@@ -1,42 +0,0 @@
-name: checks.security.sast
-
-on:
-  push:
-  pull_request:
-  schedule:
-    - cron: '0 0 * * 0' # at 00:00 on every Sunday
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [
-          javascript # analyzes code written in JavaScript, TypeScript and both.
-        ]
-
-    steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v4
-      -
-        name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
-        with:
-          languages: ${{ matrix.language }}
-          queries: +security-and-quality
-      -
-        name: Autobuild
-        uses: github/codeql-action/autobuild@v2
-      -
-        name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
-        with:
-          category: "/language:${{ matrix.language }}"

.github/workflows/checks.security.yaml

@@ -1,4 +1,4 @@
-name: checks.security.dependencies
+name: security-checks
 
 on:
   push:
@@ -13,10 +13,10 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v2
       -
         name: Setup node
         uses: ./.github/actions/setup-node
       -
         name: NPM audit
-        run:  npm audit --omit=dev
+        run: exit "$(npm audit)" # Since node 15.x, it does not fail with error if we don't explicitly exit

.github/workflows/release.desktop.yaml

@@ -13,29 +13,20 @@ jobs:
       fail-fast: false # So publish runs for other OSes if one fails
     runs-on: ${{ matrix.os }}-latest
     steps:
-      -
+      - uses: actions/checkout@v2
-        uses: actions/checkout@v4
         with:
           ref: master # otherwise it defaults to the version tag missing bump commit
           fetch-depth: 0 # fetch all history
-      -
+      - name: Checkout to bump commit
-        name: Checkout to bump commit
         run: git checkout "$(git rev-list "${{ github.event.release.tag_name }}"..master | tail -1)"
-      -
+      - name: Setup node
-        name: Setup node
         uses: ./.github/actions/setup-node
-      -
+      - name: Install dependencies
-        name: Install dependencies
+        run: npm ci
-        uses: ./.github/actions/npm-install-dependencies
+      - name: Run unit tests
-      -
-        name: Run unit tests
         run: npm run test:unit
-      -
+      - name: Publish desktop app
-        name: Prebuild
+        run: npm run electron:build -- -p always # https://nklayman.github.io/vue-cli-plugin-electron-builder/guide/recipes.html#upload-release-to-github
-        run: npm run electron:prebuild
-      -
-        name: Build and publish
-        run: npm run electron:build -- --publish always
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           EP_GH_IGNORE_TIME: true # Otherwise publishing fails if GitHub release is more than 2 hours old https://github.com/electron-userland/electron-builder/issues/2074

.github/workflows/release.site.yaml

@@ -10,7 +10,7 @@ jobs:
     steps:
       -
         name: "Infrastructure: Checkout"
-        uses: actions/checkout@v4
+        uses: actions/checkout@v2
         with:
           path: aws
           repository: undergroundwires/aws-static-site-with-cd
@@ -75,7 +75,7 @@ jobs:
         working-directory: aws
       -
         name: "App: Checkout"
-        uses: actions/checkout@v4
+        uses: actions/checkout@v2
         with:
           path: app
           ref: master # otherwise we don't get version bump commit
@@ -84,8 +84,7 @@ jobs:
         uses: ./app/.github/actions/setup-node
       -
         name: "App: Install dependencies"
-        uses: ./app/.github/actions/npm-install-dependencies
+        run: npm ci
-        with:
         working-directory: app
       -
         name: "App: Run unit tests"
@@ -95,21 +94,11 @@ jobs:
         name: "App: Build"
         run: npm run build
         working-directory: app
-      -
-        name: "App: Verify web build artifacts"
-        run: npm run check:verify-build-artifacts -- --web
-        working-directory: app
       -
         name: "App: Deploy to S3"
-        shell: bash
+        run: >-
-        run: |-
-          declare web_output_dir
-          if ! web_output_dir=$(cd app && node scripts/print-dist-dir.js --web); then
-            echo 'Error: Could not determine distribution directory.'
-            exit 1
-          fi
           bash "aws/scripts/deploy/deploy-to-s3.sh" \
-            --folder "${web_output_dir}" \
+            --folder app/dist \
             --web-stack-name privacysexy-web-stack --web-stack-s3-name-output-name S3BucketName \
             --storage-class ONEZONE_IA \
             --role-arn ${{secrets.AWS_S3_SITE_DEPLOYMENT_ROLE_ARN}} \

.github/workflows/tests.e2e.yaml

@@ -14,51 +14,13 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v2
       -
         name: Setup node
         uses: ./.github/actions/setup-node
       -
         name: Install dependencies
-        uses: ./.github/actions/npm-install-dependencies
+        run: npm ci
       -
         name: Run e2e tests
-        run: npm run test:cy:run
+        run: npm run test:e2e -- --headless
-      -
-        name: Output artifact directories
-        id: artifacts
-        if: always() # Run even if previous steps fail because test run video is always captured
-        shell: bash
-        run: |-
-          declare -r dirs_json_file='cypress-dirs.json'
-          if [ ! -f "${dirs_json_file}" ]; then
-            echo "${dirs_json_file} does not exist"
-            exit 1
-          fi
-
-          SCREENSHOTS_DIR=$(jq -r '.screenshots' "${dirs_json_file}")
-          VIDEOS_DIR=$(jq -r '.videos' "${dirs_json_file}")
-
-          for dir in "${SCREENSHOTS_DIR}" "${VIDEOS_DIR}"; do
-            if [ "${dir}" = 'null' ] || [ -z "${dir}" ]; then
-              echo "One or more directories are null or not specified in cypress-dirs.json"
-              exit 1
-            fi
-          done
-
-          echo "SCREENSHOTS_DIR=${SCREENSHOTS_DIR}" >> "${GITHUB_OUTPUT}"
-          echo "VIDEOS_DIR=${VIDEOS_DIR}" >> "${GITHUB_OUTPUT}"
-      -
-        name: Upload screenshots
-        if: failure() # Run only if previous steps fail because screenshots will be generated only if E2E test failed
-        uses: actions/upload-artifact@v3
-        with:
-          name: e2e-screenshots-${{ matrix.os }}
-          path: ${{ steps.artifacts.outputs.SCREENSHOTS_DIR }}
-      -
-        name: Upload videos
-        if: always() # Run even if previous steps fail because test run video is always captured
-        uses: actions/upload-artifact@v3
-        with:
-          name: e2e-videos-${{ matrix.os }}
-          path: ${{ steps.artifacts.outputs.VIDEOS_DIR }}

.github/workflows/tests.integration.yaml

@@ -16,13 +16,13 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v2
       -
         name: Setup node
         uses: ./.github/actions/setup-node
       -
         name: Install dependencies
-        uses: ./.github/actions/npm-install-dependencies
+        run: npm ci
       -
         name: Run integration tests
         run: npm run test:integration

.github/workflows/tests.unit.yaml

@@ -14,13 +14,13 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v2
       -
         name: Set-up node
         uses: ./.github/actions/setup-node
       -
         name: Install dependencies
-        uses: ./.github/actions/npm-install-dependencies
+        run: npm ci
       -
         name: Run unit tests
         run: npm run test:unit

.gitignore

@@ -1,13 +1,10 @@
-# Application build artifacts
-/dist-*/
-
-# npm
 node_modules
-
+dist/
-# Visual Studio Code
+.vs
 .vscode/**/*
 !.vscode/extensions.json
-
+#Electron-builder output
-# draw.io
+/dist_electron
-*.bkp
+# Cypress
-*.dtmp
+/tests/e2e/screenshots
+/tests/e2e/videos

.vscode/extensions.json

@@ -11,8 +11,8 @@
     "dbaeumer.vscode-eslint",           // Lints JavaScript/TypeScript.
     "pmneo.tsimporter",                 // Provides better auto-complete for TypeScripts imports.
     // Vue
-    "Vue.volar",                        // Official Vue extensions
+    "jcbuisson.vue",                    // Highlights syntax.
-    "Vue.vscode-typescript-vue-plugin", // Official TypeScript Vue Plugin
+    "octref.vetur",                     // Adds Vetur, Vue tooling support.
     // Scripting
     "timonwong.shellcheck",             // Lints bash files.
     "ms-vscode.powershell",             // Lints PowerShell files.

CHANGELOG.md

@@ -1,125 +1,5 @@
 # Changelog
 
-## 0.12.7 (2023-11-07)
-
-* Add winget download instructions | [b2ffc90](https://github.com/undergroundwires/privacy.sexy/commit/b2ffc90da70367b9e65c82556e8f440f865ceb98)
-* Fix unresponsive copy button on instructions modal | [8ccaec7](https://github.com/undergroundwires/privacy.sexy/commit/8ccaec7af6ea3ecfd46bab5c13b90f71d55e32c1)
-* Fix tree node check states not being updated | [af7219f](https://github.com/undergroundwires/privacy.sexy/commit/af7219f6e12ab4a65ce07190f691cf3234e87e35)
-
-[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.6...0.12.7)
-
-## 0.12.6 (2023-11-03)
-
-* Bump dependencies to latest | [25d7f7b](https://github.com/undergroundwires/privacy.sexy/commit/25d7f7b2a479e51e092881cc2751e67a7d3f179f)
-* win: improve system app uninstall cleanup #73 | [dbe3c5c](https://github.com/undergroundwires/privacy.sexy/commit/dbe3c5cfb91ba8a1657838b69117858843c8fbc8)
-* win: improve system app uninstall /w fallback #260 | [98a26f9](https://github.com/undergroundwires/privacy.sexy/commit/98a26f9ae47af2668aa53f39d1768983036048ce)
-* Improve performance of rendering during search | [79b46bf](https://github.com/undergroundwires/privacy.sexy/commit/79b46bf21004d96d31551439e5db5d698a3f71f3)
-* Fix YAML error for site release in CI/CD | [237d994](https://github.com/undergroundwires/privacy.sexy/commit/237d9944f900f5172366868d75219224ff0542b0)
-* win: fix Microsoft Advertising app removal #200 | [e40b9a3](https://github.com/undergroundwires/privacy.sexy/commit/e40b9a3cf53c341f2e84023a9f0e9680ac08f3fa)
-* win: improve directory cleanup security | [060e789](https://github.com/undergroundwires/privacy.sexy/commit/060e7896624309aebd25e8b190c127282de177e8)
-* Centralize Electron entry file path configuration | [d6da406](https://github.com/undergroundwires/privacy.sexy/commit/d6da406c61e5b9f5408851d1302d6d7398157a2e)
-* win: prevent updates from reinstalling apps #260 | [8570b02](https://github.com/undergroundwires/privacy.sexy/commit/8570b02dde14ffad64863f614682c3fc1f87b6c2)
-* win: improve script environment robustness #221 | [dfd4451](https://github.com/undergroundwires/privacy.sexy/commit/dfd44515613f38abe5a806bda36f44e7b715b50b)
-* Fix compiler failing with nested `with` expression | [80821fc](https://github.com/undergroundwires/privacy.sexy/commit/80821fca0769e5fd2c6338918fbdcea12fbe83d2)
-* win: improve soft file/app delete security #260 | [f4a74f0](https://github.com/undergroundwires/privacy.sexy/commit/f4a74f058db9b5bcbcbe438785db5ec88ecc1657)
-* Fix incorrect tooltip position after window resize | [f8e5f1a](https://github.com/undergroundwires/privacy.sexy/commit/f8e5f1a5a2afa1f18567e6d965359b6a1f082367)
-* linux: fix string formatting of Firefox configs | [e775d68](https://github.com/undergroundwires/privacy.sexy/commit/e775d68a9b4a5f9e893ff0e3500dade036185193)
-* win: improve file delete | [e72c1c1](https://github.com/undergroundwires/privacy.sexy/commit/e72c1c13ea2d73ebfc7a8da5a21254fdfc0e5b59)
-* win: change system app removal to hard delete #260 | [77123d8](https://github.com/undergroundwires/privacy.sexy/commit/77123d8c929d23676a9cb21d7b697703fd1b6e82)
-* Improve UI performance by optimizing reactivity | [4995e49](https://github.com/undergroundwires/privacy.sexy/commit/4995e49c469211404dac9fcb79b75eb121f80bce)
-* Migrate to Vue 3.0 #230 | [ca81f68](https://github.com/undergroundwires/privacy.sexy/commit/ca81f68ff1c3bbe5b22981096ae9220b0b5851c7)
-* win, linux: unify & improve Firefox clean-up #273 | [0466b86](https://github.com/undergroundwires/privacy.sexy/commit/0466b86f1013341c966a9bbf6513990337b16598)
-* win: fix store revert for multiple installs #260 | [5bb13e3](https://github.com/undergroundwires/privacy.sexy/commit/5bb13e34f8de2e2a7ba943ff72b12c0569435e62)
-
-[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.5...0.12.6)
-
-## 0.12.5 (2023-10-13)
-
-* Fix Docker build and improve checks #220 | [7669985](https://github.com/undergroundwires/privacy.sexy/commit/7669985f8e1446e726a95626ecf35b3ce6b60a16)
-* Add SAST security checks with SECURITY.md #178 | [3e5239f](https://github.com/undergroundwires/privacy.sexy/commit/3e5239f7d35e57749c01adf3dbbcd365aebb39c8)
-* Add Scoop download instructions #174 | [cf55ca9](https://github.com/undergroundwires/privacy.sexy/commit/cf55ca9e28b064fa7a516077a9da23e3a8e3f534)
-* win: fix and improve temp dir cleanup #176, #89 | [d457504](https://github.com/undergroundwires/privacy.sexy/commit/d45750428cca010daf2721b33a8ae3a01b28813b)
-* win, linux: improve VSCode setting robustness #196 | [e8a52f7](https://github.com/undergroundwires/privacy.sexy/commit/e8a52f717dc799b34ceeb1c27c2b8219391dff6a)
-* linux: fix obsolete Firefox DPI script #239 | [e5f6edf](https://github.com/undergroundwires/privacy.sexy/commit/e5f6edf405bcec7c29ea4d7932d1910620fa15f8)
-* win: add removal of Edge assocations #64 | [888c916](https://github.com/undergroundwires/privacy.sexy/commit/888c9166fc66a2094137fa8be739cc21bafef5f6)
-* win: improve Edge & OneDrive shortcut removal #73 | [8501495](https://github.com/undergroundwires/privacy.sexy/commit/8501495c170af61913288a63dbd369db5bbc5003)
-* win: relocate and document SecHealthUI #190 | [2862951](https://github.com/undergroundwires/privacy.sexy/commit/286295128d0179358e0c6b7b6415d752175a1aed)
-* Add developer toolkit UI component | [2147eae](https://github.com/undergroundwires/privacy.sexy/commit/2147eae687b82d05bc43bb4605d9068f148bb92a)
-* win: fix and improve network data usage reset #265 | [5e359c2](https://github.com/undergroundwires/privacy.sexy/commit/5e359c2fb82a08e6acf7159b70ca86a8234b359b)
-* win: improve app reversion and docs #260 | [a3f11df](https://github.com/undergroundwires/privacy.sexy/commit/a3f11dff187c821a00910c20dac05e285cda9073)
-* Fix working directory in CI/CD web release | [698b570](https://github.com/undergroundwires/privacy.sexy/commit/698b570ee6e300d6703015464f4345b5e706f1cb)
-* Implement new UI component for icons #230 | [48730bc](https://github.com/undergroundwires/privacy.sexy/commit/48730bca0506120bca4bf3a23545d59f2b1a9009)
-* win: fix and improve AppCompat disabling #255 | [bab6316](https://github.com/undergroundwires/privacy.sexy/commit/bab6316e7625230cf4a4cf67c3aca417347db75c)
-* win, linux, mac: fix typos and improve naming | [67c3677](https://github.com/undergroundwires/privacy.sexy/commit/67c3677621b201525a813e8a26f07d607176e89b)
-
-[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.4...0.12.5)
-
-## 0.12.4 (2023-09-25)
-
-* win: fix Windows spotlight revert, docs, recommend | [659fea7](https://github.com/undergroundwires/privacy.sexy/commit/659fea7afcabcd0ea273cfdcc8c4bae190c126f3)
-* win: fix Edge telemetry disabling for v116+ #242 | [6d301f9](https://github.com/undergroundwires/privacy.sexy/commit/6d301f99616ed49975876803d0098eafe4d3cb2e)
-* win: fix, improve disabling automatic updates #252 | [6e9b65d](https://github.com/undergroundwires/privacy.sexy/commit/6e9b65d8b1b481c1471dde90876c37838b4ac4e5)
-* win: refactor `update.mode` key for VSCode #215 | [c27172c](https://github.com/undergroundwires/privacy.sexy/commit/c27172c32e7c316b7cb0f44cab611eed89ca034e)
-* Fix wrong action path in website CI deployment | [a1f2497](https://github.com/undergroundwires/privacy.sexy/commit/a1f24973813ccbdd7e1f06c64e1912a991a6bb64)
-* Fix compiler bug with nested optional arguments | [53222fd](https://github.com/undergroundwires/privacy.sexy/commit/53222fd83c2846089746a217482195806f960d18)
-* Fix no spacing after lists in documentation text | [f810ed0](https://github.com/undergroundwires/privacy.sexy/commit/f810ed0c147c2a46cae3b70b635ed81128646fff)
-* Rewrite tooltip UI for efficiency and Vue 3.0 #230 | [8b930fc](https://github.com/undergroundwires/privacy.sexy/commit/8b930fc57c8ee6691ed6165bcb27d97e64a1a0c0)
-* win: fix uninstallation of newer Edge #236 | [60dde11](https://github.com/undergroundwires/privacy.sexy/commit/60dde11311a2409537f5965f370b0daaaec53339)
-* win: fix delivery optimization side-effects #173 | [203daeb](https://github.com/undergroundwires/privacy.sexy/commit/203daeb4a2fca0a0295cbc2a736394f9f87725e6)
-* win: fix Defender scan artifacts removal #246 | [cb21a97](https://github.com/undergroundwires/privacy.sexy/commit/cb21a970b6b867e1476a5eb8a72b9a7fdd53a744)
-* Fix outdated and broken links in README #161 | [0303ef2](https://github.com/undergroundwires/privacy.sexy/commit/0303ef2fd98b36306523e2a0c5f5ae812a4c6c99)
-* Fix loss of tree node state when switching views | [8f188ac](https://github.com/undergroundwires/privacy.sexy/commit/8f188acd3c2d93e40c89569c74bc5cff992f0052)
-* Fix slow appearance of nodes on tree view | [bd2082e](https://github.com/undergroundwires/privacy.sexy/commit/bd2082e8c574db065bb4462f30ea3ace2cb028cb)
-
-[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.3...0.12.4)
-
-## 0.12.3 (2023-09-09)
-
-* linux: use user.js over prefs.js for Firefox #232 | [dae6d11](https://github.com/undergroundwires/privacy.sexy/commit/dae6d114daab6857d773071211eb57619b136281)
-* win: fix typo in Defender retention script #213 | [35be05d](https://github.com/undergroundwires/privacy.sexy/commit/35be05df2094ea8bba4ee4725e6fa4956a79493d)
-* Improve desktop runtime execution tests | [ad0576a](https://github.com/undergroundwires/privacy.sexy/commit/ad0576a752f8fd6ea2f917a59173fe61f9951246)
-* Fix Windows artifact naming in desktop packaging | [f4d86fc](https://github.com/undergroundwires/privacy.sexy/commit/f4d86fccfd0e73e94c8c6e400a33514900bc5abe)
-* Refactor and improve external URL checks | [19e42c9](https://github.com/undergroundwires/privacy.sexy/commit/19e42c9c52a18c813ded4265e687e01032cdd4c8)
-* Fix memory leaks via auto-unsubscribing and DI | [eb096d0](https://github.com/undergroundwires/privacy.sexy/commit/eb096d07e276e1b4c8040220c47f186d02841e14)
-* Refactor build configs and improve CI/CD checks | [0a2a1a0](https://github.com/undergroundwires/privacy.sexy/commit/0a2a1a026b0efb29624be82b06536c518c1ea439)
-* Introduce retry mechanism for npm install in CI/CD | [4beb1bb](https://github.com/undergroundwires/privacy.sexy/commit/4beb1bb5748a60886210187ca3cdc7f4b41067c0)
-* win: fix disable recent apps revert #211, #248 | [4ce327e](https://github.com/undergroundwires/privacy.sexy/commit/4ce327eb6af542ed2916d649553e5e1ba5833882)
-* Change license to AGPLv3 | [821cc62](https://github.com/undergroundwires/privacy.sexy/commit/821cc62c4c8347cb76d041f82f574754e4d948c5)
-* Introduce new TreeView UI component | [65f121c](https://github.com/undergroundwires/privacy.sexy/commit/65f121c451af87315e1c91df4198562e0445b2c2)
-
-[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.2...0.12.3)
-
-## 0.12.2 (2023-08-25)
-
-* Add automated checks for desktop app runtime #233 | [04b3133](https://github.com/undergroundwires/privacy.sexy/commit/04b3133500485d0d278a81a177a1677134131405)
-* win: fix automatic updates revert #234 | [0873769](https://github.com/undergroundwires/privacy.sexy/commit/08737698c2283bdf535d1611a730031ebfc7c0df)
-* Migrate unit/integration tests to Vitest with Vite | [5f11c8d](https://github.com/undergroundwires/privacy.sexy/commit/5f11c8d98f782dd7c77f27649a1685fb7bd06e13)
-* Remove Vue ESLint plugin for Vite compatibility | [6e40edd](https://github.com/undergroundwires/privacy.sexy/commit/6e40edd3f8a063c1b7482c27d8368e14c2fbcfbf)
-* Migrate web builds from Vue CLI to Vite | [7365905](https://github.com/undergroundwires/privacy.sexy/commit/736590558be51a09435bb87e78b6655e8533bc2e)
-* Migrate Cypress (E2E) tests to Vite and TypeScript | [ec98d84](https://github.com/undergroundwires/privacy.sexy/commit/ec98d8417f779fa818ccdda6bb90f521e1738002)
-* Migrate to `electron-vite` and `electron-builder` | [75c9b51](https://github.com/undergroundwires/privacy.sexy/commit/75c9b51bf2d1dc7269adfd7b5ed71acfb5031299)
-* Fix searching/filtering bugs #235 | [62f8bfa](https://github.com/undergroundwires/privacy.sexy/commit/62f8bfac2f481c93598fe19a51594769f522d684)
-* Improve desktop security by isolating Electron | [e9e0001](https://github.com/undergroundwires/privacy.sexy/commit/e9e0001ef845fa6935c59a4e20a89aac9e71756a)
-
-[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.1...0.12.2)
-
-## 0.12.1 (2023-08-17)
-
-* Transition to eslint-config-airbnb-with-typescript | [ff84f56](https://github.com/undergroundwires/privacy.sexy/commit/ff84f5676e496dd7ec5b3599e34ec9627d181ea2)
-* Improve user privacy with secure outbound links | [3a594ac](https://github.com/undergroundwires/privacy.sexy/commit/3a594ac7fd708dc1e98155ffb9b21acd4e1fcf2d)
-* Refactor Vue components using Composition API #230 | [1b9be8f](https://github.com/undergroundwires/privacy.sexy/commit/1b9be8fe2d72d8fb5cf1fed6dcc0b9777171aa98)
-* Fix failing security tests | [3bc8da4](https://github.com/undergroundwires/privacy.sexy/commit/3bc8da4cbf1e2bd758dc3fffe4b1e62dc3beb7b3)
-* Improve Defender scripts #201 | [061afad](https://github.com/undergroundwires/privacy.sexy/commit/061afad9673a41454c2421c318898f2b4f4cf504)
-* Fix failing tests due to failed error logging | [986ba07](https://github.com/undergroundwires/privacy.sexy/commit/986ba078a643de6acbee50fff9cf77494ca7ea7f)
-* Implement custom lightweight modal #230 | [9e5491f](https://github.com/undergroundwires/privacy.sexy/commit/9e5491fdbf2d9d40d974f5ad0e879a6d5c6d1e55)
-* Refactor usage of tooltips for flexibility | [bc91237](https://github.com/undergroundwires/privacy.sexy/commit/bc91237d7c54bdcd15c5c39a55def50d172bb659)
-* Fix revert toggle partial rendering | [39e650c](https://github.com/undergroundwires/privacy.sexy/commit/39e650cf110bee6b1b21d9b2902b36b0e2568d54)
-* Increase testability through dependency injection | [ae75059](https://github.com/undergroundwires/privacy.sexy/commit/ae75059cc14db41f55dd2056f528442c7d319dd2)
-* Refactor filter (search query) event handling | [6a20d80](https://github.com/undergroundwires/privacy.sexy/commit/6a20d804dc365d22c1248d787f9912271f508eeb)
-* Migrate to ES6 modules | [a14929a](https://github.com/undergroundwires/privacy.sexy/commit/a14929a13cc6260b514692d9b4f1cdf5fb85d8b2)
-
-[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.0...0.12.1)
-
 ## 0.12.0 (2023-08-03)
 
 * Improve script/category name validation | [b210aad](https://github.com/undergroundwires/privacy.sexy/commit/b210aaddf26629179f77fe19f62f65d8a0ca2b87)

CONTRIBUTING.md

@@ -43,7 +43,6 @@ You have two alternatives:
 
 1. [Create an issue](https://github.com/undergroundwires/privacy.sexy/issues/new/choose) and ask for someone else to add the script for you.
 2. Or send a PR yourself. This would make it faster to get your code into the project. You need to add scripts to related OS in [collections](src/application/collections/) folder. Then you'd sent a pull request, see [pull request process](#pull-request-process).
-   - 💡 You should use existing shared functions for most of the operations, like `DisableService` for disabling services, to maintain code consistency and efficiency.
    - 📖 If you're unsure about the syntax, check [collection-files.md](docs/collection-files.md).
    - 📖 If you wish to use templates, use [templating.md](./docs/templating.md).
 

Dockerfile

@@ -1,16 +1,13 @@
 # Build
-FROM node:lts-alpine AS build-stage
+FROM node:lts-alpine as build-stage
 WORKDIR /app
+COPY package*.json ./
+RUN npm install
 COPY . .
-RUN npm run install-deps
+RUN npm run build
-RUN npm run build \
-    && npm run check:verify-build-artifacts -- --web
-RUN mkdir /dist \
-    && dist_directory=$(node 'scripts/print-dist-dir.js' --web) \
-    && cp -a "${dist_directory}/." '/dist'
 
 # Production stage
-FROM nginx:stable-alpine AS production-stage
+FROM nginx:stable-alpine as production-stage
-COPY --from=build-stage /dist /usr/share/nginx/html
+COPY --from=build-stage /app/dist /usr/share/nginx/html
 EXPOSE 80
 CMD ["nginx", "-g", "daemon off;"]

LICENSE

@@ -1,5 +1,5 @@
-                    GNU AFFERO GENERAL PUBLIC LICENSE
+                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 19 November 2007
+                       Version 3, 29 June 2007
 
  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
@@ -7,15 +7,17 @@
 
                             Preamble
 
-  The GNU Affero General Public License is a free, copyleft license for
+  The GNU General Public License is a free, copyleft license for
-software and other kinds of works, specifically designed to ensure
+software and other kinds of works.
-cooperation with the community in the case of network server software.
 
   The licenses for most software and other practical works are designed
 to take away your freedom to share and change the works.  By contrast,
-our General Public Licenses are intended to guarantee your freedom to
+the GNU General Public License is intended to guarantee your freedom to
 share and change all versions of a program--to make sure it remains free
-software for all its users.
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
 
   When we speak of free software, we are referring to freedom, not
 price.  Our General Public Licenses are designed to make sure that you
@@ -24,34 +26,44 @@ them if you wish), that you receive source code or can get it if you
 want it, that you can change the software or use pieces of it in new
 free programs, and that you know you can do these things.
 
-  Developers that use our General Public Licenses protect your rights
+  To protect your rights, we need to prevent others from denying you
-with two steps: (1) assert copyright on the software, and (2) offer
+these rights or asking you to surrender the rights.  Therefore, you have
-you this License which gives you legal permission to copy, distribute
+certain responsibilities if you distribute copies of the software, or if
-and/or modify the software.
+you modify it: responsibilities to respect the freedom of others.
 
-  A secondary benefit of defending all users' freedom is that
+  For example, if you distribute copies of such a program, whether
-improvements made in alternate versions of the program, if they
+gratis or for a fee, you must pass on to the recipients the same
-receive widespread use, become available for other developers to
+freedoms that you received.  You must make sure that they, too, receive
-incorporate.  Many developers of free software are heartened and
+or can get the source code.  And you must show them these terms so they
-encouraged by the resulting cooperation.  However, in the case of
+know their rights.
-software used on network servers, this result may fail to come about.
-The GNU General Public License permits making a modified version and
-letting the public access it on a server without ever releasing its
-source code to the public.
 
-  The GNU Affero General Public License is designed specifically to
+  Developers that use the GNU GPL protect your rights with two steps:
-ensure that, in such cases, the modified source code becomes available
+(1) assert copyright on the software, and (2) offer you this License
-to the community.  It requires the operator of a network server to
+giving you legal permission to copy, distribute and/or modify it.
-provide the source code of the modified version running there to the
-users of that server.  Therefore, public use of a modified version, on
-a publicly accessible server, gives the public access to the source
-code of the modified version.
 
-  An older license, called the Affero General Public License and
+  For the developers' and authors' protection, the GPL clearly explains
-published by Affero, was designed to accomplish similar goals.  This is
+that there is no warranty for this free software.  For both users' and
-a different license, not a version of the Affero GPL, but Affero has
+authors' sake, the GPL requires that modified versions be marked as
-released a new version of the Affero GPL which permits relicensing under
+changed, so that their problems will not be attributed erroneously to
-this license.
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
 
   The precise terms and conditions for copying, distribution and
 modification follow.
@@ -60,7 +72,7 @@ modification follow.
 
   0. Definitions.
 
-  "This License" refers to version 3 of the GNU Affero General Public License.
+  "This License" refers to version 3 of the GNU General Public License.
 
   "Copyright" also means copyright-like laws that apply to other kinds of
 works, such as semiconductor masks.
@@ -537,45 +549,35 @@ to collect a royalty for further conveying from those to whom you convey
 the Program, the only way you could satisfy both those terms and this
 License would be to refrain entirely from conveying the Program.
 
-  13. Remote Network Interaction; Use with the GNU General Public License.
+  13. Use with the GNU Affero General Public License.
-
-  Notwithstanding any other provision of this License, if you modify the
-Program, your modified version must prominently offer all users
-interacting with it remotely through a computer network (if your version
-supports such interaction) an opportunity to receive the Corresponding
-Source of your version by providing access to the Corresponding Source
-from a network server at no charge, through some standard or customary
-means of facilitating copying of software.  This Corresponding Source
-shall include the Corresponding Source for any work covered by version 3
-of the GNU General Public License that is incorporated pursuant to the
-following paragraph.
 
   Notwithstanding any other provision of this License, you have
 permission to link or combine any covered work with a work licensed
-under version 3 of the GNU General Public License into a single
+under version 3 of the GNU Affero General Public License into a single
 combined work, and to convey the resulting work.  The terms of this
 License will continue to apply to the part which is the covered work,
-but the work with which it is combined will remain governed by version
+but the special requirements of the GNU Affero General Public License,
-3 of the GNU General Public License.
+section 13, concerning interaction through a network will apply to the
+combination as such.
 
   14. Revised Versions of this License.
 
   The Free Software Foundation may publish revised and/or new versions of
-the GNU Affero General Public License from time to time.  Such new versions
+the GNU General Public License from time to time.  Such new versions will
-will be similar in spirit to the present version, but may differ in detail to
+be similar in spirit to the present version, but may differ in detail to
 address new problems or concerns.
 
   Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU Affero General
+Program specifies that a certain numbered version of the GNU General
 Public License "or any later version" applies to it, you have the
 option of following the terms and conditions either of that numbered
 version or of any later version published by the Free Software
 Foundation.  If the Program does not specify a version number of the
-GNU Affero General Public License, you may choose any version ever published
+GNU General Public License, you may choose any version ever published
 by the Free Software Foundation.
 
   If the Program specifies that a proxy can decide which future
-versions of the GNU Affero General Public License can be used, that proxy's
+versions of the GNU General Public License can be used, that proxy's
 public statement of acceptance of a version permanently authorizes you
 to choose that version for the Program.
 
@@ -633,29 +635,40 @@ the "copyright" line and a pointer to where the full notice is found.
     Copyright (C) <year>  <name of author>
 
     This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU Affero General Public License as published by
+    it under the terms of the GNU General Public License as published by
     the Free Software Foundation, either version 3 of the License, or
     (at your option) any later version.
 
     This program is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU Affero General Public License for more details.
+    GNU General Public License for more details.
 
-    You should have received a copy of the GNU Affero General Public License
+    You should have received a copy of the GNU General Public License
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
-  If your software can interact with users remotely through a computer
+  If the program does terminal interaction, make it output a short
-network, you should also make sure that it provides a way for users to
+notice like this when it starts in an interactive mode:
-get its source.  For example, if your program is a web application, its
+
-interface could display a "Source" link that leads users to an archive
+    <program>  Copyright (C) <year>  <name of author>
-of the code.  There are many ways you could offer source, and different
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-solutions will be better for different programs; see section 13 for the
+    This is free software, and you are welcome to redistribute it
-specific requirements.
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
 
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU AGPL, see
+For more information on this, and how to apply and follow the GNU GPL, see
 <https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -4,19 +4,27 @@
 
 <!-- markdownlint-disable MD033 -->
 <p align="center">
-  <a href="https://undergroundwires.dev/donate?project=privacy.sexy" target="_blank" rel="noopener noreferrer">
+  <a href="https://undergroundwires.dev/donate?project=privacy.sexy">
     <img
       alt="donation badge"
       src="https://undergroundwires.dev/img/badges/donate/flat.svg"
     />
   </a>
-  <a href="https://github.com/undergroundwires/privacy.sexy/blob/master/CONTRIBUTING.md" target="_blank" rel="noopener noreferrer">
+  <a href="https://github.com/undergroundwires/privacy.sexy/blob/master/CONTRIBUTING.md">
     <img
       alt="contributions are welcome"
       src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat"
     />
   </a>
-  <a href="https://codeclimate.com/github/undergroundwires/privacy.sexy/maintainability" target="_blank" rel="noopener noreferrer">
+  <!-- Code quality -->
+  <br />
+  <a href="https://lgtm.com/projects/g/undergroundwires/privacy.sexy/context:javascript">
+    <img
+      alt="Language grade: JavaScript/TypeScript"
+      src="https://img.shields.io/lgtm/grade/javascript/g/undergroundwires/privacy.sexy.svg?logo=lgtm&logoWidth=18"
+    />
+  </a>
+  <a href="https://codeclimate.com/github/undergroundwires/privacy.sexy/maintainability">
     <img
       alt="Maintainability"
       src="https://api.codeclimate.com/v1/badges/3a70b7ef602e2264342c/maintainability"
@@ -24,85 +32,59 @@
   </a>
   <!-- Tests -->
   <br />
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.unit.yaml" target="_blank" rel="noopener noreferrer">
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.unit.yaml">
     <img
       alt="Unit tests status"
       src="https://github.com/undergroundwires/privacy.sexy/workflows/unit-tests/badge.svg"
     />
   </a>
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.integration.yaml" target="_blank" rel="noopener noreferrer">
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.integration.yaml">
     <img
       alt="Integration tests status"
       src="https://github.com/undergroundwires/privacy.sexy/workflows/integration-tests/badge.svg"
     />
   </a>
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.e2e.yaml" target="_blank" rel="noopener noreferrer">
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.e2e.yaml">
     <img
       alt="E2E tests status"
       src="https://github.com/undergroundwires/privacy.sexy/workflows/e2e-tests/badge.svg"
     />
   </a>
-  <!-- Security checks -->
-  <br />
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.security.sast.yaml" target="_blank" rel="noopener noreferrer">
-    <img
-      alt="Status of dependency security checks"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.security.sast/badge.svg"
-    />
-  </a>
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.security.dependencies.yaml" target="_blank" rel="noopener noreferrer">
-    <img
-      alt="Status of Static Analysis Security Testing (SAST)"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.security.dependencies/badge.svg"
-    />
-  </a>
   <!-- Checks -->
   <br />
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.quality.yaml" target="_blank" rel="noopener noreferrer">
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.quality.yaml">
     <img
       alt="Quality checks status"
       src="https://github.com/undergroundwires/privacy.sexy/workflows/quality-checks/badge.svg"
     />
   </a>
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.build.yaml" target="_blank" rel="noopener noreferrer">
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.security.yaml">
     <img
-      alt="Status of build checks"
+      alt="Security checks status"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.build/badge.svg"
+      src="https://github.com/undergroundwires/privacy.sexy/workflows/security-checks/badge.svg"
     />
   </a>
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.desktop-runtime-errors.yaml" target="_blank" rel="noopener noreferrer">
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.build.yaml">
     <img
-      alt="Status of runtime error checks for the desktop application"
+      alt="Build checks status"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.desktop-runtime-errors/badge.svg"
+      src="https://github.com/undergroundwires/privacy.sexy/workflows/build-checks/badge.svg"
-    />
-  </a>
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.scripts.yaml" target="_blank" rel="noopener noreferrer">
-    <img
-      alt="Status of script checks"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.scripts/badge.svg"
-    />
-  </a>
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.external-urls.yaml" target="_blank" rel="noopener noreferrer">
-    <img
-      alt="Status of external URL checks"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.external-urls/badge.svg"
     />
   </a>
   <!-- Release -->
   <br />
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.git.yaml" target="_blank" rel="noopener noreferrer">
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.git.yaml">
     <img
       alt="Git release status"
       src="https://github.com/undergroundwires/privacy.sexy/workflows/release-git/badge.svg"
     />
   </a>
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.site.yaml" target="_blank" rel="noopener noreferrer">
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.site.yaml">
     <img
       alt="Site release status"
       src="https://github.com/undergroundwires/privacy.sexy/workflows/release-site/badge.svg"
     />
   </a>
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.desktop.yaml" target="_blank" rel="noopener noreferrer">
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.desktop.yaml">
     <img
       alt="Desktop application release status"
       src="https://github.com/undergroundwires/privacy.sexy/workflows/release-desktop/badge.svg"
@@ -110,7 +92,7 @@
   </a>
   <!-- Others -->
   <br />
-  <a href="https://github.com/undergroundwires/bump-everywhere" target="_blank" rel="noopener noreferrer">
+  <a href="https://github.com/undergroundwires/bump-everywhere">
     <img
       alt="Auto-versioned by bump-everywhere"
       src="https://github.com/undergroundwires/bump-everywhere/blob/master/badge.svg?raw=true"
@@ -122,7 +104,7 @@
 ## Get started
 
 - 🌍️ **Online**: [https://privacy.sexy](https://privacy.sexy).
-- 🖥️ **Offline**: Download directly for: [Windows](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.7/privacy.sexy-Setup-0.12.7.exe), [macOS](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.7/privacy.sexy-0.12.7.dmg), [Linux](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.7/privacy.sexy-0.12.7.AppImage). For more options, see [here](#additional-install-options).
+- 🖥️ **Offline**: Check [releases page](https://github.com/undergroundwires/privacy.sexy/releases), or download directly for: [Windows](https://github.com/undergroundwires/privacy.sexy/releases/download/0.11.2/privacy.sexy-Setup-0.11.2.exe), [macOS](https://github.com/undergroundwires/privacy.sexy/releases/download/0.11.2/privacy.sexy-0.11.2.dmg), [Linux](https://github.com/undergroundwires/pr.vacy.sexy/releases/download/0.11.2/privacy.sexy-0.11.2.AppImage).
 
 Online version does not require to run any software on your computer. Offline version has more functions such as running the scripts directly.
 
@@ -150,25 +132,6 @@ Online version does not require to run any software on your computer. Offline ve
 
 **Contribute 👷**. Contributions of any type are welcome. See [CONTRIBUTING.md](./CONTRIBUTING.md) as the starting point. It includes useful information like [how to add new scripts](./CONTRIBUTING.md#extend-scripts).
 
-## Additional Install Options
-
-- Check the [releases page](https://github.com/undergroundwires/privacy.sexy/releases) for all available versions.
-- Other unofficial channels (not maintained by privacy.sexy) for Windows include:
-  - [Scoop 🥄](https://scoop.sh/#/apps?q=privacy.sexy&s=2&d=1&o=true) (latest version):
-
-    ```powershell
-      scoop bucket add extras
-      scoop install privacy.sexy
-    ```
-
-  - [winget 🪟](https://winget.run/pkg/undergroundwires/privacy.sexy) (may be outdated):
-
-    ```powershell
-      winget install -e --id undergroundwires.privacy.sexy
-    ```
-
-    With winget, updates require manual submission; the auto-update feature within privacy.sexy will notify you of new releases post-installation.
-
 ## Development
 
 Refer to [development.md](./docs/development.md) for Docker usage and reading more about setting up your development environment.
@@ -176,7 +139,3 @@ Refer to [development.md](./docs/development.md) for Docker usage and reading mo
 Check [architecture.md](./docs/architecture.md) for an overview of design and how different parts and layers work together. You can refer to [application.md](./docs/application.md) for a closer look at application layer codebase and [presentation.md](./docs/presentation.md) for code related to GUI layer. [collection-files.md](./docs/collection-files.md) explains the YAML files that are the core of the application and [templating.md](./docs/templating.md) documents how to use templating language in those files. In [ci-cd.md](./docs/ci-cd.md), you can read more about the pipelines that automates maintenance tasks and ensures you get what see.
 
 [docs/](./docs/) folder includes all other documentation.
-
-## Security
-
-Security is a top priority at privacy.sexy. An extensive commitment to security verification ensures this priority. For any security concerns or vulnerabilities, please consult the [Security Policy](./SECURITY.md).

SECURITY.md

@@ -1,31 +0,0 @@
-# Security Policy
-
-privacy.sexy takes security seriously. Commitment is made to address all security issues with urgency. Responsible reporting of any discovered vulnerabilities in the project is highly encouraged.
-
-## Reporting a Vulnerability
-
-Efforts to responsibly disclose findings are greatly appreciated. To report a security vulnerability, follow these steps:
-
-- For general vulnerabilities, [open an issue](https://github.com/undergroundwires/privacy.sexy/issues/new/choose) using the bug report template.
-- For sensitive matters, [contact the developer directly](https://undergroundwires.dev).
-
-## Security Report Handling
-
-Upon receipt of a security report, the following actions will be taken:
-
-- The report will be confirmed, identifying the affected components.
-- The impact and severity of the issue will be assessed.
-- Work on a fix and plan a release to address the vulnerability will be initiated.
-- The reporter will be kept updated about the progress.
-
-## Testing
-
-Regular and extensive testing is conducted to ensure robust security in the project. Information about testing practices can be found in the [Testing Documentation](./docs/tests.md).
-
-## Support
-
-For additional assistance or any unanswered questions, [submit a GitHub issue](https://github.com/undergroundwires/privacy.sexy/issues/new/choose). Security concerns are a priority, and necessary support to address them is assured.
-
----
-
-Active contribution to the safety and security of privacy.sexy is thanked. This collaborative effort keeps the project resilient and trustworthy for all.

babel.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  presets: [
+    '@vue/cli-plugin-babel/preset',
+  ],
+};

cypress-dirs.json

@@ -1,5 +0,0 @@
-{
-  "base": "tests/e2e",
-  "videos": "tests/e2e/videos",
-  "screenshots": "tests/e2e/videos"
-}

cypress.config.ts

@@ -1,31 +1,14 @@
-import { defineConfig } from 'cypress';
+import { defineConfig } from 'cypress'
-import ViteConfig from './vite.config';
-import cypressDirs from './cypress-dirs.json' assert { type: 'json' };
 
 export default defineConfig({
-  fixturesFolder: `${cypressDirs.base}/fixtures`,
+  fixturesFolder: 'tests/e2e/fixtures',
-  screenshotsFolder: cypressDirs.screenshots,
+  screenshotsFolder: 'tests/e2e/screenshots',
-
+  videosFolder: 'tests/e2e/videos',
-  video: true,
-  videosFolder: cypressDirs.videos,
-
   e2e: {
-    baseUrl: `http://localhost:${getApplicationPort()}/`,
+    setupNodeEvents(on, config) {
-    specPattern: `${cypressDirs.base}/**/*.cy.{js,jsx,ts,tsx}`, // Default: cypress/e2e/**/*.cy.{js,jsx,ts,tsx}
+      return require('./tests/e2e/plugins/index.js')(on, config)
-    supportFile: `${cypressDirs.base}/support/e2e.ts`,
+    },
+    specPattern: 'tests/e2e/specs/**/*.cy.{js,jsx,ts,tsx}',
+    supportFile: 'tests/e2e/support/index.js',
   },
-
-  /*
-    Disabling Chrome's web security to allow for faster DOM queries to access DOM earlier than
-    `cy.get()`. It bypasses the usual same-origin policy constraints
-  */
-  chromeWebSecurity: false,
 });
-
-function getApplicationPort(): number {
-  const port = ViteConfig.server?.port;
-  if (port === undefined) {
-    throw new Error('Unknown application port');
-  }
-  return port;
-}

dist-dirs.json

@@ -1,5 +0,0 @@
-{
-  "electronUnbundled": "dist-electron-unbundled",
-  "electronBundled": "dist-electron-bundled",
-  "web": "dist-web"
-}

docs/application.md

@@ -35,7 +35,7 @@ Application layer enables [data-driven programming](https://en.wikipedia.org/wik
 
 Application layer parses the application data to compile the domain object [`Application.ts`](./../src/domain/Application.ts).
 
-The build tool loads (or injects) application data ([collection yaml files](./../src/application/collections/)) into the application layer in compile time. Application layer ([`ApplicationFactory.ts`](./../src/application/ApplicationFactory.ts)) parses and compiles this data in runtime.
+A webpack loader loads (or injects) application data ([collection yaml files](./../src/application/collections/)) into the application layer in compile time. Application layer ([`ApplicationFactory.ts`](./../src/application/ApplicationFactory.ts)) parses and compiles this data in runtime.
 
 Application layer compiles templating syntax during parsing to create the end scripts. You can read more about templating syntax in [templating.md](./templating.md) and how application data uses them through functions in [collection-files.md | Function](./collection-files.md#function).
 

docs/architecture.md

@@ -15,23 +15,11 @@ Application is
 
 Application uses highly decoupled models & services in different DDD layers:
 
-**Application layer** (see [application.md](./application.md)):
+- presentation layer (see [presentation.md](./presentation.md)),
+- application layer (see [application.md](./application.md)),
+- and domain layer.
 
-- Coordinates application activities and consumes the domain layer.
+Application layer depends on and consumes domain layer. [Presentation layer](./presentation.md) consumes and depends on application layer along with domain layer. Application and presentation layers can communicate through domain model.
-
-**Presentation layer** (see [presentation.md](./presentation.md)):
-
-- Handles UI/UX, consumes both the application and domain layers.
-- May communicate directly with the infrastructure layer for technical needs, but avoids domain logic.
-
-**Domain layer**:
-
-- Serves as the system's core and central truth.
-- Facilitates communication between the application and presentation layers through the domain model.
-
-**Infrastructure layer**:
-
-- Manages technical implementations without dependencies on other layers or domain knowledge.
 
 ![DDD + vue.js](./../img/architecture/app-ddd.png)
 
@@ -39,8 +27,6 @@ Application uses highly decoupled models & services in different DDD layers:
 
 State handling uses an event-driven subscription model to signal state changes and special functions to register changes. It does not depend on third party packages.
 
-The presentation layer can read and modify state through the context. State changes trigger events that components can subscribe to for reactivity.
-
 Each layer treat application layer differently.
 
 ![State](./../img/architecture/app-state.png)
@@ -59,7 +45,7 @@ Each layer treat application layer differently.
 - So state is mutable, and fires related events when mutated.
 - 📖 Read more: [application.md | Application state](./application.md#application-state).
 
-It's comparable with `flux`, `vuex`, and `pinia`. A difference is that mutable application layer state in privacy.sexy is mutable and lies in single "store" that holds app state and logic. The "actions" mutate the state directly which in turns act as dispatcher to notify its own event subscriptions (callbacks).
+It's comparable with flux ([`redux`](https://redux.js.org/)) or flux-like ([`vuex`](https://vuex.vuejs.org/)) patterns. Flux component "view" is [presentation layer](./presentation.md) in Vue. Flux functions "dispatcher", "store" and "action creation" functions lie in the [application layer](./application.md). A difference is that application state in privacy.sexy is mutable and lies in single flux "store" that holds app state and logic. The "actions" mutate the state directly which in turns act as dispatcher to notify its own event subscriptions (callbacks).
 
 ## AWS infrastructure
 

docs/collection-files.md

@@ -174,19 +174,3 @@
 - `endCode:` *`string`* (**required**)
   - Code that'll be inserted at the end of user created script.
   - Global variables such as `$homepage`, `$version`, `$date` can be used using [parameter substitution](./templating.md#parameter-substitution) code syntax such as `Welcome to {{ $homepage }}!`
-
-## Naming guidelines
-
-- Prioritize consistency throughout all names.
-- Use an instruction format like "do this, do that" for clear, direct guidance. This approach reduces potential confusion and offers easy-to-follow steps. It provides specific, unambiguous instructions.
-- Ensure brand names adhere to their official casing.
-- Choose clear and uncomplicated language.
-- Favor the terms:
-  - "Disable" over "Turn off"
-  - "Configure" over "Set up"
-  - "Clear" over "Erase" or "Clean"
-  - "Minimize" over "Limit" or "Reduce" (when it enhances clarity)
-  - "Remove" over "Uninstall"
-- Structure your phrases for clarity.
-  - For instance, "Disable XX telemetry" or "Clear XX data" are preferred over "Clear data from XX", "Disable telemetry in XX", or "Clear data of XX".
-- Use sentence case rather than Title Case.

docs/development.md

@@ -5,28 +5,22 @@ Before your commit, a good practice is to:
 1. [Run unit tests](#testing)
 2. [Lint your code](#linting)
 
-You could run other types of tests as well, but they may take longer time and overkill for your changes.
+You could run other types of tests as well, but they may take longer time and overkill for your changes. Automated actions executes the tests for a pull request or change in the main branch. See [ci-cd.md](./ci-cd.md) for more information.
-Automated actions are set up to execute these tests as necessary.
-See [ci-cd.md](./ci-cd.md) for more information.
 
 ## Commands
 
 ### Prerequisites
 
-- Install Node >16.x.
+- Install node >15.x.
-- Install dependencies using `npm install` (or [`npm run install-deps`](#utility-scripts) for more options).
+- Install dependencies using `npm install`.
 
 ### Testing
 
 - Run unit tests: `npm run test:unit`
 - Run integration tests: `npm run test:integration`
-- Run end-to-end (e2e) tests:
+- Run e2e (end-to-end) tests
-  - `npm run test:cy:open`: Run tests interactively using the development server with hot-reloading.
+  - Interactive mode with GUI: `npm run test:e2e`
-  - `npm run test:cy:run`: Run tests on the production build in a headless mode.
+  - Headless mode without GUI: `npm run test:e2e -- --headless`
-- Run checks:
-  - `npm run check:desktop`: Run runtime checks for packaged desktop applications ([README.md](./../tests/checks/desktop-runtime-errors/check-desktop-runtime-errors/README.md)).
-    - You can set environment variables active its flags such as `BUILD=true SCREENSHOT=true npm run check:desktop`
-  - `npm run check:external-urls`: Test whether external URLs used in applications are alive.
 
 📖 Read more about testing in [tests](./tests.md).
 
@@ -41,26 +35,11 @@ See [ci-cd.md](./ci-cd.md) for more information.
 
 ### Running
 
-**Web:**
+- Run in local server: `npm run serve`
-
-- Run in local server: `npm run dev`
   - 💡 Meant for local development with features such as hot-reloading.
-- Preview production build: `npm run preview`
+- Run using Docker:
-  - Start a local web server that serves the built solution from `./dist`.
-  - 💡 Run `npm run build` before `npm run preview`.
-
-**Desktop apps:**
-
-- `npm run electron:dev`: The command will build the main process and preload scripts source code, and start a dev server for the renderer, and start the Electron app.
-- `npm run electron:preview`: The command will build the main process, preload scripts and renderer source code, and start the Electron app to preview.
-- `npm run electron:prebuild`: The command will build the main process, preload scripts and renderer source code. Usually before packaging the Electron application, you need to execute this command.
-- `npm run electron:build`: Prebuilds the Electron application, packages and publishes it through `electron-builder`.
-
-**Docker:**
-
   1. Build: `docker build -t undergroundwires/privacy.sexy:latest .`
   2. Run: `docker run -it -p 8080:80 --rm --name privacy.sexy undergroundwires/privacy.sexy:latest`
-3. Application should be available at [`http://localhost:8080`](http://localhost:8080)
 
 ### Building
 
@@ -68,27 +47,13 @@ See [ci-cd.md](./ci-cd.md) for more information.
 - Build desktop application: `npm run electron:build`
 - (Re)create icons (see [documentation](../img/README.md)): `npm run create-icons`
 
-### Scripts
+### Utility Scripts
 
-📖 For detailed options and behavior for any of the following scripts, please refer to the script file itself.
+- Run fresh NPM install: [`./scripts/fresh-npm-install.sh`](../scripts/fresh-npm-install.sh)
-
+  - This script provides a clean NPM install, removing existing node modules and optionally the package-lock.json (when run with -n), then installs dependencies and runs unit tests.
-#### Utility scripts
+- Configure VSCode: [`./scripts/configure-vscode.sh`](../scripts/configure-vscode.sh)
-
-- [**`npm run install-deps [-- <options>]`**](../scripts/npm-install.js):
-  - Manages NPM dependency installation, it offers capabilities like doing a fresh install, retries on network errors, and other features.
-  - For example, you can run `npm run install-deps -- --fresh` to do clean installation of dependencies.
-- [**`./scripts/configure-vscode.sh`**](../scripts/configure-vscode.sh):
   - This script checks and sets the necessary configurations for VSCode in `settings.json` file.
 
-#### Automation scripts
-
-- [**`node scripts/print-dist-dir.js [<options>]`**](../scripts/print-dist-dir.js):
-  - Determines the absolute path of a distribution directory based on CLI arguments and outputs its absolute path.
-- [**`npm run check:verify-build-artifacts [-- <options>]`**](../scripts/verify-build-artifacts.js):
-  - Verifies the existence and content of build artifacts. Useful for ensuring that the build process is generating the expected output.
-- [**`node scripts/verify-web-server-status.js --url [URL]`**](../scripts/verify-web-server-status.js):
-  - Checks if a specified server is up with retries and returns an HTTP 200 status code.
-
 ## Recommended extensions
 
 You should use EditorConfig to follow project style.

docs/presentation.md

@@ -1,34 +1,30 @@
 # Presentation layer
 
-The presentation layer handles UI concerns using Vue as JavaScript framework and Electron to provide desktop functionality.
+Presentation layer consists of UI-related code. It uses Vue.js as JavaScript framework and includes Vue.js components. It also includes [Electron](https://www.electronjs.org/) to provide functionality to desktop application.
 
-It reflects the [application state](./application.md#application-state) and allows user interactions to modify it. Components manage their own local UI state.
+It's designed event-driven from bottom to top. It listens user events (from top) and state events (from bottom) to update state or the GUI.
-
-The presentation layer uses an event-driven architecture for bidirectional reactivity between the application state and UI. State change events flow bottom-up to trigger UI updates, while user events flow top-down through components, some ultimately modifying the application state.
 
 📖 Refer to [architecture.md (Layered Application)](./architecture.md#layered-application) to read more about the layered architecture.
 
 ## Structure
 
-- [`/src/` **`presentation/`**](./../src/presentation/): Contains Vue and Electron code.
+- [`/src/` **`presentation/`**](./../src/presentation/): Contains all presentation related code including Vue and Electron configurations
-  - [**`main.ts`**](./../src/presentation/main.ts): Starts Vue app.
+  - [**`bootstrapping/`**](./../src/presentation/bootstrapping/): Registers Vue global objects including components and plugins.
-  - [**`index.html`**](./../src/presentation/index.html): The `index.html` entry file, located at the root of the project as required by Vite
+  - [**`components/`**](./../src/presentation/components/): Contains all Vue components and their helper classes.
-  - [**`bootstrapping/`**](./../src/presentation/bootstrapping/): Registers Vue components and plugins.
+    - [**`Shared/`**](./../src/presentation/components/Shared): Contains Vue components and component helpers that other components share.
-  - [**`components/`**](./../src/presentation/components/): Contains Vue components and helpers.
+  - [**`assets/`**](./../src/presentation/assets/styles/): Contains assets that webpack will process.
-    - [**`Shared/`**](./../src/presentation/components/Shared): Contains shared Vue components and helpers.
+    - [**`fonts/`**](./../src/presentation/assets/fonts/): Contains fonts
-      - [**`Hooks`**](../src/presentation/components/Shared/Hooks): Hooks used by components through [dependency injection](#dependency-injections).
+    - [**`styles/`**](./../src/presentation/assets/styles/): Contains shared styles used throughout different components.
-  - [**`/public/`**](../src/presentation/public/): Contains static assets.
+      - [**`components/`**](./../src/presentation/assets/styles/components): Contains reusable styles coupled to a Vue/HTML component.
-  - [**`assets/`**](./../src/presentation/assets/styles/): Contains assets processed by Vite.
+      - [**`vendors-extensions/`**](./../src/presentation/assets/styles/third-party-extensions): Contains styles that override third-party components used.
-    - [**`fonts/`**](./../src/presentation/assets/fonts/): Contains fonts.
+      - [**`main.scss`**](./../src/presentation/assets/styles/main.scss): Primary Sass file, passes along all other styles, should be the single file used from other components.
-    - [**`styles/`**](./../src/presentation/assets/styles/): Contains shared styles.
+  - [**`main.ts`**](./../src/presentation/main.ts): Application entry point that mounts and starts Vue application.
-      - [**`components/`**](./../src/presentation/assets/styles/components): Contains styles coupled to Vue components.
+  - [**`electron/`**](./../src/presentation/electron/): Electron configuration for the desktop application.
-      - [**`main.scss`**](./../src/presentation/assets/styles/main.scss): Main Sass file, imported by other components as single entrypoint..
+    - [**`main.ts`**](./../src/presentation/main.ts): Main process of Electron, started as first thing when app starts.
-  - [**`electron/`**](./../src/presentation/electron/): Contains Electron code.
+- [**`/public/`**](./../public/): Contains static assets that are directly copied and do not go through webpack.
-    - [`/main/` **`index.ts`**](./../src/presentation/main.ts): Main entry for Electron, managing application windows and lifecycle events.
+- [**`/vue.config.js`**](./../vue.config.js): Global Vue CLI configurations loaded by `@vue/cli-service`.
-    - [`/preload/` **`index.ts`**](./../src/presentation/main.ts): Script executed before the renderer, securing Node.js features for renderer use.
+- [**`/postcss.config.js`**](./../postcss.config.js): PostCSS configurations used by Vue CLI internally.
-- [**`/vite.config.ts`**](./../vite.config.ts): Contains Vite configurations for building web application.
+- [**`/babel.config.js`**](./../babel.config.js): Babel configurations for polyfills used by `@vue/cli-plugin-babel`.
-- [**`/electron.vite.config.ts`**](./../electron.vite.config.ts): Contains Vite configurations for building desktop applications.
-- [**`/postcss.config.cjs`**](./../postcss.config.cjs): Contains PostCSS configurations for Vite.
 
 ## Visual design best-practices
 
@@ -36,7 +32,7 @@ Add visual clues for clickable items. It should be as clear as possible that the
 
 ## Application data
 
-Components (should) use [`UseApplication`](./../src/presentation/components/Shared/Hooks/UseApplication.ts) to reach the application domain to avoid [parsing and compiling](./application.md#parsing-and-compiling) the application again.
+Components (should) use [ApplicationFactory](./../src/application/ApplicationFactory.ts) singleton to reach the application domain to avoid [parsing and compiling](./application.md#parsing-and-compiling) the application again.
 
 [Application.ts](../src/domain/Application.ts) is an immutable domain model that represents application state. It includes:
 
@@ -47,59 +43,34 @@ You can read more about how application layer provides application data to he pr
 
 ## Application state
 
-This project uses a singleton instance of the application state, making it available to all Vue components.
+Inheritance of a Vue components marks whether it uses application state . Components that does not handle application state extends `Vue`. Stateful components mutate or/and react to state changes (such as user selection or search queries) in [ApplicationContext](./../src/application/Context/ApplicationContext.ts) extend [`StatefulVue`](./../src/presentation/components/Shared/StatefulVue.ts) class to access the context / state.
 
-The decision to not use third-party state management libraries like [`vuex`](https://web.archive.org/web/20230801191617/https://vuex.vuejs.org/) or [`pinia`](https://web.archive.org/web/20230801191743/https://pinia.vuejs.org/) was made to promote code independence and enhance portability.
+[`StatefulVue`](./../src/presentation/components/Shared/StatefulVue.ts) functions include:
 
-Stateful components can mutate and/or react to state changes (e.g., user selection, search queries) in the [ApplicationContext](./../src/application/Context/ApplicationContext.ts). Vue components import [`CollectionState.ts`](./../src/presentation/components/Shared/Hooks/UseCollectionState.ts) to access both the application context and the state.
+- Creating a singleton of the state and makes it available to presentation layer as single source of truth.
+- Providing virtual abstract `handleCollectionState` callback that it calls when
+  - the Vue loads the component,
+  - and also every time when state changes.
+- Providing `events` member to make lifecycling of state subscriptions events easier because it ensures that components unsubscribe from listening to state events when
+  - the component is no longer used (destroyed),
+  - an if [ApplicationContext](./../src/application/Context/ApplicationContext.ts) changes the active [collection](./collection-files.md) to a different one.
 
-[`UseCollectionState.ts`](./../src/presentation/components/Shared/Hooks/UseCollectionState.ts) provides several functionalities including:
+📖 Refer to [architecture.md | Application State](./architecture.md#application-state) to get an overview of event handling and [application.md | Application State](./presentation.md#application-state) for deeper look into how the application layer manages state.
 
-- **Singleton State Instance**: It creates a singleton instance of the state, which is shared across the presentation layer. The singleton instance ensures that there's a single source of truth for the application's state.
+## Modals
-- **State Change Callback and Lifecycle Management**: It offers a mechanism to register callbacks, which will be invoked when the state initializes or mutates. It ensures that components unsubscribe from state events when they are no longer in use or when [ApplicationContext](./../src/application/Context/ApplicationContext.ts) switches the active [collection](./collection-files.md).
-- **State Access and Modification**: It provides functions to read and mutate for accessing and modifying the state, encapsulating the details of these operations.
-- **Event Subscription Lifecycle Management**: Includes an `events` member that simplifies state subscription lifecycle events. This ensures that components unsubscribe from state events when they are no longer in use, or when [ApplicationContext](./../src/application/Context/ApplicationContext.ts) switches the active [collection](./collection-files.md).
 
-📖 Refer to [architecture.md | Application State](./architecture.md#application-state) for an overview of event handling and [application.md | Application State](./presentation.md#application-state) for an in-depth understanding of state management in the application layer.
+[Dialog.vue](./../src/presentation/components/Shared/Dialog.vue) is a shared component that other components used to show modal windows.
 
-## Dependency injections
+You can use it by wrapping the content inside of its `slot` and call `.show()` function on its reference. For example:
 
-The presentation layer uses Vue's native dependency injection system to increase testability and decouple components.
+  ```html
+    <Dialog ref="testDialog">
+      <div>Hello world</div>
+    </Dialog>
+    <div @click="$refs.testDialog.show()">Show dialog</div>
+  ```
 
-To add a new dependency:
+## Sass naming convention
-
-1. **Define its symbol**: Define an associated symbol for every dependency in [`injectionSymbols.ts`](./../src/presentation/injectionSymbols.ts). Symbols are grouped into:
-   - **Singletons**: Shared across components, instantiated once.
-   - **Transients**: Factories yielding a new instance on every access.
-2. **Provide the dependency**:
-  Modify the [`provideDependencies`](./../src/presentation/bootstrapping/DependencyProvider.ts) function to include the new dependency.
-  [`App.vue`](./../src/presentation/components/App.vue) calls this function within its `setup()` hook to register the dependencies.
-3. **Inject the dependency**: Use `injectKey` to inject a dependency. Pass a selector function to `injectKey` that retrieves the appropriate symbol from the provided dependencies.
-   - Example usage: `injectKey((keys) => keys.useCollectionState)`;
-
-## Shared UI components
-
-Shared UI components promote consistency and simplifies the creation of the front-end.
-
-In order to maintain portability and easy maintainability, the preference is towards using homegrown components over third-party ones or comprehensive UI frameworks like Quasar.
-
-Shared components include:
-
-- [ModalDialog.vue](./../src/presentation/components/Shared/Modal/ModalDialog.vue) is utilized for rendering modal windows.
-- [TooltipWrapper.vue](./../src/presentation/components/Shared/TooltipWrapper.vue) acts as a wrapper for rendering tooltips.
-
-## Desktop builds
-
-Desktop builds uses `electron-vite` to bundle the code, and `electron-builder` to build and publish the packages.
-
-## Styles
-
-### Style location
-
-- **Global styles**: The [`assets/styles/`](#structure) directory is reserved for styles that have a broader scope, affecting multiple components or entire layouts. They are generic and should not be tightly coupled to a specific component's functionality.
-- **Component-specific styles**: Styles closely tied to a particular component's functionality or appearance should reside near the component they are used by. This makes it easier to locate and modify styles when working on a specific component.
-
-### Sass naming convention
 
 - Use lowercase for variables/functions/mixins, e.g.:
   - Variable: `$variable: value;`

docs/templating.md

@@ -2,69 +2,21 @@
 
 ## Benefits of templating
 
-- **Code sharing:** Share code across scripts for consistent practices and easier maintenance.
+- Generating scripts by sharing code to increase best-practice usage and maintainability.
-- **Script independence:** Generate self-contained scripts, eliminating the need for external code.
+- Creating self-contained scripts without cross-dependencies.
-- **Cleaner code:** Use pipes for complex operations, resulting in more readable and streamlined code.
+- Use of pipes for writing cleaner code and letting pipes do dirty work.
 
 ## Expressions
 
-**Syntax:**
+- Expressions start and end with mustaches (double brackets, `{{` and `}}`).
-
+  - E.g. `Hello {{ $name }} !`
-Expressions are enclosed within `{{` and `}}`.
+- Syntax is close to [Go Templates ❤️](https://pkg.go.dev/text/template) but not the same.
-Example: `Hello {{ $name }}!`.
+- Functions enables usage of expressions.
-They are a core component of templating, enhancing scripts with dynamic capabilities and functionality.
+  - In script definition parts of a function, see [`Function`](./collection-files.md#Function).
-
+  - When doing a call as argument values, see [`FunctionCall`](./collection-files.md#Function).
-**Syntax similarity:**
+- Expressions inside expressions (nested templates) are supported.
-
+  - An expression can output another expression that will also be compiled.
-The syntax shares similarities with [Go Templates ❤️](https://pkg.go.dev/text/template), but with some differences:
+  - E.g. following would compile first [with expression](#with), and then [parameter substitution](#parameter-substitution) in its output.
-
-**Function definitions:**
-
-You can use expressions in function definition.
-Refer to [Function](./collection-files.md#function) for more details.
-
-Example usage:
-
-```yaml
-  name: GreetFunction
-  parameters:
-    - name: name
-  code: Hello {{ $name }}!
-```
-
-If you assign `name` the value `world`, invoking `GreetFunction` would result in `Hello world!`.
-
-**Function arguments:**
-
-You can also use expressions in arguments in nested function calls.
-Refer to [`Function | collection-files.md`](./collection-files.md#functioncall) for more details.
-
-Example with nested function calls:
-
-```yaml
--
-  name: PrintMessageFunction
-  parameters:
-    - name: message
-  code: echo "{{ $message }}"
--
-  name: GreetUserFunction
-  parameters:
-    - name: userName
-  call:
-    name: PrintMessageFunction
-    parameters:
-      argument: 'Hello, {{ $userName }}!'
-```
-
-Here, if `userName` is `Alice`, invoking `GreetUserFunction` would execute `echo "Hello, Alice!"`.
-
-**Nested templates:**
-
-You can nest expressions inside expressions (also called "nested templates").
-This means that an expression can output another expression where compiler will compile both.
-
-For example, following would compile first [with expression](#with), and then [parameter substitution](#parameter-substitution) in its output:
 
     ```go
       {{ with $condition }}
@@ -74,70 +26,55 @@ For example, following would compile first [with expression](#with), and then [p
 
 ### Parameter substitution
 
-Parameter substitution dynamically replaces variable references with their corresponding values in the script.
+A simple function example:
-
-**Example function:**
 
 ```yaml
-  name: DisplayTextFunction
+  function: EchoArgument
   parameters:
-    - name: 'text'
+    - name: 'argument'
-  code: echo {{ $text }}
+  code: Hello {{ $argument }} !
 ```
 
-Invoking `DisplayTextFunction` with `text` set to `"Hello, world!"` would result in `echo "Hello, World!"`.
+It would print "Hello world" if it's called in a [script](./collection-files.md#script) as following:
+
+```yaml
+  script: Echo script
+  call:
+    function: EchoArgument
+    parameters:
+      argument: World
+```
+
+A function can call other functions such as:
+
+```yaml
+  - 
+    function: CallerFunction
+    parameters:
+      - name: 'value'
+    call:
+      function: EchoArgument
+      parameters:
+        argument: {{ $value }}
+  -
+    function: EchoArgument
+    parameters:
+      - name: 'argument'
+    code: Hello {{ $argument }} !
+```
 
 ### with
 
-The `with` expression enables conditional rendering and provides a context variable for simpler code.
+Skips its "block" if the variable is absent or empty. Its "block" is between `with` start (`{{ with .. }}`) and end (`{{ end }`}) expressions.
+E.g. `{{ with $parameterName }} Hi, I'm a block! {{ end }}` would only output `Hi, I'm a block!` if `parameterName` has any value..
 
-**Optional block rendering:**
+It binds its context (value of the provided parameter value) as arbitrary `.` value. It allows you to use the argument value of the given parameter when it is provided and not empty such as:
-
-If the provided variable is falsy (`false`, `null`, or empty), the compiler skips the enclosed block of code.
-A "block" lies between the with start (`{{ with .. }}`) and end (`{{ end }}`) expressions, defining its boundaries.
-
-Example:
-
-```go
-{{ with $optionalVariable }}
-  Hello
-{{ end }}
-```
-
-This would display `Hello` if `$optionalVariable` is truthy.
-
-**Parameter declaration:**
-
-You should set `optional: true` for the argument if you use it like `{{ with $argument }} .. {{ end }}`.
-
-Declare parameters used for `with` condition as optional such as:
-
-```yaml
-name: ConditionalOutputFunction
-parameters:
-  - name: 'data'
-    optional: true
-code: |- 
-  {{ with $data }}
-    Data is: {{ . }}
-  {{ end }}
-```
-
-**Context variable:**
-
-`with` statement binds its context (value of the provided parameter value) as arbitrary `.` value.
-`{{ . }}` syntax gives you access to the context variable.
-This is optional to use, and not required to use `with` expressions.
-
-For example:
 
 ```go
   {{ with $parameterName }}Parameter value is {{ . }} here {{ end }}
 ```
 
-**Multiline text:**
+It supports multiline text inside the block. You can have something like:
-
-It supports multiline text inside the block. You can write something like:
 
 ```go
   {{ with $argument }}
@@ -146,9 +83,7 @@ It supports multiline text inside the block. You can write something like:
   {{ end }}
 ```
 
-**Inner expressions:**
+You can also use other expressions inside its block, such as [parameter substitution](#parameter-substitution):
-
-You can also embed other expressions inside its block, such as [parameter substitution](#parameter-substitution):
 
 ```go
   {{ with $condition }}
@@ -156,44 +91,32 @@ You can also embed other expressions inside its block, such as [parameter substi
   {{ end }}
 ```
 
-This also includes nesting `with` statements:
+💡 Declare parameters used for `with` condition as optional. Set `optional: true` for the argument if you use it like `{{ with $argument }} .. {{ end }}`.
 
-```go
+Example:
-  {{ with $condition1 }}
+
-    Value of $condition1: {{ . }}
+```yaml
-    {{ with $condition2 }}
+  function: FunctionThatOutputsConditionally
-      Value of $condition2: {{ . }}
+  parameters:
-    {{ end }}
+    - name: 'argument'
+      optional: true
+  code: |- 
+    {{ with $argument }}
+      Value is: {{ . }}
     {{ end }}
 ```
 
 ### Pipes
 
-Pipes are functions designed for text manipulation.
+- Pipes are functions available for handling text.
-They allow for a sequential application of operations resembling [Unix pipelines](https://en.wikipedia.org/wiki/Pipeline_(Unix)), also known as "chaining".
+- Allows stacking actions one after another also known as "chaining".
-Each pipeline's output becomes the input of the following pipe.
+- Like [Unix pipelines](https://en.wikipedia.org/wiki/Pipeline_(Unix)), the concept is simple: each pipeline's output becomes the input of the following pipe.
-
+- You cannot create pipes. [A dedicated compiler](./application.md#parsing-and-compiling) provides pre-defined pipes to consume in collection files.
-**Pre-defined**:
+- You can combine pipes with other expressions such as [parameter substitution](#parameter-substitution) and [with](#with) syntax.
-
+- ❗ Pipe names must be camelCase without any space or special characters.
-Pipes are pre-defined by the system.
+- **Existing pipes**
-You cannot create pipes in [collection files](./collection-files.md).
-[A dedicated compiler](./application.md#parsing-and-compiling) provides pre-defined pipes to consume in collection files.
-
-**Compatibility:**
-
-You can combine pipes with other expressions such as [parameter substitution](#parameter-substitution) and [with](#with) syntax.
-
-For example:
-
-```go
-{{ with $script }} echo "{{ . | inlinePowerShell | escapeDoubleQuotes }}" {{ end }}
-```
-
-**Naming:**
-
-❗ Pipe names must be camelCase without any space or special characters.
-
-**Available pipes:**
-
   - `inlinePowerShell`: Converts a multi-lined PowerShell script to a single line.
-- `escapeDoubleQuotes`: Escapes `"` characters for batch command execution, allows you to use them inside double quotes (`"`).
+  - `escapeDoubleQuotes`: Escapes `"` characters, allows you to use them inside double quotes (`"`).
+- **Example usages**
+  - `{{ with $code }} echo "{{ . | inlinePowerShell }}" {{ end }}`
+  - `{{ with $code }} echo "{{ . | inlinePowerShell | escapeDoubleQuotes }}" {{ end }}`

docs/tests.md

@@ -5,86 +5,77 @@ There are different types of tests executed:
 1. [Unit tests](#unit-tests)
 2. [Integration tests](#integration-tests)
 3. [End-to-end (E2E) tests](#e2e-tests)
-4. [Automated checks](#automated-checks)
 
-## Unit and integration tests
+Common aspects for all tests:
 
-- They utilize [Vitest](https://vitest.dev/).
+- They use [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com/).
-- Test files are suffixed with `.spec.ts`.
+- Their files end with `.spec.{ts|js}` suffix.
+
+💡 You can use path/module alias `@/tests` in import statements.
+
+## Unit tests
+
+- Unit tests test each component in isolation.
+- All unit tests goes under [`./tests/unit`](./../tests/unit).
+- They rely on [stubs](./../tests/unit/shared/Stubs) for isolation.
+
+### Unit tests structure
+
+- [`./src/`](./../src/)
+  - Includes source code that unit tests will test.
+- [`./tests/unit/`](./../tests/unit/)
+  - Includes test code.
+  - Tests follow same folder structure as [`./src/`](./../src).
+    - E.g. if system under test lies in [`./src/application/ApplicationFactory.ts`](./../src/application/ApplicationFactory.ts) then its tests would be in test would be at [`./tests/unit/application/ApplicationFactory.spec.ts`](./../tests/unit/application/ApplicationFactory.spec.ts).
+  - [`shared/`](./../tests/unit/shared/)
+    - Includes common functionality that's shared across unit tests.
+    - [`Assertions/`](./../tests/unit/shared/Assertions):
+      - Common assertions that extend [Chai Assertion Library](https://www.chaijs.com/).
+      - Asserting functions should start with `expect` prefix.
+    - [`TestCases/`](./../tests/unit/shared/TestCases/)
+      - Shared test cases.
+      - Functions that calls `it()` from [Mocha test framework](https://mochajs.org/) should have `it` prefix.
+        - E.g. `itEachAbsentCollectionValue()`.
+    - [`Stubs/`](./../tests/unit/shared/Stubs)
+      - Includes stubs to be able to test components in isolation.
+      - Stubs have minimal and dummy behavior to be functional, they may also have spying or mocking functions.
+
+### Unit tests naming
+
+- Each test suite first describe the system under test.
+  - E.g. tests for class `Application.ts` are all inside `Application.spec.ts`.
+- `describe` blocks tests for same function (if applicable).
+  - E.g. test for `run()` are inside `describe('run', () => ..)`.
 
 ### Act, arrange, assert
 
-- Tests implement the act, arrange, and assert (AAA) pattern.
+- Tests use act, arrange and assert (AAA) pattern when applicable.
 - **Arrange**
-  - Sets up the test scenario and environment.
+  - Sets up the test case.
-  - Begins with comment line `// arrange`.
+  - Starts with comment line `// arrange`.
 - **Act**
   - Executes the actual test.
-  - Begins with comment line `// act`.
+  - Starts with comment line `// act`.
 - **Assert**
-  - Sets an expectation for the test's outcome.
+  - Elicit some sort of expectation.
-  - Begins with comment line `// assert`.
+  - Starts with comment line `// assert`.
 
-### Unit tests
+## Integration tests
 
-- Evaluate individual components in isolation.
+- Tests functionality of a component in combination with others (not isolated).
-- Located in [`./tests/unit`](./../tests/unit).
+- Ensure dependencies to third parties work as expected.
-- Achieve isolation using [stubs](./../tests/unit/shared/Stubs).
+- Defined in [./tests/integration](./../tests/integration).
-- Include Vue component tests, enabled by `@vue/test-utils`.
-
-#### Unit tests naming
-
-- Test suites start with a description of the component or system under test.
-  - E.g., tests for `Application.ts` are contained in `Application.spec.ts`.
-- Whenever possible, `describe` blocks group tests of the same function.
-  - E.g., tests for `run()` are inside `describe('run', () => ...)`.
-
-### Integration tests
-
-- Assess the combined functionality of components.
-- They verify that third-party dependencies function as anticipated.
 
 ## E2E tests
 
-- Examine the live web application's functionality and performance.
+- Test the functionality and performance of a running application.
-- Uses Cypress to run the tests.
+- Vue CLI plugin  [`e2e-cypress`](https://github.com/vuejs/vue-cli/tree/dev/packages/@vue/cli-plugin-e2e-cypress#readme) configures E2E tests.
-
+- Test names and folders have logical structure based on tests executed.
-## Automated checks
+- The structure is following:
-
+  - [`cypress.config.ts`](./../cypress.config.ts): Cypress configuration file.
-These checks validate various qualities like runtime execution, building process, security testing, etc.
+  - [`./tests/e2e/`](./../tests/e2e/): Base Cypress folder.
-
+    - [`/specs/`](./../tests/e2e/specs/): Test files named with `.spec.js` extension.
-- Use [various tools](./../package.json) and [scripts](./../scripts).
+    - [`/plugins/index.js`](./../tests/e2e/plugins/index.js): Plugin file executed before loading project.
-- Are automatically executed as [GitHub workflows](./../.github/workflows).
+    - [`/support/index.js`](./../tests/e2e/support/index.js): Support file, runs before every single spec file.
-
+    - *(Ignored)* `/videos`: Asset folder for videos taken during tests.
-### Security checks
+    - *(Ignored)* `/screenshots`: Asset folder for Screenshots taken during tests.
-
-- [`checks.security.sast`](./../.github/workflows/checks.security.sast.yaml): Utilizes CodeQL to conduct Static Analysis Security Testing (SAST) to ensure the secure integrity of the codebase.
-- [`checks.security.dependencies`](./../.github/workflows/checks.security.dependencies.yaml): Performs audits on third-party dependencies to identify and mitigate potential vulnerabilities, safeguarding the project from exploitable weaknesses.
-
-## Tests structure
-
-- [`package.json`](./../package.json): Defines test commands and includes tools used in tests.
-- [`vite.config.ts`](./../vite.config.ts): Configures `vitest` for unit and integration tests.
-- [`./src/`](./../src/): Contains the code subject to testing.
-- [`./tests/shared/`](./../tests/shared/): Contains code shared by different test categories.
-  - [`bootstrap/setup.ts`](./../tests/shared/bootstrap/setup.ts): Initializes unit and integration tests.
-  - [`Assertions/`](./../tests/shared/Assertions/): Contains common assertion functions, prefixed with `expect`.
-- [`./tests/unit/`](./../tests/unit/)
-  - Stores unit test code.
-  - The directory structure mirrors [`./src/`](./../src).
-    - E.g., tests for [`./src/application/ApplicationFactory.ts`](./../src/application/ApplicationFactory.ts) reside in [`./tests/unit/application/ApplicationFactory.spec.ts`](./../tests/unit/application/ApplicationFactory.spec.ts).
-  - [`shared/`](./../tests/unit/shared/)
-    - Contains shared unit test functionalities.
-    - [`TestCases/`](./../tests/unit/shared/TestCases/)
-      - Shared test cases.
-      - Functions that calls `it()` from [Vitest](https://vitest.dev/) should have `it` prefix.
-    - [`Stubs/`](./../tests/unit/shared/Stubs): Maintains stubs for component isolation, equipped with basic functionalities and, when necessary, spying or mocking capabilities.
-- [`./tests/integration/`](./../tests/integration/): Contains integration test files.
-- [`cypress.config.ts`](./../cypress.config.ts): Cypress (E2E tests) configuration file.
-- [`cypress-dirs.json`](./../cypress-dirs.json): A central definition of directories used by Cypress, designed for reuse across different configurations.
-- [`./tests/e2e/`](./../tests/e2e/): Base Cypress folder, includes tests with `.cy.ts` extension.
-  - [`/tsconfig.json`]: TypeScript configuration for file Cypress code, improves IDE support, recommended to have by official documentation.
-  - *(git ignored)* `/videos`: Asset folder for videos taken during tests.
-  - *(git ignored)* `/screenshots`: Asset folder for Screenshots taken during tests.
-  - [`/support/e2e.ts`](./../tests/e2e/support/e2e.ts): Support file, runs before every single test file.
-  - [`/support/interactions/`](./../tests/e2e/support/interactions/): Contains reusable functions for simulating user interactions, enhancing test readability and maintainability.

electron-builder.cjs

@@ -1,43 +0,0 @@
-/* eslint-disable no-template-curly-in-string */
-
-const { join } = require('path');
-const { electronBundled, electronUnbundled } = require('./dist-dirs.json');
-
-module.exports = {
-  // Common options
-  publish: {
-    provider: 'github',
-    vPrefixedTagName: false, // default: true
-    releaseType: 'release', // default: draft
-  },
-  directories: {
-    output: electronBundled,
-  },
-  extraMetadata: {
-    main: join(electronUnbundled, 'main/index.cjs'), // do not `path.resolve`, it expects a relative path
-  },
-
-  // Windows
-  win: {
-    target: 'nsis',
-  },
-  nsis: {
-    artifactName: '${name}-Setup-${version}.${ext}',
-  },
-
-  // Linux
-  linux: {
-    target: 'AppImage',
-  },
-  appImage: {
-    artifactName: '${name}-${version}.${ext}',
-  },
-
-  // macOS
-  mac: {
-    target: 'dmg',
-  },
-  dmg: {
-    artifactName: '${name}-${version}.${ext}',
-  },
-};

electron.vite.config.ts

@@ -1,80 +0,0 @@
-import { resolve } from 'path';
-import { mergeConfig, UserConfig } from 'vite';
-import { defineConfig, externalizeDepsPlugin } from 'electron-vite';
-import { getAliasesFromTsConfig, getClientEnvironmentVariables } from './vite-config-helper';
-import { createVueConfig } from './vite.config';
-import distDirs from './dist-dirs.json' assert { type: 'json' };
-
-const MAIN_ENTRY_FILE = resolvePathFromProjectRoot('src/presentation/electron/main/index.ts');
-const PRELOAD_ENTRY_FILE = resolvePathFromProjectRoot('src/presentation/electron/preload/index.ts');
-const WEB_INDEX_HTML_PATH = resolvePathFromProjectRoot('src/presentation/index.html');
-const ELECTRON_DIST_SUBDIRECTORIES = {
-  main: resolveElectronDistSubdirectory('main'),
-  preload: resolveElectronDistSubdirectory('preload'),
-  renderer: resolveElectronDistSubdirectory('renderer'),
-};
-
-process.env.ELECTRON_ENTRY = resolve(ELECTRON_DIST_SUBDIRECTORIES.main, 'index.cjs');
-
-export default defineConfig({
-  main: getSharedElectronConfig({
-    distDirSubfolder: ELECTRON_DIST_SUBDIRECTORIES.main,
-    entryFilePath: MAIN_ENTRY_FILE,
-  }),
-  preload: getSharedElectronConfig({
-    distDirSubfolder: ELECTRON_DIST_SUBDIRECTORIES.preload,
-    entryFilePath: PRELOAD_ENTRY_FILE,
-  }),
-  renderer: mergeConfig(
-    createVueConfig({
-      supportLegacyBrowsers: false,
-    }),
-    {
-      build: {
-        outDir: ELECTRON_DIST_SUBDIRECTORIES.renderer,
-        rollupOptions: {
-          input: {
-            index: WEB_INDEX_HTML_PATH,
-          },
-        },
-      },
-    },
-  ),
-});
-
-function getSharedElectronConfig(options: {
-  readonly distDirSubfolder: string;
-  readonly entryFilePath: string;
-}): UserConfig {
-  return {
-    build: {
-      outDir: options.distDirSubfolder,
-      lib: {
-        entry: options.entryFilePath,
-      },
-      rollupOptions: {
-        output: {
-          entryFileNames: '[name].cjs', // This is needed so `type="module"` works
-        },
-      },
-    },
-    plugins: [externalizeDepsPlugin()],
-    define: {
-      ...getClientEnvironmentVariables(),
-    },
-    resolve: {
-      alias: {
-        ...getAliasesFromTsConfig(),
-      },
-    },
-  };
-}
-
-function resolvePathFromProjectRoot(pathSegment: string): string {
-  return resolve(__dirname, pathSegment);
-}
-
-function resolveElectronDistSubdirectory(subDirectory: string): string {
-  const electronDistDir = resolvePathFromProjectRoot(distDirs.electronUnbundled);
-  return resolve(electronDistDir, subDirectory);
-}

img/README.md

@@ -4,6 +4,9 @@ This folder contains image files and other resources related to images.
 
 ## logo.svg
 
-[`logo.svg`](./logo.svg) serves as the primary logo from which all other icons and images are derived.
+[logo.svg](./logo.svg) is the master logo from which all other icons or images are created from.
-Only modify this file manually.
+It should be the only file that will be changed manually.
-After making changes, execute `npm run build:icons` to regenerate logo files in various formats.
+
+[`logo-update.mjs`](./logo-update.mjs) script in this folder updates all the logo files.
+It should be executed everytime the logo is changed.
+It automates recreation of logo files in different formats.

img/logo-update.mjs

@@ -8,7 +8,7 @@ class Paths {
   constructor(selfDirectory) {
     const projectRoot = resolve(selfDirectory, '../');
     this.sourceImage = join(projectRoot, 'img/logo.svg');
-    this.publicDirectory = join(projectRoot, 'src/presentation/public');
+    this.publicDirectory = join(projectRoot, 'public');
     this.electronBuildDirectory = join(projectRoot, 'build');
   }
 
@@ -61,7 +61,7 @@ async function updateDesktopIcons(sourceImage, electronIconsDir) {
   await ensureFolderExists(electronIconsDir);
   const temporaryDir = await mkdtemp('icon-');
   const temporaryPngFile = join(temporaryDir, 'icon.png');
-  console.log(`Converting from SVG (${sourceImage}) to PNG: ${temporaryPngFile}`); // required by `icon-builder`
+  console.log(`Converting from SVG (${sourceImage}) to PNG: ${temporaryPngFile}`); // required by icon-builder
   await runCommand(
     'npx',
     'svgexport',

package.json

@@ -1,107 +1,112 @@
 {
   "name": "privacy.sexy",
-  "version": "0.12.7",
+  "version": "0.12.0",
   "private": true,
   "slogan": "Now you have the choice",
   "description": "Enforce privacy & security best-practices on Windows, macOS and Linux, because privacy is sexy 🍑🍆",
   "author": "undergroundwires",
-  "type": "module",
   "scripts": {
-    "dev": "vite",
+    "serve": "vue-cli-service serve",
-    "build": "vue-tsc --noEmit && vite build",
+    "build": "vue-cli-service build",
-    "preview": "vite preview",
+    "test:unit": "vue-cli-service test:unit",
-    "test:unit": "vitest run --dir tests/unit",
+    "test:e2e": "vue-cli-service test:e2e",
-    "test:integration": "vitest run --dir tests/integration",
-    "test:cy:run": "start-server-and-test \"vite build && vite preview --port 7070\" http://localhost:7070 \"cypress run --config baseUrl=http://localhost:7070\"",
-    "test:cy:open": "start-server-and-test \"vite --port 7070 --mode production\" http://localhost:7070 \"cypress open --config baseUrl=http://localhost:7070\"",
     "lint": "npm run lint:md && npm run lint:md:consistency && npm run lint:md:relative-urls && npm run lint:eslint && npm run lint:yaml",
-    "install-deps": "node scripts/npm-install.js",
+    "create-icons": "node img/logo-update.mjs",
-    "icons:build": "node scripts/logo-update.js",
+    "electron:build": "vue-cli-service electron:build",
-    "check:desktop": "vitest run --dir tests/checks/desktop-runtime-errors --environment node",
+    "electron:serve": "vue-cli-service electron:serve",
-    "check:external-urls": "vitest run --dir tests/checks/external-urls --environment node",
+    "lint:eslint": "vue-cli-service lint --no-fix --mode production",
-    "check:verify-build-artifacts": "node scripts/verify-build-artifacts",
-    "electron:dev": "electron-vite dev",
-    "electron:preview": "electron-vite preview",
-    "electron:prebuild": "electron-vite build",
-    "electron:build": "electron-builder",
-    "lint:eslint": "eslint . --max-warnings=0 --ignore-path .gitignore",
     "lint:md": "markdownlint **/*.md --ignore node_modules",
     "lint:md:consistency": "remark . --frail --use remark-preset-lint-consistent",
     "lint:md:relative-urls": "remark . --frail --use remark-validate-links",
     "lint:yaml": "yamllint **/*.yaml --ignore=node_modules/**/*.yaml",
     "postinstall": "electron-builder install-app-deps",
-    "postuninstall": "electron-builder install-app-deps"
+    "postuninstall": "electron-builder install-app-deps",
+    "test:integration": "vue-cli-service test:unit \"tests/integration/**/*.spec.ts\""
   },
+  "main": "index.js",
   "dependencies": {
-    "@floating-ui/vue": "^1.0.2",
+    "@fortawesome/fontawesome-svg-core": "^6.4.0",
+    "@fortawesome/free-brands-svg-icons": "^6.4.0",
+    "@fortawesome/free-regular-svg-icons": "^6.4.0",
+    "@fortawesome/free-solid-svg-icons": "^6.4.0",
+    "@fortawesome/vue-fontawesome": "^2.0.9",
     "@juggle/resize-observer": "^3.4.0",
-    "ace-builds": "^1.30.0",
+    "ace-builds": "^1.23.4",
+    "core-js": "^3.32.0",
     "cross-fetch": "^4.0.0",
-    "electron-log": "^4.4.8",
     "electron-progressbar": "^2.1.0",
-    "electron-updater": "^6.1.4",
     "file-saver": "^2.0.5",
-    "markdown-it": "^13.0.2",
+    "install": "^0.13.0",
-    "vue": "^3.3.7"
+    "liquor-tree": "^0.2.70",
+    "markdown-it": "^13.0.1",
+    "npm": "^9.8.1",
+    "v-tooltip": "2.1.3",
+    "vue": "^2.7.14",
+    "vue-class-component": "^7.2.6",
+    "vue-js-modal": "^2.0.1",
+    "vue-property-decorator": "^9.1.2"
   },
   "devDependencies": {
-    "@modyfi/vite-plugin-yaml": "^1.0.4",
+    "@rushstack/eslint-patch": "^1.3.2",
-    "@rushstack/eslint-patch": "^1.5.1",
+    "@types/ace": "^0.0.48",
-    "@types/ace": "^0.0.49",
+    "@types/chai": "^4.3.5",
     "@types/file-saver": "^2.0.5",
+    "@types/mocha": "^10.0.1",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
-    "@vitejs/plugin-legacy": "^4.1.1",
+    "@vue/cli-plugin-babel": "~5.0.8",
-    "@vitejs/plugin-vue": "^4.4.0",
+    "@vue/cli-plugin-e2e-cypress": "~5.0.8",
+    "@vue/cli-plugin-eslint": "~5.0.8",
+    "@vue/cli-plugin-typescript": "~5.0.8",
+    "@vue/cli-plugin-unit-mocha": "~5.0.8",
+    "@vue/cli-service": "~5.0.8",
     "@vue/eslint-config-airbnb-with-typescript": "^7.0.0",
     "@vue/eslint-config-typescript": "^11.0.3",
-    "@vue/test-utils": "^2.4.1",
+    "chai": "^4.3.7",
-    "autoprefixer": "^10.4.16",
+    "cypress": "^12.17.2",
-    "cypress": "^13.3.1",
+    "electron": "^25.3.2",
-    "electron": "^27.0.0",
+    "electron-builder": "^24.6.3",
-    "electron-builder": "^24.6.4",
     "electron-devtools-installer": "^3.2.0",
     "electron-icon-builder": "^2.0.1",
-    "electron-vite": "^1.0.28",
+    "electron-log": "^4.4.8",
-    "eslint": "^8.51.0",
+    "electron-updater": "^6.1.4",
-    "eslint-plugin-cypress": "^2.15.1",
+    "eslint": "^8.46.0",
-    "eslint-plugin-vue": "^9.17.0",
+    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-vuejs-accessibility": "^2.2.0",
+    "eslint-plugin-vue": "^9.6.0",
-    "icon-gen": "^4.0.0",
+    "eslint-plugin-vuejs-accessibility": "^1.2.0",
-    "jsdom": "^22.1.0",
+    "icon-gen": "^3.0.1",
-    "markdownlint-cli": "^0.37.0",
+    "js-yaml-loader": "^1.2.2",
-    "postcss": "^8.4.31",
+    "markdownlint-cli": "^0.35.0",
-    "remark-cli": "^12.0.0",
+    "remark-cli": "^11.0.0",
     "remark-lint-no-dead-urls": "^1.1.0",
     "remark-preset-lint-consistent": "^5.1.2",
-    "remark-validate-links": "^13.0.0",
+    "remark-validate-links": "^12.1.1",
-    "sass": "^1.69.3",
+    "sass": "^1.64.1",
-    "start-server-and-test": "^2.0.1",
+    "sass-loader": "^13.3.2",
     "svgexport": "^0.4.2",
-    "terser": "^5.21.0",
+    "ts-loader": "^9.4.4",
-    "tslib": "^2.6.2",
+    "typescript": "~4.6.2",
-    "typescript": "^5.2.2",
+    "vue-cli-plugin-electron-builder": "^3.0.0-alpha.4",
-    "vite": "^4.4.11",
+    "yaml-lint": "^1.7.0",
-    "vitest": "^0.34.6",
+    "tslib": "~2.4.0"
-    "vue-tsc": "^1.8.19",
+  },
-    "yaml-lint": "^1.7.0"
+  "overrides": {
+    "vue-cli-plugin-electron-builder": {
+      "electron-builder": "^24.6.3"
+    }
   },
   "//devDependencies": {
-    "terser": "Used by @vitejs/plugin-legacy for minification",
+    "typescript": [
-    "@rushstack/eslint-patch": "Needed by @vue/eslint-config-typescript",
+      "Cannot upgrade to 5.X.X due to unmaintained @vue/cli-plugin-typescript, https://github.com/vuejs/vue-cli/issues/7401",
-    "@vue/eslint-config-typescript": "Cannot upgrade to 12.X.X due to @vue/eslint-config-airbnb-with-typescript, https://github.com/vuejs/eslint-config-airbnb/issues/58",
+      "Cannot upgrade to > 4.6.X otherwise unit tests do not work, https://github.com/evanw/node-source-map-support/issues/252"
-    "@typescript-eslint/eslint-plugin": "Cannot upgrade to 6.X.X due to @vue/eslint-config-airbnb-with-typescript, https://github.com/vuejs/eslint-config-airbnb/issues/58",
+    ],
-    "@typescript-eslint/parser": "Cannot upgrade to 6.X.X due to @vue/eslint-config-airbnb-with-typescript, https://github.com/vuejs/eslint-config-airbnb/issues/58"
+    "tslib": "Cannot upgrade to > 2.4.X otherwise unit tests do not work, https://github.com/evanw/node-source-map-support/issues/252",
+    "@typescript-eslint/eslint-plugin": "Cannot upgrade to 6.X.X due to @vue/eslint-config-typescript, https://github.com/vuejs/eslint-config-typescript/pull/60",
+    "@typescript-eslint/parser": "Cannot upgrade to 6.X.X due to @vue/eslint-config-typescript, https://github.com/vuejs/eslint-config-typescript/pull/60"
   },
   "homepage": "https://privacy.sexy",
   "repository": {
     "type": "git",
     "url": "https://github.com/undergroundwires/privacy.sexy.git"
-  },
-  "optionalDependencies": {
-    "dmg-license": "^1.0.11"
-  },
-  "//optionalDependencies": {
-    "dmg-license": "Required by `electron-builder` for DMG builds on macOS, https://github.com/electron-userland/electron-builder/issues/6489, https://github.com/electron-userland/electron-builder/issues/6520"
   }
 }

postcss.config.cjs

@@ -1,9 +0,0 @@
-const autoprefixer = require('autoprefixer');
-
-module.exports = () => {
-  return {
-    plugins: [
-      autoprefixer(),
-    ],
-  };
-};

postcss.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  plugins: {
+    autoprefixer: {},
+  },
+};

public/index.html

@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1.0">
+    <title>Privacy is sexy 🍑🍆 - Enforce privacy & security on Windows, macOS and Linux</title>
+    <meta name="robots" content="index,follow" />
+    <meta name="description" content="Web tool to generate scripts for enforcing privacy & security best-practices such as stopping data collection of Windows and different softwares on it."/>
+    <link rel="icon" href="<%= BASE_URL %>favicon.ico">
+  </head>
+  <body>
+    <noscript>
+      <style>
+        #javascriptDisabled {
+          background:#eceef1;
+          margin: 5rem auto;
+          max-width: 800px;
+          font-size: 7px;
+          padding: 3rem;
+          border: 1px solid#333a45;
+          font-size: 1.5rem;
+          line-height: 150%;
+          font-family: 'Monaco', 'Menlo', 'Ubuntu Mono', 'Consolas', 'source-code-pro', monospace;
+        }
+      </style>
+      <div id="javascriptDisabled">
+        <h1>Problem loading page</h1>
+        <p>The page does not work without JavaScript enabled. Please enable it to use privacy.sexy. There's no shady stuff as 100% of the website is open source.</p>
+      </div>
+    </noscript>
+    <div id="app"></div>
+    <!-- built files will be auto injected -->
+  </body>
+</html>

scripts/fresh-npm-install.sh

@@ -0,0 +1,95 @@
+#!/usr/bin/env bash
+
+# Description:
+#   This script ensures npm is available, removes existing node modules, optionally
+#   removes package-lock.json (when -n flag is used), installs dependencies and runs unit tests.
+# Usage:
+#   ./fresh-npm-install.sh         # Regular execution
+#   ./fresh-npm-install.sh -n      # Non-deterministic mode (removes package-lock.json)
+
+declare NON_DETERMINISTIC_FLAG=0
+
+
+main() {
+  parse_args "$@"
+  ensure_npm_is_available
+  ensure_npm_root
+  remove_existing_modules
+  if [[ $NON_DETERMINISTIC_FLAG -eq 1 ]]; then
+    remove_package_lock_json
+  fi
+  install_dependencies
+  run_unit_tests
+}
+
+ensure_npm_is_available() {
+  if ! command -v npm &> /dev/null; then
+    log::fatal 'npm could not be found, please install it first.'
+  fi
+}
+
+ensure_npm_root() {
+  if [ ! -f package.json ]; then
+    log::fatal 'Current directory is not a npm root. Please run the script in a npm root directory.'
+  fi
+}
+
+remove_existing_modules() {
+  if [ -d ./node_modules ]; then
+    log::info 'Removing existing node modules...'
+    if ! rm -rf ./node_modules; then
+      log::fatal 'Could not remove existing node modules.'
+    fi
+  fi
+}
+
+install_dependencies() {
+  log::info 'Installing dependencies...'
+  if ! npm install; then
+    log::fatal 'Failed to install dependencies.'
+  fi
+}
+
+remove_package_lock_json() {
+  if [ -f ./package-lock.json ]; then
+    log::info 'Removing package-lock.json...'
+    if ! rm -rf ./package-lock.json; then
+      log::fatal 'Could not remove package-lock.json.'
+    fi
+  fi
+}
+
+run_unit_tests() {
+  log::info 'Running unit tests...'
+  if ! npm run test:unit; then
+    pwd
+    log::fatal 'Failed to run unit tests.'
+  fi
+}
+
+log::info() {
+  local -r message="$1"
+  echo "📣 ${message}"
+}
+
+log::fatal() {
+  local -r message="$1"
+  echo "❌ ${message}" >&2
+  exit 1
+}
+
+parse_args() {
+  while getopts "n" opt; do
+    case ${opt} in
+      n)
+        NON_DETERMINISTIC_FLAG=1
+        ;;
+      \?)
+        echo "Invalid option: $OPTARG" 1>&2
+        exit 1
+        ;;
+    esac
+  done
+}
+
+main "$1"

scripts/npm-install.js

@@ -1,199 +0,0 @@
-/*
-Description:
-  This script manages NPM dependencies for a project.
-  It offers capabilities like doing a fresh install, retries on network errors, and other features.
-
-Usage:
-  npm run install-deps [-- <options>]
-  node scripts/npm-install.js [options]
-
-Options:
-  --root-directory <path>
-    Specifies the root directory where package.json resides
-    Defaults to the current working directory.
-    Example: npm run install-deps -- --root-directory /your/path/here
-
-  --no-errors
-    Ignores errors and continues the execution.
-    Example: npm run install-deps -- --no-errors
-
-  --ci
-    Uses 'npm ci' for dependency installation instead of 'npm install'.
-    Example: npm run install-deps -- --ci
-
-  --fresh
-    Removes the existing node_modules directory before installing dependencies.
-    Example: npm run install-deps -- --fresh
-
-  --non-deterministic
-    Removes package-lock.json for a non-deterministic installation.
-    Example: npm run install-deps -- --non-deterministic
-
-Note:
-
-  Flags can be combined as needed.
-  Example: npm run install-deps -- --fresh --non-deterministic
-*/
-
-import { exec } from 'child_process';
-import { resolve } from 'path';
-import { access, rm, unlink } from 'fs/promises';
-import { constants } from 'fs';
-
-const MAX_RETRIES = 5;
-const RETRY_DELAY_IN_MS = 5 /* seconds */ * 1000;
-const ARG_NAMES = {
-  rootDirectory: '--root-directory',
-  ignoreErrors: '--no-errors',
-  ci: '--ci',
-  fresh: '--fresh',
-  nonDeterministic: '--non-deterministic',
-};
-
-async function main() {
-  const options = getOptions();
-  console.log('Options:', options);
-  await ensureNpmRootDirectory(options.rootDirectory);
-  await ensureNpmIsAvailable();
-  if (options.fresh) {
-    await removeNodeModules(options.rootDirectory);
-  }
-  if (options.nonDeterministic) {
-    await removePackageLockJson(options.rootDirectory);
-  }
-  const command = buildCommand(options.ci, options.outputErrors);
-  console.log('Starting dependency installation...');
-  const exitCode = await executeWithRetry(
-    command,
-    options.workingDirectory,
-    MAX_RETRIES,
-    RETRY_DELAY_IN_MS,
-  );
-  if (exitCode === 0) {
-    console.log('🎊 Installed dependencies...');
-  } else {
-    console.error(`💀 Failed to install dependencies, exit code: ${exitCode}`);
-  }
-  process.exit(exitCode);
-}
-
-async function removeNodeModules(workingDirectory) {
-  const nodeModulesDirectory = resolve(workingDirectory, 'node_modules');
-  if (await exists('./node_modules')) {
-    console.log('Removing node_modules...');
-    await rm(nodeModulesDirectory, { recursive: true });
-  }
-}
-
-async function removePackageLockJson(workingDirectory) {
-  const packageLockJsonFile = resolve(workingDirectory, 'package-lock.json');
-  if (await exists(packageLockJsonFile)) {
-    console.log('Removing package-lock.json...');
-    await unlink(packageLockJsonFile);
-  }
-}
-
-async function ensureNpmIsAvailable() {
-  const exitCode = await executeCommand('npm --version');
-  if (exitCode !== 0) {
-    throw new Error('`npm` in not available!');
-  }
-}
-
-async function ensureNpmRootDirectory(workingDirectory) {
-  const packageJsonPath = resolve(workingDirectory, 'package.json');
-  if (!await exists(packageJsonPath)) {
-    throw new Error(`Not an NPM project root: ${workingDirectory}`);
-  }
-}
-
-function buildCommand(ci, outputErrors) {
-  const baseCommand = ci ? 'npm ci' : 'npm install';
-  if (!outputErrors) {
-    return `${baseCommand} --loglevel=error`;
-  }
-  return baseCommand;
-}
-
-function getOptions() {
-  const processArgs = process.argv.slice(2); // Slice off the node and script name
-  return {
-    rootDirectory: processArgs.includes('--root-directory') ? processArgs[processArgs.indexOf('--root-directory') + 1] : process.cwd(),
-    outputErrors: !processArgs.includes(ARG_NAMES.ignoreErrors),
-    ci: processArgs.includes(ARG_NAMES.ci),
-    fresh: processArgs.includes(ARG_NAMES.fresh),
-    nonDeterministic: processArgs.includes(ARG_NAMES.nonDeterministic),
-  };
-}
-
-async function executeWithRetry(
-  command,
-  workingDirectory,
-  maxRetries,
-  retryDelayInMs,
-  currentAttempt = 1,
-) {
-  const statusCode = await executeCommand(command, workingDirectory, true, true);
-  if (statusCode === 0 || currentAttempt >= maxRetries) {
-    return statusCode;
-  }
-
-  console.log(`⚠️🔄 Attempt ${currentAttempt} failed. Retrying in ${retryDelayInMs / 1000} seconds...`);
-  await sleep(retryDelayInMs);
-
-  const retryResult = await executeWithRetry(
-    command,
-    workingDirectory,
-    maxRetries,
-    retryDelayInMs,
-    currentAttempt + 1,
-  );
-  return retryResult;
-}
-
-async function executeCommand(
-  command,
-  workingDirectory = process.cwd(),
-  logStdout = false,
-  logCommand = false,
-) {
-  if (logCommand) {
-    console.log(`▶️ Executing command "${command}" at "${workingDirectory}"`);
-  }
-  const process = exec(
-    command,
-    {
-      cwd: workingDirectory,
-    },
-  );
-  if (logStdout) {
-    process.stdout.on('data', (data) => {
-      console.log(data.toString());
-    });
-  }
-  process.stderr.on('data', (data) => {
-    console.error(data.toString());
-  });
-  return new Promise((resolve) => {
-    process.on('exit', (code) => {
-      resolve(code);
-    });
-  });
-}
-
-function sleep(milliseconds) {
-  return new Promise((resolve) => {
-    setTimeout(resolve, milliseconds);
-  });
-}
-
-async function exists(path) {
-  try {
-    await access(path, constants.F_OK);
-    return true;
-  } catch {
-    return false;
-  }
-}
-
-await main();

scripts/print-dist-dir.js

@@ -1,58 +0,0 @@
-/**
- * Description:
- *   This script determines the absolute path of a distribution directory based on CLI arguments
- *   and outputs its absolute path. It is designed to be run programmatically by other scripts.
- *
- * Usage:
- *   node scripts/print-dist-dir.js [options]
- *
- * Options:
- *   --electron-unbundled   Path for the unbundled Electron application
- *   --electron-bundled     Path for the bundled Electron application
- *   --web                  Path for the web application
- */
-
-import { resolve } from 'path';
-import { readFile } from 'fs/promises';
-
-const DIST_DIRS_JSON_FILE_PATH = resolve(process.cwd(), 'dist-dirs.json'); // cannot statically import because ESLint does not support it https://github.com/eslint/eslint/discussions/15305
-const CLI_ARGUMENTS = process.argv.slice(2);
-
-async function main() {
-  const distDirs = await readDistDirsJsonFile(DIST_DIRS_JSON_FILE_PATH);
-  const relativeDistDir = determineRelativeDistDir(distDirs, CLI_ARGUMENTS);
-  const absoluteDistDir = resolve(process.cwd(), relativeDistDir);
-  console.log(absoluteDistDir);
-}
-
-function mapCliFlagsToDistDirs(distDirs) {
-  return {
-    '--electron-unbundled': distDirs.electronUnbundled,
-    '--electron-bundled': distDirs.electronBundled,
-    '--web': distDirs.web,
-  };
-}
-
-function determineRelativeDistDir(distDirsJsonObject, cliArguments) {
-  const cliFlagDistDirMap = mapCliFlagsToDistDirs(distDirsJsonObject);
-  const availableCliFlags = Object.keys(cliFlagDistDirMap);
-  const requestedCliFlags = cliArguments.filter((arg) => {
-    return availableCliFlags.includes(arg);
-  });
-  if (!requestedCliFlags.length) {
-    throw new Error(`No distribution directory was requested. Please use one of these flags: ${availableCliFlags.join(', ')}`);
-  }
-  if (requestedCliFlags.length > 1) {
-    throw new Error(`Multiple distribution directories were requested, but this script only supports one: ${requestedCliFlags.join(', ')}`);
-  }
-  const selectedCliFlag = requestedCliFlags[0];
-  return cliFlagDistDirMap[selectedCliFlag];
-}
-
-async function readDistDirsJsonFile(absoluteConfigJsonFilePath) {
-  const fileContentAsText = await readFile(absoluteConfigJsonFilePath, 'utf8');
-  const parsedJsonData = JSON.parse(fileContentAsText);
-  return parsedJsonData;
-}
-
-await main();

scripts/verify-build-artifacts.js

@@ -1,133 +0,0 @@
-/**
- * Description:
- *   This script verifies the existence and content of build artifacts based on the
- *   provided CLI flags. It exists with exit code `0` if all verifications pass, otherwise
- *   with exit code `1`.
- *
- * Usage:
- *   node scripts/verify-build-artifacts.js [options]
- *
- * Options:
- *   --electron-unbundled    Verify artifacts for the unbundled Electron application.
- *   --electron-bundled      Verify artifacts for the bundled Electron application.
- *   --web                   Verify artifacts for the web application.
- */
-
-import { access, readdir } from 'fs/promises';
-import { exec } from 'child_process';
-import { resolve } from 'path';
-
-const PROCESS_ARGUMENTS = process.argv.slice(2);
-const PRINT_DIST_DIR_SCRIPT_BASE_COMMAND = 'node scripts/print-dist-dir';
-
-async function main() {
-  const buildConfigs = getBuildVerificationConfigs();
-  if (!anyCommandsFound(Object.keys(buildConfigs))) {
-    die(`No valid command found in process arguments. Expected one of: ${Object.keys(buildConfigs).join(', ')}`);
-  }
-  /* eslint-disable no-await-in-loop */
-  for (const [command, config] of Object.entries(buildConfigs)) {
-    if (PROCESS_ARGUMENTS.includes(command)) {
-      const distDir = await executePrintDistDirScript(config.printDistDirScriptArgument);
-      await verifyDirectoryExists(distDir);
-      await verifyNonEmptyDirectory(distDir);
-      await verifyFilesExist(distDir, config.filePatterns);
-    }
-  }
-  /* eslint-enable no-await-in-loop */
-  console.log('✅ Build completed successfully and all expected artifacts are in place.');
-  process.exit(0);
-}
-
-function getBuildVerificationConfigs() {
-  return {
-    '--electron-unbundled': {
-      printDistDirScriptArgument: '--electron-unbundled',
-      filePatterns: [
-        /main[/\\]index\.cjs/,
-        /preload[/\\]index\.cjs/,
-        /renderer[/\\]index\.htm(l)?/,
-      ],
-    },
-    '--electron-bundled': {
-      printDistDirScriptArgument: '--electron-bundled',
-      filePatterns: [
-        /latest.*\.yml/, // generates latest.yml for auto-updates
-        /.*-\d+\.\d+\.\d+\..*/, // a file with extension and semantic version (packaged application)
-      ],
-    },
-    '--web': {
-      printDistDirScriptArgument: '--web',
-      filePatterns: [
-        /index\.htm(l)?/,
-      ],
-    },
-  };
-}
-
-function anyCommandsFound(commands) {
-  return PROCESS_ARGUMENTS.some((arg) => commands.includes(arg));
-}
-
-async function verifyDirectoryExists(directoryPath) {
-  try {
-    await access(directoryPath);
-  } catch (error) {
-    die(`Directory does not exist at \`${directoryPath}\`:\n\t${error.message}`);
-  }
-}
-
-async function verifyNonEmptyDirectory(directoryPath) {
-  const files = await readdir(directoryPath);
-  if (files.length === 0) {
-    die(`Directory is empty at \`${directoryPath}\``);
-  }
-}
-
-async function verifyFilesExist(directoryPath, filePatterns) {
-  const files = await listAllFilesRecursively(directoryPath);
-  for (const pattern of filePatterns) {
-    const match = files.some((file) => pattern.test(file));
-    if (!match) {
-      die(
-        `No file matches the pattern ${pattern.source} in directory \`${directoryPath}\``,
-        `\nFiles in directory:\n${files.map((file) => `\t- ${file}`).join('\n')}`,
-      );
-    }
-  }
-}
-
-async function listAllFilesRecursively(directoryPath) {
-  const dir = await readdir(directoryPath, { withFileTypes: true });
-  const files = await Promise.all(dir.map(async (dirent) => {
-    const absolutePath = resolve(directoryPath, dirent.name);
-    if (dirent.isDirectory()) {
-      return listAllFilesRecursively(absolutePath);
-    }
-    return absolutePath;
-  }));
-  return files.flat();
-}
-
-async function executePrintDistDirScript(flag) {
-  return new Promise((resolve, reject) => {
-    const commandToRun = `${PRINT_DIST_DIR_SCRIPT_BASE_COMMAND} ${flag}`;
-
-    exec(commandToRun, (error, stdout, stderr) => {
-      if (error) {
-        reject(new Error(`Execution failed with error: ${error}`));
-      } else if (stderr) {
-        reject(new Error(`Execution failed with stderr: ${stderr}`));
-      } else {
-        resolve(stdout.trim());
-      }
-    });
-  });
-}
-
-function die(...message) {
-  console.error(...message);
-  process.exit(1);
-}
-
-await main();

scripts/verify-web-server-status.js

@@ -1,62 +0,0 @@
-/**
- * Description:
- *   This script checks if a server, provided as a CLI argument, is up
- *   and returns an HTTP 200 status code.
- *   It is designed to provide easy verification of server availability
- *   and will retry a specified number of times.
- *
- * Usage:
- *   node ./scripts/verify-web-server-status.js --url [URL]
- *
- * Options:
- *   --url   URL of the server to check
- */
-
-import { get } from 'http';
-
-const MAX_RETRIES = 30;
-const RETRY_DELAY_IN_SECONDS = 3;
-const URL_PARAMETER_NAME = '--url';
-
-function checkServer(currentRetryCount = 1) {
-  const serverUrl = getServerUrl();
-  console.log(`Requesting ${serverUrl}...`);
-  get(serverUrl, (res) => {
-    if (res.statusCode === 200) {
-      console.log('🎊 Success: The server is up and returned HTTP 200.');
-      process.exit(0);
-    } else {
-      console.log(`Server returned HTTP status code ${res.statusCode}.`);
-      retry(currentRetryCount);
-    }
-  }).on('error', (err) => {
-    console.error('Error making the request:', err);
-    retry(currentRetryCount);
-  });
-}
-
-function retry(currentRetryCount) {
-  console.log(`Attempt ${currentRetryCount}/${MAX_RETRIES}:`);
-  console.log(`Retrying in ${RETRY_DELAY_IN_SECONDS} seconds.`);
-
-  const remainingTime = (MAX_RETRIES - currentRetryCount) * RETRY_DELAY_IN_SECONDS;
-  console.log(`Time remaining before timeout: ${remainingTime}s`);
-
-  if (currentRetryCount < MAX_RETRIES) {
-    setTimeout(() => checkServer(currentRetryCount + 1), RETRY_DELAY_IN_SECONDS * 1000);
-  } else {
-    console.log('Failure: The server at did not return HTTP 200 within the allocated time. Exiting.');
-    process.exit(1);
-  }
-}
-
-function getServerUrl() {
-  const urlIndex = process.argv.indexOf(URL_PARAMETER_NAME);
-  if (urlIndex === -1 || urlIndex === process.argv.length - 1) {
-    console.error(`Parameter "${URL_PARAMETER_NAME}" is not provided.`);
-    process.exit(1);
-  }
-  return process.argv[urlIndex + 1];
-}
-
-checkServer();

src/TypeHelpers.ts

@@ -1,16 +0,0 @@
-export type Constructible<T, TArgs extends unknown[] = never> = {
-  prototype: T;
-  apply: (this: unknown, args: TArgs) => void;
-  readonly name: string;
-};
-
-export type PropertyKeys<T> = {
-  [K in keyof T]: T[K] extends (...args: unknown[]) => unknown ? never : K;
-}[keyof T];
-
-export type ConstructorArguments<T> =
-  T extends new (...args: infer U) => unknown ? U : never;
-
-export type FunctionKeys<T> = {
-  [K in keyof T]: T[K] extends (...args: unknown[]) => unknown ? K : never;
-}[keyof T];

src/application/ApplicationFactory.ts

@@ -12,6 +12,9 @@ export class ApplicationFactory implements IApplicationFactory {
   private readonly getter: AsyncLazy<IApplication>;
 
   protected constructor(costlyGetter: ApplicationGetterType) {
+    if (!costlyGetter) {
+      throw new Error('missing getter');
+    }
     this.getter = new AsyncLazy<IApplication>(() => Promise.resolve(costlyGetter()));
   }
 

src/application/Common/Array.ts

@@ -1,5 +1,7 @@
 // Compares to Array<T> objects for equality, ignoring order
 export function scrambledEqual<T>(array1: readonly T[], array2: readonly T[]) {
+  if (!array1) { throw new Error('missing first array'); }
+  if (!array2) { throw new Error('missing second array'); }
   const sortedArray1 = sort(array1);
   const sortedArray2 = sort(array2);
   return sequenceEqual(sortedArray1, sortedArray2);
@@ -10,6 +12,8 @@ export function scrambledEqual<T>(array1: readonly T[], array2: readonly T[]) {
 
 // Compares to Array<T> objects for equality in same order
 export function sequenceEqual<T>(array1: readonly T[], array2: readonly T[]) {
+  if (!array1) { throw new Error('missing first array'); }
+  if (!array2) { throw new Error('missing second array'); }
   if (array1.length !== array2.length) {
     return false;
   }

src/application/Common/CustomError.ts

@@ -1,57 +0,0 @@
-/*
-  Provides a unified and resilient way to extend errors across platforms.
-
-  Rationale:
-  - Babel:
-    > "Built-in classes cannot be properly subclassed due to limitations in ES5"
-    > https://web.archive.org/web/20230810014108/https://babeljs.io/docs/caveats#classes
-  - TypeScript:
-    > "Extending built-ins like Error, Array, and Map may no longer work"
-    > https://web.archive.org/web/20230810014143/https://github.com/Microsoft/TypeScript-wiki/blob/main/Breaking-Changes.md#extending-built-ins-like-error-array-and-map-may-no-longer-work
-*/
-export abstract class CustomError extends Error {
-  constructor(message?: string, options?: ErrorOptions) {
-    super(message, options);
-
-    fixPrototype(this, new.target.prototype);
-    ensureStackTrace(this);
-
-    this.name = this.constructor.name;
-  }
-}
-
-interface ErrorPrototypeManipulation {
-  getSetPrototypeOf: () => (typeof Object.setPrototypeOf | undefined);
-  getCaptureStackTrace: () => (typeof Error.captureStackTrace | undefined);
-}
-
-export const PlatformErrorPrototypeManipulation: ErrorPrototypeManipulation = {
-  getSetPrototypeOf: () => Object.setPrototypeOf,
-  getCaptureStackTrace: () => Error.captureStackTrace,
-};
-
-function fixPrototype(target: Error, prototype: CustomError) {
-  // This is recommended by TypeScript guidelines.
-  //  Source: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
-  //  Snapshots: https://web.archive.org/web/20231111234849/https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget, https://archive.ph/tr7cX#support-for-newtarget
-  const setPrototypeOf = PlatformErrorPrototypeManipulation.getSetPrototypeOf();
-  if (!isFunction(setPrototypeOf)) {
-    return;
-  }
-  setPrototypeOf(target, prototype);
-}
-
-function ensureStackTrace(target: Error) {
-  const captureStackTrace = PlatformErrorPrototypeManipulation.getCaptureStackTrace();
-  if (!isFunction(captureStackTrace)) {
-    // captureStackTrace is only available on V8, if it's not available
-    // modern JS engines will usually generate a stack trace on error objects when they're thrown.
-    return;
-  }
-  captureStackTrace(target, target.constructor);
-}
-
-// eslint-disable-next-line @typescript-eslint/ban-types
-function isFunction(func: unknown): func is Function {
-  return typeof func === 'function';
-}

src/application/Common/Enum.ts

@@ -54,6 +54,9 @@ export function assertInRange<T extends EnumType, TEnumValue extends EnumType>(
   value: TEnumValue,
   enumVariable: EnumVariable<T, TEnumValue>,
 ) {
+  if (value === undefined || value === null) {
+    throw new Error('absent enum value');
+  }
   if (!(value in enumVariable)) {
     throw new RangeError(`enum value "${value}" is out of range`);
   }

src/application/Common/ScriptingLanguage/ScriptingLanguageFactory.ts

@@ -9,16 +9,19 @@ export abstract class ScriptingLanguageFactory<T> implements IScriptingLanguageF
 
   public create(language: ScriptingLanguage): T {
     assertInRange(language, ScriptingLanguage);
-    const getter = this.getters.get(language);
+    if (!this.getters.has(language)) {
-    if (!getter) {
       throw new RangeError(`unknown language: "${ScriptingLanguage[language]}"`);
     }
+    const getter = this.getters.get(language);
     const instance = getter();
     return instance;
   }
 
   protected registerGetter(language: ScriptingLanguage, getter: Getter<T>) {
     assertInRange(language, ScriptingLanguage);
+    if (!getter) {
+      throw new Error('missing getter');
+    }
     if (this.getters.has(language)) {
       throw new Error(`${ScriptingLanguage[language]} is already registered`);
     }

src/application/Common/Timing/BatchedDebounce.ts

@@ -1,27 +0,0 @@
-import { PlatformTimer } from './PlatformTimer';
-import { TimeoutType, Timer } from './Timer';
-
-export function batchedDebounce<T>(
-  callback: (batches: readonly T[]) => void,
-  waitInMs: number,
-  timer: Timer = PlatformTimer,
-): (arg: T) => void {
-  let lastTimeoutId: TimeoutType | undefined;
-  let batches: Array<T> = [];
-
-  return (arg: T) => {
-    batches.push(arg);
-
-    const later = () => {
-      callback(batches);
-      batches = [];
-      lastTimeoutId = undefined;
-    };
-
-    if (lastTimeoutId !== undefined) {
-      timer.clearTimeout(lastTimeoutId);
-    }
-
-    lastTimeoutId = timer.setTimeout(later, waitInMs);
-  };
-}

src/application/Common/Timing/PlatformTimer.ts

@@ -1,7 +0,0 @@
-import { Timer } from './Timer';
-
-export const PlatformTimer: Timer = {
-  setTimeout: (callback, ms) => setTimeout(callback, ms),
-  clearTimeout: (timeoutId) => clearTimeout(timeoutId),
-  dateNow: () => Date.now(),
-};

src/application/Common/Timing/Timer.ts

@@ -1,8 +0,0 @@
-// Allows aligning with both NodeJs (NodeJs.Timeout) and Window type (number)
-export type TimeoutType = ReturnType<typeof setTimeout>;
-
-export interface Timer {
-  setTimeout: (callback: () => void, ms: number) => TimeoutType;
-  clearTimeout: (timeoutId: TimeoutType) => void;
-  dateNow(): number;
-}

src/application/Context/ApplicationContext.ts

@@ -26,6 +26,7 @@ export class ApplicationContext implements IApplicationContext {
     public readonly app: IApplication,
     initialContext: OperatingSystem,
   ) {
+    validateApp(app);
     this.states = initializeStates(app);
     this.changeContext(initialContext);
   }
@@ -35,8 +36,10 @@ export class ApplicationContext implements IApplicationContext {
     if (this.currentOs === os) {
       return;
     }
-    const collection = this.app.getCollection(os);
+    this.collection = this.app.getCollection(os);
-    this.collection = collection;
+    if (!this.collection) {
+      throw new Error(`os "${OperatingSystem[os]}" is not defined in application`);
+    }
     const event: IApplicationContextChangedEvent = {
       newState: this.states[os],
       oldState: this.states[this.currentOs],
@@ -46,6 +49,12 @@ export class ApplicationContext implements IApplicationContext {
   }
 }
 
+function validateApp(app: IApplication) {
+  if (!app) {
+    throw new Error('missing app');
+  }
+}
+
 function initializeStates(app: IApplication): StateMachine {
   const machine = new Map<OperatingSystem, ICategoryCollectionState>();
   for (const collection of app.collections) {

src/application/Context/ApplicationContextFactory.ts

@@ -1,32 +1,29 @@
 import { IApplicationContext } from '@/application/Context/IApplicationContext';
 import { OperatingSystem } from '@/domain/OperatingSystem';
 import { IApplication } from '@/domain/IApplication';
-import { RuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironment';
+import { Environment } from '../Environment/Environment';
+import { IEnvironment } from '../Environment/IEnvironment';
 import { IApplicationFactory } from '../IApplicationFactory';
 import { ApplicationFactory } from '../ApplicationFactory';
 import { ApplicationContext } from './ApplicationContext';
 
 export async function buildContext(
   factory: IApplicationFactory = ApplicationFactory.Current,
-  environment = RuntimeEnvironment.CurrentEnvironment,
+  environment = Environment.CurrentEnvironment,
 ): Promise<IApplicationContext> {
+  if (!factory) { throw new Error('missing factory'); }
+  if (!environment) { throw new Error('missing environment'); }
   const app = await factory.getApp();
-  const os = getInitialOs(app, environment.os);
+  const os = getInitialOs(app, environment);
   return new ApplicationContext(app, os);
 }
 
-function getInitialOs(
+function getInitialOs(app: IApplication, environment: IEnvironment): OperatingSystem {
-  app: IApplication,
+  const currentOs = environment.os;
-  currentOs: OperatingSystem | undefined,
-): OperatingSystem {
   const supportedOsList = app.getSupportedOsList();
-  if (currentOs !== undefined && supportedOsList.includes(currentOs)) {
+  if (supportedOsList.includes(currentOs)) {
     return currentOs;
   }
-  return getMostSupportedOs(supportedOsList, app);
-}
-
-function getMostSupportedOs(supportedOsList: OperatingSystem[], app: IApplication) {
   supportedOsList.sort((os1, os2) => {
     const getPriority = (os: OperatingSystem) => app.getCollection(os).totalScripts;
     return getPriority(os2) - getPriority(os1);

src/application/Context/State/CategoryCollectionState.ts

@@ -4,48 +4,23 @@ import { UserFilter } from './Filter/UserFilter';
 import { IUserFilter } from './Filter/IUserFilter';
 import { ApplicationCode } from './Code/ApplicationCode';
 import { UserSelection } from './Selection/UserSelection';
+import { IUserSelection } from './Selection/IUserSelection';
 import { ICategoryCollectionState } from './ICategoryCollectionState';
 import { IApplicationCode } from './Code/IApplicationCode';
-import { UserSelectionFacade } from './Selection/UserSelectionFacade';
 
 export class CategoryCollectionState implements ICategoryCollectionState {
   public readonly os: OperatingSystem;
 
   public readonly code: IApplicationCode;
 
-  public readonly selection: UserSelection;
+  public readonly selection: IUserSelection;
 
   public readonly filter: IUserFilter;
 
-  public constructor(
+  public constructor(readonly collection: ICategoryCollection) {
-    public readonly collection: ICategoryCollection,
+    this.selection = new UserSelection(collection, []);
-    selectionFactory = DefaultSelectionFactory,
+    this.code = new ApplicationCode(this.selection, collection.scripting);
-    codeFactory = DefaultCodeFactory,
+    this.filter = new UserFilter(collection);
-    filterFactory = DefaultFilterFactory,
-  ) {
-    this.selection = selectionFactory(collection, []);
-    this.code = codeFactory(this.selection.scripts, collection.scripting);
-    this.filter = filterFactory(collection);
     this.os = collection.os;
   }
 }
-
-export type CodeFactory = (
-  ...params: ConstructorParameters<typeof ApplicationCode>
-) => IApplicationCode;
-
-const DefaultCodeFactory: CodeFactory = (...params) => new ApplicationCode(...params);
-
-export type SelectionFactory = (
-  ...params: ConstructorParameters<typeof UserSelectionFacade>
-) => UserSelection;
-
-const DefaultSelectionFactory: SelectionFactory = (
-  ...params
-) => new UserSelectionFacade(...params);
-
-export type FilterFactory = (
-  ...params: ConstructorParameters<typeof UserFilter>
-) => IUserFilter;
-
-const DefaultFilterFactory: FilterFactory = (...params) => new UserFilter(...params);

src/application/Context/State/Code/ApplicationCode.ts

@@ -1,7 +1,7 @@
+import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
+import { IReadOnlyUserSelection } from '@/application/Context/State/Selection/IUserSelection';
 import { EventSource } from '@/infrastructure/Events/EventSource';
 import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
-import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
-import { ReadonlyScriptSelection } from '@/application/Context/State/Selection/Script/ScriptSelection';
 import { CodeChangedEvent } from './Event/CodeChangedEvent';
 import { CodePosition } from './Position/CodePosition';
 import { ICodeChangedEvent } from './Event/ICodeChangedEvent';
@@ -17,12 +17,15 @@ export class ApplicationCode implements IApplicationCode {
   private scriptPositions = new Map<SelectedScript, CodePosition>();
 
   constructor(
-    selection: ReadonlyScriptSelection,
+    userSelection: IReadOnlyUserSelection,
     private readonly scriptingDefinition: IScriptingDefinition,
     private readonly generator: IUserScriptGenerator = new UserScriptGenerator(),
   ) {
-    this.setCode(selection.selectedScripts);
+    if (!userSelection) { throw new Error('missing userSelection'); }
-    selection.changed.on((scripts) => {
+    if (!scriptingDefinition) { throw new Error('missing scriptingDefinition'); }
+    if (!generator) { throw new Error('missing generator'); }
+    this.setCode(userSelection.selectedScripts);
+    userSelection.changed.on((scripts) => {
       this.setCode(scripts);
     });
   }

src/application/Context/State/Code/Event/CodeChangedEvent.ts

@@ -1,6 +1,6 @@
 import { IScript } from '@/domain/IScript';
 import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
-import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
+import { SelectedScript } from '../../Selection/SelectedScript';
 import { ICodeChangedEvent } from './ICodeChangedEvent';
 
 export class CodeChangedEvent implements ICodeChangedEvent {
@@ -36,18 +36,7 @@ export class CodeChangedEvent implements ICodeChangedEvent {
   }
 
   public getScriptPositionInCode(script: IScript): ICodePosition {
-    return this.getPositionById(script.id);
+    return this.scripts.get(script);
-  }
-
-  private getPositionById(scriptId: string): ICodePosition {
-    const position = [...this.scripts.entries()]
-      .filter(([s]) => s.id === scriptId)
-      .map(([, pos]) => pos)
-      .at(0);
-    if (!position) {
-      throw new Error('Unknown script: Position could not be found for the script');
-    }
-    return position;
   }
 }
 

src/application/Context/State/Code/Event/ICodeChangedEvent.ts

@@ -3,9 +3,9 @@ import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePo
 
 export interface ICodeChangedEvent {
   readonly code: string;
-  readonly addedScripts: ReadonlyArray<IScript>;
+  addedScripts: ReadonlyArray<IScript>;
-  readonly removedScripts: ReadonlyArray<IScript>;
+  removedScripts: ReadonlyArray<IScript>;
-  readonly changedScripts: ReadonlyArray<IScript>;
+  changedScripts: ReadonlyArray<IScript>;
   isEmpty(): boolean;
   getScriptPositionInCode(script: IScript): ICodePosition;
 }

src/application/Context/State/Code/Generation/CodeBuilder.ts

@@ -16,9 +16,7 @@ export abstract class CodeBuilder implements ICodeBuilder {
       return this;
     }
     const lines = code.match(/[^\r\n]+/g);
-    if (lines) {
     this.lines.push(...lines);
-    }
     return this;
   }
 

src/application/Context/State/Code/Generation/IUserScript.ts

@@ -1,7 +1,7 @@
+import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
 import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
-import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
 
 export interface IUserScript {
-  readonly code: string;
+  code: string;
-  readonly scriptPositions: Map<SelectedScript, ICodePosition>;
+  scriptPositions: Map<SelectedScript, ICodePosition>;
 }

src/application/Context/State/Code/Generation/IUserScriptGenerator.ts

@@ -1,10 +1,9 @@
+import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
 import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
-import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
 import { IUserScript } from './IUserScript';
 
 export interface IUserScriptGenerator {
   buildCode(
     selectedScripts: ReadonlyArray<SelectedScript>,
-    scriptingDefinition: IScriptingDefinition,
+    scriptingDefinition: IScriptingDefinition): IUserScript;
-  ): IUserScript;
 }

src/application/Context/State/Code/Generation/UserScriptGenerator.ts

@@ -1,6 +1,6 @@
+import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
 import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
 import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
-import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
 import { CodePosition } from '../Position/CodePosition';
 import { IUserScriptGenerator } from './IUserScriptGenerator';
 import { IUserScript } from './IUserScript';
@@ -17,6 +17,8 @@ export class UserScriptGenerator implements IUserScriptGenerator {
     selectedScripts: ReadonlyArray<SelectedScript>,
     scriptingDefinition: IScriptingDefinition,
   ): IUserScript {
+    if (!selectedScripts) { throw new Error('missing scripts'); }
+    if (!scriptingDefinition) { throw new Error('missing definition'); }
     if (!selectedScripts.length) {
       return { code: '', scriptPositions: new Map<SelectedScript, ICodePosition>() };
     }
@@ -66,19 +68,8 @@ function appendSelection(
 function appendCode(selection: SelectedScript, builder: ICodeBuilder): ICodeBuilder {
   const { script } = selection;
   const name = selection.revert ? `${script.name} (revert)` : script.name;
-  const scriptCode = getSelectedCode(selection);
+  const scriptCode = selection.revert ? script.code.revert : script.code.execute;
   return builder
     .appendLine()
     .appendFunction(name, scriptCode);
 }
-
-function getSelectedCode(selection: SelectedScript): string {
-  const { code } = selection.script;
-  if (!selection.revert) {
-    return code.execute;
-  }
-  if (!code.revert) {
-    throw new Error('Reverted script lacks revert code.');
-  }
-  return code.revert;
-}

src/application/Context/State/Filter/Event/FilterActionType.ts

@@ -1,4 +0,0 @@
-export enum FilterActionType {
-  Apply,
-  Clear,
-}

src/application/Context/State/Filter/Event/FilterChange.ts

@@ -1,37 +0,0 @@
-import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
-import { FilterActionType } from './FilterActionType';
-import {
-  IFilterChangeDetails, IFilterChangeDetailsVisitor,
-  ApplyFilterAction, ClearFilterAction,
-} from './IFilterChangeDetails';
-
-export class FilterChange implements IFilterChangeDetails {
-  public static forApply(
-    filter: IFilterResult,
-  ): IFilterChangeDetails {
-    return new FilterChange({ type: FilterActionType.Apply, filter });
-  }
-
-  public static forClear(): IFilterChangeDetails {
-    return new FilterChange({ type: FilterActionType.Clear });
-  }
-
-  private constructor(public readonly action: ApplyFilterAction | ClearFilterAction) { }
-
-  public visit(visitor: IFilterChangeDetailsVisitor): void {
-    switch (this.action.type) {
-      case FilterActionType.Apply:
-        if (visitor.onApply) {
-          visitor.onApply(this.action.filter);
-        }
-        break;
-      case FilterActionType.Clear:
-        if (visitor.onClear) {
-          visitor.onClear();
-        }
-        break;
-      default:
-        throw new Error(`Unknown action: ${this.action}`);
-    }
-  }
-}

src/application/Context/State/Filter/Event/IFilterChangeDetails.ts

@@ -1,23 +0,0 @@
-import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
-import { FilterActionType } from './FilterActionType';
-
-export interface IFilterChangeDetails {
-  readonly action: FilterAction;
-  visit(visitor: IFilterChangeDetailsVisitor): void;
-}
-
-export interface IFilterChangeDetailsVisitor {
-  readonly onClear?: () => void;
-  readonly onApply?: (filter: IFilterResult) => void;
-}
-
-export type ApplyFilterAction = {
-  readonly type: FilterActionType.Apply,
-  readonly filter: IFilterResult;
-};
-
-export type ClearFilterAction = {
-  readonly type: FilterActionType.Clear,
-};
-
-export type FilterAction = ApplyFilterAction | ClearFilterAction;

src/application/Context/State/Filter/FilterResult.ts

@@ -9,6 +9,8 @@ export class FilterResult implements IFilterResult {
     public readonly query: string,
   ) {
     if (!query) { throw new Error('Query is empty or undefined'); }
+    if (!scriptMatches) { throw new Error('Script matches is undefined'); }
+    if (!categoryMatches) { throw new Error('Category matches is undefined'); }
   }
 
   public hasAnyMatches(): boolean {

src/application/Context/State/Filter/IUserFilter.ts

@@ -1,13 +1,13 @@
 import { IEventSource } from '@/infrastructure/Events/IEventSource';
 import { IFilterResult } from './IFilterResult';
-import { IFilterChangeDetails } from './Event/IFilterChangeDetails';
 
 export interface IReadOnlyUserFilter {
   readonly currentFilter: IFilterResult | undefined;
-  readonly filterChanged: IEventSource<IFilterChangeDetails>;
+  readonly filtered: IEventSource<IFilterResult>;
+  readonly filterRemoved: IEventSource<void>;
 }
 
 export interface IUserFilter extends IReadOnlyUserFilter {
-  applyFilter(filter: string): void;
+  setFilter(filter: string): void;
-  clearFilter(): void;
+  removeFilter(): void;
 }

src/application/Context/State/Filter/UserFilter.ts

@@ -4,11 +4,11 @@ import { ICategoryCollection } from '@/domain/ICategoryCollection';
 import { FilterResult } from './FilterResult';
 import { IFilterResult } from './IFilterResult';
 import { IUserFilter } from './IUserFilter';
-import { IFilterChangeDetails } from './Event/IFilterChangeDetails';
-import { FilterChange } from './Event/FilterChange';
 
 export class UserFilter implements IUserFilter {
-  public readonly filterChanged = new EventSource<IFilterChangeDetails>();
+  public readonly filtered = new EventSource<IFilterResult>();
+
+  public readonly filterRemoved = new EventSource<void>();
 
   public currentFilter: IFilterResult | undefined;
 
@@ -16,9 +16,9 @@ export class UserFilter implements IUserFilter {
 
   }
 
-  public applyFilter(filter: string): void {
+  public setFilter(filter: string): void {
     if (!filter) {
-      throw new Error('Filter must be defined and not empty. Use clearFilter() to remove the filter');
+      throw new Error('Filter must be defined and not empty. Use removeFilter() to remove the filter');
     }
     const filterLowercase = filter.toLocaleLowerCase();
     const filteredScripts = this.collection.getAllScripts().filter(
@@ -33,12 +33,12 @@ export class UserFilter implements IUserFilter {
       filter,
     );
     this.currentFilter = matches;
-    this.filterChanged.notify(FilterChange.forApply(this.currentFilter));
+    this.filtered.notify(matches);
   }
 
-  public clearFilter(): void {
+  public removeFilter(): void {
     this.currentFilter = undefined;
-    this.filterChanged.notify(FilterChange.forClear());
+    this.filterRemoved.notify();
   }
 }
 

src/application/Context/State/ICategoryCollectionState.ts

@@ -1,18 +1,18 @@
 import { ICategoryCollection } from '@/domain/ICategoryCollection';
 import { OperatingSystem } from '@/domain/OperatingSystem';
 import { IReadOnlyUserFilter, IUserFilter } from './Filter/IUserFilter';
-import { ReadonlyUserSelection, UserSelection } from './Selection/UserSelection';
+import { IReadOnlyUserSelection, IUserSelection } from './Selection/IUserSelection';
 import { IApplicationCode } from './Code/IApplicationCode';
 
 export interface IReadOnlyCategoryCollectionState {
   readonly code: IApplicationCode;
   readonly os: OperatingSystem;
   readonly filter: IReadOnlyUserFilter;
-  readonly selection: ReadonlyUserSelection;
+  readonly selection: IReadOnlyUserSelection;
   readonly collection: ICategoryCollection;
 }
 
 export interface ICategoryCollectionState extends IReadOnlyCategoryCollectionState {
   readonly filter: IUserFilter;
-  readonly selection: UserSelection;
+  readonly selection: IUserSelection;
 }

src/application/Context/State/Selection/Category/CategorySelection.ts

@@ -1,11 +0,0 @@
-import { ICategory } from '@/domain/ICategory';
-import { CategorySelectionChangeCommand } from './CategorySelectionChange';
-
-export interface ReadonlyCategorySelection {
-  areAllScriptsSelected(category: ICategory): boolean;
-  isAnyScriptSelected(category: ICategory): boolean;
-}
-
-export interface CategorySelection extends ReadonlyCategorySelection {
-  processChanges(action: CategorySelectionChangeCommand): void;
-}

src/application/Context/State/Selection/Category/CategorySelectionChange.ts

@@ -1,15 +0,0 @@
-type CategorySelectionStatus = {
-  readonly isSelected: true;
-  readonly isReverted: boolean;
-} | {
-  readonly isSelected: false;
-};
-
-export interface CategorySelectionChange {
-  readonly categoryId: number;
-  readonly newStatus: CategorySelectionStatus;
-}
-
-export interface CategorySelectionChangeCommand {
-  readonly changes: readonly CategorySelectionChange[];
-}

src/application/Context/State/Selection/Category/ScriptToCategorySelectionMapper.ts

@@ -1,60 +0,0 @@
-import { ICategory } from '@/domain/ICategory';
-import { ICategoryCollection } from '@/domain/ICategoryCollection';
-import { ScriptSelection } from '../Script/ScriptSelection';
-import { ScriptSelectionChange } from '../Script/ScriptSelectionChange';
-import { CategorySelection } from './CategorySelection';
-import { CategorySelectionChange, CategorySelectionChangeCommand } from './CategorySelectionChange';
-
-export class ScriptToCategorySelectionMapper implements CategorySelection {
-  constructor(
-    private readonly scriptSelection: ScriptSelection,
-    private readonly collection: ICategoryCollection,
-  ) {
-
-  }
-
-  public areAllScriptsSelected(category: ICategory): boolean {
-    const { selectedScripts } = this.scriptSelection;
-    if (selectedScripts.length === 0) {
-      return false;
-    }
-    const scripts = category.getAllScriptsRecursively();
-    if (selectedScripts.length < scripts.length) {
-      return false;
-    }
-    return scripts.every(
-      (script) => selectedScripts.some((selected) => selected.id === script.id),
-    );
-  }
-
-  public isAnyScriptSelected(category: ICategory): boolean {
-    const { selectedScripts } = this.scriptSelection;
-    if (selectedScripts.length === 0) {
-      return false;
-    }
-    return selectedScripts.some((s) => category.includes(s.script));
-  }
-
-  public processChanges(action: CategorySelectionChangeCommand): void {
-    const scriptChanges = action.changes.reduce((changes, change) => {
-      changes.push(...this.collectScriptChanges(change));
-      return changes;
-    }, new Array<ScriptSelectionChange>());
-    this.scriptSelection.processChanges({
-      changes: scriptChanges,
-    });
-  }
-
-  private collectScriptChanges(change: CategorySelectionChange): ScriptSelectionChange[] {
-    const category = this.collection.getCategory(change.categoryId);
-    const scripts = category.getAllScriptsRecursively();
-    const scriptsChangesInCategory = scripts
-      .map((script): ScriptSelectionChange => ({
-        scriptId: script.id,
-        newStatus: {
-          ...change.newStatus,
-        },
-      }));
-    return scriptsChangesInCategory;
-  }
-}

src/application/Context/State/Selection/IUserSelection.ts

@@ -0,0 +1,23 @@
+import { IScript } from '@/domain/IScript';
+import { ICategory } from '@/domain/ICategory';
+import { IEventSource } from '@/infrastructure/Events/IEventSource';
+import { SelectedScript } from './SelectedScript';
+
+export interface IReadOnlyUserSelection {
+  readonly changed: IEventSource<ReadonlyArray<SelectedScript>>;
+  readonly selectedScripts: ReadonlyArray<SelectedScript>;
+  isSelected(scriptId: string): boolean;
+  areAllSelected(category: ICategory): boolean;
+  isAnySelected(category: ICategory): boolean;
+}
+
+export interface IUserSelection extends IReadOnlyUserSelection {
+  removeAllInCategory(categoryId: number): void;
+  addOrUpdateAllInCategory(categoryId: number, revert: boolean): void;
+  addSelectedScript(scriptId: string, revert: boolean): void;
+  addOrUpdateSelectedScript(scriptId: string, revert: boolean): void;
+  removeSelectedScript(scriptId: string): void;
+  selectOnly(scripts: ReadonlyArray<IScript>): void;
+  selectAll(): void;
+  deselectAll(): void;
+}

src/application/Context/State/Selection/Script/DebouncedScriptSelection.ts

@@ -1,171 +0,0 @@
-import { InMemoryRepository } from '@/infrastructure/Repository/InMemoryRepository';
-import { IScript } from '@/domain/IScript';
-import { EventSource } from '@/infrastructure/Events/EventSource';
-import { ReadonlyRepository, Repository } from '@/application/Repository/Repository';
-import { ICategoryCollection } from '@/domain/ICategoryCollection';
-import { batchedDebounce } from '@/application/Common/Timing/BatchedDebounce';
-import { ScriptSelection } from './ScriptSelection';
-import { ScriptSelectionChange, ScriptSelectionChangeCommand } from './ScriptSelectionChange';
-import { SelectedScript } from './SelectedScript';
-import { UserSelectedScript } from './UserSelectedScript';
-
-const DEBOUNCE_DELAY_IN_MS = 100;
-
-export type DebounceFunction = typeof batchedDebounce<ScriptSelectionChangeCommand>;
-
-export class DebouncedScriptSelection implements ScriptSelection {
-  public readonly changed = new EventSource<ReadonlyArray<SelectedScript>>();
-
-  private readonly scripts: Repository<string, SelectedScript>;
-
-  public readonly processChanges: ScriptSelection['processChanges'];
-
-  constructor(
-    private readonly collection: ICategoryCollection,
-    selectedScripts: ReadonlyArray<SelectedScript>,
-    debounce: DebounceFunction = batchedDebounce,
-  ) {
-    this.scripts = new InMemoryRepository<string, SelectedScript>();
-    for (const script of selectedScripts) {
-      this.scripts.addItem(script);
-    }
-    this.processChanges = debounce(
-      (batchedRequests: readonly ScriptSelectionChangeCommand[]) => {
-        const consolidatedChanges = batchedRequests.flatMap((request) => request.changes);
-        this.processScriptChanges(consolidatedChanges);
-      },
-      DEBOUNCE_DELAY_IN_MS,
-    );
-  }
-
-  public isSelected(scriptId: string): boolean {
-    return this.scripts.exists(scriptId);
-  }
-
-  public get selectedScripts(): readonly SelectedScript[] {
-    return this.scripts.getItems();
-  }
-
-  public selectAll(): void {
-    const scriptsToSelect = this.collection
-      .getAllScripts()
-      .filter((script) => !this.scripts.exists(script.id))
-      .map((script) => new UserSelectedScript(script, false));
-    if (scriptsToSelect.length === 0) {
-      return;
-    }
-    this.processChanges({
-      changes: scriptsToSelect.map((script): ScriptSelectionChange => ({
-        scriptId: script.id,
-        newStatus: {
-          isSelected: true,
-          isReverted: false,
-        },
-      })),
-    });
-  }
-
-  public deselectAll(): void {
-    if (this.scripts.length === 0) {
-      return;
-    }
-    const selectedScriptIds = this.scripts.getItems().map((script) => script.id);
-    this.processChanges({
-      changes: selectedScriptIds.map((scriptId): ScriptSelectionChange => ({
-        scriptId,
-        newStatus: {
-          isSelected: false,
-        },
-      })),
-    });
-  }
-
-  public selectOnly(scripts: readonly IScript[]): void {
-    if (scripts.length === 0) {
-      throw new Error('Provided script array is empty. To deselect all scripts, please use the deselectAll() method instead.');
-    }
-    this.processChanges({
-      changes: [
-        ...getScriptIdsToBeDeselected(this.scripts, scripts)
-          .map((scriptId): ScriptSelectionChange => ({
-            scriptId,
-            newStatus: {
-              isSelected: false,
-            },
-          })),
-        ...getScriptIdsToBeSelected(this.scripts, scripts)
-          .map((scriptId): ScriptSelectionChange => ({
-            scriptId,
-            newStatus: {
-              isSelected: true,
-              isReverted: false,
-            },
-          })),
-      ],
-    });
-  }
-
-  private processScriptChanges(changes: readonly ScriptSelectionChange[]): void {
-    let totalChanged = 0;
-    for (const change of changes) {
-      totalChanged += this.applyChange(change);
-    }
-    if (totalChanged > 0) {
-      this.changed.notify(this.scripts.getItems());
-    }
-  }
-
-  private applyChange(change: ScriptSelectionChange): number {
-    const script = this.collection.getScript(change.scriptId);
-    if (change.newStatus.isSelected) {
-      return this.addOrUpdateScript(script.id, change.newStatus.isReverted);
-    }
-    return this.removeScript(script.id);
-  }
-
-  private addOrUpdateScript(scriptId: string, revert: boolean): number {
-    const script = this.collection.getScript(scriptId);
-    const selectedScript = new UserSelectedScript(script, revert);
-    if (!this.scripts.exists(selectedScript.id)) {
-      this.scripts.addItem(selectedScript);
-      return 1;
-    }
-    const existingSelectedScript = this.scripts.getById(selectedScript.id);
-    if (equals(selectedScript, existingSelectedScript)) {
-      return 0;
-    }
-    this.scripts.addOrUpdateItem(selectedScript);
-    return 1;
-  }
-
-  private removeScript(scriptId: string): number {
-    if (!this.scripts.exists(scriptId)) {
-      return 0;
-    }
-    this.scripts.removeItem(scriptId);
-    return 1;
-  }
-}
-
-function getScriptIdsToBeSelected(
-  existingItems: ReadonlyRepository<string, SelectedScript>,
-  desiredScripts: readonly IScript[],
-): string[] {
-  return desiredScripts
-    .filter((script) => !existingItems.exists(script.id))
-    .map((script) => script.id);
-}
-
-function getScriptIdsToBeDeselected(
-  existingItems: ReadonlyRepository<string, SelectedScript>,
-  desiredScripts: readonly IScript[],
-): string[] {
-  return existingItems
-    .getItems()
-    .filter((existing) => !desiredScripts.some((script) => existing.id === script.id))
-    .map((script) => script.id);
-}
-
-function equals(a: SelectedScript, b: SelectedScript): boolean {
-  return a.script.equals(b.script.id) && a.revert === b.revert;
-}

src/application/Context/State/Selection/Script/ScriptSelection.ts

@@ -1,17 +0,0 @@
-import { IEventSource } from '@/infrastructure/Events/IEventSource';
-import { IScript } from '@/domain/IScript';
-import { SelectedScript } from './SelectedScript';
-import { ScriptSelectionChangeCommand } from './ScriptSelectionChange';
-
-export interface ReadonlyScriptSelection {
-  readonly changed: IEventSource<readonly SelectedScript[]>;
-  readonly selectedScripts: readonly SelectedScript[];
-  isSelected(scriptId: string): boolean;
-}
-
-export interface ScriptSelection extends ReadonlyScriptSelection {
-  selectOnly(scripts: readonly IScript[]): void;
-  selectAll(): void;
-  deselectAll(): void;
-  processChanges(action: ScriptSelectionChangeCommand): void;
-}

src/application/Context/State/Selection/Script/ScriptSelectionChange.ts

@@ -1,15 +0,0 @@
-export type ScriptSelectionStatus = {
-  readonly isSelected: true;
-  readonly isReverted: boolean;
-} | {
-  readonly isSelected: false;
-};
-
-export interface ScriptSelectionChange {
-  readonly scriptId: string;
-  readonly newStatus: ScriptSelectionStatus;
-}
-
-export interface ScriptSelectionChangeCommand {
-  readonly changes: ReadonlyArray<ScriptSelectionChange>;
-}

src/application/Context/State/Selection/Script/SelectedScript.ts

@@ -1,9 +0,0 @@
-import { IEntity } from '@/infrastructure/Entity/IEntity';
-import { IScript } from '@/domain/IScript';
-
-type ScriptId = IScript['id'];
-
-export interface SelectedScript extends IEntity<ScriptId> {
-  readonly script: IScript;
-  readonly revert: boolean;
-}

src/application/Context/State/Selection/SelectedScript.ts

@@ -1,17 +1,14 @@
 import { BaseEntity } from '@/infrastructure/Entity/BaseEntity';
 import { IScript } from '@/domain/IScript';
-import { SelectedScript } from './SelectedScript';
 
-type SelectedScriptId = SelectedScript['id'];
+export class SelectedScript extends BaseEntity<string> {
-
-export class UserSelectedScript extends BaseEntity<SelectedScriptId> {
   constructor(
     public readonly script: IScript,
     public readonly revert: boolean,
   ) {
     super(script.id);
     if (revert && !script.canRevert()) {
-      throw new Error(`The script with ID '${script.id}' is not reversible and cannot be reverted.`);
+      throw new Error('cannot revert an irreversible script');
     }
   }
 }

src/application/Context/State/Selection/UserSelection.ts

@@ -1,12 +1,167 @@
-import { CategorySelection, ReadonlyCategorySelection } from './Category/CategorySelection';
+import { InMemoryRepository } from '@/infrastructure/Repository/InMemoryRepository';
-import { ReadonlyScriptSelection, ScriptSelection } from './Script/ScriptSelection';
+import { IScript } from '@/domain/IScript';
+import { EventSource } from '@/infrastructure/Events/EventSource';
+import { IRepository } from '@/infrastructure/Repository/IRepository';
+import { ICategory } from '@/domain/ICategory';
+import { ICategoryCollection } from '@/domain/ICategoryCollection';
+import { IUserSelection } from './IUserSelection';
+import { SelectedScript } from './SelectedScript';
 
-export interface ReadonlyUserSelection {
+export class UserSelection implements IUserSelection {
-  readonly categories: ReadonlyCategorySelection;
+  public readonly changed = new EventSource<ReadonlyArray<SelectedScript>>();
-  readonly scripts: ReadonlyScriptSelection;
+
+  private readonly scripts: IRepository<string, SelectedScript>;
+
+  constructor(
+    private readonly collection: ICategoryCollection,
+    selectedScripts: ReadonlyArray<SelectedScript>,
+  ) {
+    this.scripts = new InMemoryRepository<string, SelectedScript>();
+    for (const script of selectedScripts) {
+      this.scripts.addItem(script);
+    }
   }
 
-export interface UserSelection extends ReadonlyUserSelection {
+  public areAllSelected(category: ICategory): boolean {
-  readonly categories: CategorySelection;
+    if (this.selectedScripts.length === 0) {
-  readonly scripts: ScriptSelection;
+      return false;
+    }
+    const scripts = category.getAllScriptsRecursively();
+    if (this.selectedScripts.length < scripts.length) {
+      return false;
+    }
+    return scripts.every(
+      (script) => this.selectedScripts.some((selected) => selected.id === script.id),
+    );
+  }
+
+  public isAnySelected(category: ICategory): boolean {
+    if (this.selectedScripts.length === 0) {
+      return false;
+    }
+    return this.selectedScripts.some((s) => category.includes(s.script));
+  }
+
+  public removeAllInCategory(categoryId: number): void {
+    const category = this.collection.findCategory(categoryId);
+    const scriptsToRemove = category.getAllScriptsRecursively()
+      .filter((script) => this.scripts.exists(script.id));
+    if (!scriptsToRemove.length) {
+      return;
+    }
+    for (const script of scriptsToRemove) {
+      this.scripts.removeItem(script.id);
+    }
+    this.changed.notify(this.scripts.getItems());
+  }
+
+  public addOrUpdateAllInCategory(categoryId: number, revert = false): void {
+    const scriptsToAddOrUpdate = this.collection
+      .findCategory(categoryId)
+      .getAllScriptsRecursively()
+      .filter(
+        (script) => !this.scripts.exists(script.id)
+          || this.scripts.getById(script.id).revert !== revert,
+      )
+      .map((script) => new SelectedScript(script, revert));
+    if (!scriptsToAddOrUpdate.length) {
+      return;
+    }
+    for (const script of scriptsToAddOrUpdate) {
+      this.scripts.addOrUpdateItem(script);
+    }
+    this.changed.notify(this.scripts.getItems());
+  }
+
+  public addSelectedScript(scriptId: string, revert: boolean): void {
+    const script = this.collection.findScript(scriptId);
+    if (!script) {
+      throw new Error(`Cannot add (id: ${scriptId}) as it is unknown`);
+    }
+    const selectedScript = new SelectedScript(script, revert);
+    this.scripts.addItem(selectedScript);
+    this.changed.notify(this.scripts.getItems());
+  }
+
+  public addOrUpdateSelectedScript(scriptId: string, revert: boolean): void {
+    const script = this.collection.findScript(scriptId);
+    const selectedScript = new SelectedScript(script, revert);
+    this.scripts.addOrUpdateItem(selectedScript);
+    this.changed.notify(this.scripts.getItems());
+  }
+
+  public removeSelectedScript(scriptId: string): void {
+    this.scripts.removeItem(scriptId);
+    this.changed.notify(this.scripts.getItems());
+  }
+
+  public isSelected(scriptId: string): boolean {
+    return this.scripts.exists(scriptId);
+  }
+
+  /** Get users scripts based on his/her selections */
+  public get selectedScripts(): ReadonlyArray<SelectedScript> {
+    return this.scripts.getItems();
+  }
+
+  public selectAll(): void {
+    const scriptsToSelect = this.collection
+      .getAllScripts()
+      .filter((script) => !this.scripts.exists(script.id))
+      .map((script) => new SelectedScript(script, false));
+    if (scriptsToSelect.length === 0) {
+      return;
+    }
+    for (const script of scriptsToSelect) {
+      this.scripts.addItem(script);
+    }
+    this.changed.notify(this.scripts.getItems());
+  }
+
+  public deselectAll(): void {
+    if (this.scripts.length === 0) {
+      return;
+    }
+    const selectedScriptIds = this.scripts.getItems().map((script) => script.id);
+    for (const scriptId of selectedScriptIds) {
+      this.scripts.removeItem(scriptId);
+    }
+    this.changed.notify([]);
+  }
+
+  public selectOnly(scripts: readonly IScript[]): void {
+    if (!scripts || scripts.length === 0) {
+      throw new Error('Scripts are empty. Use deselectAll() if you want to deselect everything');
+    }
+    let totalChanged = 0;
+    totalChanged += this.unselectMissingWithoutNotifying(scripts);
+    totalChanged += this.selectNewWithoutNotifying(scripts);
+    if (totalChanged > 0) {
+      this.changed.notify(this.scripts.getItems());
+    }
+  }
+
+  private unselectMissingWithoutNotifying(scripts: readonly IScript[]): number {
+    if (this.scripts.length === 0 || scripts.length === 0) {
+      return 0;
+    }
+    const existingItems = this.scripts.getItems();
+    const missingIds = existingItems
+      .filter((existing) => !scripts.some((script) => existing.id === script.id))
+      .map((script) => script.id);
+    for (const id of missingIds) {
+      this.scripts.removeItem(id);
+    }
+    return missingIds.length;
+  }
+
+  private selectNewWithoutNotifying(scripts: readonly IScript[]): number {
+    const unselectedScripts = scripts
+      .filter((script) => !this.scripts.exists(script.id))
+      .map((script) => new SelectedScript(script, false));
+    for (const newScript of unselectedScripts) {
+      this.scripts.addItem(newScript);
+    }
+    return unselectedScripts.length;
+  }
 }

src/application/Context/State/Selection/UserSelectionFacade.ts

@@ -1,39 +0,0 @@
-import { ICategoryCollection } from '@/domain/ICategoryCollection';
-import { CategorySelection } from './Category/CategorySelection';
-import { ScriptToCategorySelectionMapper } from './Category/ScriptToCategorySelectionMapper';
-import { DebouncedScriptSelection } from './Script/DebouncedScriptSelection';
-import { ScriptSelection } from './Script/ScriptSelection';
-import { UserSelection } from './UserSelection';
-import { SelectedScript } from './Script/SelectedScript';
-
-export class UserSelectionFacade implements UserSelection {
-  public readonly categories: CategorySelection;
-
-  public readonly scripts: ScriptSelection;
-
-  constructor(
-    collection: ICategoryCollection,
-    selectedScripts: readonly SelectedScript[],
-    scriptsFactory = DefaultScriptsFactory,
-    categoriesFactory = DefaultCategoriesFactory,
-  ) {
-    this.scripts = scriptsFactory(collection, selectedScripts);
-    this.categories = categoriesFactory(this.scripts, collection);
-  }
-}
-
-export type ScriptsFactory = (
-  ...params: ConstructorParameters<typeof DebouncedScriptSelection>
-) => ScriptSelection;
-
-const DefaultScriptsFactory: ScriptsFactory = (
-  ...params
-) => new DebouncedScriptSelection(...params);
-
-export type CategoriesFactory = (
-  ...params: ConstructorParameters<typeof ScriptToCategorySelectionMapper>
-) => CategorySelection;
-
-const DefaultCategoriesFactory: CategoriesFactory = (
-  ...params
-) => new ScriptToCategorySelectionMapper(...params);

src/application/Environment/BrowserOs/DetectorBuilder.ts

@@ -25,9 +25,9 @@ export class DetectorBuilder {
     };
   }
 
-  private detect(userAgent: string): OperatingSystem | undefined {
+  private detect(userAgent: string): OperatingSystem {
     if (!userAgent) {
-      return undefined;
+      throw new Error('missing userAgent');
     }
     if (this.existingPartsInUserAgent.some((part) => !userAgent.includes(part))) {
       return undefined;

src/application/Environment/Environment.ts

@@ -0,0 +1,89 @@
+import { OperatingSystem } from '@/domain/OperatingSystem';
+import { BrowserOsDetector } from './BrowserOs/BrowserOsDetector';
+import { IBrowserOsDetector } from './BrowserOs/IBrowserOsDetector';
+import { IEnvironment } from './IEnvironment';
+
+export interface IEnvironmentVariables {
+  readonly window: Window & typeof globalThis;
+  readonly process: NodeJS.Process;
+  readonly navigator: Navigator;
+}
+
+export class Environment implements IEnvironment {
+  public static readonly CurrentEnvironment: IEnvironment = new Environment({
+    window,
+    process: typeof process !== 'undefined' ? process /* electron only */ : undefined,
+    navigator,
+  });
+
+  public readonly isDesktop: boolean;
+
+  public readonly os: OperatingSystem;
+
+  protected constructor(
+    variables: IEnvironmentVariables,
+    browserOsDetector: IBrowserOsDetector = new BrowserOsDetector(),
+  ) {
+    if (!variables) {
+      throw new Error('variables is null or empty');
+    }
+    this.isDesktop = isDesktop(variables);
+    if (this.isDesktop) {
+      this.os = getDesktopOsType(getProcessPlatform(variables));
+    } else {
+      const userAgent = getUserAgent(variables);
+      this.os = !userAgent ? undefined : browserOsDetector.detect(userAgent);
+    }
+  }
+}
+
+function getUserAgent(variables: IEnvironmentVariables): string {
+  if (!variables.window || !variables.window.navigator) {
+    return undefined;
+  }
+  return variables.window.navigator.userAgent;
+}
+
+function getProcessPlatform(variables: IEnvironmentVariables): string {
+  if (!variables.process || !variables.process.platform) {
+    return undefined;
+  }
+  return variables.process.platform;
+}
+
+function getDesktopOsType(processPlatform: string): OperatingSystem | undefined {
+  // https://nodejs.org/api/process.html#process_process_platform
+  switch (processPlatform) {
+    case 'darwin':
+      return OperatingSystem.macOS;
+    case 'win32':
+      return OperatingSystem.Windows;
+    case 'linux':
+      return OperatingSystem.Linux;
+    default:
+      return undefined;
+  }
+}
+
+function isDesktop(variables: IEnvironmentVariables): boolean {
+  // More: https://github.com/electron/electron/issues/2288
+  // Renderer process
+  if (variables.window
+    && variables.window.process
+    && variables.window.process.type === 'renderer') {
+    return true;
+  }
+  // Main process
+  if (variables.process
+    && variables.process.versions
+    && Boolean(variables.process.versions.electron)) {
+    return true;
+  }
+  // Detect the user agent when the `nodeIntegration` option is set to true
+  if (variables.navigator
+    && variables.navigator.userAgent
+    && variables.navigator.userAgent.includes('Electron')) {
+    return true;
+  }
+  return false;
+}

src/application/Environment/IEnvironment.ts

@@ -0,0 +1,6 @@
+import { OperatingSystem } from '@/domain/OperatingSystem';
+
+export interface IEnvironment {
+  readonly isDesktop: boolean;
+  readonly os: OperatingSystem;
+}

src/application/Parser/ApplicationParser.ts

@@ -7,19 +7,16 @@ import MacOsData from '@/application/collections/macos.yaml';
 import LinuxData from '@/application/collections/linux.yaml';
 import { parseProjectInformation } from '@/application/Parser/ProjectInformationParser';
 import { Application } from '@/domain/Application';
-import { IAppMetadata } from '@/infrastructure/EnvironmentVariables/IAppMetadata';
-import { EnvironmentVariablesFactory } from '@/infrastructure/EnvironmentVariables/EnvironmentVariablesFactory';
 import { parseCategoryCollection } from './CategoryCollectionParser';
 
 export function parseApplication(
-  categoryParser = parseCategoryCollection,
+  parser = CategoryCollectionParser,
-  informationParser = parseProjectInformation,
+  processEnv: NodeJS.ProcessEnv = process.env,
-  metadata: IAppMetadata = EnvironmentVariablesFactory.Current.instance,
   collectionsData = PreParsedCollections,
 ): IApplication {
   validateCollectionsData(collectionsData);
-  const information = informationParser(metadata);
+  const information = parseProjectInformation(processEnv);
-  const collections = collectionsData.map((collection) => categoryParser(collection, information));
+  const collections = collectionsData.map((collection) => parser(collection, information));
   const app = new Application(information, collections);
   return app;
 }
@@ -27,12 +24,19 @@ export function parseApplication(
 export type CategoryCollectionParserType
     = (file: CollectionData, info: IProjectInformation) => ICategoryCollection;
 
+const CategoryCollectionParser: CategoryCollectionParserType = (file, info) => {
+  return parseCategoryCollection(file, info);
+};
+
 const PreParsedCollections: readonly CollectionData [] = [
   WindowsData, MacOsData, LinuxData,
 ];
 
 function validateCollectionsData(collections: readonly CollectionData[]) {
-  if (!collections.length) {
+  if (!collections || !collections.length) {
     throw new Error('missing collections');
   }
+  if (collections.some((collection) => !collection)) {
+    throw new Error('missing collection provided');
+  }
 }

src/application/Parser/CategoryCollectionParser.ts

@@ -28,7 +28,10 @@ export function parseCategoryCollection(
 }
 
 function validate(content: CollectionData): void {
-  if (!content.actions.length) {
+  if (!content) {
+    throw new Error('missing content');
+  }
+  if (!content.actions || content.actions.length <= 0) {
     throw new Error('content does not define any action');
   }
 }

src/application/Parser/CategoryParser.ts

@@ -1,5 +1,5 @@
 import type {
-  CategoryData, ScriptData, CategoryOrScriptData,
+  CategoryData, ScriptData, CategoryOrScriptData, InstructionHolder,
 } from '@/application/collections/';
 import { Script } from '@/domain/Script';
 import { Category } from '@/domain/Category';
@@ -16,6 +16,7 @@ export function parseCategory(
   context: ICategoryCollectionParseContext,
   factory: CategoryFactoryType = CategoryFactory,
 ): Category {
+  if (!context) { throw new Error('missing context'); }
   return parseCategoryRecursively({
     categoryData: category,
     context,
@@ -29,8 +30,8 @@ interface ICategoryParseContext {
   readonly factory: CategoryFactoryType,
   readonly parentCategory?: CategoryData,
 }
-
+// eslint-disable-next-line consistent-return
-function parseCategoryRecursively(context: ICategoryParseContext): Category | never {
+function parseCategoryRecursively(context: ICategoryParseContext): Category {
   ensureValidCategory(context.categoryData, context.parentCategory);
   const children: ICategoryChildren = {
     subCategories: new Array<Category>(),
@@ -54,7 +55,7 @@ function parseCategoryRecursively(context: ICategoryParseContext): Category | ne
       /* scripts: */ children.subScripts,
     );
   } catch (err) {
-    return new NodeValidator({
+    new NodeValidator({
       type: NodeType.Category,
       selfNode: context.categoryData,
       parentNode: context.parentCategory,
@@ -71,7 +72,7 @@ function ensureValidCategory(category: CategoryData, parentCategory?: CategoryDa
     .assertDefined(category)
     .assertValidName(category.category)
     .assert(
-      () => category.children.length > 0,
+      () => category.children && category.children.length > 0,
       `"${category.category}" has no children.`,
     );
 }
@@ -93,14 +94,14 @@ function parseNode(context: INodeParseContext) {
   validator.assertDefined(context.nodeData);
   if (isCategory(context.nodeData)) {
     const subCategory = parseCategoryRecursively({
-      categoryData: context.nodeData,
+      categoryData: context.nodeData as CategoryData,
       context: context.context,
       factory: context.factory,
       parentCategory: context.parent,
     });
     context.children.subCategories.push(subCategory);
   } else if (isScript(context.nodeData)) {
-    const script = parseScript(context.nodeData, context.context);
+    const script = parseScript(context.nodeData as ScriptData, context.context);
     context.children.subScripts.push(script);
   } else {
     validator.throw('Node is neither a category or a script.');
@@ -108,18 +109,19 @@ function parseNode(context: INodeParseContext) {
 }
 
 function isScript(data: CategoryOrScriptData): data is ScriptData {
-  return hasCode(data) || hasCall(data);
+  const holder = (data as InstructionHolder);
+  return hasCode(holder) || hasCall(holder);
 }
 
 function isCategory(data: CategoryOrScriptData): data is CategoryData {
   return hasProperty(data, 'category');
 }
 
-function hasCode(data: unknown): boolean {
+function hasCode(data: InstructionHolder): boolean {
   return hasProperty(data, 'code');
 }
 
-function hasCall(data: unknown) {
+function hasCall(data: InstructionHolder) {
   return hasProperty(data, 'call');
 }
 

src/application/Parser/DocumentationParser.ts

@@ -1,6 +1,9 @@
 import type { DocumentableData, DocumentationData } from '@/application/collections/';
 
 export function parseDocs(documentable: DocumentableData): readonly string[] {
+  if (!documentable) {
+    throw new Error('missing documentable');
+  }
   const { docs } = documentable;
   if (!docs) {
     return [];