npm - @beauraines/rtm-api - Versions diffs - 1.4.1 - Mend

@beauraines/rtm-api 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (52) hide show

package/LICENSE +21 -0
package/README.md +285 -0
package/config.js +22 -0
package/docs/RTMClient.html +2798 -0
package/docs/RTMError.html +1029 -0
package/docs/RTMList.html +966 -0
package/docs/RTMResponse.html +868 -0
package/docs/RTMSuccess.html +337 -0
package/docs/RTMTask.html +2461 -0
package/docs/RTMUser.html +6761 -0
package/docs/client_auth.js.html +123 -0
package/docs/client_index.js.html +241 -0
package/docs/client_user.js.html +170 -0
package/docs/global.html +386 -0
package/docs/index.html +305 -0
package/docs/list_index.js.html +159 -0
package/docs/response_error.js.html +172 -0
package/docs/response_response.js.html +160 -0
package/docs/response_success.js.html +104 -0
package/docs/scripts/linenumber.js +25 -0
package/docs/scripts/prettify/Apache-License-2.0.txt +202 -0
package/docs/scripts/prettify/lang-css.js +2 -0
package/docs/scripts/prettify/prettify.js +28 -0
package/docs/styles/jsdoc.css +664 -0
package/docs/styles/prettify.css +79 -0
package/docs/task_helper.js.html +531 -0
package/docs/task_index.js.html +304 -0
package/docs/user_index.js.html +347 -0
package/docs/user_lists.js.html +208 -0
package/docs/user_tasks.js.html +703 -0
package/jsdoc.json +13 -0
package/package.json +33 -0
package/src/client/auth.js +65 -0
package/src/client/index.js +182 -0
package/src/client/user.js +112 -0
package/src/list/helper.js +131 -0
package/src/list/index.js +101 -0
package/src/response/error.js +114 -0
package/src/response/index.js +8 -0
package/src/response/parse.js +51 -0
package/src/response/response.js +102 -0
package/src/response/success.js +46 -0
package/src/task/helper.js +469 -0
package/src/task/index.js +264 -0
package/src/user/index.js +288 -0
package/src/user/lists.js +150 -0
package/src/user/tasks.js +708 -0
package/src/utils/auth.js +188 -0
package/src/utils/fetch.js +67 -0
package/src/utils/get.js +247 -0
package/src/utils/sign.js +93 -0
package/src/utils/taskIds.js +188 -0

package/docs/task_helper.js.html ADDED Viewed

