@kumologica/sdk 3.0.0

package/src/app/main-process/menu.js

@@ -0,0 +1,219 @@
+let { Menu, app, ipcMain } = require('electron');
+
+const isMac = process.platform === 'darwin';
+
+let dockTemplate = [
+  {
+    label: 'New Project',
+    click() {
+      ipcMain.emit('show-newProject-modal');
+    },
+  },
+  {
+    label: 'Open Project',
+    click() {
+      ipcMain.emit('show-openProject-dialog');
+    },
+  },
+];
+
+
+let appTemplate = [
+  ...(isMac
+    ? [
+        {
+          label: 'Kumologica Designer', //app.name,
+          submenu: [
+            { role: 'about' },
+            {
+              label: 'Check for Updates',
+              click() {
+                ipcMain.emit('menu-check-for-updates');
+              },
+            },
+            { type: 'separator' },
+            { role: 'services' },
+            { type: 'separator' },
+            { role: 'hide' },
+            { role: 'hideothers' },
+            { role: 'unhide' },
+            { type: 'separator' },
+            { role: 'quit' },
+          ],
+        },
+      ]
+    : []),
+  {
+    label: 'File',
+    submenu: [
+      {
+        label: 'New Project',
+        accelerator: 'CmdOrCtrl+N',
+        click() {
+          ipcMain.emit('show-newProject-modal');
+        },
+      },
+      {
+        label: 'Open Project',
+        accelerator: 'CmdOrCtrl+O',
+        click() {
+          ipcMain.emit('show-openProject-dialog');
+        },
+      },
+      { type: 'separator' },
+      {
+        label: 'Open Recent',
+        role: 'recentdocuments',
+        submenu: [
+          {
+            label: 'Clear Recent',
+            role: 'clearrecentdocuments',
+          },
+        ],
+      },
+      { type: 'separator' },
+      {
+        label: 'Import Flow',
+        accelerator: 'CmdOrCtrl+i',
+        click() {
+          ipcMain.emit('core:show-import-dialog');
+        },
+      },
+      {
+        label: 'Export Flow',
+        accelerator: 'CmdOrCtrl+e',
+        click() {
+          ipcMain.emit('core:show-export-dialog');
+        },
+      },
+    ],
+  },
+  {
+    label: 'Edit',
+    submenu: [
+      { label: 'Undo', accelerator: 'CmdOrCtrl+Z', selector: 'undo:' },
+      { label: 'Redo', accelerator: 'Shift+CmdOrCtrl+Z', selector: 'redo:' },
+      { type: 'separator' },
+      { label: 'Cut', accelerator: 'CmdOrCtrl+X', selector: 'cut:' },
+      { label: 'Copy', accelerator: 'CmdOrCtrl+C', selector: 'copy:' },
+      { label: 'Paste', accelerator: 'CmdOrCtrl+V', selector: 'paste:' },
+      {
+        label: 'Select All',
+        accelerator: 'CmdOrCtrl+A',
+        selector: 'selectAll:',
+      },
+      { type: 'separator' },
+      {
+        label: 'Find Node...',
+        accelerator: 'CmdOrCtrl+F',
+        click() {
+          ipcMain.emit('core:search');
+        },
+      },
+    ],
+  },
+  {
+    label: 'View',
+    submenu: [
+      { role: 'reload' },
+      { role: 'forcereload' },
+      { role: 'toggledevtools' },
+      { type: 'separator' },
+      { role: 'resetzoom' },
+      { role: 'zoomin' },
+      { role: 'zoomout' },
+      { type: 'separator' },
+      {
+        label: 'Main Workspace',
+        accelerator: 'CmdOrCtrl+1',
+        click() {
+          ipcMain.emit('core:view-main-workspace');
+        },
+      },
+      { label: 'Test Workspace', 
+        accelerator: 'CmdOrCtrl+2',
+        click() {
+          ipcMain.emit('core:view-test-workspace');
+        },
+      },
+      { label: 'Settings', 
+      accelerator: 'CmdOrCtrl+,',
+      click() {
+        ipcMain.emit('core:view-settings');
+      },
+    },
+      { type: 'separator' },
+      {
+        label: 'Toggle Palette',
+        accelerator: 'CmdOrCtrl+p',
+        click() {
+          ipcMain.emit('core:toggle-palette');
+        },
+      },
+      { label: 'Toggle Terminal', 
+        accelerator: 'CmdOrCtrl+t',
+        click() {
+          ipcMain.emit('core:toggle-terminal');
+        },
+      },
+      { role: 'togglefullscreen' },
+    ],
+  },
+  {
+    role: 'window',
+    submenu: [{ role: 'minimize' }, { role: 'close' }],
+  },
+  {
+    role: 'help',
+    submenu: [
+      {
+        label: 'Documentation',
+        click() {
+          ipcMain.emit('menu-help-documentation');
+        },
+      },
+      {
+        label: 'Training Videos',
+        click() {
+          ipcMain.emit('menu-help-training-videos');
+        },
+      },
+      {
+        label: 'Release Notes',
+        click() {
+          ipcMain.emit('menu-help-release-notes');
+        },
+      },
+      { type: 'separator' },
+      {
+        label: 'Join our Discord',
+        click() {
+          ipcMain.emit('menu-help-join-discord');
+        },
+      },
+      {
+        label: 'Contact us',
+        click() {
+          ipcMain.emit('kumologica-contact-us');
+        },
+      },
+      // { type: 'separator' },
+      // {
+      //   label: 'Open Log File',
+      //   click: function () {
+      //     electron.shell.openItem(
+      //       os.homedir() + '/Library/Logs/electron-express/log.log'
+      //     );
+      //   },
+      // },
+    ],
+  },
+];
+
+const appMenu = Menu.buildFromTemplate(appTemplate);
+const dockMenu = Menu.buildFromTemplate(dockTemplate);
+
+module.exports = {
+  appMenu,
+  dockMenu,
+};

