@itee/client 10.0.0

package/sources/webapis/WebAPIOrigin.js

@@ -0,0 +1,141 @@
+/**
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ * @license [BSD-3-Clause]{@link https://opensource.org/licenses/BSD-3-Clause}
+ */
+
+import {
+    isDefined,
+    isEmptyArray,
+    isEmptyString,
+    isNotArray,
+    isNotBoolean,
+    isNotDefined,
+    isNotString
+}                       from '@itee/validators'
+import { v4 as uuidv4 } from 'uuid'
+
+class WebAPIOrigin {
+
+    constructor( parameters = {} ) {
+
+        const _parameters = {
+            ...{
+                uri:            '',
+                allowedMethods: [ '*' ],
+                window:         null,
+                messageQueue:   [],
+                isReachable:    true,
+                isReady:        false
+            },
+            ...parameters,
+            ...{
+                id: isDefined( parameters.id ) ? parameters.id : uuidv4()
+            }
+        }
+
+        this._id            = _parameters.id
+        this.uri            = _parameters.uri
+        this.allowedMethods = _parameters.allowedMethods // Todo: use Set instead
+        this.window         = _parameters.window
+        this.isReachable    = _parameters.isReachable
+        this.isReady        = _parameters.isReady
+        this.messageQueue   = _parameters.messageQueue
+
+    }
+
+    /**
+     *
+     */
+    get id() {
+        return this._id
+    }
+
+    get uri() {
+        return this._uri
+    }
+    set uri( value ) {
+        if ( isNotDefined( value ) ) { throw new ReferenceError( 'WebAPIOrigin uri cannot be null or undefined !' )}
+        if ( isNotString( value ) ) { throw new TypeError( `WebAPIOrigin uri expect to be a string. Got '${ typeof value }' !` )}
+        if ( isEmptyString( value ) ) { throw new RangeError( 'WebAPIOrigin uri cannot be an empty string !' )}
+
+        this._uri = value
+    }
+    get allowedMethods() {
+        return this._allowedMethods
+    }
+    set allowedMethods( value ) {
+        if ( isNotDefined( value ) ) { throw new ReferenceError( 'WebAPIOrigin methods cannot be null or undefined ! Expect an array of method name.' )}
+        if ( isNotArray( value ) ) { throw new TypeError( `WebAPIOrigin methods expect to be an array of method name (string).Got '${ typeof value }' !` )}
+        if ( isEmptyArray( value ) ) { throw new RangeError( 'WebAPIOrigin methods cannot be an empty array ! Expect an array of method name.' )}
+
+        this._allowedMethods = value
+    }
+    get window() {
+        return this._window
+    }
+    set window( value ) {
+        //        if ( isNotDefined( value ) ) { throw new ReferenceError( 'WebAPIOrigin window cannot be null or undefined ! Expect a Window object.' )}
+        //        if ( isDefined( value ) && !( value instanceof Window ) ) { throw new TypeError( `WebAPIOrigin window expect to be a Window. Got '${ typeof value }' !` )}
+
+        this._window = value
+    }
+    get isReady() {
+        return this._isReady
+    }
+    set isReady( value ) {
+        if ( isNotDefined( value ) ) { throw new ReferenceError( 'WebAPIOrigin isReady cannot be null or undefined !' )}
+        if ( isNotBoolean( value ) ) { throw new TypeError( `WebAPIOrigin isReady expect a Boolean. Got '${ typeof value }' !` )}
+
+        this._isReady = value
+    }
+    get isReachable() {
+        return this._isReachable
+    }
+    set isReachable( value ) {
+        if ( isNotDefined( value ) ) { throw new ReferenceError( 'WebAPIOrigin isReachable cannot be null or undefined !' )}
+        if ( isNotBoolean( value ) ) { throw new TypeError( `WebAPIOrigin isReachable expect a Boolean. Got '${ typeof value }' !` )}
+
+        this._isReachable = value
+    }
+    get messageQueue() {
+        return this._messageQueue
+    }
+    set messageQueue( value ) {
+        this._messageQueue = value
+    }
+    setUri( value ) {
+        this.uri = value
+        return this
+    }
+    setAllowedMethods( arrayOfMethodNames ) {
+        this.allowedMethods = arrayOfMethodNames
+        return this
+    }
+    addAllowedMethod( methodName ) {
+        if ( !this.allowedMethods.includes( methodName ) ) {
+            this.allowedMethods.push( methodName )
+        }
+        return this
+    }
+    removeAllowedMethod( methodName ) {
+        const index = this.allowedMethods.indexOf( methodName )
+        if ( index >= 0 ) {
+            this.allowedMethods.slice( index, methodName )
+        }
+        return this
+    }
+    setWindow( value ) {
+        this.window = value
+        return this
+    }
+    setReadyState( value ) {
+        this.isReady = value
+        return this
+    }
+    setReachableState( value ) {
+        this.isReachable = value
+        return this
+    }
+}
+
+export { WebAPIOrigin }

