@genesislcap/foundation-utils 14.310.2 → 14.311.1-alpha-3bdf18f.0

package/dist/foundation-utils.d.ts

@@ -1,3 +1,4 @@
+import { BehaviorSubject } from 'rxjs';
 import { Binding } from '@microsoft/fast-element';
 import { CaptureType } from '@microsoft/fast-element';
 import { ComposableStyles } from '@microsoft/fast-element';
@@ -12,6 +13,7 @@ import type { JSONSchema7 } from 'json-schema';
 import { Logger as Logger_2 } from '@genesislcap/foundation-logger';
 import { LoggerOptions as LoggerOptions_2 } from '@genesislcap/foundation-logger';
 import { LogLevel } from '@genesislcap/foundation-logger';
+import { Observable } from 'rxjs';
 import { SyntheticViewTemplate } from '@microsoft/fast-element';
 import { Types } from '@genesislcap/expression-builder';
 
@@ -336,6 +338,45 @@ export declare class DefaultServerRowDTOMapper implements ServerRowDTOMapper {
     toDTO: (entity: ServerRowEntity) => ServerRowDTO;
 }
 
+/**
+ * Default implementation of the ShortcutManager interface
+ * @public
+ */
+export declare class DefaultShortcutManager implements ShortcutManager {
+    private shortcuts;
+    private shortcutLookup;
+    private keyCombinationMap;
+    private _isPausedSubject;
+    private _activeContext;
+    get isPaused(): boolean;
+    get isPaused$(): Observable<boolean>;
+    get isPausedSubject(): BehaviorSubject<boolean>;
+    registerShortcuts(shortcuts: ShortcutDefinition[]): void;
+    registerShortcut(shortcut: ShortcutDefinition): ShortcutRegistrationResult;
+    unregisterShortcut(context: string, id: string): void;
+    unregisterShortcutsByContext(context: string): void;
+    executeShortcut(id: string): void;
+    executeShortcutByContext(context: string, id: string): void;
+    getShortcuts(): ShortcutDefinition[];
+    getShortcutsByContext(context: string): ShortcutDefinition[];
+    findShortcutByKeyCombination(key: string, ctrlKey?: boolean, altKey?: boolean, shiftKey?: boolean, metaKey?: boolean): ShortcutDefinition | undefined;
+    getContexts(): string[];
+    getShortcutsByContextMap(): Map<string, Map<string, ShortcutDefinition>>;
+    registerContext(context: string): void;
+    setActiveContext(context: string): void;
+    getActiveContext(): string | undefined;
+    clearActiveContext(): void;
+    pause(): void;
+    resume(): void;
+    /**
+     * Normalizes a shortcut definition to handle option/alt equivalence
+     * If optionKey is set, altKey will also be set to true (and vice versa)
+     */
+    private normalizeShortcutDefinition;
+    private createKeyCombinationKey;
+    private isElementFocused;
+}
+
 /**
  * Delay for a given number of milliseconds
  * @param ms - The number of milliseconds to delay
@@ -519,6 +560,25 @@ export declare type FoundationLayoutContainer = {
     _key: 'foundation-layout';
 };
 
+/**
+ * A custom element that listens for keyboard shortcuts.
+ * @public
+ * @remarks Part of the ShortcutManager Service.
+ */
+export declare class FoundationShortcutListener extends FASTElement {
+    shortcutManager: ShortcutManager;
+    private keyListener;
+    private isListening;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    private setupStateSubscription;
+    private addKeyListener;
+    private removeKeyListener;
+    private handleKeyDown;
+    private extractKeyFromCode;
+    private isInputElement;
+}
+
 /** @public */
 export declare namespace Genesis {
     const genesisFieldTypes: readonly ["STRING", "ENUM", "INT", "SHORT", "DOUBLE", "LONG", "BOOLEAN", "BIGDECIMAL", "DATE", "DATETIME", "RAW", "NANO_TIMESTAMP"];
@@ -2000,6 +2060,91 @@ export declare type ServerRowEntity = {
     };
 };
 
