@beauraines/rtm-api 1.4.2 → 1.6.0

package/docs/user_lists.js.html

@@ -23,7 +23,7 @@
 <label for="nav-trigger" class="overlay"></label>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="RTMClient.html">RTMClient</a><ul class='methods'><li data-type='method'><a href="RTMClient.html#get">get</a></li><li data-type='method'><a href="RTMClient.html#~auth/getAuthToken">auth/getAuthToken</a></li><li data-type='method'><a href="RTMClient.html#~auth/getAuthUrl">auth/getAuthUrl</a></li><li data-type='method'><a href="RTMClient.html#~auth/verifyAuthToken">auth/verifyAuthToken</a></li><li data-type='method'><a href="RTMClient.html#~user/create">user/create</a></li><li data-type='method'><a href="RTMClient.html#~user/export">user/export</a></li><li data-type='method'><a href="RTMClient.html#~user/exportToString">user/exportToString</a></li><li data-type='method'><a href="RTMClient.html#~user/import">user/import</a></li><li data-type='method'><a href="RTMClient.html#~user/importFromString">user/importFromString</a></li></ul></li><li><a href="RTMError.html">RTMError</a><ul class='methods'><li data-type='method'><a href="RTMError.html#.networkError">networkError</a></li><li data-type='method'><a href="RTMError.html#.rateLimitError">rateLimitError</a></li><li data-type='method'><a href="RTMError.html#.referenceError">referenceError</a></li><li data-type='method'><a href="RTMError.html#.responseError">responseError</a></li><li data-type='method'><a href="RTMError.html#.serverError">serverError</a></li><li data-type='method'><a href="RTMError.html#toString">toString</a></li></ul></li><li><a href="RTMList.html">RTMList</a></li><li><a href="RTMResponse.html">RTMResponse</a><ul class='methods'><li data-type='method'><a href="RTMResponse.html#has">has</a></li><li data-type='method'><a href="RTMResponse.html#toString">toString</a></li></ul></li><li><a href="RTMSuccess.html">RTMSuccess</a><ul class='methods'><li data-type='method'><a href="RTMSuccess.html#toString">toString</a></li></ul></li><li><a href="RTMTask.html">RTMTask</a></li><li><a href="RTMUser.html">RTMUser</a><ul class='methods'><li data-type='method'><a href="RTMUser.html#clearTaskIndexCache">clearTaskIndexCache</a></li><li data-type='method'><a href="RTMUser.html#get">get</a></li><li data-type='method'><a href="RTMUser.html#verifyAuthToken">verifyAuthToken</a></li><li data-type='method'><a href="RTMUser.html#~lists/add">lists/add</a></li><li data-type='method'><a href="RTMUser.html#~lists/archive">lists/archive</a></li><li data-type='method'><a href="RTMUser.html#~lists/get">lists/get</a></li><li data-type='method'><a href="RTMUser.html#~lists/remove">lists/remove</a></li><li data-type='method'><a href="RTMUser.html#~lists/rename">lists/rename</a></li><li data-type='method'><a href="RTMUser.html#~tasks/add">tasks/add</a></li><li data-type='method'><a href="RTMUser.html#~tasks/addNotes">tasks/addNotes</a></li><li data-type='method'><a href="RTMUser.html#~tasks/addTags">tasks/addTags</a></li><li data-type='method'><a href="RTMUser.html#~tasks/complete">tasks/complete</a></li><li data-type='method'><a href="RTMUser.html#~tasks/decreasePriority">tasks/decreasePriority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/get">tasks/get</a></li><li data-type='method'><a href="RTMUser.html#~tasks/getTask">tasks/getTask</a></li><li data-type='method'><a href="RTMUser.html#~tasks/increasePriority">tasks/increasePriority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/move">tasks/move</a></li><li data-type='method'><a href="RTMUser.html#~tasks/postpone">tasks/postpone</a></li><li data-type='method'><a href="RTMUser.html#~tasks/priority">tasks/priority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/remove">tasks/remove</a></li><li data-type='method'><a href="RTMUser.html#~tasks/removeTags">tasks/removeTags</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setDueDate">tasks/setDueDate</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setName">tasks/setName</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setURL">tasks/setURL</a></li><li data-type='method'><a href="RTMUser.html#~tasks/uncomplete">tasks/uncomplete</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#setStartDate">setStartDate</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="RTMClient.html">RTMClient</a><ul class='methods'><li data-type='method'><a href="RTMClient.html#get">get</a></li><li data-type='method'><a href="RTMClient.html#~auth/getAuthToken">auth/getAuthToken</a></li><li data-type='method'><a href="RTMClient.html#~auth/getAuthUrl">auth/getAuthUrl</a></li><li data-type='method'><a href="RTMClient.html#~auth/verifyAuthToken">auth/verifyAuthToken</a></li><li data-type='method'><a href="RTMClient.html#~user/create">user/create</a></li><li data-type='method'><a href="RTMClient.html#~user/export">user/export</a></li><li data-type='method'><a href="RTMClient.html#~user/exportToString">user/exportToString</a></li><li data-type='method'><a href="RTMClient.html#~user/import">user/import</a></li><li data-type='method'><a href="RTMClient.html#~user/importFromString">user/importFromString</a></li></ul></li><li><a href="RTMError.html">RTMError</a><ul class='methods'><li data-type='method'><a href="RTMError.html#.networkError">networkError</a></li><li data-type='method'><a href="RTMError.html#.rateLimitError">rateLimitError</a></li><li data-type='method'><a href="RTMError.html#.referenceError">referenceError</a></li><li data-type='method'><a href="RTMError.html#.responseError">responseError</a></li><li data-type='method'><a href="RTMError.html#.serverError">serverError</a></li><li data-type='method'><a href="RTMError.html#toString">toString</a></li></ul></li><li><a href="RTMList.html">RTMList</a></li><li><a href="RTMResponse.html">RTMResponse</a><ul class='methods'><li data-type='method'><a href="RTMResponse.html#has">has</a></li><li data-type='method'><a href="RTMResponse.html#toString">toString</a></li></ul></li><li><a href="RTMSuccess.html">RTMSuccess</a><ul class='methods'><li data-type='method'><a href="RTMSuccess.html#toString">toString</a></li></ul></li><li><a href="RTMTask.html">RTMTask</a></li><li><a href="RTMUser.html">RTMUser</a><ul class='methods'><li data-type='method'><a href="RTMUser.html#clearTaskIndexCache">clearTaskIndexCache</a></li><li data-type='method'><a href="RTMUser.html#get">get</a></li><li data-type='method'><a href="RTMUser.html#verifyAuthToken">verifyAuthToken</a></li><li data-type='method'><a href="RTMUser.html#~lists/add">lists/add</a></li><li data-type='method'><a href="RTMUser.html#~lists/archive">lists/archive</a></li><li data-type='method'><a href="RTMUser.html#~lists/get">lists/get</a></li><li data-type='method'><a href="RTMUser.html#~lists/remove">lists/remove</a></li><li data-type='method'><a href="RTMUser.html#~lists/rename">lists/rename</a></li><li data-type='method'><a href="RTMUser.html#~tasks/add">tasks/add</a></li><li data-type='method'><a href="RTMUser.html#~tasks/addNotes">tasks/addNotes</a></li><li data-type='method'><a href="RTMUser.html#~tasks/addTags">tasks/addTags</a></li><li data-type='method'><a href="RTMUser.html#~tasks/complete">tasks/complete</a></li><li data-type='method'><a href="RTMUser.html#~tasks/decreasePriority">tasks/decreasePriority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/get">tasks/get</a></li><li data-type='method'><a href="RTMUser.html#~tasks/getTask">tasks/getTask</a></li><li data-type='method'><a href="RTMUser.html#~tasks/getTask">tasks/getTask</a></li><li data-type='method'><a href="RTMUser.html#~tasks/increasePriority">tasks/increasePriority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/move">tasks/move</a></li><li data-type='method'><a href="RTMUser.html#~tasks/postpone">tasks/postpone</a></li><li data-type='method'><a href="RTMUser.html#~tasks/priority">tasks/priority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/remove">tasks/remove</a></li><li data-type='method'><a href="RTMUser.html#~tasks/removeTags">tasks/removeTags</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setDueDate">tasks/setDueDate</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setName">tasks/setName</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setURL">tasks/setURL</a></li><li data-type='method'><a href="RTMUser.html#~tasks/uncomplete">tasks/uncomplete</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#callAPI">callAPI</a></li><li><a href="global.html#formQuery">formQuery</a></li><li><a href="global.html#setStartDate">setStartDate</a></li></ul>
 </nav>
 
 <div id="main">
