chore: run transform script (dirty)

Author: ST-DDT

src/modules/airline/aircraft-type.ts

@@ -0,0 +1,16 @@
+import type { FakerCore } from '../../faker-core';
+import { enumValue } from '../helpers/enum-value';
+
+/**
+ * Returns a random aircraft type.
+ *
+ * @param fakerCore The FakerCore to use.
+ *
+ * @example
+ * aircraftType(fakerCore) // 'narrowbody'
+ *
+ * @since 8.0.0
+ */
+export function aircraftType(fakerCore: FakerCore): AircraftType {
+  return enumValue(fakerCore, Aircraft);
+}

src/modules/airline/airline.ts

@@ -0,0 +1,20 @@
+import type { FakerCore } from '../../faker-core';
+import { resolveLocaleData } from '../../utils/resolve-locale-data';
+import { arrayElement } from '../helpers/array-element';
+
+/**
+ * Generates a random airline.
+ *
+ * @param fakerCore The FakerCore to use.
+ *
+ * @example
+ * airline(fakerCore) // { name: 'American Airlines', iataCode: 'AA' }
+ *
+ * @since 8.0.0
+ */
+export function airline(fakerCore: FakerCore): Airline {
+  return arrayElement(
+    fakerCore,
+    resolveLocaleData(fakerCore, 'airline', 'airline')
+  );
+}

src/modules/airline/airplane.ts

@@ -0,0 +1,20 @@
+import type { FakerCore } from '../../faker-core';
+import { resolveLocaleData } from '../../utils/resolve-locale-data';
+import { arrayElement } from '../helpers/array-element';
+
+/**
+ * Generates a random airplane.
+ *
+ * @param fakerCore The FakerCore to use.
+ *
+ * @example
+ * airplane(fakerCore) // { name: 'Airbus A321neo', iataTypeCode: '32Q' }
+ *
+ * @since 8.0.0
+ */
+export function airplane(fakerCore: FakerCore): Airplane {
+  return arrayElement(
+    fakerCore,
+    resolveLocaleData(fakerCore, 'airline', 'airplane')
+  );
+}

src/modules/airline/airport.ts

@@ -0,0 +1,20 @@
+import type { FakerCore } from '../../faker-core';
+import { resolveLocaleData } from '../../utils/resolve-locale-data';
+import { arrayElement } from '../helpers/array-element';
+
+/**
+ * Generates a random airport.
+ *
+ * @param fakerCore The FakerCore to use.
+ *
+ * @example
+ * airport(fakerCore) // { name: 'Dallas Fort Worth International Airport', iataCode: 'DFW' }
+ *
+ * @since 8.0.0
+ */
+export function airport(fakerCore: FakerCore): Airport {
+  return arrayElement(
+    fakerCore,
+    resolveLocaleData(fakerCore, 'airline', 'airport')
+  );
+}

src/modules/airline/flight-number.ts

@@ -0,0 +1,64 @@
+import type { FakerCore } from '../../faker-core';
+import { numeric } from '../string/numeric';
+
+/**
+ * Returns a random flight number. Flight numbers are always 1 to 4 digits long. Sometimes they are
+ * used without leading zeros (e.g.: `American Airlines flight 425`) and sometimes with leading
+ * zeros, often with the airline code prepended (e.g.: `AA0425`).
+ *
+ * To generate a flight number prepended with an airline code, combine this function with the
+ * `airline()` function and use template literals:
+ * ```
+ * `${airline(fakerCore).iataCode}${flightNumber(fakerCore, { addLeadingZeros: true })}` // 'AA0798'
+ * ```
+ *
+ * @param fakerCore The FakerCore to use.
+ * @param options The options to use.
+ * @param options.length The number or range of digits to generate. Defaults to `{ min: 1, max: 4 }`.
+ * @param options.addLeadingZeros Whether to pad the flight number up to 4 digits with leading zeros. Defaults to `false`.
+ *
+ * @example
+ * flightNumber(fakerCore) // '2405'
+ * flightNumber(fakerCore, { addLeadingZeros: true }) // '0249'
+ * flightNumber(fakerCore, { addLeadingZeros: true, length: 2 }) // '0042'
+ * flightNumber(fakerCore, { addLeadingZeros: true, length: { min: 2, max: 3 } }) // '0624'
+ * flightNumber(fakerCore, { length: 3 }) // '425'
+ * flightNumber(fakerCore, { length: { min: 2, max: 3 } }) // '84'
+ *
+ * @since 8.0.0
+ */
+export function flightNumber(
+  fakerCore: FakerCore,
+  options: {
+    /**
+     * The number or range of digits to generate.
+     *
+     * @default { min: 1, max: 4 }
+     */
+    length?:
+      | number
+      | {
+          /**
+           * The minimum number of digits to generate.
+           */
+          min: number;
+          /**
+           * The maximum number of digits to generate.
+           */
+          max: number;
+        };
+    /**
+     * Whether to pad the flight number up to 4 digits with leading zeros.
+     *
+     * @default false
+     */
+    addLeadingZeros?: boolean;
+  } = {}
+): string {
+  const { length = { min: 1, max: 4 }, addLeadingZeros = false } = options;
+  const flightNumber = numeric(fakerCore, {
+    length,
+    allowLeadingZeros: false,
+  });
+  return addLeadingZeros ? flightNumber.padStart(4, '0') : flightNumber;
+}

src/modules/airline/record-locator.ts

