feat: new methods setDate / getDate (#625)

flaviendelangle · web-flow · commit 8deea4ab5eee · 2022-09-21T09:58:06.000+02:00
diff --git a/README.md b/README.md
@@ -197,6 +197,9 @@ export interface IUtils<TDate> {
   getSeconds(value: TDate): number;
   setSeconds(value: TDate, count: number): TDate;
 
+  getDate(value: TDate): number;
+  setDate(value: TDate, count: number): TDate;
+
   getMonth(value: TDate): number;
   getDaysInMonth(value: TDate): number;
   setMonth(value: TDate, count: number): TDate;
diff --git a/__tests__/calculations.test.ts b/__tests__/calculations.test.ts
@@ -165,6 +165,10 @@ describe("DateTime calculations", () => {
     expect(utils.getSeconds(date)).toBe(0);
   });
 
+  utilsTest("getDate", (date, utils) => {
+    expect(utils.getDate(date)).toBe(30);
+  });
+
   utilsTest("getYear", (date, utils) => {
     expect(utils.getYear(date)).toBe(2018);
   });
@@ -217,6 +221,14 @@ describe("DateTime calculations", () => {
     expect(updatedTime).toBe("2011-10-30 11:44");
   });
 
+  utilsTest("setDate", (date, utils, lib) => {
+    const updatedTime = utils.formatByString(
+      utils.setDate(date, 15),
+      formats.dateTime[lib]
+    );
+    expect(updatedTime).toBe("2018-10-15 11:44");
+  });
+
   utilsTest("setSeconds", (date, utils) => {
     expect(utils.setSeconds(date, 11)).toBeTruthy();
   });
diff --git a/__tests__/date-fns-jalali.test.ts b/__tests__/date-fns-jalali.test.ts
@@ -164,6 +164,10 @@ describe("DateFnsJalali", () => {
       expect(utils.getYear(date)).toBe(1397);
     });
 
+    it("DateFnsJalali -- getDate", () => {
+      expect(utils.getDate(date)).toBe(8);
+    });
+
     it("DateFnsJalali -- getMonth", () => {
       expect(utils.getMonth(date)).toBe(7);
     });
@@ -203,6 +207,11 @@ describe("DateFnsJalali", () => {
       expect(updatedTime).toBe("1399/08/08 11:44");
     });
 
+    it("DateFnsJalali -- setDate", () => {
+      const updatedTime = utils.formatByString(utils.setDate(date, 12), dateTimeFormat);
+      expect(updatedTime).toBe("1397/08/12 11:44");
+    });
+
     it("DateFnsJalali -- setSeconds", () => {
       expect(utils.setSeconds(date, 11)).toBeTruthy();
     });
diff --git a/__tests__/hijri.test.ts b/__tests__/hijri.test.ts
@@ -46,6 +46,38 @@ describe("Hijri", () => {
     expect(hijriiUtils.getWeekdays()).toEqual(["ح", "ن", "ث", "ر", "خ", "ج", "س"]);
   });
 
+  it("Hijri -- getYear", () => {
+    const date = hijriiUtils.date(TEST_TIMESTAMP);
+
+    expect(hijriiUtils.getYear(date)).toEqual(
+      1440
+    );
+  });
+
+  it("Hijri -- setYear", () => {
+    const date = hijriiUtils.date(TEST_TIMESTAMP);
+
+    expect(hijriiUtils.setYear(date, 1441).toISOString()).toEqual(
+      "2019-10-20T11:44:00.000Z"
+    );
+  });
+
+  it("Hijri -- getDate", () => {
+    const date = hijriiUtils.date(TEST_TIMESTAMP);
+
+    expect(hijriiUtils.getDate(date)).toEqual(
+      21
+    );
+  });
+
+  it("Hijri -- setDate", () => {
+    const date = hijriiUtils.date(TEST_TIMESTAMP);
+
+    expect(hijriiUtils.setDate(date, 22).toISOString()).toEqual(
+      "2018-10-31T11:44:00.000Z"
+    );
+  });
+
   it("Hijri -- endOfYear", () => {
     const date = hijriiUtils.date(TEST_TIMESTAMP);
 
diff --git a/__tests__/jalaali.test.ts b/__tests__/jalaali.test.ts
@@ -28,6 +28,12 @@ describe("Jalaali", () => {
     expect(jalaaliUtils.getYear(date)).toBe(1397);
   });
 
+  it("Should proper work with jalaali day in month", () => {
+    const date = jalaaliUtils.date(TEST_TIMESTAMP);
+
+    expect(jalaaliUtils.getDate(date)).toBe(8);
+  });
+
   it("Should proper work with jalaali month", () => {
     const date = jalaaliUtils.date(TEST_TIMESTAMP);
 
@@ -49,6 +55,46 @@ describe("Jalaali", () => {
     expect(jalaaliUtils.getWeekdays()).toEqual(["ش", "ی", "د", "س", "چ", "پ", "ج"]);
   });
 
+  it("Jalaali -- getYear", () => {
+    const date = jalaaliUtils.date(TEST_TIMESTAMP);
+
+    expect(jalaaliUtils.getYear(date)).toEqual(
+      1397
+    );
+  });
+
+  it("Jalaali -- setYear", () => {
+    const date = jalaaliUtils.date(TEST_TIMESTAMP);
+
+    expect(jalaaliUtils.setYear(date, 1398).toISOString()).toEqual(
+      "2019-10-30T11:44:00.000Z"
+    );
+  });
+
+  it("Jalaali -- getDate", () => {
+    const date = jalaaliUtils.date(TEST_TIMESTAMP);
+
+    expect(jalaaliUtils.getDate(date)).toEqual(
+      8
+    );
+  });
+
+  it("Jalaali -- setDate", () => {
+    const date = jalaaliUtils.date(TEST_TIMESTAMP);
+
+    expect(jalaaliUtils.setDate(date, 9).toISOString()).toEqual(
+      "2018-10-31T11:44:00.000Z"
+    );
+  });
+
+  it("Jalaali -- getYear", () => {
+    const date = jalaaliUtils.date(TEST_TIMESTAMP);
+
+    expect(jalaaliUtils.getYear(date)).toEqual(
+      1397
+    );
+  });
+
   it("Jalaali -- endOfYear", () => {
     const date = jalaaliUtils.date(TEST_TIMESTAMP);
 
diff --git a/__tests__/local-date-calculations.test.ts b/__tests__/local-date-calculations.test.ts
@@ -123,11 +123,14 @@ describe("DateTime calculations", () => {
     );
   });
 
-
   localDateutilsTest("getYear", (date, utils) => {
     expect(utils.getYear(date)).toBe(2018);
   });
 
+  localDateutilsTest("getDate", (date, utils) => {
+    expect(utils.getDate(date)).toBe(30);
+  });
+
   localDateutilsTest("getMonth", (date, utils) => {
     expect(utils.getMonth(date)).toBe(9);
   });
@@ -152,6 +155,14 @@ describe("DateTime calculations", () => {
     expect(updatedTime).toBe("2011-10-30");
   });
 
+  localDateutilsTest("setYear", (date, utils, lib) => {
+    const updatedTime = utils.formatByString(
+      utils.setDate(date, 15),
+      formats.date[lib]
+    );
+    expect(updatedTime).toBe("2018-10-15");
+  });
+
   localDateutilsTest("isAfter", (date, utils, lib) => {
     expect(utils.isAfter(utils.date("2021-01-01"), utils.date(LOCALDATE_TEST_TIMESTAMP))).toBeTruthy();
     expect(utils.isAfter(utils.date(LOCALDATE_TEST_TIMESTAMP), utils.date("2021-01-01"))).toBeFalsy();
diff --git a/packages/core/IUtils.d.ts b/packages/core/IUtils.d.ts
@@ -140,6 +140,9 @@ export interface IUtils<TDate extends ExtendableDateType> {
   getSeconds(value: TDate): number;
   setSeconds(value: TDate, count: number): TDate;
 
+  getDate(value: TDate): number;
+  setDate(value: TDate, count: number): TDate;
+
   getMonth(value: TDate): number;
   getDaysInMonth(value: TDate): number;
   setMonth(value: TDate, count: number): TDate;
diff --git a/packages/date-fns-jalali/src/date-fns-jalali-utils.ts b/packages/date-fns-jalali/src/date-fns-jalali-utils.ts
@@ -24,6 +24,7 @@ import getHours from "date-fns-jalali/getHours";
 import getSeconds from "date-fns-jalali/getSeconds";
 import getYear from "date-fns-jalali/getYear";
 import getMonth from "date-fns-jalali/getMonth";
+import getDate from "date-fns-jalali/getDate";
 import getDay from "date-fns-jalali/getDay";
 import getDaysInMonth from "date-fns-jalali/getDaysInMonth";
 import getMinutes from "date-fns-jalali/getMinutes";
@@ -37,6 +38,7 @@ import isSameHour from "date-fns-jalali/isSameHour";
 import isValid from "date-fns-jalali/isValid";
 import dateFnsParse from "date-fns-jalali/parse";
 import parseISO from "date-fns-jalali/parseISO";
+import setDate from "date-fns-jalali/setDate";
 import setHours from "date-fns-jalali/setHours";
 import setMinutes from "date-fns-jalali/setMinutes";
 import setMonth from "date-fns-jalali/setMonth";
@@ -284,6 +286,14 @@ export default class DateFnsJalaliUtils implements IUtils<Date> {
     return setYear(value, count);
   };
 
+  public getDate = (value: Date) => {
+    return getDate(value);
+  };
+
+  public setDate = (value: Date, count: number) => {
+    return setDate(value, count);
+  };
+
   public date = (value?: string | number | Date) => {
     if (typeof value === "undefined") {
       return new Date();
diff --git a/packages/date-fns/src/date-fns-utils.ts b/packages/date-fns/src/date-fns-utils.ts
@@ -19,7 +19,12 @@ import endOfDay from "date-fns/endOfDay";
 import endOfWeek from "date-fns/endOfWeek";
 import endOfYear from "date-fns/endOfYear";
 import format from "date-fns/format";
+import getDate from "date-fns/getDate";
+import getDay from "date-fns/getDay";
+import getDaysInMonth from "date-fns/getDaysInMonth";
 import getHours from "date-fns/getHours";
+import getMinutes from "date-fns/getMinutes";
+import getMonth from "date-fns/getMonth";
 import getSeconds from "date-fns/getSeconds";
 import getYear from "date-fns/getYear";
 import isAfter from "date-fns/isAfter";
@@ -31,11 +36,10 @@ import isSameMonth from "date-fns/isSameMonth";
 import isSameHour from "date-fns/isSameHour";
 import isValid from "date-fns/isValid";
 import dateFnsParse from "date-fns/parse";
+import setDate from "date-fns/setDate";
 import setHours from "date-fns/setHours";
 import setMinutes from "date-fns/setMinutes";
 import setMonth from "date-fns/setMonth";
-import getDay from "date-fns/getDay";
-import getDaysInMonth from "date-fns/getDaysInMonth";
 import setSeconds from "date-fns/setSeconds";
 import setYear from "date-fns/setYear";
 import startOfDay from "date-fns/startOfDay";
@@ -346,11 +350,19 @@ export default class DateFnsUtils implements IUtils<Date> {
   };
 
   public getMinutes = (date: Date) => {
-    return date.getMinutes();
+    return getMinutes(date);
+  };
+
+  public getDate = (date: Date) => {
+    return getDate(date);
+  };
+
+  public setDate = (date: Date, count: number) => {
+    return setDate(date, count);
   };
 
   public getMonth = (date: Date) => {
-    return date.getMonth();
+    return getMonth(date);
   };
 
   public getDaysInMonth = (date: Date) => {
diff --git a/packages/dayjs/src/dayjs-utils.ts b/packages/dayjs/src/dayjs-utils.ts
@@ -255,6 +255,14 @@ export default class DayjsUtils<TDate extends Dayjs = Dayjs> implements IUtils<T
     return date.month();
   };
 
+  public getDate = (date: Dayjs) => {
+    return date.date();
+  };
+
+  public setDate = (date: Dayjs, count: number) => {
+    return date.set("date", count) as TDate;
+  };
+
   public getDaysInMonth = (date: Dayjs) => {
     return date.daysInMonth();
   };
diff --git a/packages/hijri/src/hijri-utils.ts b/packages/hijri/src/hijri-utils.ts
@@ -136,6 +136,14 @@ export default class MomentUtils extends DefaultMomentUtils {
     return date.clone().iYear(year);
   };
 
+  public getDate = (date: Moment) => {
+    return date.iDate();
+  };
+
+  public setDate = (date: Moment, year: number) => {
+    return date.clone().iDate(year);
+  };
+
   public getMeridiemText = (ampm: "am" | "pm") => {
     return ampm === "am"
       ? this.toIMoment().hours(2).format("A")
diff --git a/packages/jalaali/src/jalaali-utils.ts b/packages/jalaali/src/jalaali-utils.ts
@@ -135,6 +135,14 @@ export default class MomentUtils extends DefaultMomentUtils {
     return date.clone().jYear(year);
   };
 
+  public getDate = (date: Moment) => {
+    return date.jDate();
+  };
+
+  public setDate = (date: Moment, count: number) => {
+    return date.clone().jDate(count);
+  };
+
   public getMeridiemText = (ampm: "am" | "pm") => {
     return ampm === "am"
       ? this.toJMoment().hours(2).format("A")
diff --git a/packages/js-joda/src/js-joda-utils.ts b/packages/js-joda/src/js-joda-utils.ts
@@ -397,6 +397,14 @@ export default class JsJodaUtils implements IUtils<Temporal> {
     return months;
   }
 
+  getDate(date: Temporal): number {
+    return date.get(ChronoField.DAY_OF_MONTH);
+  }
+
+  setDate(date: Temporal, count: number): Temporal {
+    return date.with(ChronoField.DAY_OF_MONTH, count);
+  }
+
   getYear(date: Temporal): number {
     return date.get(ChronoField.YEAR);
   }
diff --git a/packages/luxon/src/luxon-utils.ts b/packages/luxon/src/luxon-utils.ts
@@ -278,6 +278,14 @@ export default class LuxonUtils implements IUtils<DateTime> {
     return value.set({ year });
   };
 
+  public getDate = (value: DateTime) => {
+    return value.get("day");
+  };
+
+  public setDate = (value: DateTime, day: number) => {
+    return value.set({ day });
+  };
+
   public mergeDateAndTime = (date: DateTime, time: DateTime) => {
     return date.set({
       second: time.second,
diff --git a/packages/moment/src/moment-utils.ts b/packages/moment/src/moment-utils.ts
@@ -325,6 +325,14 @@ export default class MomentUtils implements IUtils<defaultMoment.Moment> {
     return date.clone().set("year", year);
   };
 
+  public getDate = (date: Moment) => {
+    return date.get("date");
+  };
+
+  public setDate = (date: Moment, year: number) => {
+    return date.clone().set("date", year);
+  };
+
   public mergeDateAndTime = (date: Moment, time: Moment) => {
     return date.hour(time.hour()).minute(time.minute()).second(time.second());
   };
