@iebh/tera-fy 1.13.0 → 1.13.1

package/CHANGELOG.md

@@ -1,5 +1,7 @@
 # Changelog
 
+## [1.13.1](https://github.com/IEBH/TERA-fy/compare/v1.13.0...v1.13.1) (2024-07-10)
+
 # [1.13.0](https://github.com/IEBH/TERA-fy/compare/v1.12.0...v1.13.0) (2024-07-09)
 
 

package/api.md

@@ -997,11 +997,13 @@ Display simple text within TERA
 
 ### Parameters
 
-*   `text` **[String][150]** The text to display
+*   `text` **[String][150]?** Text to display, if specified this populates `options.body`
 *   `options` **[Object][151]?** Additional options to mutate behaviour
 
-    *   `options.title` **[String][150]** The title of the alert box (optional, default `'TERA'`)
+    *   `options.body` **[String][150]** The body text to display (optional, default `"Alert!"`)
     *   `options.isHtml` **[Boolean][159]** If falsy the text is rendered as plain-text otherwise it will be assumed as HTML content (optional, default `false`)
+    *   `options.title` **[String][150]** The title of the alert box (optional, default `'TERA'`)
+    *   `options.buttons` **(`"ok"` | `false`)** Button set to use or falsy to disable (optional, default `'ok'`)
 
 Returns **[Promise][157]** A promise which resolves when the alert has been dismissed
 
@@ -1011,11 +1013,12 @@ Present a simple ok/cancel dialog to the user
 
 ### Parameters
 
-*   `text` **[String][150]** The text to display
+*   `text` **[String][150]?** Text to display, if specified this populates `options.body`
 *   `options` **[Object][151]?** Additional options to mutate behaviour
 
-    *   `options.title` **[String][150]** The title of the confirmation box (optional, default `'TERA'`)
+    *   `options.body` **[String][150]** The body text to display (optional, default `"Confirm?"`)
     *   `options.isHtml` **[Boolean][159]** If falsy the text is rendered as plain-text otherwise it will be assumed as HTML content (optional, default `false`)
+    *   `options.title` **[String][150]** The title of the confirmation box (optional, default `'TERA'`)
 
 Returns **[Promise][157]** A promise which resolves with `Promise.resolve('OK')` or rejects with `Promise.reject('CANCEL')`
 
@@ -1044,13 +1047,15 @@ Prompt the user for an input, responding with a Promisable value
 
 ### Parameters
 
+*   `text` **[String][150]?** Text to display, if specified this populates `options.body`
 *   `options` **[Object][151]?** Additional options to mutate behaviour
 
+    *   `options.body` **[String][150]?** Optional additional body text
     *   `options.value` **[String][150]?** Current or default value to display pre-filled
     *   `options.title` **[String][150]** The dialog title to display (optional, default `'Input required'`)
-    *   `options.body` **[String][150]?** Optional additional body text
     *   `options.bodyHtml` **[Boolean][159]** If truthy, treat the body as HTML (optional, default `false`)
     *   `options.placeholder` **[String][150]?** Optional placeholder text
+    *   `options.required` **[Boolean][159]** Treat nullish or empty inputs as a cancel operation (optional, default `true`)
 
 Returns **[Promise][157]\<any>** Either the eventual user value or a throw with `Promise.reject('CANCEL')`
 

package/lib/terafy.client.js

