@ouroboros/browser 0.1.0

package/hash.js

@@ -0,0 +1,195 @@
+/**
+ * Hash
+ *
+ * JS Library to manage hash values
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2018-12-09
+ */
+// Generic modules
+import { clone, empty, isObject, parseQuery } from '@ouroboros/tools';
+// name regex
+const nameRE = /^[a-zA-Z_]+$/;
+// Callbacks
+const dCallbacks = {};
+// Values
+let dHash = {};
+/**
+ * Hash Changed
+ *
+ * Called when the location hash has been altered, notifies any watchers of
+ * hash values changing
+ *
+ * @name _hashChanged
+ * @access private
+ * @return {void}
+ */
+function _hashChanged() {
+    // Store the current hash
+    const old = clone(dHash);
+    // Re-parse the current location hash
+    dHash = parseQuery(window.location.hash.substring(1));
+    // If there are dCallbacks
+    if (!empty(dCallbacks)) {
+        // Check each watch
+        for (const name in dCallbacks) {
+            // If the value didn't exist and now it does, or it did exist
+            //	and now it doesn't, or the values don't match
+            if ((!(name in old) && name in dHash) ||
+                (name in old && !(name in dHash)) ||
+                old[name] !== dHash[name]) {
+                // Go through each callback and call it
+                for (const f of dCallbacks[name]) {
+                    f(dHash[name] || null);
+                }
+            }
+        }
+    }
+}
+/**
+ * Init
+ *
+ * Initialises the internal hash by fetching and parsing the current
+ * location hash
+ *
+ * @name init
+ * @access public
+ * @return {void}
+ */
+function init() {
+    // Track changes
+    window.addEventListener("hashchange", _hashChanged);
+    // Parse the current location hash
+    dHash = parseQuery(window.location.hash.substring(1));
+}
+/**
+ * Get
+ *
+ * Returns a hash name
+ *
+ * @name get
+ * @access public
+ * @static
+ * @param {string} name The name to look for
+ * @param {string?} defaultReturn The value to return if the name isn't found
+ * @return {string | null}
+ */
+function get(name, defaultReturn) {
+    // If the name is invalid
+    if (!nameRE.test(name)) {
+        throw new Error('Invalid Hash name');
+    }
+    // If there is a value for the name
+    if (typeof dHash[name] !== 'undefined') {
+        return dHash[name];
+    }
+    // Else, return the default
+    else {
+        return defaultReturn === undefined ? null : defaultReturn;
+    }
+}
+/**
+ * Set
+ *
+ * Sets a specific name
+ *
+ * @name set
+ * @access public
+ * @param {string | object} name The name to set, or an object of name/value pairs
+ * @param {string?} value The value to set the name to
+ */
+function set(name, value) {
+    // If the name is not an object
+    if (!isObject(name)) {
+        // If the value is not defined
+        if (typeof value === 'undefined') {
+            value = '';
+        }
+        // Set the value
+        name = { [name]: value };
+    }
+    // Make a copy of the current hash
+    const copy = clone(dHash);
+    // Go through each name
+    for (const n of Object.keys(name)) {
+        // If the name is invalid
+        if (!nameRE.test(n)) {
+            throw new Error('Invalid Hash name: ' + n);
+        }
+        // If we got null, delete the name
+        if (name[n] === null) {
+            delete copy[n];
+        }
+        // Else, set the new value
+        else {
+            copy[n] = name[n];
+        }
+    }
+    // Init an array to store the parts
+    const temp = [];
+    // Go through each name
+    for (const k of Object.keys(copy)) {
+        temp.push(k + '=' + copy[k]);
+    }
+    // Reset the window location hash
+    window.location.hash = temp.join('&');
+}
+/**
+ * Subscribe
+ *
+ * Adds a callback for a specific name which will be called if the name is
+ * added, deleted, or changed
+ *
+ * @name subscribe
+ * @access public
+ * @param {string} name The name of the value to watch
+ * @param {function} callback The function to call when the value changes
+ * @return {void}
+ */
+function subscribe(name, callback) {
+    // If we already have the name
+    if (name in dCallbacks) {
+        // Go through the callbacks associated with the name
+        for (const f of dCallbacks[name]) {
+            // If we already have the callback there's no need to store it
+            if (f === callback) {
+                return;
+            }
+        }
+    }
+    // Else if we don't have any callbacks for the name
+    else {
+        dCallbacks[name] = [];
+    }
+    // Add the callback to the dCallbacks
+    dCallbacks[name].push(callback);
+}
+/**
+ * Unsubscribe
+ *
+ * Removes a callback from the dCallbacks
+ *
+ * @name unsubscribe
+ * @access public
+ * @param {string} name The name of the value to stop watching
+ * @param {function} callback The callback to remove
+ * @return {void}
+ */
+function unsubscribe(name, callback) {
+    // If we have the name
+    if (name in dCallbacks) {
+        // Go through the callbacks associated with the name
+        for (let i = 0; i < dCallbacks[name].length; ++i) {
+            // If we find the callback
+            if (dCallbacks[name][i] === callback) {
+                // Remove it
+                dCallbacks[name].splice(i, 1);
+                return;
+            }
+        }
+    }
+}
+// Default export
+const hash = { init, get, set, subscribe, unsubscribe };
+export default hash;

