plotboilerplate 1.27.1 → 1.28.0

package/src/_cjs/utils/parsers/svg/types.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Defining some basic SVG command types.
+ *
+ * As these types do not define all very possible path data strings they should cover the most daily use-cases.
+ *
+ * For more insight see
+ *    https://www.w3.org/TR/SVG/paths.html
+ *
+ *
+ * @author   Ikaros Kappler
+ * @date     2022-12-21 (winter solstice night – yes the days & nights are dark and I have nothing else to do)
+ * @modified 2023-01-17 Added multiple parameter sets.
+ * @version  0.0.2-alpha
+ */
+export type NumericString = `${number}`;
+export type BooleanString = "0" | "1" | `${boolean}`;
+export type SVGPathMoveToCommand = ["M" | "m", NumericString | number, NumericString | number];
+export type SVGPathLineToCommand = ["L" | "l", NumericString, NumericString, ...Array<NumericString>];
+export type SVGPathVerticalLineToCommand = ["V" | "v", NumericString];
+export type SVGPathHorizontalLineToCommand = ["H" | "h", NumericString];
+export type SVGPathQuadraticCurveToCommand = ["Q" | "q", NumericString, NumericString, NumericString, NumericString] | [
+    "Q" | "q",
+    NumericString,
+    NumericString,
+    NumericString,
+    NumericString,
+    "T" | "t",
+    NumericString,
+    NumericString,
+    ...Array<NumericString>
+];
+export type SVGPathCubicCurveToCommand = [
+    "C" | "c",
+    NumericString | number,
+    NumericString | number,
+    NumericString | number,
+    NumericString | number,
+    NumericString | number,
+    NumericString | number,
+    ...Array<NumericString | number>
+];
+export type SVGPathShorthandCubicCurveToCommand = [
+    "S" | "s",
+    NumericString,
+    NumericString,
+    NumericString,
+    NumericString,
+    ...Array<NumericString>
+];
+export type SVGPathArcToCommand = [
+    "A" | "a",
+    NumericString,
+    NumericString,
+    NumericString,
+    BooleanString,
+    BooleanString,
+    NumericString,
+    NumericString,
+    ...Array<NumericString>
+];
+export type SVGPathCloseCommand = ["Z" | "z"];
+export type SVGPathShorthandQuadraticCurveToCommand = ["T" | "t", NumericString, NumericString, ...Array<NumericString>];
+export type SVGPathCommand = SVGPathMoveToCommand | SVGPathLineToCommand | SVGPathVerticalLineToCommand | SVGPathHorizontalLineToCommand | SVGPathQuadraticCurveToCommand | SVGPathCubicCurveToCommand | SVGPathShorthandCubicCurveToCommand | SVGPathArcToCommand | SVGPathCloseCommand;

package/src/_cjs/utils/parsers/svg/types.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * Defining some basic SVG command types.
+ *
+ * As these types do not define all very possible path data strings they should cover the most daily use-cases.
+ *
+ * For more insight see
+ *    https://www.w3.org/TR/SVG/paths.html
+ *
+ *
+ * @author   Ikaros Kappler
+ * @date     2022-12-21 (winter solstice night – yes the days & nights are dark and I have nothing else to do)
+ * @modified 2023-01-17 Added multiple parameter sets.
+ * @version  0.0.2-alpha
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/src/_cjs/utils/parsers/svg/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../ts/utils/parsers/svg/types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;GAaG"}

package/src/_cjs/utils/ts-runner.js

