@wirekyt/dom 0.0.1 → 0.0.2

package/dist/hotkeys.d.cts

@@ -0,0 +1,199 @@
+//#region src/common/hotkeys/types.d.ts
+type HotkeyTarget = Document | ShadowRoot | Element;
+type Platform = "mac" | "windows" | "linux";
+interface KeyboardModifiers {
+  alt?: boolean | undefined;
+  ctrl?: boolean | undefined;
+  meta?: boolean | undefined;
+  shift?: boolean | undefined;
+}
+interface SequenceStep extends KeyboardModifiers {
+  key: string;
+}
+interface ParsedHotkey extends KeyboardModifiers {
+  keys: string[];
+  codes?: string[] | undefined;
+  isSequence?: boolean | undefined;
+  description?: string | undefined;
+  sequenceSteps?: SequenceStep[] | undefined;
+}
+type HotkeyAction = (event: KeyboardEvent) => void;
+interface CommandDefinition {
+  id: string;
+  hotkey: string;
+  action: HotkeyAction;
+  label?: string | undefined;
+  description?: string | undefined;
+  category?: string | undefined;
+  options?: HotkeyOptions | undefined;
+  enabled?: boolean | (() => boolean) | undefined;
+  scopes?: string | string[] | undefined;
+  keywords?: string[] | undefined;
+}
+interface HotkeyCommand {
+  id: string;
+  hotkey: string;
+  action: HotkeyAction;
+  label?: string | undefined;
+  description?: string | undefined;
+  category?: string | undefined;
+  options: HotkeyOptions;
+  enabled: boolean | (() => boolean);
+  scopes: string[];
+  keywords: string[];
+  _parsed: ParsedHotkey;
+  _priority: number;
+  _registrationOrder: number;
+}
+type ConflictBehavior = "warn" | "error" | "replace" | "allow";
+interface HotkeyStoreOptions {
+  target?: HotkeyTarget | undefined;
+  defaultOptions?: Partial<HotkeyOptions> | undefined;
+  sequenceTimeoutMs?: number | undefined;
+  activeScopes?: string | string[] | undefined;
+  conflictBehavior?: ConflictBehavior | undefined;
+}
+type FormTagName = "input" | "textarea" | "select";
+interface HotkeyOptions {
+  preventDefault?: boolean | undefined;
+  stopPropagation?: boolean | undefined;
+  enableOnFormTags?: boolean | FormTagName[] | undefined;
+  enableOnContentEditable?: boolean | undefined;
+  capture?: boolean | undefined;
+  requireReset?: boolean | undefined;
+  eventType?: "keydown" | "keyup" | undefined;
+}
+interface HotkeyStoreState {
+  pressedKeys: Set<string>;
+  pressedCodes: Set<string>;
+  commands: Map<string, HotkeyCommand>;
+  listening: boolean;
+  activeScopes: Set<string>;
+}
+//#endregion
+//#region src/common/hotkeys/store.d.ts
+declare class HotkeyStore {
+  private state;
+  private target?;
+  private defaultCommandOptions;
+  private commandOptionOverrides;
+  private sequenceTimeoutMs;
+  private conflictBehavior;
+  private sequenceStates;
+  private registrationOrder;
+  private platform;
+  private listeners;
+  private firedCommands;
+  private hasKeyupCommands;
+  private subscribers;
+  constructor(options?: HotkeyStoreOptions);
+  init(options: HotkeyStoreOptions): this;
+  destroy(): void;
+  setScope(scope: string | string[]): this;
+  addScope(scope: string): this;
+  removeScope(scope: string): this;
+  getActiveScopes(): readonly string[];
+  getState(): Readonly<HotkeyStoreState>;
+  toggleScope(scope: string): this;
+  subscribe<T>(selector: (state: HotkeyStoreState) => T, callback: (value: T) => void): () => void;
+  register(commands: CommandDefinition | CommandDefinition[]): this;
+  unregister(id: string): this;
+  enable(id: string): this;
+  disable(id: string): this;
+  setEnabled(id: string, enabled: boolean | (() => boolean)): this;
+  clear(): this;
+  isPressed(hotkey: string): boolean;
+  getCurrentlyPressed(): readonly string[];
+  getPressedCodes(): readonly string[];
+  private modifiersMatchPressed;
+  private applyDefaultOptions;
+  private updateParsedHotkeys;
+  private refreshKeyupFlag;
+  private detectConflicts;
+  private updateListeners;
+  private startListening;
+  private stopListening;
+  private getListenerPhases;
+  private handleKeyUp;
+  private handleBlur;
+  private executeMatchingCommands;
+  private handleSequence;
+  private clearAllSequences;
+  private resetSequence;
+  private notifySubscribers;
+}
+declare function createHotkeyStore(options?: HotkeyStoreOptions): HotkeyStore;
+//#endregion
+//#region src/common/hotkeys/parser.d.ts
+declare function parseHotkey(hotkey: string, platform: Platform): ParsedHotkey;
+declare function isHotKey(hotkey: string | string[], event: KeyboardEvent, options?: HotkeyOptions, platform?: Platform): boolean;
+declare function isHotkeyEqual(a: string, b: string, platform?: Platform): boolean;
+//#endregion
+//#region src/common/hotkeys/format.d.ts
+interface FormatHotkeyOptions {
+  platform?: Platform | "auto" | undefined;
+  style?: "symbols" | "text" | "mixed" | undefined;
+  separator?: string | undefined;
+  sequenceSeparator?: string | undefined;
+  useShortNames?: boolean | undefined;
+}
+declare function formatHotkey(hotkey: string, options?: FormatHotkeyOptions): string;
+//#endregion
+//#region src/common/hotkeys/recorder.d.ts
+interface RecordedHotkey {
+  value: string;
+  display: string;
+}
+interface HotkeyRecorderOptions {
+  target?: HotkeyTarget | undefined;
+  onRecord?: (hotkey: RecordedHotkey) => void;
+  onCancel?: () => void;
+  onClear?: () => void;
+  formatOptions?: FormatHotkeyOptions | undefined;
+  sequenceTimeoutMs?: number | undefined;
+}
+interface HotkeyRecorderState {
+  recording: boolean;
+  value: RecordedHotkey | null;
+}
+type RecorderSubscriber = (state: HotkeyRecorderState) => void;
+declare class HotkeyRecorder {
+  private state;
+  private target?;
+  private options;
+  private platform;
+  private keyDownHandler?;
+  private keyUpHandler?;
+  private subscribers;
+  private steps;
+  private sequenceTimerId?;
+  constructor(options?: HotkeyRecorderOptions);
+  init(target: HotkeyTarget): this;
+  start(): this;
+  stop(): this;
+  cancel(): this;
+  clear(): this;
+  setOptions(options: Partial<HotkeyRecorderOptions>): this;
+  getState(): Readonly<HotkeyRecorderState>;
+  subscribe(callback: RecorderSubscriber): () => void;
+  destroy(): void;
+  private setState;
+  private attachListeners;
+  private detachListeners;
+  private handleKeyDown;
+  private buildRecordedHotkey;
+  private finalize;
+  private clearSequenceTimer;
+}
+declare function createHotkeyRecorder(options?: HotkeyRecorderOptions): HotkeyRecorder;
+//#endregion
+//#region src/common/hotkeys/validate.d.ts
+interface ValidationResult {
+  valid: boolean;
+  errors: string[];
+  warnings: string[];
+}
+declare function validateHotkey(hotkey: string): ValidationResult;
+declare function assertValidHotkey(hotkey: string): void;
+//#endregion
+export { type CommandDefinition, type ConflictBehavior, type FormTagName, type HotkeyAction, type HotkeyCommand, type FormatHotkeyOptions as HotkeyFormatOptions, type HotkeyOptions, HotkeyRecorder, type HotkeyRecorderOptions, type HotkeyRecorderState, HotkeyStore, type HotkeyStoreOptions, type HotkeyStoreState, type KeyboardModifiers, type ParsedHotkey, type RecordedHotkey, type ValidationResult, assertValidHotkey, createHotkeyRecorder, createHotkeyStore, formatHotkey, isHotKey, isHotkeyEqual, parseHotkey, validateHotkey };

