@hebcal/geo-sqlite 5.10.5 → 5.11.0

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,YAAY,CAAC;AAEjC,OAAO,EAAC,mBAAmB,EAAC,MAAM,4BAA4B,CAAC;AAE/D,OAAO,EAAC,cAAc,EAAC,MAAM,uBAAuB,CAAC"}

package/dist/make-zips-sqlite.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Builds `zips.sqlite3` from the bundled zips-dummy.sql schema file
+ * @param dbFilename path to the output SQLite database file
+ * @param sqlFile path to the SQL schema file
+ */
+export declare function makeZipsSqlite(dbFilename: string, sqlFile: string): void;

package/dist/make-zips-sqlite.js

@@ -0,0 +1,15 @@
+import { DatabaseSync } from 'node:sqlite';
+import fs from 'node:fs';
+/**
+ * Builds `zips.sqlite3` from the bundled zips-dummy.sql schema file
+ * @param dbFilename path to the output SQLite database file
+ * @param sqlFile path to the SQL schema file
+ */
+export function makeZipsSqlite(dbFilename, sqlFile) {
+    const sql = fs.readFileSync(sqlFile, 'utf8');
+    const db = new DatabaseSync(dbFilename);
+    console.log(sql);
+    db.exec(sql);
+    db.close();
+}
+//# sourceMappingURL=make-zips-sqlite.js.map

package/dist/make-zips-sqlite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"make-zips-sqlite.js","sourceRoot":"","sources":["../src/make-zips-sqlite.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,MAAM,SAAS,CAAC;AAEzB;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,UAAkB,EAAE,OAAe;IAChE,MAAM,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC7C,MAAM,EAAE,GAAG,IAAI,YAAY,CAAC,UAAU,CAAC,CAAC;IACxC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACjB,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,EAAE,CAAC,KAAK,EAAE,CAAC;AACb,CAAC"}

package/dist/munge.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Normalizes a city name for legacy lookups: lowercases and strips
+ * apostrophes, spaces, and plus signs.
+ * @private
+ */
+export declare function munge(s: string): string;

package/dist/munge.js

@@ -0,0 +1,13 @@
+/**
+ * Normalizes a city name for legacy lookups: lowercases and strips
+ * apostrophes, spaces, and plus signs.
+ * @private
+ */
+export function munge(s) {
+    return s
+        .toLowerCase()
+        .replaceAll("'", '')
+        .replaceAll(' ', '')
+        .replaceAll('+', '');
+}
+//# sourceMappingURL=munge.js.map

package/dist/munge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"munge.js","sourceRoot":"","sources":["../src/munge.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,UAAU,KAAK,CAAC,CAAS;IAC7B,OAAO,CAAC;SACL,WAAW,EAAE;SACb,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC;SACnB,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC;SACnB,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;AACzB,CAAC"}

package/dist/pkgVersion.d.ts

@@ -0,0 +1 @@
+export declare const version = "5.11.0";

package/dist/pkgVersion.js

@@ -0,0 +1,3 @@
+// DO NOT EDIT THIS AUTO-GENERATED FILE!
+export const version = '5.11.0';
+//# sourceMappingURL=pkgVersion.js.map

