elections-types 1.0.14 → 1.0.15

package/dist/src/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./types/APIError.js";
+export * from "./types/Article.js";
 export * from "./types/Candidate.js";
 export * from "./types/Committee.js";
 export * from "./types/Donation.js";
@@ -8,3 +9,4 @@ export * from "./types/FormTypeID.js";
 export * from "./types/State.js";
 export * from "./types/Tweet.js";
 export * from "./types/User.js";
+export * from "./types/Video.js";

package/dist/src/index.js

@@ -1,4 +1,5 @@
 export * from "./types/APIError.js";
+export * from "./types/Article.js";
 export * from "./types/Candidate.js";
 export * from "./types/Committee.js";
 export * from "./types/Donation.js";
@@ -8,3 +9,4 @@ export * from "./types/FormTypeID.js";
 export * from "./types/State.js";
 export * from "./types/Tweet.js";
 export * from "./types/User.js";
+export * from "./types/Video.js";

package/dist/src/types/Article.d.ts

@@ -0,0 +1,13 @@
+export declare class Article {
+    readonly article_id: string;
+    readonly publish_date: string;
+    readonly hash: string;
+    readonly title: string;
+    readonly publisher: string;
+    readonly domain: string;
+    readonly url: string;
+    readonly fetch_time: string;
+    readonly s3_filename?: string;
+    constructor(article: any);
+    static is(article: any): article is Article;
+}

package/dist/src/types/Article.js

@@ -0,0 +1,37 @@
+export class Article {
+    article_id;
+    publish_date;
+    hash;
+    title;
+    publisher;
+    domain;
+    url;
+    fetch_time;
+    s3_filename;
+    constructor(article) {
+        if (!Article.is(article)) {
+            throw Error("Invalid input.");
+        }
+        this.article_id = article.article_id;
+        this.publish_date = article.publish_date;
+        this.hash = article.hash;
+        this.title = article.title;
+        this.publisher = article.publisher;
+        this.domain = article.domain;
+        this.url = article.url;
+        this.fetch_time = article.fetch_time;
+        this.s3_filename = article.s3_filename;
+    }
+    static is(article) {
+        return (article !== undefined &&
+            typeof article.article_id === "string" &&
+            typeof article.publish_date === "string" &&
+            typeof article.hash === "string" &&
+            typeof article.title === "string" &&
+            typeof article.publisher === "string" &&
+            typeof article.domain === "string" &&
+            typeof article.url === "string" &&
+            typeof article.fetch_time === "string" &&
+            (article.s3_filename === undefined || typeof article.s3_filename === "string"));
+    }
+}

package/dist/src/types/Candidate.d.ts

@@ -1 +1,30 @@
-export {};
+import { ElectionID, OfficeID } from "./Election.js";
+import { StateID } from "./State.js";
+export declare class ActivityIndex {
+    readonly news_index: number;
+    readonly twitter_index: number;
+    readonly total_index: number;
+    constructor(activity_index: any);
+    static is(activity_index: any): activity_index is ActivityIndex;
+}
+export declare class Candidate {
+    readonly candidate_id: string;
+    readonly fec_name: string;
+    readonly office_id: OfficeID;
+    readonly state_id: StateID;
+    readonly election_id: ElectionID;
+    readonly party_id: string;
+    readonly active: boolean;
+    readonly status: string;
+    readonly file_number: number;
+    readonly committee_ids?: string[];
+    readonly principal_committee_ids?: string[];
+    readonly authorized_committee_ids?: string[];
+    readonly sponsor_committee_ids?: string[];
+    readonly expenditure_ids?: string[];
+    readonly ballotpedia_name?: string;
+    readonly ballotpedia_url?: string;
+    readonly ballotpedia_data?: Record<string, any>;
+    constructor(candidate: any);
+    static is(candidate: any): candidate is Candidate;
+}

package/dist/src/types/Candidate.js

