@keymanapp/kmc-model 17.0.256-alpha → 17.0.258-alpha

package/build/src/build-trie.d.ts

@@ -1,42 +1,40 @@
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="82977ed1-376e-5f0d-8872-7a0c42176370")}catch(e){}}();
-/**
- * A word list is (conceptually) an array of pairs: the concrete word form itself + a
- * non-negative count.
- *
- * Since each word should only appear once within the list, we represent it with
- * an associative array pattern keyed by the wordform.
- */
-export type WordList = {
-    [wordform: string]: number;
-};
-/**
- * Returns a data structure that can be loaded by the TrieModel.
- *
- * It implements a **weighted** trie, whose indices (paths down the trie) are
- * generated by a search key, and not concrete wordforms themselves.
- *
- * @param sourceFiles an array of source files that will be read to generate the trie.
- */
-export declare function createTrieDataStructure(filenames: string[], searchTermToKey?: (wf: string) => string): string;
-/**
- * Parses a word list from a file, merging duplicate entries.
- *
- * The word list may be encoded in:
- *
- *  - UTF-8, with or without BOM [exported by most software]
- *  - UTF-16, little endian, with BOM [exported by Microsoft Excel]
- *
- * @param wordlist word list to merge entries into (may have existing entries)
- * @param filename filename of the word list
- */
-export declare function parseWordListFromFilename(wordlist: WordList, filename: string): void;
-/**
- * Parses a word list from a string. The string should have multiple lines
- * with LF or CRLF line terminators.
- *
- * @param wordlist word list to merge entries into (may have existing entries)
- * @param filename filename of the word list
- */
-export declare function parseWordListFromContents(wordlist: WordList, contents: string): void;
-//# debugId=82977ed1-376e-5f0d-8872-7a0c42176370
-//# sourceMappingURL=build-trie.d.ts.map
+/**
+ * A word list is (conceptually) an array of pairs: the concrete word form itself + a
+ * non-negative count.
+ *
+ * Since each word should only appear once within the list, we represent it with
+ * an associative array pattern keyed by the wordform.
+ */
+export type WordList = {
+    [wordform: string]: number;
+};
+/**
+ * Returns a data structure that can be loaded by the TrieModel.
+ *
+ * It implements a **weighted** trie, whose indices (paths down the trie) are
+ * generated by a search key, and not concrete wordforms themselves.
+ *
+ * @param sourceFiles an array of source files that will be read to generate the trie.
+ */
+export declare function createTrieDataStructure(filenames: string[], searchTermToKey?: (wf: string) => string): string;
+/**
+ * Parses a word list from a file, merging duplicate entries.
+ *
+ * The word list may be encoded in:
+ *
+ *  - UTF-8, with or without BOM [exported by most software]
+ *  - UTF-16, little endian, with BOM [exported by Microsoft Excel]
+ *
+ * @param wordlist word list to merge entries into (may have existing entries)
+ * @param filename filename of the word list
+ */
+export declare function parseWordListFromFilename(wordlist: WordList, filename: string): void;
+/**
+ * Parses a word list from a string. The string should have multiple lines
+ * with LF or CRLF line terminators.
+ *
+ * @param wordlist word list to merge entries into (may have existing entries)
+ * @param filename filename of the word list
+ */
+export declare function parseWordListFromContents(wordlist: WordList, contents: string): void;
+//# sourceMappingURL=build-trie.d.ts.map

package/build/src/build-trie.d.ts.map

@@ -1 +1 @@
-{"debug_id":"82977ed1-376e-5f0d-8872-7a0c42176370","file":"build-trie.d.ts","mappings":";AAMA;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,GAAG;IAAC,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;CAAC,CAAC;AAEpD;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,eAAe,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,MAAM,GAAG,MAAM,CAU7G;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAGpF;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAGpF","names":[],"sourceRoot":"","sources":["../../src/build-trie.ts"],"version":3}
+{"version":3,"file":"build-trie.d.ts","sourceRoot":"","sources":["../../src/build-trie.ts"],"names":[],"mappings":"AAMA;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,GAAG;IAAC,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;CAAC,CAAC;AAEpD;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,eAAe,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,MAAM,GAAG,MAAM,CAU7G;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAGpF;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAGpF"}

package/build/src/compiler-callbacks.d.ts

@@ -1,6 +1,4 @@
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="5109171c-973d-5245-a6d1-34f3dcd574be")}catch(e){}}();
-import { CompilerCallbacks } from "@keymanapp/common-types";
-export declare let callbacks: CompilerCallbacks;
-export declare function setCompilerCallbacks(c: CompilerCallbacks): void;
-//# debugId=5109171c-973d-5245-a6d1-34f3dcd574be
-//# sourceMappingURL=compiler-callbacks.d.ts.map
+import { CompilerCallbacks } from "@keymanapp/common-types";
+export declare let callbacks: CompilerCallbacks;
+export declare function setCompilerCallbacks(c: CompilerCallbacks): void;
+//# sourceMappingURL=compiler-callbacks.d.ts.map

package/build/src/compiler-callbacks.d.ts.map

@@ -1 +1 @@
-{"debug_id":"5109171c-973d-5245-a6d1-34f3dcd574be","file":"compiler-callbacks.d.ts","mappings":";AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAE5D,eAAO,IAAI,SAAS,EAAE,iBAAiB,CAAC;AAExC,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,iBAAiB,QAExD","names":[],"sourceRoot":"","sources":["../../src/compiler-callbacks.ts"],"version":3}
+{"version":3,"file":"compiler-callbacks.d.ts","sourceRoot":"","sources":["../../src/compiler-callbacks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAE5D,eAAO,IAAI,SAAS,EAAE,iBAAiB,CAAC;AAExC,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,iBAAiB,QAExD"}

package/build/src/join-word-breaker-decorator.d.ts

@@ -1,12 +1,10 @@
-/// <reference types="@keymanapp/models-types" />
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="ca1f6008-5474-5b1f-a8e0-5e03178980fa")}catch(e){}}();
-/**
- * Returns a word breaker that joins spans of an existing word breaker.
- * Spans are joined if they are connected by a delimiter.
- *
- * @param breaker The word breaker whose results will be decorated.
- * @param joiners What delimiters should be used to join spans.
- */
-export declare function decorateWithJoin(breaker: WordBreakingFunction, joiners: string[]): WordBreakingFunction;
-//# debugId=ca1f6008-5474-5b1f-a8e0-5e03178980fa
-//# sourceMappingURL=join-word-breaker-decorator.d.ts.map
+/// <reference types="@keymanapp/models-types" />
+/**
+ * Returns a word breaker that joins spans of an existing word breaker.
+ * Spans are joined if they are connected by a delimiter.
+ *
+ * @param breaker The word breaker whose results will be decorated.
+ * @param joiners What delimiters should be used to join spans.
+ */
+export declare function decorateWithJoin(breaker: WordBreakingFunction, joiners: string[]): WordBreakingFunction;
+//# sourceMappingURL=join-word-breaker-decorator.d.ts.map

