text-shaper 0.0.1 → 0.1.0

package/dist/raster/types.d.ts

@@ -0,0 +1,174 @@
+/**
+ * Rasterizer types - FreeType-style bitmap rendering
+ */
+import type { GlyphPath } from "../render/path.ts";
+/**
+ * Pixel modes for bitmap output
+ */
+export declare enum PixelMode {
+    /** 1-bit per pixel, 8 pixels per byte */
+    Mono = 0,
+    /** 8-bit grayscale, 1 byte per pixel */
+    Gray = 1,
+    /** 24-bit LCD subpixel RGB, 3 bytes per pixel */
+    LCD = 2,
+    /** 24-bit LCD subpixel vertical RGB */
+    LCD_V = 3
+}
+/**
+ * Fill rule for outline rendering
+ */
+export declare enum FillRule {
+    /** Non-zero winding rule (default) */
+    NonZero = 0,
+    /** Even-odd (alternating) fill rule */
+    EvenOdd = 1
+}
+/**
+ * Bitmap buffer for rasterized glyphs
+ */
+export interface Bitmap {
+    /** Pixel buffer */
+    buffer: Uint8Array;
+    /** Width in pixels */
+    width: number;
+    /** Height in pixels */
+    rows: number;
+    /** Bytes per row (may include padding) */
+    pitch: number;
+    /** Pixel format */
+    pixelMode: PixelMode;
+    /** Number of gray levels (256 for 8-bit) */
+    numGrays: number;
+}
+/**
+ * A single horizontal span of pixels (for direct rendering)
+ */
+export interface Span {
+    /** X position of span start */
+    x: number;
+    /** Length in pixels */
+    len: number;
+    /** Coverage value 0-255 */
+    coverage: number;
+}
+/**
+ * Callback for span-based rendering
+ * @template T User data type passed through from render call
+ */
+export type SpanFunc<T = void> = (y: number, spans: Span[], userData: T) => void;
+/**
+ * Rasterization parameters
+ */
+export interface RasterParams {
+    /** Target bitmap (null for span callback mode) */
+    target?: Bitmap;
+    /** Source outline path */
+    source: GlyphPath;
+    /** Fill rule */
+    fillRule?: FillRule;
+    /** Span callback for direct rendering */
+    spanFunc?: SpanFunc;
+    /** Clip box (in pixels) */
+    clipBox?: {
+        xMin: number;
+        yMin: number;
+        xMax: number;
+        yMax: number;
+    };
+}
+/**
+ * Options for rasterizing a glyph
+ */
+export interface RasterizeOptions {
+    /** Width in pixels */
+    width: number;
+    /** Height in pixels */
+    height: number;
+    /** Scale factor (font units to pixels) */
+    scale: number;
+    /** X offset in pixels */
+    offsetX?: number;
+    /** Y offset in pixels */
+    offsetY?: number;
+    /** Pixel mode */
+    pixelMode?: PixelMode;
+    /** Fill rule */
+    fillRule?: FillRule;
+    /** Flip Y axis (font coords are Y-up, bitmap is Y-down) */
+    flipY?: boolean;
+}
+/**
+ * Result of glyph rasterization
+ */
+export interface RasterizedGlyph {
+    /** Pixel data */
+    bitmap: Bitmap;
+    /** Bearing X (offset from origin to left edge) */
+    bearingX: number;
+    /** Bearing Y (offset from origin to top edge) */
+    bearingY: number;
+}
+/**
+ * Glyph metrics for atlas building
+ */
+export interface GlyphMetrics {
+    /** Glyph ID */
+    glyphId: number;
+    /** X position in atlas */
+    atlasX: number;
+    /** Y position in atlas */
+    atlasY: number;
+    /** Width in atlas */
+    width: number;
+    /** Height in atlas */
+    height: number;
+    /** Bearing X */
+    bearingX: number;
+    /** Bearing Y */
+    bearingY: number;
+    /** Horizontal advance */
+    advance: number;
+}
+/**
+ * Texture atlas containing multiple glyphs
+ */
+export interface GlyphAtlas {
+    /** Atlas bitmap */
+    bitmap: Bitmap;
+    /** Glyph metrics indexed by glyph ID */
+    glyphs: Map<number, GlyphMetrics>;
+    /** Font size used for rendering */
+    fontSize: number;
+}
+/**
+ * Options for building a glyph atlas
+ */
+export interface AtlasOptions {
+    /** Font size in pixels */
+    fontSize: number;
+    /** Padding between glyphs */
+    padding?: number;
+    /** Maximum atlas width */
+    maxWidth?: number;
+    /** Maximum atlas height */
+    maxHeight?: number;
+    /** Pixel mode */
+    pixelMode?: PixelMode;
+    /** Enable hinting */
+    hinting?: boolean;
+}
+/**
+ * Create an empty bitmap
+ */
+export declare function createBitmap(width: number, height: number, pixelMode?: PixelMode): Bitmap;
+/**
+ * Clear a bitmap to zero
+ */
+export declare function clearBitmap(bitmap: Bitmap): void;
+/**
+ * Create a bottom-up bitmap (negative pitch)
+ * Bottom-up bitmaps have row 0 at the bottom of the image,
+ * which matches some graphics APIs (e.g., Windows DIB, OpenGL textures)
+ */
+export declare function createBottomUpBitmap(width: number, height: number, pixelMode?: PixelMode): Bitmap;

