node-red-contrib-aws-sqs-variable 1.0.0

package/aws-sqs-config.js

@@ -0,0 +1,272 @@
+/**
+ * AWS SQS Configuration Node
+ *
+ * Provides configuration for AWS SQS operations in Node-RED.
+ * Supports IAM roles and access key authentication with context support.
+ */
+
+const { SQSClient } = require("@aws-sdk/client-sqs");
+
+module.exports = function(RED) {
+    /**
+     * Helper function to get value from different contexts
+     * @param {Object} node - Node instance
+     * @param {string} value - Value to get
+     * @param {string} type - Type of value (str, flow, global, env)
+     * @param {Object} msg - Message object
+     * @returns {string} Retrieved value
+     */
+    function getValueFromContext(node, value, type, msg) {
+        if (value === null || value === undefined) return null;
+
+        try {
+            let result;
+            switch (type) {
+                case 'flow':
+                    const flowContext = node.context().flow;
+                    if (!flowContext) {
+                        return null;
+                    }
+                    result = getNestedValue(flowContext, value);
+                    break;
+                case 'global':
+                    const globalContext = node.context().global;
+                    if (!globalContext) {
+                        return null;
+                    }
+                    result = getNestedValue(globalContext, value);
+                    break;
+                case 'env':
+                    result = process.env[value];
+                    break;
+                case 'msg':
+                    result = RED.util.getMessageProperty(msg, value);
+                    break;
+                default:
+                    result = value;
+            }
+
+            return result !== undefined ? result : null;
+        } catch (err) {
+            throw new Error(`Failed to get value for type: ${type}, value: ${value}. Error: ${err.message}`);
+        }
+    }
+
+    /**
+     * Helper function to get nested values like "all_vars.host"
+     * @param {Object} context - Context object
+     * @param {string} path - Dot-separated path
+     * @returns {*} Retrieved value
+     */
+    function getNestedValue(context, path) {
+        if (!context) return undefined;
+        
+        if (path.includes('.')) {
+            const parts = path.split('.');
+            let result = context.get(parts[0]);
+            for (let i = 1; i < parts.length; i++) {
+                if (result && typeof result === 'object') {
+                    result = result[parts[i]];
+                } else {
+                    return undefined;
+                }
+            }
+            return result;
+        } else {
+            return context.get(path);
+        }
+    }
+
+    /**
+     * AWS SQS Configuration Node constructor
+     *
+     * @param {Object} config - Node configuration
+     * @param {string} config.name - Node name
+     * @param {boolean} config.useIAMRole - Whether to use IAM role
+     */
+    function AWSSQSConfigNode(config) {
+        RED.nodes.createNode(this, config);
+        
+        this.name = config.name || "AWS SQS Config";
+        this.region = config.region || "eu-central-1";
+        
+        // Store credential types and values
+        this.useIAMRole = config.useIAMRole === true || config.useIAMRole === "true" || config.useIAMRole === 1;
+        this.deferMissingConfig = config.deferMissingConfig === undefined ? true : (config.deferMissingConfig === true || config.deferMissingConfig === "true");
+        this.regionType = config.regionType || 'str';
+        this.regionContext = config.regionContext;
+        this.accessKeyIdType = config.accessKeyIdType || 'str';
+        this.secretAccessKeyType = config.secretAccessKeyType || 'str';
+        this.accessKeyId = config.accessKeyId;
+        this.accessKeyIdContext = config.accessKeyIdContext;
+        this.secretAccessKey = config.secretAccessKey;
+        this.secretAccessKeyContext = config.secretAccessKeyContext;
+
+        /**
+         * Parse credential values based on type
+         * @param {string} value - Value to parse
+         * @param {string} type - Type of value
+         * @param {Object} msg - Message object
+         * @param {Object} executingNode - Node executing the request
+         * @returns {string|null} Parsed value
+         */
+        this.parseCredentialValue = function(value, type, msg, executingNode) {
+            if (!value) {
+                return null;
+            }
+            
+            try {
+                let result;
+                switch (type) {
+                    case 'str':
+                        result = value;
+                        break;
+                    case 'flow':
+                        result = getValueFromContext(executingNode || this, value, 'flow', msg);
+                        break;
+                    case 'global':
+                        result = getValueFromContext(executingNode || this, value, 'global', msg);
+                        break;
+                    case 'env':
+                        result = process.env[value] || null;
+                        break;
+                    default:
+                        result = value;
+                }
+                
+                return result;
+            } catch (error) {
+                if (executingNode) {
+                    executingNode.error(`Error parsing credential value: ${error.message}`);
+                }
+                return null;
+            }
+        };
+
+        /**
+         * Resolve region based on configuration
+         * @param {Object} msg - Message object
+         * @param {Object} executingNode - Node executing the request
+         * @returns {string} Region string
+         */
+        this.resolveRegion = function(msg, executingNode) {
+            if (this.regionType === 'str') {
+                return this.region || process.env.AWS_REGION || "eu-central-1";
+            }
+
+            const resolved = this.parseCredentialValue(this.regionContext, this.regionType, msg, executingNode);
+            return resolved || process.env.AWS_REGION || "eu-central-1";
+        };
+
+        /**
+         * Get credentials based on configuration
+         * @param {Object} msg - Message object
+         * @param {Object} executingNode - Node executing the request
+         * @returns {Object} Credentials object
+         */
+        this.getCredentials = function(msg, executingNode) {
+            if (this.useIAMRole) {
+                return {
+                    useIAMRole: true,
+                    region: this.resolveRegion(msg, executingNode)
+                };
+            }
+
+            try {
+                // Handle Access Key ID
+                let accessKeyId;
+                if (this.accessKeyIdType === 'str') {
+                    accessKeyId = this.credentials?.accessKeyId;
+                } else {
+                    accessKeyId = this.parseCredentialValue(this.accessKeyIdContext, this.accessKeyIdType, msg, executingNode);
+                }
+
+                // Handle Secret Access Key
+                let secretAccessKey;
+                if (this.secretAccessKeyType === 'str') {
+                    secretAccessKey = this.credentials?.secretAccessKey;
+                } else {
+                    secretAccessKey = this.parseCredentialValue(this.secretAccessKeyContext, this.secretAccessKeyType, msg, executingNode);
+                }
+
+                if (!accessKeyId || !secretAccessKey) {
+                    const missingFields = [];
+                    if (!accessKeyId) missingFields.push('Access Key ID');
+                    if (!secretAccessKey) missingFields.push('Secret Access Key');
+                    if (this.deferMissingConfig) {
+                        return null;
+                    }
+                    throw new Error(`Missing required credentials: ${missingFields.join(', ')}`);
+                }
+
+                return {
+                    accessKeyId,
+                    secretAccessKey,
+                    region: this.resolveRegion(msg, executingNode)
+                };
+            } catch (err) {
+                if (this.deferMissingConfig) {
+                    return null;
+                }
+                throw new Error(`Failed to get AWS credentials: ${err.message}`);
+            }
+        };
+
+        /**
+         * Get AWS SQS client
+         * @param {Object} msg - Message object
+         * @param {Object} executingNode - Node executing the request
+         * @returns {SQSClient} AWS SQS client
+         */
+        this.getClient = (msg, executingNode) => {
+            try {
+                if (this.useIAMRole) {
+                    return new SQSClient({
+                        region: this.resolveRegion(msg, executingNode)
+                    });
+                }
+
+                const credentials = this.getCredentials(msg, executingNode);
+                if (!credentials) {
+                    return null;
+                }
+
+                return new SQSClient({
+                    region: credentials.region,
+                    credentials: {
+                        accessKeyId: credentials.accessKeyId,
+                        secretAccessKey: credentials.secretAccessKey
+                    }
+                });
+
+            } catch (error) {
+                if (executingNode) {
+                    executingNode.error(`Failed to create SQS client: ${error.message}`);
+                }
+                throw error;
+            }
+        };
+    }
+
+    // Register node type with credentials
+    RED.nodes.registerType("aws-sqs-config", AWSSQSConfigNode, {
+        credentials: {
+            accessKeyId: { type: "text" },
+            secretAccessKey: { type: "password" }
+        },
+        defaults: {
+            name: { value: "" },
+            region: { value: "eu-central-1", required: true },
+            regionType: { value: "str" },
+            regionContext: { value: "" },
+            useIAMRole: { value: false, required: true },
+            deferMissingConfig: { value: true },
+            accessKeyId: { value: "" },
+            accessKeyIdType: { value: "str" },
+            accessKeyIdContext: { value: "" },
+            secretAccessKey: { value: "" },
+            secretAccessKeyType: { value: "str" },
+            secretAccessKeyContext: { value: "" }
+        }
+    });
+};

