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

package/factories/validation-factory.ts

@@ -1,42 +1,42 @@
-import { ref } from 'vue-demi'
-
-import { AddressValidationRules } from '@bcrs-shared-components/enums'
-
-/* Sets up form validation functions */
-export function useBaseValidations () {
-  /* this variable must be named the same as your ref=___ in your form */
-  const addressForm = ref(null)
-  const resetValidation = () => {
-    addressForm.value?.resetValidation()
-  }
-  const validate = () => {
-    addressForm.value?.validate()
-  }
-  return { addressForm, resetValidation, validate }
-}
-
-/* Rules used in most schemas */
-export const baseRules = {
-  [AddressValidationRules.BC]: (v: string) => v === 'BC' || v === 'British Columbia' || 'Address must be in BC',
-  [AddressValidationRules.CANADA]: (v: string) => v === 'CA' || 'Address must be in Canada',
-  [AddressValidationRules.MAX_LENGTH]: (max: number) => {
-    return (v: string) => (v || '').length <= max || `Maximum ${max} characters`
-  },
-  [AddressValidationRules.MIN_LENGTH]: (min: number) => {
-    return (v: string) => (v || '').length >= min || `Minimum ${min} characters`
-  },
-  [AddressValidationRules.POSTAL_CODE]: (v: string) => (
-    /^\s*[ABCEGHJ-NPRSTVXY]\d[ABCEGHJ-NPRSTV-Z][\s-]?\d[ABCEGHJ-NPRSTV-Z]\d\s*$/i.test(v) ||
-    'Must be a valid postal code'
-  ),
-  [AddressValidationRules.REQUIRED]: (v: string) => v?.length > 0 || 'This field is required',
-  [AddressValidationRules.ZIP_CODE]: (v: string) => (
-    /^\s*[0-9]{5}([\s-]?[0-9]{4})?\s*$/i.test(v) ||
-    'Must be a valid zip code'
-  )
-}
-
-/* Array of validation rules used by input elements to prevent extra whitespace. */
-export const spaceRules = [
-  (v: string) => !/^\s/g.test(v) || 'Invalid spaces' // leading spaces
-]
+import { ref } from 'vue-demi'
+
+import { AddressValidationRules } from '@bcrs-shared-components/enums'
+
+/* Sets up form validation functions */
+export function useBaseValidations () {
+  /* this variable must be named the same as your ref=___ in your form */
+  const addressForm = ref(null)
+  const resetValidation = () => {
+    addressForm.value?.resetValidation()
+  }
+  const validate = () => {
+    addressForm.value?.validate()
+  }
+  return { addressForm, resetValidation, validate }
+}
+
+/* Rules used in most schemas */
+export const baseRules = {
+  [AddressValidationRules.BC]: (v: string) => v === 'BC' || v === 'British Columbia' || 'Address must be in BC',
+  [AddressValidationRules.CANADA]: (v: string) => v === 'CA' || 'Address must be in Canada',
+  [AddressValidationRules.MAX_LENGTH]: (max: number) => {
+    return (v: string) => (v || '').length <= max || `Maximum ${max} characters`
+  },
+  [AddressValidationRules.MIN_LENGTH]: (min: number) => {
+    return (v: string) => (v || '').length >= min || `Minimum ${min} characters`
+  },
+  [AddressValidationRules.POSTAL_CODE]: (v: string) => (
+    /^\s*[ABCEGHJ-NPRSTVXY]\d[ABCEGHJ-NPRSTV-Z][\s-]?\d[ABCEGHJ-NPRSTV-Z]\d\s*$/i.test(v) ||
+    'Must be a valid postal code'
+  ),
+  [AddressValidationRules.REQUIRED]: (v: string) => v?.length > 0 || 'This field is required',
+  [AddressValidationRules.ZIP_CODE]: (v: string) => (
+    /^\s*[0-9]{5}([\s-]?[0-9]{4})?\s*$/i.test(v) ||
+    'Must be a valid zip code'
+  )
+}
+
+/* Array of validation rules used by input elements to prevent extra whitespace. */
+export const spaceRules = [
+  (v: string) => !/^\s/g.test(v) || 'Invalid spaces' // leading spaces
+]

package/factories/vuelidate-validation-factory.ts

