@beauraines/rtm-api 1.13.1 → 1.14.1

package/.github/workflows/publish.yml

@@ -21,7 +21,7 @@ jobs:
       - name: setup node
         uses: actions/setup-node@v3
         with:
-          node-version: 18.x
+          node-version: 20.x
           registry-url: 'https://registry.npmjs.org'
       - name: npm install
         run: npm ci

package/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.14.1](https://github.com/beauraines/rtm-api/compare/v1.14.0...v1.14.1) (2025-12-19)
+
+
+### Bug Fixes
+
+* adds Location functions to the user ([18322b7](https://github.com/beauraines/rtm-api/commit/18322b743419a7274e65d55780563198088cfd1d))
+
+## [1.14.0](https://github.com/beauraines/rtm-api/compare/v1.13.1...v1.14.0) (2025-12-19)
+
+
+### Features
+
+* **Locations:** adds support. for get Locations ([4694b54](https://github.com/beauraines/rtm-api/commit/4694b54f8b6e4096dc235e83f83f8164c8f164c7))
+* **Locations:** adds support. for get Locations ([#74](https://github.com/beauraines/rtm-api/issues/74)) ([76a6e05](https://github.com/beauraines/rtm-api/commit/76a6e059ad6717e43e64fb6f4584d2fbc9838d2e))
+
 ### [1.13.1](https://github.com/beauraines/rtm-api/compare/v1.13.0...v1.13.1) (2025-12-17)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/rtm-api",
-  "version": "1.13.1",
+  "version": "1.14.1",
   "description": "Remember the Milk API Interface",
   "author": "David Waring <dev@davidwaring.net> (https://davidwaring.net)",
   "contributors": [

package/src/location/helper.js

@@ -0,0 +1,39 @@
+'use strict';
+
+const RTMLocation = require('./index.js');
+
+
+/**
+ * API Call: rtm.locations.getList
+ * @param user RTMUser
+ * @param callback Callback function(err, locations)
+ * @private
+ */
+function get(user, callback) {
+  user.get('rtm.locations.getList', function(err, resp) {
+    if ( err ) {
+      return callback(err);
+    }
+
+    // List of locations to return
+    let rtn = [];
+
+    // Parse each of the locations
+    let locations = resp.locations.location;
+    for ( let i = 0; i < locations.length; i++ ) {
+      rtn.push(
+        new RTMLocation(locations[i])
+      );
+    }
+
+    // Call the callback
+    return callback(null, rtn);
+  });
+}
+
+
+
+
+module.exports = {
+  get: get
+};

package/src/location/index.js

@@ -0,0 +1,82 @@
+'use strict';
+
+
+/**
+ * ### RTM Location
+ *
+ * This Class is used to represent the properties of an RTM Location.
+ *
+ * All of the location properties from RTM are directly accessible from this Class.
+ *
+ * ```
+ * let location = new RTMLocation(...);
+ * let name = location.name;
+ * ```
+ * @class
+ */
+class RTMLocation {
+
+  /**
+   * Create a new RTM Location
+   * @param {object} props The properties from the RTM API response `resp.locations.location`
+   */
+  constructor(props) {
+
+    /**
+     * Location ID
+     * @type {Number}
+     */
+    this.id = parseFloat(props.id);
+
+    /**
+     * Location Name
+     * @type {string}
+     */
+    this.name = props.name;
+
+  
+    /**
+     * Location Longitude
+     * @type {Number}
+     */
+    this.longitude = parseInt(props.longitude);
+
+    /**
+     * Location Latitude
+     * @type {Number}
+     */
+    this.latitude = parseInt(props.latitude);
+
+
+    /**
+     * Location Zoom
+     * @type {Number}
+     */
+    this.zoom = parseInt(props.zoom);
+
+    /**
+     * Location Address
+     * @type {string}
+     */
+    this.address = props.address;
+  
+  }
+
+  /**
+   * All of the RTM Location properties
+   * @type {object}
+   */
+  get props() {
+    let rtn = {};
+    for ( let key in this ) {
+      if ( this.hasOwnProperty(key) && key !== '_index' ) {
+        rtn[key] = this[key];
+      }
+    }
+    return rtn;
+  }
+
+}
+
+
+module.exports = RTMLocation;

package/src/user/index.js

@@ -259,6 +259,16 @@ class RTMUser {
   }
 
 
+  /**
+   * RTM Location related functions:
+   * - {@link RTMUser~locations/get|get}
+   * @returns {{get: function}}
+   */
+  get locations() {
+    return require('./locations.js')(this);
+  }
+
+
   /**
    * RTM Task related functions:
    * - {@link RTMUser~tasks/get|get}

package/src/user/locations.js

@@ -0,0 +1,27 @@
+'use strict';
+
+const _locations = require('../location/helper.js');
+
+
+/**
+ * This module returns the RTM location-related functions for the RTMUser
+ * @param {RTMUser} user RTM User instance
+ * @returns {{get: function}}
+ * @private
+ */
+module.exports = function(user) {
+  let rtn = {};
+
+  /**
+   * Get the list of RTM Lists for this User from the API Server
+   * @param {function} callback Callback function(err, lists)
+   * @param {RTMError} callback.err RTM API Error Response, if encountered
+   * @param {RTMList[]} callback.lists List of User's RTM Lists
+   * @function RTMUser~lists/get
+   */
+  rtn.get = function(callback) {
+    _locations.get(user, callback);
+  };
+
+  return rtn;
+};