package/aws-sqs.html

@@ -0,0 +1,253 @@
+<script type="text/javascript">
+    RED.nodes.registerType("aws-sqs", {
+        category: "AWS",
+        color: "#b2e2b2",
+        defaults: {
+            name: { value: "" },
+            awsConfig: { value: "", type: "aws-sqs-config", required: true },
+            operation: { value: "send", required: true },
+            queueUrl: { value: "" },
+            queueUrlType: { value: "str" },
+            messageBody: { value: "payload" },
+            messageBodyType: { value: "msg" },
+            messageGroupId: { value: "" },
+            messageGroupIdType: { value: "str" },
+            messageDeduplicationId: { value: "" },
+            messageDeduplicationIdType: { value: "str" },
+            maxNumberOfMessages: { value: 1 },
+            waitTimeSeconds: { value: 0 },
+            visibilityTimeout: { value: 30 },
+            deleteAfterReceive: { value: true },
+            parseJsonBody: { value: false },
+            pollEnabled: { value: false },
+            pollIntervalSeconds: { value: 30 }
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: "font-awesome/fa-exchange",
+        label: function() {
+            return this.name || "AWS SQS (" + this.operation + ")";
+        },
+        oneditprepare: function() {
+            // Initialize typedInput for Queue URL
+            $("#node-input-queueUrl").typedInput({
+                default: 'str',
+                types: ['str', 'msg', 'flow', 'global', 'env'],
+                typeField: "#node-input-queueUrlType"
+            });
+            $("#node-input-queueUrl").typedInput('type', this.queueUrlType || 'str');
+            $("#node-input-queueUrl").typedInput('value', this.queueUrl || '');
+
+            // Initialize typedInput for Message Body
+            $("#node-input-messageBody").typedInput({
+                default: 'msg',
+                types: ['msg', 'str', 'flow', 'global', 'env'],
+                typeField: "#node-input-messageBodyType"
+            });
+            $("#node-input-messageBody").typedInput('type', this.messageBodyType || 'msg');
+            $("#node-input-messageBody").typedInput('value', this.messageBody || 'payload');
+
+            // Initialize typedInput for Message Group ID (FIFO)
+            $("#node-input-messageGroupId").typedInput({
+                default: 'str',
+                types: ['str', 'msg', 'flow', 'global', 'env'],
+                typeField: "#node-input-messageGroupIdType"
+            });
+            $("#node-input-messageGroupId").typedInput('type', this.messageGroupIdType || 'str');
+            $("#node-input-messageGroupId").typedInput('value', this.messageGroupId || '');
+
+            // Initialize typedInput for Message Deduplication ID (FIFO)
+            $("#node-input-messageDeduplicationId").typedInput({
+                default: 'str',
+                types: ['str', 'msg', 'flow', 'global', 'env'],
+                typeField: "#node-input-messageDeduplicationIdType"
+            });
+            $("#node-input-messageDeduplicationId").typedInput('type', this.messageDeduplicationIdType || 'str');
+            $("#node-input-messageDeduplicationId").typedInput('value', this.messageDeduplicationId || '');
+
+            // Initialize tooltips
+            $('.node-input').tooltip({
+                delay: { show: 500, hide: 100 },
+                trigger: 'hover'
+            });
+
+            var updateOperationFields = function() {
+                var operation = $("#node-input-operation").val();
+                if (operation === "send") {
+                    $("#sendFields").show();
+                    $("#receiveFields").hide();
+                } else {
+                    $("#sendFields").hide();
+                    $("#receiveFields").show();
+                }
+            };
+
+            $("#node-input-operation").on("change", updateOperationFields);
+            updateOperationFields();
+        },
+        oneditsave: function() {
+            this.queueUrlType = $("#node-input-queueUrlType").val();
+            this.queueUrl = $("#node-input-queueUrl").typedInput('value');
+            this.messageBodyType = $("#node-input-messageBodyType").val();
+            this.messageBody = $("#node-input-messageBody").typedInput('value');
+            this.messageGroupIdType = $("#node-input-messageGroupIdType").val();
+            this.messageGroupId = $("#node-input-messageGroupId").typedInput('value');
+            this.messageDeduplicationIdType = $("#node-input-messageDeduplicationIdType").val();
+            this.messageDeduplicationId = $("#node-input-messageDeduplicationId").typedInput('value');
+        }
+    });
+</script>
+
+<script type="text/x-red" data-template-name="aws-sqs">
+    <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="AWS SQS" style="width: 70%;">
+    </div>
+    <div class="form-row">
+        <label for="node-input-awsConfig">
+            <i class="fa fa-cog"></i> AWS Config
+        </label>
+        <input type="text" id="node-input-awsConfig" style="width: 70%;">
+    </div>
+    <div class="form-row">
+        <label for="node-input-operation">
+            <i class="fa fa-exchange"></i> Operation
+        </label>
+        <select id="node-input-operation" style="width: 70%;">
+            <option value="send">Send Message</option>
+            <option value="receive">Receive Messages</option>
+        </select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-queueUrl">
+            <i class="fa fa-link"></i> Queue URL
+        </label>
+        <input type="text" id="node-input-queueUrl" style="width: 70%;">
+        <input type="hidden" id="node-input-queueUrlType">
+    </div>
+
+    <div id="sendFields">
+        <div class="form-row">
+            <label for="node-input-messageBody">
+                <i class="fa fa-envelope"></i> Message Body
+            </label>
+            <input type="text" id="node-input-messageBody" style="width: 70%;">
+            <input type="hidden" id="node-input-messageBodyType">
+        </div>
+        <div class="form-row">
+            <label for="node-input-messageGroupId">
+                <i class="fa fa-object-group"></i> Message Group ID
+            </label>
+            <input type="text" id="node-input-messageGroupId" style="width: 70%;">
+            <input type="hidden" id="node-input-messageGroupIdType">
+        </div>
+        <div class="form-row">
+            <label for="node-input-messageDeduplicationId">
+                <i class="fa fa-clone"></i> Deduplication ID
+            </label>
+            <input type="text" id="node-input-messageDeduplicationId" style="width: 70%;">
+            <input type="hidden" id="node-input-messageDeduplicationIdType">
+        </div>
+    </div>
+
+    <div id="receiveFields" style="display: none;">
+        <div class="form-row">
+            <label for="node-input-pollEnabled">
+                <i class="fa fa-refresh"></i> Polling
+            </label>
+            <input type="checkbox" id="node-input-pollEnabled" style="display: inline-block; width: auto; vertical-align: middle;">
+            <span style="margin-left: 5px; vertical-align: middle;">Enable regular polling</span>
+        </div>
+        <div class="form-row">
+            <label for="node-input-pollIntervalSeconds">
+                <i class="fa fa-clock-o"></i> Poll Interval (s)
+            </label>
+            <input type="number" id="node-input-pollIntervalSeconds" min="1" max="86400" style="width: 70%;">
+        </div>
+        <div class="form-row">
+            <label for="node-input-maxNumberOfMessages">
+                <i class="fa fa-list"></i> Max Messages
+            </label>
+            <input type="number" id="node-input-maxNumberOfMessages" min="1" max="10" style="width: 70%;">
+        </div>
+        <div class="form-row">
+            <label for="node-input-waitTimeSeconds">
+                <i class="fa fa-clock-o"></i> Wait Time (s)
+            </label>
+            <input type="number" id="node-input-waitTimeSeconds" min="0" max="20" style="width: 70%;">
+        </div>
+        <div class="form-row">
+            <label for="node-input-visibilityTimeout">
+                <i class="fa fa-eye-slash"></i> Visibility Timeout (s)
+            </label>
+            <input type="number" id="node-input-visibilityTimeout" min="0" max="43200" style="width: 70%;">
+        </div>
+        <div class="form-row">
+            <label for="node-input-deleteAfterReceive">
+                <i class="fa fa-trash"></i> Delete After Receive
+            </label>
+            <input type="checkbox" id="node-input-deleteAfterReceive" style="display: inline-block; width: auto; vertical-align: middle;">
+            <span style="margin-left: 5px; vertical-align: middle;">Delete messages from queue after read</span>
+        </div>
+        <div class="form-row">
+            <label for="node-input-parseJsonBody">
+                <i class="fa fa-code"></i> Parse JSON Body
+            </label>
+            <input type="checkbox" id="node-input-parseJsonBody" style="display: inline-block; width: auto; vertical-align: middle;">
+            <span style="margin-left: 5px; vertical-align: middle;">Parse message body as JSON when possible</span>
+        </div>
+    </div>
+</script>
+
+<script type="text/x-red" data-help-name="aws-sqs">
+    <p>A Node-RED node for AWS SQS operations.</p>
+    
+    <h3>Configuration</h3>
+    <p>Select or create an AWS SQS configuration that contains your AWS credentials and region settings.</p>
+    
+    <h3>Queue URL Input</h3>
+    <p>The Queue URL field supports multiple input types:</p>
+    <ul>
+        <li><b>String</b>: Direct Queue URL</li>
+        <li><b>Message</b>: Retrieved from message property (e.g., <code>payload.queueUrl</code>)</li>
+        <li><b>Flow Context</b>: Retrieved from flow context</li>
+        <li><b>Global Context</b>: Retrieved from global context</li>
+        <li><b>Environment Variable</b>: Retrieved from environment variable</li>
+    </ul>
+    
+    <h3>Operations</h3>
+    <ul>
+        <li><b>Send Message</b>: Sends a message to the queue</li>
+        <li><b>Receive Messages</b>: Receives messages from the queue</li>
+    </ul>
+    
+    <h3>FIFO Notes</h3>
+    <ul>
+        <li>For FIFO queues, <b>Message Group ID</b> is required</li>
+        <li>Deduplication ID is optional if content-based deduplication is enabled</li>
+    </ul>
+    
+    <h3>Output</h3>
+    <p>Send operation returns message metadata. Receive operation returns array of messages in <code>msg.payload</code>.</p>
+</script>
+
+<style>
+    .help-text {
+        font-size: 0.8em;
+        color: #666;
+        margin-top: 4px;
+    }
+    .error-text {
+        color: #d00;
+        font-size: 0.8em;
+        margin-top: 4px;
+    }
+    .input-error {
+        border-color: #d00 !important;
+    }
+    .form-row {
+        margin-bottom: 10px;
+    }
+</style>