kira-arts 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,294 @@
+import { Client, AttachmentBuilder } from 'discord.js';
+import { Canvas, SKRSContext2D, Image } from '@napi-rs/canvas';
+
+type PresenceStatus = "online" | "idle" | "offline" | "dnd" | "invisible" | "streaming" | "phone";
+type BorderAlign = "horizontal" | "vertical";
+type ColorValue$1 = string | number;
+type ColorInput = ColorValue$1 | ColorValue$1[];
+type OutputFormat = "png" | "jpeg" | "webp";
+interface OutputOptions {
+    format?: OutputFormat;
+    quality?: number;
+}
+declare enum KiraErrorCode {
+    Validation = "VALIDATION",
+    Fetch = "FETCH",
+    AssetLoad = "ASSET_LOAD",
+    Render = "RENDER",
+    Config = "CONFIG"
+}
+
+type KiraThemeName = "discord" | "midnight" | "sunset" | "neon" | "forest" | "sakura" | "monochrome" | "gold";
+interface KiraThemePalette {
+    accentColor: string;
+    borderColor: string[];
+    usernameColor: string;
+    tagColor: string;
+    messageColor: string;
+    levelColor: string;
+    barColor: string[];
+    glowColor: string;
+    heartColor: string;
+}
+type KiraNameplatePalette = "berry" | "bubble_gum" | "clover" | "cobalt" | "crimson" | "forest" | "lemon" | "sky" | "teal" | "violet" | "white";
+
+interface KiraBadge {
+    name: string;
+    icon: string;
+}
+interface KiraNameplate {
+    imageURL: string;
+    palette: KiraNameplatePalette;
+}
+interface KiraServerTag {
+    text: string;
+    badgeURL: string | null;
+}
+interface KiraUserBasicInfo {
+    id: string;
+    username: string;
+    globalName: string | null;
+    discriminator: string | null;
+    bot: boolean;
+    verified: boolean;
+    createdTimestamp: number;
+}
+interface KiraUserAssets {
+    avatarURL: string | null;
+    defaultAvatarURL: string;
+    bannerURL: string | null;
+    badges: KiraBadge[];
+}
+interface KiraUserDecoration {
+    avatarFrame: string | null;
+    profileColors: string[] | null;
+    roleColor: string | null;
+    nameplate: KiraNameplate | null;
+    serverTag: KiraServerTag | null;
+}
+interface KiraUserData {
+    basicInfo: KiraUserBasicInfo;
+    assets: KiraUserAssets;
+    decoration: KiraUserDecoration;
+}
+
+interface RankOptions {
+    currentXp: number;
+    requiredXp: number;
+    level: number;
+    rank?: number;
+    barColor?: ColorInput;
+    levelColor?: string;
+    autoColorRank?: boolean;
+}
+interface MemberEventOptions {
+    message?: string;
+    memberCount?: number;
+    customBackground?: string;
+    borderColor?: ColorInput;
+    removeBorder?: boolean;
+    useNitroTheme?: boolean;
+    useRoleColor?: boolean;
+    accentColor?: string;
+    usernameColor?: string;
+    messageColor?: string;
+    showDate?: boolean;
+    date?: Date | string;
+    localDateType?: string;
+    guildId?: string;
+    bypassCache?: boolean;
+    fontScale?: number;
+    showAvatarDecoration?: boolean;
+    avatarBorderColor?: string;
+    showServerTag?: boolean;
+    showBadges?: boolean;
+    maxBadges?: number;
+    usernameEffect?: "shadow" | "glow";
+    messageEffect?: "shadow" | "glow";
+    glowColor?: string;
+    theme?: KiraThemeName;
+    output?: OutputOptions;
+}
+type AchievementRarity = "common" | "rare" | "epic" | "legendary";
+interface AchievementOptions {
+    description?: string;
+    iconUrl?: string;
+    rarity?: AchievementRarity;
+    accentColor?: string;
+    borderColor?: ColorInput;
+    removeBorder?: boolean;
+    useNitroTheme?: boolean;
+    useRoleColor?: boolean;
+    customBackground?: string;
+    progressText?: string;
+    showUsername?: boolean;
+    guildId?: string;
+    bypassCache?: boolean;
+    theme?: KiraThemeName;
+    output?: OutputOptions;
+}
+interface ShipOptions {
+    leftImage?: string;
+    rightImage?: string;
+    percentage?: number;
+    message?: string;
+    accentColor?: string;
+    borderColor?: ColorInput;
+    removeBorder?: boolean;
+    useNitroTheme?: boolean;
+    useRoleColor?: boolean;
+    customBackground?: string;
+    heartColor?: string;
+    shipName?: string;
+    showText?: boolean;
+    guildId?: string;
+    bypassCache?: boolean;
+    theme?: KiraThemeName;
+    output?: OutputOptions;
+}
+interface LevelUpOptions {
+    message?: string;
+    currentXp?: number;
+    requiredXp?: number;
+    customBackground?: string;
+    backgroundTint?: boolean;
+    borderColor?: ColorInput;
+    removeBorder?: boolean;
+    useNitroTheme?: boolean;
+    useRoleColor?: boolean;
+    accentColor?: string;
+    barColor?: ColorInput;
+    barBackgroundColor?: string;
+    levelColor?: string;
+    usernameColor?: string;
+    messageColor?: string;
+    kickerColor?: string;
+    xpColor?: string;
+    avatarBorderColor?: string;
+    showAvatarDecoration?: boolean;
+    showBadges?: boolean;
+    maxBadges?: number;
+    guildId?: string;
+    bypassCache?: boolean;
+    theme?: KiraThemeName;
+    output?: OutputOptions;
+}
+interface LeaderboardEntry {
+    userId: string;
+    currentXp: number;
+    requiredXp: number;
+    level: number;
+    rank?: number;
+}
+interface LeaderboardOptions {
+    title?: string;
+    subtitle?: string;
+    barColor?: ColorInput;
+    levelColor?: string;
+    usernameColor?: string;
+    accentColor?: string;
+    borderColor?: ColorInput;
+    removeBorder?: boolean;
+    useNitroTheme?: boolean;
+    useRoleColor?: boolean;
+    backgroundImage?: string;
+    guildId?: string;
+    bypassCache?: boolean;
+    maxEntries?: number;
+    theme?: KiraThemeName;
+    output?: OutputOptions;
+}
+interface ProfileOptions {
+    customUsername?: string;
+    customTag?: string;
+    compactTag?: boolean;
+    customSubtitle?: string;
+    color?: string;
+    useRoleColor?: boolean;
+    guildId?: string;
+    bypassCache?: boolean;
+    customBadges?: string[];
+    customBackground?: string;
+    overwriteBadges?: boolean;
+    usernameColor?: string;
+    tagColor?: string;
+    borderColor?: ColorInput;
+    borderAllign?: BorderAlign;
+    disableProfileTheme?: boolean;
+    disableBackgroundBlur?: boolean;
+    badgesFrame?: boolean;
+    removeBadges?: boolean;
+    removeBorder?: boolean;
+    presenceStatus?: PresenceStatus;
+    squareAvatar?: boolean;
+    moreBackgroundBlur?: boolean;
+    backgroundBrightness?: number;
+    customDate?: Date | string;
+    localDateType?: string;
+    removeAvatarFrame?: boolean;
+    removeNameplate?: boolean;
+    removeServerTag?: boolean;
+    rankData?: RankOptions;
+    theme?: KiraThemeName;
+    output?: OutputOptions;
+}
+
+declare function profileImage(userId: string, options?: ProfileOptions): Promise<Buffer>;
+
+declare function leaderboardImage(entries: LeaderboardEntry[], options?: LeaderboardOptions): Promise<Buffer>;
+
+declare function welcomeImage(userId: string, guildName: string, options?: MemberEventOptions): Promise<Buffer>;
+
+declare function leaveImage(userId: string, guildName: string, options?: MemberEventOptions): Promise<Buffer>;
+
+declare function levelUpImage(userId: string, level: number, options?: LevelUpOptions): Promise<Buffer>;
+
+declare function achievementImage(userId: string, title: string, options?: AchievementOptions): Promise<Buffer>;
+
+declare function shipImage(leftUserId: string, rightUserId: string, options?: ShipOptions): Promise<Buffer>;
+
+declare function computeCompatibility(leftId: string, rightId: string): number;
+declare function pickShipMessage(leftId: string, rightId: string, percentage: number): string;
+
+declare function setClient(client: Client): void;
+
+interface KiraCacheOptions {
+    enabled?: boolean;
+    ttl?: number;
+}
+declare function setCacheOptions(options: KiraCacheOptions): void;
+declare function clearCache(userId?: string, guildId?: string): void;
+declare function getCacheSize(): number;
+
+declare class KiraError extends Error {
+    readonly code: KiraErrorCode;
+    constructor(message?: string, code?: KiraErrorCode);
+}
+
+declare function toAttachment(buffer: Buffer, name?: string, format?: OutputFormat): AttachmentBuilder;
+
+declare function encodeCanvas(canvas: Canvas, output?: OutputOptions): Promise<Buffer>;
+declare function extensionForFormat(format?: OutputFormat): string;
+
+declare const THEMES: Record<KiraThemeName, KiraThemePalette>;
+declare function getThemePalette(theme?: KiraThemeName): KiraThemePalette | undefined;
+
+declare function parseImg(imgString: string): string;
+declare function parsePng(imgString: string): string;
+type ColorValue = string | number;
+declare function decimalToHex(decimal: number): string;
+declare function parseHex(input: ColorValue): string;
+declare function isString(param: unknown, type: string): string;
+declare function isNumber(param: unknown, type: string): number;
+
+declare function loadImageSafe(url: string | undefined, attempts?: number, timeoutMs?: number): Promise<Image | undefined>;
+declare function hexToRgb(hex: string): {
+    r: number;
+    g: number;
+    b: number;
+};
+declare function hexToRgba(hex: string, alpha: number): string;
+declare function drawGradientBorder(ctx: SKRSContext2D, width: number, height: number, colors: string[], cornerRadius: number, thickness?: number): void;
+declare function drawCoverImage(ctx: SKRSContext2D, image: Image, x: number, y: number, w: number, h: number): void;
+
+export { type AchievementOptions, type AchievementRarity, type BorderAlign, type ColorInput, type ColorValue$1 as ColorValue, type KiraBadge, type KiraCacheOptions, KiraError, KiraErrorCode, type KiraNameplate, type KiraNameplatePalette, type KiraServerTag, type KiraThemeName, type KiraThemePalette, type KiraUserData, type LeaderboardEntry, type LeaderboardOptions, type LevelUpOptions, type MemberEventOptions, type OutputFormat, type OutputOptions, type PresenceStatus, type ProfileOptions, type RankOptions, type ShipOptions, THEMES, achievementImage, clearCache, computeCompatibility, decimalToHex, drawCoverImage, drawGradientBorder, encodeCanvas, extensionForFormat, getCacheSize, getThemePalette, hexToRgb, hexToRgba, isNumber, isString, leaderboardImage, leaveImage, levelUpImage, loadImageSafe, parseHex, parseImg, parsePng, pickShipMessage, profileImage, setCacheOptions, setClient, shipImage, toAttachment, welcomeImage };

