@ouroboros/mouth-mui 2.1.1 → 2.1.3

package/lib/components/pages/Templates/Template/index.js

@@ -76,18 +76,26 @@ export default function Template({ locales, onChange, onError, onContent, rights
     // Called to update the template
     function update() {
         // Create the data in the system
-        mouth.update('template', edit).then((data) => {
+        mouth.update('template', edit).then((res) => {
+            // If we failed
+            if (res.error) {
+                if (res.error.code === errors.body.DB_DUPLICATE) {
+                    refName.current?.error('Duplicate');
+                }
+                else {
+                    if (onError) {
+                        onError(res.error);
+                    }
+                    else {
+                        throw new Error(JSON.stringify(res.error));
+                    }
+                }
+                return;
+            }
             // Hide the form
             editSet(false);
             // Let the parent know
             onChange(edit);
-        }, (error) => {
-            if (error.code === errors.body.DB_DUPLICATE) {
-                refName.current?.error('Duplicate');
-            }
-            else {
-                return false;
-            }
         });
     }
     // View toggle
@@ -99,7 +107,7 @@ export default function Template({ locales, onChange, onError, onContent, rights
             if (contents === false) {
                 mouth.read('template/contents', {
                     template: value._id
-                }).then(contentsSet);
+                }).then((res) => contentsSet(res.data));
             }
             viewSet(true);
         }
@@ -163,7 +171,7 @@ export default function Template({ locales, onChange, onError, onContent, rights
 Template.propTypes = {
     locales: PropTypes.objectOf(PropTypes.string).isRequired,
     onChange: PropTypes.func.isRequired,
-    onError: PropTypes.func.isRequired,
+    onError: PropTypes.func,
     onContent: PropTypes.func.isRequired,
     rights: PropTypes.exact({
         template: PropTypes.exact({

package/lib/components/pages/Templates/index.d.ts

@@ -10,8 +10,8 @@ import PropTypes from 'prop-types';
 import React from 'react';
 import { responseErrorStruct } from '@ouroboros/body';
 export type TemplatesProps = {
-    onError: (error: responseErrorStruct) => void;
-    onSuccess: (type: string) => void;
+    onError?: (error: responseErrorStruct) => void;
+    onSuccess?: (type: string) => void;
 };
 /**
  * Templates
@@ -26,8 +26,8 @@ export type TemplatesProps = {
 declare function Templates({ onError, onSuccess }: TemplatesProps): React.JSX.Element;
 declare namespace Templates {
     var propTypes: {
-        onError: PropTypes.Validator<(...args: any[]) => any>;
-        onSuccess: PropTypes.Validator<(...args: any[]) => any>;
+        onError: PropTypes.Requireable<(...args: any[]) => any>;
+        onSuccess: PropTypes.Requireable<(...args: any[]) => any>;
     };
 }
 export default Templates;

package/lib/components/pages/Templates/index.js

@@ -42,14 +42,14 @@ export default function Templates({ onError, onSuccess }) {
     useEffect(() => {
         // If we have template read permissions
         if (rightsTemplate.read) {
-            mouth.read('locales').then((data) => {
+            mouth.read('locales').then((res) => {
                 const oLocales = {};
-                for (const o of data) {
+                for (const o of res.data) {
                     oLocales[o._id] = o.name;
                 }
                 localesSet(oLocales);
             });
-            mouth.read('templates').then(templatesSet);
+            mouth.read('templates').then((res) => templatesSet(res.data));
         }
         else {
             localesSet({});
@@ -63,7 +63,9 @@ export default function Templates({ onError, onSuccess }) {
     // Called when a template has been created
     function templateCreated(template) {
         // Notify parent
-        onSuccess('template_create');
+        if (onSuccess) {
+            onSuccess('template_create');
+        }
         // Hide the create form
         createSet(false);
         // Clone the current templates, add the new one to the front, and set
@@ -73,7 +75,9 @@ export default function Templates({ onError, onSuccess }) {
     // Called when a template has been updated
     function templateUpdated(template) {
         // Notify parent
-        onSuccess('template_update');
+        if (onSuccess) {
+            onSuccess('template_update');
+        }
         // Work on latest
         templatesSet(l => arrayFindOverwrite(l, '_id', template._id, template, true));
     }
@@ -88,13 +92,17 @@ export default function Templates({ onError, onSuccess }) {
                             React.createElement("i", { className: 'fa-solid fa-plus' + (create ? ' open' : '') }))))),
         create &&
             React.createElement(Create, { onCancel: () => createSet(false), onCreated: templateCreated, onError: onError }),
-        templates.map((o) => React.createElement(Template, { key: o._id, locales: locales, onChange: templateUpdated, onContent: type => onSuccess(`content_${type}`), onError: onError, rights: {
+        templates.map((o) => React.createElement(Template, { key: o._id, locales: locales, onChange: templateUpdated, onContent: type => {
+                if (onSuccess) {
+                    onSuccess(`content_${type}`);
+                }
+            }, onError: onError, rights: {
                 content: rightsContent,
                 template: rightsTemplate
             }, value: o }))));
 }
 // Valid props
 Templates.propTypes = {
-    onError: PropTypes.func.isRequired,
-    onSuccess: PropTypes.func.isRequired
+    onError: PropTypes.func,
+    onSuccess: PropTypes.func
 };

package/lib/locales.js

@@ -139,28 +139,31 @@ class Locales extends Subscribe {
         // Mark us as running
         this.fetching = true;
         // Fetch the data from the server
-        mouth.read('locales').then((list) => {
+        mouth.read('locales').then((res) => {
+            // If we failed
+            if (res.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(res.error);
+                }
+                return;
+            }
             // If there's data
-            if (list) {
+            if (res.data) {
                 // Trigger all callbacks
-                this.set(list);
+                this.set(res.data);
             }
             // 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;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ouroboros/mouth-mui",
-	"version": "2.1.1",
+	"version": "2.1.3",
 	"description": "Components for use with the Mouth service",
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",
@@ -28,27 +28,26 @@
 	"devDependencies": {
 		"@types/node": "^18.14.0",
 		"@types/react": "^18.0.28",
-		"@types/uuid": "^9.0.0",
 		"tslint": "^6.1.3",
 		"tslint-config-prettier": "^1.18.0",
-		"typescript": "^4.8.3"
+		"typescript": "^5.9.3"
 	},
 	"dependencies": {
 		"@ouroboros/define": "^1.1.3",
 		"@ouroboros/define-mui": "^1.5.6",
-		"@ouroboros/mouth": "^2.1.1",
+		"@ouroboros/mouth": "^2.2.0",
 		"@ouroboros/react-radiobuttons-mui": "^1.1.0",
 		"@ouroboros/subscribe": "^1.3.2",
-		"@ouroboros/tools": "^0.7.0",
+		"@ouroboros/tools": "^0.7.3",
 		"prop-types": "^15.8.1"
 	},
 	"peerDependencies": {
-		"@emotion/react": "^11.8.2",
-		"@emotion/styled": "^11.8.1",
+		"@emotion/react": "^11.14.0",
+		"@emotion/styled": "^11.14.1",
 		"@mui/material": "^5.5.1",
-		"@ouroboros/body": "^1.2.0",
-		"@ouroboros/brain-react": "^2.3.1",
-		"@ouroboros/events": "^1.1.0",
+		"@ouroboros/body": "^1.3.0",
+		"@ouroboros/brain-react": "^2.3.3",
+		"@ouroboros/events": "^1.1.3",
 		"react": "^17.0.2 || ^18.0.0",
 		"react-dom": "^17.0.2 || ^18.0.0"
 	}

package/releases.md

@@ -0,0 +1,21 @@
+# @ouroboros/mouth-mui releases
+
+## 2.1.3
+- Updated `@ouroboros/body` and `@ouroboros/mouth` to latest
+
+## 2.1.2
+- Completed documentation.
+
+## 2.1.1
+- Updated @ouroboros/mouth to 2.1.1.
+- Updated @ouroboros/body to 1.2.0.
+- Updated @ouroboros/brain-react to 2.3.1.
+
+## 2.1.0
+- Updated @ouroboros/brain-react to 2.3.0.
+- Updated @ouroboros/define to 1.1.3.
+- Updated @ouroboros/define-mui to 1.5.6.
+- Updated @ouroboros/mouth to 2.1.0.
+- Removed the `mobile` prop from all components as it wasn't used.
+- Removed all uses of clone from the project.
+- Added a shared file for holding onto common types / defines.

package/src/components/pages/Locales.tsx

@@ -42,7 +42,7 @@ const LocaleTree = new Tree(LocaleDef, {
 });
 
 // Types
-import { responseErrorStruct } from '@ouroboros/body';
+import { responseErrorStruct, responseStruct } from '@ouroboros/body';
 export type LocalesProps = {
 	onError: (error: responseErrorStruct) => void,
 	onSuccess: (type: string) => void
@@ -72,9 +72,9 @@ export default function Locales({ onError, onSuccess }: LocalesProps) {
 
 		// If we have read rights
 		if(rights.read) {
-			mouth.read('locales').then(recordsSet);
+			mouth.read('locales').then((res: responseStruct) => recordsSet(res.data));
 		} else {
-			recordsSet([]);
+			recordsSet([ ]);
 		}
 
 		// If we don't have create rights
@@ -91,13 +91,31 @@ export default function Locales({ onError, onSuccess }: LocalesProps) {
 		return new Promise((resolve, reject) => {
 
 			// Create the new locale
-			mouth.create('locale', locale).then((data: string) => {
+			mouth.create('locale', locale).then((res: responseStruct) => {
+
+				// If we failed
+				if(res.error) {
+					if(res.error.code === errors.body.DB_NO_RECORD) {
+						return reject([['_id', 'Already in use']]);
+					} else if(res.error.code === errors.body.DATA_FIELDS) {
+						return reject(res.error.msg);
+					} else {
+						if(onError) {
+							onError(res.error);
+							return reject([ ]);
+						} else {
+							throw new Error(JSON.stringify(res.error));
+						}
+					}
+				}
 
 				// If we were successful
-				if(data) {
+				if(res.data) {
 
 					// Notify the parent
-					onSuccess('create');
+					if(onSuccess) {
+						onSuccess('create');
+					}
 
 					// Close the create form
 					createSet(false);
@@ -112,20 +130,7 @@ export default function Locales({ onError, onSuccess }: LocalesProps) {
 				}
 
 				// Resolve with the form
-				resolve(data ? true : false);
-
-			}, (error: responseErrorStruct) => {
-				if(error.code === errors.body.DB_NO_RECORD) {
-					reject([['_id', 'Already in use']]);
-				} else if(error.code === errors.body.DATA_FIELDS) {
-					reject(error.msg);
-				} else {
-					if(onError) {
-						onError(error);
-					} else {
-						throw new Error(JSON.stringify(error));
-					}
-				}
+				resolve(res.data ? true : false);
 			});
 		});
 	}
@@ -134,13 +139,24 @@ export default function Locales({ onError, onSuccess }: LocalesProps) {
 	function deleteClick(key: string) {
 
 		// Delete the existing locale
-		mouth.delete('locale', { _id: key }).then((data: boolean) => {
+		mouth.delete('locale', { _id: key }).then((res: responseStruct) => {
+
+			// If we failed
+			if(res.error) {
+				if(onError) {
+					return onError(res.error);
+				} else {
+					throw new Error(JSON.stringify(res.error));
+				}
+			}
 
 			// If it was successful
-			if(data) {
+			if(res.data) {
 
 				// Notify the parent
-				onSuccess('delete');
+				if(onSuccess) {
+					onSuccess('delete');
+				}
 
 				// Look for the record
 				const i = afindi(records, '_id', key);
@@ -158,12 +174,6 @@ export default function Locales({ onError, onSuccess }: LocalesProps) {
 					locales.set(lRecords);
 				}
 			}
-		}, (error: responseErrorStruct) => {
-			if(onError) {
-				onError(error);
-			} else {
-				throw new Error(JSON.stringify(error));
-			}
 		});
 	}
 
@@ -177,13 +187,29 @@ export default function Locales({ onError, onSuccess }: LocalesProps) {
 		return new Promise((resolve, reject) => {
 
 			// Update the locale on the server
-			mouth.update('locale', locale).then((data: boolean) => {
+			mouth.update('locale', locale).then((res: responseStruct) => {
+
+				// If we failed
+				if(res.error) {
+					if(res.error.code === errors.body.DATA_FIELDS) {
+						return reject(res.error.msg);
+					} else {
+						if(onError) {
+							onError(res.error);
+							return reject([ ]);
+						} else {
+							throw new Error(JSON.stringify(res.error));
+						}
+					}
+				}
 
 				// If we were successful
-				if(data) {
+				if(res.data) {
 
 					// Notify the parent
-					onSuccess('update');
+					if(onSuccess) {
+						onSuccess('update');
+					}
 
 					// Look for the record
 					const i = afindi(records, '_id', key);
@@ -203,18 +229,7 @@ export default function Locales({ onError, onSuccess }: LocalesProps) {
 				}
 
 				// Resolve with the Form
-				resolve(data);
-
-			}, (error: responseErrorStruct) => {
-				if(error.code === errors.body.DATA_FIELDS) {
-					reject(error.msg);
-				} else {
-					if(onError) {
-						onError(error);
-					} else {
-						throw new Error(JSON.stringify(error));
-					}
-				}
+				resolve(res.data);
 			});
 		});
 	}
@@ -262,6 +277,6 @@ export default function Locales({ onError, onSuccess }: LocalesProps) {
 
 // Valid props
 Locales.propTypes = {
-	onError: PropTypes.func.isRequired,
-	onSuccess: PropTypes.func.isRequired
+	onError: PropTypes.func,
+	onSuccess: PropTypes.func
 }

package/src/components/pages/Templates/Create.tsx

@@ -30,12 +30,12 @@ import Variables from './Template/Variables';
 const oNameNode = new Node(TemplateDef.name);
 
 // Types
-import { responseErrorStruct } from '@ouroboros/body';
+import { responseErrorStruct, responseStruct } from '@ouroboros/body';
 import { templateStruct } from './Template';
 export interface CreateProps {
 	onCancel?: () => void,
 	onCreated: (template: templateStruct) => void,
-	onError: (error: responseErrorStruct) => void
+	onError?: (error: responseErrorStruct) => void
 }
 
 /**
@@ -53,7 +53,7 @@ export default function Create({ onCancel, onCreated, onError }: CreateProps) {
 	// State
 	const [ record, recordSet ] = useState<templateStruct>({
 		name: '',
-		variables: {}
+		variables: { }
 	});
 
 	// Refs
@@ -72,24 +72,28 @@ export default function Create({ onCancel, onCreated, onError }: CreateProps) {
 	function create() {
 
 		// Create the data in the system
-		mouth.create('template', record).then((data: string) => {
+		mouth.create('template', record).then((res: responseStruct) => {
+
+			// If we failed
+			if(res.error) {
+				if(res.error.code === errors.body.DB_DUPLICATE) {
+					refName.current?.error('Duplicate');
+				} else {
+					if(onError) {
+						onError(res.error);
+						return;
+					} else {
+						throw new Error(JSON.stringify(res.error));
+					}
+				}
+			}
 
 			// Add the ID to the record
-			record._id = data;
+			record._id = res.data;
 
 			// Let the parent know
 			onCreated({ ...record });
-		}, (error: responseErrorStruct) => {
-			if(error.code === errors.body.DB_DUPLICATE) {
-				refName.current?.error('Duplicate');
-			} else {
-				if(onError) {
-					onError(error);
-				} else {
-					throw new Error(JSON.stringify(error));
-				}
-			}
-		})
+		});
 	}
 
 	// Render
@@ -132,5 +136,5 @@ export default function Create({ onCancel, onCreated, onError }: CreateProps) {
 Create.propTypes = {
 	onCancel: PropTypes.func,
 	onCreated: PropTypes.func.isRequired,
-	onError: PropTypes.func.isRequired,
+	onError: PropTypes.func,
 }

package/src/components/pages/Templates/Template/Content/Create/index.tsx

@@ -32,11 +32,11 @@ import SMS from './SMS';
 
 // Types
 import { contentStruct, typeOption } from '../../';
-import { responseErrorStruct } from '@ouroboros/body';
+import { responseErrorStruct, responseStruct } from '@ouroboros/body';
 export type TemplateContentCreateProps = {
 	locales: Record<string, string>,
 	onCreated: (content: contentStruct) => void,
-	onError: (error: responseErrorStruct) => void,
+	onError?: (error: responseErrorStruct) => void,
 	template: string
 }
 
@@ -55,58 +55,66 @@ export default function Create(
 ) {
 
 	// State
-	const [fieldErrors, fieldErrorsSet] = useState<Record<string, any>>({});
-	const [preview, previewSet] = useState(false);
-	const [record, recordSet] = useState<Omit<contentStruct, 'type'>>({
+	const [ fieldErrors, fieldErrorsSet ] = useState<Record<string, any>>({});
+	const [ preview, previewSet ] = useState(false);
+	const [ record, recordSet ] = useState<Omit<contentStruct, 'type'>>({
 		locale: Object.keys(locales)[0],
 		template,
 		subject: '',
 		text: '',
 		html: ''
 	})
-	const [type, typeSet] = useState<typeOption>('email');
+	const [ type, typeSet ] = useState<typeOption>('email');
 
 	// Called to create the new content record
 	function create() {
 
 		// Send the record data to the server
-		mouth.create(`template/${type}`, record).then((data: string) => {
+		mouth.create(`template/${type}`, record).then((res: responseStruct) => {
+
+			// If we failed
+			if(res.error) {
+				if(res.error.code === errors.body.DATA_FIELDS) {
+					fieldErrorsSet(errorTree(res.error.msg));
+				} else if(res.error.code === errors.body.DB_DUPLICATE) {
+					fieldErrorsSet({ locale: 'Already used' });
+				} else if(res.error.code === errors.TEMPLATE_CONTENT_ERROR) {
+					const oLines: { templates: string[], variables: string[] } = { templates: [], variables: [] };
+					for(const l of res.error.msg) {
+						if(l[0] === 'template') {
+							oLines.templates.push(l[1]);
+						} else if(l[0] === 'variable') {
+							oLines.variables.push(l[1]);
+						}
+					}
+					const lLines = [];
+					if(oLines.templates.length) {
+						lLines.push('The following templates are invalid: ' + oLines.templates.join(', '));
+					}
+					if(oLines.variables.length) {
+						lLines.push('The following variables are invalid: ' + oLines.variables.join(', '));
+					}
+
+					// Show the errors
+					if(onError) {
+						onError({ code: 0, msg: lLines.join('\n') });
+					} else {
+						throw new Error(JSON.stringify(res.error));
+					}
+				} else if(onError) {
+					onError(res.error);
+				} else {
+					throw new Error(JSON.stringify(res.error));
+				}
+				return;
+			}
 
 			// Add the type and ID
-			const oRecord = { ...record, type, _id: data }
+			const oRecord = { ...record, type, _id: res.data }
 
 			// Tell the parent about the new record
 			onCreated(oRecord);
 
-		}, (error: responseErrorStruct) => {
-			if(error.code === errors.body.DATA_FIELDS) {
-				fieldErrorsSet(errorTree(error.msg));
-			} else if(error.code === errors.body.DB_DUPLICATE) {
-				fieldErrorsSet({ locale: 'Already used' });
-			} else if(error.code === errors.TEMPLATE_CONTENT_ERROR) {
-				const oLines: { templates: string[], variables: string[] } = { templates: [], variables: [] };
-				for(const l of error.msg) {
-					if(l[0] === 'template') {
-						oLines.templates.push(l[1]);
-					} else if(l[0] === 'variable') {
-						oLines.variables.push(l[1]);
-					}
-				}
-				const lLines = [];
-				if(oLines.templates.length) {
-					lLines.push('The following templates are invalid: ' + oLines.templates.join(', '));
-				}
-				if(oLines.variables.length) {
-					lLines.push('The following variables are invalid: ' + oLines.variables.join(', '));
-				}
-
-				// Show the errors
-				if(onError) {
-					onError({ code: 0, msg: lLines.join('\n') });
-				}
-			} else {
-				onError(error);
-			}
 		});
 	}
 
@@ -227,8 +235,10 @@ export default function Create(
 						onError={(error: responseErrorStruct) => {
 							if(error.code === errors.body.DATA_FIELDS) {
 								fieldErrorsSet(errorTree(error.msg));
-							} else {
+							} else if(onError) {
 								onError(error);
+							} else {
+								throw new Error(JSON.stringify(error));
 							}
 							previewSet(false);
 						}}

package/src/components/pages/Templates/Template/Content/Preview/index.tsx

@@ -27,10 +27,10 @@ import SMS from './SMS';
 
 // Types
 import { contentStruct } from '../..';
-import { responseErrorStruct } from '@ouroboros/body';
+import { responseErrorStruct, responseStruct } from '@ouroboros/body';
 export type PreviewProps = {
 	onClose: () => void,
-	onError: (error: responseErrorStruct) => void,
+	onError?: (error: responseErrorStruct) => void,
 	value: contentStruct
 }
 
@@ -54,8 +54,23 @@ export default function Preview({ onClose, onError, value }: PreviewProps) {
 		mouth.create(
 			`template/${value.type}/generate`,
 			value
-		).then(previewSet, onError);
-	}, [value, onError]);
+		).then((res: responseStruct) => {
+
+			// If we failed
+			if(res.error) {
+				if(onError) {
+					onError(res.error);
+					return;
+				} else {
+					throw new Error(JSON.stringify(res.error));
+				}
+			}
+
+			// Set the preview
+			previewSet(res.data);
+
+		})
+	}, [ value, onError ]);
 
 	// Render
 	return (
@@ -91,7 +106,7 @@ export default function Preview({ onClose, onError, value }: PreviewProps) {
 // Valid props
 Preview.propTypes = {
 	onClose: PropTypes.func.isRequired,
-	onError: PropTypes.func.isRequired,
+	onError: PropTypes.func,
 	value: PropTypes.shape({
 		locale: PropTypes.string.isRequired,
 		template: PropTypes.string,