javascript-ampache 1.0.9 → 1.1.1

package/README.md

@@ -1,47 +1,50 @@
-# javascript-ampache
-
-A JS client for the Ampache API written in Typescript.
-
-## Installation
-
-```bash
-npm install javascript-ampache
-```
-
-## Usage
-
-Import `javascript-ampache` module in your project and initialize it with the URL to your server e.g. http://music.com.au
-
-```js
-import AmpacheAPI from 'javascript-ampache';
-
-const API = new AmpacheAPI({ url: 'http://pathToYourAmpacheServer', sessionKey: yourSessionAuthKey }); // debug: true - will log the final GET to console
-
-// either set the session key at time of instantiation or set/update with: 
-API.setSessionKey(yourSessionAuthKey);
-
-let allUsers = API.users();
-
-let thisAlbum = API.album({ filter: 123 });
-
-let results = API.advancedSearch({
-    type: "album",
-    operator: "and",
-    random: 1,
-    limit: 20,
-    rules: [
-        ['title', 0, 'monkey'], // Title contains 'monkey'
-        ['myrating', 2, 4] // Rating is 4 stars
-    ]
-});
-```
-
-## Build
-```bash
-npm run build
-```
-
-### Special thanks
-https://lyamkin.com/blog/how-to-build-api-client-library-in-js/ & https://github.com/ilyamkin/dev-to-js
-
-
+# javascript-ampache
+
+A JS client for the Ampache API written in Typescript.
+
+## Installation
+
+```bash
+npm install javascript-ampache
+```
+
+## Usage
+
+Import `javascript-ampache` module in your project and initialize it with the URL to your server e.g. http://music.com.au
+
+```js
+import AmpacheAPI from "javascript-ampache";
+
+const API = new AmpacheAPI({
+  url: "http://pathToYourAmpacheServer",
+  sessionKey: yourSessionAuthKey,
+}); // debug: true - will log the final GET to console
+
+// either set the session key at time of instantiation or set/update with:
+API.setSessionKey(yourSessionAuthKey);
+
+let allUsers = API.users();
+
+let thisAlbum = API.album({ filter: 123 });
+
+let results = API.advancedSearch({
+  type: "album",
+  operator: "and",
+  random: 1,
+  limit: 20,
+  rules: [
+    ["title", 0, "monkey"], // Title contains 'monkey'
+    ["myrating", 2, 4], // Rating is 4 stars
+  ],
+});
+```
+
+## Build
+
+```bash
+npm run build
+```
+
+### Special thanks
+
+https://lyamkin.com/blog/how-to-build-api-client-library-in-js/ & https://github.com/ilyamkin/dev-to-js

package/dist/albums/index.d.ts

@@ -1,5 +1,5 @@
-import { Album } from './types';
-import { Base, BinaryBoolean, ExtendedPagination, UID } from '../base';
+import { AlbumResponse, AlbumsResponse } from "./types";
+import { Base, BinaryBoolean, ExtendedPagination, UID } from "../base";
 export declare class Albums extends Base {
     /**
      * This returns albums based on the provided search filters
@@ -21,9 +21,7 @@ export declare class Albums extends Base {
         add?: Date;
         update?: Date;
         include?: "albums" | "songs";
-    } & ExtendedPagination): Promise<Album[] | {
-        album: Album[];
-    }>;
+    } & ExtendedPagination): Promise<AlbumsResponse>;
     /**
      * This returns a single album based on the UID provided
      * @remarks MINIMUM_API_VERSION=380001
@@ -33,8 +31,8 @@ export declare class Albums extends Base {
      */
     album(params: {
         filter: UID;
-        include?: 'songs';
-    }): Promise<Album>;
+        include?: "songs";
+    }): Promise<AlbumResponse>;
     /**
      * This returns the albums of an artist
      * @remarks MINIMUM_API_VERSION=380001
@@ -47,9 +45,7 @@ export declare class Albums extends Base {
      */
     artistAlbums(params: {
         filter: UID;
-    } & ExtendedPagination): Promise<Album[] | {
-        album: Album[];
-    }>;
+    } & ExtendedPagination): Promise<AlbumsResponse>;
     /**
      * This returns the albums associated with the genre in question
      * @remarks MINIMUM_API_VERSION=380001
@@ -62,7 +58,5 @@ export declare class Albums extends Base {
      */
     genreAlbums(params?: {
         filter: UID;
-    } & ExtendedPagination): Promise<Album[] | {
-        album: Album[];
-    }>;
+    } & ExtendedPagination): Promise<AlbumsResponse>;
 }