package/src/app/main-process/modal-home.js

@@ -0,0 +1,118 @@
+const electron = require('electron');
+const path = require('path');
+const url = require('url');
+const EventEmitter = require('events');
+const dependencies = require('../lib/dependencies.js');
+
+const { BrowserWindow } = electron;
+const preloadJsPath = path.join(__dirname, '..', 'preload.js');
+const {app} = require('electron');
+
+class ModalHome {
+  // Properties
+  window = null;
+
+  // Methods
+  constructor(listRecentProjects) {
+    this.headless = false;
+    this.listRecentProjects = listRecentProjects;
+    this.emitter = new EventEmitter();
+    let windowOptions = {
+      modal: true,
+      width: 780,
+      height: 440,
+      titleBarStyle: 'hiddenInset',
+      icon: "./src/assets/kumologica-app.png",
+      minimizable: false,
+      maximizable: false,
+      resizable: false,
+      backgroundColor: '#fff',
+      webPreferences: {
+        nodeIntegration: false,
+        preload: preloadJsPath,
+        contextIsolation: false
+      },
+      show: false
+    };
+
+    this.window = new BrowserWindow(windowOptions);
+
+    this.window.on('focus', () => this.window.webContents.send('focus'));
+    this.window.on('blur', () => this.window.webContents.send('blur'));
+
+    this.window.once('ready-to-show', () => {
+      this.appVersion = app.getVersion(); 
+      this.window.show();
+    });
+
+    this.window.webContents.on('did-finish-load', async () => {
+      this.sendInfoToRenderer();
+      this.emitter.emit('did-load', null);
+
+      const dep = await dependencies.checkDependencies();
+      if (this.window) {
+        this.window.webContents.send('dependencies', dep);
+      }
+    });
+
+    this.window.on('page-title-updated', e => {
+      e.preventDefault();
+    });
+
+    this.window.on('closed', () => {
+      // Dereference the window object, usually you would store windows
+      // in an array if your app supports multi windows, this is the time
+      // when you should delete the corresponding element.
+      this.window = null;
+    });
+  }
+
+  sendInfoToRenderer() {
+    this.window.webContents.send('receiveProps', {
+      payload: {
+        headless: this.isHeadless(),
+        recentProjects: this.listRecentProjects || []
+      }
+    });
+  }
+
+  load() {
+    this.window.loadURL(
+      url.format({
+        pathname: '127.0.0.1:1880/__home',
+        protocol: 'http:',
+        slashes: true
+      }),
+      {
+        userAgent: 'Kumologica Designer'
+      }
+    );
+    this.window.removeMenu();
+  }
+  show() {
+    this.window.show();
+  }
+  reload() {
+    this.window.reload();
+  }
+
+  close() {
+    this.window.close();
+  }
+  get window() {
+    return this.window;
+  }
+  /**
+   * Register a function to call when the window is done loading. At that point
+   * the page has loaded and the renderer has signalled that it is ready.
+   */
+  onDidLoad(fn) {
+    return this.emitter.once('did-load', fn);
+  }
+
+  isHeadless() {
+    return this.headless;
+  }
+}
+
+module.exports = ModalHome;

