javascript-ampache 1.2.0 → 2.0.0

package/src/auth/types.ts

@@ -1,32 +0,0 @@
-export type AuthResponse = {
-  add: string;
-  albums: number;
-  api: string;
-  artists: number;
-  auth: string;
-  catalogs: number;
-  compatible: string;
-  clean: string;
-  genres: number;
-  labels: number;
-  licenses: number;
-  live_streams: number;
-  playlists: number;
-  podcasts: number;
-  podcast_episodes: number;
-  server: string;
-  session_expire: string;
-  shares: number;
-  songs: number;
-  update: string;
-  user: number;
-  username: string;
-  version: string;
-  videos: number;
-  max_song: number;
-  max_album: number;
-  max_artist: number;
-  max_video: number;
-  max_podcast: number;
-  max_podcast_episode: number;
-};

package/src/base.ts

@@ -1,133 +0,0 @@
-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;
-  }
-}

package/src/bookmarks/index.ts

@@ -1,116 +0,0 @@
-import qs from "querystringify";
-import { BookmarkResponse, BookmarksResponse } from "./types";
-import { Base, BinaryBoolean, Success, UID } from "../base";
-
-export class Bookmarks extends Base {
-  /**
-   * Get a single bookmark by bookmark_id
-   * @remarks MINIMUM_API_VERSION=6.1.0
-   * @param params.filter UID to find
-   * @param [params.include] 0,1, if true include the object in the bookmark
-   * @see {@link https://ampache.org/api/api-json-methods#bookmark}
-   */
-  bookmark(params: { filter: UID; include?: BinaryBoolean }) {
-    let query = "bookmark";
-    query += qs.stringify(params, "&");
-    return this.request<BookmarkResponse>(query);
-  }
-
-  /**
-   * Get information about bookmarked media this user is allowed to manage
-   * @remarks MINIMUM_API_VERSION=5.0.0
-   * @param [params.client] filter by the agent/client name
-   * @param [params.include] 0,1, if true include the object in the bookmark
-   * @see {@link https://ampache.org/api/api-json-methods#bookmarks}
-   */
-  bookmarks(params: { client?: string; include?: BinaryBoolean }) {
-    let query = "bookmarks";
-    query += qs.stringify(params, "&");
-    return this.request<BookmarksResponse>(query);
-  }
-
-  /**
-   * Get the bookmark/s from its object_id and object_type.
-   * @remarks MINIMUM_API_VERSION=5.0.0
-   * @param params.filter UID to find
-   * @param params.type Object type
-   * @param [params.include] 0,1, if true include the object in the bookmark
-   * @see {@link https://ampache.org/api/api-json-methods#get_bookmark}
-   */
-  getBookmark(params: {
-    filter: UID;
-    type: "song" | "video" | "podcast_episode";
-    include?: BinaryBoolean;
-    all?: BinaryBoolean;
-  }) {
-    let query = "get_bookmark";
-    query += qs.stringify(params, "&");
-    return this.request<BookmarkResponse>(query);
-  }
-
-  /**
-   * Create a placeholder for the current media that you can return to later.
-   * @remarks MINIMUM_API_VERSION=5.0.0
-   * @param params.filter UID to find
-   * @param params.type Object type
-   * @param params.position current track time in seconds
-   * @param [params.client] Agent string. (Default: 'AmpacheAPI')
-   * @param [params.date] update time (Default: UNIXTIME())
-   * @param [params.include] 0,1, if true include the object in the bookmark
-   * @see {@link https://ampache.org/api/api-json-methods#bookmark_create}
-   */
-  bookmarkCreate(params: {
-    filter: UID;
-    type: "song" | "video" | "podcast_episode";
-    position: number;
-    client?: string;
-    date?: number;
-    include?: BinaryBoolean;
-  }) {
-    let query = "bookmark_create";
-    query += qs.stringify(params, "&");
-    return this.request<BookmarkResponse>(query);
-  }
-
-  /**
-   * Edit a placeholder for the current media that you can return to later.
-   * @remarks MINIMUM_API_VERSION=5.0.0
-   * @param params.filter UID to find
-   * @param params.type Object type
-   * @param params.position current track time in seconds
-   * @param [params.client] Agent string. (Default: 'AmpacheAPI')
-   * @param [params.date] update time (Default: UNIXTIME())
-   * @param [params.include] 0,1, if true include the object in the bookmark
-   * @see {@link https://ampache.org/api/api-json-methods#bookmark_edit}
-   */
-  bookmarkEdit(params: {
-    filter: UID;
-    type: "song" | "video" | "podcast_episode";
-    position: number;
-    client?: string;
-    date?: number;
-    include?: BinaryBoolean;
-  }) {
-    let query = "bookmark_edit";
-    query += qs.stringify(params, "&");
-    return this.request<BookmarkResponse>(query);
-  }
-
-  /**
-     * Delete an existing bookmark. (if it exists)
-     * @remarks MINIMUM_API_VERSION=5.0.0
-     * @param params.filter UID to find
-     * @param params.type Object type
-     * @param [params.client] Agent string. (Default: 'AmpacheAPI')
-     @see {@link https://ampache.org/api/api-json-methods#bookmark_delete}
-     */
-  bookmarkDelete(params: {
-    filter: UID;
-    type: "song" | "video" | "podcast_episode";
-    client?: string;
-  }) {
-    let query = "bookmark_delete";
-    query += qs.stringify(params, "&");
-    return this.request<Success>(query);
-  }
-}

