devworldbr-api 1.0.0 → 1.0.2

package/README.md

@@ -1,8 +1,287 @@
-# devworldbr-api 🚀
+<div align="center">devworldbr-api
 
-SDK Oficial Node.js para integrar os serviços e ferramentas da **DevWorld BR APIs** na sua aplicação ou Bot de WhatsApp/Telegram.
+SDK oficial para integração com as APIs da Dev World BR.
 
-## 📦 Instalação
+Acesse, de forma simples, os recursos de downloads, mídias, ferramentas e serviços disponibilizados pela plataforma.
+
+<p>
+  <a href="https://www.npmjs.com/package/devworldbr-api">
+    <img src="https://img.shields.io/npm/v/devworldbr-api.svg?style=flat-square" alt="NPM Version">
+  </a>
+  <a href="https://www.npmjs.com/package/devworldbr-api">
+    <img src="https://img.shields.io/npm/dm/devworldbr-api.svg?style=flat-square" alt="NPM Downloads">
+  </a>
+  <a href="https://api.devworldbr.site">
+    <img src="https://img.shields.io/badge/DevWorld%20BR-API-005955?style=flat-square" alt="DevWorld BR">
+  </a>
+</p></div>---
+
+Sobre
+
+O "devworldbr-api" é o SDK oficial da Dev World BR, criado para facilitar o consumo dos endpoints da plataforma diretamente em projetos Node.js.
+
+Com ele, você pode utilizar recursos de download, pesquisa, ferramentas e outros serviços através de métodos simples.
+
+---
+
+Requisitos
+
+- Node.js
+- Uma conta na Dev World BR
+- Uma "apiKey" válida
+
+Obtendo sua API Key
+
+1. Acesse o site oficial: https://api.devworldbr.site
+2. Crie sua conta.
+3. Ative uma chave API através de um dos planos disponíveis.
+4. Copie sua "apiKey" pelo painel.
+
+---
+
+Instalação
+
+Instale o pacote utilizando o npm:
 
