@keymanapp/developer-utils 18.0.41-alpha → 18.0.118-alpha

package/build/src/common-messages.d.ts

@@ -0,0 +1,49 @@
+export declare class CommonTypesMessages {
+    static ERROR_SchemaValidationError: number;
+    static Error_SchemaValidationError: (o: {
+        instancePath: string;
+        keyword: string;
+        message: string;
+        params: string;
+    }) => import("./compiler-interfaces.js").CompilerEvent;
+    static ERROR_ImportInvalidBase: number;
+    static Error_ImportInvalidBase: (o: {
+        base: string;
+        path: string;
+        subtag: string;
+    }) => import("./compiler-interfaces.js").CompilerEvent;
+    static ERROR_ImportInvalidPath: number;
+    static Error_ImportInvalidPath: (o: {
+        base: string;
+        path: string;
+        subtag: string;
+    }) => import("./compiler-interfaces.js").CompilerEvent;
+    static ERROR_ImportReadFail: number;
+    static Error_ImportReadFail: (o: {
+        base: string;
+        path: string;
+        subtag: string;
+    }) => import("./compiler-interfaces.js").CompilerEvent;
+    static ERROR_ImportWrongRoot: number;
+    static Error_ImportWrongRoot: (o: {
+        base: string;
+        path: string;
+        subtag: string;
+    }) => import("./compiler-interfaces.js").CompilerEvent;
+    static ERROR_ImportMergeFail: number;
+    static Error_ImportMergeFail: (o: {
+        base: string;
+        path: string;
+        subtag: string;
+        subsubtag: string;
+    }) => import("./compiler-interfaces.js").CompilerEvent;
+    static ERROR_TestDataUnexpectedArray: number;
+    static Error_TestDataUnexpectedArray: (o: {
+        subtag: string;
+    }) => import("./compiler-interfaces.js").CompilerEvent;
+    static ERROR_InvalidXml: number;
+    static Error_InvalidXml: (o: {
+        e: any;
+    }) => import("./compiler-interfaces.js").CompilerEvent;
+}
+//# sourceMappingURL=common-messages.d.ts.map

package/build/src/common-messages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common-messages.d.ts","sourceRoot":"","sources":["../../src/common-messages.ts"],"names":[],"mappings":"AAaA,qBAAa,mBAAmB;IAE9B,MAAM,CAAC,2BAA2B,SAAqB;IACvD,MAAM,CAAC,2BAA2B,MAAM;QAAC,YAAY,EAAC,MAAM,CAAC;QAAC,OAAO,EAAC,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAC,sDACK;IAEnH,MAAM,CAAC,uBAAuB,SAAqB;IACnD,MAAM,CAAC,uBAAuB,MAAO;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,sDAE6B;IAEhH,MAAM,CAAC,uBAAuB,SAAqB;IACnD,MAAM,CAAC,uBAAuB,MAAO;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,sDAE+B;IAElH,MAAM,CAAC,oBAAoB,SAAqB;IAChD,MAAM,CAAC,oBAAoB,MAAO;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,sDAEuC;IAEvH,MAAM,CAAC,qBAAqB,SAAqB;IACjD,MAAM,CAAC,qBAAqB,MAAO;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,sDAEK;IAEtF,MAAM,CAAC,qBAAqB,SAAqB;IACjD,MAAM,CAAC,qBAAqB,MAAO;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,sDAEW;IAE/G,MAAM,CAAC,6BAA6B,SAAqB;IACzD,MAAM,CAAC,6BAA6B,MAAO;QAAC,MAAM,EAAE,MAAM,CAAA;KAAC,sDAEgC;IAE3F,MAAM,CAAC,gBAAgB,SAAqB;IAC5C,MAAM,CAAC,gBAAgB,MAAM;QAAC,CAAC,EAAE,GAAG,CAAA;KAAC,sDACiD;CACvF"}

package/build/src/common-messages.js

