@kottetall/random 0.0.2 → 0.0.4

package/lib/constants/random.constant.d.ts

@@ -0,0 +1,13 @@
+export declare const casing: {
+    readonly LOWER: "lower";
+    readonly UPPER: "upper";
+};
+export declare const booleanString: {
+    readonly TRUE_LOWERCASE: "true";
+    readonly FALSE_LOWERCASE: "false";
+    readonly TRUE_UPPERCASE: "TRUE";
+    readonly FALSE_UPPERCASE: "FALSE";
+};
+export declare const falsyValues: readonly [null, undefined, false, number, 0, 0, 0n, ""];
+export declare const truthyValues: readonly [true, {}, readonly [], 42, "0", "false", Date, -42, 12n, 3.14, -3.14, number, number];
+//# sourceMappingURL=random.constant.d.ts.map

package/lib/constants/random.constant.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"random.constant.d.ts","sourceRoot":"","sources":["../../src/constants/random.constant.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;;;CAGT,CAAC;AAEX,eAAO,MAAM,aAAa;;;;;CAKhB,CAAC;AAEX,eAAO,MAAM,WAAW,yDAUd,CAAC;AAEX,eAAO,MAAM,YAAY,iGAef,CAAC"}

package/lib/constants/random.constant.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.truthyValues = exports.falsyValues = exports.booleanString = exports.casing = void 0;
+exports.casing = {
+    LOWER: "lower",
+    UPPER: "upper",
+};
+exports.booleanString = {
+    TRUE_LOWERCASE: "true",
+    FALSE_LOWERCASE: "false",
+    TRUE_UPPERCASE: "TRUE",
+    FALSE_UPPERCASE: "FALSE",
+};
+exports.falsyValues = [
+    // Based on https://developer.mozilla.org/en-US/docs/Glossary/Falsy
+    null,
+    undefined,
+    false,
+    NaN,
+    0,
+    -0,
+    0n,
+    "",
+];
+exports.truthyValues = [
+    // Based on https://developer.mozilla.org/en-US/docs/Glossary/Truthy
+    true,
+    {},
+    [],
+    42,
+    "0",
+    "false",
+    new Date(),
+    -42,
+    12n,
+    3.14,
+    -3.14,
+    Infinity,
+    -Infinity,
+];

package/lib/index.d.ts

@@ -1,7 +1,51 @@
+import { Casing } from "./types/random.type";
+import { ObjectValues } from "./types/utils.type";
 export declare class Random {
     static intBetween(min: number, max: number): number;
     static boolean(): boolean;
+    /**
+     * Returns "true" or "false" in lowercase unless casing has been specified
+     * @param booleanCasing
+     * @returns
+     */
+    static booleanString(booleanCasing?: Casing): string;
+    /**
+     * Returns 1 or 0
+     * @returns
+     */
+    static booleanInt(): 0 | 1;
+    /**
+     * Returns a falsy value
+     * @returns
+     */
+    static falsy(): number | false | "" | 0n | null | undefined;
+    /**
+     * Returns a truthy value
+     * @returns
+     */
+    static truthy(): number | true | "false" | readonly [] | "0" | Date | 12n | {};
+    /**
+     * Returns a value from the provided array
+     * @param source
+     * @returns
+     */
     static fromArray<T>(source: T[]): T;
-    static letter(casing: "ALL" | "UPPERCASE" | "LOWERCASE"): string;
+    /**
+     * Returns a value from the provided object
+     * @param source
+     * @returns
+     */
+    static fromObject<T extends Object>(source: T): ObjectValues<T>;
+    /**
+     * Returns a letter, can be either lowercase or uppercase unless specified
+     * @param letterCasing
+     * @returns
+     */
+    static letter(letterCasing?: Casing): string;
+    /**
+     * A wrapper for crypto.randomUUID
+     * @returns
+     */
+    static uuid(): `${string}-${string}-${string}-${string}-${string}`;
 }
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,qBAAa,MAAM;IACjB,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAO1C,MAAM,CAAC,OAAO;IAId,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC;IAMnC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,GAAG,WAAW,GAAG,WAAW;CAWxD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAWA,OAAO,EAAiB,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAqB,MAAM,oBAAoB,CAAC;AAErE,qBAAa,MAAM;IACjB,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAY1C,MAAM,CAAC,OAAO;IAId;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE,MAAM;IAQ3C;;;OAGG;IACH,MAAM,CAAC,UAAU;IAIjB;;;OAGG;IACH,MAAM,CAAC,KAAK;IAIZ;;;OAGG;IACH,MAAM,CAAC,MAAM;IAIb;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC;IAMnC;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC;IAK/D;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,MAAM;IAYnC;;;OAGG;IACH,MAAM,CAAC,IAAI;CAGZ"}

package/lib/index.js

@@ -2,9 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Random = void 0;
 const chars_constant_1 = require("./constants/chars.constant");
