@iebh/tera-fy 1.1.0 → 1.2.1

package/api.md

@@ -108,18 +108,16 @@
     *   [Parameters][104]
 *   [selectProjectLibrary][105]
     *   [Parameters][106]
-*   [parseProjectLibrary][107]
+*   [getProjectLibrary][107]
     *   [Parameters][108]
 *   [setProjectLibrary][109]
     *   [Parameters][110]
-*   [setProjectLibrary][111]
+*   [uiAlert][111]
     *   [Parameters][112]
-*   [uiAlert][113]
+*   [uiSplat][113]
     *   [Parameters][114]
-*   [uiSplat][115]
+*   [uiWindow][115]
     *   [Parameters][116]
-*   [uiWindow][117]
-    *   [Parameters][118]
 
 ## ProjectFile
 
@@ -137,87 +135,87 @@ Parent TeraClient instance used by all helper functions
 
 A UUID string representing the unique ID of the file
 
-Type: [String][119]
+Type: [String][117]
 
 ### name
 
 Relative name path (can contain prefix directories) for the human readable file name
 
-Type: [String][119]
+Type: [String][117]
 
 ### path
 
 Full path to the file
 This is also used as the unique identifier within the project
 
-Type: [String][119]
+Type: [String][117]
 
 ### parsedName
 
 An object representing meta file parts of a file name
 
-Type: [Object][120]
+Type: [Object][118]
 
 #### Properties
 
-*   `basename` **[String][119]** The filename + extention (i.e. everything without directory name)
-*   `filename` **[String][119]** The file portion of the name (basename without the extension)
-*   `ext` **[String][119]** The extension portion of the name (always lower case)
-*   `dirName` **[String][119]** The directory path portion of the name
+*   `basename` **[String][117]** The filename + extention (i.e. everything without directory name)
+*   `filename` **[String][117]** The file portion of the name (basename without the extension)
+*   `ext` **[String][117]** The extension portion of the name (always lower case)
+*   `dirName` **[String][117]** The directory path portion of the name
 
 ### created
 
 A date representing when the file was created
 
-Type: [Date][121]
+Type: [Date][119]
 
 ### createdFormatted
 
 A human readable, formatted version of "created"
 
-Type: [String][119]
+Type: [String][117]
 
 ### modified
 
 A date representing when the file was created
 
-Type: [Date][121]
+Type: [Date][119]
 
 ### modifiedFormatted
 
 A human readable, formatted version of "modified"
 
-Type: [String][119]
+Type: [String][117]
 
 ### accessed
 
 A date representing when the file was last accessed
 
-Type: [Date][121]
+Type: [Date][119]
 
 ### accessedFormatted
 
 A human readable, formatted version of "accessed"
 
-Type: [String][119]
+Type: [String][117]
 
 ### size
 
 Size, in bytes, of the file
 
-Type: [Number][122]
+Type: [Number][120]
 
 ### sizeFormatted
 
 A human readable, formatted version of the file size
 
-Type: [String][119]
+Type: [String][117]
 
 ### mime
 
 The associated mime type for the file
 
-Type: [String][119]
+Type: [String][117]
 
 ### getContents
 
@@ -235,17 +233,17 @@ Overwrite the contents of a file with new content
 
 #### Parameters
 
-*   `contents` **(File | [Blob][123] | [FormData][124] | [Object][120] | [Array][125])** The new file contents
+*   `contents` **(File | [Blob][121] | [FormData][122] | [Object][118] | [Array][123])** The new file contents
 
-Returns **[Promise][126]** A promise which resolves when the operation has completed
+Returns **[Promise][124]** A promise which resolves when the operation has completed
 
 ### getRefs
 
-*   **See**: parseProjectLibrary()
+*   **See**: getProjectLibrary()
 
 Fetch the file contents as an array of Reflib refs
 
-Returns **[Promise][126]<[Array][125]\<Ref>>** An eventual array of RefLib references
+Returns **[Promise][124]<[Array][123]\<Ref>>** An eventual array of RefLib references
 
 ### setRefs
 
@@ -256,9 +254,9 @@ Overwrite the contents of a file with a new collection of Reflib refs
 #### Parameters
 
 *   `refs` &#x20;
-*   `Collection` **[Array][125]\<RefLibRef>** of references for the selected library
+*   `Collection` **[Array][123]\<RefLibRef>** of references for the selected library
 
-Returns **[Promise][126]** A promise which resolves when the operation has completed
+Returns **[Promise][124]** A promise which resolves when the operation has completed
 
 ## TeraFy
 
@@ -268,18 +266,18 @@ Main Tera-Fy Client (class singleton) to be used in a frontend browser
 
 Various settings to configure behaviour
 
-Type: [Object][120]
+Type: [Object][118]
 
 #### Properties
 
