@anonaddy/omni-worker 0.0.1 → 0.2.0

package/README.md

@@ -1,21 +1,27 @@
 # 👷 Omni Worker - A Versatile Worker for Typescript
-Webworkers (browser) and thread workers (NodeJS) are usually limiting in their application, since the code that runs on a worker needs to be serializable. Therefore interfaces aren't fully supported, and also 3rd party libraries usually don't work.
+Webworkers (browser) and thread workers (NodeJS) are usually hard to implement, since the code that runs on a worker needs to be serializable and have complex interfaces to transfer the data into the workers. 3rd party modules are usually hard to get working or don't work at all giving you a serious headache when implementing them...
 
-Enter the stage, OmniWorkers! These workers allow you to simply declare any interface with functions that will actually run inside a worker. Whether it be on the web (webworker) or as a thread worker in NodeJS, these workers will run your code, no matter what.
+Enter the stage, OmniWorkers! These workers allow you to simply declare an interface with functions (currently with the exception of callbacks) that will actually run inside a worker. Whether it be on the web (webworker) or on NodeJS (thread worker), these workers will run your code inside a worker, period.
 
 ## How does it Work?
-In the case of jsDOM, the UI will block at certain tasks if it's too heavy. Alternatively, in case of Node, load times will take longer since the JavaScript V8 engine only runs one event loop thread. Even when using asynchronous code, the event loop can easily get overloaded.
+In the case of using typescript for front-end projects, a UI will simply block at certain tasks if they're too heavy. You could use yielding functions, but that will slow your code down as a result. Similarly, in case of NodeJS, load times can significantly increase since the JavaScript V8 engine only runs one event loop thread. Even when using asynchronous code, the event loop is still just running on one thread.
 
 ### Workers
