@simulatte/webgpu-doe 0.1.3 → 0.3.2

package/package.json

@@ -1,9 +1,51 @@
 {
   "name": "@simulatte/webgpu-doe",
-  "version": "0.1.3",
-  "description": "Deprecated redirect package. Use @simulatte/webgpu instead.",
-  "license": "ISC",
+  "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": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    }
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "assets/",
+    "examples/",
+    "src/",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "test": "node ./test-node.js",
+    "smoke": "node ./test-node.js"
+  },
+  "keywords": [
+    "webgpu",
+    "doe",
+    "helpers",
+    "compute",
+    "wgsl"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/clocksmith/fawn.git",
+    "directory": "nursery/webgpu-doe"
+  },
+  "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;
+}