@iebh/tera-fy 1.0.14 → 1.0.15

package/api.md

@@ -48,35 +48,39 @@
 *   [User][44]
     *   [Properties][45]
 *   [getUser][46]
-*   [Project][47]
-*   [getProject][48]
-*   [getProjects][49]
-*   [setActiveProject][50]
-    *   [Parameters][51]
-*   [requireProject][52]
+*   [requireUser][47]
+*   [][48]
+*   [Project][49]
+*   [getProject][50]
+*   [getProjects][51]
+*   [setActiveProject][52]
     *   [Parameters][53]
-*   [selectProject][54]
+*   [requireProject][54]
     *   [Parameters][55]
-*   [getProjectState][56]
+*   [selectProject][56]
     *   [Parameters][57]
-*   [setProjectState][58]
+*   [getProjectState][58]
     *   [Parameters][59]
-*   [setProjectStateDefaults][60]
+*   [setProjectState][60]
     *   [Parameters][61]
-*   [saveProjectState][62]
-*   [replaceProjectState][63]
-    *   [Parameters][64]
-*   [applyProjectStatePatch][65]
+*   [setProjectStateDefaults][62]
+    *   [Parameters][63]
+*   [saveProjectState][64]
+*   [replaceProjectState][65]
     *   [Parameters][66]
-*   [subscribeProjectState][67]
-*   [ProjectFile][68]
-    *   [Properties][69]
-*   [getProjectFiles][70]
-    *   [Parameters][71]
-*   [getProjectLibrary][72]
+*   [applyProjectStatePatch][67]
+    *   [Parameters][68]
+*   [subscribeProjectState][69]
+*   [ProjectFile][70]
+    *   [Properties][71]
+*   [getProjectFiles][72]
     *   [Parameters][73]
-*   [setProjectLibrary][74]
+*   [getProjectLibrary][74]
     *   [Parameters][75]
+*   [setProjectLibrary][76]
+    *   [Parameters][77]
+*   [uiAlert][78]
+    *   [Parameters][79]
 
 ## TeraFy
 
@@ -86,16 +90,16 @@ Main Tera-Fy Client (class singleton) to be used in a frontend browser
 
 Various settings to configure behaviour
 
-Type: [Object][76]
+Type: [Object][80]
 
 #### Properties
 
-*   `devMode` **[Boolean][77]** Operate in devMode - i.e. force outer refresh when encountering an existing TeraFy instance
+*   `devMode` **[Boolean][81]** Operate in devMode - i.e. force outer refresh when encountering an existing TeraFy instance
 *   `How` **(`"detect"` | `"parent"` | `"child"`)** 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 fallsback to 'child'
-*   `modeTimeout` **[Number][78]** How long entities have in 'detect' mode to identify themselves
-*   `siteUrl` **[String][79]** The TERA URL to connect to
-*   `restrictOrigin` **[String][79]** URL to restrict communications to
-*   `List` **[Array][80]<[String][79]>** of sandbox allowables for the embedded if in embed mode
+*   `modeTimeout` **[Number][82]** How long entities have in 'detect' mode to identify themselves
+*   `siteUrl` **[String][83]** The TERA URL to connect to
+*   `restrictOrigin` **[String][83]** URL to restrict communications to
+*   `List` **[Array][84]<[String][83]>** of sandbox allowables for the embedded if in embed mode
 
 ### events
 
@@ -107,7 +111,7 @@ Type: Mitt
 
 DOMElements for this TeraFy instance
 
-Type: [Object][76]
+Type: [Object][80]
 
 #### Properties
 
@@ -120,13 +124,13 @@ Type: [Object][76]
 List of function stubs mapped here from the server
 This array is forms the reference of `TeraFy.METHOD()` objects to provide locally which will be mapped via `TeraFy.rpc(METHOD, ...args)`
 
-Type: [Array][80]<[String][79]>
+Type: [Array][84]<[String][83]>
 
 ### plugins
 
 Loaded plugins via Use()
 
-Type: [Array][80]\<TeraFyPlugin>
+Type: [Array][84]\<TeraFyPlugin>
 
 ### send
 
