@bytecodealliance/preview2-shim 0.0.21 → 0.14.1

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

@@ -1,31 +1,21 @@
 export namespace WasiIoStreams {
-  /**
-   * Returns a string that's suitable to assist humans in debugging this
-   * error.
-   * 
-   * The returned string will change across platforms and hosts which
-   * means that parsing it, for example, would be a
-   * platform-compatibility hazard.
-   */
-  export { Error };
   /**
    * Perform a non-blocking read from the stream.
    * 
-   * This function returns a list of bytes containing the data that was
-   * read, along with a `stream-status` which, indicates whether further
-   * reads are expected to produce data. The returned list will contain up to
-   * `len` bytes; it may return fewer than requested, but not more. An
-   * empty list and `stream-status:open` indicates no more data is
-   * available at this time, and that the pollable given by `subscribe`
-   * will be ready when more data is available.
+   * This function returns a list of bytes containing the read data,
+   * when successful. The returned list will contain up to `len` bytes;
+   * it may return fewer than requested, but not more. The list is
+   * empty when no bytes are available for reading at this time. The
+   * pollable given by `subscribe` will be ready when more bytes are
+   * available.
    * 
-   * Once a stream has reached the end, subsequent calls to `read` or
-   * `skip` will always report `stream-status:ended` rather than producing more
-   * data.
+   * This function fails with a `stream-error` when the operation
+   * encounters an error, giving `last-operation-failed`, or when the
+   * stream is closed, giving `closed`.
    * 
-   * When the caller gives a `len` of 0, it represents a request to read 0
-   * bytes. This read should  always succeed and return an empty list and
-   * the current `stream-status`.
+   * When the caller gives a `len` of 0, it represents a request to
+   * read 0 bytes. If the stream is still open, this call should
+   * succeed and return an empty list, or otherwise fail with `closed`.
    * 
    * The `len` parameter is a `u64`, which could represent a list of u8 which
    * is not possible to allocate in wasm32, or not desirable to allocate as
@@ -35,21 +25,13 @@ export namespace WasiIoStreams {
   export { InputStream };
   /**
    * Read bytes from a stream, after blocking until at least one byte can
-   * be read. Except for blocking, identical to `read`.
+   * be read. Except for blocking, behavior is identical to `read`.
    */
   /**
-   * Skip bytes from a stream.
-   * 
-   * This is similar to the `read` function, but avoids copying the
-   * bytes into the instance.
-   * 
-   * Once a stream has reached the end, subsequent calls to read or
-   * `skip` will always report end-of-stream rather than producing more
-   * data.
+   * Skip bytes from a stream. Returns number of bytes skipped.
    * 
-   * This function returns the number of bytes skipped, along with a
-   * `stream-status` indicating whether the end of the stream was
-   * reached. The returned value will be at most `len`; it may be less.
+   * Behaves identical to `read`, except instead of returning a list
+   * of bytes, returns the number of bytes consumed from the stream.
    */
   /**
    * Skip bytes from a stream, after blocking until at least one byte
@@ -195,6 +177,8 @@ export namespace WasiIoStreams {
        * is ready for reading, before performing the `splice`.
        */
     }