@@ -1,50 +1,84 @@
-// import { ElectionID, OfficeID } from "./Election.js"
-// import { StateID } from "./State.js"
-export {};
-// export class Candidate {
-//     readonly candidate_id : string
-//     readonly fec_name : string
-//     readonly office_id : OfficeID
-//     readonly state_id : StateID
-//     readonly election_id : ElectionID
-//     readonly party_id : string
-//     readonly active : boolean
-//     readonly status : boolean
-//     constructor(candidate : any) {
-//         if (!Candidate.is(candidate)) {
-//             throw Error("Invalid input.")
-//         }
-//         this.office_id = candidate.office_id
-//         this.number = candidate.number
-//         this.scout_id = candidate.scout_id
-//         this.name = candidate.name
-//         this.active = candidate.active
-//         this.state_id = candidate.state_id
-//         this.district = candidate.district
-//         this.party_id = candidate.party_id
-//         this.tone_description_refresh = candidate.tone_description_refresh
-//         this.jurisdiction_ids = candidate.jurisdiction_ids
-//         this.sub_scout_ids = candidate.sub_scout_ids
-//         this.office_class_id = candidate.office_class_id
-//         this.office_name = candidate.office_name
-//     }
-//     static is(candidate : any) : candidate is Candidate {
-//         return (
-//             candidate !== undefined &&
-//             typeof candidate.office_id === "string" &&
-//             typeof candidate.number === "string" &&
-//             typeof candidate.scout_id === "string" &&
-//             typeof candidate.name === "string" &&
-//             typeof candidate.active === "boolean" &&
-//             (candidate.state_id === undefined || is_state_id(candidate.state_id)) &&
-//             (candidate.district === undefined || typeof candidate.district === "number") &&
-//             is_party_id(candidate.party_id) &&
-//             typeof candidate.tone_description_refresh === "boolean" &&
-//             Array.isArray(candidate.jurisdiction_ids) &&
-//             candidate.jurisdiction_ids.every((jurisdiction_id : any) => typeof jurisdiction_id === "number") &&
-//             (candidate.sub_scout_ids === undefined || Array.isArray(candidate.sub_scout_ids) && candidate.sub_scout_ids.every((sub_scout_id : any) => typeof sub_scout_id === "string")) &&
-//             is_office_class_id(candidate.office_class_id) &&
-//             (candidate.office_name === undefined || typeof candidate.office_name === "string")
-//         )
-//     }
-// }
+import { is_election_id, is_office_id } from "./Election.js";
+import { is_state_id } from "./State.js";
+export class ActivityIndex {
+    news_index;
+    twitter_index;
+    total_index;
+    constructor(activity_index) {
+        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) {
+        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 {
+    candidate_id;
+    fec_name;
+    office_id;
+    state_id;
+    election_id;
+    party_id;
+    active;
+    status;
+    file_number;
+    committee_ids;
+    principal_committee_ids;
+    authorized_committee_ids;
+    sponsor_committee_ids;
+    expenditure_ids;
+    ballotpedia_name;
+    ballotpedia_url;
+    ballotpedia_data;
+    // readonly urls? : string[]
+    // readonly previews? : string[]
+    constructor(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.election_id = candidate.election_id;
+        this.party_id = candidate.party_id;
+        this.active = candidate.active;
+        this.status = candidate.status;
+        this.file_number = candidate.file_number;
+        this.committee_ids = candidate.committee_ids;
+        this.principal_committee_ids = candidate.principal_committee_ids;
+        this.authorized_committee_ids = candidate.authorized_committee_ids;
+        this.sponsor_committee_ids = candidate.sponsor_committee_ids;
+        this.expenditure_ids = candidate.expenditure_ids;
+        this.ballotpedia_name = candidate.ballotpedia_name;
+        this.ballotpedia_url = candidate.ballotpedia_url;
+        this.ballotpedia_data = candidate.ballotpedia_data;
+    }
+    static 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) &&
+            is_election_id(candidate.election_id) &&
+            typeof candidate.party_id === "string" &&
+            typeof candidate.active === "boolean" &&
+            typeof candidate.status === "string" &&
+            typeof candidate.file_number === "number" &&
+            (candidate.committee_id === undefined || Array.isArray(candidate.committee_id) && candidate.committee_id.map((committee_id) => typeof committee_id === "string")) &&
+            (candidate.principal_committee_ids === undefined || Array.isArray(candidate.principal_committee_ids) && candidate.principal_committee_ids.map((committee_id) => typeof committee_id === "string")) &&
+            (candidate.authorized_committee_ids === undefined || Array.isArray(candidate.authorized_committee_ids) && candidate.authorized_committee_ids.map((committee_id) => typeof committee_id === "string")) &&
+            (candidate.sponsor_committee_ids === undefined || Array.isArray(candidate.sponsor_committee_ids) && candidate.sponsor_committee_ids.map((committee_id) => typeof committee_id === "string")) &&
+            (candidate.expenditure_ids === undefined || Array.isArray(candidate.expenditure_ids) && candidate.expenditure_ids.map((committee_id) => typeof committee_id === "string")) &&
+            (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) => typeof key === "string")));
+    }
+}

