@emilgroup/changelog-sdk 1.3.1-beta.14 → 1.3.1-beta.16

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.
package/dist/base.js CHANGED
@@ -74,6 +74,17 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
74
74
  if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
75
75
  }
76
76
  };
77
+ var __rest = (this && this.__rest) || function (s, e) {
78
+ var t = {};
79
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
80
+ t[p] = s[p];
81
+ if (s != null && typeof Object.getOwnPropertySymbols === "function")
82
+ for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
83
+ if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
84
+ t[p[i]] = s[p[i]];
85
+ }
86
+ return t;
87
+ };
77
88
  var __importDefault = (this && this.__importDefault) || function (mod) {
78
89
  return (mod && mod.__esModule) ? mod : { "default": mod };
79
90
  };
@@ -112,6 +123,12 @@ function resetRetry() {
112
123
  exports.resetRetry = resetRetry;
113
124
  var NETWORK_ERROR_MESSAGE = "Network Error";
114
125
  var TOKEN_DATA = 'APP_TOKEN';
126
+ // Sent only to authservice, to ask for a server session.
127
+ var AUTH_MODE_HEADER = 'X-Emil-Auth-Mode';
128
+ // Names the account on every call; one browser session can hold several.
129
+ var ACCOUNT_HEADER = 'X-Emil-Account';
130
+ var SESSION_MODES = ['both', 'session'];
131
+ var RESEND_SAFE_METHODS = ['get', 'head', 'options'];
115
132
  /**
116
133
  *
117
134
  * @export
@@ -129,7 +146,10 @@ var BaseAPI = /** @class */ (function () {
129
146
  this.configuration = configuration;
130
147
  this.basePath = configuration.basePath || this.basePath;
131
148
  if (configuration.cookieAuth) {
132
- this.useCookieAuth();
149
+ this.configuration.username = this.configuration.username || this.tokenData.username;
150
+ }
151
+ if (this.usesSession()) {
152
+ this.useSessionAuth();
133
153
  }
134
154
  else {
135
155
  // Use config token if provided, otherwise use tokenData token
@@ -148,10 +168,94 @@ var BaseAPI = /** @class */ (function () {
148
168
  }
149
169
  this.attachInterceptor(axios);
150
170
  }
151
- // Cookie mode: the browser sends the HttpOnly access cookie, so no token is read from storage.
152
- BaseAPI.prototype.useCookieAuth = function () {
153
- this.configuration.username = this.configuration.username || this.tokenData.username;
154
- this.configuration.baseOptions = __assign(__assign({}, this.configuration.baseOptions), { withCredentials: true });
171
+ // The app's own account wins over APP_TOKEN, which holds whichever tab wrote last.
172
+ BaseAPI.prototype.sessionAccount = function () {
173
+ return this.configuration.account || this.tokenData.sub;
174
+ };
175
+ // Apps may pass the address as the second argument only; authservice is on the same host.
176
+ BaseAPI.prototype.authBasePath = function () {
177
+ return this.configuration.basePath || this.basePath;
178
+ };
179
+ BaseAPI.prototype.usesSession = function () {
180
+ return !!this.configuration.cookieAuth && SESSION_MODES.indexOf(this.tokenData.authMode) !== -1 && !!this.sessionAccount();
181
+ };
182
+ BaseAPI.prototype.useSessionAuth = function () {
183
+ var _a;
184
+ var _b = this.configuration.baseOptions || {}, headers = _b.headers, baseOptions = __rest(_b, ["headers"]);
185
+ this.configuration.accessToken = '';
186
+ this.configuration.baseOptions = __assign(__assign({}, baseOptions), { withCredentials: true, headers: __assign(__assign({}, headers), (_a = {}, _a[ACCOUNT_HEADER] = this.sessionAccount(), _a)) });
187
+ };
188
+ BaseAPI.prototype.useHeaderAuth = function (accessToken) {
189
+ this.configuration.accessToken = accessToken ? "Bearer ".concat(accessToken) : '';
190
+ this.tokenData.accessToken = accessToken;
191
+ delete this.tokenData.authMode;
192
+ delete this.tokenData.sub;
193
+ if (this.configuration.cookieAuth) {
194
+ var _a = this.configuration.baseOptions || {}, withCredentials = _a.withCredentials, headers = _a.headers, baseOptions = __rest(_a, ["withCredentials", "headers"]);
195
+ var _b = headers || {}, _c = ACCOUNT_HEADER, account = _b[_c], otherHeaders = __rest(_b, [typeof _c === "symbol" ? _c : _c + ""]);
196
+ this.configuration.baseOptions = __assign(__assign({}, baseOptions), { headers: otherHeaders });
197
+ }
198
+ };
199
+ BaseAPI.prototype.applyTokenReply = function (_a) {
200
+ var accessToken = _a.accessToken, authMode = _a.authMode, session = _a.session;
201
+ if (this.configuration.cookieAuth && SESSION_MODES.indexOf(authMode) !== -1 && (session === null || session === void 0 ? void 0 : session.sub)) {
202
+ this.tokenData.authMode = authMode;
203
+ this.tokenData.sub = session.sub;
204
+ if (this.configuration.account) {
205
+ // A workspace switch moves the app to another account.
206
+ this.configuration.account = session.sub;
207
+ }
208
+ // Both keeps the token for apps not moved yet; session mode keeps no token at all.
209
+ if (authMode === 'both' && accessToken) {
210
+ this.tokenData.accessToken = accessToken;
211
+ }
212
+ else {
213
+ delete this.tokenData.accessToken;
214
+ }
215
+ this.useSessionAuth();
216
+ }
217
+ else {
218
+ this.useHeaderAuth(accessToken);
219
+ }
220
+ };
221
+ BaseAPI.prototype.sessionHeaders = function () {
222
+ var _a, _b;
223
+ if (!this.configuration.cookieAuth) {
224
+ return {};
225
+ }
226
+ return __assign((_a = {}, _a[AUTH_MODE_HEADER] = 'session', _a), (this.usesSession() && (_b = {}, _b[ACCOUNT_HEADER] = this.sessionAccount(), _b)));
227
+ };
228
+ BaseAPI.prototype.withCurrentAuth = function (config) {
229
+ delete config.headers['Authorization'];
230
+ delete config.headers[ACCOUNT_HEADER];
231
+ if (this.usesSession()) {
232
+ config.headers[ACCOUNT_HEADER] = this.sessionAccount();
233
+ config.withCredentials = true;
234
+ }
235
+ else if (this.configuration.accessToken) {
236
+ config.headers['Authorization'] = this.configuration.accessToken;
237
+ }
238
+ return config;
239
+ };
240
+ // Both keeps the token, so a session call the browser could not complete can be sent again with it.
241
+ BaseAPI.prototype.canRetryWithToken = function (config) {
242
+ var _a;
243
+ return !!config.withCredentials && !!((_a = config.headers) === null || _a === void 0 ? void 0 : _a[ACCOUNT_HEADER])
244
+ && !!this.tokenData.accessToken && this.tokenData.authMode !== 'session';
245
+ };
246
+ // A network error can come after the server ran the call, so only a call that is safe to repeat is sent again.
247
+ BaseAPI.prototype.canResend = function (config) {
248
+ return RESEND_SAFE_METHODS.indexOf((config.method || 'get').toLowerCase()) !== -1
249
+ || Object.keys(config.headers || {}).some(function (name) { return name.toLowerCase() === 'idempotency-key'; });
250
+ };
251
+ BaseAPI.prototype.switchToToken = function () {
252
+ this.useHeaderAuth(this.tokenData.accessToken);
253
+ this.storeTokenData(this.tokenData);
254
+ };
255
+ BaseAPI.prototype.retryWithToken = function (axios, config) {
256
+ this.switchToToken();
257
+ config.withCredentials = false;
258
+ return axios(this.withCurrentAuth(config));
155
259
  };
156
260
  BaseAPI.prototype.selectEnvironment = function (env) {
157
261
  this.selectBasePath(env);
@@ -168,14 +272,15 @@ var BaseAPI = /** @class */ (function () {
168
272
  };
169
273
  BaseAPI.prototype.authorize = function (username, password, targetWorkspace) {
170
274
  return __awaiter(this, void 0, void 0, function () {
171
- var options, response, _a, accessToken, permissions;
275
+ var options, response;
276
+ var _a;
172
277
  return __generator(this, function (_b) {
173
278
  switch (_b.label) {
174
279
  case 0:
175
280
  options = {
176
281
  method: 'POST',
177
- url: "".concat(this.configuration.basePath, "/authservice/v1/login"),
178
- headers: { 'Content-Type': 'application/json' },
282
+ url: "".concat(this.authBasePath(), "/authservice/v1/login"),
283
+ headers: __assign({ 'Content-Type': 'application/json' }, (this.configuration.cookieAuth && (_a = {}, _a[AUTH_MODE_HEADER] = 'session', _a))),
179
284
  data: {
180
285
  username: username,
181
286
  password: password,
@@ -185,14 +290,10 @@ var BaseAPI = /** @class */ (function () {
185
290
  return [4 /*yield*/, axios_1.default.request(options)];
186
291
  case 1:
187
292
  response = _b.sent();
188
- _a = response.data, accessToken = _a.accessToken, permissions = _a.permissions;
189
293
  this.configuration.username = username;
190
294
  this.tokenData.username = username;
191
- this.tokenData.permissions = permissions;
192
- if (!this.configuration.cookieAuth) {
193
- this.configuration.accessToken = "Bearer ".concat(accessToken);
194
- this.tokenData.accessToken = accessToken;
195
- }
295
+ this.tokenData.permissions = response.data.permissions;
296
+ this.applyTokenReply(response.data);
196
297
  if (!targetWorkspace) return [3 /*break*/, 3];
197
298
  return [4 /*yield*/, this.switchWorkspace(targetWorkspace)];
198
299
  case 2:
@@ -211,14 +312,14 @@ var BaseAPI = /** @class */ (function () {
211
312
  };
212
313
  BaseAPI.prototype.switchWorkspace = function (targetWorkspace) {
213
314
  return __awaiter(this, void 0, void 0, function () {
214
- var options, response, _a, accessToken, permissions;
215
- return __generator(this, function (_b) {
216
- switch (_b.label) {
315
+ var options, response;
316
+ return __generator(this, function (_a) {
317
+ switch (_a.label) {
217
318
  case 0:
218
319
  options = {
219
320
  method: 'POST',
220
- url: "".concat(this.configuration.basePath, "/authservice/v1/workspaces/switch"),
221
- headers: __assign({ 'Content-Type': 'application/json' }, (this.configuration.cookieAuth ? {} : { 'Authorization': "Bearer ".concat(this.configuration.accessToken) })),
321
+ url: "".concat(this.authBasePath(), "/authservice/v1/workspaces/switch"),
322
+ headers: __assign(__assign({ 'Content-Type': 'application/json' }, this.sessionHeaders()), (!this.usesSession() && !!this.configuration.accessToken && { 'Authorization': this.configuration.accessToken })),
222
323
  data: {
223
324
  username: this.configuration.username,
224
325
  targetWorkspace: targetWorkspace,
@@ -227,13 +328,9 @@ var BaseAPI = /** @class */ (function () {
227
328
  };
228
329
  return [4 /*yield*/, axios_1.default.request(options)];
229
330
  case 1:
230
- response = _b.sent();
231
- _a = response.data, accessToken = _a.accessToken, permissions = _a.permissions;
232
- this.tokenData.permissions = permissions;
233
- if (!this.configuration.cookieAuth) {
234
- this.configuration.accessToken = "Bearer ".concat(accessToken);
235
- this.tokenData.accessToken = accessToken;
236
- }
331
+ response = _a.sent();
332
+ this.tokenData.permissions = response.data.permissions;
333
+ this.applyTokenReply(response.data);
237
334
  this.storeTokenData(__assign({}, this.tokenData));
238
335
  return [2 /*return*/];
239
336
  }
@@ -260,10 +357,8 @@ var BaseAPI = /** @class */ (function () {
260
357
  });
261
358
  options = {
262
359
  method: 'POST',
263
- url: "".concat(this.configuration.basePath, "/authservice/v1/refresh-token"),
264
- headers: {
265
- 'Content-Type': 'application/json',
266
- },
360
+ url: "".concat(this.authBasePath(), "/authservice/v1/refresh-token"),
361
+ headers: __assign({ 'Content-Type': 'application/json' }, this.sessionHeaders()),
267
362
  data: { username: username },
268
363
  withCredentials: true,
269
364
  };
@@ -276,13 +371,7 @@ var BaseAPI = /** @class */ (function () {
276
371
  });
277
372
  };
278
373
  BaseAPI.prototype.storeTokenData = function (tokenData) {
279
- var _a;
280
374
  if (typeof window !== 'undefined') {
281
- if (tokenData && ((_a = this.configuration) === null || _a === void 0 ? void 0 : _a.cookieAuth)) {
282
- // Cookie mode saves who is logged in, never the token; a token saved by apps not yet migrated stays.
283
- var username = tokenData.username, permissions = tokenData.permissions;
284
- tokenData = __assign(__assign({}, ((0, common_1.defaultStorage)().get(TOKEN_DATA) || {})), { username: username, permissions: permissions });
285
- }
286
375
  (0, common_1.defaultStorage)().set(TOKEN_DATA, tokenData);
287
376
  }
288
377
  };
@@ -302,65 +391,75 @@ var BaseAPI = /** @class */ (function () {
302
391
  axios.interceptors.response.use(function (res) {
303
392
  return res;
304
393
  }, function (err) { return __awaiter(_this, void 0, void 0, function () {
305
- var originalConfig, _a, tokenString, permissions, accessToken, _error_1, _b, tokenString, permissions, accessToken, _error_2;
306
- return __generator(this, function (_c) {
307
- switch (_c.label) {
394
+ var originalConfig, reply, _error_1, reply, _error_2;
395
+ var _this = this;
396
+ return __generator(this, function (_a) {
397
+ switch (_a.label) {
308
398
  case 0:
309
399
  originalConfig = err.config;
310
400
  if (!(err.response && !(err.response instanceof XMLHttpRequest))) return [3 /*break*/, 5];
311
401
  if (!((err.response.status === 401 || err.response.status === 403)
312
402
  && !originalConfig._retry)) return [3 /*break*/, 4];
313
403
  originalConfig._retry = true;
314
- _c.label = 1;
404
+ _a.label = 1;
315
405
  case 1:
316
- _c.trys.push([1, 3, , 4]);
406
+ _a.trys.push([1, 3, , 4]);
317
407
  return [4 /*yield*/, this.refreshTokenInternal()];
318
408
  case 2:
319
- _a = _c.sent(), tokenString = _a.accessToken, permissions = _a.permissions;
320
- this.tokenData.permissions = permissions;
321
- delete originalConfig.headers['Authorization'];
322
- // In cookie mode the refresh reply renewed the access cookie, so retry without a header.
323
- if (!this.configuration.cookieAuth) {
324
- accessToken = "Bearer ".concat(tokenString);
325
- originalConfig.headers['Authorization'] = accessToken;
326
- this.configuration.accessToken = accessToken;
327
- this.tokenData.accessToken = tokenString;
328
- }
409
+ reply = _a.sent();
410
+ this.tokenData.permissions = reply.permissions;
411
+ this.applyTokenReply(reply);
329
412
  this.storeTokenData(this.tokenData);
330
- return [2 /*return*/, axios(originalConfig)];
413
+ if (!this.usesSession()) {
414
+ return [2 /*return*/, axios(this.withCurrentAuth(originalConfig))];
415
+ }
416
+ // Both mode: if the browser does not send the session cookie (another site), use the token.
417
+ return [2 /*return*/, axios(this.withCurrentAuth(originalConfig)).catch(function (retryError) {
418
+ var _a;
419
+ if (((_a = retryError === null || retryError === void 0 ? void 0 : retryError.response) === null || _a === void 0 ? void 0 : _a.status) !== 401 || !_this.tokenData.accessToken) {
420
+ return Promise.reject(retryError);
421
+ }
422
+ return _this.retryWithToken(axios, originalConfig);
423
+ })];
331
424
  case 3:
332
- _error_1 = _c.sent();
425
+ _error_1 = _a.sent();
333
426
  if (_error_1.response && _error_1.response.data) {
334
427
  return [2 /*return*/, Promise.reject(_error_1.response.data)];
335
428
  }
336
429
  return [2 /*return*/, Promise.reject(_error_1)];
337
- case 4: return [3 /*break*/, 9];
430
+ case 4: return [3 /*break*/, 10];
338
431
  case 5:
432
+ if (!(err.message === NETWORK_ERROR_MESSAGE && this.canRetryWithToken(originalConfig))) return [3 /*break*/, 6];
433
+ // Both mode: the browser blocked the session call or hid its reply; later calls use the token.
434
+ if (!this.canResend(originalConfig)) {
435
+ this.switchToToken();
436
+ return [2 /*return*/, Promise.reject(err)];
437
+ }
438
+ return [2 /*return*/, this.retryWithToken(axios, originalConfig)];
439
+ case 6:
339
440
  if (!(err.message === NETWORK_ERROR_MESSAGE
340
- && originalConfig.headers.hasOwnProperty('Authorization')
341
- && _retry_count < 4)) return [3 /*break*/, 9];
441
+ && (originalConfig.headers.hasOwnProperty('Authorization')
442
+ || (this.configuration.cookieAuth && originalConfig.withCredentials && this.canResend(originalConfig)))
443
+ && _retry_count < 4)) return [3 /*break*/, 10];
342
444
  _retry_count++;
343
- _c.label = 6;
344
- case 6:
345
- _c.trys.push([6, 8, , 9]);
346
- return [4 /*yield*/, this.refreshTokenInternal()];
445
+ _a.label = 7;
347
446
  case 7:
348
- _b = _c.sent(), tokenString = _b.accessToken, permissions = _b.permissions;
349
- accessToken = "Bearer ".concat(tokenString);
350
- this.tokenData.permissions = permissions;
447
+ _a.trys.push([7, 9, , 10]);
448
+ return [4 /*yield*/, this.refreshTokenInternal()];
449
+ case 8:
450
+ reply = _a.sent();
451
+ this.tokenData.permissions = reply.permissions;
351
452
  _retry = true;
352
- originalConfig.headers['Authorization'] = accessToken;
353
- this.configuration.accessToken = accessToken;
354
- this.tokenData.accessToken = tokenString;
453
+ this.applyTokenReply(reply);
355
454
  this.storeTokenData(this.tokenData);
356
- return [2 /*return*/, axios.request(__assign({}, originalConfig))];
357
- case 8:
358
- _error_2 = _c.sent();
455
+ return [2 /*return*/, axios.request(__assign({}, this.withCurrentAuth(originalConfig)))];
456
+ case 9:
457
+ _error_2 = _a.sent();
359
458
  if (_error_2.response && _error_2.response.data) {
360
459
  return [2 /*return*/, Promise.reject(_error_2.response.data)];
361
460
  }
362
461
  return [2 /*return*/, Promise.reject(_error_2)];
363
- case 9: return [2 /*return*/, Promise.reject(err)];
462
+ case 10: return [2 /*return*/, Promise.reject(err)];
364
463
  }
365
464
  });
366
465
  }); });
package/dist/common.d.ts CHANGED
@@ -62,7 +62,7 @@ export declare const toPathString: (url: URL) => string;
62
62
  *
63
63
  * @export
64
64
  */
65
- export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any, {}>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
65
+ export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any, {}, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
66
66
  /**
67
67
  * EMIL Changelogservice
68
68
  * The EMIL Changelog Service API description
package/dist/common.js CHANGED
@@ -233,6 +233,7 @@ exports.toPathString = toPathString;
233
233
  * @export
234
234
  */
235
235
  var createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
236
+ // Typed by hand: since axios 1.20, request() returns an internal axios type that SDK declarations cannot name.
236
237
  return function (axios, basePath) {
237
238
  if (axios === void 0) { axios = globalAxios; }
238
239
  if (basePath === void 0) { basePath = BASE_PATH; }
@@ -18,6 +18,7 @@ export interface ConfigurationParameters {
18
18
  baseOptions?: any;
19
19
  formDataCtor?: new () => any;
20
20
  cookieAuth?: boolean;
21
+ account?: string;
21
22
  }
22
23
  export declare class Configuration {
23
24
  /**
@@ -70,13 +71,20 @@ export declare class Configuration {
70
71
  */
71
72
  formDataCtor?: new () => any;
72
73
  /**
73
- * Authenticate with the HttpOnly access cookie instead of a stored token: every call sends credentials.
74
- * The browser holds one cookie, so use it with one logged-in account; log out through the auth service.
74
+ * Use a server session when authservice makes one; otherwise the token, as without this option.
75
+ * Set `account` too, so each SDK object keeps its own account.
75
76
  *
76
77
  * @type {boolean}
77
78
  * @memberof Configuration
78
79
  */
79
80
  cookieAuth?: boolean;
81
+ /**
82
+ * The session account (Cognito sub) this app shows, so the SDK never takes another tab's account.
83
+ *
84
+ * @type {string}
85
+ * @memberof Configuration
86
+ */
87
+ account?: string;
80
88
  constructor(param?: ConfigurationParameters);
81
89
  /**
82
90
  * Check if the given MIME is a JSON MIME.
@@ -25,6 +25,7 @@ var Configuration = /** @class */ (function () {
25
25
  this.baseOptions = param.baseOptions;
26
26
  this.formDataCtor = param.formDataCtor;
27
27
  this.cookieAuth = param.cookieAuth;
28
+ this.account = param.account;
28
29
  }
29
30
  /**
30
31
  * Check if the given MIME is a JSON MIME.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/changelog-sdk",
3
- "version": "1.3.1-beta.14",
3
+ "version": "1.3.1-beta.16",
4
4
  "description": "OpenAPI client for @emilgroup/changelog-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [
@@ -18,7 +18,7 @@
18
18
  "prepare": "npm run build"
19
19
  },
20
20
  "dependencies": {
21
- "axios": "1.18.0"
21
+ "axios": "1.20.0"
22
22
  },
23
23
  "devDependencies": {
24
24