javascript-ampache 1.1.10 → 2.0.0

package/dist/users/index.d.ts

@@ -1,190 +0,0 @@
-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<{
-        user: UserSummary[];
-    }>;
-    /**
-     * This get a user's public information (or current user if username is omitted)
-     * @remarks MINIMUM_API_VERSION=380001
-     * @param [params.username] UID to find
-     * @see {@link https://ampache.org/api/api-json-methods#user}
-     */
-    user(params?: {
-        username?: string;
-    }): Promise<UserResponse>;
-    /**
-     * Create a new user
-     * ACCESS REQUIRED: 100 (Admin)
-     * @remarks MINIMUM_API_VERSION=400001
-     * @param params.username Username
-     * @param params.password SHA256 hashed password
-     * @param params.email  Email
-     * @param [params.fullname] Full Name
-     * @param [params.disable] 0, 1
-     * @param [params.catalog_filter_group] Catalog filter group, default = 0
-     * @see {@link https://ampache.org/api/api-json-methods#user_create}
-     */
-    userCreate(params: {
-        username: string;
-        password: string;
-        email: string;
-        fullname?: string;
-        disable?: BinaryBoolean;
-        catalog_filter_group?: number;
-    }): Promise<Success>;
-    /**
-     * Register as a new user if allowed.
-     * @remarks MINIMUM_API_VERSION=6.0.0
-     * @param params.username Username
-     * @param params.password SHA256 hashed password
-     * @param params.email  Email
-     * @param [params.fullname] Full Name
-     * @see {@link https://ampache.org/api/api-json-methods/#register}
-     */
-    register(params: {
-        username: string;
-        password: string;
-        email: string;
-        fullname?: string;
-    }): Promise<Success>;
-    /**
-     * Update an existing user
-     * ACCESS REQUIRED: 100 (Admin)
-     * @remarks MINIMUM_API_VERSION=400001
-     * @param  params.username Username
-     * @param  [params.password] Password
-     * @param  [params.email] Email
-     * @param  [params.fullname] Full Name
-     * @param  [params.website] Website
-     * @param  [params.state] State
-     * @param  [params.city] City
-     * @param  [params.disable] 0, 1
-     * @param  [params.maxbitrate] Max bitrate for transcoding
-     * @see {@link https://ampache.org/api/api-json-methods#user_update}
-     * @deprecated Being removed in 7.0.0. Use `user_edit` instead.
-     */
-    userUpdate(params: {
-        username: string;
-        password?: string;
-        email?: string;
-        fullname?: string;
-        website?: string;
-        state?: string;
-        city?: string;
-        disable?: BinaryBoolean;
-        maxbitrate?: string;
-    }): Promise<Success>;
-    /**
-     * Update an existing user
-     * ACCESS REQUIRED: 100 (Admin)
-     * @remarks MINIMUM_API_VERSION=6.0.0
-     * @param  params.username Username
-     * @param  [params.password] Password
-     * @param  [params.email] Email
-     * @param  [params.fullname] Full Name
-     * @param  [params.website] Website
-     * @param  [params.state] State
-     * @param  [params.city] City
-     * @param  [params.disable] 0, 1
-     * @param  [params.maxbitrate] Max bitrate for transcoding
-     * @param  [params.group] Catalog filter group, default = 0
-     * @param  [params.fullname_public] show fullname in public display
-     * @param  [params.reset_apikey] reset user Api Key
-     * @param  [params.reset_streamtoken] reset user Stream Token
-     * @param  [params.clear_stats] reset all stats for this user
-     * @see {@link https://ampache.org/api/api-json-methods#user_edit}
-     */
-    userEdit(params: {
-        username: string;
-        password?: string;
-        email?: string;
-        fullname?: string;
-        website?: string;
-        state?: string;
-        city?: string;
-        maxbitrate?: string;
-        group?: number;
-        disable?: BinaryBoolean;
-        fullname_public?: BinaryBoolean;
-        reset_apikey?: BinaryBoolean;
-        reset_streamtoken?: BinaryBoolean;
-        clear_stats?: BinaryBoolean;
-    }): Promise<Success>;
-    /**
-     * Delete an existing user.
-     * ACCESS REQUIRED: 100 (Admin)
-     * @remarks MINIMUM_API_VERSION=400001
-     * @param params.filter UID of user to delete
-     * @see {@link https://ampache.org/api/api-json-methods#user_delete}
-     */
-    userDelete(params: {
-        filter: string;
-    }): Promise<Success>;
-    /**
-     * This gets the followers for the requested username
-     * @remarks MINIMUM_API_VERSION=380001
-     * @param params.username UID to find
-     * @param [params.offset]
-     * @param [params.limit]
-     * @param [params.cond]
-     * @param [params.sort]
-     * @see {@link https://ampache.org/api/api-json-methods#followers}
-     */
-    followers(params: {
-        username: string;
-    } & ExtendedPagination): Promise<{
-        user: UserSummary[];
-    }>;
-    /**
-     * Get a list of people that this user follows
-     * @remarks MINIMUM_API_VERSION=380001
-     * @see {@link https://ampache.org/api/api-json-methods#following}
-     */
-    following(params: {
-        username: string;
-    }): Promise<{
-        user: UserSummary[];
-    }>;
-    /**
-     * This will follow/unfollow a user
-     * @param params.username Username string to find
-     * @see {@link https://ampache.org/api/api-json-methods#toggle_follow}
-     */
-    toggleFollow(params: {
-        username: string;
-    }): Promise<Success>;
-    /**
-     * This get a user timeline
-     * @remarks MINIMUM_API_VERSION=380001
-     * @param params.username Username to find
-     * @param [params.limit] Max results to return
-     * @param [params.since] UNIXTIME
-     * @see {@link https://ampache.org/api/api-json-methods#timeline}
-     */
-    timeline(params: {
-        username: string;
-        limit?: number;
-        since?: number;
-    }): Promise<{
-        activity: ActivityResponse[];
-    }>;
-    /**
-     * This get current user friends timeline
-     * @remarks MINIMUM_API_VERSION=380001
-     * @param [params.limit] Max results to return
-     * @param [params.since] UNIXTIME
-     * @see {@link https://ampache.org/api/api-json-methods#friends_timeline}
-     */
-    friendsTimeline(params?: {
-        limit?: number;
-        since?: number;
-    }): Promise<{
-        activity: ActivityResponse[];
-    }>;
-}

