@djodjonx/x32-simulator 0.0.3 → 0.0.5

package/src/domain/entities/SubscriptionManager.ts

@@ -1,126 +0,0 @@
-import { Subscriber, RemoteClient } from '../models/types';
-import { ILogger, LogCategory } from '../ports/ILogger';
-
-/**
- * Manages OSC client subscriptions and their lifecycle.
- */
-export class SubscriptionManager {
-  private logger: ILogger;
-  private subscribers: Subscriber[] = [];
-
-  constructor(logger: ILogger) {
-      this.logger = logger;
-  }
-
-  /**
-   * Cleans up expired subscriptions.
-   * Standard X32 subscriptions last 10 seconds.
-   */
-  public cleanup() {
-    const now = Date.now();
-    const initialCount = this.subscribers.length;
-    this.subscribers = this.subscribers.filter(s => {
-        const active = s.expires > now;
-        if (!active) {
-            this.logger.debug(LogCategory.SUB, `Expired subscriber`, { type: s.type, ip: s.address, port: s.port, path: 'path' in s ? s.path : s.alias });
-        }
-        return active;
-    });
-    if (this.subscribers.length !== initialCount) {
-        this.logger.info(LogCategory.SUB, `Cleanup finished`, { removed: initialCount - this.subscribers.length, remaining: this.subscribers.length });
-    }
-  }
-
-  /**
-   * Gets all active subscribers.
-   * @returns Array of subscribers.
-   */
-  public getSubscribers(): Subscriber[] {
-    return this.subscribers;
-  }
-
-  /**
-   * Adds or renews a path-based subscription (e.g. /subscribe or /xremote).
-   * @param rinfo - Client remote info.
-   * @param path - Subscription path.
-   */
-  public addPathSubscriber(rinfo: RemoteClient, path: string) {
-    const key = `${rinfo.address}:${rinfo.port}:${path}`;
-    const expires = Date.now() + 10000;
-    const existing = this.subscribers.find(s => s.type === 'path' && `${s.address}:${s.port}:${s.path}` === key);
-
-    if (existing) {
-        existing.expires = expires;
-        this.logger.debug(LogCategory.SUB, `Renewed subscription`, { ip: rinfo.address, path });
-    } else {
-        this.subscribers.push({ type: 'path', address: rinfo.address, port: rinfo.port, path, expires });
-        this.logger.info(LogCategory.SUB, `New subscription`, { ip: rinfo.address, path });
-    }
-  }
-
-  /**
-   * Adds or renews a batch subscription.
-   * @param rinfo - Client remote info.
-   * @param alias - Response alias.
-   * @param paths - Target paths.
-   * @param start - Start index.
-   * @param count - Count.
-   * @param factor - Frequency factor.
-   * @param args - Command arguments.
-   */
-  public addBatchSubscriber(rinfo: RemoteClient, alias: string, paths: string[], start: number, count: number, factor?: number, args?: number[]) {
-        const expires = Date.now() + 10000;
-        this.subscribers = this.subscribers.filter(s => !(s.type === 'batch' && s.alias === alias && s.address === rinfo.address));
-
-        this.subscribers.push({ type: 'batch', address: rinfo.address, port: rinfo.port, alias, paths, start, count, factor, expires, args });
-        this.logger.info(LogCategory.SUB, `Batch subscription`, { alias, count: paths.length, factor, ip: rinfo.address, args });
-    }
-
-    /**
-     * Adds or renews a format subscription.
-     * @param rinfo - Client remote info.
-     * @param alias - Response alias.
-     * @param pattern - Path pattern.
-     * @param start - Start index.
-     * @param count - Count.
-     * @param factor - Frequency factor.
-     */
-    public addFormatSubscriber(rinfo: RemoteClient, alias: string, pattern: string, start: number, count: number, factor?: number) {
-        const expires = Date.now() + 10000;
-        this.subscribers = this.subscribers.filter(s => !(s.type === 'format' && s.alias === alias && s.address === rinfo.address));
-        this.subscribers.push({ type: 'format', address: rinfo.address, port: rinfo.port, alias, pattern, start, count, factor, expires });
-        this.logger.info(LogCategory.SUB, `Format subscription`, { alias, pattern, factor, ip: rinfo.address });
-    }
-
-  /**
-   * Adds or renews a high-frequency meter subscription.
-   * @param rinfo - Client remote info.
-   * @param meterPath - Target meter path.
-   */
-  public addMeterSubscriber(rinfo: RemoteClient, meterPath: string) {
-      const expires = Date.now() + 10000;
-      const existing = this.subscribers.find(s => s.type === 'meter' && s.meterPath === meterPath && s.address === rinfo.address);
-
-      this.subscribers = this.subscribers.filter(s => !(s.type === 'meter' && s.meterPath === meterPath && s.address === rinfo.address));
-      this.subscribers.push({ type: 'meter', address: rinfo.address, port: rinfo.port, meterPath, expires });
-
-      if (!existing) {
-          this.logger.info(LogCategory.SUB, `Meter subscription`, { path: meterPath, ip: rinfo.address });
-      } else {
-          this.logger.debug(LogCategory.SUB, `Meter renewal`, { path: meterPath, ip: rinfo.address });
-      }
-  }
-
-  /**
-   * Removes a subscription.
-   * @param rinfo - Client remote info.
-   * @param path - Subscription path.
-   */
-  public removeSubscriber(rinfo: RemoteClient, path: string) {
-      const initial = this.subscribers.length;
-      this.subscribers = this.subscribers.filter(s => !(s.address === rinfo.address && s.port === rinfo.port && s.path === path));
-      if (this.subscribers.length < initial) {
-          this.logger.info(LogCategory.SUB, `Unsubscribed`, { path, ip: rinfo.address });
-      }
-  }
-}

