@vepler/sdk 2.164.0 → 3.0.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 (636) hide show
  1. package/README.md +408 -401
  2. package/dist/commonjs/address-search/__tests__/controller.test.d.ts +2 -0
  3. package/dist/commonjs/address-search/__tests__/controller.test.d.ts.map +1 -0
  4. package/dist/commonjs/address-search/__tests__/controller.test.js +329 -0
  5. package/dist/commonjs/address-search/__tests__/controller.test.js.map +1 -0
  6. package/dist/commonjs/address-search/__tests__/default-transports.test.d.ts +2 -0
  7. package/dist/commonjs/address-search/__tests__/default-transports.test.d.ts.map +1 -0
  8. package/dist/commonjs/address-search/__tests__/default-transports.test.js +161 -0
  9. package/dist/commonjs/address-search/__tests__/default-transports.test.js.map +1 -0
  10. package/dist/commonjs/address-search/__tests__/narrow.test.d.ts +2 -0
  11. package/dist/commonjs/address-search/__tests__/narrow.test.d.ts.map +1 -0
  12. package/dist/commonjs/address-search/__tests__/narrow.test.js +63 -0
  13. package/dist/commonjs/address-search/__tests__/narrow.test.js.map +1 -0
  14. package/dist/commonjs/address-search/controller.d.ts +14 -0
  15. package/dist/commonjs/address-search/controller.d.ts.map +1 -0
  16. package/dist/commonjs/address-search/controller.js +190 -0
  17. package/dist/commonjs/address-search/controller.js.map +1 -0
  18. package/dist/commonjs/address-search/default-transports.d.ts +52 -0
  19. package/dist/commonjs/address-search/default-transports.d.ts.map +1 -0
  20. package/dist/commonjs/address-search/default-transports.js +134 -0
  21. package/dist/commonjs/address-search/default-transports.js.map +1 -0
  22. package/dist/commonjs/address-search/errors.d.ts +5 -0
  23. package/dist/commonjs/address-search/errors.d.ts.map +1 -0
  24. package/dist/commonjs/address-search/errors.js +12 -0
  25. package/dist/commonjs/address-search/errors.js.map +1 -0
  26. package/dist/commonjs/address-search/index.d.ts +8 -0
  27. package/dist/commonjs/address-search/index.d.ts.map +1 -0
  28. package/dist/commonjs/address-search/index.js +43 -0
  29. package/dist/commonjs/address-search/index.js.map +1 -0
  30. package/dist/commonjs/address-search/lru-cache.d.ts +13 -0
  31. package/dist/commonjs/address-search/lru-cache.d.ts.map +1 -0
  32. package/dist/commonjs/address-search/lru-cache.js +50 -0
  33. package/dist/commonjs/address-search/lru-cache.js.map +1 -0
  34. package/dist/commonjs/address-search/narrow.d.ts +21 -0
  35. package/dist/commonjs/address-search/narrow.d.ts.map +1 -0
  36. package/dist/commonjs/address-search/narrow.js +49 -0
  37. package/dist/commonjs/address-search/narrow.js.map +1 -0
  38. package/dist/commonjs/address-search/types.d.ts +125 -0
  39. package/dist/commonjs/address-search/types.d.ts.map +1 -0
  40. package/dist/commonjs/address-search/types.js +9 -0
  41. package/dist/commonjs/address-search/types.js.map +1 -0
  42. package/dist/commonjs/address-search.d.ts +3 -0
  43. package/dist/commonjs/address-search.d.ts.map +1 -0
  44. package/dist/commonjs/address-search.js +19 -0
  45. package/dist/commonjs/address-search.js.map +1 -0
  46. package/dist/commonjs/funcs/avmPredictPropertyValue.d.ts +1 -1
  47. package/dist/commonjs/funcs/avmPredictPropertyValue.d.ts.map +1 -1
  48. package/dist/commonjs/funcs/avmPredictPropertyValue.js +1 -1
  49. package/dist/commonjs/funcs/avmPredictPropertyValue.js.map +1 -1
  50. package/dist/commonjs/funcs/propertyGetProperties.js +1 -0
  51. package/dist/commonjs/funcs/propertyGetProperties.js.map +1 -1
  52. package/dist/commonjs/funcs/propertyGetPropertiesByLocation.js +1 -0
  53. package/dist/commonjs/funcs/propertyGetPropertiesByLocation.js.map +1 -1
  54. package/dist/commonjs/funcs/propertyGetPropertiesBySource.js +1 -0
  55. package/dist/commonjs/funcs/propertyGetPropertiesBySource.js.map +1 -1
  56. package/dist/commonjs/funcs/searchSearchRetrieve.d.ts +23 -0
  57. package/dist/commonjs/funcs/searchSearchRetrieve.d.ts.map +1 -0
  58. package/dist/commonjs/funcs/searchSearchRetrieve.js +128 -0
  59. package/dist/commonjs/funcs/searchSearchRetrieve.js.map +1 -0
  60. package/dist/commonjs/funcs/searchSearchSuggest.d.ts +3 -1
  61. package/dist/commonjs/funcs/searchSearchSuggest.d.ts.map +1 -1
  62. package/dist/commonjs/funcs/searchSearchSuggest.js +5 -1
  63. package/dist/commonjs/funcs/searchSearchSuggest.js.map +1 -1
  64. package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts +1 -1
  65. package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts.map +1 -1
  66. package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js +2 -1
  67. package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js.map +1 -1
  68. package/dist/commonjs/lib/config.d.ts +3 -3
  69. package/dist/commonjs/lib/config.js +3 -3
  70. package/dist/commonjs/lib/config.js.map +1 -1
  71. package/dist/commonjs/sdk/models/errors/index.d.ts +1 -0
  72. package/dist/commonjs/sdk/models/errors/index.d.ts.map +1 -1
  73. package/dist/commonjs/sdk/models/errors/index.js +1 -0
  74. package/dist/commonjs/sdk/models/errors/index.js.map +1 -1
  75. package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts +65 -0
  76. package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts.map +1 -1
  77. package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.js +55 -1
  78. package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.js.map +1 -1
  79. package/dist/commonjs/sdk/models/errors/predictpropertyvalue.d.ts +65 -0
  80. package/dist/commonjs/sdk/models/errors/predictpropertyvalue.d.ts.map +1 -1
  81. package/dist/commonjs/sdk/models/errors/predictpropertyvalue.js +57 -1
  82. package/dist/commonjs/sdk/models/errors/predictpropertyvalue.js.map +1 -1
  83. package/dist/commonjs/sdk/models/errors/searchretrieve.d.ts +201 -0
  84. package/dist/commonjs/sdk/models/errors/searchretrieve.d.ts.map +1 -0
  85. package/dist/commonjs/sdk/models/errors/searchretrieve.js +213 -0
  86. package/dist/commonjs/sdk/models/errors/searchretrieve.js.map +1 -0
  87. package/dist/commonjs/sdk/models/operations/getcensuswholelevel.d.ts +1 -0
  88. package/dist/commonjs/sdk/models/operations/getcensuswholelevel.d.ts.map +1 -1
  89. package/dist/commonjs/sdk/models/operations/getcensuswholelevel.js +1 -0
  90. package/dist/commonjs/sdk/models/operations/getcensuswholelevel.js.map +1 -1
  91. package/dist/commonjs/sdk/models/operations/getlistingbyid.d.ts +18 -15
  92. package/dist/commonjs/sdk/models/operations/getlistingbyid.d.ts.map +1 -1
  93. package/dist/commonjs/sdk/models/operations/getlistingbyid.js +15 -15
  94. package/dist/commonjs/sdk/models/operations/getlistingbyid.js.map +1 -1
  95. package/dist/commonjs/sdk/models/operations/getlistingbysource.d.ts +18 -15
  96. package/dist/commonjs/sdk/models/operations/getlistingbysource.d.ts.map +1 -1
  97. package/dist/commonjs/sdk/models/operations/getlistingbysource.js +15 -15
  98. package/dist/commonjs/sdk/models/operations/getlistingbysource.js.map +1 -1
  99. package/dist/commonjs/sdk/models/operations/getlistingsbylocation.d.ts +18 -15
  100. package/dist/commonjs/sdk/models/operations/getlistingsbylocation.d.ts.map +1 -1
  101. package/dist/commonjs/sdk/models/operations/getlistingsbylocation.js +16 -15
  102. package/dist/commonjs/sdk/models/operations/getlistingsbylocation.js.map +1 -1
  103. package/dist/commonjs/sdk/models/operations/getproperties.d.ts +5 -0
  104. package/dist/commonjs/sdk/models/operations/getproperties.d.ts.map +1 -1
  105. package/dist/commonjs/sdk/models/operations/getproperties.js +1 -0
  106. package/dist/commonjs/sdk/models/operations/getproperties.js.map +1 -1
  107. package/dist/commonjs/sdk/models/operations/getpropertiesbylocation.d.ts +5 -0
  108. package/dist/commonjs/sdk/models/operations/getpropertiesbylocation.d.ts.map +1 -1
  109. package/dist/commonjs/sdk/models/operations/getpropertiesbylocation.js +1 -0
  110. package/dist/commonjs/sdk/models/operations/getpropertiesbylocation.js.map +1 -1
  111. package/dist/commonjs/sdk/models/operations/getpropertiesbysource.d.ts +5 -0
  112. package/dist/commonjs/sdk/models/operations/getpropertiesbysource.d.ts.map +1 -1
  113. package/dist/commonjs/sdk/models/operations/getpropertiesbysource.js +1 -0
  114. package/dist/commonjs/sdk/models/operations/getpropertiesbysource.js.map +1 -1
  115. package/dist/commonjs/sdk/models/operations/index.d.ts +1 -0
  116. package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
  117. package/dist/commonjs/sdk/models/operations/index.js +1 -0
  118. package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
  119. package/dist/commonjs/sdk/models/operations/querylistings.d.ts +18 -15
  120. package/dist/commonjs/sdk/models/operations/querylistings.d.ts.map +1 -1
  121. package/dist/commonjs/sdk/models/operations/querylistings.js +17 -16
  122. package/dist/commonjs/sdk/models/operations/querylistings.js.map +1 -1
  123. package/dist/commonjs/sdk/models/operations/querylistingsbysource.d.ts +18 -15
  124. package/dist/commonjs/sdk/models/operations/querylistingsbysource.d.ts.map +1 -1
  125. package/dist/commonjs/sdk/models/operations/querylistingsbysource.js +16 -15
  126. package/dist/commonjs/sdk/models/operations/querylistingsbysource.js.map +1 -1
  127. package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts +16 -3
  128. package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts.map +1 -1
  129. package/dist/commonjs/sdk/models/operations/resolveaddress.js +18 -3
  130. package/dist/commonjs/sdk/models/operations/resolveaddress.js.map +1 -1
  131. package/dist/commonjs/sdk/models/operations/searchretrieve.d.ts +20 -0
  132. package/dist/commonjs/sdk/models/operations/searchretrieve.d.ts.map +1 -0
  133. package/dist/commonjs/sdk/models/operations/searchretrieve.js +55 -0
  134. package/dist/commonjs/sdk/models/operations/searchretrieve.js.map +1 -0
  135. package/dist/commonjs/sdk/models/operations/searchsuggest.d.ts +35 -0
  136. package/dist/commonjs/sdk/models/operations/searchsuggest.d.ts.map +1 -1
  137. package/dist/commonjs/sdk/models/operations/searchsuggest.js +18 -1
  138. package/dist/commonjs/sdk/models/operations/searchsuggest.js.map +1 -1
  139. package/dist/commonjs/sdk/models/shared/addressresolverequest.d.ts +27 -0
  140. package/dist/commonjs/sdk/models/shared/addressresolverequest.d.ts.map +1 -1
  141. package/dist/commonjs/sdk/models/shared/addressresolverequest.js +25 -1
  142. package/dist/commonjs/sdk/models/shared/addressresolverequest.js.map +1 -1
  143. package/dist/commonjs/sdk/models/shared/advancedlisting.d.ts +2 -2
  144. package/dist/commonjs/sdk/models/shared/advancedlisting.d.ts.map +1 -1
  145. package/dist/commonjs/sdk/models/shared/advancedlisting.js +2 -2
  146. package/dist/commonjs/sdk/models/shared/advancedlisting.js.map +1 -1
  147. package/dist/commonjs/sdk/models/shared/aggregationresult.d.ts +2 -1
  148. package/dist/commonjs/sdk/models/shared/aggregationresult.d.ts.map +1 -1
  149. package/dist/commonjs/sdk/models/shared/aggregationresult.js +2 -0
  150. package/dist/commonjs/sdk/models/shared/aggregationresult.js.map +1 -1
  151. package/dist/commonjs/sdk/models/shared/censusareaprofilerequest.d.ts +20 -0
  152. package/dist/commonjs/sdk/models/shared/censusareaprofilerequest.d.ts.map +1 -1
  153. package/dist/commonjs/sdk/models/shared/censusareaprofilerequest.js +13 -1
  154. package/dist/commonjs/sdk/models/shared/censusareaprofilerequest.js.map +1 -1
  155. package/dist/commonjs/sdk/models/shared/censusrolluprequest.d.ts +20 -0
  156. package/dist/commonjs/sdk/models/shared/censusrolluprequest.d.ts.map +1 -1
  157. package/dist/commonjs/sdk/models/shared/censusrolluprequest.js +12 -1
  158. package/dist/commonjs/sdk/models/shared/censusrolluprequest.js.map +1 -1
  159. package/dist/commonjs/sdk/models/shared/geocodeprecision.d.ts +17 -0
  160. package/dist/commonjs/sdk/models/shared/geocodeprecision.d.ts.map +1 -0
  161. package/dist/commonjs/sdk/models/shared/geocodeprecision.js +51 -0
  162. package/dist/commonjs/sdk/models/shared/geocodeprecision.js.map +1 -0
  163. package/dist/commonjs/sdk/models/shared/histogrambucket.d.ts +7 -0
  164. package/dist/commonjs/sdk/models/shared/histogrambucket.d.ts.map +1 -1
  165. package/dist/commonjs/sdk/models/shared/histogrambucket.js +4 -2
  166. package/dist/commonjs/sdk/models/shared/histogrambucket.js.map +1 -1
  167. package/dist/commonjs/sdk/models/shared/index.d.ts +15 -7
  168. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  169. package/dist/commonjs/sdk/models/shared/index.js +15 -7
  170. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  171. package/dist/commonjs/sdk/models/shared/mortgagecharge.d.ts +38 -0
  172. package/dist/commonjs/sdk/models/shared/mortgagecharge.d.ts.map +1 -0
  173. package/dist/commonjs/sdk/models/shared/{extractionmortgagecharge.js → mortgagecharge.js} +11 -11
  174. package/dist/commonjs/sdk/models/shared/mortgagecharge.js.map +1 -0
  175. package/dist/commonjs/sdk/models/shared/nestedaggregationresult.d.ts +16 -0
  176. package/dist/commonjs/sdk/models/shared/nestedaggregationresult.d.ts.map +1 -0
  177. package/dist/commonjs/sdk/models/shared/{extractionproprietor.js → nestedaggregationresult.js} +12 -15
  178. package/dist/commonjs/sdk/models/shared/nestedaggregationresult.js.map +1 -0
  179. package/dist/commonjs/sdk/models/shared/othercharge.d.ts +23 -0
  180. package/dist/commonjs/sdk/models/shared/othercharge.d.ts.map +1 -0
  181. package/dist/commonjs/sdk/models/shared/{extractionothercharge.js → othercharge.js} +6 -6
  182. package/dist/commonjs/sdk/models/shared/othercharge.js.map +1 -0
  183. package/dist/commonjs/sdk/models/shared/propertyaddress.d.ts +24 -2
  184. package/dist/commonjs/sdk/models/shared/propertyaddress.d.ts.map +1 -1
  185. package/dist/commonjs/sdk/models/shared/propertyaddress.js +14 -2
  186. package/dist/commonjs/sdk/models/shared/propertyaddress.js.map +1 -1
  187. package/dist/commonjs/sdk/models/shared/propertybyslugsrequest.d.ts +5 -0
  188. package/dist/commonjs/sdk/models/shared/propertybyslugsrequest.d.ts.map +1 -1
  189. package/dist/commonjs/sdk/models/shared/propertybyslugsrequest.js +1 -0
  190. package/dist/commonjs/sdk/models/shared/propertybyslugsrequest.js.map +1 -1
  191. package/dist/commonjs/sdk/models/shared/propertydataapi.d.ts +38 -0
  192. package/dist/commonjs/sdk/models/shared/propertydataapi.d.ts.map +1 -1
  193. package/dist/commonjs/sdk/models/shared/propertydataapi.js +22 -1
  194. package/dist/commonjs/sdk/models/shared/propertydataapi.js.map +1 -1
  195. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.d.ts +5 -0
  196. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.d.ts.map +1 -1
  197. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.js +1 -0
  198. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.js.map +1 -1
  199. package/dist/commonjs/sdk/models/shared/registeredcharges.d.ts +14 -0
  200. package/dist/commonjs/sdk/models/shared/registeredcharges.d.ts.map +1 -0
  201. package/dist/commonjs/sdk/models/shared/registeredcharges.js +54 -0
  202. package/dist/commonjs/sdk/models/shared/registeredcharges.js.map +1 -0
  203. package/dist/commonjs/sdk/models/shared/salerecord.d.ts +45 -0
  204. package/dist/commonjs/sdk/models/shared/salerecord.d.ts.map +1 -1
  205. package/dist/commonjs/sdk/models/shared/salerecord.js +26 -1
  206. package/dist/commonjs/sdk/models/shared/salerecord.js.map +1 -1
  207. package/dist/commonjs/sdk/models/shared/searchresponse.d.ts +8 -0
  208. package/dist/commonjs/sdk/models/shared/searchresponse.d.ts.map +1 -1
  209. package/dist/commonjs/sdk/models/shared/searchresponse.js +4 -0
  210. package/dist/commonjs/sdk/models/shared/searchresponse.js.map +1 -1
  211. package/dist/commonjs/sdk/models/shared/searchretrieveresponse.d.ts +82 -0
  212. package/dist/commonjs/sdk/models/shared/searchretrieveresponse.d.ts.map +1 -0
  213. package/dist/commonjs/sdk/models/shared/searchretrieveresponse.js +88 -0
  214. package/dist/commonjs/sdk/models/shared/searchretrieveresponse.js.map +1 -0
  215. package/dist/commonjs/sdk/models/shared/streetmatch.d.ts +106 -0
  216. package/dist/commonjs/sdk/models/shared/streetmatch.d.ts.map +1 -0
  217. package/dist/commonjs/sdk/models/shared/streetmatch.js +84 -0
  218. package/dist/commonjs/sdk/models/shared/streetmatch.js.map +1 -0
  219. package/dist/commonjs/sdk/models/shared/termsbucket.d.ts +3 -0
  220. package/dist/commonjs/sdk/models/shared/termsbucket.d.ts.map +1 -1
  221. package/dist/commonjs/sdk/models/shared/termsbucket.js +2 -2
  222. package/dist/commonjs/sdk/models/shared/termsbucket.js.map +1 -1
  223. package/dist/commonjs/sdk/models/shared/titlecovenant.d.ts +23 -0
  224. package/dist/commonjs/sdk/models/shared/titlecovenant.d.ts.map +1 -0
  225. package/dist/commonjs/sdk/models/shared/{extractionrestriction.js → titlecovenant.js} +6 -6
  226. package/dist/commonjs/sdk/models/shared/titlecovenant.js.map +1 -0
  227. package/dist/commonjs/sdk/models/shared/{extractiondocumentsummary.d.ts → titledocumentsummary.d.ts} +9 -9
  228. package/dist/commonjs/sdk/models/shared/titledocumentsummary.d.ts.map +1 -0
  229. package/dist/commonjs/sdk/models/shared/{extractiondocumentsummary.js → titledocumentsummary.js} +11 -11
  230. package/dist/commonjs/sdk/models/shared/titledocumentsummary.js.map +1 -0
  231. package/dist/commonjs/sdk/models/shared/titleextractionpayload.d.ts +83 -0
  232. package/dist/commonjs/sdk/models/shared/titleextractionpayload.d.ts.map +1 -0
  233. package/dist/commonjs/sdk/models/shared/titleextractionpayload.js +103 -0
  234. package/dist/commonjs/sdk/models/shared/titleextractionpayload.js.map +1 -0
  235. package/dist/commonjs/sdk/models/shared/titleextractionpollresponse.d.ts +2 -2
  236. package/dist/commonjs/sdk/models/shared/titleextractionpollresponse.d.ts.map +1 -1
  237. package/dist/commonjs/sdk/models/shared/titleextractionpollresponse.js +2 -2
  238. package/dist/commonjs/sdk/models/shared/titleextractionpollresponse.js.map +1 -1
  239. package/dist/{esm/sdk/models/shared/extractionnotice.d.ts → commonjs/sdk/models/shared/titlenotice.d.ts} +13 -4
  240. package/dist/commonjs/sdk/models/shared/titlenotice.d.ts.map +1 -0
  241. package/dist/commonjs/sdk/models/shared/{extractionnotice.js → titlenotice.js} +6 -6
  242. package/dist/commonjs/sdk/models/shared/titlenotice.js.map +1 -0
  243. package/dist/commonjs/sdk/models/shared/titleproprietor.d.ts +54 -0
  244. package/dist/commonjs/sdk/models/shared/titleproprietor.d.ts.map +1 -0
  245. package/dist/commonjs/sdk/models/shared/titleproprietor.js +75 -0
  246. package/dist/commonjs/sdk/models/shared/titleproprietor.js.map +1 -0
  247. package/dist/commonjs/sdk/models/shared/titlerestriction.d.ts +23 -0
  248. package/dist/commonjs/sdk/models/shared/titlerestriction.d.ts.map +1 -0
  249. package/dist/commonjs/sdk/models/shared/titlerestriction.js +54 -0
  250. package/dist/commonjs/sdk/models/shared/titlerestriction.js.map +1 -0
  251. package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.d.ts +13 -0
  252. package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.d.ts.map +1 -0
  253. package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.js +50 -0
  254. package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.js.map +1 -0
  255. package/dist/commonjs/sdk/models/shared/titlesummarycounts.d.ts +15 -0
  256. package/dist/commonjs/sdk/models/shared/titlesummarycounts.d.ts.map +1 -0
  257. package/dist/commonjs/sdk/models/shared/titlesummarycounts.js +55 -0
  258. package/dist/commonjs/sdk/models/shared/titlesummarycounts.js.map +1 -0
  259. package/dist/commonjs/sdk/search.d.ts +14 -1
  260. package/dist/commonjs/sdk/search.d.ts.map +1 -1
  261. package/dist/commonjs/sdk/search.js +17 -1
  262. package/dist/commonjs/sdk/search.js.map +1 -1
  263. package/dist/esm/address-search/__tests__/controller.test.d.ts +2 -0
  264. package/dist/esm/address-search/__tests__/controller.test.d.ts.map +1 -0
  265. package/dist/esm/address-search/__tests__/controller.test.js +327 -0
  266. package/dist/esm/address-search/__tests__/controller.test.js.map +1 -0
  267. package/dist/esm/address-search/__tests__/default-transports.test.d.ts +2 -0
  268. package/dist/esm/address-search/__tests__/default-transports.test.d.ts.map +1 -0
  269. package/dist/esm/address-search/__tests__/default-transports.test.js +159 -0
  270. package/dist/esm/address-search/__tests__/default-transports.test.js.map +1 -0
  271. package/dist/esm/address-search/__tests__/narrow.test.d.ts +2 -0
  272. package/dist/esm/address-search/__tests__/narrow.test.d.ts.map +1 -0
  273. package/dist/esm/address-search/__tests__/narrow.test.js +61 -0
  274. package/dist/esm/address-search/__tests__/narrow.test.js.map +1 -0
  275. package/dist/esm/address-search/controller.d.ts +14 -0
  276. package/dist/esm/address-search/controller.d.ts.map +1 -0
  277. package/dist/esm/address-search/controller.js +187 -0
  278. package/dist/esm/address-search/controller.js.map +1 -0
  279. package/dist/esm/address-search/default-transports.d.ts +52 -0
  280. package/dist/esm/address-search/default-transports.d.ts.map +1 -0
  281. package/dist/esm/address-search/default-transports.js +129 -0
  282. package/dist/esm/address-search/default-transports.js.map +1 -0
  283. package/dist/esm/address-search/errors.d.ts +5 -0
  284. package/dist/esm/address-search/errors.d.ts.map +1 -0
  285. package/dist/esm/address-search/errors.js +8 -0
  286. package/dist/esm/address-search/errors.js.map +1 -0
  287. package/dist/esm/address-search/index.d.ts +8 -0
  288. package/dist/esm/address-search/index.d.ts.map +1 -0
  289. package/dist/esm/address-search/index.js +30 -0
  290. package/dist/esm/address-search/index.js.map +1 -0
  291. package/dist/esm/address-search/lru-cache.d.ts +13 -0
  292. package/dist/esm/address-search/lru-cache.d.ts.map +1 -0
  293. package/dist/esm/address-search/lru-cache.js +46 -0
  294. package/dist/esm/address-search/lru-cache.js.map +1 -0
  295. package/dist/esm/address-search/narrow.d.ts +21 -0
  296. package/dist/esm/address-search/narrow.d.ts.map +1 -0
  297. package/dist/esm/address-search/narrow.js +43 -0
  298. package/dist/esm/address-search/narrow.js.map +1 -0
  299. package/dist/esm/address-search/types.d.ts +125 -0
  300. package/dist/esm/address-search/types.d.ts.map +1 -0
  301. package/dist/esm/address-search/types.js +8 -0
  302. package/dist/esm/address-search/types.js.map +1 -0
  303. package/dist/esm/address-search.d.ts +3 -0
  304. package/dist/esm/address-search.d.ts.map +1 -0
  305. package/dist/esm/address-search.js +6 -0
  306. package/dist/esm/address-search.js.map +1 -0
  307. package/dist/esm/funcs/avmPredictPropertyValue.d.ts +1 -1
  308. package/dist/esm/funcs/avmPredictPropertyValue.d.ts.map +1 -1
  309. package/dist/esm/funcs/avmPredictPropertyValue.js +1 -1
  310. package/dist/esm/funcs/avmPredictPropertyValue.js.map +1 -1
  311. package/dist/esm/funcs/propertyGetProperties.js +1 -0
  312. package/dist/esm/funcs/propertyGetProperties.js.map +1 -1
  313. package/dist/esm/funcs/propertyGetPropertiesByLocation.js +1 -0
  314. package/dist/esm/funcs/propertyGetPropertiesByLocation.js.map +1 -1
  315. package/dist/esm/funcs/propertyGetPropertiesBySource.js +1 -0
  316. package/dist/esm/funcs/propertyGetPropertiesBySource.js.map +1 -1
  317. package/dist/esm/funcs/searchSearchRetrieve.d.ts +23 -0
  318. package/dist/esm/funcs/searchSearchRetrieve.d.ts.map +1 -0
  319. package/dist/esm/funcs/searchSearchRetrieve.js +92 -0
  320. package/dist/esm/funcs/searchSearchRetrieve.js.map +1 -0
  321. package/dist/esm/funcs/searchSearchSuggest.d.ts +3 -1
  322. package/dist/esm/funcs/searchSearchSuggest.d.ts.map +1 -1
  323. package/dist/esm/funcs/searchSearchSuggest.js +5 -1
  324. package/dist/esm/funcs/searchSearchSuggest.js.map +1 -1
  325. package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts +1 -1
  326. package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts.map +1 -1
  327. package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js +2 -1
  328. package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js.map +1 -1
  329. package/dist/esm/lib/config.d.ts +3 -3
  330. package/dist/esm/lib/config.js +3 -3
  331. package/dist/esm/lib/config.js.map +1 -1
  332. package/dist/esm/sdk/models/errors/index.d.ts +1 -0
  333. package/dist/esm/sdk/models/errors/index.d.ts.map +1 -1
  334. package/dist/esm/sdk/models/errors/index.js +1 -0
  335. package/dist/esm/sdk/models/errors/index.js.map +1 -1
  336. package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts +65 -0
  337. package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts.map +1 -1
  338. package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.js +52 -0
  339. package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.js.map +1 -1
  340. package/dist/esm/sdk/models/errors/predictpropertyvalue.d.ts +65 -0
  341. package/dist/esm/sdk/models/errors/predictpropertyvalue.d.ts.map +1 -1
  342. package/dist/esm/sdk/models/errors/predictpropertyvalue.js +54 -0
  343. package/dist/esm/sdk/models/errors/predictpropertyvalue.js.map +1 -1
  344. package/dist/esm/sdk/models/errors/searchretrieve.d.ts +201 -0
  345. package/dist/esm/sdk/models/errors/searchretrieve.d.ts.map +1 -0
  346. package/dist/esm/sdk/models/errors/searchretrieve.js +171 -0
  347. package/dist/esm/sdk/models/errors/searchretrieve.js.map +1 -0
  348. package/dist/esm/sdk/models/operations/getcensuswholelevel.d.ts +1 -0
  349. package/dist/esm/sdk/models/operations/getcensuswholelevel.d.ts.map +1 -1
  350. package/dist/esm/sdk/models/operations/getcensuswholelevel.js +1 -0
  351. package/dist/esm/sdk/models/operations/getcensuswholelevel.js.map +1 -1
  352. package/dist/esm/sdk/models/operations/getlistingbyid.d.ts +18 -15
  353. package/dist/esm/sdk/models/operations/getlistingbyid.d.ts.map +1 -1
  354. package/dist/esm/sdk/models/operations/getlistingbyid.js +16 -16
  355. package/dist/esm/sdk/models/operations/getlistingbyid.js.map +1 -1
  356. package/dist/esm/sdk/models/operations/getlistingbysource.d.ts +18 -15
  357. package/dist/esm/sdk/models/operations/getlistingbysource.d.ts.map +1 -1
  358. package/dist/esm/sdk/models/operations/getlistingbysource.js +16 -16
  359. package/dist/esm/sdk/models/operations/getlistingbysource.js.map +1 -1
  360. package/dist/esm/sdk/models/operations/getlistingsbylocation.d.ts +18 -15
  361. package/dist/esm/sdk/models/operations/getlistingsbylocation.d.ts.map +1 -1
  362. package/dist/esm/sdk/models/operations/getlistingsbylocation.js +17 -16
  363. package/dist/esm/sdk/models/operations/getlistingsbylocation.js.map +1 -1
  364. package/dist/esm/sdk/models/operations/getproperties.d.ts +5 -0
  365. package/dist/esm/sdk/models/operations/getproperties.d.ts.map +1 -1
  366. package/dist/esm/sdk/models/operations/getproperties.js +1 -0
  367. package/dist/esm/sdk/models/operations/getproperties.js.map +1 -1
  368. package/dist/esm/sdk/models/operations/getpropertiesbylocation.d.ts +5 -0
  369. package/dist/esm/sdk/models/operations/getpropertiesbylocation.d.ts.map +1 -1
  370. package/dist/esm/sdk/models/operations/getpropertiesbylocation.js +1 -0
  371. package/dist/esm/sdk/models/operations/getpropertiesbylocation.js.map +1 -1
  372. package/dist/esm/sdk/models/operations/getpropertiesbysource.d.ts +5 -0
  373. package/dist/esm/sdk/models/operations/getpropertiesbysource.d.ts.map +1 -1
  374. package/dist/esm/sdk/models/operations/getpropertiesbysource.js +1 -0
  375. package/dist/esm/sdk/models/operations/getpropertiesbysource.js.map +1 -1
  376. package/dist/esm/sdk/models/operations/index.d.ts +1 -0
  377. package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
  378. package/dist/esm/sdk/models/operations/index.js +1 -0
  379. package/dist/esm/sdk/models/operations/index.js.map +1 -1
  380. package/dist/esm/sdk/models/operations/querylistings.d.ts +18 -15
  381. package/dist/esm/sdk/models/operations/querylistings.d.ts.map +1 -1
  382. package/dist/esm/sdk/models/operations/querylistings.js +18 -17
  383. package/dist/esm/sdk/models/operations/querylistings.js.map +1 -1
  384. package/dist/esm/sdk/models/operations/querylistingsbysource.d.ts +18 -15
  385. package/dist/esm/sdk/models/operations/querylistingsbysource.d.ts.map +1 -1
  386. package/dist/esm/sdk/models/operations/querylistingsbysource.js +17 -16
  387. package/dist/esm/sdk/models/operations/querylistingsbysource.js.map +1 -1
  388. package/dist/esm/sdk/models/operations/resolveaddress.d.ts +16 -3
  389. package/dist/esm/sdk/models/operations/resolveaddress.d.ts.map +1 -1
  390. package/dist/esm/sdk/models/operations/resolveaddress.js +16 -2
  391. package/dist/esm/sdk/models/operations/resolveaddress.js.map +1 -1
  392. package/dist/esm/sdk/models/operations/searchretrieve.d.ts +20 -0
  393. package/dist/esm/sdk/models/operations/searchretrieve.d.ts.map +1 -0
  394. package/dist/esm/sdk/models/operations/searchretrieve.js +18 -0
  395. package/dist/esm/sdk/models/operations/searchretrieve.js.map +1 -0
  396. package/dist/esm/sdk/models/operations/searchsuggest.d.ts +35 -0
  397. package/dist/esm/sdk/models/operations/searchsuggest.d.ts.map +1 -1
  398. package/dist/esm/sdk/models/operations/searchsuggest.js +17 -0
  399. package/dist/esm/sdk/models/operations/searchsuggest.js.map +1 -1
  400. package/dist/esm/sdk/models/shared/addressresolverequest.d.ts +27 -0
  401. package/dist/esm/sdk/models/shared/addressresolverequest.d.ts.map +1 -1
  402. package/dist/esm/sdk/models/shared/addressresolverequest.js +23 -0
  403. package/dist/esm/sdk/models/shared/addressresolverequest.js.map +1 -1
  404. package/dist/esm/sdk/models/shared/advancedlisting.d.ts +2 -2
  405. package/dist/esm/sdk/models/shared/advancedlisting.d.ts.map +1 -1
  406. package/dist/esm/sdk/models/shared/advancedlisting.js +2 -2
  407. package/dist/esm/sdk/models/shared/advancedlisting.js.map +1 -1
  408. package/dist/esm/sdk/models/shared/aggregationresult.d.ts +2 -1
  409. package/dist/esm/sdk/models/shared/aggregationresult.d.ts.map +1 -1
  410. package/dist/esm/sdk/models/shared/aggregationresult.js +2 -0
  411. package/dist/esm/sdk/models/shared/aggregationresult.js.map +1 -1
  412. package/dist/esm/sdk/models/shared/censusareaprofilerequest.d.ts +20 -0
  413. package/dist/esm/sdk/models/shared/censusareaprofilerequest.d.ts.map +1 -1
  414. package/dist/esm/sdk/models/shared/censusareaprofilerequest.js +12 -0
  415. package/dist/esm/sdk/models/shared/censusareaprofilerequest.js.map +1 -1
  416. package/dist/esm/sdk/models/shared/censusrolluprequest.d.ts +20 -0
  417. package/dist/esm/sdk/models/shared/censusrolluprequest.d.ts.map +1 -1
  418. package/dist/esm/sdk/models/shared/censusrolluprequest.js +11 -0
  419. package/dist/esm/sdk/models/shared/censusrolluprequest.js.map +1 -1
  420. package/dist/esm/sdk/models/shared/geocodeprecision.d.ts +17 -0
  421. package/dist/esm/sdk/models/shared/geocodeprecision.d.ts.map +1 -0
  422. package/dist/esm/sdk/models/shared/geocodeprecision.js +15 -0
  423. package/dist/esm/sdk/models/shared/geocodeprecision.js.map +1 -0
  424. package/dist/esm/sdk/models/shared/histogrambucket.d.ts +7 -0
  425. package/dist/esm/sdk/models/shared/histogrambucket.d.ts.map +1 -1
  426. package/dist/esm/sdk/models/shared/histogrambucket.js +5 -3
  427. package/dist/esm/sdk/models/shared/histogrambucket.js.map +1 -1
  428. package/dist/esm/sdk/models/shared/index.d.ts +15 -7
  429. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  430. package/dist/esm/sdk/models/shared/index.js +15 -7
  431. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  432. package/dist/esm/sdk/models/shared/mortgagecharge.d.ts +38 -0
  433. package/dist/esm/sdk/models/shared/mortgagecharge.d.ts.map +1 -0
  434. package/dist/esm/sdk/models/shared/mortgagecharge.js +28 -0
  435. package/dist/esm/sdk/models/shared/mortgagecharge.js.map +1 -0
  436. package/dist/esm/sdk/models/shared/nestedaggregationresult.d.ts +16 -0
  437. package/dist/esm/sdk/models/shared/nestedaggregationresult.d.ts.map +1 -0
  438. package/dist/esm/sdk/models/shared/nestedaggregationresult.js +18 -0
  439. package/dist/esm/sdk/models/shared/nestedaggregationresult.js.map +1 -0
  440. package/dist/esm/sdk/models/shared/othercharge.d.ts +23 -0
  441. package/dist/esm/sdk/models/shared/othercharge.d.ts.map +1 -0
  442. package/dist/esm/sdk/models/shared/{extractionothercharge.js → othercharge.js} +4 -4
  443. package/dist/esm/sdk/models/shared/othercharge.js.map +1 -0
  444. package/dist/esm/sdk/models/shared/propertyaddress.d.ts +24 -2
  445. package/dist/esm/sdk/models/shared/propertyaddress.d.ts.map +1 -1
  446. package/dist/esm/sdk/models/shared/propertyaddress.js +13 -1
  447. package/dist/esm/sdk/models/shared/propertyaddress.js.map +1 -1
  448. package/dist/esm/sdk/models/shared/propertybyslugsrequest.d.ts +5 -0
  449. package/dist/esm/sdk/models/shared/propertybyslugsrequest.d.ts.map +1 -1
  450. package/dist/esm/sdk/models/shared/propertybyslugsrequest.js +1 -0
  451. package/dist/esm/sdk/models/shared/propertybyslugsrequest.js.map +1 -1
  452. package/dist/esm/sdk/models/shared/propertydataapi.d.ts +38 -0
  453. package/dist/esm/sdk/models/shared/propertydataapi.d.ts.map +1 -1
  454. package/dist/esm/sdk/models/shared/propertydataapi.js +21 -0
  455. package/dist/esm/sdk/models/shared/propertydataapi.js.map +1 -1
  456. package/dist/esm/sdk/models/shared/propertyqueryrequest.d.ts +5 -0
  457. package/dist/esm/sdk/models/shared/propertyqueryrequest.d.ts.map +1 -1
  458. package/dist/esm/sdk/models/shared/propertyqueryrequest.js +1 -0
  459. package/dist/esm/sdk/models/shared/propertyqueryrequest.js.map +1 -1
  460. package/dist/esm/sdk/models/shared/registeredcharges.d.ts +14 -0
  461. package/dist/esm/sdk/models/shared/registeredcharges.d.ts.map +1 -0
  462. package/dist/esm/sdk/models/shared/registeredcharges.js +17 -0
  463. package/dist/esm/sdk/models/shared/registeredcharges.js.map +1 -0
  464. package/dist/esm/sdk/models/shared/salerecord.d.ts +45 -0
  465. package/dist/esm/sdk/models/shared/salerecord.d.ts.map +1 -1
  466. package/dist/esm/sdk/models/shared/salerecord.js +25 -0
  467. package/dist/esm/sdk/models/shared/salerecord.js.map +1 -1
  468. package/dist/esm/sdk/models/shared/searchresponse.d.ts +8 -0
  469. package/dist/esm/sdk/models/shared/searchresponse.d.ts.map +1 -1
  470. package/dist/esm/sdk/models/shared/searchresponse.js +4 -0
  471. package/dist/esm/sdk/models/shared/searchresponse.js.map +1 -1
  472. package/dist/esm/sdk/models/shared/searchretrieveresponse.d.ts +82 -0
  473. package/dist/esm/sdk/models/shared/searchretrieveresponse.d.ts.map +1 -0
  474. package/dist/esm/sdk/models/shared/searchretrieveresponse.js +50 -0
  475. package/dist/esm/sdk/models/shared/searchretrieveresponse.js.map +1 -0
  476. package/dist/esm/sdk/models/shared/streetmatch.d.ts +106 -0
  477. package/dist/esm/sdk/models/shared/streetmatch.d.ts.map +1 -0
  478. package/dist/esm/sdk/models/shared/streetmatch.js +45 -0
  479. package/dist/esm/sdk/models/shared/streetmatch.js.map +1 -0
  480. package/dist/esm/sdk/models/shared/termsbucket.d.ts +3 -0
  481. package/dist/esm/sdk/models/shared/termsbucket.d.ts.map +1 -1
  482. package/dist/esm/sdk/models/shared/termsbucket.js +3 -3
  483. package/dist/esm/sdk/models/shared/termsbucket.js.map +1 -1
  484. package/dist/esm/sdk/models/shared/titlecovenant.d.ts +23 -0
  485. package/dist/esm/sdk/models/shared/titlecovenant.d.ts.map +1 -0
  486. package/dist/esm/sdk/models/shared/{extractionrestriction.js → titlecovenant.js} +4 -4
  487. package/dist/esm/sdk/models/shared/titlecovenant.js.map +1 -0
  488. package/dist/esm/sdk/models/shared/{extractiondocumentsummary.d.ts → titledocumentsummary.d.ts} +9 -9
  489. package/dist/esm/sdk/models/shared/titledocumentsummary.d.ts.map +1 -0
  490. package/dist/esm/sdk/models/shared/{extractiondocumentsummary.js → titledocumentsummary.js} +9 -9
  491. package/dist/esm/sdk/models/shared/titledocumentsummary.js.map +1 -0
  492. package/dist/esm/sdk/models/shared/titleextractionpayload.d.ts +83 -0
  493. package/dist/esm/sdk/models/shared/titleextractionpayload.d.ts.map +1 -0
  494. package/dist/esm/sdk/models/shared/titleextractionpayload.js +65 -0
  495. package/dist/esm/sdk/models/shared/titleextractionpayload.js.map +1 -0
  496. package/dist/esm/sdk/models/shared/titleextractionpollresponse.d.ts +2 -2
  497. package/dist/esm/sdk/models/shared/titleextractionpollresponse.d.ts.map +1 -1
  498. package/dist/esm/sdk/models/shared/titleextractionpollresponse.js +2 -2
  499. package/dist/esm/sdk/models/shared/titleextractionpollresponse.js.map +1 -1
  500. package/dist/{commonjs/sdk/models/shared/extractionnotice.d.ts → esm/sdk/models/shared/titlenotice.d.ts} +13 -4
  501. package/dist/esm/sdk/models/shared/titlenotice.d.ts.map +1 -0
  502. package/dist/esm/sdk/models/shared/{extractionnotice.js → titlenotice.js} +4 -4
  503. package/dist/esm/sdk/models/shared/titlenotice.js.map +1 -0
  504. package/dist/esm/sdk/models/shared/titleproprietor.d.ts +54 -0
  505. package/dist/esm/sdk/models/shared/titleproprietor.d.ts.map +1 -0
  506. package/dist/esm/sdk/models/shared/titleproprietor.js +38 -0
  507. package/dist/esm/sdk/models/shared/titleproprietor.js.map +1 -0
  508. package/dist/esm/sdk/models/shared/titlerestriction.d.ts +23 -0
  509. package/dist/esm/sdk/models/shared/titlerestriction.d.ts.map +1 -0
  510. package/dist/esm/sdk/models/shared/titlerestriction.js +17 -0
  511. package/dist/esm/sdk/models/shared/titlerestriction.js.map +1 -0
  512. package/dist/esm/sdk/models/shared/titleschedulenoticeoflease.d.ts +13 -0
  513. package/dist/esm/sdk/models/shared/titleschedulenoticeoflease.d.ts.map +1 -0
  514. package/dist/esm/sdk/models/shared/titleschedulenoticeoflease.js +13 -0
  515. package/dist/esm/sdk/models/shared/titleschedulenoticeoflease.js.map +1 -0
  516. package/dist/esm/sdk/models/shared/titlesummarycounts.d.ts +15 -0
  517. package/dist/esm/sdk/models/shared/titlesummarycounts.d.ts.map +1 -0
  518. package/dist/esm/sdk/models/shared/titlesummarycounts.js +18 -0
  519. package/dist/esm/sdk/models/shared/titlesummarycounts.js.map +1 -0
  520. package/dist/esm/sdk/search.d.ts +14 -1
  521. package/dist/esm/sdk/search.d.ts.map +1 -1
  522. package/dist/esm/sdk/search.js +17 -1
  523. package/dist/esm/sdk/search.js.map +1 -1
  524. package/package.json +3 -2
  525. package/src/address-search/__tests__/controller.test.ts +395 -0
  526. package/src/address-search/__tests__/default-transports.test.ts +201 -0
  527. package/src/address-search/__tests__/narrow.test.ts +74 -0
  528. package/src/address-search/controller.ts +219 -0
  529. package/src/address-search/default-transports.ts +199 -0
  530. package/src/address-search/errors.ts +7 -0
  531. package/src/address-search/index.ts +54 -0
  532. package/src/address-search/lru-cache.ts +34 -0
  533. package/src/address-search/narrow.ts +45 -0
  534. package/src/address-search/types.ts +147 -0
  535. package/src/address-search.ts +40 -0
  536. package/src/funcs/avmPredictPropertyValue.ts +9 -2
  537. package/src/funcs/propertyGetProperties.ts +1 -0
  538. package/src/funcs/propertyGetPropertiesByLocation.ts +1 -0
  539. package/src/funcs/propertyGetPropertiesBySource.ts +1 -0
  540. package/src/funcs/searchSearchRetrieve.ts +192 -0
  541. package/src/funcs/searchSearchSuggest.ts +5 -1
  542. package/src/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.ts +8 -0
  543. package/src/lib/config.ts +3 -3
  544. package/src/sdk/models/errors/index.ts +1 -0
  545. package/src/sdk/models/errors/postv1titledeedstitlenumberpurchase.ts +144 -0
  546. package/src/sdk/models/errors/predictpropertyvalue.ts +136 -0
  547. package/src/sdk/models/errors/searchretrieve.ts +391 -0
  548. package/src/sdk/models/operations/getcensuswholelevel.ts +1 -0
  549. package/src/sdk/models/operations/getlistingbyid.ts +84 -76
  550. package/src/sdk/models/operations/getlistingbysource.ts +95 -87
  551. package/src/sdk/models/operations/getlistingsbylocation.ts +95 -86
  552. package/src/sdk/models/operations/getproperties.ts +6 -0
  553. package/src/sdk/models/operations/getpropertiesbylocation.ts +6 -0
  554. package/src/sdk/models/operations/getpropertiesbysource.ts +6 -0
  555. package/src/sdk/models/operations/index.ts +1 -0
  556. package/src/sdk/models/operations/querylistings.ts +91 -82
  557. package/src/sdk/models/operations/querylistingsbysource.ts +95 -86
  558. package/src/sdk/models/operations/resolveaddress.ts +50 -12
  559. package/src/sdk/models/operations/searchretrieve.ts +45 -0
  560. package/src/sdk/models/operations/searchsuggest.ts +41 -0
  561. package/src/sdk/models/shared/addressresolverequest.ts +60 -0
  562. package/src/sdk/models/shared/advancedlisting.ts +4 -4
  563. package/src/sdk/models/shared/aggregationresult.ts +7 -1
  564. package/src/sdk/models/shared/censusareaprofilerequest.ts +24 -0
  565. package/src/sdk/models/shared/censusrolluprequest.ts +27 -0
  566. package/src/sdk/models/shared/geocodeprecision.ts +27 -0
  567. package/src/sdk/models/shared/histogrambucket.ts +19 -5
  568. package/src/sdk/models/shared/index.ts +15 -7
  569. package/src/sdk/models/shared/mortgagecharge.ts +76 -0
  570. package/src/sdk/models/shared/nestedaggregationresult.ts +47 -0
  571. package/src/sdk/models/shared/{extractionothercharge.ts → othercharge.ts} +16 -7
  572. package/src/sdk/models/shared/propertyaddress.ts +36 -3
  573. package/src/sdk/models/shared/propertybyslugsrequest.ts +6 -0
  574. package/src/sdk/models/shared/propertydataapi.ts +55 -0
  575. package/src/sdk/models/shared/propertyqueryrequest.ts +6 -0
  576. package/src/sdk/models/shared/registeredcharges.ts +40 -0
  577. package/src/sdk/models/shared/salerecord.ts +62 -0
  578. package/src/sdk/models/shared/searchresponse.ts +12 -0
  579. package/src/sdk/models/shared/searchretrieveresponse.ts +153 -0
  580. package/src/sdk/models/shared/streetmatch.ts +181 -0
  581. package/src/sdk/models/shared/termsbucket.ts +13 -5
  582. package/src/sdk/models/shared/{extractionrestriction.ts → titlecovenant.ts} +16 -7
  583. package/src/sdk/models/shared/{extractiondocumentsummary.ts → titledocumentsummary.ts} +20 -18
  584. package/src/sdk/models/shared/titleextractionpayload.ts +170 -0
  585. package/src/sdk/models/shared/titleextractionpollresponse.ts +5 -5
  586. package/src/sdk/models/shared/{extractionnotice.ts → titlenotice.ts} +16 -7
  587. package/src/sdk/models/shared/titleproprietor.ts +90 -0
  588. package/src/sdk/models/shared/titlerestriction.ts +48 -0
  589. package/src/sdk/models/shared/titleschedulenoticeoflease.ts +34 -0
  590. package/src/sdk/models/shared/titlesummarycounts.ts +41 -0
  591. package/src/sdk/search.ts +25 -1
  592. package/dist/commonjs/sdk/models/shared/extractiondocumentsummary.d.ts.map +0 -1
  593. package/dist/commonjs/sdk/models/shared/extractiondocumentsummary.js.map +0 -1
  594. package/dist/commonjs/sdk/models/shared/extractionmortgagecharge.d.ts +0 -26
  595. package/dist/commonjs/sdk/models/shared/extractionmortgagecharge.d.ts.map +0 -1
  596. package/dist/commonjs/sdk/models/shared/extractionmortgagecharge.js.map +0 -1
  597. package/dist/commonjs/sdk/models/shared/extractionnotice.d.ts.map +0 -1
  598. package/dist/commonjs/sdk/models/shared/extractionnotice.js.map +0 -1
  599. package/dist/commonjs/sdk/models/shared/extractionothercharge.d.ts +0 -14
  600. package/dist/commonjs/sdk/models/shared/extractionothercharge.d.ts.map +0 -1
  601. package/dist/commonjs/sdk/models/shared/extractionothercharge.js.map +0 -1
  602. package/dist/commonjs/sdk/models/shared/extractionpayload.d.ts +0 -63
  603. package/dist/commonjs/sdk/models/shared/extractionpayload.d.ts.map +0 -1
  604. package/dist/commonjs/sdk/models/shared/extractionpayload.js +0 -108
  605. package/dist/commonjs/sdk/models/shared/extractionpayload.js.map +0 -1
  606. package/dist/commonjs/sdk/models/shared/extractionproprietor.d.ts +0 -18
  607. package/dist/commonjs/sdk/models/shared/extractionproprietor.d.ts.map +0 -1
  608. package/dist/commonjs/sdk/models/shared/extractionproprietor.js.map +0 -1
  609. package/dist/commonjs/sdk/models/shared/extractionrestriction.d.ts +0 -14
  610. package/dist/commonjs/sdk/models/shared/extractionrestriction.d.ts.map +0 -1
  611. package/dist/commonjs/sdk/models/shared/extractionrestriction.js.map +0 -1
  612. package/dist/esm/sdk/models/shared/extractiondocumentsummary.d.ts.map +0 -1
  613. package/dist/esm/sdk/models/shared/extractiondocumentsummary.js.map +0 -1
  614. package/dist/esm/sdk/models/shared/extractionmortgagecharge.d.ts +0 -26
  615. package/dist/esm/sdk/models/shared/extractionmortgagecharge.d.ts.map +0 -1
  616. package/dist/esm/sdk/models/shared/extractionmortgagecharge.js +0 -28
  617. package/dist/esm/sdk/models/shared/extractionmortgagecharge.js.map +0 -1
  618. package/dist/esm/sdk/models/shared/extractionnotice.d.ts.map +0 -1
  619. package/dist/esm/sdk/models/shared/extractionnotice.js.map +0 -1
  620. package/dist/esm/sdk/models/shared/extractionothercharge.d.ts +0 -14
  621. package/dist/esm/sdk/models/shared/extractionothercharge.d.ts.map +0 -1
  622. package/dist/esm/sdk/models/shared/extractionothercharge.js.map +0 -1
  623. package/dist/esm/sdk/models/shared/extractionpayload.d.ts +0 -63
  624. package/dist/esm/sdk/models/shared/extractionpayload.d.ts.map +0 -1
  625. package/dist/esm/sdk/models/shared/extractionpayload.js +0 -68
  626. package/dist/esm/sdk/models/shared/extractionpayload.js.map +0 -1
  627. package/dist/esm/sdk/models/shared/extractionproprietor.d.ts +0 -18
  628. package/dist/esm/sdk/models/shared/extractionproprietor.d.ts.map +0 -1
  629. package/dist/esm/sdk/models/shared/extractionproprietor.js +0 -21
  630. package/dist/esm/sdk/models/shared/extractionproprietor.js.map +0 -1
  631. package/dist/esm/sdk/models/shared/extractionrestriction.d.ts +0 -14
  632. package/dist/esm/sdk/models/shared/extractionrestriction.d.ts.map +0 -1
  633. package/dist/esm/sdk/models/shared/extractionrestriction.js.map +0 -1
  634. package/src/sdk/models/shared/extractionmortgagecharge.ts +0 -66
  635. package/src/sdk/models/shared/extractionpayload.ts +0 -177
  636. package/src/sdk/models/shared/extractionproprietor.ts +0 -47
