diff --git a/developer/docs/api/etc/kmc-analyze.api.md b/developer/docs/api/etc/kmc-analyze.api.md new file mode 100644 index 0000000000..c2b911a450 --- /dev/null +++ b/developer/docs/api/etc/kmc-analyze.api.md @@ -0,0 +1,52 @@ +## 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/common-types'; + +// @public (undocumented) +export class AnalyzeOskCharacterUse { + // Warning: (ae-forgotten-export) The symbol "AnalyzeOskCharacterUseOptions" needs to be exported by the entry point index.d.ts + constructor(callbacks: CompilerCallbacks, options?: AnalyzeOskCharacterUseOptions); + analyze(file: string): Promise; + clear(): void; + getStrings(format?: '.txt' | '.md' | '.json'): string[]; +} + +// @public (undocumented) +export class AnalyzeOskRewritePua { + constructor(callbacks: CompilerCallbacks); + // (undocumented) + analyze(file: string, mapping: Osk.StringResult[]): Promise; + // (undocumented) + clear(): void; + // (undocumented) + get data(): { + [index: string]: Uint8Array; + }; +} + +// @public (undocumented) +export class AnalyzerMessages { + // (undocumented) + static FATAL_UnexpectedException: number; + // (undocumented) + static Fatal_UnexpectedException: (o: { + e: any; + }) => CompilerEvent; + // (undocumented) + static INFO_ScanningFile: number; + // (undocumented) + static Info_ScanningFile: (o: { + type: string; + name: string; + }) => CompilerEvent; +} + +// (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 new file mode 100644 index 0000000000..93e652e9e3 --- /dev/null +++ b/developer/docs/api/etc/kmc-keyboard-info.api.md @@ -0,0 +1,148 @@ +## 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 (undocumented) +export class KeyboardInfoCompiler implements KeymanCompiler { + constructor(); + // Warning: (ae-forgotten-export) The symbol "KeyboardInfoFileLanguageFont" needs to be exported by the entry point index.d.ts + // + // (undocumented) + fontSourceToKeyboardInfoFont(kpsFilename: string, kmpJsonData: KmpJsonFile.KmpJsonFile, source: string[]): Promise; + // (undocumented) + init(callbacks: CompilerCallbacks, options: KeyboardInfoCompilerOptions): Promise; + run(inputFilename: string, outputFilename?: string): Promise; + // (undocumented) + write(artifacts: KeyboardInfoCompilerArtifacts): Promise; +} + +// @public (undocumented) +export interface KeyboardInfoCompilerArtifacts extends KeymanCompilerArtifacts { + // (undocumented) + keyboard_info: KeymanCompilerArtifact; +} + +// @public (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_FileIsNotValid: number; + // (undocumented) + static Error_FileIsNotValid: (o: { + filename: string; + e: any; + }) => CompilerEvent; + // (undocumented) + static ERROR_FontFileCannotBeRead: number; + // (undocumented) + static Error_FontFileCannotBeRead: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_InvalidAuthorEmail: number; + // (undocumented) + static Error_InvalidAuthorEmail: (o: { + email: string; + }) => CompilerEvent; + // (undocumented) + static Error_LicenseFileDoesNotExist: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_LicenseFileIsDamaged: number; + // (undocumented) + static Error_LicenseFileIsDamaged: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_LicenseFileIsMissing: number; + // (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 ERROR_OutputValidation: number; + // (undocumented) + static Error_OutputValidation: (o: { + message: any; + }) => CompilerEvent; + // (undocumented) + static FATAL_UnexpectedException: number; + // (undocumented) + static Fatal_UnexpectedException: (o: { + e: any; + }) => CompilerEvent; + // (undocumented) + static HINT_OutputValidation: number; + // (undocumented) + static Hint_OutputValidation: (o: { + message: any; + }) => CompilerEvent; + // (undocumented) + static WARN_MetadataFieldInconsistent: number; + // (undocumented) + static Warn_MetadataFieldInconsistent: (o: { + field: string; + value: any; + expected: any; + }) => CompilerEvent; + // (undocumented) + static WARN_OutputValidation: number; + // (undocumented) + static Warn_OutputValidation: (o: { + message: any; + }) => CompilerEvent; +} + +// @public (undocumented) +export interface KeyboardInfoCompilerOptions extends CompilerOptions { + // (undocumented) + sources: KeyboardInfoSources; +} + +// @public (undocumented) +export interface KeyboardInfoCompilerResult extends KeymanCompilerResult { + // (undocumented) + artifacts: KeyboardInfoCompilerArtifacts; +} + +// @public (undocumented) +export interface KeyboardInfoSources { + forPublishing: boolean; + jsFilename?: string; + kmpFilename: string; + kpsFilename: string; + lastCommitDate?: string; + sourcePath: string; +} + +// (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 new file mode 100644 index 0000000000..b1faead083 --- /dev/null +++ b/developer/docs/api/etc/kmc-kmn.api.md @@ -0,0 +1,580 @@ +## 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 { Osk } from '@keymanapp/common-types'; +import { UnicodeSet } from '@keymanapp/common-types'; +import { UnicodeSetParser } from '@keymanapp/common-types'; + +// @public (undocumented) +export class CompilerMessages { + // (undocumented) + static ERROR_FileNotFound: number; + // (undocumented) + static Error_FileNotFound: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_InvalidDisplayMapFile: number; + // (undocumented) + static Error_InvalidDisplayMapFile: (o: { + filename: string; + e: any; + }) => 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_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 FATAL_CallbacksNotSet: number; + // (undocumented) + static Fatal_CallbacksNotSet: () => CompilerEvent; + // (undocumented) + static FATAL_MissingWasmModule: number; + // (undocumented) + static Fatal_MissingWasmModule: (o: { + e?: any; + }) => CompilerEvent; + // (undocumented) + static FATAL_UnableToSetCompilerOptions: number; + // (undocumented) + static Fatal_UnableToSetCompilerOptions: () => 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 WARN_InvalidVkeyInKvksFile: number; + // (undocumented) + static Warn_InvalidVkeyInKvksFile: (o: { + filename: string; + invalidVkey: string; + }) => CompilerEvent; +} + +// @public (undocumented) +export class KmnCompiler implements KeymanCompiler, UnicodeSetParser { + constructor(); + static fixNewPattern(pattern: string): string; + // Warning: (ae-forgotten-export) The symbol "KmnCompilerOptions" needs to be exported by the entry point main.d.ts + // + // (undocumented) + init(callbacks: CompilerCallbacks, options: KmnCompilerOptions): Promise; + // (undocumented) + parseUnicodeSet(pattern: string, rangeCount: number): UnicodeSet | null; + // Warning: (ae-forgotten-export) The symbol "KmnCompilerResult" needs to be exported by the entry point main.d.ts + // + // (undocumented) + run(infile: string, outfile: string): Promise; + // (undocumented) + sizeUnicodeSet(pattern: string): number; + // (undocumented) + testSentry(): any; + verifyInitialized(): boolean; + // Warning: (ae-forgotten-export) The symbol "KmnCompilerArtifacts" needs to be exported by the entry point main.d.ts + // + // (undocumented) + write(artifacts: KmnCompilerArtifacts): Promise; +} + +// @public +export class KmnCompilerMessages { + // (undocumented) + static ERROR_140FeatureOnlyContextAndNotAnyWeb: number; + // (undocumented) + static ERROR_501FeatureOnly_Call: number; + // (undocumented) + static ERROR_60FeatureOnly_Contextn: number; + // (undocumented) + static ERROR_60FeatureOnly_EthnologueCode: number; + // (undocumented) + static ERROR_60FeatureOnly_MnemonicLayout: number; + // (undocumented) + static ERROR_60FeatureOnly_NamedCodes: number; + // (undocumented) + static ERROR_60FeatureOnly_OldCharPosMatching: number; + // (undocumented) + static ERROR_60FeatureOnly_VirtualCharKey: number; + // (undocumented) + static ERROR_70FeatureOnly: number; + // (undocumented) + static ERROR_80FeatureOnly: number; + // (undocumented) + static ERROR_90FeatureOnly_IfSystemStores: number; + // (undocumented) + static ERROR_90FeatureOnly_SetSystemStores: number; + // (undocumented) + static ERROR_90FeatureOnlyEmbedCSS: number; + // (undocumented) + static ERROR_90FeatureOnlyKeyboardVersion: number; + // (undocumented) + static ERROR_90FeatureOnlyLayoutFile: number; + // (undocumented) + static ERROR_90FeatureOnlyTargets: number; + // (undocumented) + static ERROR_90FeatureOnlyVirtualKeyDictionary: number; + // (undocumented) + static ERROR_AnyInVirtualKeySection: number; + // (undocumented) + static ERROR_BeepInVirtualKeySection: number; + // (undocumented) + static ERROR_CallInVirtualKeySection: number; + // (undocumented) + static ERROR_CannotLoadIncludeFile: number; + // (undocumented) + static ERROR_CannotReadBitmapFile: number; + // (undocumented) + static ERROR_CannotReadInfile: number; + // (undocumented) + static ERROR_CannotUseReadWriteGroupFromReadonlyGroup: number; + // (undocumented) + static ERROR_CasedKeysMustContainOnlyVirtualKeys: number; + // (undocumented) + static ERROR_CasedKeysMustNotIncludeShiftStates: number; + // (undocumented) + static ERROR_CasedKeysNotSupportedWithMnemonicLayout: number; + // (undocumented) + static ERROR_CharacterExpansionMustBeFollowedByCharacter: number; + // (undocumented) + static ERROR_CodeInvalidInKeyStore: number; + // (undocumented) + static ERROR_CodeInvalidInThisSection: number; + // (undocumented) + static ERROR_ContextAndIndexInvalidInMatchNomatch: number; + // (undocumented) + static ERROR_ContextExHasInvalidOffset: number; + // (undocumented) + static ERROR_ContextInVirtualKeySection: number; + // (undocumented) + static ERROR_DuplicateGroup: number; + // (undocumented) + static ERROR_DuplicateStore: number; + // (undocumented) + static ERROR_ExpansionMustBePositive: number; + // (undocumented) + static ERROR_ExpansionMustFollowCharacterOrVKey: number; + // (undocumented) + static ERROR_GroupDoesNotExist: number; + // (undocumented) + static ERROR_IfSystemStore_NotFound: number; + // (undocumented) + static ERROR_IndexDoesNotPointToAny: number; + // (undocumented) + static ERROR_IndexInVirtualKeySection: number; + // (undocumented) + static ERROR_InfileNotExist: number; + // (undocumented) + static ERROR_InvalidAny: number; + // (undocumented) + static ERROR_InvalidBegin: number; + // (undocumented) + static ERROR_InvalidBitmapLine: number; + // (undocumented) + static ERROR_InvalidCall: number; + // (undocumented) + static ERROR_InvalidCharacter: number; + // (undocumented) + static ERROR_InvalidCodeInKeyPartOfRule: number; + // (undocumented) + static ERROR_InvalidCopyright: number; + // (undocumented) + static ERROR_InvalidDeadkey: number; + // (undocumented) + static ERROR_InvalidEthnologueCode: number; + // (undocumented) + static ERROR_InvalidGroupLine: number; + // (undocumented) + static ERROR_InvalidIf: number; + // (undocumented) + static ERROR_InvalidIndex: number; + // (undocumented) + static ERROR_InvalidInVirtualKeySection: number; + // (undocumented) + static ERROR_InvalidKeyCode: number; + // (undocumented) + static ERROR_InvalidLanguageLine: number; + // (undocumented) + static ERROR_InvalidLanguageName: number; + // (undocumented) + static ERROR_InvalidLayoutLine: number; + // (undocumented) + static ERROR_InvalidLineContinuation: number; + // (undocumented) + static ERROR_InvalidMessage: number; + // (undocumented) + static ERROR_InvalidName: number; + // (undocumented) + static ERROR_InvalidNamedCode: number; + // (undocumented) + static ERROR_InvalidOuts: number; + // (undocumented) + static ERROR_InvalidReset: number; + // (undocumented) + static ERROR_InvalidSave: number; + // (undocumented) + static ERROR_InvalidSet: number; + // (undocumented) + static ERROR_InvalidStoreLine: number; + // (undocumented) + static ERROR_InvalidSwitch: number; + // (undocumented) + static ERROR_InvalidSystemStore: number; + // (undocumented) + static ERROR_InvalidToken: number; + // (undocumented) + static ERROR_InvalidTouchLayoutFile: number; + // (undocumented) + static ERROR_InvalidUse: number; + // (undocumented) + static ERROR_InvalidValue: number; + // (undocumented) + static ERROR_InvalidVersion: number; + // (undocumented) + static ERROR_KeyboardVersionFormatInvalid: number; + // (undocumented) + static ERROR_LayoutButNoLanguage: number; + // (undocumented) + static ERROR_LineTooLong: number; + // (undocumented) + static ERROR_NewContextGroupMustBeReadonly: number; + // (undocumented) + static ERROR_NoTokensFound: number; + // (undocumented) + static ERROR_NotSupportedInKeymanWebContext: number; + // (undocumented) + static ERROR_NotSupportedInKeymanWebOutput: number; + // (undocumented) + static ERROR_NotSupportedInKeymanWebStore: number; + // (undocumented) + static ERROR_NoVersionLine: number; + // (undocumented) + static ERROR_OutputInReadonlyGroup: number; + // (undocumented) + static ERROR_OutsInVirtualKeySection: number; + // (undocumented) + static ERROR_PostKeystrokeGroupMustBeReadonly: number; + // (undocumented) + static ERROR_RepeatedBegin: number; + // (undocumented) + static ERROR_ReservedCharacter: number; + // (undocumented) + static ERROR_SetSystemStore_NotFound: number; + // (undocumented) + static ERROR_StatementNotPermittedInReadonlyGroup: number; + // (undocumented) + static ERROR_StoreDoesNotExist: number; + // (undocumented) + static ERROR_StringInVirtualKeySection: number; + // (undocumented) + static ERROR_TooManyIndexToKeyRefs: number; + // (undocumented) + static ERROR_TouchLayoutInvalidIdentifier: number; + // (undocumented) + static ERROR_UnterminatedString: number; + // (undocumented) + static ERROR_VersionAlreadyIncluded: number; + // (undocumented) + static ERROR_VirtualCharacterKeysNotSupportedInKeymanWeb: number; + // (undocumented) + static ERROR_VirtualKeyInContext: number; + // (undocumented) + static ERROR_VirtualKeyNotAllowedHere: number; + // (undocumented) + static ERROR_VirtualKeysNotValidForMnemonicLayouts: number; + // (undocumented) + static ERROR_VKeyExpansionMustBeFollowedByVKey: number; + // (undocumented) + static ERROR_VKeyExpansionMustUseConsistentShift: number; + // (undocumented) + static ERROR_ZeroLengthString: number; + // (undocumented) + static FATAL_BadCallParams: number; + // (undocumented) + static FATAL_Break: number; + // (undocumented) + static FATAL_BufferOverflow: number; + // (undocumented) + static FATAL_CannotAllocateMemory: number; + // (undocumented) + static FATAL_CannotCreateTempfile: number; + // (undocumented) + static FATAL_SomewhereIGotItWrong: number; + // (undocumented) + static FATAL_UnableToWriteFully: number; + // (undocumented) + static HINT_NonUnicodeFile: number; + // (undocumented) + static HINT_UnreachableKeyCode: number; + // (undocumented) + static HINT_UnreachableRule: number; + // (undocumented) + static INFO_EndOfFile: number; + // (undocumented) + static INFO_Info: number; + // (undocumented) + static INFO_None: number; + // (undocumented) + static WARN_ANSIInUnicodeGroup: number; + // (undocumented) + static WARN_BitmapNotUsed: number; + // (undocumented) + static WARN_CouldNotCopyJsonFile: number; + // (undocumented) + static WARN_CustomLanguagesNotSupported: number; + // (undocumented) + static WARN_DontMixChiralAndNonChiralModifiers: number; + // (undocumented) + static WARN_EmbedJsFileMissing: number; + // (undocumented) + static WARN_ExtendedShiftFlagsNotSupportedInKeymanWeb: number; + // (undocumented) + static WARN_HeaderStatementIsDeprecated: number; + // (undocumented) + static WARN_HelpFileMissing: number; + // (undocumented) + static WARN_HotkeyHasInvalidModifier: number; + // (undocumented) + static WARN_IfShouldBeAtStartOfContext: number; + // (undocumented) + static WARN_IndexStoreShort: number; + // (undocumented) + static WARN_InvalidJSONMetadataFile: number; + // (undocumented) + static WARN_JSONMetadataOSKFontShouldMatchTouchFont: number; + // (undocumented) + static WARN_KeyBadLength: number; + // (undocumented) + static WARN_KeyShouldIncludeNCaps: number; + // (undocumented) + static WARN_KVKFileIsInSourceFormat: number; + // (undocumented) + static WARN_LanguageHeadersDeprecatedInKeyman10: number; + // (undocumented) + static WARN_MixingLeftAndRightModifiers: number; + // (undocumented) + static WARN_NulNotFirstStatementInContext: number; + // (undocumented) + static WARN_OldVersion: number; + // (undocumented) + static WARN_OptionStoreNameInvalid: number; + // (undocumented) + static WARN_PlatformNotInTargets: number; + // (undocumented) + static WARN_PunctuationInEthnologueCode: number; + // (undocumented) + static WARN_ReservedCharacter: number; + // (undocumented) + static WARN_StoreAlreadyUsedAsOptionOrCall: number; + // (undocumented) + static WARN_StoreAlreadyUsedAsStoreOrCall: number; + // (undocumented) + static WARN_StoreAlreadyUsedAsStoreOrOption: number; + // (undocumented) + static WARN_TooManyErrorsOrWarnings: number; + // (undocumented) + static WARN_TooManyWarnings: number; + // (undocumented) + static WARN_TouchLayoutCustomKeyNotDefined: number; + // (undocumented) + static WARN_TouchLayoutFileMissing: number; + // (undocumented) + static WARN_TouchLayoutFontShouldBeSameForAllPlatforms: number; + // (undocumented) + static WARN_TouchLayoutMissingLayer: number; + // (undocumented) + static WARN_TouchLayoutMissingRequiredKeys: number; + // (undocumented) + static WARN_TouchLayoutSpecialLabelOnNormalKey: number; + // (undocumented) + static WARN_TouchLayoutUnidentifiedKey: number; + // (undocumented) + static WARN_UnicodeInANSIGroup: number; + // (undocumented) + static WARN_UnicodeSurrogateUsed: number; + // (undocumented) + static WARN_UseNotLastStatementInRule: number; + // (undocumented) + static WARN_VirtualCharKeyWithPositionalLayout: number; + // (undocumented) + static WARN_VirtualKeyInOutput: number; + // (undocumented) + static WARN_VirtualKeyWithMnemonicLayout: number; + // (undocumented) + static WARN_VisualKeyboardFileMissing: number; +} + +// @public (undocumented) +export class KmwCompilerMessages extends KmnCompilerMessages { + // (undocumented) + static Error_InvalidBegin: () => CompilerEvent; + // (undocumented) + static Error_InvalidKeyCode: (o: { + keyId: string; + }) => CompilerEvent; + // (undocumented) + static Error_InvalidTouchLayoutFile: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_InvalidTouchLayoutFileFormat: number; + // (undocumented) + static Error_InvalidTouchLayoutFileFormat: (o: { + msg: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_NotAnyRequiresVersion14: number; + // (undocumented) + static Error_NotAnyRequiresVersion14: (o: { + line: number; + }) => CompilerEvent; + // (undocumented) + static Error_NotSupportedInKeymanWebContext: (o: { + line: number; + code: String; + }) => CompilerEvent; + // (undocumented) + static Error_NotSupportedInKeymanWebOutput: (o: { + line: number; + code: string; + }) => CompilerEvent; + // (undocumented) + static Error_NotSupportedInKeymanWebStore: (o: { + code: string; + store: 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 Error_TouchLayoutInvalidIdentifier: (o: { + keyId: string; + platformName: string; + layerId: string; + }) => CompilerEvent; + // (undocumented) + static Error_VirtualCharacterKeysNotSupportedInKeymanWeb: (o: { + line: number; + }) => CompilerEvent; + // (undocumented) + static Error_VirtualKeysNotValidForMnemonicLayouts: (o: { + line: number; + }) => CompilerEvent; + // (undocumented) + static HINT_TouchLayoutUsesUnsupportedGesturesDownlevel: number; + // (undocumented) + static Hint_TouchLayoutUsesUnsupportedGesturesDownlevel: (o: { + keyId: string; + }) => CompilerEvent; + // (undocumented) + static Hint_UnreachableKeyCode: (o: { + line: number; + key: string; + }) => CompilerEvent; + // (undocumented) + static Warn_DontMixChiralAndNonChiralModifiers: () => CompilerEvent; + // (undocumented) + static Warn_EmbedJsFileMissing: (o: { + line: number; + jsFilename: string; + e: any; + }) => CompilerEvent; + // (undocumented) + static Warn_ExtendedShiftFlagsNotSupportedInKeymanWeb: (o: { + line: number; + flags: string; + }) => CompilerEvent; + // (undocumented) + static Warn_HelpFileMissing: (o: { + line: number; + helpFilename: string; + e: any; + }) => CompilerEvent; + // (undocumented) + static Warn_OptionStoreNameInvalid: (o: { + name: string; + }) => CompilerEvent; + // (undocumented) + static Warn_TouchLayoutCustomKeyNotDefined: (o: { + keyId: string; + platformName: string; + layerId: string; + }) => CompilerEvent; + // (undocumented) + static Warn_TouchLayoutFontShouldBeSameForAllPlatforms: () => CompilerEvent; + // (undocumented) + static Warn_TouchLayoutMissingLayer: (o: { + keyId: string; + platformName: string; + layerId: string; + nextLayer: string; + }) => CompilerEvent; + // (undocumented) + static Warn_TouchLayoutMissingRequiredKeys: (o: { + layerId: string; + platformName: string; + missingKeys: string; + }) => CompilerEvent; + // (undocumented) + static Warn_TouchLayoutSpecialLabelOnNormalKey: (o: { + keyId: string; + platformName: string; + layerId: string; + label: string; + }) => CompilerEvent; + // (undocumented) + static Warn_TouchLayoutUnidentifiedKey: (o: { + layerId: string; + }) => CompilerEvent; +} + +// (No @packageDocumentation comment for this package) + +``` diff --git a/developer/docs/api/etc/kmc-ldml.api.md b/developer/docs/api/etc/kmc-ldml.api.md new file mode 100644 index 0000000000..65ca6d3088 --- /dev/null +++ b/developer/docs/api/etc/kmc-ldml.api.md @@ -0,0 +1,336 @@ +## 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 { KMXBuilder } from '@keymanapp/common-types'; +import { KMXPlus } from '@keymanapp/common-types'; +import { LDMLKeyboard } from '@keymanapp/common-types'; +import { LDMLKeyboardTestDataXMLSourceFile } from '@keymanapp/common-types'; +import { LDMLKeyboardXMLSourceFileReaderOptions } from '@keymanapp/common-types'; +import { SectionIdent } from '@keymanapp/ldml-keyboard-constants'; +import { TouchLayout } from '@keymanapp/common-types'; +import { UnicodeSet } from '@keymanapp/common-types'; +import { UnicodeSetParser } from '@keymanapp/common-types'; +import { VisualKeyboard } from '@keymanapp/common-types'; + +export { KMXBuilder } + +// @public (undocumented) +export class KMXPlusMetadataCompiler { + // Warning: (ae-forgotten-export) The symbol "KMXPlusData" needs to be exported by the entry point main.d.ts + // Warning: (ae-forgotten-export) The symbol "KEYBOARD" needs to be exported by the entry point main.d.ts + static addKmxMetadata(kmxplus: KMXPlusData, keyboard: KEYBOARD, options: LdmlCompilerOptions): void; +} + +// @public (undocumented) +export interface LdmlCompilerOptions extends CompilerOptions { + readerOptions: LDMLKeyboardXMLSourceFileReaderOptions; +} + +// @public (undocumented) +export class LdmlKeyboardCompiler implements KeymanCompiler { + compile(source: LDMLKeyboardXMLSourceFile, postValidate?: boolean): Promise; + getUsetParser(): Promise; + // (undocumented) + init(callbacks: CompilerCallbacks, options: LdmlCompilerOptions): Promise; + // Warning: (ae-forgotten-export) The symbol "LDMLKeyboardXMLSourceFile" needs to be exported by the entry point main.d.ts + load(filename: string): LDMLKeyboardXMLSourceFile | null; + loadTestData(filename: string): LDMLKeyboardTestDataXMLSourceFile | null; + // Warning: (ae-forgotten-export) The symbol "LdmlKeyboardCompilerResult" needs to be exported by the entry point main.d.ts + // + // (undocumented) + run(inputFilename: string, outputFilename?: string): Promise; + validate(source: LDMLKeyboardXMLSourceFile): Promise; + // Warning: (ae-forgotten-export) The symbol "LdmlKeyboardCompilerArtifacts" needs to be exported by the entry point main.d.ts + // + // (undocumented) + write(artifacts: LdmlKeyboardCompilerArtifacts): Promise; +} + +// @public (undocumented) +export class LdmlKeyboardCompilerMessages { + // (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_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_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 FATAL_SectionCompilerFailed: number; + // (undocumented) + static Fatal_SectionCompilerFailed: (o: { + sect: 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_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 (undocumented) +export class LdmlKeyboardKeymanWebCompiler { + constructor(callbacks: CompilerCallbacks, options?: LdmlCompilerOptions); + // (undocumented) + compile(name: string, source: LDMLKeyboard.LDMLKeyboardXMLSourceFile): string; + // (undocumented) + compileTouchLayout(source: LDMLKeyboard.LDMLKeyboardXMLSourceFile): string; + // (undocumented) + compileVisualKeyboard(source: LDMLKeyboard.LDMLKeyboardXMLSourceFile): string; +} + +// @public (undocumented) +export class LdmlKeyboardVisualKeyboardCompiler { + constructor(callbacks: CompilerCallbacks); + // (undocumented) + compile(source: LDMLKeyboard.LDMLKeyboardXMLSourceFile): VisualKeyboard.VisualKeyboard; +} + +// @public (undocumented) +export class TouchLayoutCompiler { + // (undocumented) + compileToJavascript(source: LDMLKeyboard.LDMLKeyboardXMLSourceFile): TouchLayout.TouchLayoutFile; +} + +// (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 new file mode 100644 index 0000000000..1c933be669 --- /dev/null +++ b/developer/docs/api/etc/kmc-model-info.api.md @@ -0,0 +1,118 @@ +## 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 (undocumented) +export class ModelInfoCompiler implements KeymanCompiler { + constructor(); + // (undocumented) + init(callbacks: CompilerCallbacks, options: ModelInfoCompilerOptions): Promise; + run(inputFilename: string, outputFilename?: string): Promise; + // (undocumented) + write(artifacts: ModelInfoCompilerArtifacts): Promise; +} + +// @public (undocumented) +export interface ModelInfoCompilerArtifacts extends KeymanCompilerArtifacts { + // (undocumented) + model_info: KeymanCompilerArtifact; +} + +// @public (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_LicenseFileDoesNotExist: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_LicenseFileIsDamaged: number; + // (undocumented) + static Error_LicenseFileIsDamaged: (o: { + filename: string; + }) => CompilerEvent; + // (undocumented) + static ERROR_LicenseFileIsMissing: number; + // (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 (undocumented) +export interface ModelInfoCompilerOptions extends CompilerOptions { + // (undocumented) + sources: ModelInfoSources; +} + +// @public (undocumented) +export interface ModelInfoCompilerResult extends KeymanCompilerResult { + // (undocumented) + artifacts: ModelInfoCompilerArtifacts; +} + +// @public (undocumented) +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 new file mode 100644 index 0000000000..68ef0fd4ed --- /dev/null +++ b/developer/docs/api/etc/kmc-model.api.md @@ -0,0 +1,96 @@ +## 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 (undocumented) +export class LexicalModelCompiler implements KeymanCompiler { + generateLexicalModelCode(model_id: string, modelSource: LexicalModelSource, sourcePath: string): string; + // (undocumented) + init(callbacks: CompilerCallbacks, _options: CompilerOptions): Promise; + // Warning: (ae-forgotten-export) The symbol "LexicalModelSource" needs to be exported by the entry point main.d.ts + loadFromFilename(filename: string): LexicalModelSource; + // Warning: (ae-forgotten-export) The symbol "LexicalModelCompilerResult" needs to be exported by the entry point main.d.ts + // + // (undocumented) + run(inputFilename: string, outputFilename?: string): Promise; + // (undocumented) + transpileSources(sources: Array): Array; + // Warning: (ae-forgotten-export) The symbol "LexicalModelCompilerArtifacts" needs to be exported by the entry point main.d.ts + // + // (undocumented) + write(artifacts: LexicalModelCompilerArtifacts): Promise; +} + +// @public (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; +} + +// (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 new file mode 100644 index 0000000000..2601e38f3b --- /dev/null +++ b/developer/docs/api/etc/kmc-package.api.md @@ -0,0 +1,266 @@ +## 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 (undocumented) +export class KmpCompiler implements KeymanCompiler { + buildKmpFile(kpsFilename: string, kmpJsonData: KmpJsonFile.KmpJsonFile): Promise; + // Warning: (ae-forgotten-export) The symbol "KmpCompilerOptions" needs to be exported by the entry point main.d.ts + // + // (undocumented) + init(callbacks: CompilerCallbacks, options: KmpCompilerOptions): Promise; + // (undocumented) + loadKpsFile(kpsFilename: string): KpsFile.KpsFile; + // Warning: (ae-forgotten-export) The symbol "KmpCompilerResult" needs to be exported by the entry point main.d.ts + // + // (undocumented) + run(inputFilename: string, outputFilename?: string): Promise; + // (undocumented) + transformKpsFileToKmpObject(kpsFilename: string, kps: KpsFile.KpsFile): KmpJsonFile.KmpJsonFile; + // (undocumented) + transformKpsToKmpObject(kpsFilename: string): KmpJsonFile.KmpJsonFile; + // Warning: (ae-forgotten-export) The symbol "KmpCompilerArtifacts" needs to be exported by the entry point main.d.ts + // + // (undocumented) + write(artifacts: KmpCompilerArtifacts): Promise; +} + +// @public (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_FollowKeyboardVersionButNoKeyboards: number; + // (undocumented) + static Error_FollowKeyboardVersionButNoKeyboards: () => CompilerEvent; + // (undocumented) + static ERROR_FollowKeyboardVersionNotAllowedForModelPackages: number; + // (undocumented) + static Error_FollowKeyboardVersionNotAllowedForModelPackages: () => 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; +} + +// @public (undocumented) +export class PackageValidation { + constructor(callbacks: CompilerCallbacks, options: CompilerOptions); + // (undocumented) + validate(filename: string, kmpJson: KmpJsonFile.KmpJsonFile): boolean; +} + +// @public (undocumented) +export class WindowsPackageInstallerCompiler implements KeymanCompiler { + // Warning: (ae-forgotten-export) The symbol "WindowsPackageInstallerCompilerOptions" needs to be exported by the entry point main.d.ts + // + // (undocumented) + init(callbacks: CompilerCallbacks, options: WindowsPackageInstallerCompilerOptions): Promise; + // Warning: (ae-forgotten-export) The symbol "WindowsPackageInstallerCompilerResult" needs to be exported by the entry point main.d.ts + // + // (undocumented) + run(inputFilename: string, outputFilename?: string): Promise; + // Warning: (ae-forgotten-export) The symbol "WindowsPackageInstallerCompilerArtifacts" needs to be exported by the entry point main.d.ts + // + // (undocumented) + write(artifacts: WindowsPackageInstallerCompilerArtifacts): Promise; +} + +// @public (undocumented) +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) + +```