javascript-ampache 1.2.0 → 2.0.0

package/src/podcasts/types.ts

@@ -1,85 +0,0 @@
-import { UID } from "../base";
-
-export type PodcastResponse = {
-  id: UID;
-  name: string;
-  description: string;
-  language: string;
-  copyright: string;
-  feed_url: string;
-  generator: string;
-  website: string;
-  build_date: string;
-  sync_date: string;
-  public_url: string;
-  art: string;
-  has_art: boolean;
-  flag: boolean;
-  rating: number | null;
-  averaterating: number | null;
-  podcast_episode: PodcastEpisodeResponse[];
-};
-
-export type PodcastsResponse = {
-  total_count: number;
-  md5: string;
-  podcast: PodcastResponse[];
-};
-
-export type PodcastEpisodeResponse = {
-  id: UID;
-  title: string;
-  name: string;
-  description: string;
-  category: string;
-  author: string;
-  author_full: string;
-  website: string;
-  pubdate: string;
-  state: "completed" | "pending";
-  filelength: string;
-  filesize: string;
-  filename: string;
-  mime: string;
-  time: number;
-  size: number;
-  bitrate: number;
-  stream_bitrate: number;
-  rate: number;
-  mode: number | null;
-  channels: number | null;
-  public_url: string;
-  url: string;
-  catalog: UID;
-  art: string;
-  has_art: boolean;
-  flag: boolean;
-  rating: number | null;
-  averagerating: number | null;
-  playcount: number;
-  played: number;
-};
-
-export type PodcastEpisodesResponse = {
-  total_count: number;
-  md5: string;
-  podcast_episode: PodcastEpisodeResponse[];
-};
-
-export type DeletedPodcastEpisodeResponse = {
-  id: UID;
-  addition_time: number;
-  delete_time: number;
-  title: string;
-  file: string;
-  catalog: UID;
-  total_count: number;
-  total_skip: number;
-  podcast: UID;
-};
-
-export type DeletedPodcastEpisodesResponse = {
-  total_count: number;
-  md5: string;
-  deleted_podcast_episode: DeletedPodcastEpisodeResponse[];
-};

package/src/preferences/index.ts