package/build/src/join-word-breaker-decorator.d.ts.map

@@ -1 +1 @@
-{"debug_id":"ca1f6008-5474-5b1f-a8e0-5e03178980fa","file":"join-word-breaker-decorator.d.ts","mappings":";;AAEA;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,oBAAoB,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,oBAAoB,CA4HvG","names":[],"sourceRoot":"","sources":["../../src/join-word-breaker-decorator.ts"],"version":3}
+{"version":3,"file":"join-word-breaker-decorator.d.ts","sourceRoot":"","sources":["../../src/join-word-breaker-decorator.ts"],"names":[],"mappings":";AAEA;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,oBAAoB,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,oBAAoB,CA4HvG"}

package/build/src/lexical-model-compiler.d.ts

@@ -1,33 +1,31 @@
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="1bc80df3-48dc-5244-9634-1f202c49337f")}catch(e){}}();
-import { LexicalModelSource } from "./lexical-model.js";
-import { CompilerCallbacks, CompilerOptions, KeymanCompiler, KeymanCompilerArtifact, KeymanCompilerArtifacts, KeymanCompilerResult } from "@keymanapp/common-types";
-export interface LexicalModelCompilerArtifacts extends KeymanCompilerArtifacts {
-    js: KeymanCompilerArtifact;
-}
-export interface LexicalModelCompilerResult extends KeymanCompilerResult {
-    artifacts: LexicalModelCompilerArtifacts;
-}
-export declare class LexicalModelCompiler implements KeymanCompiler {
-    init(callbacks: CompilerCallbacks, _options: CompilerOptions): Promise<boolean>;
-    run(inputFilename: string, outputFilename?: string): Promise<LexicalModelCompilerResult>;
-    write(artifacts: LexicalModelCompilerArtifacts): Promise<boolean>;
-    /**
-     * Loads a lexical model's source module from the given filename.
-     *
-     * @param filename path to the model source file.
-     */
-    loadFromFilename(filename: string): LexicalModelSource;
-    /**
-     * Returns the generated code for the model that will ultimately be loaded by
-     * the LMLayer worker. This code contains all model parameters, and specifies
-     * word breakers and auxilary functions that may be required.
-     *
-     * @param model_id      The model ID. TODO: not sure if this is actually required!
-     * @param modelSource   A specification of the model to compile
-     * @param sourcePath    Where to find auxilary sources files
-     */
-    generateLexicalModelCode(model_id: string, modelSource: LexicalModelSource, sourcePath: string): string;
-    transpileSources(sources: Array<string>): Array<string>;
-}
-//# debugId=1bc80df3-48dc-5244-9634-1f202c49337f
-//# sourceMappingURL=lexical-model-compiler.d.ts.map
+import { LexicalModelSource } from "./lexical-model.js";
+import { CompilerCallbacks, CompilerOptions, KeymanCompiler, KeymanCompilerArtifact, KeymanCompilerArtifacts, KeymanCompilerResult } from "@keymanapp/common-types";
+export interface LexicalModelCompilerArtifacts extends KeymanCompilerArtifacts {
+    js: KeymanCompilerArtifact;
+}
+export interface LexicalModelCompilerResult extends KeymanCompilerResult {
+    artifacts: LexicalModelCompilerArtifacts;
+}
+export declare class LexicalModelCompiler implements KeymanCompiler {
+    init(callbacks: CompilerCallbacks, _options: CompilerOptions): Promise<boolean>;
+    run(inputFilename: string, outputFilename?: string): Promise<LexicalModelCompilerResult>;
+    write(artifacts: LexicalModelCompilerArtifacts): Promise<boolean>;
+    /**
+     * Loads a lexical model's source module from the given filename.
+     *
+     * @param filename path to the model source file.
+     */
+    loadFromFilename(filename: string): LexicalModelSource;
+    /**
+     * Returns the generated code for the model that will ultimately be loaded by
+     * the LMLayer worker. This code contains all model parameters, and specifies
+     * word breakers and auxilary functions that may be required.
+     *
+     * @param model_id      The model ID. TODO: not sure if this is actually required!
+     * @param modelSource   A specification of the model to compile
+     * @param sourcePath    Where to find auxilary sources files
+     */
+    generateLexicalModelCode(model_id: string, modelSource: LexicalModelSource, sourcePath: string): string;
+    transpileSources(sources: Array<string>): Array<string>;
+}
+//# sourceMappingURL=lexical-model-compiler.d.ts.map

package/build/src/lexical-model-compiler.d.ts.map