+    import type { Error } from '../interfaces/wasi-io-error.js';
+    export { Error };
     import type { Pollable } from '../interfaces/wasi-io-poll.js';
     export { Pollable };
     /**
@@ -219,6 +203,14 @@ export namespace WasiIoStreams {
       tag: 'closed',
     }
     
+    export class InputStream {
+      read(len: bigint): Uint8Array;
+      blockingRead(len: bigint): Uint8Array;
+      skip(len: bigint): bigint;
+      blockingSkip(len: bigint): bigint;
+      subscribe(): Pollable;
+    }
+    
     export class OutputStream {
       checkWrite(): bigint;
       write(contents: Uint8Array): void;
@@ -231,16 +223,4 @@ export namespace WasiIoStreams {
       splice(src: InputStream, len: bigint): bigint;
       blockingSplice(src: InputStream, len: bigint): bigint;
     }
-    
-    export class Error {
-      toDebugString(): string;
-    }
-    
-    export class InputStream {
-      read(len: bigint): Uint8Array;
-      blockingRead(len: bigint): Uint8Array;
-      skip(len: bigint): bigint;
-      blockingSkip(len: bigint): bigint;
-      subscribe(): Pollable;
-    }
     

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

@@ -2,28 +2,18 @@ export namespace WasiSocketsIpNameLookup {
   /**
    * Resolve an internet host name to a list of IP addresses.
    * 
-   * See the wasi-socket proposal README.md for a comparison with getaddrinfo.
-   * 
-   * # Parameters
-   * - `name`: The name to look up. IP addresses are not allowed. Unicode domain names are automatically converted
-   * to ASCII using IDNA encoding.
-   * - `address-family`: If provided, limit the results to addresses of this specific address family.
-   * - `include-unavailable`: When set to true, this function will also return addresses of which the runtime
-   * thinks (or knows) can't be connected to at the moment. For example, this will return IPv6 addresses on
-   * systems without an active IPv6 interface. Notes:
-   * - Even when no public IPv6 interfaces are present or active, names like "localhost" can still resolve to an IPv6 address.
-   * - Whatever is "available" or "unavailable" is volatile and can change everytime a network cable is unplugged.
+   * Unicode domain names are automatically converted to ASCII using IDNA encoding.
+   * If the input is an IP address string, the address is parsed and returned
+   * as-is without making any external requests.
    * 
-   * This function never blocks. It either immediately fails or immediately returns successfully with a `resolve-address-stream`
-   * that can be used to (asynchronously) fetch the results.
+   * See the wasi-socket proposal README.md for a comparison with getaddrinfo.
    * 
-   * At the moment, the stream never completes successfully with 0 items. Ie. the first call
-   * to `resolve-next-address` never returns `ok(none)`. This may change in the future.
+   * This function never blocks. It either immediately fails or immediately
+   * returns successfully with a `resolve-address-stream` that can be used
+   * to (asynchronously) fetch the results.
    * 
    * # Typical errors
-   * - `invalid-argument`:     `name` is a syntactically invalid domain name.
-   * - `invalid-argument`:     `name` is an IP address.
-   * - `not-supported`:        The specified `address-family` is not supported. (EAI_FAMILY)
+   * - `invalid-argument`: `name` is a syntactically invalid domain name or IP address.
    * 
    * # References:
    * - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getaddrinfo.html>
@@ -31,7 +21,7 @@ export namespace WasiSocketsIpNameLookup {
    * - <https://learn.microsoft.com/en-us/windows/win32/api/ws2tcpip/nf-ws2tcpip-getaddrinfo>
    * - <https://man.freebsd.org/cgi/man.cgi?query=getaddrinfo&sektion=3>
    */
