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

package/build/src/types/kpj/keyman-developer-project.js

@@ -0,0 +1,197 @@
+//
+// Version 1.0 and 2.0 of Keyman Developer Project .kpj file
+//
+
+!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]="f5f9e7bb-a463-5cb7-9f2c-8a63df7a8c69")}catch(e){}}();
+import { KeymanFileTypes } from '@keymanapp/common-types';
+export class KeymanDeveloperProject {
+    _projectFilename;
+    callbacks;
+    options;
+    files;
+    projectPath = '';
+    projectFile;
+    get projectFilename() {
+        return this._projectFilename;
+    }
+    constructor(_projectFilename, version, callbacks) {
+        this._projectFilename = _projectFilename;
+        this.callbacks = callbacks;
+        this.projectPath = this.callbacks.path.dirname(this._projectFilename);
+        this.options = new KeymanDeveloperProjectOptions(version);
+        this.files = [];
+        this.projectFile = new KeymanDeveloperProjectFile20(_projectFilename, callbacks);
+    }
+    /**
+     * Adds .kmn, .xml, .kps to project based on options.sourcePath
+     * @param projectFilename Full path to project.kpj (even if the file doesn't exist)
+     */
+    populateFiles() {
+        if (this.options.version != '2.0') {
+            throw new Error('populateFiles can only be called on a v2.0 project');
+        }
+        const sourcePath = this.resolveProjectPath(this.options.sourcePath);
+        if (!this.callbacks.fs.existsSync(sourcePath)) {
+            return false;
+        }
+        const files = this.callbacks.fs.readdirSync(sourcePath);
+        for (const filename of files) {
+            const fullPath = this.callbacks.path.join(sourcePath, filename);
+            if (KeymanFileTypes.filenameIs(filename, ".xml" /* KeymanFileTypes.Source.LdmlKeyboard */)) {
+                try {
+                    const data = this.callbacks.loadFile(fullPath);
+                    const text = new TextDecoder().decode(data);
+                    if (!text?.match(/<keyboard3/)) {
+                        // Skip this .xml because we assume it isn't really a keyboard .xml
+                        continue;
+                    }
+                }
+                catch (e) {
+                    // We'll just silently skip this file because we were not able to load it,
+                    // so let's hope it wasn't a real LDML keyboard XML :-)
+                    continue;
+                }
+            }
+            if (KeymanFileTypes.sourceTypeFromFilename(filename) !== null) {
+                const file = new KeymanDeveloperProjectFile20(fullPath, this.callbacks);
+                this.files.push(file);
+            }
+        }
+        return this.files.length > 0;
+    }
+    isKeyboardProject() {
+        return !!this.files.find(file => file.fileType == ".kmn" /* KeymanFileTypes.Source.KeymanKeyboard */ || file.fileType == ".xml" /* KeymanFileTypes.Source.LdmlKeyboard */);
+    }
+    isLexicalModelProject() {
+        return !!this.files.find(file => file.fileType == ".model.ts" /* KeymanFileTypes.Source.Model */);
+    }
+    resolveProjectPath(p) {
+        // Replace placeholders in the target path
+        return p.replace('$PROJECTPATH', this.projectPath);
+    }
+    getOutputFilePath(type) {
+        // Roughly corresponds to Delphi TProject.GetTargetFileName
+        let p = this.options.version == '1.0' ?
+            this.options.buildPath || '$SOURCEPATH' :
+            this.options.buildPath;
+        // Replace placeholders in the target path
+        if (this.options.version == '1.0') {
+            // TODO: do we need to support $VERSION?
+            // $SOURCEPATH only supported in 1.0 projects
+            p = p.replace('$SOURCEPATH', this.callbacks.path.dirname(this._projectFilename));
+        }
+        p = this.resolveProjectPath(p);
+        const f = this.callbacks.path.basename(this._projectFilename, ".kpj" /* KeymanFileTypes.Source.Project */) + type;
+        return this.callbacks.path.normalize(this.callbacks.path.join(p, f));
+    }
+    resolveInputFilePath(file) {
+        return this.callbacks.resolveFilename(this._projectFilename, file.filePath);
+    }
+    resolveOutputFilePath(file, sourceExt, targetExt) {
+        // Roughly corresponds to Delphi TProject.GetTargetFileName
+        let p = this.options.version == '1.0' ?
+            this.options.buildPath || '$SOURCEPATH' :
+            this.options.buildPath;
+        // Replace placeholders in the target path
+        if (this.options.version == '1.0') {
+            // TODO: do we need to support $VERSION?
+            // $SOURCEPATH only supported in 1.0 projects
+            p = p.replace('$SOURCEPATH', this.callbacks.path.dirname(this.resolveInputFilePath(file)));
+        }
+        p = this.resolveProjectPath(p);
+        const f = file.filename.replace(new RegExp(`\\${sourceExt}$`, 'i'), targetExt);
+        return this.callbacks.path.normalize(this.callbacks.path.join(p, f));
+    }
+}
+;
+export var KeymanDeveloperProjectType;
+(function (KeymanDeveloperProjectType) {
+    KeymanDeveloperProjectType[KeymanDeveloperProjectType["Keyboard"] = 0] = "Keyboard";
+    KeymanDeveloperProjectType[KeymanDeveloperProjectType["LexicalModel"] = 1] = "LexicalModel";
+})(KeymanDeveloperProjectType || (KeymanDeveloperProjectType = {}));
+;
+export class KeymanDeveloperProjectOptions {
+    buildPath;
+    sourcePath;
+    compilerWarningsAsErrors = false;
+    warnDeprecatedCode = true;
+    checkFilenameConventions = false; // missing option defaults to False
+    /**
+     * Skip building .keyboard_info and .model_info files, for example in
+     * unit tests or for legacy keyboards
+     */
+    skipMetadataFiles;
+    projectType = KeymanDeveloperProjectType.Keyboard;
+    version;
+    constructor(version) {
+        this.version = version;
+        switch (version) {
+            case "1.0":
+                this.buildPath = '';
+                this.sourcePath = '';
+                this.skipMetadataFiles = true;
+                break;
+            case "2.0":
+                this.buildPath = '$PROJECTPATH/build';
+                this.sourcePath = '$PROJECTPATH/source';
+                this.skipMetadataFiles = false;
+                break;
+            default:
+                throw new Error('Invalid version');
+        }
+    }
+}
+;
+;
+export class KeymanDeveloperProjectFile10 {
+    id;
+    filePath;
+    fileVersion;
+    callbacks;
+    get filename() {
+        return this.callbacks.path.basename(this.filePath);
+    }
+    get fileType() {
+        return KeymanFileTypes.fromFilename(this.filename);
+    }
+    details; // 1.0 only
+    childFiles; // 1.0 only
+    constructor(id, filePath, fileVersion, callbacks) {
+        this.id = id;
+        this.filePath = filePath;
+        this.fileVersion = fileVersion;
+        this.callbacks = callbacks;
+        this.details = {};
+        this.childFiles = [];
+    }
+}
+;
+export class KeymanDeveloperProjectFile20 {
+    filePath;
+    callbacks;
+    get filename() {
+        return this.callbacks.path.basename(this.filePath);
+    }
+    get fileType() {
+        return KeymanFileTypes.fromFilename(this.filename);
+    }
+    constructor(filePath, callbacks) {
+        this.filePath = filePath;
+        this.callbacks = callbacks;
+    }
+}
+;
+export class KeymanDeveloperProjectFileDetail_Kps {
+    name;
+    copyright;
+    version;
+}
+;
+export class KeymanDeveloperProjectFileDetail_Kmn {
+    name;
+    copyright;
+    message;
+}
+;
+//# sourceMappingURL=keyman-developer-project.js.map
+//# debugId=f5f9e7bb-a463-5cb7-9f2c-8a63df7a8c69

