change(common/web): keyboard processor package modularization 🧩

common/test/resources/keyboards/khmer_angkor.js

@@ -6,8 +6,17 @@ KeymanWeb.KR(new Keyboard_khmer_angkor());
 }
 function Keyboard_khmer_angkor()
 {
-  var modCodes = com.keyman.text.Codes.modifierCodes;
-  var keyCodes = com.keyman.text.Codes.keyCodes;
+  var Codes, modCodes, keyCodes;
+
+  if(KeymanWeb.Codes) {
+    // ES Module attachment point
+    Codes = KeymanWeb.Codes;
+  } else if (typeof com != 'undefined' && com.keyman && com.keyman.text && com.keyman.text.Codes) {
+    // Pre-modularized attachment point
+    Codes = com.keyman.text.Codes;
+  }
+  var modCodes = Codes.modifierCodes;
+  var keyCodes = Codes.keyCodes;
 
   this.KI="Keyboard_khmer_angkor";
   this.KN="Khmer Angkor";
@@ -2804,7 +2813,7 @@ function Keyboard_khmer_angkor()
       k.KO(-1,t,"»");
     }
     if(m) {
-    
+
       k.KDC(-1,t);
       r=this.g_normalise(t,e);
     }

common/test/resources/keyboards/test_deadkeys.js

@@ -6,8 +6,17 @@ KeymanWeb.KR(new Keyboard_test_deadkeys());
 }
 function Keyboard_test_deadkeys()
 {
-  var modCodes = com.keyman.text.Codes.modifierCodes;
-  var keyCodes = com.keyman.text.Codes.keyCodes;
+  var Codes, modCodes, keyCodes;
+
+  if(KeymanWeb.Codes) {
+    // ES Module attachment point
+    Codes = KeymanWeb.Codes;
+  } else if (typeof com != 'undefined' && com.keyman && com.keyman.text && com.keyman.text.Codes) {
+    // Pre-modularized attachment point
+    Codes = com.keyman.text.Codes;
+  }
+  var modCodes = Codes.modifierCodes;
+  var keyCodes = Codes.keyCodes;
 
   this.KI="Keyboard_test_deadkeys";
   this.KN="Keyman Deadkey Stress-Tester";
@@ -325,7 +334,7 @@ function Keyboard_test_deadkeys()
       k.KDO(-1,t,17);
     }
     if(m) {
-    
+
       k.KDC(-1,t);
       r=this.g_dead_reorder(t,e);
     }

common/test/resources/keyboards/web_context_tests.js

