toosoon-prng 1.1.0 → 1.2.1

package/lib/controllers.js

@@ -1,4 +1,3 @@
-"use strict";
 var __extends = (this && this.__extends) || (function () {
     var extendStatics = function (d, b) {
         extendStatics = Object.setPrototypeOf ||
@@ -14,23 +13,18 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WeightsGroupController = exports.ObjectPropertyGroupController = exports.ItemGroupController = exports.HexColorGroupController = exports.IntGroupController = exports.FloatGroupController = exports.SignGroupController = exports.BooleanGroupController = exports.WeightsController = exports.ObjectPropertyController = exports.ItemController = exports.HexColorController = exports.IntController = exports.FloatController = exports.SignController = exports.BooleanController = void 0;
-var prng_1 = __importDefault(require("./prng"));
+import prng from './prng';
 // *********************
 // Abstract controllers
 // *********************
 var BasePRNGController = /** @class */ (function () {
     function BasePRNGController(seed) {
         this.seed = seed;
-        prng_1.default.addController(this);
+        prng.addController(this);
     }
     BasePRNGController.prototype.dispose = function () {
         var _a;
-        prng_1.default.removeController(this);
+        prng.removeController(this);
         (_a = this.gui) === null || _a === void 0 ? void 0 : _a.destroy();
     };
     return BasePRNGController;
@@ -40,7 +34,7 @@ var BasePRNGGroupController = /** @class */ (function () {
         this.controllers = [];
         this.seed = seed;
     }
-    BasePRNGGroupController.prototype.addGui = function (gui, min, max, step) {
+    BasePRNGGroupController.prototype.addGUI = function (gui, min, max, step) {
         this.gui = gui.addFolder(this.seed).close();
         this.guiArgs = { min: min, max: max, step: step };
         return this.gui;
@@ -51,7 +45,7 @@ var BasePRNGGroupController = /** @class */ (function () {
             controller = this.createController(index);
             if (this.gui) {
                 controller
-                    .addGui(this.gui, this.guiArgs.min, this.guiArgs.max, this.guiArgs.step)
+                    .addGUI(this.gui, this.guiArgs.min, this.guiArgs.max, this.guiArgs.step)
                     .name("".concat(this.seed, "-").concat(index));
             }
             this.controllers[index] = controller;
@@ -78,19 +72,19 @@ var BooleanController = /** @class */ (function (_super) {
         _this.value = _this.getValue();
         return _this;
     }
-    BooleanController.prototype.addGui = function (gui) {
+    BooleanController.prototype.addGUI = function (gui) {
         this.gui = gui.add(this, 'value').name(this.seed);
         return this.gui;
     };
     BooleanController.prototype.getValue = function () {
         var _a;
-        this.value = prng_1.default.randomBoolean(this.seed, this.probability);
+        this.value = prng.randomBoolean(this.seed, this.probability);
         (_a = this.gui) === null || _a === void 0 ? void 0 : _a.updateDisplay();
         return this.value;
     };
     return BooleanController;
 }(BasePRNGController));
-exports.BooleanController = BooleanController;
+export { BooleanController };
 var SignController = /** @class */ (function (_super) {
     __extends(SignController, _super);
     function SignController(seed, probability) {
@@ -100,19 +94,19 @@ var SignController = /** @class */ (function (_super) {
         _this.value = _this.getValue();
         return _this;
     }
-    SignController.prototype.addGui = function (gui) {
+    SignController.prototype.addGUI = function (gui) {
         this.gui = gui.add(this, 'value', [-1, 1]).name(this.seed);
         return this.gui;
     };
     SignController.prototype.getValue = function () {
         var _a;
-        this.value = prng_1.default.randomSign(this.seed, this.probability);
+        this.value = prng.randomSign(this.seed, this.probability);
         (_a = this.gui) === null || _a === void 0 ? void 0 : _a.updateDisplay();
         return this.value;
     };
     return SignController;
 }(BasePRNGController));
-exports.SignController = SignController;
+export { SignController };
 var FloatController = /** @class */ (function (_super) {
     __extends(FloatController, _super);
     function FloatController(seed, min, max) {
@@ -124,43 +118,43 @@ var FloatController = /** @class */ (function (_super) {
         _this.value = _this.getValue();
         return _this;
     }
-    FloatController.prototype.addGui = function (gui, min, max, step) {
+    FloatController.prototype.addGUI = function (gui, min, max, step) {
         if (step === void 0) { step = 0.01; }
         this.gui = gui.add(this, 'value', min, max, step).name(this.seed);
         return this.gui;
     };
     FloatController.prototype.getValue = function () {
         var _a;
-        this.value = prng_1.default.randomFloat(this.seed, this.min, this.max);
+        this.value = prng.randomFloat(this.seed, this.min, this.max);
         (_a = this.gui) === null || _a === void 0 ? void 0 : _a.updateDisplay();
         return this.value;
     };
     return FloatController;
 }(BasePRNGController));
-exports.FloatController = FloatController;
+export { FloatController };
 var IntController = /** @class */ (function (_super) {
     __extends(IntController, _super);
     function IntController(seed, min, max) {
         var _this = _super.call(this, seed) || this;
         _this.min = min;
         _this.max = max;
-        _this.value = prng_1.default.randomInt(_this.seed, min, max);
+        _this.value = prng.randomInt(_this.seed, min, max);
         return _this;
     }
-    IntController.prototype.addGui = function (gui, min, max, step) {
+    IntController.prototype.addGUI = function (gui, min, max, step) {
         if (step === void 0) { step = 1; }
         this.gui = gui.add(this, 'value', min, max, step).name(this.seed);
         return this.gui;
     };
     IntController.prototype.getValue = function () {
         var _a;
-        this.value = prng_1.default.randomInt(this.seed, this.min, this.max);
+        this.value = prng.randomInt(this.seed, this.min, this.max);
         (_a = this.gui) === null || _a === void 0 ? void 0 : _a.updateDisplay();
         return this.value;
     };
     return IntController;
 }(BasePRNGController));
-exports.IntController = IntController;
+export { IntController };
 var HexColorController = /** @class */ (function (_super) {
     __extends(HexColorController, _super);
     function HexColorController(seed) {
@@ -168,19 +162,19 @@ var HexColorController = /** @class */ (function (_super) {
         _this.value = _this.getValue();
         return _this;
     }
-    HexColorController.prototype.addGui = function (gui) {
+    HexColorController.prototype.addGUI = function (gui) {
         this.gui = gui.addColor(this, 'value').name(this.seed);
         return this.gui;
     };
     HexColorController.prototype.getValue = function () {
         var _a;
-        this.value = prng_1.default.randomHexColor(this.seed);
+        this.value = prng.randomHexColor(this.seed);
         (_a = this.gui) === null || _a === void 0 ? void 0 : _a.updateDisplay();
         return this.value;
     };
     return HexColorController;
 }(BasePRNGController));
-exports.HexColorController = HexColorController;
+export { HexColorController };
 var ItemController = /** @class */ (function (_super) {
     __extends(ItemController, _super);
     function ItemController(seed, items) {
@@ -189,19 +183,19 @@ var ItemController = /** @class */ (function (_super) {
         _this.value = _this.getValue();
         return _this;
     }
-    ItemController.prototype.addGui = function (gui) {
+    ItemController.prototype.addGUI = function (gui) {
         this.gui = gui.add(this, 'value', this.items).name(this.seed);
         return this.gui;
     };
     ItemController.prototype.getValue = function () {
         var _a;
-        this.value = prng_1.default.randomItem(this.seed, this.items);
+        this.value = prng.randomItem(this.seed, this.items);
         (_a = this.gui) === null || _a === void 0 ? void 0 : _a.updateDisplay();
         return this.value;
     };
     return ItemController;
 }(BasePRNGController));
-exports.ItemController = ItemController;
+export { ItemController };
 var ObjectPropertyController = /** @class */ (function (_super) {
     __extends(ObjectPropertyController, _super);
     function ObjectPropertyController(seed, object) {
@@ -210,19 +204,19 @@ var ObjectPropertyController = /** @class */ (function (_super) {
         _this.value = _this.getValue();
         return _this;
     }
-    ObjectPropertyController.prototype.addGui = function (gui) {
+    ObjectPropertyController.prototype.addGUI = function (gui) {
         this.gui = gui.add(this, 'value', this.object).name(this.seed);
         return this.gui;
     };
     ObjectPropertyController.prototype.getValue = function () {
         var _a;
-        this.value = prng_1.default.randomObjectProperty(this.seed, this.object);
+        this.value = prng.randomObjectProperty(this.seed, this.object);
         (_a = this.gui) === null || _a === void 0 ? void 0 : _a.updateDisplay();
         return this.value;
     };
     return ObjectPropertyController;
 }(BasePRNGController));
-exports.ObjectPropertyController = ObjectPropertyController;
+export { ObjectPropertyController };
 var WeightsController = /** @class */ (function (_super) {
     __extends(WeightsController, _super);
     function WeightsController(seed, items) {
@@ -232,7 +226,7 @@ var WeightsController = /** @class */ (function (_super) {
         _this.value = _this.getValue();
         return _this;
     }
-    WeightsController.prototype.addGui = function (gui) {
+    WeightsController.prototype.addGUI = function (gui) {
         this.gui = gui
             .add(this, 'value', this.items.map(function (item) { return item.value; }))
             .name(this.seed);
@@ -240,14 +234,14 @@ var WeightsController = /** @class */ (function (_super) {
     };
     WeightsController.prototype.getValue = function () {
         var _a;
-        var index = prng_1.default.randomIndex(this.seed, this.weights);
+        var index = prng.randomIndex(this.seed, this.weights);
         this.value = this.items[index].value;
         (_a = this.gui) === null || _a === void 0 ? void 0 : _a.updateDisplay();
         return this.value;
     };
     return WeightsController;
 }(BasePRNGController));
-exports.WeightsController = WeightsController;
+export { WeightsController };
 // *********************
 // Group Controllers
 // *********************
@@ -264,7 +258,7 @@ var BooleanGroupController = /** @class */ (function (_super) {
     };
     return BooleanGroupController;
 }(BasePRNGGroupController));
-exports.BooleanGroupController = BooleanGroupController;
+export { BooleanGroupController };
 var SignGroupController = /** @class */ (function (_super) {
     __extends(SignGroupController, _super);
     function SignGroupController(seed, probability) {
@@ -278,7 +272,7 @@ var SignGroupController = /** @class */ (function (_super) {
     };
     return SignGroupController;
 }(BasePRNGGroupController));
-exports.SignGroupController = SignGroupController;
+export { SignGroupController };
 var FloatGroupController = /** @class */ (function (_super) {
     __extends(FloatGroupController, _super);
     function FloatGroupController(seed, min, max) {
@@ -293,7 +287,7 @@ var FloatGroupController = /** @class */ (function (_super) {
     };
     return FloatGroupController;
 }(BasePRNGGroupController));
-exports.FloatGroupController = FloatGroupController;
+export { FloatGroupController };
 var IntGroupController = /** @class */ (function (_super) {
     __extends(IntGroupController, _super);
     function IntGroupController(seed, min, max) {
@@ -308,7 +302,7 @@ var IntGroupController = /** @class */ (function (_super) {
     };
     return IntGroupController;
 }(BasePRNGGroupController));
-exports.IntGroupController = IntGroupController;
+export { IntGroupController };
 var HexColorGroupController = /** @class */ (function (_super) {
     __extends(HexColorGroupController, _super);
     function HexColorGroupController() {
@@ -324,7 +318,7 @@ var HexColorGroupController = /** @class */ (function (_super) {
     };
     return HexColorGroupController;
 }(BasePRNGGroupController));
-exports.HexColorGroupController = HexColorGroupController;
+export { HexColorGroupController };
 var ItemGroupController = /** @class */ (function (_super) {
     __extends(ItemGroupController, _super);
     function ItemGroupController(seed, items) {
@@ -338,7 +332,7 @@ var ItemGroupController = /** @class */ (function (_super) {
     };
     return ItemGroupController;
 }(BasePRNGGroupController));
-exports.ItemGroupController = ItemGroupController;
+export { ItemGroupController };
 var ObjectPropertyGroupController = /** @class */ (function (_super) {
     __extends(ObjectPropertyGroupController, _super);
     function ObjectPropertyGroupController(seed, object) {
@@ -352,7 +346,7 @@ var ObjectPropertyGroupController = /** @class */ (function (_super) {
     };
     return ObjectPropertyGroupController;
 }(BasePRNGGroupController));
-exports.ObjectPropertyGroupController = ObjectPropertyGroupController;
+export { ObjectPropertyGroupController };
 var WeightsGroupController = /** @class */ (function (_super) {
     __extends(WeightsGroupController, _super);
     function WeightsGroupController(seed, items) {
@@ -366,4 +360,4 @@ var WeightsGroupController = /** @class */ (function (_super) {
     };
     return WeightsGroupController;
 }(BasePRNGGroupController));
-exports.WeightsGroupController = WeightsGroupController;
+export { WeightsGroupController };

package/lib/index.d.ts

@@ -1,4 +1,3 @@
 export { BooleanController, SignController, IntController, FloatController, HexColorController, ItemController, ObjectPropertyController, WeightsController, BooleanGroupController, SignGroupController, IntGroupController, FloatGroupController, HexColorGroupController, ItemGroupController, ObjectPropertyGroupController, WeightsGroupController } from './controllers';
 export type { PRNGController, PRNGGroupController } from './controllers';
-export { default } from './prng';
-export type * from './prng';
+export { default, Algorithm } from './prng';

package/lib/index.js

@@ -1,25 +1,2 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = exports.WeightsGroupController = exports.ObjectPropertyGroupController = exports.ItemGroupController = exports.HexColorGroupController = exports.FloatGroupController = exports.IntGroupController = exports.SignGroupController = exports.BooleanGroupController = exports.WeightsController = exports.ObjectPropertyController = exports.ItemController = exports.HexColorController = exports.FloatController = exports.IntController = exports.SignController = exports.BooleanController = void 0;
-var controllers_1 = require("./controllers");
-Object.defineProperty(exports, "BooleanController", { enumerable: true, get: function () { return controllers_1.BooleanController; } });
-Object.defineProperty(exports, "SignController", { enumerable: true, get: function () { return controllers_1.SignController; } });
-Object.defineProperty(exports, "IntController", { enumerable: true, get: function () { return controllers_1.IntController; } });
-Object.defineProperty(exports, "FloatController", { enumerable: true, get: function () { return controllers_1.FloatController; } });
-Object.defineProperty(exports, "HexColorController", { enumerable: true, get: function () { return controllers_1.HexColorController; } });
-Object.defineProperty(exports, "ItemController", { enumerable: true, get: function () { return controllers_1.ItemController; } });
-Object.defineProperty(exports, "ObjectPropertyController", { enumerable: true, get: function () { return controllers_1.ObjectPropertyController; } });
-Object.defineProperty(exports, "WeightsController", { enumerable: true, get: function () { return controllers_1.WeightsController; } });
-Object.defineProperty(exports, "BooleanGroupController", { enumerable: true, get: function () { return controllers_1.BooleanGroupController; } });
-Object.defineProperty(exports, "SignGroupController", { enumerable: true, get: function () { return controllers_1.SignGroupController; } });
-Object.defineProperty(exports, "IntGroupController", { enumerable: true, get: function () { return controllers_1.IntGroupController; } });
-Object.defineProperty(exports, "FloatGroupController", { enumerable: true, get: function () { return controllers_1.FloatGroupController; } });
-Object.defineProperty(exports, "HexColorGroupController", { enumerable: true, get: function () { return controllers_1.HexColorGroupController; } });
-Object.defineProperty(exports, "ItemGroupController", { enumerable: true, get: function () { return controllers_1.ItemGroupController; } });
-Object.defineProperty(exports, "ObjectPropertyGroupController", { enumerable: true, get: function () { return controllers_1.ObjectPropertyGroupController; } });
-Object.defineProperty(exports, "WeightsGroupController", { enumerable: true, get: function () { return controllers_1.WeightsGroupController; } });
-var prng_1 = require("./prng");
-Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(prng_1).default; } });
+export { BooleanController, SignController, IntController, FloatController, HexColorController, ItemController, ObjectPropertyController, WeightsController, BooleanGroupController, SignGroupController, IntGroupController, FloatGroupController, HexColorGroupController, ItemGroupController, ObjectPropertyGroupController, WeightsGroupController } from './controllers';
+export { default, Algorithm } from './prng';

package/lib/prng.d.ts

@@ -1,30 +1,120 @@
 import { PRNGController } from './controllers';
-export declare enum PRNGMethod {
+export declare enum Algorithm {
     jsf32 = "jsf32",
     mulberry32 = "mulberry32",
     sfc32 = "sfc32",
+    splitmix32 = "splitmix32",// Default
     xoshiro128ss = "xoshiro128**"
 }
+/**
+ * PRNG class
+ *
+ * @class PRNG
+ */
 declare class PRNG {
     seed: string;
-    method: PRNGMethod;
+    algorithm: Algorithm;
     controllers: PRNGController[];
-    constructor(seed?: string);
+    /**
+     * Add a controller to this PRNG
+     *
+     * @param {PRNGController} controller
+     */
     addController(controller: PRNGController): void;
+    /**
+     * Remove a controller from this PRNG
+     *
+     * @param {PRNGController} controller
+     */
     removeController(controller: PRNGController): void;
+    /**
+     * Set this PRNG seed
+     *
+     * @param {string} seed
+     */
     setSeed(seed: string): void;
-    setMethod(method: PRNGMethod): void;
+    /**
+     * Set this PRNG algorithm for generating pseudo-random values
+     *
+     * @param {Algorithm} algorithm Algorithm name
+     */
+    setAlgorithm(algorithm: Algorithm): void;
+    /**
+     * Generate a pseudo-random number in the interval [0, 1]
+     * PRNG equivalent of `Math.random()`
+     *
+     * @param {string} seed
+     * @returns {number}
+     */
     random(seed: string): number;
+    /**
+     * Generate a pseudo-random boolean (true or false)
+     *
+     * @param {string} seed
+     * @param {number} [probability=0.5] Probability to get `true`
+     * @returns {boolean} Either `true` or `false`
+     */
     randomBoolean(seed: string, probability?: number): boolean;
+    /**
+     * Generate a pseudo-random sign (1 or -1)
+     *
+     * @param {string} seed
+     * @param {number} [probability=0.5] Probability to get 1
+     * @returns {number} Either 1 or -1
+     */
     randomSign(seed: string, probability?: number): number;
+    /**
+     * Generate a pseudo-random floating-point number within a specified range
+     *
+     * @param {string} seed
+     * @param {number} [min=0]       Minimum boundary
+     * @param {number} [max=1]       Maximum boundary
+     * @param {number} [precision=2] Number of digits after the decimal point
+     * @returns {number} Generated float
+     */
     randomFloat(seed: string, min?: number, max?: number, precision?: number): number;
+    /**
+     * Generate a pseudo-random integer number within a specified range
+     *
+     * @param {string} seed
+     * @param {number} min Minimum boundary
+     * @param {number} max Maximum boundary
+     * @returns {number} Generated integer
+     */
     randomInt(seed: string, min: number, max: number): number;
+    /**
+     * Generate a pseudo-random hexadecimal color
+     *
+     * @param {string} seed
+     * @returns {string} Generated hexadecimal color
+     */
     randomHexColor(seed: string): string;
-    randomItem<T = unknown>(seed: string, array?: T[]): T | undefined;
+    /**
+     * Pick a pseudo-random item from a given array
+     *
+     * @param {string} seed
+     * @param {T[]} array Array to pick the item from
+     * @returns {T|undefined} Random item picked
+     */
+    randomItem<T = unknown>(seed: string, array: T[]): T | undefined;
+    /**
+     * Pick a pseudo-random property value from a given object
+     *
+     * @param {string} seed
+     * @param {object} object Object to pick the property from
+     * @returns {T|undefined} Random item picked
+     */
     randomObjectProperty<T = unknown>(seed: string, object: {
         [key: string]: T;
     }): T | undefined;
-    randomIndex(seed: string, weights?: number[]): number;
+    /**
+     * Select a pseudo-random index from an array of weighted items
+     *
+     * @param {string} seed
+     * @param {number[]} weights Array of weights
+     * @returns {number} Random index based on weights
+     */
+    randomIndex(seed: string, weights: number[]): number;
 }
 declare const prng: PRNG;
 export default prng;