airdcpp-apisocket 2.4.4 → 2.5.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (137) hide show
  1. package/GUIDE.md +7 -7
  2. package/README.md +3 -2
  3. package/babel.config.cjs +6 -0
  4. package/dist/ApiConstants.d.ts +6 -6
  5. package/dist/ApiConstants.js +7 -7
  6. package/dist/NodeSocket.d.ts +4 -4
  7. package/dist/NodeSocket.js +24 -20
  8. package/dist/NodeSocket.js.map +1 -1
  9. package/dist/Promise.d.ts +8 -8
  10. package/dist/Promise.js +26 -26
  11. package/dist/Promise.js.map +1 -1
  12. package/dist/PublicHelpers.d.ts +2 -2
  13. package/dist/PublicHelpers.js +94 -192
  14. package/dist/PublicHelpers.js.map +1 -1
  15. package/dist/SocketBase.d.ts +4 -4
  16. package/dist/SocketBase.js +351 -359
  17. package/dist/SocketBase.js.map +1 -1
  18. package/dist/SocketLogger.d.ts +9 -9
  19. package/dist/SocketLogger.js +74 -84
  20. package/dist/SocketLogger.js.map +1 -1
  21. package/dist/SocketRequestHandler.d.ts +14 -14
  22. package/dist/SocketRequestHandler.js +168 -176
  23. package/dist/SocketRequestHandler.js.map +1 -1
  24. package/dist/SocketSubscriptionHandler.d.ts +11 -11
  25. package/dist/SocketSubscriptionHandler.js +161 -173
  26. package/dist/SocketSubscriptionHandler.js.map +1 -1
  27. package/dist/types/api.d.ts +30 -30
  28. package/dist/types/api.js +3 -3
  29. package/dist/types/api_internal.d.ts +24 -24
  30. package/dist/types/api_internal.js +2 -2
  31. package/dist/types/index.d.ts +7 -7
  32. package/dist/types/index.js +23 -19
  33. package/dist/types/index.js.map +1 -1
  34. package/dist/types/logger.d.ts +6 -6
  35. package/dist/types/logger.js +2 -2
  36. package/dist/types/options.d.ts +31 -31
  37. package/dist/types/options.js +3 -3
  38. package/dist/types/public_helpers.d.ts +19 -14
  39. package/dist/types/public_helpers.js +2 -2
  40. package/dist/types/public_helpers_internal.d.ts +27 -25
  41. package/dist/types/public_helpers_internal.js +2 -2
  42. package/dist/types/requests.d.ts +14 -14
  43. package/dist/types/requests.js +2 -2
  44. package/dist/types/socket.d.ts +23 -23
  45. package/dist/types/socket.js +2 -3
  46. package/dist/types/socket.js.map +1 -1
  47. package/dist/types/subscriptions.d.ts +20 -20
  48. package/dist/types/subscriptions.js +2 -2
  49. package/dist/utils.d.ts +2 -2
  50. package/dist/utils.js +15 -15
  51. package/dist/utils.js.map +1 -1
  52. package/dist-es/ApiConstants.d.ts +6 -6
  53. package/dist-es/ApiConstants.js +5 -5
  54. package/dist-es/NodeSocket.d.ts +4 -4
  55. package/dist-es/NodeSocket.js +4 -4
  56. package/dist-es/NodeSocket.js.map +1 -1
  57. package/dist-es/Promise.d.ts +8 -8
  58. package/dist-es/Promise.js +24 -24
  59. package/dist-es/Promise.js.map +1 -1
  60. package/dist-es/PublicHelpers.d.ts +2 -2
  61. package/dist-es/PublicHelpers.js +90 -188
  62. package/dist-es/PublicHelpers.js.map +1 -1
  63. package/dist-es/SocketBase.d.ts +4 -4
  64. package/dist-es/SocketBase.js +346 -354
  65. package/dist-es/SocketBase.js.map +1 -1
  66. package/dist-es/SocketLogger.d.ts +9 -9
  67. package/dist-es/SocketLogger.js +68 -78
  68. package/dist-es/SocketLogger.js.map +1 -1
  69. package/dist-es/SocketRequestHandler.d.ts +14 -14
  70. package/dist-es/SocketRequestHandler.js +163 -171
  71. package/dist-es/SocketRequestHandler.js.map +1 -1
  72. package/dist-es/SocketSubscriptionHandler.d.ts +11 -11
  73. package/dist-es/SocketSubscriptionHandler.js +156 -168
  74. package/dist-es/SocketSubscriptionHandler.js.map +1 -1
  75. package/dist-es/types/api.d.ts +30 -30
  76. package/dist-es/types/api.js +2 -2
  77. package/dist-es/types/api_internal.d.ts +24 -24
  78. package/dist-es/types/api_internal.js +1 -1
  79. package/dist-es/types/index.d.ts +7 -7
  80. package/dist-es/types/index.js +7 -7
  81. package/dist-es/types/index.js.map +1 -1
  82. package/dist-es/types/logger.d.ts +6 -6
  83. package/dist-es/types/logger.js +1 -1
  84. package/dist-es/types/options.d.ts +31 -31
  85. package/dist-es/types/options.js +2 -2
  86. package/dist-es/types/public_helpers.d.ts +19 -14
  87. package/dist-es/types/public_helpers.js +1 -1
  88. package/dist-es/types/public_helpers_internal.d.ts +27 -25
  89. package/dist-es/types/public_helpers_internal.js +1 -1
  90. package/dist-es/types/requests.d.ts +14 -14
  91. package/dist-es/types/requests.js +1 -1
  92. package/dist-es/types/socket.d.ts +23 -23
  93. package/dist-es/types/socket.js +1 -2
  94. package/dist-es/types/socket.js.map +1 -1
  95. package/dist-es/types/subscriptions.d.ts +20 -20
  96. package/dist-es/types/subscriptions.js +1 -1
  97. package/dist-es/utils.d.ts +2 -2
  98. package/dist-es/utils.js +11 -11
  99. package/dist-es/utils.js.map +1 -1
  100. package/jest.config.js +15 -3
  101. package/package.json +15 -13
  102. package/src/NodeSocket.ts +3 -3
  103. package/src/PublicHelpers.ts +11 -10
  104. package/src/SocketBase.ts +9 -9
  105. package/src/SocketLogger.ts +6 -6
  106. package/src/SocketRequestHandler.ts +10 -10
  107. package/src/SocketSubscriptionHandler.ts +10 -10
  108. package/src/tests/Socket.test.ts +29 -26
  109. package/src/tests/helpers.ts +14 -8
  110. package/src/tests/public_helpers.test.ts +7 -6
  111. package/src/types/api_internal.ts +1 -1
  112. package/src/types/index.ts +7 -7
  113. package/src/types/public_helpers.ts +7 -1
  114. package/src/types/public_helpers_internal.ts +3 -1
  115. package/src/types/requests.ts +1 -1
  116. package/src/types/socket.ts +4 -20
  117. package/src/types/subscriptions.ts +1 -1
  118. package/src/utils.ts +1 -1
  119. package/tsconfig.json +5 -10
  120. package/dist/tests/Socket.test.d.ts +0 -1
  121. package/dist/tests/Socket.test.js +0 -758
  122. package/dist/tests/Socket.test.js.map +0 -1
  123. package/dist/tests/helpers.d.ts +0 -57
  124. package/dist/tests/helpers.js +0 -178
  125. package/dist/tests/helpers.js.map +0 -1
  126. package/dist/tests/public_helpers.test.d.ts +0 -1
  127. package/dist/tests/public_helpers.test.js +0 -241
  128. package/dist/tests/public_helpers.test.js.map +0 -1
  129. package/dist-es/tests/Socket.test.d.ts +0 -1
  130. package/dist-es/tests/Socket.test.js +0 -734
  131. package/dist-es/tests/Socket.test.js.map +0 -1
  132. package/dist-es/tests/helpers.d.ts +0 -57
  133. package/dist-es/tests/helpers.js +0 -168
  134. package/dist-es/tests/helpers.js.map +0 -1
  135. package/dist-es/tests/public_helpers.test.d.ts +0 -1
  136. package/dist-es/tests/public_helpers.test.js +0 -236
  137. package/dist-es/tests/public_helpers.test.js.map +0 -1
