node-red-contrib-prib-functions 0.19.2 → 0.21.0

package/.github/workflows/codeql-analysis.yml

@@ -35,7 +35,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
@@ -50,7 +50,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -64,4 +64,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v3

package/.github/workflows/npmpublish.yml

@@ -11,10 +11,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 12
+          node-version: 'latest'
       - run: npm ci
       - run: npm test
 
@@ -22,10 +22,10 @@ jobs:
     needs: build
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 12
+          node-version: 'latest'
           registry-url: https://registry.npmjs.org/
       - run: npm ci
       - run: npm publish

package/.vs/VSWorkspaceState.json

@@ -0,0 +1,7 @@
+{
+  "ExpandedNodes": [
+    ""
+  ],
+  "SelectedNode": "\\C:\\Users\\peter\\Source\\Repos\\node-red-contrib-prib-functions",
+  "PreviewInSolutionExplorer": false
+}

package/README.md

@@ -4,22 +4,22 @@
 
 *   Data Analysis  - statistical metrics that has real time option
 *   Matrix
-*	Transform
-*	Test
+*   Transform
+*   Test
 *   Load Injector
-*	Monitor Flow
-*	append
-*	Spawn Process
-*	Host Available
-*	node.js os metrics
-*	Levenshtein Distance
+*   Monitor Flow
+*   append
+*   Spawn Process
+*   Host Available
+*   node.js os metrics
+*   Levenshtein Distance
 
 ------------------------------------------------------------
 
 ## Data Analysis
 
 Real time metrics which are recalculated on single of data point and posted in msg.result.
-Key and value can be selected from msg.payload.
+Key and value can be selected from msg.payload. Includes lag (seasonal) along with delta(defference).
 Sending message with topic"@stats" places message with all stats on second port.
 If realtime metrics then a third port is shown where the message is sent if it is an outlier
 being outside 3 standard deviations from mean. This can be changed to median and number of deviations.
@@ -27,7 +27,6 @@ being outside 3 standard deviations from mean. This can be changed to median and
 ![Data Analysis Realtime](documentation/DataAnalysisRealtime.JPG "Data Analysis Realtime")
 ![Data Analysis Pearson R](documentation/DataAnalysisPearsonR.JPG "Data Analysis Pearson R")
 
-
 A set of data analysis functions that can be run over an array of data
 
 Single value metrics:
@@ -44,6 +43,9 @@ Single value metrics:
 Array metrics:
 * Deltas
 * Deltas Normalised
+* difference
+* difference seasonal
+* difference seasonal second order
 * Moving Average Simple (SMA)
 * Moving Average Cumulative (CMA)
 * Moving Average Weighted (WMA)
@@ -53,8 +55,9 @@ Array metrics:
 
 Array data
 * distances 
-* minimum distance(s) between points
-* maximum distance(s) between points
+* distance(s) minimum between points
+* distance(s) maximum between points
+
 
 ![Data Analysis](documentation/DataAnalysis.JPG "Data Analysis")
 
@@ -74,7 +77,7 @@ example:
 
 Define a matrix and perform various functions
 
- * Define / Define Empty / Create / Create Like/ clone"
+ * Define / Define Empty / Create / Create Like/ clone
  * Add / Add Row to Row / Add to Cell / Add Row / Subtract Cell
  * Multiple / Multiple Cell / Divide Cell / Divide Row
  * Transpose
@@ -106,48 +109,48 @@ Messages generates a message for each row or record.
 
 Transformations:
 
-*	Array to CSV
-*	Array to HTML
-*	Array to ISO8385
-*	Array to Messages
-*	Array to xlsx / xlsx object (excel uses [xlsx][7])  
-*	AVRO to JSON (uses [avsc][6])
+*   Array to CSV
+*   Array to HTML
+*   Array to ISO8385
+*   Array to Messages
+*   Array to xlsx / xlsx object (excel uses [xlsx][7])  
+*   AVRO to JSON (uses [avsc][6])
 *   Buffer to comprossed 
