pubnub/src/core/endpoints/access_manager/revoke_token.ts

Publish & Subscribe Real-time Messaging with PubNub

/**
 * PAM Revoke Token REST API module.
 *
 * @internal
 */

import { TransportResponse } from '../../types/transport-response';
import { TransportMethod } from '../../types/transport-request';
import { AbstractRequest } from '../../components/request';
import RequestOperation from '../../constants/operations';
import * as PAM from '../../types/api/access-manager';
import { encodeString } from '../../utils';
import { KeySet } from '../../types/api';

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

/**
 * Request configuration parameters.
 */
type RequestParameters = {
  /**
   * Access token for which permissions should be revoked.
   */
  token: string;

  /**
   * PubNub REST API access key set.
   */
  keySet: KeySet;
};

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

  /**
   * Request processing result data.
   */
  data: Record<string, unknown>;

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

/**
 * Access token revoke request.
 *
 * Invalidate token and permissions which has been granted for it.
 *
 * @internal
 */
export class RevokeTokenRequest extends AbstractRequest<PAM.RevokeTokenResponse, ServiceResponse> {
  constructor(private readonly parameters: RequestParameters) {
    super({ method: TransportMethod.DELETE });
  }

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

  validate(): string | undefined {
    if (!this.parameters.keySet.secretKey) return 'Missing Secret Key';
    if (!this.parameters.token) return "token can't be empty";
  }

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

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

    return `/v3/pam/${subscribeKey}/grant/${encodeString(token)}`;
  }
}