@mailwoman/resolver-wof-sqlite 9.2.0 → 9.4.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 (493) hide show
  1. package/README.md +16 -19
  2. package/lib/address/index.ts +9 -0
  3. package/{address-point-interpolation.ts → lib/address/point-interpolation.ts} +25 -24
  4. package/{address-point-schema.ts → lib/address/point-schema.ts} +18 -4
  5. package/lib/address/point.ts +328 -0
  6. package/{ancestry-backfill.ts → lib/ancestry/backfill.ts} +14 -19
  7. package/{ancestry.ts → lib/ancestry/index.ts} +5 -4
  8. package/{build-candidate.ts → lib/build-candidate.ts} +99 -79
  9. package/{build-slim.ts → lib/build-slim.ts} +150 -165
  10. package/{candidate → lib/candidate}/alias-bags.ts +8 -6
  11. package/{candidate → lib/candidate}/ancestors-sidecar.ts +13 -15
  12. package/{candidate → lib/candidate}/country-display-names.ts +2 -2
  13. package/lib/candidate/extract-fold.ts +219 -0
  14. package/{candidate → lib/candidate}/name-roles.ts +17 -16
  15. package/{candidate → lib/candidate}/own-name.ts +2 -1
  16. package/{candidate → lib/candidate}/place-attrs.ts +3 -3
  17. package/{candidate-ancestors-schema.ts → lib/candidate-ancestors-schema.ts} +4 -4
  18. package/{candidate-fts.ts → lib/candidate-fts.ts} +3 -3
  19. package/{candidate-importance.ts → lib/candidate-importance.ts} +53 -57
  20. package/{candidate-lookup.ts → lib/candidate-lookup.ts} +84 -80
  21. package/{candidate-schema.ts → lib/candidate-schema.ts} +6 -6
  22. package/{candidate-scoring.ts → lib/candidate-scoring.ts} +15 -22
  23. package/{capital-schema.ts → lib/capital-schema.ts} +5 -6
  24. package/{capitals.ts → lib/capitals.ts} +2 -2
  25. package/{coincident-roles.ts → lib/coincident-roles.ts} +9 -13
  26. package/{convention.ts → lib/convention/index.ts} +3 -3
  27. package/{convention-schema.ts → lib/convention/schema.ts} +2 -2
  28. package/{coverage-manifest-schema.ts → lib/coverage-manifest-schema.ts} +10 -10
  29. package/{currency-backfill.ts → lib/currency-backfill.ts} +126 -41
  30. package/lib/env.ts +50 -0
  31. package/{exact-match.ts → lib/exact-match.ts} +23 -14
  32. package/{sharding.ts → lib/extracts.ts} +61 -58
  33. package/{fst-autocomplete.ts → lib/fst/autocomplete.ts} +4 -4
  34. package/{fst-builder.ts → lib/fst/builder.ts} +17 -16
  35. package/{fst-deserialize-web.ts → lib/fst/deserialize-web.ts} +27 -87
  36. package/lib/fst/format.ts +106 -0
  37. package/{fst-freshness.ts → lib/fst/freshness.ts} +40 -74
  38. package/lib/fst/index.ts +14 -0
  39. package/{fst-matcher.ts → lib/fst/matcher.ts} +1 -1
  40. package/{fst-serialize.ts → lib/fst/serialize.ts} +37 -115
  41. package/{fst-types.ts → lib/fst/types.ts} +4 -2
  42. package/{fts.ts → lib/fts/index.ts} +24 -19
  43. package/{fts-query.ts → lib/fts/query.ts} +1 -1
  44. package/{geonames-aliases.ts → lib/geonames/aliases.ts} +13 -13
  45. package/lib/geonames/index.ts +8 -0
  46. package/{geonames-postal.ts → lib/geonames/postal.ts} +14 -13
  47. package/{index.ts → lib/index.ts} +37 -37
  48. package/{interpolation.ts → lib/interpolation.ts} +28 -26
  49. package/{lookup.ts → lib/lookup.ts} +130 -142
  50. package/lib/nsul/index.ts +8 -0
  51. package/lib/nsul/lookup.ts +144 -0
  52. package/lib/nsul/schema.ts +130 -0
  53. package/{place-importance-schema.ts → lib/place-importance-schema.ts} +7 -16
  54. package/lib/poi/index.ts +8 -0
  55. package/{poi-lookup.ts → lib/poi/lookup.ts} +22 -29
  56. package/{poi-schema.ts → lib/poi/schema.ts} +3 -4
  57. package/{postal-city-alias-lookup.ts → lib/postal/city-alias-lookup.ts} +14 -20
  58. package/{postal-city-candidate-schema.ts → lib/postal/city-candidate-schema.ts} +2 -2
  59. package/lib/postal/index.ts +9 -0
  60. package/{postcode-point-lookup.ts → lib/postcode-point-lookup.ts} +17 -15
  61. package/{primary-preference.ts → lib/primary-preference.ts} +43 -14
  62. package/{proximity-rerank.ts → lib/proximity-rerank.ts} +2 -2
  63. package/{ranking-weights.ts → lib/ranking-weights.ts} +30 -4
  64. package/{region-keys.ts → lib/region-keys.ts} +9 -9
  65. package/{reverse.ts → lib/reverse.ts} +34 -47
  66. package/{schema.ts → lib/schema.ts} +10 -0
  67. package/{search-fetch.ts → lib/search-fetch.ts} +29 -29
  68. package/{sqlite-convention-source.ts → lib/sqlite-convention-source.ts} +9 -10
  69. package/{sqlite-utils.ts → lib/sqlite-utils.ts} +14 -19
  70. package/{street-centroid-schema.ts → lib/street/centroid-schema.ts} +5 -5
  71. package/{street-centroid.ts → lib/street/centroid.ts} +15 -22
  72. package/lib/street/index.ts +13 -0
  73. package/{street-morphology-fst-builder.ts → lib/street/morphology-fst-builder.ts} +24 -14
  74. package/{street-morphology-fst-loader.ts → lib/street/morphology-fst-loader.ts} +14 -12
  75. package/{street-name-lookup.ts → lib/street/name-lookup.ts} +14 -30
  76. package/{street-normalize.ts → lib/street/normalize.ts} +86 -20
  77. package/{street-segment-schema.ts → lib/street/segment-schema.ts} +7 -7
  78. package/{types.ts → lib/types.ts} +18 -12
  79. package/{unified-schema.ts → lib/unified-schema.ts} +20 -24
  80. package/lib/uprn/existence.ts +84 -0
  81. package/lib/uprn/index.ts +9 -0
  82. package/{uprn-lookup.ts → lib/uprn/lookup.ts} +14 -19
  83. package/{uprn-schema.ts → lib/uprn/schema.ts} +3 -3
  84. package/lib/weights-overlay-linker.ts +879 -0
  85. package/out/address/index.d.ts +9 -0
  86. package/out/address/index.d.ts.map +1 -0
  87. package/out/address/index.js +9 -0
  88. package/out/address/index.js.map +1 -0
  89. package/out/{address-point-interpolation.d.ts → address/point-interpolation.d.ts} +12 -11
  90. package/out/address/point-interpolation.d.ts.map +1 -0
  91. package/out/{address-point-interpolation.js → address/point-interpolation.js} +18 -18
  92. package/out/address/point-interpolation.js.map +1 -0
  93. package/out/{address-point-schema.d.ts → address/point-schema.d.ts} +16 -6
  94. package/out/address/point-schema.d.ts.map +1 -0
  95. package/out/{address-point-schema.js → address/point-schema.js} +7 -3
  96. package/out/address/point-schema.js.map +1 -0
  97. package/out/{address-point.d.ts → address/point.d.ts} +19 -9
  98. package/out/address/point.d.ts.map +1 -0
  99. package/out/address/point.js +222 -0
  100. package/out/address/point.js.map +1 -0
  101. package/out/{ancestry-backfill.d.ts → ancestry/backfill.d.ts} +7 -5
  102. package/out/ancestry/backfill.d.ts.map +1 -0
  103. package/out/{ancestry-backfill.js → ancestry/backfill.js} +12 -16
  104. package/out/ancestry/backfill.js.map +1 -0
  105. package/out/{ancestry.d.ts → ancestry/index.d.ts} +4 -3
  106. package/out/ancestry/index.d.ts.map +1 -0
  107. package/out/{ancestry.js → ancestry/index.js} +3 -2
  108. package/out/ancestry/index.js.map +1 -0
  109. package/out/build-candidate.d.ts +32 -24
  110. package/out/build-candidate.d.ts.map +1 -1
  111. package/out/build-candidate.js +60 -54
  112. package/out/build-candidate.js.map +1 -1
  113. package/out/build-slim.d.ts +4 -4
  114. package/out/build-slim.d.ts.map +1 -1
  115. package/out/build-slim.js +124 -139
  116. package/out/build-slim.js.map +1 -1
  117. package/out/candidate/alias-bags.d.ts +5 -3
  118. package/out/candidate/alias-bags.d.ts.map +1 -1
  119. package/out/candidate/alias-bags.js +2 -2
  120. package/out/candidate/alias-bags.js.map +1 -1
  121. package/out/candidate/ancestors-sidecar.d.ts +9 -10
  122. package/out/candidate/ancestors-sidecar.d.ts.map +1 -1
  123. package/out/candidate/ancestors-sidecar.js +7 -7
  124. package/out/candidate/ancestors-sidecar.js.map +1 -1
  125. package/out/candidate/country-display-names.d.ts +1 -1
  126. package/out/candidate/country-display-names.d.ts.map +1 -1
  127. package/out/candidate/country-display-names.js +1 -1
  128. package/out/candidate/country-display-names.js.map +1 -1
  129. package/out/candidate/extract-fold.d.ts +41 -0
  130. package/out/candidate/extract-fold.d.ts.map +1 -0
  131. package/out/candidate/extract-fold.js +153 -0
  132. package/out/candidate/extract-fold.js.map +1 -0
  133. package/out/candidate/name-roles.d.ts +13 -11
  134. package/out/candidate/name-roles.d.ts.map +1 -1
  135. package/out/candidate/name-roles.js +11 -10
  136. package/out/candidate/name-roles.js.map +1 -1
  137. package/out/candidate/own-name.d.ts +1 -1
  138. package/out/candidate/own-name.d.ts.map +1 -1
  139. package/out/candidate/own-name.js +2 -1
  140. package/out/candidate/own-name.js.map +1 -1
  141. package/out/candidate/place-attrs.d.ts +3 -3
  142. package/out/candidate/place-attrs.d.ts.map +1 -1
  143. package/out/candidate/place-attrs.js +1 -1
  144. package/out/candidate/place-attrs.js.map +1 -1
  145. package/out/candidate-ancestors-schema.d.ts +4 -4
  146. package/out/candidate-ancestors-schema.d.ts.map +1 -1
  147. package/out/candidate-ancestors-schema.js +2 -2
  148. package/out/candidate-ancestors-schema.js.map +1 -1
  149. package/out/candidate-fts.d.ts +3 -3
  150. package/out/candidate-fts.d.ts.map +1 -1
  151. package/out/candidate-fts.js +1 -1
  152. package/out/candidate-fts.js.map +1 -1
  153. package/out/candidate-importance.d.ts +16 -16
  154. package/out/candidate-importance.d.ts.map +1 -1
  155. package/out/candidate-importance.js +46 -51
  156. package/out/candidate-importance.js.map +1 -1
  157. package/out/candidate-lookup.d.ts +16 -14
  158. package/out/candidate-lookup.d.ts.map +1 -1
  159. package/out/candidate-lookup.js +67 -63
  160. package/out/candidate-lookup.js.map +1 -1
  161. package/out/candidate-schema.d.ts +6 -6
  162. package/out/candidate-schema.d.ts.map +1 -1
  163. package/out/candidate-schema.js +1 -1
  164. package/out/candidate-schema.js.map +1 -1
  165. package/out/candidate-scoring.d.ts +7 -7
  166. package/out/candidate-scoring.d.ts.map +1 -1
  167. package/out/candidate-scoring.js +10 -14
  168. package/out/candidate-scoring.js.map +1 -1
  169. package/out/capital-schema.d.ts +3 -3
  170. package/out/capital-schema.d.ts.map +1 -1
  171. package/out/capital-schema.js +2 -2
  172. package/out/capital-schema.js.map +1 -1
  173. package/out/capitals.d.ts +1 -1
  174. package/out/capitals.d.ts.map +1 -1
  175. package/out/capitals.js +2 -2
  176. package/out/capitals.js.map +1 -1
  177. package/out/coincident-roles.d.ts +7 -6
  178. package/out/coincident-roles.d.ts.map +1 -1
  179. package/out/coincident-roles.js +2 -4
  180. package/out/coincident-roles.js.map +1 -1
  181. package/out/{convention.d.ts → convention/index.d.ts} +4 -4
  182. package/out/convention/index.d.ts.map +1 -0
  183. package/out/{convention.js → convention/index.js} +2 -2
  184. package/out/convention/index.js.map +1 -0
  185. package/out/{convention-schema.d.ts → convention/schema.d.ts} +2 -2
  186. package/out/convention/schema.d.ts.map +1 -0
  187. package/out/{convention-schema.js → convention/schema.js} +3 -3
  188. package/out/convention/schema.js.map +1 -0
  189. package/out/coverage-manifest-schema.d.ts +8 -8
  190. package/out/coverage-manifest-schema.d.ts.map +1 -1
  191. package/out/coverage-manifest-schema.js +5 -4
  192. package/out/coverage-manifest-schema.js.map +1 -1
  193. package/out/currency-backfill.d.ts +51 -7
  194. package/out/currency-backfill.d.ts.map +1 -1
  195. package/out/currency-backfill.js +65 -49
  196. package/out/currency-backfill.js.map +1 -1
  197. package/out/env.d.ts +43 -0
  198. package/out/env.d.ts.map +1 -0
  199. package/out/env.js +48 -0
  200. package/out/env.js.map +1 -0
  201. package/out/exact-match.d.ts +5 -5
  202. package/out/exact-match.d.ts.map +1 -1
  203. package/out/exact-match.js +10 -11
  204. package/out/exact-match.js.map +1 -1
  205. package/out/extracts.d.ts +114 -0
  206. package/out/extracts.d.ts.map +1 -0
  207. package/out/{sharding.js → extracts.js} +38 -38
  208. package/out/extracts.js.map +1 -0
  209. package/out/{fst-autocomplete.d.ts → fst/autocomplete.d.ts} +2 -2
  210. package/out/fst/autocomplete.d.ts.map +1 -0
  211. package/out/{fst-autocomplete.js → fst/autocomplete.js} +3 -3
  212. package/out/fst/autocomplete.js.map +1 -0
  213. package/out/{fst-builder.d.ts → fst/builder.d.ts} +5 -5
  214. package/out/fst/builder.d.ts.map +1 -0
  215. package/out/{fst-builder.js → fst/builder.js} +14 -13
  216. package/out/fst/builder.js.map +1 -0
  217. package/out/{fst-deserialize-web.d.ts → fst/deserialize-web.d.ts} +3 -3
  218. package/out/fst/deserialize-web.d.ts.map +1 -0
  219. package/out/{fst-deserialize-web.js → fst/deserialize-web.js} +10 -74
  220. package/out/fst/deserialize-web.js.map +1 -0
  221. package/out/fst/format.d.ts +80 -0
  222. package/out/fst/format.d.ts.map +1 -0
  223. package/out/fst/format.js +91 -0
  224. package/out/fst/format.js.map +1 -0
  225. package/out/{fst-freshness.d.ts → fst/freshness.d.ts} +9 -13
  226. package/out/fst/freshness.d.ts.map +1 -0
  227. package/out/{fst-freshness.js → fst/freshness.js} +40 -73
  228. package/out/fst/freshness.js.map +1 -0
  229. package/out/fst/index.d.ts +14 -0
  230. package/out/fst/index.d.ts.map +1 -0
  231. package/out/fst/index.js +14 -0
  232. package/out/fst/index.js.map +1 -0
  233. package/out/{fst-matcher.d.ts → fst/matcher.d.ts} +2 -2
  234. package/out/fst/matcher.d.ts.map +1 -0
  235. package/out/{fst-matcher.js → fst/matcher.js} +1 -1
  236. package/out/fst/matcher.js.map +1 -0
  237. package/out/{fst-serialize.d.ts → fst/serialize.d.ts} +5 -10
  238. package/out/fst/serialize.d.ts.map +1 -0
  239. package/out/{fst-serialize.js → fst/serialize.js} +18 -98
  240. package/out/fst/serialize.js.map +1 -0
  241. package/out/{fst-types.d.ts → fst/types.d.ts} +4 -3
  242. package/out/fst/types.d.ts.map +1 -0
  243. package/out/{fst-types.js → fst/types.js} +1 -1
  244. package/out/fst/types.js.map +1 -0
  245. package/out/{fts.d.ts → fts/index.d.ts} +16 -9
  246. package/out/fts/index.d.ts.map +1 -0
  247. package/out/{fts.js → fts/index.js} +16 -11
  248. package/out/fts/index.js.map +1 -0
  249. package/out/{fts-query.d.ts → fts/query.d.ts} +2 -2
  250. package/out/fts/query.d.ts.map +1 -0
  251. package/out/{fts-query.js → fts/query.js} +1 -1
  252. package/out/fts/query.js.map +1 -0
  253. package/out/{geonames-aliases.d.ts → geonames/aliases.d.ts} +8 -6
  254. package/out/geonames/aliases.d.ts.map +1 -0
  255. package/out/{geonames-aliases.js → geonames/aliases.js} +7 -7
  256. package/out/geonames/aliases.js.map +1 -0
  257. package/out/geonames/index.d.ts +8 -0
  258. package/out/geonames/index.d.ts.map +1 -0
  259. package/out/geonames/index.js +8 -0
  260. package/out/geonames/index.js.map +1 -0
  261. package/out/{geonames-postal.d.ts → geonames/postal.d.ts} +10 -8
  262. package/out/geonames/postal.d.ts.map +1 -0
  263. package/out/{geonames-postal.js → geonames/postal.js} +9 -9
  264. package/out/geonames/postal.js.map +1 -0
  265. package/out/index.d.ts +32 -32
  266. package/out/index.d.ts.map +1 -1
  267. package/out/index.js +24 -24
  268. package/out/index.js.map +1 -1
  269. package/out/interpolation.d.ts +11 -10
  270. package/out/interpolation.d.ts.map +1 -1
  271. package/out/interpolation.js +20 -20
  272. package/out/interpolation.js.map +1 -1
  273. package/out/lookup.d.ts +22 -21
  274. package/out/lookup.d.ts.map +1 -1
  275. package/out/lookup.js +103 -113
  276. package/out/lookup.js.map +1 -1
  277. package/out/name-score.d.ts.map +1 -1
  278. package/out/name-score.js.map +1 -1
  279. package/out/nsul/index.d.ts +8 -0
  280. package/out/nsul/index.d.ts.map +1 -0
  281. package/out/nsul/index.js +8 -0
  282. package/out/nsul/index.js.map +1 -0
  283. package/out/nsul/lookup.d.ts +83 -0
  284. package/out/nsul/lookup.d.ts.map +1 -0
  285. package/out/nsul/lookup.js +80 -0
  286. package/out/nsul/lookup.js.map +1 -0
  287. package/out/nsul/schema.d.ts +100 -0
  288. package/out/nsul/schema.d.ts.map +1 -0
  289. package/out/nsul/schema.js +78 -0
  290. package/out/nsul/schema.js.map +1 -0
  291. package/out/place-importance-schema.d.ts +5 -6
  292. package/out/place-importance-schema.d.ts.map +1 -1
  293. package/out/place-importance-schema.js +3 -4
  294. package/out/place-importance-schema.js.map +1 -1
  295. package/out/poi/index.d.ts +8 -0
  296. package/out/poi/index.d.ts.map +1 -0
  297. package/out/poi/index.js +8 -0
  298. package/out/poi/index.js.map +1 -0
  299. package/out/{poi-lookup.d.ts → poi/lookup.d.ts} +8 -10
  300. package/out/poi/lookup.d.ts.map +1 -0
  301. package/out/{poi-lookup.js → poi/lookup.js} +14 -18
  302. package/out/poi/lookup.js.map +1 -0
  303. package/out/{poi-schema.d.ts → poi/schema.d.ts} +4 -4
  304. package/out/poi/schema.d.ts.map +1 -0
  305. package/out/{poi-schema.js → poi/schema.js} +1 -1
  306. package/out/poi/schema.js.map +1 -0
  307. package/out/polygon-schema.d.ts.map +1 -1
  308. package/out/polygon-schema.js.map +1 -1
  309. package/out/{postal-city-alias-lookup.d.ts → postal/city-alias-lookup.d.ts} +6 -5
  310. package/out/postal/city-alias-lookup.d.ts.map +1 -0
  311. package/out/{postal-city-alias-lookup.js → postal/city-alias-lookup.js} +11 -15
  312. package/out/postal/city-alias-lookup.js.map +1 -0
  313. package/out/{postal-city-alias-schema.d.ts → postal/city-alias-schema.d.ts} +1 -1
  314. package/out/{postal-city-alias-schema.d.ts.map → postal/city-alias-schema.d.ts.map} +1 -1
  315. package/out/{postal-city-alias-schema.js → postal/city-alias-schema.js} +1 -1
  316. package/out/{postal-city-alias-schema.js.map → postal/city-alias-schema.js.map} +1 -1
  317. package/out/{postal-city-candidate-schema.d.ts → postal/city-candidate-schema.d.ts} +3 -3
  318. package/out/{postal-city-candidate-schema.d.ts.map → postal/city-candidate-schema.d.ts.map} +1 -1
  319. package/out/{postal-city-candidate-schema.js → postal/city-candidate-schema.js} +2 -2
  320. package/out/{postal-city-candidate-schema.js.map → postal/city-candidate-schema.js.map} +1 -1
  321. package/out/postal/index.d.ts +9 -0
  322. package/out/postal/index.d.ts.map +1 -0
  323. package/out/postal/index.js +9 -0
  324. package/out/postal/index.js.map +1 -0
  325. package/out/postcode-point-lookup.d.ts +10 -10
  326. package/out/postcode-point-lookup.d.ts.map +1 -1
  327. package/out/postcode-point-lookup.js +13 -13
  328. package/out/postcode-point-lookup.js.map +1 -1
  329. package/out/primary-preference.d.ts +15 -7
  330. package/out/primary-preference.d.ts.map +1 -1
  331. package/out/primary-preference.js +28 -12
  332. package/out/primary-preference.js.map +1 -1
  333. package/out/proximity-rerank.d.ts +2 -2
  334. package/out/proximity-rerank.d.ts.map +1 -1
  335. package/out/proximity-rerank.js +2 -2
  336. package/out/proximity-rerank.js.map +1 -1
  337. package/out/ranking-weights.d.ts +15 -3
  338. package/out/ranking-weights.d.ts.map +1 -1
  339. package/out/ranking-weights.js +21 -3
  340. package/out/ranking-weights.js.map +1 -1
  341. package/out/region-keys.d.ts +8 -8
  342. package/out/region-keys.d.ts.map +1 -1
  343. package/out/region-keys.js +9 -9
  344. package/out/region-keys.js.map +1 -1
  345. package/out/reverse.d.ts +6 -6
  346. package/out/reverse.d.ts.map +1 -1
  347. package/out/reverse.js +20 -29
  348. package/out/reverse.js.map +1 -1
  349. package/out/schema.d.ts +9 -0
  350. package/out/schema.d.ts.map +1 -1
  351. package/out/schema.js.map +1 -1
  352. package/out/search-fetch.d.ts +12 -10
  353. package/out/search-fetch.d.ts.map +1 -1
  354. package/out/search-fetch.js +21 -20
  355. package/out/search-fetch.js.map +1 -1
  356. package/out/sqlite-convention-source.d.ts +7 -7
  357. package/out/sqlite-convention-source.d.ts.map +1 -1
  358. package/out/sqlite-convention-source.js +5 -5
  359. package/out/sqlite-convention-source.js.map +1 -1
  360. package/out/sqlite-utils.d.ts +8 -9
  361. package/out/sqlite-utils.d.ts.map +1 -1
  362. package/out/sqlite-utils.js +6 -10
  363. package/out/sqlite-utils.js.map +1 -1
  364. package/out/{street-centroid-schema.d.ts → street/centroid-schema.d.ts} +6 -6
  365. package/out/{street-centroid-schema.d.ts.map → street/centroid-schema.d.ts.map} +1 -1
  366. package/out/{street-centroid-schema.js → street/centroid-schema.js} +5 -5
  367. package/out/{street-centroid-schema.js.map → street/centroid-schema.js.map} +1 -1
  368. package/out/{street-centroid.d.ts → street/centroid.d.ts} +7 -7
  369. package/out/street/centroid.d.ts.map +1 -0
  370. package/out/{street-centroid.js → street/centroid.js} +13 -19
  371. package/out/street/centroid.js.map +1 -0
  372. package/out/street/index.d.ts +13 -0
  373. package/out/street/index.d.ts.map +1 -0
  374. package/out/street/index.js +13 -0
  375. package/out/street/index.js.map +1 -0
  376. package/out/{street-morphology-fst-builder.d.ts → street/morphology-fst-builder.d.ts} +4 -4
  377. package/out/street/morphology-fst-builder.d.ts.map +1 -0
  378. package/out/{street-morphology-fst-builder.js → street/morphology-fst-builder.js} +18 -13
  379. package/out/street/morphology-fst-builder.js.map +1 -0
  380. package/out/{street-morphology-fst-loader.d.ts → street/morphology-fst-loader.d.ts} +5 -5
  381. package/out/street/morphology-fst-loader.d.ts.map +1 -0
  382. package/out/{street-morphology-fst-loader.js → street/morphology-fst-loader.js} +11 -10
  383. package/out/street/morphology-fst-loader.js.map +1 -0
  384. package/out/{street-name-lookup.d.ts → street/name-lookup.d.ts} +4 -7
  385. package/out/street/name-lookup.d.ts.map +1 -0
  386. package/out/{street-name-lookup.js → street/name-lookup.js} +9 -23
  387. package/out/street/name-lookup.js.map +1 -0
  388. package/out/{street-normalize.d.ts → street/normalize.d.ts} +38 -15
  389. package/out/street/normalize.d.ts.map +1 -0
  390. package/out/{street-normalize.js → street/normalize.js} +73 -17
  391. package/out/street/normalize.js.map +1 -0
  392. package/out/{street-segment-schema.d.ts → street/segment-schema.d.ts} +8 -8
  393. package/out/{street-segment-schema.d.ts.map → street/segment-schema.d.ts.map} +1 -1
  394. package/out/{street-segment-schema.js → street/segment-schema.js} +4 -4
  395. package/out/{street-segment-schema.js.map → street/segment-schema.js.map} +1 -1
  396. package/out/types.d.ts +18 -12
  397. package/out/types.d.ts.map +1 -1
  398. package/out/types.js.map +1 -1
  399. package/out/unified-schema.d.ts +5 -4
  400. package/out/unified-schema.d.ts.map +1 -1
  401. package/out/unified-schema.js +15 -18
  402. package/out/unified-schema.js.map +1 -1
  403. package/out/uprn/existence.d.ts +53 -0
  404. package/out/uprn/existence.d.ts.map +1 -0
  405. package/out/uprn/existence.js +61 -0
  406. package/out/uprn/existence.js.map +1 -0
  407. package/out/uprn/index.d.ts +9 -0
  408. package/out/uprn/index.d.ts.map +1 -0
  409. package/out/uprn/index.js +9 -0
  410. package/out/uprn/index.js.map +1 -0
  411. package/out/{uprn-lookup.d.ts → uprn/lookup.d.ts} +4 -4
  412. package/out/uprn/lookup.d.ts.map +1 -0
  413. package/out/{uprn-lookup.js → uprn/lookup.js} +11 -14
  414. package/out/uprn/lookup.js.map +1 -0
  415. package/out/{uprn-schema.d.ts → uprn/schema.d.ts} +4 -4
  416. package/out/uprn/schema.d.ts.map +1 -0
  417. package/out/{uprn-schema.js → uprn/schema.js} +4 -4
  418. package/out/uprn/schema.js.map +1 -0
  419. package/out/weights-overlay-linker.d.ts +184 -26
  420. package/out/weights-overlay-linker.d.ts.map +1 -1
  421. package/out/weights-overlay-linker.js +339 -86
  422. package/out/weights-overlay-linker.js.map +1 -1
  423. package/package.json +465 -269
  424. package/address-point.ts +0 -218
  425. package/candidate/shard-fold.ts +0 -137
  426. package/out/address-point-interpolation.d.ts.map +0 -1
  427. package/out/address-point-interpolation.js.map +0 -1
  428. package/out/address-point-schema.d.ts.map +0 -1
  429. package/out/address-point-schema.js.map +0 -1
  430. package/out/address-point.d.ts.map +0 -1
  431. package/out/address-point.js +0 -140
  432. package/out/address-point.js.map +0 -1
  433. package/out/ancestry-backfill.d.ts.map +0 -1
  434. package/out/ancestry-backfill.js.map +0 -1
  435. package/out/ancestry.d.ts.map +0 -1
  436. package/out/ancestry.js.map +0 -1
  437. package/out/candidate/shard-fold.d.ts +0 -31
  438. package/out/candidate/shard-fold.d.ts.map +0 -1
  439. package/out/candidate/shard-fold.js +0 -104
  440. package/out/candidate/shard-fold.js.map +0 -1
  441. package/out/convention-schema.d.ts.map +0 -1
  442. package/out/convention-schema.js.map +0 -1
  443. package/out/convention.d.ts.map +0 -1
  444. package/out/convention.js.map +0 -1
  445. package/out/fst-autocomplete.d.ts.map +0 -1
  446. package/out/fst-autocomplete.js.map +0 -1
  447. package/out/fst-builder.d.ts.map +0 -1
  448. package/out/fst-builder.js.map +0 -1
  449. package/out/fst-deserialize-web.d.ts.map +0 -1
  450. package/out/fst-deserialize-web.js.map +0 -1
  451. package/out/fst-freshness.d.ts.map +0 -1
  452. package/out/fst-freshness.js.map +0 -1
  453. package/out/fst-matcher.d.ts.map +0 -1
  454. package/out/fst-matcher.js.map +0 -1
  455. package/out/fst-serialize.d.ts.map +0 -1
  456. package/out/fst-serialize.js.map +0 -1
  457. package/out/fst-types.d.ts.map +0 -1
  458. package/out/fst-types.js.map +0 -1
  459. package/out/fts-query.d.ts.map +0 -1
  460. package/out/fts-query.js.map +0 -1
  461. package/out/fts.d.ts.map +0 -1
  462. package/out/fts.js.map +0 -1
  463. package/out/geonames-aliases.d.ts.map +0 -1
  464. package/out/geonames-aliases.js.map +0 -1
  465. package/out/geonames-postal.d.ts.map +0 -1
  466. package/out/geonames-postal.js.map +0 -1
  467. package/out/poi-lookup.d.ts.map +0 -1
  468. package/out/poi-lookup.js.map +0 -1
  469. package/out/poi-schema.d.ts.map +0 -1
  470. package/out/poi-schema.js.map +0 -1
  471. package/out/postal-city-alias-lookup.d.ts.map +0 -1
  472. package/out/postal-city-alias-lookup.js.map +0 -1
  473. package/out/sharding.d.ts +0 -114
  474. package/out/sharding.d.ts.map +0 -1
  475. package/out/sharding.js.map +0 -1
  476. package/out/street-centroid.d.ts.map +0 -1
  477. package/out/street-centroid.js.map +0 -1
  478. package/out/street-morphology-fst-builder.d.ts.map +0 -1
  479. package/out/street-morphology-fst-builder.js.map +0 -1
  480. package/out/street-morphology-fst-loader.d.ts.map +0 -1
  481. package/out/street-morphology-fst-loader.js.map +0 -1
  482. package/out/street-name-lookup.d.ts.map +0 -1
  483. package/out/street-name-lookup.js.map +0 -1
  484. package/out/street-normalize.d.ts.map +0 -1
  485. package/out/street-normalize.js.map +0 -1
  486. package/out/uprn-lookup.d.ts.map +0 -1
  487. package/out/uprn-lookup.js.map +0 -1
  488. package/out/uprn-schema.d.ts.map +0 -1
  489. package/out/uprn-schema.js.map +0 -1
  490. package/weights-overlay-linker.ts +0 -377
  491. /package/{name-score.ts → lib/name-score.ts} +0 -0
  492. /package/{polygon-schema.ts → lib/polygon-schema.ts} +0 -0
  493. /package/{postal-city-alias-schema.ts → lib/postal/city-alias-schema.ts} +0 -0
