diff --git a/developer/docs/api/etc/kmc-analyze.api.md b/developer/docs/api/etc/kmc-analyze.api.md index 45bbd8101c..8784db6b95 100644 --- a/developer/docs/api/etc/kmc-analyze.api.md +++ b/developer/docs/api/etc/kmc-analyze.api.md @@ -1,55 +1,87 @@ -## API Report File for "@keymanapp/kmc-analyze" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { CompilerCallbacks } from '@keymanapp/common-types'; -import { CompilerEvent } from '@keymanapp/common-types'; -import { Osk } from '@keymanapp/kmc-kmn'; - -// @public -export class AnalyzeOskCharacterUse { - constructor(callbacks: CompilerCallbacks, options?: AnalyzeOskCharacterUseOptions); - analyze(file: string): Promise; - clear(): void; - getStrings(format?: '.txt' | '.md' | '.json'): string[]; -} - -// @public -export interface AnalyzeOskCharacterUseOptions { - includeCounts?: boolean; - puaBase?: number; - stripDottedCircle?: boolean; -} - -// @public -export class AnalyzeOskRewritePua { - constructor(callbacks: CompilerCallbacks); - analyze(file: string, mapping: Osk.StringResult[]): Promise; - clear(): void; - get data(): { - [index: string]: Uint8Array; - }; -} - -// Warning: (ae-internal-missing-underscore) The name "AnalyzerMessages" should be prefixed with an underscore because the declaration is marked as @internal -// -// @internal -export class AnalyzerMessages { - // (undocumented) - static readonly FATAL_UnexpectedException: number; - // (undocumented) - static readonly Fatal_UnexpectedException: (o: { - e: any; - }) => CompilerEvent; - // (undocumented) - static readonly INFO_ScanningFile: number; - // (undocumented) - static readonly Info_ScanningFile: (o: { - type: string; - name: string; - }) => CompilerEvent; -} - -``` +## API Report File for "@keymanapp/kmc-analyze" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { CompilerCallbacks } from '@keymanapp/developer-utils'; +import { CompilerEvent } from '@keymanapp/developer-utils'; +import { Osk } from '@keymanapp/kmc-kmn'; + +// @public +export class AnalyzeOskCharacterUse { + constructor(callbacks: CompilerCallbacks, options?: AnalyzeOskCharacterUseOptions); + analyze(file: string): Promise; + clear(): void; + getStrings(format?: '.txt' | '.md' | '.json'): string[]; + // @internal (undocumented) + unitTestEndPoints: { + loadPreviousMap: (filename: string) => Osk.StringResult[]; + addStrings: (strings: string[], filename: string) => void; + stringToUnicodeSequence: typeof AnalyzeOskCharacterUse.stringToUnicodeSequence; + }; +} + +// @public +export interface AnalyzeOskCharacterUseOptions { + includeCounts?: boolean; + mergeMapFile?: string; + puaBase?: number; + stripDottedCircle?: boolean; +} + +// @public +export class AnalyzeOskRewritePua { + constructor(callbacks: CompilerCallbacks); + analyze(file: string, mapping: Osk.StringResult[]): Promise; + clear(): void; + get data(): { + [index: string]: Uint8Array; + }; +} + +// Warning: (ae-internal-missing-underscore) The name "AnalyzerMessages" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal +export class AnalyzerMessages { + // (undocumented) + static readonly FATAL_UnexpectedException: number; + // (undocumented) + static readonly Fatal_UnexpectedException: (o: { + e: any; + }) => CompilerEvent; + // (undocumented) + static readonly INFO_ScanningFile: number; + // (undocumented) + static readonly Info_ScanningFile: (o: { + type: string; + name: string; + }) => CompilerEvent; + // (undocumented) + static readonly WARN_PreviousMapDidIncludeCounts: number; + // (undocumented) + static readonly Warn_PreviousMapDidIncludeCounts: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static readonly WARN_PreviousMapDidNotIncludeCounts: number; + // (undocumented) + static readonly Warn_PreviousMapDidNotIncludeCounts: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static readonly WARN_PreviousMapFileCouldNotBeLoaded: number; + // (undocumented) + static readonly Warn_PreviousMapFileCouldNotBeLoaded: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static readonly WARN_PreviousMapFileCouldNotBeLoadedDueToError: number; + // (undocumented) + static readonly Warn_PreviousMapFileCouldNotBeLoadedDueToError: (o: { + filename: string; + e: any; + }) => CompilerEvent; +} + +``` diff --git a/developer/docs/api/etc/kmc-copy.api.md b/developer/docs/api/etc/kmc-copy.api.md new file mode 100644 index 0000000000..f61dd59e10 --- /dev/null +++ b/developer/docs/api/etc/kmc-copy.api.md @@ -0,0 +1,258 @@ +## API Report File for "@keymanapp/kmc-copy" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { CompilerAsyncCallbacks } from '@keymanapp/developer-utils'; +import { CompilerBaseOptions } from '@keymanapp/developer-utils'; +import { CompilerCallbacks } from '@keymanapp/developer-utils'; +import { CompilerEvent } from '@keymanapp/developer-utils'; +import { CompilerFileSystemAsyncCallbacks } from '@keymanapp/developer-utils'; +import { CompilerNetAsyncCallbacks } from '@keymanapp/developer-utils'; +import { CompilerPathCallbacks } from '@keymanapp/developer-utils'; +import { GitHubUrls } from '@keymanapp/developer-utils'; +import { KeymanCompiler } from '@keymanapp/developer-utils'; +import { KeymanCompilerArtifact } from '@keymanapp/developer-utils'; +import { KeymanCompilerArtifacts } from '@keymanapp/developer-utils'; +import { KeymanCompilerResult } from '@keymanapp/developer-utils'; + +// Warning: (ae-internal-missing-underscore) The name "CopierMessages" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal (undocumented) +export class CopierMessages { + // (undocumented) + static ERROR_CannotCreateFolder: number; + // (undocumented) + static Error_CannotCreateFolder: (o: { + folderName: string; + e: any; + }) => CompilerEvent; + // (undocumented) + static ERROR_CannotDownloadFolderFromGitHub: number; + // (undocumented) + static Error_CannotDownloadFolderFromGitHub: (o: { + ref: string; + message?: string; + cause?: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_CannotDownloadRepoFromGitHub: number; + // (undocumented) + static Error_CannotDownloadRepoFromGitHub: (o: { + ref: string; + message?: string; + cause?: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_CannotFindInputProject: number; + // (undocumented) + static Error_CannotFindInputProject: (o: { + project: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_CannotWriteOutputFile: number; + // (undocumented) + static Error_CannotWriteOutputFile: (o: { + filename: string; + e: any; + }) => CompilerEvent; + // (undocumented) + static ERROR_CloudDoesNotHaveSource: number; + // (undocumented) + static Error_CloudDoesNotHaveSource: (o: { + id: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_CouldNotFindDefaultBranchOnGitHub: number; + // (undocumented) + static Error_CouldNotFindDefaultBranchOnGitHub: (o: { + ref: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_CouldNotRetrieveFromCloud: number; + // (undocumented) + static Error_CouldNotRetrieveFromCloud: (o: { + id: string; + message?: string; + cause?: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_FolderDownloadedFromGitHubIsNotAValidFolder: number; + // (undocumented) + static Error_FolderDownloadedFromGitHubIsNotAValidFolder: (o: { + ref: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_InvalidCloudKeyboardId: number; + // (undocumented) + static Error_InvalidCloudKeyboardId: (o: { + id: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_InvalidKeyboardId: number; + // (undocumented) + static Error_InvalidKeyboardId: (o: { + id: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_InvalidLexicalModelId: number; + // (undocumented) + static Error_InvalidLexicalModelId: (o: { + id: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_KeymanCloudReturnedInvalidData: number; + // (undocumented) + static Error_KeymanCloudReturnedInvalidData: (o: { + id: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_OutputPathAlreadyExists: number; + // (undocumented) + static Error_OutputPathAlreadyExists: (o: { + outPath: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_PackageFileCouldNotBeRead: number; + // (undocumented) + static Error_PackageFileCouldNotBeRead: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static FATAL_UnexpectedException: number; + // (undocumented) + static Fatal_UnexpectedException: (o: { + e: any; + }) => CompilerEvent; + // (undocumented) + static INFO_CannotDownloadBinaryFileFromGitHub: number; + // (undocumented) + static Info_CannotDownloadBinaryFileFromGitHub: (o: { + ref: string; + message?: string; + cause?: string; + }) => CompilerEvent; + // (undocumented) + static INFO_DryRun: number; + // (undocumented) + static Info_DryRun: (o: { + outPath: string; + }) => CompilerEvent; + // (undocumented) + static INFO_DryRunCreatingFolder: number; + // (undocumented) + static Info_DryRunCreatingFolder: (o: { + path: string; + }) => CompilerEvent; + // (undocumented) + static INFO_DryRunWritingFile: number; + // (undocumented) + static Info_DryRunWritingFile: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static VERBOSE_CopyingFile: number; + // (undocumented) + static Verbose_CopyingFile: (o: { + from: string; + to: string; + }) => CompilerEvent; + // (undocumented) + static VERBOSE_DownloadingFile: number; + // (undocumented) + static Verbose_DownloadingFile: (o: { + filename: string; + url: string; + }) => CompilerEvent; + // (undocumented) + static VERBOSE_DownloadingFolder: number; + // (undocumented) + static Verbose_DownloadingFolder: (o: { + path: string; + url: string; + }) => CompilerEvent; + // (undocumented) + static WARN_CannotDownloadFileFromGitHub: number; + // (undocumented) + static Warn_CannotDownloadFileFromGitHub: (o: { + ref: string; + message?: string; + cause?: string; + }) => CompilerEvent; + // (undocumented) + static WARN_FilenameCollides: number; + // (undocumented) + static Warn_FilenameCollides: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static WARN_FileNotFound: number; + // (undocumented) + static Warn_FileNotFound: (o: { + filename: string; + newFilename: string; + }) => CompilerEvent; + // (undocumented) + static WARN_ModelIdDoesNotFollowLexicalModelConventions: number; + // (undocumented) + static Warn_ModelIdDoesNotFollowLexicalModelConventions: (o: { + id: string; + }) => CompilerEvent; + // (undocumented) + static WARN_NoWordlistsFound: number; + // (undocumented) + static Warn_NoWordlistsFound: (o: { + filename: string; + }) => CompilerEvent; +} + +// @public +export interface CopierOptions extends CompilerBaseOptions { + dryRun: boolean; + outPath: string; + relocateExternalFiles?: boolean; +} + +// @public (undocumented) +export class KeymanProjectCopier implements KeymanCompiler { + // Warning: (ae-forgotten-export) The symbol "CopierAsyncCallbacks" needs to be exported by the entry point main.d.ts + // + // (undocumented) + asyncCallbacks: CopierAsyncCallbacks; + // (undocumented) + callbacks: CompilerCallbacks; + // Warning: (ae-forgotten-export) The symbol "KeymanCloudSource" needs to be exported by the entry point main.d.ts + // + // (undocumented) + cloudSource: KeymanCloudSource; + // Warning: (ae-forgotten-export) The symbol "GitHubRef" needs to be exported by the entry point main.d.ts + // + // (undocumented) + githubRef: GitHubRef; + // (undocumented) + init(callbacks: CompilerCallbacks, options: CopierOptions): Promise; + // (undocumented) + isLocalOrigin(): boolean; + // (undocumented) + options: CopierOptions; + // (undocumented) + outPath: string; + // (undocumented) + outputId: string; + // Warning: (ae-forgotten-export) The symbol "CopierResult" needs to be exported by the entry point main.d.ts + run(source: string): Promise; + // (undocumented) + sourceId: string; + // @internal (undocumented) + unitTestEndPoints: { + getGithubSourceProject: (source: string) => Promise; + getCloudSourceProject: (source: string) => Promise; + }; + // Warning: (ae-forgotten-export) The symbol "CopierArtifacts" needs to be exported by the entry point main.d.ts + write(artifacts: CopierArtifacts): Promise; +} + +// (No @packageDocumentation comment for this package) + +``` diff --git a/developer/docs/api/etc/kmc-generate.api.md b/developer/docs/api/etc/kmc-generate.api.md new file mode 100644 index 0000000000..427f2f2d49 --- /dev/null +++ b/developer/docs/api/etc/kmc-generate.api.md @@ -0,0 +1,181 @@ +## API Report File for "@keymanapp/kmc-generate" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { CompilerBaseOptions } from '@keymanapp/developer-utils'; +import { CompilerCallbacks } from '@keymanapp/developer-utils'; +import { CompilerEvent } from '@keymanapp/developer-utils'; +import { KeymanCompiler } from '@keymanapp/developer-utils'; +import { KeymanCompilerArtifact } from '@keymanapp/developer-utils'; +import { KeymanCompilerArtifacts } from '@keymanapp/developer-utils'; +import { KeymanCompilerResult } from '@keymanapp/developer-utils'; +import { KeymanTargets } from '@keymanapp/common-types'; + +// @public +export class AbstractGenerator { + // (undocumented) + protected get callbacks(): CompilerCallbacks; + protected defaultArtifacts(): GeneratorArtifacts; + protected get filenameMap(): { + [index: string]: string; + }; + protected fullCopyright: string; + protected get includedPrefixes(): string[]; + init(callbacks: CompilerCallbacks, options: GeneratorOptions): Promise; + // (undocumented) + protected get options(): GeneratorOptions; + // (undocumented) + protected static readonly SFile_GitIgnore = ".gitignore"; + // (undocumented) + protected static readonly SFile_HistoryMD = "HISTORY.md"; + // (undocumented) + protected static readonly SFile_LicenseMD = "LICENSE.md"; + // (undocumented) + protected static readonly SFile_ReadmeHTM: string; + // (undocumented) + protected static readonly SFile_ReadmeMD = "README.md"; + // (undocumented) + protected static readonly SFile_WelcomeHTM: string; + // (undocumented) + protected static readonly SPath_Source = "source/"; + protected get templateBasePath(): string; + // @internal (undocumented) + get test_tokenMap(): { + [index: string]: string; + }; + protected get tokenMap(): { + [index: string]: string; + }; + // Warning: (ae-forgotten-export) The symbol "GeneratorArtifacts" needs to be exported by the entry point main.d.ts + write(artifacts: GeneratorArtifacts): Promise; +} + +// Warning: (ae-internal-missing-underscore) The name "GeneratorMessages" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal (undocumented) +export class GeneratorMessages { + // (undocumented) + static ERROR_CannotCreateFolder: number; + // (undocumented) + static Error_CannotCreateFolder: (o: { + folderName: string; + e: any; + }) => CompilerEvent; + // (undocumented) + static ERROR_CannotWriteOutputFile: number; + // (undocumented) + static Error_CannotWriteOutputFile: (o: { + filename: string; + e: any; + }) => CompilerEvent; + // (undocumented) + static ERROR_InvalidKeymanKeyboardId: number; + // (undocumented) + static Error_InvalidKeymanKeyboardId: (o: { + id: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_InvalidLdmlKeyboardId: number; + // (undocumented) + static Error_InvalidLdmlKeyboardId: (o: { + id: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_InvalidLexicalModelId: number; + // (undocumented) + static Error_InvalidLexicalModelId: (o: { + id: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_InvalidTarget: number; + // (undocumented) + static Error_InvalidTarget: (o: { + target: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_OutputPathAlreadyExists: number; + // (undocumented) + static Error_OutputPathAlreadyExists: (o: { + outPath: string; + }) => CompilerEvent; + // (undocumented) + static FATAL_UnexpectedException: number; + // (undocumented) + static Fatal_UnexpectedException: (o: { + e: any; + }) => CompilerEvent; + // (undocumented) + static WARN_ModelIdDoesNotFollowLexicalModelConventions: number; + // (undocumented) + static Warn_ModelIdDoesNotFollowLexicalModelConventions: (o: { + id: string; + }) => CompilerEvent; +} + +// @public +export interface GeneratorOptions extends CompilerBaseOptions { + author?: string; + copyright?: string; + description?: string; + id: string; + keymanVersion?: string; + languageTags?: string[]; + name?: string; + outPath: string; + targets?: KeymanTargets.KeymanTarget[]; + version?: string; +} + +// Warning: (ae-forgotten-export) The symbol "BasicGenerator" needs to be exported by the entry point main.d.ts +// +// @public +export class KeymanKeyboardGenerator extends BasicGenerator implements KeymanCompiler { + // Warning: (ae-forgotten-export) The symbol "GeneratorResult" needs to be exported by the entry point main.d.ts + run(): Promise; + // (undocumented) + static readonly SFile_Keyboard = "keyboard"; + // (undocumented) + static readonly SFile_KeyboardKMN: string; + // (undocumented) + static readonly SFile_KeyboardKPS: string; + // (undocumented) + static readonly SFile_KeyboardKVKS: string; + // (undocumented) + static readonly SFile_Project: string; + // (undocumented) + static readonly SFile_TouchLayout: string; +} + +// @public +export class LdmlKeyboardGenerator extends BasicGenerator implements KeymanCompiler { + run(): Promise; + // (undocumented) + protected static readonly SFile_Keyboard = "keyboard"; + // (undocumented) + static readonly SFile_KeyboardXML: string; + // (undocumented) + static readonly SFile_Package: string; + // (undocumented) + static readonly SFile_Project: string; +} + +// @public +export class LexicalModelGenerator extends BasicGenerator implements KeymanCompiler { + run(): Promise; + // (undocumented) + static readonly SFile_Model = "model"; + // (undocumented) + static readonly SFile_ModelTs: string; + // (undocumented) + static readonly SFile_Package: string; + // (undocumented) + static readonly SFile_Project: string; + // (undocumented) + static readonly SFile_WordlistTsv: string; +} + +// (No @packageDocumentation comment for this package) + +``` diff --git a/developer/docs/api/etc/kmc-keyboard-info.api.md b/developer/docs/api/etc/kmc-keyboard-info.api.md index 0b1ee4f427..0f320b803f 100644 --- a/developer/docs/api/etc/kmc-keyboard-info.api.md +++ b/developer/docs/api/etc/kmc-keyboard-info.api.md @@ -1,119 +1,157 @@ -## API Report File for "@keymanapp/kmc-keyboard-info" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { CompilerCallbacks } from '@keymanapp/common-types'; -import { CompilerEvent } from '@keymanapp/common-types'; -import { CompilerOptions } from '@keymanapp/common-types'; -import { KeymanCompiler } from '@keymanapp/common-types'; -import { KeymanCompilerArtifact } from '@keymanapp/common-types'; -import { KeymanCompilerArtifacts } from '@keymanapp/common-types'; -import { KeymanCompilerResult } from '@keymanapp/common-types'; -import { KmpJsonFile } from '@keymanapp/common-types'; - -// @public -export class KeyboardInfoCompiler implements KeymanCompiler { - constructor(); - // Warning: (ae-forgotten-export) The symbol "KeyboardInfoFileLanguageFont" needs to be exported by the entry point index.d.ts - // - // @internal (undocumented) - fontSourceToKeyboardInfoFont(kpsFilename: string, kmpJsonData: KmpJsonFile.KmpJsonFile, source: string[]): Promise; - init(callbacks: CompilerCallbacks, options: KeyboardInfoCompilerOptions): Promise; - run(inputFilename: string, outputFilename?: string): Promise; - write(artifacts: KeyboardInfoCompilerArtifacts): Promise; -} - -// @public -export interface KeyboardInfoCompilerArtifacts extends KeymanCompilerArtifacts { - keyboard_info: KeymanCompilerArtifact; -} - -// Warning: (ae-internal-missing-underscore) The name "KeyboardInfoCompilerMessages" should be prefixed with an underscore because the declaration is marked as @internal -// -// @internal (undocumented) -export class KeyboardInfoCompilerMessages { - // (undocumented) - static ERROR_CannotBuildWithoutKmpFile: number; - // (undocumented) - static Error_CannotBuildWithoutKmpFile: () => CompilerEvent; - // (undocumented) - static ERROR_FileDoesNotExist: number; - // (undocumented) - static Error_FileDoesNotExist: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_FontFileCannotBeRead: number; - // (undocumented) - static Error_FontFileCannotBeRead: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_FontFileMetaDataIsInvalid: number; - // (undocumented) - static Error_FontFileMetaDataIsInvalid: (o: { - filename: string; - message: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_InvalidAuthorEmail: number; - // (undocumented) - static Error_InvalidAuthorEmail: (o: { - email: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_LicenseFileIsDamaged: number; - // (undocumented) - static Error_LicenseFileIsDamaged: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_LicenseFileIsMissing: number; - // (undocumented) - static Error_LicenseFileIsMissing: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_LicenseIsNotValid: number; - // (undocumented) - static Error_LicenseIsNotValid: (o: { - filename: string; - message: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_NoLicenseFound: number; - // (undocumented) - static Error_NoLicenseFound: () => CompilerEvent; - // (undocumented) - static FATAL_UnexpectedException: number; - // (undocumented) - static Fatal_UnexpectedException: (o: { - e: any; - }) => CompilerEvent; -} - -// @public -export interface KeyboardInfoCompilerOptions extends CompilerOptions { - sources: KeyboardInfoSources; -} - -// @public -export interface KeyboardInfoCompilerResult extends KeymanCompilerResult { - artifacts: KeyboardInfoCompilerArtifacts; -} - -// @public -export interface KeyboardInfoSources { - forPublishing: boolean; - jsFilename?: string; - kmpFilename: string; - kpsFilename: string; - lastCommitDate?: string; - sourcePath: string; -} - -// (No @packageDocumentation comment for this package) - -``` +## API Report File for "@keymanapp/kmc-keyboard-info" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { CompilerCallbacks } from '@keymanapp/developer-utils'; +import { CompilerEvent } from '@keymanapp/developer-utils'; +import { CompilerOptions } from '@keymanapp/developer-utils'; +import { KeymanCompiler } from '@keymanapp/developer-utils'; +import { KeymanCompilerArtifact } from '@keymanapp/developer-utils'; +import { KeymanCompilerArtifacts } from '@keymanapp/developer-utils'; +import { KeymanCompilerResult } from '@keymanapp/developer-utils'; +import { KmpJsonFile } from '@keymanapp/common-types'; + +// @public +export class KeyboardInfoCompiler implements KeymanCompiler { + // Warning: (ae-forgotten-export) The symbol "KeyboardInfoFileLanguageFont" needs to be exported by the entry point index.d.ts + // + // @internal (undocumented) + fontSourceToKeyboardInfoFont(kpsFilename: string, kmpJsonData: KmpJsonFile.KmpJsonFile, source: string[]): Promise; + init(callbacks: CompilerCallbacks, options: KeyboardInfoCompilerOptions): Promise; + run(inputFilename: string, outputFilename?: string): Promise; + // @internal (undocumented) + unitTestEndPoints: { + fillLanguageMetadata: (language: KeyboardInfoFileLanguage, bcp47: string, commonScript: string, firstBcp47: string) => { + commonScript: string; + firstBcp47: string; + }; + }; + write(artifacts: KeyboardInfoCompilerArtifacts): Promise; +} + +// @public +export interface KeyboardInfoCompilerArtifacts extends KeymanCompilerArtifacts { + keyboard_info: KeymanCompilerArtifact; +} + +// Warning: (ae-internal-missing-underscore) The name "KeyboardInfoCompilerMessages" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal (undocumented) +export class KeyboardInfoCompilerMessages { + // (undocumented) + static ERROR_CannotBuildWithoutKmpFile: number; + // (undocumented) + static Error_CannotBuildWithoutKmpFile: () => CompilerEvent; + // (undocumented) + static ERROR_DescriptionIsMissing: number; + // (undocumented) + static Error_DescriptionIsMissing: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_FileDoesNotExist: number; + // (undocumented) + static Error_FileDoesNotExist: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_FontFileCannotBeRead: number; + // (undocumented) + static Error_FontFileCannotBeRead: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_FontFileMetaDataIsInvalid: number; + // (undocumented) + static Error_FontFileMetaDataIsInvalid: (o: { + filename: string; + message: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_InvalidAuthorEmail: number; + // (undocumented) + static Error_InvalidAuthorEmail: (o: { + email: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_LicenseFileIsDamaged: number; + // (undocumented) + static Error_LicenseFileIsDamaged: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_LicenseFileIsMissing: number; + // (undocumented) + static Error_LicenseFileIsMissing: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_LicenseIsNotValid: number; + // (undocumented) + static Error_LicenseIsNotValid: (o: { + filename: string; + message: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_NoLicenseFound: number; + // (undocumented) + static Error_NoLicenseFound: () => CompilerEvent; + // (undocumented) + static FATAL_UnexpectedException: number; + // (undocumented) + static Fatal_UnexpectedException: (o: { + e: any; + }) => CompilerEvent; + // (undocumented) + static HINT_ScriptDoesNotMatch: number; + // (undocumented) + static Hint_ScriptDoesNotMatch: (o: { + script: string; + bcp47: string; + commonScript: string; + firstBcp47: string; + }) => CompilerEvent; + // (undocumented) + static WARN_LanguageTagNotFound: number; + // (undocumented) + static Warn_LanguageTagNotFound: (o: { + bcp47: string; + langSubtag: string; + }) => CompilerEvent; + // (undocumented) + static WARN_LanguageTagNotFound2: number; + // (undocumented) + static Warn_LanguageTagNotFound2: (o: { + bcp47: string; + }) => CompilerEvent; +} + +// @public +export interface KeyboardInfoCompilerOptions extends CompilerOptions { + sources: KeyboardInfoSources; +} + +// @public +export interface KeyboardInfoCompilerResult extends KeymanCompilerResult { + artifacts: KeyboardInfoCompilerArtifacts; +} + +// @public +export interface KeyboardInfoSources { + forPublishing: boolean; + jsFilename?: string; + kmpFilename: string; + kpsFilename: string; + lastCommitDate?: string; + sourcePath: string; +} + +// Warnings were encountered during analysis: +// +// src/keyboard-info-compiler.ts:674:14 - (ae-forgotten-export) The symbol "KeyboardInfoFileLanguage" needs to be exported by the entry point index.d.ts + +// (No @packageDocumentation comment for this package) + +``` diff --git a/developer/docs/api/etc/kmc-kmn.api.md b/developer/docs/api/etc/kmc-kmn.api.md index de1bd503f8..0805075e56 100644 --- a/developer/docs/api/etc/kmc-kmn.api.md +++ b/developer/docs/api/etc/kmc-kmn.api.md @@ -1,958 +1,978 @@ -## API Report File for "@keymanapp/kmc-kmn" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { CompilerCallbacks } from '@keymanapp/common-types'; -import { CompilerEvent } from '@keymanapp/common-types'; -import { CompilerOptions } from '@keymanapp/common-types'; -import { KeymanCompiler } from '@keymanapp/common-types'; -import { KeymanCompilerArtifactOptional } from '@keymanapp/common-types'; -import { KeymanCompilerArtifacts } from '@keymanapp/common-types'; -import { KeymanCompilerResult } from '@keymanapp/common-types'; -import { TouchLayout } from '@keymanapp/common-types'; -import { UnicodeSet } from '@keymanapp/common-types'; -import { UnicodeSetParser } from '@keymanapp/common-types'; -import { VisualKeyboard } from '@keymanapp/common-types'; - -// Warning: (ae-internal-missing-underscore) The name "CompilerResultExtraGroup" should be prefixed with an underscore because the declaration is marked as @internal -// -// @internal (undocumented) -export interface CompilerResultExtraGroup { - // (undocumented) - isReadOnly: boolean; - // (undocumented) - name: string; -} - -// Warning: (ae-internal-missing-underscore) The name "CompilerResultExtraStore" should be prefixed with an underscore because the declaration is marked as @internal -// -// @internal (undocumented) -export interface CompilerResultExtraStore { - // (undocumented) - line: number; - // (undocumented) - name: string; - // (undocumented) - storeType: number; -} - -// @public -export class KmnCompiler implements KeymanCompiler, UnicodeSetParser { - constructor(); - // @internal - static fixNewPattern(pattern: string): string; - init(callbacks: CompilerCallbacks, options: KmnCompilerOptions): Promise; - // @internal (undocumented) - parseUnicodeSet(pattern: string, rangeCount: number): UnicodeSet | null; - run(infile: string, outfile: string): Promise; - // @internal (undocumented) - sizeUnicodeSet(pattern: string): number; - // @internal - testSentry(): any; - verifyInitialized(): boolean; - write(artifacts: KmnCompilerArtifacts): Promise; -} - -// @public -export interface KmnCompilerArtifacts extends KeymanCompilerArtifacts { - js?: KeymanCompilerArtifactOptional; - kmx?: KeymanCompilerArtifactOptional; - kvk?: KeymanCompilerArtifactOptional; -} - -// Warning: (ae-internal-missing-underscore) The name "KmnCompilerMessages" should be prefixed with an underscore because the declaration is marked as @internal -// -// @internal -export class KmnCompilerMessages { - // (undocumented) - static ERROR_140FeatureOnlyContextAndNotAnyWeb: number; - // (undocumented) - static Error_140FeatureOnlyContextAndNotAnyWeb: () => CompilerEvent; - // (undocumented) - static ERROR_501FeatureOnly_Call: number; - // (undocumented) - static Error_501FeatureOnly_Call: () => CompilerEvent; - // (undocumented) - static ERROR_60FeatureOnly_Contextn: number; - // (undocumented) - static Error_60FeatureOnly_Contextn: () => CompilerEvent; - // (undocumented) - static ERROR_60FeatureOnly_EthnologueCode: number; - // (undocumented) - static Error_60FeatureOnly_EthnologueCode: () => CompilerEvent; - // (undocumented) - static ERROR_60FeatureOnly_MnemonicLayout: number; - // (undocumented) - static Error_60FeatureOnly_MnemonicLayout: () => CompilerEvent; - // (undocumented) - static ERROR_60FeatureOnly_NamedCodes: number; - // (undocumented) - static Error_60FeatureOnly_NamedCodes: () => CompilerEvent; - // (undocumented) - static ERROR_60FeatureOnly_OldCharPosMatching: number; - // (undocumented) - static Error_60FeatureOnly_OldCharPosMatching: () => CompilerEvent; - // (undocumented) - static ERROR_60FeatureOnly_VirtualCharKey: number; - // (undocumented) - static Error_60FeatureOnly_VirtualCharKey: () => CompilerEvent; - // (undocumented) - static ERROR_70FeatureOnly: number; - // (undocumented) - static Error_70FeatureOnly: () => CompilerEvent; - // (undocumented) - static ERROR_80FeatureOnly: number; - // (undocumented) - static Error_80FeatureOnly: () => CompilerEvent; - // (undocumented) - static ERROR_90FeatureOnly_IfSystemStores: number; - // (undocumented) - static Error_90FeatureOnly_IfSystemStores: () => CompilerEvent; - // (undocumented) - static ERROR_90FeatureOnly_SetSystemStores: number; - // (undocumented) - static Error_90FeatureOnly_SetSystemStores: () => CompilerEvent; - // (undocumented) - static ERROR_90FeatureOnlyEmbedCSS: number; - // (undocumented) - static Error_90FeatureOnlyEmbedCSS: () => CompilerEvent; - // (undocumented) - static ERROR_90FeatureOnlyKeyboardVersion: number; - // (undocumented) - static Error_90FeatureOnlyKeyboardVersion: () => CompilerEvent; - // (undocumented) - static ERROR_90FeatureOnlyLayoutFile: number; - // (undocumented) - static Error_90FeatureOnlyLayoutFile: () => CompilerEvent; - // (undocumented) - static ERROR_90FeatureOnlyTargets: number; - // (undocumented) - static Error_90FeatureOnlyTargets: () => CompilerEvent; - // (undocumented) - static ERROR_90FeatureOnlyVirtualKeyDictionary: number; - // (undocumented) - static Error_90FeatureOnlyVirtualKeyDictionary: () => CompilerEvent; - // (undocumented) - static ERROR_AnyInVirtualKeySection: number; - // (undocumented) - static Error_AnyInVirtualKeySection: () => CompilerEvent; - // (undocumented) - static ERROR_BeepInVirtualKeySection: number; - // (undocumented) - static Error_BeepInVirtualKeySection: () => CompilerEvent; - // (undocumented) - static ERROR_CallInVirtualKeySection: number; - // (undocumented) - static Error_CallInVirtualKeySection: () => CompilerEvent; - // (undocumented) - static ERROR_CannotLoadIncludeFile: number; - // (undocumented) - static Error_CannotLoadIncludeFile: () => CompilerEvent; - // (undocumented) - static ERROR_CannotReadBitmapFile: number; - // (undocumented) - static Error_CannotReadBitmapFile: () => CompilerEvent; - // (undocumented) - static ERROR_CannotReadInfile: number; - // (undocumented) - static Error_CannotReadInfile: () => CompilerEvent; - // (undocumented) - static ERROR_CannotUseReadWriteGroupFromReadonlyGroup: number; - // (undocumented) - static Error_CannotUseReadWriteGroupFromReadonlyGroup: () => CompilerEvent; - // (undocumented) - static ERROR_CasedKeysMustContainOnlyVirtualKeys: number; - // (undocumented) - static Error_CasedKeysMustContainOnlyVirtualKeys: () => CompilerEvent; - // (undocumented) - static ERROR_CasedKeysMustNotIncludeShiftStates: number; - // (undocumented) - static Error_CasedKeysMustNotIncludeShiftStates: () => CompilerEvent; - // (undocumented) - static ERROR_CasedKeysNotSupportedWithMnemonicLayout: number; - // (undocumented) - static Error_CasedKeysNotSupportedWithMnemonicLayout: () => CompilerEvent; - // (undocumented) - static ERROR_CharacterExpansionMustBeFollowedByCharacter: number; - // (undocumented) - static Error_CharacterExpansionMustBeFollowedByCharacter: () => CompilerEvent; - // (undocumented) - static ERROR_CharacterRangeTooLong: number; - // (undocumented) - static Error_CharacterRangeTooLong: () => CompilerEvent; - // (undocumented) - static ERROR_CodeInvalidInKeyStore: number; - // (undocumented) - static Error_CodeInvalidInKeyStore: () => CompilerEvent; - // (undocumented) - static ERROR_CodeInvalidInThisSection: number; - // (undocumented) - static Error_CodeInvalidInThisSection: () => CompilerEvent; - // (undocumented) - static ERROR_ContextAndIndexInvalidInMatchNomatch: number; - // (undocumented) - static Error_ContextAndIndexInvalidInMatchNomatch: () => CompilerEvent; - // (undocumented) - static ERROR_ContextExHasInvalidOffset: number; - // (undocumented) - static Error_ContextExHasInvalidOffset: () => CompilerEvent; - // (undocumented) - static ERROR_ContextInVirtualKeySection: number; - // (undocumented) - static Error_ContextInVirtualKeySection: () => CompilerEvent; - // (undocumented) - static ERROR_DuplicateGroup: number; - // (undocumented) - static Error_DuplicateGroup: () => CompilerEvent; - // (undocumented) - static ERROR_DuplicateStore: number; - // (undocumented) - static Error_DuplicateStore: () => CompilerEvent; - // (undocumented) - static ERROR_ExpansionMustBePositive: number; - // (undocumented) - static Error_ExpansionMustBePositive: () => CompilerEvent; - // (undocumented) - static ERROR_ExpansionMustFollowCharacterOrVKey: number; - // (undocumented) - static Error_ExpansionMustFollowCharacterOrVKey: () => CompilerEvent; - // (undocumented) - static ERROR_ExtendedStringTooLong: number; - // (undocumented) - static Error_ExtendedStringTooLong: () => CompilerEvent; - // (undocumented) - static ERROR_FileNotFound: number; - // (undocumented) - static Error_FileNotFound: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_GroupDoesNotExist: number; - // (undocumented) - static Error_GroupDoesNotExist: () => CompilerEvent; - // (undocumented) - static ERROR_IfSystemStore_NotFound: number; - // (undocumented) - static Error_IfSystemStore_NotFound: () => CompilerEvent; - // (undocumented) - static ERROR_IndexDoesNotPointToAny: number; - // (undocumented) - static Error_IndexDoesNotPointToAny: () => CompilerEvent; - // (undocumented) - static ERROR_IndexInVirtualKeySection: number; - // (undocumented) - static Error_IndexInVirtualKeySection: () => CompilerEvent; - // (undocumented) - static ERROR_InfileNotExist: number; - // (undocumented) - static Error_InfileNotExist: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidAny: number; - // (undocumented) - static Error_InvalidAny: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidBegin: number; - // (undocumented) - static Error_InvalidBegin: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidBitmapLine: number; - // (undocumented) - static Error_InvalidBitmapLine: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidCall: number; - // (undocumented) - static Error_InvalidCall: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidCharacter: number; - // (undocumented) - static Error_InvalidCharacter: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidCodeInKeyPartOfRule: number; - // (undocumented) - static Error_InvalidCodeInKeyPartOfRule: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidCopyright: number; - // (undocumented) - static Error_InvalidCopyright: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidDeadkey: number; - // (undocumented) - static Error_InvalidDeadkey: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidDisplayMapFile: number; - // (undocumented) - static Error_InvalidDisplayMapFile: (o: { - filename: string; - e: any; - }) => CompilerEvent; - // (undocumented) - static ERROR_InvalidEthnologueCode: number; - // (undocumented) - static Error_InvalidEthnologueCode: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidGroupLine: number; - // (undocumented) - static Error_InvalidGroupLine: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidIf: number; - // (undocumented) - static Error_InvalidIf: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidIndex: number; - // (undocumented) - static Error_InvalidIndex: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidInVirtualKeySection: number; - // (undocumented) - static Error_InvalidInVirtualKeySection: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidKeyCode: number; - // (undocumented) - static Error_InvalidKeyCode: (o: { - keyId: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_InvalidKvkFile: number; - // (undocumented) - static Error_InvalidKvkFile: (o: { - filename: string; - e: any; - }) => CompilerEvent; - // (undocumented) - static ERROR_InvalidKvksFile: number; - // (undocumented) - static Error_InvalidKvksFile: (o: { - filename: string; - e: any; - }) => CompilerEvent; - // (undocumented) - static ERROR_InvalidLanguageLine: number; - // (undocumented) - static Error_InvalidLanguageLine: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidLanguageName: number; - // (undocumented) - static Error_InvalidLanguageName: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidLayoutLine: number; - // (undocumented) - static Error_InvalidLayoutLine: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidLineContinuation: number; - // (undocumented) - static Error_InvalidLineContinuation: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidMessage: number; - // (undocumented) - static Error_InvalidMessage: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidName: number; - // (undocumented) - static Error_InvalidName: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidNamedCode: number; - // (undocumented) - static Error_InvalidNamedCode: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidOuts: number; - // (undocumented) - static Error_InvalidOuts: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidReset: number; - // (undocumented) - static Error_InvalidReset: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidSave: number; - // (undocumented) - static Error_InvalidSave: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidSet: number; - // (undocumented) - static Error_InvalidSet: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidStoreLine: number; - // (undocumented) - static Error_InvalidStoreLine: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidSwitch: number; - // (undocumented) - static Error_InvalidSwitch: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidSystemStore: number; - // (undocumented) - static Error_InvalidSystemStore: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidTarget: number; - // (undocumented) - static Error_InvalidTarget: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidToken: number; - // (undocumented) - static Error_InvalidToken: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidTouchLayoutFile: number; - // (undocumented) - static Error_InvalidTouchLayoutFile: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_InvalidUse: number; - // (undocumented) - static Error_InvalidUse: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidValue: number; - // (undocumented) - static Error_InvalidValue: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidVersion: number; - // (undocumented) - static Error_InvalidVersion: () => CompilerEvent; - // (undocumented) - static ERROR_KeyboardVersionFormatInvalid: number; - // (undocumented) - static Error_KeyboardVersionFormatInvalid: () => CompilerEvent; - // (undocumented) - static ERROR_LayoutButNoLanguage: number; - // (undocumented) - static Error_LayoutButNoLanguage: () => CompilerEvent; - // (undocumented) - static ERROR_LineTooLong: number; - // (undocumented) - static Error_LineTooLong: () => CompilerEvent; - // (undocumented) - static ERROR_NewContextGroupMustBeReadonly: number; - // (undocumented) - static Error_NewContextGroupMustBeReadonly: () => CompilerEvent; - // (undocumented) - static ERROR_NonBMPCharactersNotSupportedInKeySection: number; - // (undocumented) - static Error_NonBMPCharactersNotSupportedInKeySection: () => CompilerEvent; - // (undocumented) - static ERROR_NoTargetsSpecified: number; - // (undocumented) - static Error_NoTargetsSpecified: () => CompilerEvent; - // (undocumented) - static ERROR_NoTokensFound: number; - // (undocumented) - static Error_NoTokensFound: () => CompilerEvent; - // (undocumented) - static ERROR_NotSupportedInKeymanWebContext: number; - // (undocumented) - static Error_NotSupportedInKeymanWebContext: (o: { - line: number; - code: String; - }) => CompilerEvent; - // (undocumented) - static ERROR_NotSupportedInKeymanWebOutput: number; - // (undocumented) - static Error_NotSupportedInKeymanWebOutput: (o: { - line: number; - code: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_NotSupportedInKeymanWebStore: number; - // (undocumented) - static Error_NotSupportedInKeymanWebStore: (o: { - code: string; - store: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_NoVersionLine: number; - // (undocumented) - static Error_NoVersionLine: () => CompilerEvent; - // (undocumented) - static ERROR_OutputInReadonlyGroup: number; - // (undocumented) - static Error_OutputInReadonlyGroup: () => CompilerEvent; - // (undocumented) - static ERROR_OutsInVirtualKeySection: number; - // (undocumented) - static Error_OutsInVirtualKeySection: () => CompilerEvent; - // (undocumented) - static ERROR_OutsTooLong: number; - // (undocumented) - static Error_OutsTooLong: () => CompilerEvent; - // (undocumented) - static ERROR_PostKeystrokeGroupMustBeReadonly: number; - // (undocumented) - static Error_PostKeystrokeGroupMustBeReadonly: () => CompilerEvent; - // (undocumented) - static ERROR_RepeatedBegin: number; - // (undocumented) - static Error_RepeatedBegin: () => CompilerEvent; - // (undocumented) - static ERROR_ReservedCharacter: number; - // (undocumented) - static Error_ReservedCharacter: () => CompilerEvent; - // (undocumented) - static ERROR_SetSystemStore_NotFound: number; - // (undocumented) - static Error_SetSystemStore_NotFound: () => CompilerEvent; - // (undocumented) - static ERROR_StatementNotPermittedInReadonlyGroup: number; - // (undocumented) - static Error_StatementNotPermittedInReadonlyGroup: () => CompilerEvent; - // (undocumented) - static ERROR_StoreDoesNotExist: number; - // (undocumented) - static Error_StoreDoesNotExist: () => CompilerEvent; - // (undocumented) - static ERROR_StringInVirtualKeySection: number; - // (undocumented) - static Error_StringInVirtualKeySection: () => CompilerEvent; - // (undocumented) - static ERROR_TooManyIndexToKeyRefs: number; - // (undocumented) - static Error_TooManyIndexToKeyRefs: () => CompilerEvent; - // (undocumented) - static ERROR_TouchLayoutInvalidIdentifier: number; - // (undocumented) - static Error_TouchLayoutInvalidIdentifier: (o: { - keyId: string; - platformName: string; - layerId: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_UnicodeSetHasProperties: number; - // (undocumented) - static Error_UnicodeSetHasProperties: () => CompilerEvent; - // (undocumented) - static ERROR_UnicodeSetHasStrings: number; - // (undocumented) - static Error_UnicodeSetHasStrings: () => CompilerEvent; - // (undocumented) - static ERROR_UnicodeSetSyntaxError: number; - // (undocumented) - static Error_UnicodeSetSyntaxError: () => CompilerEvent; - // (undocumented) - static ERROR_UnterminatedString: number; - // (undocumented) - static Error_UnterminatedString: () => CompilerEvent; - // (undocumented) - static ERROR_VersionAlreadyIncluded: number; - // (undocumented) - static Error_VersionAlreadyIncluded: () => CompilerEvent; - // (undocumented) - static ERROR_VirtualCharacterKeysNotSupportedInKeymanWeb: number; - // (undocumented) - static Error_VirtualCharacterKeysNotSupportedInKeymanWeb: (o: { - line: number; - }) => CompilerEvent; - // (undocumented) - static ERROR_VirtualKeyExpansionTooLong: number; - // (undocumented) - static Error_VirtualKeyExpansionTooLong: () => CompilerEvent; - // (undocumented) - static ERROR_VirtualKeyInContext: number; - // (undocumented) - static Error_VirtualKeyInContext: () => CompilerEvent; - // (undocumented) - static ERROR_VirtualKeyNotAllowedHere: number; - // (undocumented) - static Error_VirtualKeyNotAllowedHere: () => CompilerEvent; - // (undocumented) - static ERROR_VirtualKeysNotValidForMnemonicLayouts: number; - // (undocumented) - static Error_VirtualKeysNotValidForMnemonicLayouts: (o: { - line: number; - }) => CompilerEvent; - // (undocumented) - static ERROR_VKeyExpansionMustBeFollowedByVKey: number; - // (undocumented) - static Error_VKeyExpansionMustBeFollowedByVKey: () => CompilerEvent; - // (undocumented) - static ERROR_VKeyExpansionMustUseConsistentShift: number; - // (undocumented) - static Error_VKeyExpansionMustUseConsistentShift: () => CompilerEvent; - // (undocumented) - static ERROR_ZeroLengthString: number; - // (undocumented) - static Error_ZeroLengthString: () => CompilerEvent; - // (undocumented) - static FATAL_BadCallParams: number; - // (undocumented) - static Fatal_BadCallParams: () => CompilerEvent; - // (undocumented) - static FATAL_Break: number; - // (undocumented) - static Fatal_Break: () => CompilerEvent; - // (undocumented) - static FATAL_BufferOverflow: number; - // (undocumented) - static Fatal_BufferOverflow: () => CompilerEvent; - // (undocumented) - static FATAL_CallbacksNotSet: number; - // (undocumented) - static Fatal_CallbacksNotSet: () => CompilerEvent; - // (undocumented) - static FATAL_CannotAllocateMemory: number; - // (undocumented) - static Fatal_CannotAllocateMemory: () => CompilerEvent; - // (undocumented) - static FATAL_CannotCreateTempfile: number; - // (undocumented) - static Fatal_CannotCreateTempfile: () => CompilerEvent; - // (undocumented) - static FATAL_MissingWasmModule: number; - // (undocumented) - static Fatal_MissingWasmModule: (o: { - e?: any; - }) => CompilerEvent; - // (undocumented) - static FATAL_SomewhereIGotItWrong: number; - // (undocumented) - static Fatal_SomewhereIGotItWrong: () => CompilerEvent; - // (undocumented) - static FATAL_UnableToWriteFully: number; - // (undocumented) - static Fatal_UnableToWriteFully: () => CompilerEvent; - // (undocumented) - static FATAL_UnexpectedException: number; - // (undocumented) - static Fatal_UnexpectedException: (o: { - e: any; - }) => CompilerEvent; - // (undocumented) - static FATAL_UnicodeSetOutOfRange: number; - // (undocumented) - static Fatal_UnicodeSetOutOfRange: () => CompilerEvent; - // (undocumented) - static HINT_IndexStoreLong: number; - // (undocumented) - static Hint_IndexStoreLong: () => CompilerEvent; - // (undocumented) - static HINT_NonUnicodeFile: number; - // (undocumented) - static Hint_NonUnicodeFile: () => CompilerEvent; - // (undocumented) - static HINT_UnreachableKeyCode: number; - // (undocumented) - static Hint_UnreachableKeyCode: (o: { - line: number; - key: string; - }) => CompilerEvent; - // (undocumented) - static HINT_UnreachableRule: number; - // (undocumented) - static Hint_UnreachableRule: () => CompilerEvent; - // (undocumented) - static INFO_EndOfFile: number; - // (undocumented) - static Info_EndOfFile: () => CompilerEvent; - // (undocumented) - static INFO_Info: number; - // (undocumented) - static Info_Info: () => CompilerEvent; - // (undocumented) - static WARN_ANSIInUnicodeGroup: number; - // (undocumented) - static Warn_ANSIInUnicodeGroup: () => CompilerEvent; - // (undocumented) - static WARN_BitmapNotUsed: number; - // (undocumented) - static Warn_BitmapNotUsed: () => CompilerEvent; - // (undocumented) - static WARN_CustomLanguagesNotSupported: number; - // (undocumented) - static Warn_CustomLanguagesNotSupported: () => CompilerEvent; - // (undocumented) - static WARN_DontMixChiralAndNonChiralModifiers: number; - // (undocumented) - static Warn_DontMixChiralAndNonChiralModifiers: () => CompilerEvent; - // (undocumented) - static WARN_EmbedJsFileMissing: number; - // (undocumented) - static Warn_EmbedJsFileMissing: (o: { - line: number; - jsFilename: string; - e: any; - }) => CompilerEvent; - // (undocumented) - static WARN_ExtendedShiftFlagsNotSupportedInKeymanWeb: number; - // (undocumented) - static Warn_ExtendedShiftFlagsNotSupportedInKeymanWeb: (o: { - line: number; - flags: string; - }) => CompilerEvent; - // (undocumented) - static WARN_HeaderStatementIsDeprecated: number; - // (undocumented) - static Warn_HeaderStatementIsDeprecated: () => CompilerEvent; - // (undocumented) - static WARN_HelpFileMissing: number; - // (undocumented) - static Warn_HelpFileMissing: (o: { - line: number; - helpFilename: string; - e: any; - }) => CompilerEvent; - // (undocumented) - static WARN_HotkeyHasInvalidModifier: number; - // (undocumented) - static Warn_HotkeyHasInvalidModifier: () => CompilerEvent; - // (undocumented) - static WARN_IfShouldBeAtStartOfContext: number; - // (undocumented) - static Warn_IfShouldBeAtStartOfContext: () => CompilerEvent; - // (undocumented) - static WARN_IndexStoreShort: number; - // (undocumented) - static Warn_IndexStoreShort: () => CompilerEvent; - // (undocumented) - static WARN_InvalidVkeyInKvksFile: number; - // (undocumented) - static Warn_InvalidVkeyInKvksFile: (o: { - filename: string; - invalidVkey: string; - }) => CompilerEvent; - // (undocumented) - static WARN_KeyBadLength: number; - // (undocumented) - static Warn_KeyBadLength: () => CompilerEvent; - // (undocumented) - static WARN_KeyShouldIncludeNCaps: number; - // (undocumented) - static Warn_KeyShouldIncludeNCaps: () => CompilerEvent; - // (undocumented) - static WARN_KVKFileIsInSourceFormat: number; - // (undocumented) - static Warn_KVKFileIsInSourceFormat: () => CompilerEvent; - // (undocumented) - static WARN_LanguageHeadersDeprecatedInKeyman10: number; - // (undocumented) - static Warn_LanguageHeadersDeprecatedInKeyman10: () => CompilerEvent; - // (undocumented) - static WARN_MixingLeftAndRightModifiers: number; - // (undocumented) - static Warn_MixingLeftAndRightModifiers: () => CompilerEvent; - // (undocumented) - static WARN_NulNotFirstStatementInContext: number; - // (undocumented) - static Warn_NulNotFirstStatementInContext: () => CompilerEvent; - // (undocumented) - static WARN_OldVersion: number; - // (undocumented) - static Warn_OldVersion: () => CompilerEvent; - // (undocumented) - static WARN_OptionStoreNameInvalid: number; - // (undocumented) - static Warn_OptionStoreNameInvalid: (o: { - name: string; - }) => CompilerEvent; - // (undocumented) - static WARN_PlatformNotInTargets: number; - // (undocumented) - static Warn_PlatformNotInTargets: () => CompilerEvent; - // (undocumented) - static WARN_PunctuationInEthnologueCode: number; - // (undocumented) - static Warn_PunctuationInEthnologueCode: () => CompilerEvent; - // (undocumented) - static WARN_ReservedCharacter: number; - // (undocumented) - static Warn_ReservedCharacter: () => CompilerEvent; - // (undocumented) - static WARN_StoreAlreadyUsedAsOptionOrCall: number; - // (undocumented) - static Warn_StoreAlreadyUsedAsOptionOrCall: () => CompilerEvent; - // (undocumented) - static WARN_StoreAlreadyUsedAsStoreOrCall: number; - // (undocumented) - static Warn_StoreAlreadyUsedAsStoreOrCall: () => CompilerEvent; - // (undocumented) - static WARN_StoreAlreadyUsedAsStoreOrOption: number; - // (undocumented) - static Warn_StoreAlreadyUsedAsStoreOrOption: () => CompilerEvent; - // (undocumented) - static WARN_TooManyWarnings: number; - // (undocumented) - static Warn_TooManyWarnings: () => CompilerEvent; - // (undocumented) - static WARN_TouchLayoutCustomKeyNotDefined: number; - // (undocumented) - static Warn_TouchLayoutCustomKeyNotDefined: (o: { - keyId: string; - platformName: string; - layerId: string; - }) => CompilerEvent; - // (undocumented) - static WARN_TouchLayoutFontShouldBeSameForAllPlatforms: number; - // (undocumented) - static Warn_TouchLayoutFontShouldBeSameForAllPlatforms: () => CompilerEvent; - // (undocumented) - static WARN_TouchLayoutMissingLayer: number; - // (undocumented) - static Warn_TouchLayoutMissingLayer: (o: { - keyId: string; - platformName: string; - layerId: string; - nextLayer: string; - }) => CompilerEvent; - // (undocumented) - static WARN_TouchLayoutMissingRequiredKeys: number; - // (undocumented) - static Warn_TouchLayoutMissingRequiredKeys: (o: { - layerId: string; - platformName: string; - missingKeys: string; - }) => CompilerEvent; - // (undocumented) - static WARN_TouchLayoutSpecialLabelOnNormalKey: number; - // (undocumented) - static Warn_TouchLayoutSpecialLabelOnNormalKey: (o: { - keyId: string; - platformName: string; - layerId: string; - label: string; - }) => CompilerEvent; - // (undocumented) - static WARN_TouchLayoutUnidentifiedKey: number; - // (undocumented) - static Warn_TouchLayoutUnidentifiedKey: (o: { - layerId: string; - }) => CompilerEvent; - // (undocumented) - static WARN_UnicodeInANSIGroup: number; - // (undocumented) - static Warn_UnicodeInANSIGroup: () => CompilerEvent; - // (undocumented) - static WARN_UnicodeSurrogateUsed: number; - // (undocumented) - static Warn_UnicodeSurrogateUsed: () => CompilerEvent; - // (undocumented) - static WARN_UseNotLastStatementInRule: number; - // (undocumented) - static Warn_UseNotLastStatementInRule: () => CompilerEvent; - // (undocumented) - static WARN_VirtualCharKeyWithPositionalLayout: number; - // (undocumented) - static Warn_VirtualCharKeyWithPositionalLayout: () => CompilerEvent; - // (undocumented) - static WARN_VirtualKeyInOutput: number; - // (undocumented) - static Warn_VirtualKeyInOutput: () => CompilerEvent; - // (undocumented) - static WARN_VirtualKeyWithMnemonicLayout: number; - // (undocumented) - static Warn_VirtualKeyWithMnemonicLayout: () => CompilerEvent; -} - -// @public -export interface KmnCompilerOptions extends CompilerOptions { -} - -// @public -export interface KmnCompilerResult extends KeymanCompilerResult { - artifacts: KmnCompilerArtifacts; - displayMap?: Osk.PuaMap; - // Warning: (ae-incompatible-release-tags) The symbol "extra" is marked as @public, but its signature references "KmnCompilerResultExtra" which is marked as @internal - extra: KmnCompilerResultExtra; -} - -// Warning: (ae-internal-missing-underscore) The name "KmnCompilerResultExtra" should be prefixed with an underscore because the declaration is marked as @internal -// -// @internal -export interface KmnCompilerResultExtra { - // (undocumented) - displayMapFilename?: string; - // (undocumented) - groups: CompilerResultExtraGroup[]; - // (undocumented) - kvksFilename?: string; - // (undocumented) - stores: CompilerResultExtraStore[]; - targets: number; -} - -// Warning: (ae-internal-missing-underscore) The name "KmwCompilerMessages" should be prefixed with an underscore because the declaration is marked as @internal -// -// @internal -export class KmwCompilerMessages extends KmnCompilerMessages { - // (undocumented) - static ERROR_InvalidTouchLayoutFileFormat: number; - // (undocumented) - static Error_InvalidTouchLayoutFileFormat: (o: { - msg: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_TouchLayoutFileDoesNotExist: number; - // (undocumented) - static Error_TouchLayoutFileDoesNotExist: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_TouchLayoutIdentifierRequires15: number; - // (undocumented) - static Error_TouchLayoutIdentifierRequires15: (o: { - keyId: string; - platformName: string; - layerId: string; - }) => CompilerEvent; - // (undocumented) - static HINT_TouchLayoutUsesUnsupportedGesturesDownlevel: number; - // (undocumented) - static Hint_TouchLayoutUsesUnsupportedGesturesDownlevel: (o: { - keyId: string; - }) => CompilerEvent; - // (undocumented) - static INFO_MinimumEngineVersion: number; - // (undocumented) - static Info_MinimumEngineVersion: (o: { - version: string; - }) => CompilerEvent; -} - -declare namespace Osk { - export { - parseMapping, - remapVisualKeyboard, - remapTouchLayout, - StringRefUsage, - StringRef, - StringResult, - PuaMap - } -} -export { Osk } - -// @public (undocumented) -function parseMapping(mapping: any): PuaMap; - -// @public (undocumented) -type PuaMap = { - [index: string]: string; -}; - -// @public (undocumented) -function remapTouchLayout(source: TouchLayout.TouchLayoutFile, map: PuaMap): boolean; - -// @public (undocumented) -function remapVisualKeyboard(vk: VisualKeyboard.VisualKeyboard, map: PuaMap): boolean; - -// @public (undocumented) -interface StringRef { - // (undocumented) - str: string; - // (undocumented) - usages: StringRefUsage[]; -} - -// @public (undocumented) -interface StringRefUsage { - // (undocumented) - count: number; - // (undocumented) - filename: string; -} - -// @public -interface StringResult { - pua: string; - str: string; - unicode: string; - usages: StringRefUsage[] | string[]; -} - -``` +## API Report File for "@keymanapp/kmc-kmn" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { CompilerCallbacks } from '@keymanapp/developer-utils'; +import { CompilerEvent } from '@keymanapp/developer-utils'; +import { CompilerOptions } from '@keymanapp/developer-utils'; +import { KeymanCompiler } from '@keymanapp/developer-utils'; +import { KeymanCompilerArtifactOptional } from '@keymanapp/developer-utils'; +import { KeymanCompilerArtifacts } from '@keymanapp/developer-utils'; +import { KeymanCompilerResult } from '@keymanapp/developer-utils'; +import { LdmlKeyboardTypes } from '@keymanapp/common-types'; +import { ObjectWithCompileContext } from '@keymanapp/common-types'; +import { TouchLayout } from '@keymanapp/common-types'; +import { VisualKeyboard } from '@keymanapp/common-types'; + +// Warning: (ae-internal-missing-underscore) The name "CompilerResultExtraGroup" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal (undocumented) +export interface CompilerResultExtraGroup { + // (undocumented) + isReadOnly: boolean; + // (undocumented) + name: string; +} + +// Warning: (ae-internal-missing-underscore) The name "CompilerResultExtraStore" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal (undocumented) +export interface CompilerResultExtraStore { + // (undocumented) + line: number; + // (undocumented) + name: string; + // (undocumented) + storeType: number; +} + +// @public +export class KmnCompiler implements KeymanCompiler, LdmlKeyboardTypes.UnicodeSetParser { + // @internal + static fixNewPattern(pattern: string): string; + init(callbacks: CompilerCallbacks, options: KmnCompilerOptions): Promise; + // @internal (undocumented) + parseUnicodeSet(pattern: string, rangeCount: number, compileContext?: any): LdmlKeyboardTypes.UnicodeSet | null; + run(infile: string, outfile: string): Promise; + // @internal (undocumented) + sizeUnicodeSet(pattern: string, compileContext?: any): number; + // @internal + testSentry(): any; + verifyInitialized(): boolean; + write(artifacts: KmnCompilerArtifacts): Promise; +} + +// @public +export interface KmnCompilerArtifacts extends KeymanCompilerArtifacts { + js?: KeymanCompilerArtifactOptional; + kmx?: KeymanCompilerArtifactOptional; + kvk?: KeymanCompilerArtifactOptional; +} + +// Warning: (ae-internal-missing-underscore) The name "KmnCompilerMessages" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal +export class KmnCompilerMessages { + // (undocumented) + static ERROR_140FeatureOnlyContextAndNotAnyWeb: number; + // (undocumented) + static Error_140FeatureOnlyContextAndNotAnyWeb: () => CompilerEvent; + // (undocumented) + static ERROR_501FeatureOnly_Call: number; + // (undocumented) + static Error_501FeatureOnly_Call: () => CompilerEvent; + // (undocumented) + static ERROR_60FeatureOnly_Contextn: number; + // (undocumented) + static Error_60FeatureOnly_Contextn: () => CompilerEvent; + // (undocumented) + static ERROR_60FeatureOnly_EthnologueCode: number; + // (undocumented) + static Error_60FeatureOnly_EthnologueCode: () => CompilerEvent; + // (undocumented) + static ERROR_60FeatureOnly_MnemonicLayout: number; + // (undocumented) + static Error_60FeatureOnly_MnemonicLayout: () => CompilerEvent; + // (undocumented) + static ERROR_60FeatureOnly_NamedCodes: number; + // (undocumented) + static Error_60FeatureOnly_NamedCodes: () => CompilerEvent; + // (undocumented) + static ERROR_60FeatureOnly_OldCharPosMatching: number; + // (undocumented) + static Error_60FeatureOnly_OldCharPosMatching: () => CompilerEvent; + // (undocumented) + static ERROR_60FeatureOnly_VirtualCharKey: number; + // (undocumented) + static Error_60FeatureOnly_VirtualCharKey: () => CompilerEvent; + // (undocumented) + static ERROR_70FeatureOnly: number; + // (undocumented) + static Error_70FeatureOnly: () => CompilerEvent; + // (undocumented) + static ERROR_80FeatureOnly: number; + // (undocumented) + static Error_80FeatureOnly: () => CompilerEvent; + // (undocumented) + static ERROR_90FeatureOnly_IfSystemStores: number; + // (undocumented) + static Error_90FeatureOnly_IfSystemStores: () => CompilerEvent; + // (undocumented) + static ERROR_90FeatureOnly_SetSystemStores: number; + // (undocumented) + static Error_90FeatureOnly_SetSystemStores: () => CompilerEvent; + // (undocumented) + static ERROR_90FeatureOnlyEmbedCSS: number; + // (undocumented) + static Error_90FeatureOnlyEmbedCSS: () => CompilerEvent; + // (undocumented) + static ERROR_90FeatureOnlyKeyboardVersion: number; + // (undocumented) + static Error_90FeatureOnlyKeyboardVersion: () => CompilerEvent; + // (undocumented) + static ERROR_90FeatureOnlyLayoutFile: number; + // (undocumented) + static Error_90FeatureOnlyLayoutFile: () => CompilerEvent; + // (undocumented) + static ERROR_90FeatureOnlyTargets: number; + // (undocumented) + static Error_90FeatureOnlyTargets: () => CompilerEvent; + // (undocumented) + static ERROR_90FeatureOnlyVirtualKeyDictionary: number; + // (undocumented) + static Error_90FeatureOnlyVirtualKeyDictionary: () => CompilerEvent; + // (undocumented) + static ERROR_CannotLoadIncludeFile: number; + // (undocumented) + static Error_CannotLoadIncludeFile: () => CompilerEvent; + // (undocumented) + static ERROR_CannotReadBitmapFile: number; + // (undocumented) + static Error_CannotReadBitmapFile: () => CompilerEvent; + // (undocumented) + static ERROR_CannotReadInfile: number; + // (undocumented) + static Error_CannotReadInfile: () => CompilerEvent; + // (undocumented) + static ERROR_CannotUseReadWriteGroupFromReadonlyGroup: number; + // (undocumented) + static Error_CannotUseReadWriteGroupFromReadonlyGroup: () => CompilerEvent; + // (undocumented) + static ERROR_CasedKeysMustContainOnlyVirtualKeys: number; + // (undocumented) + static Error_CasedKeysMustContainOnlyVirtualKeys: () => CompilerEvent; + // (undocumented) + static ERROR_CasedKeysMustNotIncludeShiftStates: number; + // (undocumented) + static Error_CasedKeysMustNotIncludeShiftStates: () => CompilerEvent; + // (undocumented) + static ERROR_CasedKeysNotSupportedWithMnemonicLayout: number; + // (undocumented) + static Error_CasedKeysNotSupportedWithMnemonicLayout: () => CompilerEvent; + // (undocumented) + static ERROR_CharacterExpansionMustBeFollowedByCharacter: number; + // (undocumented) + static Error_CharacterExpansionMustBeFollowedByCharacter: () => CompilerEvent; + // (undocumented) + static ERROR_CharacterRangeTooLong: number; + // (undocumented) + static Error_CharacterRangeTooLong: () => CompilerEvent; + // (undocumented) + static ERROR_CodeInvalidInKeyStore: number; + // (undocumented) + static Error_CodeInvalidInKeyStore: () => CompilerEvent; + // (undocumented) + static ERROR_CodeInvalidInThisSection: number; + // (undocumented) + static Error_CodeInvalidInThisSection: () => CompilerEvent; + // (undocumented) + static ERROR_ContextAndIndexInvalidInMatchNomatch: number; + // (undocumented) + static Error_ContextAndIndexInvalidInMatchNomatch: () => CompilerEvent; + // (undocumented) + static ERROR_ContextExCannotReferenceIf: number; + // (undocumented) + static Error_ContextExCannotReferenceIf: () => CompilerEvent; + // (undocumented) + static ERROR_ContextExCannotReferenceNul: number; + // (undocumented) + static Error_ContextExCannotReferenceNul: () => CompilerEvent; + // (undocumented) + static ERROR_ContextExHasInvalidOffset: number; + // (undocumented) + static Error_ContextExHasInvalidOffset: () => CompilerEvent; + // (undocumented) + static ERROR_DuplicateGroup: number; + // Warning: (ae-forgotten-export) The symbol "KmcmpLibMessageParameters" needs to be exported by the entry point main.d.ts + // + // (undocumented) + static Error_DuplicateGroup: (o: KmcmpLibMessageParameters) => CompilerEvent; + // (undocumented) + static ERROR_DuplicateStore: number; + // (undocumented) + static Error_DuplicateStore: (o: KmcmpLibMessageParameters) => CompilerEvent; + // (undocumented) + static ERROR_ExpansionMustBePositive: number; + // (undocumented) + static Error_ExpansionMustBePositive: () => CompilerEvent; + // (undocumented) + static ERROR_ExpansionMustFollowCharacterOrVKey: number; + // (undocumented) + static Error_ExpansionMustFollowCharacterOrVKey: () => CompilerEvent; + // (undocumented) + static ERROR_ExtendedStringTooLong: number; + // (undocumented) + static Error_ExtendedStringTooLong: () => CompilerEvent; + // (undocumented) + static ERROR_FileNotFound: number; + // (undocumented) + static Error_FileNotFound: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_GroupDoesNotExist: number; + // (undocumented) + static Error_GroupDoesNotExist: () => CompilerEvent; + // (undocumented) + static ERROR_IfSystemStore_NotFound: number; + // (undocumented) + static Error_IfSystemStore_NotFound: () => CompilerEvent; + // (undocumented) + static ERROR_IndexDoesNotPointToAny: number; + // (undocumented) + static Error_IndexDoesNotPointToAny: () => CompilerEvent; + // (undocumented) + static ERROR_InfileNotExist: number; + // (undocumented) + static Error_InfileNotExist: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidAny: number; + // (undocumented) + static Error_InvalidAny: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidBegin: number; + // (undocumented) + static Error_InvalidBegin: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidBitmapLine: number; + // (undocumented) + static Error_InvalidBitmapLine: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidCall: number; + // (undocumented) + static Error_InvalidCall: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidCharacter: number; + // (undocumented) + static Error_InvalidCharacter: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidCodeInKeyPartOfRule: number; + // (undocumented) + static Error_InvalidCodeInKeyPartOfRule: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidCopyright: number; + // (undocumented) + static Error_InvalidCopyright: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidDeadkey: number; + // (undocumented) + static Error_InvalidDeadkey: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidDisplayMapFile: number; + // (undocumented) + static Error_InvalidDisplayMapFile: (o: { + filename: string; + e: any; + }) => CompilerEvent; + // (undocumented) + static ERROR_InvalidEthnologueCode: number; + // (undocumented) + static Error_InvalidEthnologueCode: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidGroupLine: number; + // (undocumented) + static Error_InvalidGroupLine: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidIf: number; + // (undocumented) + static Error_InvalidIf: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidIndex: number; + // (undocumented) + static Error_InvalidIndex: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidKeyCode: number; + // (undocumented) + static Error_InvalidKeyCode: (o: { + keyId: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_InvalidKvkFile: number; + // (undocumented) + static Error_InvalidKvkFile: (o: { + filename: string; + e: any; + }) => CompilerEvent; + // (undocumented) + static ERROR_InvalidKvksFile: number; + // (undocumented) + static Error_InvalidKvksFile: (o: { + filename: string; + e: any; + }) => CompilerEvent; + // (undocumented) + static ERROR_InvalidLanguageLine: number; + // (undocumented) + static Error_InvalidLanguageLine: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidLanguageName: number; + // (undocumented) + static Error_InvalidLanguageName: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidLayoutLine: number; + // (undocumented) + static Error_InvalidLayoutLine: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidLineContinuation: number; + // (undocumented) + static Error_InvalidLineContinuation: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidMessage: number; + // (undocumented) + static Error_InvalidMessage: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidName: number; + // (undocumented) + static Error_InvalidName: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidNamedCode: number; + // (undocumented) + static Error_InvalidNamedCode: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidOuts: number; + // (undocumented) + static Error_InvalidOuts: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidReset: number; + // (undocumented) + static Error_InvalidReset: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidSave: number; + // (undocumented) + static Error_InvalidSave: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidSet: number; + // (undocumented) + static Error_InvalidSet: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidStoreLine: number; + // (undocumented) + static Error_InvalidStoreLine: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidSwitch: number; + // (undocumented) + static Error_InvalidSwitch: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidSystemStore: number; + // (undocumented) + static Error_InvalidSystemStore: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidTarget: number; + // (undocumented) + static Error_InvalidTarget: (o: KmcmpLibMessageParameters) => CompilerEvent; + // (undocumented) + static ERROR_InvalidToken: number; + // (undocumented) + static Error_InvalidToken: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidTouchLayoutFile: number; + // (undocumented) + static Error_InvalidTouchLayoutFile: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_InvalidUse: number; + // (undocumented) + static Error_InvalidUse: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidValue: number; + // (undocumented) + static Error_InvalidValue: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidVersion: number; + // (undocumented) + static Error_InvalidVersion: () => CompilerEvent; + // (undocumented) + static ERROR_KeyboardVersionFormatInvalid: number; + // (undocumented) + static Error_KeyboardVersionFormatInvalid: () => CompilerEvent; + // (undocumented) + static ERROR_LayoutButNoLanguage: number; + // (undocumented) + static Error_LayoutButNoLanguage: () => CompilerEvent; + // (undocumented) + static ERROR_LineTooLong: number; + // (undocumented) + static Error_LineTooLong: () => CompilerEvent; + // (undocumented) + static ERROR_NameContainsInvalidCharacter: number; + // (undocumented) + static Error_NameContainsInvalidCharacter: (o: { + name: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_NameMustBeAtLeastOneCharLong: number; + // (undocumented) + static Error_NameMustBeAtLeastOneCharLong: () => CompilerEvent; + // (undocumented) + static ERROR_NameMustBeAtMostNCharsLong: number; + // (undocumented) + static Error_NameMustBeAtMostNCharsLong: (o: { + name: string; + length: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_NameMustNotContainComma: number; + // (undocumented) + static Error_NameMustNotContainComma: (o: { + name: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_NameMustNotContainParentheses: number; + // (undocumented) + static Error_NameMustNotContainParentheses: (o: { + name: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_NameMustNotContainSpaces: number; + // (undocumented) + static Error_NameMustNotContainSpaces: (o: { + name: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_NameMustNotContainSquareBrackets: number; + // (undocumented) + static Error_NameMustNotContainSquareBrackets: (o: { + name: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_NewContextGroupMustBeReadonly: number; + // (undocumented) + static Error_NewContextGroupMustBeReadonly: () => CompilerEvent; + // (undocumented) + static ERROR_NonBMPCharactersNotSupportedInKeySection: number; + // (undocumented) + static Error_NonBMPCharactersNotSupportedInKeySection: () => CompilerEvent; + // (undocumented) + static ERROR_NoTargetsSpecified: number; + // (undocumented) + static Error_NoTargetsSpecified: () => CompilerEvent; + // (undocumented) + static ERROR_NoTokensFound: number; + // (undocumented) + static Error_NoTokensFound: () => CompilerEvent; + // (undocumented) + static ERROR_NotSupportedInKeymanWebContext: number; + // (undocumented) + static Error_NotSupportedInKeymanWebContext: (o: { + line: number; + code: String; + }) => CompilerEvent; + // (undocumented) + static ERROR_NotSupportedInKeymanWebOutput: number; + // (undocumented) + static Error_NotSupportedInKeymanWebOutput: (o: { + line: number; + code: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_NotSupportedInKeymanWebStore: number; + // (undocumented) + static Error_NotSupportedInKeymanWebStore: (o: { + code: string; + store: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_NoVersionLine: number; + // (undocumented) + static Error_NoVersionLine: () => CompilerEvent; + // (undocumented) + static ERROR_OutputInReadonlyGroup: number; + // (undocumented) + static Error_OutputInReadonlyGroup: () => CompilerEvent; + // (undocumented) + static ERROR_OutsTooLong: number; + // (undocumented) + static Error_OutsTooLong: () => CompilerEvent; + // (undocumented) + static ERROR_PostKeystrokeGroupMustBeReadonly: number; + // (undocumented) + static Error_PostKeystrokeGroupMustBeReadonly: () => CompilerEvent; + // (undocumented) + static ERROR_RepeatedBegin: number; + // (undocumented) + static Error_RepeatedBegin: () => CompilerEvent; + // (undocumented) + static ERROR_ReservedCharacter: number; + // (undocumented) + static Error_ReservedCharacter: () => CompilerEvent; + // (undocumented) + static ERROR_SetSystemStore_NotFound: number; + // (undocumented) + static Error_SetSystemStore_NotFound: () => CompilerEvent; + // (undocumented) + static ERROR_StatementNotPermittedInReadonlyGroup: number; + // (undocumented) + static Error_StatementNotPermittedInReadonlyGroup: () => CompilerEvent; + // (undocumented) + static ERROR_StoreDoesNotExist: number; + // (undocumented) + static Error_StoreDoesNotExist: () => CompilerEvent; + // (undocumented) + static ERROR_TextBeforeOrAfterNulInOutput: number; + // (undocumented) + static Error_TextBeforeOrAfterNulInOutput: () => CompilerEvent; + // (undocumented) + static ERROR_TooManyIndexToKeyRefs: number; + // (undocumented) + static Error_TooManyIndexToKeyRefs: () => CompilerEvent; + // (undocumented) + static ERROR_TouchLayoutInvalidIdentifier: number; + // (undocumented) + static Error_TouchLayoutInvalidIdentifier: (o: { + keyId: string; + platformName: string; + layerId: string; + address: KeyAddress; + }) => CompilerEvent; + // (undocumented) + static ERROR_UnicodeSetHasProperties: number; + // (undocumented) + static Error_UnicodeSetHasProperties: (compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_UnicodeSetHasStrings: number; + // (undocumented) + static Error_UnicodeSetHasStrings: (compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_UnicodeSetSyntaxError: number; + // (undocumented) + static Error_UnicodeSetSyntaxError: (compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_UnterminatedString: number; + // (undocumented) + static Error_UnterminatedString: () => CompilerEvent; + // (undocumented) + static ERROR_VersionAlreadyIncluded: number; + // (undocumented) + static Error_VersionAlreadyIncluded: () => CompilerEvent; + // (undocumented) + static ERROR_VirtualCharacterKeysNotSupportedInKeymanWeb: number; + // (undocumented) + static Error_VirtualCharacterKeysNotSupportedInKeymanWeb: (o: { + line: number; + }) => CompilerEvent; + // (undocumented) + static ERROR_VirtualKeyExpansionTooLong: number; + // (undocumented) + static Error_VirtualKeyExpansionTooLong: () => CompilerEvent; + // (undocumented) + static ERROR_VirtualKeyInContext: number; + // (undocumented) + static Error_VirtualKeyInContext: () => CompilerEvent; + // (undocumented) + static ERROR_VirtualKeyNotAllowedHere: number; + // (undocumented) + static Error_VirtualKeyNotAllowedHere: () => CompilerEvent; + // (undocumented) + static ERROR_VirtualKeysNotValidForMnemonicLayouts: number; + // (undocumented) + static Error_VirtualKeysNotValidForMnemonicLayouts: (o: { + line: number; + }) => CompilerEvent; + // (undocumented) + static ERROR_VKeyExpansionMustBeFollowedByVKey: number; + // (undocumented) + static Error_VKeyExpansionMustBeFollowedByVKey: () => CompilerEvent; + // (undocumented) + static ERROR_VKeyExpansionMustUseConsistentShift: number; + // (undocumented) + static Error_VKeyExpansionMustUseConsistentShift: () => CompilerEvent; + // (undocumented) + static ERROR_ZeroLengthString: number; + // (undocumented) + static Error_ZeroLengthString: () => CompilerEvent; + // (undocumented) + static FATAL_BadCallParams: number; + // (undocumented) + static Fatal_BadCallParams: () => CompilerEvent; + // (undocumented) + static FATAL_BufferOverflow: number; + // (undocumented) + static Fatal_BufferOverflow: () => CompilerEvent; + // (undocumented) + static FATAL_CallbacksNotSet: number; + // (undocumented) + static Fatal_CallbacksNotSet: () => CompilerEvent; + // (undocumented) + static FATAL_CannotAllocateMemory: number; + // (undocumented) + static Fatal_CannotAllocateMemory: () => CompilerEvent; + // (undocumented) + static FATAL_CannotCreateTempfile: number; + // (undocumented) + static Fatal_CannotCreateTempfile: () => CompilerEvent; + // (undocumented) + static FATAL_MissingWasmModule: number; + // (undocumented) + static Fatal_MissingWasmModule: (o: { + e?: any; + }) => CompilerEvent; + // (undocumented) + static FATAL_SomewhereIGotItWrong: number; + // (undocumented) + static Fatal_SomewhereIGotItWrong: () => CompilerEvent; + // (undocumented) + static FATAL_UnexpectedException: number; + // (undocumented) + static Fatal_UnexpectedException: (o: { + e: any; + }) => CompilerEvent; + // (undocumented) + static FATAL_UnicodeSetOutOfRange: number; + // (undocumented) + static Fatal_UnicodeSetOutOfRange: (compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static HINT_IndexStoreLong: number; + // (undocumented) + static Hint_IndexStoreLong: () => CompilerEvent; + // (undocumented) + static HINT_NonUnicodeFile: number; + // (undocumented) + static Hint_NonUnicodeFile: () => CompilerEvent; + // (undocumented) + static HINT_UnreachableKeyCode: number; + // (undocumented) + static Hint_UnreachableKeyCode: (o: { + line: number; + key: string; + }) => CompilerEvent; + // (undocumented) + static HINT_UnreachableRule: number; + // (undocumented) + static Hint_UnreachableRule: (o: KmcmpLibMessageParameters) => CompilerEvent; + // (undocumented) + static INFO_MinimumCoreEngineVersion: number; + // (undocumented) + static Info_MinimumCoreEngineVersion: (o: KmcmpLibMessageParameters) => CompilerEvent; + // (undocumented) + static WARN_ANSIInUnicodeGroup: number; + // (undocumented) + static Warn_ANSIInUnicodeGroup: () => CompilerEvent; + // (undocumented) + static WARN_BitmapNotUsed: number; + // (undocumented) + static Warn_BitmapNotUsed: () => CompilerEvent; + // (undocumented) + static WARN_CustomLanguagesNotSupported: number; + // (undocumented) + static Warn_CustomLanguagesNotSupported: () => CompilerEvent; + // (undocumented) + static WARN_DontMixChiralAndNonChiralModifiers: number; + // (undocumented) + static Warn_DontMixChiralAndNonChiralModifiers: () => CompilerEvent; + // (undocumented) + static WARN_EmbedJsFileMissing: number; + // (undocumented) + static Warn_EmbedJsFileMissing: (o: { + line: number; + jsFilename: string; + e: any; + }) => CompilerEvent; + // (undocumented) + static WARN_ExtendedShiftFlagsNotSupportedInKeymanWeb: number; + // (undocumented) + static Warn_ExtendedShiftFlagsNotSupportedInKeymanWeb: (o: { + line: number; + flags: string; + }) => CompilerEvent; + // (undocumented) + static WARN_HeaderStatementIsDeprecated: number; + // (undocumented) + static Warn_HeaderStatementIsDeprecated: () => CompilerEvent; + // (undocumented) + static WARN_HelpFileMissing: number; + // (undocumented) + static Warn_HelpFileMissing: (o: { + line: number; + helpFilename: string; + e: any; + }) => CompilerEvent; + // (undocumented) + static WARN_HotkeyHasInvalidModifier: number; + // (undocumented) + static Warn_HotkeyHasInvalidModifier: () => CompilerEvent; + // (undocumented) + static WARN_IfShouldBeAtStartOfContext: number; + // (undocumented) + static Warn_IfShouldBeAtStartOfContext: () => CompilerEvent; + // (undocumented) + static WARN_IndexStoreShort: number; + // (undocumented) + static Warn_IndexStoreShort: () => CompilerEvent; + // (undocumented) + static WARN_InvalidVkeyInKvksFile: number; + // (undocumented) + static Warn_InvalidVkeyInKvksFile: (o: { + filename: string; + invalidVkey: string; + }) => CompilerEvent; + // (undocumented) + static WARN_KeyBadLength: number; + // (undocumented) + static Warn_KeyBadLength: () => CompilerEvent; + // (undocumented) + static WARN_KeyShouldIncludeNCaps: number; + // (undocumented) + static Warn_KeyShouldIncludeNCaps: () => CompilerEvent; + // (undocumented) + static WARN_KVKFileIsInSourceFormat: number; + // (undocumented) + static Warn_KVKFileIsInSourceFormat: () => CompilerEvent; + // (undocumented) + static WARN_LanguageHeadersDeprecatedInKeyman10: number; + // (undocumented) + static Warn_LanguageHeadersDeprecatedInKeyman10: () => CompilerEvent; + // (undocumented) + static WARN_MixingLeftAndRightModifiers: number; + // (undocumented) + static Warn_MixingLeftAndRightModifiers: () => CompilerEvent; + // (undocumented) + static WARN_NulNotFirstStatementInContext: number; + // (undocumented) + static Warn_NulNotFirstStatementInContext: () => CompilerEvent; + // (undocumented) + static WARN_OldVersion: number; + // (undocumented) + static Warn_OldVersion: () => CompilerEvent; + // (undocumented) + static WARN_OptionStoreNameInvalid: number; + // (undocumented) + static Warn_OptionStoreNameInvalid: (o: { + name: string; + }) => CompilerEvent; + // (undocumented) + static WARN_PlatformNotInTargets: number; + // (undocumented) + static Warn_PlatformNotInTargets: () => CompilerEvent; + // (undocumented) + static WARN_PunctuationInEthnologueCode: number; + // (undocumented) + static Warn_PunctuationInEthnologueCode: () => CompilerEvent; + // (undocumented) + static WARN_ReservedCharacter: number; + // (undocumented) + static Warn_ReservedCharacter: () => CompilerEvent; + // (undocumented) + static WARN_StoreAlreadyUsedAsOptionOrCall: number; + // (undocumented) + static Warn_StoreAlreadyUsedAsOptionOrCall: () => CompilerEvent; + // (undocumented) + static WARN_StoreAlreadyUsedAsStoreOrCall: number; + // (undocumented) + static Warn_StoreAlreadyUsedAsStoreOrCall: () => CompilerEvent; + // (undocumented) + static WARN_StoreAlreadyUsedAsStoreOrOption: number; + // (undocumented) + static Warn_StoreAlreadyUsedAsStoreOrOption: () => CompilerEvent; + // (undocumented) + static WARN_TooManyWarnings: number; + // (undocumented) + static Warn_TooManyWarnings: () => CompilerEvent; + // (undocumented) + static WARN_TouchLayoutCustomKeyNotDefined: number; + // (undocumented) + static Warn_TouchLayoutCustomKeyNotDefined: (o: { + keyId: string; + platformName: string; + layerId: string; + address: KeyAddress; + }) => CompilerEvent; + // (undocumented) + static WARN_TouchLayoutFontShouldBeSameForAllPlatforms: number; + // (undocumented) + static Warn_TouchLayoutFontShouldBeSameForAllPlatforms: () => CompilerEvent; + // (undocumented) + static WARN_TouchLayoutMissingLayer: number; + // (undocumented) + static Warn_TouchLayoutMissingLayer: (o: { + keyId: string; + platformName: string; + layerId: string; + nextLayer: string; + address: KeyAddress; + }) => CompilerEvent; + // (undocumented) + static WARN_TouchLayoutMissingRequiredKeys: number; + // (undocumented) + static Warn_TouchLayoutMissingRequiredKeys: (o: { + layerId: string; + platformName: string; + missingKeys: string; + }) => CompilerEvent; + // (undocumented) + static WARN_TouchLayoutSpecialLabelOnNormalKey: number; + // (undocumented) + static Warn_TouchLayoutSpecialLabelOnNormalKey: (o: { + keyId: string; + platformName: string; + layerId: string; + label: string; + address: KeyAddress; + }) => CompilerEvent; + // (undocumented) + static WARN_TouchLayoutUnidentifiedKey: number; + // (undocumented) + static Warn_TouchLayoutUnidentifiedKey: (o: { + layerId: string; + address: KeyAddress; + }) => CompilerEvent; + // (undocumented) + static WARN_UnicodeInANSIGroup: number; + // (undocumented) + static Warn_UnicodeInANSIGroup: () => CompilerEvent; + // (undocumented) + static WARN_UnicodeSurrogateUsed: number; + // (undocumented) + static Warn_UnicodeSurrogateUsed: () => CompilerEvent; + // (undocumented) + static WARN_UseNotLastStatementInRule: number; + // (undocumented) + static Warn_UseNotLastStatementInRule: () => CompilerEvent; + // (undocumented) + static WARN_VirtualCharKeyWithPositionalLayout: number; + // (undocumented) + static Warn_VirtualCharKeyWithPositionalLayout: () => CompilerEvent; + // (undocumented) + static WARN_VirtualKeyInOutput: number; + // (undocumented) + static Warn_VirtualKeyInOutput: () => CompilerEvent; + // (undocumented) + static WARN_VirtualKeyWithMnemonicLayout: number; + // (undocumented) + static Warn_VirtualKeyWithMnemonicLayout: () => CompilerEvent; +} + +// @public +export interface KmnCompilerOptions extends CompilerOptions { +} + +// @public +export interface KmnCompilerResult extends KeymanCompilerResult { + artifacts: KmnCompilerArtifacts; + displayMap?: Osk.PuaMap; + // Warning: (ae-incompatible-release-tags) The symbol "extra" is marked as @public, but its signature references "KmnCompilerResultExtra" which is marked as @internal + extra: KmnCompilerResultExtra; +} + +// Warning: (ae-internal-missing-underscore) The name "KmnCompilerResultExtra" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal +export interface KmnCompilerResultExtra { + // (undocumented) + displayMapFilename?: string; + // (undocumented) + groups: CompilerResultExtraGroup[]; + // (undocumented) + kvksFilename?: string; + // (undocumented) + stores: CompilerResultExtraStore[]; + targets: number; +} + +// Warning: (ae-internal-missing-underscore) The name "KmwCompilerMessages" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal +export class KmwCompilerMessages extends KmnCompilerMessages { + // (undocumented) + static ERROR_InvalidTouchLayoutFileFormat: number; + // (undocumented) + static Error_InvalidTouchLayoutFileFormat: (o: { + msg: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_TouchLayoutFileDoesNotExist: number; + // (undocumented) + static Error_TouchLayoutFileDoesNotExist: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_TouchLayoutIdentifierRequires15: number; + // (undocumented) + static Error_TouchLayoutIdentifierRequires15: (o: { + keyId: string; + platformName: string; + layerId: string; + address: KeyAddress; + }) => CompilerEvent; + // (undocumented) + static HINT_TouchLayoutUsesUnsupportedGesturesDownlevel: number; + // (undocumented) + static Hint_TouchLayoutUsesUnsupportedGesturesDownlevel: (o: { + keyId: string; + }) => CompilerEvent; + // (undocumented) + static INFO_MinimumWebEngineVersion: number; + // (undocumented) + static Info_MinimumWebEngineVersion: (o: { + version: string; + }) => CompilerEvent; +} + +declare namespace Osk { + export { + parseMapping, + remapVisualKeyboard, + remapTouchLayout, + StringRefUsage, + StringRef, + StringResult, + PuaMap + } +} +export { Osk } + +// @public (undocumented) +function parseMapping(mapping: any): PuaMap; + +// @public (undocumented) +type PuaMap = { + [index: string]: string; +}; + +// @public (undocumented) +function remapTouchLayout(source: TouchLayout.TouchLayoutFile, map: PuaMap): boolean; + +// @public (undocumented) +function remapVisualKeyboard(vk: VisualKeyboard.VisualKeyboard, map: PuaMap): boolean; + +// @public (undocumented) +interface StringRef { + // (undocumented) + str: string; + // (undocumented) + usages: StringRefUsage[]; +} + +// @public (undocumented) +interface StringRefUsage { + // (undocumented) + count: number; + // (undocumented) + filename: string; +} + +// @public +interface StringResult { + pua: string; + str: string; + unicode: string; + usages: StringRefUsage[] | string[]; +} + +// Warnings were encountered during analysis: +// +// src/compiler/kmn-compiler-messages.ts:468:103 - (ae-forgotten-export) The symbol "KeyAddress" needs to be exported by the entry point main.d.ts + +``` diff --git a/developer/docs/api/etc/kmc-ldml.api.md b/developer/docs/api/etc/kmc-ldml.api.md index cc32c5e357..0e5ffcff79 100644 --- a/developer/docs/api/etc/kmc-ldml.api.md +++ b/developer/docs/api/etc/kmc-ldml.api.md @@ -1,330 +1,365 @@ -## API Report File for "@keymanapp/kmc-ldml" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { CompilerCallbacks } from '@keymanapp/common-types'; -import { CompilerEvent } from '@keymanapp/common-types'; -import { CompilerOptions } from '@keymanapp/common-types'; -import { KeymanCompiler } from '@keymanapp/common-types'; -import { KeymanCompilerArtifactOptional } from '@keymanapp/common-types'; -import { KeymanCompilerArtifacts } from '@keymanapp/common-types'; -import { KeymanCompilerResult } from '@keymanapp/common-types'; -import { KMXPlus } from '@keymanapp/common-types'; -import { LDMLKeyboardTestDataXMLSourceFile } from '@keymanapp/common-types'; -import { LDMLKeyboardXMLSourceFileReaderOptions } from '@keymanapp/common-types'; -import { UnicodeSetParser } from '@keymanapp/common-types'; - -// Warning: (ae-internal-missing-underscore) The name "LdmlCompilerMessages" should be prefixed with an underscore because the declaration is marked as @internal -// -// @internal (undocumented) -export class LdmlCompilerMessages { - // (undocumented) - static ERROR_CantReferenceSetFromUnicodeSet: number; - // (undocumented) - static Error_CantReferenceSetFromUnicodeSet: (o: { - id: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_DisplayIsRepeated: number; - // (undocumented) - static Error_DisplayIsRepeated: (o: { - output?: string; - keyId?: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_DisplayNeedsToOrId: number; - // (undocumented) - static Error_DisplayNeedsToOrId: (o: { - output?: string; - keyId?: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_DuplicateTransformsType: number; - // (undocumented) - static Error_DuplicateTransformsType: (o: { - types: string[]; - }) => CompilerEvent; - // (undocumented) - static ERROR_DuplicateVariable: number; - // (undocumented) - static Error_DuplicateVariable: (o: { - ids: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_EmptyTransformGroup: number; - // (undocumented) - static Error_EmptyTransformGroup: () => CompilerEvent; - // (undocumented) - static ERROR_ExcessHardware: number; - // (undocumented) - static Error_ExcessHardware: (o: { - formId: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_GestureKeyNotFoundInKeyBag: number; - // (undocumented) - static Error_GestureKeyNotFoundInKeyBag: (o: { - keyId: string; - parentKeyId: string; - attribute: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_HardwareLayerHasTooManyRows: number; - // (undocumented) - static Error_HardwareLayerHasTooManyRows: () => CompilerEvent; - // (undocumented) - static ERROR_IllegalCharacters: number; - // (undocumented) - static Error_IllegalCharacters: (o: { - count: number; - lowestCh: number; - }) => CompilerEvent; - // (undocumented) - static ERROR_IllegalTransformAsterisk: number; - // (undocumented) - static Error_IllegalTransformAsterisk: (o: { - from: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_IllegalTransformDollarsign: number; - // (undocumented) - static Error_IllegalTransformDollarsign: (o: { - from: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_IllegalTransformPlus: number; - // (undocumented) - static Error_IllegalTransformPlus: (o: { - from: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_InvalidFile: number; - // (undocumented) - static Error_InvalidFile: (o: { - errorText: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_InvalidHardware: number; - // (undocumented) - static Error_InvalidHardware: (o: { - formId: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_InvalidLocale: number; - // (undocumented) - static Error_InvalidLocale: (o: { - tag: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_InvalidModifier: number; - // (undocumented) - static Error_InvalidModifier: (o: { - layer: string; - modifiers: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_InvalidQuadEscape: number; - // (undocumented) - static Error_InvalidQuadEscape: (o: { - cp: number; - }) => CompilerEvent; - // (undocumented) - static ERROR_InvalidScanCode: number; - // (undocumented) - static Error_InvalidScanCode: (o: { - form?: string; - codes?: string[]; - }) => CompilerEvent; - // (undocumented) - static ERROR_InvalidTransformsType: number; - // (undocumented) - static Error_InvalidTransformsType: (o: { - types: string[]; - }) => CompilerEvent; - // (undocumented) - static ERROR_InvalidVersion: number; - // (undocumented) - static Error_InvalidVersion: (o: { - version: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_KeyMissingToGapOrSwitch: number; - // (undocumented) - static Error_KeyMissingToGapOrSwitch: (o: { - keyId: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_KeyNotFoundInKeyBag: number; - // (undocumented) - static Error_KeyNotFoundInKeyBag: (o: { - keyId: string; - col: number; - row: number; - layer: string; - form: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_MissingFlicks: number; - // (undocumented) - static Error_MissingFlicks: (o: { - flickId: string; - id: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_MissingMarkers: number; - // (undocumented) - static Error_MissingMarkers: (o: { - ids: string[]; - }) => CompilerEvent; - // (undocumented) - static ERROR_MissingSetVariable: number; - // (undocumented) - static Error_MissingSetVariable: (o: { - id: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_MissingStringVariable: number; - // (undocumented) - static Error_MissingStringVariable: (o: { - id: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_MissingUnicodeSetVariable: number; - // (undocumented) - static Error_MissingUnicodeSetVariable: (o: { - id: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_MixedTransformGroup: number; - // (undocumented) - static Error_MixedTransformGroup: () => CompilerEvent; - // (undocumented) - static ERROR_MustBeAtLeastOneLayerElement: number; - // (undocumented) - static Error_MustBeAtLeastOneLayerElement: () => CompilerEvent; - // (undocumented) - static ERROR_NeedSpacesBetweenSetVariables: number; - // (undocumented) - static Error_NeedSpacesBetweenSetVariables: (o: { - item: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_RowOnHardwareLayerHasTooManyKeys: number; - // (undocumented) - static Error_RowOnHardwareLayerHasTooManyKeys: (o: { - row: number; - hardware: string; - modifiers: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_TransformFromMatchesNothing: number; - // (undocumented) - static Error_TransformFromMatchesNothing: (o: { - from: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_UnparseableReorderSet: number; - // (undocumented) - static Error_UnparseableReorderSet: (o: { - from: string; - set: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_UnparseableTransformFrom: number; - // (undocumented) - static Error_UnparseableTransformFrom: (o: { - from: string; - message: string; - }) => CompilerEvent; - // (undocumented) - static HINT_CharClassImplicitDenorm: number; - // (undocumented) - static Hint_CharClassImplicitDenorm: (o: { - lowestCh: number; - }) => CompilerEvent; - // (undocumented) - static HINT_LocaleIsNotMinimalAndClean: number; - // (undocumented) - static Hint_LocaleIsNotMinimalAndClean: (o: { - sourceLocale: string; - locale: string; - }) => CompilerEvent; - // (undocumented) - static HINT_NoDisplayForMarker: number; - // (undocumented) - static Hint_NoDisplayForMarker: (o: { - id: string; - }) => CompilerEvent; - // (undocumented) - static HINT_NoDisplayForSwitch: number; - // (undocumented) - static Hint_NoDisplayForSwitch: (o: { - id: string; - }) => CompilerEvent; - // (undocumented) - static HINT_NormalizationDisabled: number; - // (undocumented) - static Hint_NormalizationDisabled: () => CompilerEvent; - // (undocumented) - static HINT_OneOrMoreRepeatedLocales: number; - // (undocumented) - static Hint_OneOrMoreRepeatedLocales: () => CompilerEvent; - // (undocumented) - static HINT_PUACharacters: number; - // (undocumented) - static Hint_PUACharacters: (o: { - count: number; - lowestCh: number; - }) => CompilerEvent; - // (undocumented) - static WARN_CharClassExplicitDenorm: number; - // (undocumented) - static Warn_CharClassExplicitDenorm: (o: { - lowestCh: number; - }) => CompilerEvent; - // (undocumented) - static WARN_CustomForm: number; - // (undocumented) - static Warn_CustomForm: (o: { - id: string; - }) => CompilerEvent; - // (undocumented) - static WARN_UnassignedCharacters: number; - // (undocumented) - static Warn_UnassignedCharacters: (o: { - count: number; - lowestCh: number; - }) => CompilerEvent; -} - -// @public -export interface LdmlCompilerOptions extends CompilerOptions { - readerOptions: LDMLKeyboardXMLSourceFileReaderOptions; -} - -// @public -export class LdmlKeyboardCompiler implements KeymanCompiler { - // @internal - compile(source: LDMLKeyboardXMLSourceFile, postValidate?: boolean): Promise; - // @internal - getUsetParser(): Promise; - init(callbacks: CompilerCallbacks, options: LdmlCompilerOptions): Promise; - // Warning: (ae-forgotten-export) The symbol "LDMLKeyboardXMLSourceFile" needs to be exported by the entry point main.d.ts - // - // @internal - load(filename: string): LDMLKeyboardXMLSourceFile | null; - // @internal - loadTestData(filename: string): LDMLKeyboardTestDataXMLSourceFile | null; - // Warning: (ae-forgotten-export) The symbol "LdmlKeyboardCompilerResult" needs to be exported by the entry point main.d.ts - run(inputFilename: string, outputFilename?: string): Promise; - // @internal - validate(source: LDMLKeyboardXMLSourceFile): Promise; - // Warning: (ae-forgotten-export) The symbol "LdmlKeyboardCompilerArtifacts" needs to be exported by the entry point main.d.ts - write(artifacts: LdmlKeyboardCompilerArtifacts): Promise; -} - -// (No @packageDocumentation comment for this package) - -``` +## API Report File for "@keymanapp/kmc-ldml" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { CompilerCallbacks } from '@keymanapp/developer-utils'; +import { CompilerEvent } from '@keymanapp/developer-utils'; +import { CompilerOptions } from '@keymanapp/developer-utils'; +import { KeymanCompiler } from '@keymanapp/developer-utils'; +import { KeymanCompilerArtifactOptional } from '@keymanapp/developer-utils'; +import { KeymanCompilerArtifacts } from '@keymanapp/developer-utils'; +import { KeymanCompilerResult } from '@keymanapp/developer-utils'; +import { KMXPlus } from '@keymanapp/common-types'; +import { LDMLKeyboardTestDataXMLSourceFile } from '@keymanapp/developer-utils'; +import { LdmlKeyboardTypes } from '@keymanapp/common-types'; +import { LDMLKeyboardXMLSourceFileReaderOptions } from '@keymanapp/developer-utils'; +import { ObjectWithCompileContext } from '@keymanapp/common-types'; + +// Warning: (ae-internal-missing-underscore) The name "LdmlCompilerMessages" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal (undocumented) +export class LdmlCompilerMessages { + // (undocumented) + static ERROR_CantReferenceSetFromUnicodeSet: number; + // (undocumented) + static Error_CantReferenceSetFromUnicodeSet: (o: { + id: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_DisplayIsRepeated: number; + // (undocumented) + static Error_DisplayIsRepeated: (o: { + display?: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_DisplayNeedsToOrId: number; + // (undocumented) + static Error_DisplayNeedsToOrId: (o: { + display?: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_DuplicateLayerWidth: number; + // (undocumented) + static Error_DuplicateLayerWidth: (o: { + minDeviceWidth: number; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_DuplicateTransformsType: number; + // (undocumented) + static Error_DuplicateTransformsType: (o: { + type: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_DuplicateVariable: number; + // (undocumented) + static Error_DuplicateVariable: (o: { + id: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_EmptyTransformGroup: number; + // (undocumented) + static Error_EmptyTransformGroup: (compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_ExcessHardware: number; + // (undocumented) + static Error_ExcessHardware: (o: { + formId: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_GestureKeyNotFoundInKeyBag: number; + // (undocumented) + static Error_GestureKeyNotFoundInKeyBag: (o: { + keyId: string; + parentKeyId: string; + attribute: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_HardwareLayerHasTooManyRows: number; + // (undocumented) + static Error_HardwareLayerHasTooManyRows: (compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_IllegalCharacters: number; + // (undocumented) + static Error_IllegalCharacters: (o: { + count: number; + lowestCh: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_IllegalTransformAsterisk: number; + // (undocumented) + static Error_IllegalTransformAsterisk: (o: { + from: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_IllegalTransformDollarsign: number; + // (undocumented) + static Error_IllegalTransformDollarsign: (o: { + from: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_IllegalTransformPlus: number; + // (undocumented) + static Error_IllegalTransformPlus: (o: { + from: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_IllegalTransformToUset: number; + // (undocumented) + static Error_IllegalTransformToUset: (o: { + to: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_InvalidFile: number; + // (undocumented) + static Error_InvalidFile: (o: { + errorText: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_InvalidHardware: number; + // (undocumented) + static Error_InvalidHardware: (o: { + formId: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_InvalidLayerWidth: number; + // (undocumented) + static Error_InvalidLayerWidth: (o: { + minDeviceWidth: number; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_InvalidLocale: number; + // (undocumented) + static Error_InvalidLocale: (o: { + tag: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_InvalidMarkerIdentifier: number; + // (undocumented) + static Error_InvalidMarkerIdentifier: (o: { + id: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_InvalidModifier: number; + // (undocumented) + static Error_InvalidModifier: (o: { + modifiers: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_InvalidQuadEscape: number; + // (undocumented) + static Error_InvalidQuadEscape: (o: { + cp: string; + recommended: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_InvalidScanCode: number; + // (undocumented) + static Error_InvalidScanCode: (o: { + codes: string; + id: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_InvalidTransformsType: number; + // (undocumented) + static Error_InvalidTransformsType: (o: { + type: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_InvalidVariableIdentifier: number; + // (undocumented) + static Error_InvalidVariableIdentifier: (o: { + id: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_InvalidVersion: number; + // (undocumented) + static Error_InvalidVersion: (o: { + version: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_KeyMissingToGapOrSwitch: number; + // (undocumented) + static Error_KeyMissingToGapOrSwitch: (o: { + keyId: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_KeyNotFoundInKeyBag: number; + // (undocumented) + static Error_KeyNotFoundInKeyBag: (o: { + keyId: string; + col: number; + row: number; + layer: string; + form: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_MissingFlicks: number; + // (undocumented) + static Error_MissingFlicks: (o: { + id: string; + flickId: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_MissingMarkers: number; + // (undocumented) + static Error_MissingMarkers: (o: { + ids: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_MissingSetVariable: number; + // (undocumented) + static Error_MissingSetVariable: (o: { + id: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_MissingStringVariable: number; + // (undocumented) + static Error_MissingStringVariable: (o: { + id: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_MissingUnicodeSetVariable: number; + // (undocumented) + static Error_MissingUnicodeSetVariable: (o: { + id: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_MixedTransformGroup: number; + // (undocumented) + static Error_MixedTransformGroup: (compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_MustBeAtLeastOneLayerElement: number; + // (undocumented) + static Error_MustBeAtLeastOneLayerElement: (compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_NeedSpacesBetweenSetVariables: number; + // (undocumented) + static Error_NeedSpacesBetweenSetVariables: (o: { + item: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_RowOnHardwareLayerHasTooManyKeys: number; + // (undocumented) + static Error_RowOnHardwareLayerHasTooManyKeys: (o: { + row: number; + hardware: string; + modifiers: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_TransformFromMatchesNothing: number; + // (undocumented) + static Error_TransformFromMatchesNothing: (o: { + from: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_UnparseableTransformFrom: number; + // (undocumented) + static Error_UnparseableTransformFrom: (o: { + from: string; + message: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static ERROR_UnparseableTransformTo: number; + // (undocumented) + static Error_UnparseableTransformTo: (o: { + to: string; + message: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static HINT_CharClassImplicitDenorm: number; + // (undocumented) + static Hint_CharClassImplicitDenorm: (o: { + lowestCh: number; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static HINT_LocaleIsNotMinimalAndClean: number; + // (undocumented) + static Hint_LocaleIsNotMinimalAndClean: (o: { + sourceLocale: string; + locale: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static HINT_NoDisplayForMarker: number; + // (undocumented) + static Hint_NoDisplayForMarker: (o: { + id: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static HINT_NoDisplayForSwitch: number; + // (undocumented) + static Hint_NoDisplayForSwitch: (o: { + id: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static HINT_NormalizationDisabled: number; + // (undocumented) + static Hint_NormalizationDisabled: (compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static HINT_OneOrMoreRepeatedLocales: number; + // (undocumented) + static Hint_OneOrMoreRepeatedLocales: (compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static HINT_PUACharacters: number; + // (undocumented) + static Hint_PUACharacters: (o: { + count: number; + lowestCh: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static WARN_CharClassExplicitDenorm: number; + // (undocumented) + static Warn_CharClassExplicitDenorm: (o: { + lowestCh: number; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static WARN_CustomForm: number; + // (undocumented) + static Warn_CustomForm: (o: { + id: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static WARN_StringDenorm: number; + // (undocumented) + static Warn_StringDenorm: (o: { + s: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; + // (undocumented) + static WARN_UnassignedCharacters: number; + // (undocumented) + static Warn_UnassignedCharacters: (o: { + count: number; + lowestCh: string; + }, compileContext?: ObjectWithCompileContext) => CompilerEvent; +} + +// @public +export interface LdmlCompilerOptions extends CompilerOptions { + readerOptions: LDMLKeyboardXMLSourceFileReaderOptions; +} + +// @public +export class LdmlKeyboardCompiler implements KeymanCompiler { + // @internal + compile(source: LDMLKeyboardXMLSourceFile, postValidate?: boolean): Promise; + // @internal + getUsetParser(): Promise; + init(callbacks: CompilerCallbacks, options: LdmlCompilerOptions): Promise; + // Warning: (ae-forgotten-export) The symbol "LDMLKeyboardXMLSourceFile" needs to be exported by the entry point main.d.ts + // + // @internal + load(filename: string): LDMLKeyboardXMLSourceFile | null; + // @internal + loadTestData(filename: string): LDMLKeyboardTestDataXMLSourceFile | null; + // Warning: (ae-forgotten-export) The symbol "LdmlKeyboardCompilerResult" needs to be exported by the entry point main.d.ts + run(inputFilename: string, outputFilename?: string): Promise; + // @internal + validate(source: LDMLKeyboardXMLSourceFile): Promise; + // Warning: (ae-forgotten-export) The symbol "LdmlKeyboardCompilerArtifacts" needs to be exported by the entry point main.d.ts + write(artifacts: LdmlKeyboardCompilerArtifacts): Promise; +} + +// (No @packageDocumentation comment for this package) + +``` diff --git a/developer/docs/api/etc/kmc-model-info.api.md b/developer/docs/api/etc/kmc-model-info.api.md index af54f5b882..3d1c7a6e26 100644 --- a/developer/docs/api/etc/kmc-model-info.api.md +++ b/developer/docs/api/etc/kmc-model-info.api.md @@ -1,115 +1,121 @@ -## API Report File for "@keymanapp/kmc-model-info" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { CompilerCallbacks } from '@keymanapp/common-types'; -import { CompilerEvent } from '@keymanapp/common-types'; -import { CompilerOptions } from '@keymanapp/common-types'; -import { KeymanCompiler } from '@keymanapp/common-types'; -import { KeymanCompilerArtifact } from '@keymanapp/common-types'; -import { KeymanCompilerArtifacts } from '@keymanapp/common-types'; -import { KeymanCompilerResult } from '@keymanapp/common-types'; -import { KmpJsonFile } from '@keymanapp/common-types'; - -// @public -export class ModelInfoCompiler implements KeymanCompiler { - constructor(); - init(callbacks: CompilerCallbacks, options: ModelInfoCompilerOptions): Promise; - run(inputFilename: string, outputFilename?: string): Promise; - write(artifacts: ModelInfoCompilerArtifacts): Promise; -} - -// @public -export interface ModelInfoCompilerArtifacts extends KeymanCompilerArtifacts { - model_info: KeymanCompilerArtifact; -} - -// Warning: (ae-internal-missing-underscore) The name "ModelInfoCompilerMessages" should be prefixed with an underscore because the declaration is marked as @internal -// -// @internal (undocumented) -export class ModelInfoCompilerMessages { - // (undocumented) - static ERROR_FileDoesNotExist: number; - // (undocumented) - static Error_FileDoesNotExist: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_FileIsNotValid: number; - // (undocumented) - static Error_FileIsNotValid: (o: { - filename: string; - e: any; - }) => CompilerEvent; - // (undocumented) - static ERROR_InvalidAuthorEmail: number; - // (undocumented) - static Error_InvalidAuthorEmail: (o: { - email: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_LicenseFileIsDamaged: number; - // (undocumented) - static Error_LicenseFileIsDamaged: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_LicenseFileIsMissing: number; - // (undocumented) - static Error_LicenseFileIsMissing: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_LicenseIsNotValid: number; - // (undocumented) - static Error_LicenseIsNotValid: (o: { - filename: string; - message: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_NoLicenseFound: number; - // (undocumented) - static Error_NoLicenseFound: () => CompilerEvent; - // (undocumented) - static FATAL_UnexpectedException: number; - // (undocumented) - static Fatal_UnexpectedException: (o: { - e: any; - }) => CompilerEvent; - // (undocumented) - static WARN_MetadataFieldInconsistent: number; - // (undocumented) - static Warn_MetadataFieldInconsistent: (o: { - field: string; - value: any; - expected: any; - }) => CompilerEvent; -} - -// @public -export interface ModelInfoCompilerOptions extends CompilerOptions { - sources: ModelInfoSources; -} - -// @public -export interface ModelInfoCompilerResult extends KeymanCompilerResult { - artifacts: ModelInfoCompilerArtifacts; -} - -// @public -export class ModelInfoSources { - forPublishing: boolean; - kmpFileName: string; - kmpJsonData: KmpJsonFile.KmpJsonFile; - kpsFilename: string; - lastCommitDate?: string; - model_id: string; - modelFileName: string; - sourcePath: string; -} - -// (No @packageDocumentation comment for this package) - -``` +## API Report File for "@keymanapp/kmc-model-info" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { CompilerCallbacks } from '@keymanapp/developer-utils'; +import { CompilerEvent } from '@keymanapp/developer-utils'; +import { CompilerOptions } from '@keymanapp/developer-utils'; +import { KeymanCompiler } from '@keymanapp/developer-utils'; +import { KeymanCompilerArtifact } from '@keymanapp/developer-utils'; +import { KeymanCompilerArtifacts } from '@keymanapp/developer-utils'; +import { KeymanCompilerResult } from '@keymanapp/developer-utils'; +import { KmpJsonFile } from '@keymanapp/common-types'; + +// @public +export class ModelInfoCompiler implements KeymanCompiler { + constructor(); + init(callbacks: CompilerCallbacks, options: ModelInfoCompilerOptions): Promise; + run(inputFilename: string, outputFilename?: string): Promise; + write(artifacts: ModelInfoCompilerArtifacts): Promise; +} + +// @public +export interface ModelInfoCompilerArtifacts extends KeymanCompilerArtifacts { + model_info: KeymanCompilerArtifact; +} + +// Warning: (ae-internal-missing-underscore) The name "ModelInfoCompilerMessages" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal (undocumented) +export class ModelInfoCompilerMessages { + // (undocumented) + static ERROR_DescriptionIsMissing: number; + // (undocumented) + static Error_DescriptionIsMissing: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_FileDoesNotExist: number; + // (undocumented) + static Error_FileDoesNotExist: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_FileIsNotValid: number; + // (undocumented) + static Error_FileIsNotValid: (o: { + filename: string; + e: any; + }) => CompilerEvent; + // (undocumented) + static ERROR_InvalidAuthorEmail: number; + // (undocumented) + static Error_InvalidAuthorEmail: (o: { + email: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_LicenseFileIsDamaged: number; + // (undocumented) + static Error_LicenseFileIsDamaged: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_LicenseFileIsMissing: number; + // (undocumented) + static Error_LicenseFileIsMissing: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_LicenseIsNotValid: number; + // (undocumented) + static Error_LicenseIsNotValid: (o: { + filename: string; + message: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_NoLicenseFound: number; + // (undocumented) + static Error_NoLicenseFound: () => CompilerEvent; + // (undocumented) + static FATAL_UnexpectedException: number; + // (undocumented) + static Fatal_UnexpectedException: (o: { + e: any; + }) => CompilerEvent; + // (undocumented) + static WARN_MetadataFieldInconsistent: number; + // (undocumented) + static Warn_MetadataFieldInconsistent: (o: { + field: string; + value: any; + expected: any; + }) => CompilerEvent; +} + +// @public +export interface ModelInfoCompilerOptions extends CompilerOptions { + sources: ModelInfoSources; +} + +// @public +export interface ModelInfoCompilerResult extends KeymanCompilerResult { + artifacts: ModelInfoCompilerArtifacts; +} + +// @public +export class ModelInfoSources { + forPublishing: boolean; + kmpFileName: string; + kmpJsonData: KmpJsonFile.KmpJsonFile; + kpsFilename: string; + lastCommitDate?: string; + model_id: string; + modelFileName: string; + sourcePath: string; +} + +// (No @packageDocumentation comment for this package) + +``` diff --git a/developer/docs/api/etc/kmc-model.api.md b/developer/docs/api/etc/kmc-model.api.md index 51ea5dffb8..f42c1a12fc 100644 --- a/developer/docs/api/etc/kmc-model.api.md +++ b/developer/docs/api/etc/kmc-model.api.md @@ -1,137 +1,152 @@ -## API Report File for "@keymanapp/kmc-model" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -/// - -import { CompilerCallbacks } from '@keymanapp/common-types'; -import { CompilerEvent } from '@keymanapp/common-types'; -import { CompilerOptions } from '@keymanapp/common-types'; -import { KeymanCompiler } from '@keymanapp/common-types'; -import { KeymanCompilerArtifact } from '@keymanapp/common-types'; -import { KeymanCompilerArtifacts } from '@keymanapp/common-types'; -import { KeymanCompilerResult } from '@keymanapp/common-types'; - -// @public -export type CasedWordformToKeySpec = (term: string, applyCasing?: CasingFunction) => string; - -// @public -export class LexicalModelCompiler implements KeymanCompiler { - // @internal - generateLexicalModelCode(model_id: string, modelSource: LexicalModelSource, sourcePath: string): string; - init(callbacks: CompilerCallbacks, _options: CompilerOptions): Promise; - // @internal - loadFromFilename(filename: string): LexicalModelSource; - run(inputFilename: string, outputFilename?: string): Promise; - // @internal (undocumented) - transpileSources(sources: Array): Array; - write(artifacts: LexicalModelCompilerArtifacts): Promise; -} - -// @public -export interface LexicalModelCompilerArtifacts extends KeymanCompilerArtifacts { - js: KeymanCompilerArtifact; -} - -// @public -export interface LexicalModelCompilerResult extends KeymanCompilerResult { - artifacts: LexicalModelCompilerArtifacts; -} - -// Warning: (ae-forgotten-export) The symbol "LexicalModelDeclaration" needs to be exported by the entry point main.d.ts -// -// @public -export interface LexicalModelSource extends LexicalModelDeclaration { - readonly applyCasing?: CasingFunction; - readonly languageUsesCasing?: boolean; - readonly punctuation?: LexicalModelPunctuation; - readonly rootClass?: string; - readonly searchTermToKey?: WordformToKeySpec; - // (undocumented) - readonly sources: Array; - readonly wordBreaker?: WordBreakerSpec | SimpleWordBreakerSpec; -} - -// Warning: (ae-internal-missing-underscore) The name "ModelCompilerMessages" should be prefixed with an underscore because the declaration is marked as @internal -// -// @internal (undocumented) -export class ModelCompilerMessages { - // (undocumented) - static ERROR_NoDefaultExport: number; - // (undocumented) - static Error_NoDefaultExport: () => CompilerEvent; - // (undocumented) - static ERROR_SearchTermToKeyMustBeExplicitlySpecified: number; - // (undocumented) - static Error_SearchTermToKeyMustBeExplicitlySpecified: () => CompilerEvent; - // (undocumented) - static ERROR_UnimplementedModelFormat: number; - // (undocumented) - static Error_UnimplementedModelFormat: (o: { - format: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_UnknownModelFormat: number; - // (undocumented) - static Error_UnknownModelFormat: (o: { - format: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_UnknownWordBreaker: number; - // (undocumented) - static Error_UnknownWordBreaker: (o: { - spec: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_UnsupportedScriptOverride: number; - // (undocumented) - static Error_UnsupportedScriptOverride: (o: { - option: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_UTF16BEUnsupported: number; - // (undocumented) - static Error_UTF16BEUnsupported: () => CompilerEvent; - // (undocumented) - static FATAL_UnexpectedException: number; - // (undocumented) - static Fatal_UnexpectedException: (o: { - e: any; - }) => CompilerEvent; - // (undocumented) - static HINT_DuplicateWordInSameFile: number; - // (undocumented) - static Hint_DuplicateWordInSameFile: (o: { - wordform: string; - }) => CompilerEvent; - // (undocumented) - static HINT_MixedNormalizationForms: number; - // (undocumented) - static Hint_MixedNormalizationForms: (o: { - wordform: string; - }) => CompilerEvent; -} - -// @public -export type SimpleWordBreakerSpec = 'default' | 'ascii' | WordBreakingFunction; - -// @public -export type SimpleWordformToKeySpec = (term: string) => string; - -// @public -export interface WordBreakerSpec { - readonly joinWordsAt?: string[]; - // Warning: (ae-forgotten-export) The symbol "OverrideScriptDefaults" needs to be exported by the entry point main.d.ts - readonly overrideScriptDefaults?: OverrideScriptDefaults; - // (undocumented) - readonly use: SimpleWordBreakerSpec; -} - -// @public -export type WordformToKeySpec = SimpleWordformToKeySpec | CasedWordformToKeySpec; - -// (No @packageDocumentation comment for this package) - -``` +## API Report File for "@keymanapp/kmc-model" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { CompilerCallbacks } from '@keymanapp/developer-utils'; +import { CompilerEvent } from '@keymanapp/developer-utils'; +import { CompilerOptions } from '@keymanapp/developer-utils'; +import { KeymanCompiler } from '@keymanapp/developer-utils'; +import { KeymanCompilerArtifact } from '@keymanapp/developer-utils'; +import { KeymanCompilerArtifacts } from '@keymanapp/developer-utils'; +import { KeymanCompilerResult } from '@keymanapp/developer-utils'; + +// Warning: (ae-forgotten-export) The symbol "CasingFunction" needs to be exported by the entry point main.d.ts +// +// @public +export type CasedWordformToKeySpec = (term: string, applyCasing?: CasingFunction) => string; + +// @public +export class LexicalModelCompiler implements KeymanCompiler { + // @internal + generateLexicalModelCode(model_id: string, modelSource: LexicalModelSource, sourcePath: string): string; + init(callbacks: CompilerCallbacks, _options: CompilerOptions): Promise; + // @internal + loadFromFilename(filename: string): LexicalModelSource; + run(inputFilename: string, outputFilename?: string): Promise; + // @internal (undocumented) + transpileSources(sources: Array): Array; + write(artifacts: LexicalModelCompilerArtifacts): Promise; +} + +// @public +export interface LexicalModelCompilerArtifacts extends KeymanCompilerArtifacts { + js: KeymanCompilerArtifact; +} + +// @public +export interface LexicalModelCompilerResult extends KeymanCompilerResult { + artifacts: LexicalModelCompilerArtifacts; +} + +// Warning: (ae-forgotten-export) The symbol "LexicalModelDeclaration" needs to be exported by the entry point main.d.ts +// +// @public +export interface LexicalModelSource extends LexicalModelDeclaration { + readonly applyCasing?: CasingFunction; + readonly languageUsesCasing?: boolean; + // Warning: (ae-forgotten-export) The symbol "LexicalModelPunctuation" needs to be exported by the entry point main.d.ts + readonly punctuation?: LexicalModelPunctuation; + readonly rootClass?: string; + readonly searchTermToKey?: WordformToKeySpec; + // (undocumented) + readonly sources: Array; + readonly wordBreaker?: WordBreakerSpec | SimpleWordBreakerSpec; +} + +// Warning: (ae-internal-missing-underscore) The name "ModelCompilerMessages" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal (undocumented) +export class ModelCompilerMessages { + // (undocumented) + static ERROR_ModelFileNotFound: number; + // (undocumented) + static Error_ModelFileNotFound: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_NoDefaultExport: number; + // (undocumented) + static Error_NoDefaultExport: () => CompilerEvent; + // (undocumented) + static ERROR_SearchTermToKeyMustBeExplicitlySpecified: number; + // (undocumented) + static Error_SearchTermToKeyMustBeExplicitlySpecified: () => CompilerEvent; + // (undocumented) + static ERROR_UnimplementedModelFormat: number; + // (undocumented) + static Error_UnimplementedModelFormat: (o: { + format: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_UnknownModelFormat: number; + // (undocumented) + static Error_UnknownModelFormat: (o: { + format: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_UnknownWordBreaker: number; + // (undocumented) + static Error_UnknownWordBreaker: (o: { + spec: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_UnsupportedScriptOverride: number; + // (undocumented) + static Error_UnsupportedScriptOverride: (o: { + option: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_UTF16BEUnsupported: number; + // (undocumented) + static Error_UTF16BEUnsupported: () => CompilerEvent; + // (undocumented) + static ERROR_WordlistFileNotFound: number; + // (undocumented) + static Error_WordlistFileNotFound: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static FATAL_UnexpectedException: number; + // (undocumented) + static Fatal_UnexpectedException: (o: { + e: any; + }) => CompilerEvent; + // (undocumented) + static HINT_DuplicateWordInSameFile: number; + // (undocumented) + static Hint_DuplicateWordInSameFile: (o: { + wordform: string; + }) => CompilerEvent; + // (undocumented) + static HINT_MixedNormalizationForms: number; + // (undocumented) + static Hint_MixedNormalizationForms: (o: { + wordform: string; + }) => CompilerEvent; +} + +// Warning: (ae-forgotten-export) The symbol "WordBreakingFunction" needs to be exported by the entry point main.d.ts +// +// @public +export type SimpleWordBreakerSpec = 'default' | 'ascii' | WordBreakingFunction; + +// @public +export type SimpleWordformToKeySpec = (term: string) => string; + +// @public +export interface WordBreakerSpec { + readonly joinWordsAt?: string[]; + // Warning: (ae-forgotten-export) The symbol "OverrideScriptDefaults" needs to be exported by the entry point main.d.ts + readonly overrideScriptDefaults?: OverrideScriptDefaults; + // (undocumented) + readonly use: SimpleWordBreakerSpec; +} + +// @public +export type WordformToKeySpec = SimpleWordformToKeySpec | CasedWordformToKeySpec; + +// (No @packageDocumentation comment for this package) + +``` diff --git a/developer/docs/api/etc/kmc-package.api.md b/developer/docs/api/etc/kmc-package.api.md index eb2c535160..41475fa791 100644 --- a/developer/docs/api/etc/kmc-package.api.md +++ b/developer/docs/api/etc/kmc-package.api.md @@ -1,296 +1,347 @@ -## API Report File for "@keymanapp/kmc-package" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { CompilerCallbacks } from '@keymanapp/common-types'; -import { CompilerEvent } from '@keymanapp/common-types'; -import { CompilerOptions } from '@keymanapp/common-types'; -import { KeymanCompiler } from '@keymanapp/common-types'; -import { KeymanCompilerArtifact } from '@keymanapp/common-types'; -import { KeymanCompilerArtifacts } from '@keymanapp/common-types'; -import { KeymanCompilerResult } from '@keymanapp/common-types'; -import { KmpJsonFile } from '@keymanapp/common-types'; -import { KpsFile } from '@keymanapp/common-types'; - -// @public -export class KmpCompiler implements KeymanCompiler { - // @internal - buildKmpFile(kpsFilename: string, kmpJsonData: KmpJsonFile.KmpJsonFile): Promise; - init(callbacks: CompilerCallbacks, options: KmpCompilerOptions): Promise; - // @internal (undocumented) - loadKpsFile(kpsFilename: string): KpsFile.KpsFile; - // (undocumented) - readonly normalizePath: (path: string) => string; - run(inputFilename: string, outputFilename?: string): Promise; - // @internal (undocumented) - transformKpsFileToKmpObject(kpsFilename: string, kps: KpsFile.KpsFile): KmpJsonFile.KmpJsonFile; - // @internal (undocumented) - transformKpsToKmpObject(kpsFilename: string): KmpJsonFile.KmpJsonFile; - write(artifacts: KmpCompilerArtifacts): Promise; -} - -// @public -export interface KmpCompilerArtifacts extends KeymanCompilerArtifacts { - kmp: KeymanCompilerArtifact; -} - -// @public -export interface KmpCompilerOptions extends CompilerOptions { -} - -// @public -export interface KmpCompilerResult extends KeymanCompilerResult { - artifacts: KmpCompilerArtifacts; -} - -// Warning: (ae-internal-missing-underscore) The name "PackageCompilerMessages" should be prefixed with an underscore because the declaration is marked as @internal -// -// @internal (undocumented) -export class PackageCompilerMessages { - // (undocumented) - static ERROR_FileCouldNotBeRead: number; - // (undocumented) - static Error_FileCouldNotBeRead: (o: { - filename: string; - e: any; - }) => CompilerEvent; - // (undocumented) - static ERROR_FileDoesNotExist: number; - // (undocumented) - static Error_FileDoesNotExist: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_FileRecordIsMissingName: number; - // (undocumented) - static Error_FileRecordIsMissingName: (o: { - description: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_FollowKeyboardVersionButNoKeyboards: number; - // (undocumented) - static Error_FollowKeyboardVersionButNoKeyboards: () => CompilerEvent; - // (undocumented) - static ERROR_FollowKeyboardVersionNotAllowedForModelPackages: number; - // (undocumented) - static Error_FollowKeyboardVersionNotAllowedForModelPackages: () => CompilerEvent; - // (undocumented) - static ERROR_InvalidAuthorEmail: number; - // (undocumented) - static Error_InvalidAuthorEmail: (o: { - email: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_InvalidPackageFile: number; - // (undocumented) - static Error_InvalidPackageFile: (o: { - e: any; - }) => CompilerEvent; - // (undocumented) - static ERROR_KeyboardContentFileNotFound: number; - // (undocumented) - static Error_KeyboardContentFileNotFound: (o: { - id: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_KeyboardFileNotFound: number; - // (undocumented) - static Error_KeyboardFileNotFound: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_KeyboardFileNotValid: number; - // (undocumented) - static Error_KeyboardFileNotValid: (o: { - filename: string; - e: any; - }) => CompilerEvent; - // (undocumented) - static ERROR_LanguageTagIsNotValid: number; - // (undocumented) - static Error_LanguageTagIsNotValid: (o: { - resourceType: string; - id: string; - lang: string; - e: any; - }) => CompilerEvent; - // (undocumented) - static ERROR_ModelMustHaveAtLeastOneLanguage: number; - // (undocumented) - static Error_ModelMustHaveAtLeastOneLanguage: (o: { - id: string; - }) => CompilerEvent; - // (undocumented) - static ERROR_PackageCannotContainBothModelsAndKeyboards: number; - // (undocumented) - static Error_PackageCannotContainBothModelsAndKeyboards: () => CompilerEvent; - // (undocumented) - static ERROR_PackageMustContainAModelOrAKeyboard: number; - // (undocumented) - static Error_PackageMustContainAModelOrAKeyboard: () => CompilerEvent; - // (undocumented) - static ERROR_PackageNameCannotBeBlank: number; - // (undocumented) - static Error_PackageNameCannotBeBlank: () => CompilerEvent; - // (undocumented) - static FATAL_UnexpectedException: number; - // (undocumented) - static Fatal_UnexpectedException: (o: { - e: any; - }) => CompilerEvent; - // (undocumented) - static HINT_JsKeyboardFileHasNoTouchTargets: number; - // (undocumented) - static Hint_JsKeyboardFileHasNoTouchTargets: (o: { - id: string; - }) => CompilerEvent; - // (undocumented) - static HINT_LanguageTagIsNotMinimal: number; - // (undocumented) - static Hint_LanguageTagIsNotMinimal: (o: { - resourceType: string; - id: string; - actual: string; - expected: string; - }) => CompilerEvent; - // (undocumented) - static HINT_PackageContainsSourceFile: number; - // (undocumented) - static Hint_PackageContainsSourceFile: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static HINT_PackageShouldNotRepeatLanguages: number; - // (undocumented) - static Hint_PackageShouldNotRepeatLanguages: (o: { - resourceType: string; - id: string; - minimalTag: string; - firstTag: string; - secondTag: string; - }) => CompilerEvent; - // (undocumented) - static INFO_KeyboardFileHasNoKeyboardVersion: number; - // (undocumented) - static Info_KeyboardFileHasNoKeyboardVersion: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static WARN_AbsolutePath: number; - // (undocumented) - static Warn_AbsolutePath: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static WARN_DocFileDangerous: number; - // (undocumented) - static Warn_DocFileDangerous: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static WARN_FileInPackageDoesNotFollowFilenameConventions: number; - // (undocumented) - static Warn_FileInPackageDoesNotFollowFilenameConventions: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static WARN_FileIsNotABinaryKvkFile: number; - // (undocumented) - static Warn_FileIsNotABinaryKvkFile: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static WARN_JsKeyboardFileIsMissing: number; - // (undocumented) - static Warn_JsKeyboardFileIsMissing: (o: { - id: string; - }) => CompilerEvent; - // (undocumented) - static WARN_KeyboardShouldHaveAtLeastOneLanguage: number; - // (undocumented) - static Warn_KeyboardShouldHaveAtLeastOneLanguage: (o: { - id: string; - }) => CompilerEvent; - // (undocumented) - static WARN_KeyboardVersionsDoNotMatch: number; - // (undocumented) - static Warn_KeyboardVersionsDoNotMatch: (o: { - keyboard: string; - version: string; - firstKeyboard: string; - firstVersion: string; - }) => CompilerEvent; - // (undocumented) - static WARN_PackageNameDoesNotFollowKeyboardConventions: number; - // (undocumented) - static Warn_PackageNameDoesNotFollowKeyboardConventions: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static WARN_PackageNameDoesNotFollowLexicalModelConventions: number; - // (undocumented) - static Warn_PackageNameDoesNotFollowLexicalModelConventions: (o: { - filename: string; - }) => CompilerEvent; - // (undocumented) - static WARN_RedistFileShouldNotBeInPackage: number; - // (undocumented) - static Warn_RedistFileShouldNotBeInPackage: (o: { - filename: string; - }) => CompilerEvent; -} - -// Warning: (ae-internal-missing-underscore) The name "PackageValidation" should be prefixed with an underscore because the declaration is marked as @internal -// -// @internal (undocumented) -export class PackageValidation { - constructor(callbacks: CompilerCallbacks, options: CompilerOptions); - // (undocumented) - validate(filename: string, kmpJson: KmpJsonFile.KmpJsonFile): boolean; -} - -// @public -export class WindowsPackageInstallerCompiler implements KeymanCompiler { - init(callbacks: CompilerCallbacks, options: WindowsPackageInstallerCompilerOptions): Promise; - run(inputFilename: string, outputFilename?: string): Promise; - write(artifacts: WindowsPackageInstallerCompilerArtifacts): Promise; -} - -// @public -export interface WindowsPackageInstallerCompilerArtifacts extends KeymanCompilerArtifacts { - exe: KeymanCompilerArtifact; -} - -// @public -export interface WindowsPackageInstallerCompilerOptions extends KmpCompilerOptions { - sources: WindowsPackageInstallerSources; -} - -// @public -export interface WindowsPackageInstallerCompilerResult extends KeymanCompilerResult { - artifacts: WindowsPackageInstallerCompilerArtifacts; -} - -// @public -export interface WindowsPackageInstallerSources { - // (undocumented) - appName?: string; - // (undocumented) - licenseFilename: string; - // (undocumented) - msiFilename: string; - // (undocumented) - setupExeFilename: string; - // (undocumented) - startDisabled: boolean; - // (undocumented) - startWithConfiguration: boolean; - // (undocumented) - titleImageFilename?: string; -} - -// (No @packageDocumentation comment for this package) - -``` +## API Report File for "@keymanapp/kmc-package" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { CompilerCallbacks } from '@keymanapp/developer-utils'; +import { CompilerEvent } from '@keymanapp/developer-utils'; +import { CompilerOptions } from '@keymanapp/developer-utils'; +import { KeymanCompiler } from '@keymanapp/developer-utils'; +import { KeymanCompilerArtifact } from '@keymanapp/developer-utils'; +import { KeymanCompilerArtifacts } from '@keymanapp/developer-utils'; +import { KeymanCompilerResult } from '@keymanapp/developer-utils'; +import { KmpJsonFile } from '@keymanapp/common-types'; +import { KpsFile } from '@keymanapp/developer-utils'; + +// @public +export class KmpCompiler implements KeymanCompiler { + // @internal + buildKmpFile(kpsFilename: string, kmpJsonData: KmpJsonFile.KmpJsonFile): Promise; + init(callbacks: CompilerCallbacks, options: KmpCompilerOptions): Promise; + // (undocumented) + readonly normalizePath: (path: string) => string; + run(inputFilename: string, outputFilename?: string): Promise; + // @internal (undocumented) + transformKpsFileToKmpObject(kpsFilename: string, kps: KpsFile.KpsFile): KmpJsonFile.KmpJsonFile; + // @internal (undocumented) + transformKpsToKmpObject(kpsFilename: string): KmpJsonFile.KmpJsonFile; + write(artifacts: KmpCompilerArtifacts): Promise; +} + +// @public +export interface KmpCompilerArtifacts extends KeymanCompilerArtifacts { + kmp: KeymanCompilerArtifact; +} + +// @public +export interface KmpCompilerOptions extends CompilerOptions { +} + +// @public +export interface KmpCompilerResult extends KeymanCompilerResult { + artifacts: KmpCompilerArtifacts; +} + +// Warning: (ae-internal-missing-underscore) The name "PackageCompilerMessages" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal (undocumented) +export class PackageCompilerMessages { + // (undocumented) + static ERROR_FileCouldNotBeRead: number; + // (undocumented) + static Error_FileCouldNotBeRead: (o: { + filename: string; + e: any; + }) => CompilerEvent; + // (undocumented) + static ERROR_FileDoesNotExist: number; + // (undocumented) + static Error_FileDoesNotExist: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_FileRecordIsMissingName: number; + // (undocumented) + static Error_FileRecordIsMissingName: (o: { + description: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_FollowKeyboardVersionButNoKeyboards: number; + // (undocumented) + static Error_FollowKeyboardVersionButNoKeyboards: () => CompilerEvent; + // (undocumented) + static ERROR_FollowKeyboardVersionNotAllowedForModelPackages: number; + // (undocumented) + static Error_FollowKeyboardVersionNotAllowedForModelPackages: () => CompilerEvent; + // (undocumented) + static ERROR_InvalidAuthorEmail: number; + // (undocumented) + static Error_InvalidAuthorEmail: (o: { + email: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_KeyboardContentFileNotFound: number; + // (undocumented) + static Error_KeyboardContentFileNotFound: (o: { + id: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_KeyboardFileNotFound: number; + // (undocumented) + static Error_KeyboardFileNotFound: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_KeyboardFileNotValid: number; + // (undocumented) + static Error_KeyboardFileNotValid: (o: { + filename: string; + e: any; + }) => CompilerEvent; + // (undocumented) + static ERROR_LanguageTagIsNotValid: number; + // (undocumented) + static Error_LanguageTagIsNotValid: (o: { + resourceType: string; + id: string; + lang: string; + e: any; + }) => CompilerEvent; + // (undocumented) + static ERROR_MissingKeyboardId: number; + // (undocumented) + static Error_MissingKeyboardId: (o: { + index: number; + }) => CompilerEvent; + // (undocumented) + static ERROR_MissingModelId: number; + // (undocumented) + static Error_MissingModelId: (o: { + index: number; + }) => CompilerEvent; + // (undocumented) + static ERROR_ModelMustHaveAtLeastOneLanguage: number; + // (undocumented) + static Error_ModelMustHaveAtLeastOneLanguage: (o: { + id: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_PackageCannotContainBothModelsAndKeyboards: number; + // (undocumented) + static Error_PackageCannotContainBothModelsAndKeyboards: () => CompilerEvent; + // (undocumented) + static ERROR_PackageFileHasEmptyVersion: number; + // (undocumented) + static Error_PackageFileHasEmptyVersion: () => CompilerEvent; + // (undocumented) + static ERROR_PackageMustContainAModelOrAKeyboard: number; + // (undocumented) + static Error_PackageMustContainAModelOrAKeyboard: () => CompilerEvent; + // (undocumented) + static ERROR_PackageMustNotContainItself: number; + // (undocumented) + static Error_PackageMustNotContainItself: (o: { + outputFilename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_PackageNameCannotBeBlank: number; + // (undocumented) + static Error_PackageNameCannotBeBlank: () => CompilerEvent; + // (undocumented) + static ERROR_RequiredParameterMissing: number; + // (undocumented) + static Error_RequiredParameterMissing: (o: { + param: string; + }) => CompilerEvent; + // (undocumented) + static FATAL_UnexpectedException: number; + // (undocumented) + static Fatal_UnexpectedException: (o: { + e: any; + }) => CompilerEvent; + // (undocumented) + static HINT_JsKeyboardFileHasNoTouchTargets: number; + // (undocumented) + static Hint_JsKeyboardFileHasNoTouchTargets: (o: { + id: string; + }) => CompilerEvent; + // (undocumented) + static HINT_LanguageTagIsNotMinimal: number; + // (undocumented) + static Hint_LanguageTagIsNotMinimal: (o: { + resourceType: string; + id: string; + actual: string; + expected: string; + }) => CompilerEvent; + // (undocumented) + static HINT_PackageContainsSourceFile: number; + // (undocumented) + static Hint_PackageContainsSourceFile: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static HINT_PackageShouldNotRepeatLanguages: number; + // (undocumented) + static Hint_PackageShouldNotRepeatLanguages: (o: { + resourceType: string; + id: string; + minimalTag: string; + firstTag: string; + secondTag: string; + }) => CompilerEvent; + // (undocumented) + static INFO_KeyboardFileHasNoKeyboardVersion: number; + // (undocumented) + static Info_KeyboardFileHasNoKeyboardVersion: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static WARN_AbsolutePath: number; + // (undocumented) + static Warn_AbsolutePath: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static WARN_CannotFindFontForKeyboard: number; + // (undocumented) + static Warn_CannotFindFontForKeyboard: (o: { + id: string; + fontFilename: string; + }) => CompilerEvent; + // (undocumented) + static WARN_CannotFindMatchingKeyboardForVisualKeyboard: number; + // (undocumented) + static Warn_CannotFindMatchingKeyboardForVisualKeyboard: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static WARN_CannotReadFont: number; + // (undocumented) + static Warn_CannotReadFont: (o: { + fontFilename: string; + }) => CompilerEvent; + // (undocumented) + static WARN_DocFileDangerous: number; + // (undocumented) + static Warn_DocFileDangerous: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static WARN_FileInPackageDoesNotFollowFilenameConventions: number; + // (undocumented) + static Warn_FileInPackageDoesNotFollowFilenameConventions: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static WARN_FileIsNotABinaryKvkFile: number; + // (undocumented) + static Warn_FileIsNotABinaryKvkFile: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static WARN_JsKeyboardFileIsMissing: number; + // (undocumented) + static Warn_JsKeyboardFileIsMissing: (o: { + id: string; + }) => CompilerEvent; + // (undocumented) + static WARN_KeyboardShouldHaveAtLeastOneLanguage: number; + // (undocumented) + static Warn_KeyboardShouldHaveAtLeastOneLanguage: (o: { + id: string; + }) => CompilerEvent; + // (undocumented) + static WARN_KeyboardVersionsDoNotMatch: number; + // (undocumented) + static Warn_KeyboardVersionsDoNotMatch: (o: { + keyboard: string; + version: string; + firstKeyboard: string; + firstVersion: string; + }) => CompilerEvent; + // (undocumented) + static WARN_PackageNameDoesNotFollowKeyboardConventions: number; + // (undocumented) + static Warn_PackageNameDoesNotFollowKeyboardConventions: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static WARN_PackageNameDoesNotFollowLexicalModelConventions: number; + // (undocumented) + static Warn_PackageNameDoesNotFollowLexicalModelConventions: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static WARN_PackageVersionIsUnrecognizedFormat: number; + // (undocumented) + static Warn_PackageVersionIsUnrecognizedFormat: (o: { + version: string; + }) => CompilerEvent; + // (undocumented) + static WARN_RedistFileShouldNotBeInPackage: number; + // (undocumented) + static Warn_RedistFileShouldNotBeInPackage: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static WARN_VisualKeyboardFileIsInvalid: number; + // (undocumented) + static Warn_VisualKeyboardFileIsInvalid: (o: { + filename: string; + }) => CompilerEvent; +} + +// Warning: (ae-internal-missing-underscore) The name "PackageValidation" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal (undocumented) +export class PackageValidation { + constructor(callbacks: CompilerCallbacks, options: CompilerOptions); + // (undocumented) + validate(filename: string, outputFilename: string, kmpJson: KmpJsonFile.KmpJsonFile): boolean; +} + +// @public +export class WindowsPackageInstallerCompiler implements KeymanCompiler { + init(callbacks: CompilerCallbacks, options: WindowsPackageInstallerCompilerOptions): Promise; + run(inputFilename: string, outputFilename?: string): Promise; + write(artifacts: WindowsPackageInstallerCompilerArtifacts): Promise; +} + +// @public +export interface WindowsPackageInstallerCompilerArtifacts extends KeymanCompilerArtifacts { + exe: KeymanCompilerArtifact; +} + +// @public +export interface WindowsPackageInstallerCompilerOptions extends KmpCompilerOptions { + sources: WindowsPackageInstallerSources; +} + +// @public +export interface WindowsPackageInstallerCompilerResult extends KeymanCompilerResult { + artifacts: WindowsPackageInstallerCompilerArtifacts; +} + +// @public +export interface WindowsPackageInstallerSources { + // (undocumented) + appName?: string; + // (undocumented) + licenseFilename: string; + // (undocumented) + msiFilename: string; + // (undocumented) + setupExeFilename: string; + // (undocumented) + startDisabled: boolean; + // (undocumented) + startWithConfiguration: boolean; + // (undocumented) + titleImageFilename?: string; +} + +// (No @packageDocumentation comment for this package) + +```