@@ -0,0 +1,35 @@
+/*
+ * Keyman is copyright (C) SIL International. MIT License.
+ */
+
+!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="409251ef-bdb1-595c-9e1b-30cb7a0a5921")}catch(e){}}();
+import { CompilerErrorNamespace, CompilerErrorSeverity, CompilerMessageDef as def, CompilerMessageSpec as m } from './compiler-interfaces.js';
+import { constants } from '@keymanapp/ldml-keyboard-constants';
+const CommonTypesErrMask = CompilerErrorNamespace.CommonTypes;
+// const SevInfo = CompilerErrorSeverity.Info   | CommonTypesErrMask;
+// const SevHint = CompilerErrorSeverity.Hint   | CommonTypesErrMask;
+// const SevWarn = CompilerErrorSeverity.Warn   | CommonTypesErrMask;
+const SevError = CompilerErrorSeverity.Error | CommonTypesErrMask;
+// const SevFatal = CompilerErrorSeverity.Fatal | CommonTypesErrMask;
+export class CommonTypesMessages {
+    // structured Ajv validation error
+    static ERROR_SchemaValidationError = SevError | 0x0001;
+    static Error_SchemaValidationError = (o) => m(this.ERROR_SchemaValidationError, `Error validating LDML XML file: ${def(o.instancePath)}: ${def(o.keyword)}: ${def(o.message)} ${def(o.params)}`);
+    static ERROR_ImportInvalidBase = SevError | 0x0002;
+    static Error_ImportInvalidBase = (o) => m(this.ERROR_ImportInvalidBase, `Import element with base ${def(o.base)} is unsupported. Only ${constants.cldr_import_base} is supported.`);
+    static ERROR_ImportInvalidPath = SevError | 0x0003;
+    static Error_ImportInvalidPath = (o) => m(this.ERROR_ImportInvalidPath, `Import element with invalid path ${def(o.path)}: expected the form '${constants.cldr_version_latest}/*.xml`);
+    static ERROR_ImportReadFail = SevError | 0x0004;
+    static Error_ImportReadFail = (o) => m(this.ERROR_ImportReadFail, `Import could not read data with path ${def(o.path)}: expected the form '${constants.cldr_version_latest}/*.xml'`);
+    static ERROR_ImportWrongRoot = SevError | 0x0005;
+    static Error_ImportWrongRoot = (o) => m(this.ERROR_ImportWrongRoot, `Invalid import file ${def(o.path)}: expected ${def(o.subtag)} as root element.`);
+    static ERROR_ImportMergeFail = SevError | 0x0006;
+    static Error_ImportMergeFail = (o) => m(this.ERROR_ImportMergeFail, `Problem importing ${def(o.path)}: not sure how to handle non-array ${def(o.subtag)}.${def(o.subsubtag)}`);
+    static ERROR_TestDataUnexpectedArray = SevError | 0x0007;
+    static Error_TestDataUnexpectedArray = (o) => m(this.ERROR_TestDataUnexpectedArray, `Problem reading test data: expected single ${def(o.subtag)} element, found multiple`);
+    static ERROR_InvalidXml = SevError | 0x0008;
+    static Error_InvalidXml = (o) => m(this.ERROR_InvalidXml, `The XML file could not be read: ${(o.e ?? '').toString()}`);
+}
+;
+//# sourceMappingURL=common-messages.js.map
+//# debugId=409251ef-bdb1-595c-9e1b-30cb7a0a5921

