javascript-ampache 1.0.8 → 1.1.0

package/src/auth/index.ts

@@ -1,103 +1,103 @@
-import JsSHA from "jssha/dist/sha256";
-import qs from 'querystringify';
-import fetch from "isomorphic-unfetch";
-import { Base, Success } from "../base";
-import { AuthResponse } from './types'
-
-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
-    }) {
-        // 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;
-        }
-
-        let query = this.url + "/server/json.server.php?action=handshake";
-        query += qs.stringify(params, '&');
-
-        return fetch(query)
-            .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");
-        }
-    }
-}
+import JsSHA from "jssha/dist/sha256";
+import qs from "querystringify";
+import fetch from "isomorphic-unfetch";
+import { Base, Success } from "../base";
+import { AuthResponse } from "./types";
+
+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;
+  }) {
+    // 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;
+    }
+
+    let query = this.url + "/server/json.server.php?action=handshake";
+    query += qs.stringify(params, "&");
+
+    return fetch(query)
+      .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");
+    }
+  }
+}

package/src/auth/types.ts

@@ -1,25 +1,25 @@
-export type AuthResponse = {
-    add: string,
-    albums: number,
-    api: string,
-    artists: number,
-    auth: string,
-    catalogs: number,
-    compatible: string
-    clean: string,
-    genres: number,
-    labels: number,
-    licenses: number,
-    live_streams: number,
-    playlists: number,
-    podcasts: number,
-    podcast_episodes: number,
-    server: string,
-    session_expire: string,
-    shares: number,
-    songs: number,
-    update: string,
-    user: number,
-    version: string,
-    videos: number,
-}
+export type AuthResponse = {
+  add: string;
+  albums: number;
+  api: string;
+  artists: number;
+  auth: string;
+  catalogs: number;
+  compatible: string;
+  clean: string;
+  genres: number;
+  labels: number;
+  licenses: number;
+  live_streams: number;
+  playlists: number;
+  podcasts: number;
+  podcast_episodes: number;
+  server: string;
+  session_expire: string;
+  shares: number;
+  songs: number;
+  update: string;
+  user: number;
+  version: string;
+  videos: number;
+};

package/src/base.ts

