@pipelab/plugin-core 1.0.0-beta.1 → 1.0.0-beta.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipelab/plugin-core",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.11",
   "description": "Core library for building Pipelab plugins",
   "license": "FSL-1.1-MIT",
   "author": "CynToolkit",
@@ -9,6 +9,9 @@
     "url": "https://github.com/CynToolkit/pipelab.git",
     "directory": "plugins/plugin-core"
   },
+  "files": [
+    "dist"
+  ],
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -35,7 +38,7 @@
     "type-fest": "4.26.1",
     "yauzl": "2.10.0",
     "zod": "4.3.6",
-    "@pipelab/core-node": "1.0.0-beta.1"
+    "@pipelab/core-node": "1.0.0-beta.10"
   },
   "devDependencies": {
     "@types/archiver": "7.0.0",
@@ -44,9 +47,9 @@
     "@types/yauzl": "2.10.3",
     "tsdown": "0.21.2",
     "typescript": "5.9.3",
-    "@pipelab/constants": "1.0.0-beta.0",
-    "@pipelab/shared": "1.0.0-beta.0",
-    "@pipelab/tsconfig": "1.0.0-beta.0"
+    "@pipelab/constants": "1.0.0-beta.8",
+    "@pipelab/shared": "1.0.0-beta.6",
+    "@pipelab/tsconfig": "1.0.0-beta.6"
   },
   "scripts": {
     "build": "tsdown",

package/CHANGELOG.md

@@ -1,19 +0,0 @@
-# @pipelab/plugin-core
-
-## 1.0.0-beta.1
-
-### Patch Changes
-
-- Updated dependencies
-  - @pipelab/core-node@1.0.0-beta.1
-
-## 1.0.0-beta.0
-
-### Major Changes
-
-- e1befbf: initial release
-
-### Patch Changes
-
-- Updated dependencies [e1befbf]
-  - @pipelab/core-node@1.0.0-beta.0

package/src/archive-utils.ts

@@ -1,127 +0,0 @@
-import { mkdir, createReadStream, createWriteStream } from "node:fs";
-import { mkdir as mkdirP } from "node:fs/promises";
-import { join, dirname } from "node:path";
-import zlib from "zlib";
-import tar from "tar";
-import yauzl from "yauzl";
-import archiver from "archiver";
-
-/**
- * Extracts a .tar.gz archive.
- * @param archivePath The full path to the .tar.gz file.
- * @param destinationDir The directory to extract contents into.
- * @returns A Promise that resolves when extraction is complete.
- */
-export async function extractTarGz(archivePath: string, destinationDir: string): Promise<void> {
-  console.log(`Extracting ${archivePath} to ${destinationDir}...`);
-
-  // Ensure the destination directory exists
-  await mkdirP(destinationDir, { recursive: true });
-
-  await tar.x({
-    file: archivePath,
-    cwd: destinationDir,
-  });
-
-  console.log("Extraction finished.");
-}
-
-/**
- * Extracts a .zip archive.
- * @param archivePath The full path to the .zip file.
- * @param destinationDir The directory to extract contents into.
- * @returns A Promise that resolves when extraction is complete.
- */
-export async function extractZip(archivePath: string, destinationDir: string): Promise<void> {
-  console.log(`Extracting ${archivePath} to ${destinationDir}...`);
-
-  // Ensure the destination directory exists
-  await mkdirP(destinationDir, { recursive: true });
-
-  return new Promise((resolve, reject) => {
-    yauzl.open(archivePath, { lazyEntries: true }, (err, zipfile) => {
-      if (err || !zipfile) {
-        return reject(err || new Error("Could not open zip file"));
-      }
-
-      zipfile.on("error", reject);
-
-      zipfile.readEntry(); // Start reading entries
-
-      zipfile.on("entry", (entry) => {
-        const entryPath = join(destinationDir, entry.fileName);
-
-        if (/\/$/.test(entry.fileName)) {
-          // It's a directory
-          mkdirP(entryPath, { recursive: true })
-            .then(() => zipfile.readEntry())
-            .catch(reject);
-        } else {
-          // It's a file
-          // Ensure parent directory exists (just in case)
-          mkdirP(dirname(entryPath), { recursive: true })
-            .then(() => {
-              zipfile.openReadStream(entry, (err, readStream) => {
-                if (err || !readStream) {
-                  return reject(err || new Error("Could not open read stream"));
-                }
-
-                readStream.on("error", reject);
-                const writeStream = createWriteStream(entryPath);
-                writeStream.on("error", reject);
-                writeStream.on("close", () => {
-                  zipfile.readEntry();
-                });
-                readStream.pipe(writeStream);
-              });
-            })
-            .catch(reject);
-        }
-      });
-
-      zipfile.on("end", () => {
-        console.log("Zip extraction finished.");
-        resolve();
-      });
-    });
-  });
-}
-
-export const zipFolder = async (from: string, to: string, log: typeof console.log) => {
-  const output = createWriteStream(to);
-
-  const archive = archiver("zip", {
-    zlib: { level: 9 }, // Sets the compression level.
-  });
-
-  // eslint-disable-next-line no-async-promise-executor
-  return new Promise<string>(async (resolve, reject) => {
-    // listen for all archive data to be written
-    // 'close' event is fired only when a file descriptor is involved
-    output.on("close", function () {
-      log(archive.pointer() + " total bytes");
-      log("archiver has been finalized and the output file descriptor has closed.");
-      resolve(to);
-    });
-
-    // This event is fired when the data source is drained no matter what was the data source.
-    // It is not part of this library but part of NodeJS.
-    output.on("end", function () {
-      log("Data has been drained");
-    });
-
-    // good practice to catch this error and expose it to the user
-    archive.on("error", function (err) {
-      reject(err);
-    });
-
-    // pipe archive data to the file
-    archive.pipe(output);
-
-    archive.directory(from, false);
-
-    // finalize the archive (ie we are done appending files but streams have to finish yet)
-    // 'close', 'end' or 'finish' may be fired right after calling this method so register to them beforehand
-    await archive.finalize();
-  });
-};

package/src/create-plugin.ts

@@ -1,8 +0,0 @@
-export type Plugin = {
-  nodes: Record<string, any>;
-  runtime: () => Promise<void>;
-};
-
-export const createPlugin = (plugin: Plugin) => {
-  return plugin;
-};

package/src/custom-errors.ts

@@ -1,11 +0,0 @@
-export class ExternalCommandError extends Error {
-  code: number;
-
-  constructor(message: string, code: number) {
-    super(message);
-
-    this.code = code;
-
-    Object.setPrototypeOf(this, ExternalCommandError.prototype);
-  }
-}

package/src/fs-utils.ts

@@ -1,31 +0,0 @@
-import { access, mkdir, realpath, writeFile, mkdtemp } from "node:fs/promises";
-import { dirname, join } from "node:path";
-import { tmpdir } from "node:os";
-import { readdirSync, copyFileSync, statSync } from "node:fs";
-
-export const ensure = async (filesPath: string, defaultContent = "{}") => {
-  // create parent folder
-  await mkdir(dirname(filesPath), {
-    recursive: true,
-  });
-
-  // ensure file exist
-  try {
-    await access(filesPath);
-  } catch {
-    // File doesn't exist, create it
-    await writeFile(filesPath, defaultContent); // json
-  }
-};
-
-export const generateTempFolder = async (base?: string) => {
-  const targetBase = base || tmpdir();
-  await mkdir(targetBase, {
-    recursive: true,
-  });
-  const realPath = await realpath(targetBase);
-  console.log("join", join(realPath, "pipelab-"));
-  const tempFolder = await mkdtemp(join(realPath, "pipelab-"));
-
-  return tempFolder;
-};

package/src/node-utils.ts

@@ -1,52 +0,0 @@
-import { access } from "node:fs/promises";
-import { join } from "node:path";
-
-export type OutputRuntimes = "construct" | "godot";
-
-const fileExists = async (path: string): Promise<boolean> => {
-  try {
-    await access(path);
-    return true;
-  } catch {
-    return false;
-  }
-};
-
-/**
- * Detects the runtime of an app folder by checking for specific files.
- * This function depends on Node.js APIs and should only be used in Node environments.
- */
-export const detectRuntime = async (
-  appFolder: string | undefined,
-): Promise<OutputRuntimes | undefined> => {
-  if (!appFolder) {
-    return undefined;
-  }
-
-  const indexExist = await fileExists(join(appFolder, "index.html"));
-  const swExist = await fileExists(join(appFolder, "sw.js"));
-  const offlineJSON = await fileExists(join(appFolder, "offline.json"));
-  const dataJSON = await fileExists(join(appFolder, "data.json"));
-  const scriptsFolder = await fileExists(join(appFolder, "scripts"));
-  const workermainJs = await fileExists(join(appFolder, "workermain.js"));
-
-  if (!indexExist) {
-    throw new Error("The input folder does not contain an index.html file");
-  }
-
-  let detectedRuntime: OutputRuntimes | undefined = undefined;
-
-  if (swExist || dataJSON || workermainJs || scriptsFolder) {
-    detectedRuntime = "construct";
-  }
-
-  console.log("Detected runtime", detectedRuntime);
-
-  if (detectedRuntime === "construct" && offlineJSON && swExist) {
-    throw new Error(
-      "Construct runtime detected, please disable offline capabilties when using HTML5 export. Offline is already supported by default.",
-    );
-  }
-
-  return detectedRuntime;
-};

package/src/pipelab.ts

@@ -1,95 +0,0 @@
-import type { BrowserWindow } from "electron";
-import type {
-  Action,
-  Condition,
-  Loop,
-  Expression,
-  Event,
-  SetOutputActionFn,
-  SetOutputLoopFn,
-  SetOutputExpressionFn,
-  ExtractInputsFromAction,
-  ExtractInputsFromCondition,
-  ExtractInputsFromLoop,
-  ExtractInputsFromEvent,
-  ExtractInputsFromExpression,
-} from "@pipelab/shared";
-
-export * from "@pipelab/shared";
-import {
-  type RunnerCallbackFnArgument,
-  type ActionRunnerData,
-  type ActionRunner,
-  type ConditionRunner,
-  type LoopRunner,
-  type ExpressionRunner,
-  type EventRunner,
-  type Runner,
-  PipelabContext,
-} from "@pipelab/core-node";
-
-export {
-  type RunnerCallbackFnArgument,
-  type ActionRunnerData,
-  type ActionRunner,
-  type ConditionRunner,
-  type LoopRunner,
-  type ExpressionRunner,
-  type EventRunner,
-  type Runner,
-  PipelabContext,
-};
-
-export const createActionRunner = <ACTION extends Action>(
-  runner: (data: ActionRunnerData<ACTION>) => Promise<void>,
-) => runner;
-
-export const createConditionRunner = <CONDITION extends Condition>(
-  runner: (data: {
-    log: typeof console.log;
-    inputs: ExtractInputsFromCondition<CONDITION>;
-    setMeta: (callback: (data: CONDITION["meta"]) => CONDITION["meta"]) => void;
-    meta: CONDITION["meta"];
-    cwd: string;
-    context: PipelabContext;
-  }) => Promise<boolean>,
-) => runner;
-
-export const createLoopRunner = <LOOP extends Loop>(
-  runner: (data: {
-    log: typeof console.log;
-    setOutput: SetOutputLoopFn<LOOP>;
-    inputs: ExtractInputsFromLoop<LOOP>;
-    setMeta: (callback: (data: LOOP["meta"]) => LOOP["meta"]) => void;
-    meta: LOOP["meta"];
-    cwd: string;
-    context: PipelabContext;
-  }) => Promise<"step" | "exit">,
-) => runner;
-
-export const createExpressionRunner = <EXPRESSION extends Expression>(
-  runner: (data: {
-    log: typeof console.log;
-    setOutput: SetOutputExpressionFn<EXPRESSION>;
-    inputs: ExtractInputsFromExpression<EXPRESSION>;
-    setMeta: (callback: (data: EXPRESSION["meta"]) => EXPRESSION["meta"]) => void;
-    meta: EXPRESSION["meta"];
-    cwd: string;
-    context: PipelabContext;
-  }) => Promise<string>,
-) => runner;
-
-export const createEventRunner = <EVENT extends Event>(
-  runner: (data: {
-    log: typeof console.log;
-    inputs: ExtractInputsFromEvent<EVENT>;
-    setMeta: (callback: (data: EVENT["meta"]) => EVENT["meta"]) => void;
-    meta: EVENT["meta"];
-    cwd: string;
-    context: PipelabContext;
-  }) => Promise<void>,
-) => runner;
-
-export const sleep = (duration: number) => {
-  return new Promise((resolve) => setTimeout(resolve, duration));
-};

package/src/utils.ts

@@ -1,26 +0,0 @@
-import { Options, Subprocess } from "execa";
-export {
-  fetchPackage,
-  fetchPipelabAsset,
-  fetchPipelabPlugin,
-  fetchPipelabCli,
-  runPnpm,
-  downloadFile,
-  runWithLiveLogs,
-} from "@pipelab/core-node";
-
-/**
- * Re-exporting hooks type for backward compatibility
- */
-export type { DownloadHooks as Hooks } from "@pipelab/core-node";
-
-// Keep runtime-only utilities that don't depend on complex engine state
-export const fileExists = async (path: string): Promise<boolean> => {
-  try {
-    const { access } = await import("node:fs/promises");
-    await access(path);
-    return true;
-  } catch {
-    return false;
-  }
-};

package/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "extends": "@pipelab/tsconfig/vue.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "rootDir": "src",
-    "types": ["node"]
-  },
-  "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",
-  },
-});