ddmaster 3.1.3 → 3.1.5

package/README.md

@@ -1,124 +1,77 @@
-Короче
-позже добавлю другие функции, сейчас пока что только получение сырой инфы и список серверов.
-Пакет зделан чтобы проще работать с ДДНет серверами.
+# ddmaster
 
-зделал я 0374flop
+Пакет для работы с ДДНет серверами.
+Сделал я, 0374flop. MIT лицензия (./LICENSE)
 
+---
+
+## Установка
+
+```
 npm i ddmaster
-ето скачать.
-
-getDDNetServers() - Возвращает сервера дднет в виде [ 'ip:port' ], принимает второй параметер data. (getrawDDNetServers)
-getrawDDNetServers() - Возвращает сырую инфу
-convertudptw(addr) - берет что-то типа "tw-0.6+udp://203.86.233.50:8352" и возвращает просто "айпи:порт"
-вот код етой штуки
-"
-function convertudptw(addr) {
-    if (typeof addr !== 'string') return null;
-    const match = addr.match(/(\d{1,3}(\.\d{1,3}){3}:\d+)/);
-    loger.log('convertudptw', addr, '->', match ? match[1] : null);
-    return match ? match[1] : null;
-}
-"
-findDDNetPlayerByName(name) - штука которая возвращает примерно ту же raw дату (как у getrawDDNetServers),
-но отфильтровано где есть нужный игрок. 
-Так же можно передавать data как второй параметр, тоесть типа findDDNetPlayerByName(playerName, data) и data тут со структорой как у getrawDDNetServers.
-
-Лицензия MIT (./LICENSE)
-
-npm i ddmaster устанавливаем
-
-
-const ddmaster = require('ddmaster'); рекуирим
-
-
-getrawDDNetServers() пример того что выдаст (будет много серверов, но тут только один)
-[
-	{
-        "addresses": [
-            "tw-0.6+udp://203.86.233.50:8352",
-            "tw-0.7+udp://203.86.233.50:8352"
-        ],
-        "community": "ddnet",
-        "location": "as:hk",
-        "info": {
-            "max_clients": 63,
-            "max_players": 63,
-            "passworded": false,
-            "game_type": "DDraceNetwork",
-            "flag": 156,
-            "name": "DDNet CHN1 香港 - Moderate 中阶",
-            "map": {
-                "name": "Weapons",
-                "sha256": "8d6d0f5724dbec496d2ed88dc50c80ff09fdc6fd3d60bd2e1de6d3e666544054",
-                "size": 625069
-            },
-            "version": "0.6.4, 19.6",
-            "client_score_kind": "time",
-            "requires_login": false,
-            "clients": [
-                {
-                    "name": "Rabbit Doll",
-                    "clan": "兔玩偶",
-                    "country": -1,
-                    "score": -9999,
-                    "is_player": true,
-                    "skin": {
-                        "name": "rongrongtu_blue"
-                    },
-                    "afk": false,
-                    "team": 0
-                },
-                {
-                    "name": "Nyakori's",
-                    "clan": "兔玩偶",
-                    "country": -1,
-                    "score": -9999,
-                    "is_player": true,
-                    "skin": {
-                        "name": "rongrongtu_pink"
-                    },
-                    "afk": false,
-                    "team": 0
-                },
-                {
-                    "name": "18687017299",
-                    "clan": "糖糖教",
-                    "country": -1,
-                    "score": -9999,
-                    "is_player": true,
-                    "skin": {
-                        "name": "Shadow Catsk"
-                    },
-                    "afk": true,
-                    "team": 0
-                },
-                {
-                    "name": "pbAdq",
-                    "clan": "",
-                    "country": -1,
-                    "score": 2167,
-                    "is_player": true,
-                    "skin": {
-                        "name": "maotouying"
-                    },
-                    "afk": false,
-                    "team": 0
-                },
-                {
-                    "name": "549120418",
-                    "clan": "日月教",
-                    "country": 156,
-                    "score": -9999,
-                    "is_player": true,
-                    "skin": {
-                        "name": "ghostjtj",
-                        "color_body": 14810880,
-                        "color_feet": 16776960
-                    },
-                    "afk": false,
-                    "team": 0
-                }
-            ]
-        }
-    }
-]
+```
+
+## Импорт
+
+```js
+const ddmaster = require('ddmaster'); // CommonJS
+```
+```ts
+import * as ddmaster from 'ddmaster'; // ESM / TypeScript
+```
+
+---
+
+## API
+
+**getrawDDNetServers()**
+Возвращает сырую инфу с мастер сервера ДДНета. Структура ответа — `{ servers: DDNetServer[] }`.
+
+**getDDNetServers(data?)**
+Возвращает список серверов в виде `['ip:port']`.
+`data` — опционально, сырая data от `getrawDDNetServers()`. Если не передана, сама получит.
+
+**findDDNetPlayerByName(playerName, data?)**
+Ищет игрока по имени (строгое сравнение через `===`) на всех серверах.
+Возвращает массив серверов (та же структура что у `getrawDDNetServers`), но только те где есть этот игрок.
+`data` — опционально, сырая data от `getrawDDNetServers()`.
+
+**getinfoserver(address)**
+Возвращает полную инфу об одном сервере по адресу `'ip:port'`. Или `undefined` если не найден.
+
+**convertudptw(addr)**
+Берёт адрес типа `"tw-0.6+udp://203.86.233.50:8352"` и возвращает просто `"203.86.233.50:8352"`.
+Если адрес невалидный — возвращает `null`.
+
+**filterbycommunity(servers, community)**
+Фильтрует массив серверов по community (например `'ddnet'`).
+
+**filterbylocation(servers, location)**
+Фильтрует массив серверов по локации, точное совпадение (например `'eu:de'`).
+
+**filterbylocationincludes(servers, location)**
+То же самое но через includes (например `'eu'` найдёт `'eu:de'`, `'eu:pl'` и тд).
+
+---
+
+## Пример
+
+```js
+const ddmaster = require('ddmaster');
+
+// список всех серверов
+const servers = await ddmaster.getDDNetServers();
+console.log(servers); // ['ip:port', ...]
+
+// найти игрока
+const found = await ddmaster.findDDNetPlayerByName('имя игрока');
+console.log(found); // массив серверов где есть игрок
+
+// получить только европейские сервера
+const raw = await ddmaster.getrawDDNetServers();
+const eu = ddmaster.filterbylocationincludes(raw.servers, 'eu');
+```
+
+---
+
+Позже добавлю ещё функции.