@@ -0,0 +1,219 @@
1
+ /**
2
+ * @copyright Sister Software
3
+ * @license AGPL-3.0
4
+ * @author Teffen Ellis, et al.
5
+ * @file Pass 4 of the candidate build — fold a postcode or locality extract into the staging table.
6
+ */
7
+
8
+ import { DatabaseClient } from "@mailwoman/sqlite/client"
9
+ import { tableExists } from "@mailwoman/sqlite/introspection"
10
+
11
+ import { CANDIDATE_ANCESTOR_COLUMNS, CANDIDATE_ANCESTOR_TABLE } from "#candidate-ancestors-schema"
12
+ import type { CandidateDatabase } from "#candidate-schema"
13
+ import type { PlaceAttrs, StageRow } from "#candidate/place-attrs"
14
+ import type { WOFDatabase } from "#schema"
15
+ import { normalizeLocalityForKey } from "#street/normalize"
16
+
17
+ /**
18
+ * The extract's own region-tier ancestry, when it carries any: extract id → the admin region's id. A locality extract
19
+ * derived from a national register (the Taiwanese 鄉鎮市區 from the civil-affairs address points) knows which 縣市 each row
20
+ * belongs to, and writes that as an `ancestors` row against the admin region's WOF id. Without it a folded row has no
21
+ * region scope, so a `parentID`-scoped probe misses it and the cascade widens to whatever namesake carries the key.
22
+ *
23
+ * Only a region the admin build staged (`attrs`) counts: an id the admin does not know cannot be denormalized into a
24
+ * closure row, and a scope nothing can match would be a silent zero rather than an absence.
25
+ */
26
+ function extractRegionAncestry(pc: DatabaseClient<WOFDatabase>, attrs: Map<number, PlaceAttrs>): Map<number, number> {
27
+ const regionOf = new Map<number, number>()
28
+
29
+ if (!tableExists(pc, "ancestors")) {
30
+ return regionOf
31
+ }
32
+
33
+ for (const r of pc
34
+ .prepare(
35
+ "SELECT id, MIN(ancestor_id) AS ancestor_id FROM ancestors WHERE ancestor_placetype = 'region' GROUP BY id"
36
+ )
37
+ .iterate()) {
38
+ const rid = Number(r.ancestor_id)
39
+
40
+ if (attrs.has(rid)) {
41
+ regionOf.set(Number(r.id), rid)
42
+ }
43
+ }
44
+
45
+ return regionOf
46
+ }
47
+
48
+ /**
49
+ * Fold ONE extract (`spr` rows at `extractPlacetype` carrying real coordinates) in, then pass 4b: the alias names
50
+ * hanging off that same extract's `names` table.
51
+ *
52
+ * Self-contained by construction — it shares only the staging statement and the code dictionaries with the admin passes
53
+ * above it, and nothing downstream reads anything it produces except the counters it returns. The one thing it writes
54
+ * beyond the staging table is a depth-1 closure row for a row whose extract names its region (see
55
+ * {@link extractRegionAncestry}), so the pick's stamped ancestors agree with the scope it was found under.
56
+ */
57
+ export function foldExtract(ctx: {
58
+ /**
59
+ * The staging connection. The extract itself is opened read-only here and closed before returning.
60
+ */
61
+ out: DatabaseClient<CandidateDatabase>
62
+ extractPath: string
63
+ extractPlacetype: "postalcode" | "locality"
64
+ ccID: (code: string | null) => number
65
+ ptID: (pt: string | null) => number
66
+ stageRow: StageRow
67
+ /**
68
+ * The admin places pass 1 staged — what an extract's region ancestry is resolved against. Absent, no extract row
69
+ * takes a region scope (the postcode extracts, which carry none).
70
+ */
71
+ attrs?: Map<number, PlaceAttrs>
72
+ progress: (phase: string, message: string) => void
73
+ }): { primaries: number; aliases: number; scoped: number; ancestorRows: number } {
74
+ const { out, extractPath, extractPlacetype, ccID, ptID, stageRow, progress } = ctx
75
+
76
+ progress(extractPlacetype === "postalcode" ? "postcodes" : "localities", `reading ${extractPath}`)
77
+
78
+ using pc = new DatabaseClient<WOFDatabase>(extractPath, { readOnly: true })
79
+ const pcPtid = ptID(extractPlacetype)
80
+ // Per-extract, not the admin `attrs` map: pass 1 only ever sees the admin DB, so the alias pass
81
+ // below has nothing to join against unless this primary loop records what it staged.
82
+ const pcAttrs = new Map<number, PlaceAttrs>()
83
+ const regionOf = ctx.attrs ? extractRegionAncestry(pc, ctx.attrs) : new Map<number, number>()
84
+
85
+ const insAncestor = out.prepare(
86
+ `INSERT OR IGNORE INTO ${CANDIDATE_ANCESTOR_TABLE} VALUES (${CANDIDATE_ANCESTOR_COLUMNS.map(() => "?").join(", ")})`
87
+ )
88
+
89
+ // The region's own closure rows, as the sidecar pass wrote them. A scoped row inherits the whole chain above its
90
+ // region — macroregion, country — not the region alone: the widened-scope refusal reads a pick's stamped ancestors
91
+ // against the parent the walk resolved, and a 縣市 that resolves to its macroregion record (`桃園市`, which WOF names
92
+ // only at that tier) would otherwise contradict a lineage that stops at the region.
93
+ const regionChain = out.prepare(
94
+ `SELECT depth, parent_spr_id, parent_placetype_id, parent_name, parent_name_key FROM ${CANDIDATE_ANCESTOR_TABLE} WHERE spr_id = ? ORDER BY depth`
95
+ )
96
+
97
+ let primaries = 0
98
+ let aliases = 0
99
+ let scoped = 0
100
+ let ancestorRows = 0
101
+
102
+ out.exec("BEGIN")
103
+
104
+ for (const r of pc
105
+ .prepare(
106
+ `SELECT id, name, country, latitude, longitude,
107
+ min_latitude AS mnlat, min_longitude AS mnlon, max_latitude AS mxlat, max_longitude AS mxlon
108
+ FROM spr WHERE placetype = ? AND latitude != 0 AND longitude != 0`
109
+ )
110
+ .iterate(extractPlacetype)) {
111
+ const name = String(r.name ?? "")
112
+ const key = normalizeLocalityForKey(name)
113
+
114
+ if (!key) continue
115
+
116
+ const lat = r.latitude as number
117
+ const lon = r.longitude as number
118
+ const id = Number(r.id)
119
+ const rid = regionOf.get(id) ?? 0
120
+
121
+ // region_id from the extract's own ancestry when it names one, else 0 (a postcode is unique by
122
+ // name+country — no same-name disambiguation); neg_rank 0 (no population). bbox = the row's own
123
+ // min/max (falls back to the centroid point).
124
+ const a: PlaceAttrs = {
125
+ cid: ccID(r.country as string | null),
126
+ rid,
127
+ ptid: pcPtid,
128
+ name,
129
+ lat,
130
+ lon,
131
+ mnLat: (r.mnlat as number) || lat,
132
+ mnLon: (r.mnlon as number) || lon,
133
+ mxLat: (r.mxlat as number) || lat,
134
+ mxLon: (r.mxlon as number) || lon,
135
+ pop: 0,
136
+ neg: 0,
137
+ pkey: key,
138
+ // A postcode has no toponym fame — nobody writes an encyclopedia article about SW1A 2AA — and
139
+ // the score source carries no `postalcode` rows to join against anyway. NULL is the truthful
140
+ // value: unmeasured, so the ranking key leaves postcode rows exactly where they were.
141
+ imp: null,
142
+ }
143
+
144
+ pcAttrs.set(id, a)
145
+ stageRow(key, a, id, 1)
146
+
147
+ if (rid !== 0) {
148
+ const region = ctx.attrs!.get(rid)!
149
+
150
+ insAncestor.run(id, 1, rid, region.ptid, region.name, region.pkey)
151
+
152
+ scoped++
153
+
154
+ ancestorRows++
155
+
156
+ for (const link of regionChain.iterate(rid)) {
157
+ insAncestor.run(
158
+ id,
159
+ Number(link.depth) + 1,
160
+ Number(link.parent_spr_id),
161
+ Number(link.parent_placetype_id),
162
+ String(link.parent_name ?? ""),
163
+ String(link.parent_name_key ?? "")
164
+ )
165
+
166
+ ancestorRows++
167
+ }
168
+ }
169
+
170
+ primaries++
171
+ }
172
+
173
+ out.exec("COMMIT")
174
+
175
+ // --- pass 4b: postcode ALIAS names (#1495) ---
176
+ //
177
+ // The delivery-city names GeoNames supplies for a ZIP ("Brooklyn" for 11201) are written into
178
+ // the extract's `names` table by `postcode/centroid-fills.ts`'s `geonamesNameFill`. Everything
179
+ // downstream of `names` picked them up EXCEPT this build: `fts.ts` unions `spr.name` with every
180
+ // `names` row into `place_search.alt_names`, so the FTS backend resolved "Brooklyn" → 11201
181
+ // while the candidate backend — whose every row IS an exact-tier row — had no key for it at
182
+ // all. Pass 2 does the equivalent fold for admin places, but reads the ADMIN `place_search`,
183
+ // and `attrs` holds admin ids only, so a postcode extract could never reach it.
184
+ //
185
+ // Same discipline as pass 2: `is_primary = 0` (so `rankByPrimaryPreference` treats it as an
186
+ // alias, not a canonical postcode name), the row stays denormalized onto the POSTCODE's own
187
+ // spr_id/coords/bbox, and the display `name` stays the postcode — resolving "brooklyn" answers
188
+ // with place 11201, it does not rename the place to its delivery city.
189
+ const hasNames = tableExists(pc, "names")
190
+
191
+ if (hasNames) {
192
+ out.exec("BEGIN")
193
+
194
+ for (const r of pc.prepare("SELECT id, name FROM names").iterate()) {
195
+ const a = pcAttrs.get(Number(r.id))
196
+
197
+ if (!a) continue
198
+
199
+ const k = normalizeLocalityForKey(String(r.name ?? ""))
200
+
201
+ // The postcode's own key is already staged as the primary; `INSERT OR IGNORE` at
202
+ // materialization dedupes repeats, so this only skips the obvious self-alias.
203
+ if (!k || k === a.pkey) continue
204
+
205
+ stageRow(k, a, Number(r.id), 0)
206
+
207
+ aliases++
208
+ }
209
+
210
+ out.exec("COMMIT")
211
+ } else {
212
+ // Never a silent zero: real extracts come from `createUnifiedSchema`, which always creates
213
+ // `names`. A extract without it has no alias surface to lose, but say so rather than reporting
214
+ // "0 aliases" from a table that was never read.
215
+ progress("postcode-aliases", `${extractPath} has no \`names\` table — no delivery-city aliases to fold`)
216
+ }
217
+
218
+ return { primaries, aliases, scoped, ancestorRows }
219
+ }
@@ -2,21 +2,23 @@
2
2
  * @copyright Sister Software
