@simulatte/webgpu-doe 0.1.2 → 0.3.2

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to `@simulatte/webgpu-doe` are documented in this file.
+
+## [0.3.2] - 2026-03-15
+
+### Added
+
+- Reintroduced `@simulatte/webgpu-doe` as a standalone helper-only package.
+- Exported `createDoeNamespace(...)`, `doe`, and the default Doe namespace.
+- Added standalone TypeScript types for the Doe helper contract.
+- Added a package-local smoke test and example showing how to bind Doe to
+  `@simulatte/webgpu` or `@simulatte/webgpu/compute`.
+
+### Notes
+
+- This package intentionally does not ship a runtime, addon, or Bun FFI layer.
+- The Doe helper surface remains compatible with the helper contract currently
+  shipped inside `@simulatte/webgpu`.

package/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Fawn Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,173 +1,168 @@
 # @simulatte/webgpu-doe
 
-Headless WebGPU for Node.js on the Doe runtime.
+<table>
+  <tr>
+    <td valign="middle">
+      <strong>Run the Doe helper layer over real WebGPU devices from Fawn or any compatible raw runtime.</strong>
+    </td>
+    <td valign="middle">
+      <img src="assets/fawn-icon-main.svg" alt="Fawn logo" width="88" />
+    </td>
+  </tr>
+</table>
 
