@pipelab/plugin-electron 1.0.0-beta.1 → 1.0.0-beta.4

package/src/index.ts

@@ -1,94 +0,0 @@
-import { makeRunner } from "./make";
-import { packageRunner } from "./package";
-import { previewRunner } from "./preview";
-
-import { createNodeDefinition } from "@pipelab/plugin-core";
-const icon = new URL("./public/electron.webp", import.meta.url).href;
-import {
-  createMakeProps,
-  createPackageProps,
-  createPackageV2Props,
-  createPreviewProps,
-  IDMake,
-  IDPackage,
-  IDPackageV2,
-  IDPreview,
-} from "./forge";
-import { configureRunner, props } from "./configure";
-import { packageV2Runner } from "./package-v2";
-
-export default createNodeDefinition({
-  description: "Electron",
-  name: "Electron",
-  id: "electron",
-  icon: {
-    type: "image",
-    image: icon,
-  },
-  nodes: [
-    // make and package
-    {
-      node: createMakeProps(
-        IDMake,
-        "Create Installer",
-        "Create a distributable installer for your chosen platform",
-        "",
-        "`Build package for ${fmt.param(params['input-folder'], 'primary', 'Input folder not set')}`",
-      ),
-      runner: makeRunner,
-      // disabled: platform === 'linux' ? 'Electron is not supported on Linux' : undefined
-    },
-    // package
-    // v1
-    {
-      node: createPackageProps(
-        IDPackage,
-        "Package app",
-        "Gather all necessary files and prepare your app for distribution, creating a platform-specific bundle.",
-        "",
-        "`Package app from ${fmt.param(params['input-folder'], 'primary', 'Input folder not set')}`",
-        true,
-      ),
-      runner: packageRunner,
-    },
-    // v2
-    {
-      node: createPackageV2Props(
-        IDPackageV2,
-        "Package app with configuration",
-        "Gather all necessary files and prepare your app for distribution, creating a platform-specific bundle.",
-        "",
-        "`Package app from ${fmt.param(params['input-folder'], 'primary', 'Input folder not set')}`",
-        false,
-        false,
-        undefined,
-        false,
-        false,
-      ),
-      runner: packageV2Runner,
-    },
-    {
-      node: createPreviewProps(
-        IDPreview,
-        "Preview app",
-        "Package and preview your app from an URL",
-        "",
-        "`Preview app from ${fmt.param(params['input-url'], 'primary', 'URL not set')}`",
-      ),
-      runner: previewRunner,
-    },
-    {
-      node: props,
-      runner: configureRunner,
-    },
-    // {
-    //   node: propsConfigureV2,
-    //   runner: configureV2Runner
-    // }
-    // make without package
-    // {
-    //   node: packageApp,
-    //   runner: packageRunner,
-    // },
-  ],
-});

package/src/make.spec.ts

@@ -1,57 +0,0 @@
-import { expect, test, vi } from "vitest";
-import { makeRunner } from "./make.js";
-import { tmpdir } from "node:os";
-import { join } from "node:path";
-import { type fs } from "memfs";
-import { browserWindow } from "@pipelab/shared";
-
-// ...
-
-// vi.mock('node:fs/promises', async () => {
-//   const memfs: { fs: typeof fs } = await vi.importActual('memfs')
-
-//   return memfs.fs.promises
-// })
-
-test("adds 1 + 2 to equal 3", async () => {
-  const outputs: Record<string, unknown> = {};
-
-  const id = "ut-electron-build";
-  const tmpDir = join(tmpdir(), id);
-
-  console.log("tmpDir", tmpDir);
-
-  const inputFolder = join(process.cwd(), "fixtures", "build");
-
-  console.log("inputFolder", inputFolder);
-
-  // await makeRunner({
-  //   inputs: {
-  //     'input-folder': inputFolder,
-  //     configuration: {},
-  //     arch: undefined,
-  //     platform: undefined
-  //   },
-  //   log: (...args) => {
-  //     console.log(...args)
-  //   },
-  //   setOutput: (key, value) => {
-  //     outputs[key] = value
-  //   },
-  //   meta: {
-  //     definition: ''
-  //   },
-  //   setMeta: () => {
-  //     console.log('set meta defined here')
-  //   },
-  //   cwd: tmpDir,
-  //   paths: {
-  //     assets: '',
-  //     unpack: ''
-  //   },
-  //   api: undefined,
-  //   browserWindow
-  // })
-  console.log("outputs", outputs);
-  expect(true).toBe(true);
-}, 120_000);