package/src/app/main-process/modal-newproject.js

@@ -0,0 +1,119 @@
+const electron = require('electron');
+const path = require('path');
+const url = require('url');
+const { BrowserWindow } = electron;
+const preloadJsPath = path.join(__dirname, '..', 'preload.js');
+
+class ModalNewProject {
+  // Properties
+  window = null;
+
+  // Methods
+  constructor(parentWindow, cancellable) {
+    this.cancellable = cancellable;
+    let windowOptions = {
+      parent: parentWindow,
+      modal: true,
+      width: 770,
+      height: 390, //290,
+      minimizable: false,
+      maximizable: false,
+      resizable: true,
+      icon: "./src/assets/kumologica-app.png",
+      titleBarStyle: 'hiddenInset',
+      backgroundColor: '#fff',
+      webPreferences: {
+        nodeIntegration: false,
+        preload: preloadJsPath,
+        enableRemoteModule: true,
+        contextIsolation: false
+      },
+      show: false,
+    };
+
+    this.window = new BrowserWindow(windowOptions);
+    // this.window.webContents.openDevTools(); 
+
+    this.window.on('focus', () => this.window.webContents.send('focus'));
+    this.window.on('blur', () => this.window.webContents.send('blur'));
+
+    this.window.once('ready-to-show', () => {
+      this.window.show();
+    });
+
+    this.window.on('page-title-updated', (e) => {
+      e.preventDefault();
+    });
+
+    this.window.on('closed', () => {
+      // Dereference the window object, usually you would store windows
+      // in an array if your app supports multi windows, this is the time
+      // when you should delete the corresponding element.
+      this.window = null;
+    });
+  }
+
+  load() {
+    this.window.loadURL(
+      url.format({
+        pathname: '127.0.0.1:1880/__newProject',
+        protocol: 'http:',
+        slashes: true,
+      }),
+      {
+        userAgent: 'Kumologica Designer'
+      }
+    );
+    this.window.removeMenu();
+  }
+  show() {
+    this.window.show();
+  }
+  reload() {
+    this.window.reload();
+  }
+
+  close() {
+    this.window.close();
+  }
+  get window() {
+    return this.window;
+  }
+  isCancellable() {
+    return this.cancellable;
+  }
+
+  validate(newFlow) {
+    try {
+      newNodes = JSON.parse(newFlow);
+    } catch (err) {
+      throw new Error('Provided flow is not in kumologica format');
+    }
+
+    if (!$.isArray(newFlow)) {
+      throw new Error('Provided flow is not in kumologica format');
+    }
+
+    let unknownTypes = newFlow.filter(function (n) {
+      return (
+        n.type != 'workspace' &&
+        n.type != 'tab' &&
+        n.type != 'subflow' &&
+        n.type.substring(0, 8) != 'subflow:'
+      );
+    });
+
+    if (unknownTypes.length > 0) {
+      var typeList = '<ul><li>' + unknownTypes.join('</li><li>') + '</li></ul>';
+      RED.notify(
+        '<p>Imported unrecognised type:</p>' +
+          typeList,
+        'error',
+        false,
+        10000
+      );
+    }
+  }
+}
+
+module.exports = ModalNewProject;

package/src/app/main-process/modal-nodelibrary.js

