@keymanapp/common-types 17.0.85-alpha

package/test/ldml-keyboard/test-ldml-keyboard-xml-reader.ts

@@ -0,0 +1,131 @@
+import { LKKey } from './../../src/ldml-keyboard/ldml-keyboard-xml.js';
+import 'mocha';
+import {assert} from 'chai';
+import { CommonTypesMessages } from '../../src/util/common-events.js';
+import { testReaderCases } from '../helpers/reader-callback-test.js';
+
+function pluckKeysFromKeybag(keys: LKKey[], ids: string[]) {
+  return keys.filter(({id}) => ids.indexOf(id) !== -1);
+}
+
+describe('ldml keyboard xml reader tests', function () {
+  this.slow(500); // 0.5 sec -- json schema validation takes a while
+
+  testReaderCases([
+    {
+      subpath: 'invalid-structure-per-dtd.xml',
+      errors: [CommonTypesMessages.Error_SchemaValidationError({
+        instancePath: '/keyboard',
+        keyword: 'required',
+        message: `must have required property 'names'`,
+        params: 'missingProperty="names"',
+      })],
+    },
+    {
+      subpath: 'invalid-conforms-to.xml',
+      errors: [CommonTypesMessages.Error_SchemaValidationError({
+        instancePath: '/keyboard/conformsTo',
+        keyword: 'enum',
+        message: `must be equal to one of the allowed values`,
+        params: 'allowedValues="techpreview"',
+      })],
+    },
+    {
+      subpath: 'import-minimal.xml',
+      callback: (data, source, subpath, callbacks) => {
+        assert.ok(source?.keyboard?.keys);
+        const k = pluckKeysFromKeybag(source?.keyboard?.keys.key, ['a', 'b', 'c']);
+        assert.sameDeepOrderedMembers(k, [
+          {id: 'a', to: 'a'},
+          {id: 'b', to: 'b'},
+          {id: 'c', to: 'c'},
+        ]);
+      },
+    },
+    {
+      subpath: 'import-minimal1.xml',
+      callback: (data, source, subpath, callbacks) => {
+        assert.ok(source?.keyboard?.keys);
+        const k = pluckKeysFromKeybag(source?.keyboard?.keys.key, ['a', 'b', 'c']);
+        assert.sameDeepOrderedMembers(k, [
+          {id: 'a', to: 'a'},
+          {id: 'b', to: 'b'},
+          {id: 'c', to: 'c'},
+        ]);
+      },
+    },
+    {
+      subpath: 'import-minimal2.xml',
+      callback: (data, source, subpath, callbacks) => {
+        assert.ok(source?.keyboard?.keys);
+        const k = pluckKeysFromKeybag(source?.keyboard?.keys.key, ['a', 'b', 'c']);
+        assert.sameDeepOrderedMembers(k, [
+          {id: 'a', to: 'a'},
+          {id: 'b', to: 'b'},
+          {id: 'c', to: 'c'},
+          {id: 'a', to: 'å'}, // overridden
+        ]);
+      },
+    },
+    {
+      subpath: 'import-symbols.xml',
+      callback: (data, source, subpath, callbacks) => {
+        assert.ok(source?.keyboard?.keys);
+        const k = pluckKeysFromKeybag(source?.keyboard?.keys.key, ['a', 'b', 'c', 'zz', 'hash', 'hyphen']);
+        assert.sameDeepOrderedMembers(k, [
+          {id: 'a', to: 'a'},       // implied
+          {id: 'b', to: 'b'},
+          {id: 'c', to: 'c'},
+          {id: 'hash', to: '#'},    // imported symbols
+          {id: 'hyphen', to: '-'},
+          {id: 'zz', to: 'zz'},     // new key
+          {id: 'hash', to: '##'},   // override
+        ]);
+      },
+    },
+    {
+      subpath: 'invalid-import-base.xml',
+      loadfail: true,
+      errors: [
+        CommonTypesMessages.Error_ImportInvalidBase({
+          base: 'SOME_INVALID_BASE',
+          path: 'B',
+          subtag: 'C'
+        }),
+      ],
+    },
+    {
+      subpath: 'invalid-import-path.xml',
+      loadfail: true,
+      errors: [
+        CommonTypesMessages.Error_ImportInvalidPath({
+          base: null,
+          path: 'techpreview/too/many/slashes/leading/to/nothing-Zxxx-does-not-exist.xml',
+          subtag: null,
+        }),
+      ],
+    },
+    {
+      subpath: 'invalid-import-readfail.xml',
+      loadfail: true,
+      errors: [
+        CommonTypesMessages.Error_ImportReadFail({
+          base: null,
+          path: 'techpreview/none-Zxxx-does-not-exist.xml',
+          subtag: null,
+        }),
+      ],
+    },
+    {
+      subpath: 'invalid-import-wrongroot.xml',
+      loadfail: true,
+      errors: [
+        CommonTypesMessages.Error_ImportWrongRoot({
+          base: null,
+          path: 'techpreview/keys-Zyyy-punctuation.xml',
+          subtag: 'names',
+        }),
+      ],
+    },
+  ]);
+});

