@telnyx/react-voice-commons-sdk 0.1.1 → 0.1.3

package/src/models/config.ts

@@ -1,125 +1,125 @@
-/**
- * Configuration for credential-based authentication
- */
-export interface CredentialConfig {
-  type: 'credential';
-  sipUser: string;
-  sipPassword: string;
-  debug?: boolean;
-  pushNotificationDeviceToken?: string;
-}
-
-/**
- * Configuration for token-based authentication
- */
-export interface TokenConfig {
-  type: 'token';
-  token: string;
-  debug?: boolean;
-  pushNotificationDeviceToken?: string;
-}
-
-/**
- * Union type for all supported authentication configurations
- */
-export type Config = CredentialConfig | TokenConfig;
-
-/**
- * Type guard to check if config is credential-based
- */
-export function isCredentialConfig(config: Config): config is CredentialConfig {
-  return config.type === 'credential';
-}
-
-/**
- * Type guard to check if config is token-based
- */
-export function isTokenConfig(config: Config): config is TokenConfig {
-  return config.type === 'token';
-}
-
-/**
- * Validates a credential configuration
- */
-export function validateCredentialConfig(config: CredentialConfig): string[] {
-  const errors: string[] = [];
-
-  if (!config.sipUser || config.sipUser.trim() === '') {
-    errors.push('sipUser is required');
-  }
-
-  if (!config.sipPassword || config.sipPassword.trim() === '') {
-    errors.push('sipPassword is required');
-  }
-
-  return errors;
-}
-
-/**
- * Validates a token configuration
- */
-export function validateTokenConfig(config: TokenConfig): string[] {
-  const errors: string[] = [];
-
-  if (!config.token || config.token.trim() === '') {
-    errors.push('token is required');
-  }
-
-  return errors;
-}
-
-/**
- * Validates any configuration
- */
-export function validateConfig(config: Config): string[] {
-  if (isCredentialConfig(config)) {
-    return validateCredentialConfig(config);
-  } else if (isTokenConfig(config)) {
-    return validateTokenConfig(config);
-  } else {
-    return ['Invalid configuration type'];
-  }
-}
-
-/**
- * Creates a credential configuration
- *
- * @param sipUser - SIP username for authentication
- * @param sipPassword - SIP password for authentication
- * @param options - Optional configuration settings
- * @param options.debug - Enable debug logging (sets SDK logLevel to 'debug')
- * @param options.pushNotificationDeviceToken - Device token for push notifications
- * @returns Complete credential configuration object
- */
-export function createCredentialConfig(
-  sipUser: string,
-  sipPassword: string,
-  options?: Partial<Omit<CredentialConfig, 'type' | 'sipUser' | 'sipPassword'>>
-): CredentialConfig {
-  return {
-    type: 'credential',
-    sipUser,
-    sipPassword,
-    ...options,
-  };
-}
-
-/**
- * Creates a token-based configuration
- *
- * @param sipToken - JWT token for authentication
- * @param options - Optional configuration settings
- * @param options.debug - Enable debug logging (sets SDK logLevel to 'debug')
- * @param options.pushNotificationDeviceToken - Device token for push notifications
- * @returns Complete token configuration object
- */
-export function createTokenConfig(
-  sipToken: string,
-  options?: Partial<Omit<TokenConfig, 'type' | 'sipToken'>>
-): TokenConfig {
-  return {
-    type: 'token',
-    token: sipToken,
-    ...options,
-  };
-}
+/**
+ * Configuration for credential-based authentication
+ */
+export interface CredentialConfig {
+  type: 'credential';
+  sipUser: string;
+  sipPassword: string;
+  debug?: boolean;
+  pushNotificationDeviceToken?: string;
+}
+
+/**
+ * Configuration for token-based authentication
+ */
+export interface TokenConfig {
+  type: 'token';
+  token: string;
+  debug?: boolean;
+  pushNotificationDeviceToken?: string;
+}
+
+/**
+ * Union type for all supported authentication configurations
+ */
+export type Config = CredentialConfig | TokenConfig;
+
+/**
+ * Type guard to check if config is credential-based
+ */
+export function isCredentialConfig(config: Config): config is CredentialConfig {
+  return config.type === 'credential';
+}
+
+/**
+ * Type guard to check if config is token-based
+ */
+export function isTokenConfig(config: Config): config is TokenConfig {
+  return config.type === 'token';
+}
+
+/**
+ * Validates a credential configuration
+ */
+export function validateCredentialConfig(config: CredentialConfig): string[] {
+  const errors: string[] = [];
+
+  if (!config.sipUser || config.sipUser.trim() === '') {
+    errors.push('sipUser is required');
+  }
+
+  if (!config.sipPassword || config.sipPassword.trim() === '') {
+    errors.push('sipPassword is required');
+  }
+
+  return errors;
+}
+
+/**
+ * Validates a token configuration
+ */
+export function validateTokenConfig(config: TokenConfig): string[] {
+  const errors: string[] = [];
+
+  if (!config.token || config.token.trim() === '') {
+    errors.push('token is required');
+  }
+
+  return errors;
+}
+
+/**
+ * Validates any configuration
+ */
+export function validateConfig(config: Config): string[] {
+  if (isCredentialConfig(config)) {
+    return validateCredentialConfig(config);
+  } else if (isTokenConfig(config)) {
+    return validateTokenConfig(config);
+  } else {
+    return ['Invalid configuration type'];
+  }
+}
+
+/**
+ * Creates a credential configuration
+ *
+ * @param sipUser - SIP username for authentication
+ * @param sipPassword - SIP password for authentication
+ * @param options - Optional configuration settings
+ * @param options.debug - Enable debug logging (sets SDK logLevel to 'debug')
+ * @param options.pushNotificationDeviceToken - Device token for push notifications
+ * @returns Complete credential configuration object
+ */
+export function createCredentialConfig(
+  sipUser: string,
+  sipPassword: string,
+  options?: Partial<Omit<CredentialConfig, 'type' | 'sipUser' | 'sipPassword'>>
+): CredentialConfig {
+  return {
+    type: 'credential',
+    sipUser,
+    sipPassword,
+    ...options,
+  };
+}
+
+/**
+ * Creates a token-based configuration
+ *
+ * @param sipToken - JWT token for authentication
+ * @param options - Optional configuration settings
+ * @param options.debug - Enable debug logging (sets SDK logLevel to 'debug')
+ * @param options.pushNotificationDeviceToken - Device token for push notifications
+ * @returns Complete token configuration object
+ */
+export function createTokenConfig(
+  sipToken: string,
+  options?: Partial<Omit<TokenConfig, 'type' | 'sipToken'>>
+): TokenConfig {
+  return {
+    type: 'token',
+    token: sipToken,
+    ...options,
+  };
+}

