feat: alternative geometry zones

Author: aradzie

docs/translations_report.md

@@ -91,6 +91,7 @@
   "keyboard.geometry.label": "Geometry:",
   "keyboard.language.label": "Language:",
   "keyboard.layout.label": "Layout:",
+  "keyboard.zones.label": "Zones:",
   "layouts.stats.bottomRowKeys.description": "The percentage of keys typed on the Shift row, the less the better.",
   "layouts.stats.bottomRowKeys.name": "Keys on the bottom row:",
   "layouts.stats.homeRowKeys.description": "The percentage of keys typed without leaving the Caps Lock row, the more the better.",

packages/keybr-intl/lib/messages/ar.json

@@ -1,79 +1,119 @@
 import { Enum, type EnumItem } from "@keybr/lang";
+import {
+  STANDARD_MOD,
+  SYMMETRIC_MOD,
+  type ZoneModDict,
+} from "./geometry/mod.ts";
+
+export class ZoneMod implements EnumItem {
+  static readonly STANDARD = new ZoneMod(
+    "standard", //
+    "Standard",
+    STANDARD_MOD,
+  );
+  static readonly SYMMETRIC = new ZoneMod(
+    "symmetric",
+    "Symmetric",
+    SYMMETRIC_MOD,
+  );
+
+  static readonly ALL = new Enum<ZoneMod>(
+    ZoneMod.STANDARD, //
+    ZoneMod.SYMMETRIC,
+  );
+
+  static first(items: Iterable<ZoneMod>): ZoneMod {
+    return items[Symbol.iterator]().next().value ?? ZoneMod.STANDARD;
+  }
+
+  private constructor(
+    readonly id: string,
+    readonly name: string,
+    readonly mod: ZoneModDict,
+  ) {}
+
+  toString() {
+    return this.id;
+  }
+
+  toJSON() {
+    return this.id;
+  }
+}
 
 export class Geometry implements EnumItem {
   static readonly ANSI_101 = new Geometry(
     "ansi101", //
     "ANSI 101",
     "staggered",
+    ZoneMod.ALL,
   );
   static readonly ANSI_101_FULL = new Geometry(
     "ansi101full", //
     "ANSI 101 (Full)",
     "staggered",
+    ZoneMod.ALL,
   );
   static readonly ISO_102 = new Geometry(
     "iso102", //
     "ISO 102",
     "staggered",
+    ZoneMod.ALL,
   );
   static readonly ISO_102_FULL = new Geometry(
     "iso102full", //
     "ISO 102 (Full)",
     "staggered",
-  );
-  static readonly ISO_102_SYMMETRIC = new Geometry(
-    "iso102symmetric", //
-    "ISO 102 (Symmetric)",
-    "staggered",
-  );
-  static readonly ISO_102_FULL_SYMMETRIC = new Geometry(
-    "iso102fullsymmetric", //
-    "ISO 102 (Full, Symmetric)",
-    "staggered",
+    ZoneMod.ALL,
   );
   static readonly KOREAN_103 = new Geometry(
     "kr103", //
     "Korean 103",
     "staggered",
+    ZoneMod.ALL,
   );
   static readonly KOREAN_103_FULL = new Geometry(
     "kr103full", //
     "Korean 103 (Full)",
     "staggered",
+    ZoneMod.ALL,
   );
   static readonly BRAZILIAN_104 = new Geometry(
     "br104", //
     "Brazilian 104",
     "staggered",
+    ZoneMod.ALL,
   );
   static readonly BRAZILIAN_104_FULL = new Geometry(
     "br104full", //
     "Brazilian 104 (Full)",
     "staggered",
+    ZoneMod.ALL,
   );
   static readonly JAPANESE_106 = new Geometry(
     "jp106", //
     "Japanese 106",
     "staggered",
+    ZoneMod.ALL,
   );
   static readonly JAPANESE_106_FULL = new Geometry(
     "jp106full", //
     "Japanese 106 (Full)",
     "staggered",
+    ZoneMod.ALL,
   );
   static readonly MATRIX = new Geometry(
     "matrix", //
     "Matrix/Ergonomic",
     "matrix",
+    new Enum(),
   );
 
   static readonly ALL = new Enum<Geometry>(
     Geometry.ANSI_101,
     Geometry.ANSI_101_FULL,
     Geometry.ISO_102,
     Geometry.ISO_102_FULL,
-    Geometry.ISO_102_SYMMETRIC,
-    Geometry.ISO_102_FULL_SYMMETRIC,
     Geometry.KOREAN_103,
     Geometry.KOREAN_103_FULL,
     Geometry.BRAZILIAN_104,
@@ -91,6 +131,7 @@ export class Geometry implements EnumItem {
     readonly id: string,
     readonly name: string,
     readonly form: "staggered" | "matrix",
+    readonly zones: Enum<ZoneMod>,
   ) {}
 
   toString() {

packages/keybr-intl/lib/messages/bg.json

@@ -16,8 +16,6 @@ export class Layout implements XEnumItem {
       Geometry.ANSI_101_FULL,
       Geometry.ISO_102,
       Geometry.ISO_102_FULL,
-      Geometry.ISO_102_SYMMETRIC,
-      Geometry.ISO_102_FULL_SYMMETRIC,
       Geometry.MATRIX,
     ),
   );
@@ -33,8 +31,6 @@ export class Layout implements XEnumItem {
       Geometry.ANSI_101_FULL,
       Geometry.ISO_102,
       Geometry.ISO_102_FULL,
-      Geometry.ISO_102_SYMMETRIC,
-      Geometry.ISO_102_FULL_SYMMETRIC,
       Geometry.MATRIX,
     ),
   );
@@ -50,8 +46,6 @@ export class Layout implements XEnumItem {
       Geometry.ANSI_101_FULL,
       Geometry.ISO_102,
       Geometry.ISO_102_FULL,
-      Geometry.ISO_102_SYMMETRIC,
-      Geometry.ISO_102_FULL_SYMMETRIC,
       Geometry.MATRIX,
     ),
   );
