unwasm 0.0.0 → 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Pooya Parsa <pooya@pi0.io>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,88 @@
+# 🇼 unwasm
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![Codecov][codecov-src]][codecov-href]
+
+Universal [WebAssembly](https://webassembly.org/) tools for JavaScript.
+
+## Goal
+
+This project aims to make a common and future-proof solution for WebAssembly modules support suitable for various JavaScript runtimes, Frameworks, and build Tools following [WebAssembly/ES Module Integration](https://github.com/WebAssembly/esm-integration/tree/main/proposals/esm-integration) proposal from WebAssembly Community Group as much as possible.
+
+## Roadmap
+
+The development will be split into multiple stages.
+
+> [!IMPORTANT]
+> This Project is under development! Join the linked discussions to be involved!
+
+- [ ] Universal builder plugins ([unjs/unwasm#2](https://github.com/unjs/unwasm/issues/2)) built with [unjs/unplugin](https://github.com/unjs/unplugin) 
+  - [x] Rollup
+- [ ] Tools to operate and inspect `.wasm` files ([unjs/unwasm#3](https://github.com/unjs/unwasm/issues/3)) 
+- [ ] Runtime utils ([unjs/unwasm#4](https://github.com/unjs/unwasm/issues/4)) 
+- [ ] ESM loader for Node.js and other JavaScript runtimes ([unjs/unwasm#5](https://github.com/unjs/unwasm/issues/5))
+- [ ] Integration with [Wasmer](https://github.com/wasmerio) ([unjs/unwasm#6](https://github.com/unjs/unwasm/issues/6)) 
+- [ ] Convention and tools for library authors exporting wasm modules ([unjs/unwasm#7](https://github.com/unjs/unwasm/issues/7))
+
+## Install
+
+Install package from [npm](https://www.npmjs.com/package/unwasm):
+
+```sh
+# npm
+npm install unwasm
+
+# yarn
+yarn add unwasm
+
+# pnpm
+pnpm install unwasm
+
+# bun
+bun install unwasm
+```
+
+## Using build plugin
+
+###### Rollup
+
+```js
+import unwasmPlugin from "unwasm/plugin";
+
+export default {
+  plugins: [
+    unwasmPlugin.rollup({
+      /* options */
+    }),
+  ],
+};
+```
+
+### Options
+
+- `esmImport`: Direct import the wasm file instead of bundling, required in Cloudflare Workers (default is `false`)
+- `lazy`: Import `.wasm` files using a lazily evaluated promise for compatibility with runtimes without top-level await support (default is `false`)
+
+## Development
+
+- Clone this repository
+- Install the latest LTS version of [Node.js](https://nodejs.org/en/)
+- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
+- Install dependencies using `pnpm install`
+- Run interactive tests using `pnpm dev`
+
+## License
+
+Made with 💛
+
+Published under [MIT License](./LICENSE).
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/unwasm?style=flat&colorA=18181B&colorB=F0DB4F
+[npm-version-href]: https://npmjs.com/package/unwasm
+[npm-downloads-src]: https://img.shields.io/npm/dm/unwasm?style=flat&colorA=18181B&colorB=F0DB4F
+[npm-downloads-href]: https://npmjs.com/package/unwasm
+[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/unwasm/main?style=flat&colorA=18181B&colorB=F0DB4F
+[codecov-href]: https://codecov.io/gh/unjs/unwasm

package/dist/plugin.d.mts

@@ -0,0 +1,21 @@
+import { Plugin } from 'rollup';
+
+interface UnwasmPluginOptions {
+    /**
+     * Direct import the wasm file instead of bundling, required in Cloudflare Workers
+     *
+     * @default false
+     */
+    esmImport?: boolean;
+    /**
+     * Import `.wasm` files using a lazily evaluated promise for compatibility with runtimes without top-level await support
+     *
+     * @default false
+     */
+    lazy?: boolean;
+}
+declare const _default: {
+    rollup: (opts: UnwasmPluginOptions) => Plugin<any>;
+};
+
+export { type UnwasmPluginOptions, _default as default };

package/dist/plugin.d.ts

@@ -0,0 +1,21 @@
+import { Plugin } from 'rollup';
+
+interface UnwasmPluginOptions {
+    /**
+     * Direct import the wasm file instead of bundling, required in Cloudflare Workers
+     *
+     * @default false
+     */
+    esmImport?: boolean;
+    /**
+     * Import `.wasm` files using a lazily evaluated promise for compatibility with runtimes without top-level await support
+     *
+     * @default false
+     */
+    lazy?: boolean;
+}
+declare const _default: {
+    rollup: (opts: UnwasmPluginOptions) => Plugin<any>;
+};
+
+export { type UnwasmPluginOptions, _default as default };

package/dist/plugin.mjs

@@ -0,0 +1,129 @@
+import { existsSync, promises } from 'node:fs';
+import { basename } from 'pathe';
+import MagicString from 'magic-string';
+import { createUnplugin } from 'unplugin';
+import { createHash } from 'node:crypto';
+
+function sha1(source) {
+  return createHash("sha1").update(source).digest("hex").slice(0, 16);
+}
+
+const WASM_EXTERNAL_ID = "\0unwasm:external:";
+const unplugin = createUnplugin((opts) => {
+  const assets = /* @__PURE__ */ Object.create(null);
+  return {
+    name: "unwasm",
+    rollup: {
+      async resolveId(id, importer) {
+        if (id.startsWith(WASM_EXTERNAL_ID)) {
+          return {
+            id,
+            external: true
+          };
+        }
+        if (id.endsWith(".wasm")) {
+          const r = await this.resolve(id, importer, { skipSelf: true });
+          if (r?.id && r?.id !== id) {
+            return {
+              id: r.id.startsWith("file://") ? r.id.slice(7) : r.id,
+              external: false,
+              moduleSideEffects: false,
+              syntheticNamedExports: false
+            };
+          }
+        }
+      },
+      generateBundle() {
+        if (opts.esmImport) {
+          for (const asset of Object.values(assets)) {
+            this.emitFile({
+              type: "asset",
+              source: asset.source,
+              fileName: asset.name
+            });
+          }
+        }
+      }
+    },
+    async load(id) {
+      if (!id.endsWith(".wasm") || !existsSync(id)) {
+        return;
+      }
+      const source = await promises.readFile(id);
+      const name = `wasm/${basename(id, ".wasm")}-${sha1(source)}.wasm`;
+      assets[id] = { name, source };
+      return `export default "WASM";`;
+    },
+    transform(_code, id) {
+      if (!id.endsWith(".wasm")) {
+        return;
+      }
+      const asset = assets[id];
+      if (!asset) {
+        return;
+      }
+      let _dataStr;
+      if (opts.esmImport) {
+        _dataStr = `await import("${WASM_EXTERNAL_ID}${id}").then(r => r?.default || r)`;
+      } else {
+        const base64Str = asset.source.toString("base64");
+        _dataStr = `(()=>{const d=atob("${base64Str}");const s=d.length;const b=new Uint8Array(s);for(let i=0;i<s;i++)b[i]=d.charCodeAt(i);return b})()`;
+      }
+      let _str = `await WebAssembly.instantiate(${_dataStr}, { env: { "Math.random": () => Math.random, "Math.floor": () => Math.floor } }).then(r => r?.exports||r?.instance?.exports || r);`;
+      if (opts.lazy) {
+        _str = `(()=>{const e=async()=>{return ${_str}};let _p;const p=()=>{if(!_p)_p=e();return _p;};return {then:cb=>p().then(cb),catch:cb=>p().catch(cb)}})()`;
+      }
+      return {
+        code: `export default ${_str};`,
+        map: { mappings: "" },
+        syntheticNamedExports: true
+      };
+    },
+    renderChunk(code, chunk) {
+      if (!chunk.moduleIds.some((id) => id.endsWith(".wasm")) || !code.includes(WASM_EXTERNAL_ID)) {
+        return;
+      }
+      const s = new MagicString(code);
+      const resolveImport = (id) => {
+        if (typeof id !== "string") {
+          return;
+        }
+        const asset = assets[id];
+        if (!asset) {
+          return;
+        }
+        const nestedLevel = chunk.fileName.split("/").length - 1;
+        const relativeId = (nestedLevel ? "../".repeat(nestedLevel) : "./") + asset.name;
+        return {
+          relativeId,
+          asset
+        };
+      };
+      const ReplaceRE = new RegExp(`${WASM_EXTERNAL_ID}([^"']+)`, "g");
+      for (const match of code.matchAll(ReplaceRE)) {
+        const resolved = resolveImport(match[1]);
+        const index = match.index;
+        const len = match[0].length;
+        if (!resolved || !index) {
+          console.warn(
+            `Failed to resolve WASM import: ${JSON.stringify(match[1])}`
+          );
+          continue;
+        }
+        s.overwrite(index, index + len, resolved.relativeId);
+      }
+      if (s.hasChanged()) {
+        return {
+          code: s.toString(),
+          map: s.generateMap({ includeContent: true })
+        };
+      }
+    }
+  };
+});
+const rollup = unplugin.rollup;
+const plugin = {
+  rollup
+};
+
+export { plugin as default };

package/package.json

@@ -1 +1,50 @@
-{"name":"unwasm","version":"0.0.0"}
+{
+  "name": "unwasm",
+  "version": "0.0.1",
+  "description": "WebAssembly tools for JavaScript",
+  "repository": "unjs/unwasm",
+  "license": "MIT",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    "./plugin": {
+      "types": "./dist/plugin.d.mts",
+      "import": "./dist/plugin.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "unbuild",
+    "dev": "vitest dev",
+    "lint": "eslint --cache --ext .ts,.js,.mjs,.cjs . && prettier -c src test",
+    "lint:fix": "eslint --cache --ext .ts,.js,.mjs,.cjs . --fix && prettier -c src test -w",
+    "prepack": "pnpm build",
+    "release": "pnpm test && changelogen --release && npm publish && git push --follow-tags",
+    "test": "pnpm lint && pnpm test:types && vitest run --coverage",
+    "test:types": "tsc --noEmit --skipLibCheck"
+  },
+  "dependencies": {
+    "magic-string": "^0.30.5",
+    "mlly": "^1.4.2",
+    "pathe": "^1.1.1",
+    "unplugin": "^1.6.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@types/node": "^20.10.5",
+    "@vitest/coverage-v8": "^1.1.0",
+    "changelogen": "^0.5.5",
+    "eslint": "^8.56.0",
+    "eslint-config-unjs": "^0.2.1",
+    "jiti": "^1.21.0",
+    "prettier": "^3.1.1",
+    "rollup": "^4.9.1",
+    "typescript": "^5.3.3",
+    "unbuild": "^2.0.0",
+    "vite": "^5.0.10",
+    "vitest": "^1.1.0"
+  },
+  "packageManager": "pnpm@8.12.1"
+}