plotboilerplate 1.27.1 → 1.28.0

package/src/_cjs/utils/io/FileDrop.js

@@ -0,0 +1,177 @@
+"use strict";
+/**
+ * A basic IO handler for file drop (Drag-and-drop).
+ *
+ * Example use:
+ * ```javascript
+ *  var body = document.getElememtByTagName("body")[0];
+ *  var fileDrop = new FileDrop(body);
+ *    fileDrop.onFileJSONDropped(function (jsonObject) {
+ *    console.log("jsonObject", jsonObject);
+ *  });
+ * ```
+ *
+ * @author   Ikaros Kappler
+ * @date     2021-10-13
+ * @modified 2022-01-31 (ported from the ngdg project, then generalized)
+ * @modified 2023-01-03 Fixing some minor type issues and adding SVG reading capabilities.
+ * @version  2.1.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileDrop = void 0;
+var FileDrop = /** @class */ (function () {
+    /**
+     *
+     * @param {HTMLElement} element - The element you wish to operate as the drop zone (like <body/>).
+     */
+    function FileDrop(element) {
+        var _this = this;
+        /**
+         * Internally handle a drop event.
+         *
+         * @param {DragEvent} event
+         * @returns {void}
+         */
+        this.handleDropEvent = function (event) {
+            event.preventDefault();
+            event.stopPropagation();
+            _this.element.style.opacity = "1.0";
+            if (!event.dataTransfer || !event.dataTransfer.files || event.dataTransfer.files.length === 0) {
+                // No files were dropped
+                return;
+            }
+            if (event.dataTransfer.files.length > 1) {
+                // Multiple file drop is not nupported
+                return;
+            }
+            // if (!this.fileDroppedCallbackJSON) {
+            //   // No handling callback defined.
+            //   return;
+            // }
+            if (event.dataTransfer.files[0]) {
+                var file_1 = event.dataTransfer.files[0];
+                // console.log("file", file);
+                if (file_1.type.match(/json.*/) && _this.fileDroppedCallbackJSON !== null) {
+                    var reader = new FileReader();
+                    reader.onload = function (readEvent) {
+                        if (!readEvent.target) {
+                            console.warn("Cannot process JSON ProgressEvent data: target is null.");
+                            return;
+                        }
+                        // Finished reading file data.
+                        var jsonObject = JSON.parse(readEvent.target.result);
+                        // TODO: what happens on fail?
+                        _this.fileDroppedCallbackJSON && _this.fileDroppedCallbackJSON(jsonObject);
+                    };
+                    reader.readAsText(file_1); // start reading the file data.
+                }
+                else if (file_1.type.match(/text\/plain.*/) && _this.fileDroppedCallbackText) {
+                    var reader = new FileReader();
+                    reader.onload = function (readEvent) {
+                        if (!readEvent.target) {
+                            console.warn("Cannot process Text ProgressEvent data: target is null.");
+                            return;
+                        }
+                        // Finished reading file data.
+                        _this.fileDroppedCallbackText && _this.fileDroppedCallbackText(readEvent.target.result);
+                    };
+                    reader.readAsText(file_1); // start reading the file data.
+                }
+                else if (_this.fileDroppedCallbackBinary) {
+                    var reader = new FileReader();
+                    reader.onload = function (readEvent) {
+                        if (!readEvent.target) {
+                            console.warn("Cannot process Binary ProgressEvent data: target is null.");
+                            return;
+                        }
+                        // Finished reading file data.
+                        _this.fileDroppedCallbackBinary &&
+                            _this.fileDroppedCallbackBinary(new Blob([readEvent.target.result]), file_1);
+                    };
+                    reader.readAsBinaryString(file_1); // start reading the file data.
+                }
+                else if (_this.fileDroppedCallbackSVG) {
+                    var reader = new FileReader();
+                    reader.onload = function (readEvent) {
+                        if (!readEvent.target) {
+                            console.warn("Cannot process SVG ProgressEvent data: target is null.");
+                            return;
+                        }
+                        var parser = new DOMParser();
+                        var doc = parser.parseFromString(readEvent.target.result, "image/svg+xml");
+                        // Finished reading file data.
+                        _this.fileDroppedCallbackSVG && _this.fileDroppedCallbackSVG(doc);
+                    };
+                    reader.readAsText(file_1); // start reading the file data.
+                }
+            }
+        };
+        /**
+         * Toggles the drop sensitive element's opacity to 0.5.
+         *
+         * @param {DragEvent} event - The event.
+         */
+        this.handleDragOverEvent = function (event) {
+            event.preventDefault();
+            event.stopPropagation();
+            _this.element.style.opacity = "0.5";
+        };
+        /**
+         * Restored the drop sensitive element's opacity back to 1.0.
+         *
+         * @param {DragEvent} event - The event.
+         */
+        this.handleDragLeaveEvent = function (event) {
+            event.preventDefault();
+            event.stopPropagation();
+            _this.element.style.opacity = "1.0";
+        };
+        this.element = element;
+        // Init the drop listeners
+        element.addEventListener("drop", this.handleDropEvent.bind(this));
+        element.addEventListener("dragover", this.handleDragOverEvent.bind(this));
+        element.addEventListener("dragleave", this.handleDragLeaveEvent.bind(this));
+    }
+    /**
+     * Install the JSON (MIME type json*) file drop callback. Note than only one callback can be installed
+     * in this implementation. Calling this method multiple times will overwrite previously
+     * installed listeners.
+     *
+     * The callback will receive the dropped file content as an object (parsed JSON).
+     *
+     * @param {(data:object)=>void} callback
+     */
+    FileDrop.prototype.onFileJSONDropped = function (callback) {
+        this.fileDroppedCallbackJSON = callback;
+    };
+    /**
+     * Install the text file (MIME type text/plain) drop callback. Note than only one callback can be installed
+     * in this implementation. Calling this method multiple times will overwrite previously
+     * installed listeners.
+     *
+     * The callback will receive the dropped file content as a string.
+     *
+     * @param {(data:object)=>void} callback
+     */
+    FileDrop.prototype.onFileTextDropped = function (callback) {
+        this.fileDroppedCallbackText = callback;
+    };
+    // TODO: docs
+    FileDrop.prototype.onFileSVGDropped = function (callback) {
+        this.fileDroppedCallbackSVG = callback;
+    };
+    FileDrop.prototype.onFileBinaryDropped = function (callback) {
+        this.fileDroppedCallbackBinary = callback;
+    };
+    /**
+     * Removes all listeners (drop, dragover and dragleave).
+     */
+    FileDrop.prototype.destroy = function () {
+        this.element.removeEventListener("drop", this.handleDropEvent);
+        this.element.removeEventListener("dragover", this.handleDragOverEvent);
+        this.element.removeEventListener("dragleave", this.handleDragLeaveEvent);
+    };
+    return FileDrop;
+}());
+exports.FileDrop = FileDrop;
+//# sourceMappingURL=FileDrop.js.map

