@iebh/tera-fy 1.4.4 → 1.6.0

package/api.md

@@ -99,34 +99,38 @@
     *   [Parameters][95]
 *   [setProjectStateDefaults][96]
     *   [Parameters][97]
-*   [saveProjectState][98]
-*   [replaceProjectState][99]
-    *   [Parameters][100]
-*   [applyProjectStatePatch][101]
+*   [setProjectStateFlush][98]
+*   [setProjectStateRefresh][99]
+*   [saveProjectState][100]
+*   [replaceProjectState][101]
     *   [Parameters][102]
-*   [subscribeProjectState][103]
-*   [FileFilters][104]
-    *   [Properties][105]
-*   [selectProjectFile][106]
-    *   [Parameters][107]
-*   [setProjectFile][108]
+*   [applyProjectStatePatch][103]
+    *   [Parameters][104]
+*   [subscribeProjectState][105]
+*   [FileFilters][106]
+    *   [Properties][107]
+*   [selectProjectFile][108]
     *   [Parameters][109]
-*   [selectProjectLibrary][110]
+*   [setProjectFile][110]
     *   [Parameters][111]
-*   [getProjectLibrary][112]
+*   [selectProjectLibrary][112]
     *   [Parameters][113]
-*   [setProjectLibrary][114]
+*   [getProjectLibrary][114]
     *   [Parameters][115]
-*   [projectLog][116]
+*   [setProjectLibrary][116]
     *   [Parameters][117]
-*   [setPageUrl][118]
+*   [projectLog][118]
     *   [Parameters][119]
-*   [uiAlert][120]
+*   [setPageUrl][120]
     *   [Parameters][121]
-*   [uiSplat][122]
+*   [setPageTitle][122]
     *   [Parameters][123]
-*   [uiWindow][124]
+*   [uiAlert][124]
     *   [Parameters][125]
+*   [uiSplat][126]
+    *   [Parameters][127]
+*   [uiWindow][128]
+    *   [Parameters][129]
 
 ## ProjectFile
 
@@ -136,99 +140,99 @@ A project file fetched from TERA
 
 A UUID string representing the unique ID of the file
 
-Type: [String][126]
+Type: [String][130]
 
 ### name
 
 Relative name path (can contain prefix directories) for the human readable file name
 
-Type: [String][126]
+Type: [String][130]
 
 ### icon
 
 CSS class to use as the file icon
 
-Type: [String][126]
+Type: [String][130]
 
 ### path
 
 Full path to the file
 This is also used as the unique identifier within the project
 
-Type: [String][126]
+Type: [String][130]
 
 ### parsedName
 
 An object representing meta file parts of a file name
 
-Type: [Object][127]
+Type: [Object][131]
 
 #### Properties
 
-*   `basename` **[String][126]** The filename + extention (i.e. everything without directory name)
-*   `filename` **[String][126]** The file portion of the name (basename without the extension)
-*   `ext` **[String][126]** The extension portion of the name (always lower case)
-*   `dirName` **[String][126]** The directory path portion of the name
+*   `basename` **[String][130]** The filename + extention (i.e. everything without directory name)
+*   `filename` **[String][130]** The file portion of the name (basename without the extension)
+*   `ext` **[String][130]** The extension portion of the name (always lower case)
+*   `dirName` **[String][130]** The directory path portion of the name
 
 ### created
 
 A date representing when the file was created
 
-Type: [Date][128]
+Type: [Date][132]
 
 ### createdFormatted
 
 A human readable, formatted version of "created"
 
-Type: [String][126]
+Type: [String][130]
 
 ### modified
 
 A date representing when the file was created
 
-Type: [Date][128]
+Type: [Date][132]
 
 ### modifiedFormatted
 
 A human readable, formatted version of "modified"
 
-Type: [String][126]
+Type: [String][130]
 
 ### accessed
 
 A date representing when the file was last accessed
 
-Type: [Date][128]
+Type: [Date][132]
 
 ### accessedFormatted
 
 A human readable, formatted version of "accessed"
 
-Type: [String][126]
+Type: [String][130]
 
 ### size
 
 Size, in bytes, of the file
 
-Type: [Number][129]
+Type: [Number][133]
 
 ### sizeFormatted
 
 A human readable, formatted version of the file size
 
-Type: [String][126]
+Type: [String][130]
 
 ### mime
 
 The associated mime type for the file
 
-Type: [String][126]
+Type: [String][130]
 
 ### meta
 
 Additional meta information for the file
 
-Type: [Object][127]
+Type: [Object][131]
 
 ### getContents
 
@@ -246,9 +250,9 @@ Overwrite the contents of a file with new content
 
 #### Parameters
 
-*   `contents` **(File | [Blob][130] | [FormData][131] | [Object][127] | [Array][132])** The new file contents
+*   `contents` **(File | [Blob][134] | [FormData][135] | [Object][131] | [Array][136])** The new file contents
 
-Returns **[Promise][133]** A promise which resolves when the operation has completed
+Returns **[Promise][137]** A promise which resolves when the operation has completed
 
 ### getRefs
 
@@ -256,7 +260,7 @@ Returns **[Promise][133]** A promise which resolves when the operation has compl
 
 Fetch the file contents as an array of Reflib refs
 
-Returns **[Promise][133]<[Array][132]\<Ref>>** An eventual array of RefLib references
+Returns **[Promise][137]<[Array][136]\<Ref>>** An eventual array of RefLib references
 
 ### setRefs
 
@@ -267,18 +271,18 @@ Overwrite the contents of a file with a new collection of Reflib refs
 #### Parameters
 
 *   `refs` &#x20;
