@bbn/bbn 1.0.59 → 1.0.60

package/dist/fn/ajax/setNavigationVars.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Changes the URL and the associated variables and updates the history.
+ *
+ * @method   setNavigationVars
+ * @todo     Add method description for setNavigationVars
+ * @global
+ * @memberof bbn.fn
+ *
+ * @example
+ * ```javascript
+ * // Changing URL
+ * bbn.fn.setNavigationVars('my/page', 'My page');
+ * // Replacing the previous state
+ * bbn.fn.setNavigationVars('my/page/deeper', 'My deeper page', null, true);
+ * ```
+ *
+ * @param    {String}  url   The URL which will become the location.href
+ * @param    {String}  title The title corresponding to the given URL
+ * @param    {Object}  data  The data if any
+ * @param    {Boolean} repl  If true the history state object will replace the current one, will be added otherwise
+ *
+ * @returns  {undefined}
+ */
+declare const setNavigationVars: (url: any, title: any, data?: object, repl?: boolean) => void;
+export { setNavigationVars };

package/dist/fn/ajax/setNavigationVars.js

@@ -0,0 +1,80 @@
+import { substr } from '../string/substr';
+import { filter } from '../object/filter';
+import { extend } from '../object/extend';
+import { html2text } from '../html/html2text';
+/**
+ * Changes the URL and the associated variables and updates the history.
+ *
+ * @method   setNavigationVars
+ * @todo     Add method description for setNavigationVars
+ * @global
+ * @memberof bbn.fn
+ *
+ * @example
+ * ```javascript
+ * // Changing URL
+ * bbn.fn.setNavigationVars('my/page', 'My page');
+ * // Replacing the previous state
+ * bbn.fn.setNavigationVars('my/page/deeper', 'My deeper page', null, true);
+ * ```
+ *
+ * @param    {String}  url   The URL which will become the location.href
+ * @param    {String}  title The title corresponding to the given URL
+ * @param    {Object}  data  The data if any
+ * @param    {Boolean} repl  If true the history state object will replace the current one, will be added otherwise
+ *
+ * @returns  {undefined}
+ */
+const setNavigationVars = function (url, title, data, repl) {
+    // Current path becomes old path
+    bbn.env.old_path = bbn.env.path;
+    // URL includes the domain
+    bbn.env.url = ['https:/', 'http://'].includes(substr(url, 0, 7)) ? url : bbn.env.root + url;
+    // Path does not
+    bbn.env.path = substr(bbn.env.url, bbn.env.root.length);
+    // Params will include each part of the URL
+    bbn.env.params = filter(bbn.env.path.split('/'), (v) => {
+        return v !== '';
+    });
+    // Managing history
+    let h = window.history;
+    if (h) {
+        // Current state
+        let state = h.state;
+        // Future state
+        let obj = {
+            url: bbn.env.path,
+            old_path: bbn.env.old_path || null,
+            data: data || {},
+            reload: false
+        };
+        // If same URL we replace
+        if (state && state.url === bbn.env.path) {
+            if (state.data) {
+                extend(obj.data, state.data);
+            }
+            if (state.title && !title) {
+                title = state.title;
+            }
+            repl = true;
+        }
+        // If no title the global title
+        if (!title) {
+            title = bbn.env.siteTitle;
+        }
+        // Otherwise we add the global title at the end
+        else {
+            title = html2text(title);
+        }
+        // Replacing state
+        if (repl) {
+            obj.reload = true;
+            h.replaceState(obj, title, bbn.env.url);
+        }
+        // Adding state
+        else {
+            h.pushState(obj, title, bbn.env.url);
+        }
+    }
+};
+export { setNavigationVars };

