@axium/client 0.31.2 → 0.32.0

package/assets/theme.css

@@ -51,6 +51,8 @@ html {
 	--fg-error: hsl(0 50 calc(var(--fg-light) - var(--light-step)));
 	--fg-warning: hsl(60 50 calc(var(--fg-light) - var(--light-step)));
 
+	--green: hsl(140 50 50);
+
 	--border-disabled: 1px solid hsl(0 5 calc(var(--bg-light) - var(--light-step)));
 	--border-accent: 1px solid hsl(var(--hue) 10 calc(var(--bg-light) + (var(--light-step) * 3)));
 	--border-alt: 1px solid var(--bg-alt);

package/axium-client.service

@@ -11,7 +11,7 @@ FailureAction=none
 [Service]
 Type=simple
 ExecStartPre=/usr/bin/env cd "%Y/../../.."
-ExecStart=/usr/bin/env npx --prefix "%Y/../../.." axium-client run
+ExecStart=/usr/bin/env npx --prefix "%Y/../../.." axium-client daemon
 ExecReload=kill -HUP $MAINPID
 SyslogIdentifier=axium-client
 Restart=on-failure

package/dist/cli/cache.js

@@ -136,9 +136,15 @@ export async function update(force = false) {
 }
 export function clear() {
     for (const handle of handles)
-        unlinkSync(handle.path);
+        try {
+            unlinkSync(handle.path);
+        }
+        catch { }
     for (const { path } of persistedAPICaches)
-        unlinkSync(path);
+        try {
+            unlinkSync(path);
+        }
+        catch { }
 }
 export async function* info() {
     for (const handle of handles) {

package/dist/cli/config.d.ts

@@ -1,4 +1,5 @@
 export declare const configDir: string;
+export declare const axcConfigPath: string;
 export declare function session(): {
     id: string;
     userId: string;

package/dist/cli/config.js

@@ -8,9 +8,9 @@ import { setPrefix, setToken } from '../requests.js';
 import * as cache from './cache.js';
 export const configDir = join(process.env.XDG_CONFIG_HOME || join(homedir(), '.config'), 'axium');
 mkdirSync(configDir, { recursive: true });
-const axcConfig = join(configDir, 'config.json');
-if (!existsSync(axcConfig))
-    writeFileSync(axcConfig, '{}');
+export const axcConfigPath = join(configDir, 'config.json');
+if (!existsSync(axcConfigPath))
+    writeFileSync(axcConfigPath, '{}');
 export function session() {
     if (!config.token)
         io.exit('Not logged in.', 4);
@@ -20,19 +20,19 @@ export function session() {
 }
 export async function loadConfig(safe) {
     try {
-        Object.assign(config, io.readJSON(axcConfig, ClientConfig));
+        Object.assign(config, io.readJSON(axcConfigPath, ClientConfig));
         if (config.server)
             setPrefix(config.server);
         if (config.token)
             setToken(config.token);
         for (const plugin of config.plugins ?? [])
-            await loadPlugin('client', plugin, axcConfig, safe);
+            await loadPlugin('client', plugin, axcConfigPath, safe);
     }
     catch (e) {
         io.warn('Failed to load config: ' + io.errorText(e));
     }
 }
 export function saveConfig() {
-    io.writeJSON(axcConfig, config);
-    io.debug('Saved config to ' + axcConfig);
+    io.writeJSON(axcConfigPath, config);
+    io.debug('Saved config to ' + axcConfigPath);
 }

package/dist/cli/index.js

@@ -1,6 +1,6 @@
 #! /usr/bin/env node
 import { formatBytes } from '@axium/core';
-import { outputDaemonStatus, pluginText } from '@axium/core/node';
+import { loadPlugin, outputDaemonStatus, pluginText } from '@axium/core/node';
 import { _findPlugin, plugins } from '@axium/core/plugins';
 import { CommanderError, program } from 'commander';
 import * as io from 'ioium/node';
@@ -10,10 +10,11 @@ import * as z from 'zod';
 import $pkg from '../../package.json' with { type: 'json' };
 import { config } from '../config.js';
 import { prefix, useUserAgent } from '../requests.js';
+import { connect as connectSocket } from '../socket.js';
 import { logout } from '../user.js';
 import { clientUA, login } from './auth.js';
 import * as cache from './cache.js';
-import { loadConfig, saveConfig, session } from './config.js';
+import { axcConfigPath, loadConfig, saveConfig, session } from './config.js';
 const safe = z.stringbool().default(false).parse(process.env.SAFE?.toLowerCase()) || process.argv.includes('--safe');
 const debug = z.stringbool().default(false).parse(process.env.DEBUG?.toLowerCase()) || process.argv.includes('--debug');
 if (debug)
@@ -62,18 +63,26 @@ program.command('status').action(() => {
     outputDaemonStatus('axium-client');
 });
 program
-    .command('run')
-    .argument('[plugin]', 'The plugin to run')
-    .action(async (name) => {
-    if (name) {
-        const plugin = _findPlugin(name);
-        await plugin._client?.run();
-        return;
-    }
+    .command('daemon')
+    .description('Run as the Axium client daemon')
+    .option('--no-socket', 'do not open a socket connection to the server')
+    .option('--insecure', 'allow connecting to a server with an untrusted (e.g. self-signed) TLS certificate', false)
+    .action(async (opt) => {
     for (const plugin of plugins.values())
-        await plugin._client?.run();
+        await plugin._client?.run?.();
+    // Hold a socket connection to the server for the lifetime of the daemon.
+    if (opt.socket && config.token)
+        await connectSocket({ rejectUnauthorized: !opt.insecure });
 });
 const axcPlugin = program.command('plugin').alias('plugins').description('Manage plugins');
+axcPlugin
+    .command('run')
+    .description('Run a plugin')
+    .argument('<plugin>', 'the plugin to run')
+    .action(async (search) => {
+    const plugin = _findPlugin(search);
+    await plugin._client?.run?.();
+});
 axcPlugin
     .command('list')
     .alias('ls')
@@ -103,6 +112,31 @@ axcPlugin
     for (const line of pluginText(plugin))
         console.log(line);
 });
+axcPlugin
+    .command('add')
+    .description('Add a plugin')
+    .option('-k, --keep-going', 'continue adding plugins even if one fails')
+    .argument('<spec...>', 'the plugin specifier (e.g. a package name) to add')
+    .action(async (specs, { keepGoing }) => {
+    for (const spec of specs) {
+        try {
+            if (config.plugins.includes(spec))
+                throw `Plugin "${spec}" is already added.`;
+            const plugin = await loadPlugin('client', spec, axcConfigPath, safe);
+            if (!plugin)
+                throw `Failed to load a client plugin from "${spec}".`;
+            config.plugins.push(spec);
+            saveConfig();
+            console.log('Added plugin:', plugin.name, styleText('dim', 'v' + plugin.version));
+        }
+        catch (e) {
+            if (keepGoing)
+                io.error(e);
+            else
+                io.exit(e);
+        }
+    }
+});
 axcPlugin
     .command('remove')
     .alias('rm')

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 export * from './access.js';
-export * as preferences from './preferences.js';
 export * from './cache.js';
 export * from './config.js';
 export * from './locales.js';
+export * as preferences from './preferences.js';
 export * from './requests.js';
+export * as socket from './socket.js';
 export * from './user.js';

package/dist/index.js

@@ -1,7 +1,8 @@
 export * from './access.js';
-export * as preferences from './preferences.js';
 export * from './cache.js';
 export * from './config.js';
 export * from './locales.js';
+export * as preferences from './preferences.js';
 export * from './requests.js';
+export * as socket from './socket.js';
 export * from './user.js';

package/dist/requests.d.ts

@@ -5,6 +5,7 @@ export declare let token: string | null;
 export declare function setToken(value: string | null): void;
 export declare let prefix: string, origin: string;
 export declare function setPrefix(value: string): void;
+export declare let userAgent: string | null;
 /**
  * Only for use on non-browser clients, e.g. Node.js
  */

package/dist/requests.js

@@ -14,7 +14,7 @@ export function setPrefix(value) {
     prefix = value;
     origin = new URL(prefix, origin).origin;
 }
-let userAgent = null;
+export let userAgent = null;
 /**
  * Only for use on non-browser clients, e.g. Node.js
  */

package/dist/socket.d.ts

@@ -0,0 +1,10 @@
+import type { ClientToServerEvents, ServerToClientEvents } from '@axium/core/socket';
+import { ServerToClient } from '@axium/core/socket';
+import type { ManagerOptions, Socket as PlainSocket, SocketOptions } from 'socket.io-client';
+export interface Socket extends PlainSocket<ServerToClientEvents, ClientToServerEvents> {
+}
+export declare function addListener<T extends keyof ServerToClient & string>(event: T, listener: ServerToClientEvents[T]): void;
+export interface ConnectOptions extends Partial<ManagerOptions & SocketOptions> {
+}
+export declare let socket: Socket | null;
+export declare function connect(opts?: ConnectOptions): Promise<Socket>;

package/dist/socket.js

@@ -0,0 +1,40 @@
+import { ServerToClient } from '@axium/core/socket';
+import * as io from 'ioium';
+import { io as socketIO } from 'socket.io-client';
+import { origin, token, userAgent } from './requests.js';
+const listeners = new Set();
+export function addListener(event, listener) {
+    const schema = ServerToClient[event];
+    if (schema)
+        listeners.add([event, schema.implement(listener)]);
+    else {
+        io.warn(`Attaching a listener to the '${event}' socket event without schema`);
+        listeners.add([event, listener]);
+    }
+}
+export let socket = null;
+export function connect(opts) {
+    if (socket)
+        return Promise.resolve(socket);
+    if (!token)
+        io.warn('Connecting to the server socket without a session token.');
+    const { extraHeaders = {} } = opts || {};
+    if (token)
+        extraHeaders.Authorization = 'Bearer ' + token;
+    if (userAgent)
+        extraHeaders['User-Agent'] = userAgent;
+    socket = socketIO(origin, { ...opts, extraHeaders });
+    for (const [event, listener] of listeners)
+        socket.on(event, listener);
+    const { promise, resolve, reject } = Promise.withResolvers();
+    socket.on('connect', () => {
+        io.debug('socket: Connected as ' + socket.id);
+        resolve(socket);
+    });
+    socket.on('connect_error', err => {
+        if (!socket.active)
+            socket = null;
+        reject(err);
+    });
+    return promise;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@axium/client",
-	"version": "0.31.2",
+	"version": "0.32.0",
 	"author": "James Prevett <jp@jamespre.dev>",
 	"funding": {
 		"type": "individual",
@@ -49,7 +49,7 @@
 		"build": "tsc"
 	},
 	"peerDependencies": {
-		"@axium/core": ">=0.32.0",
+		"@axium/core": ">=0.33.0",
 		"ioium": "^1.0.2",
 		"semver": "^7.7.4",
 		"svelte": "^5.36.0",
@@ -59,6 +59,7 @@
 	"dependencies": {
 		"@simplewebauthn/browser": "^13.1.0",
 		"commander": "^15.0.0",
-		"music-metadata": "^11.12.3"
+		"music-metadata": "^11.12.3",
+		"socket.io-client": "^4.8.3"
 	}
 }