-*   `Collection` **[Array][132]\<RefLibRef>** of references for the selected library
+*   `Collection` **[Array][136]\<RefLibRef>** of references for the selected library
 
-Returns **[Promise][133]** A promise which resolves when the operation has completed
+Returns **[Promise][137]** 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][134]
+*   **See**: [https://developer.mozilla.org/en-US/docs/Web/API/Web\_Workers\_API/Structured\_clone\_algorithm][138]
 
 Compress a file state down into a serializable entity
 By default this computes a Structured Clone which can be stringified
 
-Returns **[Object][127]** A Structured Clone compatible representation of this ProjectFile instance
+Returns **[Object][131]** A Structured Clone compatible representation of this ProjectFile instance
 
 ### deserialize
 
@@ -286,7 +290,7 @@ Restore an entity created with serialize
 
 #### Parameters
 
-*   `data` **[Object][127]** An input object created via `ProjectFiles.serialize()`
+*   `data` **[Object][131]** An input object created via `ProjectFiles.serialize()`
 
 Returns **[ProjectFile][1]** A ProjectFile instance setup against the deserializzed data
 
@@ -306,19 +310,19 @@ Main Tera-Fy Client (class singleton) to be used in a frontend browser
 
 Various settings to configure behaviour
 
-Type: [Object][127]
+Type: [Object][131]
 
 #### Properties
 
-*   `devMode` **[Boolean][135]** Operate in devMode - i.e. force outer refresh when encountering an existing TeraFy instance
-*   `verbosity` **[Number][129]** Verbosity level, the higher the more chatty TeraFY will be. Set to zero to disable all `debug()` call output
+*   `devMode` **[Boolean][139]** Operate in devMode - i.e. force outer refresh when encountering an existing TeraFy instance
+*   `verbosity` **[Number][133]** 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][126]** Method to use when all method detection fails
-*   `modeTimeout` **[Number][129]** How long entities have in 'detect' mode to identify themselves
-*   `siteUrl` **[String][126]** The TERA URL to connect to
-*   `restrictOrigin` **[String][126]** URL to restrict communications to
-*   `List` **[Array][132]<[String][126]>** of sandbox allowables for the embedded if in embed mode
-*   `handshakeInterval` **[Number][129]** Interval in milliseconds when sanning for a handshake
+*   `modeFallback` **[String][130]** Method to use when all method detection fails
+*   `modeTimeout` **[Number][133]** How long entities have in 'detect' mode to identify themselves
+*   `siteUrl` **[String][130]** The TERA URL to connect to
+*   `restrictOrigin` **[String][130]** URL to restrict communications to
+*   `List` **[Array][136]<[String][130]>** of sandbox allowables for the embedded if in embed mode
+*   `handshakeInterval` **[Number][133]** Interval in milliseconds when sanning for a handshake
 
 ### events
 
@@ -330,13 +334,13 @@ Type: Mitt
 
 DOMElements for this TeraFy instance
 
-Type: [Object][127]
+Type: [Object][131]
 
 #### Properties
 
 *   `el` **DOMElement** The main tera-fy div wrapper
 *   `iframe` **DOMElement** The internal iFrame element  (if `settings.mode == 'child'`)
-*   `popup` **[Window][136]** The popup window context (if `settings.mode == 'popup'`)
+*   `popup` **[Window][140]** The popup window context (if `settings.mode == 'popup'`)
 *   `stylesheet` **DOMElement** The corresponding stylesheet
 
 ### methods
@@ -344,13 +348,13 @@ Type: [Object][127]
 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][132]<[String][126]>
+Type: [Array][136]<[String][130]>
 
 ### plugins
 
 Loaded plugins via Use()
 
-Type: [Array][132]\<TeraFyPlugin>
+Type: [Array][136]\<TeraFyPlugin>
 
 ### send
 
@@ -358,9 +362,9 @@ Send a message + wait for a response object
 
 #### Parameters
 
-*   `message` **[Object][127]** Message object to send
+*   `message` **[Object][131]** Message object to send
 
-Returns **[Promise][133]\<any>** A promise which resolves when the operation has completed with the remote reply
+Returns **[Promise][137]\<any>** A promise which resolves when the operation has completed with the remote reply
 
 ### sendRaw
 
@@ -369,7 +373,7 @@ This function does not return or wait for a reply - use `send()` for that
 
 #### Parameters
 
-*   `message` **[Object][127]** Message object to send
+*   `message` **[Object][131]** Message object to send
 
 ### rpc
 
@@ -377,10 +381,10 @@ Call an RPC function in the server instance
 
 #### Parameters
 
-*   `method` **[String][126]** The method name to call
+*   `method` **[String][130]** The method name to call
 *   `args` **...any**&#x20;
 
-Returns **[Promise][133]\<any>** The resolved output of the server function
+Returns **[Promise][137]\<any>** The resolved output of the server function
 
 ### acceptMessage
 
@@ -389,7 +393,7 @@ Accept an incoming message
 #### Parameters
 
 *   `rawMessage` &#x20;
-*   `Raw` **[MessageEvent][137]** message event to process
+*   `Raw` **[MessageEvent][141]** message event to process
 
 ### acceptPostboxes
 
@@ -398,27 +402,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][138] standard
+The transmitted patch follows the [JSPatch][142] standard
 This function accepts an entire projectState instance, computes the delta and transmits that to the server for merging
 
 #### Parameters
 
-*   `newState` **[Object][127]** The local projectState to accept
-*   `oldState` **[Object][127]** The previous projectState to examine against
+*   `newState` **[Object][131]** The local projectState to accept
+*   `oldState` **[Object][131]** The previous projectState to examine against
 
