@mailwoman/bdc 8.3.0

package/out/sdk/common.d.ts

@@ -0,0 +1,279 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ * @file BDC file metadata model — dictionaries for the FCC's `bdc_file` listing rows, the
+ *   raw-to-parsed record shape, and file-ordering comparators.
+ */
+import type { Tagged } from "type-fest";
+import type { BroadbandTechnologyCode } from "./technologies.ts";
+/**
+ * Unique identifier for an FCC BDC broadband provider.
+ *
+ * Re-homed locally as `Tagged<number, ...>` — the Nexus original imported this from `@isp.nexus/fcc`
+ * (`BroadbandProvider.ts`), where it's defined identically.
+ *
+ * @category BDC
+ * @category FCC
+ */
+export type ProviderID = Tagged<number, "ProviderID">;
+/**
+ * The data type of the file, e.g. what kind of data is in the file.
+ *
+ * @category BDC
+ * @category FCC
+ */
+export declare const BDCFilingDataType: {
+    /**
+     * The file contains data about the availability of broadband with a specific provider.
+     */
+    readonly Availability: "availability";
+    /**
+     * The file contains data about the challenge process.
+     */
+    readonly Challenge: "challenge";
+};
+/**
+ * @category BDC
+ * @category FCC
+ */
+export type BDCFilingDataType = (typeof BDCFilingDataType)[keyof typeof BDCFilingDataType];
+/**
+ * @category BDC
+ * @category FCC
+ */
+export declare const BDCGISFileType: {
+    readonly ShapeFile: 1;
+    readonly GeoPackage: 2;
+};
+/**
+ * @category BDC
+ * @category FCC
+ */
+export type BDCGISFileType = (typeof BDCGISFileType)[keyof typeof BDCGISFileType];
+/**
+ * The type of file, e.g. what format the file is in.
+ *
+ * @category BDC
+ * @category FCC
+ */
+export declare const BDCFileFormat: {
+    readonly CSV: "csv";
+    readonly GIS: "gis";
+};
+/**
+ * @category BDC
+ * @category FCC
+ */
+export type BDCFileFormat = (typeof BDCFileFormat)[keyof typeof BDCFileFormat];
+/**
+ * @category BDC
+ * @category FCC
+ */
+export declare const BDCFileCategory: {
+    readonly Provider: "Provider";
+    readonly Summary: "Summary";
+    readonly State: "State";
+};
+/**
+ * @category BDC
+ * @category FCC
+ */
+export type BDCFileCategory = (typeof BDCFileCategory)[keyof typeof BDCFileCategory];
+/**
+ * @category BDC
+ * @category FCC
+ */
+export declare const BDCProviderSubCategory: {
+    readonly FixedBroadband: "Fixed Broadband";
+    readonly MobileBroadband: "Mobile Broadband";
+    readonly MobileVoice: "Mobile Voice";
+    readonly SupportingData: "Supporting Data";
+};
+/**
+ * @category BDC
+ * @category FCC
+ */
+export type BDCProviderSubCategory = (typeof BDCProviderSubCategory)[keyof typeof BDCProviderSubCategory];
+/**
+ * @category BDC
+ * @category FCC
+ */
+export declare const BDCSummarySubCategory: {
+    readonly BroadbandSummaryByGeography: "Broadband Summary by Geography Type";
+    readonly ProviderSummaryByGeography: "Provider Summary by Geography Type";
+    readonly ProviderSummaryFixedBroadband: "Provider Summary - Fixed Broadband";
+    readonly ProviderSummaryMobileBroadband: "Provider Summary - Mobile Broadband";
+};
+/**
+ * @category BDC
+ * @category FCC
+ */
+export type BDCSummarySubCategory = (typeof BDCSummarySubCategory)[keyof typeof BDCSummarySubCategory];
+/**
+ * @category BDC
+ * @category FCC
+ */
+export declare const BDCStateSubCategory: {
+    readonly FixedBroadband: "Fixed Broadband";
+    readonly MobileBroadband: "Mobile Broadband";
+    readonly MobileVoice: "Mobile Voice";
+};
+/**
+ * @category BDC
+ * @category FCC
+ */
+export type BDCStateSubCategory = (typeof BDCStateSubCategory)[keyof typeof BDCStateSubCategory];
+export type BDCSubCategory = BDCProviderSubCategory | BDCStateSubCategory | BDCSummarySubCategory;
+/**
+ * A single row from the FCC's BDC file listing, as returned by the API before parsing.
+ *
+ * @category BDC
+ * @category FCC
+ */
+export interface RawBDCFile {
+    file_id: number;
+    category: BDCFileCategory;
+    subcategory: BDCSubCategory;
+    /**
+     * Comma-separated list of technology codes.
+     *
+     * Nullable in live data: the FCC's `/map/downloads/listAvailabilityData` response carries `technology_code: null` for
+     * at least some State-category rows (first observed in the live FCC smoke test, see
+     * `.superpowers/sdd/2026-07-30-bdc-2b-plan/live-smoke-findings.md`). Guarded in {@linkcode parseRawBDCFile} — a null
+     * value parses to an empty `technologyCodes` set rather than throwing.
+     *
+     * @see {@link BroadbandTechnologyCode}
+     */
+    technology_code: string | null;
+    technology_code_desc: string;
+    /**
+     * 2-digit state or territory FIPS code.
+     *
+     * Loosely typed as `string` for now. The Nexus original was `AdminLevel1Code` (via `@isp.nexus/tiger`); this port
+     * drops that dependency, same as `data-collection.ts`'s `FCCStateID`. Task 2c tightens this against
+     * `@mailwoman/tiger` if a downstream dictionary needs the literal union.
+     *
+     * Nullable in live data for rows not scoped to a specific state (e.g. Provider-category rows). Guarded in
+     * {@linkcode parseRawBDCFile} — a null value parses to an empty `stateCode` string.
+     */
+    state_fips: string | null;
+    /**
+     * State or territory name.
+     *
+     * Loosely typed as `string` — the Nexus original was `StateName` (via `@isp.nexus/tiger`). Same task-2c deferral as
+     * `state_fips` above.
+     */
+    state_name: string;
+    /**
+     * Nullable in live data for rows not scoped to a specific provider (e.g. State/Summary-category rows). Guarded in
+     * {@linkcode parseRawBDCFile} — a null value parses to a `providerID` of `0`.
+     */
+    provider_id: string | null;
+    /**
+     * Nullable in live data — travels with `provider_id` (see above). Guarded in {@linkcode parseRawBDCFile} — a null
+     * value parses to an empty `providerName` string.
+     */
+    provider_name: string | null;
+    file_type: string;
+    file_name: string;
+    record_count: string;
+}
+/**
+ * A parsed FCC BDC file-listing entry.
+ *
+ * @category BDC
+ * @category FCC
+ */
+export interface BDCFile {
+    /**
+     * Unique identifier for the file, defined by the FCC.
+     */
+    fileID: number;
+    revision: Date;
+    vintage: Date;
+    /**
+     * The date the file was was downloaded, parsed, and stored in the database.
+     */
+    synchronizedAt?: Date;
+    /**
+     * The category of the file.
+     */
+    category: BDCFileCategory;
+    /**
+     * The subcategory of the file.
+     */
+    subcategory: BDCSubCategory;
+    /**
+     * The technology codes in the file. Empty when the raw `technology_code` was `null`.
+     */
+    technologyCodes: Set<BroadbandTechnologyCode>;
+    /**
+     * The state or territory FIPS code.
+     *
+     * Loosely typed as `string` — see {@linkcode RawBDCFile} for the task-2c deferral. Empty string when the raw
+     * `state_fips` was `null`.
+     */
+    stateCode: string;
+    /**
+     * The provider ID associated with the file. `0` when the raw `provider_id` was `null` (no specific provider — see
+     * {@linkcode RawBDCFile}).
+     */
+    providerID: ProviderID;
+    /**
+     * The provider name associated with the file. Empty string when the raw `provider_name` was `null`.
+     */
+    providerName: string;
+    /**
+     * The number of records in the file.
+     */
+    recordCount: number;
+    /**
+     * The type of file, e.g. what format the file is in.
+     */
+    fileType: string;
+    /**
+     * The name of the file, as provided by the FCC.
+     */
+    fileName: string;
+}
+declare const MonthAbbreviation: {
+    readonly jan: 0;
+    readonly feb: 1;
+    readonly mar: 2;
+    readonly apr: 3;
+    readonly may: 4;
+    readonly jun: 5;
+    readonly jul: 6;
+    readonly aug: 7;
+    readonly sep: 8;
+    readonly oct: 9;
+    readonly nov: 10;
+    readonly dec: 11;
+};
+export type MonthAbbreviation = keyof typeof MonthAbbreviation;
+/**
+ * Given a BDC file, parse the components of the file name.
+ */
+export declare function parseBDCFileTimestamps(fileName: string): {
+    revision: Date;
+    vintage: Date;
+};
+/**
+ * Parses a raw BDC file-listing entry into a {@linkcode BDCFile}.
+ */
+export declare function parseRawBDCFile(raw: RawBDCFile): BDCFile;
+/**
+ * Comparator for sorting {@linkcode BDCFile} records ascending by revision date.
+ */
+export declare function compareRevisionAsc(a: BDCFile, b: BDCFile): number;
+/**
+ * Comparator for sorting {@linkcode BDCFile} records ascending by provider ID.
+ */
+export declare function compareProviderIDAsc(a: BDCFile, b: BDCFile): number;
+/**
+ * Comparator for sorting {@linkcode BDCFile} records ascending by state FIPS code.
+ */
+export declare function compareStateCodeAsc(a: BDCFile, b: BDCFile): number;
+export {};
+//# sourceMappingURL=common.d.ts.map

