spiegel-keyman/developer/docs/api/etc/kmc-keyboard-info.api.md

API Report File for "@keymanapp/kmc-keyboard-info"

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

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)