-*   `devMode` **[Boolean][127]** Operate in devMode - i.e. force outer refresh when encountering an existing TeraFy instance
+*   `devMode` **[Boolean][125]** Operate in devMode - i.e. force outer refresh when encountering an existing TeraFy instance
 *   `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][119]** Method to use when all method detection fails
-*   `modeTimeout` **[Number][122]** How long entities have in 'detect' mode to identify themselves
-*   `siteUrl` **[String][119]** The TERA URL to connect to
-*   `restrictOrigin` **[String][119]** URL to restrict communications to
-*   `List` **[Array][125]<[String][119]>** of sandbox allowables for the embedded if in embed mode
-*   `handshakeInterval` **[Number][122]** Interval in milliseconds when sanning for a handshake
+*   `modeFallback` **[String][117]** Method to use when all method detection fails
+*   `modeTimeout` **[Number][120]** How long entities have in 'detect' mode to identify themselves
+*   `siteUrl` **[String][117]** The TERA URL to connect to
+*   `restrictOrigin` **[String][117]** URL to restrict communications to
+*   `List` **[Array][123]<[String][117]>** of sandbox allowables for the embedded if in embed mode
+*   `handshakeInterval` **[Number][120]** Interval in milliseconds when sanning for a handshake
 
 ### events
 
@@ -291,27 +289,27 @@ Type: Mitt
 
 DOMElements for this TeraFy instance
 
-Type: [Object][120]
+Type: [Object][118]
 
 #### Properties
 
 *   `el` **DOMElement** The main tera-fy div wrapper
 *   `iframe` **DOMElement** The internal iFrame element  (if `settings.mode == 'child'`)
-*   `popup` **[Window][128]** The popup window context (if `settings.mode == 'popup'`)
+*   `popup` **[Window][126]** The popup window context (if `settings.mode == 'popup'`)
 *   `stylesheet` **DOMElement** The corresponding stylesheet
 
 ### methods
 
-List of function stubs mapped here from the server
+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][125]<[String][119]>
+Type: [Array][123]<[String][117]>
 
 ### plugins
 
 Loaded plugins via Use()
 
-Type: [Array][125]\<TeraFyPlugin>
+Type: [Array][123]\<TeraFyPlugin>
 
 ### send
 
@@ -319,9 +317,9 @@ Send a message + wait for a response object
 
 #### Parameters
 
-*   `message` **[Object][120]** Message object to send
+*   `message` **[Object][118]** Message object to send
 
-Returns **[Promise][126]\<any>** A promise which resolves when the operation has completed with the remote reply
+Returns **[Promise][124]\<any>** A promise which resolves when the operation has completed with the remote reply
 
 ### sendRaw
 
@@ -330,7 +328,7 @@ This function does not return or wait for a reply - use `send()` for that
 
 #### Parameters
 
-*   `message` **[Object][120]** Message object to send
+*   `message` **[Object][118]** Message object to send
 
 ### rpc
 
@@ -338,10 +336,10 @@ Call an RPC function in the server instance
 
 #### Parameters
 
-*   `method` **[String][119]** The method name to call
+*   `method` **[String][117]** The method name to call
 *   `args` **...any**&#x20;
 
-Returns **[Promise][126]\<any>** The resolved output of the server function
+Returns **[Promise][124]\<any>** The resolved output of the server function
 
 ### acceptMessage
 
@@ -350,7 +348,7 @@ Accept an incoming message
 #### Parameters
 
 *   `rawMessage` &#x20;
-*   `Raw` **[MessageEvent][129]** message event to process
+*   `Raw` **[MessageEvent][127]** message event to process
 
 ### acceptPostboxes
 
@@ -359,27 +357,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][130] standard
+The transmitted patch follows the [JSPatch][128] standard
 This function accepts an entire projectState instance, computes the delta and transmits that to the server for merging
 
 #### Parameters
 
-*   `newState` **[Object][120]** The local projectState to accept
-*   `oldState` **[Object][120]** The previous projectState to examine against
+*   `newState` **[Object][118]** The local projectState to accept
+*   `oldState` **[Object][118]** The previous projectState to examine against
 
-Returns **[Promise][126]** A promise which will resolve when the operation has completed
+Returns **[Promise][124]** 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][130] standard
+The patch should follow the [JSPatch][128] standard
 This function is expected to be sub-classed by a plugin
 
 #### Parameters
 
-*   `patch` **[Array][125]** A JSPatch patch to apply
+*   `patch` **[Array][123]** A JSPatch patch to apply
 
-Returns **[Promise][126]** A promise which will resolve when the operation has completed
+Returns **[Promise][124]** A promise which will resolve when the operation has completed
 
 ### init
 
@@ -388,22 +386,22 @@ This function can only be called once and will return the existing init() worker
 
 #### Parameters
 
-*   `options` **[Object][120]?** Additional options to merge into `settings` via `set`
+*   `options` **[Object][118]?** Additional options to merge into `settings` via `set`
 
-Returns **[Promise][126]<[TeraFy][24]>** An eventual promise which will resovle with this terafy instance
+Returns **[Promise][124]<[TeraFy][24]>** 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][126]<[String][119]>** A promise which will resolve with the detected mode to use
+Returns **[Promise][124]<[String][117]>** A promise which will resolve with the detected mode to use
 
 ### injectComms
 
 Find an existing active TERA server OR initalize one
 
-Returns **[Promise][126]** A promise which will resolve when the loading has completed and we have found a parent TERA instance or initiallized a child
+Returns **[Promise][124]** A promise which will resolve when the loading has completed and we have found a parent TERA instance or initiallized a child
 
 ### injectStylesheet
 
@@ -430,7 +428,7 @@ This function also routes 'special' keys like `devMode` to their internal handle
 
 #### Parameters
 
-*   `key` **([String][119] | [Object][120])** Either a single setting key to set or an object to merge
+*   `key` **([String][117] | [Object][118])** 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][24]** This chainable terafy instance
@@ -443,7 +441,7 @@ Set or merge settings - but only in dev mode and only if the value is not undefi
 
 #### Parameters
 
-*   `key` **([String][119] | [Object][120])** Either a single setting key to set or an object to merge
+*   `key` **([String][117] | [Object][118])** 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][24]** This chainable terafy instance
@@ -455,8 +453,8 @@ Include a TeraFy client plugin
 #### Parameters
 
 *   `mod` &#x20;
-*   `options` **[Object][120]?** Additional options to mutate behaviour during construction (pass options to init() to intialize later options)
-*   `The` **[Object][120]** module function to include. Invoked as `(teraClient:TeraFy, options:Object)`
+*   `options` **[Object][118]?** Additional options to mutate behaviour during construction (pass options to init() to intialize later options)
+*   `The` **[Object][118]** module function to include. Invoked as `(teraClient:TeraFy, options:Object)`
 
 Returns **[TeraFy][24]** This chainable terafy instance
 
@@ -466,8 +464,8 @@ Internal function used by use() to merge an external declared singleton against
 
 #### Parameters
 
-*   `target` **[Object][120]** Initalied class instance to extend
-*   `source` **[Object][120]** Initalized source object to extend from
+*   `target` **[Object][118]** Initalied class instance to extend
+*   `source` **[Object][118]** Initalized source object to extend from
 
 ### toggleDevMode
 
@@ -475,7 +473,7 @@ Set or toggle devMode
 
 #### Parameters
 
-*   `devModeEnabled` **([String][119] | [Boolean][127])** Optional boolean to force dev mode (optional, default `'toggle'`)
+*   `devModeEnabled` **([String][117] | [Boolean][125])** Optional boolean to force dev mode (optional, default `'toggle'`)
 
 Returns **[TeraFy][24]** This chainable terafy instance
 
@@ -486,7 +484,7 @@ This is usually because the server component wants to perform some user activity
 
 #### Parameters
 
-*   `isFocused` **([String][119] | [Boolean][127])** Whether to fullscreen the embedded component (optional, default `'toggle'`)
+*   `isFocused` **([String][117] | [Boolean][125])** Whether to fullscreen the embedded component (optional, default `'toggle'`)
 
 ### selectProjectFile
 
@@ -498,7 +496,7 @@ This is an pre-requisite step for requireProject()
 
 *   `options` &#x20;
 
-Returns **[Promise][126]** A promise which will resolve if the there is a user and they are logged in
+Returns **[Promise][124]** A promise which will resolve if the there is a user and they are logged in
 
 ### getProjectFiles
 
@@ -506,12 +504,12 @@ Fetch the files associated with a given project
 
 #### Parameters
 
-*   `options` **[Object][120]** Options which mutate behaviour
+*   `options` **[Object][118]** Options which mutate behaviour
 
-    *   `options.autoRequire` **[Boolean][127]** Run `requireProject()` automatically before continuing (optional, default `true`)
-    *   `options.meta` **[Boolean][127]** Pull meta information for each file entity (optional, default `true`)
+    *   `options.autoRequire` **[Boolean][125]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.meta` **[Boolean][125]** Pull meta information for each file entity (optional, default `true`)
 