package/dist/index.d.ts

@@ -0,0 +1,294 @@
+import { Client, AttachmentBuilder } from 'discord.js';
+import { Canvas, SKRSContext2D, Image } from '@napi-rs/canvas';
+
+type PresenceStatus = "online" | "idle" | "offline" | "dnd" | "invisible" | "streaming" | "phone";
+type BorderAlign = "horizontal" | "vertical";
+type ColorValue$1 = string | number;
+type ColorInput = ColorValue$1 | ColorValue$1[];
+type OutputFormat = "png" | "jpeg" | "webp";
+interface OutputOptions {
+    format?: OutputFormat;
+    quality?: number;
+}
+declare enum KiraErrorCode {
+    Validation = "VALIDATION",
+    Fetch = "FETCH",
+    AssetLoad = "ASSET_LOAD",
+    Render = "RENDER",
+    Config = "CONFIG"
+}
+
+type KiraThemeName = "discord" | "midnight" | "sunset" | "neon" | "forest" | "sakura" | "monochrome" | "gold";
+interface KiraThemePalette {
+    accentColor: string;
+    borderColor: string[];
+    usernameColor: string;
+    tagColor: string;
+    messageColor: string;
+    levelColor: string;
+    barColor: string[];
+    glowColor: string;
+    heartColor: string;
+}
+type KiraNameplatePalette = "berry" | "bubble_gum" | "clover" | "cobalt" | "crimson" | "forest" | "lemon" | "sky" | "teal" | "violet" | "white";
+
+interface KiraBadge {
+    name: string;
+    icon: string;
+}
+interface KiraNameplate {
+    imageURL: string;
+    palette: KiraNameplatePalette;
+}
+interface KiraServerTag {
+    text: string;
+    badgeURL: string | null;
+}
+interface KiraUserBasicInfo {
+    id: string;
+    username: string;
+    globalName: string | null;
+    discriminator: string | null;
+    bot: boolean;
+    verified: boolean;
+    createdTimestamp: number;
+}
+interface KiraUserAssets {
+    avatarURL: string | null;
+    defaultAvatarURL: string;
+    bannerURL: string | null;
+    badges: KiraBadge[];
+}
+interface KiraUserDecoration {
+    avatarFrame: string | null;
+    profileColors: string[] | null;
+    roleColor: string | null;
+    nameplate: KiraNameplate | null;
+    serverTag: KiraServerTag | null;
+}
+interface KiraUserData {
+    basicInfo: KiraUserBasicInfo;
+    assets: KiraUserAssets;
+    decoration: KiraUserDecoration;
+}
+
+interface RankOptions {
+    currentXp: number;
+    requiredXp: number;
+    level: number;
+    rank?: number;
+    barColor?: ColorInput;
+    levelColor?: string;
+    autoColorRank?: boolean;
+}
+interface MemberEventOptions {
+    message?: string;
+    memberCount?: number;
+    customBackground?: string;
+    borderColor?: ColorInput;
+    removeBorder?: boolean;
+    useNitroTheme?: boolean;
+    useRoleColor?: boolean;
+    accentColor?: string;
+    usernameColor?: string;
+    messageColor?: string;
+    showDate?: boolean;
+    date?: Date | string;
+    localDateType?: string;
+    guildId?: string;
+    bypassCache?: boolean;
+    fontScale?: number;
+    showAvatarDecoration?: boolean;
+    avatarBorderColor?: string;
+    showServerTag?: boolean;
+    showBadges?: boolean;
+    maxBadges?: number;
+    usernameEffect?: "shadow" | "glow";
+    messageEffect?: "shadow" | "glow";
+    glowColor?: string;
+    theme?: KiraThemeName;
+    output?: OutputOptions;
+}
+type AchievementRarity = "common" | "rare" | "epic" | "legendary";
+interface AchievementOptions {
+    description?: string;
+    iconUrl?: string;
+    rarity?: AchievementRarity;
+    accentColor?: string;
+    borderColor?: ColorInput;
+    removeBorder?: boolean;
+    useNitroTheme?: boolean;
+    useRoleColor?: boolean;
+    customBackground?: string;
+    progressText?: string;
+    showUsername?: boolean;
+    guildId?: string;
+    bypassCache?: boolean;
+    theme?: KiraThemeName;
+    output?: OutputOptions;
+}
+interface ShipOptions {
+    leftImage?: string;
+    rightImage?: string;
+    percentage?: number;
+    message?: string;
+    accentColor?: string;
+    borderColor?: ColorInput;
+    removeBorder?: boolean;
+    useNitroTheme?: boolean;
+    useRoleColor?: boolean;
+    customBackground?: string;
+    heartColor?: string;
+    shipName?: string;
+    showText?: boolean;
+    guildId?: string;
+    bypassCache?: boolean;
+    theme?: KiraThemeName;
+    output?: OutputOptions;
+}
+interface LevelUpOptions {
+    message?: string;
+    currentXp?: number;
+    requiredXp?: number;
+    customBackground?: string;
+    backgroundTint?: boolean;
+    borderColor?: ColorInput;
+    removeBorder?: boolean;
+    useNitroTheme?: boolean;
+    useRoleColor?: boolean;
+    accentColor?: string;
+    barColor?: ColorInput;
+    barBackgroundColor?: string;
+    levelColor?: string;
+    usernameColor?: string;
+    messageColor?: string;
+    kickerColor?: string;
+    xpColor?: string;
+    avatarBorderColor?: string;
+    showAvatarDecoration?: boolean;
+    showBadges?: boolean;
+    maxBadges?: number;
+    guildId?: string;
+    bypassCache?: boolean;
+    theme?: KiraThemeName;
+    output?: OutputOptions;
+}
+interface LeaderboardEntry {
+    userId: string;
+    currentXp: number;
+    requiredXp: number;
+    level: number;
+    rank?: number;
+}
+interface LeaderboardOptions {
+    title?: string;
+    subtitle?: string;
+    barColor?: ColorInput;
+    levelColor?: string;
+    usernameColor?: string;
+    accentColor?: string;
+    borderColor?: ColorInput;
+    removeBorder?: boolean;
+    useNitroTheme?: boolean;
+    useRoleColor?: boolean;
+    backgroundImage?: string;
+    guildId?: string;
+    bypassCache?: boolean;
+    maxEntries?: number;
+    theme?: KiraThemeName;
+    output?: OutputOptions;
+}
+interface ProfileOptions {
+    customUsername?: string;
+    customTag?: string;
+    compactTag?: boolean;
+    customSubtitle?: string;
+    color?: string;
+    useRoleColor?: boolean;
+    guildId?: string;
+    bypassCache?: boolean;
+    customBadges?: string[];
+    customBackground?: string;
+    overwriteBadges?: boolean;
+    usernameColor?: string;
+    tagColor?: string;
+    borderColor?: ColorInput;
+    borderAllign?: BorderAlign;
+    disableProfileTheme?: boolean;
+    disableBackgroundBlur?: boolean;
+    badgesFrame?: boolean;
+    removeBadges?: boolean;
+    removeBorder?: boolean;
+    presenceStatus?: PresenceStatus;
+    squareAvatar?: boolean;
+    moreBackgroundBlur?: boolean;
+    backgroundBrightness?: number;
+    customDate?: Date | string;
+    localDateType?: string;
+    removeAvatarFrame?: boolean;
+    removeNameplate?: boolean;
+    removeServerTag?: boolean;
+    rankData?: RankOptions;
+    theme?: KiraThemeName;
+    output?: OutputOptions;
+}
+
+declare function profileImage(userId: string, options?: ProfileOptions): Promise<Buffer>;
+
+declare function leaderboardImage(entries: LeaderboardEntry[], options?: LeaderboardOptions): Promise<Buffer>;
+
+declare function welcomeImage(userId: string, guildName: string, options?: MemberEventOptions): Promise<Buffer>;
+
+declare function leaveImage(userId: string, guildName: string, options?: MemberEventOptions): Promise<Buffer>;
+
+declare function levelUpImage(userId: string, level: number, options?: LevelUpOptions): Promise<Buffer>;
+
+declare function achievementImage(userId: string, title: string, options?: AchievementOptions): Promise<Buffer>;
+
+declare function shipImage(leftUserId: string, rightUserId: string, options?: ShipOptions): Promise<Buffer>;
+
+declare function computeCompatibility(leftId: string, rightId: string): number;
+declare function pickShipMessage(leftId: string, rightId: string, percentage: number): string;
+
+declare function setClient(client: Client): void;
+
+interface KiraCacheOptions {
+    enabled?: boolean;
+    ttl?: number;
+}
+declare function setCacheOptions(options: KiraCacheOptions): void;
+declare function clearCache(userId?: string, guildId?: string): void;
+declare function getCacheSize(): number;
+
+declare class KiraError extends Error {
+    readonly code: KiraErrorCode;
+    constructor(message?: string, code?: KiraErrorCode);
+}
+
+declare function toAttachment(buffer: Buffer, name?: string, format?: OutputFormat): AttachmentBuilder;
+
+declare function encodeCanvas(canvas: Canvas, output?: OutputOptions): Promise<Buffer>;
+declare function extensionForFormat(format?: OutputFormat): string;
+
+declare const THEMES: Record<KiraThemeName, KiraThemePalette>;
+declare function getThemePalette(theme?: KiraThemeName): KiraThemePalette | undefined;
+
+declare function parseImg(imgString: string): string;
+declare function parsePng(imgString: string): string;
+type ColorValue = string | number;
+declare function decimalToHex(decimal: number): string;
+declare function parseHex(input: ColorValue): string;
+declare function isString(param: unknown, type: string): string;
+declare function isNumber(param: unknown, type: string): number;
+
+declare function loadImageSafe(url: string | undefined, attempts?: number, timeoutMs?: number): Promise<Image | undefined>;
+declare function hexToRgb(hex: string): {
+    r: number;
+    g: number;
+    b: number;
+};
+declare function hexToRgba(hex: string, alpha: number): string;
+declare function drawGradientBorder(ctx: SKRSContext2D, width: number, height: number, colors: string[], cornerRadius: number, thickness?: number): void;
+declare function drawCoverImage(ctx: SKRSContext2D, image: Image, x: number, y: number, w: number, h: number): void;
+
+export { type AchievementOptions, type AchievementRarity, type BorderAlign, type ColorInput, type ColorValue$1 as ColorValue, type KiraBadge, type KiraCacheOptions, KiraError, KiraErrorCode, type KiraNameplate, type KiraNameplatePalette, type KiraServerTag, type KiraThemeName, type KiraThemePalette, type KiraUserData, type LeaderboardEntry, type LeaderboardOptions, type LevelUpOptions, type MemberEventOptions, type OutputFormat, type OutputOptions, type PresenceStatus, type ProfileOptions, type RankOptions, type ShipOptions, THEMES, achievementImage, clearCache, computeCompatibility, decimalToHex, drawCoverImage, drawGradientBorder, encodeCanvas, extensionForFormat, getCacheSize, getThemePalette, hexToRgb, hexToRgba, isNumber, isString, leaderboardImage, leaveImage, levelUpImage, loadImageSafe, parseHex, parseImg, parsePng, pickShipMessage, profileImage, setCacheOptions, setClient, shipImage, toAttachment, welcomeImage };