1.3.0

- reject with real errors instead strings
- some jsdoc clarification

Author: foxriver76

.gitignore

@@ -1,5 +1,3 @@
-package-lock.json
-
 ### Node template
 # Logs
 logs

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Moritz Heusinger <moritz.heusinger@gmail.com>
+Copyright (c) 2020 Moritz Heusinger <moritz.heusinger@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

README.md

@@ -20,7 +20,11 @@ async function main () {
     const bring = new bringApi({mail: `example@example.com`, password: `secret`});
 
     // login to get your uuid and Bearer token
-    await bring.login();
+    try {
+        await bring.login();
+    } catch (e) {
+        console.error(`Error on Login: ${e.message}`);
+    }   
 
     // get all lists and their listUuid
     const lists = await bring.loadLists();
@@ -33,10 +37,14 @@ async function main () {
 } 
 ```
 
-More important methods are `getItems(listUUID)`, `saveItem(listUuid, itemName, specificaiton)`, 
+More important methods are `getItems(listUUID)`, `getItemsDetails(listUUID)`, `saveItem(listUuid, itemName, specificaiton)`, 
 `moveToRecentList(listUuid, itemName)` and `getAllUsersFromList(listUuid)`.
 
 ## Changelog
+### 1.3.0 (2020-10-05)
+* (mdhom) added getItemsDetails method
+* (foxriver76) now reject with real errors instead of strings
+
 ### 1.2.3 (2019-09-22)
 * (foxriver76) on new call of login overwrite bearer header to allow reauth
 

lib/bring.js

@@ -27,7 +27,7 @@ class Bring {
                     }
                 });
         } catch (e) {
-            throw `Cannot Login: ${e}`;
+            throw new Error(`Cannot Login: ${e.message}`);
         } // endCatch
 
         data = JSON.parse(data);
@@ -39,49 +39,47 @@ class Bring {
         this.headers[`X-BRING-USER-UUID`] = this.uuid;
         this.headers[`Authorization`] = `Bearer ${this.bearerToken}`;
         this.putHeaders = {...this.headers, ...{'Content-Type': `application/x-www-form-urlencoded; charset=UTF-8`}};
-
-        return Promise.resolve();
     } // endLogin
 
     /**
      *   Loads all shopping lists
      *
-     *   @return {json}
+     *   @return {Promise<json>}
      */
     async loadLists() {
         try {
             const data = await request(`${this.url}bringusers/${this.uuid}/lists`, {headers: this.headers});
-            return Promise.resolve(JSON.parse(data));
+            return  JSON.parse(data);
         } catch (e) {
-            return Promise.reject(`Cannot get lists: ${e}`);
+            throw new Error(`Cannot get lists: ${e.message}`);
         } // endCatch
     } // endLoadLists
 
     /**
      *   Get all items from the current selected shopping list
      *
-     *   @return {json}
+     *   @return {Promise<json>}
      */
     async getItems(listUuid) {
         try {
             const data = await request(`${this.url}bringlists/${listUuid}`, {headers: this.headers});
-            return Promise.resolve(JSON.parse(data));
+            return JSON.parse(data);
         } catch (e) {
-            return Promise.reject(`Cannot get items for list ${listUuid}: ${e}`);
+            throw new Error(`Cannot get items for list ${listUuid}: ${e.message}`);
         } // endCatch
     } // endGetItems
 
     /**
      *   Get detailed information about all items from the current selected shopping list
      *
-     *   @return {json}
+     *   @return {Promise<json>}
      */
     async getItemsDetails(listUuid) {
         try {
             const data = await request(`${this.url}bringlists/${listUuid}/details`, {headers: this.headers});
-            return Promise.resolve(JSON.parse(data));
+            return JSON.parse(data);
         } catch (e) {
-            return Promise.reject(`Cannot get detailed items for list ${listUuid}: ${e}`);
+            throw new Error(`Cannot get detailed items for list ${listUuid}: ${e.message}`);
         } // endCatch
     } // endGetItemsDetails
 
@@ -91,17 +89,17 @@ class Bring {
      *   @param {string} itemName The name of the item you want to send to the bring server
      *   @param {string} specification The litte description under the name of the item
      *   @param {string} listUuid The lisUUID you want to receive a list of users from.
-     *   @return should return an empty string and answerHttpStatus should contain 204. If not -> error
+     *   @return {Promise<string>} should return an empty string and answerHttpStatus should contain 204. If not -> error
      */
     async saveItem(listUuid, itemName, specification) {
         try {
             const data = await request.put(`${this.url}bringlists/${listUuid}`, {
                 headers: this.putHeaders,
                 body: `&purchase=${itemName}&recently=&specification=${specification}&remove=&sender=null`
             });
-            return Promise.resolve(data);
+            return data;
         } catch (e) {
-            return Promise.reject(`Cannot save item ${itemName} (${specification}) to ${listUuid}: ${e}`);
+            throw new Error(`Cannot save item ${itemName} (${specification}) to ${listUuid}: ${e.message}`);
         } // endCatch
     } // endSaveItem
 
@@ -110,17 +108,17 @@ class Bring {
      *
      *   @param {string} itemName Name of the item you want to delete from you shopping list
      *   @param {string} listUuid The lisUUID you want to receive a list of users from.
-     *   @return should return an empty string and $answerHttpStatus should contain 204. If not -> error
+     *   @return {Promise<string>} should return an empty string and $answerHttpStatus should contain 204. If not -> error
      */
     async removeItem(listUuid, itemName) {
         try {
             const data = await request.put(`${this.url}bringlists/${listUuid}`, {
                 headers: this.putHeaders,
                 body: `&purchase=&recently=&specification=&remove=${itemName}&sender=null`
             });
-            return Promise.resolve(data);
+            return data;
         } catch (e) {
-            return Promise.reject(`Cannot remove item ${itemName} from ${listUuid}: ${e}`);
+            throw new Error(`Cannot remove item ${itemName} from ${listUuid}: ${e.message}`);
         } // endCatch
     } // endRemoveItem
 
@@ -129,89 +127,88 @@ class Bring {
      *
      *   @param {string} itemName Name of the item you want to delete from you shopping list
      *   @param {string} listUuid The lisUUID you want to receive a list of users from.
-     *   @return should return an empty string and $answerHttpStatus should contain 204. If not -> error
+     *   @return {Promise<string>} should return an empty string and $answerHttpStatus should contain 204. If not -> error
      */
     async moveToRecentList(listUuid, itemName) {
         try {
             const data = await request.put(`${this.url}bringlists/${listUuid}`, {
                 headers: this.putHeaders,
                 body: `&purchase=&recently=${itemName}&specification=&remove=&&sender=null`
             });
-            return Promise.resolve(data);
+            return data;
         } catch (e) {
-            return Promise.reject(`Cannot remove item ${itemName} from ${listUuid}: ${e}`);
+            throw new Error(`Cannot remove item ${itemName} from ${listUuid}: ${e.message}`);
         } // endCatch
     } // endRemoveItem
 
     /**
      *   Get all users from a shopping list
      *
      *   @param {string} listUuid The lisUUID you want to receive a list of users from.
-     *   @return {json}
+     *   @return {Promise<json>}
      */
     async getAllUsersFromList(listUuid) {
         try {
             const data = await request(`${this.url}bringlists/${listUuid}/users`, {headers: this.headers});
-            return Promise.resolve(JSON.parse(data));
+            return JSON.parse(data);
         } catch (e) {
-            return Promise.reject(`Cannot get users from list: ${e}`);
+            throw new Error(`Cannot get users from list: ${e.message}`);
         } // endCatch
     } // endGetAllUsersFromList
 
-
     /**
-     *   @return {json}
+     *   @return {Promise<json>}
      */
     async getUserSettings() {
         try {
             const data = await request(`${this.url}bringusersettings/${this.uuid}`, {headers: this.headers});
-            return Promise.resolve(JSON.parse(data));
+            return JSON.parse(data);
         } catch (e) {
-            return Promise.reject(`Cannot get user settings: ${e}`);
+            throw new Error(`Cannot get user settings: ${e.message}`);
         } // endCatch
     } // endGetUserSettings
 
     /**
      *   Load translation file e. g. via 'de-DE'
      *   @param {string} locale from which country translations will be loaded
-     *   @return {json} translations
+     *   @return {Promise<json>} translations
      */
     async loadTranslations(locale) {
         try {
             const data = await request(`https://web.getbring.com/locale/articles.${locale}.json`);
-            return Promise.resolve(JSON.parse(data));
+            return JSON.parse(data);
         } catch (e) {
-            return Promise.reject(`Cannot get translations: ${e}`);
+            throw new Error(`Cannot get translations: ${e.message}`);
         } // endCatch
     } // endLoadTranslations
 
     /**
      *   Load translation file e. g. via 'de-DE'
      *   @param {string} locale from which country translations will be loaded
-     *   @return {json} catalog
+     *   @return @return {Promise<json>} catalog
      */
     async loadCatalog(locale) {
         try {
             const data = await request(`https://web.getbring.com/locale/catalog.${locale}.json`);
-            return Promise.resolve(JSON.parse(data));
+            return JSON.parse(data);
         } catch (e) {
-            return Promise.reject(`Cannot get catalog: ${e}`);
+            throw new Error(`Cannot get catalog: ${e.message}`);
         } // endCatch
     } // endLoadCatalog
 
     /**
      *   Get pending invitations
-     *   @return {json} pending invitations
+     *   @return {Promise<json>} pending invitations
      */
     async getPendingInvitations() {
         try {
             const data = await request(`${this.url}bringusers/${this.uuid}/invitations?status=pending`, {headers: this.headers});
-            return Promise.resolve(JSON.parse(data));
+            return JSON.parse(data);
         } catch (e) {
-            return Promise.reject(`Cannot get pending invitations: ${e}`);
+            throw new Error(`Cannot get pending invitations: ${e}`);
         } // endCatch
     } // endGetPendingInvitations
 
 } // endClassBring
 
-module.exports = Bring;
+module.exports = Bring;