@mailwoman/tiger 1.0.0

package/constants.ts

@@ -0,0 +1,252 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+
+import { TIGERClassCode } from "./class-code.js"
+import { TIGERFunctionalStatus } from "./functional-status.js"
+import {
+	type FIPSBlockCode,
+	type FIPSBlockGroupCode,
+	type FIPSCongressionalDistrictCode,
+	type FIPSCountyCode,
+	type FIPSCountySubDivisionCode,
+	type FIPSPlaceCode,
+	type FIPSTractCode,
+	GeoIDPart,
+} from "./geoid.js"
+import { LegalStatisticalAreaDescription } from "./legal-statistical-area.js"
+import { FIPSStateCode } from "./state.js"
+
+/**
+ * A code indicating the classification of the block, i.e. urban or rural.
+ *
+ * @title TIGER Geographic Classification
+ *
+ * @minLength 1
+ * @maxLength 1
+ */
+export enum TIGERGeographicClassification {
+	Urban = "U",
+	Rural = "R",
+}
+
+/**
+ * @title Land/Water Block Type
+ *
+ * A code indicating the type of feature represented by the land/water block.
+ */
+export enum LandWaterBlockType {
+	/**
+	 * Block is land.
+	 */
+	Land = "L",
+	/**
+	 * Block is water.
+	 */
+	Water = "W",
+}
+
+/**
+ * @title TIGER Property
+ */
+export enum TIGERProperty {
+	/**
+	 * @title Geographic Identifier
+	 */
+	GeoID = "GEOID",
+	/**
+	 * @title Display Name
+	 */
+	DisplayName = "display_name",
+	/**
+	 * @title Urban/Rural Code
+	 */
+	UrbanRuralCode = "urban_rural_code",
+	/**
+	 * @title Urban Area Code
+	 */
+	UrbanizedAreaCode = "urbanized_area_code",
+	/**
+	 * @title Land Area (square meters)
+	 */
+	LandAreaSqm = "land_area_sqm",
+	/**
+	 * @title Water Area (square meters)
+	 */
+	WaterAreaSqm = "water_area_sqm",
+	/**
+	 * @title Housing Unit Count
+	 */
+	HousingUnitCount = "housing_unit_count",
+	/**
+	 * @title Population Count
+	 */
+	Population = "population",
+	/**
+	 * @title Functional Status
+	 */
+	FunctionalStatus = "functional_status",
+	/**
+	 * @title Centroid Latitude
+	 */
+	CentroidLatitude = "latitude",
+	/**
+	 * @title Centroid Longitude
+	 */
+	CentroidLongitude = "longitude",
+	/**
+	 * @title Legal/Statistical Area Description
+	 */
+	LegalStatisticalAreaDescription = "legal_statistical_area_description",
+	/**
+	 * @title MAF/TIGER Feature Class Code
+	 */
+	ClassCode = "class_code",
+}
+
+/**
+ * Properties common to all Census.
+ */
+export interface TIGERPropertyRecord<GeoID extends string = string> {
+	/**
+	 * @title Geographic Identifier
+	 */
+	[TIGERProperty.GeoID]: GeoID
+
+	/**
+	 * @title State FIPS Code.
+	 */
+	[GeoIDPart.State]: FIPSStateCode
+
+	/**
+	 * @title County
+	 */
+	[GeoIDPart.County]: FIPSCountyCode
+
+	/**
+	 * @title County Sub Division
+	 */
+	[GeoIDPart.CountySubDivision]: FIPSCountySubDivisionCode
+
+	/**
+	 * @title Tract
+	 */
+	[GeoIDPart.Tract]: FIPSTractCode
+
+	/**
+	 * @title Place
+	 */
+	[GeoIDPart.Place]: FIPSPlaceCode
+
+	/**
+	 * @title Congressional District
+	 */
+	[GeoIDPart.CongressionalDistrict]: FIPSCongressionalDistrictCode
+
+	/**
+	 * @title Block
+	 */
+	[GeoIDPart.Block]: FIPSBlockCode
+
+	/**
+	 * @title Block Group
+	 */
+	[GeoIDPart.BlockGroup]: FIPSBlockGroupCode
+
+	/**
+	 * Urban/Rural Code.
+	 *
+	 * @title Urban/Rural Code
+	 *
+	 * @minLength 1
+	 * @maxLength 1
+	 */
+	[TIGERProperty.UrbanRuralCode]: TIGERGeographicClassification
+
+	/**
+	 * A code indicating a specific urban area, such as a specific city, or a specific region of
+	 * cities.
+	 *
+	 * For example, 23824 references Detroit, MI. 63217 references the region of New York City, Jersey
+	 * City, and Newark.
+	 *
+	 * @title Urban Area Code
+	 * @minLength 5
+	 * @maxLength 5
+	 */
+	[TIGERProperty.UrbanizedAreaCode]: string
+
+	/**
+	 * Land Area in square meters.
+	 *
+	 * @type {integer}
+	 * @title Land Area
+	 * @minimum 0
+	 */
+	[TIGERProperty.LandAreaSqm]: number
+
+	/**
+	 * Water Area in square meters.
+	 *
+	 * @type {integer}
+	 * @title Water Area
+	 * @minimum 0
+	 */
+	[TIGERProperty.WaterAreaSqm]: number
+
+	/**
+	 * The tabulated block's housing unit count.
+	 *
+	 * Note: This is the number of housing units in the block, not the number of people.
+	 *
+	 * @type {integer}
+	 * @title Housing Units
+	 * @minimum 0
+	 */
+	[TIGERProperty.HousingUnitCount]: number
+
+	/**
+	 * The tabulated block's population count.
+	 *
+	 * @type {integer}
+	 * @title Population Count
+	 * @minimum 0
+	 */
+	[TIGERProperty.Population]: number
+
+	/**
+	 * @title Legal/Statistical Area Description
+	 */
+	[TIGERProperty.LegalStatisticalAreaDescription]: LegalStatisticalAreaDescription
+
+	/**
+	 * @title MAF/TIGER Feature Class Code
+	 */
+	[TIGERProperty.ClassCode]: TIGERClassCode
+
+	/**
+	 * Functional Status.
+	 *
+	 * @title Functional Status
+	 * @minLength 1
+	 * @maxLength 1
+	 * @pattern ^[A-Z]$
+	 */
+	[TIGERProperty.FunctionalStatus]: TIGERFunctionalStatus
+
+	/**
+	 * Longitude of the internal point.
+	 *
+	 * @title Centroid Longitude
+	 */
+	[TIGERProperty.CentroidLongitude]: number
+
+	/**
+	 * Latitude of the internal point.
+	 *
+	 * @title Centroid Latitude
+	 */
+	[TIGERProperty.CentroidLatitude]: number
+}