package/dist/pkgVersion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pkgVersion.js","sourceRoot":"","sources":["../src/pkgVersion.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/geo-sqlite",
-  "version": "5.10.5",
+  "version": "5.11.0",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "keywords": [
     "hebcal"
@@ -10,7 +10,7 @@
   "type": "module",
   "exports": {
     "import": "./dist/index.js",
-    "types": "./geo-sqlite.d.ts"
+    "types": "./dist/index.d.ts"
   },
   "bin": {
     "build-geonames-sqlite": "bin/build-geonames-sqlite",
@@ -25,7 +25,8 @@
   "bugs": {
     "url": "https://github.com/hebcal/hebcal-geo-sqlite/issues"
   },
-  "typings": "geo-sqlite.d.ts",
+  "homepage": "https://hebcal.github.io/api/geo-sqlite/",
+  "typings": "./dist/index.d.ts",
   "engines": {
     "node": ">= 22.5.0"
   },
@@ -34,12 +35,11 @@
     "bin",
     "test/fixtures",
     "cities-patch.txt",
-    "zips-dummy.sql",
-    "geo-sqlite.d.ts"
+    "zips-dummy.sql"
   ],
   "dependencies": {
-    "@hebcal/cities": "^6.1.0",
-    "@hebcal/core": "^6.5.2",
+    "@hebcal/cities": "^6.2.0",
+    "@hebcal/core": "^6.6.0",
     "minimist": "^1.2.8",
     "pino": "^10.3.1",
     "pino-pretty": "^13.1.3",
@@ -47,31 +47,27 @@
     "transliteration": "^2.6.1"
   },
   "scripts": {
-    "build:rollup": "rollup -c",
-    "build:version": "node ./version.cjs package.json src/pkgVersion.js",
-    "build:json2js": "for f in src/*.json test/*.json; do echo 'export default' > $f.js && cat $f >> $f.js; done",
-    "build": "npm run build:version && npm run build:json2js && npm run build:rollup",
-    "prepublish": "npm run build",
-    "readme": "npx jsdoc2md dist/index.js",
-    "test": "ava"
-  },
-  "ava": {
-    "files": [
-      "test/**/*.spec.js"
-    ]
+    "build:version": "node ./version.cjs package.json src/pkgVersion.ts",
+    "build:json2js": "for f in src/*.json; do echo 'export default' > \"$f.ts\" && cat \"$f\" >> \"$f.ts\"; done",
+    "compile": "tsc",
+    "build": "npm run build:version && npm run build:json2js && npm run compile",
+    "clean": "gts clean",
+    "prepublishOnly": "npm run build",
+    "prepare": "npm run build",
+    "docs": "typedoc",
+    "lint": "gts lint",
+    "fix": "gts fix",
+    "pretest": "npm run build",
+    "test": "node --test test/*.spec.js"
   },
   "license": "BSD-2-Clause",
+  "overrides": {
+    "tmp": "^0.2.6"
+  },
   "devDependencies": {
-    "@eslint/js": "^10.0.1",
-    "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^16.0.3",
-    "ava": "^8.0.1",
-    "eslint": "^10.4.1",
-    "eslint-config-google": "^0.14.0",
-    "eslint-plugin-n": "^18.0.1",
-    "globals": "^17.6.0",
-    "jsdoc": "^4.0.5",
-    "jsdoc-to-markdown": "^9.1.3",
-    "rollup": "^4.60.4"
+    "@types/node": "^26.0.0",
+    "gts": "^7.0.0",
+    "typedoc": "^0.28.19",
+    "typescript": "^6.0.3"
   }
 }

package/geo-sqlite.d.ts

