@xwiki/cristal-electron-main 0.10.0 → 0.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xwiki/cristal-electron-main",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "license": "LGPL 2.1",
   "author": "XWiki Org Community <contact@xwiki.org>",
   "homepage": "https://cristal.xwiki.org/",
@@ -13,12 +13,13 @@
     "url": "https://jira.xwiki.org/projects/CRISTAL/"
   },
   "dependencies": {
-    "electron": "31.0.2",
-    "@xwiki/cristal-browser-electron": "0.10.0",
-    "@xwiki/cristal-electron-storage": "0.10.0"
+    "electron": "31.7.1",
+    "@xwiki/cristal-browser-electron": "0.11.0",
+    "@xwiki/cristal-electron-storage": "0.11.0",
+    "@xwiki/cristal-electron-authentication-xwiki-main": "0.11.0"
   },
   "devDependencies": {
-    "@types/node": "20.14.9",
+    "@types/node": "22.7.7",
     "cross-env": "7.0.3"
   },
   "scripts": {
@@ -27,7 +28,6 @@
     "electron": "echo 'no task'",
     "lint": "eslint \"./src/**/*.{ts,tsx}\" --max-warnings=0",
     "linux": "echo 'no task'",
-    "package": "echo 'no task'",
-    "test": "echo 'no test'"
+    "package": "echo 'no task'"
   }
 }

package/src/index.ts

@@ -26,6 +26,8 @@ import { platform } from "node:process";
 import load from "@xwiki/cristal-electron-storage/main";
 // @ts-expect-error shouldn't happen but we need to generate the types for the whole project once.
 import loadBrowser from "@xwiki/cristal-browser-electron/main";
+import { load as loadAuthentication } from "@xwiki/cristal-electron-authentication-xwiki-main";
+import { loadFile } from "./reload";
 
 /**
  * Prevent electron from running multiple instances.
@@ -58,7 +60,10 @@ app
   .whenReady()
   .then(() => {
     load();
-    restoreOrCreateWindow().then((w) => loadBrowser(w));
+    restoreOrCreateWindow().then((w) => {
+      loadBrowser(w);
+      loadAuthentication(w, loadFile);
+    });
     /**
      * @see https://www.electronjs.org/docs/latest/api/app#event-activate-macos Event: 'activate'.
      */
@@ -110,7 +115,7 @@ if (import.meta.env.PROD) {
        * @see https://github.com/electron/electron/issues/38829
        * Potentially it may be fixed by this https://github.com/electron/electron/pull/37535
        */
-      // eslint-disable-next-line @typescript-eslint/no-var-requires
+      // eslint-disable-next-line @typescript-eslint/no-require-imports
       require("electron-updater").autoUpdater.checkForUpdatesAndNotify(),
     )
     .catch((e) => console.error("Failed check and install updates:", e));

package/src/mainWindow.ts

@@ -19,7 +19,8 @@
  */
 
 import { app, BrowserWindow, shell } from "electron";
-import { join, resolve } from "node:path";
+import { join } from "node:path";
+import { loadFile } from "./reload";
 
 async function createWindow() {
   const browserWindow = new BrowserWindow({
@@ -80,9 +81,7 @@ async function createWindow() {
      * @see https://github.com/nodejs/node/issues/12682
      * @see https://github.com/electron/electron/issues/6869
      */
-    await browserWindow.loadFile(
-      resolve(app.getAppPath(), "./renderer/dist/index.html"),
-    );
+    await loadFile(browserWindow);
   }
 
   return browserWindow;

package/src/reload.ts

@@ -0,0 +1,28 @@
+/*
+ * See the LICENSE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+
+import { app, BrowserWindow } from "electron";
+import { resolve } from "node:path";
+
+function loadFile(win: BrowserWindow) {
+  return win.loadFile(resolve(app.getAppPath(), "./renderer/dist/index.html"));
+}
+
+export { loadFile };

package/src/security-restrictions.ts

@@ -34,11 +34,17 @@ type Permission = Parameters<
  *
  * In development mode you need allow open `VITE_DEV_SERVER_URL`.
  */
-const ALLOWED_ORIGINS_AND_PERMISSIONS = new Map<string, Set<Permission>>(
+const ALLOWED_ORIGINS_AND_PERMISSIONS: Map<string, Set<Permission>> = new Map<
+  string,
+  Set<Permission>
+>(
   import.meta.env.DEV && import.meta.env.VITE_DEV_SERVER_URL
     ? [[new URL(import.meta.env.VITE_DEV_SERVER_URL).origin, new Set()]]
     : [],
 );
+// TODO: CRISTAL-253 replace this hardcoded mapping with list of values drawn
+// from the configuration.
+ALLOWED_ORIGINS_AND_PERMISSIONS.set("http://localhost:15680", new Set());
 
 /**
  * A list of origins that you allow open IN BROWSER.

package/tsconfig.json

@@ -5,15 +5,28 @@
     "target": "esnext",
     "sourceMap": false,
     "moduleResolution": "Node",
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
     "skipLibCheck": true,
     "strict": true,
     "isolatedModules": true,
-    "types": ["node", "vite/client"],
+    "types": [
+      "node",
+      "vite/client"
+    ],
     "baseUrl": ".",
     "paths": {
-      "/@/*": ["./src/*"]
+      "/@/*": [
+        "./src/*"
+      ]
     }
   },
-  "include": ["src/**/*.ts", "../types/**/*.d.ts"],
-  "exclude": ["**/*.spec.ts", "**/*.test.ts"]
+  "include": [
+    "src/**/*.ts",
+    "../types/**/*.d.ts"
+  ],
+  "exclude": [
+    "**/*.spec.ts",
+    "**/*.test.ts"
+  ]
 }