@capsule-run/sdk 0.4.1 → 0.5.0

package/src/task.ts

@@ -25,13 +25,30 @@ export interface TaskOptions {
   maxRetries?: number;
   /** Files/folders accessible in the sandbox, e.g., ["./data"] */
   allowedFiles?: string[];
+  /** Environment variables available from your .env file for the task */
+  envVariables?: string[];
 }
 
-interface TaskResult {
-  result?: any;
-  error?: string;
+interface TaskResult<T> {
+  success: boolean;
+  result: T;
+  error: string | null;
+  execution: TaskExecution;
 }
 
+interface TaskExecution {
+    task_name: string;
+    duration_ms: number;
+    retries: number;
+    fuel_consumed: number;
+}
+
+type Awaited<T> = T extends Promise<infer U> ? U : T;
+
+type TaskReturnType<T> = T extends Promise<infer U>
+  ? Promise<TaskResult<U>>
+  : TaskResult<T>;
+
 /**
  * Define a Capsule task with configuration.
  *
@@ -80,7 +97,7 @@ function normalizeTimeout(timeout?: string | number): string | undefined {
 export function task<TArgs extends any[], TReturn>(
   options: TaskOptions,
   fn: (...args: TArgs) => TReturn
-): (...args: TArgs) => TReturn {
+): (...args: TArgs) => TaskReturnType<TReturn> {
   const taskName = options.name;
   let compute = options.compute?.toString().toUpperCase() ?? "MEDIUM";
 
@@ -91,21 +108,48 @@ export function task<TArgs extends any[], TReturn>(
     timeout: normalizeTimeout(options.timeout),
     maxRetries: options.maxRetries,
     allowedFiles: options.allowedFiles,
+    envVariables: options.envVariables,
   };
 
-  const wrapper = (...args: TArgs): TReturn => {
+  const wrapper = (...args: TArgs): TaskReturnType<TReturn> => {
     if (!isWasmMode()) {
-      return fn(...args);
+      const result = fn(...args);
+
+      if (result instanceof Promise) {
+        return result.then((value) => ({
+          success: true,
+          result: value,
+          error: null,
+          execution: {
+            task_name: taskName,
+            duration_ms: 0,
+            retries: 0,
+            fuel_consumed: 0,
+          },
+        })) as TaskReturnType<TReturn>;
+      }
+
+      return {
+        success: true,
+        result,
+        error: null,
+        execution: {
+          task_name: taskName,
+          duration_ms: 0,
+          retries: 0,
+          fuel_consumed: 0,
+        },
+      } as TaskReturnType<TReturn>;
     }
 
     const resultJson = callHost(taskName, args, taskConfig);
 
     try {
-      const result: TaskResult = JSON.parse(resultJson);
-      return result as TReturn;
+      const result: TaskResult<Awaited<TReturn>> = JSON.parse(resultJson);
+      return result as TaskReturnType<TReturn>;
     } catch (e) {
       if (e instanceof SyntaxError) {
-        return resultJson as unknown as TReturn;
+        return resultJson as unknown as TaskReturnType<TReturn>;
       }
       throw e;
     }

package/dist/files.d.ts

@@ -1,46 +0,0 @@
-/**
- * Capsule Files API for WASM filesystem access.
- */
-/**
- * Read a file as text.
- *
- * @param path - The path to read.
- * @returns A promise that resolves to a string containing the file contents.
- */
-export declare function readText(path: string): Promise<string>;
-/**
- * Read a file as bytes.
- *
- * @param path - The path to read.
- * @returns A promise that resolves to a Uint8Array containing the file contents.
- */
-export declare function readBytes(path: string): Promise<Uint8Array>;
-/**
- * Write text content to a file.
- *
- * @param path - The path to write.
- * @param content - The text content to write.
- */
-export declare function writeText(path: string, content: string): Promise<void>;
-/**
- * Write bytes to a file.
- *
- * @param path - The path to write.
- * @param data - The bytes to write.
- */
-export declare function writeBytes(path: string, data: Uint8Array): Promise<void>;
-/**
- * List files/directories at a path.
- *
- * @param path - The path to list.
- * @returns A promise that resolves to an array of strings representing the files and directories at the specified path.
- */
-export declare function list(path?: string): Promise<string[]>;
-/**
- * Check if a file or directory exists.
- *
- * @param path - The path to check.
- * @returns A promise that resolves to a boolean indicating whether the file or directory exists.
- */
-export declare function exists(path: string): Promise<boolean>;
-//# sourceMappingURL=files.d.ts.map

package/dist/files.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":"AAAA;;GAEG;AAoFH;;;;;GAKG;AACH,wBAAsB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAG5D;AAED;;;;;GAKG;AACH,wBAAsB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAkBjE;AAED;;;;;GAKG;AACH,wBAAsB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG5E;AAED;;;;;GAKG;AACH,wBAAsB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAgB9E;AAED;;;;;GAKG;AACH,wBAAsB,IAAI,CAAC,IAAI,GAAE,MAAY,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CA6BhE;AAED;;;;;GAKG;AACH,wBAAsB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAe3D"}

package/dist/files.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"files.js","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":"AAAA;;GAEG;AAyBH,SAAS,aAAa;IACpB,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,UAAU,CAAC,uBAAuB,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,UAAU,CAAC,0BAA0B,CAAC,CAAC;QACxD,IAAI,KAAK,IAAI,QAAQ,EAAE,CAAC;YACtB,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;QAC7B,CAAC;IACH,CAAC;IAAC,MAAM,CAAC,CAAA,CAAC;IACV,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,gBAAgB;IACvB,MAAM,EAAE,GAAG,aAAa,EAAE,CAAC;IAC3B,IAAI,CAAC,EAAE;QAAE,OAAO,EAAE,CAAC;IAEnB,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;QAC1C,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAA2B,EAAE,EAAE,CAAC,CAAC;YACxD,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC;YACpB,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;SACpB,CAAC,CAAC,CAAC;IACN,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,IAAY;IACjC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,WAAW,CAAC,IAAY;IAC/B,MAAM,QAAQ,GAAG,gBAAgB,EAAE,CAAC;IACpC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAEvC,MAAM,cAAc,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IAE3C,KAAK,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,QAAQ,EAAE,CAAC;QACjD,MAAM,eAAe,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;QAEjD,IAAI,eAAe,KAAK,GAAG,IAAI,eAAe,KAAK,EAAE,EAAE,CAAC;YACtD,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC;QAC3D,CAAC;QAED,IAAI,cAAc,CAAC,UAAU,CAAC,eAAe,GAAG,GAAG,CAAC,EAAE,CAAC;YACrD,MAAM,YAAY,GAAG,cAAc,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACtE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC;QAC3C,CAAC;QAED,IAAI,cAAc,KAAK,eAAe,EAAE,CAAC;YACvC,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC;QAChD,CAAC;IACH,CAAC;IAED,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC;AACvE,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,IAAY;IACzC,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,CAAC;IACpC,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACzC,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,IAAY;IAC1C,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;QAC3C,MAAM,SAAS,GAAG,EAAE,CAAC;QACrB,MAAM,eAAe,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QAEvC,MAAM,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,YAAY,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;QAC7F,MAAM,IAAI,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC;QACvB,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,wBAAwB,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC;IACzD,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,IAAY,EAAE,OAAe;IAC3D,MAAM,KAAK,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAChD,MAAM,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAChC,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,IAAY,EAAE,IAAgB;IAC7D,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;QAC3C,MAAM,SAAS,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QACnD,MAAM,eAAe,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAExC,MAAM,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,YAAY,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;QAC7F,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5B,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,yBAAyB,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC;IAC1D,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,OAAe,GAAG;IAC3C,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAED,IAAI,CAAC;QACH,IAAI,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC;QAC7B,IAAI,QAAQ,CAAC,YAAY,KAAK,GAAG,EAAE,CAAC;YAClC,MAAM,SAAS,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;YAC3C,MAAM,SAAS,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;YACtC,MAAM,eAAe,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;YACvC,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,YAAY,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;QAChG,CAAC;QAED,MAAM,MAAM,GAAG,SAAS,CAAC,aAAa,EAAE,CAAC;QACzC,MAAM,OAAO,GAAa,EAAE,CAAC;QAE7B,IAAI,KAAK,CAAC;QACV,OAAO,CAAC,KAAK,GAAG,MAAM,CAAC,kBAAkB,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC;YACtD,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;gBACf,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC;IAC9D,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,IAAY;IACvC,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;QAC3C,MAAM,SAAS,GAAG,EAAE,CAAC;QACrB,MAAM,eAAe,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QACvC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,YAAY,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;QAClF,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC"}

