tci-client-node 0.1.2 → 0.2.0

package/dist/index.d.cts

@@ -1,11 +1,17 @@
-import { Q as QueueCommandOptions, T as TciError } from './index-CK3XdXP3.cjs';
-export { a as QueuedCommandResult, b as TciCommandMatcher, c as TciCommandQueue, d as TciCommandQueueOptions, e as TciErrorCode, t as toTciError } from './index-CK3XdXP3.cjs';
+import { Q as QueueCommandOptions, T as TciError } from './index-lbK6NGY4.cjs';
+export { a as QueuedCommandResult, b as TciCommandMatcher, c as TciCommandQueue, d as TciCommandQueueOptions, e as TciErrorCode, t as toTciError } from './index-lbK6NGY4.cjs';
 import { EventEmitter } from 'eventemitter3';
 import WebSocket from 'ws';
 import { TciSampleType, TciSampleTypeName, TciStreamFrame, BuildTxAudioFrameOptions } from './audio/index.cjs';
-export { BuildStreamFrameOptions, TCI_STREAM_HEADER_BYTES, TciStreamType, buildStreamFrame, buildTxAudioFrame, deinterleaveChannels, float32ToPcm16, mixToMono, normalizeSampleType, normalizeStreamType, parseStreamFrame, payloadToFloat32, pcm16ToFloat32, sampleTypeBytes, sampleTypeName, samplesToPayload } from './audio/index.cjs';
+export { BuildStreamFrameOptions, ParseStreamFrameOptions, TCI_STREAM_HEADER_BYTES, TciStreamType, buildStreamFrame, buildTxAudioFrame, deinterleaveChannels, float32ToPcm16, mixToMono, normalizeSampleType, normalizeStreamType, parseStreamFrame, payloadToFloat32, pcm16ToFloat32, sampleTypeBytes, sampleTypeName, samplesToPayload } from './audio/index.cjs';
 import { T as TciCommand } from './text-BwCWY1k1.cjs';
 export { a as TciCommandInput, c as commandKey, e as escapeTciText, f as formatTciCommand, i as isCommandReplyTo, n as normalizeCommandName, p as parseTciCommand, b as parseTciText, u as unescapeTciText } from './text-BwCWY1k1.cjs';
