smartystreets-javascript-sdk 4.0.0 → 4.0.1

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,7 +2,12 @@ const SmartySDK = require("smartystreets-javascript-sdk");
 const SmartyCore = SmartySDK.core;
 const Lookup = SmartySDK.internationalAddressAutocomplete.Lookup;
 
-// International Autocomplete only supports using Embedded Keys
+// 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);
 

package/package.json

@@ -1,6 +1,6 @@
 {
  "name": "smartystreets-javascript-sdk",
- "version": "4.0.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.baseUrlParams ? `/${request.baseUrlParams}` : ""}`;
+			request.baseUrl = `${this.urlOverride}${request.baseUrlParam ? `/${request.baseUrlParam}` : ""}`;
 
 			this.sender.send(request)
 				.then(resolve)

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,7 +1,7 @@
 class Request {
 	constructor(payload) {
 		this.baseUrl = "";
-		this.baseUrlParams = "";
+		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,16 +13,10 @@ 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.maxResults,
-			include_only_locality: lookup.includeOnlyLocality,
-			include_only_postal_code: lookup.includeOnlyPostalCode,
-		};
+		request.parameters = buildInputData(lookup, keyTranslationFormat);
 
 		if (lookup.addressId) {
-			request.baseUrlParams = lookup.addressId;
+			request.baseUrlParam = lookup.addressId;
 		}
 
 		return new Promise((resolve, reject) => {

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

@@ -14,9 +14,6 @@ describe("An International Address Autocomplete Client", function () {
 		let search = "(";
 		let lookup = new Lookup({search});
 		let expectedParameters = {
-			country: undefined,
-			include_only_locality: undefined,
-			include_only_postal_code: undefined,
 			max_results: 5,
 			search: "(",
 		};
@@ -35,8 +32,6 @@ describe("An International Address Autocomplete Client", function () {
 		let expectedParameters = {
 			country: "Russia",
 			max_results: 5,
-			include_only_locality: undefined,
-			include_only_postal_code: undefined,
 			search: search,
 		};
 
@@ -52,10 +47,7 @@ describe("An International Address Autocomplete Client", function () {
 		lookup.search = search;
 		lookup.maxResults = 10;
 		let expectedParameters = {
-			country: undefined,
 			max_results: 10,
-			include_only_locality: undefined,
-			include_only_postal_code: undefined,
 			search: search,
 		};
 

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);