package/src/bookmarks/types.ts

@@ -1,15 +0,0 @@
-import { UID } from "../base";
-
-export type BookmarkResponse = {
-  id: UID;
-  type: "song" | "video" | "podcast_episode";
-  position: number;
-  client?: string;
-  date?: number;
-};
-
-export type BookmarksResponse = {
-  total_count: number;
-  md5: string;
-  bookmark: BookmarkResponse[];
-};

package/src/catalogs/index.ts

@@ -1,130 +0,0 @@
-import qs from "querystringify";
-import { CatalogResponse, CatalogsResponse } from "./types";
-import { Base, ExtendedPagination, Success, UID } from "../base";
-
-export class Catalogs extends Base {
-  /**
-   * This searches the catalogs and returns... catalogs
-   * @remarks MINIMUM_API_VERSION=420000
-   * @param [params.filter] Catalog type
-   * @param [params.offset]
-   * @param [params.limit]
-   * @param [params.cond]
-   * @param [params.sort]
-   * @see {@link https://ampache.org/api/api-json-methods#catalogs}
-   */
-  catalogs(
-    params?: {
-      filter?:
-        | "music"
-        | "clip"
-        | "tvshow"
-        | "movie"
-        | "personal_video"
-        | "podcast";
-    } & ExtendedPagination,
-  ) {
-    let query = "catalogs";
-    query += qs.stringify(params, "&");
-    return this.request<CatalogsResponse>(query);
-  }
-
-  /**
-   * Return catalog by UID
-   * @remarks MINIMUM_API_VERSION=420000
-   * @param params.filter UID to find
-   * @see {@link https://ampache.org/api/api-json-methods#catalog}
-   */
-  catalog(params: { filter: UID }) {
-    let query = "catalog";
-    query += qs.stringify(params, "&");
-    return this.request<CatalogResponse>(query);
-  }
-
-  /**
-   * Kick off a catalog update or clean for the selected catalog
-   * ACCESS REQUIRED: 75 (Catalog Manager)
-   * @remarks MINIMUM_API_VERSION=400001
-   * @param params.task add_to_catalog, clean_catalog
-   * @param params.catalog UID of catalog
-   * @see {@link https://ampache.org/api/api-json-methods#catalog_action}
-   */
-  catalogAction(params: {
-    task: "add_to_catalog" | "clean_catalog";
-    catalog: UID;
-  }) {
-    let query = "catalog_action";
-    query += qs.stringify(params, "&");
-    return this.request<Success>(query);
-  }
-
-  /**
-   * Perform actions on local catalog files. Single file versions of catalog add, clean, verify and remove (delete).
-   * Make sure you remember to urlencode those file names!
-   * ACCESS REQUIRED: 50 (Content Manager)
-   * @remarks MINIMUM_API_VERSION=420000
-   * @param params.file FULL path to local file
-   * @param params.task add, clean, verify, remove, (can include comma-separated values)
-   * @param params.catalog UID of catalog
-   * @see {@link https://ampache.org/api/api-json-methods#catalog_file}
-   */
-  catalogFile(params: { file: string; task: string; catalog: UID }) {
-    let query = "catalog_file";
-    query += qs.stringify(params, "&");
-    return this.request<Success>(query);
-  }
-
-  /**
-   * Create a new catalog.
-   * ACCESS REQUIRED: 75 (Catalog Manager)
-   * @remarks MINIMUM_API_VERSION=6.0.0
-   * @param params.name Name for the catalog
-   * @param params.path URL or folder path for your catalog
-   * @param [params.type] Default: 'local'
-   * @param [params.media_type] Default: 'music'
-   * @param [params.file_pattern] Pattern used identify tags from the file name. Default: '%T - %t'
-   * @param [params.folder_pattern] Pattern used identify tags from the folder name. Default: '%a/%A'
-   * @param [params.username] login to remote catalog
-   * @param [params.password] password to remote catalog
-   * @see {@link https://ampache.org/api/api-json-methods#catalog_add}
-   */
-  catalogAdd(params: {
-    name: string;
-    path: string;
-    type?:
-      | "local"
-      | "beets"
-      | "remote"
-      | "subsonic"
-      | "seafile"
-      | "beetsremote";
-    media_type?:
-      | "music"
-      | "podcast"
-      | "clip"
-      | "tvshow"
-      | "movie"
-      | "personal_video";
-    file_pattern?: string;
-    folder_pattern?: string;
-    username?: string;
-    password?: string;
-  }) {
-    let query = "catalog_add";
-    query += qs.stringify(params, "&");
-    return this.request<CatalogResponse>(query);
-  }
-
-  /**
-   * Delete an existing catalog. (if it exists)
-   * ACCESS REQUIRED: 75 (Catalog Manager)
-   * @remarks MINIMUM_API_VERSION=6.0.0
-   * @param params.filter ID of the catalog
-   * @see {@link https://ampache.org/api/api-json-methods#catalog_delete}
-   */
-  catalogDelete(params: { filter: UID }) {
-    let query = "catalog_delete";
-    query += qs.stringify(params, "&");
-    return this.request<Success>(query);
-  }
-}

