✨ support per-profile default keymaps

Author: peppapighs

src/lib/configurator/remap/remap-menubar.svelte

@@ -18,12 +18,13 @@ this program. If not, see <https://www.gnu.org/licenses/>.
   import LayerSelect from "$lib/components/layer-select.svelte"
   import { Button } from "$lib/components/ui/button"
   import { keyboardContext } from "$lib/keyboard"
-  import { remapStateContext } from "../context.svelte"
+  import { globalStateContext, remapStateContext } from "../context.svelte"
   import { keymapQueryContext } from "../queries/keymap-query.svelte"
 
+  const { profile } = globalStateContext.get()
   const remapState = remapStateContext.get()
   const { layer } = $derived(remapState)
-  const { defaultKeymap } = keyboardContext.get().metadata
+  const { defaultKeymaps } = keyboardContext.get().metadata
 
   const keymapQuery = keymapQueryContext.get()
 </script>
@@ -33,7 +34,11 @@ this program. If not, see <https://www.gnu.org/licenses/>.
   <div class="flex items-center gap-2">
     <Button
       onclick={() =>
-        keymapQuery.set({ layer, offset: 0, data: defaultKeymap[layer] })}
+        keymapQuery.set({
+          layer,
+          offset: 0,
+          data: defaultKeymaps[profile][layer],
+        })}
       size="sm"
       variant="destructive"
     >

src/lib/keyboard/demo-keyboard.svelte.ts

@@ -42,7 +42,7 @@ import type {
 } from "."
 import { demoMetadata } from "./metadata"
 
-const { adcResolution, numProfiles, numKeys, numAdvancedKeys, defaultKeymap } =
+const { adcResolution, numProfiles, numKeys, numAdvancedKeys, defaultKeymaps } =
   demoMetadata
 
 type DemoKeyboardProfileState = {
@@ -54,19 +54,21 @@ type DemoKeyboardProfileState = {
   tickRate: number
 }
 
-const defaultProfile: DemoKeyboardProfileState = {
-  keymap: defaultKeymap,
-  actuationMap: [...Array(numKeys)].fill(defaultActuation),
-  advancedKeys: [...Array(numAdvancedKeys)].fill(defaultAdvancedKey),
-  gamepadButtons: Array(numKeys).fill(HMK_GamepadButton.NONE),
-  gamepadOptions: {
-    analogCurve: analogCurvePresets[0].curve,
-    keyboardEnabled: true,
-    gamepadOverride: false,
-    squareJoystick: false,
-    snappyJoystick: true,
-  },
-  tickRate: DEFAULT_TICK_RATE,
+function defaultProfile(profile: number): DemoKeyboardProfileState {
+  return {
+    keymap: defaultKeymaps[profile],
+    actuationMap: Array(numKeys).fill(defaultActuation),
+    advancedKeys: Array(numAdvancedKeys).fill(defaultAdvancedKey),
+    gamepadButtons: Array(numKeys).fill(HMK_GamepadButton.NONE),
+    gamepadOptions: {
+      analogCurve: analogCurvePresets[0].curve,
+      keyboardEnabled: true,
+      gamepadOverride: false,
+      squareJoystick: false,
+      snappyJoystick: true,
+    },
+    tickRate: DEFAULT_TICK_RATE,
+  }
 }
 
 type DemoKeyboardState = {
@@ -86,8 +88,8 @@ export class DemoKeyboard implements Keyboard {
       saveBottomOutThreshold: true,
       highPollingRateEnabled: true,
     },
-    profiles: [...Array(numProfiles)].map(() =>
-      structuredClone(defaultProfile),
+    profiles: [...Array(numProfiles)].map((_, i) =>
+      structuredClone(defaultProfile(i)),
     ),
   }
 
@@ -118,7 +120,7 @@ export class DemoKeyboard implements Keyboard {
     this.#state.options = data
   }
   async resetProfile({ profile }: ResetProfileParams) {
-    this.#state.profiles[profile] = structuredClone(defaultProfile)
+    this.#state.profiles[profile] = structuredClone(defaultProfile(profile))
   }
   async duplicateProfile({ profile, srcProfile }: DuplicateProfileParams) {
     this.#state.profiles[profile] = structuredClone(

src/lib/keyboard/metadata.ts

@@ -106,22 +106,59 @@ export const keyboardMetadataSchema = z
     numAdvancedKeys: z.int().min(1).max(HMK_MAX_NUM_ADVANCED_KEYS),
 
     layout: keyboardLayoutSchema,
-    defaultKeymap: z.array(z.array(keycodeSchema)),
+    defaultKeymap: z.array(z.array(keycodeSchema)).optional(),
+    defaultKeymaps: z.array(z.array(z.array(keycodeSchema))).optional(),
   })
-  .superRefine((val, ctx) => {
-    if (val.defaultKeymap.length !== val.numLayers) {
+  .transform((val, ctx) => {
+    const getDefaultKeymaps = () => {
+      const defaultKeymaps = val.defaultKeymaps
+      if (defaultKeymaps !== undefined) {
+        return defaultKeymaps
+      } else {
+        const defaultKeymap = val.defaultKeymap
+        return defaultKeymap === undefined
+          ? undefined
+          : [...Array(val.numProfiles)].map(() =>
+              defaultKeymap.map((layer) => [...layer]),
+            )
+      }
+    }
+
+    const defaultKeymaps = getDefaultKeymaps()
+    if (defaultKeymaps === undefined) {
+      ctx.addIssue({
+        code: "custom",
+        message: "Expected either defaultKeymap or defaultKeymaps",
+      })
+      return z.NEVER
+    }
+
+    if (defaultKeymaps.length !== val.numProfiles) {
+      ctx.addIssue({
+        code: "custom",
+        message: `Expected defaultKeymaps to have ${val.numProfiles} profiles`,
+      })
+    }
+
+    if (defaultKeymaps.some((profile) => profile.length !== val.numLayers)) {
       ctx.addIssue({
         code: "custom",
-        message: `Expected defaultKeymap to have ${val.numLayers} layers`,
+        message: `Expected defaultKeymaps profiles to have ${val.numLayers} layers`,
       })
     }
 
-    if (val.defaultKeymap.some((layer) => layer.length !== val.numKeys)) {
+    if (
+      defaultKeymaps.some((profile) =>
+        profile.some((layer) => layer.length !== val.numKeys),
+      )
+    ) {
       ctx.addIssue({
         code: "custom",
-        message: `Expected defaultKeymap layers to have ${val.numKeys} keys`,
+        message: `Expected defaultKeymaps layers to have ${val.numKeys} keys`,
       })
     }
+
+    return { ...val, defaultKeymaps }
   })
 
 export type KeyboardMetadata = z.infer<typeof keyboardMetadataSchema>
@@ -243,7 +280,7 @@ export const demoMetadata = keyboardMetadataSchema.parse({
       ],
     ],
   },
-  defaultKeymap: [
+  defaultKeymaps: [...Array(4)].map(() => [
     [
       "KC_ESC",
       "KC_1",
@@ -528,5 +565,5 @@ export const demoMetadata = keyboardMetadataSchema.parse({
       "_______",
       "_______",
     ],
-  ],
+  ]),
 })