javascript-ampache 1.0.9 → 1.1.0

package/src/videos/index.ts

@@ -1,53 +1,49 @@
-import qs from 'querystringify';
-import { Video, DeletedVideo } from './types';
-import { Base, BinaryBoolean, Pagination, UID } from '../base';
-
-export class Videos extends Base {
-    /**
-     * Get videos
-     * @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.offset]
-     * @param [params.limit]
-     * @see {@link https://ampache.org/api/api-json-methods#videos}
-     */
-    async videos (params?: {
-        filter?: string,
-        exact?: BinaryBoolean,
-    } & Pagination) {
-        let query = 'videos';
-        query += qs.stringify(params, '&');
-        let data = await this.request<{video: Video[]}>(query);
-        return (data.video) ? data.video : data;
-    }
-
-    /**
-     * This returns a single video
-     * @remarks MINIMUM_API_VERSION=380001
-     * @param params.filter UID to find
-     * @see {@link https://ampache.org/api/api-json-methods#video}
-     */
-    video (params: {
-        filter: UID,
-    }) {
-        let query = 'video';
-        query += qs.stringify(params, '&');
-        return this.request<Video>(query);
-    }
-
-    /**
-     * 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}
-     */
-    async deletedVideos (params?: {
-
-    } & Pagination) {
-        let query = 'deleted_videos';
-        query += qs.stringify(params, '&');
-        let data = await this.request<{deleted_video: DeletedVideo[]}>(query);
-        return (data.deleted_video) ? data.deleted_video : data;
-    }
-}
+import qs from "querystringify";
+import { VideoResponse, VideosResponse, DeletedVideosResponse } from "./types";
+import { Base, BinaryBoolean, Pagination, UID } from "../base";
+
+export class Videos extends Base {
+  /**
+   * Get videos
+   * @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.offset]
+   * @param [params.limit]
+   * @see {@link https://ampache.org/api/api-json-methods#videos}
+   */
+  videos(
+    params?: {
+      filter?: string;
+      exact?: BinaryBoolean;
+    } & Pagination,
+  ) {
+    let query = "videos";
+    query += qs.stringify(params, "&");
+    return this.request<VideosResponse>(query);
+  }
+
+  /**
+   * This returns a single video
+   * @remarks MINIMUM_API_VERSION=380001
+   * @param params.filter UID to find
+   * @see {@link https://ampache.org/api/api-json-methods#video}
+   */
+  video(params: { filter: UID }) {
+    let query = "video";
+    query += qs.stringify(params, "&");
+    return this.request<VideoResponse>(query);
+  }
+
+  /**
+   * 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) {
+    let query = "deleted_videos";
+    query += qs.stringify(params, "&");
+    return this.request<DeletedVideosResponse>(query);
+  }
+}

package/src/videos/types.ts

@@ -1,30 +1,42 @@
-import { UID } from "../base";
-import { GenreSummary } from "../genres/types";
-
-export type Video = {
-    id: UID,
-    title: string,
-    mime: string,
-    resolution: string,
-    size: number,
-    genre: GenreSummary[],
-    time: number,
-    url: string,
-    art: string,
-    has_art: boolean,
-    flag: boolean,
-    rating: number | null,
-    averagerating: number | null,
-    playcount: number,
-}
-
-export type DeletedVideo = {
-    id: UID,
-    addition_time: number,
-    delete_time: number,
-    title: string,
-    file: string,
-    catalog: UID,
-    total_count: number,
-    total_skip: number,
-}
+import { UID } from "../base";
+import { GenreSummary } from "../genres/types";
+
+export type VideoResponse = {
+  id: UID;
+  title: string;
+  mime: string;
+  resolution: string;
+  size: number;
+  genre: GenreSummary[];
+  time: number;
+  url: string;
+  art: string;
+  has_art: boolean;
+  flag: boolean;
+  rating: number | null;
+  averagerating: number | null;
+  playcount: number;
+};
+
+export type VideosResponse = {
+  total_count: number;
+  md5: string;
+  video: VideoResponse[];
+};
+
+export type DeletedVideoResponse = {
+  id: UID;
+  addition_time: number;
+  delete_time: number;
+  title: string;
+  file: string;
+  catalog: UID;
+  total_count: number;
+  total_skip: number;
+};
+
+export type DeletedVideosResponse = {
+  total_count: number;
+  md5: string;
+  deleted_video: DeletedVideoResponse[];
+};