javascript-ampache 1.0.9 → 1.1.1

package/dist/songs/index.d.ts

@@ -1,5 +1,5 @@
-import { Song, DeletedSong } from './types';
-import { Base, BinaryBoolean, ExtendedPagination, Pagination, Success, UID } from '../base';
+import { SongResponse, SongsResponse, DeletedSongsResponse } from "./types";
+import { Base, BinaryBoolean, ExtendedPagination, Pagination, Success, UID } from "../base";
 export declare class Songs extends Base {
     /**
      * Returns songs based on the specified filter
@@ -19,9 +19,7 @@ export declare class Songs extends Base {
         exact?: BinaryBoolean;
         add?: Date;
         update?: Date;
-    } & ExtendedPagination): Promise<Song[] | {
-        song: Song[];
-    }>;
+    } & ExtendedPagination): Promise<SongsResponse>;
     /**
      * Returns a single song
      * @remarks MINIMUM_API_VERSION=380001
@@ -30,7 +28,7 @@ export declare class Songs extends Base {
      */
     song(params: {
         filter: UID;
-    }): Promise<Song>;
+    }): Promise<SongResponse>;
     /**
      * Songs of the specified artist
      * @remarks MINIMUM_API_VERSION=380001
@@ -45,9 +43,7 @@ export declare class Songs extends Base {
     artistSongs(params: {
         filter: UID;
         top50?: BinaryBoolean;
-    } & ExtendedPagination): Promise<Song[] | {
-        song: Song[];
-    }>;
+    } & ExtendedPagination): Promise<SongsResponse>;
     /**
      * Songs of the specified album
      * @remarks MINIMUM_API_VERSION=380001
@@ -60,9 +56,7 @@ export declare class Songs extends Base {
      */
     albumSongs(params: {
         filter: UID;
-    } & ExtendedPagination): Promise<Song[] | {
-        song: Song[];
-    }>;
+    } & ExtendedPagination): Promise<SongsResponse>;
     /**
      * Songs of the specified genre
      * @remarks MINIMUM_API_VERSION=380001
@@ -75,9 +69,7 @@ export declare class Songs extends Base {
      */
     genreSongs(params: {
         filter: UID;
-    } & ExtendedPagination): Promise<Song[] | {
-        song: Song[];
-    }>;
+    } & ExtendedPagination): Promise<SongsResponse>;
     /**
      * This returns the songs for a playlist
      * @remarks MINIMUM_API_VERSION=380001
@@ -90,9 +82,7 @@ export declare class Songs extends Base {
     playlistSongs(params: {
         filter: UID;
         random?: BinaryBoolean;
-    } & Pagination): Promise<Song[] | {
-        song: Song[];
-    }>;
+    } & Pagination): Promise<SongsResponse>;
     /**
      * This returns the songs for a license
      * @remarks MINIMUM_API_VERSION=420000
@@ -105,9 +95,7 @@ export declare class Songs extends Base {
      */
     licenseSongs(params: {
         filter: UID;
-    } & ExtendedPagination): Promise<Song[] | {
-        song: Song[];
-    }>;
+    } & ExtendedPagination): Promise<SongsResponse>;
     /**
      * Delete an existing song. (if you are allowed to)
      * @remarks MINIMUM_API_VERSION=5.0.0
@@ -125,7 +113,7 @@ export declare class Songs extends Base {
      */
     urlToSong(params: {
         url: string;
-    }): Promise<Song>;
+    }): Promise<SongResponse>;
     /**
      * This searches the songs and returns... songs
      * @remarks MINIMUM_API_VERSION=380001
@@ -136,9 +124,7 @@ export declare class Songs extends Base {
      */
     searchSongs(params: {
         filter: string;
-    } & Pagination): Promise<Song[] | {
-        song: Song[];
-    }>;
+    } & Pagination): Promise<SongsResponse>;
     /**
      * Returns songs that have been deleted from the server
      * @remarks MINIMUM_API_VERSION=500000
@@ -146,7 +132,5 @@ export declare class Songs extends Base {
      * @param [params.limit]
      * @see {@link https://ampache.org/api/api-json-methods#deleted_songs}
      */
-    deletedSongs(params?: {} & Pagination): Promise<DeletedSong[] | {
-        deleted_song: DeletedSong[];
-    }>;
+    deletedSongs(params?: {} & Pagination): Promise<DeletedSongsResponse>;
 }

package/dist/songs/types.d.ts

