@simulatte/webgpu-doe 0.1.2 → 0.3.2

package/assets/fawn-icon-main.svg

@@ -0,0 +1,222 @@
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 width="100%" viewBox="0 0 1024 912" enable-background="new 0 0 1024 912" xml:space="preserve">
+<path fill="#000000" opacity="1.000000" stroke="none" 
+	d="
+M561.720642,622.786377 
+	C553.729919,627.969910 546.010742,632.904602 538.369385,637.957031 
+	C535.816589,639.644958 533.450928,639.890869 530.410156,639.033569 
+	C496.780701,629.553040 463.095703,620.269409 429.449615,610.847229 
+	C426.789368,610.102295 424.805511,610.437683 422.541382,612.110107 
+	C391.322327,635.171021 360.024384,658.125061 328.777100,681.147827 
+	C326.949310,682.494568 324.665314,683.427673 323.501312,686.239502 
+	C332.812775,697.053833 342.244049,708.005188 351.672821,718.958740 
+	C355.911652,723.883118 360.213379,728.755676 364.352844,733.762329 
+	C366.395416,736.232727 368.639038,736.733826 371.815857,736.326721 
+	C395.402374,733.303955 419.023499,730.552856 442.621857,727.620361 
+	C456.483551,725.897827 470.323303,723.998779 484.173126,722.180664 
+	C486.255676,721.907288 488.363617,721.164978 491.108093,722.817322 
+	C487.332245,727.182861 483.732910,731.417847 480.055420,735.583801 
+	C462.526154,755.441467 444.874146,775.192200 427.513458,795.195923 
+	C423.789734,799.486572 418.971436,798.620178 414.630371,799.096924 
+	C382.224335,802.655823 349.776764,805.835388 317.347687,809.186890 
+	C314.016266,809.531250 311.309998,808.870239 308.652527,806.577637 
+	C293.512878,793.516846 278.267792,780.577148 262.963531,767.709290 
+	C260.426514,765.575989 259.164886,763.535583 259.918427,760.033569 
+	C264.604370,738.255676 269.179749,716.453125 273.615570,694.622925 
+	C274.479248,690.372375 276.427002,687.729614 280.374420,685.634399 
+	C319.514038,664.859131 358.537842,643.865662 397.604797,622.953308 
+	C400.812408,621.236328 404.096161,619.661682 407.150513,617.578186 
+	C393.732697,622.716980 380.298035,627.812378 366.900330,633.003174 
+	C333.982697,645.756592 301.074982,658.535889 268.189453,671.371765 
+	C265.848175,672.285645 263.776581,672.206299 261.437622,671.452393 
+	C246.070526,666.499451 230.683975,661.605286 215.267365,656.808960 
+	C212.194107,655.852783 210.103867,654.263794 208.742416,651.246216 
+	C187.855164,604.951904 166.902298,558.687256 145.906128,512.442200 
+	C144.987503,510.418915 145.157257,508.623322 145.793808,506.672943 
+	C157.670425,470.283783 169.540680,433.892578 181.402237,397.498535 
+	C184.754959,387.211609 188.098938,376.921692 191.383820,366.613068 
+	C191.825394,365.227356 192.462067,363.790863 191.736496,361.545654 
+	C184.453964,359.555237 176.801498,357.450378 169.141418,355.373566 
+	C159.671265,352.806030 150.205750,350.220001 140.714081,347.734192 
+	C138.026398,347.030243 135.910217,345.670532 134.053238,343.621948 
+	C112.234657,319.551697 90.411766,295.485046 68.485085,271.513458 
+	C65.887260,268.673370 65.523636,265.257629 64.848785,261.891754 
+	C56.576641,220.633774 48.364689,179.363693 40.146648,138.094879 
+	C38.665779,130.658356 37.227734,123.213303 35.690380,115.366211 
+	C40.433868,114.928268 44.042770,116.909630 47.717518,118.043434 
+	C99.263542,133.947342 150.750153,150.044006 202.309982,165.902649 
+	C207.699402,167.560303 211.560791,170.671005 215.235367,174.679153 
+	C241.804993,203.660690 268.524261,232.505081 295.080139,261.499176 
+	C297.910065,264.588959 300.303467,265.394440 304.533447,264.020844 
+	C329.391846,255.948639 354.393036,248.317032 379.308838,240.419434 
+	C382.485748,239.412445 385.346466,239.393539 388.532715,240.395325 
+	C421.252045,250.682495 454.005737,260.860382 486.755432,271.050873 
+	C489.222900,271.818634 491.161682,273.269073 492.938354,275.105591 
+	C506.840179,289.475433 520.896973,303.698212 534.613708,318.241974 
+	C537.627380,321.437347 540.515869,321.205933 544.030640,320.376068 
+	C573.657593,313.380890 603.293335,306.422607 632.920532,299.428467 
+	C643.606567,296.905823 654.267090,294.274200 664.964844,291.803223 
+	C666.486206,291.451813 668.108032,290.460999 669.814636,291.591919 
+	C670.192810,294.030426 668.415833,295.596619 667.317017,297.350250 
+	C636.976929,345.773132 606.644836,394.201294 576.122803,442.509460 
+	C573.378540,446.852936 573.123657,450.225891 575.521301,454.824280 
+	C590.533936,483.616547 605.209656,512.584290 620.125061,541.427734 
+	C621.919067,544.897034 622.520325,548.027954 621.308167,551.859314 
+	C617.644714,563.439331 614.236816,575.101990 610.866333,586.771973 
+	C609.790649,590.496399 607.782532,593.152527 604.463562,595.254456 
+	C590.248535,604.256714 576.158325,613.456116 561.720642,622.786377 
+M389.160492,357.400208 
+	C377.895325,350.594940 366.583130,343.865631 355.395233,336.935638 
+	C352.259521,334.993286 349.793701,335.102173 346.783813,337.256500 
+	C319.826477,356.550690 292.800842,375.749664 265.745667,394.906525 
+	C263.544037,396.465393 262.329681,398.155731 262.033478,400.936432 
+	C259.216034,427.388336 256.314209,453.831604 253.309174,480.262817 
+	C252.844360,484.351013 254.656021,487.205566 257.028107,490.134552 
+	C275.376831,512.791016 293.711456,535.459351 311.910980,558.235474 
+	C314.253540,561.167053 316.995422,562.697571 320.491333,563.678040 
+	C386.520844,582.196045 452.576324,600.625305 518.489746,619.548950 
+	C527.676208,622.186401 535.468384,622.854553 542.702759,615.858521 
+	C543.638672,614.953491 544.956970,614.450012 546.077148,613.728088 
+	C555.126221,607.895935 564.170349,602.055908 573.225342,596.212341 
+	C572.119995,593.866333 570.705750,592.725342 569.262939,591.600159 
+	C560.328918,584.632874 551.468567,577.568359 542.430176,570.739441 
+	C539.547424,568.561401 538.424866,566.530396 539.555725,562.775269 
+	C542.047974,554.499207 544.070374,546.077332 546.119263,537.674683 
+	C546.786133,534.939697 548.161682,533.386230 550.904663,532.646423 
+	C557.971252,530.740662 564.995850,528.676331 572.019470,526.614807 
+	C578.174683,524.808228 584.305725,522.919434 590.221558,521.135132 
+	C590.295715,518.215515 589.053711,516.567627 588.162903,514.813843 
+	C578.734070,496.250458 569.299255,477.690063 559.808594,459.158295 
+	C558.483154,456.570251 557.825989,453.944122 557.789429,451.028076 
+	C557.463684,425.041412 557.033997,399.056000 556.730774,373.069092 
+	C556.698120,370.272583 556.065369,367.962158 554.337524,365.703094 
+	C547.252747,356.439758 540.328613,347.053741 533.316956,337.734192 
+	C532.307068,336.391846 531.465698,334.758179 528.940552,334.188080 
+	C529.409485,336.139984 529.619141,337.603485 530.110901,338.965118 
+	C533.898621,349.453766 537.650574,359.957184 541.622253,370.376465 
+	C542.796143,373.455994 543.060059,376.288116 542.416260,379.561615 
+	C539.176270,396.036377 536.303406,412.583588 533.037476,429.052979 
+	C532.198181,433.285675 532.293274,437.893341 529.599854,442.109650 
+	C482.724701,413.845673 436.248322,385.822113 389.160492,357.400208 
+M56.569050,140.456726 
+	C57.268250,143.874146 57.942520,147.296906 58.670532,150.708176 
+	C65.677315,183.540237 72.641701,216.381531 79.761696,249.189041 
+	C80.832840,254.124680 81.227097,259.218994 85.018944,263.441406 
+	C104.823868,285.495239 124.405800,307.749481 144.034897,329.960876 
+	C145.854980,332.020386 147.803009,333.319489 150.680099,333.860687 
+	C177.804352,338.962921 204.896912,344.234528 231.987488,349.514313 
+	C241.745834,351.416138 251.037933,353.534485 260.474915,346.848877 
+	C269.175598,340.684998 269.619690,341.523285 265.387604,331.394623 
+	C245.881470,284.710724 226.412018,238.011368 207.056107,191.265106 
+	C205.715347,188.027054 203.863800,186.261200 200.563248,185.145782 
+	C160.363266,171.560287 120.209190,157.838913 80.039070,144.164978 
+	C73.424332,141.913315 66.805107,139.672226 60.154423,137.530396 
+	C58.289543,136.929840 55.923115,136.065369 56.569050,140.456726 
+z"/>
+<path fill="#000000" opacity="1.000000" stroke="none" 
+	d="
+M731.231934,682.461914 
+	C736.633423,680.504578 737.072327,679.305176 733.911377,674.890747 
+	C717.714111,652.270508 701.466064,629.686707 685.232239,607.092712 
+	C674.152527,591.672180 663.097595,576.233704 651.947998,560.863831 
+	C650.435486,558.778687 650.035583,556.890381 650.816833,554.402344 
+	C664.624878,510.428223 678.360046,466.431152 692.155151,422.452911 
+	C692.535828,421.239624 692.594788,419.770050 693.996399,418.885345 
+	C695.775146,418.608185 696.389282,420.199554 697.320312,421.264954 
+	C721.212219,448.607300 745.334717,475.754272 768.815857,503.445160 
+	C774.828674,510.535950 781.631042,514.719055 790.249939,517.647888 
+	C836.906738,533.502625 883.415283,549.793762 929.977234,565.927734 
+	C931.684448,566.519287 933.415894,567.041077 936.217712,567.943970 
+	C947.106567,519.674866 957.898376,471.835693 968.690186,423.996552 
+	C972.131714,429.442688 972.162231,435.309631 973.138062,440.919861 
+	C979.203796,475.792755 984.433228,510.825745 991.281860,545.540955 
+	C994.246094,560.566711 991.265930,574.089050 987.032837,587.948669 
+	C983.679626,598.927429 980.492371,609.957031 977.277161,620.977478 
+	C976.657471,623.101196 975.759949,624.940857 974.096680,626.500854 
+	C952.954529,646.330750 931.828552,666.178223 910.776245,686.103455 
+	C908.674316,688.092834 906.513794,688.984924 903.652954,688.949951 
+	C899.545715,688.899719 895.381104,688.465210 891.387939,689.559937 
+	C890.740234,691.802307 892.010681,693.316650 892.757019,694.925049 
+	C897.734436,705.651123 902.706238,716.380676 907.817871,727.042908 
+	C908.992554,729.493164 909.164062,731.544678 907.919678,734.079102 
+	C903.222778,743.644836 898.566772,753.240356 894.283508,762.995117 
+	C892.475708,767.112061 890.086304,768.469238 885.566895,768.458862 
+	C819.580444,768.307983 753.593567,768.361206 687.606750,768.364746 
+	C665.111267,768.365967 642.615601,768.398621 620.120361,768.325684 
+	C616.840454,768.315063 613.977173,768.965454 611.194214,770.816589 
+	C587.340698,786.683594 563.404663,802.426636 539.562012,818.309875 
+	C536.385132,820.426208 533.213501,821.462402 529.348572,821.449341 
+	C497.188782,821.340576 465.028351,821.405029 432.868164,821.376282 
+	C431.258209,821.374817 429.553650,821.838013 427.615570,820.654785 
+	C428.738312,817.837585 431.083252,815.891113 432.972290,813.740784 
+	C462.877960,779.697327 493.057037,745.890747 522.634949,711.565857 
+	C528.071411,705.256897 534.605713,705.750427 541.086548,704.942688 
+	C579.859314,700.110413 618.661011,695.507141 657.464600,690.925781 
+	C681.907166,688.039978 706.370056,685.326477 731.231934,682.461914 
+M503.772980,757.260376 
+	C490.344299,772.708374 476.915588,788.156372 463.486877,803.604309 
+	C476.103638,804.763000 487.897797,804.808472 499.691467,804.749390 
+	C510.005981,804.697693 520.971497,806.678833 530.450806,803.806396 
+	C539.932312,800.933350 547.956055,793.198608 556.556702,787.501221 
+	C558.981445,785.895020 561.790039,784.678650 563.506836,782.197998 
+	C563.099243,781.457642 562.968811,780.891052 562.613220,780.622437 
+	C547.470825,769.184448 532.304871,757.777710 517.152832,746.352539 
+	C515.169067,744.856812 513.806519,745.820129 512.479919,747.346741 
+	C509.750305,750.487732 506.988220,753.600464 503.772980,757.260376 
+z"/>
+<path fill="#000000" opacity="1.000000" stroke="none" 
+	d="
+M442.079773,131.096130 
+	C457.800568,112.627243 473.291626,94.427544 489.449097,75.444923 
+	C493.529510,85.120598 497.185028,93.637383 500.719482,102.204109 
+	C506.495819,116.204674 512.038696,130.304092 518.009521,144.220490 
+	C520.044678,148.963852 520.779846,153.800201 520.931396,158.775818 
+	C521.479065,176.751144 521.848450,194.731827 522.347717,212.708771 
+	C522.424500,215.472504 521.754272,217.874130 520.364868,220.279236 
+	C513.534912,232.101974 506.721710,243.937576 500.153809,255.906509 
+	C498.311310,259.264191 496.317963,260.171509 492.587524,259.258820 
+	C460.289185,251.356903 427.946198,243.637665 395.627441,235.818893 
+	C389.245697,234.274994 389.202698,234.055267 391.016357,227.726776 
+	C395.736450,211.256729 400.497772,194.798157 405.120117,178.300674 
+	C406.180176,174.517181 407.934235,171.279755 410.482666,168.305206 
+	C420.992371,156.038071 431.403015,143.686111 442.079773,131.096130 
+z"/>
+<path fill="#000000" opacity="1.000000" stroke="none" 
+	d="
+M252.998932,712.786987 
+	C250.317963,725.394775 247.725464,737.587036 245.158737,749.784668 
+	C243.936020,755.595276 243.508926,755.814148 237.893997,754.554443 
+	C216.489075,749.752686 195.083923,744.949646 173.643234,740.311829 
+	C169.245514,739.360596 165.697144,737.598572 162.588989,734.212402 
+	C153.809341,724.647400 144.771652,715.317749 135.758499,705.969727 
+	C133.405960,703.529724 132.567398,700.848022 132.547668,697.449341 
+	C132.463577,682.968018 132.131790,668.487671 131.830811,654.008240 
+	C131.773529,651.252686 132.100418,648.758423 134.133392,646.643616 
+	C145.671478,634.641052 157.163727,622.594360 168.693634,610.583862 
+	C169.240112,610.014587 169.996033,609.646362 170.658371,609.181763 
+	C173.133591,610.502014 173.506210,612.985535 174.467651,615.005920 
+	C182.190201,631.234131 189.908066,647.465454 197.451523,663.777222 
+	C199.122818,667.391174 201.509567,669.478210 205.316818,670.676331 
+	C221.501770,675.769409 237.583847,681.189636 253.771881,686.272522 
+	C257.208191,687.351440 258.236877,688.890198 257.385834,692.387329 
+	C255.775284,699.005371 254.507935,705.706787 252.998932,712.786987 
+z"/>
+<path fill="#000000" opacity="1.000000" stroke="none" 
+	d="
+M862.719971,430.887146 
+	C858.402466,432.035706 854.776245,434.308868 849.628052,434.442932 
+	C851.871216,412.718262 854.065735,391.465057 856.410034,368.761017 
+	C878.879822,382.735718 900.196106,395.992981 921.512329,409.250244 
+	C921.524780,409.751282 921.537170,410.252350 921.549622,410.753387 
+	C902.062439,417.418610 882.575317,424.083862 862.719971,430.887146 
+z"/>
+<path fill="#000000" opacity="1.000000" stroke="none" 
+	d="
+M821.230652,403.927551 
+	C819.668640,412.961365 820.023743,421.815399 817.718933,431.213898 
+	C801.171509,421.056610 785.291016,411.308716 769.410522,401.560822 
+	C769.423279,401.011597 769.436035,400.462341 769.448792,399.913116 
+	C786.970764,393.854431 804.492676,387.795776 822.784790,381.470795 
+	C823.206604,389.521515 821.328735,396.452484 821.230652,403.927551 
+z"/>
+</svg>