@@ -1,118 +1,118 @@
-/* FUTURE:
- * Delete this if we decide not to move forward with vuelidate
- * Fix it to work otherwise
- */
-import { computed, Ref, reactive } from 'vue-demi'
-
-import { AddressIF, SchemaIF } from '@bcrs-shared-components/interfaces'
-
-import useVuelidate from '@vuelidate/core'
-
-export function useValidations (schema: Ref<SchemaIF>, address: Ref<AddressIF>) {
-  const validations = reactive({ addressLocal: schema.value })
-  const $v = useVuelidate(validations, reactive({ addressLocal: address.value }))
-
-  /**
-   * Misc Vuetify rules.
-   * @param prop The name of the property object to validate.
-   * @param key The name of the property key (field) to validate.
-   * @returns True if the rule passes, otherwise an error string.
-   */
-  const vuetifyRules = {
-    requiredRule: (prop: string, key: string): boolean | string => {
-      return Boolean($v.value[prop] && !$v.value[prop][key].required.$invalid) || 'This field is required'
-    },
-    minLengthRule: (prop: string, key: string): boolean | string => {
-      const min = validations.addressLocal[key].max
-      const msg = min ? `Minimum length is ${min}` : 'Text is below minimum length'
-      return Boolean($v.value[prop] && !$v.value[prop][key].minLength.$invalid) || msg
-    },
-    maxLengthRule: (prop: string, key: string): boolean | string => {
-      const max = validations.addressLocal[key].max
-      const msg = max ? `Maximum length is ${max}` : 'Text is over maximum length'
-      return Boolean($v.value[prop] && !$v.value[prop][key].maxLength.$invalid) || msg
-    },
-    // FUTURE: generalize this rule to take a validation parameter (ie, 'CA')
-    isCanadaRule: (prop: string, key: string): boolean | string => {
-      return Boolean($v.value[prop] && !$v.value[prop][key].isCanada.$invalid) || 'Address must be in Canada'
-    },
-    // FUTURE: generalize this rule to take a validation parameter (ie, 'BC')
-    isBCRule: (prop: string, key: string): boolean | string => {
-      return Boolean($v.value[prop] && !$v.value[prop][key].isBC.$invalid) || 'Address must be in BC'
-    }
-  }
-
-  /**
-   * Creates a Vuetify rules object from the Vuelidate state.
-   * @param model The name of the model we are validating.
-   * @returns A Vuetify rules object.
-   */
-  const createVuetifyRulesObject = (model: string): { [attr: string]: Array<Function> } => {
-    const obj = {
-      street: [],
-      streetAdditional: [],
-      city: [],
-      region: [],
-      postalCode: [],
-      country: [],
-      deliveryInstructions: []
-    }
-
-    // ensure Vuelidate state object is initialized
-    if ($v && $v.value[model]) {
-      // iterate over Vuelidate object properties
-      Object.keys($v.value[model])
-        // only look at validation properties
-        .filter(prop => prop.charAt(0) !== '$')
-        .forEach(prop => {
-          // create array for each validation property
-          obj[prop] = []
-          // iterate over validation property params
-          Object.keys($v.value[model][prop])
-            .forEach(param => {
-              // add specified validation functions to array
-              switch (param) {
-                case 'required': obj[prop].push(() => vuetifyRules.requiredRule(model, prop)); break
-                case 'minLength': obj[prop].push(() => vuetifyRules.minLengthRule(model, prop)); break
-                case 'maxLength': obj[prop].push(() => vuetifyRules.maxLengthRule(model, prop)); break
-                case 'isCanada': obj[prop].push(() => vuetifyRules.isCanadaRule(model, prop)); break
-                case 'isBC': obj[prop].push(() => vuetifyRules.isBCRule(model, prop)); break
-                // FUTURE: add extra validation functions here
-                default: break
-              }
-            })
-        })
-    }
-
-    // sample return object
-    // street: [
-    //   () => this.requiredRule('addressLocal', 'street'),
-    //   () => this.minLengthRule('addressLocal', 'street'),
-    //   () => this.maxLengthRule('addressLocal', 'street')
-    // ],
-    // ...
-
-    return obj
-  }
-
-  /**
-   * The Vuetify rules object. Used to display any validation errors/styling.
-   * NB: As a getter, this is initialized between created() and mounted().
-   * @returns the Vuetify validation rules object
-   */
-  const rules = computed((): { [attr: string]: Array<Function> } => {
-    return createVuetifyRulesObject('addressLocal')
-  })
-
-  /** Array of validation rules used by input elements to prevent extra whitespace. */
-  const spaceRules = [
-    (v: string) => !/^\s/g.test(v) || 'Invalid spaces', // leading spaces
-    (v: string) => !/\s$/g.test(v) || 'Invalid spaces', // trailing spaces
-    (v: string) => !/\s\s/g.test(v) || 'Invalid word spacing' // multiple inline spaces
-  ]
-  return {
-    $v,
-    rules,
-    spaceRules
-  }
-}
+/* FUTURE:
+ * Delete this if we decide not to move forward with vuelidate
+ * Fix it to work otherwise
+ */
+import { computed, Ref, reactive } from 'vue-demi'
+
+import { AddressIF, SchemaIF } from '@bcrs-shared-components/interfaces'
+
+import useVuelidate from '@vuelidate/core'
+
+export function useValidations (schema: Ref<SchemaIF>, address: Ref<AddressIF>) {
+  const validations = reactive({ addressLocal: schema.value })
+  const $v = useVuelidate(validations, reactive({ addressLocal: address.value }))
+
+  /**
+   * Misc Vuetify rules.
+   * @param prop The name of the property object to validate.
+   * @param key The name of the property key (field) to validate.
+   * @returns True if the rule passes, otherwise an error string.
+   */
+  const vuetifyRules = {
+    requiredRule: (prop: string, key: string): boolean | string => {
+      return Boolean($v.value[prop] && !$v.value[prop][key].required.$invalid) || 'This field is required'
+    },
+    minLengthRule: (prop: string, key: string): boolean | string => {
+      const min = validations.addressLocal[key].max
+      const msg = min ? `Minimum length is ${min}` : 'Text is below minimum length'
+      return Boolean($v.value[prop] && !$v.value[prop][key].minLength.$invalid) || msg
+    },
+    maxLengthRule: (prop: string, key: string): boolean | string => {
+      const max = validations.addressLocal[key].max
+      const msg = max ? `Maximum length is ${max}` : 'Text is over maximum length'
+      return Boolean($v.value[prop] && !$v.value[prop][key].maxLength.$invalid) || msg
+    },
+    // FUTURE: generalize this rule to take a validation parameter (ie, 'CA')
+    isCanadaRule: (prop: string, key: string): boolean | string => {
+      return Boolean($v.value[prop] && !$v.value[prop][key].isCanada.$invalid) || 'Address must be in Canada'
+    },
+    // FUTURE: generalize this rule to take a validation parameter (ie, 'BC')
+    isBCRule: (prop: string, key: string): boolean | string => {
+      return Boolean($v.value[prop] && !$v.value[prop][key].isBC.$invalid) || 'Address must be in BC'
+    }
+  }
+
+  /**
+   * Creates a Vuetify rules object from the Vuelidate state.
+   * @param model The name of the model we are validating.
+   * @returns A Vuetify rules object.
+   */
+  const createVuetifyRulesObject = (model: string): { [attr: string]: Array<Function> } => {
+    const obj = {
+      street: [],
+      streetAdditional: [],
+      city: [],
+      region: [],
+      postalCode: [],
+      country: [],
+      deliveryInstructions: []
+    }
+
+    // ensure Vuelidate state object is initialized
+    if ($v && $v.value[model]) {
+      // iterate over Vuelidate object properties
+      Object.keys($v.value[model])
+        // only look at validation properties
+        .filter(prop => prop.charAt(0) !== '$')
+        .forEach(prop => {
+          // create array for each validation property
+          obj[prop] = []
+          // iterate over validation property params
+          Object.keys($v.value[model][prop])
+            .forEach(param => {
+              // add specified validation functions to array
+              switch (param) {
+                case 'required': obj[prop].push(() => vuetifyRules.requiredRule(model, prop)); break
+                case 'minLength': obj[prop].push(() => vuetifyRules.minLengthRule(model, prop)); break
+                case 'maxLength': obj[prop].push(() => vuetifyRules.maxLengthRule(model, prop)); break
+                case 'isCanada': obj[prop].push(() => vuetifyRules.isCanadaRule(model, prop)); break
+                case 'isBC': obj[prop].push(() => vuetifyRules.isBCRule(model, prop)); break
+                // FUTURE: add extra validation functions here
+                default: break
+              }
+            })
+        })
+    }
+
+    // sample return object
+    // street: [
+    //   () => this.requiredRule('addressLocal', 'street'),
+    //   () => this.minLengthRule('addressLocal', 'street'),
+    //   () => this.maxLengthRule('addressLocal', 'street')
+    // ],
+    // ...
+
+    return obj
+  }
+
+  /**
+   * The Vuetify rules object. Used to display any validation errors/styling.
+   * NB: As a getter, this is initialized between created() and mounted().
+   * @returns the Vuetify validation rules object
+   */
+  const rules = computed((): { [attr: string]: Array<Function> } => {
+    return createVuetifyRulesObject('addressLocal')
+  })
+
+  /** Array of validation rules used by input elements to prevent extra whitespace. */
+  const spaceRules = [
+    (v: string) => !/^\s/g.test(v) || 'Invalid spaces', // leading spaces
+    (v: string) => !/\s$/g.test(v) || 'Invalid spaces', // trailing spaces
+    (v: string) => !/\s\s/g.test(v) || 'Invalid word spacing' // multiple inline spaces
+  ]
+  return {
+    $v,
+    rules,
+    spaceRules
+  }
+}