package/county-subdivision.ts

@@ -0,0 +1,154 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+
+import type { TIGERClassCode } from "./class-code.js"
+import type { TIGERFunctionalStatus } from "./functional-status.js"
+import type { LegalStatisticalAreaDescription } from "./legal-statistical-area.js"
+import type { AdminLevel1Code } from "./state.js"
+
+/**
+ * Census Geographic subdivision of a county.
+ *
+ * @title TIGER County Subdivision
+ * @public
+ */
+export interface TIGERCountySubdivision {
+	/**
+	 * @title State FIPS Code
+	 */
+	STATEFP: AdminLevel1Code
+
+	/**
+	 * @title County FIPS Code
+	 * @minLength 3
+	 * @maxLength 3
+	 * @pattern ^\d{3}$
+	 */
+	COUNTYFP: string
+
+	/**
+	 * @title County Subdivision FIPS Code
+	 *
+	 * @minLength 5
+	 * @maxLength 5
+	 * @pattern ^\d{5}$
+	 */
+	COUSUBFP: string
+
+	/**
+	 * @see {@link https://www.usgs.gov/us-board-on-geographic-names/domestic-names | USGS: Domestic Names}
+	 * @title County Subdivision GNIS Code
+	 *
+	 * @minLength 8
+	 * @maxLength 8
+	 * @pattern ^\d{8}$
+	 */
+	COUSUBNS: string
+	/**
+	 * Concatenation of current state FIPS code, county FIPS code, and county subdivision FIPS code.
+	 *
+	 * @see {@link https://www.census.gov/programs-surveys/geography/guidance/geo-identifiers.html | Census: GeoID}
+	 * @title County Sub-division Identifier
+	 * @minLength 10
+	 * @maxLength 20
+	 * @pattern ^\d{10,20}$
+	 */
+	GEOID: string
+
+	/**
+	 * Fully Qualified GEOID as used in CEDSCI and other systems.
+	 *
+	 * @title Fully Qualified Geographic Identifier
+	 * @minLength 19
+	 * @maxLength 29
+	 * @pattern ^\d{19}$
+	 */
+	GEOIDFQ: string
+
+	/**
+	 * Current name and the translated legal/statistical area description code for county
+	 * sub-division.
+	 *
+	 * @title Name/Legal Statistical Area Description
+	 * @minLength 1
+	 * @maxLength 100
+	 */
+	NAMELSAD: string
+
+	/**
+	 * Legal/Statistical Area Description.
+	 *
+	 * @title Legal/Statistical Area Description
+	 */
+	LSAD: LegalStatisticalAreaDescription
+
+	/**
+	 * Class Code.
+	 *
+	 * @title Class Code
+	 */
+	CLASSFP: TIGERClassCode
+
+	/**
+	 * MAF/TIGER Feature Class Code.
+	 *
+	 * @title MAF/TIGER Feature Class Code
+	 *
+	 * @minLength 5
+	 * @maxLength 5
+	 * @pattern ^[A-Z]\d{1}$
+	 */
+	MTFCC: string
+
+	/**
+	 * Functional Status.
+	 *
+	 * @title Functional Status
+	 * @minLength 1
+	 * @maxLength 1
+	 * @pattern ^[A-Z]$
+	 */
+	FUNCSTAT: TIGERFunctionalStatus
+
+	/**
+	 * Land Area in square meters.
+	 *
+	 * @title Land Area
+	 * @minimum 0
+	 */
+	ALAND: number
+
+	/**
+	 * Water Area in square meters.
+	 *
+	 * @title Water Area
+	 * @minimum 0
+	 */
+	AWATER: number
+
+	/**
+	 * Latitude of the internal point.
+	 *
+	 * @title Internal Point Latitude
+	 */
+	INTPTLAT: string
+
+	/**
+	 * Longitude of the internal point.
+	 *
+	 * @title Internal Point Longitude
+	 */
+	INTPTLON: string
+
+	/**
+	 * Name of the county subdivision.
+	 *
+	 * @title Name
+	 * @minLength 1
+	 * @maxLength 100
+	 */
+	NAME: string
+}

