jusemon/avatars-api
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Upgrade dependencies and migrate from Joi to Zod for validation

Browse source
This commit is contained in:
Juan Sebastián Montoya 2025-02-10 22:41:08 -05:00
parent 4fa0190e4b
commit a26d0c77a1
12 changed files with 498 additions and 287 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
Dockerfile
View file

@ -1,5 +1,5 @@
# Build stage
FROM node:18-alpine AS build
FROM node:22-alpine AS build
WORKDIR /app
COPY package*.json .
RUN npm ci
@ -13,7 +13,7 @@ COPY package*.json .
RUN npm ci --omit=dev
# Prod stage
FROM node:18-alpine AS production
FROM node:22-alpine AS production
WORKDIR /app
COPY package*.json .
COPY --from=build /app/dist ./dist

540
package-lock.json generated
View file

File diff suppressed because it is too large Load diff

11
package.json
View file

@ -3,10 +3,9 @@
"version": "1.1.0",
"description": "",
"main": "dist/index.js",
"type": "module",
"scripts": {
"build": "npx tsc",
"start": "node --experimental-specifier-resolution=node dist/index.js",
"start": "node dist/index.js",
"dev": "tsx watch src/index.ts"
},
"keywords": [],
@ -20,21 +19,21 @@
"@dicebear/thumbs": "^9.2.2",
"@koa/cors": "^5.0.0",
"dotenv": "^16.0.1",
"joi": "^17.13.3",
"koa": "^2.15.3",
"koa-logger": "^3.2.1",
"koa-router": "^12.0.1",
"sharp": "^0.33.5",
"uuid": "^10.0.0"
"uuid": "^10.0.0",
"zod": "^3.24.1"
},
"devDependencies": {
"@types/koa": "^2.15.0",
"@types/koa__cors": "^5.0.0",
"@types/koa-logger": "^3.1.5",
"@types/koa-router": "^7.4.8",
"@types/node": "^18.7.3",
"@types/node": "^22.13.1",
"@types/uuid": "^10.0.0",
"tsx": "^4.19.1",
"typescript": "^4.7.4"
"typescript": "^5.5.4"
}
}

17
src/config/components/general.config.ts
View file

@ -1,18 +1,13 @@
import joi from "joi";
import { z } from "zod";
import { Config } from "../../types/config";
import { server } from "./server.config";
const envSchema = joi
.object({
NODE_ENV: joi
.string()
.allow("development", "production", "test")
.required(),
})
.unknown()
.required();
const envSchema = z.object({
NODE_ENV: z.enum(["development", "production", "test"]),
});
const { error, data: envVars } = envSchema.safeParse(process.env);
const { error, value: envVars } = envSchema.validate(process.env);
if (error) {
throw new Error(`Config validation error: ${error.message}`);
}

19
src/config/components/server.config.ts
View file

@ -1,17 +1,14 @@
import joi from "joi";
import { z } from "zod";
import { ServerConfig } from "../../types/config";
const envSchema = joi
.object({
HOST: joi.string().default("localhost"),
PORT: joi.number().default(3000),
API_VERSION: joi.number().default(1),
ALLOWED_ORIGINS: joi.string().default("http://localhost:3000"),
})
.unknown()
.required();
const envSchema = z.object({
HOST: z.string().default("localhost"),
PORT: z.coerce.number().default(3000),
API_VERSION: z.coerce.number().default(1),
ALLOWED_ORIGINS: z.string().default("http://localhost:3000"),
});
const { error, value: envVars } = envSchema.validate(process.env);
const { error, data: envVars } = envSchema.safeParse(process.env);
if (error) {
throw new Error(`Config validation error: ${error.message}`);
}

5
src/index.ts
View file

@ -4,7 +4,7 @@ import logger from "koa-logger";
import config from "./config";
import corsMiddleware from "./middlewares/cors.middleware";
import errorMiddleware from "./middlewares/error.middleware";
import avatarRoute from "./routes/avatar.route";
import routes, { healthRoute } from "./routes";
import { startServerLog } from "./utils/server";
const { server } = config;
@ -15,6 +15,7 @@ app.use(corsMiddleware());
app.use(logger());
app.use(errorMiddleware());
app.use(avatarRoute.routes()).use(avatarRoute.allowedMethods());
app.use(healthRoute.routes()).use(healthRoute.allowedMethods());
app.use(routes.routes()).use(routes.allowedMethods());
app.listen(server.port, server.host, startServerLog(server.port));

4
src/middlewares/error.middleware.ts
View file

