@ikonai/sdk 0.0.1

package/connection/authenticator.d.ts

@@ -0,0 +1,53 @@
+import { AuthResponse } from '../../../platform-generated/src/index.ts';
+import { ApiKeyConfig, BrowserConfig, LocalConfig } from '../client/ikon-client-config';
+/**
+ * Result of authentication - contains the AuthResponse from the server.
+ */
+export interface AuthResult {
+    authResponse: AuthResponse;
+}
+/**
+ * Derive backend API URL from window.location.hostname.
+ * - If hostname contains '.dev.' → https://api.dev.ikon.live
+ * - Otherwise → https://api.prod.ikon.live
+ */
+export declare function deriveBackendUrl(): string;
+/**
+ * Extract space domain from hostname.
+ * - First checks VITE_IKON_SPACE_DOMAIN env variable (via import.meta.env)
+ * - Otherwise extracts first subdomain: myapp.dev.ikon.live → myapp
+ */
+export declare function deriveSpaceDomain(): string;
+/**
+ * Authenticate with a local Ikon server in development mode.
+ *
+ * Flow:
+ * 1. POST /connect-token with ConnectToken data → get JWT token
+ * 2. GET /connect?token=jwt → get binary AuthResponse
+ */
+export declare function authenticateLocal(config: LocalConfig, signal?: AbortSignal): Promise<AuthResult>;
+/**
+ * Authenticate with the Ikon backend using browser session cookies.
+ *
+ * Flow:
+ * 1. Derive backend URL and space domain from hostname
+ * 2. Fetch space info by domain
+ * 3. Fetch channels for space
+ * 4. Select channel (by channelKey or first available)
+ * 5. POST /rooms/connect and poll until running
+ * 6. Connect to the returned Ikon server URL
+ */
+export declare function authenticateBrowser(config: BrowserConfig, signal?: AbortSignal): Promise<AuthResult>;
+/**
+ * Authenticate with the Ikon backend using an API key.
+ *
+ * Flow:
+ * 1. POST /auth/api-key with { space, apiKey, user } → get JWT token
+ * 2. Use token as Bearer auth for backend requests
+ * 3. GET /profiles/me?space={spaceId} to create user profile
+ * 4. Fetch channels for space
+ * 5. Select channel (by channelKey or first available)
+ * 6. POST /rooms/connect and poll until running
+ * 7. Connect to the returned Ikon server URL
+ */
+export declare function authenticateApiKey(config: ApiKeyConfig, signal?: AbortSignal): Promise<AuthResult>;

package/errors/index.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Base class for all SDK connection-related errors.
+ */
+export declare class ConnectionError extends Error {
+    readonly cause?: Error | undefined;
+    constructor(message: string, cause?: Error | undefined);
+}
+/**
+ * Error thrown when authentication fails.
+ * This includes /connect-token failures, /connect failures, or invalid responses.
+ */
+export declare class AuthenticationError extends ConnectionError {
+    constructor(message: string, cause?: Error);
+}
+/**
+ * Error thrown when transport-level operations fail.
+ * This includes WebSocket connection failures and protocol errors.
+ */
+export declare class TransportError extends ConnectionError {
+    constructor(message: string, cause?: Error);
+}
+/**
+ * Error thrown when no keepalive is received within the timeout period.
+ */
+export declare class KeepaliveTimeoutError extends TransportError {
+    constructor(timeoutMs: number);
+}
+/**
+ * Error thrown when maximum reconnection attempts are exhausted.
+ */
+export declare class MaxRetriesExceededError extends ConnectionError {
+    constructor(maxAttempts: number);
+}
+/**
+ * Error thrown when cloud channel provisioning times out.
+ */
+export declare class ProvisioningTimeoutError extends AuthenticationError {
+    constructor(timeoutMs: number);
+}
+/**
+ * Error thrown when a channel with the specified key is not found.
+ */
+export declare class ChannelNotFoundError extends AuthenticationError {
+    constructor(channelKey: string);
+}
+/**
+ * Error thrown when no space is found for the given domain.
+ */
+export declare class SpaceNotFoundError extends AuthenticationError {
+    constructor(domain: string);
+}
+/**
+ * Error thrown when no channels are available in the space.
+ */
+export declare class NoChannelsError extends AuthenticationError {
+    constructor();
+}

package/index.d.ts

@@ -0,0 +1,16 @@
+export { IkonClient, type ProtocolMessageHandler, type StateHandler } from './client/ikon-client';
+export type { IkonClientConfig, LocalConfig, BrowserConfig, ApiKeyConfig, CloudConnectionConfig, CommonConnectionConfig, TimeoutConfig, BackendType } from './client/ikon-client-config';
+export type { ConnectionState } from './client/connection-state';
+export { isConnecting, isConnected, isOffline, isError } from './client/connection-state';
+export { ChannelManager, type ChannelManagerConfig, type ChannelManagerState } from './channel/channel-manager';
+export { Channel, type ChannelConfig, type ChannelState } from './channel/channel';
+export { EndpointSelector } from './client/endpoint-selector';
+export { ConnectionError, AuthenticationError, TransportError, KeepaliveTimeoutError, MaxRetriesExceededError, ProvisioningTimeoutError, ChannelNotFoundError, SpaceNotFoundError, NoChannelsError, } from './errors';
+export { Opcode, EntrypointType, ClientReady, UserType, ClientType, ContextType } from '../../platform-generated/src/index.ts';
+export type { ProtocolMessage, ProtocolMessageHeaders } from '../../platform-generated/src/index.ts';
+export { teleportReadOpcode as readOpcode, teleportReadOpcodeGroup as readOpcodeGroup, asProtocolMessage, readProtocolMessageHeaders } from '../../platform-generated/src/index.ts';
+export { isWebTransportSupported } from './transport/web-transport-transport';
+export { setLogLevel, setLogSink, getLogLevel, getLogSink, createLogger, LogLevel } from './utils/logger';
+export type { LogEntry, LogSink, Logger } from './utils/logger';
+export { initializeLogSink, setSendLogsCallback, getBufferedLogs, takeBufferedLogs, flushLogs, clearLogBuffer, getLogBufferSize } from './utils/logSink';
+export type { LogSinkConfig } from './utils/logSink';