@mailwoman/tiger 1.0.0

package/out/geoid.d.ts

@@ -0,0 +1,438 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import type { Tagged } from "type-fest";
+import { AdminLevel1Code, FIPSStateCode } from "./state.js";
+/**
+ * A 4-digit number assigned by the Census to uniquely identify a block.
+ *
+ * ```txt
+ * (State Code)━━┳┓   ┏┳┳┳┳┳━━(Tract Code)
+ *               482012231001050
+ *                 ┗╋┛      ┗┻┻┻━(Block Code)
+ *            (County Code)
+ * ```
+ *
+ * @category Census
+ * @category FIPS
+ * @type {string}
+ * @see {@linkcode FIPSBlockGroupCode} for a less specific level.
+ * @see {@linkcode FIPSBlockGeoID} for the full GeoID.
+ * @pattern ^\d{4}$
+ * @minLength 4
+ * @maxLength 4
+ * @title FIPS Block Code
+ */
+export type FIPSBlockCode = Tagged<string, "FIPSBlockCode">;
+/**
+ * A 15-digit number assigned by the Census to uniquely identify a block.
+ *
+ * ```txt
+ * (State Code)━━┳┓   ┏┳┳┳┳┳━━(Tract Code)
+ *               482012231001050
+ *                 ┗╋┛      ┗┻┻┻━(Block Code)
+ *            (County Code)
+ * ```
+ *
+ * @category Census
+ * @category FIPS
+ * @type {string}
+ * @see {@linkcode FIPSBlockCode} for the 4-digit version.
+ * @pattern ^\d{15}$
+ * @minLength 15
+ * @maxLength 15
+ * @title FIPS Block Geo ID
+ */
+export type FIPSBlockGeoID = Tagged<string, "FIPSBlockGeoID">;
+/**
+ * A 1-digit number assigned by the Census to uniquely identify a block group.
+ *
+ * ```txt
+ * (State Code)━━┳┓   ┏┳┳┳┳┳━━(Tract Code)
+ *               060133740002###
+ *                 ┗╋┛      ┗━(Block Group Code)
+ *            (County Code)
+ * ```
+ *
+ * @category Census
+ * @category FIPS
+ * @type {string}
+ * @see {@linkcode FIPSBlockCode} for a more specific level.
+ * @see {@linkcode FIPSTractCode} for a less specific level.
+ * @pattern ^\d{1}$
+ * @minLength 1
+ * @maxLength 1
+ * @title FIPS Block Group Code
+ */
+export type FIPSBlockGroupCode = Tagged<string, "FIPSBlockGroupCode">;
+/**
+ * A 6-digit number assigned by the Census to uniquely identify a tract.
+ *
+ * ```txt
+ * (State Code)━━┳┓   ┏┳┳┳┳┳━━(Tract Code)
+ *               06013374000####
+ *                 ┗╋┛
+ *            (County Code)
+ * ```
+ *
+ * @category Census
+ * @category FIPS
+ * @type {string}
+ * @see {@linkcode FIPSBlockGroupCode} for a more specific level.
+ * @see {@linkcode FIPSCountySubDivisionCode} for a less specific level.
+ * @pattern ^\d{6}$
+ * @minLength 6
+ * @maxLength 6
+ * @title FIPS Tract Code
+ */
+export type FIPSTractCode = Tagged<string, "FIPSTractCode">;
+/**
+ * An 11-digit number assigned by the Census to uniquely identify a tract.
+ *
+ * ```txt
+ * (State Code)━━┳┓   ┏┳┳┳┳┳━━(Tract Code)
+ *               06013374000####
+ *                 ┗╋┛
+ *            (County Code)
+ * ```
+ *
+ * @category Census
+ * @category FIPS
+ * @type {string}
+ * @see {@linkcode FIPSBlockCode} for the 4-digit version.
+ * @pattern ^\d{6}$
+ * @minLength 6
+ * @maxLength 6
+ * @title FIPS Tract Geo ID
+ */
+export type FIPSTractGeoID = Tagged<string, "FIPSTractGeoID">;
+/**
+ * A 5-digit number assigned by the Census to uniquely identify a county sub-division.
+ *
+ * ```txt
+ * (State Code)━━┳┓   ┏┳┳┳┳━━(County Sub-Division Code)
+ *               0601337400#####
+ *                 ┗╋┛
+ *            (County Code)
+ * ```
+ *
+ * @category Census
+ * @category FIPS
+ * @type {string}
+ * @see {@linkcode FIPSTractCode} for a more specific level.
+ * @see {@linkcode FIPSCountyCode} for a less specific level.
+ * @pattern ^\d{5}$
+ * @minLength 5
+ * @maxLength 5
+ * @title FIPS County Sub-Division Code
+ */
+export type FIPSCountySubDivisionCode = Tagged<string, "FIPSCountySubDivisionCode">;
+/**
+ * A 3-digit number assigned by the Census to uniquely identify a county.
+ *
+ * ```txt
+ * (State Code)━━┳┓
+ *               06013##########
+ *                 ┗┻┻━(County Code)
+ * ```
+ *
+ * @category Census
+ * @category FIPS
+ * @type {string}
+ * @see {@linkcode FIPSCountySubDivisionCode} for a more specific level.
+ * @see {@linkcode AdminLevel1Code} for a less specific level.
+ * @pattern ^\d{3}$
+ * @minLength 3
+ * @maxLength 3
+ * @title FIPS County Code
+ */
+export type FIPSCountyCode = Tagged<string, "FIPSCountyCode">;
+/**
+ * A 5-digit number assigned by the Census to uniquely identify a place.
+ *
+ * ```txt
+ * (State Code)━━┳┓
+ *               4835000########
+ *                 ┗┻┻┻┻━(Place Code)
+ * ```
+ *
+ * @category Census
+ * @category FIPS
+ * @type {string}
+ * @minLength 5
+ * @maxLength 5
+ * @pattern ^\d{5}$
+ * @title FIPS Place Code
+ */
+export type FIPSPlaceCode = Tagged<string, "FIPSPlaceCode">;
+/**
+ * A 2-digit number assigned by the Census to uniquely identify a congressional district.
+ *
+ * ```txt
+ * (State Code)━━┳┓
+ *               0902···········
+ *                 ┗┻━(Congressional District Code)
+ * ```
+ *
+ * @category Census
+ * @category FIPS
+ * @type {string}
+ * @see {@linkcode AdminLevel1Code} for a less specific level.
+ * @see {@linkcode FIPSPlaceCode} for a more specific level.
+ * @pattern ^\d{2}$
+ * @minLength 2
+ * @maxLength 2
+ * @title FIPS Congressional District Code
+ */
+export type FIPSCongressionalDistrictCode = Tagged<string, "FIPSConressionalDistrictCode">;
+/**
+ * A part of a GeoID to it's respective name.
+ *
+ * @internal
+ */
+export declare enum GeoIDPart {
+    /**
+     * The state code part of a GeoID.
+     *
+     * Sometimes considered the administrative area level 1 code.
+     */
+    State = "state_code",
+    /**
+     * The county code part of a GeoID.
+     *
+     * Sometimes considered the administrative area level 2 code.
+     */
+    County = "county_code",
+    /**
+     * The county subdivision code part of a GeoID.
+     *
+     * Sometimes considered the administrative area level 3 code.
+     */
+    CountySubDivision = "county_sub_division_code",
+    /**
+     * The congressional district code part of a GeoID.
+     */
+    CongressionalDistrict = "congressional_district_code",
+    /**
+     * A place as defined by the Census, such as a city or town.
+     */
+    Place = "place_code",
+    /**
+     * The tract code part of a GeoID. The third most granular part.
+     */
+    Tract = "tract_code",
+    /**
+     * The block group code part of a GeoID. The second most granular part.
+     */
+    BlockGroup = "block_group_code",
+    /**
+     * The block code part of a GeoID. The most granular part.
+     */
+    Block = "block_code"
+}
+/**
+ * Mapping of GeoID parts to their respective FIPS codes types.
+ *
+ * @internal
+ */
+export type GeoIDPartMapping = {
+    [GeoIDPart.State]: FIPSStateCode;
+    [GeoIDPart.County]: FIPSCountyCode;
+    [GeoIDPart.CountySubDivision]: FIPSCountySubDivisionCode;
+    [GeoIDPart.CongressionalDistrict]: FIPSCongressionalDistrictCode;
+    [GeoIDPart.Place]: FIPSPlaceCode;
+    [GeoIDPart.Tract]: FIPSTractCode;
+    [GeoIDPart.BlockGroup]: FIPSBlockGroupCode;
+    [GeoIDPart.Block]: FIPSBlockCode;
+};
+/**
+ * Record of GeoID parts and their respective lengths.
+ *
+ * Note that the length of a GeoID is the sum of the lengths of its parts.
+ *
+ * @internal
+ */
+export declare const GeoIDPartLength: {
+    readonly state_code: 2;
+    readonly county_code: 3;
+    readonly county_sub_division_code: 5;
+    readonly congressional_district_code: 2;
+    readonly place_code: 5;
+    readonly tract_code: 6;
+    readonly block_group_code: 1;
+    readonly block_code: 4;
+};
+/**
+ * A GeoID parsed to the block level. The most granular level.
+ *
+ * @title Parsed GeoID Block Level
+ * @public
+ */
+export interface ParsedGeoIDBlockLevel {
+    [GeoIDPart.State]: FIPSStateCode;
+    [GeoIDPart.County]: FIPSCountyCode;
+    [GeoIDPart.CountySubDivision]: FIPSCountySubDivisionCode;
+    [GeoIDPart.Tract]: FIPSTractCode;
+    [GeoIDPart.Place]: FIPSPlaceCode;
+    [GeoIDPart.BlockGroup]: FIPSBlockGroupCode;
+    [GeoIDPart.Block]: FIPSBlockCode;
+    [GeoIDPart.BlockGroup]: FIPSBlockGroupCode;
+    [GeoIDPart.CongressionalDistrict]: FIPSCongressionalDistrictCode;
+}
+/**
+ * A GeoID parsed to the block group level. The second most granular level.
+ *
+ * @internal
+ */
+export type ParsedGeoIDBlockGroupLevel = {
+    [GeoIDPart.State]: AdminLevel1Code;
+    [GeoIDPart.County]: FIPSCountyCode;
+    [GeoIDPart.CountySubDivision]: FIPSCountySubDivisionCode;
+    [GeoIDPart.Tract]: FIPSTractCode;
+    [GeoIDPart.BlockGroup]: FIPSBlockGroupCode;
+    [GeoIDPart.Block]: undefined;
+};
+/**
+ * A GeoID parsed to the tract level. The third most granular level.
+ *
+ * @internal
+ */
+export type ParsedGeoIDTractLevel = {
+    [GeoIDPart.State]: AdminLevel1Code;
+    [GeoIDPart.County]: FIPSCountyCode;
+    [GeoIDPart.CountySubDivision]: FIPSCountySubDivisionCode;
+    [GeoIDPart.Tract]: FIPSTractCode;
+    [GeoIDPart.BlockGroup]: undefined;
+    [GeoIDPart.Block]: undefined;
+};
+/**
+ * A GeoID parsed to a partial level.
+ *
+ * @internal
+ */
+export type ParsedGeoIDPartial = {
+    [P in GeoIDPart]?: string;
+};
+/**
+ * A GeoID parsed to the county-subdivision level. The fourth most granular level.
+ *
+ * @internal
+ */
+export type ParsedGeoIDCountySubDivisionLevel = {
+    [GeoIDPart.State]: AdminLevel1Code;
+    [GeoIDPart.County]: FIPSCountyCode;
+    [GeoIDPart.CountySubDivision]: FIPSCountySubDivisionCode;
+    [GeoIDPart.Tract]: undefined;
+    [GeoIDPart.BlockGroup]: undefined;
+    [GeoIDPart.Block]: undefined;
+};
+/**
+ * A GeoID parsed to the county level. The fifth most granular level.
+ *
+ * @internal
+ */
+export type ParsedGeoIDCountyLevel = {
+    [GeoIDPart.State]: AdminLevel1Code;
+    [GeoIDPart.County]: FIPSCountyCode;
+    [GeoIDPart.CountySubDivision]: undefined;
+    [GeoIDPart.Tract]: undefined;
+    [GeoIDPart.BlockGroup]: undefined;
+    [GeoIDPart.Block]: undefined;
+};
+/**
+ * A GeoID parsed to the state level. The least granular level.
+ *
+ * @internal
+ */
+export type ParsedGeoIDStateLevel = {
+    [GeoIDPart.State]: AdminLevel1Code;
+    [GeoIDPart.County]: undefined;
+    [GeoIDPart.CountySubDivision]: undefined;
+    [GeoIDPart.Tract]: undefined;
+    [GeoIDPart.BlockGroup]: undefined;
+    [GeoIDPart.Block]: undefined;
+};
+/**
+ * A GeoID parsed to a specific level.
+ *
+ * @internal
+ */
+export type ParsedGeoID = ParsedGeoIDBlockLevel | ParsedGeoIDBlockGroupLevel | ParsedGeoIDTractLevel | ParsedGeoIDCountySubDivisionLevel | ParsedGeoIDCountyLevel | ParsedGeoIDStateLevel;
+export declare class GeoIDParsingError extends Error {
+    constructor(message: string);
+}
+export declare class GeoIDInputMatcher<T extends GeoIDPart[] = GeoIDPart[]> {
+    pattern: RegExp;
+    components: T;
+    /**
+     * The specific length of a valid GeoID input.
+     */
+    length: number;
+    constructor(...geoIDComponents: T);
+    parse<R extends ParsedGeoIDPartial>(input: string): R | null;
+    test(input: string): boolean;
+}
+/**
+ * Record of GeoID input matchers, i.e. a pattern and parser for each grouping of GeoID components.
+ *
+ * @see {@linkcode GeoIDComponentMatchers} for the component-level matchers.
+ * @internal
+ */
+export declare const GeoIDInputMatchers: {
+    readonly block_code: GeoIDInputMatcher<[GeoIDPart.State, GeoIDPart.County, GeoIDPart.Tract, GeoIDPart.Block]>;
+    readonly block_group_code: GeoIDInputMatcher<[GeoIDPart.State, GeoIDPart.County, GeoIDPart.Tract, GeoIDPart.BlockGroup]>;
+    readonly tract_code: GeoIDInputMatcher<[GeoIDPart.State, GeoIDPart.County, GeoIDPart.Tract]>;
+    readonly place_code: GeoIDInputMatcher<[GeoIDPart.State, GeoIDPart.County, GeoIDPart.Place]>;
+    readonly county_sub_division_code: GeoIDInputMatcher<[GeoIDPart.State, GeoIDPart.County, GeoIDPart.CountySubDivision]>;
+    readonly county_code: GeoIDInputMatcher<[GeoIDPart.State, GeoIDPart.County]>;
+    readonly congressional_district_code: GeoIDInputMatcher<[GeoIDPart.State, GeoIDPart.CongressionalDistrict]>;
+    readonly state_code: GeoIDInputMatcher<[GeoIDPart.State]>;
+};
+/**
+ * Type-predicate for checking if a value appears to be a valid GeoID component.
+ */
+export declare function isGeoIDComponent<T extends GeoIDPart>(component: T, input: unknown): input is GeoIDPartMapping[T];
+/**
+ * Given a block GeoID, parse it into its components.
+ *
+ * @category Census
+ * @category FIPS
+ */
+export declare function parseFIPSBlockGeoID(input: FIPSBlockGeoID): ParsedGeoIDBlockLevel;
+/**
+ * Given a tract GeoID, parse it into its components.
+ *
+ * @category Census
+ * @category FIPS
+ */
+export declare function parseFIPSTractGeoID(input: FIPSTractGeoID): ParsedGeoIDTractLevel;
+/**
+ * Given a GeoID, parse it into its components.
+ *
+ * @category Census
+ * @category FIPS
+ */
+export declare function parseGeoID(input: FIPSBlockGeoID): ParsedGeoIDBlockLevel;
+export declare function parseGeoID(input: FIPSBlockGroupCode): ParsedGeoIDBlockGroupLevel;
+export declare function parseGeoID(input: FIPSTractCode): ParsedGeoIDTractLevel;
+export declare function parseGeoID(input: FIPSCountySubDivisionCode): ParsedGeoIDCountySubDivisionLevel;
+export declare function parseGeoID(input: FIPSCountyCode): ParsedGeoIDCountyLevel;
+export declare function parseGeoID(input: AdminLevel1Code): ParsedGeoIDStateLevel;
+export declare function parseGeoID(input: unknown): ParsedGeoID | null;
+/**
+ * Format a parsed block GeoID back into a string.
+ *
+ * @category Census
+ * @category FIPS
+ */
+export declare function formatGeoID(input: ParsedGeoIDBlockLevel): FIPSBlockGeoID;
+/**
+ * Format a parsed GeoID back into a string.
+ *
+ * @category Census
+ * @category FIPS
+ */
+export declare function formatGeoID(input: ParsedGeoIDPartial): string;
+//# sourceMappingURL=geoid.d.ts.map

