Merge pull request #54 from hughrawlinson/add-support-for-other-worklets

Add support for other workers/worklets

Author: darionco

README.md

@@ -1,6 +1,13 @@
 # rollup-plugin-web-worker-loader
 
-Rollup plugin to handle Web Workers.
+Rollup plugin to handle Web Workers, Service Workers, Shared Workers,
+Audio Worklets, and Paint Worklets. Support for Animation Worklets and
+Layout Worklets is in consideration for when implementations are available
+in browsers.
+
+Web Workers are available in Node JS as well as in browsers. All the other
+worklets and workers are available in browsers only, and will throw a runtime
+error if used in Node JS.
 
 Can inline the worker code or emit a script file using code-splitting.
 Handles Worker dependencies and can emit source maps.
@@ -27,6 +34,8 @@ export default {
 };
 ```
 
+#### Web Worker Example
+
 Bundle the worker code using the RegEx pattern specified in the plugin's configuration.
 By default you can add the prefix `web-worker:` to your imports:
 
@@ -38,6 +47,81 @@ const dataWorker = new DataWorker();
 dataWorker.postMessage('Hello World!');
 ```
 
+#### Shared Worker Example
+
+```javascript
+import SharedWorker from 'shared-worker:./SharedWorker';
+
+const sharedWorker = new SharedWorker();
+sharedWorker.port.postMessage('Hello World!');
+```
+
+#### Service Worker Example
+
+```javascript
+import ServiceWorker from 'service-worker:./ServiceWorker';
+
+ServiceWorker.then(function(registration) {
+    console.log('Registration successful, scope is: ', registration.scope);
+})
+.catch(function(error) {
+    console.log('Service worker registration failed, error: ', error);
+}
+```
+
+#### Audio Worklet Example
+
+Audio Worklets require an audio context at instantiation. When you use
+rollup-plugin-web-worker-loader in a browser environment, your import will
+return a constructor to which you can pass an audio context.
+##### Worklet Processor
+
+```javascript
+class MyAudioWorkletProcessor extends AudioWorkletProcessor {
+}
+
+registerProcessor("my-audio-worklet", MyAudioWorkletProcessor);
+```
+
+##### Worklet Consumer
+
+```javascript
+import registerMyAudioWorklet from 'audio-worklet:./MyAudioWorkletFactory';
+
+const audioContext = new AudioContext();
+registerMyAudioWorklet(audioContext);
+
+class MyAudioWorklet extends AudioWorkletNode {
+    constructor(audioContext) {
+        super(audioContext, "my-audio-worklet"));
+    }
+}
+```
+
+#### Paint Worklet Example
+
+##### Worklet Processor
+
+```javascript
+class MyPaintWorklet {
+    ...
+}
+
+registerPaint('my-paint-worklet', MyPaintWorklet);
+```
+
+##### Worklet Consumer
+
+```javascript
+import registerMyPaintWorklet from 'paint-worklet:./MyPaintWorkletFactory';
+registerMyPaintWorklet();
+```
+
+```css
+html {
+    background: paint(my-paint-worklet);
+}
+
 ### Configuration
 The plugin responds to the following configuration options:
 ```javascript
