textmode.js 0.3.2-beta.3 → 0.4.0

package/dist/types/export/base/DataExtractor.d.ts

@@ -1,34 +0,0 @@
-import type { GLFramebuffer } from '../../rendering';
-import type { FramebufferData } from '../svg/types';
-/**
- * Base class for data extraction from textmode framebuffers.
- * Provides common functionality shared between different export formats.
- */
-export declare abstract class DataExtractor {
-    /**
-     * Extracts pixel data from all framebuffers needed for export
-     * @param framebuffer The conversion pipeline containing framebuffers
-     * @returns Object containing all pixel data arrays
-     */
-    $extractFramebufferData(framebuffer: GLFramebuffer): FramebufferData;
-    /**
-     * Gets character index from character framebuffer pixels
-     * @param characterPixels Character framebuffer pixel data
-     * @param pixelIndex Index in the pixel array (already multiplied by 4 for RGBA)
-     * @param charactersLength Total number of available characters
-     * @returns Character index
-     */
-    protected _getCharacterIndex(characterPixels: Uint8Array, pixelIndex: number): number;
-    /**
-     * Converts raw pixel data to RGBA color object
-     * @param pixels Pixel data array
-     * @param index Pixel index (already multiplied by 4 for RGBA)
-     * @returns RGBA color object with r, g, b, a properties
-     */
-    protected _pixelsToRGBA(pixels: Uint8Array, index: number): {
-        r: number;
-        g: number;
-        b: number;
-        a: number;
-    };
-}

package/dist/types/export/base/FileHandler.d.ts

@@ -1,46 +0,0 @@
-/**
- * Base class for file handling operations.
- * Provides common functionality for downloading files in the browser.
- */
-export declare abstract class FileHandler {
-    /**
-     * Creates a downloadable blob from content
-     * @param content The content to include in the blob
-     * @param mimeType The MIME type for the blob
-     * @returns Blob object containing the content
-     */
-    protected _createBlob(content: string, mimeType: string): Blob;
-    /**
-     * Downloads content as a file
-     * @param content The content to download
-     * @param filename The filename (with extension)
-     * @param mimeType The MIME type for the content
-     */
-    protected _downloadFile(content: string, filename: string, mimeType: string): void;
-    /**
-     * Generates a timestamp string for filenames
-     * @returns Formatted timestamp string
-     */
-    protected _generateTimestamp(): string;
-    /**
-     * Generates a date-time string for filenames (alternative format)
-     * @returns Formatted date and time string
-     */
-    protected _generateDateTimeString(): {
-        date: string;
-        time: string;
-    };
-    /**
-     * Validates and sanitizes filename for safety and compatibility
-     * @param filename The filename to validate
-     * @returns Sanitized filename
-     */
-    protected _sanitizeFilename(filename: string): string;
-    /**
-     * Generates a default filename with prefix and timestamp
-     * @param prefix The prefix for the filename
-     * @param extension The file extension (with dot)
-     * @returns Generated filename
-     */
-    $generateDefaultFilename(): string;
-}

package/dist/types/export/base/index.d.ts

@@ -1,2 +0,0 @@
-export { DataExtractor } from './DataExtractor';
-export { FileHandler } from './FileHandler';

package/dist/types/export/index.d.ts

@@ -1 +0,0 @@
-export type { SVGExportOptions } from './svg';

package/dist/types/export/svg/SVGContentGenerator.d.ts