package/src/domain/entities/X32State.ts

@@ -1,78 +0,0 @@
-import { EventEmitter } from 'node:events';
-import { X32Node } from '../models/X32Node';
-
-/**
- * Manages the internal "Digital Twin" state of the X32 console.
- * It acts as a single source of truth for all parameters.
- * Emits 'change' events whenever a value is updated.
- */
-export class X32State extends EventEmitter {
-  /** Map storing all OSC paths and their current values. */
-  private state = new Map<string, number | string>();
-  private readonly defaultState: Map<string, number | string> = new Map();
-
-  /**
-   * Initializes the state with default values from the schema.
-   * @param schema - The schema definition map.
-   */
-  constructor(schema: Record<string, X32Node>) {
-    super();
-    // Pre-calculate default state
-    for (const [addr, def] of Object.entries(schema)) {
-        this.defaultState.set(addr, def.default);
-    }
-    this.reset();
-  }
-
-  /**
-   * Resets all state parameters to their default values defined in the schema.
-   */
-  public reset() {
-    this.state.clear();
-    this.defaultState.forEach((val, key) => {
-        this.state.set(key, val);
-    });
-  }
-
-  /**
-   * Retrieves the value of a specific OSC node.
-   * @param address - The full OSC address path.
-   * @returns The stored value (number or string) or undefined if not found.
-   */
-  public get(address: string): number | string | undefined {
-    return this.state.get(address);
-  }
-
-  /**
-   * Updates the value of a specific OSC node and notifies subscribers.
-   * @param address - The full OSC address path.
-   * @param value - The new value to store.
-   */
-  public set(address: string, value: number | string) {
-    this.state.set(address, value);
-    this.emit('change', { address, value });
-  }
-
-  /**
-   * Specialized logic to handle X32 Mute Groups side-effects.
-   * When a mute group is toggled, it iterates through all channels
-   * assigned to that group and updates their individual mute status.
-   * @param groupIdx - The index of the mute group (1-6).
-   * @param isOn - The new state of the group master switch (0 or 1).
-   */
-  public handleMuteGroupChange(groupIdx: number, isOn: number) {
-      for(let i=1; i<=32; i++) {
-          const ch = i.toString().padStart(2, '0');
-          const grpVal = this.get(`/ch/${ch}/grp/mute`);
-
-          if (typeof grpVal === 'number') {
-              if ((grpVal & (1 << (groupIdx - 1))) !== 0) {
-                   const targetMute = isOn === 1 ? 0 : 1;
-                   const muteAddr = `/ch/${ch}/mix/on`;
-                   // This set calls emit('change') which will trigger broadcast
-                   this.set(muteAddr, targetMute);
-              }
-          }
-      }
-  }
-}

