@keymanapp/common-types 17.0.85-alpha

package/src/util/common-events.ts

@@ -0,0 +1,50 @@
+import { CompilerErrorNamespace, CompilerErrorSeverity, 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 = (o:{instancePath:string, keyword:string, message: string, params: string}) => m(this.ERROR_SchemaValidationError,
+    `Error validating LDML XML file: ${o.instancePath}: ${o.keyword}: ${o.message} ${o.params}`);
+  static ERROR_SchemaValidationError = SevError | 0x0001;
+
+  static Error_ImportInvalidBase = (o: { base: string, path: string, subtag: string }) =>
+    m(this.ERROR_ImportInvalidBase,
+      `Import element with base ${o.base} is unsupported. Only ${constants.cldr_import_base} is supported.`);
+  static ERROR_ImportInvalidBase = SevError | 0x0002;
+
+  static Error_ImportInvalidPath = (o: { base: string, path: string, subtag: string }) =>
+    m(this.ERROR_ImportInvalidPath,
+      `Import element with invalid path ${o.path}: expected the form '${constants.cldr_version_latest}./*.xml`);
+  static ERROR_ImportInvalidPath = SevError | 0x0003;
+
+  static Error_ImportReadFail = (o: { base: string, path: string, subtag: string }) =>
+    m(this.ERROR_ImportReadFail,
+      `Import could not read data with path ${o.path}: expected the form '${constants.cldr_version_latest}./*.xml'`);
+  static ERROR_ImportReadFail = SevError | 0x0004;
+
+  static Error_ImportWrongRoot = (o: { base: string, path: string, subtag: string }) =>
+    m(this.ERROR_ImportWrongRoot,
+      `Invalid import file ${o.path}: expected ${o.subtag} as root element.`);
+  static ERROR_ImportWrongRoot = SevError | 0x0005;
+
+  static Error_ImportMergeFail = (o: { base: string, path: string, subtag: string, subsubtag: string }) =>
+    m(this.ERROR_ImportMergeFail,
+      `Problem importing ${o.path}: not sure how to handle non-array ${o.subtag}.${o.subsubtag}`);
+  static ERROR_ImportMergeFail = SevError | 0x0006;
+
+  static Error_TestDataUnexpectedArray = (o: {subtag: string}) =>
+    m(this.ERROR_TestDataUnexpectedArray,
+      `Problem reading test data: expected single ${o.subtag} element, found multiple`);
+  static ERROR_TestDataUnexpectedArray = SevError | 0x0007;
+  static Error_TestDataUnexpectedAction = (o: {subtag: string}) =>
+    m(this.ERROR_TestDataUnexpectedAction,
+      `Problem reading test data: unexpected action element ${o.subtag}`);
+  static ERROR_TestDataUnexpectedAction = SevError | 0x0008;
+};

package/src/util/compiler-interfaces.ts

@@ -0,0 +1,54 @@
+/**
+ * Abstract interface for compiler error and warning messages
+ */
+export interface CompilerEvent {
+  code: number;
+  message: string;
+};
+
+export enum CompilerErrorSeverity {
+  Info =          0x000000, // Informational, not necessarily a problem
+  Hint =          0x100000, // Something the user might want to be aware of
+  Warn =          0x200000, // Warning: Not great, but we can keep going.
+  Error =         0x300000, // Severe error where we can't continue
+  Fatal =         0x400000, // OOM or should-not-happen internal problem
+
+  Severity_Mask = 0xF00000, // includes reserved bits
+  Error_Mask =    0x0FFFFF,
+};
+
+export enum CompilerErrorNamespace {
+  /**
+   * kmc-keyboard errors between 0x0000…0x0FFF
+   */
+  KeyboardCompiler = 0x0000,
+  /**
+   * common/web/types errors between 0x1000…0x1FFF
+   */
+  CommonTypes = 0x1000,
+};
+
+/**
+ * Abstract interface for callbacks, to abstract out file i/o
+ */
+export interface CompilerCallbacks {
+  /**
+   * Attempt to load a file. Return falsy if not found.
+   * @param baseFilename
+   * @param filename
+   */
+  loadFile(baseFilename: string, filename: string | URL): Buffer;
+  loadLdmlKeyboardSchema(): Buffer;
+  loadLdmlKeyboardTestSchema(): Buffer;
+  reportMessage(event: CompilerEvent): void;
+  loadKvksJsonSchema(): Buffer;
+  loadKpjJsonSchema(): Buffer;
+};
+
+/**
+ * Convenience function for constructing CompilerEvents
+ * @param code
+ * @param message
+ * @returns
+ */
+export const CompilerMessageSpec = (code: number, message: string) : CompilerEvent => { return { code, message } };