package/dist/fn/ajax/treatAjaxArguments.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Transforms unordered arguments into a configuratiuon object for Ajax shortcut functions.
+ *
+ * The final object will have the following arguments: url, obj, datatype, force, successFn,
+ * errorFn, abortFn, e, and ele; The rules are:
+ * * The first string found is the URL
+ * * The second string found is the datatype
+ * * The first function is successFn
+ * * The second function is errorFn
+ * * The third function is abortFn
+ * * A boolean true is force
+ * * An Event is e
+ * * An HTML element is ele
+ *
+ * If no object is given the _bbn property will be added in order to always post something
+ * and let the bbn server scripts know if a whole DOM is requested or a JSON answer
+ *
+ * @method   treatAjaxArguments
+ * @global
+ * @memberof bbn.fn
+ *
+ * @example
+ * ```javascript
+ * bbn.fn.treatAjaxArguments(['my/script', 'json', {a:1, b:2}, () => bbn.fn.log('Hi'), () => bbn.fn.log('Bye'), () => bbn.fn.log('Argh'), true])
+ * // {
+ * //   "url": "my/script",
+ * //   "datatype": "json",
+ * //   "obj": {
+ * //     "a": 1,
+ * //     "b": 2
+ * //   },
+ * //   "successFn": () => bbn.fn.log('Hi'),
+ * //   "errorFn": () => bbn.fn.log('Bye'),
+ * //   "abortFn": () => bbn.fn.log('Argh'),
+ * //   "force": true
+ * // }
+ *
+ * bbn.fn.treatAjaxArguments(['my/script?id=1'])
+ * // {
+ * //   "url": "my/script?id=1",
+ * //   "obj": {
+ * //     "_bbn": "public"
+ * //   },
+ * //   "datatype": "json"
+ * // }
+ * ```
+ *
+ * @param    {*}      args
+ *
+ * @returns  {Object} The configuration object
+ */
+declare const treatAjaxArguments: (args: any) => BbnAjaxCfg;
+export { treatAjaxArguments };

package/dist/fn/ajax/treatAjaxArguments.js

@@ -0,0 +1,127 @@
+import { isObject } from '../type/isObject';
+import { isFunction } from '../type/isFunction';
+import { substr } from '../string/substr';
+import { numProperties } from '../object/numProperties';
+/**
+ * Transforms unordered arguments into a configuratiuon object for Ajax shortcut functions.
+ *
+ * The final object will have the following arguments: url, obj, datatype, force, successFn,
+ * errorFn, abortFn, e, and ele; The rules are:
+ * * The first string found is the URL
+ * * The second string found is the datatype
+ * * The first function is successFn
+ * * The second function is errorFn
+ * * The third function is abortFn
+ * * A boolean true is force
+ * * An Event is e
+ * * An HTML element is ele
+ *
+ * If no object is given the _bbn property will be added in order to always post something
+ * and let the bbn server scripts know if a whole DOM is requested or a JSON answer
+ *
+ * @method   treatAjaxArguments
+ * @global
+ * @memberof bbn.fn
+ *
+ * @example
+ * ```javascript
+ * bbn.fn.treatAjaxArguments(['my/script', 'json', {a:1, b:2}, () => bbn.fn.log('Hi'), () => bbn.fn.log('Bye'), () => bbn.fn.log('Argh'), true])
+ * // {
+ * //   "url": "my/script",
+ * //   "datatype": "json",
+ * //   "obj": {
+ * //     "a": 1,
+ * //     "b": 2
+ * //   },
+ * //   "successFn": () => bbn.fn.log('Hi'),
+ * //   "errorFn": () => bbn.fn.log('Bye'),
+ * //   "abortFn": () => bbn.fn.log('Argh'),
+ * //   "force": true
+ * // }
+ *
+ * bbn.fn.treatAjaxArguments(['my/script?id=1'])
+ * // {
+ * //   "url": "my/script?id=1",
+ * //   "obj": {
+ * //     "_bbn": "public"
+ * //   },
+ * //   "datatype": "json"
+ * // }
+ * ```
+ *
+ * @param    {*}      args
+ *
+ * @returns  {Object} The configuration object
+ */
+const treatAjaxArguments = function (args) {
+    let cfg = {};
+    let t;
+    let i;
+    if (isObject(args[0]) && args.length === 1) {
+        return args[0];
+    }
+    for (i = 0; i < args.length; i++) {
+        t = typeof args[i];
+        t = t.toLowerCase();
+        /* Callbacks */
+        if (isFunction(args[i])) {
+            if (cfg.errorFn && !cfg.abortFn) {
+                cfg.abortFn = args[i];
+            }
+            if (cfg.successFn && !cfg.errorFn) {
+                cfg.errorFn = args[i];
+            }
+            else if (!cfg.successFn) {
+                cfg.successFn = args[i];
+            }
+        }
+        else if (args[i] === 1 || args[i] === true) {
+            /* Force */
+            cfg.force = true;
+        }
+        else if (t === 'string') {
+            if (!cfg.url) {
+                /* Hash */
+                if (args[i].indexOf('#') === 0 || args[i].indexOf(bbn.env.root + '#') === 0) {
+                    cfg.url = substr(args[i], bbn.env.root.length);
+                }
+                else {
+                    /* Link */
+                    cfg.url = args[i];
+                    if (cfg.url.indexOf(bbn.env.root) === 0) {
+                        cfg.url = substr(cfg.url, bbn.env.root.length);
+                    }
+                }
+            }
+            else {
+                /* Ajax datatype */
+                cfg.datatype = args[i];
+            }
+        }
+        else if (args[i] && t === 'object') {
+            /* Event */
+            if (args[i] instanceof Event) {
+                cfg.e = args[i];
+            }
+            else if (!cfg.ele && args[i].nodeType === 1) {
+                /* HTML Element */
+                cfg.ele = args[i];
+            }
+            else if (t.toLowerCase() === 'object') {
+                /* An object to post */
+                cfg.obj = args[i];
+            }
+        }
+    }
+    if (!cfg.url && numProperties(cfg)) {
+        cfg.url = bbn.env.path;
+    }
+    if (cfg.obj === undefined) {
+        cfg.obj = { _bbn: 'public' };
+    }
+    if (!cfg.datatype) {
+        cfg.datatype = 'json';
+    }
+    return cfg;
+};
+export { treatAjaxArguments };