-*	Confluence to JSON
+*   Confluence to JSON
 *   Compressed to Buffer
 *   Compressed to String
 *   COmpressed to JSON
-*	CSV to Array
-*	CSV to HTML
-*	CSV to Messages
-*	CSVWithHeader to Array
-*	CSVWithHeader to HTML
-*	CSVWithHeader to JSON
-*	ISO8385 to Array
-*	ISO8385 to JSON
-*	JSON to Array
-*	JSON to Confluence
-*	JSON to CSV
-*	JSON to AVRO (uses [avsc][6])
-*	JSON to ISO8385
-*	JSON to Messages
-*	JSON to String
-*	JSON to xlsx / xlsx object (excel uses [xlsx][7])  
-*	JSON to XML (uses [fast-xml-parser][4])
-*	String to JSON
-*	path to Basename
-*	path to Dirname
-*	path to Extname
-*	path to Format
-*	path to Is Absolute
-*	path to Join
-*	path to Parse
-*	path to Normalize
-*	path to Resolve
-*	snappy compress (uses [snappy][5], must install separately)
-*	snappy uncompress (uses [snappy][5], must install separately)
-*	xlsx / xlsx object to array/JSON (excel uses [xlsx][7])  
-*	XML to JSON (uses [fast-xml-parser][4])
+*   CSV to Array
+*   CSV to HTML
+*   CSV to Messages
+*   CSVWithHeader to Array
+*   CSVWithHeader to HTML
+*   CSVWithHeader to JSON
+*   ISO8385 to Array
+*   ISO8385 to JSON
+*   JSON to Array
+*   JSON to Confluence
+*   JSON to CSV
+*   JSON to AVRO (uses [avsc][6])
+*   JSON to ISO8385
+*   JSON to Messages
+*   JSON to String
+*   JSON to xlsx / xlsx object (excel uses [xlsx][7])  
+*   JSON to XML (uses [fast-xml-parser][4])
+*   String to JSON
+*   path to Basename
+*   path to Dirname
+*   path to Extname
+*   path to Format
+*   path to Is Absolute
+*   path to Join
+*   path to Parse
+*   path to Normalize
+*   path to Resolve
+*   snappy compress (uses [snappy][5], must install separately)
+*   snappy uncompress (uses [snappy][5], must install separately)
+*   xlsx / xlsx object to array/JSON (excel uses [xlsx][7])  
+*   XML to JSON (uses [fast-xml-parser][4])
 
 Note, snappy needs to be installed separately as can have issues with auto install as build binaries.
 
@@ -215,7 +218,6 @@ Test example:
 
 ![Load Injector example](documentation/LoadInjectorTest.JPG "Load Injector example")
 
-
 ------------------------------------------------------------
 
 ## Monitor Flow
@@ -231,34 +233,29 @@ Test example:
 
 ------------------------------------------------------------
 
-## Spawn Process
+## Host Available
 
-Spawn process as per node.js manual with ability to set working directory, environment variables
-and argument passed to process. STDOUT and STDERR are sent as individual messages.
-RC port is sent a message on closure.
-Takes in messages that starts a process with ability to add environment values.
-Message can be sent to kill the process.    
+Test if host is available sending msg to up or down port so action can be taken.
+Message only sent on state change or if message is sent which doesn't have topic refreshHostAvailable.
+This topic forces a check rather than time check which can be set.
 
-![Spawn Process](documentation/SpawnProcess.JPG "Spawn Process")
+![Host Available](documentation/hostAvailable.JPG "Host Available")
 
 Test example:
 
-![Spawn Process example](documentation/SpawnProcessTest.JPG "Spawn Process example")
-
+![Host Available example](documentation/hostAvailableTest.JPG "Host Available example")
 
 ------------------------------------------------------------
 
