triage-types 1.0.41 → 1.0.43

package/src/index.ts

@@ -1,10 +1,22 @@
 export * from "./types/APIError"
 export * from "./types/State"
-export * from "./types/AR/ARStateFacility"
-export * from "./types/AR/ARStatePermit"
-export * from "./types/AR/ARStatePermitSource"
-export * from "./types/AR/ARStatePermitSourcePollutant"
-export * from "./types/KY/KYStateFacility"
-export * from "./types/KY/KYStatePermit"
-export * from "./types/NC/NCStateFacility"
-export * from "./types/NC/NCStatePermit"
+
+export * from "./types/federal_dockets/FederalDocketAgency"
+export * from "./types/federal_dockets/FederalDocket"
+export * from "./types/federal_dockets/FederalDocketDocument"
+export * from "./types/federal_dockets/FederalDocketComment"
+export * from "./types/federal_dockets/FederalDocketCommentAttachment"
+
+export * from "./types/state_permits/AR/ARStateFacility"
+export * from "./types/state_permits/AR/ARStatePermit"
+export * from "./types/state_permits/AR/ARStatePermitSource"
+export * from "./types/state_permits/AR/ARStatePermitSourcePollutant"
+
+export * from "./types/state_permits/KY/KYStateFacility"
+export * from "./types/state_permits/KY/KYStatePermit"
+
+export * from "./types/state_permits/NC/NCStateFacility"
+export * from "./types/state_permits/NC/NCStatePermit"
+
+export * from "./types/state_permits/TN/TNStateFacility"
+export * from "./types/state_permits/TN/TNStatePermit"

package/src/types/federal_dockets/FederalDocket.ts

@@ -0,0 +1,29 @@
+export class FederalDocket {
+    readonly federal_docket_id : string
+    readonly federal_docket_agency_id : string
+    readonly is_rule : boolean
+    readonly title : string
+    readonly modify_time? : string
+
+    constructor(federal_docket : any) {
+        if (!FederalDocket.is(federal_docket)) {
+            throw Error("Invalid input.")
+        }
+        this.federal_docket_id = federal_docket.federal_docket_id
+        this.federal_docket_agency_id = federal_docket.federal_docket_agency_id
+        this.is_rule = federal_docket.is_rule
+        this.title = federal_docket.title
+        this.modify_time = federal_docket.modify_time
+    }
+
+    static is(federal_docket : any) : federal_docket is FederalDocket {
+        return (
+            federal_docket !== undefined &&
+            typeof federal_docket.federal_docket_id === "string" &&
+            typeof federal_docket.federal_docket_agency_id === "string" &&
+            typeof federal_docket.is_rule === "boolean" &&
+            typeof federal_docket.title === "string" &&
+            (federal_docket.modify_time === undefined || typeof federal_docket.modify_time === "string")
+        )
+    }
+}

package/src/types/federal_dockets/FederalDocketAgency.ts

@@ -0,0 +1,26 @@
+export class FederalDocketAgency {
+    readonly federal_docket_agency_id : string
+    readonly federal_register_agency_id : number
+    readonly name : string
+    readonly supreme_federal_register_agency_id : number
+
+    constructor(federal_docket_agency : any) {
+        if (!FederalDocketAgency.is(federal_docket_agency)) {
+            throw Error("Invalid input.")
+        }
+        this.federal_docket_agency_id = federal_docket_agency.federal_docket_agency_id
+        this.federal_register_agency_id = federal_docket_agency.federal_register_agency_id
+        this.name = federal_docket_agency.name
+        this.supreme_federal_register_agency_id = federal_docket_agency.supreme_federal_register_agency_id
+    }
+
+    static is(federal_docket_agency : any) : federal_docket_agency is FederalDocketAgency {
+        return (
+            federal_docket_agency !== undefined &&
+            typeof federal_docket_agency.federal_docket_agency_id === "string" &&
+            typeof federal_docket_agency.federal_register_agency_id === "number" &&
+            typeof federal_docket_agency.name === "string" &&
+            typeof federal_docket_agency.supreme_federal_register_agency_id === "number"
+        )
+    }
+}

package/src/types/federal_dockets/FederalDocketComment.ts

