node-red-contrib-couchdb-nodes 0.0.1

package/src/nodes/list-docs/couchdb-list-docs.js

@@ -0,0 +1,101 @@
+module.exports = function(RED) {
+  function CouchDBListDocsNode(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+    const serverConfig = RED.nodes.getNode(config.server);
+
+    node.on('input', function(msg) {
+      if (!serverConfig) {
+        node.error("CouchDB server not configured");
+        msg.error = {error: "Server not configured"};
+        node.send([null, msg]);
+        return;
+      }
+
+      const nano = require('nano');
+      const hostname = serverConfig.hostname;
+      const port = serverConfig.port || 5984;
+      const username = serverConfig.username;
+      const password = serverConfig.credentials.password;
+
+      const couchUrl = `http://${username}:${password}@${hostname}:${port}`;
+      const connection = nano(couchUrl);
+
+      // Get database name from config or message
+      const database = msg.database || config.database;
+      
+      if (!database) {
+        node.error("Database name is required");
+        msg.error = {error: "Database name not specified"};
+        node.send([null, msg]);
+        return;
+      }
+
+      const db = connection.use(database);
+
+      // Build query options
+      const options = {};
+      
+      // Pagination options
+      if (msg.limit !== undefined || config.limit) {
+        options.limit = parseInt(msg.limit || config.limit);
+      }
+      
+      if (msg.skip !== undefined) {
+        options.skip = parseInt(msg.skip);
+      }
+      
+      if (msg.startkey !== undefined) {
+        options.startkey = msg.startkey;
+      }
+      
+      if (msg.endkey !== undefined) {
+        options.endkey = msg.endkey;
+      }
+
+      // Include document content if requested
+      if (msg.includeDocs !== undefined) {
+        options.include_docs = msg.includeDocs;
+      } else if (config.includeDocs) {
+        options.include_docs = true;
+      }
+
+      // Descending order
+      if (msg.descending !== undefined) {
+        options.descending = msg.descending;
+      } else if (config.descending) {
+        options.descending = true;
+      }
+
+      node.status({fill: "blue", shape: "dot", text: "listing..."});
+
+      db.list(options)
+        .then(result => {
+          node.status({fill: "green", shape: "dot", text: "success"});
+          msg.payload = result;
+          msg.rows = result.rows;
+          msg.totalRows = result.total_rows;
+          msg.offset = result.offset;
+          
+          // If include_docs was true, extract just the docs
+          if (options.include_docs) {
+            msg.docs = result.rows.map(row => row.doc);
+          }
+          
+          node.send([msg, null]);
+        })
+        .catch(err => {
+          node.status({fill: "red", shape: "ring", text: "error"});
+          node.error("Failed to list documents: " + err.message);
+          msg.error = err;
+          node.send([null, msg]);
+        });
+
+        node.on("close", function() {
+            node.status({});
+        });
+    });
+  }
+
+  RED.nodes.registerType("couchdb-list-docs", CouchDBListDocsNode);
+};

package/src/nodes/query/couchdb-query.html