@@ -49,9 +133,26 @@ webWorkerLoader({
                                     // 'auto' detectes the target platform and selects between 'browser` and 'node'.
                                     // Default: 'auto'
 
-    pattern?: RegEx,                // A RegEx instance describing the pattern that matches the files to import as
+    web-worker?: RegEx,             // A RegEx instance describing the pattern that matches the files to import as
                                     // web workers. If capturing groups are present, the plugin uses the contents of the
                                     // last capturing group as the path to the worker script. Default: /web-worker:(.+)/
+
+    shared-worker?: RegEx,          // A RegEx instance describing the pattern that matches the files to import as
+                                    // shared workers. If capturing groups are present, the plugin uses the contents of the
+                                    // last capturing group as the path to the worker script. Default: /shared-worker:(.+)/
+
+    service-worker?: RegEx,         // A RegEx instance describing the pattern that matches the files to import as
+                                    // service workers. If capturing groups are present, the plugin uses the contents of the
+                                    // last capturing group as the path to the worker script. Default: /service-worker:(.+)/
+
+    audio-worklet?: RegEx,          // A RegEx instance describing the pattern that matches the files to import as
+                                    // audio worklets. If capturing groups are present, the plugin uses the contents of the
+                                    // last capturing group as the path to the worker script. Default: /audio-worklet:(.+)/
+
+    paint-worklet?: RegEx,          // A RegEx instance describing the pattern that matches the files to import as
+                                    // paint worklets. If capturing groups are present, the plugin uses the contents of the
+                                    // last capturing group as the path to the worker script. Default: /paint-worklet:(.+)/
+
 
     extensions?: string[],          // An array of strings to use as extensions when resolving worker files.
                                     // Default: ['.js']

src/helper/auto/createBase64AudioWorkletFactory.js

@@ -0,0 +1,9 @@
+import {createBase64AudioWorkletFactory as browserCreateBase64AudioWorkletFactory} from '\0rollup-plugin-web-worker-loader::helper::browser::createBase64AudioWorkletFactory';
+import {isNodeJS} from '\0rollup-plugin-web-worker-loader::helper::auto::isNodeJS';
+
+export function createBase64AudioWorkletFactory(base64, sourcemapArg, enableUnicodeArg) {
+    if (isNodeJS()) {
+        throw new Error('rollup-plugin-web-worker-loader does not support Audio Worklet in Node.JS');
+    }
+    return browserCreateBase64AudioWorkletFactory(base64, sourcemapArg, enableUnicodeArg);
+}

src/helper/auto/createBase64PaintWorkletFactory.js

@@ -0,0 +1,9 @@
+import {createBase64PaintWorkletFactory as browserCreateBase64PaintWorkletFactory} from '\0rollup-plugin-web-worker-loader::helper::browser::createBase64AudioWorkletFactory';
+import {isNodeJS} from '\0rollup-plugin-web-worker-loader::helper::auto::isNodeJS';
+
+export function createBase64PaintWorkletFactory(base64, sourcemapArg, enableUnicodeArg) {
+    if (isNodeJS()) {
+        throw new Error('rollup-plugin-web-worker-loader does not support Paint Worklet in Node.JS');
+    }
+    return browserCreateBase64PaintWorkletFactory(base64, sourcemapArg, enableUnicodeArg);
+}

src/helper/auto/createBase64ServiceWorkerFactory.js

@@ -0,0 +1,9 @@
+import {createBase64ServiceWorkerFactory as browserCreateBase64ServiceWorkerFactory} from '\0rollup-plugin-web-worker-loader::helper::browser::createBase64ServiceWorkerFactory';
+import {isNodeJS} from '\0rollup-plugin-web-worker-loader::helper::auto::isNodeJS';
+
+export function createBase64ServiceWorkerFactory(base64, sourcemapArg, enableUnicodeArg) {
+    if (isNodeJS()) {
+        throw new Error('rollup-plugin-web-worker-loader does not support Service Worker in Node.JS');
+    }
+    return browserCreateBase64ServiceWorkerFactory(base64, sourcemapArg, enableUnicodeArg);
+}

src/helper/auto/createBase64SharedWorkerFactory.js

@@ -0,0 +1,9 @@
+import {createBase64SharedWorkerFactory as browserCreateBase64SharedWorkerFactory} from '\0rollup-plugin-web-worker-loader::helper::browser::createBase64SharedWorkerFactory';
+import {isNodeJS} from '\0rollup-plugin-web-worker-loader::helper::auto::isNodeJS';
+
+export function createBase64SharedWorkerFactory(base64, sourcemapArg, enableUnicodeArg) {
+    if (isNodeJS()) {
+        throw new Error('rollup-plugin-web-worker-loader does not support Shared Worker in Node.JS');
+    }
+    return browserCreateBase64SharedWorkerFactory(base64, sourcemapArg, enableUnicodeArg);
+}

src/helper/auto/createInlineAudioWorkletFactory.js

@@ -0,0 +1,9 @@
+import {createInlineAudioWorkletFactory as browserCreateInlineAudioWorkletFactory} from '\0rollup-plugin-web-worker-loader::helper::browser::createInlineAudioWorkletFactory';
+import {isNodeJS} from '\0rollup-plugin-web-worker-loader::helper::auto::isNodeJS';
+
+export function createInlineAudioWorkletFactory(fn, sourcemapArg) {
+    if (isNodeJS()) {
+        throw new Error('rollup-plugin-web-worker-loader does not support Audio Worklet in Node.JS');
+    }
+    return browserCreateInlineAudioWorkletFactory(fn, sourcemapArg);
+}

src/helper/auto/createInlinePaintWorkletFactory.js

@@ -0,0 +1,10 @@
+import {createInlinePaintWorkletFactory as browserCreateInlinePaintWorkletFactory} from '\0rollup-plugin-web-worker-loader::helper::browser::createInlinePaintWorkletFactory';
+import {isNodeJS} from '\0rollup-plugin-web-worker-loader::helper::auto::isNodeJS';
+
+export function createInlinePaintWorkletFactory(fn, sourcemapArg) {
+    if (isNodeJS()) {
+        throw new Error('rollup-plugin-web-worker-loader does not support Paint Worklet in Node.JS');
+    }
+    return browserCreateInlinePaintWorkletFactory(fn, sourcemapArg);
+}
+

src/helper/auto/createInlineServiceWorkerFactory.js

@@ -0,0 +1,9 @@
+import {createInlineServiceWorkerFactory as browserCreateInlineServiceWorkerFactory} from '\0rollup-plugin-web-worker-loader::helper::browser::createInlineServiceWorkerFactory';
+import {isNodeJS} from '\0rollup-plugin-web-worker-loader::helper::auto::isNodeJS';
+
+export function createInlineServiceWorkerFactory(fn, sourcemapArg) {
+    if (isNodeJS()) {
+        throw new Error('rollup-plugin-web-worker-loader does not support Service Worker in Node.JS');
+    }
+    return browserCreateInlineServiceWorkerFactory(fn, sourcemapArg);
+}

src/helper/auto/createInlineSharedWorkerFactory.js

@@ -0,0 +1,9 @@
+import {createInlineSharedWorkerFactory as browserCreateInlineSharedWorkerFactory} from '\0rollup-plugin-web-worker-loader::helper::browser::createInlineSharedWorkerFactory';
+import {isNodeJS} from '\0rollup-plugin-web-worker-loader::helper::auto::isNodeJS';
+
+export function createInlineSharedWorkerFactory(fn, sourcemapArg) {
+    if (isNodeJS()) {
+        throw new Error('rollup-plugin-web-worker-loader does not support Shared Worker in Node.JS');
+    }
+    return browserCreateInlineSharedWorkerFactory(fn, sourcemapArg);
+}

src/helper/auto/createURLAudioWorkletFactory.js

@@ -0,0 +1,9 @@
+import {createURLAudioWorkletFactory as browserCreateURLAudioWorkletFactory} from '\0rollup-plugin-web-worker-loader::helper::browser::createURLAudioWorkletFactory';
+import {isNodeJS} from '\0rollup-plugin-web-worker-loader::helper::auto::isNodeJS';
+
+export function createURLAudioWorkletFactory(url) {
+    if (isNodeJS()) {
+        throw new Error('rollup-plugin-web-worker-loader does not support Audio Worklet in Node.JS');
+    }
+    return browserCreateURLAudioWorkletFactory(url);
+}