smartystreets-javascript-sdk 5.1.0 → 5.1.2

package/examples/international_address_autocomplete.js

@@ -15,7 +15,8 @@ const credentials = new SmartyCore.SharedCredentials(key);
 // can be found on the Subscription page of the account dashboard.
 // https://www.smarty.com/docs/cloud/licensing
 const clientBuilder = new SmartyCore.ClientBuilder(credentials).withLicenses(["international-autocomplete-v2-cloud"])
-// .withBaseUrl("");
+	// .withBaseUrl("YOUR URL") // withBaseUrl() should be used if you are self-hosting the Smarty API
+
 const client = clientBuilder.buildInternationalAddressAutocompleteClient();
 
 // Documentation for input fields can be found at:

package/examples/international_street.js

@@ -15,6 +15,8 @@ const credentials = new SmartyCore.SharedCredentials(key);
 // 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-global-plus-cloud"]);
+	// .withBaseUrl("YOUR URL") // withBaseUrl() should be used if you are self-hosting the Smarty API
+
 let client = clientBuilder.buildInternationalStreetClient();
 
 // Documentation for input fields can be found at:

package/examples/us_autocomplete_pro.js

@@ -15,7 +15,8 @@ const credentials = new SmartyCore.SharedCredentials(key);
 // 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(["us-autocomplete-pro-cloud"]);
-// .withBaseUrl("");
+	// .withBaseUrl("YOUR URL") // withBaseUrl() should be used if you are self-hosting the Smarty API
+
 let client = clientBuilder.buildUsAutocompleteProClient();
 
 // Documentation for input fields can be found at:

package/examples/us_enrichment.js

@@ -0,0 +1,36 @@
+const SmartySDK = require("smartystreets-javascript-sdk");
+const SmartyCore = SmartySDK.core;
+const Lookup = SmartySDK.usEnrichment.Lookup;
+
+// 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:
+let 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(["us-property-data-principal-cloud"]);
+	// .withBaseUrl("YOUR URL") // withBaseUrl() should be used if you are self-hosting the Smarty API
+
+let client = clientBuilder.buildUsEnrichmentClient();
+
+// Documentation for input fields can be found at:
+// https://www.smarty.com/docs/us-street-api#input-fields
+
+let lookup = new Lookup("334968275");
+
+handleResponse(lookup).then();
+
+async function handleResponse(lookup) {
+	try {
+		const result = await client.sendPrincipal(lookup);
+		console.log(result.response);
+	} catch (err) {
+		console.log(err);
+	}
+}

package/examples/us_extract.js

@@ -12,7 +12,8 @@ let key = process.env.SMARTY_EMBEDDED_KEY;
 const credentials = new SmartyCore.SharedCredentials(key);
 
 let clientBuilder = new SmartyCore.ClientBuilder(credentials);
-// .withBaseUrl("");
+	// .withBaseUrl("YOUR URL") // withBaseUrl() should be used if you are self-hosting the Smarty API
+
 let client = clientBuilder.buildUsExtractClient();
 
 // Documentation for input fields can be found at:

package/examples/us_reverse_geo.js

@@ -15,7 +15,7 @@ const credentials = new SmartyCore.SharedCredentials(key);
 // 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(["us-reverse-geocoding-cloud"]);
-// .withBaseUrl("");
+	// .withBaseUrl("YOUR URL") // withBaseUrl() should be used if you are self-hosting the Smarty API
 let client = clientBuilder.buildUsReverseGeoClient();
 
 let lookup1 = new Lookup(40.27644, -111.65747, "all");

package/examples/us_street.js

@@ -14,7 +14,9 @@ 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).withBaseUrl("YOUR URL").withLicenses(["us-rooftop-geocoding-cloud"]);
+let clientBuilder = new SmartyCore.ClientBuilder(credentials).withLicenses(["us-rooftop-geocoding-cloud"]);
+	// .withBaseUrl("YOUR URL") // withBaseUrl() should be used if you are self-hosting the Smarty API
+
 let client = clientBuilder.buildUsStreetApiClient();
 
 // Documentation for input fields can be found at:

package/examples/us_zipcode.js

@@ -12,7 +12,8 @@ let key = process.env.SMARTY_EMBEDDED_KEY;
 const credentials = new SmartyCore.SharedCredentials(key);
 
 let clientBuilder = new SmartyCore.ClientBuilder(credentials);