-The [Webworker API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) for the web and [Worker Threads](https://nodejs.org/api/worker_threads.html) for NodeJS allow us to declare code inside a seperate file, which will run in its own context. The advantage, is that we now have more than one event loop thread to work on. The drawback of course, is that all code executed inside these (contexed) workers needs to be serializable, since your code is basically shipped into the worker for execution. If you have code that depends on other 3rd party libraries, your code will most-likely not build, since the code inside the worker context is closed off.
+The [Webworker API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) for the web and [Worker Threads](https://nodejs.org/api/worker_threads.html) for NodeJS allow us to declare code inside a seperate file, which will run in its own context (event loop). The advantage of this is that we now have more than one event loop thread to work with. 
+
+The drawback here, is that all code executed inside these (contexed) workers needs to be serializable, since your code is basically shipped into the worker for execution. This is done through the Worker communication interface. Should your code depend on other 3rd party libraries, your code would have most-likely not executed, since the code inside the worker context is closed off from the main thread context.
 
 ### 👷 OmniWorkers
-So how do OmniWorkers stand out from normal workers? First off, the simplicity. Simply declare your code and expose it to the main event loop. Then, build the OmniWorker by referencing you file. Now, the OmniWorker will expose the object with functions you've injected into the worker container. You can use your own functions with primitive types, functions directly taken from 3rd party modules or a hybrid mix of both. Let's look at an example:
+So what makes OmniWorkers to special? First off, their simplicity. Simply declare your code and expose it to the main event loop. Then build the OmniWorker by simply referencing you file. Now, the OmniWorker will expose the object with functions or a class you've injected into the worker container. You can use your own functions with primitive types, functions directly taken from 3rd party modules or a hybrid mix of both. Let's first look at an example for NodeJS:
 
 #### `👷‍♀️ workers/worker.ts`
 ```javascript
 import { NodeOmniWorker } from "@anonaddy/omni-worker";
+
+// Interface declared by you
 import { IMyOmniWorkerFunctions } from "./worker-model";
+
+// 3rd party module dependency
 import { capitalize } from "lodash";
 
 // Declare your functions using an interface
@@ -27,9 +33,9 @@ const fnObj: IMyOmniWorkerFunctions = {
 // In this case, diamond interface can even be omitted, since inferred
 NodeOmniWorker.expose<IMyOmniWorkerFunctions>(fnObj);
 ```
-The worker.ts file contains the logic you would like to run inside the container. In our example above we created our own function, but we also included a 3rd party module (lodash) to demonstrate that an OmniWorker can just as well use any other 3rd party module.
+The worker.ts file contains the logic you would like to run inside the container. In our example above we created our own function inside a object containing functions, but notice how we included a 3rd party module (lodash). This demonstrates that an OmniWorker can just as well use any other 3rd party module as well as logic defined by you.
 
-What's important, is to expose your logic using the expose function. This will make sure that the container exposes (or shares) your code logic with the main event loop thread, for you to access it in your code.
+What's important, is to expose your logic using the expose function. This will make sure that the container exposes (or shares) your code logic with the main event loop, for you to access it in the rest of your code:
 
 #### `🏭 index.ts`
 ```javascript
@@ -37,15 +43,16 @@ import { NodeOmniWorker } from "@anonaddy/omni-worker";
 import { IMyOmniWorkerFunctions } from "./worker-model";
 
 // Use the static path from your project's root
-const WORKER_DIR = "src/workers";
-
-// Build the worker from the file you specified and the
-// functions that were exposed
-const worker = await NodeOmniWorker
-  .build<IMyOmniWorkerFunctions>(`${WORKER_DIR}/worker`);
+const WORKER_DIR = "./src/workers";
 
 // Placing anonymous async function on the event loop
-setTimeout(async () => {
+(async () => {
+
+  // Build the worker from the file you specified and the
+  // functions that were exposed
+  const worker = await NodeOmniWorker
+    .build<IMyOmniWorkerFunctions>(`${WORKER_DIR}/worker.ts`);
+
   const sum = await worker.use().add(1, 2);
   const str = await worker.use().capitalize("hello");
 
@@ -54,34 +61,91 @@ setTimeout(async () => {
     The result of my sum is: ${sum}!
     Aren't Omniworkers just awesome?!
   `);
-}, 0);
+
+  // Release resources once you're done!
+  await worker.destroy();
+})();
 ```
-Your code can now just asynchronously call the logic you have declared and exposed inside your worker. Simply call the `worker.use()` function and you'll have access to all the functions defined by you inside your `IMyOwnWorkerFunctions` interface.
+Your code can now just **asynchronously** call the logic you have declared and exposed inside your worker.ts. Simply call the `worker.use()` function and you'll have access to all the functions defined by you inside your `IMyOwnWorkerFunctions` interface. 
 
-### Under the Hood
-This modules leverages [Comlink](https://github.com/GoogleChromeLabs/comlink) and [Esbuild](https://github.com/evanw/esbuild) to parse your container code, build it and wire it up to the main event loop using Comlink.
+> `⚠️ Even if your functions are not returning a Promise in your declaration file, now they will!`
+
+### Worker Pools
+Sometimes, having one worker just isn't enough. Worker pools are capable of instantiating multiple workers and consuming their compute power in a round-robin fashion. Let's look at an example:
 
-### Tests
-Tests are included inside this library. If you would like to learn how to build and instantiate your workers, you can find examples inside the test code, for node inside `__tests_node__` and for web `__tests_dom__` respectively.
+#### `🏊‍♂️ pool.ts`
+```javascript
+import { NodeOmniWorkerPool } from '@anonaddy/omni-worker';
+import { IMyOmniWorkerFunctions } from "./worker-model";
+
+(async () => {
+
+  const pool = await NodeOmniWorkerPool
+    .buildAndLaunch<IMyOmniWorkerFunctions>(
+      './src/worker/workers/normal.worker.ts',
+      { numOfWorkers: 4 }
+    );
+
+  const sentence = "i very much like your new tie brother joe";
+  const fns: (() => Promise<string>)[] = [];
+
+  // capitalize each word (promisified)
+  for (const word of sentence.split(' ')) {
+    const fn = async () => {
+      return await pool.use().capitalize(word);
+    }
+    fns.push(fn);
+  }
+  
+  // await all promises and join up the words
+  const result = await Promise.all(fns.map(fn => fn()));
+  console.log(result.join(' '));
+  
+  // Release resources once you're done!
+  await pool.destroy();
+
+})();
+
+```
+The code example above will create a worker pool of 4 workers with the code you specified. All work will be distributed round-robin across the OmniWorkers. We recommend using as many workers inside the pool as you have threads on the processor running the code. This will make sure that performance is optimal. Too many workers can AND WILL degrade performance in JavaScript.
+
+### 🕸️ WebOmniWorkers
+When you're building a module for the web, you can't use Node's module resolution. Instead, you will use a bundler (e.g. Webpack, Rollup) to bundle your code, usually in a format like ESM. This use case is covered by WebOmniWorkers.
+
+The only difference when instantiating a WebOmniWorker is that instead of a project file path, a URL object needs to be parsed into the build function. Also, when using any 3rd party modules, these need to be statically linked inside your `worker.ts` file and can't be linked using Node's module resolution.
+
+Please see the [demos](https://github.com/avluent/omni-worker-demos) project to see how a WebOmniWorker(pool) can be instantiated on a JavaScript module project.
+
+### Under the Hood
+This modules leverages [Webpack](https://www.npmjs.com/package/webpack) to parse your container code and build it. From there, it's wired up to the main event loop using a great module called [Comlink](https://github.com/GoogleChromeLabs/comlink). This module abstracts away the communication between the main event loop and Workers.
 
 # Potential Issues
-There's cases where building the worker could lead to errors. Especially when working with packages that use bindings for other languages such as C or C++ for example and that are built to `*.node` binary files using node-gyp. One could experience situations like:
+There's cases where building the worker(pool)s could lead to errors. Especially when working with modules that use bindings to other languages such as C or C++. These are usually compiled to native code such as `*.node` binary files using node-gyp. A common error is:
 ```
