javascript-ampache 1.0.8 → 1.1.0

package/src/genres/index.ts

@@ -1,40 +1,39 @@
-import qs from 'querystringify';
-import { Genre } from './types';
-import { Base, BinaryBoolean, ExtendedPagination, UID } from '../base';
-
-export class Genres extends Base {
-    /**
-     * This returns the genres (Tags) based on the specified filter
-     * @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.offset]
-     * @param [params.limit]
-     * @param [params.cond]
-     * @param [params.sort]
-     * @see {@link https://ampache.org/api/api-json-methods#genres}
-     */
-    async genres (params?: {
-        filter?: string,
-        exact?: BinaryBoolean,
-    } & ExtendedPagination) {
-        let query = 'genres';
-        query += qs.stringify(params, '&');
-        let data = await this.request<{genre: Genre[]}>(query);
-        return (data.genre) ? data.genre : data;
-    }
-
-    /**
-     * This returns a single genre based on UID
-     * @remarks MINIMUM_API_VERSION=380001
-     * @param params.filter UID to find
-     * @see {@link https://ampache.org/api/api-json-methods#genre}
-     */
-    async genre (params: {
-        filter: UID,
-    }) {
-        let query = 'genre';
-        query += qs.stringify(params, '&');
-        return this.request<Genre>(query);
-    }
-}
+import qs from "querystringify";
+import { GenreResponse, GenresResponse } from "./types";
+import { Base, BinaryBoolean, ExtendedPagination, UID } from "../base";
+
+export class Genres extends Base {
+  /**
+   * This returns the genres (Tags) based on the specified filter
+   * @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.offset]
+   * @param [params.limit]
+   * @param [params.cond]
+   * @param [params.sort]
+   * @see {@link https://ampache.org/api/api-json-methods#genres}
+   */
+  genres(
+    params?: {
+      filter?: string;
+      exact?: BinaryBoolean;
+    } & ExtendedPagination,
+  ) {
+    let query = "genres";
+    query += qs.stringify(params, "&");
+    return this.request<GenresResponse>(query);
+  }
+
+  /**
+   * This returns a single genre based on UID
+   * @remarks MINIMUM_API_VERSION=380001
+   * @param params.filter UID to find
+   * @see {@link https://ampache.org/api/api-json-methods#genre}
+   */
+  genre(params: { filter: UID }) {
+    let query = "genre";
+    query += qs.stringify(params, "&");
+    return this.request<GenreResponse>(query);
+  }
+}

package/src/genres/types.ts

@@ -1,17 +1,23 @@
-import { UID } from "../base";
-
-export type GenreSummary = {
-    id: UID,
-    name: string,
-}
-
-export type Genre = {
-    id: UID,
-    name: string,
-    albums: number,
-    artists: number,
-    songs: number,
-    videos: number,
-    playlists: number,
-    live_streams: number,
-}
+import { UID } from "../base";
+
+export type GenreSummary = {
+  id: UID;
+  name: string;
+};
+
+export type GenreResponse = {
+  id: UID;
+  name: string;
+  albums: number;
+  artists: number;
+  songs: number;
+  videos: number;
+  playlists: number;
+  live_streams: number;
+};
+
+export type GenresResponse = {
+  total_count: number;
+  md5: string;
+  genre: GenreResponse[];
+};

package/src/index.ts

@@ -1,26 +1,63 @@
-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 { applyMixins } from './utils';
-import { Base } from './base';
-
-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 {}
-applyMixins(AmpacheAPI, [Albums, Artists, Auth, Bookmarks, Catalogs, Genres, Labels, Licenses, LiveStreams, Playlists, Podcasts, Preferences, Shares, Shouts, Songs, System, Users, Videos]);
-
-export default AmpacheAPI
+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 { applyMixins } from "./utils";
+import { Base } from "./base";
+
+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 {}
+applyMixins(AmpacheAPI, [
+  Albums,
+  Artists,
+  Auth,
+  Bookmarks,
+  Catalogs,
+  Genres,
+  Labels,
+  Licenses,
+  LiveStreams,
+  Playlists,
+  Podcasts,
+  Preferences,
+  Shares,
+  Shouts,
+  Songs,
+  System,
+  Users,
+  Videos,
+]);
+
+export default AmpacheAPI;

package/src/labels/index.ts