package/src/make.ts

@@ -1,22 +0,0 @@
-import { createActionRunner } from "@pipelab/plugin-core";
-import { forge, createMakeProps } from "./forge";
-import { merge } from "ts-deepmerge";
-import { defaultElectronConfig } from "./utils";
-
-export const makeRunner = createActionRunner<ReturnType<typeof createMakeProps>>(
-  async (options) => {
-    const appFolder = options.inputs["input-folder"];
-
-    if (!options.inputs.configuration) {
-      throw new Error("Missing electron configuration");
-    }
-
-    const completeConfiguration = merge(
-      defaultElectronConfig,
-      options.inputs.configuration,
-    ) as DesktopApp.Electron;
-
-    // @ts-expect-error options is not really compatible
-    return await forge("make", appFolder, options, completeConfiguration);
-  },
-);

package/src/package-v2.ts

@@ -1,52 +0,0 @@
-import { createActionRunner } from "@pipelab/plugin-core";
-import { forge } from "./forge";
-import { createPackageV2Props } from "./forge";
-import { merge } from "ts-deepmerge";
-import { defaultElectronConfig } from "./utils";
-
-export const packageV2Runner = createActionRunner<ReturnType<typeof createPackageV2Props>>(
-  async (options) => {
-    const appFolder = options.inputs["input-folder"];
-
-    const completeConfiguration = merge(defaultElectronConfig, {
-      alwaysOnTop: options.inputs["alwaysOnTop"],
-      appBundleId: options.inputs["appBundleId"],
-      appCategoryType: options.inputs["appCategoryType"],
-      appCopyright: options.inputs["appCopyright"],
-      appVersion: options.inputs["appVersion"],
-      author: options.inputs["author"],
-      customMainCode: options.inputs["customMainCode"],
-      description: options.inputs["description"],
-      electronVersion: options.inputs["electronVersion"],
-      disableAsarPackaging: options.inputs["disableAsarPackaging"],
-      forceHighPerformanceGpu: options.inputs["forceHighPerformanceGpu"],
-      enableExtraLogging: options.inputs["enableExtraLogging"],
-      clearServiceWorkerOnBoot: options.inputs["clearServiceWorkerOnBoot"],
-      enableDisableRendererBackgrounding: options.inputs["enableDisableRendererBackgrounding"],
-      enableInProcessGPU: options.inputs["enableInProcessGPU"],
-      frame: options.inputs["frame"],
-      fullscreen: options.inputs["fullscreen"],
-      icon: options.inputs["icon"],
-      height: options.inputs["height"],
-      name: options.inputs["name"],
-      toolbar: options.inputs["toolbar"],
-      transparent: options.inputs["transparent"],
-      width: options.inputs["width"],
-      enableSteamSupport: options.inputs["enableSteamSupport"],
-      steamGameId: options.inputs["steamGameId"],
-      ignore: options.inputs["ignore"],
-      openDevtoolsOnStart: options.inputs["openDevtoolsOnStart"],
-      enableDiscordSupport: options.inputs["enableDiscordSupport"],
-      discordAppId: options.inputs["discordAppId"],
-      customPackages: options.inputs["customPackages"],
-      backgroundColor: options.inputs["backgroundColor"],
-      enableDoctor: options.inputs["enableDoctor"],
-      serverMode: options.inputs["serverMode"],
-    } satisfies DesktopApp.Electron) as DesktopApp.Electron;
-
-    options.log("completeConfiguration", completeConfiguration);
-
-    // @ts-expect-error options is not really compatible
-    return await forge("package", appFolder, options, completeConfiguration);
-  },
-);

package/src/package.ts