@@ -1,161 +0,0 @@
-import {Location} from '@hebcal/core';
-
-export type AutoComplete = {
-    id: number | string;
-    value: string;
-    geo: 'geoname' | 'zip';
-    name?: string;
-    asciiname?: string;
-    admin1?: string;
-    country?: string;
-    cc?: string;
-    population?: number;
-    latitude?: number;
-    longitude?: number;
-    timezone?: string;
-    elevation?: number;
-};
-
-/**
- * Options for configuring the GeoDb constructor.
- */
-export type GeoDbOptions = {
-    /** Maximum number of entries in the ZIP code LRU cache. Default is 150. */
-    zipsCacheSize?: number;
-    /** Maximum number of entries in the geonames LRU cache. Default is 750. */
-    geonamesCacheSize?: number;
-};
-
-/**
- * Options for `buildGeonamesSqlite`.
- */
-export type BuildGeonamesSqliteOptions = {
-    /** Path to the output SQLite database file. */
-    dbFilename: string;
-    /** Path to countryInfo.txt from geonames.org. */
-    countryInfotxt: string;
-    /** Path to cities5000.txt (or similar) from geonames.org. */
-    cities5000txt: string;
-    /** Path to a TSV patch file with additional city rows. */
-    citiesPatch: string;
-    /** Path to admin1CodesASCII.txt from geonames.org. */
-    admin1CodesASCIItxt: string;
-    /** Path to IL.txt (Israel geonames) from geonames.org. */
-    ILtxt: string;
-    /** Path to IL alternate names file from geonames.org. */
-    ILalternate: string;
-    /** Logger instance (e.g. pino). */
-    logger: any;
-    /** Minimum population filter for PPL feature codes. */
-    population?: number;
-};
-
-/**
- * Wrapper around SQLite databases for looking up geographic locations
- * by ZIP code, geoname ID, or legacy Hebcal city name.
- */
-export class GeoDb {
-    /**
-     * Opens the ZIP code and geonames SQLite databases.
-     * @param logger - Logger instance (e.g. pino), or `null` to disable logging
-     * @param zipsFilename - Path to the ZIP codes SQLite database file
-     * @param geonamesFilename - Path to the geonames SQLite database file
-     * @param options - Optional cache size configuration
-     */
-    constructor(logger: any, zipsFilename: string, geonamesFilename: string, options?: GeoDbOptions);
-
-    /** Closes both database handles. */
-    close(): void;
-
-    /**
-     * Looks up a US ZIP code and returns the corresponding location.
-     * @param zip - 5-digit US ZIP code (leading zeros preserved as string)
-     * @returns The location, or `null` if not found
-     */
-    lookupZip(zip: string): Location;
-
-    /**
-     * Looks up a geonames.org ID and returns the corresponding location.
-     * @param geonameid - Numeric geoname ID from geonames.org
-     * @returns The location, or `null` if not found
-     */
-    lookupGeoname(geonameid: number): Location;
-
-    /**
-     * Looks up a legacy Hebcal city name (e.g. "Jerusalem" or "New York")
-     * and returns the corresponding location.
-     * @param cityName - Legacy city name string
-     * @returns The location, or `null` if not found
-     */
-    lookupLegacyCity(cityName: string): Location;
-
-    /**
-     * Generates autocomplete suggestions for a query string.
-     * Numeric queries search ZIP codes; alphabetic queries search geonames
-     * and ZIP city names via full-text search.
-     * @param qraw - Raw query string from user input
-     * @param latlong - If `true`, include latitude, longitude, timezone, and population in results
-     * @returns Array of autocomplete suggestion objects, sorted by population
-     */
-    autoComplete(qraw: string, latlong?: boolean): AutoComplete[];
-
-    /**
-     * Reads the entire ZIP code database into an in-memory cache,
-     * replacing the default LRU cache. Useful for high-throughput servers.
-     */
-    cacheZips(): void;
-
-    /**
-     * Reads the entire geonames database into an in-memory cache,
-     * replacing the default LRU cache. Useful for high-throughput servers.
-     */
-    cacheGeonames(): void;
-
-    /**
-     * Returns the version string of the `@hebcal/geo-sqlite` package.
-     */
-    static version(): string;
-
-    /**
-     * Tests whether the given string begins with exactly 5 ASCII digits
-     * (a valid US ZIP code format).
-     * @param str - String to test
-     * @returns `true` if the string starts with 5 digits
-     */
-    static is5DigitZip(str: string): boolean;
-
-    /**
-     * Convenience wrapper around the `transliterate` function from the
-     * `transliteration` npm package. Converts Unicode text to ASCII.
-     * @param source - String to transliterate
-     * @param options - Options passed to the underlying `transliterate` function
-     * @returns Transliterated ASCII string
-     */
-    static transliterate(source: string, options?: any): string;
-
-    /**
-     * Builds a display string for a city from its name components.
-     * Applies special formatting for US ("USA") and UK ("UK") country names,
-     * and omits the admin1 subdivision when it duplicates the city name.
-     * @param cityName - City name, e.g. "Tel Aviv" or "Chicago"
-     * @param admin1 - First-level administrative subdivision, e.g. "Illinois"
-     * @param countryName - Full country name, e.g. "United States" or "Israel"
-     * @returns Formatted city description, e.g. "Chicago, Illinois, USA"
-     */
-    static geonameCityDescr(cityName: string, admin1: string, countryName: string): string;
-}
-
-/**
- * Builds the `geonames.sqlite3` database from raw text files
- * downloaded from geonames.org.
- * @param opts - Paths to input files and configuration
- * @returns Resolves when the database has been built and closed
- */
-export function buildGeonamesSqlite(opts: BuildGeonamesSqliteOptions): Promise<boolean>;
-
-/**
- * Builds the `zips.sqlite3` database from a bundled SQL schema file.
- * @param dbFilename - Path to the output SQLite database file
- * @param sqlFile - Path to the SQL schema file to execute
- */
-export function makeZipsSqlite(dbFilename: string, sqlFile: string): void;