mirror of
https://github.com/keymanapp/keyman.git
synced 2026-09-24 08:37:42 +00:00
docs(developer): add/update API docs
Test-bot: skip Build-bot: skip
This commit is contained in:
Marc Durdin
parent
65dabe45df
commit
9de8371cfe
9 changed files with 2646 additions and 2010 deletions
|
|
@ -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<boolean>;
|
||||
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<boolean>;
|
||||
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<boolean>;
|
||||
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<boolean>;
|
||||
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;
|
||||
}
|
||||
|
||||
```
|
||||
|
|
|
|||
258
developer/docs/api/etc/kmc-copy.api.md
Normal file
258
developer/docs/api/etc/kmc-copy.api.md
Normal file
|
|
@ -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<boolean>;
|
||||
// (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<CopierResult>;
|
||||
// (undocumented)
|
||||
sourceId: string;
|
||||
// @internal (undocumented)
|
||||
unitTestEndPoints: {
|
||||
getGithubSourceProject: (source: string) => Promise<GitHubRef>;
|
||||
getCloudSourceProject: (source: string) => Promise<GitHubRef>;
|
||||
};
|
||||
// Warning: (ae-forgotten-export) The symbol "CopierArtifacts" needs to be exported by the entry point main.d.ts
|
||||
write(artifacts: CopierArtifacts): Promise<boolean>;
|
||||
}
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
181
developer/docs/api/etc/kmc-generate.api.md
Normal file
181
developer/docs/api/etc/kmc-generate.api.md
Normal file
|
|
@ -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<boolean>;
|
||||
// (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<boolean>;
|
||||
}
|
||||
|
||||
// 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<GeneratorResult>;
|
||||
// (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<GeneratorResult>;
|
||||
// (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<GeneratorResult>;
|
||||
// (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)
|
||||
|
||||
```
|
||||
|
|
@ -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<KeyboardInfoFileLanguageFont>;
|
||||
init(callbacks: CompilerCallbacks, options: KeyboardInfoCompilerOptions): Promise<boolean>;
|
||||
run(inputFilename: string, outputFilename?: string): Promise<KeyboardInfoCompilerResult>;
|
||||
write(artifacts: KeyboardInfoCompilerArtifacts): Promise<boolean>;
|
||||
}
|
||||
|
||||
// @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<KeyboardInfoFileLanguageFont>;
|
||||
init(callbacks: CompilerCallbacks, options: KeyboardInfoCompilerOptions): Promise<boolean>;
|
||||
run(inputFilename: string, outputFilename?: string): Promise<KeyboardInfoCompilerResult>;
|
||||
// @internal (undocumented)
|
||||
unitTestEndPoints: {
|
||||
fillLanguageMetadata: (language: KeyboardInfoFileLanguage, bcp47: string, commonScript: string, firstBcp47: string) => {
|
||||
commonScript: string;
|
||||
firstBcp47: string;
|
||||
};
|
||||
};
|
||||
write(artifacts: KeyboardInfoCompilerArtifacts): Promise<boolean>;
|
||||
}
|
||||
|
||||
// @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)
|
||||
|
||||
```
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -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<KMXPlus.KMXPlusFile>;
|
||||
// @internal
|
||||
getUsetParser(): Promise<UnicodeSetParser>;
|
||||
init(callbacks: CompilerCallbacks, options: LdmlCompilerOptions): Promise<boolean>;
|
||||
// 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<LdmlKeyboardCompilerResult>;
|
||||
// @internal
|
||||
validate(source: LDMLKeyboardXMLSourceFile): Promise<boolean>;
|
||||
// Warning: (ae-forgotten-export) The symbol "LdmlKeyboardCompilerArtifacts" needs to be exported by the entry point main.d.ts
|
||||
write(artifacts: LdmlKeyboardCompilerArtifacts): Promise<boolean>;
|
||||
}
|
||||
|
||||
// (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<KMXPlus.KMXPlusFile>;
|
||||
// @internal
|
||||
getUsetParser(): Promise<LdmlKeyboardTypes.UnicodeSetParser>;
|
||||
init(callbacks: CompilerCallbacks, options: LdmlCompilerOptions): Promise<boolean>;
|
||||
// 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<LdmlKeyboardCompilerResult>;
|
||||
// @internal
|
||||
validate(source: LDMLKeyboardXMLSourceFile): Promise<boolean>;
|
||||
// Warning: (ae-forgotten-export) The symbol "LdmlKeyboardCompilerArtifacts" needs to be exported by the entry point main.d.ts
|
||||
write(artifacts: LdmlKeyboardCompilerArtifacts): Promise<boolean>;
|
||||
}
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
|
|
|
|||
|
|
@ -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<boolean>;
|
||||
run(inputFilename: string, outputFilename?: string): Promise<ModelInfoCompilerResult>;
|
||||
write(artifacts: ModelInfoCompilerArtifacts): Promise<boolean>;
|
||||
}
|
||||
|
||||
// @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<boolean>;
|
||||
run(inputFilename: string, outputFilename?: string): Promise<ModelInfoCompilerResult>;
|
||||
write(artifacts: ModelInfoCompilerArtifacts): Promise<boolean>;
|
||||
}
|
||||
|
||||
// @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)
|
||||
|
||||
```
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
/// <reference types="@keymanapp/common-types" />
|
||||
|
||||
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<boolean>;
|
||||
// @internal
|
||||
loadFromFilename(filename: string): LexicalModelSource;
|
||||
run(inputFilename: string, outputFilename?: string): Promise<LexicalModelCompilerResult>;
|
||||
// @internal (undocumented)
|
||||
transpileSources(sources: Array<string>): Array<string>;
|
||||
write(artifacts: LexicalModelCompilerArtifacts): Promise<boolean>;
|
||||
}
|
||||
|
||||
// @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<string>;
|
||||
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<boolean>;
|
||||
// @internal
|
||||
loadFromFilename(filename: string): LexicalModelSource;
|
||||
run(inputFilename: string, outputFilename?: string): Promise<LexicalModelCompilerResult>;
|
||||
// @internal (undocumented)
|
||||
transpileSources(sources: Array<string>): Array<string>;
|
||||
write(artifacts: LexicalModelCompilerArtifacts): Promise<boolean>;
|
||||
}
|
||||
|
||||
// @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<string>;
|
||||
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)
|
||||
|
||||
```
|
||||
|
|
|
|||
|
|
@ -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<Uint8Array>;
|
||||
init(callbacks: CompilerCallbacks, options: KmpCompilerOptions): Promise<boolean>;
|
||||
// @internal (undocumented)
|
||||
loadKpsFile(kpsFilename: string): KpsFile.KpsFile;
|
||||
// (undocumented)
|
||||
readonly normalizePath: (path: string) => string;
|
||||
run(inputFilename: string, outputFilename?: string): Promise<KmpCompilerResult>;
|
||||
// @internal (undocumented)
|
||||
transformKpsFileToKmpObject(kpsFilename: string, kps: KpsFile.KpsFile): KmpJsonFile.KmpJsonFile;
|
||||
// @internal (undocumented)
|
||||
transformKpsToKmpObject(kpsFilename: string): KmpJsonFile.KmpJsonFile;
|
||||
write(artifacts: KmpCompilerArtifacts): Promise<boolean>;
|
||||
}
|
||||
|
||||
// @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<boolean>;
|
||||
run(inputFilename: string, outputFilename?: string): Promise<WindowsPackageInstallerCompilerResult>;
|
||||
write(artifacts: WindowsPackageInstallerCompilerArtifacts): Promise<boolean>;
|
||||
}
|
||||
|
||||
// @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<Uint8Array>;
|
||||
init(callbacks: CompilerCallbacks, options: KmpCompilerOptions): Promise<boolean>;
|
||||
// (undocumented)
|
||||
readonly normalizePath: (path: string) => string;
|
||||
run(inputFilename: string, outputFilename?: string): Promise<KmpCompilerResult>;
|
||||
// @internal (undocumented)
|
||||
transformKpsFileToKmpObject(kpsFilename: string, kps: KpsFile.KpsFile): KmpJsonFile.KmpJsonFile;
|
||||
// @internal (undocumented)
|
||||
transformKpsToKmpObject(kpsFilename: string): KmpJsonFile.KmpJsonFile;
|
||||
write(artifacts: KmpCompilerArtifacts): Promise<boolean>;
|
||||
}
|
||||
|
||||
// @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<boolean>;
|
||||
run(inputFilename: string, outputFilename?: string): Promise<WindowsPackageInstallerCompilerResult>;
|
||||
write(artifacts: WindowsPackageInstallerCompilerArtifacts): Promise<boolean>;
|
||||
}
|
||||
|
||||
// @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)
|
||||
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue