@itee/client 10.0.0

package/sources/webapis/messages/WebAPIMessageResponse.js

@@ -0,0 +1,80 @@
+/**
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ */
+
+import {
+    isNull,
+    isUndefined
+}                        from '@itee/validators'
+import { WebAPIMessage } from './WebAPIMessage.js'
+
+/**
+ * @class
+ * @classdesc The message response to a message request
+ */
+class WebAPIMessageResponse extends WebAPIMessage {
+
+    /**
+     *
+     * @type {boolean}
+     */
+    static isWebApiMessageResponse = true
+
+    /**
+     *
+     * @param request
+     * @param result
+     */
+    constructor( request, result ) {
+        super( '_response' )
+
+        this.request = request
+        this.result  = result
+    }
+
+    /**
+     *
+     * @returns {*}
+     */
+    get request() {
+        return this._request
+    }
+
+    set request( value ) {
+        if ( isNull( value ) ) { return }
+        if ( isUndefined( value ) ) { return }
+
+        this._request = value
+    }
+
+    /**
+     *
+     * @returns {*}
+     */
+    get result() {
+        return this._result
+    }
+
+    set result( value ) {
+        this._result = value
+    }
+
+    /**
+     *
+     * @returns {{result: *, request: *}}
+     */
+    toJSON() {
+
+        return {
+            ...super.toJSON(),
+            ...{
+                request: this.request,
+                result:  this.result
+            }
+        }
+
+    }
+
+}
+
+export { WebAPIMessageResponse }

package/sources/webapis/messages/_messages.js

@@ -0,0 +1,16 @@
+/**
+ * @module WebAPI/Messages
+ * @description Intermediary export file for webapi messages. Export [WebAPIMessage]{@link WebAPIMessage}, [WebAPIMessageData]{@link WebAPIMessageData}, [WebAPIMessageError]{@link WebAPIMessageError},
+ *     [WebAPIMessageProgress]{@link WebAPIMessageProgress}, [WebAPIMessageReady]{@link WebAPIMessageReady}, [WebAPIMessageRequest]{@link WebAPIMessageRequest}, and [WebAPIMessageResponse]{@link WebAPIMessageResponse}.
+ *
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ * @license [BSD-3-Clause]{@link https://opensource.org/licenses/BSD-3-Clause}
+ */
+
+export * from './WebAPIMessage.js'
+export * from './WebAPIMessageData.js'
+export * from './WebAPIMessageError.js'
+export * from './WebAPIMessageProgress.js'
+export * from './WebAPIMessageReady.js'
+export * from './WebAPIMessageRequest.js'
+export * from './WebAPIMessageResponse.js'

package/sources/workers/AbstractWorker.js

