@difizen/libro-common 0.3.3 → 1.0.0

package/es/core/keyboard/keyboard-layout-service.d.ts

@@ -0,0 +1,51 @@
+import type { Event } from '../../common/index.js';
+import { Emitter } from '../../common/index.js';
+import type { NativeKeyboardLayout } from './keyboard-protocol';
+import { KeyboardLayoutProvider, KeyboardLayoutChangeNotifier, KeyValidator } from './keyboard-protocol';
+import { KeyCode, Key } from './keys';
+export type KeyboardLayout = {
+    /**
+     * Mapping of standard US keyboard keys to the actual key codes to use.
+     * See `KeyboardLayoutService.getCharacterIndex` for the index computation.
+     */
+    readonly key2KeyCode: KeyCode[];
+    /**
+     * Mapping of KeyboardEvent codes to the characters shown on the user's keyboard
+     * for the respective keys.
+     */
+    readonly code2Character: Record<string, string>;
+};
+export declare class KeyboardLayoutService {
+    protected readonly layoutProvider: KeyboardLayoutProvider;
+    protected readonly layoutChangeNotifier: KeyboardLayoutChangeNotifier;
+    protected readonly keyValidator?: KeyValidator | undefined;
+    constructor(layoutProvider: KeyboardLayoutProvider, layoutChangeNotifier: KeyboardLayoutChangeNotifier, keyValidator?: KeyValidator);
+    private currentLayout?;
+    protected updateLayout(newLayout: NativeKeyboardLayout): KeyboardLayout;
+    protected keyboardLayoutChanged: Emitter<KeyboardLayout>;
+    get onKeyboardLayoutChanged(): Event<KeyboardLayout>;
+    initialize(): Promise<void>;
+    /**
+     * Resolve a KeyCode of a keybinding using the current keyboard layout.
+     * If no keyboard layout has been detected or the layout does not contain the
+     * key used in the KeyCode, the KeyCode is returned unchanged.
+     */
+    resolveKeyCode(inCode: KeyCode): KeyCode;
+    /**
+     * Return the character shown on the user's keyboard for the given key.
+     * Use this to determine UI representations of keybindings.
+     */
+    getKeyboardCharacter(key: Key): string;
+    /**
+     * Called when a KeyboardEvent is processed by the KeybindingRegistry.
+     * The KeyValidator may trigger a keyboard layout change.
+     */
+    validateKeyCode(keyCode: KeyCode): void;
+    protected transformKeyCode(inCode: KeyCode, mappedCode: KeyCode, keyNeedsShift: boolean): KeyCode | undefined;
+    protected transformNativeLayout(nativeLayout: NativeKeyboardLayout): KeyboardLayout;
+    protected shouldIncludeKey(code: string): boolean;
+    private addKeyMapping;
+    private addWindowsKeyMapping;
+    protected getCharacterIndex(key: Key, shift?: boolean): number;
+}
+//# sourceMappingURL=keyboard-layout-service.d.ts.map

package/es/core/keyboard/keyboard-layout-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyboard-layout-service.d.ts","sourceRoot":"","sources":["../../../src/core/keyboard/keyboard-layout-service.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,OAAO,EAAa,MAAM,uBAAuB,CAAC;AAI3D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EACL,sBAAsB,EACtB,4BAA4B,EAC5B,YAAY,EACb,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC;AAEtC,MAAM,MAAM,cAAc,GAAG;IAC3B;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC;IAChC;;;OAGG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjD,CAAC;AAEF,qBACa,qBAAqB;IAChC,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,sBAAsB,CAAC;IAC1D,SAAS,CAAC,QAAQ,CAAC,oBAAoB,EAAE,4BAA4B,CAAC;IACtE,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;gBAGzB,cAAc,EAAE,sBAAsB,EAEtE,oBAAoB,EAAE,4BAA4B,EAChB,YAAY,CAAC,EAAE,YAAY;IAO/D,OAAO,CAAC,aAAa,CAAC,CAAiB;IAEvC,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,oBAAoB,GAAG,cAAc;IAOvE,SAAS,CAAC,qBAAqB,0BAAiC;IAEhE,IAAI,uBAAuB,IAAI,KAAK,CAAC,cAAc,CAAC,CAEnD;IAEK,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAQjC;;;;OAIG;IACH,cAAc,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO;IAiBxC;;;OAGG;IACH,oBAAoB,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM;IAWtC;;;OAGG;IACH,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAYvC,SAAS,CAAC,gBAAgB,CACxB,MAAM,EAAE,OAAO,EACf,UAAU,EAAE,OAAO,EACnB,aAAa,EAAE,OAAO,GACrB,OAAO,GAAG,SAAS;IAmBtB,SAAS,CAAC,qBAAqB,CAAC,YAAY,EAAE,oBAAoB,GAAG,cAAc;IA+DnF,SAAS,CAAC,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAQjD,OAAO,CAAC,aAAa;IAqBrB,OAAO,CAAC,oBAAoB;IAkB5B,SAAS,CAAC,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM;CAM/D"}