@20syldev/api 5.6.0 → 5.8.0

package/dist/types/storage.d.ts

@@ -0,0 +1,49 @@
+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;
+    last?: 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/dist/utils/colors.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 declare function hexToRgb(hex: string): [number, number, number];
+/**
+ * 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 declare function hslToRgb(h: number, s: number, l: number): [number, number, number];
+/**
+ * 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 declare function normalizeColor(value: string | undefined, def: string): string;
+/**
+ * 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 declare function rgbToHex(r: number, g: number, b: number): string;
+/**
+ * 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 declare function rgbToHsl(r: number, g: number, b: number): [number, number, number];

package/dist/utils/helpers.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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 declare function checkRateLimit(rateLimits: Record<string, number[]>, userId: string, timestamp: number, window?: number, limit?: number): boolean;
+/**
+ * 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 declare function envList(key: string): string[] | null;
+/**
+ * Formats a Date to ISO string without timezone suffix.
+ *
+ * @param date - The date to format
+ * @returns ISO-formatted string without trailing Z
+ */
+export declare function formatDate(date: Date): string;
+/**
+ * Generates a random IPv4 address.
+ *
+ * @returns A string in the format "X.X.X.X"
+ */
+export declare function genIP(): string;
+/**
+ * Returns a random element from an array.
+ *
+ * @param arr - The source array
+ * @returns A random element
+ */
+export declare function random<T>(arr: T[]): T;
+/**
+ * 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 declare function randomNumber(min: number, max: number): number;
+/**
+ * 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 declare function since(version: string, min: number): boolean;

package/dist/utils/response.d.ts

@@ -0,0 +1,9 @@
+import type { Response } from 'express';
+/**
+ * Sends a standardized JSON error response.
+ *
+ * @param res - Express response object
+ * @param status - HTTP status code
+ * @param message - Error description
+ */
+export declare function error(res: Response, status: number, message: string): void;

package/dist/utils/response.js

