@bytecodealliance/preview2-shim 0.0.1

package/README.md

@@ -0,0 +1,39 @@
+# WASI Preview2 JavaScript Shim
+
+_**Experimental**_ shim modules for the [WASI Preview2](https://github.com/bytecodealliance/preview2-prototyping) component interfaces in JS environments.
+
+Currently supports Node.js and browser versions, but alternative implementations for any JS environments can be supported.
+
+## Implementation Status
+
+| Interface       | Node.js               |Browser               |
+| --------------- | ---------------------:|---------------------:|
+| Command         | :x:                   | :x:                  |
+| Default Clocks  | :heavy_check_mark:    | :heavy_check_mark:   |
+| DNS             | :x:                   | :x:                  |
+| Environment     | :x:                   | :x:                  |
+| Exit            | :heavy_check_mark:    | :heavy_check_mark:   |
+| Filesystem      | :x:                   | :x:                  |
+| Http            | Experimental          | Experimental         |
+| IO              | Partial               | Partial              |
+| IP              | :x:                   | :x:                  |
+| Logging         | :heavy_check_mark:    | :heavy_check_mark:   |
+| Monotonic Clock | Missing `resolution`  | Missing `resolution` |
+| Net             | :x:                   | :x:                  |
+| Poll            | :x:                   | :x:                  |
+| Random          | :heavy_check_mark:    | :heavy_check_mark:   |
+| Stderr          | :heavy_check_mark:    | :heavy_check_mark:   |
+| TCP             | :x:                   | :x:                  |
+| Timezone        | :x:                   | :x:                  |
+| Wall Clock      | Missing `resolution`  | Missing `resolution` |
+
+# License
+
+This project is licensed under the Apache 2.0 license with the LLVM exception.
+See [LICENSE](LICENSE) for more details.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in this project by you, as defined in the Apache-2.0 license,
+shall be licensed as above, without any additional terms or conditions.

package/http/error.js

@@ -0,0 +1,11 @@
+export class UnexpectedError extends Error {
+  /** @type { import("../types/wasi-http").HttpErrorUnexpectedError } */
+  payload;
+  constructor(message = "unexpected-error") {
+    super(message);
+    this.payload = {
+      tag: "unexpected-error",
+      val: message,
+    };
+  }
+}

package/http/make-request.js

@@ -0,0 +1,29 @@
+import { runAsWorker } from "synckit";
+
+/**
+ * @param {import("../types/wasi-http").Request} req
+ * @returns {Promise<string>}
+ */
+async function makeRequest(req) {
+  try {
+    let headers = new Headers(req.headers);
+    const resp = await fetch(req.uri, {
+      method: req.method.toString(),
+      headers,
+      body: req.body.length > 0 ? req.body : undefined,
+    });
+    let arrayBuffer = await resp.arrayBuffer();
+    return JSON.stringify({
+      status: resp.status,
+      headers: resp.headers,
+      body:
+        arrayBuffer.byteLength > 0
+          ? Buffer.from(arrayBuffer).toString("base64")
+          : undefined,
+    });
+  } catch (err) {
+    return err.message;
+  }
+}
+
+runAsWorker(makeRequest);

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@bytecodealliance/preview2-shim",
+  "version": "0.0.1",
+  "description": "WASI Preview2 shim in JavaScript environments",
+  "author": "Guy Bedford, Eduardo Rodrigues<16357187+eduardomourar@users.noreply.github.com>",
+  "type": "module",
+  "exports": {
+    "./*": {
+      "types": "./types/*.js",
+      "node": "./lib/nodejs/*.js",
+      "default": "./lib/browser/*.js"
+    }
+  },
+  "scripts": {
+    "test": "mocha -u tdd test/test.js --timeout 10000"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "browser/",
+    "http/",
+    "nodejs/",
+    "types/"
+  ],
+  "devDependencies": {
+    "mocha": "^10.2.0"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,9 @@
+export * as clocks from "./types/wasi-clocks";
+export * as defaultClocks from "./types/wasi-default-clocks";
+export * as exit from "./types/wasi-exit";
+export * as filesystem from "./types/wasi-filesystem";
+export * as io from "./types/wasi-io";
+export * as logging from "./types/wasi-logging";
+export * as poll from "./types/wasi-poll";
+export * as random from "./types/wasi-random";
+export * as stderr from "./types/wasi-stderr";

package/types/wasi-clocks.d.ts

@@ -0,0 +1,11 @@
+export type MonotonicClock = number;
+export type Instant = bigint;
+export type WallClock = number;
+export interface Datetime {
+  seconds: bigint,
+  nanoseconds: number,
+}
+export namespace WasiClocks {
+  export function monotonicClockNow(clock: MonotonicClock): Instant;
+  export function wallClockNow(clock: WallClock): Datetime;
+}

package/types/wasi-default-clocks.d.ts

@@ -0,0 +1,6 @@
+export type MonotonicClock = MonotonicClock;
+export type WallClock = WallClock;
+export namespace WasiDefaultClocks {
+  export function defaultMonotonicClock(): MonotonicClock;
+  export function defaultWallClock(): WallClock;
+}

package/types/wasi-exit.d.ts

@@ -0,0 +1,3 @@
+export namespace WasiExit {
+  export function exit(status: { tag: 'err' | 'ok' }): void;
+}

package/types/wasi-filesystem.d.ts

@@ -0,0 +1,150 @@
+export type Descriptor = number;
+export type Filesize = bigint;
+export type InputStream = InputStream;
+/**
+ * # Variants
+ * 
+ * ## `"access"`
+ * 
+ * ## `"again"`
+ * 
+ * ## `"already"`
+ * 
+ * ## `"badf"`
+ * 
+ * ## `"busy"`
+ * 
+ * ## `"deadlk"`
+ * 
+ * ## `"dquot"`
+ * 
+ * ## `"exist"`
+ * 
+ * ## `"fbig"`
+ * 
+ * ## `"ilseq"`
+ * 
+ * ## `"inprogress"`
+ * 
+ * ## `"intr"`
+ * 
+ * ## `"inval"`
+ * 
+ * ## `"io"`
+ * 
+ * ## `"isdir"`
+ * 
+ * ## `"loop"`
+ * 
+ * ## `"mlink"`
+ * 
+ * ## `"msgsize"`
+ * 
+ * ## `"nametoolong"`
+ * 
+ * ## `"nodev"`
+ * 
+ * ## `"noent"`
+ * 
+ * ## `"nolck"`
+ * 
+ * ## `"nomem"`
+ * 
+ * ## `"nospc"`
+ * 
+ * ## `"nosys"`
+ * 
+ * ## `"notdir"`
+ * 
+ * ## `"notempty"`
+ * 
+ * ## `"notrecoverable"`
+ * 
+ * ## `"notsup"`
+ * 
+ * ## `"notty"`
+ * 
+ * ## `"nxio"`
+ * 
+ * ## `"overflow"`
+ * 
+ * ## `"perm"`
+ * 
+ * ## `"pipe"`
+ * 
+ * ## `"rofs"`
+ * 
+ * ## `"spipe"`
+ * 
+ * ## `"txtbsy"`
+ * 
+ * ## `"xdev"`
+ */
+export type Errno = 'access' | 'again' | 'already' | 'badf' | 'busy' | 'deadlk' | 'dquot' | 'exist' | 'fbig' | 'ilseq' | 'inprogress' | 'intr' | 'inval' | 'io' | 'isdir' | 'loop' | 'mlink' | 'msgsize' | 'nametoolong' | 'nodev' | 'noent' | 'nolck' | 'nomem' | 'nospc' | 'nosys' | 'notdir' | 'notempty' | 'notrecoverable' | 'notsup' | 'notty' | 'nxio' | 'overflow' | 'perm' | 'pipe' | 'rofs' | 'spipe' | 'txtbsy' | 'xdev';
+export type OutputStream = OutputStream;
+export type DirEntryStream = number;
+export type Device = bigint;
+export type Inode = bigint;
+/**
+ * # Variants
+ * 
+ * ## `"unknown"`
+ * 
+ * ## `"block-device"`
+ * 
+ * ## `"character-device"`
+ * 
+ * ## `"directory"`
+ * 
+ * ## `"fifo"`
+ * 
+ * ## `"symbolic-link"`
+ * 
+ * ## `"regular-file"`
+ * 
+ * ## `"socket"`
+ */
+export type DescriptorType = 'unknown' | 'block-device' | 'character-device' | 'directory' | 'fifo' | 'symbolic-link' | 'regular-file' | 'socket';
+export type Linkcount = bigint;
+export type Datetime = Datetime;
+export interface DescriptorStat {
+  dev: Device,
+  ino: Inode,
+  type: DescriptorType,
+  nlink: Linkcount,
+  size: Filesize,
+  atim: Datetime,
+  mtim: Datetime,
+  ctim: Datetime,
+}
+export interface AtFlags {
+  symlinkFollow?: boolean,
+}
+export interface OFlags {
+  create?: boolean,
+  directory?: boolean,
+  excl?: boolean,
+  trunc?: boolean,
+}
+export interface DescriptorFlags {
+  read?: boolean,
+  write?: boolean,
+  dsync?: boolean,
+  nonblock?: boolean,
+  rsync?: boolean,
+  sync?: boolean,
+}
+export interface Mode {
+  readable?: boolean,
+  writeable?: boolean,
+  executable?: boolean,
+}
+export namespace WasiFilesystem {
+  export function readViaStream(fd: Descriptor, offset: Filesize): InputStream;
+  export function writeViaStream(fd: Descriptor, offset: Filesize): OutputStream;
+  export function appendViaStream(fd: Descriptor): OutputStream;
+  export function closeDirEntryStream(s: DirEntryStream): void;
+  export function stat(fd: Descriptor): DescriptorStat;
+  export function openAt(fd: Descriptor, atFlags: AtFlags, path: string, oFlags: OFlags, flags: DescriptorFlags, mode: Mode): Descriptor;
+  export function close(fd: Descriptor): void;
+}

package/types/wasi-http.d.ts

@@ -0,0 +1,55 @@
+/**
+ * # Variants
+ * 
+ * ## `"get"`
+ * 
+ * ## `"post"`
+ * 
+ * ## `"put"`
+ * 
+ * ## `"delete"`
+ * 
+ * ## `"patch"`
+ * 
+ * ## `"head"`
+ * 
+ * ## `"options"`
+ */
+export type Method = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'head' | 'options';
+export type Uri = string;
+export type Headers = [string, string][];
+export type Params = [string, string][];
+export type Body = Uint8Array;
+export interface Request {
+  method: Method,
+  uri: Uri,
+  headers: Headers,
+  params: Params,
+  body?: Body,
+}
+export type HttpStatus = number;
+export interface Response {
+  status: HttpStatus,
+  headers?: Headers,
+  body?: Body,
+}
+export type HttpError = HttpErrorInvalidUrl | HttpErrorTimeoutError | HttpErrorProtocolError | HttpErrorUnexpectedError;
+export interface HttpErrorInvalidUrl {
+  tag: 'invalid-url',
+  val: string,
+}
+export interface HttpErrorTimeoutError {
+  tag: 'timeout-error',
+  val: string,
+}
+export interface HttpErrorProtocolError {
+  tag: 'protocol-error',
+  val: string,
+}
+export interface HttpErrorUnexpectedError {
+  tag: 'unexpected-error',
+  val: string,
+}
+export namespace WasiHttp {
+  export function send(req: Request): Response;
+}

package/types/wasi-io.d.ts

@@ -0,0 +1,10 @@
+export type InputStream = number;
+export interface StreamError {
+}
+export type OutputStream = number;
+export namespace WasiIo {
+  export function read(src: InputStream, len: bigint): [Uint8Array | ArrayBuffer, boolean];
+  export function write(dst: OutputStream, buf: Uint8Array): bigint;
+  export function dropInputStream(f: InputStream): void;
+  export function dropOutputStream(f: OutputStream): void;
+}

package/types/wasi-poll.d.ts

@@ -0,0 +1,4 @@
+export type Pollable = number;
+export namespace WasiPoll {
+  export function pollOneoff(input: Pollable[]): Uint8Array;
+}

package/types/wasi-random.d.ts

@@ -0,0 +1,3 @@
+export namespace WasiRandom {
+  export function getRandomBytes(len: number): Uint8Array | ArrayBuffer;
+}

package/types/wasi-stderr.d.ts

@@ -0,0 +1,3 @@
+export namespace WasiStderr {
+  export function print(message: string): void;
+}