package/out/sdk/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../sdk/common.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAEvC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAA;AAEhE;;;;;;;;GAQG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;AAErD;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB;IAC7B;;OAEG;;IAEH;;OAEG;;CAEM,CAAA;AAEV;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAA;AAE1F;;;GAGG;AACH,eAAO,MAAM,cAAc;;;CAGjB,CAAA;AAEV;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAA;AAEjF;;;;;GAKG;AACH,eAAO,MAAM,aAAa;;;CAGhB,CAAA;AAEV;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAA;AAE9E;;;GAGG;AACH,eAAO,MAAM,eAAe;;;;CAIlB,CAAA;AAEV;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAA;AAEpF;;;GAGG;AACH,eAAO,MAAM,sBAAsB;;;;;CAKzB,CAAA;AAEV;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,OAAO,sBAAsB,CAAC,CAAA;AAEzG;;;GAGG;AACH,eAAO,MAAM,qBAAqB;;;;;CAKxB,CAAA;AAEV;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAA;AAEtG;;;GAGG;AACH,eAAO,MAAM,mBAAmB;;;;CAItB,CAAA;AAEV;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAA;AAEhG,MAAM,MAAM,cAAc,GAAG,sBAAsB,GAAG,mBAAmB,GAAG,qBAAqB,CAAA;AAEjG;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,eAAe,CAAA;IACzB,WAAW,EAAE,cAAc,CAAA;IAC3B;;;;;;;;;OASG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,oBAAoB,EAAE,MAAM,CAAA;IAC5B;;;;;;;;;OASG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;;;;OAKG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B;;;OAGG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd,QAAQ,EAAE,IAAI,CAAA;IACd,OAAO,EAAE,IAAI,CAAA;IAEb;;OAEG;IACH,cAAc,CAAC,EAAE,IAAI,CAAA;IAErB;;OAEG;IACH,QAAQ,EAAE,eAAe,CAAA;IACzB;;OAEG;IACH,WAAW,EAAE,cAAc,CAAA;IAC3B;;OAEG;IACH,eAAe,EAAE,GAAG,CAAC,uBAAuB,CAAC,CAAA;IAC7C;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,UAAU,EAAE,UAAU,CAAA;IACtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;CAChB;AAID,QAAA,MAAM,iBAAiB;;;;;;;;;;;;;CAab,CAAA;AAEV,MAAM,MAAM,iBAAiB,GAAG,MAAM,OAAO,iBAAiB,CAAA;AAe9D;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM;;;EAkBtD;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAoBxD;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,MAAM,CAEjE;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,MAAM,CAEnE;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,MAAM,CAElE"}

