@iebh/tera-fy 1.0.24 → 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iebh/tera-fy",
-  "version": "1.0.24",
+  "version": "1.2.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,7 @@
   },
   "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"
     }
   },

package/widgets/tera-file-select.vue

@@ -4,22 +4,27 @@
 * Most of the options are copied from the $teraFy.selectProjectFile() API call that this component wraps
 * @see https://github.com/IEBH/TERA-fy
 *
-* @param {String} [title="Select a citation library"] The title of the file selection display
-* @param {String|Array<String>} [hint] Hints to identify the library to select in array order of preference. Generally corresponds to the previous stage
-* @param {Boolean} [allowUpload=true] Allow uploading new files
-* @param {Boolean} [allowRefresh=true] Allow the user to manually refresh the file list
-* @param {Boolean} [allowDownloadZip=true] Allow the user to download a Zip of all files
-* @param {Boolean} [allowCancel=true] Allow cancelling the operation. Will throw `'CANCEL'` as the promise rejection if acationed
-* @param {Boolean} [autoRequire=true] Run `requireProject()` automatically before continuing
-* @param {FileFilters} [filters] Optional file filters, defaults to citation library selection only
-* @param {String} [placeholder="Select a file..."] Placeholder text to show when no file is selected
+* @prop {Boolean} [save=false] Prompt for either a new filename or overwriting an existing file, if false only show files to open
+* @prop {String} [saveFilename] Optional suggested filename when saving
 *
-* @fires change Fired as `(file:ProjectFile)` when the contents changes
+* @prop {String} [title="Select a citation library"] The title of the file selection display
+* @prop {String|Array<String>} [hint] Hints to identify the library to select in array order of preference. Generally corresponds to the previous stage
+* @prop {Boolean} [allowUpload=true] Allow uploading new files
+* @prop {Boolean} [allowRefresh=true] Allow the user to manually refresh the file list
+* @prop {Boolean} [allowDownloadZip=true] Allow the user to download a Zip of all files
+* @prop {Boolean} [allowCancel=true] Allow cancelling the operation. Will throw `'CANCEL'` as the promise rejection if acationed
+* @prop {Boolean} [autoRequire=true] Run `requireProject()` automatically before continuing
+* @prop {FileFilters} [filters] Optional file filters, defaults to citation library selection only
+*
+* @prop {String} [placeholder="Select a file..."] Placeholder text to show when no file is selected
+*
+* @emits change Fired as `(file:ProjectFile)` when the contents changes
 *
 * @slot selected Slot to show when a file is selected. Contains the bindings `({selected})`
 * @slot deselected Slot to show when no file is selected. Contains the bindings `({})`
 */
 export default {
+	emits: ['change'],
 	data() { return {
 		/**
 		* The currently selected library, if any
@@ -29,6 +34,8 @@ export default {
 	}},
 	props: {
 		// Props passed to $teraFy.selectProjectFile()
+		save: {type: Boolean, default: false},
+		saveFilename: {type: String},
 		title: {type: String, default: 'Select a citation library'},
 		hint: {type: [String, Array]},
 		allowUpload: {type: Boolean, default: true},
@@ -53,6 +60,8 @@ export default {
 		*/
 		async choose() {
 			this.selected = await this.$tera.selectProjectFile({
+				save: this.save,
+				saveFiename: this.saveFilename,
 				title: this.title,
 				hint: this.hint,
 				allowUpload: this.allowUpload,