package/src/_cjs/utils/io/FileDrop.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileDrop.js","sourceRoot":"","sources":["../../../ts/utils/io/FileDrop.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;GAiBG;;;AAOH;IAyCE;;;OAGG;IACH,kBAAY,OAAoB;QAAhC,iBAOC;QAqCD;;;;;WAKG;QACK,oBAAe,GAAG,UAAC,KAAgB;YACzC,KAAK,CAAC,cAAc,EAAE,CAAC;YACvB,KAAK,CAAC,eAAe,EAAE,CAAC;YACxB,KAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC;YAEnC,IAAI,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,IAAI,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC9F,wBAAwB;gBACxB,OAAO;YACT,CAAC;YACD,IAAI,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxC,sCAAsC;gBACtC,OAAO;YACT,CAAC;YACD,uCAAuC;YACvC,qCAAqC;YACrC,YAAY;YACZ,IAAI;YACJ,IAAI,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBAChC,IAAM,MAAI,GAAS,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC/C,6BAA6B;gBAC7B,IAAI,MAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,KAAI,CAAC,uBAAuB,KAAK,IAAI,EAAE,CAAC;oBACvE,IAAI,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;oBAC9B,MAAM,CAAC,MAAM,GAAG,UAAC,SAAoC;wBACnD,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;4BACtB,OAAO,CAAC,IAAI,CAAC,yDAAyD,CAAC,CAAC;4BACxE,OAAO;wBACT,CAAC;wBACD,8BAA8B;wBAC9B,IAAM,UAAU,GAAW,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,MAAgB,CAAC,CAAC;wBACzE,8BAA8B;wBAC9B,KAAI,CAAC,uBAAuB,IAAI,KAAI,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;oBAC3E,CAAC,CAAC;oBACF,MAAM,CAAC,UAAU,CAAC,MAAI,CAAC,CAAC,CAAC,+BAA+B;gBAC1D,CAAC;qBAAM,IAAI,MAAI,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,KAAI,CAAC,uBAAuB,EAAE,CAAC;oBAC5E,IAAI,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;oBAC9B,MAAM,CAAC,MAAM,GAAG,UAAC,SAAoC;wBACnD,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;4BACtB,OAAO,CAAC,IAAI,CAAC,yDAAyD,CAAC,CAAC;4BACxE,OAAO;wBACT,CAAC;wBACD,8BAA8B;wBAC9B,KAAI,CAAC,uBAAuB,IAAI,KAAI,CAAC,uBAAuB,CAAC,SAAS,CAAC,MAAM,CAAC,MAAgB,CAAC,CAAC;oBAClG,CAAC,CAAC;oBACF,MAAM,CAAC,UAAU,CAAC,MAAI,CAAC,CAAC,CAAC,+BAA+B;gBAC1D,CAAC;qBAAM,IAAI,KAAI,CAAC,yBAAyB,EAAE,CAAC;oBAC1C,IAAI,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;oBAC9B,MAAM,CAAC,MAAM,GAAG,UAAC,SAAoC;wBACnD,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;4BACtB,OAAO,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAC;4BAC1E,OAAO;wBACT,CAAC;wBACD,8BAA8B;wBAC9B,KAAI,CAAC,yBAAyB;4BAC5B,KAAI,CAAC,yBAAyB,CAAC,IAAI,IAAI,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAqB,CAAC,CAAC,EAAE,MAAI,CAAC,CAAC;oBAC7F,CAAC,CAAC;oBACF,MAAM,CAAC,kBAAkB,CAAC,MAAI,CAAC,CAAC,CAAC,+BAA+B;gBAClE,CAAC;qBAAM,IAAI,KAAI,CAAC,sBAAsB,EAAE,CAAC;oBACvC,IAAI,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;oBAC9B,MAAM,CAAC,MAAM,GAAG,UAAC,SAAoC;wBACnD,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;4BACtB,OAAO,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;4BACvE,OAAO;wBACT,CAAC;wBACD,IAAM,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;wBAC/B,IAAM,GAAG,GAAG,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,MAAM,CAAC,MAAgB,EAAE,eAAe,CAAC,CAAC;wBAEvF,8BAA8B;wBAC9B,KAAI,CAAC,sBAAsB,IAAI,KAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;oBAClE,CAAC,CAAC;oBACF,MAAM,CAAC,UAAU,CAAC,MAAI,CAAC,CAAC,CAAC,+BAA+B;gBAC1D,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QAEF;;;;WAIG;QACK,wBAAmB,GAAG,UAAC,KAAgB;YAC7C,KAAK,CAAC,cAAc,EAAE,CAAC;YACvB,KAAK,CAAC,eAAe,EAAE,CAAC;YACxB,KAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC;QACrC,CAAC,CAAC;QAEF;;;;WAIG;QACK,yBAAoB,GAAG,UAAC,KAAgB;YAC9C,KAAK,CAAC,cAAc,EAAE,CAAC;YACvB,KAAK,CAAC,eAAe,EAAE,CAAC;YACxB,KAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC;QACrC,CAAC,CAAC;QA/IA,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,0BAA0B;QAC1B,OAAO,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAClE,OAAO,CAAC,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,OAAO,CAAC,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;OAQG;IACH,oCAAiB,GAAjB,UAAkB,QAA8B;QAC9C,IAAI,CAAC,uBAAuB,GAAG,QAAQ,CAAC;IAC1C,CAAC;IAED;;;;;;;;OAQG;IACH,oCAAiB,GAAjB,UAAkB,QAA8B;QAC9C,IAAI,CAAC,uBAAuB,GAAG,QAAQ,CAAC;IAC1C,CAAC;IAED,aAAa;IACb,mCAAgB,GAAhB,UAAiB,QAA6B;QAC5C,IAAI,CAAC,sBAAsB,GAAG,QAAQ,CAAC;IACzC,CAAC;IAED,sCAAmB,GAAnB,UAAoB,QAAgC;QAClD,IAAI,CAAC,yBAAyB,GAAG,QAAQ,CAAC;IAC5C,CAAC;IAwGD;;OAEG;IACH,0BAAO,GAAP;QACE,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC/D,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;QACvE,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,WAAW,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAC3E,CAAC;IACH,eAAC;AAAD,CAAC,AAvMD,IAuMC;AAvMY,4BAAQ"}

