smartystreets-javascript-sdk 5.2.0 → 6.0.0

package/src/us_extract/Result.js

@@ -1,21 +0,0 @@
-const Address = require("./Address");
-
-/**
- * @see <a href="https://www.smarty.com/docs/cloud/us-extract-api#http-response-status">Smarty US Extract API docs</a>
- */
-class Result {
-	constructor({meta, addresses}) {
-		this.meta = {
-			lines: meta.lines,
-			unicode: meta.unicode,
-			addressCount: meta.address_count,
-			verifiedCount: meta.verified_count,
-			bytes: meta.bytes,
-			characterCount: meta.character_count,
-		};
-
-		this.addresses = addresses.map(rawAddress => new Address(rawAddress));
-	}
-}
-
-module.exports = Result;

package/src/us_reverse_geo/Client.js

@@ -1,40 +0,0 @@
-const Request = require("../Request");
-const Response = require("./Response");
-const buildInputData = require("../util/buildInputData");
-const keyTranslationFormat = require("../util/apiToSDKKeyMap").usReverseGeo;
-const {UndefinedLookupError} = require("../Errors.js");
-
-/**
- * This client sends lookups to the Smarty US Reverse Geo API, <br>
- *     and attaches the results to the appropriate Lookup objects.
- */
-class Client {
-	constructor(sender) {
-		this.sender = sender;
-	}
-
-	send(lookup) {
-		if (typeof lookup === "undefined") throw new UndefinedLookupError();
-
-		let request = new Request();
-		request.parameters = buildInputData(lookup, keyTranslationFormat);
-
-		return new Promise((resolve, reject) => {
-			this.sender.send(request)
-				.then(response => {
-					if (response.error) reject(response.error);
-
-					resolve(attachLookupResults(response, lookup));
-				})
-				.catch(reject);
-		});
-
-		function attachLookupResults(response, lookup) {
-			lookup.response = new Response(response.payload);
-
-			return lookup;
-		}
-	}
-}
-
-module.exports = Client;

package/src/us_reverse_geo/Lookup.js

@@ -1,17 +0,0 @@
-const Response = require("./Response");
-
-/**
- * In addition to holding all of the input data for this lookup, this class also<br>
- *     will contain the result of the lookup after it comes back from the API.
- *     @see "https://www.smarty.com/docs/cloud/us-street-api#input-fields"
- */
-class Lookup {
-	constructor(latitude, longitude, source="") {
-		this.latitude = latitude.toFixed(8);
-		this.longitude = longitude.toFixed(8);
-		this.source = source;
-		this.response = new Response();
-	}
-}
-
-module.exports = Lookup;

package/src/us_reverse_geo/Response.js

@@ -1,17 +0,0 @@
-const Result = require("./Result");
-
-/**
- * The SmartyResponse contains the response from a call to the US Reverse Geo API.
- */
-class Response {
-	constructor(responseData) {
-		this.results = [];
-
-		if (responseData)
-			responseData.results.map(rawResult => {
-				this.results.push(new Result(rawResult));
-			});
-	}
-}
-
-module.exports = Response;

package/src/us_reverse_geo/Result.js

@@ -1,36 +0,0 @@
-/**
- * A candidate is a possible match for an address that was submitted.<br>
- *     A lookup can have multiple candidates if the address was ambiguous.
- *
- * @see "https://www.smarty.com/docs/cloud/us-reverse-geo-api#result"
- */
-class Result {
-	constructor(responseData) {
-		this.distance = responseData.distance;
-
-		this.address = {};
-		if (responseData.address) {
-			this.address.street = responseData.address.street;
-			this.address.city = responseData.address.city;
-			this.address.state_abbreviation = responseData.address.state_abbreviation;
-			this.address.zipcode = responseData.address.zipcode;
-			this.address.source = responseData.address.source
-		}
-
-		this.coordinate = {};
-		if (responseData.coordinate) {
-			this.coordinate.latitude = responseData.coordinate.latitude;
-			this.coordinate.longitude = responseData.coordinate.longitude;
-			this.coordinate.accuracy = responseData.coordinate.accuracy;
-			switch (responseData.coordinate.license) {
-				case 1:
-					this.coordinate.license = "SmartyStreets Proprietary";
-					break;
-				default:
-					this.coordinate.license = "SmartyStreets";
-			}
-		}
-	}
-}
-
-module.exports = Result;