@@ -1 +1 @@
-{"debug_id":"1bc80df3-48dc-5244-9634-1f202c49337f","file":"lexical-model-compiler.d.ts","mappings":";AASA,OAAO,EAAE,kBAAkB,EAA0C,MAAM,oBAAoB,CAAC;AAGhG,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,cAAc,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAWpK,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC5E,EAAE,EAAE,sBAAsB,CAAC;CAC5B;AAED,MAAM,WAAW,0BAA2B,SAAQ,oBAAoB;IACtE,SAAS,EAAE,6BAA6B,CAAC;CAC1C;AAED,qBAAa,oBAAqB,YAAW,cAAc;IAEnD,IAAI,CAAC,SAAS,EAAE,iBAAiB,EAAE,QAAQ,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAK/E,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAwBxF,KAAK,CAAC,SAAS,EAAE,6BAA6B,GAAG,OAAO,CAAC,OAAO,CAAC;IAKvE;;;;OAIG;IACI,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,kBAAkB;IA8B7D;;;;;;;;OAQG;IACH,wBAAwB,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM;IAiE9F,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;CAUxD","names":[],"sourceRoot":"","sources":["../../src/lexical-model-compiler.ts"],"version":3}
+{"version":3,"file":"lexical-model-compiler.d.ts","sourceRoot":"","sources":["../../src/lexical-model-compiler.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,kBAAkB,EAA0C,MAAM,oBAAoB,CAAC;AAGhG,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,cAAc,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAWpK,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC5E,EAAE,EAAE,sBAAsB,CAAC;CAC5B;AAED,MAAM,WAAW,0BAA2B,SAAQ,oBAAoB;IACtE,SAAS,EAAE,6BAA6B,CAAC;CAC1C;AAED,qBAAa,oBAAqB,YAAW,cAAc;IAEnD,IAAI,CAAC,SAAS,EAAE,iBAAiB,EAAE,QAAQ,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAK/E,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAwBxF,KAAK,CAAC,SAAS,EAAE,6BAA6B,GAAG,OAAO,CAAC,OAAO,CAAC;IAKvE;;;;OAIG;IACI,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,kBAAkB;IA8B7D;;;;;;;;OAQG;IACH,wBAAwB,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM;IAiE9F,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;CAUxD"}

package/build/src/lexical-model.d.ts

@@ -1,137 +1,135 @@
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="94f66ee3-becb-53a9-9cc1-28e99f0ada0e")}catch(e){}}();
-/**
- * Interfaces and constants used by the lexical model compiler. These target
- * the LMLayer's internal worker code, so we provide those definitions too.
- */
-/// <reference types="@keymanapp/models-types" />
-export interface LexicalModelDeclaration {
-    readonly format: 'trie-1.0' | 'fst-foma-1.0' | 'custom-1.0';
-}
-/**
- * Keyman 14.0+ word breaker specification:
- *
- * Can support all old word breaking specification,
- * but can also be extended with options.
- *
- * @since 14.0
- */
-export interface WordBreakerSpec {
-    readonly use: SimpleWordBreakerSpec;
-    /**
-     * If present, joins words that were split by the word breaker
-     * together at the given strings. e.g.,
-     *
-     *    joinWordsAt: ['-'] // to keep hyphenated items together
-     *
-     * @since 14.0
-     */
-    readonly joinWordsAt?: string[];
-    /**
-     * Overrides word splitting behaviour for certain scripts.
-     * For example, specifing that spaces break words in certain South-East
-     * Asian scripts that otherwise do not use spaces.
-     *
-     * @since 14.0
-     */
-    readonly overrideScriptDefaults?: OverrideScriptDefaults;
-}
-/**
- * Simplified word breaker specification.
- *
- * @since 11.0
- */
-export type SimpleWordBreakerSpec = 'default' | 'ascii' | WordBreakingFunction;
-/**
- * Simplifies input text to facilitate finding entries within a lexical model's
- * lexicon.
- * @since 11.0
- */
-export type SimpleWordformToKeySpec = (term: string) => string;
-/**
- * Simplifies input text to facilitate finding entries within a lexical model's
- * lexicon, using the model's `applyCasing` function to assist in the keying process.
- * @since 14.0
- */
-export type CasedWordformToKeySpec = (term: string, applyCasing?: CasingFunction) => string;
-/**
- * Simplifies input text to facilitate finding entries within a lexical model's
- * lexicon.
- */
-export type WordformToKeySpec = SimpleWordformToKeySpec | CasedWordformToKeySpec;
-/**
- * Override the default word breaking behaviour for some scripts.
- *
- * There is currently only one option:
- *
- * 'break-words-at-spaces'
- * : some South-East Asian scripts conventionally do not use space or any
- * explicit word boundary character to write word breaks. These scripts are:
- *
- *   * Burmese
- *   * Khmer
- *   * Thai
- *   * Laos
- *
- * (this list may be incomplete and extended in the future)
- *
- * For these scripts, the default word breaker breaks at **every**
- * letter/syllable/ideograph. However, in languages that use these scripts BUT
- * use spaces (or some other delimier) as word breaks, enable
- * 'break-words-at-spaces'; enabling 'break-words-at-spaces' prevents the word
- * breaker from making too many breaks in these scripts.
- *
- * @since 14.0
- */
-export type OverrideScriptDefaults = 'break-words-at-spaces';
-export interface LexicalModelSource extends LexicalModelDeclaration {
-    readonly sources: Array<string>;
-    /**
-     * The name of the type to instantiate (without parameters) as the base object for a custom predictive model.
-     */
-    readonly rootClass?: string;
-    /**
-     * When set to `true`, suggestions will attempt to match the case of the input text even if
-     * the lexicon entries use a different casing scheme due to search term keying effects.
-     * @since 14.0
-     */
-    readonly languageUsesCasing?: boolean;
-    /**
-     * Specifies the casing rules for a language.  Should implement three casing forms:
-     * - 'lower' -- a fully-lowercased version of the text appropriate for the language's
-     *   use of the writing system.
-     * - 'upper' -- a fully-uppercased version of the text
-     * - 'initial' -- a version preserving the input casing aside from the initial character,
-     *   which is uppercased (like with proper nouns and sentence-initial words in English
-     *   sentences.)
-     *
-     * This is only utilized if `languageUsesCasing` is defined and set to `true`.
-     * @since 14.0
-     */
-    readonly applyCasing?: CasingFunction;
-    /**
-     * Which word breaker to use. Choose from:
-     *
-     *  - 'default' -- breaks according to Unicode UAX #29 §4.1 Default Word
-     *    Boundary Specification, which works well for *most* languages.
-     *  - 'ascii' -- a very simple word breaker, for demonstration purposes only.
-     *  - word breaking function -- provide your own function that breaks words.
-     *  - class-based word-breaker - may be supported in the future.
-     */
-    readonly wordBreaker?: WordBreakerSpec | SimpleWordBreakerSpec;
-    /**
-     * How to simplify words, to convert them into simplified search keys
-     * This often involves removing accents, lowercasing, etc.
-     */
-    readonly searchTermToKey?: WordformToKeySpec;
-    /**
-     * Punctuation and spacing suggested by the model.
-     *
-     * @see LexicalModelPunctuation
-     */
-    readonly punctuation?: LexicalModelPunctuation;
-}
-export interface LexicalModelCompiled extends LexicalModelDeclaration {
-    readonly id: string;
-}
-//# debugId=94f66ee3-becb-53a9-9cc1-28e99f0ada0e
-//# sourceMappingURL=lexical-model.d.ts.map
+/**
+ * Interfaces and constants used by the lexical model compiler. These target
+ * the LMLayer's internal worker code, so we provide those definitions too.
+ */
+/// <reference types="@keymanapp/models-types" />
+export interface LexicalModelDeclaration {
+    readonly format: 'trie-1.0' | 'fst-foma-1.0' | 'custom-1.0';
+}
+/**
+ * Keyman 14.0+ word breaker specification:
+ *
+ * Can support all old word breaking specification,
+ * but can also be extended with options.
+ *
+ * @since 14.0
+ */
+export interface WordBreakerSpec {
+    readonly use: SimpleWordBreakerSpec;
+    /**
+     * If present, joins words that were split by the word breaker
+     * together at the given strings. e.g.,
+     *
+     *    joinWordsAt: ['-'] // to keep hyphenated items together
+     *
+     * @since 14.0
+     */
+    readonly joinWordsAt?: string[];
+    /**
+     * Overrides word splitting behaviour for certain scripts.
+     * For example, specifing that spaces break words in certain South-East
+     * Asian scripts that otherwise do not use spaces.
+     *
+     * @since 14.0
+     */
+    readonly overrideScriptDefaults?: OverrideScriptDefaults;
+}
+/**
+ * Simplified word breaker specification.
+ *
+ * @since 11.0
+ */
+export type SimpleWordBreakerSpec = 'default' | 'ascii' | WordBreakingFunction;
+/**
+ * Simplifies input text to facilitate finding entries within a lexical model's
+ * lexicon.
+ * @since 11.0
+ */
+export type SimpleWordformToKeySpec = (term: string) => string;
+/**
+ * Simplifies input text to facilitate finding entries within a lexical model's
+ * lexicon, using the model's `applyCasing` function to assist in the keying process.
+ * @since 14.0
+ */
+export type CasedWordformToKeySpec = (term: string, applyCasing?: CasingFunction) => string;
+/**
+ * Simplifies input text to facilitate finding entries within a lexical model's
+ * lexicon.
+ */
+export type WordformToKeySpec = SimpleWordformToKeySpec | CasedWordformToKeySpec;
+/**
+ * Override the default word breaking behaviour for some scripts.
+ *
+ * There is currently only one option:
+ *
+ * 'break-words-at-spaces'
+ * : some South-East Asian scripts conventionally do not use space or any
+ * explicit word boundary character to write word breaks. These scripts are:
+ *
+ *   * Burmese
+ *   * Khmer
+ *   * Thai
+ *   * Laos
+ *
+ * (this list may be incomplete and extended in the future)
+ *
+ * For these scripts, the default word breaker breaks at **every**
+ * letter/syllable/ideograph. However, in languages that use these scripts BUT
+ * use spaces (or some other delimier) as word breaks, enable
+ * 'break-words-at-spaces'; enabling 'break-words-at-spaces' prevents the word
+ * breaker from making too many breaks in these scripts.
+ *
+ * @since 14.0
+ */
+export type OverrideScriptDefaults = 'break-words-at-spaces';
+export interface LexicalModelSource extends LexicalModelDeclaration {
+    readonly sources: Array<string>;
+    /**
+     * The name of the type to instantiate (without parameters) as the base object for a custom predictive model.
+     */
+    readonly rootClass?: string;
+    /**
+     * When set to `true`, suggestions will attempt to match the case of the input text even if
+     * the lexicon entries use a different casing scheme due to search term keying effects.
+     * @since 14.0
+     */
+    readonly languageUsesCasing?: boolean;
+    /**
+     * Specifies the casing rules for a language.  Should implement three casing forms:
+     * - 'lower' -- a fully-lowercased version of the text appropriate for the language's
+     *   use of the writing system.
+     * - 'upper' -- a fully-uppercased version of the text
+     * - 'initial' -- a version preserving the input casing aside from the initial character,
+     *   which is uppercased (like with proper nouns and sentence-initial words in English
+     *   sentences.)
+     *
+     * This is only utilized if `languageUsesCasing` is defined and set to `true`.
+     * @since 14.0
+     */
+    readonly applyCasing?: CasingFunction;
+    /**
+     * Which word breaker to use. Choose from:
+     *
+     *  - 'default' -- breaks according to Unicode UAX #29 §4.1 Default Word
+     *    Boundary Specification, which works well for *most* languages.
+     *  - 'ascii' -- a very simple word breaker, for demonstration purposes only.
+     *  - word breaking function -- provide your own function that breaks words.
+     *  - class-based word-breaker - may be supported in the future.
+     */
+    readonly wordBreaker?: WordBreakerSpec | SimpleWordBreakerSpec;
+    /**
+     * How to simplify words, to convert them into simplified search keys
+     * This often involves removing accents, lowercasing, etc.
+     */
+    readonly searchTermToKey?: WordformToKeySpec;
+    /**
+     * Punctuation and spacing suggested by the model.
+     *
+     * @see LexicalModelPunctuation
+     */
+    readonly punctuation?: LexicalModelPunctuation;
+}
+export interface LexicalModelCompiled extends LexicalModelDeclaration {
+    readonly id: string;
+}
+//# sourceMappingURL=lexical-model.d.ts.map