@@ -134,9 +138,9 @@ Send a message + wait for a response object
 
 #### Parameters
 
-*   `message` **[Object][76]** Message object to send
+*   `message` **[Object][80]** Message object to send
 
-Returns **[Promise][81]\<any>** A promise which resolves when the operation has completed with the remote reply
+Returns **[Promise][85]\<any>** A promise which resolves when the operation has completed with the remote reply
 
 ### sendRaw
 
@@ -145,7 +149,7 @@ This function does not return or wait for a reply - use `send()` for that
 
 #### Parameters
 
-*   `message` **[Object][76]** Message object to send
+*   `message` **[Object][80]** Message object to send
 
 ### rpc
 
@@ -153,10 +157,10 @@ Call an RPC function in the server instance
 
 #### Parameters
 
-*   `method` **[String][79]** The method name to call
+*   `method` **[String][83]** The method name to call
 *   `args` **...any**&#x20;
 
-Returns **[Promise][81]\<any>** The resolved output of the server function
+Returns **[Promise][85]\<any>** The resolved output of the server function
 
 ### acceptMessage
 
@@ -165,7 +169,7 @@ Accept an incoming message
 #### Parameters
 
 *   `rawMessage` &#x20;
-*   `Raw` **[MessageEvent][82]** message event to process
+*   `Raw` **[MessageEvent][86]** message event to process
 
 ### acceptPostboxes
 
@@ -174,27 +178,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][83] standard
+The transmitted patch follows the [JSPatch][87] standard
 This function accepts an entire projectState instance, computes the delta and transmits that to the server for merging
 
 #### Parameters
 
-*   `newState` **[Object][76]** The local projectState to accept
-*   `oldState` **[Object][76]** The previous projectState to examine against
+*   `newState` **[Object][80]** The local projectState to accept
+*   `oldState` **[Object][80]** The previous projectState to examine against
 
-Returns **[Promise][81]** A promise which will resolve when the operation has completed
+Returns **[Promise][85]** 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][83] standard
+The patch should follow the [JSPatch][87] standard
 This function is expected to be sub-classed by a plugin
 
 #### Parameters
 
-*   `patch` **[Array][80]** A JSPatch patch to apply
+*   `patch` **[Array][84]** A JSPatch patch to apply
 
-Returns **[Promise][81]** A promise which will resolve when the operation has completed
+Returns **[Promise][85]** A promise which will resolve when the operation has completed
 
 ### init
 
@@ -203,22 +207,22 @@ This function can only be called once and will return the existing init() worker
 
 #### Parameters
 
-*   `options` **[Object][76]?** Additional options to merge into `settings` via `set`
+*   `options` **[Object][80]?** Additional options to merge into `settings` via `set`
 
-Returns **[Promise][81]<[TeraFy][1]>** An eventual promise which will resovle with this terafy instance
+Returns **[Promise][85]<[TeraFy][1]>** 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][81]<[String][79]>** A promise which will resolve with the detected mode to use
+Returns **[Promise][85]<[String][83]>** A promise which will resolve with the detected mode to use
 
 ### injectComms
 
 Find an existing active TERA server OR initalize one
 
-Returns **[Promise][81]** A promise which will resolve when the loading has completed and we have found a parent TERA instance or initiallized a child
+Returns **[Promise][85]** A promise which will resolve when the loading has completed and we have found a parent TERA instance or initiallized a child
 
 ### injectStylesheet
 
@@ -245,7 +249,7 @@ This function also routes 'special' keys like `devMode` to their internal handle
 
 #### Parameters
 
-*   `key` **([String][79] | [Object][76])** Either a single setting key to set or an object to merge
+*   `key` **([String][83] | [Object][80])** 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][1]** This chainable terafy instance
@@ -258,7 +262,7 @@ Set or merge settings - but only in dev mode
 
 #### Parameters
 
-*   `key` **([String][79] | [Object][76])** Either a single setting key to set or an object to merge
+*   `key` **([String][83] | [Object][80])** 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][1]** This chainable terafy instance
@@ -270,8 +274,8 @@ Include a TeraFy client plugin
 #### Parameters
 
 *   `mod` &#x20;
