neekuro 2.0.0

package/package.json

@@ -0,0 +1,64 @@
+{
+  "$schema": "https://json.schemastore.org/package.json",
+  "name": "neekuro",
+  "version": "2.0.0",
+  "description": "Una biblioteca de imágenes con temática de anime para bots de Discord.",
+  "main": "sources/main/index.js",
+  "types": "sources/typings/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./sources/typings/index.d.ts",
+        "default": "./sources/main/index.js"
+      },
+      "require": {
+        "types": "./sources/typings/index.d.ts",
+        "default": "./sources/main/index.js"
+      }
+    }
+  },
+  "directories": {
+    "test": "test"
+  },
+  "files": [
+    "sources",
+    "README.md"
+  ],
+  "contributors": [
+    "cacao0027 <kzmkuro@gmail.com>"
+  ],
+  "author": "cacao0027 <kzmkuro@gmail.com>",
+  "keywords": [
+    "anime",
+    "acción",
+    "gifs",
+    "imagenes",
+    "nsfw",
+    "sfw",
+    "discord",
+    "action",
+    "images"
+  ],
+  "license": "ISC",
+  "scripts": {
+    "test": "nodemon node ./test/main.test.js"
+  },
+  "engines": {
+    "node": ">=20.12.2"
+  },
+  "dependencies": {
+    "canvas": "^3.1.0",
+    "hex-color-regex": "^1.1.0",
+    "neekuro": "file:",
+    "nekoapi.beta": "^1.0.5",
+    "node-fetch": "^3.3.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/CacaoNk0027/neekuro_package.git"
+  },
+  "bugs": {
+    "url": "https://github.com/CacaoNk0027/neekuro_package/issues"
+  },
+  "homepage": "https://github.com/CacaoNk0027/neekuro_package#readme"
+}

package/readme.md

@@ -0,0 +1,123 @@
+<center> <h1>NeeKuro</h1> </center>
+<center>de <b>Kmz Kuro</b> en nombre de <b>NexaTDC</b></center>
+<center>creada apartir de <b>cacao_nekoapi</b> y <b>nekoapi.beta</b> en npm.js</center>
+<br>
+<center>
+<img alt="NPM Version" src="https://img.shields.io/npm/v/neekuro?logo=npm&style=flat&color=0d8973">
+<img alt="Downloads" src="https://img.shields.io/npm/dw/neekuro?style=flat&color=bf9308&label=Descargas">
+<img alt="Typescript" src="https://img.shields.io/badge/declaraciones-typescript-blue?logo=typescript">
+<img alt="NPM Version" src="https://img.shields.io/badge/node%20version-%3E=20.12.2-489248?logo=nodedotjs">
+</center>
+
+### ¿Qué es "NeeKuro"?
+
+NeeKuro es una biblioteca de imágenes con temática de anime para bots de Discord e imagenes de bienvenida.
+
+Principalmente se creo con el fin de ser unicamente para <b>Maple Bot</b>. Sin embargo, desde que se decidio hacer a Maple de codigo publico, tambien se decidio que tanto su API como paquete fuesen libres.
+
+> notas: el paquete puede contener errores ya que se encuentra en fase beta, la API se hostea de manera gratuita por lo que las solicitudes no siempre pueden estar disponibles.
+
+## Instalacion
+
+```sh
+npm install neekuro
+```
+
+## Ejemplos
+
+NeeKuro es un paquete que requiere de un token para llevar a cabo sus sollicitudes, por lo que requieres de ir a la [API Oficial](https://www.nexatdc.work.gd/api/) para poder generar un token.
+
+### primeros pasos
+1 - Instanciamiento de usuario y establecimiento del token.<br>Este paso se requiere ya que con ello se establece globalmente el token por el paquete
+<hr>
+
+```javascript
+require('dotenv').config();
+// importacion del paquete neekuro
+const neekuro = require('neekuro');
+
+// instanciamiento del usuario
+const user = new neekuro.User();
+
+// establecimiento del token
+user.token(process.env['ApiToken'])
+```
+<hr>
+
+#### Peticion de imagenes simple
+Una vez estableciste el token puedes comenzar a pedir imagenes
+
+```javascript
+
+const neekuro = require('neekuro');
+
+/**
+ * Codigo de usuario
+ */
+
+// es necesario escribir todo siempre dentro de una funcion asincrona
+async function ObtenerImagen() {
+    // obtenemos un gif con el metodo getGif de SFW
+    const cuddle = await neekuro.SFW.getGif('action', 'cuddle');
+    
+    // imprimimos la url y el anime del gif
+    console.log(cuddle.getUrl(), cuddle.getAnime())
+}
+
+// ejecutamos la funcion
+ObtenerImagen();
+
+// nota: no te aguites por el gif y subcategoria, todo viene en documentado con typescript, solo tienes que completar los pasos :)
+```
+#### Ejemplo de imagenes de bienvenida
+Las imagenes de bienvenida son otra de las alternativas que otorga NeeKuro, puedes hacer una imagen de la siguiente manera:
+```javascript
+// obtenemos directamente la clase del paquete
+const { Welcome } = require('neekuro');
+const fs = require('fs');
+
+// Configuración básica, añade un avatar titulo y descripción
+const welcome = new Welcome()
+  .setAvatar('https://ejemplo.com/avatar.jpg')
+  .setTitle('¡Bienvenido!')
+  .setDescription('Al servidor de Discord');
+
+// Genera y guarda la imagen
+welcome.build()
+  .then(image => fs.writeFileSync('bienvenida.png', image))
+  .then(() => console.log('Imagen creada correctamente!'))
+  .catch(err => console.error('Error:', err.message));
+
+// nota: como antes, todo viene bien documentado en el paquete, solo sigue los pasos y explora por ti ;3
+```
+<hr>
+<center>
+<p>Resultado esperado</p>
+<img src="./sources/assets/example.png" style="width: 60%; max-width: 500px;" alt="Texto alternativo">
+</center>
+
+## Contenido
+
+Lo siguente es lo que contiene (o contendra) el paquete
+
+| Categoria | Descripción | |
+|-|-|-|
+| Sfw | Contenido de roleplay no nsfw | en desarrollo
+| Nsfw | Contenido +18 general y roleplay | no comenzada
+
+## Finalmente....
+
+Tanto la API, paquete y bot se encuentran en desarrollo, ante todo te pedimos la mayor de las paciencias, te aseguraremos que el resultado te gustará! :'3
+
+Finalmente te agradecemos tu preferencia y esperamos haber cumplido tus espectativas ;)
+<br><br><hr>
+
+### que se tiene planeado?
+
+Principalmente terminaremos la categoria acción y reacción para tener la primer subida a NPM de este paquete y asi finalmente tener terminada la categoria SFW. <br> Sin embargo una de las problematicas que se nos presentan son buscar los gifs para la API asi como sus animes <b>es un proceso lento...</b> y agobiante...
+<br>Por eso ahora mas que nunca queremos que nos apoyes en <b>NexaTDC</b>! Con el fin de poder dar al publico lo mas pronto posible los servicios que Maple Bot ofrece.
+
+<b><i>No es para mi, es para la comunidad... Si no es para la comunidad, no es para nadie...</i></b>
+<i>- NexaTDC</i>
+<br><br><br><br>
+CC. Creative Commons 2025 - @CacaoNk0027