package/build/src/lexical-model.d.ts.map

@@ -1 +1 @@
-{"debug_id":"94f66ee3-becb-53a9-9cc1-28e99f0ada0e","file":"lexical-model.d.ts","mappings":";AAAA;;;GAGG;;AAEH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,MAAM,EAAE,UAAU,GAAC,cAAc,GAAC,YAAY,CAAC;CAEzD;AAED;;;;;;;GAOG;AACF,MAAM,WAAW,eAAe;IAC/B,QAAQ,CAAC,GAAG,EAAE,qBAAqB,CAAC;IACpC;;;;;;;OAOG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;;;;;OAMG;IACH,QAAQ,CAAC,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;CAC1D;AAED;;;;GAIG;AACF,MAAM,MAAM,qBAAqB,GAAG,SAAS,GAAG,OAAO,GAAG,oBAAoB,CAAC;AAEhF;;;;GAIG;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,cAAc,KAAK,MAAM,CAAC;AAE5F;;;GAGG;AACF,MAAM,MAAM,iBAAiB,GAAG,uBAAuB,GAAG,sBAAsB,CAAC;AAElF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,sBAAsB,GAAG,uBAAuB,CAAC;AAG7D,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB;IACjE,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAChC;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAErC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,cAAc,CAAA;IAErC;;;;;;;;OAQG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,eAAe,GAAG,qBAAqB,CAAC;IAE/D;;;OAGG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC;IAE7C;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,uBAAuB,CAAC;CAChD;AAED,MAAM,WAAW,oBAAqB,SAAQ,uBAAuB;IACnE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;CACrB","names":[],"sourceRoot":"","sources":["../../src/lexical-model.ts"],"version":3}
+{"version":3,"file":"lexical-model.d.ts","sourceRoot":"","sources":["../../src/lexical-model.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AAEH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,MAAM,EAAE,UAAU,GAAC,cAAc,GAAC,YAAY,CAAC;CAEzD;AAED;;;;;;;GAOG;AACF,MAAM,WAAW,eAAe;IAC/B,QAAQ,CAAC,GAAG,EAAE,qBAAqB,CAAC;IACpC;;;;;;;OAOG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;;;;;OAMG;IACH,QAAQ,CAAC,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;CAC1D;AAED;;;;GAIG;AACF,MAAM,MAAM,qBAAqB,GAAG,SAAS,GAAG,OAAO,GAAG,oBAAoB,CAAC;AAEhF;;;;GAIG;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,cAAc,KAAK,MAAM,CAAC;AAE5F;;;GAGG;AACF,MAAM,MAAM,iBAAiB,GAAG,uBAAuB,GAAG,sBAAsB,CAAC;AAElF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,sBAAsB,GAAG,uBAAuB,CAAC;AAG7D,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB;IACjE,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAChC;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAErC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,cAAc,CAAA;IAErC;;;;;;;;OAQG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,eAAe,GAAG,qBAAqB,CAAC;IAE/D;;;OAGG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC;IAE7C;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,uBAAuB,CAAC;CAChD;AAED,MAAM,WAAW,oBAAqB,SAAQ,uBAAuB;IACnE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;CACrB"}

package/build/src/main.d.ts

@@ -1,5 +1,3 @@
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="70705a10-2a85-53de-a527-92aa4f2e19d0")}catch(e){}}();
-export { LexicalModelCompiler } from './lexical-model-compiler.js';
-export { ModelCompilerMessages } from './model-compiler-messages.js';
-//# debugId=70705a10-2a85-53de-a527-92aa4f2e19d0
-//# sourceMappingURL=main.d.ts.map
+export { LexicalModelCompiler } from './lexical-model-compiler.js';
+export { ModelCompilerMessages } from './model-compiler-messages.js';
+//# sourceMappingURL=main.d.ts.map

