pixel-forge
Version:
A comprehensive generator for social media previews, favicons, and visual assets across all platforms
70 lines (69 loc) • 1.85 kB
TypeScript
import type { PixelForgeConfig } from '../../core/config-validator';
export interface WebSEOOptions {
title?: string;
description?: string;
template?: 'basic' | 'gradient' | 'custom';
includeOpenGraph?: boolean;
includeTwitter?: boolean;
includeGeneric?: boolean;
outputFormat?: 'png' | 'jpeg' | 'both';
}
export declare class WebSEOGenerator {
private config;
private sourceImage;
constructor(sourceImage: string, config: PixelForgeConfig);
/**
* Generate essential SEO images for web applications
*/
generate(options?: WebSEOOptions): Promise<void>;
/**
* Generate generic og-image that works across all platforms
*/
private generateGenericOpenGraph;
/**
* Generate OpenGraph-specific image
*/
private generateOpenGraphImage;
/**
* Generate Twitter card image
*/
private generateTwitterCardImage;
/**
* Get HTML meta tags for SEO images
*/
getMetaTags(options?: {
format?: 'png' | 'jpeg';
}): string[];
/**
* Get Next.js metadata configuration
*/
getNextMetadata(options?: {
format?: 'png' | 'jpeg';
}): {
title: string;
description: string | undefined;
openGraph: {
title: string;
description: string | undefined;
type: string;
images: {
url: string;
width: number;
height: number;
alt: string;
}[];
};
twitter: {
card: string;
title: string;
description: string | undefined;
images: string[];
};
};
/**
* Get list of generated files
*/
getGeneratedFiles(options?: {
format?: 'png' | 'jpeg' | 'both';
}): string[];
}