@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
@@ -2,93 +2,100 @@
2
2
  * @copyright Sister Software
3
3
  * @license AGPL-3.0
4
4
  * @author Teffen Ellis, et al.
5
- * Shared development tooling for weights overlays: the symlink primitives every overlay linker uses, the
6
- * placetype-pair index build, and the manifest form ({@link materializeDevOverlay}) each locale's
7
- * `scripts/link-dev-weights.ts` declares itself in.
8
5
  */
6
+ import type { PathBuilder, PathBuilderLike } from "path-ts";
9
7
  /**
10
- * Replicate `ln -sf SRC DEST` ATOMICALLY: symlink under a temp name, then rename over the destination. A plain
11
- * unlink-then-symlink leaves a no-file window that concurrent vitest workers can hit mid-suite — bit CI on 2026-07-24.
12
- * rename(2) replaces the destination atomically.
8
+ * Replaces `dest` with a symlink to `src` by renaming a temporary link over it.
9
+ *
10
+ * The rename is atomic, so concurrent test workers never see `dest` missing.
13
11
  */
14
- export declare function linkForce(src: string, dest: string): Promise<void>;
12
+ export declare function linkForce(src: PathBuilderLike, dest: PathBuilderLike): Promise<void>;
15
13
  /**
16
- * Remove a leftover local file/symlink so the #1179 base-weights fallback engages.
14
+ * Removes a file or symlink at `dest` so that the runtime falls back to the base en-us weights.
17
15
  */
18
- export declare function removeIfPresent(dest: string): Promise<void>;
16
+ export declare function removeIfPresent(dest: PathBuilder): Promise<void>;
19
17
  /**
20
- * Symlink one soft-feed sibling into an overlay, warning rather than failing when the source is absent.
18
+ * Symlinks one optional soft-feed artifact into an overlay and returns whether the source existed.
21
19
  *
22
- * Every one of these artifacts is OPTIONAL by design — the runtime has a fallback for each, so a fresh worktree that
23
- * has not built the gazetteer still geocodes. That is why the miss prints the consequence instead of throwing: the
24
- * operator needs to know which channel just resolved OFF, not to have the link step abort.
20
+ * A missing source prints `consequenceIfMissing` and does not throw, because the
21
+ * runtime has a fallback for every soft-feed artifact.
25
22
  */
26
- export declare function linkSoftFeedSibling(source: string, destination: string, consequenceIfMissing: string): Promise<boolean>;
23
+ export declare function linkSoftFeedSibling(source: PathBuilderLike, destination: PathBuilder, consequenceIfMissing: string): Promise<boolean>;
27
24
  /**
28
- * The calibrated pair-index emission bias every shipped artifact is built at today — the R5/R6/R9/R10/R11 bars were all
29
- * measured at δ=10 (each linker's own docstring carries its locale's receipt).
25
+ * The pair-index emission bias (δ) used by every shipped pair-index artifact.
30
26
  */
31
27
  export declare const PAIR_INDEX_DELTA = 10;
32
28
  /**
33
- * The decoder transition-entry bonus (TRANSITION-BETA build, 2026-07-24 — operator-approved β=5 from the
34
- * transition-level probe). en-nz deliberately builds WITHOUT one (unmeasured there): the two magnitudes are calibrated
35
- * independently, and a locale earning one says nothing about the other.
29
+ * The decoder transition-entry bonus (β).
30
+ * Only locales that were calibrated with it pass it.
36
31
  */
37
32
  export declare const PAIR_INDEX_TRANSITION_BETA = 5;
38
33
  /**
39
- * The WHOLE-EDGE parent-bias magnitude (#46, default-on 2026-08-04) at the verdict's recommended δ=5 — see
40
- * `docs/records/evals/2026-08-04-pix1-whole-edge-verdict.md`. Only the measured locales (us/gb/nz/fr) pass it; the
41
- * D-rule's answer to an unmeasured locale is a per-locale absence, not an inherited magnitude.
34
+ * The whole-edge parent-bias magnitude.
35
+ * Only locales that were calibrated with it pass it.
36
+ *
37
+ * Other locales omit the flag and do not inherit this value.
42
38
  */
