npm - @iebh/tera-fy - Versions diffs - 1.4.3 → 1.5.0 - Mend

@iebh/tera-fy 1.4.3 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/api.md CHANGED Viewed

@@ -121,12 +121,14 @@
     *   [Parameters][117]
 *   [setPageUrl][118]
     *   [Parameters][119]
-*   [uiAlert][120]
+*   [setPageTitle][120]
     *   [Parameters][121]
-*   [uiSplat][122]
+*   [uiAlert][122]
     *   [Parameters][123]
-*   [uiWindow][124]
+*   [uiSplat][124]
     *   [Parameters][125]
+*   [uiWindow][126]
+    *   [Parameters][127]
 ## ProjectFile
@@ -136,99 +138,99 @@ A project file fetched from TERA
 A UUID string representing the unique ID of the file
-Type: [String][126]
+Type: [String][128]
 ### name
 Relative name path (can contain prefix directories) for the human readable file name
-Type: [String][126]
+Type: [String][128]
 ### icon
 CSS class to use as the file icon
-Type: [String][126]
+Type: [String][128]
 ### path
 Full path to the file
 This is also used as the unique identifier within the project
-Type: [String][126]
+Type: [String][128]
 ### parsedName
 An object representing meta file parts of a file name
-Type: [Object][127]
+Type: [Object][129]
 #### 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][128]** The filename + extention (i.e. everything without directory name)
+*   `filename` **[String][128]** The file portion of the name (basename without the extension)
+*   `ext` **[String][128]** The extension portion of the name (always lower case)
+*   `dirName` **[String][128]** The directory path portion of the name
 ### created
 A date representing when the file was created
-Type: [Date][128]
+Type: [Date][130]
 ### createdFormatted
 A human readable, formatted version of "created"
-Type: [String][126]
+Type: [String][128]
 ### modified
 A date representing when the file was created
-Type: [Date][128]
+Type: [Date][130]
 ### modifiedFormatted
 A human readable, formatted version of "modified"
-Type: [String][126]
+Type: [String][128]
 ### accessed
 A date representing when the file was last accessed
-Type: [Date][128]
+Type: [Date][130]
 ### accessedFormatted
 A human readable, formatted version of "accessed"
-Type: [String][126]
+Type: [String][128]
 ### size
 Size, in bytes, of the file
-Type: [Number][129]
+Type: [Number][131]
 ### sizeFormatted
 A human readable, formatted version of the file size
-Type: [String][126]
+Type: [String][128]
 ### mime
 The associated mime type for the file
-Type: [String][126]
+Type: [String][128]
 ### meta
 Additional meta information for the file
-Type: [Object][127]
+Type: [Object][129]
 ### getContents
@@ -246,9 +248,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][132] | [FormData][133] | [Object][129] | [Array][134])** The new file contents
-Returns **[Promise][133]** A promise which resolves when the operation has completed
+Returns **[Promise][135]** A promise which resolves when the operation has completed
 ### getRefs
@@ -256,7 +258,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][135]<[Array][134]\<Ref>>** An eventual array of RefLib references
 ### setRefs
@@ -267,18 +269,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][134]\<RefLibRef>** of references for the selected library
-Returns **[Promise][133]** A promise which resolves when the operation has completed
+Returns **[Promise][135]** 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][136]
 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][129]** A Structured Clone compatible representation of this ProjectFile instance
 ### deserialize
@@ -286,7 +288,7 @@ Restore an entity created with serialize
 #### Parameters
-*   `data` **[Object][127]** An input object created via `ProjectFiles.serialize()`
+*   `data` **[Object][129]** An input object created via `ProjectFiles.serialize()`
 Returns **[ProjectFile][1]** A ProjectFile instance setup against the deserializzed data
@@ -306,19 +308,19 @@ Main Tera-Fy Client (class singleton) to be used in a frontend browser
 Various settings to configure behaviour
-Type: [Object][127]
+Type: [Object][129]
 #### 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][137]** Operate in devMode - i.e. force outer refresh when encountering an existing TeraFy instance
+*   `verbosity` **[Number][131]** 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][128]** Method to use when all method detection fails
+*   `modeTimeout` **[Number][131]** How long entities have in 'detect' mode to identify themselves
+*   `siteUrl` **[String][128]** The TERA URL to connect to
+*   `restrictOrigin` **[String][128]** URL to restrict communications to
+*   `List` **[Array][134]<[String][128]>** of sandbox allowables for the embedded if in embed mode
+*   `handshakeInterval` **[Number][131]** Interval in milliseconds when sanning for a handshake
 ### events