@@ -147,8 +141,6 @@ export class Layout implements XEnumItem {
       Geometry.ANSI_101_FULL,
       Geometry.ISO_102,
       Geometry.ISO_102_FULL,
-      Geometry.ISO_102_SYMMETRIC,
-      Geometry.ISO_102_FULL_SYMMETRIC,
       Geometry.MATRIX,
     ),
   );
@@ -162,8 +154,6 @@ export class Layout implements XEnumItem {
     /* geometries= */ new Enum(
       Geometry.ISO_102,
       Geometry.ISO_102_FULL,
-      Geometry.ISO_102_SYMMETRIC,
-      Geometry.ISO_102_FULL_SYMMETRIC,
       Geometry.ANSI_101,
       Geometry.ANSI_101_FULL,
       Geometry.MATRIX,

packages/keybr-intl/lib/messages/ca.json

@@ -1,4 +1,4 @@
-import { Geometry } from "./geometry.ts";
+import { Geometry, ZoneMod } from "./geometry.ts";
 import { ANSI_101 } from "./geometry/ansi_101.ts";
 import { ANSI_101_FULL } from "./geometry/ansi_101_full.ts";
 import { BRAZILIAN_104 } from "./geometry/brazilian_104.ts";
@@ -10,7 +10,6 @@ import { JAPANESE_106_FULL } from "./geometry/japanese_106_full.ts";
 import { KOREAN_103 } from "./geometry/korean_103.ts";
 import { KOREAN_103_FULL } from "./geometry/korean_103_full.ts";
 import { MATRIX } from "./geometry/matrix.ts";
-import { SYMMETRIC_MOD } from "./geometry/mod.ts";
 import { Keyboard } from "./keyboard.ts";
 import { Layout } from "./layout.ts";
 import { LAYOUT_AR_SA } from "./layout/ar_sa.ts";
@@ -81,7 +80,7 @@ import { LAYOUT_TH_TH_PAT } from "./layout/th_th_pat.ts";
 import { LAYOUT_TR_TR_F } from "./layout/tr_tr_f.ts";
 import { LAYOUT_TR_TR_Q } from "./layout/tr_tr_q.ts";
 import { LAYOUT_UK_UA } from "./layout/uk_ua.ts";
-import { remapZones } from "./mod.ts";
+import { nullMod, remapZones } from "./mod.ts";
 import { KeyboardOptions } from "./settings.ts";
 import { type CharacterDict, type GeometryDict } from "./types.ts";
 
@@ -163,8 +162,6 @@ const geometries = new Map<Geometry, GeometryDict>([
   [Geometry.BRAZILIAN_104_FULL, BRAZILIAN_104_FULL],
   [Geometry.ISO_102, ISO_102],
   [Geometry.ISO_102_FULL, ISO_102_FULL],
-  [Geometry.ISO_102_SYMMETRIC, remapZones(ISO_102, SYMMETRIC_MOD)],
-  [Geometry.ISO_102_FULL_SYMMETRIC, remapZones(ISO_102_FULL, SYMMETRIC_MOD)],
   [Geometry.JAPANESE_106, JAPANESE_106],
   [Geometry.JAPANESE_106_FULL, JAPANESE_106_FULL],
   [Geometry.KOREAN_103, KOREAN_103],
@@ -179,7 +176,7 @@ export function loadKeyboard(...args: any[]): Keyboard {
   const { length } = args;
   let options: KeyboardOptions;
   if (length === 1 && (options = args[0]) instanceof KeyboardOptions) {
-    return loadImpl(options.layout, options.geometry);
+    return loadImpl(options.layout, options.geometry, options.zones);
   }
   let layout: Layout;
   if (length === 1 && (layout = args[0]) instanceof Layout) {
@@ -199,8 +196,12 @@ export function loadKeyboard(...args: any[]): Keyboard {
 function loadImpl(
   layout: Layout,
   geometry: Geometry = Geometry.first(layout.geometries),
+  zones: ZoneMod = ZoneMod.first(geometry.zones),
 ): Keyboard {
   let characterDict = layouts.get(layout)!;
   let geometryDict = geometries.get(geometry)!;
+  if (layout.mod === nullMod && zones !== ZoneMod.STANDARD) {
+    geometryDict = remapZones(geometryDict, zones.mod);
+  }
   return new Keyboard(layout, geometry, characterDict, geometryDict);
 }

packages/keybr-intl/lib/messages/cs.json

@@ -1,6 +1,6 @@
 import { Settings } from "@keybr/settings";
 import test from "ava";
-import { Geometry } from "./geometry.ts";
+import { Geometry, ZoneMod } from "./geometry.ts";
 import { Language } from "./language.ts";
 import { Layout } from "./layout.ts";
 import { KeyboardOptions, keyboardProps } from "./settings.ts";
@@ -11,6 +11,7 @@ test("defaults", (t) => {
   t.is(options.language, Language.EN);
   t.is(options.layout, Layout.EN_US);
   t.is(options.geometry, Geometry.ANSI_101);
+  t.is(options.zones, ZoneMod.STANDARD);
 });
 
 test("from user settings", (t) => {
@@ -20,30 +21,35 @@ test("from user settings", (t) => {
     t.is(options.language, Language.EN);
     t.is(options.layout, Layout.EN_US);
     t.is(options.geometry, Geometry.ANSI_101);
+    t.is(options.zones, ZoneMod.STANDARD);
   }
 
   {
     const options = KeyboardOptions.from(
       new Settings()
         .set(keyboardProps.layout, Layout.EN_US)
-        .set(keyboardProps.geometry, Geometry.ISO_102),
+        .set(keyboardProps.geometry, Geometry.ISO_102)
+        .set(keyboardProps.zones, ZoneMod.STANDARD),
     );
 
     t.is(options.language, Language.EN);
     t.is(options.layout, Layout.EN_US);
     t.is(options.geometry, Geometry.ISO_102);
+    t.is(options.zones, ZoneMod.STANDARD);
   }
 
   {
     const options = KeyboardOptions.from(
       new Settings()
         .set(keyboardProps.layout, Layout.EN_JP)
-        .set(keyboardProps.geometry, Geometry.ANSI_101),
+        .set(keyboardProps.geometry, Geometry.ANSI_101)
+        .set(keyboardProps.zones, ZoneMod.SYMMETRIC),
     );
 
     t.is(options.language, Language.EN);
     t.is(options.layout, Layout.EN_JP);
     t.is(options.geometry, Geometry.JAPANESE_106);
+    t.is(options.zones, ZoneMod.SYMMETRIC);
   }
 });
 
@@ -54,6 +60,7 @@ test("update properties", (t) => {
     t.is(options.language, Language.FR);
     t.is(options.layout, Layout.FR_FR);
     t.is(options.geometry, Geometry.ISO_102);
+    t.is(options.zones, ZoneMod.STANDARD);
   }
 
   {
@@ -64,6 +71,7 @@ test("update properties", (t) => {
     t.is(options.language, Language.FR);
     t.is(options.layout, Layout.FR_CA);
     t.is(options.geometry, Geometry.ISO_102);
+    t.is(options.zones, ZoneMod.STANDARD);
   }
 
   {
@@ -75,5 +83,19 @@ test("update properties", (t) => {
     t.is(options.language, Language.FR);
     t.is(options.layout, Layout.FR_CA);
     t.is(options.geometry, Geometry.ANSI_101);
+    t.is(options.zones, ZoneMod.STANDARD);
+  }
+
+  {
+    const options = KeyboardOptions.default()
+      .withLanguage(Language.FR)
+      .withLayout(Layout.FR_CA)
+      .withGeometry(Geometry.ANSI_101)
+      .withZones(ZoneMod.SYMMETRIC);
+
+    t.is(options.language, Language.FR);
+    t.is(options.layout, Layout.FR_CA);
+    t.is(options.geometry, Geometry.ANSI_101);
+    t.is(options.zones, ZoneMod.SYMMETRIC);
   }
 });