@farm.js/wasm 0.1.0-beta.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Farm.js Team
+
+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,23 @@
+# @farm.js/wasm
+
+Import prebuilt WebAssembly modules in Farm browser code and browser workers.
+
+```sh
+pnpm add @farm.js/wasm
+```
+
+```ts
+import { defineConfig } from "@farm.js/core";
+import { wasm } from "@farm.js/wasm";
+
+export default defineConfig({
+  plugins: [wasm()],
+});
+```
+
+The plugin installs `vite-plugin-wasm` in both build pipelines, uses ES-module workers, and selects a browser target that supports native top-level await. The default is Chrome/Edge 89, Firefox 114, and Safari 15 unless your app supplies `vite.build.target`. Override it explicitly with `wasm({ target: ["chrome120", "firefox120", "safari17"] })`.
+
+This is a browser loading/build plugin, not a Rust compiler, worker pool, or universal server/edge adapter. Import the JavaScript entry point supplied by your Wasm package when it has one. Keep browser-only imports inside client event handlers or effects.
+
+- [Documentation](https://farmjs.dev/docs/plugins/wasm)
+- [Runnable example](https://github.com/farming-labs/farm.js/tree/main/examples/wasm-demo)

package/dist/config.d.ts

@@ -0,0 +1,12 @@
+export interface WasmOptions {
+    /**
+     * Browser compilation target. Must support native top-level await and module workers.
+     * Overrides vite.build.target for browser builds only; server targets are unchanged.
+     * Uses vite.build.target when supplied, otherwise Chrome/Edge 89,
+     * Firefox 114, and Safari 15. Does not polyfill browser runtime limitations.
+     */
+    target?: string | string[];
+}
+export declare const DEFAULT_WASM_TARGET: string[];
+export declare function resolveWasmOptions(options: WasmOptions): WasmOptions;
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC5B;AAED,eAAO,MAAM,mBAAmB,UAAmD,CAAC;AAEpF,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,WAAW,GAAG,WAAW,CAuBpE"}

package/dist/config.js

@@ -0,0 +1,20 @@
+export const DEFAULT_WASM_TARGET = ["chrome89", "edge89", "firefox114", "safari15"];
+export function resolveWasmOptions(options) {
+    if (!options || typeof options !== "object" || Array.isArray(options)) {
+        throw new TypeError("[farm:wasm] Options must be an object");
+    }
+    for (const key of Object.keys(options)) {
+        if (key !== "target") {
+            throw new TypeError(`[farm:wasm] Unknown option ${JSON.stringify(key)}. The supported option is target.`);
+        }
+    }
+    const target = options.target;
+    if (target === undefined)
+        return {};
+    const targets = Array.isArray(target) ? target : [target];
+    if (targets.length === 0 ||
+        targets.some((value) => typeof value !== "string" || value.trim() === "")) {
+        throw new TypeError("[farm:wasm] target must be a non-empty browser target or array of browser targets");
+    }
+    return { target: Array.isArray(target) ? [...target] : target };
+}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import { type FarmPlugin } from "@farm.js/core/plugin";
+import { type WasmOptions } from "./config.js";
+export type { WasmOptions };
+/** Configure WebAssembly ESM imports in Farm's browser and browser-worker builds. */
+export declare function wasm(options?: WasmOptions): FarmPlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAGrE,OAAO,EAA2C,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;AAExF,YAAY,EAAE,WAAW,EAAE,CAAC;AAE5B,qFAAqF;AACrF,wBAAgB,IAAI,CAAC,OAAO,GAAE,WAAgB,GAAG,UAAU,CAuE1D"}

package/dist/index.js

@@ -0,0 +1,73 @@
+import { definePlugin } from "@farm.js/core/plugin";
+import wasmPlugin from "vite-plugin-wasm";
+import { DEFAULT_WASM_TARGET, resolveWasmOptions } from "./config.js";
+/** Configure WebAssembly ESM imports in Farm's browser and browser-worker builds. */
+export function wasm(options = {}) {
+    const resolved = resolveWasmOptions(options);
+    function plugins() {
+        const upstream = wasmPlugin();
+        // The upstream helper uses a root URL. Farm handles page requests before
+        // Vite, so give this virtual module Vite's standard null-prefixed identity.
+        const helper = "/__vite-plugin-wasm-helper";
+        const virtualHelper = `\0${helper}`;
+        return [
+            {
+                ...upstream,
+                resolveId(id, ...args) {
+                    if (id === helper)
+                        return virtualHelper;
+                    return upstream.resolveId.call(this, id, ...args);
+                },
+                load(id, ...args) {
+                    return upstream.load.call(this, id === virtualHelper ? helper : id, ...args);
+                },
+            },
+        ];
+    }
+    return definePlugin({
+        name: "farm:wasm",
+        enforce: "pre",
+        configure(config) {
+            if ((config.plugins ?? []).filter((plugin) => plugin.name === "farm:wasm").length > 1) {
+                throw new Error("[farm:wasm] Configure one wasm() plugin instance");
+            }
+            // Install worker handling through a Vite config hook as well as the public
+            // config. Farm constructs separate production Vite configs for each build.
+            const workerPlugin = {
+                name: "farm:wasm-workers",
+                config(viteConfig, environment) {
+                    const worker = { ...config.vite?.worker, ...viteConfig.worker };
+                    const existing = worker.plugins;
+                    if (worker.format === "iife") {
+                        throw new Error('[farm:wasm] WebAssembly imports require worker.format: "es". Remove the iife override.');
+                    }
+                    if (environment.command === "build" && !viteConfig.build?.ssr) {
+                        // Vite concatenates arrays returned from config hooks. Replace the
+                        // target so Farm's older default cannot remain in the target list.
+                        viteConfig.build = {
+                            ...viteConfig.build,
+                            target: resolved.target ?? config.vite?.build?.target ?? [...DEFAULT_WASM_TARGET],
+                        };
+                    }
+                    return {
+                        worker: {
+                            ...worker,
+                            format: "es",
+                            plugins: (...args) => [
+                                ...plugins(),
+                                ...(typeof existing === "function" ? existing(...args) : (existing ?? [])),
+                            ],
+                        },
+                    };
+                },
+            };
+            return {
+                ...config,
+                vite: {
+                    ...config.vite,
+                    plugins: [workerPlugin, ...plugins(), ...(config.vite?.plugins ?? [])],
+                },
+            };
+        },
+    });
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@farm.js/wasm",
+  "version": "0.1.0-beta.0",
+  "description": "WebAssembly imports and browser workers for Farm.js applications",
+  "keywords": [
+    "farm.js",
+    "vite",
+    "wasm",
+    "webassembly",
+    "worker"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/farming-labs/farm.js",
+    "directory": "packages/farm-wasm"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "vite-plugin-wasm": "^3.6.0",
+    "@farm.js/core": "0.1.0-beta.96"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.5",
+    "typescript": "^5.3.3",
+    "vite": "^5.0.10",
+    "vitest": "^3.2.7",
+    "wabt": "^1.0.39"
+  },
+  "engines": {
+    "node": ">=22.13.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "type-check": "tsc --noEmit",
+    "test": "vitest run"
+  }
+}