@hebcal/geo-sqlite 5.4.1 → 5.5.1

package/dist/index.js

@@ -1,4 +1,4 @@
-/*! @hebcal/geo-sqlite v5.4.1 */
+/*! @hebcal/geo-sqlite v5.5.1 */
 import Database from 'better-sqlite3';
 import { Location, Locale } from '@hebcal/core';
 import '@hebcal/cities';
@@ -6,6 +6,336 @@ import events from 'events';
 import fs from 'fs';
 import readline from 'readline';
 
+class QuickLRU extends Map {
+	#size = 0;
+	#cache = new Map();
+	#oldCache = new Map();
+	#maxSize;
+	#maxAge;
+	#onEviction;
+
+	constructor(options = {}) {
+		super();
+
+		if (!(options.maxSize && options.maxSize > 0)) {
+			throw new TypeError('`maxSize` must be a number greater than 0');
+		}
+
+		if (typeof options.maxAge === 'number' && options.maxAge === 0) {
+			throw new TypeError('`maxAge` must be a number greater than 0');
+		}
+
+		this.#maxSize = options.maxSize;
+		this.#maxAge = options.maxAge || Number.POSITIVE_INFINITY;
+		this.#onEviction = options.onEviction;
+	}
+
+	// For tests.
+	get __oldCache() {
+		return this.#oldCache;
+	}
+
+	#emitEvictions(cache) {
+		if (typeof this.#onEviction !== 'function') {
+			return;
+		}
+
+		for (const [key, item] of cache) {
+			this.#onEviction(key, item.value);
+		}
+	}
+
+	#deleteIfExpired(key, item) {
+		if (typeof item.expiry === 'number' && item.expiry <= Date.now()) {
+			if (typeof this.#onEviction === 'function') {
+				this.#onEviction(key, item.value);
+			}
+
+			return this.delete(key);
+		}
+
+		return false;
+	}
+
+	#getOrDeleteIfExpired(key, item) {
+		const deleted = this.#deleteIfExpired(key, item);
+		if (deleted === false) {
+			return item.value;
+		}
+	}
+
+	#getItemValue(key, item) {
+		return item.expiry ? this.#getOrDeleteIfExpired(key, item) : item.value;
+	}
+
+	#peek(key, cache) {
+		const item = cache.get(key);
+		return this.#getItemValue(key, item);
+	}
+
+	#set(key, value) {
+		this.#cache.set(key, value);
+		this.#size++;
+
+		if (this.#size >= this.#maxSize) {
+			this.#size = 0;
+			this.#emitEvictions(this.#oldCache);
+			this.#oldCache = this.#cache;
+			this.#cache = new Map();
+		}
+	}
+
+	#moveToRecent(key, item) {
+		this.#oldCache.delete(key);
+		this.#set(key, item);
+	}
+
+	* #entriesAscending() {
+		for (const item of this.#oldCache) {
+			const [key, value] = item;
+			if (!this.#cache.has(key)) {
+				const deleted = this.#deleteIfExpired(key, value);
+				if (deleted === false) {
+					yield item;
+				}
+			}
+		}
+
+		for (const item of this.#cache) {
+			const [key, value] = item;
+			const deleted = this.#deleteIfExpired(key, value);
+			if (deleted === false) {
+				yield item;
+			}
+		}
+	}
+
+	get(key) {
+		if (this.#cache.has(key)) {
+			const item = this.#cache.get(key);
+			return this.#getItemValue(key, item);
+		}
+
+		if (this.#oldCache.has(key)) {
+			const item = this.#oldCache.get(key);
+			if (this.#deleteIfExpired(key, item) === false) {
+				this.#moveToRecent(key, item);
+				return item.value;
+			}
+		}
+	}
+
+	set(key, value, {maxAge = this.#maxAge} = {}) {
+		const expiry = typeof maxAge === 'number' && maxAge !== Number.POSITIVE_INFINITY
+			? (Date.now() + maxAge)
+			: undefined;
+
+		if (this.#cache.has(key)) {
+			this.#cache.set(key, {
+				value,
+				expiry,
+			});
+		} else {
+			this.#set(key, {value, expiry});
+		}
+
+		return this;
+	}
+
+	has(key) {
+		if (this.#cache.has(key)) {
+			return !this.#deleteIfExpired(key, this.#cache.get(key));
+		}
+
+		if (this.#oldCache.has(key)) {
+			return !this.#deleteIfExpired(key, this.#oldCache.get(key));
+		}
+
+		return false;
+	}
+
+	peek(key) {
+		if (this.#cache.has(key)) {
+			return this.#peek(key, this.#cache);
+		}
+
+		if (this.#oldCache.has(key)) {
+			return this.#peek(key, this.#oldCache);
+		}
+	}
+
+	expiresIn(key) {
+		const item = this.#cache.get(key) ?? this.#oldCache.get(key);
+		if (item) {
+			return item.expiry ? item.expiry - Date.now() : Number.POSITIVE_INFINITY;
+		}
+	}
+
+	delete(key) {
+		const deleted = this.#cache.delete(key);
+		if (deleted) {
+			this.#size--;
+		}
+
+		return this.#oldCache.delete(key) || deleted;
+	}
+
+	clear() {
+		this.#cache.clear();
+		this.#oldCache.clear();
+		this.#size = 0;
+	}
+
+	resize(newSize) {
+		if (!(newSize && newSize > 0)) {
+			throw new TypeError('`maxSize` must be a number greater than 0');
+		}
+
+		const items = [...this.#entriesAscending()];
+		const removeCount = items.length - newSize;
+		if (removeCount < 0) {
+			this.#cache = new Map(items);
+			this.#oldCache = new Map();
+			this.#size = items.length;
+		} else {
+			if (removeCount > 0) {
+				this.#emitEvictions(items.slice(0, removeCount));
+			}
+
+			this.#oldCache = new Map(items.slice(removeCount));
+			this.#cache = new Map();
+			this.#size = 0;
+		}
+
+		this.#maxSize = newSize;
+	}
+
+	evict(count = 1) {
+		const requested = Number(count);
+		if (!requested || requested <= 0) {
+			return;
+		}
+
+		const items = [...this.#entriesAscending()];
+		const evictCount = Math.trunc(Math.min(requested, Math.max(items.length - 1, 0)));
+		if (evictCount <= 0) {
+			return;
+		}
+
+		this.#emitEvictions(items.slice(0, evictCount));
+		this.#oldCache = new Map(items.slice(evictCount));
+		this.#cache = new Map();
+		this.#size = 0;
+	}
+
+	* keys() {
+		for (const [key] of this) {
+			yield key;
+		}
+	}
+
+	* values() {
+		for (const [, value] of this) {
+			yield value;
+		}
+	}
+
+	* [Symbol.iterator]() {
+		for (const item of this.#cache) {
+			const [key, value] = item;
+			const deleted = this.#deleteIfExpired(key, value);
+			if (deleted === false) {
+				yield [key, value.value];
+			}
+		}
+
+		for (const item of this.#oldCache) {
+			const [key, value] = item;
+			if (!this.#cache.has(key)) {
+				const deleted = this.#deleteIfExpired(key, value);
+				if (deleted === false) {
+					yield [key, value.value];
+				}
+			}
+		}
+	}
+
+	* entriesDescending() {
+		let items = [...this.#cache];
+		for (let i = items.length - 1; i >= 0; --i) {
+			const item = items[i];
+			const [key, value] = item;
+			const deleted = this.#deleteIfExpired(key, value);
+			if (deleted === false) {
+				yield [key, value.value];
+			}
+		}
+
+		items = [...this.#oldCache];
+		for (let i = items.length - 1; i >= 0; --i) {
+			const item = items[i];
+			const [key, value] = item;
+			if (!this.#cache.has(key)) {
+				const deleted = this.#deleteIfExpired(key, value);
+				if (deleted === false) {
+					yield [key, value.value];
+				}
+			}
+		}
+	}
+
+	* entriesAscending() {
+		for (const [key, value] of this.#entriesAscending()) {
+			yield [key, value.value];
+		}
+	}
+
+	get size() {
+		if (!this.#size) {
+			return this.#oldCache.size;
+		}
+
+		let oldCacheSize = 0;
+		for (const key of this.#oldCache.keys()) {
+			if (!this.#cache.has(key)) {
+				oldCacheSize++;
+			}
+		}
+
+		return Math.min(this.#size + oldCacheSize, this.#maxSize);
+	}
+
+	get maxSize() {
+		return this.#maxSize;
+	}
+
+	get maxAge() {
+		return this.#maxAge;
+	}
+
+	entries() {
+		return this.entriesAscending();
+	}
+
+	forEach(callbackFunction, thisArgument = this) {
+		for (const [key, value] of this.entriesAscending()) {
+			callbackFunction.call(thisArgument, value, key, this);
+		}
+	}
+
+	get [Symbol.toStringTag]() {
+		return 'QuickLRU';
+	}
+
+	toString() {
+		return `QuickLRU(${this.size}/${this.maxSize})`;
+	}
+
+	[Symbol.for('nodejs.util.inspect.custom')]() {
+		return this.toString();
+	}
+}
+
 var city2geonameid = {
 "AD-Andorra La Vella":3041563,
 "AE-Abu Dhabi":292968,
@@ -511,7 +841,7 @@ function munge(s) {
 }
 
 // DO NOT EDIT THIS AUTO-GENERATED FILE!
-const version = '5.4.1';
+const version = '5.5.1';
 
 const GEONAME_SQL = `SELECT
   g.name as name,
@@ -644,10 +974,10 @@ class GeoDb {
     this.geonamesDb = new Database(geonamesFilename, {fileMustExist: true});
     this.zipStmt = this.zipsDb.prepare(ZIPCODE_SQL);
     /** @type {Map<string, Location>} */
-    this.zipCache = new Map();
+    this.zipCache = new QuickLRU({maxSize: 150});
     this.geonamesStmt = this.geonamesDb.prepare(GEONAME_SQL);
     /** @type {Map<number, Location>} */
-    this.geonamesCache = new Map();
+    this.geonamesCache = new QuickLRU({maxSize: 750});
     /** @type {Map<string, number>} */
     this.legacyCities = new Map();
     for (const [name, id] of Object.entries(city2geonameid)) {
@@ -1015,6 +1345,7 @@ class GeoDb {
     const start = Date.now();
     const stmt = this.zipsDb.prepare(ZIPCODE_ALL_SQL);
     const rows = stmt.all();
+    this.zipCache = new Map(); // replace QuickLRU
     for (const row of rows) {
       const location = this.makeZipLocation(row);
       this.zipCache.set(row.ZipCode, location);
@@ -1028,6 +1359,7 @@ class GeoDb {
     const start = Date.now();
     const stmt = this.geonamesDb.prepare(GEONAME_ALL_SQL);
     const rows = stmt.all();
+    this.geonamesCache = new Map(); // replace QuickLRU
     for (const row of rows) {
       const location = this.makeGeonameLocation(row.geonameid, row);
       this.geonamesCache.set(row.geonameid, location);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/geo-sqlite",
-  "version": "5.4.1",
+  "version": "5.5.1",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "keywords": [
     "hebcal"
@@ -40,6 +40,7 @@
     "better-sqlite3": "^12.5.0",
     "pino": "^10.1.0",
     "pino-pretty": "^13.1.2",
+    "quick-lru": "^7.3.0",
     "transliteration": "^2.3.5"
   },
   "scripts": {

package/readme.txt

@@ -1,141 +0,0 @@
-
-Readme for GeoNames Gazetteer extract files
-
-============================================================================================================
-
-This work is licensed under a Creative Commons Attribution 4.0 License,
-see https://creativecommons.org/licenses/by/4.0/
-The Data is provided "as is" without warranty or any representation of accuracy, timeliness or completeness.
-
-The data format is tab-delimited text in utf8 encoding.
-
-
-Files :
--------
-XX.zip                   : features for country with iso code XX, see 'geoname' table for columns. 'no-country' for features not belonging to a country.
-allCountries.zip         : all countries combined in one file, see 'geoname' table for columns
-cities500.zip            : all cities with a population > 500 or seats of adm div down to PPLA4 (ca 185.000), see 'geoname' table for columns
-cities1000.zip           : all cities with a population > 1000 or seats of adm div down to PPLA3 (ca 130.000), see 'geoname' table for columns
-cities5000.zip           : all cities with a population > 5000 or PPLA (ca 50.000), see 'geoname' table for columns
-cities15000.zip          : all cities with a population > 15000 or capitals (ca 25.000), see 'geoname' table for columns
-alternateNamesV2.zip     : alternate names with language codes and geonameId, file with iso language codes, with new columns from and to
-alternateNames.zip       : obsolete use V2, this file does not have the new columns to and from and will be removed in the future
-admin1CodesASCII.txt     : names in English for admin divisions. Columns: code, name, name ascii, geonameid
-admin2Codes.txt          : names for administrative subdivision 'admin2 code' (UTF8), Format : concatenated codes <tab>name <tab> asciiname <tab> geonameId
-iso-languagecodes.txt    : iso 639 language codes, as used for alternate names in file alternateNames.zip
-featureCodes.txt         : name and description for feature classes and feature codes 
-timeZones.txt            : countryCode, timezoneId, gmt offset on 1st of January, dst offset to gmt on 1st of July (of the current year), rawOffset without DST
-countryInfo.txt          : country information : iso codes, fips codes, languages, capital ,...
-                           see the geonames webservices for additional country information,
-                                bounding box                         : http://api.geonames.org/countryInfo?
-                                country names in different languages : http:/api.geonames.org/countryInfoCSV?lang=it
-modifications-<date>.txt : all records modified on the previous day, the date is in yyyy-MM-dd format. You can use this file to daily synchronize your own geonames database.
-deletes-<date>.txt       : all records deleted on the previous day, format : geonameId <tab> name <tab> comment.
-
-alternateNamesModifications-<date>.txt : all alternate names modified on the previous day,
-alternateNamesDeletes-<date>.txt       : all alternate names deleted on the previous day, format : alternateNameId <tab> geonameId <tab> name <tab> comment.
-userTags.zip		: user tags , format : geonameId <tab> tag.
-hierarchy.zip		: parentId, childId, type. The type 'ADM' stands for the admin hierarchy modeled by the admin1-4 codes. The other entries are entered with the user interface. The relation toponym-adm hierarchy is not included in the file, it can instead be built from the admincodes of the toponym.
-adminCode5.zip		: the new adm5 column is not yet exported in the other files (in order to not break import scripts). Instead it is availabe as separate file.
-			  columns: geonameId,adm5code
-
-The main 'geoname' table has the following fields :
----------------------------------------------------
-geonameid         : integer id of record in geonames database
-name              : name of geographical point (utf8) varchar(200)
-asciiname         : name of geographical point in plain ascii characters, varchar(200)
-alternatenames    : alternatenames, comma separated, ascii names automatically transliterated, convenience attribute from alternatename table, varchar(10000)
-latitude          : latitude in decimal degrees (wgs84)
-longitude         : longitude in decimal degrees (wgs84)
-feature class     : see http://www.geonames.org/export/codes.html, char(1)
-feature code      : see http://www.geonames.org/export/codes.html, varchar(10)
-country code      : ISO-3166 2-letter country code, 2 characters
-cc2               : alternate country codes, comma separated, ISO-3166 2-letter country code, 200 characters
-admin1 code       : fipscode (subject to change to iso code), see exceptions below, see file admin1Codes.txt for display names of this code; varchar(20)
-admin2 code       : code for the second administrative division, a county in the US, see file admin2Codes.txt; varchar(80) 
-admin3 code       : code for third level administrative division, varchar(20)
-admin4 code       : code for fourth level administrative division, varchar(20)
-population        : bigint (8 byte int) 
-elevation         : in meters, integer
-dem               : digital elevation model, srtm3 or gtopo30, average elevation of 3''x3'' (ca 90mx90m) or 30''x30'' (ca 900mx900m) area in meters, integer. srtm processed by cgiar/ciat.
-timezone          : the iana timezone id (see file timeZone.txt) varchar(40)
-modification date : date of last modification in yyyy-MM-dd format
-
-
-AdminCodes:
-Most adm1 are FIPS codes. ISO codes are used for US, CH, BE and ME. UK and Greece are using an additional level between country and fips code. The code '00' stands for general features where no specific adm1 code is defined.
-The corresponding admin feature is found with the same countrycode and adminX codes and the respective feature code ADMx.
-
-
-
-The table 'alternate names' :
------------------------------
-alternateNameId   : the id of this alternate name, int
-geonameid         : geonameId referring to id in table 'geoname', int
-isolanguage       : iso 639 language code 2- or 3-characters, optionally followed by a hyphen and a countrycode for country specific variants (ex:zh-CN) or by a variant name (ex: zh-Hant); 4-characters 'post' for postal codes and 'iata','icao' and faac for airport codes, fr_1793 for French Revolution names,  abbr for abbreviation, link to a website (mostly to wikipedia), wkdt for the wikidataid, varchar(7)
-alternate name    : alternate name or name variant, varchar(400)
-isPreferredName   : '1', if this alternate name is an official/preferred name
-isShortName       : '1', if this is a short name like 'California' for 'State of California'
-isColloquial      : '1', if this alternate name is a colloquial or slang term. Example: 'Big Apple' for 'New York'.
-isHistoric        : '1', if this alternate name is historic and was used in the past. Example 'Bombay' for 'Mumbai'.
-from		  : from period when the name was used
-to		  : to period when the name was used
-
-Remark : the field 'alternatenames' in the table 'geoname' is a short version of the 'alternatenames' table without links and postal codes but with ascii transliterations. You probably don't need both. 
-If you don't need to know the language of a name variant, the field 'alternatenames' will be sufficient. If you need to know the language
-of a name variant, then you will need to load the table 'alternatenames' and you can drop the column in the geoname table.
-
-
-
-
-Boundaries:
-Simplified country boundaries are available in two slightly different formats:
-shapes_simplified_low:
-geonameId: 	The geonameId of the feature
-geoJson:	The boundary in geoJson format
-
-shapes_simplified_low.json:
-similar to the abovementioned file, but fully in geojson format. The geonameId is a feature property in the geojson string.
-
-
-Statistics on the number of features per country and the feature class and code distributions : http://www.geonames.org/statistics/ 
-
-
-Continent codes :
-AF : Africa			geonameId=6255146
-AS : Asia			geonameId=6255147
-EU : Europe			geonameId=6255148
-NA : North America		geonameId=6255149
-OC : Oceania			geonameId=6255151
-SA : South America		geonameId=6255150
-AN : Antarctica			geonameId=6255152
-
-
-feature classes:
-A: country, state, region,...
-H: stream, lake, ...
-L: parks,area, ...
-P: city, village,...
-R: road, railroad 
-S: spot, building, farm
-T: mountain,hill,rock,... 
-U: undersea
-V: forest,heath,...
-
-
-If you find errors or miss important places, please do use the wiki-style edit interface on our website 
-https://www.geonames.org to correct inaccuracies and to add new records. 
-Thanks in the name of the geonames community for your valuable contribution.
-
-Data Sources:
-https://www.geonames.org/datasources/
-
-
-More Information is also available in the geonames faq :
-
-https://forum.geonames.org/gforum/forums/show/6.page
-
-The forum : https://forum.geonames.org
-
-or the google group : https://groups.google.com/group/geonames
-