@@ -1,76 +0,0 @@
-import type { SVGCellData, SVGGenerationOptions } from './types';
-import type { TextmodeFont, TextmodeGrid } from '../../index';
-/**
- * Generates SVG content and markup from processed cell data.
- * This class handles the creation of SVG elements, groups, and styling.
- */
-export declare class SVGContentGenerator {
-    private _pathGenerator;
-    constructor();
-    /**
-     * Generates the SVG header with metadata
-     * @param gridInfo Grid dimensions
-     * @returns SVG header string
-     */
-    $generateSVGHeader(gridInfo: TextmodeGrid): string;
-    /**
-     * Generates the SVG footer
-     * @returns SVG footer string
-     */
-    $generateSVGFooter(): string;
-    /**
-     * Generates background rectangle if needed
-     * @param gridInfo Grid information
-     * @param options SVG generation options
-     * @returns Background rectangle SVG string or empty string
-     */
-    $generateBackground(gridInfo: TextmodeGrid, options: SVGGenerationOptions): string;
-    /**
-     * Generates SVG transform attribute string
-     * @param cellData Cell data with transform information
-     * @param gridInfo Grid information for center calculations
-     * @returns Transform attribute string or empty string
-     */
-    private _generateTransformAttribute;
-    /**
-     * Generates background rectangle for a cell
-     * @param cellData Cell data
-     * @param gridInfo Grid information
-     * @param options SVG generation options
-     * @returns Background rectangle SVG string or empty string
-     */
-    private _generateCellBackground;
-    /**
-     * Generates character path element for a cell
-     * @param cellData Cell data
-     * @param gridInfo Grid information
-     * @param fontInfo Font information
-     * @param options SVG generation options
-     * @returns Character path SVG string
-     */
-    private _generateCharacterPath;
-    /**
-     * Generates complete SVG content for a single cell
-     * @param cellData Cell data
-     * @param gridInfo Grid information
-     * @param fontInfo Font information
-     * @param options SVG generation options
-     * @returns Complete cell SVG content
-     */
-    $generateCellContent(cellData: SVGCellData, gridInfo: TextmodeGrid, fontInfo: TextmodeFont, options: SVGGenerationOptions): string;
-    /**
-     * Generates the complete SVG content from cell data
-     * @param cellDataArray Array of cell data
-     * @param grid Grid information
-     * @param fontInfo Font information
-     * @param options SVG generation options
-     * @returns Complete SVG string
-     */
-    $generateSVGContent(cellDataArray: SVGCellData[], grid: TextmodeGrid, fontInfo: TextmodeFont, options: SVGGenerationOptions): string;
-    /**
-     * Optimizes SVG content by removing empty elements and unnecessary whitespace
-     * @param svgContent Raw SVG content
-     * @returns Optimized SVG content
-     */
-    $optimizeSVGContent(svgContent: string): string;
-}

package/dist/types/export/svg/SVGDataExtractor.d.ts

@@ -1,33 +0,0 @@
-import type { FramebufferData, SVGCellData } from './types';
-import { DataExtractor } from '../base';
-import type { TextmodeGrid } from '../../index';
-/**
- * Extracts and processes data from framebuffers for SVG generation.
- * This class handles the conversion of raw pixel data into structured data objects.
- */
-export declare class SVGDataExtractor extends DataExtractor {
-    /**
-     * Extracts transform data from transform pixels
-     * @param transformPixels Transform framebuffer pixels
-     * @param rotationPixels Rotation framebuffer pixels
-     * @param pixelIndex Pixel index in the array
-     * @returns Transform data object
-     */
-    private _extractTransformData;
-    /**
-     * Calculates cell position information
-     * @param x Grid X coordinate
-     * @param y Grid Y coordinate
-     * @param gridInfo Grid information
-     * @returns Position data object
-     */
-    private _calculateCellPosition;
-    /**
-     * Processes all grid cells and extracts SVG cell data
-     * @param framebufferData Raw pixel data from framebuffers
-     * @param grid Grid information
-     * @param font Font information
-     * @returns Array of SVG cell data objects
-     */
-    $extractSVGCellData(framebufferData: FramebufferData, grid: TextmodeGrid): SVGCellData[];
-}

package/dist/types/export/svg/SVGExporter.d.ts