-*   `options` **[Object][76]?** Additional options to mutate behaviour during construction (pass options to init() to intialize later options)
-*   `The` **[Object][76]** module function to include. Invoked as `(teraClient:TeraFy, options:Object)`
+*   `options` **[Object][80]?** Additional options to mutate behaviour during construction (pass options to init() to intialize later options)
+*   `The` **[Object][80]** module function to include. Invoked as `(teraClient:TeraFy, options:Object)`
 
 Returns **[TeraFy][1]** This chainable terafy instance
 
@@ -281,8 +285,8 @@ Internal function used by use() to merge an external declared singleton against
 
 #### Parameters
 
-*   `target` **[Object][76]** Initalied class instance to extend
-*   `source` **[Object][76]** Initalized source object to extend from
+*   `target` **[Object][80]** Initalied class instance to extend
+*   `source` **[Object][80]** Initalized source object to extend from
 
 ### toggleDevMode
 
@@ -290,7 +294,7 @@ Set or toggle devMode
 
 #### Parameters
 
-*   `devModeEnabled` **([String][79] | [Boolean][77])** Optional boolean to force dev mode (optional, default `'toggle'`)
+*   `devModeEnabled` **([String][83] | [Boolean][81])** Optional boolean to force dev mode (optional, default `'toggle'`)
 
 Returns **[TeraFy][1]** This chainable terafy instance
 
@@ -301,7 +305,7 @@ This is usually because the server component wants to perform some user activity
 
 #### Parameters
 
-*   `isFocused` **([String][79] | [Boolean][77])** Whether to fullscreen the embedded component (optional, default `'toggle'`)
+*   `isFocused` **([String][83] | [Boolean][81])** Whether to fullscreen the embedded component (optional, default `'toggle'`)
 
 ## handshake
 
@@ -309,9 +313,9 @@ Return basic server information as a form of validation
 
 ### Properties
 
-*   `date` **[Date][84]** Server date
+*   `date` **[Date][88]** Server date
 
-Returns **[Promise][81]<[Object][76]>** Basic promise result
+Returns **[Promise][85]<[Object][80]>** Basic promise result
 
 ## User
 
@@ -319,16 +323,32 @@ User / active session within TERA
 
 ### Properties
 
-*   `id` **[String][79]** Unique identifier of the user
-*   `email` **[String][79]** The email address of the current user
-*   `name` **[String][79]** The provided full name of the user
-*   `isSubscribed` **[Boolean][77]** Whether the active user has a TERA subscription
+*   `id` **[String][83]** Unique identifier of the user
+*   `email` **[String][83]** The email address of the current user
+*   `name` **[String][83]** The provided full name of the user
+*   `isSubscribed` **[Boolean][81]** Whether the active user has a TERA subscription
 
 ## getUser
 
 Fetch the current session user
 
-Returns **[Promise][81]<[User][44]>** The current logged in user or null if none
+Returns **[Promise][85]<[User][44]>** The current logged in user or null if none
+
+## requireUser
+
+Require a user login to TERA
+If there is no user OR they are not logged in a prompt is shown to go and do so
+This is an pre-requisite step for requireProject()
+
+Returns **[Promise][85]** A promise which will resolve if the there is a user and they are logged in
+
+##
+
+Require a user login to TERA
+If there is no user OR they are not logged in a prompt is shown to go and do so
+This is an pre-requisite step for requireProject()
+
+Returns **[Promise][85]** A promise which will resolve if the there is a user and they are logged in
 
 ## Project
 
@@ -338,13 +358,13 @@ Project entry within TERA
 
 Get the currently active project, if any
 
-Returns **[Promise][81]<([Project][47] | null)>** The currently active project, if any
+Returns **[Promise][85]<([Project][49] | null)>** The currently active project, if any
 
 ## getProjects
 
 Get a list of projects the current session user has access to
 
-Returns **[Promise][81]<[Array][80]<[Project][47]>>** Collection of projects the user has access to
+Returns **[Promise][85]<[Array][84]<[Project][49]>>** Collection of projects the user has access to
 
 ## setActiveProject
 