@@ -0,0 +1,531 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>task/helper.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/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>
+</nav>
+<div id="main">
+    <h1 class="page-title">task/helper.js</h1>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>'use strict';
+const RTMTask = require('./index.js');
+const taskIds = require('../utils/taskIds.js');
+/**
+ * API Call: rtm.tasks.getList
+ * @param user RTMUser
+ * @param [filter] Task Filter
+ * @param callback Callback function(err, tasks)
+ * @private
+ */
+function get(user, filter, callback) {
+  let params = {};
+  if ( callback === undefined &amp;&amp; typeof filter === 'function' ) {
+    callback = filter;
+  }
+  else if ( filter !== '' ) {
+    params.filter = filter;
+  }
+  user.get('rtm.tasks.getList', params, function(err, resp) {
+    if ( err ) {
+      return callback(err);
+    }
+    // List of task to return
+    let rtn = [];
+    // Parse each List
+    let lists = resp.tasks.list;
+    if ( lists !== undefined ) {
+      for ( let i = 0; i &lt; lists.length; i++ ) {
+        let list = lists[i];
+        // Parse the List's TaskSeries
+        if ( list.taskseries ) {
+          if ( !Array.isArray(list.taskseries) ) {
+            list.taskseries = [list.taskseries];
+          }
+          for ( let j = 0; j &lt; list.taskseries.length; j++ ) {
+            let series = list.taskseries[j];
+            if ( series.name === "Add Support for Sub Tasks" ) {
+              console.log(series);
+            }
+            // Parse the TaskSeries' Tasks
+            if ( !Array.isArray(series.task) ) {
+              series.task = [series.task];
+            }
+            for ( let k = 0; k &lt; series.task.length; k++ ) {
+              let task = series.task[k];
+              rtn.push(new RTMTask(user.id, list.id, series, task));
+            }
+          }
+        }
+      }
+    }
+    // Save the task indices
+    taskIds.save();
+    // Return with the callback
+    return callback(null, rtn);
+  });
+}
+/**
+ * API Call rtm.tasks.add
+ * Note: this uses RTM's 'smart add'
+ * @param {string} name Task Name (or smart add syntax)
+ * @param {{due: *, priority: *, list: *, tags: *, location: *, start: *, repeat: *, estimate: *, to: *, url: *, note: *}} props Additional task properties
+ * @param user RTM User
+ * @param callback Callback function(err)
+ * @private
+ */
+function add(name, props, user, callback) {
+  // Parse the props keys
+  if ( props.due ) {
+    name = name + " ^" + props.due;
+  }
+  if ( props.priority ) {
+    name = name + " !" + props.priority
+  }
+  if ( props.list ) {
+    name = name + " #" + props.list;
+  }
+  if ( props.tags ) {
+    if ( !Array.isArray(props.tags) ) {
+      props.tags = [props.tags];
+    }
+    for ( let i = 0; i &lt; props.tags.length; i++ ) {
+      name = name + " #" + props.tags[i];
+    }
+  }
+  if ( props.location ) {
+    name = name + " @" + props.location;
+  }
+  if ( props.start ) {
+    name = name + " ~" + props.start;
+  }
+  if ( props.repeat ) {
+    name = name + " *" + props.repeat;
+  }
+  if ( props.estimate ) {
+    name = name + " =" + props.estimate;
+  }
+  if ( props.to ) {
+    name = name + " +" + props.to;
+  }
+  if ( props.url ) {
+    name = name + " " + props.url;
+  }
+  if ( props.note ) {
+    name = name + " //" + props.note;
+  }
+  // Set the request params
+  let params = {
+    timeline: user.timeline,
+    name: name,
+    parse: '1'
+  };
+  // Make the API Request
+  user.get('rtm.tasks.add', params, function(err) {
+    return callback(err);
+  });
+}
+/**
+ * API Call: rtm.tasks.complete
+ * @param {number} listId RTM List ID
+ * @param {number} taskSeriesId RTM Task Series ID
+ * @param {number} taskId RTM Task ID
+ * @param {RTMUser} user RTM User
+ * @param {function} callback function(err)
+ * @private
+ */
+function complete(listId, taskSeriesId, taskId, user, callback) {
+  let params = {
+    timeline: user.timeline,
+    list_id: listId,
+    taskseries_id: taskSeriesId,
+    task_id: taskId
+  };
+  user.get('rtm.tasks.complete', params, function(err) {
+    return callback(err);
+  });
+}
+/**
+ * API Call: rtm.tasks.uncomplete
+ * @param {number} listId RTM List ID
+ * @param {number} taskSeriesId RTM Task Series ID
+ * @param {number} taskId RTM Task ID
+ * @param {RTMUser} user RTM User
+ * @param {function} callback function(err)
+ * @private
+ */
+function uncomplete(listId, taskSeriesId, taskId, user, callback) {
+  let params = {
+    timeline: user.timeline,
+    list_id: listId,
+    taskseries_id: taskSeriesId,
+    task_id: taskId
+  };
+  user.get('rtm.tasks.uncomplete', params, function(err) {
+    return callback(err);
+  });
+}
+/**
+ * API Call: rtm.tasks.setPriority
+ * @param {number} listId RTM List ID
+ * @param {number} taskSeriesId RTM Task Series ID
+ * @param {number} taskId RTM Task ID
+ * @param {int} priority Task Priority
+ * @param {RTMUser} user RTM User
+ * @param {function} callback function(err)
+ * @private
+ */
+function priority(listId, taskSeriesId, taskId, priority, user, callback) {
+  let params = {
+    timeline: user.timeline,
+    list_id: listId,
+    taskseries_id: taskSeriesId,
+    task_id: taskId,
+    priority: priority
+  };
+  user.get('rtm.tasks.setPriority', params, function(err) {
+    return callback(err);
+  });
+}
+/**
+ * API Call: rtm.tasks.addTags
+ * @param {number} listId RTM List ID
+ * @param {number} taskSeriesId RTM Task Series ID
+ * @param {number} taskId RTM Task ID
+ * @param {string[]} tags Tags to Add
+ * @param {RTMUser} user RTM User
+ * @param {function} callback function(err)
+ * @private
+ */
+function addTags(listId, taskSeriesId, taskId, tags, user, callback) {
+  let params = {
+    timeline: user.timeline,
+    list_id: listId,
+    taskseries_id: taskSeriesId,
+    task_id: taskId,
+    tags: tags.join(',')
+  };
+  user.get('rtm.tasks.addTags', params, function(err) {
+    return callback(err);
+  });
+}
+/**
+ * API Call: rtm.tasks.notes.add
+ * @param {number} listId RTM List ID
+ * @param {number} taskSeriesId RTM Task Series ID
+ * @param {number} taskId RTM Task ID
+ * @param {string} title Title of Note
+ * @param {string|string[]} notes Note(s) to add to the Task
+ * @param {RTMUser} user RTM User
+ * @param {function} callback function(err)
+ * @private
+ */
+function addNotes(listId, taskSeriesId, taskId, title, notes, user, callback) {
+  let params = {
+    timeline: user.timeline,
+    list_id: listId,
+    taskseries_id: taskSeriesId,
+    task_id: taskId,
+	note_title: title,
+    note_text: notes
+  };
+  user.get('rtm.tasks.notes.add', params, function(err) {
+    return callback(err);
+  });
+}
+/**
+ * API Call: rtm.tasks.delete
+ * @param {number} listId RTM List ID
+ * @param {number} taskSeriesId RTM Task Series ID
+ * @param {number} taskId RTM Task ID
+ * @param {RTMUser} user RTM User
+ * @param {function} callback function(err)
+ * @private
+ */
+function remove(listId, taskSeriesId, taskId, user, callback) {
+  let params = {
+    timeline: user.timeline,
+    list_id: listId,
+    taskseries_id: taskSeriesId,
+    task_id: taskId,
+  };
+  user.get('rtm.tasks.delete', params, function(err) {
+    return callback(err);
+  });
+}
+/**
+ * API Call: rtm.tasks.movePriority
+ * @param {number} listId RTM List ID
+ * @param {number} taskSeriesId RTM Task Series ID
+ * @param {number} taskId RTM Task ID
+ * @param {string} direction Direction to move 'up' or 'down'
+ * @param {RTMUser} user RTM User
+ * @param {function} callback function(err)
+ * @private
+ */
+function movePriority(listId, taskSeriesId, taskId, direction, user, callback) {
+  if ( direction.toLowerCase() !== 'up' &amp;&amp; direction.toLowerCase() !== 'down' ) {
+    throw "Incorrect priority direction.  Must be either 'up' or 'down'";
+  }
+  let params = {
+    timeline: user.timeline,
+    list_id: listId,
+    taskseries_id: taskSeriesId,
+    task_id: taskId,
+    direction: direction.toLowerCase()
+  };
+  user.get('rtm.tasks.movePriority', params, function(err) {
+    return callback(err);
+  });
+}
+/**
+ * API Call: rtm.tasks.moveTo
+ * @param {number} listId RTM List ID (original)
+ * @param {number} taskSeriesId RTM Task Series ID
+ * @param {number} taskId RTM Task ID
+ * @param {number} toListId RTM List ID (new)
+ * @param {RTMUser} user RTM User
+ * @param {function} callback function(err)
+ * @private
+ */
+function move(listId, taskSeriesId, taskId, toListId, user, callback) {
+  let params = {
+    timeline: user.timeline,
+    from_list_id: listId,
+    taskseries_id: taskSeriesId,
+    task_id: taskId,
+    to_list_id: toListId
+  };
+  user.get('rtm.tasks.moveTo', params, function(err) {
+    return callback(err);
+  });
+}
+/**
+ * API Call: rtm.tasks.postpone
+ * @param {number} listId RTM List ID
+ * @param {number} taskSeriesId RTM Task Series ID
+ * @param {number} taskId RTM Task ID
+ * @param {RTMUser} user RTM User
+ * @param {function} callback function(err)
+ * @private
+ */
+function postpone(listId, taskSeriesId, taskId, user, callback) {
+  let params = {
+    timeline: user.timeline,
+    list_id: listId,
+    taskseries_id: taskSeriesId,
+    task_id: taskId
+  };
+  user.get('rtm.tasks.postpone', params, function(err) {
+    return callback(err);
+  });
+}
+/**
+ * API Call: rtm.tasks.removeTags
+ * @param {number} listId RTM List ID
+ * @param {number} taskSeriesId RTM Task Series ID
+ * @param {number} taskId RTM Task ID
+ * @param {string[]} tags Tags to Remove
+ * @param {RTMUser} user RTM User
+ * @param {function} callback function(err)
+ * @private
+ */
+function removeTags(listId, taskSeriesId, taskId, tags, user, callback) {
+  let params = {
+    timeline: user.timeline,
+    list_id: listId,
+    taskseries_id: taskSeriesId,
+    task_id: taskId,
+    tags: tags.join(',')
+  };
+  user.get('rtm.tasks.removeTags', params, function(err) {
+    return callback(err);
+  });
+}
+/**
+ * API Call: rtm.tasks.setDueDate
+ * @param {number} listId RTM List ID
+ * @param {number} taskSeriesId RTM Task Series ID
+ * @param {number} taskId RTM Task ID
+ * @param {string} due Task Due Date (will be parsed by RTM)
+ * @param {RTMUser} user RTM User
+ * @param {function} callback function(err)
+ * @private
+ */
+function setDueDate(listId, taskSeriesId, taskId, due, user, callback) {
+  let params = {
+    timeline: user.timeline,
+    list_id: listId,
+    taskseries_id: taskSeriesId,
+    task_id: taskId,
+    due: due,
+    parse: 1
+  };
+  user.get('rtm.tasks.setDueDate', params, function(err) {
+    return callback(err);
+  });
+}
+/**
+ * API Call: rtm.tasks.setStartDate
+ * @param {number}   listId       RTM List ID
+ * @param {number}   taskSeriesId RTM Task Series ID
+ * @param {number}   taskId       RTM Task ID
+ * @param {string}   start        Task Start Date/Time (will be parsed by RTM)
+ * @param {RTMUser}  user         RTM User
+ * @param {Function} callback     Callback function(err)
+ */
+function setStartDate(listId, taskSeriesId, taskId, start, user, callback) {
+  let params = {
+    timeline: user.timeline,
+    list_id: listId,
+    taskseries_id: taskSeriesId,
+    task_id: taskId,
+    start: start,
+    parse: 1
+  };
+  user.get('rtm.tasks.setStartDate', params, function(err) {
+    return callback(err);
+  });
+}
+/**
+ * API Call: rtm.tasks.setName
+ * @param {number} listId RTM List ID
+ * @param {number} taskSeriesId RTM Task Series ID
+ * @param {number} taskId RTM Task ID
+ * @param {string} name New Task Name
+ * @param {RTMUser} user RTM User
+ * @param {function} callback function(err)
+ * @private
+ */
+function setName(listId, taskSeriesId, taskId, name, user, callback) {
+  let params = {
+    timeline: user.timeline,
+    list_id: listId,
+    taskseries_id: taskSeriesId,
+    task_id: taskId,
+    name: name
+  };
+  user.get('rtm.tasks.setName', params, function(err) {
+    return callback(err);
+  });
+}
+/**
+ * API Call: rtm.tasks.setURL
+ * @param {number} listId RTM List ID
+ * @param {number} taskSeriesId RTM Task Series ID
+ * @param {number} taskId RTM Task ID
+ * @param {string} url New Task URL
+ * @param {RTMUser} user RTM User
+ * @param {function} callback function(err)
+ * @private
+ */
+function setURL(listId, taskSeriesId, taskId, url, user, callback) {
+  let params = {
+    timeline: user.timeline,
+    list_id: listId,
+    taskseries_id: taskSeriesId,
+    task_id: taskId,
+    url: url
+  };
+  user.get('rtm.tasks.setURL', params, function(err) {
+    return callback(err);
+  });
+}
+module.exports = {
+  get: get,
+  add: add,
+  complete: complete,
+  uncomplete: uncomplete,
+  priority: priority,
+  addNotes: addNotes,
+  addTags: addTags,
+  remove: remove,
+  movePriority: movePriority,
+  move: move,
+  postpone: postpone,
+  removeTags: removeTags,
+  setDueDate: setDueDate,
+  setStartDate: setStartDate,
+  setName: setName,
+  setURL: setURL
+};
+</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 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.
+</footer>
+<script>prettyPrint();</script>
+<script src="scripts/linenumber.js"></script>
+</body>
+</html>