javascript-ampache 1.0.8 → 1.1.0

package/package.json

@@ -1,38 +1,38 @@
-{
-  "name": "javascript-ampache",
-  "version": "1.0.8",
-  "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.0",
+  "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"
+  ]
+}

package/src/albums/index.ts

@@ -1,86 +1,86 @@
-import qs from 'querystringify';
-import { Album } from './types';
-import { Base, BinaryBoolean, ExtendedPagination, UID } from '../base';
-
-export class Albums extends Base {
-    /**
-     * This returns albums based on the provided search filters
-     * @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.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.include] albums, songs (include child objects in the response)
-     * @param [params.offset]
-     * @param [params.limit]
-     * @param [params.cond]
-     * @param [params.sort]
-     * @see {@link https://ampache.org/api/api-json-methods#albums}
-     */
-    async albums (params?: {
-        filter?: number,
-        exact?: BinaryBoolean,
-        add?: Date,
-        update?: Date,
-        include?: "albums" | "songs",
-    } & ExtendedPagination) {
-        let query = 'albums';
-        query += qs.stringify(params, '&');
-        let data = await this.request<{album: Album[]}>(query);
-        return (data.album) ? data.album : data;
-    }
-
-    /**
-     * This returns a single album based on the UID provided
-     * @remarks MINIMUM_API_VERSION=380001
-     * @param params.filter UID to find
-     * @param [params.include] songs (include child objects in the response)
-     * @see {@link https://ampache.org/api/api-json-methods#album}
-     */
-    album (params: {
-        filter: UID,
-        include?: 'songs'
-    }) {
-        let query = 'album';
-        query += qs.stringify(params, '&');
-        return this.request<Album>(query);
-    }
-
-    /**
-     * This returns the albums of an artist
-     * @remarks MINIMUM_API_VERSION=380001
-     * @param params.filter UID to find
-     * @param [params.offset]
-     * @param [params.limit]
-     * @param [params.cond]
-     * @param [params.sort]
-     * @see {@link https://ampache.org/api/api-json-methods#artist_albums}
-     */
-    async artistAlbums (params: {
-        filter: UID
-    } & ExtendedPagination) {
-        let query = 'artist_albums';
-        query += qs.stringify(params, '&');
-        let data = await this.request<{album: Album[]}>(query);
-        return (data.album) ? data.album : data;
-    }
-
-    /**
-     * This returns the albums associated with the genre in question
-     * @remarks MINIMUM_API_VERSION=380001
-     * @param params.filter UID to find
-     * @param [params.offset]
-     * @param [params.limit]
-     * @param [params.cond]
-     * @param [params.sort]
-     * @see {@link https://ampache.org/api/api-json-methods#genre_albums}
-     */
-    async genreAlbums (params?: {
-        filter: UID
-    } & ExtendedPagination) {
-        let query = 'genre_albums';
-        query += qs.stringify(params, '&');
-        let data = await this.request<{album: Album[]}>(query);
-        return (data.album) ? data.album : data;
-    }
-}
+import qs from "querystringify";
+import { AlbumResponse, AlbumsResponse } from "./types";
+import { Base, BinaryBoolean, ExtendedPagination, UID } from "../base";
+
+export class Albums extends Base {
+  /**
+   * This returns albums based on the provided search filters
+   * @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.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.include] albums, songs (include child objects in the response)
+   * @param [params.offset]
+   * @param [params.limit]
+   * @param [params.cond]
+   * @param [params.sort]
+   * @see {@link https://ampache.org/api/api-json-methods#albums}
+   */
+  albums(
+    params?: {
+      filter?: number;
+      exact?: BinaryBoolean;
+      add?: Date;
+      update?: Date;
+      include?: "albums" | "songs";
+    } & ExtendedPagination,
+  ) {
+    let query = "albums";
+    query += qs.stringify(params, "&");
+    return this.request<AlbumsResponse>(query);
+  }
+
+  /**
+   * This returns a single album based on the UID provided
+   * @remarks MINIMUM_API_VERSION=380001
+   * @param params.filter UID to find
+   * @param [params.include] songs (include child objects in the response)
+   * @see {@link https://ampache.org/api/api-json-methods#album}
+   */
+  album(params: { filter: UID; include?: "songs" }) {
+    let query = "album";
+    query += qs.stringify(params, "&");
+    return this.request<AlbumResponse>(query);
+  }
+
+  /**
+   * This returns the albums of an artist
+   * @remarks MINIMUM_API_VERSION=380001
+   * @param params.filter UID to find
+   * @param [params.offset]
+   * @param [params.limit]
+   * @param [params.cond]
+   * @param [params.sort]
+   * @see {@link https://ampache.org/api/api-json-methods#artist_albums}
+   */
+  artistAlbums(
+    params: {
+      filter: UID;
+    } & ExtendedPagination,
+  ) {
+    let query = "artist_albums";
+    query += qs.stringify(params, "&");
+    return this.request<AlbumsResponse>(query);
+  }
+
+  /**
+   * This returns the albums associated with the genre in question
+   * @remarks MINIMUM_API_VERSION=380001
+   * @param params.filter UID to find
+   * @param [params.offset]
+   * @param [params.limit]
+   * @param [params.cond]
+   * @param [params.sort]
+   * @see {@link https://ampache.org/api/api-json-methods#genre_albums}
+   */
+  genreAlbums(
+    params?: {
+      filter: UID;
+    } & ExtendedPagination,
+  ) {
+    let query = "genre_albums";
+    query += qs.stringify(params, "&");
+    return this.request<AlbumsResponse>(query);
+  }
+}