package/src/_cjs/utils/lil.gui.arrowbounce.polyfill.js

@@ -0,0 +1,133 @@
+/**
+ * This snippet adds an 'arrowBounce' prototype function to all dat.GUI components.
+ *
+ * It's an adaption of the 'title' polyfill found at
+ *    https://stackoverflow.com/questions/27362914/how-to-add-tooltips-to-dat-gui
+ *    by greginvm
+ *
+ * @author   Ikaros Kappler
+ * @date     2024-06-25 Copied from dat.gui and adapted for lil-gui
+ * version   1.0.0
+ **/
+
+(function () {
+  /* lil.GUI copies the prototype of superclass Controller to all other controllers, so it is not enough to add it only to 
+       the super class as the reference is not maintained */
+  var eachController = function (fnc) {
+    fnc(lil.Controller);
+  };
+
+  var setArrowBounce = function (v, options) {
+    options = options || {};
+    if (typeof options.fadeDelay == "undefined") {
+      options.fadeDelay = 5000;
+    }
+    options.fadeDelay = options.fadeDelay / 1000;
+    var randomkey = "arrowbounce-" + Math.round(Math.random() * Math.pow(2, 16));
+
+    var _self = this;
+    removeElement = function () {
+      _self.domElement.querySelectorAll(".arrowBounce").forEach(function (elem) {
+        elem.parentElement.removeChild(elem);
+      });
+      _self.domElement.style.overflow = "hidden"; // Restore old overflow
+      _self.domElement.style.position = "static";
+    };
+
+    // domElement is the root dom element of each controller
+    if (v) {
+      this.domElement.style.position = "relative";
+      this.domElement.style.overflow = "visible";
+      //this.domElement.style.overflowX = 'visible';
+      //this.domElement.style.overflowY = 'hidden';
+      var node = document.createElement("div");
+      node.style.position = "absolute";
+      // node.style.lineHeight = '24px';
+      node.style.left = 0;
+      node.style.top = 0;
+      node.style.transform = "translateX(-100%)";
+      node.style.height = "100%";
+      node.classList =
+        randomkey + " arrowBounce hideAfterNs" + (typeof options.className != "undefined" ? " " + options.className : "");
+      // BEGIN custom Styling
+      node.style.paddingRight = "1em";
+      // node.style.paddingTop = node.style.paddingBottom = '0em';
+      node.style.color = "rgb(0,0,0)";
+      // END custom Styling
+
+      node.innerHTML = '<div class="bounce">' + v + '&nbsp;<span style="margin-left: 3em;">➤</span></div>';
+      this.domElement.prepend(node);
+      if (typeof options.detachAfter == "number")
+        globalThis.setTimeout(function () {
+          removeElement();
+        }, options.detachAfter);
+    } else {
+      removeElement();
+    }
+
+    // --- Unfortunately IE does not support ES6 Template Literals ---
+    // --- So use '§' instead '$' here plus string.replace(...)    ---
+    // Define a dynamic and local CSS class
+    var style = document.createElement("style");
+    style.innerHTML = `.§{randomkey}.hideAfterNs {  
+	  animation: fadeout 0.5s 1;
+	  -webkit-animation: fadeout 0.5s 1;
+	  animation-fill-mode: forwards;
+
+	  animation-delay: ${options.fadeDelay}s;
+	  -webkit-animation-delay:§{options.fadeDelay}s; /* Safari and Chrome */
+	  -webkit-animation-fill-mode: forwards;
+	}`.replace(/§\{fadeTime\}/g, (options.fadeDelay / 1000).toString());
+    document.getElementsByTagName("head")[0].appendChild(style);
+    return this;
+  };
+
+  // Define a global CSS class
+  var style = document.createElement("style");
+  // style.type = "text/css";
+  style.innerHTML = `.bounce {
+      animation: bounce 2s infinite;
+      background: rgba(255,255,255,0.7);
+      border-radius: 8px;
+      padding-left: 1em;
+      padding-right: 1em;
+      display: flex;
+      align-items: center;
+      height: 100%;
+	}
+
+	@keyframes bounce {
+	    0%, 20%, 50%, 80%, 100% {
+		transform: translateX(0);
+	    }
+	    40% {
+		transform: translateX(-30px);
+	    }
+	    60% {
+		transform: translateX(-15px);
+	    }
+	}
+        @keyframes fadeout {
+	   from {opacity :1;}
+	   to {opacity :0; display:none;}
+        }
+        @-webkit-keyframes fadeout {
+	   from {opacity :1;}
+	   to {opacity :0;display:none;}
+        }
+    
+  /* override lil.gui style to make arrowbounce work */
+  .lil-gui .children {
+    overflow-x: visible !important;
+    overflow-y: visible !important;
+  }
+  `;
+  document.getElementsByTagName("head")[0].appendChild(style);
+
+  // Install the new feature
+  eachController(function (controller) {
+    if (!controller.prototype.hasOwnProperty("arrowBounce")) {
+      controller.prototype.arrowBounce = setArrowBounce;
+    }
+  });
+})();

