scout-types 1.0.0

package/dist/src/types/State.js

@@ -0,0 +1,306 @@
+const state_ids = ["AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY"];
+export function is_state_id(state_id) {
+    return state_ids.includes(state_id);
+}
+export const states_by_state_id = {
+    AL: {
+        state_id: "AL",
+        name: "Alabama",
+        jurisdiction_id: 2280,
+        schools_jurisdiction_id: 13586
+    },
+    AK: {
+        state_id: "AK",
+        name: "Alaska",
+        jurisdiction_id: 2281,
+        schools_jurisdiction_id: 12910
+    },
+    AZ: {
+        state_id: "AZ",
+        name: "Arizona",
+        jurisdiction_id: 2148,
+        schools_jurisdiction_id: 12978
+    },
+    AR: {
+        state_id: "AR",
+        name: "Arkansas",
+        jurisdiction_id: 2282,
+        schools_jurisdiction_id: 12971
+    },
+    CA: {
+        state_id: "CA",
+        name: "California",
+        jurisdiction_id: 2283,
+        schools_jurisdiction_id: 12992
+    },
+    CO: {
+        state_id: "CO",
+        name: "Colorado",
+        jurisdiction_id: 2284,
+        schools_jurisdiction_id: 12897
+    },
+    CT: {
+        state_id: "CT",
+        name: "Connecticut",
+        jurisdiction_id: 2314,
+        schools_jurisdiction_id: 12998
+    },
+    DE: {
+        state_id: "DE",
+        name: "Delaware",
+        jurisdiction_id: 2315,
+        schools_jurisdiction_id: 13105
+    },
+    FL: {
+        state_id: "FL",
+        name: "Florida",
+        jurisdiction_id: 2316,
+        schools_jurisdiction_id: 13111
+    },
+    GA: {
+        state_id: "GA",
+        name: "Georgia",
+        jurisdiction_id: 2317,
+        schools_jurisdiction_id: 13119
+    },
+    HI: {
+        state_id: "HI",
+        name: "Hawaii",
+        jurisdiction_id: 2156,
+        schools_jurisdiction_id: 13127
+    },
+    ID: {
+        state_id: "ID",
+        name: "Idaho",
+        jurisdiction_id: 2318,
+        schools_jurisdiction_id: 13014
+    },
+    IL: {
+        state_id: "IL",
+        name: "Illinois",
+        jurisdiction_id: 2319,
+        schools_jurisdiction_id: 13065
+    },
+    IN: {
+        state_id: "IN",
+        name: "Indiana",
+        jurisdiction_id: 2159,
+        schools_jurisdiction_id: 13068
+    },
+    IA: {
+        state_id: "IA",
+        name: "Iowa",
+        jurisdiction_id: 2320,
+        schools_jurisdiction_id: 12917
+    },
+    KS: {
+        state_id: "KS",
+        name: "Kansas",
+        jurisdiction_id: 2161,
+        schools_jurisdiction_id: 13088
+    },
+    KY: {
+        state_id: "KY",
+        name: "Kentucky",
+        jurisdiction_id: 2162,
+        schools_jurisdiction_id: 13094
+    },
+    LA: {
+        state_id: "LA",
+        name: "Louisiana",
+        jurisdiction_id: 2163,
+        schools_jurisdiction_id: 13130
+    },
+    ME: {
+        state_id: "ME",
+        name: "Maine",
+        jurisdiction_id: 2164,
+        schools_jurisdiction_id: 38491
+    },
+    MD: {
+        state_id: "MD",
+        name: "Maryland",
+        jurisdiction_id: 2165,
+        schools_jurisdiction_id: 14199
+    },
+    MA: {
+        state_id: "MA",
+        name: "Massachusetts",
+        jurisdiction_id: 2166,
+        schools_jurisdiction_id: 13135
+    },
+    MI: {
+        state_id: "MI",
+        name: "Michigan",
+        jurisdiction_id: 2167,
+        schools_jurisdiction_id: 13448
+    },
+    MN: {
+        state_id: "MN",
+        name: "Minnesota",
+        jurisdiction_id: 2286,
+        schools_jurisdiction_id: 13233
+    },
+    MS: {
+        state_id: "MS",
+        name: "Mississippi",
+        jurisdiction_id: 2287,
+        schools_jurisdiction_id: 12965
+    },
+    MO: {
+        state_id: "MO",
+        name: "Missouri",
+        jurisdiction_id: 2288,
+        schools_jurisdiction_id: 12955
+    },
+    MT: {
+        state_id: "MT",
+        name: "Montana",
+        jurisdiction_id: 2289,
+        schools_jurisdiction_id: 38286
+    },
+    NE: {
+        state_id: "NE",
+        name: "Nebraska",
+        jurisdiction_id: 2290,
+        schools_jurisdiction_id: 13050
+    },
+    NV: {
+        state_id: "NV",
+        name: "Nevada",
+        jurisdiction_id: 2291,
+        schools_jurisdiction_id: 13425
+    },
+    NH: {
+        state_id: "NH",
+        name: "New Hampshire",
+        jurisdiction_id: 2292,
+        schools_jurisdiction_id: 13062
+    },
+    NJ: {
+        state_id: "NJ",
+        name: "New Jersey",
+        jurisdiction_id: 2293,
+        schools_jurisdiction_id: 13244
+    },
+    NM: {
+        state_id: "NM",
+        name: "New Mexico",
+        jurisdiction_id: 2294,
+        schools_jurisdiction_id: 13251
+    },
+    NY: {
+        state_id: "NY",
+        name: "New York",
+        jurisdiction_id: 2295,
+        schools_jurisdiction_id: 13429
+    },
+    NC: {
+        state_id: "NC",
+        name: "North Carolina",
+        jurisdiction_id: 2296,
+        schools_jurisdiction_id: 13009
+    },
+    ND: {
+        state_id: "ND",
+        name: "North Dakota",
+        jurisdiction_id: 2297,
+        schools_jurisdiction_id: 13042
+    },
+    OH: {
+        state_id: "OH",
+        name: "Ohio",
+        jurisdiction_id: 2298,
+        schools_jurisdiction_id: 13224
+    },
+    OK: {
+        state_id: "OK",
+        name: "Oklahoma",
+        jurisdiction_id: 2299,
+        schools_jurisdiction_id: 13223
+    },
+    OR: {
+        state_id: "OR",
+        name: "Oregon",
+        jurisdiction_id: 2300,
+        schools_jurisdiction_id: 13221
+    },
+    PA: {
+        state_id: "PA",
+        name: "Pennsylvania",
+        jurisdiction_id: 2301,
+        schools_jurisdiction_id: 12918
+    },
+    RI: {
+        state_id: "RI",
+        name: "Rhode Island",
+        jurisdiction_id: 2302,
+        schools_jurisdiction_id: 12926
+    },
+    SC: {
+        state_id: "SC",
+        name: "South Carolina",
+        jurisdiction_id: 2303,
+        schools_jurisdiction_id: 12929
+    },
+    SD: {
+        state_id: "SD",
+        name: "South Dakota",
+        jurisdiction_id: 2304,
+        schools_jurisdiction_id: 12938
+    },
+    TN: {
+        state_id: "TN",
+        name: "Tennessee",
+        jurisdiction_id: 2305,
+        schools_jurisdiction_id: 12942
+    },
+    TX: {
+        state_id: "TX",
+        name: "Texas",
+        jurisdiction_id: 2306,
+        schools_jurisdiction_id: 12949
+    },
+    UT: {
+        state_id: "UT",
+        name: "Utah",
+        jurisdiction_id: 2307,
+        schools_jurisdiction_id: 65780
+    },
+    VT: {
+        state_id: "VT",
+        name: "Vermont",
+        jurisdiction_id: 2308,
+        schools_jurisdiction_id: 47348
+    },
+    VA: {
+        state_id: "VA",
+        name: "Virginia",
+        jurisdiction_id: 2309,
+        schools_jurisdiction_id: 13026
+    },
+    WA: {
+        state_id: "WA",
+        name: "Washington",
+        jurisdiction_id: 2310,
+        schools_jurisdiction_id: 13032
+    },
+    WV: {
+        state_id: "WV",
+        name: "West Virginia",
+        jurisdiction_id: 2311,
+        schools_jurisdiction_id: 13056
+    },
+    WI: {
+        state_id: "WI",
+        name: "Wisconsin",
+        jurisdiction_id: 2312,
+        schools_jurisdiction_id: 13044
+    },
+    WY: {
+        state_id: "WY",
+        name: "Wyoming",
+        jurisdiction_id: 2313,
+        schools_jurisdiction_id: 13148
+    }
+};

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