@@ -1,97 +1,134 @@
-import fetch from 'isomorphic-unfetch';
-
-type Config = {
-    url: string,
-    sessionKey?: string,
-    debug?: boolean,
-}
-
-export type Success = {
-    success: string,
-}
-
-/**
- * @param [offset] Return results starting from this index position
- * @param [limit] Maximum number of results to return
- */
-export type Pagination = {
-    offset?: number,
-    limit?: number,
-}
-
-/**
- * @param [offset] Return results starting from this index position
- * @param [limit] Maximum number of results to return
- * @param [cond] Apply additional filters to the browse using ; separated comma string pairs (e.g. 'filter1,value1;filter2,value2')
- * @param [sort] Sort name or comma-separated key pair. (e.g. 'name,order') Default order 'ASC' (e.g. 'name,ASC' == 'name')
- */
-export type ExtendedPagination = Pagination & {
-    cond?: string,
-    sort?: string,
-}
-
-export type BinaryBoolean = 0 | 1;
-
-export type UID = string | number;
-
-export abstract class Base {
-    sessionKey: string;
-    url: string;
-    version: string = '6.3.0';// default to latest version
-    debug: boolean;
-
-    constructor(config: Config) {
-        this.sessionKey = config.sessionKey || null;
-        this.url = config.url;
-        this.debug = config.debug || false;
-    }
-
-    protected request<T> (endpoint: string): Promise<T> {
-        let url = this.url + "/server/json.server.php?action=" + endpoint + "&version=" + this.version;
-
-        if (this.debug) {
-            console.debug(
-                "javascript-ampache query URL %c" + url + "&auth=" + this.sessionKey,
-                "color: black; font-style: italic; background-color: orange;padding: 2px"
-            );
-        }
-
-        return fetch(url, {
-            method: "GET",
-            headers: {
-                'Authorization': 'Bearer ' + this.sessionKey
-            }
-        }).then(r => {
-            if (r.ok) {
-                return r.json();
-            }
-            throw new Error(r.statusText);
-        })
-    }
-
-    protected binary<T> (endpoint: string): Promise<Blob> {
-        let url = this.url + "/server/json.server.php?action=" + endpoint + "&version=" + this.version;
-
-        if (this.debug) {
-            console.debug(
-                "javascript-ampache query URL %c" + url + "&auth=" + this.sessionKey,
-                "color: black; font-style: italic; background-color: orange;padding: 2px"
-            );
-        }
-
-        return fetch(url,{
-            method: "GET",
-            headers: {
-                'Authorization': 'Bearer ' + this.sessionKey
-            }
-        })
-            .then(response => response.blob())
-            .then(r => {
-                return r;
-            })
-    }
-
-    public setSessionKey(sessionKey: string) {
-        this.sessionKey = sessionKey;
-    }
-}
+import fetch from "isomorphic-unfetch";
+import qs from "querystringify";
+
+type Config = {
+  url: string;
+  sessionKey?: string;
+  debug?: boolean;
+};
+
+export type Success = {
+  success: string;
+};
+
+/**
+ * @param [offset] Return results starting from this index position
+ * @param [limit] Maximum number of results to return
+ */
+export type Pagination = {
+  offset?: number;
+  limit?: number;
+};
+
+/**
+ * @param [offset] Return results starting from this index position
+ * @param [limit] Maximum number of results to return
+ * @param [cond] Apply additional filters to the browse using ; separated comma string pairs (e.g. 'filter1,value1;filter2,value2')
+ * @param [sort] Sort name or comma-separated key pair. (e.g. 'name,order') Default order 'ASC' (e.g. 'name,ASC' == 'name')
+ */
+export type ExtendedPagination = Pagination & {
+  cond?: string;
+  sort?: string;
+};
+
+export type BinaryBoolean = 0 | 1;
+
+export type UID = string | number;
+
+export abstract class Base {
+  sessionKey: string;
+  url: string;
+  version: string = "6.3.0"; // default to latest version
+  debug: boolean;
+
+  constructor(config: Config) {
+    this.sessionKey = config.sessionKey || null;
+    this.url = config.url;
+    this.debug = config.debug || false;
+  }
+
+  protected request<T>(endpoint: string): Promise<T> {
+    let url =
+      this.url +
+      "/server/json.server.php?action=" +
+      endpoint +
+      "&version=" +
+      this.version;
+
+    if (this.debug) {
+      console.debug(
+        "javascript-ampache query URL %c" + url + "&auth=" + this.sessionKey,
+        "color: black; font-style: italic; background-color: orange;padding: 2px",
+      );
+    }
+
+    return fetch(url, {
+      method: "GET",
+      headers: {
+        Authorization: "Bearer " + this.sessionKey,
+      },
+    }).then((r) => {
+      if (r.ok) {
+        return r.json();
+      }
+      throw new Error(r.statusText);
+    });
+  }
+
+  protected binary<T>(endpoint: string): Promise<Blob> {
+    let url =
+      this.url +
+      "/server/json.server.php?action=" +
+      endpoint +
+      "&version=" +
+      this.version;
+
+    if (this.debug) {
+      console.debug(
+        "javascript-ampache query URL %c" + url + "&auth=" + this.sessionKey,
+        "color: black; font-style: italic; background-color: orange;padding: 2px",
+      );
+    }
+
+    return fetch(url, {
+      method: "GET",
+      headers: {
+        Authorization: "Bearer " + this.sessionKey,
+      },
+    })
+      .then((response) => response.blob())
+      .then((r) => {
+        return r;
+      });
+  }
+
+  public setSessionKey(sessionKey: string) {
+    this.sessionKey = sessionKey;
+  }
+
+  /**
+   * Construct and return a URL
+   * @param endpoint
+   * @param [params]
+   */
+  public rawURL(endpoint: string, params?: {}) {
+    let query = endpoint;
+    query += qs.stringify(params, "&");
+
+    let url =
+      this.url +
+      "/server/json.server.php?action=" +
+      query +
+      "&version=" +
+      this.version;
+
+    if (this.debug) {
+      console.debug(
+        "javascript-ampache query URL %c" + url + "&auth=" + this.sessionKey,
+        "color: black; font-style: italic; background-color: orange;padding: 2px",
+      );
+    }
+
+    return url;
+  }
+}