feat(helpers): adds format-address helper

Author: aarondrabeck

packages/web/titanium/address-input/manual-address-dialog.ts

@@ -14,8 +14,8 @@ import { DOMEvent } from '../types/dom-event';
 import { allowDialogOverflow, preventDialogOverflow } from '../hacks/dialog-overflow-hacks';
 import { dialogZIndexHack } from '../hacks/dialog-zindex-hack';
 import { reportValidityIfError } from '../hacks/report-validity-if-error';
-import { caStates, usStates } from './utils/states-abbr-to-titlecase';
-import { countries } from './utils/country-abbr-to-titlecase';
+import { caStates, usStates } from '../helpers/address/states-abbr-to-titlecase';
+import { countries } from '../helpers/address/country-abbr-to-titlecase';
 
 @customElement('manual-address-dialog')
 export class ManualAddressDialog extends LitElement {

…input/utils/country-abbr-to-titlecase.ts …ers/address/country-abbr-to-titlecase.tspackages/web/titanium/address-input/utils/country-abbr-to-titlecase.ts renamed to packages/web/titanium/helpers/address/country-abbr-to-titlecase.ts packages/web/titanium/address-input/utils/country-abbr-to-titlecase.ts renamed to packages/web/titanium/helpers/address/country-abbr-to-titlecase.ts

@@ -0,0 +1,51 @@
+import { IAddress, Person } from '@leavittsoftware/lg-core-typescript';
+import { html, TemplateResult } from 'lit';
+import { join } from 'lit/directives/join.js';
+import { getCountryName } from './get-country-name';
+
+export function formatAddressParts(address: Partial<IAddress> | Partial<Person>, options: formatAddressOptions = {}) {
+  if (!address) {
+    return {};
+  }
+
+  const street1 = 'Street1' in address ? address.Street1?.trim() : 'CompanyAddressStreet1' in address ? address.CompanyAddressStreet1?.trim() : '';
+  const street2 = 'Street2' in address ? address.Street2?.trim() : 'CompanyAddressStreet2' in address ? address.CompanyAddressStreet2?.trim() : '';
+  const city = 'City' in address ? address.City?.trim() : 'CompanyAddressCity' in address ? address.CompanyAddressCity?.trim() : '';
+  const state = 'State' in address ? address.State?.trim() : 'CompanyAddressState' in address ? address.CompanyAddressState?.trim() : '';
+  const zip = 'Zip' in address ? address.Zip?.trim() : 'CompanyAddressZip' in address ? address.CompanyAddressZip?.trim() : '';
+  const country = 'Country' in address ? address.Country?.trim() : 'CompanyAddressCountry' in address ? address.CompanyAddressCountry?.trim() : '';
+
+  const line1 = street1;
+  const line2 = street2;
+  const line3 = `${[[city, state].join(' ').trim(), zip].filter((o) => o).join(', ')}`;
+  const line4 = getCountryName(country, options?.excludeCountryIfUSA);
+
+  return {
+    line1: line1 && !options?.excludeLine1 ? line1 : undefined,
+    line2: line2 && !options?.excludeLine2 ? line2 : undefined,
+    line3: line3 && !options?.excludeLine3 ? line3 : undefined,
+    line4: line4 && !options?.excludeLine4 ? line4 : undefined,
+  };
+}
+
+export function formatAddress(
+  address: Partial<IAddress> | Partial<Person>,
+  options: formatAddressOptions = {},
+  joiner: TemplateResult | string = html`<br />`
+) {
+  const parts = formatAddressParts(address, options);
+  const partsArray = Object.values(parts).filter((part) => part !== undefined && part !== '');
+
+  if (partsArray.length === 0) {
+    return null;
+  }
+  return join(partsArray, joiner);
+}
+
+export type formatAddressOptions = {
+  excludeCountryIfUSA?: boolean;
+  excludeLine1?: boolean;
+  excludeLine2?: boolean;
+  excludeLine3?: boolean;
+  excludeLine4?: boolean;
+};

packages/web/titanium/helpers/address/format-address.ts

@@ -0,0 +1,14 @@
+import { countries } from './country-abbr-to-titlecase';
+
+export function getCountryName(countryAbbr: string | null | undefined, excludeCountryIfUSA: boolean = false): string {
+  if (!countryAbbr) {
+    return '';
+  }
+
+  if (excludeCountryIfUSA && countryAbbr.toLowerCase() === 'us') {
+    return '';
+  }
+
+  const country = countries.find((c) => c.abbreviation.toLowerCase() === countryAbbr.toLowerCase());
+  return country ? country.name : countryAbbr;
+}