-Returns **[Promise][126]<[Array][125]<[ProjectFile][1]>>** A collection of project files for the given project
+Returns **[Promise][124]<[Array][123]<[ProjectFile][1]>>** A collection of project files for the given project
 
 ### getProjectFile
 
@@ -519,9 +517,9 @@ Fetch a project file
 
 #### Parameters
 
-*   `path` **[String][119]** File path to read
+*   `path` **[String][117]** File path to read
 
-Returns **[Promise][126]<[Blob][123]>** The eventual fetched file as a blob
+Returns **[Promise][124]<[Blob][121]>** The eventual fetched file as a blob
 
 ## handshake
 
@@ -529,9 +527,9 @@ Return basic server information as a form of validation
 
 ### Properties
 
-*   `date` **[Date][121]** Server date
+*   `date` **[Date][119]** Server date
 
-Returns **[Promise][126]<[Object][120]>** Basic promise result
+Returns **[Promise][124]<[Object][118]>** Basic promise result
 
 ## User
 
@@ -539,16 +537,16 @@ User / active session within TERA
 
 ### Properties
 
-*   `id` **[String][119]** Unique identifier of the user
-*   `email` **[String][119]** The email address of the current user
-*   `name` **[String][119]** The provided full name of the user
-*   `isSubscribed` **[Boolean][127]** Whether the active user has a TERA subscription
+*   `id` **[String][117]** Unique identifier of the user
+*   `email` **[String][117]** The email address of the current user
+*   `name` **[String][117]** The provided full name of the user
+*   `isSubscribed` **[Boolean][125]** Whether the active user has a TERA subscription
 
 ## getUser
 
 Fetch the current session user
 