@@ -1,44 +1,43 @@
-import qs from 'querystringify';
-import { Label } from './types';
-import { Base, BinaryBoolean, ExtendedPagination, UID } from '../base';
-
-export class Labels extends Base {
-    /**
-     * This returns labels based on the specified filter
-     * @remarks MINIMUM_API_VERSION=420000
-     * @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.offset]
-     * @param [params.limit]
-     * @param [params.cond]
-     * @param [params.sort]
-     * @see {@link https://ampache.org/api/api-json-methods#labels}
-     */
-    async labels (params?: {
-        filter?: string,
-        exact?: BinaryBoolean,
-        add?: Date,
-        update?: Date,
-    } & ExtendedPagination) {
-        let query = 'labels';
-        query += qs.stringify(params, '&');
-        let data = await this.request<{label: Label[]}>(query);
-        return (data.label) ? data.label : data;
-    }
-
-    /**
-     * This returns a single label
-     * @remarks MINIMUM_API_VERSION=420000
-     * @param params.filter UID to find
-     * @see {@link https://ampache.org/api/api-json-methods#label}
-     */
-    label (params: {
-        filter: UID,
-    }) {
-        let query = 'label';
-        query += qs.stringify(params, '&');
-        return this.request<Label>(query);
-    }
-}
+import qs from "querystringify";
+import { LabelResponse, LabelsResponse } from "./types";
+import { Base, BinaryBoolean, ExtendedPagination, UID } from "../base";
+
+export class Labels extends Base {
+  /**
+   * This returns labels based on the specified filter
+   * @remarks MINIMUM_API_VERSION=420000
+   * @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.offset]
+   * @param [params.limit]
+   * @param [params.cond]
+   * @param [params.sort]
+   * @see {@link https://ampache.org/api/api-json-methods#labels}
+   */
+  labels(
+    params?: {
+      filter?: string;
+      exact?: BinaryBoolean;
+      add?: Date;
+      update?: Date;
+    } & ExtendedPagination,
+  ) {
+    let query = "labels";
+    query += qs.stringify(params, "&");
+    return this.request<LabelsResponse>(query);
+  }
+
+  /**
+   * This returns a single label
+   * @remarks MINIMUM_API_VERSION=420000
+   * @param params.filter UID to find
+   * @see {@link https://ampache.org/api/api-json-methods#label}
+   */
+  label(params: { filter: UID }) {
+    let query = "label";
+    query += qs.stringify(params, "&");
+    return this.request<LabelResponse>(query);
+  }
+}

package/src/labels/types.ts

@@ -1,14 +1,20 @@
-import { UID } from "../base";
-
-export type Label = {
-    id: UID,
-    name: string,
-    artists: number,
-    summary: string | null,
-    external_link: string | null,
-    address: string | null,
-    category: string | null,
-    email: string | null,
-    website: string | null,
-    user: UID,
-}
+import { UID } from "../base";
+
+export type LabelResponse = {
+  id: UID;
+  name: string;
+  artists: number;
+  summary: string | null;
+  external_link: string | null;
+  address: string | null;
+  category: string | null;
+  email: string | null;
+  website: string | null;
+  user: UID;
+};
+
+export type LabelsResponse = {
+  total_count: number;
+  md5: string;
+  label: LabelResponse[];
+};

package/src/licenses/index.ts

@@ -1,44 +1,43 @@
-import qs from 'querystringify';
-import { License } from './types';
-import { Base, BinaryBoolean, ExtendedPagination, UID } from '../base';
-
-export class Licenses extends Base {
-    /**
-     * This returns licenses based on the specified filter
-     * @remarks MINIMUM_API_VERSION=420000
-     * @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.offset]
-     * @param [params.limit]
-     * @param [params.cond]
-     * @param [params.sort]
-     * @see {@link https://ampache.org/api/api-json-methods#licenses}
-     */
-    async licenses (params?: {
-        filter?: string,
-        exact?: BinaryBoolean,
-        add?: Date,
-        update?: Date,
-    } & ExtendedPagination) {
-        let query = 'licenses';
-        query += qs.stringify(params, '&');
-        let data = await this.request<{license: License[]}>(query);
-        return (data.license) ? data.license : data;
-    }
-
-    /**
-     * This returns a single license
-     * @remarks MINIMUM_API_VERSION=420000
-     * @param params.filter UID to find
-     * @see {@link https://ampache.org/api/api-json-methods#license}
-     */
-    license (params: {
-        filter: UID,
-    }) {
-        let query = 'license';
-        query += qs.stringify(params, '&');
-        return this.request<License>(query);
-    }
-}
+import qs from "querystringify";
+import { LicenseResponse, LicensesResponse } from "./types";
+import { Base, BinaryBoolean, ExtendedPagination, UID } from "../base";
+
+export class Licenses extends Base {
+  /**
+   * This returns licenses based on the specified filter
+   * @remarks MINIMUM_API_VERSION=420000
+   * @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.offset]
+   * @param [params.limit]
+   * @param [params.cond]
+   * @param [params.sort]
+   * @see {@link https://ampache.org/api/api-json-methods#licenses}
+   */
+  licenses(
+    params?: {
+      filter?: string;
+      exact?: BinaryBoolean;
+      add?: Date;
+      update?: Date;
+    } & ExtendedPagination,
+  ) {
+    let query = "licenses";
+    query += qs.stringify(params, "&");
+    return this.request<LicensesResponse>(query);
+  }
+
+  /**
+   * This returns a single license
+   * @remarks MINIMUM_API_VERSION=420000
+   * @param params.filter UID to find
+   * @see {@link https://ampache.org/api/api-json-methods#license}
+   */
+  license(params: { filter: UID }) {
+    let query = "license";
+    query += qs.stringify(params, "&");
+    return this.request<LicenseResponse>(query);
+  }
+}

package/src/licenses/types.ts

@@ -1,8 +1,14 @@
-import { UID } from "../base";
-
-export type License = {
-    id: UID,
-    name: string,
-    description: string,
-    external_link: string,
-}
+import { UID } from "../base";
+
+export type LicenseResponse = {
+  id: UID;
+  name: string;
+  description: string;
+  external_link: string;
+};
+
+export type LicensesResponse = {
+  total_count: number;
+  md5: string;
+  license: LicenseResponse[];
+};