Define JSON for summary.

src/models/datasource.d.ts

@@ -0,0 +1,92 @@
+declare namespace ElectionDataSource {
+  /** ISO-formatted date, e.g. 2019-03-18T17:00:00.000Z */
+  type DateString = string
+
+  /**
+   * The summary file which contains all necessary data to render these sections.
+   *
+   * - Nationwide summary
+   * - Filtered summary
+   * - Election map
+   */
+  interface SummaryJSON {
+    updatedAt: DateString
+    zoneWinnerMap: ZoneWinnerMap
+    zoneStatsMap: ZoneStatsMap
+    partyScoreMap: PartyScoreMap
+  }
+
+  /**
+   * Information representing the highest-voted candidate for each district.
+   */
+  interface ZoneWinnerMap {
+    [provinceId: string]: {
+      [zoneNo: string]: {
+        /** Candidate number */
+        no: number
+        /** Score (number of votes) */
+        score: number
+        /** Party ID */
+        partyId: number
+      }
+    }
+  }
+
+  /**
+   * Information representing the number of people who voted in each zone.
+   *
+   * This is required for calculating:
+   * - how many people voted (in total, as well as in filtered views)
+   * - stats for overview page
+   */
+  interface ZoneStatsMap {
+    [provinceId: string]: {
+      [zoneId: string]: {
+        /** Number of election units */
+        units: number
+        /** Number of eligible voters */
+        eligible: number
+        /** Number of voters who voted = (goodVotes + badVotes) = (votesM + votesF) */
+        votesTotal: number
+        /** Number of men who voted */
+        votesM: number
+        /** Number of women who voted */
+        votesF: number
+        /** Number of votes that are valid */
+        goodVotes: number
+        /** Number of votes that are invalid */
+        badVotes: number
+        /** Number of "no" votes (also counted as a good vote) */
+        noVotes: number
+
+        // @todo #1 How do we determine when vote counting for a certain zone is finished?
+        //  The problem is, we don’t know beforehand how many ballots we received.
+        //  And it also seems like the official API doesn’t provide the information
+        //  on progress of each zone, or whether the counting has finished.
+        //  Need to check with the committee to see if the data will be available,
+        //  and if not, decide the appropriate adjustments to the app.
+        //
+        /** Vote counting progress, between 0-1 */
+        progress: number
+        /** True if counting finished */
+        finished: boolean
+      }
+    }
+  }
+
+  /**
+   * The total score each party received, aggregated nationwide.
+   *
+   * This is required for calculating:
+   * - Party list member count for each party.
+   */
+  interface PartyScoreMap {
+    [partyNo: string]: {
+      score: number
+    }
+  }
+
+  // @todo #1 Define JSON data format for each province.
+  //  This data should contain necessary information to display
+  //  - Per-zone summary
+}