@bcrs-shared-components/base-address 3.0.2 → 3.0.3

package/factories/address-factory.ts

@@ -1,216 +1,216 @@
-/* eslint-disable */
-import { computed, reactive, ref, Ref } from 'vue-demi'
-import { uniqueId } from 'lodash'
-
-import { AddressIF, SchemaIF } from '@bcrs-shared-components/interfaces'
-
-export function useAddress (address: Ref<AddressIF>, schema: SchemaIF) {
-  const addressLocal = address
-  /** The Address Country, to simplify the template and so we can watch it directly. */
-  const country = computed((): string => {
-    return addressLocal.value.country
-  })
-  const schemaLocal = ref(schema)
-  const isSchemaRequired = (prop: string): boolean => {
-    if (!schemaLocal || !schemaLocal.value[prop]) return false
-
-    // check for any rule that does not allow an empty string
-    for (let index in schemaLocal.value[prop]) {
-      if (schemaLocal.value[prop][index]('') !== true) return true
-    }
-    return false
-  }
-  const labels = {
-    /** The Street Address Additional label with 'optional' as needed. */
-    streetAdditionalLabel: computed((): string => {
-      return 'Address Line 2' + (isSchemaRequired('streetAdditional') ? '' : ' (Optional)')
-    }),
-    /** The Street Address label with 'optional' as needed. */
-    streetLabel: computed((): string => {
-      return 'Address Line 1' + (isSchemaRequired('street') ? '' : ' (Optional)')
-    }),
-    /** The Address City label with 'optional' as needed. */
-    cityLabel: computed((): string => {
-      return 'City' + (isSchemaRequired('city') ? '' : ' (Optional)')
-    }),
-    /** The Address Region label with 'optional' as needed. */
-    regionLabel: computed((): string => {
-      let label: string
-      let required = isSchemaRequired('region')
-
-      // NB: make region required for Canada and USA
-      if (addressLocal.value.country === 'CA') {
-        label = 'Province'
-        required = true
-      } else if (addressLocal.value.country === 'US') {
-        label = 'State'
-        required = true
-      } else {
-        label = 'Region'
-      }
-      return label + (required ? '' : ' (Optional)')
-    }),
-    /** The Postal Code label with 'optional' as needed. */
-    postalCodeLabel: computed((): string => {
-      let label: string
-      if (addressLocal.value.country === 'US') {
-        label = 'Zip Code'
-      } else {
-        label = 'Postal Code'
-      }
-      return label + (isSchemaRequired('postalCode') ? '' : ' (Optional)')
-    }),
-    /** The Address Country label with 'optional' as needed. */
-    countryLabel: computed((): string => {
-      return 'Country' + (isSchemaRequired('country') ? '' : ' (Optional)')
-    }),
-    /** The Delivery Instructions label with 'optional' as needed. */
-    deliveryInstructionsLabel: computed((): string => {
-      return 'Delivery Instructions' + (isSchemaRequired('deliveryInstructions') ? '' : ' (Optional)')
-    })
-  }
-  return {
-    addressLocal,
-    country,
-    schemaLocal,
-    isSchemaRequired,
-    labels
-  }
-}
-
-export function useAddressComplete (addressLocal: Ref<AddressIF>) {
-  const combineLines = (line1: string, line2: string) => {
-    if (!line1) return line2
-    if (!line2) return line1
-    return line1 + '\n' + line2
-  }
-  /**
-   * Callback to update the address data after the user chooses a suggested address.
-   * @param address the data object returned by the AddressComplete Retrieve API
-   */
-  const addressCompletePopulate = (addressComplete: object): void => {
-    addressLocal.value.streetAddress = addressComplete['Line1'] || 'N/A'
-    // Combine extra address lines into Street Address Additional field.
-    addressLocal.value.streetAddressAdditional = combineLines(
-      combineLines(addressComplete['Line2'], addressComplete['Line3']),
-      combineLines(addressComplete['Line4'], addressComplete['Line5'])
-    )
-    addressLocal.value.city = addressComplete['City']
-    if (useCountryRegions(addressComplete['CountryIso2'])) {
-      // In this case, v-select will map known province code to province name
-      // or v-select will be blank and user will have to select a known item.
-      addressLocal.value.region = addressComplete['ProvinceCode']
-    } else {
-      // In this case, v-text-input will allow manual entry but province info is probably too long
-      // so set region to null and add province name to the Street Address Additional field.
-      // If length is excessive, user will have to fix it.
-      addressLocal.value.region = ''
-      addressLocal.value.streetAdditional = combineLines(
-        addressLocal.value.streetAdditional, addressComplete['ProvinceName']
-      )
-    }
-    addressLocal.value.postalCode = addressComplete['PostalCode']
-    addressLocal.value.country = addressComplete['CountryIso2']
-  }
-  const uniqueIds = reactive({
-    /** A unique id for this instance of this component. */
-    uniqueId: uniqueId(),
-    /** A unique id for the Street Address input. */
-    streetId: computed((): string => {
-      return `street-address-${uniqueIds.uniqueId}`
-    }),
-    /** A unique id for the Address Country input. */
-    countryId: computed((): string => {
-      return `address-country-${uniqueIds.uniqueId}`
-    })
-  })
-  /**
-   * Creates the AddressComplete object for this instance of the component.
-   * @param pca the Postal Code Anywhere object provided by AddressComplete
-   * @param key the key for the Canada Post account that is to be charged for lookups
-   * @returns an object that is a pca.Address instance
-   */
-  const createAddressComplete = (pca: any, key: string): object => {
-    // Set up the two fields that AddressComplete will use for input.
-    // Ref: https://www.canadapost.ca/pca/support/guides/advanced
-    // Note: Use special field for country, which user can't click, and which AC will overwrite
-    //       but that we don't care about.
-    const fields = [
-      { element: uniqueIds.streetId, field: 'Line1', mode: pca.fieldMode.SEARCH },
-      { element: uniqueIds.countryId, field: 'CountryName', mode: pca.fieldMode.COUNTRY }
-    ]
-    const options = { key }
-
-    const addressComplete = new pca.Address(fields, options)
-
-    // The documentation contains sample load/populate callback code that doesn't work, but this will. The side effect
-    // is that it breaks the autofill functionality provided by the library, but we really don't want the library
-    // altering the DOM because Vue is already doing so, and the two don't play well together.
-    addressComplete.listen('populate', addressCompletePopulate)
-
-    return addressComplete
-  }
-  /** Enables AddressComplete for this instance of the address. */
-  const enableAddressComplete = (): void => {
-    // If you want to use this component with the Canada Post AddressComplete service:
-    // 1. The AddressComplete JavaScript script (and stylesheet) must be loaded.
-    // 2. Your AddressComplete account key must be defined.
-    const pca = window['pca']
-    const key = window['addressCompleteKey']
-    if (!pca || !key) {
-      // eslint-disable-next-line no-console
-      console.log('AddressComplete not initialized due to missing script and/or key')
-      return
-    }
-
-    // Destroy the old object if it exists, and create a new one.
-    if (window['currentAddressComplete']) {
-      window['currentAddressComplete'].destroy()
-    }
-    window['currentAddressComplete'] = createAddressComplete(pca, key)
-  }
-  return {
-    addressCompletePopulate,
-    createAddressComplete,
-    enableAddressComplete,
-    uniqueIds
-  }
-}
-
-/**
- * Determines whether to use a country's known regions (ie, provinces/states).
- * @param code the short code of the country
- * @returns whether to use v-select (true) or v-text-field (false) for input
- */
-export function useCountryRegions (code: string): boolean {
-  return (code === 'CA' || code === 'US')
-}
-
-export function formatAddress (address: AddressIF): AddressIF {
-  let formattedPostalCode = address.postalCode?.toUpperCase() || ''
-  if (address.addressCountry === 'CA') {
-    formattedPostalCode = address.postalCode.replace('-', ' ')
-    if (address.postalCode.length > 4 && address.postalCode[3] !== ' ') {
-      formattedPostalCode = address.postalCode.slice(0, 3) + ' ' + address.postalCode.slice(3,)
-    }
-  }
-  return {
-    addressCity: address.addressCity?.trim(),
-    addressCountry: address.addressCountry?.trim(),
-    addressRegion: address.addressRegion?.trim(),
-    addressType: address.addressType?.trim(),
-    deliveryInstructions: address.deliveryInstruction?.trim(),
-    postalCode: formattedPostalCode.trim(),
-    streetAddress: address.streetAddress?.trim(),
-    streetAddressAdditional: address.streetAddressAdditional?.trim()
-  }
-}
-
-export function checkAddress (address: AddressIF, schema: SchemaIF): AddressIF {
-  for(var addressProperty in schema) {
-    if (!address[addressProperty]) {
-      address[addressProperty] = ''
-    }
-  }
-  return address
-}
+/* eslint-disable */
+import { computed, reactive, ref, Ref } from 'vue-demi'
+import { uniqueId } from 'lodash'
+
+import { AddressIF, SchemaIF } from '@bcrs-shared-components/interfaces'
+
+export function useAddress (address: Ref<AddressIF>, schema: SchemaIF) {
+  const addressLocal = address
+  /** The Address Country, to simplify the template and so we can watch it directly. */
+  const country = computed((): string => {
+    return addressLocal.value.addressCountry
+  })
+  const schemaLocal = ref(schema)
+  const isSchemaRequired = (prop: string): boolean => {
+    if (!schemaLocal || !schemaLocal.value[prop]) return false
+
+    // check for any rule that does not allow an empty string
+    for (let index in schemaLocal.value[prop]) {
+      if (schemaLocal.value[prop][index]('') !== true) return true
+    }
+    return false
+  }
+  const labels = {
+    /** The Street Address Additional label with 'optional' as needed. */
+    streetAdditionalLabel: computed((): string => {
+      return 'Address Line 2' + (isSchemaRequired('streetAdditional') ? '' : ' (Optional)')
+    }),
+    /** The Street Address label with 'optional' as needed. */
+    streetLabel: computed((): string => {
+      return 'Address Line 1' + (isSchemaRequired('street') ? '' : ' (Optional)')
+    }),
+    /** The Address City label with 'optional' as needed. */
+    cityLabel: computed((): string => {
+      return 'City' + (isSchemaRequired('city') ? '' : ' (Optional)')
+    }),
+    /** The Address Region label with 'optional' as needed. */
+    regionLabel: computed((): string => {
+      let label: string
+      let required = isSchemaRequired('region')
+
+      // NB: make region required for Canada and USA
+      if (addressLocal.value.addressCountry === 'CA') {
+        label = 'Province'
+        required = true
+      } else if (addressLocal.value.addressCountry === 'US') {
+        label = 'State'
+        required = true
+      } else {
+        label = 'Region'
+      }
+      return label + (required ? '' : ' (Optional)')
+    }),
+    /** The Postal Code label with 'optional' as needed. */
+    postalCodeLabel: computed((): string => {
+      let label: string
+      if (addressLocal.value.addressCountry === 'US') {
+        label = 'Zip Code'
+      } else {
+        label = 'Postal Code'
+      }
+      return label + (isSchemaRequired('postalCode') ? '' : ' (Optional)')
+    }),
+    /** The Address Country label with 'optional' as needed. */
+    countryLabel: computed((): string => {
+      return 'Country' + (isSchemaRequired('country') ? '' : ' (Optional)')
+    }),
+    /** The Delivery Instructions label with 'optional' as needed. */
+    deliveryInstructionsLabel: computed((): string => {
+      return 'Delivery Instructions' + (isSchemaRequired('deliveryInstructions') ? '' : ' (Optional)')
+    })
+  }
+  return {
+    addressLocal,
+    country,
+    schemaLocal,
+    isSchemaRequired,
+    labels
+  }
+}
+
+export function useAddressComplete (addressLocal: Ref<AddressIF>) {
+  const combineLines = (line1: string, line2: string) => {
+    if (!line1) return line2
+    if (!line2) return line1
+    return line1 + '\n' + line2
+  }
+  /**
+   * Callback to update the address data after the user chooses a suggested address.
+   * @param address the data object returned by the AddressComplete Retrieve API
+   */
+  const addressCompletePopulate = (addressComplete: object): void => {
+    addressLocal.value.streetAddress = addressComplete['Line1'] || 'N/A'
+    // Combine extra address lines into Street Address Additional field.
+    addressLocal.value.streetAddressAdditional = combineLines(
+      combineLines(addressComplete['Line2'], addressComplete['Line3']),
+      combineLines(addressComplete['Line4'], addressComplete['Line5'])
+    )
+    addressLocal.value.addressCity = addressComplete['City']
+    if (useCountryRegions(addressComplete['CountryIso2'])) {
+      // In this case, v-select will map known province code to province name
+      // or v-select will be blank and user will have to select a known item.
+      addressLocal.value.addressRegion = addressComplete['ProvinceCode']
+    } else {
+      // In this case, v-text-input will allow manual entry but province info is probably too long
+      // so set region to null and add province name to the Street Address Additional field.
+      // If length is excessive, user will have to fix it.
+      addressLocal.value.addressRegion = ''
+      addressLocal.value.streetAddressAdditional = combineLines(
+        addressLocal.value.streetAddressAdditional, addressComplete['ProvinceName']
+      )
+    }
+    addressLocal.value.postalCode = addressComplete['PostalCode']
+    addressLocal.value.addressCountry = addressComplete['CountryIso2']
+  }
+  const uniqueIds = reactive({
+    /** A unique id for this instance of this component. */
+    uniqueId: uniqueId(),
+    /** A unique id for the Street Address input. */
+    streetId: computed((): string => {
+      return `street-address-${uniqueIds.uniqueId}`
+    }),
+    /** A unique id for the Address Country input. */
+    countryId: computed((): string => {
+      return `address-country-${uniqueIds.uniqueId}`
+    })
+  })
+  /**
+   * Creates the AddressComplete object for this instance of the component.
+   * @param pca the Postal Code Anywhere object provided by AddressComplete
+   * @param key the key for the Canada Post account that is to be charged for lookups
+   * @returns an object that is a pca.Address instance
+   */
+  const createAddressComplete = (pca: any, key: string): object => {
+    // Set up the two fields that AddressComplete will use for input.
+    // Ref: https://www.canadapost.ca/pca/support/guides/advanced
+    // Note: Use special field for country, which user can't click, and which AC will overwrite
+    //       but that we don't care about.
+    const fields = [
+      { element: uniqueIds.streetId, field: 'Line1', mode: pca.fieldMode.SEARCH },
+      { element: uniqueIds.countryId, field: 'CountryName', mode: pca.fieldMode.COUNTRY }
+    ]
+    const options = { key }
+
+    const addressComplete = new pca.Address(fields, options)
+
+    // The documentation contains sample load/populate callback code that doesn't work, but this will. The side effect
+    // is that it breaks the autofill functionality provided by the library, but we really don't want the library
+    // altering the DOM because Vue is already doing so, and the two don't play well together.
+    addressComplete.listen('populate', addressCompletePopulate)
+
+    return addressComplete
+  }
+  /** Enables AddressComplete for this instance of the address. */
+  const enableAddressComplete = (): void => {
+    // If you want to use this component with the Canada Post AddressComplete service:
+    // 1. The AddressComplete JavaScript script (and stylesheet) must be loaded.
+    // 2. Your AddressComplete account key must be defined.
+    const pca = window['pca']
+    const key = window['addressCompleteKey']
+    if (!pca || !key) {
+      // eslint-disable-next-line no-console
+      console.log('AddressComplete not initialized due to missing script and/or key')
+      return
+    }
+
+    // Destroy the old object if it exists, and create a new one.
+    if (window['currentAddressComplete']) {
+      window['currentAddressComplete'].destroy()
+    }
+    window['currentAddressComplete'] = createAddressComplete(pca, key)
+  }
+  return {
+    addressCompletePopulate,
+    createAddressComplete,
+    enableAddressComplete,
+    uniqueIds
+  }
+}
+
+/**
+ * Determines whether to use a country's known regions (ie, provinces/states).
+ * @param code the short code of the country
+ * @returns whether to use v-select (true) or v-text-field (false) for input
+ */
+export function useCountryRegions (code: string): boolean {
+  return (code === 'CA' || code === 'US')
+}
+
+export function formatAddress (address: AddressIF): AddressIF {
+  let formattedPostalCode = address.postalCode?.toUpperCase() || ''
+  if (address.addressCountry === 'CA') {
+    formattedPostalCode = address.postalCode.replace('-', ' ')
+    if (address.postalCode.length > 4 && address.postalCode[3] !== ' ') {
+      formattedPostalCode = address.postalCode.slice(0, 3) + ' ' + address.postalCode.slice(3,)
+    }
+  }
+  return {
+    addressCity: address.addressCity?.trim(),
+    addressCountry: address.addressCountry?.trim(),
+    addressRegion: address.addressRegion?.trim(),
+    addressType: address.addressType?.trim(),
+    deliveryInstructions: address.deliveryInstruction?.trim(),
+    postalCode: formattedPostalCode.trim(),
+    streetAddress: address.streetAddress?.trim(),
+    streetAddressAdditional: address.streetAddressAdditional?.trim()
+  }
+}
+
+export function checkAddress (address: AddressIF, schema: SchemaIF): AddressIF {
+  for(var addressProperty in schema) {
+    if (!address[addressProperty]) {
+      address[addressProperty] = ''
+    }
+  }
+  return address
+}

