@ouroboros/mouth-mui 1.2.0 → 1.3.0

package/{src → build}/locales.d.ts

@@ -22,7 +22,8 @@ export type Options = Record<string, Option[]>;
  * @extends Subscribe
  */
 declare class Locales extends Subscribe {
-    private running;
+    private failed;
+    private fetching;
     /**
      * Constructor
      *
@@ -58,6 +59,17 @@ declare class Locales extends Subscribe {
      * 			text
      */
     static objectSort(records: Record<string, Record<string, string>>): Options;
+    /**
+     * Fetch
+     *
+     * Private method to fetch the locales from the server which loops if
+     * there's network issues
+     *
+     * @name fetch
+     * @access private
+     * @returns void
+     */
+    private fetch;
     /**
      * Subscribe
      *
@@ -65,6 +77,9 @@ declare class Locales extends Subscribe {
      *
      * @name subscribe
      * @access public
+     * @param callback The function to call when locales change
+     * @returns an object with the current available `data` and `unsubscribe`
+     * 			to remove the callback from the list when we're done
      */
     subscribe(callback: SubscribeCallback): SubscribeReturn;
 }

package/{src → build}/locales.js

@@ -8,6 +8,7 @@
  * @created 2021-03-17
  */
 // Ouroboros modules
+import events from '@ouroboros/events';
 import Subscribe from '@ouroboros/subscribe';
 // Local modules
 import mouth from '@ouroboros/mouth';