package/out/sdk/common.js

@@ -0,0 +1,162 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ * @file BDC file metadata model — dictionaries for the FCC's `bdc_file` listing rows, the
+ *   raw-to-parsed record shape, and file-ordering comparators.
+ */
+/**
+ * The data type of the file, e.g. what kind of data is in the file.
+ *
+ * @category BDC
+ * @category FCC
+ */
+export const BDCFilingDataType = {
+    /**
+     * The file contains data about the availability of broadband with a specific provider.
+     */
+    Availability: "availability",
+    /**
+     * The file contains data about the challenge process.
+     */
+    Challenge: "challenge",
+};
+/**
+ * @category BDC
+ * @category FCC
+ */
+export const BDCGISFileType = {
+    ShapeFile: 1,
+    GeoPackage: 2,
+};
+/**
+ * The type of file, e.g. what format the file is in.
+ *
+ * @category BDC
+ * @category FCC
+ */
+export const BDCFileFormat = {
+    CSV: "csv",
+    GIS: "gis",
+};
+/**
+ * @category BDC
+ * @category FCC
+ */
+export const BDCFileCategory = {
+    Provider: "Provider",
+    Summary: "Summary",
+    State: "State",
+};
+/**
+ * @category BDC
+ * @category FCC
+ */
+export const BDCProviderSubCategory = {
+    FixedBroadband: "Fixed Broadband",
+    MobileBroadband: "Mobile Broadband",
+    MobileVoice: "Mobile Voice",
+    SupportingData: "Supporting Data",
+};
+/**
+ * @category BDC
+ * @category FCC
+ */
+export const BDCSummarySubCategory = {
+    BroadbandSummaryByGeography: "Broadband Summary by Geography Type",
+    ProviderSummaryByGeography: "Provider Summary by Geography Type",
+    ProviderSummaryFixedBroadband: "Provider Summary - Fixed Broadband",
+    ProviderSummaryMobileBroadband: "Provider Summary - Mobile Broadband",
+};
+/**
+ * @category BDC
+ * @category FCC
+ */
+export const BDCStateSubCategory = {
+    FixedBroadband: "Fixed Broadband",
+    MobileBroadband: "Mobile Broadband",
+    MobileVoice: "Mobile Voice",
+};
+const BDCFileNamePattern = /([A-Z])(\d+)_(\d{2})([a-z]{3})(\d{4})$/;
+const MonthAbbreviation = {
+    jan: 0,
+    feb: 1,
+    mar: 2,
+    apr: 3,
+    may: 4,
+    jun: 5,
+    jul: 6,
+    aug: 7,
+    sep: 8,
+    oct: 9,
+    nov: 10,
+    dec: 11,
+};
+const VintageMonthLetter = {
+    /**
+     * December
+     */
+    D: 11,
+    /**
+     * June
+     */
+    J: 5,
+};
+/**
+ * Given a BDC file, parse the components of the file name.
+ */
+export function parseBDCFileTimestamps(fileName) {
+    const match = fileName.match(BDCFileNamePattern);
+    if (!match)
+        throw new Error(`Invalid BDC file name: ${fileName}`);
+    const [, vintageMonthLetter, vintageYearAbbreviation, revisionDay, revisionMonthAbbreviation, revisionYear] = match;
+    const revisionMonth = MonthAbbreviation[revisionMonthAbbreviation];
+    const revision = new Date(Number.parseInt(revisionYear, 10), revisionMonth, Number.parseInt(revisionDay, 10));
+    const vintageMonth = VintageMonthLetter[vintageMonthLetter];
+    const vintageYear = Number.parseInt(`20${vintageYearAbbreviation}`, 10);
+    const vintage = new Date(vintageYear, vintageMonth);
+    return {
+        revision,
+        vintage,
+    };
+}
+/**
+ * Parses a raw BDC file-listing entry into a {@linkcode BDCFile}.
+ */
+export function parseRawBDCFile(raw) {
+    const parsedBDC = {
+        ...parseBDCFileTimestamps(raw.file_name),
+        fileName: raw.file_name,
+        fileType: raw.file_type,
+        fileID: raw.file_id,
+        recordCount: Number.parseInt(raw.record_count, 10),
+        category: raw.category,
+        subcategory: raw.subcategory,
+        technologyCodes: new Set(raw.technology_code === null
+            ? []
+            : raw.technology_code.split(",").map((code) => Number.parseInt(code, 10))),
+        stateCode: raw.state_fips ?? "",
+        providerID: (raw.provider_id === null ? 0 : Number.parseInt(raw.provider_id, 10)),
+        providerName: raw.provider_name ?? "",
+    };
+    return parsedBDC;
+}
+/**
+ * Comparator for sorting {@linkcode BDCFile} records ascending by revision date.
+ */
+export function compareRevisionAsc(a, b) {
+    return a.revision.getTime() - b.revision.getTime();
+}
+/**
+ * Comparator for sorting {@linkcode BDCFile} records ascending by provider ID.
+ */
+export function compareProviderIDAsc(a, b) {
+    return a.providerID - b.providerID;
+}
+/**
+ * Comparator for sorting {@linkcode BDCFile} records ascending by state FIPS code.
+ */
+export function compareStateCodeAsc(a, b) {
+    return Number.parseInt(a.stateCode, 10) - Number.parseInt(b.stateCode, 10);
+}
+//# sourceMappingURL=common.js.map

