javascript-ampache 1.1.4 → 1.1.6

package/dist/playlists/index.d.ts

@@ -1,4 +1,4 @@
-import { PlaylistResponse, PlaylistsResponse } from "./types";
+import { HashResponse, PlaylistResponse, PlaylistsResponse } from "./types";
 import { SongsResponse } from "../songs/types";
 import { Base, BinaryBoolean, ExtendedPagination, Pagination, Success, UID } from "../base";
 export declare class Playlists extends Base {
@@ -11,6 +11,7 @@ export declare class Playlists extends Base {
      * @param [params.update] ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date
      * @param [params.hide_search] 0, 1 (if true do not include searches/smartlists in the result)
      * @param [params.show_dupes] 0, 1 (if true ignore 'api_hide_dupe_searches' setting)
+     * @param [params.include] 0, 1 (if true include the objects in the playlist)
      * @param [params.offset]
      * @param [params.limit]
      * @param [params.cond]
@@ -24,6 +25,7 @@ export declare class Playlists extends Base {
         update?: Date;
         hide_search?: BinaryBoolean;
         show_dupes?: BinaryBoolean;
+        include?: BinaryBoolean;
     } & ExtendedPagination): Promise<PlaylistsResponse>;
     /**
      * This returns smartlists based on the specified filter. NOTE: Filtered from Playlists() so pagination is invalid.
@@ -190,4 +192,13 @@ export declare class Playlists extends Base {
         flag?: BinaryBoolean;
         format?: "song" | "index" | "id";
     } & Pagination): Promise<SongsResponse>;
+    /**
+     * This returns the md5 hash for the songs in a playlist
+     * @remarks MINIMUM_API_VERSION=6.6.0
+     * @param params.filter string UID of Playlist
+     * @see {@link https://ampache.org/api/api-json-methods#playlist_hash}
+     */
+    playlistHash(params: {
+        filter: UID;
+    }): Promise<HashResponse>;
 }

package/dist/playlists/types.d.ts

@@ -1,4 +1,5 @@
 import { UID } from "../base";
