refactor(web): rename VariableStore → VariableStores

Addresses code review comments.

Test-bot: skip

Author: ermshiperete

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

@@ -21,7 +21,7 @@ import {
   type Deadkey,
   type KeyEvent,
   type TextStore,
-  VariableStore,
+  VariableStores,
   VariableStoreSerializer,
 } from "keyman/engine/keyboard";
 import { PlatformSystemStore } from './platformSystemStore.js';
@@ -963,7 +963,7 @@ export class JSKeyboardInterface extends KeyboardHarness {
     }
 
     // And the lookup under that entry looks for the value under the store name, again.
-    const valueObj: VariableStore = {};
+    const valueObj: VariableStores = {};
     valueObj[storeName] = optValue;
 
     // Null-check in case of invocation during unit-test
@@ -1102,7 +1102,7 @@ export class JSKeyboardInterface extends KeyboardHarness {
    * @param stores A dictionary of stores which should be found in the
    *               keyboard
    */
-  applyVariableStores(stores: VariableStore): void {
+  applyVariableStores(stores: VariableStores): void {
     this.activeKeyboard.variableStores = stores;
   }
 

web/src/engine/src/keyboard/index.ts

@@ -30,7 +30,7 @@ export { EmulationKeystrokes, LogMessages, DefaultRules } from "./defaultRules.j
 export { type KeyDistribution, KeyEventSpec, KeyEvent } from "./keyEvent.js";
 export { KeyMapping } from "./keyMapping.js";
 export { type SystemStoreMutationHandler, MutableSystemStore, SystemStore, SystemStoreIDs, type SystemStoreDictionary } from "./systemStore.js";
-export { type VariableStore, VariableStoreSerializer } from "./variableStore.js";
+export { type VariableStores, VariableStoreSerializer } from "./variableStores.js";
 
 export { DOMKeyboardLoader } from './keyboards/loaders/domKeyboardLoader.js';
 export { SyntheticTextStore } from "./syntheticTextStore.js";

web/src/engine/src/keyboard/keyboards/jsKeyboard.ts

@@ -4,7 +4,7 @@ import { ActiveKey, ActiveLayout, ActiveSubKey } from "./activeLayout.js";
 import { KeyEvent } from "../keyEvent.js";
 import { type TextStore } from "../textStore.js";
 import { KeymanWebKeyboard, ModifierKeyConstants, TouchLayout } from "@keymanapp/common-types";
-import { VariableStore } from "../variableStore.js";
+import { VariableStores } from "../variableStores.js";
 
 import ComplexKeyboardStore = KeymanWebKeyboard.ComplexKeyboardStore;
 import KeyboardObject = KeymanWebKeyboard.KeyboardObject;
@@ -120,11 +120,11 @@ export class JSKeyboard {
    *
    * @returns an object with each property referencing a variable store
    */
-  get variableStores(): VariableStore {
+  get variableStores(): VariableStores {
     const storeNames = this.scriptObject['KVS'];
-    let values: VariableStore = {};
+    const values: VariableStores = {};
     if(Array.isArray(storeNames)) {
-      for(let store of storeNames) {
+      for(const store of storeNames) {
         values[store] = this.scriptObject[store];
       }
     }
@@ -139,10 +139,10 @@ export class JSKeyboard {
    *
    * @param values  name-value pairs for each store value
    */
-  set variableStores(values: VariableStore) {
+  set variableStores(values: VariableStores) {
     const storeNames = this.scriptObject['KVS'];
     if(Array.isArray(storeNames)) {
-      for(let store of storeNames) {
+      for(const store of storeNames) {
         // If the value is not present in the cache, don't overwrite it;
         // while this is not used in initial implementation, we could use
         // it in future to update a single variable store value rather than

web/src/engine/src/keyboard/keyboards/processorAction.ts

@@ -3,7 +3,7 @@
  */
 import { LexicalModelTypes } from '@keymanapp/common-types';
 import { Transcription } from './transcription.js';
-import { VariableStore } from '../variableStore.js';
+import { VariableStores } from '../variableStores.js';
 import { SystemStoreDictionary } from '../systemStore.js';
 
 /**
@@ -29,12 +29,12 @@ export class ProcessorAction {
   /**
    * A set of variable stores with save requests triggered by the matched keyboard rule
    */
-  saveStore: {[name: string]: VariableStore} = {};
+  saveStore: {[name: string]: VariableStores} = {};
 
   /**
    * A set of variable stores with possible changes to be applied during finalization.
    */
-  variableStores: VariableStore = {};
+  variableStores: VariableStores = {};
 
   /**
    * Denotes a non-output default behavior; this should be evaluated later, against the true keystroke.

…src/engine/src/keyboard/variableStore.ts …rc/engine/src/keyboard/variableStores.tsweb/src/engine/src/keyboard/variableStore.ts renamed to web/src/engine/src/keyboard/variableStores.ts web/src/engine/src/keyboard/variableStore.ts renamed to web/src/engine/src/keyboard/variableStores.ts

@@ -4,10 +4,10 @@
  * Definitions for variable stores (see kmn reference)
  */
 
-export type VariableStore = { [name: string]: string; };
+export type VariableStores = { [name: string]: string; };
 
 export interface VariableStoreSerializer {
-  loadStore(keyboardID: string, storeName: string): VariableStore;
-  saveStore(keyboardID: string, storeName: string, storeMap: VariableStore): void;
-  findStores(keyboardID: string): VariableStore[];
+  loadStore(keyboardID: string, storeName: string): VariableStores;
+  saveStore(keyboardID: string, storeName: string, storeMap: VariableStores): void;
+  findStores(keyboardID: string): VariableStores[];
 }

web/src/engine/src/main/variableStoreCookieSerializer.ts

@@ -1,4 +1,4 @@
-import { VariableStore, VariableStoreSerializer } from 'keyman/engine/keyboard';
+import { VariableStores, VariableStoreSerializer } from 'keyman/engine/keyboard';
 import { CookieSerializer } from "keyman/engine/dom-utils";
 
 // While there's little reason we couldn't store all of a keyboard's store values within
@@ -14,13 +14,13 @@ export class VariableStoreCookieSerializer implements VariableStoreSerializer {
     return `KeymanWeb_${keyboardID}_Option_${storeName}`;
   }
 
-  public loadStore(keyboardID: string, storeName: string): VariableStore {
-    const storeCookieSerializer = new CookieSerializer<VariableStore>(this.getStoreCookieName(keyboardID, storeName));
+  public loadStore(keyboardID: string, storeName: string): VariableStores {
+    const storeCookieSerializer = new CookieSerializer<VariableStores>(this.getStoreCookieName(keyboardID, storeName));
     return storeCookieSerializer.load(decodeURIComponent);
   }
 
-  public saveStore(keyboardID: string, storeName: string, storeMap: VariableStore) {
-    const storeCookieSerializer = new CookieSerializer<VariableStore>(this.getStoreCookieName(keyboardID, storeName));
+  public saveStore(keyboardID: string, storeName: string, storeMap: VariableStores) {
+    const storeCookieSerializer = new CookieSerializer<VariableStores>(this.getStoreCookieName(keyboardID, storeName));
     storeCookieSerializer.save(storeMap, encodeURIComponent);
   }
 
@@ -29,11 +29,11 @@ export class VariableStoreCookieSerializer implements VariableStoreSerializer {
    *
    * @param {string}  keyboardID  The keyboard ID whose variable stores are to be found.
    *
-   * @returns An array of VariableStore objects found for the keyboard.
+   * @returns An array of VariableStores objects found for the keyboard.
    */
-  public findStores(keyboardID: string): VariableStore[] {
+  public findStores(keyboardID: string): VariableStores[] {
     const pattern = new RegExp(`^${this.getStoreCookieName(keyboardID, '')}`);
-    const matching = CookieSerializer.loadAllMatching<VariableStore>(pattern, decodeURIComponent);
+    const matching = CookieSerializer.loadAllMatching<VariableStores>(pattern, decodeURIComponent);
     return matching.map(m => m.value);
   }
 }

web/src/test/auto/dom/cases/main/variableStoreCookieSerializer.tests.ts

@@ -2,7 +2,7 @@
  * Keyman is copyright (C) SIL Global. MIT License.
  */
 import { assert } from 'chai';
-import { VariableStore } from 'keyman/engine/keyboard';
+import { VariableStores } from 'keyman/engine/keyboard';
 import { VariableStoreCookieSerializer } from 'keyman/engine/main';
 
 describe('VariableStoreCookieSerializer', () => {
@@ -18,7 +18,7 @@ describe('VariableStoreCookieSerializer', () => {
     it('should save and load a simple store with string values', () => {
       // Arrange
       const serializer = new VariableStoreCookieSerializer();
-      const storeData: VariableStore = {
+      const storeData: VariableStores = {
         option1: 'value1',
         option2: 'value2',
         option3: 'value3'
@@ -35,7 +35,7 @@ describe('VariableStoreCookieSerializer', () => {
     it('should save and load a store with empty values', () => {
       // Arrange
       const serializer = new VariableStoreCookieSerializer();
-      const storeData: VariableStore = {
+      const storeData: VariableStores = {
         option1: '',
         option2: 'value',
         option3: ''
@@ -52,7 +52,7 @@ describe('VariableStoreCookieSerializer', () => {
     it('should save and load a store with special characters', () => {
       // Arrange
       const serializer = new VariableStoreCookieSerializer();
-      const storeData: VariableStore = {
+      const storeData: VariableStores = {
         encoded: 'value:with;special&chars=',
         emoji: '⭐'
       };
@@ -68,8 +68,8 @@ describe('VariableStoreCookieSerializer', () => {
     it('should handle multiple stores for the same keyboard independently', () => {
       // Arrange
       const serializer = new VariableStoreCookieSerializer();
-      const store1Data: VariableStore = { option: 'store1value' };
-      const store2Data: VariableStore = { option: 'store2value' };
+      const store1Data: VariableStores = { option: 'store1value' };
+      const store2Data: VariableStores = { option: 'store2value' };
 
       // Act
       serializer.saveStore(keyboardID, 'store1', store1Data);
@@ -104,7 +104,7 @@ describe('VariableStoreCookieSerializer', () => {
       // Arrange
       const serializer = new VariableStoreCookieSerializer();
       const keyboardID = 'test-keyboard';
-      const expected: VariableStore[] = [];
+      const expected: VariableStores[] = [];
 
       // Act
       const result = serializer.findStores(keyboardID);
@@ -118,13 +118,13 @@ describe('VariableStoreCookieSerializer', () => {
     it('should return store for keyboard', () => {
       // Arrange
       const serializer = new VariableStoreCookieSerializer();
-      const storeData1: VariableStore = {
+      const storeData1: VariableStores = {
         option1: 'value1',
         option2: 'value2',
         option3: 'value3'
       };
       serializer.saveStore('test-keyboard', 'storeName', storeData1);
-      const storeData2: VariableStore = {
+      const storeData2: VariableStores = {
         settingA: 'A',
         settingB: 'B'
       };