package/src/util/util.ts

@@ -0,0 +1,68 @@
+/**
+ * xml2js will not place single-entry objects into arrays. Easiest way to fix
+ * this is to box them ourselves as needed. Ensures that o.x is an array.
+ *
+ * @param o Object with property to box
+ * @param x Name of element to box
+ */
+export function boxXmlArray(o: any, x: string): void {
+  if(typeof o == 'object' && !Array.isArray(o[x])) {
+    if(o[x] === null || o[x] === undefined) {
+      o[x] = [];
+    }
+    else {
+      o[x] = [o[x]];
+    }
+  }
+}
+
+// TODO-LDML: #7569 the below regex works, but captures more than it should
+// (it would include \u{fffffffffffffffff } which
+// is overlong and has a space at the end.) The second regex does not work yet.
+const MATCH_HEX_ESCAPE = /\\u{([0-9a-fA-F ]{1,})}/g;
+// const MATCH_HEX_ESCAPE = /\\u{((?:(?:[0-9a-fA-F]{1,5})|(?:10[0-9a-fA-F]{4})(?: (?!}))?)+)}/g;
+
+export class UnescapeError extends Error {
+}
+
+/**
+ * Unescapes a string according to UTS#18§1.1, see <https://www.unicode.org/reports/tr18/#Hex_notation>
+ * @param s escaped string
+ * @returns
+ */
+export function unescapeString(s: string): string {
+  if(!s) {
+    return s;
+  }
+  try {
+    /**
+     * Unescape one codepoint
+     * @param hex one codepoint in hex, such as '0127'
+     * @returns the unescaped codepoint
+     */
+    function unescapeOne(hex: string) : string {
+      const codepoint = Number.parseInt(hex, 16);
+      return String.fromCodePoint(codepoint);
+    }
+    /**
+     * process one regex match
+     * @param str ignored
+     * @param matched the entire match such as '0127' or '22 22'
+     * @returns the unescaped match
+     */
+    function processMatch(str: string, matched: string) : string {
+      const codepoints = matched.split(' ');
+      const unescaped = codepoints.map(unescapeOne);
+      return unescaped.join('');
+    }
+    s = s.replaceAll(MATCH_HEX_ESCAPE, processMatch);
+  } catch(e) {
+    if (e instanceof RangeError) {
+      throw new UnescapeError(`Out of range while unescaping '${s}': ${e.message}`, { cause: e });
+    } else {
+      throw e;
+    }
+  }
+
+  return s;
+}

package/test/fixtures/import-minimal.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE keyboard SYSTEM "../../../../../resources/standards-data/ldml-keyboards/techpreview/dtd/ldmlKeyboard.dtd">
+<keyboard locale="und" conformsTo="techpreview">
+  <info author="srl295" indicator="🙀" layout="qwerty" normalization="NFC" />
+  <names>
+    <name value="Test Minimal Keyboard" />
+  </names>
+</keyboard>

package/test/fixtures/import-minimal1.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE keyboard SYSTEM "../../../../../resources/standards-data/ldml-keyboards/techpreview/dtd/ldmlKeyboard.dtd">
+<keyboard locale="und" conformsTo="techpreview">
+  <info author="srl295" indicator="🙀" layout="qwerty" normalization="NFC" />
+  <names>
+    <name value="Test Minimal Keyboard" />
+  </names>
+  <keys>
+
+  </keys>
+</keyboard>

package/test/fixtures/import-minimal2.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE keyboard SYSTEM "../../../../../resources/standards-data/ldml-keyboards/techpreview/dtd/ldmlKeyboard.dtd">
+<keyboard locale="und" conformsTo="techpreview">
+  <info author="srl295" indicator="🙀" layout="qwerty" normalization="NFC" />
+  <names>
+    <name value="Test Minimal Keyboard" />
+  </names>
+  <keys>
+    <key id="a" to="å"/> <!-- override -->
+  </keys>
+</keyboard>

