RestClient.ts

import type { HttpClientRequestOptions } from './HttpClientRequestOptions.js'

/**
 * A REST API client which will provide GET, POST, PUT, PATCH, DELETE methods
 * The client provides error and timeout handling and tries to decode the responses
 */
export interface RestClient {
  /**
   * Set the Auth-Bearer-Token for all following requests
   * @param token the bearer token
   */
  setBearerToken(token: string | undefined): void

  /**
   * Make a GET request against baseUrl+path
   * Returns body text if response content type is not set to `application/json`.
   * If response content type is `application/json`, the JSON parsed result will be returned
   * @param path
   * @param options
   */
  get<T>(path: string, options: HttpClientRequestOptions): Promise<T>

  /**
   * Make a POST request against baseUrl+path
   * Returns body text if response content type is not set to `application/json`.
   * If response content type is `application/json`, the JSON parsed result will be returned
   * @param path
   * @param payload
   * @param options
   */
  post<T>(path: string, payload: unknown, options: HttpClientRequestOptions): Promise<T>

  /**
   * Make a PUT request against baseUrl+path
   * Returns body text if response content type is not set to `application/json`.
   * If response content type is `application/json`, the JSON parsed result will be returned
   * @param path
   * @param payload
   * @param options
   */
  put<T>(path: string, payload: unknown, options: HttpClientRequestOptions): Promise<T>

  /**
   * Make a PATCH request against baseUrl+path
   * Returns body text if response content type is not set to `application/json`.
   * If response content type is `application/json`, the JSON parsed result will be returned
   * @param path
   * @param payload
   * @param options
   */
  patch<T>(path: string, payload: unknown, options: HttpClientRequestOptions): Promise<T>

  /**
   * Make a DELETE request against baseUrl+path
   * Returns body text if response content type is not set to `application/json`.
   * If response content type is `application/json`, the JSON parsed result will be returned
   * @param path
   * @param options
   */
  delete<T>(path: string, options: HttpClientRequestOptions): Promise<T>
}