+/**
+ * A definition of a keyboard shortcut
+ * @public
+ */
+export declare interface ShortcutDefinition {
+    id: string;
+    key: string;
+    ctrlKey?: boolean;
+    altKey?: boolean;
+    optionKey?: boolean;
+    shiftKey?: boolean;
+    metaKey?: boolean;
+    description: string;
+    action: () => void;
+    context: string;
+    priority?: number;
+    elementRef?: HTMLElement;
+    canExecute?: () => ShortcutExecutionStatus;
+}
+
+/**
+ * A type which represents the disabled status and tooltip of an item
+ * @public
+ * */
+export declare type ShortcutExecutionStatus = {
+    disabled?: boolean;
+    tooltip?: string;
+};
+
+/**
+ * Interface of a manager for keyboard shortcuts
+ * @public
+ */
+export declare interface ShortcutManager {
+    registerShortcuts(shortcuts: ShortcutDefinition[]): void;
+    registerShortcut(shortcut: ShortcutDefinition): ShortcutRegistrationResult;
+    unregisterShortcut(context: string, id: string): void;
+    unregisterShortcutsByContext(context: string): void;
+    /**
+     * Execute a shortcut by its id
+     * @param id - The id of the shortcut to execute
+     * @remarks This method will execute the shortcut in the active context
+     */
+    executeShortcut(id: string): void;
+    /**
+     * Execute a shortcut by its id and context
+     * @param context - The context of the shortcut to execute
+     * @param id - The id of the shortcut to execute
+     */
+    executeShortcutByContext(context: string, id: string): void;
+    getShortcuts(): ShortcutDefinition[];
+    getShortcutsByContext(context: string): ShortcutDefinition[];
+    getContexts(): string[];
+    getShortcutsByContextMap(): Map<string, Map<string, ShortcutDefinition>>;
+    registerContext(context: string): void;
+    setActiveContext(context: string): void;
+    getActiveContext(): string | undefined;
+    clearActiveContext(): void;
+    findShortcutByKeyCombination(key: string, ctrlKey?: boolean, altKey?: boolean, shiftKey?: boolean, metaKey?: boolean): ShortcutDefinition | undefined;
+    pause(): void;
+    resume(): void;
+    isPaused: boolean;
+    isPaused$: Observable<boolean>;
+    isPausedSubject: BehaviorSubject<boolean>;
+}
+
+/**
+ * A dependency injection token for the ShortcutManager interface.
+ * @public
+ */
+export declare const ShortcutManager: InterfaceSymbol<ShortcutManager>;
+
+/**
+ * A result of registering a keyboard shortcut
+ * @public
+ */
+export declare interface ShortcutRegistrationResult {
+    shortcut: ShortcutDefinition;
+    id: string;
+    keyCombination: string;
+    keyCombinationDisplay: string;
+    disabled: () => boolean;
+    tooltip: () => string | undefined;
+}
+
 /**
  * A custom element that encapsulates a set of styles that can be applied to slotted elements.
  * @public

package/docs/api/foundation-utils.defaultshortcutmanager.clearactivecontext.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [clearActiveContext](./foundation-utils.defaultshortcutmanager.clearactivecontext.md)
+
+## DefaultShortcutManager.clearActiveContext() method
+
+**Signature:**
+
+```typescript
+clearActiveContext(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.defaultshortcutmanager.executeshortcut.md

@@ -0,0 +1,50 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [executeShortcut](./foundation-utils.defaultshortcutmanager.executeshortcut.md)
+
+## DefaultShortcutManager.executeShortcut() method
+
+**Signature:**
+
+```typescript
+executeShortcut(id: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+id
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.defaultshortcutmanager.executeshortcutbycontext.md

@@ -0,0 +1,64 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [executeShortcutByContext](./foundation-utils.defaultshortcutmanager.executeshortcutbycontext.md)
+
+## DefaultShortcutManager.executeShortcutByContext() method
+
+**Signature:**
+
+```typescript
+executeShortcutByContext(context: string, id: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+context
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+id
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.defaultshortcutmanager.findshortcutbykeycombination.md

@@ -0,0 +1,114 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [findShortcutByKeyCombination](./foundation-utils.defaultshortcutmanager.findshortcutbykeycombination.md)
+
+## DefaultShortcutManager.findShortcutByKeyCombination() method
+
+**Signature:**
+
+```typescript
+findShortcutByKeyCombination(key: string, ctrlKey?: boolean, altKey?: boolean, shiftKey?: boolean, metaKey?: boolean): ShortcutDefinition | undefined;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+key
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+ctrlKey
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+altKey
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+shiftKey
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+metaKey
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[ShortcutDefinition](./foundation-utils.shortcutdefinition.md) \| undefined
+

package/docs/api/foundation-utils.defaultshortcutmanager.getactivecontext.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [getActiveContext](./foundation-utils.defaultshortcutmanager.getactivecontext.md)
+
+## DefaultShortcutManager.getActiveContext() method
+
+**Signature:**
+
+```typescript
+getActiveContext(): string | undefined;
+```
+**Returns:**
+
+string \| undefined
+

package/docs/api/foundation-utils.defaultshortcutmanager.getcontexts.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [getContexts](./foundation-utils.defaultshortcutmanager.getcontexts.md)
+
+## DefaultShortcutManager.getContexts() method
+
+**Signature:**
+
+```typescript
+getContexts(): string[];
+```
+**Returns:**
+
+string\[\]
+

package/docs/api/foundation-utils.defaultshortcutmanager.getshortcuts.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [getShortcuts](./foundation-utils.defaultshortcutmanager.getshortcuts.md)
+
+## DefaultShortcutManager.getShortcuts() method
+
+**Signature:**
+
+```typescript
+getShortcuts(): ShortcutDefinition[];
+```
+**Returns:**
+
+[ShortcutDefinition](./foundation-utils.shortcutdefinition.md)<!-- -->\[\]
+

package/docs/api/foundation-utils.defaultshortcutmanager.getshortcutsbycontext.md

@@ -0,0 +1,50 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [getShortcutsByContext](./foundation-utils.defaultshortcutmanager.getshortcutsbycontext.md)
+
+## DefaultShortcutManager.getShortcutsByContext() method
+
+**Signature:**
+
+```typescript
+getShortcutsByContext(context: string): ShortcutDefinition[];
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+context
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[ShortcutDefinition](./foundation-utils.shortcutdefinition.md)<!-- -->\[\]
+

package/docs/api/foundation-utils.defaultshortcutmanager.getshortcutsbycontextmap.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [getShortcutsByContextMap](./foundation-utils.defaultshortcutmanager.getshortcutsbycontextmap.md)
+
+## DefaultShortcutManager.getShortcutsByContextMap() method
+
+**Signature:**
+
+```typescript
+getShortcutsByContextMap(): Map<string, Map<string, ShortcutDefinition>>;
+```
+**Returns:**
+
+Map&lt;string, Map&lt;string, [ShortcutDefinition](./foundation-utils.shortcutdefinition.md)<!-- -->&gt;&gt;
+

package/docs/api/foundation-utils.defaultshortcutmanager.ispaused.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [isPaused](./foundation-utils.defaultshortcutmanager.ispaused.md)
+
+## DefaultShortcutManager.isPaused property
+
+**Signature:**
+
+```typescript
+get isPaused(): boolean;
+```

package/docs/api/foundation-utils.defaultshortcutmanager.ispaused_.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [isPaused$](./foundation-utils.defaultshortcutmanager.ispaused_.md)
+
+## DefaultShortcutManager.isPaused$ property
+
+**Signature:**
+
+```typescript
+get isPaused$(): Observable<boolean>;
+```

package/docs/api/foundation-utils.defaultshortcutmanager.ispausedsubject.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [isPausedSubject](./foundation-utils.defaultshortcutmanager.ispausedsubject.md)
+
+## DefaultShortcutManager.isPausedSubject property
+
+**Signature:**
+
+```typescript
+get isPausedSubject(): BehaviorSubject<boolean>;
+```