textmode.js 0.3.2-beta.2 → 0.4.0

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;
-}

package/dist/types/export/txt/TXTContentGenerator.d.ts

@@ -1,14 +0,0 @@
-import type { TXTGenerationOptions } from './types';
-/**
- * Generates TXT content from character grid data.
- * This class handles the conversion of character arrays into formatted text strings.
- */
-export declare class TXTContentGenerator {
-    /**
-     * Generates TXT content from a 2D character array
-     * @param characterGrid 2D array of characters (rows x columns)
-     * @param options Generation options
-     * @returns TXT content as string
-     */
-    $generateTXTContent(characterGrid: string[][], options: TXTGenerationOptions): string;
-}

package/dist/types/export/txt/TXTDataExtractor.d.ts

@@ -1,19 +0,0 @@
-import type { FramebufferData } from './types';
-import { DataExtractor } from '../base';
-import type { TextmodeGrid } from '../../textmode/Grid';
-import type { TextmodeFont } from '../../textmode/font';
-/**
- * Extracts and processes data from framebuffers for TXT generation.
- * This class handles the conversion of raw pixel data into character arrays.
- */
-export declare class TXTDataExtractor extends DataExtractor {
-    /**
-     * Extracts character data for TXT generation
-     * @param framebufferData Framebuffer pixel data
-     * @param grid Grid information
-     * @param font Font information
-     * @param emptyCharacter Character to use for empty cells
-     * @returns 2D array of characters (rows x columns)
-     */
-    $extractCharacterGrid(framebufferData: FramebufferData, grid: TextmodeGrid, font: TextmodeFont, emptyCharacter?: string): string[][];
-}

package/dist/types/export/txt/TXTExporter.d.ts

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

package/dist/types/export/txt/TXTFileHandler.d.ts

@@ -1,19 +0,0 @@
-import { FileHandler } from '../base/FileHandler.js';
-/**
- * Handles file operations for TXT export.
- * This class manages the saving of TXT content to downloadable files.
- */
-export declare class TXTFileHandler extends FileHandler {
-    /**
-     * Saves TXT content as a downloadable file
-     * @param content The TXT content to save
-     * @param filename The filename to use for the download
-     */
-    $saveTXT(content: string, filename: string): void;
-    /**
-     * Ensures filename has proper extension and is valid
-     * @param filename The filename to validate and fix
-     * @returns Valid filename with .txt extension
-     */
-    private _ensureValidFilename;
-}

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

@@ -1,5 +0,0 @@
-export { TXTExporter } from './TXTExporter';
-export { TXTDataExtractor } from './TXTDataExtractor';
-export { TXTContentGenerator } from './TXTContentGenerator';
-export { TXTFileHandler } from './TXTFileHandler';
-export type { TXTExportOptions, TXTGenerationOptions, FramebufferData } from './types';

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

@@ -1,55 +0,0 @@
-/**
- * TXT-specific type definitions for the textmode.js library.
- */
-import type { TextmodeFont, TextmodeGrid } from '../..';
-/**
- * Options for exporting the textmode content to TXT format.
- */
-export type TXTExportOptions = {
-    /**
-     * The filename to save the TXT file as.
-     *
-     * If not provided, a default filename is used.
-     */
-    filename?: string;
-    /**
-     * Whether to preserve trailing spaces on each line.
-     *
-     * When `false`, trailing spaces are trimmed from each line.
-     *
-     * Default is `false`.
-     */
-    preserveTrailingSpaces?: boolean;
-    /**
-     * The line ending format to use *(`'lf'` for Unix/Linux, `'crlf'` for Windows)*.
-     *
-     * Default is `'lf'`.
-     */
-    lineEnding?: 'lf' | 'crlf';
-    /**
-     * Character to use for empty cells *(when no character is rendered)*.
-     * Default is a space `' '`.
-     */
-    emptyCharacter?: string;
-};
-/**
- * Internal options used by TXT generation (with all defaults applied).
- */
-export interface TXTGenerationOptions {
-    preserveTrailingSpaces: boolean;
-    lineEnding: 'lf' | 'crlf';
-    emptyCharacter: string;
-    filename: string;
-}
-/**
- * Data required for textmode rendering export
- */
-export interface TextmodeRenderingData {
-    pipeline: any;
-    grid: TextmodeGrid;
-    font: TextmodeFont;
-}
-/**
- * Re-export shared types from SVG module that are also used by TXT exporter
- */
-export type { FramebufferData } from '../svg/types';

package/dist/types/textmode/mixins/ExportMixin.d.ts