@@ -0,0 +1,395 @@
1
+ import { describe, expect, it } from "vitest";
2
+ import { createAddressSearch } from "../controller.js";
3
+ import type {
4
+ AddressSearchOptions,
5
+ AddressSearchTimers,
6
+ AddressSuggestion,
7
+ RetrieveRequest,
8
+ RetrieveResult,
9
+ SuggestRequest,
10
+ SuggestResult,
11
+ SuggestTransport,
12
+ TimerHandle,
13
+ } from "../types.js";
14
+
15
+ /** Deterministic clock + timer harness injected in place of real timers. */
16
+ function createTimerHarness(): { timers: AddressSearchTimers; advance(ms: number): void } {
17
+ let now = 0;
18
+ let nextId = 1;
19
+ const scheduled = new Map<number, { at: number; callback: () => void }>();
20
+ return {
21
+ timers: {
22
+ now: (): number => now,
23
+ setTimeout: (callback: () => void, ms: number): TimerHandle => {
24
+ const id = nextId++;
25
+ scheduled.set(id, { at: now + ms, callback });
26
+ return id;
27
+ },
28
+ clearTimeout: (handle: TimerHandle): void => {
29
+ scheduled.delete(handle as number);
30
+ },
31
+ },
32
+ advance(ms: number): void {
33
+ now += ms;
34
+ for (const [id, task] of [...scheduled]) {
35
+ if (task.at <= now) {
36
+ scheduled.delete(id);
37
+ task.callback();
38
+ }
39
+ }
40
+ },
41
+ };
42
+ }
43
+
44
+ /** Let promise continuations queued by the transports run. */
45
+ function flush(): Promise<void> {
46
+ return new Promise((resolve) => setTimeout(resolve, 0));
47
+ }
48
+
49
+ function suggestion(uprn: string, title: string): AddressSuggestion {
50
+ return { id: `addr-${uprn}`, title, uprn, source: "address", matchedSubstrings: [], raw: { uprn, title } };
51
+ }
52
+
53
+ /** Same rows the server's candidate-set narrowing tests use. */
54
+ const FIXTURE_ROWS: readonly AddressSuggestion[] = [
55
+ suggestion("100", "31 Christopher Court, Cherry Lane, Beverley, HU17 9TB"),
56
+ suggestion("101", "31 Christie Avenue, Beverley, HU17 9TB"),
57
+ suggestion("102", "112 Green Lane, York, YO42 2RW"),
58
+ ];
59
+
60
+ const COMPLETE_SET: SuggestResult = {
61
+ suggestions: FIXTURE_ROWS,
62
+ searchId: "set-1",
63
+ setComplete: true,
64
+ billing: null,
65
+ };
66
+
67
+ const TIERED_RESULT: SuggestResult = {
68
+ suggestions: [suggestion("900", "Beverley, East Riding of Yorkshire")],
69
+ searchId: null,
70
+ setComplete: false,
71
+ billing: null,
72
+ };
73
+
74
+ function createSuggestMock(handler: (request: SuggestRequest) => SuggestResult | Promise<SuggestResult>): {
75
+ calls: SuggestRequest[];
76
+ transport: SuggestTransport;
77
+ } {
78
+ const calls: SuggestRequest[] = [];
79
+ const transport: SuggestTransport = async (request): Promise<SuggestResult> => {
80
+ calls.push(request);
81
+ return handler(request);
82
+ };
83
+ return { calls, transport };
84
+ }
85
+
86
+ function createRetrieveMock<TRecord>(handler: (request: RetrieveRequest) => RetrieveResult<TRecord>): {
87
+ calls: RetrieveRequest[];
88
+ transport: (request: RetrieveRequest) => Promise<RetrieveResult<TRecord>>;
89
+ } {
90
+ const calls: RetrieveRequest[] = [];
91
+ return {
92
+ calls,
93
+ transport: async (request): Promise<RetrieveResult<TRecord>> => {
94
+ calls.push(request);
95
+ return handler(request);
96
+ },
97
+ };
98
+ }
99
+
100
+ interface Setup {
101
+ controller: ReturnType<typeof createAddressSearch<{ uprn: string }>>;
102
+ suggestCalls: SuggestRequest[];
103
+ retrieveCalls: RetrieveRequest[];
104
+ advance(ms: number): void;
105
+ }
106
+
107
+ function setup(
108
+ suggestHandler: (request: SuggestRequest) => SuggestResult | Promise<SuggestResult>,
109
+ overrides: Partial<AddressSearchOptions<{ uprn: string }>> = {},
110
+ ): Setup {
111
+ const harness = createTimerHarness();
112
+ const suggest = createSuggestMock(suggestHandler);
113
+ const retrieve = createRetrieveMock<{ uprn: string }>(({ suggestion: picked }) => ({
114
+ record: { uprn: picked.uprn ?? "" },
115
+ }));
116
+ const controller = createAddressSearch<{ uprn: string }>({
117
+ suggest: suggest.transport,
118
+ retrieve: retrieve.transport,
119
+ timers: harness.timers,
120
+ ...overrides,
121
+ });
122
+ return { controller, suggestCalls: suggest.calls, retrieveCalls: retrieve.calls, advance: harness.advance };
123
+ }
124
+
125
+ describe("debounce and minimum length", () => {
126
+ it("coalesces a fast typing burst into one fetch for the final query", async () => {
127
+ const { controller, suggestCalls, advance } = setup(() => COMPLETE_SET);
128
+ for (const text of ["31 c", "31 ch", "31 chr", "31 chri"]) {
129
+ controller.input(text);
130
+ advance(100); // faster than the 250ms debounce
131
+ }
132
+ advance(250);
133
+ await flush();
134
+ expect(suggestCalls).toHaveLength(1);
135
+ expect(suggestCalls[0]?.query).toBe("31 chri");
136
+ expect(controller.getState().status).toBe("ready");
137
+ });
138
+
139
+ it("never fetches below three characters and clears suggestions", async () => {
140
+ const { controller, suggestCalls, advance } = setup(() => COMPLETE_SET);
141
+ controller.input("31 chri");
142
+ advance(300);
143
+ await flush();
144
+ expect(controller.getState().suggestions.length).toBeGreaterThan(0);
145
+
146
+ controller.input("31");
147
+ advance(1000);
148
+ await flush();
149
+ expect(suggestCalls).toHaveLength(1); // no second fetch
150
+ expect(controller.getState().status).toBe("idle");
151
+ expect(controller.getState().suggestions).toEqual([]);
152
+ });
153
+ });
154
+
155
+ describe("candidate-set protocol", () => {
156
+ it("holds a complete set and narrows extending keystrokes locally — zero further fetches", async () => {
157
+ const { controller, suggestCalls, advance } = setup(() => COMPLETE_SET);
158
+ controller.input("31 chri");
159
+ advance(300);
160
+ await flush();
161
+ expect(suggestCalls).toHaveLength(1);
162
+
163
+ controller.input("31 chris");
164
+ expect(controller.getState().status).toBe("ready");
165
+ expect(controller.getState().suggestions.map((s) => s.uprn)).toEqual(["100", "101"]);
166
+
167
+ controller.input("31 christo");
168
+ expect(controller.getState().suggestions.map((s) => s.uprn)).toEqual(["100"]);
169
+ expect(controller.getState().searchId).toBe("set-1");
170
+ expect(controller.getState().setComplete).toBe(true);
171
+
172
+ advance(1000);
173
+ await flush();
174
+ expect(suggestCalls).toHaveLength(1); // both narrows were local
175
+ });
176
+
177
+ it("re-queries WITHOUT a search_id when the local narrow empties (set exhaustion)", async () => {
178
+ const { controller, suggestCalls, advance } = setup(() => COMPLETE_SET);
179
+ controller.input("31 chri");
180
+ advance(300);
181
+ await flush();
182
+
183
+ controller.input("31 christopher zzz"); // extends the trigger but matches nothing held
184
+ expect(controller.getState().status).toBe("debouncing");
185
+ advance(250);
186
+ await flush();
187
+ expect(suggestCalls).toHaveLength(2);
188
+ expect(suggestCalls[1]?.query).toBe("31 christopher zzz");
189
+ expect(suggestCalls[1]?.searchId).toBeNull();
190
+ });
191
+
192
+ it("re-queries when the input no longer extends the trigger prefix (backspace past it)", async () => {
193
+ const { controller, suggestCalls, advance } = setup(() => COMPLETE_SET);
194
+ controller.input("31 chri");
195
+ advance(300);
196
+ await flush();
197
+
198
+ controller.input("31 ch"); // backspace past the trigger
199
+ advance(250);
200
+ await flush();
201
+ expect(suggestCalls).toHaveLength(2);
202
+ expect(suggestCalls[1]?.query).toBe("31 ch");
203
+ expect(suggestCalls[1]?.searchId).toBeNull();
204
+ });
205
+
206
+ it("issues at most 2 data fetches across a 10-keystroke chain", async () => {
207
+ const { controller, suggestCalls, advance } = setup(({ query }) =>
208
+ query.startsWith("31 chri") ? COMPLETE_SET : TIERED_RESULT,
209
+ );
210
+ const chain = [
211
+ "31 c",
212
+ "31 ch",
213
+ "31 chr",
214
+ "31 chri", // pause here → fetch 1 returns the complete set
215
+ "31 chris",
216
+ "31 christ",
217
+ "31 christo",
218
+ "31 christop",
219
+ "31 christoph",
220
+ "31 christophz", // typo exhausts the set → fetch 2
221
+ ];
222
+ for (const text of chain) {
223
+ controller.input(text);
224
+ advance(text === "31 chri" || text === "31 christophz" ? 300 : 100);
225
+ await flush();
226
+ }
227
+ expect(suggestCalls.length).toBeLessThanOrEqual(2);
228
+ expect(suggestCalls.map((c) => c.query)).toEqual(["31 chri", "31 christophz"]);
229
+ });
230
+
231
+ it("serves a repeated query from the cache without a fetch and re-adopts its set", async () => {
232
+ const { controller, suggestCalls, advance } = setup(({ query }) =>
233
+ query.startsWith("31 chri") ? COMPLETE_SET : TIERED_RESULT,
234
+ );
235
+ controller.input("31 chri");
236
+ advance(300);
237
+ await flush();
238
+ controller.input("beverley town"); // unrelated query displaces the held set context
239
+ advance(300);
240
+ await flush();
241
+ expect(suggestCalls).toHaveLength(2);
242
+
243
+ controller.input("31 chri"); // cache hit — instant, no fetch
244
+ expect(controller.getState().status).toBe("ready");
245
+ expect(controller.getState().searchId).toBe("set-1");
246
+ controller.input("31 christo"); // and the re-adopted set narrows locally
247
+ expect(controller.getState().suggestions.map((s) => s.uprn)).toEqual(["100"]);
248
+ advance(1000);
249
+ await flush();
250
+ expect(suggestCalls).toHaveLength(2);
251
+ });
252
+ });
253
+
254
+ describe("cancellation and stale responses", () => {
255
+ it("aborts the in-flight request when a new fetch supersedes it", async () => {
256
+ let release: ((result: SuggestResult) => void) | undefined;
257
+ const { controller, suggestCalls, advance } = setup(({ query }) =>
258
+ query === "31 chri"
259
+ ? new Promise<SuggestResult>((resolve) => {
260
+ release = resolve;
261
+ })
262
+ : TIERED_RESULT,
263
+ );
264
+ controller.input("31 chri");
265
+ advance(250); // fetch 1 in flight, unresolved
266
+ controller.input("112 green");
267
+ advance(250); // fetch 2 supersedes
268
+ await flush();
269
+
270
+ expect(suggestCalls).toHaveLength(2);
271
+ expect(suggestCalls[0]?.signal.aborted).toBe(true);
272
+ expect(controller.getState().query).toBe("112 green");
273
+ expect(controller.getState().status).toBe("ready");
274
+
275
+ release?.(COMPLETE_SET); // the stale response finally lands…
276
+ await flush();
277
+ expect(controller.getState().suggestions).toEqual(TIERED_RESULT.suggestions); // …and is ignored
278
+ });
279
+ });
280
+
281
+ describe("select", () => {
282
+ it("fires the retrieve exactly once per selection, with the session id attached", async () => {
283
+ const { controller, retrieveCalls, advance } = setup(() => COMPLETE_SET);
284
+ controller.input("31 chri");
285
+ advance(300);
286
+ await flush();
287
+
288
+ const picked = controller.getState().suggestions[0];
289
+ expect(picked).toBeDefined();
290
+ if (picked === undefined) return;
291
+
292
+ const [first, second] = await Promise.all([controller.select(picked), controller.select(picked)]);
293
+ expect(retrieveCalls).toHaveLength(1);
294
+ expect(retrieveCalls[0]?.searchId).toBe("set-1");
295
+ expect(retrieveCalls[0]?.suggestion.uprn).toBe("100");
296
+ expect(first).toEqual(second);
297
+
298
+ await controller.select(picked); // later re-selects also reuse the settled retrieve
299
+ expect(retrieveCalls).toHaveLength(1);
300
+ });
301
+
302
+ it("clears the idempotency guard when a retrieve fails, so it can be retried", async () => {
303
+ const harness = createTimerHarness();
304
+ const suggest = createSuggestMock(() => COMPLETE_SET);
305
+ let attempts = 0;
306
+ const controller = createAddressSearch<{ uprn: string }>({
307
+ suggest: suggest.transport,
308
+ retrieve: async ({ suggestion: picked }): Promise<RetrieveResult<{ uprn: string }>> => {
309
+ attempts += 1;
310
+ if (attempts === 1) throw new Error("transient");
311
+ return { record: { uprn: picked.uprn ?? "" } };
312
+ },
313
+ timers: harness.timers,
314
+ });
315
+ controller.input("31 chri");
316
+ harness.advance(300);
317
+ await flush();
318
+
319
+ const picked = controller.getState().suggestions[0];
320
+ expect(picked).toBeDefined();
321
+ if (picked === undefined) return;
322
+
323
+ await expect(controller.select(picked)).rejects.toThrow("transient");
324
+ await expect(controller.select(picked)).resolves.toEqual({ record: { uprn: "100" } }.record);
325
+ expect(attempts).toBe(2);
326
+ });
327
+ });
328
+
329
+ describe("billing metadata", () => {
330
+ it("surfaces suggest billing headers on the state and the billing property", async () => {
331
+ const billing = { creditsCharged: 0, creditsBalance: 4200, alreadyCharged: false };
332
+ const { controller, advance } = setup(() => ({ ...COMPLETE_SET, billing }));
333
+ controller.input("31 chri");
334
+ advance(300);
335
+ await flush();
336
+ expect(controller.getState().billing).toEqual({ ...billing, receivedAt: 300 });
337
+ expect(controller.billing).toEqual({ ...billing, receivedAt: 300 });
338
+ });
339
+
340
+ it("updates billing from the retrieve response after a selection", async () => {
341
+ const harness = createTimerHarness();
342
+ const suggest = createSuggestMock(() => COMPLETE_SET);
343
+ const controller = createAddressSearch<{ uprn: string }>({
344
+ suggest: suggest.transport,
345
+ retrieve: async ({ suggestion: picked }): Promise<RetrieveResult<{ uprn: string }>> => ({
346
+ record: { uprn: picked.uprn ?? "" },
347
+ billing: { creditsCharged: 4, creditsBalance: 4196, alreadyCharged: false },
348
+ }),
349
+ timers: harness.timers,
350
+ });
351
+ controller.input("31 chri");
352
+ harness.advance(300);
353
+ await flush();
354
+
355
+ const picked = controller.getState().suggestions[0];
356
+ expect(picked).toBeDefined();
357
+ if (picked === undefined) return;
358
+ await controller.select(picked);
359
+ expect(controller.billing).toEqual({
360
+ creditsCharged: 4,
361
+ creditsBalance: 4196,
362
+ alreadyCharged: false,
363
+ receivedAt: 300,
364
+ });
365
+ });
366
+ });
367
+
368
+ describe("subscription surface", () => {
369
+ it("notifies subscribers on every state change and stops after unsubscribe", async () => {
370
+ const { controller, advance } = setup(() => COMPLETE_SET);
371
+ const statuses: string[] = [];
372
+ const unsubscribe = controller.subscribe((state) => statuses.push(state.status));
373
+
374
+ controller.input("31 chri");
375
+ advance(300);
376
+ await flush();
377
+ expect(statuses).toEqual(["debouncing", "loading", "ready"]);
378
+
379
+ unsubscribe();
380
+ controller.input("31 christo");
381
+ expect(statuses).toHaveLength(3);
382
+ });
383
+
384
+ it("dispose cancels pending work and ignores further input", async () => {
385
+ const { controller, suggestCalls, advance } = setup(() => COMPLETE_SET);
386
+ controller.input("31 chri");
387
+ controller.dispose();
388
+ advance(1000);
389
+ await flush();
390
+ controller.input("31 christo");
391
+ advance(1000);
392
+ await flush();
393
+ expect(suggestCalls).toHaveLength(0);
394
+ });
395
+ });
@@ -0,0 +1,201 @@
1
+ import { describe, expect, it } from "vitest";
2
+ import type { SDKCore } from "../../core.js";
3
+ import type { UprnLookupResponse } from "../../sdk/models/shared/uprnlookupresponse.js";
4
+ import type { Result } from "../../sdk/types/fp.js";
5
+ import {
6
+ createSuggestTransport,
7
+ createUprnRetrieveTransport,
8
+ type FetchLike,
9
+ parseBillingHeaders,
10
+ type SuggestHttpResponse,
11
+ } from "../default-transports.js";
12
+ import { AddressSearchError } from "../errors.js";
13
+
14
+ interface CapturedRequest {
15
+ url: string;
16
+ headers: Record<string, string>;
17
+ signal: AbortSignal;
18
+ }
19
+
20
+ function fakeFetch(
21
+ body: unknown,
22
+ options: { status?: number; headers?: Record<string, string> } = {},
23
+ ): { fetch: FetchLike; captured: CapturedRequest[] } {
24
+ const captured: CapturedRequest[] = [];
25
+ const status = options.status ?? 200;
26
+ const headerMap = new Map(Object.entries(options.headers ?? {}).map(([k, v]) => [k.toLowerCase(), v]));
27
+ const response: SuggestHttpResponse = {
28
+ ok: status >= 200 && status < 300,
29
+ status,
30
+ headers: { get: (name: string): string | null => headerMap.get(name.toLowerCase()) ?? null },
31
+ json: async (): Promise<unknown> => body,
32
+ };
33
+ return {
34
+ captured,
35
+ fetch: async (url, init): Promise<SuggestHttpResponse> => {
36
+ captured.push({ url, headers: init.headers, signal: init.signal });
37
+ return response;
38
+ },
39
+ };
40
+ }
41
+
42
+ const SERVER_ROW = {
43
+ id: "addr-100023336956",
44
+ title: "10 Downing Street, London, SW1A 2AA",
45
+ main_text: "10 Downing Street, London, SW1A 2AA",
46
+ type: "address",
47
+ source: "address",
48
+ score: 5,
49
+ relevanceScore: 1,
50
+ uprn: "100023336956",
51
+ matched_substrings: [{ offset: 0, length: 10 }],
52
+ main_text_matched_substrings: [{ offset: 0, length: 10 }],
53
+ };
54
+
55
+ describe("createSuggestTransport", () => {
56
+ it("requests /v1/search/suggest with the query, page cap, version header and api key", async () => {
57
+ const { fetch, captured } = fakeFetch({ object: "list", data: [], search_id: null, set_complete: false });
58
+ const transport = createSuggestTransport({ baseUrl: "https://api.example.com/", apiKey: "sk-test", fetch });
59
+ await transport({ query: "10 downing", searchId: null, signal: new AbortController().signal });
60
+
61
+ expect(captured).toHaveLength(1);
62
+ const request = captured[0];
63
+ expect(request?.url).toBe("https://api.example.com/v1/search/suggest?q=10+downing&limit=100");
64
+ expect(request?.headers["X-API-Version"]).toBe("2");
65
+ expect(request?.headers["x-api-key"]).toBe("sk-test");
66
+ });
67
+
68
+ it("passes search_id through when the caller narrows server-side", async () => {
69
+ const { fetch, captured } = fakeFetch({ data: [], search_id: "s-1", set_complete: true });
70
+ const transport = createSuggestTransport({ fetch });
71
+ await transport({ query: "10 downing st", searchId: "s-1", signal: new AbortController().signal });
72
+ expect(captured[0]?.url).toContain("search_id=s-1");
73
+ });
74
+
75
+ it("lifts rows, search_id, set_complete and billing headers out of the response", async () => {
76
+ const { fetch } = fakeFetch(
77
+ { object: "list", data: [SERVER_ROW], search_id: "s-9", set_complete: true },
78
+ { headers: { "X-Credits-Charged": "0", "X-Credits-Balance": "4200", "X-Already-Charged": "false" } },
79
+ );
80
+ const transport = createSuggestTransport({ fetch });
81
+ const result = await transport({ query: "10 downing", searchId: null, signal: new AbortController().signal });
82
+
83
+ expect(result.searchId).toBe("s-9");
84
+ expect(result.setComplete).toBe(true);
85
+ expect(result.suggestions).toHaveLength(1);
86
+ expect(result.suggestions[0]).toMatchObject({
87
+ id: "addr-100023336956",
88
+ title: "10 Downing Street, London, SW1A 2AA",
89
+ uprn: "100023336956",
90
+ source: "address",
91
+ matchedSubstrings: [{ offset: 0, length: 10 }],
92
+ });
93
+ expect(result.suggestions[0]?.raw).toBe(SERVER_ROW);
94
+ expect(result.billing).toEqual({ creditsCharged: 0, creditsBalance: 4200, alreadyCharged: false });
95
+ });
96
+
97
+ it("parses the legacy envelope's result array and rows without a UPRN", async () => {
98
+ const { fetch } = fakeFetch({
99
+ success: true,
100
+ result: [{ id: "street-1", title: "Cherry Lane", source: "address" }],
101
+ });
102
+ const transport = createSuggestTransport({ fetch });
103
+ const result = await transport({ query: "cherry", searchId: null, signal: new AbortController().signal });
104
+ expect(result.suggestions).toEqual([
105
+ {
106
+ id: "street-1",
107
+ title: "Cherry Lane",
108
+ uprn: null,
109
+ source: "address",
110
+ matchedSubstrings: [],
111
+ raw: expect.anything(),
112
+ },
113
+ ]);
114
+ expect(result.searchId).toBeNull();
115
+ expect(result.setComplete).toBe(false);
116
+ });
117
+
118
+ it("throws an AddressSearchError on a non-2xx response", async () => {
119
+ const { fetch } = fakeFetch({ error: "nope" }, { status: 429 });
120
+ const transport = createSuggestTransport({ fetch });
121
+ await expect(
122
+ transport({ query: "10 downing", searchId: null, signal: new AbortController().signal }),
123
+ ).rejects.toThrow(AddressSearchError);
124
+ });
125
+ });
126
+
127
+ describe("parseBillingHeaders", () => {
128
+ const headersOf = (entries: Record<string, string>): { get(name: string): string | null } => {
129
+ const map = new Map(Object.entries(entries).map(([k, v]) => [k.toLowerCase(), v]));
130
+ return { get: (name): string | null => map.get(name.toLowerCase()) ?? null };
131
+ };
132
+
133
+ it("returns null when no billing header is present", () => {
134
+ expect(parseBillingHeaders(headersOf({}))).toBeNull();
135
+ });
136
+
137
+ it("parses partial header sets, leaving absent values null", () => {
138
+ expect(parseBillingHeaders(headersOf({ "X-Credits-Charged": "3" }))).toEqual({
139
+ creditsCharged: 3,
140
+ creditsBalance: null,
141
+ alreadyCharged: null,
142
+ });
143
+ });
144
+
145
+ it("accepts both boolean spellings of X-Already-Charged", () => {
146
+ expect(parseBillingHeaders(headersOf({ "X-Already-Charged": "true" }))?.alreadyCharged).toBe(true);
147
+ expect(parseBillingHeaders(headersOf({ "X-Already-Charged": "1" }))?.alreadyCharged).toBe(true);
148
+ expect(parseBillingHeaders(headersOf({ "X-Already-Charged": "false" }))?.alreadyCharged).toBe(false);
149
+ });
150
+
151
+ it("parses non-numeric header values to null rather than NaN", () => {
152
+ expect(parseBillingHeaders(headersOf({ "X-Credits-Balance": "unlimited" }))?.creditsBalance).toBeNull();
153
+ });
154
+ });
155
+
156
+ describe("createUprnRetrieveTransport", () => {
157
+ const fakeClient = {} as unknown as SDKCore;
158
+ const record = { uprn: "100023336956" } as unknown as UprnLookupResponse;
159
+ const pickedSuggestion = {
160
+ id: "addr-100023336956",
161
+ title: "10 Downing Street, London, SW1A 2AA",
162
+ uprn: "100023336956",
163
+ source: "address",
164
+ matchedSubstrings: [],
165
+ raw: null,
166
+ };
167
+
168
+ it("resolves the suggestion's UPRN through the injected lookup", async () => {
169
+ const requests: string[] = [];
170
+ const transport = createUprnRetrieveTransport(fakeClient, {
171
+ lookup: async (_client, request): Promise<Result<UprnLookupResponse, unknown>> => {
172
+ requests.push(request.uprn);
173
+ return { ok: true, value: record };
174
+ },
175
+ });
176
+ const result = await transport({ suggestion: pickedSuggestion, searchId: "s-1" });
177
+ expect(requests).toEqual(["100023336956"]);
178
+ expect(result.record).toBe(record);
179
+ });
180
+
181
+ it("throws the lookup's error when the lookup fails", async () => {
182
+ const transport = createUprnRetrieveTransport(fakeClient, {
183
+ lookup: async (): Promise<Result<UprnLookupResponse, unknown>> => ({ ok: false, error: new Error("boom") }),
184
+ });
185
+ await expect(transport({ suggestion: pickedSuggestion, searchId: null })).rejects.toThrow("boom");
186
+ });
187
+
188
+ it("rejects suggestions without a UPRN before any request is made", async () => {
189
+ let called = false;
190
+ const transport = createUprnRetrieveTransport(fakeClient, {
191
+ lookup: async (): Promise<Result<UprnLookupResponse, unknown>> => {
192
+ called = true;
193
+ return { ok: true, value: record };
194
+ },
195
+ });
196
+ await expect(transport({ suggestion: { ...pickedSuggestion, uprn: null }, searchId: null })).rejects.toThrow(
197
+ AddressSearchError,
198
+ );
199
+ expect(called).toBe(false);
200
+ });
201
+ });
@@ -0,0 +1,74 @@
1
+ import { describe, expect, it } from "vitest";
2
+ import { extendsTriggerPrefix, narrowSuggestions, normaliseQuery } from "../narrow.js";
3
+
4
+ /**
5
+ * Client-side narrowing must agree with the server's candidate-set narrowing
6
+ * (apps/api search suggest, `narrowCandidates`) on the same fixtures — a
7
+ * divergence would make client and server disagree about which rows survive
8
+ * a keystroke. Fixture rows and expectations are copied verbatim from the
9
+ * server's candidate-set unit tests.
10
+ */
11
+
12
+ const ROWS = [
13
+ { uprn: "100", title: "31 Christopher Court, Cherry Lane, Beverley, HU17 9TB" },
14
+ { uprn: "101", title: "31 Christie Avenue, Beverley, HU17 9TB" },
15
+ { uprn: "102", title: "112 Green Lane, York, YO42 2RW" },
16
+ ] as const;
17
+
18
+ describe("narrowSuggestions — mirrors the server's narrowing semantics", () => {
19
+ it("keeps rows where every query token prefix-matches a title token, case-insensitively", () => {
20
+ const narrowed = narrowSuggestions(ROWS, "31 chri");
21
+ expect(narrowed.map((r) => r.uprn)).toEqual(["100", "101"]);
22
+ });
23
+
24
+ it("narrows further as the prefix grows (monotone: longer prefix, never more rows)", () => {
25
+ const narrowed = narrowSuggestions(ROWS, "31 christo");
26
+ expect(narrowed.map((r) => r.uprn)).toEqual(["100"]);
27
+ });
28
+
29
+ it("requires EVERY query token to match — one stray token empties the result", () => {
30
+ expect(narrowSuggestions(ROWS, "31 christopher zzz")).toEqual([]);
31
+ });
32
+
33
+ it("treats punctuation as separators on both sides (commas in titles never block a match)", () => {
34
+ expect(narrowSuggestions(ROWS, "cherry lane beverley").map((r) => r.uprn)).toEqual(["100"]);
35
+ });
36
+
37
+ it("matches mid-title tokens (a postcode prefix narrows to that postcode's rows)", () => {
38
+ expect(narrowSuggestions(ROWS, "hu17").map((r) => r.uprn)).toEqual(["100", "101"]);
39
+ });
40
+
41
+ it("returns the whole set for an empty or separator-only query", () => {
42
+ expect(narrowSuggestions(ROWS, "")).toHaveLength(3);
43
+ expect(narrowSuggestions(ROWS, " , ")).toHaveLength(3);
44
+ });
45
+
46
+ it("preserves the served order", () => {
47
+ const narrowed = narrowSuggestions(ROWS, "beverley");
48
+ expect(narrowed.map((r) => r.uprn)).toEqual(["100", "101"]);
49
+ });
50
+ });
51
+
52
+ describe("extendsTriggerPrefix — when local narrowing stays sound", () => {
53
+ it("accepts a query that extends the trigger prefix", () => {
54
+ expect(extendsTriggerPrefix("31 chris", "31 chri")).toBe(true);
55
+ });
56
+
57
+ it("accepts case and whitespace variants of the trigger itself", () => {
58
+ expect(extendsTriggerPrefix("31 CHRI", "31 chri")).toBe(true);
59
+ });
60
+
61
+ it("rejects a backspace past the trigger prefix", () => {
62
+ expect(extendsTriggerPrefix("31 ch", "31 chri")).toBe(false);
63
+ });
64
+
65
+ it("rejects an edit inside the trigger prefix", () => {
66
+ expect(extendsTriggerPrefix("32 chri", "31 chri")).toBe(false);
67
+ });
68
+ });
69
+
70
+ describe("normaliseQuery — the cache and prefix key form", () => {
71
+ it("lower-cases, collapses whitespace runs and trims", () => {
72
+ expect(normaliseQuery(" 31 Christopher Court ")).toBe("31 christopher court");
73
+ });
74
+ });