@mailwoman/resolver-wof-sqlite 9.4.0 → 10.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (548) hide show
  1. package/README.md +8 -8
  2. package/lib/address/{point-interpolation.ts → point/interpolation.ts} +40 -38
  3. package/lib/address/point/schema.ts +132 -0
  4. package/lib/address/point.ts +68 -81
  5. package/lib/{address/index.ts → address.ts} +2 -2
  6. package/lib/ancestry/backfill.ts +24 -88
  7. package/lib/{ancestry/index.ts → ancestry.ts} +19 -15
  8. package/lib/build/candidate.ts +608 -0
  9. package/lib/build/population-corrections.ts +64 -0
  10. package/lib/build/slim.ts +338 -0
  11. package/lib/candidate/alias-bags.ts +74 -14
  12. package/lib/candidate/ancestors/schema.ts +211 -0
  13. package/lib/candidate/{ancestors-sidecar.ts → ancestors/sidecar.ts} +17 -24
  14. package/lib/candidate/country-display-names.ts +6 -20
  15. package/lib/candidate/extract-fold.ts +12 -57
  16. package/lib/candidate/fts.ts +28 -0
  17. package/lib/candidate/importance.ts +221 -0
  18. package/lib/candidate/lookup.ts +669 -0
  19. package/lib/candidate/name-roles.ts +16 -34
  20. package/lib/candidate/own-name.ts +34 -31
  21. package/lib/candidate/place-attrs.ts +20 -13
  22. package/lib/candidate/schema.ts +211 -0
  23. package/lib/candidate/scoring.ts +222 -0
  24. package/lib/capital-schema.ts +21 -17
  25. package/lib/capitals.ts +26 -24
  26. package/lib/coincident-roles.ts +74 -55
  27. package/lib/convention/schema.ts +13 -7
  28. package/lib/convention.ts +144 -0
  29. package/lib/coverage-manifest-schema.ts +34 -39
  30. package/lib/currency-backfill.ts +24 -69
  31. package/lib/env.ts +1 -1
  32. package/lib/exact-match.ts +31 -20
  33. package/lib/extracts.ts +96 -73
  34. package/lib/fst/autocomplete.ts +52 -35
  35. package/lib/fst/builder.ts +30 -36
  36. package/lib/fst/deserialize-web.ts +8 -9
  37. package/lib/fst/format.ts +41 -23
  38. package/lib/fst/freshness.ts +17 -95
  39. package/lib/fst/matcher.ts +2 -2
  40. package/lib/fst/serialize.ts +45 -60
  41. package/lib/fst/types.ts +71 -59
  42. package/lib/fts/query.ts +5 -36
  43. package/lib/fts.ts +280 -0
  44. package/lib/geonames/aliases.ts +72 -149
  45. package/lib/geonames/postal.ts +162 -77
  46. package/lib/index.ts +20 -27
  47. package/lib/interpolation.ts +43 -96
  48. package/lib/lookup.ts +137 -257
  49. package/lib/name-score.ts +9 -7
  50. package/lib/nsul/lookup.ts +36 -53
  51. package/lib/nsul/schema.ts +16 -43
  52. package/lib/paths.ts +159 -0
  53. package/lib/place-importance-schema.ts +57 -164
  54. package/lib/poi/lookup.ts +100 -109
  55. package/lib/poi/schema.ts +42 -26
  56. package/lib/polygon-schema.ts +10 -6
  57. package/lib/postal/city/alias/lookup.ts +79 -0
  58. package/lib/postal/{city-alias-schema.ts → city/alias/schema.ts} +14 -10
  59. package/lib/postal/{city-candidate-schema.ts → city/candidate-schema.ts} +26 -20
  60. package/lib/postal.ts +9 -0
  61. package/lib/postcode-point-lookup.ts +9 -19
  62. package/lib/primary-preference.ts +45 -125
  63. package/lib/proximity-rerank.ts +43 -32
  64. package/lib/ranking-weights.ts +98 -76
  65. package/lib/region-keys.ts +68 -40
  66. package/lib/reverse.ts +108 -72
  67. package/lib/schema.ts +74 -42
  68. package/lib/search-fetch.ts +90 -68
  69. package/lib/sqlite/convention-source.ts +57 -0
  70. package/lib/sqlite/utils.ts +79 -0
  71. package/lib/street/centroid/schema.ts +149 -0
  72. package/lib/street/centroid.ts +16 -25
  73. package/lib/street/{morphology-fst-builder.ts → morphology/fst/builder.ts} +56 -41
  74. package/lib/street/{morphology-fst-loader.ts → morphology/fst/loader.ts} +36 -29
  75. package/lib/street/name-lookup.ts +43 -35
  76. package/lib/street/normalize.ts +85 -216
  77. package/lib/street/segment-schema.ts +116 -43
  78. package/lib/{street/index.ts → street.ts} +3 -3
  79. package/lib/types.ts +94 -140
  80. package/lib/unified-schema.ts +29 -29
  81. package/lib/uprn/existence.ts +30 -19
  82. package/lib/uprn/lookup.ts +28 -67
  83. package/lib/uprn/schema.ts +18 -40
  84. package/lib/weights-overlay-linker.ts +204 -232
  85. package/out/address/point/interpolation.d.ts +45 -0
  86. package/out/address/point/interpolation.d.ts.map +1 -0
  87. package/out/address/{point-interpolation.js → point/interpolation.js} +38 -38
  88. package/out/address/point/interpolation.js.map +1 -0
  89. package/out/address/point/schema.d.ts +74 -0
  90. package/out/address/point/schema.d.ts.map +1 -0
  91. package/out/address/{point-schema.js → point/schema.js} +4 -20
  92. package/out/address/point/schema.js.map +1 -0
  93. package/out/address/point.d.ts +24 -21
  94. package/out/address/point.d.ts.map +1 -1
  95. package/out/address/point.js +60 -77
  96. package/out/address/point.js.map +1 -1
  97. package/out/{address/index.js → address.d.ts} +3 -3
  98. package/out/address.d.ts.map +1 -0
  99. package/out/{address/index.d.ts → address.js} +3 -3
  100. package/out/address.js.map +1 -0
  101. package/out/ancestry/backfill.d.ts +11 -64
  102. package/out/ancestry/backfill.d.ts.map +1 -1
  103. package/out/ancestry/backfill.js +18 -76
  104. package/out/ancestry/backfill.js.map +1 -1
  105. package/out/ancestry.d.ts +49 -0
  106. package/out/ancestry.d.ts.map +1 -0
  107. package/out/ancestry.js +59 -0
  108. package/out/ancestry.js.map +1 -0
  109. package/out/build/candidate.d.ts +170 -0
  110. package/out/build/candidate.d.ts.map +1 -0
  111. package/out/{build-candidate.js → build/candidate.js} +33 -102
  112. package/out/build/candidate.js.map +1 -0
  113. package/out/build/population-corrections.d.ts +52 -0
  114. package/out/build/population-corrections.d.ts.map +1 -0
  115. package/out/build/population-corrections.js +40 -0
  116. package/out/build/population-corrections.js.map +1 -0
  117. package/out/build/slim.d.ts +44 -0
  118. package/out/build/slim.d.ts.map +1 -0
  119. package/out/{build-slim.js → build/slim.js} +33 -94
  120. package/out/build/slim.js.map +1 -0
  121. package/out/candidate/alias-bags.d.ts +13 -5
  122. package/out/candidate/alias-bags.d.ts.map +1 -1
  123. package/out/candidate/alias-bags.js +55 -12
  124. package/out/candidate/alias-bags.js.map +1 -1
  125. package/out/candidate/ancestors/schema.d.ts +166 -0
  126. package/out/candidate/ancestors/schema.d.ts.map +1 -0
  127. package/out/candidate/ancestors/schema.js +131 -0
  128. package/out/candidate/ancestors/schema.js.map +1 -0
  129. package/out/candidate/ancestors/sidecar.d.ts +27 -0
  130. package/out/candidate/ancestors/sidecar.d.ts.map +1 -0
  131. package/out/candidate/{ancestors-sidecar.js → ancestors/sidecar.js} +17 -24
  132. package/out/candidate/ancestors/sidecar.js.map +1 -0
  133. package/out/candidate/country-display-names.d.ts +5 -15
  134. package/out/candidate/country-display-names.d.ts.map +1 -1
  135. package/out/candidate/country-display-names.js +6 -20
  136. package/out/candidate/country-display-names.js.map +1 -1
  137. package/out/candidate/extract-fold.d.ts +8 -16
  138. package/out/candidate/extract-fold.d.ts.map +1 -1
  139. package/out/candidate/extract-fold.js +6 -48
  140. package/out/candidate/extract-fold.js.map +1 -1
  141. package/out/candidate/fts.d.ts +19 -0
  142. package/out/candidate/fts.d.ts.map +1 -0
  143. package/out/candidate/fts.js +22 -0
  144. package/out/candidate/fts.js.map +1 -0
  145. package/out/candidate/importance.d.ts +127 -0
  146. package/out/candidate/importance.d.ts.map +1 -0
  147. package/out/candidate/importance.js +162 -0
  148. package/out/candidate/importance.js.map +1 -0
  149. package/out/candidate/lookup.d.ts +36 -0
  150. package/out/candidate/lookup.d.ts.map +1 -0
  151. package/out/candidate/lookup.js +456 -0
  152. package/out/candidate/lookup.js.map +1 -0
  153. package/out/candidate/name-roles.d.ts +10 -22
  154. package/out/candidate/name-roles.d.ts.map +1 -1
  155. package/out/candidate/name-roles.js +15 -33
  156. package/out/candidate/name-roles.js.map +1 -1
  157. package/out/candidate/own-name.d.ts +23 -25
  158. package/out/candidate/own-name.d.ts.map +1 -1
  159. package/out/candidate/own-name.js +34 -31
  160. package/out/candidate/own-name.js.map +1 -1
  161. package/out/candidate/place-attrs.d.ts +20 -13
  162. package/out/candidate/place-attrs.d.ts.map +1 -1
  163. package/out/candidate/place-attrs.js +4 -5
  164. package/out/candidate/place-attrs.js.map +1 -1
  165. package/out/candidate/schema.d.ts +120 -0
  166. package/out/candidate/schema.d.ts.map +1 -0
  167. package/out/{candidate-schema.js → candidate/schema.js} +11 -23
  168. package/out/candidate/schema.js.map +1 -0
  169. package/out/{candidate-scoring.d.ts → candidate/scoring.d.ts} +8 -9
  170. package/out/candidate/scoring.d.ts.map +1 -0
  171. package/out/candidate/scoring.js +157 -0
  172. package/out/candidate/scoring.js.map +1 -0
  173. package/out/capital-schema.d.ts +21 -17
  174. package/out/capital-schema.d.ts.map +1 -1
  175. package/out/capital-schema.js +17 -15
  176. package/out/capital-schema.js.map +1 -1
  177. package/out/capitals.d.ts +26 -24
  178. package/out/capitals.d.ts.map +1 -1
  179. package/out/capitals.js +23 -21
  180. package/out/capitals.js.map +1 -1
  181. package/out/coincident-roles.d.ts +60 -43
  182. package/out/coincident-roles.d.ts.map +1 -1
  183. package/out/coincident-roles.js +61 -50
  184. package/out/coincident-roles.js.map +1 -1
  185. package/out/convention/schema.d.ts +12 -6
  186. package/out/convention/schema.d.ts.map +1 -1
  187. package/out/convention/schema.js +6 -4
  188. package/out/convention/schema.js.map +1 -1
  189. package/out/convention.d.ts +97 -0
  190. package/out/convention.d.ts.map +1 -0
  191. package/out/convention.js +81 -0
  192. package/out/convention.js.map +1 -0
  193. package/out/coverage-manifest-schema.d.ts +33 -38
  194. package/out/coverage-manifest-schema.d.ts.map +1 -1
  195. package/out/coverage-manifest-schema.js +20 -29
  196. package/out/coverage-manifest-schema.js.map +1 -1
  197. package/out/currency-backfill.d.ts +13 -35
  198. package/out/currency-backfill.d.ts.map +1 -1
  199. package/out/currency-backfill.js +12 -39
  200. package/out/currency-backfill.js.map +1 -1
  201. package/out/env.d.ts +2 -2
  202. package/out/env.js +1 -1
  203. package/out/exact-match.d.ts +19 -10
  204. package/out/exact-match.d.ts.map +1 -1
  205. package/out/exact-match.js +31 -20
  206. package/out/exact-match.js.map +1 -1
  207. package/out/extracts.d.ts +65 -54
  208. package/out/extracts.d.ts.map +1 -1
  209. package/out/extracts.js +63 -55
  210. package/out/extracts.js.map +1 -1
  211. package/out/fst/autocomplete.d.ts +28 -20
  212. package/out/fst/autocomplete.d.ts.map +1 -1
  213. package/out/fst/autocomplete.js +38 -27
  214. package/out/fst/autocomplete.js.map +1 -1
  215. package/out/fst/builder.d.ts.map +1 -1
  216. package/out/fst/builder.js +30 -36
  217. package/out/fst/builder.js.map +1 -1
  218. package/out/fst/deserialize-web.d.ts +3 -3
  219. package/out/fst/deserialize-web.d.ts.map +1 -1
  220. package/out/fst/deserialize-web.js +8 -9
  221. package/out/fst/deserialize-web.js.map +1 -1
  222. package/out/fst/format.d.ts +41 -23
  223. package/out/fst/format.d.ts.map +1 -1
  224. package/out/fst/format.js +41 -23
  225. package/out/fst/format.js.map +1 -1
  226. package/out/fst/freshness.d.ts +11 -73
  227. package/out/fst/freshness.d.ts.map +1 -1
  228. package/out/fst/freshness.js +12 -76
  229. package/out/fst/freshness.js.map +1 -1
  230. package/out/fst/matcher.d.ts +1 -1
  231. package/out/fst/matcher.d.ts.map +1 -1
  232. package/out/fst/matcher.js +2 -2
  233. package/out/fst/matcher.js.map +1 -1
  234. package/out/fst/serialize.d.ts +30 -26
  235. package/out/fst/serialize.d.ts.map +1 -1
  236. package/out/fst/serialize.js +44 -58
  237. package/out/fst/serialize.js.map +1 -1
  238. package/out/fst/types.d.ts +71 -59
  239. package/out/fst/types.d.ts.map +1 -1
  240. package/out/fst/types.js +1 -4
  241. package/out/fst/types.js.map +1 -1
  242. package/out/{fst/index.js → fst.d.ts} +1 -1
  243. package/out/fst.d.ts.map +1 -0
  244. package/out/{fst/index.d.ts → fst.js} +1 -1
  245. package/out/fst.js.map +1 -0
  246. package/out/fts/query.d.ts +2 -27
  247. package/out/fts/query.d.ts.map +1 -1
  248. package/out/fts/query.js +5 -36
  249. package/out/fts/query.js.map +1 -1
  250. package/out/fts.d.ts +126 -0
  251. package/out/fts.d.ts.map +1 -0
  252. package/out/fts.js +188 -0
  253. package/out/fts.js.map +1 -0
  254. package/out/geonames/aliases.d.ts +26 -67
  255. package/out/geonames/aliases.d.ts.map +1 -1
  256. package/out/geonames/aliases.js +44 -121
  257. package/out/geonames/aliases.js.map +1 -1
  258. package/out/geonames/postal.d.ts +84 -50
  259. package/out/geonames/postal.d.ts.map +1 -1
  260. package/out/geonames/postal.js +115 -78
  261. package/out/geonames/postal.js.map +1 -1
  262. package/out/{geonames/index.js → geonames.d.ts} +1 -1
  263. package/out/geonames.d.ts.map +1 -0
  264. package/out/{geonames/index.d.ts → geonames.js} +1 -1
  265. package/out/geonames.js.map +1 -0
  266. package/out/index.d.ts +20 -21
  267. package/out/index.d.ts.map +1 -1
  268. package/out/index.js +14 -15
  269. package/out/index.js.map +1 -1
  270. package/out/interpolation.d.ts +15 -52
  271. package/out/interpolation.d.ts.map +1 -1
  272. package/out/interpolation.js +25 -68
  273. package/out/interpolation.js.map +1 -1
  274. package/out/lookup.d.ts +24 -53
  275. package/out/lookup.d.ts.map +1 -1
  276. package/out/lookup.js +117 -223
  277. package/out/lookup.js.map +1 -1
  278. package/out/name-score.d.ts +2 -2
  279. package/out/name-score.d.ts.map +1 -1
  280. package/out/name-score.js +9 -7
  281. package/out/name-score.js.map +1 -1
  282. package/out/nsul/lookup.d.ts +33 -34
  283. package/out/nsul/lookup.d.ts.map +1 -1
  284. package/out/nsul/lookup.js +26 -40
  285. package/out/nsul/lookup.js.map +1 -1
  286. package/out/nsul/schema.d.ts +16 -43
  287. package/out/nsul/schema.d.ts.map +1 -1
  288. package/out/nsul/schema.js +9 -35
  289. package/out/nsul/schema.js.map +1 -1
  290. package/out/{nsul/index.d.ts → nsul.d.ts} +1 -1
  291. package/out/nsul.d.ts.map +1 -0
  292. package/out/{nsul/index.js → nsul.js} +1 -1
  293. package/out/nsul.js.map +1 -0
  294. package/out/paths.d.ts +124 -0
  295. package/out/paths.d.ts.map +1 -0
  296. package/out/paths.js +104 -0
  297. package/out/paths.js.map +1 -0
  298. package/out/place-importance-schema.d.ts +49 -141
  299. package/out/place-importance-schema.d.ts.map +1 -1
  300. package/out/place-importance-schema.js +25 -140
  301. package/out/place-importance-schema.js.map +1 -1
  302. package/out/poi/lookup.d.ts +38 -42
  303. package/out/poi/lookup.d.ts.map +1 -1
  304. package/out/poi/lookup.js +67 -90
  305. package/out/poi/lookup.js.map +1 -1
  306. package/out/poi/schema.d.ts +41 -25
  307. package/out/poi/schema.d.ts.map +1 -1
  308. package/out/poi/schema.js +25 -17
  309. package/out/poi/schema.js.map +1 -1
  310. package/out/{poi/index.js → poi.d.ts} +1 -1
  311. package/out/poi.d.ts.map +1 -0
  312. package/out/{poi/index.d.ts → poi.js} +1 -1
  313. package/out/poi.js.map +1 -0
  314. package/out/polygon-schema.d.ts +10 -6
  315. package/out/polygon-schema.d.ts.map +1 -1
  316. package/out/polygon-schema.js +2 -2
  317. package/out/polygon-schema.js.map +1 -1
  318. package/out/postal/{city-alias-lookup.d.ts → city/alias/lookup.d.ts} +22 -25
  319. package/out/postal/city/alias/lookup.d.ts.map +1 -0
  320. package/out/postal/city/alias/lookup.js +49 -0
  321. package/out/postal/city/alias/lookup.js.map +1 -0
  322. package/out/postal/{city-alias-schema.d.ts → city/alias/schema.d.ts} +15 -11
  323. package/out/postal/city/alias/schema.d.ts.map +1 -0
  324. package/out/postal/{city-alias-schema.js → city/alias/schema.js} +11 -9
  325. package/out/postal/city/alias/schema.js.map +1 -0
  326. package/out/postal/city/candidate-schema.d.ts +72 -0
  327. package/out/postal/city/candidate-schema.d.ts.map +1 -0
  328. package/out/postal/city/candidate-schema.js +60 -0
  329. package/out/postal/city/candidate-schema.js.map +1 -0
  330. package/out/postal.d.ts +9 -0
  331. package/out/postal.d.ts.map +1 -0
  332. package/out/postal.js +9 -0
  333. package/out/postal.js.map +1 -0
  334. package/out/postcode-point-lookup.d.ts +9 -19
  335. package/out/postcode-point-lookup.d.ts.map +1 -1
  336. package/out/postcode-point-lookup.js +5 -17
  337. package/out/postcode-point-lookup.js.map +1 -1
  338. package/out/primary-preference.d.ts +39 -93
  339. package/out/primary-preference.d.ts.map +1 -1
  340. package/out/primary-preference.js +13 -97
  341. package/out/primary-preference.js.map +1 -1
  342. package/out/proximity-rerank.d.ts +40 -29
  343. package/out/proximity-rerank.d.ts.map +1 -1
  344. package/out/proximity-rerank.js +38 -29
  345. package/out/proximity-rerank.js.map +1 -1
  346. package/out/ranking-weights.d.ts +91 -62
  347. package/out/ranking-weights.d.ts.map +1 -1
  348. package/out/ranking-weights.js +26 -25
  349. package/out/ranking-weights.js.map +1 -1
  350. package/out/region-keys.d.ts +48 -29
  351. package/out/region-keys.d.ts.map +1 -1
  352. package/out/region-keys.js +68 -40
  353. package/out/region-keys.js.map +1 -1
  354. package/out/reverse.d.ts +75 -50
  355. package/out/reverse.d.ts.map +1 -1
  356. package/out/reverse.js +61 -49
  357. package/out/reverse.js.map +1 -1
  358. package/out/schema.d.ts +74 -42
  359. package/out/schema.d.ts.map +1 -1
  360. package/out/schema.js +4 -5
  361. package/out/schema.js.map +1 -1
  362. package/out/search-fetch.d.ts +16 -12
  363. package/out/search-fetch.d.ts.map +1 -1
  364. package/out/search-fetch.js +83 -63
  365. package/out/search-fetch.js.map +1 -1
  366. package/out/sqlite/convention-source.d.ts +25 -0
  367. package/out/sqlite/convention-source.d.ts.map +1 -0
  368. package/out/sqlite/convention-source.js +48 -0
  369. package/out/sqlite/convention-source.js.map +1 -0
  370. package/out/sqlite/utils.d.ts +45 -0
  371. package/out/sqlite/utils.d.ts.map +1 -0
  372. package/out/sqlite/utils.js +56 -0
  373. package/out/sqlite/utils.js.map +1 -0
  374. package/out/street/centroid/schema.d.ts +100 -0
  375. package/out/street/centroid/schema.d.ts.map +1 -0
  376. package/out/street/centroid/schema.js +66 -0
  377. package/out/street/centroid/schema.js.map +1 -0
  378. package/out/street/centroid.d.ts +9 -19
  379. package/out/street/centroid.d.ts.map +1 -1
  380. package/out/street/centroid.js +11 -22
  381. package/out/street/centroid.js.map +1 -1
  382. package/out/street/{morphology-fst-builder.d.ts → morphology/fst/builder.d.ts} +21 -11
  383. package/out/street/morphology/fst/builder.d.ts.map +1 -0
  384. package/out/street/{morphology-fst-builder.js → morphology/fst/builder.js} +40 -34
  385. package/out/street/morphology/fst/builder.js.map +1 -0
  386. package/out/street/morphology/fst/loader.d.ts +74 -0
  387. package/out/street/morphology/fst/loader.d.ts.map +1 -0
  388. package/out/street/{morphology-fst-loader.js → morphology/fst/loader.js} +21 -21
  389. package/out/street/morphology/fst/loader.js.map +1 -0
  390. package/out/street/name-lookup.d.ts +24 -18
  391. package/out/street/name-lookup.d.ts.map +1 -1
  392. package/out/street/name-lookup.js +32 -31
  393. package/out/street/name-lookup.js.map +1 -1
  394. package/out/street/normalize.d.ts +35 -136
  395. package/out/street/normalize.d.ts.map +1 -1
  396. package/out/street/normalize.js +74 -191
  397. package/out/street/normalize.js.map +1 -1
  398. package/out/street/segment-schema.d.ts +79 -39
  399. package/out/street/segment-schema.d.ts.map +1 -1
  400. package/out/street/segment-schema.js +71 -21
  401. package/out/street/segment-schema.js.map +1 -1
  402. package/out/{street/index.d.ts → street.d.ts} +4 -4
  403. package/out/street.d.ts.map +1 -0
  404. package/out/{street/index.js → street.js} +4 -4
  405. package/out/street.js.map +1 -0
  406. package/out/types.d.ts +69 -138
  407. package/out/types.d.ts.map +1 -1
  408. package/out/types.js +0 -6
  409. package/out/types.js.map +1 -1
  410. package/out/unified-schema.d.ts +8 -12
  411. package/out/unified-schema.d.ts.map +1 -1
  412. package/out/unified-schema.js +29 -29
  413. package/out/unified-schema.js.map +1 -1
  414. package/out/uprn/existence.d.ts +28 -17
  415. package/out/uprn/existence.d.ts.map +1 -1
  416. package/out/uprn/existence.js +26 -16
  417. package/out/uprn/existence.js.map +1 -1
  418. package/out/uprn/lookup.d.ts +14 -44
  419. package/out/uprn/lookup.d.ts.map +1 -1
  420. package/out/uprn/lookup.js +20 -56
  421. package/out/uprn/lookup.js.map +1 -1
  422. package/out/uprn/schema.d.ts +18 -40
  423. package/out/uprn/schema.d.ts.map +1 -1
  424. package/out/uprn/schema.js +10 -32
  425. package/out/uprn/schema.js.map +1 -1
  426. package/out/{uprn/index.d.ts → uprn.d.ts} +1 -1
  427. package/out/uprn.d.ts.map +1 -0
  428. package/out/{uprn/index.js → uprn.js} +1 -1
  429. package/out/uprn.js.map +1 -0
  430. package/out/weights-overlay-linker.d.ts +132 -141
  431. package/out/weights-overlay-linker.d.ts.map +1 -1
  432. package/out/weights-overlay-linker.js +86 -154
  433. package/out/weights-overlay-linker.js.map +1 -1
  434. package/package.json +94 -599
  435. package/lib/address/point-schema.ts +0 -155
  436. package/lib/build-candidate.ts +0 -632
  437. package/lib/build-slim.ts +0 -408
  438. package/lib/candidate-ancestors-schema.ts +0 -195
  439. package/lib/candidate-fts.ts +0 -46
  440. package/lib/candidate-importance.ts +0 -224
  441. package/lib/candidate-lookup.ts +0 -977
  442. package/lib/candidate-schema.ts +0 -247
  443. package/lib/candidate-scoring.ts +0 -261
  444. package/lib/convention/index.ts +0 -154
  445. package/lib/fts/index.ts +0 -361
  446. package/lib/postal/city-alias-lookup.ts +0 -97
  447. package/lib/postal/index.ts +0 -9
  448. package/lib/sqlite-convention-source.ts +0 -65
  449. package/lib/sqlite-utils.ts +0 -82
  450. package/lib/street/centroid-schema.ts +0 -154
  451. package/out/address/index.d.ts.map +0 -1
  452. package/out/address/index.js.map +0 -1
  453. package/out/address/point-interpolation.d.ts +0 -49
  454. package/out/address/point-interpolation.d.ts.map +0 -1
  455. package/out/address/point-interpolation.js.map +0 -1
  456. package/out/address/point-schema.d.ts +0 -97
  457. package/out/address/point-schema.d.ts.map +0 -1
  458. package/out/address/point-schema.js.map +0 -1
  459. package/out/ancestry/index.d.ts +0 -45
  460. package/out/ancestry/index.d.ts.map +0 -1
  461. package/out/ancestry/index.js +0 -55
  462. package/out/ancestry/index.js.map +0 -1
  463. package/out/build-candidate.d.ts +0 -184
  464. package/out/build-candidate.d.ts.map +0 -1
  465. package/out/build-candidate.js.map +0 -1
  466. package/out/build-slim.d.ts +0 -80
  467. package/out/build-slim.d.ts.map +0 -1
  468. package/out/build-slim.js.map +0 -1
  469. package/out/candidate/ancestors-sidecar.d.ts +0 -32
  470. package/out/candidate/ancestors-sidecar.d.ts.map +0 -1
  471. package/out/candidate/ancestors-sidecar.js.map +0 -1
  472. package/out/candidate-ancestors-schema.d.ts +0 -150
  473. package/out/candidate-ancestors-schema.d.ts.map +0 -1
  474. package/out/candidate-ancestors-schema.js +0 -123
  475. package/out/candidate-ancestors-schema.js.map +0 -1
  476. package/out/candidate-fts.d.ts +0 -37
  477. package/out/candidate-fts.d.ts.map +0 -1
  478. package/out/candidate-fts.js +0 -40
  479. package/out/candidate-fts.js.map +0 -1
  480. package/out/candidate-importance.d.ts +0 -132
  481. package/out/candidate-importance.d.ts.map +0 -1
  482. package/out/candidate-importance.js +0 -169
  483. package/out/candidate-importance.js.map +0 -1
  484. package/out/candidate-lookup.d.ts +0 -76
  485. package/out/candidate-lookup.d.ts.map +0 -1
  486. package/out/candidate-lookup.js +0 -768
  487. package/out/candidate-lookup.js.map +0 -1
  488. package/out/candidate-schema.d.ts +0 -155
  489. package/out/candidate-schema.d.ts.map +0 -1
  490. package/out/candidate-schema.js.map +0 -1
  491. package/out/candidate-scoring.d.ts.map +0 -1
  492. package/out/candidate-scoring.js +0 -196
  493. package/out/candidate-scoring.js.map +0 -1
  494. package/out/convention/index.d.ts +0 -106
  495. package/out/convention/index.d.ts.map +0 -1
  496. package/out/convention/index.js +0 -93
  497. package/out/convention/index.js.map +0 -1
  498. package/out/fst/index.d.ts.map +0 -1
  499. package/out/fst/index.js.map +0 -1
  500. package/out/fts/index.d.ts +0 -184
  501. package/out/fts/index.d.ts.map +0 -1
  502. package/out/fts/index.js +0 -277
  503. package/out/fts/index.js.map +0 -1
  504. package/out/geonames/index.d.ts.map +0 -1
  505. package/out/geonames/index.js.map +0 -1
  506. package/out/nsul/index.d.ts.map +0 -1
  507. package/out/nsul/index.js.map +0 -1
  508. package/out/poi/index.d.ts.map +0 -1
  509. package/out/poi/index.js.map +0 -1
  510. package/out/postal/city-alias-lookup.d.ts.map +0 -1
  511. package/out/postal/city-alias-lookup.js +0 -62
  512. package/out/postal/city-alias-lookup.js.map +0 -1
  513. package/out/postal/city-alias-schema.d.ts.map +0 -1
  514. package/out/postal/city-alias-schema.js.map +0 -1
  515. package/out/postal/city-candidate-schema.d.ts +0 -66
  516. package/out/postal/city-candidate-schema.d.ts.map +0 -1
  517. package/out/postal/city-candidate-schema.js +0 -56
  518. package/out/postal/city-candidate-schema.js.map +0 -1
  519. package/out/postal/index.d.ts +0 -9
  520. package/out/postal/index.d.ts.map +0 -1
  521. package/out/postal/index.js +0 -9
  522. package/out/postal/index.js.map +0 -1
  523. package/out/sqlite-convention-source.d.ts +0 -29
  524. package/out/sqlite-convention-source.d.ts.map +0 -1
  525. package/out/sqlite-convention-source.js +0 -57
  526. package/out/sqlite-convention-source.js.map +0 -1
  527. package/out/sqlite-utils.d.ts +0 -45
  528. package/out/sqlite-utils.d.ts.map +0 -1
  529. package/out/sqlite-utils.js +0 -57
  530. package/out/sqlite-utils.js.map +0 -1
  531. package/out/street/centroid-schema.d.ts +0 -105
  532. package/out/street/centroid-schema.d.ts.map +0 -1
  533. package/out/street/centroid-schema.js +0 -78
  534. package/out/street/centroid-schema.js.map +0 -1
  535. package/out/street/index.d.ts.map +0 -1
  536. package/out/street/index.js.map +0 -1
  537. package/out/street/morphology-fst-builder.d.ts.map +0 -1
  538. package/out/street/morphology-fst-builder.js.map +0 -1
  539. package/out/street/morphology-fst-loader.d.ts +0 -67
  540. package/out/street/morphology-fst-loader.d.ts.map +0 -1
  541. package/out/street/morphology-fst-loader.js.map +0 -1
  542. package/out/uprn/index.d.ts.map +0 -1
  543. package/out/uprn/index.js.map +0 -1
  544. /package/lib/{fst/index.ts → fst.ts} +0 -0
  545. /package/lib/{geonames/index.ts → geonames.ts} +0 -0
  546. /package/lib/{nsul/index.ts → nsul.ts} +0 -0
  547. /package/lib/{poi/index.ts → poi.ts} +0 -0
  548. /package/lib/{uprn/index.ts → uprn.ts} +0 -0
