svelte-session-manager
Version:
Session store for svelte (currently only for JWT)
257 lines (168 loc) • 9.88 kB
Markdown
[](https://svelte.dev)
[](https://www.npmjs.com/package/svelte-session-manager)
[](https://spdx.org/licenses/0BSD.html)
[](https://bundlejs.com/?q=svelte-session-manager)
[](https://npmjs.org/package/svelte-session-manager)
[](https://github.com/arlac77/svelte-session-manager/issues)
[](https://actions-badge.atrox.dev/arlac77/svelte-session-manager/goto)
[](https://github.com/prettier/prettier)
[](http://commitizen.github.io/cz-cli/)
[](https://snyk.io/test/github/arlac77/svelte-session-manager)
[](https://coveralls.io/github/arlac77/svelte-session-manager)
[](https://github.com/DevExpress/testcafe)
# svelte-session-manager
Session store for svelte (currently only for JWT)
# usage
```js
import { derived } from 'svelte';
import { Session, login } from 'svelte-session-manager';
// use localStorage as backing store
let session = new Session(localStorage);
// session may still be valid
if(!session.isValid) {
await login(session, 'https://mydomain.com/authenticate', 'a user', 'a secret');
}
session.isValid; // true when auth was ok or localStorage token is still valid
export const values = derived(
session,
($session, set) => {
if (!session.isValid) {
set([]); // session has expired no more data
} else {
fetch('https://mydomain.com/values', {
headers: {
...session.authorizationHeader
}
}).then(async data => set(await data.json()));
}
return () => {};
}
,[]);
// $values contains fetch result as long as session has not expired
```
## run tests
```sh
export BROWSER=safari|chrome|...
npm|yarn test
```
The test runs the following requests against the server
* successful auth
```sh
curl -X POST -d '{"username":"user","password":"secret"}' 'http://[::]:5000/api/login'
```
{"access_token":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbnRpdGxlbWVudHMiOiJhLGIsYyIsImlhdCI6MTYwNDY2NDI0NywiZXhwIjoxNjA0NjY0MjYyfQ.qyjeoCuXO0iyYwSxM2sM02_BVhaZobRmEWam1M8Hzkx51nbsAuTR8G1rNgz1COo_KvbCU7LwZt7qnSEFB1tcwyDA1eBxwc2Wb7JxWgQ50m1IWkr2JCgY1seWRJRcwZBXiTRtiPqhzofP-l3S-CBluzU48cd4yzoPayczLkKuPK4"}
* invalid credentials
```sh
curl -X POST -d '{"username":"user","password":"wrong"}' 'http://[::]:5000/api/login'
```
{"message":"Unauthorized"}
## Live Example
[live example](https://svelte-session-manager.pages.dev/)
# API
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
### Table of Contents
* [login](#login)
* [Parameters](#parameters)
* [handleFailedResponse](#handlefailedresponse)
* [Parameters](#parameters-1)
* [SessionData](#sessiondata)
* [Properties](#properties)
* [msecsRequiredForRefresh](#msecsrequiredforrefresh)
* [supportedTokenTypes](#supportedtokentypes)
* [Session](#session)
* [Parameters](#parameters-2)
* [Properties](#properties-1)
* [update](#update)
* [Parameters](#parameters-3)
* [refresh](#refresh)
* [authorizationHeader](#authorizationheader)
* [isValid](#isvalid)
* [invalidate](#invalidate)
* [hasEntitlement](#hasentitlement)
* [Parameters](#parameters-4)
* [subscribe](#subscribe)
* [Parameters](#parameters-5)
* [decode](#decode)
* [Parameters](#parameters-6)
## login
Bring session into the valid state by calling the authorization endpoint
and asking for a access\_token.
Executes a POST on the endpoint url expecting username, and password as json
### Parameters
* `session` **[Session](#session)** to be opened
* `endpoint` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** authorization url
* `username` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** id of the user
* `password` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** user credentials
* `tokenmap` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** token names in response to internal known values (optional, default `defaultTokenMap`)
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** error message in case of failure or undefined on success
## handleFailedResponse
Extract error description from response.
### Parameters
* `response` **[Response](https://developer.mozilla.org/docs/Web/Guide/HTML/HTML5)** 
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** 
## SessionData
Data as preserved in the backing store.
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
### Properties
* `username` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** user name (id)
* `access_token` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** JWT token
* `refresh_token` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** JWT token
## msecsRequiredForRefresh
Time required to execute a refresh
Type: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)
## supportedTokenTypes
## Session
User session.
To create as session backed by browser local storage.
```js
let session = new Session(localStorage);
```
or by browser session storage
```js
let session = new Session(sessionStorage);
```
### Parameters
* `store` **[SessionData](#sessiondata)** (optional, default `localStorage`)
### Properties
* `entitlements` **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** 
* `subscriptions` **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>** store subscriptions
* `expirationDate` **[Date](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date)** when the access token expires
* `access_token` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** token itself
* `refresh_token` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** refresh token
### update
Consume auth response data and reflect internal state.
#### Parameters
* `data` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
### refresh
Refresh with refresh\_token.
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)>** true if refresh was succcessfull false otherwise
### authorizationHeader
Http header suitable for fetch.
Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** header The http header.
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** header.Authorization The Bearer access token.
### isValid
As long as the expirationTimer is running we must be valid.
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if session is valid (not expired)
### invalidate
Remove all tokens from the session and the backing store.
### hasEntitlement
Check presence of an entitlement.
#### Parameters
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the entitlement
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if the named entitlement is present
### subscribe
Fired when the session changes.
#### Parameters
* `subscription` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
## decode
Extract and decode the payload.
### Parameters
* `token` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** payload object
# install
With [npm](http://npmjs.org) do:
```shell
npm install svelte-session-manager
```
# license
BSD-2-Clause