@pipelab/asset-electron 1.0.0-beta.0

package/LICENSE

@@ -0,0 +1,110 @@
+# Functional Source License, Version 1.1, MIT Future License
+
+## Abbreviation
+
+FSL-1.1-MIT
+
+## Notice
+
+Copyright 2026 CynToolkit
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under
+these Terms and Conditions, as indicated by our inclusion of these Terms and
+Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents,
+Redistribution and Trademark clauses below, we hereby grant you the right to
+use, copy, modify, create derivative works, publicly perform, publicly display
+and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
+means making the Software available to others in a commercial product or
+service that:
+
+1. substitutes for the Software;
+
+2. substitutes for any other product or service we offer using the Software
+   that exists as of the date we make the Software available; or
+
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+
+2. for non-commercial education;
+
+3. for non-commercial research; and
+
+4. in connection with professional services that you provide to a licensee
+   using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our
+patents, the license grant above includes a license under our patents. If you
+make a claim against any party that the Software infringes or contributes to
+the infringement of any patent, then your patent license to the Software ends
+immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of
+the Software.
+
+If you redistribute any copies, modifications or derivatives of the Software,
+you must include a copy of or a link to these Terms and Conditions and not
+remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
+PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
+SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
+EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of
+the Software, you have no right under these Terms and Conditions to use our
+trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under
+the MIT license that is effective on the second anniversary of the date we make
+the Software available. On or after that date, you may use the Software under
+the MIT license, in which case the following will apply:
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@pipelab/asset-electron",
+  "version": "1.0.0-beta.0",
+  "description": "Electron assets for pipelab",
+  "license": "FSL-1.1-MIT",
+  "author": "CynToolkit",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/CynToolkit/pipelab.git",
+    "directory": "assets/asset-electron"
+  },
+  "files": [
+    "template"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/template/config.cjs

@@ -0,0 +1,45 @@
+// THIS IS STUB DEFINITION
+// WILL BE REPLACED ON BUILD
+
+// eslint-disable-next-line @typescript-eslint/triple-slash-reference
+/// <reference path="../../../../src/definitions.d.ts" />
+
+// @ts-check
+
+/** @type {DesktopApp.Electron} */
+const config = {
+  alwaysOnTop: false,
+  appBundleId: "com.pipelab.app",
+  appCategoryType: "",
+  appCopyright: "Copyright © 2024 Pipelab",
+  appVersion: "1.0.0",
+  author: "Pipelab",
+  customMainCode: "",
+  description: "A simple Electron application",
+  electronVersion: "",
+  disableAsarPackaging: true,
+  forceHighPerformanceGpu: false,
+  enableExtraLogging: false,
+  clearServiceWorkerOnBoot: false,
+  enableDisableRendererBackgrounding: false,
+  enableInProcessGPU: false,
+  openDevtoolsOnStart: false,
+  frame: true,
+  fullscreen: false,
+  icon: "",
+  height: 600,
+  name: "Pipelab",
+  toolbar: true,
+  transparent: false,
+  width: 800,
+  enableSteamSupport: false,
+  steamGameId: 480,
+  enableDiscordSupport: false,
+  discordAppId: "",
+  enableDoctor: false,
+  ignore: [],
+  serverMode: "default",
+  backgroundColor: "#FFF",
+};
+
+module.exports = config;

package/template/forge.config.cjs

@@ -0,0 +1,70 @@
+// @ts-check
+
+const { FusesPlugin } = require("@electron-forge/plugin-fuses");
+const { FuseV1Options, FuseVersion } = require("@electron/fuses");
+const { join } = require("path");
+
+const PipelabPlugin = require("./pipelab-plugin.cjs");
+
+const config = require("./config.cjs");
+
+// Include all files in the dist directory regardless of OS (to support unpacking .so when built on windows)
+const unpackFilter = join("**", "steamworks.js", "dist", "**", "*");
+
+/**
+ * @type {import('@electron-forge/shared-types').ForgeConfig}
+ */
+module.exports = {
+  outDir: "./out",
+  packagerConfig: {
+    asar: config.disableAsarPackaging
+      ? false
+      : {
+          unpack: unpackFilter,
+        },
+    name: config.name,
+    appBundleId: config.appBundleId,
+    appCopyright: config.appCopyright,
+    appVersion: config.appVersion,
+    // icon: './assets/icon', // file extension is ommited (auto completed by platform: darwin: icns, linux, win32)
+    win32metadata: {
+      CompanyName: config.author,
+      FileDescription: config.description,
+    },
+    appCategoryType: config.appCategoryType,
+    icon: config.icon,
+    ignore: config.ignore,
+  },
+  rebuildConfig: {},
+  makers: [
+    {
+      name: "@electron-forge/maker-dmg",
+      config: {},
+    },
+    {
+      name: "@electron-forge/maker-squirrel",
+      config: {},
+    },
+    {
+      name: "@electron-forge/maker-zip",
+    },
+  ],
+  plugins: [
+    // {
+    //   name: '@electron-forge/plugin-auto-unpack-natives',
+    //   config: {
+    //   }
+    // },
+    new FusesPlugin({
+      version: FuseVersion.V1,
+      [FuseV1Options.RunAsNode]: false,
+      [FuseV1Options.EnableCookieEncryption]: true,
+      [FuseV1Options.EnableNodeOptionsEnvironmentVariable]: false,
+      [FuseV1Options.EnableNodeCliInspectArguments]: false,
+      [FuseV1Options.EnableEmbeddedAsarIntegrityValidation]:
+        config.disableAsarPackaging === true ? false : true,
+      [FuseV1Options.OnlyLoadAppFromAsar]: config.disableAsarPackaging === true ? false : true,
+    }),
+    new PipelabPlugin(),
+  ],
+};

package/template/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "app",
+  "version": "0.9.9",
+  "description": "My Electron application description",
+  "keywords": [],
+  "license": "MIT",
+  "author": {
+    "name": "[NAME]",
+    "email": "[EMAIL_ADDRESS]"
+  },
+  "type": "module",
+  "main": "src/index.js",
+  "scripts": {
+    "start": "electron-forge start",
+    "package": "electron-forge package",
+    "make": "electron-forge make",
+    "publish": "electron-forge publish",
+    "lint": "echo \"No linting configured\""
+  },
+  "dependencies": {
+    "@electron-forge/plugin-base": "7.11.1",
+    "@electron/asar": "3.2.13",
+    "@pipelab/steamworks.js": "^0.11.1",
+    "discord-rpc": "^4.0.1",
+    "electron-serve": "^2.1.1",
+    "electron-squirrel-startup": "1.0.1",
+    "execa": "^9.4.0",
+    "mime-types": "^3.0.2",
+    "move-file": "^3.1.0",
+    "mri": "1.2.0",
+    "semver": "^7.7.2",
+    "serve-handler": "^6.1.6",
+    "slash": "^5.1.0",
+    "ws": "^8.18.1"
+  },
+  "devDependencies": {
+    "@electron-forge/cli": "7.11.1",
+    "@electron-forge/maker-deb": "7.11.1",
+    "@electron-forge/maker-dmg": "7.11.1",
+    "@electron-forge/maker-rpm": "7.11.1",
+    "@electron-forge/maker-squirrel": "7.11.1",
+    "@electron-forge/maker-zip": "7.11.1",
+    "@electron-forge/plugin-auto-unpack-natives": "7.11.1",
+    "@electron-forge/plugin-fuses": "7.11.1",
+    "@electron/fuses": "1.8.0",
+    "@pipelab/core": "1.4.9",
+    "@types/mime-types": "^3.0.1",
+    "electron": "39.2.3"
+  },
+  "pnpm": {
+    "overrides": {
+      "discord-rpc>register-scheme": "-"
+    },
+    "onlyBuiltDependencies": [
+      "electron",
+      "electron-winstaller",
+      "fs-xattr",
+      "macos-alias"
+    ]
+  },
+  "productName": "app"
+}

