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

package/dist/custom-elements.json

@@ -127,6 +127,14 @@
             "package": "./serializers"
           }
         },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./shortcut-manager"
+          }
+        },
         {
           "kind": "js",
           "name": "*",
@@ -367,97 +375,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/decorators/index.ts",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./renderOnChange"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/decorators/renderOnChange.ts",
-      "declarations": [
-        {
-          "kind": "function",
-          "name": "renderOnChange",
-          "parameters": [
-            {
-              "name": "target",
-              "type": {
-                "text": "FASTElement & { render(): void }"
-              },
-              "description": "The target to define the property change handler on."
-            },
-            {
-              "name": "name",
-              "type": {
-                "text": "string"
-              },
-              "description": "The property name."
-            }
-          ],
-          "description": "Defines a property changed handler that calls a render() method on the target as an internal observation enhancement.",
-          "privacy": "public"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "renderOnChange",
-          "declaration": {
-            "name": "renderOnChange",
-            "module": "src/decorators/renderOnChange.ts"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/directives/index.ts",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./sync"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./when-else"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/encoding/index.ts",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./base64"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "src/design-system/design-system.ts",
@@ -578,6 +495,97 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/directives/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./sync"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./when-else"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/decorators/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./renderOnChange"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/decorators/renderOnChange.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "renderOnChange",
+          "parameters": [
+            {
+              "name": "target",
+              "type": {
+                "text": "FASTElement & { render(): void }"
+              },
+              "description": "The target to define the property change handler on."
+            },
+            {
+              "name": "name",
+              "type": {
+                "text": "string"
+              },
+              "description": "The property name."
+            }
+          ],
+          "description": "Defines a property changed handler that calls a render() method on the target as an internal observation enhancement.",
+          "privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "renderOnChange",
+          "declaration": {
+            "name": "renderOnChange",
+            "module": "src/decorators/renderOnChange.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/encoding/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./base64"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/env/index.ts",
@@ -1865,7 +1873,7 @@
     },
     {
       "kind": "javascript-module",
-      "path": "src/state/index.ts",
+      "path": "src/shortcut-manager/index.ts",
       "declarations": [],
       "exports": [
         {
@@ -1873,7 +1881,7 @@
           "name": "*",
           "declaration": {
             "name": "*",
-            "package": "./reactive"
+            "package": "./shortcut-manager"
           }
         },
         {
@@ -1881,83 +1889,657 @@
           "name": "*",
           "declaration": {
             "name": "*",
-            "package": "./visitor"
+            "package": "./shortcut-listener"
           }
         }
       ]
     },
     {
       "kind": "javascript-module",
-      "path": "src/state/reactive.ts",
+      "path": "src/shortcut-manager/shortcut-listener.ts",
       "declarations": [
         {
-          "kind": "function",
-          "name": "reactive",
-          "return": {
-            "type": {
-              "text": ""
-            }
-          },
-          "parameters": [
+          "kind": "class",
+          "description": "A custom element that listens for keyboard shortcuts.",
+          "name": "FoundationShortcutListener",
+          "members": [
             {
-              "name": "object",
+              "kind": "field",
+              "name": "shortcutManager",
               "type": {
-                "text": "T"
-              },
-              "description": "The object to make reactive."
+                "text": "ShortcutManager"
+              }
             },
             {
-              "name": "deep",
-              "default": "false",
-              "description": "Indicates whether to deeply convert the object."
-            }
-          ],
-          "description": "Converts a plain object to a reactive, observable object."
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "reactive",
-          "declaration": {
-            "name": "reactive",
-            "module": "src/state/reactive.ts"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/state/visitor.ts",
-      "declarations": [
-        {
-          "kind": "function",
-          "name": "visitObject",
-          "return": {
-            "type": {
-              "text": "void"
-            }
-          },
-          "parameters": [
-            {
-              "name": "object",
+              "kind": "field",
+              "name": "keyListener",
               "type": {
-                "text": "any"
+                "text": "((event: KeyboardEvent) => void) | null"
               },
-              "description": "The object."
+              "privacy": "private",
+              "default": "null"
             },
             {
-              "name": "deep",
+              "kind": "field",
+              "name": "isListening",
               "type": {
                 "text": "boolean"
               },
-              "description": "A flag to indicate if a recursive visit of sub objects should occur."
+              "privacy": "private",
+              "default": "false"
             },
             {
-              "name": "visitor",
-              "type": {
-                "text": "ObjectVisitor<TVisitorData>"
-              },
+              "kind": "method",
+              "name": "setupStateSubscription",
+              "privacy": "private"
+            },
+            {
+              "kind": "method",
+              "name": "addKeyListener",
+              "privacy": "private"
+            },
+            {
+              "kind": "method",
+              "name": "removeKeyListener",
+              "privacy": "private"
+            },
+            {
+              "kind": "method",
+              "name": "handleKeyDown",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "event",
+                  "type": {
+                    "text": "KeyboardEvent"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "extractKeyFromCode",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "string"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "code",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "isInputElement",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "element",
+                  "type": {
+                    "text": "HTMLElement | null"
+                  }
+                }
+              ]
+            }
+          ],
+          "superclass": {
+            "name": "FASTElement",
+            "package": "@microsoft/fast-element"
+          },
+          "tagName": "foundation-shortcut-listener",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "FoundationShortcutListener",
+          "declaration": {
+            "name": "FoundationShortcutListener",
+            "module": "src/shortcut-manager/shortcut-listener.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "foundation-shortcut-listener",
+          "declaration": {
+            "name": "FoundationShortcutListener",
+            "module": "src/shortcut-manager/shortcut-listener.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/shortcut-manager/shortcut-manager.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Default implementation of the ShortcutManager interface",
+          "name": "DefaultShortcutManager",
+          "members": [
+            {
+              "kind": "field",
+              "name": "shortcuts",
+              "privacy": "private",
+              "default": "new Map<string, Map<string, ShortcutDefinition>>()"
+            },
+            {
+              "kind": "field",
+              "name": "shortcutLookup",
+              "privacy": "private",
+              "default": "new Map<string, ShortcutDefinition>()"
+            },
+            {
+              "kind": "field",
+              "name": "keyCombinationMap",
+              "privacy": "private",
+              "default": "new Map<string, Set<string>>()"
+            },
+            {
+              "kind": "field",
+              "name": "_isPausedSubject",
+              "privacy": "private",
+              "default": "new BehaviorSubject<boolean>(false)"
+            },
+            {
+              "kind": "field",
+              "name": "_activeContext",
+              "type": {
+                "text": "string | undefined"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "isPaused",
+              "type": {
+                "text": "boolean"
+              },
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "isPaused$",
+              "type": {
+                "text": "Observable<boolean>"
+              },
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "isPausedSubject",
+              "type": {
+                "text": "BehaviorSubject<boolean>"
+              },
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "registerShortcuts",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "shortcuts",
+                  "type": {
+                    "text": "ShortcutDefinition[]"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "registerShortcut",
+              "return": {
+                "type": {
+                  "text": "ShortcutRegistrationResult"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "shortcut",
+                  "type": {
+                    "text": "ShortcutDefinition"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "unregisterShortcut",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "context",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "id",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "unregisterShortcutsByContext",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "context",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "executeShortcut",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "id",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "executeShortcutByContext",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "context",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "id",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "getShortcuts",
+              "return": {
+                "type": {
+                  "text": "ShortcutDefinition[]"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "getShortcutsByContext",
+              "return": {
+                "type": {
+                  "text": "ShortcutDefinition[]"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "context",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "findShortcutByKeyCombination",
+              "return": {
+                "type": {
+                  "text": "ShortcutDefinition | undefined"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "key",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "ctrlKey",
+                  "default": "false"
+                },
+                {
+                  "name": "altKey",
+                  "default": "false"
+                },
+                {
+                  "name": "shiftKey",
+                  "default": "false"
+                },
+                {
+                  "name": "metaKey",
+                  "default": "false"
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "getContexts",
+              "return": {
+                "type": {
+                  "text": "string[]"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "getShortcutsByContextMap",
+              "return": {
+                "type": {
+                  "text": "Map<string, Map<string, ShortcutDefinition>>"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "registerContext",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "context",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "setActiveContext",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "context",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "getActiveContext",
+              "return": {
+                "type": {
+                  "text": "string | undefined"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "clearActiveContext",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "pause",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "resume",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "normalizeShortcutDefinition",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "ShortcutDefinition"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "shortcut",
+                  "type": {
+                    "text": "ShortcutDefinition"
+                  }
+                }
+              ],
+              "description": "Normalizes a shortcut definition to handle option/alt equivalence\nIf optionKey is set, altKey will also be set to true (and vice versa)"
+            },
+            {
+              "kind": "method",
+              "name": "createKeyCombinationKey",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "string"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "key",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "ctrlKey",
+                  "default": "false"
+                },
+                {
+                  "name": "altKey",
+                  "default": "false"
+                },
+                {
+                  "name": "shiftKey",
+                  "default": "false"
+                },
+                {
+                  "name": "metaKey",
+                  "default": "false"
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "isElementFocused",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "element",
+                  "type": {
+                    "text": "HTMLElement"
+                  }
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "kind": "variable",
+          "name": "ShortcutManager",
+          "description": "A dependency injection token for the ShortcutManager interface.",
+          "privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "DefaultShortcutManager",
+          "declaration": {
+            "name": "DefaultShortcutManager",
+            "module": "src/shortcut-manager/shortcut-manager.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "ShortcutManager",
+          "declaration": {
+            "name": "ShortcutManager",
+            "module": "src/shortcut-manager/shortcut-manager.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/state/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./reactive"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./visitor"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/state/reactive.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "reactive",
+          "return": {
+            "type": {
+              "text": ""
+            }
+          },
+          "parameters": [
+            {
+              "name": "object",
+              "type": {
+                "text": "T"
+              },
+              "description": "The object to make reactive."
+            },
+            {
+              "name": "deep",
+              "default": "false",
+              "description": "Indicates whether to deeply convert the object."
+            }
+          ],
+          "description": "Converts a plain object to a reactive, observable object."
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "reactive",
+          "declaration": {
+            "name": "reactive",
+            "module": "src/state/reactive.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/state/visitor.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "visitObject",
+          "return": {
+            "type": {
+              "text": "void"
+            }
+          },
+          "parameters": [
+            {
+              "name": "object",
+              "type": {
+                "text": "any"
+              },
+              "description": "The object."
+            },
+            {
+              "name": "deep",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "A flag to indicate if a recursive visit of sub objects should occur."
+            },
+            {
+              "name": "visitor",
+              "type": {
+                "text": "ObjectVisitor<TVisitorData>"
+              },
               "description": "The defined {@link ObjectVisitor}logic.\n * "
             },
             {
@@ -2444,6 +3026,105 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/utils/os-platform.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Platform detection utilities for cross-platform compatibility",
+          "name": "OperatingSystemUtils",
+          "members": [
+            {
+              "kind": "field",
+              "name": "isMacOS",
+              "type": {
+                "text": "boolean"
+              },
+              "static": true,
+              "description": "Detects if the current platform is macOS",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "isWindows",
+              "type": {
+                "text": "boolean"
+              },
+              "static": true,
+              "description": "Detects if the current platform is Windows",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "isLinux",
+              "type": {
+                "text": "boolean"
+              },
+              "static": true,
+              "description": "Detects if the current platform is Linux",
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "getModifierSymbols",
+              "static": true,
+              "return": {
+                "type": {
+                  "text": "{\n    ctrl: string;\n    alt: string;\n    shift: string;\n    meta: string;\n  }"
+                }
+              },
+              "description": "Gets the appropriate modifier key symbols for the current platform"
+            },
+            {
+              "kind": "method",
+              "name": "formatKeyCombination",
+              "static": true,
+              "return": {
+                "type": {
+                  "text": "string"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "key",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "ctrlKey",
+                  "default": "false"
+                },
+                {
+                  "name": "altKey",
+                  "default": "false"
+                },
+                {
+                  "name": "shiftKey",
+                  "default": "false"
+                },
+                {
+                  "name": "metaKey",
+                  "default": "false"
+                }
+              ],
+              "description": "Formats a key combination with platform-appropriate symbols"
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "OperatingSystemUtils",
+          "declaration": {
+            "name": "OperatingSystemUtils",
+            "module": "src/utils/os-platform.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/uuid/index.ts",