package/src/_cjs/utils/lil.gui.title.polyfill.js

@@ -0,0 +1,32 @@
+/* lil.GUI copies the prototype of superclass Controller to all other controllers, so it is not enough to add it only to 
+the super class as the reference is not maintained */
+
+(function () {
+  var eachController = function (fnc) {
+    // Only in super controller required (?)
+    fnc(lil.Controller);
+    fnc(lil.BooleanController);
+    fnc(lil.ColorController);
+    fnc(lil.FunctionController);
+    fnc(lil.OptionController);
+    fnc(lil.NumberController);
+    fnc(lil.StringController);
+  };
+
+  var setTitle = function (v) {
+    // __li is the root dom element of each controller
+    // console.log("Controller", v, this);
+    if (v) {
+      this.domElement.setAttribute("title", v);
+    } else {
+      this.domElement.removeAttribute("title");
+    }
+    return this;
+  };
+
+  eachController(function (controller) {
+    if (!controller.prototype.hasOwnProperty("title")) {
+      controller.prototype.title = setTitle;
+    }
+  });
+})();

package/src/_cjs/utils/module.js

@@ -0,0 +1,18 @@
+/**
+ * Javacript modules transpiled from Typescript may contain
+ * `export` and `require` directives, which are no native components
+ * in most common browsers.
+ *
+ *  > Uncaught ReferenceError: exports is not defined
+ *  > Uncaught ReferenceError: require is not defined
+ *
+ * These two instructions create fake 'require' and fake 'export'
+ * which should fix these problems.
+ *
+ * @date 2020-04-01
+ **/
+
+var exports = (globalThis.export = globalThis);
+var require = (globalThis.require = function (...args) {
+  return globalThis;
+});

