javascript-ampache 1.0.8 → 1.1.0

package/src/preferences/index.ts

@@ -1,116 +1,114 @@
-import qs from 'querystringify';
-import { Base, BinaryBoolean, Success } from '../base';
-import { Preference } 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}
-     */
-    async systemPreferences () {
-        let query = 'system_preferences';
-        let data = await this.request<{preference: Preference[]}>(query);
-        return (data.preference) ? data.preference : data;
-    }
-
-    /**
-     * 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}
-     */
-    async systemPreference (params: {
-        filter: string,
-    }) {
-        let query = 'system_preference';
-        query += qs.stringify(params, '&');
-        return await this.request<{ preference: Preference }>(query);
-    }
-
-    /**
-     * Get your user preferences
-     * @remarks MINIMUM_API_VERSION=5.0.0
-     * @see {@link https://ampache.org/api/api-json-methods#user_preferences}
-     */
-    async userPreferences () {
-        let query = 'user_preferences';
-        let data = await this.request<{preference: Preference[]}>(query);
-        return (data.preference) ? data.preference : data;
-    }
-
-    /**
-     * 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}
-     */
-    async userPreference (params: {
-        filter: string,
-    }) {
-        let query = 'user_preference';
-        query += qs.stringify(params, '&');
-        return await this.request<{ preference: Preference }>(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);
-    }
-}
+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,12 +1,18 @@
-import { UID } from "../base";
-
-export type Preference = {
-    id: UID,
-    name: string,
-    level: string,
-    description: string,
-    value: string,
-    type: string,
-    category: string,
-    subcategory: string | null
-}
+import { UID } from "../base";
+
+export type PreferenceResponse = {
+  id: UID;
+  name: string;
+  level: string;
+  description: string;
+  value: string;
+  type: string;
+  category: string;
+  subcategory: string | null;
+};
+
+export type PreferencesResponse = {
+  total_count: number;
+  md5: string;
+  preference: PreferenceResponse[];
+};

package/src/shares/index.ts

@@ -1,96 +1,100 @@
-import qs from 'querystringify';
-import { Share } 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}
-     */
-    async shares (params?: {
-        filter?: string,
-        exact?: BinaryBoolean,
-    } & ExtendedPagination) {
-        let query = 'shares';
-        query += qs.stringify(params, '&');
-        let data = await this.request<{share: Share[]}>(query);
-        return (data.share) ? data.share : data;
-    }
-
-    /**
-     * 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<Share>(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')
-     * @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<Share>(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);
-    }
-}
+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,19 +1,25 @@
-import { UID } from "../base";
-
-export type Share = {
-    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,
-}
+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,22 +1,18 @@
-import qs from 'querystringify';
-import { Shout } 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}
-     */
-    async last_shouts (params?: {
-        username?: string,
-        limit?: number
-    }) {
-        let query = 'last_shouts';
-        query += qs.stringify(params, '&');
-        let data = await this.request<{shout: Shout[]}>(query);
-        return (data.shout) ? data.shout : data;
-    }
-}
+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,9 +1,9 @@
-import { UID } from "../base";
-import { UserSummary } from "../users/types";
-
-export type Shout = {
-    id: UID,
-    date: number,
-    text: string,
-    user: UserSummary,
-}
+import { UID } from "../base";
+import { UserSummary } from "../users/types";
+
+export type ShoutResponse = {
+  id: UID;
+  date: number;
+  text: string;
+  user: UserSummary;
+};