Refactor - Drop commonjs syntax

.gitignore

@@ -11,7 +11,6 @@ TODOS.md
 NOTES.md
 run-wpt.*
 all-checks.sh
-tests/junk.mjs
 tests/junk-*
 yarn.lock
 issues

.npmignore

@@ -4,12 +4,11 @@
 .env
 .gitmodules
 
-eslint.config.mjs
+eslint.config.js
 build.rs
 Cargo.*
 Cross.toml
 NOTES.md
-dummy.mjs
 all-checks.sh
 run-wpt.sh
 

.scripts/move-artifact.mjs → .scripts/move-artifact.js

@@ -5,7 +5,7 @@ import {
   destReleaseFile,
   destDebugFile,
   deleteDevArtifacts,
-} from './utils/dev-artifacts-helpers.mjs';
+} from './utils/dev-artifacts-helpers.js';
 
 const { platform } = process;
 const profile = process.argv.includes('--release') ? 'release' : 'debug';

.scripts/retrieve-artifacts.mjs → .scripts/retrieve-artifacts.js

@@ -3,7 +3,7 @@ import { Octokit } from 'octokit';
 import fs from 'node:fs';
 import { execSync } from 'node:child_process';
 
-import { deleteDevArtifacts } from './utils/dev-artifacts-helpers.mjs';
+import { deleteDevArtifacts } from './utils/dev-artifacts-helpers.js';
 
 // --------------------------------------------------------------
 console.log('');

.scripts/wpt-harness.mjs → .scripts/wpt-harness.js

@@ -6,7 +6,7 @@ import wptRunner from 'wpt-runner';
 import chalk from 'chalk';
 import { program } from 'commander';
 
-import * as nodeWebAudioAPI from '../index.mjs';
+import * as nodeWebAudioAPI from '../index.js';
 
 // mocks
 import createXMLHttpRequest from './wpt-mock/XMLHttpRequest.js';

.scripts/wpt-mock/XMLHttpRequest.js

