Shortened database/utils.ts by adding a 'Query Database' helper function to reduce boilerplate/copied code, also added functions form apping the Post, Account and Comment row. api/main.ts now has more unfinished endpoints and will now work using functions instead of doing everything inside of the routes, created a helpers.ts file to make it a bit more modular and easier to look over.
This commit is contained in:
Esad Mustafoski
44
api/helpers.ts
Normal file
44
api/helpers.ts
Normal file
@@ -0,0 +1,44 @@
|
||||
/// <reference lib="deno.ns" />
|
||||
|
||||
/**
|
||||
* @author Esad Mustafoski
|
||||
* @file api/helpers.ts
|
||||
* @description Helper functions for the API
|
||||
*
|
||||
*/
|
||||
import { Context } from "https://deno.land/x/oak/mod.ts";
|
||||
import { hash } from "node:crypto";
|
||||
|
||||
export type ApiResponse = {
|
||||
status: number;
|
||||
body: unknown;
|
||||
};
|
||||
|
||||
// --- Helper Functions --- //
|
||||
/**
|
||||
* @description Sends a response to the client
|
||||
* @usage sendResponse(ctx, { status: 200, body: { message: "Success" } })
|
||||
* Status is the HTTP Status code
|
||||
* Body is the response body/message/data.
|
||||
*/
|
||||
const sendResponse = (ctx: Context, {status, body}: ApiResponse): void => {
|
||||
ctx.response.status = status;
|
||||
ctx.response.body = body as any;
|
||||
};
|
||||
|
||||
/**
|
||||
* @usage errorResponse(ctx, 401, "Unauthorized")
|
||||
* @see sendResponse
|
||||
*/
|
||||
const errorResponse = (ctx: Context, status: number, message: string): void => {
|
||||
sendResponse(ctx, { status, body: { error: message } });
|
||||
};
|
||||
|
||||
/**
|
||||
* @description Hashing Function for Passwords/etc
|
||||
* @param password The password to hash
|
||||
* Works only up to 5 Megabytes
|
||||
*/
|
||||
const hashPassword = async (password: string): Promise<string> => {
|
||||
return hash("sha256", password);
|
||||
}
|
||||
159
api/main.ts
159
api/main.ts
@@ -5,35 +5,156 @@
|
||||
*/
|
||||
|
||||
// +++ IMPORTS ------------------------------------------------------ //
|
||||
import { Application, Router } from "https://deno.land/x/oak/mod.ts";
|
||||
import { Application, Router, Context, Next } from "https://deno.land/x/oak/mod.ts";
|
||||
import { oakCors } from "https://deno.land/x/cors/mod.ts";
|
||||
import * as db_utils from "../database/utils.ts";
|
||||
import * as helper_utils from "./helpers.ts";
|
||||
|
||||
// +++ VARIABLES ---------------------------------------------------- //
|
||||
// +++ VARIABLES / TYPES --------------------------------------------- //
|
||||
const router = new Router();
|
||||
const app = new Application();
|
||||
|
||||
// For the future
|
||||
type ApiResponse = {
|
||||
status: number;
|
||||
body: unknown;
|
||||
}
|
||||
|
||||
// +++ ROUTER ------------------------------------------------------- //
|
||||
// Creates the routes for the API server.
|
||||
// Example: localhost:8000/api will show "testAPIPoint"
|
||||
// in the HTML
|
||||
router
|
||||
.get("/", (ctx):void => {
|
||||
ctx.response.body = "ESP API Site";
|
||||
})
|
||||
.get("/api", (ctx):void => {
|
||||
ctx.response.body = "testAPIPoint";
|
||||
})
|
||||
.get("/api/users", async (ctx):Promise<void> => {
|
||||
const getUsers = await db_utils.getAllUsersFromDB();
|
||||
ctx.response.body = getUsers; //getAllUsers();
|
||||
})
|
||||
.get("/api/posts", async (ctx):Promise<void> => {
|
||||
const getPosts = await db_utils.getPostsFromDB();
|
||||
const countedPosts:number = await db_utils.countPosts();
|
||||
ctx.response.body = { getPosts, countedPosts };
|
||||
});
|
||||
// in the HTML page.
|
||||
|
||||
// Docs Routes
|
||||
router
|
||||
.get("/", (ctx) => { ctx.response.body = "For endpoints, use /api/{name}"; })
|
||||
.get("/api", (ctx) => { ctx.response.body = "For API Documentation, visit /docs"; })
|
||||
|
||||
// Account routes
|
||||
router
|
||||
.post("/api/account/login", () => {}) // TODO
|
||||
.post("/api/account/register", () => {}) // TODO
|
||||
.post("/api/account/logout", () => {}) // TODO
|
||||
.post("/api/account/password/forgot", () => {}) // TODO
|
||||
.post("/api/account/password/reset", () => {}) // TODO
|
||||
.post("/api/account/password/change", () => {}) // TODO
|
||||
.post("/api/account/email/change-email", () => {}) // TODO
|
||||
.post("/api/account/email/verify-email", () => {}) // TODO
|
||||
.post("/api/account/delete-account", () => {}) // TODO
|
||||
.post("/api/account/block", () => {}) // TODO
|
||||
|
||||
// Auth Routes
|
||||
router
|
||||
.get("/api/auth", () => {}) // TODO
|
||||
.get("/api/auth/verify", () => {}) // TODO
|
||||
.get("/api/auth/refresh", () => {}) // TODO
|
||||
|
||||
// User routes
|
||||
router
|
||||
.get("/api/users", api_getAllUsers)
|
||||
.get("/api/user/:id/info", api_user_getInfo);
|
||||
|
||||
// Post routes
|
||||
router
|
||||
.get("/api/posts", api_posts_getAll);
|
||||
|
||||
// +++ FUNCTIONS ----------------------------------------------------- //
|
||||
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @description Stands between the client and the API
|
||||
* It checks if the client is authorized to access the API with a token/Multiple tokens
|
||||
* Currently not implemented
|
||||
* Middleware
|
||||
*/
|
||||
async function authenticator(ctx: Context, next: Next): Promise<void> {
|
||||
const authHeader = ctx.request.headers.get('Authorization');
|
||||
|
||||
if (!authHeader) {
|
||||
ctx.response.status = 401;
|
||||
ctx.response.body = { error: "No header" };
|
||||
return;
|
||||
}
|
||||
|
||||
const match = authHeader.match(/^Bearer (.+)$/);
|
||||
if (!match) {
|
||||
ctx.response.status = 401;
|
||||
ctx.response.body = { error: "Invalid format" };
|
||||
return;
|
||||
}
|
||||
|
||||
const token = match[1];
|
||||
|
||||
try {
|
||||
// Token logic missing, not tried or attempted yet.
|
||||
await next();
|
||||
} catch (error) {
|
||||
ctx.response.status = 401;
|
||||
ctx.response.body = { error: "Invalid token" };
|
||||
}
|
||||
}
|
||||
|
||||
async function tokenChecker(ctx: Context, next: Next): Promise<void> {
|
||||
// logic below (TODO):
|
||||
/**
|
||||
* 1. check if the token is valid
|
||||
* 2. if valid, set the user in the context
|
||||
* 3. if not valid, return 401
|
||||
* 4. if token is missing, return 401
|
||||
* 5. if token is expired, return 401
|
||||
* 6. if token is blacklisted, return 401
|
||||
* 7. if token is not in the database, return 401
|
||||
* 8. if token is not associated with a user, return 401
|
||||
* 9. if token is not associated with the correct user, return 401
|
||||
*/
|
||||
}
|
||||
|
||||
|
||||
async function api_getAllUsers(ctx: any): Promise<void> {
|
||||
const getUsers = await db_utils.getAllUsersFromDB();
|
||||
ctx.response.body = getUsers;
|
||||
}
|
||||
|
||||
// Users
|
||||
async function api_user_getInfo(ctx: any): Promise<void> {
|
||||
const id = ctx.params.id;
|
||||
|
||||
if (!id) {
|
||||
ctx.response.status = 400; // Bad Request status
|
||||
ctx.response.body = { error: "User ID required" };
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
const user = await db_utils.getAllUserInfoByID(id);
|
||||
|
||||
if (!user) {
|
||||
ctx.response.status = 404; // Not Found status/Doesn't exist
|
||||
ctx.response.body = { error: "User not found" };
|
||||
return;
|
||||
}
|
||||
|
||||
ctx.response.body = user;
|
||||
} catch (error) {
|
||||
ctx.response.status = 500; // Internal Server Error status
|
||||
ctx.response.body = { error: "Error" };
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// Posts
|
||||
async function api_posts_getAll(ctx: any): Promise<void> {
|
||||
const posts = await db_utils.getPostsFromDB();
|
||||
ctx.response.body = posts;
|
||||
}
|
||||
|
||||
// Comments
|
||||
|
||||
// Filtering
|
||||
|
||||
// +++ APP ---------------------------------------------------------- //
|
||||
app.use(oakCors());
|
||||
app.use(router.routes());
|
||||
app.use(router.allowedMethods());
|
||||
|
||||
Reference in New Issue
Block a user