package/template/pipelab-plugin.cjs

@@ -0,0 +1,160 @@
+const { PluginBase } = require("@electron-forge/plugin-base");
+
+module.exports = class PipelabPlugin extends PluginBase {
+  getHooks() {
+    return {
+      prePackage: [this.prePackage],
+      generateAssets: [this.generateAssets],
+      postStart: [this.postStart],
+      packageAfterCopy: [this.packageAfterCopy],
+      packageAfterPrune: [this.packageAfterPrune],
+      packageAfterExtract: [this.packageAfterExtract],
+      postPackage: [this.postPackage],
+      preMake: [this.preMake],
+      postMake: [this.postMake],
+      readPackageJson: [this.readPackageJson],
+    };
+  }
+
+  prePackage() {
+    // console.log('running prePackage hook')
+  }
+  generateAssets() {
+    // console.log('running generateAssets hook')
+  }
+  postStart() {
+    // console.log('running postStart hook')
+  }
+  async packageAfterCopy(config, buildPath, electronVersion, platform, arch) {
+    console.log(`Platform: ${platform}`);
+    console.log(`Architecture: ${arch}`);
+    console.log(`Build path: ${buildPath}`);
+    console.log(`Config: ${JSON.stringify(config)}`);
+    console.log(`Electron version: ${electronVersion}`);
+    const fs = require("fs").promises;
+    const path = require("path");
+    const pkg = require("./package.json");
+
+    console.log("config", config);
+
+    const outputFolder = path.resolve(buildPath, "..", "..");
+
+    // Runtime JSON file
+
+    const pipelabJsonPath = path.join(outputFolder, "pipelab.json");
+
+    await fs.writeFile(
+      pipelabJsonPath,
+      JSON.stringify(
+        {
+          name: config.name || pkg.productName || pkg.name,
+          version: config.appVersion || pkg.version,
+          description: config.description || pkg.description,
+          author: config.author || (typeof pkg.author === "object" ? pkg.author.name : pkg.author),
+          homepage: pkg.homepage,
+          engine: "Pipelab",
+          runtimeVersion: pkg.devDependencies["@pipelab/core"],
+          buildDate: new Date().toISOString(),
+          platform: platform,
+          arch: arch,
+          electron: electronVersion,
+        },
+        null,
+        2,
+      ),
+      "utf8",
+    );
+  }
+  packageAfterPrune() {
+    // console.log('running packageAfterPrune hook')
+  }
+  packageAfterExtract() {
+    // console.log('running packageAfterExtract hook')
+  }
+  async postPackage(config, result) {
+    const fs = require("fs").promises;
+    const path = require("path");
+    const appConfig = require("./config.cjs");
+
+    const outputFolder = result.outputPaths[0];
+
+    // Doctor
+    if (result.platform === "win32" && appConfig.enableDoctor) {
+      const appName = config.packagerConfig.name;
+      console.log("appName", appName);
+      const doctorBatContent = `@echo off
+pushd "%~dp0"
+
+echo ${appName} Doctor - Checking prerequisites...
+echo.
+
+echo 1. Checking Windows version...
+ver | find "10." >nul
+if %errorlevel% neq 0 (
+  echo ERROR: Windows 10 or later required.
+  goto end
+)
+echo OK: Windows 10 or later detected.
+echo.
+
+echo 2. Checking Microsoft Visual C++ Redistributable...
+reg query "HKLM\\SOFTWARE\\Microsoft\\VisualStudio\\14.0\\VC\\Runtimes\\x64" /v Installed >nul 2>&1
+if %errorlevel% neq 0 (
+  echo ERROR: Microsoft Visual C++ Redistributable 2015-2022 not found.
+  goto end
+)
+echo OK: VC++ Redistributable found.
+echo.
+
+echo 3. Checking DirectX version...
+reg query "HKLM\\SOFTWARE\\Microsoft\\DirectX" /v Version >nul 2>&1
+if %errorlevel%==0 (
+  echo OK: DirectX detected.
+) else (
+  echo ERROR: DirectX registry key not found.
+)
+echo.
+
+echo 4. Checking Vulkan...
+if exist "%SystemRoot%\\System32\\vulkan-1.dll" (
+  echo OK: Vulkan installed.
+) else (
+  echo WARNING: Vulkan not found.
+)
+echo.
+
+echo 5. GPU Information:
+echo All GPUs:
+powershell -NoProfile -Command "Get-CimInstance Win32_VideoController | Select-Object Name, AdapterRAM, DriverVersion | Format-Table -AutoSize"
+echo.
+
+echo All prerequisites met. Starting ${appName}...
+echo Logs will be displayed and saved to ${appName.toLowerCase()}-debug.log
+echo.
+
+powershell -NoProfile -ExecutionPolicy Bypass -Command "cmd /c '${appName}.exe --enable-logging 2>&1' | Tee-Object -FilePath '${appName.toLowerCase()}}-debug.log'"
+
+echo.
+if %ERRORLEVEL% NEQ 0 (
+    echo [ERROR] ${appName} exited with error code: %ERRORLEVEL%
+) else (
+    echo ${appName} has exited. Logs saved to ${appName.toLowerCase()}}-debug.log
+)
+
+:end
+popd
+pause`;
+      const doctorBatPath = path.join(outputFolder, "doctor.bat");
+      await fs.writeFile(doctorBatPath, doctorBatContent, "utf8");
+    }
+  }
+  preMake() {
+    // console.log('running preMake hook')
+  }
+  postMake() {
+    // console.log('running postMake hook')
+  }
+  readPackageJson() {
+    // console.log('running readPackageJson hook')
+  }
+};