package/dist/src/types/Video.d.ts

@@ -0,0 +1,14 @@
+export declare class Video {
+    readonly video_id: string;
+    readonly publish_time: string;
+    readonly hash: string;
+    readonly channel_id: string;
+    readonly channel_name: string;
+    readonly title: string;
+    readonly description: string;
+    readonly tags?: string[];
+    readonly duration: number;
+    readonly fetch_time: string;
+    constructor(video: any);
+    static is(video: any): video is Video;
+}

package/dist/src/types/Video.js

@@ -0,0 +1,40 @@
+export class Video {
+    video_id;
+    publish_time;
+    hash;
+    channel_id;
+    channel_name;
+    title;
+    description;
+    tags;
+    duration;
+    fetch_time;
+    constructor(video) {
+        if (!Video.is(video)) {
+            throw Error("Invalid input.");
+        }
+        this.video_id = video.video_id;
+        this.publish_time = video.publish_time;
+        this.hash = video.hash;
+        this.channel_id = video.channel_id;
+        this.channel_name = video.channel_name;
+        this.title = video.title;
+        this.description = video.description;
+        this.tags = video.tags;
+        this.duration = video.duration;
+        this.fetch_time = video.fetch_time;
+    }
+    static is(video) {
+        return (video !== undefined &&
+            typeof video.video_id === "string" &&
+            typeof video.publish_time === "string" &&
+            typeof video.hash === "string" &&
+            typeof video.channel_id === "string" &&
+            typeof video.channel_name === "string" &&
+            typeof video.title === "string" &&
+            typeof video.description === "string" &&
+            (video.tags === undefined || Array.isArray(video.tags) && video.tags.map((tag) => typeof tag === "string")) &&
+            typeof video.duration === "number" &&
+            typeof video.fetch_time === "number");
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "elections-types",
-    "version": "1.0.14",
+    "version": "1.0.15",
     "main": "dist/src/index.js",
     "types": "dist/src/index.d.ts",
     "directories": {

package/src/index.ts

@@ -1,4 +1,5 @@
 export * from "./types/APIError"
+export * from "./types/Article"
 export * from "./types/Candidate"
 export * from "./types/Committee"
 export * from "./types/Donation"
@@ -7,4 +8,5 @@ export * from "./types/ElectionsConfig"
 export * from "./types/FormTypeID"
 export * from "./types/State"
 export * from "./types/Tweet"
-export * from "./types/User"
+export * from "./types/User"
+export * from "./types/Video"

package/src/types/Article.ts

@@ -0,0 +1,41 @@
+export class Article {
+    readonly article_id : string
+    readonly publish_date : string
+    readonly hash : string
+    readonly title : string
+    readonly publisher : string
+    readonly domain : string
+    readonly url : string
+    readonly fetch_time : string
+    readonly s3_filename? : string
+
+    constructor(article : any) {
+        if (!Article.is(article)) {
+            throw Error("Invalid input.")
+        }
+        this.article_id = article.article_id
+        this.publish_date = article.publish_date
+        this.hash = article.hash
+        this.title = article.title
+        this.publisher = article.publisher
+        this.domain = article.domain
+        this.url = article.url
+        this.fetch_time = article.fetch_time
+        this.s3_filename = article.s3_filename
+    }
+
+    static is(article : any) : article is Article {
+        return (
+            article !== undefined &&
+            typeof article.article_id === "string" &&
+            typeof article.publish_date === "string" &&
+            typeof article.hash === "string" &&
+            typeof article.title === "string" &&
+            typeof article.publisher === "string" &&
+            typeof article.domain === "string" &&
+            typeof article.url === "string" &&
+            typeof article.fetch_time === "string" &&
+            (article.s3_filename === undefined || typeof article.s3_filename === "string")
+        )
+    }
+}

package/src/types/Candidate.ts

@@ -1,52 +1,95 @@
-// import { ElectionID, OfficeID } from "./Election"
-// import { StateID } from "./State"
+import { ElectionID, is_election_id, is_office_id, OfficeID } from "./Election"
+import { is_state_id, StateID } from "./State"
 
-// export class Candidate {
-//     readonly candidate_id : string
-//     readonly fec_name : string
-//     readonly office_id : OfficeID
-//     readonly state_id : StateID
-//     readonly election_id : ElectionID
-//     readonly party_id : string
-//     readonly active : boolean
-//     readonly status : boolean
+export class ActivityIndex {
+    readonly news_index : number
+    readonly twitter_index : number
+    readonly total_index : number
 
-//     constructor(candidate : any) {
-//         if (!Candidate.is(candidate)) {
-//             throw Error("Invalid input.")
-//         }
-//         this.office_id = candidate.office_id
-//         this.number = candidate.number
-//         this.scout_id = candidate.scout_id
-//         this.name = candidate.name
-//         this.active = candidate.active
-//         this.state_id = candidate.state_id
-//         this.district = candidate.district
-//         this.party_id = candidate.party_id
-//         this.tone_description_refresh = candidate.tone_description_refresh
-//         this.jurisdiction_ids = candidate.jurisdiction_ids
-//         this.sub_scout_ids = candidate.sub_scout_ids
-//         this.office_class_id = candidate.office_class_id
-//         this.office_name = candidate.office_name
-//     }
+    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(candidate : any) : candidate is Candidate {
-//         return (
-//             candidate !== undefined &&
-//             typeof candidate.office_id === "string" &&
-//             typeof candidate.number === "string" &&
-//             typeof candidate.scout_id === "string" &&
-//             typeof candidate.name === "string" &&
-//             typeof candidate.active === "boolean" &&
-//             (candidate.state_id === undefined || is_state_id(candidate.state_id)) &&
-//             (candidate.district === undefined || typeof candidate.district === "number") &&
-//             is_party_id(candidate.party_id) &&
-//             typeof candidate.tone_description_refresh === "boolean" &&
-//             Array.isArray(candidate.jurisdiction_ids) &&
-//             candidate.jurisdiction_ids.every((jurisdiction_id : any) => typeof jurisdiction_id === "number") &&
-//             (candidate.sub_scout_ids === undefined || Array.isArray(candidate.sub_scout_ids) && candidate.sub_scout_ids.every((sub_scout_id : any) => typeof sub_scout_id === "string")) &&
-//             is_office_class_id(candidate.office_class_id) &&
-//             (candidate.office_name === undefined || typeof candidate.office_name === "string")
-//         )
-//     }
-// }
+    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 election_id : ElectionID
+    readonly party_id : string
+    readonly active : boolean
+    readonly status : string
+    readonly file_number : number
+    readonly committee_ids? : string[]
+    readonly principal_committee_ids? : string[]
+    readonly authorized_committee_ids? : string[]
+    readonly sponsor_committee_ids? : string[]
+    readonly expenditure_ids? : string[]
+    readonly ballotpedia_name? : string
+    readonly ballotpedia_url? : string
+    readonly ballotpedia_data? : Record<string, any>
+    // readonly urls? : string[]
+    // readonly previews? : string[]
+
+
+    constructor(candidate : any) {
+        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.election_id = candidate.election_id
+        this.party_id = candidate.party_id
+        this.active = candidate.active
+        this.status = candidate.status
+        this.file_number = candidate.file_number
+        this.committee_ids = candidate.committee_ids
+        this.principal_committee_ids = candidate.principal_committee_ids
+        this.authorized_committee_ids = candidate.authorized_committee_ids
+        this.sponsor_committee_ids = candidate.sponsor_committee_ids
+        this.expenditure_ids = candidate.expenditure_ids
+        this.ballotpedia_name = candidate.ballotpedia_name
+        this.ballotpedia_url = candidate.ballotpedia_url
+        this.ballotpedia_data = candidate.ballotpedia_data
+    }
+
+    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) &&
+            is_election_id(candidate.election_id) &&
+            typeof candidate.party_id === "string" &&
+            typeof candidate.active === "boolean" &&
+            typeof candidate.status === "string" &&
+            typeof candidate.file_number === "number" &&
+            (candidate.committee_id === undefined || Array.isArray(candidate.committee_id) && candidate.committee_id.map((committee_id : any) => typeof committee_id === "string")) &&
+            (candidate.principal_committee_ids === undefined || Array.isArray(candidate.principal_committee_ids) && candidate.principal_committee_ids.map((committee_id : any) => typeof committee_id === "string")) &&
+            (candidate.authorized_committee_ids === undefined || Array.isArray(candidate.authorized_committee_ids) && candidate.authorized_committee_ids.map((committee_id : any) => typeof committee_id === "string")) &&
+            (candidate.sponsor_committee_ids === undefined || Array.isArray(candidate.sponsor_committee_ids) && candidate.sponsor_committee_ids.map((committee_id : any) => typeof committee_id === "string")) &&
+            (candidate.expenditure_ids === undefined || Array.isArray(candidate.expenditure_ids) && candidate.expenditure_ids.map((committee_id : any) => typeof committee_id === "string")) &&
+            (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"))
+        )
+    }
+}

package/src/types/Video.ts

@@ -0,0 +1,44 @@
+export class Video {
+    readonly video_id : string
+    readonly publish_time : string
+    readonly hash : string
+    readonly channel_id : string
+    readonly channel_name : string
+    readonly title : string
+    readonly description : string
+    readonly tags? : string[]
+    readonly duration : number
+    readonly fetch_time : string
+
+    constructor(video : any) {
+        if (!Video.is(video)) {
+            throw Error("Invalid input.")
+        }
+        this.video_id = video.video_id
+        this.publish_time = video.publish_time
+        this.hash = video.hash
+        this.channel_id = video.channel_id
+        this.channel_name = video.channel_name
+        this.title = video.title
+        this.description = video.description
+        this.tags = video.tags
+        this.duration = video.duration
+        this.fetch_time = video.fetch_time
+    }
+
+    static is(video : any) : video is Video {
+        return (
+            video !== undefined &&
+            typeof video.video_id === "string" &&
+            typeof video.publish_time === "string" &&
+            typeof video.hash === "string" &&
+            typeof video.channel_id === "string" &&
+            typeof video.channel_name === "string" &&
+            typeof video.title === "string" &&
+            typeof video.description === "string" &&
+            (video.tags === undefined || Array.isArray(video.tags) && video.tags.map((tag : any) => typeof tag === "string")) &&
+            typeof video.duration === "number" &&
+            typeof video.fetch_time === "number"
+        )
+    }
+}