rrule-rust 1.1.3 → 1.1.5

package/index.d.ts

@@ -55,15 +55,15 @@ export class RRule {
   toString(): string
   setInterval(interval: number): this
   setCount(count: number): this
-  setByWeekday(weekdays: Weekday[]): this
-  setByHour(hours: Array<number>): this
-  setByMinute(minutes: Array<number>): this
-  setBySecond(seconds: Array<number>): this
-  setByMonthday(days: Array<number>): this
-  setBySetpos(poses: Array<number>): this
-  setByMonth(months: Month[]): this
-  setByWeekno(weekNumbers: Array<number>): this
-  setByYearday(days: Array<number>): this
+  setByWeekday(weekdays: ReadonlyArray<Weekday>): this
+  setByHour(hours: ReadonlyArray<number>): this
+  setByMinute(minutes: ReadonlyArray<number>): this
+  setBySecond(seconds: ReadonlyArray<number>): this
+  setByMonthday(days: ReadonlyArray<number>): this
+  setBySetpos(poses: ReadonlyArray<number>): this
+  setByMonth(months: ReadonlyArray<Month>): this
+  setByWeekno(weekNumbers: ReadonlyArray<number>): this
+  setByYearday(days: ReadonlyArray<number>): this
   setWeekstart(day: Weekday): this
   setUntil(timestamp: number): this
 }

package/jest.config.ts

@@ -0,0 +1,7 @@
+/* eslint-disable import/no-default-export -- Required by jest */
+import { Config } from 'jest';
+
+export default {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+} satisfies Config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rrule-rust",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "main": "index.js",
   "types": "index.d.ts",
   "keywords": [
@@ -40,20 +40,22 @@
   "license": "MIT",
   "devDependencies": {
     "@napi-rs/cli": "^2.15.1",
+    "@types/jest": "^29.5.0",
     "@types/node": "^18.15.5",
     "@typescript-eslint/eslint-plugin": "^5.50.0",
     "@typescript-eslint/parser": "^5.50.0",
-    "ava": "^5.1.1",
     "benny": "^3.7.1",
     "eslint": "^8.33.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^29.5.0",
     "lint-staged": "^13.1.0",
     "pre-commit": "^1.2.2",
     "prettier": "^2.8.3",
     "rrule": "^2.7.2",
+    "ts-jest": "^29.0.5",
     "ts-node": "^10.9.1",
     "typescript": "^4.9.4"
   },
@@ -64,15 +66,6 @@
   "lint-staged": {
     "**/*.{js,ts,json}": "eslint --fix --max-warnings=0"
   },
-  "ava": {
-    "timeout": "10m",
-    "extensions": [
-      "ts"
-    ],
-    "require": [
-      "ts-node/register"
-    ]
-  },
   "engines": {
     "node": ">= 10"
   },
@@ -81,7 +74,7 @@
     "build": "napi build --platform --release --js-package-name @rrule-rust/lib",
     "build:debug": "napi build --platform",
     "prepublishOnly": "napi prepublish -t npm",
-    "test": "ava",
+    "test": "jest",
     "universal": "napi universal",
     "version": "napi version",
     "benchmark": "ts-node ./benchmark/index.ts",
@@ -90,19 +83,19 @@
     "lint:fix-staged": "lint-staged"
   },
   "optionalDependencies": {
-    "@rrule-rust/lib-win32-x64-msvc": "1.1.3",
-    "@rrule-rust/lib-darwin-x64": "1.1.3",
-    "@rrule-rust/lib-linux-x64-gnu": "1.1.3",
-    "@rrule-rust/lib-darwin-arm64": "1.1.3",
-    "@rrule-rust/lib-android-arm64": "1.1.3",
-    "@rrule-rust/lib-linux-arm64-gnu": "1.1.3",
-    "@rrule-rust/lib-linux-arm64-musl": "1.1.3",
-    "@rrule-rust/lib-win32-arm64-msvc": "1.1.3",
-    "@rrule-rust/lib-linux-arm-gnueabihf": "1.1.3",
-    "@rrule-rust/lib-linux-x64-musl": "1.1.3",
-    "@rrule-rust/lib-freebsd-x64": "1.1.3",
-    "@rrule-rust/lib-win32-ia32-msvc": "1.1.3",
-    "@rrule-rust/lib-android-arm-eabi": "1.1.3",
-    "@rrule-rust/lib-darwin-universal": "1.1.3"
+    "@rrule-rust/lib-win32-x64-msvc": "1.1.5",
+    "@rrule-rust/lib-darwin-x64": "1.1.5",
+    "@rrule-rust/lib-linux-x64-gnu": "1.1.5",
+    "@rrule-rust/lib-darwin-arm64": "1.1.5",
+    "@rrule-rust/lib-android-arm64": "1.1.5",
+    "@rrule-rust/lib-linux-arm64-gnu": "1.1.5",
+    "@rrule-rust/lib-linux-arm64-musl": "1.1.5",
+    "@rrule-rust/lib-win32-arm64-msvc": "1.1.5",
+    "@rrule-rust/lib-linux-arm-gnueabihf": "1.1.5",
+    "@rrule-rust/lib-linux-x64-musl": "1.1.5",
+    "@rrule-rust/lib-freebsd-x64": "1.1.5",
+    "@rrule-rust/lib-win32-ia32-msvc": "1.1.5",
+    "@rrule-rust/lib-android-arm-eabi": "1.1.5",
+    "@rrule-rust/lib-darwin-universal": "1.1.5"
   }
 }