@@ -352,7 +372,7 @@ Set the currently active project within TERA
 
 ### Parameters
 
-*   `project` **([Object][76] | [String][79])** The project to set as active - either the full Project object or its ID
+*   `project` **([Object][80] | [String][83])** The project to set as active - either the full Project object or its ID
 
 ## requireProject
 
@@ -361,14 +381,14 @@ Note that this function will percist in asking the uesr even if they try to canc
 
 ### Parameters
 
-*   `options` **[Object][76]?** Additional options to mutate behaviour
+*   `options` **[Object][80]?** Additional options to mutate behaviour
 
-    *   `options.autoSetActiveProject` **[Boolean][77]** After selecting a project set that project as active in TERA (optional, default `true`)
-    *   `options.title` **[String][79]** The title of the dialog to display (optional, default `"Select a project to work with"`)
-    *   `options.noSelectTitle` **[String][79]** Dialog title when warning the user they need to select something (optional, default `'Select project'`)
-    *   `options.noSelectBody` **[String][79]** Dialog body when warning the user they need to select something (optional, default `'A project needs to be selected to continue'`)
+    *   `options.autoSetActiveProject` **[Boolean][81]** After selecting a project set that project as active in TERA (optional, default `true`)
+    *   `options.title` **[String][83]** The title of the dialog to display (optional, default `"Select a project to work with"`)
+    *   `options.noSelectTitle` **[String][83]** Dialog title when warning the user they need to select something (optional, default `'Select project'`)
+    *   `options.noSelectBody` **[String][83]** Dialog body when warning the user they need to select something (optional, default `'A project needs to be selected to continue'`)
 
-Returns **[Promise][81]<[Project][47]>** The active project
+Returns **[Promise][85]<[Project][49]>** The active project
 
 ## selectProject
 
@@ -376,13 +396,13 @@ Prompt the user to select a project from those available
 
 ### Parameters
 
-*   `options` **[Object][76]?** Additional options to mutate behaviour
+*   `options` **[Object][80]?** Additional options to mutate behaviour
 
-    *   `options.title` **[String][79]** The title of the dialog to display (optional, default `"Select a project to work with"`)
-    *   `options.allowCancel` **[Boolean][77]** Advertise cancelling the operation, the dialog can still be cancelled by closing it (optional, default `true`)
-    *   `options.setActive` **[Boolean][77]** Also set the project as active when selected (optional, default `false`)
+    *   `options.title` **[String][83]** The title of the dialog to display (optional, default `"Select a project to work with"`)
+    *   `options.allowCancel` **[Boolean][81]** Advertise cancelling the operation, the dialog can still be cancelled by closing it (optional, default `true`)
+    *   `options.setActive` **[Boolean][81]** Also set the project as active when selected (optional, default `false`)
 
-Returns **[Promise][81]<[Project][47]>** The active project
+Returns **[Promise][85]<[Project][49]>** The active project
 
 ## getProjectState
 
@@ -390,12 +410,12 @@ Return the current, full snapshot state of the active project
 
 ### Parameters
 
-*   `options` **[Object][76]?** Additional options to mutate behaviour
+*   `options` **[Object][80]?** Additional options to mutate behaviour
 
-    *   `options.autoRequire` **[Boolean][77]** Run `requireProject()` automatically before continuing (optional, default `true`)
-*   `Paths` **[Array][80]<[String][79]>** to subscribe to e.g. \['/users/'],
+    *   `options.autoRequire` **[Boolean][81]** Run `requireProject()` automatically before continuing (optional, default `true`)
+*   `Paths` **[Array][84]<[String][83]>** to subscribe to e.g. \['/users/'],
 
-Returns **[Promise][81]<[Object][76]>** The current project state snapshot
+Returns **[Promise][85]<[Object][80]>** The current project state snapshot
 
 ## setProjectState
 
@@ -407,14 +427,14 @@ Paths can be any valid Lodash.set() value such as:
 
 ### Parameters
 
