@ouroboros/browser 0.1.7 → 0.3.0

package/network.js

@@ -0,0 +1,106 @@
+/**
+ * Network
+ *
+ * Tracks whether the browser is online / offline
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2024-04-09
+ */
+// Ouroboros modules
+import Subscribe from '@ouroboros/subscribe';
+/**
+ * Track Offline
+ *
+ * The actual function passed to the event so that we only have one event
+ * listener
+ *
+ * @name trackOffline
+ * @access private
+ */
+function trackOffline() {
+    // Set the data so the instance notifies subscribers
+    network.set(false);
+}
+/**
+ * Track Online
+ *
+ * The actual function passed to the event so that we only have one event
+ * listener
+ *
+ * @name trackOnline
+ * @access private
+ */
+function trackOnline() {
+    // Set the data so the instance notifies subscribers
+    network.set(true);
+}
+/**
+ * Network
+ *
+ * Extends the Subscribe class to be created once and exported
+ *
+ * @name Network
+ * @extends Subscribe
+ */
+class Network extends Subscribe {
+    /**
+     * Constructor
+     *
+     * Creates a new instance and returns it
+     *
+     * @name Network
+     * @access private
+     * @returns Network
+     */
+    constructor() {
+        // Get the current values and init the instance with them
+        super(navigator.onLine);
+    }
+    /**
+     * Subscribe
+     *
+     * Overrides parent subscribe to handle adding the window event
+     *
+     * @name subscribe
+     * @access public
+     * @param callback The function to call when the state changes
+     * @returns object
+     */
+    subscribe(callback) {
+        // If we have no current subscribers
+        if (this.subscribeCallbacks.length === 0) {
+            // Add the event listeners
+            window.addEventListener('online', trackOnline);
+            window.addEventListener('offline', trackOffline);
+        }
+        // Call the parent subscribe and return
+        return super.subscribe(callback);
+    }
+    /**
+     * Unsubscribe
+     *
+     * Overrides parent unsubscribe to handle removing the window event
+     *
+     * @name unsubscribe
+     * @access public
+     * @param callback The callback to remove from the list
+     * @returns boolean
+     */
+    unsubscribe(callback) {
+        // Call the parent unsubscribe
+        const bRet = super.unsubscribe(callback);
+        // If it was successful and we have no more callbacks
+        if (bRet && this.subscribeCallbacks.length === 0) {
+            // Remove the event listeners
+            window.removeEventListener('online', trackOnline);
+            window.removeEventListener('offline', trackOffline);
+        }
+        // Return
+        return bRet;
+    }
+}
+// Create an instance of the class
+const network = new Network();
+// Default export
+export default network;

package/network.ts

