@hebcal/geo-sqlite 3.6.1 → 3.8.0

package/dist/index.js

@@ -1,4 +1,4 @@
-/*! @hebcal/geo-sqlite v3.6.0 */
+/*! @hebcal/geo-sqlite v3.8.0 */
 'use strict';
 
 Object.defineProperty(exports, '__esModule', { value: true });
@@ -52,18 +52,76 @@ const ZIPCODE_SQL = `SELECT CityMixedCase,State,Latitude,Longitude,TimeZone,DayL
 FROM ZIPCodes_Primary WHERE ZipCode = ?`;
 const ZIPCODE_ALL_SQL = `SELECT ZipCode,CityMixedCase,State,Latitude,Longitude,TimeZone,DayLightSaving
 FROM ZIPCodes_Primary`;
-const ZIP_COMPLETE_SQL = `SELECT ZipCode,CityMixedCase,State,Latitude,Longitude,TimeZone,DayLightSaving
+const ZIP_COMPLETE_SQL = `SELECT ZipCode,CityMixedCase,State,Latitude,Longitude,TimeZone,DayLightSaving,Population
 FROM ZIPCodes_Primary
 WHERE ZipCode LIKE ?
 ORDER BY Population DESC
 LIMIT 10`;
+const ZIP_FULLTEXT_COMPLETE_SQL = `SELECT ZipCode,CityMixedCase,State,Latitude,Longitude,TimeZone,DayLightSaving,Population
+FROM ZIPCodes_CityFullText
+WHERE CityMixedCase MATCH ?
+ORDER BY Population DESC
+LIMIT 15`;
 const GEONAME_COMPLETE_SQL = `SELECT geonameid, asciiname, admin1, country,
 population, latitude, longitude, timezone
 FROM geoname_fulltext
 WHERE longname MATCH ?
 GROUP BY geonameid
 ORDER BY population DESC
-LIMIT 10`;
+LIMIT 15`;
+const stateNames = {
+  'AK': 'Alaska',
+  'AL': 'Alabama',
+  'AR': 'Arkansas',
+  'AZ': 'Arizona',
+  'CA': 'California',
+  'CO': 'Colorado',
+  'CT': 'Connecticut',
+  'DC': 'Washington, D.C.',
+  'DE': 'Delaware',
+  'FL': 'Florida',
+  'GA': 'Georgia',
+  'HI': 'Hawaii',
+  'IA': 'Iowa',
+  'ID': 'Idaho',
+  'IL': 'Illinois',
+  'IN': 'Indiana',
+  'KS': 'Kansas',
+  'KY': 'Kentucky',
+  'LA': 'Louisiana',
+  'MA': 'Massachusetts',
+  'MD': 'Maryland',
+  'ME': 'Maine',
+  'MI': 'Michigan',
+  'MN': 'Minnesota',
+  'MO': 'Missouri',
+  'MS': 'Mississippi',
+  'MT': 'Montana',
+  'NC': 'North Carolina',
+  'ND': 'North Dakota',
+  'NE': 'Nebraska',
+  'NH': 'New Hampshire',
+  'NJ': 'New Jersey',
+  'NM': 'New Mexico',
+  'NV': 'Nevada',
+  'NY': 'New York',
+  'OH': 'Ohio',
+  'OK': 'Oklahoma',
+  'OR': 'Oregon',
+  'PA': 'Pennsylvania',
+  'RI': 'Rhode Island',
+  'SC': 'South Carolina',
+  'SD': 'South Dakota',
+  'TN': 'Tennessee',
+  'TX': 'Texas',
+  'UT': 'Utah',
+  'VA': 'Virginia',
+  'VT': 'Vermont',
+  'WA': 'Washington',
+  'WI': 'Wisconsin',
+  'WV': 'West Virginia',
+  'WY': 'Wyoming'
+};
 /** Wrapper around sqlite databases */
 
 class GeoDb {
@@ -83,14 +141,32 @@ class GeoDb {
       fileMustExist: true
     });
     this.zipStmt = this.zipsDb.prepare(ZIPCODE_SQL);
+    /** @type {Map<string, Location>} */
+
     this.zipCache = new Map();
     this.geonamesStmt = this.geonamesDb.prepare(GEONAME_SQL);
+    /** @type {Map<number, Location>} */
+
     this.geonamesCache = new Map();
+    /** @type {Map<string, Location>} */
+
     this.legacyCities = new Map();
 
     for (const [name, id] of Object.entries(city2geonameid)) {
       this.legacyCities.set(GeoDb.munge(name), id);
     }
