MrUnknownDE/VRCX
1
0
Fork 0
mirror of https://github.com/MrUnknownDE/VRCX.git synced 2026-04-22 16:23:50 +02:00
Code Issues Packages Projects Releases Wiki Activity

refactor: add type definitions for API responses

Browse Source
This commit is contained in:
pa
2025-07-16 13:31:48 +09:00
committed by Natsumi
parent 342850dc7e
commit 0e50a67c25
17 changed files with 601 additions and 206 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
src/api/user.js
View File

@@ -1,6 +1,9 @@
import { request } from '../service/request';
import { useUserStore } from '../stores';
/**
* @returns {string}
*/
function getCurrentUserId() {
return useUserStore().currentUser.id;
}
@@ -9,7 +12,7 @@ const userReq = {
/**
* Fetch user from API.
* identifier of registered user
* @type {import('../types/user').getUser}
* @type {import('../types/api/user').GetUser}
*/
getUser(params) {
const userStore = useUserStore();
@@ -32,7 +35,7 @@ const userReq = {
/**
* Fetch user from cache if they're in it. Otherwise, calls API.
* @type {import('../types/user').getUser}
* @type {import('../types/api/user').GetCachedUser}
*/
getCachedUser(params) {
const userStore = useUserStore();
@@ -58,17 +61,7 @@ const userReq = {
},
/**
* @typedef {object} GetUsersParameters
* @property {number} n
* @property {number} offset
* @property {string} search
* @property {'nuisanceFactor' | 'created' | '_created_at' | 'last_login'} sort
* @property {'ascending' | 'descending'} order
*/
/**
* Fetch multiple users from API.
* @param params {GetUsersParameters} filtering and sorting parameters
* @returns {Promise<{json: any, params}>}
* @type {import('../types/api/user').GetUsers}
*/
getUsers(params) {
return request('users', {
@@ -84,8 +77,8 @@ const userReq = {
},
/**
* @param params {string[]}
* @returns {Promise<{json: any, params}>}
* @param {string[]} params User tags to add
* @returns {Promise<{json: any, params: string[]}>}
*/
addUserTags(params) {
const userStore = useUserStore();
@@ -103,8 +96,8 @@ const userReq = {
},
/**
* @param params {string[]}
* @returns {Promise<{json: any, params}>}
* @param {string[]} params User tags to remove
* @returns {Promise<{json: any, params: string[]}>}
*/
removeUserTags(params) {
const userStore = useUserStore();
@@ -122,8 +115,8 @@ const userReq = {
},
/**
* @param params {{ userId: string }}
* @returns {Promise<{json: any, params}>}
* @param {{ userId: string }} params
* @returns {Promise<{json: any, params: { userId: string }}>}
*/
getUserFeedback(params) {
return request(`users/${params.userId}/feedback`, {
@@ -142,7 +135,7 @@ const userReq = {
/**
* Updates current user's status.
* @type {import('../types/user').getCurrentUser}
* @type {import('../types/api/user').GetCurrentUser}
*/
saveCurrentUser(params) {
const userStore = useUserStore();
@@ -160,8 +153,8 @@ const userReq = {
},
/**
* @param params {{ offset: number, n: number }}
* @returns {Promise<{json: any, params}>}
* @param {{ offset: number, n: number }} params
* @returns {Promise<{json: any, params: { offset: number, n: number }}>}
*/
getUserNotes(params) {
return request(`userNotes`, {