+const random_constant_1 = require("./constants/random.constant");
 class Random {
     static intBetween(min, max) {
         // From https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/random
+        if (max < min) {
+            const oldMin = min;
+            min = max;
+            max = oldMin;
+        }
         const minCeiled = Math.ceil(min);
         const maxFloored = Math.floor(max);
         return Math.floor(Math.random() * (maxFloored - minCeiled + 1) + minCeiled);
@@ -12,20 +18,80 @@ class Random {
     static boolean() {
         return Math.random() < 0.5;
     }
+    /**
+     * Returns "true" or "false" in lowercase unless casing has been specified
+     * @param booleanCasing
+     * @returns
+     */
+    static booleanString(booleanCasing) {
+        if (!booleanCasing)
+            booleanCasing = random_constant_1.casing.LOWER;
+        const result = Random.boolean()
+            ? random_constant_1.booleanString.TRUE_LOWERCASE
+            : random_constant_1.booleanString.FALSE_UPPERCASE;
+        return booleanCasing === random_constant_1.casing.LOWER ? result : result.toUpperCase();
+    }
+    /**
+     * Returns 1 or 0
+     * @returns
+     */
+    static booleanInt() {
+        return Random.boolean() ? 1 : 0;
+    }
+    /**
+     * Returns a falsy value
+     * @returns
+     */
+    static falsy() {
+        return Random.fromArray([...random_constant_1.falsyValues]);
+    }
+    /**
+     * Returns a truthy value
+     * @returns
+     */
+    static truthy() {
+        return Random.fromArray([...random_constant_1.truthyValues]);
+    }
+    /**
+     * Returns a value from the provided array
+     * @param source
+     * @returns
+     */
     static fromArray(source) {
         const maxIndex = source.length - 1;
         const randomIndex = Random.intBetween(0, maxIndex);
         return source[randomIndex];
     }
-    static letter(casing) {
+    /**
+     * Returns a value from the provided object
+     * @param source
+     * @returns
+     */
+    static fromObject(source) {
+        const sourceValues = Object.values(source);
+        return Random.fromArray(sourceValues);
+    }
+    /**
+     * Returns a letter, can be either lowercase or uppercase unless specified
+     * @param letterCasing
+     * @returns
+     */
+    static letter(letterCasing) {
         const source = [];
-        if (casing === "LOWERCASE" || casing === "ALL") {
+        if (letterCasing === random_constant_1.casing.LOWER || !letterCasing) {
             source.push(...chars_constant_1.alphabetLowercase);
         }
-        if (casing === "UPPERCASE" || casing === "ALL") {
+        if (letterCasing === random_constant_1.casing.UPPER || !letterCasing) {
             source.push(...chars_constant_1.alphabetUppercase);
         }
         return Random.fromArray(source);
     }
+    /**
+     * A wrapper for crypto.randomUUID
+     * @returns
+     */
+    static uuid() {
+        return crypto.randomUUID();
+    }
 }
 exports.Random = Random;

package/lib/types/random.type.d.ts

@@ -0,0 +1,4 @@
+import { booleanString, casing } from "../constants/random.constant";
+export type Casing = (typeof casing)[keyof typeof casing];
+export type BooleanString = (typeof booleanString)[keyof typeof booleanString];
+//# sourceMappingURL=random.type.d.ts.map

package/lib/types/random.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"random.type.d.ts","sourceRoot":"","sources":["../../src/types/random.type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAErE,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,MAAM,CAAC,CAAC,MAAM,OAAO,MAAM,CAAC,CAAC;AAE1D,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC"}

package/lib/types/random.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/utils.type.d.ts

@@ -0,0 +1,3 @@
+export type ObjectValues<T extends Object> = T[keyof T];
+export type ObjectValuesArray<T extends Object> = ObjectValues<T>[];
+//# sourceMappingURL=utils.type.d.ts.map

package/lib/types/utils.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.type.d.ts","sourceRoot":"","sources":["../../src/types/utils.type.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAExD,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,MAAM,IAAI,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC"}

package/lib/types/utils.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kottetall/random",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -14,7 +14,20 @@
     "type": "git",
     "url": "git+https://github.com/kottetall/random.git"
   },
-  "keywords": [],
+  "keywords": [
+    "random",
+    "random-utils",
+    "utility",
+    "utils",
+    "helpers",
+    "javascript",
+    "node",
+    "array",
+    "object",
+    "picker",
+    "random-picker",
+    "random-value"
+  ],
   "author": "",
   "license": "ISC",
   "type": "commonjs",

package/readme.md

@@ -0,0 +1,56 @@
+# Random
+
+A lightweight utility library for generating pseudo-random values in JavaScript based of `Math.random()`.
+
+This package was originally created for personal use in my own projects, but it is published as an open tool that anyone can use. It focuses on simple, practical helpers for working with randomness, such as picking random values from arrays or objects.
+
+## Features
+
+- Get a random value from an array
+- Get a random value from an object
+- Get a random letter
+- Get a random truthy/falsy value
+- And more...
+- Simple and minimal API
+- Zero dependencies
+- Designed for everyday use in JavaScript and Node.js projects
+
+## Installation
+
+```bash
+npm install @kottetall/random
+```
+
+## Usage
+
+### Random value from an array
+
+```js
+import { Random } from "@kottetall/random";
+
+const items = ["apple", "banana", "orange"];
+const result = Random.fromArray(items);
+
+console.log(result);
+```
+
+### Random value from an object
+
+```js
+import { Random } from "@kottetall/random";
+
+const obj = {
+  a: 1,
+  b: 2,
+  c: 3,
+};
+
+const result = Random.fromObject(obj);
+
+console.log(result);
+```
+
+## Why this package?
+
+Sometimes you just need small, reusable helpers instead of rewriting the same logic in every project.
+This package aims to provide clean and simple functions for common random-related tasks.