package/build/src/common-messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common-messages.js","sources":["../../src/common-messages.ts"],"sourceRoot":"","names":[],"mappings":"AAAA;;GAEG;;;AACH,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAG,kBAAkB,IAAI,GAAG,EAAE,mBAAmB,IAAI,CAAC,EAAE,MAAM,0BAA0B,CAAC;AAC/I,OAAO,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAC;AAE/D,MAAM,kBAAkB,GAAK,sBAAsB,CAAC,WAAW,CAAC;AAChE,qEAAqE;AACrE,qEAAqE;AACrE,qEAAqE;AACrE,MAAM,QAAQ,GAAG,qBAAqB,CAAC,KAAK,GAAG,kBAAkB,CAAC;AAClE,qEAAqE;AAErE,MAAM,OAAO,mBAAmB;IAC9B,kCAAkC;IAClC,MAAM,CAAC,2BAA2B,GAAG,QAAQ,GAAG,MAAM,CAAC;IACvD,MAAM,CAAC,2BAA2B,GAAG,CAAC,CAAwE,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,2BAA2B,EACnJ,mCAAmC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAEnH,MAAM,CAAC,uBAAuB,GAAG,QAAQ,GAAG,MAAM,CAAC;IACnD,MAAM,CAAC,uBAAuB,GAAG,CAAC,CAAiD,EAAE,EAAE,CACrF,CAAC,CAAC,IAAI,CAAC,uBAAuB,EAC5B,4BAA4B,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,yBAAyB,SAAS,CAAC,gBAAgB,gBAAgB,CAAC,CAAC;IAEhH,MAAM,CAAC,uBAAuB,GAAG,QAAQ,GAAG,MAAM,CAAC;IACnD,MAAM,CAAC,uBAAuB,GAAG,CAAC,CAAiD,EAAE,EAAE,CACrF,CAAC,CAAC,IAAI,CAAC,uBAAuB,EAC5B,oCAAoC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,SAAS,CAAC,mBAAmB,QAAQ,CAAC,CAAC;IAElH,MAAM,CAAC,oBAAoB,GAAG,QAAQ,GAAG,MAAM,CAAC;IAChD,MAAM,CAAC,oBAAoB,GAAG,CAAC,CAAiD,EAAE,EAAE,CAClF,CAAC,CAAC,IAAI,CAAC,oBAAoB,EACzB,wCAAwC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,SAAS,CAAC,mBAAmB,SAAS,CAAC,CAAC;IAEvH,MAAM,CAAC,qBAAqB,GAAG,QAAQ,GAAG,MAAM,CAAC;IACjD,MAAM,CAAC,qBAAqB,GAAG,CAAC,CAAiD,EAAE,EAAE,CACnF,CAAC,CAAC,IAAI,CAAC,qBAAqB,EAC1B,uBAAuB,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;IAEtF,MAAM,CAAC,qBAAqB,GAAG,QAAQ,GAAG,MAAM,CAAC;IACjD,MAAM,CAAC,qBAAqB,GAAG,CAAC,CAAoE,EAAE,EAAE,CACtG,CAAC,CAAC,IAAI,CAAC,qBAAqB,EAC1B,qBAAqB,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,sCAAsC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAE/G,MAAM,CAAC,6BAA6B,GAAG,QAAQ,GAAG,MAAM,CAAC;IACzD,MAAM,CAAC,6BAA6B,GAAG,CAAC,CAAmB,EAAE,EAAE,CAC7D,CAAC,CAAC,IAAI,CAAC,6BAA6B,EAClC,8CAA8C,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC;IAE3F,MAAM,CAAC,gBAAgB,GAAG,QAAQ,GAAG,MAAM,CAAC;IAC5C,MAAM,CAAC,gBAAgB,GAAG,CAAC,CAAU,EAAE,EAAE,CACzC,CAAC,CAAC,IAAI,CAAC,gBAAgB,EAAE,mCAAmC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;;AACvF,CAAC","debug_id":"409251ef-bdb1-595c-9e1b-30cb7a0a5921"}

package/build/src/compiler-interfaces.d.ts