+import { T as TciDialectId, a as TciHandshakeResult, b as TciDialectSelection, c as TciWriteResult } from './types-xRotf9gW.cjs';
+export { B as BuiltInTciDialectId, d as TciDialect, e as TciDialectDetection, f as TciDialectDetectionContext, g as TciDialectScore, h as TciDriveState, i as TciProtocolIdentity, j as TciStreamLengthSemantics } from './types-xRotf9gW.cjs';
+import { TciDialectRegistry } from './dialect/index.cjs';
+export { aetherSdrDialect, assertValidTciHandshake, builtInDialects, compareTciVersion, defaultTciDialectRegistry, expertSdr14Dialect, expertSdrLegacyDialect, expertSdrModernDialect, genericObservedDialect, parseProtocolIdentity, parseTciVersion, thetisDialect } from './dialect/index.cjs';
+import { TciTransportFactory } from './transport/index.cjs';
+export { TciTransport, TciTransportEvents, WebSocketTciTransport } from './transport/index.cjs';
 
 interface TciClientOptions {
     url: string;
@@ -13,12 +19,16 @@ interface TciClientOptions {
     trx?: number;
     vfo?: number;
     connectTimeoutMs?: number;
+    handshakeTimeoutMs?: number;
     commandTimeoutMs?: number;
     writeAckMode?: TciWriteAckMode;
     writeTimeoutMs?: number;
     writeSettleMs?: number;
     frequencyWriteSettleMs?: number;
+    dialect?: TciDialectSelection;
+    dialectRegistry?: TciDialectRegistry;
     WebSocketImpl?: typeof WebSocket;
+    transportFactory?: TciTransportFactory;
 }
 interface TciAudioConfig {
     sampleRate: 8_000 | 12_000 | 24_000 | 48_000 | number;
@@ -47,11 +57,17 @@ interface TciTxChronoRequest {
     channels: number;
     sampleType: TciSampleType;
     sampleCount: number;
+    frameCount: number;
 }
 interface TciClientState {
     connected: boolean;
     ready: boolean;
     protocol?: string;
+    protocolName?: string;
+    protocolVersion?: string;
+    dialectId?: TciDialectId;
+    dialectConfidence?: TciHandshakeResult['dialect']['confidence'];
+    dialectWarnings: string[];
     device?: string;
     receiveOnly?: boolean;
     trxCount?: number;
@@ -65,6 +81,7 @@ interface TciClientState {
     pttSource: Record<string, string | undefined>;
     tune: Record<string, boolean>;
     drive: Record<string, number>;
+    tuneDrive: Record<string, number>;
     split: Record<string, boolean>;
     rxSensors: Record<string, Record<string, number | string | boolean>>;
     txSensors: Record<string, Record<string, number | string | boolean>>;
@@ -77,6 +94,7 @@ interface TciClientEvents {
     connected: () => void;
     disconnected: (reason?: unknown) => void;
     ready: (state: TciClientState) => void;
+    handshake: (result: TciHandshakeResult) => void;
     state: (state: TciClientState) => void;
     command: (command: TciCommand) => void;
     binary: (frame: TciStreamFrame) => void;
@@ -92,16 +110,27 @@ interface SendCommandOptions extends QueueCommandOptions {
     waitForReply?: boolean;
 }
 declare class TciClient extends EventEmitter<TciClientEvents> {
-    readonly options: Required<Pick<TciClientOptions, 'receiver' | 'trx' | 'vfo' | 'connectTimeoutMs' | 'commandTimeoutMs' | 'writeAckMode' | 'writeTimeoutMs' | 'writeSettleMs' | 'frequencyWriteSettleMs'>> & Pick<TciClientOptions, 'url'>;
+    readonly options: Required<Pick<TciClientOptions, 'receiver' | 'trx' | 'vfo' | 'connectTimeoutMs' | 'handshakeTimeoutMs' | 'commandTimeoutMs' | 'writeAckMode' | 'writeTimeoutMs' | 'writeSettleMs' | 'frequencyWriteSettleMs'>> & Pick<TciClientOptions, 'url'> & {
+        dialect: TciDialectSelection;
+    };
     private readonly WebSocketImpl;
-    private ws?;
+    private readonly transportFactory;
+    private transport?;
     private readonly queue;
     private readonly state;
+    private readonly stateReducers;
+    private readonly dialectRegistry;
+    private activeDialect?;
+    private handshakeResult?;
+    private handshakeError?;
+    private initializationCommands;
+    private handshakeWaiter?;
     constructor(options: TciClientOptions);
-    connect(): Promise<void>;
+    connect(): Promise<TciHandshakeResult>;
     disconnect(code?: number, reason?: string): Promise<void>;
     isConnected(): boolean;
     getState(): TciClientState;
+    getHandshakeResult(): TciHandshakeResult | undefined;
     sendCommand(name: string, args?: readonly unknown[], options?: SendCommandOptions): Promise<TciCommand | undefined>;
     request(name: string, args?: readonly unknown[], options?: QueueCommandOptions): Promise<TciCommand>;
     sendStateWrite(name: string, args: readonly unknown[], isApplied: (state: TciClientState) => boolean, description?: string, options?: TciWriteOptions): Promise<void>;
@@ -111,9 +140,13 @@ declare class TciClient extends EventEmitter<TciClientEvents> {
     getMode(receiver?: number): Promise<string | undefined>;
     setPtt(enabled: boolean, options?: TciPttOptions): Promise<void>;
     getPtt(trx?: number): Promise<boolean | undefined>;
-    setTune(enabled: boolean, trx?: number): Promise<void>;
+    setTune(enabled: boolean, trx?: number, options?: TciWriteOptions): Promise<void>;
     setDrive(value: number, trx?: number): Promise<void>;
-    setSplit(enabled: boolean, trx?: number): Promise<void>;
+    setDriveWithResult(value: number, trx?: number, options?: TciWriteOptions): Promise<TciWriteResult<number>>;
+    getDrive(trx?: number): Promise<number | undefined>;
+    setTuneDrive(value: number, trx?: number, options?: TciWriteOptions): Promise<TciWriteResult<number>>;
+    getTuneDrive(trx?: number): Promise<number | undefined>;
+    setSplit(enabled: boolean, trx?: number, options?: TciWriteOptions): Promise<void>;
     configureAudio(config: TciAudioConfig): Promise<void>;
     startAudio(receiver?: number): Promise<void>;
     stopAudio(receiver?: number): Promise<void>;
@@ -125,18 +158,26 @@ declare class TciClient extends EventEmitter<TciClientEvents> {
     sendCwMessage(message: string): Promise<void>;
     stopCw(): Promise<void>;
     private waitForState;
-    private waitForOpen;
-    private attachSocket;
+    private waitForCommand;
+    private resetHandshake;
+    private waitForHandshake;
+    private finalizeHandshake;
+    private rejectHandshake;
+    private requireDialect;
+    private attachTransport;
     private sendRaw;
     private sendRawBinary;
-    private handleMessage;
+    private handleText;
     private handleBinary;
     private applyCommand;
+    private createStateReducers;
     private applyVfo;
     private applyModulation;
     private applyTrx;
     private applyBooleanByFirstArg;
     private applyDrive;
+    private applyTuneDrive;
+    private updateAudioState;
     private applyRxChannelSensors;
     private applyRxSensors;
     private applyTxSensors;
@@ -146,4 +187,4 @@ declare class TciClient extends EventEmitter<TciClientEvents> {
 }
 declare function createTciClient(options: TciClientOptions): TciClient;
 
-export { BuildTxAudioFrameOptions, QueueCommandOptions, type SendCommandOptions, type TciAudioConfig, TciClient, type TciClientEvents, type TciClientOptions, type TciClientState, TciCommand, TciError, type TciPttOptions, TciSampleType, TciSampleTypeName, TciStreamFrame, type TciTxChronoRequest, type TciWriteAckMode, type TciWriteOptions, createTciClient };
+export { BuildTxAudioFrameOptions, QueueCommandOptions, type SendCommandOptions, type TciAudioConfig, TciClient, type TciClientEvents, type TciClientOptions, type TciClientState, TciCommand, TciDialectId, TciDialectRegistry, TciDialectSelection, TciError, TciHandshakeResult, type TciPttOptions, TciSampleType, TciSampleTypeName, TciStreamFrame, TciTransportFactory, type TciTxChronoRequest, type TciWriteAckMode, type TciWriteOptions, TciWriteResult, createTciClient };

package/dist/index.d.ts

@@ -1,11 +1,17 @@
-import { Q as QueueCommandOptions, T as TciError } from './index-Dfmrk2MR.js';
-export { a as QueuedCommandResult, b as TciCommandMatcher, c as TciCommandQueue, d as TciCommandQueueOptions, e as TciErrorCode, t as toTciError } from './index-Dfmrk2MR.js';
+import { Q as QueueCommandOptions, T as TciError } from './index-paj1AOJY.js';
+export { a as QueuedCommandResult, b as TciCommandMatcher, c as TciCommandQueue, d as TciCommandQueueOptions, e as TciErrorCode, t as toTciError } from './index-paj1AOJY.js';
 import { EventEmitter } from 'eventemitter3';
 import WebSocket from 'ws';
 import { TciSampleType, TciSampleTypeName, TciStreamFrame, BuildTxAudioFrameOptions } from './audio/index.js';
-export { BuildStreamFrameOptions, TCI_STREAM_HEADER_BYTES, TciStreamType, buildStreamFrame, buildTxAudioFrame, deinterleaveChannels, float32ToPcm16, mixToMono, normalizeSampleType, normalizeStreamType, parseStreamFrame, payloadToFloat32, pcm16ToFloat32, sampleTypeBytes, sampleTypeName, samplesToPayload } from './audio/index.js';
+export { BuildStreamFrameOptions, ParseStreamFrameOptions, TCI_STREAM_HEADER_BYTES, TciStreamType, buildStreamFrame, buildTxAudioFrame, deinterleaveChannels, float32ToPcm16, mixToMono, normalizeSampleType, normalizeStreamType, parseStreamFrame, payloadToFloat32, pcm16ToFloat32, sampleTypeBytes, sampleTypeName, samplesToPayload } from './audio/index.js';
 import { T as TciCommand } from './text-BwCWY1k1.js';
 export { a as TciCommandInput, c as commandKey, e as escapeTciText, f as formatTciCommand, i as isCommandReplyTo, n as normalizeCommandName, p as parseTciCommand, b as parseTciText, u as unescapeTciText } from './text-BwCWY1k1.js';
+import { T as TciDialectId, a as TciHandshakeResult, b as TciDialectSelection, c as TciWriteResult } from './types-9seY9Th-.js';
+export { B as BuiltInTciDialectId, d as TciDialect, e as TciDialectDetection, f as TciDialectDetectionContext, g as TciDialectScore, h as TciDriveState, i as TciProtocolIdentity, j as TciStreamLengthSemantics } from './types-9seY9Th-.js';
+import { TciDialectRegistry } from './dialect/index.js';
+export { aetherSdrDialect, assertValidTciHandshake, builtInDialects, compareTciVersion, defaultTciDialectRegistry, expertSdr14Dialect, expertSdrLegacyDialect, expertSdrModernDialect, genericObservedDialect, parseProtocolIdentity, parseTciVersion, thetisDialect } from './dialect/index.js';
+import { TciTransportFactory } from './transport/index.js';
+export { TciTransport, TciTransportEvents, WebSocketTciTransport } from './transport/index.js';
 
 interface TciClientOptions {
     url: string;
@@ -13,12 +19,16 @@ interface TciClientOptions {
     trx?: number;
     vfo?: number;
     connectTimeoutMs?: number;
+    handshakeTimeoutMs?: number;
     commandTimeoutMs?: number;
     writeAckMode?: TciWriteAckMode;
     writeTimeoutMs?: number;
     writeSettleMs?: number;
     frequencyWriteSettleMs?: number;
+    dialect?: TciDialectSelection;
+    dialectRegistry?: TciDialectRegistry;
     WebSocketImpl?: typeof WebSocket;
+    transportFactory?: TciTransportFactory;
 }
 interface TciAudioConfig {
     sampleRate: 8_000 | 12_000 | 24_000 | 48_000 | number;
@@ -47,11 +57,17 @@ interface TciTxChronoRequest {
     channels: number;
     sampleType: TciSampleType;
     sampleCount: number;
+    frameCount: number;
 }
 interface TciClientState {
     connected: boolean;
     ready: boolean;
     protocol?: string;
+    protocolName?: string;
+    protocolVersion?: string;
+    dialectId?: TciDialectId;
+    dialectConfidence?: TciHandshakeResult['dialect']['confidence'];
+    dialectWarnings: string[];
     device?: string;
     receiveOnly?: boolean;
     trxCount?: number;
@@ -65,6 +81,7 @@ interface TciClientState {
     pttSource: Record<string, string | undefined>;
     tune: Record<string, boolean>;
     drive: Record<string, number>;
+    tuneDrive: Record<string, number>;
     split: Record<string, boolean>;
     rxSensors: Record<string, Record<string, number | string | boolean>>;
     txSensors: Record<string, Record<string, number | string | boolean>>;
@@ -77,6 +94,7 @@ interface TciClientEvents {
     connected: () => void;
     disconnected: (reason?: unknown) => void;
     ready: (state: TciClientState) => void;
+    handshake: (result: TciHandshakeResult) => void;
     state: (state: TciClientState) => void;
     command: (command: TciCommand) => void;
     binary: (frame: TciStreamFrame) => void;
@@ -92,16 +110,27 @@ interface SendCommandOptions extends QueueCommandOptions {
     waitForReply?: boolean;
 }
 declare class TciClient extends EventEmitter<TciClientEvents> {
-    readonly options: Required<Pick<TciClientOptions, 'receiver' | 'trx' | 'vfo' | 'connectTimeoutMs' | 'commandTimeoutMs' | 'writeAckMode' | 'writeTimeoutMs' | 'writeSettleMs' | 'frequencyWriteSettleMs'>> & Pick<TciClientOptions, 'url'>;
+    readonly options: Required<Pick<TciClientOptions, 'receiver' | 'trx' | 'vfo' | 'connectTimeoutMs' | 'handshakeTimeoutMs' | 'commandTimeoutMs' | 'writeAckMode' | 'writeTimeoutMs' | 'writeSettleMs' | 'frequencyWriteSettleMs'>> & Pick<TciClientOptions, 'url'> & {
+        dialect: TciDialectSelection;
+    };
     private readonly WebSocketImpl;
-    private ws?;
+    private readonly transportFactory;
+    private transport?;
     private readonly queue;
     private readonly state;
+    private readonly stateReducers;
+    private readonly dialectRegistry;
+    private activeDialect?;
+    private handshakeResult?;
+    private handshakeError?;
+    private initializationCommands;
+    private handshakeWaiter?;
     constructor(options: TciClientOptions);
-    connect(): Promise<void>;
+    connect(): Promise<TciHandshakeResult>;
     disconnect(code?: number, reason?: string): Promise<void>;
     isConnected(): boolean;
     getState(): TciClientState;
+    getHandshakeResult(): TciHandshakeResult | undefined;
     sendCommand(name: string, args?: readonly unknown[], options?: SendCommandOptions): Promise<TciCommand | undefined>;
     request(name: string, args?: readonly unknown[], options?: QueueCommandOptions): Promise<TciCommand>;
     sendStateWrite(name: string, args: readonly unknown[], isApplied: (state: TciClientState) => boolean, description?: string, options?: TciWriteOptions): Promise<void>;
@@ -111,9 +140,13 @@ declare class TciClient extends EventEmitter<TciClientEvents> {
     getMode(receiver?: number): Promise<string | undefined>;
     setPtt(enabled: boolean, options?: TciPttOptions): Promise<void>;
     getPtt(trx?: number): Promise<boolean | undefined>;
-    setTune(enabled: boolean, trx?: number): Promise<void>;
+    setTune(enabled: boolean, trx?: number, options?: TciWriteOptions): Promise<void>;
     setDrive(value: number, trx?: number): Promise<void>;
-    setSplit(enabled: boolean, trx?: number): Promise<void>;
+    setDriveWithResult(value: number, trx?: number, options?: TciWriteOptions): Promise<TciWriteResult<number>>;
+    getDrive(trx?: number): Promise<number | undefined>;
+    setTuneDrive(value: number, trx?: number, options?: TciWriteOptions): Promise<TciWriteResult<number>>;
+    getTuneDrive(trx?: number): Promise<number | undefined>;
+    setSplit(enabled: boolean, trx?: number, options?: TciWriteOptions): Promise<void>;
     configureAudio(config: TciAudioConfig): Promise<void>;
     startAudio(receiver?: number): Promise<void>;
     stopAudio(receiver?: number): Promise<void>;
@@ -125,18 +158,26 @@ declare class TciClient extends EventEmitter<TciClientEvents> {
     sendCwMessage(message: string): Promise<void>;
     stopCw(): Promise<void>;
     private waitForState;
-    private waitForOpen;
-    private attachSocket;
+    private waitForCommand;
+    private resetHandshake;
+    private waitForHandshake;
+    private finalizeHandshake;
+    private rejectHandshake;
+    private requireDialect;
+    private attachTransport;
     private sendRaw;
     private sendRawBinary;
-    private handleMessage;
+    private handleText;
     private handleBinary;
     private applyCommand;
+    private createStateReducers;
     private applyVfo;
     private applyModulation;
     private applyTrx;
     private applyBooleanByFirstArg;
     private applyDrive;
+    private applyTuneDrive;
+    private updateAudioState;
     private applyRxChannelSensors;
     private applyRxSensors;
     private applyTxSensors;
@@ -146,4 +187,4 @@ declare class TciClient extends EventEmitter<TciClientEvents> {
 }
 declare function createTciClient(options: TciClientOptions): TciClient;
 
-export { BuildTxAudioFrameOptions, QueueCommandOptions, type SendCommandOptions, type TciAudioConfig, TciClient, type TciClientEvents, type TciClientOptions, type TciClientState, TciCommand, TciError, type TciPttOptions, TciSampleType, TciSampleTypeName, TciStreamFrame, type TciTxChronoRequest, type TciWriteAckMode, type TciWriteOptions, createTciClient };
+export { BuildTxAudioFrameOptions, QueueCommandOptions, type SendCommandOptions, type TciAudioConfig, TciClient, type TciClientEvents, type TciClientOptions, type TciClientState, TciCommand, TciDialectId, TciDialectRegistry, TciDialectSelection, TciError, TciHandshakeResult, type TciPttOptions, TciSampleType, TciSampleTypeName, TciStreamFrame, TciTransportFactory, type TciTxChronoRequest, type TciWriteAckMode, type TciWriteOptions, TciWriteResult, createTciClient };