@signalwire/js 4.0.0-dev-20260428183200 → 4.0.0-dev-20260429174756

package/dist/index.d.cts

@@ -84,7 +84,7 @@ type WebSocketAdapter = new (url: string | URL, protocols?: string | string[]) =
  * At least one of `token` or `authorizationState` must be provided.
  */
 interface SDKCredential {
-  /** JWT subscriber access token (SAT). */
+  /** JWT user access token (SAT). */
   token?: string;
   /** Pre-authorized session state (alternative to token). */
   authorizationState?: string;
@@ -626,57 +626,57 @@ interface SATClaims {
   expires_at?: number;
 }
 //#endregion
-//#region src/core/types/subscriber.types.d.ts
-/** Raw subscriber profile response from the SignalWire Fabric API. */
-interface GetSubscriberInfoResponse {
-  /** Unique subscriber identifier. */
+//#region src/core/types/user.types.d.ts
+/** Raw user profile response from the SignalWire Fabric API. */
+interface GetUserInfoResponse {
+  /** Unique user identifier. */
   id: string;
-  /** Subscriber's email address. */
+  /** User's email address. */
   email: string;
-  /** Subscriber's first name. */
+  /** User's first name. */
   first_name?: string;
-  /** Subscriber's last name. */
+  /** User's last name. */
   last_name?: string;
-  /** Subscriber's display name. */
+  /** User's display name. */
   display_name?: string;
-  /** Subscriber's job title. */
+  /** User's job title. */
   job_title?: string;
-  /** Subscriber's time zone offset. */
+  /** User's time zone offset. */
   time_zone?: number;
-  /** Subscriber's country. */
+  /** User's country. */
   country?: string;
-  /** Subscriber's region or state. */
+  /** User's region or state. */
   region?: string;
-  /** Subscriber's company name. */
+  /** User's company name. */
   company_name?: string;
   /** Key for push notification delivery. */
   push_notification_key: string;
-  /** Application-level settings for this subscriber. */
+  /** Application-level settings for this user. */
   app_settings?: {
     /** Display name configured at the application level. */
     display_name: string;
-    /** Permission scopes granted to this subscriber. */
+    /** Permission scopes granted to this user. */
     scopes: string[];
   };
-  /** Fabric addresses associated with this subscriber. */
+  /** Fabric addresses associated with this user. */
   fabric_addresses: GetAddressResponse[];
   /** Filtered SAT claims (scope, cnf, expires_at) returned when the token has special capabilities. */
   sat_claims?: SATClaims;
 }
 //#endregion
-//#region src/core/entities/Subscriber.d.ts
-/** Subscriber online presence state. */
-type SubscriberPresence = 'online' | 'offline' | 'busy';
+//#region src/core/entities/User.d.ts
+/** User online presence state. */
+type UserPresence = 'online' | 'offline' | 'busy';
 /**
- * Authenticated subscriber profile.
+ * Authenticated user profile.
  *
  * Fetched automatically when a {@link SignalWire} connects.
  * Contains identity, contact, and organization details.
  */
-declare class Subscriber extends Fetchable<GetSubscriberInfoResponse> {
-  /** Unique subscriber identifier. */
+declare class User extends Fetchable<GetUserInfoResponse> {
+  /** Unique user identifier. */
   id: string;
-  /** Subscriber email address. */
+  /** User email address. */
   email: string;
   /** First name. */
   firstName?: string;
@@ -701,12 +701,12 @@ declare class Subscriber extends Fetchable<GetSubscriberInfoResponse> {
     displayName: string;
     scopes: string[];
   };
-  /** Fabric addresses associated with this subscriber. */
+  /** Fabric addresses associated with this user. */
   addresses: GetAddressResponse[];
   /** Filtered SAT claims when the token has special capabilities (e.g., refresh scope). */
   satClaims?: SATClaims;
   constructor(http: HTTPRequestController);
-  protected populateInstance(data: GetSubscriberInfoResponse): void;
+  protected populateInstance(data: GetUserInfoResponse): void;
 }
 //#endregion
 //#region src/core/types/call.types.d.ts
@@ -1780,8 +1780,8 @@ declare class Participant extends Destroyable implements CallParticipant {
   get denoise$(): Observable<boolean | undefined>;
   /** Observable of custom metadata for this participant. */
   get meta$(): Observable<Record<string, unknown> | undefined>;
-  /** Observable of the participant's subscriber ID. */
-  get subscriberId$(): Observable<string | undefined>;
+  /** Observable of the participant's user ID. */
+  get userId$(): Observable<string | undefined>;
   /** Observable of the participant's address ID. */
   get addressId$(): Observable<string | undefined>;
   /** Observable of the server node ID for this participant. */
@@ -1838,8 +1838,8 @@ declare class Participant extends Destroyable implements CallParticipant {
   get denoise(): boolean;
   /** Custom metadata for this participant, or `undefined` if not set. */
   get meta(): Record<string, unknown> | undefined;
-  /** Subscriber ID of this participant, or `undefined` if not available. */
-  get subscriberId(): string | undefined;
+  /** User ID of this participant, or `undefined` if not available. */
+  get userId(): string | undefined;
   /** Address ID of this participant, or `undefined` if not available. */
   get addressId(): string | undefined;
   /** Server node ID for this participant, or `undefined` if not available. */
@@ -2057,7 +2057,7 @@ interface CallParticipant {
   readonly lowbitrate$: Observable<boolean | undefined>;
   readonly denoise$: Observable<boolean | undefined>;
   readonly meta$: Observable<Record<string, unknown> | undefined>;
-  readonly subscriberId$: Observable<string | undefined>;
+  readonly userId$: Observable<string | undefined>;
   readonly addressId$: Observable<string | undefined>;
   readonly nodeId$: Observable<string | undefined>;
   readonly isTalking$: Observable<boolean | undefined>;
@@ -2078,7 +2078,7 @@ interface CallParticipant {
   readonly lowbitrate: boolean;
   readonly denoise: boolean;
   readonly meta: Record<string, unknown> | undefined;
-  readonly subscriberId: string | undefined;
+  readonly userId: string | undefined;
   readonly addressId: string | undefined;
   readonly nodeId: string | undefined;
   readonly isTalking: boolean;
@@ -2899,14 +2899,14 @@ declare class ClientSessionManager extends Destroyable implements SessionState {
   private _authState$;
   /** Sticky flag — once true, stays true for the session lifetime. */
   private _wasClientBound;
-  private _subscriberInfo$;
+  private _userInfo$;
   private _calls$;
   private _iceServers$;
   constructor(getCredential: () => SDKCredential, transport: TransportManager, storage: StorageManager, authorizationStateKey: string, deviceController: DeviceController, attachManager: AttachManager, webRTCApiProvider: WebRTCApiProvider, dpopManager?: CryptoController | undefined, networkChange$?: Observable<NetworkChangeEvent>);
   get incomingCalls$(): Observable<Call[]>;
   get incomingCalls(): Call[];
-  get subscriberInfo$(): Observable<Address | null>;
-  get subscriberInfo(): Address | null;
+  get userInfo$(): Observable<Address | null>;
+  get userInfo(): Address | null;
   get calls$(): Observable<Call[]>;
   get calls(): Call[];
   get iceServers(): RTCIceServer[] | undefined;
@@ -3334,7 +3334,7 @@ declare const getLogger: () => InternalSDKLogger;
 interface SignalWireOptions {
   /** Skip automatic WebSocket connection on construction. */
   skipConnection?: boolean;
-  /** Skip automatic subscriber registration on construction. */
+  /** Skip automatic user registration on construction. */
   skipRegister?: boolean;
   /** Skip monitoring media device changes. */
   skipDeviceMonitoring?: boolean;
@@ -3413,7 +3413,7 @@ interface DialOptions extends MediaOptions {
 declare class SignalWire extends Destroyable implements DeviceController {
   /** Global SDK preferences (timeouts, ICE config, media defaults). */
   preferences: ClientPreferences;
-  private _subscriber$;
+  private _user$;
   private _directory$;
   private _transport;
   private _clientSession;
@@ -3503,19 +3503,19 @@ declare class SignalWire extends Destroyable implements DeviceController {
    */
   connect(): Promise<void>;
   /**
-   * Observable that emits the {@link Subscriber} profile once fetched,
+   * Observable that emits the {@link User} profile once fetched,
    * or `undefined` before authentication completes.
    *
    * @example
    * ```ts
-   * client.subscriber$.subscribe(sub => {
-   *   if (sub) console.log('Logged in as', sub.email);
+   * client.user$.subscribe(u => {
+   *   if (u) console.log('Logged in as', u.email);
    * });
    * ```
    */
-  get subscriber$(): Observable<Subscriber | undefined>;
-  /** Current subscriber snapshot, or `undefined` if not yet authenticated. */
-  get subscriber(): Subscriber | undefined;
+  get user$(): Observable<User | undefined>;
+  /** Current user snapshot, or `undefined` if not yet authenticated. */
+  get user(): User | undefined;
   /**
    * Observable that emits the {@link Directory} instance once the client is connected,
    * or `undefined` while disconnected. Subscribe to this to safely wait for the directory
@@ -3534,9 +3534,9 @@ declare class SignalWire extends Destroyable implements DeviceController {
    * Prefer {@link directory$} when you need to react to the directory becoming available.
    */
   get directory(): Directory | undefined;
-  /** Observable that emits when the subscriber registration state changes. */
+  /** Observable that emits when the user registration state changes. */
   get isRegistered$(): Observable<boolean>;
-  /** Whether the subscriber is currently registered. */
+  /** Whether the user is currently registered. */
   get isRegistered(): boolean;
   /** Whether the client is currently connected. */
   get isConnected(): boolean;
@@ -3574,7 +3574,7 @@ declare class SignalWire extends Destroyable implements DeviceController {
   private teardownTransportAndSession;
   private waitAuthentication;
   /**
-   * Registers the subscriber as online to receive inbound calls and events.
+   * Registers the user as online to receive inbound calls and events.
    *
    * Waits for authentication to complete before sending the registration.
    * If the initial attempt fails, reauthentication is attempted automatically.
@@ -3583,7 +3583,7 @@ declare class SignalWire extends Destroyable implements DeviceController {
    */
   register(): Promise<void>;
   /**
-   * Unregisters the subscriber, going offline for inbound calls.
+   * Unregisters the user, going offline for inbound calls.
    *
    * The WebSocket connection remains open; use {@link disconnect} to fully close it.
    */
@@ -4737,5 +4737,5 @@ declare const version: string;
  */
 declare const ready: boolean;
 //#endregion
-export { Address, type AddressHistory, type AudioConstraintsEvent, type AuthenticateContext, type Call, type CallAddress, type CallCapabilitiesState, CallCreateError, type CallDiagnosticSummary, type CallDirection, type CallError, type CallErrorKind, type NetworkIssue as CallNetworkIssue, type NetworkIssue, type NetworkMetrics as CallNetworkMetrics, type NetworkMetrics, type CallOptions, type CallParticipant, type CallSelfParticipant, type CallState, type CallStatus, type Capability, ClientPreferences, CollectionFetchError, type ConstraintFallbackEvent, type CredentialProvider, DPoPInitError, type DebugOptions, type DeviceController, type DeviceRecoveryEvent, DeviceTokenError, type DiagnosticEvent, type DialOptions, type Directory, EmbedTokenCredentialProvider, type ExecuteMethod, InvalidCredentialsError, type JSONRPCErrorResponse, type JSONRPCRequest, type JSONRPCResponse, type JSONRPCSuccessResponse, type LayoutLayer, type LogLevel, type MediaDirection, type MediaDirections, type MediaOptions, type MediaParamsEvent, MediaTrackError, type MemberCapabilities, MessageParseError, type NodeSocketAdapter, type OnOffCapability, OverconstrainedFallbackError, Participant, type PendingRPCOptions, type PermissionResult, type PlatformCapabilities, PreflightError, type PreflightOptions, type PreflightResult, type QualityLevel, RecoveryError, type RecoveryEvent, type RecoveryState, type ResilienceCallStatus, type SATClaims, type SDKCredential, type SDKLogger, type ScreenShareStatus, type SelectDeviceOptions, SelfCapabilities, SelfParticipant, type SessionDiagnostics, type SessionState, SignalWire, type SignalWireOptions, StaticCredentialProvider, type Storage, type StoredDevicePreference, Subscriber, type SubscriberPresence, type TextMessage, TokenRefreshError, type TransferOptions, UnexpectedError, VertoPongError, type VideoPosition, type WebRTCApiProvider, WebRTCCall, type WebRTCMediaDevices, type WebSocketAdapter, embeddableCall, getLogger, isSelfParticipant, ready, setDebugOptions, setLogLevel, setLogger, version };
+export { Address, type AddressHistory, type AudioConstraintsEvent, type AuthenticateContext, type Call, type CallAddress, type CallCapabilitiesState, CallCreateError, type CallDiagnosticSummary, type CallDirection, type CallError, type CallErrorKind, type NetworkIssue as CallNetworkIssue, type NetworkIssue, type NetworkMetrics as CallNetworkMetrics, type NetworkMetrics, type CallOptions, type CallParticipant, type CallSelfParticipant, type CallState, type CallStatus, type Capability, ClientPreferences, CollectionFetchError, type ConstraintFallbackEvent, type CredentialProvider, DPoPInitError, type DebugOptions, type DeviceController, type DeviceRecoveryEvent, DeviceTokenError, type DiagnosticEvent, type DialOptions, type Directory, EmbedTokenCredentialProvider, type ExecuteMethod, InvalidCredentialsError, type JSONRPCErrorResponse, type JSONRPCRequest, type JSONRPCResponse, type JSONRPCSuccessResponse, type LayoutLayer, type LogLevel, type MediaDirection, type MediaDirections, type MediaOptions, type MediaParamsEvent, MediaTrackError, type MemberCapabilities, MessageParseError, type NodeSocketAdapter, type OnOffCapability, OverconstrainedFallbackError, Participant, type PendingRPCOptions, type PermissionResult, type PlatformCapabilities, PreflightError, type PreflightOptions, type PreflightResult, type QualityLevel, RecoveryError, type RecoveryEvent, type RecoveryState, type ResilienceCallStatus, type SATClaims, type SDKCredential, type SDKLogger, type ScreenShareStatus, type SelectDeviceOptions, SelfCapabilities, SelfParticipant, type SessionDiagnostics, type SessionState, SignalWire, type SignalWireOptions, StaticCredentialProvider, type Storage, type StoredDevicePreference, type TextMessage, TokenRefreshError, type TransferOptions, UnexpectedError, User, type UserPresence, VertoPongError, type VideoPosition, type WebRTCApiProvider, WebRTCCall, type WebRTCMediaDevices, type WebSocketAdapter, embeddableCall, getLogger, isSelfParticipant, ready, setDebugOptions, setLogLevel, setLogger, version };
 //# sourceMappingURL=index.d.cts.map