-Returns **[Promise][133]** A promise which will resolve when the operation has completed
+Returns **[Promise][137]** 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][138] standard
+The patch should follow the [JSPatch][142] standard
 This function is expected to be sub-classed by a plugin
 
 #### Parameters
 
-*   `patch` **[Array][132]** A JSPatch patch to apply
+*   `patch` **[Array][136]** A JSPatch patch to apply
 
-Returns **[Promise][133]** A promise which will resolve when the operation has completed
+Returns **[Promise][137]** A promise which will resolve when the operation has completed
 
 ### init
 
@@ -427,28 +431,28 @@ This function can only be called once and will return the existing init() worker
 
 #### Parameters
 
-*   `options` **[Object][127]?** Additional options to merge into `settings` via `set`
+*   `options` **[Object][131]?** Additional options to merge into `settings` via `set`
 
-Returns **[Promise][133]<[TeraFy][29]>** An eventual promise which will resovle with this terafy instance
+Returns **[Promise][137]<[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][133]<[String][126]>** A promise which will resolve with the detected mode to use
+Returns **[Promise][137]<[String][130]>** A promise which will resolve with the detected mode to use
 
 ### injectComms
 
 Find an existing active TERA server OR initalize one
 
-Returns **[Promise][133]** A promise which will resolve when the loading has completed and we have found a parent TERA instance or initiallized a child
+Returns **[Promise][137]** 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][133]** A promise which will resolve when the loading has completed and we have found a parent TERA instance or initiallized a child
+Returns **[Promise][137]** A promise which will resolve when the loading has completed and we have found a parent TERA instance or initiallized a child
 
 ### injectMethods
 
@@ -463,7 +467,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][129]** The verbosity level to trigger at. If `settings.verbosity` is lower than this, the message is ignored (optional, default `1`)
+*   `verboseLevel` **[Number][133]** The verbosity level to trigger at. If `settings.verbosity` is lower than this, the message is ignored (optional, default `1`)
 
 ### set
 
@@ -472,7 +476,7 @@ This function also routes 'special' keys like `devMode` to their internal handle
 
 #### Parameters
 
-*   `key` **([String][126] | [Object][127])** Either a single setting key to set or an object to merge
+*   `key` **([String][130] | [Object][131])** Either a single setting key to set or an object to merge
 *   `value` **any** The value to set if `key` is a string
 
 Returns **[TeraFy][29]** This chainable terafy instance
@@ -485,7 +489,7 @@ Set or merge settings - but only in dev mode and only if the value is not undefi
 
 #### Parameters
 
-*   `key` **([String][126] | [Object][127])** Either a single setting key to set or an object to merge
+*   `key` **([String][130] | [Object][131])** Either a single setting key to set or an object to merge
 *   `value` **any** The value to set if `key` is a string
 
 Returns **[TeraFy][29]** This chainable terafy instance
@@ -497,8 +501,8 @@ Include a TeraFy client plugin
 #### Parameters
 
 *   `mod` &#x20;
-*   `options` **[Object][127]?** Additional options to mutate behaviour during construction (pass options to init() to intialize later options)
-*   `The` **[Object][127]** module function to include. Invoked as `(teraClient:TeraFy, options:Object)`
+*   `options` **[Object][131]?** Additional options to mutate behaviour during construction (pass options to init() to intialize later options)
+*   `The` **[Object][131]** module function to include. Invoked as `(teraClient:TeraFy, options:Object)`
 
 Returns **[TeraFy][29]** This chainable terafy instance
 
@@ -508,8 +512,8 @@ Internal function used by use() to merge an external declared singleton against
 
 #### Parameters
 
-*   `target` **[Object][127]** Initalied class instance to extend
-*   `source` **[Object][127]** Initalized source object to extend from
+*   `target` **[Object][131]** Initalied class instance to extend
+*   `source` **[Object][131]** Initalized source object to extend from
 
 ### toggleDevMode
 
@@ -517,7 +521,7 @@ Set or toggle devMode
 
 #### Parameters
 
-*   `devModeEnabled` **([String][126] | [Boolean][135])** Optional boolean to force dev mode (optional, default `'toggle'`)
+*   `devModeEnabled` **([String][130] | [Boolean][139])** Optional boolean to force dev mode (optional, default `'toggle'`)
 
 Returns **[TeraFy][29]** This chainable terafy instance
 
@@ -528,7 +532,7 @@ This is usually because the server component wants to perform some user activity
 
 #### Parameters
 
-*   `isFocused` **([String][126] | [Boolean][135])** Whether to fullscreen the embedded component (optional, default `'toggle'`)
+*   `isFocused` **([String][130] | [Boolean][139])** Whether to fullscreen the embedded component (optional, default `'toggle'`)
 
 ### selectProjectFile
 
@@ -540,7 +544,7 @@ This is an pre-requisite step for requireProject()
 
 *   `options` &#x20;
 
-Returns **[Promise][133]** A promise which will resolve if the there is a user and they are logged in
+Returns **[Promise][137]** A promise which will resolve if the there is a user and they are logged in
 
 ### getProjectFiles
 
@@ -548,12 +552,12 @@ Fetch the files associated with a given project
 
 #### Parameters
 
-*   `options` **[Object][127]** Options which mutate behaviour
+*   `options` **[Object][131]** Options which mutate behaviour
 