@@ -1,22 +0,0 @@
-import { createActionRunner } from "@pipelab/plugin-core";
-import { createPackageProps, forge } from "./forge";
-import { merge } from "ts-deepmerge";
-import { defaultElectronConfig } from "./utils";
-
-export const packageRunner = createActionRunner<ReturnType<typeof createPackageProps>>(
-  async (options) => {
-    const appFolder = options.inputs["input-folder"];
-
-    if (!options.inputs.configuration) {
-      throw new Error("Missing electron configuration");
-    }
-
-    const completeConfiguration = merge(
-      defaultElectronConfig,
-      options.inputs.configuration,
-    ) as DesktopApp.Electron;
-
-    // @ts-expect-error options is not really compatible
-    return await forge("package", appFolder, options, completeConfiguration);
-  },
-);

package/src/preview.ts

@@ -1,35 +0,0 @@
-import { createActionRunner, runWithLiveLogs } from "@pipelab/plugin-core";
-import { createPreviewProps, forge } from "./forge";
-import { merge } from "ts-deepmerge";
-import { defaultElectronConfig } from "./utils";
-
-export const previewRunner = createActionRunner<ReturnType<typeof createPreviewProps>>(
-  async (options) => {
-    const url = options.inputs["input-url"];
-    if (url === "") {
-      throw new Error("URL can't be empty");
-    }
-
-    if (!options.inputs.configuration) {
-      throw new Error("Missing electron configuration");
-    }
-
-    const completeConfiguration = merge(
-      defaultElectronConfig,
-      options.inputs.configuration,
-    ) as DesktopApp.Electron;
-
-    const output = await forge("package", undefined, options, completeConfiguration);
-    options.log("Opening preview", JSON.stringify(output));
-    options.log("Opening url", url);
-    await runWithLiveLogs(
-      output.binary,
-      ["--url", url],
-      {
-        cancelSignal: options.abortSignal,
-      },
-      options.log,
-    );
-    return;
-  },
-);

package/src/utils.ts

@@ -1,35 +0,0 @@
-export const defaultElectronConfig = {
-  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,
-  frame: true,
-  fullscreen: false,
-  icon: "",
-  height: 600,
-  name: "Pipelab",
-  toolbar: true,
-  transparent: false,
-  width: 800,
-  enableSteamSupport: false,
-  steamGameId: 480,
-  enableDiscordSupport: false,
-  discordAppId: "",
-  ignore: [] as string[],
-  backgroundColor: "#FFF",
-  openDevtoolsOnStart: false,
-  enableDoctor: false,
-  customPackages: [] as string[],
-  serverMode: "default",
-} satisfies DesktopApp.Electron;

package/tests/e2e/electron.spec.ts

@@ -1,64 +0,0 @@
-import { expect, test, describe, afterEach } from "vitest";
-import { mkdir, writeFile, access } from "node:fs/promises";
-import { join, dirname } from "node:path";
-import { fileURLToPath } from "node:url";
-import { createSandbox, runAction } from "@pipelab/test-utils";
-import { getBinName } from "@pipelab/constants";
-import { packageRunner } from "../../src/package";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-describe("End-to-End: Electron Plugin", () => {
-  let sandbox: Awaited<ReturnType<typeof createSandbox>>;
-
-  afterEach(async () => {
-    if (sandbox) {
-      await sandbox.remove();
-    }
-  });
-
-  test(
-    "should package a project using 'electron-package' node",
-    async () => {
-      sandbox = await createSandbox("electron-e2e");
-      // 1. Setup a dummy project to package
-      const projectToPackage = join(sandbox.path, "my-app");
-      await mkdir(projectToPackage, { recursive: true });
-      await writeFile(
-        join(projectToPackage, "package.json"),
-        JSON.stringify({ name: "my-app", version: "1.0.0", main: "index.js" }),
-      );
-      await writeFile(join(projectToPackage, "index.js"), "console.log('hello electron')");
-      await writeFile(join(projectToPackage, "index.html"), "<h1>Hello Electron</h1>");
-
-      // 2. Run the action directly
-      const inputs = {
-        "input-folder": projectToPackage,
-        configuration: { name: "my-app" },
-      };
-
-      const result = await runAction(packageRunner, {
-        inputs,
-        sandboxPath: sandbox.path,
-      });
-
-      // 3. Verification
-      const outputs = result.outputs;
-      expect(outputs).toBeDefined();
-      expect(outputs.output).toEqual(expect.any(String));
-
-      // Verify output exists in the dynamically generated output folder
-      await expect(access(outputs.output as string)).resolves.not.toThrow();
-
-      // Verify and run the binary
-      const platform = process.platform;
-      const binName = getBinName("my-app", platform);
-      const binaryPath = join(outputs.output as string, binName);
-
-      console.log("Calculated binary path:", binaryPath);
-      await expect(access(binaryPath)).resolves.not.toThrow();
-    },
-    5 * 60 * 1000,
-  ); // 5 minutes timeout for real build
-});