package/template/src/custom-main.js

@@ -0,0 +1 @@
+// THIS FILE WILL BE REPLACED

package/template/src/handlers/dialog/folder.js

@@ -0,0 +1,25 @@
+import { dialog } from "electron";
+
+/**
+ * @param {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').MessageShowFolderDialog, 'input'>} json
+ * @param {import('ws').WebSocket} ws
+ */
+export default async (json, ws) => {
+  const openFolderDialogResponse = await dialog.showOpenDialog({
+    properties: ["openDirectory", "createDirectory"],
+  });
+
+  /**
+   * @type {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').MessageShowFolderDialog, 'output'>}
+   */
+  const dialogOpenResult = {
+    correlationId: json.correlationId,
+    url: json.url,
+    body: {
+      success: true,
+      canceled: openFolderDialogResponse.canceled,
+      paths: openFolderDialogResponse.filePaths,
+    },
+  };
+  ws.send(JSON.stringify(dialogOpenResult));
+};

package/template/src/handlers/dialog/open.js

@@ -0,0 +1,25 @@
+import { dialog } from "electron";
+
+/**
+ * @param {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').MessageShowOpenDialog, 'input'>} json
+ * @param {import('ws').WebSocket} ws
+ */
+export default async (json, ws) => {
+  const openDialogResponse = await dialog.showOpenDialog({
+    properties: ["openFile"],
+  });
+
+  /**
+   * @type {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').MessageShowOpenDialog, 'output'>}
+   */
+  const dialogOpenResult = {
+    correlationId: json.correlationId,
+    url: json.url,
+    body: {
+      success: true,
+      canceled: openDialogResponse.canceled,
+      paths: openDialogResponse.filePaths,
+    },
+  };
+  ws.send(JSON.stringify(dialogOpenResult));
+};