package/src/catalogs/types.ts

@@ -1,27 +0,0 @@
-import { UID } from "../base";
-
-export type CatalogResponse = {
-  id: UID;
-  name: string;
-  type: "local" | "remote";
-  gather_types:
-    | "podcast"
-    | "clip"
-    | "tvshow"
-    | "movie"
-    | "personal_video"
-    | "music";
-  enabled: boolean;
-  last_add: number;
-  last_clean: number;
-  last_update: number;
-  path: string;
-  rename_pattern: string;
-  sort_pattern: string;
-};
-
-export type CatalogsResponse = {
-  total_count: number;
-  md5: string;
-  catalog: CatalogResponse[];
-};

package/src/genres/index.ts

@@ -1,39 +0,0 @@
-import qs from "querystringify";
-import { GenreResponse, GenresResponse } from "./types";
-import { Base, BinaryBoolean, ExtendedPagination, UID } from "../base";
-
-export class Genres extends Base {
-  /**
-   * This returns the genres (Tags) based on the specified filter
-   * @remarks MINIMUM_API_VERSION=380001
-   * @param [params.filter] UID to find
-   * @param [params.exact] 0, 1 (if true filter is exact = rather than fuzzy LIKE)
-   * @param [params.offset]
-   * @param [params.limit]
-   * @param [params.cond]
-   * @param [params.sort]
-   * @see {@link https://ampache.org/api/api-json-methods#genres}
-   */
-  genres(
-    params?: {
-      filter?: string;
-      exact?: BinaryBoolean;
-    } & ExtendedPagination,
-  ) {
-    let query = "genres";
-    query += qs.stringify(params, "&");
-    return this.request<GenresResponse>(query);
-  }
-
-  /**
-   * This returns a single genre based on UID
-   * @remarks MINIMUM_API_VERSION=380001
-   * @param params.filter UID to find
-   * @see {@link https://ampache.org/api/api-json-methods#genre}
-   */
-  genre(params: { filter: UID }) {
-    let query = "genre";
-    query += qs.stringify(params, "&");
-    return this.request<GenreResponse>(query);
-  }
-}

package/src/genres/types.ts

@@ -1,25 +0,0 @@
-import { UID } from "../base";
-
-export type GenreSummary = {
-  id: UID;
-  name: string;
-};
-
-export type GenreResponse = {
-  id: UID;
-  name: string;
-  albums: number;
-  artists: number;
-  songs: number;
-  videos: number;
-  playlists: number;
-  live_streams: number;
-  is_hidden: boolean;
-  merge: GenreSummary[];
-};
-
-export type GenresResponse = {
-  total_count: number;
-  md5: string;
-  genre: GenreResponse[];
-};

package/src/index.ts

