feat: use street address templates from locales (#754)

src/address.ts

@@ -206,6 +206,20 @@ export class Address {
     );
   }
 
+  /**
+   * Generates a random building number.
+   *
+   * @example
+   * faker.address.buildingNumber() // '379'
+   */
+  buildingNumber(): string {
+    const format = this.faker.random.arrayElement(
+      this.faker.definitions.address.building_number
+    );
+
+    return this.faker.helpers.replaceSymbolWithNumber(format);
+  }
+
   /**
    * Generates a random localized street name.
    *
@@ -242,30 +256,10 @@ export class Address {
    * faker.address.streetAddress(false) // '34830 Erdman Hollow'
    */
   streetAddress(useFullAddress: boolean = false): string {
-    let address = '';
-    switch (this.faker.datatype.number(2)) {
-      case 0:
-        address =
-          this.faker.helpers.replaceSymbolWithNumber('#####') +
-          ' ' +
-          this.faker.address.streetName();
-        break;
-      case 1:
-        address =
-          this.faker.helpers.replaceSymbolWithNumber('####') +
-          ' ' +
-          this.faker.address.streetName();
-        break;
-      case 2:
-        address =
-          this.faker.helpers.replaceSymbolWithNumber('###') +
-          ' ' +
-          this.faker.address.streetName();
-        break;
-    }
-    return useFullAddress
-      ? address + ' ' + this.faker.address.secondaryAddress()
-      : address;
+    const formats = this.faker.definitions.address.street_address;
+    const format = formats[useFullAddress ? 'full' : 'normal'];
+
+    return this.faker.fake(format);
   }
 
   /**
@@ -293,7 +287,8 @@ export class Address {
   }
 
   /**
-   * Generates a random localized secondary address.
+   * Generates a random localized secondary address. This refers to a specific location at a given address
+   * such as an apartment or room number.
    *
    * @example
    * faker.address.secondaryAddress() // 'Apt. 861'

src/definitions/address.ts

@@ -54,6 +54,11 @@ export interface AddressDefinitions {
    */
   direction_abbr: string[];
 
+  /**
+   * The pattern used to generate building numbers.
+   */
+  building_number: string[];
+
   /**
    * Common street prefixes
    */
