plotboilerplate 1.23.0 → 1.23.2

package/src/ts/utils/InitializationObserver.ts

@@ -0,0 +1,70 @@
+/**
+ * Approach to observe objects from other scripts to be initialized.
+ *
+ * @author  Ikaros Kappler
+ * @date    2024-07-08
+ * @version 1.0.0
+ */
+
+interface IAccepptRejectPair<T, E> {
+  accept: (value: T) => void;
+  reject: (error: E | null) => void;
+}
+
+export class InitializationObserver<T, E> {
+  private _acceptRejectPairs: Array<IAccepptRejectPair<T, E | null>>;
+  private _timeoutMessage: E | null;
+  private _initializedValue: T;
+  private _isInitialized: boolean;
+
+  constructor(timeout: number, timeoutMessage?: E) {
+    this._acceptRejectPairs = [];
+    this._timeoutMessage = timeoutMessage ?? null;
+
+    globalThis.setTimeout(() => {
+      if (this._isInitialized) {
+        return; // NOOP
+      }
+      // else
+      if (!this._timeoutMessage) {
+        console.warn("Failed to initialize object. Reason unknown.");
+      }
+      this._fireReject(this._timeoutMessage ?? null);
+    }, timeout);
+  }
+
+  public accept(value: T): void {
+    if (this._isInitialized) {
+      return;
+    }
+    this._isInitialized = true;
+    this._initializedValue = value;
+    this._fireAccept(value);
+  }
+
+  private _fireAccept(value: T) {
+    this._acceptRejectPairs.forEach(pair => {
+      pair.accept(value);
+    });
+  }
+
+  private _fireReject(error: E | null) {
+    this._acceptRejectPairs.forEach(pair => {
+      pair.reject(error);
+    });
+  }
+
+  waitForInitialized(): Promise<T> {
+    const _self = this;
+    // If the value is already present, then accept immediately
+    if (_self._isInitialized) {
+      return new Promise<T>((accept: (value: T) => void, reject: (error: E | null) => void) => {
+        accept(_self._initializedValue);
+      });
+    } else {
+      return new Promise<T>((accept: (value: T) => void, reject: (error: E | null) => void) => {
+        _self._acceptRejectPairs.push({ accept, reject });
+      });
+    }
+  }
+}

package/src/ts/utils/Params.ts

@@ -2,9 +2,10 @@
  * Wraps a Record<string,string> and adds type conversion methods (developed this in
  * some other project) and added this here (2023-10-28).
  *
- * @author  Ikars Kappler
- * @version 1.0.0
- * @date    2023-03-13
+ * @author   Ikars Kappler
+ * @version  1.0.0
+ * @date     2023-03-13
+ * @modified 2024-08-26 Added the `hasParam` method.
  */
 
 export class Params {
@@ -14,6 +15,10 @@ export class Params {
     this.baseParams = baseParams;
   }
 
+  hasParam(name: string): boolean {
+    return this.baseParams.hasOwnProperty(name);
+  }
+
   getString(name: string, fallback: string): string {
     let value = this.baseParams[name];
     if (typeof value === "undefined" || !value || (value = value.trim()).length === 0) {

package/src/ts/utils/dom/guiSizeToggler.ts

@@ -0,0 +1,45 @@
+/**
+ * @requires lil-gui
+ *
+ * @author   Ikaros Kappler
+ * @date     2021-12-13
+ * @modified 2022-01-10
+ * @modified 2024-06-25 Ported to typescript and moved to utils/dom (was located inside demos before).
+ * @version  1.1.0
+ */
+
+import { GUI } from "../../interfaces/externals";
+
+interface ITogglerConfig {
+  guiDoubleSize?: boolean;
+}
+
+/**
+ * @param {GUI} gui - The GUI (compatible with dat.gui and lil-gui).
+ * @param {boolean} guiDoubleSize - True or false.
+ * @param {Record<string,string>} cssProps - The CSS props to use.
+ */
+const applyGuiSize = (gui: GUI, guiDoubleSize: boolean, cssProps: Record<string, string>) => {
+  if (cssProps && cssProps.hasOwnProperty("transformOrigin")) {
+    gui.domElement.style["transform-origin"] = cssProps["transformOrigin"];
+  } else {
+    gui.domElement.style["transform-origin"] = "100% 0%";
+  }
+
+  const transform = cssProps && cssProps.hasOwnProperty("transform") ? cssProps["transform"] + " " : "";
+
+  console.log("transform", transform);
+  if (guiDoubleSize) {
+    gui.domElement.style["transform"] = transform + "scale(2.0)";
+  } else {
+    gui.domElement.style["transform"] = transform + "scale(1.0)";
+  }
+};
+
+export const guiSizeToggler /* gst */ = (gui: GUI, config: ITogglerConfig, cssProps: Record<string, string>) => {
+  return {
+    update: function () {
+      applyGuiSize(gui, Boolean(config.guiDoubleSize), cssProps);
+    }
+  };
+};

package/src/ts/utils/gup.ts

@@ -9,6 +9,7 @@
  * Ported to typescript.
  * @date 2021-05-21
  * @modified 2024-03-10 Fixed some type for Typescript 5 compatibility.
+ * @modified 2024-08-26 Decoding URI components in GET params.
  */
 
 // Get the URI GET params as an assoc.
@@ -19,7 +20,8 @@
 export const gup = (): Record<string, string> => {
   const vars: Record<string, string> = {};
   globalThis.location.href.replace(/[?&]+([^=&]+)=([^&]*)/gi, (_m: string, key: string, value: string): string => {
-    return (vars[key as keyof Object] = value);
+    const keyName: string = key as keyof Object;
+    return (vars[decodeURIComponent(keyName)] = value);
   });
   return vars;
 };