@simplybusiness/mobius 6.3.3 → 6.4.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 6.4.0
+
+### Minor Changes
+
+- 8f5b73a: pass in filters record to LoqateAddressLookupService to support US state filtering
+
 ## 6.3.3
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -1888,14 +1888,21 @@ var LoqateAddressLookupService = class {
    * 2 or 3 character ISO country codes
    */
   #countries;
+  /**
+   * Optional filters for the Loqate API
+   * E.g., { AdministrativeArea: "CA", PostalCode: "90210" }
+   */
+  #filters;
   constructor({
     baseUrl,
     apiKey,
-    countries
+    countries,
+    filters
   }) {
     this.#apiKey = apiKey;
     this.#baseUrl = baseUrl || LOQATE_BASE_URL;
     this.#countries = countries || DEFAULT_COUNTRIES;
+    this.#filters = filters;
   }
   fetchFromApi(url) {
     return fetch(`${this.#baseUrl}${url}`).then((response) => response.json()).then((json) => {
@@ -1905,12 +1912,28 @@ var LoqateAddressLookupService = class {
       return json;
     });
   }
+  /**
+   * Builds the Filters query parameter for Loqate API requests.
+   * - Filter keys (e.g., "AdministrativeArea", "PostalCode") are predefined by Loqate API (no need to encode)
+   * - Filter values (e.g., "New York", "90210") contain user input that may have special characters (need encoding)
+   *
+   * @returns Empty string if no filters, otherwise "&Filters=key1:value1&key2:value2" (Loqate's expected format for Filters)
+   */
+  buildFiltersQuery() {
+    if (!this.#filters || Object.keys(this.#filters).length === 0) {
+      return "";
+    }
+    const encodedFilters = Object.entries(this.#filters).map(([key, value]) => `${key}:${encodeURIComponent(value)}`).join("&");
+    return `&Filters=${encodedFilters}`;
+  }
   search(searchTerm) {
-    const url = `${LOQATE_FIND_URL}?Key=${this.#apiKey}&Text=${searchTerm}&Countries=${this.#countries?.join(",")}`;
+    let url = `${LOQATE_FIND_URL}?Key=${this.#apiKey}&Text=${searchTerm}&Countries=${this.#countries?.join(",")}`;
+    url += this.buildFiltersQuery();
     return this.fetchFromApi(url);
   }
   findById(id) {
-    const url = `${LOQATE_FIND_URL}?Key=${this.#apiKey}&Container=${id}&Countries=${this.#countries?.join(",")}`;
+    let url = `${LOQATE_FIND_URL}?Key=${this.#apiKey}&Container=${id}&Countries=${this.#countries?.join(",")}`;
+    url += this.buildFiltersQuery();
     return this.fetchFromApi(url);
   }
   async get(id) {