package/out/geoid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"geoid.d.ts","sourceRoot":"","sources":["../geoid.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AACvC,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAI3D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;AAE3D;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;AAE7D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAA;AAErE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;AAE3D;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;AAE7D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,yBAAyB,GAAG,MAAM,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAA;AAEnF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;AAE7D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;AAE3D;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAAC,MAAM,EAAE,8BAA8B,CAAC,CAAA;AAM1F;;;;GAIG;AACH,oBAAY,SAAS;IACpB;;;;OAIG;IACH,KAAK,eAAe;IACpB;;;;OAIG;IACH,MAAM,gBAAgB;IACtB;;;;OAIG;IACH,iBAAiB,6BAA6B;IAC9C;;OAEG;IACH,qBAAqB,gCAAgC;IACrD;;OAEG;IACH,KAAK,eAAe;IACpB;;OAEG;IACH,KAAK,eAAe;IACpB;;OAEG;IACH,UAAU,qBAAqB;IAC/B;;OAEG;IACH,KAAK,eAAe;CACpB;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC9B,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,aAAa,CAAA;IAChC,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,cAAc,CAAA;IAClC,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,yBAAyB,CAAA;IACxD,CAAC,SAAS,CAAC,qBAAqB,CAAC,EAAE,6BAA6B,CAAA;IAChE,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,aAAa,CAAA;IAChC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,aAAa,CAAA;IAChC,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAA;IAC1C,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,aAAa,CAAA;CAChC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,eAAe;;;;;;;;;CASkB,CAAA;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACrC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,aAAa,CAAA;IAChC,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,cAAc,CAAA;IAClC,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,yBAAyB,CAAA;IACxD,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,aAAa,CAAA;IAChC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,aAAa,CAAA;IAChC,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAA;IAC1C,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,aAAa,CAAA;IAChC,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAA;IAC1C,CAAC,SAAS,CAAC,qBAAqB,CAAC,EAAE,6BAA6B,CAAA;CAChE;AAED;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACxC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,eAAe,CAAA;IAClC,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,cAAc,CAAA;IAClC,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,yBAAyB,CAAA;IACxD,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,aAAa,CAAA;IAChC,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAA;IAC1C,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAC5B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IACnC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,eAAe,CAAA;IAClC,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,cAAc,CAAA;IAClC,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,yBAAyB,CAAA;IACxD,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,aAAa,CAAA;IAChC,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,SAAS,CAAA;IACjC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAC5B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;KAAG,CAAC,IAAI,SAAS,CAAC,CAAC,EAAE,MAAM;CAAE,CAAA;AAE9D;;;;GAIG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC/C,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,eAAe,CAAA;IAClC,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,cAAc,CAAA;IAClC,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,yBAAyB,CAAA;IACxD,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,SAAS,CAAA;IAC5B,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,SAAS,CAAA;IACjC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAC5B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACpC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,eAAe,CAAA;IAClC,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,cAAc,CAAA;IAClC,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,SAAS,CAAA;IACxC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,SAAS,CAAA;IAC5B,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,SAAS,CAAA;IACjC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAC5B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IACnC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,eAAe,CAAA;IAClC,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,SAAS,CAAA;IAC7B,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,SAAS,CAAA;IACxC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,SAAS,CAAA;IAC5B,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,SAAS,CAAA;IACjC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAC5B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GACpB,qBAAqB,GACrB,0BAA0B,GAC1B,qBAAqB,GACrB,iCAAiC,GACjC,sBAAsB,GACtB,qBAAqB,CAAA;AAExB,qBAAa,iBAAkB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM;CAI3B;AAMD,qBAAa,iBAAiB,CAAC,CAAC,SAAS,SAAS,EAAE,GAAG,SAAS,EAAE;IAC1D,OAAO,EAAE,MAAM,CAAA;IAEf,UAAU,EAAE,CAAC,CAAA;IAEpB;;OAEG;IACI,MAAM,EAAE,MAAM,CAAA;gBAET,GAAG,eAAe,EAAE,CAAC;IAc1B,KAAK,CAAC,CAAC,SAAS,kBAAkB,EAAE,KAAK,EAAE,MAAM;IAcjD,IAAI,CAAC,KAAK,EAAE,MAAM;CAGzB;AAED;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;CA6C0B,CAAA;AAczD;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,SAAS,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,gBAAgB,CAAC,CAAC,CAAC,CAOhH;AAYD;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,cAAc,GAAG,qBAAqB,CAehF;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,cAAc,GAAG,qBAAqB,CAUhF;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,cAAc,GAAG,qBAAqB,CAAA;AACxE,wBAAgB,UAAU,CAAC,KAAK,EAAE,kBAAkB,GAAG,0BAA0B,CAAA;AACjF,wBAAgB,UAAU,CAAC,KAAK,EAAE,aAAa,GAAG,qBAAqB,CAAA;AACvE,wBAAgB,UAAU,CAAC,KAAK,EAAE,yBAAyB,GAAG,iCAAiC,CAAA;AAC/F,wBAAgB,UAAU,CAAC,KAAK,EAAE,cAAc,GAAG,sBAAsB,CAAA;AACzE,wBAAgB,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,qBAAqB,CAAA;AACzE,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,WAAW,GAAG,IAAI,CAAA;AAqC9D;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,qBAAqB,GAAG,cAAc,CAAA;AACzE;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,kBAAkB,GAAG,MAAM,CAAA"}