package/build/src/main.d.ts.map

@@ -1 +1 @@
-{"debug_id":"70705a10-2a85-53de-a527-92aa4f2e19d0","file":"main.d.ts","mappings":";AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC","names":[],"sourceRoot":"","sources":["../../src/main.ts"],"version":3}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC"}

package/build/src/model-compiler-messages.d.ts

@@ -1,53 +1,51 @@
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="d754c5c8-0a2c-5d7a-895e-3a8bec5326f4")}catch(e){}}();
-import { CompilerEvent } from "@keymanapp/common-types";
-export declare class ModelCompilerMessageContext {
-    static line: number;
-    static filename: string;
-}
-export declare class ModelCompilerMessages {
-    static Fatal_UnexpectedException: (o: {
-        e: any;
-    }) => CompilerEvent;
-    static FATAL_UnexpectedException: number;
-    static Hint_MixedNormalizationForms: (o: {
-        wordform: string;
-    }) => CompilerEvent;
-    static HINT_MixedNormalizationForms: number;
-    static Hint_DuplicateWordInSameFile: (o: {
-        wordform: string;
-    }) => CompilerEvent;
-    static HINT_DuplicateWordInSameFile: number;
-    static Error_UnimplementedModelFormat: (o: {
-        format: string;
-    }) => CompilerEvent;
-    static ERROR_UnimplementedModelFormat: number;
-    static Error_UnknownModelFormat: (o: {
-        format: string;
-    }) => CompilerEvent;
-    static ERROR_UnknownModelFormat: number;
-    static Error_NoDefaultExport: () => CompilerEvent;
-    static ERROR_NoDefaultExport: number;
-    static Error_SearchTermToKeyMustBeExplicitlySpecified: () => CompilerEvent;
-    static ERROR_SearchTermToKeyMustBeExplicitlySpecified: number;
-    static Error_UTF16BEUnsupported: () => CompilerEvent;
-    static ERROR_UTF16BEUnsupported: number;
-    static Error_UnknownWordBreaker: (o: {
-        spec: string;
-    }) => CompilerEvent;
-    static ERROR_UnknownWordBreaker: number;
-    static Error_UnsupportedScriptOverride: (o: {
-        option: string;
-    }) => CompilerEvent;
-    static ERROR_UnsupportedScriptOverride: number;
-}
-/**
- * A ModelCompilerError should be thrown when an unrecoverable error occurs that
- * would block further compilation. It will be caught in the top-most compiler
- * API endpoint and converted into a callback message.
- */
-export declare class ModelCompilerError extends Error {
-    event: CompilerEvent;
-    constructor(event: CompilerEvent);
-}
-//# debugId=d754c5c8-0a2c-5d7a-895e-3a8bec5326f4
-//# sourceMappingURL=model-compiler-messages.d.ts.map
+import { CompilerEvent } from "@keymanapp/common-types";
+export declare class ModelCompilerMessageContext {
+    static line: number;
+    static filename: string;
+}
+export declare class ModelCompilerMessages {
+    static Fatal_UnexpectedException: (o: {
+        e: any;
+    }) => CompilerEvent;
+    static FATAL_UnexpectedException: number;
+    static Hint_MixedNormalizationForms: (o: {
+        wordform: string;
+    }) => CompilerEvent;
+    static HINT_MixedNormalizationForms: number;
+    static Hint_DuplicateWordInSameFile: (o: {
+        wordform: string;
+    }) => CompilerEvent;
+    static HINT_DuplicateWordInSameFile: number;
+    static Error_UnimplementedModelFormat: (o: {
+        format: string;
+    }) => CompilerEvent;
+    static ERROR_UnimplementedModelFormat: number;
+    static Error_UnknownModelFormat: (o: {
+        format: string;
+    }) => CompilerEvent;
+    static ERROR_UnknownModelFormat: number;
+    static Error_NoDefaultExport: () => CompilerEvent;
+    static ERROR_NoDefaultExport: number;
+    static Error_SearchTermToKeyMustBeExplicitlySpecified: () => CompilerEvent;
+    static ERROR_SearchTermToKeyMustBeExplicitlySpecified: number;
+    static Error_UTF16BEUnsupported: () => CompilerEvent;
+    static ERROR_UTF16BEUnsupported: number;
+    static Error_UnknownWordBreaker: (o: {
+        spec: string;
+    }) => CompilerEvent;
+    static ERROR_UnknownWordBreaker: number;
+    static Error_UnsupportedScriptOverride: (o: {
+        option: string;
+    }) => CompilerEvent;
+    static ERROR_UnsupportedScriptOverride: number;
+}
+/**
+ * A ModelCompilerError should be thrown when an unrecoverable error occurs that
+ * would block further compilation. It will be caught in the top-most compiler
+ * API endpoint and converted into a callback message.
+ */
+export declare class ModelCompilerError extends Error {
+    event: CompilerEvent;
+    constructor(event: CompilerEvent);
+}
+//# sourceMappingURL=model-compiler-messages.d.ts.map

package/build/src/model-compiler-messages.d.ts.map