package/out/sdk/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../sdk/common.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAiBH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAChC;;OAEG;IACH,YAAY,EAAE,cAAc;IAC5B;;OAEG;IACH,SAAS,EAAE,WAAW;CACb,CAAA;AAQV;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC7B,SAAS,EAAE,CAAC;IACZ,UAAU,EAAE,CAAC;CACJ,CAAA;AAQV;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC5B,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,KAAK;CACD,CAAA;AAQV;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC9B,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;CACL,CAAA;AAQV;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACrC,cAAc,EAAE,iBAAiB;IACjC,eAAe,EAAE,kBAAkB;IACnC,WAAW,EAAE,cAAc;IAC3B,cAAc,EAAE,iBAAiB;CACxB,CAAA;AAQV;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACpC,2BAA2B,EAAE,qCAAqC;IAClE,0BAA0B,EAAE,oCAAoC;IAChE,6BAA6B,EAAE,oCAAoC;IACnE,8BAA8B,EAAE,qCAAqC;CAC5D,CAAA;AAQV;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IAClC,cAAc,EAAE,iBAAiB;IACjC,eAAe,EAAE,kBAAkB;IACnC,WAAW,EAAE,cAAc;CAClB,CAAA;AA+HV,MAAM,kBAAkB,GAAG,wCAAwC,CAAA;AAEnE,MAAM,iBAAiB,GAAG;IACzB,GAAG,EAAE,CAAC;IACN,GAAG,EAAE,CAAC;IACN,GAAG,EAAE,CAAC;IACN,GAAG,EAAE,CAAC;IACN,GAAG,EAAE,CAAC;IACN,GAAG,EAAE,CAAC;IACN,GAAG,EAAE,CAAC;IACN,GAAG,EAAE,CAAC;IACN,GAAG,EAAE,CAAC;IACN,GAAG,EAAE,CAAC;IACN,GAAG,EAAE,EAAE;IACP,GAAG,EAAE,EAAE;CACE,CAAA;AAIV,MAAM,kBAAkB,GAAG;IAC1B;;OAEG;IACH,CAAC,EAAE,EAAE;IACL;;OAEG;IACH,CAAC,EAAE,CAAC;CACJ,CAAA;AAID;;GAEG;AACH,MAAM,UAAU,sBAAsB,CAAC,QAAgB;IACtD,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAA;IAEhD,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,QAAQ,EAAE,CAAC,CAAA;IACjE,MAAM,CAAC,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,WAAW,EAAE,yBAAyB,EAAE,YAAY,CAAC,GAAG,KAAK,CAAA;IAEnH,MAAM,aAAa,GAAG,iBAAiB,CAAC,yBAA8C,CAAC,CAAA;IACvF,MAAM,QAAQ,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAa,EAAE,EAAE,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,QAAQ,CAAC,WAAY,EAAE,EAAE,CAAC,CAAC,CAAA;IAE/G,MAAM,YAAY,GAAG,kBAAkB,CAAC,kBAAwC,CAAC,CAAA;IACjF,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,uBAAuB,EAAE,EAAE,EAAE,CAAC,CAAA;IAEvE,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAA;IAEnD,OAAO;QACN,QAAQ;QACR,OAAO;KACP,CAAA;AACF,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,GAAe;IAC9C,MAAM,SAAS,GAAY;QAC1B,GAAG,sBAAsB,CAAC,GAAG,CAAC,SAAS,CAAC;QACxC,QAAQ,EAAE,GAAG,CAAC,SAAS;QACvB,QAAQ,EAAE,GAAG,CAAC,SAAS;QACvB,MAAM,EAAE,GAAG,CAAC,OAAO;QACnB,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,CAAC;QAClD,QAAQ,EAAE,GAAG,CAAC,QAAQ;QACtB,WAAW,EAAE,GAAG,CAAC,WAAW;QAC5B,eAAe,EAAE,IAAI,GAAG,CACvB,GAAG,CAAC,eAAe,KAAK,IAAI;YAC3B,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAA4B,CAAC,CACrG;QACD,SAAS,EAAE,GAAG,CAAC,UAAU,IAAI,EAAE;QAC/B,UAAU,EAAE,CAAC,GAAG,CAAC,WAAW,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,CAAC,CAAe;QAC/F,YAAY,EAAE,GAAG,CAAC,aAAa,IAAI,EAAE;KACrC,CAAA;IAED,OAAO,SAAS,CAAA;AACjB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,CAAU,EAAE,CAAU;IACxD,OAAO,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAA;AACnD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,CAAU,EAAE,CAAU;IAC1D,OAAO,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,CAAA;AACnC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,CAAU,EAAE,CAAU;IACzD,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAA;AAC3E,CAAC"}