3
3
  * @license AGPL-3.0
4
4
  * @author Teffen Ellis, et al.
5
- * @file Pass 3c of the candidate build — the `name_role` detectors and the cuts they are judged by.
5
+ * @file Pass 3c of the candidate build — the `name_role` detectors and the thresholds they are judged by.
6
6
  */
7
7
 
8
- import type { DatabaseSync } from "node:sqlite"
9
-
10
8
  import { isOfficialLanguage } from "@mailwoman/codex/country"
9
+ import type { DatabaseClient } from "@mailwoman/sqlite/client"
10
+ import { tableExists } from "@mailwoman/sqlite/introspection"
11
11
 
12
- import { normalizeLocalityForKey } from "../street-normalize.ts"
13
- import { isOwnNameVariant } from "./own-name.ts"
14
- import type { PlaceAttrs } from "./place-attrs.ts"
12
+ import type { CandidateDatabase } from "#candidate-schema"
13
+ import { isOwnNameVariant } from "#candidate/own-name"
14
+ import type { PlaceAttrs } from "#candidate/place-attrs"
15
+ import type { WOFDatabase } from "#schema"
16
+ import { normalizeLocalityForKey } from "#street/normalize"
15
17
 
16
18
  /**
17
- * Key-count cut for the gloss anomaly detector (#1730) — the sweep's own boundary: 4,000 places carried >= 50 keys, and
18
- * a legitimate famous place at that count (New York, 176 keys) is separated by the PROMINENCE gate, never by this
19
- * number alone.
19
+ * Key-count threshold for the gloss anomaly detector (#1730) — the sweep's own boundary: 4,000 places carried >= 50
20
+ * keys, and a legitimate famous place at that count (New York, 176 keys) is separated by the PROMINENCE check, never by
21
+ * this number alone.
20
22
  */
