Skip to content

Make a general functions for API calls #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kyrkjedelen merged 3 commits into from
Mar 9, 2026
Merged

Make a general functions for API calls #134

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6121548
Made plural api function calls for the most standard category of calls
kyrkjedelen Feb 2, 2026
8de1e4c
Fix biome checks
kyrkjedelen Feb 9, 2026
37b8673
Merge branch 'main' into 131-make-a-general-function-for-api-calls
kyrkjedelen Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 91 additions & 0 deletions src/request-handling/standard-request-generators.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
import type { RequestHandler } from "express";
import type { ZodSchema } from "zod";
import { clientError } from "../error/http-errors";
import type { OrmResult } from "../error/orm-error";
import type { QueryParameters } from "../request-handling/common";

type DatabaseCall<Req, Res> = (items: Req) => Promise<OrmResult<Res>>;

export function makeStandardBodyRequestHandler<Req, Res>(
zodSchema: ZodSchema<Req>,
databaseCall: DatabaseCall<Req[], Res>,
options: { httpReturnCode: number } = { httpReturnCode: 200 },

Check warning on line 12 in src/request-handling/standard-request-generators.ts

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Do not use an object literal as default for parameter `options`. 


See more on https://sonarcloud.io/project/issues?id=vektorprogrammet_api&issues=AZxDh7nYiMVnFPx9Kvbn&open=AZxDh7nYiMVnFPx9Kvbn&pullRequest=134
): RequestHandler {
return async (req, res, next) => {
const requestResult = zodSchema.safeParse(req.body);
if (!requestResult.success) {
const error = clientError(
400,
"Invalid request format",
requestResult.error,
);
return next(error);
}
const databaseResult = await databaseCall([requestResult.data]);
if (!databaseResult.success) {
const error = clientError(
400,
"Failed to execute the database command",
databaseResult.error,
);
return next(error);
}
res.status(options.httpReturnCode).json(databaseResult.data);
};
}

export function makeStandardQueryRequestHandler<Res>(
zodSchema: ZodSchema<QueryParameters>,
databaseCall: DatabaseCall<QueryParameters, Res>,
options: { httpReturnCode: number } = { httpReturnCode: 200 },

Check warning on line 40 in src/request-handling/standard-request-generators.ts

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Do not use an object literal as default for parameter `options`. 


See more on https://sonarcloud.io/project/issues?id=vektorprogrammet_api&issues=AZxDh7nYiMVnFPx9Kvbo&open=AZxDh7nYiMVnFPx9Kvbo&pullRequest=134
): RequestHandler {
return async (req, res, next) => {
const requestResult = zodSchema.safeParse(req.query);
if (!requestResult.success) {
const error = clientError(
400,
"Invalid request format",
requestResult.error,
);
return next(error);
}
const databaseResult = await databaseCall(requestResult.data);
if (!databaseResult.success) {
const error = clientError(
400,
"Failed to execute the database command",
databaseResult.error,
);
return next(error);
}
res.status(options.httpReturnCode).json(databaseResult.data);
};
}

export function makeStandardParameterHandler<Param, Res>(
zodSchema: ZodSchema<Param>,
databaseCall: DatabaseCall<Param, Res>,
options: { httpReturnCode: number } = { httpReturnCode: 200 },

Check warning on line 68 in src/request-handling/standard-request-generators.ts

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Do not use an object literal as default for parameter `options`. 


See more on https://sonarcloud.io/project/issues?id=vektorprogrammet_api&issues=AZxDh7nYiMVnFPx9Kvbp&open=AZxDh7nYiMVnFPx9Kvbp&pullRequest=134
): RequestHandler {
return async (req, res, next) => {
const requestResult = zodSchema.safeParse(req.params);
if (!requestResult.success) {
const error = clientError(
400,
"Invalid request format",
requestResult.error,
);
return next(error);
}
const databaseResult = await databaseCall(requestResult.data);
if (!databaseResult.success) {
const error = clientError(
400,
"Failed to execute the database command",
databaseResult.error,
);
return next(error);
}
res.status(options.httpReturnCode).json(databaseResult.data);
};
}