@processlink/node-red-contrib-processlink 1.0.1 → 1.0.4

package/CHANGELOG.md

@@ -5,7 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.0.1] - 2025-02-05
+## [1.0.4] - 2025-02-05
+
+### Added
+
+- Timestamp prefix option: automatically prefix filenames with `YYYY-MM-DD_HH-MM-SS_`
+- Improved filename documentation explaining how it appears in Process Link Files
+
+## [1.0.3] - 2025-02-05
+
+### Added
+
+- Importable JSON example flow in README for easy customer onboarding
+
+## [1.0.2] - 2025-02-05
 
 ### Changed
 

package/README.md

@@ -116,17 +116,79 @@ Uploads files to the Process Link Files API.
 | 🟢 Green | Upload successful |
 | 🔴 Red | Error occurred |
 
-## Examples
-
-### Basic File Upload
-
-```
-[File In] → [files upload] → [Debug]
+## Example Flow (Copy & Import)
+
+Copy the JSON below and import it into Node-RED: **Menu → Import → Clipboard**
+
+```json
+[
+    {
+        "id": "pl-inject",
+        "type": "inject",
+        "z": "",
+        "name": "Upload File",
+        "props": [],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 110,
+        "y": 100,
+        "wires": [["pl-file-in"]]
+    },
+    {
+        "id": "pl-file-in",
+        "type": "file in",
+        "z": "",
+        "name": "Read File",
+        "filename": "/tmp/myfile.csv",
+        "filenameType": "str",
+        "format": "",
+        "chunk": false,
+        "sendError": false,
+        "encoding": "none",
+        "allProps": true,
+        "x": 270,
+        "y": 100,
+        "wires": [["pl-upload"]]
+    },
+    {
+        "id": "pl-upload",
+        "type": "processlink-files-upload",
+        "z": "",
+        "name": "Upload to Process Link",
+        "server": "",
+        "filename": "",
+        "timeout": "30000",
+        "apiUrl": "https://files.processlink.com.au/api/upload",
+        "x": 470,
+        "y": 100,
+        "wires": [["pl-debug"]]
+    },
+    {
+        "id": "pl-debug",
+        "type": "debug",
+        "z": "",
+        "name": "Result",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "true",
+        "targetType": "full",
+        "x": 650,
+        "y": 100,
+        "wires": []
+    }
+]
 ```
 
-1. Configure a **File In** node to read your file
-2. Connect it to the **files upload** node
-3. Add a **Debug** node to see the response
+**After importing:**
+1. Double-click the **Read File** node → change the file path to your file
+2. Double-click the **Upload to Process Link** node → click the pencil icon → enter your **Site ID** and **API Key**
+3. Click **Deploy**
+4. Click the inject button to upload
 
 ### Dynamic Filename
 
@@ -190,4 +252,4 @@ Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md)
 
 ## License
 
-[MIT](LICENSE) © [Process Link](https://processlink.com.au)
+[MIT](LICENSE)

package/nodes/config/processlink-config.html

@@ -50,7 +50,7 @@
     <dt>Name <span class="property-type">string</span></dt>
     <dd>Optional friendly name for this configuration.</dd>
     <dt>Site ID <span class="property-type">string</span></dt>
-    <dd>The UUID of your site from Process Link. Found in your site settings.</dd>
+    <dd>The UUID of your site from Process Link. Found in your organisation settings under Developer.</dd>
     <dt>API Key <span class="property-type">string</span></dt>
     <dd>
       The API key for authentication. Generate one from Developer → API Keys in the Process Link Portal.

package/nodes/files/processlink-files-upload.html

@@ -6,6 +6,7 @@
       name: { value: "" },
       server: { value: "", type: "processlink-config", required: true },
       filename: { value: "" },
+      timestampPrefix: { value: false },
       timeout: { value: "30000" },
       apiUrl: { value: "https://files.processlink.com.au/api/upload" },
     },
@@ -37,6 +38,11 @@
     <label for="node-input-filename"><i class="fa fa-file"></i> Filename</label>
     <input type="text" id="node-input-filename" placeholder="msg.filename (or specify default)" />
   </div>
+  <div class="form-row">
+    <label for="node-input-timestampPrefix">&nbsp;</label>
+    <input type="checkbox" id="node-input-timestampPrefix" style="width: auto; margin-right: 10px;">
+    <span>Prefix filename with timestamp (YYYY-MM-DD_HH-MM-SS_)</span>
+  </div>
   <div class="form-row">
     <label for="node-input-timeout"><i class="fa fa-clock-o"></i> Timeout</label>
     <input type="text" id="node-input-timeout" placeholder="30000" />
@@ -56,7 +62,17 @@
     <dt>payload <span class="property-type">buffer | string</span></dt>
     <dd>The file content to upload.</dd>
     <dt class="optional">filename <span class="property-type">string</span></dt>
-    <dd>The filename to use. Defaults to the configured filename or "file.bin".</dd>
+    <dd>The filename that will appear in Process Link Files. Can be set via <code>msg.filename</code> or configured in the node. Defaults to "file.bin" if not set. Any path is stripped (e.g., <code>/tmp/report.csv</code> becomes <code>report.csv</code>).</dd>
+  </dl>
+
+  <h3>Configuration</h3>
+  <dl class="message-properties">
+    <dt>Filename <span class="property-type">string</span></dt>
+    <dd>Default filename to use if <code>msg.filename</code> is not set.</dd>
+    <dt>Prefix with timestamp <span class="property-type">boolean</span></dt>
+    <dd>When enabled, automatically prefixes the filename with a timestamp in the format <code>YYYY-MM-DD_HH-MM-SS_</code>. For example, <code>report.csv</code> becomes <code>2025-02-05_14-30-45_report.csv</code>.</dd>
+    <dt>Timeout <span class="property-type">number</span></dt>
+    <dd>Request timeout in milliseconds. Default is 30000 (30 seconds).</dd>
   </dl>
 
   <h3>Outputs</h3>

package/nodes/files/processlink-files-upload.js

@@ -55,7 +55,19 @@ module.exports = function (RED) {
 
       // Get filename
       const filename = msg.filename || config.filename || "file.bin";
-      const basename = filename.split(/[\\/]/).pop();
+      let basename = filename.split(/[\\/]/).pop();
+
+      // Add timestamp prefix if enabled
+      if (config.timestampPrefix) {
+        const now = new Date();
+        const timestamp = now.getFullYear() + "-" +
+          String(now.getMonth() + 1).padStart(2, "0") + "-" +
+          String(now.getDate()).padStart(2, "0") + "_" +
+          String(now.getHours()).padStart(2, "0") + "-" +
+          String(now.getMinutes()).padStart(2, "0") + "-" +
+          String(now.getSeconds()).padStart(2, "0");
+        basename = timestamp + "_" + basename;
+      }
 
       // Build multipart form data
       const boundary = "----NodeREDProcessLink" + Date.now() + Math.random().toString(36).substring(2);

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.0.1",
+  "version": "1.0.4",
   "description": "Node-RED nodes for Process Link platform integration - upload files, send notifications, and connect to industrial automation systems",
   "keywords": [
     "node-red",