chore(web): finalize removal of side-effect KMWString implementation

Author: Joshua Horton

common/test/resources/model-helpers.mjs

@@ -13,16 +13,9 @@ import vm from 'vm';
 // Ensure that we can successfully load the module & apply kmwLength, as it's
 // needed for some of the unit tests.
 
-// // Verify that the KMW string extensions are loaded via side-effect.
-
-import { extendString } from '@keymanapp/web-utils';
-
 import { createRequire } from "module";
 import { fileURLToPath } from 'url';
 
-// Ensure that our KMW string-extensions activate.
-extendString();
-
 /**
  * Creates a MessageEvent (for inter-worker communication), with the given data payload.
  *

web/src/engine/common/web-utils/src/index.ts

@@ -16,7 +16,6 @@ export { default as Version } from "./version.js";
 
 export { default as globalObject } from "./globalObject.js";
 
-export { default as extendString } from "./kmwstring.js";
 export * as KMWString from './kmwstring.js';
 
 export { default as ManagedPromise } from "./managedPromise.js";

web/src/engine/common/web-utils/src/kmwstring.ts

@@ -1,6 +1,13 @@
 /***
-   KeymanWeb 19.0
-   Copyright 2025 SIL International
+ KeymanWeb 19.0
+  Copyright 2025 SIL International
+
+  NOTE: in previous versions of Keyman Engine for Web, these methods were set on the standard
+  JS String type in a manner considered a "side-effect".  (When inspecting older versions, it may help
+  to know that they were originally implemented within a file named kmwstring.ts.)
+  *
+  These methods seek to support SMP-aware string functionality within the Web engine, as many
+  keyboards exist that utilize characters within such ranges.
 ***/
 
 /**
@@ -58,7 +65,6 @@ export function charCodeAt(s: string, index: number) {
   return first;
 }
 
-
 /**
  * Returns the code point index within the calling String object of the first occurrence
  * of the specified value, or -1 if not found.
@@ -403,29 +409,4 @@ export function charAt(s: string, index: number) { // charAtPoint
   } else {
     return ''
   };
-}
-
-/*
- * TODO:  Remove this file as part of addressing https://github.com/keymanapp/keyman/issues/2492.
- */
-
-declare global {
-  interface StringConstructor {
-    kmwEnableSupplementaryPlane(bEnable: boolean): void
-  }
-}
-
-export default function extendString() {
-  /**
-   * Enable or disable supplementary plane string handling
-   *
-   * @param  {boolean}  bEnable
-   */
-  String.kmwEnableSupplementaryPlane = function(bEnable)
-  {
-    enableSupplementaryPlane(bEnable);
-  }
-}
-
-// For side-effect imports:
-extendString();
+}

web/src/engine/common/web-utils/src/tests/stringHandling.js