package/src/us_street/Candidate.js

@@ -1,89 +0,0 @@
-/**
- * A candidate is a possible match for an address that was submitted.<br>
- *     A lookup can have multiple candidates if the address was ambiguous, and<br>
- *     the maxCandidates field is set higher than 1.
- *
- * @see "https://www.smarty.com/docs/cloud/us-street-api#root"
- */
-class Candidate {
-	constructor(responseData) {
-		this.inputIndex = responseData.input_index;
-		this.candidateIndex = responseData.candidate_index;
-		this.addressee = responseData.addressee;
-		this.deliveryLine1 = responseData.delivery_line_1;
-		this.deliveryLine2 = responseData.delivery_line_2;
-		this.lastLine = responseData.last_line;
-		this.deliveryPointBarcode = responseData.delivery_point_barcode;
-		this.smartyKey = responseData.smarty_key;
-
-		this.components = {};
-		if (responseData.components !== undefined) {
-			this.components.urbanization = responseData.components.urbanization;
-			this.components.primaryNumber = responseData.components.primary_number;
-			this.components.streetName = responseData.components.street_name;
-			this.components.streetPredirection = responseData.components.street_predirection;
-			this.components.streetPostdirection = responseData.components.street_postdirection;
-			this.components.streetSuffix = responseData.components.street_suffix;
-			this.components.secondaryNumber = responseData.components.secondary_number;
-			this.components.secondaryDesignator = responseData.components.secondary_designator;
-			this.components.extraSecondaryNumber = responseData.components.extra_secondary_number;
-			this.components.extraSecondaryDesignator = responseData.components.extra_secondary_designator;
-			this.components.pmbDesignator = responseData.components.pmb_designator;
-			this.components.pmbNumber = responseData.components.pmb_number;
-			this.components.cityName = responseData.components.city_name;
-			this.components.defaultCityName = responseData.components.default_city_name;
-			this.components.state = responseData.components.state_abbreviation;
-			this.components.zipCode = responseData.components.zipcode;
-			this.components.plus4Code = responseData.components.plus4_code;
-			this.components.deliveryPoint = responseData.components.delivery_point;
-			this.components.deliveryPointCheckDigit = responseData.components.delivery_point_check_digit;
-		}
-
-		this.metadata = {};
-		if (responseData.metadata !== undefined) {
-			this.metadata.recordType = responseData.metadata.record_type;
-			this.metadata.zipType = responseData.metadata.zip_type;
-			this.metadata.countyFips = responseData.metadata.county_fips;
-			this.metadata.countyName = responseData.metadata.county_name;
-			this.metadata.carrierRoute = responseData.metadata.carrier_route;
-			this.metadata.congressionalDistrict = responseData.metadata.congressional_district;
-			this.metadata.buildingDefaultIndicator = responseData.metadata.building_default_indicator;
-			this.metadata.rdi = responseData.metadata.rdi;
-			this.metadata.elotSequence = responseData.metadata.elot_sequence;
-			this.metadata.elotSort = responseData.metadata.elot_sort;
-			this.metadata.latitude = responseData.metadata.latitude;
-			this.metadata.longitude = responseData.metadata.longitude;
-			switch (responseData.metadata.coordinate_license)
-			{
-				case 1:
-					this.metadata.coordinateLicense = "SmartyStreets Proprietary";
-					break;
-				default:
-					this.metadata.coordinateLicense = "SmartyStreets";
-			}
-			this.metadata.precision = responseData.metadata.precision;
-			this.metadata.timeZone = responseData.metadata.time_zone;
-			this.metadata.utcOffset = responseData.metadata.utc_offset;
-			this.metadata.obeysDst = responseData.metadata.dst;
-			this.metadata.isEwsMatch = responseData.metadata.ews_match;
-		}
-
-		this.analysis = {};
-		if (responseData.analysis !== undefined) {
-			this.analysis.dpvMatchCode = responseData.analysis.dpv_match_code;
-			this.analysis.dpvFootnotes = responseData.analysis.dpv_footnotes;
-			this.analysis.cmra = responseData.analysis.dpv_cmra;
-			this.analysis.vacant = responseData.analysis.dpv_vacant;
-			this.analysis.noStat = responseData.analysis.dpv_no_stat;
-			this.analysis.active = responseData.analysis.active;
-			this.analysis.isEwsMatch = responseData.analysis.ews_match; // Deprecated, refer to metadata.ews_match
-			this.analysis.footnotes = responseData.analysis.footnotes;
-			this.analysis.lacsLinkCode = responseData.analysis.lacslink_code;
-			this.analysis.lacsLinkIndicator = responseData.analysis.lacslink_indicator;
-			this.analysis.isSuiteLinkMatch = responseData.analysis.suitelink_match;
-			this.analysis.enhancedMatch = responseData.analysis.enhanced_match;
-		}
-	}
-}
-
-module.exports = Candidate;