-  export function resolveAddresses(network: Network, name: string, addressFamily: IpAddressFamily | undefined, includeUnavailable: boolean): ResolveAddressStream;
+  export function resolveAddresses(network: Network, name: string): ResolveAddressStream;
   /**
    * Returns the next address from the resolver.
    * 
@@ -63,8 +53,6 @@ import type { ErrorCode } from '../interfaces/wasi-sockets-network.js';
 export { ErrorCode };
 import type { IpAddress } from '../interfaces/wasi-sockets-network.js';
 export { IpAddress };
-import type { IpAddressFamily } from '../interfaces/wasi-sockets-network.js';
-export { IpAddressFamily };
 
 export class ResolveAddressStream {
   resolveNextAddress(): IpAddress | undefined;

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

@@ -1,4 +1,5 @@
 export namespace WasiSocketsNetwork {
+  export { Network };
 }
 /**
  * Error codes.
@@ -136,3 +137,6 @@ export interface IpSocketAddressIpv6 {
   tag: 'ipv6',
   val: Ipv6SocketAddress,
 }
+
+export class Network {
+}

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

@@ -63,7 +63,7 @@ export namespace WasiSocketsTcp {
    * - `connection-refused`:        The connection was forcefully rejected. (ECONNREFUSED)
    * - `connection-reset`:          The connection was reset. (ECONNRESET)
    * - `connection-aborted`:        The connection was aborted. (ECONNABORTED)
-   * - `remote-unreachable`:        The remote address is not reachable. (EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN)
+   * - `remote-unreachable`:        The remote address is not reachable. (EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN, ENONET)
    * - `address-in-use`:            Tried to perform an implicit bind, but there were no ephemeral ports available. (EADDRINUSE, EADDRNOTAVAIL on Linux, EAGAIN on BSD)
    * - `not-in-progress`:           A `connect` operation is not in progress.
    * - `would-block`:               Can't finish the operation, it is still in progress. (EWOULDBLOCK, EAGAIN)
@@ -105,9 +105,11 @@ export namespace WasiSocketsTcp {
    * The returned socket is bound and in the Connection state. The following properties are inherited from the listener socket:
    * - `address-family`
    * - `ipv6-only`
-   * - `keep-alive`
-   * - `no-delay`
-   * - `unicast-hop-limit`
+   * - `keep-alive-enabled`
+   * - `keep-alive-idle-time`
+   * - `keep-alive-interval`
+   * - `keep-alive-count`
+   * - `hop-limit`
    * - `receive-buffer-size`
    * - `send-buffer-size`
    * 
@@ -156,6 +158,11 @@ export namespace WasiSocketsTcp {
    * - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getpeername>
    * - <https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2&n=1>
    */
+  /**
+   * Whether the socket is listening for new connections.
+   * 
+   * Equivalent to the SO_ACCEPTCONN socket option.
+   */
   /**
    * Whether this is a IPv4 or IPv6 socket.
    * 
@@ -174,21 +181,66 @@ export namespace WasiSocketsTcp {
   /**
    * Hints the desired listen queue size. Implementations are free to ignore this.
    * 
+   * If the provided value is 0, an `invalid-argument` error is returned.
+   * Any other value will never cause an error, but it might be silently clamped and/or rounded.
+   * 
    * # Typical errors
    * - `not-supported`:        (set) The platform does not support changing the backlog size after the initial listen.
+   * - `invalid-argument`:     (set) The provided value was 0.
    * - `invalid-state`:        (set) The socket is already in the Connection state.
    */
   /**
+   * Enables or disables keepalive.
+   * 
+   * The keepalive behavior can be adjusted using:
+   * - `keep-alive-idle-time`
+   * - `keep-alive-interval`
+   * - `keep-alive-count`
+   * These properties can be configured while `keep-alive-enabled` is false, but only come into effect when `keep-alive-enabled` is true.
+   * 
    * Equivalent to the SO_KEEPALIVE socket option.
    */
   /**
-   * Equivalent to the TCP_NODELAY socket option.
+   * Amount of time the connection has to be idle before TCP starts sending keepalive packets.
    * 
-   * The default value is `false`.
+   * If the provided value is 0, an `invalid-argument` error is returned.
+   * Any other value will never cause an error, but it might be silently clamped and/or rounded.
+   * I.e. after setting a value, reading the same setting back may return a different value.
+   * 
+   * Equivalent to the TCP_KEEPIDLE socket option. (TCP_KEEPALIVE on MacOS)
+   * 
+   * # Typical errors
+   * - `invalid-argument`:     (set) The provided value was 0.
+   */
+  /**
+   * The time between keepalive packets.
+   * 
+   * If the provided value is 0, an `invalid-argument` error is returned.
+   * Any other value will never cause an error, but it might be silently clamped and/or rounded.
+   * I.e. after setting a value, reading the same setting back may return a different value.
+   * 
+   * Equivalent to the TCP_KEEPINTVL socket option.
+   * 
+   * # Typical errors
+   * - `invalid-argument`:     (set) The provided value was 0.
+   */
+  /**
+   * The maximum amount of keepalive packets TCP should send before aborting the connection.
+   * 
+   * If the provided value is 0, an `invalid-argument` error is returned.
+   * Any other value will never cause an error, but it might be silently clamped and/or rounded.
+   * I.e. after setting a value, reading the same setting back may return a different value.
+   * 
+   * Equivalent to the TCP_KEEPCNT socket option.
+   * 
+   * # Typical errors
+   * - `invalid-argument`:     (set) The provided value was 0.
    */
   /**
    * Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
    * 
+   * If the provided value is 0, an `invalid-argument` error is returned.
+   * 
    * # Typical errors
    * - `invalid-argument`:     (set) The TTL value must be 1 or higher.
    * - `invalid-state`:        (set) The socket is already in the Connection state.
@@ -197,16 +249,14 @@ export namespace WasiSocketsTcp {
   /**
    * The kernel buffer space reserved for sends/receives on this socket.
    * 
-   * Note #1: an implementation may choose to cap or round the buffer size when setting the value.
-   * In other words, after setting a value, reading the same setting back may return a different value.
-   * 
-   * Note #2: there is not necessarily a direct relationship between the kernel buffer size and the bytes of
-   * actual data to be sent/received by the application, because the kernel might also use the buffer space
-   * for internal metadata structures.
+   * If the provided value is 0, an `invalid-argument` error is returned.
+   * Any other value will never cause an error, but it might be silently clamped and/or rounded.
+   * I.e. after setting a value, reading the same setting back may return a different value.
    * 
    * Equivalent to the SO_RCVBUF and SO_SNDBUF socket options.
    * 
    * # Typical errors
+   * - `invalid-argument`:     (set) The provided value was 0.
    * - `invalid-state`:        (set) The socket is already in the Connection state.
    * - `invalid-state`:        (set) The socket is already in the Listener state.
    */