-**[Fawn](https://github.com/clocksmith/fawn/tree/main/nursery/webgpu-doe)** · **[npm](https://www.npmjs.com/package/@simulatte/webgpu-doe)** · **[simulatte.world](https://simulatte.world)**
+`@simulatte/webgpu-doe` is the standalone Doe helper layer extracted from
+Fawn's headless WebGPU package surface.
 
-## Install
+This package does **not** ship a runtime, native addon, Bun FFI layer, or raw
+WebGPU implementation. It ships the Doe helper namespace only:
 
-```sh
-npm install @simulatte/webgpu-doe
-```
+- `createDoeNamespace(...)`
+- `doe`
+- `default`
 
-The published package currently targets `darwin-arm64`. The N-API addon builds
-from C source during install via `node-gyp`, so a local C toolchain is
-required (`xcode-select --install` on macOS).
+Use it when you want the same helper surface that exists inside
+`@simulatte/webgpu`, but as a separate package boundary.
 
-## Quick start
+## What this package includes
 
-```js
-import { create, globals } from '@simulatte/webgpu-doe';
+- Doe buffer helpers: `gpu.buffer.create(...)`, `gpu.buffer.read(...)`
+- Doe compute helpers: `gpu.kernel.run(...)`, `gpu.kernel.create(...)`,
+  `gpu.compute(...)`
+- Generic TypeScript types for the bound Doe namespace and helper options
 
-const gpu = create();
-const adapter = await gpu.requestAdapter();
-const device = await adapter.requestDevice();
+## What this package does not include
 
-console.log(device.limits.maxComputeWorkgroupSizeX); // 1024
-console.log(device.features.has('shader-f16'));       // true
+- no runtime or device discovery on its own
+- no Node addon or Bun FFI transport
+- no raw WebGPU wrapper classes
+- no feature publication, limits, or globals
 
-// Standard WebGPU compute workflow
-const buffer = device.createBuffer({
-  size: 64,
-  usage: globals.GPUBufferUsage.STORAGE | globals.GPUBufferUsage.COPY_SRC,
-});
+You either:
 
-const shader = device.createShaderModule({
-  code: `
-    @group(0) @binding(0) var<storage, read_write> data: array<f32>;
-    @compute @workgroup_size(64)
-    fn main(@builtin(global_invocation_id) id: vec3u) {
-      data[id.x] = data[id.x] * 2.0;
-    }
-  `,
-});
+1. inject a `requestDevice(...)` function from another package, or
+2. bind Doe to an already-created compatible device with `doe.bind(device)`
 
-// ... create pipeline, bind group, encode, dispatch, readback
-```
+## Install
 
-The package loads `libdoe_webgpu` and exposes a WebGPU-shaped API for
-headless compute and basic render work. See [more examples](#more-examples)
-below for `navigator.gpu` setup and provider inspection.
+Pair it with a compatible runtime package, usually `@simulatte/webgpu`:
 
-## Why Doe
+```bash
+npm install @simulatte/webgpu-doe @simulatte/webgpu
+```
 
-- Native path: JavaScript calls into an N-API addon, which loads
-  `libdoe_webgpu` and submits work through Doe's Metal backend.
-- Runtime ownership: WGSL is compiled to MSL inside Doe's AST-based compiler
-  instead of going through Dawn.
-- Small package payload: the shared library is about 2 MB on `darwin-arm64`.
-- WebGPU-shaped surface: `requestAdapter`, `requestDevice`, buffer mapping,
-  bind groups, compute pipelines, command encoders, and basic render passes are
-  exposed directly from the package.
+## How the packages fit together
 
-## Status
+- `@simulatte/webgpu`
+  - full headless WebGPU package
+  - includes the native runtime, raw WebGPU surface, and the same Doe helper contract
+- `@simulatte/webgpu/compute`
+  - narrower compute-first facade over the same underlying runtime
+- `@simulatte/webgpu-doe`
+  - helper-only package
+  - no runtime transport
+  - meant for reuse, custom binding, and independent versioning of the Doe helper contract
 
-Current package target:
-- macOS arm64: prebuilt library and tested package path
+Normal users can keep using `@simulatte/webgpu` or `@simulatte/webgpu/compute`
+directly. `@simulatte/webgpu-doe` is the explicit extraction for advanced
+composition and for making the Doe helper layer independently publishable.
 
-Backend readiness:
+## Start here
 
-| Backend | Compute | Render | WGSL compiler | Status |
-|---------|---------|--------|---------------|--------|
-| **Metal** (macOS) | Production | Basic (no vertex/index) | WGSL -> MSL (AST-based) | Ready for package use |
-| **Vulkan** (Linux) | WIP | Not started | WGSL -> SPIR-V needed | Experimental |
-| **D3D12** (Windows) | WIP | Not started | WGSL -> HLSL/DXIL needed | Experimental |
+The same simple compute pass, shown first as the helper-only package mounted on
+the compute runtime and then as a direct bind over an already-created device.
 
-Metal currently covers the package's intended use: bind groups 0-3, buffer
-map/unmap, indirect dispatch, `shader-f16`, subgroups, override constants,
-workgroup shared memory, multiple entry points, textures, samplers, and basic
-render-pass execution.
+### 1. Bind Doe to `@simulatte/webgpu/compute`
 
-Vulkan and D3D12 already have native runtime paths for instance creation,
-compute dispatch, and buffer upload, but they still need shader translation,
-bind group management, buffer map/unmap, textures, and render pipelines.
+```js
+import { requestDevice } from "@simulatte/webgpu/compute";
+import { createDoeNamespace } from "@simulatte/webgpu-doe";
 
-Performance snapshot from the Fawn Dawn-vs-Doe harness on Apple Silicon with
-strict comparability checks:
+const doe = createDoeNamespace({ requestDevice });
+const gpu = await doe.requestDevice();
 
-- Compute e2e: 1.5x faster (0.23ms vs 0.35ms, 4096 threads)
-- Buffer upload: faster across 1 KB to 4 GB (8 sizes claimable)
-- Atomics: workgroup atomic and non-atomic both claimable
-- Matrix-vector multiply: 3 variants claimable
-- Concurrent execution: claimable
-- Zero-init workgroup memory: claimable
-- Draw throughput: 200k draws claimable
-- Binary size: about 2 MB vs Dawn's about 11 MB
+const src = gpu.buffer.create({ data: Float32Array.of(1, 2, 3, 4) });
+const dst = gpu.buffer.create({ size: src.size, usage: "storageReadWrite" });
 
-19 of 30 workloads are currently claimable. The remaining 11 are limited by
-per-command Metal command buffer creation overhead (~350us vs Dawn's ~30us).
-See `fawn/bench/` and [`status.md`](../../status.md) for methodology and the
-broader backend matrix.
+await gpu.kernel.run({
+  code: `
+    @group(0) @binding(0) var<storage, read> src: array<f32>;
+    @group(0) @binding(1) var<storage, read_write> dst: array<f32>;
 
-## API surface
+    @compute @workgroup_size(4)
+    fn main(@builtin(global_invocation_id) gid: vec3u) {
+      let i = gid.x;
+      dst[i] = src[i] * 2.0;
+    }
+  `,
+  bindings: [src, dst],
+  workgroups: 1,
+});
 
-Compute:
+console.log(await gpu.buffer.read({ buffer: dst, type: Float32Array }));
+```
 
-- `create()` / `setupGlobals()` / `requestAdapter()` / `requestDevice()`
-- `device.createBuffer()` / `device.createShaderModule()` (WGSL)
-- `device.createComputePipeline()` / `device.createComputePipelineAsync()`
-- `device.createBindGroupLayout()` / `device.createBindGroup()`
-- `device.createPipelineLayout()` / `pipeline.getBindGroupLayout()`
-- `device.createCommandEncoder()` / `encoder.beginComputePass()`
-- `pass.setPipeline()` / `pass.setBindGroup()` / `pass.dispatchWorkgroups()`
-- `pass.dispatchWorkgroupsIndirect()`
-- `encoder.copyBufferToBuffer()` / `queue.submit()` / `queue.writeBuffer()`
-- `buffer.mapAsync()` / `buffer.getMappedRange()` / `buffer.unmap()`
-- `queue.onSubmittedWorkDone()`
+### 2. Bind Doe to an existing device
 
-Render:
+```js
+import { requestDevice } from "@simulatte/webgpu";
+import doe from "@simulatte/webgpu-doe";
 
-- `device.createTexture()` / `texture.createView()` / `device.createSampler()`
-- `device.createRenderPipeline()` / `encoder.beginRenderPass()`
-- `renderPass.setPipeline()` / `renderPass.draw()` / `renderPass.end()`
+const device = await requestDevice();
+const gpu = doe.bind(device);
+```
 
-Device capabilities:
+### 3. Inject your own request path
 
-- `device.limits` / `adapter.limits`
-- `device.features` / `adapter.features` with `shader-f16`
+```js
+import { createDoeNamespace } from "@simulatte/webgpu-doe";
 
-Current gaps:
-- Canvas and surface presentation
-- Vertex and index buffer binding in render passes
-- Full render pipeline descriptor parsing
+const doe = createDoeNamespace({
+  async requestDevice(options) {
+    return createMyCompatibleDevice(options);
+  },
+});
 
-## More examples
+const gpu = await doe.requestDevice();
+```
 
-```js
-import { setupGlobals } from '@simulatte/webgpu-doe';
+The only requirement is that the bound device exposes the WebGPU methods Doe
+uses internally:
 
-setupGlobals(globalThis);
-const adapter = await navigator.gpu.requestAdapter();
-```
+- `createBuffer`
+- `createShaderModule`
+- `createBindGroupLayout`
+- `createPipelineLayout`
+- `createComputePipeline`
+- `createBindGroup`
+- `createCommandEncoder`
+- `queue.writeBuffer`
+- `queue.submit`
+- optionally `queue.onSubmittedWorkDone`
 
-### Provider info
+## API surface
 
-```js
-import { providerInfo } from '@simulatte/webgpu-doe';
-console.log(providerInfo());
-// { module: '@simulatte/webgpu-doe', loaded: true, doeNative: true, ... }
-```
+### `createDoeNamespace({ requestDevice } = {})`
 
-## Configuration
+Creates a Doe namespace object with:
 
-The library search order:
+- `requestDevice(options?)`
+- `bind(device)`
 
-1. `DOE_WEBGPU_LIB` environment variable (full path)
-2. `<package>/prebuilds/<platform>-<arch>/libdoe_webgpu.{ext}`
-3. `<workspace>/zig/zig-out/lib/libdoe_webgpu.{ext}` (monorepo layout)
-4. `<cwd>/zig/zig-out/lib/libdoe_webgpu.{ext}`
+If `requestDevice` is omitted, `doe.requestDevice()` throws an explicit error
+and `doe.bind(device)` remains available.
 
-## Building from source
+### `doe`
 
-Requires [Zig](https://ziglang.org/download/) (0.15+).
+Default namespace created with no injected `requestDevice(...)`. This is
+useful when you want only `doe.bind(device)`.
 
-```sh
-git clone https://github.com/clocksmith/fawn
-cd fawn/zig
-zig build dropin
-# Output: zig-out/lib/libdoe_webgpu.{dylib,so}
-```
+## Release contract
+
+This package intentionally owns only the helper contract. It should stay
+transport-free. Runtime loading and raw WebGPU surfaces belong in
+`@simulatte/webgpu`.
 
 ## License
 
-ISC
+Apache-2.0