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

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

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

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)