@mailwoman/resolver-wof-sqlite 10.0.0 → 10.2.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 (477) hide show
  1. package/README.md +9 -8
  2. package/lib/address/point/interpolation.ts +45 -39
  3. package/lib/address/point/schema.ts +17 -40
  4. package/lib/address/point.ts +316 -0
  5. package/lib/{address/index.ts → address.ts} +1 -1
  6. package/lib/ancestry/backfill.ts +20 -86
  7. package/lib/{ancestry/index.ts → ancestry.ts} +19 -15
  8. package/lib/build/candidate.ts +122 -174
  9. package/lib/build/population-corrections.ts +64 -0
  10. package/lib/build/slim.ts +44 -114
  11. package/lib/candidate/alias-bags.ts +16 -17
  12. package/lib/candidate/ancestors/schema.ts +77 -61
  13. package/lib/candidate/ancestors/sidecar.ts +15 -22
  14. package/lib/candidate/country-display-names.ts +6 -20
  15. package/lib/candidate/extract-fold.ts +10 -55
  16. package/lib/candidate/fts.ts +5 -23
  17. package/lib/candidate/importance.ts +65 -68
  18. package/lib/candidate/lookup.ts +124 -415
  19. package/lib/candidate/name-roles.ts +15 -33
  20. package/lib/candidate/own-name.ts +35 -32
  21. package/lib/candidate/place-attrs.ts +20 -13
  22. package/lib/candidate/schema.ts +29 -65
  23. package/lib/candidate/scoring.ts +54 -93
  24. package/lib/capital-schema.ts +21 -17
  25. package/lib/capitals.ts +29 -27
  26. package/lib/coincident-roles.ts +85 -55
  27. package/lib/convention/schema.ts +15 -16
  28. package/lib/convention.ts +144 -0
  29. package/lib/coverage-manifest-schema.ts +40 -45
  30. package/lib/currency-backfill.ts +34 -79
  31. package/lib/env.ts +1 -1
  32. package/lib/exact-match.ts +32 -21
  33. package/lib/extracts.ts +97 -74
  34. package/lib/fst/autocomplete.ts +54 -37
  35. package/lib/fst/builder.ts +37 -41
  36. package/lib/fst/deserialize-web.ts +16 -17
  37. package/lib/fst/format.ts +41 -23
  38. package/lib/fst/freshness.ts +43 -120
  39. package/lib/fst/matcher.ts +7 -5
  40. package/lib/fst/serialize.ts +54 -74
  41. package/lib/fst/types.ts +78 -75
  42. package/lib/{fst/index.ts → fst.ts} +1 -0
  43. package/lib/fts/query.ts +5 -36
  44. package/lib/fts.ts +280 -0
  45. package/lib/geonames/aliases.ts +73 -144
  46. package/lib/geonames/postal.ts +162 -71
  47. package/lib/index.ts +9 -8
  48. package/lib/interpolation.ts +48 -100
  49. package/lib/lookup.ts +155 -270
  50. package/lib/name-score.ts +9 -7
  51. package/lib/nsul/lookup.ts +37 -54
  52. package/lib/nsul/schema.ts +16 -43
  53. package/lib/paths.ts +159 -0
  54. package/lib/place-importance-schema.ts +62 -169
  55. package/lib/poi/lookup.ts +104 -121
  56. package/lib/poi/schema.ts +42 -26
  57. package/lib/polygon-schema.ts +10 -6
  58. package/lib/postal/city/alias/lookup.ts +22 -40
  59. package/lib/postal/city/alias/schema.ts +14 -10
  60. package/lib/postal/city/candidate-schema.ts +26 -20
  61. package/lib/postcode-point-lookup.ts +8 -27
  62. package/lib/primary-preference.ts +46 -126
  63. package/lib/proximity-rerank.ts +44 -33
  64. package/lib/ranking-weights.ts +105 -78
  65. package/lib/region-keys.ts +70 -42
  66. package/lib/reverse.ts +149 -86
  67. package/lib/schema.ts +73 -50
  68. package/lib/search-fetch.ts +90 -68
  69. package/lib/sqlite/convention-source.ts +15 -23
  70. package/lib/sqlite/utils.ts +19 -22
  71. package/lib/street/centroid/schema.ts +37 -42
  72. package/lib/street/{centroid/index.ts → centroid.ts} +16 -25
  73. package/lib/street/morphology/fst/builder.ts +60 -42
  74. package/lib/street/morphology/fst/loader.ts +40 -32
  75. package/lib/street/name-lookup.ts +45 -41
  76. package/lib/street/normalize.ts +88 -219
  77. package/lib/street/segment-schema.ts +116 -43
  78. package/lib/{street/index.ts → street.ts} +1 -1
  79. package/lib/types.ts +109 -150
  80. package/lib/unified-schema.ts +29 -29
  81. package/lib/uprn/existence.ts +30 -19
  82. package/lib/uprn/lookup.ts +29 -68
  83. package/lib/uprn/schema.ts +18 -40
  84. package/lib/weights-overlay-linker.ts +236 -252
  85. package/out/address/point/interpolation.d.ts +20 -23
  86. package/out/address/point/interpolation.d.ts.map +1 -1
  87. package/out/address/point/interpolation.js +42 -39
  88. package/out/address/point/interpolation.js.map +1 -1
  89. package/out/address/point/schema.d.ts +12 -35
  90. package/out/address/point/schema.d.ts.map +1 -1
  91. package/out/address/point/schema.js +3 -19
  92. package/out/address/point/schema.js.map +1 -1
  93. package/out/address/point.d.ts +57 -0
  94. package/out/address/point.d.ts.map +1 -0
  95. package/out/address/point.js +206 -0
  96. package/out/address/point.js.map +1 -0
  97. package/out/{address/index.js → address.d.ts} +2 -2
  98. package/out/address.d.ts.map +1 -0
  99. package/out/{address/index.d.ts → address.js} +2 -2
  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 +14 -74
  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 +82 -112
  110. package/out/build/candidate.d.ts.map +1 -1
  111. package/out/build/candidate.js +17 -100
  112. package/out/build/candidate.js.map +1 -1
  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 +8 -44
  118. package/out/build/slim.d.ts.map +1 -1
  119. package/out/build/slim.js +33 -94
  120. package/out/build/slim.js.map +1 -1
  121. package/out/candidate/alias-bags.d.ts +6 -6
  122. package/out/candidate/alias-bags.d.ts.map +1 -1
  123. package/out/candidate/alias-bags.js +16 -17
  124. package/out/candidate/alias-bags.js.map +1 -1
  125. package/out/candidate/ancestors/schema.d.ts +73 -57
  126. package/out/candidate/ancestors/schema.d.ts.map +1 -1
  127. package/out/candidate/ancestors/schema.js +56 -48
  128. package/out/candidate/ancestors/schema.js.map +1 -1
  129. package/out/candidate/ancestors/sidecar.d.ts +3 -8
  130. package/out/candidate/ancestors/sidecar.d.ts.map +1 -1
  131. package/out/candidate/ancestors/sidecar.js +15 -22
  132. package/out/candidate/ancestors/sidecar.js.map +1 -1
  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 +7 -15
  138. package/out/candidate/extract-fold.d.ts.map +1 -1
  139. package/out/candidate/extract-fold.js +5 -47
  140. package/out/candidate/extract-fold.js.map +1 -1
  141. package/out/candidate/fts.d.ts +5 -23
  142. package/out/candidate/fts.d.ts.map +1 -1
  143. package/out/candidate/fts.js +5 -23
  144. package/out/candidate/fts.js.map +1 -1
  145. package/out/candidate/importance.d.ts +60 -65
  146. package/out/candidate/importance.d.ts.map +1 -1
  147. package/out/candidate/importance.js +56 -63
  148. package/out/candidate/importance.js.map +1 -1
  149. package/out/candidate/lookup.d.ts +18 -55
  150. package/out/candidate/lookup.d.ts.map +1 -1
  151. package/out/candidate/lookup.js +82 -385
  152. package/out/candidate/lookup.js.map +1 -1
  153. package/out/candidate/name-roles.d.ts +9 -21
  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 +35 -32
  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 +27 -62
  166. package/out/candidate/schema.d.ts.map +1 -1
  167. package/out/candidate/schema.js +10 -22
  168. package/out/candidate/schema.js.map +1 -1
  169. package/out/candidate/scoring.d.ts +7 -8
  170. package/out/candidate/scoring.d.ts.map +1 -1
  171. package/out/candidate/scoring.js +52 -89
  172. package/out/candidate/scoring.js.map +1 -1
  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 +27 -25
  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 +72 -50
  184. package/out/coincident-roles.js.map +1 -1
  185. package/out/convention/schema.d.ts +14 -14
  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 +34 -39
  194. package/out/coverage-manifest-schema.d.ts.map +1 -1
  195. package/out/coverage-manifest-schema.js +25 -34
  196. package/out/coverage-manifest-schema.js.map +1 -1
  197. package/out/currency-backfill.d.ts +16 -38
  198. package/out/currency-backfill.d.ts.map +1 -1
  199. package/out/currency-backfill.js +19 -46
  200. package/out/currency-backfill.js.map +1 -1
  201. package/out/env.d.ts +1 -1
  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 +32 -21
  206. package/out/exact-match.js.map +1 -1
  207. package/out/extracts.d.ts +66 -55
  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 +29 -21
  212. package/out/fst/autocomplete.d.ts.map +1 -1
  213. package/out/fst/autocomplete.js +39 -28
  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 +37 -41
  217. package/out/fst/builder.js.map +1 -1
  218. package/out/fst/deserialize-web.d.ts +4 -4
  219. package/out/fst/deserialize-web.d.ts.map +1 -1
  220. package/out/fst/deserialize-web.js +15 -16
  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 +19 -81
  227. package/out/fst/freshness.d.ts.map +1 -1
  228. package/out/fst/freshness.js +31 -94
  229. package/out/fst/freshness.js.map +1 -1
  230. package/out/fst/matcher.d.ts +5 -4
  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 +28 -28
  235. package/out/fst/serialize.d.ts.map +1 -1
  236. package/out/fst/serialize.js +53 -71
  237. package/out/fst/serialize.js.map +1 -1
  238. package/out/fst/types.d.ts +78 -74
  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} +2 -1
  243. package/out/fst.d.ts.map +1 -0
  244. package/out/{fst/index.d.ts → fst.js} +2 -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 -62
  255. package/out/geonames/aliases.d.ts.map +1 -1
  256. package/out/geonames/aliases.js +45 -117
  257. package/out/geonames/aliases.js.map +1 -1
  258. package/out/geonames/postal.d.ts +84 -44
  259. package/out/geonames/postal.d.ts.map +1 -1
  260. package/out/geonames/postal.js +115 -73
  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 +9 -8
  267. package/out/index.d.ts.map +1 -1
  268. package/out/index.js +6 -5
  269. package/out/index.js.map +1 -1
  270. package/out/interpolation.d.ts +18 -55
  271. package/out/interpolation.d.ts.map +1 -1
  272. package/out/interpolation.js +27 -69
  273. package/out/interpolation.js.map +1 -1
  274. package/out/lookup.d.ts +23 -51
  275. package/out/lookup.d.ts.map +1 -1
  276. package/out/lookup.js +136 -234
  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 +51 -143
  299. package/out/place-importance-schema.d.ts.map +1 -1
  300. package/out/place-importance-schema.js +28 -143
  301. package/out/place-importance-schema.js.map +1 -1
  302. package/out/poi/lookup.d.ts +40 -47
  303. package/out/poi/lookup.d.ts.map +1 -1
  304. package/out/poi/lookup.js +69 -96
  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 +20 -23
  319. package/out/postal/city/alias/lookup.d.ts.map +1 -1
  320. package/out/postal/city/alias/lookup.js +17 -30
  321. package/out/postal/city/alias/lookup.js.map +1 -1
  322. package/out/postal/city/alias/schema.d.ts +14 -10
  323. package/out/postal/city/alias/schema.d.ts.map +1 -1
  324. package/out/postal/city/alias/schema.js +10 -8
  325. package/out/postal/city/alias/schema.js.map +1 -1
  326. package/out/postal/city/candidate-schema.d.ts +25 -19
  327. package/out/postal/city/candidate-schema.d.ts.map +1 -1
  328. package/out/postal/city/candidate-schema.js +21 -17
  329. package/out/postal/city/candidate-schema.js.map +1 -1
  330. package/out/{postal/index.d.ts → postal.d.ts} +1 -1
  331. package/out/postal.d.ts.map +1 -0
  332. package/out/{postal/index.js → postal.js} +1 -1
  333. package/out/postal.js.map +1 -0
  334. package/out/postcode-point-lookup.d.ts +6 -24
  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 +38 -92
  339. package/out/primary-preference.d.ts.map +1 -1
  340. package/out/primary-preference.js +15 -99
  341. package/out/primary-preference.js.map +1 -1
  342. package/out/proximity-rerank.d.ts +41 -30
  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 +98 -64
  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 +50 -31
  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 +78 -50
  355. package/out/reverse.d.ts.map +1 -1
  356. package/out/reverse.js +98 -61
  357. package/out/reverse.js.map +1 -1
  358. package/out/schema.d.ts +72 -49
  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 +12 -16
  367. package/out/sqlite/convention-source.d.ts.map +1 -1
  368. package/out/sqlite/convention-source.js +13 -22
  369. package/out/sqlite/convention-source.js.map +1 -1
  370. package/out/sqlite/utils.d.ts +19 -19
  371. package/out/sqlite/utils.d.ts.map +1 -1
  372. package/out/sqlite/utils.js +14 -15
  373. package/out/sqlite/utils.js.map +1 -1
  374. package/out/street/centroid/schema.d.ts +37 -42
  375. package/out/street/centroid/schema.d.ts.map +1 -1
  376. package/out/street/centroid/schema.js +9 -21
  377. package/out/street/centroid/schema.js.map +1 -1
  378. package/out/street/centroid.d.ts +30 -0
  379. package/out/street/centroid.d.ts.map +1 -0
  380. package/out/street/{centroid/index.js → centroid.js} +13 -24
  381. package/out/street/centroid.js.map +1 -0
  382. package/out/street/morphology/fst/builder.d.ts +20 -10
  383. package/out/street/morphology/fst/builder.d.ts.map +1 -1
  384. package/out/street/morphology/fst/builder.js +44 -34
  385. package/out/street/morphology/fst/builder.js.map +1 -1
  386. package/out/street/morphology/fst/loader.d.ts +33 -26
  387. package/out/street/morphology/fst/loader.d.ts.map +1 -1
  388. package/out/street/morphology/fst/loader.js +23 -22
  389. package/out/street/morphology/fst/loader.js.map +1 -1
  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 +34 -35
  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 +77 -194
  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.js → street.d.ts} +2 -2
  403. package/out/street.d.ts.map +1 -0
  404. package/out/{street/index.d.ts → street.js} +2 -2
  405. package/out/street.js.map +1 -0
  406. package/out/types.d.ts +84 -149
  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 +21 -57
  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 +138 -144
  431. package/out/weights-overlay-linker.d.ts.map +1 -1
  432. package/out/weights-overlay-linker.js +105 -159
  433. package/out/weights-overlay-linker.js.map +1 -1
  434. package/package.json +91 -596
  435. package/lib/address/point/index.ts +0 -328
  436. package/lib/convention/index.ts +0 -154
  437. package/lib/fts/index.ts +0 -361
  438. package/out/address/index.d.ts.map +0 -1
  439. package/out/address/index.js.map +0 -1
  440. package/out/address/point/index.d.ts +0 -53
  441. package/out/address/point/index.d.ts.map +0 -1
  442. package/out/address/point/index.js +0 -222
  443. package/out/address/point/index.js.map +0 -1
  444. package/out/ancestry/index.d.ts +0 -45
  445. package/out/ancestry/index.d.ts.map +0 -1
  446. package/out/ancestry/index.js +0 -55
  447. package/out/ancestry/index.js.map +0 -1
  448. package/out/convention/index.d.ts +0 -106
  449. package/out/convention/index.d.ts.map +0 -1
  450. package/out/convention/index.js +0 -93
  451. package/out/convention/index.js.map +0 -1
  452. package/out/fst/index.d.ts.map +0 -1
  453. package/out/fst/index.js.map +0 -1
  454. package/out/fts/index.d.ts +0 -184
  455. package/out/fts/index.d.ts.map +0 -1
  456. package/out/fts/index.js +0 -277
  457. package/out/fts/index.js.map +0 -1
  458. package/out/geonames/index.d.ts.map +0 -1
  459. package/out/geonames/index.js.map +0 -1
  460. package/out/nsul/index.d.ts.map +0 -1
  461. package/out/nsul/index.js.map +0 -1
  462. package/out/poi/index.d.ts.map +0 -1
  463. package/out/poi/index.js.map +0 -1
  464. package/out/postal/index.d.ts.map +0 -1
  465. package/out/postal/index.js.map +0 -1
  466. package/out/street/centroid/index.d.ts +0 -40
  467. package/out/street/centroid/index.d.ts.map +0 -1
  468. package/out/street/centroid/index.js.map +0 -1
  469. package/out/street/index.d.ts.map +0 -1
  470. package/out/street/index.js.map +0 -1
  471. package/out/uprn/index.d.ts.map +0 -1
  472. package/out/uprn/index.js.map +0 -1
  473. /package/lib/{geonames/index.ts → geonames.ts} +0 -0
  474. /package/lib/{nsul/index.ts → nsul.ts} +0 -0
  475. /package/lib/{poi/index.ts → poi.ts} +0 -0
  476. /package/lib/{postal/index.ts → postal.ts} +0 -0
  477. /package/lib/{uprn/index.ts → uprn.ts} +0 -0
