@qelos/sdk 4.1.0 → 4.1.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.
- package/dist/authentication.d.ts +11 -0
- package/dist/authentication.js +6 -3
- package/dist/authentication.js.map +1 -1
- package/dist/services/decode-uri-fields.d.ts +4 -0
- package/dist/services/decode-uri-fields.js +42 -0
- package/dist/services/decode-uri-fields.js.map +1 -0
- package/package.json +2 -2
- package/src/authentication.ts +16 -3
- package/src/services/decode-uri-fields.ts +48 -0
- package/test/authentication-me.test.ts +109 -0
- package/test/authentication-social.test.ts +24 -0
package/dist/authentication.d.ts
CHANGED
|
@@ -49,7 +49,18 @@ export interface IApiToken {
|
|
|
49
49
|
export type SocialProvider = 'linkedin' | 'facebook' | 'google' | 'github';
|
|
50
50
|
export interface SocialLoginOptions {
|
|
51
51
|
state?: string;
|
|
52
|
+
/**
|
|
53
|
+
* Where Qelos redirects after OAuth with `?rt=<refreshToken>` (SDK flow).
|
|
54
|
+
* Absolute URLs must use a host listed in app-configuration `metadata.websiteUrls`.
|
|
55
|
+
*/
|
|
52
56
|
returnUrl?: string;
|
|
57
|
+
/**
|
|
58
|
+
* Overrides the OAuth provider callback origin when its host is listed in
|
|
59
|
+
* app-configuration `metadata.websiteUrls`. The callback path stays
|
|
60
|
+
* `/api/auth/<provider>/callback` on that origin. When omitted, Qelos uses
|
|
61
|
+
* the request tenant host (`tenanthost`).
|
|
62
|
+
*/
|
|
63
|
+
redirectUrl?: string;
|
|
53
64
|
}
|
|
54
65
|
export interface SocialAuthCallbackPayload {
|
|
55
66
|
payload: BasicPayload & {
|
package/dist/authentication.js
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import BaseSDK from './base-sdk';
|
|
2
|
+
import { decodeMeUser } from './services/decode-uri-fields';
|
|
2
3
|
function collectSetCookieHeaders(res) {
|
|
3
4
|
const h = res.headers;
|
|
4
5
|
if (typeof h.getSetCookie === 'function') {
|
|
@@ -166,7 +167,7 @@ export default class QlAuthentication extends BaseSDK {
|
|
|
166
167
|
async apiTokenSignin(apiToken) {
|
|
167
168
|
this.#apiToken = apiToken;
|
|
168
169
|
this.qlOptions.apiToken = apiToken;
|
|
169
|
-
return this.callJsonApi('/api/me');
|
|
170
|
+
return this.callJsonApi('/api/me').then(decodeMeUser);
|
|
170
171
|
}
|
|
171
172
|
listApiTokens() {
|
|
172
173
|
return this.callJsonApi('/api/me/api-tokens');
|
|
@@ -192,6 +193,8 @@ export default class QlAuthentication extends BaseSDK {
|
|
|
192
193
|
params.state = options.state;
|
|
193
194
|
if (options.returnUrl)
|
|
194
195
|
params.returnUrl = options.returnUrl;
|
|
196
|
+
if (options.redirectUrl)
|
|
197
|
+
params.redirectUrl = options.redirectUrl;
|
|
195
198
|
const qs = Object.keys(params).length ? `?${new URLSearchParams(params)}` : '';
|
|
196
199
|
return this.buildUrl(`/api/auth/${provider}${qs}`);
|
|
197
200
|
}
|
|
@@ -249,14 +252,14 @@ export default class QlAuthentication extends BaseSDK {
|
|
|
249
252
|
return this.exchangeAuthCallback(refreshToken);
|
|
250
253
|
}
|
|
251
254
|
getLoggedInUser() {
|
|
252
|
-
return this.callJsonApi('/api/me');
|
|
255
|
+
return this.callJsonApi('/api/me').then(decodeMeUser);
|
|
253
256
|
}
|
|
254
257
|
updateLoggedInUser(changes) {
|
|
255
258
|
return this.callJsonApi('/api/me', {
|
|
256
259
|
method: 'post',
|
|
257
260
|
headers: { 'content-type': 'application/json' },
|
|
258
261
|
body: JSON.stringify(changes)
|
|
259
|
-
});
|
|
262
|
+
}).then(decodeMeUser);
|
|
260
263
|
}
|
|
261
264
|
}
|
|
262
265
|
//# sourceMappingURL=authentication.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"authentication.js","sourceRoot":"","sources":["../src/authentication.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"authentication.js","sourceRoot":"","sources":["../src/authentication.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,YAAY,CAAC;AACjC,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAsF5D,SAAS,uBAAuB,CAAC,GAAa;IAC5C,MAAM,CAAC,GAAG,GAAG,CAAC,OAAsD,CAAC;IACrE,IAAI,OAAO,CAAC,CAAC,YAAY,KAAK,UAAU,EAAE;QACxC,MAAM,IAAI,GAAG,CAAC,CAAC,YAAY,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;KACvC;IACD,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAC7C,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACvC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,+BAA+B,CAAC,KAA0B;IACxE,IAAI,KAAK,YAAY,GAAG,EAAE;QACxB,OAAO,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC;KAClD;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,IAAI;YACF,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,EAAE,sCAAsC,CAAC,CAAC;YACjE,OAAO,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC;SAC9C;QAAC,MAAM;YACN,OAAO,SAAS,CAAC;SAClB;KACF;IACD,IAAI,KAAK,YAAY,eAAe,EAAE;QACpC,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC;KACrC;IACD,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IACxB,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACtB,OAAO,GAAG,CAAC,CAAC,CAAC,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;KAClE;IACD,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;AACnD,CAAC;AAED,8FAA8F;AAC9F,MAAM,UAAU,2BAA2B,CAAC,MAAiC;IAC3E,IAAI,MAAM,CAAC,gBAAgB,EAAE,MAAM,EAAE;QACnC,OAAO,MAAM,CAAC,gBAAgB,CAAC;KAChC;IACD,MAAM,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACvC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACtB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sCAAsC,CACpD,GAAgE,EAChE,MAAiC;IAEjC,MAAM,KAAK,GAAG,2BAA2B,CAAC,MAAM,CAAC,CAAC;IAClD,IAAI,CAAC,KAAK,CAAC,MAAM;QAAE,OAAO;IAC1B,GAAG,CAAC,SAAS,CAAC,YAAY,EAAE,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AACtE,CAAC;AAED,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,OAAO;IAEnD,aAAa,CAAS;IACtB,YAAY,CAAS;IACrB,SAAS,CAAS;IAElB,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED,YAAY,OAAwB;QAClC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,cAAc,EAAE;YACjD,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YACpE,OAAO,OAAO,CAAC,WAAW,CAAC;SAC5B;QACD,IAAI,OAAO,CAAC,YAAY,EAAE;YACxB,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;YAC1C,OAAO,OAAO,CAAC,YAAY,CAAC;SAC7B;QACD,IAAI,OAAO,CAAC,QAAQ,EAAE;YACpB,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC;SACnC;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,WAAyB;QACpC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE;YAC5C,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;SAClC,CAAC,CAAC;QACH,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE;YACX,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAA;SACnC;QACD,MAAM,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAA8B,CAAA;QAE5D,OAAO;YACL,GAAG,IAAI;YACP,OAAO,EAAE;gBACP,YAAY,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,YAAY,CAAC;aAC7C;SACF,CAAA;IACH,CAAC;IAED,WAAW,CAAC,WAAyB;QACnC,OAAO,IAAI,CAAC,WAAW,CACrB,aAAa,EACb;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;SAC5D,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,EAAE;YACX,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;YACvC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;YAC/C,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAA;IACN,CAAC;IAED,MAAM,CAAC,WAA+B;QACpC,OAAO,IAAI,CAAC,WAAW,CACrB,aAAa,EACb;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;SAClC,CAAC,CAAA;IACN,CAAC;IAED,WAAW,CAAC,WAA+B;QACzC,OAAO,IAAI,CAAC,WAAW,CACrB,aAAa,EACb;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;SAC5D,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,EAAE;YACX,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;YACvC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;YAC/C,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAA;IACN,CAAC;IAED,YAAY,CAAC,YAAqB;QAChC,YAAY,GAAG,YAAY,IAAI,IAAI,CAAC,aAAa,CAAC;QAClD,IAAI,CAAC,YAAY,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;SACrD;QACD,OAAO,IAAI,CAAC,WAAW,CACrB,oBAAoB,EACpB;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,aAAa,EAAE,SAAS,GAAG,YAAY;aACxC;SACF,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,EAAE;YACX,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;YACvC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;YAC/C,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAA;IACN,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,WAAoB;QAC3C,MAAM,OAAO,GAA2B,EAAE,CAAC;QAC3C,IAAI,WAAW,EAAE;YACf,OAAO,CAAC,aAAa,GAAG,SAAS,GAAG,WAAW,CAAC;SACjD;QACD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE;YACpD,MAAM,EAAE,MAAM;YACd,OAAO;SACR,CAAC,CAAC;QACH,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE;YACX,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;SACnD;QACD,MAAM,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAK7B,CAAC;QACF,OAAO;YACL,GAAG,IAAI;YACP,OAAO,EAAE;gBACP,YAAY,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,YAAY,CAAC;aAC7C;SACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,QAAgB;QACnC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACnC,OAAO,IAAI,CAAC,WAAW,CAAQ,SAAS,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC/D,CAAC;IAED,aAAa;QACX,OAAO,IAAI,CAAC,WAAW,CAAc,oBAAoB,CAAC,CAAC;IAC7D,CAAC;IAED,cAAc,CAAC,IAAiE;QAC9E,OAAO,IAAI,CAAC,WAAW,CAAyC,oBAAoB,EAAE;YACpF,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAC,CAAC;IACL,CAAC;IAED,cAAc,CAAC,OAAe;QAC5B,OAAO,IAAI,CAAC,WAAW,CAAO,sBAAsB,OAAO,EAAE,EAAE;YAC7D,MAAM,EAAE,QAAQ;SACjB,CAAC,CAAC;IACL,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;IACxD,CAAC;IAED,iBAAiB,CAAC,QAAwB,EAAE,UAA8B,EAAE;QAC1E,MAAM,MAAM,GAA2B,EAAE,CAAC;QAC1C,IAAI,OAAO,CAAC,KAAK;YAAE,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAChD,IAAI,OAAO,CAAC,SAAS;YAAE,MAAM,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QAC5D,IAAI,OAAO,CAAC,WAAW;YAAE,MAAM,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QAClE,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,IAAI,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/E,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,QAAQ,GAAG,EAAE,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,oBAAoB,CAAC,QAAwB;QAC3C,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,QAAQ,WAAW,CAAC,CAAC;IACzD,CAAC;IAED,gBAAgB,CAAC,QAAwB,EAAE,OAA4B;QACrE,MAAM,QAAQ,GAAI,UAAkB,CAAC,QAAQ,CAAC;QAC9C,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;SACpE;QACD,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,YAAoB;QAC7C,IAAI,CAAC,YAAY,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAC9C;QACD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,kBAAkB,CAAC,YAAY,CAAC,EAAE,EAAE;YAC1F,MAAM,EAAE,MAAM;YACd,KAAK,EAAE,UAAU;SAClB,CAAC,CAAC;QACH,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE;YACX,IAAI,MAAM,GAAG,EAAE,CAAC;YAChB,IAAI;gBACF,MAAM,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;aAC3C;YAAC,MAAM;gBACN,YAAY;aACb;YACD,MAAM,IAAI,KAAK,CACb,0CAA0C,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CACtF,CAAC;SACH;QACD,MAAM,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAoD,CAAC;QACnF,MAAM,WAAW,GAAG,uBAAuB,CAAC,GAAG,CAAC,CAAC;QACjD,MAAM,YAAY,GAChB,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC;QACrD,OAAO;YACL,GAAG,IAAI;YACP,OAAO,EAAE;gBACP,YAAY,EAAE,YAAY,IAAI,IAAI;aACnC;YACD,GAAG,CAAC,WAAW,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC;gBACvC,CAAC,CAAC,EAAE,gBAAgB,EAAE,WAAW,EAAE;gBACnC,CAAC,CAAC,EAAE,CAAC;SACR,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,cAAc,CAAC,KAA0B;QAC7C,MAAM,YAAY,GAAG,+BAA+B,CAAC,KAAK,CAAC,CAAC;QAC5D,IAAI,CAAC,YAAY,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;SAC/C;QACD,OAAO,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;IACjD,CAAC;IAED,eAAe;QACb,OAAO,IAAI,CAAC,WAAW,CAAQ,SAAS,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC/D,CAAC;IAED,kBAAkB,CAAC,OAA+C;QAChE,OAAO,IAAI,CAAC,WAAW,CAAQ,SAAS,EAAE;YACxC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;SAC9B,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACxB,CAAC;CACF"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
/** Mirrors auth `encodeIfNeeded` — only decodes values that are URI-encoded. */
|
|
2
|
+
export declare function decodeIfNeeded(value?: string): string | undefined;
|
|
3
|
+
/** Decodes URI-encoded user fields returned by `GET/POST /api/me`. */
|
|
4
|
+
export declare function decodeMeUser<T extends Record<string, unknown>>(user: T): T;
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/** Mirrors auth `encodeIfNeeded` — only decodes values that are URI-encoded. */
|
|
2
|
+
export function decodeIfNeeded(value) {
|
|
3
|
+
if (value === undefined || value === null || value === '') {
|
|
4
|
+
return value;
|
|
5
|
+
}
|
|
6
|
+
try {
|
|
7
|
+
const decoded = decodeURIComponent(value);
|
|
8
|
+
if (encodeURIComponent(decoded) === value) {
|
|
9
|
+
return decoded;
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
catch {
|
|
13
|
+
// not a valid encoded URI component
|
|
14
|
+
}
|
|
15
|
+
return value;
|
|
16
|
+
}
|
|
17
|
+
const ME_USER_STRING_FIELDS = ['name', 'fullName', 'firstName', 'lastName'];
|
|
18
|
+
/** Decodes URI-encoded user fields returned by `GET/POST /api/me`. */
|
|
19
|
+
export function decodeMeUser(user) {
|
|
20
|
+
if (!user || typeof user !== 'object') {
|
|
21
|
+
return user;
|
|
22
|
+
}
|
|
23
|
+
const result = { ...user };
|
|
24
|
+
for (const field of ME_USER_STRING_FIELDS) {
|
|
25
|
+
const value = result[field];
|
|
26
|
+
if (typeof value === 'string') {
|
|
27
|
+
result[field] = decodeIfNeeded(value);
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
const workspace = result.workspace;
|
|
31
|
+
if (workspace && typeof workspace === 'object' && !Array.isArray(workspace)) {
|
|
32
|
+
const ws = workspace;
|
|
33
|
+
if (typeof ws.name === 'string') {
|
|
34
|
+
result.workspace = {
|
|
35
|
+
...ws,
|
|
36
|
+
name: decodeIfNeeded(ws.name),
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
return result;
|
|
41
|
+
}
|
|
42
|
+
//# sourceMappingURL=decode-uri-fields.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"decode-uri-fields.js","sourceRoot":"","sources":["../../src/services/decode-uri-fields.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,MAAM,UAAU,cAAc,CAAC,KAAc;IAC3C,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE,EAAE;QACzD,OAAO,KAAK,CAAC;KACd;IAED,IAAI;QACF,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,kBAAkB,CAAC,OAAO,CAAC,KAAK,KAAK,EAAE;YACzC,OAAO,OAAO,CAAC;SAChB;KACF;IAAC,MAAM;QACN,oCAAoC;KACrC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,qBAAqB,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,CAAU,CAAC;AAErF,sEAAsE;AACtE,MAAM,UAAU,YAAY,CAAoC,IAAO;IACrE,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QACrC,OAAO,IAAI,CAAC;KACb;IAED,MAAM,MAAM,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;IAE3B,KAAK,MAAM,KAAK,IAAI,qBAAqB,EAAE;QACzC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC5B,MAAkC,CAAC,KAAK,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;SACpE;KACF;IAED,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;IACnC,IAAI,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;QAC3E,MAAM,EAAE,GAAG,SAAoC,CAAC;QAChD,IAAI,OAAO,EAAE,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC9B,MAAkC,CAAC,SAAS,GAAG;gBAC9C,GAAG,EAAE;gBACL,IAAI,EAAE,cAAc,CAAC,EAAE,CAAC,IAAI,CAAC;aAC9B,CAAC;SACH;KACF;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@qelos/sdk",
|
|
3
|
-
"version": "4.1.
|
|
3
|
+
"version": "4.1.1",
|
|
4
4
|
"description": "SDK for Qelos API",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -102,7 +102,7 @@
|
|
|
102
102
|
"access": "public"
|
|
103
103
|
},
|
|
104
104
|
"dependencies": {
|
|
105
|
-
"@qelos/global-types": "^4.1.
|
|
105
|
+
"@qelos/global-types": "^4.1.1"
|
|
106
106
|
},
|
|
107
107
|
"devDependencies": {
|
|
108
108
|
"tsx": "^4.21.0",
|
package/src/authentication.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { QelosSDKOptions } from './types';
|
|
2
2
|
import BaseSDK from './base-sdk';
|
|
3
|
+
import { decodeMeUser } from './services/decode-uri-fields';
|
|
3
4
|
|
|
4
5
|
export interface IUser {
|
|
5
6
|
_id: string;
|
|
@@ -54,7 +55,18 @@ export type SocialProvider = 'linkedin' | 'facebook' | 'google' | 'github';
|
|
|
54
55
|
|
|
55
56
|
export interface SocialLoginOptions {
|
|
56
57
|
state?: string;
|
|
58
|
+
/**
|
|
59
|
+
* Where Qelos redirects after OAuth with `?rt=<refreshToken>` (SDK flow).
|
|
60
|
+
* Absolute URLs must use a host listed in app-configuration `metadata.websiteUrls`.
|
|
61
|
+
*/
|
|
57
62
|
returnUrl?: string;
|
|
63
|
+
/**
|
|
64
|
+
* Overrides the OAuth provider callback origin when its host is listed in
|
|
65
|
+
* app-configuration `metadata.websiteUrls`. The callback path stays
|
|
66
|
+
* `/api/auth/<provider>/callback` on that origin. When omitted, Qelos uses
|
|
67
|
+
* the request tenant host (`tenanthost`).
|
|
68
|
+
*/
|
|
69
|
+
redirectUrl?: string;
|
|
58
70
|
}
|
|
59
71
|
|
|
60
72
|
export interface SocialAuthCallbackPayload {
|
|
@@ -271,7 +283,7 @@ export default class QlAuthentication extends BaseSDK {
|
|
|
271
283
|
async apiTokenSignin(apiToken: string): Promise<IUser> {
|
|
272
284
|
this.#apiToken = apiToken;
|
|
273
285
|
this.qlOptions.apiToken = apiToken;
|
|
274
|
-
return this.callJsonApi<IUser>('/api/me');
|
|
286
|
+
return this.callJsonApi<IUser>('/api/me').then(decodeMeUser);
|
|
275
287
|
}
|
|
276
288
|
|
|
277
289
|
listApiTokens(): Promise<IApiToken[]> {
|
|
@@ -300,6 +312,7 @@ export default class QlAuthentication extends BaseSDK {
|
|
|
300
312
|
const params: Record<string, string> = {};
|
|
301
313
|
if (options.state) params.state = options.state;
|
|
302
314
|
if (options.returnUrl) params.returnUrl = options.returnUrl;
|
|
315
|
+
if (options.redirectUrl) params.redirectUrl = options.redirectUrl;
|
|
303
316
|
const qs = Object.keys(params).length ? `?${new URLSearchParams(params)}` : '';
|
|
304
317
|
return this.buildUrl(`/api/auth/${provider}${qs}`);
|
|
305
318
|
}
|
|
@@ -364,7 +377,7 @@ export default class QlAuthentication extends BaseSDK {
|
|
|
364
377
|
}
|
|
365
378
|
|
|
366
379
|
getLoggedInUser() {
|
|
367
|
-
return this.callJsonApi<IUser>('/api/me')
|
|
380
|
+
return this.callJsonApi<IUser>('/api/me').then(decodeMeUser);
|
|
368
381
|
}
|
|
369
382
|
|
|
370
383
|
updateLoggedInUser(changes: Partial<IUser & { password?: string }>): Promise<IUser> {
|
|
@@ -372,6 +385,6 @@ export default class QlAuthentication extends BaseSDK {
|
|
|
372
385
|
method: 'post',
|
|
373
386
|
headers: { 'content-type': 'application/json' },
|
|
374
387
|
body: JSON.stringify(changes)
|
|
375
|
-
})
|
|
388
|
+
}).then(decodeMeUser);
|
|
376
389
|
}
|
|
377
390
|
}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
/** Mirrors auth `encodeIfNeeded` — only decodes values that are URI-encoded. */
|
|
2
|
+
export function decodeIfNeeded(value?: string): string | undefined {
|
|
3
|
+
if (value === undefined || value === null || value === '') {
|
|
4
|
+
return value;
|
|
5
|
+
}
|
|
6
|
+
|
|
7
|
+
try {
|
|
8
|
+
const decoded = decodeURIComponent(value);
|
|
9
|
+
if (encodeURIComponent(decoded) === value) {
|
|
10
|
+
return decoded;
|
|
11
|
+
}
|
|
12
|
+
} catch {
|
|
13
|
+
// not a valid encoded URI component
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
return value;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
const ME_USER_STRING_FIELDS = ['name', 'fullName', 'firstName', 'lastName'] as const;
|
|
20
|
+
|
|
21
|
+
/** Decodes URI-encoded user fields returned by `GET/POST /api/me`. */
|
|
22
|
+
export function decodeMeUser<T extends Record<string, unknown>>(user: T): T {
|
|
23
|
+
if (!user || typeof user !== 'object') {
|
|
24
|
+
return user;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
const result = { ...user };
|
|
28
|
+
|
|
29
|
+
for (const field of ME_USER_STRING_FIELDS) {
|
|
30
|
+
const value = result[field];
|
|
31
|
+
if (typeof value === 'string') {
|
|
32
|
+
(result as Record<string, unknown>)[field] = decodeIfNeeded(value);
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
const workspace = result.workspace;
|
|
37
|
+
if (workspace && typeof workspace === 'object' && !Array.isArray(workspace)) {
|
|
38
|
+
const ws = workspace as Record<string, unknown>;
|
|
39
|
+
if (typeof ws.name === 'string') {
|
|
40
|
+
(result as Record<string, unknown>).workspace = {
|
|
41
|
+
...ws,
|
|
42
|
+
name: decodeIfNeeded(ws.name),
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
return result;
|
|
48
|
+
}
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import * as assert from 'node:assert/strict';
|
|
2
|
+
import { test } from 'node:test';
|
|
3
|
+
import { decodeIfNeeded, decodeMeUser } from '../src/services/decode-uri-fields';
|
|
4
|
+
|
|
5
|
+
test('decodeIfNeeded', async (t) => {
|
|
6
|
+
await t.test('decodes URI-encoded values', () => {
|
|
7
|
+
assert.equal(decodeIfNeeded('David%20Meir-Levy'), 'David Meir-Levy');
|
|
8
|
+
assert.equal(
|
|
9
|
+
decodeIfNeeded(encodeURIComponent('My Workspace / Special & Name')),
|
|
10
|
+
'My Workspace / Special & Name',
|
|
11
|
+
);
|
|
12
|
+
assert.equal(decodeIfNeeded(encodeURIComponent('José García')), 'José García');
|
|
13
|
+
});
|
|
14
|
+
|
|
15
|
+
await t.test('leaves plain strings unchanged', () => {
|
|
16
|
+
assert.equal(decodeIfNeeded('David Meir-Levy'), 'David Meir-Levy');
|
|
17
|
+
assert.equal(decodeIfNeeded('user@example.com'), 'user@example.com');
|
|
18
|
+
assert.equal(decodeIfNeeded('100% legit'), '100% legit');
|
|
19
|
+
});
|
|
20
|
+
|
|
21
|
+
await t.test('passes through empty and undefined values', () => {
|
|
22
|
+
assert.equal(decodeIfNeeded(''), '');
|
|
23
|
+
assert.equal(decodeIfNeeded(undefined), undefined);
|
|
24
|
+
});
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
test('decodeMeUser', async (t) => {
|
|
28
|
+
await t.test('decodes user and workspace name fields', () => {
|
|
29
|
+
const encoded = {
|
|
30
|
+
_id: 'user-1',
|
|
31
|
+
name: 'David%20Meir-Levy',
|
|
32
|
+
fullName: 'David%20Meir-Levy',
|
|
33
|
+
firstName: 'David',
|
|
34
|
+
lastName: 'Meir-Levy',
|
|
35
|
+
workspace: {
|
|
36
|
+
_id: 'ws-1',
|
|
37
|
+
name: encodeURIComponent('My Workspace / Special & Name'),
|
|
38
|
+
roles: ['admin'],
|
|
39
|
+
},
|
|
40
|
+
};
|
|
41
|
+
|
|
42
|
+
const decoded = decodeMeUser(encoded);
|
|
43
|
+
|
|
44
|
+
assert.equal(decoded.name, 'David Meir-Levy');
|
|
45
|
+
assert.equal(decoded.fullName, 'David Meir-Levy');
|
|
46
|
+
assert.equal(decoded.firstName, 'David');
|
|
47
|
+
assert.equal(decoded.lastName, 'Meir-Levy');
|
|
48
|
+
assert.equal(decoded.workspace.name, 'My Workspace / Special & Name');
|
|
49
|
+
assert.equal(decoded._id, 'user-1');
|
|
50
|
+
assert.deepEqual(decoded.workspace.roles, ['admin']);
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
await t.test('leaves non-encoded fields unchanged', () => {
|
|
54
|
+
const user = {
|
|
55
|
+
_id: 'user-1',
|
|
56
|
+
username: 'david@example.com',
|
|
57
|
+
email: 'david@example.com',
|
|
58
|
+
name: 'David Meir-Levy',
|
|
59
|
+
fullName: 'David Meir-Levy',
|
|
60
|
+
firstName: 'David',
|
|
61
|
+
lastName: 'Meir-Levy',
|
|
62
|
+
roles: ['user'],
|
|
63
|
+
metadata: {},
|
|
64
|
+
};
|
|
65
|
+
|
|
66
|
+
assert.deepEqual(decodeMeUser(user), user);
|
|
67
|
+
});
|
|
68
|
+
});
|
|
69
|
+
|
|
70
|
+
test('getLoggedInUser decodes /api/me response', async (t) => {
|
|
71
|
+
const { default: QelosSDK } = await import('../src/index');
|
|
72
|
+
|
|
73
|
+
await t.test('returns decoded user fields', async () => {
|
|
74
|
+
const sdk = new QelosSDK({
|
|
75
|
+
appUrl: 'http://localhost:3000',
|
|
76
|
+
accessToken: 'test-token',
|
|
77
|
+
fetch: async () => {
|
|
78
|
+
const res = new Response(
|
|
79
|
+
JSON.stringify({
|
|
80
|
+
_id: '6a33dcba2c798875d68aa8ab',
|
|
81
|
+
tenant: '6a280e991bbd4078edefe097',
|
|
82
|
+
username: 'david@davidlevy.co.il',
|
|
83
|
+
email: 'david@davidlevy.co.il',
|
|
84
|
+
name: 'David%20Meir-Levy',
|
|
85
|
+
fullName: 'David%20Meir-Levy',
|
|
86
|
+
firstName: 'David',
|
|
87
|
+
lastName: 'Meir-Levy',
|
|
88
|
+
roles: ['user'],
|
|
89
|
+
metadata: {},
|
|
90
|
+
workspace: {
|
|
91
|
+
_id: 'ws-1',
|
|
92
|
+
name: encodeURIComponent('Acme / Dev'),
|
|
93
|
+
roles: ['admin'],
|
|
94
|
+
},
|
|
95
|
+
}),
|
|
96
|
+
);
|
|
97
|
+
res.headers.set('Content-Type', 'application/json');
|
|
98
|
+
return res;
|
|
99
|
+
},
|
|
100
|
+
});
|
|
101
|
+
|
|
102
|
+
const user = await sdk.authentication.getLoggedInUser();
|
|
103
|
+
|
|
104
|
+
assert.equal(user.name, 'David Meir-Levy');
|
|
105
|
+
assert.equal(user.fullName, 'David Meir-Levy');
|
|
106
|
+
assert.equal(user.workspace.name, 'Acme / Dev');
|
|
107
|
+
assert.equal(user.username, 'david@davidlevy.co.il');
|
|
108
|
+
});
|
|
109
|
+
});
|
|
@@ -28,6 +28,30 @@ test('parseSocialCallbackRefreshToken', async (t) => {
|
|
|
28
28
|
});
|
|
29
29
|
});
|
|
30
30
|
|
|
31
|
+
test('getSocialLoginUrl', async (t) => {
|
|
32
|
+
const { default: QelosSDK } = await import('../src/index');
|
|
33
|
+
|
|
34
|
+
await t.test('builds provider URL with state, returnUrl, and redirectUrl', () => {
|
|
35
|
+
const sdk = new QelosSDK({ appUrl: 'https://gateway.example.com' });
|
|
36
|
+
const url = sdk.authentication.getSocialLoginUrl('google', {
|
|
37
|
+
state: 'csrf-1',
|
|
38
|
+
returnUrl: 'https://app.example.com/auth/finish',
|
|
39
|
+
redirectUrl: 'https://app.example.com',
|
|
40
|
+
});
|
|
41
|
+
const parsed = new URL(url);
|
|
42
|
+
assert.equal(parsed.origin, 'https://gateway.example.com');
|
|
43
|
+
assert.equal(parsed.pathname, '/api/auth/google');
|
|
44
|
+
assert.equal(parsed.searchParams.get('state'), 'csrf-1');
|
|
45
|
+
assert.equal(parsed.searchParams.get('returnUrl'), 'https://app.example.com/auth/finish');
|
|
46
|
+
assert.equal(parsed.searchParams.get('redirectUrl'), 'https://app.example.com');
|
|
47
|
+
});
|
|
48
|
+
|
|
49
|
+
await t.test('omits query string when no options', () => {
|
|
50
|
+
const sdk = new QelosSDK({ appUrl: 'http://localhost:3000' });
|
|
51
|
+
assert.equal(sdk.authentication.getSocialLoginUrl('github'), 'http://localhost:3000/api/auth/github');
|
|
52
|
+
});
|
|
53
|
+
});
|
|
54
|
+
|
|
31
55
|
test('getSocialAuthSetCookieParts', async (t) => {
|
|
32
56
|
await t.test('prefers setCookieHeaders array', () => {
|
|
33
57
|
const r = {
|