bd-geo-address 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,77 @@
+# Changelog
+
+All notable changes to `bd-geo-address` are documented here.
+This project follows [Semantic Versioning](https://semver.org/).
+
+---
+
+## [0.1.0] — 2024-06-22
+
+### Added
+
+#### Name-Based API
+- `allDivision()` / `allDivisionBn()` — all 8 division names (English & Bangla)
+- `divisionalDataOf()` / `divisionalDataOfBn()` — districts + upazilas of a division
+- `isValidDivision()` / `isValidDivisionBn()` — division name validation
+- `allDistricts()` / `allDistrictsBn()` — all 64 district names
+- `districtsOf()` / `districtsOfBn()` — districts of a division
+- `isValidDistrict()` / `isValidDistrictBn()` — district name validation
+- `getDivisionOfDistrict()` / `getDivisionOfDistrictBn()` — parent division lookup
+- `allUpazila()` / `allUpazilaNames()` / `allUpazilaNamesBn()` — all 595 upazilas
+- `upazilasOf()` / `upazilasOfBn()` — upazilas of a district
+- `upazilaNamesOf()` / `upazilaNamesOfBn()` — upazila name strings
+- `upazilasOfDivision()` / `upazilasOfDivisionBn()` — upazilas of a division
+- `upazilaNamesOfDivision()` / `upazilaNamesOfDivisionBn()` — names only
+- `isUpazila()` / `isUpazilabn()` — correctly excludes metropolitan thanas
+- `getUpazila()` / `getUpazilabn()` — upazila object lookup with disambiguation
+- `getDistrictOfUpazila()` / `getDistrictOfUpazilabn()` — parent district
+- `upazilaData` — raw Upazila[] constant
+- `allThana()` / `allThanaNames()` — 26 metropolitan thanas
+- `thanasOf()` / `thanasOfBn()` — thanas of a city district
+- `thanaNamesOf()` / `thanaNamesOfBn()` — thana name strings
+- `isThana()` / `isThanabn()` — thana name check with optional district disambiguation
+- `getThana()` / `getThanabn()` — thana object lookup
+- `thanaData` — raw Thana[] constant
+- `searchLocations()` — cross-level partial English/Bangla search
+
+#### FHIR Code-Based API
+- `resolveCode()` — FHIR geocode → full BDAddress hierarchy
+- `resolveCodes()` — bulk resolution
+- `toAddressString()` — full formatted address string (en/bn)
+- `toShortAddress()` — short address (lowest level + district)
+- `toCustomAddress()` — custom level selection
+- `getByCode()` — BDLocation by FHIR code
+- `findByName()` / `findByNameBn()` — lookup by English/Bangla name
+- `search()` — English-first then Bangla fallback search
+- `getAllByLevel()` — all locations at a given level
+- `getParent()` — immediate parent in hierarchy
+- `getChildren()` — direct children in hierarchy
+- `getAllDescendants()` — all descendants with optional level filter
+- `getHierarchy()` — hierarchy without formatted strings
+- `isValidCode()` — code existence check
+- `isValidName()` / `isValidNameBn()` — name existence check
+- `isChildOf()` — ancestry check
+- `getLevel()` — administrative level of a code
+- `getByPostalCode()` — postal entry lookup
+- `getPostalCode()` / `getPostalCodeBn()` — postal code by post office name
+- `getPostalCodesByArea()` / `getPostalCodesByAreaBn()` — postal codes by area
+- `getFhirCodeFromPostal()` — linked FHIR code from postal code
+- `resolvePostalCode()` — postal code → full BDAddress
+- `getCoordinates()` — lat/lng of a location
+- `getNearestLocation()` — nearest location to a point (Haversine)
+- `getLocationsWithinRadius()` — locations within a radius
+
+#### Data & Exports
+- `DivisionName` enum for autocomplete-friendly division names
+- `DistrictName` string literal union (all 64 districts)
+- `BDLocation`, `BDAddress`, `BDPostalEntry`, `Upazila`, `Thana`, `SearchResult` interfaces
+- `LocationLevel` type
+- Bundled dataset: 8 divisions, 64 districts, 595 upazilas, 26 metropolitan thanas, 848 unions, 1343 postal codes
+- Database dumps: MySQL, PostgreSQL, SQLite, MongoDB
+
+#### Build
+- CJS + ESM dual output via `tsup`
+- TypeScript declaration files (`.d.ts` + `.d.ts.map`)
+- `npm run build:data` — rebuild `bd-geodata.json` from raw sources
+- `npm run build:db` — regenerate all 4 database dump files
+- `npm run build:coords` — extract centroids from HDX shapefiles

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 bd-geo-address contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.