tiddlywiki 5.3.8 → 5.4.0

package/core/modules/filter-tracker.js

@@ -0,0 +1,106 @@
+/*\
+title: $:/core/modules/filter-tracker.js
+type: application/javascript
+module-type: global
+
+Class to track the results of a filter string
+
+\*/
+
+"use strict";
+
+class FilterTracker {
+	constructor(wiki) {
+		this.wiki = wiki;
+		this.trackers = new Map();
+		this.nextTrackerId = 1;
+	}
+
+	handleChangeEvent(changes) {
+		this.processTrackers();
+		this.processChanges(changes);
+	}
+
+	/*
+	Add a tracker to the filter tracker. Returns null if any of the parameters are invalid, or a tracker id if the tracker was added successfully. Options include:
+	filterString: the filter string to track
+	fnEnter: function to call when a title enters the filter results. Called even if the tiddler does not actually exist. Called as (title), and should return a truthy value that is stored in the tracker as the "enterValue"
+	fnLeave: function to call when a title leaves the filter results. Called as (title,enterValue)
+	fnChange: function to call when a tiddler changes in the filter results. Only called for filter results that identify a tiddler or shadow tiddler. Called as (title,enterValue), and may optionally return a replacement enterValue
+	fnProcess: function to call each time the tracker is processed, after any enter, leave or change functions are called. Called as (changes)
+	*/
+	track(options = {}) {
+		const {
+			filterString,
+			fnEnter,
+			fnLeave,
+			fnChange,
+			fnProcess
+		} = options;
+		const id = this.nextTrackerId++;
+		const tracker = {
+			id,
+			filterString,
+			fnEnter,
+			fnLeave,
+			fnChange,
+			fnProcess,
+			previousResults: [],
+			resultValues: {}
+		};
+		this.trackers.set(id, tracker);
+		// Process the tracker
+		this.processTracker(id);
+		return id;
+	}
+
+	untrack(id) {
+		this.trackers.delete(id);
+	}
+
+	processTrackers() {
+		for(const id of this.trackers.keys()) {
+			this.processTracker(id);
+		}
+	}
+
+	processTracker(id) {
+		const tracker = this.trackers.get(id);
+		if(!tracker) return;
+		const results = [];
+		// Evaluate the filter and remove duplicate results
+		$tw.utils.each(this.wiki.filterTiddlers(tracker.filterString), (title) => {
+			$tw.utils.pushTop(results, title);
+		});
+		// Process the newly entered results
+		results.forEach((title) => {
+			if(!tracker.previousResults.includes(title) && !tracker.resultValues[title] && tracker.fnEnter) {
+				tracker.resultValues[title] = tracker.fnEnter(title) || true;
+			}
+		});
+		// Process the results that have just left
+		tracker.previousResults.forEach((title) => {
+			if(!results.includes(title) && tracker.resultValues[title] && tracker.fnLeave) {
+				tracker.fnLeave(title, tracker.resultValues[title]);
+				delete tracker.resultValues[title];
+			}
+		});
+		// Update the previous results
+		tracker.previousResults = results;
+	}
+
+	processChanges(changes) {
+		for(const tracker of this.trackers.values()) {
+			Object.keys(changes).forEach((title) => {
+				if(title && tracker.previousResults.includes(title) && tracker.fnChange) {
+					tracker.resultValues[title] = tracker.fnChange(title, tracker.resultValues[title]) || tracker.resultValues[title];
+				}
+			});
+			if(tracker.fnProcess) {
+				tracker.fnProcess(changes);
+			}
+		}
+	}
+}
+
+exports.FilterTracker = FilterTracker;

package/core/modules/filterrunprefixes/cascade.js

@@ -24,7 +24,7 @@ exports.cascade = function(operationSubFunction,options) {
 					}
 					var output = filterFnList[index](options.wiki.makeTiddlerIterator([title]),widget.makeFakeWidgetWithVariables({
 						"currentTiddler": "" + title,
-						"..currentTiddler": widget.getVariable("currentTiddler","")
+						"..currentTiddler": widget.getVariable("currentTiddler",{defaultValue:""})
 					}));
 					if(output.length !== 0) {
 						result = output[0];
@@ -34,5 +34,5 @@ exports.cascade = function(operationSubFunction,options) {
 				results.push(result);
 			});
 		}
