easy-web-worker 1.1.1 → 1.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "easy-web-worker",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "This is a library to easily handle and create web-workers, if you are a web developer and never tried this... do not wait any longer! Workers are an amazing option to improve user experience and make your webpages even greater",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/lib/EasyWebWorker.js

@@ -1,252 +0,0 @@
-"use strict";
-var __read = (this && this.__read) || function (o, n) {
-    var m = typeof Symbol === "function" && o[Symbol.iterator];
-    if (!m) return o;
-    var i = m.call(o), r, ar = [], e;
-    try {
-        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
-    }
-    catch (error) { e = { error: error }; }
-    finally {
-        try {
-            if (r && !r.done && (m = i["return"])) m.call(i);
-        }
-        finally { if (e) throw e.error; }
-    }
-    return ar;
-};
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EasyWebWorker = exports.createBlobWorker = exports.createBlobFromString = void 0;
-var EasyWebWorkerMessage_1 = require("./EasyWebWorkerMessage");
-var EasyWebWorkerFixtures_1 = require("./EasyWebWorkerFixtures");
-var getImportScriptsTemplate = function (scripts) {
-    if (scripts === void 0) { scripts = []; }
-    if (!scripts.length)
-        return '';
-    return "self.importScripts([\"".concat(scripts.join('","'), "\"]);");
-};
-var createBlobFromString = function (source, imports) {
-    if (imports === void 0) { imports = []; }
-    var content = "".concat(getImportScriptsTemplate(imports), "\n  ").concat(source);
-    return (window.URL || window.webkitURL).createObjectURL(new Blob([content], {
-        type: 'application/javascript',
-    }));
-};
-exports.createBlobFromString = createBlobFromString;
-var createBlobWorker = function (source, imports) {
-    if (imports === void 0) { imports = []; }
-    var template = (0, EasyWebWorkerFixtures_1.WorkerTemplate)();
-    var contentCollection = Array.isArray(source) ? source : [source];
-    return (window.URL || window.webkitURL).createObjectURL(new Blob([
-        "".concat(getImportScriptsTemplate(imports), "\n    \n        ").concat(template, "\n    \n        ").concat(contentCollection
-            .map(function (content, index) {
-            return "// content #".concat(index, "\n(").concat(content.toString(), ")(easyWorker, self);");
-        })
-            .join('\n\n')),
-    ], { type: 'application/javascript' }));
-};
-exports.createBlobWorker = createBlobWorker;
-/**
- * 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 {EasyWebWorkerBody<IPayload, IResult> | EasyWebWorkerBody<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<IWorkerConfig>} WorkerConfig - You could add extra configuration to your worker,
- * consult IWorkerConfig description to have more information
- * */
-var EasyWebWorker = /** @class */ (function () {
-    function EasyWebWorker(
-    /**
-     * 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.
-     */
-    workerBody, 
-    /**
-     * You could import scripts into your worker, this is useful if you want to use external libraries
-     */
-    _a) {
-        var 
-        /**
-         * You could import scripts into your worker, this is useful if you want to use external libraries
-         */
-        _b = _a === void 0 ? {} : _a, _c = _b.scripts, scripts = _c === void 0 ? [] : _c, name = _b.name, _d = _b.onWorkerError, onWorkerError = _d === void 0 ? null : _d;
-        var _this = this;
-        this.workerBody = workerBody;
-        /**
-         * These where send to the worker but not yet resolved
-         */
-        this.messagesQueue = new Map();
-        /**
-         * This is the list of scripts that will be imported into the worker
-         */
-        this.scripts = [];
-        /**
-         * 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
-         */
-        this.send = (function () {
-            var _a;
-            var payload = [];
-            for (var _i = 0; _i < arguments.length; _i++) {
-                payload[_i] = arguments[_i];
-            }
-            var _b = __read(payload, 1), $payload = _b[0];
-            var message = new EasyWebWorkerMessage_1.EasyWebWorkerMessage($payload);
-            var messageId = message.messageId;
-            _this.messagesQueue.set(message.messageId, message);
-            (_a = _this.worker) === null || _a === void 0 ? void 0 : _a.postMessage({
-                messageId: messageId,
-                payload: $payload,
-            });
-            return message.decoupledPromise.promise;
-        });
-        /**
-         * This method terminate all current messages and send a new one to the worker queue
-         * @param {IPayload} payload - whatever json data you want to send to the worker, should be serializable
-         * @param {unknown} reason - reason why the worker was terminated
-         * @returns {IMessagePromise<IResult>} generated defer that will be resolved when the message completed
-         */
-        this.override = (function () {
-            var _a = [];
-            for (var _i = 0; _i < arguments.length; _i++) {
-                _a[_i] = arguments[_i];
-            }
-            var _b = __read(_a, 2), payload = _b[0], reason = _b[1];
-            _this.cancelAll(reason);
-            return _this.send.apply(_this, __spreadArray([], __read([payload]), false));
-        });
-        /**
-         * This method will alow the current message to be completed and send a new one to the worker queue after it, all the messages after the current one will be canceled
-         * @param {IPayload} payload - whatever json data you want to send to the worker should be serializable
-         * @param {unknown} reason - reason why the worker was terminated
-         * @returns {IMessagePromise<IResult>} generated defer that will be resolved when the message completed
-         */
-        this.overrideAfterCurrent = (function () {
-            var _a = [];
-            for (var _i = 0; _i < arguments.length; _i++) {
-                _a[_i] = arguments[_i];
-            }
-            var _b = __read(_a, 2), payload = _b[0], reason = _b[1];
-            if (_this.messagesQueue.size) {
-                var _c = __read(_this.messagesQueue, 1), firstItem = _c[0];
-                var _d = __read(firstItem, 2), currentMessage = _d[1];
-                _this.messagesQueue.delete(currentMessage.messageId);
-                _this.cancelAll(reason);
-                _this.messagesQueue.set(currentMessage.messageId, currentMessage);
-            }
-            return _this.send.apply(_this, __spreadArray([], __read([payload]), false));
-        });
-        this.name = name || (0, EasyWebWorkerFixtures_1.generatedId)();
-        this.scripts = scripts;
-        this.worker = this.createWorker();
-        this.onWorkerError = onWorkerError;
-    }
-    Object.defineProperty(EasyWebWorker.prototype, "isExternalWorkerFile", {
-        get: function () {
-            return typeof this.workerBody === 'string';
-        },
-        enumerable: false,
-        configurable: true
-    });
-    EasyWebWorker.prototype.RemoveMessageFromQueue = function (messageId) {
-        this.messagesQueue.delete(messageId);
-    };
-    /**
-     * Categorizes the worker response and executes the corresponding callback
-     */
-    EasyWebWorker.prototype.executeMessageCallback = function (event) {
-        var _a;
-        var message = (_a = this.messagesQueue.get(event.data.messageId)) !== null && _a !== void 0 ? _a : null;
-        if (!message)
-            return;
-        var _b = event.data, payload = _b.payload, reason = _b.reason, wasCanceled = _b.wasCanceled, progressPercentage = _b.progressPercentage;
-        // worker was disposed before the message was resolved
-        if (!this.worker) {
-            this.RemoveMessageFromQueue(message.messageId);
-            return;
-        }
-        // execute progress callback
-        if (progressPercentage !== undefined) {
-            message.reportProgress(progressPercentage);
-            return;
-        }
-        // remove message from queue
-        this.RemoveMessageFromQueue(message.messageId);
-        message.wasCompleted = false;
-        if (wasCanceled) {
-            message.cancel(reason);
-            return;
-        }
-        if (reason) {
-            message.reject(reason);
-            return;
-        }
-        message.wasCompleted = true;
-        // resolve message with the serialized payload
-        message.resolve.apply(message, __spreadArray([], __read((payload !== null && payload !== void 0 ? payload : [])), false));
-    };
-    EasyWebWorker.prototype.getWorkerUrl = function () {
-        if (this.isExternalWorkerFile) {
-            return this.workerBody;
-        }
-        return (0, exports.createBlobWorker)(this.workerBody, this.scripts);
-    };
-    EasyWebWorker.prototype.createWorker = function () {
-        var _this = this;
-        this.workerUrl = this.getWorkerUrl();
-        var worker = new Worker(this.workerUrl, {
-            name: this.name,
-        });
-        worker.onmessage = function (event) {
-            _this.executeMessageCallback(event);
-        };
-        /**
-         * If not handled, the error will be thrown to the global scope
-         */
-        worker.onerror = function (reason) {
-            if (!_this.onWorkerError)
-                throw reason;
-            _this.onWorkerError(reason);
-        };
-        return worker;
-    };
-    /**
-     * Terminates the worker and remove all messages from the queue
-     * Execute the cancel callback of each message in the queue if provided
-     * @param {unknown} reason - reason why the worker was terminated
-     */
-    EasyWebWorker.prototype.cancelAll = function (reason) {
-        var _a;
-        (_a = this.worker) === null || _a === void 0 ? void 0 : _a.terminate();
-        var messages = Array.from(this.messagesQueue.values());
-        messages.forEach(function (message) { return message.cancel(reason); });
-        this.messagesQueue = new Map();
-    };
-    /**
-     * This method will remove the WebWorker and the BlobUrl
-     */
-    EasyWebWorker.prototype.dispose = function () {
-        this.cancelAll();
-        URL.revokeObjectURL(this.workerUrl);
-        this.worker = null;
-    };
-    return EasyWebWorker;
-}());
-exports.EasyWebWorker = EasyWebWorker;
-exports.default = EasyWebWorker;