@@ -1,114 +0,0 @@
-import qs from "querystringify";
-import { Base, BinaryBoolean, Success } from "../base";
-import { PreferenceResponse, PreferencesResponse } from "./types";
-
-export class Preferences extends Base {
-  /**
-   * Get your server preferences
-   * ACCESS REQUIRED: 100 (Admin)
-   * @remarks MINIMUM_API_VERSION=5.0.0
-   * @see {@link https://ampache.org/api/api-json-methods#system_preferences}
-   */
-  systemPreferences() {
-    let query = "system_preferences";
-    return this.request<PreferencesResponse>(query);
-  }
-
-  /**
-   * Get your system preference by name
-   * ACCESS REQUIRED: 100 (Admin)
-   * @remarks MINIMUM_API_VERSION=5.0.0
-   * @param params.systemPreference Preference name e.g ('notify_email', 'ajax_load')
-   * @see {@link https://ampache.org/api/api-json-methods#system_preference}
-   */
-  systemPreference(params: { filter: string }) {
-    let query = "system_preference";
-    query += qs.stringify(params, "&");
-    return this.request<PreferenceResponse>(query);
-  }
-
-  /**
-   * Get your user preferences
-   * @remarks MINIMUM_API_VERSION=5.0.0
-   * @see {@link https://ampache.org/api/api-json-methods#user_preferences}
-   */
-  userPreferences() {
-    let query = "user_preferences";
-    return this.request<PreferencesResponse>(query);
-  }
-
-  /**
-   * Get your user preference by name
-   * @remarks MINIMUM_API_VERSION=5.0.0
-   * @param params.filter Preference name e.g ('notify_email', 'ajax_load')
-   * @see {@link https://ampache.org/api/api-json-methods#user_preference}
-   */
-  userPreference(params: { filter: string }) {
-    let query = "user_preference";
-    query += qs.stringify(params, "&");
-    return this.request<PreferenceResponse>(query);
-  }
-
-  /**
-   * Add a new preference to your server
-   * ACCESS REQUIRED: 100 (Admin)
-   * @param params.filter Preference name e.g ('notify_email', 'ajax_load')
-   * @param params.type boolean, integer, string, special
-   * @param params.default string or integer default value
-   * @param params.category Category type
-   * @param [params.description]
-   * @param [params.subcategory]
-   * @param [params.level] access level required to change the value (default 100)
-   * @see {@link https://ampache.org/api/api-json-methods#preference_create}
-   */
-  preferenceCreate(params: {
-    filter: string;
-    type: "boolean" | "integer" | "string" | "special";
-    default: string | number;
-    category:
-      | "interface"
-      | "internal"
-      | "options"
-      | "playlist"
-      | "plugins"
-      | "streaming";
-    description?: string;
-    subcategory?: string;
-    level?: number;
-  }) {
-    let query = "preference_create";
-    query += qs.stringify(params, "&");
-    return this.request<Success>(query);
-  }
-
-  /**
-   * Edit a preference value and apply to all users if allowed
-   * ACCESS REQUIRED: 100 (Admin)
-   * @remarks MINIMUM_API_VERSION=5.0.0
-   * @param params.filter Preference name e.g ('notify_email', 'ajax_load')
-   * @param params.value (string/integer) Preference value
-   * @param [params.all] 0, 1 apply to all users
-   * @see {@link https://ampache.org/api/api-json-methods#preference_edit}
-   */
-  preferenceEdit(params: {
-    filter: string;
-    value: string | number;
-    all?: BinaryBoolean;
-  }) {
-    let query = "preference_edit";
-    query += qs.stringify(params, "&");
-    return this.request<Success>(query);
-  }
-
-  /**
-   * Delete a non-system preference by name
-   * ACCESS REQUIRED: 100 (Admin)
-   * @param params.filter Preference name e.g ('notify_email', 'ajax_load')
-   * @see {@link https://ampache.org/api/api-json-methods#preference_delete}
-   */
-  preferenceDelete(params: { filter: string }) {
-    let query = "preference_delete";
-    query += qs.stringify(params, "&");
-    return this.request<Success>(query);
-  }
-}

package/src/preferences/types.ts

@@ -1,20 +0,0 @@
-import { UID } from "../base";
-
-export type PreferenceResponse = {
-  id: UID;
-  name: string;
-  level: string;
-  description: string;
-  value: string;
-  type: string;
-  category: string;
-  subcategory: string | null;
-  has_access: boolean;
-  values?: string; // TODO verify type
-};
-
-export type PreferencesResponse = {
-  total_count: number;
-  md5: string;
-  preference: PreferenceResponse[];
-};

package/src/shares/index.ts

