javascript-ampache/src/base.ts

A JS library for the Ampache API

import fetch from "isomorphic-unfetch";
import qs from "querystringify";
import { outputDebugURL } from "./utils";

type Config = {
  url: string;
  sessionKey?: string;
  useBearerToken?: boolean;
  debug?: boolean;
};

export type Success = {
  success: string;
};

/**
 * @param [offset] Return results starting from this index position
 * @param [limit] Maximum number of results to return
 */
export type Pagination = {
  offset?: number;
  limit?: number;
};

/**
 * @param [offset] Return results starting from this index position
 * @param [limit] Maximum number of results to return
 * @param [cond] Apply additional filters to the browse using ; separated comma string pairs (e.g. 'filter1,value1;filter2,value2')
 * @param [sort] Sort name or comma-separated key pair. (e.g. 'name,order') Default order 'ASC' (e.g. 'name,ASC' == 'name')
 */
export type ExtendedPagination = Pagination & {
  cond?: string;
  sort?: string;
};

export type BinaryBoolean = 0 | 1;

export type UID = string | number;

export abstract class Base {
  sessionKey: string;
  url: string;
  version: string = "6.6.8";
  useBearerToken: boolean;
  debug: boolean;

  constructor(config: Config) {
    this.sessionKey = config.sessionKey || null;
    this.url = config.url;
    this.useBearerToken = config.useBearerToken || false;
    this.debug = config.debug || false;
  }

  protected request<T>(endpoint: string): Promise<T> {
    let url =
      this.url +
      "/server/json.server.php?action=" +
      endpoint +
      "&version=" +
      this.version;

    if (!this.useBearerToken) {
      url += "&auth=" + this.sessionKey;
    }

    if (this.debug) {
      outputDebugURL(url, this);
    }

    return fetch(url, {
      method: "GET",
      headers: this.useBearerToken ? { Authorization: "Bearer " + this.sessionKey } : {},
    }).then((r) => {
      if (r.ok) {
        return r.json();
      }
      throw new Error(r.statusText);
    });
  }

  protected binary<T>(endpoint: string): Promise<Blob> {
    let url =
      this.url +
      "/server/json.server.php?action=" + endpoint +
      "&version=" + this.version;

    if (!this.useBearerToken) {
      url += "&auth=" + this.sessionKey;
    }

    if (this.debug) {
      outputDebugURL(url, this);
    }

    return fetch(url, {
      method: "GET",
      headers: this.useBearerToken ? { Authorization: "Bearer " + this.sessionKey } : {},
    })
      .then((response) => response.blob())
      .then((r) => {
        return r;
      });
  }

  public setSessionKey(sessionKey: string) {
    this.sessionKey = sessionKey;
  }

  /**
   * Construct and return a URL
   * @param endpoint
   * @param [params]
   */
  public rawURL(endpoint: string, params?: {}) {
    let query = endpoint;
    query += qs.stringify(params, "&");

    let url =
      this.url +
      "/server/json.server.php?action=" + query +
      "&version=" + this.version;

    if (!this.useBearerToken) {
      url += "&auth=" + this.sessionKey;
    }

    if (this.debug) {
      outputDebugURL(url, this);
    }

    return url;
  }
}