@beauraines/rtm-api 1.11.0 → 1.13.0

package/.github/dependabot.yml

@@ -8,14 +8,14 @@ updates:
   - package-ecosystem: "npm" # See documentation for possible values
     directory: "/" # Location of package manifests
     schedule:
-      interval: "weekly"
+      interval: "monthly"
       day: "friday"
     commit-message:
       prefix: fix
       prefix-development: chore
       include: scope
     groups:
-        dev-dependencies:
-          dependency-type: "development"
-          patterns:
-            - "*"
+      dev-dependencies:
+        dependency-type: "development"
+        patterns:
+          - "*"

package/CHANGELOG.md

@@ -2,7 +2,19 @@
 
 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.11.0](https://github.com/beauraines/rtm-api/compare/v1.5.0...v1.11.0) (2024-06-24)
+## [1.13.0](https://github.com/beauraines/rtm-api/compare/v1.12.0...v1.13.0) (2025-12-17)
+
+
+### Features
+
+* includes recurrence rule on RTMTask object ([#71](https://github.com/beauraines/rtm-api/issues/71)) ([9400a6e](https://github.com/beauraines/rtm-api/commit/9400a6e1376cec40e2ae3ffed3661357d551b65b)), closes [#66](https://github.com/beauraines/rtm-api/issues/66)
+
+
+### Bug Fixes
+
+* **deps:** bump debug from 4.3.5 to 4.4.0 ([#62](https://github.com/beauraines/rtm-api/issues/62)) ([fdd0986](https://github.com/beauraines/rtm-api/commit/fdd0986218fe4cca119d7b1c11ef3e45dbd12055)), closes [debug-js/debug#819](https://github.com/debug-js/debug/issues/819) [debug-js/debug#969](https://github.com/debug-js/debug/issues/969) [debug-js/debug#969](https://github.com/debug-js/debug/issues/969) [#819](https://github.com/beauraines/rtm-api/issues/819)
+
+## [1.12.0](https://github.com/beauraines/rtm-api/compare/v1.5.0...v1.12.0) (2024-06-24)
 
 
 ### Features
@@ -12,6 +24,7 @@ All notable changes to this project will be documented in this file. See [standa
 
 ### Bug Fixes
 
+* **ci:** increment package number ([#48](https://github.com/beauraines/rtm-api/issues/48)) ([920f0c2](https://github.com/beauraines/rtm-api/commit/920f0c2857edd1a4c313edd03202f642df0ad6bb))
 * **deps:** bump debug from 4.3.4 to 4.3.5 ([269cc26](https://github.com/beauraines/rtm-api/commit/269cc2629ca7641f9e54f5f4578ebfab77c5879f))
 * **deps:** bump debug from 4.3.4 to 4.3.5 ([#46](https://github.com/beauraines/rtm-api/issues/46)) ([b488362](https://github.com/beauraines/rtm-api/commit/b488362b6beff5b293efb2a26b71640580a9e554))
 * **deps:** bump node-fetch from 2.6.11 to 2.7.0 ([#33](https://github.com/beauraines/rtm-api/issues/33)) ([37e41f2](https://github.com/beauraines/rtm-api/commit/37e41f2e174228c861f77b36c2da0242cb7e2c24)), closes [#1744](https://github.com/beauraines/rtm-api/issues/1744) [#1765](https://github.com/beauraines/rtm-api/issues/1765) [#1735](https://github.com/beauraines/rtm-api/issues/1735) [#1473](https://github.com/beauraines/rtm-api/issues/1473) [#1736](https://github.com/beauraines/rtm-api/issues/1736) [#1726](https://github.com/beauraines/rtm-api/issues/1726) [#1744](https://github.com/beauraines/rtm-api/issues/1744) [#1765](https://github.com/beauraines/rtm-api/issues/1765) [#1726](https://github.com/beauraines/rtm-api/issues/1726)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/rtm-api",
-  "version": "1.11.0",
+  "version": "1.13.0",
   "description": "Remember the Milk API Interface",
   "author": "David Waring <dev@davidwaring.net> (https://davidwaring.net)",
   "contributors": [
@@ -18,7 +18,7 @@
   "main": "src/client/index.js",
   "scripts": {
     "docs": "jsdoc -c jsdoc.json --readme README.md --template node_modules/@dwaring87/docdash",
-    "test": "jest --passWithNoTests",
+    "test": "jest",
     "lint": "eslint src",
     "lint:fix": "eslint src --fix",
     "release": "standard-version",
@@ -30,7 +30,7 @@
     "@eslint/js": "^9.5.0",
     "eslint": "^9.5.0",
     "eslint-plugin-jest": "^28.6.0",
-    "globals": "^15.6.0",
+    "globals": "^16.0.0",
     "jest": "^29.4.3",
     "jsdoc": "^4.0.2"
   },

package/src/task/index.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const taskIds = require('../utils/taskIds.js');
+const rruleToISODuration = require('../utils/rruleToDuration.js');
 
 
 /**
@@ -211,6 +212,15 @@ class RTMTask {
      */
     this.isRecurring = series.rrule ? true : false;
 
+    /**
+     * Task recurrence rule
+     * @type {string}}
+     */
+    this.recurrenceRule = series.rrule?.toString() === '' ? undefined : rruleToISODuration(series.rrule);
+    this.recurrenceRuleRaw = series.rrule?.toString() === '' ? undefined : JSON.stringify(series.rrule);
+
+
+
     /**
      * Task subtask flag
      * @type {boolean}

package/src/utils/rruleToDuration.js

@@ -0,0 +1,43 @@
+'use strict';
+
+/**
+ * Convert an RTM-style rrule object into an ISO 8601 duration string.
+ * @param {{ $t: string }} rrule - Object with $t property like 'FREQ=DAILY;INTERVAL=1;WKST=SU'
+ * @returns {string} ISO 8601 duration string (e.g. 'P1D', 'PT3H')
+ * @throws {Error} on missing or unsupported frequency
+ */
+function rruleToISODuration(rrule) {
+  if (!rrule || typeof rrule.$t !== 'string') {
+    throw new Error('Invalid rrule object');
+  }
+
+  const parts = rrule.$t
+    .split(';')
+    .map(p => p.split('='))
+    .reduce((acc, [k, v]) => {
+      acc[k] = v;
+      return acc;
+    }, {});
+
+  const freq = parts.FREQ;
+  const interval = parseInt(parts.INTERVAL || '1', 10);
+  const freqMap = {
+    YEARLY: 'Y',
+    MONTHLY: 'M',
+    WEEKLY: 'W',
+    DAILY: 'D',
+    HOURLY: 'H',
+    MINUTELY: 'M',
+    SECONDLY: 'S',
+  };
+
+  const designator = freqMap[freq];
+  if (!designator) {
+    throw new Error(`Unsupported FREQ: ${freq}`);
+  }
+
+  const timeBased = ['HOURLY', 'MINUTELY', 'SECONDLY'].includes(freq);
+  return `${timeBased ? 'PT' : 'P'}${interval}${designator}`;
+}
+
+module.exports = rruleToISODuration;

package/src/utils/rruleToDuration.test.js

@@ -0,0 +1,45 @@
+'use strict';
+
+const rruleToISODuration = require('./rruleToDuration');
+
+describe('rruleToISODuration', () => {
+  test('daily with explicit interval', () => {
+    const rrule = { $t: 'FREQ=DAILY;INTERVAL=1;WKST=SU' };
+    expect(rruleToISODuration(rrule)).toBe('P1D');
+  });
+
+  test('weekly without interval (defaults to 1)', () => {
+    const rrule = { $t: 'FREQ=WEEKLY;WKST=SU' };
+    expect(rruleToISODuration(rrule)).toBe('P1W');
+  });
+
+  test('monthly with interval 2', () => {
+    const rrule = { $t: 'FREQ=MONTHLY;INTERVAL=2' };
+    expect(rruleToISODuration(rrule)).toBe('P2M');
+  });
+
+  test('hourly with interval 3', () => {
+    const rrule = { $t: 'FREQ=HOURLY;INTERVAL=3' };
+    expect(rruleToISODuration(rrule)).toBe('PT3H');
+  });
+
+  test('minutely with interval 15', () => {
+    const rrule = { $t: 'FREQ=MINUTELY;INTERVAL=15' };
+    expect(rruleToISODuration(rrule)).toBe('PT15M');
+  });
+
+  test('secondly with interval 30', () => {
+    const rrule = { $t: 'FREQ=SECONDLY;INTERVAL=30' };
+    expect(rruleToISODuration(rrule)).toBe('PT30S');
+  });
+
+  test('unsupported frequency throws', () => {
+    const rrule = { $t: 'FREQ=UNKNOWN;INTERVAL=1' };
+    expect(() => rruleToISODuration(rrule)).toThrow('Unsupported FREQ: UNKNOWN');
+  });
+
+  test('invalid object throws', () => {
+    expect(() => rruleToISODuration(null)).toThrow('Invalid rrule object');
+    expect(() => rruleToISODuration({})).toThrow('Invalid rrule object');
+  });
+});