package/dist/albums/types.d.ts

@@ -1,14 +1,14 @@
-import { UID } from '../base';
+import { UID } from "../base";
 import { GenreSummary } from "../genres/types";
 import { ArtistSummary } from "../artists/types";
-import { Song } from "../songs/types";
+import { SongResponse } from "../songs/types";
 export type AlbumSummary = {
     id: UID;
     name: string;
     prefix: string | null;
     basename: string;
 };
-export type Album = {
+export type AlbumResponse = {
     id: UID;
     name: string;
     prefix: string | null;
@@ -16,7 +16,7 @@ export type Album = {
     artist: ArtistSummary;
     time: number;
     year: number | string;
-    tracks?: Song[];
+    tracks?: SongResponse[];
     songcount: number;
     disccount: number;
     type: string | null;
@@ -28,3 +28,8 @@ export type Album = {
     averagerating: number | null;
     mbid: string | null;
 };
+export type AlbumsResponse = {
+    total_count: number;
+    md5: string;
+    album: AlbumResponse[];
+};

package/dist/artists/index.d.ts

@@ -1,5 +1,5 @@
-import { Artist } from './types';
-import { Base, BinaryBoolean, ExtendedPagination, UID } from '../base';
+import { ArtistResponse, ArtistsResponse } from "./types";
+import { Base, BinaryBoolean, ExtendedPagination, UID } from "../base";
 export declare class Artists extends Base {
     /**
      * This takes a collection of inputs and returns artist objects
@@ -21,11 +21,9 @@ export declare class Artists extends Base {
         exact?: BinaryBoolean;
         add?: Date;
         update?: Date;
-        include?: 'albums' | 'songs';
+        include?: "albums" | "songs";
         album_artist?: BinaryBoolean;
-    } & ExtendedPagination): Promise<Artist[] | {
-        artist: Artist[];
-    }>;
+    } & ExtendedPagination): Promise<ArtistsResponse>;
     /**
      * This returns a single artist based on the UID of said artist
      * @remarks MINIMUM_API_VERSION=380001
@@ -35,8 +33,8 @@ export declare class Artists extends Base {
      */
     artist(params: {
         filter: UID;
-        include?: 'albums' | 'songs';
-    }): Promise<Artist>;
+        include?: "albums" | "songs";
+    }): Promise<ArtistResponse>;
     /**
      * This returns the artists associated with the genre in question as defined by the UID
      * @remarks MINIMUM_API_VERSION=380001
@@ -49,9 +47,7 @@ export declare class Artists extends Base {
      */
     genreArtists(params: {
         filter: UID;
-    } & ExtendedPagination): Promise<Artist[] | {
-        artist: Artist[];
-    }>;
+    } & ExtendedPagination): Promise<ArtistsResponse>;
     /**
      * This returns the artists associated with the label in question as defined by the UID
      * @remarks MINIMUM_API_VERSION=420000
@@ -64,7 +60,5 @@ export declare class Artists extends Base {
      */
     labelArtists(params: {
         filter: UID;
-    } & ExtendedPagination): Promise<Artist[] | {
-        artist: Artist[];
-    }>;
+    } & ExtendedPagination): Promise<ArtistsResponse>;
 }

package/dist/artists/types.d.ts

@@ -1,22 +1,22 @@
-import { Album } from "../albums/types";
+import { AlbumResponse } from "../albums/types";
 import { Song } from "../songs/types";
-import { Genre } from "../genres/types";
+import { GenreResponse } from "../genres/types";
 export type ArtistSummary = {
     id: string;
     name: string;
     prefix: string | null;
     basename: string;
 };