@@ -1,100 +0,0 @@
-import qs from "querystringify";
-import { ShareResponse, SharesResponse } from "./types";
-import { Base, BinaryBoolean, ExtendedPagination, Success, UID } from "../base";
-
-export class Shares extends Base {
-  /**
-   * This searches the shares and returns... shares
-   * @remarks MINIMUM_API_VERSION=420000
-   * @param [params.filter] UID to find
-   * @param [params.exact] 0, 1 boolean to match the exact filter string
-   * @param [params.offset]
-   * @param [params.limit]
-   * @param [params.cond]
-   * @param [params.sort]
-   * @see {@link https://ampache.org/api/api-json-methods#shares}
-   */
-  shares(
-    params?: {
-      filter?: string;
-      exact?: BinaryBoolean;
-    } & ExtendedPagination,
-  ) {
-    let query = "shares";
-    query += qs.stringify(params, "&");
-    return this.request<SharesResponse>(query);
-  }
-
-  /**
-   * Return a share from UID
-   * @remarks MINIMUM_API_VERSION=420000
-   * @param params.filter UID to find
-   * @see {@link https://ampache.org/api/api-json-methods#share}
-   */
-  share(params: { filter: UID }) {
-    let query = "share";
-    query += qs.stringify(params, "&");
-    return this.request<ShareResponse>(query);
-  }
-
-  /**
-   * Create a public url that can be used by anyone to stream media.
-   * @remarks MINIMUM_API_VERSION=420000
-   * @param params.filter UID of object you are sharing
-   * @param params.type ('song', 'album', 'artist', 'playlist', 'podcast', 'podcast_episode', 'video')
-   * @param [params.description] description (will be filled for you if empty)
-   * @param [params.expires] days to keep active
-   * @see {@link https://ampache.org/api/api-json-methods#share_create}
-   */
-  shareCreate(params: {
-    filter: UID;
-    type:
-      | "song"
-      | "album"
-      | "artist"
-      | "playlist"
-      | "podcast"
-      | "podcast_episode"
-      | "video";
-    description?: string;
-    expires?: number;
-  }) {
-    let query = "share_create";
-    query += qs.stringify(params, "&");
-    return this.request<ShareResponse>(query);
-  }
-
-  /**
-   * Update the description and/or expiration date for an existing share
-   * @remarks MINIMUM_API_VERSION=420000
-   * @param params.filter UID to find
-   * @param [params.stream] 0, 1
-   * @param [params.download] 0, 1
-   * @param [params.expires] days to keep active
-   * @param [params.description] description
-   * @see {@link https://ampache.org/api/api-json-methods#share_edit}
-   */
-  shareEdit(params: {
-    filter: UID;
-    stream?: BinaryBoolean;
-    download?: BinaryBoolean;
-    expires?: number;
-    description?: string;
-  }) {
-    let query = "share_edit";
-    query += qs.stringify(params, "&");
-    return this.request<Success>(query);
-  }
-
-  /**
-   * Delete an existing share.
-   * @remarks MINIMUM_API_VERSION=420000
-   * @param params.filter UID of share to delete
-   * @see {@link https://ampache.org/api/api-json-methods#share_delete}
-   */
-  shareDelete(params: { filter: UID }) {
-    let query = "share_delete";
-    query += qs.stringify(params, "&");
-    return this.request<Success>(query);
-  }
-}

package/src/shares/types.ts

@@ -1,25 +0,0 @@
-import { UID } from "../base";
-
-export type ShareResponse = {
-  id: UID;
-  name: string;
-  owner: string;
-  allow_stream: boolean;
-  allow_download: boolean;
-  creation_date: number;
-  lastvisit_date: number;
-  object_type: string;
-  object_id: UID;
-  expire_days: number;
-  max_counter: number;
-  counter: number;
-  secret: string;
-  public_url: string;
-  description: string;
-};
-
-export type SharesResponse = {
-  total_count: number;
-  md5: string;
-  share: ShareResponse[];
-};

package/src/shouts/index.ts

@@ -1,18 +0,0 @@
-import qs from "querystringify";
-import { ShoutResponse } from "./types";
-import { Base } from "../base";
-
-export class Shouts extends Base {
-  /**
-   * This gets the latest posted shouts
-   * @remarks MINIMUM_API_VERSION=380001
-   * @param [params.username] Username to find
-   * @param [params.limit] Maximum number of results to return
-   * @see {@link https://ampache.org/api/api-json-methods#last_shouts}
-   */
-  last_shouts(params?: { username?: string; limit?: number }) {
-    let query = "last_shouts";
-    query += qs.stringify(params, "&");
-    return this.request<{ shout: ShoutResponse[] }>(query);
-  }
-}

package/src/shouts/types.ts

@@ -1,11 +0,0 @@
-import { UID } from "../base";
-import { UserSummary } from "../users/types";
-
-export type ShoutResponse = {
-  id: UID;
-  date: number;
-  text: string;
-  user: UserSummary;
-  object_type: "song" | "album" | "artist" | "playlist";
-  object_id: UID;
-};

package/src/songs/index.ts

