smartystreets-javascript-sdk 1.11.4 → 1.11.8

package/Makefile

@@ -18,7 +18,10 @@ publish: clean test version upload unversion
 	git push origin --tags
 
 upload:
-	npm publish && node browserify.js && node s3.js
+	npm publish
+
+upload_s3:
+	node browserify.js && node s3.js
 
 version:
 	sed -i.bak -e 's/^ "version": "0\.0\.0",/ "version": "$(VERSION)",/g' "$(VERSION_FILE1)" && rm -f "$(VERSION_FILE1).bak"

package/examples/international_address_autocomplete.js

@@ -0,0 +1,46 @@
+const SmartyStreetsSDK = require("smartystreets-javascript-sdk");
+const SmartyStreetsCore = SmartyStreetsSDK.core;
+const Lookup = SmartyStreetsSDK.internationalAddressAutocomplete.Lookup;
+
+// US Autocomplete Pro only supports using Website Keys
+let key = process.env.SMARTY_WEBSITE_KEY;
+const credentials = new SmartyStreetsCore.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.smartystreets.com/docs/cloud/licensing
+let clientBuilder = new SmartyStreetsCore.ClientBuilder(credentials).withLicenses(["international-autocomplete-cloud"])
+// .withBaseUrl("");
+let client = clientBuilder.buildInternationalAddressAutocompleteClient();
+
+// Documentation for input fields can be found at:
+//www.smartystreets.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 = "";
+
+await handleRequest(lookup, "Using Filter and Prefer");
+
+
+function logSuggestions(response, message) {
+	console.log(message);
+	console.log(response.result);
+	console.log("*********************");
+}
+
+async function handleRequest(lookup, lookupType) {
+	try {
+		const results = await client.send(lookup);
+		logSuggestions(results, lookupType);
+	} catch(err) {
+		console.log(err)
+	}
+}

package/examples/international_street.js

@@ -33,12 +33,8 @@ lookup2.administrativeArea = "SP";
 lookup2.country = "Brazil";
 lookup2.postalCode = "02516-050";
 