@ -1,5 +1,5 @@
import Router from "koa-router";
import { isValidationError } from "../utils/type-guards";
import { ZodError } from "zod";
const errorMiddleware: () => Router.IMiddleware<any, {}> =
() => async (ctx, next) => {
@ -8,7 +8,7 @@ const errorMiddleware: () => Router.IMiddleware<any, {}> =
} catch (err) {
console.log("error middleware", err);
if (err && (err as any).status >= 500) console.log("Error handler:", err);
if (isValidationError(err)) {
if (err instanceof ZodError) {
ctx.status = 400;
} else {
ctx.status = (err as any).status || 500;

34
src/routes/avatar.route.ts
View file

@ -7,8 +7,7 @@ import * as openPeeps from "@dicebear/open-peeps";
import * as pixelArt from "@dicebear/pixel-art";
import * as thumbs from "@dicebear/thumbs";
import * as botttsNeutral from "@dicebear/bottts-neutral";
import { isValue, isSize, isStyle } from "../utils/type-guards";
import { z } from "zod";
const DENSITY = 72;
const avatars: Record<string, Style<any> & { defaultSize: number }> = {
@ -18,13 +17,19 @@ const avatars: Record<string, Style<any> & { defaultSize: number }> = {
thumbs: { ...thumbs, defaultSize: 100 },
};
const validStyles = Object.keys(avatars);
const isValidStyle = isStyle(validStyles);
const schema = z.object({
style: z.enum(Object.keys(avatars) as [string, ...string[]]).default("thumbs"),
size: z.number().min(16).max(512).default(128),
seed: z.string().min(1).max(256).default(uuidv4()),
});
const router = new Router();
router.get("/list", async (ctx) => {
const styles = validStyles.map((key) => ({ ...avatars[key].meta, key }));
const styles = Object.keys(avatars).map((key) => ({
...avatars[key].meta,
key,
}));
ctx.body = { styles };
});
@ -37,12 +42,8 @@ router.use(async (ctx, next) => {
});
router.get("/random", async (ctx) => {
const { style = "thumbs", size = "100" } = ctx.query;
if (!isValidStyle(style) || !isSize(size)) {
throw Error("Invalid query");
}
const seed = uuidv4();
const density = (DENSITY * parseInt(size)) / avatars[style].defaultSize;
const { style, size, seed } = schema.parse(ctx.query);
const density = (DENSITY * size) / avatars[style].defaultSize;
ctx.body = sharp(
Buffer.from(createAvatar(avatars[style], { seed }).toString()),
{ density }
@ -50,12 +51,11 @@ router.get("/random", async (ctx) => {
});
router.get("/:seed", async (ctx) => {
const { seed } = ctx.params;
const { style = "thumbs", size = "100" } = ctx.query;
if (!isValue(seed) || !isValidStyle(style) || !isSize(size)) {
throw Error("Invalid query");
}
const density = (DENSITY * parseInt(size)) / avatars[style].defaultSize;
const { style, size, seed } = schema.parse({
...ctx.query,
...ctx.params,
});
const density = (DENSITY * size) / avatars[style].defaultSize;
ctx.body = sharp(
Buffer.from(createAvatar(avatars[style], { seed }).toString()),
{

10
src/routes/health.route.ts Normal file
View file

@ -0,0 +1,10 @@
import Router from 'koa-router';
const router = new Router();
router.get("/health", async (ctx) => {
ctx.status = 200;
ctx.body = "healthy";
});
export default router;

15
src/routes/index.ts Normal file
View file

@ -0,0 +1,15 @@
import Router from 'koa-router';
import { readdirSync } from 'fs';
const router = new Router<any, any>();
readdirSync(__dirname)
.filter((file) => file.includes('.route.') && !file.startsWith('health.'))
.forEach((file) => {
const routesFile = require(`${__dirname}/${file}`).default;
router.use(routesFile.routes(), routesFile.allowedMethods());
});
export default router;
export { default as healthRoute } from './health.route';

19
src/utils/type-guards.ts
View file

@ -1,19 +0,0 @@
import Joi from "joi";
export const isValidationError = (
error: unknown
): error is Joi.ValidationError => error instanceof Joi.ValidationError;
export const isValue = <T>(value: T | Array<T> | undefined): value is T =>
!!value && !Array.isArray(value);
export const isSize = (value: unknown): value is string =>
!Array.isArray(value) &&
!isNaN(parseInt(value as string)) &&
parseInt(value as string) <= 512 &&
parseInt(value as string) >= 16;
export const isStyle =
(validStyles: string[]) =>
<T>(value: T | Array<T> | undefined): value is T =>
!!value && !Array.isArray(value) && validStyles.includes(value as string);

107
tsconfig.json
View file

@ -1,103 +1,12 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */
/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
"target": "es2017", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
"module": "esnext", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
"moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
"outDir": "./dist", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
"target": "es2024" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
"module": "commonjs" /* Specify what module code is generated. */,
"rootDir": "./src" /* Specify the root folder within your source files. */,
"outDir": "./dist" /* Specify an output folder for all emitted files. */,
"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
"strict": true /* Enable all strict type-checking options. */,
"skipLibCheck": true /* Skip type checking all .d.ts files. */
}
}