-	// .withBaseUrl("");
+	// .withBaseUrl("YOUR URL") // withBaseUrl() should be used if you are self-hosting the Smarty API
+
 let client = clientBuilder.buildUsZipcodeClient();
 
 // Documentation for input fields can be found at:

package/package.json

@@ -1,6 +1,6 @@
 {
  "name": "smartystreets-javascript-sdk",
- "version": "5.1.0",
+ "version": "5.1.2",
  "description": "Quick and easy Smarty address validation.",
  "keywords": [
   "smarty",
@@ -37,6 +37,7 @@
  },
  "dependencies": {
   "axios": "^1.6.2",
-  "axios-retry": "4.0.0"
+  "axios-retry": "4.0.0",
+  "smartystreets-javascript-sdk": "^5.1.1"
  }
 }

package/src/us_enrichment/Client.js

@@ -14,11 +14,7 @@ class Client {
         let request = new Request();
         request.parameters = buildInputData(lookup, keyTranslationFormat);
 
-        if (lookup.smartyKey) {
-            request.baseUrlParam = lookup.smartyKey;
-        }
-
-        request.baseUrlParam = "property/principal";
+        request.baseUrlParam = lookup.smartyKey + "/property/principal";
 
         return new Promise((resolve, reject) => {
             this.sender.send(request)
@@ -38,11 +34,7 @@ class Client {
         let request = new Request();
         request.parameters = buildInputData(lookup, keyTranslationFormat);
 
-        if (lookup.smartyKey) {
-            request.baseUrlParam = lookup.smartyKey;
-        }
-
-        request.baseUrlParam = "property/financial";
+        request.baseUrlParam = lookup.smartyKey + "/property/financial";
 
         return new Promise((resolve, reject) => {
             this.sender.send(request)
@@ -62,11 +54,7 @@ class Client {
         let request = new Request();
         request.parameters = buildInputData(lookup, keyTranslationFormat);
 
-        if (lookup.smartyKey) {
-            request.baseUrlParam = lookup.smartyKey;
-        }
-
-        request.baseUrlParam = "geo-reference";
+        request.baseUrlParam = lookup.smartyKey + "/geo-reference";
 
         return new Promise((resolve, reject) => {
             this.sender.send(request)

package/tests/fixtures/mock_senders.js

@@ -6,12 +6,14 @@ module.exports = {
 		let request = {
 			payload: undefined,
 			parameters: undefined,
+			baseUrlParam: undefined,
 		};
 		this.request = request;
 
 		this.send = function (clientRequest) {
 			request.payload = clientRequest.payload;
 			request.parameters = clientRequest.parameters;
+			request.baseUrlParam = clientRequest.baseUrlParam;
 		}
 	},
 	MockSenderWithResponse: function (expectedPayload, expectedError) {

package/tests/us_enrichment/test_Client.js

@@ -8,6 +8,39 @@ const MockSenderWithResponse = require("../fixtures/mock_senders").MockSenderWit
 const {Response, FinancialResponse, GeoResponse} = require("../../src/us_enrichment/Response");
 
 describe("A US Enrichment Client", function () {
+    it("composes principal url path properly", function () {
+        let mockSender = new MockSender();
+        let client = new Client(mockSender);
+        let smartyKey = "0";
+        let lookup = new Lookup(smartyKey);
+
+        client.sendPrincipal(lookup);
+
+        expect(mockSender.request.baseUrlParam).to.deep.equal("0/property/principal");
+    })
+
+    it("composes financial url path properly", function () {
+        let mockSender = new MockSender();
+        let client = new Client(mockSender);
+        let smartyKey = "0";
+        let lookup = new Lookup(smartyKey);
+
+        client.sendFinancial(lookup);
+
+        expect(mockSender.request.baseUrlParam).to.deep.equal("0/property/financial");
+    })
+
+    it("composes geo url path properly", function () {
+        let mockSender = new MockSender();
+        let client = new Client(mockSender);
+        let smartyKey = "0";
+        let lookup = new Lookup(smartyKey);
+
+        client.sendGeo(lookup);
+
+        expect(mockSender.request.baseUrlParam).to.deep.equal("0/geo-reference");
+    })
+
     it("correctly builds parameters for a smartyKey only principal lookup.", function () {
         let mockSender = new MockSender();
         let client = new Client(mockSender);