-## Host Available
+## Monitor System 
 
-Test if host is available sending msg to up or down port so action can be taken.
-Message only sent on state change or if message is sent which doesn't have topic refreshHostAvailable.
-This topic forces a check rather than time check which can be set.
+System monitoring metrics
 
-![Host Available](documentation/hostAvailable.JPG "Host Available")
+![Monitor System](documentation/monitorSystem.JPG "Monitor System")
 
 Test example:
 
-![Host Available example](documentation/hostAvailableTest.JPG "Host Available example")
+![Monitor System example](documentation/monitorSystemTest.JPG "Monitor System example")
 
 ------------------------------------------------------------
 
@@ -274,6 +271,22 @@ Test example:
 
 ------------------------------------------------------------
 
+## Spawn Process
+
+Spawn process as per node.js manual with ability to set working directory, environment variables
+and argument passed to process. STDOUT and STDERR are sent as individual messages.
+RC port is sent a message on closure.
+Takes in messages that starts a process with ability to add environment values.
+Message can be sent to kill the process.    
+
+![Spawn Process](documentation/SpawnProcess.JPG "Spawn Process")
+
+Test example:
+
+![Spawn Process example](documentation/SpawnProcessTest.JPG "Spawn Process example")
+
+------------------------------------------------------------
+
 # Install
 
 Run the following command in the root directory of your Node-RED install
@@ -288,15 +301,16 @@ Test/example flow in test/generalTest.json
 
 # Version
 
+0.21.0 Add lag/seasonal to real time data analystics
+
+0.20.3 Add difference + monitor system
+
 0.19.0 Improve load injector, fix bug in test comparing buffers, add compression tranforms
 
 0.18.0 Add matrix node
 
 0.17.0 Add finished wire to load injector
 
-0.16.0 fix data analysis variance and stddev, add sample, add tests
-
-
 
 # Author
 

package/dataAnalysis/arrayAllRowsSwap.js

@@ -0,0 +1,15 @@
+if(Array.prototype.allRowsSwap==null)
+	  Object.defineProperty(Array.prototype, "allRowsSwap", {
+		  value(x,y) {
+			const l=this.length;
+			for(let i=0; i<l; i++) {
+				const row=this[i]
+        		const temp = row[x];
+        		row[x] = row[y];
+        		row[y] = temp;
+			}
+  			return this;
+		  },
+		  writable: true,
+		  configurable: true
+	  });

package/dataAnalysis/arrayCompareToPrecision.js

@@ -0,0 +1,34 @@
+[Array,Float32Array,Float64Array].forEach(object=>{
+	if(object.prototype.compareToPrecision==null)
+		Object.defineProperty(object.prototype, "compareToPrecision", {
+			value(toArray,precision=6) {
+				const basePrecision=Math.pow(10,-precision);
+				if(this.length!=toArray.length) throw Error("array length different")
+				this.forEach((element,index)=>{
+					const toElement=toArray[index];
+					if(typeof element !== typeof toElement) throw Error("types no same for "+index)
+					if(typeof element == "array"){
+						element.compareToPrecision(toElement,precision)
+						return
+					}
+					switch (typeof element) {
+					case "array":
+						try{
+							element.compareRounded(toElement,precision)
+						} catch(ex) {
+							throw Error(index+","+ex.message)
+						}
+						return;
+					default:
+						const diff = Math.abs(element-toElement) ;
+//						console.log({diff:diff,basePrecision:basePrecision})
+						if(Math.abs(element-toElement)/element > basePrecision)
+							throw Error(index+ " failed "+element+" <> "+toElement);
+					}
+				});
+			},
+			writable: true,
+			configurable: true
+		});
+		
+});

package/dataAnalysis/arrayDifference.js

