@tachybase/plugin-mock-collections 0.23.8

package/dist/node_modules/@faker-js/faker/dist/types/modules/person/index.d.ts

@@ -0,0 +1,220 @@
+import { ModuleBase } from '../../internal/module-base';
+export declare enum Sex {
+    Female = "female",
+    Male = "male"
+}
+export type SexType = `${Sex}`;
+/**
+ * Module to generate people's personal information such as names and job titles. Prior to Faker 8.0.0, this module was known as `faker.name`.
+ *
+ * ### Overview
+ *
+ * To generate a full name, use [`fullName`](https://fakerjs.dev/api/person.html#fullname). Note that this is not the same as simply concatenating [`firstName`](https://fakerjs.dev/api/person.html#firstname) and [`lastName`](https://fakerjs.dev/api/person.html#lastname), as the full name may contain a prefix, suffix, or both. Additionally, different supported locales will have differing name patterns. For example, the last name may appear before the first name, or there may be a double or hyphenated first or last name.
+ *
+ * You can also generate the parts of a name separately, using [`prefix`](https://fakerjs.dev/api/person.html#prefix), [`firstName`](https://fakerjs.dev/api/person.html#firstname), [`middleName`](https://fakerjs.dev/api/person.html#middlename), [`lastName`](https://fakerjs.dev/api/person.html#lastname), and [`suffix`](https://fakerjs.dev/api/person.html#suffix). Not all locales support all of these parts.
+ *
+ * Many of the methods in this module can optionally choose either female, male or mixed names.
+ *
+ * Job-related data is also available. To generate a job title, use [`jobTitle`](https://fakerjs.dev/api/person.html#jobtitle).
+ *
+ * This module can also generate other personal information which might appear in user profiles, such as [`gender`](https://fakerjs.dev/api/person.html#gender), [`zodiacSign`](https://fakerjs.dev/api/person.html#zodiacsign), and [`bio`](https://fakerjs.dev/api/person.html#bio).
+ *
+ * ### Related modules
+ *
+ * For personal contact information like phone numbers and email addresses, see the [`faker.phone`](https://fakerjs.dev/api/phone.html) and [`faker.internet`](https://fakerjs.dev/api/internet.html) modules.
+ */
+export declare class PersonModule extends ModuleBase {
+    /**
+     * Returns a random first name.
+     *
+     * @param sex The optional sex to use.
+     * Can be either `'female'` or `'male'`.
+     *
+     * @example
+     * faker.person.firstName() // 'Antwan'
+     * faker.person.firstName('female') // 'Victoria'
+     * faker.person.firstName('male') // 'Tom'
+     *
+     * @since 8.0.0
+     */
+    firstName(sex?: SexType): string;
+    /**
+     * Returns a random last name.
+     *
+     * @param sex The optional sex to use.
+     * Can be either `'female'` or `'male'`.
+     *
+     * @example
+     * faker.person.lastName() // 'Hauck'
+     * faker.person.lastName('female') // 'Grady'
+     * faker.person.lastName('male') // 'Barton'
+     *
+     * @since 8.0.0
+     */
+    lastName(sex?: SexType): string;
+    /**
+     * Returns a random middle name.
+     *
+     * @param sex The optional sex to use.
+     * Can be either `'female'` or `'male'`.
+     *
+     * @example
+     * faker.person.middleName() // 'James'
+     * faker.person.middleName('female') // 'Eloise'
+     * faker.person.middleName('male') // 'Asher'
+     *
+     * @since 8.0.0
+     */
+    middleName(sex?: SexType): string;
+    /**
+     * Generates a random full name.
+     *
+     * @param options An options object.
+     * @param options.firstName The optional first name to use. If not specified a random one will be chosen.
+     * @param options.lastName The optional last name to use. If not specified a random one will be chosen.
+     * @param options.sex The optional sex to use. Can be either `'female'` or `'male'`.
+     *
+     * @example
+     * faker.person.fullName() // 'Allen Brown'
+     * faker.person.fullName({ firstName: 'Joann' }) // 'Joann Osinski'
+     * faker.person.fullName({ firstName: 'Marcella', sex: 'female' }) // 'Mrs. Marcella Huels'
+     * faker.person.fullName({ lastName: 'Beer' }) // 'Mr. Alfonso Beer'
+     * faker.person.fullName({ sex: 'male' }) // 'Fernando Schaefer'
+     *
+     * @since 8.0.0
+     */
+    fullName(options?: {
+        /**
+         * The optional first name to use. If not specified a random one will be chosen.
+         *
+         * @default faker.person.firstName(sex)
+         */
+        firstName?: string;
+        /**
+         * The optional last name to use. If not specified a random one will be chosen.
+         *
+         * @default faker.person.lastName(sex)
+         */
+        lastName?: string;
+        /**
+         * The optional sex to use. Can be either `'female'` or `'male'`.
+         *
+         * @default faker.helpers.arrayElement(['female', 'male'])
+         */
+        sex?: SexType;
+    }): string;
+    /**
+     * Returns a random gender.
+     *
+     * @see faker.person.sex(): For generating a binary-gender value.
+     *
+     * @example
+     * faker.person.gender() // 'Trans*Man'
+     *
+     * @since 8.0.0
+     */
+    gender(): string;
+    /**
+     * Returns a random sex.
+     *
+     * Output of this method is localised, so it should not be used to fill the parameter `sex`
+     * available in some other modules for example `faker.person.firstName()`.
+     *
+     * @see faker.person.gender(): For generating a gender related value.
+     * @see faker.person.sexType(): For generating a sex value to be used as a parameter.
+     *
+     * @example
+     * faker.person.sex() // 'female'
+     *
+     * @since 8.0.0
+     */
+    sex(): string;
+    /**
+     * Returns a random sex type. The `SexType` is intended to be used in parameters and conditions.
+     *
+     * @see faker.person.gender(): For generating a gender related value in forms.
+     * @see faker.person.sex(): For generating a binary-gender value in forms.
+     *
+     * @example
+     * faker.person.sexType() // Sex.Female
+     *
+     * @since 8.0.0
+     */
+    sexType(): SexType;
+    /**
+     * Returns a random short biography
+     *
+     * @example
+     * faker.person.bio() // 'oatmeal advocate, veteran 🐠'
+     *
+     * @since 8.0.0
+     */
+    bio(): string;
+    /**
+     * Returns a random person prefix.
+     *
+     * @param sex The optional sex to use. Can be either `'female'` or `'male'`.
+     *
+     * @example
+     * faker.person.prefix() // 'Miss'
+     * faker.person.prefix('female') // 'Ms.'
+     * faker.person.prefix('male') // 'Mr.'
+     *
+     * @since 8.0.0
+     */
+    prefix(sex?: SexType): string;
+    /**
+     * Returns a random person suffix.
+     *
+     * @example
+     * faker.person.suffix() // 'DDS'
+     *
+     * @since 8.0.0
+     */
+    suffix(): string;
+    /**
+     * Generates a random job title.
+     *
+     * @example
+     * faker.person.jobTitle() // 'Global Accounts Engineer'
+     *
+     * @since 8.0.0
+     */
+    jobTitle(): string;
+    /**
+     * Generates a random job descriptor.
+     *
+     * @example
+     * faker.person.jobDescriptor() // 'Customer'
+     *
+     * @since 8.0.0
+     */
+    jobDescriptor(): string;
+    /**
+     * Generates a random job area.
+     *
+     * @example
+     * faker.person.jobArea() // 'Brand'
+     *
+     * @since 8.0.0
+     */
+    jobArea(): string;
+    /**
+     * Generates a random job type.
+     *
+     * @example
+     * faker.person.jobType() // 'Assistant'
+     *
+     * @since 8.0.0
+     */
+    jobType(): string;
+    /**
+     * Returns a random zodiac sign.
+     *
+     * @example
+     * faker.person.zodiacSign() // 'Pisces'
+     *
+     * @since 8.0.0
+     */
+    zodiacSign(): string;
+}