-    *   `options.autoRequire` **[Boolean][135]** Run `requireProject()` automatically before continuing (optional, default `true`)
-    *   `options.meta` **[Boolean][135]** Pull meta information for each file entity (optional, default `true`)
+    *   `options.autoRequire` **[Boolean][139]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.meta` **[Boolean][139]** Pull meta information for each file entity (optional, default `true`)
 
-Returns **[Promise][133]<[Array][132]<[ProjectFile][1]>>** A collection of project files for the given project
+Returns **[Promise][137]<[Array][136]<[ProjectFile][1]>>** A collection of project files for the given project
 
 ### getProjectFile
 
@@ -561,9 +565,9 @@ Fetch a project file
 
 #### Parameters
 
-*   `path` **[String][126]** File path to read
+*   `path` **[String][130]** File path to read
 
-Returns **[Promise][133]<[Blob][130]>** The eventual fetched file as a blob
+Returns **[Promise][137]<[Blob][134]>** The eventual fetched file as a blob
 
 ## handshake
 
@@ -571,9 +575,9 @@ Return basic server information as a form of validation
 
 ### Properties
 
-*   `date` **[Date][128]** Server date
+*   `date` **[Date][132]** Server date
 
-Returns **[Promise][133]<[Object][127]>** Basic promise result
+Returns **[Promise][137]<[Object][131]>** Basic promise result
 
 ## User
 
@@ -581,16 +585,16 @@ User / active session within TERA
 
 ### Properties
 
-*   `id` **[String][126]** Unique identifier of the user
-*   `email` **[String][126]** The email address of the current user
-*   `name` **[String][126]** The provided full name of the user
-*   `isSubscribed` **[Boolean][135]** Whether the active user has a TERA subscription
+*   `id` **[String][130]** Unique identifier of the user
+*   `email` **[String][130]** The email address of the current user
+*   `name` **[String][130]** The provided full name of the user
+*   `isSubscribed` **[Boolean][139]** Whether the active user has a TERA subscription
 
 ## getUser
 
 Fetch the current session user
 
-Returns **[Promise][133]<[User][78]>** The current logged in user or null if none
+Returns **[Promise][137]<[User][78]>** The current logged in user or null if none
 
 ## requireUser
 
@@ -600,11 +604,11 @@ This is an pre-requisite step for requireProject()
 
 ### Parameters
 
-*   `options` **[Object][127]?** Additional options to mutate behaviour
+*   `options` **[Object][131]?** Additional options to mutate behaviour
 
-    *   `options.forceRetry` **[Boolean][135]** Forcabily try to refresh the user state (optional, default `false`)
+    *   `options.forceRetry` **[Boolean][139]** Forcabily try to refresh the user state (optional, default `false`)
 
-Returns **[Promise][133]<[User][78]>** The current logged in user or null if none
+Returns **[Promise][137]<[User][78]>** The current logged in user or null if none
 
 ## Project
 
@@ -614,13 +618,13 @@ Project entry within TERA
 
 Get the currently active project, if any
 
-Returns **[Promise][133]<([Project][83] | null)>** The currently active project, if any
+Returns **[Promise][137]<([Project][83] | null)>** The currently active project, if any
 
 ## getProjects
 
 Get a list of projects the current session user has access to
 
-Returns **[Promise][133]<[Array][132]<[Project][83]>>** Collection of projects the user has access to
+Returns **[Promise][137]<[Array][136]<[Project][83]>>** Collection of projects the user has access to
 
 ## setActiveProject
 
@@ -628,7 +632,7 @@ Set the currently active project within TERA
 
 ### Parameters
 
-*   `project` **([Object][127] | [String][126])** The project to set as active - either the full Project object or its ID
+*   `project` **([Object][131] | [String][130])** The project to set as active - either the full Project object or its ID
 
 ## requireProject
 
@@ -637,14 +641,14 @@ Note that this function will percist in asking the uesr even if they try to canc
 
 ### Parameters
 
-*   `options` **[Object][127]?** Additional options to mutate behaviour
+*   `options` **[Object][131]?** Additional options to mutate behaviour
 
-    *   `options.autoSetActiveProject` **[Boolean][135]** After selecting a project set that project as active in TERA (optional, default `true`)
-    *   `options.title` **[String][126]** The title of the dialog to display (optional, default `"Select a project to work with"`)
-    *   `options.noSelectTitle` **[String][126]** Dialog title when warning the user they need to select something (optional, default `'Select project'`)
-    *   `options.noSelectBody` **[String][126]** Dialog body when warning the user they need to select something (optional, default `'A project needs to be selected to continue'`)
+    *   `options.autoSetActiveProject` **[Boolean][139]** After selecting a project set that project as active in TERA (optional, default `true`)
+    *   `options.title` **[String][130]** The title of the dialog to display (optional, default `"Select a project to work with"`)
+    *   `options.noSelectTitle` **[String][130]** Dialog title when warning the user they need to select something (optional, default `'Select project'`)
+    *   `options.noSelectBody` **[String][130]** Dialog body when warning the user they need to select something (optional, default `'A project needs to be selected to continue'`)
 
-Returns **[Promise][133]<[Project][83]>** The active project
+Returns **[Promise][137]<[Project][83]>** The active project
 
 ## selectProject
 
@@ -652,13 +656,13 @@ Prompt the user to select a project from those available
 
 ### Parameters
 
-*   `options` **[Object][127]?** Additional options to mutate behaviour
+*   `options` **[Object][131]?** Additional options to mutate behaviour
 
-    *   `options.title` **[String][126]** The title of the dialog to display (optional, default `"Select a project to work with"`)
-    *   `options.allowCancel` **[Boolean][135]** Advertise cancelling the operation, the dialog can still be cancelled by closing it (optional, default `true`)
-    *   `options.setActive` **[Boolean][135]** Also set the project as active when selected (optional, default `false`)
+    *   `options.title` **[String][130]** The title of the dialog to display (optional, default `"Select a project to work with"`)
+    *   `options.allowCancel` **[Boolean][139]** Advertise cancelling the operation, the dialog can still be cancelled by closing it (optional, default `true`)
+    *   `options.setActive` **[Boolean][139]** Also set the project as active when selected (optional, default `false`)
 
-Returns **[Promise][133]<[Project][83]>** The active project
+Returns **[Promise][137]<[Project][83]>** The active project
 
 ## getProjectState
 
@@ -666,12 +670,12 @@ Return the current, full snapshot state of the active project
 
 ### Parameters
 
-*   `options` **[Object][127]?** Additional options to mutate behaviour
+*   `options` **[Object][131]?** Additional options to mutate behaviour
 
-    *   `options.autoRequire` **[Boolean][135]** Run `requireProject()` automatically before continuing (optional, default `true`)
-*   `Paths` **[Array][132]<[String][126]>** to subscribe to e.g. \['/users/'],
+    *   `options.autoRequire` **[Boolean][139]** Run `requireProject()` automatically before continuing (optional, default `true`)
+*   `Paths` **[Array][136]<[String][130]>** to subscribe to e.g. \['/users/'],
 
-Returns **[Promise][133]<[Object][127]>** The current project state snapshot
+Returns **[Promise][137]<[Object][131]>** The current project state snapshot
 
 ## setProjectState
 
@@ -683,13 +687,13 @@ Paths can be any valid Lodash.set() value such as:
 
 ### Parameters
 
-*   `path` **([String][126] | [Array][132]<[String][126]>)** The sub-path within the project state to set
+*   `path` **([String][130] | [Array][136]<[String][130]>)** The sub-path within the project state to set
 *   `value` **any** The value to set
-*   `options` **[Object][127]?** Additional options to mutate behaviour
+*   `options` **[Object][131]?** Additional options to mutate behaviour
 
-    *   `options.save` **[Boolean][135]** Save the changes to the server immediately, disable to queue up multiple writes (optional, default `true`)
+    *   `options.save` **[Boolean][139]** Save the changes to the server immediately, disable to queue up multiple writes (optional, default `true`)
 
-Returns **[Promise][133]** A promise which resolves when the operation has been dispatched to the server
+Returns **[Promise][137]** A promise which resolves when the operation has been dispatched to the server
 
 ## setProjectStateDefaults
 
@@ -699,17 +703,31 @@ Set a nested value within the project state - just like `setProjectState()` - bu
 
 ### Parameters
 
-*   `path` **([String][126] | [Array][132]<[String][126]>)** The sub-path within the project state to set
+*   `path` **([String][130] | [Array][136]<[String][130]>)** The sub-path within the project state to set
 *   `value` **any** The value to set
-*   `options` **[Object][127]?** Additional options to mutate behaviour, see setProjectState() for the full list of supported options
+*   `options` **[Object][131]?** Additional options to mutate behaviour, see setProjectState() for the full list of supported options
 
-Returns **[Promise][133]<[Boolean][135]>** A promise which resolves to whether any changes were made - True if defaults were applied, false otherwise
+Returns **[Promise][137]<[Boolean][139]>** 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][137]** 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][137]** A promise which resolves when the operation has completed
 
 ## saveProjectState
 
 Force-Save the currently active project state
 
-Returns **[Promise][133]** A promise which resolves when the operation has completed
+Returns **[Promise][137]** A promise which resolves when the operation has completed
 
 ## replaceProjectState
 
@@ -720,9 +738,9 @@ You almost never want to use this function directly, see `setProjectState(path,
 
 ### Parameters
 
-*   `newState` **[Object][127]** The new state to replace the current state with
+*   `newState` **[Object][131]** The new state to replace the current state with
 
-Returns **[Promise][133]** A promise which resolves when the operation has completed
+Returns **[Promise][137]** A promise which resolves when the operation has completed
 
 ## applyProjectStatePatch
 
@@ -730,9 +748,9 @@ Apply a computed `just-diff` patch to the current project state
 
 ### Parameters
 
-*   `Patch` **[Object][127]** to apply
+*   `Patch` **[Object][131]** to apply
 
-Returns **[Promise][133]** A promise which resolves when the operation has completed
+Returns **[Promise][137]** A promise which resolves when the operation has completed
 
 ## subscribeProjectState
 
@@ -740,7 +758,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][133]<[Function][139]>** A promise which resolves when a subscription has been created, call the resulting function to unsubscribe
+Returns **[Promise][137]<[Function][143]>** A promise which resolves when a subscription has been created, call the resulting function to unsubscribe
 
 ## FileFilters
 