@@ -0,0 +1,14 @@
+[Array,Float32Array,Float64Array].forEach(object=>{
+    if(object.prototype.difference==null)
+        Object.defineProperty(object.prototype, "difference", {
+            value(order=0) {
+                let i=this.length
+                if(i<2) return new object()
+                const result=new object(i-1)
+                while(--i) result[i-1]=this[i]-this[i-1];
+                return order?result.difference(--order):result;
+            },
+            writable: true,
+             configurable: true
+        });
+})

package/dataAnalysis/arrayDifferenceSeasonal.js

@@ -0,0 +1,15 @@
+
+[Array,Float32Array,Float64Array].forEach(object=>{
+    if(object.prototype.differenceSeasonal==null)
+        Object.defineProperty(object.prototype, "differenceSeasonal", {
+            value(lag=1,order=0) {
+                let i=this.length-lag
+                if(i<1) return new object()
+                const result=new object(i)
+                while(--i>=0) result[i]=this[i+lag]-this[i];
+                return order?result.difference(--order):result;
+            },
+            writable: true,
+             configurable: true
+        });
+})

package/dataAnalysis/arrayDifferenceSeasonalSecondOrder.js

@@ -0,0 +1,20 @@
+[Array,Float32Array,Float64Array].forEach(object=>{
+    if(object.prototype.differenceSeasonalSecondOrder==null)
+        Object.defineProperty(object.prototype, "differenceSeasonalSecondOrder", {
+            value(lag=1) {
+                let i=this.length-lag-1
+                if(i<1) return new object()
+                const result=new object(i)
+                let lastDiff=this[i+lag-1]-this[i-1]
+                while(--i>=0){
+                    const newDiff=this[i+lag-1]-this[i-1]
+                    result[i]=lastDiff-newDiff
+                    lastDiff=newDiff
+                }
+                return result
+            },
+            writable: true,
+             configurable: true
+        });
+})
+

package/dataAnalysis/arrayDifferenceSecondOrder.js

@@ -0,0 +1,14 @@
+[Array,Float32Array,Float64Array].forEach(object=>{
+    if(object.prototype.differenceSecondOrder==null)
+        Object.defineProperty(object.prototype, "differenceSecondOrder", {
+            value() {
+                    let i=this.length-1
+                    if(i<2) return new object()
+                    const result=new object(i-1)
+                    while(--i) result[i-1]=this[i-1]-2*this[i]+this[i+1]
+                    return result;
+                },
+                writable: true,
+                 configurable: true
+            });
+})

package/dataAnalysis/arrayForEachRange.js

@@ -0,0 +1,38 @@
+[Array,Float32Array,Float64Array].forEach(object=>{
+	if(object.prototype.forEachRange==null)
+		Object.defineProperty(object.prototype, "forEachRange", {
+			value(start=0,end=this.length-1,func,o=this) {
+				if(start<=end) {
+					if(end>=this.length) throw Error("end offset "+end+" >= array length "+this.length);
+					if(start<0) throw Error("start offset "+start+"< 0");
+					for(let i=start;i<=end;i++) func(this[i],i,this)
+				} else {
+					if(start>=this.length) throw Error("end<start and start offset "+start+" >= array length "+this.length);
+					if(end<0) throw Error("end<start and end offset "+end+"< 0")
+					for(let i=start;i>=end;i--) func(this[i],i,this)
+				}
+				return this;
+			},
+			writable: true,
+			configurable: true
+		});
+	if(object.prototype.forEachRangeNotTested==null)
+		Object.defineProperty(object.prototype, "forEachRangeNotTested", {
+			value(start=0,end=this.length-1,func,o=this) {
+				if(start<=end) {
+					if(end>=this.length) end=this.length-1;
+					if(start<0) start=0;
+					for(let i=start;i<=end;i++) func(this[i],i,this)
+				} else {
+					if(start>=this.length) start=this.length-1
+					if(end<0) end=0
+					for(let i=start;i>=end;i--) func(this[i],i,this)
+				}
+				return this;
+			},
+			writable: true,
+			configurable: true
+		});
+
+});
+