@@ -1,31 +0,0 @@
-import type { SVGExportOptions, TextmodeRenderingData } from './types';
-/**
- * Main SVG exporter for the textmode.js library.
- * Orchestrates the SVG export process by coordinating data extraction,
- * content generation, and file handling.
- */
-export declare class SVGExporter {
-    private _dataExtractor;
-    private _contentGenerator;
-    private _fileHandler;
-    constructor();
-    /**
-     * Applies default values to SVG export options
-     * @param options User-provided options
-     * @returns Complete options with defaults applied
-     */
-    private _applyDefaultOptions;
-    /**
-     * Generates SVG content from textmode rendering data without saving to file
-     * @param renderingData The textmode rendering data containing pipeline, grid, and font
-     * @param options Export options (excluding filename)
-     * @returns SVG content as string
-     */
-    $generateSVG(renderingData: TextmodeRenderingData, options?: SVGExportOptions): string;
-    /**
-     * Exports SVG content to a downloadable file
-     * @param renderingData The textmode rendering data containing pipeline, grid, and font
-     * @param options Export options including filename
-     */
-    $saveSVG(renderingData: TextmodeRenderingData, options?: SVGExportOptions): void;
-}

package/dist/types/export/svg/SVGFileHandler.d.ts

@@ -1,25 +0,0 @@
-import { FileHandler } from '../base/FileHandler.js';
-/**
- * Handles SVG file operations including download and save functionality.
- * This class manages the creation of downloadable SVG files and blob handling.
- */
-export declare class SVGFileHandler extends FileHandler {
-    /**
-     * Creates a downloadable blob from SVG content
-     * @param svgContent The SVG content string
-     * @returns Blob object containing the SVG data
-     */
-    $createSVGBlob(svgContent: string): Blob;
-    /**
-     * Downloads SVG content as a file
-     * @param svgContent The SVG content to download
-     * @param filename The filename (without extension)
-     */
-    private _downloadSVG;
-    /**
-     * Saves SVG content with automatic filename generation if not provided
-     * @param svgContent The SVG content to save
-     * @param filename Optional filename (will generate if not provided)
-     */
-    $saveSVG(svgContent: string, filename?: string): void;
-}

package/dist/types/export/svg/SVGPathGenerator.d.ts

@@ -1,49 +0,0 @@
-import type { TextmodeFont } from '../../textmode/font/TextmodeFont';
-/**
- * Handles SVG path generation for character glyphs.
- * This class is responsible for converting font glyph data into SVG path strings.
- */
-export declare class SVGPathGenerator {
-    /**
-     * Creates a path object for a glyph
-     * @param fontData Font data object
-     * @param glyphData Glyph data from font
-     * @param x X position
-     * @param y Y position
-     * @param fontSize Font size
-     * @returns Path object with bounding box and SVG methods
-     */
-    private _createGlyphPath;
-    /**
-     * Converts glyph data to SVG path string
-     * @param glyphData Glyph data from font
-     * @param x X position
-     * @param y Y position
-     * @param scale Scale factor
-     * @returns SVG path data string
-     */
-    private _glyphToSVGPath;
-    /**
-     * Generates an SVG path for a character glyph
-     * @param character The character to generate a path for
-     * @param fontData The font data object
-     * @param x X position
-     * @param y Y position
-     * @param fontSize Font size
-     * @returns Path object with SVG generation methods
-     */
-    private _generateCharacterPath;
-    /**
-     * Generates SVG path data for a character with positioning calculations
-     * @param character The character to render
-     * @param fontData The font data
-     * @param cellX Cell X position
-     * @param cellY Cell Y position
-     * @param cellWidth Cell width
-     * @param cellHeight Cell height
-     * @param fontSize Font size
-     * @param advanceWidth Character advance width
-     * @returns SVG path data string or null if generation fails
-     */
-    $generatePositionedCharacterPath(character: string, font: TextmodeFont, cellX: number, cellY: number, cellWidth: number, cellHeight: number, fontSize: number, advanceWidth: number): string | null;
-}

package/dist/types/export/svg/index.d.ts