+import { UserSummary } from "../users/types";
 export type PlaylistResponse = {
     id: UID;
     name: string;
@@ -10,9 +11,16 @@ export type PlaylistResponse = {
     flag: boolean;
     rating: number | null;
     averagerating: number | null;
+    user: UserSummary;
+    has_access: boolean;
+    has_collaborate: boolean;
+    last_update: number;
 };
 export type PlaylistsResponse = {
     total_count: number;
     md5: string;
     playlist: PlaylistResponse[];
 };
+export type HashResponse = {
+    md5: string;
+};

package/dist/preferences/types.d.ts

@@ -8,6 +8,8 @@ export type PreferenceResponse = {
     type: string;
     category: string;
     subcategory: string | null;
+    has_access: boolean;
+    values?: string;
 };
 export type PreferencesResponse = {
     total_count: number;

package/dist/shouts/types.d.ts

@@ -5,4 +5,6 @@ export type ShoutResponse = {
     date: number;
     text: string;
     user: UserSummary;
+    object_type: "song" | "album" | "artist" | "playlist";
+    object_id: UID;
 };

package/dist/songs/index.d.ts

@@ -105,6 +105,13 @@ export declare class Songs extends Base {
     songDelete(params: {
         filter: UID;
     }): Promise<Success>;
+    /**
+     * Get the full song file tags using VaInfo
+     * This is used to get tags for remote catalogs to allow maximum data to be returned
+     * @remarks MINIMUM_API_VERSION=7.5.0
+     * @param params.filter UID of song to fetch
+     * @see {@link https://ampache.org/api/api-json-methods#song_tags}
+     */
     /**
      * This takes a URL and returns the song object in question
      * @remarks MINIMUM_API_VERSION=380001

package/dist/system/index.d.ts

@@ -1,5 +1,5 @@
 import { Base, BinaryBoolean, ExtendedPagination, Pagination, Success, UID } from "../base";
-import { IndexEntry } from "./types";
+import { IndexEntry, NowPlayingResponse } from "./types";
 export declare class System extends Base {
     /**
      * Check Ampache for updates and run the update if there is one.
@@ -24,7 +24,7 @@ export declare class System extends Base {
      * @deprecated Being removed in 7.0.0. Use `list` instead.
      */
     getIndexes(params: {
-        type: "song" | "album" | "artist" | "album_artist" | "playlist" | "podcast" | "podcast_episode" | "live_stream";
+        type: "song" | "album" | "artist" | "album_artist" | "playlist" | "podcast" | "podcast_episode" | "live_stream" | "catalog" | "song_artist";
         filter?: string;
         add?: Date;
         update?: Date;
@@ -46,7 +46,7 @@ export declare class System extends Base {
      * @see {@link https://ampache.org/api/api-json-methods#list}
      */
     list(params: {
-        type: "song" | "album" | "artist" | "album_artist" | "playlist" | "podcast" | "podcast_episode" | "live_stream";
+        type: "song" | "album" | "artist" | "album_artist" | "playlist" | "podcast" | "podcast_episode" | "live_stream" | "catalog" | "song_artist";
         filter?: string;
         add?: Date;
         update?: Date;
@@ -154,12 +154,14 @@ export declare class System extends Base {
      * @param params.type Object type
      * @param params.id UID to find
      * @param params.flag 0, 1
+     * @param [params.date] UNIXTIME
      * @see {@link https://ampache.org/api/api-json-methods#flag}
      */
     flag(params: {
         type: "song" | "album" | "artist" | "playlist" | "podcast" | "podcast_episode" | "video" | "tvshow" | "tvshow_season";
         id: UID;
         flag: BinaryBoolean;
+        date?: number;
     }): Promise<Success>;
     /**
      * Take a song_id and update the object_count and user_activity table with a play. This allows other sources to record play history to Ampache.
@@ -255,6 +257,7 @@ export declare class System extends Base {
      * @param [params.format] mp3, ogg, raw, etc. (raw returns the original format)
      * @param [params.offset] Time offset
      * @param [params.length] 0, 1 (estimate content length)
+     * @param [params.stats] 0, 1 (if false disable stat recording when playing the object; default: 1)
      * @see {@link https://ampache.org/api/api-json-methods#stream}
      */
     stream(params: {
@@ -264,6 +267,7 @@ export declare class System extends Base {
         format?: string;
         offset?: number;
         length?: BinaryBoolean;
+        stats?: BinaryBoolean;
     }): Promise<Blob>;
     /**
      * Downloads a given media file. set format=raw to download the full file
@@ -272,23 +276,29 @@ export declare class System extends Base {
      * @param params.id UID to find
      * @param params.type Object type
      * @param [params.format] mp3, ogg, raw, etc. (raw returns the original format)
+     * @param [params.bitrate] max bitrate for transcoding in bytes (e.g 192000=192Kb)
+     * @param [params.stats] 0, 1 (if false disable stat recording when playing the object; default: 1)
      * @see {@link https://ampache.org/api/api-json-methods#download}
      */
     download(params: {
         id: UID;
         type: "song" | "podcast_episode" | "search" | "playlist";
         format?: string;
+        bitrate?: number;
+        stats?: BinaryBoolean;
     }): Promise<Blob>;
     /**
      * Get an art image file.
      * @remarks MINIMUM_API_VERSION=400001
      * @param params.id UID to find
      * @param params.type Object type
+     * @param [params.size] width x height (e.g. '640x480')
      * @see {@link https://ampache.org/api/api-json-methods#get_art}
      */
     getArt(params: {
         id: UID;
         type: "song" | "artist" | "album" | "playlist" | "search" | "podcast";
+        size?: string;
     }): Promise<Blob>;
     /**
      * This is for controlling localplay
@@ -324,6 +334,33 @@ export declare class System extends Base {
         oid: UID;
         method: "vote" | "devote" | "playlist" | "play";
     }): Promise<unknown>;
+    /**
+     * Get what is currently being played by all users.
+     * @remarks MINIMUM_API_VERSION=6.3.1
+     * @see {@link https://ampache.org/api/api-json-methods#now_playing}
+     */
+    nowPlaying(): Promise<{
+        now_playing: NowPlayingResponse[];
+    }>;
+    /**
+     * Inform the server about the state of your client. (Song you are playing, Play/Pause state, etc.)
+     * @remarks MINIMUM_API_VERSION=6.4.0
+     * @param params.filter $object_id currently playing/stopping
+     * @param [params.type] song, video, podcast_episode (Default: song)
+     * @param [params.state] play, stop (Default: play)
+     * @param [params.time] current play time in whole seconds (Default: 0)
+     * @param [params.client] agent/client name
+     * @see {@link https://ampache.org/api/api-json-methods#player}
+     */
+    player(params: {
+        filter: UID;
+        type?: "song" | "video" | "podcast_episode";
+        state?: "play" | "stop";
+        time?: number;
+        client?: string;
+    }): Promise<{
+        now_playing: NowPlayingResponse[];
+    }>;
     /**
      * Perform an advanced search given passed rules.
      * You'll want to consult the docs for this.
@@ -342,4 +379,29 @@ export declare class System extends Base {
         rules: Array<Array<string>>;
         random?: BinaryBoolean;
     } & Pagination): any;
+    search: (params: {
+        operator: "and" | "or";
+        type: "song" | "album" | "album_disk" | "artist" | "album_artist" | "song_artist" | "label" | "playlist" | "podcast" | "podcast_episode" | "genre" | "user" | "video";
+        rules: Array<Array<string>>;
+        random?: BinaryBoolean;
+    } & Pagination) => any;
+    /**
+     * Perform a search given passed rules and return matching objects in a group.
+     * If the rules do not exist for the object type or would return the entire table they will not return objects
+     * You'll want to consult the docs for this.
+     * @remarks MINIMUM_API_VERSION=6.3.0
+     * @param params.operator and, or (whether to match one rule or all)
+     * @param params.rules An array of rules
+     * @param [params.type] Object type to return (all, music, song_artist, album_artist, podcast, video; all by default)
+     * @param [params.random] 0, 1 (random order of results; default to 0)
+     * @param [params.offset]
+     * @param [params.limit]
+     * @see {@link https://ampache.org/api/api-json-methods#search_group}
+     */
+    searchGroup(params: {
+        operator: "and" | "or";
+        rules: Array<Array<string>>;
+        type?: "all" | "music" | "song_artist" | "album_artist" | "podcast" | "video";
+        random?: BinaryBoolean;
+    } & Pagination): any;
 }

package/dist/system/types.d.ts

@@ -6,6 +6,7 @@ import { PodcastResponse, PodcastEpisodeResponse } from "../podcasts/types";
 import { LiveStreamResponse } from "../live-streams/types";
 import { VideoResponse } from "../videos/types";
 import { UID } from "../base";
+import { UserSummary } from "../users/types";
 export type IndexType = SongResponse | AlbumResponse | ArtistResponse | PlaylistResponse | PodcastResponse | PodcastEpisodeResponse | LiveStreamResponse;
 export type StatsType = SongResponse | AlbumResponse | ArtistResponse | VideoResponse | PlaylistResponse | PodcastResponse | PodcastEpisodeResponse;
 export type IndexEntry = {
@@ -14,3 +15,10 @@ export type IndexEntry = {
     prefix: string;
     basename: string;
 };
+export type NowPlayingResponse = {
+    id: UID;
+    type: "song" | "podcast_episode" | "video";
+    client: string;
+    expire: number;
+    user: UserSummary;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "javascript-ampache",
-  "version": "1.1.4",
+  "version": "1.1.6",
   "description": "A JS library for the Ampache API",
   "main": "dist/index.js",
   "module": "dist/index.m.js",

package/src/base.ts

@@ -1,134 +1,134 @@
-import fetch from "isomorphic-unfetch";
-import qs from "querystringify";
-
-type Config = {
-  url: string;
-  sessionKey?: string;
-  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";
-  debug: boolean;
-
-  constructor(config: Config) {
-    this.sessionKey = config.sessionKey || null;
-    this.url = config.url;
-    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.debug) {
-      console.debug(
-        "javascript-ampache query URL %c" + url + "&auth=" + this.sessionKey,
-        "color: black; font-style: italic; background-color: orange;padding: 2px",
-      );
-    }
-
-    return fetch(url, {
-      method: "GET",
-      headers: {
-        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.debug) {
-      console.debug(
-        "javascript-ampache query URL %c" + url + "&auth=" + this.sessionKey,
-        "color: black; font-style: italic; background-color: orange;padding: 2px",
-      );
-    }
-
-    return fetch(url, {
-      method: "GET",
-      headers: {
-        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.debug) {
-      console.debug(
-        "javascript-ampache query URL %c" + url + "&auth=" + this.sessionKey,
-        "color: black; font-style: italic; background-color: orange;padding: 2px",
-      );
-    }
-
-    return url;
-  }
-}
+import fetch from "isomorphic-unfetch";
+import qs from "querystringify";
+
+type Config = {
+  url: string;
+  sessionKey?: string;
+  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";
+  debug: boolean;
+
+  constructor(config: Config) {
+    this.sessionKey = config.sessionKey || null;
+    this.url = config.url;
+    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.debug) {
+      console.debug(
+        "javascript-ampache query URL %c" + url + "&auth=" + this.sessionKey,
+        "color: black; font-style: italic; background-color: orange;padding: 2px",
+      );
+    }
+
+    return fetch(url, {
+      method: "GET",
+      headers: {
+        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.debug) {
+      console.debug(
+        "javascript-ampache query URL %c" + url + "&auth=" + this.sessionKey,
+        "color: black; font-style: italic; background-color: orange;padding: 2px",
+      );
+    }
+
+    return fetch(url, {
+      method: "GET",
+      headers: {
+        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.debug) {
+      console.debug(
+        "javascript-ampache query URL %c" + url + "&auth=" + this.sessionKey,
+        "color: black; font-style: italic; background-color: orange;padding: 2px",
+      );
+    }
+
+    return url;
+  }
+}

package/src/system/index.ts

@@ -525,11 +525,13 @@ export class System extends Base {
    * @remarks MINIMUM_API_VERSION=400001
    * @param params.id UID to find
    * @param params.type Object type
+   * @param [params.size] width x height (e.g. '640x480')
    * @see {@link https://ampache.org/api/api-json-methods#get_art}
    */
   getArt(params: {
     id: UID;
     type: "song" | "artist" | "album" | "playlist" | "search" | "podcast";
+    size?: string;
   }) {
     let query = "get_art";
     query += qs.stringify(params, "&");

package/src/system/types.ts

@@ -35,7 +35,7 @@ export type IndexEntry = {
 
 export type NowPlayingResponse = {
   id: UID;
-  type: "song" | "podcast_episode" | "live_stream" | "video";
+  type: "song" | "podcast_episode" | "video";
   client: string;
   expire: number;
   user: UserSummary;