smartystreets-javascript-sdk 3.3.0 → 4.0.1

package/.github/workflows/node-tests.yml

@@ -13,7 +13,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x, 16.x, 18.x]
+        node-version: [14.x, 16.x, 18.x, 20.x]
 
     steps:
     - uses: actions/checkout@v2

package/Makefile

@@ -1,6 +1,6 @@
 #!/usr/bin/make -f
 
-VERSION           := $(shell tagit -m --dry-run)
+VERSION           := $(shell tagit -p --dry-run)
 VERSION_FILE1     := package.json
 VERSION_FILE2     := package-lock.json
 
@@ -11,7 +11,7 @@ node_modules:
 	npm install
 
 publish: test version upload unversion
-	tagit -m
+	tagit -p
 	git push origin --tags
 
 upload:

package/examples/international_address_autocomplete.js

@@ -2,38 +2,49 @@ const SmartySDK = require("smartystreets-javascript-sdk");
 const SmartyCore = SmartySDK.core;
 const Lookup = SmartySDK.internationalAddressAutocomplete.Lookup;
 
-// US Autocomplete Pro only supports using Embedded Keys
-let key = process.env.SMARTY_EMBEDDED_KEY;
+// for Server-to-server requests, use this code:
+// let authId = process.env.SMARTY_AUTH_ID;
+// let authToken = process.env.SMARTY_AUTH_TOKEN;
+// const credentials = new SmartyCore.StaticCredentials(authId, authToken);
+
+// for client-side requests (browser/mobile), use this code:
+const key = process.env.SMARTY_EMBEDDED_KEY;
 const credentials = new SmartyCore.SharedCredentials(key);
 
 // The appropriate license values to be used for your subscriptions
 // can be found on the Subscription page of the account dashboard.
 // https://www.smarty.com/docs/cloud/licensing
-let clientBuilder = new SmartyCore.ClientBuilder(credentials).withLicenses(["international-autocomplete-cloud"])
+const clientBuilder = new SmartyCore.ClientBuilder(credentials).withLicenses(["international-autocomplete-v2-cloud"])
 // .withBaseUrl("");
-let client = clientBuilder.buildInternationalAddressAutocompleteClient();
+const client = clientBuilder.buildInternationalAddressAutocompleteClient();
 
 // Documentation for input fields can be found at:
-//www.smarty.com/docs/cloud/international-address-autocomplete-api#pro-http-request-input-fields
-
-let lookup = new Lookup("Ave", "CAN");
-await handleRequest(lookup, "Simple Request");
-
-// *** Using Filter and Prefer ***
-lookup = new Lookup("Ave", "CAN");
-
-lookup.maxResults = 10;
-// lookup.include_only_administrative_area = "";
-lookup.include_only_locality = "Sherwood Park";
-// lookup.include_only_postal_code = "";
+// www.smarty.com/docs/cloud/international-address-autocomplete-api#pro-http-request-input-fields
+const country = "CAN";
 
-await handleRequest(lookup, "Using Filter and Prefer");
+const summaryLookup = new Lookup({search: "123 Anson", country});
+await handleRequest(summaryLookup, "Response of summary results");
 