@@ -244,6 +294,8 @@ import type { OutputStream } from '../interfaces/wasi-io-streams.js';
 export { OutputStream };
 import type { Pollable } from '../interfaces/wasi-io-poll.js';
 export { Pollable };
+import type { Duration } from '../interfaces/wasi-clocks-monotonic-clock.js';
+export { Duration };
 import type { Network } from '../interfaces/wasi-sockets-network.js';
 export { Network };
 import type { ErrorCode } from '../interfaces/wasi-sockets-network.js';
@@ -277,16 +329,21 @@ export class TcpSocket {
   accept(): [TcpSocket, InputStream, OutputStream];
   localAddress(): IpSocketAddress;
   remoteAddress(): IpSocketAddress;
+  isListening(): boolean;
   addressFamily(): IpAddressFamily;
   ipv6Only(): boolean;
   setIpv6Only(value: boolean): void;
   setListenBacklogSize(value: bigint): void;
-  keepAlive(): boolean;
-  setKeepAlive(value: boolean): void;
-  noDelay(): boolean;
-  setNoDelay(value: boolean): void;
-  unicastHopLimit(): number;
-  setUnicastHopLimit(value: number): void;
+  keepAliveEnabled(): boolean;
+  setKeepAliveEnabled(value: boolean): void;
+  keepAliveIdleTime(): Duration;
+  setKeepAliveIdleTime(value: Duration): void;
+  keepAliveInterval(): Duration;
+  setKeepAliveInterval(value: Duration): void;
+  keepAliveCount(): number;
+  setKeepAliveCount(value: number): void;
+  hopLimit(): number;
+  setHopLimit(value: number): void;
   receiveBufferSize(): bigint;
   setReceiveBufferSize(value: bigint): void;
   sendBufferSize(): bigint;

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

@@ -5,7 +5,7 @@ export namespace WasiSocketsUdpCreateSocket {
    * Similar to `socket(AF_INET or AF_INET6, SOCK_DGRAM, IPPROTO_UDP)` in POSIX.
    * 
    * This function does not require a network capability handle. This is considered to be safe because
-   * at time of creation, the socket is not bound to any `network` yet. Up to the moment `bind`/`connect` is called,
+   * at time of creation, the socket is not bound to any `network` yet. Up to the moment `bind` is called,
    * the socket is effectively an in-memory configuration object, unable to communicate with the outside world.
    * 
    * All sockets are non-blocking. Use the wasi-poll interface to block on asynchronous operations.