@@ -330,13 +332,13 @@ Type: Mitt
 DOMElements for this TeraFy instance
-Type: [Object][127]
+Type: [Object][129]
 #### 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][138]** The popup window context (if `settings.mode == 'popup'`)
 *   `stylesheet` **DOMElement** The corresponding stylesheet
 ### methods
@@ -344,13 +346,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][134]<[String][128]>
 ### plugins
 Loaded plugins via Use()
-Type: [Array][132]\<TeraFyPlugin>
+Type: [Array][134]\<TeraFyPlugin>
 ### send
@@ -358,9 +360,9 @@ Send a message + wait for a response object
 #### Parameters
-*   `message` **[Object][127]** Message object to send
+*   `message` **[Object][129]** Message object to send
-Returns **[Promise][133]\<any>** A promise which resolves when the operation has completed with the remote reply
+Returns **[Promise][135]\<any>** A promise which resolves when the operation has completed with the remote reply
 ### sendRaw
@@ -369,7 +371,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][129]** Message object to send
 ### rpc
@@ -377,10 +379,10 @@ Call an RPC function in the server instance
 #### Parameters
-*   `method` **[String][126]** The method name to call
+*   `method` **[String][128]** The method name to call
 *   `args` **...any**&#x20;
-Returns **[Promise][133]\<any>** The resolved output of the server function
+Returns **[Promise][135]\<any>** The resolved output of the server function
 ### acceptMessage
@@ -389,7 +391,7 @@ Accept an incoming message
 #### Parameters
 *   `rawMessage` &#x20;
-*   `Raw` **[MessageEvent][137]** message event to process
+*   `Raw` **[MessageEvent][139]** message event to process
 ### acceptPostboxes
@@ -398,27 +400,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][140] 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][129]** The local projectState to accept
+*   `oldState` **[Object][129]** The previous projectState to examine against
-Returns **[Promise][133]** A promise which will resolve when the operation has completed
+Returns **[Promise][135]** 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][140] standard
 This function is expected to be sub-classed by a plugin
 #### Parameters
-*   `patch` **[Array][132]** A JSPatch patch to apply
+*   `patch` **[Array][134]** A JSPatch patch to apply
-Returns **[Promise][133]** A promise which will resolve when the operation has completed
+Returns **[Promise][135]** A promise which will resolve when the operation has completed
 ### init
@@ -427,28 +429,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][129]?** 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][135]<[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][135]<[String][128]>** 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][135]** 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][135]** 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 +465,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][131]** The verbosity level to trigger at. If `settings.verbosity` is lower than this, the message is ignored (optional, default `1`)
 ### set
@@ -472,7 +474,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][128] | [Object][129])** 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 +487,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][128] | [Object][129])** 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 +499,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][129]?** Additional options to mutate behaviour during construction (pass options to init() to intialize later options)
+*   `The` **[Object][129]** module function to include. Invoked as `(teraClient:TeraFy, options:Object)`
 Returns **[TeraFy][29]** This chainable terafy instance
@@ -508,8 +510,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][129]** Initalied class instance to extend
+*   `source` **[Object][129]** Initalized source object to extend from
 ### toggleDevMode
@@ -517,7 +519,7 @@ Set or toggle devMode
 #### Parameters
-*   `devModeEnabled` **([String][126] | [Boolean][135])** Optional boolean to force dev mode (optional, default `'toggle'`)
+*   `devModeEnabled` **([String][128] | [Boolean][137])** Optional boolean to force dev mode (optional, default `'toggle'`)
 Returns **[TeraFy][29]** This chainable terafy instance
@@ -528,7 +530,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][128] | [Boolean][137])** Whether to fullscreen the embedded component (optional, default `'toggle'`)
 ### selectProjectFile
@@ -540,7 +542,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][135]** A promise which will resolve if the there is a user and they are logged in
 ### getProjectFiles
@@ -548,12 +550,12 @@ Fetch the files associated with a given project
 #### Parameters
