@iebh/tera-fy 1.0.13 → 1.0.15

package/lib/terafy.client.js

@@ -77,7 +77,7 @@ export default class TeraFy {
 		'handshake',
 
 		// Session
-		'getUser',
+		'getUser', 'requireUser',
 
 		// Projects
 		'bindProject', 'getProject', 'getProjects', 'setActiveProject', 'requireProject', 'selectProject',
@@ -91,6 +91,9 @@ export default class TeraFy {
 
 		// Project Libraries
 		'getProjectLibrary', 'setProjectLibrary',
+
+		// UI
+		'uiAlert',
 	];
 
 
@@ -615,6 +618,25 @@ export default class TeraFy {
 	*/
 
 
+	/**
+	* Require a user login to TERA
+	* If there is no user OR they are not logged in a prompt is shown to go and do so
+	* This is an pre-requisite step for requireProject()
+	*
+	* @function requireUser
+	* @returns {Promise} A promise which will resolve if the there is a user and they are logged in
+	*/
+
+
+	/**
+	* Require a user login to TERA
+	* If there is no user OR they are not logged in a prompt is shown to go and do so
+	* This is an pre-requisite step for requireProject()
+	*
+	* @returns {Promise} A promise which will resolve if the there is a user and they are logged in
+	*/
+
+
 	/**
 	* Project entry within TERA
 	*
@@ -817,5 +839,20 @@ export default class TeraFy {
 	*
 	* @returns {Promise} A promise which resolves when the save operation has completed
 	*/
+
+
+	/**
+	* Display simple text within TERA
+	*
+	* @function uiAlert
+	* @param {String} text The text to display
+	*
+	* @param {Object} [options] Additional options to mutate behaviour
+	* @param {String} [options.title='TERA'] The title of the alert box
+	* @param {Boolean} [options.isHtml=false] If falsy the text is rendered as plain-text otherwise it will be assumed as HTML content
+	*
+	* @returns {Promise} A promise which resolves when the alert has been dismissed
+	*/
+
 	// }}}
 }

package/lib/terafy.server.js

@@ -33,6 +33,7 @@ export default class TeraFyServer {
 	static SERVERMODE_NONE = 0;
 	static SERVERMODE_EMBEDDED = 1;
 	static SERVERMODE_WINDOW = 2;
+	static SERVERMODE_TERA = 3; // Terafy is running as the main TERA site
 
 
 	// Contexts - createContext(), getClientContext(), messageEvent, senderRpc() {{{
@@ -105,7 +106,7 @@ export default class TeraFyServer {
 								TERA: 1,
 								...cloneDeep(message), // Need to clone to resolve promise nasties
 							};
-							iFrame.postMessage(payload, this.settings.restrictOrigin);
+							iFrame.contentWindow.postMessage(payload, this.settings.restrictOrigin);
 						} catch (e) {
 							this.debug('ERROR', 'Attempted to dispatch payload server(top level window)->cient(iframe)', {payload, e});
 							throw e;
@@ -290,9 +291,9 @@ export default class TeraFyServer {
 	*/
 	requestFocus(cb) {
 		return Promise.resolve()
-			.then(()=> this.senderRpc('toggleFocus', true))
+			.then(()=> this.settings.serverMode != TeraFyServer.SERVERMODE_TERA && this.senderRpc('toggleFocus', true))
 			.then(()=> cb.call(this))
-			.finally(()=> this.senderRpc('toggleFocus', false))
+			.finally(()=> this.settings.serverMode != TeraFyServer.SERVERMODE_TERA && this.senderRpc('toggleFocus', false))
 	}
 
 
@@ -314,7 +315,7 @@ export default class TeraFyServer {
 	}
 	// }}}
 
-	// Session / User - getUser() {{{
+	// Session / User - getUser(), requireUser() {{{
 
 	/**
 	* User / active session within TERA
@@ -349,6 +350,22 @@ export default class TeraFyServer {
 			} : null)
 	}
 
+
+	/**
+	* Require a user login to TERA
+	* If there is no user OR they are not logged in a prompt is shown to go and do so
+	* This is an pre-requisite step for requireProject()
+	*
+	* @returns {Promise} A promise which will resolve if the there is a user and they are logged in
+	*/
+	requireUser() {
+		return this.getUser()
+			.then(user => user || this.uiAlert('You must be logged in to <a href="https://tera-tools.com" target="_blank">TERA-tools.com</a> to use this tool', {
+				title: 'TERA-tools account needed',
+				isHtml: true,
+			}))
+	}
+
 	// }}}
 
 	// Projects - getProject(), getProjects(), requireProject(), selectProject() {{{
@@ -417,6 +434,7 @@ export default class TeraFyServer {
 	* Note that this function will percist in asking the uesr even if they try to cancel
 	*
 	* @param {Object} [options] Additional options to mutate behaviour
+	* @param {Boolean} [options.autoRequireUser=true] Automatically call `requireUser()` before trying to fetch a list of projects
 	* @param {Boolean} [options.autoSetActiveProject=true] After selecting a project set that project as active in TERA
 	* @param {String} [options.title="Select a project to work with"] The title of the dialog to display
 	* @param {String} [options.noSelectTitle='Select project'] Dialog title when warning the user they need to select something
@@ -426,6 +444,7 @@ export default class TeraFyServer {
 	*/
 	requireProject(options) {
 		let settings = {
+			autoRequireUser: true,
 			autoSetActiveProject: true,
 			title: 'Select a project to work with',
 			noSelectTitle: 'Select project',
@@ -433,7 +452,9 @@ export default class TeraFyServer {
 			...options,
 		};
 
-		return this.getProject()
+		return Promise.resolve()
+			.then(()=> settings.autoRequireUser && this.requireUser())
+			.then(()=> this.getProject())
 			.then(active => {
 				if (active) return active; // Use active project
 
@@ -772,6 +793,37 @@ export default class TeraFyServer {
 	}
 	// }}}
 
+	// UI - uiAlert() {{{
+	/**
+	* Display simple text within TERA
+	*
+	* @param {String} text The text to display
+	*
+	* @param {Object} [options] Additional options to mutate behaviour
+	* @param {String} [options.title='TERA'] The title of the alert box
+	* @param {Boolean} [options.isHtml=false] If falsy the text is rendered as plain-text otherwise it will be assumed as HTML content
+	*
+	* @returns {Promise} A promise which resolves when the alert has been dismissed
+	*/
+	uiAlert(text, options) {
+		let settings = {
+			title: 'TERA',
+			isHtml: false,
+			...options,
+		};
+
+		return this.requestFocus(()=>
+			app.service('$prompt').dialog({
+				title: settings.title,
+				body: text,
+				buttons: ['ok'],
+				isHtml: settings.isHtml,
+				dialogClose: 'resolve',
+			})
+		);
+	}
+	// }}}
+
 	// Utility - debug() {{{
 
 	/**

package/package.json

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