package/src/_cjs/utils/parsers/LinearColorGradientParser.d.ts

@@ -0,0 +1,78 @@
+/**
+ * A CSS gradient string parser.
+ *
+ * Source:
+ *  https://stackoverflow.com/questions/20215440/parse-css-gradient-rule-with-javascript-regex
+ * Thanks to Dean Taylor
+ *
+ * @date           2025-09-04
+ * @OriginalAuthor Dean Taylor
+ * @RefactoredBy   Ikaros Kappler, ported to Typescript.
+ * @version        1.0.0
+ */
+import { ColorGradient } from "../datastructures/ColorGradient";
+/**
+ * A wrapper type for the regular expressions used to parsed gradient strings.
+ */
+export type ColorGradientParserRegExpLib = {
+    gradientSearch: RegExp;
+    colorStopSearch: RegExp;
+};
+/**
+ * The raw parse result.
+ */
+export type ColorGradientParseResult = {
+    original: string;
+    line: string;
+    angle: string;
+    colorStopList: ColorGradientStopResult[];
+    sideCorner: string;
+    gradientType?: string;
+    parseWarning?: boolean;
+};
+/**
+ * The position string can have two formats: as percent or as pixels.
+ * For conversion to LinearColorGradient only relative (percent) is supported.
+ */
+type PositionString = `${number}px` | `${number}%`;
+/**
+ * A sub type of the result representing pairs of (color,position) elements.
+ */
+type ColorGradientStopResult = {
+    color: string;
+    position: PositionString;
+};
+/**
+ * This must convert positioning strings to ratio numbers (in [0..1]).
+ * Must throw error if not parsable.
+ */
+export type PositionToRatioConverter = (positionString: PositionString) => number;
+/**
+ * The default implementation of `PositionToRatioConverter`.
+ * @param positionString
+ * @returns
+ */
+export declare const DefaultPositionConverter: PositionToRatioConverter;
+/**
+ * Actually parse the input gradient parameters string into an object for reusability.
+ *
+ *
+ * @note Really this only supports the standard syntax not historical versions, see MDN for details
+ *       https://developer.mozilla.org/en-US/docs/Web/CSS/linear-gradient
+ *
+ * @param {ColorGradientParserRegExpLib} regExpLib
+ * @param {string} input Input string in the form "to right bottom, #FF0 0%, red 20px, rgb(0, 0, 255) 100%"
+ * @returns {object|undefined} Object containing break down of input string including array of stop points.
+ */
+export declare var __parseGradient: (regExpLib: ColorGradientParserRegExpLib, input: string) => ColorGradientParseResult;
+/**
+ * The actual parser class.
+ */
+export declare class LinearColorGradientParser {
+    private readonly regExpLib;
+    constructor(regExpLib?: ColorGradientParserRegExpLib);
+    parse(input: string, positionConverter?: PositionToRatioConverter): ColorGradient;
+    parseRaw(input: string): ColorGradientParseResult;
+    static parseResultToColorGradient(result: ColorGradientParseResult, positionConverter?: PositionToRatioConverter): ColorGradient;
+}
+export {};