@@ -0,0 +1,127 @@
+/**
+ * Network
+ *
+ * Tracks whether the browser is online / offline
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2024-04-09
+ */
+
+// Ouroboros modules
+import Subscribe, {
+	SubscribeCallback,
+	SubscribeReturn
+} from '@ouroboros/subscribe';
+
+/**
+ * Track Offline
+ *
+ * The actual function passed to the event so that we only have one event
+ * listener
+ *
+ * @name trackOffline
+ * @access private
+ */
+function trackOffline(): void {
+
+	// Set the data so the instance notifies subscribers
+	network.set(false);
+}
+
+/**
+ * Track Online
+ *
+ * The actual function passed to the event so that we only have one event
+ * listener
+ *
+ * @name trackOnline
+ * @access private
+ */
+function trackOnline(): void {
+
+	// Set the data so the instance notifies subscribers
+	network.set(true);
+}
+
+/**
+ * Network
+ *
+ * Extends the Subscribe class to be created once and exported
+ *
+ * @name Network
+ * @extends Subscribe
+ */
+class Network extends Subscribe {
+
+	/**
+	 * Constructor
+	 *
+	 * Creates a new instance and returns it
+	 *
+	 * @name Network
+	 * @access private
+	 * @returns Network
+	 */
+	constructor() {
+
+		// Get the current values and init the instance with them
+		super(navigator.onLine);
+	}
+
+	/**
+	 * Subscribe
+	 *
+	 * Overrides parent subscribe to handle adding the window event
+	 *
+	 * @name subscribe
+	 * @access public
+	 * @param callback The function to call when the state changes
+	 * @returns object
+	 */
+	subscribe(callback: SubscribeCallback): SubscribeReturn {
+
+		// If we have no current subscribers
+		if(this.subscribeCallbacks.length === 0) {
+
+			// Add the event listeners
+			window.addEventListener('online', trackOnline);
+			window.addEventListener('offline', trackOffline);
+		}
+
+		// Call the parent subscribe and return
+		return super.subscribe(callback);
+	}
+
+	/**
+	 * Unsubscribe
+	 *
+	 * Overrides parent unsubscribe to handle removing the window event
+	 *
+	 * @name unsubscribe
+	 * @access public
+	 * @param callback The callback to remove from the list
+	 * @returns boolean
+	 */
+	unsubscribe(callback: SubscribeCallback): boolean {
+
+		// Call the parent unsubscribe
+		const bRet = super.unsubscribe(callback);
+
+		// If it was successful and we have no more callbacks
+		if(bRet && this.subscribeCallbacks.length === 0) {
+
+			// Remove the event listeners
+			window.removeEventListener('online', trackOnline);
+			window.removeEventListener('offline', trackOffline);
+		}
+
+		// Return
+		return bRet;
+	}
+}
+
+// Create an instance of the class
+const network = new Network();
+// Default export
+export default network;

package/package.json

@@ -1,12 +1,13 @@
 {
 	"name": "@ouroboros/browser",
-	"version": "0.1.7",
+	"version": "0.3.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",
+		"for_local": "npm install; tslint -p tsconfig.json && tsc; rm -Rf node_modules",
 		"test": "echo \"Error: no test specified.\" && exit 1"
 	},
 	"repository": {
@@ -20,6 +21,7 @@
 		"cookies",
 		"hash",
 		"local storage",
+		"network",
 		"page visibility"
 	],
 	"author": "Chris Nasr <chris@ouroboroscoding.com>",
@@ -34,6 +36,7 @@
 	},
 	"dependencies": {
 		"@ouroboros/clone": "^1.0.1",
-		"@ouroboros/tools": "^0.4.1"
+		"@ouroboros/subscribe": "^1.2.2",
+		"@ouroboros/tools": "^0.5.3"
 	}
 }

package/pageVisibility.d.ts

@@ -7,42 +7,48 @@
  * @copyright Ouroboros Coding Inc.
  * @created 2018-08-01
  */
-type Callback = (...args: any[]) => {};
+import Subscribe, { SubscribeCallback, SubscribeReturn } from '@ouroboros/subscribe';
 /**
- * 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
+ * Page Visibility
  *
- * Stop tracking changes in page visibility
+ * Extends the Subscribe class to be created once and exported
  *
- * @name unsubscribe
- * @access public
- * @param {function} callback
- * @return {boolean}
+ * @name PageVisibility
+ * @extends Subscribe
  */
-export declare function unsubscribe(callback: Callback): boolean;
-declare const pageVisibility: {
-    get: typeof get;
-    subscribe: typeof subscribe;
-    unsubscribe: typeof unsubscribe;
-};
+declare class PageVisibility extends Subscribe {
+    /**
+     * Constructor
+     *
+     * Creates a new instance and returns it
+     *
+     * @name PageVisibility
+     * @access private
+     * @returns PageVisibility
+     */
+    constructor();
+    /**
+     * Subscribe
+     *
+     * Overrides parent subscribe to handle adding the window event
+     *
+     * @name subscribe
+     * @access public
+     * @param callback The function to call when the state changes
+     * @returns object
+     */
+    subscribe(callback: SubscribeCallback): SubscribeReturn;
+    /**
+     * Unsubscribe
+     *
+     * Overrides parent unsubscribe to handle removing the window event
+     *
+     * @name unsubscribe
+     * @access public
+     * @param callback The callback to remove from the list
+     * @returns boolean
+     */
+    unsubscribe(callback: SubscribeCallback): boolean;
+}
+declare const pageVisibility: PageVisibility;
 export default pageVisibility;