@@ -1 +1 @@
-{"debug_id":"d754c5c8-0a2c-5d7a-895e-3a8bec5326f4","file":"model-compiler-messages.d.ts","mappings":";AAAA,OAAO,EAAiD,aAAa,EAAuB,MAAM,yBAAyB,CAAC;AAe5H,qBAAa,2BAA2B;IAEtC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC;CACzB;AAED,qBAAa,qBAAqB;IAEhC,MAAM,CAAC,yBAAyB,MAAM;QAAC,CAAC,EAAE,GAAG,CAAA;KAAC,mBAAqE;IACnH,MAAM,CAAC,yBAAyB,SAAqB;IAErD,MAAM,CAAC,4BAA4B,MAAM;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAC,mBACkB;IAC7E,MAAM,CAAC,4BAA4B,SAAoB;IAEvD,MAAM,CAAC,4BAA4B,MAAM;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAC,mBACY;IACvE,MAAM,CAAC,4BAA4B,SAAoB;IAEvD,MAAM,CAAC,8BAA8B,MAAM;QAAC,MAAM,EAAE,MAAM,CAAA;KAAC,mBACd;IAC7C,MAAM,CAAC,8BAA8B,SAAqB;IAE1D,MAAM,CAAC,wBAAwB,MAAM;QAAC,MAAM,EAAE,MAAM,CAAA;KAAC,mBACR;IAC7C,MAAM,CAAC,wBAAwB,SAAqB;IAEpD,MAAM,CAAC,qBAAqB,sBACwE;IACpG,MAAM,CAAC,qBAAqB,SAAqB;IAEjD,MAAM,CAAC,8CAA8C,sBACH;IAClD,MAAM,CAAC,8CAA8C,SAAqB;IAE1E,MAAM,CAAC,wBAAwB,sBAAqE;IACpG,MAAM,CAAC,wBAAwB,SAAqB;IAEpD,MAAM,CAAC,wBAAwB,MAAM;QAAC,IAAI,EAAC,MAAM,CAAA;KAAC,mBACb;IACrC,MAAM,CAAC,wBAAwB,SAAqB;IAEpD,MAAM,CAAC,+BAA+B,MAAM;QAAC,MAAM,EAAC,MAAM,CAAA;KAAC,mBACb;IAC9C,MAAM,CAAC,+BAA+B,SAAqB;CAC5D;AAED;;;;GAIG;AACH,qBAAa,kBAAmB,SAAQ,KAAK;IACxB,KAAK,EAAE,aAAa;gBAApB,KAAK,EAAE,aAAa;CAGxC","names":[],"sourceRoot":"","sources":["../../src/model-compiler-messages.ts"],"version":3}
+{"version":3,"file":"model-compiler-messages.d.ts","sourceRoot":"","sources":["../../src/model-compiler-messages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiD,aAAa,EAAuB,MAAM,yBAAyB,CAAC;AAe5H,qBAAa,2BAA2B;IAEtC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC;CACzB;AAED,qBAAa,qBAAqB;IAEhC,MAAM,CAAC,yBAAyB,MAAM;QAAC,CAAC,EAAE,GAAG,CAAA;KAAC,mBAAqE;IACnH,MAAM,CAAC,yBAAyB,SAAqB;IAErD,MAAM,CAAC,4BAA4B,MAAM;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAC,mBACkB;IAC7E,MAAM,CAAC,4BAA4B,SAAoB;IAEvD,MAAM,CAAC,4BAA4B,MAAM;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAC,mBACY;IACvE,MAAM,CAAC,4BAA4B,SAAoB;IAEvD,MAAM,CAAC,8BAA8B,MAAM;QAAC,MAAM,EAAE,MAAM,CAAA;KAAC,mBACd;IAC7C,MAAM,CAAC,8BAA8B,SAAqB;IAE1D,MAAM,CAAC,wBAAwB,MAAM;QAAC,MAAM,EAAE,MAAM,CAAA;KAAC,mBACR;IAC7C,MAAM,CAAC,wBAAwB,SAAqB;IAEpD,MAAM,CAAC,qBAAqB,sBACwE;IACpG,MAAM,CAAC,qBAAqB,SAAqB;IAEjD,MAAM,CAAC,8CAA8C,sBACH;IAClD,MAAM,CAAC,8CAA8C,SAAqB;IAE1E,MAAM,CAAC,wBAAwB,sBAAqE;IACpG,MAAM,CAAC,wBAAwB,SAAqB;IAEpD,MAAM,CAAC,wBAAwB,MAAM;QAAC,IAAI,EAAC,MAAM,CAAA;KAAC,mBACb;IACrC,MAAM,CAAC,wBAAwB,SAAqB;IAEpD,MAAM,CAAC,+BAA+B,MAAM;QAAC,MAAM,EAAC,MAAM,CAAA;KAAC,mBACb;IAC9C,MAAM,CAAC,+BAA+B,SAAqB;CAC5D;AAED;;;;GAIG;AACH,qBAAa,kBAAmB,SAAQ,KAAK;IACxB,KAAK,EAAE,aAAa;gBAApB,KAAK,EAAE,aAAa;CAGxC"}

package/build/src/model-defaults.d.ts

@@ -1,58 +1,56 @@
-/// <reference types="@keymanapp/models-types" />
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="9a5871e0-b721-5738-8625-272cb6f5e965")}catch(e){}}();
-/**
- * Converts wordforms into an indexable form. It does this by
- * normalizing the letter case of characters INDIVIDUALLY (to disregard
- * context-sensitive case transformations), normalizing to NFKD form,
- * and removing common diacritical marks.
- *
- * This is a very speculative implementation, that might work with
- * your language. We don't guarantee that this will be perfect for your
- * language, but it's a start.
- *
- * This uses String.prototype.normalize() to convert normalize into NFKD.
- * NFKD neutralizes some funky distinctions, e.g., ꬲ, ｅ, e should all be the
- * same character; plus, it's an easy way to separate a Latin character from
- * its diacritics; Even then, orthographies regularly use code points
- * that, under NFKD normalization, do NOT decompose appropriately for your
- * language (e.g., SENĆOŦEN, Plains Cree in syllabics).
- *
- * Use this in early iterations of the model. For a production lexical model,
- * you will probably write/generate your own key function, tailored to your
- * language. There is a chance the default will work properly out of the box.
- */
-export declare function defaultSearchTermToKey(wordform: string): string;
-/**
- * Converts wordforms into an indexable form. It does this by
- * normalizing the letter case of characters INDIVIDUALLY (to disregard
- * context-sensitive case transformations), normalizing to NFKD form,
- * and removing common diacritical marks.
- *
- * This is a very speculative implementation, that might work with
- * your language. We don't guarantee that this will be perfect for your
- * language, but it's a start.
- *
- * This uses String.prototype.normalize() to convert normalize into NFKD.
- * NFKD neutralizes some funky distinctions, e.g., ꬲ, ｅ, e should all be the
- * same character; plus, it's an easy way to separate a Latin character from
- * its diacritics; Even then, orthographies regularly use code points
- * that, under NFKD normalization, do NOT decompose appropriately for your
- * language (e.g., SENĆOŦEN, Plains Cree in syllabics).
- *
- * Use this in early iterations of the model. For a production lexical model,
- * you will probably write/generate your own key function, tailored to your
- * language. There is a chance the default will work properly out of the box.
- */
-export declare function defaultCasedSearchTermToKey(wordform: string, applyCasing: CasingFunction): string;
-/**
- * Specifies default casing behavior for lexical models when `languageUsesCasing` is
- * set to true.
- * @param casing One of 'lower' (lowercased), 'upper' (uppercased), or 'initial'.
- *
- * 'initial' is designed to cover cases like sentence-initial & proper noun capitalization in English.
- * This may be overwritten as appropriate in model-specific implementations.
- * @param text The text to be modified.
- */
-export declare function defaultApplyCasing(casing: CasingForm, text: string): string;
-//# debugId=9a5871e0-b721-5738-8625-272cb6f5e965
-//# sourceMappingURL=model-defaults.d.ts.map
+/// <reference types="@keymanapp/models-types" />
+/**
+ * Converts wordforms into an indexable form. It does this by
+ * normalizing the letter case of characters INDIVIDUALLY (to disregard
+ * context-sensitive case transformations), normalizing to NFKD form,
+ * and removing common diacritical marks.
+ *
+ * This is a very speculative implementation, that might work with
+ * your language. We don't guarantee that this will be perfect for your
+ * language, but it's a start.
+ *
+ * This uses String.prototype.normalize() to convert normalize into NFKD.
+ * NFKD neutralizes some funky distinctions, e.g., ꬲ, ｅ, e should all be the
+ * same character; plus, it's an easy way to separate a Latin character from
+ * its diacritics; Even then, orthographies regularly use code points
+ * that, under NFKD normalization, do NOT decompose appropriately for your
+ * language (e.g., SENĆOŦEN, Plains Cree in syllabics).
+ *
+ * Use this in early iterations of the model. For a production lexical model,
+ * you will probably write/generate your own key function, tailored to your
+ * language. There is a chance the default will work properly out of the box.
+ */
+export declare function defaultSearchTermToKey(wordform: string): string;
+/**
+ * Converts wordforms into an indexable form. It does this by
+ * normalizing the letter case of characters INDIVIDUALLY (to disregard
+ * context-sensitive case transformations), normalizing to NFKD form,
+ * and removing common diacritical marks.
+ *
+ * This is a very speculative implementation, that might work with
+ * your language. We don't guarantee that this will be perfect for your
+ * language, but it's a start.
+ *
+ * This uses String.prototype.normalize() to convert normalize into NFKD.
+ * NFKD neutralizes some funky distinctions, e.g., ꬲ, ｅ, e should all be the
+ * same character; plus, it's an easy way to separate a Latin character from
+ * its diacritics; Even then, orthographies regularly use code points
+ * that, under NFKD normalization, do NOT decompose appropriately for your
+ * language (e.g., SENĆOŦEN, Plains Cree in syllabics).
+ *
+ * Use this in early iterations of the model. For a production lexical model,
+ * you will probably write/generate your own key function, tailored to your
+ * language. There is a chance the default will work properly out of the box.
+ */
+export declare function defaultCasedSearchTermToKey(wordform: string, applyCasing: CasingFunction): string;
+/**
+ * Specifies default casing behavior for lexical models when `languageUsesCasing` is
+ * set to true.
+ * @param casing One of 'lower' (lowercased), 'upper' (uppercased), or 'initial'.
+ *
+ * 'initial' is designed to cover cases like sentence-initial & proper noun capitalization in English.
+ * This may be overwritten as appropriate in model-specific implementations.
+ * @param text The text to be modified.
+ */
+export declare function defaultApplyCasing(casing: CasingForm, text: string): string;
+//# sourceMappingURL=model-defaults.d.ts.map