-❌ Module did not self-register: /path/to/node-gyp/built/binary.node
+❌ Module did not self-register: /path/to/native/binary.node
 ```
-The root cause is assumed to be a mismatch on either the build or the initialization stage of the binary. Oftentimes, performing these steps, helps:
+If you're trying to run multiple OmniWorkers (for example inside an OmniWorkerPool) and multiple OmniWorkers depend on the same library (with native .node binary), then this could lead to serious issues. The reason for this, is that multiple contexts are trying to access the same .node file at the same time, which leads to NodeJS not being able to access the file (DLOPEN fails).
+
+If you're absolutely sure that you're only running one OmniWorker and that your OmniWorker depends on native code, but the build still fails, theses are some steps you could try, before trying to start the OmniWorker again:
 ``` bash
-# first, retry the rebuild
+# rebuild the .node native code
 npm rebuild <your lib>
 
-# if that didn't work
+# if that didn't work try deleting package info
 rm -rf node_modules
 mv package-lock.json package-lock.json.backup # make sure to make a backup!
 npm i
 ```
-Should you run into the issue above, or similar other issues, please drop me an email on the address mentioned at the bottom of this doc.
+Should you not be able to solve your issue, please drop me an email so we can have a look at your case. We're constantly attempt at improving compatitiblity for these types of use cases. Should you have an idea of you own, also feel free to provide a pull request. 
 
 # Project Status
-Currently, only `NodeOmniWorker`s are available. The `WebOmniWorker`s will also be available soon. Please stay tuned! In case you have any questions, make sure to drop me an [email](mailto:7ebr7fa0@anonaddy.com) and I will try to get back to you asap.
+We're happy to announce that `WebOmniWorker`s along with their pools are now available. In case you have any questions, make sure to drop me an [email](mailto:7ebr7fa0@anonaddy.com) and I will get back to you asap.
+
+## Change Log
+|Version|Description|
+|:-:|-|
+|**v0.2.0**|Introduced the WebOmniWorker and the WebOmniWorker pool. Split the project for Node and Web|
+|**v0.1.0**|Switched from ESBuild to Webpack for NodeJS and introduced the NodeOmniWorkerPool|
+|**v0.0.1**|Basic of single NodeOmniWorker with code having native dependencies still crashing|
 
-🏗️ **Happy (Omni)Working!!** 🏗️
+### 🏗️ Happy (Omni)Working!! 🏗️

package/dist/cjs/{builder/helpers.js → helpers/builder.js}

@@ -15,8 +15,8 @@ function getCallerDir() {
         return dirName;
     }
     catch (e) {
-        console.error('building caller path failed', e);
+        // console.error('building caller path failed', e);
         return './';
     }
 }
-//# sourceMappingURL=helpers.js.map
+//# sourceMappingURL=builder.js.map

package/dist/cjs/{builder/helpers.js.map → helpers/builder.js.map}

@@ -1 +1 @@
-{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../src/builder/helpers.ts"],"names":[],"mappings":";;;;;AAEA,oCAaC;AAfD,gDAAwB;AAExB,SAAgB,YAAY;IAC1B,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC,KAAM,CAAC;QACjC,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,MAAM,OAAO,GAAG,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEnC,OAAO,OAAO,CAAC;IACjB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,KAAK,CAAC,6BAA6B,EAAE,CAAC,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC"}
+{"version":3,"file":"builder.js","sourceRoot":"","sources":["../../../src/helpers/builder.ts"],"names":[],"mappings":";;;;;AAEA,oCAaC;AAfD,gDAAwB;AAExB,SAAgB,YAAY;IAC1B,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC,KAAM,CAAC;QACjC,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,MAAM,OAAO,GAAG,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEnC,OAAO,OAAO,CAAC;IACjB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,mDAAmD;QACnD,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC"}

package/dist/cjs/helpers/pool.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.doYield = doYield;
+function doYield() {
+    return new Promise((resolve) => {
+        setTimeout(resolve, 0);
+    });
+}
+//# sourceMappingURL=pool.js.map

package/dist/cjs/helpers/pool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pool.js","sourceRoot":"","sources":["../../../src/helpers/pool.ts"],"names":[],"mappings":";;AAAA,0BAIC;AAJD,SAAgB,OAAO;IACrB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/cjs/node/builder/constants.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tsNodeCompilerOptions = exports.tsCompilerOptions = void 0;
+const typescript_1 = __importDefault(require("typescript"));
+exports.tsCompilerOptions = {
+    module: typescript_1.default.ModuleKind.CommonJS,
+    target: typescript_1.default.ScriptTarget.ES2018,
+};
+exports.tsNodeCompilerOptions = {
+    transpileOnly: true,
+    compilerOptions: {
+        module: 'CommonJS',
+        target: 'ES5'
+    }
+};
+//# sourceMappingURL=constants.js.map

package/dist/cjs/node/builder/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../src/node/builder/constants.ts"],"names":[],"mappings":";;;;;;AACA,4DAA6B;AAEhB,QAAA,iBAAiB,GAAuB;IACnD,MAAM,EAAE,oBAAE,CAAC,UAAU,CAAC,QAAQ;IAC9B,MAAM,EAAE,oBAAE,CAAC,YAAY,CAAC,MAAM;CAC/B,CAAA;AAEY,QAAA,qBAAqB,GAAoB;IACpD,aAAa,EAAE,IAAI;IACnB,eAAe,EAAE;QACf,MAAM,EAAE,UAAU;QAClB,MAAM,EAAE,KAAK;KACd;CACF,CAAA"}

package/dist/cjs/node/builder/helpers.js

@@ -0,0 +1,144 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildWorkerCode = buildWorkerCode;
+const webpack_node_externals_1 = __importDefault(require("webpack-node-externals"));
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const webpack_1 = require("webpack");
+const terser_webpack_plugin_1 = __importDefault(require("terser-webpack-plugin"));
+const BUILD_PATH = path_1.default.join(__dirname, '.out');
+const BUILD_FILENAME = 'bundle.js';
+const BUILD_FILE_PATH = path_1.default.join(BUILD_PATH, BUILD_FILENAME);
+function buildWorkerCode(entryFile) {
+    if (!fs_1.default.existsSync(BUILD_PATH)) {
+        fs_1.default.mkdirSync(BUILD_PATH, { recursive: true });
+    }
+    const config = getWebpackConfig(entryFile);
+    const compiler = (0, webpack_1.webpack)(config);
+    return new Promise((resolve, reject) => {
+        compiler.run((err, stats) => {
+            if (err) {
+                reject(err);
+                return;
+            }
+            /*
+            console.log(stats?.toString({
+              chunks: false,
+              colors: true
+            }));
+            */
+            const bundledCode = fs_1.default
+                .readFileSync(BUILD_FILE_PATH, 'utf8');
+            // clean up the build folder
+            fs_1.default.rm(BUILD_PATH, { recursive: true, force: false }, (err) => {
+                if (err) {
+                    reject(err);
+                }
+            });
+            resolve(bundledCode);
+        });
+    });
+}
+const getWebpackConfig = (entry) => ({
+    entry,
+    output: {
+        filename: BUILD_FILENAME,
+        path: BUILD_PATH,
+        libraryTarget: 'commonjs2',
+        module: false,
+        iife: false,
+        umdNamedDefine: true,
+    },
+    resolve: {
+        extensions: ['.ts', '.js'],
+        fallback: {
+            assert: false,
+            buffer: false,
+            console: false,
+            constants: false,
+            crypto: false,
+            domain: false,
+            events: false,
+            fs: false,
+            http: false,
+            https: false,
+            module: false,
+            net: false,
+            os: false,
+            path: false,
+            process: false,
+            punycode: false,
+            querystring: false,
+            readline: false,
+            stream: false,
+            string_decoder: false,
+            sys: false,
+            timers: false,
+            tls: false,
+            tty: false,
+            url: false,
+            util: false,
+            vm: false,
+            worker_threads: false,
+            zlib: false,
+        },
+    },
+    resolveLoader: {
+        modules: [
+            path_1.default.resolve(process.cwd(), 'node_modules')
+        ]
+    },
+    mode: 'production',
+    optimization: {
+        minimize: true,
+        minimizer: [
+            new terser_webpack_plugin_1.default({
+                terserOptions: {
+                    compress: {
+                        drop_console: true,
+                        drop_debugger: true
+                    },
+                }
+            })
+        ]
+    },
+    target: 'node',
+    module: {
+        rules: [
+            {
+                test: /\.ts$/,
+                use: [
+                    {
+                        loader: resolveNodeModules('babel-loader'),
+                        options: {
+                            presets: [
+                                resolveNodeModules('@babel/preset-env'),
+                                resolveNodeModules('@babel/preset-typescript')
+                            ],
+                            plugins: [
+                                resolveNodeModules('@babel/plugin-transform-modules-commonjs'),
+                                [resolveNodeModules('@babel/plugin-proposal-decorators'), { "legacy": true }],
+                            ]
+                        },
+                    }
+                ],
+                exclude: /node_modules/
+            }
+        ],
+    },
+    devtool: 'source-map',
+    stats: 'verbose',
+    externals: [(0, webpack_node_externals_1.default)({
+            importType: 'commonjs',
+        })],
+    cache: false
+});
+const resolveNodeModules = (packageName) => require.resolve(packageName, {
+    paths: [
+        path_1.default.resolve(__dirname, 'node_modules')
+    ]
+});
+//# sourceMappingURL=helpers.js.map

package/dist/cjs/node/builder/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../../src/node/builder/helpers.ts"],"names":[],"mappings":";;;;;AAWA,0CAoCC;AA/CD,oFAAmD;AACnD,gDAAwB;AAExB,4CAAoB;AACpB,qCAAkC;AAClC,kFAAiD;AAEjD,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;AAChD,MAAM,cAAc,GAAG,WAAW,CAAC;AACnC,MAAM,eAAe,GAAG,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;AAE9D,SAAgB,eAAe,CAAC,SAAiB;IAE/C,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/B,YAAE,CAAC,SAAS,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAChD,CAAC;IACD,MAAM,MAAM,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC3C,MAAM,QAAQ,GAAG,IAAA,iBAAO,EAAC,MAAM,CAAC,CAAC;IAEjC,OAAO,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAE7C,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YAC1B,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,CAAC,GAAG,CAAC,CAAC;gBACZ,OAAO;YACT,CAAC;YAED;;;;;cAKE;YAEF,MAAM,WAAW,GAAG,YAAE;iBACnB,YAAY,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;YAEzC,4BAA4B;YAC5B,YAAE,CAAC,EAAE,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,EAAE,EAAE;gBAC3D,IAAI,GAAG,EAAE,CAAC;oBACR,MAAM,CAAC,GAAG,CAAC,CAAC;gBACd,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,OAAO,CAAC,WAAW,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,gBAAgB,GAAG,CAAC,KAAa,EAAiB,EAAE,CAAC,CAAC;IAC1D,KAAK;IACL,MAAM,EAAE;QACN,QAAQ,EAAE,cAAc;QACxB,IAAI,EAAE,UAAU;QAChB,aAAa,EAAE,WAAW;QAC1B,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,KAAK;QACX,cAAc,EAAE,IAAI;KACrB;IACD,OAAO,EAAE;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;QAC1B,QAAQ,EAAE;YACR,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,KAAK;YACd,SAAS,EAAE,KAAK;YAChB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,KAAK;YACb,EAAE,EAAE,KAAK;YACT,IAAI,EAAE,KAAK;YACX,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,KAAK;YACV,EAAE,EAAE,KAAK;YACT,IAAI,EAAE,KAAK;YACX,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,KAAK;YACf,WAAW,EAAE,KAAK;YAClB,QAAQ,EAAE,KAAK;YACf,MAAM,EAAE,KAAK;YACb,cAAc,EAAE,KAAK;YACrB,GAAG,EAAE,KAAK;YACV,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,KAAK;YACV,GAAG,EAAE,KAAK;YACV,GAAG,EAAE,KAAK;YACV,IAAI,EAAE,KAAK;YACX,EAAE,EAAE,KAAK;YACT,cAAc,EAAE,KAAK;YACrB,IAAI,EAAE,KAAK;SACZ;KACF;IACD,aAAa,EAAE;QACb,OAAO,EAAE;YACP,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC;SAC5C;KACF;IACD,IAAI,EAAE,YAAY;IAClB,YAAY,EAAE;QACZ,QAAQ,EAAE,IAAI;QACd,SAAS,EAAE;YACT,IAAI,+BAAY,CAAC;gBACf,aAAa,EAAE;oBACb,QAAQ,EAAE;wBACR,YAAY,EAAE,IAAI;wBAClB,aAAa,EAAE,IAAI;qBACpB;iBACF;aACF,CAAC;SACH;KACF;IACD,MAAM,EAAE,MAAM;IACd,MAAM,EAAE;QACN,KAAK,EAAE;YACL;gBACE,IAAI,EAAE,OAAO;gBACb,GAAG,EAAG;oBACJ;wBACE,MAAM,EAAE,kBAAkB,CAAC,cAAc,CAAC;wBAC1C,OAAO,EAAE;4BACP,OAAO,EAAE;gCACP,kBAAkB,CAAC,mBAAmB,CAAC;gCACvC,kBAAkB,CAAC,0BAA0B,CAAC;6BAC/C;4BACD,OAAO,EAAE;gCACP,kBAAkB,CAAC,0CAA0C,CAAC;gCAC9D,CAAC,kBAAkB,CAAC,mCAAmC,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;6BAC9E;yBACF;qBACF;iBACF;gBACD,OAAO,EAAE,cAAc;aACxB;SACF;KACF;IACD,OAAO,EAAE,YAAY;IACrB,KAAK,EAAE,SAAS;IAChB,SAAS,EAAE,CAAC,IAAA,gCAAa,EAAC;YACxB,UAAU,EAAE,UAAU;SACvB,CAAC,CAAC;IACH,KAAK,EAAE,KAAK;CACb,CAAC,CAAC;AAEH,MAAM,kBAAkB,GAAG,CAAC,WAAmB,EAAE,EAAE,CACjD,OAAO,CAAC,OAAO,CAAC,WAAW,EACzB;IACE,KAAK,EAAE;QACL,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,CAAC;KACxC;CACF,CAAC,CAAC"}

package/dist/cjs/node/builder/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildNodeApiAndWorkerFromCode = exports.genWorkerCodeFromFile = void 0;
+const comlink_1 = __importDefault(require("comlink"));
+const worker_threads_1 = require("worker_threads");
+const node_adapter_js_1 = __importDefault(require("comlink/dist/umd/node-adapter.js"));
+const helpers_1 = require("./helpers");
+const path_1 = __importDefault(require("path"));
+const builder_1 = require("../../helpers/builder");
+const genWorkerCodeFromFile = async (workerPath) => {
+    const callerDir = (0, builder_1.getCallerDir)();
+    const resolvedPath = path_1.default.resolve(callerDir, workerPath);
+    const code = await (0, helpers_1.buildWorkerCode)(resolvedPath);
+    return code;
+};
+exports.genWorkerCodeFromFile = genWorkerCodeFromFile;
+const buildNodeApiAndWorkerFromCode = (code) => {
+    const worker = new worker_threads_1.Worker(code, { eval: true });
+    const api = comlink_1.default.wrap((0, node_adapter_js_1.default)(worker));
+    return { worker, api };
+};
+exports.buildNodeApiAndWorkerFromCode = buildNodeApiAndWorkerFromCode;
+//# sourceMappingURL=index.js.map

package/dist/cjs/node/builder/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/node/builder/index.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA8B;AAC9B,mDAAwD;AACxD,uFAA4D;AAC5D,uCAA4C;AAC5C,gDAAwB;AACxB,mDAAqD;AAE9C,MAAM,qBAAqB,GAAG,KAAK,EACxC,UAAkB,EACD,EAAE;IACnB,MAAM,SAAS,GAAG,IAAA,sBAAY,GAAE,CAAC;IACjC,MAAM,YAAY,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IACzD,MAAM,IAAI,GAAG,MAAM,IAAA,yBAAe,EAAC,YAAY,CAAC,CAAC;IACjD,OAAO,IAAI,CAAC;AACd,CAAC,CAAA;AAPY,QAAA,qBAAqB,yBAOjC;AAEM,MAAM,6BAA6B,GAAG,CAC3C,IAAY,EAC4C,EAAE;IAE1D,MAAM,MAAM,GAAG,IAAI,uBAAY,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IACtD,MAAM,GAAG,GAAG,iBAAO,CAAC,IAAI,CAAI,IAAA,yBAAY,EAAC,MAAM,CAAC,CAAC,CAAC;IAElD,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;AACzB,CAAC,CAAA;AARY,QAAA,6BAA6B,iCAQzC"}

package/dist/cjs/node/index.js

@@ -0,0 +1,125 @@
+"use strict";
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+var __setFunctionName = (this && this.__setFunctionName) || function (f, name, prefix) {
+    if (typeof name === "symbol") name = name.description ? "[".concat(name.description, "]") : "";
+    return Object.defineProperty(f, "name", { configurable: true, value: prefix ? "".concat(prefix, " ", name) : name });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeOmniWorker = void 0;
+const worker_threads_1 = require("worker_threads");
+const comlink_1 = __importDefault(require("comlink"));
+const node_adapter_1 = __importDefault(require("comlink/dist/umd/node-adapter"));
+const builder_1 = require("./builder");
+const helpers_1 = require("../types/helpers");
+/**
+ * OmniWorker for NodeJS
+ */
+let NodeOmniWorker = (() => {
+    let _classDecorators = [(0, helpers_1.staticImplements)(), (0, helpers_1.staticImplements)()];
+    let _classDescriptor;
+    let _classExtraInitializers = [];
+    let _classThis;
+    var NodeOmniWorker = _classThis = class {
+        constructor(code, worker, api) {
+            this.isInitialized = () => (this._api !== undefined);
+            this.use = () => {
+                const isInitialized = this.isInitialized();
+                if (isInitialized) {
+                    return this._api;
+                }
+                else {
+                    throw Error('worker is not yet initialized. make sure to call the build() function, first');
+                }
+            };
+            this.clone = (numOfTimes) => {
+                const workers = [];
+                const code = this._code;
+                for (let i = 0; i <= numOfTimes; i++) {
+                    const { worker, api } = (0, builder_1.buildNodeApiAndWorkerFromCode)(code);
+                    workers.push(new NodeOmniWorker(code, worker, api));
+                }
+                return workers;
+            };
+            this.destroy = async () => {
+                await this._worker.terminate();
+            };
+            this._code = code;
+            this._worker = worker;
+            this._api = api;
+            return this;
+        }
+        /**
+         * Handles the building of the necessary resources for an OmniWorker to function.
+         * This usually means, building from the consumer's code, creating the comlink
+         * interface between the worker and the main thread as well as the worker itself.
+         *
+         * @param path Relative path FROM YOUR PROJECT's ROOT to the file to be the worker
+         * @returns An OmniWorker
+         */
+        static async build(path) {
+            const code = await (0, builder_1.genWorkerCodeFromFile)(path);
+            const { worker, api } = (0, builder_1.buildNodeApiAndWorkerFromCode)(code);
+            return new NodeOmniWorker(code, worker, api);
+        }
+    };
+    __setFunctionName(_classThis, "NodeOmniWorker");
+    (() => {
+        const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
+        __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
+        NodeOmniWorker = _classThis = _classDescriptor.value;
+        if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+    })();
+    /**
+     * Expose the functions inside the worker to the rest of the application.
+     * After having exposed the functions, the build step can be initiated.
+     * @param exposable A class, object with functions or a single function to be
+     * exposed to the main thread.
+     */
+    _classThis.expose = (exposable) => {
+        if (worker_threads_1.parentPort) {
+            comlink_1.default.expose(exposable, (0, node_adapter_1.default)(worker_threads_1.parentPort));
+        }
+    };
+    (() => {
+        __runInitializers(_classThis, _classExtraInitializers);
+    })();
+    return NodeOmniWorker = _classThis;
+})();
+exports.NodeOmniWorker = NodeOmniWorker;
+//# sourceMappingURL=index.js.map

package/dist/cjs/node/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/node/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,mDAAoE;AACpE,sDAA8B;AAC9B,iFAAyD;AACzD,uCAAiF;AACjF,8CAAoD;AAEpD;;GAEG;IAGU,cAAc;4BAF1B,IAAA,0BAAgB,GAAc,EAC9B,IAAA,0BAAgB,GAAc;;;;;QAO7B,YACE,IAAY,EACZ,MAAoB,EACpB,GAA4B;YAoCvB,kBAAa,GAAG,GAAY,EAAE,CAAC,CACpC,IAAI,CAAC,IAAI,KAAK,SAAS,CACxB,CAAC;YAEK,QAAG,GAAG,GAAG,EAAE;gBAChB,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;gBAC3C,IAAI,aAAa,EAAE,CAAC;oBAClB,OAAO,IAAI,CAAC,IAAK,CAAC;gBACpB,CAAC;qBAAM,CAAC;oBACN,MAAM,KAAK,CAAC,8EAA8E,CAAC,CAAC;gBAC9F,CAAC;YACH,CAAC,CAAA;YAEM,UAAK,GAAG,CAAC,UAAkB,EAAE,EAAE;gBACpC,MAAM,OAAO,GAAwB,EAAE,CAAC;gBACxC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;gBACxB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC;oBACrC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,IAAA,uCAA6B,EAAI,IAAI,CAAC,CAAC;oBAC/D,OAAO,CAAC,IAAI,CAAC,IAAI,cAAc,CAAI,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;gBACzD,CAAC;gBACD,OAAO,OAAO,CAAC;YACjB,CAAC,CAAA;YAEM,YAAO,GAAG,KAAK,IAAI,EAAE;gBAC1B,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YACjC,CAAC,CAAA;YA3DC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;YACtB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;YAChB,OAAO,IAAI,CAAC;QACd,CAAC;QAcD;;;;;;;WAOG;QACI,MAAM,CAAC,KAAK,CAAC,KAAK,CACvB,IAAY;YAEZ,MAAM,IAAI,GAAG,MAAM,IAAA,+BAAqB,EAAC,IAAI,CAAC,CAAC;YAC/C,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,IAAA,uCAA6B,EAAI,IAAI,CAAC,CAAC;YAC/D,OAAO,IAAI,cAAc,CAAI,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;QAClD,CAAC;;;;;QA3CH,6KAuEC;;;;IAtDC;;;;;OAKG;IACW,iBAAM,GAAG,CAAI,SAAY,EAAE,EAAE;QACzC,IAAI,2BAAU,EAAE,CAAC;YACf,iBAAO,CAAC,MAAM,CAAC,SAAS,EAAE,IAAA,sBAAY,EAAC,2BAAU,CAAC,CAAC,CAAC;QACtD,CAAC;IACH,CAAC,AAJmB,CAInB;;QA3BU,uDAAc;;;;AAAd,wCAAc"}