package/src/us_street/Client.js

@@ -1,43 +0,0 @@
-const Candidate = require("./Candidate");
-const Lookup = require("./Lookup");
-const Batch = require("../Batch");
-const UndefinedLookupError = require("../Errors").UndefinedLookupError;
-const sendBatch = require("../util/sendBatch");
-const keyTranslationFormat = require("../util/apiToSDKKeyMap").usStreet;
-
-/**
- * This client sends lookups to the Smarty US Street API, <br>
- *     and attaches the results to the appropriate Lookup objects.
- */
-class Client {
-	constructor(sender) {
-		this.sender = sender;
-	}
-
-	/**
-	 * Sends up to 100 lookups for validation.
-	 * @param data may be a Lookup object, or a Batch which must contain between 1 and 100 Lookup objects
-	 * @throws SmartyException
-	 */
-	send(data) {
-		const dataIsBatch = data instanceof Batch;
-		const dataIsLookup = data instanceof Lookup;
-
-		if (!dataIsLookup && !dataIsBatch) throw new UndefinedLookupError;
-
-		let batch;
-
-		if (dataIsLookup) {
-			if (data.maxCandidates == null && data.match == "enhanced")
-				data.maxCandidates = 5;
-			batch = new Batch();
-			batch.add(data);
-		} else {
-			batch = data;
-		}
-
-		return sendBatch(batch, this.sender, Candidate, keyTranslationFormat);
-	}
-}
-
-module.exports = Client;

package/src/us_street/Lookup.js

@@ -1,25 +0,0 @@
-/**
- * In addition to holding all of the input data for this lookup, this class also<br>
- *     will contain the result of the lookup after it comes back from the API.
- *     @see "https://www.smarty.com/docs/cloud/us-street-api#input-fields"
- */
-class Lookup {
-	constructor(street, street2, secondary, city, state, zipCode, lastLine, addressee, urbanization, match, maxCandidates, inputId, format) {
-		this.street = street;
-		this.street2 = street2;
-		this.secondary = secondary;
-		this.city = city;
-		this.state = state;
-		this.zipCode = zipCode;
-		this.lastLine = lastLine;
-		this.addressee = addressee;
-		this.urbanization = urbanization;
-		this.match = match;
-		this.maxCandidates = maxCandidates;
-		this.inputId = inputId;
-		this.format = format;
-		this.result = [];
-	}
-}
-
-module.exports = Lookup;

package/src/us_zipcode/Client.js

@@ -1,39 +0,0 @@
-const Lookup = require("./Lookup");
-const Result = require("./Result");
-const Batch = require("../Batch");
-const UndefinedLookupError = require("../Errors").UndefinedLookupError;
-const sendBatch = require("../util/sendBatch");
-const keyTranslationFormat = require("../util/apiToSDKKeyMap").usZipcode;
-
-/**
- * This client sends lookups to the Smarty US ZIP Code API, <br>
- *     and attaches the results to the appropriate Lookup objects.
- */
-class Client {
-	constructor(sender) {
-		this.sender = sender;
-	}
-
-	/**
-	 * Sends up to 100 lookups for validation.
-	 * @param data May be a Lookup object, or a Batch which must contain between 1 and 100 Lookup objects
-	 * @throws SmartyException
-	 */
-	send(data) {
-		const dataIsBatch = data instanceof Batch;
-		const dataIsLookup = data instanceof Lookup;
-
-		if (!dataIsLookup && !dataIsBatch) throw new UndefinedLookupError;
-
-		let batch;
-
-		if (dataIsLookup) {
-			batch = new Batch();
-			batch.add(data);
-		} else batch = data;
-
-		return sendBatch(batch, this.sender, Result, keyTranslationFormat);
-	}
-}
-
-module.exports = Client;

package/src/us_zipcode/Lookup.js