@@ -1,247 +0,0 @@
1
- /**
2
- * @copyright Sister Software
3
- * @license AGPL-3.0
4
- * @author Teffen Ellis, et al.
5
- *
6
- * Typed schema for the byte-range CANDIDATE gazetteer (`candidate.db`) — the single source of truth
7
- * for the columns shared by the BUILDER ({@link buildCandidateTable}) and the READERS (the Node
8
- * {@link WOFCandidateTableLookup} + the browser `@mailwoman/resolver-wof-wasm/httpvfs/resolver`). Before this module each
9
- * side hand-wrote the column list; a rename in one place broke the other at runtime. Now the
10
- * contract is a Kysely `Database` interface (`new DatabaseClient<CandidateDatabase>(...)` for
11
- * typed inserts) plus the table DDL as strings — so a column change is a compile error on every
12
- * consumer.
13
- *
14
- * `cand_stage` is the transient staging table the builder bulk-loads; `candidate` is the clustered
15
- * `WITHOUT ROWID` B-tree it's materialized into (same columns). The reader queries `candidate`.
16
- */
17
-
18
- import { sql, type Kysely } from "kysely"
19
-
20
- import type { CandidateAncestorsDatabase } from "#candidate-ancestors-schema"
21
- import type { CapitalTable } from "#capital-schema"
22
- import type { NameKey } from "#street/normalize"
23
-
24
- /**
25
- * One candidate row. `name_key` + the four small int keys + `neg_rank` + `spr_id` form the clustered primary key; the
26
- * rest is denormalized so a resolve is one probe (no join to `spr`). Coordinates + bbox + name are nullable at the SQL
27
- * level (a postcode extract row may lack a bbox).
28
- */
29
- export interface CandidateTable {
30
- /**
31
- * The shared {@link normalizeLocalityForKey} of the name/alias — the probe key.
32
- */
33
- name_key: NameKey
34
- /**
35
- * Small int from {@link CountryCodeTable} (shrinks the clustered key).
36
- */
37
- country_id: number
38
- /**
39
- * The place's region-tier ancestor id, or 0 (carried for the future region 2-step).
40
- */
41
- region_id: number
42
- /**
43
- * Small int from {@link PlacetypeCodeTable}.
44
- */
45
- placetype_id: number
46
- /**
47
- * `-log10(population + 1)` — ASC order = highest-population first. 0 for postcodes (no population).
48
- */
49
- neg_rank: number
50
- /**
51
- * WOF id of the place this row resolves to.
52
- */
53
- spr_id: number
54
- name: string | null
55
- latitude: number | null
56
- longitude: number | null
57
- min_lat: number | null
58
- min_lon: number | null
59
- max_lat: number | null
60
- max_lon: number | null
61
- population: number | null
62
- /**
63
- * 1 when the row is the place's canonical name (vs an alias/abbrev).
64
- */
65
- is_primary: number | null
66
- /**
67
- * Blended place importance in [0, 1] — the toponym-fame prior the bare-city-name class is decided on (#28). NULL
68
- * means the score source had no row for this place: UNMEASURED, never "an importance of zero" (meaning-of-zero).
69
- * Constant across every row of one place — primary, alias and abbrev alike — because it is a property of the PLACE,
70
- * not of the name that reached it, which is what lets a bare `Moscow` inherit Москва's score through the alias row.
71
- *
72
- * **THIS IS THE PRE-SPLIT CONFLATION, AND THE NAME SAYS SO.** It is `place_importance.importance` copied verbatim
73
- * from the score source — the bounded blend `place-importance-schema.ts`'s `blendImportance` writes (the
74
- * concordance's encyclopedia-derived channel clamped around a population-derived base); that module calls the column
75
- * DEPRECATED. It is NOT the split `encyclopedic` channel, and the two must not be conflated in a future build:
76
- * writing the split value here instead was measured on 2026-08-10 and makes the ranking key INERT on three of the
77
- * four rows it exists to fix. The reason is coverage, not principle — the encyclopedia-concordance join in
78
- * `admin-global-priority-importance.db` reaches 133,888 of 702,709 scored places and only eleven countries
79
- * (US/FR/GB/DE/IT/ES/NL/JP/CN/KR/TW). CA, AU and RU have ZERO concordance rows, so Whitby CA, Windsor CA and Epping
80
- * AU carry the population fallback and nothing else. Under the strict split those three become unmeasured, the
81
- * consumer's positive-evidence-only rule leaves them exactly where population put them (first), and the famous GB
82
- * bearer can never overtake them. The conflated column is the only one on which every bearer of a name is scored on a
83
- * single comparable scale, which is the precondition for comparing them at all.
84
- *
85
- * So a consumer reads this as "fame, with population standing in where fame was never measured" — the legacy blended
86
- * semantics — and NOT as "this place has an encyclopedia entry of this importance". When the score source grows a
87
- * real `encyclopedic` column for every country, add a SECOND column rather than redefining this one.
88
- */
89
- importance: number | null
90
- /**
91
- * The NAME'S detected role on this row, or NULL (#1730). Two build-time detectors stamp `is_primary = 0` rows only:
92
- *
93
- * - `'abbr'` — provenance-based: the surface is a WOF `variant` name in one of the place's country's official languages
94
- * (or English) — the #936 signal, measured at a 13× key-collision rate vs preferred names.
95
- * - `'gloss'` — anomaly-based: the row belongs to a place whose key count crosses the gloss threshold with a non-admin
96
- * placetype and NO measured prominence (population absent AND importance unmeasured) — the translation-gloss
97
- * fingerprint (#1730's sweep; `Poisson` → a US fish-name place). Provenance CANNOT separate a gloss from an exonym
98
- * (WOF imported both as `x_preferred`), which is why this detector is an anomaly test and stamps only the certain
99
- * core.
100
- *
101
- * NULL = no role detected. The column is WRITE-ONLY in this build generation: no ranking consumer reads it — a rank
102
- * penalty is its own future, D-rule-conditional step with the `gloss_key` board as regression check.
103
- */
104
- name_role: string | null
105
- }
106
-
107
- /**
108
- * `(id → ISO country code)` dictionary.
109
- */
110
- export interface CountryCodeTable {
111
- id: number
112
- code: string
113
- }
114
-
115
- /**
116
- * `(id → placetype)` dictionary.
117
- */
118
- export interface PlacetypeCodeTable {
119
- id: number
120
- placetype: string
121
- }
122
-
123
- /**
124
- * The candidate database schema for `new DatabaseClient<CandidateDatabase>(...)`. Extends the ancestors sidecar
125
- * (`candidate_ancestor` + `candidate_interval` — see candidate-ancestors-schema.ts for the encoding decision), so the
126
- * builder's one typed client covers every table in the artifact.
127
- */
128
- export interface CandidateDatabase extends CandidateAncestorsDatabase {
129
- /**
130
- * The clustered `WITHOUT ROWID` lookup table the reader probes.
131
- */
132
- candidate: CandidateTable
133
- /**
134
- * Transient staging table (same columns); dropped once `candidate` is materialized.
135
- */
136
- cand_stage: CandidateTable
137
- country_codes: CountryCodeTable
138
- placetype_codes: PlacetypeCodeTable
139
- /**
140
- * The capital-status reference carried in-artifact (#1880's distribution home) — see capital-schema.ts.
141
- */
142
- capital: CapitalTable
143
- }
144
-
145
- /**
146
- * The `candidate`/`cand_stage` columns in clustered-key order. The materialization `INSERT INTO candidate SELECT … FROM
147
- * cand_stage` derives its column list from this, so the two tables can't drift. Keep in sync with
148
- * {@link CandidateTable}.
149
- */
150
- export const CANDIDATE_COLUMNS = [
151
- "name_key",
152
- "country_id",
153
- "region_id",
154
- "placetype_id",
155
- "neg_rank",
156
- "spr_id",
157
- "name",
158
- "latitude",
159
- "longitude",
160
- "min_lat",
161
- "min_lon",
162
- "max_lat",
163
- "max_lon",
164
- "population",
165
- "is_primary",
166
- // Appended, never inserted mid-list: the first six entries ARE the clustered primary key, and the
167
- // positional `INSERT INTO cand_stage VALUES (…)` in the builder binds by position.
168
- "importance",
169
- "name_role",
170
- ] as const
171
-
172
- /**
173
- * Create the code dictionaries + the transient staging table — called before the build's load passes. `cand_stage`
174
- * mirrors {@link CandidateTable} but every column is nullable (the loader fills them positionally). Pass a
175
- * {@link DatabaseClient} (or any `Kysely`) over the candidate DB.
176
- */
177
- export async function createCandidateStagingTables(db: Kysely<CandidateDatabase>): Promise<void> {
178
- await db.schema
179
- .createTable("country_codes")
180
- .addColumn("id", "integer", (c) => c.primaryKey())
181
- .addColumn("code", "text", (c) => c.unique())
182
- .execute()
183
-
184
- await db.schema
185
- .createTable("placetype_codes")
186
- .addColumn("id", "integer", (c) => c.primaryKey())
187
- .addColumn("placetype", "text", (c) => c.unique())
188
- .execute()
189
-
190
- await db.schema
191
- .createTable("cand_stage")
192
- .addColumn("name_key", "text")
193
- .addColumn("country_id", "integer")
194
- .addColumn("region_id", "integer")
195
- .addColumn("placetype_id", "integer")
196
- .addColumn("neg_rank", "real")
197
- .addColumn("spr_id", "integer")
198
- .addColumn("name", "text")
199
- .addColumn("latitude", "real")
200
- .addColumn("longitude", "real")
201
- .addColumn("min_lat", "real")
202
- .addColumn("min_lon", "real")
203
- .addColumn("max_lat", "real")
204
- .addColumn("max_lon", "real")
205
- .addColumn("population", "integer")
206
- .addColumn("is_primary", "integer")
207
- .addColumn("importance", "real")
208
- .addColumn("name_role", "text")
209
- .execute()
210
- }
211
-
212
- /**
213
- * Create the clustered `WITHOUT ROWID` lookup table — called after staging, before the VACUUM. The first six columns
214
- * form the clustered primary key (population-ranked via `neg_rank`).
215
- */
216
- export async function createCandidateTable(db: Kysely<CandidateDatabase>): Promise<void> {
217
- await db.schema
218
- .createTable("candidate")
219
- .addColumn("name_key", "text", (c) => c.notNull())
220
- .addColumn("country_id", "integer", (c) => c.notNull())
221
- .addColumn("region_id", "integer", (c) => c.notNull())
222
- .addColumn("placetype_id", "integer", (c) => c.notNull())
223
- .addColumn("neg_rank", "real", (c) => c.notNull())
224
- .addColumn("spr_id", "integer", (c) => c.notNull())
225
- .addColumn("name", "text")
226
- .addColumn("latitude", "real")
227
- .addColumn("longitude", "real")
228
- .addColumn("min_lat", "real")
229
- .addColumn("min_lon", "real")
230
- .addColumn("max_lat", "real")
231
- .addColumn("max_lon", "real")
232
- .addColumn("population", "integer")
233
- .addColumn("is_primary", "integer")
234
- .addColumn("importance", "real")
235
- .addColumn("name_role", "text")
236
- .addPrimaryKeyConstraint("candidate_pk", [
237
- "name_key",
238
- "country_id",
239
- "region_id",
240
- "placetype_id",
241
- "neg_rank",
242
- "spr_id",
243
- ])
244
- // `WITHOUT ROWID` has no first-class builder; the raw modifier is the idiomatic fallback.
245
- .modifyEnd(sql`without rowid`)
246
- .execute()
247
- }
@@ -1,261 +0,0 @@
1
- /**
2
- * @copyright Sister Software
3
- * @license AGPL-3.0
4
- * @author Teffen Ellis, et al.
5
- *
6
- * How a raw `place_search` row becomes a scored `PlaceCandidate`, and how the resulting pool is
7
- * ordered — the weighted-sum score and the exact-match tiering that ranks over it.
8
- */
9
-
10
- import { compareReferential, referentialFromPopulation } from "@mailwoman/core/resolver"
11
- import { haversineKm } from "@mailwoman/spatial"
12
- import type { DatabaseClient } from "@mailwoman/sqlite/client"
13
-
14
- import { exactMatchIDs, officialNameIDs } from "#exact-match"
15
- import { foldQueryText } from "#fts/index"
16
- import { populationBoostTerm, type RankingWeights } from "#ranking-weights"
17
- import type { RawSearchRow } from "#search-fetch"
18
- import type { FindPlaceQuery, PlaceCandidate, WOFPlacetype } from "#types"
19
-
20
- /**
21
- * Score one raw FTS row into a `PlaceCandidate`: the weighted sum over the negated BM25 baseline, the placetype /
22
- * country / parent boosts, the length penalty, the proximity and population terms, and the carried fields (referential,
23
- * encyclopedic, bbox) consumers read. `queryLen` is the query text's length, hoisted out of the per-row loop.
24
- */
25
- export function candidateFromSearchRow(
26
- row: RawSearchRow,
27
- context: {
28
- query: FindPlaceQuery
29
- placetypes: WOFPlacetype[] | null
30
- queryLen: number
31
- weights: RankingWeights
32
- }
33
- ): PlaceCandidate {
34
- const { query, placetypes, queryLen, weights } = context
35
-
36
- // SQLite's bm25() returns a lower-is-better score (negative for matches). Negate so we
37
- // start from a higher-is-better baseline.
38
- let score = -row.rank
39
-
40
- if (placetypes && placetypes.length && placetypes.includes(row.placetype as WOFPlacetype)) {
41
- score += weights.placetypeMatchBoost
42
- }
43
-
44
- if (!placetypes && row.placetype === "locality") {
45
- score += weights.localityImplicitBoost
46
- }
47
-
48
- if (query.country && row.country === query.country) {
49
- score += weights.countryMatchBoost
50
- }
51
-
52
- if (query.parentID !== undefined) {
53
- score += row.parent_id === query.parentID ? weights.directChildBoost : weights.descendantBoost
54
- }
55
-
56
- const extraLen = Math.max(0, row.name.length - queryLen - 3)
57
- score -= (weights.lengthPenaltyWeight * extraLen) / 10
58
-
59
- // Proximity boost: only applied when the query carries `near` AND the candidate has real
60
- // coordinates. The formula decays smoothly with distance so close-but-not-exact hits
61
- // still benefit; tunable via proximityBoost + proximityScaleKm.
62
- let distanceKm: number | undefined
63
- // The best decayed-distance term over `near` + every `bias` point (each point's term is
64
- // scaled by its weight; the MAX wins — a candidate near ANY hint is "nearby"). Carried
65
- // into the exact-tier prominence sort below when hints are present.
66
- let proximityTerm = 0
67
-
68
- if (row.lat !== null && row.lon !== null && !(row.lat === 0 && row.lon === 0)) {
69
- const hints: Array<{ lat: number; lon: number; weight: number }> = []
70
-
71
- if (query.near) {
72
- hints.push({ lat: query.near.lat, lon: query.near.lon, weight: 1 })
73
- }
74
-
75
- for (const b of query.bias ?? []) {
76
- hints.push({ lat: b.lat, lon: b.lon, weight: b.weight ?? 1 })
77
- }
78
-
79
- let scoreTerm = 0
80
-
81
- for (const h of hints) {
82
- const d = haversineKm(h.lat, h.lon, row.lat, row.lon)
83
- const decay = h.weight / (1 + d / weights.proximityScaleKm)
84
- const prom = decay * weights.biasBoost
85
-
86
- if (prom > proximityTerm) {
87
- proximityTerm = prom
88
- distanceKm = d
89
- scoreTerm = decay * weights.proximityBoost
90
- }
91
- }
92
-
93
- score += scoreTerm
94
- }
95
-
96
- // Population boost: capped at `populationBoost` magnitude at `10^populationScaleLog10`
97
- // people. Missing population → no contribution. Never penalizes.
98
- const popTerm = populationBoostTerm(row.population, weights)
99
- score += popTerm
100
-
101
- // Combined prominence for the exact-tier sort when proximity hints are present: population
102
- // and nearness in the SAME additive units, so the map view / the user's location can win a
103
- // cross-country postcode tie without a hard filter.
104
- const prominence = popTerm + proximityTerm
105
-
106
- const candidate: PlaceCandidate = {
107
- id: row.id,
108
- prominence,
109
- name: row.name,
110
- placetype: row.placetype as WOFPlacetype,
111
- country: row.country ?? "",
112
- lat: row.lat ?? 0,
113
- lon: row.lon ?? 0,
114
- parent_id: row.parent_id ?? undefined,
115
- score,
116
- }
117
-
118
- if (distanceKm !== undefined) {
119
- candidate.distanceKm = distanceKm
120
- }
121
-
122
- if (row.population !== null && row.population > 0) {
123
- candidate.population = row.population
124
- // The named ranking key (ROAD_TO_V9 §2). DERIVED, not stored — a pure function of the
125
- // population already on this row, so it cannot drift from what the ordering uses.
126
- candidate.referential = referentialFromPopulation(row.population)
127
- }
128
-
129
- // Carried for consumers (annotations / API surfaces). No ranking site reads it.
130
- if (row.encyclopedic !== null) {
131
- candidate.encyclopedic = row.encyclopedic
132
- }
133
-
134
- // Candidate bbox — parity with the WASM lookup (resolver-wof-wasm/lookup.ts), whose
135
- // consumers (the demo cascade's region constraint) read it. Without this the Node
136
- // backend's region→bbox constraint is dead and disambiguation falls to population
137
- // ranking (the Springfield-IL→MO failure the #524 smoke eval caught).
138
- if (row.min_latitude != null && row.max_latitude != null && row.min_longitude != null && row.max_longitude != null) {
139
- candidate.bbox = {
140
- minLat: row.min_latitude,
141
- maxLat: row.max_latitude,
142
- minLon: row.min_longitude,
143
- maxLon: row.max_longitude,
144
- }
145
- }
146
-
147
- return candidate
148
- }
149
-
150
- /**
151
- * Order `candidates` IN PLACE — the exact-match tier first when the extract can answer the name probes, otherwise plain
152
- * weighted-score order. Every candidate is stamped with its `exactMatch` flag on the way through.
153
- */
154
- export function rankCandidates<DB>(
155
- candidates: PlaceCandidate[],
156
- options: {
157
- db: DatabaseClient<DB>
158
- schemaName: string
159
- query: FindPlaceQuery
160
- weights: RankingWeights
161
- }
162
- ): void {
163
- const { db, schemaName, query, weights } = options
164
-
165
- // Exact-match tiering: a candidate whose name OR any alias equals the query text (case-folded)
166
- // ranks above any partial match, with the weighted-sum score (incl. population) breaking ties
167
- // WITHIN a tier. See the RankingWeights.exactMatchTiering docstring for why this aligns the
168
- // population prior rather than overriding it. One cheap indexed lookup over the candidate ids.
169
- // Runs even for a SINGLE candidate so `exactMatch` is stamped consistently (parity with the
170
- // WASM lookup) — a sole alias hit ("New York City" → New York) must still carry the flag the
171
- // demo cascade / #369 re-rank read.
172
- if (weights.exactMatchTiering && candidates.length) {
173
- const exactIDs = exactMatchIDs(
174
- db,
175
- schemaName,
176
- candidates.map((c) => c.id as number),
177
- query.text
178
- )
179
-
180
- // Stamp the tier onto every candidate (not just when the tiering sort fires) so a downstream
181
- // re-rank — #369's postcode-anchor country pin in `resolveTree` — can keep the country pin from
182
- // crossing the exact/partial boundary ("ME" → Maine, not the more-populous Missouri).
183
- for (const c of candidates) {
184
- c.exactMatch = exactIDs.has(c.id as number)
185
- }
186
-
187
- if (exactIDs.size) {
188
- // #905: WITHIN the exact tier, population is the PRIMARY key and the weighted score
189
- // only breaks population ties. Exactness saturates text relevance, and the bm25
190
- // residue inside `score` is length-noise (see the fetch-site comment), so letting it
191
- // order the tier is what sent unscoped "Paris" to an Ohio township. The partial tier
192
- // keeps score order — text relevance still means something there. This makes the
193
- // exactMatchTiering docstring literal: match quality primary, prominence within.
194
- //
195
- // #912 sub-tier: a NAME-exact candidate (spr.name equals the query) outranks an
196
- // ALIAS-exact one ('Paris' the place beats 'Paris Township' held via alias 'Paris').
197
- // The place's own name is a stronger identity claim than an alias — aliases exist to
198
- // widen recall, not to tie primaries. ME→Maine is untouched: 'ME' name-exact-matches
199
- // nothing, so the alias sub-tier still decides there. Population orders within each
200
- // sub-tier as before.
201
- const needle = foldQueryText(query.text)
202
-
203
- // #936 option 3: an OFFICIAL name (preferred form in an official language of the place's
204
- // country, `names.official = 1`) counts as the place's own name for the sub-tier — "Åbo" is
205
- // Turku's name, not merely its alias. Floor-conditioned on the holder's population (see the
206
- // RankingWeights docstring for the measured 100k boundary). officialIDs ⊆ exactIDs by
207
- // construction (official rows are names rows), so only the sub-tier KIND changes.
208
- const officialIDs = weights.officialNameExact
209
- ? officialNameIDs(
210
- db,
211
- schemaName,
212
- candidates
213
- .filter((c) => exactIDs.has(c.id as number) && (c.population ?? 0) >= weights.officialNameExactFloor)
214
- .map((c) => c.id as number),
215
- query.text
216
- )
217
- : undefined
218
-
219
- const kind = (c: PlaceCandidate): number => {
220
- if (!exactIDs.has(c.id as number)) return 0
221
-
222
- if (foldQueryText(String(c.name ?? "")) === needle) return 2
223
-
224
- return officialIDs?.has(c.id as number) ? 2 : 1
225
- }
226
-
227
- // With proximity hints (near/bias), prominence (population + nearness, same units)
228
- // replaces raw population as the within-tier key — the 48026 rule: the map view or
229
- // the user's location breaks a cross-country postcode tie. Without hints, REFERENTIAL
230
- // ordering decides.
231
- //
232
- // ROAD_TO_V9 §2: this is the site that "orders namesakes", so it is the site that has to
233
- // say what it orders by. `compareReferential` is referential DESC with raw population as
234
- // the tiebreak, which is provably the SAME ORDER as the `(b.population ?? 0) - (a.population ?? 0)`
235
- // it replaces — referential is strictly increasing in population below saturation and
236
- // constant above it, and the tiebreak restores the order in the saturated tail. Measured
237
- // zero-delta, not assumed: see `place-importance-schema.test.ts` and `resolver-referential-ranking.test.ts`.
238
- // Encyclopedic importance is not, and must not become, an input here.
239
- const hasHints = !!query.near || (query.bias?.length ?? 0) > 0
240
-
241
- candidates.sort((a, b) => {
242
- const ax = kind(a)
243
- const bx = kind(b)
244
-
245
- if (bx !== ax) return bx - ax
246
-
247
- if (ax >= 1) {
248
- if (hasHints) return (b.prominence ?? 0) - (a.prominence ?? 0) || b.score - a.score
249
-
250
- return compareReferential(a, b) || b.score - a.score
251
- }
252
-
253
- return b.score - a.score
254
- })
255
-
256
- return
257
- }
258
- }
259
-
260
- candidates.sort((a, b) => b.score - a.score)
261
- }
@@ -1,154 +0,0 @@
1
- /**
2
- * @copyright Sister Software
3
- * @license AGPL-3.0
4
- * @author Teffen Ellis, et al.
5
- *
6
- * The **Geographic Rule Engine** convention model (Direction E, #289 — see
7
- * `docs/articles/plan/2026-06-05-geographic-rule-engine.md` and epic #288).
8
- *
9
- * A `Convention` is a declarative resolution profile attached to a Who's-On-First admin polygon.
10
- * The engine deep-merges the conventions along a resolved place's ancestor chain — country →
11
- * region → … → locality, most-specific winning — and the backend dispatches the named strategies
12
- * in `candidateStrategies`, first to return candidates wins.
13
- *
14
- * This module is the backend-agnostic core: the convention TYPES, the deep-merge, and the seed
15
- * source. The strategy IMPLEMENTATIONS are SQL-bound and live in `lookup.ts`, registered by
16
- * name.
17
- *
18
- * For the existing EU locales (DE/FR/GB/NL) the seed source is empty, so every query resolves to
19
- * `WORLD_DEFAULT` and the dispatch is byte-identical to the pre-engine coordinate-first path. JP
20
- * / KR / TW add rows here (and #290 swaps the seed map for a build-from-source sqlite-backed
21
- * source).
22
- */
23
-
24
- import type { FindPlaceQuery, PlaceCandidate } from "#types"
25
-
26
- /**
27
- * Soft-scoring weights for the `postcode_area_resolution` strategy: `pc·S_pc + name·S_name + pop·S_pop`.
28
- */
29
- export interface ScoringWeights {
30
- pc: number
31
- name: number
32
- pop: number
33
- }
34
-
35
- /**
36
- * A geographically-scoped resolution profile. Namespaced sections grow per phase; #289 ships the dispatch + scoring
37
- * slice (`candidateStrategies` + `scoringWeights`). Later phases add `fieldMapping` (locale semantics for `locator[]`),
38
- * `tokenNormalization`, etc.
39
- */
40
- export interface Convention {
41
- /**
42
- * Ordered strategy names the dispatcher runs; the first to return a non-null result wins.
43
- */
44
- candidateStrategies?: string[]
45
- /**
46
- * Weights for `postcode_area_resolution`'s soft-score. Partial — a layer may nudge one weight and inherit the rest
47
- * from the layers below it (`resolveConvention` fills any gaps from WORLD_DEFAULT).
48
- */
49
- scoringWeights?: Partial<ScoringWeights>
50
- }
51
-
52
- /**
53
- * A fully-resolved convention: every field present, weights complete. What `resolveConvention` returns and what
54
- * strategies consume.
55
- */
56
- export interface ResolvedConvention {
57
- candidateStrategies: string[]
58
- scoringWeights: ScoringWeights
59
- }
60
-
61
- /**
62
- * The base layer every ancestor chain starts from. Reproduces the pre-engine coordinate-first behavior exactly: try
63
- * `postcode_area_resolution`, else fall back to fuzzy name match; soft-score weights 0.6 / 0.3 / 0.1. Changing these
64
- * changes EU behavior — don't, without a byte-stability run.
65
- */
66
- export const WORLD_DEFAULT: ResolvedConvention = {
67
- candidateStrategies: ["postcode_area_resolution", "fallback_fuzzy_name_match"],
68
- scoringWeights: { pc: 0.6, name: 0.3, pop: 0.1 },
69
- }
70
-
71
- /**
72
- * The strategy names the backend registers. The single source of truth shared by the dispatch registry and the
73
- * build-time validator, so an authored convention that names a non-existent strategy is caught at build (loud) rather
74
- * than silently skipped at runtime.
75
- */
76
- export const BUILTIN_STRATEGY_NAMES = ["postcode_area_resolution", "fallback_fuzzy_name_match"] as const
77
-
78
- /**
79
- * Table name for the convention asset (#290). Carried here so the build script, the runtime source, and the extract
80
- * auto-detect all agree.
81
- */
82
- export const ADDRESS_CONVENTION_TABLE = "address_convention"
83
-
84
- /**
85
- * A named resolution primitive. Returns `null` to abstain (condition unmet / no data) → the dispatcher tries the next
86
- * strategy; returns an array (possibly empty) to claim the result.
87
- */
88
- export type Strategy = (query: FindPlaceQuery, convention: ResolvedConvention) => Promise<PlaceCandidate[] | null>
89
-
90
- /**
91
- * Look up a convention record by WOF polygon id. Returns `undefined` when the polygon has no override.
92
- */
93
- export interface ConventionSource {
94
- get(wofID: number): Convention | undefined
95
- }
96
-
97
- /**
98
- * In-memory convention source seeded from a `{ wofID: Convention }` map. Empty for the EU locales (they ride
99
- * `WORLD_DEFAULT`); JP / KR / TW add rows. #290 replaces this with a sqlite-backed source built from source, same
100
- * distributable-asset discipline as `postcode-locality-intl.db`.
101
- */
102
- export class SeedConventionSource implements ConventionSource {
103
- readonly #rows: Map<number, Convention>
104
-
105
- constructor(rows: Record<number, Convention> = {}) {
106
- this.#rows = new Map(Object.entries(rows).map(([k, v]) => [Number(k), v]))
107
- }
108
-
109
- get(wofID: number): Convention | undefined {
110
- return this.#rows.get(wofID)
111
- }
112
- }
113
-
114
- /**
115
- * Deep-merge convention layers, later (more-specific) layers winning per field. `candidateStrategies` is replaced
116
- * wholesale — a convention names its full ordered list, it does not append. `scoringWeights` is merged key-by-key so a
117
- * locality can nudge one weight without restating the others.
118
- */
119
- export function mergeConventions(base: Convention, ...overrides: Array<Convention | undefined>): Convention {
120
- const out: Convention = {
121
- candidateStrategies: base.candidateStrategies ? [...base.candidateStrategies] : undefined,
122
- scoringWeights: base.scoringWeights ? { ...base.scoringWeights } : undefined,
123
- }
124
-
125
- for (const o of overrides) {
126
- if (!o) continue
127
-
128
- if (o.candidateStrategies !== undefined) {
129
- out.candidateStrategies = [...o.candidateStrategies]
130
- }
131
-
132
- if (o.scoringWeights !== undefined) {
133
- out.scoringWeights = { ...(out.scoringWeights ?? WORLD_DEFAULT.scoringWeights), ...o.scoringWeights }
134
- }
135
- }
136
-
137
- return out
138
- }
139
-
140
- /**
141
- * Resolve the effective convention for a place given its ancestor chain, ordered MOST-GENERAL → MOST-SPECIFIC (country,
142
- * region, …, locality). Starts from `WORLD_DEFAULT` so every field is defined regardless of which (if any) ancestors
143
- * carry an override.
144
- */
145
- export function resolveConvention(source: ConventionSource, ancestorIDs: readonly number[]): ResolvedConvention {
146
- const layers = ancestorIDs.map((id) => source.get(id))
147
- const merged = mergeConventions(WORLD_DEFAULT, ...layers)
148
-
149
- return {
150
- candidateStrategies: merged.candidateStrategies ?? WORLD_DEFAULT.candidateStrategies,
151
- // Fill any weight gaps from the base so strategies always see a complete set.
152
- scoringWeights: { ...WORLD_DEFAULT.scoringWeights, ...merged.scoringWeights },
153
- }
154
- }