package/template/src/handlers/dialog/save.js

@@ -0,0 +1,24 @@
+import { dialog } from "electron";
+
+/**
+ * @param {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').MessageShowSaveDialog, 'input'>} json
+ * @param {import('ws').WebSocket} ws
+ */
+export default async (json, ws) => {
+  const saveDialogResponse = await dialog.showSaveDialog({
+    properties: [],
+  });
+
+  /**
+   * @type {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').MessageShowSaveDialog, 'output'>}
+   */
+  const dialogOpenResult = {
+    correlationId: json.correlationId,
+    url: json.url,
+    body: {
+      success: true,
+      path: saveDialogResponse.filePath,
+    },
+  };
+  ws.send(JSON.stringify(dialogOpenResult));
+};

package/template/src/handlers/discord/set-activity.js

@@ -0,0 +1,68 @@
+/**
+ * @param {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').DiscordSetActivity, 'input'>} json
+ * @param {import('ws').WebSocket} ws
+ * @param {import('electron').BrowserWindow} mainWindow
+ * @param {import('discord-rpc').Client} rpc
+ */
+export default async (json, ws, mainWindow, rpc) => {
+  console.log("json", json);
+
+  const { body } = json;
+  const {
+    details,
+    largeImageKey,
+    largeImageText,
+    smallImageKey,
+    smallImageText,
+    startTimestamp,
+    state,
+  } = body;
+
+  if (!rpc || !mainWindow) {
+    return;
+  }
+
+  const startTimestampAsNumber = Number.parseInt(startTimestamp);
+
+  const payload = {
+    instance: false,
+  };
+
+  if (details) payload.details = details;
+  if (state) payload.state = state;
+  if (largeImageKey) payload.largeImageKey = largeImageKey;
+  if (largeImageText) payload.largeImageText = largeImageText;
+  if (smallImageKey) payload.smallImageKey = smallImageKey;
+  if (smallImageText) payload.smallImageText = smallImageText;
+  if (!Number.isNaN(startTimestampAsNumber)) payload.startTimestamp = startTimestampAsNumber;
+
+  try {
+    await rpc.setActivity(payload);
+
+    /**
+     * @type {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').DiscordSetActivity, 'output'>}
+     */
+    const result = {
+      url: json.url,
+      correlationId: json.correlationId,
+      body: {
+        success: true,
+      },
+    };
+    ws.send(JSON.stringify(result));
+  } catch (e) {
+    console.error("e", e);
+    /**
+     * @type {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').DiscordSetActivity, 'output'>}
+     */
+    const result = {
+      url: json.url,
+      correlationId: json.correlationId,
+      body: {
+        success: false,
+        error: e.message,
+      },
+    };
+    ws.send(JSON.stringify(result));
+  }
+};

