@ably/chat/src/core/client-id.ts

Ably Chat is a set of purpose-built APIs for a host of chat features enabling you to create 1:1, 1:Many, Many:1 and Many:Many chat rooms for any scale. It is designed to meet a wide range of chat use cases, such as livestreams, in-game communication, cust

import * as Ably from 'ably';

import { ErrorCode } from './errors.js';
import { Logger } from './logger.js';

/**
 * Interface for a type that resolves the current clientId from the realtime client.
 */
export interface ClientIdResolver {
  /**
   * Return the current clientId, throwing an exception if one isn't set.
   * @throws Ably.ErrorInfo if no clientId is set.
   * @returns string The resolved clientId
   */
  get(): string;
}

export class DefaultClientIdResolver implements ClientIdResolver {
  constructor(
    private _realtime: Ably.Realtime,
    private _logger: Logger,
  ) {}

  get(): string {
    const clientId = this._realtime.auth.clientId;
    if (!clientId) {
      this._logger.error('unable to get client id; client id is not set', { clientId });
      throw new Ably.ErrorInfo('unable to get client id; client id is not set', ErrorCode.InvalidClientId, 400);
    }

    return clientId;
  }
}