3rd party broker

forge/db/migrations/20250109-01-EE-3rd-party-broker-creds.js

@@ -0,0 +1,36 @@
+/**
+ * Add 3rd party broker credentials table
+ */
+const { DataTypes } = require('sequelize')
+
+module.exports = {
+    /**
+     * upgrade database
+     * @param {QueryInterface} context Sequelize.QueryInterface
+     */
+    up: async (context) => {
+        await context.createTable('BrokerCredentials', {
+            id: { type: DataTypes.INTEGER, primaryKey: true, autoIncrement: true },
+            name: { type: DataTypes.STRING, allowNull: false },
+            host: { type: DataTypes.STRING, allowNull: false },
+            port: { type: DataTypes.INTEGER, allowNull: false, default: 1883 },
+            protocol: { type: DataTypes.STRING, allowNull: false, default: 'mqtt:' },
+            protocolVersion: { type: DataTypes.INTEGER, allowNull: false, default: 4 },
+            ssl: { type: DataTypes.BOOLEAN, allowNull: false, default: false },
+            verifySSL: { type: DataTypes.BOOLEAN, allowNull: false, default: false },
+            clientId: { type: DataTypes.STRING, allowNull: false },
+            credentials: { type: DataTypes.TEXT, allowNull: false },
+            createdAt: { type: DataTypes.DATE },
+            updatedAt: { type: DataTypes.DATE },
+            TeamId: {
+                type: DataTypes.INTEGER,
+                references: { model: 'Teams', key: 'id' },
+                onDelete: 'cascade',
+                onUpdate: 'cascade'
+            }
+        })
+        await context.addIndex('BrokerCredentials', { name: 'broker_name_team_unique', fields: ['name', 'TeamId'], unique: true })
+    },
+    down: async (context) => {
+    }
+}

forge/db/models/BrokerCredentials.js

@@ -0,0 +1,50 @@
+/**
+ * 
+ */
+const { DataTypes } = require('sequelize')
+
+module.exports = {
+    name: 'BrokerCredentials',
+    schema: {
+        name: { type: DataTypes.STRING, allowNull: false },
+        host: { type: DataTypes.STRING, allowNull: false },
+        port: { type: DataTypes.INTEGER, allowNull: false, default: 1883 },
+        protocol: { type: DataTypes.STRING, allowNull: false, default: 'mqtt:' },
+        protocolVersion: { type: DataTypes.INTEGER, allowNull: false, default: 4 },
+        ssl: { type: DataTypes.BOOLEAN, allowNull: false, default: false },
+        verifySSL: { type: DataTypes.BOOLEAN, allowNull: false, default: false },
+        clientId: { type: DataTypes.STRING, allowNull: false },
+        credentials: { type: DataTypes.TEXT, allowNull: false }
+    },
+    indexes: [
+        { name: 'broker_name_team_unique', fields: ['name', 'TeamId'], unique: true }
+    ],
+    associations: function (M) {
+        this.belongsTo(M.Team)
+    },
+    finders: function (M) {
+        return {
+            static: {
+                byId: async function (idOrHash) {
+                    let id = idOrHash
+                    if (typeof id === 'string') {
+                        id = M.BrokerCredentials.decodeHashid(idOrHash)
+                    }
+                    return this.findOne({
+                        where: { id }
+                    })
+                },
+                byTeam: async function (teamId) {
+                    if (typeof teamId === 'string') {
+                        teamId = M.Team.decodeHashid(teamId)
+                    }
+                    return this.findAll({
+                        where: {
+                            TeamId: teamId
+                        }
+                    })
+                }
+            }
+        }
+    }
+}

forge/db/models/index.js

@@ -80,7 +80,8 @@ const modelTypes = [
     'BrokerClient',
     'OAuthSession',
     'Notification',
-    'TeamBrokerClient'
+    'TeamBrokerClient',
+    'BrokerCredentials'
 ]
 
 // A local map of the known models.

forge/db/views/BrokerCredentials.js

@@ -0,0 +1,23 @@
+module.exports = {
+    credentials: function (app, credentials) {
+        const filtered = []
+        credentials.forEach(c => {
+            filtered.push(this.clean(app, c))
+        })
+        return filtered
+    },
+    clean: function (app, cred) {
+        const result = cred.toJSON()
+        const cleaned = {
+            id: result.hashid,
+            name: result.name,
+            host: result.host,
+            port: result.port,
+            protocol: result.protocol,
+            ssl: result.ssl,
+            verifySSL: result.verifySSL,
+            clientId: result.clientId
+        }
+        return cleaned
+    }
+}

forge/db/views/index.js

@@ -27,7 +27,8 @@ const modelTypes = [
     'Team',
     'TeamType',
     'User',
-    'TeamBrokerClient'
+    'TeamBrokerClient',
+    'BrokerCredentials'
 ]
 
 async function register (app, viewType, viewModule) {