-Returns **[Promise][126]<[User][73]>** The current logged in user or null if none
+Returns **[Promise][124]<[User][73]>** The current logged in user or null if none
 
 ## requireUser
 
@@ -558,11 +556,11 @@ This is an pre-requisite step for requireProject()
 
 ### Parameters
 
-*   `options` **[Object][120]?** Additional options to mutate behaviour
+*   `options` **[Object][118]?** Additional options to mutate behaviour
 
-    *   `options.forceRetry` **[Boolean][127]** Forcabily try to refresh the user state (optional, default `false`)
+    *   `options.forceRetry` **[Boolean][125]** Forcabily try to refresh the user state (optional, default `false`)
 
-Returns **[Promise][126]<[User][73]>** The current logged in user or null if none
+Returns **[Promise][124]<[User][73]>** The current logged in user or null if none
 
 ## Project
 
@@ -572,13 +570,13 @@ Project entry within TERA
 
 Get the currently active project, if any
 
-Returns **[Promise][126]<([Project][78] | null)>** The currently active project, if any
+Returns **[Promise][124]<([Project][78] | null)>** The currently active project, if any
 
 ## getProjects
 
 Get a list of projects the current session user has access to
 
-Returns **[Promise][126]<[Array][125]<[Project][78]>>** Collection of projects the user has access to
+Returns **[Promise][124]<[Array][123]<[Project][78]>>** Collection of projects the user has access to
 
 ## setActiveProject
 
@@ -586,7 +584,7 @@ Set the currently active project within TERA
 
 ### Parameters
 
-*   `project` **([Object][120] | [String][119])** The project to set as active - either the full Project object or its ID
+*   `project` **([Object][118] | [String][117])** The project to set as active - either the full Project object or its ID
 
 ## requireProject
 
@@ -595,14 +593,14 @@ Note that this function will percist in asking the uesr even if they try to canc
 
 ### Parameters
 
-*   `options` **[Object][120]?** Additional options to mutate behaviour
+*   `options` **[Object][118]?** Additional options to mutate behaviour
 
-    *   `options.autoSetActiveProject` **[Boolean][127]** After selecting a project set that project as active in TERA (optional, default `true`)
-    *   `options.title` **[String][119]** The title of the dialog to display (optional, default `"Select a project to work with"`)
-    *   `options.noSelectTitle` **[String][119]** Dialog title when warning the user they need to select something (optional, default `'Select project'`)
-    *   `options.noSelectBody` **[String][119]** Dialog body when warning the user they need to select something (optional, default `'A project needs to be selected to continue'`)
+    *   `options.autoSetActiveProject` **[Boolean][125]** After selecting a project set that project as active in TERA (optional, default `true`)
+    *   `options.title` **[String][117]** The title of the dialog to display (optional, default `"Select a project to work with"`)
+    *   `options.noSelectTitle` **[String][117]** Dialog title when warning the user they need to select something (optional, default `'Select project'`)
+    *   `options.noSelectBody` **[String][117]** Dialog body when warning the user they need to select something (optional, default `'A project needs to be selected to continue'`)
 
-Returns **[Promise][126]<[Project][78]>** The active project
+Returns **[Promise][124]<[Project][78]>** The active project
 
 ## selectProject
 
@@ -610,13 +608,13 @@ Prompt the user to select a project from those available
 
 ### Parameters
 
-*   `options` **[Object][120]?** Additional options to mutate behaviour
+*   `options` **[Object][118]?** Additional options to mutate behaviour
 
