WIP: BREAKING CHANGE: evaluated nonbusinessdays

src/clockodo.test.ts

@@ -571,8 +571,8 @@ describe("Clockodo (instance)", () => {
       });
     });
 
-    describe("getNonbusinessDays()", () => {
-      it("correctly builds getNonbusinessDays() request", async () => {
+    describe("getEvaluatedNonbusinessDays()", () => {
+      it("correctly builds getEvaluatedNonbusinessDays() request", async () => {
         const nockScope = nock(CLOCKODO_API)
           .get(
             "/nonbusinessdays?" +
@@ -583,19 +583,19 @@ describe("Clockodo (instance)", () => {
           )
           .reply(200, {});
 
-        await clockodo.getNonbusinessDays({
+        await clockodo.getEvaluatedNonbusinessDays({
           nonbusinessgroupsId: [123],
           year: 2021,
         });
 
         nockScope.done();
       });
 
-      it("throws an error when getNonbusinessDays() is missing param", async () => {
+      it("throws an error when getEvaluatedNonbusinessDays() is missing param", async () => {
         expect.assertions(1);
 
         return expect(
-          clockodo.getNonbusinessDays(
+          clockodo.getEvaluatedNonbusinessDays(
             // @ts-expect-error Year is missing
             { nonbusinessgroupsId: 123 }
           )

src/clockodo.ts

@@ -402,6 +402,12 @@ export class Clockodo {
   }
 
   async getNonbusinessDays(
+    params?: Params
+  ): Promise<NonbusinessDaysReturnType> {
+    return this.api.get("/v2/nonbusinessdays", params);
+  }
+
+  async getEvaluatedNonbusinessDays(
     params: Params<{
       nonbusinessgroupsId?:
         | NonbusinessGroup["id"]
@@ -411,7 +417,7 @@ export class Clockodo {
   ): Promise<NonbusinessDaysReturnType> {
     REQUIRED.checkRequired(params, REQUIRED.GET_NONBUSINESS_DAYS);
 
-    return this.api.get("/nonbusinessdays", params);
+    return this.api.get("/v2/nonbusinessdays/evaluated", params);
   }
 
   async getAggregatesUsersMe(

src/integration.test.ts

@@ -338,7 +338,7 @@ describe("Clockodo", () => {
     });
   });
 
-  describe("getNonbusinessGroups() / getNonbusinessDays()", () => {
+  describe("getNonbusinessGroups() / getEvaluatedNonbusinessDays()", () => {
     it("returns expected data format", async () => {
       const { nonbusinessgroups: nonbusinessGroups } =
         await clockodo.getNonbusinessGroups();
@@ -352,7 +352,7 @@ describe("Clockodo", () => {
       const [firstNonbusinessGroup] = nonbusinessGroups;
 
       const { nonbusinessdays: nonbusinessDays } =
-        await clockodo.getNonbusinessDays({
+        await clockodo.getEvaluatedNonbusinessDays({
           nonbusinessgroupsId: firstNonbusinessGroup.id,
           year: 2021,
         });

src/mocks.ts

@@ -9,6 +9,7 @@ export * from "./models/holidaysquota.mocks.js";
 export * from "./models/lumpsumService.mocks.js";
 export * from "./models/service.mocks.js";
 export * from "./models/nonbusinessDay.mocks.js";
+export * from "./models/nonbusinessGroup.mocks.js";
 export * from "./models/overtimecarry.mocks.js";
 export * from "./models/project.mocks.js";
 // export * from "./models/service.mocks.js";

src/models/nonbusinessDay.mocks.ts

@@ -32,12 +32,17 @@ export const createNonbusinessDayMocks = ({
     const name = faker.lorem.words();
     const isHalfDay = faker.datatype.number({ min: 0, max: 10 }) > 8;
 
+    const periodic = faker.datatype.boolean();
+
     return {
       date: isoDateFromDateTime(dateTime),
       id,
       nonbusinessgroupsId: 0,
       name,
       halfDay: isHalfDay,
+      surchargeSpecial: faker.datatype.boolean(),
+      periodic,
+      differentPerYear: periodic ? faker.datatype.boolean() : false,
     };
   });
 };

src/models/nonbusinessDay.ts

@@ -9,4 +9,10 @@ export type NonbusinessDay = {
   name: string;
   /** It is half a nonbusiness day */
   halfDay: boolean;
+  /** It is a special nonbusiness day */
+  surchargeSpecial: boolean;
+  /** It is a recurring nonbusiness day */
+  periodic: boolean;
+  /** Varies from year per year */
+  differentPerYear: boolean;
 };

src/models/nonbusinessGroup.mocks.ts

@@ -0,0 +1,15 @@
+import { faker } from "@faker-js/faker";
+import { NonbusinessGroup } from "./nonbusinessGroup.js";
+
+export const createNonbusinessGroupMocks = ({
+  count = 1,
+}: {
+  count?: number;
+  dateBetween?: readonly [Date, Date];
+}) =>
+  Array.from({ length: count }, (_, index): NonbusinessGroup => {
+    return {
+      id: index,
+      name: faker.commerce.productName(),
+    };
+  });