@@ -20,8 +21,10 @@ import mouth from '@ouroboros/mouth';
  * @extends Subscribe
  */
 class Locales extends Subscribe {
+    // Keep track of failed attempts
+    failed;
     // Keeps the state of if the rest request is taking place
-    running;
+    fetching;
     /**
      * Constructor
      *
@@ -35,7 +38,7 @@ class Locales extends Subscribe {
         // Call the Subscribe constructor with empty data
         super([]);
         // Init the running flag
-        this.running = false;
+        this.fetching = false;
     }
     /**
      * Array Sort
@@ -122,6 +125,47 @@ class Locales extends Subscribe {
         // Return the new structure
         return oRet;
     }
+    /**
+     * Fetch
+     *
+     * Private method to fetch the locales from the server which loops if
+     * there's network issues
+     *
+     * @name fetch
+     * @access private
+     * @returns void
+     */
+    fetch() {
+        // Mark us as running
+        this.fetching = true;
+        // Fetch the data from the server
+        mouth.read('locales').then((list) => {
+            // If there's data
+            if (list) {
+                // Trigger all callbacks
+                this.set(list);
+            }
+            // Finish running
+            this.fetching = false;
+            // Reset the count
+            this.failed = 0;
+        }, error => {
+            // If we haven't hit the limit
+            if (this.failed < 3) {
+                // Increase the failed count
+                ++this.failed;
+                // Fetch again
+                this.fetch();
+            }
+            // Else, we can't keep trying, notify the user
+            else {
+                events.get('error').trigger(error);
+            }
+        }).finally(() => {
+            // Regardless of the outcome, we're done fetching
+            this.fetching = false;
+        });
+    }
     /**
      * Subscribe
      *
@@ -129,24 +173,17 @@ class Locales extends Subscribe {
      *
      * @name subscribe
      * @access public
+     * @param callback The function to call when locales change
+     * @returns an object with the current available `data` and `unsubscribe`
+     * 			to remove the callback from the list when we're done
      */
     subscribe(callback) {
         // Call the Subscribe subscribe
         const oReturn = super.subscribe(callback);
         // If we don't have a value yet and it's not running
-        if (oReturn.data.length === 0 && this.running === false) {
-            // Mark us as running
-            this.running = true;
-            // Fetch the data from the server
-            mouth.read('locales').then((list) => {
-                // If there's data
-                if (list) {
-                    // Trigger all callbacks
-                    this.set(list);
-                }
-                // Finish running
-                this.running = false;
-            });
+        if (oReturn.data.length === 0 && this.fetching === false) {
+            // Fetch the data
+            this.fetch();
             // Overwrite the data
             oReturn.data = [];
         }

package/package.json

@@ -1,12 +1,12 @@
 {
 	"name": "@ouroboros/mouth-mui",
-	"version": "1.2.0",
+	"version": "1.3.0",
 	"description": "Components for use with the Mouth service",
-	"main": "src/index.js",
-	"types": "src/index.d.ts",
+	"main": "build/index.js",
+	"types": "build/index.d.ts",
 	"scripts": {
 		"build": "tslint -p tsconfig.json && tsc",
-		"clean": "cd src; find . -type f -name \"*.js\" -delete; find . -type f -name \"*.d.ts\" -delete",
+		"clean": "rm -Rf build/*",
 		"for_local": "npm install; tslint -p tsconfig.json && tsc; rm -Rf node_modules",
 		"test": "echo \"Error: no test specified.\" && exit 1"
 	},
@@ -26,7 +26,6 @@
 		"url": "https://github.com/ouroboroscoding/mouth-mui/issues"
 	},
 	"devDependencies": {
-		"@ouroboros/body": "^1.0.2",
 		"@types/node": "^18.14.0",
 		"@types/react": "^18.0.28",
 		"@types/uuid": "^9.0.0",
@@ -35,22 +34,23 @@
 		"typescript": "^4.8.3"
 	},
 	"dependencies": {
-		"@ouroboros/clone": "^1.0.1",
-		"@ouroboros/define": "^1.0.2",
-		"@ouroboros/define-mui": "^1.0.3",
-		"@ouroboros/react-radiobuttons-mui": "^1.0.0",
-		"@ouroboros/subscribe": "^1.2.0",
-		"@ouroboros/tools": "^0.5.1",
+		"@ouroboros/clone": "^1.1.0",
+		"@ouroboros/define": "^1.1.0",
+		"@ouroboros/define-mui": "^1.5.0",
+		"@ouroboros/react-radiobuttons-mui": "^1.1.0",
+		"@ouroboros/subscribe": "^1.3.1",
+		"@ouroboros/tools": "^0.6.1",
 		"prop-types": "^15.8.1"
 	},
 	"peerDependencies": {
 		"@emotion/react": "^11.8.2",
 		"@emotion/styled": "^11.8.1",
 		"@mui/material": "^5.5.1",
-		"@ouroboros/body": "^1.0.2",
-		"@ouroboros/brain-react": "^1.0.0",
-		"@ouroboros/mouth": "^1.1.0",
-		"react": "^17.0.2",
-		"react-dom": "^17.0.2"
+		"@ouroboros/body": "^1.1.2",
+		"@ouroboros/brain-react": "^1.1.0",
+		"@ouroboros/events": "^1.1.0",
+		"@ouroboros/mouth": "^1.2.0",
+		"react": "^17.0.2 || ^18.0.0",
+		"react-dom": "^17.0.2 || ^18.0.0"
 	}
 }

package/src/locales.ts

@@ -9,6 +9,7 @@
  */
 
 // Ouroboros modules
+import events from '@ouroboros/events';
 import Subscribe, { SubscribeCallback, SubscribeReturn } from '@ouroboros/subscribe';
 
 // Local modules
@@ -31,8 +32,11 @@ export type Options = Record<string, Option[]>;
  */
 class Locales extends Subscribe {
 
+	// Keep track of failed attempts
+	private failed: number;
+
 	// Keeps the state of if the rest request is taking place
-	private running: boolean;
+	private fetching: boolean;
 
 	/**
 	 * Constructor
@@ -49,7 +53,7 @@ class Locales extends Subscribe {
 		super([]);
 
 		// Init the running flag
-		this.running = false;
+		this.fetching = false;
 	}
 
 	/**
@@ -151,6 +155,61 @@ class Locales extends Subscribe {
 		return oRet;
 	}
 
+	/**
+	 * Fetch
+	 *
+	 * Private method to fetch the locales from the server which loops if
+	 * there's network issues
+	 *
+	 * @name fetch
+	 * @access private
+	 * @returns void
+	 */
+	private fetch(): void {
+
+		// Mark us as running
+		this.fetching = true;
+
+		// Fetch the data from the server
+		mouth.read('locales').then((list: any) => {
+
+			// If there's data
+			if(list) {
+
+				// Trigger all callbacks
+				this.set(list);
+			}
+
+			// Finish running
+			this.fetching = false;
+
+			// Reset the count
+			this.failed = 0;
+
+		}, error => {
+
+			// If we haven't hit the limit
+			if(this.failed < 3) {
+
+				// Increase the failed count
+				++this.failed;
+
+				// Fetch again
+				this.fetch();
+			}
+
+			// Else, we can't keep trying, notify the user
+			else {
+				events.get('error').trigger(error);
+			}
+
+		}).finally(() => {
+
+			// Regardless of the outcome, we're done fetching
+			this.fetching = false;
+		})
+	}
+
 	/**
 	 * Subscribe
 	 *
@@ -158,6 +217,9 @@ class Locales extends Subscribe {
 	 *
 	 * @name subscribe
 	 * @access public
+	 * @param callback The function to call when locales change
+	 * @returns an object with the current available `data` and `unsubscribe`
+	 * 			to remove the callback from the list when we're done
 	 */
 	subscribe(callback: SubscribeCallback): SubscribeReturn {
 
@@ -165,24 +227,10 @@ class Locales extends Subscribe {
 		const oReturn = super.subscribe(callback);
 
 		// If we don't have a value yet and it's not running
-		if(oReturn.data.length === 0 && this.running === false) {
-
-			// Mark us as running
-			this.running = true;
-
-			// Fetch the data from the server
-			mouth.read('locales').then((list: any) => {
-
-				// If there's data
-				if(list) {
+		if(oReturn.data.length === 0 && this.fetching === false) {
 
-					// Trigger all callbacks
-					this.set(list);
-				}
-
-				// Finish running
-				this.running = false;
-			});
+			// Fetch the data
+			this.fetch();
 
 			// Overwrite the data
 			oReturn.data = [];

package/src/types/xhr2.d.ts

@@ -0,0 +1,3 @@
+declare module "xhr2" {
+	export default XMLHttpRequest;
+}