-export type Artist = {
+export type ArtistResponse = {
     id: string;
     name: string;
     prefix: string | null;
     basename: string;
-    albums: Album[];
+    albums: AlbumResponse[];
     albumcount: number;
     songs: Song[];
     songcount: number;
-    genre: Genre[];
+    genre: GenreResponse[];
     art: string;
     has_art: boolean;
     flag: boolean;
@@ -28,3 +28,8 @@ export type Artist = {
     yearformed: number;
     placeformed: string;
 };
+export type ArtistsResponse = {
+    total_count: number;
+    md5: string;
+    artist: ArtistResponse[];
+};

package/dist/auth/index.d.ts

@@ -1,5 +1,5 @@
 import { Base, Success } from "../base";
-import { AuthResponse } from './types';
+import { AuthResponse } from "./types";
 export declare class Auth extends Base {
     /**
      * Handles verifying a new handshake

package/dist/base.d.ts

@@ -35,6 +35,11 @@ export declare abstract class Base {
     protected request<T>(endpoint: string): Promise<T>;
     protected binary<T>(endpoint: string): Promise<Blob>;
     setSessionKey(sessionKey: string): void;
+    /**
+     * Construct and return a URL
+     * @param endpoint
+     * @param [params]
+     */
     rawURL(endpoint: string, params?: {}): string;
 }
 export {};

package/dist/bookmarks/index.d.ts

@@ -1,5 +1,5 @@
-import { Bookmark } from './types';
-import { Base, BinaryBoolean, Success, UID } from '../base';
+import { BookmarkResponse, BookmarksResponse } from "./types";
+import { Base, BinaryBoolean, Success, UID } from "../base";
 export declare class Bookmarks extends Base {
     /**
      * Get a single bookmark by bookmark_id
@@ -11,7 +11,7 @@ export declare class Bookmarks extends Base {
     bookmark(params: {
         filter: UID;
         include?: BinaryBoolean;
-    }): Promise<Bookmark>;
+    }): Promise<BookmarkResponse>;
     /**
      * Get information about bookmarked media this user is allowed to manage
      * @remarks MINIMUM_API_VERSION=5.0.0
@@ -22,11 +22,9 @@ export declare class Bookmarks extends Base {
     bookmarks(params: {
         client?: string;
         include?: BinaryBoolean;
-    }): Promise<Bookmark[] | {
-        bookmark: Bookmark[];
-    }>;
+    }): Promise<BookmarksResponse>;
     /**
-     * Get the bookmark from its object_id and object_type.
+     * 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
@@ -35,9 +33,10 @@ export declare class Bookmarks extends Base {
      */
     getBookmark(params: {
         filter: UID;
-        type: 'song' | 'video' | 'podcast_episode';
+        type: "song" | "video" | "podcast_episode";
         include?: BinaryBoolean;
-    }): Promise<Bookmark>;
+        all?: BinaryBoolean;
+    }): Promise<BookmarkResponse>;
     /**
      * Create a placeholder for the current media that you can return to later.
      * @remarks MINIMUM_API_VERSION=5.0.0
@@ -51,12 +50,12 @@ export declare class Bookmarks extends Base {
      */
     bookmarkCreate(params: {
         filter: UID;
-        type: 'song' | 'video' | 'podcast_episode';
+        type: "song" | "video" | "podcast_episode";
         position: number;
         client?: string;
         date?: number;
         include?: BinaryBoolean;
-    }): Promise<Bookmark>;
+    }): Promise<BookmarkResponse>;
     /**
      * Edit a placeholder for the current media that you can return to later.
      * @remarks MINIMUM_API_VERSION=5.0.0
@@ -70,23 +69,23 @@ export declare class Bookmarks extends Base {
      */
     bookmarkEdit(params: {
         filter: UID;
-        type: 'song' | 'video' | 'podcast_episode';
+        type: "song" | "video" | "podcast_episode";
         position: number;
         client?: string;
         date?: number;
         include?: BinaryBoolean;
-    }): Promise<Bookmark>;
+    }): Promise<BookmarkResponse>;
     /**
-     * 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}
-     */
+       * 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';
+        type: "song" | "video" | "podcast_episode";
         client?: string;
     }): Promise<Success>;
 }

package/dist/bookmarks/types.d.ts

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