@@ -5,7 +5,7 @@ import { KMWString } from '@keymanapp/web-utils';
 describe('Unicode string handling', () => {
   describe('disabled: BMP-mode, BMP-only strings',  () => {
     before(() => {
-      String.kmwEnableSupplementaryPlane(false);
+      KMWString.enableSupplementaryPlane(false);
     });
 
     it('charAt', () => {
@@ -118,7 +118,7 @@ describe('Unicode string handling', () => {
 
   describe('enabled: SMP-mode, but BMP-only strings',  () => {
     before(() => {
-      String.kmwEnableSupplementaryPlane(true);
+      KMWString.enableSupplementaryPlane(true);
     });
 
     it('charAt', () => {
@@ -237,7 +237,7 @@ describe('Unicode string handling', () => {
 
   describe('enabled: SMP-mode, with mixed-plane strings',  () => {
     before(() => {
-      String.kmwEnableSupplementaryPlane(true);
+      KMWString.enableSupplementaryPlane(true);
     });
 
     it('charAt', () => {

web/src/engine/js-processor/src/outputTarget.ts

@@ -1,10 +1,8 @@
-import { extendString, KMWString } from "@keymanapp/web-utils";
+import { KMWString } from "@keymanapp/web-utils";
 import { findCommonSubstringEndIndex } from "./stringDivergence.js";
 import { Mock } from "./mock.js";
 import { OutputTarget as OutputTargetInterface } from 'keyman/engine/keyboard';
 
-extendString();
-
 // Defines deadkey management in a manner attachable to each element interface.
 import { type KeyEvent } from 'keyman/engine/keyboard';
 import { Deadkey, DeadkeyTracker } from "./deadkeys.js";

web/src/engine/main/src/keymanEngine.ts

@@ -15,6 +15,7 @@ import { LegacyAPIEvents } from "./legacyAPIEvents.js";
 import { EventNames, EventListener, LegacyEventEmitter } from "keyman/engine/events";
 import DOMCloudRequester from "keyman/engine/keyboard-storage/dom-requester";
 import KEYMAN_VERSION from "@keymanapp/keyman-version";
+import { KMWString } from "@keymanapp/web-utils";
 
 // From https://stackoverflow.com/a/69328045
 type WithRequired<T, K extends keyof T> = T & { [P in K]-?: T[P] };
@@ -237,7 +238,7 @@ export default class KeymanEngine<
     config.initialize(optionSpec);
 
     // Initialize supplementary plane string extensions
-    String.kmwEnableSupplementaryPlane(true);
+    KMWString.enableSupplementaryPlane(true);
 
     // Since we're not sandboxing keyboard loads yet, we just use `window` as the jsGlobal object.
     // All components initialized below require a properly-configured `config.paths` or similar.

web/src/engine/predictive-text/templates/src/common.ts

@@ -6,9 +6,7 @@ import Outcome = LexicalModelTypes.Outcome;
 import Suggestion = LexicalModelTypes.Suggestion;
 import Transform = LexicalModelTypes.Transform;
 import WithOutcome = LexicalModelTypes.WithOutcome;
-import { extendString, KMWString } from "@keymanapp/web-utils";
-
-extendString();
+import { KMWString } from "@keymanapp/web-utils";
 
 export const SENTINEL_CODE_UNIT = '\uFDD0';
 

web/src/engine/predictive-text/templates/src/trie-model.ts

@@ -25,8 +25,7 @@
 // Worth noting:  we're starting to get quite a 'library' of common model/LMLayer functionality.
 // Should probably make a 'lm-utils' submodule.
 
-// Allows the kmwstring bindings to resolve.
-import { extendString, KMWString, PriorityQueue } from "@keymanapp/web-utils";
+import { KMWString, PriorityQueue } from "@keymanapp/web-utils";
 import { default as defaultWordBreaker } from "@keymanapp/models-wordbreakers";
 
 import { applyTransform, isHighSurrogate, isSentinel, SENTINEL_CODE_UNIT, transformToSuggestion } from "./common.js";
@@ -47,8 +46,6 @@ import USVString = LexicalModelTypes.USVString;
 import WithOutcome = LexicalModelTypes.WithOutcome;
 import WordBreakingFunction = LexicalModelTypes.WordBreakingFunction;
 
-extendString();
-
 /**
  * @file trie-model.ts
  *

web/src/engine/predictive-text/templates/tests/helpers.js

@@ -7,13 +7,14 @@ var _ = global;
 // TODO: then mocha invocation is as follows:
 // TODO:     mocha -r @keymanapp/models-test-helpers test/
 
-import { extendString } from '@keymanapp/web-utils';
+import { KMWString } from '@keymanapp/web-utils';
+
+// The predictive-text engine always keeps these enabled.
+KMWString.enableSupplementaryPlane(true);
 
 import { createRequire } from "module";
 import { fileURLToPath } from 'url';
 
-extendString();
-
 /**
  * Load JSON fixtures from a well-known place.
  */

web/src/engine/predictive-text/worker-thread/src/main/index.ts

@@ -30,9 +30,6 @@
  */
 
 /// <reference types="@keymanapp/lm-message-types" />
-import { extendString } from "@keymanapp/web-utils";
-
-extendString();
 
 import * as models from './models/index.js';
 import * as correction from './correction/index.js';