@ouroboros/mouth-mui 1.0.0

package/src/locales.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Locales
+ *
+ * Keeps track of the locales available
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2021-03-17
+ */
+import Subscribe, { SubscribeCallback, SubscribeReturn } from '@ouroboros/subscribe';
+export type Option = {
+    id: string;
+    text: string;
+};
+export type Options = Record<string, Option[]>;
+/**
+ * Locales
+ *
+ * Extends the Subscribe class to be created once and exported
+ *
+ * @name Locales
+ * @extends Subscribe
+ */
+declare class Locales extends Subscribe {
+    private running;
+    /**
+     * Constructor
+     *
+     * Creates a new instance
+     *
+     * @name Locales
+     * @access public
+     * @returns a new instance
+     */
+    constructor();
+    /**
+     * Array Sort
+     *
+     * Splits the records so they are stored by locale and then orders them
+     * alphabetically
+     *
+     * @name arraySort
+     * @param records The records to sort
+     * @param idKey The primary key of the records to sort
+     * @param valueKey The value with locale data in the records
+     */
+    static arraySort(records: Record<string, any>[], idKey?: string, valueKey?: string): Options;
+    /**
+     * Object Sort
+     *
+     * Splits the records so they are stored by locale and then orders them
+     * alphabetically
+     *
+     * @name objectSort
+     * @access public
+     * @param records The records to re-order
+     * @returns an object of locale keys to option records sorted by the display
+     * 			text
+     */
+    static objectSort(records: Record<string, Record<string, string>>): Options;
+    /**
+     * Subscribe
+     *
+     * Override the subscribe method to initiate the fetching process
+     *
+     * @name subscribe
+     * @access public
+     */
+    subscribe(callback: SubscribeCallback): SubscribeReturn;
+}
+declare const locale: Locales;
+export default locale;

package/src/locales.js

@@ -0,0 +1,160 @@
+/**
+ * Locales
+ *
+ * Keeps track of the locales available
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2021-03-17
+ */
+// Ouroboros modules
+import Subscribe from '@ouroboros/subscribe';
+// Local modules
+import mouth from '@ouroboros/mouth';
+/**
+ * Locales
+ *
+ * Extends the Subscribe class to be created once and exported
+ *
+ * @name Locales
+ * @extends Subscribe
+ */
+class Locales extends Subscribe {
+    // Keeps the state of if the rest request is taking place
+    running;
+    /**
+     * Constructor
+     *
+     * Creates a new instance
+     *
+     * @name Locales
+     * @access public
+     * @returns a new instance
+     */
+    constructor() {
+        // Call the Subscribe constructor with empty data
+        super([]);
+        // Init the running flag
+        this.running = false;
+    }
+    /**
+     * Array Sort
+     *
+     * Splits the records so they are stored by locale and then orders them
+     * alphabetically
+     *
+     * @name arraySort
+     * @param records The records to sort
+     * @param idKey The primary key of the records to sort
+     * @param valueKey The value with locale data in the records
+     */
+    static arraySort(records, idKey = '_id', valueKey = 'name') {
+        // Init the return
+        const oRet = {};
+        // Go through each record
+        for (const oRecord of records) {
+            // Go through each locale
+            for (const sLocale of Object.keys(oRecord[valueKey])) {
+                // If we don't have the locale
+                if (!(sLocale in oRet)) {
+                    oRet[sLocale] = [];
+                }
+                // Add the ID and text to the list
+                oRet[sLocale].push({
+                    id: oRecord[idKey],
+                    text: oRecord[valueKey][sLocale]
+                });
+            }
+        }
+        // Go through each locale
+        for (const sLocale of Object.keys(oRet)) {
+            // Sort it alphabetically
+            oRet[sLocale].sort((a, b) => {
+                if (a.text.normalize('NFD') === b.text.normalize('NFD'))
+                    return 0;
+                else
+                    return (a.text.normalize('NFD') < b.text.normalize('NFD')) ? -1 : 1;
+            });
+        }
+        // Return the new structure
+        return oRet;
+    }
+    /**
+     * Object Sort
+     *
+     * Splits the records so they are stored by locale and then orders them
+     * alphabetically
+     *
+     * @name objectSort
+     * @access public
+     * @param records The records to re-order
+     * @returns an object of locale keys to option records sorted by the display
+     * 			text
+     */
+    static objectSort(records) {
+        // Init the return
+        const oRet = {};
+        // Go through each record
+        for (const sID of Object.keys(records)) {
+            // Go through each locale
+            for (const sLocale of Object.keys(records[sID])) {
+                // If we don't have the locale
+                if (!(sLocale in oRet)) {
+                    oRet[sLocale] = [];
+                }
+                // Add the ID and text to the list
+                oRet[sLocale].push({
+                    id: sID,
+                    text: records[sID][sLocale]
+                });
+            }
+        }
+        // Go through each locale
+        for (const sLocale of Object.keys(oRet)) {
+            // Sort it alphabetically
+            oRet[sLocale].sort((a, b) => {
+                if (a.text.normalize('NFD') === b.text.normalize('NFD'))
+                    return 0;
+                else
+                    return (a.text.normalize('NFD') < b.text.normalize('NFD')) ? -1 : 1;
+            });
+        }
+        // Return the new structure
+        return oRet;
+    }
+    /**
+     * Subscribe
+     *
+     * Override the subscribe method to initiate the fetching process
+     *
+     * @name subscribe
+     * @access public
+     */
+    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('locale').then((list) => {
+                // If there's data
+                if (list) {
+                    // Trigger all callbacks
+                    this.set(list);
+                }
+                // Finish running
+                this.running = false;
+            });
+            // Overwrite the data
+            oReturn.data = [];
+        }
+        // Return the Subscribe result
+        return oReturn;
+    }
+}
+// Create an instance of the class
+const locale = new Locales();
+// Default export
+export default locale;