package/dist/fn/ajax/upload.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Uploads a file synchronously through an XHR indicating progress.
+ *
+ * @method   upload
+ * @todo examples
+ * @global
+ * @memberof bbn.fn
+ *
+ * @param {String}   url      The URL to which the file should be uploaded
+ * @param {File}     file     A File object or an array of data
+ * @param {Function} success  A function to execute after success
+ * @param {Function} failure  A function to execute after failure
+ * @param {Function} progress A function to execute during progress
+ *
+ * @returns  {Promise}
+ */
+declare const upload: (url: string, file: any, success?: (d: any) => any, failure?: (d: any) => any, progress?: (d: any, l: any, t: any) => any) => any;
+export { upload };

package/dist/fn/ajax/upload.js

@@ -0,0 +1,52 @@
+import { objectToFormData } from '../form/objectToFormData';
+import { log } from '../browser/log';
+/**
+ * Uploads a file synchronously through an XHR indicating progress.
+ *
+ * @method   upload
+ * @todo examples
+ * @global
+ * @memberof bbn.fn
+ *
+ * @param {String}   url      The URL to which the file should be uploaded
+ * @param {File}     file     A File object or an array of data
+ * @param {Function} success  A function to execute after success
+ * @param {Function} failure  A function to execute after failure
+ * @param {Function} progress A function to execute during progress
+ *
+ * @returns  {Promise}
+ */
+const upload = function (url, file, success, failure, progress) {
+    let fn = () => {
+        return axios.post(url || bbn.env.path, objectToFormData(file), {
+            headers: {
+                'Content-Type': 'multipart/form-data',
+            },
+            onUploadProgress(progressEvent) {
+                if (progress) {
+                    let percentCompleted = Math.round((progressEvent.loaded * 100) / progressEvent.total);
+                    progress(percentCompleted, progressEvent.loaded, progressEvent.total);
+                }
+            },
+        });
+    };
+    if (!success && !failure) {
+        return fn();
+    }
+    else {
+        return fn()
+            .then((res) => {
+            if (success) {
+                log('SUCCESS', res);
+                success(res);
+            }
+        })
+            .catch((err) => {
+            if (failure) {
+                log('ERROR', err);
+                failure(err);
+            }
+        });
+    }
+};
+export { upload };

package/dist/fn/browser/copy.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Copies to the clipboard the value of the given string.
+ * @method   copy
+ * @global
+ * ``` javascript
+ * let myVal = 'the value you want to copy to clipbord';
+ * bbn.fn.copy(myVal);
+ *
+ * ```
+ * @memberof bbn.fn
+ * @param {String} st The string to copy.
+ * @returns
+ */
+declare const copy: (st: any) => Promise<unknown>;
+export { copy };

package/dist/fn/browser/copy.js