package/pageVisibility.js

@@ -7,30 +7,30 @@
  * @copyright Ouroboros Coding Inc.
  * @created 2018-08-01
  */
+// Ouroboros modules
+import Subscribe from '@ouroboros/subscribe';
 // Init the visibility property name and event values
-let bVis = false;
-const dVis = {
+let apiAvailable = false;
+const properties = {
     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
+const prefixes = ['moz', 'ms', 'o', 'webkit'];
+// If a prefix is not required
 if ('hidden' in document) {
-    bVis = true;
+    apiAvailable = true;
 }
 // Else, loop through the prefixes
 else {
-    for (const prefix of lPrefixes) {
+    for (const prefix of prefixes) {
         // If the prefixes version exists
         if ((prefix + 'Hidden') in document) {
-            dVis.property = prefix + 'Hidden';
-            dVis.event = prefix + 'visibilitychange';
-            dVis.state = prefix + 'VisibilityState';
-            bVis = true;
+            properties.property = prefix + 'Hidden';
+            properties.event = prefix + 'visibilitychange';
+            properties.state = prefix + 'VisibilityState';
+            apiAvailable = true;
             break;
         }
     }
@@ -38,95 +38,90 @@ else {
 /**
  * Track
  *
- * The actual function passed to the event so that we only have one event listener
+ * 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]);
-    }
+    // Set the data so the instance notifies subscribers
+    pageVisibility.set({
+        property: document[properties.property],
+        state: document[properties.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
+ * Page Visibility
  *
- * Track changes on page visibility
+ * Extends the Subscribe class to be created once and exported
  *
- * @name subscribe
- * @access public
- * @param {function} callback Function to call on visibility changes
- * @return {boolean}
+ * @name PageVisibility
+ * @extends Subscribe
  */
-export function subscribe(callback) {
-    // If the Page Visibility  API is not available
-    if (bVis === false) {
-        console.error('Page Visibility API not available');
-        return false;
+class PageVisibility extends Subscribe {
+    /**
+     * Constructor
+     *
+     * Creates a new instance and returns it
+     *
+     * @name PageVisibility
+     * @access private
+     * @returns PageVisibility
+     */
+    constructor() {
+        // Get the current values and init the instance with them
+        super(apiAvailable ? {
+            property: document[properties.property],
+            state: document[properties.state]
+        } : null);
     }
-    // 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;
+    /**
+     * Subscribe
+     *
+     * Overrides parent subscribe to handle adding the window event
+     *
+     * @name subscribe
+     * @access public
+     * @param callback The function to call when the state changes
+     * @returns object
+     */
+    subscribe(callback) {
+        // If we have no current subscribers
+        if (apiAvailable && this.subscribeCallbacks.length === 0) {
+            // Add the event listener
+            document.addEventListener(properties.event, track);
+        }
+        // Call the parent subscribe and return
+        return super.subscribe(callback);
     }
-    // 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);
+    /**
+     * Unsubscribe
+     *
+     * Overrides parent unsubscribe to handle removing the window event
+     *
+     * @name unsubscribe
+     * @access public
+     * @param callback The callback to remove from the list
+     * @returns boolean
+     */
+    unsubscribe(callback) {
+        // If there's no API
+        if (!apiAvailable) {
+            return false;
+        }
+        // Call the parent unsubscribe
+        const bRet = super.unsubscribe(callback);
+        // If it was successful and we have no more callbacks
+        if (bRet && this.subscribeCallbacks.length === 0) {
+            // Remove the event listener
+            document.removeEventListener(properties.event, track);
         }
+        // Return
+        return bRet;
     }
-    // Return ok
-    return true;
 }
+// Create an instance of the class
+const pageVisibility = new PageVisibility();
 // Default export
-const pageVisibility = { get, subscribe, unsubscribe };
 export default pageVisibility;