package/src/_cjs/utils/parsers/LinearColorGradientParser.js

@@ -0,0 +1,224 @@
+"use strict";
+/**
+ * A CSS gradient string parser.
+ *
+ * Source:
+ *  https://stackoverflow.com/questions/20215440/parse-css-gradient-rule-with-javascript-regex
+ * Thanks to Dean Taylor
+ *
+ * @date           2025-09-04
+ * @OriginalAuthor Dean Taylor
+ * @RefactoredBy   Ikaros Kappler, ported to Typescript.
+ * @version        1.0.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LinearColorGradientParser = exports.__parseGradient = exports.DefaultPositionConverter = void 0;
+var Color_1 = require("../datastructures/Color");
+var ColorGradient_1 = require("../datastructures/ColorGradient");
+/**
+ * The default implementation of `PositionToRatioConverter`.
+ * @param positionString
+ * @returns
+ */
+var DefaultPositionConverter = function (positionString) {
+    if (typeof positionString === "undefined") {
+        throw new Error("Cannot parse positioning string `null`.");
+    }
+    var tmp = positionString.trim();
+    if (tmp.length === 0) {
+        throw new Error('Cannot parse empty positioning string "".');
+    }
+    if (!tmp.endsWith("%")) {
+        throw new Error("Cannot parse positioning string, must end with '%': '".concat(tmp, "'"));
+    }
+    return Number.parseFloat(tmp) / 100.0;
+};
+exports.DefaultPositionConverter = DefaultPositionConverter;
+/**
+ * Utility combine multiple regular expressions.
+ *
+ * Source:
+ *  https://stackoverflow.com/questions/20215440/parse-css-gradient-rule-with-javascript-regex
+ * Thanks to Dean Taylor
+ *
+ * @param {Array<RegExp | string>} regexpList List of regular expressions or strings.
+ * @param {string} flags Normal RegExp flags.
+ */
+var __combineRegExp = function (regexpList, flags) {
+    var source = "";
+    for (var i = 0; i < regexpList.length; i++) {
+        var regex = regexpList[i];
+        if (typeof regex === "string") {
+            source += regex;
+        }
+        else {
+            source += regex.source;
+        }
+    }
+    return new RegExp(source, flags);
+};
+/**
+ * Generate the required regular expressions once.
+ *
+ * Regular Expressions are easier to manage this way and can be well described.
+ *
+ * @result {object} Object containing regular expressions.
+ */
+var __generateDefaultRegExpLib = function () {
+    // Note any variables with "Capture" in name include capturing bracket set(s).
+    var searchFlags = "gi", // ignore case for angles, "rgb" etc
+    rAngle = /(?:[+-]?\d*\.?\d+)(?:deg|grad|rad|turn)/, // Angle +ive, -ive and angle types
+    rSideCornerCapture = /to\s+((?:(?:left|right)(?:\s+(?:top|bottom))?))/, // optional 2nd part
+    rComma = /\s*,\s*/, // Allow space around comma.
+    rColorHex = /\#(?:[a-f0-9]{6}|[a-f0-9]{3})/, // 3 or 6 character form
+    rDigits3 = /\(\s*(?:\d{1,3}\s*,\s*){2}\d{1,3}\s*\)/, // "(1, 2, 3)"
+    rDigits4 = /\(\s*(?:\d{1,3}\s*,\s*){2}\d{1,3}\s*,\s*\d*\.?\d+\)/, // "(1, 2, 3, 4)"
+    rValue = /(?:[+-]?\d*\.?\d+)(?:%|[a-z]+)?/, // ".9", "-5px", "100%".
+    rKeyword = /[_a-z-][_a-z0-9-]*/, // "red", "transparent", "border-collapse".
+    rColor = __combineRegExp(["(?:", rColorHex, "|", "(?:rgb|hsl)", rDigits3, "|", "(?:rgba|hsla)", rDigits4, "|", rKeyword, ")"], ""), rColorStop = __combineRegExp([rColor, "(?:\\s+", rValue, "(?:\\s+", rValue, ")?)?"], ""), // Single Color Stop, optional %, optional length.
+    rColorStopList = __combineRegExp(["(?:", rColorStop, rComma, ")*", rColorStop], ""), // List of color stops min 1.
+    rLineCapture = __combineRegExp(["(?:(", rAngle, ")|", rSideCornerCapture, ")"], ""), // Angle or SideCorner
+    rGradientSearch = __combineRegExp(["(?:(", rLineCapture, ")", rComma, ")?(", rColorStopList, ")"], searchFlags), // Capture 1:"line", 2:"angle" (optional), 3:"side corner" (optional) and 4:"stop list".
+    rColorStopSearch = __combineRegExp(["\\s*(", rColor, ")", "(?:\\s+", "(", rValue, "))?", "(?:", rComma, "\\s*)?"], searchFlags); // Capture 1:"color" and 2:"position" (optional).
+    return {
+        gradientSearch: rGradientSearch,
+        colorStopSearch: rColorStopSearch
+    };
+};
+/**
+ * Actually parse the input gradient parameters string into an object for reusability.
+ *
+ *
+ * @note Really this only supports the standard syntax not historical versions, see MDN for details
+ *       https://developer.mozilla.org/en-US/docs/Web/CSS/linear-gradient
+ *
+ * @param {ColorGradientParserRegExpLib} regExpLib
+ * @param {string} input Input string in the form "to right bottom, #FF0 0%, red 20px, rgb(0, 0, 255) 100%"
+ * @returns {object|undefined} Object containing break down of input string including array of stop points.
+ */
+var __parseGradient = function (regExpLib, input) {
+    var result;
+    var matchGradient, matchColorStop, stopResult;
+    // reset search position, because we reuse regex.
+    regExpLib.gradientSearch.lastIndex = 0;
+    matchGradient = regExpLib.gradientSearch.exec(input);
+    if (matchGradient !== null) {
+        result = {
+            original: matchGradient[0],
+            colorStopList: [],
+            line: null,
+            angle: null,
+            sideCorner: null
+        };
+        // Line (Angle or Side-Corner).
+        if (!!matchGradient[1]) {
+            result.line = matchGradient[1];
+        }
+        // Angle or undefined if side-corner.
+        if (!!matchGradient[2]) {
+            result.angle = matchGradient[2];
+        }
+        // Side-corner or undefined if angle.
+        if (!!matchGradient[3]) {
+            result.sideCorner = matchGradient[3];
+        }
+        // reset search position, because we reuse regex.
+        regExpLib.colorStopSearch.lastIndex = 0;
+        // Loop though all the color-stops.
+        matchColorStop = regExpLib.colorStopSearch.exec(matchGradient[4]);
+        while (matchColorStop !== null) {
+            stopResult = {
+                color: matchColorStop[1],
+                position: null
+            };
+            // Position (optional).
+            if (!!matchColorStop[2]) {
+                stopResult.position = matchColorStop[2];
+            }
+            result.colorStopList.push(stopResult);
+            // Continue searching from previous position.
+            matchColorStop = regExpLib.colorStopSearch.exec(matchGradient[4]);
+        }
+    }
+    // Can be undefined if match not found.
+    return result;
+};
+exports.__parseGradient = __parseGradient;
+/**
+ * The actual parser class.
+ */
+var LinearColorGradientParser = /** @class */ (function () {
+    function LinearColorGradientParser(regExpLib) {
+        this.regExpLib = regExpLib || __generateDefaultRegExpLib();
+    }
+    LinearColorGradientParser.prototype.parse = function (input, positionConverter) {
+        var result = this.parseRaw(input);
+        return LinearColorGradientParser.parseResultToColorGradient(result, positionConverter);
+    };
+    LinearColorGradientParser.prototype.parseRaw = function (input) {
+        var result;
+        var rGradientEnclosedInBrackets = /.*gradient\s*\(((?:\([^\)]*\)|[^\)\(]*)*)\)/; // Captures inside brackets - max one additional inner set.
+        var match = rGradientEnclosedInBrackets.exec(input);
+        var bracketPos = input.indexOf("(");
+        var gradientType = bracketPos === -1 ? null : input.substring(0, bracketPos).toLowerCase();
+        if (match !== null) {
+            // Get the parameters for the gradient
+            result = (0, exports.__parseGradient)(this.regExpLib, match[1]);
+            result.gradientType = gradientType;
+            if (result.original.trim() !== match[1].trim()) {
+                // Did not match the input exactly - possible parsing error.
+                result.parseWarning = true;
+            }
+        }
+        else {
+            //   result = new Error("Failed to find gradient");
+            throw new Error("Failed to find gradient");
+        }
+        return result;
+    };
+    LinearColorGradientParser.parseResultToColorGradient = function (result, positionConverter) {
+        if (!result.gradientType || result.gradientType.toLowerCase() != "linear-gradient") {
+            throw new Error("Cannot create linear gradient from type '".concat(result.gradientType, "'."));
+        }
+        if (!result.colorStopList || result.colorStopList.length <= 1) {
+            throw new Error("Cannot create linear gradient from color stop list of length '".concat(result.colorStopList.length, "'. Too few elements."));
+        }
+        var colorStops = [];
+        var converter = positionConverter !== null && positionConverter !== void 0 ? positionConverter : exports.DefaultPositionConverter;
+        for (var i = 0; i < result.colorStopList.length; i++) {
+            var stopListItem = result.colorStopList[i];
+            console.log(stopListItem);
+            var color = Color_1.Color.parse(stopListItem.color);
+            // var position: number = LinearColorGradientParser.parsePosition(stopListItem.position);
+            var ratio;
+            if (typeof stopListItem.position === "undefined") {
+                // Try to auto-fill undefined positions by their index in the list.
+                ratio = i / (result.colorStopList.length - 1);
+            }
+            else {
+                ratio = converter(stopListItem.position);
+            }
+            colorStops.push({ color: color, ratio: ratio });
+        }
+        return new ColorGradient_1.ColorGradient(colorStops, result.line);
+    };
+    return LinearColorGradientParser;
+}()); // END class
+exports.LinearColorGradientParser = LinearColorGradientParser;
+// var test_this_one = function (regExpLib, input) {
+//   var result,
+//     rGradientEnclosedInBrackets = /.*gradient\s*\(((?:\([^\)]*\)|[^\)\(]*)*)\)/, // Captures inside brackets - max one additional inner set.
+//     match = rGradientEnclosedInBrackets.exec(input);
+//   if (match !== null) {
+//     // Get the parameters for the gradient
+//     result = parseGradient(regExpLib, match[1]);
+//     if (result.original.trim() !== match[1].trim()) {
+//       // Did not match the input exactly - possible parsing error.
+//       result.parseWarning = true;
+//     }
+//   } else {
+//     result = "Failed to find gradient";
+//   }
+//   return result;
+// };
+//# sourceMappingURL=LinearColorGradientParser.js.map