@@ -0,0 +1,55 @@
+import type { FakerCore } from '../../faker-core';
+import { alphanumeric } from '../string/alphanumeric';
+
+/**
+ * Generates a random [record locator](https://en.wikipedia.org/wiki/Record_locator). Record locators
+ * are used by airlines to identify reservations. They're also known as booking reference numbers,
+ * locator codes, confirmation codes, or reservation codes.
+ *
+ * @param fakerCore The FakerCore to use.
+ * @param options The options to use.
+ * @param options.allowNumerics Whether to allow numeric characters. Defaults to `false`.
+ * @param options.allowVisuallySimilarCharacters Whether to allow visually similar characters such as '1' and 'I'. Defaults to `false`.
+ *
+ * @example
+ * recordLocator(fakerCore) // 'KIFRWE'
+ * recordLocator(fakerCore, { allowNumerics: true }) // 'E5TYEM'
+ * recordLocator(fakerCore, { allowVisuallySimilarCharacters: true }) // 'ANZNEI'
+ * recordLocator(fakerCore, { allowNumerics: true, allowVisuallySimilarCharacters: true }) // '1Z2Z3E'
+ *
+ * @since 8.0.0
+ */
+export function recordLocator(
+  fakerCore: FakerCore,
+  options: {
+    /**
+     * Whether to allow numeric characters.
+     *
+     * @default false
+     */
+    allowNumerics?: boolean;
+    /**
+     * Whether to allow visually similar characters such as '1' and 'I'.
+     *
+     * @default false
+     */
+    allowVisuallySimilarCharacters?: boolean;
+  } = {}
+): string {
+  const { allowNumerics = false, allowVisuallySimilarCharacters = false } =
+    options;
+  const excludedChars: string[] = [];
+  if (!allowNumerics) {
+    excludedChars.push(...numerics);
+  }
+
+  if (!allowVisuallySimilarCharacters) {
+    excludedChars.push(...visuallySimilarCharacters);
+  }
+
+  return alphanumeric(fakerCore, {
+    length: 6,
+    casing: 'upper',
+    exclude: excludedChars,
+  });
+}

src/modules/airline/seat.ts

@@ -0,0 +1,36 @@
+import type { FakerCore } from '../../faker-core';
+import { arrayElement } from '../helpers/array-element';
+import { int } from '../number/int';
+
+/**
+ * Generates a random seat.
+ *
+ * @param fakerCore The FakerCore to use.
+ * @param options The options to use.
+ * @param options.aircraftType The aircraft type. Can be one of `narrowbody`, `regional`, `widebody`. Defaults to `narrowbody`.
+ *
+ * @example
+ * seat(fakerCore) // '22C'
+ * seat(fakerCore, { aircraftType: 'regional' }) // '7A'
+ * seat(fakerCore, { aircraftType: 'widebody' }) // '42K'
+ *
+ * @since 8.0.0
+ */
+export function seat(
+  fakerCore: FakerCore,
+  options: {
+    /**
+     * The aircraft type. Can be one of `narrowbody`, `regional`, `widebody`.
+     *
+     * @default 'narrowbody'
+     */
+    aircraftType?: AircraftType;
+  } = {}
+): string {
+  const { aircraftType = Aircraft.Narrowbody } = options;
+  const maxRow = aircraftTypeMaxRows[aircraftType];
+  const allowedSeats = aircraftTypeSeats[aircraftType];
+  const row = int(fakerCore, { min: 1, max: maxRow });
+  const seat = arrayElement(fakerCore, allowedSeats);
+  return `${row}${seat}`;
+}

src/modules/animal/bear.ts

@@ -0,0 +1,20 @@
+import type { FakerCore } from '../../faker-core';
+import { resolveLocaleData } from '../../utils/resolve-locale-data';
+import { arrayElement } from '../helpers/array-element';
+
+/**
+ * Returns a random bear species.
+ *
+ * @param fakerCore The FakerCore to use.
+ *
+ * @example
+ * bear(fakerCore) // 'Asian black bear'
+ *
+ * @since 5.5.0
+ */
+export function bear(fakerCore: FakerCore): string {
+  return arrayElement(
+    fakerCore,
+    resolveLocaleData(fakerCore, 'animal', 'bear')
+  );
+}

src/modules/animal/bird.ts

@@ -0,0 +1,20 @@
+import type { FakerCore } from '../../faker-core';
+import { resolveLocaleData } from '../../utils/resolve-locale-data';
+import { arrayElement } from '../helpers/array-element';
+
+/**
+ * Returns a random bird species.
+ *
+ * @param fakerCore The FakerCore to use.
+ *
+ * @example
+ * bird(fakerCore) // 'Buller's Shearwater'
+ *
+ * @since 5.5.0
+ */
+export function bird(fakerCore: FakerCore): string {
+  return arrayElement(
+    fakerCore,
+    resolveLocaleData(fakerCore, 'animal', 'bird')
+  );
+}

src/modules/animal/cat.ts

@@ -0,0 +1,17 @@
+import type { FakerCore } from '../../faker-core';
+import { resolveLocaleData } from '../../utils/resolve-locale-data';
+import { arrayElement } from '../helpers/array-element';
+
+/**
+ * Returns a random cat breed.
+ *
+ * @param fakerCore The FakerCore to use.
+ *
+ * @example
+ * cat(fakerCore) // 'Singapura'
+ *
+ * @since 5.5.0
+ */
+export function cat(fakerCore: FakerCore): string {
+  return arrayElement(fakerCore, resolveLocaleData(fakerCore, 'animal', 'cat'));
+}