@@ -63,6 +68,20 @@ export interface AddressDefinitions {
    */
   street_suffix: string[];
 
+  /**
+   * The pattern used to generate street addresses.
+   */
+  street_address: {
+    /**
+     * The fake pattern to generate only the street address.
+     */
+    normal: string;
+    /**
+     * The fake pattern to generate the full street address including the secondary address.
+     */
+    full: string;
+  };
+
   /**
    * The address "inside" an address/e.g. an apartment or office.
    */
@@ -100,9 +119,12 @@ export const ADDRESS = allOf<keyof AddressDefinitions>()(
   'direction_abbr',
   'direction',
 
+  'building_number',
+
   'street_prefix',
   'street_suffix',
 
+  'street_address',
   'secondary_address',
 
   'country_code',

src/locales/ar/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{building_number} #{street_name}'];
+export default {
+  normal: '{{address.buildingNumber}} {{address.streetName}}',
+  full: '{{address.buildingNumber}} {{address.streetName}} {{address.secondaryAddress}}',
+};

src/locales/az/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name}, #{building_number}'];
+export default {
+  normal: '{{address.streetName}}, {{address.buildingNumber}}',
+  full: '{{address.streetName}}, {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/cz/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name} #{building_number}'];
+export default {
+  normal: '{{address.streetName}} {{address.buildingNumber}}',
+  full: '{{address.streetName}} {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/de/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name} #{building_number}'];
+export default {
+  normal: '{{address.streetName}} {{address.buildingNumber}}',
+  full: '{{address.streetName}} {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/de_AT/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name} #{building_number}'];
+export default {
+  normal: '{{address.streetName}} {{address.buildingNumber}}',
+  full: '{{address.streetName}} {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/en/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{building_number} #{street_name}'];
+export default {
+  normal: '{{address.buildingNumber}} {{address.streetName}}',
+  full: '{{address.buildingNumber}} {{address.streetName}} {{address.secondaryAddress}}',
+};

src/locales/en_GH/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{building_number} #{street_name}'];
+export default {
+  normal: '{{address.buildingNumber}} {{address.streetName}}',
+  full: '{{address.buildingNumber}} {{address.streetName}} {{address.secondaryAddress}}',
+};

src/locales/es/address/street_address.ts

@@ -1,4 +1,4 @@
-export default [
-  '#{street_name}#{building_number}',
-  '#{street_name}#{building_number} #{secondary_address}',
-];
+export default {
+  normal: '{{address.streetName}}{{address.buildingNumber}}',
+  full: '{{address.streetName}}{{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/es_MX/address/street_address.ts

@@ -1,4 +1,4 @@
-export default [
-  '#{street_name}#{building_number}',
-  '#{street_name}#{building_number} #{secondary_address}',
-];
+export default {
+  normal: '{{address.streetName}}{{address.buildingNumber}}',
+  full: '{{address.streetName}}{{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/fa/address/street_address.ts

@@ -1,4 +1,4 @@
-export default [
-  '#{street_name}, پلاک #{building_number}',
-  '#{street_name}, #{street_name}, پلاک #{building_number}',
-];
+export default {
+  normal: '{{address.streetName}}, پلاک {{address.buildingNumber}}',
+  full: '{{address.streetName}}, پلاک {{address.buildingNumber}}  {{address.secondaryAddress}}',
+};

src/locales/fr/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{building_number} #{street_name}'];
+export default {
+  normal: '{{address.buildingNumber}} {{address.streetName}}',
+  full: '{{address.buildingNumber}} {{address.streetName}} {{address.secondaryAddress}}',
+};

src/locales/fr_BE/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name} #{building_number}'];
+export default {
+  normal: '{{address.streetName}} {{address.buildingNumber}}',
+  full: '{{address.streetName}} {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/ge/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name} #{building_number}'];
+export default {
+  normal: '{{address.streetName}} {{address.buildingNumber}}',
+  full: '{{address.streetName}} {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/he/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{building_number} #{street_name}'];
+export default {
+  normal: '{{address.buildingNumber}} {{address.streetName}}',
+  full: '{{address.buildingNumber}} {{address.streetName}} {{address.secondaryAddress}}',
+};

src/locales/hr/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name} #{building_number}'];
+export default {
+  normal: '{{address.streetName}} {{address.buildingNumber}}',
+  full: '{{address.streetName}} {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/hy/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{address.street_name} #{address.building_number}'];
+export default {
+  normal: '{{address.streetName}} {{address.buildingNumber}}',
+  full: '{{address.streetName}} {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/id_ID/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name} no #{building_number}'];
+export default {
+  normal: '{{address.streetName}} no {{address.buildingNumber}}',
+  full: '{{address.streetName}} no {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/it/address/street_address.ts

@@ -1,4 +1,4 @@
-export default [
-  '#{street_name} #{building_number}',
-  '#{street_name} #{building_number}, #{secondary_address}',
-];
+export default {
+  normal: '{{address.streetName}} {{address.buildingNumber}}',
+  full: '{{address.streetName}} {{address.buildingNumber}}, {{address.secondaryAddress}}',
+};

src/locales/lv/address/street_address.ts

@@ -1,4 +1,4 @@
-export default [
-  '#{street_name} #{building_number}',
-  '#{street_name} #{building_number} #{secondary_address}',
-];
+export default {
+  normal: '{{address.streetName}} {{address.buildingNumber}}',
+  full: '{{address.streetName}} {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/mk/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name} #{building_number}'];
+export default {
+  normal: '{{address.streetName}} {{address.buildingNumber}}',
+  full: '{{address.streetName}} {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/nb_NO/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name} #{building_number}'];
+export default {
+  normal: '{{address.streetName}} {{address.buildingNumber}}',
+  full: '{{address.streetName}} {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/nl/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name} #{building_number}'];
+export default {
+  normal: '{{address.streetName}} {{address.buildingNumber}}',
+  full: '{{address.streetName}} {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/nl_BE/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name} #{building_number}'];
+export default {
+  normal: '{{address.streetName}} {{address.buildingNumber}}',
+  full: '{{address.streetName}} {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/pl/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name} #{building_number}'];
+export default {
+  normal: '{{address.streetName}} {{address.buildingNumber}}',
+  full: '{{address.streetName}} {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/pt_PT/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name} #{building_number}'];
+export default {
+  normal: '{{address.streetName}} {{address.buildingNumber}}',
+  full: '{{address.streetName}} {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/ro/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name}, #{building_number}, #{secondary_address}'];
+export default {
+  normal: '{{address.streetName}}, {{address.buildingNumber}}',
+  full: '{{address.streetName}}, {{address.buildingNumber}}, {{address.secondaryAddress}}',
+};

src/locales/ru/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name}, #{building_number}'];
+export default {
+  normal: '{{address.streetName}}, {{address.buildingNumber}}',
+  full: '{{address.streetName}}, {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/sk/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name} #{building_number}'];
+export default {
+  normal: '{{address.streetName}} {{address.buildingNumber}}',
+  full: '{{address.streetName}} {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/sv/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name} #{building_number}'];
+export default {
+  normal: '{{address.streetName}} {{address.buildingNumber}}',
+  full: '{{address.streetName}} {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/tr/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name} #{building_number}'];
+export default {
+  normal: '{{address.streetName}} {{address.buildingNumber}}',
+  full: '{{address.streetName}} {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/uk/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name}, #{building_number}'];
+export default {
+  normal: '{{address.streetName}}, {{address.buildingNumber}}',
+  full: '{{address.streetName}}, {{address.buildingNumber}} {{address.secondaryAddress}}',
+};

src/locales/ur/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{building_number} #{street_name}'];
+export default {
+  normal: '{{address.buildingNumber}} {{address.streetName}}',
+  full: '{{address.buildingNumber}} {{address.streetName}} {{address.secondaryAddress}}',
+};

src/locales/zh_CN/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name}#{building_number}号'];
+export default {
+  normal: '{{address.streetName}}{{address.buildingNumber}}号',
+  full: '{{address.streetName}}{{address.buildingNumber}}号 {{address.secondaryAddress}}',
+};

src/locales/zh_TW/address/street_address.ts

@@ -1 +1,4 @@
-export default ['#{street_name}#{building_number}號'];
+export default {
+  normal: '{{address.streetName}}{{address.buildingNumber}}號',
+  full: '{{address.streetName}}{{address.buildingNumber}}號 {{address.secondaryAddress}}',
+};