@@ -1,221 +0,0 @@
-import qs from "querystringify";
-import { SongResponse, SongsResponse, DeletedSongsResponse } from "./types";
-import {
-  Base,
-  BinaryBoolean,
-  ExtendedPagination,
-  Pagination,
-  Success,
-  UID,
-} from "../base";
-
-export class Songs extends Base {
-  /**
-   * Returns songs based on the specified filter
-   * @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.offset]
-   * @param [params.limit]
-   * @param [params.cond]
-   * @param [params.sort]
-   * @see {@link https://ampache.org/api/api-json-methods#songs}
-   */
-  songs(
-    params?: {
-      filter?: string;
-      exact?: BinaryBoolean;
-      add?: Date;
-      update?: Date;
-    } & ExtendedPagination,
-  ) {
-    let query = "songs";
-    query += qs.stringify(params, "&");
-    return this.request<SongsResponse>(query);
-  }
-
-  /**
-   * Returns a single song
-   * @remarks MINIMUM_API_VERSION=380001
-   * @param params.filter UID to find
-   * @see {@link https://ampache.org/api/api-json-methods#song}
-   */
-  song(params: { filter: UID }) {
-    let query = "song";
-    query += qs.stringify(params, "&");
-    return this.request<SongResponse>(query);
-  }
-
-  /**
-   * Songs of the specified artist
-   * @remarks MINIMUM_API_VERSION=380001
-   * @param params.filter UID to find
-   * @param [params.top50] 0, 1 (if true filter to the artist top 50)
-   * @param [params.offset]
-   * @param [params.limit]
-   * @param [params.cond]
-   * @param [params.sort]
-   * @see {@link https://ampache.org/api/api-json-methods#artist_songs}
-   */
-  artistSongs(
-    params: {
-      filter: UID;
-      top50?: BinaryBoolean;
-    } & ExtendedPagination,
-  ) {
-    let query = "artist_songs";
-    query += qs.stringify(params, "&");
-    return this.request<SongsResponse>(query);
-  }
-
-  /**
-   * Songs of the specified album
-   * @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#album_songs}
-   */
-  albumSongs(
-    params: {
-      filter: UID;
-    } & ExtendedPagination,
-  ) {
-    let query = "album_songs";
-    query += qs.stringify(params, "&");
-    return this.request<SongsResponse>(query);
-  }
-
-  /**
-   * Songs of the specified genre
-   * @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_songs}
-   */
-  genreSongs(
-    params: {
-      filter: UID;
-    } & ExtendedPagination,
-  ) {
-    let query = "genre_songs";
-    query += qs.stringify(params, "&");
-    return this.request<SongsResponse>(query);
-  }
-
-  /**
-   * This returns the songs for a playlist
-   * @remarks MINIMUM_API_VERSION=380001
-   * @param params.filter UID to find
-   * @param [params.random] 0, 1 (if true get random songs using limit)
-   * @param [params.offset]
-   * @param [params.limit]
-   * @see {@link https://ampache.org/api/api-json-methods#playlist_songs}
-   */
-  playlistSongs(
-    params: {
-      filter: UID;
-      random?: BinaryBoolean;
-    } & Pagination,
-  ) {
-    let query = "playlist_songs";
-    query += qs.stringify(params, "&");
-    return this.request<SongsResponse>(query);
-  }
-
-  /**
-   * This returns the songs for a license
-   * @remarks MINIMUM_API_VERSION=420000
-   * @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#license_songs}
-   */
-  licenseSongs(
-    params: {
-      filter: UID;
-    } & ExtendedPagination,
-  ) {
-    let query = "license_songs";
-    query += qs.stringify(params, "&");
-    return this.request<SongsResponse>(query);
-  }
-
-  /**
-   * Delete an existing song. (if you are allowed to)
-   * @remarks MINIMUM_API_VERSION=5.0.0
-   * @param params.filter UID of song to delete
-   * @see {@link https://ampache.org/api/api-json-methods#song_delete}
-   */
-  songDelete(params: { filter: UID }) {
-    let query = "song_delete";
-    query += qs.stringify(params, "&");
-    return this.request<Success>(query);
-  }
-
-  /**
-   * Get the full song file tags using VaInfo
-   * This is used to get tags for remote catalogs to allow maximum data to be returned
-   * @remarks MINIMUM_API_VERSION=6.7.0
-   * @param params.filter UID of song to fetch
-   * @see {@link https://ampache.org/api/api-json-methods#song_tags}
-   */
-  songTags(params: { filter: UID }) {
-    let query = "song_tags";
-    query += qs.stringify(params, "&");
-    return this.request(query); // TODO response type
-  }
-
-  /**
-   * This takes a URL and returns the song object in question
-   * @remarks MINIMUM_API_VERSION=380001
-   * @param params.url Full Ampache URL from server
-   * @see {@link https://ampache.org/api/api-json-methods#url_to_song}
-   */
-  urlToSong(params: { url: string }) {
-    let query = "url_to_song";
-    params.url = encodeURIComponent(params.url);
-    query += qs.stringify(params, "&");
-    return this.request<SongResponse>(query);
-  }
-
-  /**
-   * This searches the songs and returns... songs
-   * @remarks MINIMUM_API_VERSION=380001
-   * @param params.filter Filter results to match this string
-   * @param [params.offset]
-   * @param [params.limit]
-   * @see {@link https://ampache.org/api/api-json-methods#search_songs}
-   */
-  searchSongs(
-    params: {
-      filter: string;
-    } & Pagination,
-  ) {
-    let query = "search_songs";
-    query += qs.stringify(params, "&");
-    return this.request<SongsResponse>(query);
-  }
-
-  /**
-   * Returns songs that have been deleted from the server
-   * @remarks MINIMUM_API_VERSION=500000
-   * @param [params.offset]
-   * @param [params.limit]
-   * @see {@link https://ampache.org/api/api-json-methods#deleted_songs}
-   */
-  deletedSongs(params?: {} & Pagination) {
-    let query = "deleted_songs";
-    query += qs.stringify(params, "&");
-    return this.request<DeletedSongsResponse>(query);
-  }
-}