@@ -1,5 +1,5 @@
-const fs = require('node:fs');
-const path = require('node:path');
+import fs from 'node:fs';
+import path from 'node:path';
 
 // @note - once all of them are listed, make a pull request to wpt to harmonize all file loading calls
 const relativePathPatches = {
@@ -8,7 +8,7 @@ const relativePathPatches = {
 
 // to be passed to wtp-runner step
 // window.XMLHttpRequest = XMLHttpRequest;
-module.exports = function createXMLHttpRequest(basepath) {
+export default function createXMLHttpRequest(basepath) {
   return class XMLHttpRequest {
     constructor() {
       this._pathname;

.scripts/wpt-mock/fetch.js

@@ -1,8 +1,8 @@
 // required in node_modules/wpt_runner/testharness/idlharness.js, cf `fetch_spec`
-const fs = require('node:fs');
-const path = require('node:path');
+import fs from 'node:fs';
+import path from 'node:path';
 
-module.exports = function createFetch(basePath) {
+export default function createFetch(basePath) {
   return function fetch(pathname) {
     pathname = path.join(basePath, pathname);
 

.scripts/wpt-mock/requestAnimationFrame.js

@@ -21,7 +21,7 @@ const animFrame = () => {
   setTimeout(animFrame, time - t);
 };
 
-module.exports.requestAnimationFrame = requestAnimationFrame = func => {
+export const requestAnimationFrame = func => {
   // lazily start timer
   if (!launched) {
     launched = true;
@@ -32,6 +32,6 @@ module.exports.requestAnimationFrame = requestAnimationFrame = func => {
   return funcs.length - 1;
 };
 
-module.exports.cancelAnimationFrame = cancelAnimationFrame = id => {
+export const cancelAnimationFrame = id => {
   funcs[id] = skip;
 };

.scripts/wpt-mock/wpt-buffer-loader.js → .scripts/wpt-mock/wpt-buffer-loader-test.js

@@ -1,7 +1,7 @@
-const path = require('node:path');
+import path from 'node:path';
 
-const createXMLHttpRequest = require('./XMLHttpRequest.js');
-const { OfflineAudioContext } = require('../../index.cjs');
+import createXMLHttpRequest from './XMLHttpRequest.js';
+import { OfflineAudioContext } from '../../index.js';
 
 // create a XMLHttpRequest to be passed to the runner
 // can be configured to handle the difference between process.cwd() and given path

README.md

@@ -21,8 +21,7 @@ npm install [--save] node-web-audio-api
 
 ```js
 import { AudioContext, OscillatorNode, GainNode } from 'node-web-audio-api';
-// or using old fashioned commonjs syntax:
-// const { AudioContext, OscillatorNode, GainNode } = require('node-web-audio-api');
+// audioContext is resumed by default
 const audioContext = new AudioContext();
 
 setInterval(() => {
@@ -43,33 +42,38 @@ setInterval(() => {
 }, 80);
 ```
 
-### Running the Examples
+## Running the Examples
 
 To run all examples locally on your machine you will need to:
 
-1. Install Rust toolchain
+1. Clone the repo and build the binary on your machine
 ```sh
-curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+git clone https://github.com/ircam-ismm/node-web-audio-api.git
 ```
 
-2. Clone the repo and build the binary on your machine
+2. Install dependencies in the examples directory
 ```sh
-git clone https://github.com/ircam-ismm/node-web-audio-api.git
-cd node-web-audio-api
-npm install
-npm run build
+npm run examples:install
+# Basically a shortcut for `cd examples && npm install`
 ```
 
 3. Run the examples from the project's root directory
 ```sh
 node examples/granular-scrub.js
 ```
 
+_Note that in the examples, the library is loaded through a proxy which loads either from the
+`examples/node_modules` directory, or from the root of the project if you want to test
+against a local build (see [Build](#build)).
+
+In this last case, make sure to run `npm run examples:clean` to delete any previously
+installed `examples/node_modules`._
+
 ## Caveats
 
 - `AudioBuffer#getChannelData` is implemented but not reliable in some situations. Your should prefer `AudioBuffer#copyToChannel` and `AudioBuffer#copyFromChannel` when you want to access or manipulate the underlying samples in a safe way.
 - `Streams`: only a minimal audio input stream and the `MediaStreamSourceNode` are provided. All other `MediaStream` features are left on the side for now as they principally concern a different API specification, which is not a trivial problem.
-- `new AudioContext({sinkId:{type:'none'}})`: if your system has no audio sinks (e.g. docker image) use `{sinkId:{type:'none'}}` when initializing `AudioContext`, else it will crash with `DeviceNotAvailable` [see MDN](https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/AudioContext#sinkid)
+- `new AudioContext({ sinkId: { type:'none' } })`: if your system has no audio sinks (e.g. docker image, CI) use `{ sinkId: { type:'none' } }` when initializing `AudioContext`, else it will crash with `DeviceNotAvailable` [see MDN](https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/AudioContext#sinkid)
 
 ## Supported Platforms - Prebuilt Binaries
 
@@ -93,8 +97,7 @@ We provide prebuilt binaries for the following platforms:
 
 - All provided Linux binaries are built with the `jack` flag, which should work either with properly configured [Jack](https://jackaudio.org/) or [pipewire-jack](https://pipewire.org/) backends. If this is a limitation for you, please fill an [issue](https://github.com/ircam-ismm/node-web-audio-api/issues) and we will see what we can do.
 
-
-## Manual Build
+### Manually install and build the library
 
 If prebuilt binaries are not shippped for your platform, you will need to:
 
@@ -119,7 +122,7 @@ Be aware that the package won't be listed on your `package.json` file, and that
 
 ## Notes for Linux users
 
-### Build
+### Dependencies
 
 To build the library, you will need to manually install the `libasound2-dev` package:
 
@@ -133,7 +136,7 @@ Optionally, if you use the Jack Audio Backend, the `libjack-jackd2-dev` package:
 sudo apt install libjack-jackd2-dev
 ```
 
-In such case, you can use the `npm run build:jack` script to enable the Jack feature.
+In that case, you can use the `npm run build:jack` script to enable the Jack feature.
 
 ### Audio backend and latency
 
@@ -148,11 +151,28 @@ For real-time and interactive applications where low latency is crucial, you sho
 If you don't have JACK installed, you can still pass the `WEB_AUDIO_LATENCY=playback` environment variable to all examples to create the audio context with the playback latency hint, e.g.:
 
 ```sh
-WEB_AUDIO_LATENCY=playback node examples/amplitude-modulation.mjs
+WEB_AUDIO_LATENCY=playback node examples/amplitude-modulation.js
 ```
 
 ## Development notes
 
+### Build
+
+1. Install Rust toolchain
+
+```sh
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+````
+
+2. Clone the repo and build the binary on your machine
+
+```sh
+git clone https://github.com/ircam-ismm/node-web-audio-api.git
+cd node-web-audio-api
+npm install
+npm run build
+```
+
 ### Synchronize versioning
 
 The npm `postversion` script rely on [`cargo-bump`](https://crates.io/crates/cargo-bump) to maintain versions synced between the `package.json` and the `Cargo.toml` files. Therefore, you will need to install `cargo-bump` on your machine
@@ -163,7 +183,7 @@ cargo install cargo-bump
 
 ### Running the web-platform-test suite
 
-Follow the steps for 'Manual Build' first. Then checkout the web-platform-tests submodule with:
+Follow the steps for [Build](#build) first. Then checkout the web-platform-tests submodule with:
 
 ```
 git submodule init

examples/.npmrc

@@ -0,0 +1 @@
+package-lock=false

examples/all-nodes.js

@@ -19,7 +19,7 @@ import {
   OfflineAudioContext,
   AudioBuffer,
   mediaDevices,
-} from '../index.mjs';
+} from '#node-web-audio-api';
 
 const contexts = [new AudioContext(), new OfflineAudioContext(1, 1, 48000)];
 

examples/amplitude-modulation.js

@@ -1,4 +1,4 @@
-import { AudioContext } from '../index.mjs';
+import { AudioContext } from '#node-web-audio-api';
 
 const latencyHint = process.env.WEB_AUDIO_LATENCY === 'playback' ? 'playback' : 'interactive';
 const audioContext = new AudioContext({ latencyHint });

examples/analyser.js

@@ -1,4 +1,4 @@
-import { AudioContext } from '../index.mjs';
+import { AudioContext } from '#node-web-audio-api';
 
 const latencyHint = process.env.WEB_AUDIO_LATENCY === 'playback' ? 'playback' : 'interactive';
 const audioContext = new AudioContext({ latencyHint });

examples/audio-buffer.js

@@ -1,5 +1,5 @@
 import assert from 'node:assert';
-import { AudioContext } from '../index.mjs';
+import { AudioContext } from '#node-web-audio-api';
 
 const latencyHint = process.env.WEB_AUDIO_LATENCY === 'playback' ? 'playback' : 'interactive';
 const audioContext = new AudioContext({ latencyHint });

examples/audio-worklet-online.js

@@ -1,4 +1,4 @@
-import { AudioContext, OscillatorNode, GainNode, AudioWorkletNode } from '../index.mjs';
+import { AudioContext, OscillatorNode, GainNode, AudioWorkletNode } from '#node-web-audio-api';
 
 // load audio worklet from online source
 

examples/audio-worklet-shared-array-buffer.js

@@ -1,6 +1,6 @@
 import path from 'node:path';
 
-import { AudioContext, AudioWorkletNode } from '../index.mjs';
+import { AudioContext, AudioWorkletNode } from '#node-web-audio-api';
 import { sleep } from '@ircam/sc-utils';
 
 const latencyHint = process.env.WEB_AUDIO_LATENCY === 'playback' ? 'playback' : 'interactive';

examples/audio-worklet-webassembly.js

@@ -4,11 +4,11 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-import { AudioContext, OscillatorNode, AudioWorkletNode } from '../index.mjs';
+import { AudioContext, OscillatorNode, AudioWorkletNode } from '#node-web-audio-api';
 
 const audioContext = new AudioContext();
 
-await audioContext.audioWorklet.addModule('./worklets/wasm-worklet-processor.mjs');
+await audioContext.audioWorklet.addModule('./worklets/wasm-worklet-processor.js');
 const oscillator = new OscillatorNode(audioContext);
 const bypasser = new AudioWorkletNode(audioContext, 'wasm-worklet-processor');
 oscillator.connect(bypasser).connect(audioContext.destination);

examples/audio-worklet-white-woise.js

@@ -1,6 +1,6 @@
 import path from 'node:path';
 
-import { AudioContext, OfflineAudioContext, AudioWorkletNode } from '../index.mjs';
+import { AudioContext, OfflineAudioContext, AudioWorkletNode } from '#node-web-audio-api';
 import { sleep } from '@ircam/sc-utils';
 
 const latencyHint = process.env.WEB_AUDIO_LATENCY === 'playback' ? 'playback' : 'interactive';

examples/audio-worklet-with-params.js

@@ -1,6 +1,6 @@
 import path from 'node:path';
 
-import { AudioContext, OfflineAudioContext, OscillatorNode, AudioWorkletNode } from '../index.mjs';
+import { AudioContext, OfflineAudioContext, OscillatorNode, AudioWorkletNode } from '#node-web-audio-api';
 import { sleep } from '@ircam/sc-utils';
 
 const latencyHint = process.env.WEB_AUDIO_LATENCY === 'playback' ? 'playback' : 'interactive';

examples/benchmarks.js

@@ -2,7 +2,7 @@ import readline from 'node:readline';
 import fs from 'node:fs';
 import path from 'node:path';
 
-import { OfflineAudioContext, AudioContext } from '../index.mjs';
+import { OfflineAudioContext, AudioContext } from '#node-web-audio-api';
 import { getTime } from '@ircam/sc-utils';
 import Table from 'cli-table';
 

examples/biquad.js

@@ -1,6 +1,6 @@
 import fs from 'node:fs';
 import path from 'node:path';
-import { AudioContext } from '../index.mjs';
+import { AudioContext } from '#node-web-audio-api';
 
 const latencyHint = process.env.WEB_AUDIO_LATENCY === 'playback' ? 'playback' : 'interactive';
 const audioContext = new AudioContext({ latencyHint });

examples/change-state.js

@@ -1,4 +1,4 @@
-import { AudioContext } from '../index.mjs';
+import { AudioContext } from '#node-web-audio-api';
 
 console.warn('[incomplete example]');
 

examples/commonjs.cjs

@@ -0,0 +1,22 @@
+const { AudioContext, OscillatorNode, GainNode } = require('../index.js');
+
+const latencyHint = process.env.WEB_AUDIO_LATENCY === 'playback' ? 'playback' : 'interactive';
+const audioContext = new AudioContext({ latencyHint });
+
+setInterval(() => {
+  const now = audioContext.currentTime;
+  const frequency = 200 + Math.random() * 2800;
+
+  const env = new GainNode(audioContext, { gain: 0 });
+  env.connect(audioContext.destination);
+  env.gain
+    .setValueAtTime(0, now)
+    .linearRampToValueAtTime(0.2, now + 0.02)
+    .exponentialRampToValueAtTime(0.0001, now + 1);
+
+  const osc = new OscillatorNode(audioContext);
+  osc.frequency.value = frequency;
+  osc.connect(env);
+  osc.start(now);
+  osc.stop(now + 1);
+}, 80);

examples/composite-audio-node.js

@@ -1,5 +1,5 @@
 import { sleep } from '@ircam/sc-utils';
-import { AudioContext, AudioNode } from '../index.mjs';
+import { AudioContext, AudioNode } from '#node-web-audio-api';
 
 // Monkeypatching AudioNode.connect to allow for composite nodes.
 // https://github.com/GoogleChromeLabs/web-audio-samples/wiki/CompositeAudioNode

examples/compressor.js

@@ -1,6 +1,6 @@
 import fs from 'node:fs';
 import path from 'node:path';
-import { AudioContext } from '../index.mjs';
+import { AudioContext } from '#node-web-audio-api';
 
 const latencyHint = process.env.WEB_AUDIO_LATENCY === 'playback' ? 'playback' : 'interactive';
 const audioContext = new AudioContext({ latencyHint });

examples/constant-source.js

@@ -1,4 +1,4 @@
-import { AudioContext } from '../index.mjs';
+import { AudioContext } from '#node-web-audio-api';
 
 const latencyHint = process.env.WEB_AUDIO_LATENCY === 'playback' ? 'playback' : 'interactive';
 const audioContext = new AudioContext({ latencyHint });

examples/convolution.js

@@ -1,6 +1,6 @@
 import fs from 'node:fs';
 import path from 'node:path';
-import { AudioContext, ConvolverNode } from '../index.mjs';
+import { AudioContext, ConvolverNode } from '#node-web-audio-api';
 
 // create an `AudioContext` and load a sound file
 const latencyHint = process.env.WEB_AUDIO_LATENCY === 'playback' ? 'playback' : 'interactive';

examples/decoding-legacy.js

@@ -1,6 +1,6 @@
 import fs from 'node:fs';
 import path from 'node:path';
-import { AudioContext, OfflineAudioContext } from '../index.mjs';
+import { AudioContext, OfflineAudioContext } from '#node-web-audio-api';
 
 const latencyHint = process.env.WEB_AUDIO_LATENCY === 'playback' ? 'playback' : 'interactive';
 const audioContext = new AudioContext({ latencyHint });

examples/decoding.js

@@ -1,6 +1,6 @@
 import fs from 'node:fs';
 import path from 'node:path';
-import { AudioContext } from '../index.mjs';
+import { AudioContext } from '#node-web-audio-api';
 
 const files = [
   path.join('examples', 'samples', 'sample-faulty.wav'),