frodovdr/node-red
1
0
Fork 0
mirror of https://github.com/node-red/node-red.git synced 2025-03-01 10:36:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Support for a module with nodes and plugins in the palette

Browse Source
This commit is contained in:
GogoVega 2024-11-06 16:20:23 +01:00
parent 54bf3f4402
commit a6f01d7085
No known key found for this signature in database
GPG Key ID: E1E048B63AC5AC2B
1 changed files with 118 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

160
packages/node_modules/@node-red/editor-client/src/js/ui/palette-editor.js vendored
View File

@ -231,40 +231,82 @@ RED.palette.editor = (function() {
} }
} }
function _refreshNodeModule(module) { function _refreshNodeModule(module) {
if (!nodeEntries.hasOwnProperty(module)) { if (!nodeEntries.hasOwnProperty(module)) {
nodeEntries[module] = {info:RED.nodes.registry.getModule(module)}; const nodeInfo = RED.nodes.registry.getModule(module);
var index = [module]; let index = [module];
for (var s in nodeEntries[module].info.sets) {
if (nodeEntries[module].info.sets.hasOwnProperty(s)) { nodeEntries[module] = {
index.push(s); info: {
index = index.concat(nodeEntries[module].info.sets[s].types) name: nodeInfo.name,
version: nodeInfo.version,
local: nodeInfo.local,
nodeSet: nodeInfo.sets,
},
};
if (nodeInfo.pending_version) {
nodeEntries[module].info.pending_version = nodeInfo.pending_version;
}
for (const set in nodeInfo.sets) {
if (nodeInfo.sets.hasOwnProperty(set)) {
index.push(set);
index = index.concat(nodeInfo.sets[set].types);
} }
} }
nodeEntries[module].index = index.join(",").toLowerCase(); nodeEntries[module].index = index.join(",").toLowerCase();
nodeList.editableList('addItem', nodeEntries[module]); nodeList.editableList('addItem', nodeEntries[module]);
} else { } else {
var moduleInfo = nodeEntries[module].info; if (nodeEntries[module].info.pluginSet && !nodeEntries[module].info.nodeSet) {
var nodeEntry = nodeEntries[module].elements; // Since plugins are loaded before nodes, check if the module has nodes too
if (nodeEntry) { const nodeInfo = RED.nodes.registry.getModule(module);
if (moduleInfo.plugin) {
nodeEntry.enableButton.hide(); if (nodeInfo) {
nodeEntry.removeButton.show(); let index = [nodeEntries[module].index];
for (const set in nodeInfo.sets) {
if (nodeInfo.sets.hasOwnProperty(set)) {
index.push(set);
index = index.concat(nodeInfo.sets[set].types)
}
}
nodeEntries[module].info.nodeSet = nodeInfo.sets;
nodeEntries[module].index = index.join(",").toLowerCase();
}
}
const moduleInfo = nodeEntries[module].info;
const nodeEntry = nodeEntries[module].elements;
if (nodeEntry) {
const setCount = [];
if (moduleInfo.pluginSet) {
let pluginCount = 0; let pluginCount = 0;
for (let setName in moduleInfo.sets) { for (const setName in moduleInfo.pluginSet) {
if (moduleInfo.sets.hasOwnProperty(setName)) { if (moduleInfo.pluginSet.hasOwnProperty(setName)) {
let set = moduleInfo.sets[setName]; let set = moduleInfo.pluginSet[setName];
if (set.plugins) { if (set.plugins && set.plugins.length) {
pluginCount += set.plugins.length; pluginCount += set.plugins.length;
} else if (set.plugins && !!RED.plugins.getPlugin(setName)) {
// `registerPlugin` in runtime not called but called in editor, add it
pluginCount++;
} }
} }
} }
nodeEntry.setCount.text(RED._('palette.editor.pluginCount',{count:pluginCount,label:pluginCount}));
} else { setCount.push(RED._('palette.editor.pluginCount', { count: pluginCount }));
if (!moduleInfo.nodeSet) {
// Module only have plugins
nodeEntry.enableButton.hide();
nodeEntry.removeButton.show();
}
}
if (moduleInfo.nodeSet) {
var activeTypeCount = 0; var activeTypeCount = 0;
var typeCount = 0; var typeCount = 0;
var errorCount = 0; var errorCount = 0;
@ -272,10 +314,10 @@ RED.palette.editor = (function() {
nodeEntries[module].totalUseCount = 0; nodeEntries[module].totalUseCount = 0;
nodeEntries[module].setUseCount = {}; nodeEntries[module].setUseCount = {};
for (var setName in moduleInfo.sets) { for (const setName in moduleInfo.nodeSet) {
if (moduleInfo.sets.hasOwnProperty(setName)) { if (moduleInfo.nodeSet.hasOwnProperty(setName)) {
var inUseCount = 0; let inUseCount = 0;
const set = moduleInfo.sets[setName]; const set = moduleInfo.nodeSet[setName];
const setElements = nodeEntry.sets[setName] const setElements = nodeEntry.sets[setName]
if (set.err) { if (set.err) {
@ -292,8 +334,8 @@ RED.palette.editor = (function() {
activeTypeCount += set.types.length; activeTypeCount += set.types.length;
} }
typeCount += set.types.length; typeCount += set.types.length;
for (var i=0;i<moduleInfo.sets[setName].types.length;i++) { for (var i=0;i<moduleInfo.nodeSet[setName].types.length;i++) {
var t = moduleInfo.sets[setName].types[i]; var t = moduleInfo.nodeSet[setName].types[i];
inUseCount += (typesInUse[t]||0); inUseCount += (typesInUse[t]||0);
if (setElements && set.enabled) { if (setElements && set.enabled) {
var def = RED.nodes.getType(t); var def = RED.nodes.getType(t);
@ -329,8 +371,8 @@ RED.palette.editor = (function() {
nodeEntry.errorRow.show(); nodeEntry.errorRow.show();
} }
var nodeCount = (activeTypeCount === typeCount)?typeCount:activeTypeCount+" / "+typeCount; const nodeCount = (activeTypeCount === typeCount) ? typeCount : activeTypeCount + " / " + typeCount;
nodeEntry.setCount.text(RED._('palette.editor.nodeCount',{count:typeCount,label:nodeCount})); setCount.push(RED._('palette.editor.nodeCount', { count: typeCount, label: nodeCount }));
if (nodeEntries[module].totalUseCount > 0) { if (nodeEntries[module].totalUseCount > 0) {
nodeEntry.enableButton.text(RED._('palette.editor.inuse')); nodeEntry.enableButton.text(RED._('palette.editor.inuse'));
@ -349,6 +391,7 @@ RED.palette.editor = (function() {
nodeEntry.container.toggleClass("disabled",(activeTypeCount === 0)); nodeEntry.container.toggleClass("disabled",(activeTypeCount === 0));
} }
} }
nodeEntry.setCount.text(setCount.join(" & ") || RED._("sidebar.info.empty"));
} }
if (moduleInfo.pending_version) { if (moduleInfo.pending_version) {
nodeEntry.versionSpan.html(moduleInfo.version+' <i class="fa fa-long-arrow-right"></i> '+moduleInfo.pending_version).appendTo(nodeEntry.metaRow) nodeEntry.versionSpan.html(moduleInfo.version+' <i class="fa fa-long-arrow-right"></i> '+moduleInfo.pending_version).appendTo(nodeEntry.metaRow)
@ -700,19 +743,36 @@ RED.palette.editor = (function() {
}) })
RED.events.on("registry:plugin-module-added", function(module) { RED.events.on("registry:plugin-module-added", function(module) {
if (!nodeEntries.hasOwnProperty(module)) { if (!nodeEntries.hasOwnProperty(module)) {
nodeEntries[module] = {info:RED.plugins.getModule(module)}; const pluginInfo = RED.plugins.getModule(module);
var index = [module]; let index = [module];
for (var s in nodeEntries[module].info.sets) {
if (nodeEntries[module].info.sets.hasOwnProperty(s)) { nodeEntries[module] = {
index.push(s); info: {
index = index.concat(nodeEntries[module].info.sets[s].types) name: pluginInfo.name,
version: pluginInfo.version,
local: pluginInfo.local,
pluginSet: pluginInfo.sets,
}
};
if (pluginInfo.pending_version) {
nodeEntries[module].info.pending_version = pluginInfo.pending_version;
}
for (const set in pluginInfo.sets) {
if (pluginInfo.sets.hasOwnProperty(set)) {
index.push(set);
// TODO: not sure plugin has `types` property
index = index.concat(pluginInfo.sets[set].types)
} }
} }
nodeEntries[module].index = index.join(",").toLowerCase(); nodeEntries[module].index = index.join(",").toLowerCase();
nodeList.editableList('addItem', nodeEntries[module]); nodeList.editableList('addItem', nodeEntries[module]);
} else { } else {
// Since plugins are loaded before nodes,
// `nodeEntries[module]` should be undefined
_refreshNodeModule(module); _refreshNodeModule(module);
} }
@ -873,12 +933,28 @@ RED.palette.editor = (function() {
} }
}) })
const populateSetList = function () { const populateSetList = function () {
var setList = Object.keys(entry.sets) const setList = [...Object.keys(entry.nodeSet || {}), ...Object.keys(entry.pluginSet || {})];
setList.sort(function(A,B) { setList.sort(function (A, B) {
return A.toLowerCase().localeCompare(B.toLowerCase()); return A.toLowerCase().localeCompare(B.toLowerCase());
}); });
setList.forEach(function(setName) { setList.forEach(function (setName) {
var set = entry.sets[setName]; const set = (entry.nodeSet && setName in entry.nodeSet) ? entry.nodeSet[setName] : entry.pluginSet[setName];
if (set.plugins && !set.plugins.length) {
// `registerPlugin` in the runtime not called
if (!!RED.plugins.getPlugin(setName)) {
// Add plugin if registered in editor but not in runtime
// Can happen if plugin doesn't have .js file
set.plugins.push({ id: setName });
} else {
// `registerPlugin` in the editor not called - do not add this empty set
return;
}
} else if (set.types && !set.types.length) {
// `registerPlugin` in the runtime not called - do not add this empty set
return;
}
var setRow = $('<div>',{class:"red-ui-palette-module-set"}).appendTo(contentRow); var setRow = $('<div>',{class:"red-ui-palette-module-set"}).appendTo(contentRow);
var buttonGroup = $('<div>',{class:"red-ui-palette-module-set-button-group"}).appendTo(setRow); var buttonGroup = $('<div>',{class:"red-ui-palette-module-set-button-group"}).appendTo(setRow);
var typeSwatches = {}; var typeSwatches = {};
@ -1317,7 +1393,7 @@ RED.palette.editor = (function() {
} }
} else { } else {
// dedicated list management for plugins // dedicated list management for plugins
if (entry.plugin) { if (entry.pluginSet) {
let e = nodeEntries[entry.name]; let e = nodeEntries[entry.name];
if (e) { if (e) {
@ -1329,9 +1405,9 @@ RED.palette.editor = (function() {
// cleans the editor accordingly of its left-overs. // cleans the editor accordingly of its left-overs.
let found_onremove = true; let found_onremove = true;
let keys = Object.keys(entry.sets); let keys = Object.keys(entry.pluginSet);
keys.forEach((key) => { keys.forEach((key) => {
let set = entry.sets[key]; let set = entry.pluginSet[key];
for (let i=0; i<set.plugins?.length; i++) { for (let i=0; i<set.plugins?.length; i++) {
let plgn = RED.plugins.getPlugin(set.plugins[i].id); let plgn = RED.plugins.getPlugin(set.plugins[i].id);
if (plgn && plgn.onremove && typeof plgn.onremove === 'function') { if (plgn && plgn.onremove && typeof plgn.onremove === 'function') {