@eryx-org/eryx 0.0.0 → 0.15.1

package/interfaces/wasi-io-streams.d.ts

@@ -0,0 +1,51 @@
+/** @module Interface wasi:io/streams@0.2.0 **/
+export type Error = import('./wasi-io-error.js').Error;
+export type Pollable = import('./wasi-io-poll.js').Pollable;
+export type StreamError = StreamErrorLastOperationFailed | StreamErrorClosed;
+export interface StreamErrorLastOperationFailed {
+  tag: 'last-operation-failed',
+  val: Error,
+}
+export interface StreamErrorClosed {
+  tag: 'closed',
+}
+
+export class InputStream {
+  /**
+   * This type does not have a public constructor.
+   */
+  private constructor();
+  /**
+  * @throws {StreamError} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  read(len: bigint): Uint8Array;
+  /**
+  * @throws {StreamError} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  blockingRead(len: bigint): Uint8Array;
+  subscribe(): Pollable;
+}
+
+export class OutputStream {
+  /**
+   * This type does not have a public constructor.
+   */
+  private constructor();
+  /**
+  * @throws {StreamError} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  checkWrite(): bigint;
+  /**
+  * @throws {StreamError} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  write(contents: Uint8Array): void;
+  /**
+  * @throws {StreamError} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  blockingWriteAndFlush(contents: Uint8Array): void;
+  /**
+  * @throws {StreamError} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  blockingFlush(): void;
+  subscribe(): Pollable;
+}

package/interfaces/wasi-random-random.d.ts

@@ -0,0 +1,2 @@
+/** @module Interface wasi:random/random@0.2.0 **/
+export function getRandomBytes(len: bigint): Uint8Array;

package/interfaces/wasi-sockets-instance-network.d.ts

@@ -0,0 +1,3 @@
+/** @module Interface wasi:sockets/instance-network@0.2.0 **/
+export function instanceNetwork(): Network;
+export type Network = import('./wasi-sockets-network.js').Network;

package/interfaces/wasi-sockets-ip-name-lookup.d.ts

@@ -0,0 +1,21 @@
+/** @module Interface wasi:sockets/ip-name-lookup@0.2.0 **/
+/**
+ * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+ */
+export function resolveAddresses(network: Network, name: string): ResolveAddressStream;
+export type IpAddress = import('./wasi-sockets-network.js').IpAddress;
+export type ErrorCode = import('./wasi-sockets-network.js').ErrorCode;
+export type Pollable = import('./wasi-io-poll.js').Pollable;
+export type Network = import('./wasi-sockets-network.js').Network;
+
+export class ResolveAddressStream {
+  /**
+   * This type does not have a public constructor.
+   */
+  private constructor();
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  resolveNextAddress(): IpAddress | undefined;
+  subscribe(): Pollable;
+}

package/interfaces/wasi-sockets-network.d.ts

@@ -0,0 +1,92 @@
+/** @module Interface wasi:sockets/network@0.2.0 **/
+export type Ipv4Address = [number, number, number, number];
+export interface Ipv4SocketAddress {
+  port: number,
+  address: Ipv4Address,
+}
+export type Ipv6Address = [number, number, number, number, number, number, number, number];
+export interface Ipv6SocketAddress {
+  port: number,
+  flowInfo: number,
+  address: Ipv6Address,
+  scopeId: number,
+}
+export type IpSocketAddress = IpSocketAddressIpv4 | IpSocketAddressIpv6;
+export interface IpSocketAddressIpv4 {
+  tag: 'ipv4',
+  val: Ipv4SocketAddress,
+}
+export interface IpSocketAddressIpv6 {
+  tag: 'ipv6',
+  val: Ipv6SocketAddress,
+}
+/**
+ * # Variants
+ * 
+ * ## `"unknown"`
+ * 
+ * ## `"access-denied"`
+ * 
+ * ## `"not-supported"`
+ * 
+ * ## `"invalid-argument"`
+ * 
+ * ## `"out-of-memory"`
+ * 
+ * ## `"timeout"`
+ * 
+ * ## `"concurrency-conflict"`
+ * 
+ * ## `"not-in-progress"`
+ * 
+ * ## `"would-block"`
+ * 
+ * ## `"invalid-state"`
+ * 
+ * ## `"new-socket-limit"`
+ * 
+ * ## `"address-not-bindable"`
+ * 
+ * ## `"address-in-use"`
+ * 
+ * ## `"remote-unreachable"`
+ * 
+ * ## `"connection-refused"`
+ * 
+ * ## `"connection-reset"`
+ * 
+ * ## `"connection-aborted"`
+ * 
+ * ## `"datagram-too-large"`
+ * 
+ * ## `"name-unresolvable"`
+ * 
+ * ## `"temporary-resolver-failure"`
+ * 
+ * ## `"permanent-resolver-failure"`
+ */
+export type ErrorCode = "unknown" | "access-denied" | "not-supported" | "invalid-argument" | "out-of-memory" | "timeout" | "concurrency-conflict" | "not-in-progress" | "would-block" | "invalid-state" | "new-socket-limit" | "address-not-bindable" | "address-in-use" | "remote-unreachable" | "connection-refused" | "connection-reset" | "connection-aborted" | "datagram-too-large" | "name-unresolvable" | "temporary-resolver-failure" | "permanent-resolver-failure";
+export type IpAddress = IpAddressIpv4 | IpAddressIpv6;
+export interface IpAddressIpv4 {
+  tag: 'ipv4',
+  val: Ipv4Address,
+}
+export interface IpAddressIpv6 {
+  tag: 'ipv6',
+  val: Ipv6Address,
+}
+/**
+ * # Variants
+ * 
+ * ## `"ipv4"`
+ * 
+ * ## `"ipv6"`
+ */
+export type IpAddressFamily = "ipv4" | "ipv6";
+
+export class Network {
+  /**
+   * This type does not have a public constructor.
+   */
+  private constructor();
+}

package/interfaces/wasi-sockets-tcp-create-socket.d.ts

@@ -0,0 +1,8 @@
+/** @module Interface wasi:sockets/tcp-create-socket@0.2.0 **/
+/**
+ * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+ */
+export function createTcpSocket(addressFamily: IpAddressFamily): TcpSocket;
+export type IpAddressFamily = import('./wasi-sockets-network.js').IpAddressFamily;
+export type TcpSocket = import('./wasi-sockets-tcp.js').TcpSocket;
+export type ErrorCode = import('./wasi-sockets-network.js').ErrorCode;

package/interfaces/wasi-sockets-tcp.d.ts

@@ -0,0 +1,127 @@
+/** @module Interface wasi:sockets/tcp@0.2.0 **/
+export type Network = import('./wasi-sockets-network.js').Network;
+export type IpSocketAddress = import('./wasi-sockets-network.js').IpSocketAddress;
+export type ErrorCode = import('./wasi-sockets-network.js').ErrorCode;
+export type InputStream = import('./wasi-io-streams.js').InputStream;
+export type OutputStream = import('./wasi-io-streams.js').OutputStream;
+export type Duration = import('./wasi-clocks-monotonic-clock.js').Duration;
+export type Pollable = import('./wasi-io-poll.js').Pollable;
+/**
+ * # Variants
+ * 
+ * ## `"receive"`
+ * 
+ * ## `"send"`
+ * 
+ * ## `"both"`
+ */
+export type ShutdownType = "receive" | "send" | "both";
+
+export class TcpSocket {
+  /**
+   * This type does not have a public constructor.
+   */
+  private constructor();
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  startBind(network: Network, localAddress: IpSocketAddress): void;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  finishBind(): void;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  startConnect(network: Network, remoteAddress: IpSocketAddress): void;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  finishConnect(): [InputStream, OutputStream];
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  startListen(): void;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  finishListen(): void;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  accept(): [TcpSocket, InputStream, OutputStream];
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  localAddress(): IpSocketAddress;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  remoteAddress(): IpSocketAddress;
+  isListening(): boolean;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  setListenBacklogSize(value: bigint): void;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  keepAliveEnabled(): boolean;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  setKeepAliveEnabled(value: boolean): void;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  keepAliveIdleTime(): Duration;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  setKeepAliveIdleTime(value: Duration): void;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  keepAliveInterval(): Duration;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  setKeepAliveInterval(value: Duration): void;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  keepAliveCount(): number;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  setKeepAliveCount(value: number): void;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  hopLimit(): number;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  setHopLimit(value: number): void;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  receiveBufferSize(): bigint;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  setReceiveBufferSize(value: bigint): void;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  sendBufferSize(): bigint;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  setSendBufferSize(value: bigint): void;
+  subscribe(): Pollable;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  shutdown(shutdownType: ShutdownType): void;
+}

package/interfaces/wasi-sockets-udp-create-socket.d.ts

@@ -0,0 +1,8 @@
+/** @module Interface wasi:sockets/udp-create-socket@0.2.0 **/
+/**
+ * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+ */
+export function createUdpSocket(addressFamily: IpAddressFamily): UdpSocket;
+export type IpAddressFamily = import('./wasi-sockets-network.js').IpAddressFamily;
+export type UdpSocket = import('./wasi-sockets-udp.js').UdpSocket;
+export type ErrorCode = import('./wasi-sockets-network.js').ErrorCode;

package/interfaces/wasi-sockets-udp.d.ts

@@ -0,0 +1,93 @@
+/** @module Interface wasi:sockets/udp@0.2.0 **/
+export type Network = import('./wasi-sockets-network.js').Network;
+export type IpSocketAddress = import('./wasi-sockets-network.js').IpSocketAddress;
+export type ErrorCode = import('./wasi-sockets-network.js').ErrorCode;
+export type Pollable = import('./wasi-io-poll.js').Pollable;
+export interface IncomingDatagram {
+  data: Uint8Array,
+  remoteAddress: IpSocketAddress,
+}
+export interface OutgoingDatagram {
+  data: Uint8Array,
+  remoteAddress?: IpSocketAddress,
+}
+
+export class IncomingDatagramStream {
+  /**
+   * This type does not have a public constructor.
+   */
+  private constructor();
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  receive(maxResults: bigint): Array<IncomingDatagram>;
+  subscribe(): Pollable;
+}
+
+export class OutgoingDatagramStream {
+  /**
+   * This type does not have a public constructor.
+   */
+  private constructor();
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  checkSend(): bigint;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  send(datagrams: Array<OutgoingDatagram>): bigint;
+  subscribe(): Pollable;
+}
+
+export class UdpSocket {
+  /**
+   * This type does not have a public constructor.
+   */
+  private constructor();
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  startBind(network: Network, localAddress: IpSocketAddress): void;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  finishBind(): void;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  stream(remoteAddress: IpSocketAddress | undefined): [IncomingDatagramStream, OutgoingDatagramStream];
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  localAddress(): IpSocketAddress;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  remoteAddress(): IpSocketAddress;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  unicastHopLimit(): number;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  setUnicastHopLimit(value: number): void;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  receiveBufferSize(): bigint;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  setReceiveBufferSize(value: bigint): void;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  sendBufferSize(): bigint;
+  /**
+  * @throws {ErrorCode} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+  */
+  setSendBufferSize(value: bigint): void;
+  subscribe(): Pollable;
+}

package/package.json

@@ -1,12 +1,78 @@
 {
   "name": "@eryx-org/eryx",
-  "version": "0.0.0",
-  "description": "Placeholder for the first release of @eryx-org/eryx, formerly @bsull/eryx",
+  "type": "module",
+  "description": "A Python sandbox powered by WebAssembly, for browser and Node.js",
+  "version": "0.15.1",
   "license": "MIT OR Apache-2.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/eryx-org/eryx.git",
     "directory": "js/eryx"
   },
-  "files": ["README.md"]
+  "files": [
+    "interfaces/*",
+    "shims/*",
+    "*.wasm",
+    "*.js",
+    "*.d.ts",
+    "python-stdlib.tar.gz",
+    "README.md"
+  ],
+  "main": "index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    },
+    "./callbacks": {
+      "types": "./shims/callbacks.d.ts",
+      "default": "./shims/callbacks.js"
+    },
+    "./shims/net": {
+      "types": "./shims/net.d.ts",
+      "default": "./shims/net.js"
+    },
+    "./shims/sockets": {
+      "default": "./shims/sockets.js"
+    },
+    "./low-level": {
+      "types": "./eryx-sandbox.d.ts",
+      "default": "./eryx-sandbox.js"
+    }
+  },
+  "imports": {
+    "#preview2/cli": {
+      "node": "./shims/preview2-node.js",
+      "default": "@bytecodealliance/preview2-shim/cli"
+    },
+    "#preview2/clocks": {
+      "node": "./shims/preview2-node.js",
+      "default": "@bytecodealliance/preview2-shim/clocks"
+    },
+    "#preview2/filesystem": {
+      "node": "./shims/preview2-node.js",
+      "default": "@bytecodealliance/preview2-shim/filesystem"
+    },
+    "#preview2/io": {
+      "node": "./shims/preview2-node.js",
+      "default": "@bytecodealliance/preview2-shim/io"
+    },
+    "#preview2/random": {
+      "node": "./shims/preview2-node.js",
+      "default": "@bytecodealliance/preview2-shim/random"
+    }
+  },
+  "keywords": [
+    "python",
+    "sandbox",
+    "wasm",
+    "webassembly",
+    "component-model",
+    "interpreter"
+  ],
+  "dependencies": {
+    "@bytecodealliance/preview2-shim": "^0.31.0",
+    "@eryx-org/eryx-run": "^0.2.0"
+  }
 }