+const detailedLookup = new Lookup({addressId: summaryLookup.result[0].addressId, country});
+await handleRequest(detailedLookup, "Response using an address ID to get detailed results");
 
 function logSuggestions(response, message) {
-	console.log(message);
-	console.log(response.result);
-	console.log("*********************");
+	console.log("*** " + message + " ***");
+
+	response.result.forEach(suggestion => {
+		if (suggestion.addressText) {
+			console.log("Entries: ", suggestion.entries);
+			console.log("Address Text: ", suggestion.addressText);
+			console.log("Address ID: ", suggestion.addressId);
+		} else {
+			console.log("Street: ", suggestion.street);
+			console.log("Locality: ", suggestion.locality);
+			console.log("Administrative Area: ", suggestion.administrativeArea);
+			console.log("Postal Code: ", suggestion.postalCode);
+			console.log("Country: ", suggestion.countryIso3);
+		}
+	});
+	console.log("\n");
 }
 
 async function handleRequest(lookup, lookupType) {

package/package.json

@@ -1,6 +1,6 @@
 {
  "name": "smartystreets-javascript-sdk",
- "version": "3.3.0",
+ "version": "4.0.1",
  "description": "Quick and easy Smarty address validation.",
  "keywords": [
   "smarty",
@@ -33,10 +33,10 @@
  },
  "devDependencies": {
   "chai": "^4.3.6",
-  "mocha": "^9.2.2"
+  "mocha": "^10.2.0"
  },
  "dependencies": {
-  "axios": "^0.26.1",
-  "axios-retry": "3.2.0"
+  "axios": "^1.6.2",
+  "axios-retry": "4.0.0"
  }
 }

package/src/BaseUrlSender.js

@@ -6,7 +6,7 @@ class BaseUrlSender {
 
 	send(request) {
 		return new Promise((resolve, reject) => {
-			request.baseUrl = this.urlOverride;
+			request.baseUrl = `${this.urlOverride}${request.baseUrlParam ? `/${request.baseUrlParam}` : ""}`;
 
 			this.sender.send(request)
 				.then(resolve)

package/src/ClientBuilder.js

@@ -28,7 +28,7 @@ const US_EXTRACT_API_URL = "https://us-extract.api.smarty.com/";
 const US_STREET_API_URL = "https://us-street.api.smarty.com/street-address";
 const US_ZIP_CODE_API_URL = "https://us-zipcode.api.smarty.com/lookup";
 const US_REVERSE_GEO_API_URL = "https://us-reverse-geo.api.smarty.com/lookup";
-const INTERNATIONAL_ADDRESS_AUTOCOMPLETE_API_URL = "https://international-autocomplete.api.smarty.com/lookup";
+const INTERNATIONAL_ADDRESS_AUTOCOMPLETE_API_URL = "https://international-autocomplete.api.smarty.com/v2/lookup";
 
 /**
  * The ClientBuilder class helps you build a client object for one of the supported Smarty APIs.<br>

package/src/InputData.js

@@ -5,7 +5,12 @@ class InputData {
 	}
 
 	add(apiField, lookupField) {
-		if (this.lookupFieldIsPopulated(lookupField)) this.data[apiField] = this.lookup[lookupField];
+		if (this.lookupFieldIsPopulated(lookupField)) this.data[apiField] = this.formatData(this.lookup[lookupField]);
+	}
+
+	formatData(field) {
+		if (Array.isArray(field)) return field.join(";");
+		else return field;
 	}
 
 	lookupFieldIsPopulated(lookupField) {

package/src/Request.js

@@ -1,6 +1,7 @@
 class Request {
 	constructor(payload) {
 		this.baseUrl = "";
+		this.baseUrlParam = "";
 		this.payload = payload;
 		this.headers = {
 			"Content-Type": "application/json; charset=utf-8",

package/src/international_address_autocomplete/Client.js

@@ -1,6 +1,8 @@
 const Errors = require("../Errors");
 const Request = require("../Request");
 const Suggestion = require("./Suggestion");
+const buildInputData = require("../util/buildInputData");
+const keyTranslationFormat = require("../util/apiToSDKKeyMap").internationalAddressAutocomplete;
 
 class Client {
 	constructor(sender) {
@@ -11,14 +13,11 @@ class Client {
 		if (typeof lookup === "undefined") throw new Errors.UndefinedLookupError();
 
 		let request = new Request();
-		request.parameters = {
-			search: lookup.search,
-			country: lookup.country,
-			max_results: lookup.max_results,
-			include_only_administrative_area: lookup.include_only_administrative_area,
-			include_only_locality: lookup.include_only_locality,
-			include_only_postal_code: lookup.include_only_postal_code,
-		};
+		request.parameters = buildInputData(lookup, keyTranslationFormat);
+
+		if (lookup.addressId) {
+			request.baseUrlParam = lookup.addressId;
+		}
 
 		return new Promise((resolve, reject) => {
 			this.sender.send(request)

package/src/international_address_autocomplete/Lookup.js

@@ -1,13 +1,13 @@
 class Lookup {
-	constructor(search = "", country = "United States", max_results = undefined, include_only_administrative_area = "", include_only_locality = "", include_only_postal_code = "") {
+	constructor({search, addressId, country, maxResults = 5, includeOnlyLocality, includeOnlyPostalCode} = {}) {
 		this.result = [];
 
 		this.search = search;
+		this.addressId = addressId;
 		this.country = country;
-		this.max_results = max_results;
-		this.include_only_administrative_area = include_only_administrative_area;
-		this.include_only_locality = include_only_locality;
-		this.include_only_postal_code = include_only_postal_code;
+		this.maxResults = maxResults;
+		this.includeOnlyLocality = includeOnlyLocality;
+		this.includeOnlyPostalCode = includeOnlyPostalCode;
 	}
 }
 

package/src/international_address_autocomplete/Suggestion.js

@@ -5,6 +5,9 @@ class Suggestion {
 		this.administrativeArea = responseData.administrative_area;
 		this.postalCode = responseData.postal_code;
 		this.countryIso3 = responseData.country_iso3;
+		this.entries = responseData.entries;
+		this.addressText = responseData.address_text;
+		this.addressId = responseData.address_id;
 	}
 }
 

package/src/us_autocomplete_pro/Client.js

@@ -1,6 +1,8 @@
 const Errors = require("../Errors");
 const Request = require("../Request");
 const Suggestion = require("./Suggestion");
+const buildInputData = require("../util/buildInputData");
+const keyTranslationFormat = require("../util/apiToSDKKeyMap").usAutocompletePro;
 
 /**
  * This client sends lookups to the Smarty US Autocomplete Pro API, <br>
@@ -15,7 +17,7 @@ class Client {
 		if (typeof lookup === "undefined") throw new Errors.UndefinedLookupError();
 
 		let request = new Request();
-		request.parameters = buildRequestParameters(lookup);
+		request.parameters = buildInputData(lookup, keyTranslationFormat);
 
 		return new Promise((resolve, reject) => {
 			this.sender.send(request)
@@ -28,28 +30,6 @@ class Client {
 				.catch(reject);
 		});
 
-		function buildRequestParameters(lookup) {
-			return {
-				search: lookup.search,
-				selected: lookup.selected,
-				max_results: lookup.maxResults,
-				include_only_cities: joinFieldWith(lookup.includeOnlyCities, ";"),
-				include_only_states: joinFieldWith(lookup.includeOnlyStates, ";"),
-				include_only_zip_codes: joinFieldWith(lookup.includeOnlyZIPCodes, ";"),
-				exclude_states: joinFieldWith(lookup.excludeStates, ";"),
-				prefer_cities: joinFieldWith(lookup.preferCities, ";"),
-				prefer_states: joinFieldWith(lookup.preferStates, ";"),
-				prefer_zip_codes: joinFieldWith(lookup.preferZIPCodes, ";"),
-				prefer_ratio: lookup.preferRatio,
-				prefer_geolocation: lookup.preferGeolocation,
-				source: lookup.source,
-			};
-
-			function joinFieldWith(field, delimiter) {
-				if (field.length) return field.join(delimiter);
-			}
-		}
-
 		function buildSuggestionsFromResponse(payload) {
 			if (payload.suggestions === null) return [];
 

package/src/us_extract/Client.js

@@ -1,6 +1,8 @@
 const Errors = require("../Errors");
 const Request = require("../Request");
 const Result = require("./Result");
+const buildInputData = require("../util/buildInputData");
+const keyTranslationFormat = require("../util/apiToSDKKeyMap").usExtract;
 
 /**
  * This client sends lookups to the Smarty US Extract API, <br>
@@ -15,7 +17,7 @@ class Client {
 		if (typeof lookup === "undefined") throw new Errors.UndefinedLookupError();
 
 		let request = new Request(lookup.text);
-		request.parameters = buildRequestParams(lookup);
+		request.parameters = buildInputData(lookup, keyTranslationFormat);
 
 		return new Promise((resolve, reject) => {
 			this.sender.send(request)
@@ -27,15 +29,6 @@ class Client {
 				})
 				.catch(reject);
 		});
-
-		function buildRequestParams(lookup) {
-			return {
-				html: lookup.html,
-				aggressive: lookup.aggressive,
-				addr_line_breaks: lookup.addressesHaveLineBreaks,
-				addr_per_line: lookup.addressesPerLine,
-			};
-		}
 	}
 }
 

package/src/util/apiToSDKKeyMap.js

@@ -13,6 +13,21 @@ module.exports = {
 		"format": "format",
 		"candidates": "maxCandidates",
 	},
+	usAutocompletePro: {
+		search: "search",
+		selected: "selected",
+		max_results: "maxResults",
+		include_only_cities: "includeOnlyCities",
+		include_only_states: "includeOnlyStates",
+		include_only_zip_codes: "includeOnlyZIPCodes",
+		exclude_states: "excludeStates",
+		prefer_cities: "preferCities",
+		prefer_states: "preferStates",
+		prefer_zip_codes: "preferZIPCodes",
+		prefer_ratio: "preferRatio",
+		prefer_geolocation: "preferGeolocation",
+		source: "source",
+	},
 	usZipcode: {
 		"city": "city",
 		"state": "state",
@@ -32,9 +47,23 @@ module.exports = {
 		"geocode": "geocode",
 		"language": "language",
 	},
+	internationalAddressAutocomplete: {
+		search: "search",
+		country: "country",
+		max_results: "maxResults",
+		include_only_administrative_area: "includeOnlyAdministrativeArea",
+		include_only_locality: "includeOnlyLocality",
+		include_only_postal_code: "includeOnlyPostalCode",
+	},
 	usReverseGeo: {
 		"latitude": "latitude",
 		"longitude": "longitude",
 		"source": "source"
+	},
+	usExtract: {
+		html: "html",
+		aggressive: "aggressive",
+		addr_line_breaks: "addressesHaveLineBreaks",
+		addr_per_line: "addressesPerLine",
 	}
 };

package/tests/international_address_autocomplete/test_Client.js

@@ -12,14 +12,10 @@ describe("An International Address Autocomplete Client", function () {
 		let mockSender = new MockSender();
 		let client = new Client(mockSender);
 		let search = "(";
-		let lookup = new Lookup(search);
+		let lookup = new Lookup({search});
 		let expectedParameters = {
-			search: search,
-			max_results: undefined,
-			include_only_administrative_area: "",
-			include_only_locality: "",
-			include_only_postal_code: "",
-			country: "United States",
+			max_results: 5,
+			search: "(",
 		};
 
 		client.send(lookup);
@@ -30,15 +26,12 @@ describe("An International Address Autocomplete Client", function () {
 		let mockSender = new MockSender();
 		let client = new Client(mockSender);
 		let search = "(";
-		let lookup = new Lookup(search);
+		let lookup = new Lookup({search});
 		lookup.search = search;
 		lookup.country = "Russia";
 		let expectedParameters = {
 			country: "Russia",
-			max_results: undefined,
-			include_only_administrative_area: "",
-			include_only_locality: "",
-			include_only_postal_code: "",
+			max_results: 5,
 			search: search,
 		};
 
@@ -50,15 +43,11 @@ describe("An International Address Autocomplete Client", function () {
 		let mockSender = new MockSender();
 		let client = new Client(mockSender);
 		let search = "(";
-		let lookup = new Lookup(search);
+		let lookup = new Lookup({search});
 		lookup.search = search;
-		lookup.max_results = 10;
+		lookup.maxResults = 10;
 		let expectedParameters = {
-			country: "United States",
 			max_results: 10,
-			include_only_administrative_area: "",
-			include_only_locality: "",
-			include_only_postal_code: "",
 			search: search,
 		};
 
@@ -87,7 +76,7 @@ describe("An International Address Autocomplete Client", function () {
 
 		let mockSender = new MockSenderWithResponse(responseData);
 		let client = new Client(mockSender);
-		let lookup = new Lookup("f");
+		let lookup = new Lookup({search: "f"});
 		let expectedSuggestion = new Suggestion(responseData.candidates[0]);
 
 		return client.send(lookup).then(() => {

package/tests/international_address_autocomplete/test_Lookup.js

@@ -5,45 +5,50 @@ const Lookup = require("../../src/international_address_autocomplete/Lookup");
 describe("An International Address Autocomplete lookup", function () {
 	it("Can be newed up with a prefix", function () {
 		const expectedPrefix = "z";
-		let lookup = new Lookup(expectedPrefix);
+		let lookup = new Lookup({search: expectedPrefix});
 		expect(lookup.search).to.equal(expectedPrefix);
 	});
 
-	it("Default country parameter should be United States", function () {
-		let lookup = new Lookup("z");
-		expect(lookup.country).to.equal("United States");
+	it("Set address ID", function () {
+		const addressId = "111";
+		let lookup = new Lookup({addressId});
+		expect(lookup.addressId).to.equal(addressId);
 	});
 
-	it("Manually set lookup to be another country", function () {
+	it("Set country", function () {
 		const country = "Russia";
-		const expectedPrefix = "z";
-		let lookup = new Lookup(expectedPrefix, country);
+		let lookup = new Lookup({country});
 		expect(lookup.country).to.equal(country);
 	});
 
-	it("Set include only administrative area param", function () {
-		const administrativeArea = "administrative area";
-		const expectedPrefix = "z";
-		let lookup = new Lookup(expectedPrefix, "Utah", "test", administrativeArea);
-		expect(lookup.include_only_administrative_area).to.equal(administrativeArea);
+	it("Set max results", function () {
+		const maxResults = 10000;
+		let lookup = new Lookup({maxResults});
+		expect(lookup.maxResults).to.equal(maxResults);
 	});
 
-	it("Set include only locality param", function () {
-		const locality = "locality";
-		const expectedPrefix = "z";
-		let lookup = new Lookup(expectedPrefix, "Utah", "test", "test", locality);
-		expect(lookup.include_only_locality).to.equal(locality);
+	it("Set include only include locality param", function () {
+		const onlyIncludeLocality = "locality";
+		let lookup = new Lookup({includeOnlyLocality: onlyIncludeLocality});
+		expect(lookup.includeOnlyLocality).to.equal(onlyIncludeLocality);
 	});
 
-	it("Set include only postal code param", function () {
-		const postalCode = "locality";
-		const expectedPrefix = "z";
-		let lookup = new Lookup(expectedPrefix, "Utah", "test", "test", "test", postalCode);
-		expect(lookup.include_only_postal_code).to.equal(postalCode);
+	it("Set include only include postal code param", function () {
+		const onlyIncludePostalCode = "post code";
+		let lookup = new Lookup({includeOnlyPostalCode: onlyIncludePostalCode});
+		expect(lookup.includeOnlyPostalCode).to.equal(onlyIncludePostalCode);
 	});
 
 	it("Checking defaults of params on instantiation ", function () {
-		const defaultLookup = new Lookup("", "United States", undefined, "", "", "");
+		const defaultLookup = {
+			result: [],
+			search: undefined,
+			addressId: undefined,
+			country: undefined,
+			maxResults: 5,
+			includeOnlyLocality: undefined,
+			includeOnlyPostalCode: undefined,
+		};
 		let lookup = new Lookup();
 		expect(lookup).to.deep.equal(defaultLookup);
 	});

package/tests/us_autocomplete_pro/test_Client.js

@@ -14,19 +14,14 @@ describe("A US Autocomplete Pro Client", function () {
 		let search = '(>")>#';
 		let lookup = new Lookup(search);
 		let expectedParameters = {
+			exclude_states: "",
+			include_only_cities: "",
+			include_only_states: "",
+			include_only_zip_codes: "",
+			prefer_cities: "",
+			prefer_states: "",
+			prefer_zip_codes: "",
 			search: search,
-			selected: undefined,
-			max_results: undefined,
-			include_only_cities: undefined,
-			include_only_states: undefined,
-			include_only_zip_codes: undefined,
-			exclude_states: undefined,
-			prefer_cities: undefined,
-			prefer_states: undefined,
-			prefer_zip_codes: undefined,
-			prefer_ratio: undefined,
-			prefer_geolocation: undefined,
-			source: undefined,
 		};
 
 		client.send(lookup);