spiegel-keyman/developer/docs/api/etc/kmc-generate.api.md

API Report File for "@keymanapp/kmc-generate"

Do not edit this file. It is a report generated by API Extractor.

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)