monkeytype/backend/types/types.d.ts

73 lines
1.4 KiB
TypeScript
Raw Normal View History

Api overhaul (#2555) by Bruception * Feat:Update response structure (#2427) * Fix:response and error structure * update:response message * update:response class * update * Update response message Co-authored-by: Mustafiz Kaifee Mumtaz <mustafiz.mumtaz@freecharge.com> * Add MonkeyToken foundation (#2487) by Bruception * Api changes (#2492) * API changes * Remove unused import * Add Ape client (#2513) * Add all endpoints (#2514) * Merged backend typescript into api overhaul (#2515) * Install typescript and add backend tsconfig Cannot yet build due to a number of compilation errors in JS code Signed-off-by: Brian Evans <ebrian101@gmail.com> * Fix typescript compilation errors Signed-off-by: Brian Evans <ebrian101@gmail.com> * Migrated backend to ES modules Switched to import export syntax Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add typescript declaration for anticheat Signed-off-by: Brian Evans <ebrian101@gmail.com> * Rename top level files to .ts Fix service account json file typing Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add dev build scripts for backend typescript Signed-off-by: Brian Evans <ebrian101@gmail.com> * Removed empty lines and switched to using db Cleaned up imports by removing needless empty lines and migrated to the new db.js instead of mongodb.js. Signed-off-by: Brian Evans <ebrian101@gmail.com> * Fixed backend commonjs syntax to ES module syntax Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add build to backend start script Signed-off-by: Brian Evans <ebrian101@gmail.com> * Migrate some endpoints to Ape * Strict equals * Remove artifact * ape -> Ape * Ape migration p2 (#2522) * Migrate leaderboard endpoints to ape * Fixed comment * Init backend types * Fail * Return * Migrate Quotes to Ape (#2528) * Migrate quotes to Ape * Fix backend response * Fix issue * Fix rate limit (#2533) * fix rate limit * Fix import * Fix issues * Ape migration p4 (#2547) * Migrate results endpoints to ape * Remove unused import * Remove unused import * Fix loaders * Make function async * Hide try saving results * Migrate some users endpoints to Ape (#2548) * Complete Ape Migration (#2553) * Complete ape migration * Fix preset * Return preset data * Add typings * Move captcha reset * Read from params * Fix result tags endpoint * Fix stuck loader * fixed lb memory not saving * fixed quote rating popup not showing up for new users Co-authored-by: Mustafiz Kaifee <49086821+Mustafiz04@users.noreply.github.com> Co-authored-by: Mustafiz Kaifee Mumtaz <mustafiz.mumtaz@freecharge.com> Co-authored-by: Brian Evans <53117772+mrbrianevans@users.noreply.github.com> Co-authored-by: Miodec <bartnikjack@gmail.com>
2022-02-23 03:55:48 +08:00
type ExpressRequest = import("express").Request;
declare namespace MonkeyTypes {
interface Configuration {
maintenance: boolean;
quoteReport: {
enabled: boolean;
maxReports: number;
contentReportLimit: number;
};
quoteSubmit: {
enabled: boolean;
};
resultObjectHashCheck: {
enabled: boolean;
};
apeKeys: {
endpointsEnabled: boolean;
acceptKeys: boolean;
maxKeysPerUser: number;
Api overhaul (#2555) by Bruception * Feat:Update response structure (#2427) * Fix:response and error structure * update:response message * update:response class * update * Update response message Co-authored-by: Mustafiz Kaifee Mumtaz <mustafiz.mumtaz@freecharge.com> * Add MonkeyToken foundation (#2487) by Bruception * Api changes (#2492) * API changes * Remove unused import * Add Ape client (#2513) * Add all endpoints (#2514) * Merged backend typescript into api overhaul (#2515) * Install typescript and add backend tsconfig Cannot yet build due to a number of compilation errors in JS code Signed-off-by: Brian Evans <ebrian101@gmail.com> * Fix typescript compilation errors Signed-off-by: Brian Evans <ebrian101@gmail.com> * Migrated backend to ES modules Switched to import export syntax Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add typescript declaration for anticheat Signed-off-by: Brian Evans <ebrian101@gmail.com> * Rename top level files to .ts Fix service account json file typing Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add dev build scripts for backend typescript Signed-off-by: Brian Evans <ebrian101@gmail.com> * Removed empty lines and switched to using db Cleaned up imports by removing needless empty lines and migrated to the new db.js instead of mongodb.js. Signed-off-by: Brian Evans <ebrian101@gmail.com> * Fixed backend commonjs syntax to ES module syntax Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add build to backend start script Signed-off-by: Brian Evans <ebrian101@gmail.com> * Migrate some endpoints to Ape * Strict equals * Remove artifact * ape -> Ape * Ape migration p2 (#2522) * Migrate leaderboard endpoints to ape * Fixed comment * Init backend types * Fail * Return * Migrate Quotes to Ape (#2528) * Migrate quotes to Ape * Fix backend response * Fix issue * Fix rate limit (#2533) * fix rate limit * Fix import * Fix issues * Ape migration p4 (#2547) * Migrate results endpoints to ape * Remove unused import * Remove unused import * Fix loaders * Make function async * Hide try saving results * Migrate some users endpoints to Ape (#2548) * Complete Ape Migration (#2553) * Complete ape migration * Fix preset * Return preset data * Add typings * Move captcha reset * Read from params * Fix result tags endpoint * Fix stuck loader * fixed lb memory not saving * fixed quote rating popup not showing up for new users Co-authored-by: Mustafiz Kaifee <49086821+Mustafiz04@users.noreply.github.com> Co-authored-by: Mustafiz Kaifee Mumtaz <mustafiz.mumtaz@freecharge.com> Co-authored-by: Brian Evans <53117772+mrbrianevans@users.noreply.github.com> Co-authored-by: Miodec <bartnikjack@gmail.com>
2022-02-23 03:55:48 +08:00
};
enableSavingResults: {
enabled: boolean;
};
Api overhaul (#2555) by Bruception * Feat:Update response structure (#2427) * Fix:response and error structure * update:response message * update:response class * update * Update response message Co-authored-by: Mustafiz Kaifee Mumtaz <mustafiz.mumtaz@freecharge.com> * Add MonkeyToken foundation (#2487) by Bruception * Api changes (#2492) * API changes * Remove unused import * Add Ape client (#2513) * Add all endpoints (#2514) * Merged backend typescript into api overhaul (#2515) * Install typescript and add backend tsconfig Cannot yet build due to a number of compilation errors in JS code Signed-off-by: Brian Evans <ebrian101@gmail.com> * Fix typescript compilation errors Signed-off-by: Brian Evans <ebrian101@gmail.com> * Migrated backend to ES modules Switched to import export syntax Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add typescript declaration for anticheat Signed-off-by: Brian Evans <ebrian101@gmail.com> * Rename top level files to .ts Fix service account json file typing Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add dev build scripts for backend typescript Signed-off-by: Brian Evans <ebrian101@gmail.com> * Removed empty lines and switched to using db Cleaned up imports by removing needless empty lines and migrated to the new db.js instead of mongodb.js. Signed-off-by: Brian Evans <ebrian101@gmail.com> * Fixed backend commonjs syntax to ES module syntax Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add build to backend start script Signed-off-by: Brian Evans <ebrian101@gmail.com> * Migrate some endpoints to Ape * Strict equals * Remove artifact * ape -> Ape * Ape migration p2 (#2522) * Migrate leaderboard endpoints to ape * Fixed comment * Init backend types * Fail * Return * Migrate Quotes to Ape (#2528) * Migrate quotes to Ape * Fix backend response * Fix issue * Fix rate limit (#2533) * fix rate limit * Fix import * Fix issues * Ape migration p4 (#2547) * Migrate results endpoints to ape * Remove unused import * Remove unused import * Fix loaders * Make function async * Hide try saving results * Migrate some users endpoints to Ape (#2548) * Complete Ape Migration (#2553) * Complete ape migration * Fix preset * Return preset data * Add typings * Move captcha reset * Read from params * Fix result tags endpoint * Fix stuck loader * fixed lb memory not saving * fixed quote rating popup not showing up for new users Co-authored-by: Mustafiz Kaifee <49086821+Mustafiz04@users.noreply.github.com> Co-authored-by: Mustafiz Kaifee Mumtaz <mustafiz.mumtaz@freecharge.com> Co-authored-by: Brian Evans <53117772+mrbrianevans@users.noreply.github.com> Co-authored-by: Miodec <bartnikjack@gmail.com>
2022-02-23 03:55:48 +08:00
}
interface DecodedToken {
uid?: string;
email?: string;
}
Api overhaul (#2555) by Bruception * Feat:Update response structure (#2427) * Fix:response and error structure * update:response message * update:response class * update * Update response message Co-authored-by: Mustafiz Kaifee Mumtaz <mustafiz.mumtaz@freecharge.com> * Add MonkeyToken foundation (#2487) by Bruception * Api changes (#2492) * API changes * Remove unused import * Add Ape client (#2513) * Add all endpoints (#2514) * Merged backend typescript into api overhaul (#2515) * Install typescript and add backend tsconfig Cannot yet build due to a number of compilation errors in JS code Signed-off-by: Brian Evans <ebrian101@gmail.com> * Fix typescript compilation errors Signed-off-by: Brian Evans <ebrian101@gmail.com> * Migrated backend to ES modules Switched to import export syntax Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add typescript declaration for anticheat Signed-off-by: Brian Evans <ebrian101@gmail.com> * Rename top level files to .ts Fix service account json file typing Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add dev build scripts for backend typescript Signed-off-by: Brian Evans <ebrian101@gmail.com> * Removed empty lines and switched to using db Cleaned up imports by removing needless empty lines and migrated to the new db.js instead of mongodb.js. Signed-off-by: Brian Evans <ebrian101@gmail.com> * Fixed backend commonjs syntax to ES module syntax Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add build to backend start script Signed-off-by: Brian Evans <ebrian101@gmail.com> * Migrate some endpoints to Ape * Strict equals * Remove artifact * ape -> Ape * Ape migration p2 (#2522) * Migrate leaderboard endpoints to ape * Fixed comment * Init backend types * Fail * Return * Migrate Quotes to Ape (#2528) * Migrate quotes to Ape * Fix backend response * Fix issue * Fix rate limit (#2533) * fix rate limit * Fix import * Fix issues * Ape migration p4 (#2547) * Migrate results endpoints to ape * Remove unused import * Remove unused import * Fix loaders * Make function async * Hide try saving results * Migrate some users endpoints to Ape (#2548) * Complete Ape Migration (#2553) * Complete ape migration * Fix preset * Return preset data * Add typings * Move captcha reset * Read from params * Fix result tags endpoint * Fix stuck loader * fixed lb memory not saving * fixed quote rating popup not showing up for new users Co-authored-by: Mustafiz Kaifee <49086821+Mustafiz04@users.noreply.github.com> Co-authored-by: Mustafiz Kaifee Mumtaz <mustafiz.mumtaz@freecharge.com> Co-authored-by: Brian Evans <53117772+mrbrianevans@users.noreply.github.com> Co-authored-by: Miodec <bartnikjack@gmail.com>
2022-02-23 03:55:48 +08:00
interface Context {
configuration: Configuration;
decodedToken: DecodedToken;
Api overhaul (#2555) by Bruception * Feat:Update response structure (#2427) * Fix:response and error structure * update:response message * update:response class * update * Update response message Co-authored-by: Mustafiz Kaifee Mumtaz <mustafiz.mumtaz@freecharge.com> * Add MonkeyToken foundation (#2487) by Bruception * Api changes (#2492) * API changes * Remove unused import * Add Ape client (#2513) * Add all endpoints (#2514) * Merged backend typescript into api overhaul (#2515) * Install typescript and add backend tsconfig Cannot yet build due to a number of compilation errors in JS code Signed-off-by: Brian Evans <ebrian101@gmail.com> * Fix typescript compilation errors Signed-off-by: Brian Evans <ebrian101@gmail.com> * Migrated backend to ES modules Switched to import export syntax Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add typescript declaration for anticheat Signed-off-by: Brian Evans <ebrian101@gmail.com> * Rename top level files to .ts Fix service account json file typing Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add dev build scripts for backend typescript Signed-off-by: Brian Evans <ebrian101@gmail.com> * Removed empty lines and switched to using db Cleaned up imports by removing needless empty lines and migrated to the new db.js instead of mongodb.js. Signed-off-by: Brian Evans <ebrian101@gmail.com> * Fixed backend commonjs syntax to ES module syntax Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add build to backend start script Signed-off-by: Brian Evans <ebrian101@gmail.com> * Migrate some endpoints to Ape * Strict equals * Remove artifact * ape -> Ape * Ape migration p2 (#2522) * Migrate leaderboard endpoints to ape * Fixed comment * Init backend types * Fail * Return * Migrate Quotes to Ape (#2528) * Migrate quotes to Ape * Fix backend response * Fix issue * Fix rate limit (#2533) * fix rate limit * Fix import * Fix issues * Ape migration p4 (#2547) * Migrate results endpoints to ape * Remove unused import * Remove unused import * Fix loaders * Make function async * Hide try saving results * Migrate some users endpoints to Ape (#2548) * Complete Ape Migration (#2553) * Complete ape migration * Fix preset * Return preset data * Add typings * Move captcha reset * Read from params * Fix result tags endpoint * Fix stuck loader * fixed lb memory not saving * fixed quote rating popup not showing up for new users Co-authored-by: Mustafiz Kaifee <49086821+Mustafiz04@users.noreply.github.com> Co-authored-by: Mustafiz Kaifee Mumtaz <mustafiz.mumtaz@freecharge.com> Co-authored-by: Brian Evans <53117772+mrbrianevans@users.noreply.github.com> Co-authored-by: Miodec <bartnikjack@gmail.com>
2022-02-23 03:55:48 +08:00
}
interface Request extends ExpressRequest {
ctx: Readonly<Context>;
Api overhaul (#2555) by Bruception * Feat:Update response structure (#2427) * Fix:response and error structure * update:response message * update:response class * update * Update response message Co-authored-by: Mustafiz Kaifee Mumtaz <mustafiz.mumtaz@freecharge.com> * Add MonkeyToken foundation (#2487) by Bruception * Api changes (#2492) * API changes * Remove unused import * Add Ape client (#2513) * Add all endpoints (#2514) * Merged backend typescript into api overhaul (#2515) * Install typescript and add backend tsconfig Cannot yet build due to a number of compilation errors in JS code Signed-off-by: Brian Evans <ebrian101@gmail.com> * Fix typescript compilation errors Signed-off-by: Brian Evans <ebrian101@gmail.com> * Migrated backend to ES modules Switched to import export syntax Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add typescript declaration for anticheat Signed-off-by: Brian Evans <ebrian101@gmail.com> * Rename top level files to .ts Fix service account json file typing Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add dev build scripts for backend typescript Signed-off-by: Brian Evans <ebrian101@gmail.com> * Removed empty lines and switched to using db Cleaned up imports by removing needless empty lines and migrated to the new db.js instead of mongodb.js. Signed-off-by: Brian Evans <ebrian101@gmail.com> * Fixed backend commonjs syntax to ES module syntax Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add build to backend start script Signed-off-by: Brian Evans <ebrian101@gmail.com> * Migrate some endpoints to Ape * Strict equals * Remove artifact * ape -> Ape * Ape migration p2 (#2522) * Migrate leaderboard endpoints to ape * Fixed comment * Init backend types * Fail * Return * Migrate Quotes to Ape (#2528) * Migrate quotes to Ape * Fix backend response * Fix issue * Fix rate limit (#2533) * fix rate limit * Fix import * Fix issues * Ape migration p4 (#2547) * Migrate results endpoints to ape * Remove unused import * Remove unused import * Fix loaders * Make function async * Hide try saving results * Migrate some users endpoints to Ape (#2548) * Complete Ape Migration (#2553) * Complete ape migration * Fix preset * Return preset data * Add typings * Move captcha reset * Read from params * Fix result tags endpoint * Fix stuck loader * fixed lb memory not saving * fixed quote rating popup not showing up for new users Co-authored-by: Mustafiz Kaifee <49086821+Mustafiz04@users.noreply.github.com> Co-authored-by: Mustafiz Kaifee Mumtaz <mustafiz.mumtaz@freecharge.com> Co-authored-by: Brian Evans <53117772+mrbrianevans@users.noreply.github.com> Co-authored-by: Miodec <bartnikjack@gmail.com>
2022-02-23 03:55:48 +08:00
}
// Data Model
interface User {
// TODO, Complete the typings for the user model
addedAt: number;
bananas: number;
completedTests: number;
discordId?: string;
email: string;
lastNameChange: number;
lbMemory: object;
lbPersonalBests: object;
name: string;
personalBests: object;
quoteRatings?: Record<string, Record<string, number>>;
startedTests: number;
tags: object[];
timeTyping: number;
uid: string;
quoteMod?: boolean;
cannotReport?: boolean;
apeKeys?: Record<string, ApeKey>;
}
interface ApeKey {
name: string;
hash: string;
createdOn: number;
modifiedOn: number;
enabled: boolean;
}
Api overhaul (#2555) by Bruception * Feat:Update response structure (#2427) * Fix:response and error structure * update:response message * update:response class * update * Update response message Co-authored-by: Mustafiz Kaifee Mumtaz <mustafiz.mumtaz@freecharge.com> * Add MonkeyToken foundation (#2487) by Bruception * Api changes (#2492) * API changes * Remove unused import * Add Ape client (#2513) * Add all endpoints (#2514) * Merged backend typescript into api overhaul (#2515) * Install typescript and add backend tsconfig Cannot yet build due to a number of compilation errors in JS code Signed-off-by: Brian Evans <ebrian101@gmail.com> * Fix typescript compilation errors Signed-off-by: Brian Evans <ebrian101@gmail.com> * Migrated backend to ES modules Switched to import export syntax Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add typescript declaration for anticheat Signed-off-by: Brian Evans <ebrian101@gmail.com> * Rename top level files to .ts Fix service account json file typing Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add dev build scripts for backend typescript Signed-off-by: Brian Evans <ebrian101@gmail.com> * Removed empty lines and switched to using db Cleaned up imports by removing needless empty lines and migrated to the new db.js instead of mongodb.js. Signed-off-by: Brian Evans <ebrian101@gmail.com> * Fixed backend commonjs syntax to ES module syntax Signed-off-by: Brian Evans <ebrian101@gmail.com> * Add build to backend start script Signed-off-by: Brian Evans <ebrian101@gmail.com> * Migrate some endpoints to Ape * Strict equals * Remove artifact * ape -> Ape * Ape migration p2 (#2522) * Migrate leaderboard endpoints to ape * Fixed comment * Init backend types * Fail * Return * Migrate Quotes to Ape (#2528) * Migrate quotes to Ape * Fix backend response * Fix issue * Fix rate limit (#2533) * fix rate limit * Fix import * Fix issues * Ape migration p4 (#2547) * Migrate results endpoints to ape * Remove unused import * Remove unused import * Fix loaders * Make function async * Hide try saving results * Migrate some users endpoints to Ape (#2548) * Complete Ape Migration (#2553) * Complete ape migration * Fix preset * Return preset data * Add typings * Move captcha reset * Read from params * Fix result tags endpoint * Fix stuck loader * fixed lb memory not saving * fixed quote rating popup not showing up for new users Co-authored-by: Mustafiz Kaifee <49086821+Mustafiz04@users.noreply.github.com> Co-authored-by: Mustafiz Kaifee Mumtaz <mustafiz.mumtaz@freecharge.com> Co-authored-by: Brian Evans <53117772+mrbrianevans@users.noreply.github.com> Co-authored-by: Miodec <bartnikjack@gmail.com>
2022-02-23 03:55:48 +08:00
}