package/dist/render/path.d.ts

@@ -30,6 +30,19 @@ export type PathCommand = {
 } | {
     type: "Z";
 };
+/**
+ * Outline flags (like FreeType's FT_OUTLINE_* flags)
+ */
+export declare enum OutlineFlags {
+    /** No flags */
+    None = 0,
+    /** Use even-odd fill rule instead of non-zero winding */
+    EvenOddFill = 1,
+    /** Outline has been hinted */
+    HighPrecision = 2,
+    /** Outline is a single stroke (not filled) */
+    SinglePass = 4
+}
 /**
  * A glyph path is a series of drawing commands
  */
@@ -41,10 +54,12 @@ export interface GlyphPath {
         xMax: number;
         yMax: number;
     } | null;
+    /** Outline flags (like FreeType's FT_OUTLINE_* flags) */
+    flags?: OutlineFlags;
 }
 /**
- * Convert TrueType contours to path commands
- * TrueType uses quadratic Bézier curves with on-curve and off-curve points
+ * Convert contours to path commands
+ * Handles both TrueType (quadratic Béziers) and CFF (cubic Béziers)
  */
 export declare function contourToPath(contour: Contour): PathCommand[];
 /**

package/dist/shaper/complex/indic.d.ts

@@ -103,6 +103,10 @@ export declare enum MatraPosition {
     BelowBase = 2,
     PostBase = 3
 }
+/**
+ * Get matra position based on codepoint
+ */
+export declare function getMatraPosition(cp: number): MatraPosition;
 /**
  * Set up masks and syllable indices for Indic shaping
  */

package/dist/types.d.ts

