@livedesk/client 0.1.240 → 0.1.241

package/README.md

@@ -17,14 +17,14 @@ npx -y --prefer-online livedesk@latest client 3
 advanced diagnostics. The public command above keeps Hub and client versions
 aligned.
 
-The default flow lets the local Client runtime own Google authorization,
-callback exchange, and saved authentication as one path. The browser only
-shows progress; it does not maintain a second session that must be transferred
-back to the Client. LiveDesk then waits for the active Hub published by the
-same account and connects locally. If the Hub is not
-ready yet, the client waits for a Hub-online event and polls the registry at
-most every six seconds as a fallback. Missing a wake event can never leave a
-Client asleep for minutes. If a
+The default flow lets the local Client runtime own Google authorization,
+callback exchange, and saved authentication as one path. The browser only
+shows progress; it does not maintain a second session that must be transferred
+back to the Client. LiveDesk then waits for the active Hub published by the
+same account and connects locally. If the Hub is not
+ready yet, the client waits for a Hub-online event and polls the registry at
+most every six seconds as a fallback. Missing a wake event can never leave a
+Client asleep for minutes. If a
 connected Hub is replaced, the launcher also leaves the stale endpoint and
 discovers the newly published Hub without another Google login. Omit the number
 for first-available placement, or pass `1` to `999` to pin this machine to a
@@ -34,11 +34,11 @@ On Windows, check **Start with Windows** on the connection page to reconnect thi
 client automatically after reboot. The startup entry reuses the saved Google
 session and only opens the connection page again if sign-in is needed.
 
-On the Hub computer, open the LiveDesk dashboard, sign in, and run **Sync
-Server** once. The dashboard transfers the signed-in session to the local Hub;
-the Hub process then keeps its own local address and private pair token
-refreshed in the LiveDesk Supabase registry. The dashboard can be closed after
-that while the Hub remains running.
+On the Hub computer, open the LiveDesk dashboard, sign in, and run **Sync
+Server** once. The dashboard transfers the signed-in session to the local Hub;
+the Hub process then keeps its own local address and private pair token
+refreshed in the LiveDesk Supabase registry. The dashboard can be closed after
+that while the Hub remains running.
 
 Supabase Auth must allow the CLI callback URL:
 
@@ -52,9 +52,9 @@ the matching callback URL to Supabase Auth redirect URLs.
 The client registers the device, sends status heartbeats, can return
 Hub-requested thumbnails, can stream a focused view-only live screen, and
 can receive safe task-only instructions. The C# RemoteFast engine also supports
-keyboard/mouse control on Windows, macOS, and Linux/X11, file transfer, and
-system-audio playback from Windows, macOS, and Linux. Linux captures the default
-output through PipeWire `pw-record` or PulseAudio `parec`. macOS control requires Accessibility
+keyboard/mouse control on Windows, macOS, and Linux/X11, file transfer, and
+system-audio playback from Windows, macOS, and Linux. Linux captures the default
+output through PipeWire `pw-record` or PulseAudio `parec`. macOS control requires Accessibility
 permission for the terminal app that started LiveDesk; screen streaming and
 system-audio capture require Screen Recording permission. LiveDesk checks these
 permissions without opening repeated system dialogs and prints the matching
@@ -62,9 +62,9 @@ System Settings path when access is missing; after granting access, restart the
 client. When file transfer is enabled by the Hub, received files are saved
 to `Desktop/LiveDeskFiles` unless the Hub sets another destination folder.
 
-By default, the launcher uses the packaged C# RemoteFast engine when supported.
-It falls back to the Node engine only when a compatible RemoteFast runtime is
-unavailable. Windows, macOS, and Linux all try RemoteFast first so
+By default, the launcher uses the packaged C# RemoteFast engine when supported.
+It falls back to the Node engine only when a compatible RemoteFast runtime is
+unavailable. Windows, macOS, and Linux all try RemoteFast first so
 the Hub can request the Mode 3 hardware video path when it is available.
 RemoteFast is shipped as a platform-specific self-contained .NET executable,
 so client computers do not need a separate .NET installation.
@@ -91,7 +91,7 @@ Frame pipeline roadmap:
 
 - Mode 1: `mode1-jpeg` - current test path using screen capture, resize, and JPEG binary frames.
 - Mode 2: `mode2-lzo` - cross-platform wall path using independent RGB565LE frames capped at 320x180 and compressed as LZO1X blocks. The wall defaults to 8 fps. macOS and Linux keep one persistent local capture helper per client process. Legacy `mode2-lz4` settings migrate to this mode.