43
39
  export declare const PAIR_INDEX_PARENT_DELTA = 5;
44
40
  /**
45
- * What one pair-index build has to say about itself. Everything else is shared.
41
+ * Describes one locale's pair-index build.
42
+ *
43
+ * When `sources`, `inputs` and `extraArgs` are omitted, the build reads the shared WOF admin database.
46
44
  */
47
45
  export interface PairIndexOverlay {
48
46
  /**
49
- * Workspace directory name, e.g. `neural-weights-de-de`.
47
+ * The weights workspace directory name, such as `neural-weights-de-de`.
48
+ * The overlay locale is derived from it.
50
49
  */
51
50
  packageDir: string;
52
51
  /**
53
- * ISO country code passed to `gazetteer pair-index --country`, and the suffix of the built artifact (`de` →
54
- * `pair-index-de.bin`). NOT the locale tag: `en-in` builds `pair-index-in.bin`.
52
+ * The ISO country code passed to `--country` and used in `pair-index-<country>.bin`.
53
+ *
54
+ * It can differ from the locale tag.
55
+ * For example, `en-in` builds `pair-index-in.bin`.
55
56
  */
56
57
  country: string;
57
58
  /**
58
- * Calibrated magnitudes the locale's bars were measured at. Baked into the artifact's PIX1 header, which is how the
59
- * freshness check notices a change to any of them. An ABSENT `transitionBeta`/`parentDelta` means the flag is not
60
- * passed and the header carries no such key — a real state, distinct from zero (see `PairIndexHeader.parentDelta`).
61
- * The whole calibration feeds both the build FLAGS and the staleness EXPECTATION, so the two cannot disagree.
59
+ * The child bias magnitude.
60
+ *
61
+ * The build writes `delta`, `transitionBeta` and `parentDelta` into the PIX1 header.
62
+ * The freshness check compares them.
63
+ *
64
+ * An absent `transitionBeta` or `parentDelta` leaves its key out of the header.
65
+ * The freshness check treats an absent key as distinct from zero.
62
66
  */
63
67
  delta: number;
64
68
  transitionBeta?: number;
65
69
  parentDelta?: number;
66
70
  /**
67
- * Source FILES whose md5s the build records, in the order `gazetteer pair-index` records them. The freshness guard
68
- * compares EVERY one against the existing header (#1734): a partial comparison leaves the guard blind to the rest,
69
- * and a stale artifact then keeps reporting itself fresh while the data it was built from has moved. Empty means the
70
- * build's source cannot be file-hashed (fr's BAN directory) and freshness rests on the magnitudes alone. Default: the
71
- * WOF admin DB.
71
+ * The source files whose MD5s the build records, in the order that `gazetteer pair-index` records them.
72
+ * The default is the WOF admin database.
73
+ *
74
+ * The freshness check compares each MD5 with the header.
75
+ * An empty list makes the check compare the magnitudes only.
72
76
  */
73
- sources?: string[];
77
+ sources?: PathBuilder[];
74
78
  /**
75
- * Inputs that must exist before a build is attempted — a missing one warns and returns, because a fresh clone has no
76
- * data root and `yarn test` invokes the linkers to verify auto-resolve. Default: `sources`.
79
+ * Files that must exist before a build runs.
80
+ *
81
+ * The default is `sources`.
82
+ * A missing file prints a warning and skips the build.
77
83
  */
78
- inputs?: string[];
84
+ inputs?: PathBuilder[];
79
85
  /**
80
- * Extra CLI args naming the build's sources (`--source`, `--borough-db`, `--pairs-jsonl`, `--ban-dir`). Default:
81
- * `--borough-db <admin db>`.
86
+ * Extra CLI arguments that pass the build's sources.
87
+ * The default is `--borough-db <admin db>`.
82
88
  */
83
- extraArgs?: string[];
89
+ extraArgs?: PathBuilderLike[];
84
90
  /**
85
- * Refuse to trust an existing artifact smaller than this. fr-fr's guard: a pair index built from the WRONG source can
86
- * carry matching magnitudes, and size is the one signal the header cannot fake.
91
+ * The byte size below which an existing artifact is rebuilt.
92
+ *
93
+ * A build from the wrong source can have matching header magnitudes but a smaller size.
87
94
  */
88
95
  minimumPlausibleBytes?: number;
89
96
  }
