@volley/recognition-client-sdk 0.1.254 → 0.1.287

package/dist/browser.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Browser-only entry point for Recognition SDK
+ * Excludes server-side dependencies
+ *
+ * Note: This file directly imports browser-compatible modules only,
+ * avoiding Node.js-specific code like the ws package.
+ */
+export { RealTimeTwoWayWebSocketRecognitionClient, type RealTimeTwoWayWebSocketRecognitionClientConfig, type TranscriptionResult } from './recognition-client.js';
+export { AudioEncoding, ControlSignalTypeV1 as ControlSignal, type GameContextV1, RecognitionContextTypeV1 } from '@recog/shared-types';
+//# sourceMappingURL=browser.d.ts.map

package/dist/browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH,OAAO,EACL,wCAAwC,EACxC,KAAK,8CAA8C,EACnD,KAAK,mBAAmB,EACzB,MAAM,yBAAyB,CAAC;AAGjC,OAAO,EACL,aAAa,EACb,mBAAmB,IAAI,aAAa,EACpC,KAAK,aAAa,EAClB,wBAAwB,EACzB,MAAM,qBAAqB,CAAC"}

package/dist/config-builder.d.ts

@@ -0,0 +1,129 @@
+/**
+ * Configuration Builder for Recognition Client
+ *
+ * Simple builder pattern for RealTimeTwoWayWebSocketRecognitionClientConfig
+ */
+import type { RealTimeTwoWayWebSocketRecognitionClientConfig, RecognitionCallbackUrl } from './recognition-client.types.js';
+import type { ASRRequestConfig, GameContextV1, TranscriptionResultV1, MetadataResultV1, ErrorResultV1, Stage } from '@recog/shared-types';
+/**
+ * Builder for RealTimeTwoWayWebSocketRecognitionClientConfig
+ *
+ * Provides a fluent API for building client configurations.
+ *
+ * Example:
+ * ```typescript
+ * import { STAGES } from '@recog/shared-types';
+ *
+ * const config = new ConfigBuilder()
+ *   .stage(STAGES.STAGING)  // Recommended: automatic environment selection
+ *   .asrRequestConfig({
+ *     provider: RecognitionProvider.DEEPGRAM,
+ *     model: 'nova-2-general'
+ *   })
+ *   .onTranscript((result) => console.log(result))
+ *   .build();
+ * ```
+ */
+export declare class ConfigBuilder {
+    private config;
+    /**
+     * Set the WebSocket URL (advanced usage)
+     * For standard environments, use stage() instead
+     */
+    url(url: string): this;
+    /**
+     * Set the stage for automatic environment selection (recommended)
+     * @param stage - STAGES.LOCAL | STAGES.DEV | STAGES.STAGING | STAGES.PRODUCTION
+     * @example
+     * ```typescript
+     * import { STAGES } from '@recog/shared-types';
+     * builder.stage(STAGES.STAGING)
+     * ```
+     */
+    stage(stage: Stage | string): this;
+    /**
+     * Set ASR request configuration
+     */
+    asrRequestConfig(config: ASRRequestConfig): this;
+    /**
+     * Set game context
+     */
+    gameContext(context: GameContextV1): this;
+    /**
+     * Set audio utterance ID
+     */
+    audioUtteranceId(id: string): this;
+    /**
+     * Set callback URLs
+     */
+    callbackUrls(urls: RecognitionCallbackUrl[]): this;
+    /**
+     * Set user ID
+     */
+    userId(id: string): this;
+    /**
+     * Set game session ID
+     */
+    gameSessionId(id: string): this;
+    /**
+     * Set device ID
+     */
+    deviceId(id: string): this;
+    /**
+     * Set account ID
+     */
+    accountId(id: string): this;
+    /**
+     * Set question answer ID
+     */
+    questionAnswerId(id: string): this;
+    /**
+     * Set platform
+     */
+    platform(platform: string): this;
+    /**
+     * Set transcript callback
+     */
+    onTranscript(callback: (result: TranscriptionResultV1) => void): this;
+    /**
+     * Set metadata callback
+     */
+    onMetadata(callback: (metadata: MetadataResultV1) => void): this;
+    /**
+     * Set error callback
+     */
+    onError(callback: (error: ErrorResultV1) => void): this;
+    /**
+     * Set connected callback
+     */
+    onConnected(callback: () => void): this;
+    /**
+     * Set disconnected callback
+     */
+    onDisconnected(callback: (code: number, reason: string) => void): this;
+    /**
+     * Set high water mark
+     */
+    highWaterMark(bytes: number): this;
+    /**
+     * Set low water mark
+     */
+    lowWaterMark(bytes: number): this;
+    /**
+     * Set max buffer duration in seconds
+     */
+    maxBufferDurationSec(seconds: number): this;
+    /**
+     * Set chunks per second
+     */
+    chunksPerSecond(chunks: number): this;
+    /**
+     * Set logger function
+     */
+    logger(logger: (level: 'debug' | 'info' | 'warn' | 'error', message: string, data?: any) => void): this;
+    /**
+     * Build the configuration
+     */
+    build(): RealTimeTwoWayWebSocketRecognitionClientConfig;
+}
+//# sourceMappingURL=config-builder.d.ts.map