@@ -0,0 +1,107 @@
+<script type="text/javascript">
+  RED.nodes.registerType('couchdb-query', {
+    category: 'couchdb',
+    color: '#ff6b00',
+    defaults: {
+      name: { value: '' },
+      server: { type: 'couchdb-server', required: true },
+      database: { value: '', required: true },
+      selector: { value: '{}' },
+      limit: { value: '100', validate: RED.validators.number() }
+    },
+    inputs: 1,
+    outputs: 2,
+    icon: 'db.png',
+    label: function() {
+      return this.name || 'CouchDB Query';
+    },
+    oneditprepare: function() {
+      // Validate JSON
+      $('#node-input-selector').on('change', function() {
+        try {
+          JSON.parse($(this).val());
+          $(this).removeClass('input-error');
+        } catch(e) {
+          $(this).addClass('input-error');
+        }
+      });
+    }
+  });
+</script>
+
+<script type="text/x-red" data-template-name="couchdb-query">
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-input-name" placeholder="Query Documents">
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-server"><i class="fa fa-server"></i> Server</label>
+    <input type="text" id="node-input-server">
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-database"><i class="fa fa-database"></i> Database</label>
+    <input type="text" id="node-input-database" placeholder="e.g. node-red-flows">
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-selector"><i class="fa fa-filter"></i> Selector (JSON)</label>
+    <textarea id="node-input-selector" style="width: 100%; height: 100px" placeholder='{"type": "flow"}'>{"type": "flow"}</textarea>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-limit"><i class="fa fa-list"></i> Limit</label>
+    <input type="number" id="node-input-limit" min="1" max="10000">
+  </div>
+
+  <div class="form-tips">
+    <p><strong>Selector:</strong> Mango query selector (JSON format)</p>
+    <p><strong>Output 1 (Success):</strong> msg.payload with results array</p>
+    <p><strong>Output 2 (Error):</strong> msg with error information</p>
+  </div>
+</script>
+
+<script type="text/x-red" data-help-name="couchdb-query">
+  <p>Queries documents from a CouchDB database using Mango queries.</p>
+
+  <h3>Inputs</h3>
+  <dl class="message-properties">
+    <dt class="optional">selector <span class="property-type">object</span></dt>
+    <dd>Mango query selector object (overrides node config if provided)</dd>
+    <dt class="optional">limit <span class="property-type">number</span></dt>
+    <dd>Maximum number of documents to return (overrides node config if provided)</dd>
+    <dt class="optional">database <span class="property-type">string</span></dt>
+    <dd>Database name (overrides node config if provided)</dd>
+  </dl>
+
+  <h3>Outputs</h3>
+  <ol class="node-ports">
+    <li>Success Output
+      <dl class="message-properties">
+        <dt>payload <span class="property-type">array</span></dt>
+        <dd>Array of documents matching the query</dd>
+        <dt>count <span class="property-type">number</span></dt>
+        <dd>Number of documents found</dd>
+        <dt>result <span class="property-type">object</span></dt>
+        <dd>Full query result with metadata</dd>
+      </dl>
+    </li>
+    <li>Error Output
+      <dl class="message-properties">
+        <dt>error <span class="property-type">object</span></dt>
+        <dd>Error details if query fails</dd>
+      </dl>
+    </li>
+  </ol>
+
+  <h3>Selector Examples</h3>
+  <p><strong>Find by field value:</strong></p>
+  <pre>{"type": "sensor"}</pre>
+  
+  <p><strong>Find with conditions:</strong></p>
+  <pre>{"type": "sensor", "active": true}</pre>
+  
+  <p><strong>Find with comparison:</strong></p>
+  <pre>{"temperature": {"\$gt": 20}}</pre>
+</script>

package/src/nodes/query/couchdb-query.js

@@ -0,0 +1,67 @@
+module.exports = function(RED) {
+  function CouchDBQueryNode(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+
+    const serverConfig = RED.nodes.getNode(config.server);
+    if (!serverConfig) {
+      node.error("CouchDB server not configured");
+      return;
+    }
+
+    const nano = require('nano');
+    const url = `http://${serverConfig.username}:${serverConfig.password}@${serverConfig.hostname}:${serverConfig.port}`;
+    const couchdb = nano(url);
+
+    node.on("input", function(msg) {
+      const database = config.database || msg.database;
+      let selector = config.selector ? JSON.parse(config.selector) : msg.selector;
+      const limit = config.limit || msg.limit || 100;
+
+      if (!database) {
+        node.error("Database not specified", msg);
+        return;
+      }
+
+      if (!selector || typeof selector !== 'object') {
+        node.error("Selector must be a valid object", msg);
+        return;
+      }
+
+      try {
+        const db = couchdb.db.use(database);
+        
+        db.find({
+          selector: selector,
+          limit: limit
+        }, (err, result) => {
+          if (err) {
+            node.error(`Query failed: ${err.message}`, msg);
+            msg.error = {
+              code: err.code,
+              message: err.message,
+              status: err.status
+            };
+            node.send([null, msg]);
+          } else {
+            msg.payload = result.docs;
+            msg.count = result.docs.length;
+            msg.result = result;
+            node.send([msg, null]);
+            node.status({ fill: "green", shape: "dot", text: `Found: ${result.docs.length} docs` });
+          }
+        });
+      } catch (error) {
+        node.error(`Connection error: ${error.message}`, msg);
+        msg.error = error;
+        node.send([null, msg]);
+      }
+    });
+
+    node.on("close", function() {
+      node.status({ fill: "grey", shape: "ring", text: "disconnected" });
+    });
+  }
+
+  RED.nodes.registerType("couchdb-query", CouchDBQueryNode);
+};

package/src/nodes/server/couchdb-server.html