-- Mode 3: `mode3-h264-hw` - OS-specific H.264 path. Windows tries Media Foundation/NVENC/QSV/AMF, macOS prefers ScreenCaptureKit plus VideoToolbox, and Linux tries NVENC/VAAPI/QSV before falling back to the bundled ffmpeg `libx264` encoder. Linux users do not need to install ffmpeg separately when starting LiveDesk through the published npm package. macOS emits one startup key frame and then an approximately half-second recovery GOP. The launcher uses bundled ffmpeg for fallback paths unless `LIVEDESK_FFMPEG` points to a custom binary. On macOS, set `LIVEDESK_FFMPEG_AVFOUNDATION_INPUT` only when the ScreenCaptureKit helper is unavailable and the AVFoundation fallback input is not `1:none`.
+- Mode 3: `mode3-h264-hw` - OS-specific H.264 path. Windows tries Media Foundation/NVENC/QSV/AMF, macOS prefers ScreenCaptureKit plus VideoToolbox, and Linux tries NVENC/VAAPI/QSV before falling back to the bundled ffmpeg `libx264` encoder. Linux users do not need to install ffmpeg separately when starting LiveDesk through the published npm package. macOS emits one startup key frame and then an approximately half-second recovery GOP. The launcher uses bundled ffmpeg for fallback paths unless `LIVEDESK_FFMPEG` points to a custom binary. On macOS, set `LIVEDESK_FFMPEG_AVFOUNDATION_INPUT` only when the ScreenCaptureKit helper is unavailable and the AVFoundation fallback input is not `1:none`.
 
 Legacy mode names such as `remote-fast` and `remote-quality` are treated as
 Mode 1 aliases.

package/THIRD_PARTY_NOTICES.md