-*   `path` **([String][79] | [Array][80]<[String][79]>)** The sub-path within the project state to set
+*   `path` **([String][83] | [Array][84]<[String][83]>)** The sub-path within the project state to set
 *   `value` **any** The value to set
-*   `options` **[Object][76]?** Additional options to mutate behaviour
+*   `options` **[Object][80]?** Additional options to mutate behaviour
 
-    *   `options.save` **[Boolean][77]** Save the changes to the server immediately, disable to queue up multiple writes (optional, default `true`)
-    *   `options.sync` **[Boolean][77]** Wait for the server to acknowledge the write, you almost never need to do this (optional, default `false`)
+    *   `options.save` **[Boolean][81]** Save the changes to the server immediately, disable to queue up multiple writes (optional, default `true`)
+    *   `options.sync` **[Boolean][81]** Wait for the server to acknowledge the write, you almost never need to do this (optional, default `false`)
 
-Returns **[Promise][81]** A promise which resolves when the operation has synced with the server
+Returns **[Promise][85]** A promise which resolves when the operation has synced with the server
 
 ## setProjectStateDefaults
 
@@ -424,17 +444,17 @@ Set a nested value within the project state - just like `setProjectState()` - bu
 
 ### Parameters
 
-*   `path` **([String][79] | [Array][80]<[String][79]>)** The sub-path within the project state to set
+*   `path` **([String][83] | [Array][84]<[String][83]>)** The sub-path within the project state to set
 *   `value` **any** The value to set
-*   `options` **[Object][76]?** Additional options to mutate behaviour, see setProjectState() for the full list of supported options
+*   `options` **[Object][80]?** Additional options to mutate behaviour, see setProjectState() for the full list of supported options
 
-Returns **[Promise][81]<[Boolean][77]>** A promise which resolves to whether any changes were made - True if defaults were applied, false otherwise
+Returns **[Promise][85]<[Boolean][81]>** 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][81]** A promise which resolves when the operation has completed
+Returns **[Promise][85]** A promise which resolves when the operation has completed
 
 ## replaceProjectState
 
@@ -445,9 +465,9 @@ You almost never want to use this function directly, see `setProjectState(path,
 
 ### Parameters
 
-*   `newState` **[Object][76]** The new state to replace the current state with
+*   `newState` **[Object][80]** The new state to replace the current state with
 
-Returns **[Promise][81]** A promise which resolves when the operation has completed
+Returns **[Promise][85]** A promise which resolves when the operation has completed
 
 ## applyProjectStatePatch
 
@@ -455,9 +475,9 @@ Apply a computed `just-diff` patch to the current project state
 
 ### Parameters
 
-*   `Patch` **[Object][76]** to apply
+*   `Patch` **[Object][80]** to apply
 
-Returns **[Promise][81]** A promise which resolves when the operation has completed
+Returns **[Promise][85]** A promise which resolves when the operation has completed
 
 ## subscribeProjectState
 
@@ -465,7 +485,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][81]<[Function][85]>** A promise which resolves when a subscription has been created, call the resulting function to unsubscribe
+Returns **[Promise][85]<[Function][89]>** A promise which resolves when a subscription has been created, call the resulting function to unsubscribe
 
 ## ProjectFile
 
@@ -473,19 +493,19 @@ Data structure for a project file
 
 ### Properties
 
-*   `id` **[String][79]** A UUID string representing the unique ID of the file
-*   `name` **[String][79]** Relative name path (can contain prefix directories) for the human readable file name
-*   `parsedName` **[Object][76]** An object representing meta file parts of a file name
+*   `id` **[String][83]** A UUID string representing the unique ID of the file
+*   `name` **[String][83]** Relative name path (can contain prefix directories) for the human readable file name
+*   `parsedName` **[Object][80]** An object representing meta file parts of a file name
 
-    *   `parsedName.basename` **[String][79]** The filename + extention (i.e. everything without directory name)
-    *   `parsedName.filename` **[String][79]** The file portion of the name (basename without the extension)
-    *   `parsedName.ext` **[String][79]** The extension portion of the name (always lower case)
-    *   `parsedName.dirName` **[String][79]** The directory path portion of the name
-*   `created` **[Date][84]** A date representing when the file was created
-*   `modified` **[Date][84]** A date representing when the file was created
-*   `accessed` **[Date][84]** A date representing when the file was last accessed
-*   `size` **[Number][78]** Size, in bytes, of the file
-*   `mime` **[String][79]** The associated mime type for the file
+    *   `parsedName.basename` **[String][83]** The filename + extention (i.e. everything without directory name)
+    *   `parsedName.filename` **[String][83]** The file portion of the name (basename without the extension)
+    *   `parsedName.ext` **[String][83]** The extension portion of the name (always lower case)
+    *   `parsedName.dirName` **[String][83]** The directory path portion of the name
+*   `created` **[Date][88]** A date representing when the file was created
+*   `modified` **[Date][88]** A date representing when the file was created
+*   `accessed` **[Date][88]** A date representing when the file was last accessed
+*   `size` **[Number][82]** Size, in bytes, of the file
+*   `mime` **[String][83]** The associated mime type for the file
 
 ## getProjectFiles
 
@@ -493,12 +513,12 @@ Fetch the files associated with a given project
 
 ### Parameters
 
-*   `options` **[Object][76]** Options which mutate behaviour
+*   `options` **[Object][80]** Options which mutate behaviour
 
-    *   `options.autoRequire` **[Boolean][77]** Run `requireProject()` automatically before continuing (optional, default `true`)
-    *   `options.meta` **[Boolean][77]** Pull meta information for each file entity (optional, default `true`)
+    *   `options.autoRequire` **[Boolean][81]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.meta` **[Boolean][81]** Pull meta information for each file entity (optional, default `true`)
 
