@illusionforge/node-red-contrib-directus 1.0.0

package/README.md

@@ -0,0 +1,3 @@
+# Directus Node Package
+
+For detailed information, how to use this nodes, take a look on the Documentation in node-red.

package/directus-config.html

@@ -0,0 +1,23 @@
+<script type="text/javascript">
+    RED.nodes.registerType('directus-config',{
+        category: 'config',
+        defaults: {
+            host: {value:"https://localhost:8055",required:true},
+            token: {value:"",required:false}
+        },
+        label: function() {
+            return this.host;
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="directus-config">
+    <div class="form-row">
+        <label for="node-config-input-host"><i class="fa fa-bookmark"></i> Host</label>
+        <input type="text" id="node-config-input-host">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-token"><i class="fa fa-bookmark"></i> Token</label>
+        <input type="password" id="node-config-input-token">
+    </div>
+</script>

package/directus-config.js

@@ -0,0 +1,8 @@
+module.exports = function(RED) {
+    function DirectusConfigNode(n) {
+        RED.nodes.createNode(this,n);
+        this.host = n.host;
+        this.token = n.token;
+    }
+    RED.nodes.registerType("directus-config",DirectusConfigNode);
+}

package/directus-items.html

@@ -0,0 +1,91 @@
+<script type="text/javascript">
+    RED.nodes.registerType('directus-items', {
+        category: 'Directus',
+        color: '#64f',
+        defaults: {
+            name: { value: '' },
+            server: {value:'', type:"directus-config"},
+            collection: { value: '' },
+            method: { value: 'GET' },
+            mode: { value: 'single' }
+        },
+        inputs: 1,
+        outputs: 2,
+        inputLabels: ['Input'],
+        outputLabels: ['Success', 'Error'],
+        icon: 'directus.io.svg',
+        label() {
+            return this.collection+ ' - ' + this.method + (this.mode === "single" ? " Single Item" : " Multiple Items") || this.name + ' - ' + this.method + (this.mode === "single" ? " Single Item" : " Multiple Items") || 'Directus Collections';
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="directus-items">
+    <div class="form-row">
+        <label for="node-input-server"><i class="fa fa-tag"></i> Directus Configuration</label>
+        <input type="directus-config" id="node-input-server" placeholder="Directus Configuration" />
+    </div>
+    <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="Name" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-collection"><i class="fa fa-tag"></i> Collection</label>
+        <input type="text" id="node-input-collection" placeholder="Collection" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-method"><i class="fa fa-tasks"></i> Methode</label>
+        <select id="node-input-method">
+            <option value="GET">Read Data (GET)</option>
+            <option value="POST">Create Data (POST)</option>
+            <option value="PATCH">Update Data (PATCH)</option>
+            <option value="DELETE">Delete Data (DELETE)</option>
+        </select>
+    </div>
+        <div class="form-row">
+        <label for="node-input-mode"><i class="fa fa-tasks"></i> Mode</label>
+        <select id="node-input-mode">
+            <option value="single">Single Item</option>
+            <option value="multiple">Multiple Items</option>
+        </select>
+    </div>
+</script>
+
+<script type="text/markdown" data-help-name="directus-items">
+Directus Items Node
+
+### Inputs
+
+: payload (object or array) : The data to be sent to Directus for POST, PATCH, or DELETE operations. For GET operations, this can be used to specify query parameters.
+: itemId (string) : The ID of the item to be updated for PATCH operations.
+: query (object) : The query parameters for GET, PATCH, or DELETE operations in multiple mode.
+
+### Outputs
+1. Standard output
+: payload (object) : The response from Directus if the operation was successful.
+2. Standard output
+: payload (object) : The error details if there was an error during the operation.
+
+This node allows you to interact with Directus collections. You can perform various operations such as reading, creating, updating, and deleting data from your Directus collections.
+
+### Configuration
+- **Directus Configuration**: Select the Directus configuration you want to use for this node.
+- **Name**: A name for the node (optional).
+- **Collection**: The name of the Directus collection you want to interact with.
+- **Method**: The HTTP method to use for the operation (GET, POST, PATCH, DELETE).
+- **Mode**: Choose between "Single Item" or "Multiple Items" mode.
+
+### Input
+The node accepts input messages that can contain data to be sent to Directus for POST, PATCH, or DELETE operations. For GET operations, the input can be used to specify query parameters.
+## Output
+- **Success**: The output will contain the response from Directus if the operation was successful.
+- **Error**: If there was an error during the operation, the error details will be sent to this output.
+
+### Methods
+- **GET**: Retrieve data from the specified collection. The output will contain the retrieved data. You can use query parameters `msg.query` in the input message to filter, sort, or paginate the results.
+- **POST**: Create a new item in the specified collection. The input message should contain the data for the new item in the payload. The output will contain the response from Directus, including the ID of the newly created item.
+- **PATCH**: Update an existing item in the specified collection. The input message should contain the ID `msg.itemId` of the item to be updated and the data to be updated in the `msg.payload`. In multiple mode, the input message should contain a `msg.query` and data in the `msg.payload`. The output will contain the response from Directus, including the updated item details.
+- **DELETE**: Delete an existing item from the specified collection. The input message should contain the `msg.payload` ID of the item or an array of IDs to be deleted in the payload. Alternatively a `msg.query` can be used, to find specific items to delete. The output will contain the response from Directus, confirming the deletion.
+For more information on how to use this node, please refer to the Directus API documentation (https://directus.io/docs/api/items) and the Node-RED documentation.
+
+</script>

package/directus-items.js

@@ -0,0 +1,90 @@
+const { createDirectus, rest, readItem, readItems, updateItem, updateItems, createItem, createItems, deleteItem, deleteItems, staticToken, serverPing } = require('@directus/sdk');
+
+
+
+module.exports = function(RED) {
+    function DirectusItemsNode(config) {
+        RED.nodes.createNode(this, config);
+
+        this.serverConfig = RED.nodes.getNode(config.server);
+        this.collection = config.collection;
+
+        var node = this;
+
+        const client = createDirectus(this.serverConfig.host)
+            .with(staticToken(this.serverConfig.token))
+            .with(rest());
+        
+        node.status({fill:"yellow", shape:"dot", text:"healthcheck..."});
+        
+        const result = async function() { await client.request(serverPing()) };
+
+        result().finally(() => {
+            node.status({fill:"green", shape:"dot", text:"ready"});
+        }).catch((error) => {
+            node.status({fill:"red", shape:"dot", text:"error"});
+        })
+
+        node.on('input', async function(msg) {
+            node.status({fill:"blue", shape:"dot", text:"fetching..."});
+            const collection = msg.collection || config.collection;
+            const method = msg.method || config.method;
+            const mode = msg.mode || config.mode;
+
+            let response = null;
+
+            try {
+                switch (method) {
+                    case 'GET':
+                        if(mode === 'single') {
+                            response = await client.request(
+                                readItem(collection, msg.itemId || msg.payload, msg.query || {})
+                            );
+                        } else {
+                            response = await client.request(
+                                readItems(collection, msg.query || msg.payload || {
+                                    limit: -1,
+                                    fields: ['*']
+                                })
+                            );
+                        }
+                    break;
+                    case 'POST':
+                        if(mode === 'single') {
+                            response = await client.request(createItem(collection, msg.payload, msg.query || {}));
+                        } else {
+                            response = await client.request(createItems(collection, msg.payload, msg.query || {}));
+                        } 
+                    break;
+                    case 'PATCH':
+                        if(mode === 'single') {
+                            response = await client.request(updateItem(collection, msg.itemId, msg.payload, msg.query || {}));
+                        } else {
+                            response = await client.request(updateItems(collection, msg.query, msg.payload));
+                        }
+                    break;
+                    case 'DELETE':
+                        if(mode === 'single') {
+                            response = await client.request(deleteItem(collection, msg.payload));
+                        } else {
+                            response = await client.request(deleteItems(collection, msg.query || msg.payload));
+                        }
+                    break;
+                }
+
+                msg.payload = response;
+                node.send([msg, null]);
+                node.status({fill:"green", shape:"dot", text:"idle"});
+
+            } catch (error) {
+                msg.payload = error;
+                node.status({fill:"red", shape:"dot", text:"error"});
+                node.send([null, msg]);
+            }
+        });
+
+        node.status({fill:"green", shape:"dot", text:"idle"});
+    }
+
+    RED.nodes.registerType("directus-items", DirectusItemsNode);
+}

package/icons/directus.io.svg

@@ -0,0 +1 @@
+<svg viewBox="0 0 90 90" xmlns="http://www.w3.org/2000/svg"><g fill="none" fill-rule="evenodd"><path fill="#6e84f000" fill-rule="nonzero" d="M0 0h90v90H0z"/><path d="M65.962 50.504a5.107 5.107 0 0 1-.833-.266 1.915 1.915 0 0 1-.592-.398c.161-1.41 0-2.632.135-4.015.537-5.37 3.953-3.669 7.018-4.546 1.91-.532 3.819-1.622 4.303-3.856a39.29 39.29 0 0 0-6.992-6.354c-8.31-5.85-19.174-8.189-29.043-6.567a14.85 14.85 0 0 0 6.527 5.982s-2.674 0-4.967-1.693c-.672.266-2.017.79-2.663 1.108 5.244 4.972 13.446 5.53 19.336 1.064-.027.053-.538.824-1.157 4.04-1.371 6.86-5.325 6.329-10.219 4.6-10.165-3.642-15.758-.265-20.841-7.178a4.63 4.63 0 0 0-2.393 4.041c0 1.728.968 3.19 2.366 3.988.763-1 1.106-1.286 2.437-1.286-2.06 1.155-2.303 2.164-3.19 4.956-1.076 3.376-.619 6.832-5.647 7.736-2.663.133-2.609 1.915-3.577 4.573-1.21 3.457-2.824 4.84-5.97 8.11 1.29 1.542 2.636 1.728 4.007 1.17 2.824-1.17 5.002-4.786 7.046-7.126 2.285-2.606 7.771-1.489 11.913-4.041 2.85-1.729 4.249-4.068 2.366-8.03a7.8 7.8 0 0 1 2.044 4.786c4.787-.611 11.187 5.158 17.023 6.115a10.29 10.29 0 0 1-1.425-2.366c-.673-1.595-.888-3.058-.753-4.334.537 3.164 3.764 7.232 8.955 7.604 1.317.106 2.77-.053 4.275-.505 1.802-.532 3.47-1.223 5.46-.85 1.479.265 2.85 1.01 3.71 2.26 1.291 1.86 4.115 2.259 5.379-.027-2.85-7.365-10.703-7.844-14.038-8.695Z" fill="#FFF"/></g></svg>

package/package.json

@@ -0,0 +1,28 @@
+{
+    "name": "@illusionforge/node-red-contrib-directus",
+    "version": "1.0.0",
+    "publishConfig": {
+        "access": "public"
+    },
+    "description": "A node collection for Node-RED to interact with Directus, a headless CMS. This package provides nodes to perform CRUD operations on Directus collections and items.",
+    "main": "index.js",
+    "author": {
+        "name": "Erik Konrad",
+        "email": "e_konrad84@yahoo.de"
+    },
+    "node-red": {
+        "version": ">=4.0.0",
+        "nodes": {
+            "directus-items": "directus-items.js",
+            "directus-config": "directus-config.js"
+        }
+    },
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1"
+    },
+    "keywords": [ "node-red" ],
+    "license": "ISC",
+    "dependencies": {
+        "@directus/sdk": "^21.1.0"
+    }
+}