package/src/files.ts

@@ -1,217 +0,0 @@
-/**
- * Capsule Files API for WASM filesystem access.
- */
-
-declare const globalThis: {
-  'wasi:filesystem/types': any;
-  'wasi:filesystem/preopens': any;
-};
-
-interface Descriptor {
-  read(length: bigint, offset: bigint): [Uint8Array, boolean];
-  write(buffer: Uint8Array, offset: bigint): bigint;
-  stat(): { size: bigint };
-  readDirectory(): any;
-  openAt(
-    pathFlags: { symlinkFollow?: boolean },
-    path: string,
-    openFlags: { create?: boolean; directory?: boolean; exclusive?: boolean; truncate?: boolean },
-    descriptorFlags: { read?: boolean; write?: boolean; mutateDirectory?: boolean }
-  ): Descriptor;
-}
-
-interface PreopenedDir {
-  descriptor: Descriptor;
-  guestPath: string;
-}
-
-function getFsBindings(): { types: any; preopens: any } | null {
-  try {
-    const types = globalThis['wasi:filesystem/types'];
-    const preopens = globalThis['wasi:filesystem/preopens'];
-    if (types && preopens) {
-      return { types, preopens };
-    }
-  } catch {}
-  return null;
-}
-
-function getPreopenedDirs(): PreopenedDir[] {
-  const fs = getFsBindings();
-  if (!fs) return [];
-
-  try {
-    const dirs = fs.preopens.getDirectories();
-    return (dirs || []).map((entry: [Descriptor, string]) => ({
-      descriptor: entry[0],
-      guestPath: entry[1]
-    }));
-  } catch {
-    return [];
-  }
-}
-
-function normalizePath(path: string): string {
-  if (path.startsWith('./')) {
-    return path.slice(2);
-  }
-  return path;
-}
-
-function resolvePath(path: string): { dir: Descriptor; relativePath: string } | null {
-  const preopens = getPreopenedDirs();
-  if (preopens.length === 0) return null;
-
-  const normalizedPath = normalizePath(path);
-
-  for (const { descriptor, guestPath } of preopens) {
-    const normalizedGuest = normalizePath(guestPath);
-
-    if (normalizedGuest === '.' || normalizedGuest === '') {
-      return { dir: descriptor, relativePath: normalizedPath };
-    }
-
-    if (normalizedPath.startsWith(normalizedGuest + '/')) {
-      const relativePath = normalizedPath.slice(normalizedGuest.length + 1);
-      return { dir: descriptor, relativePath };
-    }
-
-    if (normalizedPath === normalizedGuest) {
-      return { dir: descriptor, relativePath: '.' };
-    }
-  }
-
-  return { dir: preopens[0].descriptor, relativePath: normalizedPath };
-}
-
-/**
- * Read a file as text.
- *
- * @param path - The path to read.
- * @returns A promise that resolves to a string containing the file contents.
- */
-export async function readText(path: string): Promise<string> {
-  const bytes = await readBytes(path);
-  return new TextDecoder().decode(bytes);
-}
-
-/**
- * Read a file as bytes.
- *
- * @param path - The path to read.
- * @returns A promise that resolves to a Uint8Array containing the file contents.
- */
-export async function readBytes(path: string): Promise<Uint8Array> {
-  const resolved = resolvePath(path);
-  if (!resolved) {
-    throw new Error("Filesystem not available.");
-  }
-
-  try {
-    const pathFlags = { symlinkFollow: false };
-    const openFlags = {};
-    const descriptorFlags = { read: true };
-
-    const fd = resolved.dir.openAt(pathFlags, resolved.relativePath, openFlags, descriptorFlags);
-    const stat = fd.stat();
-    const [data] = fd.read(stat.size, BigInt(0));
-    return data;
-  } catch (e) {
-    throw new Error(`Failed to read file '${path}': ${e}`);
-  }
-}
-
-/**
- * Write text content to a file.
- *
- * @param path - The path to write.
- * @param content - The text content to write.
- */
-export async function writeText(path: string, content: string): Promise<void> {
-  const bytes = new TextEncoder().encode(content);
-  await writeBytes(path, bytes);
-}
-
-/**
- * Write bytes to a file.
- *
- * @param path - The path to write.
- * @param data - The bytes to write.
- */
-export async function writeBytes(path: string, data: Uint8Array): Promise<void> {
-  const resolved = resolvePath(path);
-  if (!resolved) {
-    throw new Error("Filesystem not available.");
-  }
-
-  try {
-    const pathFlags = { symlinkFollow: false };
-    const openFlags = { create: true, truncate: true };
-    const descriptorFlags = { write: true };
-
-    const fd = resolved.dir.openAt(pathFlags, resolved.relativePath, openFlags, descriptorFlags);
-    fd.write(data, BigInt(0));
-  } catch (e) {
-    throw new Error(`Failed to write file '${path}': ${e}`);
-  }
-}
-
-/**
- * List files/directories at a path.
- *
- * @param path - The path to list.
- * @returns A promise that resolves to an array of strings representing the files and directories at the specified path.
- */
-export async function list(path: string = "."): Promise<string[]> {
-  const resolved = resolvePath(path);
-  if (!resolved) {
-    throw new Error("Filesystem not available.");
-  }
-
-  try {
-    let targetDir = resolved.dir;
-    if (resolved.relativePath !== ".") {
-      const pathFlags = { symlinkFollow: false };
-      const openFlags = { directory: true };
-      const descriptorFlags = { read: true };
-      targetDir = resolved.dir.openAt(pathFlags, resolved.relativePath, openFlags, descriptorFlags);
-    }
-
-    const stream = targetDir.readDirectory();
-    const entries: string[] = [];
-
-    let entry;
-    while ((entry = stream.readDirectoryEntry()) && entry) {
-      if (entry.name) {
-        entries.push(entry.name);
-      }
-    }
-
-    return entries;
-  } catch (e) {
-    throw new Error(`Failed to list directory '${path}': ${e}`);
-  }
-}
-
-/**
- * Check if a file or directory exists.
- *
- * @param path - The path to check.
- * @returns A promise that resolves to a boolean indicating whether the file or directory exists.
- */
-export async function exists(path: string): Promise<boolean> {
-  const resolved = resolvePath(path);
-  if (!resolved) {
-    return false;
-  }
-
-  try {
-    const pathFlags = { symlinkFollow: false };
-    const openFlags = {};
-    const descriptorFlags = { read: true };
-    resolved.dir.openAt(pathFlags, resolved.relativePath, openFlags, descriptorFlags);
-    return true;
-  } catch {
-    return false;
-  }
-}