epicenter-libs v3.28.3

Epicenter JavaScript Libs (v3)

The Epicenter JS libs is Forio's JavaScript library for interacting with the Epicenter platform. Similar to its predecessor, 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)
  • New Features In v3
  • Some Things Were Renamed
  • Changes In The Way We Store And Expose User Data
  • Session Expiration & Generic Error Handling
  • Built-in SSO Handling
  • Pagination
  • Presence
• Tenets for Development
• How to Contribute
• How to Prepare a Release
  • Publishing on NPM
    • npm publish --dry-run
    • npm publish --tag next
    • npm unpublish epicenter-libs@{{version}}
    • npm dist-tag add | rm | ls
  • Versioning
• How to Test
• How to Use Examples (Local)
  • Vanilla JavaScript
  • Node Server
• 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 keys 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 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:, and this will be automatically reflected in the changelog when it's generated.
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. Update the version in the package.json to the value you'd like to release
4. Generate a changelog entry using conventional-changelog
   • Entries are created based on the most recent git tag compared to the the version value in package.json
   • For this reason, make sure sure you have the latest tags: git fetch origin
   • Run: npm run changelog -- which will append to the CHANGELOG.md file an automated text translation of the commits created between the most recent git tag, and the current HEAD.
   • Commit your updated CHANGELOG.md: git add CHANGELOG.md && git commit -m "chore: update CHANGELOG"
5. Tag master with the same version you used in step 3 (prefix with 'v')
6. Visit Jenkins to deploy to forio.com/tools/js-libs: https://build.forio.com/job/deploy-epicenter-js-v3--epicenter--/
7. Publish the files in dist/ folder to NPM: npm publish

Publishing on NPM

In order to publish to NPM, you have to be logged into the Forio NPM account. To do this, you'll need perform a one-time login with npm adduser. You will be prompted for a one-time password, which will be sent to tech@forio.com. Afterwhich, you'll be able to run npm publish. Below are other helpful commands to consider.

npm publish --dry-run

For doing a test run before actually publishing

npm publish --tag next

For when you want to publish an alpha version of the libs for testing. Normal installations will not pick up versions tagged as "next". This way, you can publish on a change you want to test, and then go to an external project and run npm install -i epicenter-libs@next to go and play around with your changes.

npm unpublish epicenter-libs@{{version}}

For when you accidentally publish an incorrect version (this removes the package version from the registry, as well as deletes its entry, removign the tarball).

npm dist-tag add | rm | ls

Manages distribution tags, for when you make a typo spelling "--tag next" and you end up publishing epicenter-libs@name.

Versioning

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.

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.