package/test/fixtures/import-symbols.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE keyboard SYSTEM "../../../../../resources/standards-data/ldml-keyboards/techpreview/dtd/ldmlKeyboard.dtd">
+<keyboard locale="und" conformsTo="techpreview">
+  <info author="srl295" indicator="🙀" layout="qwerty" normalization="NFC" />
+  <names>
+    <name value="Test Minimal Keyboard" />
+  </names>
+  <keys>
+    <import base="cldr" path="techpreview/keys-Zyyy-punctuation.xml"/>
+    <key id="zz" to="zz"/>
+    <key id="hash" to="##"/> <!-- override -->
+  </keys>
+</keyboard>

package/test/fixtures/invalid-conforms-to.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+  DOCTYPE keyboard SYSTEM "../../../../../resources/standards-data/ldml-keyboards/techpreview/dtd/ldmlKeyboard.dtd"
+  Disabling doctype for this invalid file, not used by compiler, and avoids complaints in IDEs etc.
+-->
+<keyboard locale="mt" conformsTo="nothing-anyone-ever-heard-of"> <!-- invalid -->
+  <info author="srl295" indicator="🙀" layout="qwerty" normalization="NFC" />
+
+  <names>
+    <name value="TestKbd" />
+  </names>
+
+  <keys>
+    <key id="hmaqtugha" to="ħ" />
+    <key id="that" to="ថា" />
+  </keys>
+
+</keyboard>

package/test/fixtures/invalid-import-base.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE keyboard SYSTEM "../../../../../resources/standards-data/ldml-keyboards/techpreview/dtd/ldmlKeyboard.dtd">
+<keyboard locale="mt" conformsTo="techpreview">
+  <info author="srl295" indicator="🙀" layout="qwerty" normalization="NFC" />
+
+  <names>
+    <name value="TestKbd" />
+  </names>
+
+  <keys>
+    <import base="SOME_INVALID_BASE" path="abcd/keys-Zyyy-punctuation.xml"/> <!-- invalid -->
+    <key id="hmaqtugha" to="ħ" />
+    <key id="that" to="ថា" />
+  </keys>
+
+</keyboard>

package/test/fixtures/invalid-import-path.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE keyboard SYSTEM "../../../../../resources/standards-data/ldml-keyboards/techpreview/dtd/ldmlKeyboard.dtd">
+<keyboard locale="mt" conformsTo="techpreview">
+  <info author="srl295" indicator="🙀" layout="qwerty" normalization="NFC" />
+
+  <names>
+    <name value="TestKbd" />
+  </names>
+
+  <keys>
+    <import base="cldr" path="techpreview/too/many/slashes/leading/to/nothing-Zxxx-does-not-exist.xml"/> <!-- invalid -->
+    <key id="hmaqtugha" to="ħ" />
+    <key id="that" to="ថា" />
+  </keys>
+
+</keyboard>

package/test/fixtures/invalid-import-readfail.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE keyboard SYSTEM "../../../../../resources/standards-data/ldml-keyboards/techpreview/dtd/ldmlKeyboard.dtd">
+<keyboard locale="mt" conformsTo="techpreview">
+  <info author="srl295" indicator="🙀" layout="qwerty" normalization="NFC" />
+
+  <names>
+    <name value="TestKbd" />
+  </names>
+
+  <keys>
+    <import base="cldr" path="techpreview/none-Zxxx-does-not-exist.xml"/> <!-- invalid -->
+    <key id="hmaqtugha" to="ħ" />
+    <key id="that" to="ថា" />
+  </keys>
+
+</keyboard>

package/test/fixtures/invalid-import-wrongroot.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE keyboard SYSTEM "../../../../../resources/standards-data/ldml-keyboards/techpreview/dtd/ldmlKeyboard.dtd">
+<keyboard locale="mt" conformsTo="techpreview">
+  <info author="srl295" indicator="🙀" layout="qwerty" normalization="NFC" />
+
+  <names>
+    <import base="cldr" path="techpreview/keys-Zyyy-punctuation.xml"/> <!-- wrong root! -->
+    <name value="TestKbd" />
+  </names>
+
+  <keys>
+    <key id="hmaqtugha" to="ħ" />
+    <key id="that" to="ថា" />
+  </keys>
+
+</keyboard>

package/test/fixtures/invalid-structure-per-dtd.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+  DOCTYPE keyboard SYSTEM "../../../../../resources/standards-data/ldml-keyboards/techpreview/dtd/ldmlKeyboard.dtd"
+  Disabling doctype for this invalid file, not used by compiler, and avoids complaints in IDEs etc.
+-->
+<keyboard locale="mt" conformsTo="techpreview">
+</keyboard>