qtools-library-dot-d 1.0.12 → 1.0.13

package/libDotD_Working_Example/node_modules/qtools-asynchronous-pipe-plus/README.md

@@ -1,213 +0,0 @@
-### qtools-asynchronous-pipe
-
-asynchronousPipe() takes an array of asynchronous functions and executes
-them in sequence. As each completes, the next is called with the return
-result of the previous function.
-
-The purpose of the package is to create a joint scope for a series of
-asynchronous operations.
-
-There are two main functions:
-
-```
-const asynchronousPipePlus=require('qtools-asynchronous-pipe-plus')(); // Note function execution
-const pipeRunner = asynchronousPipePlus.pipeRunner;
-const taskListPlus = asynchronousPipePlus.taskListPlus;
-```
-
-It is executed like this:
-
-```
-const taskList = new taskListPlus();
-
-taskList.push(someWorkListFunction);
-
-pipeRunner(taskList.getList(), initialValue, [callback])
-```
-
-The parameters are:
-
-    taskList:         an array of functions (This can be a normal Array())
-    initialValue:    optional initial value passed to the first function
-    callback:        optional function called after all the other functions are finished
-
-The workList functions must have the signature:
-
-    (args, next)={
-        const result= "some functionOf(args), probably the result of an I/O function";
-        next(err, result); //mandatory
-    }
-
-taskListPlus() returns, in addition to push() and getList(), several functions to control the parameters passed between process steps. These are undocumented for now:
-
-*returnGlobalArgs, getArgsValue, enforceScope, reduceToLocalScope, restoreGlobalScope*
-
-There is another taskListPlus() function that I used like crazy back in the day whose function is also, for now, undocumented: *addFromDelegate*.
-
-#### UPDATE 6/7/19
-
-There is a special value of err, **skipRestOfPipe**, eg:
-
-```
-next('skipRestOfPipe', result);
-```
-
-This will do as the symbol says, skip the rest of the pipe. It serves
-the role of 'break' in loops. Practically speaking, it immediately calls the
-callback function with the current value of result with the error value of 'skipRestOfPipe'.
-
-It is often good to have special code in the final callback to change a
-skipRestOfPipe error status for the next callback in case it's not an
-asynchronousPipe and  treats it as an error. 
-
-Eg,
-
-```
-callback(err=='skipRestOfPipe'?'':err, result)
-```
-
-The optional callback function is called as:
-
-    callback(err, result);
-
-pipeRunner() does not return anything.
-
-#### UPDATE: v1.04 (6/6/24)
-
-There are two new utility functions:
-
-    asynchronousPipePlus.mergeArgs
-    asynchronousPipePlus.forwardArgs
-
-These fabricate a callback that makes the args object available
-to the rest of the process sequence.
-
-**mergeArgs is used when a result is expected.** The result is added
-to the 'args' object using a string parameter as the property name:
-
-    const mergeArgs = (args, next, propertyName) => (err, result) =>
-        next(err, {
-            ...args,
-            ...(propertyName ? { [propertyName]: result } : result)
-        });
-
-It is called like this:
-
-    taskList.push((args, next) => {
-        const {argsForFunction}=args;
-        asyncFuncWithCallback(
-            argsForFunction,
-            mergeArgs(args, next, 'propertyNameForResult')
-        );
-    });
-    
-    
-    taskList.push((args, next) => {
-        const {propertyNameForResult, otherArgIfAny}=args;
-    
-        // ...
-    });
-
-**forwardArgs is used when no result parameter is expected:**
-
-    const forwardArgs = ({ next, args }) => err => next(err, args);
-    
-    taskList.push((args, next) => {
-        const {argsForFunction}=args;
-        asyncFuncWithCallback(
-            argsForFunction,
-            forwardArgs({ next, args })
-        );
-    });
-    
-    
-    taskList.push((args, next) => {
-        const {otherArgIfAny}=args;
-    
-        // ...
-    });
-
-### ===================================
-
-### Misc Example from test.js
-
-#!/usr/local/bin/node
-'use strict';
-
-const asynchronousPipePlus = new require('qtools-asynchronous-pipe-plus')();
-const pipeRunner = asynchronousPipePlus.pipeRunner;
-const taskListPlus = asynchronousPipePlus.taskListPlus; 
-
- const pipeFunction = (inData, callback) => {
-    const taskList = new taskListPlus();
-
-    taskList.push((args, next) => {
-        const localCallback = (err, localResult1) => {
-            if (err == 'someParticularError') {
-                next('skipRestOfPipe', err);
-                return;
-            }
-            console.dir({ 'only inboundData so far': args });
-    
-            args.localResult1 = localResult1;
-            next(err, args);
-        };
-        localCallback('', 'localResult1_value');
-    });
-    
-    
-    taskList.push((args, next) => {
-        const localCallback = (err, localResult3) => {
-            args.localResult3 = localResult3;
-            next(err, args);
-        };
-        console.dir({ 'shows localResult1 and inboundData': args });
-        localCallback('', 'localResult3_value');
-    });
-    
-    taskList.push(
-        (args, next) => {
-            const localCallback = (err, localResult2) => {
-                args.localResult2 = localResult2;
-                next(err, args);
-            };
-            console.dir({ 'shows localResult1 only': args });
-            localCallback('', 'localResult2_value');
-        },
-        ['localResult1']
-    );
-    
-    taskList.push(taskList.restoreGlobalScope());
-    
-    taskList.push((args, next) => {
-        const localCallback = (err, localResult3) => {
-            args.localResult3 = localResult3;
-            next(err, args);
-        };
-        console.dir({ 'shows all incoming values, 1, 2, hiding test': args });
-        localCallback('', 'localResult3_value');
-    });
-    
-    taskList.push(
-        (args, next) => {
-            const localCallback = (err, localResult4) => {
-                args.localResult4 = localResult4;
-                next(err, args);
-            };
-            console.dir({ 'shows localResult1 and inboundData': args });
-            localCallback('', 'localResult2_value');
-        },
-        ['localResult3', 'inboundData']
-    );
-    
-    const initialData = typeof inData != 'undefined' ? inData : {};
-    pipeRunner(taskList.getList(), initialData, (err, finalResult) => {
-        console.dir({ 'final: shows localResult3, inboundData, and localResult4': finalResult });
-        callback(err, finalResult);
-    });
-
-};
-
-pipeFunction({ inboundData: 'inboundData_value' }, (err, result) => {
-    console.log('if you do not see errors, it works');
-});