package/examples/with-webgpu-compute.js

@@ -0,0 +1,25 @@
+import { requestDevice } from '@simulatte/webgpu/compute';
+import { createDoeNamespace } from '@simulatte/webgpu-doe';
+
+const doe = createDoeNamespace({ requestDevice });
+const gpu = await doe.requestDevice();
+
+const src = gpu.buffer.create({ data: Float32Array.of(1, 2, 3, 4) });
+const dst = gpu.buffer.create({ size: src.size, usage: 'storageReadWrite' });
+
+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>;
+
+    @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,
+});
+
+console.log(await gpu.buffer.read({ buffer: dst, type: Float32Array }));

package/package.json

@@ -1,46 +1,51 @@
 {
   "name": "@simulatte/webgpu-doe",
-  "version": "0.1.2",
-  "description": "Doe WebGPU runtime for Node.js — native Zig GPU backends (Metal, Vulkan) via N-API",
+  "version": "0.3.2",
+  "description": "Standalone Doe helper namespace for WebGPU-compatible runtimes",
   "type": "module",
+  "sideEffects": false,
   "main": "./src/index.js",
+  "types": "./src/index.d.ts",
   "exports": {
-    ".": "./src/index.js",
-    "./node": "./src/index.js"
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    }
+  },
+  "engines": {
+    "node": ">=18"
   },
   "files": [
-    "src/index.js",
-    "native/",
-    "binding.gyp",
-    "prebuilds/",
-    "README.md"
+    "assets/",
+    "examples/",
+    "src/",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md"
   ],
   "scripts": {
-    "build:addon": "node-gyp rebuild"
+    "test": "node ./test-node.js",
+    "smoke": "node ./test-node.js"
   },