@@ -1,6 +0,0 @@
-export { SVGExporter } from './SVGExporter';
-export { SVGDataExtractor } from './SVGDataExtractor';
-export { SVGContentGenerator } from './SVGContentGenerator';
-export { SVGPathGenerator } from './SVGPathGenerator';
-export { SVGFileHandler } from './SVGFileHandler';
-export type { SVGExportOptions, SVGGenerationOptions, SVGCellData, FramebufferData, RGBA, Position, CellPosition, CellTransform, GlyphPath } from './types';

package/dist/types/export/svg/types.d.ts

@@ -1,129 +0,0 @@
-/**
- * SVG-specific type definitions for the textmode.js library.
- */
-import type { TextmodeFont, TextmodeGrid } from '../..';
-/**
- * RGBA color representation.
- */
-export interface RGBA {
-    r: number;
-    g: number;
-    b: number;
-    a: number;
-}
-/**
- * 2D position coordinates.
- */
-export interface Position {
-    x: number;
-    y: number;
-}
-/**
- * Cell position in grid coordinates.
- */
-export interface CellPosition {
-    x: number;
-    y: number;
-    cellX: number;
-    cellY: number;
-}
-/**
- * Cell transformation data.
- */
-export interface CellTransform {
-    isInverted: boolean;
-    flipHorizontal: boolean;
-    flipVertical: boolean;
-    rotation: number;
-}
-/**
- * Complete data for a single SVG cell.
- */
-export interface SVGCellData {
-    charIndex: number;
-    primaryColor: RGBA;
-    secondaryColor: RGBA;
-    transform: CellTransform;
-    position: CellPosition;
-}
-/**
- * Framebuffer data extracted for SVG generation.
- */
-export interface FramebufferData {
-    characterPixels: Uint8Array;
-    primaryColorPixels: Uint8Array;
-    secondaryColorPixels: Uint8Array;
-    transformPixels: Uint8Array;
-    rotationPixels: Uint8Array;
-}
-/**
- * Options for exporting the textmode content to SVG format.
- */
-export type SVGExportOptions = {
-    /**
-     * The filename to save the SVG file as.
-     *
-     * If not provided, a default filename is used.
-     */
-    filename?: string;
-    /**
-     * Whether to include cell background rectangles in the SVG output.
-     *
-     * When `false`, only the character paths are included, creating a more compact SVG.
-     *
-     * Default is `true`.
-     */
-    includeBackgroundRectangles?: boolean;
-    /**
-     * The drawing mode for ASCII characters.
-     *
-     * When set to `'fill'`, characters are rendered as filled shapes.
-     *
-     * When set to `'stroke'`, characters are rendered as outlines.
-     *
-     * Default is `'fill'`.
-     */
-    drawMode?: 'fill' | 'stroke';
-    /**
-     * The stroke width to use when drawMode is set to `'stroke'`.
-     *
-     * Default is `1.0`.
-     */
-    strokeWidth?: number;
-    /**
-     * Background color for the SVG as RGBA array `[r, g, b, a]`.
-     *
-     * Default is transparent black `[0, 0, 0, 0]`.
-     */
-    backgroundColor?: [number, number, number, number];
-};
-/**
- * Path object interface for character glyphs.
- */
-export interface GlyphPath {
-    getBoundingBox(): {
-        x1: number;
-        y1: number;
-        x2: number;
-        y2: number;
-    };
-    toSVG(): string;
-}
-/**
- * Internal options used by SVG generation (with all defaults applied).
- */
-export interface SVGGenerationOptions {
-    includeBackgroundRectangles: boolean;
-    drawMode: 'fill' | 'stroke';
-    strokeWidth: number;
-    backgroundColor: [number, number, number, number];
-    filename: string;
-}
-/**
- * Data required for textmode rendering export (shared shape with TXT exporter)
- */
-export interface TextmodeRenderingData {
-    pipeline: any;
-    grid: TextmodeGrid;
-    font: TextmodeFont;
-}