@@ -3,17 +3,14 @@
3
3
  * @license AGPL-3.0
4
4
  * @author Teffen Ellis, et al.
5
5
  *
6
- * Pass 1c of the candidate build (#1737): resurrect deprecated-with-no-successor WOF localities that a second
7
- * source independently attests. Extracted from `build-candidate.ts` as a cohesive unit — the checks, their measured
8
- * constants, and the GeoNames dump reader live together here; the build calls {@link resurrectCurrencyHoles} once,
9
- * between the primaries pass and the alias pass.
6
+ * Restores deprecated WOF localities only when an independent source attests them.
10
7
  */
11
8
 
12
- import { pathExists } from "@mailwoman/core/fs/readers"
9
+ import { pathExists } from "@mailwoman/core/fs/readers/stat"
13
10
  import { isStrictlyFiner } from "@mailwoman/core/resources/whosonfirst"
14
11
  import { haversineKm } from "@mailwoman/spatial"
15
12
  import type { DatabaseClient } from "@mailwoman/sqlite/client"
16
- import { resolvePath } from "path-ts"
13
+ import { type PathBuilderLike, resolvePath } from "path-ts"
17
14
  import { TSVSpliterator } from "spliterator"
18
15
 
19
16
  import type { loadImportanceIndex } from "#candidate/importance"
@@ -22,42 +19,15 @@ import type { CandidateDatabase } from "#candidate/schema"
22
19
  import type { WOFDatabase } from "#schema"
23
20
  import { normalizeLocalityForKey } from "#street/normalize"
24
21
 
25
- /**
26
- * Corroboration radius for the currency backfill (#1737), km — both for the live-near blocker and the GeoNames
27
- * attestation. Measured basis (2026-08-19 prototype, GB locality slice): at 10 km, 20 of 108 dead names resurrect —
28
- * Rochester (Kent), Aldershot, Staines, Telford, Ebbw Vale among them — while the `Birmingham/Wolverhampton/…`
29
- * conurbation blobs stay dead (no attestation) and Swansea/Wrexham stay out because a live same-name row already serves
30
- * them within the radius.
31
- */
32
22
  const CURRENCY_BACKFILL_RADIUS_KM = 10
33
23
 
34
- /**
35
- * Minimum attestor population for a resurrection. The same prototype measured 44 of 108 dead GB names attested but
36
- * under this floor — hamlet-scale ghosts whose absence from the index nobody has reported. A floor keeps the pass
37
- * answering the measured defect (real settlements) rather than re-importing the tail WOF chose to prune.
38
- */
39
24
  const CURRENCY_BACKFILL_POP_FLOOR = 1000
40
25
 
41
26
  /**
42
- * Pass 1c (#1737): resurrect deprecated-with-no-successor localities that a second source independently attests.
43
- *
44
- * WOF deprecations WITH a successor need nothing — the successor indexes. A deprecation with `is_superseded = 0` on a
45
- * populated place is the shape of an upstream mistake (Rochester Kent, Aldershot, Telford; 120 GB localities alone),
46
- * and it is indistinguishable from a correct pruning at this layer without outside evidence. So every resurrection
47
- * requires all three conditions, positive evidence only:
48
- *
49
- * 1. NO live same-name spr row of any placetype within {@link CURRENCY_BACKFILL_RADIUS_KM} of the dead record — a live row
50
- * means the place is alive (possibly under another placetype) and there is no hole. A DISTANT same-name row is a
51
- * namesake and does not block.
52
- * 2. A GeoNames feature-class-P attestation of the same folded name within the radius.
53
- * 3. The attestor at or above {@link CURRENCY_BACKFILL_POP_FLOOR}.
54
- *
55
- * The staged row keeps the WOF identity — id, name, centroid, bbox, region ancestry — because the dead record's own
56
- * data is not what is wrong with it. GeoNames contributes exactly two things: the attestation, and the population that
57
- * lets the row stand in prominence races (the dead record's own population is absent). Each name is judged once per
58
- * country; the resurrected place joins `attrs`, so the alias pass explodes its alt names like any primary's.
27
+ * Restore a deprecated locality only when no nearby live namesake exists and GeoNames
28
+ * attests the same folded name above {@link CURRENCY_BACKFILL_POP_FLOOR}.
59
29
  */
60
- export interface CurrencyBackfillOutcomes {
30
+ export interface CurrencyBackfillResults {
61
31
  judged: number
62
32
  blocked: number
63
33
  unattested: number
@@ -66,17 +36,16 @@ export interface CurrencyBackfillOutcomes {
66
36
  }
67
37
 
68
38
  /**
69
- * One country's read of the check — every dead name judged, by outcome and by the dead row's placetype — so a census
70
- * can say what a wider dead-row query admits before a build carries it.
39
+ * One country's read of the check — every dead name judged, by result and by the dead
40
+ * row's placetype — so a census can say what a wider query admits.
71
41
  */
72
- export interface CurrencyBackfillCountryReport extends CurrencyBackfillOutcomes {
42
+ export interface CurrencyBackfillCountryReport extends CurrencyBackfillResults {
73
43
  country: string
74
44
  deadPlacetypes: readonly string[]
75
45
  dumpPresent: boolean
76
- byDeadPlacetype: Record<string, CurrencyBackfillOutcomes>
46
+ byDeadPlacetype: Record<string, CurrencyBackfillResults>
77
47
  /**
78
- * The first resurrected names, `placetype:name`, so a census reads what a wider query admits — capped, because the
79
- * report is a receipt and not the table.
48
+ * The first resurrected names, `placetype:name`, capped because the report is a receipt and not the table.
80
49
  */
81
50
  sample: string[]
82
51
  }
@@ -84,40 +53,37 @@ export interface CurrencyBackfillCountryReport extends CurrencyBackfillOutcomes
84
53
  const REPORT_SAMPLE_SIZE = 25
85
54
 
86
55
  /**
87
- * The placetypes a dead row may carry to be judged at all. `locality` is the shipped default; `localadmin` is the
88
- * second cause #1746 named (one GB row of seventeen) and is admitted through this option once its census is read.
56
+ * The placetypes a dead row may have to be judged at all; `locality` is the shipped default.
89
57
  */
90
58
  export const DEFAULT_DEAD_PLACETYPES: readonly string[] = ["locality"]
91
59
 
92
- function emptyOutcomes(): CurrencyBackfillOutcomes {
60
+ function emptyResults(): CurrencyBackfillResults {
93
61
  return { judged: 0, blocked: 0, unattested: 0, floored: 0, resurrected: 0 }
94
62
  }
95
63
 
96
64
  export async function resurrectCurrencyHoles(ctx: {
97
65
  src: DatabaseClient<WOFDatabase>
98
66
  /**
99
- * The candidate build's transaction. Required unless `dryRun` — a dry run judges every row and stages nothing.
67
+ * The candidate build's transaction, required unless `dryRun`.
100
68
  */
101
69
  tx?: DatabaseClient<CandidateDatabase>
102
- geonamesDir: string
70
+ geonamesDir: PathBuilderLike
103
71
  countries: readonly string[]
104
72
  attrs: Map<number, PlaceAttrs>
105
73
  ccID: (code: string | null) => number
106
74
  ptID: (pt: string | null) => number
107
75
  regionOf: Map<number, number>
108
- importance: ReturnType<typeof loadImportanceIndex> | undefined
76
+ importance: ReturnType<typeof loadImportanceIndex> | null
109
77
  stageRow: StageRow
110
78
  progress: (phase: string, message: string) => void
111
- /**
112
- * Which dead placetypes are judged. Default {@link DEFAULT_DEAD_PLACETYPES}.
113
- */
79
+
114
80
  deadPlacetypes?: readonly string[]
115
81
  /**
116
- * Judge and count, stage nothing — the census mode. No transaction is opened.
82
+ * Judge and count while staging no row and opening no transaction.
117
83
  */
118
84
  dryRun?: boolean
119
85
  /**
120
- * Receives one report per country judged (a country with no dump or no dead rows reports zero outcomes).
86
+ * Receives one report per country judged (a country with no dump or no dead rows reports zero results).
121
87
  */
122
88
  onCountry?: (report: CurrencyBackfillCountryReport) => void
123
89
  }): Promise<number> {
@@ -151,7 +117,7 @@ export async function resurrectCurrencyHoles(ctx: {
151
117
  country: cc,
152
118
  deadPlacetypes,
153
119
  dumpPresent: await pathExists(dumpPath),
154
- ...emptyOutcomes(),
120
+ ...emptyResults(),
155
121
  byDeadPlacetype: {},
156
122
  sample: [],
157
123
  }
@@ -163,9 +129,9 @@ export async function resurrectCurrencyHoles(ctx: {
163
129
  continue
164
130
  }
165
131
 
166
- // Dead rows FIRST: a country with no deprecated-no-successor localities needs no attestors at all, and
167
- // loading a national dump to judge zero rows is pure heap pressure on a build already near its ceiling
168
- // (the first live run OOM'd in a later pass with JP/KR dumps loaded for 0 dead names each).
132
+ // Read dead rows first.
133
+ // A country with no dead names then avoids loading its national dump.
134
+ // That avoids heap pressure on a build near its limit.
169
135
  const dead = deadStmt.all(cc, ...deadPlacetypes)
170
136
 
171
137
  if (!dead.length) {
@@ -175,8 +141,8 @@ export async function resurrectCurrencyHoles(ctx: {
175
141
  continue
176
142
  }
177
143
 
178
- // Only the dead names' own folded keys can ever be probed, so only those keys are worth holding —
179
- // the rest of the national dump streams through without residency.
144
+ // Only the dead names' own folded keys can ever be probed, so the rest of the
145
+ // national dump streams through without residency.
180
146
  const deadKeys = new Set<string>()
181
147
 
182
148
  for (const d of dead) {
@@ -187,8 +153,7 @@ export async function resurrectCurrencyHoles(ctx: {
187
153
  }
188
154
  }
189
155
 
190
- // Folded name → P-class attestors. GeoNames columns by index: 1 name, 2 ascii, 4 lat, 5 lon,
191
- // 6 feature_class, 14 population.
156
+ // GeoNames columns by index: 1 name, 2 ascii, 4 lat, 5 lon, 6 feature_class, 14 population.
192
157
  const attestors = new Map<string, { lat: number; lon: number; pop: number }[]>()
193
158
 
194
159
  for await (const f of TSVSpliterator.fromAsync(dumpPath, { header: false })) {
@@ -215,11 +180,11 @@ export async function resurrectCurrencyHoles(ctx: {
215
180
 
216
181
  const seen = new Set<string>()
217
182
 
218
- const count = (deadPlacetype: string, outcome: keyof CurrencyBackfillOutcomes): void => {
219
- report[outcome] += 1
220
- const bucket = (report.byDeadPlacetype[deadPlacetype] ??= emptyOutcomes())
183
+ const count = (deadPlacetype: string, result: keyof CurrencyBackfillResults): void => {
184
+ report[result] += 1
185
+ const bucket = (report.byDeadPlacetype[deadPlacetype] ??= emptyResults())
221
186
 
222
- bucket[outcome] += 1
187
+ bucket[result] += 1
223
188
  }
224
189
 
225
190
  if (!dryRun) {
@@ -232,31 +197,21 @@ export async function resurrectCurrencyHoles(ctx: {
232
197
 
233
198
  if (!pkey || seen.has(pkey)) continue
234
199
  seen.add(pkey)
235
- // Read from the row: the query admits whatever `deadPlacetypes` names, and the rank comparison below must
236
- // judge each candidate against ITS dead rung, never a hardcoded one.
200
+ // The query admits whatever `deadPlacetypes` names, so the rank comparison
201
+ // judges each candidate against its own dead rung.
237
202
  const deadPlacetype = String(d.placetype ?? "locality")
238
203
 
239
204
  count(deadPlacetype, "judged")
240
205
  const dLat = Number(d.latitude)
241
206
  const dLon = Number(d.longitude)
242
207
 
243
- // A live row blocks only when it is AT LEAST AS COARSE as the dead one. The original check compared name and
244
- // distance alone, on the premise that a nearby same-name row means "the place is alive under another
245
- // placetype" — true for a place recorded twice, false for a placetype DEMOTION, which is the shape that
246
- // actually occurs: WOF retired `Gillingham` the locality (pop 101,187) and kept `Gillingham` the
247
- // neighbourhood 3.2 km away, and the check read the surviving CHILD as covering its own dead parent.
248
- // Sixteen of seventeen GB refusals had exactly that shape (#1746).
249
- //
250
- // An UNRANKED placetype blocks, which is the conservative direction: this check's failure mode is inventing
251
- // a place, so a row we cannot rank is treated as covering rather than waved through.
208
+ // A live row blocks unless it is strictly finer than the dead one.
209
+ // An unranked placetype also blocks because the failure mode is inventing a place.
252
210
  const liveNear = liveStmt.all(cc, name).some((row) => {
253
211
  if (haversineKm(dLat, dLon, Number(row.latitude), Number(row.longitude)) > CURRENCY_BACKFILL_RADIUS_KM) {
254
212
  return false
255
213
  }
256
214
 
257
- // Blocks UNLESS the live row is strictly finer. The equal rung must still block — a live `locality`
258
- // covers a dead `locality` — and an unranked placetype blocks too, since this check's failure mode
259
- // is inventing a place.
260
215
  return isStrictlyFiner(String(row.placetype ?? ""), deadPlacetype) !== true
261
216
  })
262
217
 
package/lib/env.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  * @license AGPL-3.0
4
4
  * @author Teffen Ellis, et al.
5
5
  *
6
- * Environment variables naming the WOF SQLite artifacts this resolver opens, and the development weights the overlay
6
+ * Environment variables name the WOF SQLite artifacts this resolver opens and the development weights the overlay
7
7
  * linker materializes. CLI flags (`--resolve-db`, …) override these at the call site.
8
8
  */
9
9
 
@@ -3,20 +3,25 @@
3
3
  * @license AGPL-3.0
4
4
  * @author Teffen Ellis, et al.
5
5
  *
6
- * The exact-match tier's name probes — the two case-folded equality lookups that decide whether a
6
+ * The exact-match tier's name probes, the two case-folded equality lookups that decide whether a
7
7
  * candidate holds the query text as its own name, an alias, or an official name.
8
8
  */
9
9
 
10
10
  import type { DatabaseClient } from "@mailwoman/sqlite/client"
11
11
 
12
- import { aliasBagExactMatch, foldQueryText } from "#fts/index"
12
+ import { aliasBagExactMatch, foldQueryText } from "#fts"
13
13
 
14
14
  /**
15
- * Among `ids`, return the subset whose name OR any alias equals `text` case-insensitively — the exact-match tier for
16
- * ranking. One indexed query over `<schema>.names`. When the extract has no `names` table (a slim DB built with
17
- * `dropNames`, or a postcode-only extract), fall back to the self-contained `place_search` FTS content: its `alt_names`
18
- * column is the same alias set joined on the boundary-preserving `ALIAS_SEPARATOR` (#523), so `aliasBagExactMatch`
19
- * recovers the exact alias tier ("New York City" → New York) that the dropped `names` table used to provide.
15
+ * Among `ids`, return the subset whose name or any alias equals `text` case-insensitively,
16
+ * the exact-match tier for ranking.
17
+ *
18
+ * One indexed query over `<schema>.names`.
19
+ * When the extract has no `names` table (a slim database built with `dropNames`, or a postcode-only extract),
20
+ * fall back to the self-contained `place_search` FTS content.
21
+ *
22
+ * Its `alt_names` column is the same alias set joined on the boundary-preserving
23
+ * `ALIAS_SEPARATOR`, so `aliasBagExactMatch` recovers the exact alias tier
24
+ * ("New York City" → New York) that the dropped `names` table used to provide.
20
25
  */
21
26
  export function exactMatchIDs<DB>(
22
27
  db: DatabaseClient<DB>,
@@ -41,7 +46,8 @@ export function exactMatchIDs<DB>(
41
46
 
42
47
  return out
43
48
  } catch {
44
- // No `names` table on this extract — fall through to the place_search alias bag.
49
+ // No `names` table on this extract.
50
+ // Fall through to the place_search alias bag.
45
51
  }
46
52
 
47
53
  try {
@@ -52,17 +58,17 @@ export function exactMatchIDs<DB>(
52
58
  const needle = foldQueryText(trimmed)
53
59
 
54
60
  for (const r of rows) {
55
- if (r.name !== null && foldQueryText(r.name) === needle) {
61
+ if (r.name && foldQueryText(r.name) === needle) {
56
62
  out.add(r.id)
57
63
  }
58
64
  }
59
65
 
60
- // Alias pass via the shared bag parser (#523). Separated bags (built since #523) get a true
61
- // per-alias equality check, unrestricted — matching the `names`-table branch above, where an
62
- // alias match counts as exact regardless of other candidates. Legacy bags (no separator)
63
- // fall back to padded containment, conditioned on "no canonical exact in the pool" because their
64
- // lost boundaries would otherwise false-promote interior fragments ("York" inside the alias
65
- // "New York City") or cross-alias fragments ("York New" across "…York" + "New City…").
66
+ // Alias pass via the shared bag parser.
67
+ // Separated bags get a true per-alias equality check, unrestricted, matching the `names`-table
68
+ // branch above where an alias match counts as exact regardless of other candidates.
69
+ // Legacy bags without a separator fall back to padded containment, conditioned on "no
70
+ // canonical exact in the pool" because their lost boundaries would otherwise false-promote
71
+ // interior fragments ("York" inside the alias "New York City") or cross-alias fragments.
66
72
  const anyCanonicalExact = out.size > 0
67
73
 
68
74
  for (const r of rows) {
@@ -71,17 +77,22 @@ export function exactMatchIDs<DB>(
71
77
  }
72
78
  }
73
79
  } catch {
74
- // Extract without place_search either → no exact-match tier. Falls back to weighted-sum order.
80
+ // Extract without place_search either, so there is no exact-match tier.
81
+ // The caller falls back to weighted-sum order.
75
82
  }
76
83
 
77
84
  return out
78
85
  }
79
86
 
80
87
  /**
81
- * Among `ids` (already known exact matches), the subset holding `text` as an OFFICIAL name (`names.official = 1`, the
82
- * #940 ingest bit). Same COLLATE NOCASE semantics as {@link WOFSQLitePlaceLookup.#exactMatchIDs} so the two probes
83
- * agree on what "equals the query" means. Fails soft on gazetteers built before #940 (no `official` column) — the
84
- * sub-tier then behaves exactly as if `officialNameExact` were off.
88
+ * Among `ids` (already known exact matches), the subset holding `text` as an
89
+ * official name (`names.official = 1`, the ingest bit).
90
+ *
91
+ * Same collate nocase semantics as {@link WOFSQLitePlaceLookup.#exactMatchIDs},
92
+ * so the two probes agree on what "equals the query" means.
93
+ * Fails soft on gazetteers built before the `official` column existed.
94
+ *
95
+ * The sub-tier then behaves exactly as if `officialNameExact` were off.
85
96
  */
86
97
  export function officialNameIDs<DB>(
87
98
  db: DatabaseClient<DB>,
@@ -106,7 +117,7 @@ export function officialNameIDs<DB>(
106
117
  out.add(r.id)
107
118
  }
108
119
  } catch {
109
- // Pre-#940 gazetteer (no `official` column) or a names-less slim extract — feature inert.
120
+ // A gazetteer without the `official` column, or a names-less slim extract, leaves the feature inert.
110
121
  }
111
122
 
112
123
  return out
package/lib/extracts.ts CHANGED
@@ -1,36 +1,32 @@
1
- import { basename } from "path-ts"
1
+ import { stringifyJSON } from "@mailwoman/core/json"
2
+ import { basename, PathBuilder, type PathBuilderLike } from "path-ts"
2
3
 
3
4
  /**
4
5
  * @copyright Sister Software
5
6
  * @license AGPL-3.0
6
7
  * @author Teffen Ellis, et al.
7
8
  *
8
- * Multi-extract support for `WOFSQLitePlaceLookup` — opens multiple WOF SQLite distributions on one
9
- * connection via `ATTACH DATABASE`, and routes queries to the right extract based on placetype.
9
+ * Multi-extract support for `WOFSQLitePlaceLookup`. It opens multiple WOF SQLite distributions
10
+ * on one connection with `attach database`. It routes queries by placetype.
10
11
  *
11
- * ## The FTS5 syntax rule that drove this design
12
- *
13
- * The naive `SELECT … FROM pc.place_search WHERE pc.place_search MATCH ?` fails — SQLite parses the
14
- * schema-qualified table on the left of MATCH as "column place_search of table pc". Discovered in
15
- * the spike at PR review time; documented as `_EXTRACT_RULE.md` should it ever bite again.
16
- *
17
- * The working form: schema-qualified in FROM, bare table name in MATCH:
12
+ * SQLite parses a schema-qualified table on the left of `match` as "column place_search of table
13
+ * pc", so the working form is schema-qualified in `from` and a bare table name in `match`:
18
14
  *
19
15
  * ```sql
20
- * SELECT … FROM pc.place_search WHERE place_search MATCH ?
16
+ * select … from pc.place_search where place_search match ?
21
17
  * ```
22
18
  *
23
- * Identical table names across attached extracts (which is what we have — every extract ships its own
24
- * `place_search` + `place_bbox`) are fine because the bare-name MATCH resolves against FROM
25
- * scope.
19
+ * Identical table names across attached extracts are fine, because the bare-name `match` resolves
20
+ * against `from` scope. Every extract ships its own `place_search` and `place_bbox`.
26
21
  */
27
22
 
28
23
  /**
29
- * Derive a SQL-safe schema name from a WOF distribution filename. Used by `ATTACH DATABASE … AS <name>` so each extract
30
- * gets a stable, predictable handle.
24
+ * Derive a SQL-safe schema name from a WOF distribution filename.
31
25
  *
32
- * Convention strips the `whosonfirst-data-` prefix and the `-latest.db` (or just `.db`) suffix, then replaces `-` with
33
- * `_` for SQL identifier safety.
26
+ * Used by `attach database … AS <name>` so each extract gets a stable, predictable handle.
27
+ *
28
+ * Convention strips the `whosonfirst-data-` prefix and the `-latest.db` (or just `.db`)
29
+ * suffix, then replaces `-` with `_` for SQL identifier safety.
34
30
  *
35
31
  * Examples:
36
32
  *
@@ -39,46 +35,56 @@ import { basename } from "path-ts"
39
35
  * - `whosonfirst-data-admin-latest.db` → `admin`
40
36
  * - `my-custom.db` → `my_custom`
41
37
  *
42
- * Callers can override the derived name explicitly via `ExtractConfig.schemaName` when the filename doesn't follow WOF
43
- * convention.
38
+ * Callers can override the derived name explicitly via `ExtractConfig.schemaName`
39
+ * when the filename doesn't follow WOF convention.
44
40
  */
45
- export function deriveSchemaName(path: string): string {
46
- const stem = basename(path)
41
+ export function deriveSchemaName(path: PathBuilderLike): string {
42
+ const stem = basename(path.toString())
47
43
  .replace(/^whosonfirst-data-/u, "")
48
44
  .replace(/-latest\.db$/u, "")
49
45
  .replace(/\.db$/u, "")
50
46
  .replaceAll(/[^a-zA-Z0-9_]/g, "_")
51
47
 
52
48
  if (!stem) {
53
- throw new Error(`deriveSchemaName: could not derive a SQL schema name from path ${JSON.stringify(path)}`)
49
+ throw new Error(`deriveSchemaName: could not derive a SQL schema name from path ${stringifyJSON(path)}`)
54
50
  }
55
51
 
56
52
  return stem
57
53
  }
58
54
 
59
55
  /**
60
- * Per-extract configuration. The simple form is just a path string — the schema name is derived from it. The object
61
- * form lets callers override the derived schema name (useful when a filename doesn't follow WOF convention) or attach
62
- * an extra hint about which placetypes route here.
56
+ * Per-extract configuration.
57
+ *
58
+ * The simple form is just a path string.
59
+ * The schema name is derived from it.
60
+ *
61
+ * The object form lets callers override the derived schema name (useful when a filename
62
+ * doesn't follow WOF convention) or attach an extra hint about which placetypes route here.
63
63
  */
64
64
  export interface ExtractConfig {
65
- path: string
65
+ path: PathBuilderLike
66
66
  /**
67
- * Override the auto-derived schema name. Useful when the filename doesn't match WOF convention or when you want a
68
- * memorable handle. Must be a valid SQLite identifier — `[a-zA-Z_][a-zA-Z0-9_]*`.
67
+ * Override the auto-derived schema name.
68
+ *
69
+ * Useful when the filename does not match WOF convention or when you want a memorable handle.
70
+ * Must be a valid SQLite identifier matching `[a-zA-Z_][a-zA-Z0-9_]*`.
69
71
  */
70
72
  schemaName?: string
71
73
  /**
72
- * Optional explicit list of placetypes this extract serves. When set, queries against any listed placetype are routed
73
- * to this extract. When omitted, routing falls back to a name-match heuristic: a extract whose `schemaName` contains
74
- * the placetype as a substring (e.g. `postalcode_us` for `postalcode` queries) is preferred for that placetype.
74
+ * Optional explicit list of placetypes this extract serves.
75
+ *
76
+ * When set, queries against any listed placetype are routed to this extract.
77
+ * When omitted, routing falls back to a name-match heuristic: an extract whose `schemaName`
78
+ * contains the placetype as a substring (e.g. `postalcode_us` for `postalcode` queries)
79
+ * is preferred for that placetype.
75
80
  */
76
81
  placetypes?: readonly string[]
77
82
  }
78
83
 
79
84
  /**
80
- * Resolved post-derivation: paired path + chosen schema name + (possibly empty) placetypes hint. Used internally by
81
- * `WOFSQLitePlaceLookup` so the routing logic operates on uniform structures.
85
+ * Resolved post-derivation: paired path + chosen schema name + (possibly empty) placetypes hint.
86
+ *
87
+ * Used internally by `WOFSQLitePlaceLookup` so the routing logic operates on uniform structures.
82
88
  */
83
89
  export interface ResolvedExtract {
84
90
  path: string
@@ -87,19 +93,30 @@ export interface ResolvedExtract {
87
93
  }
88
94
 
89
95
  /**
90
- * SQLite identifier regex — `[A-Za-z_][A-Za-z0-9_]*`.
96
+ * SQLite identifier regex matching `[A-Za-z_][A-Za-z0-9_]*`.
91
97
  */
92
98
  const SQLITE_IDENT_RE = /^[A-Za-z_][A-Za-z0-9_]*$/u
93
99
 
94
100
  /**
95
- * Normalize the user-provided `databasePath` opt (which may be a single string, an array of strings, or an array of
96
- * `ExtractConfig` objects) into a uniform `ResolvedExtract[]`.
101
+ * Whether a `databasePath` entry is a path or an {@link ExtractConfig}.
97
102
  *
98
- * The first extract becomes `main` regardless of its derived schema name — that's the SQLite convention. Subsequent
99
- * extracts keep their derived (or override) schema name.
103
+ * A builder is a `String` object, so `typeof` by itself reads it as an object.
100
104
  */
101
- export function resolveExtracts(input: string | ReadonlyArray<string | ExtractConfig>): ResolvedExtract[] {
102
- const list = typeof input === "string" ? [input] : input
105
+ function isPathBuilderLike(value: unknown): value is PathBuilderLike {
106
+ return typeof value === "string" || value instanceof PathBuilder
107
+ }
108
+
109
+ /**
110
+ * Normalize the user-provided `databasePath` opt (which may be a single string, an array
111
+ * of strings, or an array of `ExtractConfig` objects) into a uniform `ResolvedExtract[]`.
112
+ *
113
+ * The first extract becomes `main` regardless of its derived schema name, following SQLite convention.
114
+ * Subsequent extracts keep their derived or overridden schema name.
115
+ */
116
+ export function resolveExtracts(
117
+ input: PathBuilderLike | ReadonlyArray<PathBuilderLike | ExtractConfig>
118
+ ): ResolvedExtract[] {
119
+ const list = isPathBuilderLike(input) ? [input] : input
103
120
 
104
121
  if (!list.length) throw new Error("resolveExtracts: at least one extract is required")
105
122
 
@@ -108,24 +125,25 @@ export function resolveExtracts(input: string | ReadonlyArray<string | ExtractCo
108
125
 
109
126
  for (let i = 0; i < list.length; i++) {
110
127
  const entry = list[i]!
111
- const cfg: ExtractConfig = typeof entry === "string" ? { path: entry } : entry
128
+ const cfg: ExtractConfig = isPathBuilderLike(entry) ? { path: entry } : entry
112
129
  const derived = cfg.schemaName ?? deriveSchemaName(cfg.path)
113
130
 
114
131
  if (!SQLITE_IDENT_RE.test(derived)) {
115
132
  throw new Error(
116
- `resolveExtracts: schema name ${JSON.stringify(derived)} is not a valid SQLite identifier ` +
117
- `(derived from path ${JSON.stringify(cfg.path)}). Pass an explicit ` +
133
+ `resolveExtracts: schema name ${stringifyJSON(derived)} is not a valid SQLite identifier ` +
134
+ `(derived from path ${stringifyJSON(cfg.path)}). Pass an explicit ` +
118
135
  `{ path, schemaName } to override.`
119
136
  )
120
137
  }
121
138
 
122
- // The first extract is always main per SQLite semantics — its derived name is informational
123
- // only. Subsequent extracts must have unique non-main names.
139
+ // SQLite always treats the first extract as main.
140
+ // Its derived name is informational only.
141
+ // Subsequent extracts must have unique non-main names.
124
142
  const schemaName = i === 0 ? "main" : derived
125
143
 
126
144
  if (i > 0 && (schemaName === "main" || seen.has(schemaName))) {
127
145
  throw new Error(
128
- `resolveExtracts: schema name ${JSON.stringify(schemaName)} collides ` +
146
+ `resolveExtracts: schema name ${stringifyJSON(schemaName)} collides ` +
129
147
  `(either with "main" or another extract). Pass an explicit { path, schemaName }.`
130
148
  )
131
149
  }
@@ -133,7 +151,7 @@ export function resolveExtracts(input: string | ReadonlyArray<string | ExtractCo
133
151
  seen.add(schemaName)
134
152
 
135
153
  out.push({
136
- path: cfg.path,
154
+ path: cfg.path.toString(),
137
155
  schemaName,
138
156
  placetypes: cfg.placetypes ?? [],
139
157
  })
@@ -143,24 +161,11 @@ export function resolveExtracts(input: string | ReadonlyArray<string | ExtractCo
143
161
  }
144
162
 
145
163
  /**
146
- * Pick the extract to route a query to given the requested placetype(s).
147
- *
148
- * Routing rules, in order:
164
+ * All placetype-matching extracts, in routing order (the country-aware pick chooses among these).
149
165
  *
150
- * 1. If any extract has explicit `placetypes` that includes the requested placetype, use it.
151
- * 2. Otherwise, if a non-main extract's `schemaName` matches the placetype (e.g. `postalcode_us` matches `postalcode`),
152
- * use it.
153
- * 3. Otherwise, fall back to `main`.
154
- *
155
- * This deliberately doesn't UNION across extracts — BM25 scores aren't comparable across separately- indexed corpora,
156
- * and the typical mailwoman query has a single placetype anyway. If a caller needs cross-extract results they can issue
157
- * two `findPlace` calls.
158
- */
159
- /**
160
- * All placetype-matching extracts, in routing order (the country-aware pick chooses among these). Used by the bias
161
- * path: a country-less postcode query with proximity hints fans out across every matching extract and merges, because
162
- * single-extract routing would hide the cross-country ambiguity the hints exist to resolve ("48026" lives in
163
- * postalcode-us AND postalcode-intl).
166
+ * Used by the bias path: a country-less postcode query with proximity hints fans out across
167
+ * every matching extract and merges, because single-extract routing would hide the cross-country
168
+ * ambiguity the hints exist to resolve ("48026" lives in postalcode-us and postalcode-intl).
164
169
  */
165
170
  export function pickExtractsForPlacetype(
166
171
  extracts: ResolvedExtract[],
@@ -190,16 +195,34 @@ export function pickExtractsForPlacetype(
190
195
  return matches.length ? matches : [extracts[0]!]
191
196
  }
192
197
 
198
+ /**
199
+ * Pick the extract to route a query to given the requested placetype(s).
200
+ *
201
+ * The resolver applies these routing rules in order:
202
+ *
203
+ * 1. If any extract has explicit `placetypes` that includes the requested placetype, use it.
204
+ * 2. Otherwise, if a non-main extract's `schemaName` matches the placetype
205
+ * (e.g. `postalcode_us` matches `postalcode`), use it.
206
+ * 3. Otherwise, fall back to `main`.
207
+ *
208
+ * This deliberately does not union across extracts.
209
+ * BM25 scores are not comparable across separately indexed corpora.
210
+ * A typical mailwoman query has one placetype.
211
+ *
212
+ * Callers that need cross-extract results can issue two `findPlace` calls.
213
+ */
193
214
  export function pickExtractForPlacetype(
194
215
  extracts: ResolvedExtract[],
195
- placetype: string | undefined,
216
+ placetype: string | null,
196
217
  opts?: {
197
218
  /**
198
- * #920: the query's country constraint, when the caller has one. With MULTIPLE extracts matching a placetype
199
- * (postalcode-us + postalcode-geonames-tail), first-match routing sent every postcode query to the first extract
200
- * and starved the rest — a FI postcode could never reach the tail extract. When `country` is given and a matching
201
- * extract's probed country set contains it, that extract wins; extracts without the country are skipped; the
202
- * placetype-match order remains the tiebreak when no extract claims the country (or none was probed).
219
+ * The query's country constraint, when the caller has one.
220
+ *
221
+ * When `country` is given and a matching extract's probed country set contains it, that extract wins.
222
+ * Extracts without the country are skipped.
223
+ *
224
+ * The placetype-match order remains the tiebreak when no extract claims
225
+ * the country (or none was probed).
203
226
  */
204
227
  country?: string
205
228
  /**
@@ -221,9 +244,9 @@ export function pickExtractForPlacetype(
221
244
  for (const s of extracts) {
222
245
  if (s.schemaName === "main" || matches.includes(s)) continue
223
246
 
224
- // Substring match: `postalcode_us` matches `postalcode`. Conservative — requires the
225
- // placetype to appear at a word boundary in the schema name to avoid false hits like
226
- // `region` matching `arboregion`.
247
+ // A substring match lets `postalcode_us` match `postalcode`.
248
+ // Conservative, requiring the placetype at a word boundary in the schema name
249
+ // to avoid false hits like `region` matching `arboregion`.
227
250
  if (
228
251
  s.schemaName === placetype ||
229
252
  s.schemaName.startsWith(`${placetype}_`) ||