@@ -2,7 +2,7 @@ import { ArtistSummary } from "../artists/types";
 import { GenreSummary } from "../genres/types";
 import { UID } from "../base";
 import { AlbumSummary } from "../albums/types";
-export type Song = {
+export type SongResponse = {
     id: UID;
     title: string;
     name: string;
@@ -48,7 +48,12 @@ export type Song = {
     r128_album_gain: number | null;
     r128_track_gain: number | null;
 };
-export type DeletedSong = {
+export type SongsResponse = {
+    total_count: number;
+    md5: string;
+    song: SongResponse[];
+};
+export type DeletedSongResponse = {
     id: UID;
     addition_time: number;
     delete_time: number;
@@ -61,3 +66,8 @@ export type DeletedSong = {
     album: UID;
     artist: UID;
 };
+export type DeletedSongsResponse = {
+    total_count: number;
+    md5: string;
+    deleted_song: DeletedSongResponse[];
+};

package/dist/system/index.d.ts

@@ -1,4 +1,4 @@
-import { Base, BinaryBoolean, ExtendedPagination, Pagination, Success, UID } from '../base';
+import { Base, BinaryBoolean, ExtendedPagination, Pagination, Success, UID } from "../base";
 import { IndexEntry } from "./types";
 export declare class System extends Base {
     /**
@@ -24,13 +24,13 @@ 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";
         filter?: string;
         add?: Date;
         update?: Date;
         include?: BinaryBoolean;
         hide_search?: BinaryBoolean;
-    } & ExtendedPagination): Promise<any>;
+    } & ExtendedPagination): any;
     /**
      * This takes a named array of objects and returning `id`, `name`, `prefix` and `basename`
      * @remarks MINIMUM_API_VERSION=6.0.0
@@ -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";
         filter?: string;
         add?: Date;
         update?: Date;
@@ -71,7 +71,7 @@ export declare class System extends Base {
      * @see {@link https://ampache.org/api/api-json-methods#index}
      */
     index(params: {
-        type: 'catalog' | 'song' | 'album' | 'artist' | 'album_artist' | 'song_artist' | 'playlist' | 'podcast' | 'podcast_episode' | 'share' | 'video' | 'live_stream';
+        type: "catalog" | "song" | "album" | "artist" | "album_artist" | "song_artist" | "playlist" | "podcast" | "podcast_episode" | "share" | "video" | "live_stream";
         filter?: string;
         exact?: BinaryBoolean;
         add?: Date;
@@ -98,7 +98,7 @@ export declare class System extends Base {
      */
     browse(params: {
         filter?: UID;
-        type?: 'root' | 'catalog' | 'artist' | 'album' | 'podcast';
+        type?: "root" | "catalog" | "artist" | "album" | "podcast";
         catalog?: number;
         add?: Date;
         update?: Date;
@@ -115,9 +115,9 @@ export declare class System extends Base {
      * @see {@link https://ampache.org/api/api-json-methods#get_similar}
      */
     getSimilar(params: {
-        type: 'song' | 'artist';
+        type: "song" | "artist";
         filter: UID;
-    } & Pagination): Promise<any>;
+    } & Pagination): any;
     /**
      * Get some items based on some simple search types and filters. (Random by default)
      * @remarks MINIMUM_API_VERSION=380001; CHANGED_IN_API_VERSION=400001
@@ -130,11 +130,11 @@ export declare class System extends Base {
      * @see {@link https://ampache.org/api/api-json-methods#stats}
      */
     stats(params: {
-        type: 'song' | 'album' | 'artist' | 'video' | 'playlist' | 'podcast' | 'podcast_episode';
-        filter?: 'newest' | 'highest' | 'frequent' | 'recent' | 'forgotten' | 'flagged' | 'random';
+        type: "song" | "album" | "artist" | "video" | "playlist" | "podcast" | "podcast_episode";
+        filter?: "newest" | "highest" | "frequent" | "recent" | "forgotten" | "flagged" | "random";
         user_id?: number;
         username?: string;
-    } & Pagination): Promise<any>;
+    } & Pagination): any;
     /**
      * This rates a library item
      * @remarks MINIMUM_API_VERSION=380001
@@ -144,7 +144,7 @@ export declare class System extends Base {
      * @see {@link https://ampache.org/api/api-json-methods#rate}
      */
     rate(params: {
-        type: 'song' | 'album' | 'artist' | 'playlist' | 'podcast' | 'podcast_episode' | 'video' | 'tvshow' | 'tvshow_season';
+        type: "song" | "album" | "artist" | "playlist" | "podcast" | "podcast_episode" | "video" | "tvshow" | "tvshow_season";
         id: UID;
         rating: 0 | 1 | 2 | 3 | 4 | 5;
     }): Promise<Success>;
@@ -157,7 +157,7 @@ export declare class System extends Base {
      * @see {@link https://ampache.org/api/api-json-methods#flag}
      */
     flag(params: {
-        type: 'song' | 'album' | 'artist' | 'playlist' | 'podcast' | 'podcast_episode' | 'video' | 'tvshow' | 'tvshow_season';
+        type: "song" | "album" | "artist" | "playlist" | "podcast" | "podcast_episode" | "video" | "tvshow" | "tvshow_season";
         id: UID;
         flag: BinaryBoolean;
     }): Promise<Success>;
@@ -215,7 +215,7 @@ export declare class System extends Base {
      * @see {@link https://ampache.org/api/api-json-methods#update_from_tags}
      */
     updateFromTags(params: {
-        type: 'song' | 'artist' | 'album';
+        type: "song" | "artist" | "album";
         id: UID;
     }): Promise<Success>;
     /**
@@ -241,7 +241,7 @@ export declare class System extends Base {
      */
     updateArt(params: {
         id: UID;
-        type: 'artist' | 'album' | 'song';
+        type: "artist" | "album" | "song";
         overwrite?: BinaryBoolean;
     }): Promise<Success>;
     /**
@@ -259,7 +259,7 @@ export declare class System extends Base {
      */
     stream(params: {
         id: UID;
-        type: 'song' | 'podcast_episode' | 'search' | 'playlist';
+        type: "song" | "podcast_episode" | "search" | "playlist";
         bitrate?: number;
         format?: string;
         offset?: number;
@@ -276,7 +276,7 @@ export declare class System extends Base {
      */
     download(params: {
         id: UID;
-        type: 'song' | 'podcast_episode' | 'search' | 'playlist';
+        type: "song" | "podcast_episode" | "search" | "playlist";
         format?: string;
     }): Promise<Blob>;
     /**
@@ -288,7 +288,7 @@ export declare class System extends Base {
      */
     getArt(params: {
         id: UID;
-        type: 'song' | 'artist' | 'album' | 'playlist' | 'search' | 'podcast';
+        type: "song" | "artist" | "album" | "playlist" | "search" | "podcast";
     }): Promise<Blob>;
     /**
      * This is for controlling localplay
@@ -300,9 +300,9 @@ export declare class System extends Base {
      * @see {@link https://ampache.org/api/api-json-methods#localplay}
      */
     localplay(params: {
-        command: 'next' | 'prev' | 'stop' | 'play' | 'pause' | 'add' | 'volume_up' | 'volume_down' | 'volume_mute' | 'delete_all' | 'skip' | 'status';
+        command: "next" | "prev" | "stop" | "play" | "pause" | "add" | "volume_up" | "volume_down" | "volume_mute" | "delete_all" | "skip" | "status";
         oid?: number;
-        type?: 'song' | 'video' | 'podcast_episode' | 'channel' | 'broadcast' | 'democratic' | 'live_stream';
+        type?: "song" | "video" | "podcast_episode" | "channel" | "broadcast" | "democratic" | "live_stream";
         clear?: BinaryBoolean;
     }): Promise<unknown>;
     /**
@@ -322,7 +322,7 @@ export declare class System extends Base {
      */
     democratic(params: {
         oid: UID;
-        method: 'vote' | 'devote' | 'playlist' | 'play';
+        method: "vote" | "devote" | "playlist" | "play";
     }): Promise<unknown>;
     /**
      * Perform an advanced search given passed rules.
@@ -337,9 +337,9 @@ export declare class System extends Base {
      * @see {@link https://ampache.org/api/api-json-methods#advanced_search}
      */
     advancedSearch(params: {
-        operator: 'and' | 'or';
-        type: 'song' | 'album' | 'album_disk' | 'artist' | 'album_artist' | 'song_artist' | 'label' | 'playlist' | 'podcast' | 'podcast_episode' | 'genre' | 'user' | 'video';
+        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): Promise<any>;
+    } & Pagination): any;
 }

package/dist/system/types.d.ts

@@ -1,13 +1,13 @@
-import { Song } from "../songs/types";
-import { Album } from "../albums/types";
-import { Artist } from "../artists/types";
-import { Playlist } from "../playlists/types";
-import { Podcast, PodcastEpisode } from "../podcasts/types";
-import { LiveStream } from "../live-streams/types";
-import { Video } from "../videos/types";
+import { SongResponse } from "../songs/types";
+import { AlbumResponse } from "../albums/types";
+import { ArtistResponse } from "../artists/types";
+import { PlaylistResponse } from "../playlists/types";
+import { PodcastResponse, PodcastEpisodeResponse } from "../podcasts/types";
+import { LiveStreamResponse } from "../live-streams/types";
+import { VideoResponse } from "../videos/types";
 import { UID } from "../base";
-export type IndexType = Song | Album | Artist | Playlist | Podcast | PodcastEpisode | LiveStream;
-export type StatsType = Song | Album | Artist | Video | Playlist | Podcast | PodcastEpisode;
+export type IndexType = SongResponse | AlbumResponse | ArtistResponse | PlaylistResponse | PodcastResponse | PodcastEpisodeResponse | LiveStreamResponse;
+export type StatsType = SongResponse | AlbumResponse | ArtistResponse | VideoResponse | PlaylistResponse | PodcastResponse | PodcastEpisodeResponse;
 export type IndexEntry = {
     id: UID;
     name: string;

package/dist/users/index.d.ts

@@ -1,12 +1,12 @@
-import { User, UserSummary, Activity } from './types';
-import { Base, BinaryBoolean, ExtendedPagination, Success } from '../base';
+import { UserResponse, UserSummary, ActivityResponse } from "./types";
+import { Base, BinaryBoolean, ExtendedPagination, Success } from "../base";
 export declare class Users extends Base {
     /**
      * Get ids and usernames for your site
      * @remarks MINIMUM_API_VERSION=5.0.0
      * @see {@link https://ampache.org/api/api-json-methods#users}
      */
-    users(): Promise<UserSummary[] | {
+    users(): Promise<{
         user: UserSummary[];
     }>;
     /**
@@ -17,7 +17,7 @@ export declare class Users extends Base {
      */
     user(params?: {
         username?: string;
-    }): Promise<User>;
+    }): Promise<UserResponse>;
     /**
      * Create a new user
      * ACCESS REQUIRED: 100 (Admin)
@@ -138,7 +138,7 @@ export declare class Users extends Base {
      */
     followers(params: {
         username: string;
-    } & ExtendedPagination): Promise<UserSummary[] | {
+    } & ExtendedPagination): Promise<{
         user: UserSummary[];
     }>;
     /**
@@ -148,7 +148,7 @@ export declare class Users extends Base {
      */
     following(params: {
         username: string;
-    }): Promise<UserSummary[] | {
+    }): Promise<{
         user: UserSummary[];
     }>;
     /**
@@ -171,8 +171,8 @@ export declare class Users extends Base {
         username: string;
         limit?: number;
         since?: number;
-    }): Promise<Activity[] | {
-        activity: Activity[];
+    }): Promise<{
+        activity: ActivityResponse[];
     }>;
     /**
      * This get current user friends timeline
@@ -184,7 +184,7 @@ export declare class Users extends Base {
     friendsTimeline(params?: {
         limit?: number;
         since?: number;
-    }): Promise<Activity[] | {
-        activity: Activity[];
+    }): Promise<{
+        activity: ActivityResponse[];
     }>;
 }

package/dist/users/types.d.ts

@@ -3,7 +3,7 @@ export type UserSummary = {
     id: UID;
     username: string;
 };
-export type User = {
+export type UserResponse = {
     id: UID;
     username: string;
     auth: string;
@@ -19,7 +19,12 @@ export type User = {
     state: string | null;
     city: string | null;
 };
-export type Activity = {
+export type UsersResponse = {
+    total_count: number;
+    md5: string;
+    user: UserResponse[];
+};
+export type ActivityResponse = {
     id: UID;
     date: number;
     object_type: string;

package/dist/videos/index.d.ts

@@ -1,5 +1,5 @@
-import { Video, DeletedVideo } from './types';
-import { Base, BinaryBoolean, Pagination, UID } from '../base';
+import { VideoResponse, VideosResponse, DeletedVideosResponse } from "./types";
+import { Base, BinaryBoolean, Pagination, UID } from "../base";
 export declare class Videos extends Base {
     /**
      * Get videos
@@ -13,9 +13,7 @@ export declare class Videos extends Base {
     videos(params?: {
         filter?: string;
         exact?: BinaryBoolean;
-    } & Pagination): Promise<Video[] | {
-        video: Video[];
-    }>;
+    } & Pagination): Promise<VideosResponse>;
     /**
      * This returns a single video
      * @remarks MINIMUM_API_VERSION=380001
@@ -24,14 +22,12 @@ export declare class Videos extends Base {
      */
     video(params: {
         filter: UID;
-    }): Promise<Video>;
+    }): Promise<VideoResponse>;
     /**
      * This returns video objects that have been deleted
      * @param [params.offset]
      * @param [params.limit]
      * @see {@link https://ampache.org/api/api-json-methods#deleted_videos}
      */
-    deletedVideos(params?: {} & Pagination): Promise<DeletedVideo[] | {
-        deleted_video: DeletedVideo[];
-    }>;
+    deletedVideos(params?: {} & Pagination): Promise<DeletedVideosResponse>;
 }

package/dist/videos/types.d.ts

@@ -1,6 +1,6 @@
 import { UID } from "../base";
 import { GenreSummary } from "../genres/types";
-export type Video = {
+export type VideoResponse = {
     id: UID;
     title: string;
     mime: string;
@@ -16,7 +16,12 @@ export type Video = {
     averagerating: number | null;
     playcount: number;
 };
-export type DeletedVideo = {
+export type VideosResponse = {
+    total_count: number;
+    md5: string;
+    video: VideoResponse[];
+};
+export type DeletedVideoResponse = {
     id: UID;
     addition_time: number;
     delete_time: number;
@@ -26,3 +31,8 @@ export type DeletedVideo = {
     total_count: number;
     total_skip: number;
 };
+export type DeletedVideosResponse = {
+    total_count: number;
+    md5: string;
+    deleted_video: DeletedVideoResponse[];
+};

package/package.json

@@ -1,38 +1,38 @@
-{
-  "name": "javascript-ampache",
-  "version": "1.0.9",
-  "description": "A JS library for the Ampache API",
-  "main": "dist/index.js",
-  "module": "dist/index.m.js",
-  "umd:main": "dist/index.umd.js",
-  "source": "src/index.ts",
-  "repository": "github:mitchray/javascript-ampache",
-  "scripts": {
-    "build": "rimraf dist && microbundle --tsconfig tsconfig.json",
-    "dev": "microbundle watch --tsconfig tsconfig.json",
-    "test": "jest"
-  },
-  "devDependencies": {
-    "@types/jest": "^25.2.3",
-    "isomorphic-unfetch": "^3.1.0",
-    "jest": "^29.3.1",
-    "jssha": "^3.3.0",
-    "microbundle": "^0.15.1",
-    "nock": "^13.0.0",
-    "querystringify": "2.2.0",
-    "rimraf": "^5.0.0"
-  },
-  "keywords": [
-    "ampache",
-    "javascript",
-    "typescript",
-    "api",
-    "js"
-  ],
-  "author": "mitchray (https://github.com/mitchray)",
-  "license": "GPL-3.0-only",
-  "files": [
-    "src",
-    "dist"
-  ]
-}
+{
+  "name": "javascript-ampache",
+  "version": "1.1.1",
+  "description": "A JS library for the Ampache API",
+  "main": "dist/index.js",
+  "module": "dist/index.m.js",
+  "umd:main": "dist/index.umd.js",
+  "source": "src/index.ts",
+  "repository": "github:mitchray/javascript-ampache",
+  "scripts": {
+    "build": "rimraf dist && microbundle --tsconfig tsconfig.json",
+    "dev": "microbundle watch --tsconfig tsconfig.json",
+    "test": "jest"
+  },
+  "devDependencies": {
+    "@types/jest": "^25.2.3",
+    "isomorphic-unfetch": "^3.1.0",
+    "jest": "^29.3.1",
+    "jssha": "^3.3.0",
+    "microbundle": "^0.15.1",
+    "nock": "^13.0.0",
+    "querystringify": "2.2.0",
+    "rimraf": "^5.0.0"
+  },
+  "keywords": [
+    "ampache",
+    "javascript",
+    "typescript",
+    "api",
+    "js"
+  ],
+  "author": "mitchray (https://github.com/mitchray)",
+  "license": "GPL-3.0-only",
+  "files": [
+    "src",
+    "dist"
+  ]
+}