90
97
  /**
91
- * The header fields a dev-weights freshness guard reads.
98
+ * The pair-index header fields that the dev-weights freshness check reads.
92
99
  */
93
100
  export interface PairIndexHeaderFields {
94
101
  delta: number;
@@ -96,33 +103,28 @@ export interface PairIndexHeaderFields {
96
103
  parentDelta: number | undefined;
97
104
  schemaVersion: number;
98
105
  /**
99
- * One md5 per source the build read, in fold order. Empty on a header that recorded none.
106
+ * One MD5 per source the build read, in recorded order.
107
+ * The list is empty when the header has none.
100
108
  */
101
109
  sourceMD5s: string[];
102
110
  }
103
111
  /**
104
- * Minimal PIX1 header reader — magic + header only, reimplemented so a data-only weights package gains no dependency on
105
- * `@mailwoman/neural` (which pulls onnxruntime-node) to read a few fields. `neural/pair-index-resolver.ts`'s own header
106
- * parse is the source of truth this must follow.
112
+ * Reads the calibration fields from a PIX1 pair-index header without depending on `@mailwoman/neural`.
107
113
  *
108
- * Shared by the overlay build below AND by the four hand-written base linkers
109
- * (`neural-weights-{en-us,en-gb,en-nz,fr-fr}/scripts/link-dev-weights.ts`), which each carried their own near-copy
110
- * before 2026-08-04 — the ×5 clone the taste audit named, and the reason three of them were schema-blind while this one
111
- * was not.
114
+ * The parse must match the reader in `neural/lib/pair/index/resolver.ts`.
112
115
  */
113
- export declare function peekPairIndexHeaderFields(path: string): Promise<PairIndexHeaderFields>;
116
+ export declare function peekPairIndexHeaderFields(path: PathBuilderLike): Promise<PairIndexHeaderFields>;
114
117
  /**
115
- * Md5 of `path`, cached in a standard `md5sum`-format sidecar (`<hash> <filename>`) beside it so a multi-gigabyte
116
- * source is hashed once per change rather than once per linker run. The sidecar is trusted only when at least as new as
117
- * the source; a missing or stale sidecar recomputes and rewrites, so the cache self-heals.
118
+ * Returns the MD5 of `path`, cached in a `<path>.md5` sidecar in `md5sum` format.
118
119
  *
119
- * The shared home for the copies the base linkers (`en-us`, `en-gb`, `en-nz`) each carry — new callers import this one.
120
+ * The sidecar is used only when it is at least as new as the source.
120
121
  */
121
- export declare function md5FileWithSidecar(path: string): Promise<string>;
122
+ export declare function md5FileWithSidecar(path: PathBuilderLike): Promise<string>;
122
123
  /**
123
- * The calibrated magnitudes a linker bakes into its artifact. `undefined` means the flag is NOT passed and the header
124
- * carries no such key — a real state, distinct from zero (see `PairIndexHeader.parentDelta`), so the comparison below
125
- * is `!==` against `undefined` rather than a truthiness test.
124
+ * The calibrated magnitudes that a linker writes into its pair-index artifact.
125
+ *
126
+ * An `undefined` magnitude means the header has no such key.
127
+ * It is distinct from zero.
126
128
  */
127
129
  export interface PairIndexCalibration {
128
130
  delta: number;
@@ -130,69 +132,46 @@ export interface PairIndexCalibration {
130
132
  parentDelta?: number;
131
133
  }
132
134
  /**
133
- * Why an existing `pair-index-*.bin` is stale against `expected`, or `undefined` when its header matches. Covers the
134
- * FORMAT (schemaVersion) and every calibrated magnitude; source-md5 freshness stays with the caller, because each base
135
- * linker passes a different set of sources and only it knows what they are.
135
+ * Returns why a pair-index header's schema or magnitudes differ from `expected`,
136
+ * or `undefined` when they match.
136
137
  *
137
- * One place so a magnitude added to the header cannot be checked by some linkers and not others — which is exactly how
138
- * three of the four base linkers ended up unable to notice a schema bump.
138
+ * The caller checks the source MD5s because only the caller knows its sources.
139
139
  */
140
140
  export declare function pairIndexStaleReason(header: PairIndexHeaderFields, expected: PairIndexCalibration): string | undefined;
141
141
  /**
142
- * The PIX1 schema this tree's reader requires. MUST equal `KNOWN_SCHEMA_VERSION` in `neural/pair-index-resolver.ts` —
143
- * they are two ends of one fact, and this copy exists only because a data-only overlay must not gain a dependency on
144
- * `@mailwoman/neural` (onnxruntime-node) to read one header field. Bump BOTH in the same commit; a schema bump that
145
- * leaves this behind makes every dev checkout rebuild-loop or serve an artifact the runtime refuses.
142
+ * The PIX1 schema version the pair-index reader requires.
146
143
  *
147
- * The freshness guard must compare it: a guard that checks only delta + source md5 reads a format-obsolete binary as
148
- * "current" and leaves every dev checkout with artifacts the runtime refuses — the R5 freshness-guard lesson, format
149
- * edition. Also compared by the four hand-written base linkers (`neural-weights-{en-us,en-gb,en-nz,fr-fr}`), which
150
- * import this constant rather than re-typing the number.
144
+ * It must equal `KNOWN_SCHEMA_VERSION` in `neural/lib/pair/index/resolver.ts`.
145
+ * A mismatch makes dev checkouts rebuild on every run or link an artifact that the runtime refuses.
151
146
  */
152
147
  export declare const REQUIRED_PAIR_INDEX_SCHEMA = 3;
153
148
  /**
154
- * Warn when the per-locale FST a linker just symlinked was built from a DIFFERENT admin database than the one on disk
155
- * now.
149
+ * Warns when a linked per-locale FST was built from a different admin database than the one on disk.
156
150
  *
157
- * WHY IT WARNS RATHER THAN REBUILDS, unlike its pair-index sibling above. A pair index is seconds of work and the
158
- * linker owns its whole recipe. A locale FST is a multi-minute build whose output goes to a STAGING dir on purpose —
159
- * the swap into `fst-per-locale/` is operator-approved after the battery, because an FST changes decoder behaviour and
160
- * the D-rule does not let that land unmeasured. So the guard's job is to make the drift impossible to miss, and to name
161
- * the command that starts fixing it. It is also why a stale FST is never fatal: the artifact is a decode-time bias
162
- * list, and a dev tree must still run.
163
- *
164
- * The source-side half of the comparison lives here rather than in `fst-freshness.ts` for the same reason
165
- * `pairIndexStaleReason` splits: only the caller knows which database it built against. All three FST-linking base
166
- * packages build against the same one, so they share this rather than each pinning it.
151
+ * It does not rebuild, because an FST rebuild writes to a staging directory
152
+ * and an operator swaps it in after evaluation.
167
153
  */
168
- export declare function warnIfFSTStale(fstPath: string, locale: string): Promise<void>;
154
+ export declare function warnIfFSTStale(fstPath: PathBuilder, locale: string): Promise<void>;
169
155
  /**
170
- * Symlink the per-locale FST gazetteer (`fst-<locale>.bin`) from the shared build area
171
- * (`$MAILWOMAN_DATA_ROOT/wof/fst-per-locale/`) into an overlay so `resolveWeights` surfaces `fstPath` in dev and the
172
- * runtime pipeline can auto-wire the gazetteer + street-context check, then run {@link warnIfFSTStale} on the linked
173
- * artifact. The publish flow stages the real binary (release-sequenced).
156
+ * Symlinks the per-locale FST gazetteer `fst-<locale>.bin` into an overlay
157
+ * and checks it with {@link warnIfFSTStale}.
174
158
  */
175
- export declare function linkLocaleFST(destDir: string, locale: string): Promise<void>;
159
+ export declare function linkLocaleFST(destDir: PathBuilder, locale: string): Promise<void>;
176
160
  /**
177
- * Symlink the sealed locale-general street-morphology FST (`$MAILWOMAN_DATA_ROOT/wof/fst-street-morphology.bin`,
178
- * `mailwoman gazetteer build street-morphology`) into an overlay so `resolveWeights` surfaces `streetMorphologyPath` in
179
- * dev and the street-context check (#1315) deserializes the artifact instead of rebuilding from the libpostal
180
- * dictionaries per process. Missing is non-fatal — the runtime loader's dictionary-build fallback covers it.
161
+ * Symlinks the prebuilt street-morphology FST into an overlay so that the
162
+ * street-context check does not rebuild it from dictionaries.
181
163
  */
182
- export declare function linkStreetMorphologyFST(destDir: string): Promise<void>;
164
+ export declare function linkStreetMorphologyFST(destDir: PathBuilder): Promise<void>;
183
165
  /**
184
- * Build `pair-index-<country>.bin` into the overlay, skipping the work when the artifact on disk was already built at
185
- * these magnitudes FROM the sources on disk (see {@link pairIndexIsFresh}). The calibration object drives both the
186
- * staleness expectation and the CLI flags, so a magnitude cannot be checked by the guard and dropped from the build.
166
+ * Builds `pair-index-<country>.bin` into the overlay unless the existing artifact
167
+ * already matches these magnitudes and sources.
187
168
  *
188
- * Exits non-zero on a failed build. Missing INPUTS (an unbuilt CLI, an absent source) warn and return instead: a fresh
189
- * clone has neither, and `yarn test` invokes this to verify auto-resolve, so a hard failure there would be a failure to
190
- * have run a build yet rather than a real fault.
169
+ * A failed build exits the process.
170
+ * A missing CLI or input only prints a warning, because a fresh clone has neither.
191
171
  */
192
172
  export declare function buildPairIndexOverlay(overlay: PairIndexOverlay): Promise<void>;
193
173
  /**
194
- * A soft-feed sibling an overlay links: where it comes from, the name it takes in the overlay, and the consequence line
195
- * printed when the source is missing (the link is warn-and-continue; the channel resolves OFF).
174
+ * A soft-feed artifact that an overlay links, with the warning to print when its source is missing.
196
175
  */
197
176
  export interface SoftFeedLink {
198
177
  source: string;
@@ -200,9 +179,9 @@ export interface SoftFeedLink {
200
179
  consequenceIfMissing: string;
201
180
  }
202
181
  /**
203
- * The committed soft-feed lexicons as links, by channel, read from `release.config.json` so the filename a manifest
204
- * links is the one the release ships. `streetType` is offered for completeness; the manifests link the evidence
205
- * lexicons by the generation their CARD names instead (`evidenceLexiconsFromCard`).
182
+ * Returns the committed soft-feed lexicons as links.
183
+ *
184
+ * The filenames come from `release.config.json` so that dev links match the release.
206
185
  */
207
186
  export declare function committedSoftFeedLinks(): Promise<{
208
187
  anchor: SoftFeedLink;
@@ -210,8 +189,7 @@ export declare function committedSoftFeedLinks(): Promise<{
210
189
  streetType?: SoftFeedLink;
211
190
  }>;
212
191
  /**
213
- * The slice of a weights package's committed `model-card.json` the dev materialization reads: the shipped digests the
214
- * release re-verifies against the published tarball, and the channel requirements that name evidence lexicons.
192
+ * The fields of a weights package's `model-card.json` that dev materialization reads.
215
193
  */
216
194
  export interface WeightsCard {
217
195
  files_md5?: Record<string, string>;
@@ -221,26 +199,34 @@ export interface WeightsCard {
221
199
  } | undefined>;
222
200
  }
223
201
  /**
224
- * What one locale's `scripts/link-dev-weights.ts` declares, so an overlay is a manifest plus a call rather than a
225
- * script cloned from a sibling. Every step is optional and runs only when named, in a fixed order: model pair,
226
- * soft-feed siblings, card-named evidence lexicons, postcode binary, pair index, FSTs.
202
+ * Declares what one locale's dev overlay contains. {@link materializeDevOverlay}
203
+ * runs the steps in the order the fields are listed.
227
204
  */
228
205
  export interface DevOverlayManifest {
229
206
  /**
230
- * The overlay's locale tag, lower-case. The workspace is `neural-weights-<locale>` and the artifacts land in
231
- * `$MAILWOMAN_DATA_ROOT/weights/<locale>/`, never in the tracked package: the binaries are not in git, so
232
- * materializing them there made a fresh worktree unable to geocode, made `yarn test` mutate a tracked directory, and
233
- * put a symlink into a publish tarball (`YN0035`).
207
+ * The overlay's lowercase locale tag.
208
+ * The workspace is `neural-weights-<locale>`.
209
+ *
210
+ * Artifacts go to the data root's `weights/<locale>/` overlay because the binaries are kept out of git.
234
211
  */
235
212
  locale: string;
236
213
  /**
237
- * What happens to `model.onnx` + `tokenizer.model`. `link`: the pair is symlinked from the paths
238
- * `release.config.json`'s `weights` block names under the data root (`$MAILWOMAN_DEV_MODEL` /
239
- * `$MAILWOMAN_DEV_TOKENIZER` override them), and when `digestCard` names a workspace the linked default bytes must
240
- * match that workspace's card `files_md5` — the #397 drift guard, which fails loud instead of grading the wrong
241
- * model; an override skips the check and says so. `inherit`: the package declares `mailwoman.baseWeights`, so any
242
- * local pair is REMOVED — a stale local file shadows the base fallback and silently serves outdated bytes. Omitted:
243
- * the pair is left to `packages/release-kit/lib/weights/link-weights-overlay.ts`, the recipe writer.
214
+ * How the overlay gets its model files.
215
+ *
216
+ * When it is omitted, `link-weights-overlay.ts` in release-kit handles them.
217
+ *
218
+ * The `link` kind symlinks `model.onnx` and `tokenizer.model` from the
219
+ * `release.config.json` weights paths under the data root.
220
+ * The `$MAILWOMAN_DEV_MODEL` and `$MAILWOMAN_DEV_TOKENIZER` variables override those paths.
221
+ *
222
+ * With `digestCard`, the linked default files must match the `files_md5` of that workspace's card.
223
+ * An override skips this check.
224
+ *
225
+ * The `inherit` kind removes any local pair, because the package declares
226
+ * `mailwoman.baseWeights` and a local file would shadow the base.
227
+ *
228
+ * The `char` kind links the `charWeights.<family>` model, character vocabulary and model card.
229
+ * It removes any tokenizer.
244
230
  */
245
231
  model?: {
246
232
  kind: "link";
@@ -252,48 +238,53 @@ export interface DevOverlayManifest {
252
238
  family: string;
253
239
  };
254
240
  /**
255
- * Soft-feed siblings linked warn-and-continue, in order.
241
+ * Soft-feed siblings to link in order.
242
+ * A missing source prints a warning and the step continues.
256
243
  */
257
244
  softFeed?: ReadonlyArray<SoftFeedLink>;
258
245
  /**
259
- * Link the evidence lexicons the overlay's own card names under `requires.<channel>.lexicon`, so the generation comes
260
- * from the card the loader reads and a card bump moves the artifact with it. `street-type-lexicon-v*.json` is
261
- * committed under `data/gazetteer/`; `locality-surface-lexicon-v*.json` is 7–13 MB and lives in the data root.
246
+ * Whether to link the evidence lexicons listed under `requires.<channel>.lexicon`
247
+ * in the overlay's model card.
248
+ * A card update then changes the linked file too.
249
+ *
250
+ * The street-type lexicon comes from the repo's `data/gazetteer/`.
251
+ * The locality-surface lexicon comes from the data root.
262
252
  */
263
253
  evidenceLexiconsFromCard?: boolean;
264
254
  /**
265
- * Build `postcode-<country>.bin` from a WOF postcode extract through the compiled `gazetteer postcode-binary` CLI,
266
- * skipped when already present (it rebuilds in seconds, and the extract is versionless on disk).
255
+ * Builds `postcode-<country>.bin` from a WOF postcode extract with the compiled CLI.
256
+ * The step is skipped when the file already exists.
267
257
  */
268
258
  postcodeBinary?: {
269
259
  country: string;
270
- database: string;
260
+ database: PathBuilder;
271
261
  };
272
262
  /**
273
- * The placetype-pair index build, minus `packageDir`, which follows from `locale`.
263
+ * The placetype-pair index build.
264
+ * Its `packageDir` is derived from `locale`.
274
265
  */
275
266
  pairIndex?: Omit<PairIndexOverlay, "packageDir">;
276
267
  /**
277
- * Link `fst-<locale>.bin` with its freshness warning.
268
+ * Whether to link `fst-<locale>.bin` and warn when it is stale.
278
269
  */
279
270
  localeFST?: boolean;
280
271
  /**
281
- * Link the shared street-morphology FST.
272
+ * Whether to link the shared street-morphology FST.
282
273
  */
283
274
  streetMorphologyFST?: boolean;
284
275
  }
285
276
  /**
286
- * What a materialized overlay hands back for the locale-specific step a manifest cannot express (en-gb's
287
- * card-conditional postcode binary is the one that exists).
277
+ * The overlay directory, CLI path and model card that {@link materializeDevOverlay} returns.
278
+ *
279
+ * Callers use them for locale-specific steps that a manifest cannot express.
288
280
  */
289
281
  export interface DevOverlay {
290
- destDir: string;
291
- cli: string;
282
+ destDir: PathBuilder;
283
+ cli: PathBuilder;
292
284
  card: WeightsCard | undefined;
293
285
  }
294
286
  /**
295
- * Materialize one locale's dev overlay from its manifest. The steps run in the order {@link DevOverlayManifest}
296
- * documents, each independent on disk, and the result carries what a locale-specific step needs afterwards.
287
+ * Materializes one locale's dev weights overlay from its manifest.
297
288
  */
298
289
  export declare function materializeDevOverlay(manifest: DevOverlayManifest): Promise<DevOverlay>;
299
290
  //# sourceMappingURL=weights-overlay-linker.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"weights-overlay-linker.d.ts","sourceRoot":"","sources":["../lib/weights-overlay-linker.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AA6BH;;;;GAIG;AACH,wBAAsB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CASxE;AAED;;GAEG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAUjE;AAED;;;;;;GAMG;AACH,wBAAsB,mBAAmB,CACxC,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,oBAAoB,EAAE,MAAM,GAC1B,OAAO,CAAC,OAAO,CAAC,CAYlB;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB,KAAK,CAAA;AAElC;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,IAAI,CAAA;AAE3C;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,IAAI,CAAA;AAExC;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAA;IACb,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,KAAK,EAAE,MAAM,CAAA;IACb,cAAc,EAAE,MAAM,GAAG,SAAS,CAAA;IAClC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,EAAE,CAAA;CACpB;AAED;;;;;;;;;GASG;AACH,wBAAsB,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CA2B5F;AAOD;;;;;;GAMG;AAEH,wBAAsB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAsBtE;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACpC,KAAK,EAAE,MAAM,CAAA;IACb,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,WAAW,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CACnC,MAAM,EAAE,qBAAqB,EAC7B,QAAQ,EAAE,oBAAoB,GAC5B,MAAM,GAAG,SAAS,CAgBpB;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,0BAA0B,IAAI,CAAA;AAE3C;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAUnF;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAYlF;AAED;;;;;GAKG;AACH,wBAAsB,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAM5E;AAuFD;;;;;;;;GAQG;AACH,wBAAsB,qBAAqB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CA2EpF;AAID;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,oBAAoB,EAAE,MAAM,CAAA;CAC5B;AAED;;;;GAIG;AACH,wBAAsB,sBAAsB,IAAI,OAAO,CAAC;IACvD,MAAM,EAAE,YAAY,CAAA;IACpB,OAAO,EAAE,YAAY,CAAA;IACrB,UAAU,CAAC,EAAE,YAAY,CAAA;CACzB,CAAC,CAsBD;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC,CAAA;CAC/E;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAClC;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,SAAS,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;IACtG;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC,YAAY,CAAC,CAAA;IACtC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC;;;OAGG;IACH,cAAc,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAA;IACtD;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAAA;IAChD;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,WAAW,GAAG,SAAS,CAAA;CAC7B;AA2KD;;;GAGG;AACH,wBAAsB,qBAAqB,CAAC,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,CAuD7F"}
1
+ {"version":3,"file":"weights-overlay-linker.d.ts","sourceRoot":"","sources":["../lib/weights-overlay-linker.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAuBH,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAM3D;;;;GAIG;AACH,wBAAsB,SAAS,CAAC,GAAG,EAAE,eAAe,EAAE,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAS1F;AAED;;GAEG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAUtE;AAED;;;;;GAKG;AACH,wBAAsB,mBAAmB,CACxC,MAAM,EAAE,eAAe,EACvB,WAAW,EAAE,WAAW,EACxB,oBAAoB,EAAE,MAAM,GAC1B,OAAO,CAAC,OAAO,CAAC,CAYlB;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,KAAK,CAAA;AAElC;;;GAGG;AACH,eAAO,MAAM,0BAA0B,IAAI,CAAA;AAE3C;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,IAAI,CAAA;AAExC;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;;;;OAKG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;;;;;;;OAQG;IACH,KAAK,EAAE,MAAM,CAAA;IACb,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,WAAW,EAAE,CAAA;IAEvB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;IAEtB;;;OAGG;IACH,SAAS,CAAC,EAAE,eAAe,EAAE,CAAA;IAE7B;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,KAAK,EAAE,MAAM,CAAA;IACb,cAAc,EAAE,MAAM,GAAG,SAAS,CAAA;IAClC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,aAAa,EAAE,MAAM,CAAA;IAErB;;;OAGG;IACH,UAAU,EAAE,MAAM,EAAE,CAAA;CACpB;AAED;;;;GAIG;AACH,wBAAsB,yBAAyB,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,qBAAqB,CAAC,CA2BrG;AAMD;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAoB/E;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACpC,KAAK,EAAE,MAAM,CAAA;IACb,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,WAAW,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CACnC,MAAM,EAAE,qBAAqB,EAC7B,QAAQ,EAAE,oBAAoB,GAC5B,MAAM,GAAG,SAAS,CAgBpB;AAED;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,IAAI,CAAA;AAE3C;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAUxF;AAED;;;GAGG;AACH,wBAAsB,aAAa,CAAC,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAYvF;AAED;;;GAGG;AACH,wBAAsB,uBAAuB,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAMjF;AA+ED;;;;;;GAMG;AACH,wBAAsB,qBAAqB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAsEpF;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,oBAAoB,EAAE,MAAM,CAAA;CAC5B;AAED;;;;GAIG;AACH,wBAAsB,sBAAsB,IAAI,OAAO,CAAC;IACvD,MAAM,EAAE,YAAY,CAAA;IACpB,OAAO,EAAE,YAAY,CAAA;IACrB,UAAU,CAAC,EAAE,YAAY,CAAA;CACzB,CAAC,CAsBD;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC,CAAA;CAC/E;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAClC;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,SAAS,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;IAEtG;;;OAGG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC,YAAY,CAAC,CAAA;IAEtC;;;;;;;OAOG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAElC;;;OAGG;IACH,cAAc,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,WAAW,CAAA;KAAE,CAAA;IAE3D;;;OAGG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAAA;IAEhD;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IAC1B,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,WAAW,CAAA;IAChB,IAAI,EAAE,WAAW,GAAG,SAAS,CAAA;CAC7B;AA8JD;;GAEG;AACH,wBAAsB,qBAAqB,CAAC,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,CAuD7F"}