package/dist/users/types.d.ts

@@ -1,34 +0,0 @@
-import { UID } from "../base";
-export type UserSummary = {
-    id: UID;
-    username: string;
-};
-export type UserResponse = {
-    id: UID;
-    username: string;
-    auth: string;
-    email: string;
-    access: number;
-    streamtoken: string | null;
-    fullname_public: number;
-    validation: string | null;
-    disabled: boolean;
-    create_date: number;
-    last_seen: number;
-    website: string | null;
-    state: string | null;
-    city: string | null;
-};
-export type UsersResponse = {
-    total_count: number;
-    md5: string;
-    user: UserResponse[];
-};
-export type ActivityResponse = {
-    id: UID;
-    date: number;
-    object_type: string;
-    object_id: UID;
-    action: string;
-    user: UserSummary;
-};

package/dist/utils.d.ts

@@ -1,4 +0,0 @@
-import { Base } from "./base";
-export declare function applyMixins(derivedCtor: any, baseCtors: any[]): void;
-export declare function encryptPassword(password: string, time: number): string;
-export declare function outputDebugURL(url: string, config: Base): void;

package/dist/videos/index.d.ts

@@ -1,33 +0,0 @@
-import { VideoResponse, VideosResponse, DeletedVideosResponse } from "./types";
-import { Base, BinaryBoolean, Pagination, UID } from "../base";
-export declare 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): Promise<VideosResponse>;
-    /**
-     * 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;
-    }): 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<DeletedVideosResponse>;
-}

package/dist/videos/types.d.ts

@@ -1,38 +0,0 @@
-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[];
-};

package/src/albums/index.ts

@@ -1,88 +0,0 @@
-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.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#artist_albums}
-   */
-  artistAlbums(
-    params: {
-      filter: UID;
-      album_artist?: BinaryBoolean;
-    } & 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,40 +0,0 @@
-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;
-  artists: ArtistSummary[];
-  songartists: 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 +0,0 @@
-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,38 +0,0 @@
-import { AlbumResponse } from "../albums/types";
-import { SongsResponse } 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: SongsResponse[];
-  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[];
-};

