pubnub/src/core/endpoints/channel_groups/add_channels.ts

Publish & Subscribe Real-time Messaging with PubNub

/**
 * Add channel group channels REST API module.
 *
 * @internal
 */

import { TransportResponse } from '../../types/transport-response';
import * as ChannelGroups from '../../types/api/channel-groups';
import { AbstractRequest } from '../../components/request';
import RequestOperation from '../../constants/operations';
import { KeySet, Query } from '../../types/api';
import { encodeString } from '../../utils';

// --------------------------------------------------------
// ------------------------ Types -------------------------
// --------------------------------------------------------
// region Types

/**
 * Request configuration parameters.
 */
type RequestParameters = ChannelGroups.ManageChannelGroupChannelsParameters & {
  /**
   * PubNub REST API access key set.
   */
  keySet: KeySet;
};

/**
 * Service success response.
 */
type ServiceResponse = {
  /**
   * Request result status code.
   */
  status: number;

  /**
   * Channel group channels addition human-readable result.
   */
  message: string;

  /**
   * Name of the service which provided response.
   */
  service: string;

  /**
   * Whether response represent service error or not.
   */
  error: boolean;
};
// endregion

/**
 * Add channel group channels request.
 *
 * @internal
 */
export class AddChannelGroupChannelsRequest extends AbstractRequest<
  ChannelGroups.ManageChannelGroupChannelsResponse,
  ServiceResponse
> {
  constructor(private readonly parameters: RequestParameters) {
    super();
  }

  operation(): RequestOperation {
    return RequestOperation.PNAddChannelsToGroupOperation;
  }

  validate(): string | undefined {
    const {
      keySet: { subscribeKey },
      channels,
      channelGroup,
    } = this.parameters;

    if (!subscribeKey) return 'Missing Subscribe Key';
    if (!channelGroup) return 'Missing Channel Group';
    if (!channels) return 'Missing channels';
  }

  async parse(response: TransportResponse): Promise<ChannelGroups.ManageChannelGroupChannelsResponse> {
    return super.parse(response).then((_) => ({}));
  }

  protected get path(): string {
    const {
      keySet: { subscribeKey },
      channelGroup,
    } = this.parameters;

    return `/v1/channel-registration/sub-key/${subscribeKey}/channel-group/${encodeString(channelGroup)}`;
  }

  protected get queryParameters(): Query {
    return { add: this.parameters.channels.join(',') };
  }
}