@@ -0,0 +1,149 @@
+/**
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ */
+
+import {
+    isArray,
+    isArrayBuffer,
+    isEmptyString,
+    isNotArray,
+    isNotDefined,
+    isNotString
+}                                from '@itee/validators'
+import { WorkerMessageData }     from './messages/WorkerMessageData.js'
+import { WorkerMessageError }    from './messages/WorkerMessageError.js'
+import { WorkerMessageProgress } from './messages/WorkerMessageProgress.js'
+
+/**
+ * @class
+ * @classdesc Base worker interface that allow messaging between callee and caller
+ */
+class AbstractWorker {
+
+    /**
+     *
+     * @param progress
+     */
+    postProgress( progress ) {
+
+        if ( progress.isWorkerMessageProgress ) {
+            postMessage( progress.toJSON() )
+        } else {
+            postMessage( new WorkerMessageProgress( progress.loaded, progress.total ).toJSON() )
+        }
+
+    }
+
+    /**
+     *
+     * @param error
+     */
+    postError( error ) {
+
+        if ( error.isWorkerMessageError ) {
+            postMessage( error.toJSON() )
+        } else {
+            postMessage( new WorkerMessageError( error ).toJSON() )
+        }
+
+    }
+
+    /**
+     *
+     * @param type
+     * @param arrayBuffer
+     */
+    postData( type, arrayBuffer ) {
+
+        if ( isArray( arrayBuffer ) ) {
+            postMessage( new WorkerMessageData( type, arrayBuffer ).toJSON(), [ ...arrayBuffer ] )
+        } else if ( isArrayBuffer( arrayBuffer ) ) {
+            postMessage( new WorkerMessageData( type, arrayBuffer ).toJSON(), [ arrayBuffer ] )
+        } else {
+            throw new TypeError( `AbstractWorker.postData: Unable to post data of type [${ type }].` )
+        }
+
+    }
+
+    /**
+     *
+     * @param message
+     * @returns {boolean}
+     */
+    onMessage( message ) {
+
+        if ( isNotDefined( message ) ) {
+            this.postError( new Error( 'Message event cannot be null or undefined !' ) )
+            return true
+        }
+
+        const data = message.data
+        if ( isNotDefined( data ) ) {
+            this.postError( new Error( 'Message data cannot be null or undefined !' ) )
+            return true
+        }
+
+        const dataType = data.type
+        if ( isNotDefined( dataType ) ) {
+            this.postError( new Error( 'Message data type cannot be null or undefined !' ) )
+            return true
+        }
+
+        if ( data.type === 'methodCall' ) {
+
+            const methodName = data.method
+            if ( isNotDefined( methodName ) ) {
+                this.postError( new Error( 'Message of type "methodCall" cannot have null, undefined or empty name !' ) )
+                return true
+            }
+
+            if ( isNotString( methodName ) ) {
+                this.postError( new Error( 'Message of type "methodCall" expect name to be a string !' ) )
+                return true
+            }
+
+            if ( isEmptyString( methodName ) ) {
+                this.postError( new Error( 'Message of type "methodCall" expect name to be a non empty string !' ) )
+                return true
+            }
+
+            const methodParameters = data.parameters || []
+            if ( isNotArray( methodParameters ) ) {
+                this.postError( new Error( 'Message of type "methodCall" expect parameters to be an array !' ) )
+                return true
+            }
+
+            this._invoke( methodName, methodParameters )
+            return true
+
+        }
+
+    }
+
+    /**
+     *
+     * @param name
+     * @param parameters
+     * @private
+     */
+    _invoke( name, parameters = [] ) {
+
+        try {
+
+            const result = this[ name ]( ...parameters )
+            if ( result ) {
+                postMessage( {
+                    type:   name,
+                    result: result
+                } )
+            }
+
+        } catch ( error ) {
+            this.postError( error )
+        }
+
+    }
+
+}
+
+export { AbstractWorker }

package/sources/workers/_workers.js

@@ -0,0 +1,10 @@
+/**
+ * @module Workers
+ * @description Intermediary export file for workers. Export [AbstractWorker]{@link AbstractWorker} and all worker messages from [Worker/Messages]{@link module:Workers/Messages}.
+ *
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ * @license [BSD-3-Clause]{@link https://opensource.org/licenses/BSD-3-Clause}
+ */
+export * from './AbstractWorker.js'
+
+export * from './messages/_messages.js'

package/sources/workers/messages/WorkerMessage.js

@@ -0,0 +1,33 @@
+/**
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ */
+
+class WorkerMessage {
+
+    static isWorkerMessage = true
+
+    constructor( type ) {
+
+        this.type = type
+
+    }
+
+    get type() {
+        return this._type
+    }
+
+    set type( type ) {
+        this._type = type
+    }
+
+    toJSON() {
+
+        return {
+            type: this.type
+        }
+
+    }
+
+}
+
+export { WorkerMessage }

package/sources/workers/messages/WorkerMessageData.js

@@ -0,0 +1,30 @@
+/**
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ */
+
+import { WorkerMessage } from './WorkerMessage.js'
+
+class WorkerMessageData extends WorkerMessage {
+
+    static isWorkerMessageData = true
+
+    constructor( type, buffer ) {
+        super( type )
+
+        this.buffer = buffer
+    }
+
+    toJSON() {
+
+        return {
+            ...super.toJSON(),
+            ...{
+                buffer: this.buffer
+            }
+        }
+
+    }
+
+}
+
+export { WorkerMessageData }

package/sources/workers/messages/WorkerMessageError.js