package/dist/node_modules/@faker-js/faker/dist/types/modules/phone/index.d.ts

@@ -0,0 +1,62 @@
+import { ModuleBase } from '../../internal/module-base';
+/**
+ * Module to generate phone-related data.
+ *
+ * ### Overview
+ *
+ * For a phone number, use [`number()`](https://fakerjs.dev/api/phone.html#number). Many locales provide country-specific formats.
+ */
+export declare class PhoneModule extends ModuleBase {
+    /**
+     * Generates a random phone number.
+     *
+     * @see faker.string.numeric(): For generating a random string of numbers.
+     * @see faker.helpers.fromRegExp(): For generating a phone number matching a regular expression.
+     *
+     * @example
+     * faker.phone.number() // '961-770-7727'
+     *
+     * @since 7.3.0
+     */
+    number(): string;
+    /**
+     * Generates a random phone number.
+     *
+     * @param format Format of the phone number.
+     *
+     * @see faker.string.numeric(): For generating a random string of numbers.
+     * @see faker.helpers.fromRegExp(): For generating a phone number matching a regular expression.
+     *
+     * @example
+     * faker.phone.number('501-###-###') // '501-039-841'
+     * faker.phone.number('+48 91 ### ## ##') // '+48 91 463 61 70'
+     *
+     * @since 7.3.0
+     *
+     * @deprecated Use `faker.phone.number()` without an argument, `faker.string.numeric()` or `faker.helpers.fromRegExp()` instead.
+     */
+    number(format: string): string;
+    /**
+     * Generates a random phone number.
+     *
+     * @param format Format of the phone number. Defaults to a random phone number format.
+     *
+     * @see faker.string.numeric(): For generating a random string of numbers.
+     * @see faker.helpers.fromRegExp(): For generating a phone number matching a regular expression.
+     *
+     * @example
+     * faker.phone.number() // '961-770-7727'
+     *
+     * @since 7.3.0
+     */
+    number(format?: string): string;
+    /**
+     * Generates IMEI number.
+     *
+     * @example
+     * faker.phone.imei() // '13-850175-913761-7'
+     *
+     * @since 6.2.0
+     */
+    imei(): string;
+}