package/lib/EasyWebWorkerFixtures.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkerTemplate = exports.generatedId = void 0;
-var generatedId = function () {
-    return "".concat(new Date().getTime()).concat(Math.random().toString(36).substr(2, 9));
-};
-exports.generatedId = generatedId;
-/**
- * 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;

package/lib/EasyWebWorkerMessage.js

@@ -1,44 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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 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 = (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 EasyWebWorkerMessage;
-}());
-exports.EasyWebWorkerMessage = EasyWebWorkerMessage;

package/lib/StaticEasyWebWorker.js

@@ -1,100 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StaticEasyWebWorker = exports.WorkerMessage = void 0;
-/**
- * This message wrap the interaction with the worker to ensure that the message is correctly synchronized with the EasyWebWorker
- */
-var WorkerMessage = /** @class */ (function () {
-    /**
-     * @param {TPayload} 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 = '*'; }
-        var _this = this;
-        this.payload = payload;
-        this.messageId = messageId;
-        this.messageTargetOrigin = messageTargetOrigin;
-        /**
-         * This method is used to resolve the message from inside the worker
-         */
-        this.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) {
-        self.postMessage({ reason: reason }, this.messageTargetOrigin);
-    };
-    /**
-     * This method is used to cancel the message from inside the worker
-     */
-    WorkerMessage.prototype.cancel = function (reason) {
-        self.postMessage({ wasCanceled: true, reason: reason }, this.messageTargetOrigin);
-    };
-    /**
-     * 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;
-/**
- * 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);
-    }
-    /**
-     * 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
-            var message = new WorkerMessage(payload, messageId, messageTargetOrigin);
-            _this.onMessageCallback.call(_this, message, event);
-        };
-    };
-    /**
-     * 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;

package/lib/bundle.js.LICENSE.txt

@@ -1 +0,0 @@
-/*! For license information please see bundle.js.LICENSE.txt */

package/lib/index.js

@@ -1,18 +0,0 @@
-"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("./StaticEasyWebWorker"), exports);