+
+    const stmt = this.geonamesDb.prepare(`SELECT ISO, Country FROM country WHERE Country <> ''`);
+    const rows = stmt.all();
+    const map = new Map();
+
+    for (const row of rows) {
+      map.set(row.ISO, row.Country);
+    }
+    /** @type {Map<string, string>} */
+
+
+    this.countryNames = map;
   }
   /** Closes database handles */
 
@@ -116,19 +192,20 @@ class GeoDb {
 
 
   lookupZip(zip) {
-    const found = this.zipCache.get(zip);
+    const zip5 = zip.trim().substring(0, 5);
+    const found = this.zipCache.get(zip5);
     if (typeof found !== 'undefined') return found;
-    const result = this.zipStmt.get(zip);
+    const result = this.zipStmt.get(zip5);
 
     if (!result) {
-      if (this.logger) this.logger.warn(`GeoDb: unknown zipcode=${zip}`);
-      this.zipCache.set(zip, null);
+      if (this.logger) this.logger.warn(`GeoDb: unknown zipcode=${zip5}`);
+      this.zipCache.set(zip5, null);
       return null;
     }
 
-    result.ZipCode = String(zip);
+    result.ZipCode = String(zip5);
     const location = this.makeZipLocation(result);
-    this.zipCache.set(zip, location);
+    this.zipCache.set(zip5, location);
     return location;
   }
   /**
@@ -218,6 +295,28 @@ class GeoDb {
       return null;
     }
   }
+  /**
+   * @private
+   * @param {any[]} res
+   * @return {Object[]}
+   */
+
+
+  static zipResultToObj(res) {
+    const obj = {
+      id: String(res.ZipCode),
+      value: `${res.CityMixedCase}, ${res.State} ${res.ZipCode}`,
+      admin1: res.State,
+      asciiname: res.CityMixedCase,
+      country: 'United States',
+      latitude: res.Latitude,
+      longitude: res.Longitude,
+      timezone: core.Location.getUsaTzid(res.State, res.TimeZone, res.DayLightSaving),
+      population: res.Population,
+      geo: 'zip'
+    };
+    return obj;
+  }
   /**
    * Generates autocomplete results based on a query string
    * @param {string} qraw
@@ -226,43 +325,37 @@ class GeoDb {
 
 
   autoComplete(qraw) {
+    qraw = qraw.trim();
+
     if (qraw.length === 0) {
       return [];
     }
 
-    if (qraw.charCodeAt(0) >= 48 && qraw.charCodeAt(0) <= 57) {
+    const firstCharCode = qraw.charCodeAt(0);
+
+    if (firstCharCode >= 48 && firstCharCode <= 57) {
       if (!this.zipCompStmt) {
         this.zipCompStmt = this.zipsDb.prepare(ZIP_COMPLETE_SQL);
       }
 
-      return this.zipCompStmt.all(qraw + '%').map(res => {
-        const obj = {
-          id: String(res.ZipCode),
-          value: `${res.CityMixedCase}, ${res.State} ${res.ZipCode}`,
-          admin1: res.State,
-          asciiname: res.CityMixedCase,
-          country: 'United States',
-          latitude: res.Latitude,
-          longitude: res.Longitude,
-          timezone: core.Location.getUsaTzid(res.State, res.TimeZone, res.DayLightSaving),
-          population: res.Population,
-          geo: 'zip'
-        };
-        return obj;
-      });
+      const zip5 = qraw.substring(0, 5);
+      return this.zipCompStmt.all(zip5 + '%').map(GeoDb.zipResultToObj);
     } else {
       if (!this.geonamesCompStmt) {
         this.geonamesCompStmt = this.geonamesDb.prepare(GEONAME_COMPLETE_SQL);
       }
 
       qraw = qraw.replace(/\"/g, '""');
-      return this.geonamesCompStmt.all(`"${qraw}*"`).map(res => {
+      const geoRows = this.geonamesCompStmt.all(`"${qraw}*"`);
+      const geoMatches = geoRows.map(res => {
         const country = res.country || '';
         const admin1 = res.admin1 || '';
         const obj = {
           id: res.geonameid,
           value: core.Location.geonameCityDescr(res.asciiname, admin1, country),
           asciiname: res.asciiname,
+          admin1,
+          country,
           latitude: res.latitude,
           longitude: res.longitude,
           timezone: res.timezone,
@@ -281,6 +374,32 @@ class GeoDb {
         obj.tokens = Array.from(new Set(res.asciiname.split(' ').concat(admin1.split(' '), country.split(' '))));
         return obj;
       });
+
+      if (!this.zipFulltextCompStmt) {
+        this.zipFulltextCompStmt = this.zipsDb.prepare(ZIP_FULLTEXT_COMPLETE_SQL);
+      }
+
+      const zipRows = this.zipFulltextCompStmt.all(`"${qraw}*"`);
+      const zipMatches = zipRows.map(GeoDb.zipResultToObj);
+      const map = new Map();
+
+      for (const obj of zipMatches) {
+        const key = [obj.asciiname, stateNames[obj.admin1], obj.country].join('|');
+
+        if (!map.has(key)) {
+          map.set(key, obj);
+        }
+      } // GeoNames takes priority over USA ZIP code matches
+
+
+      for (const obj of geoMatches) {
+        const key = [obj.asciiname, obj.admin1, obj.country].join('|');
+        map.set(key, obj);
+      }
+
+      const values = Array.from(map.values());
+      values.sort((a, b) => b.population - a.population);
+      return values.slice(0, 10);
     }
   }
   /** Reads entire ZIP database and caches in-memory */

package/dist/index.mjs

@@ -1,4 +1,4 @@
-/*! @hebcal/geo-sqlite v3.6.0 */
+/*! @hebcal/geo-sqlite v3.8.0 */
 import Database from 'better-sqlite3';
 import { Location, Locale } from '@hebcal/core';
 import pino from 'pino';
@@ -40,18 +40,76 @@ const ZIPCODE_SQL = `SELECT CityMixedCase,State,Latitude,Longitude,TimeZone,DayL
 FROM ZIPCodes_Primary WHERE ZipCode = ?`;
 const ZIPCODE_ALL_SQL = `SELECT ZipCode,CityMixedCase,State,Latitude,Longitude,TimeZone,DayLightSaving
 FROM ZIPCodes_Primary`;
-const ZIP_COMPLETE_SQL = `SELECT ZipCode,CityMixedCase,State,Latitude,Longitude,TimeZone,DayLightSaving
+const ZIP_COMPLETE_SQL = `SELECT ZipCode,CityMixedCase,State,Latitude,Longitude,TimeZone,DayLightSaving,Population
 FROM ZIPCodes_Primary
 WHERE ZipCode LIKE ?
 ORDER BY Population DESC
 LIMIT 10`;
+const ZIP_FULLTEXT_COMPLETE_SQL = `SELECT ZipCode,CityMixedCase,State,Latitude,Longitude,TimeZone,DayLightSaving,Population
+FROM ZIPCodes_CityFullText
+WHERE CityMixedCase MATCH ?
+ORDER BY Population DESC
+LIMIT 15`;
 const GEONAME_COMPLETE_SQL = `SELECT geonameid, asciiname, admin1, country,
 population, latitude, longitude, timezone
 FROM geoname_fulltext
 WHERE longname MATCH ?
 GROUP BY geonameid
 ORDER BY population DESC
-LIMIT 10`;
+LIMIT 15`;
+const stateNames = {
+  'AK': 'Alaska',
+  'AL': 'Alabama',
+  'AR': 'Arkansas',
+  'AZ': 'Arizona',
+  'CA': 'California',
+  'CO': 'Colorado',
+  'CT': 'Connecticut',
+  'DC': 'Washington, D.C.',
+  'DE': 'Delaware',
+  'FL': 'Florida',
+  'GA': 'Georgia',
+  'HI': 'Hawaii',
+  'IA': 'Iowa',
+  'ID': 'Idaho',
+  'IL': 'Illinois',
+  'IN': 'Indiana',
+  'KS': 'Kansas',
+  'KY': 'Kentucky',
+  'LA': 'Louisiana',
+  'MA': 'Massachusetts',
+  'MD': 'Maryland',
+  'ME': 'Maine',
+  'MI': 'Michigan',
+  'MN': 'Minnesota',
+  'MO': 'Missouri',
+  'MS': 'Mississippi',
+  'MT': 'Montana',
+  'NC': 'North Carolina',
+  'ND': 'North Dakota',
+  'NE': 'Nebraska',
+  'NH': 'New Hampshire',
+  'NJ': 'New Jersey',
+  'NM': 'New Mexico',
+  'NV': 'Nevada',
+  'NY': 'New York',
+  'OH': 'Ohio',
+  'OK': 'Oklahoma',
+  'OR': 'Oregon',
+  'PA': 'Pennsylvania',
+  'RI': 'Rhode Island',
+  'SC': 'South Carolina',
+  'SD': 'South Dakota',
+  'TN': 'Tennessee',
+  'TX': 'Texas',
+  'UT': 'Utah',
+  'VA': 'Virginia',
+  'VT': 'Vermont',
+  'WA': 'Washington',
+  'WI': 'Wisconsin',
+  'WV': 'West Virginia',
+  'WY': 'Wyoming'
+};
 /** Wrapper around sqlite databases */
 
 class GeoDb {
@@ -71,14 +129,32 @@ class GeoDb {
       fileMustExist: true
     });
     this.zipStmt = this.zipsDb.prepare(ZIPCODE_SQL);
+    /** @type {Map<string, Location>} */
+
     this.zipCache = new Map();
     this.geonamesStmt = this.geonamesDb.prepare(GEONAME_SQL);
+    /** @type {Map<number, Location>} */
+
     this.geonamesCache = new Map();
+    /** @type {Map<string, Location>} */
+
     this.legacyCities = new Map();
 
     for (const [name, id] of Object.entries(city2geonameid)) {
       this.legacyCities.set(GeoDb.munge(name), id);
     }
+
+    const stmt = this.geonamesDb.prepare(`SELECT ISO, Country FROM country WHERE Country <> ''`);
+    const rows = stmt.all();
+    const map = new Map();
+
+    for (const row of rows) {
+      map.set(row.ISO, row.Country);
+    }
+    /** @type {Map<string, string>} */
+
+
+    this.countryNames = map;
   }
   /** Closes database handles */
 