-    *   `options.title` **[String][119]** The title of the dialog to display (optional, default `"Select a project to work with"`)
-    *   `options.allowCancel` **[Boolean][127]** Advertise cancelling the operation, the dialog can still be cancelled by closing it (optional, default `true`)
-    *   `options.setActive` **[Boolean][127]** Also set the project as active when selected (optional, default `false`)
+    *   `options.title` **[String][117]** The title of the dialog to display (optional, default `"Select a project to work with"`)
+    *   `options.allowCancel` **[Boolean][125]** Advertise cancelling the operation, the dialog can still be cancelled by closing it (optional, default `true`)
+    *   `options.setActive` **[Boolean][125]** Also set the project as active when selected (optional, default `false`)
 
-Returns **[Promise][126]<[Project][78]>** The active project
+Returns **[Promise][124]<[Project][78]>** The active project
 
 ## getProjectState
 
@@ -624,12 +622,12 @@ Return the current, full snapshot state of the active project
 
 ### Parameters
 
-*   `options` **[Object][120]?** Additional options to mutate behaviour
+*   `options` **[Object][118]?** Additional options to mutate behaviour
 
-    *   `options.autoRequire` **[Boolean][127]** Run `requireProject()` automatically before continuing (optional, default `true`)
-*   `Paths` **[Array][125]<[String][119]>** to subscribe to e.g. \['/users/'],
+    *   `options.autoRequire` **[Boolean][125]** Run `requireProject()` automatically before continuing (optional, default `true`)
+*   `Paths` **[Array][123]<[String][117]>** to subscribe to e.g. \['/users/'],
 
-Returns **[Promise][126]<[Object][120]>** The current project state snapshot
+Returns **[Promise][124]<[Object][118]>** The current project state snapshot
 
 ## setProjectState
 
@@ -641,13 +639,13 @@ Paths can be any valid Lodash.set() value such as:
 
 ### Parameters
 
-*   `path` **([String][119] | [Array][125]<[String][119]>)** The sub-path within the project state to set
+*   `path` **([String][117] | [Array][123]<[String][117]>)** The sub-path within the project state to set
 *   `value` **any** The value to set
-*   `options` **[Object][120]?** Additional options to mutate behaviour
+*   `options` **[Object][118]?** Additional options to mutate behaviour
 
-    *   `options.save` **[Boolean][127]** Save the changes to the server immediately, disable to queue up multiple writes (optional, default `true`)
+    *   `options.save` **[Boolean][125]** Save the changes to the server immediately, disable to queue up multiple writes (optional, default `true`)
 
-Returns **[Promise][126]** A promise which resolves when the operation has been dispatched to the server
+Returns **[Promise][124]** A promise which resolves when the operation has been dispatched to the server
 
 ## setProjectStateDefaults
 
@@ -657,17 +655,17 @@ Set a nested value within the project state - just like `setProjectState()` - bu
 
 ### Parameters
 
-*   `path` **([String][119] | [Array][125]<[String][119]>)** The sub-path within the project state to set
+*   `path` **([String][117] | [Array][123]<[String][117]>)** The sub-path within the project state to set
 *   `value` **any** The value to set
-*   `options` **[Object][120]?** Additional options to mutate behaviour, see setProjectState() for the full list of supported options
+*   `options` **[Object][118]?** Additional options to mutate behaviour, see setProjectState() for the full list of supported options
 
-Returns **[Promise][126]<[Boolean][127]>** A promise which resolves to whether any changes were made - True if defaults were applied, false otherwise
+Returns **[Promise][124]<[Boolean][125]>** 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][126]** A promise which resolves when the operation has completed
+Returns **[Promise][124]** A promise which resolves when the operation has completed
 
 ## replaceProjectState
 