package/tests/e2e/fixtures/folder-to-electron.json

@@ -1,171 +0,0 @@
-{
-  "description": "",
-  "name": "Folder to Electron",
-  "variables": [],
-  "canvas": {
-    "blocks": [
-      {
-        "uid": "electron-package-node",
-        "type": "action",
-        "origin": {
-          "nodeId": "electron:package:v2",
-          "pluginId": "electron"
-        },
-        "params": {
-          "arch": {
-            "editor": "simple",
-            "value": ""
-          },
-          "platform": {
-            "editor": "simple",
-            "value": ""
-          },
-          "input-folder": {
-            "editor": "simple",
-            "value": "\"./tests/e2e/fixtures/html-export\""
-          },
-          "name": {
-            "editor": "simple",
-            "value": "\"Pipelab\""
-          },
-          "appBundleId": {
-            "editor": "simple",
-            "value": "\"com.pipelab.app\""
-          },
-          "appCopyright": {
-            "editor": "simple",
-            "value": "\"Copyright © 2024 Pipelab\""
-          },
-          "appVersion": {
-            "editor": "simple",
-            "value": "\"1.0.0\""
-          },
-          "icon": {
-            "editor": "simple",
-            "value": ""
-          },
-          "author": {
-            "editor": "simple",
-            "value": "\"Pipelab\""
-          },
-          "description": {
-            "editor": "simple",
-            "value": "\"A sample application\""
-          },
-          "appCategoryType": {
-            "editor": "simple",
-            "value": "\"public.app-category.developer-tools\""
-          },
-          "width": {
-            "editor": "simple",
-            "value": 800
-          },
-          "height": {
-            "editor": "simple",
-            "value": 600
-          },
-          "fullscreen": {
-            "editor": "simple",
-            "value": "false"
-          },
-          "frame": {
-            "editor": "simple",
-            "value": "true"
-          },
-          "transparent": {
-            "editor": "simple",
-            "value": "false"
-          },
-          "toolbar": {
-            "editor": "simple",
-            "value": "false"
-          },
-          "alwaysOnTop": {
-            "editor": "simple",
-            "value": "false"
-          },
-          "electronVersion": {
-            "editor": "simple",
-            "value": ""
-          },
-          "customMainCode": {
-            "editor": "simple",
-            "value": ""
-          },
-          "disableAsarPackaging": {
-            "editor": "simple",
-            "value": "true"
-          },
-          "enableExtraLogging": {
-            "editor": "simple",
-            "value": "false"
-          },
-          "clearServiceWorkerOnBoot": {
-            "editor": "simple",
-            "value": "false"
-          },
-          "enableInProcessGPU": {
-            "editor": "simple",
-            "value": "false"
-          },
-          "enableDisableRendererBackgrounding": {
-            "editor": "simple",
-            "value": "false"
-          },
-          "forceHighPerformanceGpu": {
-            "editor": "simple",
-            "value": "false"
-          },
-          "websocketApi": {
-            "editor": "simple",
-            "value": "[]"
-          },
-          "ignore": {
-            "editor": "simple",
-            "value": "[\n  // use 'src/app/' as starting point\n]"
-          },
-          "enableSteamSupport": {
-            "editor": "simple",
-            "value": "true"
-          },
-          "steamGameId": {
-            "editor": "simple",
-            "value": ""
-          },
-          "openDevtoolsOnStart": {
-            "editor": "simple",
-            "value": false
-          },
-          "enableDiscordSupport": {
-            "editor": "simple",
-            "value": false
-          },
-          "discordAppId": {
-            "editor": "simple",
-            "value": ""
-          },
-          "customPackages": {
-            "editor": "editor",
-            "value": "[\n]"
-          },
-          "backgroundColor": {
-            "editor": "simple",
-            "value": "\"#FFFFFF\""
-          }
-        }
-      }
-    ],
-    "triggers": [
-      {
-        "type": "event",
-        "origin": {
-          "pluginId": "system",
-          "nodeId": "manual"
-        },
-        "uid": "manual-start",
-        "params": {}
-      }
-    ]
-  },
-  "version": "3.0.0"
-}