package/dist/hotkeys.d.ts

@@ -0,0 +1,199 @@
+//#region src/common/hotkeys/types.d.ts
+type HotkeyTarget = Document | ShadowRoot | Element;
+type Platform = "mac" | "windows" | "linux";
+interface KeyboardModifiers {
+  alt?: boolean | undefined;
+  ctrl?: boolean | undefined;
+  meta?: boolean | undefined;
+  shift?: boolean | undefined;
+}
+interface SequenceStep extends KeyboardModifiers {
+  key: string;
+}
+interface ParsedHotkey extends KeyboardModifiers {
+  keys: string[];
+  codes?: string[] | undefined;
+  isSequence?: boolean | undefined;
+  description?: string | undefined;
+  sequenceSteps?: SequenceStep[] | undefined;
+}
+type HotkeyAction = (event: KeyboardEvent) => void;
+interface CommandDefinition {
+  id: string;
+  hotkey: string;
+  action: HotkeyAction;
+  label?: string | undefined;
+  description?: string | undefined;
+  category?: string | undefined;
+  options?: HotkeyOptions | undefined;
+  enabled?: boolean | (() => boolean) | undefined;
+  scopes?: string | string[] | undefined;
+  keywords?: string[] | undefined;
+}
+interface HotkeyCommand {
+  id: string;
+  hotkey: string;
+  action: HotkeyAction;
+  label?: string | undefined;
+  description?: string | undefined;
+  category?: string | undefined;
+  options: HotkeyOptions;
+  enabled: boolean | (() => boolean);
+  scopes: string[];
+  keywords: string[];
+  _parsed: ParsedHotkey;
+  _priority: number;
+  _registrationOrder: number;
+}
+type ConflictBehavior = "warn" | "error" | "replace" | "allow";
+interface HotkeyStoreOptions {
+  target?: HotkeyTarget | undefined;
+  defaultOptions?: Partial<HotkeyOptions> | undefined;
+  sequenceTimeoutMs?: number | undefined;
+  activeScopes?: string | string[] | undefined;
+  conflictBehavior?: ConflictBehavior | undefined;
+}
+type FormTagName = "input" | "textarea" | "select";
+interface HotkeyOptions {
+  preventDefault?: boolean | undefined;
+  stopPropagation?: boolean | undefined;
+  enableOnFormTags?: boolean | FormTagName[] | undefined;
+  enableOnContentEditable?: boolean | undefined;
+  capture?: boolean | undefined;
+  requireReset?: boolean | undefined;
+  eventType?: "keydown" | "keyup" | undefined;
+}
+interface HotkeyStoreState {
+  pressedKeys: Set<string>;
+  pressedCodes: Set<string>;
+  commands: Map<string, HotkeyCommand>;
+  listening: boolean;
+  activeScopes: Set<string>;
+}
+//#endregion
+//#region src/common/hotkeys/store.d.ts
+declare class HotkeyStore {
+  private state;
+  private target?;
+  private defaultCommandOptions;
+  private commandOptionOverrides;
+  private sequenceTimeoutMs;
+  private conflictBehavior;
+  private sequenceStates;
+  private registrationOrder;
+  private platform;
+  private listeners;
+  private firedCommands;
+  private hasKeyupCommands;
+  private subscribers;
+  constructor(options?: HotkeyStoreOptions);
+  init(options: HotkeyStoreOptions): this;
+  destroy(): void;
+  setScope(scope: string | string[]): this;
+  addScope(scope: string): this;
+  removeScope(scope: string): this;
+  getActiveScopes(): readonly string[];
+  getState(): Readonly<HotkeyStoreState>;
+  toggleScope(scope: string): this;
+  subscribe<T>(selector: (state: HotkeyStoreState) => T, callback: (value: T) => void): () => void;
+  register(commands: CommandDefinition | CommandDefinition[]): this;
+  unregister(id: string): this;
+  enable(id: string): this;
+  disable(id: string): this;
+  setEnabled(id: string, enabled: boolean | (() => boolean)): this;
+  clear(): this;
+  isPressed(hotkey: string): boolean;
+  getCurrentlyPressed(): readonly string[];
+  getPressedCodes(): readonly string[];
+  private modifiersMatchPressed;
+  private applyDefaultOptions;
+  private updateParsedHotkeys;
+  private refreshKeyupFlag;
+  private detectConflicts;
+  private updateListeners;
+  private startListening;
+  private stopListening;
+  private getListenerPhases;
+  private handleKeyUp;
+  private handleBlur;
+  private executeMatchingCommands;
+  private handleSequence;
+  private clearAllSequences;
+  private resetSequence;
+  private notifySubscribers;
+}
+declare function createHotkeyStore(options?: HotkeyStoreOptions): HotkeyStore;
+//#endregion
+//#region src/common/hotkeys/parser.d.ts
+declare function parseHotkey(hotkey: string, platform: Platform): ParsedHotkey;
+declare function isHotKey(hotkey: string | string[], event: KeyboardEvent, options?: HotkeyOptions, platform?: Platform): boolean;
+declare function isHotkeyEqual(a: string, b: string, platform?: Platform): boolean;
+//#endregion
+//#region src/common/hotkeys/format.d.ts
+interface FormatHotkeyOptions {
+  platform?: Platform | "auto" | undefined;
+  style?: "symbols" | "text" | "mixed" | undefined;
+  separator?: string | undefined;
+  sequenceSeparator?: string | undefined;
+  useShortNames?: boolean | undefined;
+}
+declare function formatHotkey(hotkey: string, options?: FormatHotkeyOptions): string;
+//#endregion
+//#region src/common/hotkeys/recorder.d.ts
+interface RecordedHotkey {
+  value: string;
+  display: string;
+}
+interface HotkeyRecorderOptions {
+  target?: HotkeyTarget | undefined;
+  onRecord?: (hotkey: RecordedHotkey) => void;
+  onCancel?: () => void;
+  onClear?: () => void;
+  formatOptions?: FormatHotkeyOptions | undefined;
+  sequenceTimeoutMs?: number | undefined;
+}
+interface HotkeyRecorderState {
+  recording: boolean;
+  value: RecordedHotkey | null;
+}
+type RecorderSubscriber = (state: HotkeyRecorderState) => void;
+declare class HotkeyRecorder {
+  private state;
+  private target?;
+  private options;
+  private platform;
+  private keyDownHandler?;
+  private keyUpHandler?;
+  private subscribers;
+  private steps;
+  private sequenceTimerId?;
+  constructor(options?: HotkeyRecorderOptions);
+  init(target: HotkeyTarget): this;
+  start(): this;
+  stop(): this;
+  cancel(): this;
+  clear(): this;
+  setOptions(options: Partial<HotkeyRecorderOptions>): this;
+  getState(): Readonly<HotkeyRecorderState>;
+  subscribe(callback: RecorderSubscriber): () => void;
+  destroy(): void;
+  private setState;
+  private attachListeners;
+  private detachListeners;
+  private handleKeyDown;
+  private buildRecordedHotkey;
+  private finalize;
+  private clearSequenceTimer;
+}
+declare function createHotkeyRecorder(options?: HotkeyRecorderOptions): HotkeyRecorder;
+//#endregion
+//#region src/common/hotkeys/validate.d.ts
+interface ValidationResult {
+  valid: boolean;
+  errors: string[];
+  warnings: string[];
+}
+declare function validateHotkey(hotkey: string): ValidationResult;
+declare function assertValidHotkey(hotkey: string): void;
+//#endregion
+export { type CommandDefinition, type ConflictBehavior, type FormTagName, type HotkeyAction, type HotkeyCommand, type FormatHotkeyOptions as HotkeyFormatOptions, type HotkeyOptions, HotkeyRecorder, type HotkeyRecorderOptions, type HotkeyRecorderState, HotkeyStore, type HotkeyStoreOptions, type HotkeyStoreState, type KeyboardModifiers, type ParsedHotkey, type RecordedHotkey, type ValidationResult, assertValidHotkey, createHotkeyRecorder, createHotkeyStore, formatHotkey, isHotKey, isHotkeyEqual, parseHotkey, validateHotkey };