text-shaper 0.1.2 → 0.1.4

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

@@ -2,9 +2,19 @@
  * Bidi character mirroring
  * Port of bidi-js mirroring.js
  */
+/**
+ * Get the mirrored version of a character for BiDi display
+ * @param char Character to mirror
+ * @returns Mirrored character, or null if character has no mirror
+ */
 export declare function getMirroredCharacter(char: string): string | null;
 /**
  * Given a string and its resolved embedding levels, build a map of indices to replacement chars
  * for any characters in right-to-left segments that have defined mirrored characters.
+ * @param string Text string to process
+ * @param embeddingLevels Resolved embedding levels from getEmbeddingLevels
+ * @param start Start index (defaults to 0)
+ * @param end End index (defaults to string length - 1)
+ * @returns Map of character indices to their mirrored replacements
  */
 export declare function getMirroredCharactersMap(string: string, embeddingLevels: Uint8Array, start?: number, end?: number): Map<number, string>;

package/dist/unicode/bidi/reordering.d.ts

@@ -6,13 +6,28 @@ import type { EmbeddingLevelsResult } from "./embedding-levels.ts";
 /**
  * Given a start and end denoting a single line within a string, and a set of precalculated
  * bidi embedding levels, produce a list of segments whose ordering should be flipped, in sequence.
+ * @param string Text string to process
+ * @param embeddingLevelsResult Result from getEmbeddingLevels
+ * @param start Start index (defaults to 0)
+ * @param end End index (defaults to string length - 1)
+ * @returns Array of segment ranges [start, end] to be reversed
  */
 export declare function getReorderSegments(string: string, embeddingLevelsResult: EmbeddingLevelsResult, start?: number, end?: number): Array<[number, number]>;
 /**
  * Get the reordered string with bidi segments reversed
+ * @param string Text string to reorder
+ * @param embedLevelsResult Result from getEmbeddingLevels
+ * @param start Start index (defaults to 0)
+ * @param end End index (defaults to string length - 1)
+ * @returns Reordered string with BiDi applied
  */
 export declare function getReorderedString(string: string, embedLevelsResult: EmbeddingLevelsResult, start?: number, end?: number): string;
 /**
  * Get an array with character indices in their new bidi order
+ * @param string Text string to process
+ * @param embedLevelsResult Result from getEmbeddingLevels
+ * @param start Start index (defaults to 0)
+ * @param end End index (defaults to string length - 1)
+ * @returns Array mapping new positions to original character indices
  */
 export declare function getReorderedIndices(string: string, embedLevelsResult: EmbeddingLevelsResult, start?: number, end?: number): number[];

package/dist/unicode/normalize.d.ts