package/src/domain/models/MeterConfig.ts

@@ -1,22 +0,0 @@
-/**
- * Configuration for meter counts per path.
- */
-export const METER_COUNTS: Record<string, number> = {
-    '/meters/0': 70,
-    '/meters/1': 96,
-    '/meters/2': 49,
-    '/meters/3': 22,
-    '/meters/4': 82,
-    '/meters/5': 27,
-    '/meters/6': 4,
-    '/meters/7': 16,
-    '/meters/8': 6,
-    '/meters/9': 32,
-    '/meters/10': 32,
-    '/meters/11': 5,
-    '/meters/12': 4,
-    '/meters/13': 48,
-    '/meters/14': 80,
-    '/meters/15': 50,
-    '/meters/16': 48,
-};

package/src/domain/models/MeterData.ts

@@ -1,59 +0,0 @@
-/**
- * Represents a set of meter values for a specific meter path.
- * Handles the storage of float values and serialization to X32-specific binary blobs.
- */
-export class MeterData {
-    private readonly _path: string;
-    private readonly _values: number[];
-    
-    // Cache for the binary buffer to avoid re-allocation if values haven't changed (optional optimization, 
-    // but here we mainly cache the structure or just generate on demand). 
-    // Given the previous util had a static cache, we can keep it simple here.
-    
-    /**
-     * Creates a new MeterData instance.
-     * @param path - The meter OSC path (e.g., "/meters/1").
-     * @param values - The array of float values (0.0 - 1.0 or similar).
-     */
-    constructor(path: string, values: number[]) {
-        this._path = path;
-        this._values = values;
-    }
-
-    /**
-     * Gets the meter path.
-     */
-    get path(): string {
-        return this._path;
-    }
-
-    /**
-     * Gets the values.
-     */
-    get values(): number[] {
-        return [...this._values];
-    }
-
-    /**
-     * Generates an optimized binary blob for X32 meters (mixed endianness).
-     * Structure: [Size (Int32BE)] [Count (Int32LE)] [Float1 (LE)] [Float2 (LE)] ...
-     * @returns Buffer containing the OSC blob.
-     */
-    toBlob(): Buffer {
-        const count = this._values.length;
-        const totalSize = 4 + 4 + (count * 4);
-        
-        const blob = Buffer.alloc(totalSize);
-        
-        // Header: Size (BE) + Count (LE)
-        blob.writeInt32BE(totalSize, 0);
-        blob.writeInt32LE(count, 4);
-        
-        // Body: Floats (LE)
-        for (let i = 0; i < count; i++) {
-            blob.writeFloatLE(this._values[i], 8 + (i * 4));
-        }
-        
-        return blob;
-    }
-}

package/src/domain/models/OscMessage.ts