package/src/lib.rs

@@ -78,7 +78,7 @@ impl JsRRule {
   #[napi(getter, ts_return_type = "Weekday[]")]
   pub fn by_weekday(&self, env: Env) -> napi::Result<Array> {
     let ndays = self.rrule.get_by_weekday();
-    let mut arr = env.create_array(0).unwrap();
+    let mut arr = env.create_array(0)?;
 
     for nday in ndays.iter() {
       let day = match nday {
@@ -86,7 +86,7 @@ impl JsRRule {
         _ => panic!("Unsupported"),
       };
 
-      arr.insert(map_rust_weekday(day)).unwrap();
+      arr.insert(map_rust_weekday(day))?;
     }
 
     Ok(arr)
@@ -120,10 +120,10 @@ impl JsRRule {
   #[napi(getter, ts_return_type = "Month[]")]
   pub fn by_month(&self, env: Env) -> napi::Result<Array> {
     let months = self.rrule.get_by_month();
-    let mut arr = env.create_array(0).unwrap();
+    let mut arr = env.create_array(0)?;
 
     for month in months.iter() {
-      arr.insert(map_rust_month(month)).unwrap();
+      arr.insert(map_rust_month(month))?;
     }
 
     Ok(arr)
@@ -174,7 +174,7 @@ impl JsRRule {
   #[napi]
   pub fn set_by_weekday(
     &mut self,
-    #[napi(ts_arg_type = "Weekday[]")] weekdays: Array,
+    #[napi(ts_arg_type = "ReadonlyArray<Weekday>")] weekdays: Array,
   ) -> napi::Result<&Self> {
     let mut vec: Vec<NWeekday> = Vec::new();
 
@@ -191,35 +191,50 @@ impl JsRRule {
   }
 
   #[napi]
-  pub fn set_by_hour(&mut self, hours: Vec<u8>) -> napi::Result<&Self> {
+  pub fn set_by_hour(
+    &mut self,
+    #[napi(ts_arg_type = "ReadonlyArray<number>")] hours: Vec<u8>,
+  ) -> napi::Result<&Self> {
     replace_with_or_abort(&mut self.rrule, |self_| self_.by_hour(hours));
 
     Ok(self)
   }
 
   #[napi]
-  pub fn set_by_minute(&mut self, minutes: Vec<u8>) -> napi::Result<&Self> {
+  pub fn set_by_minute(
+    &mut self,
+    #[napi(ts_arg_type = "ReadonlyArray<number>")] minutes: Vec<u8>,
+  ) -> napi::Result<&Self> {
     replace_with_or_abort(&mut self.rrule, |self_| self_.by_minute(minutes));
 
     Ok(self)
   }
 
   #[napi]
-  pub fn set_by_second(&mut self, seconds: Vec<u8>) -> napi::Result<&Self> {
+  pub fn set_by_second(
+    &mut self,
+    #[napi(ts_arg_type = "ReadonlyArray<number>")] seconds: Vec<u8>,
+  ) -> napi::Result<&Self> {
     replace_with_or_abort(&mut self.rrule, |self_| self_.by_second(seconds));
 
     Ok(self)
   }
 
   #[napi]
-  pub fn set_by_monthday(&mut self, days: Vec<i8>) -> napi::Result<&Self> {
+  pub fn set_by_monthday(
+    &mut self,
+    #[napi(ts_arg_type = "ReadonlyArray<number>")] days: Vec<i8>,
+  ) -> napi::Result<&Self> {
     replace_with_or_abort(&mut self.rrule, |self_| self_.by_month_day(days));
 
     Ok(self)
   }
 
   #[napi]
-  pub fn set_by_setpos(&mut self, poses: Vec<i32>) -> napi::Result<&Self> {
+  pub fn set_by_setpos(
+    &mut self,
+    #[napi(ts_arg_type = "ReadonlyArray<number>")] poses: Vec<i32>,
+  ) -> napi::Result<&Self> {
     replace_with_or_abort(&mut self.rrule, |self_| self_.by_set_pos(poses));
 
     Ok(self)
@@ -228,7 +243,7 @@ impl JsRRule {
   #[napi]
   pub fn set_by_month(
     &mut self,
-    #[napi(ts_arg_type = "Month[]")] months: Array,
+    #[napi(ts_arg_type = "ReadonlyArray<Month>")] months: Array,
   ) -> napi::Result<&Self> {
     let mut vec: Vec<Month> = Vec::new();
 
@@ -244,14 +259,20 @@ impl JsRRule {
   }
 
   #[napi]
-  pub fn set_by_weekno(&mut self, week_numbers: Vec<i8>) -> napi::Result<&Self> {
+  pub fn set_by_weekno(
+    &mut self,
+    #[napi(ts_arg_type = "ReadonlyArray<number>")] week_numbers: Vec<i8>,
+  ) -> napi::Result<&Self> {
     replace_with_or_abort(&mut self.rrule, |self_| self_.by_week_no(week_numbers));
 
     Ok(self)
   }
 
   #[napi]
-  pub fn set_by_yearday(&mut self, days: Vec<i16>) -> napi::Result<&Self> {
+  pub fn set_by_yearday(
+    &mut self,
+    #[napi(ts_arg_type = "ReadonlyArray<number>")] days: Vec<i16>,
+  ) -> napi::Result<&Self> {
     replace_with_or_abort(&mut self.rrule, |self_| self_.by_year_day(days));
 
     Ok(self)
@@ -275,8 +296,8 @@ impl JsRRule {
     Ok(self)
   }
 
-  pub fn validate(&self, dt_start: DateTime<Tz>) -> RRule {
-    self.rrule.clone().validate(dt_start).unwrap()
+  pub fn validate(&self, dt_start: DateTime<Tz>) -> napi::Result<RRule> {
+    return Ok(self.rrule.clone().validate(dt_start).map_err(|e| napi::Error::new(napi::Status::GenericFailure, e))?);
   }
 }
 
@@ -289,21 +310,21 @@ pub struct JsRRuleSet {
 #[napi]
 impl JsRRuleSet {
   #[napi(constructor)]
-  pub fn new(dtstart: i64, tzid: String) -> Self {
-    let tz = map_js_tz(&tzid);
+  pub fn new(dtstart: i64, tzid: String) -> napi::Result<Self> {
+    let tz = map_js_tz(&tzid)?;
     let date = timestamp_to_date_with_tz(dtstart, &tz);
     let rrule_set = RRuleSet::new(date);
 
-    JsRRuleSet { rrule_set, tz }
+    Ok(JsRRuleSet { rrule_set, tz })
   }
 
-  #[napi(factory, ts_return_type="RRuleSet")]
-  pub fn parse(str: String) -> Self {
-    let rrule_set: RRuleSet = str.parse().unwrap();
+  #[napi(factory, ts_return_type = "RRuleSet")]
+  pub fn parse(str: String) -> napi::Result<Self> {
+    let rrule_set: RRuleSet = str.parse().map_err(|e| napi::Error::new(napi::Status::GenericFailure, e))?;
     let dtstart = rrule_set.get_dt_start();
     let tz = dtstart.timezone();
 
-    JsRRuleSet { rrule_set, tz }
+    Ok(JsRRuleSet { rrule_set, tz })
   }
 
   #[napi]
@@ -314,7 +335,7 @@ impl JsRRuleSet {
   #[napi]
   pub fn add_rrule(&mut self, js_rrule: &JsRRule) -> napi::Result<&Self> {
     let dt_start = self.rrule_set.get_dt_start().clone();
-    let rrule = js_rrule.validate(dt_start);
+    let rrule = js_rrule.validate(dt_start)?;
 
     replace_with_or_abort(&mut self.rrule_set, |self_| self_.rrule(rrule));
 
@@ -323,7 +344,7 @@ impl JsRRuleSet {
 
   #[napi]
   pub fn add_exrule(&mut self, js_rrule: &JsRRule) -> napi::Result<&Self> {
-    let rrule = js_rrule.validate(*self.rrule_set.get_dt_start());
+    let rrule = js_rrule.validate(*self.rrule_set.get_dt_start())?;
 
     replace_with_or_abort(&mut self.rrule_set, |self_| self_.exrule(rrule));
 
@@ -389,7 +410,7 @@ impl JsRRuleSet {
 
   #[napi(ts_return_type = "number[]")]
   pub fn all(&self, env: Env, limit: Option<u32>) -> napi::Result<Array> {
-    let mut arr = env.create_array(0).unwrap();
+    let mut arr = env.create_array(0)?;
     let mut left = match limit {
       Some(number) => number,
       None => 0,
@@ -403,15 +424,21 @@ impl JsRRuleSet {
       }
 
       let timestamp = date.timestamp_millis();
-      arr.insert(timestamp).unwrap();
+      arr.insert(timestamp)?;
     }
 
     Ok(arr)
   }
 
   #[napi(ts_return_type = "number[]")]
-  pub fn between(&self, env: Env, after: i64, before: i64, inclusive: Option<bool>) -> napi::Result<Array> {
-    let mut arr = env.create_array(0).unwrap();
+  pub fn between(
+    &self,
+    env: Env,
+    after: i64,
+    before: i64,
+    inclusive: Option<bool>,
+  ) -> napi::Result<Array> {
+    let mut arr = env.create_array(0)?;
 
     for date in self.rrule_set.into_iter() {
       let timestamp = date.timestamp_millis();
@@ -419,7 +446,7 @@ impl JsRRuleSet {
       let is_before = self.is_before(timestamp, before, inclusive);
 
       if is_after && is_before {
-        arr.insert(timestamp).unwrap();
+        arr.insert(timestamp)?;
       } else if !is_before {
         break;
       }
@@ -521,9 +548,9 @@ fn map_rust_month(month: &u8) -> JsMonth {
   }
 }
 
-fn map_js_tz(tz: &str) -> Tz {
-  let chrono_tz = tz.parse().unwrap();
-  Tz::Tz(chrono_tz)
+fn map_js_tz(tz: &str) -> napi::Result<Tz> {
+  let chrono_tz = tz.parse().map_err(|e| napi::Error::new(napi::Status::GenericFailure, e))?;
+  Ok(Tz::Tz(chrono_tz))
 }
 
 fn timestamp_to_date_with_tz(timestamp: i64, tz: &Tz) -> DateTime<Tz> {