vevet 1.4.27 → 2.0.1-dev.3

package/dist/js/Event.js

@@ -1,538 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _getVevetProperties = _interopRequireDefault(require("./getVevetProperties"));
-
-var _merge = _interopRequireDefault(require("./merge"));
-
-var _generateId = _interopRequireDefault(require("./generateId"));
-
-var _timeoutCallback = _interopRequireDefault(require("./timeoutCallback"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
-
-/**
- * @classdesc A class for callbacks' manipulation.
- * <br><br> <b>import {Event} from 'vevet';</b>
- * @class
- * @abstract
- * @memberof Vevet
- */
-var Event = /*#__PURE__*/function () {
-  /**
-   * @typedef {object} Vevet.Event.Properties
-   * 
-   * @property {Vevet.Application} [v] - Vevet Application.
-   * @property {Array<Vevet.Event.EventObj>} [callbacks] - Vevet Events. Almost equal to {@linkcode Vevet.Event#add}.
-   */
-
-  /**
-   * @alias Vevet.Event
-   * 
-   * @param {Vevet.Event.Properties} [data]
-   * @param {boolean} [init=true] - Defines if you need to call {@linkcode Vevet.Event#init} at the constructor's end.
-   * 
-   * @example 
-   * let data = {
-   *     v: window.vevetApplication
-   * };
-   * let event = new Vevet.Event(data);
-   * 
-   */
-  function Event(data) {
-    var _this = this;
-
-    var init = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
-
-    _classCallCheck(this, Event);
-
-    // get vevet application if not exists
-    data = (0, _getVevetProperties.default)(data);
-    /**
-     * @description Vevet Application.
-     * @type {Vevet.Application}
-     * @protected
-     */
-
-    this._v = data.v;
-    /**
-     * @description Vevet Application Properties.
-     * @type {Vevet.Application.Properties}
-     * @protected
-     */
-
-    this._vp = this._v.prop;
-    /**
-     * @description Class Prefix.
-     * @type {string}
-     * @protected
-     */
-
-    this._prefix = this.prefix;
-    /**
-     * @description Current Properties.
-     * @type {Vevet.Event.Properties}
-     * @protected
-     */
-
-    this._prop = (0, _merge.default)(this.defaultProp, data);
-    /**
-     * @type {string}
-     * @protected
-     */
-
-    this._name = this.constructor.name;
-    /**
-     * @description Vevet Callbacks.
-     * @type {Array<Vevet.Event.EventData>}
-     * @protected
-     */
-
-    this._events = [];
-    /**
-     * @description A short alias for {@linkcode Vevet.Event#launchByTarget}
-     * @type {Function}
-     */
-
-    this.lbt = this.launchByTarget; // add callbacks
-
-    this._prop.callbacks.forEach(function (callback) {
-      _this.add(callback);
-    }); // initialize
-
-
-    if (init) {
-      this._init();
-    }
-  }
-  /**
-   * @description Default properties. See {@linkcode typedef Properties} to get more info.
-   * @readonly
-   * @type {Vevet.Event.Properties}
-   */
-
-
-  _createClass(Event, [{
-    key: "defaultProp",
-    get: function get() {
-      return {
-        v: window.vevetApplication,
-        callbacks: []
-      };
-    }
-    /**
-     * @description Current Properties. See {@linkcode typedef Properties} to get more info.
-     * @type {Vevet.Event.Properties}
-     */
-
-  }, {
-    key: "prop",
-    get: function get() {
-      return this._prop;
-    }
-    /**
-     * @description Get the name of the class.
-     * @readonly
-     * @type {string}
-     */
-
-  }, {
-    key: "name",
-    get: function get() {
-      return this._name;
-    }
-    /**
-     * @memberof Vevet.Event
-     * @typedef {object} EventData
-     * @property {string} id Id of the callback.
-     * @property {boolean} on Defines if the callback is enabled.
-     * @property {Vevet.Event.EventObjWithTarget} data Callback data.
-     */
-
-    /**
-     * @memberof Vevet.Event
-     * @typedef {object} EventObjWithTarget
-     * @augments Vevet.Event.EventObj
-     * @property {string} [target] The target name of the callback.
-     */
-
-    /**
-     * @memberof Vevet.Event
-     * @typedef {object} EventObj
-     * @augments Vevet.Event.EventObjSettings
-     * @property {Function} do Callback itself.
-     */
-
-    /**
-     * @memberof Vevet.Event
-     * @typedef {object} EventObjSettings
-     * @property {string} [name] A Name of the callback if needed. It is useful when you need to trace callbacks from different modules.
-     * @property {number} [timeout] A timeout of the callback.
-     * @property {boolean} [protected] Defines if the callback can be deleted or not. 
-     * @property {boolean} [once] Defines if the callback will be deleted right after it is launched.
-     */
-
-    /**
-     * @description All callbacks.
-     * @readonly
-     * @type {Array<Vevet.Event.EventData>}
-     */
-
-  }, {
-    key: "events",
-    get: function get() {
-      return this._events;
-    }
-    /**
-     * @description An empty method that is called in {@linkcode Vevet.Event#_init}.
-     * This can be used in other classes to extend the default constructor.
-     * @protected
-     */
-
-  }, {
-    key: "_extra",
-    value: function _extra() {}
-    /**
-     * @description Initializes the class.
-     * @protected
-     */
-
-  }, {
-    key: "_init",
-    value: function _init() {
-      this._extra();
-
-      this._setEvents();
-    }
-    /**
-     * @description An empty method that is called in {@linkcode Vevet.Event#_init}.
-     * This can be used in other classes to extend the default constructor.
-     * @protected
-     */
-
-  }, {
-    key: "_setEvents",
-    value: function _setEvents() {}
-    /**
-     * @description Adds a callback.
-     * 
-     * @param {Vevet.Event.EventObj} data - Callback data.
-     * @param {boolean} [bool=true] - Defines if the event is enabled.
-     * 
-     * @returns {string} Returns a string with the callback's id.
-     * 
-     * @example
-     * let id = event.add({
-     *     // if targets are available
-     *     target: 'target name',
-     *     do: () => {
-     *         alert("callback launched");
-     *     }
-     * }, true);
-     */
-
-  }, {
-    key: "add",
-    value: function add(data) {
-      var bool = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
-      var id = (0, _generateId.default)(this.name),
-          array = {
-        id: id,
-        on: bool,
-        data: data
-      };
-
-      this._events.push(array);
-
-      this._addCallback(id);
-
-      return id;
-    }
-    /**
-     * @description Use it to carry out some actions after adding callbacks.
-     * 
-     * @protected
-     * @param {string} id - Callback id.
-     */
-    // eslint-disable-next-line no-unused-vars
-
-  }, {
-    key: "_addCallback",
-    value: function _addCallback(id) {}
-    /**
-     * @description Add a callback. This is a short form of {@linkcode Vevet.Event#add}
-     * 
-     * @param {string} target - Event target name.
-     * @param {Function} callback - Callback itself.
-     * @param {Vevet.Event.EventObjSettings} [prop] - Other settings.
-     * 
-     * @returns {string} Returns a string with the callback's id.
-     * 
-     * @example
-     * let id = event.on('target name', () => {
-     *     alert("callback launched");
-     * });
-     */
-
-  }, {
-    key: "on",
-    value: function on(target, callback) {
-      var prop = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-      var obj = (0, _merge.default)(prop, {
-        target: target,
-        do: callback
-      });
-      return this.add(obj);
-    }
-    /**
-     * @description Remove a callback.
-     * 
-     * @param {string} id - Id of the callback to be deleted.
-     * @returns {boolean} Returns true if callback is deleted.
-     * 
-     * @example
-     * event.remove('id');
-     * 
-     */
-
-  }, {
-    key: "remove",
-    value: function remove(id) {
-      var events = this._events,
-          newEvents = [],
-          removed = false;
-
-      for (var i = 0; i < events.length; i++) {
-        // copy vars
-        var event = events[i]; // check id
-
-        if (event.id !== id) {
-          // add callback to the new array
-          newEvents.push(event);
-          continue;
-        } // check if the callback is protected
-
-
-        var protectedCallback = false,
-            protectedData = event.data.protected;
-
-        if (typeof protectedData == 'boolean') {
-          if (protectedData) {
-            protectedCallback = true;
-          }
-        } // remove callback if not protected
-
-
-        if (!protectedCallback) {
-          this._removeCallback(id);
-
-          removed = true;
-        } else {
-          // add callback to the new array
-          newEvents.push(event);
-        }
-      } // replace array
-
-
-      this._events = newEvents; // return results
-
-      return removed;
-    }
-    /**
-     * @description Use this method for some actions when callbacks are removed.
-     * 
-     * @protected
-     * @param {string} id - Callback id.
-     */
-    // eslint-disable-next-line no-unused-vars
-
-  }, {
-    key: "_removeCallback",
-    value: function _removeCallback(id) {}
-    /**
-     * @description Remove all callbacks.
-     */
-
-  }, {
-    key: "removeAll",
-    value: function removeAll() {
-      while (this._events.length > 0) {
-        this.remove(this._events[0].id);
-      }
-    }
-    /**
-     * @description Enable/disable a callback.
-     * 
-     * @param {string} id - Id of a callback to enable or disable.
-     * @param {boolean} [bool=true] - Set true to enable & false to disable.
-     * 
-     * @returns {boolean} Returns true if the event is enabled.
-     * 
-     * @example
-     * event.turn('id', false);
-     * event.turn('id', true);
-     * 
-     */
-
-  }, {
-    key: "turn",
-    value: function turn(id) {
-      var bool = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
-      var event = this.get(id);
-
-      if (event) {
-        event.on = bool;
-
-        this._turnCallback(id);
-
-        return true;
-      }
-
-      return false;
-    }
-    /**
-     * @description Use this method for some actions when callbacks are enabled or disabled.
-     * 
-     * @protected
-     * @param {string} id - Callback id.
-     */
-    // eslint-disable-next-line no-unused-vars
-
-  }, {
-    key: "_turnCallback",
-    value: function _turnCallback(id) {}
-    /**
-     * @description Get a callback by id.
-     * @param {string} id - Id of the callback.
-     * 
-     * @returns {(false|Vevet.Event.EventData)} Returns false if callback does not exist or its object if it does.
-     */
-
-  }, {
-    key: "get",
-    value: function get(id) {
-      var events = this._events;
-
-      for (var i = 0; i < events.length; i++) {
-        if (events[i].id === id) {
-          return events[i];
-        }
-      }
-
-      return false;
-    }
-    /**
-     * @description Launch a callback. It will work if the callback is enabled.
-     * 
-     * @protected
-     * 
-     * @param {Vevet.Event.EventData} obj - Callback's object.
-     * @param {object|false} [arg] - Callback's arguments.
-     */
-
-  }, {
-    key: "_launch",
-    value: function _launch(obj) {
-      var arg = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-
-      // check if enabled
-      if (!obj.on) {
-        return;
-      } // copy vars
-
-
-      var data = obj.data,
-          callback = data.do,
-          timeout = 0; // check if timeout exists
-
-      if (data.timeout) {
-        timeout = data.timeout;
-      } // launch
-
-
-      if (timeout === 0) {
-        this._launchCallback(callback, arg);
-      } else {
-        (0, _timeoutCallback.default)(this._launchCallback.bind(this, callback, arg), timeout);
-      } // remove once-callback
-
-
-      if (typeof data.once == 'boolean') {
-        if (data.once) {
-          this.remove(obj.id);
-        }
-      }
-    }
-    /**
-     * @description Launch a callback.
-     * 
-     * @protected
-     * 
-     * @param {Function} callback
-     * @param {object} arg
-     */
-
-  }, {
-    key: "_launchCallback",
-    value: function _launchCallback(callback, arg) {
-      if (arg) {
-        callback(arg);
-      } else {
-        callback();
-      }
-    }
-    /**
-     * @description Launch all callbacks.
-     */
-
-  }, {
-    key: "launchAll",
-    value: function launchAll() {
-      var _this2 = this;
-
-      this._events.forEach(function (event) {
-        _this2._launch(event);
-      });
-    }
-    /**
-     * @description Launch all enabled events with a certain target.
-     * 
-     * @param {string} target - The name of the target.
-     * @param {object} [arg] - Callback's arguments.
-     * 
-     * @example
-     * event.launchByTarget('target name', {
-     *     firstname: 'John',
-     *     secondname: 'Doe'
-     * });
-     */
-
-  }, {
-    key: "launchByTarget",
-    value: function launchByTarget(target) {
-      var _this3 = this;
-
-      var arg = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-
-      this._events.forEach(function (event) {
-        if (event.data.target === target) {
-          _this3._launch(event, arg);
-        }
-      });
-    }
-  }]);
-
-  return Event;
-}();
-
-exports.default = Event;