package/county.ts

@@ -0,0 +1,135 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+
+import { TIGERClassCode } from "./class-code.js"
+import { TIGERFunctionalStatus } from "./functional-status.js"
+import type { LegalStatisticalAreaDescription } from "./legal-statistical-area.js"
+import type { AdminLevel1Code } from "./state.js"
+
+/**
+ * @title TIGER County
+ * @public
+ */
+export interface TIGERCounty {
+	/**
+	 * @title State FIPS Code
+	 */
+	STATEFP: AdminLevel1Code
+
+	/**
+	 * @title County FIPS Code
+	 * @minLength 3
+	 * @maxLength 3
+	 * @pattern ^\d{3}$
+	 */
+	COUNTYFP: string
+
+	/**
+	 * @see {@link https://www.usgs.gov/us-board-on-geographic-names/domestic-names | USGS: Domestic Names}
+	 * @title County GNIS Code
+	 *
+	 * @minLength 8
+	 * @maxLength 8
+	 * @pattern ^\d{8}$
+	 */
+	GEOID: string
+
+	/**
+	 * Fully Qualified GEOID as used in CEDSCI and other systems.
+	 *
+	 * @title Fully Qualified Geographic Identifier
+	 * @minLength 19
+	 * @maxLength 29
+	 * @pattern ^\d{19}$
+	 */
+	GEOIDFQ: string
+
+	/**
+	 * Current name and the translated legal/statistical area description code for county
+	 * sub-division.
+	 *
+	 * @title Name/Legal Statistical Area Description
+	 * @minLength 1
+	 * @maxLength 100
+	 */
+	NAMELSAD: string
+
+	/**
+	 * Legal/Statistical Area Description.
+	 *
+	 * @title Legal/Statistical Area Description
+	 */
+	LSAD: LegalStatisticalAreaDescription
+
+	/**
+	 * Class Code.
+	 *
+	 * @title Class Code
+	 */
+	CLASSFP: TIGERClassCode
+
+	/**
+	 * MAF/TIGER Feature Class Code.
+	 *
+	 * @title MAF/TIGER Feature Class Code
+	 *
+	 * @minLength 5
+	 * @maxLength 5
+	 * @pattern ^[A-Z]\d{1}$
+	 */
+	MTFCC: string
+
+	/**
+	 * Functional Status.
+	 *
+	 * @title Functional Status
+	 * @minLength 1
+	 * @maxLength 1
+	 * @pattern ^[A-Z]$
+	 */
+	FUNCSTAT: TIGERFunctionalStatus
+
+	/**
+	 * Land Area in square meters.
+	 *
+	 * @title Land Area
+	 * @minimum 0
+	 */
+	ALAND: number
+
+	/**
+	 * Water Area in square meters.
+	 *
+	 * @title Water Area
+	 * @minimum 0
+	 */
+	AWATER: number
+
+	/**
+	 * Latitude of the internal point.
+	 *
+	 * @title Internal Point Latitude
+	 */
+	INTPTLAT: string
+
+	/**
+	 * Longitude of the internal point.
+	 *
+	 * @title Internal Point Longitude
+	 */
+	INTPTLON: string
+
+	/**
+	 * Name of the county.
+	 *
+	 * @title Name
+	 * @minLength 1
+	 * @maxLength 100
+	 */
+	NAME: string
+}
+
+export const TIGERCountySymbol = Symbol.for("TIGERCounty")