@@ -15,22 +15,45 @@ export declare enum NormalizationMode {
 /**
  * Canonical Combining Class (ccc) for combining marks
  * Based on Unicode 15.0
+ *
+ * Optimized with early-exit for common non-combining ranges:
+ * - Basic Latin (0000-007F)
+ * - Latin-1 Supplement (0080-00FF)
+ * - Latin Extended-A/B (0100-024F)
+ * - IPA Extensions (0250-02AF)
+ * - Spacing Modifier Letters (02B0-02FF) - most are spacing
+ * - Greek and Coptic (0370-03FF) - base chars only
+ * - Cyrillic (0400-04FF)
+ * - Cyrillic Supplement (0500-052F)
+ * - CJK ranges (3000+)
+ * - Hangul (AC00-D7AF)
+ * @param cp Unicode codepoint to check
+ * @returns Canonical combining class (0 for non-combining characters, 1-255 for combining marks)
  */
 export declare function getCombiningClass(cp: number): number;
 /**
  * Reorder combining marks according to canonical combining class
+ * @param infos Array of glyph information objects (modified in place)
  */
 export declare function reorderMarks(infos: GlyphInfo[]): void;
 /**
  * Decompose a codepoint if it has a canonical decomposition
+ * @param cp Unicode codepoint to decompose
+ * @returns Array of decomposed codepoints, or null if character has no decomposition
  */
 export declare function decompose(cp: number): number[] | null;
 /**
  * Try to compose a base character with a combining mark
  * Returns the composed character or null if no composition exists
+ * @param base Base character codepoint
+ * @param combining Combining mark codepoint
+ * @returns Composed character codepoint, or null if no composition exists
  */
 export declare function tryCompose(base: number, combining: number): number | null;
 /**
  * Apply normalization to glyph infos
+ * @param infos Array of glyph information objects
+ * @param mode Normalization mode (None, Decompose, Compose, or Auto)
+ * @returns Normalized array of glyph information objects
  */
 export declare function normalize(infos: GlyphInfo[], mode: NormalizationMode): GlyphInfo[];

package/dist/unicode/script.d.ts

@@ -173,19 +173,28 @@ export declare enum Script {
 }
 /**
  * Get script for a codepoint using binary search
+ * @param cp Unicode codepoint to check
+ * @returns The script for the given codepoint
  */
 export declare function getScript(cp: number): Script;
 /**
  * Get script for a string (returns the dominant non-Common/Inherited script)
+ * @param text Text string to analyze
+ * @returns The dominant script found in the text (most frequent non-Common/Inherited script)
  */
 export declare function detectScript(text: string): Script;
 /**
  * Get all scripts present in text
+ * @param text Text string to analyze
+ * @returns Array of all scripts found in the text
  */
 export declare function getScripts(text: string): Script[];
 /**
  * Check if text contains only characters from a specific script
  * (Common and Inherited are allowed)
+ * @param text Text string to check
+ * @param script Script to check against
+ * @returns True if text contains only characters from the specified script (plus Common/Inherited)
  */
 export declare function isScript(text: string, script: Script): boolean;
 /**
@@ -199,17 +208,25 @@ export interface ScriptRun {
 }
 /**
  * Split text into script runs
+ * @param text Text string to split
+ * @returns Array of script runs, where each run is a contiguous sequence of characters with the same script
  */
 export declare function getScriptRuns(text: string): ScriptRun[];
 /**
  * Get OpenType script tag for a Unicode script
+ * @param script Unicode script to convert
+ * @returns OpenType script tag (4-character string like "latn", "arab", etc.)
  */
 export declare function getScriptTag(script: Script): string;
 /**
  * Check if a script requires complex shaping
+ * @param script Script to check
+ * @returns True if the script requires complex shaping (e.g., Arabic, Devanagari, Thai)
  */
 export declare function isComplexScript(script: Script): boolean;
 /**
  * Get script direction (LTR or RTL)
+ * @param script Script to check
+ * @returns Direction of the script: "ltr" for left-to-right or "rtl" for right-to-left
  */
 export declare function getScriptDirection(script: Script): "ltr" | "rtl";

package/dist/unicode/segmentation.d.ts

@@ -50,10 +50,14 @@ export declare enum WordBreakProperty {
 }
 /**
  * Get grapheme break property for codepoint
+ * @param cp Unicode codepoint to check
+ * @returns Grapheme break property for the codepoint
  */
 export declare function getGraphemeBreakProperty(cp: number): GraphemeBreakProperty;
 /**
  * Get word break property for codepoint
+ * @param cp Unicode codepoint to check
+ * @returns Word break property for the codepoint
  */
 export declare function getWordBreakProperty(cp: number): WordBreakProperty;
 /**
@@ -67,6 +71,8 @@ export interface GraphemeBoundaries {
 }
 /**
  * Find grapheme cluster boundaries in codepoints
+ * @param codepoints Array of Unicode codepoints
+ * @returns Object containing boundary positions and grapheme break properties
  */
 export declare function findGraphemeBoundaries(codepoints: number[]): GraphemeBoundaries;
 /**
@@ -80,25 +86,37 @@ export interface WordBoundaries {
 }
 /**
  * Find word boundaries in codepoints
+ * @param codepoints Array of Unicode codepoints
+ * @returns Object containing boundary positions and word break properties
  */
 export declare function findWordBoundaries(codepoints: number[]): WordBoundaries;
 /**
  * Split text into grapheme clusters
+ * @param text Text string to split
+ * @returns Array of grapheme cluster strings
  */
 export declare function splitGraphemes(text: string): string[];
 /**
  * Split text into words
+ * @param text Text string to split
+ * @returns Array of word strings (whitespace-only segments are filtered out)
  */
 export declare function splitWords(text: string): string[];
 /**
  * Count grapheme clusters in text
+ * @param text Text string to analyze
+ * @returns Number of grapheme clusters in the text
  */
 export declare function countGraphemes(text: string): number;
 /**
  * Analyze grapheme boundaries for glyph infos
+ * @param infos Array of glyph information objects
+ * @returns Object containing boundary positions and grapheme break properties
  */
 export declare function analyzeGraphemesForGlyphs(infos: GlyphInfo[]): GraphemeBoundaries;
 /**
  * Analyze word boundaries for glyph infos
+ * @param infos Array of glyph information objects
+ * @returns Object containing boundary positions and word break properties
  */
 export declare function analyzeWordsForGlyphs(infos: GlyphInfo[]): WordBoundaries;

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "text-shaper",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "devDependencies": {
     "@biomejs/biome": "2.3.8",
     "@types/bun": "latest",
+    "@types/opentype.js": "^1.3.8",
+    "freetype2": "^2.1.0",
+    "harfbuzzjs": "^0.4.13",
+    "opentype.js": "^1.3.4",
     "vitepress": "^2.0.0-alpha.15",
     "vitepress-plugin-llms": "^1.9.3"
   },
@@ -43,6 +47,8 @@
   ],
   "license": "MIT",
   "scripts": {
+    "postinstall": "node scripts/patch-pkg-prebuilds.js",
+    "bench": "bun test ./bench/ --timeout 120000",
     "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",
     "build:analyze": "bun build ./src/index.ts --outdir ./dist --target browser --minify --metafile=./dist/meta.json",
@@ -56,5 +62,8 @@
     "docs:preview": "vitepress preview docs"
   },
   "type": "module",
-  "types": "./dist/index.d.ts"
+  "types": "./dist/index.d.ts",
+  "trustedDependencies": [
+    "freetype2"
+  ]
 }