package/libDotD_Working_Example/node_modules/qtools-asynchronous-pipe-plus/package.json

@@ -1,20 +0,0 @@
-{
-  "name": "qtools-asynchronous-pipe-plus",
-  "version": "1.0.5",
-  "description": "Asynchronous-pipe for the future. Includes taskListPlus and utility functions I have learned to like\"",
-  "main": "qtools-asynchronous-pipe-plus.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/tqwhite/qtools-asynchronous-pipe-plus.git"
-  },
-  "author": "TQ White II",
-  "licenses": [
-    {
-      "type": "MIT",
-      "url": "https://github.com/evangelion1204/multi-ini/blob/master/LICENSE"
-    }
-  ]
-}

package/libDotD_Working_Example/node_modules/qtools-asynchronous-pipe-plus/qtools-asynchronous-pipe-plus.js

@@ -1,278 +0,0 @@
-'use strict';
-
-//START OF moduleFunction() ============================================================
-
-var moduleFunction = function(args) {
-	/* 
-
-asynchronousPipe() takes an array of asynchronous functions and executes them
-in sequence. As each completes, the next is called with the return result of the
-previous function.
-
-The parameters are:
-
-	workList: an array of functions
-	initialValue:	optional initial value passed to the first function
-	callback:		optional function called after all the other functions are finished
-
-The workList functions must have the signature:
-
-	(args, next)={
-		const result= "some functionOf(args), probably the result of an I/O function";
-		next(err, result); //mandatory
-	}
-
-As of 6/7/19, there is a special value of err, skipRestOfPipe, eg:
-
-next('skipRestOfPipe', result);
-
-This will do as the symbol says, skip the rest of the pipe. It serves the role of 'continue'
-in loops. Practically speaking, it calls the callback with the current value of result and no error.
-It is often good to have special code for in the final callback to 
-change the error status for the next callback in case it's not asynchronousPipe and 
-treats it as an error. Eg, callback(err=='skipRestOfPipe'?'':err, result)
-
-The optional callback function is called as:
-
-	callback(err, result);
-
-asynchronousPipe() does not return anything.
-
- */
- 
-
-	// --------------------------------------------------------------------------------
-	// INTERNAL UTILITIES
-
-	const mergeArgs = (args, next, propertyName) => (err, result) =>
-		next(err, {
-			...args,
-			...(propertyName ? { [propertyName]: result } : result)
-		});
-
-	const forwardArgs = ({ next, args }) => err => next(err, args);
- 
-	const isArray=item=>(typeof item=='object' && typeof item.length=='number');
-	
-	const logger=message=>{
-		const suffix='[asynchronousPipe.js]';
-		if (typeof message=='string'){
-			console.log(`${message} ${suffix}`)
-		}
-		else{
-		
-			console.log(`${suffix} =======`)
-			console.dir(message);		
-			console.log(`======= ${suffix}`)
-		}
-	
-	}
-
-	// asyncPipe(workList, [initialValue,] callback);
-	const asynchronousPipe = (...args) => {
-		const workList = args[0];
-		const callback = args[args.length - 1];
-
-		let initial;
-		if (args.length == 3) {
-			initial = args[1];
-		}
-
-		const recursion = (err, result, workListInx) => {
-			if (err) {
-				if (err == 'skipRestOfPipe') {
-					callback('skipRestOfPipe', result);
-					return;
-				} else {
-					callback(err, result);
-					return;
-				}
-			}
-
-			if (workListInx > workList.length - 1) {
-				if (typeof callback == 'function') {
-					callback('', result);
-				}
-				return;
-			}
-			workList[workListInx](result, (err, result) => {
-				recursion(err, result, workListInx + 1);
-			});
-		};
-		recursion('', initial, 0);
-	};
-	
-	const taskListPlus = function() {
-		const taskList = [];
-		const hiddenArgsName = `asyncPipeHideFromScope${new Date().getTime()}`;
-
-		const addOptions = options => {
-			if (options.debug) {
-				switch (options.debug) {
-					case 'properties':
-						//{debug:'properties', label:'identifier'}
-						taskList.push((args, next) => {
-							logger(
-								`\nLIST: args (${options.label ? options.label : ''}) =======`
-							);
-							logger(Object.keys(args));
-							logger('======= args\n');
-						});
-						break;
-					case 'fileMarker':
-						//{debug:'fileMarker', label:'identifier'}
-						taskList.push((args, next) => {
-							logger(
-								`\n=-========= (${
-									options.label ? options.label : ''
-								}) =======\n`
-							);
-						});
-						break;
-				}
-			}
-		};
-
-		this.push = function(item, propertyList, options) {
-			if (isArray(propertyList)) {
-				taskList.push(this.reduceToLocalScope(propertyList));
-			}
-
-			if (options) {
-				addOptions(options);
-			}
-			taskList.push(item);
-			this.length = taskList.length;
-		};
-
-		this.addFromDelegate = function(
-			targetFunction,
-			propertyList,
-			options = {}
-		) {
-			if (isArray(propertyList)) {
-				taskList.push(this.reduceToLocalScope(propertyList));
-			}
-
-			targetFunction();
-		};
-
-		this.getList = function() {
-			//returns this tasklist for use with pipeRunner()
-			return taskList;
-		};
-
-		const isScopeBad = (
-			args,
-			list,
-			strict = false,
-			originatingLine = 'no originating line given'
-		) => {
-			const missing = list.filter(name => typeof args[name] == 'undefined');
-			const extra = Object.keys(args).filter(name => !list.includes(name));
-			let result = '';
-
-			const missingString = missing.join(', ');
-			if (missingString && missingString != `${hiddenArgsName}`) {
-				result = `isScopeBad() found missing parameters: ${missingString} `;
-			}
-
-			const extraString = extra
-				.join(', ')
-				.replace(new RegExp(`(, )*${hiddenArgsName}*`), '');
-			if (strict && extraString && extraString != hiddenArgsName) {
-				result += `isScopeBad() found extra parameters: ${extraString} `;
-			}
-
-			if (result) {
-				result = `${result} ${originatingLine}`;
-				logger(result);
-			}
-			return result ? result : false;
-		};
-
-		this.returnGlobalArgs = args => {
-			const newArgs = Object.assign({}, args[hiddenArgsName], args);
-			delete newArgs[hiddenArgsName];
-			return newArgs;
-		};
-
-		this.getArgsValue = (args, nameList) => {
-			//extracts values from scope whether hidden or not
-			return nameList.reduce((result, name) => {
-				result[name] = args[hiddenArgsName][name]
-					? args[hiddenArgsName][name]
-					: args[name];
-				return result;
-			}, {});
-		};
-
-		this.enforceScope = (propertyList, strict = true) => {
-			//error if args has properties not allowed for local scope
-			let e = new Error();
-			const originatingLine = e.stack.split('\n')[2];
-			taskList.push((args, next) => {
-				next(isScopeBad(args, propertyList, strict, originatingLine), args);
-			});
-		};
-
-		this.reduceToLocalScope = requiredPropertyList => (args, next) => {
-			//changes (adds or substracts) elements from local scope
-			const localCallback = (err, cleanedArgs) => {
-				next(err, cleanedArgs);
-			};
-
-			if (args[hiddenArgsName]) {
-				const tmpArgs = Object.assign({}, args[hiddenArgsName], args);
-				delete tmpArgs[hiddenArgsName];
-				args = tmpArgs; //prevent recursing down globalArgs
-			}
-
-			const validFiles = true;
-			const cleanedArgs = {};
-
-			requiredPropertyList.forEach(item => {
-				cleanedArgs[item] = args[item];
-			});
-
-			const missingElements = requiredPropertyList
-				.filter(item => typeof cleanedArgs[item] == 'undefined')
-				.join(', ');
-
-				Object.defineProperty(cleanedArgs, hiddenArgsName, {
-					value: args,
-					writable: false,
-					enumerable: false
-				});
-					
-					
-			localCallback(
-				missingElements
-					? `MISSING ELEMENTS: ${missingElements} (by reduceToLocalScope())`
-					: '',
-				cleanedArgs
-			);
-		};
-		this.restoreGlobalScope = () => (args, next) => {
-			//returns all properties to the scope
-			const newArgs = Object.assign({}, args[hiddenArgsName], args);
-			delete newArgs[hiddenArgsName];
-			next('', newArgs);
-		};
-		return this;
-	};
-
-	return {
-		pipeRunner:asynchronousPipe,
-		asynchronousPipe,
-		taskListPlus,
-		mergeArgs,
-		forwardArgs
-	};
-};
-
-//END OF moduleFunction() ============================================================
-
-module.exports = moduleFunction;
-//module.exports = new moduleFunction();
-