package/build/src/model-defaults.d.ts.map

@@ -1 +1 @@
-{"debug_id":"9a5871e0-b721-5738-8625-272cb6f5e965","file":"model-defaults.d.ts","mappings":";;AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAW/D;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,2BAA2B,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,cAAc,GAAG,MAAM,CAiBjG;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CA2B3E","names":[],"sourceRoot":"","sources":["../../src/model-defaults.ts"],"version":3}
+{"version":3,"file":"model-defaults.d.ts","sourceRoot":"","sources":["../../src/model-defaults.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAW/D;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,2BAA2B,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,cAAc,GAAG,MAAM,CAiBjG;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CA2B3E"}

package/build/src/model-definitions.d.ts

@@ -1,73 +1,71 @@
-/// <reference types="@keymanapp/models-types" />
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="da50a2a7-71d5-57a0-9a0c-c905d304ad11")}catch(e){}}();
-import { LexicalModelSource, WordformToKeySpec } from "./lexical-model.js";
-/**
- * Processes certain defined model behaviors in such a way that the needed closures
- * may be safely compiled to a JS file and loaded within the LMLayer.
- *
- * This is accomplished by writing out a 'pseudoclosure' within the model's IIFE,
- * then used to build _actual_ closures at LMLayer load time.  This 'pseudoclosure'
- * will very closely match the organizational patterns of this class in order to
- * facilitate the maintenance of this approach.
- */
-export declare class ModelDefinitions {
-    static readonly COMPILED_NAME = "definitions";
-    /**
-     * A closure fully implementing the model's defined `applyCasing` behavior with
-     * the function parameter preset to the version-appropriate default.
-     * `defaults.applyCasing` is captured as part of the closure.
-     *
-     * During compilation of some models (such as Trie-based wordlist templated models),
-     * this closure will be directly used as part of searchTermToKey.
-     *
-     * In compiled code, this will instead be defined in-line as an autogenerated closure
-     * using the other properties of the pseudoclosure.
-     */
-    applyCasing?: CasingFunction;
-    /**
-     * A closure fully implementing the model's defined `searchTermToKey` behavior
-     * based upon the model's specified casing rules.  The `applyCasing` closure is
-     * itself captured within this closure.
-     *
-     * During compilation of some models (such as Trie-based wordlist templated models),
-     * this closure will be directly utilized when compiling the lexicon.
-     *
-     * In compiled code, this will instead be defined in-line as an autogenerated closure
-     * using the other properties of the pseudoclosure.
-     */
-    searchTermToKey?: WordformToKeySpec;
-    /**
-     * Contains embedded 'default' implementations that may be needed for
-     * closures in the compiled version, annotated with the current version
-     * of Developer.
-     */
-    private defaults;
-    /**
-     * Contains the model-specific definitions specified in the model's source.
-     *
-     * These definitions may expect `defaults.applyCasing` as a parameter in
-     * their final closures.
-     */
-    private model;
-    constructor(modelSource: LexicalModelSource);
-    /**
-     * Writes out a compiled JS version of the pseudoclosure, preserving all function
-     * implementations.
-     *
-     * This should be written to the file within the same IIFE as the model but BEFORE
-     * the model itself, as the model will need to refer to the definitions herein.
-     */
-    compileDefinitions(): string;
-    /**
-     * Compiles the model-options entry for `searchTermToKey` in reference to the
-     * compiled pseudoclosure.
-     */
-    compileSearchTermToKey(): string;
-    /**
-     * Compiles the model-options entry for `applyCasing` in reference to the
-     * compiled pseudoclosure.
-     */
-    compileApplyCasing(): string;
-}
-//# debugId=da50a2a7-71d5-57a0-9a0c-c905d304ad11
-//# sourceMappingURL=model-definitions.d.ts.map
+/// <reference types="@keymanapp/models-types" />
+import { LexicalModelSource, WordformToKeySpec } from "./lexical-model.js";
+/**
+ * Processes certain defined model behaviors in such a way that the needed closures
+ * may be safely compiled to a JS file and loaded within the LMLayer.
+ *
+ * This is accomplished by writing out a 'pseudoclosure' within the model's IIFE,
+ * then used to build _actual_ closures at LMLayer load time.  This 'pseudoclosure'
+ * will very closely match the organizational patterns of this class in order to
+ * facilitate the maintenance of this approach.
+ */
+export declare class ModelDefinitions {
+    static readonly COMPILED_NAME = "definitions";
+    /**
+     * A closure fully implementing the model's defined `applyCasing` behavior with
+     * the function parameter preset to the version-appropriate default.
+     * `defaults.applyCasing` is captured as part of the closure.
+     *
+     * During compilation of some models (such as Trie-based wordlist templated models),
+     * this closure will be directly used as part of searchTermToKey.
+     *
+     * In compiled code, this will instead be defined in-line as an autogenerated closure
+     * using the other properties of the pseudoclosure.
+     */
+    applyCasing?: CasingFunction;
+    /**
+     * A closure fully implementing the model's defined `searchTermToKey` behavior
+     * based upon the model's specified casing rules.  The `applyCasing` closure is
+     * itself captured within this closure.
+     *
+     * During compilation of some models (such as Trie-based wordlist templated models),
+     * this closure will be directly utilized when compiling the lexicon.
+     *
+     * In compiled code, this will instead be defined in-line as an autogenerated closure
+     * using the other properties of the pseudoclosure.
+     */
+    searchTermToKey?: WordformToKeySpec;
+    /**
+     * Contains embedded 'default' implementations that may be needed for
+     * closures in the compiled version, annotated with the current version
+     * of Developer.
+     */
+    private defaults;
+    /**
+     * Contains the model-specific definitions specified in the model's source.
+     *
+     * These definitions may expect `defaults.applyCasing` as a parameter in
+     * their final closures.
+     */
+    private model;
+    constructor(modelSource: LexicalModelSource);
+    /**
+     * Writes out a compiled JS version of the pseudoclosure, preserving all function
+     * implementations.
+     *
+     * This should be written to the file within the same IIFE as the model but BEFORE
+     * the model itself, as the model will need to refer to the definitions herein.
+     */
+    compileDefinitions(): string;
+    /**
+     * Compiles the model-options entry for `searchTermToKey` in reference to the
+     * compiled pseudoclosure.
+     */
+    compileSearchTermToKey(): string;
+    /**
+     * Compiles the model-options entry for `applyCasing` in reference to the
+     * compiled pseudoclosure.
+     */
+    compileApplyCasing(): string;
+}
+//# sourceMappingURL=model-definitions.d.ts.map

