@tachybase/plugin-mock-collections 0.23.8

package/dist/node_modules/@faker-js/faker/dist/types/modules/word/filter-word-list-by-length.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Filters a string array for values with a matching length.
+ * If length is not provided or no values with a matching length are found,
+ * then the result will be determined using the given error handling strategy.
+ *
+ * @param options The options to provide.
+ * @param options.wordList A list of words to filter.
+ * @param options.length The exact or the range of lengths the words should have.
+ * @param options.strategy The strategy to apply when no words with a matching length are found. Defaults to 'any-length'.
+ *
+ * Available error handling strategies:
+ *
+ * - `fail`: Throws an error if no words with the given length are found.
+ * - `shortest`: Returns any of the shortest words.
+ * - `closest`: Returns any of the words closest to the given length.
+ * - `longest`: Returns any of the longest words.
+ * - `any-length`: Returns a copy of the original word list.
+ */
+export declare function filterWordListByLength(options: {
+    wordList: ReadonlyArray<string>;
+    length?: number | {
+        min: number;
+        max: number;
+    };
+    strategy?: 'fail' | 'closest' | 'shortest' | 'longest' | 'any-length';
+}): string[];

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

@@ -0,0 +1,474 @@
+import { ModuleBase } from '../../internal/module-base';
+/**
+ * Module to return various types of words.
+ */
+export declare class WordModule extends ModuleBase {
+    /**
+     * Returns an adjective of random or optionally specified length.
+     *
+     * @param options The expected length of the word or the options to use.
+     * @param options.length The expected length of the word.
+     * @param options.strategy The strategy to apply when no words with a matching length are found.
+     *
+     * Available error handling strategies:
+     *
+     * - `fail`: Throws an error if no words with the given length are found.
+     * - `shortest`: Returns any of the shortest words.
+     * - `closest`: Returns any of the words closest to the given length.
+     * - `longest`: Returns any of the longest words.
+     * - `any-length`: Returns a word with any length.
+     *
+     * Defaults to `'any-length'`.
+     *
+     * @example
+     * faker.word.adjective() // 'pungent'
+     * faker.word.adjective(5) // 'slimy'
+     * faker.word.adjective(100) // 'complete'
+     * faker.word.adjective({ strategy: 'shortest' }) // 'icy'
+     * faker.word.adjective({ length: { min: 5, max: 7 }, strategy: "fail" }) // 'distant'
+     *
+     * @since 6.0.0
+     */
+    adjective(options?: number | {
+        /**
+         * The expected length of the word.
+         */
+        length?: number | {
+            /**
+             * The minimum length of the word.
+             */
+            min: number;
+            /**
+             * The maximum length of the word.
+             */
+            max: number;
+        };
+        /**
+         * The strategy to apply when no words with a matching length are found.
+         *
+         * Available error handling strategies:
+         *
+         * - `fail`: Throws an error if no words with the given length are found.
+         * - `shortest`: Returns any of the shortest words.
+         * - `closest`: Returns any of the words closest to the given length.
+         * - `longest`: Returns any of the longest words.
+         * - `any-length`: Returns a word with any length.
+         *
+         * @default 'any-length'
+         */
+        strategy?: 'fail' | 'closest' | 'shortest' | 'longest' | 'any-length';
+    }): string;
+    /**
+     * Returns an adverb of random or optionally specified length.
+     *
+     * @param options The expected length of the word or the options to use.
+     * @param options.length The expected length of the word.
+     * @param options.strategy The strategy to apply when no words with a matching length are found.
+     *
+     * Available error handling strategies:
+     *
+     * - `fail`: Throws an error if no words with the given length are found.
+     * - `shortest`: Returns any of the shortest words.
+     * - `closest`: Returns any of the words closest to the given length.
+     * - `longest`: Returns any of the longest words.
+     * - `any-length`: Returns a word with any length.
+     *
+     * Defaults to `'any-length'`.
+     *
+     * @example
+     * faker.word.adverb() // 'quarrelsomely'
+     * faker.word.adverb(5) // 'madly'
+     * faker.word.adverb(100) // 'sadly'
+     * faker.word.adverb({ strategy: 'shortest' }) // 'too'
+     * faker.word.adverb({ length: { min: 5, max: 7 }, strategy: "fail" }) // 'sweetly'
+     *
+     * @since 6.0.0
+     */
+    adverb(options?: number | {
+        /**
+         * The expected length of the word.
+         */
+        length?: number | {
+            /**
+             * The minimum length of the word.
+             */
+            min: number;
+            /**
+             * The maximum length of the word.
+             */
+            max: number;
+        };
+        /**
+         * The strategy to apply when no words with a matching length are found.
+         *
+         * Available error handling strategies:
+         *
+         * - `fail`: Throws an error if no words with the given length are found.
+         * - `shortest`: Returns any of the shortest words.
+         * - `closest`: Returns any of the words closest to the given length.
+         * - `longest`: Returns any of the longest words.
+         * - `any-length`: Returns a word with any length.
+         *
+         * @default 'any-length'
+         */
+        strategy?: 'fail' | 'closest' | 'shortest' | 'longest' | 'any-length';
+    }): string;
+    /**
+     * Returns a conjunction of random or optionally specified length.
+     *
+     * @param options The expected length of the word or the options to use.
+     * @param options.length The expected length of the word.
+     * @param options.strategy The strategy to apply when no words with a matching length are found.
+     *
+     * Available error handling strategies:
+     *
+     * - `fail`: Throws an error if no words with the given length are found.
+     * - `shortest`: Returns any of the shortest words.
+     * - `closest`: Returns any of the words closest to the given length.
+     * - `longest`: Returns any of the longest words.
+     * - `any-length`: Returns a word with any length.
+     *
+     * Defaults to `'any-length'`.
+     *
+     * @example
+     * faker.word.conjunction() // 'in order that'
+     * faker.word.conjunction(5) // 'since'
+     * faker.word.conjunction(100) // 'as long as'
+     * faker.word.conjunction({ strategy: 'shortest' }) // 'or'
+     * faker.word.conjunction({ length: { min: 5, max: 7 }, strategy: "fail" }) // 'hence'
+     *
+     * @since 6.0.0
+     */
+    conjunction(options?: number | {
+        /**
+         * The expected length of the word.
+         */
+        length?: number | {
+            /**
+             * The minimum length of the word.
+             */
+            min: number;
+            /**
+             * The maximum length of the word.
+             */
+            max: number;
+        };
+        /**
+         * The strategy to apply when no words with a matching length are found.
+         *
+         * Available error handling strategies:
+         *
+         * - `fail`: Throws an error if no words with the given length are found.
+         * - `shortest`: Returns any of the shortest words.
+         * - `closest`: Returns any of the words closest to the given length.
+         * - `longest`: Returns any of the longest words.
+         * - `any-length`: Returns a word with any length.
+         *
+         * @default 'any-length'
+         */
+        strategy?: 'fail' | 'closest' | 'shortest' | 'longest' | 'any-length';
+    }): string;
+    /**
+     * Returns an interjection of random or optionally specified length.
+     *
+     * @param options The expected length of the word or the options to use.
+     * @param options.length The expected length of the word.
+     * @param options.strategy The strategy to apply when no words with a matching length are found.
+     *
+     * Available error handling strategies:
+     *
+     * - `fail`: Throws an error if no words with the given length are found.
+     * - `shortest`: Returns any of the shortest words.
+     * - `closest`: Returns any of the words closest to the given length.
+     * - `longest`: Returns any of the longest words.
+     * - `any-length`: Returns a word with any length.
+     *
+     * Defaults to `'any-length'`.
+     *
+     * @example
+     * faker.word.interjection() // 'gah'
+     * faker.word.interjection(5) // 'fooey'
+     * faker.word.interjection(100) // 'yowza'
+     * faker.word.interjection({ strategy: 'shortest' }) // 'hm'
+     * faker.word.interjection({ length: { min: 5, max: 7 }, strategy: "fail" }) // 'boohoo'
+     *
+     * @since 6.0.0
+     */
+    interjection(options?: number | {
+        /**
+         * The expected length of the word.
+         */
+        length?: number | {
+            /**
+             * The minimum length of the word.
+             */
+            min: number;
+            /**
+             * The maximum length of the word.
+             */
+            max: number;
+        };
+        /**
+         * The strategy to apply when no words with a matching length are found.
+         *
+         * Available error handling strategies:
+         *
+         * - `fail`: Throws an error if no words with the given length are found.
+         * - `shortest`: Returns any of the shortest words.
+         * - `closest`: Returns any of the words closest to the given length.
+         * - `longest`: Returns any of the longest words.
+         * - `any-length`: Returns a word with any length.
+         *
+         * @default 'any-length'
+         */
+        strategy?: 'fail' | 'closest' | 'shortest' | 'longest' | 'any-length';
+    }): string;
+    /**
+     * Returns a noun of random or optionally specified length.
+     *
+     * @param options The expected length of the word or the options to use.
+     * @param options.length The expected length of the word.
+     * @param options.strategy The strategy to apply when no words with a matching length are found.
+     *
+     * Available error handling strategies:
+     *
+     * - `fail`: Throws an error if no words with the given length are found.
+     * - `shortest`: Returns any of the shortest words.
+     * - `closest`: Returns any of the words closest to the given length.
+     * - `longest`: Returns any of the longest words.
+     * - `any-length`: Returns a word with any length.
+     *
+     * Defaults to `'any-length'`.
+     *
+     * @example
+     * faker.word.noun() // 'external'
+     * faker.word.noun(5) // 'front'
+     * faker.word.noun(100) // 'care'
+     * faker.word.noun({ strategy: 'shortest' }) // 'ad'
+     * faker.word.noun({ length: { min: 5, max: 7 }, strategy: "fail" }) // 'average'
+     *
+     * @since 6.0.0
+     */
+    noun(options?: number | {
+        /**
+         * The expected length of the word.
+         */
+        length?: number | {
+            /**
+             * The minimum length of the word.
+             */
+            min: number;
+            /**
+             * The maximum length of the word.
+             */
+            max: number;
+        };
+        /**
+         * The strategy to apply when no words with a matching length are found.
+         *
+         * Available error handling strategies:
+         *
+         * - `fail`: Throws an error if no words with the given length are found.
+         * - `shortest`: Returns any of the shortest words.
+         * - `closest`: Returns any of the words closest to the given length.
+         * - `longest`: Returns any of the longest words.
+         * - `any-length`: Returns a word with any length.
+         *
+         * @default 'any-length'
+         */
+        strategy?: 'fail' | 'closest' | 'shortest' | 'longest' | 'any-length';
+    }): string;
+    /**
+     * Returns a preposition of random or optionally specified length.
+     *
+     * @param options The expected length of the word or the options to use.
+     * @param options.length The expected length of the word.
+     * @param options.strategy The strategy to apply when no words with a matching length are found.
+     *
+     * Available error handling strategies:
+     *
+     * - `fail`: Throws an error if no words with the given length are found.
+     * - `shortest`: Returns any of the shortest words.
+     * - `closest`: Returns any of the words closest to the given length.
+     * - `longest`: Returns any of the longest words.
+     * - `any-length`: Returns a word with any length.
+     *
+     * Defaults to `'any-length'`.
+     *
+     * @example
+     * faker.word.preposition() // 'without'
+     * faker.word.preposition(5) // 'abaft'
+     * faker.word.preposition(100) // 'an'
+     * faker.word.preposition({ strategy: 'shortest' }) // 'a'
+     * faker.word.preposition({ length: { min: 5, max: 7 }, strategy: "fail" }) // 'given'
+     *
+     * @since 6.0.0
+     */
+    preposition(options?: number | {
+        /**
+         * The expected length of the word.
+         */
+        length?: number | {
+            /**
+             * The minimum length of the word.
+             */
+            min: number;
+            /**
+             * The maximum length of the word.
+             */
+            max: number;
+        };
+        /**
+         * The strategy to apply when no words with a matching length are found.
+         *
+         * Available error handling strategies:
+         *
+         * - `fail`: Throws an error if no words with the given length are found.
+         * - `shortest`: Returns any of the shortest words.
+         * - `closest`: Returns any of the words closest to the given length.
+         * - `longest`: Returns any of the longest words.
+         * - `any-length`: Returns a word with any length.
+         *
+         * @default 'any-length'
+         */
+        strategy?: 'fail' | 'closest' | 'shortest' | 'longest' | 'any-length';
+    }): string;
+    /**
+     * Returns a verb of random or optionally specified length.
+     *
+     * @param options The expected length of the word or the options to use.
+     * @param options.length The expected length of the word.
+     * @param options.strategy The strategy to apply when no words with a matching length are found.
+     *
+     * Available error handling strategies:
+     *
+     * - `fail`: Throws an error if no words with the given length are found.
+     * - `shortest`: Returns any of the shortest words.
+     * - `closest`: Returns any of the words closest to the given length.
+     * - `longest`: Returns any of the longest words.
+     * - `any-length`: Returns a word with any length.
+     *
+     * Defaults to `'any-length'`.
+     *
+     * @example
+     * faker.word.verb() // 'act'
+     * faker.word.verb(5) // 'tinge'
+     * faker.word.verb(100) // 'mess'
+     * faker.word.verb({ strategy: 'shortest' }) // 'do'
+     * faker.word.verb({ length: { min: 5, max: 7 }, strategy: "fail" }) // 'vault'
+     *
+     * @since 6.0.0
+     */
+    verb(options?: number | {
+        /**
+         * The expected length of the word.
+         */
+        length?: number | {
+            /**
+             * The minimum length of the word.
+             */
+            min: number;
+            /**
+             * The maximum length of the word.
+             */
+            max: number;
+        };
+        /**
+         * The strategy to apply when no words with a matching length are found.
+         *
+         * Available error handling strategies:
+         *
+         * - `fail`: Throws an error if no words with the given length are found.
+         * - `shortest`: Returns any of the shortest words.
+         * - `closest`: Returns any of the words closest to the given length.
+         * - `longest`: Returns any of the longest words.
+         * - `any-length`: Returns a word with any length.
+         *
+         * @default 'any-length'
+         */
+        strategy?: 'fail' | 'closest' | 'shortest' | 'longest' | 'any-length';
+    }): string;
+    /**
+     * Returns a random sample of random or optionally specified length.
+     *
+     * @param options The expected length of the word or the options to use.
+     * @param options.length The expected length of the word.
+     * @param options.strategy The strategy to apply when no words with a matching length are found.
+     *
+     * Available error handling strategies:
+     *
+     * - `fail`: Throws an error if no words with the given length are found.
+     * - `shortest`: Returns any of the shortest words.
+     * - `closest`: Returns any of the words closest to the given length.
+     * - `longest`: Returns any of the longest words.
+     * - `any-length`: Returns a word with any length.
+     *
+     * Defaults to `'any-length'`.
+     *
+     * @example
+     * faker.word.sample() // 'incidentally'
+     * faker.word.sample(5) // 'fruit'
+     *
+     * @since 8.0.0
+     */
+    sample(options?: number | {
+        /**
+         * The expected length of the word.
+         */
+        length?: number | {
+            /**
+             * The minimum length of the word.
+             */
+            min: number;
+            /**
+             * The maximum length of the word.
+             */
+            max: number;
+        };
+        /**
+         * The strategy to apply when no words with a matching length are found.
+         *
+         * Available error handling strategies:
+         *
+         * - `fail`: Throws an error if no words with the given length are found.
+         * - `shortest`: Returns any of the shortest words.
+         * - `closest`: Returns any of the words closest to the given length.
+         * - `longest`: Returns any of the longest words.
+         * - `any-length`: Returns a word with any length.
+         *
+         * @default 'any-length'
+         */
+        strategy?: 'fail' | 'closest' | 'shortest' | 'longest' | 'any-length';
+    }): string;
+    /**
+     * Returns a string containing a number of space separated random words.
+     *
+     * @param options The optional options object or the number of words to return.
+     * @param options.count The number of words to return. Defaults to a random value between `1` and `3`.
+     *
+     * @example
+     * faker.word.words() // 'almost'
+     * faker.word.words(5) // 'before hourly patiently dribble equal'
+     * faker.word.words({ count: 5 }) // 'whoever edible um kissingly faraway'
+     * faker.word.words({ count: { min: 5, max: 10 } }) // 'vice buoyant through apropos poised total wary boohoo'
+     *
+     * @since 8.0.0
+     */
+    words(options?: number | {
+        /**
+         * The number of words to return.
+         *
+         * @default { min: 1, max: 3 }
+         */
+        count?: number | {
+            /**
+             * The minimum number of words to return.
+             */
+            min: number;
+            /**
+             * The maximum number of words to return.
+             */
+            max: number;
+        };
+    }): string;
+}