package/test/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "extends": "../../../../tsconfig.esm-base.json",
+
+  "compilerOptions": {
+    "rootDir": ".",
+    "rootDirs": ["./", "../src/"],
+    "outDir": "../build/test",
+    "baseUrl": ".",
+    "strictNullChecks": false, // TODO: get rid of this as some point
+    "allowSyntheticDefaultImports": true // for ajv
+  },
+  "include": [
+    "**/test-*.ts",
+    "./helpers/*.ts",
+  ],
+  "references": [
+    { "path": "../../keyman-version/tsconfig.esm.json" },
+    { "path": "../../../../core/include/ldml/"},
+    { "path": "../" },
+  ]
+}

package/test/util/test-unescape.ts

@@ -0,0 +1,38 @@
+import 'mocha';
+import {assert} from 'chai';
+import {unescapeString, UnescapeError} from '../../src/util/util.js';
+
+describe('test unescapeString()', function() {
+  it("should correctly handle multi strings", function() {
+    assert.equal(unescapeString('Sa\\u{0127 0127}a'), 'Saħħa');
+  });
+
+  it("should pass through falsy strings", function() {
+    assert.equal(unescapeString(''), '');
+    assert.equal(unescapeString(null), null);
+  });
+
+  it("should pass through non-escaped strings", function() {
+    assert.equal(unescapeString('abc'), 'abc');
+    assert.equal(unescapeString('\\u{abc'), '\\u{abc');
+  });
+
+  it("should correctly unescape strings", function() {
+    assert.equal(unescapeString('\\u{0127}'), 'ħ');
+    assert.equal(unescapeString('\\u{0127}==\\u{0127}'), 'ħ==ħ');
+    assert.equal(unescapeString('Q\\u{0127}'), 'Qħ');
+  });
+
+  it("should correctly handle 1..6 char escapes", function() {
+    assert.equal(unescapeString('\\u{9}'),      '\u{0009}');   // TAB
+    assert.equal(unescapeString('\\u{4a}'),     '\u{004a}');   // J
+    assert.equal(unescapeString('\\u{3c8}'),    '\u{03c8}');   // ψ
+    assert.equal(unescapeString('\\u{304B}'),   '\u{304b}');   // か
+    assert.equal(unescapeString('\\u{1e109}'),  '\u{1e109}');  // 𞄉
+    assert.equal(unescapeString('\\u{10fff0}'), '\u{10fff0}'); // Plane 16 Private Use
+  });
+
+  it("should throw UnescapeError on invalid escapes", function() {
+    assert.throws(() => unescapeString('\\u{110000}'), UnescapeError);
+  });
+});

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "extends": "../../../tsconfig.esm-base.json",
+
+  "compilerOptions": {
+    "outDir": "build/src/",
+    "rootDir": "src/",
+    "baseUrl": ".",
+    "allowSyntheticDefaultImports": true // for ajv
+  },
+  "include": [
+    "src/**/*.ts"
+  ],
+  "references": [
+    { "path": "../keyman-version/tsconfig.esm.json" },
+    { "path": "../../../core/include/ldml/tsconfig.json"},
+  ]
+}