package/build/src/model-definitions.d.ts.map

@@ -1 +1 @@
-{"debug_id":"da50a2a7-71d5-57a0-9a0c-c905d304ad11","file":"model-definitions.d.ts","mappings":";;AAMA,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAE3E;;;;;;;;GAQG;AACH,qBAAa,gBAAgB;IAC3B,MAAM,CAAC,QAAQ,CAAC,aAAa,iBAAiB;IAC9C;;;;;;;;;;OAUG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC;IAE7B;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EAAE,iBAAiB,CAAC;IAEpC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAKd;IAEF;;;;;OAKG;IACH,OAAO,CAAC,KAAK,CAGN;gBAEK,WAAW,EAAE,kBAAkB;IAsD3C;;;;;;OAMG;IACH,kBAAkB,IAAI,MAAM;IAuE5B;;;OAGG;IACH,sBAAsB,IAAI,MAAM;IAMhC;;;OAGG;IACH,kBAAkB,IAAI,MAAM;CAI7B","names":[],"sourceRoot":"","sources":["../../src/model-definitions.ts"],"version":3}
+{"version":3,"file":"model-definitions.d.ts","sourceRoot":"","sources":["../../src/model-definitions.ts"],"names":[],"mappings":";AAMA,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAE3E;;;;;;;;GAQG;AACH,qBAAa,gBAAgB;IAC3B,MAAM,CAAC,QAAQ,CAAC,aAAa,iBAAiB;IAC9C;;;;;;;;;;OAUG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC;IAE7B;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EAAE,iBAAiB,CAAC;IAEpC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAKd;IAEF;;;;;OAKG;IACH,OAAO,CAAC,KAAK,CAGN;gBAEK,WAAW,EAAE,kBAAkB;IAsD3C;;;;;;OAMG;IACH,kBAAkB,IAAI,MAAM;IAuE5B;;;OAGG;IACH,sBAAsB,IAAI,MAAM;IAMhC;;;OAGG;IACH,kBAAkB,IAAI,MAAM;CAI7B"}

package/build/src/script-overrides-decorator.d.ts

@@ -1,6 +1,4 @@
-/// <reference types="@keymanapp/models-types" />
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="82b84a7e-8421-59a6-8b07-a1c5850d036b")}catch(e){}}();
-import { OverrideScriptDefaults } from "./lexical-model.js";
-export declare function decorateWithScriptOverrides(breaker: WordBreakingFunction, option: OverrideScriptDefaults): (phrase: string) => Span[];
-//# debugId=82b84a7e-8421-59a6-8b07-a1c5850d036b
-//# sourceMappingURL=script-overrides-decorator.d.ts.map
+/// <reference types="@keymanapp/models-types" />
+import { OverrideScriptDefaults } from "./lexical-model.js";
+export declare function decorateWithScriptOverrides(breaker: WordBreakingFunction, option: OverrideScriptDefaults): (phrase: string) => Span[];
+//# sourceMappingURL=script-overrides-decorator.d.ts.map

package/build/src/script-overrides-decorator.d.ts.map

@@ -1 +1 @@
-{"debug_id":"82b84a7e-8421-59a6-8b07-a1c5850d036b","file":"script-overrides-decorator.d.ts","mappings":";;AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAG5D,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,oBAAoB,EAAE,MAAM,EAAE,sBAAsB,YAgB/D,MAAM,KAAG,IAAI,EAAE,CAwDxD","names":[],"sourceRoot":"","sources":["../../src/script-overrides-decorator.ts"],"version":3}
+{"version":3,"file":"script-overrides-decorator.d.ts","sourceRoot":"","sources":["../../src/script-overrides-decorator.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAG5D,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,oBAAoB,EAAE,MAAM,EAAE,sBAAsB,YAgB/D,MAAM,KAAG,IAAI,EAAE,CAwDxD"}

package/package.json

@@ -30,13 +30,13 @@
     "url": "https://github.com/keymanapp/keyman/issues"
   },
   "dependencies": {
-    "@keymanapp/common-types": "17.0.256-alpha",
-    "@keymanapp/keyman-version": "17.0.256-alpha",
-    "@keymanapp/models-types": "17.0.256-alpha",
+    "@keymanapp/common-types": "17.0.258-alpha",
+    "@keymanapp/keyman-version": "17.0.258-alpha",
+    "@keymanapp/models-types": "17.0.258-alpha",
     "typescript": "^4.9.5"
   },
   "devDependencies": {
-    "@keymanapp/developer-test-helpers": "17.0.256-alpha",
+    "@keymanapp/developer-test-helpers": "17.0.258-alpha",
     "@types/chai": "^4.1.7",
     "@types/mocha": "^5.2.7",
     "@types/node": "^20.4.1",
@@ -69,5 +69,5 @@
     "type": "git",
     "url": "git+https://github.com/keymanapp/keyman.git"
   },
-  "version": "17.0.256-alpha"
+  "version": "17.0.258-alpha"
 }