package/build/src/types/kpj/keyman-developer-project.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyman-developer-project.js","sources":["../../../../src/types/kpj/keyman-developer-project.ts"],"sourceRoot":"","names":[],"mappings":"AAAA,EAAE;AACF,4DAA4D;AAC5D,EAAE;;;AAEF,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAG1D,MAAM,OAAO,sBAAsB;IAUb;IAA0E;IAT9F,OAAO,CAAgC;IACvC,KAAK,CAA+B;IACpC,WAAW,GAAW,EAAE,CAAC;IAChB,WAAW,CAA6B;IAEjD,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED,YAAoB,gBAAwB,EAAE,OAAsC,EAAU,SAA4B;QAAtG,qBAAgB,GAAhB,gBAAgB,CAAQ;QAAkD,cAAS,GAAT,SAAS,CAAmB;QACxH,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACtE,IAAI,CAAC,OAAO,GAAG,IAAI,6BAA6B,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC,WAAW,GAAG,IAAI,4BAA4B,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAC;IACnF,CAAC;IACD;;;OAGG;IACH,aAAa;QACX,IAAG,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,KAAK,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACxE,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACpE,IAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAC7C,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QACxD,KAAI,MAAM,QAAQ,IAAI,KAAK,EAAE,CAAC;YAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YAChE,IAAG,eAAe,CAAC,UAAU,CAAC,QAAQ,mDAAsC,EAAE,CAAC;gBAC7E,IAAI,CAAC;oBACH,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBAC/C,MAAM,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;oBAC5C,IAAG,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;wBAC9B,mEAAmE;wBACnE,SAAS;oBACX,CAAC;gBACH,CAAC;gBAAC,OAAM,CAAC,EAAE,CAAC;oBACV,0EAA0E;oBAC1E,uDAAuD;oBACvD,SAAS;gBACX,CAAC;YACH,CAAC;YACD,IAAG,eAAe,CAAC,sBAAsB,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE,CAAC;gBAC7D,MAAM,IAAI,GAAG,IAAI,4BAA4B,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;gBACxE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxB,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IAC/B,CAAC;IAEM,iBAAiB;QACtB,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,sDAAyC,IAAI,IAAI,CAAC,QAAQ,oDAAuC,CAAC,CAAC;IACnJ,CAAC;IAEM,qBAAqB;QAC1B,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,kDAAgC,CAAC,CAAC;IAClF,CAAC;IAEO,kBAAkB,CAAC,CAAS;QAClC,0CAA0C;QAC1C,OAAO,CAAC,CAAC,OAAO,CAAC,cAAc,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACrD,CAAC;IAED,iBAAiB,CAAC,IAA4B;QAC5C,2DAA2D;QAC3D,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC,CAAC;YACrC,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,aAAa,CAAC,CAAC;YACzC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;QAEzB,0CAA0C;QAC1C,IAAG,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,KAAK,EAAE,CAAC;YACjC,wCAAwC;YACxC,6CAA6C;YAC7C,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;QACnF,CAAC;QAED,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;QAE/B,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,8CAAiC,GAAG,IAAI,CAAC;QACrG,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACvE,CAAC;IAED,oBAAoB,CAAC,IAAgC;QACnD,OAAO,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9E,CAAC;IAED,qBAAqB,CAAC,IAAgC,EAAE,SAAiB,EAAE,SAAiB;QAC1F,2DAA2D;QAC3D,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC,CAAC;YACrC,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,aAAa,CAAC,CAAC;YACzC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;QAEzB,0CAA0C;QAC1C,IAAG,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,KAAK,EAAE,CAAC;YACjC,wCAAwC;YACxC,6CAA6C;YAC7C,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC7F,CAAC;QAED,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;QAE/B,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,KAAK,SAAS,GAAG,EAAE,GAAG,CAAC,EAAE,SAAS,CAAC,CAAC;QAC/E,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACvE,CAAC;CAEF;AAAA,CAAC;AAEF,MAAM,CAAN,IAAY,0BAGX;AAHD,WAAY,0BAA0B;IACpC,mFAAQ,CAAA;IACR,2FAAY,CAAA;AACd,CAAC,EAHW,0BAA0B,KAA1B,0BAA0B,QAGrC;AAAA,CAAC;AAMF,MAAM,OAAO,6BAA6B;IACxC,SAAS,CAAS;IAClB,UAAU,CAAS;IACnB,wBAAwB,GAAY,KAAK,CAAC;IAC1C,kBAAkB,GAAY,IAAI,CAAC;IACnC,wBAAwB,GAAY,KAAK,CAAC,CAAE,mCAAmC;IAC/E;;;OAGG;IACH,iBAAiB,CAAU;IAC3B,WAAW,GAA+B,0BAA0B,CAAC,QAAQ,CAAC;IACrE,OAAO,CAAgC;IAChD,YAAY,OAAsC;QAChD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,QAAO,OAAO,EAAE,CAAC;YACf,KAAK,KAAK;gBACR,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;gBACpB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;gBACrB,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;gBAC9B,MAAM;YACR,KAAK,KAAK;gBACR,IAAI,CAAC,SAAS,GAAG,oBAAoB,CAAC;gBACtC,IAAI,CAAC,UAAU,GAAG,qBAAqB,CAAC;gBACxC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;gBAC/B,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;CACF;AAAA,CAAC;AAMD,CAAC;AAEF,MAAM,OAAO,4BAA4B;IAUX;IAA4B;IAAkC;IAAqC;IAT/H,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACrD,CAAC;IACD,IAAI,QAAQ;QACV,OAAO,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,CAA8E,CAAC,WAAW;IACjG,UAAU,CAA+B,CAAC,WAAW;IAErD,YAA4B,EAAU,EAAkB,QAAgB,EAAkB,WAAkB,EAAmB,SAA4B;QAA/H,OAAE,GAAF,EAAE,CAAQ;QAAkB,aAAQ,GAAR,QAAQ,CAAQ;QAAkB,gBAAW,GAAX,WAAW,CAAO;QAAmB,cAAS,GAAT,SAAS,CAAmB;QACzJ,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;IACvB,CAAC;CACF;AAAA,CAAC;AAIF,MAAM,OAAO,4BAA4B;IAOX;IAAmC;IAN/D,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACrD,CAAC;IACD,IAAI,QAAQ;QACV,OAAO,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACrD,CAAC;IACD,YAA4B,QAAgB,EAAmB,SAA4B;QAA/D,aAAQ,GAAR,QAAQ,CAAQ;QAAmB,cAAS,GAAT,SAAS,CAAmB;IAC3F,CAAC;CACF;AAAA,CAAC;AAEF,MAAM,OAAO,oCAAoC;IAC/C,IAAI,CAAU;IACd,SAAS,CAAU;IACnB,OAAO,CAAU;CAClB;AAAA,CAAC;AAEF,MAAM,OAAO,oCAAoC;IAC/C,IAAI,CAAU;IACd,SAAS,CAAU;IACnB,OAAO,CAAU;CAClB;AAAA,CAAC","debug_id":"f5f9e7bb-a463-5cb7-9f2c-8a63df7a8c69"}

