@bytecodealliance/preview2-shim 0.0.13 → 0.0.14

package/types/imports/wasi-sockets-udp.d.ts

@@ -0,0 +1,228 @@
+export namespace WasiSocketsUdp {
+  /**
+   * Bind the socket to a specific network on the provided IP address and port.
+   * 
+   * If the IP address is zero (`0.0.0.0` in IPv4, `::` in IPv6), it is left to the implementation to decide which
+   * network interface(s) to bind to.
+   * If the TCP/UDP port is zero, the socket will be bound to a random free port.
+   * 
+   * When a socket is not explicitly bound, the first invocation to connect will implicitly bind the socket.
+   * 
+   * Unlike in POSIX, this function is async. This enables interactive WASI hosts to inject permission prompts.
+   * 
+   * # Typical `start` errors
+   * - `address-family-mismatch`:   The `local-address` has the wrong address family. (EINVAL)
+   * - `already-bound`:             The socket is already bound. (EINVAL)
+   * - `concurrency-conflict`:      Another `bind` or `connect` operation is already in progress. (EALREADY)
+   * 
+   * # Typical `finish` errors
+   * - `ephemeral-ports-exhausted`: No ephemeral ports available. (EADDRINUSE, ENOBUFS on Windows)
+   * - `address-in-use`:            Address is already in use. (EADDRINUSE)
+   * - `address-not-bindable`:      `local-address` is not an address that the `network` can bind to. (EADDRNOTAVAIL)
+   * - `not-in-progress`:           A `bind` operation is not in progress.
+   * - `would-block`:               Can't finish the operation, it is still in progress. (EWOULDBLOCK, EAGAIN)
+   * 
+   * # References
+   * - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html>
+   * - <https://man7.org/linux/man-pages/man2/bind.2.html>
+   * - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-bind>
+   * - <https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2&format=html>
+   */
+  export function startBind(this_: UdpSocket, network: Network, localAddress: IpSocketAddress): void;
+  export function finishBind(this_: UdpSocket): void;
+  /**
+   * Set the destination address.
+   * 
+   * The local-address is updated based on the best network path to `remote-address`.
+   * 
+   * When a destination address is set:
+   * - all receive operations will only return datagrams sent from the provided `remote-address`.
+   * - the `send` function can only be used to send to this destination.
+   * 
+   * Note that this function does not generate any network traffic and the peer is not aware of this "connection".
+   * 
+   * Unlike in POSIX, this function is async. This enables interactive WASI hosts to inject permission prompts.
+   * 
+   * # Typical `start` errors
+   * - `address-family-mismatch`:   The `remote-address` has the wrong address family. (EAFNOSUPPORT)
+   * - `invalid-remote-address`:    The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EDESTADDRREQ, EADDRNOTAVAIL)
+   * - `invalid-remote-address`:    The port in `remote-address` is set to 0. (EDESTADDRREQ, EADDRNOTAVAIL)
+   * - `already-attached`:          The socket is already bound to a different network. The `network` passed to `connect` must be identical to the one passed to `bind`.
+   * - `concurrency-conflict`:      Another `bind` or `connect` operation is already in progress. (EALREADY)
+   * 
+   * # Typical `finish` errors
+   * - `ephemeral-ports-exhausted`: 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)
+   * 
+   * # References
+   * - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>
+   * - <https://man7.org/linux/man-pages/man2/connect.2.html>
+   * - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect>
+   * - <https://man.freebsd.org/cgi/man.cgi?connect>
+   */
+  export function startConnect(this_: UdpSocket, network: Network, remoteAddress: IpSocketAddress): void;
+  export function finishConnect(this_: UdpSocket): void;
+  /**
+   * Receive messages on the socket.
+   * 
+   * This function attempts to receive up to `max-results` datagrams on the socket without blocking.
+   * The returned list may contain fewer elements than requested, but never more.
+   * If `max-results` is 0, this function returns successfully with an empty list.
+   * 
+   * # Typical errors
+   * - `not-bound`:          The socket is not bound to any local address. (EINVAL)
+   * - `remote-unreachable`: The remote address is not reachable. (ECONNREFUSED, ECONNRESET, ENETRESET on Windows, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN)
+   * - `would-block`:        There is no pending data available to be read at the moment. (EWOULDBLOCK, EAGAIN)
+   * 
+   * # References
+   * - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recvfrom.html>
+   * - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/recvmsg.html>
+   * - <https://man7.org/linux/man-pages/man2/recv.2.html>
+   * - <https://man7.org/linux/man-pages/man2/recvmmsg.2.html>
+   * - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-recv>
+   * - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-recvfrom>
+   * - <https://learn.microsoft.com/en-us/previous-versions/windows/desktop/legacy/ms741687(v=vs.85)>
+   * - <https://man.freebsd.org/cgi/man.cgi?query=recv&sektion=2>
+   */
+  export function receive(this_: UdpSocket, maxResults: bigint): Datagram[];
+  /**
+   * Send messages on the socket.
+   * 
+   * This function attempts to send all provided `datagrams` on the socket without blocking and
+   * returns how many messages were actually sent (or queued for sending).
+   * 
+   * This function semantically behaves the same as iterating the `datagrams` list and sequentially
+   * sending each individual datagram until either the end of the list has been reached or the first error occurred.
+   * If at least one datagram has been sent successfully, this function never returns an error.
+   * 
+   * If the input list is empty, the function returns `ok(0)`.
+   * 
+   * The remote address option is required. To send a message to the "connected" peer,
+   * call `remote-address` to get their address.
+   * 
+   * # Typical errors
+   * - `address-family-mismatch`: The `remote-address` has the wrong address family. (EAFNOSUPPORT)
+   * - `invalid-remote-address`:  The IP address in `remote-address` is set to INADDR_ANY (`0.0.0.0` / `::`). (EDESTADDRREQ, EADDRNOTAVAIL)
+   * - `invalid-remote-address`:  The port in `remote-address` is set to 0. (EDESTADDRREQ, EADDRNOTAVAIL)
+   * - `already-connected`:       The socket is in "connected" mode and the `datagram.remote-address` does not match the address passed to `connect`. (EISCONN)
+   * - `not-bound`:               The socket is not bound to any local address. Unlike POSIX, this function does not perform an implicit bind.
+   * - `remote-unreachable`:      The remote address is not reachable. (ECONNREFUSED, ECONNRESET, ENETRESET on Windows, EHOSTUNREACH, EHOSTDOWN, ENETUNREACH, ENETDOWN)
+   * - `datagram-too-large`:      The datagram is too large. (EMSGSIZE)
+   * - `would-block`:             The send buffer is currently full. (EWOULDBLOCK, EAGAIN)
+   * 
+   * # References
+   * - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/sendto.html>
+   * - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/sendmsg.html>
+   * - <https://man7.org/linux/man-pages/man2/send.2.html>
+   * - <https://man7.org/linux/man-pages/man2/sendmmsg.2.html>
+   * - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-send>
+   * - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-sendto>
+   * - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasendmsg>
+   * - <https://man.freebsd.org/cgi/man.cgi?query=send&sektion=2>
+   */
+  export function send(this_: UdpSocket, datagrams: Datagram[]): bigint;
+  /**
+   * Get the current bound address.
+   * 
+   * # Typical errors
+   * - `not-bound`: The socket is not bound to any local address.
+   * 
+   * # References
+   * - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html>
+   * - <https://man7.org/linux/man-pages/man2/getsockname.2.html>
+   * - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getsockname>
+   * - <https://man.freebsd.org/cgi/man.cgi?getsockname>
+   */
+  export function localAddress(this_: UdpSocket): IpSocketAddress;
+  /**
+   * Get the address set with `connect`.
+   * 
+   * # Typical errors
+   * - `not-connected`: The socket is not connected to a remote address. (ENOTCONN)
+   * 
+   * # References
+   * - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getpeername.html>
+   * - <https://man7.org/linux/man-pages/man2/getpeername.2.html>
+   * - <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>
+   */
+  export function remoteAddress(this_: UdpSocket): IpSocketAddress;
+  /**
+   * Whether this is a IPv4 or IPv6 socket.
+   * 
+   * Equivalent to the SO_DOMAIN socket option.
+   */
+  export function addressFamily(this_: UdpSocket): IpAddressFamily;
+  /**
+   * Whether IPv4 compatibility (dual-stack) mode is disabled or not.
+   * 
+   * Equivalent to the IPV6_V6ONLY socket option.
+   * 
+   * # Typical errors
+   * - `ipv6-only-operation`:  (get/set) `this` socket is an IPv4 socket.
+   * - `already-bound`:        (set) The socket is already bound.
+   * - `not-supported`:        (set) Host does not support dual-stack sockets. (Implementations are not required to.)
+   * - `concurrency-conflict`: (set) Another `bind` or `connect` operation is already in progress. (EALREADY)
+   */
+  export function ipv6Only(this_: UdpSocket): boolean;
+  export function setIpv6Only(this_: UdpSocket, value: boolean): void;
+  /**
+   * Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
+   * 
+   * # Typical errors
+   * - `concurrency-conflict`: (set) Another `bind` or `connect` operation is already in progress. (EALREADY)
+   */
+  export function unicastHopLimit(this_: UdpSocket): number;
+  export function setUnicastHopLimit(this_: UdpSocket, value: number): void;
+  /**
+   * 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.
+   * 
+   * Equivalent to the SO_RCVBUF and SO_SNDBUF socket options.
+   * 
+   * # Typical errors
+   * - `concurrency-conflict`: (set) Another `bind` or `connect` operation is already in progress. (EALREADY)
+   */
+  export function receiveBufferSize(this_: UdpSocket): bigint;
+  export function setReceiveBufferSize(this_: UdpSocket, value: bigint): void;
+  export function sendBufferSize(this_: UdpSocket): bigint;
+  export function setSendBufferSize(this_: UdpSocket, value: bigint): void;
+  /**
+   * Create a `pollable` which will resolve once the socket is ready for I/O.
+   * 
+   * Note: this function is here for WASI Preview2 only.
+   * It's planned to be removed when `future` is natively supported in Preview3.
+   */
+  export function subscribe(this_: UdpSocket): Pollable;
+  /**
+   * Dispose of the specified `udp-socket`, after which it may no longer be used.
+   * 
+   * Note: this function is scheduled to be removed when Resources are natively supported in Wit.
+   */
+  export function dropUdpSocket(this_: UdpSocket): void;
+}
+import type { Pollable } from '../imports/wasi-poll-poll';
+export { Pollable };
+import type { Network } from '../imports/wasi-sockets-network';
+export { Network };
+import type { ErrorCode } from '../imports/wasi-sockets-network';
+export { ErrorCode };
+import type { IpSocketAddress } from '../imports/wasi-sockets-network';
+export { IpSocketAddress };
+import type { IpAddressFamily } from '../imports/wasi-sockets-network';
+export { IpAddressFamily };
+/**
+ * A UDP socket handle.
+ */
+export type UdpSocket = number;
+export interface Datagram {
+  data: Uint8Array,
+  remoteAddress: IpSocketAddress,
+}