package/dist/catalogs/index.d.ts

@@ -1,5 +1,5 @@
-import { Catalog } from './types';
-import { Base, ExtendedPagination, Success, UID } from '../base';
+import { CatalogResponse, CatalogsResponse } from "./types";
+import { Base, ExtendedPagination, Success, UID } from "../base";
 export declare class Catalogs extends Base {
     /**
      * This searches the catalogs and returns... catalogs
@@ -12,10 +12,8 @@ export declare class Catalogs extends Base {
      * @see {@link https://ampache.org/api/api-json-methods#catalogs}
      */
     catalogs(params?: {
-        filter?: 'music' | 'clip' | 'tvshow' | 'movie' | 'personal_video' | 'podcast';
-    } & ExtendedPagination): Promise<Catalog[] | {
-        catalog: Catalog[];
-    }>;
+        filter?: "music" | "clip" | "tvshow" | "movie" | "personal_video" | "podcast";
+    } & ExtendedPagination): Promise<CatalogsResponse>;
     /**
      * Return catalog by UID
      * @remarks MINIMUM_API_VERSION=420000
@@ -24,7 +22,7 @@ export declare class Catalogs extends Base {
      */
     catalog(params: {
         filter: UID;
-    }): Promise<Catalog>;
+    }): Promise<CatalogResponse>;
     /**
      * Kick off a catalog update or clean for the selected catalog
      * ACCESS REQUIRED: 75 (Catalog Manager)
@@ -34,7 +32,7 @@ export declare class Catalogs extends Base {
      * @see {@link https://ampache.org/api/api-json-methods#catalog_action}
      */
     catalogAction(params: {
-        task: 'add_to_catalog' | 'clean_catalog';
+        task: "add_to_catalog" | "clean_catalog";
         catalog: UID;
     }): Promise<Success>;
     /**
@@ -69,13 +67,13 @@ export declare class Catalogs extends Base {
     catalogAdd(params: {
         name: string;
         path: string;
-        type?: 'local' | 'beets' | 'remote' | 'subsonic' | 'seafile' | 'beetsremote';
-        media_type?: 'music' | 'podcast' | 'clip' | 'tvshow' | 'movie' | 'personal_video';
+        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;
-    }): Promise<Catalog>;
+    }): Promise<CatalogResponse>;
     /**
      * Delete an existing catalog. (if it exists)
      * ACCESS REQUIRED: 75 (Catalog Manager)

package/dist/catalogs/types.d.ts

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

package/dist/genres/index.d.ts

@@ -1,5 +1,5 @@
-import { Genre } from './types';
-import { Base, BinaryBoolean, ExtendedPagination, UID } from '../base';
+import { GenreResponse, GenresResponse } from "./types";
+import { Base, BinaryBoolean, ExtendedPagination, UID } from "../base";
 export declare class Genres extends Base {
     /**
      * This returns the genres (Tags) based on the specified filter
@@ -15,9 +15,7 @@ export declare class Genres extends Base {
     genres(params?: {
         filter?: string;
         exact?: BinaryBoolean;
-    } & ExtendedPagination): Promise<Genre[] | {
-        genre: Genre[];
-    }>;
+    } & ExtendedPagination): Promise<GenresResponse>;
     /**
      * This returns a single genre based on UID
      * @remarks MINIMUM_API_VERSION=380001
@@ -26,5 +24,5 @@ export declare class Genres extends Base {
      */
     genre(params: {
         filter: UID;
-    }): Promise<Genre>;
+    }): Promise<GenreResponse>;
 }

package/dist/genres/types.d.ts

@@ -3,7 +3,7 @@ export type GenreSummary = {
     id: UID;
     name: string;
 };
-export type Genre = {
+export type GenreResponse = {
     id: UID;
     name: string;
     albums: number;
@@ -13,3 +13,8 @@ export type Genre = {
     playlists: number;
     live_streams: number;
 };
+export type GenresResponse = {
+    total_count: number;
+    md5: string;
+    genre: GenreResponse[];
+};

package/dist/index.d.ts

@@ -1,22 +1,22 @@
-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 { Base } from './base';
+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 { Base } from "./base";
 declare 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 {