package/build/src/types/kpj/kpj-file-reader.d.ts

@@ -0,0 +1,19 @@
+import { KPJFile } from './kpj-file.js';
+import { KeymanDeveloperProject } from './keyman-developer-project.js';
+import { CompilerCallbacks } from '../../compiler-interfaces.js';
+export declare class KPJFileReader {
+    private callbacks;
+    constructor(callbacks: CompilerCallbacks);
+    read(file: Uint8Array): KPJFile;
+    validate(source: KPJFile): void;
+    private boolFromString;
+    transform(projectFilename: string, source: KPJFile): KeymanDeveloperProject;
+    private transformFilesVersion10;
+    /**
+     * xml2js will not place single-entry objects into arrays.
+     * Easiest way to fix this is to box them ourselves as needed
+     * @param source KVKSourceFile
+     */
+    private boxArrays;
+}
+//# sourceMappingURL=kpj-file-reader.d.ts.map

package/build/src/types/kpj/kpj-file-reader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kpj-file-reader.d.ts","sourceRoot":"","sources":["../../../../src/types/kpj/kpj-file-reader.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAkB,MAAM,eAAe,CAAC;AAExD,OAAO,EAAE,sBAAsB,EAA4D,MAAM,+BAA+B,CAAC;AAEjI,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAEjE,qBAAa,aAAa;IACZ,OAAO,CAAC,SAAS;gBAAT,SAAS,EAAE,iBAAiB;IAIzC,IAAI,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO;IA6B/B,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI;IAUtC,OAAO,CAAC,cAAc;IAOf,SAAS,CAAC,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAG,sBAAsB;IA+BlF,OAAO,CAAC,uBAAuB;IAwB/B;;;;OAIG;IACH,OAAO,CAAC,SAAS;CAUlB"}

