Implement HostHook logic to CLI and API. Implement an example in the Web-App.

Author: GregorBiswanger

ElectronNET.API/Electron.cs

@@ -60,7 +60,13 @@ public static class Electron
         /// </summary>
         public static Clipboard Clipboard { get { return Clipboard.Instance; } }
 
-
+        /// <summary>
+        /// Allows you to execute native JavaScript/TypeScript code from the host process.
+        /// 
+        /// It is only possible if the Electron.NET CLI has previously added an 
+        /// ElectronHostHook directory:
+        /// <c>electronize add HostHook</c>
+        /// </summary>
         public static HostHook HostHook { get { return HostHook.Instance; } }
     }
 }

ElectronNET.API/HostHook.cs

@@ -6,6 +6,13 @@
 
 namespace ElectronNET.API
 {
+    /// <summary>
+    /// Allows you to execute native JavaScript/TypeScript code from the host process.
+    /// 
+    /// It is only possible if the Electron.NET CLI has previously added an 
+    /// ElectronHostHook directory:
+    /// <c>electronize add HostHook</c>
+    /// </summary>
     public sealed class HostHook
     {
         private static HostHook _electronHostHook;
@@ -33,6 +40,11 @@ internal static HostHook Instance
             }
         }
 
+        /// <summary>
+        /// Execute native JavaScript/TypeScript code.
+        /// </summary>
+        /// <param name="socketEventName">Socket name registered on the host.</param>
+        /// <param name="arguments">Optional parameters.</param>
         public void Call(string socketEventName, params dynamic[] arguments)
         {
             BridgeConnector.Socket.On(socketEventName + "Error" + oneCallguid, (result) =>
@@ -44,6 +56,13 @@ public void Call(string socketEventName, params dynamic[] arguments)
             BridgeConnector.Socket.Emit(socketEventName, arguments, oneCallguid);
         }
 
+        /// <summary>
+        /// Execute native JavaScript/TypeScript code.
+        /// </summary>
+        /// <typeparam name="T">Results from the executed host code.</typeparam>
+        /// <param name="socketEventName">Socket name registered on the host.</param>
+        /// <param name="arguments">Optional parameters.</param>
+        /// <returns></returns>
         public Task<T> CallAsync<T>(string socketEventName, params dynamic[] arguments)
         {
             var taskCompletionSource = new TaskCompletionSource<T>();

ElectronNET.CLI/Commands/Actions/DeployEmbeddedElectronFiles.cs

@@ -1,7 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.IO;
-using System.Text;
+using System.IO;
 
 namespace ElectronNET.CLI.Commands.Actions
 {
@@ -11,7 +8,6 @@ public static void Do(string tempPath)
         {
             EmbeddedFileHelper.DeployEmbeddedFile(tempPath, "main.js");
             EmbeddedFileHelper.DeployEmbeddedFile(tempPath, "package.json");
-            EmbeddedFileHelper.DeployEmbeddedFile(tempPath, "package-lock.json");
 
             string hostApiFolder = Path.Combine(tempPath, "api");
             if (Directory.Exists(hostApiFolder) == false)

ElectronNET.CLI/Commands/AddCommand.cs

@@ -67,11 +67,17 @@ public Task<bool> ExecuteAsync()
                 EmbeddedFileHelper.DeployEmbeddedFile(targetFilePath, "connector.ts", "ElectronHostHook.");
                 EmbeddedFileHelper.DeployEmbeddedFile(targetFilePath, "package.json", "ElectronHostHook.");
                 EmbeddedFileHelper.DeployEmbeddedFile(targetFilePath, "tsconfig.json", "ElectronHostHook.");
+                EmbeddedFileHelper.DeployEmbeddedFile(targetFilePath, ".gitignore", "ElectronHostHook.");
 
                 // npm for typescript compiler etc.
                 Console.WriteLine("Start npm install...");
                 ProcessHelper.CmdExecute("npm install", targetFilePath);
 
+                // run typescript compiler
+                string tscPath = Path.Combine(targetFilePath, "node_modules", ".bin");
+                // ToDo: Not sure if this runs under linux/macos
+                ProcessHelper.CmdExecute(@"tsc -p ../../", tscPath);
+
                 // search .csproj
                 Console.WriteLine($"Search your .csproj to add configure CopyToPublishDirectory to 'Never'");
                 var projectFile = Directory.EnumerateFiles(currentDirectory, "*.csproj", SearchOption.TopDirectoryOnly).FirstOrDefault();

ElectronNET.CLI/Commands/BuildCommand.cs

@@ -1,9 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
-using System.Linq;
 using System.Runtime.InteropServices;
-using System.Text;
 using System.Threading.Tasks;
 using ElectronNET.CLI.Commands.Actions;
 
@@ -82,17 +80,11 @@ public Task<bool> ExecuteAsync()
                     return false;
                 }
 
-
-
                 DeployEmbeddedElectronFiles.Do(tempPath);
-
                 var nodeModulesDirPath = Path.Combine(tempPath, "node_modules");
 
-
-                Console.WriteLine("node_modules missing in: " + checkForNodeModulesDirPath);
-
                 Console.WriteLine("Start npm install...");
-                ProcessHelper.CmdExecute("npm install", tempPath);
+                ProcessHelper.CmdExecute("npm install --production", tempPath);
 
                 Console.WriteLine("Start npm install electron-packager...");
 
@@ -118,11 +110,11 @@ public Task<bool> ExecuteAsync()
                     DirectoryCopy.Do(electronhosthookDir, hosthookDir, true, new List<string>() { "node_modules" });
 
                     Console.WriteLine("Start npm install for hosthooks...");
-                    ProcessHelper.CmdExecute("npm install", hosthookDir);
+                    ProcessHelper.CmdExecute("npm install --production", hosthookDir);
 
                     string tscPath = Path.Combine(tempPath, "node_modules", ".bin");
                     // ToDo: Not sure if this runs under linux/macos
-                    ProcessHelper.CmdExecute(@"tsc -p ../../ElectronHostHook", tscPath);
+                    ProcessHelper.CmdExecute(@"tsc -p ../../ElectronHostHook --sourceMap false", tscPath);
                 }
 
                 Console.WriteLine("Build Electron Desktop Application...");

ElectronNET.CLI/ElectronNET.CLI.csproj

@@ -44,7 +44,6 @@ This package contains the dotnet tooling to electronize your application.</Descr
   </ItemGroup>
 
   <ItemGroup>
-    <EmbeddedResource Include="..\ElectronNET.Host\package-lock.json" Link="ElectronHost\package-lock.json" />
     <EmbeddedResource Include="..\ElectronNET.Host\package.json" Link="ElectronHost\package.json" />
   </ItemGroup>
 
@@ -61,6 +60,7 @@ This package contains the dotnet tooling to electronize your application.</Descr
 	 <EmbeddedResource Include="..\ElectronNET.Host\ElectronHostHook\connector.ts" Link="ElectronHost\ElectronHostHook\connector.ts" />
 	<EmbeddedResource Include="..\ElectronNET.Host\ElectronHostHook\tsconfig.json" Link="ElectronHost\ElectronHostHook\tsconfig.json" />
 	<EmbeddedResource Include="..\ElectronNET.Host\ElectronHostHook\package.json" Link="ElectronHost\ElectronHostHook\package.json" />
+      <EmbeddedResource Include="..\ElectronNET.Host\ElectronHostHook\.gitignore" Link="ElectronHost\ElectronHostHook\.gitignore" />
   </ItemGroup>
 
 

ElectronNET.Host/ElectronHostHook/.gitignore

@@ -0,0 +1,91 @@
+
+# Created by https://www.gitignore.io/api/node
+# Edit at https://www.gitignore.io/?templates=node
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# End of https://www.gitignore.io/api/node

ElectronNET.Host/ElectronHostHook/connector.js

@@ -1,20 +1,20 @@
 export class Connector {
-    constructor(private socket: SocketIO.Socket, public app: Electron.App) { }
+    constructor(private socket: SocketIO.Socket,
+        // @ts-ignore
+        public app: Electron.App) { }
 
     on(key: string, javaScriptCode: Function): void {
         this.socket.on(key, (...args: any[]) => {
             const id: string = args.pop();
 
             try {
                 javaScriptCode(...args, (data) => {
-                    if (isNaN(data)) {
-                        throw new Error('Result is NaN');
-                    } else {
+                    if (data) {
                         this.socket.emit(`${key}Complete${id}`, data);
                     }
                 });
             } catch (error) {
-                this.socket.emit(`${key}Error${id}`, 'Host Hook Exception', error);
+                this.socket.emit(`${key}Error${id}`, `Host Hook Exception`, error);
             }
         });
     }