package/dist/node_modules/@faker-js/faker/dist/types/modules/random/index.d.ts

@@ -0,0 +1,172 @@
+import { ModuleBase } from '../../internal/module-base';
+import type { LiteralUnion } from '../../utils/types';
+import type { AlphaChar, AlphaNumericChar, Casing, NumericChar } from '../string';
+/**
+ * Generates random values of different kinds.
+ *
+ * @deprecated Use the modules specific to the type of data you want to generate instead.
+ */
+export declare class RandomModule extends ModuleBase {
+    /**
+     * Returns a random word.
+     *
+     * @see faker.lorem.word(): For generating a random placeholder word.
+     * @see faker.word.sample(): For generating a random real word.
+     *
+     * @example
+     * faker.random.word() // 'Seamless'
+     *
+     * @since 3.1.0
+     *
+     * @deprecated Use `faker.lorem.word()` or `faker.word.sample()` instead.
+     */
+    word(): string;
+    /**
+     * Returns a string with a given number of random words.
+     *
+     * @param count The number or range of words. Defaults to a random value between `1` and `3`.
+     * @param count.min The minimum number of words. Defaults to `1`.
+     * @param count.max The maximum number of words. Defaults to `3`.
+     *
+     * @see faker.lorem.words(): For generating a sequence of random placeholder words.
+     * @see faker.word.words(): For generating a sequence of random real words.
+     *
+     * @example
+     * faker.random.words() // 'neural'
+     * faker.random.words(5) // 'copy Handcrafted bus client-server Point'
+     * faker.random.words({ min: 3, max: 5 }) // 'cool sticky Borders'
+     *
+     * @since 3.1.0
+     *
+     * @deprecated Use `faker.lorem.words()` or `faker.word.words()` instead.
+     */
+    words(count?: number | {
+        /**
+         * The minimum number of words.
+         */
+        min: number;
+        /**
+         * The maximum number of words.
+         */
+        max: number;
+    }): string;
+    /**
+     * Do NOT use. This property has been removed.
+     *
+     * @example
+     * faker.helpers.objectKey(allLocales)
+     * faker.helpers.objectValue(allFakers)
+     *
+     * @since 3.1.0
+     *
+     * @deprecated Use `faker.helpers.objectKey(allLocales/allFakers)` instead.
+     */
+    private locale;
+    /**
+     * Generating a string consisting of letters in the English alphabet.
+     *
+     * @param options Either the number of characters or an options instance.
+     * @param options.count The number of characters to generate. Defaults to `1`.
+     * @param options.casing The casing of the characters. Defaults to `'mixed'`.
+     * @param options.bannedChars An array with characters to exclude. Defaults to `[]`.
+     *
+     * @see faker.string.alpha(): For the replacement method.
+     *
+     * @example
+     * faker.random.alpha() // 'b'
+     * faker.random.alpha(10) // 'qccrabobaf'
+     * faker.random.alpha({ count: 5, casing: 'upper', bannedChars: ['A'] }) // 'DTCIC'
+     *
+     * @since 5.0.0
+     *
+     * @deprecated Use `faker.string.alpha()` instead.
+     */
+    alpha(options?: number | {
+        /**
+         * The number of characters to generate.
+         *
+         * @default 1
+         */
+        count?: number;
+        /**
+         * The casing of the characters.
+         *
+         * @default 'mixed'
+         */
+        casing?: Casing;
+        /**
+         * An array with characters to exclude.
+         *
+         * @default []
+         */
+        bannedChars?: ReadonlyArray<LiteralUnion<AlphaChar>> | string;
+    }): string;
+    /**
+     * Generating a string consisting of alpha characters and digits.
+     *
+     * @param count The number of characters and digits to generate. Defaults to `1`.
+     * @param options The options to use.
+     * @param options.casing The casing of the characters. Defaults to `'lower'`.
+     * @param options.bannedChars An array of characters and digits which should be banned in the generated string. Defaults to `[]`.
+     *
+     * @see faker.string.alphanumeric(): For the replacement method.
+     *
+     * @example
+     * faker.random.alphaNumeric() // '2'
+     * faker.random.alphaNumeric(5) // '3e5v7'
+     * faker.random.alphaNumeric(5, { bannedChars: ["a"] }) // 'xszlm'
+     *
+     * @since 3.1.0
+     *
+     * @deprecated Use `faker.string.alphanumeric()` instead.
+     */
+    alphaNumeric(count?: number, options?: {
+        /**
+         * The casing of the characters.
+         *
+         * @default 'lower'
+         */
+        casing?: Casing;
+        /**
+         * An array of characters and digits which should be banned in the generated string.
+         *
+         * @default []
+         */
+        bannedChars?: ReadonlyArray<LiteralUnion<AlphaNumericChar>> | string;
+    }): string;
+    /**
+     * Generates a given length string of digits.
+     *
+     * @param length The number of digits to generate. Defaults to `1`.
+     * @param options The options to use.
+     * @param options.allowLeadingZeros Whether leading zeros are allowed or not. Defaults to `true`.
+     * @param options.bannedDigits An array of digits which should be banned in the generated string. Defaults to `[]`.
+     *
+     * @see faker.string.numeric(): For the replacement method.
+     *
+     * @example
+     * faker.random.numeric() // '2'
+     * faker.random.numeric(5) // '31507'
+     * faker.random.numeric(42) // '00434563150765416546479875435481513188548'
+     * faker.random.numeric(42, { allowLeadingZeros: true }) // '00564846278453876543517840713421451546115'
+     * faker.random.numeric(6, { bannedDigits: ['0'] }) // '943228'
+     *
+     * @since 6.3.0
+     *
+     * @deprecated Use `faker.string.numeric()` instead.
+     */
+    numeric(length?: number, options?: {
+        /**
+         * Whether leading zeros are allowed or not.
+         *
+         * @default true
+         */
+        allowLeadingZeros?: boolean;
+        /**
+         * An array of digits which should be banned in the generated string.
+         *
+         * @default []
+         */
+        bannedDigits?: ReadonlyArray<LiteralUnion<NumericChar>> | string;
+    }): string;
+}

