epicenter-libs 3.11.0

package/CHANGELOG.md

@@ -0,0 +1,345 @@
+# [3.11.0](https://github.com/forio/epicenter-libs/compare/v3.10.0-breaking...v3.11.0) (2022-01-08)
+
+
+### Bug Fixes
+
+* error handler less specific ([1b5d4b5](https://github.com/forio/epicenter-libs/commit/1b5d4b5bc444fc83b1308d33d51c61eeea54cc90))
+
+
+
+# [3.10.0-breaking](https://github.com/forio/epicenter-libs/compare/v3.9.0...v3.10.0-breaking) (2022-01-06)
+
+
+### Features
+
+* many new features & cleanup; explanation in commit desc ([331f4f7](https://github.com/forio/epicenter-libs/commit/331f4f7ca80d321edbfb892fb49aac62419fff2f))
+
+
+### BREAKING CHANGES
+
+* leaderboardAdapter.update arguments re-ordered
+
+
+
+# [3.9.0](https://github.com/forio/epicenter-libs/compare/v3.8.3...v3.9.0) (2021-12-02)
+
+
+### Features
+
+* add createUser function ([d892996](https://github.com/forio/epicenter-libs/commit/d8929968344ad49bd8618536976582269159f5cc))
+
+
+
+## [3.8.3](https://github.com/forio/epicenter-libs/compare/v3.8.2...v3.8.3) (2021-11-16)
+
+
+### Bug Fixes
+
+* fixed an issue w/ runAdapter.query returning variables in an array ([f544cbf](https://github.com/forio/epicenter-libs/commit/f544cbf628ed397834e3f71cf74c37ef7f61ade7))
+
+
+
+## [3.8.2](https://github.com/forio/epicenter-libs/compare/v3.8.1...v3.8.2) (2021-11-11)
+
+
+
+## [3.8.1](https://github.com/forio/epicenter-libs/compare/v3.8.0-breaking...v3.8.1) (2021-11-02)
+
+
+### Bug Fixes
+
+* users w/ multiple groups unable to log in ([46de1ce](https://github.com/forio/epicenter-libs/commit/46de1ce92b22cb05ae6045203212666336898eea))
+
+
+
+# [3.8.0-breaking](https://github.com/forio/epicenter-libs/compare/v3.7.1...v3.8.0-breaking) (2021-10-30)
+
+
+### Bug Fixes
+
+* added to documentation ([d90507c](https://github.com/forio/epicenter-libs/commit/d90507c089cac3bf22eb37bf46f7e7a0dd3ec0f8))
+* altered cron documentation ([f92be61](https://github.com/forio/epicenter-libs/commit/f92be61434e621d43dfa84c66967043ec0ddbe80))
+* fixed bug due to tokenOverride ([b1da99d](https://github.com/forio/epicenter-libs/commit/b1da99d2809d9b613fef34b35b0c95a1104e1d1e))
+* fixed group adapter test name changes ([780666d](https://github.com/forio/epicenter-libs/commit/780666dc7f1c826072c5f3c0f12553790e9d5926))
+* typo that broke request() ([adcf7b6](https://github.com/forio/epicenter-libs/commit/adcf7b65d72c4d019b81b082f7780aab626bf555))
+* updated documentation ([4471966](https://github.com/forio/epicenter-libs/commit/4471966f0a7a3ea07156b6e970030a7bfb4eb0f4))
+* updated email documentation ([a9c2d97](https://github.com/forio/epicenter-libs/commit/a9c2d97a26619237c49b419b47ae86828cb05d19))
+
+
+### Code Refactoring
+
+* handle resource scopes consistent to Epicenter ([10a227b](https://github.com/forio/epicenter-libs/commit/10a227b44bc98cbabdb8a2c44a8d5d05dd64d770))
+
+
+### Features
+
+* add chatAdapter ([854127a](https://github.com/forio/epicenter-libs/commit/854127a92d795cf970504b64abf92f7e48784da9))
+* add support for auth overrides (EPILIBS-79) ([7773913](https://github.com/forio/epicenter-libs/commit/7773913a9bb4e928e71416ce2acc82591f85e5b7))
+* added additional email endpoint support ([3d6127c](https://github.com/forio/epicenter-libs/commit/3d6127cdebb273c314e84f2301f5a89a1b79529c))
+* added get task adapter ([08b8d7e](https://github.com/forio/epicenter-libs/commit/08b8d7ed0289763d582a254f89d8b59baf1412c4))
+* added remaining task adapter GETs ([2bae7b0](https://github.com/forio/epicenter-libs/commit/2bae7b0026caabec3d4c06424a4e46082dd0c792))
+* added resetPassword ([716e9c7](https://github.com/forio/epicenter-libs/commit/716e9c717568b66f6444c68d53e02354aaa1d36c))
+* added sendEmailToAdmin adapter ([7900bd8](https://github.com/forio/epicenter-libs/commit/7900bd81939082336012833ecfd8f5687a5cd932))
+* create and destroy tasks ([7d22d59](https://github.com/forio/epicenter-libs/commit/7d22d591248df590566ade7dc9d1a189d3f5454d))
+* email route ([c75a917](https://github.com/forio/epicenter-libs/commit/c75a917570fd8ab9f778e9811802d08b6760c238))
+
+
+### Performance Improvements
+
+* code-split cometd ([d53a3ab](https://github.com/forio/epicenter-libs/commit/d53a3ab486baa14b8108d84f25d85a49213dd1e4))
+
+
+### BREAKING CHANGES
+
+* optionals.userKey for scopes is no longer supported
+
+
+
+## [3.7.1](https://github.com/forio/epicenter-libs/compare/v3.7.0...v3.7.1) (2021-09-27)
+
+
+### Bug Fixes
+
+* added documentation for resetPassword ([dcfa14b](https://github.com/forio/epicenter-libs/commit/dcfa14b42f2550018a3a90d6b0d6cae53f0e0373))
+* fixed bug due to tokenOverride ([c6fbf42](https://github.com/forio/epicenter-libs/commit/c6fbf423791fecc60f2b8556b2805f87da9deb2e))
+* fixed group adapter test name changes ([dbf3fa0](https://github.com/forio/epicenter-libs/commit/dbf3fa00ca78a7f5b0a2bbfdea5208e77be07480))
+
+
+### Features
+
+* added resetPassword ([6c0fad3](https://github.com/forio/epicenter-libs/commit/6c0fad357dd2ce856d501a236119fd856b05c546))
+
+
+
+# [3.7.0](https://github.com/forio/epicenter-libs/compare/v3.6.1...v3.7.0) (2021-09-03)
+
+### Code Refactoring
+
+* groupAdapter optional arguments renamed: all -> includeAllMembers; expired -> includeExpired ([658e2a9](https://github.com/forio/epicenter-libs/commit/8ce6886773ac49d95984fa9e11cc48371658e2a9))
+
+
+### BREAKING CHANGES
+
+* Group API calls w/ query parameter 'all' becomes 'includeAllMembers' and 'expired' becomes 'includeExpired'  (to match epicenter 3.7.x / 3.8.x)
+
+## [3.6.1](https://github.com/forio/epicenter-libs/compare/v3.6.0...v3.6.1) (2021-08-06)
+
+
+### Features
+
+* add group status endpoint adapter ([c2a34d9](https://github.com/forio/epicenter-libs/commit/c2a34d92bb5c2d8e4d297d1f536f9c0382e9f531))
+
+
+
+# [3.6.0](https://github.com/forio/epicenter-libs/compare/v3.5.1...v3.6.0) (2021-07-26)
+
+
+### Code Refactoring
+
+* vault update changed from PATCH -> PUT ([998693c](https://github.com/forio/epicenter-libs/commit/998693c33bff9e4a956da72a76c627172a712f0f))
+
+
+### BREAKING CHANGES
+
+* vaultAdapter.update produces a PUT instead of a PATCH (to match epicenter 3.7.x)
+
+
+
+## [3.5.1](https://github.com/forio/epicenter-libs/compare/v3.5.0...v3.5.1) (2021-07-16)
+
+
+### Features
+
+* episodeAdapter.byName to take includeEpisodes ([d966d19](https://github.com/forio/epicenter-libs/commit/d966d19df3d94821bf78cd9aceaea707227bb26a))
+
+
+
+# [3.5.0](https://github.com/forio/epicenter-libs/compare/v3.4.0...v3.5.0) (2021-07-14)
+
+
+### Bug Fixes
+
+* handle localhost domain ([7d77cc5](https://github.com/forio/epicenter-libs/commit/7d77cc52f497019c304a1a44797fea9c0552221b))
+
+
+### Code Refactoring
+
+* episodeAdapter.byName -> episodeAdapter.withName (new args) ([4829496](https://github.com/forio/epicenter-libs/commit/48294965feb09300790ca4d7d5bbc15feee01e82))
+* forUserKey -> forUser ([f4fda50](https://github.com/forio/epicenter-libs/commit/f4fda5055995211957987082cbc6b842c8623bc8))
+* vaultAdapter.getWithScope -> vaultAdapter.withScope ([d2304cd](https://github.com/forio/epicenter-libs/commit/d2304cd45fbd5c552c7691de3e8f22fd45cc8836))
+
+
+### Features
+
+* add vaultAdapter.byName ([d4b3f7b](https://github.com/forio/epicenter-libs/commit/d4b3f7b7bc569b9d3cd3ba6f35dc2fcd833d3e24))
+
+
+### BREAKING CHANGES
+
+* vaultAdapter.getWithScope -> withScope, renamed for consistency
+* episodeAdapter.byName -> withName; takes groupName as an optional argument
+* groupAdapter.forUserKey renamed to groupAdapter.forUser
+
+
+
+# [3.4.0](https://github.com/forio/epicenter-libs/compare/v3.3.1...v3.4.0) (2021-06-10)
+
+
+### Bug Fixes
+
+* accept userKeys when using world scope in vault ([ec1cee9](https://github.com/forio/epicenter-libs/commit/ec1cee95ec468a53ac90a8d4f162a12cde8d86ea))
+* no GETs for channelsEnabled on login ([820e5a4](https://github.com/forio/epicenter-libs/commit/820e5a43384034f47cf1b15e20c0034e21ed937f))
+* query crashing on runs with no variables ([f6db421](https://github.com/forio/epicenter-libs/commit/f6db421d22823ccfc62989a973e54e0dfc9a3720))
+* query variables return payload ([bfe4d2a](https://github.com/forio/epicenter-libs/commit/bfe4d2a7d2a6f6a78e1b403905b805c28a10af32))
+* typo ([f57192c](https://github.com/forio/epicenter-libs/commit/f57192ce44aeb20ef3ea335ba03b3309e305847c))
+* v3 SSO cookie occasionally wrapped in quotes ([a364b6c](https://github.com/forio/epicenter-libs/commit/a364b6cf9e49f576c8c917fbf484ba0529ed007e))
+* worldAdapter.removeUsers to actually use DELETE ([ace23c5](https://github.com/forio/epicenter-libs/commit/ace23c5e4cd612896ba801acbfe67e9e832cfc8d))
+
+
+### Code Refactoring
+
+* change exceedMinimums to objective ([3f6fe10](https://github.com/forio/epicenter-libs/commit/3f6fe10f3ef20d25d71945fe05750180d5fc3be0))
+* change runAdapter.query to better support multiplayer ([b9b6fab](https://github.com/forio/epicenter-libs/commit/b9b6fab21d8a2104f822f9dd50bba004cb53ae91))
+* change worldAdapter.create to only take optional args ([addae8e](https://github.com/forio/epicenter-libs/commit/addae8e55e28b91f71400932be2da0676d380185))
+* cleanup; remove updateAssignments ([eb2c721](https://github.com/forio/epicenter-libs/commit/eb2c7215b03f7d92834178d227bc73ca80470e1b))
+* groupAdapter add/update/remove user ([efb6ed4](https://github.com/forio/epicenter-libs/commit/efb6ed4ba8799fcf55b26861b1ac822e6316400c))
+* groupAdapter.get to use session groupkey by default ([5a3f667](https://github.com/forio/epicenter-libs/commit/5a3f667e6caaf54d11e361deff759e43bfc29bfb))
+* rename 'updateUsers' -> 'updateAssignments' ([d21a0f1](https://github.com/forio/epicenter-libs/commit/d21a0f1751073abf5768150ab7fd678703de58fa))
+* rename assignUsers to autoAssignUsers ([eabff19](https://github.com/forio/epicenter-libs/commit/eabff1936951a64758b78698e043105776cf62b0))
+* rename editPersonas -> setPersonas ([dcba7e2](https://github.com/forio/epicenter-libs/commit/dcba7e24227d7a45645e249d644db348aa218b3b))
+* rename getAssignments -> getAssignmentsByKey ([d02d5fd](https://github.com/forio/epicenter-libs/commit/d02d5fd08dc0b64193c815243c36ed6184b4e906))
+* rename makeAssignments -> editAssignments ([142a2e9](https://github.com/forio/epicenter-libs/commit/142a2e9588fecd01500bd7d90a5e95ed537e803f))
+
+
+### Features
+
+* add 'keepEmptyWorlds' flag ([0c1d557](https://github.com/forio/epicenter-libs/commit/0c1d55703642dce3c587042a064a9690ab9e4611))
+* add assetAdapter ([472358d](https://github.com/forio/epicenter-libs/commit/472358dac7e7459a7d565d5c651de7de81604d87))
+* add assignRun for worldAdapter ([4ab0e11](https://github.com/forio/epicenter-libs/commit/4ab0e114ca4527ba9b3884787848526c9ae0c59a))
+* add includeEpisode option for query ([01cbbeb](https://github.com/forio/epicenter-libs/commit/01cbbebb0b66b78f26acf5e7490c5032940ca4f4))
+* add makeAssignments function ([f133bde](https://github.com/forio/epicenter-libs/commit/f133bdeb4513b91b46666ddf676227504ce501a5))
+* add projectAdapter.get ([4dc13c5](https://github.com/forio/epicenter-libs/commit/4dc13c538e19241676715cf8f3df198c0c534f1b))
+* add PUSH_CATEGORY.GROUP for assignments ([d8c6dfe](https://github.com/forio/epicenter-libs/commit/d8c6dfed85ca8ffab9e826c6ea281a9d4d73c460))
+* add user adapter ([66bbe15](https://github.com/forio/epicenter-libs/commit/66bbe15cab723ffe7421cc5ab95330c58057b6cd))
+* attempt to support formdata (browser) ([b073e48](https://github.com/forio/epicenter-libs/commit/b073e48eb30119c21fbc08ad769f3a607cc9b5c3))
+
+
+### BREAKING CHANGES
+
+* changed the arguments accepted by addUser, updateUser, removeUser
+* worldAdapter.create to only take one (optional) argument
+* query(modelFile, scope, optionals) -> query(modelFile, optionals)
+* exceedMinimums -> objective; changed from bool to enum
+* worldAdapter.getAssignments -> worldAdapter.getAssignmentsByKey
+* worldAdapter.editPersonas -> worldAdapter.setPersonas
+* worldAdapter.makeAssignments -> worldAdapter.editAssignments
+* worldAdapter.assignUsers -> worldAdapter.autoAssignUsers
+* worldAdapter.updateAssignments no longer supported
+* worldAdapter.updateUsers -> worldAdapter.updateAssignments
+* groupAdapter.get(groupKey) -> groupAdapter.get({ groupKey })
+
+
+
+## [3.3.1](https://github.com/forio/epicenter-libs/compare/v3.3.0...v3.3.1) (2021-02-03)
+
+
+### Bug Fixes
+
+* errorManager default handler to actually return retry resp ([e5ba658](https://github.com/forio/epicenter-libs/commit/e5ba6589f12685c5ae1031a65695370b3dae294b))
+
+
+### Features
+
+* attach args to retry function ([443a1bf](https://github.com/forio/epicenter-libs/commit/443a1bf2e96c6b683e9ab88bf5a195502620a78c))
+
+
+
+# [3.3.0](https://github.com/forio/epicenter-libs/compare/v3.2.1...v3.3.0) (2021-02-03)
+
+
+### Code Refactoring
+
+* change authAdapter.upgrade to authAdapter.regenerate ([3d05f2d](https://github.com/forio/epicenter-libs/commit/3d05f2dd12649cbcd23f8a32cb6192f77615b39e))
+
+
+### BREAKING CHANGES
+
+* authAdapter.upgrade renamed to authAdapter.regenerate
+
+
+
+## [3.2.1](https://github.com/forio/epicenter-libs/compare/v3.2.0...v3.2.1) (2021-01-21)
+
+
+### Bug Fixes
+
+* add samesite, secure to session cookies ([101b261](https://github.com/forio/epicenter-libs/commit/101b261e49a48bf571b7fc05e953c5efeea0296b))
+
+
+### Code Refactoring
+
+* authAdapter.login to take generic URL options as 2nd arg ([be231a9](https://github.com/forio/epicenter-libs/commit/be231a9bee4562deff764193ead92e868fa9c83f))
+
+
+### BREAKING CHANGES
+
+* authAdapter.login now takes account/project overrides as second argument
+
+
+
+# [3.2.0](https://github.com/forio/epicenter-libs/compare/v3.1.0...v3.2.0) (2020-12-11)
+
+
+### Bug Fixes
+
+* all 'optionals' to actually be optional ([9bdd9b0](https://github.com/forio/epicenter-libs/commit/9bdd9b067ad99d1898fa7bfd1318cad8e0fba42d))
+* authAdapter.login to ignore falsey values ([572be63](https://github.com/forio/epicenter-libs/commit/572be63e49af02cd8b02cac62e5a3fa74121336e))
+* handle 204 responses ([474bee3](https://github.com/forio/epicenter-libs/commit/474bee3d7029823a36f443f4a475df9848f7dac8))
+* properly handle undefined search params ([0c34372](https://github.com/forio/epicenter-libs/commit/0c34372f12a76ac6869845866dec4e94a4fb2788))
+* support node v12+ in build process ([d1c9afb](https://github.com/forio/epicenter-libs/commit/d1c9afb942ed68f0c7dd942c6daf56014a31b5a6))
+
+
+### Code Refactoring
+
+* runAdapter.retrieveFromWorld arguments ([239a2d4](https://github.com/forio/epicenter-libs/commit/239a2d4e6497522c5972dbfcf308935b113c54e3))
+
+
+### Features
+
+* add group adapters ([49fae4d](https://github.com/forio/epicenter-libs/commit/49fae4d0a0e142b478fe68a29b2d37e248047fde))
+* add new push categories ([530d2ea](https://github.com/forio/epicenter-libs/commit/530d2ea2c99ae56e1f34f325be206f42e556fb54))
+* add support for token overrides ([00adf31](https://github.com/forio/epicenter-libs/commit/00adf3141e95335c8b4be6707850b6511d5e3f3a))
+* add support for worlds to runAdapter (EPILIBS-55) ([9213f2f](https://github.com/forio/epicenter-libs/commit/9213f2fd162be9536013b2bc97ff12eecae909b5))
+* world api adapter (EPILIBS-55) ([7b2ac96](https://github.com/forio/epicenter-libs/commit/7b2ac96117e8218533e96ae2a0193a34c9d3fa32))
+
+
+* refactor!: change LOCK_TYPE to ROLE ([ac9b200](https://github.com/forio/epicenter-libs/commit/ac9b200e6fa5f7fb935e8d53b62423412c2e745a))
+* refactor!: change pagination ([44921fb](https://github.com/forio/epicenter-libs/commit/44921fbd3a28882343f24dfbc054e3a400c2dbf7))
+* refactor!: router 'with' functions to only ignore undefined input ([b7cb586](https://github.com/forio/epicenter-libs/commit/b7cb586c4b1ec1c9faacb7eb19e2780d82610c69))
+* refactor!: run query to accept arrayed filter/sort ([3da6e8c](https://github.com/forio/epicenter-libs/commit/3da6e8c79d883563f4ab727e10534ef08dfca5aa))
+
+
+### BREAKING CHANGES
+
+* retrieveFromWorld to accept (worldKey, model) instead of (model, worldKey)
+* LOCK_TYPE changed to ROLE for more generic usage
+* remove page.withAll; change page.next
+* router 'with' functions will now utilize falsey values it previously ignored
+* runAdapter.query filter/sort no longer uses objs
+
+
+
+# [3.1.0](https://github.com/forio/epicenter-libs/compare/v3.0.3...v3.1.0) (2020-10-17)
+
+
+### Bug Fixes
+
+* test change log generation ([9be9445](https://github.com/forio/epicenter-libs/commit/9be94457097b4dfcc20022a23d3b18bcaf9a7dac))
+
+
+### Features
+
+* testing gen ([8d9b2f9](https://github.com/forio/epicenter-libs/commit/8d9b2f9142ef6975d52be52010c40304ce75b774))
+
+
+

package/LICENSE.md

@@ -0,0 +1,37 @@
+LICENSE
+-------
+
+Forio Corporation (Forio) hereby gives you a non-exclusive license to use the software in this repository (the Software).
+
+This license is granted for use in developing online applications that interact with Forio servers and server software.  Typically the Software will be used to create analytic web applications that are hosted by Forio Epicenter or Forio Simulate.   As part of this license you may freely download the complete distribution from the following URL.
+https://github.com/forio/epicenter-libs
+
+You may:
+- use the Software on any computer for the purposes of developing an online application.
+- upload the contents of the "dist" folder of the Software to any server controlled by Forio Corporation or any server that is running software provided by Forio.
+- link to the Software from a web application as long as the purpose of the web application is to interact with Forio servers or Forio server software.
+- copy the Software for archival purposes, provided any copy contains all of the original Software's proprietary notices.
+
+You may not:
+- redistribute the Software except as allowed above
+- include the Software or any files from the Software in a web application except for the contents of the "dist" folder as noted above.
+- permit other individuals to use the Software except under the terms listed above;
+- modify, translate, reverse engineer, decompile, disassemble (except to the extent applicable laws specifically prohibit such restriction),
+- create derivative works based on the Software;
+- copy the Software (except as specified above);
+- rent, lease, transfer or otherwise transfer rights to the Software;
+- remove any proprietary notices or labels on the Software.
+
+TERMINATION.
+The license will terminate automatically if you fail to comply with the limitations described above. On termination, you must destroy all copies of the Software and Documentation.
+
+
+DISCLAIMER OF WARRANTY
+---------------------------------------------
+The Software is provided on an AS IS basis, without warranty of any kind, including without limitation the warranties of merchantability, fitness for a particular purpose and non-infringement.
+The entire risk as to the quality and performance of the Software is borne by you.
+Should the Software prove defective, you and not Forio assume the entire cost of any service and repair.
+
+FORIO IS NOT RESPONSIBLE FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER COMMERCIAL DAMAGES OR LOSSES.
+
+Title, ownership rights and intellectual property rights in and to the Software shall remain in Forio. The Software is protected by international copyright treaties.

package/README.md

@@ -0,0 +1,134 @@
+Epicenter JavaScript Libs (v3)
+---
+The Epicenter JS libs is Forio's JavaScript library for interacting with the Epicenter platform. Similar to its' [predecessor](https://github.com/forio/epicenter-js-libs), it is comprised of a set of adapters meant to help streamline your work with the underlying Epicenter APIs.
+
+If you are comfortable with JavaScript, the epicenter.js library is an easy way to connect your project's model, data, and user interface.
+
+Questions? Contact us at support@forio.com or file an issue on github!
+
+JIRA (Forio internal): https://issues.forio.com/projects/EPILIBS/issues
+
+Table of Contents
+---
+- [Transition Guide (v2 → v3)](#transition-guide-v2--v3)
+  - [New Features In v3](#new-features-in-v3)
+  - [Some Things Were Renamed](#some-things-were-renamed)
+  - [Changes In The Way We Store And Expose User Data](#changes-in-the-way-we-store-and-expose-user-data)
+  - [Session Expiration & Generic Error Handling](#session-expiration--generic-error-handling)
+  - [Built-in SSO Handling](#built-in-sso-handling)
+  - [Pagination](#pagination)
+  - [Presence](#presence)
+- [Tenets for Development](#tenets-for-development)
+- [How to Contribute](#how-to-contribute)
+- [How to Prepare a Release](#how-to-prepare-a-release)
+- [How to Test](#how-to-test)
+- [How to Use Examples (Local)](#how-to-use-examples-local)
+  - [Vanilla JavaScript](#vanilla-javascript)
+  - [Node Server](#node-server)
+- [Documentation](#documentation)
+
+
+# Transition Guide (v2 → v3)
+## New Features In v3
+* All resources now have an associated scope to help categorize them -- e.g., project, group, episode, world.
+* All resources now have an associated permit to help define permissions for roles (anonymous, participant, leader, reviewer, facilitator)
+* Users now have a `displayName` for use in sims, detached from any private personal data
+* Two new roles for end users:
+    * reviewer: a role similar to facilitators, but lower on the permissions hierarchy
+    * leader: a role similar to participants, but higher on the permissions hierarchy
+* And more below...
+
+## Some Things Were Renamed
+* A bunch of user and run properties, among them --
+    * `userName → handle`
+    * `firstName → givenName`
+    * `lastName → familyName`
+    * `run.saved → run.marked`
+    * `run.trashed → run.hidden`
+* Resources ID'd by `[RESOURCE]Id` (e.g., `runId`) now use `key` instead of `id` (so now it's `runKey`)
+* `id` now refers to the long value of the row ID in the database instead
+* All resource `key`s are GUIDs (globally unique IDs)
+
+## Changes In The Way We Store And Expose User Data
+User information has been separated into out to better support for GDPR standards. Users now own a "pseudonym" from which to interact with the simulations. This is detached from their personal data which lets the platform to maintain a record while allowing for easy removal of user-sensitive data when requested.
+
+## Session Expiration & Generic Error Handling
+* v3 authorization tokens can now expire after a period of inactivity, and become invalid after a world assignment change
+* All calls have an error handling fallback to an `errorManager` instance, which will help to run checks on generic network errors like the expiration behavior described in the previous bullet
+
+## Built-in SSO Handling
+On load, epi-libs will now make an effort to find any Epicenter SSO tokens and consume them to generate an Epicenter session for you. This means a node server is no longer a hard requirement if you want to do SSO!
+
+## Pagination
+When retrieving records, pagination is no longer done via the request `Content-Range` header like in v2. Instead, the platform will now return a page-like object, which will contain properties that reflect the `records {start}-{end}/{total}` syntax:
+
+* `first → page.firstResult`
+* `end → page.firstResult + page.maxResults`
+* `total → page.totalResults`
+
+## Presence
+A user's presence is now determined by their connection to the CometD server. Unlike in v2, the platform will automatically create push channel notifications on behalf of the user when they subscribe or do anything channel related (i.e., like a CometD handshake).
+
+# Tenets for Development
+* Code should function in both Browser and Node environments
+* Trailing slashes in URL pathnames are meaningful in v3; so where applicable: always omit the slash at the end of the URLs of your API REST call (**this includes the one that might show up before a search query**)
+
+# How to Contribute
+Prequisite Node version: 12+
+
+1. Create a new branch for your change; if there's a JIRA ticket associated use that, e.g., `git checkout -b EPILIBS-42`
+2. Make your changes
+3. Create a [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) describing your changes
+   * If you feel your change breaks the existing usage of the library be sure to indicate this in the commit message by adding a note in the commit footer starting with: `BREAKING CHANGE: `
+4. Push up your branch and make sure it passes the tests in the pre-push hook
+5. Make a pull request on github, or if you're confident: merge your branch into `master`
+
+# How to Prepare a Release
+1. Build to the `dist/` folder: `npm run build`
+2. Test to make sure there are no breaking changes: `npm run single-test`
+3. Make sure you have the latest tags from master: `git fetch origin`
+4. Update version in the `package.json` file; suffix your version with `-breaking` if it contains a breaking change
+5. Update the change log: `npm run changelog` to generate the diff between versions
+6. Commit `package.json` and `CHANGELOG.md` files to `master`
+7. Tag `master` with the same version you used in step 4 (prefix with 'v')
+8. Visit Jenkins: https://build.forio.com/job/deploy-epicenter-js-v3--epicenter--/
+
+\*The web development team isn't planning on incrementing the number that correlates to the major version, that space is reserved for major platform changes (i.e., Epicenter v4 and beyond). Instead, starting in `v3.8.0` -- we will opt to track breaking changes with a suffix `-breaking` and increment the minor number instead.
+
+E.g., `3.10.0-breaking` indicates a breaking change to `3.9.x`. **Beware of these changes when incrementing versions; do not jump minor versions without looking at the tags in between.** You can utilize the CHANGELOG.md to review what has changed between versions and tags.
+
+# How to Test
+Tests are written to preserve behavior across releases. These are unit tests and are not intended for testing Epicenter features themselves.
+
+```
+npm install             # Installs dependencies for libs
+npm run build           # Builds libs to dist/ folder
+npm run single-test     # Runs the tests once
+npm run test            # Runs the tests w/ a watch
+```
+Logs during testing are sent to `browser.log` file
+
+# How to Use Examples (Local)
+The following are examples of the Epicenter JS libs use cases. Their intended purpose is to be a sandbox for end-to-end testing.
+
+Do not use these as a starting point/template for new projects. They are not an indicator of frontend best practices, rather -- the choice to use vanilla JavaScript here was to make it universally understandable.
+
+## Vanilla JavaScript
+```
+npm install             # Installs dependencies for libs
+npm run build           # Builds libs to dist/ folder
+cd examples/parcel
+npm install             # Install dependencies for example
+npm start               # Serves example locally at local.forio.com:3913
+```
+## Node Server
+```
+npm install             # Installs dependencies for libs
+npm run build           # Builds libs to dist/ folder
+cd examples/node
+npm install             # Install dependencies for example
+npm start
+```
+
+# Documentation
+Documentation is currently limited. For the time being, please refer to the comments in code. Hoping to support this in a more official capacity at some point, possibly having them generated automatically with tools like [TypeDoc](https://typedoc.org/).

package/dist/browser/AckExtension-e67c6a28.js

@@ -0,0 +1,129 @@
+import { c as createCommonjsModule, a as commonjsGlobal } from './epicenter-2cce2971.js';
+import { a as cometd } from './cometd-eeabdcd4.js';
+
+function _mergeNamespaces(n, m) {
+    m.forEach(function (e) {
+        Object.keys(e).forEach(function (k) {
+            if (k !== 'default' && !(k in n)) {
+                var d = Object.getOwnPropertyDescriptor(e, k);
+                Object.defineProperty(n, k, d.get ? d : {
+                    enumerable: true,
+                    get: function () { return e[k]; }
+                });
+            }
+        });
+    });
+    return Object.freeze(n);
+}
+
+var AckExtension = createCommonjsModule(function (module, exports) {
+/*
+ * Copyright (c) 2008-2020 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+(function(root, factory){
+    {
+        module.exports = factory(cometd);
+    }
+}(commonjsGlobal, function(cometdModule) {
+    /**
+     * This client-side extension enables the client to acknowledge to the server
+     * the messages that the client has received.
+     * For the acknowledgement to work, the server must be configured with the
+     * correspondent server-side ack extension. If both client and server support
+     * the ack extension, then the ack functionality will take place automatically.
+     * By enabling this extension, all messages arriving from the server will arrive
+     * via /meta/connect, so the comet communication will be slightly chattier.
+     * The fact that all messages will return via /meta/connect means also that the
+     * messages will arrive with total order, which is not guaranteed if messages
+     * can arrive via both /meta/connect and normal response.
+     * Messages are not acknowledged one by one, but instead a batch of messages is
+     * acknowledged when the /meta/connect returns.
+     */
+    return cometdModule.AckExtension = function() {
+        var _cometd;
+        var _serverSupportsAcks = false;
+        var _batch;
+
+        function _debug(text, args) {
+            _cometd._debug(text, args);
+        }
+
+        this.registered = function(name, cometd) {
+            _cometd = cometd;
+            _debug('AckExtension: executing registration callback');
+        };
+
+        this.unregistered = function() {
+            _debug('AckExtension: executing unregistration callback');
+            _cometd = null;
+        };
+
+        this.incoming = function(message) {
+            var channel = message.channel;
+            var ext = message.ext;
+            if (channel === '/meta/handshake') {
+                if (ext) {
+                    var ackField = ext.ack;
+                    if (typeof ackField === 'object') {
+                        // New format.
+                        _serverSupportsAcks = ackField.enabled === true;
+                        var batch = ackField.batch;
+                        if (typeof batch === 'number') {
+                            _batch = batch;
+                        }
+                    } else {
+                        // Old format.
+                        _serverSupportsAcks = ackField === true;
+                    }
+                }
+                _debug('AckExtension: server supports acknowledgements', _serverSupportsAcks);
+            } else if (channel === '/meta/connect' && message.successful && _serverSupportsAcks) {
+                if (ext && typeof ext.ack === 'number') {
+                    _batch = ext.ack;
+                    _debug('AckExtension: server sent batch', _batch);
+                }
+            }
+            return message;
+        };
+
+        this.outgoing = function(message) {
+            var channel = message.channel;
+            if (!message.ext) {
+                message.ext = {};
+            }
+            if (channel === '/meta/handshake') {
+                message.ext.ack = _cometd && _cometd.ackEnabled !== false;
+                _serverSupportsAcks = false;
+                _batch = 0;
+            } else if (channel === '/meta/connect') {
+                if (_serverSupportsAcks) {
+                    message.ext.ack = _batch;
+                    _debug('AckExtension: client sending batch', _batch);
+                }
+            }
+            return message;
+        };
+    };
+}));
+});
+
+var AckExtension$1 = /*#__PURE__*/Object.freeze(/*#__PURE__*/_mergeNamespaces({
+    __proto__: null,
+    'default': AckExtension
+}, [AckExtension]));
+
+export { AckExtension$1 as A };
+//# sourceMappingURL=AckExtension-e67c6a28.js.map

package/dist/browser/AckExtension-e67c6a28.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AckExtension-e67c6a28.js","sources":["../../node_modules/cometd/AckExtension.js"],"sourcesContent":["/*\n * Copyright (c) 2008-2020 the original author or authors.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n(function(root, factory){\n    if (typeof exports === 'object') {\n        module.exports = factory(require('./cometd'));\n    } else if (typeof define === 'function' && define.amd) {\n        define(['./cometd'], factory);\n    } else {\n        factory(root.org.cometd);\n    }\n}(this, function(cometdModule) {\n    /**\n     * This client-side extension enables the client to acknowledge to the server\n     * the messages that the client has received.\n     * For the acknowledgement to work, the server must be configured with the\n     * correspondent server-side ack extension. If both client and server support\n     * the ack extension, then the ack functionality will take place automatically.\n     * By enabling this extension, all messages arriving from the server will arrive\n     * via /meta/connect, so the comet communication will be slightly chattier.\n     * The fact that all messages will return via /meta/connect means also that the\n     * messages will arrive with total order, which is not guaranteed if messages\n     * can arrive via both /meta/connect and normal response.\n     * Messages are not acknowledged one by one, but instead a batch of messages is\n     * acknowledged when the /meta/connect returns.\n     */\n    return cometdModule.AckExtension = function() {\n        var _cometd;\n        var _serverSupportsAcks = false;\n        var _batch;\n\n        function _debug(text, args) {\n            _cometd._debug(text, args);\n        }\n\n        this.registered = function(name, cometd) {\n            _cometd = cometd;\n            _debug('AckExtension: executing registration callback');\n        };\n\n        this.unregistered = function() {\n            _debug('AckExtension: executing unregistration callback');\n            _cometd = null;\n        };\n\n        this.incoming = function(message) {\n            var channel = message.channel;\n            var ext = message.ext;\n            if (channel === '/meta/handshake') {\n                if (ext) {\n                    var ackField = ext.ack;\n                    if (typeof ackField === 'object') {\n                        // New format.\n                        _serverSupportsAcks = ackField.enabled === true;\n                        var batch = ackField.batch;\n                        if (typeof batch === 'number') {\n                            _batch = batch;\n                        }\n                    } else {\n                        // Old format.\n                        _serverSupportsAcks = ackField === true;\n                    }\n                }\n                _debug('AckExtension: server supports acknowledgements', _serverSupportsAcks);\n            } else if (channel === '/meta/connect' && message.successful && _serverSupportsAcks) {\n                if (ext && typeof ext.ack === 'number') {\n                    _batch = ext.ack;\n                    _debug('AckExtension: server sent batch', _batch);\n                }\n            }\n            return message;\n        };\n\n        this.outgoing = function(message) {\n            var channel = message.channel;\n            if (!message.ext) {\n                message.ext = {};\n            }\n            if (channel === '/meta/handshake') {\n                message.ext.ack = _cometd && _cometd.ackEnabled !== false;\n                _serverSupportsAcks = false;\n                _batch = 0;\n            } else if (channel === '/meta/connect') {\n                if (_serverSupportsAcks) {\n                    message.ext.ack = _batch;\n                    _debug('AckExtension: client sending batch', _batch);\n                }\n            }\n            return message;\n        };\n    };\n}));\n"],"names":["require$$0","this"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,CAAC,SAAS,IAAI,EAAE,OAAO,CAAC;AACxB,IAAqC;AACrC,QAAQ,cAAc,GAAG,OAAO,CAACA,MAAmB,CAAC,CAAC;AACtD,KAIK;AACL,CAAC,CAACC,cAAI,EAAE,SAAS,YAAY,EAAE;AAC/B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,IAAI,OAAO,YAAY,CAAC,YAAY,GAAG,WAAW;AAClD,QAAQ,IAAI,OAAO,CAAC;AACpB,QAAQ,IAAI,mBAAmB,GAAG,KAAK,CAAC;AACxC,QAAQ,IAAI,MAAM,CAAC;AACnB;AACA,QAAQ,SAAS,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE;AACpC,YAAY,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACvC,SAAS;AACT;AACA,QAAQ,IAAI,CAAC,UAAU,GAAG,SAAS,IAAI,EAAE,MAAM,EAAE;AACjD,YAAY,OAAO,GAAG,MAAM,CAAC;AAC7B,YAAY,MAAM,CAAC,+CAA+C,CAAC,CAAC;AACpE,SAAS,CAAC;AACV;AACA,QAAQ,IAAI,CAAC,YAAY,GAAG,WAAW;AACvC,YAAY,MAAM,CAAC,iDAAiD,CAAC,CAAC;AACtE,YAAY,OAAO,GAAG,IAAI,CAAC;AAC3B,SAAS,CAAC;AACV;AACA,QAAQ,IAAI,CAAC,QAAQ,GAAG,SAAS,OAAO,EAAE;AAC1C,YAAY,IAAI,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;AAC1C,YAAY,IAAI,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;AAClC,YAAY,IAAI,OAAO,KAAK,iBAAiB,EAAE;AAC/C,gBAAgB,IAAI,GAAG,EAAE;AACzB,oBAAoB,IAAI,QAAQ,GAAG,GAAG,CAAC,GAAG,CAAC;AAC3C,oBAAoB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;AACtD;AACA,wBAAwB,mBAAmB,GAAG,QAAQ,CAAC,OAAO,KAAK,IAAI,CAAC;AACxE,wBAAwB,IAAI,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;AACnD,wBAAwB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;AACvD,4BAA4B,MAAM,GAAG,KAAK,CAAC;AAC3C,yBAAyB;AACzB,qBAAqB,MAAM;AAC3B;AACA,wBAAwB,mBAAmB,GAAG,QAAQ,KAAK,IAAI,CAAC;AAChE,qBAAqB;AACrB,iBAAiB;AACjB,gBAAgB,MAAM,CAAC,gDAAgD,EAAE,mBAAmB,CAAC,CAAC;AAC9F,aAAa,MAAM,IAAI,OAAO,KAAK,eAAe,IAAI,OAAO,CAAC,UAAU,IAAI,mBAAmB,EAAE;AACjG,gBAAgB,IAAI,GAAG,IAAI,OAAO,GAAG,CAAC,GAAG,KAAK,QAAQ,EAAE;AACxD,oBAAoB,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC;AACrC,oBAAoB,MAAM,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;AACtE,iBAAiB;AACjB,aAAa;AACb,YAAY,OAAO,OAAO,CAAC;AAC3B,SAAS,CAAC;AACV;AACA,QAAQ,IAAI,CAAC,QAAQ,GAAG,SAAS,OAAO,EAAE;AAC1C,YAAY,IAAI,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;AAC1C,YAAY,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;AAC9B,gBAAgB,OAAO,CAAC,GAAG,GAAG,EAAE,CAAC;AACjC,aAAa;AACb,YAAY,IAAI,OAAO,KAAK,iBAAiB,EAAE;AAC/C,gBAAgB,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,OAAO,IAAI,OAAO,CAAC,UAAU,KAAK,KAAK,CAAC;AAC1E,gBAAgB,mBAAmB,GAAG,KAAK,CAAC;AAC5C,gBAAgB,MAAM,GAAG,CAAC,CAAC;AAC3B,aAAa,MAAM,IAAI,OAAO,KAAK,eAAe,EAAE;AACpD,gBAAgB,IAAI,mBAAmB,EAAE;AACzC,oBAAoB,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,MAAM,CAAC;AAC7C,oBAAoB,MAAM,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;AACzE,iBAAiB;AACjB,aAAa;AACb,YAAY,OAAO,OAAO,CAAC;AAC3B,SAAS,CAAC;AACV,KAAK,CAAC;AACN,CAAC,CAAC;;;;;;;;;;"}