package/out/sdk/data-collection.d.ts

@@ -0,0 +1,244 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ * @file FCC Broadband Data Collection System
+ */
+import type { BuildingTypeCode } from "./buildings.ts";
+import type { BroadbandServicableLocationID } from "./location.ts";
+/**
+ * Snake_case identifier for a US State or Territory.
+ *
+ * Loosely typed as `string` for now. The Nexus original derived this from `StateName` (via `@isp.nexus/tiger`); this
+ * port drops that dependency since 2a doesn't consume the literal union anywhere. Task 2c tightens this against
+ * `@mailwoman/tiger`'s `StateName` if a downstream dictionary needs it.
+ *
+ * @category FCC
+ * @title FCC State Identifier
+ */
+export type FCCStateID = string;
+/**
+ * Code indicating confidence in the association between the textual address and the location.
+ *
+ * @category NTIA
+ * @category FCC
+ */
+export declare const AddressConfidenceCode: {
+    readonly High: "1";
+    readonly Medium: "2";
+    readonly Low: "3";
+    readonly SuccessfulChallenge: "4";
+};
+/**
+ * @category NTIA
+ * @category FCC
+ */
+export type AddressConfidenceCode = (typeof AddressConfidenceCode)[keyof typeof AddressConfidenceCode];
+/**
+ * A modeled land use designation estimated from assembled county assessor information.
+ *
+ * @category NTIA
+ * @category FCC
+ */
+export declare const LandUseCode: {
+    readonly Residential: 1;
+    readonly Land: 2;
+    readonly Business: 3;
+    readonly Unknown: 4;
+    readonly Agriculture: 5;
+    readonly Community: 6;
+    readonly Industrial: 7;
+    readonly Recreation: 8;
+    readonly Utility: 9;
+    readonly MixedUse: 10;
+    readonly Transportation: 11;
+    readonly Water: 12;
+    readonly Communications: 13;
+    readonly Row: 14;
+    readonly Wireless: 15;
+    readonly Other: 0;
+};
+/**
+ * @category NTIA
+ * @category FCC
+ */
+export type LandUseCode = (typeof LandUseCode)[keyof typeof LandUseCode];
+/**
+ * Flag indicating if the location is a broadband serviceable location.
+ */
+export declare const BSLFlag: {
+    readonly Serviceable: 1;
+    readonly NotServiceable: 0;
+};
+export type BSLFlag = (typeof BSLFlag)[keyof typeof BSLFlag];
+/**
+ * Interface representing a record from the NTIA data dictionary.
+ *
+ * @category NTIA
+ * @title NTIA Record
+ */
+export interface NTIARecord {
+    /**
+     * Unique ID for the Fabric location. Remains persistent across versions, even if the location's position or building
+     * changes.
+     *
+     * @title Location ID
+     * @pattern ^\d{10}$
+     */
+    location_id: BroadbandServicableLocationID;
+    /**
+     * Primary postal address excluding city, state, and ZIP code.
+     *
+     * @example
+     * 	123 Main St
+     *
+     * @title Primary Address
+     */
+    address_primary: string;
+    /**
+     * City name from the postal address. Also known as the locality.
+     *
+     * @example
+     * 	San Francisco
+     *
+     * @title City
+     */
+    city: string;
+    /**
+     * 2-character state abbreviation from the postal address.
+     *
+     * Loosely typed as `string` — see {@linkcode FCCStateID} for why the tiger-backed literal union is deferred to task
+     * 2c.
+     *
+     * @example
+     * 	CA
+     *
+     * @title State Abbreviation
+     */
+    state: string;
+    /**
+     * 5-digit ZIP code associated with the address.
+     *
+     * @example
+     * 	94103
+     *
+     * @title ZIP Code
+     */
+    zip: string;
+    /**
+     * USPS ZIP+4 extension.
+     *
+     * @example
+     * 	e.g. 94103-1234
+     *
+     * @title ZIP+4
+     */
+    zip_suffix?: string;
+    /**
+     * Estimate of the number of units at the location. Includes both residential and non-residential units.
+     *
+     * @example
+     * 	10
+     *
+     * @title Unit Count
+     */
+    unit_count: number;
+    /**
+     * Flag indicating if the location is a broadband serviceable location. 1 for serviceable, 0 for not.
+     *
+     * @example
+     * 	1
+     *
+     * @title BSL Flag
+     */
+    bsl_flag: BSLFlag;
+    /**
+     * Code indicating the type of building at the location. Can be residential (R), non-residential (B), mixed (X), group
+     * quarters (G), CAI (C), enterprise (E), or other (O).
+     *
+     * @example
+     * 	R
+     *
+     * @title Building Type Code
+     */
+    building_type_code: BuildingTypeCode;
+    /**
+     * Modeled land use designation from county assessor information. Possible values range from 0 (Other) to 15
+     * (Wireless).
+     *
+     * @example
+     * 	1
+     *
+     * @title Land Use Code
+     */
+    land_use_code: LandUseCode | null;
+    /**
+     * Code indicating confidence in the association between the textual address and the location. 1 = High, 2 = Medium, 3
+     * = Low, 4 = successful address challenge.
+     *
+     * @example
+     * 	1
+     *
+     * @title Address Confidence Code
+     */
+    address_confidence_code: AddressConfidenceCode;
+    /**
+     * 5-digit TIGER 2020 identifier for the county based on the latitude and longitude.
+     *
+     * @example
+     * 	06075
+     *
+     * @title County GEOID
+     */
+    county_geoid: string;
+    /**
+     * 15-digit 2020 U.S. Census Bureau FIPS code for the census block, based on the latitude and longitude.
+     *
+     * @example
+     * 	060750001000123
+     *
+     * @title Block GEOID
+     */
+    block_geoid: string;
+    /**
+     * H3 hex cell ID, level 9, for geospatial referencing.
+     *
+     * @example
+     * 	8928308280fffff
+     *
+     * @title H3 Cell ID (9)
+     */
+    h3_9: string;
+    /**
+     * Latitude coordinate of the location in decimal degrees. Uses WGS84 format with 5-digit precision.
+     *
+     * @example
+     * 	37.774929
+     *
+     * @minimum -90
+     * @maximum 90
+     * @title Latitude
+     */
+    latitude: number;
+    /**
+     * Longitude coordinate of the location in decimal degrees. Uses WGS84 format with 5-digit precision.
+     *
+     * @example
+     * 	e.g. -122.419416
+     *
+     * @minimum -180
+     * @maximum 180
+     * @title Longitude
+     */
+    longitude: number;
+    /**
+     * FCC Fabric Release Date, present only for tier 2, 3, and 4 licensees.
+     *
+     * @example
+     * 	07212023
+     *
+     * @title FCC Fabric Release Date
+     */
+    fcc_rel?: string;
+}
+//# sourceMappingURL=data-collection.d.ts.map