@@ -0,0 +1,82 @@
+<script type="text/javascript">
+  RED.nodes.registerType('couchdb-server', {
+    category: 'config',
+    defaults: {
+      hostname: { value: 'localhost', required: true },
+      port: { value: 5984, required: true, validate: RED.validators.number() },
+      username: { value: '', required: true }
+    },
+    credentials: {
+      password: { type: 'password' }
+    },
+    label: function() {
+      return this.username + '@' + this.hostname + ':' + this.port;
+    }
+  });
+</script>
+
+<script type="text/x-red" data-template-name="couchdb-server">
+  <div class="form-row">
+    <label for="node-config-input-hostname"><i class="fa fa-address-book"></i> Hostname</label>
+    <input type="text" id="node-config-input-hostname" placeholder="localhost" style="width: 70%;">
+  </div>
+
+  <div class="form-row">
+    <label for="node-config-input-port"><i class="fa fa-plug"></i> Port</label>
+    <input type="number" id="node-config-input-port" placeholder="5984" style="width: 70%;">
+  </div>
+
+  <div class="form-row">
+    <label for="node-config-input-username"><i class="fa fa-user"></i> Username</label>
+    <input type="text" id="node-config-input-username" placeholder="admin" style="width: 70%;">
+  </div>
+
+  <div class="form-row">
+    <label for="node-config-input-password"><i class="fa fa-lock"></i> Password</label>
+    <input type="password" id="node-config-input-password" placeholder="password" style="width: 70%;">
+  </div>
+
+  <div class="form-tips">
+    <p><strong>Hostname:</strong> CouchDB server address (e.g., localhost, couchdb.example.com)</p>
+    <p><strong>Port:</strong> CouchDB port (default 5984)</p>
+    <p><strong>Username:</strong> CouchDB admin or valid user account</p>
+    <p><strong>Password:</strong> Will be stored securely in credentials</p>
+  </div>
+</script>
+
+<script type="text/x-red" data-help-name="couchdb-server">
+  <p>Configuration node for connecting to a CouchDB server.</p>
+  <p>This node stores the CouchDB connection details (hostname, port, username, password)
+     and is used by all CouchDB operation nodes (Get, Insert, Update, Query).</p>
+
+  <h3>Configuration</h3>
+  <dl class="message-properties">
+    <dt>Hostname</dt>
+    <dd>The hostname or IP address of the CouchDB server</dd>
+    <dt>Port</dt>
+    <dd>The port CouchDB is listening on (typically 5984)</dd>
+    <dt>Username</dt>
+    <dd>Valid CouchDB user with database access</dd>
+    <dt>Password</dt>
+    <dd>Password for the user (stored securely in Node-RED)</dd>
+  </dl>
+
+  <h3>Examples</h3>
+  <h4>Local Development</h4>
+  <ul>
+    <li>Hostname: <code>localhost</code></li>
+    <li>Port: <code>5984</code></li>
+    <li>Username: <code>admin</code></li>
+  </ul>
+
+  <h4>Kubernetes</h4>
+  <ul>
+    <li>Hostname: <code>node-red-kanr-couchdb.node-red-dev.svc.cluster.local</code></li>
+    <li>Port: <code>5984</code></li>
+    <li>Username: <code>admin</code></li>
+  </ul>
+
+  <h3>Using with Operation Nodes</h3>
+  <p>Once created, select this server configuration in any CouchDB operation node
+     (Get, Insert, Update, Query). All nodes will use the same connection.</p>
+</script>

package/src/nodes/server/couchdb-server.js

@@ -0,0 +1,17 @@
+module.exports = function(RED) {
+  'use strict';
+
+  function CouchDBServerNode(n) {
+    RED.nodes.createNode(this, n);
+    this.hostname = n.hostname;
+    this.port = n.port || 5984;
+    this.username = n.username;
+    this.password = this.credentials.password;
+  }
+
+  RED.nodes.registerType('couchdb-server', CouchDBServerNode, {
+    credentials: {
+      password: { type: 'password' }
+    }
+  });
+};

package/src/nodes/update/couchdb-update.html

