triangle-types 1.0.166 → 1.0.167

package/dist/src/index.d.ts

@@ -12,6 +12,7 @@ export * from "./types/federal_census/FederalCensus.js";
 export * from "./types/federal_census/FederalCensusBlock.js";
 export * from "./types/federal_census/FederalCensusCounty.js";
 export * from "./types/federal_census/FederalCensusMunicipality.js";
+export * from "./types/federal_census/FederalCensusSchoolDistrict.js";
 export * from "./types/federal_census/FederalCensusTract.js";
 export * from "./types/federal_elections/FederalElection.js";
 export * from "./types/federal_elections/FederalElectionCommittee.js";

package/dist/src/index.js

@@ -12,6 +12,7 @@ export * from "./types/federal_census/FederalCensus.js";
 export * from "./types/federal_census/FederalCensusBlock.js";
 export * from "./types/federal_census/FederalCensusCounty.js";
 export * from "./types/federal_census/FederalCensusMunicipality.js";
+export * from "./types/federal_census/FederalCensusSchoolDistrict.js";
 export * from "./types/federal_census/FederalCensusTract.js";
 export * from "./types/federal_elections/FederalElection.js";
 export * from "./types/federal_elections/FederalElectionCommittee.js";

package/dist/src/types/federal_census/FederalCensusSchoolDistrict.d.ts

@@ -0,0 +1,15 @@
+import { StateID } from "../regions/State.js";
+export declare const federal_census_school_district_type_ids: readonly ["UNIFIED", "PRIMARY", "SECONDARY"];
+export type FederalCensusSchoolDistrictTypeID = typeof federal_census_school_district_type_ids[number];
+export declare function is_federal_census_school_district_type_id(federal_census_school_district_type_id: any): federal_census_school_district_type_id is FederalCensusSchoolDistrictTypeID;
+export declare class FederalCensusSchoolDistrict {
+    readonly federal_census_school_district_id: string;
+    readonly federal_census_id: number;
+    readonly school_district_id: string;
+    readonly state_id: StateID;
+    readonly school_district_type_id?: FederalCensusSchoolDistrictTypeID;
+    readonly name: string;
+    readonly s3_id: string;
+    constructor(federal_census_school_district: any);
+    static is(federal_census_school_district: any): federal_census_school_district is FederalCensusSchoolDistrict;
+}

package/dist/src/types/federal_census/FederalCensusSchoolDistrict.js

@@ -0,0 +1,36 @@
+import { is_state_id } from "../regions/State.js";
+export const federal_census_school_district_type_ids = ["UNIFIED", "PRIMARY", "SECONDARY"];
+export function is_federal_census_school_district_type_id(federal_census_school_district_type_id) {
+    return federal_census_school_district_type_ids.includes(federal_census_school_district_type_id);
+}
+export class FederalCensusSchoolDistrict {
+    federal_census_school_district_id;
+    federal_census_id;
+    school_district_id;
+    state_id;
+    school_district_type_id;
+    name;
+    s3_id;
+    constructor(federal_census_school_district) {
+        if (!FederalCensusSchoolDistrict.is(federal_census_school_district)) {
+            throw Error("Invalid input.");
+        }
+        this.federal_census_school_district_id = federal_census_school_district.federal_census_school_district_id;
+        this.federal_census_id = federal_census_school_district.federal_census_id;
+        this.school_district_id = federal_census_school_district.school_district_id;
+        this.state_id = federal_census_school_district.state_id;
+        this.school_district_type_id = federal_census_school_district.school_district_type_id;
+        this.name = federal_census_school_district.name;
+        this.s3_id = federal_census_school_district.s3_id;
+    }
+    static is(federal_census_school_district) {
+        return (federal_census_school_district !== undefined &&
+            typeof federal_census_school_district.federal_census_school_district_id === "string" &&
+            typeof federal_census_school_district.federal_census_id === "number" &&
+            typeof federal_census_school_district.school_district_id === "string" &&
+            is_state_id(federal_census_school_district.state_id) &&
+            (federal_census_school_district.school_district_type_id === undefined || typeof federal_census_school_district.school_district_type_id === "string") &&
+            typeof federal_census_school_district.name === "string" &&
+            typeof federal_census_school_district.s3_id === "string");
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "triangle-types",
-    "version": "1.0.166",
+    "version": "1.0.167",
     "main": "dist/src/index.js",
     "types": "dist/src/index.d.ts",
     "scripts": {

package/src/index.ts

@@ -15,6 +15,7 @@ export * from "./types/federal_census/FederalCensus"
 export * from "./types/federal_census/FederalCensusBlock"
 export * from "./types/federal_census/FederalCensusCounty"
 export * from "./types/federal_census/FederalCensusMunicipality"
+export * from "./types/federal_census/FederalCensusSchoolDistrict"
 export * from "./types/federal_census/FederalCensusTract"
 
 export * from "./types/federal_elections/FederalElection"

package/src/types/federal_census/FederalCensusSchoolDistrict.ts

@@ -0,0 +1,46 @@
+import { is_state_id, StateID } from "../regions/State"
+
+export const federal_census_school_district_type_ids = ["UNIFIED", "PRIMARY", "SECONDARY"] as const
+
+export type FederalCensusSchoolDistrictTypeID = typeof federal_census_school_district_type_ids[number]
+
+export function is_federal_census_school_district_type_id(federal_census_school_district_type_id : any) : federal_census_school_district_type_id is FederalCensusSchoolDistrictTypeID {
+    return federal_census_school_district_type_ids.includes(federal_census_school_district_type_id)
+}
+
+export class FederalCensusSchoolDistrict {
+    readonly federal_census_school_district_id : string
+    readonly federal_census_id : number
+    readonly school_district_id : string
+    readonly state_id : StateID
+    readonly school_district_type_id? : FederalCensusSchoolDistrictTypeID
+    readonly name : string
+    readonly s3_id : string
+
+    constructor(federal_census_school_district : any) {
+        if (!FederalCensusSchoolDistrict.is(federal_census_school_district)) {
+            throw Error("Invalid input.")
+        }
+        this.federal_census_school_district_id = federal_census_school_district.federal_census_school_district_id
+        this.federal_census_id = federal_census_school_district.federal_census_id
+        this.school_district_id = federal_census_school_district.school_district_id
+        this.state_id = federal_census_school_district.state_id
+        this.school_district_type_id = federal_census_school_district.school_district_type_id
+        this.name = federal_census_school_district.name
+        this.s3_id = federal_census_school_district.s3_id
+    }
+
+    static is(federal_census_school_district : any) : federal_census_school_district is FederalCensusSchoolDistrict {
+        return (
+            federal_census_school_district !== undefined &&
+            typeof federal_census_school_district.federal_census_school_district_id === "string" &&
+            typeof federal_census_school_district.federal_census_id === "number" &&
+            typeof federal_census_school_district.school_district_id === "string" &&
+            is_state_id(federal_census_school_district.state_id) &&
+            (federal_census_school_district.school_district_type_id === undefined || typeof federal_census_school_district.school_district_type_id === "string") &&
+            typeof federal_census_school_district.name === "string" &&
+            typeof federal_census_school_district.s3_id === "string"
+        )
+    }
+
+}