21
23
  export const GLOSS_KEY_THRESHOLD = 50
22
24
 
@@ -39,9 +41,9 @@ export const GLOSS_EXCLUDED_PLACETYPES: ReadonlySet<string> = new Set([
39
41
 
40
42
  /**
41
43
  * Pass 3c — the #1730 name-role prototype: two independent detectors over the staged rows, WRITE-ONLY in this
42
- * generation (no ranking consumer; the rank penalty is its own D-rule-gated step with the `gloss_key` board as
43
- * tripwire). Both stamp `is_primary = 0` rows only — a place's canonical name and the `place_abbr` region abbreviations
44
- * are never a gloss or a variant.
44
+ * generation (no ranking consumer; the rank penalty is its own D-rule-conditional step with the `gloss_key` board as
45
+ * regression check). Both stamp `is_primary = 0` rows only — a place's canonical name and the `place_abbr` region
46
+ * abbreviations are never a gloss or a variant.
45
47
  *
46
48
  * - `gloss` is ANOMALY-based, and stamps only the certain core: key volume at/over the threshold + a non-admin placetype
47
49
  *
@@ -55,8 +57,8 @@ export const GLOSS_EXCLUDED_PLACETYPES: ReadonlySet<string> = new Set([
55
57
  * any role.
56
58
  */
57
59
  export function stampNameRoles(ctx: {
58
- src: DatabaseSync
59
- out: DatabaseSync
60
+ src: DatabaseClient<WOFDatabase>
61
+ out: DatabaseClient<CandidateDatabase>
60
62
  attrs: Map<number, PlaceAttrs>
61
63
  keyCounts: Map<number, number>
62
64
  glossThreshold: number
@@ -94,8 +96,7 @@ export function stampNameRoles(ctx: {
94
96
  const insRoleKey = out.prepare("INSERT OR IGNORE INTO role_key VALUES (?, ?)")
95
97
 
96
98
  // Zero abbr stamps from a skipped detector is a different fact from zero variants found.
97
- const hasSourceNames =
98
- src.prepare("SELECT 1 FROM sqlite_master WHERE type='table' AND name='names'").get() !== undefined
99
+ const hasSourceNames = tableExists(src, "names")
99
100
 
100
101
  if (hasSourceNames) {
101
102
  out.exec("BEGIN")
@@ -9,7 +9,7 @@
9
9
  * — rather than a different name that merely shares the folded key?
10
10
  *
11
11
  * The comparator is `levenshteinSimilarity`, NOT Jaro-Winkler: JW's common-prefix bonus scores
12
- * the load-bearing NEGATIVE case (`chanchun` vs `cancun`, 0.925) above real positives
12
+ * the required NEGATIVE case (`chanchun` vs `cancun`, 0.925) above real positives
13
13
  * (`saint george s` vs `st georges` expanded, 0.914), so no JW threshold separates them.
14
14
  * Measured on the #1882 census contests, edit similarity separates every case with margin:
15
15
  *
@@ -127,6 +127,7 @@ export function romanizeNameKey(key: string): string | null {
127
127
  * Edit similarity between a holder's primary name key and one of its alias keys, both romanized and
128
128
  * abbreviation-expanded. `null` when either side's script is uncovered.
129
129
  */
130
+ // repo-health-ignore export-name-affix -- romanizes and expands abbreviations first; `nameSimilarity` compares as given.
130
131
  export function ownNameSimilarity(primaryKey: string, aliasKey: string): number | null {
131
132
  const primary = romanizeNameKey(primaryKey)
132
133
  const alias = romanizeNameKey(aliasKey)
@@ -5,7 +5,7 @@
5
5
  * @file The per-place record every candidate-staging pass writes its rows from.
6
6
  *
7
7
  * Pass 1 reduces each current `spr` row to one {@link PlaceAttrs}; every later pass (alias bags,
8
- * region abbreviations, country display names, the currency backfill, the shard folds) discovers
8
+ * region abbreviations, country display names, the currency backfill, the extract folds) discovers
9
9
  * ADDITIONAL name keys for a place already in that map and stages a row against the same record.
10
10
  * That is what keeps each candidate row denormalized without re-reading the source, and it is why
11
11
  * a pass needs exactly four things to stage: the key it found, the place, the id the row hangs on,
@@ -38,7 +38,7 @@ export interface PlaceAttrs {
38
38
  * Stage one candidate row: a normalized name key, the place it belongs to, the source id the row hangs on, and whether
39
39
  * the key is that place's canonical name (`is_primary`).
40
40
  *
41
- * `sid` is passed separately rather than read off the place because a shard fold and the alias pass stage rows for ids
42
- * the admin `attrs` map never held.
41
+ * `sid` is passed separately rather than read off the place because a extract fold and the alias pass stage rows for
42
+ * ids the admin `attrs` map never held.
43
43
  */
44
44
  export type StageRow = (k: string, a: PlaceAttrs, sid: number, isPrimary: number) => void
@@ -50,7 +50,7 @@
50
50
  * "contained along the canonical hierarchy", never "not contained at all".
51
51
  *
52
52
  * ABSENCE SEMANTICS (meaning-of-zero): a place with no `candidate_interval` row has no recorded
53
- * ancestry in the source (shard-fed postcodes and localities, isolated places, cycle-skipped
53
+ * ancestry in the source (extract-fed postcodes and localities, isolated places, cycle-skipped
54
54
  * rows). Absence is UNVERIFIABLE, never a containment verdict.
55
55
  */
56
56
 
@@ -59,8 +59,8 @@ import { sql, type Kysely } from "kysely"
59
59
  // Type-only and circular on purpose (candidate-schema extends CandidateAncestorsDatabase): Kysely's
60
60
  // DB parameter is invariant, so the DDL functions must take the FULL database type their caller
61
61
  // holds. Erased at runtime.
62
- import type { CandidateDatabase } from "./candidate-schema.ts"
63
- import type { NameKey } from "./street-normalize.ts"
62
+ import type { CandidateDatabase } from "#candidate-schema"
63
+ import type { NameKey } from "#street/normalize"
64
64
 
65
65
  /**
66
66
  * The deepest chain the sidecar stores per place. WOF containment within the resolvable placetypes (country …
@@ -76,7 +76,7 @@ export const MAX_ANCESTOR_DEPTH = 8
76
76
  export const CANDIDATE_ANCESTOR_TABLE = "candidate_ancestor"
77
77
 
78
78
  /**
79
- * The interval-label table's name — the closure table's seal-time sibling; existence-gated the same way.
79
+ * The interval-label table's name — the closure table's seal-time sibling; existence-restricted the same way.
80
80
  */
81
81
  export const CANDIDATE_INTERVAL_TABLE = "candidate_interval"
82
82
 
@@ -25,10 +25,10 @@
25
25
  * fallback only needs to recover the name_key, then re-probes the B-tree for its rows).
26
26
  */
27
27
 
28
- import type { DatabaseSync } from "node:sqlite"
28
+ import type { DatabaseClient } from "@mailwoman/sqlite/client"
29
29
 
30
30
  /**
31
- * Name of the FTS5 trigram virtual table this module owns. The reader gates its fuzzy fallback on it.
31
+ * Name of the FTS5 trigram virtual table this module owns. The reader conditions its fuzzy fallback on it.
32
32
  */
33
33
  export const CANDIDATE_FTS_TABLE = "candidate_fts"
34
34
 
@@ -36,7 +36,7 @@ export const CANDIDATE_FTS_TABLE = "candidate_fts"
36
36
  * Build (or rebuild) {@link CANDIDATE_FTS_TABLE} from the materialized `candidate` table. Call after the candidate
37
37
  * B-tree is populated (build pipeline) or against an existing candidate DB (migration).
38
38
  */
39
- export function createCandidateFTS(db: DatabaseSync): void {
39
+ export function createCandidateFTS<DB>(db: DatabaseClient<DB>): void {
40
40
  db.exec(`DROP TABLE IF EXISTS ${CANDIDATE_FTS_TABLE}`)
41
41
  db.exec(`CREATE VIRTUAL TABLE ${CANDIDATE_FTS_TABLE} USING fts5(name_key, tokenize='trigram')`)
42
42
 
@@ -27,7 +27,7 @@
27
27
  * Warwick in America the fame of Warwick, Rhode Island, which is the fan-out defect
28
28
  * `importance-fanout.ts` documents one layer up, re-introduced at the join. So the group is
29
29
  * disambiguated GEOGRAPHICALLY: the nearest centroid wins, and only within
30
- * {@link IMPORTANCE_JOIN_GATE_KM}. Two artifacts describing the same settlement put its centroid in
30
+ * {@link IMPORTANCE_JOIN_RADIUS_KM}. Two artifacts describing the same settlement put its centroid in
31
31
  * almost the same place; two same-named towns in one country do not.
32
32
  *
33
33
  * ## What lands in the column
@@ -41,11 +41,11 @@
41
41
  * (`resolver/toponym-prior.ts`) leaves an unmeasured candidate exactly where population put it.
42
42
  */
43
43
 
44
- import { DatabaseSync } from "node:sqlite"
45
-
46
44
  import { haversineKm } from "@mailwoman/spatial"
45
+ import { DatabaseClient } from "@mailwoman/sqlite/client"
47
46
 
48
- import { normalizeLocalityForKey } from "./street-normalize.ts"
47
+ import type { CandidateDatabase } from "#candidate-schema"
48
+ import { normalizeLocalityForKey } from "#street/normalize"
49
49
 
50
50
  /**
51
51
  * How far apart two artifacts may put the same place's centroid and still be read as the same place.
@@ -55,18 +55,18 @@ import { normalizeLocalityForKey } from "./street-normalize.ts"
55
55
  * country, placetype)`). The nearest-centroid distance is **exactly 0.00 km for 577,080 of them (56.6%)** — the two
56
56
  * snapshots agree to the bit — and 656,755 (64.4%) are inside 500 m.
57
57
  *
58
- * What sets the gate is where that mode ENDS, and the per-kilometre density says so plainly. It falls from 1,076
59
- * places/km over 3–5 km to a trough of **441 places/km over 7–10 km**, then climbs back and flattens onto a plateau of
60
- * 760–780 places/km from 30 km out to 100 km and beyond. That plateau is the background rate of two DIFFERENT towns
61
- * wearing one name in one country, and it does not decay with distance because there is no reason it should. 10 km is
62
- * the floor between the two populations. Admitting it scores 679,163 places (66.6% of the matched set); pushing the
63
- * gate to 25 km buys 8,722 more, and by then better than half of each additional kilometre is the wrong town.
58
+ * What sets the radius is where that mode ENDS, and the per-kilometre density states. It falls from 1,076 places/km
59
+ * over 3–5 km to a trough of **441 places/km over 7–10 km**, then climbs back and flattens onto a plateau of 760–780
60
+ * places/km from 30 km out to 100 km and beyond. That plateau is the background rate of two DIFFERENT towns wearing one
61
+ * name in one country, and it does not decay with distance because there is no reason it should. 10 km is the floor
62
+ * between the two populations. Admitting it scores 679,163 places (66.6% of the matched set); pushing the radius to 25
63
+ * km buys 8,722 more, and by then better than half of each additional kilometre is the wrong town.
64
64
  *
65
65
  * The four-row bare-GB board is insensitive across this whole range — 5 km and 25 km were both measured and select
66
- * identical rows — so the value is chosen by what the join MEANS, not by what it scores. The gate is the definition of
67
- * "this is the same place"; widening it past the floor starts handing one town's fame to another.
66
+ * identical rows — so the value is chosen by what the join MEANS, not by what it scores. The radius is the definition
67
+ * of "this is the same place"; widening it past the floor starts handing one town's fame to another.
68
68
  */
69
- export const IMPORTANCE_JOIN_GATE_KM = 10
69
+ export const IMPORTANCE_JOIN_RADIUS_KM = 10
70
70
 
71
71
  /**
72
72
  * One scored place from the source: where it is, and what it scored.
@@ -111,17 +111,17 @@ export class ImportanceIndex {
111
111
  readonly #groups: Map<string, ScoredPlace[]>
112
112
  readonly stats: ImportanceIndexStats
113
113
  /**
114
- * Places {@link find} matched inside the gate.
114
+ * Places {@link find} matched inside the radius.
115
115
  */
116
116
  matched = 0
117
117
  /**
118
- * Places {@link find} REFUSED — the key matched a scored group, but the nearest member of it was outside the gate, so
119
- * it is a different place wearing the same name.
118
+ * Places {@link find} REFUSED — the key matched a scored group, but the nearest member of it was outside the radius,
119
+ * so it is a different place wearing the same name.
120
120
  *
121
121
  * This is the number worth watching across rebuilds. A jump means the score source and the admin source have drifted
122
- * apart and the join is being asked to guess; it does not mean the gate is too tight.
122
+ * apart and the join is being asked to guess; it does not mean the radius is too tight.
123
123
  */
124
- gated = 0
124
+ refused = 0
125
125
 
126
126
  constructor(groups: Map<string, ScoredPlace[]>, stats: ImportanceIndexStats) {
127
127
  this.#groups = groups
@@ -130,7 +130,7 @@ export class ImportanceIndex {
130
130
 
131
131
  /**
132
132
  * The importance of the scored place nearest `(lat, lon)` sharing `name`'s folded key, `country` and `placetype`, or
133
- * null when there is no such place within {@link IMPORTANCE_JOIN_GATE_KM}.
133
+ * null when there is no such place within {@link IMPORTANCE_JOIN_RADIUS_KM}.
134
134
  *
135
135
  * Null is UNMEASURED. Never substitute a zero, and never fall back to a population-derived value here — the source
136
136
  * column already carries that fallback where it has one, and inventing a second one would make an absence
@@ -157,8 +157,8 @@ export class ImportanceIndex {
157
157
  }
158
158
  }
159
159
 
160
- if (!best || bestKm > IMPORTANCE_JOIN_GATE_KM) {
161
- this.gated++
160
+ if (!best || bestKm > IMPORTANCE_JOIN_RADIUS_KM) {
161
+ this.refused++
162
162
 
163
163
  return null
164
164
  }
@@ -182,47 +182,43 @@ export class ImportanceIndex {
182
182
  * 25 s.
183
183
  */
184
184
  export function loadImportanceIndex(databasePath: string): ImportanceIndex {
185
- const db = new DatabaseSync(databasePath, { readOnly: true })
186
-
187
- try {
188
- const groups = new Map<string, ScoredPlace[]>()
189
- let places = 0
190
- let unkeyable = 0
191
-
192
- for (const row of db
193
- .prepare(
194
- `SELECT s.name AS name, s.country AS country, s.placetype AS placetype,
195
- s.latitude AS latitude, s.longitude AS longitude, i.importance AS importance
196
- FROM place_importance i JOIN spr s ON s.id = i.id
197
- WHERE s.is_current != 0 AND s.is_deprecated = 0`
198
- )
199
- .iterate()) {
200
- const importance = Number(row.importance)
201
-
202
- if (!Number.isFinite(importance)) continue
203
- const nameKey = normalizeLocalityForKey(String(row.name ?? ""))
204
-
205
- if (!nameKey) {
206
- unkeyable++
207
-
208
- continue
209
- }
185
+ using db = new DatabaseClient<CandidateDatabase>(databasePath, { readOnly: true })
210
186
 
211
- const key = groupKey(nameKey, row.country as string | null, row.placetype as string | null)
212
- let group = groups.get(key)
187
+ const groups = new Map<string, ScoredPlace[]>()
188
+ let places = 0
189
+ let unkeyable = 0
213
190
 
214
- if (!group) {
215
- group = []
216
- groups.set(key, group)
217
- }
191
+ for (const row of db
192
+ .prepare(
193
+ `SELECT s.name AS name, s.country AS country, s.placetype AS placetype,
194
+ s.latitude AS latitude, s.longitude AS longitude, i.importance AS importance
195
+ FROM place_importance i JOIN spr s ON s.id = i.id
196
+ WHERE s.is_current != 0 AND s.is_deprecated = 0`
197
+ )
198
+ .iterate()) {
199
+ const importance = Number(row.importance)
218
200
 
219
- group.push({ lat: Number(row.latitude), lon: Number(row.longitude), importance })
201
+ if (!Number.isFinite(importance)) continue
202
+ const nameKey = normalizeLocalityForKey(String(row.name ?? ""))
220
203
 
221
- places++
204
+ if (!nameKey) {
205
+ unkeyable++
206
+
207
+ continue
222
208
  }
223
209
 
224
- return new ImportanceIndex(groups, { places, keys: groups.size, unkeyable })
225
- } finally {
226
- db.close()
210
+ const key = groupKey(nameKey, row.country as string | null, row.placetype as string | null)
211
+ let group = groups.get(key)
212
+
213
+ if (!group) {
214
+ group = []
215
+ groups.set(key, group)
216
+ }
217
+
218
+ group.push({ lat: Number(row.latitude), lon: Number(row.longitude), importance })
219
+
220
+ places++
227
221
  }
222
+
223
+ return new ImportanceIndex(groups, { places, keys: groups.size, unkeyable })
228
224
  }