package/hash.ts

@@ -0,0 +1,239 @@
+/**
+ * Hash
+ *
+ * JS Library to manage hash values
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2018-12-09
+ */
+
+// Generic modules
+import { clone, empty, isObject, parseQuery } from '@ouroboros/tools';
+
+// Callback type
+type Callback = (value: string | null) => {};
+
+// name regex
+const nameRE = /^[a-zA-Z_]+$/;
+
+// Callbacks
+const dCallbacks: Record<string, Callback[]> = {};
+
+// Values
+let dHash: Record<string, string> = {};
+
+/**
+ * Hash Changed
+ *
+ * Called when the location hash has been altered, notifies any watchers of
+ * hash values changing
+ *
+ * @name _hashChanged
+ * @access private
+ * @return {void}
+ */
+function _hashChanged(): void {
+
+	// Store the current hash
+	const old = clone(dHash);
+
+	// Re-parse the current location hash
+	dHash = parseQuery(window.location.hash.substring(1));
+
+	// If there are dCallbacks
+	if(!empty(dCallbacks)) {
+
+		// Check each watch
+		for(const name in dCallbacks) {
+
+			// If the value didn't exist and now it does, or it did exist
+			//	and now it doesn't, or the values don't match
+			if((!(name in old) && name in dHash) ||
+				(name in old && !(name in dHash)) ||
+				old[name] !== dHash[name]) {
+
+				// Go through each callback and call it
+				for(const f of dCallbacks[name]) {
+					f(dHash[name] || null);
+				}
+			}
+		}
+	}
+}
+
+/**
+ * Init
+ *
+ * Initialises the internal hash by fetching and parsing the current
+ * location hash
+ *
+ * @name init
+ * @access public
+ * @return {void}
+ */
+function init(): void {
+
+	// Track changes
+	window.addEventListener("hashchange", _hashChanged);
+
+	// Parse the current location hash
+	dHash = parseQuery(window.location.hash.substring(1));
+}
+
+/**
+ * Get
+ *
+ * Returns a hash name
+ *
+ * @name get
+ * @access public
+ * @static
+ * @param {string} name The name to look for
+ * @param {string?} defaultReturn The value to return if the name isn't found
+ * @return {string | null}
+ */
+function get(name: string, defaultReturn?: string): string | null {
+
+	// If the name is invalid
+	if(!nameRE.test(name)) {
+		throw new Error('Invalid Hash name');
+	}
+
+	// If there is a value for the name
+	if(typeof dHash[name] !== 'undefined') {
+		return dHash[name];
+	}
+
+	// Else, return the default
+	else {
+		return defaultReturn === undefined ? null : defaultReturn;
+	}
+}
+
+/**
+ * Set
+ *
+ * Sets a specific name
+ *
+ * @name set
+ * @access public
+ * @param {string | object} name The name to set, or an object of name/value pairs
+ * @param {string?} value The value to set the name to
+ */
+function set(name: string | object, value?: string) {
+
+	// If the name is not an object
+	if(!isObject(name)) {
+
+		// If the value is not defined
+		if(typeof value === 'undefined') {
+			value = '';
+		}
+
+		// Set the value
+		name = {[name as string]: value}
+	}
+
+	// Make a copy of the current hash
+	const copy = clone(dHash);
+
+	// Go through each name
+	for(const n of Object.keys(name)) {
+
+		// If the name is invalid
+		if(!nameRE.test(n)) {
+			throw new Error('Invalid Hash name: ' + n);
+		}
+
+		// If we got null, delete the name
+		if(name[n as keyof object] === null) {
+			delete copy[n];
+		}
+		// Else, set the new value
+		else {
+			copy[n] = name[n as keyof object];
+		}
+	}
+
+	// Init an array to store the parts
+	const temp: string[] = [];
+
+	// Go through each name
+	for(const k of Object.keys(copy)) {
+		temp.push(k + '=' + copy[k]);
+	}
+
+	// Reset the window location hash
+	window.location.hash = temp.join('&');
+}
+
+/**
+ * Subscribe
+ *
+ * Adds a callback for a specific name which will be called if the name is
+ * added, deleted, or changed
+ *
+ * @name subscribe
+ * @access public
+ * @param {string} name The name of the value to watch
+ * @param {function} callback The function to call when the value changes
+ * @return {void}
+ */
+function subscribe(name: string, callback: Callback): void {
+
+	// If we already have the name
+	if(name in dCallbacks) {
+
+		// Go through the callbacks associated with the name
+		for(const f of dCallbacks[name]) {
+
+			// If we already have the callback there's no need to store it
+			if(f === callback) {
+				return;
+			}
+		}
+	}
+
+	// Else if we don't have any callbacks for the name
+	else {
+		dCallbacks[name] = [];
+	}
+
+	// Add the callback to the dCallbacks
+	dCallbacks[name].push(callback);
+}
+
+/**
+ * Unsubscribe
+ *
+ * Removes a callback from the dCallbacks
+ *
+ * @name unsubscribe
+ * @access public
+ * @param {string} name The name of the value to stop watching
+ * @param {function} callback The callback to remove
+ * @return {void}
+ */
+function unsubscribe(name: string, callback: Callback): void {
+
+	// If we have the name
+	if(name in dCallbacks) {
+
+		// Go through the callbacks associated with the name
+		for(let i = 0; i < dCallbacks[name].length; ++i) {
+
+			// If we find the callback
+			if(dCallbacks[name][i] === callback) {
+
+				// Remove it
+				dCallbacks[name].splice(i, 1);
+				return;
+			}
+		}
+	}
+}
+
+// Default export
+const hash = { init, get, set, subscribe, unsubscribe };
+export default hash;