-*   `options` **[Object][127]** Options which mutate behaviour
+*   `options` **[Object][129]** 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][137]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.meta` **[Boolean][137]** 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][135]<[Array][134]<[ProjectFile][1]>>** A collection of project files for the given project
 ### getProjectFile
@@ -561,9 +563,9 @@ Fetch a project file
 #### Parameters
-*   `path` **[String][126]** File path to read
+*   `path` **[String][128]** File path to read
-Returns **[Promise][133]<[Blob][130]>** The eventual fetched file as a blob
+Returns **[Promise][135]<[Blob][132]>** The eventual fetched file as a blob
 ## handshake
@@ -571,9 +573,9 @@ Return basic server information as a form of validation
 ### Properties
-*   `date` **[Date][128]** Server date
+*   `date` **[Date][130]** Server date
-Returns **[Promise][133]<[Object][127]>** Basic promise result
+Returns **[Promise][135]<[Object][129]>** Basic promise result
 ## User
@@ -581,16 +583,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][128]** Unique identifier of the user
+*   `email` **[String][128]** The email address of the current user
+*   `name` **[String][128]** The provided full name of the user
+*   `isSubscribed` **[Boolean][137]** 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][135]<[User][78]>** The current logged in user or null if none
 ## requireUser
@@ -600,11 +602,11 @@ This is an pre-requisite step for requireProject()
 ### Parameters
-*   `options` **[Object][127]?** Additional options to mutate behaviour
+*   `options` **[Object][129]?** Additional options to mutate behaviour
-    *   `options.forceRetry` **[Boolean][135]** Forcabily try to refresh the user state (optional, default `false`)
+    *   `options.forceRetry` **[Boolean][137]** 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][135]<[User][78]>** The current logged in user or null if none
 ## Project
@@ -614,13 +616,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][135]<([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][135]<[Array][134]<[Project][83]>>** Collection of projects the user has access to
 ## setActiveProject
@@ -628,7 +630,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][129] | [String][128])** The project to set as active - either the full Project object or its ID
 ## requireProject
@@ -637,14 +639,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][129]?** 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][137]** After selecting a project set that project as active in TERA (optional, default `true`)
+    *   `options.title` **[String][128]** The title of the dialog to display (optional, default `"Select a project to work with"`)
+    *   `options.noSelectTitle` **[String][128]** Dialog title when warning the user they need to select something (optional, default `'Select project'`)
+    *   `options.noSelectBody` **[String][128]** 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][135]<[Project][83]>** The active project
 ## selectProject
@@ -652,13 +654,13 @@ Prompt the user to select a project from those available
 ### Parameters
-*   `options` **[Object][127]?** Additional options to mutate behaviour
+*   `options` **[Object][129]?** 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][128]** The title of the dialog to display (optional, default `"Select a project to work with"`)
+    *   `options.allowCancel` **[Boolean][137]** Advertise cancelling the operation, the dialog can still be cancelled by closing it (optional, default `true`)
+    *   `options.setActive` **[Boolean][137]** Also set the project as active when selected (optional, default `false`)
-Returns **[Promise][133]<[Project][83]>** The active project
+Returns **[Promise][135]<[Project][83]>** The active project
 ## getProjectState
@@ -666,12 +668,12 @@ Return the current, full snapshot state of the active project
 ### Parameters
-*   `options` **[Object][127]?** Additional options to mutate behaviour
+*   `options` **[Object][129]?** 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][137]** Run `requireProject()` automatically before continuing (optional, default `true`)
+*   `Paths` **[Array][134]<[String][128]>** to subscribe to e.g. \['/users/'],
-Returns **[Promise][133]<[Object][127]>** The current project state snapshot
+Returns **[Promise][135]<[Object][129]>** The current project state snapshot
 ## setProjectState
@@ -683,13 +685,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][128] | [Array][134]<[String][128]>)** 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][129]?** 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][137]** 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][135]** A promise which resolves when the operation has been dispatched to the server
 ## setProjectStateDefaults
@@ -699,17 +701,17 @@ 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][128] | [Array][134]<[String][128]>)** 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][129]?** 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][135]<[Boolean][137]>** A promise which resolves to whether any changes were made - True if defaults were applied, false otherwise
 ## saveProjectState
 Force-Save the currently active project state
-Returns **[Promise][133]** A promise which resolves when the operation has completed
+Returns **[Promise][135]** A promise which resolves when the operation has completed
 ## replaceProjectState
@@ -720,9 +722,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][129]** The new state to replace the current state with
-Returns **[Promise][133]** A promise which resolves when the operation has completed
+Returns **[Promise][135]** A promise which resolves when the operation has completed
 ## applyProjectStatePatch
@@ -730,9 +732,9 @@ Apply a computed `just-diff` patch to the current project state
 ### Parameters
-*   `Patch` **[Object][127]** to apply
+*   `Patch` **[Object][129]** to apply
-Returns **[Promise][133]** A promise which resolves when the operation has completed
+Returns **[Promise][135]** A promise which resolves when the operation has completed
 ## subscribeProjectState
@@ -740,7 +742,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][135]<[Function][141]>** A promise which resolves when a subscription has been created, call the resulting function to unsubscribe
 ## FileFilters
@@ -748,10 +750,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][137]?** Restrict to library files only
+*   `filename` **[String][128]?** CSV of @momsfriendlydevco/match expressions to filter the filename by (filenames are the basename sans extension)
+*   `basename` **[String][128]?** CSV of @momsfriendlydevco/match expressions to filter the basename by
+*   `ext` **[String][128]?** CSV of @momsfriendlydevco/match expressions to filter the file extension by
 ## selectProjectFile
@@ -759,20 +761,20 @@ Prompt the user to select a library to operate on
 ### Parameters
-*   `options` **[Object][127]?** Additional options to mutate behaviour
+*   `options` **[Object][129]?** 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.title` **[String][128]** The title of the dialog to display (optional, default `"Select a file"`)
+    *   `options.hint` **([String][128] | [Array][134]<[String][128]>)?** Hints to identify the file to select in array order of preference
+    *   `options.save` **[Boolean][137]** 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.allowUpload` **[Boolean][137]** Allow uploading new files (optional, default `true`)
+    *   `options.allowRefresh` **[Boolean][137]** Allow the user to manually refresh the file list (optional, default `true`)
+    *   `options.allowDownloadZip` **[Boolean][137]** Allow the user to download a Zip of all files (optional, default `true`)
+    *   `options.allowCancel` **[Boolean][137]** Allow cancelling the operation. Will throw `'CANCEL'` as the promise rejection if acationed (optional, default `true`)
+    *   `options.autoRequire` **[Boolean][137]** Run `requireProject()` automatically before continuing (optional, default `true`)
     *   `options.filter` **[FileFilters][104]?** Optional file filters
-Returns **[Promise][133]<[ProjectFile][1]>** The eventually selected file
+Returns **[Promise][135]<[ProjectFile][1]>** The eventually selected file
 ## setProjectFile
@@ -780,10 +782,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][128]** File path to write
+*   `contents` **(File | [Blob][132] | [FormData][133] | [Object][129] | [Array][134])** The new file contents
-Returns **[Promise][133]** A promise which will resolve when the write operation has completed
+Returns **[Promise][135]** A promise which will resolve when the write operation has completed
 ## selectProjectLibrary
@@ -791,18 +793,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][129]?** 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.title` **[String][128]** The title of the dialog to display (optional, default `"Select a citation library"`)
+    *   `options.hint` **([String][128] | [Array][134]<[String][128]>)?** 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][137]** Allow uploading new files (optional, default `true`)
+    *   `options.allowRefresh` **[Boolean][137]** Allow the user to manually refresh the file list (optional, default `true`)
+    *   `options.allowDownloadZip` **[Boolean][137]** Allow the user to download a Zip of all files (optional, default `true`)
+    *   `options.allowCancel` **[Boolean][137]** Allow cancelling the operation. Will throw `'CANCEL'` as the promise rejection if acationed (optional, default `true`)
+    *   `options.autoRequire` **[Boolean][137]** Run `requireProject()` automatically before continuing (optional, default `true`)
     *   `options.filters` **[FileFilters][104]?** 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][135]<[Array][134]\<Ref>>** A collection of references from the selected file
 ## getProjectLibrary
