@mailwoman/tiger 1.0.0

package/README.md

@@ -0,0 +1,3 @@
+# Mailwoman TIGER
+
+This package contains a collection of utilities for working with US Census TIGER data.

package/block-group.ts

@@ -0,0 +1,151 @@
+/**
+ * @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"
+
+/**
+ * @title TIGER Block Group
+ * @public
+ */
+export interface TIGERBlockGroup {
+	/**
+	 * @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
+
+	/**
+	 * @title Block Group GEOID
+	 *
+	 * @minLength 10
+	 * @maxLength 10
+	 * @pattern ^\d{10}$
+	 */
+	GEOID: string
+
+	/**
+	 * Fully Qualified GEOID as used in CEDSCI and other systems.
+	 *
+	 * @title Fully Qualified Geographic Identifier
+	 * @minLength 19
+	 * @maxLength 19
+	 * @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: TIGERClassCode
+
+	/**
+	 * Functional Status.
+	 *
+	 * @title Functional Status
+	 * @minLength 1
+	 * @maxLength 1
+	 * @pattern ^[A-Z]$
+	 */
+	FUNCSTAT: TIGERFunctionalStatus
+
+	/**
+	 * L 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 block group.
+	 *
+	 * @title Name
+	 * @minLength 1
+	 * @maxLength 100
+	 */
+	NAME: string
+}