@@ -0,0 +1,96 @@
+export class Commentor {
+    readonly first_name? : string
+    readonly last_name? : string
+    readonly organization_name? : string
+    readonly address_1? : string
+    readonly address_2? : string
+    readonly city? : string
+    readonly state_id? : string
+    readonly zip? : string
+    readonly country? : string
+    readonly email? : string
+    readonly phone? : string
+
+    constructor(commentor : any) {
+        if (!Commentor.is(commentor)) {
+            throw Error("Invalid input.")
+        }
+        this.first_name = commentor.first_name
+        this.last_name = commentor.last_name
+        this.organization_name = commentor.organization_name
+        this.address_1 = commentor.address_1
+        this.address_2 = commentor.address_2
+        this.city = commentor.city
+        this.state_id = commentor.state_id
+        this.zip = commentor.zip
+        this.country = commentor.country
+        this.email = commentor.email
+        this.phone = commentor.phone
+    }
+
+    static is(commentor : any) : commentor is Commentor {
+        return (
+            commentor !== undefined &&
+            (commentor.first_name === undefined || typeof commentor.first_name === "string") &&
+            (commentor.last_name === undefined || typeof commentor.last_name === "string") &&
+            (commentor.organization_name === undefined || typeof commentor.organization_name === "string") &&
+            (commentor.address_1 === undefined || typeof commentor.address_1 === "string") &&
+            (commentor.address_2 === undefined || typeof commentor.address_2 === "string") &&
+            (commentor.city === undefined || typeof commentor.city === "string") &&
+            (commentor.state_id === undefined || typeof commentor.state_id === "string") &&
+            (commentor.zip === undefined || typeof commentor.zip === "string") &&
+            (commentor.country === undefined || typeof commentor.country === "string") &&
+            (commentor.email === undefined || typeof commentor.email === "string") &&
+            (commentor.phone === undefined || typeof commentor.phone === "string")
+        )
+    }
+}
+
+
+export class FederalDocketComment {
+    readonly federal_docket_comment_id : string
+    readonly federal_docket_agency_id : string
+    readonly federal_docket_id : string
+    readonly federal_docket_document_id? : string
+    readonly title : string
+    readonly publish_time? : string
+    readonly modify_time? : string
+    readonly comment_time? : string
+    readonly is_withdrawn : boolean
+    readonly commentor : Commentor
+    readonly text : string
+
+    constructor(federal_docket_comment : any) {
+        if (!FederalDocketComment.is(federal_docket_comment)) {
+            throw Error("Invalid input.")
+        }
+        this.federal_docket_comment_id = federal_docket_comment.federal_docket_comment_id
+        this.federal_docket_agency_id = federal_docket_comment.federal_docket_agency_id
+        this.federal_docket_id = federal_docket_comment.federal_docket_id
+        this.federal_docket_document_id = federal_docket_comment.federal_docket_document_id
+        this.title = federal_docket_comment.title
+        this.publish_time = federal_docket_comment.publish_time
+        this.modify_time = federal_docket_comment.modify_time
+        this.comment_time = federal_docket_comment.comment_time
+        this.is_withdrawn = federal_docket_comment.is_withdrawn
+        this.commentor = new Commentor(federal_docket_comment.commentor)
+        this.text = federal_docket_comment.text
+    }
+
+    static is(federal_docket_comment : any) : federal_docket_comment is FederalDocketComment {
+        return (
+            federal_docket_comment !== undefined &&
+            typeof federal_docket_comment.federal_docket_comment_id === "string" &&
+            typeof federal_docket_comment.federal_docket_agency_id === "string" &&
+            typeof federal_docket_comment.federal_docket_id === "string" &&
+            (federal_docket_comment.federal_docket_document_id === undefined || typeof federal_docket_comment.federal_docket_document_id === "string") &&
+            typeof federal_docket_comment.title === "string" &&
+            (federal_docket_comment.publish_time === undefined || typeof federal_docket_comment.publish_time === "string") &&
+            (federal_docket_comment.modify_time === undefined || typeof federal_docket_comment.modify_time === "string") &&
+            (federal_docket_comment.comment_time === undefined || typeof federal_docket_comment.comment_time === "string") &&
+            typeof federal_docket_comment.is_withdrawn === "boolean" &&
+            Commentor.is(federal_docket_comment.commentor) &&
+            typeof federal_docket_comment.text === "string"
+        )
+    }
+}

package/src/types/federal_dockets/FederalDocketCommentAttachment.ts