package/sources/webapis/_webapis.js

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

package/sources/webapis/messages/WebAPIMessage.js

@@ -0,0 +1,75 @@
+/**
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ */
+
+import {
+    isEmptyString,
+    isNotString
+}                       from '@itee/validators'
+import { v4 as uuidv4 } from 'uuid'
+
+/**
+ * @typedef {Object} WebAPIMessageSerialized
+ * @property {string} id
+ * @property {string} type
+ */
+
+/**
+ * @class
+ * @classdesc The base class for all web api message
+ */
+class WebAPIMessage {
+
+    /**
+     * @static
+     * @type {boolean}
+     */
+    static isWebAPIMessage = true
+
+    /**
+     *
+     * @param {string} type
+     */
+    constructor( type ) {
+        this._id  = uuidv4()
+        this.type = type
+    }
+
+    /**
+     *
+     */
+    get id() {
+        return this._id
+    }
+
+    /**
+     *
+     * @returns {string}
+     */
+    get type() {
+        return this._type
+    }
+
+    set type( value ) {
+        if ( isNotString( value ) ) { throw new ReferenceError( 'WebAPIMessage type cannot be null or undefined !' )}
+        if ( isEmptyString( value ) ) { throw new TypeError( 'WebAPIMessage type cannot be an empty string !' )}
+
+        this._type = value
+    }
+
+    /**
+     *
+     * @returns {{id: String, type: String}}
+     */
+    toJSON() {
+
+        return {
+            id:   this.id,
+            type: this.type
+        }
+
+    }
+
+}
+
+export { WebAPIMessage }

package/sources/webapis/messages/WebAPIMessageData.js

@@ -0,0 +1,51 @@
+import { WebAPIMessage } from './WebAPIMessage.js'
+
+/**
+ * @typedef {Object} WebAPIMessageDataSerialized
+ * @property {object} data
+ * @instance
+ */
+
+/**
+ * @class
+ * @classdesc The web api message for serializable data transfert
+ * @extends WebAPIMessage
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ */
+class WebAPIMessageData extends WebAPIMessage {
+
+    /**
+     * @static
+     * @type {boolean}
+     */
+    static isWebAPIMessageData = true
+
+    /**
+     *
+     * @param data
+     */
+    constructor( data ) {
+        super( '_data' )
+
+        this.data = data
+    }
+
+    /**
+     *
+     * @returns {{id: String, type: String, data: String}}
+     */
+    toJSON() {
+
+        const isPlainObject = this.data === Object( this.data )
+        return {
+            ...super.toJSON(),
+            ...{
+                data: isPlainObject ? JSON.stringify( this.data ) : this.data
+            }
+        }
+
+    }
+
+}
+
+export { WebAPIMessageData }

package/sources/webapis/messages/WebAPIMessageError.js

