UNPKG

@al/session

Version:

A client for maintaining Alert Logic session data

github.com/alertlogic/session-client

alertlogic/session-client

146 lines (74 loc) • 3.56 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
@al/session ========= A client for maintaining [Alert Logic](https://www.alertlogic.com/) session data. This library uses local-storage-fallback to provide transparent persistent storage to consumers. ## Disclaimer Until the release of version 1.0.0 all current minor version increments may be backwards incompatible. Please bear this in mind when developing against this library. Should you have any further questions, please do not hesitate to contact us as [npm@alertlogic.com](mailto:npm@alertlogic.com) Installation --- npm install @al/session --save Usage --- For commonjs environments, e.g nodejs: var ALSession = require('@al/session').ALSession; For ES2015 environments, e.g. TypeScript based frameworks such as Angular: import { ALSession } from '@al/session'; Methods --- **activateSession** Sets isSessionActive to true if authentication.token_expiration is in the future. ALSession.activateSession(); **deactivateSession** Sets isSessionActive to false and empties the cache of user and customer data. ALSession.deactivateSession(); **isSessionActive** Boolean check to see if the session data itself is verified as potentially valid. ALSession.isSessionActive(); **setUserAuthentication** Sets the authenticated user details ALSession.setUserAuthentication(proposal); Takes a proposal parameter in the format of an [AIMS authentication resource](https://console.account.alertlogic.com/users/api/aims/#api-AIMS_Authentication_and_Authorization_Resources-Authenticate) **getUserAuthentication** Returns the currently logged in user's AIMS authentication resource. ALSession.getUserAuthentication(); **setActingAccount** Sets the acting account for the current authenticated user ALSession.setActingAccount(account) Takes an account parameter in the format of an [AIMS account resource](https://console.account.alertlogic.com/users/api/aims/#api-AIMS_Authentication_and_Authorization_Resources-Authenticate) **getActingAccount** Returns an the current acting account (modelled on an AIMS account). ALSession.getActingAccount(); **getToken** Returns the current AIMS authentication token string. ALSession.getToken(); **getTokenExpiry** Returns the current AIMS authentication token expiry. ALSession.getToken(); ## Convenience methods for user **getUserID** **getUserName** **getUserEmail** **getUserAccountID** **getUserAccessibleLocations** ## Convenience methods for acting account **getActingAccountID** **getActingAccountName** **getActingAccountDefaultLocation** **getActingAccountAccessibleLocations** ## Interactive Loads the library into memory and stays in an interactive node shell. npm run interactive After running this command you can access the `ALSession` object and call methods directly on it. ## Tests npm test or to watch for code changes and re-run tests: npm test-watch An auto-generated `coverage` directory will be produced which will contain a browsable HTML report ## Contributing The sources are written in Typescript and follow the tslint [airbnb](https://www.npmjs.com/package/tslint-config-airbnb) style. ## Building To generate a production build npm run build To generate a development build for local testing - non minified, concatenated only npm run build-dev Builds will be be generated into a `dist` folder and will contain commonjs and umd bundles that will be consumed depending on the module system in whichever environment you are using.