package/dist/node_modules/@faker-js/faker/dist/types/randomizer.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Interface for a random number generator.
+ *
+ * **Note:** Normally there is no need to implement this interface directly,
+ * unless you want to achieve a specific goal with it.
+ *
+ * This interface enables you to use random generators from third party libraries such as [pure-rand](https://github.com/dubzzz/pure-rand).
+ *
+ * Instances are expected to be ready for use before being passed to any Faker constructor,
+ * this includes being `seed()`ed with either a random or fixed value.
+ *
+ * For more information please refer to the [documentation](/api/randomizer).
+ *
+ * @example
+ * import { Faker, Randomizer, SimpleFaker } from '@faker-js/faker';
+ * import { RandomGenerator, xoroshiro128plus } from 'pure-rand';
+ *
+ * function generatePureRandRandomizer(
+ *   seed: number | number[] = Date.now() ^ (Math.random() * 0x100000000),
+ *   factory: (seed: number) => RandomGenerator = xoroshiro128plus
+ * ): Randomizer {
+ *   const self = {
+ *     next: () => (self.generator.unsafeNext() >>> 0) / 0x100000000,
+ *     seed: (seed: number | number[]) => {
+ *       self.generator = factory(typeof seed === 'number' ? seed : seed[0]);
+ *     },
+ *   } as Randomizer & { generator: RandomGenerator };
+ *   self.seed(seed);
+ *   return self;
+ * }
+ *
+ * const randomizer = generatePureRandRandomizer();
+ *
+ * const simpleFaker = new SimpleFaker({ randomizer });
+ *
+ * const faker = new Faker({
+ *   locale: ...,
+ *   randomizer,
+ * });
+ *
+ * @since 8.2.0
+ */
+export interface Randomizer {
+    /**
+     * Generates a random float between 0 (inclusive) and 1 (exclusive).
+     *
+     * @example
+     * randomizer.next() // 0.3404027920160495
+     * randomizer.next() // 0.929890375900335
+     * randomizer.next() // 0.5866362918861691
+     *
+     * @since 8.2.0
+     */
+    next(): number;
+    /**
+     * Sets the seed to use.
+     *
+     * @param seed The seed to use.
+     *
+     * @example
+     * // Random seeds
+     * randomizer.seed(Date.now() ^ (Math.random() * 0x100000000));
+     * // Fixed seeds (for reproducibility)
+     * randomizer.seed(42);
+     * randomizer.seed([42, 13.37]);
+     *
+     * @since 8.2.0
+     */
+    seed(seed: number | number[]): void;
+}