@@ -1,16 +0,0 @@
-/**
- * In addition to holding all of the input data for this lookup, this class also<br>
- *     will contain the result of the lookup after it comes back from the API.
- *     @see "https://www.smarty.com/docs/cloud/us-zipcode-api#http-request-input-fields"
- */
-class Lookup {
-	constructor(city, state, zipCode, inputId) {
-		this.city = city;
-		this.state = state;
-		this.zipCode = zipCode;
-		this.inputId = inputId;
-		this.result = [];
-	}
-}
-
-module.exports = Lookup;

package/src/us_zipcode/Result.js

@@ -1,45 +0,0 @@
-/**
- * @see "https://www.smarty.com/docs/cloud/us-zipcode-api#root"
- */
-class Result {
-	constructor(responseData) {
-		this.inputIndex = responseData.input_index;
-		this.status = responseData.status;
-		this.reason = responseData.reason;
-		this.valid = this.status === undefined && this.reason === undefined;
-
-		this.cities = !responseData.city_states ? [] : responseData.city_states.map(city => {
-			return {
-				city: city.city,
-				stateAbbreviation: city.state_abbreviation,
-				state: city.state,
-				mailableCity: city.mailable_city,
-			};
-		});
-
-		this.zipcodes = !responseData.zipcodes ? [] : responseData.zipcodes.map(zipcode => {
-			return {
-				zipcode: zipcode.zipcode,
-				zipcodeType: zipcode.zipcode_type,
-				defaultCity: zipcode.default_city,
-				countyFips: zipcode.county_fips,
-				countyName: zipcode.county_name,
-				latitude: zipcode.latitude,
-				longitude: zipcode.longitude,
-				precision: zipcode.precision,
-				stateAbbreviation: zipcode.state_abbreviation,
-				state: zipcode.state,
-				alternateCounties: !zipcode.alternate_counties ? [] : zipcode.alternate_counties.map(county => {
-					return {
-						countyFips: county.county_fips,
-						countyName: county.county_name,
-						stateAbbreviation: county.state_abbreviation,
-						state: county.state,
-					}
-				}),
-			};
-		});
-	}
-}
-
-module.exports = Result;

package/src/util/Sleeper.js

@@ -1,8 +0,0 @@
-class Sleeper {
-	constructor () {}
-	sleep(seconds) {
-		return new Promise(resolve => setTimeout(resolve, seconds*1000));
-	}
-}
-
-module.exports = Sleeper;

package/src/util/apiToSDKKeyMap.js

@@ -1,75 +0,0 @@
-module.exports = {
-	usStreet: {
-		"street": "street",
-		"street2": "street2",
-		"secondary": "secondary",
-		"city": "city",
-		"state": "state",
-		"zipcode": "zipCode",
-		"lastline": "lastLine",
-		"addressee": "addressee",
-		"urbanization": "urbanization",
-		"match": "match",
-		"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",
-		"zipcode": "zipCode",
-	},
-	internationalStreet: {
-		"country": "country",
-		"freeform": "freeform",
-		"address1": "address1",
-		"address2": "address2",
-		"address3": "address3",
-		"address4": "address4",
-		"organization": "organization",
-		"locality": "locality",
-		"administrative_area": "administrativeArea",
-		"postal_code": "postalCode",
-		"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",
-	},
-	usEnrichment: {
-		include: "include",
-		exclude: "exclude",
-		dataset: "dataset",
-		data_subset: "dataSubset",
-	}
-};

package/src/util/buildClients.js

