@20syldev/api 4.8.0 → 5.0.0

package/src/routes/index.ts

@@ -1,59 +0,0 @@
-import { type Request, type Response, Router } from 'express';
-
-import { versions } from '../config/versions.js';
-import { APP_VERSION, DOCS_URL, START_TIME } from '../constants.js';
-import { logger } from '../middleware/logger.js';
-import { ipLimits } from '../storage/index.js';
-
-const router = Router();
-
-router.get('/', (req: Request, res: Response) => {
-    const base = `${req.protocol}://${req.get('host')}`;
-    const links = Object.keys(versions).reduce<Record<string, string>>((link, version) => {
-        link[version] = `${base}/${version}`;
-        return link;
-    }, {});
-
-    res.jsonResponse({
-        documentation: DOCS_URL,
-        latest: `${base}/latest`,
-        health: `${base}/health`,
-        logs: `${base}/logs`,
-        versions: links,
-    });
-});
-
-router.get('/health', (_req: Request, res: Response) => {
-    const mem = process.memoryUsage();
-
-    res.jsonResponse({
-        status: 'ok',
-        uptime: Math.floor((Date.now() - START_TIME) / 1000),
-        version: APP_VERSION,
-        node: process.version,
-        memory: {
-            rss: `${(mem.rss / 1024 / 1024).toFixed(1)} MB`,
-            heap_used: `${(mem.heapUsed / 1024 / 1024).toFixed(1)} MB`,
-            heap_total: `${(mem.heapTotal / 1024 / 1024).toFixed(1)} MB`,
-        },
-        connections: Object.keys(ipLimits).length,
-        logs: logger.entries().length,
-    });
-});
-
-router.get('/logs', (_req: Request, res: Response) => {
-    res.jsonResponse(logger.entries());
-});
-
-router.get('/latest', (_req: Request, res: Response) => {
-    const latest = Object.keys(versions).pop()!;
-    res.redirect(`/${latest}`);
-});
-
-router.get('/latest/{*rest}', (req: Request, res: Response) => {
-    const latest = Object.keys(versions).pop()!;
-    const rest = (req.params as Record<string, string>).rest;
-    res.redirect(`/${latest}/${rest}`);
-});
-
-export default router;

package/src/routes/patch.ts

@@ -1,45 +0,0 @@
-import { type Request, type Response, Router } from 'express';
-
-import { ticTacToeStorage } from '../storage/index.js';
-import { error } from '../utils/response.js';
-
-const router = Router();
-
-// Play a tic-tac-toe move
-router.patch('/:version/tic-tac-toe/:game', (req: Request, res: Response) => {
-    if (req.version !== 'v4') {
-        error(res, 405, 'PATCH is only supported in v4+.', `${req.version}/tic-tac-toe`);
-        return;
-    }
-
-    const game = req.params.game as string;
-    const { username, move, session } = (req.body as Record<string, string>) || {};
-
-    if (!username) {
-        error(res, 400, 'Please provide a username (?username={username})');
-        return;
-    }
-    if (!move) {
-        error(res, 400, 'Please provide a valid move (&move={move})');
-        return;
-    }
-    if (!session) {
-        error(res, 400, 'Please provide a valid session ID (&session={ID})');
-        return;
-    }
-
-    try {
-        const result = req.module.tic_tac_toe('play', {
-            username,
-            move,
-            session,
-            game,
-            storage: ticTacToeStorage,
-        });
-        res.jsonResponse(result);
-    } catch (err) {
-        error(res, 400, (err as Error).message);
-    }
-});
-
-export default router;

package/src/routes/post.ts