@@ -0,0 +1,32 @@
+/**
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ */
+
+import { WorkerMessage } from './WorkerMessage.js'
+
+class WorkerMessageError extends WorkerMessage {
+
+    static isWorkerMessageError = true
+
+    constructor( error ) {
+        super( 'error' )
+
+        this.message = error.message
+        this.stack   = error.stack
+    }
+
+    toJSON() {
+
+        return {
+            ...super.toJSON(),
+            ...{
+                message: this.message,
+                stack:   this.stack
+            }
+        }
+
+    }
+
+}
+
+export { WorkerMessageError }

package/sources/workers/messages/WorkerMessageMethodCall.js

@@ -0,0 +1,60 @@
+/**
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ */
+
+import {
+    isNotArray,
+    isNotString,
+    isNull,
+    isUndefined
+}                        from '@itee/validators'
+import { WorkerMessage } from './WorkerMessage.js'
+
+class WorkerMessageMethodCall extends WorkerMessage {
+
+    static isWorkerMessageMethodCall = true
+
+    constructor( method, parameters = [] ) {
+        super( 'methodCall' )
+
+        this.method     = method
+        this.parameters = parameters
+    }
+
+    get method() {
+        return this._method
+    }
+
+    set method( value ) {
+        if ( isNull( value ) ) { return }
+        if ( isUndefined( value ) ) { return }
+        if ( isNotString( value ) ) { return }
+
+        this._method = value
+    }
+
+    get parameters() {
+        return this._parameters
+    }
+
+    set parameters( value ) {
+        if ( isNotArray( value ) ) { return }
+
+        this._parameters = value
+    }
+
+    toJSON() {
+
+        return {
+            ...super.toJSON(),
+            ...{
+                method:     this.method,
+                parameters: this.parameters
+            }
+        }
+
+    }
+
+}
+
+export { WorkerMessageMethodCall }

package/sources/workers/messages/WorkerMessageProgress.js

@@ -0,0 +1,67 @@
+/**
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ */
+
+import { WorkerMessage } from './WorkerMessage.js'
+
+class WorkerMessageProgress extends WorkerMessage {
+
+    static isWorkerMessageProgress = true
+
+    constructor( loaded = 0, total = 0 ) {
+        super( 'progress' )
+
+        this.lengthComputable = false
+        this.loaded           = loaded
+        this.total            = total
+    }
+
+    get loaded() {
+        return this._loaded
+    }
+
+    set loaded( value ) {
+        this._loaded = value
+        this._checkIfLengthComputable()
+    }
+
+    get total() {
+        return this._total
+    }
+
+    set total( value ) {
+        this._total = value
+        this._checkIfLengthComputable()
+    }
+
+    _checkIfLengthComputable() {
+
+        this.lengthComputable = false
+
+        if (
+            this._total > 0 &&
+            this._total < Number.MAX_SAFE_INTEGER &&
+            this._loaded >= 0 &&
+            this._loaded < Number.MAX_SAFE_INTEGER
+        ) {
+            this.lengthComputable = true
+        }
+
+    }
+
+    toJSON() {
+
+        return {
+            ...super.toJSON(),
+            ...{
+                lengthComputable: this.lengthComputable,
+                loaded:           this.loaded,
+                total:            this.total
+            }
+        }
+
+    }
+
+}
+
+export { WorkerMessageProgress }

package/sources/workers/messages/_messages.js

@@ -0,0 +1,14 @@
+/**
+ * @module Workers/Messages
+ * @description Intermediary export file for worker messages. Export [WorkerMessage]{@link WorkerMessage}, [WorkerMessageData]{@link WorkerMessageData}, [WorkerMessageError]{@link WorkerMessageError},
+ *     [WorkerMessageMethodCall]{@link WorkerMessageMethodCall}, and [WorkerMessageProgress]{@link WorkerMessageProgress}.
+ *
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ * @license [BSD-3-Clause]{@link https://opensource.org/licenses/BSD-3-Clause}
+ */
+
+export * from './WorkerMessage.js'
+export * from './WorkerMessageData.js'
+export * from './WorkerMessageError.js'
+export * from './WorkerMessageMethodCall.js'
+export * from './WorkerMessageProgress.js'