javascript-ampache 1.1.3 → 1.1.4

package/package.json

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

package/src/albums/index.ts

@@ -48,6 +48,7 @@ export class Albums extends Base {
    * This returns the albums of an artist
    * @remarks MINIMUM_API_VERSION=380001
    * @param params.filter UID to find
+   * @param [params.album_artist] 0, 1 (if true filter for album artists only)
    * @param [params.offset]
    * @param [params.limit]
    * @param [params.cond]
@@ -57,6 +58,7 @@ export class Albums extends Base {
   artistAlbums(
     params: {
       filter: UID;
+      album_artist?: BinaryBoolean;
     } & ExtendedPagination,
   ) {
     let query = "artist_albums";

package/src/albums/types.ts

@@ -16,6 +16,8 @@ export type AlbumResponse = {
   prefix: string | null;
   basename: string;
   artist: ArtistSummary;
+  artists: ArtistSummary[];
+  songartists: ArtistSummary[];
   time: number;
   year: number | string;
   tracks?: SongResponse[];

package/src/artists/types.ts

@@ -1,5 +1,5 @@
 import { AlbumResponse } from "../albums/types";
-import { Song } from "../songs/types";
+import { SongsResponse } from "../songs/types";
 import { GenreResponse } from "../genres/types";
 
 export type ArtistSummary = {
@@ -16,7 +16,7 @@ export type ArtistResponse = {
   basename: string;
   albums: AlbumResponse[];
   albumcount: number;
-  songs: Song[];
+  songs: SongsResponse[];
   songcount: number;
   genre: GenreResponse[];
   art: string;

package/src/auth/types.ts

@@ -20,6 +20,13 @@ export type AuthResponse = {
   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

@@ -38,7 +38,7 @@ export type UID = string | number;
 export abstract class Base {
   sessionKey: string;
   url: string;
-  version: string = "6.6.8"; // default to latest version
+  version: string = "6.6.8";
   debug: boolean;
 
   constructor(config: Config) {

package/src/bookmarks/index.ts

@@ -1,116 +1,116 @@
-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);
-  }
-}
+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/catalogs/index.ts

@@ -1,130 +1,130 @@
-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);
-  }
-}
+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);
+  }
+}