@@ -0,0 +1,146 @@
+/**
+ * This is the Typescript loader.
+ *
+ * Each script inside the DOM that has 'language=typescript' will be asynchronously loaded
+ * and transpiled.
+ *
+ * It requires typescriptServices.js and tslib.js to be present.
+ *
+ * If you want to be called back when all Typescripts have been loaded and transpiled
+ * add a function: globalThis.onTypescriptsLoaded(boolean).
+ *
+ * @author  Ikaros Kappler
+ * @date    2020-03-18
+ * @version 1.0.0
+ **/
+
+(function(_context) {
+    
+    // Expose the runner to the global context
+    _context.TSRunner = _context.TSRunner || function( onTypescriptsLoaded, onTypescriptsCompiled, onTypescriptsExecuted, concatCodes ) {
+
+	// Register a pseudo-hidden global callback.
+	// The callback will be appended to the end of the transpiled JS code.
+	var callbackName = 'tsRunner_'+Math.floor(Math.random()*65535)+'_callback';
+	globalThis[callbackName] = onTypescriptsExecuted;
+	
+	/**
+	 * Request to load the given resource (specified by 'path', relative or absolute)
+	 * with an asynchronous XHR request.
+	 *
+	 * @param {string} path - The resoruce's path. Should be a text file.
+	 * @param {function(string)} success - A success callback (accepting the file contents as a string).
+	 * @param {function(number)} reject - A failure callback (accepting the error code).
+	 * @return {void}
+	 **/
+	var requestResource = function(path,success,reject) {
+	    var xhr = new XMLHttpRequest();
+	    xhr.open('GET', path);
+	    xhr.onload = function() {
+		if (xhr.status === 200) 
+		    success(xhr.responseText);
+		else 
+		    reject(xhr.status);
+	    };
+	    xhr.send();
+	};
+
+
+	/**
+	 * Transpile a batch of loaded Typescript codes.
+	 *
+	 * Each successfully transpiled code (result is a JS code) will be attached to the 
+	 * DOM's header as a <script> tag.
+	 *
+	 * @param {Array<string>} tsCodes - The actual ts codes in an array.
+	 * @param {Array<string>} pathNames - The resource names; used for proper error messages.
+	 * @return {number} errorCount
+	 **/
+	var transpileCodes = function( tsCodes, pathNames ) {
+	    const head = document.getElementsByTagName('head')[0];
+	    const jsCodes = [];
+	    var errorCount = 0;
+	    for( var i = 0; i < tsCodes.length; i++ ) {
+		try {
+		    let jsCode = globalThis.ts.transpile(tsCodes[i]);
+		    if( !concatCodes ) {
+			var scriptNode = document.createElement('script');
+			scriptNode.setAttribute('id','ts-transpiled-'+i);
+			scriptNode.innerHTML = jsCode;
+			head.appendChild(scriptNode);
+			console.log( jsCode );
+		    }
+		    jsCodes[i] = jsCode;
+		} catch( e ) {
+		    errorCount++;
+		    console.warn("Failed to transpile code "+i+" ("+pathNames[i]+")");
+		    console.error(e);
+		    onTypescriptsCompiled(false);
+		}
+	    }
+
+	    onTypescriptsCompiled(true);
+	    
+	    if( concatCodes ) {
+		var scriptNode = document.createElement('script');
+		scriptNode.setAttribute('id','ts-transpiled-concat');
+		var finalCode =
+		    jsCodes.join(' ') +
+		    "globalThis."+callbackName+"("+(errorCount==0)+")";
+		scriptNode.innerHTML = finalCode;
+		head.appendChild(scriptNode);
+	    }
+	    return errorCount;
+	};
+
+
+	/**
+	 * This triggers the process.
+	 **/
+	this.processTypescript = function() {
+	    var scriptNodes = document.querySelectorAll('script[language=typescript]');
+	    var resourcesLoaded = 0;
+	    var tsCodes = new Array(scriptNodes.length);
+	    var pathNames = new Array(scriptNodes.length);
+	    var checkComplete = function() { 
+		// If all n resources have been loaded, transpile them
+		// in exact the original order.
+		if( resourcesLoaded == scriptNodes.length ) {
+		    var errorCount = transpileCodes( tsCodes, pathNames );
+		    if( typeof onTypescriptsLoaded === "function" )
+			onTypescriptsLoaded(errorCount==0);
+		}
+	    };
+	    // Handle all typescripts 
+	    for( var i = 0; i < scriptNodes.length; i++ ) {
+		var src = scriptNodes[i].getAttribute('src');
+		if( src == null || typeof src === "undefined" ) {
+		    // This is an inline-script
+		    pathNames[i] = "[inline]";
+		    tsCodes[i] = scriptNodes[i].innerHTML;
+		    resourcesLoaded++;
+		    checkComplete();
+		} else {
+		    // This is a remote resource
+		    pathNames[i] = src;
+		    // Call this inside a closure to avoid collisions.
+		    (function(path,index) {
+			requestResource( path,
+					 function(result) {
+					     // Resource has been loaded.
+					     tsCodes[index] = result;
+					     resourcesLoaded++;
+					     checkComplete();
+					 },
+					 function(errorCode) {
+					     console.warn("Failed to load source '"+path+"'. Error code "+errorCode+".")
+					 }
+				       );
+		    })(src,i);
+		}
+	    }
+	}
+
+    }; // END constructor
+
+}(globalThis ? globalThis : module.exports));

package/src/_cjs/utils/tsAsyncScriptLoader.js

@@ -0,0 +1,74 @@
+/**
+ * This is a sandbox script helping to execute mixed Javascript and Typescript
+ * content during the development process.
+ *
+ * Due to performance reasons it is not a good idea to use this in production.
+ *
+ * Consider compiling your typescript files to JS instead.
+ *
+ * @date    2020-02-20
+ * @author  Ikaros Kappler
+ * @version 1.0.0
+ **/
+
+
+// Prevent plotboilerplate from auto-loading.
+globalThis.pbPreventAutoLoad = true;
+
+// This simulates the 'export' and 'require' directives.
+// There is no other way than to define these global!
+var exports = globalThis.exports = globalThis;
+var require = globalThis.require = function(...args) { console.log(args); return globalThis; };
+
+(function() {
+
+    // Start the process when the document is fully loaded.
+    globalThis.addEventListener('load', function() {
+	var tsRunner = new TSRunner(
+	    function(status) {
+		console.log(status ? '===> Typescript successfully loaded.' : '===> Error loading typescript.' );
+	    },
+	    function(status) {
+		console.log(status ? '===> Typescript successfully compiled.' : '===> Error compiling typescript.' );
+	    },
+	    function(status) {
+		console.log(status ? '===> Typescript successfully executed.' : '===> Error executing typescript.' );
+		loadJSFiles();
+		globalThis.initializePB();
+	    },
+	    true  // concat codes to one single 'file'
+	);
+	tsRunner.processTypescript();
+    } );
+
+
+    /**
+     * This script loads all required javascripts after the typescripts have been 
+     * compiled and executed.
+     */
+    var loadJSFiles = function() {
+	var jsSources = [
+	    // Place your JS file paths to load here
+	    // Example:
+	    // "src/js/draw.js"
+	];
+	var head = document.getElementsByTagName('head')[0];
+	var scriptsLoaded = 0;
+	for( var i in jsSources ) {
+            var scriptNode = document.createElement('script');
+            scriptNode.setAttribute('id','js-postloaded-'+i);
+	    scriptNode.setAttribute('type','text/javascript');
+	    scriptNode.setAttribute('async',false);
+	    scriptNode.setAttribute('defer',false);
+	    scriptNode.addEventListener('load', function() {
+		scriptsLoaded++;
+		if( scriptsLoaded == jsSources.length )
+		    globalThis.initializePB();
+            });
+            scriptNode.setAttribute('src',jsSources[i]);
+            head.appendChild(scriptNode);      
+	}
+	
+    };
+
+})();