package/build/src/types/kpj/kpj-file-reader.js

@@ -0,0 +1,121 @@
+
+!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]="4b33628b-8dd7-5580-b803-00a4660d8c89")}catch(e){}}();
+import { xml2js } from '../../index.js';
+import { util } from '@keymanapp/common-types';
+import { KeymanDeveloperProject, KeymanDeveloperProjectFile10, KeymanDeveloperProjectType } from './keyman-developer-project.js';
+import { SchemaValidators } from '@keymanapp/common-types';
+export class KPJFileReader {
+    callbacks;
+    constructor(callbacks) {
+        this.callbacks = callbacks;
+    }
+    read(file) {
+        let data;
+        const parser = new xml2js.Parser({
+            explicitArray: false,
+            mergeAttrs: false,
+            includeWhiteChars: false,
+            normalize: false,
+            emptyTag: ''
+        });
+        parser.parseString(file, (e, r) => {
+            if (e) {
+                throw e;
+            }
+            data = r;
+        });
+        data = this.boxArrays(data);
+        if (data.KeymanDeveloperProject?.Files?.File?.length) {
+            for (const file of data.KeymanDeveloperProject?.Files?.File) {
+                // xml2js imports <Details/> as '' so we will just delete the empty string
+                if (typeof file.Details == 'string') {
+                    delete file.Details;
+                }
+            }
+        }
+        return data;
+    }
+    validate(source) {
+        if (!SchemaValidators.default.kpj(source)) {
+            if (!SchemaValidators.default.kpj90(source)) {
+                // If the legacy schema also does not validate, then we will only report
+                // the errors against the modern schema
+                throw new Error(JSON.stringify(SchemaValidators.default.kpj.errors));
+            }
+        }
+    }
+    boolFromString(value, def) {
+        value = (value || '').toLowerCase();
+        if (value === 'true')
+            return true;
+        if (value === 'false')
+            return false;
+        return def;
+    }
+    transform(projectFilename, source) {
+        // NOTE: at this point, the xml should have been validated
+        // and matched the schema result so we can assume the source
+        // is a valid shape
+        const project = source.KeymanDeveloperProject;
+        const result = new KeymanDeveloperProject(projectFilename, project.Options?.Version || "1.0", this.callbacks);
+        if (result.options.version == '2.0') {
+            result.options.buildPath = (project.Options?.BuildPath || result.options.buildPath).replace(/\\/g, '/');
+            result.options.sourcePath = (project.Options?.SourcePath || result.options.sourcePath).replace(/\\/g, '/');
+            result.options.skipMetadataFiles = this.boolFromString(project.Options?.SkipMetadataFiles, false);
+        }
+        else {
+            result.options.buildPath = (project.Options?.BuildPath || '').replace(/\\/g, '/');
+            result.options.skipMetadataFiles = this.boolFromString(project.Options?.SkipMetadataFiles, true);
+        }
+        result.options.checkFilenameConventions = this.boolFromString(project.Options?.CheckFilenameConventions, false);
+        result.options.compilerWarningsAsErrors = this.boolFromString(project.Options?.CompilerWarningsAsErrors, false);
+        result.options.warnDeprecatedCode = this.boolFromString(project.Options?.WarnDeprecatedCode, true);
+        result.options.projectType =
+            project.Options?.ProjectType == 'keyboard' ? KeymanDeveloperProjectType.Keyboard :
+                project.Options?.ProjectType == 'lexicalmodel' ? KeymanDeveloperProjectType.LexicalModel :
+                    KeymanDeveloperProjectType.Keyboard; // Default is keyboard if missing
+        if (result.options.version == '1.0') {
+            this.transformFilesVersion10(project, result);
+        }
+        else {
+            result.populateFiles();
+        }
+        return result;
+    }
+    transformFilesVersion10(project, result) {
+        const ids = {};
+        for (const sourceFile of project.Files?.File) {
+            const file = new KeymanDeveloperProjectFile10(sourceFile.ID || '', (sourceFile.Filepath || '').replace(/\\/g, '/'), sourceFile.FileVersion || '', this.callbacks);
+            if (sourceFile.Details) {
+                file.details.copyright = sourceFile.Details.Copyright;
+                file.details.name = sourceFile.Details.Name;
+                file.details.message = sourceFile.Details.Message;
+                file.details.version = sourceFile.Details.Version;
+            }
+            if (sourceFile.ParentFileID && ids[sourceFile.ParentFileID]) {
+                ids[sourceFile.ParentFileID].childFiles.push(file);
+            }
+            else {
+                result.files.push(file);
+                ids[file.id] = file;
+            }
+        }
+    }
+    /**
+     * xml2js will not place single-entry objects into arrays.
+     * Easiest way to fix this is to box them ourselves as needed
+     * @param source KVKSourceFile
+     */
+    boxArrays(source) {
+        if (!source.KeymanDeveloperProject) {
+            return source;
+        }
+        if (!source.KeymanDeveloperProject.Files || typeof source.KeymanDeveloperProject.Files == 'string') {
+            source.KeymanDeveloperProject.Files = { File: [] };
+        }
+        util.boxXmlArray(source.KeymanDeveloperProject.Files, 'File');
+        return source;
+    }
+}
+//# sourceMappingURL=kpj-file-reader.js.map
+//# debugId=4b33628b-8dd7-5580-b803-00a4660d8c89