package/src/locales.ts

@@ -0,0 +1,200 @@
+/**
+ * Locales
+ *
+ * Keeps track of the locales available
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2021-03-17
+ */
+
+// Ouroboros modules
+import Subscribe, { SubscribeCallback, SubscribeReturn } from '@ouroboros/subscribe';
+
+// Local modules
+import mouth from '@ouroboros/mouth';
+
+// Types
+export type Option = {
+	id: string,
+	text: string
+}
+export type Options = Record<string, Option[]>;
+
+/**
+ * Locales
+ *
+ * Extends the Subscribe class to be created once and exported
+ *
+ * @name Locales
+ * @extends Subscribe
+ */
+class Locales extends Subscribe {
+
+	// Keeps the state of if the rest request is taking place
+	private running: boolean;
+
+	/**
+	 * Constructor
+	 *
+	 * Creates a new instance
+	 *
+	 * @name Locales
+	 * @access public
+	 * @returns a new instance
+	 */
+	constructor() {
+
+		// Call the Subscribe constructor with empty data
+		super([]);
+
+		// Init the running flag
+		this.running = false;
+	}
+
+	/**
+	 * Array Sort
+	 *
+	 * Splits the records so they are stored by locale and then orders them
+	 * alphabetically
+	 *
+	 * @name arraySort
+	 * @param records The records to sort
+	 * @param idKey The primary key of the records to sort
+	 * @param valueKey The value with locale data in the records
+	 */
+	static arraySort(records: Record<string, any>[], idKey='_id', valueKey='name'): Options {
+
+		// Init the return
+		const oRet: Options = {};
+
+		// Go through each record
+		for(const oRecord of records) {
+
+			// Go through each locale
+			for(const sLocale of Object.keys(oRecord[valueKey])) {
+
+				// If we don't have the locale
+				if(!(sLocale in oRet)) {
+					oRet[sLocale] = [];
+				}
+
+				// Add the ID and text to the list
+				oRet[sLocale].push({
+					id: oRecord[idKey],
+					text: oRecord[valueKey][sLocale]
+				});
+			}
+		}
+
+		// Go through each locale
+		for(const sLocale of Object.keys(oRet)) {
+
+			// Sort it alphabetically
+			oRet[sLocale].sort((a, b) => {
+				if(a.text.normalize('NFD') === b.text.normalize('NFD')) return 0;
+				else return (a.text.normalize('NFD') < b.text.normalize('NFD')) ? -1 : 1;
+			});
+		}
+
+		// Return the new structure
+		return oRet;
+	}
+
+	/**
+	 * Object Sort
+	 *
+	 * Splits the records so they are stored by locale and then orders them
+	 * alphabetically
+	 *
+	 * @name objectSort
+	 * @access public
+	 * @param records The records to re-order
+	 * @returns an object of locale keys to option records sorted by the display
+	 * 			text
+	 */
+	static objectSort(records: Record<string, Record<string, string>>): Options {
+
+		// Init the return
+		const oRet: Options = {};
+
+		// Go through each record
+		for(const sID of Object.keys(records)) {
+
+			// Go through each locale
+			for(const sLocale of Object.keys(records[sID])) {
+
+				// If we don't have the locale
+				if(!(sLocale in oRet)) {
+					oRet[sLocale] = [];
+				}
+
+				// Add the ID and text to the list
+				oRet[sLocale].push({
+					id: sID,
+					text: records[sID][sLocale]
+				});
+			}
+		}
+
+		// Go through each locale
+		for(const sLocale of Object.keys(oRet)) {
+
+			// Sort it alphabetically
+			oRet[sLocale].sort((a, b) => {
+				if(a.text.normalize('NFD') === b.text.normalize('NFD')) return 0;
+				else return (a.text.normalize('NFD') < b.text.normalize('NFD')) ? -1 : 1;
+			});
+		}
+
+		// Return the new structure
+		return oRet;
+	}
+
+	/**
+	 * Subscribe
+	 *
+	 * Override the subscribe method to initiate the fetching process
+	 *
+	 * @name subscribe
+	 * @access public
+	 */
+	subscribe(callback: SubscribeCallback): SubscribeReturn {
+
+		// 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('locale').then((list: any) => {
+
+				// If there's data
+				if(list) {
+
+					// Trigger all callbacks
+					this.set(list);
+				}
+
+				// Finish running
+				this.running = false;
+			});
+
+			// Overwrite the data
+			oReturn.data = [];
+		}
+
+		// Return the Subscribe result
+		return oReturn;
+	}
+}
+
+// Create an instance of the class
+const locale = new Locales();
+
+// Default export
+export default locale;