@mailwoman/resolver-wof-sqlite 9.1.0 → 9.3.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 (501) hide show
  1. package/README.md +36 -20
  2. package/lib/address/index.ts +9 -0
  3. package/{address-point-interpolation.ts → lib/address/point-interpolation.ts} +40 -28
  4. package/{address-point-schema.ts → lib/address/point-schema.ts} +34 -8
  5. package/lib/address/point.ts +280 -0
  6. package/{ancestry-backfill.ts → lib/ancestry/backfill.ts} +14 -19
  7. package/{ancestry.ts → lib/ancestry/index.ts} +13 -8
  8. package/{build-candidate.ts → lib/build-candidate.ts} +243 -199
  9. package/{build-slim.ts → lib/build-slim.ts} +153 -168
  10. package/lib/candidate/alias-bags.ts +56 -0
  11. package/lib/candidate/ancestors-sidecar.ts +204 -0
  12. package/lib/candidate/country-display-names.ts +79 -0
  13. package/lib/candidate/extract-fold.ts +138 -0
  14. package/lib/candidate/name-roles.ts +238 -0
  15. package/lib/candidate/own-name.ts +146 -0
  16. package/lib/candidate/place-attrs.ts +44 -0
  17. package/lib/candidate-ancestors-schema.ts +195 -0
  18. package/{candidate-fts.ts → lib/candidate-fts.ts} +7 -5
  19. package/{candidate-importance.ts → lib/candidate-importance.ts} +54 -57
  20. package/lib/candidate-lookup.ts +976 -0
  21. package/{candidate-schema.ts → lib/candidate-schema.ts} +34 -6
  22. package/lib/candidate-scoring.ts +261 -0
  23. package/lib/capital-schema.ts +89 -0
  24. package/lib/capitals.ts +148 -0
  25. package/{coincident-roles.ts → lib/coincident-roles.ts} +75 -19
  26. package/{convention.ts → lib/convention/index.ts} +5 -5
  27. package/lib/convention/schema.ts +72 -0
  28. package/{coverage-manifest-schema.ts → lib/coverage-manifest-schema.ts} +15 -16
  29. package/lib/currency-backfill.ts +334 -0
  30. package/lib/env.ts +50 -0
  31. package/lib/exact-match.ts +113 -0
  32. package/{sharding.ts → lib/extracts.ts} +63 -60
  33. package/lib/fst/autocomplete.ts +176 -0
  34. package/{fst-builder.ts → lib/fst/builder.ts} +30 -27
  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} +42 -75
  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} +28 -23
  43. package/{fts-query.ts → lib/fts/query.ts} +2 -2
  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} +16 -15
  47. package/{index.ts → lib/index.ts} +52 -48
  48. package/{interpolation.ts → lib/interpolation.ts} +137 -41
  49. package/lib/lookup.ts +861 -0
  50. package/{name-score.ts → lib/name-score.ts} +6 -4
  51. package/lib/nsul/index.ts +8 -0
  52. package/lib/nsul/lookup.ts +144 -0
  53. package/lib/nsul/schema.ts +130 -0
  54. package/{place-importance-schema.ts → lib/place-importance-schema.ts} +70 -22
  55. package/lib/poi/index.ts +8 -0
  56. package/{poi-lookup.ts → lib/poi/lookup.ts} +32 -39
  57. package/{poi-schema.ts → lib/poi/schema.ts} +10 -6
  58. package/lib/polygon-schema.ts +47 -0
  59. package/{postal-city-alias-lookup.ts → lib/postal/city-alias-lookup.ts} +15 -21
  60. package/{postal-city-candidate-schema.ts → lib/postal/city-candidate-schema.ts} +4 -2
  61. package/lib/postal/index.ts +9 -0
  62. package/{postcode-point-lookup.ts → lib/postcode-point-lookup.ts} +17 -15
  63. package/lib/primary-preference.ts +226 -0
  64. package/lib/proximity-rerank.ts +120 -0
  65. package/{ranking-weights.ts → lib/ranking-weights.ts} +30 -4
  66. package/lib/region-keys.ts +144 -0
  67. package/{reverse.ts → lib/reverse.ts} +45 -56
  68. package/{schema.ts → lib/schema.ts} +11 -1
  69. package/lib/search-fetch.ts +257 -0
  70. package/{sqlite-convention-source.ts → lib/sqlite-convention-source.ts} +9 -10
  71. package/lib/sqlite-utils.ts +83 -0
  72. package/{street-centroid-schema.ts → lib/street/centroid-schema.ts} +12 -6
  73. package/{street-centroid.ts → lib/street/centroid.ts} +26 -28
  74. package/lib/street/index.ts +13 -0
  75. package/{street-morphology-fst-builder.ts → lib/street/morphology-fst-builder.ts} +24 -14
  76. package/{street-morphology-fst-loader.ts → lib/street/morphology-fst-loader.ts} +14 -12
  77. package/{street-name-lookup.ts → lib/street/name-lookup.ts} +14 -30
  78. package/lib/street/normalize.ts +572 -0
  79. package/{street-segment-schema.ts → lib/street/segment-schema.ts} +13 -8
  80. package/{types.ts → lib/types.ts} +49 -9
  81. package/{unified-schema.ts → lib/unified-schema.ts} +21 -25
  82. package/lib/uprn/existence.ts +84 -0
  83. package/lib/uprn/index.ts +9 -0
  84. package/lib/uprn/lookup.ts +206 -0
  85. package/lib/uprn/schema.ts +124 -0
  86. package/lib/weights-overlay-linker.ts +878 -0
  87. package/out/address/index.d.ts +9 -0
  88. package/out/address/index.d.ts.map +1 -0
  89. package/out/address/index.js +9 -0
  90. package/out/address/index.js.map +1 -0
  91. package/out/{address-point-interpolation.d.ts → address/point-interpolation.d.ts} +11 -10
  92. package/out/address/point-interpolation.d.ts.map +1 -0
  93. package/out/{address-point-interpolation.js → address/point-interpolation.js} +29 -23
  94. package/out/address/point-interpolation.js.map +1 -0
  95. package/out/{address-point-schema.d.ts → address/point-schema.d.ts} +30 -10
  96. package/out/address/point-schema.d.ts.map +1 -0
  97. package/out/{address-point-schema.js → address/point-schema.js} +7 -3
  98. package/out/address/point-schema.js.map +1 -0
  99. package/out/{address-point.d.ts → address/point.d.ts} +16 -8
  100. package/out/address/point.d.ts.map +1 -0
  101. package/out/address/point.js +191 -0
  102. package/out/address/point.js.map +1 -0
  103. package/out/{ancestry-backfill.d.ts → ancestry/backfill.d.ts} +7 -5
  104. package/out/ancestry/backfill.d.ts.map +1 -0
  105. package/out/{ancestry-backfill.js → ancestry/backfill.js} +12 -16
  106. package/out/ancestry/backfill.js.map +1 -0
  107. package/out/{ancestry.d.ts → ancestry/index.d.ts} +6 -5
  108. package/out/ancestry/index.d.ts.map +1 -0
  109. package/out/{ancestry.js → ancestry/index.js} +7 -7
  110. package/out/ancestry/index.js.map +1 -0
  111. package/out/build-candidate.d.ts +88 -7
  112. package/out/build-candidate.d.ts.map +1 -1
  113. package/out/build-candidate.js +145 -149
  114. package/out/build-candidate.js.map +1 -1
  115. package/out/build-slim.d.ts +5 -5
  116. package/out/build-slim.d.ts.map +1 -1
  117. package/out/build-slim.js +127 -142
  118. package/out/build-slim.js.map +1 -1
  119. package/out/candidate/alias-bags.d.ts +19 -0
  120. package/out/candidate/alias-bags.d.ts.map +1 -0
  121. package/out/candidate/alias-bags.js +39 -0
  122. package/out/candidate/alias-bags.js.map +1 -0
  123. package/out/candidate/ancestors-sidecar.d.ts +32 -0
  124. package/out/candidate/ancestors-sidecar.d.ts.map +1 -0
  125. package/out/candidate/ancestors-sidecar.js +140 -0
  126. package/out/candidate/ancestors-sidecar.js.map +1 -0
  127. package/out/candidate/country-display-names.d.ts +35 -0
  128. package/out/candidate/country-display-names.d.ts.map +1 -0
  129. package/out/candidate/country-display-names.js +59 -0
  130. package/out/candidate/country-display-names.js.map +1 -0
  131. package/out/candidate/extract-fold.d.ts +32 -0
  132. package/out/candidate/extract-fold.d.ts.map +1 -0
  133. package/out/candidate/extract-fold.js +104 -0
  134. package/out/candidate/extract-fold.js.map +1 -0
  135. package/out/candidate/name-roles.d.ts +57 -0
  136. package/out/candidate/name-roles.d.ts.map +1 -0
  137. package/out/candidate/name-roles.js +166 -0
  138. package/out/candidate/name-roles.js.map +1 -0
  139. package/out/candidate/own-name.d.ts +50 -0
  140. package/out/candidate/own-name.d.ts.map +1 -0
  141. package/out/candidate/own-name.js +132 -0
  142. package/out/candidate/own-name.js.map +1 -0
  143. package/out/candidate/place-attrs.d.ts +43 -0
  144. package/out/candidate/place-attrs.d.ts.map +1 -0
  145. package/out/candidate/place-attrs.js +15 -0
  146. package/out/candidate/place-attrs.js.map +1 -0
  147. package/out/candidate-ancestors-schema.d.ts +150 -0
  148. package/out/candidate-ancestors-schema.d.ts.map +1 -0
  149. package/out/candidate-ancestors-schema.js +123 -0
  150. package/out/candidate-ancestors-schema.js.map +1 -0
  151. package/out/candidate-fts.d.ts +7 -5
  152. package/out/candidate-fts.d.ts.map +1 -1
  153. package/out/candidate-fts.js +5 -3
  154. package/out/candidate-fts.js.map +1 -1
  155. package/out/candidate-importance.d.ts +16 -16
  156. package/out/candidate-importance.d.ts.map +1 -1
  157. package/out/candidate-importance.js +47 -52
  158. package/out/candidate-importance.js.map +1 -1
  159. package/out/candidate-lookup.d.ts +31 -52
  160. package/out/candidate-lookup.d.ts.map +1 -1
  161. package/out/candidate-lookup.js +380 -172
  162. package/out/candidate-lookup.js.map +1 -1
  163. package/out/candidate-schema.d.ts +31 -7
  164. package/out/candidate-schema.d.ts.map +1 -1
  165. package/out/candidate-schema.js +3 -0
  166. package/out/candidate-schema.js.map +1 -1
  167. package/out/candidate-scoring.d.ts +34 -0
  168. package/out/candidate-scoring.d.ts.map +1 -0
  169. package/out/candidate-scoring.js +196 -0
  170. package/out/candidate-scoring.js.map +1 -0
  171. package/out/capital-schema.d.ts +51 -0
  172. package/out/capital-schema.d.ts.map +1 -0
  173. package/out/capital-schema.js +63 -0
  174. package/out/capital-schema.js.map +1 -0
  175. package/out/capitals.d.ts +69 -0
  176. package/out/capitals.d.ts.map +1 -0
  177. package/out/capitals.js +98 -0
  178. package/out/capitals.js.map +1 -0
  179. package/out/coincident-roles.d.ts +12 -4
  180. package/out/coincident-roles.d.ts.map +1 -1
  181. package/out/coincident-roles.js +43 -11
  182. package/out/coincident-roles.js.map +1 -1
  183. package/out/{convention.d.ts → convention/index.d.ts} +5 -5
  184. package/out/convention/index.d.ts.map +1 -0
  185. package/out/{convention.js → convention/index.js} +4 -4
  186. package/out/convention/index.js.map +1 -0
  187. package/out/convention/schema.d.ts +51 -0
  188. package/out/convention/schema.d.ts.map +1 -0
  189. package/out/convention/schema.js +34 -0
  190. package/out/convention/schema.js.map +1 -0
  191. package/out/coverage-manifest-schema.d.ts +8 -8
  192. package/out/coverage-manifest-schema.d.ts.map +1 -1
  193. package/out/coverage-manifest-schema.js +6 -10
  194. package/out/coverage-manifest-schema.js.map +1 -1
  195. package/out/currency-backfill.d.ts +90 -0
  196. package/out/currency-backfill.d.ts.map +1 -0
  197. package/out/currency-backfill.js +196 -0
  198. package/out/currency-backfill.js.map +1 -0
  199. package/out/env.d.ts +43 -0
  200. package/out/env.d.ts.map +1 -0
  201. package/out/env.js +48 -0
  202. package/out/env.js.map +1 -0
  203. package/out/exact-match.d.ts +25 -0
  204. package/out/exact-match.d.ts.map +1 -0
  205. package/out/exact-match.js +88 -0
  206. package/out/exact-match.js.map +1 -0
  207. package/out/extracts.d.ts +114 -0
  208. package/out/extracts.d.ts.map +1 -0
  209. package/out/{sharding.js → extracts.js} +38 -38
  210. package/out/extracts.js.map +1 -0
  211. package/out/{fst-autocomplete.d.ts → fst/autocomplete.d.ts} +13 -13
  212. package/out/fst/autocomplete.d.ts.map +1 -0
  213. package/out/fst/autocomplete.js +113 -0
  214. package/out/fst/autocomplete.js.map +1 -0
  215. package/out/{fst-builder.d.ts → fst/builder.d.ts} +5 -5
  216. package/out/fst/builder.d.ts.map +1 -0
  217. package/out/{fst-builder.js → fst/builder.js} +24 -24
  218. package/out/fst/builder.js.map +1 -0
  219. package/out/{fst-deserialize-web.d.ts → fst/deserialize-web.d.ts} +3 -3
  220. package/out/fst/deserialize-web.d.ts.map +1 -0
  221. package/out/{fst-deserialize-web.js → fst/deserialize-web.js} +10 -74
  222. package/out/fst/deserialize-web.js.map +1 -0
  223. package/out/fst/format.d.ts +80 -0
  224. package/out/fst/format.d.ts.map +1 -0
  225. package/out/fst/format.js +91 -0
  226. package/out/fst/format.js.map +1 -0
  227. package/out/{fst-freshness.d.ts → fst/freshness.d.ts} +11 -14
  228. package/out/fst/freshness.d.ts.map +1 -0
  229. package/out/{fst-freshness.js → fst/freshness.js} +42 -74
  230. package/out/fst/freshness.js.map +1 -0
  231. package/out/fst/index.d.ts +14 -0
  232. package/out/fst/index.d.ts.map +1 -0
  233. package/out/fst/index.js +14 -0
  234. package/out/fst/index.js.map +1 -0
  235. package/out/{fst-matcher.d.ts → fst/matcher.d.ts} +2 -2
  236. package/out/fst/matcher.d.ts.map +1 -0
  237. package/out/{fst-matcher.js → fst/matcher.js} +1 -1
  238. package/out/fst/matcher.js.map +1 -0
  239. package/out/{fst-serialize.d.ts → fst/serialize.d.ts} +5 -10
  240. package/out/fst/serialize.d.ts.map +1 -0
  241. package/out/{fst-serialize.js → fst/serialize.js} +18 -98
  242. package/out/fst/serialize.js.map +1 -0
  243. package/out/{fst-types.d.ts → fst/types.d.ts} +4 -3
  244. package/out/fst/types.d.ts.map +1 -0
  245. package/out/{fst-types.js → fst/types.js} +1 -1
  246. package/out/fst/types.js.map +1 -0
  247. package/out/{fts.d.ts → fts/index.d.ts} +20 -13
  248. package/out/fts/index.d.ts.map +1 -0
  249. package/out/{fts.js → fts/index.js} +20 -15
  250. package/out/fts/index.js.map +1 -0
  251. package/out/{fts-query.d.ts → fts/query.d.ts} +2 -2
  252. package/out/fts/query.d.ts.map +1 -0
  253. package/out/{fts-query.js → fts/query.js} +2 -2
  254. package/out/fts/query.js.map +1 -0
  255. package/out/{geonames-aliases.d.ts → geonames/aliases.d.ts} +8 -6
  256. package/out/geonames/aliases.d.ts.map +1 -0
  257. package/out/{geonames-aliases.js → geonames/aliases.js} +7 -7
  258. package/out/geonames/aliases.js.map +1 -0
  259. package/out/geonames/index.d.ts +8 -0
  260. package/out/geonames/index.d.ts.map +1 -0
  261. package/out/geonames/index.js +8 -0
  262. package/out/geonames/index.js.map +1 -0
  263. package/out/{geonames-postal.d.ts → geonames/postal.d.ts} +12 -10
  264. package/out/geonames/postal.d.ts.map +1 -0
  265. package/out/{geonames-postal.js → geonames/postal.js} +11 -11
  266. package/out/geonames/postal.js.map +1 -0
  267. package/out/index.d.ts +32 -31
  268. package/out/index.d.ts.map +1 -1
  269. package/out/index.js +24 -24
  270. package/out/index.js.map +1 -1
  271. package/out/interpolation.d.ts +18 -9
  272. package/out/interpolation.d.ts.map +1 -1
  273. package/out/interpolation.js +108 -36
  274. package/out/interpolation.js.map +1 -1
  275. package/out/lookup.d.ts +25 -25
  276. package/out/lookup.d.ts.map +1 -1
  277. package/out/lookup.js +174 -558
  278. package/out/lookup.js.map +1 -1
  279. package/out/name-score.d.ts +0 -10
  280. package/out/name-score.d.ts.map +1 -1
  281. package/out/name-score.js +6 -4
  282. package/out/name-score.js.map +1 -1
  283. package/out/nsul/index.d.ts +8 -0
  284. package/out/nsul/index.d.ts.map +1 -0
  285. package/out/nsul/index.js +8 -0
  286. package/out/nsul/index.js.map +1 -0
  287. package/out/nsul/lookup.d.ts +83 -0
  288. package/out/nsul/lookup.d.ts.map +1 -0
  289. package/out/nsul/lookup.js +80 -0
  290. package/out/nsul/lookup.js.map +1 -0
  291. package/out/nsul/schema.d.ts +100 -0
  292. package/out/nsul/schema.d.ts.map +1 -0
  293. package/out/nsul/schema.js +78 -0
  294. package/out/nsul/schema.js.map +1 -0
  295. package/out/place-importance-schema.d.ts +47 -10
  296. package/out/place-importance-schema.d.ts.map +1 -1
  297. package/out/place-importance-schema.js +56 -10
  298. package/out/place-importance-schema.js.map +1 -1
  299. package/out/poi/index.d.ts +8 -0
  300. package/out/poi/index.d.ts.map +1 -0
  301. package/out/poi/index.js +8 -0
  302. package/out/poi/index.js.map +1 -0
  303. package/out/{poi-lookup.d.ts → poi/lookup.d.ts} +8 -10
  304. package/out/poi/lookup.d.ts.map +1 -0
  305. package/out/{poi-lookup.js → poi/lookup.js} +24 -29
  306. package/out/poi/lookup.js.map +1 -0
  307. package/out/{poi-schema.d.ts → poi/schema.d.ts} +10 -6
  308. package/out/poi/schema.d.ts.map +1 -0
  309. package/out/{poi-schema.js → poi/schema.js} +1 -1
  310. package/out/poi/schema.js.map +1 -0
  311. package/out/polygon-schema.d.ts +37 -0
  312. package/out/polygon-schema.d.ts.map +1 -0
  313. package/out/polygon-schema.js +23 -0
  314. package/out/polygon-schema.js.map +1 -0
  315. package/out/{postal-city-alias-lookup.d.ts → postal/city-alias-lookup.d.ts} +7 -6
  316. package/out/postal/city-alias-lookup.d.ts.map +1 -0
  317. package/out/{postal-city-alias-lookup.js → postal/city-alias-lookup.js} +12 -16
  318. package/out/postal/city-alias-lookup.js.map +1 -0
  319. package/out/{postal-city-alias-schema.d.ts → postal/city-alias-schema.d.ts} +1 -1
  320. package/out/{postal-city-alias-schema.d.ts.map → postal/city-alias-schema.d.ts.map} +1 -1
  321. package/out/{postal-city-alias-schema.js → postal/city-alias-schema.js} +1 -1
  322. package/out/{postal-city-alias-schema.js.map → postal/city-alias-schema.js.map} +1 -1
  323. package/out/{postal-city-candidate-schema.d.ts → postal/city-candidate-schema.d.ts} +4 -3
  324. package/out/postal/city-candidate-schema.d.ts.map +1 -0
  325. package/out/{postal-city-candidate-schema.js → postal/city-candidate-schema.js} +2 -2
  326. package/out/{postal-city-candidate-schema.js.map → postal/city-candidate-schema.js.map} +1 -1
  327. package/out/postal/index.d.ts +9 -0
  328. package/out/postal/index.d.ts.map +1 -0
  329. package/out/postal/index.js +9 -0
  330. package/out/postal/index.js.map +1 -0
  331. package/out/postcode-point-lookup.d.ts +10 -10
  332. package/out/postcode-point-lookup.d.ts.map +1 -1
  333. package/out/postcode-point-lookup.js +13 -13
  334. package/out/postcode-point-lookup.js.map +1 -1
  335. package/out/primary-preference.d.ts +133 -0
  336. package/out/primary-preference.d.ts.map +1 -0
  337. package/out/primary-preference.js +146 -0
  338. package/out/primary-preference.js.map +1 -0
  339. package/out/proximity-rerank.d.ts +77 -0
  340. package/out/proximity-rerank.d.ts.map +1 -0
  341. package/out/proximity-rerank.js +86 -0
  342. package/out/proximity-rerank.js.map +1 -0
  343. package/out/ranking-weights.d.ts +15 -3
  344. package/out/ranking-weights.d.ts.map +1 -1
  345. package/out/ranking-weights.js +21 -3
  346. package/out/ranking-weights.js.map +1 -1
  347. package/out/region-keys.d.ts +47 -0
  348. package/out/region-keys.d.ts.map +1 -0
  349. package/out/region-keys.js +121 -0
  350. package/out/region-keys.js.map +1 -0
  351. package/out/reverse.d.ts +6 -6
  352. package/out/reverse.d.ts.map +1 -1
  353. package/out/reverse.js +23 -35
  354. package/out/reverse.js.map +1 -1
  355. package/out/schema.d.ts +10 -1
  356. package/out/schema.d.ts.map +1 -1
  357. package/out/schema.js.map +1 -1
  358. package/out/search-fetch.d.ts +59 -0
  359. package/out/search-fetch.d.ts.map +1 -0
  360. package/out/search-fetch.js +184 -0
  361. package/out/search-fetch.js.map +1 -0
  362. package/out/sqlite-convention-source.d.ts +7 -7
  363. package/out/sqlite-convention-source.d.ts.map +1 -1
  364. package/out/sqlite-convention-source.js +5 -5
  365. package/out/sqlite-convention-source.js.map +1 -1
  366. package/out/sqlite-utils.d.ts +24 -6
  367. package/out/sqlite-utils.d.ts.map +1 -1
  368. package/out/sqlite-utils.js +24 -7
  369. package/out/sqlite-utils.js.map +1 -1
  370. package/out/{street-centroid-schema.d.ts → street/centroid-schema.d.ts} +12 -7
  371. package/out/street/centroid-schema.d.ts.map +1 -0
  372. package/out/{street-centroid-schema.js → street/centroid-schema.js} +5 -5
  373. package/out/{street-centroid-schema.js.map → street/centroid-schema.js.map} +1 -1
  374. package/out/{street-centroid.d.ts → street/centroid.d.ts} +6 -6
  375. package/out/street/centroid.d.ts.map +1 -0
  376. package/out/{street-centroid.js → street/centroid.js} +18 -24
  377. package/out/street/centroid.js.map +1 -0
  378. package/out/street/index.d.ts +13 -0
  379. package/out/street/index.d.ts.map +1 -0
  380. package/out/street/index.js +13 -0
  381. package/out/street/index.js.map +1 -0
  382. package/out/{street-morphology-fst-builder.d.ts → street/morphology-fst-builder.d.ts} +4 -4
  383. package/out/street/morphology-fst-builder.d.ts.map +1 -0
  384. package/out/{street-morphology-fst-builder.js → street/morphology-fst-builder.js} +18 -13
  385. package/out/street/morphology-fst-builder.js.map +1 -0
  386. package/out/{street-morphology-fst-loader.d.ts → street/morphology-fst-loader.d.ts} +5 -5
  387. package/out/street/morphology-fst-loader.d.ts.map +1 -0
  388. package/out/{street-morphology-fst-loader.js → street/morphology-fst-loader.js} +11 -10
  389. package/out/street/morphology-fst-loader.js.map +1 -0
  390. package/out/{street-name-lookup.d.ts → street/name-lookup.d.ts} +4 -7
  391. package/out/street/name-lookup.d.ts.map +1 -0
  392. package/out/{street-name-lookup.js → street/name-lookup.js} +9 -23
  393. package/out/street/name-lookup.js.map +1 -0
  394. package/out/street/normalize.d.ts +179 -0
  395. package/out/street/normalize.d.ts.map +1 -0
  396. package/out/street/normalize.js +457 -0
  397. package/out/street/normalize.js.map +1 -0
  398. package/out/{street-segment-schema.d.ts → street/segment-schema.d.ts} +13 -9
  399. package/out/street/segment-schema.d.ts.map +1 -0
  400. package/out/{street-segment-schema.js → street/segment-schema.js} +4 -4
  401. package/out/{street-segment-schema.js.map → street/segment-schema.js.map} +1 -1
  402. package/out/types.d.ts +49 -9
  403. package/out/types.d.ts.map +1 -1
  404. package/out/types.js.map +1 -1
  405. package/out/unified-schema.d.ts +6 -5
  406. package/out/unified-schema.d.ts.map +1 -1
  407. package/out/unified-schema.js +16 -19
  408. package/out/unified-schema.js.map +1 -1
  409. package/out/uprn/existence.d.ts +53 -0
  410. package/out/uprn/existence.d.ts.map +1 -0
  411. package/out/uprn/existence.js +61 -0
  412. package/out/uprn/existence.js.map +1 -0
  413. package/out/uprn/index.d.ts +9 -0
  414. package/out/uprn/index.d.ts.map +1 -0
  415. package/out/uprn/index.js +9 -0
  416. package/out/uprn/index.js.map +1 -0
  417. package/out/uprn/lookup.d.ts +85 -0
  418. package/out/uprn/lookup.d.ts.map +1 -0
  419. package/out/uprn/lookup.js +149 -0
  420. package/out/uprn/lookup.js.map +1 -0
  421. package/out/uprn/schema.d.ts +93 -0
  422. package/out/uprn/schema.d.ts.map +1 -0
  423. package/out/uprn/schema.js +78 -0
  424. package/out/uprn/schema.js.map +1 -0
  425. package/out/weights-overlay-linker.d.ts +299 -0
  426. package/out/weights-overlay-linker.d.ts.map +1 -0
  427. package/out/weights-overlay-linker.js +511 -0
  428. package/out/weights-overlay-linker.js.map +1 -0
  429. package/package.json +622 -154
  430. package/address-point.ts +0 -125
  431. package/candidate-lookup.ts +0 -720
  432. package/fst-autocomplete.ts +0 -204
  433. package/geo.ts +0 -121
  434. package/lookup.ts +0 -1354
  435. package/out/address-point-interpolation.d.ts.map +0 -1
  436. package/out/address-point-interpolation.js.map +0 -1
  437. package/out/address-point-schema.d.ts.map +0 -1
  438. package/out/address-point-schema.js.map +0 -1
  439. package/out/address-point.d.ts.map +0 -1
  440. package/out/address-point.js +0 -84
  441. package/out/address-point.js.map +0 -1
  442. package/out/ancestry-backfill.d.ts.map +0 -1
  443. package/out/ancestry-backfill.js.map +0 -1
  444. package/out/ancestry.d.ts.map +0 -1
  445. package/out/ancestry.js.map +0 -1
  446. package/out/convention.d.ts.map +0 -1
  447. package/out/convention.js.map +0 -1
  448. package/out/fst-autocomplete.d.ts.map +0 -1
  449. package/out/fst-autocomplete.js +0 -130
  450. package/out/fst-autocomplete.js.map +0 -1
  451. package/out/fst-builder.d.ts.map +0 -1
  452. package/out/fst-builder.js.map +0 -1
  453. package/out/fst-deserialize-web.d.ts.map +0 -1
  454. package/out/fst-deserialize-web.js.map +0 -1
  455. package/out/fst-freshness.d.ts.map +0 -1
  456. package/out/fst-freshness.js.map +0 -1
  457. package/out/fst-matcher.d.ts.map +0 -1
  458. package/out/fst-matcher.js.map +0 -1
  459. package/out/fst-serialize.d.ts.map +0 -1
  460. package/out/fst-serialize.js.map +0 -1
  461. package/out/fst-types.d.ts.map +0 -1
  462. package/out/fst-types.js.map +0 -1
  463. package/out/fts-query.d.ts.map +0 -1
  464. package/out/fts-query.js.map +0 -1
  465. package/out/fts.d.ts.map +0 -1
  466. package/out/fts.js.map +0 -1
  467. package/out/geo.d.ts +0 -74
  468. package/out/geo.d.ts.map +0 -1
  469. package/out/geo.js +0 -71
  470. package/out/geo.js.map +0 -1
  471. package/out/geonames-aliases.d.ts.map +0 -1
  472. package/out/geonames-aliases.js.map +0 -1
  473. package/out/geonames-postal.d.ts.map +0 -1
  474. package/out/geonames-postal.js.map +0 -1
  475. package/out/poi-lookup.d.ts.map +0 -1
  476. package/out/poi-lookup.js.map +0 -1
  477. package/out/poi-schema.d.ts.map +0 -1
  478. package/out/poi-schema.js.map +0 -1
  479. package/out/postal-city-alias-lookup.d.ts.map +0 -1
  480. package/out/postal-city-alias-lookup.js.map +0 -1
  481. package/out/postal-city-candidate-schema.d.ts.map +0 -1
  482. package/out/sharding.d.ts +0 -114
  483. package/out/sharding.d.ts.map +0 -1
  484. package/out/sharding.js.map +0 -1
  485. package/out/street-centroid-schema.d.ts.map +0 -1
  486. package/out/street-centroid.d.ts.map +0 -1
  487. package/out/street-centroid.js.map +0 -1
  488. package/out/street-morphology-fst-builder.d.ts.map +0 -1
  489. package/out/street-morphology-fst-builder.js.map +0 -1
  490. package/out/street-morphology-fst-loader.d.ts.map +0 -1
  491. package/out/street-morphology-fst-loader.js.map +0 -1
  492. package/out/street-name-lookup.d.ts.map +0 -1
  493. package/out/street-name-lookup.js.map +0 -1
  494. package/out/street-normalize.d.ts +0 -95
  495. package/out/street-normalize.d.ts.map +0 -1
  496. package/out/street-normalize.js +0 -272
  497. package/out/street-normalize.js.map +0 -1
  498. package/out/street-segment-schema.d.ts.map +0 -1
  499. package/sqlite-utils.ts +0 -46
  500. package/street-normalize.ts +0 -318
  501. /package/{postal-city-alias-schema.ts → lib/postal/city-alias-schema.ts} +0 -0