@@ -1,209 +0,0 @@
-import { type Request, type Response, Router } from 'express';
-
-import { MAX_TOKEN_LENGTH, MIN_TOKEN_LENGTH } from '../constants.js';
-import type { HashResult } from '../modules/v4/hash.js';
-import { chatStorage, ticTacToeStorage } from '../storage/index.js';
-import { since } from '../utils/helpers.js';
-import { error } from '../utils/response.js';
-
-const router = Router();
-
-// Store chat messages
-router.post('/:version/chat', (req: Request, res: Response) => {
-    const { username, message, timestamp, session, token } = (req.body as Record<string, string>) || {};
-
-    if (!username) {
-        error(res, 400, 'Please provide a username (?username={username})');
-        return;
-    }
-    if (!message) {
-        error(res, 400, 'Please provide a message (&message={message})');
-        return;
-    }
-    if (!session) {
-        error(res, 400, 'Please provide a valid session ID (&session={ID})');
-        return;
-    }
-
-    try {
-        const result = req.module.chat('message', {
-            username,
-            message,
-            timestamp,
-            session,
-            token,
-            storage: chatStorage,
-        });
-        res.jsonResponse(result);
-    } catch (err) {
-        error(res, 400, (err as Error).message);
-    }
-});
-
-// Display a private chat with a token
-router.post('/:version/chat/private', (req: Request, res: Response) => {
-    const { username, token } = (req.body as Record<string, string>) || {};
-
-    if (!username) {
-        error(res, 400, 'Please provide a username (?username={username})');
-        return;
-    }
-    if (!token) {
-        error(res, 400, 'Please provide a valid token (&token={key}).');
-        return;
-    }
-
-    try {
-        const messages = req.module.chat('private', {
-            username,
-            token,
-            storage: chatStorage,
-        });
-        res.jsonResponse(messages);
-    } catch (err) {
-        error(res, 400, (err as Error).message);
-    }
-});
-
-// Generate hash
-router.post('/:version/hash', (req: Request, res: Response) => {
-    const { text, method, encoding } = (req.body as Record<string, string>) || {};
-
-    if (!text) {
-        error(res, 400, 'Please provide a text (?text={text})', `${req.version}/hash`);
-        return;
-    }
-    if (!method) {
-        error(res, 400, 'Please provide a valid hash algorithm (&method={algorithm})', `${req.version}/hash`);
-        return;
-    }
-
-    try {
-        if (since(req.version, 4)) {
-            const hashFn = req.module.hash as (t: string, m: string, e?: string) => HashResult;
-            const result = hashFn(text, method, encoding);
-            res.jsonResponse(result);
-        } else {
-            const result = (req.module.hash as (t: string, m: string) => Record<string, string>)(text, method);
-            res.jsonResponse(result);
-        }
-    } catch (err) {
-        error(res, 400, (err as Error).message, `${req.version}/hash`);
-    }
-});
-
-// Display a planning from an ICS file
-router.post('/:version/hyperplanning', async (req: Request, res: Response) => {
-    const { url, detail } = (req.body as Record<string, string>) || {};
-
-    if (!url) {
-        error(res, 400, 'Please provide a valid ICS file URL (?url={URL})', `${req.version}/hyperplanning`);
-        return;
-    }
-
-    try {
-        const hyperplanning = await req.module.hyperplanning(url, detail);
-        res.jsonResponse(hyperplanning);
-    } catch (err) {
-        error(res, 400, (err as Error).message, `${req.version}/hyperplanning`);
-    }
-});
-
-// Store tic tac toe games
-router.post('/:version/tic-tac-toe', (req: Request, res: Response) => {
-    const { username, move, session, game } = (req.body as Record<string, string>) || {};
-
-    if (!username) {
-        error(res, 400, 'Please provide a username (?username={username})');
-        return;
-    }
-    if (!move) {
-        error(res, 400, 'Please provide a valid move (&move={move})');
-        return;
-    }
-    if (!session) {
-        error(res, 400, 'Please provide a valid session ID (&session={ID})');
-        return;
-    }
-    if (!game) {
-        error(res, 400, 'Please provide a valid game ID (&game={ID})');
-        return;
-    }
-
-    try {
-        const result = req.module.tic_tac_toe('play', {
-            username,
-            move,
-            session,
-            game,
-            storage: ticTacToeStorage,
-        });
-        res.jsonResponse(result);
-    } catch (err) {
-        error(res, 400, (err as Error).message);
-    }
-});
-
-// Display a tic tac toe game with a token
-router.post('/:version/tic-tac-toe/fetch', (req: Request, res: Response) => {
-    const { username, game } = (req.body as Record<string, string>) || {};
-    const privateGame = ((req.body as Record<string, unknown>) || {}).private as boolean | undefined;
-
-    if (!username) {
-        error(res, 400, 'Please provide a username (?username={username})');
-        return;
-    }
-
-    try {
-        const result = req.module.tic_tac_toe('fetch', {
-            username,
-            game,
-            private: privateGame,
-            storage: ticTacToeStorage,
-        });
-        res.jsonResponse(result);
-    } catch (err) {
-        error(res, 400, (err as Error).message);
-    }
-});
-
-// List public tic tac toe games
-router.post('/:version/tic-tac-toe/list', (req: Request, res: Response) => {
-    try {
-        const result = req.module.tic_tac_toe('list', {
-            storage: ticTacToeStorage,
-        });
-        res.jsonResponse(result);
-    } catch (err) {
-        error(res, 400, (err as Error).message);
-    }
-});
-
-// Generate Token
-router.post('/:version/token', (req: Request, res: Response) => {
-    const body = (req.body as Record<string, unknown>) || {};
-    const len = parseInt(String(body.len || 24), 10);
-    const type = body.type ? String(body.type).toLowerCase() : 'alpha';
-
-    if (isNaN(len) || len < 0) {
-        error(res, 400, 'Invalid number.', `${req.version}/token`);
-        return;
-    }
-    if (len > MAX_TOKEN_LENGTH) {
-        error(res, 400, 'Length cannot exceed 4096.', `${req.version}/token`);
-        return;
-    }
-    if (len < MIN_TOKEN_LENGTH) {
-        error(res, 400, 'Length cannot be less than 12.', `${req.version}/token`);
-        return;
-    }
-
-    try {
-        const token = req.module.token(len, type);
-        res.jsonResponse({ token });
-    } catch (err) {
-        error(res, 400, (err as Error).message, `${req.version}/token`);
-    }
-});
-
-export default router;