package/build/src/types/kpj/kpj-file-reader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"kpj-file-reader.js","sources":["../../../../src/types/kpj/kpj-file-reader.ts"],"sourceRoot":"","names":[],"mappings":";;AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,OAAO,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAC/C,OAAO,EAAE,sBAAsB,EAAE,4BAA4B,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AACjI,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAG3D,MAAM,OAAO,aAAa;IACJ;IAApB,YAAoB,SAA4B;QAA5B,cAAS,GAAT,SAAS,CAAmB;IAEhD,CAAC;IAEM,IAAI,CAAC,IAAgB;QAC1B,IAAI,IAAa,CAAC;QAElB,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC;YAC/B,aAAa,EAAE,KAAK;YACpB,UAAU,EAAE,KAAK;YACjB,iBAAiB,EAAE,KAAK;YACxB,SAAS,EAAE,KAAK;YAChB,QAAQ,EAAE,EAAE;SACb,CAAC,CAAC;QAEH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAU,EAAE,CAAU,EAAE,EAAE;YAClD,IAAG,CAAC,EAAE,CAAC;gBACL,MAAM,CAAC,CAAC;YACV,CAAC;YACD,IAAI,GAAG,CAAY,CAAC;QACtB,CAAC,CAAC,CAAC;QACH,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAG,IAAI,CAAC,sBAAsB,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YACpD,KAAI,MAAM,IAAI,IAAI,IAAI,CAAC,sBAAsB,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;gBAC3D,0EAA0E;gBAC1E,IAAG,OAAO,IAAI,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC;oBACnC,OAAO,IAAI,CAAC,OAAO,CAAC;gBACtB,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,IAAe,CAAC;IACzB,CAAC;IAEM,QAAQ,CAAC,MAAe;QAC7B,IAAG,CAAC,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACzC,IAAG,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3C,wEAAwE;gBACxE,uCAAuC;gBACvC,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAO,gBAAgB,CAAC,OAAO,CAAC,GAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YAC9E,CAAC;QACH,CAAC;IACH,CAAC;IAEO,cAAc,CAAC,KAAa,EAAE,GAAY;QAChD,KAAK,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QACpC,IAAG,KAAK,KAAK,MAAM;YAAE,OAAO,IAAI,CAAC;QACjC,IAAG,KAAK,KAAK,OAAO;YAAE,OAAO,KAAK,CAAC;QACnC,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,SAAS,CAAC,eAAuB,EAAE,MAAe;QACvD,0DAA0D;QAC1D,4DAA4D;QAC5D,mBAAmB;QACnB,MAAM,OAAO,GAAG,MAAM,CAAC,sBAAsB,CAAC;QAC9C,MAAM,MAAM,GAA2B,IAAI,sBAAsB,CAAC,eAAe,EAAE,OAAO,CAAC,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACtI,IAAG,MAAM,CAAC,OAAO,CAAC,OAAO,IAAI,KAAK,EAAE,CAAC;YACnC,MAAM,CAAC,OAAO,CAAC,SAAS,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YACxG,MAAM,CAAC,OAAO,CAAC,UAAU,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,UAAU,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YAC3G,MAAM,CAAC,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,EAAE,iBAAiB,EAAE,KAAK,CAAC,CAAC;QACpG,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,OAAO,CAAC,SAAS,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YAClF,MAAM,CAAC,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QACnG,CAAC;QACD,MAAM,CAAC,OAAO,CAAC,wBAAwB,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,EAAE,wBAAwB,EAAE,KAAK,CAAC,CAAC;QAChH,MAAM,CAAC,OAAO,CAAC,wBAAwB,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,EAAE,wBAAwB,EAAE,KAAK,CAAC,CAAC;QAChH,MAAM,CAAC,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,EAAE,kBAAkB,EAAE,IAAI,CAAC,CAAC;QACnG,MAAM,CAAC,OAAO,CAAC,WAAW;YACxB,OAAO,CAAC,OAAO,EAAE,WAAW,IAAI,UAAU,CAAC,CAAC,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC;gBAClF,OAAO,CAAC,OAAO,EAAE,WAAW,IAAI,cAAc,CAAC,CAAC,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC;oBAC1F,0BAA0B,CAAC,QAAQ,CAAC,CAAC,iCAAiC;QAExE,IAAG,MAAM,CAAC,OAAO,CAAC,OAAO,IAAI,KAAK,EAAE,CAAC;YACnC,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,aAAa,EAAE,CAAC;QACzB,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,uBAAuB,CAAC,OAAuB,EAAE,MAA8B;QACrF,MAAM,GAAG,GAAoD,EAAE,CAAC;QAChE,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC;YAC7C,MAAM,IAAI,GAAiC,IAAI,4BAA4B,CACzE,UAAU,CAAC,EAAE,IAAI,EAAE,EACnB,CAAC,UAAU,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,EAC/C,UAAU,CAAC,WAAW,IAAI,EAAE,EAC5B,IAAI,CAAC,SAAS,CACf,CAAC;YACF,IAAI,UAAU,CAAC,OAAO,EAAE,CAAC;gBACvB,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC;gBACtD,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC;gBAC5C,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC;gBAClD,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC;YACpD,CAAC;YACD,IAAI,UAAU,CAAC,YAAY,IAAI,GAAG,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;gBAC5D,GAAG,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrD,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACxB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;YACtB,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;OAIG;IACK,SAAS,CAAC,MAAe;QAC/B,IAAG,CAAC,MAAM,CAAC,sBAAsB,EAAE,CAAC;YAClC,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,IAAG,CAAC,MAAM,CAAC,sBAAsB,CAAC,KAAK,IAAI,OAAO,MAAM,CAAC,sBAAsB,CAAC,KAAK,IAAI,QAAQ,EAAE,CAAC;YAClG,MAAM,CAAC,sBAAsB,CAAC,KAAK,GAAG,EAAC,IAAI,EAAC,EAAE,EAAC,CAAC;QAClD,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,sBAAsB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC9D,OAAO,MAAM,CAAC;IAChB,CAAC;CACF","debug_id":"4b33628b-8dd7-5580-b803-00a4660d8c89"}