@@ -199,7 +199,7 @@ module.exports = function(user) {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Mon Sep 05 2022 15:26:15 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/dwaring87/docdash">@dwaring87/docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Sun Mar 12 2023 09:58:16 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/dwaring87/docdash">@dwaring87/docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/user_tasks.js.html

@@ -23,7 +23,7 @@
 <label for="nav-trigger" class="overlay"></label>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="RTMClient.html">RTMClient</a><ul class='methods'><li data-type='method'><a href="RTMClient.html#get">get</a></li><li data-type='method'><a href="RTMClient.html#~auth/getAuthToken">auth/getAuthToken</a></li><li data-type='method'><a href="RTMClient.html#~auth/getAuthUrl">auth/getAuthUrl</a></li><li data-type='method'><a href="RTMClient.html#~auth/verifyAuthToken">auth/verifyAuthToken</a></li><li data-type='method'><a href="RTMClient.html#~user/create">user/create</a></li><li data-type='method'><a href="RTMClient.html#~user/export">user/export</a></li><li data-type='method'><a href="RTMClient.html#~user/exportToString">user/exportToString</a></li><li data-type='method'><a href="RTMClient.html#~user/import">user/import</a></li><li data-type='method'><a href="RTMClient.html#~user/importFromString">user/importFromString</a></li></ul></li><li><a href="RTMError.html">RTMError</a><ul class='methods'><li data-type='method'><a href="RTMError.html#.networkError">networkError</a></li><li data-type='method'><a href="RTMError.html#.rateLimitError">rateLimitError</a></li><li data-type='method'><a href="RTMError.html#.referenceError">referenceError</a></li><li data-type='method'><a href="RTMError.html#.responseError">responseError</a></li><li data-type='method'><a href="RTMError.html#.serverError">serverError</a></li><li data-type='method'><a href="RTMError.html#toString">toString</a></li></ul></li><li><a href="RTMList.html">RTMList</a></li><li><a href="RTMResponse.html">RTMResponse</a><ul class='methods'><li data-type='method'><a href="RTMResponse.html#has">has</a></li><li data-type='method'><a href="RTMResponse.html#toString">toString</a></li></ul></li><li><a href="RTMSuccess.html">RTMSuccess</a><ul class='methods'><li data-type='method'><a href="RTMSuccess.html#toString">toString</a></li></ul></li><li><a href="RTMTask.html">RTMTask</a></li><li><a href="RTMUser.html">RTMUser</a><ul class='methods'><li data-type='method'><a href="RTMUser.html#clearTaskIndexCache">clearTaskIndexCache</a></li><li data-type='method'><a href="RTMUser.html#get">get</a></li><li data-type='method'><a href="RTMUser.html#verifyAuthToken">verifyAuthToken</a></li><li data-type='method'><a href="RTMUser.html#~lists/add">lists/add</a></li><li data-type='method'><a href="RTMUser.html#~lists/archive">lists/archive</a></li><li data-type='method'><a href="RTMUser.html#~lists/get">lists/get</a></li><li data-type='method'><a href="RTMUser.html#~lists/remove">lists/remove</a></li><li data-type='method'><a href="RTMUser.html#~lists/rename">lists/rename</a></li><li data-type='method'><a href="RTMUser.html#~tasks/add">tasks/add</a></li><li data-type='method'><a href="RTMUser.html#~tasks/addNotes">tasks/addNotes</a></li><li data-type='method'><a href="RTMUser.html#~tasks/addTags">tasks/addTags</a></li><li data-type='method'><a href="RTMUser.html#~tasks/complete">tasks/complete</a></li><li data-type='method'><a href="RTMUser.html#~tasks/decreasePriority">tasks/decreasePriority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/get">tasks/get</a></li><li data-type='method'><a href="RTMUser.html#~tasks/getTask">tasks/getTask</a></li><li data-type='method'><a href="RTMUser.html#~tasks/increasePriority">tasks/increasePriority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/move">tasks/move</a></li><li data-type='method'><a href="RTMUser.html#~tasks/postpone">tasks/postpone</a></li><li data-type='method'><a href="RTMUser.html#~tasks/priority">tasks/priority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/remove">tasks/remove</a></li><li data-type='method'><a href="RTMUser.html#~tasks/removeTags">tasks/removeTags</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setDueDate">tasks/setDueDate</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setName">tasks/setName</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setURL">tasks/setURL</a></li><li data-type='method'><a href="RTMUser.html#~tasks/uncomplete">tasks/uncomplete</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#setStartDate">setStartDate</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="RTMClient.html">RTMClient</a><ul class='methods'><li data-type='method'><a href="RTMClient.html#get">get</a></li><li data-type='method'><a href="RTMClient.html#~auth/getAuthToken">auth/getAuthToken</a></li><li data-type='method'><a href="RTMClient.html#~auth/getAuthUrl">auth/getAuthUrl</a></li><li data-type='method'><a href="RTMClient.html#~auth/verifyAuthToken">auth/verifyAuthToken</a></li><li data-type='method'><a href="RTMClient.html#~user/create">user/create</a></li><li data-type='method'><a href="RTMClient.html#~user/export">user/export</a></li><li data-type='method'><a href="RTMClient.html#~user/exportToString">user/exportToString</a></li><li data-type='method'><a href="RTMClient.html#~user/import">user/import</a></li><li data-type='method'><a href="RTMClient.html#~user/importFromString">user/importFromString</a></li></ul></li><li><a href="RTMError.html">RTMError</a><ul class='methods'><li data-type='method'><a href="RTMError.html#.networkError">networkError</a></li><li data-type='method'><a href="RTMError.html#.rateLimitError">rateLimitError</a></li><li data-type='method'><a href="RTMError.html#.referenceError">referenceError</a></li><li data-type='method'><a href="RTMError.html#.responseError">responseError</a></li><li data-type='method'><a href="RTMError.html#.serverError">serverError</a></li><li data-type='method'><a href="RTMError.html#toString">toString</a></li></ul></li><li><a href="RTMList.html">RTMList</a></li><li><a href="RTMResponse.html">RTMResponse</a><ul class='methods'><li data-type='method'><a href="RTMResponse.html#has">has</a></li><li data-type='method'><a href="RTMResponse.html#toString">toString</a></li></ul></li><li><a href="RTMSuccess.html">RTMSuccess</a><ul class='methods'><li data-type='method'><a href="RTMSuccess.html#toString">toString</a></li></ul></li><li><a href="RTMTask.html">RTMTask</a></li><li><a href="RTMUser.html">RTMUser</a><ul class='methods'><li data-type='method'><a href="RTMUser.html#clearTaskIndexCache">clearTaskIndexCache</a></li><li data-type='method'><a href="RTMUser.html#get">get</a></li><li data-type='method'><a href="RTMUser.html#verifyAuthToken">verifyAuthToken</a></li><li data-type='method'><a href="RTMUser.html#~lists/add">lists/add</a></li><li data-type='method'><a href="RTMUser.html#~lists/archive">lists/archive</a></li><li data-type='method'><a href="RTMUser.html#~lists/get">lists/get</a></li><li data-type='method'><a href="RTMUser.html#~lists/remove">lists/remove</a></li><li data-type='method'><a href="RTMUser.html#~lists/rename">lists/rename</a></li><li data-type='method'><a href="RTMUser.html#~tasks/add">tasks/add</a></li><li data-type='method'><a href="RTMUser.html#~tasks/addNotes">tasks/addNotes</a></li><li data-type='method'><a href="RTMUser.html#~tasks/addTags">tasks/addTags</a></li><li data-type='method'><a href="RTMUser.html#~tasks/complete">tasks/complete</a></li><li data-type='method'><a href="RTMUser.html#~tasks/decreasePriority">tasks/decreasePriority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/get">tasks/get</a></li><li data-type='method'><a href="RTMUser.html#~tasks/getTask">tasks/getTask</a></li><li data-type='method'><a href="RTMUser.html#~tasks/getTask">tasks/getTask</a></li><li data-type='method'><a href="RTMUser.html#~tasks/increasePriority">tasks/increasePriority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/move">tasks/move</a></li><li data-type='method'><a href="RTMUser.html#~tasks/postpone">tasks/postpone</a></li><li data-type='method'><a href="RTMUser.html#~tasks/priority">tasks/priority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/remove">tasks/remove</a></li><li data-type='method'><a href="RTMUser.html#~tasks/removeTags">tasks/removeTags</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setDueDate">tasks/setDueDate</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setName">tasks/setName</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setURL">tasks/setURL</a></li><li data-type='method'><a href="RTMUser.html#~tasks/uncomplete">tasks/uncomplete</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#callAPI">callAPI</a></li><li><a href="global.html#formQuery">formQuery</a></li><li><a href="global.html#setStartDate">setStartDate</a></li></ul>
 </nav>
 
 <div id="main">
@@ -44,6 +44,9 @@ const _tasks = require('../task/helper.js');
 const _lists = require('../list/helper.js');
 const taskIds = require('../utils/taskIds.js');
 const errors = require('../response/error.js');
+const { getListId, getTaskId, getTaskSeriesId } = require('../utils/taskIds');
+const { callAPI, buildUrl } = require('../utils/fetch');
+const RTMTask = require('../task/index.js');
 
 /**
  * This module returns the RTM Tasks-related functions for the RTMUser
@@ -65,7 +68,7 @@ module.exports = function(user) {
   rtn.get = function(filter, callback) {
     if ( callback === undefined &amp;&amp; typeof filter === 'function' ) {
       callback = filter;
-      filter = "";
+      filter = '';
     }
 
     // Callback counters
@@ -114,8 +117,8 @@ module.exports = function(user) {
         if ( list === undefined ) {
           list = {
             id: TASKS[i].list_id,
-            name: "List #" + TASKS[i].list_id
-          }
+            name: 'List #' + TASKS[i].list_id
+          };
         }
         TASKS[i]._list = list;
       }
@@ -123,14 +126,75 @@ module.exports = function(user) {
   };
 
   /**
-   * Get the RTMTask specified by its index
+   * Get the an RTM response of lists, task series and tasks in a JSON
+   * @param {int} index Task Index
+   * @param {string} [filter] Tasks Filter (RTM Advanced Search Syntax)
+   * @return {JSON} 
+   */
+  rtn.rtmFetch = async function(filter) {
+    let url = buildUrl(user,filter);
+    let response = await callAPI(url);
+    return await response.rsp.tasks?.list;
+  };
+
+  /**
+   * Get the RTMTask specified by its index. Unlike getTask(), this will only create an RTMTask
+   * for the matching index, which is more performant.
+   * @param {int} index Task Index
+   * @param {string} [filter] Tasks Filter (RTM Advanced Search Syntax)
+   * @function RTMUser~tasks/getTask
+   * @return {RTMTask}
+   */
+  rtn.rtmIndexFetchTask = async function(index,filter) {
+
+    let url = buildUrl(user,filter);
+    let response = await callAPI(url,user);
+    const lists =  response.rsp.tasks?.list;
+
+
+    // index to ids
+    let listId = getListId(user.id,index);
+    let taskSeriesId = getTaskSeriesId(user.id,index);
+    let taskId = getTaskId(user.id,index);
+
+    if (listId == undefined || taskSeriesId == undefined || taskId == undefined) {
+      return {err: {code: -3}}; // Not sure why this is the code
+    }
+    // filter the response for the matching index
+    let taskList = lists.filter(x => x.id == listId)[0].taskseries;
+    let taskSeries = taskList ? taskList.filter(x => x.id == taskSeriesId)[0] : null;
+    taskSeries
+      ? taskSeries.task = taskSeries.task.filter(x => x.id == taskId)[0]
+      : null;
+
+
+    let err;
+    let task;
+    if (!taskSeries ) {
+      err = {code: -3}; // Not sure why this is the code 
+    }  else {
+      task = new RTMTask(user.id,listId,taskSeries,taskSeries.task);
+    }
+    return {err,task};
+  };
+
+  /**
+   * Get the RTMTask specified by its index. While this will return only the matching RTMTask,
+   * this function will create RTMTasks, updating the index for every task returned. This can
+   * contribute to laggy performance. You may be better off using rtmIndexFetchTask()
    * @param {int} index Task Index
+   * @param {string} [filter] Tasks Filter (RTM Advanced Search Syntax)
    * @param {function} callback Callback function(err, task)
    * @param {RTMError} callback.err RTM API Error Response, if encountered
    * @param {RTMTask} callback.task Matching RTM Task
    * @function RTMUser~tasks/getTask
+   * @deprecated use rtmIndexFetchTask instead
    */
-  rtn.getTask = function(index, callback) {
+  rtn.getTask = function(index, filter, callback) {
+    if ( callback === undefined &amp;&amp; typeof filter === 'function' ) {
+      callback = filter;
+      filter = '';
+    }
 
     // Get Task Info
     _getTaskInfo(index, function(err, listId, taskSeriesId, taskId) {
@@ -139,7 +203,7 @@ module.exports = function(user) {
       }
 
       // Get Task From API
-      user.tasks.get(function(err, tasks) {
+      user.tasks.get(filter, function(err, tasks) {
         if ( err ) {
           return callback(err);
         }
@@ -323,7 +387,7 @@ module.exports = function(user) {
    * @function RTMUser~tasks/addNotes
    */
   rtn.addNotes = function(index, title, notes, callback) {
-    var title = (typeof title !== 'undefined') ? title : "";
+    var title = (typeof title !== 'undefined') ? title : '';
 
     // Get the Task
     _getTaskInfo(index, function(err, listId, taskSeriesId, taskId) {
@@ -694,7 +758,7 @@ module.exports = function(user) {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Mon Sep 05 2022 15:26:15 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/dwaring87/docdash">@dwaring87/docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Sun Mar 12 2023 09:58:16 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/dwaring87/docdash">@dwaring87/docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/utils_fetch.js.html

@@ -0,0 +1,128 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>utils/fetch.js - Documentation</title>
+
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+</head>
+<body>
+
+<input type="checkbox" id="nav-trigger" class="nav-trigger" />
+<label for="nav-trigger" class="navicon-button x">
+  <div class="navicon"></div>
+</label>
+
+<label for="nav-trigger" class="overlay"></label>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="RTMClient.html">RTMClient</a><ul class='methods'><li data-type='method'><a href="RTMClient.html#get">get</a></li><li data-type='method'><a href="RTMClient.html#~auth/getAuthToken">auth/getAuthToken</a></li><li data-type='method'><a href="RTMClient.html#~auth/getAuthUrl">auth/getAuthUrl</a></li><li data-type='method'><a href="RTMClient.html#~auth/verifyAuthToken">auth/verifyAuthToken</a></li><li data-type='method'><a href="RTMClient.html#~user/create">user/create</a></li><li data-type='method'><a href="RTMClient.html#~user/export">user/export</a></li><li data-type='method'><a href="RTMClient.html#~user/exportToString">user/exportToString</a></li><li data-type='method'><a href="RTMClient.html#~user/import">user/import</a></li><li data-type='method'><a href="RTMClient.html#~user/importFromString">user/importFromString</a></li></ul></li><li><a href="RTMError.html">RTMError</a><ul class='methods'><li data-type='method'><a href="RTMError.html#.networkError">networkError</a></li><li data-type='method'><a href="RTMError.html#.rateLimitError">rateLimitError</a></li><li data-type='method'><a href="RTMError.html#.referenceError">referenceError</a></li><li data-type='method'><a href="RTMError.html#.responseError">responseError</a></li><li data-type='method'><a href="RTMError.html#.serverError">serverError</a></li><li data-type='method'><a href="RTMError.html#toString">toString</a></li></ul></li><li><a href="RTMList.html">RTMList</a></li><li><a href="RTMResponse.html">RTMResponse</a><ul class='methods'><li data-type='method'><a href="RTMResponse.html#has">has</a></li><li data-type='method'><a href="RTMResponse.html#toString">toString</a></li></ul></li><li><a href="RTMSuccess.html">RTMSuccess</a><ul class='methods'><li data-type='method'><a href="RTMSuccess.html#toString">toString</a></li></ul></li><li><a href="RTMTask.html">RTMTask</a></li><li><a href="RTMUser.html">RTMUser</a><ul class='methods'><li data-type='method'><a href="RTMUser.html#clearTaskIndexCache">clearTaskIndexCache</a></li><li data-type='method'><a href="RTMUser.html#get">get</a></li><li data-type='method'><a href="RTMUser.html#verifyAuthToken">verifyAuthToken</a></li><li data-type='method'><a href="RTMUser.html#~lists/add">lists/add</a></li><li data-type='method'><a href="RTMUser.html#~lists/archive">lists/archive</a></li><li data-type='method'><a href="RTMUser.html#~lists/get">lists/get</a></li><li data-type='method'><a href="RTMUser.html#~lists/remove">lists/remove</a></li><li data-type='method'><a href="RTMUser.html#~lists/rename">lists/rename</a></li><li data-type='method'><a href="RTMUser.html#~tasks/add">tasks/add</a></li><li data-type='method'><a href="RTMUser.html#~tasks/addNotes">tasks/addNotes</a></li><li data-type='method'><a href="RTMUser.html#~tasks/addTags">tasks/addTags</a></li><li data-type='method'><a href="RTMUser.html#~tasks/complete">tasks/complete</a></li><li data-type='method'><a href="RTMUser.html#~tasks/decreasePriority">tasks/decreasePriority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/get">tasks/get</a></li><li data-type='method'><a href="RTMUser.html#~tasks/getTask">tasks/getTask</a></li><li data-type='method'><a href="RTMUser.html#~tasks/getTask">tasks/getTask</a></li><li data-type='method'><a href="RTMUser.html#~tasks/increasePriority">tasks/increasePriority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/move">tasks/move</a></li><li data-type='method'><a href="RTMUser.html#~tasks/postpone">tasks/postpone</a></li><li data-type='method'><a href="RTMUser.html#~tasks/priority">tasks/priority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/remove">tasks/remove</a></li><li data-type='method'><a href="RTMUser.html#~tasks/removeTags">tasks/removeTags</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setDueDate">tasks/setDueDate</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setName">tasks/setName</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setURL">tasks/setURL</a></li><li data-type='method'><a href="RTMUser.html#~tasks/uncomplete">tasks/uncomplete</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#callAPI">callAPI</a></li><li><a href="global.html#formQuery">formQuery</a></li><li><a href="global.html#setStartDate">setStartDate</a></li></ul>
+</nav>
+
+<div id="main">
+    
+    <h1 class="page-title">utils/fetch.js</h1>
+    
+
+    
+
+
+
+    
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>const fetch = require('node-fetch');
+const sign = require('../utils/sign');
+const debug = require('debug')('rtm-api-fetch');
+
+// API Configuration Properties
+const config = require('../../config');
+const scheme = config.api.scheme;
+const base = config.api.url.base;
+const format = config.api.format;
+const version = config.api.version;
+
+
+function buildUrl(user,filter) {
+  let query = {
+    filter: filter ,
+    auth_token: user._authToken,
+    method: 'rtm.tasks.getList',
+    api_key: user._client._apiKey,
+    v: version,
+    format
+  };
+
+  let apiSig=sign(query,{secret:user._client._apiSecret});
+
+  let url = `${scheme}://${base}?${formQuery(query)}&amp;api_sig=${apiSig}`;
+  return url;
+}
+
+
+
+
+/**
+ * Generate a URI Encoded query string from the parameters set of
+ * key/value pairs
+ * @param {object} params Object containing the key/value parameters
+ * @returns {string} URL Encoded query string
+ */
+function formQuery(params) {
+  let parts = [];
+  for ( let key in params ) {
+    if ( params.hasOwnProperty(key) ) {
+      parts.push(encodeURIComponent(key) + '=' + encodeURIComponent(params[key]));
+    }
+  }
+  return parts.join('&amp;');
+}
+
+/**
+ * 
+ * @param {string} url fully formed url to call
+ * @returns JSON response
+ */
+async function callAPI(url) {
+  try {
+    const response = await fetch(url);
+    if (await response.ok) {
+      const responseJson = await response.json();
+	  debug(JSON.stringify(responseJson));
+	  return responseJson; 
+    } else {
+      // TODO improve this error message
+      console.error('There was an error');
+    }
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+module.exports = {callAPI,formQuery, buildUrl};
+</code></pre>
+        </article>
+    </section>
+
+
+
+
+</div>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Sun Mar 12 2023 09:58:16 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/dwaring87/docdash">@dwaring87/docdash</a> theme.
+</footer>
+
+<script>prettyPrint();</script>
+<script src="scripts/linenumber.js"></script>
+</body>
+</html>

package/package.json

@@ -1,9 +1,11 @@
 {
   "name": "@beauraines/rtm-api",
-  "version": "1.4.2",
+  "version": "1.6.0",
   "description": "Remember the Milk API Interface",
   "author": "David Waring <dev@davidwaring.net> (https://davidwaring.net)",
-  "contributors": ["Beau Raines <beau.raines@gmail.com>"],
+  "contributors": [
+    "Beau Raines <beau.raines@gmail.com>"
+  ],
   "license": "MIT",
   "keywords": [
     "rtm",
@@ -15,10 +17,18 @@
   ],
   "main": "src/client/index.js",
   "scripts": {
-    "docs": "jsdoc -c jsdoc.json --readme README.md --template $NODE_PATH/@dwaring87/docdash"
+    "docs": "jsdoc -c jsdoc.json --readme README.md --template node_modules/@dwaring87/docdash",
+    "test": "jest --passWithNoTests",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "release": "standard-version",
+    "should-release": "should-release"
   },
   "devDependencies": {
     "@dwaring87/docdash": "^0.4.1",
+    "eslint": "^8.35.0",
+    "eslint-plugin-jest": "^27.2.1",
+    "jest": "^29.4.3",
     "jsdoc": "^3.6.3"
   },
   "repository": {
@@ -29,6 +39,9 @@
     "url": "https://github.com/beauraines/rtm-api/issues"
   },
   "dependencies": {
-    "node-fetch": "^2.6.7"
+    "debug": "^4.3.4",
+    "node-fetch": "^2.6.7",
+    "should-release": "^1.2.0",
+    "standard-version": "^9.5.0"
   }
 }

package/src/client/user.js

@@ -53,14 +53,14 @@ module.exports = function(client) {
         apiKey: user.client.key,
         apiSecret: user.client.secret,
         perms: user.client.perms
-      }
+      };
     }
     else {
       rtn.client = {
         apiKey: client.key,
         apiSecret: client.key,
         perms: client.perms
-      }
+      };
     }
 
     return rtn;
@@ -94,7 +94,7 @@ module.exports = function(client) {
       return user;
     }
     else {
-      throw "Missing User Properties";
+      throw 'Missing User Properties';
     }
   };
 

package/src/list/helper.js

@@ -51,7 +51,7 @@ function add(name, filter, user, callback) {
 
   // Invalid List Names
   if ( name === 'Inbox' || name === 'Sent' ) {
-    throw "Invalid List Name"
+    throw 'Invalid List Name';
   }
 
   // Set Parameters

package/src/response/error.js

@@ -50,7 +50,7 @@ class RTMError extends RTMResponse{
    * @returns {string}
    */
   toString() {
-    return super.toString() + " ERROR " + this._code + ": " + this._msg;
+    return super.toString() + ' ERROR ' + this._code + ': ' + this._msg;
   }
 
 }
@@ -65,7 +65,7 @@ class RTMError extends RTMResponse{
  * @returns {RTMError}
  */
 RTMError.networkError = function() {
-  return new RTMError(-1, "Network Error: Could not make request to RTM API Server");
+  return new RTMError(-1, 'Network Error: Could not make request to RTM API Server');
 };
 
 /**
@@ -75,7 +75,7 @@ RTMError.networkError = function() {
  * @returns {RTMError}
  */
 RTMError.responseError = function() {
-  return new RTMError(-2, "Response Error: Could not parse the response from the RTM API Server");
+  return new RTMError(-2, 'Response Error: Could not parse the response from the RTM API Server');
 };
 
 /**
@@ -86,7 +86,7 @@ RTMError.responseError = function() {
  * @returns {RTMError}
  */
 RTMError.referenceError = function() {
-  return new RTMError(-3, "Reference Error: Could not find item by reference index number or name");
+  return new RTMError(-3, 'Reference Error: Could not find item by reference index number or name');
 };
 
 /**
@@ -97,7 +97,7 @@ RTMError.referenceError = function() {
  * @returns {RTMError}
  */
 RTMError.rateLimitError = function() {
-  return new RTMError(-4, "Rate Limit Error: Your Account has temporarily reached the RTM API Rate Limit.  Please wait a minute and try the request again later.");
+  return new RTMError(-4, 'Rate Limit Error: Your Account has temporarily reached the RTM API Rate Limit.  Please wait a minute and try the request again later.');
 };
 
 /**
@@ -108,7 +108,7 @@ RTMError.rateLimitError = function() {
  * @returns {RTMError}
  */
 RTMError.serverError = function() {
-  return new RTMError(-5, "RTM API Server Error: The RTM API Server is not responding.  Please try the request again later.");
+  return new RTMError(-5, 'RTM API Server Error: The RTM API Server is not responding.  Please try the request again later.');
 };
 
 module.exports = RTMError;

package/src/response/response.js

@@ -77,7 +77,7 @@ class RTMResponse {
    * @returns {string}
    */
   toString() {
-    return "[" + this._status + "]";
+    return '[' + this._status + ']';
   }
 
 }
@@ -88,14 +88,14 @@ class RTMResponse {
  * @type {string}
  * @default
  */
-RTMResponse.STATUS_OK = "ok";
+RTMResponse.STATUS_OK = 'ok';
 
 /**
  * RTM Status of 'fail' = error
  * @type {string}
  * @default
  */
-RTMResponse.STATUS_FAIL = "fail";
+RTMResponse.STATUS_FAIL = 'fail';
 
 
 

package/src/response/success.js

@@ -37,7 +37,7 @@ class RTMSuccess extends RTMResponse {
    * @returns {string}
    */
   toString() {
-    return super.toString() + " " + JSON.stringify(this.props);
+    return super.toString() + ' ' + JSON.stringify(this.props);
   }
 
 }

package/src/task/helper.js

@@ -76,42 +76,42 @@ function add(name, props, user, callback) {
 
   // Parse the props keys
   if ( props.due ) {
-    name = name + " ^" + props.due;
+    name = name + ' ^' + props.due;
   }
   if ( props.priority ) {
-    name = name + " !" + props.priority
+    name = name + ' !' + props.priority;
   }
   if ( props.list ) {
-    name = name + " #" + props.list;
+    name = name + ' #' + props.list;
   }
   if ( props.tags ) {
     if ( !Array.isArray(props.tags) ) {
       props.tags = [props.tags];
     }
     for ( let i = 0; i < props.tags.length; i++ ) {
-      name = name + " #" + props.tags[i];
+      name = name + ' #' + props.tags[i];
     }
   }
   if ( props.location ) {
-    name = name + " @" + props.location;
+    name = name + ' @' + props.location;
   }
   if ( props.start ) {
-    name = name + " ~" + props.start;
+    name = name + ' ~' + props.start;
   }
   if ( props.repeat ) {
-    name = name + " *" + props.repeat;
+    name = name + ' *' + props.repeat;
   }
   if ( props.estimate ) {
-    name = name + " =" + props.estimate;
+    name = name + ' =' + props.estimate;
   }
   if ( props.to ) {
-    name = name + " +" + props.to;
+    name = name + ' +' + props.to;
   }
   if ( props.url ) {
-    name = name + " " + props.url;
+    name = name + ' ' + props.url;
   }
   if ( props.note ) {
-    name = name + " //" + props.note;
+    name = name + ' //' + props.note;
   }
 
   // Set the request params
@@ -233,7 +233,7 @@ function addNotes(listId, taskSeriesId, taskId, title, notes, user, callback) {
     list_id: listId,
     taskseries_id: taskSeriesId,
     task_id: taskId,
-	note_title: title,
+    note_title: title,
     note_text: notes
   };
   user.get('rtm.tasks.notes.add', params, function(err) {
@@ -274,7 +274,7 @@ function remove(listId, taskSeriesId, taskId, user, callback) {
  */
 function movePriority(listId, taskSeriesId, taskId, direction, user, callback) {
   if ( direction.toLowerCase() !== 'up' && direction.toLowerCase() !== 'down' ) {
-    throw "Incorrect priority direction.  Must be either 'up' or 'down'";
+    throw 'Incorrect priority direction.  Must be either \'up\' or \'down\'';
   }
   let params = {
     timeline: user.timeline,

package/src/task/index.js

@@ -215,12 +215,12 @@ class RTMTask {
      * Task subtask flag
      * @type {boolean}
      */
-    this.isSubtask = series.parent_task_id != "" ? true : false;
+    this.isSubtask = series.parent_task_id != '' ? true : false;
 
     /** Task parent task id
      * @type {integer|undefined}
      */
-    this.parentTaskId = series.parent_task_id != "" ? parseFloat(series.parent_task_id) : undefined;
+    this.parentTaskId = series.parent_task_id != '' ? parseFloat(series.parent_task_id) : undefined;
 
 
   }
@@ -240,7 +240,7 @@ class RTMTask {
    */
   get list() {
     if ( this._list === undefined ) {
-      throw "Tasks not loaded with associated Lists"
+      throw 'Tasks not loaded with associated Lists';
     }
     return this._list;
   }