@keymanapp/kmc-ldml 17.0.104-alpha

package/build/src/ldml-keyboardtest.schema.json

@@ -0,0 +1,221 @@
+{
+  "$schema": "http://json-schema.org/schema#",
+  "additionalProperties": false,
+  "definitions": {
+    "any": {
+      "type": "string"
+    },
+    "backspace": {
+      "type": "string"
+    },
+    "check": {
+      "additionalProperties": false,
+      "properties": {
+        "result": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "result"
+      ],
+      "type": "object"
+    },
+    "emit": {
+      "additionalProperties": false,
+      "properties": {
+        "to": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "to"
+      ],
+      "type": "object"
+    },
+    "info": {
+      "additionalProperties": false,
+      "properties": {
+        "author": {
+          "type": "string"
+        },
+        "keyboard": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "keyboard",
+        "name"
+      ],
+      "type": "object"
+    },
+    "keystroke": {
+      "additionalProperties": false,
+      "properties": {
+        "flick": {
+          "type": "string"
+        },
+        "key": {
+          "type": "string"
+        },
+        "longPress": {
+          "type": "string"
+        },
+        "tapCount": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "key"
+      ],
+      "type": "object"
+    },
+    "repertoire": {
+      "additionalProperties": false,
+      "properties": {
+        "chars": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "enum": [
+            "default",
+            "simple",
+            "gesture",
+            "flick",
+            "longPress",
+            "multiTap",
+            "hardware"
+          ],
+          "type": "string"
+        }
+      },
+      "required": [
+        "chars",
+        "name"
+      ],
+      "type": "object"
+    },
+    "special": {
+      "$ref": "#/definitions/any"
+    },
+    "startContext": {
+      "additionalProperties": false,
+      "properties": {
+        "to": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "to"
+      ],
+      "type": "object"
+    },
+    "test": {
+      "additionalProperties": false,
+      "properties": {
+        "backspace": {
+          "$ref": "#/definitions/backspace"
+        },
+        "check": {
+          "$ref": "#/definitions/check"
+        },
+        "emit": {
+          "$ref": "#/definitions/emit"
+        },
+        "keystroke": {
+          "$ref": "#/definitions/keystroke"
+        },
+        "name": {
+          "type": "string"
+        },
+        "special": {
+          "items": {
+            "$ref": "#/definitions/special"
+          },
+          "type": "array"
+        },
+        "startContext": {
+          "$ref": "#/definitions/startContext"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "type": "object"
+    },
+    "tests": {
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "special": {
+          "items": {
+            "$ref": "#/definitions/special"
+          },
+          "type": "array"
+        },
+        "test": {
+          "items": {
+            "$ref": "#/definitions/test"
+          },
+          "minItems": 1,
+          "type": "array"
+        }
+      },
+      "required": [
+        "test",
+        "name"
+      ],
+      "type": "object"
+    }
+  },
+  "properties": {
+    "keyboardTest": {
+      "additionalProperties": false,
+      "properties": {
+        "conformsTo": {
+          "enum": [
+            "techpreview"
+          ],
+          "type": "string"
+        },
+        "info": {
+          "$ref": "#/definitions/info"
+        },
+        "repertoire": {
+          "items": {
+            "$ref": "#/definitions/repertoire"
+          },
+          "type": "array"
+        },
+        "special": {
+          "items": {
+            "$ref": "#/definitions/special"
+          },
+          "type": "array"
+        },
+        "tests": {
+          "items": {
+            "$ref": "#/definitions/tests"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "info",
+        "conformsTo"
+      ]
+    }
+  },
+  "required": [
+    "keyboardTest"
+  ],
+  "title": "techpreview/dtd/ldmlKeyboardTest.xsd",
+  "type": "object"
+}

package/build/src/main.d.ts

@@ -0,0 +1,9 @@
+export { default as Compiler } from './compiler/compiler.js';
+export { KeymanWebCompiler } from './compiler/keymanweb-compiler.js';
+export { default as VisualKeyboardCompiler } from './compiler/visual-keyboard-compiler.js';
+export { TouchLayoutCompiler } from './compiler/touch-layout-compiler.js';
+export { default as CompilerOptions } from './compiler/compiler-options.js';
+export { CompilerMessages } from './compiler/messages.js';
+export { default as KMXPlusMetadataCompiler } from './compiler/metadata-compiler.js';
+export { KMXBuilder } from "@keymanapp/common-types";
+//# sourceMappingURL=main.d.ts.map

package/build/src/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/main.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AAC3F,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,OAAO,IAAI,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAErF,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC"}

package/build/src/main.js

@@ -0,0 +1,8 @@
+export { default as Compiler } from './compiler/compiler.js';
+export { KeymanWebCompiler } from './compiler/keymanweb-compiler.js';
+export { default as VisualKeyboardCompiler } from './compiler/visual-keyboard-compiler.js';
+export { TouchLayoutCompiler } from './compiler/touch-layout-compiler.js';
+export { CompilerMessages } from './compiler/messages.js';
+export { default as KMXPlusMetadataCompiler } from './compiler/metadata-compiler.js';
+export { KMXBuilder } from "@keymanapp/common-types";
+//# sourceMappingURL=main.js.map

package/build/src/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../../src/main.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AAC3F,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAE1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,OAAO,IAAI,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAErF,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC"}

package/build/src/util/util.d.ts

@@ -0,0 +1,32 @@
+import { LDMLKeyboard } from "@keymanapp/common-types";
+/**
+ * Verifies that value is an item in the enumeration.
+ */
+export declare function isValidEnumValue<T extends {
+    [key: number]: string | number;
+}>(enu: T, value: string): boolean;
+/**
+ * Returns unique LKKeys only, preserving later ones
+ * in case of conflict. (i.e. later overrides)
+ * @param keys list of keys to consider. (mutated)
+ * @returns Array of unique keys. Order is not specified.
+ */
+export declare function calculateUniqueKeys(keys?: LDMLKeyboard.LKKey[]): LDMLKeyboard.LKKey[];
+/**
+ *
+ * @param layersList list of layers elements, from `keyboard?.layers`
+ * @returns set of key IDs
+ */
+export declare function allUsedKeyIdsInLayers(layersList: LDMLKeyboard.LKLayers[] | null): Set<string>;
+/**
+ * Determine modifier from layer info
+ * @param layer layer obj
+ * @returns modifier
+ */
+export declare function translateLayerAttrToModifier(layer: LDMLKeyboard.LKLayer): number;
+/**
+ * @param modifier modifier sequence such as undefined, "none", "shift altR" etc
+ * @returns true if valid
+ */
+export declare function validModifier(modifier?: string): boolean;
+//# sourceMappingURL=util.d.ts.map

package/build/src/util/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../src/util/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,SAAS;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,WAEjG;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC,KAAK,EAAE,GAAG,YAAY,CAAC,KAAK,EAAE,CAiBrF;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAG,YAAY,CAAC,QAAQ,EAAE,GAAG,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,CAgB9F;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,YAAY,CAAC,OAAO,GAAI,MAAM,CAYjF;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAI,OAAO,CAQzD"}

package/build/src/util/util.js

@@ -0,0 +1,85 @@
+import { constants } from "@keymanapp/ldml-keyboard-constants";
+/**
+ * Verifies that value is an item in the enumeration.
+ */
+export function isValidEnumValue(enu, value) {
+    return Object.values(enu).includes(value);
+}
+/**
+ * Returns unique LKKeys only, preserving later ones
+ * in case of conflict. (i.e. later overrides)
+ * @param keys list of keys to consider. (mutated)
+ * @returns Array of unique keys. Order is not specified.
+ */
+export function calculateUniqueKeys(keys) {
+    if (!keys) {
+        return [];
+    }
+    // Need 'newer' (later) keys to override older ones.
+    const reverseKeys = keys.reverse(); // newest to oldest
+    const alreadySeen = new Set();
+    // filter out only the keys that haven't already been seen
+    const uniqueKeys = reverseKeys.filter(({ id }) => {
+        if (!alreadySeen.has(id)) {
+            alreadySeen.add(id);
+            return true;
+        }
+        return false;
+    });
+    return uniqueKeys;
+}
+/**
+ *
+ * @param layersList list of layers elements, from `keyboard?.layers`
+ * @returns set of key IDs
+ */
+export function allUsedKeyIdsInLayers(layersList) {
+    const s = new Set();
+    if (layersList) {
+        for (const layers of layersList || []) {
+            for (const layer of layers.layer || []) {
+                for (const row of layer.row || []) {
+                    if (row.keys) {
+                        for (const k of row.keys.split(" ")) {
+                            s.add(k);
+                        }
+                    }
+                }
+            }
+        }
+    }
+    return s;
+}
+/**
+ * Determine modifier from layer info
+ * @param layer layer obj
+ * @returns modifier
+ */
+export function translateLayerAttrToModifier(layer) {
+    const { modifier } = layer;
+    if (modifier) {
+        let mod = constants.keys_mod_none;
+        for (let str of modifier.split(' ')) {
+            const submod = constants.keys_mod_map.get(str);
+            mod |= submod;
+        }
+        return mod;
+    }
+    // TODO-LDML: other modifiers, other ids?
+    return constants.keys_mod_none;
+}
+/**
+ * @param modifier modifier sequence such as undefined, "none", "shift altR" etc
+ * @returns true if valid
+ */
+export function validModifier(modifier) {
+    if (!modifier)
+        return true; // valid to have no modifier, == none
+    for (let str of modifier.split(' ')) {
+        if (!constants.keys_mod_map.has(str)) {
+            return false;
+        }
+    }
+    return true;
+}
+//# sourceMappingURL=util.js.map

package/build/src/util/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../../src/util/util.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAC;AAC/D;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAA6C,GAAM,EAAE,KAAa;IAChG,OAAQ,MAAM,CAAC,MAAM,CAAC,GAAG,CAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAA2B;IAC7D,IAAI,CAAC,IAAI,EAAE;QACT,OAAO,EAAE,CAAC;KACX;IACD,oDAAoD;IACpD,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,mBAAmB;IACvD,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAC;IACtC,0DAA0D;IAC1D,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE;QAC/C,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;YACxB,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACpB,OAAO,IAAI,CAAC;SACb;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,UAA2C;IAC/E,MAAM,CAAC,GAAG,IAAI,GAAG,EAAU,CAAC;IAC5B,IAAI,UAAU,EAAE;QACd,KAAK,MAAM,MAAM,IAAI,UAAU,IAAI,EAAE,EAAE;YACrC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,KAAK,IAAI,EAAE,EAAE;gBACtC,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,GAAG,IAAI,EAAE,EAAE;oBACjC,IAAI,GAAG,CAAC,IAAI,EAAE;wBACZ,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;4BACnC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;yBACV;qBACF;iBACF;aACF;SACF;KACF;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,4BAA4B,CAAC,KAA2B;IACtE,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;IAC3B,IAAI,QAAQ,EAAE;QACZ,IAAI,GAAG,GAAG,SAAS,CAAC,aAAa,CAAC;QAClC,KAAK,IAAI,GAAG,IAAI,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YACnC,MAAM,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC/C,GAAG,IAAI,MAAM,CAAC;SACf;QACD,OAAO,GAAG,CAAC;KACZ;IACD,yCAAyC;IACzC,OAAO,SAAS,CAAC,aAAa,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,QAAiB;IAC7C,IAAI,CAAC,QAAQ;QAAE,OAAO,IAAI,CAAC,CAAE,qCAAqC;IAClE,KAAK,IAAI,GAAG,IAAI,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;QACnC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACpC,OAAO,KAAK,CAAC;SACd;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@keymanapp/kmc-ldml",
+  "description": "Keyman Developer LDML keyboard compiler",
+  "keywords": [
+    "keyboard",
+    "keyman",
+    "ldml",
+    "unicode"
+  ],
+  "type": "module",
+  "exports": {
+    ".": "./build/src/main.js"
+  },
+  "files": [
+    "/build/src/"
+  ],
+  "scripts": {
+    "build": "tsc -b",
+    "lint": "eslint .",
+    "test": "npm run lint && cd test && tsc -b && cd .. && c8 --reporter=lcov --reporter=text mocha",
+    "prepublishOnly": "npm run build"
+  },
+  "author": "Marc Durdin <marc@keyman.com> (https://github.com/mcdurdin)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/keymanapp/keyman/issues"
+  },
+  "dependencies": {
+    "@keymanapp/keyman-version": "17.0.104-alpha",
+    "@keymanapp/ldml-keyboard-constants": "17.0.104-alpha",
+    "ajv": "^8.11.0",
+    "restructure": "git+https://github.com/keymanapp/dependency-restructure.git#49d129cf0916d082a7278bb09296fb89cecfcc50",
+    "semver": "^7.3.7",
+    "xml2js": "git+https://github.com/keymanapp/dependency-node-xml2js#535fe732dc408d697e0f847c944cc45f0baf0829"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.1.7",
+    "@types/mocha": "^5.2.7",
+    "@types/node": "^10.14.6",
+    "@types/semver": "^7.3.12",
+    "@types/xml2js": "^0.4.5",
+    "c8": "^7.12.0",
+    "chai": "^4.3.4",
+    "chalk": "^2.4.2",
+    "mocha": "^8.4.0",
+    "ts-node": "^9.1.1",
+    "typescript": "^4.9.5",
+    "@keymanapp/developer-test-helpers": "17.0.104-alpha"
+  },
+  "mocha": {
+    "spec": "build/test/**/test-*.js",
+    "require": [
+      "source-map-support/register"
+    ]
+  },
+  "c8": {
+    "all": true,
+    "src": [
+      "src/"
+    ],
+    "exclude-after-remap": true,
+    "exclude": [
+      "test/"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/keymanapp/keyman.git"
+  },
+  "version": "17.0.104-alpha"
+}