@@ -0,0 +1,12 @@
+export declare class Tweet {
+    readonly tweet_id: string;
+    readonly username: string;
+    readonly url: string;
+    readonly tweet_time: string;
+    readonly tweet_content: string;
+    readonly quote?: string;
+    readonly html: string;
+    readonly text: string;
+    constructor(tweet: any);
+    static is(tweet: any): tweet is Tweet;
+}

package/dist/src/types/Tweet.js

@@ -0,0 +1,34 @@
+export class Tweet {
+    tweet_id;
+    username;
+    url;
+    tweet_time;
+    tweet_content;
+    quote;
+    html;
+    text;
+    constructor(tweet) {
+        if (!Tweet.is(tweet)) {
+            throw Error("Invalid input.");
+        }
+        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.html = tweet.html;
+        this.text = tweet.text;
+    }
+    static is(tweet) {
+        return (tweet !== undefined &&
+            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"));
+    }
+}

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

@@ -0,0 +1,16 @@
+import { ScoutAux } from "./Scout.js";
+export declare class User {
+    readonly user_id: string;
+    readonly admin: boolean;
+    readonly active: boolean;
+    readonly scout_ids: string[];
+    readonly email: string;
+    readonly [x: string]: any;
+    constructor(user: any);
+    static is(user: any): user is User;
+}
+export declare class UserAux extends User {
+    readonly scouts: ScoutAux[];
+    constructor(user: any);
+    static is(user: any): user is UserAux;
+}

package/dist/src/types/User.js

@@ -0,0 +1,42 @@
+import { ScoutAux } from "./Scout.js";
+export class User {
+    user_id;
+    admin;
+    active;
+    scout_ids;
+    email;
+    constructor(user) {
+        if (!User.is(user)) {
+            throw Error("Invalid Input.");
+        }
+        this.user_id = user.user_id;
+        this.admin = user.admin;
+        this.active = user.active;
+        this.scout_ids = user.scout_ids;
+        this.email = user.email;
+    }
+    static is(user) {
+        return (user !== undefined &&
+            typeof user.user_id === "string" &&
+            typeof user.admin === "boolean" &&
+            typeof user.active === "boolean" &&
+            typeof user.email === "string" &&
+            Array.isArray(user.scout_ids) &&
+            user.scout_ids.every((scout_id) => typeof scout_id === "string"));
+    }
+}
+export class UserAux extends User {
+    scouts;
+    constructor(user) {
+        if (!UserAux.is(user)) {
+            throw Error("Invalid Input.");
+        }
+        super(user);
+        this.scouts = user.scouts;
+    }
+    static is(user) {
+        return (User.is(user) &&
+            Array.isArray(user.scouts) &&
+            user.scouts.every(ScoutAux.is));
+    }
+}

package/eslint.config.ts

@@ -0,0 +1,13 @@
+import js from "@eslint/js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+    { files: ["**/*.{js,mjs,cjs,ts,mts,cts}"], plugins: { js }, extends: ["js/recommended"], languageOptions: { globals: globals.browser } },
+    {
+		rules: {
+            "@typescript-eslint/explicit-function-return-type": "error"
+		},
+	},
+]);

package/jest.config.js

@@ -0,0 +1,20 @@
+import { createDefaultPreset } from "ts-jest"
+
+const tsJestTransformCfg = createDefaultPreset().transform;
+
+/** @type {import("jest").Config} **/
+export default {
+    testEnvironment: "node",
+    transform: {
+        ...tsJestTransformCfg,
+    },
+    transformIgnorePatterns: ["/node_modules/(?!@smithy|@aws-sdk).+\\.js$"],
+    globals : {
+        "ts-jest" : {
+            useESM : true
+        }
+    },
+    extensionsToTreatAsEsm : [".ts"],
+    testTimeout : 30000,
+    testPathIgnorePatterns: ['dist/']
+};

package/package.json

@@ -0,0 +1,31 @@
+{
+    "name": "scout-types",
+    "version": "1.0.0",
+    "main": "dist/src/index.js",
+    "types": "dist/src/index.d.ts",
+    "directories": {
+        "test": "test"
+    },
+    "scripts": {
+        "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+        "build": "tsc && tsc-alias"
+    },
+    "author": "",
+    "license": "ISC",
+    "description": "",
+    "type": "module",
+    "dependencies": {},
+    "devDependencies": {
+        "@eslint/js": "^9.39.2",
+        "@types/jest": "^30.0.0",
+        "eslint": "^9.39.2",
+        "globals": "^17.3.0",
+        "jest": "^30.2.0",
+        "jiti": "^2.6.1",
+        "ts-jest": "^29.4.6",
+        "tsc-alias": "^1.8.16",
+        "tsx": "^4.21.0",
+        "typescript": "^5.9.3",
+        "typescript-eslint": "^8.55.0"
+    }
+}

package/src/index.ts

@@ -0,0 +1,14 @@
+export * from "./types/Scout"
+export * from "./types/ScoutDocument"
+export * from "./types/Conversation"
+export * from "./types/APIError"
+export * from "./types/ScoutConfig"
+export * from "./types/Jurisdiction"
+export * from "./types/JurisdictionDocument"
+export * from "./types/Message"
+export * from "./types/OfficeClass"
+export * from "./types/Party"
+export * from "./types/Sources"
+export * from "./types/State"
+export * from "./types/Tweet"
+export * from "./types/User"

package/src/types/APIError.ts

@@ -0,0 +1,21 @@
+const default_messages_by_status : Record<number, string> = {
+    400 : "Bad Request",
+    401 : "Unauthorized",
+    403 : "Forbidden",
+    404 : "Not Found",
+    405 : "Method Not Allowed",
+    500 : "Internal Server Error",
+    504 : "Gateway Timeout",
+    600 : "Failed to Parse Output"
+}
+
+
+export class APIError extends Error {
+    status : number
+    constructor(status : number, message?: string) {
+        const default_message = default_messages_by_status[status]
+        super(message !== undefined ? message : default_message !== undefined ? default_message : "Error")
+        this.name = "APIError"
+        this.status = status
+    }
+}

package/src/types/Bill.ts

@@ -0,0 +1,57 @@
+const bill_types = ["HR", "S", "HJRES", "SJRES", "HCONRES", "SCONRES", "HRES", "SRES"] as const
+
+export type BillType = typeof bill_types[number]
+
+export function is_bill_type(bill_type : any) : bill_type is BillType {
+    return bill_types.includes(bill_type)
+}
+
+export class Bill {
+    readonly congress_id : number
+    readonly bill_id : string
+    readonly type : string
+    readonly number : number
+    readonly title : string
+    readonly intro_date? : string
+    readonly policy_area_name? : string
+    readonly committee_ids? : string[]
+    readonly xml_url? : string
+    readonly s3_filename? : string
+    readonly vector_keys? : string[]
+
+    constructor(bill : any) {
+        if (!Bill.is(bill)) {
+            throw Error("Invalid input.")
+        }
+        this.congress_id = bill.congress_id
+        this.bill_id = bill.bill_id
+        this.type = bill.type
+        this.number = bill.number
+        this.title = bill.title
+        this.intro_date = bill.intro_date
+        this.policy_area_name = bill.policy_area_name
+        this.committee_ids = bill.committee_ids
+        this.xml_url = bill.xml_url
+        this.s3_filename = bill.s3_filename
+        this.vector_keys = bill.vector_keys
+
+    }
+
+    static is(bill : any) : bill is Bill {
+        return (
+            bill !== undefined &&
+            typeof bill.congress_id === "number" &&
+            typeof bill.bill_id === "string" &&
+            typeof bill.type === "string" &&
+            typeof bill.number === "number" &&
+            typeof bill.title === "string" &&
+            (bill.intro_date === undefined || typeof bill.intro_date === "string") &&
+            (bill.policy_area_name === undefined || typeof bill.policy_area_name === "string") &&
+            (bill.committee_ids === undefined || Array.isArray(bill.committee_ids) && bill.committee_ids.every((committee_id : any) => typeof committee_id === "string")) &&
+            (bill.xml_url === undefined || typeof bill.xml_url === "string") &&
+            (bill.s3_filename === undefined || typeof bill.s3_filename === "string") &&
+            (bill.vector_keys === undefined || Array.isArray(bill.vector_keys) && bill.vector_keys.every((vector_key : any) => typeof vector_key === "string"))
+        )
+    }
+
+}

package/src/types/Conversation.ts

@@ -0,0 +1,52 @@
+import { Message } from "./Message"
+
+export class Conversation {
+    readonly user_id : string
+    readonly conversation_id : string
+    readonly scout_id : string
+    readonly time : string
+    readonly [x : string] : any
+
+    constructor(conversation : any) {
+        if (!Conversation.is(conversation)) {
+            throw Error("Invalid input.")
+        }
+        this.user_id = conversation.user_id
+        this.conversation_id = conversation.conversation_id
+        this.scout_id = conversation.scout_id
+        this.time = conversation.time
+    }
+
+    static is(conversation : any) : conversation is Conversation {
+        return (
+            conversation !== undefined &&
+            typeof conversation.user_id === "string" &&
+            typeof conversation.conversation_id === "string" &&
+            typeof conversation.scout_id === "string" &&
+            typeof conversation.time === "string"
+        )
+    }
+}
+
+export class ConversationAux extends Conversation {
+    readonly messages : Message[]
+    readonly max_action_time : string
+
+    constructor(conversation : any) {
+        if (!ConversationAux.is(conversation)) {
+            throw Error("Invalid input.")
+        }
+        super(conversation)
+        this.messages = conversation.messages
+        this.max_action_time = conversation.max_action_time
+    }
+
+    static is(conversation : any) : conversation is ConversationAux {
+        return (
+            Conversation.is(conversation) &&
+            Array.isArray(conversation.messages) &&
+            conversation.messages.every(Message.is) &&
+            typeof conversation.max_action_time === "string"
+        )
+    }
+}

package/src/types/Jurisdiction.ts

@@ -0,0 +1,62 @@
+export enum JurisdictionLevel {
+    OTHER = 0,
+    NATION = 1,
+    STATE = 2,
+    COUNTY = 3,
+    CITY = 4,
+    SCHOOL = 5
+}
+
+export function is_jurisdiction_level(jurisdiction_level : any) : jurisdiction_level is JurisdictionLevel {
+    return [0, 1, 2, 3, 4, 5].includes(jurisdiction_level)
+}
+
+export class Jurisdiction {
+    readonly jurisdiction_id : number
+    readonly name : string
+    readonly path : number[]
+    readonly sub_jurisdiction_ids : number[]
+    readonly super_jurisdiction_id? : number
+    readonly level : JurisdictionLevel
+    readonly state_jurisdiction_id? : number
+    readonly county_jurisdiction_id? : number
+    readonly city_jurisdiction_id? : number
+    readonly school_jurisdiction_id? : number
+    readonly geographic : boolean
+
+    constructor(jurisdiction : any) {
+        if (!Jurisdiction.is(jurisdiction)) {
+            throw Error("Invalid input.")
+        }
+        this.jurisdiction_id = jurisdiction.jurisdiction_id
+        this.name = jurisdiction.name
+        this.path = jurisdiction.path
+        this.sub_jurisdiction_ids = jurisdiction.sub_jurisdiction_ids
+        this.super_jurisdiction_id = jurisdiction.super_jurisdiction_id
+        this.level = jurisdiction.level
+        this.state_jurisdiction_id = jurisdiction.state_jurisdiction_id
+        this.county_jurisdiction_id = jurisdiction.county_jurisdiction_id
+        this.city_jurisdiction_id = jurisdiction.city_jurisdiction_id
+        this.school_jurisdiction_id = jurisdiction.school_jurisdiction_id
+        this.geographic = jurisdiction.geographic
+    }
+
+    static is(jurisdiction : any) : jurisdiction is Jurisdiction {
+        return (
+            jurisdiction !== undefined &&
+            typeof jurisdiction.jurisdiction_id === "number" &&
+            typeof jurisdiction.name === "string" &&
+            Array.isArray(jurisdiction.path) &&
+            jurisdiction.path.every((jurisdiction_id : any) => typeof jurisdiction_id === "number") &&
+            Array.isArray(jurisdiction.sub_jurisdiction_ids) &&
+            jurisdiction.sub_jurisdiction_ids.every((jurisdiction_id : any) => typeof jurisdiction_id === "number") &&
+            is_jurisdiction_level(jurisdiction.level) &&
+            typeof jurisdiction.geographic === "boolean" &&
+            (jurisdiction.super_jurisdiction_id === undefined || typeof jurisdiction.super_jurisdiction_id === "number") &&
+            (jurisdiction.state_jurisdiction_id === undefined || typeof jurisdiction.state_jurisdiction_id === "number") &&
+            (jurisdiction.county_jurisdiction_id === undefined || typeof jurisdiction.county_jurisdiction_id === "number") &&
+            (jurisdiction.city_jurisdiction_id === undefined || typeof jurisdiction.city_jurisdiction_id === "number") &&
+            (jurisdiction.school_jurisdiction_id === undefined || typeof jurisdiction.school_jurisdiction_id === "number")
+        )
+    }
+}