@ikonai/sdk 1.8.0 → 1.10.0

package/client/ikon-client.d.ts

@@ -62,9 +62,20 @@ export interface ProtocolMessageSubscriptionOptions {
  * State handler callback type for state subscribers.
  */
 export type StateHandler = (state: ConnectionState) => void;
+/** How a dispatched UI action should be treated when the server refuses it. */
+export interface SendActionCallOptions {
+    /**
+     * The dispatch is a component's own bookkeeping rather than something a person did, so a refusal
+     * is not worth a person's attention: a controlled overlay reports itself closed as it unmounts,
+     * and when the whole subtree is going away the server has already retired that action. Such a
+     * failure is logged at debug instead of error.
+     */
+    bestEffort?: boolean;
+}
 /** The server-side outcome of a dispatched UI action (see {@link IkonClient.sendActionCallWithResult}). */
 export interface ActionOutcome {
     success: boolean;
+    /** Empty: the server keeps the exception in its own log, so a failure carries no reason here. */
     errorMessage: string;
 }
 export declare class IkonClient {
@@ -102,6 +113,7 @@ export declare class IkonClient {
     private readonly _pendingActionAcks;
     private _ackRttMs;
     private readonly _actionIdByCallId;
+    private readonly _bestEffortCallIds;
     private readonly _pendingActionResults;
     private readonly endpointSelector;
     private readonly _webRtcReachability;
@@ -129,8 +141,10 @@ export declare class IkonClient {
     private unregisterBrowserFunctions;
     private unregisterMediaCaptureFunctions;
     private unregisterSoundFunctions;
+    private unregisterDownloadFunctions;
     private unregisterLoginInterceptor;
     private nextProtocolPortId;
+    private _deliveringViaDataChannel;
     private nextProtocolSendPortId;
     private readonly _audioEnabled;
     private readonly _videoEnabled;
@@ -161,6 +175,7 @@ export declare class IkonClient {
     private _reconnectTimer;
     private _joinWatchdogTimer;
     private _serverStopped;
+    private _credentialRejected;
     private _hasBeenConnected;
     private _waitForExternalConnectUrl;
     private _externalConnectUrlCleanup;
@@ -403,7 +418,7 @@ export declare class IkonClient {
      * Disconnect from the server.
      */
     disconnect(): void;
-    sendActionCall(actionId: string, payload?: string): void;
+    sendActionCall(actionId: string, payload?: string, options?: SendActionCallOptions): void;
     /**
      * Dispatch a UI action and resolve with the server handler's actual outcome — the
      * ActionResult the server emits when the handler finishes (the ActionCallAck is only a
@@ -446,6 +461,14 @@ export declare class IkonClient {
      * Routes to appropriate channel based on the message's opcode group.
      */
     sendProtocolMessage(message: ProtocolMessage): void;
+    /**
+     * Hand an error to the app's onError callback.
+     *
+     * For SDK subsystems (media playback, capture) whose failure leaves the connection itself
+     * intact: the client stays connected, so this callback is the only place the app can learn
+     * that a session went silent or blind.
+     */
+    reportError(error: Error): void;
     /**
      * Send a client context update to the server.
      * This notifies the server of changes to viewport size, theme, or timezone.

package/functions/download-functions.d.ts

@@ -0,0 +1,8 @@
+import { FunctionRegistry } from './function-registry';
+export declare const DownloadFunctionNames: {
+    readonly DownloadFile: "ikon.client.downloadFile";
+};
+/**
+ * Register download functions with a registry. Returns an unregister function.
+ */
+export declare function registerDownloadFunctions(registry: FunctionRegistry): () => void;

package/functions/index.d.ts

@@ -3,3 +3,4 @@ export { withResultData, FunctionCallError } from './types';
 export { FunctionRegistry, type FunctionRegistryConfig, type ErrorInterceptor } from './function-registry';
 export { registerBrowserFunctions, isBrowserEnvironment } from './browser-functions';
 export { registerSoundFunctions, SoundFunctionNames } from './sound-functions';
+export { registerDownloadFunctions, DownloadFunctionNames } from './download-functions';

package/index.d.ts

@@ -1,4 +1,4 @@
-export { IkonClient, type ActionOutcome, type ProtocolMessageHandler, type StateHandler, type ProtocolMessageSubscriptionOptions, type ProtocolMessagePort, type ProtocolSendPort, type WebRTCTrackMapInfo } from './client/ikon-client';
+export { IkonClient, type ActionOutcome, type SendActionCallOptions, type ProtocolMessageHandler, type StateHandler, type ProtocolMessageSubscriptionOptions, type ProtocolMessagePort, type ProtocolSendPort, type WebRTCTrackMapInfo } from './client/ikon-client';
 export { AppMessaging, appMessaging, type AppMessageType, type AppMessageSubscription } from './app-messaging';
 export type { IkonClientConfig, LocalConfig, ApiKeyConfig, SessionTokenConfig, CloudConnectionConfig, CommonConnectionConfig, TimeoutConfig, BackendType, AudioConfig, VideoConfig, MediaSessionConfig, WebRtcConfig } from './client/ikon-client-config';
 export { DEFAULT_LOCAL_SERVER_HOST, DEFAULT_LOCAL_SERVER_PORT, DEFAULT_SLOW_CONNECTION_THRESHOLD_MS } from './client/ikon-client-config';