package/libDotD_Working_Example/node_modules/qtools-asynchronous-pipe-plus/test.js

@@ -1,79 +0,0 @@
-#!/usr/local/bin/node
-'use strict';
-
-const asynchronousPipePlus = new require('qtools-asynchronous-pipe-plus')();
-const pipeRunner = asynchronousPipePlus.pipeRunner;
-const taskListPlus = asynchronousPipePlus.taskListPlus; 
-
- const pipeFunction = (inData, callback) => {
-	const taskList = new taskListPlus();
-	
-	taskList.push((args, next) => {
-		const localCallback = (err, localResult1) => {
-			if (err == 'someParticularError') {
-				next('skipRestOfPipe', err);
-				return;
-			}
-			console.dir({ 'only inboundData so far': args });
-			
-			args.localResult1 = localResult1;
-			next(err, args);
-		};
-		localCallback('', 'localResult1_value');
-	});
-	
-	
-	taskList.push((args, next) => {
-		const localCallback = (err, localResult3) => {
-			args.localResult3 = localResult3;
-			next(err, args);
-		};
-		console.dir({ 'shows localResult1 and inboundData': args });
-		localCallback('', 'localResult3_value');
-	});
-	
-	taskList.push(
-		(args, next) => {
-			const localCallback = (err, localResult2) => {
-				args.localResult2 = localResult2;
-				next(err, args);
-			};
-			console.dir({ 'shows localResult1 only': args });
-			localCallback('', 'localResult2_value');
-		},
-		['localResult1']
-	);
-	
-	taskList.push(taskList.restoreGlobalScope());
-	
-	taskList.push((args, next) => {
-		const localCallback = (err, localResult3) => {
-			args.localResult3 = localResult3;
-			next(err, args);
-		};
-		console.dir({ 'shows all incoming values, 1, 2, hiding test': args });
-		localCallback('', 'localResult3_value');
-	});
-	
-	taskList.push(
-		(args, next) => {
-			const localCallback = (err, localResult4) => {
-				args.localResult4 = localResult4;
-				next(err, args);
-			};
-			console.dir({ 'shows localResult1 and inboundData': args });
-			localCallback('', 'localResult2_value');
-		},
-		['localResult3', 'inboundData']
-	);
-	
-	const initialData = typeof inData != 'undefined' ? inData : {};
-	pipeRunner(taskList.getList(), initialData, (err, finalResult) => {
-		console.dir({ 'final: shows localResult3, inboundData, and localResult4': finalResult });
-		callback(err, finalResult);
-	});
-};
-
-pipeFunction({ inboundData: 'inboundData_value' }, (err, result) => {
-	console.log('if you do not see errors, it works');
-});