@@ -1,48 +0,0 @@
-const ClientBuilder = require("../ClientBuilder");
-
-function instantiateClientBuilder(credentials) {
-	return new ClientBuilder(credentials);
-}
-
-function buildUsStreetApiClient(credentials) {
-	return instantiateClientBuilder(credentials).buildUsStreetApiClient();
-}
-
-function buildUsAutocompleteProApiClient(credentials) {
-	return instantiateClientBuilder(credentials).buildUsAutocompleteProClient();
-}
-
-function buildUsExtractApiClient(credentials) {
-	return instantiateClientBuilder(credentials).buildUsExtractClient();
-}
-
-function buildUsZipcodeApiClient(credentials) {
-	return instantiateClientBuilder(credentials).buildUsZipcodeClient();
-}
-
-function buildInternationalStreetApiClient(credentials) {
-	return instantiateClientBuilder(credentials).buildInternationalStreetClient();
-}
-
-function buildUsReverseGeoApiClient(credentials) {
-	return instantiateClientBuilder(credentials).buildUsReverseGeoClient();
-}
-
-function buildInternationalAddressAutocompleteApiClient(credentials) {
-	return instantiateClientBuilder(credentials).buildInternationalAddressAutocompleteClient();
-}
-
-function buildUsEnrichmentApiClient(credentials) {
-	return instantiateClientBuilder(credentials).buildUsEnrichmentClient();
-}
-
-module.exports = {
-	usStreet: buildUsStreetApiClient,
-	usAutocompletePro: buildUsAutocompleteProApiClient,
-	usExtract: buildUsExtractApiClient,
-	usZipcode: buildUsZipcodeApiClient,
-	internationalStreet: buildInternationalStreetApiClient,
-	usReverseGeo: buildUsReverseGeoApiClient,
-	internationalAddressAutocomplete: buildInternationalAddressAutocompleteApiClient,
-	usEnrichment: buildUsEnrichmentApiClient,
-};

package/src/util/buildInputData.js

@@ -1,11 +0,0 @@
-const InputData = require("../InputData");
-
-module.exports = (lookup, keyTranslationFormat) => {
-	let inputData = new InputData(lookup);
-
-	for (let key in keyTranslationFormat) {
-		inputData.add(key, keyTranslationFormat[key]);
-	}
-
-	return inputData.data;
-};

package/src/util/buildSmartyResponse.js

@@ -1,10 +0,0 @@
-const Response = require("../Response.js");
-
-function buildSmartyResponse(response, error) {
-	if (response) return new Response(response.status, response.data, response.error, response.headers);
-	return new Response(undefined, undefined, error)
-}
-
-module.exports = {
-	buildSmartyResponse
-};

package/src/util/sendBatch.js

@@ -1,39 +0,0 @@
-const Request = require("../Request");
-const Errors = require("../Errors");
-const buildInputData = require("../util/buildInputData");
-
-module.exports = (batch, sender, Result, keyTranslationFormat) => {
-	if (batch.isEmpty()) throw new Errors.BatchEmptyError;
-
-	let request = new Request();
-
-	if (batch.length() === 1) request.parameters = generateRequestPayload(batch)[0];
-	else request.payload = generateRequestPayload(batch);
-
-	return new Promise((resolve, reject) => {
-		sender.send(request)
-			.then(response => {
-				if (response.error) reject(response.error);
-
-				resolve(assignResultsToLookups(batch, response));
-			})
-			.catch(reject);
-	});
-
-	function generateRequestPayload(batch) {
-		return batch.lookups.map((lookup) => {
-			return buildInputData(lookup, keyTranslationFormat);
-		});
-	}
-
-	function assignResultsToLookups(batch, response) {
-		response.payload.map(rawResult => {
-			let result = new Result(rawResult);
-			let lookup = batch.getByIndex(result.inputIndex);
-
-			lookup.result.push(result);
-		});
-
-		return batch;
-	}
-};

package/tests/fixtures/MockSleeper.js

@@ -1,10 +0,0 @@
-class MockSleeper {
-	constructor() {
-		this.sleepDurations = [];
-	}
-	sleep(ms) {
-		this.sleepDurations.push(ms);
-	}
-}
-
-module.exports = MockSleeper;

package/tests/fixtures/mock_senders.js

@@ -1,43 +0,0 @@
-const {buildSmartyResponse} = require("../../src/util/buildSmartyResponse.js");
-const Response = require("../../src/Response");
-
-module.exports = {
-	MockSender: function () {
-		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) {
-		this.send = function () {
-			return new Promise((resolve, reject) => {
-				resolve(new Response("", expectedPayload, expectedError));
-			});
-		}
-	},
-	MockSenderWithStatusCodesAndHeaders: function (statusCodes, headers = undefined, error = undefined) {
-		this.statusCodes = statusCodes;
-		this.headers = headers;
-		this.error = error;
-		this.currentStatusCodeIndex = 0;
-
-		this.send = function (request) {
-			let mockResponse = {
-				status: this.statusCodes[this.currentStatusCodeIndex],
-				headers: this.headers,
-				error: this.error,
-			};
-			const response = buildSmartyResponse(mockResponse);
-			this.currentStatusCodeIndex += 1;
-			return response;
-		}
-	}
-};