package/sources/classes/errors/apierror.js

@@ -0,0 +1,60 @@
+'use strict';
+
+/**
+ * @typedef {import('../../typings').ApiResponse} ApiResponse
+ * @typedef {import('node-fetch').Response} Response
+ */
+
+/**
+ * Clase APIError
+ * Errores personalizados respecto a la api rest
+ * @extends Error
+ */
+class APIError extends Error {
+    /**
+     * Crea la instancia del error
+     * @param {string} endpoint la ruta a la que se realizo la peticion
+     * @param {Response} response respuesta de node-fetch
+     * @param {ApiResponse} data respuesta de la api
+     */
+    constructor(endpoint, response, data) {
+        super();
+        
+        this.name = `NekoREST Error [${endpoint}]`
+        this.message = this.#determineMessage(data);
+
+        /**
+         * @type {string}
+         */
+        this.url = response?.url ?? 'unknown';
+
+        /**
+         * @type {number}
+         */
+        this.statusCode = parseInt(response?.status ?? 500);
+
+        /**
+         * @type {ApiResponse}
+         */
+        this.data = data
+
+    }
+
+    /**
+     * Determina el mensaje del error basado en el codigo de la api
+     * @param {ApiResponse} response respuesta de la api
+     * @returns {string} mensaje de error
+     */
+    #determineMessage(response) {
+        if(response.code === 403) {
+            return 'TOKEN ERROR: el token que haz proporcionado es invalido'
+        } else 
+        if(response.code === 401) {
+            return 'TOKEN ERROR: no se proporciono un token'
+        } else {
+            return response.message ?? 'descripcion no dada'
+        }
+    }
+}
+
+module.exports = APIError

package/sources/classes/errors/error.js

@@ -0,0 +1,25 @@
+'use strict';
+
+/**
+ * Clase de erorres para la API
+ * @extends Error
+ */
+class NekoError extends Error {
+    /**
+     * Crea una instancia para errores del paquete
+     * @param {string} name Corresponde al nombre del error
+     * @param {string} message Mensaje de error
+     */
+    constructor(name, message) {
+        super(message);
+        
+        this.name = `NeeKuro Error [${name}]`
+        
+        /**
+         * @type {string}
+         */
+        this.message = message
+    }
+}
+
+module.exports = NekoError

package/sources/classes/package/nekogif.js

@@ -0,0 +1,50 @@
+'use strict';
+
+/**
+ * @typedef {import("../../typings").GifResponse} GifResponse
+ */
+
+/**
+ * Clase NekoGif
+ * crea un objeto Gif a partir de la respuesta del servidor
+ */
+class NekoGif {
+    
+    /**
+     * Recibe la respuesta de la api
+     * @param {GifResponse} response respuesta de la api 
+     */
+    constructor(response) {
+        
+        /**
+         * URL del gif
+         * @type {string|null}
+         */
+        this.url = response.data.url || null
+        
+        /**
+         * Anime del gif
+         * @type {string|null}
+         */
+        this.anime = response.data.anime || null
+    }
+
+    /**
+     * Obten la url del Gif
+     * @returns {string|null} URL
+     */
+    getUrl() {
+        return this.url; 
+    }
+
+    /**
+     * Obten el anime del Gif
+     * @returns {string|null} Anime
+     */
+    getAnime() {
+        return this.anime; 
+    }
+
+}
+
+module.exports = NekoGif