@@ -748,10 +766,10 @@ Data structure for a file filter
 
 ### Properties
 
-*   `library` **[Boolean][135]?** Restrict to library files only
-*   `filename` **[String][126]?** CSV of @momsfriendlydevco/match expressions to filter the filename by (filenames are the basename sans extension)
-*   `basename` **[String][126]?** CSV of @momsfriendlydevco/match expressions to filter the basename by
-*   `ext` **[String][126]?** CSV of @momsfriendlydevco/match expressions to filter the file extension by
+*   `library` **[Boolean][139]?** Restrict to library files only
+*   `filename` **[String][130]?** CSV of @momsfriendlydevco/match expressions to filter the filename by (filenames are the basename sans extension)
+*   `basename` **[String][130]?** CSV of @momsfriendlydevco/match expressions to filter the basename by
+*   `ext` **[String][130]?** CSV of @momsfriendlydevco/match expressions to filter the file extension by
 
 ## selectProjectFile
 
@@ -759,20 +777,20 @@ Prompt the user to select a library to operate on
 
 ### Parameters
 
-*   `options` **[Object][127]?** Additional options to mutate behaviour
+*   `options` **[Object][131]?** Additional options to mutate behaviour
 
-    *   `options.title` **[String][126]** The title of the dialog to display (optional, default `"Select a file"`)
-    *   `options.hint` **([String][126] | [Array][132]<[String][126]>)?** Hints to identify the file to select in array order of preference
-    *   `options.save` **[Boolean][135]** 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][104]?** Optional file filters
-    *   `options.allowUpload` **[Boolean][135]** Allow uploading new files (optional, default `true`)
-    *   `options.allowRefresh` **[Boolean][135]** Allow the user to manually refresh the file list (optional, default `true`)
-    *   `options.allowDownloadZip` **[Boolean][135]** Allow the user to download a Zip of all files (optional, default `true`)
-    *   `options.allowCancel` **[Boolean][135]** Allow cancelling the operation. Will throw `'CANCEL'` as the promise rejection if acationed (optional, default `true`)
-    *   `options.autoRequire` **[Boolean][135]** Run `requireProject()` automatically before continuing (optional, default `true`)
-    *   `options.filter` **[FileFilters][104]?** Optional file filters
+    *   `options.title` **[String][130]** The title of the dialog to display (optional, default `"Select a file"`)
+    *   `options.hint` **([String][130] | [Array][136]<[String][130]>)?** Hints to identify the file to select in array order of preference
+    *   `options.save` **[Boolean][139]** 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][106]?** Optional file filters
+    *   `options.allowUpload` **[Boolean][139]** Allow uploading new files (optional, default `true`)
+    *   `options.allowRefresh` **[Boolean][139]** Allow the user to manually refresh the file list (optional, default `true`)
+    *   `options.allowDownloadZip` **[Boolean][139]** Allow the user to download a Zip of all files (optional, default `true`)
+    *   `options.allowCancel` **[Boolean][139]** Allow cancelling the operation. Will throw `'CANCEL'` as the promise rejection if acationed (optional, default `true`)
+    *   `options.autoRequire` **[Boolean][139]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.filter` **[FileFilters][106]?** Optional file filters
 
-Returns **[Promise][133]<[ProjectFile][1]>** The eventually selected file
+Returns **[Promise][137]<[ProjectFile][1]>** The eventually selected file
 
 ## setProjectFile
 
@@ -780,10 +798,10 @@ Replace a project files contents
 
 ### Parameters
 
-*   `path` **[String][126]** File path to write
-*   `contents` **(File | [Blob][130] | [FormData][131] | [Object][127] | [Array][132])** The new file contents
+*   `path` **[String][130]** File path to write
+*   `contents` **(File | [Blob][134] | [FormData][135] | [Object][131] | [Array][136])** The new file contents
 
-Returns **[Promise][133]** A promise which will resolve when the write operation has completed
+Returns **[Promise][137]** A promise which will resolve when the write operation has completed
 
 ## selectProjectLibrary
 
@@ -791,18 +809,18 @@ Prompt the user to select a library to operate on and return a array of referenc
 
 ### Parameters
 
-*   `options` **[Object][127]?** Additional options to mutate behaviour
+*   `options` **[Object][131]?** Additional options to mutate behaviour
 
-    *   `options.title` **[String][126]** The title of the dialog to display (optional, default `"Select a citation library"`)
-    *   `options.hint` **([String][126] | [Array][132]<[String][126]>)?** 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][135]** Allow uploading new files (optional, default `true`)
-    *   `options.allowRefresh` **[Boolean][135]** Allow the user to manually refresh the file list (optional, default `true`)
-    *   `options.allowDownloadZip` **[Boolean][135]** Allow the user to download a Zip of all files (optional, default `true`)
-    *   `options.allowCancel` **[Boolean][135]** Allow cancelling the operation. Will throw `'CANCEL'` as the promise rejection if acationed (optional, default `true`)
-    *   `options.autoRequire` **[Boolean][135]** Run `requireProject()` automatically before continuing (optional, default `true`)
-    *   `options.filters` **[FileFilters][104]?** Optional file filters, defaults to citation library selection only
+    *   `options.title` **[String][130]** The title of the dialog to display (optional, default `"Select a citation library"`)
+    *   `options.hint` **([String][130] | [Array][136]<[String][130]>)?** 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][139]** Allow uploading new files (optional, default `true`)
+    *   `options.allowRefresh` **[Boolean][139]** Allow the user to manually refresh the file list (optional, default `true`)
+    *   `options.allowDownloadZip` **[Boolean][139]** Allow the user to download a Zip of all files (optional, default `true`)
+    *   `options.allowCancel` **[Boolean][139]** Allow cancelling the operation. Will throw `'CANCEL'` as the promise rejection if acationed (optional, default `true`)
+    *   `options.autoRequire` **[Boolean][139]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.filters` **[FileFilters][106]?** Optional file filters, defaults to citation library selection only
 
