easy-web-worker 1.0.6 → 1.0.7

package/lib/EasyWebWorkerFixtures.js

@@ -1,40 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkerTemplate = exports.generatedId = void 0;
-const generatedId = () => `${new Date().getTime()}${Math.random().toString(36).substr(2, 9)}`;
+var generatedId = function () {
+    return "".concat(new Date().getTime()).concat(Math.random().toString(36).substr(2, 9));
+};
 exports.generatedId = generatedId;
-const WorkerTemplate = () => `
-// this code was auto-generated
-  const easyWorker = new (class {
-    onMessageCallback = () => {
-      // eslint-disable-next-line no-throw-literal
-      throw "you didnt defined a message-callback, please assign a callback by calling IEasyWorkerInstance.onMessage";
-    };
-
-    onMessage = (callback) => {
-      this.onMessageCallback = callback;
-    };
-  })();
-
-  self.onmessage = (event) => {
-    const { messageId, payload } = event.data;
-
-    // each message should have his own resolution methods
-    const message = new (class {
-      payload = payload;
-
-      messageId = messageId;
-
-      resolve = (...result) => self.postMessage({ messageId, payload: result });
-
-      reject = (error) => this.resolve({ error });
-
-      reportProgress = (progressPercentage) =>
-        self.postMessage({ messageId, progressPercentage });
-    })();
-
-    easyWorker.onMessageCallback(message, event);
-  };
-`;
+/**
+ * This is the template of the worker, should be and string to avoid compilation issues
+ */
+var WorkerTemplate = function () { return "\n  //this-code-was auto-generated\n  const easyWorker = new (class {\n    onMessageCallback = () => {\n      throw \"you didn't defined a message-callback, please assign a callback by calling IEasyWorkerInstance.onMessage\";\n    };\n\n    onMessage = (callback) => {\n      this.onMessageCallback = callback;\n    };\n  })();\n\n  self.onmessage = (event) => {\n    const { messageId, payload } = event.data;\n\n    // each message should have his own resolution methods\n    const message = new (class {\n      payload = payload;\n\n      messageId = messageId;\n\n      resolve = (...result) => self.postMessage({ messageId, payload: result });\n\n      reject = (reason) => self.postMessage({ messageId, reason });\n\n      cancel = (reason) => self.postMessage({  messageId, reason, wasCanceled: true });\n\n      reportProgress = (progressPercentage) => self.postMessage({ messageId, progressPercentage });\n    })();\n\n    easyWorker.onMessageCallback(message, event);\n  };\n"; };
 exports.WorkerTemplate = WorkerTemplate;
-exports.default = exports.generatedId;

package/lib/EasyWebWorkerMessage.d.ts

