fix(api): return proper json objects (LizardByte#3544)

Author: ReenigneArcher

.github/workflows/CI.yml

@@ -887,7 +887,6 @@ jobs:
             mingw-w64-ucrt-x86_64-graphviz
             mingw-w64-ucrt-x86_64-MinHook
             mingw-w64-ucrt-x86_64-miniupnpc
-            mingw-w64-ucrt-x86_64-nlohmann-json
             mingw-w64-ucrt-x86_64-nodejs
             mingw-w64-ucrt-x86_64-nsis
             mingw-w64-ucrt-x86_64-onevpl

cmake/compile_definitions/common.cmake

@@ -149,6 +149,7 @@ list(APPEND SUNSHINE_EXTERNAL_LIBRARIES
         ${CMAKE_THREAD_LIBS_INIT}
         enet
         libdisplaydevice::display_device
+        nlohmann_json::nlohmann_json
         opus
         ${FFMPEG_LIBRARIES}
         ${Boost_LIBRARIES}

cmake/compile_definitions/windows.cmake

@@ -76,7 +76,6 @@ list(PREPEND PLATFORM_LIBRARIES
         libstdc++.a
         libwinpthread.a
         minhook::minhook
-        nlohmann_json::nlohmann_json
         ntdll
         setupapi
         shlwapi

cmake/dependencies/common.cmake

@@ -16,6 +16,7 @@ add_subdirectory("${CMAKE_SOURCE_DIR}/third-party/Simple-Web-Server")
 add_subdirectory("${CMAKE_SOURCE_DIR}/third-party/libdisplaydevice")
 
 # common dependencies
+include("${CMAKE_MODULE_PATH}/dependencies/nlohmann_json.cmake")
 find_package(OpenSSL REQUIRED)
 find_package(PkgConfig REQUIRED)
 find_package(Threads REQUIRED)

cmake/dependencies/nlohmann_json.cmake

@@ -0,0 +1,18 @@
+#
+# Loads the nlohmann_json library giving the priority to the system package first, with a fallback to FetchContent.
+#
+include_guard(GLOBAL)
+
+find_package(nlohmann_json 3.11 QUIET GLOBAL)
+if(NOT nlohmann_json_FOUND)
+    message(STATUS "nlohmann_json v3.11.x package not found in the system. Falling back to FetchContent.")
+    include(FetchContent)
+
+    FetchContent_Declare(
+            json
+            URL      https://github.com/nlohmann/json/releases/download/v3.11.3/json.tar.xz
+            URL_HASH MD5=c23a33f04786d85c29fda8d16b5f0efd
+            DOWNLOAD_EXTRACT_TIMESTAMP
+    )
+    FetchContent_MakeAvailable(json)
+endif()

cmake/dependencies/windows.cmake

@@ -1,8 +1,5 @@
 # windows specific dependencies
 
-# nlohmann_json
-find_package(nlohmann_json CONFIG 3.11 REQUIRED)
-
 # Make sure MinHook is installed
 find_library(MINHOOK_LIBRARY libMinHook.a REQUIRED)
 find_path(MINHOOK_INCLUDE_DIR MinHook.h PATH_SUFFIXES include REQUIRED)

docs/api.md

@@ -12,17 +12,23 @@ basic authentication with the admin username and password.
 ## GET /api/apps
 @copydoc confighttp::getApps()
 
-## GET /api/logs
-@copydoc confighttp::getLogs()
-
 ## POST /api/apps
 @copydoc confighttp::saveApp()
 
+## POST /api/apps/close
+@copydoc confighttp::closeApp()
+
 ## DELETE /api/apps/{index}
 @copydoc confighttp::deleteApp()
 
-## POST /api/covers/upload
-@copydoc confighttp::uploadCover()
+## GET /api/clients/list
+@copydoc confighttp::getClients()
+
+## POST /api/clients/unpair
+@copydoc confighttp::unpair()
+
+## POST /api/clients/unpair-all
+@copydoc confighttp::unpairAll()
 
 ## GET /api/config
 @copydoc confighttp::getConfig()
@@ -33,29 +39,23 @@ basic authentication with the admin username and password.
 ## POST /api/config
 @copydoc confighttp::saveConfig()
 
-## POST /api/restart
-@copydoc confighttp::restart()
+## POST /api/covers/upload
+@copydoc confighttp::uploadCover()
 
-## POST /api/reset-display-device-persistence
-@copydoc confighttp::resetDisplayDevicePersistence()
+## GET /api/logs
+@copydoc confighttp::getLogs()
 
 ## POST /api/password
 @copydoc confighttp::savePassword()
 
 ## POST /api/pin
 @copydoc confighttp::savePin()
 
-## POST /api/clients/unpair-all
-@copydoc confighttp::unpairAll()
-
-## POST /api/clients/unpair
-@copydoc confighttp::unpair()
-
-## GET /api/clients/list
-@copydoc confighttp::listClients()
+## POST /api/reset-display-device-persistence
+@copydoc confighttp::resetDisplayDevicePersistence()
 
-## POST /api/apps/close
-@copydoc confighttp::closeApp()
+## POST /api/restart
+@copydoc confighttp::restart()
 
 <div class="section_buttons">
 

docs/app_examples.md

@@ -301,22 +301,19 @@ administrative privileges. Simply enable the elevated option in the WEB UI, or a
 This is an option for both prep-cmd and regular commands and will launch the process with the current user without a
 UAC prompt.
 
-@note{It is important to write the values "true" and "false" as string values, not as the typical true/false
-values in most JSON.}
-
 **Example**
 ```json
 {
   "name": "Game With AntiCheat that Requires Admin",
   "output": "",
   "cmd": "ping 127.0.0.1",
-  "exclude-global-prep-cmd": "false",
-  "elevated": "true",
+  "exclude-global-prep-cmd": false,
+  "elevated": true,
   "prep-cmd": [
     {
       "do": "powershell.exe -command \"Start-Streaming\"",
       "undo": "powershell.exe -command \"Stop-Streaming\"",
-      "elevated": "false"
+      "elevated": false
     }
   ],
   "image-path": ""

docs/building.md

@@ -92,7 +92,6 @@ dependencies=(
   "mingw-w64-ucrt-x86_64-graphviz"  # Optional, for docs
   "mingw-w64-ucrt-x86_64-MinHook"
   "mingw-w64-ucrt-x86_64-miniupnpc"
-  "mingw-w64-ucrt-x86_64-nlohmann-json"
   "mingw-w64-ucrt-x86_64-nodejs"
   "mingw-w64-ucrt-x86_64-nsis"
   "mingw-w64-ucrt-x86_64-onevpl"

docs/configuration.md

@@ -225,7 +225,7 @@ editing the `conf` file in a text editor. Use the examples as reference.
     <tr>
         <td>Example</td>
         <td colspan="2">@code{}
-            global_prep_cmd = [{"do":"nircmd.exe setdisplay 1280 720 32 144","undo":"nircmd.exe setdisplay 2560 1440 32 144"}]
+            global_prep_cmd = [{"do":"nircmd.exe setdisplay 1280 720 32 144","elevated":true,"undo":"nircmd.exe setdisplay 2560 1440 32 144"}]
             @endcode</td>
     </tr>
 </table>