@iebh/tera-fy 1.7.3 → 1.8.0

package/api.md

@@ -30,59 +30,59 @@
     *   [serialize][26]
     *   [deserialize][27]
         *   [Parameters][28]
-*   [tera][29]
-    *   [Parameters][30]
-*   [TeraFy][31]
-    *   [settings][32]
-        *   [Properties][33]
-    *   [events][34]
-    *   [dom][35]
-        *   [Properties][36]
-    *   [methods][37]
-    *   [plugins][38]
-    *   [send][39]
+*   [TeraFy][29]
+    *   [settings][30]
+        *   [Properties][31]
+    *   [events][32]
+    *   [dom][33]
+        *   [Properties][34]
+    *   [methods][35]
+    *   [plugins][36]
+    *   [send][37]
+        *   [Parameters][38]
+    *   [sendRaw][39]
         *   [Parameters][40]
-    *   [sendRaw][41]
+    *   [rpc][41]
         *   [Parameters][42]
-    *   [rpc][43]
+    *   [acceptMessage][43]
         *   [Parameters][44]
-    *   [acceptMessage][45]
-        *   [Parameters][46]
-    *   [acceptPostboxes][47]
-    *   [createProjectStatePatch][48]
+    *   [acceptPostboxes][45]
+    *   [createProjectStatePatch][46]
+        *   [Parameters][47]
+    *   [applyProjectStatePatchLocal][48]
         *   [Parameters][49]
-    *   [applyProjectStatePatchLocal][50]
+    *   [init][50]
         *   [Parameters][51]
-    *   [init][52]
-        *   [Parameters][53]
-    *   [detectMode][54]
-    *   [injectComms][55]
-    *   [injectStylesheet][56]
-    *   [injectMethods][57]
-    *   [debug][58]
+    *   [detectMode][52]
+    *   [injectComms][53]
+    *   [injectStylesheet][54]
+    *   [injectMethods][55]
+    *   [debug][56]
+        *   [Parameters][57]
+    *   [set][58]
         *   [Parameters][59]
-    *   [set][60]
+    *   [setIfDev][60]
         *   [Parameters][61]
-    *   [setIfDev][62]
+    *   [use][62]
         *   [Parameters][63]
-    *   [use][64]
+    *   [mixin][64]
         *   [Parameters][65]
-    *   [mixin][66]
+    *   [toggleDevMode][66]
         *   [Parameters][67]
-    *   [toggleDevMode][68]
+    *   [toggleFocus][68]
         *   [Parameters][69]
-    *   [toggleFocus][70]
+    *   [selectProjectFile][70]
         *   [Parameters][71]
-    *   [selectProjectFile][72]
+    *   [getProjectFiles][72]
         *   [Parameters][73]
-    *   [getProjectFiles][74]
+    *   [getProjectFile][74]
         *   [Parameters][75]
-    *   [getProjectFile][76]
+    *   [createProjectFile][76]
         *   [Parameters][77]
-    *   [createProjectFile][78]
-        *   [Parameters][79]
-*   [handshake][80]
-    *   [Properties][81]
+*   [handshake][78]
+    *   [Properties][79]
+*   [setServerVerbosity][80]
+    *   [Parameters][81]
 *   [User][82]
     *   [Properties][83]
 *   [getUser][84]
@@ -133,10 +133,12 @@
     *   [Parameters][129]
 *   [uiAlert][130]
     *   [Parameters][131]
-*   [uiSplat][132]
+*   [uiProgress][132]
     *   [Parameters][133]
 *   [uiWindow][134]
     *   [Parameters][135]
+*   [uiSplat][136]
+    *   [Parameters][137]
 
 ## ProjectFile
 
@@ -146,113 +148,113 @@ A project file fetched from TERA
 
 A UUID string representing the unique ID of the file
 
-Type: [String][136]
+Type: [String][138]
 
 ### name
 
 Relative name path (can contain prefix directories) for the human readable file name
 
-Type: [String][136]
+Type: [String][138]
 
 ### icon
 
 CSS class to use as the file icon
 
-Type: [String][136]
+Type: [String][138]
 
 ### path
 
 Full path to the file
 This is also used as the unique identifier within the project
 
-Type: [String][136]
+Type: [String][138]
 
 ### url
 
 Fully qualified URL to view / access / download the file from TERA
 This will usually open an edit UI within the TERA site
 
-Type: [String][136]
+Type: [String][138]
 
 ### teraUrl
 
 Rewrite of the URL where the absolute URL has been removed in place of a relative path, assuming the owner project is active
 This is used to direct to the edit/view/download UI when the files project is active and is usually used in place of URL for TERA related operations
 
-Type: [String][136]
+Type: [String][138]
 
 ### parsedName
 
 An object representing meta file parts of a file name
 
-Type: [Object][137]
+Type: [Object][139]
 
 #### Properties
 
-*   `basename` **[String][136]** The filename + extention (i.e. everything without directory name)
-*   `filename` **[String][136]** The file portion of the name (basename without the extension)
-*   `ext` **[String][136]** The extension portion of the name (always lower case)
-*   `dirName` **[String][136]** The directory path portion of the name
+*   `basename` **[String][138]** The filename + extention (i.e. everything without directory name)
+*   `filename` **[String][138]** The file portion of the name (basename without the extension)
+*   `ext` **[String][138]** The extension portion of the name (always lower case)
+*   `dirName` **[String][138]** The directory path portion of the name
 
 ### created
 
 A date representing when the file was created
 
-Type: [Date][138]
+Type: [Date][140]
 
 ### createdFormatted
 
 A human readable, formatted version of "created"
 
-Type: [String][136]
+Type: [String][138]
 
 ### modified
 
 A date representing when the file was created
 
-Type: [Date][138]
+Type: [Date][140]
 
 ### modifiedFormatted
 
 A human readable, formatted version of "modified"
 
-Type: [String][136]
+Type: [String][138]
 
 ### accessed
 
 A date representing when the file was last accessed
 
-Type: [Date][138]
+Type: [Date][140]
 
 ### accessedFormatted
 
 A human readable, formatted version of "accessed"
 
-Type: [String][136]
+Type: [String][138]
 
 ### size
 
 Size, in bytes, of the file
 
-Type: [Number][139]
+Type: [Number][141]
 
 ### sizeFormatted
 
 A human readable, formatted version of the file size
 
-Type: [String][136]
+Type: [String][138]
 
 ### mime
 
 The associated mime type for the file
 
-Type: [String][136]
+Type: [String][138]
 
 ### meta
 
 Additional meta information for the file
 
-Type: [Object][137]
+Type: [Object][139]
 
 ### getContents
 
@@ -270,9 +272,9 @@ Overwrite the contents of a file with new content
 
 #### Parameters
 
-*   `contents` **(File | [Blob][140] | [FormData][141] | [Object][137] | [Array][142])** The new file contents
+*   `contents` **(File | [Blob][142] | [FormData][143] | [Object][139] | [Array][144])** The new file contents
 