@@ -1,128 +0,0 @@
-import type { Mixin } from './TextmodifierMixin';
-import { type SVGExportOptions } from '../../export/svg';
-import { type TXTExportOptions } from '../../export/txt';
-import { type ImageExportOptions } from '../../export/image';
-/**
- * Interface for export capabilities that will be mixed into Textmodifier
- */
-export interface ExportCapabilities {
-    /**
-     * Generate the current textmode rendering as a text string.
-     * @param options Options for text generation *(excluding filename)*
-     * @returns Textmode grid content as a string.
-     *
-     * @example
-     * ```javascript
-     * // Fetch a canvas element to apply textmode rendering to
-     * const canvas = document.querySelector('canvas#myCanvas');
-     *
-     * // Create a Textmodifier instance
-     * const textmodifier = textmode.create(canvas, {renderMode: 'manual'});
-     *
-     * // Get the current rendering as a text string
-     * const textString = textmodifier.toString({
-     *   preserveTrailingSpaces: false,
-     *   lineEnding: 'lf'
-     * });
-     *
-     * // Print to console or use otherwise
-     * console.log(textString);
-     * ```
-     */
-    toString(options?: TXTExportOptions): string;
-    /**
-     * Export the current textmode rendering to a TXT file.
-     * @param options Options for TXT export
-     *
-     * @example
-     * ```javascript
-     * // Fetch a canvas element to apply textmode rendering to
-     * const canvas = document.querySelector('canvas#myCanvas');
-     *
-     * // Create a Textmodifier instance
-     * const textmodifier = textmode.create(canvas, {renderMode: 'manual'});
-     *
-     * // Export the current rendering to a TXT file
-     * textmodifier.saveStrings({
-     *   filename: 'my_textmode_rendering',
-     *   preserveTrailingSpaces: false
-     * });
-     * ```
-     */
-    saveStrings(options?: TXTExportOptions): void;
-    /**
-     * Generate the current textmode rendering as an SVG string.
-     * @param options Options for SVG generation *(excluding filename)*
-     * @returns SVG content as a string.
-     *
-     * @example
-     * ```javascript
-     * // Fetch a canvas element to apply textmode rendering to
-     * const canvas = document.querySelector('canvas#myCanvas');
-     *
-     * // Create a Textmodifier instance
-     * const textmodifier = textmode.create(canvas, {renderMode: 'manual'});
-     *
-     * // Get the current rendering as an SVG string
-     * const svgString = textmodifier.toSVG({
-     *   includeBackgroundRectangles: true,
-     *   drawMode: 'fill'
-     * });
-     *
-     * // Print to console or use otherwise
-     * console.log(svgString);
-     * ```
-     */
-    toSVG(options?: SVGExportOptions): string;
-    /**
-     * Export the current textmode rendering to an SVG file.
-     * @param options Options for SVG export
-     *
-     * @example
-     * ```javascript
-     * // Fetch a canvas element to apply textmode rendering to
-     * const canvas = document.querySelector('canvas#myCanvas');
-     *
-     * // Create a Textmodifier instance
-     * const textmodifier = textmode.create(canvas, {renderMode: 'manual'});
-     *
-     * // Export the current rendering to an SVG file
-     * textmodifier.saveSVG({
-     *   filename: 'my_textmode_rendering',
-     * });
-     * ```
-     */
-    saveSVG(options?: SVGExportOptions): void;
-    /**
-     * Export the current textmode rendering to an image file.
-     * @param options Options for image export
-     *
-     * @example
-     * ```javascript
-     * // Fetch a canvas element to apply textmode rendering to
-     * const canvas = document.querySelector('canvas#myCanvas');
-     *
-     * // Create a Textmodifier instance
-     * const textmodifier = textmode.create(canvas, {renderMode: 'manual'});
-     *
-     * // Export the current rendering to a PNG file *(default)*
-     * textmodifier.saveCanvas();
-     *
-     * // Export with custom options
-     * textmodifier.saveCanvas({
-     *   filename: 'my_textmode_rendering',
-     *   format: 'jpg',
-     *   quality: 0.8,
-     *   scale: 2.0,
-     *   backgroundColor: 'white'
-     * });
-     * ```
-     */
-    saveCanvas(options?: ImageExportOptions): Promise<void>;
-}
-/**
- * Mixin that adds export capabilities to a class
- * @param Base The base class to extend
- * @returns Extended class with export capabilities
- */
-export declare const ExportMixin: Mixin<ExportCapabilities>;