elections-types 1.0.26 → 1.0.28

package/dist/src/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./types/APIError.js";
 export * from "./types/Article.js";
 export * from "./types/Candidate.js";
+export * from "./types/CandidateArticle.js";
 export * from "./types/Committee.js";
 export * from "./types/Donation.js";
 export * from "./types/Election.js";

package/dist/src/index.js

@@ -1,6 +1,7 @@
 export * from "./types/APIError.js";
 export * from "./types/Article.js";
 export * from "./types/Candidate.js";
+export * from "./types/CandidateArticle.js";
 export * from "./types/Committee.js";
 export * from "./types/Donation.js";
 export * from "./types/Election.js";

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

@@ -3,7 +3,7 @@ export declare class Article {
     readonly publish_date: string;
     readonly hash: string;
     readonly title: string;
-    readonly publisher: string;
+    readonly publisher?: string;
     readonly domain: string;
     readonly url: string;
     readonly fetch_time: string;

package/dist/src/types/Article.js

@@ -30,7 +30,7 @@ export class Article {
             typeof article.publish_date === "string" &&
             typeof article.hash === "string" &&
             typeof article.title === "string" &&
-            typeof article.publisher === "string" &&
+            (article.publisher === undefined || typeof article.publisher === "string") &&
             typeof article.domain === "string" &&
             typeof article.url === "string" &&
             typeof article.fetch_time === "string" &&

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

@@ -0,0 +1,10 @@
+export declare class CandidateArticle {
+    readonly candidate_id: string;
+    readonly article_id: string;
+    readonly url: string;
+    readonly fetch_time: string;
+    readonly relevance_text?: string;
+    readonly sentiment?: string;
+    constructor(candidate_article: any);
+    static is(candidate_article: any): candidate_article is CandidateArticle;
+}

package/dist/src/types/CandidateArticle.js

@@ -0,0 +1,28 @@
+export class CandidateArticle {
+    candidate_id;
+    article_id;
+    url;
+    fetch_time;
+    relevance_text;
+    sentiment;
+    constructor(candidate_article) {
+        if (!CandidateArticle.is(candidate_article)) {
+            throw Error("Invalid input.");
+        }
+        this.candidate_id = candidate_article.candidate_id;
+        this.article_id = candidate_article.article_id;
+        this.url = candidate_article.url;
+        this.fetch_time = candidate_article.fetch_time;
+        this.relevance_text = candidate_article.relevance_text;
+        this.sentiment = candidate_article.sentiment;
+    }
+    static is(candidate_article) {
+        return (candidate_article !== undefined &&
+            typeof candidate_article.candidate_id === "string" &&
+            typeof candidate_article.article_id === "string" &&
+            typeof candidate_article.url === "string" &&
+            typeof candidate_article.fetch_time === "string" &&
+            (candidate_article.relevance_text === undefined || typeof candidate_article.relevance_text === "string") &&
+            (candidate_article.sentiment === undefined || typeof candidate_article.sentiment === "string"));
+    }
+}

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

@@ -5,7 +5,7 @@ export declare class Tweet {
     readonly tweet_time: string;
     readonly tweet_content: string;
     readonly quote?: string;
-    readonly html: string;
+    readonly html?: string;
     readonly text: string;
     constructor(tweet: any);
     static is(tweet: any): tweet is Tweet;

package/dist/src/types/Tweet.js

@@ -28,7 +28,7 @@ export class Tweet {
             typeof tweet.tweet_time === "string" &&
             typeof tweet.tweet_content === "string" &&
             (tweet.quote === undefined || typeof tweet.quote === "string") &&
-            (typeof tweet.html === "string") &&
+            (tweet.html === undefined || typeof tweet.html === "string") &&
             (typeof tweet.text === "string"));
     }
 }

package/package.json

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

package/src/index.ts

@@ -1,6 +1,7 @@
 export * from "./types/APIError"
 export * from "./types/Article"
 export * from "./types/Candidate"
+export * from "./types/CandidateArticle"
 export * from "./types/Committee"
 export * from "./types/Donation"
 export * from "./types/Election"

package/src/types/Article.ts

@@ -3,7 +3,7 @@ export class Article {
     readonly publish_date : string
     readonly hash : string
     readonly title : string
-    readonly publisher : string
+    readonly publisher? : string
     readonly domain : string
     readonly url : string
     readonly fetch_time : string
@@ -33,7 +33,7 @@ export class Article {
             typeof article.publish_date === "string" &&
             typeof article.hash === "string" &&
             typeof article.title === "string" &&
-            typeof article.publisher === "string" &&
+            (article.publisher === undefined || typeof article.publisher === "string") &&
             typeof article.domain === "string" &&
             typeof article.url === "string" &&
             typeof article.fetch_time === "string" &&

package/src/types/CandidateArticle.ts

@@ -0,0 +1,32 @@
+export class CandidateArticle {
+    readonly candidate_id : string
+    readonly article_id : string
+    readonly url : string
+    readonly fetch_time : string
+    readonly relevance_text? : string
+    readonly sentiment? : string
+
+    constructor(candidate_article : any) {
+        if (!CandidateArticle.is(candidate_article)) {
+            throw Error("Invalid input.")
+        }
+        this.candidate_id = candidate_article.candidate_id
+        this.article_id = candidate_article.article_id
+        this.url = candidate_article.url
+        this.fetch_time = candidate_article.fetch_time
+        this.relevance_text = candidate_article.relevance_text
+        this.sentiment = candidate_article.sentiment
+    }
+
+    static is(candidate_article : any) : candidate_article is CandidateArticle {
+        return (
+            candidate_article !== undefined &&
+            typeof candidate_article.candidate_id === "string" &&
+            typeof candidate_article.article_id === "string" &&
+            typeof candidate_article.url === "string" &&
+            typeof candidate_article.fetch_time === "string" &&
+            (candidate_article.relevance_text === undefined || typeof candidate_article.relevance_text === "string") &&
+            (candidate_article.sentiment === undefined || typeof candidate_article.sentiment === "string")
+        )
+    }
+}

package/src/types/Tweet.ts

@@ -5,7 +5,7 @@ export class Tweet {
     readonly tweet_time : string
     readonly tweet_content : string
     readonly quote? : string
-    readonly html : string
+    readonly html? : string
     readonly text : string
 
     constructor(tweet : any) {
@@ -31,7 +31,7 @@ export class Tweet {
             typeof tweet.tweet_time === "string" &&
             typeof tweet.tweet_content === "string" &&
             (tweet.quote === undefined || typeof tweet.quote === "string") &&
-            (typeof tweet.html === "string") &&
+            (tweet.html === undefined || typeof tweet.html === "string") &&
             (typeof tweet.text === "string")
         )
     }