@keymanapp/common-types 17.0.85-alpha

package/build/src/kvks.schema.json

@@ -0,0 +1,182 @@
+{
+  "title": "kvks.xsd",
+  "$schema": "http://json-schema.org/schema#",
+  "type": "object",
+  "properties": {
+    "visualkeyboard": {
+      "properties": {
+        "header": {
+          "$ref": "#/definitions/kvk-header"
+        },
+        "encoding": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/kvk-encoding"
+          }
+        }
+      },
+      "required": [
+        "header"
+      ],
+      "additionalProperties": false,
+      "type": "object"
+    }
+  },
+  "required": [
+    "visualkeyboard"
+  ],
+  "additionalProperties": false,
+  "definitions": {
+    "kvk-header": {
+      "type": "object",
+      "properties": {
+        "version": {
+          "$ref": "#/definitions/kvk-version"
+        },
+        "kbdname": {
+          "type": "string"
+        },
+        "flags": {
+          "$ref": "#/definitions/kvk-header-flags"
+        },
+        "layout": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "version"
+      ],
+      "additionalProperties": false
+    },
+    "kvk-header-flags": {
+      "type": "object",
+      "properties": {
+        "key102": {
+          "$ref": "#/definitions/km-empty"
+        },
+        "displayunderlying": {
+          "$ref": "#/definitions/km-empty"
+        },
+        "usealtgr": {
+          "$ref": "#/definitions/km-empty"
+        },
+        "useunderlying": {
+          "$ref": "#/definitions/km-empty"
+        }
+      },
+      "additionalProperties": false
+    },
+    "kvk-encoding": {
+      "type": "object",
+      "properties": {
+        "layer": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/kvk-layer"
+          }
+        },
+        "$": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "$ref": "#/definitions/kvk-encoding-name"
+            },
+            "fontname": {
+              "type": "string"
+            },
+            "fontsize": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "name"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "$"
+      ],
+      "additionalProperties": false
+    },
+    "kvk-layer": {
+      "type": "object",
+      "properties": {
+        "key": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/kvk-key"
+          }
+        },
+        "$": {
+          "type": "object",
+          "properties": {
+            "shift": {
+              "$ref": "#/definitions/kvk-layer-shift"
+            }
+          },
+          "required": [
+            "shift"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "$"
+      ],
+      "additionalProperties": false
+    },
+    "kvk-key": {
+      "type": "object",
+      "properties": {
+        "bitmap": {
+          "type": "string"
+        },
+        "$": {
+          "type": "object",
+          "properties": {
+            "vkey": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "vkey"
+          ],
+          "additionalProperties": false
+        },
+        "_": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "$"
+      ],
+      "additionalProperties": false
+    },
+    "km-empty": {
+      "type": "string"
+    },
+    "kvk-encoding-name": {
+      "type": "string",
+      "enum": [
+        "ansi",
+        "unicode"
+      ]
+    },
+    "kvk-layer-shift": {
+      "type": "string",
+      "pattern": "S?(C|LC|RC)?(A|LA|RA)?"
+    },
+    "kvk-version": {
+      "type": "string",
+      "pattern": "(\\d+\\.)+(\\d+)",
+      "enum": [
+        "10.0"
+      ]
+    },
+    "km-version": {
+      "type": "string",
+      "pattern": "(\\d+\\.)+(\\d+)"
+    }
+  }
+}

package/build/src/ldml-keyboard/ldml-keyboard-testdata-xml.d.ts

@@ -0,0 +1,56 @@
+export interface LDMLKeyboardTestDataXMLSourceFile {
+    /**
+     * <keyboardTest> -- the root element.
+     */
+    keyboardTest: LKTKeyboardTest;
+}
+export interface LKTKeyboardTest {
+    conformsTo?: string;
+    info?: LKTInfo;
+    repertoire?: LKTRepertoire[];
+    tests?: LKTTests[];
+}
+export interface LKTInfo {
+    author?: string;
+    keyboard?: string;
+    name?: string;
+}
+export interface LKTRepertoire {
+    name?: string;
+    chars?: string;
+    type?: string;
+}
+export interface LKTTests {
+    name?: string;
+    test?: LKTTest[];
+}
+export interface LKTTest {
+    name?: string;
+    startContext?: LKTStartContext;
+    actions?: LKTAction[];
+}
+export interface LKTStartContext {
+    to?: string;
+}
+export interface LKTCheck {
+    result?: string;
+}
+export interface LKTEmit {
+    to?: string;
+}
+export interface LKTKeystroke {
+    key?: string;
+    flick?: string;
+    longPress?: string;
+    tapCount?: string;
+}
+/**
+ * Test Actions.
+ * The expectation is that each LKTAction object will have exactly one non-falsy field.
+ */
+export interface LKTAction {
+    check?: LKTCheck;
+    emit?: LKTEmit;
+    keystroke?: LKTKeystroke;
+}
+//# sourceMappingURL=ldml-keyboard-testdata-xml.d.ts.map