-Returns **[Promise][81]<[ProjectFile][68]>** A collection of project files for the given project
+Returns **[Promise][85]<[ProjectFile][70]>** A collection of project files for the given project
 
 ## getProjectLibrary
 
@@ -506,16 +526,16 @@ Fetch the active projects citation library
 
 ### Parameters
 
-*   `path` **[String][79]?** Optional file path to use, if omitted the contents of `options` are used to guess at a suitable file
-*   `options` **[Object][76]?** Additional options to mutate behaviour
+*   `path` **[String][83]?** Optional file path to use, if omitted the contents of `options` are used to guess at a suitable file
+*   `options` **[Object][80]?** Additional options to mutate behaviour
 
-    *   `options.autoRequire` **[Boolean][77]** Run `requireProject()` automatically before continuing (optional, default `true`)
-    *   `options.multiple` **[Boolean][77]** Allow selection of multiple libraries (optional, default `false`)
-    *   `options.filter` **[Function][85]?** Optional async file filter, called each time as `(File:ProjectFile)`
-    *   `options.find` **[Function][85]?** Optional async final stage file filter to reduce all candidates down to one subject file
-    *   `options.hint` **([String][79] | [Array][80]<[String][79]>)?** 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.autoRequire` **[Boolean][81]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.multiple` **[Boolean][81]** Allow selection of multiple libraries (optional, default `false`)
+    *   `options.filter` **[Function][89]?** Optional async file filter, called each time as `(File:ProjectFile)`
+    *   `options.find` **[Function][89]?** Optional async final stage file filter to reduce all candidates down to one subject file
+    *   `options.hint` **([String][83] | [Array][84]<[String][83]>)?** Hints to identify the library to select in array order of preference. Generally corresponds to the previous stage - e.g. 'deduped', 'review1', 'review2', 'dedisputed'
 
-Returns **[Promise][81]<[Array][80]<[ProjectFile][68]>>** Collection of references for the selected library matching the given hint + filter, this could be a zero length array
+Returns **[Promise][85]<[Array][84]<[ProjectFile][70]>>** Collection of references for the selected library matching the given hint + filter, this could be a zero length array
 
 ## setProjectLibrary
 
@@ -523,13 +543,27 @@ Save back a projects citation library
 
 ### Parameters
 