@@ -1,26 +1,26 @@
-# Third-Party Notices
-
-## lzokay
-
-LiveDesk's LZO1X block encoder and decoder follow the instruction layout of
-[lzokay](https://github.com/AxioDL/lzokay), Copyright (c) 2018 Jack Andersen.
-
-The MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+# Third-Party Notices
+
+## lzokay
+
+LiveDesk's LZO1X block encoder and decoder follow the instruction layout of
+[lzokay](https://github.com/AxioDL/lzokay), Copyright (c) 2018 Jack Andersen.
+
+The MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/bin/client-version.js

@@ -1,23 +1,23 @@
-import { readFileSync } from 'node:fs';
-import { dirname, join, resolve } from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-const packageRoot = resolve(__dirname, '..');
-
-export function readClientPackageVersion() {
-    try {
-        const packageInfo = JSON.parse(readFileSync(join(packageRoot, 'package.json'), 'utf8'));
-        return String(packageInfo.version || '0.0.0');
-    } catch {
-        return '0.0.0';
-    }
-}
-
-export function formatClientVersionBanner(env = process.env) {
-    const launcherName = String(env.LIVEDESK_NPM_LAUNCHER_NAME || '').trim();
-    const launcherVersion = String(env.LIVEDESK_NPM_LAUNCHER_VERSION || '').trim();
-    const productName = launcherName || 'livedesk';
-    const productVersion = launcherVersion || readClientPackageVersion();
-    return `[LiveDesk Client] ${productName}@${productVersion}`;
-}
+import { readFileSync } from 'node:fs';
+import { dirname, join, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const packageRoot = resolve(__dirname, '..');
+
+export function readClientPackageVersion() {
+    try {
+        const packageInfo = JSON.parse(readFileSync(join(packageRoot, 'package.json'), 'utf8'));
+        return String(packageInfo.version || '0.0.0');
+    } catch {
+        return '0.0.0';
+    }
+}
+
+export function formatClientVersionBanner(env = process.env) {
+    const launcherName = String(env.LIVEDESK_NPM_LAUNCHER_NAME || '').trim();
+    const launcherVersion = String(env.LIVEDESK_NPM_LAUNCHER_VERSION || '').trim();
+    const productName = launcherName || 'livedesk';
+    const productVersion = launcherVersion || readClientPackageVersion();
+    return `[LiveDesk Client] ${productName}@${productVersion}`;
+}

package/bin/livedesk-client-fast.js

@@ -1,23 +1,23 @@
 #!/usr/bin/env node
-
-import { dirname, join } from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { spawn } from 'node:child_process';
-
-const launcherPath = join(dirname(fileURLToPath(import.meta.url)), 'livedesk-client.js');
-const child = spawn(process.execPath, [launcherPath, '--fast', ...process.argv.slice(2)], {
-    stdio: 'inherit',
-    windowsHide: true
-});
-
-child.once('error', error => {
-    console.error(`Failed to launch C# RemoteFast: ${error.message}`);
-    process.exitCode = 1;
-});
-child.once('exit', (code, signal) => {
-    if (signal) {
-        process.kill(process.pid, signal);
-        return;
-    }
-    process.exit(code ?? 0);
-});
+
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { spawn } from 'node:child_process';
+
+const launcherPath = join(dirname(fileURLToPath(import.meta.url)), 'livedesk-client.js');
+const child = spawn(process.execPath, [launcherPath, '--fast', ...process.argv.slice(2)], {
+    stdio: 'inherit',
+    windowsHide: true
+});
+
+child.once('error', error => {
+    console.error(`Failed to launch C# RemoteFast: ${error.message}`);
+    process.exitCode = 1;
+});
+child.once('exit', (code, signal) => {
+    if (signal) {
+        process.kill(process.pid, signal);
+        return;
+    }
+    process.exit(code ?? 0);
+});

package/bin/livedesk-client-node.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 import net from 'net';
 import os from 'os';
@@ -251,7 +251,7 @@ async function waitForClientUpdateShutdownSignal(
     return { ready: false, error };
 }
 
-function markClientUpdateConnected() {
+function markClientUpdateConnected() {
     const operationId = String(process.env.LIVEDESK_CLIENT_UPDATE_OPERATION_ID || '').trim();
     if (!operationId) return;
     void writeClientUpdateState('connected', {
@@ -262,59 +262,59 @@ function markClientUpdateConnected() {
         error: ''
     }).catch(error => {
         console.error(`LiveDesk client update diagnostics could not be persisted: ${error?.message || error}`);
-    });
-}
-
-async function publishClientUpdateSupervisorProof(socket) {
-    const operationId = String(process.env.LIVEDESK_CLIENT_UPDATE_OPERATION_ID || '').trim();
-    const attemptId = String(process.env.LIVEDESK_CLIENT_UPDATE_ATTEMPT_ID || '').trim();
-    const expectedLauncherPid = Number(process.env.LIVEDESK_CLIENT_PARENT_PID || 0);
-    if (!operationId || !attemptId || !Number.isInteger(expectedLauncherPid) || expectedLauncherPid <= 1) return;
-    const deadline = Date.now() + 60_000;
-    while (Date.now() < deadline && !socket.destroyed) {
-        try {
-            const state = JSON.parse(await fs.readFile(getClientUpdateStatePath(), 'utf8'));
-            if (String(state?.operationId || '') !== operationId
-                || String(state?.attemptId || '') !== attemptId) {
-                await wait(100);
-                continue;
-            }
-            if (['failed', 'restored', 'cancelled'].includes(String(state.stage || ''))) return;
-            const launcherPid = Number(state.launcherPid || 0);
-            const agentPid = Number(state.agentPid || 0);
-            const supervisorPid = Number(state.supervisorPid || 0);
-            const completedAt = String(state.completedAt || '').trim();
-            const exactSupervisorCompletion = state.stage === 'connected'
-                && state.restartVerified === true
-                && Number.isFinite(Date.parse(completedAt))
-                && launcherPid === expectedLauncherPid
-                && agentPid === process.pid
-                && Number.isInteger(supervisorPid)
-                && supervisorPid > 1
-                && String(state.productVersion || '') === PRODUCT_VERSION
-                && String(state.agentVersion || '') === AGENT_VERSION
-                && String(state.targetProductVersion || '') === PRODUCT_VERSION
-                && String(state.targetAgentVersion || state.targetVersion || '') === AGENT_VERSION;
-            if (exactSupervisorCompletion) {
-                writeJsonLine(socket, {
-                    type: 'client.update.verified',
-                    operationId,
-                    attemptId,
-                    launcherPid,
-                    agentPid,
-                    supervisorPid,
-                    productVersion: PRODUCT_VERSION,
-                    agentVersion: AGENT_VERSION,
-                    completedAt
-                });
-                return;
-            }
-        } catch {
-            // The exact package supervisor may be replacing the atomic state file.
-        }
-        await wait(100);
-    }
-}
+    });
+}
+
+async function publishClientUpdateSupervisorProof(socket) {
+    const operationId = String(process.env.LIVEDESK_CLIENT_UPDATE_OPERATION_ID || '').trim();
+    const attemptId = String(process.env.LIVEDESK_CLIENT_UPDATE_ATTEMPT_ID || '').trim();
+    const expectedLauncherPid = Number(process.env.LIVEDESK_CLIENT_PARENT_PID || 0);
+    if (!operationId || !attemptId || !Number.isInteger(expectedLauncherPid) || expectedLauncherPid <= 1) return;
+    const deadline = Date.now() + 60_000;
+    while (Date.now() < deadline && !socket.destroyed) {
+        try {
+            const state = JSON.parse(await fs.readFile(getClientUpdateStatePath(), 'utf8'));
+            if (String(state?.operationId || '') !== operationId
+                || String(state?.attemptId || '') !== attemptId) {
+                await wait(100);
+                continue;
+            }
+            if (['failed', 'restored', 'cancelled'].includes(String(state.stage || ''))) return;
+            const launcherPid = Number(state.launcherPid || 0);
+            const agentPid = Number(state.agentPid || 0);
+            const supervisorPid = Number(state.supervisorPid || 0);
+            const completedAt = String(state.completedAt || '').trim();
+            const exactSupervisorCompletion = state.stage === 'connected'
+                && state.restartVerified === true
+                && Number.isFinite(Date.parse(completedAt))
+                && launcherPid === expectedLauncherPid
+                && agentPid === process.pid
+                && Number.isInteger(supervisorPid)
+                && supervisorPid > 1
+                && String(state.productVersion || '') === PRODUCT_VERSION
+                && String(state.agentVersion || '') === AGENT_VERSION
+                && String(state.targetProductVersion || '') === PRODUCT_VERSION
+                && String(state.targetAgentVersion || state.targetVersion || '') === AGENT_VERSION;
+            if (exactSupervisorCompletion) {
+                writeJsonLine(socket, {
+                    type: 'client.update.verified',
+                    operationId,
+                    attemptId,
+                    launcherPid,
+                    agentPid,
+                    supervisorPid,
+                    productVersion: PRODUCT_VERSION,
+                    agentVersion: AGENT_VERSION,
+                    completedAt
+                });
+                return;
+            }
+        } catch {
+            // The exact package supervisor may be replacing the atomic state file.
+        }
+        await wait(100);
+    }
+}
 
 function printHelp() {
     console.log(`
@@ -2023,10 +2023,10 @@ function connectOnce(options, deviceId) {
                     remoteFiles: true,
                     fileTransferMaxBytes: MAX_FILE_TRANSFER_BYTES,
                     computerAgent: options.taskEnabled,
-                    taskDispatch: options.taskEnabled,
-                    clientUpdate: true,
-                    clientUpdateVerifiedProof: true,
-                    productVersion: PRODUCT_VERSION,
+                    taskDispatch: options.taskEnabled,
+                    clientUpdate: true,
+                    clientUpdateVerifiedProof: true,
+                    productVersion: PRODUCT_VERSION,
                     agentApproval: options.taskEnabled,
                     agentAudit: options.taskEnabled,
                     agentTools: [...NODE_AGENT_OPERATIONS],
@@ -2052,13 +2052,13 @@ function connectOnce(options, deviceId) {
                     options.effectivePolicy = message.effectivePolicy && typeof message.effectivePolicy === 'object'
                         ? message.effectivePolicy
                         : null;
-                    console.log(`Connected to LiveDesk Hub as ${options.name} (${deviceId})`);
-                    markClientUpdateConnected();
-                    void publishClientUpdateSupervisorProof(socket).catch(error => {
-                        if (!socket.destroyed) {
-                            console.error(`LiveDesk client update verification proof failed: ${error?.message || error}`);
-                        }
-                    });
+                    console.log(`Connected to LiveDesk Hub as ${options.name} (${deviceId})`);
+                    markClientUpdateConnected();
+                    void publishClientUpdateSupervisorProof(socket).catch(error => {
+                        if (!socket.destroyed) {
+                            console.error(`LiveDesk client update verification proof failed: ${error?.message || error}`);
+                        }
+                    });
                     writeJsonLine(socket, {
                         type: 'status',
                         status: getStatus(options)