@@ -104,19 +180,20 @@ class GeoDb {
 
 
   lookupZip(zip) {
-    const found = this.zipCache.get(zip);
+    const zip5 = zip.trim().substring(0, 5);
+    const found = this.zipCache.get(zip5);
     if (typeof found !== 'undefined') return found;
-    const result = this.zipStmt.get(zip);
+    const result = this.zipStmt.get(zip5);
 
     if (!result) {
-      if (this.logger) this.logger.warn(`GeoDb: unknown zipcode=${zip}`);
-      this.zipCache.set(zip, null);
+      if (this.logger) this.logger.warn(`GeoDb: unknown zipcode=${zip5}`);
+      this.zipCache.set(zip5, null);
       return null;
     }
 
-    result.ZipCode = String(zip);
+    result.ZipCode = String(zip5);
     const location = this.makeZipLocation(result);
-    this.zipCache.set(zip, location);
+    this.zipCache.set(zip5, location);
     return location;
   }
   /**
@@ -206,6 +283,28 @@ class GeoDb {
       return null;
     }
   }
+  /**
+   * @private
+   * @param {any[]} res
+   * @return {Object[]}
+   */
+
+
+  static zipResultToObj(res) {
+    const obj = {
+      id: String(res.ZipCode),
+      value: `${res.CityMixedCase}, ${res.State} ${res.ZipCode}`,
+      admin1: res.State,
+      asciiname: res.CityMixedCase,
+      country: 'United States',
+      latitude: res.Latitude,
+      longitude: res.Longitude,
+      timezone: Location.getUsaTzid(res.State, res.TimeZone, res.DayLightSaving),
+      population: res.Population,
+      geo: 'zip'
+    };
+    return obj;
+  }
   /**
    * Generates autocomplete results based on a query string
    * @param {string} qraw
@@ -214,43 +313,37 @@ class GeoDb {
 
 
   autoComplete(qraw) {
+    qraw = qraw.trim();
+
     if (qraw.length === 0) {
       return [];
     }
 
-    if (qraw.charCodeAt(0) >= 48 && qraw.charCodeAt(0) <= 57) {
+    const firstCharCode = qraw.charCodeAt(0);
+
+    if (firstCharCode >= 48 && firstCharCode <= 57) {
       if (!this.zipCompStmt) {
         this.zipCompStmt = this.zipsDb.prepare(ZIP_COMPLETE_SQL);
       }
 
-      return this.zipCompStmt.all(qraw + '%').map(res => {
-        const obj = {
-          id: String(res.ZipCode),
-          value: `${res.CityMixedCase}, ${res.State} ${res.ZipCode}`,
-          admin1: res.State,
-          asciiname: res.CityMixedCase,
-          country: 'United States',
-          latitude: res.Latitude,
-          longitude: res.Longitude,
-          timezone: Location.getUsaTzid(res.State, res.TimeZone, res.DayLightSaving),
-          population: res.Population,
-          geo: 'zip'
-        };
-        return obj;
-      });
+      const zip5 = qraw.substring(0, 5);
+      return this.zipCompStmt.all(zip5 + '%').map(GeoDb.zipResultToObj);
     } else {
       if (!this.geonamesCompStmt) {
         this.geonamesCompStmt = this.geonamesDb.prepare(GEONAME_COMPLETE_SQL);
       }
 
       qraw = qraw.replace(/\"/g, '""');
-      return this.geonamesCompStmt.all(`"${qraw}*"`).map(res => {
+      const geoRows = this.geonamesCompStmt.all(`"${qraw}*"`);
+      const geoMatches = geoRows.map(res => {
         const country = res.country || '';
         const admin1 = res.admin1 || '';
         const obj = {
           id: res.geonameid,
           value: Location.geonameCityDescr(res.asciiname, admin1, country),
           asciiname: res.asciiname,
+          admin1,
+          country,
           latitude: res.latitude,
           longitude: res.longitude,
           timezone: res.timezone,
@@ -269,6 +362,32 @@ class GeoDb {
         obj.tokens = Array.from(new Set(res.asciiname.split(' ').concat(admin1.split(' '), country.split(' '))));
         return obj;
       });
+
+      if (!this.zipFulltextCompStmt) {
+        this.zipFulltextCompStmt = this.zipsDb.prepare(ZIP_FULLTEXT_COMPLETE_SQL);
+      }
+
+      const zipRows = this.zipFulltextCompStmt.all(`"${qraw}*"`);
+      const zipMatches = zipRows.map(GeoDb.zipResultToObj);
+      const map = new Map();
+
+      for (const obj of zipMatches) {
+        const key = [obj.asciiname, stateNames[obj.admin1], obj.country].join('|');
+
+        if (!map.has(key)) {
+          map.set(key, obj);
+        }
+      } // GeoNames takes priority over USA ZIP code matches
+
+
+      for (const obj of geoMatches) {
+        const key = [obj.asciiname, obj.admin1, obj.country].join('|');
+        map.set(key, obj);
+      }
+
+      const values = Array.from(map.values());
+      values.sort((a, b) => b.population - a.population);
+      return values.slice(0, 10);
     }
   }
   /** Reads entire ZIP database and caches in-memory */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/geo-sqlite",
-  "version": "3.6.1",
+  "version": "3.8.0",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "keywords": [
     "hebcal"
@@ -28,10 +28,10 @@
     "geo-sqlite.d.ts"
   ],
   "dependencies": {
-    "@hebcal/core": "^3.32.0",
-    "better-sqlite3": "^7.4.6",
-    "pino": "^7.6.2",
-    "pino-pretty": "^7.3.0"
+    "@hebcal/core": "^3.33.2",
+    "better-sqlite3": "^7.5.0",
+    "pino": "^7.6.4",
+    "pino-pretty": "^7.5.0"
   },
   "scripts": {
     "build": "rollup -c",
@@ -60,19 +60,19 @@
   "license": "BSD-2-Clause",
   "devDependencies": {
     "@ava/babel": "^2.0.0",
-    "@babel/core": "^7.16.7",
+    "@babel/core": "^7.16.12",
     "@babel/polyfill": "^7.12.1",
-    "@babel/preset-env": "^7.16.7",
-    "@babel/register": "^7.16.7",
+    "@babel/preset-env": "^7.16.11",
+    "@babel/register": "^7.16.9",
     "@rollup/plugin-babel": "^5.3.0",
     "@rollup/plugin-commonjs": "^21.0.1",
     "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-node-resolve": "^13.1.3",
     "ava": "^3.15.0",
-    "eslint": "^8.6.0",
+    "eslint": "^8.7.0",
     "eslint-config-google": "^0.14.0",
-    "jsdoc": "^3.6.7",
+    "jsdoc": "^3.6.9",
     "jsdoc-to-markdown": "^7.1.0",
-    "rollup": "^2.63.0"
+    "rollup": "^2.66.0"
   }
 }

package/zips-dummy.sql

@@ -8,3 +8,6 @@ CREATE TABLE ZIPCodes_Primary (
   DayLightSaving char(1) NULL,
   Population int NULL
 );
+
+CREATE VIRTUAL TABLE ZIPCodes_CityFullText
+USING fts3(ZipCode,CityMixedCase,State,Latitude,Longitude,TimeZone,DayLightSaving,Population);