feat(Util): add queryGlobalUserGroup (qiuwenbaike#1671)

* feat(Util): add queryGlobalUserGroup

Author: WaitSpringQW

dist/Util/Util.js

@@ -11,6 +11,7 @@ export {initMwApi} from './modules/initMwApi';
 export {isValidKey} from './modules/isValidKey';
 export {MwUri} from './modules/mwUri';
 export {oouiConfirmWithStyle} from './modules/oouiConfirmWithStyle';
+export {queryGlobalUserGroups} from './modules/queryGlobalUserGroups';
 export {queryUserGroups} from './modules/queryUserGroups';
 export {scrollTop} from './modules/scrollTop';
 export {userIsInGroup} from './modules/userIsInGroup';

src/Util/Util.ts

@@ -14,6 +14,7 @@ type InitMwApi = import('./initMwApi').InitMwApi;
 type IsValidKey = import('./isValidKey').IsValidKey;
 type ClassMwUri = import('./mwUri').ClassMwUri;
 type OouiConfirmWithStyle = import('./oouiConfirmWithStyle').OouiConfirmWithStyle;
+type QueryGlobalUserGroups = import('./queryGlobalUserGroups').QueryGlobalUserGroups;
 type QueryUserGroups = import('./queryUserGroups').QueryUserGroups;
 type ScrollTop = import('./scrollTop').ScrollTop;
 type SetWpSummaryContent = import('./wpSummaryContent').SetWpSummaryContent;
@@ -37,6 +38,7 @@ declare module 'ext.gadget.Util' {
 	export const isValidKey: IsValidKey;
 	export const MwUri: ClassMwUri;
 	export const oouiConfirmWithStyle: OouiConfirmWithStyle;
+	export const queryGlobalUserGroups: QueryGlobalUserGroups;
 	export const queryUserGroups: QueryUserGroups;
 	export const scrollTop: ScrollTop;
 	export const setWpSummaryContent: SetWpSummaryContent;

src/Util/modules/global.d.ts

@@ -0,0 +1,56 @@
+import {initMwApi} from './initMwApi';
+
+type QueryGlobalUserGroups = typeof queryGlobalUserGroups;
+
+// eslint-disable-next-line func-style
+async function queryGlobalUserGroups(guiuser: string) {
+	const api: mw.Api = initMwApi('Util-QueryGlobalUserGroups');
+
+	const CACHE_KEY_PREFIX = 'ext.gadget.Util_queryGlobalUserGroups-';
+
+	let groups: string[] = [];
+
+	// Query from cache
+	// Check if user group info is cached in LocalStroage
+	// If cached, get them from LocalStroage
+	if (mw.storage.getObject(CACHE_KEY_PREFIX + guiuser)) {
+		groups = mw.storage.getObject(CACHE_KEY_PREFIX + guiuser) as string[];
+		// Remove '*' from groups
+		groups = groups.filter((element) => {
+			return element !== '*';
+		});
+	} else {
+		// Query from web
+		// Query params
+		const params = {
+			action: 'query',
+			format: 'json',
+			formatversion: '2',
+			meta: 'globaluserinfo',
+			guiuser,
+			guiprop: 'groups',
+			smaxage: 600,
+			maxage: 600,
+		};
+		const response = await api.get(params);
+
+		// De-construct the response object
+		const query = response['query'] as {
+			globaluserinfo: {groups: string[]; name: string};
+		};
+
+		if (query?.globaluserinfo) {
+			groups = query.globaluserinfo?.groups ?? [];
+			// Remove '*' from groups
+			groups = groups.filter((element) => {
+				return element !== '*';
+			});
+			// Cache for 10 minutes
+			mw.storage.setObject(CACHE_KEY_PREFIX + guiuser, groups, 10 * 60);
+		}
+	}
+
+	return {query: {globaluserinfo: {name: guiuser, groups}}};
+}
+
+export {type QueryGlobalUserGroups, queryGlobalUserGroups};

src/Util/modules/queryGlobalUserGroups.ts

@@ -8,8 +8,9 @@ async function queryUserGroups(users: string[]) {
 
 	const CACHE_KEY_PREFIX = 'ext.gadget.Util_queryUserGroups-';
 
-	// Query from cache
 	const cachedQueryUsers: {groups: string[]; name: string}[] = [];
+
+	// Query from cache
 	for (const user of users) {
 		// Check if user group info is cached in LocalStroage
 		// If cached, get them from LocalStroage