helper date, add helper

Author: andrechristikan

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ack-nestjs-boilerplate",
-  "version": "4.2.3",
+  "version": "4.2.4",
   "description": "Ack NestJs Boilerplate",
   "repository": {
     "type": "git",

src/common/helper/interfaces/helper.date-service.interface.ts

@@ -5,6 +5,8 @@ import {
     IHelperDateOptionsDiff,
     IHelperDateOptionsFormat,
     IHelperDateOptionsForward,
+    IHelperDateStartAndEnd,
+    IHelperDateStartAndEndDate,
 } from 'src/common/helper/interfaces/helper.interface';
 
 export interface IHelperDateService {
@@ -90,4 +92,8 @@ export interface IHelperDateService {
     startOfDay(date?: Date): Date;
 
     extractDate(date: string | Date | number): IHelperDateExtractDate;
+
+    getStartAndEndDate(
+        options?: IHelperDateStartAndEnd
+    ): IHelperDateStartAndEndDate;
 }

src/common/helper/interfaces/helper.interface.ts

@@ -41,6 +41,16 @@ export interface IHelperGeoRules extends IHelperGeoCurrent {
 }
 
 // Helper Date
+export interface IHelperDateStartAndEnd {
+    month?: number;
+    year?: number;
+}
+
+export interface IHelperDateStartAndEndDate {
+    startDate: Date;
+    endDate: Date;
+}
+
 export interface IHelperDateExtractDate {
     date: Date;
     day: string;

src/common/helper/services/helper.date.service.ts

@@ -13,6 +13,8 @@ import {
     IHelperDateOptionsFormat,
     IHelperDateOptionsForward,
     IHelperDateOptionsRoundDown,
+    IHelperDateStartAndEnd,
+    IHelperDateStartAndEndDate,
 } from 'src/common/helper/interfaces/helper.interface';
 
 @Injectable()
@@ -213,4 +215,35 @@ export class HelperDateService implements IHelperDateService {
 
         return mDate.toDate();
     }
+
+    getStartAndEndDate(
+        options?: IHelperDateStartAndEnd
+    ): IHelperDateStartAndEndDate {
+        const today = moment();
+        const todayMonth = Number(
+            today.format(ENUM_HELPER_DATE_FORMAT.ONLY_MONTH)
+        );
+        const todayYear = Number(
+            today.format(ENUM_HELPER_DATE_FORMAT.ONLY_YEAR)
+        );
+
+        // set month and year
+        const year = options?.year ?? todayYear;
+        const month = options?.month ?? todayMonth;
+
+        const date = moment(`${year}-${month}-02`);
+        let startDate: Date = date.startOf('year').toDate();
+        let endDate: Date = date.endOf('year').toDate();
+
+        if (options?.month) {
+            const date = moment(`${year}-${month}-02`);
+            startDate = date.startOf('month').toDate();
+            endDate = date.endOf('month').toDate();
+        }
+
+        return {
+            startDate,
+            endDate,
+        };
+    }
 }

test/unit/helper/helper.date.service.spec.ts

@@ -5,7 +5,10 @@ import {
     ENUM_HELPER_DATE_FORMAT,
 } from 'src/common/helper/constants/helper.enum.constant';
 import { HelperModule } from 'src/common/helper/helper.module';
-import { IHelperDateExtractDate } from 'src/common/helper/interfaces/helper.interface';
+import {
+    IHelperDateExtractDate,
+    IHelperDateStartAndEndDate,
+} from 'src/common/helper/interfaces/helper.interface';
 import { HelperDateService } from 'src/common/helper/services/helper.date.service';
 import configs from 'src/configs';
 
@@ -912,4 +915,60 @@ describe('HelperDateService', () => {
             expect(result).toBeTruthy();
         });
     });
+
+    describe('getStartAndEndDate', () => {
+        it('should be success', async () => {
+            const result: IHelperDateStartAndEndDate =
+                helperDateService.getStartAndEndDate();
+
+            jest.spyOn(
+                helperDateService,
+                'getStartAndEndDate'
+            ).mockReturnValueOnce(result);
+
+            const dt = helperDateService.create();
+            const start = helperDateService.startOfYear(dt);
+            const end = helperDateService.endOfYear(dt);
+
+            expect(result).toBeTruthy();
+            expect(`${result.startDate}`).toBe(`${start}`);
+            expect(`${result.endDate}`).toBe(`${end}`);
+        });
+
+        it('should be success options year', async () => {
+            const result: IHelperDateStartAndEndDate =
+                helperDateService.getStartAndEndDate({ year: 2022 });
+
+            jest.spyOn(
+                helperDateService,
+                'getStartAndEndDate'
+            ).mockReturnValueOnce(result);
+
+            const dt = helperDateService.create('2022-01-02');
+            const start = helperDateService.startOfYear(dt);
+            const end = helperDateService.endOfYear(dt);
+
+            expect(result).toBeTruthy();
+            expect(`${result.startDate}`).toBe(`${start}`);
+            expect(`${result.endDate}`).toBe(`${end}`);
+        });
+
+        it('should be success options year and month', async () => {
+            const result: IHelperDateStartAndEndDate =
+                helperDateService.getStartAndEndDate({ year: 2022, month: 2 });
+
+            jest.spyOn(
+                helperDateService,
+                'getStartAndEndDate'
+            ).mockReturnValueOnce(result);
+
+            const dt = helperDateService.create('2022-02-02');
+            const start = helperDateService.startOfMonth(dt);
+            const end = helperDateService.endOfMonth(dt);
+
+            expect(result).toBeTruthy();
+            expect(`${result.startDate}`).toBe(`${start}`);
+            expect(`${result.endDate}`).toBe(`${end}`);
+        });
+    });
 });