package/src/songs/types.ts

@@ -1,77 +0,0 @@
-import { ArtistSummary } from "../artists/types";
-import { GenreSummary } from "../genres/types";
-import { UID } from "../base";
-import { AlbumSummary } from "../albums/types";
-
-export type SongResponse = {
-  id: UID;
-  title: string;
-  name: string;
-  artist: ArtistSummary;
-  album: AlbumSummary;
-  albumartist: ArtistSummary;
-  disk: number;
-  track: number;
-  filename: string;
-  genre: GenreSummary[];
-  playlisttrack: number;
-  time: number;
-  year: number | string;
-  format: string;
-  stream_format: string;
-  rate: number;
-  mode: string;
-  mime: string;
-  stream_mime: string;
-  url: string;
-  size: number;
-  mbid: string | null;
-  album_mbid: string | null;
-  artist_mbid: string | null;
-  art: string;
-  has_art: boolean;
-  flag: boolean;
-  rating: number | null;
-  averagerating: number | null;
-  playcount: number;
-  catalog: number;
-  composer: string;
-  channels: number | null;
-  comment: string;
-  license: string | null;
-  publisher: string;
-  language: string;
-  lyrics: string;
-  replaygain_album_gain: number | null;
-  replaygain_album_peak: number | null;
-  replaygain_track_gain: number | null;
-  replaygain_track_peak: number | null;
-  r128_album_gain: number | null;
-  r128_track_gain: number | null;
-};
-
-export type SongsResponse = {
-  total_count: number;
-  md5: string;
-  song: SongResponse[];
-};
-
-export type DeletedSongResponse = {
-  id: UID;
-  addition_time: number;
-  delete_time: number;
-  update_time: number;
-  title: string;
-  file: string;
-  catalog: UID;
-  total_count: number;
-  total_skip: number;
-  album: UID;
-  artist: UID;
-};
-
-export type DeletedSongsResponse = {
-  total_count: number;
-  md5: string;
-  deleted_song: DeletedSongResponse[];
-};