@remit/data-ports 0.0.27 → 0.0.28

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/data-ports",
-  "version": "0.0.27",
+  "version": "0.0.28",
   "type": "module",
   "main": "src/index.ts",
   "types": "src/index.ts",

package/src/interfaces/address.ts

@@ -61,14 +61,23 @@ export interface IAddressRepository {
 		accountConfigId: string;
 		limit?: number;
 	}): Promise<AddressItem[]>;
+	/**
+	 * The account's addresses, most worth suggesting first: where the search term
+	 * hit — the start of a value before the middle of one, and the display name
+	 * before the local part, the domain and the whole address — then the account's
+	 * standing for the sender, how much it corresponds with it, how recently, and
+	 * the stored compound and id last so the order is total. Without a term every
+	 * row scores the same match, so the remaining keys decide and the listing comes
+	 * back by standing, correspondence and recency rather than alphabetically.
+	 */
 	listByAccountConfig(input: {
 		accountConfigId: string;
 		/**
-		 * Prefix term matched against both the display-name compound
-		 * (`"<display name> <email>"`) and the normalized email. Matching the
-		 * email separately is what makes an exact-address lookup resolve: the
-		 * compound leads with the display name, so an email prefix never
-		 * matches it.
+		 * Matched as a substring of the display name, the local part, the domain
+		 * and the whole address, so `po`, `locatie`, `amsterdam`, `pocahondas.nl`
+		 * and `amsterdam@pocahondas.nl` all resolve
+		 * `Pocahondas locatie amsterdam <amsterdam@pocahondas.nl>`. A name outside
+		 * ASCII (`Öz` for `Özcan Bakker`) resolves through the folded compound.
 		 */
 		search?: string;
 		cursor?: string;