fixnow 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,107 @@
+declare const SUPPORTED_LANGUAGES: readonly ["ar", "de", "es", "fr", "vi"];
+type LanguageCode = (typeof SUPPORTED_LANGUAGES)[number];
+interface LanguageInfo {
+    /** ISO 639-1 code used everywhere in the public API. */
+    code: LanguageCode;
+    /** Human-readable language name. */
+    name: string;
+    /** Gzipped trie file shipped under `dictionaries/<code>/`. */
+    trie: string;
+    /** SPDX identifier of the bundled dictionary data. */
+    license: string;
+    /** Enable cspell's compound-word matching (needed for German). */
+    compound?: boolean;
+}
+declare const LANGUAGES: Record<LanguageCode, LanguageInfo>;
+declare function isSupportedLanguage(code: string): code is LanguageCode;
+
+interface SpellIssue {
+    /** Character offset of the word in the checked text. */
+    offset: number;
+    /** Length of the flagged word. */
+    length: number;
+    /** The flagged word, exactly as it appeared. */
+    word: string;
+    /** Correction candidates, present only when `suggestions` is requested. */
+    suggestions?: string[];
+}
+interface CheckOptions {
+    /** Dictionary to check against. Defaults to `'es'`. */
+    language?: LanguageCode;
+    /**
+     * Spanish only: when true, accent omissions (e.g. "codigo" for "código") are
+     * flagged. When false (default) they are accepted as harmless.
+     */
+    strict?: boolean;
+    /** Attach correction suggestions to every issue. Defaults to false. */
+    suggestions?: boolean;
+    /** Maximum suggestions per issue. Defaults to 5. */
+    maxSuggestions?: number;
+    /** Words shorter than this are never flagged. Defaults to 3. */
+    minWordLength?: number;
+    /** Words to always accept (case-insensitive), e.g. an app-specific allowlist. */
+    ignoreWords?: Iterable<string>;
+    /**
+     * Words to always flag as misspelled (case-insensitive), even when the
+     * dictionary contains them — e.g. your own list of common personal typos.
+     * Applies unless the word is also in `ignoreWords` / `isProtectedWord`.
+     */
+    flagWords?: Iterable<string>;
+    /** Custom predicate to skip a word before it is checked (e.g. protected terms). */
+    isProtectedWord?: (word: string) => boolean;
+}
+/** A loaded, decoded dictionary. Membership and suggestion lookups are synchronous. */
+interface Dictionary {
+    /** True when the word is in the dictionary (compound-aware for German). */
+    has(word: string): boolean;
+    /** Correction candidates ordered best-first. */
+    suggest(word: string, max?: number): string[];
+}
+
+/** Finds misspelled words in `text` for the given language. */
+declare function checkText(text: string, options?: CheckOptions): Promise<SpellIssue[]>;
+/** Whether a single word is correctly spelled in the given language. */
+declare function isCorrect(word: string, language?: LanguageCode, strict?: boolean): Promise<boolean>;
+
+/** Loads and decodes a language dictionary, caching the result. */
+declare function loadDictionary(language: LanguageCode): Promise<Dictionary>;
+/**
+ * Pre-loads dictionaries so the first check isn't slowed by trie decoding.
+ * Pass nothing to warm every supported language.
+ */
+declare function warmup(language?: LanguageCode | LanguageCode[]): Promise<void>;
+
+interface Token {
+    word: string;
+    offset: number;
+}
+/**
+ * Yields candidate words from `text`, skipping anything inside a protected
+ * segment (code, URLs, paths, acronyms, …).
+ */
+declare function tokenize(text: string): Generator<Token>;
+
+/** A checker bound to a single language, for convenient repeated use. */
+interface BoundChecker {
+    readonly language: LanguageCode;
+    check(text: string, options?: Omit<CheckOptions, 'language'>): Promise<SpellIssue[]>;
+    suggest(word: string, max?: number): Promise<string[]>;
+    isCorrect(word: string, strict?: boolean): Promise<boolean>;
+    warmup(): Promise<void>;
+}
+/**
+ * Creates a checker locked to one language.
+ *
+ * ```ts
+ * const es = createChecker('es');
+ * const issues = await es.check('Este texto tiene un herror', { suggestions: true });
+ * ```
+ */
+declare function createChecker(language: LanguageCode): BoundChecker;
+/** Correction suggestions for a single word. */
+declare function suggest(word: string, options?: {
+    language?: LanguageCode;
+    max?: number;
+}): Promise<string[]>;
+
+export { type BoundChecker, type CheckOptions, type Dictionary, LANGUAGES, type LanguageCode, type LanguageInfo, SUPPORTED_LANGUAGES, type SpellIssue, checkText, createChecker, isCorrect, isSupportedLanguage, loadDictionary, suggest, tokenize, warmup };

package/dist/index.d.ts

