@mailwoman/resolver-wof-sqlite 9.4.0 → 10.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (548) hide show
  1. package/README.md +8 -8
  2. package/lib/address/{point-interpolation.ts → point/interpolation.ts} +40 -38
  3. package/lib/address/point/schema.ts +132 -0
  4. package/lib/address/point.ts +68 -81
  5. package/lib/{address/index.ts → address.ts} +2 -2
  6. package/lib/ancestry/backfill.ts +24 -88
  7. package/lib/{ancestry/index.ts → ancestry.ts} +19 -15
  8. package/lib/build/candidate.ts +608 -0
  9. package/lib/build/population-corrections.ts +64 -0
  10. package/lib/build/slim.ts +338 -0
  11. package/lib/candidate/alias-bags.ts +74 -14
  12. package/lib/candidate/ancestors/schema.ts +211 -0
  13. package/lib/candidate/{ancestors-sidecar.ts → ancestors/sidecar.ts} +17 -24
  14. package/lib/candidate/country-display-names.ts +6 -20
  15. package/lib/candidate/extract-fold.ts +12 -57
  16. package/lib/candidate/fts.ts +28 -0
  17. package/lib/candidate/importance.ts +221 -0
  18. package/lib/candidate/lookup.ts +669 -0
  19. package/lib/candidate/name-roles.ts +16 -34
  20. package/lib/candidate/own-name.ts +34 -31
  21. package/lib/candidate/place-attrs.ts +20 -13
  22. package/lib/candidate/schema.ts +211 -0
  23. package/lib/candidate/scoring.ts +222 -0
  24. package/lib/capital-schema.ts +21 -17
  25. package/lib/capitals.ts +26 -24
  26. package/lib/coincident-roles.ts +74 -55
  27. package/lib/convention/schema.ts +13 -7
  28. package/lib/convention.ts +144 -0
  29. package/lib/coverage-manifest-schema.ts +34 -39
  30. package/lib/currency-backfill.ts +24 -69
  31. package/lib/env.ts +1 -1
  32. package/lib/exact-match.ts +31 -20
  33. package/lib/extracts.ts +96 -73
  34. package/lib/fst/autocomplete.ts +52 -35
  35. package/lib/fst/builder.ts +30 -36
  36. package/lib/fst/deserialize-web.ts +8 -9
  37. package/lib/fst/format.ts +41 -23
  38. package/lib/fst/freshness.ts +17 -95
  39. package/lib/fst/matcher.ts +2 -2
  40. package/lib/fst/serialize.ts +45 -60
  41. package/lib/fst/types.ts +71 -59
  42. package/lib/fts/query.ts +5 -36
  43. package/lib/fts.ts +280 -0
  44. package/lib/geonames/aliases.ts +72 -149
  45. package/lib/geonames/postal.ts +162 -77
  46. package/lib/index.ts +20 -27
  47. package/lib/interpolation.ts +43 -96
  48. package/lib/lookup.ts +137 -257
  49. package/lib/name-score.ts +9 -7
  50. package/lib/nsul/lookup.ts +36 -53
  51. package/lib/nsul/schema.ts +16 -43
  52. package/lib/paths.ts +159 -0
  53. package/lib/place-importance-schema.ts +57 -164
  54. package/lib/poi/lookup.ts +100 -109
  55. package/lib/poi/schema.ts +42 -26
  56. package/lib/polygon-schema.ts +10 -6
  57. package/lib/postal/city/alias/lookup.ts +79 -0
  58. package/lib/postal/{city-alias-schema.ts → city/alias/schema.ts} +14 -10
  59. package/lib/postal/{city-candidate-schema.ts → city/candidate-schema.ts} +26 -20
  60. package/lib/postal.ts +9 -0
  61. package/lib/postcode-point-lookup.ts +9 -19
  62. package/lib/primary-preference.ts +45 -125
  63. package/lib/proximity-rerank.ts +43 -32
  64. package/lib/ranking-weights.ts +98 -76
  65. package/lib/region-keys.ts +68 -40
  66. package/lib/reverse.ts +108 -72
  67. package/lib/schema.ts +74 -42
  68. package/lib/search-fetch.ts +90 -68
  69. package/lib/sqlite/convention-source.ts +57 -0
  70. package/lib/sqlite/utils.ts +79 -0
  71. package/lib/street/centroid/schema.ts +149 -0
  72. package/lib/street/centroid.ts +16 -25
  73. package/lib/street/{morphology-fst-builder.ts → morphology/fst/builder.ts} +56 -41
  74. package/lib/street/{morphology-fst-loader.ts → morphology/fst/loader.ts} +36 -29
  75. package/lib/street/name-lookup.ts +43 -35
  76. package/lib/street/normalize.ts +85 -216
  77. package/lib/street/segment-schema.ts +116 -43
  78. package/lib/{street/index.ts → street.ts} +3 -3
  79. package/lib/types.ts +94 -140
  80. package/lib/unified-schema.ts +29 -29
  81. package/lib/uprn/existence.ts +30 -19
  82. package/lib/uprn/lookup.ts +28 -67
  83. package/lib/uprn/schema.ts +18 -40
  84. package/lib/weights-overlay-linker.ts +204 -232
  85. package/out/address/point/interpolation.d.ts +45 -0
  86. package/out/address/point/interpolation.d.ts.map +1 -0
  87. package/out/address/{point-interpolation.js → point/interpolation.js} +38 -38
  88. package/out/address/point/interpolation.js.map +1 -0
  89. package/out/address/point/schema.d.ts +74 -0
  90. package/out/address/point/schema.d.ts.map +1 -0
  91. package/out/address/{point-schema.js → point/schema.js} +4 -20
  92. package/out/address/point/schema.js.map +1 -0
  93. package/out/address/point.d.ts +24 -21
  94. package/out/address/point.d.ts.map +1 -1
  95. package/out/address/point.js +60 -77
  96. package/out/address/point.js.map +1 -1
  97. package/out/{address/index.js → address.d.ts} +3 -3
  98. package/out/address.d.ts.map +1 -0
  99. package/out/{address/index.d.ts → address.js} +3 -3
  100. package/out/address.js.map +1 -0
  101. package/out/ancestry/backfill.d.ts +11 -64
  102. package/out/ancestry/backfill.d.ts.map +1 -1
  103. package/out/ancestry/backfill.js +18 -76
  104. package/out/ancestry/backfill.js.map +1 -1
  105. package/out/ancestry.d.ts +49 -0
  106. package/out/ancestry.d.ts.map +1 -0
  107. package/out/ancestry.js +59 -0
  108. package/out/ancestry.js.map +1 -0
  109. package/out/build/candidate.d.ts +170 -0
  110. package/out/build/candidate.d.ts.map +1 -0
  111. package/out/{build-candidate.js → build/candidate.js} +33 -102
  112. package/out/build/candidate.js.map +1 -0
  113. package/out/build/population-corrections.d.ts +52 -0
  114. package/out/build/population-corrections.d.ts.map +1 -0
  115. package/out/build/population-corrections.js +40 -0
  116. package/out/build/population-corrections.js.map +1 -0
  117. package/out/build/slim.d.ts +44 -0
  118. package/out/build/slim.d.ts.map +1 -0
  119. package/out/{build-slim.js → build/slim.js} +33 -94
  120. package/out/build/slim.js.map +1 -0
  121. package/out/candidate/alias-bags.d.ts +13 -5
  122. package/out/candidate/alias-bags.d.ts.map +1 -1
  123. package/out/candidate/alias-bags.js +55 -12
  124. package/out/candidate/alias-bags.js.map +1 -1
  125. package/out/candidate/ancestors/schema.d.ts +166 -0
  126. package/out/candidate/ancestors/schema.d.ts.map +1 -0
  127. package/out/candidate/ancestors/schema.js +131 -0
  128. package/out/candidate/ancestors/schema.js.map +1 -0
  129. package/out/candidate/ancestors/sidecar.d.ts +27 -0
  130. package/out/candidate/ancestors/sidecar.d.ts.map +1 -0
  131. package/out/candidate/{ancestors-sidecar.js → ancestors/sidecar.js} +17 -24
  132. package/out/candidate/ancestors/sidecar.js.map +1 -0
  133. package/out/candidate/country-display-names.d.ts +5 -15
  134. package/out/candidate/country-display-names.d.ts.map +1 -1
  135. package/out/candidate/country-display-names.js +6 -20
  136. package/out/candidate/country-display-names.js.map +1 -1
  137. package/out/candidate/extract-fold.d.ts +8 -16
  138. package/out/candidate/extract-fold.d.ts.map +1 -1
  139. package/out/candidate/extract-fold.js +6 -48
  140. package/out/candidate/extract-fold.js.map +1 -1
  141. package/out/candidate/fts.d.ts +19 -0
  142. package/out/candidate/fts.d.ts.map +1 -0
  143. package/out/candidate/fts.js +22 -0
  144. package/out/candidate/fts.js.map +1 -0
  145. package/out/candidate/importance.d.ts +127 -0
  146. package/out/candidate/importance.d.ts.map +1 -0
  147. package/out/candidate/importance.js +162 -0
  148. package/out/candidate/importance.js.map +1 -0
  149. package/out/candidate/lookup.d.ts +36 -0
  150. package/out/candidate/lookup.d.ts.map +1 -0
  151. package/out/candidate/lookup.js +456 -0
  152. package/out/candidate/lookup.js.map +1 -0
  153. package/out/candidate/name-roles.d.ts +10 -22
  154. package/out/candidate/name-roles.d.ts.map +1 -1
  155. package/out/candidate/name-roles.js +15 -33
  156. package/out/candidate/name-roles.js.map +1 -1
  157. package/out/candidate/own-name.d.ts +23 -25
  158. package/out/candidate/own-name.d.ts.map +1 -1
  159. package/out/candidate/own-name.js +34 -31
  160. package/out/candidate/own-name.js.map +1 -1
  161. package/out/candidate/place-attrs.d.ts +20 -13
  162. package/out/candidate/place-attrs.d.ts.map +1 -1
  163. package/out/candidate/place-attrs.js +4 -5
  164. package/out/candidate/place-attrs.js.map +1 -1
  165. package/out/candidate/schema.d.ts +120 -0
  166. package/out/candidate/schema.d.ts.map +1 -0
  167. package/out/{candidate-schema.js → candidate/schema.js} +11 -23
  168. package/out/candidate/schema.js.map +1 -0
  169. package/out/{candidate-scoring.d.ts → candidate/scoring.d.ts} +8 -9
  170. package/out/candidate/scoring.d.ts.map +1 -0
  171. package/out/candidate/scoring.js +157 -0
  172. package/out/candidate/scoring.js.map +1 -0
  173. package/out/capital-schema.d.ts +21 -17
  174. package/out/capital-schema.d.ts.map +1 -1
  175. package/out/capital-schema.js +17 -15
  176. package/out/capital-schema.js.map +1 -1
  177. package/out/capitals.d.ts +26 -24
  178. package/out/capitals.d.ts.map +1 -1
  179. package/out/capitals.js +23 -21
  180. package/out/capitals.js.map +1 -1
  181. package/out/coincident-roles.d.ts +60 -43
  182. package/out/coincident-roles.d.ts.map +1 -1
  183. package/out/coincident-roles.js +61 -50
  184. package/out/coincident-roles.js.map +1 -1
  185. package/out/convention/schema.d.ts +12 -6
  186. package/out/convention/schema.d.ts.map +1 -1
  187. package/out/convention/schema.js +6 -4
  188. package/out/convention/schema.js.map +1 -1
  189. package/out/convention.d.ts +97 -0
  190. package/out/convention.d.ts.map +1 -0
  191. package/out/convention.js +81 -0
  192. package/out/convention.js.map +1 -0
  193. package/out/coverage-manifest-schema.d.ts +33 -38
  194. package/out/coverage-manifest-schema.d.ts.map +1 -1
  195. package/out/coverage-manifest-schema.js +20 -29
  196. package/out/coverage-manifest-schema.js.map +1 -1
  197. package/out/currency-backfill.d.ts +13 -35
  198. package/out/currency-backfill.d.ts.map +1 -1
  199. package/out/currency-backfill.js +12 -39
  200. package/out/currency-backfill.js.map +1 -1
  201. package/out/env.d.ts +2 -2
  202. package/out/env.js +1 -1
  203. package/out/exact-match.d.ts +19 -10
  204. package/out/exact-match.d.ts.map +1 -1
  205. package/out/exact-match.js +31 -20
  206. package/out/exact-match.js.map +1 -1
  207. package/out/extracts.d.ts +65 -54
  208. package/out/extracts.d.ts.map +1 -1
  209. package/out/extracts.js +63 -55
  210. package/out/extracts.js.map +1 -1
  211. package/out/fst/autocomplete.d.ts +28 -20
  212. package/out/fst/autocomplete.d.ts.map +1 -1
  213. package/out/fst/autocomplete.js +38 -27
  214. package/out/fst/autocomplete.js.map +1 -1
  215. package/out/fst/builder.d.ts.map +1 -1
  216. package/out/fst/builder.js +30 -36
  217. package/out/fst/builder.js.map +1 -1
  218. package/out/fst/deserialize-web.d.ts +3 -3
  219. package/out/fst/deserialize-web.d.ts.map +1 -1
  220. package/out/fst/deserialize-web.js +8 -9
  221. package/out/fst/deserialize-web.js.map +1 -1
  222. package/out/fst/format.d.ts +41 -23
  223. package/out/fst/format.d.ts.map +1 -1
  224. package/out/fst/format.js +41 -23
  225. package/out/fst/format.js.map +1 -1
  226. package/out/fst/freshness.d.ts +11 -73
  227. package/out/fst/freshness.d.ts.map +1 -1
  228. package/out/fst/freshness.js +12 -76
  229. package/out/fst/freshness.js.map +1 -1
  230. package/out/fst/matcher.d.ts +1 -1
  231. package/out/fst/matcher.d.ts.map +1 -1
  232. package/out/fst/matcher.js +2 -2
  233. package/out/fst/matcher.js.map +1 -1
  234. package/out/fst/serialize.d.ts +30 -26
  235. package/out/fst/serialize.d.ts.map +1 -1
  236. package/out/fst/serialize.js +44 -58
  237. package/out/fst/serialize.js.map +1 -1
  238. package/out/fst/types.d.ts +71 -59
  239. package/out/fst/types.d.ts.map +1 -1
  240. package/out/fst/types.js +1 -4
  241. package/out/fst/types.js.map +1 -1
  242. package/out/{fst/index.js → fst.d.ts} +1 -1
  243. package/out/fst.d.ts.map +1 -0
  244. package/out/{fst/index.d.ts → fst.js} +1 -1
  245. package/out/fst.js.map +1 -0
  246. package/out/fts/query.d.ts +2 -27
  247. package/out/fts/query.d.ts.map +1 -1
  248. package/out/fts/query.js +5 -36
  249. package/out/fts/query.js.map +1 -1
  250. package/out/fts.d.ts +126 -0
  251. package/out/fts.d.ts.map +1 -0
  252. package/out/fts.js +188 -0
  253. package/out/fts.js.map +1 -0
  254. package/out/geonames/aliases.d.ts +26 -67
  255. package/out/geonames/aliases.d.ts.map +1 -1
  256. package/out/geonames/aliases.js +44 -121
  257. package/out/geonames/aliases.js.map +1 -1
  258. package/out/geonames/postal.d.ts +84 -50
  259. package/out/geonames/postal.d.ts.map +1 -1
  260. package/out/geonames/postal.js +115 -78
  261. package/out/geonames/postal.js.map +1 -1
  262. package/out/{geonames/index.js → geonames.d.ts} +1 -1
  263. package/out/geonames.d.ts.map +1 -0
  264. package/out/{geonames/index.d.ts → geonames.js} +1 -1
  265. package/out/geonames.js.map +1 -0
  266. package/out/index.d.ts +20 -21
  267. package/out/index.d.ts.map +1 -1
  268. package/out/index.js +14 -15
  269. package/out/index.js.map +1 -1
  270. package/out/interpolation.d.ts +15 -52
  271. package/out/interpolation.d.ts.map +1 -1
  272. package/out/interpolation.js +25 -68
  273. package/out/interpolation.js.map +1 -1
  274. package/out/lookup.d.ts +24 -53
  275. package/out/lookup.d.ts.map +1 -1
  276. package/out/lookup.js +117 -223
  277. package/out/lookup.js.map +1 -1
  278. package/out/name-score.d.ts +2 -2
  279. package/out/name-score.d.ts.map +1 -1
  280. package/out/name-score.js +9 -7
  281. package/out/name-score.js.map +1 -1
  282. package/out/nsul/lookup.d.ts +33 -34
  283. package/out/nsul/lookup.d.ts.map +1 -1
  284. package/out/nsul/lookup.js +26 -40
  285. package/out/nsul/lookup.js.map +1 -1
  286. package/out/nsul/schema.d.ts +16 -43
  287. package/out/nsul/schema.d.ts.map +1 -1
  288. package/out/nsul/schema.js +9 -35
  289. package/out/nsul/schema.js.map +1 -1
  290. package/out/{nsul/index.d.ts → nsul.d.ts} +1 -1
  291. package/out/nsul.d.ts.map +1 -0
  292. package/out/{nsul/index.js → nsul.js} +1 -1
  293. package/out/nsul.js.map +1 -0
  294. package/out/paths.d.ts +124 -0
  295. package/out/paths.d.ts.map +1 -0
  296. package/out/paths.js +104 -0
  297. package/out/paths.js.map +1 -0
  298. package/out/place-importance-schema.d.ts +49 -141
  299. package/out/place-importance-schema.d.ts.map +1 -1
  300. package/out/place-importance-schema.js +25 -140
  301. package/out/place-importance-schema.js.map +1 -1
  302. package/out/poi/lookup.d.ts +38 -42
  303. package/out/poi/lookup.d.ts.map +1 -1
  304. package/out/poi/lookup.js +67 -90
  305. package/out/poi/lookup.js.map +1 -1
  306. package/out/poi/schema.d.ts +41 -25
  307. package/out/poi/schema.d.ts.map +1 -1
  308. package/out/poi/schema.js +25 -17
  309. package/out/poi/schema.js.map +1 -1
  310. package/out/{poi/index.js → poi.d.ts} +1 -1
  311. package/out/poi.d.ts.map +1 -0
  312. package/out/{poi/index.d.ts → poi.js} +1 -1
  313. package/out/poi.js.map +1 -0
  314. package/out/polygon-schema.d.ts +10 -6
  315. package/out/polygon-schema.d.ts.map +1 -1
  316. package/out/polygon-schema.js +2 -2
  317. package/out/polygon-schema.js.map +1 -1
  318. package/out/postal/{city-alias-lookup.d.ts → city/alias/lookup.d.ts} +22 -25
  319. package/out/postal/city/alias/lookup.d.ts.map +1 -0
  320. package/out/postal/city/alias/lookup.js +49 -0
  321. package/out/postal/city/alias/lookup.js.map +1 -0
  322. package/out/postal/{city-alias-schema.d.ts → city/alias/schema.d.ts} +15 -11
  323. package/out/postal/city/alias/schema.d.ts.map +1 -0
  324. package/out/postal/{city-alias-schema.js → city/alias/schema.js} +11 -9
  325. package/out/postal/city/alias/schema.js.map +1 -0
  326. package/out/postal/city/candidate-schema.d.ts +72 -0
  327. package/out/postal/city/candidate-schema.d.ts.map +1 -0
  328. package/out/postal/city/candidate-schema.js +60 -0
  329. package/out/postal/city/candidate-schema.js.map +1 -0
  330. package/out/postal.d.ts +9 -0
  331. package/out/postal.d.ts.map +1 -0
  332. package/out/postal.js +9 -0
  333. package/out/postal.js.map +1 -0
  334. package/out/postcode-point-lookup.d.ts +9 -19
  335. package/out/postcode-point-lookup.d.ts.map +1 -1
  336. package/out/postcode-point-lookup.js +5 -17
  337. package/out/postcode-point-lookup.js.map +1 -1
  338. package/out/primary-preference.d.ts +39 -93
  339. package/out/primary-preference.d.ts.map +1 -1
  340. package/out/primary-preference.js +13 -97
  341. package/out/primary-preference.js.map +1 -1
  342. package/out/proximity-rerank.d.ts +40 -29
  343. package/out/proximity-rerank.d.ts.map +1 -1
  344. package/out/proximity-rerank.js +38 -29
  345. package/out/proximity-rerank.js.map +1 -1
  346. package/out/ranking-weights.d.ts +91 -62
  347. package/out/ranking-weights.d.ts.map +1 -1
  348. package/out/ranking-weights.js +26 -25
  349. package/out/ranking-weights.js.map +1 -1
  350. package/out/region-keys.d.ts +48 -29
  351. package/out/region-keys.d.ts.map +1 -1
  352. package/out/region-keys.js +68 -40
  353. package/out/region-keys.js.map +1 -1
  354. package/out/reverse.d.ts +75 -50
  355. package/out/reverse.d.ts.map +1 -1
  356. package/out/reverse.js +61 -49
  357. package/out/reverse.js.map +1 -1
  358. package/out/schema.d.ts +74 -42
  359. package/out/schema.d.ts.map +1 -1
  360. package/out/schema.js +4 -5
  361. package/out/schema.js.map +1 -1
  362. package/out/search-fetch.d.ts +16 -12
  363. package/out/search-fetch.d.ts.map +1 -1
  364. package/out/search-fetch.js +83 -63
  365. package/out/search-fetch.js.map +1 -1
  366. package/out/sqlite/convention-source.d.ts +25 -0
  367. package/out/sqlite/convention-source.d.ts.map +1 -0
  368. package/out/sqlite/convention-source.js +48 -0
  369. package/out/sqlite/convention-source.js.map +1 -0
  370. package/out/sqlite/utils.d.ts +45 -0
  371. package/out/sqlite/utils.d.ts.map +1 -0
  372. package/out/sqlite/utils.js +56 -0
  373. package/out/sqlite/utils.js.map +1 -0
  374. package/out/street/centroid/schema.d.ts +100 -0
  375. package/out/street/centroid/schema.d.ts.map +1 -0
  376. package/out/street/centroid/schema.js +66 -0
  377. package/out/street/centroid/schema.js.map +1 -0
  378. package/out/street/centroid.d.ts +9 -19
  379. package/out/street/centroid.d.ts.map +1 -1
  380. package/out/street/centroid.js +11 -22
  381. package/out/street/centroid.js.map +1 -1
  382. package/out/street/{morphology-fst-builder.d.ts → morphology/fst/builder.d.ts} +21 -11
  383. package/out/street/morphology/fst/builder.d.ts.map +1 -0
  384. package/out/street/{morphology-fst-builder.js → morphology/fst/builder.js} +40 -34
  385. package/out/street/morphology/fst/builder.js.map +1 -0
  386. package/out/street/morphology/fst/loader.d.ts +74 -0
  387. package/out/street/morphology/fst/loader.d.ts.map +1 -0
  388. package/out/street/{morphology-fst-loader.js → morphology/fst/loader.js} +21 -21
  389. package/out/street/morphology/fst/loader.js.map +1 -0
  390. package/out/street/name-lookup.d.ts +24 -18
  391. package/out/street/name-lookup.d.ts.map +1 -1
  392. package/out/street/name-lookup.js +32 -31
  393. package/out/street/name-lookup.js.map +1 -1
  394. package/out/street/normalize.d.ts +35 -136
  395. package/out/street/normalize.d.ts.map +1 -1
  396. package/out/street/normalize.js +74 -191
  397. package/out/street/normalize.js.map +1 -1
  398. package/out/street/segment-schema.d.ts +79 -39
  399. package/out/street/segment-schema.d.ts.map +1 -1
  400. package/out/street/segment-schema.js +71 -21
  401. package/out/street/segment-schema.js.map +1 -1
  402. package/out/{street/index.d.ts → street.d.ts} +4 -4
  403. package/out/street.d.ts.map +1 -0
  404. package/out/{street/index.js → street.js} +4 -4
  405. package/out/street.js.map +1 -0
  406. package/out/types.d.ts +69 -138
  407. package/out/types.d.ts.map +1 -1
  408. package/out/types.js +0 -6
  409. package/out/types.js.map +1 -1
  410. package/out/unified-schema.d.ts +8 -12
  411. package/out/unified-schema.d.ts.map +1 -1
  412. package/out/unified-schema.js +29 -29
  413. package/out/unified-schema.js.map +1 -1
  414. package/out/uprn/existence.d.ts +28 -17
  415. package/out/uprn/existence.d.ts.map +1 -1
  416. package/out/uprn/existence.js +26 -16
  417. package/out/uprn/existence.js.map +1 -1
  418. package/out/uprn/lookup.d.ts +14 -44
  419. package/out/uprn/lookup.d.ts.map +1 -1
  420. package/out/uprn/lookup.js +20 -56
  421. package/out/uprn/lookup.js.map +1 -1
  422. package/out/uprn/schema.d.ts +18 -40
  423. package/out/uprn/schema.d.ts.map +1 -1
  424. package/out/uprn/schema.js +10 -32
  425. package/out/uprn/schema.js.map +1 -1
  426. package/out/{uprn/index.d.ts → uprn.d.ts} +1 -1
  427. package/out/uprn.d.ts.map +1 -0
  428. package/out/{uprn/index.js → uprn.js} +1 -1
  429. package/out/uprn.js.map +1 -0
  430. package/out/weights-overlay-linker.d.ts +132 -141
  431. package/out/weights-overlay-linker.d.ts.map +1 -1
  432. package/out/weights-overlay-linker.js +86 -154
  433. package/out/weights-overlay-linker.js.map +1 -1
  434. package/package.json +94 -599
  435. package/lib/address/point-schema.ts +0 -155
  436. package/lib/build-candidate.ts +0 -632
  437. package/lib/build-slim.ts +0 -408
  438. package/lib/candidate-ancestors-schema.ts +0 -195
  439. package/lib/candidate-fts.ts +0 -46
  440. package/lib/candidate-importance.ts +0 -224
  441. package/lib/candidate-lookup.ts +0 -977
  442. package/lib/candidate-schema.ts +0 -247
  443. package/lib/candidate-scoring.ts +0 -261
  444. package/lib/convention/index.ts +0 -154
  445. package/lib/fts/index.ts +0 -361
  446. package/lib/postal/city-alias-lookup.ts +0 -97
  447. package/lib/postal/index.ts +0 -9
  448. package/lib/sqlite-convention-source.ts +0 -65
  449. package/lib/sqlite-utils.ts +0 -82
  450. package/lib/street/centroid-schema.ts +0 -154
  451. package/out/address/index.d.ts.map +0 -1
  452. package/out/address/index.js.map +0 -1
  453. package/out/address/point-interpolation.d.ts +0 -49
  454. package/out/address/point-interpolation.d.ts.map +0 -1
  455. package/out/address/point-interpolation.js.map +0 -1
  456. package/out/address/point-schema.d.ts +0 -97
  457. package/out/address/point-schema.d.ts.map +0 -1
  458. package/out/address/point-schema.js.map +0 -1
  459. package/out/ancestry/index.d.ts +0 -45
  460. package/out/ancestry/index.d.ts.map +0 -1
  461. package/out/ancestry/index.js +0 -55
  462. package/out/ancestry/index.js.map +0 -1
  463. package/out/build-candidate.d.ts +0 -184
  464. package/out/build-candidate.d.ts.map +0 -1
  465. package/out/build-candidate.js.map +0 -1
  466. package/out/build-slim.d.ts +0 -80
  467. package/out/build-slim.d.ts.map +0 -1
  468. package/out/build-slim.js.map +0 -1
  469. package/out/candidate/ancestors-sidecar.d.ts +0 -32
  470. package/out/candidate/ancestors-sidecar.d.ts.map +0 -1
  471. package/out/candidate/ancestors-sidecar.js.map +0 -1
  472. package/out/candidate-ancestors-schema.d.ts +0 -150
  473. package/out/candidate-ancestors-schema.d.ts.map +0 -1
  474. package/out/candidate-ancestors-schema.js +0 -123
  475. package/out/candidate-ancestors-schema.js.map +0 -1
  476. package/out/candidate-fts.d.ts +0 -37
  477. package/out/candidate-fts.d.ts.map +0 -1
  478. package/out/candidate-fts.js +0 -40
  479. package/out/candidate-fts.js.map +0 -1
  480. package/out/candidate-importance.d.ts +0 -132
  481. package/out/candidate-importance.d.ts.map +0 -1
  482. package/out/candidate-importance.js +0 -169
  483. package/out/candidate-importance.js.map +0 -1
  484. package/out/candidate-lookup.d.ts +0 -76
  485. package/out/candidate-lookup.d.ts.map +0 -1
  486. package/out/candidate-lookup.js +0 -768
  487. package/out/candidate-lookup.js.map +0 -1
  488. package/out/candidate-schema.d.ts +0 -155
  489. package/out/candidate-schema.d.ts.map +0 -1
  490. package/out/candidate-schema.js.map +0 -1
  491. package/out/candidate-scoring.d.ts.map +0 -1
  492. package/out/candidate-scoring.js +0 -196
  493. package/out/candidate-scoring.js.map +0 -1
  494. package/out/convention/index.d.ts +0 -106
  495. package/out/convention/index.d.ts.map +0 -1
  496. package/out/convention/index.js +0 -93
  497. package/out/convention/index.js.map +0 -1
  498. package/out/fst/index.d.ts.map +0 -1
  499. package/out/fst/index.js.map +0 -1
  500. package/out/fts/index.d.ts +0 -184
  501. package/out/fts/index.d.ts.map +0 -1
  502. package/out/fts/index.js +0 -277
  503. package/out/fts/index.js.map +0 -1
  504. package/out/geonames/index.d.ts.map +0 -1
  505. package/out/geonames/index.js.map +0 -1
  506. package/out/nsul/index.d.ts.map +0 -1
  507. package/out/nsul/index.js.map +0 -1
  508. package/out/poi/index.d.ts.map +0 -1
  509. package/out/poi/index.js.map +0 -1
  510. package/out/postal/city-alias-lookup.d.ts.map +0 -1
  511. package/out/postal/city-alias-lookup.js +0 -62
  512. package/out/postal/city-alias-lookup.js.map +0 -1
  513. package/out/postal/city-alias-schema.d.ts.map +0 -1
  514. package/out/postal/city-alias-schema.js.map +0 -1
  515. package/out/postal/city-candidate-schema.d.ts +0 -66
  516. package/out/postal/city-candidate-schema.d.ts.map +0 -1
  517. package/out/postal/city-candidate-schema.js +0 -56
  518. package/out/postal/city-candidate-schema.js.map +0 -1
  519. package/out/postal/index.d.ts +0 -9
  520. package/out/postal/index.d.ts.map +0 -1
  521. package/out/postal/index.js +0 -9
  522. package/out/postal/index.js.map +0 -1
  523. package/out/sqlite-convention-source.d.ts +0 -29
  524. package/out/sqlite-convention-source.d.ts.map +0 -1
  525. package/out/sqlite-convention-source.js +0 -57
  526. package/out/sqlite-convention-source.js.map +0 -1
  527. package/out/sqlite-utils.d.ts +0 -45
  528. package/out/sqlite-utils.d.ts.map +0 -1
  529. package/out/sqlite-utils.js +0 -57
  530. package/out/sqlite-utils.js.map +0 -1
  531. package/out/street/centroid-schema.d.ts +0 -105
  532. package/out/street/centroid-schema.d.ts.map +0 -1
  533. package/out/street/centroid-schema.js +0 -78
  534. package/out/street/centroid-schema.js.map +0 -1
  535. package/out/street/index.d.ts.map +0 -1
  536. package/out/street/index.js.map +0 -1
  537. package/out/street/morphology-fst-builder.d.ts.map +0 -1
  538. package/out/street/morphology-fst-builder.js.map +0 -1
  539. package/out/street/morphology-fst-loader.d.ts +0 -67
  540. package/out/street/morphology-fst-loader.d.ts.map +0 -1
  541. package/out/street/morphology-fst-loader.js.map +0 -1
  542. package/out/uprn/index.d.ts.map +0 -1
  543. package/out/uprn/index.js.map +0 -1
  544. /package/lib/{fst/index.ts → fst.ts} +0 -0
  545. /package/lib/{geonames/index.ts → geonames.ts} +0 -0
  546. /package/lib/{nsul/index.ts → nsul.ts} +0 -0
  547. /package/lib/{poi/index.ts → poi.ts} +0 -0
  548. /package/lib/{uprn/index.ts → uprn.ts} +0 -0