package/src/storage/index.ts

@@ -1,16 +0,0 @@
-import type { ChatStorage, IpLimits, TicTacToeStorage } from '../types/storage.js';
-
-export const ipLimits: IpLimits = {};
-
-export const chatStorage: ChatStorage = {
-    messages: [],
-    privateChats: {},
-    sessions: {},
-    rateLimits: {},
-};
-
-export const ticTacToeStorage: TicTacToeStorage = {
-    games: {},
-    sessions: {},
-    rateLimits: {},
-};

package/src/types/express.d.ts

@@ -1,17 +0,0 @@
-import type * as apiv3 from '../modules/v3.js';
-import type * as apiv4 from '../modules/v4.js';
-
-declare global {
-    namespace Express {
-        interface Request {
-            version: string;
-            latest: string;
-            endpoint: string;
-            module: typeof apiv3 | typeof apiv4;
-        }
-
-        interface Response {
-            jsonResponse: (data: unknown) => void;
-        }
-    }
-}

package/src/types/storage.ts

@@ -1,48 +0,0 @@
-export interface LogEntry {
-    timestamp: string;
-    method: string;
-    url: string;
-    status: number;
-    duration: string;
-    platform: string | undefined;
-}
-
-export interface ChatMessage {
-    username: string;
-    message: string;
-    timestamp: string;
-}
-
-export interface ChatStorage {
-    messages: ChatMessage[];
-    privateChats: Record<string, ChatMessage[]>;
-    sessions: Record<string, { user: string; last: number }>;
-    rateLimits: Record<string, number[]>;
-}
-
-export interface TicTacToeMove {
-    username: string;
-    move: string;
-    session: string;
-}
-
-export interface TicTacToeGame {
-    moves: TicTacToeMove[];
-    players: string[];
-    private: boolean;
-    creation: number;
-}
-
-export interface TicTacToeStorage {
-    games: Record<string, TicTacToeGame>;
-    sessions: Record<string, { user: string; last: number }>;
-    rateLimits: Record<string, number[]>;
-}
-
-export interface IpLimits {
-    [ip: string]: {
-        [hour: string]: {
-            [minute: string]: number;
-        };
-    };
-}

