zavadil-ts-common 1.1.48 → 1.1.50

package/src/client/RestClient.ts

@@ -18,7 +18,7 @@ export class RestClient {
 	/**
 	 * Override this to customize http headers.
 	 */
-	getHeaders(): Promise<RestClientHeaders> {
+	getHeaders(url: string): Promise<RestClientHeaders> {
 		return Promise.resolve(
 			{
 				'Content-Type': 'application/json'
@@ -46,8 +46,8 @@ export class RestClient {
 		return url;
 	}
 
-	getRequestOptions(method: string = 'GET', data: object | null = null): Promise<RequestInit> {
-		return this.getHeaders()
+	getRequestOptions(url: string, method: string = 'GET', data: object | null = null): Promise<RequestInit> {
+		return this.getHeaders(url)
 			.then(
 				(headers) => {
 					return {
@@ -116,31 +116,31 @@ export class RestClient {
 		if (params) {
 			url = `${url}${this.paramsToQueryString(params)}`;
 		}
-		return this.getRequestOptions().then(o => this.processRequestJson(url, o));
+		return this.getRequestOptions(url).then(o => this.processRequestJson(url, o));
 	}
 
 	postJson(url: string, data: object | null = null): Promise<any> {
-		return this.getRequestOptions('POST', data).then(o => this.processRequestJson(url, o));
+		return this.getRequestOptions(url, 'POST', data).then(o => this.processRequestJson(url, o));
 	}
 
 	putJson(url: string, data: object | null = null): Promise<any> {
-		return this.getRequestOptions('PUT', data).then(o => this.processRequestJson(url, o));
+		return this.getRequestOptions(url, 'PUT', data).then(o => this.processRequestJson(url, o));
 	}
 
 	get(url: string): Promise<Response> {
-		return this.getRequestOptions().then(o => this.processRequest(url, o));
+		return this.getRequestOptions(url).then(o => this.processRequest(url, o));
 	}
 
 	del(url: string): Promise<Response> {
-		return this.getRequestOptions('DELETE').then(o => this.processRequest(url, o));
+		return this.getRequestOptions(url, 'DELETE').then(o => this.processRequest(url, o));
 	}
 
 	post(url: string, data: object | null = null): Promise<Response> {
-		return this.getRequestOptions('POST', data).then(o => this.processRequest(url, o));
+		return this.getRequestOptions(url, 'POST', data).then(o => this.processRequest(url, o));
 	}
 
 	put(url: string, data: object | null = null): Promise<Response> {
-		return this.getRequestOptions('PUT', data).then(o => this.processRequest(url, o));
+		return this.getRequestOptions(url, 'PUT', data).then(o => this.processRequest(url, o));
 	}
 
 }

package/src/oauth/OAuthRestClient.ts

@@ -7,6 +7,7 @@ export type TokenRequestPayloadBase = {
 
 export type RequestAccessTokenPayload = TokenRequestPayloadBase & {
 	idToken: string;
+	privilege: string;
 }
 
 export type RequestIdTokenFromPrevTokenPayload = {
@@ -29,7 +30,6 @@ export type IdTokenPayload = TokenResponsePayloadBase & {
 
 export type AccessTokenPayload = TokenResponsePayloadBase & {
 	accessToken: string;
-	refreshToken: string;
 }
 
 export type JwKeyPayload = {

package/src/oauth/OAuthTokenManager.ts

@@ -1,4 +1,4 @@
-import {AccessTokenPayload, IdTokenPayload, OAuthRestClient, RequestIdTokenFromLoginPayload} from "./OAuthRestClient";
+import {AccessTokenPayload, IdTokenPayload, OAuthRestClient} from "./OAuthRestClient";
 import {EventManager} from "../component";
 
 /**
@@ -14,14 +14,15 @@ export class OAuthTokenManager {
 
 	idToken?: IdTokenPayload;
 
-	accessToken?: AccessTokenPayload;
+	accessTokens: Map<string, AccessTokenPayload>;
 
 	constructor(oAuthServerBaseUrl: string, targetAudience: string) {
 		this.audience = targetAudience;
 		this.oAuthServer = new OAuthRestClient(oAuthServerBaseUrl);
+		this.accessTokens = new Map<string, AccessTokenPayload>();
 	}
 
-	addIdTokenChangedHandler(handler: () => any) {
+	addIdTokenChangedHandler(handler: (t: IdTokenPayload) => any) {
 		this.eventManager.addEventListener('id-token-changed', handler);
 	}
 
@@ -51,13 +52,13 @@ export class OAuthTokenManager {
 		return accessToken !== undefined && !this.isTokenExpired(accessToken.expires);
 	}
 
-	hasValidAccessToken(): boolean {
-		return this.isValidAccessToken(this.accessToken);
+	hasValidAccessToken(privilege: string): boolean {
+		return this.isValidAccessToken(this.accessTokens.get(privilege));
 	}
 
 	reset() {
 		this.setIdToken(undefined);
-		this.accessToken = undefined;
+		this.accessTokens.clear();
 	}
 
 	getIdToken(): Promise<string> {
@@ -82,7 +83,7 @@ export class OAuthTokenManager {
 			throw new Error("Received ID token is not valid!");
 		}
 		this.idToken = token;
-		this.eventManager.triggerEvent('id-token-changed');
+		this.eventManager.triggerEvent('id-token-changed', token);
 	}
 
 	verifyIdToken(token: string): Promise<boolean> {
@@ -101,23 +102,27 @@ export class OAuthTokenManager {
 				})
 	}
 
-	getAccessToken(): Promise<string> {
-		if (this.hasValidAccessToken()) {
-			return Promise.resolve(String(this.accessToken?.accessToken));
-		} else {
-			return this.getIdToken()
-				.then(
-					(idToken: string) => this.oAuthServer
-						.requestAccessToken({idToken: idToken, targetAudience: this.audience})
-						.then((act: AccessTokenPayload) => {
-							if (!this.isValidAccessToken(act)) {
-								return Promise.reject("Received access token is not valid!");
-							}
-							this.accessToken = act;
-							return act.accessToken;
-						})
-				);
-		}
+	private getAccessTokenInternal(privilege: string): Promise<AccessTokenPayload> {
+		return this.getIdToken()
+			.then(
+				(idToken: string) => this.oAuthServer
+					.requestAccessToken({idToken: idToken, targetAudience: this.audience, privilege: privilege})
+					.then((act: AccessTokenPayload) => {
+						if (!this.isValidAccessToken(act)) {
+							return Promise.reject("Received access token is not valid!");
+						}
+						this.accessTokens.set(privilege, act);
+						return act;
+					})
+			);
+	}
+
+	getAccessToken(privilege: string): Promise<string> {
+		const existing = this.accessTokens.get(privilege);
+		if (existing === undefined || !this.isValidAccessToken(existing)) return this.getAccessTokenInternal(privilege).then((t) => t.accessToken);
+		// preload access token if it is going to expire soon
+		if (this.isTokenReadyForRefresh(existing.issuedAt, existing.expires)) this.getAccessTokenInternal(privilege);
+		return Promise.resolve(existing.accessToken);
 	}
 
 }

package/src/oauth/RestClientWithOAuth.ts

@@ -1,6 +1,8 @@
 import {OAuthTokenManager} from "./OAuthTokenManager";
-import { RestClient, RestClientHeaders } from "../client";
+import {RestClient, RestClientHeaders} from "../client";
 import {IdTokenPayload} from "./OAuthRestClient";
+import {LazyAsync} from "../cache";
+import {StringUtil} from "../util";
 
 export type ServerOAuthInfoPayload = {
 	debugMode?: boolean;
@@ -11,39 +13,87 @@ export type ServerOAuthInfoPayload = {
 
 export class RestClientWithOAuth extends RestClient {
 
-	private tokenManager?: OAuthTokenManager;
+	private insecureClient: RestClient;
 
-	private serverInfo?: ServerOAuthInfoPayload;
+	private tokenManager: LazyAsync<OAuthTokenManager>;
 
-	private insecureClient: RestClient;
+	private serverInfo: LazyAsync<ServerOAuthInfoPayload>;
 
-	constructor(url: string) {
+	private defaultPrivilege: string;
+
+	constructor(url: string, defaultPrivilege: string = '*') {
 		super(url);
+		this.defaultPrivilege = defaultPrivilege;
+
 		// rest client without OAuth headers
 		this.insecureClient = new RestClient(url);
+
+		this.serverInfo = new LazyAsync<ServerOAuthInfoPayload>(() => this.getServerInfoInternal());
+		this.tokenManager = new LazyAsync<OAuthTokenManager>(() => this.getTokenManagerInternal());
+
+		// initialize
+		const urlToken = this.getIdTokenFromUrl();
+		if (urlToken !== null) {
+			this.setIdTokenRaw(urlToken);
+		} else {
+			const storageToken = this.getIdTokenFromLocalStorage();
+			if (storageToken) this.setIdToken(storageToken);
+		}
+	}
+
+	/**
+	 * Override this if a different privilege is needed for different endpoints
+	 * @param url
+	 */
+	getPrivilege(url: string): string {
+		return this.defaultPrivilege;
+	}
+
+	getIdTokenFromUrl(): string | null {
+		const up = new URLSearchParams(document.location.search);
+		return up.get('token');
+	}
+
+	getIdTokenFromLocalStorage(): IdTokenPayload | null {
+		const raw = localStorage.getItem('id-token');
+		if (!raw) return null;
+		return JSON.parse(raw);
+	}
+
+	saveIdTokenToLocalStorage(token: IdTokenPayload | null) {
+		const raw = token ? JSON.stringify(token) : null;
+		if (raw === null) {
+			localStorage.removeItem('id-token');
+			return;
+		}
+		localStorage.setItem('id-token', raw);
 	}
 
 	addIdTokenChangedHandler(handler: () => any) {
 		this.getTokenManager().then((m) => m.addIdTokenChangedHandler(handler));
 	}
 
+	private getServerInfoInternal(): Promise<ServerOAuthInfoPayload> {
+		return this.insecureClient.getJson('status/info');
+	}
+
 	getServerInfo(): Promise<ServerOAuthInfoPayload> {
-		if (this.serverInfo !== undefined) {
-			return Promise.resolve(this.serverInfo);
-		}
-		return this.insecureClient.getJson('status/info')
-			.then((si: ServerOAuthInfoPayload) => {
-				this.serverInfo = si;
-				return this.serverInfo;
-			});
+		return this.serverInfo.get();
 	}
 
-	getTokenManager(): Promise<OAuthTokenManager> {
-		if (this.tokenManager !== undefined) {
-			return Promise.resolve(this.tokenManager);
-		}
+	private getTokenManagerInternal(): Promise<OAuthTokenManager> {
 		return this.getServerInfo()
-			.then((info) => new OAuthTokenManager(info.oauthServerUrl, info.targetAudience));
+			.then(
+				(info) => {
+					const tm = new OAuthTokenManager(info.oauthServerUrl, info.targetAudience);
+					tm.addIdTokenChangedHandler((t: IdTokenPayload) => this.saveIdTokenToLocalStorage(t));
+					return tm;
+				}
+			);
+	}
+
+	getTokenManager(): Promise<OAuthTokenManager> {
+		return this.tokenManager.get();
 	}
 
 	login(login: string, password: string): Promise<boolean> {
@@ -61,9 +111,9 @@ export class RestClientWithOAuth extends RestClient {
 			.then(m => m.verifyIdToken(token))
 	}
 
-	getHeaders(): Promise<RestClientHeaders> {
+	getHeaders(url: string): Promise<RestClientHeaders> {
 		return this.getTokenManager()
-			.then(sm => sm.getAccessToken())
+			.then(tm => tm.getAccessToken(this.getPrivilege(url)))
 			.then(
 				(accessToken) => {
 					return {
@@ -74,4 +124,14 @@ export class RestClientWithOAuth extends RestClient {
 			);
 	}
 
+	/**
+	 * Try to obtain access token, then return true or throw an Error.
+	 * This is basically only used when initializing and trying to determine whether we need to redirect user to login page
+	 */
+	checkAccessToken(privilege?: string): Promise<boolean> {
+		return this.getTokenManager()
+			.then(tm => tm.getAccessToken(StringUtil.getNonEmpty(privilege, this.defaultPrivilege)))
+			.then((accessToken) => true);
+	}
+
 }