electron improvements

.changeset/thick-teachers-share.md

@@ -0,0 +1,7 @@
+---
+'@cyn/app': patch
+---
+
+feat(electron): add custom main code support
+feat(electron): add "configure" action
+feat: improve display strings

TODO

@@ -51,18 +51,17 @@ https://remixicon.com/
 
 Tests:
 - Disable step
+- Reorder steps
 - View logs in realtime
 - editor full width (no sidebar)
 - env
 - construct 3 validation url: 402.2 instead of **402-2**
 - electron prepare app bundle: backspace on input doesn't cancel running evaluation resulting in slowdowns
-- manage c3 export error: 
-    - missing addon 
+- manage c3 export error:
+    - missing addon
 - handle pipeline error gracefully
-    - restore working ui 
-    - display what happened in dialog 
-- steam upload stuck 
-- handle steamworks 
-- customize electron build 
-- allow running js for electron 
+    - restore working ui
+    - display what happened in dialog
+- steam upload stuck
+- handle steamworks
 

assets/electron/template/app/src/index.js

@@ -2,16 +2,14 @@ import { app, BrowserWindow } from 'electron'
 import { join } from 'node:path'
 import serve from 'serve-handler'
 import { createServer } from 'http'
-
-// if (require('electron-squirrel-startup')) {
-//   app.quit()
-// }
+import './custom-main.js'
 
 /**
  *
  * @returns {Promise<number>}
  */
 const createAppServer = () => {
+  // eslint-disable-next-line no-async-promise-executor
   return new Promise(async (resolve) => {
     const dir = app.isPackaged ? join(import.meta.dirname, './app') : './src/app'
 
@@ -44,7 +42,13 @@ const createWindow = async () => {
   await mainWindow.loadURL(`http://localhost:${port}`)
 }
 
+const registerHandlers = async () => {
+  // handlers
+}
+
 app.whenReady().then(async () => {
+  await registerHandlers()
+
   await createWindow()
 
   app.on('activate', async () => {

assets/electron/template/app/src/preload.js

@@ -1,2 +1,15 @@
-// See the Electron documentation for details on how to use preload scripts:
-// https://www.electronjs.org/docs/latest/tutorial/process-model#preload-scripts
+const { contextBridge, ipcRenderer } = require('electron')
+
+// Expose a limited API to the renderer process
+contextBridge.exposeInMainWorld('electronAPI', {
+  invoke: async (channel, data) => {
+    try {
+      return await ipcRenderer.invoke(channel, data)
+    } catch (error) {
+      console.error('IPC invocation error:', error)
+      throw error
+    }
+  }
+})
+
+console.log('Preload script loaded')

src/shared/libs/plugin-construct/export-c3p.ts

@@ -6,7 +6,8 @@ export const ID = 'export-construct-project'
 export const exportAction = createAction({
   id: ID,
   name: 'Export .c3p',
-  displayString: "`Export projet ${params.version ? `r${params.version}` : ''}`",
+  displayString:
+    "`Export projet ${fmt.param(params.file, 'primary')} ${params.version ? `r${params.version}` : ''}`",
   meta: {},
   params: {
     file: {

src/shared/libs/plugin-electron/configure.ts

@@ -0,0 +1,59 @@
+import { createAction, createActionRunner } from '@cyn/plugin-core'
+import { ElectronConfiguration } from './model'
+
+export const props = createAction({
+  id: 'electron:configure',
+  description: 'Configure electron',
+  displayString: "'Configure Electron'",
+  icon: '',
+  meta: {},
+  name: 'Configure Electron',
+  outputs: {
+    configuration: {
+      label: 'Configuration',
+      value: {} as ElectronConfiguration
+    }
+  },
+  params: {
+    electronVersion: {
+      value: '',
+      label: 'Electron version',
+      description: 'The version of Electron to use',
+      required: false,
+      control: {
+        type: 'input',
+        options: {
+          kind: 'text'
+        }
+      }
+    },
+    customMainCode: {
+      required: false,
+      label: 'Custom main code',
+      value: '',
+      control: {
+        type: 'path',
+        options: {
+          filters: [{ name: 'JavaScript', extensions: ['js'] }]
+        },
+        label: 'Path to a file containing custom main code'
+      }
+    },
+    enableSteamSupport: {
+      required: false,
+      label: 'Enable steam support',
+      value: false,
+      control: {
+        type: 'boolean'
+      }
+    }
+  }
+})
+
+export const configureRunner = createActionRunner<typeof props>(async ({ setOutput, inputs }) => {
+  setOutput('configuration', {
+    electronVersion: inputs.electronVersion,
+    steamSupport: inputs.enableSteamSupport,
+    customMainCode: inputs.customMainCode,
+  })
+})