package/shims/callbacks.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Set the default handler for trace events from the Python runtime, for every
+ * Sandbox that wasn't given its own `traceHandler` option.
+ */
+export function setTraceHandler(
+  handler:
+    | ((lineno: number, eventJson: string, contextJson: string) => void)
+    | null,
+): void;
+
+/** Host-controlled behavior for a single execution. */
+export interface ExecutionOptions {
+  pythonTracing: boolean;
+  reuseEmptyCallbacks: boolean;
+}
+
+/** Return the default sandbox host's execution behavior. */
+export function getExecutionOptions(): ExecutionOptions;
+
+/**
+ * Set the default handler for streaming output (stdout/stderr) from the Python
+ * runtime, for every Sandbox that wasn't given its own `outputHandler` option.
+ *
+ * The handler is called in real-time as Python code writes to stdout or stderr,
+ * rather than waiting for execution to complete.
+ *
+ * @param handler - stream: 0 = stdout, 1 = stderr; data: the text written
+ */
+export function setOutputHandler(
+  handler: ((stream: number, data: string) => void) | null,
+): void;
+
+/**
+ * Thrown by a callback handler to suspend execution ("retry later").
+ *
+ * The guest halts immediately. Under `executeWithJournal()` the suspension is
+ * surfaced as `outcome.suspended` and the call is not journaled, so it re-runs
+ * live when the recorded journal is replayed. Under plain `execute()` it
+ * rejects like any other error.
+ */
+export class SuspendCallback extends Error {
+  constructor(reason: string);
+  /** Opaque reason, surfaced as `outcome.suspended.reason`. */
+  readonly reason: string;
+}