package/dist/config-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-builder.d.ts","sourceRoot":"","sources":["../src/config-builder.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EACV,8CAA8C,EAC9C,sBAAsB,EACvB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EACV,gBAAgB,EAChB,aAAa,EACb,qBAAqB,EACrB,gBAAgB,EAChB,aAAa,EACb,KAAK,EACN,MAAM,qBAAqB,CAAC;AAE7B;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAA+D;IAE7E;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAKtB;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI;IAKhD;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;IAKzC;;OAEG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,sBAAsB,EAAE,GAAG,IAAI;IAKlD;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKxB;;OAEG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAK/B;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAK1B;;OAEG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAK3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAKhC;;OAEG;IACH,YAAY,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,qBAAqB,KAAK,IAAI,GAAG,IAAI;IAKrE;;OAEG;IACH,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,gBAAgB,KAAK,IAAI,GAAG,IAAI;IAKhE;;OAEG;IACH,OAAO,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,GAAG,IAAI;IAKvD;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IAKvC;;OAEG;IACH,cAAc,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAKtE;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKjC;;OAEG;IACH,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAK3C;;OAEG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAKrC;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI;IAKvG;;OAEG;IACH,KAAK,IAAI,8CAA8C;CAGxD"}

package/dist/errors.d.ts

@@ -0,0 +1,41 @@
+/**
+ * SDK Error Classes
+ *
+ * Typed error classes that extend native Error with recognition-specific metadata
+ */
+import { ErrorTypeV1 } from '@recog/shared-types';
+/**
+ * Base class for all recognition SDK errors
+ */
+export declare class RecognitionError extends Error {
+    readonly errorType: ErrorTypeV1;
+    readonly timestamp: number;
+    constructor(errorType: ErrorTypeV1, message: string);
+}
+/**
+ * Connection error - thrown when WebSocket connection fails after all retry attempts
+ */
+export declare class ConnectionError extends RecognitionError {
+    readonly attempts: number;
+    readonly url: string;
+    readonly underlyingError?: Error;
+    constructor(message: string, attempts: number, url: string, underlyingError?: Error);
+}
+/**
+ * Timeout error - thrown when operations exceed timeout limits
+ */
+export declare class TimeoutError extends RecognitionError {
+    readonly timeoutMs: number;
+    readonly operation: string;
+    constructor(message: string, timeoutMs: number, operation: string);
+}
+/**
+ * Validation error - thrown when invalid configuration or input is provided
+ */
+export declare class ValidationError extends RecognitionError {
+    readonly field?: string;
+    readonly expected?: string;
+    readonly received?: string;
+    constructor(message: string, field?: string, expected?: string, received?: string);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAElD;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,KAAK;IACzC,SAAgB,SAAS,EAAE,WAAW,CAAC;IACvC,SAAgB,SAAS,EAAE,MAAM,CAAC;gBAEtB,SAAS,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM;CAWpD;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,gBAAgB;IACnD,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,SAAgB,GAAG,EAAE,MAAM,CAAC;IAC5B,SAAgB,eAAe,CAAC,EAAE,KAAK,CAAC;gBAE5B,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,KAAK;CASpF;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,gBAAgB;IAChD,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC,SAAgB,SAAS,EAAE,MAAM,CAAC;gBAEtB,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;CAMlE;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,gBAAgB;IACnD,SAAgB,KAAK,CAAC,EAAE,MAAM,CAAC;IAC/B,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClC,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAEtB,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM;CAalF"}

package/dist/factory.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Factory function for creating Recognition Client instances
+ */
+import { ConfigBuilder } from './config-builder.js';
+import type { IRecognitionClient, RealTimeTwoWayWebSocketRecognitionClientConfig } from './recognition-client.types.js';
+/**
+ * Create a recognition client from a configuration object
+ *
+ * Example:
+ * ```typescript
+ * const client = createClient({
+ *   url: 'ws://localhost:3101/ws/v1/recognize',
+ *   audioUtteranceId: 'unique-id',
+ *   onTranscript: (result) => console.log(result)
+ * });
+ * ```
+ *
+ * @param config - Client configuration
+ * @returns Configured recognition client instance
+ */
+export declare function createClient(config: RealTimeTwoWayWebSocketRecognitionClientConfig): IRecognitionClient;
+/**
+ * Create a recognition client using the builder pattern
+ *
+ * Example:
+ * ```typescript
+ * const client = createClientWithBuilder((builder) =>
+ *   builder
+ *     .url('ws://localhost:3101/ws/v1/recognize')
+ *     .onTranscript((result) => console.log(result))
+ *     .onError((error) => console.error(error))
+ * );
+ * ```
+ */
+export declare function createClientWithBuilder(configure: (builder: ConfigBuilder) => ConfigBuilder): IRecognitionClient;
+//# sourceMappingURL=factory.d.ts.map

package/dist/factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,KAAK,EAAE,kBAAkB,EAAE,8CAA8C,EAAE,MAAM,+BAA+B,CAAC;AAExH;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,8CAA8C,GAAG,kBAAkB,CAEvG;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,aAAa,GACnD,kBAAkB,CAIpB"}