-Returns **[Promise][133]<[Array][132]\<Ref>>** A collection of references from the selected file
+Returns **[Promise][137]<[Array][136]\<Ref>>** A collection of references from the selected file
 
 ## getProjectLibrary
 
@@ -810,15 +828,15 @@ Fetch + convert a project file into a library of citations
 
 ### Parameters
 
-*   `path` **[String][126]** File path to read, if omitted the contents of `options` are used to guess at a suitable file
-*   `options` **[Object][127]?** Additional options to mutate behaviour
+*   `path` **[String][130]** File path to read, if omitted the contents of `options` are used to guess at a suitable file
+*   `options` **[Object][131]?** Additional options to mutate behaviour
 
-    *   `options.format` **[String][126]** 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][135]** Run `requireProject()` automatically before continuing (optional, default `true`)
-    *   `options.filter` **[Function][139]?** Optional async file filter, called each time as `(File:ProjectFile)`
-    *   `options.find` **[Function][139]?** Optional async final stage file filter to reduce all candidates down to one subject file
+    *   `options.format` **[String][130]** 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][139]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.filter` **[Function][143]?** Optional async file filter, called each time as `(File:ProjectFile)`
+    *   `options.find` **[Function][143]?** Optional async final stage file filter to reduce all candidates down to one subject file
 
-Returns **([Promise][133]<[Array][132]\<Ref>> | [Promise][133]\<any>)** A collection of references (default bevahiour) or a whatever format was requested
+Returns **([Promise][137]<[Array][136]\<Ref>> | [Promise][137]\<any>)** A collection of references (default bevahiour) or a whatever format was requested
 
 ## setProjectLibrary
 
@@ -826,33 +844,33 @@ Save back a citation library from some input
 
 ### Parameters
 
-*   `path` **[String][126]?** File path to save back to, if omitted one will be prompted for
-*   `refs` **([Array][132]\<RefLibRef> | [Blob][130] | File)?** Collection of references for the selected library or the raw Blob/File
-*   `options` **[Object][127]?** Additional options to mutate behaviour
+*   `path` **[String][130]?** File path to save back to, if omitted one will be prompted for
+*   `refs` **([Array][136]\<RefLibRef> | [Blob][134] | File)?** Collection of references for the selected library or the raw Blob/File
+*   `options` **[Object][131]?** Additional options to mutate behaviour
 
-    *   `options.path` **[String][126]?** Alternate method to specify the path to save as, if omitted one will be prompted for
-    *   `options.refs` **([Array][132]\<RefLibRef> | [Blob][130] | File)?** Alternate method to specify the refs to save as an array or raw Blob/File
-    *   `options.format` **[String][126]** 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][135]** Run `requireProject()` automatically before continuing (optional, default `true`)
-    *   `options.hint` **[String][126]?** Hint to store against the library. Generally corresponds to the current operation being performed - e.g. 'deduped'
-    *   `options.filename` **[String][126]?** Suggested filename if path is unspecified
-    *   `options.title` **[String][126]** Dialog title if path is unspecified and we need to prompt (optional, default `'Save citation library'`)
-    *   `options.overwrite` **[Boolean][135]** Allow existing file upsert (optional, default `true`)
-    *   `options.meta` **[Object][127]?** Optional meta data to merge into the file data
+    *   `options.path` **[String][130]?** Alternate method to specify the path to save as, if omitted one will be prompted for
+    *   `options.refs` **([Array][136]\<RefLibRef> | [Blob][134] | File)?** Alternate method to specify the refs to save as an array or raw Blob/File
+    *   `options.format` **[String][130]** 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][139]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.hint` **[String][130]?** Hint to store against the library. Generally corresponds to the current operation being performed - e.g. 'deduped'
+    *   `options.filename` **[String][130]?** Suggested filename if path is unspecified
+    *   `options.title` **[String][130]** Dialog title if path is unspecified and we need to prompt (optional, default `'Save citation library'`)
+    *   `options.overwrite` **[Boolean][139]** Allow existing file upsert (optional, default `true`)
+    *   `options.meta` **[Object][131]?** Optional meta data to merge into the file data
 
