lox-slimproto 0.1.0

package/.devcontainer/devcontainer.json

@@ -0,0 +1,22 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node
+{
+	"name": "Node.js & TypeScript",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/typescript-node:1-22-bookworm"
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "yarn install",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

package/.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: publish
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org
+
+      - name: Install deps
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Publish
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -0,0 +1,51 @@
+# lox-slimproto
+
+SlimProto server/client utilities for controlling Squeezebox-compatible players from Node.js. This is a TypeScript port of aioslimproto with the full server + player-control implementation used by lox-audioserver.
+
+## Quick start (server)
+
+```ts
+import { SlimServer, EventType } from "lox-slimproto";
+
+const server = new SlimServer();
+await server.start();
+
+server.subscribe((event) => {
+  console.log(`[${event.type}]`, event.playerId, event.data);
+});
+
+process.on("SIGINT", async () => {
+  await server.stop();
+  process.exit(0);
+});
+```
+
+## Quick start (playback control)
+
+```ts
+import { SlimServer } from "lox-slimproto";
+
+const server = new SlimServer();
+await server.start();
+
+const player = server.getPlayer("aa:bb:cc:dd:ee:ff");
+if (player) {
+  await player.playUrl("http://host:7090/streams/1/current.mp3", "audio/mpeg", {
+    title: "Now Playing",
+    artist: "Artist",
+  });
+}
+```
+
+## What is implemented
+
+- SlimProto TCP server with player tracking and event subscriptions.
+- UDP discovery responses (legacy + TLV).
+- SlimClient playback control: play/pause/stop, volume, metadata, and power.
+- HTTP stream control and codec negotiation.
+- Sync helpers (`pauseFor`, `skipOver`, `unpauseAt`) and heartbeat/jiffies tracking.
+- Typed enums and helpers mirroring the reference implementation.
+
+## Notes
+
+- This package focuses on server-side SlimProto and player control; it does not implement LMS CLI or display rendering.

package/dist/client.d.ts

@@ -0,0 +1,78 @@
+import net from 'net';
+import { EventType, MediaDetails, MediaMetadata, PlayerState, TransitionType } from './models.js';
+type SlimClientCallback = (client: SlimClient, eventType: EventType, data?: unknown) => void | Promise<void>;
+export declare class SlimClient {
+    private readonly socket;
+    private readonly callback;
+    private readonly remoteAddress?;
+    private readonly remotePort?;
+    private readonly volumeControl;
+    private buffer;
+    private _connected;
+    private _playerId;
+    private _deviceType;
+    private capabilities;
+    private _deviceName;
+    private _powered;
+    private _muted;
+    private _state;
+    private _jiffies;
+    private _lastTimestamp;
+    private _elapsedMs;
+    private _currentMedia;
+    private _bufferingMedia;
+    private _nextMedia;
+    private _autoPlay;
+    private _heartbeatTimer;
+    private _heartbeatId;
+    constructor(socket: net.Socket, callback: SlimClientCallback);
+    disconnect(): void;
+    get connected(): boolean;
+    get playerId(): string;
+    get deviceType(): string;
+    get name(): string;
+    get deviceAddress(): string | undefined;
+    get devicePort(): number | undefined;
+    get state(): PlayerState;
+    get currentMedia(): MediaDetails | null;
+    get supportedCodecs(): string[];
+    get maxSampleRate(): number;
+    get firmware(): string;
+    get volumeLevel(): number;
+    get elapsedMilliseconds(): number;
+    get jiffies(): number;
+    get lastHeartbeatAt(): number | null;
+    stop(): Promise<void>;
+    play(): Promise<void>;
+    pause(): Promise<void>;
+    pauseFor(millis: number): Promise<void>;
+    skipOver(millis: number): Promise<void>;
+    unpauseAt(timestamp: number): Promise<void>;
+    power(powered?: boolean): Promise<void>;
+    volumeSet(volumeLevel: number): Promise<void>;
+    volumeUp(): Promise<void>;
+    volumeDown(): Promise<void>;
+    mute(muted?: boolean): Promise<void>;
+    playUrl(url: string, mimeType?: string | null, metadata?: MediaMetadata, transition?: TransitionType, transitionDuration?: number, enqueue?: boolean, autostart?: boolean, sendFlush?: boolean): Promise<void>;
+    private sendAudg;
+    private sendFrame;
+    private sendStrm;
+    private handleDisconnect;
+    private onData;
+    private processHelo;
+    private processButn;
+    private processKnob;
+    private processIr;
+    private processDsco;
+    private processStat;
+    private processStatHeartbeat;
+    private processResp;
+    private processSetd;
+    private parseCodc;
+    private signalUpdate;
+    private signalEvent;
+    private startHeartbeat;
+    private togglePower;
+    private togglePause;
+}
+export {};