@@ -0,0 +1,79 @@
+/**
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ */
+
+import {
+    isDefined,
+    isNotDefined,
+    isObject,
+    isString
+}                        from '@itee/validators'
+import { WebAPIMessage } from './WebAPIMessage.js'
+
+class WebAPIMessageError extends WebAPIMessage {
+
+    static isWebAPIMessageError = true
+    /**
+     *
+     * @param error
+     */
+    constructor( error ) {
+        super( '_error' )
+
+        /**
+         * The internal error to send
+         * @type {{stack: string, name: string, message: string}}
+         */
+        this.error = error
+    }
+    get error() {
+        return this._error
+    }
+    set error( value ) {
+        if ( isNotDefined( value ) ) { throw new ReferenceError( `Expect a string, or Error like. But got value of '${ typeof value }' type: ${ JSON.stringify( value, null, 4 ) }` ) }
+
+        if ( isString( value ) ) {
+
+            this._error = {
+                name:    'UnknownError',
+                message: value
+            }
+
+        } else if ( WebAPIMessageError.isError( value ) ) {
+
+            this._error = {
+                name:    value.name,
+                message: value.message,
+                stack:   value.stack
+            }
+
+        } else {
+
+            throw new TypeError( `Expect a string, or Error like. But got value of '${ typeof value }' type: ${ JSON.stringify( value, null, 4 ) }` )
+
+        }
+
+    }
+    // Utils
+    static isError( value ) {
+        return value instanceof Error || isObject( value ) && ( isDefined( value.name ) || isDefined( value.message ) || isDefined( value.stack ) )
+    }
+    // Serialization
+    /**
+     *
+     * @returns {{id: String, type: String, name: String, stack: String, message: String}}
+     */
+    toJSON() {
+
+        return {
+            ...super.toJSON(),
+            ...{
+                error: this.error
+            }
+        }
+
+    }
+
+}
+
+export { WebAPIMessageError }

package/sources/webapis/messages/WebAPIMessageEvent.js

@@ -0,0 +1,58 @@
+/**
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ * @license [BSD-3-Clause]{@link https://opensource.org/licenses/BSD-3-Clause}
+ */
+
+import { WebAPIMessage } from './WebAPIMessage.js'
+
+/**
+ * @typedef {Object} WebAPIMessageDataSerialized
+ * @property {object} data
+ * @instance
+ */
+
+/**
+ * @class
+ * @classdesc The web api message for serializable data transfert
+ * @extends WebAPIMessage
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ */
+class WebAPIMessageEvent extends WebAPIMessage {
+
+    /**
+     * @static
+     * @type {boolean}
+     */
+    static isWebAPIMessageEvent = true
+
+    /**
+     *
+     * @param data
+     */
+    constructor( name, data ) {
+        super( '_event' )
+
+        this.name = name
+        this.data = data
+    }
+
+    /**
+     *
+     * @returns {{id: String, type: String, data: String}}
+     */
+    toJSON() {
+
+        const isPlainObject = this.data === Object( this.data )
+        return {
+            ...super.toJSON(),
+            ...{
+                name: this.name,
+                data: isPlainObject ? JSON.stringify( this.data ) : this.data
+            }
+        }
+
+    }
+
+}
+
+export { WebAPIMessageEvent }

package/sources/webapis/messages/WebAPIMessageProgress.js

@@ -0,0 +1,91 @@
+/**
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ */
+
+import { WebAPIMessage } from './WebAPIMessage.js'
+
+/**
+ * @class
+ */
+class WebAPIMessageProgress extends WebAPIMessage {
+
+    static isWebAPIMessageProgress = true
+
+    /**
+     *
+     * @param loaded
+     * @param total
+     */
+    constructor( loaded = 0, total = 0 ) {
+        super( '_progress' )
+
+        this.lengthComputable = false
+        this.loaded           = loaded
+        this.total            = total
+    }
+
+    /**
+     *
+     * @returns {*}
+     */
+    get loaded() {
+        return this._loaded
+    }
+
+    set loaded( value ) {
+        this._loaded = value
+        this._checkIfLengthComputable()
+    }
+
+    /**
+     *
+     * @returns {*}
+     */
+    get total() {
+        return this._total
+    }
+
+    set total( value ) {
+        this._total = value
+        this._checkIfLengthComputable()
+    }
+
+    /**
+     *
+     * @private
+     */
+    _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
+        }
+
+    }
+
+    /**
+     *
+     * @returns {{loaded: *, lengthComputable: boolean, total: *}}
+     */
+    toJSON() {
+
+        return {
+            ...super.toJSON(),
+            ...{
+                lengthComputable: this.lengthComputable,
+                loaded:           this.loaded,
+                total:            this.total
+            }
+        }
+
+    }
+
+}
+
+export { WebAPIMessageProgress }

