Wroclaw/WorkshopTasker
2
1
Fork 1
Code Issues Pull requests Activity Actions

factor out common api code

Browse source
This commit is contained in:
Wroclaw 2023-05-11 09:11:20 +02:00
parent 1e63e008af
commit 67cad656d5
7 changed files with 239 additions and 201 deletions
Download patch file Download diff file Expand all files Collapse all files

110
server/api/clients.get.ts
View file

@ -1,112 +1,10 @@
/* global defineEventHandler getQuery, createError */
import { QueryObject } from "ufo";
import { data, database } from "../utils/database";
import { isString } from "../utils/isString";
import BaaPagination from "~/server/utils/baaPagination";
import { client } from "~/utils/types/database";
type queryType = {
type: "before" | "after" | "around",
id: string
} | {
type: null
};
export const baaWrapper = new BaaPagination<client, "id">("clients", "id");
function getLocationParameterType(query: QueryObject): queryType {
const before = query.before;
const after = query.after;
const around = query.around;
let setLocationParametersCount = 0;
let rvalue: queryType = { type: null };
if (isString(before)) {
setLocationParametersCount++;
rvalue = { type: "before", id: before };
}
if (isString(after)) {
setLocationParametersCount++;
rvalue = { type: "after", id: after };
}
if (isString(around)) {
setLocationParametersCount++;
rvalue = { type: "around", id: around };
}
if (setLocationParametersCount > 1) {
throw createError({
statusCode: 400,
message: "multiple location parameters not allowed",
});
}
return rvalue;
}
async function getResults(
queryType: queryType,
limit = 50,
) {
switch (queryType.type) {
case "before": {
const [data] = await database.query(
"SELECT *, CONVERT(`id`, CHAR) AS `id` FROM `clients` WHERE `id` < ? ORDER BY `id` DESC LIMIT ?",
[queryType.id, limit],
) as unknown as data<client>;
return data;
}
case "after": {
const [data] = await database.query(
"SELECT *, CONVERT(`id`, CHAR) AS `id` FROM `clients` WHERE `id` > ? ORDER BY `id` DESC LIMIT ?",
[queryType.id, limit],
) as unknown as data<client>;
return data;
}
case "around": {
const [data] = await database.query(
"(SELECT *, CONVERT(`id`, CHAR) AS `id` FROM `clients` WHERE `id` >= ? ORDER BY `id` ASC LIMIT ?)\n" +
"UNION ALL\n" +
"(SELECT *, CONVERT(`id`, CHAR) AS `id` FROM `clients` WHERE `id` < ? ORDER BY `id` DESC LIMIT ?)\n" +
"ORDER BY `id` DESC",
[queryType.id, Math.ceil(limit / 2), queryType.id, Math.floor(limit / 2)],
) as unknown as data<client>;
return data;
}
case null: {
const [data] = await database.query(
"SELECT *, CONVERT(`id`, CHAR) AS `id` FROM `clients` ORDER BY `id` DESC LIMIT ?",
[limit],
) as unknown as data<client>;
return data;
}
default:
throw createError("Not implemented");
}
}
export default defineEventHandler(async (e) => {
const query = getQuery(e);
let limit = 50;
if (query.limit) limit = Number(query.limit);
if (limit > 200) {
throw createError({
statusCode: 400,
message: "Cannot retrieve more than 200 records",
});
}
if (limit <= 0) {
throw createError({
statusCode: 400,
message: "Tried to retireve 0 or less records",
});
}
const queryData = getLocationParameterType(query);
const result = await getResults(queryData, limit);
return result;
export default defineEventHandler((e) => {
return baaWrapper.RESTget(e);
});

26
server/api/clients.post.ts
View file

@ -1,10 +1,9 @@
/* global defineEventHandler, createError, readBody */
import { database } from "../utils/database";
import Snowflake from "../utils/snowflake";
import { baaWrapper } from "./clients.get";
import { client } from "~/utils/types/database";
const clientKeys = [
const clientKeys: Array<string> = [
"name",
"address",
"phone",
@ -13,7 +12,7 @@ const clientKeys = [
export function checkIsClient(
value: any,
required = true,
required = false,
): value is Partial<Omit<client, "id">> {
const errors = new Map<string, string>();
@ -29,7 +28,7 @@ export function checkIsClient(
if (!(typeof value.phone === "string" || value.phone === null || (!required && value.phone === undefined))) errors.set("phone", "is not string or null");
if (!(typeof value.email === "string" || value.email === null || (!required && value.email === undefined))) errors.set("email", "is not string or null");
for (const i in value)
for (const i in value as Partial<Omit<client, "id">>)
if (!clientKeys.includes(i)) errors.set(i, `excessive property`);
if (errors.size !== 0) {
@ -49,19 +48,6 @@ export function checkIsClient(
return true;
}
export default defineEventHandler(async (e) => {
const body = await readBody(e);
const id = new Snowflake().toString();
if (!checkIsClient(body)) return; // checkIsClient already throws an detailed error
await database.query(
"INSERT INTO `clients` VALUES (?, ?, ?, ?, ?)",
[id, body.name, body.address, body.phone, body.email],
);
// FIXME: data may be turncated in the database
// either throw an error when data is too large or
// reply with turncated data
return { id, ...body };
export default defineEventHandler((e) => {
return baaWrapper.RESTpost(e, clientKeys as Array<keyof Omit<client, "id">>, (o): o is Omit<client, "id"> => checkIsClient(o, true));
});

18
server/api/clients/[id].delete.ts
View file

@ -1,17 +1,7 @@
/* global defineEventHandler, createError */
import { ResultSetHeader } from "mysql2";
/* global defineEventHandler */
import { database } from "~/server/utils/database";
import { baaWrapper } from "../clients.get";
export default defineEventHandler(async (e) => {
const id = e.context.params?.id as string;
const [result] = await database.query(
"DELETE FROM `clients` WHERE `id` = ?",
[id],
) as unknown as [ResultSetHeader];
if (result.affectedRows === 0) throw createError({ statusCode: 404 });
return null;
export default defineEventHandler((e) => {
return baaWrapper.RESTdeleteRecord(e);
});

21
server/api/clients/[id].get.ts
View file

@ -1,20 +1,7 @@
/* global defineEventHandler, createError */
/* global defineEventHandler */
import { database, data } from "~/server/utils/database";
import { client } from "~/utils/types/database";
import { baaWrapper } from "../clients.get";
export default defineEventHandler(async (e) => {
const id = e.context.params?.id;
const [data] = await database.query(
"SELECT *, CONVERT(`id`, CHAR) AS `id` FROM `clients` WHERE `id` = ?",
[id],
) as unknown as data<client>;
if (!data[0]) {
throw createError({
statusCode: 404,
});
}
return data[0];
export default defineEventHandler((e) => {
return baaWrapper.RESTgetRecord(e);
});

36
server/api/clients/[id].patch.ts
View file

@ -1,36 +1,8 @@
/* global defineEventHandler, readBody, createError */
import { ResultSetHeader } from "mysql2";
/* global defineEventHandler */
import { checkIsClient } from "../clients.post";
import { client } from "~/utils/types/database";
import { database, data } from "~/server/utils/database";
import { baaWrapper } from "../clients.get";
export default defineEventHandler(async (e) => {
const body = await readBody(e);
const id = e.context.params?.id as string;
if (!checkIsClient(body, false)) return; // checkIsClient already throws an detailed error
for (const [k, v] of Object.entries(body)) {
const [res] = await database.query(
// I believe it is safe to put key in the template
// because it is limited to 4 values here
`UPDATE \`clients\` SET \`${k}\` = ? WHERE \`id\` = ?`,
[v, id],
) as unknown as [ResultSetHeader];
if (res.affectedRows !== 1) {
throw createError({
statusCode: 404,
});
}
}
const [data] = await database.query(
"SELECT *, CONVERT(`id`, CHAR) AS `id` FROM `clients` WHERE `id` = ?",
[id],
) as unknown as data<client>;
return data[0];
export default defineEventHandler((e) => {
return baaWrapper.RESTpatchRecord(e, checkIsClient);
});

13
server/api/clients/count.get.ts
View file

@ -1,12 +1,7 @@
/* global defineEventHandler, createError */
/* global defineEventHandler */
import { database, data } from "~/server/utils/database";
import { baaWrapper } from "../clients.get";
export default defineEventHandler(async (e) => {
const [[data]] = await database.query(
"SELECT COUNT(*) as `count` FROM `clients`",
) as unknown as data<{count: number}>;
if (!data) throw createError("Database returned no rows");
return data;
export default defineEventHandler((e) => {
return baaWrapper.RESTrecordCount(e);
});