package/types/wasi-cli-command.d.ts

@@ -0,0 +1,29 @@
+import { WasiCliEnvironment } from './imports/wasi-cli-environment';
+import { WasiCliExit } from './imports/wasi-cli-exit';
+import { WasiCliStderr } from './imports/wasi-cli-stderr';
+import { WasiCliStdin } from './imports/wasi-cli-stdin';
+import { WasiCliStdout } from './imports/wasi-cli-stdout';
+import { WasiCliTerminalInput } from './imports/wasi-cli-terminal-input';
+import { WasiCliTerminalOutput } from './imports/wasi-cli-terminal-output';
+import { WasiCliTerminalStderr } from './imports/wasi-cli-terminal-stderr';
+import { WasiCliTerminalStdin } from './imports/wasi-cli-terminal-stdin';
+import { WasiCliTerminalStdout } from './imports/wasi-cli-terminal-stdout';
+import { WasiClocksMonotonicClock } from './imports/wasi-clocks-monotonic-clock';
+import { WasiClocksTimezone } from './imports/wasi-clocks-timezone';
+import { WasiClocksWallClock } from './imports/wasi-clocks-wall-clock';
+import { WasiFilesystemPreopens } from './imports/wasi-filesystem-preopens';
+import { WasiFilesystemTypes } from './imports/wasi-filesystem-types';
+import { WasiIoStreams } from './imports/wasi-io-streams';
+import { WasiPollPoll } from './imports/wasi-poll-poll';
+import { WasiRandomInsecure } from './imports/wasi-random-insecure';
+import { WasiRandomInsecureSeed } from './imports/wasi-random-insecure-seed';
+import { WasiRandomRandom } from './imports/wasi-random-random';
+import { WasiSocketsInstanceNetwork } from './imports/wasi-sockets-instance-network';
+import { WasiSocketsIpNameLookup } from './imports/wasi-sockets-ip-name-lookup';
+import { WasiSocketsNetwork } from './imports/wasi-sockets-network';
+import { WasiSocketsTcp } from './imports/wasi-sockets-tcp';
+import { WasiSocketsTcpCreateSocket } from './imports/wasi-sockets-tcp-create-socket';
+import { WasiSocketsUdp } from './imports/wasi-sockets-udp';
+import { WasiSocketsUdpCreateSocket } from './imports/wasi-sockets-udp-create-socket';
+import { WasiCliRun } from './exports/wasi-cli-run';
+export const run: typeof WasiCliRun;

package/types/wasi-http-proxy.d.ts

@@ -0,0 +1,13 @@
+import { WasiCliStderr } from './imports/wasi-cli-stderr';
+import { WasiCliStdin } from './imports/wasi-cli-stdin';
+import { WasiCliStdout } from './imports/wasi-cli-stdout';
+import { WasiClocksMonotonicClock } from './imports/wasi-clocks-monotonic-clock';
+import { WasiClocksTimezone } from './imports/wasi-clocks-timezone';
+import { WasiClocksWallClock } from './imports/wasi-clocks-wall-clock';
+import { WasiHttpOutgoingHandler } from './imports/wasi-http-outgoing-handler';
+import { WasiHttpTypes } from './imports/wasi-http-types';
+import { WasiIoStreams } from './imports/wasi-io-streams';
+import { WasiPollPoll } from './imports/wasi-poll-poll';
+import { WasiRandomRandom } from './imports/wasi-random-random';
+import { WasiHttpIncomingHandler } from './exports/wasi-http-incoming-handler';
+export const incomingHandler: typeof WasiHttpIncomingHandler;