package/dist/node_modules/@faker-js/faker/dist/types/modules/science/index.d.ts

@@ -0,0 +1,59 @@
+import { ModuleBase } from '../../internal/module-base';
+/**
+ * The possible definitions related to elements.
+ */
+export interface ChemicalElement {
+    /**
+     * The symbol for the element (e.g. `'He'`).
+     */
+    symbol: string;
+    /**
+     * The name for the element (e.g. `'Cerium'`).
+     */
+    name: string;
+    /**
+     * The atomic number for the element (e.g. `52`).
+     */
+    atomicNumber: number;
+}
+export interface Unit {
+    /**
+     * The long version of the unit (e.g. `meter`).
+     */
+    name: string;
+    /**
+     * The short version/abbreviation of the element (e.g. `Pa`).
+     */
+    symbol: string;
+}
+/**
+ * Module to generate science related entries.
+ *
+ * ### Overview
+ *
+ * Both methods in this module return objects rather than strings. For example, you can use `faker.science.chemicalElement().name` to pick out the specific property you need.
+ */
+export declare class ScienceModule extends ModuleBase {
+    /**
+     * Returns a random periodic table element.
+     *
+     * @example
+     * faker.science.chemicalElement() // { symbol: 'H', name: 'Hydrogen', atomicNumber: 1 }
+     * faker.science.chemicalElement() // { symbol: 'Xe', name: 'Xenon', atomicNumber: 54 }
+     * faker.science.chemicalElement() // { symbol: 'Ce', name: 'Cerium', atomicNumber: 58 }
+     *
+     * @since 7.2.0
+     */
+    chemicalElement(): ChemicalElement;
+    /**
+     * Returns a random scientific unit.
+     *
+     * @example
+     * faker.science.unit() // { name: 'meter', symbol: 'm' }
+     * faker.science.unit() // { name: 'second', symbol: 's' }
+     * faker.science.unit() // { name: 'mole', symbol: 'mol' }
+     *
+     * @since 7.2.0
+     */
+    unit(): Unit;
+}