@persian-caesar/hycom-api/dist/HyCom.js

A package for easy using hycom.ir api service.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.topAuthors = topAuthors;
exports.authorPosts = authorPosts;
exports.getTags = getTags;
exports.explore = explore;
exports.websiteInformation = websiteInformation;
exports.lastPosts = lastPosts;
exports.qrCode = qrCode;
const functions_1 = require("./functions");
const hycom = {
    url: "https://hycom.ir",
    topAuthor: "/api/top-authors",
    authorPosts: "/api/author-posts",
    tags: "/api/tags",
    explore: "/api/explore",
    siteInformation: "/api/site-info",
    lastPosts: "/api/last-posts",
    searchPosts: "/api/search-posts",
    qrCode: "/api/qr-code"
};
/**
 * Returns top authors sorted by total views.
 *
 * @param limit Number of authors to return. (1-50)
 */
async function topAuthors(limit = 10) {
    try {
        const response = await (0, functions_1.repeatAction)(async () => await fetch(hycom.url + hycom.topAuthor + `?limit=${limit}`));
        const data = await response.json();
        return data.data.map(a => {
            a.tag = a.display_name + "-" + a.profile_id;
            return a;
        });
    }
    catch {
        return null;
    }
}
/**
 * Returns published posts by a specific author.
 *
 * @param tag Author display name and profile ID. (format: name-code)
 * @param limit Number of authors to return. (1-50)
 * @param sort Sort order. (newest, most_viewed)
 */
async function authorPosts(tag, limit = 10, sort = "newest") {
    try {
        const response = await (0, functions_1.repeatAction)(async () => await fetch(hycom.url + hycom.authorPosts + `/${tag}?limit=${limit}&sort=${sort}`));
        const data = await response.json();
        return data.data;
    }
    catch {
        return null;
    }
}
/**
 * Returns tags with their post counts.
 *
 * @param limit Number of tags to return. (1-100)
 */
async function getTags(limit = 20) {
    try {
        const response = await (0, functions_1.repeatAction)(async () => await fetch(hycom.url + hycom.tags + `?limit=${limit}`));
        const data = await response.json();
        return data.data;
    }
    catch {
        return null;
    }
}
/**
 * Returns a paginated list of published articles with filtering and sorting.
 *
 * @param page Page number for pagination.
 * @param limit Number of posts per page. (1-50)
 * @param search Search query for title, tags, or author.
 * @param sort Sort order. (recommended, newest, most_viewed)
 * @param tag Filter by tag slug.
 */
async function explore(search = "", page = 1, limit = 12, sort = "newest", tag = "") {
    try {
        const response = await (0, functions_1.repeatAction)(async () => await fetch(hycom.url + hycom.explore + `?search=${search}&page=${page}&limit=${limit}&sort=${sort}&tag=${tag}`));
        const data = await response.json();
        return data.data.map(post => {
            post.author_tag = post.author_name_id;
            post.author_image = hycom.url + "/cdn" + post.author_image;
            post.image = hycom.url + post.image;
            post.tags = post.tags.map(a => a.name);
            return post;
        });
    }
    catch {
        return null;
    }
}
/**
 * Returns site statistics including last post, total views, total posts, and total authors.
 */
async function websiteInformation() {
    try {
        const now = Date.now();
        const response = await (0, functions_1.repeatAction)(async () => await fetch(hycom.url + hycom.siteInformation));
        const data = await response.json();
        const siteInfo = data.data;
        siteInfo.ping = Date.now() - now;
        siteInfo.last_post = (await lastPosts(1))[0];
        return siteInfo;
    }
    catch {
        return null;
    }
}
/**
 * Returns the most recent published posts.
 *
 * @param limit Number of posts to return. (1-50)
 */
async function lastPosts(limit = 10) {
    try {
        return await explore(undefined, 1, limit, "newest");
    }
    catch {
        return null;
    }
}
/**
 * Generates a QR code for the provided URL.
 *
 * @param url URL to encode in QR code.
 */
async function qrCode(url) {
    try {
        const response = await fetch(hycom.url + hycom.qrCode + `?url=${url}`);
        const data = await response.json();
        return Buffer.from(data.data.qr_code
            .replace(/^data:image\/png;base64,/, ''), "base64");
    }
    catch {
        return null;
    }
}
/**
 * @copyright
 * Code by Sobhan-SRZA (mr.sinre) | https://github.com/Sobhan-SRZA
 * Developed for Persian Caesar | https://github.com/Persian-Caesar | https://dsc.gg/persian-caesar
 *
 * If you encounter any issues or need assistance with this code,
 * please make sure to credit "Persian Caesar" in your documentation or communications.
 */ 
//# sourceMappingURL=HyCom.js.map