-client.send(lookup1)
-	.then(displayResult)
-	.catch(handleError);
-client.send(lookup2)
-	.then(displayResult)
-	.catch(handleError);
+await handleRequest(lookup1)
+await handleRequest(lookup2)
 
 function displayResult(result) {
 	console.log(result.result[0].components);
@@ -46,4 +42,13 @@ function displayResult(result) {
 
 function handleError(error) {
 	console.log("ERROR:", error);
+}
+
+async function handleRequest(lookup) {
+	try {
+		const result = await client.send(lookup);
+		displayResult(result);
+	} catch(err) {
+		handleError(err);
+	}
 }

package/examples/us_autocomplete_pro.js

@@ -16,14 +16,10 @@ let client = clientBuilder.buildUsAutocompleteProClient();
 // Documentation for input fields can be found at:
 // https://smartystreets.com/docs/cloud/us-autocomplete-api#pro-http-request-input-fields
 
-
 // *** Simple Lookup ***
 let lookup = new Lookup("4770 Lincoln");
 
-client.send(lookup)
-	.then(function(results) { logSuggestions(results, "Simple Lookup") })
-	.catch(console.log);
-
+await handleRequest(lookup, "Simple Lookup");
 
 // *** Using Filter and Prefer ***
 lookup = new Lookup("4770 Lincoln");
@@ -34,20 +30,14 @@ lookup.preferStates = ["IL"];
 lookup.preferRatio = 33;
 lookup.source = "all";
 
-client.send(lookup)
-	.then(function(results) { logSuggestions(results, "Using Filter and Prefer") })
-	.catch(console.log);
-
+await handleRequest(lookup, "Using Filter and Prefer");
 
 // *** Using 'selected' to Expand Secondaries ***
 lookup = new Lookup("4770 Lincoln");
 
 lookup.selected = "4770 N Lincoln Ave Ste 2 (3) Chicago, IL 60625";
 
-client.send(lookup)
-	.then(function(results) { logSuggestions(results, "Using 'selected' to Expand Secondaries") })
-	.catch(console.log);
-
+await handleRequest(lookup, "Using 'selected' to Expand Secondaries")
 
 // ************************************************
 
@@ -55,4 +45,13 @@ function logSuggestions(response, message) {
 	console.log(message);
 	console.log(response.result);
 	console.log("*********************");
+}
+
+async function handleRequest(lookup, lookupType) {
+	try {
+		const results = await client.send(lookup);
+		logSuggestions(results, lookupType);
+	} catch(err) {
+		console.log(err)
+	}
 }

package/examples/us_extract.js

@@ -23,10 +23,17 @@ lookup.aggressive = true;
 lookup.addressesHaveLineBreaks = false;
 lookup.addressesPerLine = 1;
 
-client.send(lookup)
-	.then(logResult)
-	.catch(console.log);
+await handleRequest(lookup);
 
 function logResult(response) {
 	console.log(response.result);
+}
+
+async function handleRequest(lookup) {
+	try {
+		const response = await client.send(lookup);
+		logResult(response);
+	} catch(err) {
+		console.log(err);
+	}
 }

package/examples/us_reverse_geo.js

@@ -20,9 +20,7 @@ let client = clientBuilder.buildUsReverseGeoClient();
 
 let lookup1 = new Lookup(40.27644, -111.65747);
 
-client.send(lookup1)
-	.then(displayResult)
-	.catch(handleError);
+await handleResponse(lookup1);
 
 function displayResult(result) {
 	console.log(result.result[0].address);
@@ -31,3 +29,12 @@ function displayResult(result) {
 function handleError(error) {
 	console.log("ERROR:", error);
 }
+
+async function handleResponse(lookup) {
+	try {
+		const result = await client.send(lookup);
+		displayResult(result);
+	} catch(err) {
+		handleError(err);
+	}
+}

package/examples/us_street.js

@@ -51,9 +51,7 @@ batch.add(lookup1);
 batch.add(lookup2);
 batch.add(lookup3);
 
-client.send(batch)
-	.then(handleSuccess)
-	.catch(handleError);
+await handleResponse(batch);
 
 function handleSuccess(response) {
 	response.lookups.map(lookup => console.log(lookup.result));
@@ -61,4 +59,13 @@ function handleSuccess(response) {
 
 function handleError(response) {
 	console.log(response);
+}
+
+async function handleResponse(lookup) {
+	try {
+		const result = await client.send(lookup);
+		handleSuccess(result);
+	} catch(err) {
+		handleError(err);
+	}
 }

package/examples/us_zipcode.js

@@ -37,13 +37,20 @@ batch.add(lookup1);
 batch.add(lookup2);
 batch.add(lookup3);
 
-client.send(batch)
-	.then(viewResults)
-	.catch(console.log);
+await handleResponse(batch);
 
 function viewResults(response) {
 	response.lookups.map(lookup => lookup.result.map(candidate => {
 		candidate.cities.map(city => console.log(city.city));
 		// candidate.zipcodes.map(zipcode => console.log(zipcode.zipcode));
 	}));
+}
+
+async function handleResponse(lookup) {
+	try {
+		const result = await client.send(lookup);
+		viewResults(result);
+	} catch(err) {
+		console.log(err);
+	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
  "name": "smartystreets-javascript-sdk",
- "version": "1.11.4",
+ "version": "1.11.8",
  "description": "Quick and easy SmartyStreets address validation.",
  "keywords": [
   "smartystreets",

package/src/international_address_autocomplete/Client.js

@@ -15,6 +15,9 @@ class Client {
 		request.parameters = {
 			search: lookup.search,
 			country: lookup.country,
+			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,
 		};
 
 		return new Promise((resolve, reject) => {

package/src/us_street/Client.js

@@ -28,6 +28,8 @@ class Client {
 		let batch;
 
 		if (dataIsLookup) {
+			if (data.maxCandidates == null && data.match == "enhanced")
+				data.maxCandidates = 5;
 			batch = new Batch();
 			batch.add(data);
 		} else {

package/tests/international_address_autocomplete/test_Client.js

@@ -17,6 +17,9 @@ describe("An International Address Autocomplete Client", function () {
 		let lookup = new Lookup(search);
 		let expectedParameters = {
 			search: search,
+			include_only_administrative_area: "",
+			include_only_locality: "",
+			include_only_postal_code: "",
 			country: "United States",
 		};
 
@@ -32,8 +35,11 @@ describe("An International Address Autocomplete Client", function () {
 		lookup.search = search;
 		lookup.country = "Russia";
 		let expectedParameters = {
-			search: search,
 			country: "Russia",
+			include_only_administrative_area: "",
+			include_only_locality: "",
+			include_only_postal_code: "",
+			search: search,
 		};
 
 		client.send(lookup);

package/tests/us_street/test_Client.js

@@ -52,6 +52,21 @@ describe("A US Street client", function () {
 		expect(mockSender.request.parameters).to.deep.equal(expectedParameters);
 	});
 
+	it("defaults maxCandidates to 5 when match type is enhanced.", function () {
+		let mockSender = new MockSender();
+		const client = new Client(mockSender);
+		let lookup = new Lookup();
+		lookup.match = "enhanced";
+		let expectedParameters = {
+			match: "enhanced",
+			candidates: 5,
+		};
+
+		client.send(lookup);
+
+		expect(mockSender.request.parameters).to.deep.equal(expectedParameters);
+	});
+
 	it("doesn't send an empty batch.", function () {
 		let mockSender = new MockSender();
 		const client = new Client(mockSender);