@@ -1,93 +0,0 @@
-import { OscArgumentValue, OscPacket } from './types';
-
-/**
- * Represents a parsed OSC message ready for handling.
- * Encapsulates the address and arguments, providing helper methods for validation and extraction.
- */
-export class OscMessage {
-    private readonly _address: string;
-    private readonly _args: OscArgumentValue[];
-
-    /**
-     * Creates a new OscMessage instance.
-     * @param address - The OSC address string.
-     * @param args - The list of arguments.
-     */
-    constructor(address: string, args: OscArgumentValue[]) {
-        this._address = address;
-        this._args = args;
-    }
-
-    /**
-     * Gets the OSC address.
-     * @returns The address string.
-     */
-    get address(): string {
-        return this._address;
-    }
-
-    /**
-     * Gets the message arguments.
-     * @returns Copy of the arguments array.
-     */
-    get args(): OscArgumentValue[] {
-        return [...this._args]; // Return copy to preserve immutability
-    }
-
-    /**
-     * Checks if the address starts with the given prefix.
-     * @param prefix - The prefix to check.
-     * @returns True if it starts with the prefix.
-     */
-    startsWith(prefix: string): boolean {
-        return this._address.startsWith(prefix);
-    }
-
-    /**
-     * Gets an argument at a specific index, safely.
-     * @param index - The index of the argument.
-     * @returns The argument value or undefined.
-     */
-    getArg(index: number): OscArgumentValue | undefined {
-        return this._args[index];
-    }
-
-    /**
-     * Gets an argument as a number, or throws if missing/invalid.
-     * @param index - The index.
-     * @returns The number value.
-     */
-    getArgAsNumber(index: number): number {
-        const val = this._args[index];
-        if (typeof val !== 'number') {
-            throw new Error(`Argument at index ${index} is not a number.`);
-        }
-        return val;
-    }
-
-    /**
-     * Gets an argument as a string, or throws if missing/invalid.
-     * @param index - The index.
-     * @returns The string value.
-     */
-    getArgAsString(index: number): string {
-        const val = this._args[index];
-        if (typeof val !== 'string') {
-            throw new Error(`Argument at index ${index} is not a string.`);
-        }
-        return val;
-    }
-
-    /**
-     * Factory method to create an OscMessage from a raw packet.
-     * @param packet - The raw OSC packet.
-     * @returns A new OscMessage instance.
-     */
-    static fromPacket(packet: OscPacket): OscMessage {
-        const values = packet.args.map(arg => 
-            (typeof arg === 'object' && arg !== null && 'value' in arg) ? arg.value : arg
-        ) as OscArgumentValue[];
-        
-        return new OscMessage(packet.address, values);
-    }
-}

package/src/domain/models/X32Address.ts

@@ -1,72 +0,0 @@
-/**
- * Represents an X32 OSC Address path, providing parsing logic and component extraction.
- */
-export class X32Address {
-    private readonly _path: string;
-    private readonly _parts: string[];
-
-    /**
-     * Creates a new X32Address.
-     * @param path - The full OSC path (e.g., "/ch/01/mix/fader").
-     */
-    constructor(path: string) {
-        this._path = path;
-        // Split by '/' and remove empty strings from leading slash
-        this._parts = path.split('/').filter(p => p.length > 0);
-    }
-
-    /**
-     * Gets the full string representation of the path.
-     * @returns The full OSC path string.
-     */
-    get path(): string {
-        return this._path;
-    }
-
-    /**
-     * Gets the root category (e.g., "ch", "bus", "config").
-     * @returns The first segment of the path.
-     */
-    get root(): string | undefined {
-        return this._parts[0];
-    }
-
-    /**
-     * Gets the index/ID part if present (e.g., "01" from "/ch/01").
-     * @returns The second segment of the path.
-     */
-    get index(): string | undefined {
-        return this._parts[1];
-    }
-
-    /**
-     * Gets the suffix (everything after the ID).
-     * e.g., for "/ch/01/mix/fader", returns "/mix/fader".
-     * @returns The remaining path after the index.
-     */
-    get suffix(): string {
-        if (this._parts.length < 3) return '';
-        return '/' + this._parts.slice(2).join('/');
-    }
-
-    /**
-     * Checks if this address belongs to a specific category.
-     * @param category - The category to check (e.g., "meters", "ch").
-     * @returns True if it matches the category.
-     */
-    isCategory(category: string): boolean {
-        return this.root === category;
-    }
-
-    /**
-     * Checks if the address matches a specific pattern.
-     * @param pattern - The regex or string pattern.
-     * @returns True if it matches the pattern.
-     */
-    matches(pattern: RegExp | string): boolean {
-        if (typeof pattern === 'string') {
-            return this._path === pattern;
-        }
-        return pattern.test(this._path);
-    }
-}