package/libDotD_Working_Example/node_modules/qtools-functional-library/README.md

@@ -1,110 +0,0 @@
-## **qtools-functional-library**
-
-This is a collection of tools that allow chained operations on various Javascript datatypes. 
-
-In each case, the primary operand is `this`. In most cases, the function takes an argument with parameters to guide the operation. 
-
-Everything else remains compatible.
-
-**EG,**
-
-```
-const qt=require('qtools-functional-library');
-
-qt.help(); // this information and more
-
-const demo=({a:{b:"Hi from b"}})
-
-const one=demo
-    .qtGetSurePath('a.b')
-    .qtDump();//produces 'Hi from b [thisFilename.js]'
-
-console.log(one); //produces '[object Object]'
-```
-
-### **Version 2:**
-
-qtPassThrough <u>no longer</u> *always* returns the inbound 'this'. If the supplied function
-returns a value, that is passed on. This way, any ad hoc function can affect the result chain.
-
-Version 2.0.1 9/23/24 - removed deep clone in favor of spread operator (which didn't exist when this was written). Should have no effect on functionality.
-
-EG,
-
-```
-'xxx'
-    .qtPassThrough(item=>item.toUpperCase())
-    .qtDump(); // -> 'XXX'
-```
-
-### **Non-chain utilities:**
-
-- **qt.help**: Shows this information and more.
-- **qt.log**:    Writes log entry with suffix identifying the file that generated the output. (See qtLog below for chained version.)
-
-### **Get/Set values from an Array:**
-
-- **qtGetByProperty**: Operates on an array of objects. Retrieves one or more elements based on the value of an object property specified by a dotted path.
-
-- **qtPop**: Pops the last value off an array. If a default is supplied and there is nothing left on the list, that will be returned. Really good for ArrayOfObjects.qtPop({}).
-
-- **qtPush**: Pushes a value onto an array and returns the array (unlike normal .push() which returns the length of the array)
-
-- **qtLast**: Delivers the element that would have been pop'd but does not change the array. Default if none exists.
-
-- **qtFirst**: Delivers the element zero if it exists but does not change the array. Default if none exists.
-
-- **qtIncludesRegex**: Operations on a simple array of strings. Retrieves one or more elements based on an regEx match.
-
-### **Get/Set values in an Object (or array of Objects)**
-
-- **qtGetSurePath**: Gets the value of a property based on a dotted string path. No crash if intermediate elements are missing. Provides default. Predates and is prettier to use than optional chaining and supports setting the value.
-
-- **qtSetSurePath** Sets the value of a property based on a dotted string path. Creates intermediate elements if they are missing.
-
-- **qtSelectProperties**: Given an Object and an Array of Strings, filters the properties into a new Object with defaults "[{}].qtSelectProperties(outFileDefinition, {moreDefaultValues:{Value:"xxx"}}))" for missing elements. Does the same for an Array of Objects.
-
-- **qtMapProperties**: Given an Object and a one level Object whose properties are functions, applies each function to the corresponding element. Does the same for an array of Objects.
-
-### **Array/Object Conversions:**
-
-- **qtClone**: Does a deep clone of an object or array.- qtNumberKeysToArray: Converts an object with properties that are numbers to an array, including subordinate properties.
-
-- **qtToKeyValueArray**: Converts an object to an array of objects of the form, ie, `{["1"]:'one', ["2"]:'two'} => ['one', 'two']`
-
-- **qtMerge**: Deep merge of two objects including array propterties.
-
-- **qtToString**: Joins an array with prefix, suffix and separator. Pretty much the same as .join().
-
-### **Array/Object Template Replacement:**
-
-- **qtTemplateReplace**: Takes Object and a `<!template!>` String ()either can be 'this' or the argument). Substitutes from the object properties into the string. If the 'this' is an array of Objects, it does it to all of them.
-
-### **Output:**
-
-- **qtDump**: Prints 'this' and returns it. Good for debugging complicated chains.
-
-- **qtLog**: Logs message by applying 'this' into the argument which is a <!template!> string. Appends calling file name.
-
-### **Misc:**
-
-- **qtPassThrough**: Sits in a declarative chain and executes an arbitrary function. Returns function result if not undefined, 'this' otherwise. 'this' is available to the function.
-
-- **qtIterate**: Operates on a number. EG, (5).qtStart(7).qtIncrement(3).qtIterate(item=>item*100)
-
-### **Output:**
-
-2.0.3 - fixed old error where qtFirst() did not work at all.
-1.1.16 - fixed bug where intermediate path element could be undefined and cause a crash.
-
-### **Other Cool Qtools**
-
-[qtools-asynchronous-pipe-plus](https://www.npmjs.com/package/qtools-asynchronous-pipe-plus)
-[qtools-config-file-processor](https://www.npmjs.com/package/qtools-config-file-processor)
-[qtools-format-columns](https://www.npmjs.com/package/qtools-format-columns)
-[qtools-functional-library](https://www.npmjs.com/package/qtools-functional-library)
-[qtools-object-flattener](https://www.npmjs.com/package/qtools-object-flattener)
-[qtools-parse-command-line](https://www.npmjs.com/package/qtools-parse-command-line)
-[qtools-secure-container](https://www.npmjs.com/package/qtools-secure-container)
-[qtools-template-replace-for-files](https://www.npmjs.com/package/qtools-template-replace-for-files)
-[qtools-transform-text](https://www.npmjs.com/package/qtools-transform-text)