@@ -0,0 +1,572 @@
1
+ /**
2
+ * @copyright Sister Software
3
+ * @license AGPL-3.0
4
+ * @author Teffen Ellis, et al.
5
+ *
6
+ * THE street normalizer for the address-point tier (#476). One function, used by BOTH the extract
7
+ * builder (`scripts/build-address-point-extract.ts`) and the lookup tier (`address-point.ts`) —
8
+ * never two implementations (the PLACETYPE_ORDER lesson: parallel copies silently corrupt).
9
+ *
10
+ * Normalization contract (deliberately aggressive — both sides apply the same function, so
11
+ * collisions only need to be _consistent_, not linguistically perfect):
12
+ *
13
+ * 1. Lowercase, NFKD-fold diacritics, collapse whitespace, strip punctuation (periods, commas,
14
+ * apostrophes).
15
+ * 2. Expand USPS directional abbreviations at the FIRST and LAST token position (`n` → `north`, `se` →
16
+ * `southeast`) — Overture sources abbreviate inconsistently.
17
+ * 3. Canonicalize a trailing USPS street-type token via the codex suffix table to its canonical full
18
+ * form (`st`/`str`/`street` → `street`).
19
+ *
20
+ * Numbered streets are left as digits (`5th` stays `5th`); a SPELLED ordinal before a street suffix
21
+ * folds to its digit form (`tenth street` → `10th street`, #723) so the grid-city ordinal
22
+ * cross-streets the source data spells with digits become reachable.
23
+ */
24
+
25
+ import { AbbreviationToDirectional, US_STREET_SUFFIX_LOOKUP } from "@mailwoman/codex/us"
26
+ import type { Tagged } from "type-fest"
27
+
28
+ /**
29
+ * A place name folded by {@link normalizeLocalityForKey} — the value stored in, and required to probe, every
30
+ * `name_key`-style column: the candidate gazetteer, the postal-city side-index, the street-centroid extract, an
31
+ * ancestor chain's `parent_name_key`, and the address-point locality scope.
32
+ *
33
+ * The brand is here because the fold is applied at BUILD time and is therefore mandatory at QUERY time, while a
34
+ * near-miss approximation of it (`toLowerCase()`, `trim()`) is still a `string`: it binds to the parameter, returns
35
+ * fewer rows, and the shortfall reads as a coverage gap in the data rather than a defect in the probe. Requiring the
36
+ * brand at the boundary turns that silent under-match into a compile error. Mint one only by calling the fold.
37
+ */
38
+ export type NameKey = Tagged<string, "NameKey">
39
+
40
+ /**
41
+ * A street name folded by {@link normalizeStreetForKey} / {@link normalizeStreetForKeyLocale} — the value stored in a
42
+ * `street_norm` address-point column and required to probe it.
43
+ *
44
+ * Distinct from {@link RouteKey}: the route fold is a FURTHER canonicalization applied to some columns and not others,
45
+ * so the two are not interchangeable even though both are folded streets.
46
+ */
47
+ export type StreetKey = Tagged<string, "StreetKey">
48
+
49
+ /**
50
+ * A street key that has additionally passed {@link canonicalizeRouteKey} — the numbered-route canonical form.
51
+ *
52
+ * A separate brand from {@link StreetKey} because it identifies a DIFFERENT set of columns, and the two folds disagree
53
+ * exactly on the rows that motivate the route fold: binding a plain street key to a route-folded column silently misses
54
+ * every row whose source spelled the route differently, which is the miss class the fold exists to close.
55
+ */
56
+ export type RouteKey = Tagged<string, "RouteKey">
57
+
58
+ /**
59
+ * Token count a street must exceed before its trailing pair is merged. At or below it the pair IS the whole street
60
+ * name, and merging would leave nothing to match on.
61
+ */
62
+ const MIN_TOKENS_FOR_TAIL_MERGE = 3
63
+
64
+ /**
65
+ * Spelled ordinal street names → their digit-ordinal form ("tenth" → "10th"), applied ONLY when a street-type suffix
66
+ * follows (#723 admin-tail) — so the ordinal cross-streets common in grid cities ("Tenth Street", "Fifth Avenue") match
67
+ * the extracts' digit keys, WITHOUT rewriting ordinal-WORD names where the next token is not a suffix ("First National
68
+ * Bank Rd" stays "first national …"). Digit-source extracts are unaffected (a digit token isn't in this map), so the
69
+ * existing keys need no rebuild; a future rebuild folds any spelled-source key the same way (the one-function
70
+ * discipline).
71
+ */
72
+ const SPELLED_ORDINAL_TO_DIGIT = new Map<string, string>([
73
+ ["first", "1st"],
74
+ ["second", "2nd"],
75
+ ["third", "3rd"],
76
+ ["fourth", "4th"],
77
+ ["fifth", "5th"],
78
+ ["sixth", "6th"],
79
+ ["seventh", "7th"],
80
+ ["eighth", "8th"],
81
+ ["ninth", "9th"],
82
+ ["tenth", "10th"],
83
+ ["eleventh", "11th"],
84
+ ["twelfth", "12th"],
85
+ ["thirteenth", "13th"],
86
+ ["fourteenth", "14th"],
87
+ ["fifteenth", "15th"],
88
+ ["sixteenth", "16th"],
89
+ ["seventeenth", "17th"],
90
+ ["eighteenth", "18th"],
91
+ ["nineteenth", "19th"],
92
+ ["twentieth", "20th"],
93
+ ["thirtieth", "30th"],
94
+ ["fortieth", "40th"],
95
+ ["fiftieth", "50th"],
96
+ ["sixtieth", "60th"],
97
+ ["seventieth", "70th"],
98
+ ["eightieth", "80th"],
99
+ ["ninetieth", "90th"],
100
+ ["hundredth", "100th"],
101
+ ])
102
+
103
+ /**
104
+ * Lowercase + diacritic-fold + punctuation strip + whitespace collapse.
105
+ */
106
+ function fold(input: string): string {
107
+ return input
108
+ .normalize("NFKD")
109
+ .replaceAll(/[̀-ͯ]/g, "")
110
+ .toLowerCase()
111
+ .replaceAll(/[.,'’]/g, "")
112
+ .replaceAll(/\s+/g, " ")
113
+ .trim()
114
+ }
115
+
116
+ /**
117
+ * Normalize a street name for address-point keying. Same function at build time and lookup time — see module docstring
118
+ * for the contract.
119
+ */
120
+ export function normalizeStreetForKey(street: string): StreetKey {
121
+ const tokens = fold(street).split(" ")
122
+
123
+ if (!tokens.length) return "" as StreetKey
124
+
125
+ // Spelled-ordinal street names → digit form when a street suffix follows ("Tenth Street" →
126
+ // "10th street", #723). Conditioned on the next token being a suffix so ordinal-WORD names are untouched.
127
+ for (let i = 0; i < tokens.length - 1; i++) {
128
+ const digit = SPELLED_ORDINAL_TO_DIGIT.get(tokens[i]!)
129
+
130
+ if (digit && US_STREET_SUFFIX_LOOKUP.has(tokens[i + 1]!)) {
131
+ tokens[i] = digit
132
+ }
133
+ }
134
+
135
+ // Directional expansion at the edges only ("N Main St" / "Main St N" — never interior
136
+ // tokens, where "W" may be an initial in a person-named street). The codex expands
137
+ // compounds to two words ("SE" → "SOUTH EAST"); we key on the spaceless form
138
+ // ("southeast"), and also merge an already-written two-token pair ("South East …").
139
+ const edgeDirectional = (raw: string) =>
140
+ AbbreviationToDirectional.get(raw.toUpperCase())?.toLowerCase().replace(" ", "")
141
+
142
+ const mergePair = (a?: string, b?: string) =>
143
+ a && b && /^(north|south)$/.test(a) && /^(east|west)$/.test(b) ? a + b : undefined
144
+
145
+ const leadPair = mergePair(tokens[0], tokens[1])
146
+
147
+ if (leadPair && tokens.length > 2) {
148
+ tokens.splice(0, 2, leadPair)
149
+ }
150
+
151
+ const first = edgeDirectional(tokens[0]!)
152
+
153
+ if (first && tokens.length > 1) {
154
+ tokens[0] = first
155
+ }
156
+
157
+ const tailPair = mergePair(tokens.at(-2), tokens.at(-1))
158
+
159
+ if (tailPair && tokens.length > MIN_TOKENS_FOR_TAIL_MERGE) {
160
+ tokens.splice(-2, 2, tailPair)
161
+ }
162
+
163
+ if (tokens.length > 2) {
164
+ const last = edgeDirectional(tokens.at(-1)!)
165
+
166
+ if (last) {
167
+ tokens[tokens.length - 1] = last
168
+ }
169
+ }
170
+
171
+ // Street-type canonicalization via the codex table (lowercase keys, UPPER canonical
172
+ // values). The suffix is usually the last token, but sits second-to-last when a trailing
173
+ // directional follows ("Main St N") — check both positions, canonicalize the first hit.
174
+ for (const at of [tokens.length - 1, tokens.length - 2]) {
175
+ if (at < 1) continue // never canonicalize the only/first token ("Street Road" exists)
176
+ const canonical = US_STREET_SUFFIX_LOOKUP.get(tokens[at]!)
177
+
178
+ if (canonical) {
179
+ tokens[at] = canonical.toLowerCase()
180
+
181
+ break
182
+ }
183
+ }
184
+
185
+ return tokens.join(" ") as StreetKey
186
+ }
187
+
188
+ /**
189
+ * Street-name locale for the address-point key. The US path is the full USPS pipeline ({@link normalizeStreetForKey});
190
+ * the international paths fold + apply a SMALL, consistent per-locale type-token canonicalization. Same discipline as
191
+ * the US normalizer: build side and probe side call the identical function, so the key only needs to be CONSISTENT, not
192
+ * linguistically perfect — a folded "rue du chevaleret" keys the same on both sides whether or not we reorder the
193
+ * article, so no salient-token / multi-key index is built yet (deferred until probing shows the normalizer can't absorb
194
+ * the false-negatives).
195
+ */
196
+ export type StreetLocale = "us" | "en" | "fr" | "de" | "nl" | "pl" | "vn" | "id"
197
+
198
+ /**
199
+ * Country → street-locale registry surface for the acquisition SDKs (BAN, OSM). Each SDK keeps its own map — membership
200
+ * is a per-register decision — and this factory owns the lookup discipline: throw for an unsupported country rather
201
+ * than silently folding with the wrong rules, because a extract built with the wrong normalizer keys every street
202
+ * incorrectly and looks fine until a probe misses. `label` is the SDK's own registration instructions, appended to the
203
+ * error verbatim.
204
+ */
205
+ export function createStreetLocaleRegistry(
206
+ registry: ReadonlyMap<string, StreetLocale>,
207
+ label: string
208
+ ): { localeFor: (countryCode: string) => StreetLocale; supported: () => string[] } {
209
+ return {
210
+ localeFor: (countryCode) => {
211
+ const locale = registry.get(countryCode.toLowerCase())
212
+
213
+ if (!locale) {
214
+ throw new Error(`No street-normalization locale registered for country "${countryCode}". ${label}`)
215
+ }
216
+
217
+ return locale
218
+ },
219
+ supported: () => [...registry.keys()],
220
+ }
221
+ }
222
+
223
+ /**
224
+ * French street-type abbreviations → canonical full form, applied per token after {@link fold}. French address types
225
+ * LEAD the name ("Av. de…", "Bd …", "Pl. …") and "St"/"Ste" abbreviate Saint/Sainte inside names ("Rue St-Honoré" →
226
+ * "rue saint honore"). fold() has already stripped the trailing period, so the keys are point-free ("av", "bd").
227
+ */
228
+ const FR_STREET_ABBREV = new Map<string, string>([
229
+ ["av", "avenue"],
230
+ ["ave", "avenue"],
231
+ ["bd", "boulevard"],
232
+ ["bld", "boulevard"],
233
+ ["bvd", "boulevard"],
234
+ ["boul", "boulevard"],
235
+ ["pl", "place"],
236
+ ["imp", "impasse"],
237
+ ["all", "allee"],
238
+ ["ch", "chemin"],
239
+ ["che", "chemin"],
240
+ ["sq", "square"],
241
+ ["pas", "passage"],
242
+ ["fg", "faubourg"],
243
+ ["fbg", "faubourg"],
244
+ ["rte", "route"],
245
+ ["st", "saint"],
246
+ ["ste", "sainte"],
247
+ ["sts", "saints"],
248
+ ])
249
+
250
+ /**
251
+ * Polish leading street-type tokens, STRIPPED rather than expanded. Measured on the 5.56M-row PL OSM extract
252
+ * (2026-08-19): OSM Poland tags `addr:street` BARE — `ulica%` covers 22 rows and `ul.%` eight, so an EXPANSION rule
253
+ * makes a typed query ("ul. Świętokrzyska" → "ulica swietokrzyska") miss the 3,846 bare "swietokrzyska" rows. Stripping
254
+ * the leading type on BOTH sides keys typed and bare surfaces identically. The full words are stripped too: the
255
+ * aleja/plac/osiedle populations (48,597 / 26,815 / 39,552 rows) spell the word out, and "Plac Zamkowy" must key the
256
+ * same as a query's "plac zamkowy" or bare "Zamkowy". Never stripped when it is the only token.
257
+ */
258
+ const PL_LEADING_TYPE = new Set(["ul", "ulica", "al", "aleja", "aleje", "pl", "plac", "os", "osiedle"])
259
+
260
+ /**
261
+ * Indonesian street-type abbreviations → canonical full form, leading position ("Jl. Thamrin", "Gg. Waru").
262
+ */
263
+ const ID_STREET_ABBREV = new Map<string, string>([
264
+ ["jl", "jalan"],
265
+ ["jln", "jalan"],
266
+ ["gg", "gang"],
267
+ ])
268
+
269
+ /**
270
+ * Normalize a street name for the address-point key in a non-US locale. Same function build-side and probe-side (the
271
+ * one-function discipline). US delegates to {@link normalizeStreetForKey}.
272
+ *
273
+ * - **en** — the shared English address-key pipeline (directionals + suffix aliases), currently identical to US.
274
+ * - **fr** — fold + expand leading type abbreviations and Saint/Sainte (token map).
275
+ * - **de** — fold + ß→ss + canonicalize the GLUED `-str(.)` suffix to `-strasse` ("Lindenstr." → "lindenstrasse",
276
+ * "Lindenstraße" → "lindenstrasse"); an already-full "-strasse" is left intact.
277
+ * - **nl** — fold + canonicalize the glued `-str` suffix to `-straat` ("Kerkstr." → "kerkstraat").
278
+ * - **pl** — fold + ł→l (Ł does not NFKD-decompose, so the generic fold keeps it and an undiacritized query would miss;
279
+ * every other Polish diacritic is a combining form the fold already strips) + STRIP the leading type token — see
280
+ * {@link PL_LEADING_TYPE} for the measured reason expansion was wrong for this source.
281
+ * - **vn** — fold + đ→d AND ð→d (both non-decomposing, and OSM mixes the two codepoints inside single values — see the
282
+ * branch comment). Deliberately NO type-abbreviation map yet: the common abbreviation is the single letter "Đ." for
283
+ * Đường, and expanding a bare folded "d" token would rewrite initials — measure the miss rate on the built extract
284
+ * before adding anything.
285
+ * - **id** — fold + expand leading type abbreviations (jl/jln→jalan, gg→gang); Indonesian street surfaces are otherwise
286
+ * ASCII-clean.
287
+ */
288
+ export function normalizeStreetForKeyLocale(street: string, locale: StreetLocale): StreetKey {
289
+ if (locale === "us" || locale === "en") return normalizeStreetForKey(street)
290
+
291
+ // Hyphen → space so a compound name keys the same whether the source or the query writes the
292
+ // hyphen ("Champs-Élysées", "St-Honoré") or a space — both sides fold identically, so this is pure
293
+ // robustness. It also splits a hyphenated abbreviation ("St-Honoré" → "st honore") into tokens the
294
+ // per-locale type/Saint map can see. Letter maps for non-decomposing letters (ß, ł, đ) live in the
295
+ // per-locale branches, NEVER here: widening the shared pipeline would silently change keys under
296
+ // every already-built extract of the other locales.
297
+ const tokens = fold(street)
298
+ .replaceAll("ß", "ss")
299
+ .replaceAll("-", " ")
300
+ .split(/\s+/)
301
+ .filter((value) => value.length > 0)
302
+
303
+ if (!tokens.length) return "" as StreetKey
304
+
305
+ switch (locale) {
306
+ case "fr":
307
+ for (let i = 0; i < tokens.length; i++) {
308
+ tokens[i] = FR_STREET_ABBREV.get(tokens[i]!) ?? tokens[i]!
309
+ }
310
+ break
311
+ case "de":
312
+ for (let i = 0; i < tokens.length; i++) {
313
+ const t = tokens[i]!
314
+
315
+ if (t.endsWith("str") && !t.endsWith("strasse")) {
316
+ tokens[i] = t.replace(/str$/, "strasse")
317
+ }
318
+ }
319
+ break
320
+ case "nl":
321
+ for (let i = 0; i < tokens.length; i++) {
322
+ const t = tokens[i]!
323
+
324
+ if (t.endsWith("str") && !t.endsWith("straat")) {
325
+ tokens[i] = t.replace(/str$/, "straat")
326
+ }
327
+ }
328
+ break
329
+ case "pl":
330
+ for (let i = 0; i < tokens.length; i++) {
331
+ tokens[i] = tokens[i]!.replaceAll("ł", "l")
332
+ }
333
+
334
+ if (tokens.length > 1 && PL_LEADING_TYPE.has(tokens[0]!)) {
335
+ tokens.shift()
336
+ }
337
+ break
338
+ case "id":
339
+ for (let i = 0; i < tokens.length; i++) {
340
+ tokens[i] = ID_STREET_ABBREV.get(tokens[i]!) ?? tokens[i]!
341
+ }
342
+ break
343
+ case "vn":
344
+ // đ (U+0111, d-with-stroke) AND ð (U+00F0, eth): OSM Vietnamese data mixes the two visually
345
+ // identical codepoints inside single values — the 2026-08-19 extract measured `Đường Trần Hưng
346
+ // Đạo` carrying d-with-stroke at the front and ETH in `Đạo`, splitting the country's most
347
+ // common street into two keys with the MAJORITY variant (630 vs 421 rows) unreachable by a
348
+ // correctly-typed query. No abbreviation map — see the locale table.
349
+ for (let i = 0; i < tokens.length; i++) {
350
+ tokens[i] = tokens[i]!.replaceAll("đ", "d").replaceAll("ð", "d")
351
+ }
352
+ break
353
+ }
354
+
355
+ return tokens.join(" ") as StreetKey
356
+ }
357
+
358
+ /**
359
+ * Normalize a locality name for address-point keying (fold only — no street semantics).
360
+ */
361
+ export function normalizeLocalityForKey(locality: string): NameKey {
362
+ return fold(locality) as NameKey
363
+ }
364
+
365
+ /**
366
+ * Leading French street-type token. French types LEAD the name ("avenue du Parc", "boul Saint-Laurent") while English
367
+ * types TRAIL ("Fifth Avenue", "Grosvenor Place"), so a leading type-token is the discriminating signal — "1 Avenue NE"
368
+ * starts with a digit and never matches. The separator lookahead is explicit rather than `\b` because a word boundary
369
+ * after an accented final letter ("carré") is not one to an ASCII-word `\b`.
370
+ */
371
+ const FRENCH_LEAD_TYPE =
372
+ /^(?:rue|ruelle|av|ave|avenue|boul|bd|boulevard|ch|che|chemin|all[ée]e|imp|impasse|mont[ée]e|c[ôo]te|pl|place|prom|promenade|rang|rte|route|autoroute|carr[eé]|croissant|terrasse|sentier)(?=[\s.-]|$)/i
373
+
374
+ /**
375
+ * Surface-driven street-locale ROUTER for bilingual extracts — the Québec finishing move on the CA rooftop extract.
376
+ *
377
+ * A country registers ONE street locale, but Canada's street surfaces are two languages: under the `en` rules a French
378
+ * surface passes through mostly unchanged (both sides fold identically, so those rows stay reachable), and what breaks
379
+ * is abbreviation variance — the `en` rules cannot fold "boul"/"Ste-" to the full French word, so an abbreviated query
380
+ * misses a full-word row and vice versa. Routing on the SURFACE (not the province) also carries bilingual NB and the
381
+ * French street names outside Québec for free.
382
+ *
383
+ * ONE function, called by the extract BUILDER and the query PROBE alike — the #861 discipline: routing is part of the
384
+ * fold contract, and two transcriptions of this predicate would diverge exactly where it matters. Only an `en` base
385
+ * re-routes: a `fr`/`de`/`nl` extract already speaks its own rules, and the US pipeline stays untouched.
386
+ *
387
+ * Measured basis (CA extract, 2026-08-19): 183,963 distinct surfaces, 43,762 French-lead; 29,682 fold differently under
388
+ * fr-vs-en (888,265 rows), and the non-French half of those are English surfaces this router keeps on `en` unchanged.
389
+ */
390
+ export function streetLocaleForSurface(street: string, base: StreetLocale): StreetLocale {
391
+ return base === "en" && FRENCH_LEAD_TYPE.test(street.trimStart()) ? "fr" : base
392
+ }
393
+
394
+ /**
395
+ * Strip a trailing French arrondissement designator from a FOLDED commune key ("paris 8e arrondissement" → "paris",
396
+ * "lyon 1er arrondissement" → "lyon", "marseille 10e arrondissement" → "marseille"). Paris, Lyon and Marseille are the
397
+ * only French communes subdivided into _arrondissements municipaux_; a national register (BAN) names each row per
398
+ * arrondissement, but a query names the base commune ("Place Bellecour, Lyon", never "…, Lyon 2e"). Applied on BOTH
399
+ * sides of the #1042 street-centroid key — build-side (deriving the `locality_base` column) and query-side (folding the
400
+ * probe commune) — so the two agree by construction (the one-function discipline). The {@link NameKey} parameter is the
401
+ * enforcement of "must already be folded": stripping an arrondissement off an unfolded surface yields a key neither
402
+ * side stores. A no-op for every other commune, and the strip leaves a fold fixed point, so the result is still a
403
+ * {@link NameKey}. Returns the input unchanged if the strip would empty it.
404
+ */
405
+ export function stripArrondissement(localityNorm: NameKey): NameKey {
406
+ const stripped = localityNorm.replace(/\s+\d+(?:er|e)\s+arrondissement$/, "").trim() as NameKey
407
+
408
+ return stripped || localityNorm
409
+ }
410
+
411
+ /**
412
+ * Strip a locality QUALIFIER for a query-side fallback — when an OA locality's exact normalized name misses the
413
+ * gazetteer's canonical name, retry with the qualifier removed. OA address data carries disambiguating qualifiers the
414
+ * gazetteer's canonical name omits: Austrian `Kraubath/Mur` and `Hart b.Graz` → `Hart`; Swiss `Lenk im Simmental` →
415
+ * `Lenk`, `Roche VD` → `Roche`; Danish `Odense S`, `Hurup Thy`. A FALLBACK ONLY — the exact name is tried first, and
416
+ * the region-bbox disambiguation resolves any base-name ambiguity downstream. The candidate table is unchanged (this is
417
+ * purely query-side); feed the result back through {@link normalizeLocalityForKey}. Returns "" when nothing was stripped
418
+ * (no point re-probing the identical key).
419
+ *
420
+ * Measured (`scripts/eval/candidate-recall.ts --strip-fallback`, EU OA holdouts): recovers AT 74.1→88.2% (+14.1pp), DK
421
+ * 91.5→96.2%, CH 90.4→92.6%; +1.3pp overall (diluted by the already-100% locales). Conservative by design — only the
422
+ * qualifier forms above; FI/PT/SI misses are untouched.
423
+ */
424
+ export function stripLocalityQualifier(locality: string): string {
425
+ let s = locality.trim()
426
+
427
+ if (s.includes("/")) {
428
+ s = s.split("/")[0]!.trim()
429
+ }
430
+
431
+ const words = [...s.matchAll(/\S+/gu)].map((match) => ({ value: match[0], index: match.index }))
432
+ let qualifierStart: number | undefined
433
+
434
+ for (let index = 1; index < words.length; index++) {
435
+ const word = words[index]!
436
+ const first = word.value[0] ?? ""
437
+ const abbreviated = /[a-zà-ÿ]/iu.test(first) && word.value[1] === "." && word.value.length > 2
438
+ const oneWordQualifier = ["im", "ob", "bei", "unter", "vor"].includes(word.value.toLowerCase())
439
+
440
+ const twoWordQualifier =
441
+ ["an", "in"].includes(word.value.toLowerCase()) && words[index + 1]?.value.toLowerCase() === "der"
442
+
443
+ const hasQualifierValue = oneWordQualifier ? index + 1 < words.length : index + 2 < words.length
444
+
445
+ if (abbreviated || ((oneWordQualifier || twoWordQualifier) && hasQualifierValue)) {
446
+ qualifierStart = word.index
447
+
448
+ break
449
+ }
450
+ }
451
+
452
+ const suffix = words.at(-1)
453
+
454
+ if (
455
+ qualifierStart === undefined &&
456
+ suffix &&
457
+ words.length > 1 &&
458
+ (["S", "N", "E", "W", "V", "Ø", "Sø", "Fyn", "Thy", "Sjælland", "Jylland"].includes(suffix.value) ||
459
+ /^[A-ZÅÄÖ]{2}$/u.test(suffix.value))
460
+ ) {
461
+ qualifierStart = suffix.index
462
+ }
463
+
464
+ if (qualifierStart !== undefined) {
465
+ s = s.slice(0, qualifierStart).trimEnd()
466
+ }
467
+
468
+ s = s.trim()
469
+
470
+ return s === locality.trim() ? "" : s
471
+ }
472
+
473
+ /**
474
+ * Fold numbered-route designators to a canonical key, applied AFTER {@link normalizeStreetForKey}. Sources disagree
475
+ * systematically on how they spell a route: TIGER says `State Rte 100` / `US Hwy 5` where E911/Overture say `VT ROUTE
476
+ * 100` / `US ROUTE 5` — the dominant street-name miss class in the #483 interpolation eval (rural addresses live on
477
+ * routes). `us <designator> N…` folds to `us route N…`; `state <designator> N…` and `<2-letter-prefix> <designator> N…`
478
+ * (the state abbreviation form) fold to `state route N…`. Only digit-leading route numbers fold — `State Street` and
479
+ * friends never match.
480
+ *
481
+ * Used by BOTH the segment-extract builder (`scripts/build-interpolation-extract.ts`) and the interpolation lookup —
482
+ * same one-function discipline as {@link normalizeStreetForKey}. The address-point tier (#476) does NOT apply it yet:
483
+ * adopting it there requires a extract rebuild (noted on #483).
484
+ *
485
+ * A same-numbered US and state route stay DISTINCT keys (`us route 5` vs `state route 5`); only the BARE `route N` form
486
+ * is ambiguous (designator unknown) and it stays unfolded — a bare-route query therefore misses rather than guessing a
487
+ * designator.
488
+ */
489
+ export function canonicalizeRouteKey(streetNorm: StreetKey): RouteKey {
490
+ const match = /^(us|state|[a-z]{2}) (?:route|rte|rt|highway|hwy) (\d.*)$/.exec(streetNorm)
491
+
492
+ // A street naming no route is already its own route key. {@link StreetKey} and {@link RouteKey} are
493
+ // SIBLING brands rather than nested ones — precisely so neither column accepts the other's key — so
494
+ // re-minting here is an explicit hop through the unbranded string.
495
+ if (!match) return streetNorm as string as RouteKey
496
+
497
+ return `${match[1] === "us" ? "us" : "state"} route ${match[2]}` as RouteKey
498
+ }
499
+
500
+ /**
501
+ * The canonical street-type words (lowercase) — the VALUE side of the codex suffix table. Membership means "this
502
+ * normalized token is a fully-spelled street type" ("place", "street", "road" …), which is how the doubled-type
503
+ * collapse below recognizes its shape without any parse-tree knowledge.
504
+ */
505
+ const CANONICAL_TYPE_WORDS: ReadonlySet<string> = new Set(
506
+ [...US_STREET_SUFFIX_LOOKUP.values()].map((v) => v.toLowerCase())
507
+ )
508
+
509
+ /**
510
+ * Ordered lookup-key variants for a US/EN street span — the primary normalized key first, then the null-only recovery
511
+ * forms a reader may probe when the primary misses. Two register mismatches motivate them, both measured on live
512
+ * queries (2026-08-14):
513
+ *
514
+ * - **Doubled type** — a user types the type twice ("Saint Pauls PL St"), and the normalizer canonicalizes only the LAST
515
+ * type token, leaving `saint pauls pl street`, which matches nothing anywhere. The signature is visible in the key
516
+ * itself: a canonical type word in last position DIRECTLY after an uncanonicalized type abbreviation. The variant
517
+ * drops the trailing word and canonicalizes what remains (`saint pauls place`). A street genuinely named with two
518
+ * types keys identically on both sides and is caught by the primary probe first.
519
+ * - **Saint↔St register split** — the artifacts preserve each SOURCE's spelling (NYC situs keys `st pauls place`, Nassau
520
+ * keys `saint pauls place`), and a query arrives in whichever register the user typed. A leading `saint` or `st`
521
+ * token is swapped for its sibling; leading position only — a leading `st` is always the hagionym in US street names,
522
+ * and interior tokens ("Mount Saint Helens Dr") are out of scope until measured.
523
+ *
524
+ * Deduplicated and ordered most-literal-first, so probing the list in order preserves the primary key's precedence.
525
+ */
526
+ export function streetKeyVariants(street: string, locale: StreetLocale = "us"): StreetKey[] {
527
+ const primary = locale === "us" ? normalizeStreetForKey(street) : normalizeStreetForKeyLocale(street, locale)
528
+ const variants: StreetKey[] = primary ? [primary] : []
529
+
530
+ if (!primary || (locale !== "us" && locale !== "en")) return variants
531
+
532
+ const tokens = primary.split(" ")
533
+ const last = tokens.at(-1)
534
+ const secondLast = tokens.at(-2)
535
+
536
+ if (
537
+ tokens.length > 2 &&
538
+ last &&
539
+ secondLast &&
540
+ CANONICAL_TYPE_WORDS.has(last) &&
541
+ !CANONICAL_TYPE_WORDS.has(secondLast) &&
542
+ US_STREET_SUFFIX_LOOKUP.has(secondLast)
543
+ ) {
544
+ const collapsed = normalizeStreetForKey(tokens.slice(0, -1).join(" "))
545
+
546
+ if (collapsed && !variants.includes(collapsed)) {
547
+ variants.push(collapsed)
548
+ }
549
+ }
550
+
551
+ // Snapshot before the swap pass — it appends while reading, and iterating the live array would
552
+ // re-visit its own additions.
553
+ const preSwap = variants.slice()
554
+
555
+ for (const variant of preSwap) {
556
+ const [head, ...rest] = variant.split(" ")
557
+ const swapped = head === "saint" ? "st" : head === "st" ? "saint" : null
558
+
559
+ if (swapped && rest.length) {
560
+ // Substituting a leading hagionym token in an already-normalized key leaves a fold fixed point —
561
+ // the suffix pass never rewrites position 0 — so the swap yields a {@link StreetKey} without
562
+ // re-folding.
563
+ const candidate = [swapped, ...rest].join(" ") as StreetKey
564
+
565
+ if (!variants.includes(candidate)) {
566
+ variants.push(candidate)
567
+ }
568
+ }
569
+ }
570
+
571
+ return variants
572
+ }
@@ -3,8 +3,8 @@
3
3
  * @license AGPL-3.0
4
4
  * @author Teffen Ellis, et al.
5
5
  *
6
- * Typed schema for the TIGER STREET-SEGMENT interpolation shards (`street-segments-<cc>-<st>.db`,
7
- * built by `scripts/build-interpolation-shard.ts` from TIGER EDGES) — the #483 Method-3 fallback
6
+ * Typed schema for the TIGER STREET-SEGMENT interpolation extracts (`street-segments-<cc>-<st>.db`,
7
+ * built by `scripts/build-interpolation-extract.ts` from TIGER EDGES) — the #483 Method-3 fallback
8
8
  * the resolver drops to when the address-point tier (Method 2) can't bracket. Single source of
9
9
  * truth for the columns the BUILDER writes and the READER ({@link StreetInterpolator}) probes, so
10
10
  * a column rename in one is a compile error in the other.
@@ -17,6 +17,8 @@
17
17
 
18
18
  import type { Kysely } from "kysely"
19
19
 
20
+ import type { RouteKey } from "#street/normalize"
21
+
20
22
  /**
21
23
  * One TIGER street-segment edge: a `(from_hn, to_hn)` house-number range on one `side` of a named street, with the
22
24
  * geometry the interpolator walks. `min_hn`/`max_hn` are the sorted bounds (the probe filters on them); `parity` is
@@ -24,9 +26,12 @@ import type { Kysely } from "kysely"
24
26
  */
25
27
  export interface StreetSegmentTable {
26
28
  /**
27
- * Shared {@link normalizeStreetForKey} of the street — the build/query-consistent probe key.
29
+ * `canonicalizeRouteKey(normalizeStreetForKey(street))` — the build/query-consistent probe key. The column NAME says
30
+ * `street_norm`, but the value carries the route fold on top of the street fold, which is why the brand is
31
+ * {@link RouteKey}: builder and probe both apply both folds, and a plain street key bound here misses every
32
+ * numbered-route row.
28
33
  */
29
- street_norm: string
34
+ street_norm: RouteKey
30
35
  /**
31
36
  * `L` or `R` — the TIGER side the address range sits on.
32
37
  */
@@ -69,11 +74,11 @@ export interface StreetSegmentTable {
69
74
  }
70
75
 
71
76
  /**
72
- * The shard's single-row calibration metadata (#374 doctrine, 2026-07-26): the conformal radius multiplier is a
77
+ * The extract's single-row calibration metadata (#374 doctrine, 2026-07-26): the conformal radius multiplier is a
73
78
  * property of the CALIBRATION SET the artifact was built against — so it ships IN the artifact (the pair-index δ
74
79
  * precedent, `neural/pair-index-resolver.ts`), not in caller code. Written once by the builder; read at open time by
75
- * {@link StreetInterpolator}. Shards built before this table exists simply lack it — the reader degrades to `undefined`
76
- * and callers fall back to the in-code per-region table (never patch shipped DBs — rebuild).
80
+ * {@link StreetInterpolator}. Extracts built before this table exists simply lack it — the reader degrades to
81
+ * `undefined` and callers fall back to the in-code per-region table (never patch shipped DBs — rebuild).
77
82
  */
78
83
  export interface InterpCalibrationRow {
79
84
  /**
@@ -142,7 +147,7 @@ export async function createStreetSegmentTable(db: Kysely<StreetSegmentDatabase>
142
147
 
143
148
  /**
144
149
  * Create + populate the single-row `interp_calibration` metadata table (see {@link InterpCalibrationRow}) — called once
145
- * by the shard builder, after the value is selected from the calibration source of record. Build-time only (async
150
+ * by the extract builder, after the value is selected from the calibration source of record. Build-time only (async
146
151
  * Kysely is fine here); the READ side is the raw sync probe in {@link StreetInterpolator}'s constructor, per the
147
152
  * sync-by-interface doctrine.
148
153
  */