@opentui/keymap 0.2.1 → 0.2.2

package/src/types.d.ts

@@ -91,6 +91,7 @@ export interface KeySequencePart {
 }
 export interface StringifyOptions {
     preferDisplay?: boolean;
+    separator?: string;
 }
 export type KeyStringifyInput = KeyStrokeInput | NormalizedKeyStroke | KeySequencePart | {
     stroke: NormalizedKeyStroke;
@@ -116,6 +117,11 @@ export interface CommandQuery<TTarget extends object = object> {
     searchIn?: readonly string[];
     filter?: CommandFilter;
 }
+export interface CommandBindingsQuery<TTarget extends object = object> {
+    visibility?: "reachable" | "active" | "registered";
+    focused?: TTarget | null;
+    commands: readonly string[];
+}
 export interface RunCommandOptions<TTarget extends object = object, TEvent extends KeymapEvent = KeymapEvent> {
     event?: TEvent;
     focused?: TTarget | null;
@@ -167,8 +173,7 @@ export interface BindingInput<TTarget extends object = object, TEvent extends Ke
     fallthrough?: boolean;
     [key: string]: unknown;
 }
-export type BindingShorthand<TTarget extends object = object, TEvent extends KeymapEvent = KeymapEvent> = Record<string, BindingCommand<TTarget, TEvent>>;
-export type Bindings<TTarget extends object = object, TEvent extends KeymapEvent = KeymapEvent> = BindingInput<TTarget, TEvent>[] | BindingShorthand<TTarget, TEvent>;
+export type Bindings<TTarget extends object = object, TEvent extends KeymapEvent = KeymapEvent> = readonly BindingInput<TTarget, TEvent>[];
 export type TargetMode = "focus" | "focus-within";
 export interface LayerFields<TTarget extends object = object, TEvent extends KeymapEvent = KeymapEvent> {
     priority?: number;
@@ -362,6 +367,17 @@ export interface BindingTransformerContext<TTarget extends object = object, TEve
     skipOriginal(): void;
 }
 export type BindingTransformer<TTarget extends object = object, TEvent extends KeymapEvent = KeymapEvent> = (binding: ParsedBindingInput<TTarget, TEvent>, ctx: BindingTransformerContext<TTarget, TEvent>) => void;
+export type BindingInputsValidationResult = {
+    ok: true;
+} | {
+    ok: false;
+    reason: string;
+};
+export interface LayerBindingsTransformerContext<TTarget extends object = object, TEvent extends KeymapEvent = KeymapEvent> {
+    layer: Readonly<Layer<TTarget, TEvent>>;
+    validateBindings(bindings: unknown): BindingInputsValidationResult;
+}
+export type LayerBindingsTransformer<TTarget extends object = object, TEvent extends KeymapEvent = KeymapEvent> = (bindings: readonly BindingInput<TTarget, TEvent>[], ctx: LayerBindingsTransformerContext<TTarget, TEvent>) => readonly BindingInput<TTarget, TEvent>[] | void;
 export interface CommandFieldContext {
     require(name: string, value: unknown): void;
     attr(name: string, value: unknown): void;