package/out/sdk/data-collection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-collection.d.ts","sourceRoot":"","sources":["../../sdk/data-collection.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACtD,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,eAAe,CAAA;AAElE;;;;;;;;;GASG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAA;AAE/B;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB;;;;;CAKxB,CAAA;AAEV;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAA;AAEtG;;;;;GAKG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;CAiBd,CAAA;AAEV;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAA;AAExE;;GAEG;AACH,eAAO,MAAM,OAAO;;;CAGV,CAAA;AAEV,MAAM,MAAM,OAAO,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,OAAO,OAAO,CAAC,CAAA;AAE5D;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IAC1B;;;;;;OAMG;IACH,WAAW,EAAE,6BAA6B,CAAA;IAE1C;;;;;;;OAOG;IACH,eAAe,EAAE,MAAM,CAAA;IAEvB;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;;;;;;;;;OAUG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;;;;;;OAOG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;;;;;OAOG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;;;;;;OAOG;IACH,QAAQ,EAAE,OAAO,CAAA;IAEjB;;;;;;;;OAQG;IACH,kBAAkB,EAAE,gBAAgB,CAAA;IAEpC;;;;;;;;OAQG;IACH,aAAa,EAAE,WAAW,GAAG,IAAI,CAAA;IAEjC;;;;;;;;OAQG;IACH,uBAAuB,EAAE,qBAAqB,CAAA;IAE9C;;;;;;;OAOG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;;;;;;OAOG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;;;;;;;;OASG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;;;;;;OASG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CAChB"}