-  "os": [
-    "darwin"
-  ],
-  "cpu": [
-    "arm64"
-  ],
   "keywords": [
     "webgpu",
     "doe",
-    "gpu",
+    "helpers",
     "compute",
-    "headless",
-    "node",
-    "native",
-    "napi",
-    "metal",
-    "vulkan",
-    "zig"
+    "wgsl"
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/clocksmith/fawn",
+    "url": "git+https://github.com/clocksmith/fawn.git",
     "directory": "nursery/webgpu-doe"
   },
-  "license": "ISC"
+  "homepage": "https://github.com/clocksmith/fawn/tree/main/nursery/webgpu-doe",
+  "bugs": {
+    "url": "https://github.com/clocksmith/fawn/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Fawn",
+  "license": "Apache-2.0"
 }

package/src/index.d.ts

@@ -0,0 +1,125 @@
+export type DoeBufferUsage =
+  | "upload"
+  | "readback"
+  | "uniform"
+  | "storageRead"
+  | "storageReadWrite";
+
+export type DoeWorkgroups = number | [number, number] | [number, number, number];
+
+export type DoeBindingAccess = "uniform" | "storageRead" | "storageReadWrite";
+
+export interface DoeCreateBufferOptions {
+  size?: number;
+  usage?: DoeBufferUsage | DoeBufferUsage[] | number;
+  data?: ArrayBufferView | ArrayBuffer;
+  label?: string;
+  mappedAtCreation?: boolean;
+}
+
+export interface DoeReadBufferSubrangeOptions {
+  size?: number;
+  offset?: number;
+  label?: string;
+}
+
+export interface DoeReadBufferOptions<T extends ArrayBufferView = ArrayBufferView>
+  extends DoeReadBufferSubrangeOptions {
+  buffer: unknown;
+  type: { new (buffer: ArrayBuffer): T };
+}
+
+export interface DoeBindingBuffer<TBuffer> {
+  buffer: TBuffer;
+  access?: DoeBindingAccess;
+}
+
+export interface DoeComputeInputDataOptions {
+  data: ArrayBufferView | ArrayBuffer;
+  usage?: DoeBufferUsage | DoeBufferUsage[];
+  access?: DoeBindingAccess;
+  label?: string;
+}
+
+export type DoeComputeInput<TBuffer> =
+  | ArrayBufferView
+  | ArrayBuffer
+  | TBuffer
+  | DoeBindingBuffer<TBuffer>
+  | DoeComputeInputDataOptions;
+
+export interface DoeComputeOnceOutputOptions<T extends ArrayBufferView> {
+  type: { new (buffer: ArrayBuffer): T };
+  size?: number;
+  likeInput?: number;
+  usage?: DoeBufferUsage | DoeBufferUsage[];
+  access?: DoeBindingAccess;
+  label?: string;
+  read?: DoeReadBufferSubrangeOptions;
+}
+
+export interface DoeComputeOnceOptions<TBuffer, T extends ArrayBufferView> {
+  code: string;
+  entryPoint?: string;
+  inputs?: Array<DoeComputeInput<TBuffer>>;
+  output: DoeComputeOnceOutputOptions<T>;
+  workgroups: DoeWorkgroups;
+  label?: string;
+}
+
+export interface DoeKernelCreateOptions<TBuffer> {
+  code: string;
+  entryPoint?: string;
+  bindings?: Array<TBuffer | DoeBindingBuffer<TBuffer>>;
+  workgroups: DoeWorkgroups;
+  label?: string;
+}
+
+export interface DoeKernelDispatchOptions<TBuffer> {
+  bindings?: Array<TBuffer | DoeBindingBuffer<TBuffer>>;
+  workgroups: DoeWorkgroups;
+  label?: string;
+}
+
+export interface BoundDoeBufferNamespace<TBuffer> {
+  create(options: DoeCreateBufferOptions): TBuffer;
+  read<T extends ArrayBufferView>(
+    options: DoeReadBufferOptions<T>,
+  ): Promise<T>;
+}
+
+export interface BoundDoeKernelNamespace<
+  TBuffer,
+  TKernel,
+  TKernelOptions,
+> {
+  run(options: TKernelOptions): Promise<void>;
+  create(options: TKernelOptions): TKernel;
+}
+
+export interface BoundDoeNamespace<
+  TDevice,
+  TBuffer,
+  TKernel,
+  TKernelOptions,
+> {
+  readonly device: TDevice;
+  readonly buffer: BoundDoeBufferNamespace<TBuffer>;
+  readonly kernel: BoundDoeKernelNamespace<
+    TBuffer,
+    TKernel,
+    TKernelOptions
+  >;
+  compute<T extends ArrayBufferView>(
+    options: DoeComputeOnceOptions<TBuffer, T>,
+  ): Promise<T>;
+}
+
+export interface DoeNamespace<
+  TDevice,
+  TBoundDoe,
+  TRequestDeviceOptions = unknown,
+> {
+  requestDevice(options?: TRequestDeviceOptions): Promise<TBoundDoe>;
+  bind(device: TDevice): TBoundDoe;
+}