@@ -810,15 +812,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][128]** File path to read, if omitted the contents of `options` are used to guess at a suitable file
+*   `options` **[Object][129]?** 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][128]** 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][137]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.filter` **[Function][141]?** Optional async file filter, called each time as `(File:ProjectFile)`
+    *   `options.find` **[Function][141]?** 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][135]<[Array][134]\<Ref>> | [Promise][135]\<any>)** A collection of references (default bevahiour) or a whatever format was requested
 ## setProjectLibrary
@@ -826,33 +828,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][128]?** File path to save back to, if omitted one will be prompted for
+*   `refs` **([Array][134]\<RefLibRef> | [Blob][132] | File)?** Collection of references for the selected library or the raw Blob/File
+*   `options` **[Object][129]?** 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][128]?** Alternate method to specify the path to save as, if omitted one will be prompted for
+    *   `options.refs` **([Array][134]\<RefLibRef> | [Blob][132] | File)?** Alternate method to specify the refs to save as an array or raw Blob/File
+    *   `options.format` **[String][128]** 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][137]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.hint` **[String][128]?** Hint to store against the library. Generally corresponds to the current operation being performed - e.g. 'deduped'
+    *   `options.filename` **[String][128]?** Suggested filename if path is unspecified
+    *   `options.title` **[String][128]** Dialog title if path is unspecified and we need to prompt (optional, default `'Save citation library'`)
+    *   `options.overwrite` **[Boolean][137]** Allow existing file upsert (optional, default `true`)
+    *   `options.meta` **[Object][129]?** Optional meta data to merge into the file data
-Returns **[Promise][133]** A promise which resolves when the save operation has completed
+Returns **[Promise][135]** 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][142] for the full list
 ### Parameters