@@ -0,0 +1,50 @@
+import { isObject } from '../type/isObject';
+import { isFunction } from '../type/isFunction';
+/**
+ * Copies to the clipboard the value of the given string.
+ * @method   copy
+ * @global
+ * ``` javascript
+ * let myVal = 'the value you want to copy to clipbord';
+ * bbn.fn.copy(myVal);
+ *
+ * ```
+ * @memberof bbn.fn
+ * @param {String} st The string to copy.
+ * @returns
+ */
+const copy = function (st) {
+    return new Promise((resolve) => {
+        if (st) {
+            if (navigator && navigator.clipboard) {
+                if (st instanceof Blob) {
+                    navigator.clipboard.write([new ClipboardItem({ [st.type.toString()]: st })]).then(() => {
+                        resolve(true);
+                    });
+                }
+                else if (isObject(st) && isFunction(st.toBlob)) {
+                    st.toBlob((blob) => {
+                        navigator.clipboard.write([new ClipboardItem({ [blob.type.toString()]: blob })]).then(() => {
+                            resolve(true);
+                        });
+                    });
+                }
+                else {
+                    navigator.clipboard.writeText(st);
+                    resolve(true);
+                }
+                return;
+            }
+            let input = document.createElement('textarea');
+            input.style.opacity = '0';
+            input.value = st;
+            document.body.appendChild(input);
+            input.select();
+            document.execCommand('copy');
+            document.body.removeChild(input);
+            resolve(true);
+        }
+        resolve(false);
+    });
+};
+export { copy };

package/dist/fn/browser/eraseCookie.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Erase the cookie corresponding to the given name;
+ *
+ * @method   eraseCookie
+ * @global
+ * @example
+ * ``` javascript
+ * // 'en'
+ * bbn.fn.erase('lang');
+ * ```
+ * @memberof bbn.fn
+ * @returns  {*}
+ */
+declare const eraseCookie: (name: any) => void;
+export { eraseCookie };

package/dist/fn/browser/eraseCookie.js

@@ -0,0 +1,17 @@
+/**
+ * Erase the cookie corresponding to the given name;
+ *
+ * @method   eraseCookie
+ * @global
+ * @example
+ * ``` javascript
+ * // 'en'
+ * bbn.fn.erase('lang');
+ * ```
+ * @memberof bbn.fn
+ * @returns  {*}
+ */
+const eraseCookie = function (name) {
+    document.cookie = name + '=; Max-Age=-99999999;';
+};
+export { eraseCookie };

package/dist/fn/browser/error.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Throws an error.
+ * @method   error
+ * @global
+ * @ignore
+ * ``` javascript
+ * bbn.fn.error('I log this error in console with a red background')
+ * ```
+ * @memberof bbn.fn
+ * @param    {String} errorMsg
+ * @returns
+ */
+declare const error: (errorMsg: any) => never;
+export { error };

package/dist/fn/browser/error.js

@@ -0,0 +1,29 @@
+import { log } from './log';
+/**
+ * Throws an error.
+ * @method   error
+ * @global
+ * @ignore
+ * ``` javascript
+ * bbn.fn.error('I log this error in console with a red background')
+ * ```
+ * @memberof bbn.fn
+ * @param    {String} errorMsg
+ * @returns
+ */
+const error = function (errorMsg) {
+    if (arguments.length > 1) {
+        const args = [];
+        for (let i = 1; i < arguments.length; i++) {
+            args.push(arguments[i]);
+        }
+        args.unshift({
+            _bbn_console_mode: 'error',
+            _bbn_console_level: 1,
+            _bbn_console_style: 'color: #E64141; background: #F7E195; font-size: 14px',
+        });
+        log.apply(this, args);
+    }
+    throw new Error(errorMsg);
+};
+export { error };

package/dist/fn/browser/getBrowserName.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Gets the browser's name
+ * @method getBrowserName
+ * @global
+ * @memberof bbn.fn
+ * @returns {String}
+ */
+declare const getBrowserName: () => "Edge" | "Opera" | "Chrome" | "Internet Explorer" | "Firefox" | "Safari" | "Other";
+export { getBrowserName };

package/dist/fn/browser/getBrowserName.js

@@ -0,0 +1,28 @@
+/**
+ * Gets the browser's name
+ * @method getBrowserName
+ * @global
+ * @memberof bbn.fn
+ * @returns {String}
+ */
+const getBrowserName = function () {
+    const userAgent = navigator.userAgent.toLowerCase();
+    switch (true) {
+        case userAgent.includes('edge'):
+        case userAgent.includes('edg/'):
+            return 'Edge';
+        case userAgent.includes('opr') && !!window['opr']:
+            return 'Opera';
+        case userAgent.includes('chrome') && !!window['chrome']:
+            return 'Chrome';
+        case userAgent.includes('trident'):
+            return 'Internet Explorer';
+        case userAgent.includes('firefox'):
+            return 'Firefox';
+        case userAgent.includes('safari'):
+            return 'Safari';
+        default:
+            return 'Other';
+    }
+};
+export { getBrowserName };