-	}
+	};
 };

package/core/modules/filterrunprefixes/filter.js

@@ -18,7 +18,7 @@ exports.filter = function(operationSubFunction,options) {
 			results.each(function(title) {
 				var filtered = operationSubFunction(options.wiki.makeTiddlerIterator([title]),widget.makeFakeWidgetWithVariables({
 					"currentTiddler": "" + title,
-					"..currentTiddler": widget.getVariable("currentTiddler",""),
+					"..currentTiddler": widget.getVariable("currentTiddler",{defaultValue:""}),
 					"index": "" + index,
 					"revIndex": "" +  (results.length - 1 - index),
 					"length": "" + results.length
@@ -30,5 +30,5 @@ exports.filter = function(operationSubFunction,options) {
 			});
 			results.remove(resultsToRemove);
 		}
-	}
+	};
 };

package/core/modules/filterrunprefixes/let.js

@@ -0,0 +1,39 @@
+/*\
+title: $:/core/modules/filterrunprefixes/let.js
+type: application/javascript
+module-type: filterrunprefix
+
+Assign a value to a variable
+
+\*/
+
+"use strict";
+
+/*
+Export our filter prefix function
+*/
+exports.let = function(operationSubFunction,options) {
+	// Return the filter run prefix function
+	return function(results,source,widget) {
+		// Save the result list
+		var resultList = results.toArray();
+		// Clear the results
+		results.clear();
+		// Evaluate the subfunction to get the variable name
+		var subFunctionResults = operationSubFunction(source,widget);
+		if(subFunctionResults.length === 0) {
+			return;
+		}
+		var name = subFunctionResults[0];
+		if(typeof name !== "string" || name.length === 0) {
+			return;
+		}
+		// Assign the result of the subfunction to the variable
+		var variables = {};
+		variables[name] = resultList;
+		// Return the variables
+		return {
+			variables: variables
+		};
+	};
+};

package/core/modules/filterrunprefixes/map.js

@@ -20,7 +20,7 @@ exports.map = function(operationSubFunction,options) {
 			$tw.utils.each(inputTitles,function(title) {
 				var filtered = operationSubFunction(options.wiki.makeTiddlerIterator([title]),widget.makeFakeWidgetWithVariables({
 					"currentTiddler": "" + title,
-					"..currentTiddler": widget.getVariable("currentTiddler",""),
+					"..currentTiddler": widget.getVariable("currentTiddler",{defaultValue:""}),
 					"index": "" + index,
 					"revIndex": "" +  (inputTitles.length - 1 - index),
 					"length": "" + inputTitles.length
@@ -28,12 +28,12 @@ exports.map = function(operationSubFunction,options) {
 				if(filtered.length && flatten) {
 					$tw.utils.each(filtered,function(value) {
 						results.push(value);
-					})
+					});
 				} else {
 					results.push(filtered[0]||"");
 				}
 				++index;
 			});
 		}
-	}
+	};
 };

package/core/modules/filterrunprefixes/reduce.js

@@ -17,7 +17,7 @@ exports.reduce = function(operationSubFunction,options) {
 			results.each(function(title) {
 				var list = operationSubFunction(options.wiki.makeTiddlerIterator([title]),widget.makeFakeWidgetWithVariables({
 					"currentTiddler": "" + title,
-					"..currentTiddler": widget.getVariable("currentTiddler"),
+					"..currentTiddler": widget.getVariable("currentTiddler",{defaultValue:""}),
 					"index": "" + index,
 					"revIndex": "" +  (results.length - 1 - index),
 					"length": "" + results.length,
@@ -31,5 +31,5 @@ exports.reduce = function(operationSubFunction,options) {
 			results.clear();
 			results.push(accumulator);
 		}
-	}
+	};
 };

package/core/modules/filterrunprefixes/sort.js

@@ -24,7 +24,7 @@ exports.sort = function(operationSubFunction,options) {
 			results.each(function(title) {
 				var key = operationSubFunction(options.wiki.makeTiddlerIterator([title]),widget.makeFakeWidgetWithVariables({
 					"currentTiddler": "" + title,
-					"..currentTiddler": widget.getVariable("currentTiddler")
+					"..currentTiddler": widget.getVariable("currentTiddler",{defaultValue:""})
 				}));
 				sortKeys.push(key[0] || "");
 			});
@@ -36,12 +36,12 @@ exports.sort = function(operationSubFunction,options) {
 			// Sort the indexes
 			compareFn = $tw.utils.makeCompareFunction(sortType,{defaultType: "string", invert:invert, isCaseSensitive:isCaseSensitive});
 			indexes = indexes.sort(function(a,b) {
-					return compareFn(sortKeys[a],sortKeys[b]);
+				return compareFn(sortKeys[a],sortKeys[b]);
 			});
 			// Add to results in correct order
 			$tw.utils.each(indexes,function(index) {
 				results.push(inputTitles[index]);
 			});
 		}
-	}
+	};
 };

package/core/modules/filters/compare.js

@@ -32,4 +32,4 @@ var modes = {
 	"gt": function(value) {return value > 0;},
 	"lteq": function(value) {return value <= 0;},
 	"lt": function(value) {return value < 0;}
-}
+};