package/src/domain/models/X32Node.ts

@@ -1,43 +0,0 @@
-/**
- * Metadata for a single state node in the X32 schema.
- * Represents a "Knob" or "Variable" on the console.
- */
-export class X32Node {
-    /** Value type (f=float, i=int, s=string). */
-    readonly type: 'f' | 'i' | 's';
-    /** Default value for reset. */
-    readonly default: number | string;
-
-    /**
-     * Creates a new X32Node.
-     * @param type - The OSC data type ('f', 'i', 's').
-     * @param defaultValue - The default value.
-     */
-    constructor(type: 'f' | 'i' | 's', defaultValue: number | string) {
-        this.type = type;
-        this.default = defaultValue;
-    }
-
-    /**
-     * Validates if a value is compatible with this node's type.
-     * @param value - The value to check.
-     * @returns True if valid.
-     */
-    validate(value: any): boolean {
-        if (this.type === 'f') return typeof value === 'number'; // && value >= 0.0 && value <= 1.0 (optional strict check)
-        if (this.type === 'i') return typeof value === 'number'; // && Number.isInteger(value)
-        if (this.type === 's') return typeof value === 'string';
-        return false;
-    }
-
-    /**
-     * Factory method to create from a plain object (for compatibility/migration).
-     * @param obj - Plain object.
-     * @param obj.type - OSC data type.
-     * @param obj.default - Default value.
-     * @returns A new X32Node instance.
-     */
-    static from(obj: { type: 'f'|'i'|'s', default: number|string }): X32Node {
-        return new X32Node(obj.type, obj.default);
-    }
-}

package/src/domain/models/types.ts

@@ -1,86 +0,0 @@
-/**
- * Represents a basic OSC argument value.
- */
-export type OscArgumentValue = Buffer | boolean | number | string;
-
-/**
- * Represents an OSC argument, which can be a primitive value or a typed object.
- */
-export type OscArgument = OscArgumentValue | { type: string; value: OscArgumentValue };
-
-/**
- * Represents a decoded OSC packet (bundle or message) as returned by the codec.
- */
-export interface OscPacket {
-  /** The type of OSC packet. */
-  oscType: 'bundle' | 'message';
-  /** The address pattern. */
-  address: string;
-  /** The arguments of the message or elements of the bundle. */
-  args: OscArgument[];
-  /** Elements if this is a bundle. */
-  elements?: OscPacket[];
-}
-
-/**
- * Represents a remote OSC client's connection info.
- */
-export interface RemoteClient {
-  /** Target IP address. */
-  address: string;
-  /** Target port. */
-  port: number;
-}
-
-/**
- * Represents a parsed OSC message ready for handling.
- * Arguments are already unwrapped from their {type, value} containers.
- */
-export interface OscMsg {
-  /** The OSC address. */
-  address: string;
-  /** The message arguments. */
-  args: OscArgumentValue[];
-}
-
-/**
- * Represents an active subscription from a client.
- */
-export interface Subscriber {
-    /** Target IP address. */
-    address: string;
-    /** Target port. */
-    port: number;
-    /** Expiry timestamp. */
-    expires: number;
-    /** Subscription type. */
-    type: 'batch' | 'format' | 'meter' | 'path';
-    /** Optional exact path for 'path' type. */
-    path?: string;
-    /** Target meter path for 'meter' type. */
-    meterPath?: string;
-    /** Alias for batch/format responses. */
-    alias?: string;
-    /** Glob/Wildcard pattern for 'format' type. */
-    pattern?: string;
-    /** List of paths for 'batch' type. */
-    paths?: string[];
-    /** Start index for ranges. */
-    start?: number;
-    /** Number of items in range. */
-    count?: number;
-    /** Frequency reduction factor. */
-    factor?: number;
-    /** Parameter arguments for the command. */
-    args?: number[];
-}
-
-/**
- * Structure representing a reply to be sent back to an OSC client.
- */
-export interface OscReply {
-    /** The target OSC address. */
-    address: string;
-    /** The response arguments. */
-    args: OscArgument[];
-}