@@ -678,9 +676,9 @@ You almost never want to use this function directly, see `setProjectState(path,
 
 ### Parameters
 
-*   `newState` **[Object][120]** The new state to replace the current state with
+*   `newState` **[Object][118]** The new state to replace the current state with
 
-Returns **[Promise][126]** A promise which resolves when the operation has completed
+Returns **[Promise][124]** A promise which resolves when the operation has completed
 
 ## applyProjectStatePatch
 
@@ -688,9 +686,9 @@ Apply a computed `just-diff` patch to the current project state
 
 ### Parameters
 
-*   `Patch` **[Object][120]** to apply
+*   `Patch` **[Object][118]** to apply
 
-Returns **[Promise][126]** A promise which resolves when the operation has completed
+Returns **[Promise][124]** A promise which resolves when the operation has completed
 
 ## subscribeProjectState
 
@@ -698,7 +696,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][126]<[Function][131]>** A promise which resolves when a subscription has been created, call the resulting function to unsubscribe
+Returns **[Promise][124]<[Function][129]>** A promise which resolves when a subscription has been created, call the resulting function to unsubscribe
 
 ## FileFilters
 
@@ -706,10 +704,10 @@ Data structure for a file filter
 
 ### Properties
 
-*   `library` **[Boolean][127]?** Restrict to library files only
-*   `filename` **[String][119]?** CSV of @momsfriendlydevco/match expressions to filter the filename by (filenames are the basename sans extension)
-*   `basename` **[String][119]?** CSV of @momsfriendlydevco/match expressions to filter the basename by
-*   `ext` **[String][119]?** CSV of @momsfriendlydevco/match expressions to filter the file extension by
+*   `library` **[Boolean][125]?** Restrict to library files only
+*   `filename` **[String][117]?** CSV of @momsfriendlydevco/match expressions to filter the filename by (filenames are the basename sans extension)
+*   `basename` **[String][117]?** CSV of @momsfriendlydevco/match expressions to filter the basename by
+*   `ext` **[String][117]?** CSV of @momsfriendlydevco/match expressions to filter the file extension by
 
 ## selectProjectFile
 
@@ -717,20 +715,20 @@ Prompt the user to select a library to operate on
 
 ### Parameters
 
-*   `options` **[Object][120]?** Additional options to mutate behaviour
+*   `options` **[Object][118]?** Additional options to mutate behaviour
 
-    *   `options.title` **[String][119]** The title of the dialog to display (optional, default `"Select a file"`)
-    *   `options.hint` **([String][119] | [Array][125]<[String][119]>)?** Hints to identify the file to select in array order of preference
-    *   `options.save` **[Boolean][127]** 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][117]** The title of the dialog to display (optional, default `"Select a file"`)
+    *   `options.hint` **([String][117] | [Array][123]<[String][117]>)?** Hints to identify the file to select in array order of preference
+    *   `options.save` **[Boolean][125]** 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][99]?** Optional file filters
-    *   `options.allowUpload` **[Boolean][127]** Allow uploading new files (optional, default `true`)
-    *   `options.allowRefresh` **[Boolean][127]** Allow the user to manually refresh the file list (optional, default `true`)
-    *   `options.allowDownloadZip` **[Boolean][127]** Allow the user to download a Zip of all files (optional, default `true`)
-    *   `options.allowCancel` **[Boolean][127]** Allow cancelling the operation. Will throw `'CANCEL'` as the promise rejection if acationed (optional, default `true`)
-    *   `options.autoRequire` **[Boolean][127]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.allowUpload` **[Boolean][125]** Allow uploading new files (optional, default `true`)
+    *   `options.allowRefresh` **[Boolean][125]** Allow the user to manually refresh the file list (optional, default `true`)
+    *   `options.allowDownloadZip` **[Boolean][125]** Allow the user to download a Zip of all files (optional, default `true`)
+    *   `options.allowCancel` **[Boolean][125]** Allow cancelling the operation. Will throw `'CANCEL'` as the promise rejection if acationed (optional, default `true`)
+    *   `options.autoRequire` **[Boolean][125]** Run `requireProject()` automatically before continuing (optional, default `true`)
     *   `options.filter` **[FileFilters][99]?** Optional file filters
 
-Returns **[Promise][126]<[ProjectFile][1]>** The eventually selected file
+Returns **[Promise][124]<[ProjectFile][1]>** The eventually selected file
 
 ## setProjectFile
 
@@ -738,10 +736,10 @@ Replace a project files contents
 
 ### Parameters
 
-*   `path` **[String][119]** File path to write
-*   `contents` **(File | [Blob][123] | [FormData][124] | [Object][120] | [Array][125])** The new file contents
+*   `path` **[String][117]** File path to write
+*   `contents` **(File | [Blob][121] | [FormData][122] | [Object][118] | [Array][123])** The new file contents
 
-Returns **[Promise][126]** A promise which will resolve when the write operation has completed
+Returns **[Promise][124]** A promise which will resolve when the write operation has completed
 
 ## selectProjectLibrary
 
@@ -749,34 +747,34 @@ Prompt the user to select a library to operate on and return a array of referenc
 
 ### Parameters
 
-*   `options` **[Object][120]?** Additional options to mutate behaviour
+*   `options` **[Object][118]?** Additional options to mutate behaviour
 