package/index.d.ts

@@ -0,0 +1,4 @@
+export { default as clipboard } from './clipboard';
+export { default as cookies } from './cookies';
+export { default as hash } from './hash';
+export { default as pageVisibility } from './pageVisibility';

package/index.js

@@ -0,0 +1,4 @@
+export { default as clipboard } from './clipboard';
+export { default as cookies } from './cookies';
+export { default as hash } from './hash';
+export { default as pageVisibility } from './pageVisibility';

package/index.ts

@@ -0,0 +1,4 @@
+export { default as clipboard } from './clipboard';
+export { default as cookies } from './cookies';
+export { default as hash } from './hash';
+export { default as pageVisibility } from './pageVisibility';

package/package.json

@@ -0,0 +1,38 @@
+{
+	"name": "@ouroboros/browser",
+	"version": "0.1.0",
+	"description": "Package to handle common browser functionality.",
+	"main": "index.js",
+	"types": "index.d.ts",
+	"scripts": {
+		"build": "tslint -p tsconfig.json && tsc",
+		"clean": "rm *.js *.d.ts",
+		"test": "echo \"Error: no test specified.\" && exit 1"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/ouroboroscoding/browser-js.git"
+	},
+	"keywords": [
+		"javascript",
+		"browser",
+		"clipboard",
+		"cookies",
+		"hash",
+		"page visibility"
+	],
+	"author": "Chris Nasr <chris@ouroboroscoding.com>",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/ouroboroscoding/browser-js/issues"
+	},
+	"devDependencies": {
+		"tslint": "^6.1.3",
+		"tslint-config-prettier": "^1.18.0",
+		"typescript": "^4.8.3"
+	},
+	"dependencies": {
+		"@ouroboros/tools": "^0.1.0"
+	},
+	"peerDependencies": {}
+}

