cspell-dictionary 7.0.0-alpha.2 → 7.0.0

package/dist/SpellingDictionary/FlagWordsDictionary.js

@@ -1,10 +1,9 @@
 import { opMap, pipe } from '@cspell/cspell-pipe/sync';
-import { buildTrieFast, parseDictionaryLines } from 'cspell-trie-lib';
+import { buildITrieFromWords, parseDictionaryLines } from 'cspell-trie-lib';
 import { createAutoResolveWeakCache } from '../util/AutoResolve.js';
 import * as Defaults from './defaults.js';
 import { defaultOptions } from './SpellingDictionary.js';
 import { SpellingDictionaryFromTrie } from './SpellingDictionaryFromTrie.js';
-import { suggestArgsToSuggestOptions } from './SpellingDictionaryMethods.js';
 import { createTyposDictionary } from './TyposDictionary.js';
 class FlagWordsDictionaryTrie extends SpellingDictionaryFromTrie {
     constructor(trie, name, source) {
@@ -76,9 +75,7 @@ class FlagWordsDictionary {
     isNoSuggestWord(word, options) {
         return this.dictTrie?.isNoSuggestWord(word, options) || this.dictTypos.isNoSuggestWord(word, options);
     }
-    suggest(...args) {
-        const [word] = args;
-        const suggestOptions = suggestArgsToSuggestOptions(args);
+    suggest(word, suggestOptions = {}) {
         return this.dictTypos.suggest(word, suggestOptions);
     }
     getPreferredSuggestions(word) {
@@ -119,7 +116,7 @@ export function createFlagWordsDictionary(wordList, name, source) {
 }
 const regExpCleanIgnore = /^(!!)+/;
 function buildTrieDict(words, name, source) {
-    const trie = buildTrieFast(pipe(words, opMap((w) => '!' + w), opMap((w) => w.replace(regExpCleanIgnore, ''))));
+    const trie = buildITrieFromWords(pipe(words, opMap((w) => '!' + w), opMap((w) => w.replace(regExpCleanIgnore, ''))));
     return new FlagWordsDictionaryTrie(trie, name, source);
 }
 function bisect(values, predicate) {

package/dist/SpellingDictionary/SpellingDictionary.d.ts

@@ -1,7 +1,7 @@
 import type { DictionaryInformation, ReplaceMap } from '@cspell/cspell-types';
-import type { CompoundWordsMethod, SuggestionCollector, SuggestionResult, WeightMap } from 'cspell-trie-lib';
+import type { SuggestionCollector, SuggestionResult, WeightMap } from 'cspell-trie-lib';
+import type { SuggestOptions } from './SuggestOptions.js';
 export type { DictionaryDefinitionInline } from '@cspell/cspell-types';
-export { CompoundWordsMethod, type SuggestionCollector, type SuggestionResult } from 'cspell-trie-lib';
 export interface SearchOptions {
     /**
      * Legacy compounds have been deprecated.
@@ -14,36 +14,6 @@ export interface SearchOptions {
      */
     ignoreCase?: boolean | undefined;
 }
-export interface SuggestOptions {
-    /**
-     * Compounding Mode.
-     * `NONE` is the best option.
-     */
-    compoundMethod?: CompoundWordsMethod | undefined;
-    /**
-     * The limit on the number of suggestions to generate. If `allowTies` is true, it is possible
-     * for more suggestions to be generated.
-     */
-    numSuggestions?: number | undefined;
-    /**
-     * Max number of changes / edits to the word to get to a suggestion matching suggestion.
-     */
-    numChanges?: number | undefined;
-    /**
-     * Allow for case-ingestive checking.
-     */
-    ignoreCase?: boolean | undefined;
-    /**
-     * If multiple suggestions have the same edit / change "cost", then included them even if
-     * it causes more than `numSuggestions` to be returned.
-     * @default false
-     */
-    includeTies?: boolean | undefined;
-    /**
-     * Maximum amount of time to allow for generating suggestions.
-     */
-    timeout?: number | undefined;
-}
 export type FindOptions = SearchOptions;
 export interface Suggestion {
     word: string;
@@ -124,21 +94,12 @@ export interface SpellingDictionary extends DictionaryInfo {
      * @param options - options
      */
     isNoSuggestWord(word: string, options: HasOptions): boolean;
-    /**
-     * Generate suggestions for a word.
-     * @param word - word
-     * @param numSuggestions - max number of suggestions to generate.
-     * @param compoundMethod - Default NONE.
-     * @param numChanges - Default 5
-     * @param ignoreCase - true
-     */
-    suggest(word: string, numSuggestions?: number, compoundMethod?: CompoundWordsMethod, numChanges?: number, ignoreCase?: boolean): SuggestionResult[];
     /**
      * Generate suggestions for a word
      * @param word - word
      * @param suggestOptions - options
      */
-    suggest(word: string, suggestOptions: SuggestOptions): SuggestionResult[];
+    suggest(word: string, suggestOptions?: SuggestOptions): SuggestionResult[];
     getPreferredSuggestions?: (word: string) => PreferredSuggestion[];
     genSuggestions(collector: SuggestionCollector, suggestOptions: SuggestOptions): void;
     mapWord(word: string): string;
@@ -153,6 +114,5 @@ export interface SpellingDictionary extends DictionaryInfo {
     readonly isDictionaryCaseSensitive: boolean;
     getErrors?(): Error[];
 }
-export type SuggestArgs = Parameters<SpellingDictionary['suggest']> | Parameters<(word: string, numSuggestions?: number, compoundMethod?: CompoundWordsMethod, numChanges?: number, ignoreCase?: boolean) => SuggestionResult[]>;
 export declare const defaultOptions: SpellingDictionaryOptions;
 //# sourceMappingURL=SpellingDictionary.d.ts.map

package/dist/SpellingDictionary/SpellingDictionary.js

@@ -1,4 +1,3 @@
-export { CompoundWordsMethod } from 'cspell-trie-lib';
 export const defaultOptions = Object.freeze({
     weightMap: undefined,
 });

package/dist/SpellingDictionary/SpellingDictionaryCollection.js

@@ -1,9 +1,8 @@
-import { CASE_INSENSITIVE_PREFIX } from 'cspell-trie-lib';
+import { CASE_INSENSITIVE_PREFIX, CompoundWordsMethod } from 'cspell-trie-lib';
 import { genSequence } from 'gensequence';
 import { isDefined } from '../util/util.js';
 import * as Defaults from './defaults.js';
-import { CompoundWordsMethod } from './SpellingDictionary.js';
-import { defaultNumSuggestions, hasOptionToSearchOption, suggestArgsToSuggestOptions, suggestionCollector, } from './SpellingDictionaryMethods.js';
+import { defaultNumSuggestions, hasOptionToSearchOption, suggestionCollector } from './SpellingDictionaryMethods.js';
 function identityString(w) {
     return w;
 }
@@ -39,9 +38,7 @@ class SpellingDictionaryCollectionImpl {
         const ignoreCase = ignoreCaseAndAccents ?? Defaults.isForbiddenIgnoreCaseAndAccents;
         return !!this._isForbiddenInDict(word, ignoreCase) && !this.isNoSuggestWord(word, { ignoreCase });
     }
-    suggest(...args) {
-        const [word] = args;
-        const suggestOptions = suggestArgsToSuggestOptions(args);
+    suggest(word, suggestOptions = {}) {
         return this._suggest(word, suggestOptions);
     }
     _suggest(word, suggestOptions) {

package/dist/SpellingDictionary/SpellingDictionaryFromTrie.d.ts

@@ -1,8 +1,9 @@
-import type { SuggestionCollector, SuggestionResult } from 'cspell-trie-lib';
-import { CompoundWordsMethod, Trie } from 'cspell-trie-lib';
-import type { FindResult, HasOptions, SpellingDictionary, SpellingDictionaryOptions, SuggestOptions } from './SpellingDictionary.js';
+/// <reference types="node" resolution-mode="require"/>
+import type { ITrie, SuggestionCollector, SuggestionResult } from 'cspell-trie-lib';
+import type { FindResult, HasOptions, SpellingDictionary, SpellingDictionaryOptions } from './SpellingDictionary.js';
+import type { SuggestOptions } from './SuggestOptions.js';
 export declare class SpellingDictionaryFromTrie implements SpellingDictionary {
-    readonly trie: Trie;
+    readonly trie: ITrie;
     readonly name: string;
     readonly options: SpellingDictionaryOptions;
     readonly source: string;
@@ -16,7 +17,7 @@ export declare class SpellingDictionaryFromTrie implements SpellingDictionary {
     readonly isDictionaryCaseSensitive: boolean;
     readonly containsNoSuggestWords: boolean;
     private weightMap;
-    constructor(trie: Trie, name: string, options: SpellingDictionaryOptions, source?: string, size?: number);
+    constructor(trie: ITrie, name: string, options: SpellingDictionaryOptions, source?: string, size?: number);
     get size(): number;
     has(word: string, hasOptions?: HasOptions): boolean;
     find(word: string, hasOptions?: HasOptions): FindResult | undefined;
@@ -27,8 +28,7 @@ export declare class SpellingDictionaryFromTrie implements SpellingDictionary {
     isNoSuggestWord(word: string, options?: HasOptions): boolean;
     isForbidden(word: string, _ignoreCaseAndAccents?: boolean): boolean;
     private _isForbidden;
-    suggest(word: string, numSuggestions?: number, compoundMethod?: CompoundWordsMethod, numChanges?: number, ignoreCase?: boolean): SuggestionResult[];
-    suggest(word: string, suggestOptions: SuggestOptions): SuggestionResult[];
+    suggest(word: string, suggestOptions?: SuggestOptions): SuggestionResult[];
     private _suggest;
     genSuggestions(collector: SuggestionCollector, suggestOptions: SuggestOptions): void;
     getErrors(): Error[];
@@ -41,7 +41,7 @@ export declare class SpellingDictionaryFromTrie implements SpellingDictionary {
  * @param options - options.
  * @returns SpellingDictionary
  */
-export declare function createSpellingDictionaryFromTrieFile(data: Iterable<string> | string, name: string, source: string, options: SpellingDictionaryOptions): SpellingDictionary;
+export declare function createSpellingDictionaryFromTrieFile(data: string | Buffer, name: string, source: string, options: SpellingDictionaryOptions): SpellingDictionary;
 declare function outerWordForms(word: string, mapWord: (word: string) => string[]): Set<string>;
 export declare const __testing__: {
     outerWordForms: typeof outerWordForms;

package/dist/SpellingDictionary/SpellingDictionaryFromTrie.js

@@ -1,13 +1,13 @@
 import { opConcatMap, pipe } from '@cspell/cspell-pipe/sync';
-import { CompoundWordsMethod, importTrie, suggestionCollector, Trie } from 'cspell-trie-lib';
+import { CompoundWordsMethod, decodeTrie, suggestionCollector } from 'cspell-trie-lib';
 import { autoCache, createCache01 } from '../util/AutoCache.js';
 import { clean } from '../util/clean.js';
 import { createMapper, createRepMapper } from '../util/repMap.js';
 import * as Defaults from './defaults.js';
-import { createWeightMapFromDictionaryInformation, defaultNumSuggestions, hasOptionToSearchOption, impersonateCollector, suggestArgsToSuggestOptions, wordSearchForms, wordSuggestFormsArray, } from './SpellingDictionaryMethods.js';
+import { createWeightMapFromDictionaryInformation, defaultNumSuggestions, hasOptionToSearchOption, impersonateCollector, wordSearchForms, wordSuggestFormsArray, } from './SpellingDictionaryMethods.js';
 const findWordOptionsCaseSensitive = Object.freeze({ caseSensitive: true });
 const findWordOptionsNotCaseSensitive = Object.freeze({ caseSensitive: false });
-class SpellingDictionaryFromTrie {
+export class SpellingDictionaryFromTrie {
     constructor(trie, name, options, source = 'from trie', size) {
         this.trie = trie;
         this.name = name;
@@ -23,7 +23,7 @@ class SpellingDictionaryFromTrie {
         });
         this.mapWord = createMapper(options.repMap, options.dictionaryInformation?.ignore);
         this.remapWord = createRepMapper(options.repMap, options.dictionaryInformation?.ignore);
-        this.isDictionaryCaseSensitive = options.caseSensitive ?? !trie.isLegacy;
+        this.isDictionaryCaseSensitive = options.caseSensitive ?? trie.isCaseAware;
         this.containsNoSuggestWords = options.noSuggest || false;
         this._size = size || 0;
         this.weightMap = options.weightMap || createWeightMapFromDictionaryInformation(options.dictionaryInformation);
@@ -102,9 +102,7 @@ class SpellingDictionaryFromTrie {
     isForbidden(word, _ignoreCaseAndAccents) {
         return this._isForbidden(word);
     }
-    suggest(...args) {
-        const [word] = args;
-        const suggestOptions = suggestArgsToSuggestOptions(args);
+    suggest(word, suggestOptions = {}) {
         return this._suggest(word, suggestOptions);
     }
     _suggest(word, suggestOptions) {
@@ -136,7 +134,6 @@ class SpellingDictionaryFromTrie {
     }
 }
 SpellingDictionaryFromTrie.cachedWordsLimit = 50000;
-export { SpellingDictionaryFromTrie };
 /**
  * Create a dictionary from a trie file.
  * @param data - contents of a trie file.
@@ -146,9 +143,7 @@ export { SpellingDictionaryFromTrie };
  * @returns SpellingDictionary
  */
 export function createSpellingDictionaryFromTrieFile(data, name, source, options) {
-    data = typeof data === 'string' ? data.split('\n') : data;
-    const trieNode = importTrie(data);
-    const trie = new Trie(trieNode);
+    const trie = decodeTrie(data);
     return new SpellingDictionaryFromTrie(trie, name, options, source);
 }
 function findCache(fn, size = 2000) {

package/dist/SpellingDictionary/SpellingDictionaryMethods.d.ts

@@ -1,6 +1,6 @@
 import type { DictionaryInformation } from '@cspell/cspell-types';
 import type { SuggestionResult, WeightMap } from 'cspell-trie-lib';
-import type { HasOptions, SearchOptions, SuggestArgs, SuggestOptions } from './SpellingDictionary.js';
+import type { HasOptions, SearchOptions } from './SpellingDictionary.js';
 export { impersonateCollector, suggestionCollector } from 'cspell-trie-lib';
 export type FilterSuggestionsPredicate = (word: SuggestionResult) => boolean;
 export declare const defaultNumSuggestions = 10;
@@ -15,7 +15,6 @@ export declare function hasOptionToSearchOption(opt: HasOptions | undefined): Se
  * @returns SearchOptions - the canonical form
  */
 export declare function canonicalSearchOptions(opt: SearchOptions): SearchOptions;
-export declare function suggestArgsToSuggestOptions(args: SuggestArgs): SuggestOptions;
 export declare function createWeightMapFromDictionaryInformation(di: undefined): undefined;
 export declare function createWeightMapFromDictionaryInformation(di: DictionaryInformation): WeightMap;
 export declare function createWeightMapFromDictionaryInformation(di: DictionaryInformation | undefined): WeightMap | undefined;

package/dist/SpellingDictionary/SpellingDictionaryMethods.js

@@ -75,18 +75,6 @@ export function canonicalSearchOptions(opt) {
     knownCanonicalOptions.set(opt, canOpts);
     return canOpts;
 }
-export function suggestArgsToSuggestOptions(args) {
-    const [_word, options, compoundMethod, numChanges, ignoreCase] = args;
-    const suggestOptions = typeof options === 'object'
-        ? options
-        : {
-            numSuggestions: options,
-            compoundMethod,
-            numChanges,
-            ignoreCase,
-        };
-    return suggestOptions;
-}
 export function createWeightMapFromDictionaryInformation(di) {
     return di ? mapDictionaryInformationToWeightMap(di) : undefined;
 }

package/dist/SpellingDictionary/SuggestOptions.d.ts

@@ -0,0 +1,33 @@
+import type { CompoundWordsMethod } from 'cspell-trie-lib';
+export interface SuggestOptions {
+    /**
+     * Compounding Mode.
+     * `NONE` is the best option.
+     */
+    compoundMethod?: CompoundWordsMethod | undefined;
+    /**
+     * The limit on the number of suggestions to generate. If `allowTies` is true, it is possible
+     * for more suggestions to be generated.
+     */
+    numSuggestions?: number | undefined;
+    /**
+     * Max number of changes / edits to the word to get to a suggestion matching suggestion.
+     */
+    numChanges?: number | undefined;
+    /**
+     * Allow for case-ingestive checking.
+     */
+    ignoreCase?: boolean | undefined;
+    /**
+     * If multiple suggestions have the same edit / change "cost", then included them even if
+     * it causes more than `numSuggestions` to be returned.
+     * @default false
+     */
+    includeTies?: boolean | undefined;
+    /**
+     * Maximum amount of time to allow for generating suggestions.
+     */
+    timeout?: number | undefined;
+}
+export declare function createSuggestOptions(numSuggestions?: number, compoundMethod?: CompoundWordsMethod, numChanges?: number, ignoreCase?: boolean): SuggestOptions;
+//# sourceMappingURL=SuggestOptions.d.ts.map

package/dist/SpellingDictionary/SuggestOptions.js

@@ -0,0 +1,8 @@
+export function createSuggestOptions(numSuggestions, compoundMethod, numChanges, ignoreCase) {
+    return {
+        numSuggestions,
+        compoundMethod,
+        numChanges,
+        ignoreCase,
+    };
+}

package/dist/SpellingDictionary/createSpellingDictionary.js

@@ -1,4 +1,4 @@
-import { buildTrieFast, parseDictionaryLines } from 'cspell-trie-lib';
+import { buildITrieFromWords, parseDictionaryLines } from 'cspell-trie-lib';
 import { deepEqual } from 'fast-equals';
 import { AutoWeakCache, SimpleCache } from '../util/simpleCache.js';
 import { defaultOptions } from './SpellingDictionary.js';
@@ -37,7 +37,7 @@ function _createSpellingDictionary(params) {
     // console.log(`createSpellingDictionary ${name} ${source}`);
     const parseOptions = { stripCaseAndAccents: options?.supportNonStrictSearches ?? true };
     const words = parseDictionaryLines(wordList, parseOptions);
-    const trie = buildTrieFast(words);
+    const trie = buildITrieFromWords(words);
     const opts = { ...(options || defaultOptions) };
     if (opts.weightMap === undefined && opts.dictionaryInformation) {
         opts.weightMap = createWeightMapFromDictionaryInformation(opts.dictionaryInformation);

package/dist/SpellingDictionary/index.d.ts

@@ -3,9 +3,12 @@ export { createInlineSpellingDictionary } from './createInlineSpellingDictionary
 export { createFailedToLoadDictionary, createSpellingDictionary } from './createSpellingDictionary.js';
 export { createFlagWordsDictionary, createFlagWordsDictionary as createForbiddenWordsDictionary, } from './FlagWordsDictionary.js';
 export { createIgnoreWordsDictionary } from './IgnoreWordsDictionary.js';
-export type { DictionaryDefinitionInline, FindOptions, FindResult, HasOptions, SearchOptions, SpellingDictionary, SpellingDictionaryOptions, SuggestionCollector, SuggestionResult, SuggestOptions, } from './SpellingDictionary.js';
+export type { DictionaryDefinitionInline, FindOptions, FindResult, HasOptions, SearchOptions, SpellingDictionary, SpellingDictionaryOptions, } from './SpellingDictionary.js';
 export { createCollection, SpellingDictionaryCollection } from './SpellingDictionaryCollection.js';
 export { createSpellingDictionaryFromTrieFile } from './SpellingDictionaryFromTrie.js';
 export { createSuggestDictionary } from './SuggestDictionary.js';
+export type { SuggestOptions } from './SuggestOptions.js';
+export { createSuggestOptions } from './SuggestOptions.js';
 export { createTyposDictionary } from './TyposDictionary.js';
+export { CompoundWordsMethod, type SuggestionCollector, type SuggestionResult } from 'cspell-trie-lib';
 //# sourceMappingURL=index.d.ts.map

package/dist/SpellingDictionary/index.js

@@ -6,4 +6,6 @@ export { createIgnoreWordsDictionary } from './IgnoreWordsDictionary.js';
 export { createCollection } from './SpellingDictionaryCollection.js';
 export { createSpellingDictionaryFromTrieFile } from './SpellingDictionaryFromTrie.js';
 export { createSuggestDictionary } from './SuggestDictionary.js';
+export { createSuggestOptions } from './SuggestOptions.js';
 export { createTyposDictionary } from './TyposDictionary.js';
+export { CompoundWordsMethod } from 'cspell-trie-lib';

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export type { CachingDictionary, FindOptions, FindResult, HasOptions, SearchOptions, SpellingDictionary, SpellingDictionaryCollection, SpellingDictionaryOptions, SuggestionCollector, SuggestionResult, SuggestOptions, } from './SpellingDictionary/index.js';
-export { createCachingDictionary, createCollection, createFailedToLoadDictionary, createFlagWordsDictionary, createForbiddenWordsDictionary, createIgnoreWordsDictionary, createInlineSpellingDictionary, createSpellingDictionary, createSpellingDictionaryFromTrieFile, createSuggestDictionary, } from './SpellingDictionary/index.js';
+export { createCachingDictionary, createCollection, createFailedToLoadDictionary, createFlagWordsDictionary, createForbiddenWordsDictionary, createIgnoreWordsDictionary, createInlineSpellingDictionary, createSpellingDictionary, createSpellingDictionaryFromTrieFile, createSuggestDictionary, createSuggestOptions, } from './SpellingDictionary/index.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1 +1 @@
-export { createCachingDictionary, createCollection, createFailedToLoadDictionary, createFlagWordsDictionary, createForbiddenWordsDictionary, createIgnoreWordsDictionary, createInlineSpellingDictionary, createSpellingDictionary, createSpellingDictionaryFromTrieFile, createSuggestDictionary, } from './SpellingDictionary/index.js';
+export { createCachingDictionary, createCollection, createFailedToLoadDictionary, createFlagWordsDictionary, createForbiddenWordsDictionary, createIgnoreWordsDictionary, createInlineSpellingDictionary, createSpellingDictionary, createSpellingDictionaryFromTrieFile, createSuggestDictionary, createSuggestOptions, } from './SpellingDictionary/index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell-dictionary",
-  "version": "7.0.0-alpha.2",
+  "version": "7.0.0",
   "description": "A spelling dictionary library useful for checking words and getting suggestions.",
   "type": "module",
   "types": "dist/index.d.ts",
@@ -47,11 +47,11 @@
     "node": ">=16"
   },
   "dependencies": {
-    "@cspell/cspell-pipe": "7.0.0-alpha.2",
-    "@cspell/cspell-types": "7.0.0-alpha.2",
-    "cspell-trie-lib": "7.0.0-alpha.2",
+    "@cspell/cspell-pipe": "7.0.0",
+    "@cspell/cspell-types": "7.0.0",
+    "cspell-trie-lib": "7.0.0",
     "fast-equals": "^4.0.3",
     "gensequence": "^5.0.2"
   },
-  "gitHead": "a1b7c5daeef5afdb14d6444318f450b9fd9c035a"
+  "gitHead": "52960d5ed75655978f9b633f44fd106937a63cd7"
 }