-Returns **[Promise][133]** A promise which resolves when the save operation has completed
+Returns **[Promise][137]** 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][140] for the full list
+The required log object can be of various forms. See [https://tera-tools.com/api/logs.json][144] for the full list
 
 ### Parameters
 
-*   `log` **[Object][127]** The log entry to create
+*   `log` **[Object][131]** The log entry to create
 
-Returns **[Promise][133]** A promise which resolves when the operation has completed
+Returns **[Promise][137]** A promise which resolves when the operation has completed
 
 ## setPageUrl
 
@@ -861,7 +879,16 @@ This only really makes a difference to tools within the tera-tools.com site wher
 
 ### Parameters
 
-*   `url` **[String][126]** The URL to restore on next refresh
+*   `url` **[String][130]** The URL to restore on next refresh
+
+## setPageTitle
+
+Set the active page title
+This is usually called by a tool nested within the tera-tools.com embed
+
+### Parameters
+
+*   `title` **[String][130]** The current page title
 
 ## uiAlert
 
@@ -869,13 +896,13 @@ Display simple text within TERA
 
 ### Parameters
 
-*   `text` **[String][126]** The text to display
-*   `options` **[Object][127]?** Additional options to mutate behaviour
+*   `text` **[String][130]** The text to display
+*   `options` **[Object][131]?** Additional options to mutate behaviour
 
-    *   `options.title` **[String][126]** The title of the alert box (optional, default `'TERA'`)
-    *   `options.isHtml` **[Boolean][135]** If falsy the text is rendered as plain-text otherwise it will be assumed as HTML content (optional, default `false`)
+    *   `options.title` **[String][130]** The title of the alert box (optional, default `'TERA'`)
+    *   `options.isHtml` **[Boolean][139]** If falsy the text is rendered as plain-text otherwise it will be assumed as HTML content (optional, default `false`)
 
-Returns **[Promise][133]** A promise which resolves when the alert has been dismissed
+Returns **[Promise][137]** A promise which resolves when the alert has been dismissed
 
 ## uiSplat
 
@@ -884,10 +911,10 @@ This function is ideally called within a requestFocus() wrapper
 
 ### Parameters
 
-*   `content` **(DOMElement | [String][126] | `false`)** Either a prepared DOM element or string to compile, set to falsy to remove existing content
-*   `options` **[Object][127]?** Additional options to mutate behaviour
+*   `content` **(DOMElement | [String][130] | `false`)** Either a prepared DOM element or string to compile, set to falsy to remove existing content
+*   `options` **[Object][131]?** Additional options to mutate behaviour
 
-    *   `options.logo` **([Boolean][135] | [String][126])** Add a logo to the output, if boolean true the Tera-tools logo is used otherwise specify a path or URL (optional, default `false`)
+    *   `options.logo` **([Boolean][139] | [String][130])** Add a logo to the output, if boolean true the Tera-tools logo is used otherwise specify a path or URL (optional, default `false`)
 
 ## uiWindow
 
@@ -895,13 +922,13 @@ Open a popup window containing a new site
 
 ### Parameters
 
-*   `url` **[String][126]** The URL to open
-*   `options` **[Object][127]?** Additional options to mutate behaviour
+*   `url` **[String][130]** The URL to open
+*   `options` **[Object][131]?** Additional options to mutate behaviour
 
-    *   `options.width` **[Number][129]** The desired width of the window (optional, default `500`)
-    *   `options.height` **[Number][129]** The desired height of the window (optional, default `600`)
-    *   `options.center` **[Boolean][135]** Attempt to center the window on the screen (optional, default `true`)
-    *   `options.permissions` **[Object][127]?** Additional permissions to set on opening, defaults to a suitable set of permission for popups (see code)
+    *   `options.width` **[Number][133]** The desired width of the window (optional, default `500`)
+    *   `options.height` **[Number][133]** The desired height of the window (optional, default `600`)
+    *   `options.center` **[Boolean][139]** Attempt to center the window on the screen (optional, default `true`)
+    *   `options.permissions` **[Object][131]?** 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)
 