package/lib/serverlist.js

@@ -115,7 +115,7 @@ function filterbylocationincludes(servers, location) {
 async function getinfoserver(address) {
     const servers = await getrawDDNetServers();
     const server = servers?.servers.find((server) => {
-        if (server.addresses)
+        if (!server.addresses || server.addresses.length === 0)
             return false;
         return convertudptw(server.addresses[0]) === address;
     });

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "ddmaster",
-  "version": "3.1.3",
+  "version": "3.1.5",
   "description": "Позволяет опрашивать мастер-сервер дднета",
-  "main": "index.js",
+  "main": "lib/index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },

package/index.js

@@ -1,2 +0,0 @@
-const ddmaster = require('./lib/index.js');
-module.exports = ddmaster;

package/src/bin.ts

@@ -1,44 +0,0 @@
-#!/usr/bin/env node
-
-const ddmaster = require('./index.js');
-
-
-const [command, ...args] = process.argv.slice(2);
-
-if (command === "find") {
-    ddmaster.findDDNetPlayerByName(args.join(" ")).then(async (servers: import('./types').DDNetServer[]) => {
-        if (servers.length === 0) {
-            console.log("Player not found on any server.");
-            return;
-        }
-
-        console.log(`Count of servers: ${servers.length}`);
-        console.log((await ddmaster.getDDNetServers(servers)).join("\n"));
-    }).catch((err: Error) => {
-        console.error('Error:', err);
-    });
-} else if (command === "list") {
-    ddmaster.getDDNetServers().then((servers: string[]) => {
-        console.log(servers.join("\n"));
-    }).catch((err: Error) => {
-        console.error('Error:', err);
-    });
-} else if (command === "raw") {
-    ddmaster.getrawDDNetServers().then((servers: import('./types').DDNetServer[]) => {
-        console.log(JSON.stringify(servers, null, 2));
-    }).catch((err: Error) => {
-        console.error('Error:', err);
-    });
-} else if (command === "info") {
-    ddmaster.getinfoserver(args[0]).then((server: import('./types').DDNetServer) => {
-        console.log(JSON.stringify(server, null, 2));
-    }).catch((err: Error) => {
-        console.error('Error:', err);
-    });
-} else {
-    console.log("Usage:");
-    console.log("  find <playerName> - Найти сервера с игроком");
-    console.log("  list - Получить список всех серверов");
-    console.log("  raw - Получить сырые данные серверов");
-    console.log("  info <address> - Получить информацию о сервере по адресу");
-}

package/src/index.ts

@@ -1,19 +0,0 @@
-/**
- * ddmaster
- */
-const lib = require('./serverlist.js');
-
-module.exports = lib;
-
-if (require.main === module) (async () =>{
-    console.log(
-        JSON.stringify(
-            await lib.getDDNetServers(
-                await lib.findDDNetPlayerByName('0374_bober')
-            ),
-            null,
-            1
-        )
-    ); // тестовый вызов
-    // console.log(await lib.getrawDDNetServers());
-})();

package/src/serverlist.ts

@@ -1,132 +0,0 @@
-// 0374flop MIT
-// npm i ddmaster
-
-"use strict";
-
-if (typeof fetch === 'undefined') {
-    try {
-        require.resolve('node-fetch');
-    } catch (e) {
-        throw new Error('Node.js <18, npm install node-fetch');
-    }
-
-    const nodeFetch = require('node-fetch');
-    global.fetch = nodeFetch.default || nodeFetch;
-}
-
-/**
- * Делает запрос на мастер сервер ДДНета.
- * @returns Сервера ДДНета но в сыром виде.
- */
-async function getrawDDNetServers(): Promise<{ servers: import('./types').DDNetServer[] } | null> {
-    try {
-        const response = await fetch('https://master1.ddnet.org/ddnet/15/servers.json');
-        if (!response.ok) throw new Error(`Ошибка при запросе: ${response.status}`);
-        const data = await response.json();
-        return data;
-    } catch (error) {
-        console.error(error);
-        return null;
-    }
-}
-
-/**
- * 
- * @param {string} addr - берёт примерно такое "tw-0.7+udp://152.89.254.27:8310"
- * @returns {string|null} 152.89.254.27:8310 возвращает чистый адрес (если addr не валидный то null)
- */
-function convertudptw(addr: string) {
-    if (typeof addr !== 'string') return null;
-    const match = addr.match(/(\d{1,3}(\.\d{1,3}){3}:\d+)/);
-    return match ? match[1] : null;
-}
-
-/**
- * Делает запрос на мастер сервер ДДНета.
- * @param {Object|null} data - опционально, сырая data от getrawDDNetServers(). Если не передана, функция сама её получит.
- * @returns Сервера ДДНета если все пошло хорошо. ['ip:port']
- */
-async function getDDNetServers(data = null) {
-    try {
-        const servers = data || (await getrawDDNetServers())?.servers;
-        if (!servers) {
-            return [];
-        }
-
-        const ipv4WithPorts: string[] = [];
-
-        for (const server of servers) {
-            server.addresses.forEach((addr: string) => {
-				const converted = convertudptw(addr);
-				if (converted == null) return;
-                ipv4WithPorts.push(converted);
-            });
-        }
-        return [...new Set(ipv4WithPorts)];
-    } catch (err) {
-        console.error(err);
-        return [];
-    }
-}
-
-/**
- * Ищет игрока по имени на всех серверах ДДНета.
- * Возвращает ПОЛНУЮ инфу о серверах (как getrawDDNetServers),
- * но только те сервера, где есть игрок с таким именем.
- *
- * @param {string} playerName - имя игрока, ищется строго через ===
- * @param {Object|null} data - опционально, сырая data от getrawDDNetServers().
- * @returns {Promise<Array>} Массив серверов (как в getrawDDNetServers().servers),
- * на которых найден игрок.
- */
-async function findDDNetPlayerByName(playerName: string, data = null) {
-    if (typeof playerName !== 'string') {
-        throw new TypeError('playerName должен быть строкой');
-    }
-
-    try {
-        const raw = data || await getrawDDNetServers();
-        if (!raw || !Array.isArray(raw.servers)) {
-            return [];
-        }
-
-        const resultServers = [];
-
-        for (const server of raw.servers) {
-            const info = server.info;
-            if (!info || !Array.isArray(info.clients)) continue;
-
-            const hasPlayer = info.clients.some((client: import('./types').ServerClient) => client.name === playerName);
-            if (hasPlayer) {
-                resultServers.push(server);
-            }
-        }
-        return resultServers;
-    } catch (err) {
-        console.error(err);
-        return [];
-    }
-}
-
-function filterbycommunity(servers: import('./types').DDNetServer[], community: string) {
-    return servers.filter(server => server.community === community);
-}
-
-function filterbylocation(servers: import('./types').DDNetServer[], location: string) {
-    return servers.filter(server => server.location?.toLowerCase() === location?.toLowerCase());
-}
-
-function filterbylocationincludes(servers: import('./types').DDNetServer[], location: string) {
-    return servers.filter(server => server.location?.toLowerCase().includes(location?.toLowerCase()));
-}
-
-async function getinfoserver(address: string) {
-    const servers = await getrawDDNetServers();
-    const server = servers?.servers.find((server: import('./types').DDNetServer) => {
-        if (server.addresses) return false;
-        return convertudptw(server.addresses[0]) === address;
-    });
-    return server;
-}
-
-module.exports = { getDDNetServers, getrawDDNetServers, convertudptw, findDDNetPlayerByName, filterbycommunity, filterbylocation, filterbylocationincludes, getinfoserver };

package/src/types.ts

@@ -1,43 +0,0 @@
-export interface DDNetServer {
-    addresses: string[];
-    community: string;
-    location: string;
-    info: ServerInfo;
-}
-
-export interface ServerInfo {
-    max_clients: number;
-    max_players: number;
-    passworded: boolean;
-    game_type: string;
-    flag: number;
-    name: string;
-    map: ServerMap;
-    version: string;
-    client_score_kind: string;
-    requires_login: boolean;
-    clients: ServerClient[];
-}
-
-export interface ServerMap {
-    name: string;
-    sha256: string;
-    size: number;
-}
-
-export interface ServerClient {
-    name: string;
-    clan: string;
-    country: number;
-    score: number;
-    is_player: boolean;
-    skin: ClientSkin;
-    afk: boolean;
-    team: number;
-}
-
-export interface ClientSkin {
-    name: string;
-    color_body?: number;
-    color_feet?: number;
-}

package/tsconfig.json

@@ -1,43 +0,0 @@
-{
-  // Visit https://aka.ms/tsconfig to read more about this file
-  "compilerOptions": {
-    // File Layout
-    "rootDir": "./src",
-    "outDir": "./lib",
-
-    // Environment Settings
-    // See also https://aka.ms/tsconfig/module
-    "module": "nodenext",
-    "target": "esnext",
-    "types": ["node"],
-    // For nodejs:
-    // "lib": ["esnext"],
-    // "types": ["node"],
-    // and npm install -D @types/node
-
-    // Other Outputs
-    "sourceMap": false,
-    "declaration": true,
-    "declarationMap": false,
-
-    // Stricter Typechecking Options
-    "noUncheckedIndexedAccess": true,
-    "exactOptionalPropertyTypes": true,
-
-    // Style Options
-    // "noImplicitReturns": true,
-    // "noImplicitOverride": true,
-    // "noUnusedLocals": true,
-    // "noUnusedParameters": true,
-    // "noFallthroughCasesInSwitch": true,
-    // "noPropertyAccessFromIndexSignature": true,
-
-    // Recommended Options
-    "strict": true,
-    "verbatimModuleSyntax": true,
-    "isolatedModules": true,
-    "noUncheckedSideEffectImports": true,
-    "moduleDetection": "force",
-    "skipLibCheck": true,
-  }
-}