alphatheta-connect 0.22.0 → 0.23.0

package/lib/virtualcdj/device-id.d.ts

@@ -1,4 +1,10 @@
-import type { DeviceID } from "../types";
+/**
+ * Mirrors {@link import('src/types').DeviceID}. Declared locally rather than
+ * imported so this module carries no dependencies at all: consumers re-export
+ * it into their own test setups, where the package's `src/*` path aliases do
+ * not resolve.
+ */
+type DeviceID = number;
 /**
  * The highest device ID a CDJ will answer remotedb queries from.
  *
@@ -10,19 +16,62 @@ export declare const REMOTEDB_MAX_DEVICE_ID = 6;
  * The highest device ID the prolink protocol allows.
  */
 export declare const MAX_DEVICE_ID = 32;
+/**
+ * How many player numbers each mixer can hand out.
+ *
+ * Players take their number from the mixer channel they are plugged into, so
+ * an N-channel mixer only ever produces players 1..N — and N+1 is the lowest
+ * number that no player on that rig can claim.
+ *
+ * These are physical channel counts, deliberately NOT the `channelCount` in
+ * the app's own capability table, which caps the DJM-V10 at 4 for its mixer
+ * signal model. Capping here would put us on player 5 of a 6-channel rig,
+ * which is the collision this table exists to avoid.
+ */
+export declare const MIXER_PLAYER_CEILING: Record<string, number>;
+/**
+ * What to assume about a mixer whose model we do not recognise.
+ *
+ * Four is both the most common layout and the choice that keeps remotedb
+ * metadata working: assuming six would push us to player 7 on every mixer
+ * released after this table was written, silently losing metadata for
+ * unanalyzed and streaming tracks. A six-channel unit we failed to recognise
+ * may later claim the number we took, which the announcer's conflict handling
+ * resolves by moving us.
+ */
+export declare const DEFAULT_MIXER_PLAYER_CEILING = 4;
+/** The fields {@link playerNumberCeiling} reads off a discovered device. */
+export interface DeviceLike {
+    name: string;
+    type: number;
+}
+/**
+ * The highest player number the discovered gear can hand out, or undefined
+ * when nothing on the network implies one.
+ *
+ * Undefined means we have no mixer to reason from — players may have been
+ * numbered by hand anywhere in 1-6, and there is no better guess available.
+ */
+export declare function playerNumberCeiling(devices: Iterable<DeviceLike>): number | undefined;
 export interface PickDeviceIdOptions {
     /**
      * Prefer an ID in the 1-6 range, which is the only range CDJs answer
      * remotedb metadata queries from (unanalyzed media, CD text, streaming
      * tracks).
      *
-     * That range is shared with real players, so the search runs downwards from
-     * 6: players number themselves from 1 upwards, so the top of the range is
-     * the least likely to be claimed by a CDJ that powers on later.
-     *
      * @default false
      */
     preferRemoteDb?: boolean;
+    /**
+     * The highest player number the rig can hand out, from
+     * {@link playerNumberCeiling}. The search starts just above it, so the
+     * number we take is one no player on this rig can be assigned.
+     *
+     * When omitted, the 1-6 range is searched downwards instead: players number
+     * themselves from 1 upwards, so the top of the range is the least likely to
+     * be claimed by a CDJ that powers on later.
+     */
+    playerCeiling?: number;
 }
 /**
  * Pick a device ID that no device on the network is currently using.
@@ -34,4 +83,5 @@ export interface PickDeviceIdOptions {
  * Returns null when every ID from 1 to 32 is occupied, in which case there is
  * no safe ID and the caller must not join the network.
  */
-export declare function pickAvailableDeviceId(usedIds: Iterable<DeviceID>, { preferRemoteDb }?: PickDeviceIdOptions): DeviceID | null;
+export declare function pickAvailableDeviceId(usedIds: Iterable<DeviceID>, { preferRemoteDb, playerCeiling }?: PickDeviceIdOptions): DeviceID | null;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "alphatheta-connect",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "main": "lib/index.js",
   "author": "Evan Purkhiser <evanpurkhiser@gmail.com>",
   "contributors": [