@@ -0,0 +1,29 @@
+export class FederalDocketCommentAttachment {
+    readonly federal_docket_comment_attachment_id : string
+    readonly federal_docket_comment_id : string
+    readonly attachment_number : number
+    readonly urls : string[]
+    readonly s3_filenames? : string[]
+
+    constructor(federal_docket_comment_attachment : any) {
+        if (!FederalDocketCommentAttachment.is(federal_docket_comment_attachment)) {
+            throw Error("Invalid input.")
+        }
+        this.federal_docket_comment_attachment_id = federal_docket_comment_attachment.federal_docket_comment_attachment_id
+        this.attachment_number = federal_docket_comment_attachment.attachment_number
+        this.federal_docket_comment_id = federal_docket_comment_attachment.federal_docket_comment_id
+        this.urls = federal_docket_comment_attachment.urls
+        this.s3_filenames = federal_docket_comment_attachment.s3_filenames
+    }
+
+    static is(federal_docket_comment_attachment : any) : federal_docket_comment_attachment is FederalDocketCommentAttachment {
+        return (
+            federal_docket_comment_attachment !== undefined &&
+            typeof federal_docket_comment_attachment.federal_docket_comment_attachment_id === "string" &&
+            typeof federal_docket_comment_attachment.federal_docket_comment_id === "string" &&
+            typeof federal_docket_comment_attachment.attachment_number === "number" &&
+            Array.isArray(federal_docket_comment_attachment.urls) && federal_docket_comment_attachment.urls.every((url : any) => typeof url === "string") &&
+            (federal_docket_comment_attachment.s3_filenames === undefined || Array.isArray(federal_docket_comment_attachment.s3_filenames) && federal_docket_comment_attachment.s3_filenames.every((s3_filename : any) => typeof s3_filename === "string"))
+        )
+    }
+}

package/src/types/federal_dockets/FederalDocketDocument.ts

@@ -0,0 +1,82 @@
+export const federal_docket_document_type_ids = ["N", "P", "R", "S", "O"] as const
+
+export type FederalDocketDocumentTypeID = typeof federal_docket_document_type_ids[number]
+
+export function is_federal_docket_document_type_id(federal_docket_document_type_id : any) : federal_docket_document_type_id is FederalDocketDocumentTypeID {
+    return federal_docket_document_type_ids.includes(federal_docket_document_type_id)
+}
+
+export class FederalDocketDocument {
+    readonly federal_docket_document_id : string
+    readonly federal_docket_agency_id : string
+    readonly federal_docket_id? : string
+    readonly type_id : FederalDocketDocumentTypeID
+    readonly subtype_id? : string
+    readonly federal_register_document_id? : string
+    readonly title : string
+    readonly publish_time? : string
+    readonly modify_time? : string
+    readonly comment_start_time? : string
+    readonly comment_end_time? : string
+    readonly comments_open : boolean
+    readonly comments_late_allow : boolean
+    readonly is_withdrawn : boolean
+    readonly author_date? : string
+    readonly author_names : string[]
+    readonly media_type_id? : string
+    readonly abstract? : string
+    readonly urls : string[]
+    readonly s3_filenames? : string[]
+
+    constructor(federal_docket_document : any) {
+        if (!FederalDocketDocument.is(federal_docket_document)) {
+            throw Error("Invalid input.")
+        }
+        this.federal_docket_document_id = federal_docket_document.federal_docket_document_id
+        this.federal_docket_agency_id = federal_docket_document.federal_docket_agency_id
+        this.federal_docket_id = federal_docket_document.federal_docket_id
+        this.type_id = federal_docket_document.type_id
+        this.subtype_id = federal_docket_document.subtype_id
+        this.federal_register_document_id = federal_docket_document.federal_register_document_id
+        this.title = federal_docket_document.title
+        this.publish_time = federal_docket_document.publish_time
+        this.modify_time = federal_docket_document.modify_time
+        this.comment_start_time = federal_docket_document.comment_start_time
+        this.comment_end_time = federal_docket_document.comment_end_time
+        this.comments_open = federal_docket_document.comments_open
+        this.comments_late_allow = federal_docket_document.comments_late_allow
+        this.is_withdrawn = federal_docket_document.is_withdrawn
+        this.author_date = federal_docket_document.author_date
+        this.author_names = federal_docket_document.author_names
+        this.media_type_id = federal_docket_document.media_type_id
+        this.abstract = federal_docket_document.abstract
+        this.urls = federal_docket_document.urls
+        this.s3_filenames = federal_docket_document.s3_filenames
+    }
+
+    static is(federal_docket_document : any) : federal_docket_document is FederalDocketDocument {
+        return (
+            federal_docket_document !== undefined &&
+            typeof federal_docket_document.federal_docket_document_id === "string" &&
+            typeof federal_docket_document.federal_docket_agency_id === "string" &&
+            (federal_docket_document.federal_docket_id === undefined || typeof federal_docket_document.federal_docket_id === "string") &&
+            is_federal_docket_document_type_id(federal_docket_document.type_id) &&
+            (federal_docket_document.subtype_id === undefined || typeof federal_docket_document.subtype_id === "string") &&
+            (federal_docket_document.federal_register_document_id === undefined || typeof federal_docket_document.federal_register_document_id === "string") &&
+            typeof federal_docket_document.title === "string" &&
+            (federal_docket_document.publish_time === undefined || typeof federal_docket_document.publish_time === "string") &&
+            (federal_docket_document.modify_time === undefined || typeof federal_docket_document.modify_time === "string") &&
+            (federal_docket_document.comment_start_time === undefined || typeof federal_docket_document.comment_start_time === "string") &&
+            (federal_docket_document.comment_end_time === undefined || typeof federal_docket_document.comment_end_time === "string") &&
+            typeof federal_docket_document.comments_open === "boolean" &&
+            typeof federal_docket_document.comments_late_allow === "boolean" &&
+            typeof federal_docket_document.is_withdrawn === "boolean" &&
+            (federal_docket_document.author_date === undefined || typeof federal_docket_document.author_date === "string") &&
+            Array.isArray(federal_docket_document.author_names) && federal_docket_document.author_names.every((author_name : any) => typeof author_name === "string") &&
+            (federal_docket_document.media_type_id === undefined || typeof federal_docket_document.media_type_id === "string") &&
+            (federal_docket_document.abstract === undefined || typeof federal_docket_document.abstract === "string") &&
+            Array.isArray(federal_docket_document.urls) && federal_docket_document.urls.every((url : any) => typeof url === "string") &&
+            (federal_docket_document.s3_filenames === undefined || Array.isArray(federal_docket_document.s3_filenames) && federal_docket_document.s3_filenames.every((s3_filename : any) => typeof s3_filename === "string"))
+        )
+    }
+}