@@ -1,17 +1,15 @@
-import { DOCS_URL, STATUS_MESSAGES } from '../constants.js';
+import { 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, status, message, docPath) {
+export function error(res, status, message) {
     const body = {
         message: STATUS_MESSAGES[status] ?? 'Error',
         error: message,
-        documentation: docPath ? `${DOCS_URL}/${docPath}` : DOCS_URL,
         status: String(status),
     };
     if (typeof res.jsonResponse === 'function') {

package/dist/utils/response.js.map

@@ -1 +1 @@
-{"version":3,"file":"response.js","sourceRoot":"","sources":["../../src/utils/response.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAE5D;;;;;;;GAOG;AACH,MAAM,UAAU,KAAK,CAAC,GAAa,EAAE,MAAc,EAAE,OAAe,EAAE,OAAgB;IAClF,MAAM,IAAI,GAAG;QACT,OAAO,EAAE,eAAe,CAAC,MAAM,CAAC,IAAI,OAAO;QAC3C,KAAK,EAAE,OAAO;QACd,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,QAAQ,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,QAAQ;QAC5D,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;KACzB,CAAC;IAEF,IAAI,OAAO,GAAG,CAAC,YAAY,KAAK,UAAU,EAAE,CAAC;QACzC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;SAAM,CAAC;QACJ,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC;aACb,SAAS,CAAC,cAAc,EAAE,kBAAkB,CAAC;aAC7C,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC;AACL,CAAC"}
+{"version":3,"file":"response.js","sourceRoot":"","sources":["../../src/utils/response.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElD;;;;;;GAMG;AACH,MAAM,UAAU,KAAK,CAAC,GAAa,EAAE,MAAc,EAAE,OAAe;IAChE,MAAM,IAAI,GAAG;QACT,OAAO,EAAE,eAAe,CAAC,MAAM,CAAC,IAAI,OAAO;QAC3C,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;KACzB,CAAC;IAEF,IAAI,OAAO,GAAG,CAAC,YAAY,KAAK,UAAU,EAAE,CAAC;QACzC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;SAAM,CAAC;QACJ,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC;aACb,SAAS,CAAC,cAAc,EAAE,kBAAkB,CAAC;aAC7C,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC;AACL,CAAC"}

package/package.json

@@ -1,32 +1,36 @@
 {
-    "version": "5.6.0",
+    "version": "5.8.0",
     "name": "@20syldev/api",
     "description": "Node.js API with multiple features. Check the documentation at https://docs.sylvain.sh",
-    "main": "dist/app.js",
+    "main": "./dist/modules/v5.js",
+    "types": "./dist/modules/v5.d.ts",
     "type": "module",
     "scripts": {
         "prepare": "tsc",
         "dev": "tsx watch src/app.ts",
         "start": "node dist/app.js",
         "build": "tsc",
-        "check": "tsc --noEmit -p tsconfig.test.json && eslint src/ tests/",
-        "format": "prettier --write src/ tests/ && eslint --fix src/ tests/",
-        "test": "NODE_ENV=test node --import tsx --test --test-force-exit tests/unit/*.test.ts tests/integration/*.test.ts",
-        "upgrade:minor": "npm upgrade",
-        "upgrade:major": "npx npm-check-updates -u && npm install"
+        "check": "tsc --noEmit -p tsconfig.test.json && eslint src/ tests/ && prettier --check .",
+        "format": "prettier --write . && eslint --fix src/ tests/",
+        "test": "NODE_ENV=test DOCS_URL=https://docs.example.test node --import tsx --test tests/unit/*.test.ts tests/integration/*.test.ts"
     },
     "engines": {
-        "node": ">=22.0.0"
+        "node": ">=22.12.0"
     },
     "exports": {
-        "./v1": "./dist/modules/v1.js",
-        "./v2": "./dist/modules/v2.js",
-        "./v3": "./dist/modules/v3.js",
-        "./v4": "./dist/modules/v4.js",
-        "./v5": "./dist/modules/v5.js"
+        ".": { "types": "./dist/modules/v5.d.ts", "default": "./dist/modules/v5.js" },
+        "./server": { "types": "./dist/app.d.ts", "default": "./dist/app.js" },
+        "./v1": { "types": "./dist/modules/v3.d.ts", "default": "./dist/modules/v3.js" },
+        "./v2": { "types": "./dist/modules/v3.d.ts", "default": "./dist/modules/v3.js" },
+        "./v3": { "types": "./dist/modules/v3.d.ts", "default": "./dist/modules/v3.js" },
+        "./v4": { "types": "./dist/modules/v4.d.ts", "default": "./dist/modules/v4.js" },
+        "./v5": { "types": "./dist/modules/v5.d.ts", "default": "./dist/modules/v5.js" },
+        "./package.json": "./package.json"
     },
     "dependencies": {
         "@20syldev/logger.ts": "^1.0.1",
+        "@types/express": "^5.0.0",
+        "@types/node": "^22.19.17",
         "canvas": "^3.1.0",
         "cors": "^2.8.5",
         "dotenv": "^16.4.7",
@@ -39,14 +43,11 @@
     "devDependencies": {
         "@eslint/js": "^9.24.0",
         "@types/cors": "^2.8.17",
-        "@types/express": "^5.0.0",
-        "@types/node": "^22.19.17",
         "@types/qrcode": "^1.5.6",
         "@types/uuid": "^10.0.0",
         "eslint": "^9.24.0",
         "eslint-config-prettier": "^10.1.1",
         "eslint-plugin-simple-import-sort": "^13.0.0",
-        "npm-check-updates": "^18.0.1",
         "prettier": "^3.5.3",
         "tsx": "^4.19.0",
         "typescript": "^5.7.0",

package/robots.txt

@@ -0,0 +1,74 @@
+User-agent: 360Spider
+User-agent: 360Spider-Image
+User-agent: 360Spider-Video
+User-agent: AdsBot-Google
+User-agent: AdsBot-Google-Mobile
+User-agent: AdsBot-Google-Mobile-Apps
+User-agent: adidxbot
+User-agent: Applebot
+User-agent: AppleNewsBot
+User-agent: Baiduspider
+User-agent: Baiduspider-image
+User-agent: Baiduspider-news
+User-agent: Baiduspider-video
+User-agent: bingbot
+User-agent: BingPreview
+User-agent: BublupBot
+User-agent: CCBot
+User-agent: Cliqzbot
+User-agent: coccoc
+User-agent: coccocbot-image
+User-agent: coccocbot-web
+User-agent: Daumoa
+User-agent: Dazoobot
+User-agent: DeuSu
+User-agent: DuckDuckBot
+User-agent: DuckDuckGo-Favicons-Bot
+User-agent: EuripBot
+User-agent: Exploratodo
+User-agent: Facebot
+User-agent: Feedly
+User-agent: Findxbot
+User-agent: Googlebot
+User-agent: Googlebot-Image
+User-agent: Googlebot-Mobile
+User-agent: Googlebot-News
+User-agent: Googlebot-Video
+User-agent: HaoSouSpider
+User-agent: ichiro
+User-agent: istellabot
+User-agent: JikeSpider
+User-agent: Lycos
+User-agent: Mail.Ru
+User-agent: Mediapartners-Google
+User-agent: MojeekBot
+User-agent: msnbot
+User-agent: msnbot-media
+User-agent: OrangeBot
+User-agent: Pinterest
+User-agent: Plukkie
+User-agent: Qwantify
+User-agent: Rambler
+User-agent: SeznamBot
+User-agent: Sosospider
+User-agent: Slurp
+User-agent: Sogou blog
+User-agent: Sogou inst spider
+User-agent: Sogou News Spider
+User-agent: Sogou Orion spider
+User-agent: Sogou spider2
+User-agent: Sogou web spider
+User-agent: SputnikBot
+User-agent: Teoma
+User-agent: Twitterbot
+User-agent: wotbox
+User-agent: yacybot
+User-agent: Yandex
+User-agent: YandexMobileBot
+User-agent: Yeti
+User-agent: YioopBot
+User-agent: yoozBot
+User-agent: YoudaoBot
+Disallow:
+User-agent: *
+Disallow: /