-Returns **[Promise][143]** A promise which resolves when the operation has completed
+Returns **[Promise][145]** A promise which resolves when the operation has completed
 
 ### getRefs
 
@@ -280,7 +282,7 @@ Returns **[Promise][143]** A promise which resolves when the operation has compl
 
 Fetch the file contents as an array of Reflib refs
 
-Returns **[Promise][143]<[Array][142]\<Ref>>** An eventual array of RefLib references
+Returns **[Promise][145]<[Array][144]\<Ref>>** An eventual array of RefLib references
 
 ### setRefs
 
@@ -291,18 +293,18 @@ Overwrite the contents of a file with a new collection of Reflib refs
 #### Parameters
 
 *   `refs` &#x20;
-*   `Collection` **[Array][142]\<RefLibRef>** of references for the selected library
+*   `Collection` **[Array][144]\<RefLibRef>** of references for the selected library
 
-Returns **[Promise][143]** A promise which resolves when the operation has completed
+Returns **[Promise][145]** A promise which resolves when the operation has completed
 
 ### serialize
 
-*   **See**: [https://developer.mozilla.org/en-US/docs/Web/API/Web\_Workers\_API/Structured\_clone\_algorithm][144]
+*   **See**: [https://developer.mozilla.org/en-US/docs/Web/API/Web\_Workers\_API/Structured\_clone\_algorithm][146]
 
 Compress a file state down into a serializable entity
 By default this computes a Structured Clone which can be stringified
 
-Returns **[Object][137]** A Structured Clone compatible representation of this ProjectFile instance
+Returns **[Object][139]** A Structured Clone compatible representation of this ProjectFile instance
 
 ### deserialize
 
@@ -310,18 +312,10 @@ Restore an entity created with serialize
 
 #### Parameters
 
-*   `data` **[Object][137]** An input object created via `ProjectFiles.serialize()`
+*   `data` **[Object][139]** An input object created via `ProjectFiles.serialize()`
 
 Returns **[ProjectFile][1]** A ProjectFile instance setup against the deserializzed data
 
-## tera
-
-Parent TeraClient instance used by all helper functions
-
-### Parameters
-
-*   `TeraClient` &#x20;
-
 ## TeraFy
 
 Main Tera-Fy Client (class singleton) to be used in a frontend browser
@@ -330,19 +324,19 @@ Main Tera-Fy Client (class singleton) to be used in a frontend browser
 
 Various settings to configure behaviour
 
-Type: [Object][137]
+Type: [Object][139]
 
 #### Properties
 
-*   `devMode` **[Boolean][145]** Operate in devMode - i.e. force outer refresh when encountering an existing TeraFy instance
-*   `verbosity` **[Number][139]** Verbosity level, the higher the more chatty TeraFY will be. Set to zero to disable all `debug()` call output
+*   `devMode` **[Boolean][147]** Operate in devMode - i.e. force outer refresh when encountering an existing TeraFy instance
+*   `verbosity` **[Number][141]** Verbosity level, the higher the more chatty TeraFY will be. Set to zero to disable all `debug()` call output
 *   `mode` **(`"detect"` | `"parent"` | `"child"` | `"popup"`)** How to communicate with TERA. 'parent' assumes that the parent of the current document is TERA, 'child' spawns an iFrame and uses TERA there, 'detect' tries parent and switches to `modeFallback` if communication fails
-*   `modeFallback` **[String][136]** Method to use when all method detection fails
-*   `modeTimeout` **[Number][139]** How long entities have in 'detect' mode to identify themselves
-*   `siteUrl` **[String][136]** The TERA URL to connect to
-*   `restrictOrigin` **[String][136]** URL to restrict communications to
-*   `List` **[Array][142]<[String][136]>** of sandbox allowables for the embedded if in embed mode
-*   `handshakeInterval` **[Number][139]** Interval in milliseconds when sanning for a handshake
+*   `modeFallback` **[String][138]** Method to use when all method detection fails
+*   `modeTimeout` **[Number][141]** How long entities have in 'detect' mode to identify themselves
+*   `siteUrl` **[String][138]** The TERA URL to connect to
+*   `restrictOrigin` **[String][138]** URL to restrict communications to
+*   `List` **[Array][144]<[String][138]>** of sandbox allowables for the embedded if in embed mode
+*   `handshakeInterval` **[Number][141]** Interval in milliseconds when sanning for a handshake
 
 ### events
 
@@ -354,13 +348,13 @@ Type: Mitt
 
 DOMElements for this TeraFy instance
 
-Type: [Object][137]
+Type: [Object][139]
 
 #### Properties
 
 *   `el` **DOMElement** The main tera-fy div wrapper
 *   `iframe` **DOMElement** The internal iFrame element  (if `settings.mode == 'child'`)
-*   `popup` **[Window][146]** The popup window context (if `settings.mode == 'popup'`)
+*   `popup` **[Window][148]** The popup window context (if `settings.mode == 'popup'`)
 *   `stylesheet` **DOMElement** The corresponding stylesheet
 
 ### methods
@@ -368,13 +362,13 @@ Type: [Object][137]
 List of function stubs mapped from the server to here
 This array is forms the reference of `TeraFy.METHOD()` objects to provide locally which will be mapped via `TeraFy.rpc(METHOD, ...args)`
 
-Type: [Array][142]<[String][136]>
+Type: [Array][144]<[String][138]>
 
 ### plugins
 
 Loaded plugins via Use()
 
-Type: [Array][142]\<TeraFyPlugin>
+Type: [Array][144]\<TeraFyPlugin>
 
 ### send
 
@@ -382,9 +376,9 @@ Send a message + wait for a response object
 
 #### Parameters
 
-*   `message` **[Object][137]** Message object to send
+*   `message` **[Object][139]** Message object to send
 
-Returns **[Promise][143]\<any>** A promise which resolves when the operation has completed with the remote reply
+Returns **[Promise][145]\<any>** A promise which resolves when the operation has completed with the remote reply
 
 ### sendRaw
 
@@ -393,7 +387,7 @@ This function does not return or wait for a reply - use `send()` for that
 
 #### Parameters
 
-*   `message` **[Object][137]** Message object to send
+*   `message` **[Object][139]** Message object to send
 
 ### rpc
 
@@ -401,10 +395,10 @@ Call an RPC function in the server instance
 
 #### Parameters
 
-*   `method` **[String][136]** The method name to call
+*   `method` **[String][138]** The method name to call
 *   `args` **...any**&#x20;
 
-Returns **[Promise][143]\<any>** The resolved output of the server function
+Returns **[Promise][145]\<any>** The resolved output of the server function
 
 ### acceptMessage
 
@@ -413,7 +407,7 @@ Accept an incoming message
 #### Parameters
 
 *   `rawMessage` &#x20;
-*   `Raw` **[MessageEvent][147]** message event to process
+*   `Raw` **[MessageEvent][149]** message event to process
 
 ### acceptPostboxes
 
@@ -422,27 +416,27 @@ Listening postboxes, these correspond to outgoing message IDs that expect a resp
 ### createProjectStatePatch
 
 Create + transmit a new project state patch base on the current and previous states
-The transmitted patch follows the [JSPatch][148] standard
+The transmitted patch follows the [JSPatch][150] standard
 This function accepts an entire projectState instance, computes the delta and transmits that to the server for merging
 
 #### Parameters
 
-*   `newState` **[Object][137]** The local projectState to accept
-*   `oldState` **[Object][137]** The previous projectState to examine against
+*   `newState` **[Object][139]** The local projectState to accept
+*   `oldState` **[Object][139]** The previous projectState to examine against
 
-Returns **[Promise][143]** A promise which will resolve when the operation has completed
+Returns **[Promise][145]** A promise which will resolve when the operation has completed
 
 ### applyProjectStatePatchLocal
 
 Client function which accepts a patch from the server and applies it to local project state
-The patch should follow the [JSPatch][148] standard
+The patch should follow the [JSPatch][150] standard
 This function is expected to be sub-classed by a plugin
 
 #### Parameters
 
-*   `patch` **[Array][142]** A JSPatch patch to apply
+*   `patch` **[Array][144]** A JSPatch patch to apply
 
-Returns **[Promise][143]** A promise which will resolve when the operation has completed
+Returns **[Promise][145]** A promise which will resolve when the operation has completed
 
 ### init
 
@@ -451,28 +445,28 @@ This function can only be called once and will return the existing init() worker
 
 #### Parameters
 
-*   `options` **[Object][137]?** Additional options to merge into `settings` via `set`
+*   `options` **[Object][139]?** Additional options to merge into `settings` via `set`
 
-Returns **[Promise][143]<[TeraFy][31]>** An eventual promise which will resovle with this terafy instance
+Returns **[Promise][145]<[TeraFy][29]>** An eventual promise which will resovle with this terafy instance
 
 ### detectMode
 
 Populate `settings.mode`
 Try to communicate with a parent frame, if none assume we need to fallback to child mode
 
-Returns **[Promise][143]<[String][136]>** A promise which will resolve with the detected mode to use
+Returns **[Promise][145]<[String][138]>** A promise which will resolve with the detected mode to use
 
 ### injectComms
 
 Find an existing active TERA server OR initalize one
 
-Returns **[Promise][143]** A promise which will resolve when the loading has completed and we have found a parent TERA instance or initiallized a child
+Returns **[Promise][145]** A promise which will resolve when the loading has completed and we have found a parent TERA instance or initiallized a child
 
 ### injectStylesheet
 
 Inject a local stylesheet to handle TERA server functionality
 
-Returns **[Promise][143]** A promise which will resolve when the loading has completed and we have found a parent TERA instance or initiallized a child
+Returns **[Promise][145]** A promise which will resolve when the loading has completed and we have found a parent TERA instance or initiallized a child
 
 ### injectMethods
 
@@ -487,7 +481,7 @@ This function will only act if `settings.devMode` is truthy
 
 *   `msg` **...any**&#x20;
 *   `method` **(`"INFO"` | `"LOG"` | `"WARN"` | `"ERROR"`)** Logging method to use (optional, default `'LOG'`)
-*   `verboseLevel` **[Number][139]** The verbosity level to trigger at. If `settings.verbosity` is lower than this, the message is ignored (optional, default `1`)
+*   `verboseLevel` **[Number][141]** The verbosity level to trigger at. If `settings.verbosity` is lower than this, the message is ignored (optional, default `1`)
 
 ### set
 
@@ -496,10 +490,13 @@ This function also routes 'special' keys like `devMode` to their internal handle
 
 #### Parameters
 
-*   `key` **([String][136] | [Object][137])** Either a single setting key to set or an object to merge
+*   `key` **([String][138] | [Object][139])** Either a single setting key to set or an object to merge
 *   `value` **any** The value to set if `key` is a string
+*   `options` **[Object][139]?** Additional options to mutate behaviour
+
+    *   `options.ignoreNullish` **[Boolean][147]** If falsy, this forces the setting of undefined or null values rather than ignoring them when specifying values by string (optional, default `true`)
 
-Returns **[TeraFy][31]** This chainable terafy instance
+Returns **[TeraFy][29]** This chainable terafy instance
 
 ### setIfDev
 
@@ -509,10 +506,11 @@ Set or merge settings - but only in dev mode and only if the value is not undefi
 
 #### Parameters
 
-*   `key` **([String][136] | [Object][137])** Either a single setting key to set or an object to merge
+*   `key` **([String][138] | [Object][139])** Either a single setting key to set or an object to merge
 *   `value` **any** The value to set if `key` is a string
+*   `options` **[Object][139]?** Additional options to mutate behaviour
 
-Returns **[TeraFy][31]** This chainable terafy instance
+Returns **[TeraFy][29]** This chainable terafy instance
 
 ### use
 
@@ -521,10 +519,10 @@ Include a TeraFy client plugin
 #### Parameters
 
 *   `mod` &#x20;
-*   `options` **[Object][137]?** Additional options to mutate behaviour during construction (pass options to init() to intialize later options)
-*   `The` **[Object][137]** module function to include. Invoked as `(teraClient:TeraFy, options:Object)`
+*   `options` **[Object][139]?** Additional options to mutate behaviour during construction (pass options to init() to intialize later options)
+*   `The` **[Object][139]** module function to include. Invoked as `(teraClient:TeraFy, options:Object)`
 
-Returns **[TeraFy][31]** This chainable terafy instance
+Returns **[TeraFy][29]** This chainable terafy instance
 
 ### mixin
 
@@ -532,18 +530,22 @@ Internal function used by use() to merge an external declared singleton against
 
 #### Parameters
 
-*   `target` **[Object][137]** Initalied class instance to extend
-*   `source` **[Object][137]** Initalized source object to extend from
+*   `target` **[Object][139]** Initalied class instance to extend
+*   `source` **[Object][139]** Initalized source object to extend from
 
 ### toggleDevMode
 
 Set or toggle devMode
+This function also accepts meta values:
+
+    'toggle' - Set dev mode to whatever the opposing value of the current mode
+    'proxy'  - Optimize for using a loopback proxy
 
 #### Parameters
 
-*   `devModeEnabled` **([String][136] | [Boolean][145])** Optional boolean to force dev mode (optional, default `'toggle'`)
+*   `devModeEnabled` **(`"toggle"` | `"proxy"` | [Boolean][147])** Optional boolean to force dev mode or specify other behaviour (optional, default `'toggle'`)
 
-Returns **[TeraFy][31]** This chainable terafy instance
+Returns **[TeraFy][29]** This chainable terafy instance
 
 ### toggleFocus
 
@@ -552,7 +554,7 @@ This is usually because the server component wants to perform some user activity
 
 #### Parameters
 
-*   `isFocused` **([String][136] | [Boolean][145])** Whether to fullscreen the embedded component (optional, default `'toggle'`)
+*   `isFocused` **([String][138] | [Boolean][147])** Whether to fullscreen the embedded component (optional, default `'toggle'`)
 
 ### selectProjectFile
 
@@ -564,7 +566,7 @@ This is an pre-requisite step for requireProject()
 
 *   `options` &#x20;
 
-Returns **[Promise][143]** A promise which will resolve if the there is a user and they are logged in
+Returns **[Promise][145]** A promise which will resolve if the there is a user and they are logged in
 
 ### getProjectFiles
 
@@ -572,12 +574,13 @@ Fetch the files associated with a given project
 
 #### Parameters
 
-*   `options` **[Object][137]** Options which mutate behaviour
+*   `options` **[Object][139]** Options which mutate behaviour
 
-    *   `options.autoRequire` **[Boolean][145]** Run `requireProject()` automatically before continuing (optional, default `true`)
-    *   `options.meta` **[Boolean][145]** Pull meta information for each file entity (optional, default `true`)
+    *   `options.autoRequire` **[Boolean][147]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.lazy` **[Boolean][147]** If true, use the fastest method to retrieve the file list such as the cache. If false, force a refresh each time (optional, default `true`)
+    *   `options.meta` **[Boolean][147]** Pull meta information for each file entity (optional, default `true`)
 
-Returns **[Promise][143]<[Array][142]<[ProjectFile][1]>>** A collection of project files for the given project
+Returns **[Promise][145]<[Array][144]<[ProjectFile][1]>>** A collection of project files for the given project
 
 ### getProjectFile
 
@@ -586,13 +589,13 @@ Fetch a project file by its name
 #### Parameters
 
 *   `id` &#x20;
-*   `name` **[String][136]** The name + relative directory path component
-*   `options` **([Object][137] | [String][136])?** Additional options to mutate behaviour, if a string is given `options.subkey` is assumed
+*   `name` **[String][138]** The name + relative directory path component
+*   `options` **([Object][139] | [String][138])?** Additional options to mutate behaviour, if a string is given `options.subkey` is assumed
 
-    *   `options.subkey` **[String][136]?** If specified only the extracted subkey is returned rather than the full object
-    *   `options.cache` **[Boolean][145]** Use the existing file cache if possible, set to false to force a refresh of files from the server first (optional, default `true`)
+    *   `options.subkey` **[String][138]?** If specified only the extracted subkey is returned rather than the full object
+    *   `options.cache` **[Boolean][147]** Use the existing file cache if possible, set to false to force a refresh of files from the server first (optional, default `true`)
 
-Returns **[Promise][143]<[ProjectFile][1]>** The eventual fetched ProjectFile (or requested subkey)
+Returns **[Promise][145]<[ProjectFile][1]>** The eventual fetched ProjectFile (or requested subkey)
 
 ### createProjectFile
 
@@ -601,9 +604,9 @@ This creates an empty file which can then be written to
 
 #### Parameters
 
-*   `name` **[String][136]** The name + relative directory path component
+*   `name` **[String][138]** The name + relative directory path component
 
-Returns **[Promise][143]<[ProjectFile][1]>** The eventual ProjectFile created
+Returns **[Promise][145]<[ProjectFile][1]>** The eventual ProjectFile created
 
 ## handshake
 
@@ -611,9 +614,17 @@ Return basic server information as a form of validation
 
 ### Properties
 
-*   `date` **[Date][138]** Server date
+*   `date` **[Date][140]** Server date
 
-Returns **[Promise][143]<[Object][137]>** Basic promise result
+Returns **[Promise][145]<[Object][139]>** Basic promise result
+
+## setServerVerbosity
+
+RPC callback to set the server verbostiy level
+
+### Parameters
+
+*   `verbosity` **[Number][141]** The desired server verbosity level
 
 ## User
 
@@ -621,16 +632,16 @@ User / active session within TERA
 
 ### Properties
 
-*   `id` **[String][136]** Unique identifier of the user
-*   `email` **[String][136]** The email address of the current user
-*   `name` **[String][136]** The provided full name of the user
-*   `isSubscribed` **[Boolean][145]** Whether the active user has a TERA subscription
+*   `id` **[String][138]** Unique identifier of the user
+*   `email` **[String][138]** The email address of the current user
+*   `name` **[String][138]** The provided full name of the user
+*   `isSubscribed` **[Boolean][147]** Whether the active user has a TERA subscription
 
 ## getUser
 
 Fetch the current session user
 
-Returns **[Promise][143]<[User][82]>** The current logged in user or null if none
+Returns **[Promise][145]<[User][82]>** The current logged in user or null if none
 
 ## requireUser
 
@@ -640,11 +651,11 @@ This is an pre-requisite step for requireProject()
 
 ### Parameters
 
-*   `options` **[Object][137]?** Additional options to mutate behaviour
+*   `options` **[Object][139]?** Additional options to mutate behaviour
 
-    *   `options.forceRetry` **[Boolean][145]** Forcabily try to refresh the user state (optional, default `false`)
+    *   `options.forceRetry` **[Boolean][147]** Forcabily try to refresh the user state (optional, default `false`)
 
-Returns **[Promise][143]<[User][82]>** The current logged in user or null if none
+Returns **[Promise][145]<[User][82]>** The current logged in user or null if none
 
 ## Project
 
@@ -654,13 +665,13 @@ Project entry within TERA
 
 Get the currently active project, if any
 
-Returns **[Promise][143]<([Project][87] | null)>** The currently active project, if any
+Returns **[Promise][145]<([Project][87] | null)>** The currently active project, if any
 
 ## getProjects
 
 Get a list of projects the current session user has access to
 
-Returns **[Promise][143]<[Array][142]<[Project][87]>>** Collection of projects the user has access to
+Returns **[Promise][145]<[Array][144]<[Project][87]>>** Collection of projects the user has access to
 
 ## setActiveProject
 
@@ -668,7 +679,7 @@ Set the currently active project within TERA
 
 ### Parameters
 
-*   `project` **([Object][137] | [String][136])** The project to set as active - either the full Project object or its ID
+*   `project` **([Object][139] | [String][138])** The project to set as active - either the full Project object or its ID
 
 ## requireProject
 
@@ -677,14 +688,14 @@ Note that this function will percist in asking the uesr even if they try to canc
 
 ### Parameters
 
-*   `options` **[Object][137]?** Additional options to mutate behaviour
+*   `options` **[Object][139]?** Additional options to mutate behaviour
 
-    *   `options.autoSetActiveProject` **[Boolean][145]** After selecting a project set that project as active in TERA (optional, default `true`)
-    *   `options.title` **[String][136]** The title of the dialog to display (optional, default `"Select a project to work with"`)
-    *   `options.noSelectTitle` **[String][136]** Dialog title when warning the user they need to select something (optional, default `'Select project'`)
-    *   `options.noSelectBody` **[String][136]** Dialog body when warning the user they need to select something (optional, default `'A project needs to be selected to continue'`)
+    *   `options.autoSetActiveProject` **[Boolean][147]** After selecting a project set that project as active in TERA (optional, default `true`)
+    *   `options.title` **[String][138]** The title of the dialog to display (optional, default `"Select a project to work with"`)
+    *   `options.noSelectTitle` **[String][138]** Dialog title when warning the user they need to select something (optional, default `'Select project'`)
+    *   `options.noSelectBody` **[String][138]** Dialog body when warning the user they need to select something (optional, default `'A project needs to be selected to continue'`)
 
-Returns **[Promise][143]<[Project][87]>** The active project
+Returns **[Promise][145]<[Project][87]>** The active project
 
 ## selectProject
 
@@ -692,13 +703,13 @@ Prompt the user to select a project from those available
 
 ### Parameters
 
-*   `options` **[Object][137]?** Additional options to mutate behaviour
+*   `options` **[Object][139]?** Additional options to mutate behaviour
 
-    *   `options.title` **[String][136]** The title of the dialog to display (optional, default `"Select a project to work with"`)
-    *   `options.allowCancel` **[Boolean][145]** Advertise cancelling the operation, the dialog can still be cancelled by closing it (optional, default `true`)
-    *   `options.setActive` **[Boolean][145]** Also set the project as active when selected (optional, default `false`)
+    *   `options.title` **[String][138]** The title of the dialog to display (optional, default `"Select a project to work with"`)
+    *   `options.allowCancel` **[Boolean][147]** Advertise cancelling the operation, the dialog can still be cancelled by closing it (optional, default `true`)
+    *   `options.setActive` **[Boolean][147]** Also set the project as active when selected (optional, default `false`)
 
-Returns **[Promise][143]<[Project][87]>** The active project
+Returns **[Promise][145]<[Project][87]>** The active project
 
 ## getProjectState
 
@@ -706,12 +717,12 @@ Return the current, full snapshot state of the active project
 
 ### Parameters
 
-*   `options` **[Object][137]?** Additional options to mutate behaviour
+*   `options` **[Object][139]?** Additional options to mutate behaviour
 
-    *   `options.autoRequire` **[Boolean][145]** Run `requireProject()` automatically before continuing (optional, default `true`)
-*   `Paths` **[Array][142]<[String][136]>** to subscribe to e.g. \['/users/'],
+    *   `options.autoRequire` **[Boolean][147]** Run `requireProject()` automatically before continuing (optional, default `true`)
+*   `Paths` **[Array][144]<[String][138]>** to subscribe to e.g. \['/users/'],
 
-Returns **[Promise][143]<[Object][137]>** The current project state snapshot
+Returns **[Promise][145]<[Object][139]>** The current project state snapshot
 
 ## setProjectState
 
@@ -723,13 +734,13 @@ Paths can be any valid Lodash.set() value such as:
 
 ### Parameters
 
-*   `path` **([String][136] | [Array][142]<[String][136]>)** The sub-path within the project state to set
+*   `path` **([String][138] | [Array][144]<[String][138]>)** The sub-path within the project state to set
 *   `value` **any** The value to set
-*   `options` **[Object][137]?** Additional options to mutate behaviour
+*   `options` **[Object][139]?** Additional options to mutate behaviour
 
-    *   `options.save` **[Boolean][145]** Save the changes to the server immediately, disable to queue up multiple writes (optional, default `true`)
+    *   `options.save` **[Boolean][147]** Save the changes to the server immediately, disable to queue up multiple writes (optional, default `true`)
 
-Returns **[Promise][143]** A promise which resolves when the operation has been dispatched to the server
+Returns **[Promise][145]** A promise which resolves when the operation has been dispatched to the server
 
 ## setProjectStateDefaults
 
@@ -739,31 +750,31 @@ Set a nested value within the project state - just like `setProjectState()` - bu
 
 ### Parameters
 
-*   `path` **([String][136] | [Array][142]<[String][136]>)** The sub-path within the project state to set
+*   `path` **([String][138] | [Array][144]<[String][138]>)** The sub-path within the project state to set
 *   `value` **any** The value to set
-*   `options` **[Object][137]?** Additional options to mutate behaviour, see setProjectState() for the full list of supported options
+*   `options` **[Object][139]?** Additional options to mutate behaviour, see setProjectState() for the full list of supported options
 
-Returns **[Promise][143]<[Boolean][145]>** A promise which resolves to whether any changes were made - True if defaults were applied, false otherwise
+Returns **[Promise][145]<[Boolean][147]>** A promise which resolves to whether any changes were made - True if defaults were applied, false otherwise
 
 ## setProjectStateFlush
 
 Force copying local changes to the server
 This is only ever needed when saving large quantities of data that need to be immediately available
 
-Returns **[Promise][143]** A promise which resolves when the operation has completed
+Returns **[Promise][145]** A promise which resolves when the operation has completed
 
 ## setProjectStateRefresh
 
 Force refetching the remote project state into local
 This is only ever needed when saving large quantities of data that need to be immediately available
 
-Returns **[Promise][143]** A promise which resolves when the operation has completed
+Returns **[Promise][145]** A promise which resolves when the operation has completed
 
 ## saveProjectState
 
 Force-Save the currently active project state
 
-Returns **[Promise][143]** A promise which resolves when the operation has completed
+Returns **[Promise][145]** A promise which resolves when the operation has completed
 
 ## replaceProjectState
 
@@ -774,9 +785,9 @@ You almost never want to use this function directly, see `setProjectState(path,
 
 ### Parameters
 
-*   `newState` **[Object][137]** The new state to replace the current state with
+*   `newState` **[Object][139]** The new state to replace the current state with
 
-Returns **[Promise][143]** A promise which resolves when the operation has completed
+Returns **[Promise][145]** A promise which resolves when the operation has completed
 
 ## applyProjectStatePatch
 
@@ -784,9 +795,9 @@ Apply a computed `just-diff` patch to the current project state
 
 ### Parameters
 
-*   `Patch` **[Object][137]** to apply
+*   `Patch` **[Object][139]** to apply
 
-Returns **[Promise][143]** A promise which resolves when the operation has completed
+Returns **[Promise][145]** A promise which resolves when the operation has completed
 
 ## subscribeProjectState
 
@@ -794,7 +805,7 @@ Subscribe to project state changes
 This will dispatch an RPC call to the source object `applyProjectStatePatchLocal()` function with the patch
 If the above call fails the subscriber is assumed as dead and unsubscribed from the polling list
 
-Returns **[Promise][143]<[Function][149]>** A promise which resolves when a subscription has been created, call the resulting function to unsubscribe
+Returns **[Promise][145]<[Function][151]>** A promise which resolves when a subscription has been created, call the resulting function to unsubscribe
 
 ## FileFilters
 
@@ -802,10 +813,10 @@ Data structure for a file filter
 
 ### Properties
 
-*   `library` **[Boolean][145]?** Restrict to library files only
-*   `filename` **[String][136]?** CSV of @momsfriendlydevco/match expressions to filter the filename by (filenames are the basename sans extension)
-*   `basename` **[String][136]?** CSV of @momsfriendlydevco/match expressions to filter the basename by
-*   `ext` **[String][136]?** CSV of @momsfriendlydevco/match expressions to filter the file extension by
+*   `library` **[Boolean][147]?** Restrict to library files only
+*   `filename` **[String][138]?** CSV of @momsfriendlydevco/match expressions to filter the filename by (filenames are the basename sans extension)
+*   `basename` **[String][138]?** CSV of @momsfriendlydevco/match expressions to filter the basename by
+*   `ext` **[String][138]?** CSV of @momsfriendlydevco/match expressions to filter the file extension by
 
 ## selectProjectFile
 
@@ -813,20 +824,20 @@ Prompt the user to select a library to operate on
 
 ### Parameters
 
-*   `options` **[Object][137]?** Additional options to mutate behaviour
+*   `options` **[Object][139]?** Additional options to mutate behaviour
 
-    *   `options.title` **[String][136]** The title of the dialog to display (optional, default `"Select a file"`)
-    *   `options.hint` **([String][136] | [Array][142]<[String][136]>)?** Hints to identify the file to select in array order of preference
-    *   `options.save` **[Boolean][145]** Set to truthy if saving a new file, UI will adjust to allowing overwrite OR new file name input (optional, default `false`)
+    *   `options.title` **[String][138]** The title of the dialog to display (optional, default `"Select a file"`)
+    *   `options.hint` **([String][138] | [Array][144]<[String][138]>)?** Hints to identify the file to select in array order of preference
+    *   `options.save` **[Boolean][147]** 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][110]?** Optional file filters
-    *   `options.allowUpload` **[Boolean][145]** Allow uploading new files (optional, default `true`)
-    *   `options.allowRefresh` **[Boolean][145]** Allow the user to manually refresh the file list (optional, default `true`)
-    *   `options.allowDownloadZip` **[Boolean][145]** Allow the user to download a Zip of all files (optional, default `true`)
-    *   `options.allowCancel` **[Boolean][145]** Allow cancelling the operation. Will throw `'CANCEL'` as the promise rejection if acationed (optional, default `true`)
-    *   `options.autoRequire` **[Boolean][145]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.allowUpload` **[Boolean][147]** Allow uploading new files (optional, default `true`)
+    *   `options.allowRefresh` **[Boolean][147]** Allow the user to manually refresh the file list (optional, default `true`)
+    *   `options.allowDownloadZip` **[Boolean][147]** Allow the user to download a Zip of all files (optional, default `true`)
+    *   `options.allowCancel` **[Boolean][147]** Allow cancelling the operation. Will throw `'CANCEL'` as the promise rejection if acationed (optional, default `true`)
+    *   `options.autoRequire` **[Boolean][147]** Run `requireProject()` automatically before continuing (optional, default `true`)
     *   `options.filter` **[FileFilters][110]?** Optional file filters
 
-Returns **[Promise][143]<[ProjectFile][1]>** The eventually selected file, if in save mode new files are created as stubs
+Returns **[Promise][145]<[ProjectFile][1]>** The eventually selected file, if in save mode new files are created as stubs
 
 ## deleteProjectFile
 
@@ -834,9 +845,9 @@ Remove a project file by its ID
 
 ### Parameters
 
-*   `id` **[String][136]** The File ID to remove
+*   `id` **[String][138]** The File ID to remove
 
-Returns **[Promise][143]** A promise which resolves when the operation has completed
+Returns **[Promise][145]** A promise which resolves when the operation has completed
 
 ## setProjectFile
 
@@ -844,10 +855,10 @@ Replace a project files contents
 
 ### Parameters
 
-*   `id` **[String][136]** File to overwrite
-*   `contents` **(File | [Blob][140] | [FormData][141] | [Object][137] | [Array][142])** The new file contents
+*   `id` **[String][138]** File to overwrite
+*   `contents` **(File | [Blob][142] | [FormData][143] | [Object][139] | [Array][144])** The new file contents
 
-Returns **[Promise][143]** A promise which will resolve when the write operation has completed
+Returns **[Promise][145]** A promise which will resolve when the write operation has completed
 
 ## selectProjectLibrary
 
@@ -855,18 +866,18 @@ Prompt the user to select a library to operate on and return a array of referenc
 
 ### Parameters
 
-*   `options` **[Object][137]?** Additional options to mutate behaviour
+*   `options` **[Object][139]?** Additional options to mutate behaviour
 
-    *   `options.title` **[String][136]** The title of the dialog to display (optional, default `"Select a citation library"`)
-    *   `options.hint` **([String][136] | [Array][142]<[String][136]>)?** Hints to identify the library to select in array order of preference. Generally corresponds to the previous stage - e.g. 'deduped', 'review1', 'review2', 'dedisputed'
-    *   `options.allowUpload` **[Boolean][145]** Allow uploading new files (optional, default `true`)
-    *   `options.allowRefresh` **[Boolean][145]** Allow the user to manually refresh the file list (optional, default `true`)
-    *   `options.allowDownloadZip` **[Boolean][145]** Allow the user to download a Zip of all files (optional, default `true`)
-    *   `options.allowCancel` **[Boolean][145]** Allow cancelling the operation. Will throw `'CANCEL'` as the promise rejection if acationed (optional, default `true`)
-    *   `options.autoRequire` **[Boolean][145]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.title` **[String][138]** The title of the dialog to display (optional, default `"Select a citation library"`)
+    *   `options.hint` **([String][138] | [Array][144]<[String][138]>)?** Hints to identify the library to select in array order of preference. Generally corresponds to the previous stage - e.g. 'deduped', 'review1', 'review2', 'dedisputed'
+    *   `options.allowUpload` **[Boolean][147]** Allow uploading new files (optional, default `true`)
+    *   `options.allowRefresh` **[Boolean][147]** Allow the user to manually refresh the file list (optional, default `true`)
+    *   `options.allowDownloadZip` **[Boolean][147]** Allow the user to download a Zip of all files (optional, default `true`)
+    *   `options.allowCancel` **[Boolean][147]** Allow cancelling the operation. Will throw `'CANCEL'` as the promise rejection if acationed (optional, default `true`)
+    *   `options.autoRequire` **[Boolean][147]** Run `requireProject()` automatically before continuing (optional, default `true`)
     *   `options.filters` **[FileFilters][110]?** Optional file filters, defaults to citation library selection only
 
-Returns **[Promise][143]<[Array][142]\<Ref>>** A collection of references from the selected file
+Returns **[Promise][145]<[Array][144]\<Ref>>** A collection of references from the selected file
 
 ## getProjectLibrary
 
@@ -874,15 +885,15 @@ Fetch + convert a project file into a library of citations
 
 ### Parameters
 
-*   `id` **[String][136]** File ID to read
-*   `options` **[Object][137]?** Additional options to mutate behaviour
+*   `id` **[String][138]** File ID to read
+*   `options` **[Object][139]?** Additional options to mutate behaviour
 
-    *   `options.format` **[String][136]** Format for the file. ENUM: 'pojo' (return a parsed JS collection), 'blob' (raw JS Blob object), 'file' (named JS File object) (optional, default `'json'`)
-    *   `options.autoRequire` **[Boolean][145]** Run `requireProject()` automatically before continuing (optional, default `true`)
-    *   `options.filter` **[Function][149]?** Optional async file filter, called each time as `(File:ProjectFile)`
-    *   `options.find` **[Function][149]?** Optional async final stage file filter to reduce all candidates down to one subject file
+    *   `options.format` **[String][138]** Format for the file. ENUM: 'pojo' (return a parsed JS collection), 'blob' (raw JS Blob object), 'file' (named JS File object) (optional, default `'json'`)
+    *   `options.autoRequire` **[Boolean][147]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.filter` **[Function][151]?** Optional async file filter, called each time as `(File:ProjectFile)`
+    *   `options.find` **[Function][151]?** Optional async final stage file filter to reduce all candidates down to one subject file
 
-Returns **([Promise][143]<[Array][142]\<Ref>> | [Promise][143]\<any>)** A collection of references (default bevahiour) or a whatever format was requested
+Returns **([Promise][145]<[Array][144]\<Ref>> | [Promise][145]\<any>)** A collection of references (default bevahiour) or a whatever format was requested
 
 ## setProjectLibrary
 
@@ -890,33 +901,33 @@ Save back a citation library from some input
 
 ### Parameters
 
-*   `id` **[String][136]?** File ID to save back to, if omitted a file will be prompted for
-*   `refs` **([Array][142]\<RefLibRef> | [Blob][140] | File)?** Collection of references for the selected library or the raw Blob/File
-*   `options` **[Object][137]?** Additional options to mutate behaviour
+*   `id` **[String][138]?** File ID to save back to, if omitted a file will be prompted for
+*   `refs` **([Array][144]\<RefLibRef> | [Blob][142] | File)?** Collection of references for the selected library or the raw Blob/File
+*   `options` **[Object][139]?** Additional options to mutate behaviour
 
-    *   `options.id` **[String][136]?** Alternate method to specify the file ID to save as, if omitted one will be prompted for
-    *   `options.refs` **([Array][142]\<RefLibRef> | [Blob][140] | File)?** Alternate method to specify the refs to save as an array or raw Blob/File
-    *   `options.format` **[String][136]** Input format used. ENUM: 'pojo' (return a parsed JS collection), 'blob' (raw JS Blob object), 'file' (named JS File object) (optional, default `'json'`)
-    *   `options.autoRequire` **[Boolean][145]** Run `requireProject()` automatically before continuing (optional, default `true`)
-    *   `options.hint` **[String][136]?** Hint to store against the library. Generally corresponds to the current operation being performed - e.g. 'deduped'
-    *   `options.filename` **[String][136]?** Suggested filename if `id` is unspecified
-    *   `options.title` **[String][136]** Dialog title if `id` is unspecified and a prompt is necessary (optional, default `'Save citation library'`)
-    *   `options.overwrite` **[Boolean][145]** Allow existing file upsert (optional, default `true`)
-    *   `options.meta` **[Object][137]?** Optional meta data to merge into the file data
+    *   `options.id` **[String][138]?** Alternate method to specify the file ID to save as, if omitted one will be prompted for
+    *   `options.refs` **([Array][144]\<RefLibRef> | [Blob][142] | File)?** Alternate method to specify the refs to save as an array or raw Blob/File
+    *   `options.format` **[String][138]** Input format used. ENUM: 'pojo' (return a parsed JS collection), 'blob' (raw JS Blob object), 'file' (named JS File object) (optional, default `'json'`)
+    *   `options.autoRequire` **[Boolean][147]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.hint` **[String][138]?** Hint to store against the library. Generally corresponds to the current operation being performed - e.g. 'deduped'
+    *   `options.filename` **[String][138]?** Suggested filename if `id` is unspecified
+    *   `options.title` **[String][138]** Dialog title if `id` is unspecified and a prompt is necessary (optional, default `'Save citation library'`)
+    *   `options.overwrite` **[Boolean][147]** Allow existing file upsert (optional, default `true`)
+    *   `options.meta` **[Object][139]?** Optional meta data to merge into the file data
 
-Returns **[Promise][143]** A promise which resolves when the save operation has completed
+Returns **[Promise][145]** A promise which resolves when the save operation has completed
 
 ## projectLog
 
 Create a log entry for the currently active project
 
-The required log object can be of various forms. See [https://tera-tools.com/api/logs.json][150] for the full list
+The required log object can be of various forms. See [https://tera-tools.com/api/logs.json][152] for the full list
 
 ### Parameters
 
-*   `log` **[Object][137]** The log entry to create
+*   `log` **[Object][139]** The log entry to create
 
-Returns **[Promise][143]** A promise which resolves when the operation has completed
+Returns **[Promise][145]** A promise which resolves when the operation has completed
 
 ## setPageUrl
 
@@ -925,7 +936,7 @@ This only really makes a difference to tools within the tera-tools.com site wher
 
 ### Parameters
 
-*   `url` **[String][136]** The URL to restore on next refresh
+*   `url` **[String][138]** The URL to restore on next refresh
 
 ## setPageTitle
 
@@ -934,7 +945,7 @@ This is usually called by a tool nested within the tera-tools.com embed
 
 ### Parameters
 
-*   `title` **[String][136]** The current page title
+*   `title` **[String][138]** The current page title
 
 ## uiAlert
 
@@ -942,25 +953,32 @@ Display simple text within TERA
 
 ### Parameters
 
-*   `text` **[String][136]** The text to display
-*   `options` **[Object][137]?** Additional options to mutate behaviour
+*   `text` **[String][138]** The text to display
+*   `options` **[Object][139]?** Additional options to mutate behaviour
 
-    *   `options.title` **[String][136]** The title of the alert box (optional, default `'TERA'`)
-    *   `options.isHtml` **[Boolean][145]** If falsy the text is rendered as plain-text otherwise it will be assumed as HTML content (optional, default `false`)
+    *   `options.title` **[String][138]** The title of the alert box (optional, default `'TERA'`)
+    *   `options.isHtml` **[Boolean][147]** If falsy the text is rendered as plain-text otherwise it will be assumed as HTML content (optional, default `false`)
 
-Returns **[Promise][143]** A promise which resolves when the alert has been dismissed
+Returns **[Promise][145]** A promise which resolves when the alert has been dismissed
 
-## uiSplat
+## uiProgress
 
-Display HTML content full-screen within TERA
-This function is ideally called within a requestFocus() wrapper
+Display, update or dispose of windows for long running tasks
+All options are cumulative - i.e. they are merged with other options previously provided
 
 ### Parameters
 
-*   `content` **(DOMElement | [String][136] | `false`)** Either a prepared DOM element or string to compile, set to falsy to remove existing content
-*   `options` **[Object][137]?** Additional options to mutate behaviour
+*   `options` **([Object][139] | [Boolean][147])?** Additional options to mutate behaviour, if boolean false `{close: true}` is assumed
+
+    *   `options.title` **[String][138]** Window title, can only be set on the initial call (optional, default `'TERA'`)
+    *   `options.body` **[String][138]** Window body text, can only be set on the initial call (optional, default `''`)
+    *   `options.bodyHtml` **[Boolean][147]** Treat body text as HTML (optional, default `false`)
+    *   `options.close` **[Boolean][147]** Close the existing dialog, if true the dialog is disposed and options reset (optional, default `false`)
+    *   `options.text` **[String][138]?** The text of the task being conducted
+    *   `options.progress` **[Number][141]?** The current progress of the task being conducted, this is assumed to be a value less than `maxProgress`
+    *   `options.maxProgress` **[Number][141]?** The maximum value that the progress can be
 
-    *   `options.logo` **([Boolean][145] | [String][136])** Add a logo to the output, if boolean true the Tera-tools logo is used otherwise specify a path or URL (optional, default `false`)
+Returns **[Promise][145]** A promise which resolves when the dialog has been updated
 
 ## uiWindow
 
@@ -968,16 +986,28 @@ Open a popup window containing a new site
 
 ### Parameters
 
-*   `url` **[String][136]** The URL to open
-*   `options` **[Object][137]?** Additional options to mutate behaviour
+*   `url` **[String][138]** The URL to open
+*   `options` **[Object][139]?** Additional options to mutate behaviour
 
-    *   `options.width` **[Number][139]** The desired width of the window (optional, default `500`)
-    *   `options.height` **[Number][139]** The desired height of the window (optional, default `600`)
-    *   `options.center` **[Boolean][145]** Attempt to center the window on the screen (optional, default `true`)
-    *   `options.permissions` **[Object][137]?** Additional permissions to set on opening, defaults to a suitable set of permission for popups (see code)
+    *   `options.width` **[Number][141]** The desired width of the window (optional, default `500`)
+    *   `options.height` **[Number][141]** The desired height of the window (optional, default `600`)
+    *   `options.center` **[Boolean][147]** Attempt to center the window on the screen (optional, default `true`)
+    *   `options.permissions` **[Object][139]?** Additional permissions to set on opening, defaults to a suitable set of permission for popups (see code)
 
 Returns **WindowProxy** The opened window object (if `noopener` is not set in permissions)
 
+## uiSplat
+
+Display HTML content full-screen within TERA
+This function is ideally called within a requestFocus() wrapper
+
+### Parameters
+
+*   `content` **(DOMElement | [String][138] | `false`)** Either a prepared DOM element or string to compile, set to falsy to remove existing content
+*   `options` **[Object][139]?** Additional options to mutate behaviour
+
+    *   `options.logo` **([Boolean][147] | [String][138])** Add a logo to the output, if boolean true the Tera-tools logo is used otherwise specify a path or URL (optional, default `false`)
+
 [1]: #projectfile
 
 [2]: #id
@@ -1034,111 +1064,111 @@ Returns **WindowProxy** The opened window object (if `noopener` is not set in pe
 
 [28]: #parameters-2
 
-[29]: #tera
+[29]: #terafy
 
-[30]: #parameters-3
+[30]: #settings
 
-[31]: #terafy
+[31]: #properties-1
 
-[32]: #settings
+[32]: #events
 
-[33]: #properties-1
+[33]: #dom
 
-[34]: #events
+[34]: #properties-2
 
-[35]: #dom
+[35]: #methods
 
-[36]: #properties-2
+[36]: #plugins
 
-[37]: #methods
+[37]: #send
 
-[38]: #plugins
+[38]: #parameters-3
 
-[39]: #send
+[39]: #sendraw
 
 [40]: #parameters-4
 
-[41]: #sendraw
+[41]: #rpc
 
 [42]: #parameters-5
 
-[43]: #rpc
+[43]: #acceptmessage
 
 [44]: #parameters-6
 
-[45]: #acceptmessage
+[45]: #acceptpostboxes
 
-[46]: #parameters-7
+[46]: #createprojectstatepatch
 
-[47]: #acceptpostboxes
+[47]: #parameters-7
 
-[48]: #createprojectstatepatch
+[48]: #applyprojectstatepatchlocal
 
 [49]: #parameters-8
 
-[50]: #applyprojectstatepatchlocal
+[50]: #init
 
 [51]: #parameters-9
 
-[52]: #init
+[52]: #detectmode
 
-[53]: #parameters-10
+[53]: #injectcomms
 
-[54]: #detectmode
+[54]: #injectstylesheet
 
-[55]: #injectcomms
+[55]: #injectmethods
 
-[56]: #injectstylesheet
+[56]: #debug
 
-[57]: #injectmethods
+[57]: #parameters-10
 
-[58]: #debug
+[58]: #set
 
 [59]: #parameters-11
 
-[60]: #set
+[60]: #setifdev
 
 [61]: #parameters-12
 
-[62]: #setifdev
+[62]: #use
 
 [63]: #parameters-13
 
-[64]: #use
+[64]: #mixin
 
 [65]: #parameters-14
 
-[66]: #mixin
+[66]: #toggledevmode
 
 [67]: #parameters-15
 
-[68]: #toggledevmode
+[68]: #togglefocus
 
 [69]: #parameters-16
 
-[70]: #togglefocus
+[70]: #selectprojectfile
 
 [71]: #parameters-17
 
-[72]: #selectprojectfile
+[72]: #getprojectfiles
 
 [73]: #parameters-18
 
-[74]: #getprojectfiles
+[74]: #getprojectfile
 
 [75]: #parameters-19
 
-[76]: #getprojectfile
+[76]: #createprojectfile
 
 [77]: #parameters-20
 
-[78]: #createprojectfile
+[78]: #handshake
 
-[79]: #parameters-21
+[79]: #properties-3
 
-[80]: #handshake
+[80]: #setserververbosity
 
-[81]: #properties-3
+[81]: #parameters-21
 
 [82]: #user
 
@@ -1240,7 +1270,7 @@ Returns **WindowProxy** The opened window object (if `noopener` is not set in pe
 
 [131]: #parameters-40
 
-[132]: #uisplat
+[132]: #uiprogress
 
 [133]: #parameters-41
 
@@ -1248,32 +1278,36 @@ Returns **WindowProxy** The opened window object (if `noopener` is not set in pe
 
 [135]: #parameters-42
 
-[136]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+[136]: #uisplat
+
+[137]: #parameters-43
+
+[138]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-[137]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+[139]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
 
-[138]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date
+[140]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date
 
-[139]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+[141]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
-[140]: https://developer.mozilla.org/docs/Web/API/Blob
+[142]: https://developer.mozilla.org/docs/Web/API/Blob
 
-[141]: https://developer.mozilla.org/docs/Web/API/FormData
+[143]: https://developer.mozilla.org/docs/Web/API/FormData
 
-[142]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[144]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[143]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+[145]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
-[144]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm
+[146]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm
 
-[145]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+[147]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
 
-[146]: https://developer.mozilla.org/docs/Web/API/Window
+[148]: https://developer.mozilla.org/docs/Web/API/Window
 
-[147]: https://developer.mozilla.org/docs/Web/API/MessageEvent
+[149]: https://developer.mozilla.org/docs/Web/API/MessageEvent
 
-[148]: http://jsonpatch.com
+[150]: http://jsonpatch.com
 
-[149]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+[151]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
 
-[150]: https://tera-tools.com/api/logs.json
+[152]: https://tera-tools.com/api/logs.json