@sprawlify/primitives 0.0.1

package/dist/hotkeys.d.cts

@@ -0,0 +1,130 @@
+//#region src/shared/hotkeys/types.d.ts
+type RootNode = Document | ShadowRoot;
+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<TContext = any> = (context: TContext, event: KeyboardEvent) => Promise<void> | void;
+interface CommandDefinition<TContext = any> {
+  id: string;
+  hotkey: string;
+  action: HotkeyAction<TContext>;
+  label?: string | undefined;
+  description?: string | undefined;
+  category?: string | undefined;
+  options?: HotkeyOptions | undefined;
+  enabled?: boolean | ((context: TContext) => boolean) | undefined;
+  scopes?: string | string[] | undefined;
+  keywords?: string[] | undefined;
+}
+interface HotkeyCommand<TContext = any> {
+  id: string;
+  hotkey: string;
+  action: HotkeyAction<TContext>;
+  label?: string | undefined;
+  description?: string | undefined;
+  category?: string | undefined;
+  options: HotkeyOptions;
+  enabled: boolean | ((context: TContext) => boolean);
+  scopes: string[];
+  keywords: string[];
+  _parsed: ParsedHotkey;
+  _priority: number;
+  _registrationOrder: number;
+}
+interface HotkeyStoreOptions<TContext = any> {
+  rootNode?: RootNode | undefined;
+  context?: TContext | undefined;
+  defaultOptions?: Partial<HotkeyOptions> | undefined;
+  sequenceTimeoutMs?: number | undefined;
+  activeScopes?: string | string[] | undefined;
+}
+type FormTagName = "input" | "textarea" | "select";
+interface HotkeyOptions {
+  preventDefault?: boolean | undefined;
+  stopPropagation?: boolean | undefined;
+  enableOnFormTags?: boolean | FormTagName[] | undefined;
+  enableOnContentEditable?: boolean | undefined;
+  capture?: boolean | undefined;
+}
+interface HotkeyStoreState<TContext = any> {
+  pressedKeys: Set<string>;
+  commands: Map<string, HotkeyCommand<TContext>>;
+  listening: boolean;
+  activeScopes: Set<string>;
+}
+//#endregion
+//#region src/shared/hotkeys/store.d.ts
+declare class HotkeyStore<TContext = any> {
+  private state;
+  private context;
+  private rootNode?;
+  private sequenceTimeoutMs;
+  private sequenceStates;
+  private registrationOrder;
+  private platform;
+  private listeners;
+  private subscribers;
+  constructor(options?: HotkeyStoreOptions<TContext>);
+  init(options: HotkeyStoreOptions<TContext>): this;
+  destroy(): void;
+  setContext(context: TContext): this;
+  getContext(): TContext;
+  setScope(scope: string | string[]): this;
+  addScope(scope: string): this;
+  removeScope(scope: string): this;
+  getActiveScopes(): readonly string[];
+  getState(): Readonly<HotkeyStoreState<TContext>>;
+  toggleScope(scope: string): this;
+  subscribe<T>(selector: (state: HotkeyStoreState<TContext>, context: TContext) => T, callback: (value: T) => void): () => void;
+  register(commands: CommandDefinition<TContext> | CommandDefinition<TContext>[]): this;
+  unregister(id: string): this;
+  enable(id: string): this;
+  disable(id: string): this;
+  setEnabled(id: string, enabled: boolean | ((context: TContext) => boolean)): this;
+  clear(): this;
+  isPressed(hotkey: string): boolean;
+  getCurrentlyPressed(): readonly string[];
+  private updateParsedHotkeys;
+  private updateListeners;
+  private startListening;
+  private stopListening;
+  private getListenerPhases;
+  private createKeyDownHandler;
+  private createKeyUpHandler;
+  private createBlurHandler;
+  private executeMatchingCommands;
+  private handleSequence;
+  private resetSequence;
+  private notifySubscribers;
+}
+declare function createHotkeyStore<TContext = any>(options?: HotkeyStoreOptions<TContext>): HotkeyStore<TContext>;
+//#endregion
+//#region src/shared/hotkeys/parser.d.ts
+declare function parseHotkey(hotkey: string, platform: Platform): ParsedHotkey;
+declare function isHotKey(hotkey: string | string[], event: KeyboardEvent, options?: HotkeyOptions): boolean;
+//#endregion
+//#region src/shared/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
+export { CommandDefinition, FormTagName, HotkeyAction, HotkeyCommand, FormatHotkeyOptions as HotkeyFormatOptions, HotkeyOptions, HotkeyStore, HotkeyStoreOptions, HotkeyStoreState, KeyboardModifiers, ParsedHotkey, createHotkeyStore, formatHotkey, isHotKey, parseHotkey };

