chore(main): release 4.2.1 (#1235)

🤖 I have created a release *beep* *boop*
---


## [4.2.1](https://github.com/unraid/api/compare/v4.2.0...v4.2.1)
(2025-03-18)


### Bug Fixes

* **deps:** update all non-major dependencies
([#1192](https://github.com/unraid/api/issues/1192))
([b5f3a37](b5f3a37863))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

.github/CODEOWNERS

@@ -0,0 +1,20 @@
+# Default owners for everything in the repo
+* @elibosley @pujitm @mdatelle @zackspear
+
+# API specific files
+/api/ @elibosley @pujitm @mdatelle
+
+# Web frontend files
+/web/ @elibosley @mdatelle @zackspear
+
+# Plugin related files
+/plugin/ @elibosley
+
+# Unraid UI specific files
+/unraid-ui/ @mdatelle @zackspear @pujitm
+
+# GitHub workflows and configuration
+/.github/ @elibosley
+
+# Documentation
+*.md @elibosley @pujitm @mdatelle @zackspear

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,45 @@
+---
+name: Bug Report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+---
+
+<!--
+IMPORTANT: If your issue is related to Unraid Connect features (Flash Backup, connect.myunraid.net, mothership errors with connectivity, etc.) please submit a ticket here: [LINK TO FRESHDESK FORM FOR CONNECT] and choose Unraid Connect in the dropdown.
+-->
+
+## Environment
+
+**Unraid OS Version:**
+<!-- Please specify your Unraid version (e.g. 7.0.0) -->
+
+**Are you using a reverse proxy?**
+<!-- Please answer Yes/No. If yes, have you tested the issue by accessing your server directly? -->
+<!-- Note: Reverse proxies are not officially supported by Unraid and can cause issues with various components of Unraid OS -->
+
+## Pre-submission Checklist
+<!-- Please check all that apply by replacing [ ] with [x] -->
+
+- [ ] I have verified that my Unraid OS is up to date
+- [ ] I have tested this issue by accessing my server directly (not through a reverse proxy)
+- [ ] This is not an Unraid Connect related issue (if it is, please submit via the support form instead)
+
+## Issue Description
+<!-- Please provide a clear and concise description of the issue -->
+
+## Steps to Reproduce
+
+1.
+2.
+3.
+
+## Expected Behavior
+<!-- What did you expect to happen? -->
+
+## Actual Behavior
+<!-- What actually happened? -->
+
+## Additional Context
+<!-- Add any other context, screenshots, or error messages about the problem here -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,34 @@
+---
+name: Feature Request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+---
+
+<!--
+IMPORTANT: If your feature request is related to Unraid Connect features (Flash Backup, connect.myunraid.net, etc.) please submit it here: [LINK TO FRESHDESK FORM FOR CONNECT] and choose Unraid Connect in the dropdown.
+-->
+
+## Is your feature request related to a problem?
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+## Describe the solution you'd like
+<!-- A clear and concise description of what you want to happen -->
+
+## Describe alternatives you've considered
+<!-- A clear and concise description of any alternative solutions or features you've considered -->
+
+## Additional context
+<!-- Add any other context, mockups, or screenshots about the feature request here -->
+
+## Environment (if relevant)
+**Unraid OS Version:** 
+<!-- Please specify your Unraid version (e.g. 7.0.0) if the feature request is version-specific -->
+
+## Pre-submission Checklist
+<!-- Please check all that apply by replacing [ ] with [x] -->
+
+- [ ] I have searched existing issues to ensure this feature hasn't already been requested
+- [ ] This is not an Unraid Connect related feature (if it is, please submit via the support form instead)
+- [ ] I have provided clear examples or use cases for the feature 

.github/ISSUE_TEMPLATE/work_intent.md

@@ -0,0 +1,41 @@
+---
+name: Work Intent
+about: Request approval for planned development work (must be approved before starting)
+title: 'Work Intent: '
+labels: work-intent, unapproved
+assignees: ''
+---
+
+<!--
+IMPORTANT: This work intent must be approved by a core developer before beginning any development work.
+The 'unapproved' label will be removed once approved.
+-->
+
+## Overview
+<!-- Provide a high-level description of what you want to work on and why -->
+
+## Technical Approach
+<!-- Brief description of how you plan to implement this -->
+
+## Scope
+<!-- Check components that will be modified -->
+- [ ] API
+- [ ] Plugin
+- [ ] Web UI
+- [ ] Build/Deploy Process
+- [ ] Documentation
+
+## Timeline & Impact
+<!-- Quick details about timing and effects -->
+- Estimated time needed: 
+- Potential impacts: 
+
+## Pre-submission Checklist
+<!-- Please check all that apply -->
+- [ ] I have searched for similar work/issues
+- [ ] I understand this needs approval before starting
+- [ ] I am willing to make adjustments based on feedback
+
+<!--
+For Reviewers: Remove 'unapproved' label and add 'approved' label if accepted
+--> 

.github/unraid.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" version="1.2" viewBox="0 0 1000 1000"><defs><linearGradient id="a" x1="-900" x2="-100" y1="-100" y2="-900" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#e32929"/><stop offset="1" stop-color="#ff8d30"/></linearGradient></defs><path fill="url(#a)" d="M1000 500.1v376.4c0 57.5-43.4 110.1-100 120.9-8.4 1.6-17.1 2.5-25.6 2.5-250.1.1-500.2.1-750.3.1-61.3 0-114.8-47-122.8-108q-.3-2.1-.6-4.1-.2-2-.3-4.1-.2-2-.3-4v-4.1C0 624.9 0 374.2 0 123.5 0 66 43.4 13.3 100 2.6 108.4 1 117.1.1 125.6.1 375.9 0 626.2 0 876.5 0 934 0 986.7 43.4 997.4 100c1.5 8.4 2.5 17.1 2.5 25.6.1 124.8.1 249.7.1 374.5z"/><path fill="#fff" d="M481.6 392.1h36.5v216.2h-36.5zm-356 0h36.5v216.2h-36.5zm178 242h36.5v82.5h-36.5zm-89.3-92.7h36.5v133.7h-36.5zm178 0h36.5V675h-36.5zm445.8-149.3h36.5v216.1h-36.5zm-178-107.8h36.5v82.6h-36.5zm89.3 41.5h36.5v133.1h-36.5zm-178.6 0h36.5v133h-36.5z"/></svg>

.github/workflows/create-docusaurus-pr.yml

@@ -0,0 +1,59 @@
+name: Update API Documentation
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'api/docs/**'
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+# Add permissions for GITHUB_TOKEN
+permissions:
+  contents: write
+  pull-requests: write
+jobs:
+  create-docs-pr:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source repository
+        uses: actions/checkout@v4
+        with:
+          path: source-repo
+
+      - name: Checkout docs repository
+        uses: actions/checkout@v4
+        with:
+          repository: unraid/docs
+          path: docs-repo
+          token: ${{ secrets.DOCS_PAT_UNRAID_BOT }}
+
+      - name: Copy updated docs
+        run: |
+          if [ ! -d "source-repo/api/docs" ]; then
+            echo "Source directory does not exist!"
+            exit 1
+          fi
+          rm -rf docs-repo/docs/API/
+          mkdir -p docs-repo/docs/API
+          cp -r source-repo/api/docs/public/. docs-repo/docs/API/
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ secrets.DOCS_PAT_UNRAID_BOT }}
+          path: docs-repo
+          commit-message: 'docs: update API documentation'
+          title: 'Update API Documentation'
+          body: |
+            This PR updates the API documentation based on changes from the main repository.
+            
+            Changes were automatically generated from api/docs/* directory.
+
+            @coderabbitai ignore
+          reviewers: ljm42, elibosley, pujitm, mdatelle
+          branch: update-api-docs
+          base: main
+          delete-branch: true

.github/workflows/main.yml

@@ -1,261 +1,428 @@
 name: CI - Main (API)
 
 on:
+  pull_request:
   push:
     branches:
       - main
-    tags:
-      - "v*"
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
   cancel-in-progress: true
 
 jobs:
-  start:
-    # This prevents a tag running twice as it'll have a "tag" and a "commit" event
-    # We only want the tag to run the action as it'll be able to create the release notes
-    if: (startsWith(github.event.ref, 'refs/heads/') && !startsWith(github.event.head_commit.message, 'chore(release)')) || (startsWith(github.event.ref, 'refs/tags/') && startsWith(github.event.head_commit.message, 'chore(release)'))
+  release-please:
+    name: Release Please
+    # Only run release-please on pushes to main
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
     steps:
-      - name: Validate branch and tag
-        run: exit 0
-
-  lint-api:
-    continue-on-error: true
-    defaults:
-      run:
-        working-directory: api
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v3
-        with:
-          persist-credentials: false
-      - name: Reconfigure git to use HTTP authenti:cation
-        run: >
-          git config --global url."https://github.com/".insteadOf
-          ssh://git@github.com/
-
-      - name: Install node
-        uses: actions/setup-node@v3
-        with:
-          node-version-file: "api/.nvmrc"
-
-      # - name: Get npm cache directory
-      #   id: npm-cache
-      #   run: echo "::set-output name=dir::$(npm config get cache)"
-
-      # - name: Load npm cache
-      #   uses: actions/cache@v3
-      #   with:
-      #     path: ${{ steps.npm-cache.outputs.dir }}
-      #     key: ${{ runner.os }}-npm-cache-${{ hashFiles('**/package-lock.json') }}
-
-      - name: Install libvirt-dev
-        run: sudo apt-get update && sudo apt-get install libvirt-dev
-
-      - name: Installing node deps
-        run: npm install
-
-      - name: Lint files
-        run: npm run lint
+      - name: Checkout
+        uses: actions/checkout@v4
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
 
+      - id: release
+        uses: googleapis/release-please-action@v4
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    outputs:
+      releases_created: ${{ steps.release.outputs.releases_created || 'false' }}
+      tag_name: ${{ steps.release.outputs.tag_name || '' }}
   test-api:
+    name: Test API
     defaults:
       run:
         working-directory: api
     runs-on: ubuntu-latest
-
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
+      - name: Install Node
+        uses: actions/setup-node@v4
         with:
-          persist-credentials: false
+          node-version-file: ".nvmrc"
 
-      - name: Reconfigure git to use HTTP authentication
-        run: >
-          git config --global url."https://github.com/".insteadOf
-          ssh://git@github.com/
+      - name: Cache APT Packages
+        uses: awalsh128/cache-apt-pkgs-action@v1.4.3
+        with:
+          packages: bash procps python3 libvirt-dev jq zstd git build-essential
+          version: 1.0
 
-      - name: Build Docker Compose
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          run_install: false
+
+      - name: Get pnpm store directory
+        id: pnpm-cache
+        shell: bash
         run: |
-          docker network create mothership_default
-          docker-compose build builder
+          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
 
-      - name: Run Docker Compose
-        run: docker-compose run builder npm run coverage
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
+        with:
+          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: PNPM Install
+        run: pnpm install --frozen-lockfile
+
+      - name: Lint
+        run: pnpm run lint
+
+      - name: Test
+        run: pnpm run coverage
 
   build-api:
+    name: Build API
+    runs-on: ubuntu-latest
     defaults:
       run:
         working-directory: api
-    runs-on: ubuntu-latest
-
-    outputs:
-      API_VERSION: ${{ steps.build-pack-binary.outputs.API_VERSION }}
-      API_MD5: ${{ steps.set-hashes.outputs.API_MD5 }}
-      API_SHA256: ${{ steps.set-hashes.outputs.API_SHA256 }}
-
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Add SSH deploy key
-        uses: shimataro/ssh-key-action@v2
+      - name: Install Node
+        uses: actions/setup-node@v4
         with:
-          key: ${{ secrets.UNRAID_BOT_SSH_KEY }}
-          known_hosts: ${{ secrets.KNOWN_HOSTS }}
+          node-version-file: ".nvmrc"
 
-      - name: Install node
-        uses: actions/setup-node@v3
+      - uses: pnpm/action-setup@v4
+        name: Install pnpm
         with:
-          node-version-file: "api/.nvmrc"
+          run_install: false
 
-      - name: Install libvirt-dev
-        run: sudo apt-get update && sudo apt-get install libvirt-dev
-
-      - name: Installing node deps
-        run: npm install
-
-      - name: Install pkg and node-prune
-        run: npm i -g pkg && curl -sf https://gobinaries.com/tj/node-prune | sh
-
-      # See https://github.com/apollographql/subscriptions-transport-ws/issues/433
-      - name: Patch subscriptions-transport-ws
-        run: npm run patch:subscriptions-transport-ws
-
-
-      - name: Build and Pack
-        id: build-pack-binary
-        run: WORKDIR=${{ github.workspace }} && npm run build-pkg
-
-      - name: Set Hashes
-        id: set-hashes
+      - name: Get pnpm store directory
+        id: pnpm-cache
+        shell: bash
         run: |
-          API_MD5=$(md5sum ${{ github.workspace }}/api/deploy/release/*.tgz | awk '{ print $1 }')
-          API_SHA256=$(sha256sum ${{ github.workspace }}/api/deploy/release/*.tgz | awk '{ print $1 }')
-          echo "::set-output name=API_MD5::${API_MD5}"
-          echo "::set-output name=API_SHA256::${API_SHA256}"
+          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
+        with:
+          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Cache APT Packages
+        uses: awalsh128/cache-apt-pkgs-action@v1.4.3
+        with:
+          packages: bash procps python3 libvirt-dev jq zstd git build-essential
+          version: 1.0
+
+      - name: PNPM Install
+        run: |
+          cd ${{ github.workspace }}
+          pnpm install --frozen-lockfile
+
+      - name: Lint
+        run: pnpm run lint
+
+      - name: Type Check
+        run: pnpm run type-check
+
+      - name: Build
+        run: pnpm run build
+
+      - name: Get Git Short Sha and API version
+        id: vars
+        run: |
+          GIT_SHA=$(git rev-parse --short HEAD)
+          IS_TAGGED=$(git describe --tags --abbrev=0 --exact-match || echo '')
+          PACKAGE_LOCK_VERSION=$(jq -r '.version' package.json)
+          API_VERSION=$([[ -n "$IS_TAGGED" ]] && echo "$PACKAGE_LOCK_VERSION" || echo "${PACKAGE_LOCK_VERSION}+${GIT_SHA}")
+          export API_VERSION
+
+      - name: Build
+        run: |
+          pnpm run build:release
+
+          tar -czf deploy/unraid-api.tgz -C deploy/pack/ .
 
       - name: Upload tgz to Github artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: unraid-api
-          path: ${{ github.workspace }}/api/deploy/release/*.tgz
+          path: ${{ github.workspace }}/api/deploy/unraid-api.tgz
+
+  build-unraid-ui-webcomponents:
+    name: Build Unraid UI Library (Webcomponent Version)
+    defaults:
+      run:
+        working-directory: unraid-ui
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: ".nvmrc"
+
+      - uses: pnpm/action-setup@v4
+        name: Install pnpm
+        with:
+          run_install: false
+
+      - name: Get pnpm store directory
+        id: pnpm-cache
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
+        with:
+          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Cache APT Packages
+        uses: awalsh128/cache-apt-pkgs-action@v1.4.3
+        with:
+          packages: bash procps python3 libvirt-dev jq zstd git build-essential
+          version: 1.0
+
+      - name: Install dependencies
+        run: |
+          cd ${{ github.workspace }}
+          pnpm install --frozen-lockfile --filter @unraid/ui
+
+      - name: Build
+        run: pnpm run build:wc
+
+      - name: Upload Artifact to Github
+        uses: actions/upload-artifact@v4
+        with:
+          name: unraid-wc-ui
+          path: unraid-ui/dist-wc/
+
+  build-web:
+    # needs: [build-unraid-ui]
+    name: Build Web App
+    defaults:
+      run:
+        working-directory: web
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Create env file
+        run: |
+          touch .env
+          echo VITE_ACCOUNT=${{ secrets.VITE_ACCOUNT }} >> .env
+          echo VITE_CONNECT=${{ secrets.VITE_CONNECT }} >> .env
+          echo VITE_UNRAID_NET=${{ secrets.VITE_UNRAID_NET }} >> .env
+          echo VITE_CALLBACK_KEY=${{ secrets.VITE_CALLBACK_KEY }} >> .env
+          cat .env
+
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: ".nvmrc"
+
+      - uses: pnpm/action-setup@v4
+        name: Install pnpm
+        with:
+          run_install: false
+
+      - name: Get pnpm store directory
+        id: pnpm-cache
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
+        with:
+          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: PNPM Install
+        run: |
+          cd ${{ github.workspace }}
+          pnpm install --frozen-lockfile --filter @unraid/web --filter @unraid/ui
+
+      - name: Build Unraid UI
+        run: |
+          cd ${{ github.workspace }}/unraid-ui
+          pnpm run build
+
+      - name: Lint files
+        run: pnpm run lint
+
+      - name: Type Check
+        run: pnpm run type-check
+
+      - name: Test
+        run: pnpm run test:ci
+
+      - name: Build
+        run: pnpm run build
+
+      - name: Upload build to Github artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: unraid-wc-rich
+          path: web/.nuxt/nuxt-custom-elements/dist/unraid-components
 
   build-plugin:
-    needs: [lint-api, test-api, build-api]
+    name: Build and Deploy Plugin
+    needs:
+      - release-please
+      - build-api
+      - build-web
+      - build-unraid-ui-webcomponents
+      - test-api
     defaults:
       run:
         working-directory: plugin
     runs-on: ubuntu-latest
     steps:
       - name: Set Timezone
-        uses: szenius/set-timezone@v1.2
+        uses: szenius/set-timezone@v2.0
         with:
           timezoneLinux: "America/Los_Angeles"
       - name: Checkout repo
-        uses: actions/checkout@v3
-      - name: Build Plugin
-        run: |
-          cd source/dynamix.unraid.net
-          export API_VERSION=${{needs.build-api.outputs.API_VERSION}}
-          export API_MD5=${{needs.build-api.outputs.API_MD5}}
-          export API_SHA256=${{needs.build-api.outputs.API_SHA256}}
-          bash ./pkg_build.sh s
-          bash ./pkg_build.sh p
-      - name: Upload binary txz and plg to Github artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/checkout@v4
         with:
-          name: connect-files
-          path: |
-            ${{ github.workspace }}/plugin/archive/*.txz
-            ${{ github.workspace }}/plugin/plugins/*.plg
-          retention-days: 5
-          if-no-files-found: error
+          fetch-depth: 0
 
-  release-staging:
-    # Only release if this is a push to the main branch
-    if: startsWith(github.ref, 'refs/heads/main')
-    runs-on: ubuntu-latest
-    needs: [build-plugin]
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: ".nvmrc"
 
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v4
+        name: Install pnpm
+        with:
+          run_install: false
 
-      - name: Make Staging Release Folder
-        run: mkdir staging-release/
+      - name: Get pnpm store directory
+        id: pnpm-cache
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
 
-      - name: Download unraid-api binary tgz
-        uses: actions/download-artifact@v3
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
+        with:
+          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
+        run: |
+          cd ${{ github.workspace }}
+          pnpm install --frozen-lockfile --filter @unraid/connect-plugin
+
+      - name: Download Unraid UI Components
+        uses: actions/download-artifact@v4
+        with:
+          name: unraid-wc-ui
+          path: ${{ github.workspace }}/plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/unraid-components/uui
+          merge-multiple: true
+      - name: Download Unraid Web Components
+        uses: actions/download-artifact@v4
+        with:
+          pattern: unraid-wc-rich
+          path: ${{ github.workspace }}/plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/unraid-components/nuxt
+          merge-multiple: true
+      - name: Download Unraid API
+        uses: actions/download-artifact@v4
         with:
           name: unraid-api
-          path: staging-release
-
-      - name: Download plugin binary tgz
-        uses: actions/download-artifact@v3
-        with:
-          name: connect-files
-
-      - name: Parse Changelog
-        id: changelog
-        uses: ocavue/changelog-parser-action@v1
-        with:
-          removeMarkdown: false
-          filePath: "./api/CHANGELOG.md"
-
-      - name: Create release notes
+          path: ${{ github.workspace }}/plugin/api/
+      - name: Extract Unraid API
         run: |
-          escapedNotes=$(sed -e 's/[&\\/]/\\&/g; s/$/\\/' -e '$s/\\$//' <<<"${{steps.changelog.outputs.latestBody}}")
-          sed -i -z -E "s/<CHANGES>(.*)<\/CHANGES>/<CHANGES>\n${escapedNotes}\n<\/CHANGES>/g" "plugins/dynamix.unraid.net.staging.plg"
-
-      - name: Run LS in unraid-api folder
+          mkdir -p ${{ github.workspace }}/plugin/source/dynamix.unraid.net/usr/local/unraid-api
+          tar -xzf ${{ github.workspace }}/plugin/api/unraid-api.tgz -C ${{ github.workspace }}/plugin/source/dynamix.unraid.net/usr/local/unraid-api
+      - name: Build Plugin and TXZ Based on Event and Tag
+        id: build-plugin
         run: |
-          cp archive/dynamix.unraid.net.staging-*.txz staging-release/
-          cp plugins/dynamix.unraid.net.staging.plg staging-release/
-          ls -al staging-release
+          cd ${{ github.workspace }}/plugin
+          pnpm run build:txz
 
-      - name: Upload Staging Plugin to DO Spaces
-        uses: BetaHuhn/do-spaces-action@v2
+          if [ -n "${{ github.event.pull_request.number }}" ]; then
+            TAG="PR${{ github.event.pull_request.number }}"
+            BUCKET_PATH="unraid-api/tag/${TAG}"
+          else
+            TAG=""
+            BUCKET_PATH="unraid-api"
+          fi
+
+          if [ "${{ needs.release-please.outputs.releases_created }}" == 'true' ]; then
+            BASE_URL="https://stable.dl.unraid.net/unraid-api"
+          else
+            BASE_URL="https://preview.dl.unraid.net/unraid-api"
+          fi
+
+          echo "BUCKET_PATH=${BUCKET_PATH}" >> $GITHUB_OUTPUT
+          echo "TAG=${TAG}" >> $GITHUB_OUTPUT
+
+          pnpm run build:plugin --tag="${TAG}" --base-url="${BASE_URL}"
+
+      - name: Ensure Plugin Files Exist
+        run: |
+          if [ ! -f ./deploy/*.plg ]; then
+            echo "Error: .plg file not found in plugin/deploy/"
+            exit 1
+          fi
+
+          if [ ! -f ./deploy/*.txz ]; then
+            echo "Error: .txz file not found in plugin/deploy/"
+            exit 1
+          fi
+      - name: Upload to GHA
+        uses: actions/upload-artifact@v4
         with:
-          access_key: ${{ secrets.DO_ACCESS_KEY }}
-          secret_key: ${{ secrets.DO_SECRET_KEY }}
-          space_name: ${{ secrets.DO_SPACE_NAME }}
-          space_region: ${{ secrets.DO_SPACE_REGION }}
-          source: staging-release
-          out_dir: unraid-api
+          name: unraid-plugin
+          path: plugin/deploy/
+      - name: Upload to Cloudflare
+        if: github.event_name == 'pull_request' || startsWith(github.ref, 'refs/heads/main')
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.CF_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.CF_SECRET_ACCESS_KEY }}
+          AWS_DEFAULT_REGION: auto
+        run: |
+          # Sync the deploy directory to the Cloudflare bucket - CRC32 is required for the checksum-algorithm on cloudflare (ref. https://community.cloudflare.com/t/an-error-occurred-internalerror-when-calling-the-putobject-operation/764905/8)
+          aws s3 sync deploy/ s3://${{ secrets.CF_BUCKET_PREVIEW }}/${{ steps.build-plugin.outputs.BUCKET_PATH }} --endpoint-url ${{ secrets.CF_ENDPOINT }} --checksum-algorithm CRC32
 
-  create-draft-release:
-    # Only create new draft if this is a version tag
-    if: |
-      startsWith(github.ref, 'refs/tags/v')
-    runs-on: ubuntu-latest
-    needs: [build-plugin]
-
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v3
-
-      - name: Download unraid-api binary tgz
-        uses: actions/download-artifact@v3
-        with:
-          name: unraid-api
-
-      - name: Download plugin binary tgz
-        uses: actions/download-artifact@v3
-        with:
-          name: connect-files
-
-      - name: Create Github release
-        uses: softprops/action-gh-release@v1
-        with:
-          draft: true
-          prerelease: false
-          files: |
-            unraid-api-*.tgz
-            plugins/dynamix.unraid.net*
-            archive/dynamix.unraid.net*
+      - name: Upload Release Assets
+        if: needs.release-please.outputs.releases_created == 'true'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          release_name=$(gh release list --repo ${{ github.repository }} --json name,isDraft --jq '.[] | select(.isDraft == true) | .name' | head -n 1)
+          # For each file in release directory
+          for file in deploy/*; do
+            echo "Uploading $file to release..."
+            gh release upload "${release_name}" "$file" --clobber
+          done
+
+      - name: Comment URL
+        if: github.event_name == 'pull_request'
+        uses: thollander/actions-comment-pull-request@v3
+        with:
+          comment-tag: prlink
+          mode: recreate
+          message: |
+            This plugin has been deployed to Cloudflare R2 and is available for testing.
+            Download it at this URL:
+            ```
+            https://preview.dl.unraid.net/unraid-api/tag/${{ steps.build-plugin.outputs.tag }}/dynamix.unraid.net.plg
+            ```

.github/workflows/pull-request.yml

@@ -1,178 +0,0 @@
-name: Pull Request
-
-on:
-  pull_request:
-    paths:
-      - '**.js'
-      - '**.ts'
-
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  lint-api:
-    continue-on-error: true
-    defaults:
-      run:
-        working-directory: api
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v3
-        with:
-          persist-credentials: false
-      - name: Reconfigure git to use HTTP authenti:cation
-        run: >
-          git config --global url."https://github.com/".insteadOf
-          ssh://git@github.com/
-
-      - name: Install node
-        uses: actions/setup-node@v3
-        with:
-          node-version-file: "api/.nvmrc"
-
-      #      - name: Cache dependencies
-      #        uses: actions/cache@v2
-      #        with:
-      #          path: ~/.npm
-      #          key: npm-${{ hashFiles('package-lock.json') }}
-      #          restore-keys: npm-
-
-      - name: Install libvirt-dev
-        run: sudo apt-get update && sudo apt-get install libvirt-dev
-
-      - name: Installing node deps
-        run: npm ci
-
-      - name: Lint files
-        run: npm run lint
-
-  test-api:
-    defaults:
-      run:
-        working-directory: api
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v3
-        with:
-          persist-credentials: false
-
-      - name: Reconfigure git to use HTTP authentication
-        run: >
-          git config --global url."https://github.com/".insteadOf
-          ssh://git@github.com/
-
-      - name: Build Docker Compose
-        run: |
-          docker network create mothership_default
-          docker-compose build builder
-      - name: Run Docker Compose
-        run: docker-compose run builder npm run coverage
-
-  build-api:
-    defaults:
-      run:
-        working-directory: api
-    runs-on: ubuntu-latest
-
-    outputs:
-      API_VERSION: ${{ steps.build-pack-binary.outputs.API_VERSION }}
-      API_MD5: ${{ steps.set-hashes.outputs.API_MD5 }}
-      API_SHA256: ${{ steps.set-hashes.outputs.API_SHA256 }}
-
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v3
-
-      - name: Install node
-        uses: actions/setup-node@v3
-        with:
-          node-version-file: "api/.nvmrc"
-
-      - name: Install libvirt-dev
-        run: sudo apt-get update && sudo apt-get install libvirt-dev
-
-      #      - name: Cache dependencies
-      #        uses: actions/cache@v2
-      #        with:
-      #          path: ~/.npm
-      #          key: npm-${{ hashFiles('package-lock.json') }}
-      #          restore-keys: npm-
-
-      - name: Installing node deps
-        run: npm install
-
-      - name: Install pkg
-        run: npm i -g pkg
-
-      - name: Build and Pack
-        id: build-pack-binary
-        run: WORKDIR=${{ github.workspace }} && npm run build-pkg
-
-      - name: Set Hashes
-        id: set-hashes
-        run: |
-          API_MD5=$(md5sum ${{ github.workspace }}/api/deploy/release/*.tgz | awk '{ print $1 }')
-          API_SHA256=$(sha256sum ${{ github.workspace }}/api/deploy/release/*.tgz | awk '{ print $1 }')
-          echo "::set-output name=API_MD5::${API_MD5}"
-          echo "::set-output name=API_SHA256::${API_SHA256}"
-
-      - name: Upload tgz to Github artifacts
-        uses: actions/upload-artifact@v3
-        with:
-          name: unraid-api
-          path: ${{ github.workspace }}/api/deploy/release/*.tgz
-
-      - name: Parse Changelog
-        id: changelog
-        uses: ocavue/changelog-parser-action@v1
-        with:
-          removeMarkdown: false
-          filePath: "./api/CHANGELOG.md"
-
-      - name: View release notes
-        run: |
-          escapedNotes=$(sed -e 's/[&\\/]/\\&/g; s/$/\\/' -e '$s/\\$//' <<<"${{steps.changelog.outputs.latestBody}}")
-          echo "${escapedNotes}"
-  build-plugin:
-    defaults:
-      run:
-        working-directory: plugin
-    runs-on: ubuntu-latest
-    needs: [lint-api, test-api, build-api]
-    steps:
-      - name: Set Timezone
-        uses: szenius/set-timezone@v1.2
-        with:
-          timezoneLinux: "America/Los_Angeles"
-      - name: Checkout repo
-        uses: actions/checkout@v3
-      - name: Build Plugin
-        run: |
-          cd source/dynamix.unraid.net
-          export API_VERSION=${{needs.build-api.outputs.API_VERSION}}
-          export API_MD5=${{needs.build-api.outputs.API_MD5}}
-          export API_SHA256=${{needs.build-api.outputs.API_SHA256}}
-          bash ./pkg_build.sh s
-          bash ./pkg_build.sh p
-      - name: Create release notes
-        run: |
-          LAST_RELEASE=$(git tag --list --sort=v:refname | tail -1) 
-          echo ${LAST_RELEASE}
-          RELEASE_NOTES=$(git log "$LAST_RELEASE...HEAD" --pretty=format:"- %s [\`%h\`](http://github.com/$GITHUB_REPOSITORY/commit/%H)" --reverse)
-          echo "${RELEASE_NOTES}"
-          # escapedNotes=$(sed -e 's/[&\\/]/\\&/g; s/$/\\/' -e '$s/\\$//' <<<"${RELEASE_NOTES}")
-          # sed -i -z -E "s/<CHANGES>(.*)<\/CHANGES>/<CHANGES>\n${escapedNotes}\n<\/CHANGES>/g" "plugins/dynamix.unraid.net.staging.plg"
-      - name: Upload binary txz and plg to Github artifacts
-        uses: actions/upload-artifact@v3
-        with:
-          name: connect-files
-          path: |
-            ${{ github.workspace }}/plugin/archive/*.txz
-            ${{ github.workspace }}/plugin/plugins/*.plg
-          retention-days: 5
-          if-no-files-found: error

.github/workflows/push-staging-pr-on-close.yml

@@ -0,0 +1,57 @@
+name: Push Staging Plugin on PR Close
+
+on:
+  pull_request:
+    types:
+      - closed
+
+jobs:
+  push-staging:
+    if: github.event.pull_request.merged == true
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Set Timezone
+        uses: szenius/set-timezone@v2.0
+        with:
+          timezoneLinux: "America/Los_Angeles"
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          ref: refs/pull/${{ github.event.pull_request.base.ref }}/merge
+
+      - name: Download artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: connect-files
+          path: connect-files
+
+      - name: Update Downloaded Staging Plugin to New Date
+        run: |
+          if [ ! -f "connect-files/plugins/dynamix.unraid.net.pr.plg" ]; then
+            echo "ERROR: dynamix.unraid.net.pr.plg not found"
+            exit 1
+          fi
+
+          plgfile="connect-files/plugins/dynamix.unraid.net.pr.plg"
+          version=$(date +"%Y.%m.%d.%H%M")
+          sed -i -E "s#(<!ENTITY version \").*(\">)#\1${version}\2#g" "${plgfile}" || exit 1
+                
+          # Change the plugin url to point to staging
+          url="https://preview.dl.unraid.net/unraid-api/dynamix.unraid.net.plg"
+          sed -i -E "s#(<!ENTITY pluginURL \").*(\">)#\1${url}\2#g" "${plgfile}" || exit 1
+          cat "${plgfile}"
+          mkdir -p pr-release
+          mv "${plgfile}" pr-release/dynamix.unraid.net.plg
+
+      - name: Upload to Cloudflare
+        uses: jakejarvis/s3-sync-action@v0.5.1
+        env:
+          AWS_S3_ENDPOINT: ${{ secrets.CF_ENDPOINT }}
+          AWS_S3_BUCKET: ${{ secrets.CF_BUCKET_PREVIEW }}
+          AWS_ACCESS_KEY_ID: ${{ secrets.CF_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.CF_SECRET_ACCESS_KEY }}
+          AWS_REGION: "auto"
+          SOURCE_DIR: pr-release
+          DEST_DIR: unraid-api/pr/${{ github.event.pull_request.number }}

.github/workflows/release-production.yml

@@ -0,0 +1,96 @@
+name: Publish Release to Digital Ocean
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Tag to update'
+        required: true
+
+
+jobs:
+  publish-to-digital-ocean:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download Release Artifacts (Plugins)
+        uses: dsaltares/fetch-gh-release-asset@master
+        with:
+          file: ".*"
+          regex: true
+          token: ${{ secrets.GITHUB_TOKEN }}
+          target: "./"
+          version: ${{ inputs.version && format('tags/{0}', inputs.version) || 'latest' }}
+
+      - uses: cardinalby/git-get-release-action@v1
+        id: release-info
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          latest: true
+          prerelease: false
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+      - run: npm install html-escaper@2 xml2js
+      - name: Update Plugin Changelog
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const fs = require('fs');
+            const { escape } = require('html-escaper');
+            const releaseNotes = escape(`${{ steps.release-info.outputs.body }}`);
+            
+            if (!releaseNotes) {
+              console.error('No release notes found');
+              process.exit(1);
+            }
+
+            // Read the plugin file
+            const pluginPath = 'dynamix.unraid.net.plg';
+
+            if (!fs.existsSync(pluginPath)) {
+              console.error('Plugin file not found:', pluginPath);
+              process.exit(1);
+            }
+            
+            let pluginContent = fs.readFileSync(pluginPath, 'utf8');
+            
+            // Replace the changelog section using CDATA
+            pluginContent = pluginContent.replace(
+              /<CHANGES>[\s\S]*?<\/CHANGES>/,
+              `<CHANGES>\n${releaseNotes}\n</CHANGES>`
+            );
+            
+            // Validate the plugin file is valid XML
+            const xml2js = require('xml2js');
+            const parser = new xml2js.Parser();
+            parser.parseStringPromise(pluginContent).then((result) => {
+              console.log('Plugin file is valid XML');
+
+              // Write back to file
+              fs.writeFileSync(pluginPath, pluginContent);
+            }).catch((err) => {
+              console.error('Plugin file is not valid XML', err);
+              process.exit(1);
+            });
+
+      - name: Upload Release Files to DO Spaces
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.DO_ACCESS_KEY }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.DO_SECRET_KEY }}
+          AWS_DEFAULT_REGION: ${{ secrets.DO_SPACE_REGION }}
+          AWS_ENDPOINT_URL: https://${{ secrets.DO_SPACE_REGION }}.digitaloceanspaces.com
+        run: |
+          aws s3 sync . s3://${{ secrets.DO_SPACE_NAME }}/unraid-api --checksum-algorithm CRC32
+
+      - name: Upload Release Files to Cloudflare Bucket
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.CF_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.CF_SECRET_ACCESS_KEY }}
+          AWS_DEFAULT_REGION: auto
+          AWS_ENDPOINT_URL: ${{ secrets.CF_ENDPOINT }}
+        run: |
+          aws s3 sync . s3://${{ secrets.CF_BUCKET }}/unraid-api --checksum-algorithm CRC32

.github/workflows/test-libvirt.yml

@@ -0,0 +1,71 @@
+name: Test Libvirt
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "libvirt/**"
+  pull_request:
+    paths:
+      - "libvirt/**"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: ./libvirt
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Cache APT Packages
+        uses: awalsh128/cache-apt-pkgs-action@v1.4.3
+        with:
+          packages: libvirt-dev
+          version: 1.0
+
+      - name: Set Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: ".nvmrc"
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+          run_install: false
+
+      - name: Get pnpm store directory
+        id: pnpm-cache
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
+        with:
+          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('libvirt/package.json') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: pnpm install
+        run: pnpm install --frozen-lockfile
+
+      - name: Build
+        run: pnpm run build
+
+      - name: test
+        run: pnpm run test

.gitignore

@@ -0,0 +1,103 @@
+# Logs
+./logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+coverage-ts
+
+# nyc test coverage
+.nyc_output
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+unraid-ui/node_modules/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next
+
+# Visual Studio Code workspace
+.vscode/sftp.json
+.history/
+
+# OSX
+.DS_Store
+
+# Jetbrains Settings Files
+.idea
+
+# Temp dir for tests
+test/__temp__/*
+
+# Built files
+dist
+unraid-ui/storybook-static
+
+# Typescript
+typescript
+
+# Ultra runner
+.ultra.cache.json
+
+# Github actions
+RELEASE_NOTES.md
+
+# Docker Deploy Folder
+deploy/*
+!deploy/.gitkeep
+
+# pkg cache
+.pkg-cache
+
+*.log*
+.nuxt
+.nitro
+.cache
+.output
+.env*
+!.env.example
+
+fb_keepalive
+
+# pnpm store
+.pnpm-store
+
+# Nix
+result
+result-*
+.direnv/
+.envrc

.npmrc

@@ -0,0 +1 @@
+ 

.nvmrc

@@ -0,0 +1 @@
+22

.release-please-manifest.json

@@ -0,0 +1 @@
+{".":"4.2.1"}

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+    "recommendations": [
+        "davidanson.vscode-markdownlint",
+        "foxundermoon.shell-format",
+        "timonwong.shellcheck",
+        "esbenp.prettier-vscode"
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,15 @@
+{
+    "files.associations": {
+      "*.page": "php"
+    },
+    "editor.codeActionsOnSave": {
+      "source.fixAll": "never",
+      "source.fixAll.eslint": "explicit"
+    },
+    "i18n-ally.localesPaths": [
+      "locales"
+    ],
+    "i18n-ally.keystyle": "flat",
+    "eslint.experimental.useFlatConfig": true
+  }
+  

.vscode/sftp-template.json

@@ -0,0 +1,22 @@
+{
+    "_comment": "rename this file to .vscode/sftp.json and replace name/host/privateKeyPath for your system",
+    "name": "Tower",
+    "host": "Tower.local",
+    "protocol": "sftp",
+    "port": 22,
+    "username": "root",
+    "privateKeyPath": "C:/Users/username/.ssh/tower",
+    "remotePath": "/",
+    "context": "plugin/source/dynamix.unraid.net/",
+    "uploadOnSave": true,
+    "useTempFile": false,
+    "openSsh": false,
+    "ignore": [
+      "// comment: ignore dot files/dirs in root of repo",
+      ".github",
+      ".vscode",
+      ".git",
+      ".DS_Store"
+    ]
+  }
+  

CONTRIBUTING.md

@@ -0,0 +1,80 @@
+# Contributing to Unraid Connect
+
+Thank you for your interest in contributing to Unraid Connect! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+
+## TypeScript Import Extensions in the API Directory
+
+When working with the API directory, you'll notice that TypeScript files are imported with `.js` extensions (e.g., `import { something } from './file.js'`) even though the actual files have `.ts` extensions. This is because:
+
+1. We use ECMAScript modules (ESM) in our TypeScript configuration
+2. When TypeScript compiles `.ts` files to `.js`, the import paths in the compiled code need to reference `.js` files
+3. TypeScript doesn't automatically change the extensions in import statements during compilation
+4. Using `.js` extensions in imports ensures that both TypeScript during development and Node.js in production can resolve the modules correctly
+
+This approach follows the [official TypeScript ESM recommendation](https://www.typescriptlang.org/docs/handbook/esm-node.html) and ensures compatibility across development and production environments.
+
+## Development Process
+
+We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
+
+### 1. Work Intent Process
+
+**Before starting any development work**, you must submit a Work Intent and have it approved:
+
+1. **Create a Work Intent**
+   - Go to [Issues → New Issue → Work Intent](https://github.com/unraid/api/issues/new?template=work_intent.md)
+   - Fill out the brief template describing what you want to work on
+   - The issue will be automatically labeled as `work-intent` and `unapproved`
+
+2. **Wait for Approval**
+   - A core developer will review your Work Intent
+   - They may ask questions or suggest changes
+   - Once approved, the `unapproved` label will be removed
+
+3. **Begin Development**
+   - Only start coding after your Work Intent is approved
+   - Follow the approach outlined in your approved Work Intent
+   - Reference the Work Intent in your future PR
+
+### 2. Making Changes
+
+1. Fork the repo and create your branch from `main`
+2. Make your changes
+3. Ensure your commits are clear and descriptive
+4. Keep your changes focused - solve one thing at a time
+
+### 3. Pull Request Process
+
+1. Create a pull request from your fork to our `main` branch
+2. Reference the approved Work Intent in your PR description
+3. Ensure the PR description clearly describes the problem and solution
+4. Include screenshots or examples if applicable
+5. Wait for review from the core team
+
+**Note:** Direct pushes to the main branch are not allowed. All changes must go through the PR process.
+
+## Developer Documentation
+
+For detailed information about development workflows, repository organization, and other technical details, please refer to our developer documentation:
+
+- [Development Guide](api/docs/developer/development.md) - Setup, building, and debugging instructions
+- [Development Workflows](api/docs/developer/workflows.md) - Detailed workflows for local development, building, and deployment
+- [Repository Organization](api/docs/developer/repo-organization.md) - High-level architecture and project structure
+
+## Bug Reports and Feature Requests
+
+We use GitHub issues to track bugs and feature requests:
+
+- **Bug Report**: Use the [Bug Report Template](https://github.com/unraid/api/issues/new?template=bug_report.md)
+- **Feature Request**: Use the [Feature Request Template](https://github.com/unraid/api/issues/new?template=feature_request.md)
+
+For Unraid Connect specific issues (Flash Backup, connect.myunraid.net, mothership connectivity), please submit through our support portal instead.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the same terms as the main project.

LICENSE.md

@@ -0,0 +1,342 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  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
+have the freedom to distribute copies of free software (and charge for
+this service 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.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+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 a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    Unraid API - Core API functionality for Unraid systems
+    Copyright (C) 2024  Lime Technology, Inc.
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 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 General Public License for more details.
+
+    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.
+
+For questions about licensing or to report issues:
+- Website: https://unraid.net
+- Email: support@unraid.net
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    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, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Moe Ghoul>, 1 April 1989
+  Moe Ghoul, President of Vice
+
+This 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.

api/.dockerignore

@@ -0,0 +1 @@
+node_modules/

api/.env.development

@@ -1,11 +1,14 @@
 PATHS_UNRAID_DATA=./dev/data # Where we store plugin data (e.g. permissions.json)
 PATHS_STATES=./dev/states # Where .ini files live (e.g. vars.ini)
+PATHS_AUTH_SESSIONS=./dev/sessions # Where user sessions live
+PATHS_AUTH_KEY=./dev/keys # Auth key directory
 PATHS_DYNAMIX_BASE=./dev/dynamix # Dynamix's data directory
+PATHS_DYNAMIX_CONFIG_DEFAULT=./dev/dynamix/default.cfg # Dynamix's default config file, which ships with unraid
 PATHS_DYNAMIX_CONFIG=./dev/dynamix/dynamix.cfg # Dynamix's config file
 PATHS_MY_SERVERS_CONFIG=./dev/Unraid.net/myservers.cfg # My servers config file
+PATHS_MY_SERVERS_FB=./dev/Unraid.net/fb_keepalive # My servers flashbackup timekeeper file
 PATHS_KEYFILE_BASE=./dev/Unraid.net # Keyfile location
 PATHS_MACHINE_ID=./dev/data/machine-id
-
 ENVIRONMENT="development"
 NODE_ENV="development"
 PORT="3001"
@@ -13,6 +16,8 @@ PLAYGROUND=true
 INTROSPECTION=true
 MOTHERSHIP_GRAPHQL_LINK="http://authenticator:3000/graphql"
 NODE_TLS_REJECT_UNAUTHORIZED=0
-BYPASS_PERMISSION_CHECKS=true
-BYPASS_CORS_CHECKS=false
+BYPASS_PERMISSION_CHECKS=false
+BYPASS_CORS_CHECKS=true
 CHOKIDAR_USEPOLLING=true
+LOG_TRANSPORT=console
+LOG_LEVEL=trace

api/.env.production

@@ -0,0 +1,4 @@
+ENVIRONMENT="production"
+NODE_ENV="production"
+PORT="/var/run/unraid-api.sock"
+MOTHERSHIP_GRAPHQL_LINK="https://mothership.unraid.net/ws"

api/.env.test

@@ -0,0 +1,13 @@
+PATHS_UNRAID_DATA=./dev/data # Where we store plugin data (e.g. permissions.json)
+PATHS_STATES=./dev/states # Where .ini files live (e.g. vars.ini)
+PATHS_AUTH_SESSIONS=./dev/sessions # Where user sessions live
+PATHS_AUTH_KEY=./dev/keys # Auth key directory
+PATHS_DYNAMIX_BASE=./dev/dynamix # Dynamix's data directory
+PATHS_DYNAMIX_CONFIG_DEFAULT=./dev/dynamix/default.cfg # Dynamix's default config file, which ships with unraid
+PATHS_DYNAMIX_CONFIG=./dev/dynamix/dynamix.cfg # Dynamix's config file
+PATHS_MY_SERVERS_CONFIG=./dev/Unraid.net/myservers.cfg # My servers config file
+PATHS_MY_SERVERS_FB=./dev/Unraid.net/fb_keepalive # My servers flashbackup timekeeper file
+PATHS_KEYFILE_BASE=./dev/Unraid.net # Keyfile location
+PATHS_MACHINE_ID=./dev/data/machine-id
+PORT=5000
+NODE_ENV="test"

api/.eslintrc.cjs

@@ -1,46 +0,0 @@
-/** @type {import('eslint').Linter.Config} */
-module.exports = {
-    root: true,
-    plugins: [
-        '@typescript-eslint/eslint-plugin',
-        'unused-imports',
-        'eslint-plugin-unicorn',
-    ],
-    ignorePatterns: ['src/graphql/generated/**/*.ts', '*.test.ts', 'tsup.config.ts', 'vite.config.ts'],
-    parser: '@typescript-eslint/parser',
-    rules: {
-        '@typescript-eslint/no-redundant-type-constituents': 'off',
-        '@typescript-eslint/no-unsafe-call': 'off',
-        '@typescript-eslint/naming-convention': 'off',
-        '@typescript-eslint/no-unsafe-assignment': 'off',
-        '@typescript-eslint/no-unsafe-return': 'off',
-        '@typescript-eslint/ban-types': 'off',
-        '@typescript-eslint/no-explicit-any': 'off',
-        '@typescript-eslint/consistent-type-imports': [
-            'warn',
-            { fixStyle: 'inline-type-imports' },
-        ],
-        'unicorn/numeric-separators-style': [
-            'error',
-            { number: { minimumDigits: 0, groupLength: 3 } },
-        ],
-        'import/no-cycle': 'off', // Change this to "error" to find circular imports
-        '@typescript-eslint/no-use-before-define': ['error'],
-    },
-    overrides: [
-        {
-            files: ['*.ts'],
-            extends: [
-                'eslint:recommended',
-                'plugin:@typescript-eslint/recommended',
-            ],
-            parserOptions: {
-                project: true,
-                tsconfigRootDir: __dirname,
-            },
-            rules: {
-                '@typescript-eslint/no-explicit-any': 'off',
-            },
-        },
-    ],
-};

api/.eslintrc.ts

@@ -0,0 +1,57 @@
+import eslint from '@eslint/js';
+import importPlugin from 'eslint-plugin-import';
+import noRelativeImportPaths from 'eslint-plugin-no-relative-import-paths';
+import prettier from 'eslint-plugin-prettier';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(eslint.configs.recommended, ...tseslint.configs.recommended, {
+    plugins: {
+        'no-relative-import-paths': noRelativeImportPaths,
+        prettier: prettier,
+        import: importPlugin,
+    },
+    rules: {
+        '@typescript-eslint/no-redundant-type-constituents': 'off',
+        '@typescript-eslint/no-unsafe-call': 'off',
+        '@typescript-eslint/naming-convention': 'off',
+        '@typescript-eslint/no-unsafe-assignment': 'off',
+        '@typescript-eslint/no-unsafe-return': 'off',
+        '@typescript-eslint/ban-types': 'off',
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/no-empty-object-type': 'off',
+        'no-use-before-define': ['off'],
+        'no-multiple-empty-lines': ['error', { max: 1, maxBOF: 0, maxEOF: 1 }],
+        '@typescript-eslint/no-unused-vars': 'off',
+        '@typescript-eslint/no-unused-expressions': 'off',
+        'import/no-unresolved': 'off',
+        'import/no-absolute-path': 'off',
+        'import/prefer-default-export': 'off',
+        'no-relative-import-paths/no-relative-import-paths': [
+            'error',
+            { allowSameFolder: false, rootDir: 'src', prefix: '@app' },
+        ],
+        'prettier/prettier': 'error',
+        'import/extensions': [
+            'error',
+            'ignorePackages',
+            {
+                js: 'always',
+                ts: 'always',
+            },
+        ],
+        'no-restricted-globals': [
+            'error',
+            {
+                name: '__dirname',
+                message: 'Use import.meta.url instead of __dirname in ESM',
+            },
+            {
+                name: '__filename',
+                message: 'Use import.meta.url instead of __filename in ESM',
+            },
+        ],
+        'eol-last': ['error', 'always'],
+    },
+
+    ignores: ['src/graphql/generated/client/**/*'],
+});

api/.gitignore

@@ -0,0 +1,84 @@
+# Logs
+./logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+coverage-ts
+
+# nyc test coverage
+.nyc_output
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next
+
+# Visual Studio Code workspace
+.vscode/*
+!.vscode/extensions.json
+
+# OSX
+.DS_Store
+
+# Temp dir for tests
+test/__temp__/*
+
+# Built files
+dist
+
+# Typescript
+typescript
+
+# Ultra runner
+.ultra.cache.json
+
+# Github actions
+RELEASE_NOTES.md
+
+# Docker Deploy Folder 
+deploy/*
+!deploy/.gitkeep
+
+# pkg cache
+.pkg-cache
+
+# IDE Settings Files
+.idea
+
+!**/*.login.*

api/.prettierignore

@@ -0,0 +1,7 @@
+!src/*
+
+# Downloaded Fixtures (For File Modifications)
+src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/*
+
+# Generated Types
+src/graphql/generated/client/*.ts

api/.prettierrc.cjs

@@ -0,0 +1,38 @@
+/**
+ * @see https://prettier.io/docs/en/configuration.html
+ * @type {import("prettier").Config}
+ */
+module.exports = {
+    trailingComma: 'es5',
+    tabWidth: 4,
+    semi: true,
+    singleQuote: true,
+    printWidth: 105,
+    plugins: ['@ianvs/prettier-plugin-sort-imports'],
+    // decorators-legacy lets the import sorter transform files with decorators
+    importOrderParserPlugins: ['typescript', 'decorators-legacy'],
+    importOrder: [
+        /**----------------------
+         *    Nest.js & node.js imports
+         *------------------------**/
+        '<TYPES>^@nestjs(/.*)?$',
+        '^@nestjs(/.*)?$', // matches imports starting with @nestjs
+        '<TYPES>^(node:)',
+        '<BUILTIN_MODULES>', // Node.js built-in modules
+        '',
+        /**----------------------
+         *    Third party packages
+         *------------------------**/
+        '<TYPES>',
+        '<THIRD_PARTY_MODULES>', // Imports not matched by other special words or groups.
+        '',
+        /**----------------------
+         *    Application Code
+         *------------------------**/
+        '<TYPES>^@app(/.*)?$', // matches type imports starting with @app
+        '^@app(/.*)?$',
+        '',
+        '<TYPES>^[.]',
+        '^[.]', // relative imports
+    ],
+};

api/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "eslint.lintTask.options": "--flag unstable_ts_config",
+    "eslint.options": {
+        "flags": ["unstable_ts_config"],
+        "overrideConfigFile": ".eslintrc.ts"
+    }
+}

api/Dockerfile

@@ -1,42 +1,45 @@
 ###########################################################
 # Development/Build Image
 ###########################################################
-ARG NODE_IMAGE=node:18
-FROM $NODE_IMAGE As development
+FROM node:22-bookworm-slim AS development
 
-# Install build tools
-RUN apt-get update -y && apt-get install  -y \
-    python \
+# Install build tools and dependencies
+RUN apt-get update -y && apt-get install -y \
+    bash \
+    # Real PS Command (needed for some dependencies)
+    procps \ 
+    python3 \
     libvirt-dev \
     jq \
-    zstd
-
-RUN mkdir /var/log/unraid-api/
-
-
-ARG NODE_ENV=development
-ARG NPM_I_CMD=npm i
+    zstd \
+    git \
+    build-essential
 
 WORKDIR /app
 
 # Set app env
-ENV NODE_ENV=$NODE_ENV
+ENV NODE_ENV=development
+ENV PNPM_HOME="/pnpm"
+ENV PATH="$PNPM_HOME:$PATH"
 
-# Setup cache for pkg
-ENV PKG_CACHE_PATH /app/.pkg-cache
-RUN mkdir -p ${PKG_CACHE_PATH}
+# Install pnpm
+RUN corepack enable && corepack prepare pnpm@8.15.4 --activate && npm i -g npm@latest
 
-COPY package.json package-lock.json ./
-COPY tsconfig.json tsup.config.ts ./
-COPY .npmrc ./
-COPY .env.production .env.staging  ./
+COPY tsconfig.json .eslintrc.ts .prettierrc.cjs .npmrc .env.production .env.staging package.json pnpm-lock.yaml .npmrc ./
 
 # Install deps
-RUN $NPM_I_CMD
+RUN --mount=type=cache,id=pnpm,target=/pnpm/store pnpm install --frozen-lockfile
 
-# Install pkg
-RUN npm i -g pkg zx
+EXPOSE 3001
 
-EXPOSE 4000
+###########################################################
+# Builder Image
+###########################################################
 
-CMD ["npm", "run", "build-pkg"]
+FROM development AS builder
+
+ENV NODE_ENV=production
+
+COPY . .
+
+CMD ["pnpm", "run", "build:release"]

api/README.md

@@ -0,0 +1,76 @@
+# @unraid/api
+
+## Installation
+
+Install the production plugin via the apps tab (search for "Unraid Connect")
+
+Manual install can be done with the following routes:
+[production](https://stable.dl.unraid.net/unraid-api/dynamix.unraid.net.plg)
+[staging](https://preview.dl.unraid.net/unraid-api/dynamix.unraid.net.staging.plg)
+
+## CLI
+
+If you're on a unraid v6.9.2 or later machine this should be available by running `unraid-api` in any directory.
+
+```bash
+root@Devon:~# unraid-api
+
+Unraid API
+
+  Thanks for using the official Unraid API
+
+Usage:
+
+  $ unraid-api command <options>
+
+Commands:
+
+  start/stop/restart/version/status/report/switch-env
+
+Options:
+
+  -h, --help                                                   Prints this usage guide.
+  -d, --debug                                                  Enabled debug mode.
+  -p, --port string                                            Set the graphql port.
+  --environment production/staging/development                 Set the working environment.
+  --log-level ALL/TRACE/DEBUG/INFO/WARN/ERROR/FATAL/MARK/OFF   Set the log level.
+
+  Copyright © 2024 Lime Technology, Inc.
+
+```
+
+## Key
+
+To create and work with Unraid API keys, used for the local API, run the following command to view all available options. These options may change over time.
+
+```sh
+unraid-api key --help
+```
+
+## Report
+
+To view the current status of the unraid-api and its connection to mothership, run:
+
+```sh
+unraid-api report
+```
+
+To view verbose data (anonymized), run:
+
+```sh
+unraid-api report -v
+```
+
+To view non-anonymized verbose data, run:
+
+```sh
+unraid-api report -vv
+```
+
+## Secrets
+
+If you found this file you're likely a developer. If you'd like to know more about the API and when it's available please join [our discord](https://discord.unraid.net/).
+
+## License
+
+Copyright Lime Technology Inc. All rights reserved.

api/codegen.ts

@@ -0,0 +1,105 @@
+import type { CodegenConfig } from '@graphql-codegen/cli';
+
+
+
+
+
+const config: CodegenConfig = {
+    overwrite: true,
+    emitLegacyCommonJSImports: false,
+    verbose: true,
+    config: {
+        namingConvention: {
+            typeNames: './fix-array-type.cjs',
+            enumValues: 'change-case#upperCase',
+            useTypeImports: true,
+        },
+        scalars: {
+            DateTime: 'string',
+            Long: 'number',
+            JSON: 'Record<string, any>',
+            URL: 'URL',
+            Port: 'number',
+            UUID: 'string',
+        },
+        scalarSchemas: {
+            URL: 'z.instanceof(URL)',
+            Long: 'z.number()',
+            JSON: 'z.record(z.string(), z.any())',
+            Port: 'z.number()',
+            UUID: 'z.string()',
+        },
+    },
+    generates: {
+        'src/graphql/generated/client/': {
+            documents: './src/graphql/mothership/*.ts',
+            schema: {
+                [process.env.MOTHERSHIP_GRAPHQL_LINK as string]: {
+                    headers: {
+                        origin: 'https://forums.unraid.net',
+                    },
+                },
+            },
+            preset: 'client',
+            presetConfig: {
+                gqlTagName: 'graphql',
+            },
+            config: {
+                useTypeImports: true,
+                withObjectType: true,
+            },
+            plugins: [{ add: { content: '/* eslint-disable */' } }],
+        },
+        // Generate Types for the API Server
+        'src/graphql/generated/api/types.ts': {
+            schema: ['./src/graphql/types.ts', './src/graphql/schema/types/**/*.graphql'],
+            plugins: [
+                'typescript',
+                'typescript-resolvers',
+                { add: { content: '/* eslint-disable */\n/* @ts-nocheck */' } },
+            ],
+            config: {
+                contextType: '@app/graphql/schema/utils.js#Context',
+                useIndexSignature: true,
+            },
+        },
+        // Generate Operations for any built-in API Server Operations (e.g., report.ts)
+        'src/graphql/generated/api/operations.ts': {
+            documents: './src/graphql/client/api/*.ts',
+            schema: ['./src/graphql/types.ts', './src/graphql/schema/types/**/*.graphql'],
+            preset: 'import-types',
+            presetConfig: {
+                typesPath: '@app/graphql/generated/api/types.js',
+            },
+            plugins: [
+                'typescript-validation-schema',
+                'typescript-operations',
+                'typed-document-node',
+                { add: { content: '/* eslint-disable */' } },
+            ],
+            config: {
+                importFrom: '@app/graphql/generated/api/types.js',
+                strictScalars: true,
+                schema: 'zod',
+                withObjectType: true,
+            },
+        },
+        'src/graphql/generated/client/validators.ts': {
+            schema: {
+                [process.env.MOTHERSHIP_GRAPHQL_LINK as string]: {
+                    headers: {
+                        origin: 'https://forums.unraid.net',
+                    },
+                },
+            },
+            plugins: ['typescript-validation-schema', { add: { content: '/* eslint-disable */' } }],
+            config: {
+                importFrom: '@app/graphql/generated/client/graphql.js',
+                strictScalars: false,
+                schema: 'zod',
+            },
+        },
+    },
+};
+
+export default config;

api/codegen.yml

@@ -1,77 +0,0 @@
-overwrite: true
-emitLegacyCommonJSImports: false
-verbose: true
-require: 
-  - ts-node/register
-config:
-  namingConvention: 
-    typeNames: './fix-array-type.cjs'
-    enumValues: 'change-case#upperCase'
-    useTypeImports: true
-  scalars:
-    DateTime: string
-    Long: number
-    JSON: "{ [key: string]: any }"
-    URL: URL
-    Port: number
-    UUID: string
-
-generates:
-  src/graphql/generated/client/:
-    documents: './src/graphql/mothership/*.ts'
-    schema: 
-      '${MOTHERSHIP_GRAPHQL_LINK}':
-        headers:
-          origin: 'https://forums.unraid.net'
-    preset: client
-    presetConfig:
-      gqlTagName: graphql
-    config: 
-      useTypeImports: true
-      withObjectType: true
-    plugins:
-      - add: { content: '/* eslint-disable */' }
-  
-# Generate Types for the API Server
-  src/graphql/generated/api/types.ts:
-    schema: 
-      - './src/graphql/types.ts'
-      - './src/graphql/schema/types/**/*.graphql'
-    plugins:
-      - typescript
-      - typescript-resolvers
-      - add: { content: '/* eslint-disable */' }
-    config:
-      contextType: '@app/graphql/schema/utils#Context'
-      useIndexSignature: true
-# Generate Operations for any built in API Server Operations (ie report.ts)
-  src/graphql/generated/api/operations.ts:
-    documents: './src/graphql/client/api/*.ts'
-    schema: 
-      - './src/graphql/types.ts'
-      - './src/graphql/schema/types/**/*.graphql'
-    preset: import-types
-    presetConfig:
-      typesPath: '@app/graphql/generated/api/types'
-    plugins:
-      - typescript-validation-schema
-      - typescript-operations
-      - typed-document-node
-      - add: { content: '/* eslint-disable */' }
-    config:
-      importFrom: '@app/graphql/generated/api/types'
-      strictScalars: false
-      schema: 'zod'
-      withObjectType: true
-  src/graphql/generated/client/validators.ts:
-    schema: 
-      '${MOTHERSHIP_GRAPHQL_LINK}':
-        headers:
-          origin: 'https://forums.unraid.net'
-    plugins:
-      - typescript-validation-schema
-      - add: { content: '/* eslint-disable */'}
-    config:
-      importFrom: '@app/graphql/generated/client/graphql'
-      strictScalars: false
-      schema: 'zod'

api/commitlint.config.js

@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-conventional'] };

api/dev/Unraid.net/myservers.cfg

@@ -1,19 +1,20 @@
 [api]
-version="3.1.1+bf51f1f0"
+version="4.1.3"
+extraOrigins="https://google.com,https://test.com"
 [local]
-[notifier]
-apikey="unnotify_30994bfaccf839c65bae75f7fa12dd5ee16e69389f754c3b98ed7d5"
+sandbox="yes"
 [remote]
 wanaccess="yes"
 wanport="8443"
 upnpEnabled="no"
 apikey="_______________________BIG_API_KEY_HERE_________________________"
+localApiKey="_______________________LOCAL_API_KEY_HERE_________________________"
 email="test@example.com"
 username="zspearmint"
 avatar="https://via.placeholder.com/200"
 regWizTime="1611175408732_0951-1653-3509-FBA155FA23C0"
-idtoken=""
 accesstoken=""
+idtoken=""
 refreshtoken=""
-[upc]
-apikey="unupc_fab6ff6ffe51040595c6d9ffb63a353ba16cc2ad7d93f813a2e80a5810"
+dynamicRemoteAccessType="DISABLED"
+ssoSubIds=""

api/dev/data/permissions.json

@@ -1,191 +0,0 @@
-{
-  "admin": {
-    "extends": "user",
-    "permissions": [
-      {
-        "resource": "apikey",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "array",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "cpu",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "device",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "device/unassigned",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "disk",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "disk/settings",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "display",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "docker/container",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "docker/network",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "info",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "license-key",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "machine-id",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "memory",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "notifications",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "online",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "os",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "parity-history",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "permission",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "servers",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "service",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "service/emhttpd",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "service/unraid-api",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "services",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "share",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "software-versions",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "unraid-version",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "user",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "var",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "vars",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "vm/domain",
-        "action": "read:any",
-        "attributes": "*"
-      },
-      {
-        "resource": "vm/network",
-        "action": "read:any",
-        "attributes": "*"
-      }
-    ]
-  },
-  "user": {
-    "extends": "guest",
-    "permissions": [
-      {
-        "resource": "apikey",
-        "action": "read:own",
-        "attributes": "*"
-      },
-      {
-        "resource": "permission",
-        "action": "read:any",
-        "attributes": "*"
-      }
-    ]
-  },
-  "guest": {
-    "permissions": [
-      {
-        "resource": "welcome",
-        "action": "read:any",
-        "attributes": "*"
-      }
-    ]
-  }
-}

api/dev/dynamix/default.cfg

@@ -0,0 +1,80 @@
+[confirm]
+down="1"
+stop="1"
+[display]
+width=""
+font=""
+tty="15"
+date="%c"
+time="%R"
+number=".,"
+unit="C"
+scale="-1"
+resize="0"
+wwn="0"
+total="1"
+banner=""
+header=""
+background=""
+tabs="1"
+users="Tasks:3"
+usage="0"
+text="1"
+warning="70"
+critical="90"
+hot="45"
+max="55"
+hotssd="60"
+maxssd="70"
+power=""
+theme="white"
+locale=""
+raw=""
+rtl=""
+headermetacolor=""
+headerdescription="yes"
+showBannerGradient="yes"
+[parity]
+mode="0"
+hour="0 0"
+dotm="1"
+month="1"
+day="0"
+cron=""
+write="NOCORRECT"
+[notify]
+display="0"
+life="5"
+date="d-m-Y"
+time="H:i"
+position="top-right"
+path="/tmp/notifications"
+system="*/1 * * * *"
+entity="1"
+normal="1"
+warning="1"
+alert="1"
+unraid="1"
+plugin="1"
+docker_notify="1"
+language_notify="1"
+report="1"
+unraidos=""
+version=""
+docker_update=""
+language_update=""
+status=""
+[ssmtp]
+root=""
+RcptTo=""
+SetEmailPriority="True"
+Subject="Unraid Status: "
+server="smtp.gmail.com"
+port="465"
+UseTLS="YES"
+UseSTARTTLS="NO"
+UseTLSCert="NO"
+TLSCert=""
+AuthMethod="login"
+AuthUser=""
+AuthPass=""

api/dev/dynamix/dynamix.cfg

@@ -1,5 +1,6 @@
 [display]
 date="%c"
+time="%I:%M %p"
 number=".,"
 scale="-1"
 tabs="1"
@@ -31,5 +32,5 @@ display="0"
 date="d-m-Y"
 time="H:i"
 position="top-right"
-path="/app/dev/notifications"
+path="./dev/notifications"
 system="*/1 * * * *"

api/dev/keys/b5b4aa3d-8e40-4c92-bc40-d50182071886.json

@@ -0,0 +1,11 @@
+{
+  "createdAt": "2025-01-27T16:22:56.501Z",
+  "description": "API key for Connect user",
+  "id": "b5b4aa3d-8e40-4c92-bc40-d50182071886",
+  "key": "_______________________LOCAL_API_KEY_HERE_________________________",
+  "name": "Connect",
+  "permissions": [],
+  "roles": [
+    "connect"
+  ]
+}

api/dev/notifications/archive/Unraid_Parity_check_1683971161.notify

@@ -1,5 +0,0 @@
-timestamp=1683971161
-event=Unraid Parity check
-subject=Notice [UNRAID] - Parity check finished (0 errors)
-description=Canceled
-importance=warning

api/dev/notifications/unread/Unraid_Parity_check_1683971161.notify

@@ -3,3 +3,4 @@ event=Unraid Parity check
 subject=Notice [UNRAID] - Parity check finished (0 errors)
 description=Canceled
 importance=warning
+link=/

api/dev/sessions/sess_mockusersession

@@ -0,0 +1 @@
+unraid_login|i:1736523078;unraid_user|s:4:"root";locale|s:0:"";buildDate|s:8:"20241202";

api/dev/states/myservers.cfg

@@ -1,22 +1,24 @@
 [api]
-version="3.1.1+bf51f1f0"
+version="4.1.3"
+extraOrigins="https://google.com,https://test.com"
 [local]
-[notifier]
-apikey="unnotify_30994bfaccf839c65bae75f7fa12dd5ee16e69389f754c3b98ed7d5"
+sandbox="yes"
 [remote]
 wanaccess="yes"
 wanport="8443"
 upnpEnabled="no"
 apikey="_______________________BIG_API_KEY_HERE_________________________"
+localApiKey="_______________________LOCAL_API_KEY_HERE_________________________"
 email="test@example.com"
 username="zspearmint"
 avatar="https://via.placeholder.com/200"
 regWizTime="1611175408732_0951-1653-3509-FBA155FA23C0"
-idtoken=""
 accesstoken=""
+idtoken=""
 refreshtoken=""
-allowedOrigins="/var/run/unraid-notifications.sock, /var/run/unraid-php.sock, /var/run/unraid-cli.sock, http://localhost:8080, https://localhost:4443, https://tower.local:4443, https://192.168.1.150:4443, https://tower:4443, https://192-168-1-150.thisisfourtyrandomcharacters012345678900.myunraid.net:4443, https://85-121-123-122.thisisfourtyrandomcharacters012345678900.myunraid.net:8443, https://10-252-0-1.hash.myunraid.net:4443, https://10-252-1-1.hash.myunraid.net:4443, https://10-253-3-1.hash.myunraid.net:4443, https://10-253-4-1.hash.myunraid.net:4443, https://10-253-5-1.hash.myunraid.net:4443, https://connect.myunraid.net, https://staging.connect.myunraid.net, https://dev-my.myunraid.net:4000, https://studio.apollographql.com"
-[upc]
-apikey="unupc_fab6ff6ffe51040595c6d9ffb63a353ba16cc2ad7d93f813a2e80a5810"
+dynamicRemoteAccessType="DISABLED"
+ssoSubIds=""
+allowedOrigins="/var/run/unraid-notifications.sock, /var/run/unraid-php.sock, /var/run/unraid-cli.sock, http://localhost:8080, https://localhost:4443, https://tower.local:4443, https://192.168.1.150:4443, https://tower:4443, https://192-168-1-150.thisisfourtyrandomcharacters012345678900.myunraid.net:4443, https://85-121-123-122.thisisfourtyrandomcharacters012345678900.myunraid.net:8443, https://10-252-0-1.hash.myunraid.net:4443, https://10-252-1-1.hash.myunraid.net:4443, https://10-253-3-1.hash.myunraid.net:4443, https://10-253-4-1.hash.myunraid.net:4443, https://10-253-5-1.hash.myunraid.net:4443, https://10-100-0-1.hash.myunraid.net:4443, https://10-100-0-2.hash.myunraid.net:4443, https://10-123-1-2.hash.myunraid.net:4443, https://221-123-121-112.hash.myunraid.net:4443, https://google.com, https://test.com, https://connect.myunraid.net, https://connect-staging.myunraid.net, https://dev-my.myunraid.net:4000, https://studio.apollographql.com"
 [connectionStatus]
 minigraph="PRE_INIT"
+upnpStatus=""

api/dev/states/nginx.ini

@@ -0,0 +1,26 @@
+NGINX_LANIP="192.168.1.150"
+NGINX_LANIP6=""
+NGINX_LANNAME="Tower"
+NGINX_LANMDNS="Tower.local"
+NGINX_CERTPATH="/boot/config/ssl/certs/certificate_bundle.pem"
+NGINX_USESSL="yes"
+NGINX_PORT="8080"
+NGINX_PORTSSL="4443"
+NGINX_DEFAULTURL="https://Tower.local:4443"
+NGINX_CERTNAME="*.thisisfourtyrandomcharacters012345678900.myunraid.net"
+NGINX_LANFQDN="192-168-1-150.thisisfourtyrandomcharacters012345678900.myunraid.net"
+NGINX_LANFQDN6=""
+NGINX_WANACCESS=""
+NGINX_WANIP=""
+NGINX_WANIP6=""
+NGINX_WANFQDN="85-121-123-122.thisisfourtyrandomcharacters012345678900.myunraid.net"
+NGINX_WANFQDN6=""
+NGINX_WG0FQDN="10-252-0-1.hash.myunraid.net"
+NGINX_WG1FQDN="10-252-1-1.hash.myunraid.net"
+NGINX_WG3FQDN="10-253-3-1.hash.myunraid.net"
+NGINX_WG4FQDN="10-253-4-1.hash.myunraid.net"
+NGINX_WG55FQDN="10-253-5-1.hash.myunraid.net"
+NGINX_TAILSCALEFQDN="10-100-0-1.hash.myunraid.net"
+NGINX_TAILSCALE0FQDN="10-100-0-2.hash.myunraid.net"
+NGINX_CUSTOMFQDN="10-123-1-2.hash.myunraid.net"
+NGINX_CUSTOMFQDN6="221-123-121-112.hash.myunraid.net"

api/dev/states/var.ini

@@ -0,0 +1,143 @@
+version="6.11.2"
+MAX_ARRAYSZ="30"
+MAX_CACHESZ="30"
+NAME="Tower"
+timeZone="Australia/Adelaide"
+COMMENT="Dev Server"
+SECURITY="user"
+WORKGROUP="WORKGROUP"
+DOMAIN=""
+DOMAIN_SHORT=""
+hideDotFiles="no"
+localMaster="yes"
+enableFruit="no"
+USE_NETBIOS="yes"
+USE_WSD="no"
+WSD_OPT=""
+USE_NTP="yes"
+NTP_SERVER1="time1.google.com"
+NTP_SERVER2="time2.google.com"
+NTP_SERVER3="time3.google.com"
+NTP_SERVER4="time4.google.com"
+DOMAIN_LOGIN="Administrator"
+SYS_MODEL="Dell R710"
+SYS_ARRAY_SLOTS="24"
+SYS_FLASH_SLOTS="1"
+USE_SSL="auto"
+PORT="80"
+PORTSSL="443"
+LOCAL_TLD="local"
+BIND_MGT="no"
+USE_TELNET="yes"
+PORTTELNET="23"
+USE_SSH="yes"
+PORTSSH="22"
+USE_UPNP="yes"
+START_PAGE="Main"
+startArray="no"
+spindownDelay="0"
+spinupGroups="no"
+defaultFsType="xfs"
+shutdownTimeout="90"
+luksKeyfile="/tmp/unraid/keyfile"
+poll_attributes="1800"
+poll_attributes_default="1800"
+poll_attributes_status="default"
+queueDepth="auto"
+nr_requests="Auto"
+nr_requests_default="Auto"
+nr_requests_status="default"
+md_scheduler="auto"
+md_scheduler_default="auto"
+md_scheduler_status="default"
+md_num_stripes="1280"
+md_num_stripes_default="1280"
+md_num_stripes_status="default"
+md_queue_limit="80"
+md_queue_limit_default="80"
+md_queue_limit_status="default"
+md_sync_limit="5"
+md_sync_limit_default="5"
+md_sync_limit_status="default"
+md_write_method="auto"
+md_write_method_default="auto"
+md_write_method_status="default"
+shareDisk="yes"
+shareUser="e"
+shareUserInclude=""
+shareUserExclude=""
+shareSMBEnabled="yes"
+shareNFSEnabled="no"
+shareInitialOwner="Administrator"
+shareInitialGroup="Domain Users"
+shareCacheEnabled="yes"
+shareCacheFloor="2000000"
+shareMoverSchedule="40 3 * * *"
+shareMoverLogging="no"
+fuse_remember="330"
+fuse_remember_default="330"
+fuse_remember_status="default"
+fuse_directio="auto"
+fuse_directio_default="auto"
+fuse_directio_status="default"
+fuse_useino="yes"
+shareAvahiEnabled="yes"
+shareAvahiSMBName="%h"
+shareAvahiSMBModel="Xserve"
+shfs_logging="1"
+safeMode="no"
+startMode="Normal"
+configValid="yes"
+joinStatus="Not joined"
+deviceCount="4"
+flashGUID="0000-0000-0000-000000000000"
+flashProduct="DataTraveler_3.0"
+flashVendor="KINGSTON"
+regCheck=""
+regFILE="/app/dev/Unraid.net/Pro.key"
+regGUID="13FE-4200-C300-58C372A52B19"
+regTy="Pro"
+regTo="Eli Bosley"
+regTm="1833409182"
+regTm2="0"
+regExp=""
+regGen="0"
+sbName="/boot/config/super.dat"
+sbVersion="2.9.13"
+sbUpdated="1596079143"
+sbEvents="173"
+sbState="1"
+sbClean="yes"
+sbSynced="1586819259"
+sbSyncErrs="0"
+sbSynced2="1586822456"
+sbSyncExit="0"
+sbNumDisks="5"
+mdColor="green-blink"
+mdNumDisks="4"
+mdNumDisabled="1"
+mdNumInvalid="1"
+mdNumMissing="0"
+mdNumNew="0"
+mdNumErased="0"
+mdResync="0"
+mdResyncCorr="0"
+mdResyncPos="0"
+mdResyncDb="0"
+mdResyncDt="0"
+mdResyncAction="check P"
+mdResyncSize="438960096"
+mdState="STOPPED"
+mdVersion="2.9.14"
+fsState="Stopped"
+fsProgress="Autostart disabled"
+fsCopyPrcnt="0"
+fsNumMounted="0"
+fsNumUnmountable="0"
+fsUnmountableMask=""
+shareCount="0"
+shareSMBCount="1"
+shareNFSCount="0"
+shareMoverActive="no"
+reservedNames="parity,parity2,parity3,diskP,diskQ,diskR,disk,disks,flash,boot,user,user0,disk0,disk1,disk2,disk3,disk4,disk5,disk6,disk7,disk8,disk9,disk10,disk11,disk12,disk13,disk14,disk15,disk16,disk17,disk18,disk19,disk20,disk21,disk22,disk23,disk24,disk25,disk26,disk27,disk28,disk29,disk30,disk31"
+csrf_token="0000000000000000"

api/docker-compose.yml

@@ -1,68 +1,55 @@
-version: '3.8'
-
-x-volumes: &volumes
+x-common: &common
   volumes:
-  - ./dev:/app/dev
-  - ./src:/app/src
-  - ./patches:/app/patches
-  - ./package.json:/app/package.json
-  - ./package-lock.json:/app/package-lock.json
-  - ./tsconfig.json:/app/tsconfig.json
-  - ./tsup.config.ts:/app/tsup.config.ts
-  - ./vite.config.ts:/app/vite.config.ts
-  - ./dist/:/app/dist/
-  - ./deploy/:/app/deploy/
-  - ./README.md:/app/README.md
-  - ./scripts/:/app/scripts/
-  - ../.git/:/app/.git/
-  - ./.env.production:/app/.env.production
-  - ./.env.staging:/app/.env.staging
-  - ./.env.test:/app/.env.test
-  - ./.env.development:/app/.env.development
-  - ./.pkg-cache:/app/.pkg-cache
-  - ./codegen.yml:/app/codegen.yml
-  - ./fix-array-type.cjs:/app/fix-array-type.cjs
-  - /var/run/docker.sock:/var/run/docker.sock
+    - ./:/app
+    - pnpm-store:/pnpm/store
+    - ../libvirt:/libvirt
+  environment:
+    - IS_DOCKER=true
+    - GIT_SHA=${GIT_SHA:-unknown}
+    - IS_TAGGED=${IS_TAGGED:-false}
 
-
-networks:
-  mothership_default:
-    external: true
 services:
 
   dev:
-    networks:
-      - mothership_default
-    image: unraid-api-node-18
+    image: unraid-api:development
     ports:
       - "3001:3001"
     build: 
       context: .
+      target: development
       dockerfile: Dockerfile
-      args: 
-        NODE_IMAGE: node:18.5
-        NODE_ENV: development
-        NPM_I_CMD: npm i
-    <<: *volumes
+    <<: *common
     stdin_open: true
     tty: true
     entrypoint: /bin/bash
-    environment: 
-      - IS_DOCKER=true
     profiles:
       - builder
 
-
-  builder:
-    image: unraid-api-node-18
+  local:
+    image: unraid-api:development
+    ports:
+      - "3001:3001"
     build: 
       context: .
+      target: development
       dockerfile: Dockerfile
-      args: 
-        NODE_IMAGE: node:18.5
-        NODE_ENV: development
-        NPM_I_CMD: npm i
-    <<: *volumes
-    platform: linux/amd64
+    <<: *common
+    command: npm run start:dev
     profiles:
-      - builder
+      - builder
+
+  builder:
+    image: unraid-api:builder
+    build: 
+      context: .
+      target: builder
+      dockerfile: Dockerfile
+    <<: *common
+    profiles:
+      - builder
+
+volumes:
+  pnpm-store:
+    name: "pnpm-store"
+  pnpm-cache:
+    name: "pnpm-cache"

api/docs/developer/development.md

@@ -0,0 +1,116 @@
+# Development
+
+## Installation
+
+Manual install of the staging and production plugins can be done with the following routes:
+[production](https://stable.dl.unraid.net/unraid-api/dynamix.unraid.net.plg)
+[staging](https://preview.dl.unraid.net/unraid-api/dynamix.unraid.net.staging.plg)
+
+## Connecting to the API
+
+### HTTP
+
+This can be accessed by default via `http://tower.local/graphql`.
+
+See <https://graphql.org/learn/serving-over-http/#http-methods-headers-and-body>
+
+## Building in Docker
+
+To get a development environment for testing start by running this docker command:
+
+`npm run build:docker`
+`npm run start:ddev`
+
+which will give you an interactive shell inside of the newly build linux container.
+
+To automatically build the plugin run the command below:
+
+`npm run build:docker`
+
+The builder command will build the plugin into deploy/release, and the interactive plugin lets you build the plugin or install node modules how you like.
+
+## Logs
+
+Logging can be configured via environment variables.
+
+Log levels can be set when the api starts via `LOG_LEVEL=all/trace/debug/info/warn/error/fatal/mark/off`.
+
+Additional detail for the log entry can be added with `LOG_CONTEXT=true` (warning, generates a lot of data).
+
+By default, logs will be sent to syslog. Or you can set `LOG_TRANSPORT=file` to have logs saved in `/var/log/unraid-api/stdout.log`. Or enable debug mode to view logs inline.
+
+Examples:
+
+- `unraid-api start`
+- `LOG_LEVEL=debug unraid-api start --debug`
+- `LOG_LEVEL=trace LOG_CONTEXT=true LOG_TRANSPORT=file unraid-api start`
+
+## Viewing data sent to mothership
+
+If the environment variable `LOG_MOTHERSHIP_MESSAGES=true` exists, any data the unraid-api sends to mothership will be saved in clear text here: `/var/log/unraid-api/relay-messages.log`
+
+Examples:
+
+- `LOG_MOTHERSHIP_MESSAGES=true unraid-api start`
+- `LOG_MOTHERSHIP_MESSAGES=true LOG_LEVEL=debug unraid-api start --debug`
+
+## Debug Logging
+
+To view debug logs, change the log level when starting the API. Then type unraid-api logs to trail the logs.
+Examples:
+
+- `LOG_LEVEL=debug unraid-api start`
+- `unraid-api logs`
+
+## Switching between staging and production environments
+
+1. Stop the api: `unraid-api stop`
+2. Switch environments: `unraid-api switch-env`
+3. Start the api: `unraid-api start`
+4. Confirm the environment: `unraid-api report`
+
+## Playground
+
+The playground can be access via `http://tower.local/graphql` while in debug mode.  
+To get your API key open a terminal on your server and run `cat /boot/config/plugins/dynamix.my.servers/myservers.cfg | grep apikey=\"unraid | cut -d '"' -f2`. Add that API key in the "HTTP headers" panel of the playground.
+
+```json
+{
+    "x-api-key": "__REPLACE_ME_WITH_API_KEY__"
+}
+```
+
+Next add the query you want to run and hit the play icon.
+
+```gql
+query welcome {
+    welcome {
+        message
+    }
+}
+```
+
+You should get something like this back.
+
+```json
+{
+    "data": {
+        "welcome": {
+            "message": "Welcome root to this Unraid 6.10.0 server"
+        }
+    }
+}
+```
+
+Click the "Schema" and "Docs" button on the right side of the playground to learn more.
+
+## Create a new release
+
+To create a new version run `npm run release` and then run **ONLY** the `git push` section of the commands it returns.
+To create a new prerelease run `npm run release -- --prerelease alpha`.
+
+Pushing to this repo will cause an automatic "rolling" release to be built which can be accessed via the page for the associated Github action run.
+
+## Using a custom version (e.g. testing a new release)
+
+Find the Pull Request you'd like to install, and a link will be present as a comment to install a PR-specific version.

api/docs/developer/repo-organization.md

@@ -0,0 +1,82 @@
+# Repository Organization
+
+This document describes the high-level architecture of the Unraid API repository.
+
+## Overview
+
+The repository consists of:
+
+- API Server (NestJS)
+- Redux Store
+- Core Modules
+- Tests
+
+## API Server Architecture
+
+The API server is built with NestJS and provides the core functionality for interacting with Unraid systems.
+
+### Key Components
+
+- `src/unraid-api/` - Core NestJS implementation
+- `src/core/` - Legacy business logic and utilities
+- `src/store/` - Redux store and state management
+- `src/common/` - Shared utilities and types
+
+## Redux Store
+
+The store manages application state through several modules:
+
+### Store Modules
+
+- `config` - User settings, authentication, and API configuration
+- `emhttp` - Unraid system and array state
+- `registration` - License management
+- `cache` - Application caching
+- `docker` - Container management
+- `upnp` - UPnP functionality
+- `dynamix` - Plugin state
+- `minigraph` - Mothership connectivity
+- `notifications` - System notifications
+
+### Store Listeners
+
+Key listeners that handle side effects:
+
+- Array state changes
+- Configuration updates
+- Remote access changes
+- Server state updates
+- UPnP changes
+- WAN access changes
+
+### Store Synchronization
+
+The store syncs data in two ways:
+
+- Flash Storage - Persistent configuration
+- Memory Storage - Runtime state
+
+## Project Structure
+
+The repository is organized into several packages:
+
+- `api/` - NestJS API server
+- `plugin/` - Unraid plugin package
+- `web/` - Frontend application
+- `unraid-ui/` - Shared UI components
+
+## Development Flow
+
+New development should focus on the NestJS implementation in `src/unraid-api/`:
+
+1. Create new features in `src/unraid-api/` using NestJS patterns
+2. Use dependency injection and NestJS modules
+3. Legacy code in `src/core/` should be gradually migrated
+4. State management still uses Redux store when needed
+
+## Best Practices
+
+1. Follow NestJS architectural patterns
+2. Use TypeScript decorators and strong typing
+3. Implement proper dependency injection
+4. Write unit tests for new services

api/docs/developer/workflows.md

@@ -0,0 +1,219 @@
+# Unraid API Development Workflows
+
+This document outlines the various workflow styles available for developing, building, and deploying the Unraid API monorepo.
+
+## Repository Structure
+
+The Unraid API monorepo consists of several packages:
+
+- `api`: The Unraid API backend
+- `web`: The web frontend components
+- `plugin`: The Unraid plugin
+- `unraid-ui`: UI components library
+
+## Development Workflows
+
+### Local Development
+
+To start all development servers in the monorepo:
+
+```bash
+pnpm dev
+```
+
+This command runs all development servers concurrently:
+
+- API server: <http://localhost:3001>
+- Web components: <http://localhost:4321>
+- UI components: <http://localhost:5173>
+
+### Package-Specific Development
+
+If you want to work on a specific package, you can run its development server individually:
+
+#### API Development
+
+```bash
+cd api
+pnpm dev
+```
+
+#### Web Development
+
+```bash
+cd web
+pnpm dev
+```
+
+#### UI Component Development
+
+```bash
+cd unraid-ui
+pnpm dev
+```
+
+## Building Workflows
+
+### Building All Packages
+
+To build all packages in the monorepo:
+
+```bash
+pnpm build
+```
+
+### Watch Mode Building
+
+For continuous building during development:
+
+```bash
+pnpm build:watch
+```
+
+This is useful when you want to see your changes reflected without manually rebuilding. This will also allow you to install a local plugin to test your changes.
+
+### Package-Specific Building
+
+#### API Building
+
+```bash
+cd api
+pnpm build
+```
+
+#### Web Building
+
+```bash
+cd web
+pnpm build
+```
+
+#### Development Build for Web
+
+```bash
+cd web
+pnpm build:dev
+```
+
+## Deployment Workflows
+
+### Deploying to Development Unraid Server
+
+To deploy to a development Unraid server:
+
+```bash
+pnpm unraid:deploy <SERVER_IP>
+```
+
+This command builds and deploys all components to the specified Unraid server.
+
+### Package-Specific Deployment
+
+#### API Deployment
+
+```bash
+cd api
+pnpm unraid:deploy <SERVER_IP>
+```
+
+#### Web Deployment
+
+```bash
+cd web
+pnpm unraid:deploy <SERVER_IP>
+```
+
+#### Plugin Deployment
+
+```bash
+cd plugin
+pnpm unraid:deploy <SERVER_IP>
+```
+
+## Testing
+
+To run tests across all packages:
+
+```bash
+pnpm test
+```
+
+### Package-Specific Testing
+
+```bash
+cd <package-directory>
+pnpm test
+```
+
+## Code Quality Workflows
+
+### Linting
+
+To lint all packages:
+
+```bash
+pnpm lint
+```
+
+To automatically fix linting issues:
+
+```bash
+pnpm lint:fix
+```
+
+### Type Checking
+
+To run type checking across all packages:
+
+```bash
+pnpm type-check
+```
+
+## GraphQL Codegen Workflows
+
+For packages that use GraphQL, you can generate types from your schema:
+
+```bash
+cd <package-directory>
+pnpm codegen
+```
+
+To watch for changes and regenerate types:
+
+```bash
+cd <package-directory>
+pnpm codegen:watch
+```
+
+## Docker Workflows
+
+The API package supports Docker-based development:
+
+```bash
+cd api
+pnpm container:build    # Build the Docker container
+pnpm container:start    # Start the container
+pnpm container:stop     # Stop the container
+pnpm container:enter    # Enter the container shell
+pnpm container:test     # Run tests in the container
+```
+
+## CLI Commands
+
+When working with a deployed Unraid API, you can use the CLI:
+
+```bash
+unraid-api --help
+```
+
+## Recommended Workflow for New Developers
+
+1. Clone the repository: `git clone git@github.com:unraid/api.git`
+2. Set up the monorepo: `just setup` or `pnpm install`
+3. Start development servers: `pnpm dev`
+4. Make your changes
+5. Test your changes: `pnpm test`
+6. Deploy to a development server: `pnpm unraid:deploy <SERVER_IP>`
+7. Verify your changes on the Unraid server
+
+If using nix, run `nix develop` from the root of the repo before Step 2.

api/docs/public/_category_.json

@@ -0,0 +1,4 @@
+{
+    "label": "Unraid API",
+    "position": 4
+}

api/docs/public/cli.md

@@ -0,0 +1,162 @@
+# CLI Commands
+
+### Start
+
+```bash
+unraid-api start [--log-level <level>]
+```
+
+Starts the Unraid API service.
+
+Options:
+- `--log-level`: Set logging level (trace|debug|info|warn|error)
+
+### Stop
+
+```bash
+unraid-api stop [--delete]
+```
+
+Stops the Unraid API service.
+
+- `--delete`: Optional. Delete the PM2 home directory
+
+### Restart
+
+```bash
+unraid-api restart
+```
+
+Restarts the Unraid API service.
+
+### Logs
+
+```bash
+unraid-api logs [-l <lines>]
+```
+
+View the API logs.
+
+- `-l, --lines`: Optional. Number of lines to tail (default: 100)
+
+## Configuration Commands
+
+### Config
+
+```bash
+unraid-api config
+```
+
+Displays current configuration values.
+
+### Switch Environment
+
+```bash
+unraid-api switch-env [-e <environment>]
+```
+
+Switch between production and staging environments.
+
+- `-e, --environment`: Optional. Target environment (production|staging)
+
+### Developer Mode
+
+```bash
+unraid-api developer
+```
+
+Configure developer features for the API (e.g., GraphQL sandbox).
+
+## API Key Management
+
+### API Key Commands
+
+```bash
+unraid-api apikey [options]
+```
+
+Create and manage API keys.
+
+Options:
+
+- `--name <name>`: Name of the key
+- `--create`: Create a new key
+- `-r, --roles <roles>`: Comma-separated list of roles
+- `-p, --permissions <permissions>`: Comma-separated list of permissions
+- `-d, --description <description>`: Description for the key
+
+## SSO (Single Sign-On) Management
+
+### SSO Base Command
+
+```bash
+unraid-api sso
+```
+
+#### Add SSO User
+
+```bash
+unraid-api sso add-user
+# or
+unraid-api sso add
+# or
+unraid-api sso a
+```
+
+Add a new user for SSO authentication.
+
+#### Remove SSO User
+
+```bash
+unraid-api sso remove-user
+# or
+unraid-api sso remove
+# or
+unraid-api sso r
+```
+
+Remove a user (or all users) from SSO.
+
+#### List SSO Users
+
+```bash
+unraid-api sso list-users
+# or
+unraid-api sso list
+# or
+unraid-api sso l
+```
+
+List all configured SSO users.
+
+#### Validate SSO Token
+
+```bash
+unraid-api sso validate-token <token>
+# or
+unraid-api sso validate
+# or
+unraid-api sso v
+```
+
+Validates an SSO token and returns its status.
+
+## Report Generation
+
+### Generate Report
+
+```bash
+unraid-api report [-r] [-j]
+```
+
+Generate a system report.
+
+- `-r, --raw`: Display raw command output
+- `-j, --json`: Display output in JSON format
+
+## Notes
+
+1. Most commands require appropriate permissions to modify system state
+2. Some commands require the API to be running or stopped
+3. Store API keys securely as they provide system access
+4. SSO configuration changes may require a service restart

api/docs/public/how-to-use-the-api.md

@@ -0,0 +1,202 @@
+# Using the Unraid API
+
+The Unraid API provides a GraphQL interface that allows you to interact with your Unraid server. This guide will help you get started with exploring and using the API.
+
+## Enabling the GraphQL Sandbox
+
+1. First, enable developer mode using the CLI:
+
+    ```bash
+    unraid-api developer
+    ```
+
+2. Follow the prompts to enable the sandbox. This will allow you to access the Apollo Sandbox interface.
+
+3. Access the GraphQL playground by navigating to:
+
+    ```txt
+    http://YOUR_SERVER_IP/graphql
+    ```
+
+## Authentication
+
+Most queries and mutations require authentication. You can authenticate using either:
+
+1. API Keys
+2. Cookies (default method when signed into the WebGUI)
+
+### Creating an API Key
+
+Use the CLI to create an API key:
+
+```bash
+unraid-api apikey --create
+```
+
+Follow the prompts to set:
+
+- Name
+- Description
+- Roles
+- Permissions
+
+The generated API key should be included in your GraphQL requests as a header:
+
+```json
+{
+    "x-api-key": "YOUR_API_KEY"
+}
+```
+
+## Available Schemas
+
+The API provides access to various aspects of your Unraid server:
+
+### System Information
+
+- Query system details including CPU, memory, and OS information
+- Monitor system status and health
+- Access baseboard and hardware information
+
+### Array Management
+
+- Query array status and configuration
+- Manage array operations (start/stop)
+- Monitor disk status and health
+- Perform parity checks
+
+### Docker Management
+
+- List and manage Docker containers
+- Monitor container status
+- Manage Docker networks
+
+### Remote Access
+
+- Configure and manage remote access settings
+- Handle SSO configuration
+- Manage allowed origins
+
+### Example Queries
+
+1. Check System Status:
+
+```graphql
+query {
+    info {
+        os {
+            platform
+            distro
+            release
+            uptime
+        }
+        cpu {
+            manufacturer
+            brand
+            cores
+            threads
+        }
+    }
+}
+```
+
+2. Monitor Array Status:
+
+```graphql
+query {
+    array {
+        state
+        capacity {
+            disks {
+                free
+                used
+                total
+            }
+        }
+        disks {
+            name
+            size
+            status
+            temp
+        }
+    }
+}
+```
+
+3. List Docker Containers:
+
+```graphql
+query {
+    dockerContainers {
+        id
+        names
+        state
+        status
+        autoStart
+    }
+}
+```
+
+## Schema Types
+
+The API includes several core types:
+
+### Base Types
+
+- `Node`: Interface for objects with unique IDs - please see [Object Identification](https://graphql.org/learn/global-object-identification/)
+- `JSON`: For complex JSON data
+- `DateTime`: For timestamp values
+- `Long`: For 64-bit integers
+
+### Resource Types
+
+- `Array`: Array and disk management
+- `Docker`: Container and network management
+- `Info`: System information
+- `Config`: Server configuration
+- `Connect`: Remote access settings
+
+### Role-Based Access
+
+Available roles:
+
+- `admin`: Full access
+- `connect`: Remote access features
+- `guest`: Limited read access
+
+## Best Practices
+
+1. Use the Apollo Sandbox to explore the schema and test queries
+2. Start with small queries and gradually add fields as needed
+3. Monitor your query complexity to maintain performance
+4. Use appropriate roles and permissions for your API keys
+5. Keep your API keys secure and rotate them periodically
+
+## Rate Limiting
+
+The API implements rate limiting to prevent abuse. Ensure your applications handle rate limit responses appropriately.
+
+## Error Handling
+
+The API returns standard GraphQL errors in the following format:
+
+```json
+{
+  "errors": [
+    {
+      "message": "Error description",
+      "locations": [...],
+      "path": [...]
+    }
+  ]
+}
+```
+
+## Additional Resources
+
+- Use the Apollo Sandbox's schema explorer to browse all available types and fields
+- Check the documentation tab in Apollo Sandbox for detailed field descriptions
+- Monitor the API's health using `unraid-api status`
+- Generate reports using `unraid-api report` for troubleshooting
+
+For more information about specific commands and configuration options, refer to the CLI documentation or run `unraid-api --help`.

api/docs/public/index.md

@@ -0,0 +1,37 @@
+# Unraid API
+
+The Unraid API provides a GraphQL interface for programmatic interaction with your Unraid server. It enables automation, monitoring, and integration capabilities.
+
+## Current Availability
+
+The API is available through the Unraid Connect Plugin:
+
+1. Install Unraid Connect Plugin from Apps
+2. [Configure the plugin](./how-to-use-the-api.md#enabling-the-graphql-sandbox)
+3. Access API functionality through the [GraphQL Sandbox](./how-to-use-the-api.md#accessing-the-graphql-sandbox)
+
+## Future Availability
+
+The API will be integrated directly into the Unraid operating system in an upcoming OS release. This integration will:
+
+- Make the API a core part of the Unraid system
+- Remove the need for separate plugin installation
+- Enable deeper system integration capabilities
+
+## Documentation Sections
+
+- [CLI Commands](./cli.md) - Reference for all available command-line interface commands
+- [Using the Unraid API](./how-to-use-the-api.md) - Comprehensive guide on using the GraphQL API
+- [Upcoming Features](./upcoming-features.md) - Roadmap of planned features and improvements
+
+## Key Features
+
+The API provides:
+
+- GraphQL Interface: Modern, flexible API with strong typing
+- Authentication: Secure access via API keys or session cookies
+- Comprehensive Coverage: Access to system information, array management, and Docker operations
+- Developer Tools: Built-in GraphQL sandbox for testing
+- Role-Based Access: Granular permission control
+
+For detailed usage instructions, see [CLI Commands](./cli.md).

api/docs/public/upcoming-features.md

@@ -0,0 +1,71 @@
+# Upcoming Features
+
+Note: This roadmap outlines planned features and improvements for the Unraid API. Features and timelines may change based on development priorities and community feedback.
+
+## Core Infrastructure
+
+| Feature | Status | Tag |
+|---------|--------|-----|
+| API Development Environment Improvements | Done | v4.0.0 |
+| Include API in Unraid OS | Planned (Q1 2025) | - |
+| Make API Open Source | Planned (Q1 2025) | - |
+| Separate API from Connect Plugin | Planned (Q2 2025) | - |
+| Developer Tools for Plugins | Planned (Q2 2025) | - |
+
+## Security & Authentication
+
+| Feature | Status | Tag |
+|---------|--------|-----|
+| Permissions System Rewrite | Done | v4.0.0 |
+| User Interface Component Library | In Progress | - |
+
+## User Interface Improvements
+
+| Feature | Status | Tag |
+|---------|--------|-----|
+| New Settings Pages | Planned (Q2 2025) | - |
+| Custom Theme Creator | Planned (Q2-Q3 2025) | - |
+| New Connect Settings Interface | Planned (Q1 2025) | - |
+
+## Array Management
+
+| Feature | Status | Tag |
+|---------|--------|-----|
+| Array Status Monitoring | Done | v4.0.0 |
+| Storage Pool Creation Interface | Planned (Q2 2025) | - |
+| Storage Pool Status Interface | Planned (Q2 2025) | - |
+
+## Docker Integration
+
+| Feature | Status | Tag |
+|---------|--------|-----|
+| Docker Container Status Monitoring | Done | v4.0.0 |
+| New Docker Status Interface Design | Planned (Q3 2025) | - |
+| New Docker Status Interface | Planned (Q3 2025) | - |
+| Docker Container Setup Interface | Planned (Q3 2025) | - |
+| Docker Compose Support | Planned | - |
+
+## Share Management
+
+| Feature | Status | Tag |
+|---------|--------|-----|
+| Array/Cache Share Status Monitoring | Done | v4.0.0 |
+| Storage Share Creation & Settings | Planned | - |
+| Storage Share Management Interface | Planned | - |
+
+## Plugin System
+
+| Feature | Status | Tag |
+|---------|--------|-----|
+| New Plugins Interface | Planned (Q3 2025) | - |
+| Plugin Management Interface | Planned | - |
+| Plugin Development Tools | Planned | - |
+
+## Notifications
+
+| Feature | Status | Tag |
+|---------|--------|-----|
+| Notifications System | Done | v4.0.0 |
+| Notifications Interface | Done | v4.0.0 |
+
+Features marked as "Done" are available in current releases. The tag column shows the version where a feature was first introduced.

api/ecosystem.config.json

@@ -0,0 +1,20 @@
+{
+    "$schema": "https://json.schemastore.org/pm2-ecosystem",
+    "apps": [
+        {
+            "name": "unraid-api",
+            "script": "./dist/main.js",
+            "cwd": "/usr/local/unraid-api",
+            "exec_mode": "fork",
+            "wait_ready": true,
+            "listen_timeout": 15000,
+            "max_restarts": 10,
+            "min_uptime": 10000,
+            "watch": false,
+            "interpreter": "/usr/local/node/bin/node",
+            "ignore_watch": ["node_modules", "src", ".env.*", "myservers.cfg"],
+            "log_file": "/var/log/graphql-api.log",
+            "kill_timeout": 10000
+        }
+    ]
+}

api/fix-array-type.cjs

@@ -0,0 +1,18 @@
+/**
+ * This function wraps constant case, that turns any string into CONSTANT_CASE
+ * However, this function has a bug that, if you pass _ to it it will return an empty
+ * string. This small module fixes that
+ *
+ * @param {string*} str
+ * @return {string}
+ */
+function FixArrayType(str) {
+    if (str === 'Array') {
+        return 'ArrayType';
+    }
+
+    // If result is an empty string, just return the original string
+    return str;
+}
+
+module.exports = FixArrayType;

api/justfile

@@ -0,0 +1,16 @@
+set fallback
+
+default:
+    @just --list --justfile {{justfile()}} --list-heading $'\nAPI project recipes:\n'
+    @just list-commands
+
+# builds js files that can run on an unraid server
+@build:
+    pnpm run build
+
+# deploys to an unraid server
+@deploy remote:
+    ./scripts/deploy-dev.sh {{remote}}
+
+alias b := build
+alias d := deploy

api/package.json

@@ -1,204 +1,205 @@
 {
-  "name": "@unraid/api",
-  "version": "3.1.1",
-  "main": "dist/index.js",
-  "bin": "dist/unraid-api.cjs",
-  "type": "module",
-  "repository": "git@github.com:unraid/api.git",
-  "author": "Alexis Tyler <xo@wvvw.me> (https://wvvw.me/)",
-  "license": "UNLICENSED",
-  "engines": {
-    "node": ">=16.5.0"
-  },
-  "pkg": {
-    "assets": [
-      "dist/index.cjs",
-      "node_modules/segfault-handler",
-      "node_modules/@vmngr/libvirt/build/Release",
-      "node_modules/ts-invariant/",
-      "src/**/*.graphql"
-    ],
-    "targets": [
-      "node18-linux-x64"
-    ],
-    "outputPath": "dist"
-  },
-  "scripts": {
-    "compile": "tsup --config ./tsup.config.ts",
-    "bundle": "pkg . --public",
-    "build": "npm run compile && npm run bundle",
-    "build:docker": "docker-compose run --rm builder",
-    "build-pkg": "./scripts/build.mjs",
-    "codegen": "MOTHERSHIP_GRAPHQL_LINK='https://staging.mothership.unraid.net/ws' graphql-codegen --config codegen.yml -r dotenv/config './.env.staging'",
-    "codegen:watch": "DOTENV_CONFIG_PATH='./.env.staging' graphql-codegen-esm --config codegen.yml --watch -r dotenv/config",
-    "codegen:local": "MOTHERSHIP_GRAPHQL_LINK='http://localhost:3000/graphql' graphql-codegen-esm --config codegen.yml --watch",
-    "tsc": "tsc --noEmit",
-    "lint": "DEBUG=eslint:cli-engine eslint . --config .eslintrc.cjs",
-    "lint:fix": "DEBUG=eslint:cli-engine eslint . --fix --config .eslintrc.cjs",
-    "test:watch": "vitest --segfault-retry=3 --no-threads",
-    "test": "vitest run --segfault-retry=3 --no-threads",
-    "coverage": "vitest run --coverage",
-    "patch:subscriptions-transport-ws": "node ./.scripts/patches/subscriptions-transport-ws.cjs",
-    "release": "standard-version",
-    "typesync": "typesync",
-    "install:unraid": "./scripts/install-in-unraid.sh",
-    "start:plugin": "LOG_MOTHERSHIP_MESSAGES=true LOG_TYPE=pretty LOG_LEVEL=trace unraid-api start --debug",
-    "start:plugin-verbose": "LOG_CONTEXT=true LOG_MOTHERSHIP_MESSAGES=true LOG_TYPE=pretty LOG_LEVEL=trace unraid-api start --debug",
-    "start:dev": "LOG_MOTHERSHIP_MESSAGES=true LOG_TYPE=pretty NODE_ENV=development LOG_LEVEL=trace NODE_ENV=development tsup --config ./tsup.config.ts --watch --onSuccess 'DOTENV_CONFIG_PATH=./.env.development node -r dotenv/config dist/unraid-api.cjs start --debug'",
-    "stop:dev": "LOG_MOTHERSHIP_MESSAGES=true LOG_TYPE=pretty NODE_ENV=development LOG_LEVEL=trace NODE_ENV=development tsup --config ./tsup.config.ts --watch --onSuccess 'DOTENV_CONFIG_PATH=./.env.development node -r dotenv/config dist/unraid-api.cjs stop --debug'",
-    "start:report": "LOG_MOTHERSHIP_MESSAGES=true LOG_TYPE=pretty NODE_ENV=development LOG_LEVEL=trace NODE_ENV=development LOG_CONTEXT=true tsup --config ./tsup.config.ts --watch --onSuccess 'DOTENV_CONFIG_PATH=./.env.development node -r dotenv/config dist/unraid-api.cjs report --debug'",
-    "start:docker": "docker compose run --rm builder-interactive",
-    "docker:dev": "docker-compose run --rm --service-ports dev"
-  },
-  "files": [
-    ".env.staging",
-    ".env.production",
-    "dist",
-    "unraid-api"
-  ],
-  "dependencies": {
-    "@apollo/client": "^3.7.12",
-    "@apollo/server": "^4.6.0",
-    "@graphql-codegen/client-preset": "^3.0.0",
-    "@graphql-tools/load-files": "^6.6.1",
-    "@graphql-tools/merge": "^8.4.0",
-    "@graphql-tools/schema": "^9.0.17",
-    "@graphql-tools/utils": "^9.2.1",
-    "@reduxjs/toolkit": "^1.9.5",
-    "@reflet/cron": "^1.3.1",
-    "@runonflux/nat-upnp": "^1.0.2",
-    "accesscontrol": "^2.2.1",
-    "am": "github:unraid/am",
-    "async-exit-hook": "^2.0.1",
-    "btoa": "^1.2.1",
-    "bycontract": "^2.0.11",
-    "bytes": "^3.1.2",
-    "cacheable-lookup": "^6.1.0",
-    "catch-exit": "^1.2.2",
-    "chalk": "^4.1.2",
-    "chokidar": "^3.5.3",
-    "cli-table": "^0.3.11",
-    "command-exists": "^1.2.9",
-    "convert": "^4.10.0",
-    "cors": "^2.8.5",
-    "cross-fetch": "^3.1.5",
-    "docker-event-emitter": "^0.3.0",
-    "dockerode": "^3.3.5",
-    "dotenv": "^16.0.3",
-    "express": "^4.18.2",
-    "find-process": "^1.4.7",
-    "graphql": "^16.6.0",
-    "graphql-fields": "^2.0.3",
-    "graphql-scalars": "^1.21.3",
-    "graphql-subscriptions": "^2.0.0",
-    "graphql-tag": "^2.12.6",
-    "graphql-type-json": "^0.3.2",
-    "graphql-type-uuid": "^0.2.0",
-    "graphql-ws": "^5.12.1",
-    "htpasswd-js": "^1.0.2",
-    "ini": "^4.1.0",
-    "ip": "^1.1.8",
-    "jose": "^4.14.2",
-    "launchdarkly-eventsource": "^1.4.4",
-    "lodash": "^4.17.21",
-    "multi-ini": "^2.2.0",
-    "mustache": "^4.2.0",
-    "nanobus": "^4.5.0",
-    "node-cache": "^5.1.2",
-    "node-window-polyfill": "^1.0.2",
-    "openid-client": "^5.4.0",
-    "p-iteration": "^1.1.8",
-    "p-retry": "^4.6.2",
-    "pidusage": "^3.0.2",
-    "reflect-metadata": "^0.1.13",
-    "request": "^2.88.2",
-    "segfault-handler": "^1.3.0",
-    "semver": "^7.4.0",
-    "stoppable": "^1.1.0",
-    "subscriptions-transport-ws": "^0.11.0",
-    "systeminformation": "^5.17.12",
-    "ts-command-line-args": "^2.5.0",
-    "uuid": "^9.0.0",
-    "ws": "^8.13.0",
-    "wtfnode": "^0.9.1",
-    "xhr2": "^0.2.1",
-    "zod": "^3.21.4"
-  },
-  "devDependencies": {
-    "@babel/runtime": "^7.21.0",
-    "@graphql-codegen/add": "^4.0.1",
-    "@graphql-codegen/cli": "^3.3.0",
-    "@graphql-codegen/fragment-matcher": "^4.0.1",
-    "@graphql-codegen/import-types-preset": "^2.2.6",
-    "@graphql-codegen/typed-document-node": "^4.0.0",
-    "@graphql-codegen/typescript": "^3.0.3",
-    "@graphql-codegen/typescript-operations": "^3.0.3",
-    "@graphql-codegen/typescript-resolvers": "3.2.0",
-    "@graphql-typed-document-node/core": "^3.2.0",
-    "@swc/core": "^1.3.49",
-    "@types/async-exit-hook": "^2.0.0",
-    "@types/btoa": "^1.2.3",
-    "@types/bytes": "^3.1.1",
-    "@types/cli-table": "^0.3.1",
-    "@types/command-exists": "^1.2.0",
-    "@types/dockerode": "^3.3.16",
-    "@types/express": "^4.17.17",
-    "@types/graphql-fields": "^1.3.5",
-    "@types/graphql-type-uuid": "^0.2.3",
-    "@types/ini": "^1.3.31",
-    "@types/lodash": "^4.14.192",
-    "@types/mustache": "^4.2.2",
-    "@types/node": "^18.15.11",
-    "@types/pidusage": "^2.0.2",
-    "@types/pify": "^5.0.1",
-    "@types/semver": "^7.3.13",
-    "@types/sendmail": "^1.4.4",
-    "@types/stoppable": "^1.1.1",
-    "@types/uuid": "^9.0.1",
-    "@types/ws": "^8.5.4",
-    "@types/wtfnode": "^0.7.0",
-    "@typescript-eslint/eslint-plugin": "^5.58.0",
-    "@typescript-eslint/parser": "^5.58.0",
-    "@unraid/eslint-config": "github:unraid/eslint-config",
-    "@vitest/coverage-c8": "^0.30.1",
-    "@vitest/ui": "^0.30.1",
-    "camelcase-keys": "^8.0.2",
-    "cz-conventional-changelog": "3.3.0",
-    "eslint": "^8.38.0",
-    "eslint-import-resolver-typescript": "^3.5.5",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-unicorn": "^46.0.0",
-    "eslint-plugin-unused-imports": "^2.0.0",
-    "execa": "^7.1.1",
-    "filter-obj": "^5.1.0",
-    "got": "^12.6.0",
-    "graphql-codegen-typescript-validation-schema": "^0.7.1",
-    "ip-regex": "^5.0.0",
-    "json-difference": "^1.9.1",
-    "log4js": "^6.9.1",
-    "map-obj": "^5.0.2",
-    "p-props": "^5.0.0",
-    "path-exists": "^5.0.0",
-    "path-type": "^5.0.0",
-    "pkg": "^5.8.1",
-    "pretty-bytes": "^6.1.0",
-    "pretty-ms": "^8.0.0",
-    "serialize-error": "^11.0.0",
-    "standard-version": "^9.5.0",
-    "tsup": "^6.7.0",
-    "typescript": "^4.9.4",
-    "typesync": "^0.10.0",
-    "vite-tsconfig-paths": "^4.2.0",
-    "vitest": "^0.30.1",
-    "zx": "^7.2.1"
-  },
-  "optionalDependencies": {
-    "@vmngr/libvirt": "github:unraid/libvirt"
-  },
-  "config": {
-    "commitizen": {
-      "path": "./node_modules/cz-conventional-changelog"
-    }
-  }
+    "name": "@unraid/api",
+    "version": "4.2.1",
+    "main": "src/cli/index.ts",
+    "type": "module",
+    "corepack": {
+        "enabled": true
+    },
+    "repository": "git@github.com:unraid/api.git",
+    "author": "Lime Technology, Inc. <unraid.net>",
+    "license": "GPL-2.0-only",
+    "engines": {
+        "pnpm": ">=8.0.0"
+    },
+    "scripts": {
+        "// Development": "",
+        "start": "node dist/main.js",
+        "dev": "vite",
+        "command": "pnpm run build && clear && ./dist/cli.js",
+        "// Build and Deploy": "",
+        "build": "vite build --mode=production",
+        "postbuild": "chmod +x dist/main.js && chmod +x dist/cli.js",
+        "build:watch": "nodemon --watch src --ext ts,js,json --exec 'tsx ./scripts/build.ts'",
+        "build:docker": "./scripts/dc.sh run --rm builder",
+        "build:release": "tsx ./scripts/build.ts",
+        "preunraid:deploy": "pnpm build",
+        "unraid:deploy": "./scripts/deploy-dev.sh",
+        "// GraphQL Codegen": "",
+        "codegen": "MOTHERSHIP_GRAPHQL_LINK='https://staging.mothership.unraid.net/ws' graphql-codegen --config codegen.ts -r dotenv/config './.env.staging'",
+        "codegen:watch": "DOTENV_CONFIG_PATH='./.env.staging' graphql-codegen --config codegen.ts --watch -r dotenv/config",
+        "codegen:local": "NODE_TLS_REJECT_UNAUTHORIZED=0  MOTHERSHIP_GRAPHQL_LINK='https://mothership.localhost/ws' graphql-codegen --config codegen.ts --watch",
+        "// Code Quality": "",
+        "lint": "eslint --config .eslintrc.ts src/",
+        "lint:fix": "eslint --fix --config .eslintrc.ts src/",
+        "type-check": "tsc --noEmit",
+        "// Testing": "",
+        "test": "NODE_ENV=test vitest run",
+        "test:watch": "NODE_ENV=test vitest --ui",
+        "coverage": "NODE_ENV=test vitest run --coverage",
+        "// Docker": "",
+        "container:build": "./scripts/dc.sh build dev",
+        "container:start": "pnpm run container:stop && ./scripts/dc.sh run --rm --service-ports dev",
+        "container:stop": "./scripts/dc.sh stop dev",
+        "container:test": "./scripts/dc.sh run --rm builder pnpm run test",
+        "container:enter": "./scripts/dc.sh exec dev /bin/bash"
+    },
+    "bin": {
+        "unraid-api": "dist/cli.js"
+    },
+    "dependencies": {
+        "@apollo/client": "^3.11.8",
+        "@apollo/server": "^4.11.2",
+        "@as-integrations/fastify": "^2.1.1",
+        "@fastify/cookie": "^11.0.2",
+        "@fastify/helmet": "^13.0.1",
+        "@graphql-codegen/client-preset": "^4.5.0",
+        "@graphql-tools/load-files": "^7.0.0",
+        "@graphql-tools/merge": "^9.0.8",
+        "@graphql-tools/schema": "^10.0.7",
+        "@graphql-tools/utils": "^10.5.5",
+        "@jsonforms/core": "^3.5.1",
+        "@nestjs/apollo": "^13.0.3",
+        "@nestjs/common": "^11.0.11",
+        "@nestjs/core": "^11.0.11",
+        "@nestjs/graphql": "^13.0.3",
+        "@nestjs/passport": "^10.0.3",
+        "@nestjs/platform-fastify": "^11.0.11",
+        "@nestjs/schedule": "^5.0.0",
+        "@nestjs/throttler": "^6.2.1",
+        "@reduxjs/toolkit": "^2.3.0",
+        "@runonflux/nat-upnp": "^1.0.2",
+        "@types/diff": "^7.0.1",
+        "@unraid/libvirt": "^1.1.3",
+        "accesscontrol": "^2.2.1",
+        "bycontract": "^2.0.11",
+        "bytes": "^3.1.2",
+        "cacheable-lookup": "^7.0.0",
+        "camelcase-keys": "^9.1.3",
+        "casbin": "^5.32.0",
+        "chokidar": "^4.0.1",
+        "cli-table": "^0.3.11",
+        "command-exists": "^1.2.9",
+        "convert": "^5.8.0",
+        "cookie": "^1.0.2",
+        "cron": "3.5.0",
+        "cross-fetch": "^4.0.0",
+        "diff": "^7.0.0",
+        "docker-event-emitter": "^0.3.0",
+        "dockerode": "^3.3.5",
+        "dotenv": "^16.4.5",
+        "execa": "^9.5.1",
+        "exit-hook": "^4.0.0",
+        "fastify": "^5.2.1",
+        "filenamify": "^6.0.0",
+        "fs-extra": "^11.2.0",
+        "glob": "^11.0.1",
+        "global-agent": "^3.0.0",
+        "got": "^14.4.6",
+        "graphql": "^16.9.0",
+        "graphql-fields": "^2.0.3",
+        "graphql-scalars": "^1.23.0",
+        "graphql-subscriptions": "^2.0.0",
+        "graphql-tag": "^2.12.6",
+        "graphql-type-json": "^0.3.2",
+        "graphql-type-uuid": "^0.2.0",
+        "graphql-ws": "^5.16.0",
+        "ini": "^4.1.2",
+        "ip": "^2.0.1",
+        "jose": "^5.9.6",
+        "lodash-es": "^4.17.21",
+        "multi-ini": "^2.3.2",
+        "mustache": "^4.2.0",
+        "nest-authz": "^2.14.0",
+        "nest-commander": "^3.15.0",
+        "nestjs-pino": "^4.1.0",
+        "node-cache": "^5.1.2",
+        "node-window-polyfill": "^1.0.2",
+        "p-retry": "^6.2.0",
+        "passport-custom": "^1.1.1",
+        "passport-http-header-strategy": "^1.1.0",
+        "path-type": "^6.0.0",
+        "pino": "^9.5.0",
+        "pino-http": "^10.3.0",
+        "pino-pretty": "^11.3.0",
+        "pm2": "^5.4.2",
+        "reflect-metadata": "^0.1.14",
+        "request": "^2.88.2",
+        "rxjs": "^7.8.2",
+        "semver": "^7.6.3",
+        "strftime": "^0.10.3",
+        "systeminformation": "^5.25.11",
+        "uuid": "^11.0.2",
+        "ws": "^8.18.0",
+        "zen-observable-ts": "^1.1.0",
+        "zod": "^3.23.8"
+    },
+    "devDependencies": {
+        "@eslint/js": "^9.21.0",
+        "@graphql-codegen/add": "^5.0.3",
+        "@graphql-codegen/cli": "^5.0.3",
+        "@graphql-codegen/fragment-matcher": "^5.0.2",
+        "@graphql-codegen/import-types-preset": "^3.0.0",
+        "@graphql-codegen/typed-document-node": "^5.0.11",
+        "@graphql-codegen/typescript": "^4.1.1",
+        "@graphql-codegen/typescript-operations": "^4.3.1",
+        "@graphql-codegen/typescript-resolvers": "4.4.4",
+        "@graphql-typed-document-node/core": "^3.2.0",
+        "@ianvs/prettier-plugin-sort-imports": "^4.4.0",
+        "@nestjs/testing": "^11.0.11",
+        "@originjs/vite-plugin-commonjs": "^1.0.3",
+        "@rollup/plugin-node-resolve": "^16.0.0",
+        "@swc/core": "^1.10.1",
+        "@types/async-exit-hook": "^2.0.2",
+        "@types/bytes": "^3.1.4",
+        "@types/cli-table": "^0.3.4",
+        "@types/command-exists": "^1.2.3",
+        "@types/cors": "^2.8.17",
+        "@types/dockerode": "^3.3.31",
+        "@types/graphql-fields": "^1.3.9",
+        "@types/graphql-type-uuid": "^0.2.6",
+        "@types/ini": "^4.1.1",
+        "@types/ip": "^1.1.3",
+        "@types/lodash": "^4.17.13",
+        "@types/mustache": "^4.2.5",
+        "@types/node": "^22.13.4",
+        "@types/pify": "^5.0.4",
+        "@types/semver": "^7.5.8",
+        "@types/sendmail": "^1.4.7",
+        "@types/stoppable": "^1.1.3",
+        "@types/strftime": "^0.9.8",
+        "@types/uuid": "^10.0.0",
+        "@types/ws": "^8.5.13",
+        "@types/wtfnode": "^0.7.3",
+        "@vitest/coverage-v8": "^3.0.5",
+        "@vitest/ui": "^3.0.5",
+        "cz-conventional-changelog": "3.3.0",
+        "eslint": "^9.20.1",
+        "eslint-plugin-import": "^2.31.0",
+        "eslint-plugin-n": "^17.0.0",
+        "eslint-plugin-no-relative-import-paths": "^1.6.1",
+        "eslint-plugin-prettier": "^5.2.3",
+        "graphql-codegen-typescript-validation-schema": "^0.17.0",
+        "jiti": "^2.4.0",
+        "nodemon": "^3.1.7",
+        "prettier": "^3.5.2",
+        "rollup-plugin-node-externals": "^8.0.0",
+        "standard-version": "^9.5.0",
+        "tsx": "^4.19.2",
+        "typescript": "^5.6.3",
+        "typescript-eslint": "^8.13.0",
+        "unplugin-swc": "^1.5.1",
+        "vite": "^6.0.0",
+        "vite-plugin-node": "^4.0.0",
+        "vite-tsconfig-paths": "^5.1.0",
+        "vitest": "^3.0.5",
+        "zx": "^8.3.2"
+    },
+    "overrides": {
+        "eslint": {
+            "jiti": "2"
+        }
+    },
+    "private": true,
+    "packageManager": "pnpm@10.6.4"
 }

api/scripts/build.ts

@@ -0,0 +1,58 @@
+#!/usr/bin/env zx
+import { mkdir, readFile, rm, writeFile } from 'fs/promises';
+import { exit } from 'process';
+
+import { $, cd } from 'zx';
+
+import { getDeploymentVersion } from './get-deployment-version.js';
+
+try {
+    // Create release and pack directories
+    await mkdir('./deploy/release', { recursive: true });
+    await mkdir('./deploy/pack', { recursive: true });
+
+    // Build Generated Types
+    await $`pnpm run codegen`;
+
+    await $`pnpm run build`;
+    // Copy app files to plugin directory
+
+    // Get package details
+    const packageJson = await readFile('./package.json', 'utf-8');
+    const parsedPackageJson = JSON.parse(packageJson);
+
+    const deploymentVersion = await getDeploymentVersion(process.env, parsedPackageJson.version);
+
+    // Update the package.json version to the deployment version
+    parsedPackageJson.version = deploymentVersion;
+
+    // Create a temporary directory for packaging
+    await mkdir('./deploy/pack/', { recursive: true });
+
+    await writeFile('./deploy/pack/package.json', JSON.stringify(parsedPackageJson, null, 4));
+    // Copy necessary files to the pack directory
+    await $`cp -r dist README.md .env.* ecosystem.config.json ./deploy/pack/`;
+
+    // Change to the pack directory and install dependencies
+    cd('./deploy/pack');
+
+    console.log('Installing production dependencies...');
+    $.verbose = true;
+    await $`pnpm install --prod --ignore-workspace --node-linker hoisted`;
+
+    // chmod the cli
+    await $`chmod +x ./dist/cli.js`;
+    await $`chmod +x ./dist/main.js`;
+} catch (error) {
+    // Error with a command
+    if (Object.keys(error).includes('stderr')) {
+        console.log(`Failed building package. Exit code: ${error.exitCode}`);
+        console.log(`Error: ${error.stderr}`);
+    } else {
+        // Normal js error
+        console.log('Failed building package.');
+        console.log(`Error: ${error.message}`);
+    }
+
+    exit(error.exitCode);
+}

api/scripts/create-session.sh

@@ -0,0 +1,33 @@
+# This script creates a mock session on a server.
+# During local dev/testing, you should run it in the api container,
+# so the nest.js api can authenticate cookies against it.
+#
+# You should also set a cookie named 'unraid_...' whose value matches
+# the name of the session you created (where name is sess_<name>).
+# By default, this is my-session
+
+sessions_dir=/var/lib/php
+default_session_name=mock-user-session
+
+if [ "$1" = "--help" ]; then
+  echo "This script creates a mock session on a server."
+  echo ""
+  echo "Usage: $0 [options]"
+  echo ""
+  echo "Options:"
+  echo "  [name]    Name of the session to create (default: mock-user-session)"
+  echo "  --help    Display this help message and exit"
+  echo ""
+  echo "Example: $0 a-session-name"
+  echo ""
+  echo "Current list of sessions:"
+  ls $sessions_dir
+  exit 0
+fi
+
+session_name="${1:-$default_session_name}"
+
+mkdir -p $sessions_dir
+touch "$sessions_dir/sess_$session_name"
+
+ls $sessions_dir

api/scripts/dc.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+# Pass all entered params after the docker compose call
+COMPOSE_PROJECT_NAME="connect" GIT_SHA=$(git rev-parse --short HEAD) IS_TAGGED=$(git describe --tags --abbrev=0 --exact-match || echo '') docker compose -f docker-compose.yml "$@"

api/scripts/deploy-dev.sh

@@ -0,0 +1,61 @@
+#!/bin/bash
+
+# Arguments
+# $1: SSH server name (required)
+
+# Check if the server name is provided
+if [[ -z "$1" ]]; then
+  echo "Error: SSH server name is required."
+  echo "Usage: $0 <server_name>"
+  exit 1
+fi
+
+# Set server name from command-line argument
+server_name="$1"
+
+# Source directory path
+source_directory="./dist"
+
+if [ ! -d "$source_directory" ]; then
+  echo "The dist directory does not exist. Attempting build..."
+  npm run build
+  if [ $? -ne 0 ]; then
+    echo "Build failed!"
+    exit 1
+  fi
+fi
+
+# Destination directory path
+destination_directory="/usr/local/unraid-api"
+
+# Replace the value inside the rsync command with the user's input
+rsync_command="rsync -avz --progress --stats -e ssh \"$source_directory\" \"root@${server_name}:$destination_directory\""
+
+echo "Executing the following command:"
+echo "$rsync_command"
+
+# Execute the rsync command and capture the exit code
+eval "$rsync_command"
+exit_code=$?
+
+# Chown the directory
+ssh root@"${server_name}" 'chown -R root:root /usr/local/unraid-api'
+
+# Run unraid-api restart on remote host
+ssh root@"${server_name}" 'INTROSPECTION=true LOG_LEVEL=trace unraid-api restart'
+
+# Play built-in sound based on the operating system
+if [[ "$OSTYPE" == "darwin"* ]]; then
+  # macOS
+  afplay /System/Library/Sounds/Glass.aiff
+elif [[ "$OSTYPE" == "linux-gnu" ]]; then
+  # Linux
+  paplay /usr/share/sounds/freedesktop/stereo/complete.oga
+elif [[ "$OSTYPE" == "msys" || "$OSTYPE" == "win32" ]]; then
+  # Windows
+  powershell.exe -c "(New-Object Media.SoundPlayer 'C:\Windows\Media\Windows Default.wav').PlaySync()"
+fi
+
+# Exit with the rsync command's exit code
+exit $exit_code
+

api/scripts/get-deployment-version.ts

@@ -0,0 +1,34 @@
+import { execa } from 'execa';
+
+const runCommand = async (command: string, args: string[]) => {
+    try {
+        const { stdout } = await execa(command, args);
+        return stdout.trim();
+    } catch (error) {
+        console.log('Failed to execute command:', command, args.join(' '), error.message);
+        return undefined;
+    }
+};
+
+export const getDeploymentVersion = async (env = process.env, packageVersion: string) => {
+    if (env.API_VERSION) {
+        console.log(`Using env var for version: ${env.API_VERSION}`);
+        return env.API_VERSION;
+    } else if (env.GIT_SHA && env.IS_TAGGED) {
+        console.log(`Using env vars for git tags: ${env.GIT_SHA} ${env.IS_TAGGED}`);
+        return env.IS_TAGGED ? packageVersion : `${packageVersion}+${env.GIT_SHA}`;
+    } else {
+        const gitShortSHA = await runCommand('git', ['rev-parse', '--short', 'HEAD']);
+        const isCommitTagged =
+            (await runCommand('git', ['describe', '--tags', '--abbrev=0', '--exact-match'])) !==
+            undefined;
+
+        console.log('gitShortSHA', gitShortSHA, 'isCommitTagged', isCommitTagged);
+
+        if (!gitShortSHA) {
+            console.error('Failed to get git short SHA');
+            process.exit(1);
+        }
+        return isCommitTagged ? packageVersion : `${packageVersion}+${gitShortSHA}`;
+    }
+};

api/src/__test__/cli/commands/restart.test.ts

@@ -1,31 +0,0 @@
-import { beforeEach, expect, test, vi } from 'vitest';
-
-// Preloading imports for faster tests
-import '@app/cli/commands/restart';
-import '@app/cli/commands/start';
-import '@app/cli/commands/stop';
-
-beforeEach(() => {
-	vi.resetAllMocks();
-});
-
-test('calls stop and then start', async () => {
-	vi.mock('@app/cli/commands/start');
-	vi.mock('@app/cli/commands/stop');
-	// Call restart
-	const { restart } = await import('@app/cli/commands/restart');
-	const { start } = await import('@app/cli/commands/start');
-	const { stop } = await import('@app/cli/commands/stop');
-	await restart();
-
-	// Check stop was called
-	expect(vi.mocked(stop).mock.calls.length).toBe(1);
-
-	// Check start was called
-	expect(vi.mocked(start).mock.calls.length).toBe(1);
-
-	// Check stop was called first
-	expect(vi.mocked(stop).mock.invocationCallOrder[0]).toBeLessThan(
-        vi.mocked(start).mock.invocationCallOrder[0]
-    );
-});

api/src/__test__/common/allowed-origins.test.ts

@@ -0,0 +1,44 @@
+import { getAllowedOrigins } from '@app/common/allowed-origins.js';
+import { store } from '@app/store/index.js';
+import { loadConfigFile } from '@app/store/modules/config.js';
+import { loadStateFiles } from '@app/store/modules/emhttp.js';
+
+import 'reflect-metadata';
+
+import { expect, test } from 'vitest';
+
+test('Returns allowed origins', async () => {
+    // Load state files into store
+    await store.dispatch(loadStateFiles());
+    await store.dispatch(loadConfigFile());
+
+    // Get allowed origins
+    expect(getAllowedOrigins()).toMatchInlineSnapshot(`
+      [
+        "/var/run/unraid-notifications.sock",
+        "/var/run/unraid-php.sock",
+        "/var/run/unraid-cli.sock",
+        "http://localhost:8080",
+        "https://localhost:4443",
+        "https://tower.local:4443",
+        "https://192.168.1.150:4443",
+        "https://tower:4443",
+        "https://192-168-1-150.thisisfourtyrandomcharacters012345678900.myunraid.net:4443",
+        "https://85-121-123-122.thisisfourtyrandomcharacters012345678900.myunraid.net:8443",
+        "https://10-252-0-1.hash.myunraid.net:4443",
+        "https://10-252-1-1.hash.myunraid.net:4443",
+        "https://10-253-3-1.hash.myunraid.net:4443",
+        "https://10-253-4-1.hash.myunraid.net:4443",
+        "https://10-253-5-1.hash.myunraid.net:4443",
+        "https://10-100-0-1.hash.myunraid.net:4443",
+        "https://10-100-0-2.hash.myunraid.net:4443",
+        "https://10-123-1-2.hash.myunraid.net:4443",
+        "https://221-123-121-112.hash.myunraid.net:4443",
+        "https://google.com",
+        "https://test.com",
+        "https://connect.myunraid.net",
+        "https://connect-staging.myunraid.net",
+        "https://dev-my.myunraid.net:4000",
+      ]
+    `);
+});

api/src/__test__/common/dashboard/generate-data.test.ts

@@ -1,120 +0,0 @@
-import { expect, test, vi } from 'vitest';
-import { store } from '@app/store';
-
-import { loadStateFiles } from '@app/store/modules/emhttp';
-
-vi.mock('@vmngr/libvirt', () => ({
-	ConnectListAllDomainsFlags: {
-		ACTIVE: 0,
-		INACTIVE: 1,
-	},
-}));
-
-vi.mock('@app/core/log', () => ({
-	logger: {
-		info: vi.fn(),
-		error: vi.fn(),
-		debug: vi.fn(),
-		trace: vi.fn(),
-		addContext: vi.fn(),
-		removeContext: vi.fn(),
-	},
-	dashboardLogger: {
-		info: vi.fn(),
-		error: vi.fn((...input) => console.log(input)),
-		debug: vi.fn(),
-		trace: vi.fn(),
-		addContext: vi.fn(),
-		removeContext: vi.fn(),
-	},
-	emhttpLogger: {
-		info: vi.fn(),
-		error: vi.fn(),
-		debug: vi.fn(),
-		trace: vi.fn(),
-		addContext: vi.fn(),
-		removeContext: vi.fn(),
-	},
-}));
-
-vi.mock('@app/common/two-factor', () => ({
-	checkTwoFactorEnabled: vi.fn(() => ({
-		isRemoteEnabled: false,
-		isLocalEnabled: false,
-	})),
-}));
-
-vi.mock('@app/common/dashboard/boot-timestamp', () => ({
-	bootTimestamp: new Date('2022-06-10T04:35:58.276Z'),
-}));
-
-test('Returns generated data', async () => {
-	await store.dispatch(loadStateFiles()).unwrap();
-
-	const { generateData } = await import('@app/common/dashboard/generate-data');
-	const result = await generateData();
-
-	expect(result).toMatchInlineSnapshot(`
-		{
-		  "apps": {
-		    "installed": 0,
-		    "started": 0,
-		  },
-		  "array": {
-		    "capacity": {
-		      "bytes": {
-		        "free": 19495825571000,
-		        "total": 41994745901000,
-		        "used": 22498920330000,
-		      },
-		    },
-		    "state": "STOPPED",
-		  },
-		  "config": {
-		    "valid": true,
-		  },
-		  "display": {
-		    "case": {
-		      "base64": "",
-		      "error": "",
-		      "icon": "case-model.png",
-		      "url": "",
-		    },
-		  },
-		  "os": {
-		    "hostname": "Tower",
-		    "uptime": "2022-06-10T04:35:58.276Z",
-		  },
-		  "services": [
-		    {
-		      "name": "unraid-api",
-		      "online": true,
-		      "uptime": {
-		        "timestamp": "2022-06-10T04:35:58.276Z",
-		      },
-		      "version": "THIS_WILL_BE_REPLACED_WHEN_BUILT",
-		    },
-		    {
-		      "name": "dynamic-remote-access",
-		      "online": false,
-		      "uptime": {
-		        "timestamp": "2022-06-10T04:35:58.276Z",
-		      },
-		      "version": "DISABLED",
-		    },
-		  ],
-		  "vars": {
-		    "flashGuid": "0000-0000-0000-000000000000",
-		    "regState": "PRO",
-		    "regTy": "PRO",
-		  },
-		  "versions": {
-		    "unraid": "6.11.2",
-		  },
-		  "vms": {
-		    "installed": 0,
-		    "started": 0,
-		  },
-		}
-	`);
-}, 10_000);

api/src/__test__/core/__snapshots__/default-permissions.test.ts.snap

@@ -1,350 +0,0 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
-
-exports[`Returns default permissions 1`] = `
-{
-  "admin": {
-    "extends": "user",
-    "permissions": [
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "apikey",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "array",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "cpu",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "crash-reporting-enabled",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "device",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "device/unassigned",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "disk",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "disk/settings",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "display",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "docker/container",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "docker/network",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "flash",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "info",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "license-key",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "machine-id",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "memory",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "notifications",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "online",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "os",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "owner",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "parity-history",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "permission",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "registration",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "servers",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "service",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "service/emhttpd",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "service/unraid-api",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "services",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "share",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "software-versions",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "unraid-version",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "uptime",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "user",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "vars",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "vms",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "vms/domain",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "vms/network",
-      },
-    ],
-  },
-  "guest": {
-    "permissions": [
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "me",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "welcome",
-      },
-    ],
-  },
-  "my_servers": {
-    "extends": "guest",
-    "permissions": [
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "dashboard",
-      },
-      {
-        "action": "read:own",
-        "attributes": "*",
-        "resource": "two-factor",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "array",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "docker/container",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "docker/network",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "notifications",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "vms/domain",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "unraid-version",
-      },
-    ],
-  },
-  "notifier": {
-    "extends": "guest",
-    "permissions": [
-      {
-        "action": "create:own",
-        "attributes": "*",
-        "resource": "notifications",
-      },
-    ],
-  },
-  "upc": {
-    "extends": "guest",
-    "permissions": [
-      {
-        "action": "read:own",
-        "attributes": "*",
-        "resource": "apikey",
-      },
-      {
-        "action": "read:own",
-        "attributes": "*",
-        "resource": "cloud",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "config",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "crash-reporting-enabled",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "disk",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "display",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "flash",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "os",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "owner",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "permission",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "registration",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "servers",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "vars",
-      },
-    ],
-  },
-  "user": {
-    "extends": "guest",
-    "permissions": [
-      {
-        "action": "read:own",
-        "attributes": "*",
-        "resource": "apikey",
-      },
-      {
-        "action": "read:any",
-        "attributes": "*",
-        "resource": "permission",
-      },
-    ],
-  },
-}
-`;

api/src/__test__/core/modules/array/get-array-data.test.ts

@@ -1,209 +1,209 @@
-import { test, expect, vi } from 'vitest';
+import { expect, test, vi } from 'vitest';
 
-vi.mock('@app/core/pubsub', () => ({
+import { getArrayData } from '@app/core/modules/array/get-array-data.js';
+import { store } from '@app/store/index.js';
+import { loadConfigFile } from '@app/store/modules/config.js';
+import { loadStateFiles } from '@app/store/modules/emhttp.js';
+
+vi.mock('@app/core/pubsub.js', () => ({
     pubsub: { publish: vi.fn() },
 }));
 
 test('Creates an array event', async () => {
-    const { getArrayData } = await import(
-        '@app/core/modules/array/get-array-data'
-    );
-    const { store } = await import('@app/store');
-    const { loadStateFiles } = await import('@app/store/modules/emhttp');
-
     // Load state files into store
     await store.dispatch(loadStateFiles());
 
+    await store.dispatch(loadConfigFile());
+
     const arrayEvent = getArrayData(store.getState);
-    expect(arrayEvent).toMatchInlineSnapshot(`
-      {
-        "boot": {
-          "comment": "Unraid OS boot device",
-          "critical": null,
-          "device": "sda",
-          "exportable": true,
-          "format": "unknown",
-          "fsFree": 3191407,
-          "fsSize": 4042732,
-          "fsType": "vfat",
-          "fsUsed": 851325,
-          "id": "Cruzer",
-          "idx": 32,
-          "name": "flash",
-          "numErrors": 0,
-          "numReads": 0,
-          "numWrites": 0,
-          "rotational": true,
-          "size": 3956700,
-          "status": "DISK_OK",
-          "temp": null,
-          "transport": "usb",
-          "type": "Flash",
-          "warning": null,
+    expect(arrayEvent).toMatchObject({
+        boot: {
+            comment: 'Unraid OS boot device',
+            critical: null,
+            device: 'sda',
+            exportable: true,
+            format: 'unknown',
+            fsFree: 3191407,
+            fsSize: 4042732,
+            fsType: 'vfat',
+            fsUsed: 851325,
+            id: 'Cruzer',
+            idx: 32,
+            name: 'flash',
+            numErrors: 0,
+            numReads: 0,
+            numWrites: 0,
+            rotational: true,
+            size: 3956700,
+            status: 'DISK_OK',
+            temp: null,
+            transport: 'usb',
+            type: 'Flash',
+            warning: null,
         },
-        "caches": [
-          {
-            "comment": "",
-            "critical": null,
-            "device": "sdi",
-            "exportable": false,
-            "format": "MBR: 4KiB-aligned",
-            "fsFree": 111810683,
-            "fsSize": 250059317,
-            "fsType": "btrfs",
-            "fsUsed": 137273827,
-            "id": "Samsung_SSD_850_EVO_250GB_S2R5NX0H643734Z",
-            "idx": 30,
-            "name": "cache",
-            "numErrors": 0,
-            "numReads": 0,
-            "numWrites": 0,
-            "rotational": false,
-            "size": 244198552,
-            "status": "DISK_OK",
-            "temp": 22,
-            "transport": "ata",
-            "type": "Cache",
-            "warning": null,
-          },
-          {
-            "comment": null,
-            "critical": null,
-            "device": "nvme0n1",
-            "exportable": false,
-            "format": "MBR: 4KiB-aligned",
-            "fsFree": null,
-            "fsSize": null,
-            "fsType": null,
-            "fsUsed": null,
-            "id": "KINGSTON_SA2000M8250G_50026B7282669D9E",
-            "idx": 31,
-            "name": "cache2",
-            "numErrors": 0,
-            "numReads": 0,
-            "numWrites": 0,
-            "rotational": false,
-            "size": 244198552,
-            "status": "DISK_OK",
-            "temp": 27,
-            "transport": "nvme",
-            "type": "Cache",
-            "warning": null,
-          },
+        caches: [
+            {
+                comment: '',
+                critical: null,
+                device: 'sdi',
+                exportable: false,
+                format: 'MBR: 4KiB-aligned',
+                fsFree: 111810683,
+                fsSize: 250059317,
+                fsType: 'btrfs',
+                fsUsed: 137273827,
+                id: 'Samsung_SSD_850_EVO_250GB_S2R5NX0H643734Z',
+                idx: 30,
+                name: 'cache',
+                numErrors: 0,
+                numReads: 0,
+                numWrites: 0,
+                rotational: false,
+                size: 244198552,
+                status: 'DISK_OK',
+                temp: 22,
+                transport: 'ata',
+                type: 'Cache',
+                warning: null,
+            },
+            {
+                comment: null,
+                critical: null,
+                device: 'nvme0n1',
+                exportable: false,
+                format: 'MBR: 4KiB-aligned',
+                fsFree: null,
+                fsSize: null,
+                fsType: null,
+                fsUsed: null,
+                id: 'KINGSTON_SA2000M8250G_50026B7282669D9E',
+                idx: 31,
+                name: 'cache2',
+                numErrors: 0,
+                numReads: 0,
+                numWrites: 0,
+                rotational: false,
+                size: 244198552,
+                status: 'DISK_OK',
+                temp: 27,
+                transport: 'nvme',
+                type: 'Cache',
+                warning: null,
+            },
         ],
-        "capacity": {
-          "disks": {
-            "free": "27",
-            "total": "30",
-            "used": "3",
-          },
-          "kilobytes": {
-            "free": "19495825571",
-            "total": "41994745901",
-            "used": "22498920330",
-          },
+        capacity: {
+            disks: {
+                free: '27',
+                total: '30',
+                used: '3',
+            },
+            kilobytes: {
+                free: '19495825571',
+                total: '41994745901',
+                used: '22498920330',
+            },
         },
-        "disks": [
-          {
-            "comment": "Seagate Exos",
-            "critical": 75,
-            "device": "sdf",
-            "exportable": false,
-            "format": "GPT: 4KiB-aligned",
-            "fsFree": 13882739732,
-            "fsSize": 17998742753,
-            "fsType": "xfs",
-            "fsUsed": 4116003021,
-            "id": "ST18000NM000J-2TV103_ZR5B1W9X",
-            "idx": 1,
-            "name": "disk1",
-            "numErrors": 0,
-            "numReads": 0,
-            "numWrites": 0,
-            "rotational": true,
-            "size": 17578328012,
-            "status": "DISK_OK",
-            "temp": 30,
-            "transport": "ata",
-            "type": "Data",
-            "warning": 50,
-          },
-          {
-            "comment": "",
-            "critical": null,
-            "device": "sdj",
-            "exportable": false,
-            "format": "GPT: 4KiB-aligned",
-            "fsFree": 93140746,
-            "fsSize": 11998001574,
-            "fsType": "xfs",
-            "fsUsed": 11904860828,
-            "id": "WDC_WD120EDAZ-11F3RA0_5PJRD45C",
-            "idx": 2,
-            "name": "disk2",
-            "numErrors": 0,
-            "numReads": 0,
-            "numWrites": 0,
-            "rotational": true,
-            "size": 11718885324,
-            "status": "DISK_OK",
-            "temp": 30,
-            "transport": "ata",
-            "type": "Data",
-            "warning": null,
-          },
-          {
-            "comment": "",
-            "critical": null,
-            "device": "sde",
-            "exportable": false,
-            "format": "GPT: 4KiB-aligned",
-            "fsFree": 5519945093,
-            "fsSize": 11998001574,
-            "fsType": "xfs",
-            "fsUsed": 6478056481,
-            "id": "WDC_WD120EMAZ-11BLFA0_5PH8BTYD",
-            "idx": 3,
-            "name": "disk3",
-            "numErrors": 0,
-            "numReads": 0,
-            "numWrites": 0,
-            "rotational": true,
-            "size": 11718885324,
-            "status": "DISK_OK",
-            "temp": 30,
-            "transport": "ata",
-            "type": "Data",
-            "warning": null,
-          },
+        disks: [
+            {
+                comment: 'Seagate Exos',
+                critical: 75,
+                device: 'sdf',
+                exportable: false,
+                format: 'GPT: 4KiB-aligned',
+                fsFree: 13882739732,
+                fsSize: 17998742753,
+                fsType: 'xfs',
+                fsUsed: 4116003021,
+                id: 'ST18000NM000J-2TV103_ZR5B1W9X',
+                idx: 1,
+                name: 'disk1',
+                numErrors: 0,
+                numReads: 0,
+                numWrites: 0,
+                rotational: true,
+                size: 17578328012,
+                status: 'DISK_OK',
+                temp: 30,
+                transport: 'ata',
+                type: 'Data',
+                warning: 50,
+            },
+            {
+                comment: '',
+                critical: null,
+                device: 'sdj',
+                exportable: false,
+                format: 'GPT: 4KiB-aligned',
+                fsFree: 93140746,
+                fsSize: 11998001574,
+                fsType: 'xfs',
+                fsUsed: 11904860828,
+                id: 'WDC_WD120EDAZ-11F3RA0_5PJRD45C',
+                idx: 2,
+                name: 'disk2',
+                numErrors: 0,
+                numReads: 0,
+                numWrites: 0,
+                rotational: true,
+                size: 11718885324,
+                status: 'DISK_OK',
+                temp: 30,
+                transport: 'ata',
+                type: 'Data',
+                warning: null,
+            },
+            {
+                comment: '',
+                critical: null,
+                device: 'sde',
+                exportable: false,
+                format: 'GPT: 4KiB-aligned',
+                fsFree: 5519945093,
+                fsSize: 11998001574,
+                fsType: 'xfs',
+                fsUsed: 6478056481,
+                id: 'WDC_WD120EMAZ-11BLFA0_5PH8BTYD',
+                idx: 3,
+                name: 'disk3',
+                numErrors: 0,
+                numReads: 0,
+                numWrites: 0,
+                rotational: true,
+                size: 11718885324,
+                status: 'DISK_OK',
+                temp: 30,
+                transport: 'ata',
+                type: 'Data',
+                warning: null,
+            },
         ],
-        "parities": [
-          {
-            "comment": null,
-            "critical": null,
-            "device": "sdh",
-            "exportable": false,
-            "format": "GPT: 4KiB-aligned",
-            "fsFree": null,
-            "fsSize": null,
-            "fsType": null,
-            "fsUsed": null,
-            "id": "ST18000NM000J-2TV103_ZR585CPY",
-            "idx": 0,
-            "name": "parity",
-            "numErrors": 0,
-            "numReads": 0,
-            "numWrites": 0,
-            "rotational": true,
-            "size": 17578328012,
-            "status": "DISK_OK",
-            "temp": 25,
-            "transport": "ata",
-            "type": "Parity",
-            "warning": null,
-          },
+        id: expect.any(String),
+        parities: [
+            {
+                comment: null,
+                critical: null,
+                device: 'sdh',
+                exportable: false,
+                format: 'GPT: 4KiB-aligned',
+                fsFree: null,
+                fsSize: null,
+                fsType: null,
+                fsUsed: null,
+                id: 'ST18000NM000J-2TV103_ZR585CPY',
+                idx: 0,
+                name: 'parity',
+                numErrors: 0,
+                numReads: 0,
+                numWrites: 0,
+                rotational: true,
+                size: 17578328012,
+                status: 'DISK_OK',
+                temp: 25,
+                transport: 'ata',
+                type: 'Parity',
+                warning: null,
+            },
         ],
-        "state": "STOPPED",
-      }
-    `);
+        state: 'STOPPED',
+    });
 });

api/src/__test__/core/notifiers/console.test.ts

@@ -0,0 +1,22 @@
+import { expect, test, vi } from 'vitest';
+
+import { ConsoleNotifier } from '@app/core/notifiers/console.js';
+
+vi.mock('@app/core/log.js', () => ({
+    logger: {
+        info: vi.fn(),
+        error: vi.fn(),
+        debug: vi.fn(),
+    },
+    graphqlLogger: {
+        info: vi.fn(),
+        error: vi.fn(),
+        debug: vi.fn(),
+    },
+}));
+
+test('Creates a console notifier', () => {
+    const notifier = new ConsoleNotifier();
+    expect(notifier.level).toBe('info');
+    expect(notifier.template).toBe('{{{ data }}}');
+});

api/src/__test__/core/notifiers/unraid-local.test.ts

@@ -0,0 +1,24 @@
+import { expect, test, vi } from 'vitest';
+
+import { UnraidLocalNotifier } from '@app/core/notifiers/unraid-local.js';
+
+vi.mock('@app/core/log.js', () => ({
+    logger: {
+        info: vi.fn(),
+        error: vi.fn(),
+        debug: vi.fn(),
+    },
+    graphqlLogger: {
+        info: vi.fn(),
+        error: vi.fn(),
+        debug: vi.fn(),
+    },
+}));
+
+test('Creates an email notifier', () => {
+    const notifier = new UnraidLocalNotifier({ level: 'info' });
+    expect(notifier.level).toBe('normal');
+    expect(notifier.template).toBe('{{ message }}');
+    const rendered = notifier.render({ message: 'Remote access started' });
+    expect(rendered).toEqual('Remote access started');
+});

api/src/__test__/core/utils/array/array-is-running.test.ts

@@ -0,0 +1,23 @@
+import { expect, test, vi } from 'vitest';
+
+import type { SliceState } from '@app/store/modules/emhttp.js';
+import { getters } from '@app/store/index.js';
+
+test('Returns true if the array is started', async () => {
+    vi.spyOn(getters, 'emhttp').mockImplementation(
+        () => ({ var: { mdState: 'STARTED' } }) as unknown as SliceState
+    );
+
+    const { arrayIsRunning } = await import('@app/core/utils/array/array-is-running.js');
+    expect(arrayIsRunning()).toBe(true);
+    vi.spyOn(getters, 'emhttp').mockReset();
+});
+
+test('Returns false if the array is stopped', async () => {
+    vi.spyOn(getters, 'emhttp').mockImplementation(
+        () => ({ var: { mdState: 'Stopped' } }) as unknown as SliceState
+    );
+    const { arrayIsRunning } = await import('@app/core/utils/array/array-is-running.js');
+    expect(arrayIsRunning()).toBe(false);
+    vi.spyOn(getters, 'emhttp').mockReset();
+});

api/src/__test__/core/utils/files/config-file-normalizer.test.ts

@@ -0,0 +1,160 @@
+import 'reflect-metadata';
+
+import { cloneDeep } from 'lodash-es';
+import { expect, test } from 'vitest';
+
+import { getWriteableConfig } from '@app/core/utils/files/config-file-normalizer.js';
+import { initialState } from '@app/store/modules/config.js';
+
+test('it creates a FLASH config with NO OPTIONAL values', () => {
+    const basicConfig = initialState;
+    const config = getWriteableConfig(basicConfig, 'flash');
+    expect(config).toMatchInlineSnapshot(`
+      {
+        "api": {
+          "extraOrigins": "",
+          "version": "",
+        },
+        "local": {
+          "sandbox": "no",
+        },
+        "remote": {
+          "accesstoken": "",
+          "apikey": "",
+          "avatar": "",
+          "dynamicRemoteAccessType": "DISABLED",
+          "email": "",
+          "idtoken": "",
+          "localApiKey": "",
+          "refreshtoken": "",
+          "regWizTime": "",
+          "ssoSubIds": "",
+          "upnpEnabled": "",
+          "username": "",
+          "wanaccess": "",
+          "wanport": "",
+        },
+      }
+    `);
+});
+
+test('it creates a MEMORY config with NO OPTIONAL values', () => {
+    const basicConfig = initialState;
+    const config = getWriteableConfig(basicConfig, 'memory');
+    expect(config).toMatchInlineSnapshot(`
+      {
+        "api": {
+          "extraOrigins": "",
+          "version": "",
+        },
+        "connectionStatus": {
+          "minigraph": "PRE_INIT",
+          "upnpStatus": "",
+        },
+        "local": {
+          "sandbox": "no",
+        },
+        "remote": {
+          "accesstoken": "",
+          "allowedOrigins": "/var/run/unraid-notifications.sock, /var/run/unraid-php.sock, /var/run/unraid-cli.sock, https://connect.myunraid.net, https://connect-staging.myunraid.net, https://dev-my.myunraid.net:4000",
+          "apikey": "",
+          "avatar": "",
+          "dynamicRemoteAccessType": "DISABLED",
+          "email": "",
+          "idtoken": "",
+          "localApiKey": "",
+          "refreshtoken": "",
+          "regWizTime": "",
+          "ssoSubIds": "",
+          "upnpEnabled": "",
+          "username": "",
+          "wanaccess": "",
+          "wanport": "",
+        },
+      }
+    `);
+});
+
+test('it creates a FLASH config with OPTIONAL values', () => {
+    const basicConfig = cloneDeep(initialState);
+    // 2fa & t2fa should be ignored
+    basicConfig.remote['2Fa'] = 'yes';
+    basicConfig.local['2Fa'] = 'yes';
+    basicConfig.local.showT2Fa = 'yes';
+
+    basicConfig.api.extraOrigins = 'myextra.origins';
+    basicConfig.remote.upnpEnabled = 'yes';
+    basicConfig.connectionStatus.upnpStatus = 'Turned On';
+    const config = getWriteableConfig(basicConfig, 'flash');
+    expect(config).toMatchInlineSnapshot(`
+      {
+        "api": {
+          "extraOrigins": "myextra.origins",
+          "version": "",
+        },
+        "local": {
+          "sandbox": "no",
+        },
+        "remote": {
+          "accesstoken": "",
+          "apikey": "",
+          "avatar": "",
+          "dynamicRemoteAccessType": "DISABLED",
+          "email": "",
+          "idtoken": "",
+          "localApiKey": "",
+          "refreshtoken": "",
+          "regWizTime": "",
+          "ssoSubIds": "",
+          "upnpEnabled": "yes",
+          "username": "",
+          "wanaccess": "",
+          "wanport": "",
+        },
+      }
+    `);
+});
+
+test('it creates a MEMORY config with OPTIONAL values', () => {
+    const basicConfig = cloneDeep(initialState);
+    // 2fa & t2fa should be ignored
+    basicConfig.remote['2Fa'] = 'yes';
+    basicConfig.local['2Fa'] = 'yes';
+    basicConfig.local.showT2Fa = 'yes';
+    basicConfig.api.extraOrigins = 'myextra.origins';
+    basicConfig.remote.upnpEnabled = 'yes';
+    basicConfig.connectionStatus.upnpStatus = 'Turned On';
+    const config = getWriteableConfig(basicConfig, 'memory');
+    expect(config).toMatchInlineSnapshot(`
+      {
+        "api": {
+          "extraOrigins": "myextra.origins",
+          "version": "",
+        },
+        "connectionStatus": {
+          "minigraph": "PRE_INIT",
+          "upnpStatus": "Turned On",
+        },
+        "local": {
+          "sandbox": "no",
+        },
+        "remote": {
+          "accesstoken": "",
+          "allowedOrigins": "/var/run/unraid-notifications.sock, /var/run/unraid-php.sock, /var/run/unraid-cli.sock, https://connect.myunraid.net, https://connect-staging.myunraid.net, https://dev-my.myunraid.net:4000",
+          "apikey": "",
+          "avatar": "",
+          "dynamicRemoteAccessType": "DISABLED",
+          "email": "",
+          "idtoken": "",
+          "localApiKey": "",
+          "refreshtoken": "",
+          "regWizTime": "",
+          "ssoSubIds": "",
+          "upnpEnabled": "yes",
+          "username": "",
+          "wanaccess": "",
+          "wanport": "",
+        },
+      }
+    `);
+});

api/src/__test__/core/utils/files/safe-ini-serializer.test.ts

@@ -0,0 +1,70 @@
+import { parse } from 'ini';
+import { Serializer } from 'multi-ini';
+import { expect, test } from 'vitest';
+
+import { safelySerializeObjectToIni } from '@app/core/utils/files/safe-ini-serializer.js';
+
+test('MultiIni breaks when serializing an object with a boolean inside', async () => {
+    const objectToSerialize = {
+        root: {
+            anonMode: false,
+        },
+    };
+    const serializer = new Serializer({ keep_quotes: false });
+    expect(serializer.serialize(objectToSerialize)).toMatchInlineSnapshot(`
+		"[root]
+		anonMode=false
+		"
+	`);
+});
+
+test('MultiIni can safely serialize an object with a boolean inside', async () => {
+    const objectToSerialize = {
+        root: {
+            anonMode: false,
+        },
+    };
+    expect(safelySerializeObjectToIni(objectToSerialize)).toMatchInlineSnapshot(`
+		"[root]
+		anonMode="false"
+		"
+	`);
+    const result = safelySerializeObjectToIni(objectToSerialize);
+    expect(parse(result)).toMatchInlineSnapshot(`
+		{
+		  "root": {
+		    "anonMode": false,
+		  },
+		}
+	`);
+});
+
+test.skip('Can serialize top-level fields', async () => {
+    const objectToSerialize = {
+        id: 'an-id',
+        message: 'hello-world',
+        number: 1,
+        float: 1.1,
+        flag: true,
+        flag2: false,
+        item: undefined,
+        missing: null,
+        empty: {},
+    };
+
+    const expected = `
+			"id=an-id
+			message=hello-world
+			number=1
+			float=1.1
+			flag="true"
+			flag2="false"
+			[empty]
+			"
+			`
+        .split('\n')
+        .map((line) => line.trim())
+        .join('\n');
+
+    expect(safelySerializeObjectToIni(objectToSerialize)).toMatchInlineSnapshot(expected);
+});

api/src/__test__/core/utils/images/image-file-helpers.test.ts

@@ -1,23 +1,26 @@
-import { getBannerPathIfPresent, getCasePathIfPresent } from "@app/core/utils/images/image-file-helpers";
-import { loadDynamixConfigFile } from "@app/store/actions/load-dynamix-config-file";
-import { store } from "@app/store/index";
+import { expect, test } from 'vitest';
 
-import { expect, test } from "vitest";
+import {
+    getBannerPathIfPresent,
+    getCasePathIfPresent,
+} from '@app/core/utils/images/image-file-helpers.js';
+import { loadDynamixConfigFile } from '@app/store/actions/load-dynamix-config-file.js';
+import { store } from '@app/store/index.js';
 
-test('get case path returns expected result', () => {
-    expect(getCasePathIfPresent()).resolves.toContain('/dev/dynamix/case-model.png')
-})
+test('get case path returns expected result', async () => {
+    await expect(getCasePathIfPresent()).resolves.toContain('/dev/dynamix/case-model.png');
+});
 
-test('get banner path returns null (state unloaded)', () => {
-    expect(getBannerPathIfPresent()).resolves.toMatchInlineSnapshot('null')
-})
+test('get banner path returns null (state unloaded)', async () => {
+    await expect(getBannerPathIfPresent()).resolves.toMatchInlineSnapshot('null');
+});
 
-test('get banner path returns the banner (state loaded)', async() => {
-	await store.dispatch(loadDynamixConfigFile()).unwrap();
-    expect(getBannerPathIfPresent()).resolves.toContain('/dev/dynamix/banner.png');
-})
+test('get banner path returns the banner (state loaded)', async () => {
+    await store.dispatch(loadDynamixConfigFile()).unwrap();
+    await expect(getBannerPathIfPresent()).resolves.toContain('/dev/dynamix/banner.png');
+});
 
 test('get banner path returns null when no banner (state loaded)', async () => {
     await store.dispatch(loadDynamixConfigFile()).unwrap();
-    expect(getBannerPathIfPresent('notabanner.png')).resolves.toMatchInlineSnapshot('null');
-});
+    await expect(getBannerPathIfPresent('notabanner.png')).resolves.toMatchInlineSnapshot('null');
+});

api/src/__test__/core/utils/misc/clean-stdout.test.ts

@@ -0,0 +1,8 @@
+import { expect, test } from 'vitest';
+
+import { cleanStdout } from '@app/core/utils/misc/clean-stdout.js';
+
+test('Returns trimmed stdout from execa command', () => {
+    expect(cleanStdout({ stdout: 'test' })).toBe('test');
+    expect(cleanStdout({ stdout: 'test    ' })).toBe('test');
+});

api/src/__test__/core/utils/misc/get-key-file.test.ts

@@ -0,0 +1,68 @@
+import { expect, test } from 'vitest';
+
+import { store } from '@app/store/index.js';
+import { FileLoadStatus, StateFileKey } from '@app/store/types.js';
+
+import '@app/core/utils/misc/get-key-file.js';
+import '@app/store/modules/emhttp.js';
+
+test('Before loading key returns null', async () => {
+    const { getKeyFile } = await import('@app/core/utils/misc/get-key-file.js');
+    const { status } = store.getState().registration;
+
+    expect(status).toBe(FileLoadStatus.UNLOADED);
+    await expect(getKeyFile()).resolves.toBe(null);
+});
+
+test('Requires emhttp to be loaded to find key file', async () => {
+    const { getKeyFile } = await import('@app/core/utils/misc/get-key-file.js');
+    const { loadRegistrationKey } = await import('@app/store/modules/registration.js');
+
+    // Load registration key into store
+    await store.dispatch(loadRegistrationKey());
+
+    // Check if store has state files loaded
+    const { status } = store.getState().registration;
+    expect(status).toBe(FileLoadStatus.LOADED);
+    await expect(getKeyFile()).resolves.toBe(null);
+});
+
+test('Returns empty key if key location is empty', async () => {
+    const { getKeyFile } = await import('@app/core/utils/misc/get-key-file.js');
+    const { updateEmhttpState } = await import('@app/store/modules/emhttp.js');
+
+    // Set key file location as empty
+    // This should only happen if the user doesn't have a key file
+    store.dispatch(
+        updateEmhttpState({
+            field: StateFileKey.var,
+            state: {
+                regFile: '',
+            },
+        })
+    );
+
+    // Check if store has state files loaded
+    const { status } = store.getState().registration;
+    expect(status).toBe(FileLoadStatus.LOADED);
+    await expect(getKeyFile()).resolves.toBe('');
+});
+
+test(
+    'Returns decoded key file if key location exists',
+    async () => {
+        const { getKeyFile } = await import('@app/core/utils/misc/get-key-file.js');
+        const { loadStateFiles } = await import('@app/store/modules/emhttp.js');
+
+        // Load state files into store
+        await store.dispatch(loadStateFiles());
+
+        // Check if store has state files loaded
+        const { status } = store.getState().registration;
+        expect(status).toBe(FileLoadStatus.LOADED);
+        await expect(getKeyFile()).resolves.toMatchInlineSnapshot(
+            '"hVs1tLjvC9FiiQsIwIQ7G1KszAcexf0IneThhnmf22SB0dGs5WzRkqMiSMmt2DtR5HOXFUD32YyxuzGeUXmky3zKpSu6xhZNKVg5atGM1OfvkzHBMldI3SeBLuUFSgejLbpNUMdTrbk64JJdbzle4O8wiQgkIpAMIGxeYLwLBD4zHBcfyzq40QnxG--HcX6j25eE0xqa2zWj-j0b0rCAXahJV2a3ySCbPzr1MvfPRTVb0rr7KJ-25R592hYrz4H7Sc1B3p0lr6QUxHE6o7bcYrWKDRtIVoZ8SMPpd1_0gzYIcl5GsDFzFumTXUh8NEnl0Q8hwW1YE-tRc6Y_rrvd7w"'
+        );
+    },
+    { timeout: 10000 }
+);

api/src/__test__/core/utils/misc/parse-config.test.ts

@@ -0,0 +1,116 @@
+import { readFile, writeFile } from 'fs/promises';
+
+import { parse } from 'ini';
+import { Parser as MultiIniParser } from 'multi-ini';
+import { expect, test } from 'vitest';
+
+import { safelySerializeObjectToIni } from '@app/core/utils/files/safe-ini-serializer.js';
+import { parseConfig } from '@app/core/utils/misc/parse-config.js';
+
+const iniTestData = `["root"]
+idx="0"
+name="root"
+desc="Console and webGui login account"
+passwd="yes"
+["xo"]
+idx="1"
+name="xo"
+desc=""
+passwd="yes"
+["test_user"]
+idx="2"
+name="test_user"
+desc=""
+passwd="no"`;
+
+test('it loads a config from a passed in ini file successfully', () => {
+    const res = parseConfig<any>({
+        file: iniTestData,
+        type: 'ini',
+    });
+    expect(res).toMatchInlineSnapshot(`
+		{
+		  "root": {
+		    "desc": "Console and webGui login account",
+		    "idx": "0",
+		    "name": "root",
+		    "passwd": "yes",
+		  },
+		  "testUser": {
+		    "desc": "",
+		    "idx": "2",
+		    "name": "test_user",
+		    "passwd": "no",
+		  },
+		  "xo": {
+		    "desc": "",
+		    "idx": "1",
+		    "name": "xo",
+		    "passwd": "yes",
+		  },
+		}
+	`);
+    expect(res?.root.desc).toEqual('Console and webGui login account');
+});
+
+test('it loads a config from disk properly', () => {
+    const path = './dev/states/var.ini';
+    const res = parseConfig<any>({ filePath: path, type: 'ini' });
+    expect(res.DOMAIN_SHORT).toEqual(undefined);
+    expect(res.domainShort).toEqual('');
+    expect(res.shareCount).toEqual('0');
+});
+
+test('Confirm Multi-Ini Parser Still Broken', () => {
+    const parser = new MultiIniParser();
+    const res = parser.parse(iniTestData);
+    expect(res).toMatchInlineSnapshot('{}');
+});
+
+test('Combine Ini and Multi-Ini to read and then write a file with quotes', async () => {
+    const parsedFile = parse(iniTestData);
+    expect(parsedFile).toMatchInlineSnapshot(`
+		{
+		  "root": {
+		    "desc": "Console and webGui login account",
+		    "idx": "0",
+		    "name": "root",
+		    "passwd": "yes",
+		  },
+		  "test_user": {
+		    "desc": "",
+		    "idx": "2",
+		    "name": "test_user",
+		    "passwd": "no",
+		  },
+		  "xo": {
+		    "desc": "",
+		    "idx": "1",
+		    "name": "xo",
+		    "passwd": "yes",
+		  },
+		}
+	`);
+
+    const ini = safelySerializeObjectToIni(parsedFile);
+    await writeFile('/tmp/test.ini', ini);
+    const file = await readFile('/tmp/test.ini', 'utf-8');
+    expect(file).toMatchInlineSnapshot(`
+		"[root]
+		idx="0"
+		name="root"
+		desc="Console and webGui login account"
+		passwd="yes"
+		[xo]
+		idx="1"
+		name="xo"
+		desc=""
+		passwd="yes"
+		[test_user]
+		idx="2"
+		name="test_user"
+		desc=""
+		passwd="no"
+		"
+	`);
+});

api/src/__test__/core/utils/shares/get-shares.test.ts

@@ -1,12 +1,13 @@
 import { expect, test } from 'vitest';
-import { getShares } from '@app/core/utils/shares/get-shares';
-import { store } from '@app/store';
-import { loadStateFiles } from '@app/store/modules/emhttp';
+
+import { getShares } from '@app/core/utils/shares/get-shares.js';
+import { store } from '@app/store/index.js';
+import { loadStateFiles } from '@app/store/modules/emhttp.js';
 
 test('Returns both disk and user shares', async () => {
-	await store.dispatch(loadStateFiles());
+    await store.dispatch(loadStateFiles());
 
-	expect(getShares()).toMatchInlineSnapshot(`
+    expect(getShares()).toMatchInlineSnapshot(`
 		{
 		  "disks": [],
 		  "users": [
@@ -96,8 +97,8 @@ test('Returns both disk and user shares', async () => {
 });
 
 test('Returns shares by type', async () => {
-	await store.dispatch(loadStateFiles());
-	expect(getShares('user')).toMatchInlineSnapshot(`
+    await store.dispatch(loadStateFiles());
+    expect(getShares('user')).toMatchInlineSnapshot(`
 		{
 		  "allocator": "highwater",
 		  "cachePool": "cache",
@@ -119,7 +120,7 @@ test('Returns shares by type', async () => {
 		  "used": 33619300,
 		}
 	`);
-	expect(getShares('users')).toMatchInlineSnapshot(`
+    expect(getShares('users')).toMatchInlineSnapshot(`
 		[
 		  {
 		    "allocator": "highwater",
@@ -203,12 +204,12 @@ test('Returns shares by type', async () => {
 		  },
 		]
 	`);
-	expect(getShares('disk')).toMatchInlineSnapshot('null');
-	expect(getShares('disks')).toMatchInlineSnapshot('[]');
+    expect(getShares('disk')).toMatchInlineSnapshot('null');
+    expect(getShares('disks')).toMatchInlineSnapshot('[]');
 });
 
 test('Returns shares by name', async () => {
-	expect(getShares('user', { name: 'domains' })).toMatchInlineSnapshot(`
+    expect(getShares('user', { name: 'domains' })).toMatchInlineSnapshot(`
 		{
 		  "allocator": "highwater",
 		  "cachePool": "cache",
@@ -230,8 +231,8 @@ test('Returns shares by name', async () => {
 		  "used": 33619300,
 		}
 	`);
-	expect(getShares('user', { name: 'non-existent-user-share' })).toMatchInlineSnapshot('null');
-	// @TODO: disk shares need to be added to the dev ini files
-	expect(getShares('disk', { name: 'disk1' })).toMatchInlineSnapshot('null');
-	expect(getShares('disk', { name: 'non-existent-disk-share' })).toMatchInlineSnapshot('null');
+    expect(getShares('user', { name: 'non-existent-user-share' })).toMatchInlineSnapshot('null');
+    // @TODO: disk shares need to be added to the dev ini files
+    expect(getShares('disk', { name: 'disk1' })).toMatchInlineSnapshot('null');
+    expect(getShares('disk', { name: 'non-existent-disk-share' })).toMatchInlineSnapshot('null');
 });

api/src/__test__/graphql/resolvers/query/cloud/check-mothership-authentication.test.ts

@@ -0,0 +1,29 @@
+import 'reflect-metadata';
+
+import { readFileSync } from 'fs';
+import { join } from 'path';
+
+import { expect, test } from 'vitest';
+
+import { checkMothershipAuthentication } from '@app/graphql/resolvers/query/cloud/check-mothership-authentication.js';
+
+test('It fails to authenticate with mothership with no credentials', async () => {
+    try {
+        const packageJson = JSON.parse(readFileSync(join(process.cwd(), 'package.json'), 'utf-8'));
+        await expect(
+            checkMothershipAuthentication('BAD', 'BAD')
+        ).rejects.toThrowErrorMatchingInlineSnapshot(
+            `[Error: Failed to connect to https://mothership.unraid.net/ws with a "426" HTTP error.]`
+        );
+        expect(packageJson.version).not.toBeNull();
+        await expect(
+            checkMothershipAuthentication(packageJson.version, 'BAD_API_KEY')
+        ).rejects.toThrowErrorMatchingInlineSnapshot(`[Error: Invalid credentials]`);
+    } catch (error) {
+        if (error instanceof Error && error.message.includes('Timeout')) {
+            // Test succeeds on timeout
+            return;
+        }
+        throw error;
+    }
+});

api/src/__test__/graphql/resolvers/subscription/network.test.ts

@@ -0,0 +1,279 @@
+import { expect, test } from 'vitest';
+
+import type { NginxUrlFields } from '@app/graphql/resolvers/subscription/network.js';
+import { type Nginx } from '@app/core/types/states/nginx.js';
+import {
+    getServerIps,
+    getUrlForField,
+    getUrlForServer,
+} from '@app/graphql/resolvers/subscription/network.js';
+import { store } from '@app/store/index.js';
+import { loadConfigFile } from '@app/store/modules/config.js';
+import { loadStateFiles } from '@app/store/modules/emhttp.js';
+
+test.each([
+    [{ httpPort: 80, httpsPort: 443, url: 'my-default-url.com' }],
+    [{ httpPort: 123, httpsPort: 443, url: 'my-default-url.com' }],
+    [{ httpPort: 80, httpsPort: 12_345, url: 'my-default-url.com' }],
+    [{ httpPort: 212, httpsPort: 3_233, url: 'my-default-url.com' }],
+    [{ httpPort: 80, httpsPort: 443, url: 'https://BROKEN_URL' }],
+])('getUrlForField', ({ httpPort, httpsPort, url }) => {
+    const responseInsecure = getUrlForField({
+        port: httpPort,
+        url,
+    });
+
+    const responseSecure = getUrlForField({
+        portSsl: httpsPort,
+        url,
+    });
+    if (httpPort === 80) {
+        expect(responseInsecure.port).toBe('');
+    } else {
+        expect(responseInsecure.port).toBe(httpPort.toString());
+    }
+
+    if (httpsPort === 443) {
+        expect(responseSecure.port).toBe('');
+    } else {
+        expect(responseSecure.port).toBe(httpsPort.toString());
+    }
+});
+
+test('getUrlForServer - field exists, ssl disabled', () => {
+    const result = getUrlForServer({
+        nginx: {
+            lanIp: '192.168.1.1',
+            sslEnabled: false,
+            httpPort: 123,
+            httpsPort: 445,
+        } as const as Nginx,
+        field: 'lanIp',
+    });
+    expect(result).toMatchInlineSnapshot('"http://192.168.1.1:123/"');
+});
+
+test('getUrlForServer - field exists, ssl yes', () => {
+    const result = getUrlForServer({
+        nginx: {
+            lanIp: '192.168.1.1',
+            sslEnabled: true,
+            sslMode: 'yes',
+            httpPort: 123,
+            httpsPort: 445,
+        } as const as Nginx,
+        field: 'lanIp',
+    });
+    expect(result).toMatchInlineSnapshot('"https://192.168.1.1:445/"');
+});
+
+test('getUrlForServer - field exists, ssl yes, port empty', () => {
+    const result = getUrlForServer({
+        nginx: {
+            lanIp: '192.168.1.1',
+            sslEnabled: true,
+            sslMode: 'yes',
+            httpPort: 80,
+            httpsPort: 443,
+        } as const as Nginx,
+        field: 'lanIp',
+    });
+    expect(result).toMatchInlineSnapshot('"https://192.168.1.1/"');
+});
+
+test('getUrlForServer - field exists, ssl auto', async () => {
+    const getResult = async () =>
+        getUrlForServer({
+            nginx: {
+                lanIp: '192.168.1.1',
+                sslEnabled: true,
+                sslMode: 'auto',
+                httpPort: 123,
+                httpsPort: 445,
+            } as const as Nginx,
+            field: 'lanIp',
+        });
+    await expect(getResult).rejects.toThrowErrorMatchingInlineSnapshot(
+        `[Error: Cannot get IP Based URL for field: "lanIp" SSL mode auto]`
+    );
+});
+
+test('getUrlForServer - field does not exist, ssl disabled', async () => {
+    const getResult = async () =>
+        getUrlForServer({
+            nginx: { lanIp: '192.168.1.1', sslEnabled: false, sslMode: 'no' } as const as Nginx,
+            ports: {
+                port: ':123',
+                portSsl: ':445',
+                defaultUrl: new URL('https://my-default-url.unraid.net'),
+            },
+            // @ts-expect-error Field doesn't exist
+            field: 'idontexist',
+        });
+    await expect(getResult).rejects.toThrowErrorMatchingInlineSnapshot(
+        `[Error: IP URL Resolver: Could not resolve any access URL for field: "idontexist", is FQDN?: false]`
+    );
+});
+
+test('getUrlForServer - FQDN - field exists, port non-empty', () => {
+    const result = getUrlForServer({
+        nginx: { lanFqdn: 'my-fqdn.unraid.net', httpsPort: 445 } as unknown as Nginx,
+        field: 'lanFqdn' as NginxUrlFields,
+    });
+    expect(result).toMatchInlineSnapshot('"https://my-fqdn.unraid.net:445/"');
+});
+
+test('getUrlForServer - FQDN - field exists, port empty', () => {
+    const result = getUrlForServer({
+        nginx: { lanFqdn: 'my-fqdn.unraid.net', httpPort: 80, httpsPort: 443 } as unknown as Nginx,
+        field: 'lanFqdn' as NginxUrlFields,
+    });
+    expect(result).toMatchInlineSnapshot('"https://my-fqdn.unraid.net/"');
+});
+
+test.each([
+    [
+        {
+            nginx: {
+                lanFqdn: 'my-fqdn.unraid.net',
+                sslEnabled: false,
+                sslMode: 'no',
+                httpPort: 80,
+                httpsPort: 443,
+            } as unknown as Nginx,
+            field: 'lanFqdn' as NginxUrlFields,
+        },
+    ],
+    [
+        {
+            nginx: {
+                wanFqdn: 'my-fqdn.unraid.net',
+                sslEnabled: true,
+                sslMode: 'yes',
+                httpPort: 80,
+                httpsPort: 443,
+            } as unknown as Nginx,
+            field: 'wanFqdn' as NginxUrlFields,
+        },
+    ],
+    [
+        {
+            nginx: {
+                wanFqdn6: 'my-fqdn.unraid.net',
+                sslEnabled: true,
+                sslMode: 'auto',
+                httpPort: 80,
+                httpsPort: 443,
+            } as unknown as Nginx,
+            field: 'wanFqdn6' as NginxUrlFields,
+        },
+    ],
+])('getUrlForServer - FQDN', ({ nginx, field }) => {
+    const result = getUrlForServer({ nginx, field });
+    expect(result.toString()).toBe('https://my-fqdn.unraid.net/');
+});
+
+test('getUrlForServer - field does not exist, ssl disabled', async () => {
+    const getResult = async () =>
+        getUrlForServer({
+            nginx: { lanFqdn: 'my-fqdn.unraid.net' } as unknown as Nginx,
+            ports: { portSsl: '', port: '', defaultUrl: new URL('https://my-default-url.unraid.net') },
+            // @ts-expect-error Field doesn't exist
+            field: 'idontexist',
+        });
+    await expect(getResult).rejects.toThrowErrorMatchingInlineSnapshot(
+        `[Error: IP URL Resolver: Could not resolve any access URL for field: "idontexist", is FQDN?: false]`
+    );
+});
+
+test('integration test, loading nginx ini and generating all URLs', async () => {
+    await store.dispatch(loadStateFiles());
+    await store.dispatch(loadConfigFile());
+
+    const urls = getServerIps();
+    expect(urls.urls).toMatchInlineSnapshot(`
+		[
+		  {
+		    "ipv4": "https://tower.local:4443/",
+		    "ipv6": "https://tower.local:4443/",
+		    "name": "Default",
+		    "type": "DEFAULT",
+		  },
+		  {
+		    "ipv4": "https://192.168.1.150:4443/",
+		    "name": "LAN IPv4",
+		    "type": "LAN",
+		  },
+		  {
+		    "ipv4": "https://tower:4443/",
+		    "name": "LAN Name",
+		    "type": "MDNS",
+		  },
+		  {
+		    "ipv4": "https://tower.local:4443/",
+		    "name": "LAN MDNS",
+		    "type": "MDNS",
+		  },
+		  {
+		    "ipv4": "https://192-168-1-150.thisisfourtyrandomcharacters012345678900.myunraid.net:4443/",
+		    "name": "FQDN LAN",
+		    "type": "LAN",
+		  },
+		  {
+		    "ipv4": "https://85-121-123-122.thisisfourtyrandomcharacters012345678900.myunraid.net:8443/",
+		    "name": "FQDN WAN",
+		    "type": "WAN",
+		  },
+		  {
+		    "ipv4": "https://10-252-0-1.hash.myunraid.net:4443/",
+		    "name": "FQDN WG 0",
+		    "type": "WIREGUARD",
+		  },
+		  {
+		    "ipv4": "https://10-252-1-1.hash.myunraid.net:4443/",
+		    "name": "FQDN WG 1",
+		    "type": "WIREGUARD",
+		  },
+		  {
+		    "ipv4": "https://10-253-3-1.hash.myunraid.net:4443/",
+		    "name": "FQDN WG 2",
+		    "type": "WIREGUARD",
+		  },
+		  {
+		    "ipv4": "https://10-253-4-1.hash.myunraid.net:4443/",
+		    "name": "FQDN WG 3",
+		    "type": "WIREGUARD",
+		  },
+		  {
+		    "ipv4": "https://10-253-5-1.hash.myunraid.net:4443/",
+		    "name": "FQDN WG 4",
+		    "type": "WIREGUARD",
+		  },
+		  {
+		    "ipv4": "https://10-100-0-1.hash.myunraid.net:4443/",
+		    "name": "FQDN TAILSCALE 0",
+		    "type": "WIREGUARD",
+		  },
+		  {
+		    "ipv4": "https://10-100-0-2.hash.myunraid.net:4443/",
+		    "name": "FQDN TAILSCALE 1",
+		    "type": "WIREGUARD",
+		  },
+		  {
+		    "ipv4": "https://10-123-1-2.hash.myunraid.net:4443/",
+		    "name": "FQDN CUSTOM 0",
+		    "type": "WIREGUARD",
+		  },
+		  {
+		    "ipv4": "https://221-123-121-112.hash.myunraid.net:4443/",
+		    "name": "FQDN CUSTOM 1",
+		    "type": "WIREGUARD",
+		  },
+		]
+	`);
+    expect(urls.errors).toMatchInlineSnapshot(`
+		[
+		  [Error: IP URL Resolver: Could not resolve any access URL for field: "lanIp6", is FQDN?: false],
+		]
+	`);
+});

api/src/__test__/json-forms.test.ts

@@ -0,0 +1,180 @@
+import type { ControlElement } from '@jsonforms/core';
+import { describe, expect, it } from 'vitest';
+
+import type { SettingSlice } from '@app/unraid-api/types/json-forms.js';
+import { createEmptySettingSlice, mergeSettingSlices } from '@app/unraid-api/types/json-forms.js';
+
+describe('mergeSettingSlices', () => {
+    it('returns an empty slice when given an empty array', () => {
+        const result = mergeSettingSlices([]);
+        expect(result).toEqual(createEmptySettingSlice());
+    });
+
+    it('returns the same slice when given a single slice', () => {
+        const slice: SettingSlice = {
+            properties: {
+                test: { type: 'string' },
+            },
+            elements: [{ type: 'Control', scope: '#/properties/test' }],
+        };
+
+        const result = mergeSettingSlices([slice]);
+        expect(result).toEqual(slice);
+    });
+
+    it('merges properties and concatenates elements from multiple slices', () => {
+        const slice1: SettingSlice = {
+            properties: {
+                prop1: { type: 'string' },
+            },
+            elements: [{ type: 'Control', scope: '#/properties/prop1' }],
+        };
+
+        const slice2: SettingSlice = {
+            properties: {
+                prop2: { type: 'number' },
+            },
+            elements: [{ type: 'Control', scope: '#/properties/prop2' }],
+        };
+
+        const expected: SettingSlice = {
+            properties: {
+                prop1: { type: 'string' },
+                prop2: { type: 'number' },
+            },
+            elements: [
+                { type: 'Control', scope: '#/properties/prop1' },
+                { type: 'Control', scope: '#/properties/prop2' },
+            ],
+        };
+
+        const result = mergeSettingSlices([slice1, slice2]);
+        expect(result).toEqual(expected);
+    });
+
+    it('handles more complex schema properties and UI elements', () => {
+        const slice1: SettingSlice = {
+            properties: {
+                name: {
+                    type: 'string',
+                    title: 'Name',
+                    minLength: 3,
+                },
+            },
+            elements: [
+                {
+                    type: 'Control',
+                    scope: '#/properties/name',
+                    label: 'Full Name',
+                } as ControlElement,
+            ],
+        };
+
+        const slice2: SettingSlice = {
+            properties: {
+                age: {
+                    type: 'number',
+                    title: 'Age',
+                    minimum: 0,
+                    maximum: 120,
+                },
+            },
+            elements: [
+                {
+                    type: 'Control',
+                    scope: '#/properties/age',
+                    label: 'Your Age',
+                } as ControlElement,
+            ],
+        };
+
+        const slice3: SettingSlice = {
+            properties: {
+                active: {
+                    type: 'boolean',
+                    title: 'Active Status',
+                    default: true,
+                },
+            },
+            elements: [
+                {
+                    type: 'Control',
+                    scope: '#/properties/active',
+                    label: 'Is Active',
+                    options: {
+                        toggle: true,
+                    },
+                } as ControlElement,
+            ],
+        };
+
+        const result = mergeSettingSlices([slice1, slice2, slice3]);
+
+        // Check properties were merged correctly
+        expect(result.properties).toHaveProperty('name');
+        expect(result.properties).toHaveProperty('age');
+        expect(result.properties).toHaveProperty('active');
+        expect(result.properties.name.type).toBe('string');
+        expect(result.properties.age.type).toBe('number');
+        expect(result.properties.active.type).toBe('boolean');
+
+        // Check elements were concatenated in order
+        expect(result.elements).toHaveLength(3);
+        expect(result.elements[0]).toEqual(slice1.elements[0]);
+        expect(result.elements[1]).toEqual(slice2.elements[0]);
+        expect(result.elements[2]).toEqual(slice3.elements[0]);
+    });
+
+    it('later properties override earlier ones with the same key', () => {
+        const slice1: SettingSlice = {
+            properties: {
+                prop: { type: 'string', title: 'Original' },
+            },
+            elements: [
+                { type: 'Control', scope: '#/properties/prop', label: 'First' } as ControlElement,
+            ],
+        };
+
+        const slice2: SettingSlice = {
+            properties: {
+                prop: { type: 'number', title: 'Override' },
+            },
+            elements: [
+                { type: 'Control', scope: '#/properties/prop', label: 'Second' } as ControlElement,
+            ],
+        };
+
+        const result = mergeSettingSlices([slice1, slice2]);
+
+        // The property from slice2 should override the one from slice1
+        expect(result.properties.prop.type).toBe('number');
+        expect(result.properties.prop.title).toBe('Override');
+
+        // Both elements should be present
+        expect(result.elements).toHaveLength(2);
+        expect((result.elements[0] as ControlElement).label).toBe('First');
+        expect((result.elements[1] as ControlElement).label).toBe('Second');
+    });
+
+    it('preserves empty properties and elements', () => {
+        const slice1: SettingSlice = {
+            properties: {},
+            elements: [],
+        };
+
+        const slice2: SettingSlice = {
+            properties: {
+                prop: { type: 'string' },
+            },
+            elements: [{ type: 'Control', scope: '#/properties/prop' }],
+        };
+
+        const result = mergeSettingSlices([slice1, slice2]);
+        expect(result.properties).toHaveProperty('prop');
+        expect(result.elements).toHaveLength(1);
+
+        const result2 = mergeSettingSlices([slice2, slice1]);
+        expect(result2.properties).toHaveProperty('prop');
+        expect(result2.elements).toHaveLength(1);
+    });
+});

api/src/__test__/mothership/index.test.ts

@@ -0,0 +1,48 @@
+import { beforeEach, expect, test, vi } from 'vitest';
+
+// Preloading imports for faster tests
+import '@app/mothership/utils/convert-to-fuzzy-time.js';
+
+vi.mock('fs', () => ({
+    default: {
+        readFileSync: vi.fn().mockReturnValue('my-file'),
+        writeFileSync: vi.fn(),
+        existsSync: vi.fn(),
+    },
+    readFileSync: vi.fn().mockReturnValue('my-file'),
+    existsSync: vi.fn(),
+}));
+
+vi.mock('@graphql-tools/schema', () => ({
+    makeExecutableSchema: vi.fn(),
+}));
+
+vi.mock('@app/core/log.js', () => ({
+    default: { relayLogger: { trace: vi.fn() } },
+    relayLogger: { trace: vi.fn() },
+    logger: { trace: vi.fn() },
+}));
+
+beforeEach(() => {
+    vi.resetModules();
+    vi.clearAllMocks();
+});
+
+const generateTestCases = () => {
+    const cases: Array<{ min: number; max: number }> = [];
+    for (let i = 0; i < 15; i += 1) {
+        const min = Math.round(Math.random() * 100);
+        const max = min + Math.round(Math.random() * 20);
+        cases.push({ min, max });
+    }
+
+    return cases;
+};
+
+test.each(generateTestCases())('Successfully converts to fuzzy time %o', async ({ min, max }) => {
+    const { convertToFuzzyTime } = await import('@app/mothership/utils/convert-to-fuzzy-time.js');
+
+    const res = convertToFuzzyTime(min, max);
+    expect(res).toBeGreaterThanOrEqual(min);
+    expect(res).toBeLessThanOrEqual(max);
+});

api/src/__test__/setup/child-process-easy-to-kill.js

@@ -0,0 +1,6 @@
+/* eslint-disable */
+process.title = 'unraid-api';
+
+setInterval(() => {
+    console.log('I NEED TO DIE');
+}, 5_000);

api/src/__test__/setup/child-process-hard-to-kill.js

@@ -0,0 +1,10 @@
+/* eslint-disable */
+process.title = 'unraid-api';
+setInterval(() => {
+	console.log('I NEED TO DIE (but i am very hard to kill)');
+}, 5_000);
+
+process.on('SIGTERM', () => {
+	// Do nothing
+	console.log('you cant kill me haha');
+});

api/src/__test__/setup/env-setup.ts

@@ -0,0 +1,7 @@
+import { config } from 'dotenv';
+
+config({
+    path: './.env.test',
+    debug: false,
+    encoding: 'utf-8',
+});

api/src/__test__/setup/keyserver-mock.ts

@@ -0,0 +1,6 @@
+import { vi } from 'vitest';
+
+vi.mock('@app/core/utils/misc/send-form-to-keyserver.js', () => {
+    const sendFormToKeyServer = vi.fn().mockResolvedValue({ body: JSON.stringify({ valid: true }) });
+    return { sendFormToKeyServer };
+});

api/src/__test__/store/modules/__snapshots__/config.test.ts.snap

@@ -0,0 +1,36 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`Before init returns default values for all fields 1`] = `
+{
+  "api": {
+    "extraOrigins": "",
+    "version": "",
+  },
+  "connectionStatus": {
+    "minigraph": "PRE_INIT",
+    "upnpStatus": "",
+  },
+  "local": {
+    "sandbox": "no",
+  },
+  "nodeEnv": "test",
+  "remote": {
+    "accesstoken": "",
+    "allowedOrigins": "",
+    "apikey": "",
+    "avatar": "",
+    "dynamicRemoteAccessType": "DISABLED",
+    "email": "",
+    "idtoken": "",
+    "localApiKey": "",
+    "refreshtoken": "",
+    "regWizTime": "",
+    "ssoSubIds": "",
+    "upnpEnabled": "",
+    "username": "",
+    "wanaccess": "",
+    "wanport": "",
+  },
+  "status": "UNLOADED",
+}
+`;

api/src/__test__/store/modules/__snapshots__/notifications.test.ts.snap

@@ -6,7 +6,7 @@ exports[`loads notifications properly 1`] = `
     "description": "Canceled",
     "id": "/app/dev/notifications/unread/Unraid_Parity_check_1683971161.notify",
     "importance": "WARNING",
-    "link": undefined,
+    "link": "/",
     "subject": "Notice [UNRAID] - Parity check finished (0 errors)",
     "timestamp": "2023-05-13T09:46:01.000Z",
     "title": "Unraid Parity check",

api/src/__test__/store/modules/config.test.ts

@@ -0,0 +1,103 @@
+import { expect, test } from 'vitest';
+
+import { store } from '@app/store/index.js';
+import { MyServersConfigMemory } from '@app/types/my-servers-config.js';
+
+test('Before init returns default values for all fields', async () => {
+    const state = store.getState().config;
+    expect(state).toMatchSnapshot();
+}, 10_000);
+
+test('After init returns values from cfg file for all fields', async () => {
+    const { loadConfigFile } = await import('@app/store/modules/config.js');
+
+    // Load cfg into store
+    await store.dispatch(loadConfigFile());
+
+    // Check if store has cfg contents loaded
+    const state = store.getState().config;
+    expect(state).toMatchObject(
+        expect.objectContaining({
+            api: {
+                extraOrigins: expect.stringMatching('https://google.com,https://test.com'),
+                version: expect.any(String),
+            },
+            connectionStatus: {
+                minigraph: 'PRE_INIT',
+                upnpStatus: '',
+            },
+            local: {
+                sandbox: expect.any(String),
+            },
+            nodeEnv: 'test',
+            remote: {
+                accesstoken: '',
+                allowedOrigins: '',
+                apikey: '_______________________BIG_API_KEY_HERE_________________________',
+                avatar: 'https://via.placeholder.com/200',
+                dynamicRemoteAccessType: 'DISABLED',
+                email: 'test@example.com',
+                idtoken: '',
+                localApiKey: '_______________________LOCAL_API_KEY_HERE_________________________',
+                refreshtoken: '',
+                regWizTime: '1611175408732_0951-1653-3509-FBA155FA23C0',
+                ssoSubIds: '',
+                upnpEnabled: 'no',
+                username: 'zspearmint',
+                wanaccess: 'yes',
+                wanport: '8443',
+            },
+            status: 'LOADED',
+        })
+    );
+});
+
+test('updateUserConfig merges in changes to current state', async () => {
+    const { loadConfigFile, updateUserConfig } = await import('@app/store/modules/config.js');
+
+    // Load cfg into store
+    await store.dispatch(loadConfigFile());
+
+    // Update store
+    store.dispatch(
+        updateUserConfig({
+            remote: { avatar: 'https://via.placeholder.com/200' },
+        })
+    );
+
+    const state = store.getState().config;
+    expect(state).toMatchObject(
+        expect.objectContaining({
+            api: {
+                extraOrigins: expect.stringMatching('https://google.com,https://test.com'),
+                version: expect.any(String),
+            },
+            connectionStatus: {
+                minigraph: 'PRE_INIT',
+                upnpStatus: '',
+            },
+            local: {
+                sandbox: expect.any(String),
+            },
+            nodeEnv: 'test',
+            remote: {
+                accesstoken: '',
+                allowedOrigins: '',
+                apikey: '_______________________BIG_API_KEY_HERE_________________________',
+                avatar: 'https://via.placeholder.com/200',
+                dynamicRemoteAccessType: 'DISABLED',
+                email: 'test@example.com',
+                idtoken: '',
+                localApiKey: '_______________________LOCAL_API_KEY_HERE_________________________',
+                refreshtoken: '',
+                regWizTime: '1611175408732_0951-1653-3509-FBA155FA23C0',
+                ssoSubIds: '',
+                upnpEnabled: 'no',
+                username: 'zspearmint',
+                wanaccess: 'yes',
+                wanport: '8443',
+            },
+            status: 'LOADED',
+        } as MyServersConfigMemory)
+    );
+});

api/src/__test__/store/modules/emhttp.test.ts

@@ -1,14 +1,15 @@
-import { test, expect } from 'vitest';
-import { store } from '@app/store';
-import { FileLoadStatus } from '@app/store/types';
+import { expect, test } from 'vitest';
+
+import { store } from '@app/store/index.js';
+import { FileLoadStatus } from '@app/store/types.js';
 
 // Preloading imports for faster tests
-import '@app/store/modules/emhttp';
+import '@app/store/modules/emhttp.js';
 
 test('Before init returns default values for all fields', async () => {
-	const { status, ...state } = store.getState().emhttp;
-	expect(status).toBe(FileLoadStatus.UNLOADED);
-	expect(state).toMatchInlineSnapshot(`
+    const { status, ...state } = store.getState().emhttp;
+    expect(status).toBe(FileLoadStatus.UNLOADED);
+    expect(state).toMatchInlineSnapshot(`
 		{
 		  "devices": [],
 		  "disks": [],
@@ -24,16 +25,27 @@ test('Before init returns default values for all fields', async () => {
 });
 
 test('After init returns values from cfg file for all fields', async () => {
-	const { loadStateFiles } = await import('@app/store/modules/emhttp');
+    const { loadStateFiles } = await import('@app/store/modules/emhttp.js');
 
-	// Load state files into store
-	await store.dispatch(loadStateFiles());
+    // Load state files into store
+    await store.dispatch(loadStateFiles());
 
-	// Check if store has state files loaded
-	const { devices, networks, nfsShares, nginx, shares, disks, smbShares, status, users, var: varState } = store.getState().emhttp;
-	expect(status).toBe(FileLoadStatus.LOADED);
-	expect(devices).toMatchInlineSnapshot('[]');
-	expect(networks).toMatchInlineSnapshot(`
+    // Check if store has state files loaded
+    const {
+        devices,
+        networks,
+        nfsShares,
+        nginx,
+        shares,
+        disks,
+        smbShares,
+        status,
+        users,
+        var: varState,
+    } = store.getState().emhttp;
+    expect(status).toBe(FileLoadStatus.LOADED);
+    expect(devices).toMatchInlineSnapshot('[]');
+    expect(networks).toMatchInlineSnapshot(`
 		[
 		  {
 		    "bonding": true,
@@ -99,15 +111,81 @@ test('After init returns values from cfg file for all fields', async () => {
 		  },
 		]
 	`);
-	expect(nginx).toMatchInlineSnapshot(`
+    expect(nginx).toMatchInlineSnapshot(`
 		{
 		  "certificateName": "*.thisisfourtyrandomcharacters012345678900.myunraid.net",
 		  "certificatePath": "/boot/config/ssl/certs/certificate_bundle.pem",
 		  "defaultUrl": "https://Tower.local:4443",
+		  "fqdnUrls": [
+		    {
+		      "fqdn": "192-168-1-150.thisisfourtyrandomcharacters012345678900.myunraid.net",
+		      "id": null,
+		      "interface": "LAN",
+		      "isIpv6": false,
+		    },
+		    {
+		      "fqdn": "85-121-123-122.thisisfourtyrandomcharacters012345678900.myunraid.net",
+		      "id": null,
+		      "interface": "WAN",
+		      "isIpv6": false,
+		    },
+		    {
+		      "fqdn": "10-252-0-1.hash.myunraid.net",
+		      "id": 0,
+		      "interface": "WG",
+		      "isIpv6": false,
+		    },
+		    {
+		      "fqdn": "10-252-1-1.hash.myunraid.net",
+		      "id": 1,
+		      "interface": "WG",
+		      "isIpv6": false,
+		    },
+		    {
+		      "fqdn": "10-253-3-1.hash.myunraid.net",
+		      "id": 2,
+		      "interface": "WG",
+		      "isIpv6": false,
+		    },
+		    {
+		      "fqdn": "10-253-4-1.hash.myunraid.net",
+		      "id": 3,
+		      "interface": "WG",
+		      "isIpv6": false,
+		    },
+		    {
+		      "fqdn": "10-253-5-1.hash.myunraid.net",
+		      "id": 4,
+		      "interface": "WG",
+		      "isIpv6": false,
+		    },
+		    {
+		      "fqdn": "10-100-0-1.hash.myunraid.net",
+		      "id": 0,
+		      "interface": "TAILSCALE",
+		      "isIpv6": false,
+		    },
+		    {
+		      "fqdn": "10-100-0-2.hash.myunraid.net",
+		      "id": 1,
+		      "interface": "TAILSCALE",
+		      "isIpv6": false,
+		    },
+		    {
+		      "fqdn": "10-123-1-2.hash.myunraid.net",
+		      "id": 0,
+		      "interface": "CUSTOM",
+		      "isIpv6": false,
+		    },
+		    {
+		      "fqdn": "221-123-121-112.hash.myunraid.net",
+		      "id": 1,
+		      "interface": "CUSTOM",
+		      "isIpv6": true,
+		    },
+		  ],
 		  "httpPort": 8080,
 		  "httpsPort": 4443,
-		  "lanFqdn": "192-168-1-150.thisisfourtyrandomcharacters012345678900.myunraid.net",
-		  "lanFqdn6": "",
 		  "lanIp": "192.168.1.150",
 		  "lanIp6": "",
 		  "lanMdns": "Tower.local",
@@ -115,34 +193,10 @@ test('After init returns values from cfg file for all fields', async () => {
 		  "sslEnabled": true,
 		  "sslMode": "yes",
 		  "wanAccessEnabled": false,
-		  "wanFqdn": "85-121-123-122.thisisfourtyrandomcharacters012345678900.myunraid.net",
-		  "wanFqdn6": "",
 		  "wanIp": "",
-		  "wgFqdns": [
-		    {
-		      "fqdn": "10-252-0-1.hash.myunraid.net",
-		      "id": 0,
-		    },
-		    {
-		      "fqdn": "10-252-1-1.hash.myunraid.net",
-		      "id": 1,
-		    },
-		    {
-		      "fqdn": "10-253-3-1.hash.myunraid.net",
-		      "id": 3,
-		    },
-		    {
-		      "fqdn": "10-253-4-1.hash.myunraid.net",
-		      "id": 4,
-		    },
-		    {
-		      "fqdn": "10-253-5-1.hash.myunraid.net",
-		      "id": 55,
-		    },
-		  ],
 		}
 	`);
-	expect(disks).toMatchInlineSnapshot(`
+    expect(disks).toMatchInlineSnapshot(`
 		[
 		  {
 		    "comment": null,
@@ -314,7 +368,7 @@ test('After init returns values from cfg file for all fields', async () => {
 		  },
 		]
 	`);
-	expect(shares).toMatchInlineSnapshot(`
+    expect(shares).toMatchInlineSnapshot(`
 		[
 		  {
 		    "allocator": "highwater",
@@ -390,7 +444,7 @@ test('After init returns values from cfg file for all fields', async () => {
 		  },
 		]
 	`);
-	expect(nfsShares).toMatchInlineSnapshot(`
+    expect(nfsShares).toMatchInlineSnapshot(`
 		[
 		  {
 		    "enabled": false,
@@ -578,7 +632,7 @@ test('After init returns values from cfg file for all fields', async () => {
 		  },
 		]
 	`);
-	expect(smbShares).toMatchInlineSnapshot(`
+    expect(smbShares).toMatchInlineSnapshot(`
 		[
 		  {
 		    "caseSensitive": "auto",
@@ -869,7 +923,7 @@ test('After init returns values from cfg file for all fields', async () => {
 		  },
 		]
 	`);
-	expect(users).toMatchInlineSnapshot(`
+    expect(users).toMatchInlineSnapshot(`
 		[
 		  {
 		    "description": "Console and webGui login account",
@@ -894,7 +948,7 @@ test('After init returns values from cfg file for all fields', async () => {
 		  },
 		]
 	`);
-	expect(varState).toMatchInlineSnapshot(`
+    expect(varState).toMatchInlineSnapshot(`
 		{
 		  "bindMgt": false,
 		  "cacheNumDevices": NaN,
@@ -984,6 +1038,7 @@ test('After init returns values from cfg file for all fields', async () => {
 		  "porttelnet": 23,
 		  "queueDepth": "auto",
 		  "regCheck": "Valid",
+		  "regExp": "",
 		  "regFile": "/app/dev/Unraid.net/Pro.key",
 		  "regGen": "0",
 		  "regGuid": "13FE-4200-C300-58C372A52B19",

api/src/__test__/store/modules/notifications.test.ts

@@ -1,14 +0,0 @@
-import { setupNotificationWatch } from '@app/core/modules/notifications/setup-notification-watch';
-import { sleep } from '@app/core/utils/misc/sleep';
-import { loadDynamixConfigFile } from '@app/store/actions/load-dynamix-config-file';
-import { store } from '@app/store/index';
-import { expect, test } from 'vitest';
-
-test('loads notifications properly', async () => {
-    await store.dispatch(loadDynamixConfigFile()).unwrap();
-    const watch = await setupNotificationWatch();
-    expect(watch).not.toBeNull();
-    await sleep(400);
-    expect(store.getState().notifications.notifications).toMatchSnapshot();
-    await watch?.close();
-});

api/src/__test__/store/modules/paths.test.ts

@@ -1,9 +1,10 @@
 import { expect, test } from 'vitest';
-import { store } from '@app/store';
+
+import { store } from '@app/store/index.js';
 
 test('Returns paths', async () => {
-	const { paths } = store.getState();
-	expect(Object.keys(paths)).toMatchInlineSnapshot(`
+    const { paths } = store.getState();
+    expect(Object.keys(paths)).toMatchInlineSnapshot(`
 		[
 		  "core",
 		  "unraid-api-base",
@@ -20,10 +21,14 @@ test('Returns paths', async () => {
 		  "myservers-config",
 		  "myservers-config-states",
 		  "myservers-env",
+		  "myservers-keepalive",
 		  "keyfile-base",
 		  "machine-id",
 		  "log-base",
+		  "unraid-log-base",
 		  "var-run",
+		  "auth-sessions",
+		  "auth-keys",
 		]
 	`);
 });

api/src/__test__/store/modules/registration.test.ts

@@ -0,0 +1,48 @@
+import { expect, test } from 'vitest';
+
+import { store } from '@app/store/index.js';
+import { loadRegistrationKey } from '@app/store/modules/registration.js';
+import { FileLoadStatus, StateFileKey } from '@app/store/types.js';
+
+// Preloading imports for faster tests
+
+test('Before loading key returns null', async () => {
+    const { status, keyFile } = store.getState().registration;
+    expect(status).toBe(FileLoadStatus.UNLOADED);
+    expect(keyFile).toBe(null);
+});
+
+test('Requires emhttp to be loaded to find key file', async () => {
+    // Load registration key into store
+    await store.dispatch(loadRegistrationKey());
+
+    // Check if store has state files loaded
+    const { status, keyFile } = store.getState().registration;
+
+    expect(status).toBe(FileLoadStatus.LOADED);
+    expect(keyFile).toBe(null);
+});
+
+test('Returns empty key if key location is empty', async () => {
+    const { updateEmhttpState } = await import('@app/store/modules/emhttp.js');
+    const { loadRegistrationKey } = await import('@app/store/modules/registration.js');
+
+    // Set key file location as empty
+    // This should only happen if the user doesn't have a key file
+    store.dispatch(
+        updateEmhttpState({
+            field: StateFileKey.var,
+            state: {
+                regFile: '',
+            },
+        })
+    );
+
+    // Load registration key into store
+    await store.dispatch(loadRegistrationKey());
+
+    // Check if store has state files loaded
+    const { status, keyFile } = store.getState().registration;
+    expect(status).toBe(FileLoadStatus.LOADED);
+    expect(keyFile).toBe('');
+});

api/src/__test__/store/state-parsers/__snapshots__/nginx.test.ts.snap

@@ -0,0 +1,87 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`Returns parsed state file 1`] = `
+{
+  "certificateName": "*.thisisfourtyrandomcharacters012345678900.myunraid.net",
+  "certificatePath": "/boot/config/ssl/certs/certificate_bundle.pem",
+  "defaultUrl": "https://Tower.local:4443",
+  "fqdnUrls": [
+    {
+      "fqdn": "192-168-1-150.thisisfourtyrandomcharacters012345678900.myunraid.net",
+      "id": null,
+      "interface": "LAN",
+      "isIpv6": false,
+    },
+    {
+      "fqdn": "85-121-123-122.thisisfourtyrandomcharacters012345678900.myunraid.net",
+      "id": null,
+      "interface": "WAN",
+      "isIpv6": false,
+    },
+    {
+      "fqdn": "10-252-0-1.hash.myunraid.net",
+      "id": 0,
+      "interface": "WG",
+      "isIpv6": false,
+    },
+    {
+      "fqdn": "10-252-1-1.hash.myunraid.net",
+      "id": 1,
+      "interface": "WG",
+      "isIpv6": false,
+    },
+    {
+      "fqdn": "10-253-3-1.hash.myunraid.net",
+      "id": 2,
+      "interface": "WG",
+      "isIpv6": false,
+    },
+    {
+      "fqdn": "10-253-4-1.hash.myunraid.net",
+      "id": 3,
+      "interface": "WG",
+      "isIpv6": false,
+    },
+    {
+      "fqdn": "10-253-5-1.hash.myunraid.net",
+      "id": 4,
+      "interface": "WG",
+      "isIpv6": false,
+    },
+    {
+      "fqdn": "10-100-0-1.hash.myunraid.net",
+      "id": 0,
+      "interface": "TAILSCALE",
+      "isIpv6": false,
+    },
+    {
+      "fqdn": "10-100-0-2.hash.myunraid.net",
+      "id": 1,
+      "interface": "TAILSCALE",
+      "isIpv6": false,
+    },
+    {
+      "fqdn": "10-123-1-2.hash.myunraid.net",
+      "id": 0,
+      "interface": "CUSTOM",
+      "isIpv6": false,
+    },
+    {
+      "fqdn": "221-123-121-112.hash.myunraid.net",
+      "id": 1,
+      "interface": "CUSTOM",
+      "isIpv6": true,
+    },
+  ],
+  "httpPort": 8080,
+  "httpsPort": 4443,
+  "lanIp": "192.168.1.150",
+  "lanIp6": "",
+  "lanMdns": "Tower.local",
+  "lanName": "Tower",
+  "sslEnabled": true,
+  "sslMode": "yes",
+  "wanAccessEnabled": false,
+  "wanIp": "",
+}
+`;

api/src/__test__/store/state-parsers/devices.test.ts

@@ -0,0 +1,18 @@
+import { join } from 'path';
+
+import { expect, test } from 'vitest';
+
+import type { DevicesIni } from '@app/store/state-parsers/devices.js';
+import { store } from '@app/store/index.js';
+
+test('Returns parsed state file', async () => {
+    const { parse } = await import('@app/store/state-parsers/devices.js');
+    const { parseConfig } = await import('@app/core/utils/misc/parse-config.js');
+    const { paths } = store.getState();
+    const filePath = join(paths.states, 'devs.ini');
+    const stateFile = parseConfig<DevicesIni>({
+        filePath,
+        type: 'ini',
+    });
+    expect(parse(stateFile)).toMatchInlineSnapshot('[]');
+});

api/src/__test__/store/state-parsers/network.test.ts

@@ -0,0 +1,83 @@
+import { join } from 'path';
+
+import { expect, test } from 'vitest';
+
+import type { NetworkIni } from '@app/store/state-parsers/network.js';
+import { store } from '@app/store/index.js';
+
+test('Returns parsed state file', async () => {
+    const { parse } = await import('@app/store/state-parsers/network.js');
+    const { parseConfig } = await import('@app/core/utils/misc/parse-config.js');
+    const { paths } = store.getState();
+    const filePath = join(paths.states, 'network.ini');
+    const stateFile = parseConfig<NetworkIni>({
+        filePath,
+        type: 'ini',
+    });
+    expect(parse(stateFile)).toMatchInlineSnapshot(`
+		[
+		  {
+		    "bonding": true,
+		    "bondingMiimon": "100",
+		    "bondingMode": "1",
+		    "bondname": "",
+		    "bondnics": [
+		      "eth0",
+		      "eth1",
+		      "eth2",
+		      "eth3",
+		    ],
+		    "brfd": "0",
+		    "bridging": true,
+		    "brname": "",
+		    "brnics": "bond0",
+		    "brstp": "0",
+		    "description": [
+		      "",
+		    ],
+		    "dhcp6Keepresolv": false,
+		    "dhcpKeepresolv": false,
+		    "dnsServer1": "1.1.1.1",
+		    "dnsServer2": "8.8.8.8",
+		    "gateway": [
+		      "192.168.1.1",
+		    ],
+		    "gateway6": [
+		      "",
+		    ],
+		    "ipaddr": [
+		      "192.168.1.150",
+		    ],
+		    "ipaddr6": [
+		      "",
+		    ],
+		    "metric": [
+		      "",
+		    ],
+		    "metric6": [
+		      "",
+		    ],
+		    "mtu": "",
+		    "netmask": [
+		      "255.255.255.0",
+		    ],
+		    "netmask6": [
+		      "",
+		    ],
+		    "privacy6": [
+		      "",
+		    ],
+		    "protocol": [
+		      "",
+		    ],
+		    "type": "access",
+		    "useDhcp": [
+		      true,
+		    ],
+		    "useDhcp6": [
+		      false,
+		    ],
+		  },
+		]
+	`);
+});