package/src/types/{AR → state_permits/AR}/ARStateFacility.ts

@@ -1,4 +1,4 @@
-import { is_state_id, StateID } from "../State"
+import { is_state_id, StateID } from "../../State"
 import { ARStatePermitAux } from "./ARStatePermit"
 
 export class ARStateFacility {

package/src/types/{AR → state_permits/AR}/ARStatePermit.ts

@@ -1,4 +1,4 @@
-import { is_state_id, StateID } from "../State"
+import { is_state_id, StateID } from "../../State"
 import { ARStateFacility } from "./ARStateFacility"
 import { ARStatePermitSourceAux } from "./ARStatePermitSource"
 

package/src/types/{AR → state_permits/AR}/ARStatePermitSource.ts

@@ -1,4 +1,4 @@
-import { is_state_id, StateID } from "../State"
+import { is_state_id, StateID } from "../../State"
 import { ARStatePermit, ARStatePermitAux } from "./ARStatePermit"
 import { ARStatePermitSourcePollutant } from "./ARStatePermitSourcePollutant"
 

package/src/types/{AR → state_permits/AR}/ARStatePermitSourcePollutant.ts

@@ -1,4 +1,4 @@
-import { is_state_id, StateID } from "../State"
+import { is_state_id, StateID } from "../../State"
 
 export class ARStatePermitSourcePollutant {
     readonly state_permit_source_pollutant_id : string

package/src/types/{KY → state_permits/KY}/KYStateFacility.ts

@@ -1,4 +1,4 @@
-import { is_state_id, StateID } from "../State"
+import { is_state_id, StateID } from "../../State"
 
 export class KYStateFacility {
     readonly state_facility_id : string

package/src/types/{KY → state_permits/KY}/KYStatePermit.ts

@@ -1,4 +1,4 @@
-import { is_state_id, StateID } from "../State"
+import { is_state_id, StateID } from "../../State"
 
 export class KYStatePermit {
     readonly state_permit_id : string 

package/src/types/{NC → state_permits/NC}/NCStateFacility.ts

@@ -1,4 +1,4 @@
-import { is_state_id, StateID } from "../State"
+import { is_state_id, StateID } from "../../State"
 
 export class NCStateFacility {
     readonly state_facility_id : string

package/src/types/{NC → state_permits/NC}/NCStatePermit.ts

@@ -1,4 +1,4 @@
-import { is_state_id, StateID } from "../State"
+import { is_state_id, StateID } from "../../State"
 
 
 export class NCStatePermit {

package/src/types/state_permits/TN/TNStateFacility.ts

@@ -0,0 +1,35 @@
+import { is_state_id, StateID } from "../../State"
+
+export class TNStateFacility {
+    readonly state_facility_id : string
+    readonly state_id : StateID
+    readonly facility_id : string
+    readonly name : string
+    readonly site_address_city : string
+    readonly site_address_county : string
+    readonly [x : string] : any
+
+    constructor(state_facility : TNStateFacility) {
+        if (!TNStateFacility.is(state_facility)) {
+            throw Error("Invalid input.")
+        }
+        this.state_facility_id = state_facility.state_facility_id
+        this.state_id = state_facility.state_id
+        this.facility_id = state_facility.facility_id
+        this.name = state_facility.name
+        this.site_address_city = state_facility.site_address_city
+        this.site_address_county = state_facility.site_address_county
+    }
+
+    static is(state_facility : any) : state_facility is TNStateFacility {
+        return (
+            state_facility !== undefined &&
+            is_state_id(state_facility.state_id) && state_facility.state_id === "TN" &&
+            typeof state_facility.state_facility_id === "string" &&
+            typeof state_facility.facility_id === "string" &&
+            typeof state_facility.name === "string" &&
+            (state_facility.site_address_city === undefined || typeof state_facility.site_address_city === "string") &&
+            (state_facility.site_address_county === undefined || typeof state_facility.site_address_county === "string")
+        )
+    }
+}

package/src/types/state_permits/TN/TNStatePermit.ts

@@ -0,0 +1,56 @@
+import { is_state_id, StateID } from "../../State"
+
+export class TNStatePermit {
+    readonly state_permit_id : string 
+    readonly state_id : StateID
+    readonly permit_id : string
+    readonly state_facility_id : string
+    readonly issue_date? : string
+    readonly effective_date? : string
+    readonly expiration_date? : string
+    readonly status? : string
+    readonly type_id? : string
+    readonly subtype_id? : string
+    readonly s3_filename? : string
+    readonly s3_text_filename? : string
+    readonly source_ids? : string[]
+    readonly [x : string] : any
+
+    constructor(state_permit : TNStatePermit) {
+        if (!TNStatePermit.is(state_permit)) {
+            throw Error("Invalid input.")
+        }
+        this.state_permit_id = state_permit.state_permit_id
+        this.state_id = state_permit.state_id
+        this.permit_id = state_permit.permit_id
+        this.state_facility_id = state_permit.state_facility_id
+        this.issue_date = state_permit.issue_date
+        this.expiration_date = state_permit.expiration_date
+        this.effective_date = state_permit.effective_date
+        this.status = state_permit.status
+        this.type_id = state_permit.type_id
+        this.subtype_id = state_permit.subtype_id
+        this.s3_filename = state_permit.s3_filename
+        this.s3_text_filename = state_permit.s3_text_filename
+        this.source_ids = state_permit.source_ids
+    }
+
+    static is(state_permit : any) : state_permit is TNStatePermit {
+        return (
+            state_permit !== undefined &&
+            typeof state_permit.state_permit_id === "string" &&
+            is_state_id(state_permit.state_id) && state_permit.state_id === "TN" &&
+            typeof state_permit.permit_id === "string" &&
+            typeof state_permit.state_facility_id === "string" &&
+            (state_permit.issue_date === undefined || typeof state_permit.issue_date === "string") &&
+            (state_permit.expiration_date === undefined || typeof state_permit.expiration_date === "string") &&
+            (state_permit.effective_date === undefined || typeof state_permit.effective_date === "string") &&
+            (state_permit.status === undefined || typeof state_permit.status === "string") &&
+            (state_permit.type_id === undefined || typeof state_permit.type_id === "string") &&
+            (state_permit.subtype_id === undefined || typeof state_permit.subtype_id === "string") &&
+            (state_permit.s3_filename === undefined || typeof state_permit.s3_filename === "string") &&
+            (state_permit.s3_text_filename === undefined || typeof state_permit.s3_text_filename === "string") &&
+            (state_permit.source_ids === undefined || Array.isArray(state_permit.source_ids) && state_permit.source_ids.map((source_id : any) => typeof source_id === "string"))
+        )
+    }
+}