package/src/domain/ports/ILogger.ts

@@ -1,27 +0,0 @@
-/**
- * Represents data that can be logged.
- */
-export type LogData = Buffer | Error | LogData[] | boolean | number | string | { [key: string]: LogData } | null | undefined;
-
-/**
- * Standard log categories for the domain.
- */
-export enum LogCategory {
-    SYSTEM = 'SYSTEM',
-    OSC_IN = 'OSC_IN',
-    OSC_OUT = 'OSC_OUT',
-    DISPATCH = 'DISPATCH',
-    STATE = 'STATE',
-    SUB = 'SUB',
-    METER = 'METER'
-}
-
-/**
- * Interface for the logging port.
- */
-export interface ILogger {
-    debug(category: string, msg: string, data?: LogData): void;
-    info(category: string, msg: string, data?: LogData): void;
-    warn(category: string, msg: string, data?: LogData): void;
-    error(category: string, msg: string, err?: LogData): void;
-}

package/src/domain/ports/INetworkGateway.ts

@@ -1,8 +0,0 @@
-import { OscPacket, RemoteClient } from '../models/types';
-
-export interface INetworkGateway {
-    start(port: number, ip: string): Promise<void>;
-    stop(): Promise<void>;
-    send(target: RemoteClient, address: string, args: any[]): void;
-    onPacket(callback: (packet: OscPacket, source: RemoteClient) => void): void;
-}

package/src/domain/ports/IStateRepository.ts

@@ -1,16 +0,0 @@
-import { X32State } from '../entities/X32State';
-
-/**
- * Interface for accessing the mixer state.
- */
-export interface IStateRepository {
-    /**
-     * Retrieves the single instance of the mixer state (Singleton in this context).
-     */
-    getState(): X32State;
-
-    /**
-     * Resets the state to defaults.
-     */
-    reset(): void;
-}

package/src/domain/services/MeterService.ts

@@ -1,46 +0,0 @@
-import { X32State } from '../entities/X32State';
-import { MeterData } from '../models/MeterData';
-import { METER_COUNTS } from '../models/MeterConfig';
-
-/**
- * Service responsible for generating meter values and data.
- * Mimics the physics/audio engine of the X32.
- */
-export class MeterService {
-
-    /**
-     * Generates a MeterData object for a given path.
-     * @param path - The meter OSC path (e.g., "/meters/1").
-     * @param state - The current X32 state (for correlating faders to meters).
-     * @returns MeterData object containing the values.
-     */
-    public generateMeterData(path: string, state?: X32State): MeterData {
-        const count = METER_COUNTS[path];
-        if (count === undefined) {
-            return new MeterData(path, []);
-        }
-
-        const values: number[] = [];
-        for (let i = 0; i < count; i++) {
-            let val = Math.random() * 0.05; // Noise floor
-
-            // Simulation logic: Link meters 1-32 to Channel Faders 1-32
-            if (state && path === '/meters/1') {
-                if (i < 32) {
-                    const ch = (i + 1).toString().padStart(2, '0');
-                    // We should use X32Address logic here ideally, but string construction is fast
-                    const faderPath = `/ch/${ch}/mix/fader`;
-                    const fader = state.get(faderPath);
-
-                    if (typeof fader === 'number') {
-                        // If fader is up, show signal (simulated with random variation)
-                        val = fader > 0.01 ? fader * (0.9 + Math.random() * 0.1) : 0;
-                    }
-                }
-            }
-            values.push(val);
-        }
-
-        return new MeterData(path, values);
-    }
-}