@workplane/adapter-sdk 0.3.1

package/dist/index.d.ts

@@ -0,0 +1,44 @@
+interface ExecResult {
+    exitCode: number;
+    stdout: string;
+    stderr: string;
+}
+interface ExecOptions {
+    cwd?: string;
+    env?: Record<string, string>;
+    signal?: AbortSignal;
+}
+interface ArtifactInput {
+    type: string;
+    name: string;
+    path: string;
+    metadata?: Record<string, unknown>;
+}
+interface WorkContext {
+    runId: string;
+    taskId: string;
+    workspacePath: string;
+    log: (stream: "stdout" | "stderr" | "system", message: string, stepName?: string) => Promise<void>;
+    exec: (command: string, args?: string[], options?: ExecOptions) => Promise<ExecResult>;
+    ensureWorkspace: (...segments: string[]) => Promise<string>;
+    emitArtifact: (input: ArtifactInput) => Promise<void>;
+    envAllowlist?: string[];
+    writeStdin?: (data: string) => void;
+    ptyResize?: (rows: number, cols: number) => void;
+}
+interface WorkAdapter<TPayload = Record<string, unknown>> {
+    name: string;
+    kind: string;
+    interactive?: boolean;
+    terminalMode?: "stdio" | "pty";
+    run: (context: WorkContext, payload: TPayload) => Promise<void>;
+}
+declare function createExec(context: WorkContext): WorkContext["exec"];
+declare function createCancellableExec(context: WorkContext): {
+    exec: WorkContext["exec"];
+    kill: (signal?: NodeJS.Signals) => void;
+    writeStdin: (data: string) => void;
+};
+declare function ensureWorkspacePath(workspacePath: string, ...segments: string[]): Promise<string>;
+
+export { type ArtifactInput, type ExecOptions, type ExecResult, type WorkAdapter, type WorkContext, createCancellableExec, createExec, ensureWorkspacePath };

package/dist/index.js

