@heavstaltech/api 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 HEAVSTAL TECH™
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,195 @@
+# @heavstaltech/api
+
+![NPM Version](https://img.shields.io/npm/v/@heavstaltech/api?style=flat-square)
+![Build Status](https://img.shields.io/github/actions/workflow/status/HeavstalTech/heavstaltech-api/test.yml?style=flat-square&label=tests)
+![License](https://img.shields.io/npm/l/@heavstaltech/api?style=flat-square)
+
+A powerful, all-in-one scraping and utility library built by **HEAVSTAL TECH**. 
+This module provides easy access to media downloaders (TikTok, YouTube, Instagram, Facebook), search engines, and AI tools.
+
+It is designed to work seamlessly in both **CommonJS (`require`)** and **ES Modules (`import`)** environments.
+
+---
+
+## 🌐 Heavstal Tech Ecosystem
+
+This package is part of the **Heavstal Tech** ecosystem. 
+
+**Explore More APIs:**  
+Visit our official API Hub to discover more tools, endpoints, and detailed documentation:  
+👉 **[https://heavstal-tech.vercel.app/apis](https://heavstal-tech.vercel.app/apis)**
+
+---
+
+## 📦 Installation
+
+Install via npm:
+
+```bash
+npm install @heavstaltech/api
+```
+
+---
+
+## 🚀 Usage (ESM vs CJS)
+
+This library is a **hybrid module**. You can use it in legacy Node.js projects or modern TypeScript/ESM projects without any configuration.
+
+### CommonJS (`require`)
+```javascript
+const { downloader, search, tools } = require('@heavstaltech/api');
+
+// or require specific functions
+const { tiktok } = require('@heavstaltech/api');
+```
+
+### ES Modules / TypeScript (`import`)
+```typescript
+import { downloader, search, tools } from '@heavstaltech/api';
+
+// or import specific functions
+import { tiktok, remini } from '@heavstaltech/api';
+```
+
+---
+
+## 📚 API Documentation
+
+### 1. Social Media Downloaders
+
+#### TikTok (Video & Slides)
+Supports downloading videos without watermarks, searching for videos, and fetching slide images.
+
+```javascript
+// 1. Search or Download via URL
+const result = await downloader.tiktok("https://vt.tiktok.com/ZS..."); 
+// OR search: await downloader.tiktok("funny cat videos");
+
+console.log(result);
+/* Output:
+{
+  author: { name: 'HEAVSTAL TECH', ... },
+  status: true,
+  title: 'Video Title',
+  no_watermark: 'https://...',
+  audio: 'https://...'
+}
+*/
+
+// 2. TikTok Slides
+const slide = await downloader.tiktokSlide("https://vt.tiktok.com/ZS...");
+console.log(slide);
+```
+
+#### Instagram (Reels, Images, Videos)
+Downloads content from Instagram public posts.
+
+```javascript
+const ig = await downloader.igdl("https://www.instagram.com/p/Cp...");
+
+ig.forEach(media => {
+  console.log(`Type: ${media.type} | URL: ${media.url}`);
+});
+```
+
+#### Facebook (Watch & Public Videos)
+Downloads public Facebook videos in SD or HD.
+
+```javascript
+const fb = await downloader.fbdl("https://fb.watch/...");
+console.log(fb);
+```
+
+---
+
+### 2. YouTube (Search & Download)
+
+**Note:** Powered by `@distube/ytdl-core` and `yt-search`.
+
+#### Search
+```javascript
+const results = await search.youtube("No Copyright Sounds");
+console.log(results[0]); // Returns video details
+```
+
+#### Download Audio (MP3)
+```javascript
+const audio = await downloader.ytmp3("https://youtu.be/...");
+console.log(audio.url); // Direct download link
+```
+
+#### Download Video (MP4)
+```javascript
+const video = await downloader.ytmp4("https://youtu.be/...");
+console.log(video.url); // Direct download link
+```
+
+#### Play (Search & Auto-Download)
+Searches for a query and immediately returns the download link for the first result.
+```javascript
+// Get Audio
+const song = await downloader.play("Adele Hello", "mp3");
+
+// Get Video
+const vid = await downloader.play("Adele Hello", "mp4");
+```
+
+---
+
+### 3. Search & Lyrics
+
+#### Guitar Chords & Lyrics
+Fetches chords and lyrics from Gitagram.
+```javascript
+const song = await search.chords("Ed Sheeran Perfect");
+console.log(song.chord);
+```
+
+#### Wattpad
+Search for stories on Wattpad.
+```javascript
+const stories = await search.wattpad("Werewolf");
+console.log(stories);
+```
+
+---
+
+### 4. Utilities & AI Tools
+
+#### Remini (AI Image Enhancer)
+Enhances low-quality images using AI. Returns a `Buffer`.
+```javascript
+const fs = require('fs');
+
+// Methods: 'enhance', 'recolor', 'dehaze'
+const buffer = await tools.remini("https://example.com/blurry.jpg", "enhance");
+
+fs.writeFileSync("enhanced.jpg", buffer);
+```
+
+#### Screenshot Website
+Takes a screenshot of any URL.
+```javascript
+const buffer = await tools.ssweb("https://google.com", "desktop");
+// options: 'desktop', 'tablet', 'phone'
+```
+
+#### Stylish Text
+Converts normal text into fancy fonts.
+```javascript
+const fonts = await tools.styleText("Heavstal Tech");
+console.log(fonts);
+```
+
+---
+
+## 📝 License
+
+This project is licensed under the **MIT License**.
+
+---
+
+<div align="center">
+  <p>Maintained by <a href="https://heavstal-tech.vercel.app">HEAVSTAL TECH</a></p>
+  <p><i>Building Tomorrow's Web, Today.</i></p>
+</div>

package/dist/index.d.mts

@@ -0,0 +1,157 @@
+interface Author {
+    name: string;
+    source: string;
+}
+declare const AUTHOR: Author;
+interface TikTokResult {
+    author: Author;
+    status: boolean;
+    title: string;
+    cover?: string;
+    origin_cover?: string;
+    no_watermark?: string;
+    watermark?: string;
+    music?: string;
+    views?: number | string;
+    likes?: number | string;
+    comments?: number | string;
+    shares?: number | string;
+    downloads?: number | string;
+    uniqueId?: string;
+    profileUrl?: string;
+    profileImage?: string;
+    hashtags?: string[];
+    slideImages?: string[];
+    author_name?: string;
+}
+interface SocialResult {
+    author: Author;
+    status: boolean;
+    type: 'video' | 'image';
+    title?: string;
+    thumbnail?: string;
+    url: string;
+}
+interface YouTubeResult {
+    author: Author;
+    title: string;
+    thumbnail: string;
+    channel: string;
+    published: string;
+    views: string;
+    url: string;
+    duration?: number | string;
+    status?: boolean;
+}
+interface YouTubeSearchResult {
+    type: 'video' | 'channel' | 'list' | 'live';
+    url: string;
+    title: string;
+    description?: string;
+    image?: string;
+    thumbnail?: string;
+    seconds?: number;
+    timestamp?: string;
+    views?: number;
+    ago?: string;
+    author?: {
+        name: string;
+        url: string;
+    };
+}
+interface UtilsResult {
+    author: Author;
+    status: boolean;
+    data: Buffer | string | any;
+}
+
+/**
+ * Main TikTok Function
+ * Supports: URL Download & Search Query
+ */
+declare const tiktok: (input: string) => Promise<TikTokResult>;
+/**
+ * TikTok Slide Downloader
+ */
+declare const tiktokSlide: (url: string) => Promise<TikTokResult>;
+
+/**
+ * Facebook Video Downloader
+ * Source: getmyfb.com
+ */
+declare const fbdl: (url: string) => Promise<SocialResult[]>;
+/**
+ * Instagram Downloader
+ * Source: indown.io
+ */
+declare const igdl: (url: string) => Promise<SocialResult[]>;
+
+declare const search$1: (query: string) => Promise<YouTubeSearchResult[]>;
+declare const ytmp3: (url: string) => Promise<YouTubeResult>;
+declare const ytmp4: (url: string) => Promise<YouTubeResult>;
+/**
+ * YouTube Play (Search & Download)
+ * Searches for a query, grabs the first result, and returns the download link
+ */
+declare const play: (query: string, type?: "mp3" | "mp4") => Promise<YouTubeResult>;
+
+declare const ssweb: (url: string, device?: "desktop" | "tablet" | "phone") => Promise<Buffer>;
+declare const remini: (imageUrl: string, method?: "enhance" | "recolor" | "dehaze") => Promise<Buffer>;
+declare const styleText: (text: string) => Promise<{
+    author: Author;
+    name: string;
+    result: string;
+}[]>;
+declare const wattpad: (query: string) => Promise<any[]>;
+declare const chords: (query: string) => Promise<any>;
+
+declare const downloader: {
+    tiktok: (input: string) => Promise<TikTokResult>;
+    tiktokSlide: (url: string) => Promise<TikTokResult>;
+    igdl: (url: string) => Promise<SocialResult[]>;
+    fbdl: (url: string) => Promise<SocialResult[]>;
+    ytmp3: (url: string) => Promise<YouTubeResult>;
+    ytmp4: (url: string) => Promise<YouTubeResult>;
+    play: (query: string, type?: "mp3" | "mp4") => Promise<YouTubeResult>;
+};
+declare const search: {
+    youtube: (query: string) => Promise<YouTubeSearchResult[]>;
+    wattpad: (query: string) => Promise<any[]>;
+    chords: (query: string) => Promise<any>;
+};
+declare const tools: {
+    ssweb: (url: string, device?: "desktop" | "tablet" | "phone") => Promise<Buffer>;
+    remini: (imageUrl: string, method?: "enhance" | "recolor" | "dehaze") => Promise<Buffer>;
+    styleText: (text: string) => Promise<{
+        author: Author;
+        name: string;
+        result: string;
+    }[]>;
+};
+declare const _default: {
+    downloader: {
+        tiktok: (input: string) => Promise<TikTokResult>;
+        tiktokSlide: (url: string) => Promise<TikTokResult>;
+        igdl: (url: string) => Promise<SocialResult[]>;
+        fbdl: (url: string) => Promise<SocialResult[]>;
+        ytmp3: (url: string) => Promise<YouTubeResult>;
+        ytmp4: (url: string) => Promise<YouTubeResult>;
+        play: (query: string, type?: "mp3" | "mp4") => Promise<YouTubeResult>;
+    };
+    search: {
+        youtube: (query: string) => Promise<YouTubeSearchResult[]>;
+        wattpad: (query: string) => Promise<any[]>;
+        chords: (query: string) => Promise<any>;
+    };
+    tools: {
+        ssweb: (url: string, device?: "desktop" | "tablet" | "phone") => Promise<Buffer>;
+        remini: (imageUrl: string, method?: "enhance" | "recolor" | "dehaze") => Promise<Buffer>;
+        styleText: (text: string) => Promise<{
+            author: Author;
+            name: string;
+            result: string;
+        }[]>;
+    };
+};
+
+export { AUTHOR, type Author, type SocialResult, type TikTokResult, type UtilsResult, type YouTubeResult, type YouTubeSearchResult, chords, _default as default, downloader, fbdl, igdl, play, remini, search, ssweb, styleText, tiktok, tiktokSlide, tools, wattpad, search$1 as ytSearch, ytmp3, ytmp4 };

package/dist/index.d.ts

@@ -0,0 +1,157 @@
+interface Author {
+    name: string;
+    source: string;
+}
+declare const AUTHOR: Author;
+interface TikTokResult {
+    author: Author;
+    status: boolean;
+    title: string;
+    cover?: string;
+    origin_cover?: string;
+    no_watermark?: string;
+    watermark?: string;
+    music?: string;
+    views?: number | string;
+    likes?: number | string;
+    comments?: number | string;
+    shares?: number | string;
+    downloads?: number | string;
+    uniqueId?: string;
+    profileUrl?: string;
+    profileImage?: string;
+    hashtags?: string[];
+    slideImages?: string[];
+    author_name?: string;
+}
+interface SocialResult {
+    author: Author;
+    status: boolean;
+    type: 'video' | 'image';
+    title?: string;
+    thumbnail?: string;
+    url: string;
+}
+interface YouTubeResult {
+    author: Author;
+    title: string;
+    thumbnail: string;
+    channel: string;
+    published: string;
+    views: string;
+    url: string;
+    duration?: number | string;
+    status?: boolean;
+}
+interface YouTubeSearchResult {
+    type: 'video' | 'channel' | 'list' | 'live';
+    url: string;
+    title: string;
+    description?: string;
+    image?: string;
+    thumbnail?: string;
+    seconds?: number;
+    timestamp?: string;
+    views?: number;
+    ago?: string;
+    author?: {
+        name: string;
+        url: string;
+    };
+}
+interface UtilsResult {
+    author: Author;
+    status: boolean;
+    data: Buffer | string | any;
+}
+
+/**
+ * Main TikTok Function
+ * Supports: URL Download & Search Query
+ */
+declare const tiktok: (input: string) => Promise<TikTokResult>;
+/**
+ * TikTok Slide Downloader
+ */
+declare const tiktokSlide: (url: string) => Promise<TikTokResult>;
+
+/**
+ * Facebook Video Downloader
+ * Source: getmyfb.com
+ */
+declare const fbdl: (url: string) => Promise<SocialResult[]>;
+/**
+ * Instagram Downloader
+ * Source: indown.io
+ */
+declare const igdl: (url: string) => Promise<SocialResult[]>;
+
+declare const search$1: (query: string) => Promise<YouTubeSearchResult[]>;
+declare const ytmp3: (url: string) => Promise<YouTubeResult>;
+declare const ytmp4: (url: string) => Promise<YouTubeResult>;
+/**
+ * YouTube Play (Search & Download)
+ * Searches for a query, grabs the first result, and returns the download link
+ */
+declare const play: (query: string, type?: "mp3" | "mp4") => Promise<YouTubeResult>;
+
+declare const ssweb: (url: string, device?: "desktop" | "tablet" | "phone") => Promise<Buffer>;
+declare const remini: (imageUrl: string, method?: "enhance" | "recolor" | "dehaze") => Promise<Buffer>;
+declare const styleText: (text: string) => Promise<{
+    author: Author;
+    name: string;
+    result: string;
+}[]>;
+declare const wattpad: (query: string) => Promise<any[]>;
+declare const chords: (query: string) => Promise<any>;
+
+declare const downloader: {
+    tiktok: (input: string) => Promise<TikTokResult>;
+    tiktokSlide: (url: string) => Promise<TikTokResult>;
+    igdl: (url: string) => Promise<SocialResult[]>;
+    fbdl: (url: string) => Promise<SocialResult[]>;
+    ytmp3: (url: string) => Promise<YouTubeResult>;
+    ytmp4: (url: string) => Promise<YouTubeResult>;
+    play: (query: string, type?: "mp3" | "mp4") => Promise<YouTubeResult>;
+};
+declare const search: {
+    youtube: (query: string) => Promise<YouTubeSearchResult[]>;
+    wattpad: (query: string) => Promise<any[]>;
+    chords: (query: string) => Promise<any>;
+};
+declare const tools: {
+    ssweb: (url: string, device?: "desktop" | "tablet" | "phone") => Promise<Buffer>;
+    remini: (imageUrl: string, method?: "enhance" | "recolor" | "dehaze") => Promise<Buffer>;
+    styleText: (text: string) => Promise<{
+        author: Author;
+        name: string;
+        result: string;
+    }[]>;
+};
+declare const _default: {
+    downloader: {
+        tiktok: (input: string) => Promise<TikTokResult>;
+        tiktokSlide: (url: string) => Promise<TikTokResult>;
+        igdl: (url: string) => Promise<SocialResult[]>;
+        fbdl: (url: string) => Promise<SocialResult[]>;
+        ytmp3: (url: string) => Promise<YouTubeResult>;
+        ytmp4: (url: string) => Promise<YouTubeResult>;
+        play: (query: string, type?: "mp3" | "mp4") => Promise<YouTubeResult>;
+    };
+    search: {
+        youtube: (query: string) => Promise<YouTubeSearchResult[]>;
+        wattpad: (query: string) => Promise<any[]>;
+        chords: (query: string) => Promise<any>;
+    };
+    tools: {
+        ssweb: (url: string, device?: "desktop" | "tablet" | "phone") => Promise<Buffer>;
+        remini: (imageUrl: string, method?: "enhance" | "recolor" | "dehaze") => Promise<Buffer>;
+        styleText: (text: string) => Promise<{
+            author: Author;
+            name: string;
+            result: string;
+        }[]>;
+    };
+};
+
+export { AUTHOR, type Author, type SocialResult, type TikTokResult, type UtilsResult, type YouTubeResult, type YouTubeSearchResult, chords, _default as default, downloader, fbdl, igdl, play, remini, search, ssweb, styleText, tiktok, tiktokSlide, tools, wattpad, search$1 as ytSearch, ytmp3, ytmp4 };