package/dataAnalysis/arrayOverlay.js

@@ -0,0 +1,13 @@
+[Array,Float32Array,Float64Array].forEach(object=>{
+    if(object.prototype.overlay==null)
+    	Object.defineProperty(object.prototype, "overlay", {
+	    	value(array) {
+             if(array[0] instanceof Array)
+                 array.forEach((element,index)=>this[index].overlay(element));
+             else
+                 array.forEach((element,index)=>this[index]=element);
+	    	},
+	    	writable: true,
+	    	configurable: true
+	    });
+});

package/dataAnalysis/arrayProduct.js

@@ -0,0 +1,11 @@
+[Array,Float32Array,Float64Array].forEach(object=>{
+	if(object.prototype.product==null)
+		Object.defineProperty(object.prototype, "product", {
+			value(i=0,end=this.length-1,product=this[i]) {
+				for(i++;i<=end;i++) product*=this[i];
+				return product;
+			},
+			writable: true,
+			configurable: true
+		});
+})

package/dataAnalysis/arrayRandom.js

@@ -0,0 +1,14 @@
+
+[Array,Float32Array,Float64Array].forEach(object=>{
+    if(object.prototype.random==null)
+        Object.defineProperty(object.prototype, "random", {
+            value(size=this.length) {
+                let i=size
+                const result=new object(i)
+                while(i--) result[i]=Math.random();
+                return result;
+            },
+            writable: true,
+            configurable: true
+        })
+})

package/dataAnalysis/arrayReduceRange.js

@@ -0,0 +1,11 @@
+[Array,Float32Array,Float64Array].forEach(object=>{
+	if(object.prototype.reduceRange==null)
+		Object.defineProperty(object.prototype, "reduceRange", {
+			value(start=0,end=this.length-1,func=(aggregate,cell,index)=>aggregate+cell,aggregate=0,o=this) {
+				for(let i=start;i<=end;i++) aggregate=func(aggregate,this[i],i,this)
+				return aggregate;
+			},
+			writable: true,
+			configurable: true
+		});
+})

package/dataAnalysis/arrayScale.js

@@ -0,0 +1,11 @@
+[Array,Float32Array,Float64Array].forEach(object=>{
+	if(object.prototype.scale==null)
+		Object.defineProperty(object.prototype, "scale", {
+			value(factor,start=0,end=this.length-1) {
+				for(let i=start;i<=end;i++) this[i]*=factor;
+				return this;
+			},
+			writable: true,
+			configurable: true
+		});
+})

package/dataAnalysis/arraySum.js

@@ -0,0 +1,11 @@
+[Array,Float32Array,Float64Array].forEach(object=>{
+	if(object.prototype.sum==null)
+		Object.defineProperty(object.prototype, "sum", {
+			value(i=0,end=this.length-1,sum=0) {
+				for(;i<=end;i++) sum+=this[i];
+				return sum;
+			},
+			writable: true,
+			configurable: true
+		});
+})

package/dataAnalysis/arraySumSquared.js

@@ -0,0 +1,11 @@
+[Array,Float32Array,Float64Array].forEach(object=>{
+	if(object.prototype.sumSquared==null)
+		Object.defineProperty(object.prototype, "sumSquared", {
+			value(i=0,end=this.length-1,sum=0) {
+				for(;i<=end;i++) sum+=this[i]**2;
+				return sum;
+			},
+			writable: true,
+			configurable: true
+		});
+})

package/dataAnalysis/arraySwap.js

@@ -0,0 +1,11 @@
+if(Array.prototype.swap==null)
+	  Object.defineProperty(Array.prototype, "swap", {
+		  value(x,y) {
+        	const temp = this[x];
+        	this[x] = this[y];
+        	this[y] = temp;
+  			return this;
+		  },
+		  writable: true,
+		  configurable: true
+	  });