package/src/auth/index.ts

@@ -1,118 +0,0 @@
-import JsSHA from "jssha/dist/sha256";
-import qs from "querystringify";
-import fetch from "isomorphic-unfetch";
-import { Base, Success } from "../base";
-import { AuthResponse } from "./types";
-import { outputDebugURL } from "../utils";
-
-export class Auth extends Base {
-  /**
-   * Handles verifying a new handshake
-   * @remarks MINIMUM_API_VERSION=380001
-   * @param params.auth encrypted apikey OR password if using password auth
-   * @param [params.user] username
-   * @param [params.timestamp] UNIXTIME()
-   * @param [params.version] version of Ampache API to establish connection with
-   * @see {@link https://ampache.org/api/api-json-methods#handshake}
-   */
-  handshake(params: {
-    auth: string;
-    user?: string;
-    timestamp?: number;
-    version?: string;
-  }) {
-    let token = params.auth;
-
-    // generate a timestamp if one wasn't provided
-    if (!params.timestamp) {
-      params.timestamp = Math.floor(new Date().getTime() / 1000);
-    }
-
-    // override the fallback API version with specified
-    if (params.version) {
-      this.version = params.version;
-    }
-
-    // drop timestamp if no user provided (i.e. logging in with API key)
-    if (!params.user) {
-      delete params.timestamp;
-    }
-
-    // not needed if using Bearer token
-    if (this.useBearerToken) {
-      delete params.auth;
-    }
-
-    let query = this.url + "/server/json.server.php?action=handshake";
-    query += qs.stringify(params, "&");
-
-    if (this.debug) {
-      outputDebugURL(query, this);
-    }
-
-    return fetch(query, {
-      method: "GET",
-      headers: this.useBearerToken ? { Authorization: "Bearer " + token } : {},
-    })
-      .then((response) => response.json())
-      .then((data) => {
-        if (data.auth) {
-          this.sessionKey = data.auth;
-        }
-        return <AuthResponse>data;
-      });
-  }
-
-  /**
-   * This can be called without being authenticated, it is useful for determining if what the status
-   * of the server is, and what version it is running/compatible with
-   * @remarks MINIMUM_API_VERSION=380001
-   * @param [params.auth] (Session ID) returns version information and extends the session if passed
-   * @param [params.version] API Version that the application understands
-   * @see {@link https://ampache.org/api/api-json-methods#ping}
-   */
-  ping(params?: { auth?: string; version?: string }) {
-    let query = "ping";
-    query += qs.stringify(params, "&");
-    return this.request<AuthResponse>(query);
-  }
-
-  /**
-   * Destroy a session using the session auth parameter
-   * @remarks MINIMUM_API_VERSION=400001
-   * @param params.auth Session ID to destroy
-   * @see {@link https://ampache.org/api/api-json-methods#goodbye}
-   */
-  goodbye(params: { auth: string }) {
-    let query = "goodbye";
-    query += qs.stringify(params, "&");
-    return this.request<Success>(query);
-  }
-
-  /**
-   * Email a new password to the user (if allowed) using a reset token.
-   * @remarks MINIMUM_API_VERSION=6.1.0
-   * @param params.auth Password reset token
-   * @see {@link https://ampache.org/api/api-json-methods#lost_password}
-   */
-  lostPassword(params: { auth: string }) {
-    let query = "lost_password";
-    query += qs.stringify(params, "&");
-    return this.request<Success>(query);
-  }
-
-  /**
-   * Encrypt your password into the accepted format.
-   */
-  encryptPassword(params: { password: string; time: number }) {
-    let key = getSHA256(params.password);
-    return getSHA256(params.time + key);
-
-    function getSHA256(text) {
-      let shaObj = new JsSHA("SHA-256", "TEXT", { encoding: "UTF8" });
-      shaObj.update(text);
-
-      return shaObj.getHash("HEX");
-    }
-  }
-}