@@ -0,0 +1,372 @@
+/**
+ * Abstract interface for compiler error and warning messages
+ */
+export interface CompilerEvent {
+    filename?: string;
+    line?: number;
+    code: number;
+    message: string;
+    /**
+     * detailed Markdown-formatted description of the error including
+     * references to documentation, remediation options.
+     */
+    detail?: string;
+    /**
+     * an internal error occurred that should be captured with a stack trace
+     * e.g. to the Keyman sentry instance by kmc
+     */
+    exceptionVar?: any;
+}
+export declare enum CompilerErrorSeverity {
+    Info = 0,// Informational, not necessarily a problem
+    Hint = 1048576,// Something the user might want to be aware of
+    Warn = 2097152,// Warning: Not great, but we can keep going.
+    Error = 3145728,// Severe error where we can't continue
+    Fatal = 4194304
+}
+export declare const CompilerErrorSeverityValues: CompilerErrorSeverity[];
+/**
+ * Mask values for mapping compiler errors
+ */
+export declare enum CompilerErrorMask {
+    Severity = 15728640,// includes reserved bits, 16 possible severity levels
+    Error = 1048575,// error | namespace
+    Namespace = 1044480,// 256 possible namespaces
+    BaseError = 4095,// error code, 2,048 possible error codes per namespace
+    Reserved = 4278190080
+}
+export declare class CompilerError {
+    static severity(code: number): CompilerErrorSeverity;
+    static error(code: number): number;
+    static baseError(code: number): number;
+    static namespace(code: number): CompilerErrorNamespace;
+    static formatSeverity(code: number): string;
+    /** true if events has at least one message of the atLeast severity */
+    static hasSeverity(events: CompilerEvent[], atLeast: CompilerErrorSeverity): boolean;
+    /** true if events has at least one Error or worse */
+    static hasError(events: CompilerEvent[]): boolean;
+    /**
+     * Format an error code number. The error code number does not include
+     * the severity mask, as this is reported in text form separately; see
+     * `severityName`.
+     * @example
+     *
+     * The following call returns `KM03004`
+     * ```
+     *   formatCode(CompilerMessage.ERROR_InvalidDisplayMapFile)
+     * ```
+     */
+    static formatCode(code: number): string;
+    /**
+     * Formats an event filename for an error report,
+     * stripping off path component
+     * @param filename
+     * @returns
+     */
+    static formatFilename(filename: string, options?: {
+        fullPath?: boolean;
+        forwardSlashes?: boolean;
+    }): string;
+    /**
+     * Formats an event line for an error report
+     * @param line
+     * @returns
+     */
+    static formatLine(line: number): string;
+    /**
+     * Formats an event message for an error report
+     * @param message
+     * @returns
+     */
+    static formatMessage(message: string): string;
+    /**
+     * Formats a compiler message, without coloring; an ANSI color version is
+     * implemented in NodeCompilerCallbacks.
+     * @param event event or array of events
+     */
+    static formatEvent(event: CompilerEvent | CompilerEvent[]): string;
+    /**
+     * @param e Error-like
+     */
+    static exceptionToString(e?: any): string;
+    /**
+     * Returns the corresponding error severity value from a partial name match,
+     * e.g. 'inf' returns CompilerErrorSeverity.Info, or returns null if not found
+     * @param name
+     * @returns
+     */
+    static severityNameToValue(name: string): CompilerErrorSeverity;
+}
+/** @deprecated use `CompilerError.severity` instead */
+export declare function compilerErrorSeverity(code: number): CompilerErrorSeverity;
+/** @deprecated use `CompilerError.formatSeverity` instead */
+export declare function compilerErrorSeverityName(code: number): string;
+/** @deprecated use `CompilerError.formatCode` instead */
+export declare function compilerErrorFormatCode(code: number): string;
+/** @deprecated use `CompilerError.formatEvent` instead */
+export declare function compilerEventFormat(e: CompilerEvent | CompilerEvent[]): string;
+/**
+ * Defines the error code ranges for various compilers. Once defined, these
+ * ranges must not be changed as external modules may depend on specific error
+ * codes. Individual errors are defined at a compiler level, for example,
+ * kmc-ldml/src/compiler/messages.ts.
+ *
+ * kmc defines a mapping between each namespace and the corresponding compiler's
+ * error reporting class in kmc/src/messages/messageNamespaces.ts
+ */
+export declare enum CompilerErrorNamespace {
+    /**
+     * kmc-ldml errors between 0x0000…0x0FFF
+     */
+    LdmlKeyboardCompiler = 0,
+    /**
+     * common/web/types errors between 0x1000…0x1FFF
+     */
+    CommonTypes = 4096,
+    /**
+     * kmc-kmn errors between 0x2000…0x2FFF; these map to
+     * the base codes found in kmn_compiler_errors.h, exclusive severity flags
+     */
+    KmnCompiler = 8192,
+    /**
+     * kmc-model errors between 0x3000…0x3FFF
+     */
+    ModelCompiler = 12288,
+    /**
+     * kmc-package errors between 0x4000…0x4FFF
+     */
+    PackageCompiler = 16384,
+    /**
+     * kmc and related infrastructure errors between 0x5000…0x5FFF
+     */
+    Infrastructure = 20480,
+    /**
+     * kmc-analyze 0x6000…0x6FFF
+     */
+    Analyzer = 24576,
+    /**
+     * kmc-kmn/kmw-compiler errors between 0x7000…0x7FFF; note that some errors
+     * generated by kmc-kmn/kmw-compiler are from kmc-kmn namespace for legacy
+     * reasons
+     */
+    KmwCompiler = 28672,
+    /**
+     * kmc-model-info 0x8000…0x8FFF
+     */
+    ModelInfoCompiler = 32768,
+    /**
+     * kmc-keyboard-info 0x9000…0x9FFF
+     */
+    KeyboardInfoCompiler = 36864
+}
+/**
+ * A mapping for common path operations, maps to Node path module. This only
+ * defines the functions we are actually using, so that we can port more easily
+ * between different systems.
+ */
+export interface CompilerPathCallbacks {
+    dirname(name: string): string;
+    extname(name: string): string;
+    basename(name: string, ext?: string): string;
+    isAbsolute(name: string): boolean;
+    join(...paths: string[]): string;
+    normalize(p: string): string;
+}
+/**
+ * A mapping for common filesystem operations, maps to Node fs module. This only
+ * defines the functions we are actually using, so that we can port more easily
+ * between different systems.
+ */
+export interface CompilerFileSystemCallbacks {
+    readdirSync(name: string): string[];
+    readFileSync(path: string, options?: {
+        encoding?: null;
+        flag?: string;
+    } | null): Uint8Array;
+    readFileSync(path: string, options: {
+        encoding: string;
+        flag?: string;
+    } | string): string;
+    readFileSync(path: string, options?: {
+        encoding?: string | null;
+        flag?: string;
+    } | string | null): string | Uint8Array;
+    writeFileSync(path: string, data: Uint8Array): void;
+    existsSync(name: string): boolean;
+}
+type CompilerErrorSeverityOverride = CompilerErrorSeverity | 'disable';
+export interface CompilerMessageOverrideMap {
+    [code: number]: CompilerErrorSeverityOverride;
+}
+export interface CompilerMessageOverride {
+    code: number;
+    level: CompilerErrorSeverityOverride;
+}
+export interface CompilerCallbackOptions {
+    logLevel?: CompilerLogLevel;
+    logFormat?: CompilerLogFormat;
+    color?: boolean;
+    compilerWarningsAsErrors?: boolean;
+    messageOverrides?: CompilerMessageOverrideMap;
+}
+export interface KeymanCompilerArtifact {
+    data: Uint8Array;
+    filename: string;
+}
+export type KeymanCompilerArtifactOptional = KeymanCompilerArtifact | undefined;
+export interface KeymanCompilerArtifacts {
+    readonly [type: string]: KeymanCompilerArtifactOptional;
+}
+export interface KeymanCompilerResult {
+    artifacts: KeymanCompilerArtifacts;
+}
+export interface KeymanCompiler {
+    init(callbacks: CompilerCallbacks, options: CompilerOptions): Promise<boolean>;
+    /**
+     * Run the compiler, and save the result in memory arrays. Note that while
+     * `outputFilename` is provided here, the output file is not written to in
+     * this function.
+     * @param inputFilename
+     * @param outputFilename The intended output filename, optional, if missing,
+     *                       calculated from inputFilename
+     * @param data
+     */
+    run(inputFilename: string, outputFilename?: string): Promise<KeymanCompilerResult>;
+    /**
+     * Writes the compiled output files to disk
+     * @param artifacts
+     */
+    write(artifacts: KeymanCompilerArtifacts): Promise<boolean>;
+}
+/**
+ * Abstract interface for callbacks, to abstract out file i/o
+ */
+export interface CompilerCallbacks {
+    /**
+     * Attempt to load a file. Return falsy if not found.
+     * TODO: never return falsy, just throw if not found?
+     * @param filename
+     */
+    loadFile(filename: string): Uint8Array;
+    /**
+     * Get file size, returns undefined if not found
+     */
+    fileSize(filename: string): number;
+    get path(): CompilerPathCallbacks;
+    get fs(): CompilerFileSystemCallbacks;
+    /**
+     * Resolves a file path relative to the baseFilename
+     * @param baseFilename
+     * @param filename
+     */
+    resolveFilename(baseFilename: string, filename: string): string;
+    reportMessage(event: CompilerEvent): void;
+    debug(msg: string): void;
+}
+/**
+ * Wrapper class for CompilerCallbacks for a given input file
+ */
+export declare class CompilerFileCallbacks implements CompilerCallbacks {
+    private filename;
+    private options;
+    private parent;
+    messages: CompilerEvent[];
+    constructor(filename: string, options: CompilerCallbackOptions, parent: CompilerCallbacks);
+    /**
+     * Returns `true` if any message in the `messages` array is a Fatal or Error
+     * message, and if `compilerWarningsAsErrors` is `true`, then also returns
+     * `true` if any message is a Warning.
+     */
+    static hasFailureMessage(messages: CompilerEvent[], compilerWarningsAsErrors: boolean): boolean;
+    /**
+     *
+     * @param event
+     * @param overrides
+     * @returns true if event has been suppressed
+     */
+    static applyMessageOverridesToEvent(event: CompilerEvent, overrides: CompilerMessageOverrideMap): boolean;
+    /**
+     * Returns `true` if any message in the `messages` array is a Fatal or Error
+     * message, and if `compilerWarningsAsErrors` is `true`, then also returns
+     * `true` if any message is a Warning.
+     *
+     * If passed a defined `compilerWarningsAsErrors` value, then uses that,
+     * otherwise uses `options.compilerWarningsAsErrors`, or `false` if that is
+     * also `undefined`.
+     */
+    hasFailureMessage(compilerWarningsAsErrors?: boolean): boolean;
+    clear(): void;
+    loadFile(filename: string): Uint8Array;
+    fileSize(filename: string): number;
+    get path(): CompilerPathCallbacks;
+    get fs(): CompilerFileSystemCallbacks;
+    resolveFilename(baseFilename: string, filename: string): string;
+    reportMessage(event: CompilerEvent): void;
+    debug(msg: string): void;
+}
+/**
+ * Abstract interface for compiler options
+ */
+export interface CompilerBaseOptions {
+    /**
+     * Reporting level to console, used by NodeCompilerCallbacks (not used in compiler modules;
+     * all messages are still reported to the internal log)
+     */
+    logLevel?: CompilerLogLevel;
+    /**
+     * Format of output for log to console
+     */
+    logFormat?: CompilerLogFormat;
+    /**
+     * Colorize log output, default is detected from console
+     */
+    color?: boolean;
+}
+export interface CompilerOptions extends CompilerBaseOptions {
+    /**
+     * Add metadata about the compiler version to .kmx file when compiling
+     */
+    shouldAddCompilerVersion?: boolean;
+    /**
+     * Add debug information to the .kmx file when compiling
+     */
+    saveDebug?: boolean;
+    /**
+     * Upgrade any warnings produced in the compile to errors
+     */
+    compilerWarningsAsErrors?: boolean;
+    /**
+     * Emit warnings if deprecated code is encountered
+     */
+    warnDeprecatedCode?: boolean;
+    /**
+     * Check filename conventions in packages
+     */
+    checkFilenameConventions?: boolean;
+}
+export declare const defaultCompilerOptions: CompilerOptions;
+/**
+ * Convenience function for constructing CompilerEvents
+ * @param code     Unique numeric value of the event
+ * @param message  A short description of the error presented to the user
+ * @param detail   Detailed Markdown-formatted description of the error
+ *                 including references to documentation, remediation options.
+ * @returns
+ */
+export declare const CompilerMessageSpec: (code: number, message: string, detail?: string) => CompilerEvent;
+export declare const CompilerMessageDef: (param: any) => string;
+export declare const CompilerMessageSpecWithException: (code: number, message: string, exceptionVar: any, detail?: string) => CompilerEvent;
+/**
+ * Compiler logging level and correspondence to severity
+ */
+export declare const ALL_COMPILER_LOG_LEVELS: readonly ["silent", "error", "warn", "hint", "info", "debug"];
+type CompilerLogLevelTuple = typeof ALL_COMPILER_LOG_LEVELS;
+export type CompilerLogLevel = CompilerLogLevelTuple[number];
+export declare const compilerLogLevelToSeverity: {
+    [index in CompilerLogLevel]: number;
+};
+export declare const ALL_COMPILER_LOG_FORMATS: readonly ["tsv", "formatted"];
+type CompilerLogFormatTuple = typeof ALL_COMPILER_LOG_FORMATS;
+export type CompilerLogFormat = CompilerLogFormatTuple[number];
+export {};
+//# sourceMappingURL=compiler-interfaces.d.ts.map

