@kikiutils/shared 9.0.0

package/src/random.ts

@@ -0,0 +1,31 @@
+/**
+ * Generates a value using a provided generator function, where the input length
+ * is determined by two levels of nested random ranges:
+ *
+ * 1. First, a random number (`innerMin`) is chosen between `minMin` and `minMax`.
+ * 2. Then, a final length is chosen between `Math.max(innerMin, maxMin)` and `maxMax`.
+ * 3. The generator is called with the final length and its result is returned.
+ *
+ * This function supports any return type by using a generic type parameter.
+ *
+ * @typeParam T - The return type of the generator function.
+ *
+ * @param generator - A function that accepts a length and returns a value of type T.
+ * @param minMin - Lower bound of the first random range.
+ * @param minMax - Upper bound of the first random range.
+ * @param maxMin - Lower bound of the second random range.
+ * @param maxMax - Upper bound of the second random range.
+ * @returns The result of the generator function using the computed final length.
+ */
+export function generateWithNestedRandomLength<T = string>(
+    generator: (length: number) => T,
+    minMin: number,
+    minMax: number,
+    maxMin: number,
+    maxMax: number,
+) {
+    const random = (min: number, max: number) => Math.floor(Math.random() * (max - min + 1)) + min;
+    const innerMin = random(minMin, minMax);
+    const finalLength = random(Math.max(innerMin, maxMin), maxMax);
+    return generator(finalLength);
+}

package/src/string.ts

@@ -0,0 +1,49 @@
+export type RandomStringMode =
+  | 'alphabetic'
+  | 'alphanumeric'
+  | 'lowercase'
+  | 'lowercase-numeric'
+  | 'numeric'
+  | 'uppercase'
+  | 'uppercase-numeric';
+
+const DIGITS = '0123456789';
+const LOWERCASE = 'abcdefghijklmnopqrstuvwxyz';
+const UPPERCASE = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
+const CHARSETS: Record<RandomStringMode, string> = {
+    'alphabetic': LOWERCASE + UPPERCASE,
+    'alphanumeric': DIGITS + LOWERCASE + UPPERCASE,
+    'lowercase': LOWERCASE,
+    'lowercase-numeric': DIGITS + LOWERCASE,
+    'numeric': DIGITS,
+    'uppercase': UPPERCASE,
+    'uppercase-numeric': DIGITS + UPPERCASE,
+};
+
+/**
+ * Generates a random string of a given length using a specified character set.
+ *
+ * @param {number} length - The length of the string to generate. Must be a positive integer.
+ * @param {RandomStringMode} [mode] - The character set to use.
+ * @returns {string} The generated random string.
+ *
+ * @throws {Error} If the length is not a positive integer or the mode is unsupported.
+ *
+ * @example
+ * ```typescript
+ * import { randomString } from '@kikiutils/shared/string';
+ *
+ * console.log(randomString(8)); // e.g. 'aZbXwTyQ' (alphabetic)
+ * console.log(randomString(6, 'numeric')); // e.g. '402398'
+ * console.log(randomString(10, 'alphanumeric')); // e.g. 'a9Z4pQ8xY2'
+ * ```
+ */
+export function randomString(length: number, mode: RandomStringMode = 'alphabetic') {
+    if (!Number.isInteger(length) || length <= 0) {
+        throw new Error(`Invalid length: ${length}. Must be a positive integer.`);
+    }
+
+    const charset = CHARSETS[mode];
+    if (!charset) throw new Error(`Unsupported mode: ${mode}`);
+    return Array.from({ length }, () => charset[Math.floor(Math.random() * charset.length)]).join('');
+}