-*   `log` **[Object][127]** The log entry to create
+*   `log` **[Object][129]** The log entry to create
-Returns **[Promise][133]** A promise which resolves when the operation has completed
+Returns **[Promise][135]** A promise which resolves when the operation has completed
 ## setPageUrl
@@ -861,7 +863,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][128]** 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][128]** The current page title
 ## uiAlert
@@ -869,13 +880,13 @@ Display simple text within TERA
 ### Parameters
-*   `text` **[String][126]** The text to display
-*   `options` **[Object][127]?** Additional options to mutate behaviour
+*   `text` **[String][128]** The text to display
+*   `options` **[Object][129]?** 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][128]** The title of the alert box (optional, default `'TERA'`)
+    *   `options.isHtml` **[Boolean][137]** 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][135]** A promise which resolves when the alert has been dismissed
 ## uiSplat
@@ -884,10 +895,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][128] | `false`)** Either a prepared DOM element or string to compile, set to falsy to remove existing content
+*   `options` **[Object][129]?** 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][137] | [String][128])** 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 +906,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][128]** The URL to open
+*   `options` **[Object][129]?** 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][131]** The desired width of the window (optional, default `500`)
+    *   `options.height` **[Number][131]** The desired height of the window (optional, default `600`)
+    *   `options.center` **[Boolean][137]** Attempt to center the window on the screen (optional, default `true`)
+    *   `options.permissions` **[Object][129]?** 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)
@@ -1143,44 +1154,48 @@ Returns **WindowProxy** The opened window object (if `noopener` is not set in pe
 [119]: #parameters-36
-[120]: #uialert
+[120]: #setpagetitle
 [121]: #parameters-37
-[122]: #uisplat
+[122]: #uialert
 [123]: #parameters-38
-[124]: #uiwindow
+[124]: #uisplat
 [125]: #parameters-39
-[126]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+[126]: #uiwindow
+[127]: #parameters-40
+[128]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
-[127]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+[129]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
-[128]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date
+[130]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date
-[129]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+[131]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
-[130]: https://developer.mozilla.org/docs/Web/API/Blob
+[132]: https://developer.mozilla.org/docs/Web/API/Blob
-[131]: https://developer.mozilla.org/docs/Web/API/FormData
+[133]: https://developer.mozilla.org/docs/Web/API/FormData
-[132]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[134]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
-[133]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+[135]: 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
+[136]: 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
+[137]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
-[136]: https://developer.mozilla.org/docs/Web/API/Window
+[138]: https://developer.mozilla.org/docs/Web/API/Window
-[137]: https://developer.mozilla.org/docs/Web/API/MessageEvent
+[139]: https://developer.mozilla.org/docs/Web/API/MessageEvent
-[138]: http://jsonpatch.com
+[140]: http://jsonpatch.com
-[139]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+[141]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
-[140]: https://tera-tools.com/api/logs.json
+[142]: https://tera-tools.com/api/logs.json