@20syldev/api 3.4.4 → 3.4.6

package/README.md

@@ -1,16 +1,16 @@
 <div align="center">
-  <a href="https://api.sylvain.pro"><img src="https://api.sylvain.pro/favicon.ico" alt="Logo" width="25%" height="auto"/></a>
+  <a href="https://api.sylvain.sh"><img src="https://api.sylvain.sh/favicon.ico" alt="Logo" width="25%" height="auto"/></a>
 
   # API Personnelle
-  [![Version](https://custom-icon-badges.demolab.com/badge/Version%20:-v3.4.4-6479ee?logo=api.sylvain.pro&labelColor=23272A)](https://github.com/20syldev/api/releases/latest)
+  [![Version](https://custom-icon-badges.demolab.com/badge/Version%20:-v3.4.6-6479ee?logo=api.sylvain.sh&labelColor=23272A)](https://github.com/20syldev/api/releases/latest)
 </div>
 
 ---
 
 ## À propos de l'API
-Voici mon API personnelle, disponible sur le domaine [api.sylvain.pro](https://api.sylvain.pro).
-L'API est développée avec Node.js et hébergée **24h/7j**. Elle est **simple d'utilisation** et a une **documentation** disponible sur [docs.sylvain.pro](https://docs.sylvain.pro) !
-> *Une limite de **2000** requêtes **par heure** est fixée. Elle change pour certains endpoints nécessitant plus de ressources. Si vous souhaitez une **augmentation** de cette limite, n'hésitez pas à visiter la [documentation](https://docs.sylvain.pro/pricing).*
+Voici mon API personnelle, disponible sur le domaine [api.sylvain.sh](https://api.sylvain.sh).
+L'API est développée avec Node.js et hébergée **24h/7j**. Elle est **simple d'utilisation** et a une **documentation** disponible sur [docs.sylvain.sh](https://docs.sylvain.sh) !
+> *Une limite de **2000** requêtes **par heure** est fixée. Elle change pour certains endpoints nécessitant plus de ressources. Si vous souhaitez une **augmentation** de cette limite, n'hésitez pas à visiter la [documentation](https://docs.sylvain.sh/pricing).*
 
 ## Installer le paquet de l'API sur votre machine
 ```console
@@ -67,12 +67,12 @@ Ensuite, **déplacez-vous** dans le dossier du projet, via un terminal **Linux**
 $ cd /chemin/vers/le/projet
 ```
 
-Enfin, **exécutez** le script de build, qui installera les **dépendances** et lancera le **serveur** de l'[API](https://api.sylvain.pro) :
+Enfin, **exécutez** le script de build, qui installera les **dépendances** et lancera le **serveur** de l'[API](https://api.sylvain.sh) :
 ```console
 $ npm run build
 ```
 ```console
-> @20syldev/api@3.4.4 build
+> @20syldev/api@3.4.6 build
 > npm install && node app.js
 
 [...]
@@ -107,4 +107,4 @@ import {
 } from '@20syldev/api/v3';
 ```
 
-*Visitez la [documentation](https://docs.sylvain.pro) dédiée, vous y retrouverez des exemples de requêtes et des codes simples pour tester l'[API](https://api.sylvain.pro) !*
+*Visitez la [documentation](https://docs.sylvain.sh) dédiée, vous y retrouverez des exemples de requêtes et des codes simples pour tester l'[API](https://api.sylvain.sh) !*

package/app.js

@@ -1,5 +1,6 @@
 // Import modules
 import * as apiv3 from './modules/v3.js';
+import { envList } from './modules/v3/utils.js';
 
 // Import dependencies
 import cors from 'cors';
@@ -51,7 +52,8 @@ const v2 = {
             name: 'tic_tac_toe',
             children: {
                 tic_tac_toe: '/tic-tac-toe',
-                fetch: '/tic-tac-toe/fetch'
+                fetch: '/tic-tac-toe/fetch',
+                list: '/tic-tac-toe/list'
             }
         },
         { name: 'token', path: '/token' }
@@ -101,6 +103,9 @@ const ticTacToeStorage = {
     rateLimits: {}
 };
 
+// Define documentation URL
+const documentation = 'https://docs.sylvain.sh';
+
 // Define global variables
 let contributions, lastFetch = 0, requests = 0, requestLimit, resetTime = Date.now() + 3600000;
 
@@ -212,7 +217,7 @@ app.use((err, req, res, next) => {
     res.status(500).jsonResponse({
         message: 'Internal Server Error',
         error: err.message,
-        documentation: 'https://docs.sylvain.pro',
+        documentation,
         status: '500'
     });
 });
@@ -236,7 +241,7 @@ app.use('/:version', (req, res, next) => {
         return res.status(404).jsonResponse({
             message: 'Not Found',
             error: `Invalid API version (${version}).`,
-            documentation: `https://docs.sylvain.pro/${latest}`,
+            documentation: `${documentation}/${latest}`,
             status: '404'
         });
     }
@@ -247,7 +252,7 @@ app.use('/:version', (req, res, next) => {
         return res.status(404).jsonResponse({
             message: 'Not Found',
             error: `Module not found for version ${version}.`,
-            documentation: `https://docs.sylvain.pro/${latest}`,
+            documentation: `${documentation}/${latest}`,
             status: '404'
         });
     }
@@ -266,7 +271,7 @@ app.use('/:version/:endpoint', (req, res, next) => {
         return res.status(404).jsonResponse({
             message: 'Not Found',
             error: `Endpoint '${endpoint}' does not exist in ${req.version}.`,
-            documentation: `https://docs.sylvain.pro/${versions[version.length - 1]}`,
+            documentation: `${documentation}/${versions[version.length - 1]}`,
             status: '404'
         });
     }
@@ -284,7 +289,7 @@ app.get('/', (req, res) => {
     }, {});
 
     res.jsonResponse({
-        documentation: 'https://docs.sylvain.pro',
+        documentation,
         latest: `${base}/latest`,
         logs: `${base}/logs`,
         versions: links
@@ -299,7 +304,7 @@ app.get('/:version', (req, res) => {
         return res.status(404).jsonResponse({
             message: 'Not Found',
             error: `Invalid API version (${version}).`,
-            documentation: `https://docs.sylvain.pro/${Object.keys(versions).pop()}`,
+            documentation: `${documentation}/${Object.keys(versions).pop()}`,
             status: '404'
         });
     }
@@ -326,7 +331,7 @@ app.get('/:version', (req, res) => {
 
     res.jsonResponse({
         version,
-        documentation: `https://docs.sylvain.pro/${version}`,
+        documentation: `${documentation}/${version}`,
         endpoints
     });
 });
@@ -341,7 +346,7 @@ app.get('/:version/algorithms', (req, res) => {
     if (!req.module.algorithms || !req.module.algorithms[method]) {
         return res.jsonResponse({
             error: 'Please provide a valid algorithm (?method={algorithm})',
-            documentation: `https://docs.sylvain.pro/${version}/en/algorithms`
+            documentation: `${documentation}/${version}/en/algorithms`
         });
     }
 
@@ -351,7 +356,7 @@ app.get('/:version/algorithms', (req, res) => {
     } catch (err) {
         res.jsonResponse({
             error: err.message,
-            documentation: `https://docs.sylvain.pro/${version}/en/algorithms`
+            documentation: `${documentation}/${version}/en/algorithms`
         });
     }
 });
@@ -368,7 +373,7 @@ app.get('/:version/captcha', (req, res) => {
     } catch (err) {
         res.jsonResponse({
             error: err.message,
-            documentation: `https://docs.sylvain.pro/${req.version}/en/captcha`
+            documentation: `${documentation}/${req.version}/en/captcha`
         });
     }
 });
@@ -399,7 +404,7 @@ app.get('/:version/color', (req, res) => {
     } catch (err) {
         res.jsonResponse({
             error: err.message,
-            documentation: `https://docs.sylvain.pro/${req.version}/en/color`
+            documentation: `${documentation}/${req.version}/en/color`
         });
     }
 });
@@ -418,7 +423,7 @@ app.get('/:version/convert', (req, res) => {
     } catch (err) {
         res.jsonResponse({
             error: err.message,
-            documentation: `https://docs.sylvain.pro/${req.version}/en/convert`
+            documentation: `${documentation}/${req.version}/en/convert`
         });
     }
 });
@@ -431,7 +436,7 @@ app.get('/:version/domain', (req, res) => {
     } catch (err) {
         res.jsonResponse({
             error: err.message,
-            documentation: `https://docs.sylvain.pro/${req.version}/en/domain`
+            documentation: `${documentation}/${req.version}/en/domain`
         });
     }
 });
@@ -457,7 +462,7 @@ app.get('/:version/infos', (req, res) => {
     res.jsonResponse({
         endpoints: new Set(paths).size,
         last_version: Object.keys(versions).pop(),
-        documentation: 'https://docs.sylvain.pro',
+        documentation,
         github: 'https://github.com/20syldev/api',
         creation: 'November 25th 2024',
     });
@@ -476,7 +481,7 @@ app.get('/:version/levenshtein', (req, res) => {
     } catch (err) {
         res.jsonResponse({
             error: err.message,
-            documentation: `https://docs.sylvain.pro/${req.version}/en/levenshtein`
+            documentation: `${documentation}/${req.version}/en/levenshtein`
         });
     }
 });
@@ -489,7 +494,7 @@ app.get('/:version/personal', (req, res) => {
     } catch (err) {
         res.jsonResponse({
             error: err.message,
-            documentation: `https://docs.sylvain.pro/${req.version}/en/personal`
+            documentation: `${documentation}/${req.version}/en/personal`
         });
     }
 });
@@ -506,7 +511,7 @@ app.get('/:version/qrcode', async (req, res) => {
     } catch (err) {
         res.jsonResponse({
             error: err.message,
-            documentation: `https://docs.sylvain.pro/${req.version}/en/qrcode`
+            documentation: `${documentation}/${req.version}/en/qrcode`
         });
     }
 });
@@ -521,6 +526,11 @@ app.get('/:version/tic-tac-toe/fetch', (req, res) => {
     res.jsonResponse({ error: 'This endpoint only supports POST requests.' });
 });
 
+// GET tic-tac-toe list error
+app.get('/:version/tic-tac-toe/list', (req, res) => {
+    res.jsonResponse({ error: 'This endpoint only supports POST requests.' });
+});
+
 // Display or generate time informations
 app.get('/:version/time', (req, res) => {
     const { type = 'live', start, end, format, timezone } = req.query;
@@ -540,7 +550,7 @@ app.get('/:version/time', (req, res) => {
     } catch (err) {
         res.jsonResponse({
             error: err.message,
-            documentation: `https://docs.sylvain.pro/${req.version}/en/time`
+            documentation: `${documentation}/${req.version}/en/time`
         });
     }
 });
@@ -558,7 +568,7 @@ app.get('/:version/username', (req, res) => {
     } catch (err) {
         res.jsonResponse({
             error: err.message,
-            documentation: `https://docs.sylvain.pro/${req.version}/en/username`
+            documentation: `${documentation}/${req.version}/en/username`
         });
     }
 });
@@ -632,31 +642,35 @@ app.get('/:version/website', async (req, res) => {
             flowers: process.env.FLOWERS,
             g_2048: process.env.G_2048,
             gemsync: process.env.GEMSYNC,
+            gft: process.env.GFT,
             gitsite: process.env.GITSITE,
             lebonchar: process.env.LEBONCHAR,
             logs: process.env.LOGS,
             logvault: process.env.LOGVAULT,
             lyah: process.env.LYAH,
             minify: process.env.MINIFY,
+            mn: process.env.MN,
             monitoring: process.env.MONITORING,
             morpion: process.env.MORPION,
             nitrogen: process.env.NITROGEN,
             old_database: process.env.OLD_DATABASE,
             password: process.env.PASSWORD,
             php: process.env.PHP,
+            planning: process.env.PLANNING,
             ping: process.env.PING,
             portfolio: process.env.PORTFOLIO,
             python_api: process.env.PYTHON_API,
             readme: process.env.README,
             timestamp: process.env.TIMESTAMP,
             terminal: process.env.TERMINAL,
+            valentine: process.env.VALENTINE,
             wrkit: process.env.WRKIT,
             zpki: process.env.ZPKI
         },
-        patched_projects: process.env.PATCH?.split(' ') || [],
-        updated_projects: process.env.RECENT?.split(' ') || [],
-        new_projects: process.env.NEW?.split(' ') || [],
-        sub_domains: process.env.DOMAINS?.split(' ') || [],
+        patched_projects: envList('PATCH'),
+        updated_projects: envList('RECENT'),
+        new_projects: envList('NEW'),
+        sub_domains: envList('DOMAINS'),
         stats: {
             1: process.env.STATS1,
             2: process.env.STATS2,
@@ -667,8 +681,8 @@ app.get('/:version/website', async (req, res) => {
             this_month: contributions.month.toString(),
             last_year: contributions.year.toString(),
         },
-        notif_tag: process.env.TAG,
-        active: process.env.ACTIVE
+        tag: process.env.TAG,
+        active: process.env.ACTIVE === 'true'
     });
 });
 
@@ -676,7 +690,7 @@ app.get('/:version/website', async (req, res) => {
 
 // Store chat messages
 app.post('/:version/chat', (req, res) => {
-    const { username, message, timestamp, session, token } = req.body;
+    const { username, message, timestamp, session, token } = req.body || {};
 
     if (!username) return res.jsonResponse({ error: 'Please provide a username (?username={username})' });
     if (!message) return res.jsonResponse({ error: 'Please provide a message (&message={message})' });
@@ -699,7 +713,7 @@ app.post('/:version/chat', (req, res) => {
 
 // Display a private chat with a token
 app.post('/:version/chat/private', (req, res) => {
-    const { username, token } = req.body;
+    const { username, token } = req.body || {};
 
     if (!username) return res.jsonResponse({ error: 'Please provide a username (?username={username})' });
     if (!token) return res.jsonResponse({ error: 'Please provide a valid token (&token={key}).' });
@@ -718,12 +732,12 @@ app.post('/:version/chat/private', (req, res) => {
 
 // Generate hash
 app.post('/:version/hash', (req, res) => {
-    const { text, method } = req.body;
+    const { text, method } = req.body || {};
 
     if (!text) return res.jsonResponse({ error: 'Please provide a text (?text={text})' });
     if (!method) return res.jsonResponse({
         error: 'Please provide a valid hash algorithm (&method={algorithm})',
-        documentation: `https://docs.sylvain.pro/${req.version}/en/hash`
+        documentation: `${documentation}/${req.version}/en/hash`
     });
 
     try {
@@ -732,31 +746,31 @@ app.post('/:version/hash', (req, res) => {
     } catch (err) {
         res.jsonResponse({
             error: err.message,
-            documentation: `https://docs.sylvain.pro/${req.version}/en/hash`
+            documentation: `${documentation}/${req.version}/en/hash`
         })
     }
 });
 
 // Display a planning from an ICS file
 app.post('/:version/hyperplanning', async (req, res) => {
-    const { url, detail } = req.body;
+    const { url, detail } = req.body || {};
 
     if (!url) return res.jsonResponse({ error: 'Please provide a valid ICS file URL (?url={URL})' });
 
     try {
-        const hyperplanning = req.module.hyperplanning(url, detail);
+        const hyperplanning = await req.module.hyperplanning(url, detail);
         res.jsonResponse(hyperplanning);
     } catch (err){
         res.jsonResponse({
-            error: 'Failed to parse ICS file.',
-            documentation: `https://docs.sylvain.pro/${req.version}/en/hyperplanning`
+            error: err.message,
+            documentation: `${documentation}/${req.version}/en/hyperplanning`
         });
     }
 });
 
 // Store tic tac toe games
 app.post('/:version/tic-tac-toe', (req, res) => {
-    const { username, move, session, game } = req.body;
+    const { username, move, session, game } = req.body || {};
 
     if (!username) return res.jsonResponse({ error: 'Please provide a username (?username={username})' });
     if (!move) return res.jsonResponse({ error: 'Please provide a valid move (&move={move})' });
@@ -779,7 +793,8 @@ app.post('/:version/tic-tac-toe', (req, res) => {
 
 // Display a tic tac toe game with a token
 app.post('/:version/tic-tac-toe/fetch', (req, res) => {
-    const { username, game } = req.body;
+    const { username, game } = req.body || {};
+    const privateGame = (req.body || {}).private;
 
     if (!username) return res.jsonResponse({ error: 'Please provide a username (?username={username})' });
 
@@ -787,6 +802,19 @@ app.post('/:version/tic-tac-toe/fetch', (req, res) => {
         const result = req.module.tic_tac_toe('fetch', {
             username,
             game,
+            private: privateGame,
+            storage: ticTacToeStorage
+        });
+        res.jsonResponse(result);
+    } catch (err) {
+        res.jsonResponse({ error: err.message });
+    }
+});
+
+// List public tic tac toe games
+app.post('/:version/tic-tac-toe/list', (req, res) => {
+    try {
+        const result = req.module.tic_tac_toe('list', {
             storage: ticTacToeStorage
         });
         res.jsonResponse(result);
@@ -797,7 +825,7 @@ app.post('/:version/tic-tac-toe/fetch', (req, res) => {
 
 // Generate Token
 app.post('/:version/token', (req, res) => {
-    let { len, type } = req.body;
+    let { len, type } = req.body || {};
 
     len = parseInt(len || 24, 10);
     type = type ? type.toLowerCase() : 'alpha';
@@ -812,7 +840,7 @@ app.post('/:version/token', (req, res) => {
     } catch (err) {
         return res.jsonResponse({
             error: err.message,
-            documentation: `https://docs.sylvain.pro/${req.version}/en/token`
+            documentation: `${documentation}/${req.version}/en/token`
         });
     }
 });

package/modules/v3/hyperplanning.js

@@ -21,12 +21,12 @@ export default async function hyperplanning(url, detail) {
         .getAllSubcomponents('vevent')
         .map(e => {
             const evt = new ical.Event(e);
-            const summary = evt.summary.split(' ').filter(part => part !== '-');
+            const summary = (evt.summary || '').split(' ').filter(part => part !== '-');
             const start = formatDate(evt.startDate.toJSDate());
             const end = formatDate(evt.endDate.toJSDate());
 
             if (detail === 'full') {
-                const desc = evt.description.split('\n').map(l => l.trim());
+                const desc = (evt.description || '').split('\n').map(l => l.trim());
                 const extract = (p) => (desc.find(l => l.startsWith(p)) || '').replace(p, '').trim();
 
                 return {
@@ -42,7 +42,11 @@ export default async function hyperplanning(url, detail) {
 
             if (detail === 'list') return { summary, start, end };
 
-            return { summary: evt.summary, start, end };
+            return {
+                summary: evt.summary || '',
+                start,
+                end
+            };
         })
         .sort((a, b) => new Date(a.start) - new Date(b.start))
         .filter(e => new Date(e.end) >= new Date());

package/modules/v3/tic_tac_toe.js

@@ -3,7 +3,7 @@ import { randomBytes } from 'crypto';
 /**
  * Manages a Tic-Tac-Toe game session
  *
- * @param {string} action - The action to perform ('play' or 'fetch')
+ * @param {string} action - The action to perform ('play', 'fetch', or 'list')
  * @param {Object} params - The parameters for the action
  * @returns {Object} - The result of the action
  * @throws {Error} - If parameters are invalid
@@ -20,6 +20,9 @@ export default function tic_tac_toe(action, params = {}) {
     // Reference the storage properties
     const { games, sessions, rateLimits } = storage;
 
+    // List public games
+    if (action === 'list') return listGames(games);
+
     // Input validation for common parameters
     if (!params.username) throw new Error('Please provide a username');
 
@@ -40,7 +43,7 @@ export default function tic_tac_toe(action, params = {}) {
     } else if (action === 'fetch') {
         return fetchGame(params, games, u);
     } else {
-        throw new Error('Invalid action. Use "play" or "fetch"');
+        throw new Error('Invalid action. Use "play", "fetch", or "list"');
     }
 }
 
@@ -63,7 +66,12 @@ function playMove(params, games, sessions, u, now) {
     }
 
     // Initialize game if needed
-    games[game] = games[game] || { moves: [], players: [] };
+    games[game] = games[game] || {
+        moves: [],
+        players: [],
+        private: params.private || false,
+        creation: Date.now()
+    };
     const moves = games[game].moves;
 
     // Check if game is full
@@ -112,11 +120,12 @@ function playMove(params, games, sessions, u, now) {
  */
 function fetchGame(params, games, u) {
     const id = params.game || generateGameId();
-
     if (!games[id]) {
         games[id] = {
             moves: [],
-            players: []
+            players: [],
+            private: params.private || false,
+            creation: Date.now()
         };
     }
     if (!games[id].players.includes(u)) {
@@ -125,6 +134,7 @@ function fetchGame(params, games, u) {
 
     const moves = games[id].moves;
     const players = games[id].players;
+    const privateGame = games[id].private;
     const lastPlayer = moves.length ? moves[moves.length - 1].username : null;
     const turn = players.find(p => p !== lastPlayer) || players[0];
     const status = players.length >= 2 ? 'ready' : 'waiting';
@@ -136,10 +146,53 @@ function fetchGame(params, games, u) {
         players,
         turn,
         status,
+        private: privateGame,
         ...result
     };
 }
 
+/**
+ * List all public games in progress
+ */
+function listGames(games) {
+    const publicGames = [];
+    const now = Date.now();
+
+    for (const [gameId, game] of Object.entries(games)) {
+        // Only include public games
+        if (!game.private) {
+            const result = game.moves.length ? checkGame(game.moves) : {};
+            const isFinished = result.winner || result.tie;
+
+            // Only include active games (not finished)
+            if (!isFinished) {
+                const lastPlayer = game.moves.length ? game.moves[game.moves.length - 1].username : null;
+                const turn = game.players.find(p => p !== lastPlayer) || game.players[0];
+                const status = game.players.length >= 2 ? 'ready' : 'waiting';
+
+                publicGames.push({
+                    id: gameId,
+                    players: game.players,
+                    playersCount: game.players.length,
+                    moves: game.moves.length,
+                    turn,
+                    status,
+                    creation: game.creation || now
+                });
+            }
+        }
+    }
+
+    // Sort by creation time (newest first)
+    publicGames.sort((a, b) => b.creation - a.creation);
+
+    return {
+        message: 'Public games available',
+        count: publicGames.length,
+        games: publicGames
+    };
+}
+
 /**
  * Generate a random game ID
  */

package/modules/v3/utils.js

@@ -42,6 +42,17 @@ export function formatDate(date) {
     return new Date(date.getTime() - date.getTimezoneOffset() * 60000).toISOString().replace('Z', '');
 }
 
+/**
+ * Parse a space-separated env variable into an array, or return null.
+ *
+ * @param {string} key - The environment variable name.
+ * @returns {string[]|null} - The parsed array or null.
+ */
+export function envList(key) {
+    const v = process.env[key];
+    return v && v !== 'undefined' ? v.split(' ') : null;
+}
+
 /**
  * Manage rate limiting for users
  *

package/package.json

@@ -1,7 +1,7 @@
 {
-    "version": "3.4.4",
+    "version": "3.4.6",
     "name": "@20syldev/api",
-    "description": "Node.js API with multiple features. Check the documentation at https://docs.sylvain.pro",
+    "description": "Node.js API with multiple features. Check the documentation at https://docs.sylvain.sh",
     "main": "app.js",
     "type": "module",
     "scripts": {
@@ -49,5 +49,5 @@
     "bugs": {
         "url": "https://github.com/20syldev/api/issues"
     },
-    "homepage": "https://api.sylvain.pro"
+    "homepage": "https://api.sylvain.sh"
 }