-```bash
 npm install devworldbr-api
+
+---
+
+Inicialização
+
+CommonJS
+
+const DevWorldBR = require('devworldbr-api');
+
+const api = new DevWorldBR({
+  apiKey: 'SUA_API_KEY_AQUI'
+});
+
+ESM
+
+import DevWorldBR from 'devworldbr-api';
+
+const api = new DevWorldBR({
+  apiKey: 'SUA_API_KEY_AQUI'
+});
+
+---
+
+Downloads e mídias
+
+Todos os métodos abaixo são chamados diretamente através da instância "api".
+
+YouTube — Play Vídeo
+
+Retorna o conteúdo do vídeo em "Buffer".
+
+const video = await api.playVideo('música de exemplo');
+
+console.log(video);
+
+«"playVideo()" é o método destinado ao retorno direto do arquivo em Buffer.»
+
+YouTube — Play Áudio
+
+const audio = await api.playAudio('música de exemplo');
+
+console.log(audio);
+
+YouTube — Download por link
+
+const result = await api.ytdl(
+  'https://youtube.com/watch?v=xxx'
+);
+
+console.log(result);
+
+TikTok — Vídeo
+
+const result = await api.ttkdl(
+  'https://vm.tiktok.com/xxx'
+);
+
+console.log(result);
+
+TikTok — Imagens / Slides
+
+const result = await api.ttkimg(
+  'https://vm.tiktok.com/xxx'
+);
+
+console.log(result);
+
+Kwai
+
+const result = await api.kwaidl(
+  'https://kwai-video.com/p/xxx'
+);
+
+console.log(result);
+
+Pinterest
+
+Aceita termo de pesquisa ou link, dependendo do método utilizado pela API.
+
+const result = await api.pinterest('anime aesthetic');
+
+console.log(result);
+
+Spotify
+
+const result = await api.spotify(
+  'https://open.spotify.com/track/xxx'
+);
+
+console.log(result);
+
+Instagram
+
+Suporte para conteúdos como Reels e Posts.
+
+const result = await api.igdl(
+  'https://www.instagram.com/p/xxx'
+);
+
+console.log(result);
+
+Facebook
+
+const result = await api.FacebookDL(
+  'https://www.facebook.com/watch/?v=xxx'
+);
+
+console.log(result);
+
+SoundCloud
+
+const result = await api.SoundCloudDL(
+  'https://soundcloud.com/user/track'
+);
+
+console.log(result);
+
+MediaFire
+
+const result = await api.mediafireDL(
+  'https://www.mediafire.com/file/xxx'
+);
+
+console.log(result);
+
+---
+
+Ferramentas
+
+Shazam
+
+Utilize o método para identificar músicas a partir de uma URL de áudio.
+
+const result = await api.shazam(
+  'https://meusite.com/audio.mp3'
+);
+
+console.log(result);
+
+---
+
+Retornos
+
+Por padrão, os métodos da SDK retornam os dados fornecidos pela API em formato JSON.
+
+A exceção é o método:
+
+api.playVideo()
+
+que retorna o conteúdo do vídeo diretamente em Buffer.
+
+Exemplo:
+
+const video = await api.playVideo('música de exemplo');
+
+console.log(Buffer.isBuffer(video));
+// true
+
+---
+
+Exemplo completo
+
+Um exemplo simples utilizando a SDK:
+
+const DevWorldBR = require('devworldbr-api');
+
+const api = new DevWorldBR({
+  apiKey: 'SUA_API_KEY_AQUI'
+});
+
+async function main() {
+  try {
+    const result = await api.spotify(
+      'https://open.spotify.com/track/xxx'
+    );
+
+    console.log(result);
+  } catch (error) {
+    console.error('Erro ao realizar a requisição:', error);
+  }
+}
+
+main();
+
+---
+
+Plataformas disponíveis
+
+Plataforma| Recurso
+YouTube| Vídeo, áudio e download por link
+TikTok| Vídeos e imagens/slides
+Kwai| Download de vídeos
+Pinterest| Pesquisa e mídias
+Spotify| Download de faixas
+Instagram| Reels e Posts
+Facebook| Download de vídeos
+SoundCloud| Download de áudios
+MediaFire| Extração de arquivos
+Shazam| Reconhecimento musical
+
+---
+
+Métodos disponíveis
+
+playVideo()
+playAudio()
+ytdl()
+ttkdl()
+ttkimg()
+kwaidl()
+pinterest()
+spotify()
+igdl()
+FacebookDL()
+SoundCloudDL()
+mediafireDL()
+shazam()
+
+Os métodos podem receber parâmetros diferentes de acordo com o recurso utilizado.
+
+---
+
+Links
+
+API:
+https://api.devworldbr.site
+
+NPM:
+https://www.npmjs.com/package/devworldbr-api
+
+---
+
+<div align="center">DevWorld BR
+
+SDK oficial para integração com a API da Dev World BR.
+
+Desenvolvido por DevWorld BR
+
+https://api.devworldbr.site
+
+</div>

package/index.js

@@ -1,11 +1,9 @@
-const fs = require('fs');
-const path = require('path');
 const axios = require('axios');
-const config = JSON.parse(fs.readFileSync('./config/config.json', 'utf-8'));
+const { config } = require('./package.json');
 
 class DevWorldBR {
   constructor(options = {}) {
-    this.baseURL = config.baseURL || 'https://api.devworldbr.site';
+    this.baseURL = config.baseURL || options.baseURL || 'https://api.devworldbr.site';
     this.apiKey = options.apiKey;
 
     if (!this.apiKey) {
@@ -30,16 +28,74 @@ class DevWorldBR {
     }
   }
   
+  // Downloads & Mídia
   async playVideo(query) {
     if (!query) throw new Error('O parâmetro "query" é obrigatório.');
     return await this._get('/api/downloads/youtube/play/video/v1', { query }, 'arraybuffer');
   }
+  
+  async playAudio(query) {
+    if (!query) throw new Error('O parâmetro "query" é obrigatório.');
+    return await this._get('/api/downloads/youtube/play/audio/v1', { query });
+  }
+ 
+  async ytdl(link) {
+    if (!link) throw new Error('O parâmetro "link" é obrigatório.');
+    return await this._get('/api/downloads/youtube/dl/v1', { link });
+  }
+ 
+  async ttkdl(link) {
+    if (!link) throw new Error('O parâmetro "link" é obrigatório.');
+    return await this._get('/api/downloads/tiktok/dl/v1', { link });
+  }
+ 
+  async ttkimg(link) {
+    if (!link) throw new Error('O parâmetro "link" é obrigatório.');
+    return await this._get('/api/downloads/tiktok/imagens/v1', { link });
+  }
+ 
+  async kwaidl(link) {
+    if (!link) throw new Error('O parâmetro "link" é obrigatório.');
+    return await this._get('/api/downloads/kwai/dl/v1', { link });
+  }
+ 
+  async pinterest(query) {
+    if (!query) throw new Error('Informe um termo de busca ou URL do Pinterest.');
+    return await this._get('/api/downloads/pinterest/dl/v1', { query_ou_url: query });
+  }
 
+  async spotify(link) {
+    if (!link) throw new Error('O parâmetro "link" é obrigatório.');
+    return await this._get('/api/downloads/spotify/dl/v1', { link });
+  }
+   
+  async igdl(link) {
+    if (!link) throw new Error('O parâmetro "link" é obrigatório.');
+    return await this._get('/api/downloads/instagran/dl/v1', { link });
+  }
+   
+  async SoundCloudDL(link) {
+    if (!link) throw new Error('O parâmetro "link" é obrigatório.');
+    return await this._get('/api/downloads/soundcloud/dl/v1', { link });
+  }
+   
+  async mediafireDL(link) {
+    if (!link) throw new Error('O parâmetro "link" é obrigatório.');
+    return await this._get('/api/downloads/mediafire/dl/v1', { link });
+  }
+   
+  async FacebookDL(link) {
+    if (!link) throw new Error('O parâmetro "link" é obrigatório.');
+    return await this._get('/api/downloads/facebook/dl/v1', { link });
+  }
+
+  // Ferramentas & IA
   async shazam(audioUrl) {
+    if (!audioUrl) throw new Error('O parâmetro "audioUrl" é obrigatório.');
     return await this._get('/api/ferramentas/shazam/v1', { url: audioUrl });
   }
-  
 }
 
 module.exports = DevWorldBR;
-export default DevWorldBR;
+module.exports.default = DevWorldBR;
+module.exports.DevWorldBR = DevWorldBR;

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "devworldbr-api",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "SDK oficial para consumo rápido das APIs DevWorld BR",
   "main": "index.js",
+  "config": {
+  "baseURL": "https://api.devworldbr.site"
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },

package/config/config.json

@@ -1,6 +0,0 @@
-{
-"author": "Dev World BR API's",
-"criador": "Jpzinh #dwbr"
-"whatsapp": "https://wa.me/559391423261",
-"baseURL": "https://api.devworldbr.site"
-}