@bytecodealliance/preview2-shim 0.0.12 → 0.0.14

package/types/{imports/network.d.ts → exports/wasi-sockets-network.d.ts}

@@ -1,10 +1,10 @@
-export namespace ImportsNetwork {
+export namespace WasiSocketsNetwork {
   /**
    * Dispose of the specified `network`, 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 dropNetwork(this: Network): void;
+  export function dropNetwork(this_: Network): void;
 }
 /**
  * An opaque resource that represents access to (a subset of) the network.
@@ -14,48 +14,6 @@ export namespace ImportsNetwork {
  * FYI, In the future this will be replaced by handle types.
  */
 export type Network = number;
-export type Ipv6Address = [number, number, number, number, number, number, number, number];
-export interface Ipv6SocketAddress {
-  port: number,
-  flowInfo: number,
-  address: Ipv6Address,
-  scopeId: number,
-}
-export type Ipv4Address = [number, number, number, number];
-export interface Ipv4SocketAddress {
-  port: number,
-  address: Ipv4Address,
-}
-export type IpSocketAddress = IpSocketAddressIpv4 | IpSocketAddressIpv6;
-export interface IpSocketAddressIpv4 {
-  tag: 'ipv4',
-  val: Ipv4SocketAddress,
-}
-export interface IpSocketAddressIpv6 {
-  tag: 'ipv6',
-  val: Ipv6SocketAddress,
-}
-/**
- * # Variants
- * 
- * ## `"ipv4"`
- * 
- * Similar to `AF_INET` in POSIX.
- * 
- * ## `"ipv6"`
- * 
- * Similar to `AF_INET6` in POSIX.
- */
-export type IpAddressFamily = 'ipv4' | 'ipv6';
-export type IpAddress = IpAddressIpv4 | IpAddressIpv6;
-export interface IpAddressIpv4 {
-  tag: 'ipv4',
-  val: Ipv4Address,
-}
-export interface IpAddressIpv6 {
-  tag: 'ipv6',
-  val: Ipv6Address,
-}
 /**
  * Error codes.
  * 
@@ -68,39 +26,32 @@ export interface IpAddressIpv6 {
  * - `out-of-memory`
  * 
  * See each individual API for what the POSIX equivalents are. They sometimes differ per API.
- * 
  * # Variants
  * 
  * ## `"unknown"`
  * 
  * Unknown error
- * 
  * ## `"access-denied"`
  * 
  * Access denied.
  * 
  * POSIX equivalent: EACCES, EPERM
- * 
  * ## `"not-supported"`
  * 
  * The operation is not supported.
  * 
  * POSIX equivalent: EOPNOTSUPP
- * 
  * ## `"out-of-memory"`
  * 
  * Not enough memory to complete the operation.
  * 
  * POSIX equivalent: ENOMEM, ENOBUFS, EAI_MEMORY
- * 
  * ## `"timeout"`
  * 
  * The operation timed out before it could finish completely.
- * 
  * ## `"concurrency-conflict"`
  * 
  * This operation is incompatible with another asynchronous operation that is already in progress.
- * 
  * ## `"not-in-progress"`
  * 
  * Trying to finish an asynchronous operation that:
@@ -108,105 +59,122 @@ export interface IpAddressIpv6 {
  * - was already finished by a previous `finish-*` call.
  * 
  * Note: this is scheduled to be removed when `future`s are natively supported.
- * 
  * ## `"would-block"`
  * 
  * The operation has been aborted because it could not be completed immediately.
  * 
  * Note: this is scheduled to be removed when `future`s are natively supported.
- * 
  * ## `"address-family-not-supported"`
  * 
  * The specified address-family is not supported.
- * 
  * ## `"address-family-mismatch"`
  * 
  * An IPv4 address was passed to an IPv6 resource, or vice versa.
- * 
  * ## `"invalid-remote-address"`
  * 
  * The socket address is not a valid remote address. E.g. the IP address is set to INADDR_ANY, or the port is set to 0.
- * 
  * ## `"ipv4-only-operation"`
  * 
  * The operation is only supported on IPv4 resources.
- * 
  * ## `"ipv6-only-operation"`
  * 
  * The operation is only supported on IPv6 resources.
- * 
  * ## `"new-socket-limit"`
  * 
  * A new socket resource could not be created because of a system limit.
- * 
  * ## `"already-attached"`
  * 
  * The socket is already attached to another network.
- * 
  * ## `"already-bound"`
  * 
  * The socket is already bound.
- * 
  * ## `"already-connected"`
  * 
  * The socket is already in the Connection state.
- * 
  * ## `"not-bound"`
  * 
  * The socket is not bound to any local address.
- * 
  * ## `"not-connected"`
  * 
  * The socket is not in the Connection state.
- * 
  * ## `"address-not-bindable"`
  * 
  * A bind operation failed because the provided address is not an address that the `network` can bind to.
- * 
  * ## `"address-in-use"`
  * 
  * A bind operation failed because the provided address is already in use.
- * 
  * ## `"ephemeral-ports-exhausted"`
  * 
  * A bind operation failed because there are no ephemeral ports available.
- * 
  * ## `"remote-unreachable"`
  * 
  * The remote address is not reachable
- * 
  * ## `"already-listening"`
  * 
  * The socket is already in the Listener state.
- * 
  * ## `"not-listening"`
  * 
  * The socket is already in the Listener state.
- * 
  * ## `"connection-refused"`
  * 
  * The connection was forcefully rejected
- * 
  * ## `"connection-reset"`
  * 
  * The connection was reset.
- * 
  * ## `"datagram-too-large"`
  * 
  * ## `"invalid-name"`
  * 
  * The provided name is a syntactically invalid domain name.
- * 
  * ## `"name-unresolvable"`
  * 
  * Name does not exist or has no suitable associated IP addresses.
- * 
  * ## `"temporary-resolver-failure"`
  * 
  * A temporary failure in name resolution occurred.
- * 
  * ## `"permanent-resolver-failure"`
  * 
  * A permanent failure in name resolution occurred.
  */
 export type ErrorCode = 'unknown' | 'access-denied' | 'not-supported' | 'out-of-memory' | 'timeout' | 'concurrency-conflict' | 'not-in-progress' | 'would-block' | 'address-family-not-supported' | 'address-family-mismatch' | 'invalid-remote-address' | 'ipv4-only-operation' | 'ipv6-only-operation' | 'new-socket-limit' | 'already-attached' | 'already-bound' | 'already-connected' | 'not-bound' | 'not-connected' | 'address-not-bindable' | 'address-in-use' | 'ephemeral-ports-exhausted' | 'remote-unreachable' | 'already-listening' | 'not-listening' | 'connection-refused' | 'connection-reset' | 'datagram-too-large' | 'invalid-name' | 'name-unresolvable' | 'temporary-resolver-failure' | 'permanent-resolver-failure';
+/**
+ * # Variants
+ * 
+ * ## `"ipv4"`
+ * 
+ * Similar to `AF_INET` in POSIX.
+ * ## `"ipv6"`
+ * 
+ * Similar to `AF_INET6` in POSIX.
+ */
+export type IpAddressFamily = 'ipv4' | 'ipv6';
+export type Ipv4Address = [number, number, number, number];
+export type Ipv6Address = [number, number, number, number, number, number, number, number];
+export type IpAddress = IpAddressIpv4 | IpAddressIpv6;
+export interface IpAddressIpv4 {
+  tag: 'ipv4',
+  val: Ipv4Address,
+}
+export interface IpAddressIpv6 {
+  tag: 'ipv6',
+  val: Ipv6Address,
+}
+export interface Ipv4SocketAddress {
+  port: number,
+  address: Ipv4Address,
+}
+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,
+}

package/types/{imports/tcp-create-socket.d.ts → exports/wasi-sockets-tcp-create-socket.d.ts}

@@ -1,4 +1,4 @@
-export namespace ImportsTcpCreateSocket {
+export namespace WasiSocketsTcpCreateSocket {
   /**
    * Create a new TCP socket.
    * 
@@ -23,11 +23,11 @@ export namespace ImportsTcpCreateSocket {
    */
   export function createTcpSocket(addressFamily: IpAddressFamily): TcpSocket;
 }
-import type { Network } from '../imports/network';
+import type { Network } from '../exports/wasi-sockets-network';
 export { Network };
-import type { ErrorCode } from '../imports/network';
+import type { ErrorCode } from '../exports/wasi-sockets-network';
 export { ErrorCode };
-import type { IpAddressFamily } from '../imports/network';
+import type { IpAddressFamily } from '../exports/wasi-sockets-network';
 export { IpAddressFamily };
-import type { TcpSocket } from '../imports/tcp';
+import type { TcpSocket } from '../exports/wasi-sockets-tcp';
 export { TcpSocket };

package/types/{imports/tcp.d.ts → exports/wasi-sockets-tcp.d.ts}

@@ -1,4 +1,4 @@
-export namespace ImportsTcp {
+export namespace WasiSocketsTcp {
   /**
    * Bind the socket to a specific network on the provided IP address and port.
    * 
@@ -29,8 +29,8 @@ export namespace ImportsTcp {
    * - <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: TcpSocket, network: Network, localAddress: IpSocketAddress): void;
-  export function finishBind(this: TcpSocket): void;
+  export function startBind(this_: TcpSocket, network: Network, localAddress: IpSocketAddress): void;
+  export function finishBind(this_: TcpSocket): void;
   /**
    * Connect to a remote endpoint.
    * 
@@ -62,17 +62,19 @@ export namespace ImportsTcp {
    * - <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: TcpSocket, network: Network, remoteAddress: IpSocketAddress): void;
-  export function finishConnect(this: TcpSocket): [InputStream, OutputStream];
+  export function startConnect(this_: TcpSocket, network: Network, remoteAddress: IpSocketAddress): void;
+  export function finishConnect(this_: TcpSocket): [InputStream, OutputStream];
   /**
    * Start listening for new connections.
    * 
    * Transitions the socket into the Listener state.
    * 
-   * Unlike in POSIX, this function is async. This enables interactive WASI hosts to inject permission prompts.
+   * Unlike POSIX:
+   * - this function is async. This enables interactive WASI hosts to inject permission prompts.
+   * - the socket must already be explicitly bound.
    * 
    * # Typical `start` errors
-   * - `already-attached`:          The socket is already attached to a different network. The `network` passed to `listen` must be identical to the one passed to `bind`.
+   * - `not-bound`:                 The socket is not bound to any local address. (EDESTADDRREQ)
    * - `already-connected`:         The socket is already in the Connection state. (EISCONN, EINVAL on BSD)
    * - `already-listening`:         The socket is already in the Listener state.
    * - `concurrency-conflict`:      Another `bind`, `connect` or `listen` operation is already in progress. (EINVAL on BSD)
@@ -88,8 +90,8 @@ export namespace ImportsTcp {
    * - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-listen>
    * - <https://man.freebsd.org/cgi/man.cgi?query=listen&sektion=2>
    */
-  export function startListen(this: TcpSocket, network: Network): void;
-  export function finishListen(this: TcpSocket): void;
+  export function startListen(this_: TcpSocket): void;
+  export function finishListen(this_: TcpSocket): void;
   /**
    * Accept a new client socket.
    * 
@@ -110,7 +112,7 @@ export namespace ImportsTcp {
    * - <https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-accept>
    * - <https://man.freebsd.org/cgi/man.cgi?query=accept&sektion=2>
    */
-  export function accept(this: TcpSocket): [TcpSocket, InputStream, OutputStream];
+  export function accept(this_: TcpSocket): [TcpSocket, InputStream, OutputStream];
   /**
    * Get the bound local address.
    * 
@@ -123,7 +125,7 @@ export namespace ImportsTcp {
    * - <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: TcpSocket): IpSocketAddress;
+  export function localAddress(this_: TcpSocket): IpSocketAddress;
   /**
    * Get the bound remote address.
    * 
@@ -136,13 +138,13 @@ export namespace ImportsTcp {
    * - <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: TcpSocket): IpSocketAddress;
+  export function remoteAddress(this_: TcpSocket): IpSocketAddress;
   /**
    * Whether this is a IPv4 or IPv6 socket.
    * 
    * Equivalent to the SO_DOMAIN socket option.
    */
-  export function addressFamily(this: TcpSocket): IpAddressFamily;
+  export function addressFamily(this_: TcpSocket): IpAddressFamily;
   /**
    * Whether IPv4 compatibility (dual-stack) mode is disabled or not.
    * 
@@ -154,8 +156,8 @@ export namespace ImportsTcp {
    * - `not-supported`:        (set) Host does not support dual-stack sockets. (Implementations are not required to.)
    * - `concurrency-conflict`: (set) A `bind`, `connect` or `listen` operation is already in progress. (EALREADY)
    */
-  export function ipv6Only(this: TcpSocket): boolean;
-  export function setIpv6Only(this: TcpSocket, value: boolean): void;
+  export function ipv6Only(this_: TcpSocket): boolean;
+  export function setIpv6Only(this_: TcpSocket, value: boolean): void;
   /**
    * Hints the desired listen queue size. Implementations are free to ignore this.
    * 
@@ -163,23 +165,23 @@ export namespace ImportsTcp {
    * - `already-connected`:    (set) The socket is already in the Connection state.
    * - `concurrency-conflict`: (set) A `bind`, `connect` or `listen` operation is already in progress. (EALREADY)
    */
-  export function setListenBacklogSize(this: TcpSocket, value: bigint): void;
+  export function setListenBacklogSize(this_: TcpSocket, value: bigint): void;
   /**
    * Equivalent to the SO_KEEPALIVE socket option.
    * 
    * # Typical errors
    * - `concurrency-conflict`: (set) A `bind`, `connect` or `listen` operation is already in progress. (EALREADY)
    */
-  export function keepAlive(this: TcpSocket): boolean;
-  export function setKeepAlive(this: TcpSocket, value: boolean): void;
+  export function keepAlive(this_: TcpSocket): boolean;
+  export function setKeepAlive(this_: TcpSocket, value: boolean): void;
   /**
    * Equivalent to the TCP_NODELAY socket option.
    * 
    * # Typical errors
    * - `concurrency-conflict`: (set) A `bind`, `connect` or `listen` operation is already in progress. (EALREADY)
    */
-  export function noDelay(this: TcpSocket): boolean;
-  export function setNoDelay(this: TcpSocket, value: boolean): void;
+  export function noDelay(this_: TcpSocket): boolean;
+  export function setNoDelay(this_: TcpSocket, value: boolean): void;
   /**
    * Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
    * 
@@ -188,8 +190,8 @@ export namespace ImportsTcp {
    * - `already-listening`:    (set) The socket is already in the Listener state.
    * - `concurrency-conflict`: (set) A `bind`, `connect` or `listen` operation is already in progress. (EALREADY)
    */
-  export function unicastHopLimit(this: TcpSocket): number;
-  export function setUnicastHopLimit(this: TcpSocket, value: number): void;
+  export function unicastHopLimit(this_: TcpSocket): number;
+  export function setUnicastHopLimit(this_: TcpSocket, value: number): void;
   /**
    * The kernel buffer space reserved for sends/receives on this socket.
    * 
@@ -207,17 +209,17 @@ export namespace ImportsTcp {
    * - `already-listening`:    (set) The socket is already in the Listener state.
    * - `concurrency-conflict`: (set) A `bind`, `connect` or `listen` operation is already in progress. (EALREADY)
    */
-  export function receiveBufferSize(this: TcpSocket): bigint;
-  export function setReceiveBufferSize(this: TcpSocket, value: bigint): void;
-  export function sendBufferSize(this: TcpSocket): bigint;
-  export function setSendBufferSize(this: TcpSocket, value: bigint): void;
+  export function receiveBufferSize(this_: TcpSocket): bigint;
+  export function setReceiveBufferSize(this_: TcpSocket, value: bigint): void;
+  export function sendBufferSize(this_: TcpSocket): bigint;
+  export function setSendBufferSize(this_: TcpSocket, 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: TcpSocket): Pollable;
+  export function subscribe(this_: TcpSocket): Pollable;
   /**
    * Initiate a graceful shutdown.
    * 
@@ -239,7 +241,7 @@ export namespace ImportsTcp {
    * - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-shutdown>
    * - <https://man.freebsd.org/cgi/man.cgi?query=shutdown&sektion=2>
    */
-  export function shutdown(this: TcpSocket, shutdownType: ShutdownType): void;
+  export function shutdown(this_: TcpSocket, shutdownType: ShutdownType): void;
   /**
    * Dispose of the specified `tcp-socket`, after which it may no longer be used.
    * 
@@ -247,21 +249,21 @@ export namespace ImportsTcp {
    * 
    * Note: this function is scheduled to be removed when Resources are natively supported in Wit.
    */
-  export function dropTcpSocket(this: TcpSocket): void;
+  export function dropTcpSocket(this_: TcpSocket): void;
 }
-import type { InputStream } from '../imports/streams';
+import type { InputStream } from '../exports/wasi-io-streams';
 export { InputStream };
-import type { OutputStream } from '../imports/streams';
+import type { OutputStream } from '../exports/wasi-io-streams';
 export { OutputStream };
-import type { Pollable } from '../imports/poll';
+import type { Pollable } from '../exports/wasi-poll-poll';
 export { Pollable };
-import type { Network } from '../imports/network';
+import type { Network } from '../exports/wasi-sockets-network';
 export { Network };
-import type { ErrorCode } from '../imports/network';
+import type { ErrorCode } from '../exports/wasi-sockets-network';
 export { ErrorCode };
-import type { IpSocketAddress } from '../imports/network';
+import type { IpSocketAddress } from '../exports/wasi-sockets-network';
 export { IpSocketAddress };
-import type { IpAddressFamily } from '../imports/network';
+import type { IpAddressFamily } from '../exports/wasi-sockets-network';
 export { IpAddressFamily };
 /**
  * A TCP socket handle.
@@ -273,11 +275,9 @@ export type TcpSocket = number;
  * ## `"receive"`
  * 
  * Similar to `SHUT_RD` in POSIX.
- * 
  * ## `"send"`
  * 
  * Similar to `SHUT_WR` in POSIX.
- * 
  * ## `"both"`
  * 
  * Similar to `SHUT_RDWR` in POSIX.

package/types/{imports/udp-create-socket.d.ts → exports/wasi-sockets-udp-create-socket.d.ts}

@@ -1,4 +1,4 @@
-export namespace ImportsUdpCreateSocket {
+export namespace WasiSocketsUdpCreateSocket {
   /**
    * Create a new UDP socket.
    * 
@@ -23,11 +23,11 @@ export namespace ImportsUdpCreateSocket {
    */
   export function createUdpSocket(addressFamily: IpAddressFamily): UdpSocket;
 }
-import type { Network } from '../imports/network';
+import type { Network } from '../exports/wasi-sockets-network';
 export { Network };
-import type { ErrorCode } from '../imports/network';
+import type { ErrorCode } from '../exports/wasi-sockets-network';
 export { ErrorCode };
-import type { IpAddressFamily } from '../imports/network';
+import type { IpAddressFamily } from '../exports/wasi-sockets-network';
 export { IpAddressFamily };
-import type { UdpSocket } from '../imports/udp';
+import type { UdpSocket } from '../exports/wasi-sockets-udp';
 export { UdpSocket };