package/build/src/ldml-keyboard/ldml-keyboard-testdata-xml.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ldml-keyboard-testdata-xml.d.ts","sourceRoot":"","sources":["../../../src/ldml-keyboard/ldml-keyboard-testdata-xml.ts"],"names":[],"mappings":"AASA,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,YAAY,EAAE,eAAe,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,UAAU,CAAC,EAAE,aAAa,EAAE,CAAC;IAC7B,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,OAAO;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,OAAO;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,eAAe,CAAC;IAC/B,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,QAAQ;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,SAAS,CAAC,EAAE,YAAY,CAAC;CAC1B"}

package/build/src/ldml-keyboard/ldml-keyboard-testdata-xml.js

@@ -0,0 +1,20 @@
+//
+// Conforms to techpreview
+//
+// The interfaces in this file are designed with reference to the mapped
+// structures produced by xml2js when passed a LDML keyboard test data .xml file.
+//
+// Using prefix LKT for LDML Keyboard Test
+//
+;
+;
+;
+;
+;
+;
+;
+;
+;
+;
+export {};
+//# sourceMappingURL=ldml-keyboard-testdata-xml.js.map

package/build/src/ldml-keyboard/ldml-keyboard-testdata-xml.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ldml-keyboard-testdata-xml.js","sourceRoot":"","sources":["../../../src/ldml-keyboard/ldml-keyboard-testdata-xml.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AACF,wEAAwE;AACxE,iFAAiF;AACjF,EAAE;AACF,0CAA0C;AAC1C,EAAE;AAcD,CAAC;AAMD,CAAC;AAMD,CAAC;AAKD,CAAC;AAMD,CAAC;AAID,CAAC;AAID,CAAC;AAID,CAAC;AAOD,CAAC;AAUD,CAAC"}

package/build/src/ldml-keyboard/ldml-keyboard-xml-reader.d.ts