package/pageVisibility.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Page Visibility
+ *
+ * Library/Namespace containing various functions to track page visibility
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2018-08-01
+ */
+type Callback = (...args: any[]) => {};
+/**
+ * Get
+ *
+ * Returns the current state of visibility
+ *
+ * @name get
+ * @access public
+ * @return {object | false}
+ */
+export declare function get(): object | false;
+/**
+ * Subscribe
+ *
+ * Track changes on page visibility
+ *
+ * @name subscribe
+ * @access public
+ * @param {function} callback Function to call on visibility changes
+ * @return {boolean}
+ */
+export declare function subscribe(callback: Callback): boolean;
+/**
+ * Ubsubscribe
+ *
+ * Stop tracking changes in page visibility
+ *
+ * @name unsubscribe
+ * @access public
+ * @param {function} callback
+ * @return {boolean}
+ */
+export declare function unsubscribe(callback: Callback): boolean;
+declare const pageVisibility: {
+    get: typeof get;
+    subscribe: typeof subscribe;
+    unsubscribe: typeof unsubscribe;
+};
+export default pageVisibility;

package/pageVisibility.js

@@ -0,0 +1,132 @@
+/**
+ * Page Visibility
+ *
+ * Library/Namespace containing various functions to track page visibility
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2018-08-01
+ */
+// Init the visibility property name and event values
+let bVis = false;
+const dVis = {
+    property: 'hidden',
+    event: 'visibilitychange',
+    state: 'visibilityState'
+};
+const lCallbacks = [];
+// Figure out the name of the visibility property and event
+// Valid browser prefixes
+const lPrefixes = ['moz', 'ms', 'o', 'webkit'];
+// If a prefix is required
+if ('hidden' in document) {
+    bVis = true;
+}
+// Else, loop through the prefixes
+else {
+    for (const prefix of lPrefixes) {
+        // If the prefixes version exists
+        if ((prefix + 'Hidden') in document) {
+            dVis.property = prefix + 'Hidden';
+            dVis.event = prefix + 'visibilitychange';
+            dVis.state = prefix + 'VisibilityState';
+            bVis = true;
+            break;
+        }
+    }
+}
+/**
+ * Track
+ *
+ * The actual function passed to the event so that we only have one event listener
+ *
+ * @name track
+ * @access private
+ * @return {void}
+ */
+function track() {
+    // Call the callbacks and pass them bool and state values
+    for (const f of lCallbacks) {
+        f(document[dVis.property], document[dVis.state]);
+    }
+}
+/**
+ * Get
+ *
+ * Returns the current state of visibility
+ *
+ * @name get
+ * @access public
+ * @return {object | false}
+ */
+export function get() {
+    // If the library is available
+    if (bVis) {
+        return {
+            property: document[dVis.property],
+            state: document[dVis.state]
+        };
+    }
+    else {
+        console.error('Page Visibility API not available');
+        return false;
+    }
+}
+/**
+ * Subscribe
+ *
+ * Track changes on page visibility
+ *
+ * @name subscribe
+ * @access public
+ * @param {function} callback Function to call on visibility changes
+ * @return {boolean}
+ */
+export function subscribe(callback) {
+    // If the Page Visibility  API is not available
+    if (bVis === false) {
+        console.error('Page Visibility API not available');
+        return false;
+    }
+    // Save the callback for later
+    lCallbacks.push(callback);
+    // Attach an event listener if this is our first event
+    if (lCallbacks.length === 1) {
+        document.addEventListener(dVis.event, track);
+    }
+    // Return ok
+    return true;
+}
+/**
+ * Ubsubscribe
+ *
+ * Stop tracking changes in page visibility
+ *
+ * @name unsubscribe
+ * @access public
+ * @param {function} callback
+ * @return {boolean}
+ */
+export function unsubscribe(callback) {
+    // If the Page Visibility  API is not available
+    if (bVis === false) {
+        console.error('Page Visibility API not available');
+        return false;
+    }
+    // Find the index of the callback
+    const iIndex = lCallbacks.indexOf(callback);
+    // If it exists
+    if (iIndex > -1) {
+        // Remove the callback
+        lCallbacks.splice(iIndex, 1);
+        // Remove event listener if we have no more callbacks
+        if (lCallbacks.length === 0) {
+            document.removeEventListener(dVis.event, track);
+        }
+    }
+    // Return ok
+    return true;
+}
+// Default export
+const pageVisibility = { get, subscribe, unsubscribe };
+export default pageVisibility;