@@ -6,8 +6,17 @@ KeymanWeb.KR(new Keyboard_web_context_tests());
 }
 function Keyboard_web_context_tests()
 {
-  var modCodes = keyman.osk.modifierCodes;
-  var keyCodes = keyman.osk.keyCodes;
+  var Codes, modCodes, keyCodes;
+
+  if(KeymanWeb.Codes) {
+    // ES Module attachment point
+    Codes = KeymanWeb.Codes;
+  } else if (typeof com != 'undefined' && com.keyman && com.keyman.text && com.keyman.text.Codes) {
+    // Pre-modularized attachment point
+    Codes = com.keyman.text.Codes;
+  }
+  var modCodes = Codes.modifierCodes;
+  var keyCodes = Codes.keyCodes;
 
   this._v=(typeof keyman!="undefined"&&typeof keyman.version=="string")?parseInt(keyman.version,10):9;
   this.KI="Keyboard_web_context_tests";

common/web/input-processor/src/tsconfig.json

@@ -16,7 +16,7 @@
   "references": [
     { "path": "../../keyman-version" },
     { "path": "../../utils" },
-    { "path": "../../keyboard-processor/src" },
+    { "path": "../../keyboard-processor" },
     { "path": "../../../predictive-text/browser.tsconfig.json" },
   ],
   "include": ["./**/*.ts"],

common/web/keyboard-processor/build-bundler.js

@@ -0,0 +1,43 @@
+/*
+ * Note:  while this file is not meant to exist long-term, it provides a nice
+ * low-level proof-of-concept for esbuild bundling of the various Web submodules.
+ *
+ * Add some extra code at the end of src/index.ts and run it to verify successful bundling!
+ */
+
+import esbuild from 'esbuild';
+import { spawn } from 'child_process';
+
+// Bundled ES module version
+esbuild.buildSync({
+  entryPoints: ['build/obj/index.js'],
+  bundle: true,
+  sourcemap: true,
+  format: "esm",
+  // Sets 'common/web' as a root folder for module resolution;
+  // this allows the keyman-version and utils imports to resolve.
+  //
+  // We also need to point it at the nested build output folder to resolve in-project
+  // imports when compiled - esbuild doesn't seem to pick up on the shifted base.
+  nodePaths: ['..', "build/obj"],
+  outfile: "build/lib/index.mjs",
+  tsconfig: 'tsconfig.json',
+  target: "es5"
+});
+
+// Bundled CommonJS (classic Node) module version
+esbuild.buildSync({
+  entryPoints: ['build/obj/index.js'],
+  bundle: true,
+  sourcemap: true,
+  format: "cjs",
+  // Sets 'common/web' as a root folder for module resolution;
+  // this allows the keyman-version and utils imports to resolve.
+  //
+  // We also need to point it at the nested build output folder to resolve in-project
+  // imports when compiled - esbuild doesn't seem to pick up on the shifted base.
+  nodePaths: ['..', "build/obj"],
+  outfile: "build/lib/index.cjs",
+  tsconfig: 'tsconfig.json',
+  target: "es5"
+});

common/web/keyboard-processor/build.sh

@@ -49,13 +49,16 @@ if builder_start_action clean; then
 fi
 
 if builder_start_action build; then
-  npm run tsc -- --build "$THIS_SCRIPT_PATH/src/tsconfig.json"
+  npm run tsc -- --build "$THIS_SCRIPT_PATH/tsconfig.json"
+  node ./build-bundler.js
+
+  # Declaration bundling.
+  npm run tsc -- --emitDeclarationOnly --outFile ./build/lib/index.d.ts
+
   builder_finish_action success build
 fi
 
 if builder_start_action test; then
-  npm run tsc -- --build "$THIS_SCRIPT_PATH/src/tsconfig.bundled.json"
-
   echo_heading "Running Keyboard Processor test suite"
 
   FLAGS=

common/web/keyboard-processor/package.json

@@ -35,5 +35,6 @@
     "@keymanapp/keyman-version": "*",
     "@keymanapp/web-utils": "*",
     "@types/node": "^11.9.4"
-  }
+  },
+  "type": "module"
 }

common/web/keyboard-processor/src/index.ts

@@ -0,0 +1,29 @@
+export * from "./keyboards/activeLayout.js";
+export * from "./keyboards/defaultLayouts.js";
+export { default as Keyboard } from "./keyboards/keyboard.js";
+export * from "./keyboards/keyboard.js";
+
+export { default as Codes } from "./text/codes.js";
+export * from "./text/codes.js";
+export * from "./text/deadkeys.js";
+export { default as DefaultOutput } from "./text/defaultOutput.js";
+export * from "./text/defaultOutput.js";
+export { default as KeyboardInterface } from "./text/kbdInterface.js";
+export * from "./text/kbdInterface.js";
+export { default as KeyboardProcessor } from "./text/keyboardProcessor.js";
+export * from "./text/keyboardProcessor.js";
+export { default as KeyEvent } from "./text/keyEvent.js";
+export * from "./text/keyEvent.js";
+export { default as KeyMapping } from "./text/keyMapping.js";
+export { default as OutputTarget } from "./text/outputTarget.js";
+export * from "./text/outputTarget.js";
+export { default as RuleBehavior } from "./text/ruleBehavior.js";
+export * from "./text/systemStores.js";
+
+export * from "@keymanapp/web-utils/build/obj/index.js";
+
+// At the top level, there should be no default export.
+
+// Without the line below... OutputTarget would likely be aliased there, as it's
+// the last `export { default as _ }` => `export * from` pairing seen above.
+export default undefined;