package/tests/e2e/fixtures/folder-to-tauri.json

@@ -1,58 +0,0 @@
-{
-  "version": "3.0.0",
-  "name": "Noobs are coming tauri",
-  "description": "",
-  "canvas": {
-    "blocks": [
-      {
-        "uid": "tauri-package-node",
-        "type": "action",
-        "origin": { "nodeId": "tauri:package:v2", "pluginId": "tauri" },
-        "params": {
-          "arch": { "editor": "simple", "value": "" },
-          "platform": { "editor": "simple", "value": "" },
-          "input-folder": {
-            "editor": "simple",
-            "value": "\"./tests/e2e/fixtures/html-export\""
-          },
-          "name": { "editor": "simple", "value": "\"Pipelab\"" },
-          "appBundleId": { "editor": "simple", "value": "\"com.pipelab.app\"" },
-          "appCopyright": { "editor": "simple", "value": "\"Copyright © 2024 Pipelab\"" },
-          "appVersion": { "editor": "simple", "value": "\"1.0.0\"" },
-          "icon": { "editor": "simple", "value": "" },
-          "author": { "editor": "simple", "value": "\"Pipelab\"" },
-          "description": { "editor": "simple", "value": "\"A simple Electron application\"" },
-          "appCategoryType": {
-            "editor": "simple",
-            "value": "\"public.app-category.developer-tools\""
-          },
-          "width": { "editor": "simple", "value": 800 },
-          "height": { "editor": "simple", "value": 600 },
-          "fullscreen": { "editor": "simple", "value": false },
-          "frame": { "editor": "simple", "value": true },
-          "transparent": { "editor": "simple", "value": false },
-          "toolbar": { "editor": "simple", "value": true },
-          "alwaysOnTop": { "editor": "simple", "value": false },
-          "tauriVersion": { "editor": "simple", "value": "\"\"" },
-          "enableExtraLogging": { "editor": "simple", "value": false },
-          "openDevtoolsOnStart": { "editor": "simple", "value": false },
-          "websocketApi": { "editor": "simple", "value": "[]" },
-          "ignore": { "editor": "simple", "value": "[\n  // use 'src/app/' as starting point\n]" },
-          "enableSteamSupport": { "editor": "simple", "value": false },
-          "steamGameId": { "editor": "simple", "value": 480 },
-          "enableDiscordSupport": { "editor": "simple", "value": false },
-          "discordAppId": { "editor": "simple", "value": "\"\"" }
-        }
-      }
-    ],
-    "triggers": [
-      {
-        "type": "event",
-        "origin": { "pluginId": "system", "nodeId": "manual" },
-        "uid": "manual-start",
-        "params": {}
-      }
-    ]
-  },
-  "variables": []
-}

package/tests/e2e/vitest.config.mts

@@ -1,20 +0,0 @@
-import { defineConfig } from "vitest/config";
-
-export default defineConfig({
-  test: {
-    fileParallelism: false,
-    testTimeout: 60000,
-    hookTimeout: 60000,
-    maxWorkers: 1,
-    minWorkers: 1,
-    poolOptions: {
-      forks: {
-        singleFork: true,
-      },
-    },
-    include: ["**/*.spec.ts"],
-    root: "tests/e2e",
-    environment: "node",
-    env: { NODE_ENV: "development", PIPELAB_DISABLE_HISTORY: "true" },
-  },
-});

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "@pipelab/tsconfig/vue.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "rootDir": "src",
-    "types": ["node"],
-    "skipLibCheck": true
-  },
-  "include": ["src"]
-}

package/tsdown.config.ts

@@ -1,15 +0,0 @@
-import { defineConfig } from "tsdown";
-
-export default defineConfig({
-  entry: ["src/index.ts"],
-  format: ["esm", "cjs"],
-  dts: true,
-  clean: true,
-  loader: {
-    ".webp": "dataurl",
-    ".png": "dataurl",
-    ".jpg": "dataurl",
-    ".jpeg": "dataurl",
-    ".svg": "dataurl",
-  },
-});