@@ -0,0 +1,107 @@
+declare const SUPPORTED_LANGUAGES: readonly ["ar", "de", "es", "fr", "vi"];
+type LanguageCode = (typeof SUPPORTED_LANGUAGES)[number];
+interface LanguageInfo {
+    /** ISO 639-1 code used everywhere in the public API. */
+    code: LanguageCode;
+    /** Human-readable language name. */
+    name: string;
+    /** Gzipped trie file shipped under `dictionaries/<code>/`. */
+    trie: string;
+    /** SPDX identifier of the bundled dictionary data. */
+    license: string;
+    /** Enable cspell's compound-word matching (needed for German). */
+    compound?: boolean;
+}
+declare const LANGUAGES: Record<LanguageCode, LanguageInfo>;
+declare function isSupportedLanguage(code: string): code is LanguageCode;
+
+interface SpellIssue {
+    /** Character offset of the word in the checked text. */
+    offset: number;
+    /** Length of the flagged word. */
+    length: number;
+    /** The flagged word, exactly as it appeared. */
+    word: string;
+    /** Correction candidates, present only when `suggestions` is requested. */
+    suggestions?: string[];
+}
+interface CheckOptions {
+    /** Dictionary to check against. Defaults to `'es'`. */
+    language?: LanguageCode;
+    /**
+     * Spanish only: when true, accent omissions (e.g. "codigo" for "código") are
+     * flagged. When false (default) they are accepted as harmless.
+     */
+    strict?: boolean;
+    /** Attach correction suggestions to every issue. Defaults to false. */
+    suggestions?: boolean;
+    /** Maximum suggestions per issue. Defaults to 5. */
+    maxSuggestions?: number;
+    /** Words shorter than this are never flagged. Defaults to 3. */
+    minWordLength?: number;
+    /** Words to always accept (case-insensitive), e.g. an app-specific allowlist. */
+    ignoreWords?: Iterable<string>;
+    /**
+     * Words to always flag as misspelled (case-insensitive), even when the
+     * dictionary contains them — e.g. your own list of common personal typos.
+     * Applies unless the word is also in `ignoreWords` / `isProtectedWord`.
+     */
+    flagWords?: Iterable<string>;
+    /** Custom predicate to skip a word before it is checked (e.g. protected terms). */
+    isProtectedWord?: (word: string) => boolean;
+}
+/** A loaded, decoded dictionary. Membership and suggestion lookups are synchronous. */
+interface Dictionary {
+    /** True when the word is in the dictionary (compound-aware for German). */
+    has(word: string): boolean;
+    /** Correction candidates ordered best-first. */
+    suggest(word: string, max?: number): string[];
+}
+
+/** Finds misspelled words in `text` for the given language. */
+declare function checkText(text: string, options?: CheckOptions): Promise<SpellIssue[]>;
+/** Whether a single word is correctly spelled in the given language. */
+declare function isCorrect(word: string, language?: LanguageCode, strict?: boolean): Promise<boolean>;
+
+/** Loads and decodes a language dictionary, caching the result. */
+declare function loadDictionary(language: LanguageCode): Promise<Dictionary>;
+/**
+ * Pre-loads dictionaries so the first check isn't slowed by trie decoding.
+ * Pass nothing to warm every supported language.
+ */
+declare function warmup(language?: LanguageCode | LanguageCode[]): Promise<void>;
+
+interface Token {
+    word: string;
+    offset: number;
+}
+/**
+ * Yields candidate words from `text`, skipping anything inside a protected
+ * segment (code, URLs, paths, acronyms, …).
+ */
+declare function tokenize(text: string): Generator<Token>;
+
+/** A checker bound to a single language, for convenient repeated use. */
+interface BoundChecker {
+    readonly language: LanguageCode;
+    check(text: string, options?: Omit<CheckOptions, 'language'>): Promise<SpellIssue[]>;
+    suggest(word: string, max?: number): Promise<string[]>;
+    isCorrect(word: string, strict?: boolean): Promise<boolean>;
+    warmup(): Promise<void>;
+}
+/**
+ * Creates a checker locked to one language.
+ *
+ * ```ts
+ * const es = createChecker('es');
+ * const issues = await es.check('Este texto tiene un herror', { suggestions: true });
+ * ```
+ */
+declare function createChecker(language: LanguageCode): BoundChecker;
+/** Correction suggestions for a single word. */
+declare function suggest(word: string, options?: {
+    language?: LanguageCode;
+    max?: number;
+}): Promise<string[]>;
+
+export { type BoundChecker, type CheckOptions, type Dictionary, LANGUAGES, type LanguageCode, type LanguageInfo, SUPPORTED_LANGUAGES, type SpellIssue, checkText, createChecker, isCorrect, isSupportedLanguage, loadDictionary, suggest, tokenize, warmup };