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

package/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+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
+
+### Changed
+
+- Switch to Bearer token authentication (`Authorization: Bearer <apiKey>`)
+- Update documentation to reference Process Link Portal → Developer → API Keys
+- Add Process Link logo to README header
+
+## [1.0.0] - 2025-02-03
+
+### Added
+
+- Initial release
+- **files upload** node for uploading files to Process Link Files API
+- **processlink-config** configuration node for credential management
+- Support for dynamic filenames via `msg.filename`
+- Status indicators for upload progress
+- Comprehensive error handling with status codes
+- Example flow included
+- Process Link branding (logo and banner)
+
+### API
+
+- Authentication uses Bearer token (`Authorization: Bearer <apiKey>`)
+- Site identification via `x-site-id` header
+- Get credentials from Process Link Portal → Developer → API Keys
+
+### Security
+
+- API keys stored encrypted by Node-RED
+- All API communication over HTTPS
+- Keys never logged or exposed in flow exports

package/README.md

@@ -1,14 +1,41 @@
-# @processlink/node-red-contrib-processlink
+<p align="center">
+  <a href="https://processlink.com.au">
+    <img src="processlink-logo.png" alt="Process Link" width="80">
+  </a>
+</p>
 
-Node-RED nodes for Process Link platform integration.
+<p align="center">
+  <a href="https://processlink.com.au">
+    <img src="processlink-banner.png" alt="Process Link" height="50">
+  </a>
+</p>
+
+<h3 align="center">Node-RED Integration</h3>
+
+<p align="center">
+  <em>Connect your Node-RED flows to the Process Link platform</em>
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@processlink/node-red-contrib-processlink"><img src="https://img.shields.io/npm/v/@processlink/node-red-contrib-processlink.svg" alt="npm version"></a>
+  <a href="https://www.npmjs.com/package/@processlink/node-red-contrib-processlink"><img src="https://img.shields.io/npm/dm/@processlink/node-red-contrib-processlink.svg" alt="npm downloads"></a>
+  <a href="https://nodered.org"><img src="https://img.shields.io/badge/Node--RED-%3E%3D2.0.0-red.svg" alt="Node-RED"></a>
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT"></a>
+</p>
+
+---
+
+## Overview
+
+Connect your Node-RED flows to the [Process Link](https://processlink.com.au) platform. Upload files, send notifications, and integrate with industrial automation systems.
 
 ## Available Nodes
 
-| Node | Category | Description |
-|------|----------|-------------|
-| **files upload** | Process Link | Upload files to Process Link Files API |
+| Node | Description |
+|------|-------------|
+| **files upload** | Upload files to Process Link Files API |
 
-*More nodes coming soon: mail, downtime, notes*
+*More nodes coming soon: mail, downtime logging, notes*
 
 ## Installation
 
@@ -30,20 +57,27 @@ Then restart Node-RED.
 
 ## Quick Start
 
-1. **Get your credentials** from your Process Link app:
-   - Go to **Settings → API Keys**
-   - Click **Generate API Key**
-   - Copy the **Site ID** and **API Key**
+### 1. Get Your Credentials
 
-2. **Add a node** to your flow:
-   - Find nodes in the palette under "Process Link"
-   - Drag one into your flow
+1. Log in to the [Process Link Portal](https://portal.processlink.com.au)
+2. Go to **Developer → API Keys**
+3. Click **Generate API Key**
+4. Copy your **Site ID** and **API Key**
 
-3. **Configure credentials**:
-   - Double-click the node
-   - Click the pencil icon next to "Config"
-   - Enter your **Site ID** and **API Key**
-   - Click **Add**, then **Done**
+### 2. Add and Configure a Node
+
+1. Find the **files upload** node in the palette under "Process Link"
+2. Drag it into your flow
+3. Double-click to configure
+4. Click the pencil icon next to "Config"
+5. Enter your **Site ID** and **API Key**
+6. Click **Add**, then **Done**
+
+### 3. Connect Your Flow
+
+```
+[File In] → [files upload] → [Debug]
+```
 
 ## Node Reference
 
@@ -51,12 +85,20 @@ Then restart Node-RED.
 
 Uploads files to the Process Link Files API.
 
+#### Configuration
+
+| Property | Description |
+|----------|-------------|
+| Config | Your Process Link credentials (Site ID + API Key) |
+| Filename | Default filename (optional, can be set via `msg.filename`) |
+| Timeout | Request timeout in milliseconds (default: 30000) |
+
 #### Inputs
 
 | Property | Type | Description |
 |----------|------|-------------|
 | `msg.payload` | Buffer \| string | The file content to upload |
-| `msg.filename` | string | (Optional) Filename to use |
+| `msg.filename` | string | *(Optional)* Filename to use |
 
 #### Outputs
 
@@ -68,13 +110,15 @@ Uploads files to the Process Link Files API.
 
 #### Status Indicators
 
-- Yellow: Uploading in progress
-- Green: Upload successful
-- Red: Error occurred
+| Color | Meaning |
+|-------|---------|
+| 🟡 Yellow | Uploading in progress |
+| 🟢 Green | Upload successful |
+| 🔴 Red | Error occurred |
 
-## Example Flow
+## Examples
 
-Upload a file from disk:
+### Basic File Upload
 
 ```
 [File In] → [files upload] → [Debug]
@@ -82,45 +126,68 @@ Upload a file from disk:
 
 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 result
-4. Configure the upload node with your Site ID and API Key
+3. Add a **Debug** node to see the response
 
 ### Dynamic Filename
 
-Set the filename dynamically in a Function node:
+Use a Function node to set the filename dynamically:
 
 ```javascript
 msg.filename = "report-" + new Date().toISOString().split('T')[0] + ".csv";
 return msg;
 ```
 
+### Upload with Error Handling
+
+```
+[File In] → [files upload] → [Switch] → [Debug (success)]
+                                     ↘ [Debug (error)]
+```
+
+Use a Switch node to route based on `msg.statusCode`:
+- Route 1: `msg.statusCode == 201` (success)
+- Route 2: Otherwise (error)
+
 ## Error Handling
 
 | Status Code | Meaning | Solution |
 |-------------|---------|----------|
 | 201 | Success | File uploaded successfully |
 | 400 | Bad Request | Check that payload is a valid file buffer |
-| 401 | Unauthorized | Check your API key is correct |
+| 401 | Unauthorized | Verify your API key is correct |
 | 403 | Forbidden | Enable API access in site settings |
-| 404 | Not Found | Check your Site ID is correct |
-| 429 | Rate Limited | Slow down - max 30 uploads/minute per site |
-| 507 | Storage Full | Contact your administrator to increase storage |
+| 404 | Not Found | Verify your Site ID is correct |
+| 429 | Rate Limited | Max 30 uploads/minute per site |
+| 507 | Storage Full | Contact administrator to increase storage |
 
 ## Rate Limits
 
-The API allows **30 uploads per minute** per site. If you exceed this limit, you'll receive a 429 status code. The node will still output the message so you can implement retry logic in your flow.
+- **30 uploads per minute** per site
+- Exceeding the limit returns a 429 status code
+- Implement retry logic in your flow for high-volume uploads
 
 ## Security
 
-- API keys are stored encrypted by Node-RED
-- All communication uses HTTPS
-- Keys are never logged or exposed in flow exports
+- ✅ API keys are stored encrypted by Node-RED
+- ✅ All communication uses HTTPS
+- ✅ Keys are never logged or exposed in flow exports
+
+## Requirements
+
+- Node-RED >= 2.0.0
+- Node.js >= 14.0.0
 
 ## Support
 
-- **Issues**: [GitHub Issues](https://github.com/process-link/node-red-contrib-processlink/issues)
-- **Email**: support@processlink.com.au
+- 📖 **Documentation**: [GitHub Wiki](https://github.com/process-link/node-red-contrib-processlink/wiki)
+- 🐛 **Issues**: [GitHub Issues](https://github.com/process-link/node-red-contrib-processlink/issues)
+- 📧 **Email**: support@processlink.com.au
+- 🌐 **Website**: [processlink.com.au](https://processlink.com.au)
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) before submitting a pull request.
 
 ## License
 
-MIT
+[MIT](LICENSE) © [Process Link](https://processlink.com.au)

package/examples/files-upload.json

@@ -132,7 +132,7 @@
         "type": "comment",
         "z": "pl-example-flow",
         "name": "Instructions: Configure the 'Upload to Process Link' node with your Site ID and API Key",
-        "info": "1. Double-click the orange 'Upload to Process Link' node\n2. Click the pencil icon next to 'Config'\n3. Enter your Site ID and API Key from the Process Link Files app\n4. Update the 'Read File' node with the path to your file\n5. Click the inject button to upload",
+        "info": "1. Double-click the orange 'Upload to Process Link' node\n2. Click the pencil icon next to 'Config'\n3. Enter your Site ID and API Key from the Process Link Portal (Developer → API Keys)\n4. Update the 'Read File' node with the path to your file\n5. Click the inject button to upload",
         "x": 330,
         "y": 40,
         "wires": []

package/nodes/config/processlink-config.html

@@ -33,11 +33,11 @@
   </div>
   <div class="form-tips">
     <p>
-      Get your Site ID and API Key from
-      <a href="https://processlink.com.au" target="_blank">Process Link</a>.
+      Get your Site ID and API Key from the
+      <a href="https://portal.processlink.com.au" target="_blank">Process Link Portal</a>.
     </p>
     <p>
-      Go to <strong>Settings → API Keys</strong> in your app to generate a new key.
+      Go to <strong>Developer → API Keys</strong> to generate a new key.
     </p>
   </div>
 </script>
@@ -53,7 +53,7 @@
     <dd>The UUID of your site from Process Link. Found in your site settings.</dd>
     <dt>API Key <span class="property-type">string</span></dt>
     <dd>
-      The API key for authentication. Generate one from Settings → API Keys in your Process Link app.
+      The API key for authentication. Generate one from Developer → API Keys in the Process Link Portal.
     </dd>
   </dl>
 

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

@@ -11,7 +11,7 @@
     },
     inputs: 1,
     outputs: 1,
-    icon: "processlink.svg",
+    icon: "processlink.png",
     paletteLabel: "files upload",
     label: function () {
       return this.name || "files upload";
@@ -100,8 +100,8 @@ and msg.filename. Connect directly to this node to upload.</pre>
   <h3>References</h3>
   <ul>
     <li>
-      <a href="https://files.processlink.com.au" target="_blank">Process Link Files</a> - Manage
-      your files and API keys
+      <a href="https://portal.processlink.com.au" target="_blank">Process Link Portal</a> - Manage
+      your sites and API keys
     </li>
     <li>
       <a href="https://github.com/process-link/node-red-contrib-processlink" target="_blank"

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

@@ -82,7 +82,7 @@ module.exports = function (RED) {
           "Content-Type": `multipart/form-data; boundary=${boundary}`,
           "Content-Length": body.length,
           "x-site-id": siteId,
-          "x-api-key": apiKey,
+          "Authorization": `Bearer ${apiKey}`,
         },
       };
 

package/package.json

@@ -3,8 +3,8 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.0.0",
-  "description": "Node-RED nodes for Process Link platform integration",
+  "version": "1.0.1",
+  "description": "Node-RED nodes for Process Link platform integration - upload files, send notifications, and connect to industrial automation systems",
   "keywords": [
     "node-red",
     "processlink",
@@ -14,7 +14,10 @@
     "api",
     "industrial",
     "iot",
-    "automation"
+    "automation",
+    "manufacturing",
+    "scada",
+    "plc"
   ],
   "node-red": {
     "version": ">=2.0.0",
@@ -26,7 +29,12 @@
   "scripts": {
     "test": "echo \"No tests yet\" && exit 0"
   },
-  "author": "Process Link <support@processlink.com.au>",
+  "author": {
+    "name": "Process Link",
+    "email": "support@processlink.com.au",
+    "url": "https://processlink.com.au"
+  },
+  "contributors": [],
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -35,7 +43,11 @@
   "bugs": {
     "url": "https://github.com/process-link/node-red-contrib-processlink/issues"
   },
-  "homepage": "https://github.com/process-link/node-red-contrib-processlink#readme",
+  "homepage": "https://processlink.com.au",
+  "funding": {
+    "type": "individual",
+    "url": "https://processlink.com.au"
+  },
   "engines": {
     "node": ">=14.0.0"
   }