@@ -0,0 +1,90 @@
+const electron = require('electron');
+const path = require('path');
+const url = require('url');
+const { BrowserWindow } = electron;
+const preloadJsPath = path.join(__dirname, '..', 'preload.js');
+
+class ModalNodeLibrary {
+  // Properties
+  window = null;
+
+  // Methods
+  constructor(parentWindow, cancellable) {
+    let iconPath = path.join(__dirname, 'favicon.ico');
+
+    this.cancellable = cancellable;
+    let windowOptions = {
+      parent: parentWindow,
+      modal: true,
+      width: 1150,
+      height: 750,
+      minimizable: false,
+      maximizable: false,
+      resizable: false,
+      icon: "./src/assets/kumologica-app.png",
+      titleBarStyle: 'hiddenInset',
+      backgroundColor: '#fff',
+      icon: iconPath,
+      webPreferences: {
+        nodeIntegration: false,
+        preload: preloadJsPath,
+        contextIsolation: false
+      },
+      show: false
+    };
+
+    this.window = new BrowserWindow(windowOptions);
+
+    // this.window.webContents.openDevTools(); 
+    
+    this.window.on('focus', () => this.window.webContents.send('focus'));
+    this.window.on('blur', () => this.window.webContents.send('blur'));
+
+    this.window.once('ready-to-show', () => {
+      this.window.show();
+    });
+
+    this.window.on('page-title-updated', e => {
+      e.preventDefault();
+    });
+
+    this.window.on('closed', () => {
+      // Dereference the window object, usually you would store windows
+      // in an array if your app supports multi windows, this is the time
+      // when you should delete the corresponding element.
+      this.window = null;
+    });
+  }
+
+  load() {
+    this.window.loadURL(
+      url.format({
+        pathname: '127.0.0.1:1880/__nodeLibrary',
+        protocol: 'http:',
+        slashes: true
+      }),
+      {
+        userAgent: 'Kumologica Designer'
+      }
+    );
+    this.window.removeMenu();
+  }
+  show() {
+    this.window.show();
+  }
+  reload() {
+    this.window.reload();
+  }
+
+  close() {
+    this.window.close();
+  }
+  get window() {
+    return this.window;
+  }
+  isCancellable() {
+    return this.cancellable;
+  }
+}
+
+module.exports = ModalNodeLibrary;

package/src/app/main-process/modal-welcome.js

@@ -0,0 +1,114 @@
+const electron = require('electron');
+const path = require('path');
+const url = require('url');
+const EventEmitter = require('events');
+const dependencies = require('../lib/dependencies.js');
+
+const { BrowserWindow } = electron;
+const preloadJsPath = path.join(__dirname, '..', 'preload.js');
+const {app} = require('electron');
+
+class ModalWelcome {
+  // Properties
+  window = null;
+
+  // Methods
+  constructor() {
+    this.emitter = new EventEmitter();
+    let windowOptions = {
+      modal: true,
+      width: 780,
+      height: 440,
+      titleBarStyle: 'hiddenInset',
+      minimizable: false,
+      maximizable: false,
+      icon: "./src/assets/kumologica-app.png",
+      resizable: false,
+      backgroundColor: '#fff',
+      webPreferences: {
+        nodeIntegration: false,
+        preload: preloadJsPath,
+        contextIsolation: false
+      },
+      show: false
+    };
+
+    this.window = new BrowserWindow(windowOptions);
+
+    this.window.on('focus', () => this.window.webContents.send('focus'));
+    this.window.on('blur', () => this.window.webContents.send('blur'));
+
+    this.window.once('ready-to-show', () => {
+      this.appVersion = app.getVersion(); 
+      this.window.show();
+    });
+
+    this.window.webContents.on('did-finish-load', async () => {
+      //this.sendInfoToRenderer();
+      this.emitter.emit('did-load', null);
+
+      const dep = await dependencies.checkDependencies();
+      this.window.webContents.send('dependencies', dep);
+    });
+
+    this.window.on('page-title-updated', e => {
+      e.preventDefault();
+    });
+
+    this.window.on('closed', () => {
+      // Dereference the window object, usually you would store windows
+      // in an array if your app supports multi windows, this is the time
+      // when you should delete the corresponding element.
+      this.window = null;
+    });
+  }
+
+  /*sendInfoToRenderer() {
+    this.window.webContents.send('receiveProps', {
+      payload: {
+        headless: this.isHeadless(),
+        recentProjects: this.listRecentProjects || []
+      }
+    });
+  }*/
+
+  load() {
+    this.window.loadURL(
+      url.format({
+        pathname: '127.0.0.1:1880/__welcome',
+        protocol: 'http:',
+        slashes: true
+      }),
+      {
+        userAgent: 'Kumologica Designer'
+      }
+    );
+    this.window.removeMenu();
+  }
+  show() {
+    this.window.show();
+  }
+  reload() {
+    this.window.reload();
+  }
+
+  close() {
+    this.window.close();
+  }
+  get window() {
+    return this.window;
+  }
+  /**
+   * Register a function to call when the window is done loading. At that point
+   * the page has loaded and the renderer has signalled that it is ready.
+   */
+  onDidLoad(fn) {
+    return this.emitter.once('did-load', fn);
+  }
+
+  isHeadless() {
+    return this.headless;
+  }
+}
+
+module.exports = ModalWelcome;