package/template/src/handlers/fs/copy.js

@@ -0,0 +1,29 @@
+// @ts-check
+
+import { cp, mkdir } from "node:fs/promises";
+import { dirname } from "node:path";
+
+/**
+ * @param {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').MessageCopyFile, 'input'>} json
+ * @param {import('ws').WebSocket} ws
+ */
+export default async (json, ws) => {
+  const destDirName = dirname(json.body.destination);
+  await mkdir(destDirName, { recursive: true });
+
+  await cp(json.body.source, json.body.destination, {
+    force: json.body.overwrite,
+  });
+
+  /**
+   * @type {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').MessageCopyFile, 'output'>}
+   */
+  const readFileResult = {
+    correlationId: json.correlationId,
+    url: json.url,
+    body: {
+      success: true,
+    },
+  };
+  ws.send(JSON.stringify(readFileResult));
+};

package/template/src/handlers/fs/delete.js

@@ -0,0 +1,23 @@
+// @ts-check
+
+import { unlink } from "node:fs/promises";
+
+/**
+ * @param {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').MessageDelete, 'input'>} json
+ * @param {import('ws').WebSocket} ws
+ */
+export default async (json, ws) => {
+  await unlink(json.body.path);
+
+  /**
+   * @type {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').MessageDelete, 'output'>}
+   */
+  const readFileResult = {
+    correlationId: json.correlationId,
+    url: json.url,
+    body: {
+      success: true,
+    },
+  };
+  ws.send(JSON.stringify(readFileResult));
+};