package/factories/countries-provinces-factory.ts

@@ -1,78 +1,78 @@
-import countriesData from 'country-list/data.json'
-import provincesData from 'provinces/provinces.json'
-
-window['countries'] = window['countries'] || countriesData.sort((a, b) =>
-  (a.name < b.name) ? -1 : (a.name > b.name) ? 1 : 0)
-
-window['provinces'] = window['provinces'] || provincesData.sort((a, b) =>
-  (a.name < b.name) ? -1 : (a.name > b.name) ? 1 : 0)
-
-// global caching to improve performance when called multiple times
-window['countryNameCache'] = {}
-window['countryRegionsCache'] = {}
-
-/**
- * Factory that allows VM access to useful country/province data and functions.
- * @link https://www.npmjs.com/package/country-list
- * @lint https://www.npmjs.com/package/provinces
- */
-export function useCountriesProvinces () {
-  /**
-   * Helper function to return a list of countries.
-   * @returns An array of country objects, sorted alphabetically.
-   */
-  const getCountries = (naOnly = false): Array<object> => {
-    let countries = []
-    countries.push({ code: 'CA', name: 'Canada' })
-    countries.push({ code: 'US', name: 'United States' })
-    if (!naOnly) {
-      // name is set this way to ensure the divider is there in the search when CA/US are not the only options
-      countries.push({ code: '0', name: 'Can.nada. United States .Of.America', divider: true })
-      countries = countries.concat(window['countries'])
-    }
-    return countries
-  }
-  /**
-   * Helper function to return a country's name.
-   * @param code The short code of the country.
-   * @returns The long name of the country.
-   */
-  const getCountryName = (code: string): string => {
-    if (!code) return null
-    if (window['countryNameCache'][code]) return window['countryNameCache'][code]
-    const country = window['countries'].find(c => c.code === code)
-    const result = country ? country.name : null
-    window['countryNameCache'][code] = result
-    return result
-  }
-  /**
-   * Helper function to return a country's list of provinces.
-   * @param code The short code of the country.
-   * @param overrideDefault A flag to bypass manual defaults.
-   * @returns An array of province objects, sorted alphabetically.
-   */
-  const getCountryRegions = (code: string, overrideDefault = false): Array<object> => {
-    if (!code) return []
-    if (window['countryRegionsCache'][code]) return window['countryRegionsCache'][code]
-    let regions = []
-    if (code === 'CA' && !overrideDefault) {
-      regions.push({ name: 'British Columbia', short: 'BC' })
-      // name is set this way to ensure the divider is there in the search when BC is not the only option
-      regions.push({ code: '0', name: 'Br.it.is.h.Co.l.u.m.b.ia', divider: true })
-    }
-    const result = window['provinces']
-      .filter(p => p.country === code)
-      .map(p => ({
-        name: p.english || p.name,
-        short: (p.short && p.short.length <= 2) ? p.short : '--'
-      }))
-    regions = regions.concat(result)
-    window['countryRegionsCache'][code] = regions
-    return regions
-  }
-  return {
-    getCountries,
-    getCountryName,
-    getCountryRegions
-  }
-}
+import countriesData from 'country-list/data.json'
+import provincesData from 'provinces/provinces.json'
+
+window['countries'] = window['countries'] || countriesData.sort((a, b) =>
+  (a.name < b.name) ? -1 : (a.name > b.name) ? 1 : 0)
+
+window['provinces'] = window['provinces'] || provincesData.sort((a, b) =>
+  (a.name < b.name) ? -1 : (a.name > b.name) ? 1 : 0)
+
+// global caching to improve performance when called multiple times
+window['countryNameCache'] = {}
+window['countryRegionsCache'] = {}
+
+/**
+ * Factory that allows VM access to useful country/province data and functions.
+ * @link https://www.npmjs.com/package/country-list
+ * @lint https://www.npmjs.com/package/provinces
+ */
+export function useCountriesProvinces () {
+  /**
+   * Helper function to return a list of countries.
+   * @returns An array of country objects, sorted alphabetically.
+   */
+  const getCountries = (naOnly = false): Array<object> => {
+    let countries = []
+    countries.push({ code: 'CA', name: 'Canada' })
+    countries.push({ code: 'US', name: 'United States' })
+    if (!naOnly) {
+      // name is set this way to ensure the divider is there in the search when CA/US are not the only options
+      countries.push({ code: '0', name: 'Can.nada. United States .Of.America', divider: true })
+      countries = countries.concat(window['countries'])
+    }
+    return countries
+  }
+  /**
+   * Helper function to return a country's name.
+   * @param code The short code of the country.
+   * @returns The long name of the country.
+   */
+  const getCountryName = (code: string): string => {
+    if (!code) return null
+    if (window['countryNameCache'][code]) return window['countryNameCache'][code]
+    const country = window['countries'].find(c => c.code === code)
+    const result = country ? country.name : null
+    window['countryNameCache'][code] = result
+    return result
+  }
+  /**
+   * Helper function to return a country's list of provinces.
+   * @param code The short code of the country.
+   * @param overrideDefault A flag to bypass manual defaults.
+   * @returns An array of province objects, sorted alphabetically.
+   */
+  const getCountryRegions = (code: string, overrideDefault = false): Array<object> => {
+    if (!code) return []
+    if (window['countryRegionsCache'][code]) return window['countryRegionsCache'][code]
+    let regions = []
+    if (code === 'CA' && !overrideDefault) {
+      regions.push({ name: 'British Columbia', short: 'BC' })
+      // name is set this way to ensure the divider is there in the search when BC is not the only option
+      regions.push({ code: '0', name: 'Br.it.is.h.Co.l.u.m.b.ia', divider: true })
+    }
+    const result = window['provinces']
+      .filter(p => p.country === code)
+      .map(p => ({
+        name: p.english || p.name,
+        short: (p.short && p.short.length <= 2) ? p.short : '--'
+      }))
+    regions = regions.concat(result)
+    window['countryRegionsCache'][code] = regions
+    return regions
+  }
+  return {
+    getCountries,
+    getCountryName,
+    getCountryRegions
+  }
+}

package/factories/index.ts

@@ -1,3 +1,3 @@
-export { formatAddress, useAddress, useAddressComplete, useCountryRegions } from './address-factory'
-export { useCountriesProvinces } from './countries-provinces-factory'
-export { baseRules, spaceRules, useBaseValidations } from './validation-factory'
+export { formatAddress, useAddress, useAddressComplete, useCountryRegions } from './address-factory'
+export { useCountriesProvinces } from './countries-provinces-factory'
+export { baseRules, spaceRules, useBaseValidations } from './validation-factory'