Added KLE typing for ghosted, stepped, homing. Export ValidateFunctio…

…n from index
the-via · Jan 29, 2023 · c2e5ad4 · c2e5ad4
1 parent d91b2ca
commit c2e5ad4
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 12 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -1,6 +1,9 @@
 export {isVIADefinitionV3} from './validated-types/via-definition-v3.validator';
 export {isVIADefinitionV2} from './validated-types/via-definition-v2.validator';
-export {isKeyboardDefinitionV3} from './validated-types/keyboard-definition-v3.validator';
+export {
+  isKeyboardDefinitionV3,
+  ValidateFunction,
+} from './validated-types/keyboard-definition-v3.validator';
 export {isKeyboardDefinitionV2} from './validated-types/keyboard-definition-v2.validator';
 export * from './transform';
 export * from './kle-parser';

diff --git a/src/types.common.ts b/src/types.common.ts
@@ -22,6 +22,18 @@ export type OptionalDimensions = Partial<{
   w2: number;
 }>;
 
+export type Ghosted = {
+  g: boolean;
+};
+
+export type Stepped = {
+  l: boolean;
+};
+
+export type Homing = {
+  n: boolean;
+};
+
 export type Decal = {
   d: boolean;
 };
@@ -43,7 +55,15 @@ export type Dimensions = {
   h: number;
 };
 export type KLEElem =
-  | Partial<KLEDimensions & Formatting & Decal & OptionalDimensions>
+  | Partial<
+      KLEDimensions &
+        OptionalDimensions &
+        Formatting &
+        Ghosted &
+        Stepped &
+        Homing &
+        Decal
+    >
   | string;
 export type ColorCount = {[key: string]: number};
 export type ParsedKLE = {

diff --git a/test/data/v2_invalid_label_map.json b/test/data/v2_invalid_label_map.json
@@ -5,9 +5,7 @@
   "lighting": "wt_rgb_backlight",
   "matrix": {"rows": 5, "cols": 14},
   "layouts": {
-    "labels": [
-      ["Bottom Row", "HHKB", "Full"]
-    ],
+    "labels": [["Bottom Row", "HHKB", "Full"]],
     "keymap": [
       [
         {
@@ -24,6 +22,9 @@
           "y": 15,
           "y2": 1,
           "h": 10,
+          "g": true,
+          "l": true,
+          "n": true,
           "a": 1
         },
         "0,0",
@@ -189,4 +190,4 @@
       ]
     ]
   }
-}
+}
diff --git a/test/data/v2_valid_definition.json b/test/data/v2_valid_definition.json
@@ -5,9 +5,7 @@
   "lighting": "wt_rgb_backlight",
   "matrix": {"rows": 5, "cols": 14},
   "layouts": {
-    "labels": [
-      ["Bottom Row", "HHKB", "Full"]
-    ],
+    "labels": [["Bottom Row", "HHKB", "Full"]],
     "keymap": [
       [
         {
@@ -24,6 +22,9 @@
           "y": 15,
           "y2": 1,
           "h": 10,
+          "g": true,
+          "l": true,
+          "n": true,
           "a": 0
         },
         "0,0",
@@ -189,4 +190,4 @@
       ]
     ]
   }
-}
+}
diff --git a/test/data/v3_invalid_label_map.json b/test/data/v3_invalid_label_map.json
@@ -161,6 +161,9 @@
           "y": 15,
           "y2": 1,
           "h": 10,
+          "g": true,
+          "l": true,
+          "n": true,
           "a": 1
         },
         "0,0",
@@ -266,4 +269,4 @@
       ]
     ]
   }
-}
+}
diff --git a/test/data/v3_valid_definition.json b/test/data/v3_valid_definition.json
@@ -161,6 +161,9 @@
           "y": 15,
           "y2": 1,
           "h": 10,
+          "g": true,
+          "l": true,
+          "n": true,
           "a": 0
         },
         "0,0",
@@ -266,4 +269,4 @@
       ]
     ]
   }
-}
+}