package/src/albums/types.ts

@@ -1,32 +1,38 @@
-import { UID } from '../base';
-import { GenreSummary } from "../genres/types";
-import { ArtistSummary } from "../artists/types";
-import { Song } from "../songs/types";
-
-export type AlbumSummary = {
-    id: UID,
-    name: string,
-    prefix: string | null,
-    basename: string,
-}
-
-export type Album = {
-    id: UID,
-    name: string,
-    prefix: string | null,
-    basename: string,
-    artist: ArtistSummary,
-    time: number,
-    year: number | string,
-    tracks?: Song[],
-    songcount: number,
-    disccount: number,
-    type: string | null,
-    genre: GenreSummary[],
-    art: string,
-    has_art: boolean,
-    flag: boolean,
-    rating: number | null,
-    averagerating: number | null,
-    mbid: string | null
-}
+import { UID } from "../base";
+import { GenreSummary } from "../genres/types";
+import { ArtistSummary } from "../artists/types";
+import { SongResponse } from "../songs/types";
+
+export type AlbumSummary = {
+  id: UID;
+  name: string;
+  prefix: string | null;
+  basename: string;
+};
+
+export type AlbumResponse = {
+  id: UID;
+  name: string;
+  prefix: string | null;
+  basename: string;
+  artist: ArtistSummary;
+  time: number;
+  year: number | string;
+  tracks?: SongResponse[];
+  songcount: number;
+  disccount: number;
+  type: string | null;
+  genre: GenreSummary[];
+  art: string;
+  has_art: boolean;
+  flag: boolean;
+  rating: number | null;
+  averagerating: number | null;
+  mbid: string | null;
+};
+
+export type AlbumsResponse = {
+  total_count: number;
+  md5: string;
+  album: AlbumResponse[];
+};

package/src/artists/index.ts