@@ -129,6 +129,10 @@ export declare const Tags: {
     readonly vhea: number;
     readonly vmtx: number;
     readonly VORG: number;
+    readonly fpgm: number;
+    readonly prep: number;
+    readonly cvt: number;
+    readonly gasp: number;
 };
 export declare const FeatureTags: {
     readonly ccmp: number;

package/dist/unicode/bidi/brackets.gen.d.ts

@@ -0,0 +1,5 @@
+declare const _default: {
+    pairs: string;
+    canonical: string;
+};
+export default _default;

package/dist/unicode/bidi/char-types.gen.d.ts

@@ -0,0 +1,25 @@
+declare const _default: {
+    R: string;
+    EN: string;
+    ES: string;
+    ET: string;
+    AN: string;
+    CS: string;
+    B: string;
+    S: string;
+    WS: string;
+    ON: string;
+    BN: string;
+    NSM: string;
+    AL: string;
+    LRO: string;
+    RLO: string;
+    LRE: string;
+    RLE: string;
+    PDF: string;
+    LRI: string;
+    RLI: string;
+    FSI: string;
+    PDI: string;
+};
+export default _default;

package/dist/unicode/bidi/mirroring.gen.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "14>1,j>2,t>2,u>2,1a>g,2v3>1,1>1,1ge>1,1wd>1,b>1,1j>1,f>1,ai>3,-2>3,+1,8>1k0,-1jq>1y7,-1y6>1hf,-1he>1h6,-1h5>1ha,-1h8>1qi,-1pu>1,6>3u,-3s>7,6>1,1>1,f>1,1>1,+2,3>1,1>1,+13,4>1,1>1,6>1eo,-1ee>1,3>1mg,-1me>1mk,-1mj>1mi,-1mg>1mi,-1md>1,1>1,+2,1>10k,-103>1,1>1,4>1,5>1,1>1,+10,3>1,1>8,-7>8,+1,-6>7,+1,a>1,1>1,u>1,u6>1,1>1,+5,26>1,1>1,2>1,2>2,8>1,7>1,4>1,1>1,+5,b8>1,1>1,+3,1>3,-2>1,2>1,1>1,+2,c>1,3>1,1>1,+2,h>1,3>1,a>1,1>1,2>1,3>1,1>1,d>1,f>1,3>1,1a>1,1>1,6>1,7>1,13>1,k>1,1>1,+19,4>1,1>1,+2,2>1,1>1,+18,m>1,a>1,1>1,lk>1,1>1,4>1,2>1,f>1,3>1,1>1,+3,db>1,1>1,+3,3>1,1>1,+2,14qm>1,1>1,+1,6>1,4j>1,j>2,t>2,u>2,2>1,+1";
+export default _default;

package/package.json

@@ -1,18 +1,47 @@
 {
   "name": "text-shaper",
-  "version": "0.0.1",
-  "description": "Pure TypeScript text shaping engine",
-  "type": "module",
+  "version": "0.1.0",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "devDependencies": {
+    "@biomejs/biome": "2.3.8",
+    "@types/bun": "latest",
+    "vitepress": "^2.0.0-alpha.15",
+    "vitepress-plugin-llms": "^1.9.3"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     }
   },
-  "files": ["dist"],
+  "description": "Pure TypeScript text shaping engine with OpenType layout, TrueType hinting, and FreeType-style rasterization",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "font",
+    "text",
+    "shaping",
+    "harfbuzz",
+    "opentype",
+    "truetype",
+    "rasterizer",
+    "hinting",
+    "typography",
+    "glyph",
+    "freetype",
+    "arabic",
+    "indic",
+    "bidi",
+    "variable-fonts",
+    "lcd-rendering",
+    "texture-atlas"
+  ],
+  "license": "MIT",
   "scripts": {
     "build": "bun build ./src/index.ts --outdir ./dist --target browser --minify --sourcemap=linked",
     "build:prod": "bun build ./src/index.ts --outdir ./dist --target browser --production --sourcemap=external",
@@ -21,13 +50,11 @@
     "typecheck": "tsc --noEmit",
     "lint": "biome check --write --unsafe --max-diagnostics 99999",
     "check": "bun run typecheck && bun run lint",
-    "prepublishOnly": "bun run build:prod && bun run build:dts"
+    "prepublishOnly": "bun run build:prod && bun run build:dts",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs"
   },
-  "devDependencies": {
-    "@biomejs/biome": "2.3.8",
-    "@types/bun": "latest"
-  },
-  "peerDependencies": {
-    "typescript": "^5"
-  }
-}
+  "type": "module",
+  "types": "./dist/index.d.ts"
+}