package/build/src/types/kpj/kpj-file.d.ts

@@ -0,0 +1,40 @@
+export interface KPJFile {
+    KeymanDeveloperProject: KPJFileProject;
+}
+export interface KPJFileProject {
+    Options?: KPJFileOptions;
+    Files?: KPJFileFiles;
+}
+export interface KPJFileOptions {
+    BuildPath?: string;
+    SourcePath?: string;
+    CompilerWarningsAsErrors?: string;
+    WarnDeprecatedCode?: string;
+    SkipMetadataFiles?: string;
+    CheckFilenameConventions?: string;
+    ProjectType?: 'keyboard' | 'lexicalmodel';
+    Version?: '1.0' | '2.0';
+}
+export interface KPJFileFiles {
+    File?: KPJFileFile[];
+}
+export interface KPJFileFile {
+    ID?: string;
+    Filename?: string;
+    Filepath?: string;
+    FileVersion?: string;
+    FileType?: string;
+    Details?: KPJFileFileDetail_Kmn & KPJFileFileDetail_Kps;
+    ParentFileID?: string;
+}
+export interface KPJFileFileDetail_Kmn {
+    Name?: string;
+    Copyright?: string;
+    Message?: string;
+}
+export interface KPJFileFileDetail_Kps {
+    Name?: string;
+    Copyright?: string;
+    Version?: string;
+}
+//# sourceMappingURL=kpj-file.d.ts.map

package/build/src/types/kpj/kpj-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kpj-file.d.ts","sourceRoot":"","sources":["../../../../src/types/kpj/kpj-file.ts"],"names":[],"mappings":"AAQA,MAAM,WAAW,OAAO;IACtB,sBAAsB,EAAE,cAAc,CAAC;CACxC;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,KAAK,CAAC,EAAE,YAAY,CAAC;CACtB;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,WAAW,CAAC,EAAE,UAAU,GAAG,cAAc,CAAC;IAC1C,OAAO,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;CACzB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,WAAW,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,qBAAqB,GAAG,qBAAqB,CAAC;IACxD,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/build/src/types/kpj/kpj-file.js

@@ -0,0 +1,14 @@
+/*
+ * Keyman Developer Project File
+ */
+
+!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]="725ee6bc-04f0-5233-8d10-3a1db0bad59a")}catch(e){}}();
+;
+;
+;
+;
+;
+;
+export {};
+//# sourceMappingURL=kpj-file.js.map
+//# debugId=725ee6bc-04f0-5233-8d10-3a1db0bad59a

package/build/src/types/kpj/kpj-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"kpj-file.js","sources":["../../../../src/types/kpj/kpj-file.ts"],"sourceRoot":"","names":[],"mappings":"AAAA;;GAEG;;;AAaF,CAAC;AAWD,CAAC;AAID,CAAC;AAUD,CAAC;AAMD,CAAC;AAMD,CAAC","debug_id":"725ee6bc-04f0-5233-8d10-3a1db0bad59a"}

package/build/src/types/kps/kps-file.d.ts

