Merge branch 'main' into add-surcharge-model

src/clockodo.test.ts

@@ -593,10 +593,34 @@ describe("Clockodo (instance)", () => {
       });
     });
 
+    describe("getHolidaysquota()", () => {
+      it("correctly builds getHolidaysquota() request", async () => {
+        const nockScope = nock(CLOCKODO_API)
+          .get("/holidaysquota?users_id=17")
+          .reply(200, {});
+
+        await clockodo.getHolidaysquota({ usersId: 17 });
+
+        nockScope.done();
+      });
+    });
+
+    describe("getHolidayscarry()", () => {
+      it("correctly builds getHolidayscarry() request", async () => {
+        const nockScope = nock(CLOCKODO_API)
+          .get("/holidayscarry?users_id=17&year=2028")
+          .reply(200, {});
+
+        await clockodo.getHolidayscarry({ usersId: 17, year: 2028 });
+
+        nockScope.done();
+      });
+    });
+
     describe("getSurchargeModel()", () => {
       it("correctly builds getSurchargeModel() request", async () => {
         const nockScope = nock(CLOCKODO_API)
-          .get("/v2/surcharges/7")
+          .get("/v2/surchargeModels/7")
           .reply(200, {});
 
         await clockodo.getSurchargeModel({ id: 7 });
@@ -608,7 +632,7 @@ describe("Clockodo (instance)", () => {
     describe("getSurchargeModels()", () => {
       it("correctly builds getSurchargeModels() request", async () => {
         const nockScope = nock(CLOCKODO_API)
-          .get("/v2/surcharges")
+          .get("/v2/surchargeModels")
           .reply(200, {});
 
         await clockodo.getSurchargeModels();
@@ -904,7 +928,7 @@ describe("Clockodo (instance)", () => {
         };
 
         const nockScope = nock(CLOCKODO_API)
-          .post("/v2/surcharges", expectedParameters)
+          .post("/v2/surchargeModels", expectedParameters)
           .reply(200, {});
 
         await clockodo.addSurchargeModel({
@@ -1080,7 +1104,7 @@ describe("Clockodo (instance)", () => {
         };
 
         const nockScope = nock(CLOCKODO_API)
-          .put("/v2/surcharges/365", mapRequestBody(entry))
+          .put("/v2/surchargeModels/365", mapRequestBody(entry))
           .reply(200, {});
 
         await clockodo.editSurchargeModel(entry);
@@ -1218,7 +1242,7 @@ describe("Clockodo (instance)", () => {
     describe("deleteSurchargeModel()", () => {
       it("correctly builds deleteSurchargeModel() request", async () => {
         const nockScope = nock(CLOCKODO_API)
-          .delete("/v2/surcharges/31")
+          .delete("/v2/surchargeModels/31")
           .reply(200, {});
 
         await clockodo.deleteSurchargeModel({ id: 31 });

src/clockodo.ts

@@ -41,6 +41,8 @@ import {
   WorkTimeChangeRequestStatus,
   WorkTimeDay,
 } from "./models/workTimes.js";
+import { HolidaysquotaRow } from "./models/holidaysquota.js";
+import { HolidayscarryRow } from "./models/holidayscarry.js";
 import { SurchargeModel } from "./models/surchargeModel.js";
 
 export class Clockodo {
@@ -337,13 +339,13 @@ export class Clockodo {
 
     const { id, ...remainingParams } = params;
 
-    return this.api.get("/v2/surcharges/" + id, remainingParams);
+    return this.api.get("/v2/surchargeModels/" + id, remainingParams);
   }
 
   async getSurchargeModels(
     params?: Params
   ): Promise<SurchargeModelsReturnType> {
-    return this.api.get("/v2/surcharges", params);
+    return this.api.get("/v2/surchargeModels", params);
   }
 
   async getUserReport<
@@ -473,7 +475,7 @@ export class Clockodo {
   ): Promise<SurchargeModelReturnType> {
     REQUIRED.checkRequired(params, REQUIRED.ADD_SURCHARGE_MODEL);
 
-    return this.api.post("/v2/surcharges", params);
+    return this.api.post("/v2/surchargeModels", params);
   }
 
   async startClock(
@@ -593,7 +595,7 @@ export class Clockodo {
 
     const { id } = params;
 
-    return this.api.put("/v2/surcharges/" + id, params);
+    return this.api.put("/v2/surchargeModels/" + id, params);
   }
 
   async deactivateCustomer(
@@ -645,7 +647,7 @@ export class Clockodo {
 
     const { id } = params;
 
-    return this.api.delete("/v2/surcharges/" + id);
+    return this.api.delete("/v2/surchargeModels/" + id);
   }
 
   async deleteAbsence(
@@ -816,6 +818,18 @@ export class Clockodo {
       remainingParams
     );
   }
+
+  async getHolidaysquota(
+    params?: Params<HolidaysquotaRowParams>
+  ): Promise<HolidaysquotaRowReturnType> {
+    return this.api.get("/holidaysquota", params);
+  }
+
+  async getHolidayscarry(
+    params?: Params<HolidayscarryRowParams>
+  ): Promise<HolidayscarryRowReturnType> {
+    return this.api.get("/holidayscarry", params);
+  }
 }
 
 export type AbsenceReturnType = { absence: Absence };
@@ -861,8 +875,10 @@ export type LumpsumServicesReturnType = {
 };
 export type UserReturnType = { user: User };
 export type UsersReturnType = { users: Array<User> };
-export type SurchargeModelReturnType = { surcharge: SurchargeModel };
-export type SurchargeModelsReturnType = { surcharges: Array<SurchargeModel> };
+export type SurchargeModelReturnType = { surchargeModel: SurchargeModel };
+export type SurchargeModelsReturnType = {
+  surchargeModels: Array<SurchargeModel>;
+};
 export type EntryReturnType = { entry: Entry };
 export type AddEntryReturnType = { entry: Entry; stopped?: Entry };
 export type EditEntryReturnType = {
@@ -1106,3 +1122,21 @@ export type AddWorkTimesChangeRequestReturnType =
        **/
       replacedChangeRequest: null;
     };
+
+export type HolidaysquotaRowReturnType = {
+  holidaysquota: Array<HolidaysquotaRow>;
+};
+export type HolidaysquotaRowParams = {
+  /** The user ID by which the holidays quota rows should be filtered */
+  usersId?: number;
+};
+
+export type HolidayscarryRowReturnType = {
+  holidayscarry: Array<HolidayscarryRow>;
+};
+export type HolidayscarryRowParams = {
+  /** The user ID by which the holidays carry rows should be filtered */
+  usersId?: number;
+  /** The year to which the data should be restricted to */
+  year?: number;
+};

src/mocks.ts

@@ -4,14 +4,15 @@ export * from "./models/absence.mocks.js";
 export * from "./models/customer.mocks.js";
 export * from "./models/entry.mocks.js";
 // export * from "./models/entryGroup.mocks.js";
-// export * from "./models/holidayscarry.mocks.js";
-// export * from "./models/holidaysquota.mocks.js";
+export * from "./models/holidayscarry.mocks.js";
+export * from "./models/holidaysquota.mocks.js";
 export * from "./models/lumpsumService.mocks.js";
 export * from "./models/nonbusinessDay.mocks.js";
 export * from "./models/project.mocks.js";
 // export * from "./models/service.mocks.js";
 export * from "./models/surchargeModel.mocks.js";
 export * from "./models/targethours.mocks.js";
+export * from "./models/team.mocks.js";
 export * from "./models/user.mocks.js";
 // export * from "./models/userReport.mocks.js";
 export * from "./models/worktimeRegulation.mocks.js";

src/models/__snapshots__/workTimes.mocks.test.ts.snap

@@ -20,6 +20,7 @@ Array [
         "type": 1,
       },
     ],
+    "createdAt": "2020-03-24T04:00:00Z",
     "date": "2020-03-24",
     "id": 0,
     "status": 1,
@@ -43,6 +44,7 @@ Array [
         "type": 2,
       },
     ],
+    "createdAt": "2020-04-14T04:00:00Z",
     "date": "2020-04-14",
     "id": 1,
     "status": 1,
@@ -56,6 +58,7 @@ Array [
         "type": 2,
       },
     ],
+    "createdAt": "2020-06-05T04:00:00Z",
     "date": "2020-06-05",
     "id": 2,
     "status": 1,
@@ -79,6 +82,7 @@ Array [
         "type": 1,
       },
     ],
+    "createdAt": "2020-09-11T04:00:00Z",
     "date": "2020-09-11",
     "id": 3,
     "status": 1,
@@ -97,6 +101,7 @@ Array [
         "type": 1,
       },
     ],
+    "createdAt": "2020-09-17T04:00:00Z",
     "date": "2020-09-17",
     "id": 4,
     "status": 1,

src/models/holidayscarry.mocks.ts

@@ -0,0 +1,21 @@
+import { faker } from "@faker-js/faker";
+import { HolidayscarryRow } from "./holidayscarry.js";
+
+type Options = {
+  count?: number;
+  yearMinMax?: [number, number];
+};
+
+export const createHolidayscarryMocks = ({
+  count = 1,
+  yearMinMax = [1900, 2024],
+}: Options = {}) => {
+  return Array.from({ length: count }, (): HolidayscarryRow => {
+    return {
+      usersId: 0,
+      year: faker.datatype.number({ min: yearMinMax[0], max: yearMinMax[1] }),
+      note: faker.datatype.boolean() ? faker.lorem.sentences(2) : null,
+      count: faker.datatype.number({ min: 0, max: 100 }),
+    };
+  });
+};

src/models/holidayscarry.ts

@@ -1,6 +1,11 @@
 export type HolidayscarryRow = {
+  /** The related employee's ID */
   usersId: number;
+  /**
+   * Year for which the holiday carryover applies
+   */
   year: number;
+  /** Day count */
   count: number;
   note: string | null;
 };

src/models/holidaysquota.mocks.ts

@@ -0,0 +1,35 @@
+import { faker } from "@faker-js/faker";
+import { HolidaysquotaRow } from "./holidaysquota.js";
+
+type Options = {
+  count?: number;
+  yearSinceMinMax?: [number, number];
+  yearUntilMinMax?: [number, number];
+};
+
+export const createHolidaysquotaMocks = ({
+  count = 1,
+  yearSinceMinMax = [2020, 2021],
+  yearUntilMinMax = [2021, 2022],
+}: Options = {}) => {
+  return Array.from({ length: count }, (_, index): HolidaysquotaRow => {
+    const id = index;
+
+    return {
+      id,
+      usersId: 0,
+      yearSince: faker.datatype.number({
+        min: yearSinceMinMax[0],
+        max: yearSinceMinMax[1],
+      }),
+      yearUntil: faker.datatype.boolean()
+        ? faker.datatype.number({
+            min: yearUntilMinMax[0],
+            max: yearUntilMinMax[1],
+          })
+        : null,
+      note: faker.datatype.boolean() ? faker.lorem.sentences(2) : null,
+      count: faker.datatype.number({ min: 0, max: 100 }),
+    };
+  });
+};

src/models/holidaysquota.ts

@@ -1,8 +1,17 @@
 export type HolidaysquotaRow = {
+  /** The ID of the holiday quota settings */
   id: number;
+  /** The related employee's ID */
   usersId: number;
+  /**
+   * Year from which on the holiday quota setting apply
+   */
   yearSince: number;
+  /**
+   * Year until which the holiday quota setting apply
+   */
   yearUntil: number | null;
+  /** Count of holidays */
   count: number;
   note: string | null;
 };

src/models/team.mocks.ts

@@ -0,0 +1,10 @@
+import { faker } from "@faker-js/faker";
+import { Team } from "./team.js";
+
+export const createTeamMocks = ({ count = 1 }: { count?: number }) =>
+  Array.from({ length: count }, (_, index): Team => {
+    return {
+      id: index,
+      name: faker.name.jobArea() + " Team",
+    };
+  });

src/models/workTimes.mocks.ts

@@ -1,6 +1,7 @@
 import { faker } from "@faker-js/faker";
 import {
   isoDateFromDateTime,
+  isoUtcDateTimeFromDateTime,
   isoUtcDateTimeFromTimestamp,
 } from "../lib/dateTime.js";
 import {
@@ -105,22 +106,26 @@ const createChangeRequest = ({
   date,
   id,
   status = WorkTimeChangeRequestStatus.Requested,
+  createdAt,
 }: {
   date: Date;
   id: number;
   status?: WorkTimeChangeRequestStatus;
+  createdAt?: Date;
 }): WorkTimeChangeRequest => {
   const changes = generateChangeRequestChanges({
     count: faker.datatype.number({ min: 1, max: 4 }),
     date,
   });
   const isoDate = isoDateFromDateTime(date);
+  const isoCreatedAt = isoUtcDateTimeFromDateTime(createdAt ?? new Date());
 
   return {
     id,
     date: isoDate,
     usersId: 0,
     changes,
+    createdAt: isoCreatedAt,
     ...(status === WorkTimeChangeRequestStatus.Declined
       ? {
           status: WorkTimeChangeRequestStatus.Declined,
@@ -152,6 +157,7 @@ export const createWorkTimeChangeRequestMocks = ({
     return createChangeRequest({
       date,
       id,
+      createdAt: date,
     });
   });
 };

src/models/workTimes.ts

@@ -21,6 +21,7 @@ export type WorkTimeChangeRequest = {
   id: number;
   date: IsoDate;
   usersId: number;
+  createdAt: IsoUtcDateTime;
   changes: Array<WorkTimeChangeRequestInterval>;
 } & (
   | {