@ikonai/sdk 1.3.7 → 1.3.9

package/connection/authenticator.d.ts

@@ -1,4 +1,4 @@
-import { AuthResponse } from '../../shared/protocol/src/index.ts';
+import { AuthResponse, ClientEnvironment } from '../../shared/protocol/src/index.ts';
 import { ApiKeyConfig, LocalConfig, SessionTokenConfig } from '../client/ikon-client-config';
 import { ProxyMode } from '../client/endpoint-selector';
 /**
@@ -14,8 +14,14 @@ export interface AuthResult {
 }
 /**
  * Common authentication logic - fetch the connect URL and decode the AuthResponse.
+ *
+ * Every path that reaches an Ikon server goes through here — local, cloud, and the shareable URL a
+ * preview hands out — so this is where the client environment is attached. A caller that knows more
+ * than ambient browser state (its configured product id, description, locale) passes `environment`;
+ * the shareable-URL path has no config and gets the ambient one, which is what it would have been
+ * given anyway.
  */
-export declare function authenticateWithUrl(connectUrl: string, signal?: AbortSignal, timeoutMs?: number): Promise<AuthResult>;
+export declare function authenticateWithUrl(connectUrl: string, signal?: AbortSignal, timeoutMs?: number, environment?: ClientEnvironment): Promise<AuthResult>;
 /**
  * Probe server health by fetching the /health endpoint.
  * Returns true if the server responds with HTTP 200 within the timeout.

package/index.d.ts

@@ -20,7 +20,7 @@ export { abortSignalTimeout, abortSignalAny } from './utils/abort-signal';
 export { createPkceChallenge, takePkceVerifier, restorePkceVerifier, isPkceSupported } from './utils/pkce';
 export { isEmbedded, startEmbeddedOAuthSignIn, adoptPkceVerifierFromUrl, onEmbeddedOAuthResult, PKCE_URL_PARAM, type EmbeddedOAuthResult } from './utils/embedded-oauth';
 export { initializeInspectMode, isInspectModeEnabled, enableInspectMode, IKON_INSPECT_MODE_CHANGED_EVENT } from './utils/inspect-mode';
-export { getLangParam, getProxyParam, getWebSocketParam, getWebTransportParam, getDebugParam, getServerUrlParam, getAudioParam, getVideoParam, getWebRtcParam, getInspectParam, getDebugOverlayParam, getAuthSameOriginParam, getRetryParam, setSdkUrlParam, IKON_PARAM_PROXY, IKON_PARAM_WEBSOCKET, IKON_PARAM_WEBTRANSPORT, IKON_PARAM_DEBUG, IKON_PARAM_LANG, IKON_PARAM_SERVER_URL, IKON_PARAM_AUDIO, IKON_PARAM_VIDEO, IKON_PARAM_WEBRTC, IKON_PARAM_INSPECT, IKON_PARAM_DEBUG_OVERLAY, IKON_PARAM_AUTH, IKON_PARAM_RETRY } from './utils/query-params';
+export { getLangParam, getProxyParam, getWebSocketParam, getWebTransportParam, getDebugParam, getServerUrlParam, getConnectParam, getAudioParam, getVideoParam, getWebRtcParam, getInspectParam, getDebugOverlayParam, getAuthSameOriginParam, getRetryParam, setSdkUrlParam, IKON_PARAM_PROXY, IKON_PARAM_WEBSOCKET, IKON_PARAM_WEBTRANSPORT, IKON_PARAM_DEBUG, IKON_PARAM_LANG, IKON_PARAM_SERVER_URL, IKON_PARAM_CONNECT, IKON_PARAM_AUDIO, IKON_PARAM_VIDEO, IKON_PARAM_WEBRTC, IKON_PARAM_INSPECT, IKON_PARAM_DEBUG_OVERLAY, IKON_PARAM_AUTH, IKON_PARAM_RETRY } from './utils/query-params';
 export { getOpcodeName } from './utils/opcode-names';
 export { initializeLogSink, setSendLogsCallback, getBufferedLogs, takeBufferedLogs, flushLogs, clearLogBuffer, getLogBufferSize } from './utils/log-sink';
 export type { LogSinkConfig } from './utils/log-sink';