package/out/geoid.js

@@ -0,0 +1,255 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import { AdminLevel1Code, FIPSStateCode } from "./state.js";
+//#endregion
+//#region GeoID Parsing Setup
+/**
+ * A part of a GeoID to it's respective name.
+ *
+ * @internal
+ */
+export var GeoIDPart;
+(function (GeoIDPart) {
+    /**
+     * The state code part of a GeoID.
+     *
+     * Sometimes considered the administrative area level 1 code.
+     */
+    GeoIDPart["State"] = "state_code";
+    /**
+     * The county code part of a GeoID.
+     *
+     * Sometimes considered the administrative area level 2 code.
+     */
+    GeoIDPart["County"] = "county_code";
+    /**
+     * The county subdivision code part of a GeoID.
+     *
+     * Sometimes considered the administrative area level 3 code.
+     */
+    GeoIDPart["CountySubDivision"] = "county_sub_division_code";
+    /**
+     * The congressional district code part of a GeoID.
+     */
+    GeoIDPart["CongressionalDistrict"] = "congressional_district_code";
+    /**
+     * A place as defined by the Census, such as a city or town.
+     */
+    GeoIDPart["Place"] = "place_code";
+    /**
+     * The tract code part of a GeoID. The third most granular part.
+     */
+    GeoIDPart["Tract"] = "tract_code";
+    /**
+     * The block group code part of a GeoID. The second most granular part.
+     */
+    GeoIDPart["BlockGroup"] = "block_group_code";
+    /**
+     * The block code part of a GeoID. The most granular part.
+     */
+    GeoIDPart["Block"] = "block_code";
+})(GeoIDPart || (GeoIDPart = {}));
+/**
+ * Record of GeoID parts and their respective lengths.
+ *
+ * Note that the length of a GeoID is the sum of the lengths of its parts.
+ *
+ * @internal
+ */
+export const GeoIDPartLength = {
+    [GeoIDPart.State]: 2,
+    [GeoIDPart.County]: 3,
+    [GeoIDPart.CountySubDivision]: 5,
+    [GeoIDPart.CongressionalDistrict]: 2,
+    [GeoIDPart.Place]: 5,
+    [GeoIDPart.Tract]: 6,
+    [GeoIDPart.BlockGroup]: 1,
+    [GeoIDPart.Block]: 4,
+};
+export class GeoIDParsingError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "GeoIDParsingError";
+    }
+}
+//#endregion
+//#region GeoID Input Matchers
+export class GeoIDInputMatcher {
+    pattern;
+    components;
+    /**
+     * The specific length of a valid GeoID input.
+     */
+    length;
+    constructor(...geoIDComponents) {
+        this.components = geoIDComponents;
+        this.length = 0;
+        const matchedGroups = this.components.map((component) => {
+            const groupLength = GeoIDPartLength[component];
+            this.length += groupLength;
+            return `(\\d{${groupLength}})`;
+        });
+        this.pattern = new RegExp("^" + matchedGroups.join(""));
+    }
+    parse(input) {
+        const match = input.match(this.pattern);
+        if (!match)
+            return null;
+        const result = {};
+        for (let i = 0; i < this.components.length; i++) {
+            result[this.components[i]] = match[i + 1];
+        }
+        return result;
+    }
+    test(input) {
+        return this.pattern.test(input);
+    }
+}
+/**
+ * Record of GeoID input matchers, i.e. a pattern and parser for each grouping of GeoID components.
+ *
+ * @see {@linkcode GeoIDComponentMatchers} for the component-level matchers.
+ * @internal
+ */
+export const GeoIDInputMatchers = {
+    [GeoIDPart.Block]: new GeoIDInputMatcher(
+    // ---
+    GeoIDPart.State, GeoIDPart.County, GeoIDPart.Tract, GeoIDPart.Block),
+    [GeoIDPart.BlockGroup]: new GeoIDInputMatcher(
+    // ---
+    GeoIDPart.State, GeoIDPart.County, GeoIDPart.Tract, GeoIDPart.BlockGroup),
+    [GeoIDPart.Tract]: new GeoIDInputMatcher(
+    // ---
+    GeoIDPart.State, GeoIDPart.County, GeoIDPart.Tract),
+    [GeoIDPart.Place]: new GeoIDInputMatcher(
+    // ---
+    GeoIDPart.State, GeoIDPart.County, GeoIDPart.Place),
+    [GeoIDPart.CountySubDivision]: new GeoIDInputMatcher(
+    // ---
+    GeoIDPart.State, GeoIDPart.County, GeoIDPart.CountySubDivision),
+    [GeoIDPart.County]: new GeoIDInputMatcher(
+    // ---
+    GeoIDPart.State, GeoIDPart.County),
+    [GeoIDPart.CongressionalDistrict]: new GeoIDInputMatcher(
+    // ---
+    GeoIDPart.State, GeoIDPart.CongressionalDistrict),
+    [GeoIDPart.State]: new GeoIDInputMatcher(GeoIDPart.State),
+};
+/**
+ * A record of GeoID component matchers, i.e. a pattern and parser for each GeoID component.
+ *
+ * @see {@linkcode GeoIDInputMatchers} for the input-level matchers.
+ * @internal
+ */
+const GeoIDComponentMatchers = Object.fromEntries(Object.values(GeoIDPart).map((value) => {
+    return [value, new GeoIDInputMatcher(value)];
+}));
+/**
+ * Type-predicate for checking if a value appears to be a valid GeoID component.
+ */
+export function isGeoIDComponent(component, input) {
+    if (!input)
+        return false;
+    if (typeof input !== "string")
+        return false;
+    const matcher = GeoIDComponentMatchers[component];
+    return matcher.test(input);
+}
+//#endregion
+//#region GeoID Parsing
+/**
+ * GeoID input matchers sorted by length in descending order, such that the most specific matchers
+ * are first.
+ */
+const OrderedGeoIDInputMatchers = Object.values(GeoIDInputMatchers).sort((a, b) => b.length - a.length);
+/**
+ * Given a block GeoID, parse it into its components.
+ *
+ * @category Census
+ * @category FIPS
+ */
+export function parseFIPSBlockGeoID(input) {
+    const parsedBlock = GeoIDInputMatchers[GeoIDPart.Block].parse(input);
+    const { congressional_district_code } = GeoIDInputMatchers[GeoIDPart.CongressionalDistrict].parse(input);
+    const { county_sub_division_code } = GeoIDInputMatchers[GeoIDPart.CountySubDivision].parse(input);
+    const block_group_code = parsedBlock.block_code.slice(0, 1);
+    const parsed = {
+        ...parsedBlock,
+        congressional_district_code,
+        county_sub_division_code,
+        block_group_code,
+    };
+    return parsed;
+}
+/**
+ * Given a tract GeoID, parse it into its components.
+ *
+ * @category Census
+ * @category FIPS
+ */
+export function parseFIPSTractGeoID(input) {
+    const parsedTract = GeoIDInputMatchers[GeoIDPart.Tract].parse(input);
+    const { county_sub_division_code } = GeoIDInputMatchers[GeoIDPart.CountySubDivision].parse(input);
+    const parsed = {
+        ...parsedTract,
+        [GeoIDPart.CountySubDivision]: county_sub_division_code,
+    };
+    return parsed;
+}
+export function parseGeoID(input) {
+    if (!input)
+        return null;
+    if (typeof input === "number")
+        input = input.toString();
+    if (typeof input !== "string")
+        return null;
+    if (input.length === GeoIDInputMatchers[GeoIDPart.Block].length) {
+        return parseFIPSBlockGeoID(input);
+    }
+    if (input.length === GeoIDInputMatchers[GeoIDPart.Tract].length) {
+        return parseFIPSTractGeoID(input);
+    }
+    for (const matcher of OrderedGeoIDInputMatchers) {
+        // Do we even have a chance of matching?
+        if (matcher.length !== input.length)
+            continue;
+        const match = matcher.parse(input);
+        if (!match)
+            continue;
+        Object.assign(match, {
+            toJSON: () => match,
+        });
+        return match;
+    }
+    return null;
+}
+export function formatGeoID(input) {
+    if (!input || typeof input !== "object")
+        return null;
+    const { 
+    // ---
+    block_code, block_group_code, tract_code, state_code, county_sub_division_code, county_code, } = input;
+    if (block_code) {
+        return `${state_code}${county_code}${tract_code}${block_code}`;
+    }
+    if (block_group_code) {
+        return `${state_code}${county_code}${tract_code}${block_group_code}`;
+    }
+    if (tract_code) {
+        return `${state_code}${county_code}${tract_code}`;
+    }
+    if (county_sub_division_code) {
+        return `${state_code}${county_code}${county_sub_division_code}`;
+    }
+    if (county_code) {
+        return `${state_code}${county_code}`;
+    }
+    if (state_code)
+        return state_code;
+    return null;
+}
+//#endregion
+//# sourceMappingURL=geoid.js.map