package/lib/fts/index.ts DELETED
@@ -1,361 +0,0 @@
1
- /**
2
- * @copyright Sister Software
3
- * @license AGPL-3.0
4
- * @author Teffen Ellis, et al.
5
- *
6
- * FTS5 index lifecycle for the WOF SQLite distribution.
7
- *
8
- * Shared by `WOFSQLitePlaceLookup` (lazy build via `buildFTS: true`) and the operator-side
9
- * `mailwoman gazetteer build fts` CLI (ahead-of-time build to avoid first-open latency in production).
10
- *
11
- * Upstream WOF SQLite distributions do NOT ship FTS5. The index lives in a `place_search` virtual
12
- * table whose rows mirror `(spr.id, spr.name, GROUP_CONCAT(names.name))` — one current,
13
- * non-deprecated place per row, with all alternate names concatenated into a single search-token
14
- * bag.
15
- */
16
-
17
- import type { DatabaseClient } from "@mailwoman/sqlite/client"
18
- import { tableExists } from "@mailwoman/sqlite/introspection"
19
-
20
- /**
21
- * Name of the FTS5 virtual table this module owns. Centralized so `WOFSQLitePlaceLookup` and the CLI can't drift apart.
22
- */
23
- export const PLACE_SEARCH_TABLE = "place_search"
24
-
25
- /**
26
- * Boundary-preserving separator between aliases in the `alt_names` bag (#523): U+E000, the first Private Use Area
27
- * codepoint, written as an escape so the source stays plain ASCII.
28
- *
29
- * Why a PUA codepoint and not punctuation: the goal is to stop a phrase query from matching ACROSS two adjacent
30
- * aliases' concatenation boundary ("York" + "New City" must not phrase-match `"york new"`). FTS5 assigns token
31
- * positions to TOKENS only — separator characters never consume a position — so any character the tokenizer treats as a
32
- * boundary leaves the two aliases' tokens adjacent and the false phrase match intact. The separator must therefore be
33
- * an INDEXED TOKEN that sits between the aliases and breaks positional adjacency.
34
- *
35
- * Empirical probe (node:sqlite, `tokenize = 'unicode61 remove_diacritics 2'` — the exact config below). Bag = the
36
- * aliases "York" and "New City" joined by each candidate separator; query = the cross-boundary phrase `MATCH '"york
37
- * new"'`:
38
- *
39
- * - `' '` (the pre-#523 join, no separator) — false HIT
40
- * - `' ; '` (punctuation) — false HIT
41
- * - `' \u2016 '` (double vertical line) — false HIT
42
- * - `' \x1F '` (ASCII unit separator) — false HIT
43
- * - `' \uE000 '` (PUA, this constant) — NO match, while `'"york"'` and `'"new city"'` still match the bag individually
44
- * under every variant above.
45
- *
46
- * U+E000 works because unicode61 classifies it (category Co — neither space nor punctuation) as a token character, so
47
- * the standalone `\uE000` between aliases is indexed as its own token and the aliases' tokens are no longer
48
- * positionally adjacent. The remaining requirements also hold:
49
- *
50
- * - **Unreachable from queries**: `sanitizeFTSQuery` (Node + WASM resolvers) strips everything outside `\p{L}\p{N}` from
51
- * token bodies, and U+E000 is neither — no user query can ever address the separator token. The demo's `sanitizeFTS`
52
- * strips it explicitly.
53
- * - **Never in place names**: PUA codepoints are unassigned by definition; real-world WOF names don't carry them.
54
- * Defensively, the INSERT below also strips any embedded U+E000 from source names so a poisoned row can't forge an
55
- * alias boundary.
56
- * - **Survives GROUP_CONCAT**: verified — `GROUP_CONCAT(name, ' ' || char(57344) || ' ')` emits the codepoint intact
57
- * (`57344` = 0xE000).
58
- * - **Cost**: one extra token per alias boundary in the FTS document. Marginal BM25 length-norm impact, on a column whose
59
- * length stats are already the known #189 problem.
60
- *
61
- * Interaction with #189 (split `alt_names` into its own FTS table for independent BM25 length stats): the separator
62
- * SURVIVES that split as proposed — #189 still GROUP_CONCATs all aliases into one `place_search_alt` row per place, so
63
- * both the separator and the bag-parsing exact check (`aliasBagExactMatch`) carry over unchanged, just pointed at the
64
- * new table. Only if #189 were instead built as one-row-per-alias would both become moot (per-alias rows give exact
65
- * equality and phrase isolation for free). Sequencing: if #189 lands before the next slim-DB artifact rebuild, fold
66
- * both into ONE rebuild rather than shipping two FTS schema bumps.
67
- */
68
- export const ALIAS_SEPARATOR = "\uE000"
69
-
70
- /**
71
- * `char()` argument for {@link ALIAS_SEPARATOR} in SQL — keeps the SQL text plain ASCII.
72
- */
73
- const ALIAS_SEPARATOR_CODEPOINT = ALIAS_SEPARATOR.codePointAt(0) as number
74
-
75
- /**
76
- * The query/name fold every exact-tier comparison uses: lowercase, trim, collapse internal whitespace. The `alt_names`
77
- * bag is compared alias-by-alias against a query folded THIS way, so the fold lives beside the bag parser — every
78
- * consumer (the Node resolver's exact tier, the WASM resolver, the name-exact sub-tier sort) folds through this one
79
- * function.
80
- */
81
- export function foldQueryText(input: string): string {
82
- return input.toLowerCase().trim().replaceAll(/\s+/g, " ")
83
- }
84
-
85
- /**
86
- * Does any alias in an `alt_names` bag exactly equal the (already-normalized) query? The single shared implementation
87
- * of the exact-tier alias check for every consumer of the bag — the Node resolver's `#exactMatchIDs` fallback, the WASM
88
- * resolver, and the demo's httpvfs resolver — so the bag format and its parsers can't drift.
89
- *
90
- * Two formats exist in the wild:
91
- *
92
- * - **Separated bags** (built since #523): aliases joined with {@link ALIAS_SEPARATOR}, plus a trailing separator so even
93
- * a single-alias bag self-identifies as separator-formatted. Split + per-alias equality — a true exact-alias check,
94
- * matching the semantics of the full `names` table (`names.name = ? COLLATE NOCASE`), so it runs unrestricted: an
95
- * alias match is an exact match whether or not another candidate matched on its canonical name.
96
- * - **Legacy bags** (pre-#523 artifacts, e.g. an already-deployed slim DB): aliases space-joined, boundaries lost. Falls
97
- * back to the historical padded-containment check, conditioned on `anyStrictExact` — unrestricted containment would
98
- * false-promote interior fragments ("York" inside the alias "New York City") and cross-boundary fragments ("York New"
99
- * across "…York" + "New…"). Delete this branch once every shipped artifact carries the separator.
100
- *
101
- * @param altNames The `alt_names` bag from `place_search` (null when the row has no aliases).
102
- * @param normalizedQuery The query, pre-normalized: lowercased, trimmed, internal whitespace collapsed (every consumer
103
- * already normalizes this way).
104
- * @param anyStrictExact Whether ANY candidate in the pool already matched strictly (canonical name or region
105
- * abbreviation). Only consulted for legacy bags.
106
- */
107
- export function aliasBagExactMatch(altNames: string | null, normalizedQuery: string, anyStrictExact: boolean): boolean {
108
- if (altNames === null || altNames === "" || !normalizedQuery) return false
109
-
110
- if (altNames.includes(ALIAS_SEPARATOR)) {
111
- return altNames.split(ALIAS_SEPARATOR).some((alias) => foldQueryText(alias) === normalizedQuery)
112
- }
113
-
114
- if (anyStrictExact) return false
115
-
116
- return ` ${foldQueryText(altNames)} `.includes(` ${normalizedQuery} `)
117
- }
118
-
119
- /**
120
- * Name of the R*Tree virtual table that indexes WOF places' bounding boxes for proximity / bbox lookups. Built
121
- * alongside `place_search` by the CLI and `buildFTS: true`. Pure SQLite — no extensions needed, the `rtree`
122
- * virtual-table module ships with the core library.
123
- */
124
- export const PLACE_BBOX_TABLE = "place_bbox"
125
-
126
- /**
127
- * Name of the auxiliary table holding `wof:population` per place. Powers the population-weighted ranking boost. Sparse
128
- * — WOF only populates this field for ~15% of localities (and mostly larger ones); missing means no boost, never a
129
- * penalty. Built upstream by `scripts/build-unified-wof.ts` at ingest (and copied through by `build-slim`) — this
130
- * module consumes it, never builds it.
131
- *
132
- * Schema: `(id INTEGER PRIMARY KEY, population INTEGER NOT NULL)`. Plain table, not virtual.
133
- */
134
- export const PLACE_POPULATION_TABLE = "place_population"
135
-
136
- /**
137
- * Name of the auxiliary table holding the two salience scores per place — `referential` (population-anchored, the
138
- * ranking backbone) and `encyclopedic` (the Wikipedia join, NULL when there is no article). Built by `mailwoman
139
- * gazetteer importance`; schema and derivations in `place-importance-schema.ts`.
140
- *
141
- * The lookup reads ONLY `encyclopedic` from it, and only to CARRY the value onto the result — referential is derived
142
- * from the population already joined, and no ORDER BY anywhere touches this table (ROAD_TO_V9 §2). Sparse and
143
- * schema-versioned: a pre-split gazetteer has this table with a single conflated `importance` column instead, which the
144
- * lookup's column probe deliberately refuses to read.
145
- */
146
- export const PLACE_IMPORTANCE_TABLE = "place_importance"
147
-
148
- /**
149
- * Counters for a single `buildPlaceSearchFTS` run. Exposed so callers (CLI, lazy-build) can render progress to the
150
- * user.
151
- */
152
- export interface BuildPlaceSearchFTSResult {
153
- /**
154
- * Whether the FTS5 index was created (true) or already existed and was left alone (false).
155
- */
156
- created: boolean
157
- /**
158
- * Number of rows in the `place_search` table after the call.
159
- */
160
- indexedRows: number
161
- /**
162
- * Whether the R*Tree bbox index was created (true) or already existed (false).
163
- */
164
- bboxCreated: boolean
165
- /**
166
- * Number of rows in the `place_bbox` R*Tree after the call.
167
- */
168
- bboxIndexedRows: number
169
- /**
170
- * Wall-clock duration of the build step, in milliseconds.
171
- */
172
- durationMs: number
173
- }
174
-
175
- export interface BuildPlaceSearchFTSOpts {
176
- /**
177
- * Drop the existing `place_search` AND `place_bbox` tables before building. Default false — if either already exists
178
- * the corresponding build step is skipped. Set true when you want to rebuild against an updated `spr` / `names`
179
- * snapshot.
180
- */
181
- drop?: boolean
182
- /**
183
- * Optional progress callback invoked after each phase. Useful for CLI output on the planet-scale builds where the
184
- * INSERT step can take minutes.
185
- */
186
- onProgress?: (
187
- phase: "checking" | "dropping" | "creating" | "populating" | "creating-bbox" | "populating-bbox" | "done",
188
- detail?: string
189
- ) => void
190
- }
191
-
192
- /**
193
- * Build (or rebuild, with `drop: true`) the `place_search` FTS5 virtual table AND the `place_bbox` R*Tree virtual table
194
- * from the existing `spr` + `names` tables in a WOF SQLite distribution.
195
- *
196
- * The FTS5 index is used for name-based MATCH queries; the R*Tree is used for bbox + proximity filtering. Both are pure
197
- * SQLite — no extensions required.
198
- *
199
- * Returns a `BuildPlaceSearchFTSResult` summary. Idempotent when `drop: false` — re-running against an already-indexed
200
- * DB skips whichever indexes already exist.
201
- */
202
- export function buildPlaceSearchFTS<DB>(
203
- db: DatabaseClient<DB>,
204
- opts: BuildPlaceSearchFTSOpts = {}
205
- ): BuildPlaceSearchFTSResult {
206
- const start = Date.now()
207
- const onProgress = opts.onProgress ?? (() => {})
208
-
209
- onProgress("checking")
210
- const ftsExisting = tableExists(db, PLACE_SEARCH_TABLE)
211
- const bboxExisting = tableExists(db, PLACE_BBOX_TABLE)
212
-
213
- // ─── FTS5 phase ──────────────────────────────────────────────────
214
- let ftsCreated = false
215
-
216
- if (ftsExisting && opts.drop) {
217
- onProgress("dropping", PLACE_SEARCH_TABLE)
218
- db.exec(`DROP TABLE ${PLACE_SEARCH_TABLE}`)
219
- }
220
-
221
- if (!ftsExisting || opts.drop) {
222
- onProgress("creating")
223
-
224
- db.exec(`
225
- CREATE VIRTUAL TABLE ${PLACE_SEARCH_TABLE} USING fts5(
226
- wof_id UNINDEXED,
227
- name,
228
- alt_names,
229
- tokenize = 'unicode61 remove_diacritics 2'
230
- );
231
- `)
232
-
233
- onProgress("populating")
234
-
235
- // Excludes only definitively-not-current places. WOF's `is_current` carries TWO conventions:
236
- // `-1` (modern Who's On First) and `1` (legacy Mapzen-era), both meaning "currently valid".
237
- // Only `0` means "no longer current". Filtering on `= -1` strict (as Phase 4.2 did) excluded
238
- // ~42% of admin-US and ~68% of postcode-US — see #91 for the diagnostic + magnitude.
239
- //
240
- // Aliases join on the boundary-preserving ALIAS_SEPARATOR token (#523) — space-padded so each
241
- // alias still tokenizes normally — and any U+E000 embedded in a source name is defensively
242
- // flattened to a space so it can't forge a boundary. A TRAILING separator marks the bag as
243
- // separator-formatted even when it holds a single alias, so `aliasBagExactMatch` never
244
- // mistakes a new bag for a legacy (pre-#523) one. See the ALIAS_SEPARATOR docs for the
245
- // probe + rationale.
246
- db.exec(`
247
- INSERT INTO ${PLACE_SEARCH_TABLE} (wof_id, name, alt_names)
248
- SELECT
249
- spr.id,
250
- spr.name,
251
- COALESCE((
252
- SELECT GROUP_CONCAT(
253
- REPLACE(name, char(${ALIAS_SEPARATOR_CODEPOINT}), ' '),
254
- ' ' || char(${ALIAS_SEPARATOR_CODEPOINT}) || ' '
255
- ) || ' ' || char(${ALIAS_SEPARATOR_CODEPOINT})
256
- FROM names WHERE names.id = spr.id
257
- ), '')
258
- FROM spr
259
- WHERE spr.is_current != 0
260
- AND spr.is_deprecated = 0
261
- AND spr.name IS NOT NULL;
262
- `)
263
-
264
- ftsCreated = true
265
- }
266
-
267
- const ftsCountRow = db.prepare(`SELECT COUNT(*) AS n FROM ${PLACE_SEARCH_TABLE}`).get() as { n: number }
268
-
269
- // ─── R*Tree phase ────────────────────────────────────────────────
270
- let bboxCreated = false
271
-
272
- if (bboxExisting && opts.drop) {
273
- onProgress("dropping", PLACE_BBOX_TABLE)
274
- db.exec(`DROP TABLE ${PLACE_BBOX_TABLE}`)
275
- }
276
-
277
- if (!bboxExisting || opts.drop) {
278
- onProgress("creating-bbox")
279
-
280
- // R*Tree requires INTEGER PRIMARY KEY (id) + paired min/max for each indexed dimension.
281
- // `rtree` (not `rtree_i32`) keeps coordinates as REAL — what we want for WGS-84.
282
- db.exec(`
283
- CREATE VIRTUAL TABLE ${PLACE_BBOX_TABLE} USING rtree(
284
- id,
285
- min_lat, max_lat,
286
- min_lon, max_lon
287
- );
288
- `)
289
-
290
- onProgress("populating-bbox")
291
-
292
- // Only index places that have non-zero coordinates AND a real bbox. WOF stores both the
293
- // centroid (latitude/longitude) and the bounding box (min_*/max_*). A subset of rows have
294
- // all-zero coordinates — likely placeholders for deprecated / unmapped entries; the
295
- // is_current / is_deprecated filter mostly catches them, but we double-check at insert.
296
- db.exec(`
297
- INSERT INTO ${PLACE_BBOX_TABLE} (id, min_lat, max_lat, min_lon, max_lon)
298
- SELECT
299
- spr.id,
300
- spr.min_latitude,
301
- spr.max_latitude,
302
- spr.min_longitude,
303
- spr.max_longitude
304
- FROM spr
305
- WHERE spr.is_current != 0
306
- AND spr.is_deprecated = 0
307
- AND spr.min_latitude IS NOT NULL
308
- AND spr.max_latitude IS NOT NULL
309
- AND spr.min_longitude IS NOT NULL
310
- AND spr.max_longitude IS NOT NULL
311
- AND NOT (spr.min_latitude = 0 AND spr.max_latitude = 0
312
- AND spr.min_longitude = 0 AND spr.max_longitude = 0);
313
- `)
314
-
315
- bboxCreated = true
316
- }
317
-
318
- const bboxCountRow = db.prepare(`SELECT COUNT(*) AS n FROM ${PLACE_BBOX_TABLE}`).get() as { n: number }
319
-
320
- // NOTE: `place_population` is NOT built here. `scripts/build-unified-wof.ts` extracts
321
- // `wof:population` straight into that table at ingest (the canonical source carries no `geojson`
322
- // table), and `build-slim` copies it through. This function only owns the two FTS-derived virtual
323
- // tables, both of which build from `spr` + `names` alone. `placePopulationExists` lets callers
324
- // check for the pre-built table.
325
-
326
- onProgress(
327
- "done",
328
- `${ftsCountRow.n} FTS rows + ${bboxCountRow.n} bbox rows ` +
329
- `(${ftsCreated ? "built" : "preexisting"} / ${bboxCreated ? "built" : "preexisting"})`
330
- )
331
-
332
- return {
333
- created: ftsCreated,
334
- indexedRows: ftsCountRow.n,
335
- bboxCreated,
336
- bboxIndexedRows: bboxCountRow.n,
337
- durationMs: Date.now() - start,
338
- }
339
- }
340
-
341
- /**
342
- * Returns true iff the `place_search` table exists in the connected DB. Used by `WOFSQLitePlaceLookup` for its "FTS
343
- * missing — pass buildFTS:true or run the CLI" guard.
344
- */
345
- export function placeSearchFTSExists<DB>(db: DatabaseClient<DB>): boolean {
346
- return tableExists(db, PLACE_SEARCH_TABLE)
347
- }
348
-
349
- /**
350
- * Returns true iff the `place_bbox` R*Tree table exists. Used for opt-in proximity lookup checks.
351
- */
352
- export function placeBboxExists<DB>(db: DatabaseClient<DB>): boolean {
353
- return tableExists(db, PLACE_BBOX_TABLE)
354
- }
355
-
356
- /**
357
- * Returns true iff the `place_population` table exists. Used for opt-in population-ranking checks.
358
- */
359
- export function placePopulationExists<DB>(db: DatabaseClient<DB>): boolean {
360
- return tableExists(db, PLACE_POPULATION_TABLE)
361
- }
@@ -1,97 +0,0 @@
1
- /**
2
- * @copyright Sister Software
3
- * @license AGPL-3.0
4
- * @author Teffen Ellis, et al.
5
- *
6
- * Node reader over the POSTAL-CITY ALIAS table (`postal-city-alias-<cc>.db`) — the observed
7
- * `postal_city → geo_locality` aliases per postcode (`build-postal-city-alias.ts`). Consumed by
8
- * {@link WOFSQLitePlaceLookup}'s coordinate-first locality scorer: a user-typed postal city
9
- * ("Antioch", postcode 37013) becomes a name-match alias for the geographic locality the postcode
10
- * actually sits in ("Nashville"), so the right place tiers to the top instead of a same-named
11
- * town in another state. Opt-in — the lookup is only constructed when a path is supplied, and
12
- * absent it the resolver is byte-identical.
13
- *
14
- * The reader returns RAW divergent rows for a postcode; normalization + name-matching against the
15
- * candidate localities is the scorer's job (it owns the case/diacritic fold the soft name score
16
- * uses), keeping one normalizer in one place.
17
- */
18
-
19
- import { DatabaseClient } from "@mailwoman/sqlite/client"
20
-
21
- import type { PostalCityAliasDatabase } from "#postal/city-alias-schema"
22
-
23
- export interface WOFPostalCityAliasLookupOpts {
24
- /**
25
- * Path to a `postal-city-alias-<cc>.db` built by `build-postal-city-alias.ts`. Opened read-only.
26
- */
27
- databasePath?: string
28
- /**
29
- * Pre-opened handle (tests / shared connections). Mutually exclusive with `databasePath`.
30
- */
31
- database?: DatabaseClient<PostalCityAliasDatabase>
32
- }
33
-
34
- /**
35
- * One divergent alias edge: the postal-system name and the geographic locality it maps to.
36
- */
37
- export interface PostalCityAlias {
38
- /**
39
- * The postal-system surface (what a user types).
40
- */
41
- postalCity: string
42
- /**
43
- * The geographic locality name the postcode sits in (≈ the gazetteer's canonical name).
44
- */
45
- geoLocality: string
46
- /**
47
- * Observed usage count — the evidence weight.
48
- */
49
- n: number
50
- }
51
-
52
- /**
53
- * Reader over `postal_city_alias`. The only query is a postcode-scoped probe for DIVERGENT rows (where the postal name
54
- * differs from the geographic name — the rows that carry alias signal), issued via the typed Kysely query builder
55
- * against {@link PostalCityAliasDatabase}.
56
- */
57
- export class WOFPostalCityAliasLookup implements Disposable {
58
- #db: DatabaseClient<PostalCityAliasDatabase>
59
- /**
60
- * Resources this instance opened. A connection handed in by a caller is NOT in here, so disposal cannot reach it —
61
- * ownership is membership rather than a flag a later branch has to check.
62
- */
63
- readonly #resources = new DisposableStack()
64
-
65
- constructor(opts: WOFPostalCityAliasLookupOpts) {
66
- if (opts.database) {
67
- this.#db = opts.database
68
- } else if (opts.databasePath) {
69
- this.#db = this.#resources.use(new DatabaseClient<PostalCityAliasDatabase>(opts.databasePath, { readOnly: true }))
70
- } else {
71
- throw new Error("WOFPostalCityAliasLookup needs `databasePath` or `database`")
72
- }
73
- }
74
-
75
- /**
76
- * Divergent postal-city aliases for a postcode (empty when the postcode isn't in the table). The scorer groups these
77
- * by normalized `geoLocality` and appends the `postalCity` surfaces to the matching candidate locality's alias set.
78
- */
79
- async getDivergentAliases(postcode: string): Promise<PostalCityAlias[]> {
80
- const pc = postcode.trim()
81
-
82
- if (!pc) return []
83
-
84
- const rows = await this.#db
85
- .selectFrom("postal_city_alias")
86
- .select(["postal_city", "geo_locality", "n"])
87
- .where("postcode", "=", pc)
88
- .where("divergent", "=", 1)
89
- .execute()
90
-
91
- return rows.map((r) => ({ postalCity: String(r.postal_city), geoLocality: String(r.geo_locality), n: Number(r.n) }))
92
- }
93
-
94
- [Symbol.dispose](): void {
95
- this.#resources[Symbol.dispose]()
96
- }
97
- }
@@ -1,9 +0,0 @@
1
- /**
2
- * @copyright Sister Software
3
- * @license AGPL-3.0
4
- * @author Teffen Ellis, et al.
5
- */
6
-
7
- export * from "#postal/city-alias-lookup"
8
- export * from "#postal/city-alias-schema"
9
- export * from "#postal/city-candidate-schema"
@@ -1,65 +0,0 @@
1
- /**
2
- * @copyright Sister Software
3
- * @license AGPL-3.0
4
- * @author Teffen Ellis, et al.
5
- *
6
- * `SqliteConventionSource` — a `ConventionSource` backed by the build-from-source convention asset
7
- * (#290, Direction E). Conventions live in a read-only, provenance-stamped `address_convention`
8
- * table keyed by WOF polygon id; this source queries them ON DEMAND by id (one indexed lookup,
9
- * memoized) rather than paging the whole table into memory as a code constant — the deliberate
10
- * counter to the Pelias "giant dictionary in RAM, no provenance" pattern (see the operator design
11
- * value in memory `feedback-no-irrelevant-trivia`).
12
- *
13
- * The asset is the queryable, distributable artifact; the strategy IMPLEMENTATIONS stay in code. An
14
- * unknown strategy NAME is surfaced loudly at dispatch (see `lookup.ts`), not silently
15
- * swallowed.
16
- */
17
-
18
- import { tryParsingJSON } from "@mailwoman/core/json"
19
- import type { DatabaseClient } from "@mailwoman/sqlite/client"
20
-
21
- import { ADDRESS_CONVENTION_TABLE, type Convention, type ConventionSource } from "#convention/index"
22
-
23
- export class SqliteConventionSource<DB> implements ConventionSource {
24
- readonly #db: DatabaseClient<DB>
25
- readonly #schema: string
26
- /**
27
- * Memoize per-id lookups (including misses, as `null`) so a hot ancestor chain is queried once.
28
- */
29
- readonly #cache = new Map<number, Convention | null>()
30
-
31
- /**
32
- * @param db An open handle to a DB that has the convention asset attached (or is it).
33
- * @param schema The schema name the `address_convention` table lives under (`main` or an ATTACHed extract name —
34
- * `WOFSQLitePlaceLookup` auto-detects which extract carries the table).
35
- */
36
- constructor(db: DatabaseClient<DB>, schema: string) {
37
- this.#db = db
38
- this.#schema = schema
39
- }
40
-
41
- get(wofID: number): Convention | undefined {
42
- const cached = this.#cache.get(wofID)
43
-
44
- if (cached !== undefined) return cached ?? undefined
45
- let value: Convention | null = null
46
-
47
- try {
48
- const row = this.#db
49
- .prepare(`SELECT convention FROM ${this.#schema}.${ADDRESS_CONVENTION_TABLE} WHERE wof_id = ?`)
50
- .get(wofID) as { convention: string } | undefined
51
-
52
- if (row?.convention) {
53
- value = tryParsingJSON<Convention>(row.convention)
54
- }
55
- } catch {
56
- // A missing table → treat as no override (the chain falls back to WORLD_DEFAULT); malformed
57
- // JSON already nulls out above. The build script validates structure, so this is purely defensive.
58
- value = null
59
- }
60
-
61
- this.#cache.set(wofID, value)
62
-
63
- return value ?? undefined
64
- }
65
- }
@@ -1,82 +0,0 @@
1
- /**
2
- * @copyright Sister Software
3
- * @license AGPL-3.0
4
- * @author Teffen Ellis, et al.
5
- *
6
- * Small shared helpers for the SQLite-backed lookups.
7
- */
8
-
9
- import { allRows, getRow } from "@mailwoman/core/utils"
10
- import type { DatabaseClient, SQLInputValue } from "@mailwoman/sqlite/client"
11
- import { hasColumn as columnExists, tableExists } from "@mailwoman/sqlite/introspection"
12
-
13
- // The row-shape assertion itself lives in `core` so the readers that cannot depend on this package reach the same
14
- // helper; re-exported here because this module is where this package's readers already look for it.
15
-
16
- /**
17
- * A prepared single-row query whose parameter tuple remains visible to TypeScript. `StatementSync` accepts only the
18
- * broad `SQLInputValue[]`, which otherwise erases tagged key types before they reach SQLite.
19
- */
20
- export type PreparedGet<Parameters extends SQLInputValue[], Row> = (...parameters: Parameters) => Row | undefined
21
-
22
- /**
23
- * Prepare a single-row query while preserving its exact parameter tuple at every call site.
24
- */
25
- export function prepareGet<Parameters extends SQLInputValue[], Row, DB>(
26
- db: DatabaseClient<DB>,
27
- sql: string
28
- ): PreparedGet<Parameters, Row> {
29
- const statement = db.prepare(sql)
30
-
31
- return (...parameters) => getRow<Row>(statement, ...parameters)
32
- }
33
-
34
- /**
35
- * Multi-row counterpart to {@link PreparedGet}.
36
- */
37
- export type PreparedAll<Parameters extends SQLInputValue[], Row> = (...parameters: Parameters) => Row[]
38
-
39
- /**
40
- * Prepare a multi-row query while preserving its exact parameter tuple at every call site.
41
- */
42
- export function prepareAll<Parameters extends SQLInputValue[], Row, DB>(
43
- db: DatabaseClient<DB>,
44
- sql: string
45
- ): PreparedAll<Parameters, Row> {
46
- const statement = db.prepare(sql)
47
-
48
- return (...parameters) => allRows<Row>(statement, ...parameters)
49
- }
50
-
51
- /**
52
- * True when `name` is a table in the open database. The street-level lookups use this to degrade gracefully on an
53
- * empty/tableless extract — an interrupted `build-*-extract.ts`, or a stray 0-byte file (e.g. `sqlite3 <missing>.db
54
- * "…"` CREATES one) — rather than throwing `no such table` at construction and taking down a whole state's geocode
55
- * (#568). A missing table makes the lookup a no-op miss.
56
- */
57
- export function hasTable<DB>(db: DatabaseClient<DB>, name: string): boolean {
58
- try {
59
- return tableExists(db, name)
60
- } catch {
61
- return false
62
- }
63
- }
64
-
65
- /**
66
- * True when `table` exists in the open database AND carries `column`.
67
- *
68
- * The column-level sibling of {@link hasTable}, and it exists for the same reason one layer down: an artifact built
69
- * before a column was added is still a VALID artifact, and a reader that unconditionally names the new column in its
70
- * `SELECT` turns "this gazetteer is a build behind" into `no such column` at the first keystroke. Probe once at
71
- * construction and shape the query — `table_info` is a PRAGMA, so it must not sit on a per-query path.
72
- *
73
- * Note the interpolation: PRAGMA does not take bound parameters, so `table` is spliced. Every caller passes a
74
- * module-level constant; never pass user input.
75
- */
76
- export function hasColumn<DB>(db: DatabaseClient<DB>, table: string, column: string): boolean {
77
- try {
78
- return columnExists(db, table, column)
79
- } catch {
80
- return false
81
- }
82
- }