@@ -0,0 +1,176 @@
+export interface KpsPackage {
+    /**
+     * <Package> -- the root element.
+     */
+    Package: KpsFile;
+}
+export interface KpsFile {
+    System: KpsFileSystem;
+    Options: KpsFileOptions;
+    Info?: KpsFileInfo;
+    Files?: KpsFileContentFiles;
+    Keyboards?: KpsFileKeyboards;
+    LexicalModels?: KpsFileLexicalModels;
+    StartMenu?: KpsFileStartMenu;
+    Strings?: KpsFileStrings;
+    RelatedPackages?: KpsFileRelatedPackages;
+}
+export interface KpsFileSystem {
+    KeymanDeveloperVersion: string;
+    FileVersion: string;
+}
+export interface KpsFileOptions {
+    FollowKeyboardVersion?: string;
+    ReadMeFile?: string;
+    GraphicFile?: string;
+    LicenseFile?: string;
+    WelcomeFile?: string;
+    ExecuteProgram?: string;
+    MSIFileName?: string;
+    MSIOptions?: string;
+}
+export interface KpsFileInfo {
+    Name?: KpsFileInfoItem;
+    Copyright?: KpsFileInfoItem;
+    Author?: KpsFileInfoItem;
+    WebSite?: KpsFileInfoItem;
+    Version?: KpsFileInfoItem;
+    Description?: KpsFileInfoItem;
+}
+export interface KpsFileInfoItem {
+    _: string;
+    $: {
+        URL: string;
+    };
+}
+export interface KpsFileContentFiles {
+    File: KpsFileContentFile[] | KpsFileContentFile;
+}
+export interface KpsFileContentFile {
+    Name: string;
+    /** @deprecated */
+    Description: string;
+    /** @deprecated */
+    CopyLocation: string;
+    /** @deprecated */
+    FileType: string;
+}
+export interface KpsFileLexicalModel {
+    Name: string;
+    ID: string;
+    Languages: KpsFileLanguages;
+}
+export interface KpsFileLexicalModels {
+    LexicalModel: KpsFileLexicalModel[] | KpsFileLexicalModel;
+}
+export interface KpsFileLanguages {
+    Language: KpsFileLanguage[] | KpsFileLanguage;
+}
+export interface KpsFileLanguage {
+    _: string;
+    $: {
+        ID: string;
+    };
+}
+export interface KpsFileRelatedPackages {
+    RelatedPackage: KpsFileRelatedPackage | KpsFileRelatedPackage[];
+}
+export interface KpsFileRelatedPackage {
+    $: {
+        ID: string;
+        /**
+         * relationship between this package and the related package, "related" is default if not specified
+         */
+        Relationship?: "deprecates";
+    };
+}
+export interface KpsFileKeyboard {
+    Name: string;
+    ID: string;
+    Version: string;
+    OSKFont?: string;
+    DisplayFont?: string;
+    RTL?: string;
+    Languages?: KpsFileLanguages;
+    Examples?: KpsFileLanguageExamples;
+    /**
+     * array of web font alternatives for OSK. should be same font data as oskFont
+     */
+    WebOSKFonts?: KpsFileFonts;
+    /**
+     * array of web font alternatives for display. should be same font data as displayFont
+     */
+    WebDisplayFonts?: KpsFileFonts;
+}
+export interface KpsFileFonts {
+    Font: KpsFileFont[] | KpsFileFont;
+}
+export interface KpsFileFont {
+    $: {
+        Filename: string;
+    };
+}
+export interface KpsFileKeyboards {
+    Keyboard: KpsFileKeyboard[] | KpsFileKeyboard;
+}
+export interface KpsFileStartMenu {
+    Folder?: string;
+    AddUninstallEntry?: string;
+    Items?: KpsFileStartMenuItems;
+}
+export interface KpsFileStartMenuItem {
+    Name: string;
+    FileName: string;
+    Arguments?: string;
+    Icon?: string;
+    Location?: string;
+}
+export interface KpsFileStartMenuItems {
+    Item: KpsFileStartMenuItem[] | KpsFileStartMenuItem;
+}
+export interface KpsFileStrings {
+    String: KpsFileString[] | KpsFileString;
+}
+export interface KpsFileString {
+    $: {
+        Name: string;
+        Value: string;
+    };
+}
+export interface KpsFileLanguageExamples {
+    Example: KpsFileLanguageExample | KpsFileLanguageExample[];
+}
+/**
+ * An example key sequence intended to demonstrate how the keyboard works
+ */
+export interface KpsFileLanguageExample {
+    $: {
+        /**
+         * BCP 47 identifier for the example
+         */
+        ID: string;
+        /**
+         * A space-separated list of keys.
+         * - modifiers indicated with "+"
+         * - spacebar is "space"
+         * - plus key is "shift+=" or "plus" on US English (all other punctuation as per key cap).
+         * - Hardware modifiers are: "shift", "ctrl", "alt", "left-ctrl",
+         *   "right-ctrl", "left-alt", "right-alt"
+         * - Key caps should generally be their character for desktop (Latin script
+         *   case insensitive), or the actual key cap for touch
+         * - Caps Lock should be indicated with "caps-on", "caps-off"
+         *
+         * e.g. "shift+a b right-alt+c space plus z z z" represents something like: "Ab{AltGr+C} +zzz"
+         */
+        Keys: string;
+        /**
+         * The text that would be generated by typing those keys
+         */
+        Text?: string;
+        /**
+         * A short description of what the text means or represents
+         */
+        Note?: string;
+    };
+}
+//# sourceMappingURL=kps-file.d.ts.map