@@ -1,20 +1,50 @@
-import * as IEasyWebWorker from './EasyWebWorkerTypes';
-declare class EasyWebWorkerMessage<IPayload = null, IResult = void> implements IEasyWebWorker.IEasyWebWorkerMessage<IPayload, IResult> {
-    payload: IPayload;
+import { TDecoupledCancelablePromise, TOnProgressCallback } from 'cancelable-promise-jq';
+/**
+ * This class represents a message that will be send to a worker
+ */
+export declare class EasyWebWorkerMessage<TPayload = null, TResult = void> {
+    payload: TPayload;
+    /**
+     * This is the message id, it's generated automatically
+     */
     messageId: string;
+    /**
+     * This flag will be true when the message was completed
+     */
     wasCompleted: boolean;
+    /**
+     * This flag will be true when the message was canceled
+     */
     wasCanceled: boolean;
-    promise: Promise<IResult>;
-    resolve: (...args: IResult extends void ? [null?] : [IResult]) => void;
-    reject: (reason: Error) => void;
-    reportProgress: IEasyWebWorker.OnProgressCallback;
-    constructor(payload: IPayload);
-    protected createPromise(): {
-        promise: Promise<IResult>;
-        resolve: (...args: IResult extends void ? [null?] : [IResult]) => void;
-        reject: (reason: Error) => void;
-    };
-    cancel(): void;
+    /**
+     * Reason of the cancelation or rejection of the message
+     */
+    reason?: unknown;
+    /**
+     * Decoupled promise that will be resolved when the message is completed
+     * The decoupled promise is a promise that can be resolved, rejected or canceled from outside
+     */
+    decoupledPromise: TDecoupledCancelablePromise<TResult>;
+    /**
+     * This method will resolve the decoupled promise
+     */
+    resolve: (...args: TResult extends void ? [null?] : [TResult]) => void;
+    /**
+     * This method will reject the decoupled promise
+     */
+    reject: (reason: unknown) => void;
+    /**
+     * This method will cancel the decoupled promise
+     */
+    cancel: (reason: unknown) => void;
+    /**
+     * This method will report the progress of the message
+     * @param {number} progressPercentage - This is the progress percentage
+     */
+    reportProgress: TOnProgressCallback;
+    /**
+     * This is the constructor of the class
+     * @param {TPayload} payload - This are the parameters included in the message
+     */
+    constructor(payload: TPayload);
 }
-export default EasyWebWorkerMessage;
-//# sourceMappingURL=EasyWebWorkerMessage.d.ts.map

package/lib/EasyWebWorkerMessage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EasyWebWorkerMessage.d.ts","sourceRoot":"","sources":["../src/EasyWebWorkerMessage.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,cAAc,MAAM,sBAAsB,CAAC;AAEvD,cAAM,oBAAoB,CAAC,QAAQ,GAAG,IAAI,EAAE,OAAO,GAAG,IAAI,CAAE,YAAW,cAAc,CAAC,qBAAqB,CAAC,QAAQ,EAAE,OAAO,CAAC;IAkBzG,OAAO,EAAE,QAAQ;IAhB7B,SAAS,EAAE,MAAM,CAAC;IAElB,YAAY,UAAS;IAErB,WAAW,UAAS;IAEpB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAE1B,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IAEvE,MAAM,EAAE,CAAC,MAAM,EAAE,KAAK,KAAK,IAAI,CAAC;IAEhC,cAAc,EAAE,cAAc,CAAC,kBAAkB,CAEvD;gBAEkB,OAAO,EAAE,QAAQ;IASpC,SAAS,CAAC,aAAa,IAAI;QACzB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAC1B,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;QACvE,MAAM,EAAE,CAAC,MAAM,EAAE,KAAK,KAAK,IAAI,CAAA;KAC9B;IAeI,MAAM;CAId;AAED,eAAe,oBAAoB,CAAC"}
+{"version":3,"file":"EasyWebWorkerMessage.d.ts","sourceRoot":"","sources":["../src/EasyWebWorkerMessage.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,EAE3B,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAG/B;;GAEG;AACH,qBAAa,oBAAoB,CAAC,QAAQ,GAAG,IAAI,EAAE,OAAO,GAAG,IAAI;IAwD5C,OAAO,EAAE,QAAQ;IAvDpC;;OAEG;IACI,SAAS,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACI,YAAY,UAAS;IAE5B;;OAEG;IACI,WAAW,UAAS;IAE3B;;OAEG;IACI,MAAM,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACI,gBAAgB,EAAE,2BAA2B,CAAC,OAAO,CAAC,CAAC;IAE9D;;OAEG;IACI,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IAE9E;;OAEG;IACI,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IAEzC;;OAEG;IACI,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IAEzC;;;OAGG;IACI,cAAc,EAAE,mBAAmB,CAIxC;IAEF;;;OAGG;gBACgB,OAAO,EAAE,QAAQ;CAiBrC"}

package/lib/EasyWebWorkerMessage.js

@@ -1,33 +1,44 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const EasyWebWorkerFixtures_1 = require("./EasyWebWorkerFixtures");
-class EasyWebWorkerMessage {
-    constructor(payload) {
+exports.EasyWebWorkerMessage = void 0;
+var cancelable_promise_jq_1 = require("cancelable-promise-jq");
+var EasyWebWorkerFixtures_1 = require("./EasyWebWorkerFixtures");
+/**
+ * This class represents a message that will be send to a worker
+ */
+var EasyWebWorkerMessage = /** @class */ (function () {
+    /**
+     * This is the constructor of the class
+     * @param {TPayload} payload - This are the parameters included in the message
+     */
+    function EasyWebWorkerMessage(payload) {
+        var _this = this;
         this.payload = payload;
+        /**
+         * This flag will be true when the message was completed
+         */
         this.wasCompleted = false;
+        /**
+         * This flag will be true when the message was canceled
+         */
         this.wasCanceled = false;
-        this.reportProgress = () => {
+        /**
+         * This method will report the progress of the message
+         * @param {number} progressPercentage - This is the progress percentage
+         */
+        this.reportProgress = function () {
             throw new Error('Message should receive a progress-callback in order to be able to report... send(..).onProgressCallback');
         };
-        this.messageId = EasyWebWorkerFixtures_1.generatedId();
-        const { promise, resolve, reject } = this.createPromise();
-        this.promise = promise;
-        this.resolve = resolve;
-        this.reject = reject;
-    }
-    createPromise() {
-        let resolve = () => { };
-        let reject = () => { };
-        const promise = new Promise((_resolve, _reject) => {
-            resolve = _resolve;
-            reject = _reject;
+        this.messageId = (0, EasyWebWorkerFixtures_1.generatedId)();
+        this.decoupledPromise = (0, cancelable_promise_jq_1.createDecoupledPromise)();
+        this.resolve = this.decoupledPromise.resolve;
+        this.reject = this.decoupledPromise.reject;
+        this.cancel = this.decoupledPromise.cancel;
+        this.reportProgress = this.decoupledPromise.promise.reportProgress;
+        this.decoupledPromise.onCancel(function () {
+            _this.wasCanceled = true;
         });
-        return {
-            promise, reject, resolve,
-        };
-    }
-    cancel() {
-        this.wasCanceled = true;
     }
-}
-exports.default = EasyWebWorkerMessage;
+    return EasyWebWorkerMessage;
+}());
+exports.EasyWebWorkerMessage = EasyWebWorkerMessage;

package/lib/EasyWebWorkerTypes.d.ts

@@ -1,87 +1,97 @@
-export declare type OnProgressCallback = (progressPercentage: number) => void;
+/**
+ * EasyWorker Config
+ * */
 export interface IWorkerConfig {
     /**
      **  External scripts that you want to include in your worker
      */
     scripts: string[];
     /**
-     **  Identifier of your worker, this is in case you want to add a name to your worker file, otherwize an unique generic Id will be added as a name
+     **  Identifier of your worker, this is in case you want to add a name to your worker file, otherwise an unique generic Id will be added as a name
      */
     name: string;
+    /**
+     * Callback that will be executed when the worker fails, this not necessary affect the current message execution
+     * */
+    onWorkerError: (error: ErrorEvent) => void;
 }
+/**
+ * This is the structure that the messages of the worker will have
+ */
 export interface IMessageData<IPayload = null> {
+    /**
+     * This are the parameters included in the message
+     */
     payload: IPayload;
-    error: string;
-    progressPercentage: number;
+    /**
+     * The messages from the worker could include errors if something went wrong
+     * */
+    reason: unknown;
+    /**
+     * Indicates if the message was canceled
+     * */
+    wasCanceled: boolean;
+    /**
+     * The messages from the worker could include a progress percentage
+     * */
+    progressPercentage?: number;
+    /**
+     * This is the message id
+     * */
     messageId: string;
 }
 export interface IEasyWorkerInstance<IPayload = null, IResult = void> {
     /**
-    * Use this method to defined which will be the functionality of your worker when a message is send  to it
-    * @param {(message: IEasyWebWorkerMessage<IPayload, IResult>, event: MessageEvent<IMessageData<IPayload>>) => void} callback - current message
-    // * @returns {void}
-    * */
+     * Use this method to defined which will be the functionality of your worker when a message is send  to it
+     * @param {function} callback - This is the callback that will be executed when a message is received
+     * @param {IEasyWebWorkerMessage} callback.message - This is the message that was received
+     * @param {IEasyWebWorkerMessage} callback.message.messageId - This is the message id
+     * @param {IEasyWebWorkerMessage} callback.message.payload - This are the parameters included in the message
+     * @param {IEasyWebWorkerMessage} callback.message.reject - This method is used to reject the message from inside the worker
+     * @param {IEasyWebWorkerMessage} callback.message.reportProgress - This method is used to report the progress of the message from inside the worker
+     * @param {IEasyWebWorkerMessage} callback.message.resolve - This method is used to resolve the message from inside the worker
+     * @param {MessageEvent} callback.event - This is the event that was received
+     * */
     onMessage(callback: (message: IEasyWebWorkerMessage<IPayload, IResult>, event: MessageEvent<IMessageData<IPayload>>) => void): void;
 }
 export interface IEasyWebWorkerMessage<IPayload = null, IResult = void> {
+    /**
+     * This is the message id
+     */
     messageId: string;
-    payload: IPayload;
-    reject: (reason: Error) => void;
-    reportProgress(progressPercentage: number): void;
-    resolve: (...args: IResult extends void ? [null?] : [IResult]) => void;
-}
-/**
-* This type defined the structure that a WorkerBody should have.
-* @template IPayload - Indicates if your WORKERS messages requires a parameter to be provided, NULL indicates they doesn't
-* @template IResult - Indicates if your WORKERS messages has a result... NULL indicates all you messages are Promise<void>
-* @param {IEasyWorkerInstance<IPayload, IResult>} easyWorker - ,
-*/
-export declare type EasyWebWorkerBody<IPayload = null, IResult = void> = (easyWorker: IEasyWorkerInstance<IPayload, IResult>, context: any) => void;
-export interface IMessagePromise<IResult = void> extends Promise<IResult> {
-    onProgress: (callback: OnProgressCallback) => Promise<IResult>;
-}
-/**
-* This is a class to create global-store objects
-* @template IPayload - Indicates if your WORKERS messages requires a parameter to be provided, NULL indicates they doesn't
-* @template IResult - Indicates if your WORKERS messages has a result... NULL indicates all you messages are Promise<void>
-* @param {IEasyWebWorker.MessageBody<IPayload, IResult> | IEasyWebWorker.MessageBody<IPayload, IResult>[]} workerBody -
-* this parameter should be a function or set of functions that will become the body of your Web-Worker
-* IMPORTANT!! all WORKERS content is gonna be transpiled on run time, so you can not use any variable, method of resource that weren't included into the WORKER.
-* the above the reason of why we are injecting all worker context into the MessageBody Callbacks, so,
-* you could easily identify what is on the context of your Worker.
-* @param {Partial<IEasyWebWorker.IWorkerConfig>} WorkerConfig - You could add extra configuration to your worker,
-* consult IWorkerConfig description to have more information
-* */
-export interface IEasyWebWorker<IPayload = null, IResult = void> {
-    name: string;
-    workerUrl: string;
     /**
-    * This method will remove the WebWorker and the BlobUrl
-    */
-    dispose(): void;
+     * This are the parameters included in the message
+     * */
+    payload: IPayload;
     /**
-    * Disable the resolve of all current WebWorkers messages, no any of the current messages gonna call onProgress callback, neither promise.resolve
-    */
-    cancelAll(): void;
+     * This method is used to reject the message from inside the worker
+     * */
+    reject: (reason?: unknown) => void;
     /**
-    * Send a message to the worker queue
-    * @param {IPayload} payload - whatever json data you want to send to the worker
-    * @returns {IMessagePromise<IResult>} generated defer that will be resolved when the message completed
-    */
-    send(...payload: IPayload extends null ? [null?] : [IPayload]): IMessagePromise<IResult>;
+     * This method is used to report the progress of the message from inside the worker
+     * */
+    reportProgress(progressPercentage: number): void;
     /**
-    * Web Workers works as a QUEUE, sometimes a new message actually would be the only message that you'll want to resolve...
-    * you could use OVERRIDE to that purpose.
-    * @param {IPayload} payload - whatever json data you want to send to the worker
-    * @returns {IMessagePromise<IResult>} generated defer that will be resolved when the message completed
-    */
-    override(...payload: IPayload extends null ? [null?] : [IPayload]): IMessagePromise<IResult>;
+     * This method is used to resolve the message from inside the worker
+     * */
+    resolve: (...args: IResult extends void ? [null?] : [IResult]) => void;
     /**
-    * Web Workers works as a QUEUE, sometimes a new message actually would be the only message that you'll want to resolve...
-    * you could use OVERRIDE to that purpose.
-    * @param {IPayload} payload - whatever json data you want to send to the worker
-    * @returns {IMessagePromise<IResult>} generated defer that will be resolved when the message completed
-    */
-    overrideAfterCurrent(...payload: IPayload extends null ? [null?] : [IPayload]): IMessagePromise<IResult>;
+     * This method is used to cancel the message from inside the worker
+     * */
+    cancel: (reason?: unknown) => void;
 }
-//# sourceMappingURL=EasyWebWorkerTypes.d.ts.map
+/**
+ * This type defined the structure that a WorkerBody should have.
+ * @template IPayload - Indicates if your WORKERS messages requires a parameter to be provided, NULL indicates they doesn't
+ * @template IResult - Indicates if your WORKERS messages has a result... NULL indicates all you messages are Promise<void>
+ * @param {IEasyWorkerInstance<IPayload, IResult>} easyWorker - ,
+ */
+export type EasyWebWorkerBody<IPayload = null, IResult = void> = (
+/**
+ * This is the instance of the worker that you can use to communicate with the main thread
+ */
+easyWorker: IEasyWorkerInstance<IPayload, IResult>, 
+/**
+ * This is the context of the worker, you can use it to access to the global scope of the worker
+ * */
+context: any) => void;

package/lib/EasyWebWorkerTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EasyWebWorkerTypes.d.ts","sourceRoot":"","sources":["../src/EasyWebWorkerTypes.ts"],"names":[],"mappings":"AAAA,oBAAY,kBAAkB,GAAG,CAAC,kBAAkB,EAAE,MAAM,KAAK,IAAI,CAAC;AAEtE,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,YAAY,CAAC,QAAQ,GAAG,IAAI;IAC3C,OAAO,EAAE,QAAQ,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,kBAAkB,EAAE,MAAM,CAAC;IAC3B,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,mBAAmB,CAAC,QAAQ,GAAG,IAAI,EAAE,OAAO,GAAG,IAAI;IAClE;;;;QAII;IACJ,SAAS,CACP,QAAQ,EAAE,CACR,OAAO,EAAE,qBAAqB,CAAC,QAAQ,EAAE,OAAO,CAAC,EACjD,KAAK,EAAE,YAAY,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,KACxC,IAAI,GACR,IAAI,CAAC;CAET;AAED,MAAM,WAAW,qBAAqB,CAAC,QAAQ,GAAG,IAAI,EAAE,OAAO,GAAG,IAAI;IAEpE,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,QAAQ,CAAC;IAElB,MAAM,EAAE,CAAC,MAAM,EAAE,KAAK,KAAK,IAAI,CAAC;IAEhC,cAAc,CAAC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjD,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;CAExE;AAED;;;;;EAKE;AACF,oBAAY,iBAAiB,CAAC,QAAQ,GAAG,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,CAAC,UAAU,EAAE,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,KAAK,IAAI,CAAC;AAE5I,MAAM,WAAW,eAAe,CAAC,OAAO,GAAG,IAAI,CAAE,SAAQ,OAAO,CAAC,OAAO,CAAC;IACvE,UAAU,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAChE;AAED;;;;;;;;;;;IAWI;AACJ,MAAM,WAAW,cAAc,CAAE,QAAQ,GAAG,IAAI,EAAE,OAAO,GAAG,IAAI;IAE9D,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,EAAE,MAAM,CAAC;IAElB;;MAEE;IACF,OAAO,IAAI,IAAI,CAAC;IAEhB;;MAEE;IACF,SAAS,IAAI,IAAI,CAAC;IAElB;;;;MAIE;IACF,IAAI,CAAC,GAAG,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;IAEzF;;;;;MAKE;IACF,QAAQ,CAAC,GAAG,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;IAE7F;;;;;MAKE;IACF,oBAAoB,CAAC,GAAG,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;CAE1G"}
+{"version":3,"file":"EasyWebWorkerTypes.d.ts","sourceRoot":"","sources":["../src/EasyWebWorkerTypes.ts"],"names":[],"mappings":"AAAA;;KAEK;AACL,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;SAEK;IACL,aAAa,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,QAAQ,GAAG,IAAI;IAC3C;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAC;IAElB;;SAEK;IACL,MAAM,EAAE,OAAO,CAAC;IAEhB;;SAEK;IACL,WAAW,EAAE,OAAO,CAAC;IAErB;;SAEK;IACL,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;SAEK;IACL,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB,CAAC,QAAQ,GAAG,IAAI,EAAE,OAAO,GAAG,IAAI;IAClE;;;;;;;;;;SAUK;IACL,SAAS,CACP,QAAQ,EAAE,CACR,OAAO,EAAE,qBAAqB,CAAC,QAAQ,EAAE,OAAO,CAAC,EACjD,KAAK,EAAE,YAAY,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,KACxC,IAAI,GACR,IAAI,CAAC;CACT;AAED,MAAM,WAAW,qBAAqB,CAAC,QAAQ,GAAG,IAAI,EAAE,OAAO,GAAG,IAAI;IACpE;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;SAEK;IACL,OAAO,EAAE,QAAQ,CAAC;IAElB;;SAEK;IACL,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IAEnC;;SAEK;IACL,cAAc,CAAC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjD;;SAEK;IACL,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IAEvE;;SAEK;IACL,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;CACpC;AAED;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,CAAC,QAAQ,GAAG,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI;AAC/D;;GAEG;AACH,UAAU,EAAE,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC;AAElD;;KAEK;AACL,OAAO,EAAE,GAAG,KACT,IAAI,CAAC"}

package/lib/StaticEasyWebWorker.d.ts

@@ -1,18 +1,64 @@
-import * as IEasyWebWorker from './EasyWebWorkerTypes';
-export declare class WorkerMessage<IPayload = null, IResult = void> implements IEasyWebWorker.IEasyWebWorkerMessage<IPayload, IResult> {
+import { IEasyWebWorkerMessage, IEasyWorkerInstance, IMessageData } from './EasyWebWorkerTypes';
+/**
+ * This message wrap the interaction with the worker to ensure that the message is correctly synchronized with the EasyWebWorker
+ */
+export declare class WorkerMessage<IPayload = null, IResult = void> implements IEasyWebWorkerMessage<IPayload, IResult> {
     payload: IPayload;
     messageId: string;
     protected messageTargetOrigin: string;
+    /**
+     * @param {IPayload} payload - This are the parameters included in the message
+     * @param {string} messageId - This is the message id
+     * @param {string} messageTargetOrigin - This is the target origin of the message
+     */
     constructor(payload: IPayload, messageId: string, messageTargetOrigin?: string);
-    resolve(...result: [null?] | [any]): void;
-    reject(error: string | Error): void;
+    /**
+     * This method is used to resolve the message from inside the worker
+     */
+    resolve(...payload: [null?] | [any]): void;
+    /**
+     * This method is used to reject the message from inside the worker
+     * */
+    reject(reason: unknown): void;
+    /**
+     * This method is used to cancel the message from inside the worker
+     */
+    cancel(reason?: unknown): void;
+    /**
+     * This method is used to report the progress of the message from inside the worker
+     * */
     reportProgress(progressPercentage: number): void;
 }
-export declare class StaticEasyWebWorker<IPayload = null, IResult = void> implements IEasyWebWorker.IEasyWorkerInstance<IPayload, IResult> {
-    onMessageCallback: (message: IEasyWebWorker.IEasyWebWorkerMessage<IPayload, IResult>, event: MessageEvent<IEasyWebWorker.IMessageData<IPayload>>) => void;
-    constructor(onMessageCallback: (message: IEasyWebWorker.IEasyWebWorkerMessage<IPayload, IResult>, event: MessageEvent<IEasyWebWorker.IMessageData<IPayload>>) => void, messageTargetOrigin?: string);
+/**
+ * This class is used to create a static worker
+ * @param {function} onMessageCallback - This is the callback that will be executed when a message is received
+ * @param {IEasyWebWorkerMessage} onMessageCallback.message - This is the message that was received
+ * @param {IEasyWebWorkerMessage} onMessageCallback.message.messageId - This is the message id
+ * @param {IEasyWebWorkerMessage} onMessageCallback.message.payload - This are the parameters included in the message
+ * @param {IEasyWebWorkerMessage} onMessageCallback.message.reject - This method is used to reject the message from inside the worker
+ * @param {IEasyWebWorkerMessage} onMessageCallback.message.reportProgress - This method is used to report the progress of the message from inside the worker
+ * @param {IEasyWebWorkerMessage} onMessageCallback.message.resolve - This method is used to resolve the message from inside the worker
+ * @param {MessageEvent} onMessageCallback.event - This is the event that was received
+ * @param {string} messageTargetOrigin - This is the target origin of the message
+ */
+export declare class StaticEasyWebWorker<IPayload = null, IResult = void> implements IEasyWorkerInstance<IPayload, IResult> {
+    onMessageCallback: (message: IEasyWebWorkerMessage<IPayload, IResult>, event: MessageEvent<IMessageData<IPayload>>) => void;
+    constructor(onMessageCallback: (message: IEasyWebWorkerMessage<IPayload, IResult>, event: MessageEvent<IMessageData<IPayload>>) => void, messageTargetOrigin?: string);
+    /**
+     * This method is used to define the onMessage callback
+     * @param {string} messageTargetOrigin - This is the target origin of the message
+     * */
     defineOnMessage(messageTargetOrigin: string): void;
-    onMessage(callback: (message: IEasyWebWorker.IEasyWebWorkerMessage<IPayload, IResult>, event: MessageEvent<IEasyWebWorker.IMessageData<IPayload>>) => void): void;
+    /**
+     * This method is used to define the onMessage callback
+     * @param {function} callback - This is the callback that will be executed when a message is received
+     * @param {IEasyWebWorkerMessage} callback.message - This is the message that was received
+     * @param {IEasyWebWorkerMessage} callback.message.messageId - This is the message id
+     * @param {IEasyWebWorkerMessage} callback.message.payload - This are the parameters included in the message
+     * @param {IEasyWebWorkerMessage} callback.message.reject - This method is used to reject the message from inside the worker
+     * @param {IEasyWebWorkerMessage} callback.message.reportProgress - This method is used to report the progress of the message from inside the worker
+     * @param {IEasyWebWorkerMessage} callback.message.resolve - This method is used to resolve the message from inside the worker
+     * @param {MessageEvent} callback.event - This is the event that was received
+     */
+    onMessage(callback: (message: IEasyWebWorkerMessage<IPayload, IResult>, event: MessageEvent<IMessageData<IPayload>>) => void): void;
 }
-export default StaticEasyWebWorker;
-//# sourceMappingURL=StaticEasyWebWorker.d.ts.map

package/lib/StaticEasyWebWorker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StaticEasyWebWorker.d.ts","sourceRoot":"","sources":["../src/StaticEasyWebWorker.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,cAAc,MAAM,sBAAsB,CAAC;AAEvD,qBAAa,aAAa,CAAC,QAAQ,GAAG,IAAI,EAAE,OAAO,GAAG,IAAI,CAAE,YAAW,cAAc,CAAC,qBAAqB,CAAC,QAAQ,EAAE,OAAO,CAAC;IAEzG,OAAO,EAAE,QAAQ;IAAS,SAAS,EAAE,MAAM;IAAE,SAAS,CAAC,mBAAmB,EAAE,MAAM;gBAAlF,OAAO,EAAE,QAAQ,EAAS,SAAS,EAAE,MAAM,EAAY,mBAAmB,GAAE,MAAY;IAEpG,OAAO,CAAC,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAIlC,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK;IAI5B,cAAc,CAAC,kBAAkB,EAAE,MAAM;CAIjD;AAED,qBAAa,mBAAmB,CAAC,QAAQ,GAAG,IAAI,EAAE,OAAO,GAAG,IAAI,CAAE,YAAW,cAAc,CAAC,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC;IAE7G,iBAAiB,EAAE,CACpC,OAAO,EAAE,cAAc,CAAC,qBAAqB,CAAC,QAAQ,EAAE,OAAO,CAAC,EAChE,KAAK,EAAE,YAAY,CAAC,cAAc,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,KACvD,IAAI;gBAHU,iBAAiB,EAAE,CACpC,OAAO,EAAE,cAAc,CAAC,qBAAqB,CAAC,QAAQ,EAAE,OAAO,CAAC,EAChE,KAAK,EAAE,YAAY,CAAC,cAAc,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,KACvD,IAAI,EAAE,mBAAmB,GAAE,MAAY;IAIrC,eAAe,CAAC,mBAAmB,EAAE,MAAM,GAAG,IAAI;IAWlD,SAAS,CAAC,QAAQ,EAAE,CACzB,OAAO,EAAE,cAAc,CAAC,qBAAqB,CAAC,QAAQ,EAAE,OAAO,CAAC,EAChE,KAAK,EAAE,YAAY,CAAC,cAAc,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,KACvD,IAAI,GAAG,IAAI;CAIjB;AAED,eAAe,mBAAmB,CAAC"}
+{"version":3,"file":"StaticEasyWebWorker.d.ts","sourceRoot":"","sources":["../src/StaticEasyWebWorker.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,mBAAmB,EACnB,YAAY,EACb,MAAM,sBAAsB,CAAC;AAE9B;;GAEG;AACH,qBAAa,aAAa,CAAC,QAAQ,GAAG,IAAI,EAAE,OAAO,GAAG,IAAI,CACxD,YAAW,qBAAqB,CAAC,QAAQ,EAAE,OAAO,CAAC;IAQ1C,OAAO,EAAE,QAAQ;IACjB,SAAS,EAAE,MAAM;IACxB,SAAS,CAAC,mBAAmB,EAAE,MAAM;IARvC;;;;OAIG;gBAEM,OAAO,EAAE,QAAQ,EACjB,SAAS,EAAE,MAAM,EACd,mBAAmB,GAAE,MAAY;IAG7C;;OAEG;IACI,OAAO,CAAC,GAAG,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAM1C;;SAEK;IACE,MAAM,CAAC,MAAM,EAAE,OAAO;IAI7B;;OAEG;IACI,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO;IAI9B;;SAEK;IACE,cAAc,CAAC,kBAAkB,EAAE,MAAM;CAQjD;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,mBAAmB,CAAC,QAAQ,GAAG,IAAI,EAAE,OAAO,GAAG,IAAI,CAC9D,YAAW,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC;IAGxC,iBAAiB,EAAE,CACxB,OAAO,EAAE,qBAAqB,CAAC,QAAQ,EAAE,OAAO,CAAC,EACjD,KAAK,EAAE,YAAY,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,KACxC,IAAI;gBAHF,iBAAiB,EAAE,CACxB,OAAO,EAAE,qBAAqB,CAAC,QAAQ,EAAE,OAAO,CAAC,EACjD,KAAK,EAAE,YAAY,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,KACxC,IAAI,EACT,mBAAmB,GAAE,MAAY;IAKnC;;;SAGK;IACE,eAAe,CAAC,mBAAmB,EAAE,MAAM,GAAG,IAAI;IAezD;;;;;;;;;;OAUG;IACI,SAAS,CACd,QAAQ,EAAE,CACR,OAAO,EAAE,qBAAqB,CAAC,QAAQ,EAAE,OAAO,CAAC,EACjD,KAAK,EAAE,YAAY,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,KACxC,IAAI,GACR,IAAI;CAGR"}

package/lib/StaticEasyWebWorker.js

@@ -1,40 +1,99 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StaticEasyWebWorker = exports.WorkerMessage = void 0;
-class WorkerMessage {
-    constructor(payload, messageId, messageTargetOrigin = '*') {
+/**
+ * This message wrap the interaction with the worker to ensure that the message is correctly synchronized with the EasyWebWorker
+ */
+var WorkerMessage = /** @class */ (function () {
+    /**
+     * @param {IPayload} payload - This are the parameters included in the message
+     * @param {string} messageId - This is the message id
+     * @param {string} messageTargetOrigin - This is the target origin of the message
+     */
+    function WorkerMessage(payload, messageId, messageTargetOrigin) {
+        if (messageTargetOrigin === void 0) { messageTargetOrigin = '*'; }
         this.payload = payload;
         this.messageId = messageId;
         this.messageTargetOrigin = messageTargetOrigin;
     }
-    resolve(...result) {
-        self.postMessage({ messageId: this.messageId, payload: result }, this.messageTargetOrigin);
-    }
-    reject(error) {
-        this.resolve({ error });
-    }
-    reportProgress(progressPercentage) {
-        self.postMessage({ messageId: this.messageId, progressPercentage }, this.messageTargetOrigin);
-    }
-}
+    /**
+     * This method is used to resolve the message from inside the worker
+     */
+    WorkerMessage.prototype.resolve = function () {
+        var payload = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            payload[_i] = arguments[_i];
+        }
+        var messageId = this.messageId;
+        self.postMessage({ messageId: messageId, payload: payload }, this.messageTargetOrigin);
+    };
+    /**
+     * This method is used to reject the message from inside the worker
+     * */
+    WorkerMessage.prototype.reject = function (reason) {
+        this.resolve({ error: reason });
+    };
+    /**
+     * This method is used to cancel the message from inside the worker
+     */
+    WorkerMessage.prototype.cancel = function (reason) {
+        this.resolve({ cancelled: true, error: reason });
+    };
+    /**
+     * This method is used to report the progress of the message from inside the worker
+     * */
+    WorkerMessage.prototype.reportProgress = function (progressPercentage) {
+        var messageId = this.messageId;
+        self.postMessage({ messageId: messageId, progressPercentage: progressPercentage }, this.messageTargetOrigin);
+    };
+    return WorkerMessage;
+}());
 exports.WorkerMessage = WorkerMessage;
-class StaticEasyWebWorker {
-    constructor(onMessageCallback, messageTargetOrigin = '*') {
+/**
+ * This class is used to create a static worker
+ * @param {function} onMessageCallback - This is the callback that will be executed when a message is received
+ * @param {IEasyWebWorkerMessage} onMessageCallback.message - This is the message that was received
+ * @param {IEasyWebWorkerMessage} onMessageCallback.message.messageId - This is the message id
+ * @param {IEasyWebWorkerMessage} onMessageCallback.message.payload - This are the parameters included in the message
+ * @param {IEasyWebWorkerMessage} onMessageCallback.message.reject - This method is used to reject the message from inside the worker
+ * @param {IEasyWebWorkerMessage} onMessageCallback.message.reportProgress - This method is used to report the progress of the message from inside the worker
+ * @param {IEasyWebWorkerMessage} onMessageCallback.message.resolve - This method is used to resolve the message from inside the worker
+ * @param {MessageEvent} onMessageCallback.event - This is the event that was received
+ * @param {string} messageTargetOrigin - This is the target origin of the message
+ */
+var StaticEasyWebWorker = /** @class */ (function () {
+    function StaticEasyWebWorker(onMessageCallback, messageTargetOrigin) {
+        if (messageTargetOrigin === void 0) { messageTargetOrigin = '*'; }
         this.onMessageCallback = onMessageCallback;
         this.defineOnMessage(messageTargetOrigin);
     }
-    defineOnMessage(messageTargetOrigin) {
-        self.onmessage = (event) => {
-            const { messageId, payload } = event.data;
+    /**
+     * This method is used to define the onMessage callback
+     * @param {string} messageTargetOrigin - This is the target origin of the message
+     * */
+    StaticEasyWebWorker.prototype.defineOnMessage = function (messageTargetOrigin) {
+        var _this = this;
+        self.onmessage = function (event) {
+            var _a = event.data, messageId = _a.messageId, payload = _a.payload;
             // each message should have his own resolution methods
-            const message = new WorkerMessage(payload, messageId, messageTargetOrigin);
-            this.onMessageCallback.call(this, message, event);
+            var message = new WorkerMessage(payload, messageId, messageTargetOrigin);
+            _this.onMessageCallback.call(_this, message, event);
         };
-    }
-    onMessage(callback) {
+    };
+    /**
+     * This method is used to define the onMessage callback
+     * @param {function} callback - This is the callback that will be executed when a message is received
+     * @param {IEasyWebWorkerMessage} callback.message - This is the message that was received
+     * @param {IEasyWebWorkerMessage} callback.message.messageId - This is the message id
+     * @param {IEasyWebWorkerMessage} callback.message.payload - This are the parameters included in the message
+     * @param {IEasyWebWorkerMessage} callback.message.reject - This method is used to reject the message from inside the worker
+     * @param {IEasyWebWorkerMessage} callback.message.reportProgress - This method is used to report the progress of the message from inside the worker
+     * @param {IEasyWebWorkerMessage} callback.message.resolve - This method is used to resolve the message from inside the worker
+     * @param {MessageEvent} callback.event - This is the event that was received
+     */
+    StaticEasyWebWorker.prototype.onMessage = function (callback) {
         this.onMessageCallback = callback;
-    }
-    ;
-}
+    };
+    return StaticEasyWebWorker;
+}());
 exports.StaticEasyWebWorker = StaticEasyWebWorker;
-exports.default = StaticEasyWebWorker;

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export * from './EasyWebWorker';
+export * from './EasyWebWorkerTypes';
+export * from './StaticEasyWebWorker';

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC"}

package/lib/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./EasyWebWorker"), exports);
+__exportStar(require("./EasyWebWorkerTypes"), exports);
+__exportStar(require("./StaticEasyWebWorker"), exports);