@@ -1,88 +1,88 @@
-import qs from 'querystringify';
-import { Artist } from './types';
-import { Base, BinaryBoolean, ExtendedPagination, UID } from '../base';
-
-export class Artists extends Base {
-    /**
-     * This takes a collection of inputs and returns artist objects
-     * @remarks MINIMUM_API_VERSION=380001
-     * @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.include] (albums | songs) include child objects in the response
-     * @param [params.album_artist] 0, 1 (if true filter for album artists only)
-     * @param [params.offset]
-     * @param [params.limit]
-     * @param [params.cond]
-     * @param [params.sort]
-     * @see {@link https://ampache.org/api/api-json-methods#artists}
-     */
-    async artists (params?: {
-        filter?: string,
-        exact?: BinaryBoolean,
-        add?: Date,
-        update?: Date,
-        include?: 'albums' | 'songs',
-        album_artist?: BinaryBoolean,
-    } & ExtendedPagination) {
-        let query = 'artists';
-        query += qs.stringify(params, '&');
-        let data = await this.request<{artist: Artist[]}>(query);
-        return (data.artist) ? data.artist : data;
-    }
-
-    /**
-     * This returns a single artist based on the UID of said artist
-     * @remarks MINIMUM_API_VERSION=380001
-     * @param params.filter UID to find
-     * @param [params.include] (albums | songs) include child objects in the response
-     * @see {@link https://ampache.org/api/api-json-methods#artist}
-     */
-    artist (params: {
-        filter: UID,
-        include?: 'albums' | 'songs',
-    }) {
-        let query = 'artist';
-        query += qs.stringify(params, '&');
-        return this.request<Artist>(query);
-    }
-
-    /**
-     * This returns the artists associated with the genre in question as defined by the UID
-     * @remarks MINIMUM_API_VERSION=380001
-     * @param params.filter UID to find
-     * @param [params.offset]
-     * @param [params.limit]
-     * @param [params.cond]
-     * @param [params.sort]
-     * @see {@link https://ampache.org/api/api-json-methods#genre_artists}
-     */
-    async genreArtists (params: {
-        filter: UID
-    } & ExtendedPagination) {
-        let query = 'genre_artists';
-        query += qs.stringify(params, '&');
-        let data = await this.request<{artist: Artist[]}>(query);
-        return (data.artist) ? data.artist : data;
-    }
-
-    /**
-     * This returns the artists associated with the label in question as defined by the UID
-     * @remarks MINIMUM_API_VERSION=420000
-     * @param params.filter UID of find
-     * @param [params.offset]
-     * @param [params.limit]
-     * @param [params.cond]
-     * @param [params.sort]
-     * @see {@link https://ampache.org/api/api-json-methods#label_artists}
-     */
-    async labelArtists (params: {
-        filter: UID
-    } & ExtendedPagination) {
-        let query = 'label_artists';
-        query += qs.stringify(params, '&');
-        let data = await this.request<{artist: Artist[]}>(query);
-        return (data.artist) ? data.artist : data;
-    }
-}
+import qs from "querystringify";
+import { ArtistResponse, ArtistsResponse } from "./types";
+import { Base, BinaryBoolean, ExtendedPagination, UID } from "../base";
+
+export class Artists extends Base {
+  /**
+   * This takes a collection of inputs and returns artist objects
+   * @remarks MINIMUM_API_VERSION=380001
+   * @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.include] (albums | songs) include child objects in the response
+   * @param [params.album_artist] 0, 1 (if true filter for album artists only)
+   * @param [params.offset]
+   * @param [params.limit]
+   * @param [params.cond]
+   * @param [params.sort]
+   * @see {@link https://ampache.org/api/api-json-methods#artists}
+   */
+  artists(
+    params?: {
+      filter?: string;
+      exact?: BinaryBoolean;
+      add?: Date;
+      update?: Date;
+      include?: "albums" | "songs";
+      album_artist?: BinaryBoolean;
+    } & ExtendedPagination,
+  ) {
+    let query = "artists";
+    query += qs.stringify(params, "&");
+    return this.request<ArtistsResponse>(query);
+  }
+
+  /**
+   * This returns a single artist based on the UID of said artist
+   * @remarks MINIMUM_API_VERSION=380001
+   * @param params.filter UID to find
+   * @param [params.include] (albums | songs) include child objects in the response
+   * @see {@link https://ampache.org/api/api-json-methods#artist}
+   */
+  artist(params: { filter: UID; include?: "albums" | "songs" }) {
+    let query = "artist";
+    query += qs.stringify(params, "&");
+    return this.request<ArtistResponse>(query);
+  }
+
+  /**
+   * This returns the artists associated with the genre in question as defined by the UID
+   * @remarks MINIMUM_API_VERSION=380001
+   * @param params.filter UID to find
+   * @param [params.offset]
+   * @param [params.limit]
+   * @param [params.cond]
+   * @param [params.sort]
+   * @see {@link https://ampache.org/api/api-json-methods#genre_artists}
+   */
+  genreArtists(
+    params: {
+      filter: UID;
+    } & ExtendedPagination,
+  ) {
+    let query = "genre_artists";
+    query += qs.stringify(params, "&");
+    return this.request<ArtistsResponse>(query);
+  }
+
+  /**
+   * This returns the artists associated with the label in question as defined by the UID
+   * @remarks MINIMUM_API_VERSION=420000
+   * @param params.filter UID of find
+   * @param [params.offset]
+   * @param [params.limit]
+   * @param [params.cond]
+   * @param [params.sort]
+   * @see {@link https://ampache.org/api/api-json-methods#label_artists}
+   */
+  labelArtists(
+    params: {
+      filter: UID;
+    } & ExtendedPagination,
+  ) {
+    let query = "label_artists";
+    query += qs.stringify(params, "&");
+    return this.request<ArtistsResponse>(query);
+  }
+}

package/src/artists/types.ts

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