@@ -1297,11 +1297,13 @@ export default class TeraFy {
 	* Display simple text within TERA
 	*
 	* @function uiAlert
-	* @param {String} text The text to display
+	* @param {String} [text] Text to display, if specified this populates `options.body`
 	*
 	* @param {Object} [options] Additional options to mutate behaviour
-	* @param {String} [options.title='TERA'] The title of the alert box
+	* @param {String} [options.body="Alert!"] The body text to display
 	* @param {Boolean} [options.isHtml=false] If falsy the text is rendered as plain-text otherwise it will be assumed as HTML content
+	* @param {String} [options.title='TERA'] The title of the alert box
+	* @param {'ok'|false} [options.buttons='ok'] Button set to use or falsy to disable
 	*
 	* @returns {Promise} A promise which resolves when the alert has been dismissed
 	*/
@@ -1311,11 +1313,12 @@ export default class TeraFy {
 	* Present a simple ok/cancel dialog to the user
 	*
 	* @function uiConfirm
-	* @param {String} text The text to display
+	* @param {String} [text] Text to display, if specified this populates `options.body`
 	*
 	* @param {Object} [options] Additional options to mutate behaviour
-	* @param {String} [options.title='TERA'] The title of the confirmation box
+	* @param {String} [options.body="Confirm?"] The body text to display
 	* @param {Boolean} [options.isHtml=false] If falsy the text is rendered as plain-text otherwise it will be assumed as HTML content
+	* @param {String} [options.title='TERA'] The title of the confirmation box
 	*
 	* @returns {Promise} A promise which resolves with `Promise.resolve('OK')` or rejects with `Promise.reject('CANCEL')`
 	*/
@@ -1343,12 +1346,15 @@ export default class TeraFy {
 	* Prompt the user for an input, responding with a Promisable value
 	*
 	* @function uiPrompt
+	* @param {String} [text] Text to display, if specified this populates `options.body`
+	*
 	* @param {Object} [options] Additional options to mutate behaviour
+	* @param {String} [options.body] Optional additional body text
 	* @param {String} [options.value] Current or default value to display pre-filled
 	* @param {String} [options.title='Input required'] The dialog title to display
-	* @param {String} [options.body] Optional additional body text
 	* @param {Boolean} [options.bodyHtml=false] If truthy, treat the body as HTML
 	* @param {String} [options.placeholder] Optional placeholder text
+	* @param {Boolean} [options.required=true] Treat nullish or empty inputs as a cancel operation
 	*
 	* @returns {Promise<*>} Either the eventual user value or a throw with `Promise.reject('CANCEL')`
 	*/

package/lib/terafy.server.js

@@ -1431,27 +1431,33 @@ export default class TeraFyServer {
 	/**
 	* Display simple text within TERA
 	*
-	* @param {String} text The text to display
+	* @param {String} [text] Text to display, if specified this populates `options.body`
 	*
 	* @param {Object} [options] Additional options to mutate behaviour
-	* @param {String} [options.title='TERA'] The title of the alert box
+	* @param {String} [options.body="Alert!"] The body text to display
 	* @param {Boolean} [options.isHtml=false] If falsy the text is rendered as plain-text otherwise it will be assumed as HTML content
+	* @param {String} [options.title='TERA'] The title of the alert box
 	* @param {'ok'|false} [options.buttons='ok'] Button set to use or falsy to disable
 	*
 	* @returns {Promise} A promise which resolves when the alert has been dismissed
 	*/
 	uiAlert(text, options) {
 		let settings = {
-			title: 'TERA',
+			body: 'Alert!',
 			isHtml: false,
+			title: 'TERA',
 			buttons: 'ok',
-			...options,
+			...(
+				typeof text == 'string' ? {body: text, ...options}
+				: typeof text == 'object' ? text
+				: options
+			),
 		};
 
 		return this.requestFocus(()=>
 			app.service('$prompt').dialog({
 				title: settings.title,
-				body: text,
+				body: settings.body,
 				buttons:
 					settings.buttons == 'ok' ? ['ok']
 					: false,
@@ -1465,19 +1471,25 @@ export default class TeraFyServer {
 	/**
 	* Present a simple ok/cancel dialog to the user
 	*
-	* @param {String} text The text to display
+	* @param {String} [text] Text to display, if specified this populates `options.body`
 	*
 	* @param {Object} [options] Additional options to mutate behaviour
-	* @param {String} [options.title='TERA'] The title of the confirmation box
+	* @param {String} [options.body="Confirm?"] The body text to display
 	* @param {Boolean} [options.isHtml=false] If falsy the text is rendered as plain-text otherwise it will be assumed as HTML content
+	* @param {String} [options.title='TERA'] The title of the confirmation box
 	*
 	* @returns {Promise} A promise which resolves with `Promise.resolve('OK')` or rejects with `Promise.reject('CANCEL')`
 	*/
 	uiConfirm(text, options) {
 		let settings = {
-			title: 'TERA',
+			body: 'Confirm?',
 			isHtml: false,
-			...options,
+			title: 'TERA',
+			...(
+				typeof text == 'string' ? {body: text, ...options}
+				: typeof text == 'object' ? text
+				: options
+			),
 		};
 
 		return this.requestFocus(()=>
@@ -1509,9 +1521,9 @@ export default class TeraFyServer {
 	* All options are cumulative - i.e. they are merged with other options previously provided
 	*
 	* @param {Object|Boolean} [options] Additional options to mutate behaviour, if boolean false `{close: true}` is assumed
-	* @param {String} [options.title='TERA'] Window title, can only be set on the initial call
 	* @param {String} [options.body=''] Window body text
 	* @param {Boolean} [options.bodyHtml=false] If truthy, treat the body as HTML
+	* @param {String} [options.title='TERA'] Window title, can only be set on the initial call
 	* @param {Boolean} [options.close=false] Close the existing dialog, if true the dialog is disposed and options reset
 	* @param {Number} [options.progress] The current progress of the task being conducted, this is assumed to be a value less than `progressMax`
 	* @param {Number} [options.progressMax] The maximum value that the progress can be
@@ -1523,9 +1535,9 @@ export default class TeraFyServer {
 
 		if (this.uiProgressOptions === null) { // New uiProgress window
 			this.uiProgressOptions = reactive({
-				title: 'TERA',
 				body: '',
 				bodyHtml: false,
+				title: 'TERA',
 				close: false,
 				progress: 0,
 				progressMax: 0,
@@ -1562,23 +1574,31 @@ export default class TeraFyServer {
 	/**
 	* Prompt the user for an input, responding with a Promisable value
 	*
+	* @param {String} [text] Text to display, if specified this populates `options.body`
+	*
 	* @param {Object} [options] Additional options to mutate behaviour
+	* @param {String} [options.body] Optional additional body text
 	* @param {String} [options.value] Current or default value to display pre-filled
 	* @param {String} [options.title='Input required'] The dialog title to display
-	* @param {String} [options.body] Optional additional body text
 	* @param {Boolean} [options.bodyHtml=false] If truthy, treat the body as HTML
 	* @param {String} [options.placeholder] Optional placeholder text
+	* @param {Boolean} [options.required=true] Treat nullish or empty inputs as a cancel operation
 	*
 	* @returns {Promise<*>} Either the eventual user value or a throw with `Promise.reject('CANCEL')`
 	*/
-	uiPrompt(options) {
+	uiPrompt(text, options) {
 		let settings = {
-			title: 'Input required',
-			value: '',
 			body: '',
 			bodyHtml: false,
+			title: 'Input required',
+			value: '',
 			placeholder: '',
-			...options,
+			required: true,
+			...(
+				typeof text == 'string' ? {body: text, ...options}
+				: typeof text == 'object' ? text
+				: options
+			),
 		};
 
 		return this.requestFocus(()=>
@@ -1595,7 +1615,16 @@ export default class TeraFyServer {
 				buttons: ['ok', 'cancel'],
 			})
 		)
-			.then(answer => answer || Promise.reject('CANCEL'))
+			.then(answer => {
+				if (answer) {
+					return answer;
+				} else if (settings.required) {
+					return Promise.reject('CANCEL');
+				} else {
+					return answer;
+				}
+			})
+			.catch(()=> Promise.reject('CANCEL'))
 	}
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iebh/tera-fy",
-  "version": "1.13.0",
+  "version": "1.13.1",
   "description": "TERA website worker",
   "scripts": {
     "dev": "esbuild --platform=browser --format=esm --bundle lib/terafy.client.js --outfile=dist/terafy.js --minify --serve --servedir=.",