package/build/src/types/kps/kps-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kps-file.d.ts","sourceRoot":"","sources":["../../../../src/types/kps/kps-file.ts"],"names":[],"mappings":"AAeA,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,aAAa,CAAC;IACtB,OAAO,EAAE,cAAc,CAAC;IACxB,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,aAAa,CAAC,EAAE,oBAAoB,CAAC;IACrC,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,eAAe,CAAC,EAAE,sBAAsB,CAAC;CAC1C;AAED,MAAM,WAAW,aAAa;IAC5B,sBAAsB,EAAE,MAAM,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,kBAAkB,EAAE,GAAG,kBAAkB,CAAC;CACjD;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,kBAAkB;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,gBAAgB,CAAC;CAC7B;AAED,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,mBAAmB,EAAE,GAAG,mBAAmB,CAAC;CAC3D;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,eAAe,EAAE,GAAG,eAAe,CAAC;CAC/C;AAED,MAAM,WAAW,eAAe;IAC9B,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAA;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,cAAc,EAAE,qBAAqB,GAAG,qBAAqB,EAAE,CAAC;CACjE;AAED,MAAM,WAAW,qBAAqB;IACpC,CAAC,EAAE;QACD,EAAE,EAAE,MAAM,CAAC;QACX;;WAEG;QACH,YAAY,CAAC,EAAE,YAAY,CAAC;KAC7B,CAAA;CACF;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,QAAQ,CAAC,EAAE,uBAAuB,CAAC;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,YAAY,CAAC;IAC3B;;OAEG;IACH,eAAe,CAAC,EAAE,YAAY,CAAC;CAChC;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC;CACnC;AAED,MAAM,WAAW,WAAW;IAC1B,CAAC,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAA;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,eAAe,EAAE,GAAG,eAAe,CAAC;CAC/C;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,KAAK,CAAC,EAAE,qBAAqB,CAAC;CAC/B;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,oBAAoB,EAAE,GAAG,oBAAoB,CAAC;CACrD;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,aAAa,EAAE,GAAG,aAAa,CAAC;CACzC;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,EAAE;QACD,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACf,CAAA;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,sBAAsB,GAAG,sBAAsB,EAAE,CAAC;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,CAAC,EAAE;QACD;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QACX;;;;;;;;;;;;WAYG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAA;CACF"}

package/build/src/types/kps/kps-file.js

@@ -0,0 +1,19 @@
+//
+// The interfaces in this file are designed with reference to the
+// mapped structures produced by xml2js when passed a .kps file.
+//
+// A few notes:
+//
+// * Casing is updated to camelCase during load (leaving `iD` as a
+//   mixed up beastie).
+// * Arrays are buried a layer too deep (e.g. <Files><File/><File/></Files>
+//   leads to KpsFiles.KpsFile[]
+// * Properties such as used in Info Items use `_` and `$` and must be
+//   extracted.
+// * Strings element is not yet checked to be correct
+//
+
+!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]="dad015ef-b671-55bb-8c6c-23755afdb224")}catch(e){}}();
+export {};
+//# sourceMappingURL=kps-file.js.map
+//# debugId=dad015ef-b671-55bb-8c6c-23755afdb224

package/build/src/types/kps/kps-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"kps-file.js","sources":["../../../../src/types/kps/kps-file.ts"],"sourceRoot":"","names":[],"mappings":"AAAA,EAAE;AACF,iEAAiE;AACjE,gEAAgE;AAChE,EAAE;AACF,eAAe;AACf,EAAE;AACF,kEAAkE;AAClE,uBAAuB;AACvB,2EAA2E;AAC3E,gCAAgC;AAChC,sEAAsE;AACtE,eAAe;AACf,qDAAqD;AACrD,EAAE","debug_id":"dad015ef-b671-55bb-8c6c-23755afdb224"}

package/build/src/types/kvks/kvks-file-reader.d.ts

@@ -0,0 +1,26 @@
+import KVKSourceFile from './kvks-file.js';
+import { VisualKeyboard as VK } from '@keymanapp/common-types';
+import VisualKeyboard = VK.VisualKeyboard;
+import VisualKeyboardShiftState = VK.VisualKeyboardShiftState;
+export default class KVKSFileReader {
+    read(file: Uint8Array): KVKSourceFile;
+    private cleanupFlags;
+    /**
+     * The only element that allows spaces is <key>. Remove
+     * all other empty whitespace-only values.
+     * @param root
+     * @param source
+     */
+    private cleanupUnderscore;
+    validate(source: KVKSourceFile): void;
+    transform(source: KVKSourceFile, invalidVkeys?: string[]): VisualKeyboard;
+    private base64ToArray;
+    /**
+     * xml2js will not place single-entry objects into arrays.
+     * Easiest way to fix this is to box them ourselves as needed
+     * @param source KVKSourceFile
+     */
+    private boxArrays;
+    kvksShiftToKvkShift(shift: string): VisualKeyboardShiftState;
+}
+//# sourceMappingURL=kvks-file-reader.d.ts.map