docs: Document logic for storing the token in vuex state

[arlyon]

This is as much an issue as it is a pull request. Currently your token will not appear in vuex with the default prefix (_token.). For me, this is unexpected and at the least should be documented, but may also be a bug.

The "offending" line is:

auth-module/src/core/storage.ts

Line 138 in f699074

if (key[0] === '_') {

With the default prefix, the token is not added to the vuex store. At the very least, this should be documented, but I argue that the default prefix should be changed (maybe to just token). What are the consequences of this?

Thanks for the lib! :)

[arlyon]

Not sure how to rerun the semantic commit check but I believe I am compliant. What do we need to merge this?

[codyseibert]

I am running into this same issue. I don't understand why this if statement is here. I wouldn't think we'd need to change the prefix just to have it show up in the Vuex store. I'm also not seeing it set loggedIn to true either even after changing the prefix to remove the '_'.

[bmulholland]

I recognize I'm getting to this very late, but I appreciate the contribution. I agree that this behaviour isn't obvious, but I don't understand it and we need a better test suite before changing the actual behaviour. For now, having it documented is better than nothing. Thanks again.

[bmulholland]

BTW the semantic PR check failed because the commit itself, not the PR title, didn't match. But all good, I'll squash it.

[arlyon]

Ah, of course. That's what I get for coding late at night. Thanks for merging!

[bmulholland]

Thanks for the contribution!