Merge pull request #12101 from keymanapp/refactor/common/9665-move-xm…

…l2js-and-related-deps-to-developer

refactor(common): move xml2js and related deps to @keymanapp/developer-utils 🐉

common/web/types/build.sh

@@ -82,7 +82,7 @@ function do_configure() {
 function do_test() {
   eslint .
   tsc --build test
-  readonly C8_THRESHOLD=40
+  readonly C8_THRESHOLD=50
   c8 -skip-full --reporter=lcov --reporter=text --lines $C8_THRESHOLD --statements $C8_THRESHOLD --branches $C8_THRESHOLD --functions $C8_THRESHOLD mocha "${builder_extra_params[@]}"
   builder_echo warning "Coverage thresholds are currently $C8_THRESHOLD%, which is lower than ideal."
   builder_echo warning "Please increase threshold in build.sh as test coverage improves."

common/web/types/package.json

@@ -31,24 +31,17 @@
   "dependencies": {
     "@keymanapp/ldml-keyboard-constants": "*",
     "@keymanapp/keyman-version": "*",
-    "restructure": "3.0.1",
-    "semver": "^7.5.2",
-    "sax": ">=0.6.0",
-    "xmlbuilder": "~11.0.0"
+    "restructure": "3.0.1"
   },
   "devDependencies": {
     "@types/chai": "^4.1.7",
-    "@types/git-diff": "^2.0.3",
     "@types/mocha": "^5.2.7",
     "@types/node": "^20.4.1",
-    "@types/semver": "^7.3.12",
-    "@types/xml2js": "^0.4.5",
     "ajv": "^8.12.0",
     "ajv-cli": "^5.0.0",
     "ajv-formats": "^2.1.1",
     "c8": "^7.12.0",
     "chalk": "^2.4.2",
-    "git-diff": "^2.0.6",
     "hexy": "^0.3.4",
     "mocha": "^8.4.0",
     "typescript": "^5.4.5"

common/web/types/src/main.ts

@@ -24,8 +24,6 @@ export * as KeymanFileTypes from './util/file-types.js';
 export * as Schemas from './schemas.js';
 export * as SchemaValidators from './schema-validators.js';
 
-export * as xml2js from './deps/xml2js/xml2js.js';
-
 export * as KMXPlus from './kmx/kmx-plus/kmx-plus.js';
 // TODO: these exports are really not well named
 export { UnicodeSetParser, UnicodeSet } from './ldml-keyboard/unicodeset-parser-api.js';

common/web/types/tsconfig.json

@@ -9,7 +9,6 @@
     "preserveConstEnums": true,
   },
   "include": [
-    "src/deps/xml2js/*.js",
     "src/**/*.ts",
     "src/schemas/*.mjs", // Import the validators
   ],

developer/src/common/web/utils/build.sh

@@ -53,7 +53,7 @@ builder_run_action build       do_build
 if builder_start_action test; then
   eslint .
   tsc --build test
-  readonly C8_THRESHOLD=45
+  readonly C8_THRESHOLD=40
   c8 --reporter=lcov --reporter=text --exclude-after-remap --lines $C8_THRESHOLD --statements $C8_THRESHOLD --branches $C8_THRESHOLD --functions $C8_THRESHOLD mocha
   builder_echo warning "Coverage thresholds are currently $C8_THRESHOLD%, which is lower than ideal."
   builder_echo warning "Please increase threshold in build.sh as test coverage improves."

developer/src/common/web/utils/package.json

@@ -10,11 +10,18 @@
   ],
   "dependencies": {
     "@sentry/node": "^7.57.0",
-    "restructure": "^3.0.1"
+    "restructure": "^3.0.1",
+    "semver": "^7.5.2",
+    "sax": ">=0.6.0",
+    "xmlbuilder": "~11.0.0"
   },
   "devDependencies": {
+    "@types/git-diff": "^2.0.3",
     "@types/node": "^20.4.1",
+    "@types/semver": "^7.3.12",
+    "@types/xml2js": "^0.4.5",
     "c8": "^7.12.0",
+    "git-diff": "^2.0.6",
     "mocha": "^8.4.0",
     "typescript": "^5.4.5"
   },

developer/src/common/web/utils/src/index.ts

@@ -43,3 +43,5 @@ export { defaultCompilerOptions, CompilerBaseOptions, CompilerCallbacks, Compile
   } from './compiler-interfaces.js';
 
 export { CommonTypesMessages } from './common-events.js';
+
+export * as xml2js from './deps/xml2js/xml2js.js';

developer/src/common/web/utils/src/types/kpj/kpj-file-reader.ts

@@ -1,4 +1,4 @@
-import { xml2js } from '@keymanapp/common-types';
+import { xml2js } from '../../index.js';
 import { KPJFile, KPJFileProject } from './kpj-file.js';
 import { util } from '@keymanapp/common-types';
 import { KeymanDeveloperProject, KeymanDeveloperProjectFile10, KeymanDeveloperProjectType } from './keyman-developer-project.js';

developer/src/common/web/utils/src/types/kvks/kvks-file-reader.ts

@@ -1,4 +1,5 @@
-import { SchemaValidators as SV, KvkFile, xml2js, util, Constants } from '@keymanapp/common-types';
+import { SchemaValidators as SV, KvkFile, util, Constants } from '@keymanapp/common-types';
+import { xml2js } from '../../index.js'
 import KVKSourceFile from './kvks-file.js';
 const SchemaValidators = SV.default;
 import boxXmlArray = util.boxXmlArray;

developer/src/common/web/utils/src/types/kvks/kvks-file-writer.ts

@@ -1,5 +1,6 @@
-import { VisualKeyboard as VK, Constants, xml2js } from '@keymanapp/common-types';
+import { VisualKeyboard as VK, Constants } from '@keymanapp/common-types';
 import KVKSourceFile, { KVKSEncoding, KVKSFlags, KVKSKey, KVKSLayer } from './kvks-file.js';
+import { xml2js } from '../../index.js';
 
 import USVirtualKeyCodes = Constants.USVirtualKeyCodes;
 import VisualKeyboard = VK.VisualKeyboard;

developer/src/common/web/utils/src/types/ldml-keyboard/ldml-keyboard-xml-reader.ts

@@ -1,4 +1,5 @@
-import { SchemaValidators, util, xml2js } from '@keymanapp/common-types';
+import { SchemaValidators, util } from '@keymanapp/common-types';
+import { xml2js } from '../../index.js';
 import { CommonTypesMessages } from '../../common-events.js';
 import { CompilerCallbacks } from '../../compiler-interfaces.js';
 import { LDMLKeyboardXMLSourceFile, LKImport, ImportStatus } from './ldml-keyboard-xml.js';

developer/src/common/web/utils/tsconfig.json

@@ -8,5 +8,6 @@
     },
   "include": [
     "src/**/*.ts",
+    "src/deps/xml2js/*.js",
   ],
 }

developer/src/kmc-package/src/compiler/kmp-compiler.ts

@@ -1,4 +1,4 @@
-import { xml2js } from '@keymanapp/common-types';
+import { xml2js } from '@keymanapp/developer-utils';
 import JSZip from 'jszip';
 import KEYMAN_VERSION from "@keymanapp/keyman-version";