package/src/models/connection-state.ts

@@ -1,50 +1,50 @@
-/**
- * Represents the connection state to the Telnyx platform.
- *
- * This enum provides a simplified view of the connection status,
- * abstracting away the complexity of the underlying WebSocket states.
- */
-export enum TelnyxConnectionState {
-  /** Initial state before any connection attempt */
-  DISCONNECTED = 'DISCONNECTED',
-
-  /** Attempting to establish connection */
-  CONNECTING = 'CONNECTING',
-
-  /** Successfully connected and authenticated */
-  CONNECTED = 'CONNECTED',
-
-  /** Connection lost, attempting to reconnect */
-  RECONNECTING = 'RECONNECTING',
-
-  /** Connection failed or authentication error */
-  ERROR = 'ERROR',
-}
-
-/**
- * Type guard to check if a value is a valid TelnyxConnectionState
- */
-export function isTelnyxConnectionState(value: any): value is TelnyxConnectionState {
-  return Object.values(TelnyxConnectionState).includes(value);
-}
-
-/**
- * Helper function to determine if the connection state allows making calls
- */
-export function canMakeCalls(state: TelnyxConnectionState): boolean {
-  return state === TelnyxConnectionState.CONNECTED;
-}
-
-/**
- * Helper function to determine if the connection state indicates an active connection
- */
-export function isConnected(state: TelnyxConnectionState): boolean {
-  return state === TelnyxConnectionState.CONNECTED;
-}
-
-/**
- * Helper function to determine if the connection is in a transitional state
- */
-export function isTransitioning(state: TelnyxConnectionState): boolean {
-  return state === TelnyxConnectionState.CONNECTING || state === TelnyxConnectionState.RECONNECTING;
-}
+/**
+ * Represents the connection state to the Telnyx platform.
+ *
+ * This enum provides a simplified view of the connection status,
+ * abstracting away the complexity of the underlying WebSocket states.
+ */
+export enum TelnyxConnectionState {
+  /** Initial state before any connection attempt */
+  DISCONNECTED = 'DISCONNECTED',
+
+  /** Attempting to establish connection */
+  CONNECTING = 'CONNECTING',
+
+  /** Successfully connected and authenticated */
+  CONNECTED = 'CONNECTED',
+
+  /** Connection lost, attempting to reconnect */
+  RECONNECTING = 'RECONNECTING',
+
+  /** Connection failed or authentication error */
+  ERROR = 'ERROR',
+}
+
+/**
+ * Type guard to check if a value is a valid TelnyxConnectionState
+ */
+export function isTelnyxConnectionState(value: any): value is TelnyxConnectionState {
+  return Object.values(TelnyxConnectionState).includes(value);
+}
+
+/**
+ * Helper function to determine if the connection state allows making calls
+ */
+export function canMakeCalls(state: TelnyxConnectionState): boolean {
+  return state === TelnyxConnectionState.CONNECTED;
+}
+
+/**
+ * Helper function to determine if the connection state indicates an active connection
+ */
+export function isConnected(state: TelnyxConnectionState): boolean {
+  return state === TelnyxConnectionState.CONNECTED;
+}
+
+/**
+ * Helper function to determine if the connection is in a transitional state
+ */
+export function isTransitioning(state: TelnyxConnectionState): boolean {
+  return state === TelnyxConnectionState.CONNECTING || state === TelnyxConnectionState.RECONNECTING;
+}