Merge pull request #9 from radekBednarik/feat/vaccionations-deaths

dev: add vaccination deaths endpoint

Author: radekBednarik

deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedna/czech-covid-data-api-lib",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "exports": "./src/index.ts",
   "license": "MIT",
   "tasks": {

src/client/client.ts

@@ -5,6 +5,7 @@ import Deaths from "../deaths/deaths.ts";
 import VaccinationAggregated from "../vaccination/vaccination-aggregated.ts";
 import VaccinationPlaces from "../vaccination/vaccination-places.ts";
 import VaccinationFacilities from "../vaccination/vaccination-facilities.ts";
+import VaccinationDeaths from "../vaccination/vaccination-deaths.ts";
 
 /**
  * Represents single entrypoint for calling supported
@@ -29,6 +30,8 @@ export default class Client {
   public readonly vaccinationPlaces: VaccinationPlaces;
   /** @property vaccinationFacilities - represents instance of the VaccinationFacilities class */
   public readonly vaccinationFacilities: VaccinationFacilities;
+  /** @property vaccinationDeaths - represents instance of the VaccinationDeaths class */
+  public readonly vaccinationDeaths: VaccinationDeaths;
   /** @property instance - holds the singleton instance of the class */
   private static instance: Client;
 
@@ -53,6 +56,7 @@ export default class Client {
     this.vaccinationAggregated = new VaccinationAggregated(this.token);
     this.vaccinationPlaces = new VaccinationPlaces(this.token);
     this.vaccinationFacilities = new VaccinationFacilities(this.token);
+    this.vaccinationDeaths = new VaccinationDeaths(this.token);
   }
 
   /**

src/vaccination/vaccination-deaths.ts

@@ -0,0 +1,68 @@
+import ApiCallBuilder from "../builders/api-call-builder.ts";
+import type { GetApiError } from "../common/api.ts";
+
+export default class VaccinationDeaths {
+  private readonly token: string;
+
+  constructor(token: string) {
+    this.token = token;
+  }
+
+  public async getVaccinationDeathsV3({
+    page = 1,
+    itemsPerPage = 100,
+    properties,
+    datumBefore,
+    datumStrictlyBefore,
+    datumAfter,
+    datumStrictlyAfter,
+  }: {
+    page?: number;
+    itemsPerPage?: number;
+    properties?: string[];
+    datumBefore?: string;
+    datumStrictlyBefore?: string;
+    datumAfter?: string;
+    datumStrictlyAfter?: string;
+  } = {}): Promise<[VaccinationDeathsItemArr, null] | [null, GetApiError]> {
+    return await new ApiCallBuilder<VaccinationDeathsItemArr>({
+      token: this.token,
+    }).provideEndpoint("/api/v3/ockovani-umrti").provideQueryParams([
+      { page },
+      { itemsPerPage },
+      { properties },
+      { datumBefore },
+      { datumStrictlyBefore },
+      { datumAfter },
+      { datumStrictlyAfter },
+    ]).build();
+  }
+
+  public async getVaccinationDeathsOfIdV3(
+    { id }: { id: string },
+  ): Promise<[VaccinationDeathsItem, null] | [null, GetApiError]> {
+    return await new ApiCallBuilder<VaccinationDeathsItem>({
+      token: this.token,
+    }).provideEndpoint("/api/v3/ockovani-umrti").provideId(id).build();
+  }
+}
+
+export interface VaccinationDeathsItem {
+  id: string;
+  datum: string;
+  zemreli_celkem: number;
+  zemreli_bez_ockovani: number;
+  zemreli_bez_ockovani_relativni_pocet: number;
+  zemreli_bez_ockovani_vek_prumer: number;
+  zemreli_nedokoncene_ockovani: number;
+  zemreli_nedokoncene_ockovani_relativni_pocet: number;
+  zemreli_nedokoncene_ockovani_vek_prumer: number;
+  zemreli_dokoncene_ockovani: number;
+  zemreli_dokoncene_ockovani_relativni_pocet: number;
+  zemreli_dokoncene_ockovani_vek_prumer: number;
+  zemreli_posilujici_davka: number;
+  zemreli_posilujici_davka_relativni_pocet: number;
+  zemreli_posilujici_davka_vek_prumer: number;
+}
+
+export type VaccinationDeathsItemArr = VaccinationDeathsItem[];

src/vaccination/vaccination-deaths_test.ts

@@ -0,0 +1,49 @@
+import { beforeAll, describe, it } from "@std/testing/bdd";
+import { expect } from "@std/expect";
+import "@std/dotenv/load";
+import Client from "../index.ts";
+
+let client: Client;
+
+describe("vaccination deaths", () => {
+  beforeAll(() => {
+    client = Client.getInstance({ token: Deno.env.get("CLIENT_TOKEN") });
+  });
+
+  describe("deaths", () => {
+    it("happy - call endpoint with default params returns data", async () => {
+      const [data, err] = await client.vaccinationDeaths
+        .getVaccinationDeathsV3();
+
+      expect(err).toBeNull();
+      expect(data).toBeInstanceOf(Array);
+      expect(data).toHaveLength(100);
+    });
+
+    it("happy - call endpoint with custom params returns data", async () => {
+      const [data, err] = await client.vaccinationDeaths
+        .getVaccinationDeathsV3({
+          page: 100,
+          itemsPerPage: 2,
+          datumStrictlyAfter: "2022-01-01",
+        });
+
+      expect(err).toBeNull();
+      expect(data).toBeInstanceOf(Array);
+      expect(data).toHaveLength(2);
+    });
+  });
+
+  describe("deaths of id", () => {
+    it("happy - call endpoint with specific id returns data", async () => {
+      const [_data] = await client.vaccinationDeaths
+        .getVaccinationDeathsV3({ itemsPerPage: 1 });
+      const [data, err] = await client.vaccinationDeaths
+        // @ts-expect-error test
+        .getVaccinationDeathsOfIdV3({ id: _data[0].id });
+
+      expect(err).toBeNull();
+      expect(data).toHaveProperty("id");
+    });
+  });
+});