@ouroboros/browser 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Ouroboros Coding
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,61 @@
+# @ouroboros/browser
+
+[![npm version](https://img.shields.io/npm/v/@ouroboros/browser.svg)](https://www.npmjs.com/package/@ouroboros/browser) ![MIT License](https://img.shields.io/npm/l/@ouroboros/browser.svg)
+
+A library of classes to manage functionality in browsers.
+
+## Installation
+npm
+```bash
+npm install @ouroboros/browser
+```
+
+## Getting Started
+
+Import clipboard into your code
+
+```javascript
+import clipboard from '@ouroboros/browser/clipboard';
+```
+
+or
+
+```javascript
+import { clipboard } from '@ouroboros/browser';
+```
+
+Import Cookies into your code
+
+```javascript
+import cookies from '@ouroboros/browser/cookies';
+```
+
+or
+
+```javascript
+import { cookies } from '@ouroboros/browser';
+```
+
+Import hash into your code
+
+```javascript
+import hash from '@ouroboros/browser/hash';
+```
+
+or
+
+```javascript
+import { hash } from '@ouroboros/browser';
+```
+
+Import pageVisibility into your code
+
+```javascript
+import pageVisibility from '@ouroboros/browser/pageVisibility';
+```
+
+or
+
+```javascript
+import { pageVisibility } from '@ouroboros/browser';
+```

package/clipboard.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Clipboard
+ *
+ * Handles adding text to the clipboard
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2018-11-24
+ */
+/**
+ * Copy
+ *
+ * Attempts to add text to the clipboard
+ *
+ * @name copy
+ * @access public
+ * @param {string} text The text to add to the clipboard
+ * @return {Promise}
+ */
+export declare function copy(text: string): Promise<any>;
+declare const clipboard: {
+    copy: typeof copy;
+};
+export default clipboard;

package/clipboard.js

@@ -0,0 +1,60 @@
+/**
+ * Clipboard
+ *
+ * Handles adding text to the clipboard
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2018-11-24
+ */
+/**
+ * Copy
+ *
+ * Attempts to add text to the clipboard
+ *
+ * @name copy
+ * @access public
+ * @param {string} text The text to add to the clipboard
+ * @return {Promise}
+ */
+export function copy(text) {
+    // If we find the api
+    if (navigator.clipboard) {
+        return navigator.clipboard.writeText(text);
+    }
+    // Else, fallback to copying from a textarea we create ourselves
+    else {
+        return new Promise((resolve, reject) => {
+            // Create a text area to place the text in then select it
+            const oEl = document.createElement('textarea');
+            oEl.value = text;
+            oEl.style.top = "0";
+            oEl.style.left = "0";
+            oEl.style.position = "fixed";
+            document.body.appendChild(oEl);
+            oEl.focus();
+            oEl.select();
+            // Try to copy the text to the clipboard
+            let bRes = false;
+            let mErr = null;
+            try {
+                bRes = document.execCommand('copy');
+            }
+            catch (err) {
+                mErr = err;
+            }
+            // Remove the textarea and return the result
+            document.body.removeChild(oEl);
+            // Resolve or reject
+            if (mErr) {
+                reject(mErr);
+            }
+            else {
+                resolve(bRes);
+            }
+        });
+    }
+}
+// Default export
+const clipboard = { copy };
+export default clipboard;

package/clipboard.ts

@@ -0,0 +1,66 @@
+/**
+ * Clipboard
+ *
+ * Handles adding text to the clipboard
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2018-11-24
+ */
+
+/**
+ * Copy
+ *
+ * Attempts to add text to the clipboard
+ *
+ * @name copy
+ * @access public
+ * @param {string} text The text to add to the clipboard
+ * @return {Promise}
+ */
+export function copy(text: string): Promise<any> {
+
+	// If we find the api
+	if(navigator.clipboard) {
+		return navigator.clipboard.writeText(text);
+	}
+
+	// Else, fallback to copying from a textarea we create ourselves
+	else {
+		return new Promise((resolve, reject) => {
+
+			// Create a text area to place the text in then select it
+			const oEl = document.createElement('textarea');
+			oEl.value = text;
+			oEl.style.top = "0";
+			oEl.style.left = "0";
+			oEl.style.position = "fixed";
+			document.body.appendChild(oEl);
+			oEl.focus();
+			oEl.select();
+
+			// Try to copy the text to the clipboard
+			let bRes = false;
+			let mErr = null;
+			try {
+				bRes = document.execCommand('copy');
+			} catch(err) {
+				mErr = err;
+			}
+
+			// Remove the textarea and return the result
+			document.body.removeChild(oEl);
+
+			// Resolve or reject
+			if(mErr) {
+				reject(mErr);
+			} else {
+				resolve(bRes);
+			}
+		});
+	}
+}
+
+// Default export
+const clipboard = { copy };
+export default clipboard;

package/cookies.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Cookies
+ *
+ * JS Library to deal with Cookies
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2018-11-24
+ */
+/**
+ * Get
+ *
+ * Gets a cookie or returns the default. Set no name to get all
+ *
+ * @name get
+ * @access public
+ * @param {string} name The name of the cookie to fetch
+ * @param {string} defaulReturn The default value to return if no cookie is found
+ * @return {string | object | null}
+ */
+declare function get(name: string, defaulReturn: string | null | undefined): string | object | null;
+/**
+ * Remove
+ *
+ * Deletes a cookie
+ *
+ * @name remove
+ * @access public
+ * @param {string} name The name of the cookie to delete
+ * @param {string?} domain The domain of the cookie
+ * @param {string?} path The path of the cookie
+ * @return {void}
+ */
+declare function remove(name: string, domain?: string, path?: string): void;
+/**
+ * Set
+ *
+ * Sets a cookie
+ *
+ * @name set
+ * @access public
+ * @param {string} name The name of the cookie
+ * @param {string} value The value to store
+ * @param {number} expires The number of seconds before the cookie expires
+ * @param {string?} domain The optional domain to set the cookie on
+ * @param {string?} path The optional path of the cookie
+ * @return {void}
+ */
+declare function set(name: string, value: string, expires: number, domain?: string, path?: string): void;
+declare const cookies: {
+    get: typeof get;
+    remove: typeof remove;
+    set: typeof set;
+};
+export default cookies;

package/cookies.js

@@ -0,0 +1,87 @@
+/**
+ * Cookies
+ *
+ * JS Library to deal with Cookies
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2018-11-24
+ */
+/**
+ * Get
+ *
+ * Gets a cookie or returns the default. Set no name to get all
+ *
+ * @name get
+ * @access public
+ * @param {string} name The name of the cookie to fetch
+ * @param {string} defaulReturn The default value to return if no cookie is found
+ * @return {string | object | null}
+ */
+function get(name, defaulReturn) {
+    // Set the default if no value is passed
+    if (typeof defaulReturn === 'undefined') {
+        defaulReturn = null;
+    }
+    // Parse all cookies
+    const oCookies = {};
+    const lCookies = document.cookie.split(';');
+    for (const s of lCookies) {
+        const l = s.split('=');
+        oCookies[l[0].trimStart()] = decodeURIComponent(l[1]);
+    }
+    // If there's no name, return all
+    if (typeof name === 'undefined') {
+        return oCookies;
+    }
+    // If the cookie exists return it, else return the default
+    return (name in oCookies) ? oCookies[name] : defaulReturn;
+}
+/**
+ * Remove
+ *
+ * Deletes a cookie
+ *
+ * @name remove
+ * @access public
+ * @param {string} name The name of the cookie to delete
+ * @param {string?} domain The domain of the cookie
+ * @param {string?} path The path of the cookie
+ * @return {void}
+ */
+function remove(name, domain, path) {
+    set(name, '', -1, domain, path);
+}
+/**
+ * Set
+ *
+ * Sets a cookie
+ *
+ * @name set
+ * @access public
+ * @param {string} name The name of the cookie
+ * @param {string} value The value to store
+ * @param {number} expires The number of seconds before the cookie expires
+ * @param {string?} domain The optional domain to set the cookie on
+ * @param {string?} path The optional path of the cookie
+ * @return {void}
+ */
+function set(name, value, expires, domain, path) {
+    // Generate the expires time
+    const d = new Date();
+    d.setTime(d.getTime() + (expires * 1000));
+    // Generate the cookie string
+    let s = name + '=' + encodeURIComponent(value) +
+        '; expires=' + d.toUTCString() + ';';
+    if (domain) {
+        s += ' domain=' + domain + ';';
+    }
+    if (path) {
+        s += ' path=' + path + ';';
+    }
+    // Set the cookie
+    document.cookie = s;
+}
+// Default export
+const cookies = { get, remove, set };
+export default cookies;

package/cookies.ts

@@ -0,0 +1,98 @@
+/**
+ * Cookies
+ *
+ * JS Library to deal with Cookies
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2018-11-24
+ */
+
+/**
+ * Get
+ *
+ * Gets a cookie or returns the default. Set no name to get all
+ *
+ * @name get
+ * @access public
+ * @param {string} name The name of the cookie to fetch
+ * @param {string} defaulReturn The default value to return if no cookie is found
+ * @return {string | object | null}
+ */
+function get(name: string, defaulReturn: string | null | undefined): string | object | null {
+
+	// Set the default if no value is passed
+	if(typeof defaulReturn === 'undefined') {
+		defaulReturn = null;
+	}
+
+	// Parse all cookies
+	const oCookies: Record<string, string> = {};
+	const lCookies = document.cookie.split(';');
+	for(const s of lCookies) {
+		const l = s.split('=');
+		oCookies[l[0].trimStart()] = decodeURIComponent(l[1]);
+	}
+
+	// If there's no name, return all
+	if(typeof name === 'undefined') {
+		return oCookies;
+	}
+
+	// If the cookie exists return it, else return the default
+	return (name in oCookies) ? oCookies[name] : defaulReturn;
+}
+
+/**
+ * Remove
+ *
+ * Deletes a cookie
+ *
+ * @name remove
+ * @access public
+ * @param {string} name The name of the cookie to delete
+ * @param {string?} domain The domain of the cookie
+ * @param {string?} path The path of the cookie
+ * @return {void}
+ */
+function remove(name: string, domain?: string, path?: string): void {
+	set(name, '', -1, domain, path);
+}
+
+/**
+ * Set
+ *
+ * Sets a cookie
+ *
+ * @name set
+ * @access public
+ * @param {string} name The name of the cookie
+ * @param {string} value The value to store
+ * @param {number} expires The number of seconds before the cookie expires
+ * @param {string?} domain The optional domain to set the cookie on
+ * @param {string?} path The optional path of the cookie
+ * @return {void}
+ */
+function set(name: string, value: string, expires: number, domain?: string, path?: string): void {
+
+	// Generate the expires time
+	const d = new Date();
+	d.setTime(d.getTime() + (expires*1000))
+
+	// Generate the cookie string
+	let s = name + '=' + encodeURIComponent(value) +
+			'; expires=' + d.toUTCString() + ';';
+	if(domain) {
+		s += ' domain=' + domain + ';';
+	}
+	if(path) {
+		s += ' path=' + path + ';';
+	}
+
+	// Set the cookie
+	document.cookie = s;
+}
+
+// Default export
+const cookies = { get, remove, set };
+export default cookies;

package/hash.d.ts

@@ -0,0 +1,78 @@
+/**
+ * Hash
+ *
+ * JS Library to manage hash values
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2018-12-09
+ */
+type Callback = (value: string | null) => {};
+/**
+ * Init
+ *
+ * Initialises the internal hash by fetching and parsing the current
+ * location hash
+ *
+ * @name init
+ * @access public
+ * @return {void}
+ */
+declare function init(): void;
+/**
+ * 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}
+ */
+declare function get(name: string, defaultReturn?: string): string | null;
+/**
+ * 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
+ */
+declare function set(name: string | object, value?: string): void;
+/**
+ * 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}
+ */
+declare function subscribe(name: string, callback: Callback): void;
+/**
+ * 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}
+ */
+declare function unsubscribe(name: string, callback: Callback): void;
+declare const hash: {
+    init: typeof init;
+    get: typeof get;
+    set: typeof set;
+    subscribe: typeof subscribe;
+    unsubscribe: typeof unsubscribe;
+};
+export default hash;