package/build/src/compiler-interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compiler-interfaces.d.ts","sourceRoot":"","sources":["../../src/compiler-interfaces.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,YAAY,CAAC,EAAE,GAAG,CAAC;CACpB;AAED,oBAAY,qBAAqB;IAC/B,IAAI,IAAoB,CAAE,2CAA2C;IACrE,IAAI,UAAoB,CAAE,+CAA+C;IACzE,IAAI,UAAoB,CAAE,6CAA6C;IACvE,KAAK,UAAmB,CAAE,uCAAuC;IACjE,KAAK,UAAmB;CACzB;AAED,eAAO,MAAM,2BAA2B,yBAMvC,CAAA;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,QAAQ,WAAc,CAAG,sDAAsD;IAC/E,KAAK,UAAiB,CAAG,oBAAoB;IAC7C,SAAS,UAAa,CAAG,0BAA0B;IACnD,SAAS,OAAa,CAAG,uDAAuD;IAChF,QAAQ,aAAc;CACvB;AAUD,qBAAa,aAAa;IACxB,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB;IAGpD,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAGlC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAGtC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,sBAAsB;IAGtD,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAG3C,sEAAsE;IACtE,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,aAAa,EAAE,EAAE,OAAO,EAAE,qBAAqB,GAAG,OAAO;IAQpF,qDAAqD;IACrD,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,aAAa,EAAE,GAAG,OAAO;IAGjD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAIvC;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAChD,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,cAAc,CAAC,EAAE,OAAO,CAAA;KACzB,GAAG,MAAM;IAkBV;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAIvC;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAI7C;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,KAAK,EAAG,aAAa,GAAG,aAAa,EAAE,GAAG,MAAM;IAmBnE;;OAEG;IACH,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,GAAG,GAAI,MAAM;IAI1C;;;;;OAKG;IACH,MAAM,CAAC,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB;CAShE;AAED,uDAAuD;AACvD,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,CAEzE;AAED,6DAA6D;AAC7D,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE9D;AAED,yDAAyD;AACzD,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE5D;AAED,0DAA0D;AAC1D,wBAAgB,mBAAmB,CAAC,CAAC,EAAG,aAAa,GAAG,aAAa,EAAE,GAAI,MAAM,CAEhF;AAED;;;;;;;;GAQG;AACH,oBAAY,sBAAsB;IAChC;;OAEG;IACH,oBAAoB,IAAS;IAC7B;;OAEG;IACH,WAAW,OAAS;IACpB;;;OAGG;IACH,WAAW,OAAS;IACpB;;OAEG;IACH,aAAa,QAAS;IACtB;;OAEG;IACH,eAAe,QAAS;IACxB;;OAEG;IACH,cAAc,QAAS;IACvB;;OAEG;IACH,QAAQ,QAAS;IACjB;;;;OAIG;IACH,WAAW,QAAS;IACpB;;OAEG;IACH,iBAAiB,QAAS;IAC1B;;OAEG;IACH,oBAAoB,QAAS;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7C,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAClC,IAAI,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IACjC,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACpC,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,IAAI,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;KAAE,GAAG,IAAI,GAAG,UAAU,CAAC;IAC7F,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;KAAE,GAAG,MAAM,GAAG,MAAM,CAAC;IAC3F,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;KAAE,GAAG,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,UAAU,CAAC;IACxH,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,IAAI,CAAC;IAEpD,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;CACnC;AAED,KAAK,6BAA6B,GAAG,qBAAqB,GAAG,SAAS,CAAC;AACvE,MAAM,WAAW,0BAA0B;IACzC,CAAC,IAAI,EAAC,MAAM,GAAG,6BAA6B,CAAC;CAC9C;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,6BAA6B,CAAC;CACtC;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,gBAAgB,CAAC,EAAE,0BAA0B,CAAC;CAC/C;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,8BAA8B,GAAG,sBAAsB,GAAG,SAAS,CAAC;AAEhF,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,IAAI,EAAC,MAAM,GAAG,8BAA8B,CAAC;CACxD;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,uBAAuB,CAAC;CACpC;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,SAAS,EAAE,iBAAiB,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/E;;;;;;;;OAQG;IACH,GAAG,CAAC,aAAa,EAAC,MAAM,EAAE,cAAc,CAAC,EAAC,MAAM,GAAoB,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAClG;;;OAGG;IACH,KAAK,CAAC,SAAS,EAAE,uBAAuB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAEnC,IAAI,IAAI,IAAI,qBAAqB,CAAC;IAClC,IAAI,EAAE,IAAI,2BAA2B,CAAC;IAEtC;;;;OAIG;IACH,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAEhE,aAAa,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;IAE1C,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,qBAAsB,YAAW,iBAAiB;IAGjD,OAAO,CAAC,QAAQ;IAAU,OAAO,CAAC,OAAO;IAA2B,OAAO,CAAC,MAAM;IAF9F,QAAQ,EAAE,aAAa,EAAE,CAAM;gBAEX,QAAQ,EAAE,MAAM,EAAU,OAAO,EAAE,uBAAuB,EAAU,MAAM,EAAE,iBAAiB;IAGjH;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,CAAC,QAAQ,EAAE,aAAa,EAAE,EAAE,wBAAwB,EAAE,OAAO;IAOrF;;;;;OAKG;IACH,MAAM,CAAC,4BAA4B,CAAC,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,0BAA0B;IAgB/F;;;;;;;;OAQG;IACH,iBAAiB,CAAC,wBAAwB,CAAC,EAAE,OAAO;IAOpD,KAAK;IAIL,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU;IAItC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAIlC,IAAI,IAAI,IAAI,qBAAqB,CAEhC;IAED,IAAI,EAAE,IAAI,2BAA2B,CAEpC;IAED,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;IAI/D,aAAa,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI;IAQzC,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;CAGzB;AAED;;GAEG;AAEH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B;;OAEG;IACH,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,eAAgB,SAAQ,mBAAmB;IAC1D;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;OAEG;IACJ,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACpC;AAED,eAAO,MAAM,sBAAsB,EAAE,eASpC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,SAAU,MAAM,WAAW,MAAM,WAAW,MAAM,KAAI,aAIpF,CAAC;AAEH,eAAO,MAAM,kBAAkB,UAAW,GAAG,WAA+B,CAAC;AAE7E,eAAO,MAAM,gCAAgC,SAAU,MAAM,WAAW,MAAM,gBAAgB,GAAG,WAAW,MAAM,KAAI,aAOpH,CAAC;AAEH;;GAEG;AAEH,eAAO,MAAM,uBAAuB,+DAO1B,CAAC;AAEX,KAAK,qBAAqB,GAAG,OAAO,uBAAuB,CAAC;AAC5D,MAAM,MAAM,gBAAgB,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;AAE7D,eAAO,MAAM,0BAA0B,EAAE;KAAE,KAAK,IAAI,gBAAgB,GAAG,MAAM;CAO5E,CAAC;AAEF,eAAO,MAAM,wBAAwB,+BAG3B,CAAC;AAEX,KAAK,sBAAsB,GAAG,OAAO,wBAAwB,CAAC;AAC9D,MAAM,MAAM,iBAAiB,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC"}