refactor!: reorganize src folder (#909)

1 files changed, 76 insertions, 0 deletions

diff --git a/src/modules/phone/index.ts b/src/modules/phone/index.ts
new file mode 100644
index 00000000..7e85915c
--- /dev/null
+++ b/src/modules/phone/index.ts
@@ -0,0 +1,76 @@
+import type { Faker } from '../..';
+
+/**
+ * Module to generate phone-related data.
+ */
+export class Phone {
+  constructor(private readonly faker: Faker) {
+    // Bind `this` so namespaced is working correctly
+    for (const name of Object.getOwnPropertyNames(Phone.prototype)) {
+      if (name === 'constructor' || typeof this[name] !== 'function') {
+        continue;
+      }
+      this[name] = this[name].bind(this);
+    }
+  }
+
+  /**
+   * Generates a random phone number.
+   *
+   * @param format Format of the phone number. Defaults to `faker.phone.phoneFormats()`.
+   *
+   * @example
+   * faker.phone.phoneNumber() // '961-770-7727'
+   * faker.phone.phoneNumber('501-###-###') // '501-039-841'
+   * faker.phone.phoneNumber('+48 91 ### ## ##') // '+48 91 463 61 70'
+   */
+  // TODO @pkuczynski 2022-02-01: simplify name to `number()`
+  phoneNumber(format?: string): string {
+    return this.faker.helpers.replaceSymbolWithNumber(
+      format || this.phoneFormats()
+    );
+  }
+
+  /**
+   * Returns phone number in a format of the given index from `faker.definitions.phone_number.formats`.
+   *
+   * @param phoneFormatsArrayIndex Index in the `faker.definitions.phone_number.formats` array. Defaults to `0`.
+   *
+   * @example
+   * faker.phone.phoneNumberFormat() // '943-627-0355'
+   * faker.phone.phoneNumberFormat(3) // '282.652.3201'
+   */
+  // FIXME @Shinigami 2022-01-14: this is strange passing in an array index
+  // TODO @pkuczynski 2022-02-01: discuss removing this method as it tightly couples with localisation
+  phoneNumberFormat(phoneFormatsArrayIndex = 0): string {
+    return this.faker.helpers.replaceSymbolWithNumber(
+      this.faker.definitions.phone_number.formats[phoneFormatsArrayIndex]
+    );
+  }
+
+  /**
+   * Returns a random phone number format.
+   *
+   * @example
+   * faker.phone.phoneFormats() // '!##.!##.####'
+   */
+  // TODO @pkuczynski 2022-02-01: simplify name to `format()`
+  phoneFormats(): string {
+    return this.faker.helpers.arrayElement(
+      this.faker.definitions.phone_number.formats
+    );
+  }
+
+  /**
+   * Generates IMEI number.
+   *
+   * @example
+   * faker.phone.imei() // '13-850175-913761-7'
+   */
+  imei(): string {
+    return this.faker.helpers.replaceCreditCardSymbols(
+      '##-######-######-L',
+      '#'
+    );
+  }
+}