package/dist/hotkeys.d.mts

@@ -0,0 +1,130 @@
+//#region src/shared/hotkeys/types.d.ts
+type RootNode = Document | ShadowRoot;
+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<TContext = any> = (context: TContext, event: KeyboardEvent) => Promise<void> | void;
+interface CommandDefinition<TContext = any> {
+  id: string;
+  hotkey: string;
+  action: HotkeyAction<TContext>;
+  label?: string | undefined;
+  description?: string | undefined;
+  category?: string | undefined;
+  options?: HotkeyOptions | undefined;
+  enabled?: boolean | ((context: TContext) => boolean) | undefined;
+  scopes?: string | string[] | undefined;
+  keywords?: string[] | undefined;
+}
+interface HotkeyCommand<TContext = any> {
+  id: string;
+  hotkey: string;
+  action: HotkeyAction<TContext>;
+  label?: string | undefined;
+  description?: string | undefined;
+  category?: string | undefined;
+  options: HotkeyOptions;
+  enabled: boolean | ((context: TContext) => boolean);
+  scopes: string[];
+  keywords: string[];
+  _parsed: ParsedHotkey;
+  _priority: number;
+  _registrationOrder: number;
+}
+interface HotkeyStoreOptions<TContext = any> {
+  rootNode?: RootNode | undefined;
+  context?: TContext | undefined;
+  defaultOptions?: Partial<HotkeyOptions> | undefined;
+  sequenceTimeoutMs?: number | undefined;
+  activeScopes?: string | string[] | undefined;
+}
+type FormTagName = "input" | "textarea" | "select";
+interface HotkeyOptions {
+  preventDefault?: boolean | undefined;
+  stopPropagation?: boolean | undefined;
+  enableOnFormTags?: boolean | FormTagName[] | undefined;
+  enableOnContentEditable?: boolean | undefined;
+  capture?: boolean | undefined;
+}
+interface HotkeyStoreState<TContext = any> {
+  pressedKeys: Set<string>;
+  commands: Map<string, HotkeyCommand<TContext>>;
+  listening: boolean;
+  activeScopes: Set<string>;
+}
+//#endregion
+//#region src/shared/hotkeys/store.d.ts
+declare class HotkeyStore<TContext = any> {
+  private state;
+  private context;
+  private rootNode?;
+  private sequenceTimeoutMs;
+  private sequenceStates;
+  private registrationOrder;
+  private platform;
+  private listeners;
+  private subscribers;
+  constructor(options?: HotkeyStoreOptions<TContext>);
+  init(options: HotkeyStoreOptions<TContext>): this;
+  destroy(): void;
+  setContext(context: TContext): this;
+  getContext(): TContext;
+  setScope(scope: string | string[]): this;
+  addScope(scope: string): this;
+  removeScope(scope: string): this;
+  getActiveScopes(): readonly string[];
+  getState(): Readonly<HotkeyStoreState<TContext>>;
+  toggleScope(scope: string): this;
+  subscribe<T>(selector: (state: HotkeyStoreState<TContext>, context: TContext) => T, callback: (value: T) => void): () => void;
+  register(commands: CommandDefinition<TContext> | CommandDefinition<TContext>[]): this;
+  unregister(id: string): this;
+  enable(id: string): this;
+  disable(id: string): this;
+  setEnabled(id: string, enabled: boolean | ((context: TContext) => boolean)): this;
+  clear(): this;
+  isPressed(hotkey: string): boolean;
+  getCurrentlyPressed(): readonly string[];
+  private updateParsedHotkeys;
+  private updateListeners;
+  private startListening;
+  private stopListening;
+  private getListenerPhases;
+  private createKeyDownHandler;
+  private createKeyUpHandler;
+  private createBlurHandler;
+  private executeMatchingCommands;
+  private handleSequence;
+  private resetSequence;
+  private notifySubscribers;
+}
+declare function createHotkeyStore<TContext = any>(options?: HotkeyStoreOptions<TContext>): HotkeyStore<TContext>;
+//#endregion
+//#region src/shared/hotkeys/parser.d.ts
+declare function parseHotkey(hotkey: string, platform: Platform): ParsedHotkey;
+declare function isHotKey(hotkey: string | string[], event: KeyboardEvent, options?: HotkeyOptions): boolean;
+//#endregion
+//#region src/shared/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
+export { CommandDefinition, FormTagName, HotkeyAction, HotkeyCommand, FormatHotkeyOptions as HotkeyFormatOptions, HotkeyOptions, HotkeyStore, HotkeyStoreOptions, HotkeyStoreState, KeyboardModifiers, ParsedHotkey, createHotkeyStore, formatHotkey, isHotKey, parseHotkey };