package/sources/webapis/messages/WebAPIMessageReady.js

@@ -0,0 +1,66 @@
+/**
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ */
+
+import {
+    isNotBoolean,
+    isNotDefined
+}                        from '@itee/validators'
+import { WebAPIMessage } from './WebAPIMessage.js'
+
+/**
+ * @class
+ * @classdesc Internal ready message to broadcast for prevent bad or dead messager
+ */
+class WebAPIMessageReady extends WebAPIMessage {
+
+    /**
+     * @static
+     * @type {boolean}
+     */
+    static isWebAPIMessageReady = true
+
+    /**
+     *
+     */
+    constructor( parameters = {} ) {
+        super( '_ready' )
+
+        const _parameters = {
+            ...{
+                isBind: false
+            },
+            ...parameters
+        }
+
+        this.isBind = _parameters.isBind
+    }
+
+    get isBind() {
+        return this._isBind
+    }
+
+    set isBind( value ) {
+        if ( isNotDefined( value ) ) { throw new ReferenceError( 'WebAPIMessageReady isBind cannot be null or undefined ! Expect a boolean value.' )}
+        if ( isNotBoolean( value ) ) { throw new TypeError( 'WebAPIMessageReady isBind expect a boolean value.' )}
+
+        this._isBind = value
+    }
+
+    /**
+     *
+     * @returns {{id: String, type: String, isBind: Boolean}}
+     */
+    toJSON() {
+
+        return {
+            ...super.toJSON(),
+            ...{
+                isBind: this.isBind
+            }
+        }
+
+    }
+}
+
+export { WebAPIMessageReady }

package/sources/webapis/messages/WebAPIMessageRequest.js

@@ -0,0 +1,94 @@
+/**
+ * @author [Tristan Valcke]{@link https://github.com/Itee}
+ */
+
+import {
+    isBlankString,
+    isEmptyString,
+    isNotArray,
+    isNotDefined,
+    isNotString
+}                        from '@itee/validators'
+import { WebAPIMessage } from './WebAPIMessage.js'
+
+/**
+ * @class
+ * @classdesc Special message to request a distant method and expect result.
+ */
+class WebAPIMessageRequest extends WebAPIMessage {
+
+    /**
+     * @static
+     * @type {boolean}
+     */
+    static isWebAPIMessageRequest = true
+
+    /**
+     *
+     * @param method
+     * @param parameters
+     */
+    constructor( method, parameters = [] ) {
+        super( '_request' )
+
+        this.method     = method
+        this.parameters = parameters
+    }
+
+    /**
+     *
+     * @returns {String}
+     */
+    get method() {
+        return this._method
+    }
+
+    /**
+     *
+     * @param value {String}
+     */
+    set method( value ) {
+        if ( isNotDefined( value ) ) { throw new ReferenceError( 'Expect a string that represent a api method name, but got undefined or null value.' ) }
+        if ( isNotString( value ) ) { throw new TypeError( `Expect a string that represent a api method name, but got value of '${ typeof value }' type: ${ JSON.stringify( value, null, 4 ) }` ) }
+        if ( isEmptyString( value ) || isBlankString( value ) ) { throw new TypeError( 'Expect a string that represent a api method name, but got empty or blank string.' ) }
+
+        this._method = value
+    }
+
+    /**
+     *
+     * @returns {Array<*>}
+     */
+    get parameters() {
+        return this._parameters
+    }
+
+    /**
+     *
+     * @param value {Array<*>}
+     */
+    set parameters( value ) {
+        if ( isNotArray( value ) ) { throw new TypeError( `Expect an array of parameters, but got value of '${ typeof value }' type: ${ JSON.stringify( value, null, 4 ) }` ) }
+
+        this._parameters = value
+    }
+
+    /**
+     *
+     * @returns {{method: String, parameters: Array<*>}}
+     */
+    toJSON() {
+
+        return {
+            ...super.toJSON(),
+            ...{
+                method:     this.method,
+                parameters: this.parameters
+            }
+        }
+
+    }
+
+}
+
+export { WebAPIMessageRequest }