@iebh/tera-fy 1.0.23 → 1.1.0

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [1.1.0](https://github.com/IEBH/TERA-fy/compare/v1.0.24...v1.1.0) (2024-04-09)
+
+
+### Features
+
+* File saving UI ([b2f8809](https://github.com/IEBH/TERA-fy/commit/b2f8809a960880b951072127d7492b31aa29b03a))
+
+
+### Bug Fixes
+
+* Yet more files added to prerelease step ([399c6f8](https://github.com/IEBH/TERA-fy/commit/399c6f8d6c5080238c079c12b16add7eebeb1d7e))
+
+## [1.0.24](https://github.com/IEBH/TERA-fy/compare/v1.0.23...v1.0.24) (2024-04-05)
+
+
+### Bug Fixes
+
+* Yet another fix for setProjectState() throwing when trying to save + remove defunct {sync:Boolean} option ([4e320ec](https://github.com/IEBH/TERA-fy/commit/4e320ec8f171237387db7404a7209b4ca51898c8))
+
 ## [1.0.23](https://github.com/IEBH/TERA-fy/compare/v1.0.22...v1.0.23) (2024-04-04)
 
 ## <small>1.0.22 (2024-04-04)</small>

package/api.md

@@ -646,9 +646,8 @@ Paths can be any valid Lodash.set() value such as:
 *   `options` **[Object][120]?** Additional options to mutate behaviour
 
     *   `options.save` **[Boolean][127]** Save the changes to the server immediately, disable to queue up multiple writes (optional, default `true`)
-    *   `options.sync` **[Boolean][127]** Wait for the server to acknowledge the write, you almost never need to do this (optional, default `false`)
 
-Returns **[Promise][126]** A promise which resolves when the operation has synced with the server
+Returns **[Promise][126]** A promise which resolves when the operation has been dispatched to the server
 
 ## setProjectStateDefaults
 
@@ -722,6 +721,7 @@ Prompt the user to select a library to operate on
 
     *   `options.title` **[String][119]** The title of the dialog to display (optional, default `"Select a file"`)
     *   `options.hint` **([String][119] | [Array][125]<[String][119]>)?** Hints to identify the file to select in array order of preference
+    *   `options.save` **[Boolean][127]** Set to truthy if saving a new file, UI will adjust to allowing overwrite OR new file name input (optional, default `false`)
     *   `options.filters` **[FileFilters][99]?** Optional file filters
     *   `options.allowUpload` **[Boolean][127]** Allow uploading new files (optional, default `true`)
     *   `options.allowRefresh` **[Boolean][127]** Allow the user to manually refresh the file list (optional, default `true`)

package/lib/terafy.client.js

@@ -780,9 +780,8 @@ export default class TeraFy {
 	*
 	* @param {Object} [options] Additional options to mutate behaviour
 	* @param {Boolean} [options.save=true] Save the changes to the server immediately, disable to queue up multiple writes
-	* @param {Boolean} [options.sync=false] Wait for the server to acknowledge the write, you almost never need to do this
 	*
-	* @returns {Promise} A promise which resolves when the operation has synced with the server
+	* @returns {Promise} A promise which resolves when the operation has been dispatched to the server
 	*/
 
 
@@ -855,6 +854,7 @@ export default class TeraFy {
 	* @param {Object} [options] Additional options to mutate behaviour
 	* @param {String} [options.title="Select a file"] The title of the dialog to display
 	* @param {String|Array<String>} [options.hint] Hints to identify the file to select in array order of preference
+	* @param {Boolean} [options.save=false] Set to truthy if saving a new file, UI will adjust to allowing overwrite OR new file name input
 	* @param {FileFilters} [options.filters] Optional file filters
 	* @param {Boolean} [options.allowUpload=true] Allow uploading new files
 	* @param {Boolean} [options.allowRefresh=true] Allow the user to manually refresh the file list

package/lib/terafy.server.js

@@ -718,14 +718,12 @@ export default class TeraFyServer {
 	*
 	* @param {Object} [options] Additional options to mutate behaviour
 	* @param {Boolean} [options.save=true] Save the changes to the server immediately, disable to queue up multiple writes
-	* @param {Boolean} [options.sync=false] Wait for the server to acknowledge the write, you almost never need to do this
 	*
-	* @returns {Promise} A promise which resolves when the operation has synced with the server
+	* @returns {Promise} A promise which resolves when the operation has been dispatched to the server
 	*/
 	setProjectState(path, value, options) {
 		let settings = {
 			save: true,
-			sync: false,
 			...options,
 		};
 
@@ -734,11 +732,8 @@ export default class TeraFyServer {
 
 		this._pathSet(app.service('$projects').active, path, value);
 
-		return (
-			settings.save && settings.sync ? this.saveProjectState()
-			: settings.save ? Promise.resolve(void this.saveProjectState())
-			: (()=> { throw new Error('setProjectState({sync: true, save: false}) makes no sense') })()
-		);
+		return Promise.resolve()
+			.then(()=> settings.save && this.saveProjectState())
 	}
 
 
@@ -891,6 +886,8 @@ export default class TeraFyServer {
 	* @param {Object} [options] Additional options to mutate behaviour
 	* @param {String} [options.title="Select a file"] The title of the dialog to display
 	* @param {String|Array<String>} [options.hint] Hints to identify the file to select in array order of preference
+	* @param {Boolean} [options.save=false] Set to truthy if saving a new file, UI will adjust to allowing overwrite OR new file name input
+	* @param {String} [options.saveFilename] File name to save as, if omitted the hinting system is used otherwise 'My File.unknown' is assumed
 	* @param {FileFilters} [options.filters] Optional file filters
 	* @param {Boolean} [options.allowUpload=true] Allow uploading new files
 	* @param {Boolean} [options.allowRefresh=true] Allow the user to manually refresh the file list
@@ -905,6 +902,8 @@ export default class TeraFyServer {
 		let settings = {
 			title: 'Select a file',
 			hint: null,
+			save: false,
+			saveFilename: null,
 			filters: {},
 			allowUpload: true,
 			allowRefresh: true,
@@ -919,9 +918,10 @@ export default class TeraFyServer {
 			.then(files => this.requestFocus(()=>
 				app.service('$prompt').dialog({
 					title: settings.title,
-					component: 'filesSelect',
+					component: settings.save ? 'filesSave' : 'filesOpen',
 					componentProps: {
 						hint: settings.hint,
+						saveFilename: settings.saveFilename,
 						allowNavigate: false,
 						allowUpload: settings.allowUpload,
 						allowRefresh: settings.allowRefresh,
@@ -931,6 +931,9 @@ export default class TeraFyServer {
 						filters: settings.filters,
 					},
 					componentEvents: {
+						fileSave(filePath) {
+							app.service('$prompt').close(true, filePath);
+						},
 						fileSelect(file) {
 							app.service('$prompt').close(true, file);
 						},

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iebh/tera-fy",
-  "version": "1.0.23",
+  "version": "1.1.0",
   "description": "TERA website worker",
   "scripts": {
     "dev": "esbuild --platform=browser --format=esm --bundle lib/terafy.client.js --outfile=dist/terafy.js --minify --serve --servedir=.",
@@ -86,7 +86,8 @@
   },
   "commit-and-tag-version": {
     "scripts": {
-      "prerelease": "npm run build && git add docs dist"
+      "prerelease": "npm run build && git add api.md docs dist",
+      "postcommit": "npm publish"
     }
   },
   "eslintConfig": {