@@ -1,360 +1,352 @@
1
- "use strict";
2
- var __assign = (this && this.__assign) || function () {
3
- __assign = Object.assign || function(t) {
4
- for (var s, i = 1, n = arguments.length; i < n; i++) {
5
- s = arguments[i];
6
- for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
7
- t[p] = s[p];
8
- }
9
- return t;
10
- };
11
- return __assign.apply(this, arguments);
12
- };
13
- var __importDefault = (this && this.__importDefault) || function (mod) {
14
- return (mod && mod.__esModule) ? mod : { "default": mod };
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- var ApiConstants_1 = __importDefault(require("./ApiConstants"));
18
- var SocketLogger_1 = __importDefault(require("./SocketLogger"));
19
- var SocketSubscriptionHandler_1 = __importDefault(require("./SocketSubscriptionHandler"));
20
- var SocketRequestHandler_1 = __importDefault(require("./SocketRequestHandler"));
21
- var invariant_1 = __importDefault(require("invariant"));
22
- var Promise_1 = __importDefault(require("./Promise"));
23
- // CONSTANTS
24
- var defaultOptions = {
25
- autoReconnect: true,
26
- reconnectInterval: 10,
27
- userSession: false,
28
- };
29
- var ApiSocket = function (userOptions, WebSocketImpl) {
30
- var options = __assign(__assign({}, defaultOptions), userOptions);
31
- var ws = null;
32
- var authToken = null;
33
- var socket = null;
34
- var reconnectTimer;
35
- var forceNoAutoConnect = true;
36
- var connectedCallback = null;
37
- var sessionResetCallback = null;
38
- var disconnectedCallback = null;
39
- var logger = (0, SocketLogger_1.default)(options);
40
- var subscriptions = (0, SocketSubscriptionHandler_1.default)(function () { return socket; }, logger, options);
41
- var requests = (0, SocketRequestHandler_1.default)(function () { return socket; }, logger, options);
42
- (0, invariant_1.default)(userOptions.url, '"url" must be defined in settings object');
43
- var resetSession = function () {
44
- if (authToken) {
45
- if (sessionResetCallback) {
46
- sessionResetCallback();
47
- }
48
- authToken = null;
49
- }
50
- };
51
- var onClosed = function (event) {
52
- if (event.wasClean) {
53
- logger.info('Websocket was closed normally');
54
- }
55
- else {
56
- logger.error("Websocket failed: " + event.reason + " (code: " + event.code + ")");
57
- }
58
- requests.onSocketDisconnected();
59
- subscriptions.onSocketDisconnected();
60
- ws = null;
61
- if (disconnectedCallback) {
62
- disconnectedCallback(event.reason, event.code, event.wasClean);
63
- }
64
- if (authToken && options.autoReconnect && !forceNoAutoConnect) {
65
- setTimeout(function () {
66
- if (forceNoAutoConnect) {
67
- return;
68
- }
69
- socket.reconnect()
70
- .catch(function (error) {
71
- logger.error('Reconnect failed for a closed socket', error.message);
72
- });
73
- });
74
- }
75
- };
76
- var onMessage = function (event) {
77
- var messageObj = JSON.parse(event.data);
78
- if (messageObj.callback_id) {
79
- // Callback
80
- requests.handleMessage(messageObj);
81
- }
82
- else {
83
- // Listener message
84
- subscriptions.handleMessage(messageObj);
85
- }
86
- };
87
- var setSocketHandlers = function () {
88
- ws.onerror = function (event) {
89
- logger.error("Websocket failed: " + event.reason);
90
- };
91
- ws.onclose = onClosed;
92
- ws.onmessage = onMessage;
93
- };
94
- // Connect handler for creation of new session
95
- var handlePasswordLogin = function (username, password) {
96
- if (username === void 0) { username = options.username; }
97
- if (password === void 0) { password = options.password; }
98
- if (!username) {
99
- throw '"username" option was not supplied for authentication';
100
- }
101
- if (!password) {
102
- throw '"password" option was not supplied for authentication';
103
- }
104
- var data = {
105
- username: username,
106
- password: password,
107
- grant_type: 'password',
108
- };
109
- return requests.postAuthenticate(ApiConstants_1.default.LOGIN_URL, data);
110
- };
111
- var handleRefreshTokenLogin = function (refreshToken) {
112
- if (!refreshToken) {
113
- throw '"refreshToken" option was not supplied for authentication';
114
- }
115
- var data = {
116
- refresh_token: refreshToken,
117
- grant_type: 'refresh_token',
118
- };
119
- return requests.postAuthenticate(ApiConstants_1.default.LOGIN_URL, data);
120
- };
121
- // Connect handler for associating socket with an existing session token
122
- var handleAuthorizeToken = function () {
123
- var data = {
124
- auth_token: authToken,
125
- };
126
- return requests.postAuthenticate(ApiConstants_1.default.CONNECT_URL, data);
127
- };
128
- // Called after a successful authentication request
129
- var onSocketAuthenticated = function (data) {
130
- if (!authToken) {
131
- // New session
132
- logger.info('Login succeed');
133
- authToken = data.auth_token;
134
- }
135
- else {
136
- // Existing session
137
- logger.info('Socket associated with an existing session');
138
- }
139
- if (connectedCallback) {
140
- // Catch separately as we don't want an infinite reconnect loop
141
- try {
142
- connectedCallback(data);
143
- }
144
- catch (e) {
145
- console.error('Error in socket connect handler', e.message);
146
- }
147
- requests.onSocketConnected();
148
- }
149
- };
150
- // Send API authentication and handle the result
151
- // Authentication handler should send the actual authentication request
152
- var authenticate = function (resolve, reject, authenticationHandler, reconnectHandler) {
153
- authenticationHandler()
154
- .then(function (data) {
155
- onSocketAuthenticated(data);
156
- resolve(data);
157
- })
158
- .catch(function (error) {
159
- if (error.code) {
160
- if (authToken && error.code === 400 && options.autoReconnect) {
161
- // The session was lost (most likely the client was restarted)
162
- logger.info('Session lost, re-sending credentials');
163
- resetSession();
164
- authenticate(resolve, reject, handlePasswordLogin, reconnectHandler);
165
- return;
166
- }
167
- else if (error.code === 401) {
168
- // Invalid credentials, reset the token if we were reconnecting to avoid an infinite loop
169
- resetSession();
170
- }
171
- // Authentication was rejected
172
- socket.disconnect(undefined, 'Authentication failed');
173
- }
174
- else {
175
- // Socket was disconnected during the authentication
176
- logger.info('Socket disconnected during authentication, reconnecting');
177
- reconnectHandler();
178
- return;
179
- }
180
- reject(error);
181
- });
182
- };
183
- // Authentication handler should send the actual authentication request
184
- var connectInternal = function (resolve, reject, authenticationHandler, reconnectOnFailure) {
185
- if (reconnectOnFailure === void 0) { reconnectOnFailure = true; }
186
- ws = new WebSocketImpl(options.url);
187
- var scheduleReconnect = function () {
188
- ws = null;
189
- if (!reconnectOnFailure) {
190
- reject('Cannot connect to the server');
191
- return;
192
- }
193
- reconnectTimer = setTimeout(function () {
194
- logger.info('Socket reconnecting');
195
- connectInternal(resolve, reject, authenticationHandler, reconnectOnFailure);
196
- }, options.reconnectInterval * 1000);
197
- };
198
- ws.onopen = function () {
199
- logger.info('Socket connected');
200
- setSocketHandlers();
201
- authenticate(resolve, reject, authenticationHandler, scheduleReconnect);
202
- };
203
- ws.onerror = function (event) {
204
- logger.error('Connecting socket failed');
205
- scheduleReconnect();
206
- };
207
- };
208
- // Authentication handler should send the actual authentication request
209
- var startConnect = function (authenticationHandler, reconnectOnFailure) {
210
- forceNoAutoConnect = false;
211
- return new Promise_1.default(function (resolve, reject) {
212
- logger.info('Starting socket connect');
213
- connectInternal(resolve, reject, authenticationHandler, reconnectOnFailure);
214
- });
215
- };
216
- // Is the socket connected and authorized?
217
- var isConnected = function () {
218
- return !!(ws && ws.readyState === (ws.OPEN || 1) && authToken);
219
- };
220
- // Is the socket connected but not possibly authorized?
221
- var isConnecting = function () {
222
- return !!(ws && !isConnected());
223
- };
224
- // Socket exists
225
- var isActive = function () {
226
- return !!ws;
227
- };
228
- var disableReconnect = function () {
229
- clearTimeout(reconnectTimer);
230
- forceNoAutoConnect = true;
231
- };
232
- var waitDisconnected = function (timeoutMs) {
233
- if (timeoutMs === void 0) { timeoutMs = 2000; }
234
- var checkInterval = 50;
235
- var maxAttempts = timeoutMs > 0 ? timeoutMs / checkInterval : 0;
236
- return new Promise_1.default(function (resolve, reject) {
237
- var attempts = 0;
238
- var wait = function () {
239
- if (isActive()) {
240
- if (attempts >= maxAttempts) {
241
- logger.error("Socket disconnect timed out after " + timeoutMs + " ms");
242
- reject('Socket disconnect timed out');
243
- }
244
- else {
245
- setTimeout(wait, checkInterval);
246
- attempts++;
247
- }
248
- }
249
- else {
250
- resolve();
251
- }
252
- };
253
- wait();
254
- });
255
- };
256
- // Disconnects the socket but keeps the session token
257
- var disconnect = function (autoConnect, reason) {
258
- if (autoConnect === void 0) { autoConnect = false; }
259
- if (reason === void 0) { reason = 'Manually disconnected by the client'; }
260
- if (!ws) {
261
- if (!forceNoAutoConnect) {
262
- if (!autoConnect) {
263
- logger.verbose('Disconnecting a closed socket with auto reconnect enabled (cancel reconnect)');
264
- disableReconnect();
265
- }
266
- else {
267
- logger.verbose('Attempting to disconnect a closed socket with auto reconnect enabled (continue connecting)');
268
- }
269
- }
270
- else {
271
- logger.warn('Attempting to disconnect a closed socket (ignore)');
272
- //throw 'Attempting to disconnect a closed socket';
273
- }
274
- return;
275
- }
276
- logger.info('Disconnecting socket');
277
- if (!autoConnect) {
278
- disableReconnect();
279
- }
280
- ws.close(1000, reason);
281
- };
282
- socket = __assign(__assign({
283
- // Start connect
284
- // Username and password are not required if those are available in socket options
285
- connect: function (username, password, reconnectOnFailure) {
286
- if (reconnectOnFailure === void 0) { reconnectOnFailure = true; }
287
- if (isActive()) {
288
- throw 'Connect may only be used for a closed socket';
289
- }
290
- resetSession();
291
- return startConnect(function () { return handlePasswordLogin(username, password); }, reconnectOnFailure);
292
- }, connectRefreshToken: function (refreshToken, reconnectOnFailure) {
293
- if (reconnectOnFailure === void 0) { reconnectOnFailure = true; }
294
- if (isActive()) {
295
- throw 'Connect may only be used for a closed socket';
296
- }
297
- resetSession();
298
- return startConnect(function () { return handleRefreshTokenLogin(refreshToken); }, reconnectOnFailure);
299
- },
300
- // Connect and attempt to associate the socket with an existing session
301
- reconnect: function (token, reconnectOnFailure) {
302
- if (token === void 0) { token = undefined; }
303
- if (reconnectOnFailure === void 0) { reconnectOnFailure = true; }
304
- if (isActive()) {
305
- throw 'Reconnect may only be used for a closed socket';
306
- }
307
- if (token) {
308
- authToken = token;
309
- }
310
- if (!authToken) {
311
- throw 'No session token available for reconnecting';
312
- }
313
- logger.info('Reconnecting socket');
314
- return startConnect(handleAuthorizeToken, reconnectOnFailure);
315
- },
316
- // Remove the associated API session and close the socket
317
- logout: function () {
318
- var resolver = Promise_1.default.pending();
319
- socket.delete(ApiConstants_1.default.LOGOUT_URL)
320
- .then(function (data) {
321
- logger.info('Logout succeed');
322
- resetSession();
323
- resolver.resolve(data);
324
- // Don't fire the disconnected event before resolver actions are handled
325
- disconnect(undefined, 'Logged out');
326
- })
327
- .catch(function (error) {
328
- logger.error('Logout failed', error);
329
- resolver.reject(error);
330
- });
331
- return resolver.promise;
332
- }, disconnect: disconnect, isConnecting: isConnecting, isConnected: isConnected, isActive: isActive, logger: logger, waitDisconnected: waitDisconnected,
333
- // Function to call each time the socket has been connected (and authorized)
334
- set onConnected(handler) {
335
- connectedCallback = handler;
336
- },
337
- // Function to call each time the stored session token was reset (manual logout/rejected reconnect)
338
- set onSessionReset(handler) {
339
- sessionResetCallback = handler;
340
- },
341
- // Function to call each time the socket has been disconnected
342
- set onDisconnected(handler) {
343
- disconnectedCallback = handler;
344
- },
345
- get onConnected() {
346
- return connectedCallback;
347
- },
348
- get onSessionReset() {
349
- return sessionResetCallback;
350
- },
351
- get onDisconnected() {
352
- return disconnectedCallback;
353
- },
354
- get nativeSocket() {
355
- return ws;
356
- } }, subscriptions.socket), requests.socket);
357
- return socket;
358
- };
359
- exports.default = ApiSocket;
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ const ApiConstants_js_1 = __importDefault(require("./ApiConstants.js"));
7
+ const SocketLogger_js_1 = __importDefault(require("./SocketLogger.js"));
8
+ const SocketSubscriptionHandler_js_1 = __importDefault(require("./SocketSubscriptionHandler.js"));
9
+ const SocketRequestHandler_js_1 = __importDefault(require("./SocketRequestHandler.js"));
10
+ const invariant_1 = __importDefault(require("invariant"));
11
+ const Promise_js_1 = __importDefault(require("./Promise.js"));
12
+ // CONSTANTS
13
+ const defaultOptions = {
14
+ autoReconnect: true,
15
+ reconnectInterval: 10,
16
+ userSession: false,
17
+ };
18
+ const ApiSocket = (userOptions, WebSocketImpl) => {
19
+ const options = {
20
+ ...defaultOptions,
21
+ ...userOptions
22
+ };
23
+ let ws = null;
24
+ let authToken = null;
25
+ let socket = null;
26
+ let reconnectTimer;
27
+ let forceNoAutoConnect = true;
28
+ let connectedCallback = null;
29
+ let sessionResetCallback = null;
30
+ let disconnectedCallback = null;
31
+ const logger = (0, SocketLogger_js_1.default)(options);
32
+ const subscriptions = (0, SocketSubscriptionHandler_js_1.default)(() => socket, logger, options);
33
+ const requests = (0, SocketRequestHandler_js_1.default)(() => socket, logger, options);
34
+ (0, invariant_1.default)(userOptions.url, '"url" must be defined in settings object');
35
+ const resetSession = () => {
36
+ if (authToken) {
37
+ if (sessionResetCallback) {
38
+ sessionResetCallback();
39
+ }
40
+ authToken = null;
41
+ }
42
+ };
43
+ const onClosed = (event) => {
44
+ if (event.wasClean) {
45
+ logger.info('Websocket was closed normally');
46
+ }
47
+ else {
48
+ logger.error(`Websocket failed: ${event.reason} (code: ${event.code})`);
49
+ }
50
+ requests.onSocketDisconnected();
51
+ subscriptions.onSocketDisconnected();
52
+ ws = null;
53
+ if (disconnectedCallback) {
54
+ disconnectedCallback(event.reason, event.code, event.wasClean);
55
+ }
56
+ if (authToken && options.autoReconnect && !forceNoAutoConnect) {
57
+ setTimeout(() => {
58
+ if (forceNoAutoConnect) {
59
+ return;
60
+ }
61
+ socket.reconnect()
62
+ .catch((error) => {
63
+ logger.error('Reconnect failed for a closed socket', error.message);
64
+ });
65
+ });
66
+ }
67
+ };
68
+ const onMessage = (event) => {
69
+ const messageObj = JSON.parse(event.data);
70
+ if (messageObj.callback_id) {
71
+ // Callback
72
+ requests.handleMessage(messageObj);
73
+ }
74
+ else {
75
+ // Listener message
76
+ subscriptions.handleMessage(messageObj);
77
+ }
78
+ };
79
+ const setSocketHandlers = () => {
80
+ ws.onerror = (event) => {
81
+ logger.error(`Websocket failed: ${event.reason}`);
82
+ };
83
+ ws.onclose = onClosed;
84
+ ws.onmessage = onMessage;
85
+ };
86
+ // Connect handler for creation of new session
87
+ const handlePasswordLogin = (username = options.username, password = options.password) => {
88
+ if (!username) {
89
+ throw '"username" option was not supplied for authentication';
90
+ }
91
+ if (!password) {
92
+ throw '"password" option was not supplied for authentication';
93
+ }
94
+ const data = {
95
+ username,
96
+ password,
97
+ grant_type: 'password',
98
+ };
99
+ return requests.postAuthenticate(ApiConstants_js_1.default.LOGIN_URL, data);
100
+ };
101
+ const handleRefreshTokenLogin = (refreshToken) => {
102
+ if (!refreshToken) {
103
+ throw '"refreshToken" option was not supplied for authentication';
104
+ }
105
+ const data = {
106
+ refresh_token: refreshToken,
107
+ grant_type: 'refresh_token',
108
+ };
109
+ return requests.postAuthenticate(ApiConstants_js_1.default.LOGIN_URL, data);
110
+ };
111
+ // Connect handler for associating socket with an existing session token
112
+ const handleAuthorizeToken = () => {
113
+ const data = {
114
+ auth_token: authToken,
115
+ };
116
+ return requests.postAuthenticate(ApiConstants_js_1.default.CONNECT_URL, data);
117
+ };
118
+ // Called after a successful authentication request
119
+ const onSocketAuthenticated = (data) => {
120
+ if (!authToken) {
121
+ // New session
122
+ logger.info('Login succeed');
123
+ authToken = data.auth_token;
124
+ }
125
+ else {
126
+ // Existing session
127
+ logger.info('Socket associated with an existing session');
128
+ }
129
+ if (connectedCallback) {
130
+ // Catch separately as we don't want an infinite reconnect loop
131
+ try {
132
+ connectedCallback(data);
133
+ }
134
+ catch (e) {
135
+ console.error('Error in socket connect handler', e.message);
136
+ }
137
+ requests.onSocketConnected();
138
+ }
139
+ };
140
+ // Send API authentication and handle the result
141
+ // Authentication handler should send the actual authentication request
142
+ const authenticate = (resolve, reject, authenticationHandler, reconnectHandler) => {
143
+ authenticationHandler()
144
+ .then((data) => {
145
+ onSocketAuthenticated(data);
146
+ resolve(data);
147
+ })
148
+ .catch((error) => {
149
+ if (error.code) {
150
+ if (authToken && error.code === 400 && options.autoReconnect) {
151
+ // The session was lost (most likely the client was restarted)
152
+ logger.info('Session lost, re-sending credentials');
153
+ resetSession();
154
+ authenticate(resolve, reject, handlePasswordLogin, reconnectHandler);
155
+ return;
156
+ }
157
+ else if (error.code === 401) {
158
+ // Invalid credentials, reset the token if we were reconnecting to avoid an infinite loop
159
+ resetSession();
160
+ }
161
+ // Authentication was rejected
162
+ socket.disconnect(undefined, 'Authentication failed');
163
+ }
164
+ else {
165
+ // Socket was disconnected during the authentication
166
+ logger.info('Socket disconnected during authentication, reconnecting');
167
+ reconnectHandler();
168
+ return;
169
+ }
170
+ reject(error);
171
+ });
172
+ };
173
+ // Authentication handler should send the actual authentication request
174
+ const connectInternal = (resolve, reject, authenticationHandler, reconnectOnFailure = true) => {
175
+ ws = new WebSocketImpl(options.url);
176
+ const scheduleReconnect = () => {
177
+ ws = null;
178
+ if (!reconnectOnFailure) {
179
+ reject('Cannot connect to the server');
180
+ return;
181
+ }
182
+ reconnectTimer = setTimeout(() => {
183
+ logger.info('Socket reconnecting');
184
+ connectInternal(resolve, reject, authenticationHandler, reconnectOnFailure);
185
+ }, options.reconnectInterval * 1000);
186
+ };
187
+ ws.onopen = () => {
188
+ logger.info('Socket connected');
189
+ setSocketHandlers();
190
+ authenticate(resolve, reject, authenticationHandler, scheduleReconnect);
191
+ };
192
+ ws.onerror = (event) => {
193
+ logger.error('Connecting socket failed');
194
+ scheduleReconnect();
195
+ };
196
+ };
197
+ // Authentication handler should send the actual authentication request
198
+ const startConnect = (authenticationHandler, reconnectOnFailure) => {
199
+ forceNoAutoConnect = false;
200
+ return new Promise_js_1.default((resolve, reject) => {
201
+ logger.info('Starting socket connect');
202
+ connectInternal(resolve, reject, authenticationHandler, reconnectOnFailure);
203
+ });
204
+ };
205
+ // Is the socket connected and authorized?
206
+ const isConnected = () => {
207
+ return !!(ws && ws.readyState === (ws.OPEN || 1) && authToken);
208
+ };
209
+ // Is the socket connected but not possibly authorized?
210
+ const isConnecting = () => {
211
+ return !!(ws && !isConnected());
212
+ };
213
+ // Socket exists
214
+ const isActive = () => {
215
+ return !!ws;
216
+ };
217
+ const disableReconnect = () => {
218
+ clearTimeout(reconnectTimer);
219
+ forceNoAutoConnect = true;
220
+ };
221
+ const waitDisconnected = (timeoutMs = 2000) => {
222
+ const checkInterval = 50;
223
+ const maxAttempts = timeoutMs > 0 ? timeoutMs / checkInterval : 0;
224
+ return new Promise_js_1.default((resolve, reject) => {
225
+ let attempts = 0;
226
+ const wait = () => {
227
+ if (isActive()) {
228
+ if (attempts >= maxAttempts) {
229
+ logger.error(`Socket disconnect timed out after ${timeoutMs} ms`);
230
+ reject('Socket disconnect timed out');
231
+ }
232
+ else {
233
+ setTimeout(wait, checkInterval);
234
+ attempts++;
235
+ }
236
+ }
237
+ else {
238
+ resolve();
239
+ }
240
+ };
241
+ wait();
242
+ });
243
+ };
244
+ // Disconnects the socket but keeps the session token
245
+ const disconnect = (autoConnect = false, reason = 'Manually disconnected by the client') => {
246
+ if (!ws) {
247
+ if (!forceNoAutoConnect) {
248
+ if (!autoConnect) {
249
+ logger.verbose('Disconnecting a closed socket with auto reconnect enabled (cancel reconnect)');
250
+ disableReconnect();
251
+ }
252
+ else {
253
+ logger.verbose('Attempting to disconnect a closed socket with auto reconnect enabled (continue connecting)');
254
+ }
255
+ }
256
+ else {
257
+ logger.warn('Attempting to disconnect a closed socket (ignore)');
258
+ //throw 'Attempting to disconnect a closed socket';
259
+ }
260
+ return;
261
+ }
262
+ logger.info('Disconnecting socket');
263
+ if (!autoConnect) {
264
+ disableReconnect();
265
+ }
266
+ ws.close(1000, reason);
267
+ };
268
+ socket = {
269
+ // Start connect
270
+ // Username and password are not required if those are available in socket options
271
+ connect: (username, password, reconnectOnFailure = true) => {
272
+ if (isActive()) {
273
+ throw 'Connect may only be used for a closed socket';
274
+ }
275
+ resetSession();
276
+ return startConnect(() => handlePasswordLogin(username, password), reconnectOnFailure);
277
+ },
278
+ connectRefreshToken: (refreshToken, reconnectOnFailure = true) => {
279
+ if (isActive()) {
280
+ throw 'Connect may only be used for a closed socket';
281
+ }
282
+ resetSession();
283
+ return startConnect(() => handleRefreshTokenLogin(refreshToken), reconnectOnFailure);
284
+ },
285
+ // Connect and attempt to associate the socket with an existing session
286
+ reconnect: (token = undefined, reconnectOnFailure = true) => {
287
+ if (isActive()) {
288
+ throw 'Reconnect may only be used for a closed socket';
289
+ }
290
+ if (token) {
291
+ authToken = token;
292
+ }
293
+ if (!authToken) {
294
+ throw 'No session token available for reconnecting';
295
+ }
296
+ logger.info('Reconnecting socket');
297
+ return startConnect(handleAuthorizeToken, reconnectOnFailure);
298
+ },
299
+ // Remove the associated API session and close the socket
300
+ logout: () => {
301
+ const resolver = Promise_js_1.default.pending();
302
+ socket.delete(ApiConstants_js_1.default.LOGOUT_URL)
303
+ .then((data) => {
304
+ logger.info('Logout succeed');
305
+ resetSession();
306
+ resolver.resolve(data);
307
+ // Don't fire the disconnected event before resolver actions are handled
308
+ disconnect(undefined, 'Logged out');
309
+ })
310
+ .catch((error) => {
311
+ logger.error('Logout failed', error);
312
+ resolver.reject(error);
313
+ });
314
+ return resolver.promise;
315
+ },
316
+ disconnect,
317
+ isConnecting,
318
+ isConnected,
319
+ isActive,
320
+ logger,
321
+ waitDisconnected,
322
+ // Function to call each time the socket has been connected (and authorized)
323
+ set onConnected(handler) {
324
+ connectedCallback = handler;
325
+ },
326
+ // Function to call each time the stored session token was reset (manual logout/rejected reconnect)
327
+ set onSessionReset(handler) {
328
+ sessionResetCallback = handler;
329
+ },
330
+ // Function to call each time the socket has been disconnected
331
+ set onDisconnected(handler) {
332
+ disconnectedCallback = handler;
333
+ },
334
+ get onConnected() {
335
+ return connectedCallback;
336
+ },
337
+ get onSessionReset() {
338
+ return sessionResetCallback;
339
+ },
340
+ get onDisconnected() {
341
+ return disconnectedCallback;
342
+ },
343
+ get nativeSocket() {
344
+ return ws;
345
+ },
346
+ ...subscriptions.socket,
347
+ ...requests.socket,
348
+ };
349
+ return socket;
350
+ };
351
+ exports.default = ApiSocket;
360
352
  //# sourceMappingURL=SocketBase.js.map