Files
Chromacase/front/API.ts

352 lines
8.7 KiB
TypeScript

import Artist from "./models/Artist";
import AuthToken from "./models/AuthToken";
import Chapter from "./models/Chapter";
import Lesson from "./models/Lesson";
import LessonHistory from "./models/LessonHistory";
import Song from "./models/Song";
import SongHistory from "./models/SongHistory";
import User from "./models/User";
import Constants from "expo-constants";
import store from "./state/Store";
import { Platform } from "react-native";
type AuthenticationInput = { username: string; password: string };
type RegistrationInput = AuthenticationInput & { email: string };
export type AccessToken = string;
type FetchParams = {
route: string;
body?: Object;
method?: "GET" | "POST" | "DELETE";
// If true, No JSON parsing is done, the raw response's content is returned
raw?: true;
};
const dummyIllustration =
"https://i.discogs.com/syRCX8NaLwK2SMk8X6TVU_DWc8RRqE4b-tebAQ6kVH4/rs:fit/g:sm/q:90/h:600/w:600/czM6Ly9kaXNjb2dz/LWRhdGFiYXNlLWlt/YWdlcy9SLTgyNTQz/OC0xNjE3ODE0NDI2/LTU1MjUuanBlZw.jpeg";
// we will need the same thing for the scorometer API url
const baseAPIUrl =
process.env.NODE_ENV != "development" && Platform.OS === "web"
? "/api"
: Constants.manifest?.extra?.apiUrl;
export default class API {
private static async fetch(params: FetchParams) {
const jwtToken = store.getState().user.accessToken;
const header = {
"Content-Type": "application/json",
};
const response = await fetch(`${baseAPIUrl}${params.route}`, {
headers:
(jwtToken && { ...header, Authorization: `Bearer ${jwtToken}` }) ||
header,
body: JSON.stringify(params.body),
method: params.method ?? "GET",
});
if (params.raw) {
return response.arrayBuffer();
}
const body = await response.text();
try {
const jsonResponse = body.length != 0 ? JSON.parse(body) : {};
if (!response.ok) {
throw new Error(jsonResponse.error ?? response.statusText);
}
return jsonResponse;
} catch (e) {
if (e instanceof SyntaxError)
throw new Error("Error while parsing Server's response");
throw e;
}
}
public static async authenticate(
authenticationInput: AuthenticationInput
): Promise<AccessToken> {
return API.fetch({
route: "/auth/login",
body: authenticationInput,
method: "POST",
}).then((responseBody) => responseBody.access_token);
}
/**
* Create a new user profile, with an email and a password
* @param registrationInput the credentials to create a new profile
* @returns A Promise. On success, will be resolved into an instance of the API wrapper
*/
public static async createAccount(
registrationInput: RegistrationInput
): Promise<AccessToken> {
await API.fetch({
route: "/auth/register",
body: registrationInput,
method: "POST",
});
return API.authenticate({
username: registrationInput.username,
password: registrationInput.password,
});
}
/***
* Retrieve information of the currently authentified user
*/
public static async getUserInfo(): Promise<User> {
let me = await API.fetch({
route: "/auth/me",
});
// /auth/me only returns username and id (it needs to be changed)
let user = await API.fetch({
route: `/users/${me.id}`,
});
// this a dummy settings object, we will need to fetch the real one from the API
return {
id: user.id as number,
name: (user.username ?? user.name) as string,
email: user.email as string,
xp: 0,
premium: false,
metrics: {},
settings: {
preferences: {
deviceId: 1,
micVolume: 10,
theme: "system",
lang: "fr",
difficulty: "beg",
colorBlind: false,
},
notifications: {
pushNotif: false,
emailNotif: false,
trainNotif: false,
newSongNotif: false,
},
privacy: {
dataCollection: true,
customAd: true,
recommendation: true,
},
},
} as User;
}
public static async getUserSkills() {
return {
pedalsCompetency: Math.random() * 100,
rightHandCompetency: Math.random() * 100,
leftHandCompetency: Math.random() * 100,
accuracyCompetency: Math.random() * 100,
arpegeCompetency: Math.random() * 100,
chordsCompetency: Math.random() * 100,
};
}
/**
* Authentify a new user through Google
*/
public static async authWithGoogle(): Promise<AuthToken> {
//TODO
return "11111";
}
/**
* Retrive a song
* @param songId the id to find the song
*/
public static async getSong(songId: number): Promise<Song> {
let song = await API.fetch({
route: `/song/${songId}`,
});
// this is a dummy illustration, we will need to fetch the real one from the API
return {
id: song.id as number,
name: song.name as string,
artistId: song.artistId as number,
albumId: song.albumId as number,
genreId: song.genreId as number,
details: song.difficulties,
cover: dummyIllustration,
metrics: {},
} as Song;
}
/**
* Retrive a song's midi partition
* @param songId the id to find the song
*/
public static async getSongMidi(songId: number): Promise<any> {
return API.fetch({
route: `/song/${songId}/midi`,
raw: true,
});
}
/**
* Retrive a song's musicXML partition
* @param songId the id to find the song
*/
public static async getSongMusicXML(songId: number): Promise<any> {
return API.fetch({
route: `/song/${songId}/musicXml`,
raw: true,
});
}
/**
* Retrive an artist
*/
public static async getArtist(artistId: number): Promise<Artist> {
return API.fetch({
route: `/artist/${artistId}`,
});
}
/**
* Retrive a song's chapters
* @param songId the id to find the song
*/
public static async getSongChapters(songId: number): Promise<Chapter[]> {
return [1, 2, 3, 4, 5].map((value) => ({
start: 100 * (value - 1),
end: 100 * value,
songId: songId,
name: `Chapter ${value}`,
type: "chorus",
key_aspect: "rhythm",
difficulty: value,
id: value * 10,
}));
}
/**
* Retrieve a song's play history
* @param songId the id to find the song
*/
public static async getSongHistory(songId: number): Promise<SongHistory[]> {
return [67, 4578, 2, 9990].map((value) => ({
songId: songId,
userId: 1,
score: value,
}));
}
/**
* Search a song by its name
* @param query the string used to find the songs
*/
public static async searchSongs(query: string): Promise<Song[]> {
return Promise.all([1, 5, 2].map(API.getSong));
}
/**
* Retrieve a lesson
* @param lessonId the id to find the lesson
*/
public static async getLesson(lessonId: number): Promise<Lesson> {
return {
title: "Song",
description: "A song",
requiredLevel: 1,
mainSkill: "lead-head-change",
id: lessonId,
};
}
/**
* Retrieve the authenticated user's search history
* @param lessonId the id to find the lesson
*/
public static async getSearchHistory(): Promise<Song[]> {
return Promise.all([1, 2].map(API.getSong));
}
/**
* Retrieve the authenticated user's recommendations
*/
public static async getUserRecommendations(): Promise<Song[]> {
// we can assume at least 5 songs
// in the future the API will return the songs directly to avoid spamming the API
return Promise.all([1, 2, 3, 4, 5].map(API.getSong));
}
/**
* Retrieve the authenticated user's play history
*/
public static async getUserPlayHistory(): Promise<Song[]> {
return Promise.all([3, 4].map(API.getSong));
}
/**
* Retrieve a lesson's history
* @param lessonId the id to find the lesson
*/
public static async getLessonHistory(
lessonId: number
): Promise<LessonHistory[]> {
return [
{
lessonId,
userId: 1,
},
];
}
/**
* Retrieve a partition images
* @param songId the id of the song
* This API may be merged with the fetch song in the future
*/
public static async getPartitionRessources(
songId: number
): Promise<[string, number, number][]> {
return [
[
"https://media.discordapp.net/attachments/717080637038788731/1067469560426545222/vivaldi_split_1.png",
1868,
400,
],
[
"https://media.discordapp.net/attachments/717080637038788731/1067469560900505660/vivaldi_split_2.png",
1868,
400,
],
[
"https://media.discordapp.net/attachments/717080637038788731/1067469561261203506/vivaldi_split_3.png",
1868,
400,
],
[
"https://media.discordapp.net/attachments/717080637038788731/1067469561546424381/vivaldi_split_4.png",
1868,
400,
],
[
"https://media.discordapp.net/attachments/717080637038788731/1067469562058133564/vivaldi_split_5.png",
1868,
400,
],
[
"https://media.discordapp.net/attachments/717080637038788731/1067469562347528202/vivaldi_split_6.png",
1868,
400,
],
[
"https://media.discordapp.net/attachments/717080637038788731/1067469562792136815/vivaldi_split_7.png",
1868,
400,
],
[
"https://media.discordapp.net/attachments/717080637038788731/1067469563073142804/vivaldi_split_8.png",
1868,
400,
],
];
}
}