@pipelab/core-node 1.0.0-beta.0

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @pipelab/core-node
+
+## 1.0.0-beta.0
+
+### Major Changes
+
+- e1befbf: initial release
+
+### Patch Changes
+
+- Updated dependencies [e1befbf]
+  - @pipelab/constants@1.0.0-beta.0
+  - @pipelab/shared@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/README.md

@@ -0,0 +1,10 @@
+# @pipelab/core-node
+
+The backend execution engine for Pipelab.
+
+## Responsibilities
+
+- **Graph Execution**: Handles the logic for running automation pipelines.
+- **WebSocket Server**: Real-time communication between UI and backend.
+- **Environment Management**: Ensures required runtimes (like Node.js) are available.
+- **System Integration**: File system utilities, terminal emulation (PTY), and build history management.

package/dist/index.d.mts

@@ -0,0 +1,416 @@
+/// <reference types="node" />
+import { WebSocket } from "ws";
+import { Action, Agent, BlockCondition, BuildHistoryEntry, Channels, Condition, End, Event as Event$1, Events, Expression, ExtractInputsFromAction, ExtractInputsFromCondition, ExtractInputsFromEvent, ExtractInputsFromExpression, ExtractInputsFromLoop, HandleListenerRendererSendFn, IBuildHistoryStorage, IpcMessage, Loop, Migrator, RendererChannels, RendererData, RendererEnd, RendererEvents, RendererMessage, RequestId, SetOutputActionFn, SetOutputExpressionFn, SetOutputLoopFn, UpdateStatus, Variable, WebSocketConnectionState, WebSocketEvent, WebSocketHandler, WebSocketSendFunction } from "@pipelab/shared";
+import * as execa$1 from "execa";
+import { Options as Options$1, Subprocess } from "execa";
+import * as http$1 from "http";
+import http from "http";
+
+//#region src/context.d.ts
+declare const isDev: boolean;
+declare const getDefaultUserDataPath: () => string;
+declare const projectRoot: string | null;
+interface PipelabContextOptions {
+  userDataPath: string;
+}
+declare class PipelabContext {
+  readonly userDataPath: string;
+  constructor(options: PipelabContextOptions);
+  getPackagesPath(...subpaths: string[]): string;
+  getThirdPartyPath(...subpaths: string[]): string;
+  getConfigPath(...subpaths: string[]): string;
+}
+//#endregion
+//#region src/websocket-server.d.ts
+interface ConnectedClient {
+  id: string;
+  name: string;
+  ws: WebSocket;
+  connectedAt: number;
+}
+declare class WebSocketServer {
+  private wss;
+  private server;
+  private isReady;
+  private readyResolve;
+  private connectionState;
+  private clients;
+  private lastBroadcasts;
+  start(port?: number, existingServer?: http$1.Server): Promise<void>;
+  private handleWebSocketMessage;
+  private sendError;
+  stop(): Promise<void>;
+  waitForReady(): Promise<void>;
+  isServerReady(): boolean;
+  getConnectionState(): WebSocketConnectionState;
+  getAgents(): Agent[];
+  getClient(ws: WebSocket): ConnectedClient | undefined;
+  /**
+   * Broadcasts a message to all connected clients.
+   * Useful for push notifications like auth state changes.
+   */
+  broadcast<KEY extends Channels>(channel: KEY, data: Events<KEY>): void;
+}
+declare const webSocketServer: WebSocketServer;
+//#endregion
+//#region src/ipc-core.d.ts
+type HandleListenerSendFn<KEY extends Channels> = WebSocketSendFunction<KEY>;
+type WsEvent = WebSocketEvent;
+type HandleListener<KEY extends Channels> = WebSocketHandler<KEY>;
+declare const useAPI: () => {
+  handle: <KEY extends Channels>(channel: KEY, listener: WebSocketHandler<KEY>) => {
+    channel: KEY;
+    listener: WebSocketHandler<KEY>;
+  };
+  processWebSocketMessage: (ws: WebSocket, channel: string, message: IpcMessage) => any;
+  handlers: Record<string, WebSocketHandler<any>>;
+};
+//#endregion
+//#region src/handlers/shell.d.ts
+declare const registerShellHandlers: (_context: PipelabContext) => void;
+//#endregion
+//#region src/handlers/fs.d.ts
+declare const registerFsHandlers: (_context: PipelabContext) => void;
+//#endregion
+//#region src/handlers/config.d.ts
+declare const registerConfigHandlers: (context: PipelabContext) => void;
+//#endregion
+//#region src/handlers/history.d.ts
+declare const registerHistoryHandlers: (context: PipelabContext) => void;
+//#endregion
+//#region src/handlers/engine.d.ts
+declare const registerEngineHandlers: (context: PipelabContext) => void;
+//#endregion
+//#region src/handlers/agents.d.ts
+declare const registerAgentsHandlers: (_context: PipelabContext) => void;
+//#endregion
+//#region src/handlers/build-history.d.ts
+declare class BuildHistoryStorage implements IBuildHistoryStorage {
+  private context;
+  private logger;
+  constructor(context: PipelabContext);
+  private getStoragePath;
+  private getPipelinePath;
+  private ensureStoragePath;
+  private loadPipelineHistory;
+  private savePipelineHistory;
+  applyRetentionPolicy(): Promise<void>;
+  save(entry: BuildHistoryEntry): Promise<void>;
+  get(id: string, pipelineId?: string): Promise<BuildHistoryEntry | undefined>;
+  getAll(): Promise<BuildHistoryEntry[]>;
+  getByPipeline(pipelineId: string): Promise<BuildHistoryEntry[]>;
+  update(id: string, updates: Partial<BuildHistoryEntry>, pipelineId?: string): Promise<void>;
+  delete(id: string, pipelineId?: string): Promise<void>;
+  clear(): Promise<void>;
+  clearByPipeline(pipelineId: string): Promise<void>;
+  getStorageInfo(): Promise<{
+    totalEntries: number;
+    totalSize: number;
+    oldestEntry?: number;
+    newestEntry?: number;
+    numberOfPipelines: number;
+    userDataPath: string;
+    retentionPolicy: {
+      enabled: boolean;
+      maxEntries: number;
+      maxAge: number;
+    };
+    disk: {
+      total: number;
+      free: number;
+      pipelab: number;
+    };
+  }>;
+  private getAllPipelineFiles;
+}
+//#endregion
+//#region src/handlers/index.d.ts
+declare const registerAllHandlers: (options: {
+  version: string;
+  context: PipelabContext;
+}) => Promise<void>;
+//#endregion
+//#region src/config.d.ts
+declare const getMigrator: <T>(name: string) => any;
+declare const setupConfigFile: <T>(name: string, options: {
+  context: PipelabContext;
+  migrator?: Migrator<T>;
+}) => Promise<{
+  setConfig: (config: T) => Promise<boolean>;
+  getConfig: () => Promise<T>;
+}>;
+//#endregion
+//#region src/api.d.ts
+type HandleListenerRenderer<KEY extends RendererChannels> = (event: Electron.IpcMainInvokeEvent, data: {
+  value: RendererData<KEY>;
+  send: HandleListenerRendererSendFn<KEY>;
+}) => Promise<void>;
+type ListenerMain<KEY extends RendererChannels> = (event: Electron.IpcMainEvent, data: RendererEvents<KEY>) => Promise<void>;
+declare const usePluginAPI: (browserWindow: any) => {
+  send: <KEY extends RendererChannels>(channel: KEY, args?: RendererData<KEY>) => void;
+  on: <KEY extends RendererChannels>(channel: KEY | string, listener: (event: any, data: RendererEvents<KEY>) => void) => () => void;
+  execute: <KEY extends RendererChannels>(channel: KEY, data?: RendererData<KEY>, listener?: ListenerMain<KEY>) => Promise<RendererEnd<KEY>>;
+};
+type UseMainAPI = ReturnType<typeof usePluginAPI>;
+//#endregion
+//#region src/handler-func.d.ts
+declare const handleConditionExecute: (nodeId: string, pluginId: string, params: BlockCondition["params"], cwd: string, context: PipelabContext) => Promise<End<"condition:execute">>;
+declare const handleActionExecute: (nodeId: string, pluginId: string, params: Record<string, string>, mainWindow: any | undefined, send: HandleListenerSendFn<"action:execute">, abortSignal: AbortSignal, cwd: string, cachePath: string, context: PipelabContext) => Promise<End<"action:execute">>;
+//#endregion
+//#region src/utils.d.ts
+declare const getFinalPlugins: () => RendererPluginDefinition[];
+declare const executeGraphWithHistory: ({
+  graph,
+  variables,
+  projectName,
+  projectPath,
+  pipelineId,
+  onNodeEnter,
+  onNodeExit,
+  onLog,
+  abortSignal,
+  mainWindow,
+  cachePath,
+  context
+}: {
+  graph: any;
+  variables: Variable[];
+  projectName: string;
+  projectPath: string;
+  pipelineId: string;
+  onNodeEnter?: (node: any) => void;
+  onNodeExit?: (node: any) => void;
+  onLog?: (data: any, node?: any) => void;
+  abortSignal: AbortSignal;
+  mainWindow?: any;
+  cachePath: string;
+  context: PipelabContext;
+}) => Promise<{
+  result: any;
+  buildId: string;
+}>;
+//#endregion
+//#region src/plugins-registry.d.ts
+declare const loadPipelabPlugin: (id: string, options: {
+  context: PipelabContext;
+}) => Promise<any>;
+declare const builtInPlugins: (options: {
+  context: PipelabContext;
+}) => Promise<any[]>;
+//#endregion
+//#region src/utils/remote.d.ts
+declare const DEFAULT_NODE_VERSION = "24.14.1";
+declare const DEFAULT_PNPM_VERSION = "10.12.0";
+type FetchOptions = {
+  installDeps?: boolean;
+  signal?: AbortSignal;
+  context: PipelabContext;
+};
+/**
+ * Robust utility to fetch, cache, and resolve an NPM package.
+ * Centralized in core-node to avoid circular dependencies.
+ */
+declare function fetchPackage(packageName: string, versionOrRange: string, options: FetchOptions): Promise<{
+  packageDir: string;
+  resolvedVersion: string;
+  isLocal?: boolean;
+  entryPoint?: string;
+}>;
+/**
+ * Executes a pnpm install in a specific directory with a portable environment.
+ */
+declare function runPnpm(cwd: string, options: {
+  args?: string[];
+  extraEnv?: Record<string, string>;
+  signal?: AbortSignal;
+  context: PipelabContext;
+}): Promise<execa$1.Result<{
+  cwd: string;
+  all: true;
+  cancelSignal: AbortSignal | undefined;
+  env: {
+    NODE_ENV: string;
+    PATH: string | undefined;
+    PNPM_HOME: string;
+    PNPM_ONLY_ALLOW_TRUSTED_DEPENDENCIES: string;
+  };
+}>>;
+/**
+ * Installs a specific version of Node.js if not already present.
+ */
+declare function ensureNodeJS(context: PipelabContext, version?: string): Promise<string>;
+/**
+ * Installs the PNPM package from npm if not already present.
+ */
+declare function ensurePNPM(context: PipelabContext, version?: string): Promise<string>;
+declare function fetchPipelabAsset(packageName: string, versionOrRange: string, options: FetchOptions): Promise<string>;
+declare function fetchPipelabPlugin(pluginName: string, versionOrRange: string, options: FetchOptions): Promise<{
+  packageDir: string;
+  entryPoint: string;
+  isLocal: boolean;
+}>;
+declare function fetchPipelabCli(versionOrRange: string, options: FetchOptions): Promise<{
+  packageDir: string;
+  entryPoint: string;
+  isLocal: boolean;
+}>;
+//#endregion
+//#region src/utils/fs-extras.d.ts
+/**
+ * Ensures a directory exists and a file is created with default content if missing.
+ */
+declare const ensure: (filesPath: string, defaultContent?: string) => Promise<void>;
+/**
+ * Generates a unique temporary folder.
+ */
+declare const generateTempFolder: (base?: string) => Promise<string>;
+/**
+ * Extracts a .tar.gz archive.
+ */
+declare function extractTarGz(archivePath: string, destinationDir: string): Promise<void>;
+/**
+ * Extracts a .zip archive.
+ */
+declare function extractZip(archivePath: string, destinationDir: string): Promise<void>;
+/**
+ * Zips a folder.
+ */
+declare const zipFolder: (from: string, to: string, log?: typeof console.log) => Promise<string>;
+/**
+ * Downloads a file with progress tracking.
+ */
+interface DownloadHooks {
+  onProgress?: (data: {
+    progress: number;
+    downloadedSize: number;
+  }) => void;
+}
+declare const downloadFile: (url: string, localPath: string, hooks?: DownloadHooks, abortSignal?: AbortSignal) => Promise<void>;
+declare const runWithLiveLogs: (command: string, args: string[], execaOptions: Options$1, log: typeof console.log, hooks?: {
+  onStdout?: (data: string, subprocess: Subprocess) => void;
+  onStderr?: (data: string, subprocess: Subprocess) => void;
+  onExit?: (code: number) => void;
+  onCreated?: (subprocess: Subprocess) => void;
+}, abortSignal?: AbortSignal) => Promise<void>;
+/**
+ * Calculates the total size of a directory recursively.
+ */
+declare function getFolderSize(dirPath: string): Promise<number>;
+//#endregion
+//#region ../../node_modules/electron/electron.d.ts
+declare module 'electron' {
+  export = Electron.CrossProcessExports;
+}
+declare module 'electron/main' {
+  export = Electron.Main;
+}
+declare module 'electron/common' {
+  export = Electron.Common;
+}
+declare module 'electron/renderer' {
+  export = Electron.Renderer;
+}
+declare module 'electron/utility' {
+  export = Electron.Utility;
+}
+declare module 'original-fs' {
+  import * as fs from 'fs';
+  export = fs;
+}
+declare module 'node:original-fs' {
+  import * as fs from 'fs';
+  export = fs;
+}
+//#endregion
+//#region src/types/runner.d.ts
+type RunnerCallbackFnArgument = {
+  done: () => void;
+  id: string;
+  log: (...args: Parameters<(typeof console)["log"]>) => void;
+};
+type ActionRunnerData<ACTION extends Action> = {
+  log: typeof console.log;
+  setOutput: SetOutputActionFn<ACTION>;
+  inputs: ExtractInputsFromAction<ACTION>;
+  setMeta: (callback: (data: ACTION["meta"]) => ACTION["meta"]) => void;
+  meta: ACTION["meta"];
+  cwd: string;
+  paths: {
+    cache: string;
+    pnpm: string;
+    node: string;
+    userData: string;
+    modules: string;
+    thirdparty: string;
+  };
+  browserWindow: BrowserWindow$1;
+  abortSignal: AbortSignal;
+  context: PipelabContext;
+};
+type ActionRunner<ACTION extends Action> = (data: ActionRunnerData<ACTION>) => Promise<void>;
+type ConditionRunner<CONDITION extends Condition> = (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>;
+type LoopRunner<LOOP extends Loop> = (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">;
+type ExpressionRunner<EXPRESSION extends Expression> = (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>;
+type EventRunner<EVENT extends Event$1> = (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>;
+type Runner = ActionRunner<any> | LoopRunner<any> | EventRunner<any> | ConditionRunner<any>;
+//#endregion
+//#region src/runner.d.ts
+interface RunOptions {
+  userData?: string;
+  variables?: string;
+  output?: string;
+  cloud?: boolean;
+}
+declare function runPipelineCommand(file: string, options: RunOptions, version: string): Promise<any>;
+//#endregion
+//#region src/migrations.d.ts
+/**
+ * Registers migration handlers for the CLI/Standalone server.
+ * This overrides the default handlers from @pipelab/core-node to include
+ * pipeline and file repo migrations directly in the backend.
+ */
+declare function registerMigrationHandlers(context: PipelabContext): void;
+//#endregion
+//#region src/server.d.ts
+interface ServeOptions {
+  port: string | number;
+  userData?: string;
+  nodePath?: string;
+  pnpmPath?: string;
+}
+declare const sendStartupProgress: (message: string) => void;
+declare const sendStartupReady: () => void;
+declare function serveCommand(options: ServeOptions, version: string, _dirname: string): Promise<http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>>;
+//#endregion
+export { type Action, ActionRunner, ActionRunnerData, BuildHistoryStorage, type Condition, ConditionRunner, ConnectedClient, DEFAULT_NODE_VERSION, DEFAULT_PNPM_VERSION, DownloadHooks, type Event$1 as Event, EventRunner, type Expression, ExpressionRunner, type ExtractInputsFromAction, type ExtractInputsFromCondition, type ExtractInputsFromEvent, type ExtractInputsFromExpression, type ExtractInputsFromLoop, FetchOptions, HandleListener, HandleListenerRenderer, type HandleListenerRendererSendFn, HandleListenerSendFn, ListenerMain, type Loop, LoopRunner, PipelabContext, PipelabContextOptions, type RendererChannels, type RendererData, type RendererEnd, type RendererEvents, type RendererMessage, type RequestId, RunOptions, Runner, RunnerCallbackFnArgument, ServeOptions, type SetOutputActionFn, type SetOutputExpressionFn, type SetOutputLoopFn, type UpdateStatus, UseMainAPI, WebSocketServer, WsEvent, builtInPlugins, downloadFile, ensure, ensureNodeJS, ensurePNPM, executeGraphWithHistory, extractTarGz, extractZip, fetchPackage, fetchPipelabAsset, fetchPipelabCli, fetchPipelabPlugin, generateTempFolder, getDefaultUserDataPath, getFinalPlugins, getFolderSize, getMigrator, handleActionExecute, handleConditionExecute, isDev, loadPipelabPlugin, projectRoot, registerAgentsHandlers, registerAllHandlers, registerConfigHandlers, registerEngineHandlers, registerFsHandlers, registerHistoryHandlers, registerMigrationHandlers, registerShellHandlers, runPipelineCommand, runPnpm, runWithLiveLogs, sendStartupProgress, sendStartupReady, serveCommand, setupConfigFile, useAPI, usePluginAPI, webSocketServer, zipFolder };
+//# sourceMappingURL=index.d.mts.map