package/dist/fn/browser/getBrowserVersion.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Gets the browser's version
+ * @method getBrowserVersion
+ * @global
+ * @memberof bbn.fn
+ * @returns {String}
+ */
+declare const getBrowserVersion: () => string;
+export { getBrowserVersion };

package/dist/fn/browser/getBrowserVersion.js

@@ -0,0 +1,29 @@
+/**
+ * Gets the browser's version
+ * @method getBrowserVersion
+ * @global
+ * @memberof bbn.fn
+ * @returns {String}
+ */
+const getBrowserVersion = function () {
+    const userAgent = navigator.userAgent.toLowerCase();
+    switch (true) {
+        case userAgent.includes('edge/'):
+            return userAgent.split('edge/')[1].split(' ')[0];
+        case userAgent.includes('edg/'):
+            return userAgent.split('edg/')[1].split(' ')[0];
+        case userAgent.includes('opr/') && !!window['opr']:
+            return userAgent.split('opr/')[1].split(' ')[0];
+        case userAgent.includes('chrome/') && !!window['chrome']:
+            return userAgent.split('chrome/')[1].split(' ')[0];
+        case userAgent.includes('trident/'):
+            return userAgent.split('trident/')[1].split(' ')[0];
+        case userAgent.includes('firefox/'):
+            return userAgent.split('firefox/')[1].split(' ')[0];
+        case userAgent.includes('safari/'):
+            return userAgent.split('version/')[1].split(' ')[0];
+        default:
+            return '';
+    }
+};
+export { getBrowserVersion };

package/dist/fn/browser/getCookie.d.ts

@@ -0,0 +1,16 @@
+/**
+ * If it exsists returns the cookie corresponding to the given name.
+ *
+ * @method   getCookie
+ * @example
+ * ``` javascript
+ * // 'en'
+ * bbn.fn.getCookie('lang');
+ * ```
+ * @global
+ * @memberof bbn.fn
+ * @param    {String} name
+ * @returns
+ */
+declare const getCookie: (name: any) => any;
+export { getCookie };

package/dist/fn/browser/getCookie.js

@@ -0,0 +1,32 @@
+/**
+ * If it exsists returns the cookie corresponding to the given name.
+ *
+ * @method   getCookie
+ * @example
+ * ``` javascript
+ * // 'en'
+ * bbn.fn.getCookie('lang');
+ * ```
+ * @global
+ * @memberof bbn.fn
+ * @param    {String} name
+ * @returns
+ */
+const getCookie = function (name) {
+    let nameEqual = name + '=';
+    let ca = document.cookie.split(';');
+    for (let i = 0; i < ca.length; i++) {
+        let c = ca[i];
+        while (c.charAt(0) == ' ') {
+            c = c.substring(1, c.length);
+        }
+        if (c.indexOf(nameEqual) == 0) {
+            let st = c.substring(nameEqual.length, c.length);
+            if (st) {
+                return JSON.parse(unescape(st)).value;
+            }
+        }
+    }
+    return null;
+};
+export { getCookie };

package/dist/fn/browser/getDeviceType.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Returns the current device type.
+ * @method   getDeviceType
+ * @global
+ * @example
+ * ``` javascript
+ * bbn.fn.getDeviceType();
+ * // mobile
+ * ```
+ * @memberof bbn.fn
+ * @returns  {String}
+ */
+declare const getDeviceType: () => "mobile" | "tablet" | "desktop";
+export { getDeviceType };

package/dist/fn/browser/getDeviceType.js

@@ -0,0 +1,23 @@
+/**
+ * Returns the current device type.
+ * @method   getDeviceType
+ * @global
+ * @example
+ * ``` javascript
+ * bbn.fn.getDeviceType();
+ * // mobile
+ * ```
+ * @memberof bbn.fn
+ * @returns  {String}
+ */
+const getDeviceType = function () {
+    const userAgent = navigator.userAgent.toLowerCase();
+    if (/iPhone|Android/i.test(navigator.userAgent)) {
+        return 'mobile';
+    }
+    if (/(ipad|tablet|(android(?!.*mobile))|(windows(?!.*phone)(.*touch))|kindle|playbook|silk|(puffin(?!.*(IP|AP|WP))))/.test(userAgent)) {
+        return 'tablet';
+    }
+    return 'desktop';
+};
+export { getDeviceType };