-*   `Collection` **[Array][80]\<RefLibRef>** of references for the selected library
-*   `options` **[Object][76]?** Additional options to mutate behaviour
+*   `Collection` **[Array][84]\<RefLibRef>** of references for the selected library
+*   `options` **[Object][80]?** Additional options to mutate behaviour
+
+    *   `options.autoRequire` **[Boolean][81]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.hint` **[String][83]?** Hint to store against the library. Generally corresponds to the current operation being performed - e.g. 'deduped'
 
-    *   `options.autoRequire` **[Boolean][77]** Run `requireProject()` automatically before continuing (optional, default `true`)
-    *   `options.hint` **[String][79]?** Hint to store against the library. Generally corresponds to the current operation being performed - e.g. 'deduped'
+Returns **[Promise][85]** A promise which resolves when the save operation has completed
 
-Returns **[Promise][81]** A promise which resolves when the save operation has completed
+## uiAlert
+
+Display simple text within TERA
+
+### Parameters
+
+*   `text` **[String][83]** The text to display
+*   `options` **[Object][80]?** Additional options to mutate behaviour
+
+    *   `options.title` **[String][83]** The title of the alert box (optional, default `'TERA'`)
+    *   `options.isHtml` **[Boolean][81]** If falsy the text is rendered as plain-text otherwise it will be assumed as HTML content (optional, default `false`)
+
+Returns **[Promise][85]** A promise which resolves when the alert has been dismissed
 
 [1]: #terafy
 
@@ -623,80 +657,88 @@ Returns **[Promise][81]** A promise which resolves when the save operation has c
 
 [46]: #getuser
 
-[47]: #project
+[47]: #requireuser
+
+[48]: #
+
+[49]: #project
+
+[50]: #getproject
+
+[51]: #getprojects
 
-[48]: #getproject
+[52]: #setactiveproject
 
-[49]: #getprojects
+[53]: #parameters-14
 
-[50]: #setactiveproject
+[54]: #requireproject
 
-[51]: #parameters-14
+[55]: #parameters-15
 
-[52]: #requireproject
+[56]: #selectproject
 
-[53]: #parameters-15
+[57]: #parameters-16
 
-[54]: #selectproject
+[58]: #getprojectstate
 
-[55]: #parameters-16
+[59]: #parameters-17
 
-[56]: #getprojectstate
+[60]: #setprojectstate
 
-[57]: #parameters-17
+[61]: #parameters-18
 
-[58]: #setprojectstate
+[62]: #setprojectstatedefaults
 
-[59]: #parameters-18
+[63]: #parameters-19
 
-[60]: #setprojectstatedefaults
+[64]: #saveprojectstate
 
-[61]: #parameters-19
+[65]: #replaceprojectstate
 
-[62]: #saveprojectstate
+[66]: #parameters-20
 
-[63]: #replaceprojectstate
+[67]: #applyprojectstatepatch
 
-[64]: #parameters-20
+[68]: #parameters-21
 
-[65]: #applyprojectstatepatch
+[69]: #subscribeprojectstate
 
-[66]: #parameters-21
+[70]: #projectfile
 
-[67]: #subscribeprojectstate
+[71]: #properties-4
 
-[68]: #projectfile
+[72]: #getprojectfiles
 
-[69]: #properties-4
+[73]: #parameters-22
 
-[70]: #getprojectfiles
+[74]: #getprojectlibrary
 
-[71]: #parameters-22
+[75]: #parameters-23
 
-[72]: #getprojectlibrary
+[76]: #setprojectlibrary
 
-[73]: #parameters-23
+[77]: #parameters-24
 
-[74]: #setprojectlibrary
+[78]: #uialert
 
-[75]: #parameters-24
+[79]: #parameters-25
 
-[76]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+[80]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
 
-[77]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+[81]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
 
-[78]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+[82]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
-[79]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+[83]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-[80]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[84]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[81]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+[85]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
-[82]: https://developer.mozilla.org/docs/Web/API/MessageEvent
+[86]: https://developer.mozilla.org/docs/Web/API/MessageEvent
 
-[83]: http://jsonpatch.com
+[87]: http://jsonpatch.com
 
-[84]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date
+[88]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date
 
-[85]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+[89]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function