package/index.ts

@@ -1 +1 @@
-export { default as BaseAddress } from './BaseAddress.vue'
+export { default as BaseAddress } from './BaseAddress.vue'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bcrs-shared-components/base-address",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "publishConfig": {
     "access": "public"
   },
@@ -17,5 +17,5 @@
     "vue-property-decorator": "^9.1.2",
     "vuelidate-property-decorators": "1.0.28"
   },
-  "gitHead": "5f3b43cd73175662b749d8831ed3b207b3fe44fa"
+  "gitHead": "d80832aa4a621fdabf26d3e1d479f0701cf50fad"
 }

package/resources/default-schema.ts

@@ -1,42 +1,42 @@
-import { AddressValidationRules } from '@bcrs-shared-components/enums'
-import { SchemaIF } from '@bcrs-shared-components/interfaces'
-import { baseRules, spaceRules } from '../factories/validation-factory'
-
-/* example of what to pass in for the schema */
-export const DefaultSchema: SchemaIF = {
-  street: [
-    baseRules[AddressValidationRules.REQUIRED],
-    baseRules[AddressValidationRules.MAX_LENGTH](50),
-    ...spaceRules
-  ],
-  streetAdditional: [
-    baseRules[AddressValidationRules.MAX_LENGTH](50),
-    ...spaceRules
-  ],
-  city: [
-    baseRules[AddressValidationRules.REQUIRED],
-    baseRules[AddressValidationRules.MAX_LENGTH](40),
-    ...spaceRules
-  ],
-  country: [
-    baseRules[AddressValidationRules.REQUIRED],
-    ...spaceRules
-  ],
-  region: [
-    baseRules[AddressValidationRules.REQUIRED],
-    ...spaceRules
-  ],
-  /* NOTE: Canada/US postal code and zip code regex rules
-   * are added automatically as extra rules based on country
-   * inside the address components
-   */
-  postalCode: [
-    baseRules[AddressValidationRules.REQUIRED],
-    baseRules[AddressValidationRules.MAX_LENGTH](15),
-    ...spaceRules
-  ],
-  deliveryInstructions: [
-    baseRules[AddressValidationRules.MAX_LENGTH](80),
-    ...spaceRules
-  ]
-}
+import { AddressValidationRules } from '@bcrs-shared-components/enums'
+import { SchemaIF } from '@bcrs-shared-components/interfaces'
+import { baseRules, spaceRules } from '../factories/validation-factory'
+
+/* example of what to pass in for the schema */
+export const DefaultSchema: SchemaIF = {
+  street: [
+    baseRules[AddressValidationRules.REQUIRED],
+    baseRules[AddressValidationRules.MAX_LENGTH](50),
+    ...spaceRules
+  ],
+  streetAdditional: [
+    baseRules[AddressValidationRules.MAX_LENGTH](50),
+    ...spaceRules
+  ],
+  city: [
+    baseRules[AddressValidationRules.REQUIRED],
+    baseRules[AddressValidationRules.MAX_LENGTH](40),
+    ...spaceRules
+  ],
+  country: [
+    baseRules[AddressValidationRules.REQUIRED],
+    ...spaceRules
+  ],
+  region: [
+    baseRules[AddressValidationRules.REQUIRED],
+    ...spaceRules
+  ],
+  /* NOTE: Canada/US postal code and zip code regex rules
+   * are added automatically as extra rules based on country
+   * inside the address components
+   */
+  postalCode: [
+    baseRules[AddressValidationRules.REQUIRED],
+    baseRules[AddressValidationRules.MAX_LENGTH](15),
+    ...spaceRules
+  ],
+  deliveryInstructions: [
+    baseRules[AddressValidationRules.MAX_LENGTH](80),
+    ...spaceRules
+  ]
+}

package/resources/index.ts

@@ -1 +1 @@
-export { DefaultSchema } from './default-schema'
+export { DefaultSchema } from './default-schema'