@@ -0,0 +1,90 @@
+<script type="text/javascript">
+  RED.nodes.registerType('couchdb-update', {
+    category: 'couchdb',
+    color: '#ff6b00',
+    defaults: {
+      name: { value: '' },
+      server: { type: 'couchdb-server', required: true },
+      database: { value: '', required: true }
+    },
+    inputs: 1,
+    outputs: 2,
+    icon: 'db.png',
+    label: function() {
+      return this.name || 'CouchDB Update';
+    }
+  });
+</script>
+
+<script type="text/x-red" data-template-name="couchdb-update">
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-input-name" placeholder="Update Document">
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-server"><i class="fa fa-server"></i> Server</label>
+    <input type="text" id="node-input-server">
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-database"><i class="fa fa-database"></i> Database</label>
+    <input type="text" id="node-input-database" placeholder="e.g. node-red-flows">
+  </div>
+
+  <div class="form-tips">
+    <p><strong>Input:</strong> msg.payload must be a document with _id and _rev fields</p>
+    <p><strong>Workflow:</strong> Get document first, modify it, then update</p>
+    <p><strong>Output 1 (Success):</strong> msg with result containing new _rev</p>
+    <p><strong>Output 2 (Error):</strong> msg with error information</p>
+  </div>
+</script>
+
+<script type="text/x-red" data-help-name="couchdb-update">
+  <p>Updates an existing document in a CouchDB database.</p>
+
+  <h3>Inputs</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">object</span></dt>
+    <dd>The document to update. <strong>Must include:</strong>
+      <ul>
+        <li><code>_id</code> - The document ID</li>
+        <li><code>_rev</code> - The current revision (get this from Get node first)</li>
+      </ul>
+    </dd>
+    <dt class="optional">database <span class="property-type">string</span></dt>
+    <dd>Database name (overrides node config if provided)</dd>
+  </dl>
+
+  <h3>Outputs</h3>
+  <ol class="node-ports">
+    <li>Success Output
+      <dl class="message-properties">
+        <dt>result <span class="property-type">object</span></dt>
+        <dd>Result containing <code>_id</code>, <code>_rev</code> (new), and <code>ok: true</code></dd>
+        <dt>docId <span class="property-type">string</span></dt>
+        <dd>The document ID</dd>
+        <dt>docRev <span class="property-type">string</span></dt>
+        <dd>The new document revision</dd>
+      </dl>
+    </li>
+    <li>Error Output
+      <dl class="message-properties">
+        <dt>error <span class="property-type">object</span></dt>
+        <dd>Error details if update fails (e.g., conflict, not found)</dd>
+      </dl>
+    </li>
+  </ol>
+
+  <h3>Typical Workflow</h3>
+  <ol>
+    <li>Use <strong>CouchDB Get</strong> to retrieve the document</li>
+    <li>Modify the document in a function node</li>
+    <li>Use <strong>CouchDB Update</strong> to save changes</li>
+  </ol>
+
+  <h3>Example Flow</h3>
+  <pre>
+Inject → Get [doc_id] → Function [modify payload] → Update → Debug
+  </pre>
+</script>

package/src/nodes/update/couchdb-update.js

@@ -0,0 +1,73 @@
+module.exports = function(RED) {
+  function CouchDBUpdateNode(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+
+    const serverConfig = RED.nodes.getNode(config.server);
+    if (!serverConfig) {
+      node.error("CouchDB server not configured");
+      return;
+    }
+
+    const nano = require('nano');
+    const url = `http://${serverConfig.username}:${serverConfig.password}@${serverConfig.hostname}:${serverConfig.port}`;
+    const couchdb = nano(url);
+
+    node.on("input", function(msg) {
+      const database = config.database || msg.database;
+      const document = msg.payload;
+
+      if (!database) {
+        node.error("Database not specified", msg);
+        return;
+      }
+
+      if (!document || typeof document !== 'object') {
+        node.error("Payload must be an object", msg);
+        return;
+      }
+
+      if (!document._id) {
+        node.error("Document must have _id field", msg);
+        return;
+      }
+
+      if (!document._rev) {
+        node.error("Document must have _rev field (use Get node first)", msg);
+        return;
+      }
+
+      try {
+        const db = couchdb.db.use(database);
+        
+        db.insert(document, (err, result) => {
+          if (err) {
+            node.error(`Update failed: ${err.message}`, msg);
+            msg.error = {
+              code: err.code,
+              message: err.message,
+              status: err.status
+            };
+            node.send([null, msg]);
+          } else {
+            msg.result = result;
+            msg.docId = result.id;
+            msg.docRev = result.rev;
+            node.send([msg, null]);
+            node.status({ fill: "green", shape: "dot", text: `Updated: ${result.id}` });
+          }
+        });
+      } catch (error) {
+        node.error(`Connection error: ${error.message}`, msg);
+        msg.error = error;
+        node.send([null, msg]);
+      }
+    });
+
+    node.on("close", function() {
+      node.status({ fill: "grey", shape: "ring", text: "disconnected" });
+    });
+  }
+
+  RED.nodes.registerType("couchdb-update", CouchDBUpdateNode);
+};