package/src/utils/colors.ts

@@ -1,91 +0,0 @@
-/**
- * Parses a hex color string into an RGB tuple.
- *
- * @param hex - Hex color string (#RRGGBB or RRGGBB)
- * @returns RGB tuple [r, g, b] with values 0-255
- * @throws Error if the hex string is invalid
- */
-export function hexToRgb(hex: string): [number, number, number] {
-    const clean = hex.replace('#', '');
-    if (!/^[0-9a-fA-F]{6}$/.test(clean)) throw new Error('Invalid HEX color (use #RRGGBB)');
-    return [parseInt(clean.slice(0, 2), 16), parseInt(clean.slice(2, 4), 16), parseInt(clean.slice(4, 6), 16)];
-}
-
-/**
- * Converts HSL values to an RGB tuple.
- *
- * @param h - Hue in degrees (0-360)
- * @param s - Saturation (0-1)
- * @param l - Lightness (0-1)
- * @returns RGB tuple [r, g, b] with values 0-255
- */
-export function hslToRgb(h: number, s: number, l: number): [number, number, number] {
-    const c = (1 - Math.abs(2 * l - 1)) * s;
-    const x = c * (1 - Math.abs(((h / 60) % 2) - 1));
-    const m = l - c / 2;
-    let r1 = 0,
-        g1 = 0,
-        b1 = 0;
-    if (h < 60) [r1, g1, b1] = [c, x, 0];
-    else if (h < 120) [r1, g1, b1] = [x, c, 0];
-    else if (h < 180) [r1, g1, b1] = [0, c, x];
-    else if (h < 240) [r1, g1, b1] = [0, x, c];
-    else if (h < 300) [r1, g1, b1] = [x, 0, c];
-    else [r1, g1, b1] = [c, 0, x];
-    return [Math.round((r1 + m) * 255), Math.round((g1 + m) * 255), Math.round((b1 + m) * 255)];
-}
-
-/**
- * Validates and normalizes a hex color string, adding # if missing.
- *
- * @param value - Raw color value (with or without #)
- * @param def - Default color if value is empty
- * @returns Normalized hex color string with #
- * @throws Error if the color format is invalid
- */
-export function normalizeColor(value: string | undefined, def: string): string {
-    if (!value) return def;
-    const clean = value.startsWith('#') ? value : `#${value}`;
-    if (!/^#([0-9a-fA-F]{3}){1,2}$/.test(clean)) throw new Error('Invalid color (use hex like ff6600)');
-    return clean;
-}
-
-/**
- * Formats an RGB tuple as a hex color string.
- *
- * @param r - Red channel (0-255)
- * @param g - Green channel (0-255)
- * @param b - Blue channel (0-255)
- * @returns Hex color string (#rrggbb)
- */
-export function rgbToHex(r: number, g: number, b: number): string {
-    return `#${[r, g, b].map((x) => x.toString(16).padStart(2, '0')).join('')}`;
-}
-
-/**
- * Converts RGB values to an HSL tuple.
- *
- * @param r - Red channel (0-255)
- * @param g - Green channel (0-255)
- * @param b - Blue channel (0-255)
- * @returns HSL tuple [h (0-360), s (0-1), l (0-1)]
- */
-export function rgbToHsl(r: number, g: number, b: number): [number, number, number] {
-    const r1 = r / 255,
-        g1 = g / 255,
-        b1 = b / 255;
-    const max = Math.max(r1, g1, b1),
-        min = Math.min(r1, g1, b1);
-    const l = (max + min) / 2;
-
-    if (max === min) return [0, 0, l];
-
-    const d = max - min;
-    const s = l > 0.5 ? d / (2 - max - min) : d / (max + min);
-    let h = 0;
-    if (max === r1) h = (g1 - b1) / d + (g1 < b1 ? 6 : 0);
-    else if (max === g1) h = (b1 - r1) / d + 2;
-    else h = (r1 - g1) / d + 4;
-
-    return [(h * 60 + 360) % 360, s, l];
-}

package/src/utils/helpers.ts

@@ -1,90 +0,0 @@
-/**
- * Tracks requests per user and throws if the rate limit is exceeded.
- *
- * @param rateLimits - Store of timestamps per user
- * @param userId - Identifier of the requesting user
- * @param timestamp - Current timestamp in milliseconds
- * @param window - Time window in milliseconds
- * @param limit - Maximum requests allowed in the window
- * @returns false if within limits
- * @throws Error if rate limit is exceeded
- */
-export function checkRateLimit(
-    rateLimits: Record<string, number[]>,
-    userId: string,
-    timestamp: number,
-    window = 10000,
-    limit = 50,
-): boolean {
-    rateLimits[userId] = (rateLimits[userId] ?? []).filter((ts) => timestamp - ts < window);
-
-    if (rateLimits[userId]!.length > limit) {
-        const remainingTime = Math.ceil((rateLimits[userId]![0]! + window - timestamp) / 1000);
-        throw new Error(`Rate limit exceeded. Try again in ${remainingTime} seconds.`);
-    }
-
-    rateLimits[userId]!.push(timestamp);
-    return false;
-}
-
-/**
- * Parses a space-separated environment variable into an array.
- *
- * @param key - The environment variable name
- * @returns The parsed array, or null if not set
- */
-export function envList(key: string): string[] | null {
-    const v = process.env[key];
-    return v && v !== 'undefined' ? v.split(' ') : null;
-}
-
-/**
- * Formats a Date to ISO string without timezone suffix.
- *
- * @param date - The date to format
- * @returns ISO-formatted string without trailing Z
- */
-export function formatDate(date: Date): string {
-    return new Date(date.getTime() - date.getTimezoneOffset() * 60000).toISOString().replace('Z', '');
-}
-
-/**
- * Generates a random IPv4 address.
- *
- * @returns A string in the format "X.X.X.X"
- */
-export function genIP(): string {
-    return `${randomNumber(0, 255)}.${randomNumber(0, 255)}.${randomNumber(0, 255)}.${randomNumber(0, 255)}`;
-}
-
-/**
- * Returns a random element from an array.
- *
- * @param arr - The source array
- * @returns A random element
- */
-export function random<T>(arr: T[]): T {
-    return arr[Math.floor(Math.random() * arr.length)]!;
-}
-
-/**
- * Returns a random integer between min and max (inclusive).
- *
- * @param min - Lower bound
- * @param max - Upper bound
- * @returns A random integer in [min, max]
- */
-export function randomNumber(min: number, max: number): number {
-    return Math.floor(Math.random() * (max - min + 1)) + min;
-}
-
-/**
- * Checks if a version string is at least the given minimum.
- *
- * @param version - Version string (e.g. "v4")
- * @param min - Minimum version number
- * @returns true if the version is >= min
- */
-export function since(version: string, min: number): boolean {
-    return parseInt(version.replace('v', '')) >= min;
-}

package/src/utils/response.ts

@@ -1,28 +0,0 @@
-import type { Response } from 'express';
-
-import { DOCS_URL, STATUS_MESSAGES } from '../constants.js';
-
-/**
- * Sends a standardized JSON error response.
- *
- * @param res - Express response object
- * @param status - HTTP status code
- * @param message - Error description
- * @param docPath - Optional documentation path appended to the base URL
- */
-export function error(res: Response, status: number, message: string, docPath?: string): void {
-    const body = {
-        message: STATUS_MESSAGES[status] ?? 'Error',
-        error: message,
-        documentation: docPath ? `${DOCS_URL}/${docPath}` : DOCS_URL,
-        status: String(status),
-    };
-
-    if (typeof res.jsonResponse === 'function') {
-        res.status(status).jsonResponse(body);
-    } else {
-        res.status(status)
-            .setHeader('Content-Type', 'application/json')
-            .send(JSON.stringify(body, null, 2));
-    }
-}