@@ -0,0 +1,143 @@
+// src/index.ts
+import { spawn } from "child_process";
+import { mkdir } from "fs/promises";
+import { join } from "path";
+function pickEnv(allowlist) {
+  if (!allowlist || allowlist.length === 0) {
+    return { ...process.env };
+  }
+  const picked = {};
+  for (const key of allowlist) {
+    const value = process.env[key];
+    if (value !== void 0) {
+      picked[key] = value;
+    }
+  }
+  picked.PATH = process.env.PATH ?? "";
+  picked.HOME = process.env.HOME ?? "";
+  return picked;
+}
+function createExec(context) {
+  return async (command, args = [], options = {}) => new Promise((resolve) => {
+    let childError;
+    const child = spawn(command, args, {
+      cwd: options.cwd ?? context.workspacePath,
+      env: {
+        ...pickEnv(context.envAllowlist),
+        ...options.env ?? {}
+      },
+      signal: options.signal
+    });
+    let stdout = "";
+    let stderr = "";
+    child.stdout.on("data", (chunk) => {
+      const text = chunk.toString();
+      stdout += text;
+      void context.log("stdout", text);
+    });
+    child.stderr.on("data", (chunk) => {
+      const text = chunk.toString();
+      stderr += text;
+      void context.log("stderr", text);
+    });
+    child.on("error", (error) => {
+      childError = error;
+    });
+    child.on("close", (exitCode, signal) => {
+      if (signal === "SIGTERM" || signal === "SIGKILL") {
+        resolve({
+          exitCode: exitCode ?? 1,
+          stdout,
+          stderr: `${stderr}
+process terminated (${signal})`.trim()
+        });
+        return;
+      }
+      resolve({
+        exitCode: exitCode ?? 1,
+        stdout,
+        stderr: childError ? `${stderr}
+${childError.message}`.trim() : stderr
+      });
+    });
+  });
+}
+function createCancellableExec(context) {
+  let activeChild;
+  const exec = async (command, args = [], options = {}) => new Promise((resolve) => {
+    let childError;
+    const child = spawn(command, args, {
+      cwd: options.cwd ?? context.workspacePath,
+      env: {
+        ...pickEnv(context.envAllowlist),
+        ...options.env ?? {}
+      },
+      signal: options.signal
+    });
+    activeChild = child;
+    let stdout = "";
+    let stderr = "";
+    child.stdout.on("data", (chunk) => {
+      const text = chunk.toString();
+      stdout += text;
+      void context.log("stdout", text);
+    });
+    child.stderr.on("data", (chunk) => {
+      const text = chunk.toString();
+      stderr += text;
+      void context.log("stderr", text);
+    });
+    child.on("error", (error) => {
+      childError = error;
+    });
+    child.on("close", (exitCode, signal) => {
+      if (activeChild === child) {
+        activeChild = void 0;
+      }
+      if (signal === "SIGTERM" || signal === "SIGKILL") {
+        resolve({
+          exitCode: exitCode ?? 1,
+          stdout,
+          stderr: `${stderr}
+process terminated (${signal})`.trim()
+        });
+        return;
+      }
+      resolve({
+        exitCode: exitCode ?? 1,
+        stdout,
+        stderr: childError ? `${stderr}
+${childError.message}`.trim() : stderr
+      });
+    });
+  });
+  const kill = (signal = "SIGTERM") => {
+    if (!activeChild || activeChild.killed) return;
+    activeChild.kill(signal);
+    if (signal === "SIGTERM") {
+      const escalation = setTimeout(() => {
+        if (activeChild && !activeChild.killed) {
+          activeChild.kill("SIGKILL");
+        }
+      }, 5e3);
+      escalation.unref();
+    }
+  };
+  const writeStdin = (data) => {
+    if (activeChild && !activeChild.killed && activeChild.stdin && !activeChild.stdin.destroyed) {
+      activeChild.stdin.write(data);
+    }
+  };
+  return { exec, kill, writeStdin };
+}
+async function ensureWorkspacePath(workspacePath, ...segments) {
+  const fullPath = join(workspacePath, ...segments);
+  await mkdir(fullPath, { recursive: true });
+  return fullPath;
+}
+export {
+  createCancellableExec,
+  createExec,
+  ensureWorkspacePath
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { spawn, type ChildProcess } from \"node:child_process\";\nimport { mkdir } from \"node:fs/promises\";\nimport { join } from \"node:path\";\n\nexport interface ExecResult {\n  exitCode: number;\n  stdout: string;\n  stderr: string;\n}\n\nexport interface ExecOptions {\n  cwd?: string;\n  env?: Record<string, string>;\n  signal?: AbortSignal;\n}\n\nexport interface ArtifactInput {\n  type: string;\n  name: string;\n  path: string;\n  metadata?: Record<string, unknown>;\n}\n\nexport interface WorkContext {\n  runId: string;\n  taskId: string;\n  workspacePath: string;\n  log: (stream: \"stdout\" | \"stderr\" | \"system\", message: string, stepName?: string) => Promise<void>;\n  exec: (command: string, args?: string[], options?: ExecOptions) => Promise<ExecResult>;\n  ensureWorkspace: (...segments: string[]) => Promise<string>;\n  emitArtifact: (input: ArtifactInput) => Promise<void>;\n  envAllowlist?: string[];\n  writeStdin?: (data: string) => void;\n  ptyResize?: (rows: number, cols: number) => void;\n}\n\nexport interface WorkAdapter<TPayload = Record<string, unknown>> {\n  name: string;\n  kind: string;\n  interactive?: boolean;\n  terminalMode?: \"stdio\" | \"pty\";\n  run: (context: WorkContext, payload: TPayload) => Promise<void>;\n}\n\nfunction pickEnv(allowlist: string[] | undefined): Record<string, string> {\n  if (!allowlist || allowlist.length === 0) {\n    return { ...process.env } as Record<string, string>;\n  }\n  const picked: Record<string, string> = {};\n  for (const key of allowlist) {\n    const value = process.env[key];\n    if (value !== undefined) {\n      picked[key] = value;\n    }\n  }\n  picked.PATH = process.env.PATH ?? \"\";\n  picked.HOME = process.env.HOME ?? \"\";\n  return picked;\n}\n\nexport function createExec(context: WorkContext): WorkContext[\"exec\"] {\n  return async (command: string, args: string[] = [], options: ExecOptions = {}) =>\n    new Promise<ExecResult>((resolve) => {\n      let childError: Error | undefined;\n      const child = spawn(command, args, {\n        cwd: options.cwd ?? context.workspacePath,\n        env: {\n          ...pickEnv(context.envAllowlist),\n          ...(options.env ?? {}),\n        },\n        signal: options.signal,\n      });\n\n      let stdout = \"\";\n      let stderr = \"\";\n\n      child.stdout.on(\"data\", (chunk) => {\n        const text = chunk.toString();\n        stdout += text;\n        void context.log(\"stdout\", text);\n      });\n\n      child.stderr.on(\"data\", (chunk) => {\n        const text = chunk.toString();\n        stderr += text;\n        void context.log(\"stderr\", text);\n      });\n\n      child.on(\"error\", (error) => {\n        childError = error;\n      });\n\n      child.on(\"close\", (exitCode, signal) => {\n        if (signal === \"SIGTERM\" || signal === \"SIGKILL\") {\n          resolve({\n            exitCode: exitCode ?? 1,\n            stdout,\n            stderr: `${stderr}\\nprocess terminated (${signal})`.trim(),\n          });\n          return;\n        }\n        resolve({\n          exitCode: exitCode ?? 1,\n          stdout,\n          stderr: childError ? `${stderr}\\n${childError.message}`.trim() : stderr,\n        });\n      });\n    });\n}\n\nexport function createCancellableExec(context: WorkContext): {\n  exec: WorkContext[\"exec\"];\n  kill: (signal?: NodeJS.Signals) => void;\n  writeStdin: (data: string) => void;\n} {\n  let activeChild: ChildProcess | undefined;\n\n  const exec: WorkContext[\"exec\"] = async (command, args = [], options = {}) =>\n    new Promise<ExecResult>((resolve) => {\n      let childError: Error | undefined;\n      const child = spawn(command, args, {\n        cwd: options.cwd ?? context.workspacePath,\n        env: {\n          ...pickEnv(context.envAllowlist),\n          ...(options.env ?? {}),\n        },\n        signal: options.signal,\n      });\n      activeChild = child;\n\n      let stdout = \"\";\n      let stderr = \"\";\n\n      child.stdout.on(\"data\", (chunk) => {\n        const text = chunk.toString();\n        stdout += text;\n        void context.log(\"stdout\", text);\n      });\n\n      child.stderr.on(\"data\", (chunk) => {\n        const text = chunk.toString();\n        stderr += text;\n        void context.log(\"stderr\", text);\n      });\n\n      child.on(\"error\", (error) => {\n        childError = error;\n      });\n\n      child.on(\"close\", (exitCode, signal) => {\n        if (activeChild === child) {\n          activeChild = undefined;\n        }\n        if (signal === \"SIGTERM\" || signal === \"SIGKILL\") {\n          resolve({\n            exitCode: exitCode ?? 1,\n            stdout,\n            stderr: `${stderr}\\nprocess terminated (${signal})`.trim(),\n          });\n          return;\n        }\n        resolve({\n          exitCode: exitCode ?? 1,\n          stdout,\n          stderr: childError ? `${stderr}\\n${childError.message}`.trim() : stderr,\n        });\n      });\n    });\n\n  const kill = (signal: NodeJS.Signals = \"SIGTERM\"): void => {\n    if (!activeChild || activeChild.killed) return;\n    activeChild.kill(signal);\n    if (signal === \"SIGTERM\") {\n      const escalation = setTimeout(() => {\n        if (activeChild && !activeChild.killed) {\n          activeChild.kill(\"SIGKILL\");\n        }\n      }, 5000);\n      escalation.unref();\n    }\n  };\n\n  const writeStdin = (data: string): void => {\n    if (activeChild && !activeChild.killed && activeChild.stdin && !activeChild.stdin.destroyed) {\n      activeChild.stdin.write(data);\n    }\n  };\n\n  return { exec, kill, writeStdin };\n}\n\nexport async function ensureWorkspacePath(workspacePath: string, ...segments: string[]): Promise<string> {\n  const fullPath = join(workspacePath, ...segments);\n  await mkdir(fullPath, { recursive: true });\n  return fullPath;\n}\n"],"mappings":";AAAA,SAAS,aAAgC;AACzC,SAAS,aAAa;AACtB,SAAS,YAAY;AA0CrB,SAAS,QAAQ,WAAyD;AACxE,MAAI,CAAC,aAAa,UAAU,WAAW,GAAG;AACxC,WAAO,EAAE,GAAG,QAAQ,IAAI;AAAA,EAC1B;AACA,QAAM,SAAiC,CAAC;AACxC,aAAW,OAAO,WAAW;AAC3B,UAAM,QAAQ,QAAQ,IAAI,GAAG;AAC7B,QAAI,UAAU,QAAW;AACvB,aAAO,GAAG,IAAI;AAAA,IAChB;AAAA,EACF;AACA,SAAO,OAAO,QAAQ,IAAI,QAAQ;AAClC,SAAO,OAAO,QAAQ,IAAI,QAAQ;AAClC,SAAO;AACT;AAEO,SAAS,WAAW,SAA2C;AACpE,SAAO,OAAO,SAAiB,OAAiB,CAAC,GAAG,UAAuB,CAAC,MAC1E,IAAI,QAAoB,CAAC,YAAY;AACnC,QAAI;AACJ,UAAM,QAAQ,MAAM,SAAS,MAAM;AAAA,MACjC,KAAK,QAAQ,OAAO,QAAQ;AAAA,MAC5B,KAAK;AAAA,QACH,GAAG,QAAQ,QAAQ,YAAY;AAAA,QAC/B,GAAI,QAAQ,OAAO,CAAC;AAAA,MACtB;AAAA,MACA,QAAQ,QAAQ;AAAA,IAClB,CAAC;AAED,QAAI,SAAS;AACb,QAAI,SAAS;AAEb,UAAM,OAAO,GAAG,QAAQ,CAAC,UAAU;AACjC,YAAM,OAAO,MAAM,SAAS;AAC5B,gBAAU;AACV,WAAK,QAAQ,IAAI,UAAU,IAAI;AAAA,IACjC,CAAC;AAED,UAAM,OAAO,GAAG,QAAQ,CAAC,UAAU;AACjC,YAAM,OAAO,MAAM,SAAS;AAC5B,gBAAU;AACV,WAAK,QAAQ,IAAI,UAAU,IAAI;AAAA,IACjC,CAAC;AAED,UAAM,GAAG,SAAS,CAAC,UAAU;AAC3B,mBAAa;AAAA,IACf,CAAC;AAED,UAAM,GAAG,SAAS,CAAC,UAAU,WAAW;AACtC,UAAI,WAAW,aAAa,WAAW,WAAW;AAChD,gBAAQ;AAAA,UACN,UAAU,YAAY;AAAA,UACtB;AAAA,UACA,QAAQ,GAAG,MAAM;AAAA,sBAAyB,MAAM,IAAI,KAAK;AAAA,QAC3D,CAAC;AACD;AAAA,MACF;AACA,cAAQ;AAAA,QACN,UAAU,YAAY;AAAA,QACtB;AAAA,QACA,QAAQ,aAAa,GAAG,MAAM;AAAA,EAAK,WAAW,OAAO,GAAG,KAAK,IAAI;AAAA,MACnE,CAAC;AAAA,IACH,CAAC;AAAA,EACH,CAAC;AACL;AAEO,SAAS,sBAAsB,SAIpC;AACA,MAAI;AAEJ,QAAM,OAA4B,OAAO,SAAS,OAAO,CAAC,GAAG,UAAU,CAAC,MACtE,IAAI,QAAoB,CAAC,YAAY;AACnC,QAAI;AACJ,UAAM,QAAQ,MAAM,SAAS,MAAM;AAAA,MACjC,KAAK,QAAQ,OAAO,QAAQ;AAAA,MAC5B,KAAK;AAAA,QACH,GAAG,QAAQ,QAAQ,YAAY;AAAA,QAC/B,GAAI,QAAQ,OAAO,CAAC;AAAA,MACtB;AAAA,MACA,QAAQ,QAAQ;AAAA,IAClB,CAAC;AACD,kBAAc;AAEd,QAAI,SAAS;AACb,QAAI,SAAS;AAEb,UAAM,OAAO,GAAG,QAAQ,CAAC,UAAU;AACjC,YAAM,OAAO,MAAM,SAAS;AAC5B,gBAAU;AACV,WAAK,QAAQ,IAAI,UAAU,IAAI;AAAA,IACjC,CAAC;AAED,UAAM,OAAO,GAAG,QAAQ,CAAC,UAAU;AACjC,YAAM,OAAO,MAAM,SAAS;AAC5B,gBAAU;AACV,WAAK,QAAQ,IAAI,UAAU,IAAI;AAAA,IACjC,CAAC;AAED,UAAM,GAAG,SAAS,CAAC,UAAU;AAC3B,mBAAa;AAAA,IACf,CAAC;AAED,UAAM,GAAG,SAAS,CAAC,UAAU,WAAW;AACtC,UAAI,gBAAgB,OAAO;AACzB,sBAAc;AAAA,MAChB;AACA,UAAI,WAAW,aAAa,WAAW,WAAW;AAChD,gBAAQ;AAAA,UACN,UAAU,YAAY;AAAA,UACtB;AAAA,UACA,QAAQ,GAAG,MAAM;AAAA,sBAAyB,MAAM,IAAI,KAAK;AAAA,QAC3D,CAAC;AACD;AAAA,MACF;AACA,cAAQ;AAAA,QACN,UAAU,YAAY;AAAA,QACtB;AAAA,QACA,QAAQ,aAAa,GAAG,MAAM;AAAA,EAAK,WAAW,OAAO,GAAG,KAAK,IAAI;AAAA,MACnE,CAAC;AAAA,IACH,CAAC;AAAA,EACH,CAAC;AAEH,QAAM,OAAO,CAAC,SAAyB,cAAoB;AACzD,QAAI,CAAC,eAAe,YAAY,OAAQ;AACxC,gBAAY,KAAK,MAAM;AACvB,QAAI,WAAW,WAAW;AACxB,YAAM,aAAa,WAAW,MAAM;AAClC,YAAI,eAAe,CAAC,YAAY,QAAQ;AACtC,sBAAY,KAAK,SAAS;AAAA,QAC5B;AAAA,MACF,GAAG,GAAI;AACP,iBAAW,MAAM;AAAA,IACnB;AAAA,EACF;AAEA,QAAM,aAAa,CAAC,SAAuB;AACzC,QAAI,eAAe,CAAC,YAAY,UAAU,YAAY,SAAS,CAAC,YAAY,MAAM,WAAW;AAC3F,kBAAY,MAAM,MAAM,IAAI;AAAA,IAC9B;AAAA,EACF;AAEA,SAAO,EAAE,MAAM,MAAM,WAAW;AAClC;AAEA,eAAsB,oBAAoB,kBAA0B,UAAqC;AACvG,QAAM,WAAW,KAAK,eAAe,GAAG,QAAQ;AAChD,QAAM,MAAM,UAAU,EAAE,WAAW,KAAK,CAAC;AACzC,SAAO;AACT;","names":[]}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@workplane/adapter-sdk",
+  "version": "0.3.1",
+  "private": false,
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MindStaq/workplane.git"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup"
+  }
+}