-    *   `options.title` **[String][119]** The title of the dialog to display (optional, default `"Select a citation library"`)
-    *   `options.hint` **([String][119] | [Array][125]<[String][119]>)?** 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][127]** Allow uploading new files (optional, default `true`)
-    *   `options.allowRefresh` **[Boolean][127]** Allow the user to manually refresh the file list (optional, default `true`)
-    *   `options.allowDownloadZip` **[Boolean][127]** Allow the user to download a Zip of all files (optional, default `true`)
-    *   `options.allowCancel` **[Boolean][127]** Allow cancelling the operation. Will throw `'CANCEL'` as the promise rejection if acationed (optional, default `true`)
-    *   `options.autoRequire` **[Boolean][127]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.title` **[String][117]** The title of the dialog to display (optional, default `"Select a citation library"`)
+    *   `options.hint` **([String][117] | [Array][123]<[String][117]>)?** 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][125]** Allow uploading new files (optional, default `true`)
+    *   `options.allowRefresh` **[Boolean][125]** Allow the user to manually refresh the file list (optional, default `true`)
+    *   `options.allowDownloadZip` **[Boolean][125]** Allow the user to download a Zip of all files (optional, default `true`)
+    *   `options.allowCancel` **[Boolean][125]** Allow cancelling the operation. Will throw `'CANCEL'` as the promise rejection if acationed (optional, default `true`)
+    *   `options.autoRequire` **[Boolean][125]** Run `requireProject()` automatically before continuing (optional, default `true`)
     *   `options.filters` **[FileFilters][99]?** Optional file filters, defaults to citation library selection only
 
-Returns **[Promise][126]<[Array][125]\<Ref>>** A collection of references from the selected file
+Returns **[Promise][124]<[Array][123]\<Ref>>** A collection of references from the selected file
 
-## parseProjectLibrary
+## getProjectLibrary
 
-Convert a project file into a library of citations
+Fetch + convert a project file into a library of citations
 
 ### Parameters
 
-*   `path` **[String][119]** File path to read, if omitted the contents of `options` are used to guess at a suitable file
-*   `options` **[Object][120]?** Additional options to mutate behaviour
+*   `path` **[String][117]** File path to read, if omitted the contents of `options` are used to guess at a suitable file
+*   `options` **[Object][118]?** Additional options to mutate behaviour
 
-    *   `options.format` **[String][119]** 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][127]** Run `requireProject()` automatically before continuing (optional, default `true`)
-    *   `options.filter` **[Function][131]?** Optional async file filter, called each time as `(File:ProjectFile)`
-    *   `options.find` **[Function][131]?** Optional async final stage file filter to reduce all candidates down to one subject file
+    *   `options.format` **[String][117]** 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][125]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.filter` **[Function][129]?** Optional async file filter, called each time as `(File:ProjectFile)`
+    *   `options.find` **[Function][129]?** Optional async final stage file filter to reduce all candidates down to one subject file
 
-Returns **([Promise][126]<[Array][125]\<Ref>> | [Promise][126]\<any>)** A collection of references (default bevahiour) or a whatever format was requested
+Returns **([Promise][124]<[Array][123]\<Ref>> | [Promise][124]\<any>)** A collection of references (default bevahiour) or a whatever format was requested
 
 ## setProjectLibrary
 
@@ -784,31 +782,21 @@ Save back a citation library from some input
 
 ### Parameters
 
-*   `path` **[String][119]?** File path to save back to
-*   `Collection` **[Array][125]\<RefLibRef>** of references for the selected library
-*   `options` **[Object][120]?** Additional options to mutate behaviour
+*   `path` **[String][117]?** File path to save back to, if omitted one will be prompted for
+*   `refs` **([Array][123]\<RefLibRef> | [Blob][121] | File)?** Collection of references for the selected library or the raw Blob/File
+*   `options` **[Object][118]?** Additional options to mutate behaviour
 
-    *   `options.format` **[String][119]** 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][127]** Run `requireProject()` automatically before continuing (optional, default `true`)
-    *   `options.hint` **[String][119]?** Hint to store against the library. Generally corresponds to the current operation being performed - e.g. 'deduped'
-    *   `options.overwrite` **[Boolean][127]** Allow existing file upsert (optional, default `true`)
-    *   `options.meta` **[Object][120]?** Optional meta data to merge into the file data
+    *   `options.path` **[String][117]?** Alternate method to specify the path to save as, if omitted one will be prompted for
+    *   `options.refs` **([Array][123]\<RefLibRef> | [Blob][121] | File)?** Alternate method to specify the refs to save as an array or raw Blob/File
+    *   `options.format` **[String][117]** 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][125]** Run `requireProject()` automatically before continuing (optional, default `true`)
+    *   `options.hint` **[String][117]?** Hint to store against the library. Generally corresponds to the current operation being performed - e.g. 'deduped'
+    *   `options.filename` **[String][117]?** Suggested filename if path is unspecified
+    *   `options.title` **[String][117]** Dialog title if path is unspecified and we need to prompt (optional, default `'Save citation library'`)
+    *   `options.overwrite` **[Boolean][125]** Allow existing file upsert (optional, default `true`)
+    *   `options.meta` **[Object][118]?** Optional meta data to merge into the file data
 
-Returns **[Promise][126]** A promise which resolves when the save operation has completed
-
-## setProjectLibrary
-
-Save back a projects citation library
-
-### Parameters
-
-*   `Collection` **[Array][125]\<RefLibRef>** of references for the selected library
-*   `options` **[Object][120]?** Additional options to mutate behaviour
-
-    *   `options.autoRequire` **[Boolean][127]** Run `requireProject()` automatically before continuing (optional, default `true`)
-    *   `options.hint` **[String][119]?** Hint to store against the library. Generally corresponds to the current operation being performed - e.g. 'deduped'
-
-Returns **[Promise][126]** A promise which resolves when the save operation has completed
+Returns **[Promise][124]** A promise which resolves when the save operation has completed
 
 ## uiAlert
 