package/core/modules/filters/deserialize.js

@@ -31,4 +31,4 @@ exports["deserialize"] = function(source,operator,options) {
 		return [$tw.language.getString("Error/DeserializeOperator/MissingOperand")];
 	}
 	return results;
-}
+};

package/core/modules/filters/each.js

@@ -15,8 +15,8 @@ Export our filter function
 */
 exports.each = function(source,operator,options) {
 	var results =[] ,
-	value,values = {},
-	field = operator.operand || "title";
+		value,values = {},
+		field = operator.operand || "title";
 	if(operator.suffix === "value" && field === "title") {
 		source(function(tiddler,title) {
 			if(!$tw.utils.hop(values,title)) {

package/core/modules/filters/field.js

@@ -53,7 +53,7 @@ exports.field = function(source,operator,options) {
 			if(source.byField && operator.operand) {
 				indexedResults = source.byField(fieldname,operator.operand);
 				if(indexedResults) {
-					return indexedResults
+					return indexedResults;
 				}
 			}
 			source(function(tiddler,title) {

package/core/modules/filters/fields.js

@@ -24,7 +24,7 @@ exports.fields = function(source,operator,options) {
 				for(fieldName in tiddler.fields) {
 					(operand.indexOf(fieldName) !== -1) ? $tw.utils.pushTop(results,fieldName) : "";
 				}
-			} else if (suffixes.indexOf("exclude") !== -1) {
+			} else if(suffixes.indexOf("exclude") !== -1) {
 				for(fieldName in tiddler.fields) {
 					(operand.indexOf(fieldName) !== -1) ? "" : $tw.utils.pushTop(results,fieldName);
 				}

package/core/modules/filters/filter.js

@@ -19,7 +19,7 @@ exports.filter = function(source,operator,options) {
 	source(function(tiddler,title) {
 		var list = filterFn.call(options.wiki,options.wiki.makeTiddlerIterator([title]),options.widget.makeFakeWidgetWithVariables({
 			"currentTiddler": "" + title,
-			"..currentTiddler": options.widget.getVariable("currentTiddler","")
+			"..currentTiddler": options.widget.getVariable("currentTiddler",{defaultValue:""})
 		}));
 		if((list.length > 0) === target) {
 			results.push(title);

package/core/modules/filters/format/json.js

@@ -16,12 +16,8 @@ exports.json = function(source,operand,options) {
 		spaces = /^\d+$/.test(operand) ? parseInt(operand,10) : operand;
 	}
 	source(function(tiddler,title) {
-		var data = $tw.utils.parseJSONSafe(title);
-		try {
-			data = JSON.parse(title);
-		} catch(e) {
-			data = undefined;
-		}
+		var data = $tw.utils.parseJSONSafe(title,function(){return undefined;});
+
 		if(data !== undefined) {
 			results.push(JSON.stringify(data,null,spaces));
 		}

package/core/modules/filters/format/timestamp.js

@@ -12,7 +12,7 @@ Export our filter function
 exports.timestamp = function(source,operand,options) {
 	var results = [];
 	source(function(tiddler,title) {
-		if (title.match(/^-?\d+$/)) {
+		if(title.match(/^-?\d+$/)) {
 			var value = new Date(Number(title));
 			results.push($tw.utils.formatDateString(value,operand || "[UTC]YYYY0MM0DD0hh0mm0ss0XXX"));
 		}

package/core/modules/filters/function.js

@@ -16,8 +16,8 @@ exports.function = function(source,operator,options) {
 	var functionName = operator.operands[0],
 		params = [],
 		results;
-	$tw.utils.each(operator.operands.slice(1),function(param) {
-		params.push({value: param});
+	$tw.utils.each(operator.multiValueOperands.slice(1),function(paramList) {
+		params.push({value: paramList[0] || "",multiValue: paramList});
 	});
 	// console.log(`Calling ${functionName} with params ${JSON.stringify(params)}`);
 	var variableInfo = options.widget && options.widget.getVariableInfo && options.widget.getVariableInfo(functionName,{params: params, source: source});

package/core/modules/filters/getindex.js

@@ -13,7 +13,7 @@ returns the value at a given index of datatiddlers
 Export our filter function
 */
 exports.getindex = function(source,operator,options) {
-	var data,title,results = [];
+	var data,results = [];
 	if(operator.operand){
 		source(function(tiddler,title) {
 			title = tiddler ? tiddler.fields.title : title;

package/core/modules/filters/json-ops.js

@@ -113,6 +113,22 @@ exports["jsonset"] = function(source,operator,options) {
 	return results;
 };
 
+exports["jsondelete"] = function(source,operator,options) {
+	var indexes = operator.operands,
+		results = [];
+	source(function(tiddler,title) {
+		var data = $tw.utils.parseJSONSafe(title,title);
+		// If parsing failed (data equals original title and is a string), return unchanged
+		if(data === title && typeof data === "string") {
+			results.push(title);
+		} else if(data) {
+			data = deleteDataItem(data,indexes);
+			results.push(JSON.stringify(data));
+		}
+	});
+	return results;
+};
+
 /*
 Given a JSON data structure and an array of index strings, return an array of the string representation of the values at the end of the index chain, or "undefined" if any of the index strings are invalid
 */
@@ -141,13 +157,13 @@ function convertDataItemValueToStrings(item) {
 	if(item === undefined) {
 		return undefined;
 	} else if(item === null) {
-		return ["null"]
+		return ["null"];
 	} else if(typeof item === "object") {
 		var results = [],i,t;
-		if($tw.utils.isArray(item)) {
+		if(Array.isArray(item)) {
 			// Return all the items in arrays recursively
 			for(i=0; i<item.length; i++) {
-				t = convertDataItemValueToStrings(item[i])
+				t = convertDataItemValueToStrings(item[i]);
 				if(t !== undefined) {
 					results.push.apply(results,t);
 				}
@@ -178,7 +194,7 @@ function convertDataItemKeysToStrings(item) {
 			return [];
 		}
 		var results = [];
-		if($tw.utils.isArray(item)) {
+		if(Array.isArray(item)) {
 			for(var i=0; i<item.length; i++) {
 				results.push(i.toString());
 			}
@@ -201,7 +217,7 @@ function getDataItemType(data,indexes) {
 		return item;
 	} else if(item === null) {
 		return "null";
-	} else if($tw.utils.isArray(item)) {
+	} else if(Array.isArray(item)) {
 		return "array";
 	} else if(typeof item === "object") {
 		return "object";
@@ -213,9 +229,9 @@ function getDataItemType(data,indexes) {
 function getItemAtIndex(item,index) {
 	if($tw.utils.hop(item,index)) {
 		return item[index];
-	} else if($tw.utils.isArray(item)) {
+	} else if(Array.isArray(item)) {
 		index = $tw.utils.parseInt(index);
-		if(index < 0) { index = index + item.length };
+		if(index < 0) { index = index + item.length; };
 		return item[index]; // Will be undefined if index was out-of-bounds
 	} else {
 		return undefined;
@@ -223,15 +239,16 @@ function getItemAtIndex(item,index) {
 }
 
 /*
-Given a JSON data structure and an array of index strings, return the value at the end of the index chain, or "undefined" if any of the index strings are invalid
+Traverse the index chain and return the item at the specified depth.
+Returns the item at the end of the traversal, or undefined if traversal fails.
 */
-function getDataItem(data,indexes) {
+function traverseIndexChain(data,indexes,stopBeforeLast) {
 	if(indexes.length === 0 || (indexes.length === 1 && indexes[0] === "")) {
 		return data;
 	}
-	// Get the item
 	var item = data;
-	for(var i=0; i<indexes.length; i++) {
+	var stopIndex = stopBeforeLast ? indexes.length - 1 : indexes.length;
+	for(var i = 0; i < stopIndex; i++) {
 		if(item !== undefined) {
 			if(item !== null && ["number","string","boolean"].indexOf(typeof item) === -1) {
 				item = getItemAtIndex(item,indexes[i]);
@@ -243,6 +260,13 @@ function getDataItem(data,indexes) {
 	return item;
 }
 
+/*
+Given a JSON data structure and an array of index strings, return the value at the end of the index chain, or "undefined" if any of the index strings are invalid
+*/
+function getDataItem(data,indexes) {
+	return traverseIndexChain(data,indexes,false);
+}
+
 /*
 Given a JSON data structure, an array of index strings and a value, return the data structure with the value added at the end of the index chain. If any of the index strings are invalid then the JSON data structure is returned unmodified. If the root item is targetted then a different data object will be returned
 */
@@ -255,20 +279,17 @@ function setDataItem(data,indexes,value) {
 	if(indexes.length === 0 || (indexes.length === 1 && indexes[0] === "")) {
 		return value;
 	}
-	// Traverse the JSON data structure using the index chain
-	var current = data;
-	for(var i = 0; i < indexes.length - 1; i++) {
-		current = getItemAtIndex(current,indexes[i]);
-		if(current === undefined) {
-			// Return the original JSON data structure if any of the index strings are invalid
-			return data;
-		}
+	// Traverse the JSON data structure using the index chain up to the parent
+	var current = traverseIndexChain(data,indexes,true);
+	if(current === undefined) {
+		// Return the original JSON data structure if any of the index strings are invalid
+		return data;
 	}
 	// Add the value to the end of the index chain
 	var lastIndex = indexes[indexes.length - 1];
-	if($tw.utils.isArray(current)) {
+	if(Array.isArray(current)) {
 		lastIndex = $tw.utils.parseInt(lastIndex);
-		if(lastIndex < 0) { lastIndex = lastIndex + current.length };
+		if(lastIndex < 0) { lastIndex = lastIndex + current.length; };
 	}
 	// Only set indexes on objects and arrays
 	if(typeof current === "object") {
@@ -276,3 +297,32 @@ function setDataItem(data,indexes,value) {
 	}
 	return data;
 }
+
+/*
+Given a JSON data structure and an array of index strings, return the data structure with the item at the end of the index chain deleted. If any of the index strings are invalid then the JSON data structure is returned unmodified. If the root item is targetted then the JSON data structure is returned unmodified.
+*/
+function deleteDataItem(data,indexes) {
+	// Check for the root item - don't delete the root
+	if(indexes.length === 0 || (indexes.length === 1 && indexes[0] === "")) {
+		return data;
+	}
+	// Traverse the JSON data structure using the index chain up to the parent
+	var current = traverseIndexChain(data,indexes,true);
+	if(current === undefined || current === null) {
+		// Return the original JSON data structure if any of the index strings are invalid
+		return data;
+	}
+	// Delete the item at the end of the index chain
+	var lastIndex = indexes[indexes.length - 1];
+	if(Array.isArray(current) && current !== null) {
+		lastIndex = $tw.utils.parseInt(lastIndex);
+		if(lastIndex < 0) { lastIndex = lastIndex + current.length; };
+		// Check if index is valid before splicing
+		if(lastIndex >= 0 && lastIndex < current.length) {
+			current.splice(lastIndex,1);
+		}
+	} else if(typeof current === "object" && current !== null) {
+		delete current[lastIndex];
+	}
+	return data;
+}

package/core/modules/filters/lookup.js

@@ -25,7 +25,7 @@ exports.lookup = function(source,operator,options) {
 		indexSuffix = (suffixes[1] && suffixes[1][0] === "index") ? true : false,
 		target;
 	if(operator.operands.length == 2) {
-		target = operator.operands[1]
+		target = operator.operands[1];
 	} else {
 		target = indexSuffix ? "0": "text";
 	}