@@ -1,63 +0,0 @@
-import { Albums } from "./albums";
-import { Artists } from "./artists";
-import { Auth } from "./auth";
-import { Bookmarks } from "./bookmarks";
-import { Catalogs } from "./catalogs";
-import { Genres } from "./genres";
-import { Labels } from "./labels";
-import { Licenses } from "./licenses";
-import { LiveStreams } from "./live-streams";
-import { Playlists } from "./playlists";
-import { Podcasts } from "./podcasts";
-import { Preferences } from "./preferences";
-import { Shares } from "./shares";
-import { Shouts } from "./shouts";
-import { Songs } from "./songs";
-import { System } from "./system";
-import { Users } from "./users";
-import { Videos } from "./videos";
-import { applyMixins } from "./utils";
-import { Base } from "./base";
-
-class AmpacheAPI extends Base {}
-interface AmpacheAPI
-  extends Albums,
-    Artists,
-    Auth,
-    Bookmarks,
-    Catalogs,
-    Genres,
-    Labels,
-    Licenses,
-    LiveStreams,
-    Playlists,
-    Podcasts,
-    Preferences,
-    Shares,
-    Shouts,
-    Songs,
-    System,
-    Users,
-    Videos {}
-applyMixins(AmpacheAPI, [
-  Albums,
-  Artists,
-  Auth,
-  Bookmarks,
-  Catalogs,
-  Genres,
-  Labels,
-  Licenses,
-  LiveStreams,
-  Playlists,
-  Podcasts,
-  Preferences,
-  Shares,
-  Shouts,
-  Songs,
-  System,
-  Users,
-  Videos,
-]);
-
-export default AmpacheAPI;

package/src/labels/index.ts

@@ -1,43 +0,0 @@
-import qs from "querystringify";
-import { LabelResponse, LabelsResponse } from "./types";
-import { Base, BinaryBoolean, ExtendedPagination, UID } from "../base";
-
-export class Labels extends Base {
-  /**
-   * This returns labels based on the specified filter
-   * @remarks MINIMUM_API_VERSION=420000
-   * @param [params.filter] Filter results to match this string
-   * @param [params.exact] 0, 1 (if true filter is exact = rather than fuzzy LIKE)
-   * @param [params.add] ISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified date
-   * @param [params.update] ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date
-   * @param [params.offset]
-   * @param [params.limit]
-   * @param [params.cond]
-   * @param [params.sort]
-   * @see {@link https://ampache.org/api/api-json-methods#labels}
-   */
-  labels(
-    params?: {
-      filter?: string;
-      exact?: BinaryBoolean;
-      add?: Date;
-      update?: Date;
-    } & ExtendedPagination,
-  ) {
-    let query = "labels";
-    query += qs.stringify(params, "&");
-    return this.request<LabelsResponse>(query);
-  }
-
-  /**
-   * This returns a single label
-   * @remarks MINIMUM_API_VERSION=420000
-   * @param params.filter UID to find
-   * @see {@link https://ampache.org/api/api-json-methods#label}
-   */
-  label(params: { filter: UID }) {
-    let query = "label";
-    query += qs.stringify(params, "&");
-    return this.request<LabelResponse>(query);
-  }
-}

package/src/labels/types.ts

@@ -1,20 +0,0 @@
-import { UID } from "../base";
-
-export type LabelResponse = {
-  id: UID;
-  name: string;
-  artists: number;
-  summary: string | null;
-  external_link: string | null;
-  address: string | null;
-  category: string | null;
-  email: string | null;
-  website: string | null;
-  user: UID;
-};
-
-export type LabelsResponse = {
-  total_count: number;
-  md5: string;
-  label: LabelResponse[];
-};

package/src/licenses/index.ts

@@ -1,43 +0,0 @@
-import qs from "querystringify";
-import { LicenseResponse, LicensesResponse } from "./types";
-import { Base, BinaryBoolean, ExtendedPagination, UID } from "../base";
-
-export class Licenses extends Base {
-  /**
-   * This returns licenses based on the specified filter
-   * @remarks MINIMUM_API_VERSION=420000
-   * @param [params.filter] Filter results to match this string
-   * @param [params.exact] 0, 1 (if true filter is exact = rather than fuzzy LIKE)
-   * @param [params.add] ISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified date
-   * @param [params.update] ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date
-   * @param [params.offset]
-   * @param [params.limit]
-   * @param [params.cond]
-   * @param [params.sort]
-   * @see {@link https://ampache.org/api/api-json-methods#licenses}
-   */
-  licenses(
-    params?: {
-      filter?: string;
-      exact?: BinaryBoolean;
-      add?: Date;
-      update?: Date;
-    } & ExtendedPagination,
-  ) {
-    let query = "licenses";
-    query += qs.stringify(params, "&");
-    return this.request<LicensesResponse>(query);
-  }
-
-  /**
-   * This returns a single license
-   * @remarks MINIMUM_API_VERSION=420000
-   * @param params.filter UID to find
-   * @see {@link https://ampache.org/api/api-json-methods#license}
-   */
-  license(params: { filter: UID }) {
-    let query = "license";
-    query += qs.stringify(params, "&");
-    return this.request<LicenseResponse>(query);
-  }
-}