@@ -816,13 +804,13 @@ Display simple text within TERA
 
 ### Parameters
 
-*   `text` **[String][119]** The text to display
-*   `options` **[Object][120]?** Additional options to mutate behaviour
+*   `text` **[String][117]** The text to display
+*   `options` **[Object][118]?** Additional options to mutate behaviour
 
-    *   `options.title` **[String][119]** The title of the alert box (optional, default `'TERA'`)
-    *   `options.isHtml` **[Boolean][127]** If falsy the text is rendered as plain-text otherwise it will be assumed as HTML content (optional, default `false`)
+    *   `options.title` **[String][117]** The title of the alert box (optional, default `'TERA'`)
+    *   `options.isHtml` **[Boolean][125]** If falsy the text is rendered as plain-text otherwise it will be assumed as HTML content (optional, default `false`)
 
-Returns **[Promise][126]** A promise which resolves when the alert has been dismissed
+Returns **[Promise][124]** A promise which resolves when the alert has been dismissed
 
 ## uiSplat
 
@@ -831,10 +819,10 @@ This function is ideally called within a requestFocus() wrapper
 
 ### Parameters
 
-*   `content` **(DOMElement | [String][119] | `false`)** Either a prepared DOM element or string to compile, set to falsy to remove existing content
-*   `options` **[Object][120]?** Additional options to mutate behaviour
+*   `content` **(DOMElement | [String][117] | `false`)** Either a prepared DOM element or string to compile, set to falsy to remove existing content
+*   `options` **[Object][118]?** Additional options to mutate behaviour
 
-    *   `options.logo` **([Boolean][127] | [String][119])** 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][125] | [String][117])** 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
 
@@ -842,13 +830,13 @@ Open a popup window containing a new site
 
 ### Parameters
 
-*   `url` **[String][119]** The URL to open
-*   `options` **[Object][120]?** Additional options to mutate behaviour
+*   `url` **[String][117]** The URL to open
+*   `options` **[Object][118]?** Additional options to mutate behaviour
 
-    *   `options.width` **[Number][122]** The desired width of the window (optional, default `500`)
-    *   `options.height` **[Number][122]** The desired height of the window (optional, default `600`)
-    *   `options.center` **[Boolean][127]** Attempt to center the window on the screen (optional, default `true`)
-    *   `options.permissions` **[Object][120]?** Additional permissions to set on opening, defaults to a suitable set of permission for popups (see code)
+    *   `options.width` **[Number][120]** The desired width of the window (optional, default `500`)
+    *   `options.height` **[Number][120]** The desired height of the window (optional, default `600`)
+    *   `options.center` **[Boolean][125]** Attempt to center the window on the screen (optional, default `true`)
+    *   `options.permissions` **[Object][118]?** 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)
 
@@ -1064,7 +1052,7 @@ Returns **WindowProxy** The opened window object (if `noopener` is not set in pe
 
 [106]: #parameters-31
 
-[107]: #parseprojectlibrary
+[107]: #getprojectlibrary
 
 [108]: #parameters-32
 
@@ -1072,44 +1060,40 @@ Returns **WindowProxy** The opened window object (if `noopener` is not set in pe
 
 [110]: #parameters-33
 
-[111]: #setprojectlibrary-1
+[111]: #uialert
 
 [112]: #parameters-34
 
-[113]: #uialert
+[113]: #uisplat
 
 [114]: #parameters-35
 
-[115]: #uisplat
+[115]: #uiwindow
 
 [116]: #parameters-36
 
-[117]: #uiwindow
-
-[118]: #parameters-37
-
-[119]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+[117]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-[120]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+[118]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
 
-[121]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date
+[119]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date
 
-[122]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+[120]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
-[123]: https://developer.mozilla.org/docs/Web/API/Blob
+[121]: https://developer.mozilla.org/docs/Web/API/Blob
 
-[124]: https://developer.mozilla.org/docs/Web/API/FormData
+[122]: https://developer.mozilla.org/docs/Web/API/FormData
 
-[125]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[123]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[126]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+[124]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
-[127]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+[125]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
 
-[128]: https://developer.mozilla.org/docs/Web/API/Window
+[126]: https://developer.mozilla.org/docs/Web/API/Window
 
-[129]: https://developer.mozilla.org/docs/Web/API/MessageEvent
+[127]: https://developer.mozilla.org/docs/Web/API/MessageEvent
 
-[130]: http://jsonpatch.com
+[128]: http://jsonpatch.com
 
-[131]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+[129]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function