@@ -1099,88 +1126,96 @@ Returns **WindowProxy** The opened window object (if `noopener` is not set in pe
 
 [97]: #parameters-27
 
-[98]: #saveprojectstate
+[98]: #setprojectstateflush
+
+[99]: #setprojectstaterefresh
+
+[100]: #saveprojectstate
+
+[101]: #replaceprojectstate
+
+[102]: #parameters-28
 
-[99]: #replaceprojectstate
+[103]: #applyprojectstatepatch
 
-[100]: #parameters-28
+[104]: #parameters-29
 
-[101]: #applyprojectstatepatch
+[105]: #subscribeprojectstate
 
-[102]: #parameters-29
+[106]: #filefilters
 
-[103]: #subscribeprojectstate
+[107]: #properties-5
 
-[104]: #filefilters
+[108]: #selectprojectfile-1
 
-[105]: #properties-5
+[109]: #parameters-30
 
-[106]: #selectprojectfile-1
+[110]: #setprojectfile
 
-[107]: #parameters-30
+[111]: #parameters-31
 
-[108]: #setprojectfile
+[112]: #selectprojectlibrary
 
-[109]: #parameters-31
+[113]: #parameters-32
 
-[110]: #selectprojectlibrary
+[114]: #getprojectlibrary
 
-[111]: #parameters-32
+[115]: #parameters-33
 
-[112]: #getprojectlibrary
+[116]: #setprojectlibrary
 
-[113]: #parameters-33
+[117]: #parameters-34
 
-[114]: #setprojectlibrary
+[118]: #projectlog
 
-[115]: #parameters-34
+[119]: #parameters-35
 
-[116]: #projectlog
+[120]: #setpageurl
 
-[117]: #parameters-35
+[121]: #parameters-36
 
-[118]: #setpageurl
+[122]: #setpagetitle
 
-[119]: #parameters-36
+[123]: #parameters-37
 
-[120]: #uialert
+[124]: #uialert
 
-[121]: #parameters-37
+[125]: #parameters-38
 
-[122]: #uisplat
+[126]: #uisplat
 
-[123]: #parameters-38
+[127]: #parameters-39
 
-[124]: #uiwindow
+[128]: #uiwindow
 
-[125]: #parameters-39
+[129]: #parameters-40
 
-[126]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+[130]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-[127]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+[131]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
 
-[128]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date
+[132]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date
 
-[129]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+[133]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
-[130]: https://developer.mozilla.org/docs/Web/API/Blob
+[134]: https://developer.mozilla.org/docs/Web/API/Blob
 
-[131]: https://developer.mozilla.org/docs/Web/API/FormData
+[135]: https://developer.mozilla.org/docs/Web/API/FormData
 
-[132]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[136]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[133]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+[137]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
-[134]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm
+[138]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm
 
-[135]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+[139]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
 
-[136]: https://developer.mozilla.org/docs/Web/API/Window
+[140]: https://developer.mozilla.org/docs/Web/API/Window
 
-[137]: https://developer.mozilla.org/docs/Web/API/MessageEvent
+[141]: https://developer.mozilla.org/docs/Web/API/MessageEvent
 
-[138]: http://jsonpatch.com
+[142]: http://jsonpatch.com
 
-[139]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+[143]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
 
-[140]: https://tera-tools.com/api/logs.json
+[144]: https://tera-tools.com/api/logs.json