elections-types 1.0.91 → 1.0.93

package/src/types/Tweet.ts

@@ -2,11 +2,11 @@ export class Tweet {
     readonly tweet_id : string
     readonly username : string
     readonly url : string
-    readonly tweet_time : string
-    readonly tweet_content : string
-    readonly quote? : string
+    readonly publish_time : string
+    // readonly tweet_content : string
+    // readonly quote? : string
     readonly html : string
-    readonly text : string
+    // readonly text : string
 
     constructor(tweet : Tweet) {
         if (!Tweet.is(tweet)) {
@@ -15,11 +15,11 @@ export class Tweet {
         this.tweet_id = tweet.tweet_id
         this.username = tweet.username
         this.url = tweet.url
-        this.tweet_time = tweet.tweet_time
-        this.tweet_content = tweet.tweet_content
-        this.quote = tweet.quote
+        this.publish_time = tweet.publish_time
+        // this.tweet_content = tweet.tweet_content
+        // this.quote = tweet.quote
         this.html = tweet.html
-        this.text = tweet.text
+        // this.text = tweet.text
     }
 
     static is(tweet : any) : tweet is Tweet {
@@ -28,11 +28,11 @@ export class Tweet {
             typeof tweet.tweet_id === "string" &&
             typeof tweet.username === "string" &&
             typeof tweet.url === "string" &&
-            typeof tweet.tweet_time === "string" &&
-            typeof tweet.tweet_content === "string" &&
-            (tweet.quote === undefined || typeof tweet.quote === "string") &&
-            typeof tweet.html === "string" &&
-            (typeof tweet.text === "string")
+            typeof tweet.publish_time === "string" &&
+            // typeof tweet.tweet_content === "string" &&
+            // (tweet.quote === undefined || typeof tweet.quote === "string") &&
+            typeof tweet.html === "string"
+            // (typeof tweet.text === "string")
         )
     }
 }

package/src/types/UserFederalElection.ts

@@ -0,0 +1,31 @@
+import { FederalElectionID, is_federal_election_id } from "./FederalElection"
+import { is_long_form_type_id, LongFormTypeID } from "./FormTypeID"
+
+export class UserFederalElection {
+    readonly user_id : string
+    readonly federal_election_id : FederalElectionID
+    readonly candidate_display : Record<string, number>
+    readonly notify : boolean
+
+    // readonly [x : string] : any
+
+    constructor(user_federal_election : UserFederalElection) {
+        if (!UserFederalElection.is(user_federal_election)) {
+            throw Error("Invalid Input.")
+        }
+        this.user_id = user_federal_election.user_id
+        this.federal_election_id = user_federal_election.federal_election_id
+        this.candidate_display = user_federal_election.candidate_display
+        this.notify = user_federal_election.notify
+    }
+
+    static is(user_federal_election : any) : user_federal_election is UserFederalElection {
+        return (
+            user_federal_election !== undefined &&
+            typeof user_federal_election.user_id === "string" &&
+            is_federal_election_id(user_federal_election.federal_election_id) &&
+            Object.entries(user_federal_election.candidate_display).every(([key, value]) => (typeof key === "string" && typeof value === "number")) &&
+            typeof user_federal_election.notify === "boolean"
+        )
+    }
+}

package/src/types/Candidate.ts

@@ -1,118 +0,0 @@
-import { Committee, CommitteeAux } from "./Committee"
-import { ElectionID, is_election_id, is_office_id, OfficeID } from "./Election"
-import { Expenditure, ExpenditureAux } from "./Expenditure"
-import { FederalElectionF3File } from "./FederalElectionF3File"
-import { is_state_id, StateID } from "./State"
-
-export class ActivityIndex {
-    readonly news_index : number
-    readonly twitter_index : number
-    readonly total_index : number
-
-    constructor(activity_index : any) {
-        if (!ActivityIndex.is(activity_index)) {
-            throw Error("Invalid input.")
-        }
-        this.news_index = activity_index.news_index
-        this.twitter_index = activity_index.twitter_index
-        this.total_index = activity_index.total_index
-    }
-
-    static is(activity_index : any) : activity_index is ActivityIndex {
-        return (
-            activity_index !== undefined &&
-            typeof activity_index.news_index === "number" &&
-            typeof activity_index.twitter_index === "number" &&
-            typeof activity_index.total_index === "number"
-        )
-    }
-}
-
-export class Candidate {
-    readonly candidate_id : string
-    readonly fec_name : string
-    readonly office_id : OfficeID
-    readonly state_id : StateID
-    readonly district? : number
-    readonly election_id : ElectionID
-    readonly party_id? : string
-    readonly active? : boolean
-    readonly status? : string
-    readonly federal_election_file_id? : number
-    readonly ballotpedia_name? : string
-    readonly ballotpedia_url? : string
-    readonly ballotpedia_data? : Record<string, any>
-    readonly activity_index? : ActivityIndex
-    // readonly urls? : string[]
-    // readonly previews? : string[]
-    [x : string] : any
-
-
-    constructor(candidate : Candidate) {
-        if (!Candidate.is(candidate)) {
-            throw Error("Invalid input.")
-        }
-        this.candidate_id = candidate.candidate_id
-        this.fec_name = candidate.fec_name
-        this.office_id = candidate.office_id
-        this.state_id = candidate.state_id
-        this.district = candidate.district
-        this.election_id = candidate.election_id
-        this.party_id = candidate.party_id
-        this.active = candidate.active
-        this.status = candidate.status
-        this.federal_election_file_id = candidate.federal_election_file_id
-        this.ballotpedia_name = candidate.ballotpedia_name
-        this.ballotpedia_url = candidate.ballotpedia_url
-        this.ballotpedia_data = candidate.ballotpedia_data
-        this.activity_index = candidate.activity_index !== undefined ? new ActivityIndex(candidate.activity_index) : undefined
-    }
-
-    static is(candidate : any) : candidate is Candidate {
-        return (
-            candidate !== undefined &&
-            typeof candidate.candidate_id === "string" &&
-            typeof candidate.fec_name === "string" &&
-            is_office_id(candidate.office_id) &&
-            is_state_id(candidate.state_id) &&
-            (candidate.district === undefined || typeof candidate.district === "number") &&
-            is_election_id(candidate.election_id) &&
-            (candidate.party_id === undefined || typeof candidate.party_id === "string") &&
-            (candidate.active === undefined || typeof candidate.active === "boolean") &&
-            (candidate.status === undefined || typeof candidate.status === "string") &&
-            (candidate.federal_election_file_id === undefined || typeof candidate.federal_election_file_id === "number" && !isNaN(candidate.federal_election_file_id)) &&
-            (candidate.ballotpedia_name === undefined || typeof candidate.ballotpedia_name === "string") &&
-            (candidate.ballotpedia_url === undefined || typeof candidate.ballotpedia_url === "string") &&
-            (candidate.ballotpedia_data === undefined || typeof candidate.ballotpedia_data === "object" && Object.keys(candidate.ballotpedia_data).map((key : any) => typeof key === "string")) &&
-            (candidate.activity_index === undefined || ActivityIndex.is(candidate.activity_index))
-        )
-    }
-}
-
-export class CandidateAux extends Candidate {
-    readonly committees : CommitteeAux[]
-    readonly federal_election_f3_files : FederalElectionF3File[]
-    readonly expenditures : ExpenditureAux[]
-
-    constructor(candidate : any) {
-        if (!CandidateAux.is(candidate)) {
-            throw Error("Invalid input.")
-        }
-        super(candidate)
-        this.committees = candidate.committees
-        this.federal_election_f3_files = candidate.federal_election_f3_files
-        this.expenditures = candidate.expenditures
-    }
-
-    static is(candidate : any) : candidate is CandidateAux {
-        return (
-            Candidate.is(candidate) &&
-            Array.isArray(candidate.committees) &&
-            candidate.committees.every(CommitteeAux.is) &&
-            Array.isArray(candidate.federal_election_f3_files) &&
-            candidate.federal_election_f3_files.every(FederalElectionF3File.is) &&
-            Array.isArray(candidate.expenditures) &&
-            candidate.expenditures.every(ExpenditureAux.is)
-        )
-    }
-}

package/src/types/CandidateCommittee.ts

@@ -1,42 +0,0 @@
-import { Committee, CommitteeAux } from "./Committee"
-
-export class CandidateCommittee {
-    readonly candidate_id : string
-    readonly committee_id : string
-    [x : string] : any
-
-    constructor(candidate_committee : CandidateCommittee) {
-        if (!CandidateCommittee.is(candidate_committee)) {
-            throw Error("Invalid input.")
-        }
-        this.candidate_id = candidate_committee.candidate_id
-        this.committee_id = candidate_committee.committee_id
-    }
-
-    static is(candidate_committee : any) : candidate_committee is CandidateCommittee {
-        return (
-            candidate_committee !== undefined &&
-            typeof candidate_committee.candidate_id === "string" &&
-            typeof candidate_committee.committee_id === "string"
-        )
-    }
-}
-
-// export class CandidateCommitteeAux extends CandidateCommittee {
-//     readonly committee : CommitteeAux
-
-//     constructor(candidate_committee : any) {
-//         if (!CandidateCommitteeAux.is(candidate_committee)) {
-//             throw Error("Invalid input.")
-//         }
-//         super(candidate_committee)
-//         this.committee = candidate_committee.committee
-//     }
-
-//     static is(candidate_committee : any) : candidate_committee is CandidateCommitteeAux {
-//         return (
-//             CandidateCommittee.is(candidate_committee) &&
-//             CommitteeAux.is(candidate_committee.committee)
-//         )
-//     }
-// }

package/src/types/Committee.ts

@@ -1,84 +0,0 @@
-import { Candidate } from "./Candidate"
-import { CandidateCommittee } from "./CandidateCommittee"
-import { FederalElectionF3File } from "./FederalElectionF3File"
-
-export const designations = ["P", "A", "U", "J", "D", "B"] as const
-
-export type CommitteeDesignation = typeof designations[number]
-
-export function is_committee_designation(designation : any) : designation is CommitteeDesignation {
-    return designations.includes(designation)
-}
-
-export class Committee {
-    readonly committee_id : string
-    readonly name : string
-    readonly url? : string
-    readonly designation? : CommitteeDesignation
-    readonly federal_election_file_id? : number
-    readonly jfp_committee_ids? : string[]
-    readonly jfr_committee_ids : string[]
-    readonly aff_committee_ids : string[]
-    readonly [x : string] : any
-
-    constructor(committee : Committee) {
-        if (!Committee.is(committee)) {
-            throw Error("Invalid input.")
-        }
-        this.committee_id = committee.committee_id
-        this.name = committee.name
-        this.url = committee.url
-        this.designation = committee.designation
-        this.federal_election_file_id = committee.federal_election_file_id
-        this.jfp_committee_ids = committee.jfp_committee_ids
-        this.jfr_committee_ids = committee.jfr_committee_ids
-        this.aff_committee_ids = committee.aff_committee_ids
-    }
-
-    static is(committee : any) : committee is Committee {
-        return (
-            committee !== undefined &&
-            typeof committee.committee_id === "string" &&
-            typeof committee.name === "string" &&
-            (committee.url === undefined || typeof committee.url === "string") &&
-            (committee.designation === undefined || is_committee_designation(committee.designation)) &&
-            (committee.federal_election_file_id === undefined || typeof committee.federal_election_file_id === "number" && !isNaN(committee.federal_election_file_id)) &&
-            (committee.jfp_committee_ids === undefined || Array.isArray(committee.jfp_committee_ids) && committee.jfp_committee_ids.every((committee_id : any) => typeof committee_id === "string")) &&
-            (Array.isArray(committee.jfr_committee_ids) && committee.jfr_committee_ids.every((committee_id : any) => typeof committee_id === "string")) &&
-            (Array.isArray(committee.aff_committee_ids) && committee.aff_committee_ids.every((committee_id : any) => typeof committee_id === "string"))
-        )
-    }
-}
-
-export class CommitteeAux extends Committee {
-    readonly candidates : Candidate[]
-    readonly federal_election_f3_files : FederalElectionF3File[]
-    readonly jfp_committees? : Committee[]
-    readonly jfr_committees : Committee[]
-    readonly aff_committees : Committee[]
-
-    constructor(committee : any) {
-        if (!CommitteeAux.is(committee)) {
-            throw Error("Invalid input.")
-        }
-        super(committee)
-        this.candidates = committee.candidates
-        this.federal_election_f3_files = committee.federal_election_f3_files
-        this.jfp_committees = committee.jfp_committees
-        this.jfr_committees = committee.jfr_committees
-        this.aff_committees = committee.aff_committees
-    }
-
-    static is(committee : any) : committee is CommitteeAux {
-        return (
-            Committee.is(committee) &&
-            Array.isArray(committee.candidates) &&
-            committee.candidates.every(Candidate.is) &&
-            Array.isArray(committee.federal_election_f3_files) &&
-            committee.federal_election_f3_files.every(FederalElectionF3File.is) &&
-            (committee.jfp_committees === undefined || Array.isArray(committee.jfp_committees) && committee.jfp_committees.every(Committee.is)) &&
-            (Array.isArray(committee.jfr_committees) && committee.jfr_committees.every(Committee.is)) &&
-            (Array.isArray(committee.aff_committees) && committee.aff_committees.every(Committee.is))
-        )
-    }
-}

package/src/types/Election.ts

@@ -1,105 +0,0 @@
-import { Candidate, CandidateAux } from "./Candidate"
-import { Committee, CommitteeAux } from "./Committee"
-import { ExpenditureAux } from "./Expenditure"
-import { is_state_id, state_ids, StateID } from "./State"
-
-const office_ids = ["H", "S", "P"] as const
-
-export type OfficeID = typeof office_ids[number]
-
-export function is_office_id(office_id : any) : office_id is OfficeID {
-    return office_ids.includes(office_id)
-}
-
-const state_ids_without_district : StateID[] = ["AK", "DE", "ND", "SD", "VT", "WY"]
-
-export type ElectionID = string
-
-export function is_election_id(election_id : any) : election_id is ElectionID {
-    const parts = election_id.split("-")
-    const year = Number(parts[0])
-    const office_id = parts[1]
-    const state_id = parts[2]
-    const district = Number(parts[3])
-    if (!(Number.isInteger(year) && year > 1700 && year < 3000 && is_office_id(office_id))) {
-        return false
-    }
-    if (office_id === "P" && parts.length === 2) {
-        return true
-    }
-    if (!is_state_id(state_id)) {
-        return false
-    }
-    if (office_id === "S" && parts.length === 3) {
-        return true
-    }
-    if (office_id !== "H") {
-        return false
-    }
-    if (!(state_ids_without_district.includes(state_id) && parts.length === 3 || parts.length === 4)) {
-        return false
-    }
-    if (!Number.isInteger(district) && district < 100) {
-        return false
-    }
-    return true
-}
-
-export class Election {
-    readonly election_id : ElectionID
-    readonly name : string
-    readonly office_id : OfficeID
-    readonly state_id? : StateID
-    readonly district? : number
-    readonly [x : string] : any
-
-    constructor(election : Election) {
-        if (!Election.is(election)) {
-            throw Error("Invalid input.")
-        }
-        this.election_id = election.election_id
-        this.name = election.name
-        this.office_id = election.office_id
-        this.state_id = election.state_id
-        this.district = election.district
-    }
-
-    static is(election : any) : election is Election {
-        return (
-            election !== undefined &&
-            is_election_id(election.election_id) &&
-            typeof election.name === "string" &&
-            is_office_id(election.office_id) &&
-            (election.state_id === undefined || is_state_id(election.state_id)) &&
-            (election.district === undefined || typeof election.district === "number")
-        )
-    }
-}
-
-export class ElectionAux extends Election {
-    readonly candidates : CandidateAux[]
-    readonly committees : CommitteeAux[]
-    readonly expenditures : ExpenditureAux[]
-
-    constructor(election : any) {
-        if (!ElectionAux.is(election)) {
-            throw Error("Invalid input.")
-        }
-        super(election)
-        this.candidates = election.candidates.map(candidate => new CandidateAux(candidate))
-        this.committees = election.committees.map(committee => new CommitteeAux(committee))
-        this.expenditures = election.expenditures.map(expenditure => new ExpenditureAux(expenditure))
-    }
-
-    static is(election : any) : election is ElectionAux {
-        return (
-            Election.is(election) &&
-            Array.isArray(election.candidates) &&
-            election.candidates.every(CandidateAux.is) &&
-            Array.isArray(election.committees) &&
-            election.committees.every(CommitteeAux.is) &&
-            Array.isArray(election.expenditures) &&
-            election.expenditures.every(ExpenditureAux.is)
-        )
-    }
-}

package/src/types/Expenditure.ts

@@ -1,82 +0,0 @@
-import { Candidate } from "./Candidate"
-import { Committee } from "./Committee"
-import { ElectionID, is_election_id } from "./Election"
-import { FederalElectionF24File } from "./FederalElectionF24File"
-
-export class Expenditure {
-    readonly federal_election_file_id : number
-    readonly expenditure_id : string
-    readonly committee_id : string
-    readonly date : string
-    readonly payee : string
-    readonly election_stage : string
-    readonly election_id : ElectionID
-    readonly candidate_id : string
-    readonly amount : number
-    readonly cumulative_amount : number
-    readonly purpose : string
-    readonly is_support : boolean
-    readonly [x : string] : any
-        
-    constructor(expenditure : any) {
-        if (!Expenditure.is(expenditure)) {
-            throw Error("Invalid input.")
-        }
-        this.federal_election_file_id = expenditure.federal_election_file_id
-        this.expenditure_id = expenditure.expenditure_id
-        this.committee_id = expenditure.committee_id
-        this.date = expenditure.date
-        this.payee = expenditure.payee
-        this.election_stage = expenditure.election_stage
-        this.election_id = expenditure.election_id
-        this.candidate_id = expenditure.candidate_id
-        this.amount = expenditure.amount
-        this.cumulative_amount = expenditure.cumulative_amount
-        this.purpose = expenditure.purpose
-        this.is_support = expenditure.is_support
-    }
-
-    static is(expenditure : any) : expenditure is Expenditure {
-        return (
-            expenditure !== undefined &&
-            typeof expenditure.federal_election_file_id === "number" &&
-            typeof expenditure.expenditure_id === "string" &&
-            typeof expenditure.committee_id === "string" &&
-            typeof expenditure.date === "string" &&
-            typeof expenditure.payee === "string" &&
-            typeof expenditure.election_stage === "string" &&
-            is_election_id(expenditure.election_id) &&
-            typeof expenditure.candidate_id === "string" &&
-            typeof expenditure.amount === "number" &&
-            typeof expenditure.cumulative_amount === "number" &&
-            typeof expenditure.purpose === "string" &&
-            typeof expenditure.is_support === "boolean"
-        )
-    }
-
-}
-
-export class ExpenditureAux extends Expenditure {
-    readonly candidate : Candidate
-    readonly committee : Committee
-    readonly federal_election_f24_file : FederalElectionF24File
-
-    constructor(expenditure : any) {
-        if (!ExpenditureAux.is(expenditure)) {
-            throw Error("Invalid input.")
-        }
-        super(expenditure)
-        this.candidate = new Candidate(expenditure.candidate)
-        this.committee = new Committee(expenditure.committee)
-        this.federal_election_f24_file = new FederalElectionF24File(expenditure.federal_election_f24_file)
-    }
-
-    static is(expenditure : any) : expenditure is ExpenditureAux {
-        return (
-            Expenditure.is(expenditure) &&
-            Candidate.is(expenditure.candidate) &&
-            Committee.is(expenditure.committee) &&
-            FederalElectionF24File.is(expenditure.federal_election_f24_file)
-        )
-    }
-}

package/src/types/UserElection.ts

@@ -1,31 +0,0 @@
-import { ElectionID, is_election_id } from "./Election"
-import { is_long_form_type_id, LongFormTypeID } from "./FormTypeID"
-
-export class UserElection {
-    readonly user_id : string
-    readonly election_id : ElectionID
-    readonly candidate_display : Record<string, number>
-    readonly notify : boolean
-
-    // readonly [x : string] : any
-
-    constructor(user_election : UserElection) {
-        if (!UserElection.is(user_election)) {
-            throw Error("Invalid Input.")
-        }
-        this.user_id = user_election.user_id
-        this.election_id = user_election.election_id
-        this.candidate_display = user_election.candidate_display
-        this.notify = user_election.notify
-    }
-
-    static is(user_election : any) : user_election is UserElection {
-        return (
-            user_election !== undefined &&
-            typeof user_election.user_id === "string" &&
-            is_election_id(user_election.election_id) &&
-            Object.entries(user_election.candidate_display).every(([key, value]) => (typeof key === "string" && typeof value === "number")) &&
-            typeof user_election.notify === "boolean"
-        )
-    }
-}