@@ -0,0 +1,91 @@
+/// <reference types="node" resolution-mode="require"/>
+import { LDMLKeyboardXMLSourceFile } from './ldml-keyboard-xml.js';
+import { CompilerCallbacks } from '../util/compiler-interfaces.js';
+import { LDMLKeyboardTestDataXMLSourceFile } from './ldml-keyboard-testdata-xml.js';
+interface NameAndProps {
+    '$'?: any;
+    '#name'?: string;
+    '$$'?: any;
+}
+export default class LDMLKeyboardXMLSourceFileReader {
+    callbacks: CompilerCallbacks;
+    constructor(callbacks: CompilerCallbacks);
+    readImportFile(version: string, subpath: string): Buffer;
+    /**
+     * xml2js will not place single-entry objects into arrays.
+     * Easiest way to fix this is to box them ourselves as needed
+     * @param source any
+     * @returns true on success, false on failure
+     */
+    private boxArrays;
+    /**
+     * Recurse over object, boxing up any specials or imports
+     * @param obj any object to be traversed
+     * @param subtag the leafmost enclosing tag such as 'keyboard'
+     * @returns true on success, false on failure
+     */
+    private boxImportsAndSpecials;
+    /**
+     *
+     * @param obj object to be imported into
+     * @param subtag obj's element tag, e.g. `keys`
+     * @returns true on success, false on failure
+     */
+    private resolveImports;
+    /**
+     * @param obj the object being imported into
+     * @param subtag obj's element tag, e.g. `keys`
+     * @param asImport the import structure
+     * @returns true on success, false on failure
+     */
+    private resolveOneImport;
+    /**
+     * @returns true if valid, false if invalid
+     */
+    validate(source: LDMLKeyboardXMLSourceFile | LDMLKeyboardTestDataXMLSourceFile, schemaSource: Buffer): boolean;
+    loadUnboxed(file: Uint8Array): LDMLKeyboardXMLSourceFile;
+    /**
+     * @param file
+     * @returns source on success, otherwise null
+     */
+    load(file: Uint8Array): LDMLKeyboardXMLSourceFile | null;
+    loadTestDataUnboxed(file: Uint8Array): any;
+    /**
+     * Filter the obj array for a subtag
+     * @param source array of source objs
+     * @param subtag subtag to filter on
+     * @returns
+     */
+    findSubtagArray(source: NameAndProps[], subtag: string): NameAndProps[];
+    /**
+     * Get exactly one element
+     * @param source
+     * @param subtag
+     * @returns
+     */
+    findSubtag(source: NameAndProps[], subtag: string): NameAndProps | null;
+    /**
+     * The default test data stuffer.
+     * Just gets $ (the attrs) as the body.
+     * Override to use something more complex, such as including child nodes.
+     * @param o object to map
+     * @param r back ref to reader
+     */
+    static readonly defaultMapper: (o: NameAndProps, r: LDMLKeyboardXMLSourceFileReader) => any;
+    /**
+     *
+     * @param obj target object
+     * @param source array of $/#name strings
+     * @param subtag name to extract
+     * @param mapper custom mapper function
+     */
+    stuffBoxes(obj: any, source: NameAndProps[], subtag: string, asArray?: boolean, mapper?: (v: NameAndProps, r: LDMLKeyboardXMLSourceFileReader) => any): void;
+    boxTestDataArrays(raw: any): LDMLKeyboardTestDataXMLSourceFile | null;
+    /**
+     * @param file test file
+     * @returns source on success, otherwise null
+     */
+    loadTestData(file: Uint8Array): LDMLKeyboardTestDataXMLSourceFile | null;
+}
+export {};
+//# sourceMappingURL=ldml-keyboard-xml-reader.d.ts.map

package/build/src/ldml-keyboard/ldml-keyboard-xml-reader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ldml-keyboard-xml-reader.d.ts","sourceRoot":"","sources":["../../../src/ldml-keyboard/ldml-keyboard-xml-reader.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,yBAAyB,EAAY,MAAM,wBAAwB,CAAC;AAI7E,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAGnE,OAAO,EAAE,iCAAiC,EAAqB,MAAM,iCAAiC,CAAC;AAEvG,UAAU,YAAY;IACpB,GAAG,CAAC,EAAE,GAAG,CAAC;IACV,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ;AAED,MAAM,CAAC,OAAO,OAAO,+BAA+B;IAClD,SAAS,EAAE,iBAAiB,CAAC;gBAEjB,SAAS,EAAG,iBAAiB;IAIzC,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM;IAOxD;;;;;OAKG;IACH,OAAO,CAAC,SAAS;IA4CjB;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;IAiC7B;;;;;OAKG;IACH,OAAO,CAAC,cAAc;IAqBtB;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAyCxB;;OAEG;IACI,QAAQ,CAAC,MAAM,EAAE,yBAAyB,GAAG,iCAAiC,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO;IAiBrH,WAAW,CAAC,IAAI,EAAE,UAAU,GAAG,yBAAyB;IAuBxD;;;OAGG;IACI,IAAI,CAAC,IAAI,EAAE,UAAU,GAAG,yBAAyB,GAAG,IAAI;IAY/D,mBAAmB,CAAC,IAAI,EAAE,UAAU,GAAG,GAAG;IAyB1C;;;;;OAKG;IACH,eAAe,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,YAAY,EAAE;IAIvE;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,IAAI;IAYvE;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,aAAa,MAAS,YAAY,KAAK,+BAA+B,SAAW;IAEjG;;;;;;OAMG;IACH,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,+BAA+B,KAAK,GAAG;IAYrJ,iBAAiB,CAAC,GAAG,EAAE,GAAG,GAAI,iCAAiC,GAAG,IAAI;IA0CtE;;;OAGG;IACI,YAAY,CAAC,IAAI,EAAE,UAAU,GAAG,iCAAiC,GAAG,IAAI;CAOhF"}