scout-types 1.0.0

package/src/types/State.ts

@@ -0,0 +1,317 @@
+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"] as const
+
+export type StateID = typeof state_ids[number]
+
+export function is_state_id(state_id : any) : state_id is StateID {
+    return state_ids.includes(state_id)
+}
+
+export interface State {
+    state_id : StateID,
+    name : string,
+    jurisdiction_id : number,
+    schools_jurisdiction_id : number
+}
+
+export const states_by_state_id : Record<StateID, State> = {
+    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/src/types/Tweet.ts

@@ -0,0 +1,38 @@
+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 html : string
+    readonly text : string
+
+    constructor(tweet : any) {
+        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 : any) : tweet 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/src/types/User.ts

@@ -0,0 +1,53 @@
+import { ScoutAux } from "./Scout"
+
+export 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) {
+        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 : any) : user 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 : any) => typeof scout_id === "string")
+        )
+    }
+}
+
+export class UserAux extends User {
+    readonly scouts : ScoutAux[]
+
+    constructor(user : any) {
+        if (!UserAux.is(user)) {
+            throw Error("Invalid Input.")
+        }
+        super(user)
+        this.scouts = user.scouts
+    }
+
+    static is(user : any) : user is UserAux {
+        return (
+            User.is(user) &&
+            Array.isArray(user.scouts) &&
+            user.scouts.every(ScoutAux.is)
+        )
+    }
+}

package/tsconfig.json

@@ -0,0 +1,34 @@
+{
+	"compilerOptions": {
+        "outDir": "./dist",
+
+		// Treat files as modules even if it doesn't use import/export
+		"moduleDetection": "force",
+
+		// Ignore module structure
+		"module" : "esnext",
+        "target" : "es2022",
+        "noImplicitAny" : true,
+        "noImplicitReturns" : true,
+        "moduleResolution": "bundler",
+        "declaration": true,
+		// Allow JS files to be imported from TS and vice versa
+		"allowJs": true,
+        "strict" : true,
+		// Use correct ESM import behavior
+		"esModuleInterop": true,
+        "resolveJsonModule": true,
+		// Disallow features that require cross-file awareness
+		"isolatedModules": true,
+    	"lib": ["es2022"],
+        "rootDir": "./",
+        "skipLibCheck": true,
+        "maxNodeModuleJsDepth": 0,
+        "types": ["jest", "node"]
+	},
+    "tsc-alias": {
+        "resolveFullPaths": true,
+        "verbose": false
+    },
+    "include" : ["src/**/*", "test/**/*"]
+}