@witchcraft/spellcraft 0.0.3 → 0.1.0

package/README.md

@@ -123,7 +123,7 @@ You can choose in your execute function what exactly to do at that point for bot
 
 If non-modifier keys are still being held at this point, the manager will not allow triggering a shortcut until they are released (see `state.isAwaitingKeyup`). Modifiers are not affect by this. We usually want the user to be able to keep the modifier pressed and do, for example, `Ctrl+B` then `Ctrl+I` to bold and italicize text, without having to release `Ctrl`, only `B` and `I`.
 
-## Errors and `{check}` Option
+## Errors and Checking if Actions can be Performed
 
 Note the use of `unwrap()`. Because many actions can throw "soft" errors, to better help deal with all the errors the library uses a Result monad in most of the return types. `unwrap` is like rust's unwrap and will throw the error if there was one, otherwise "unwrap" and return the value within. 
 
@@ -278,12 +278,58 @@ export { }
 ```
 
 Additionally, when you create a condition, you can pass a function to `parse` it and add these needed properties:
+
+You'll probably want to create a wrapping function to do this. Here's an example with the expressit library:
+
+
+<details>
+
+<summary>Click to Expand</summary>
+
 ```ts
-const condition = createCondition("a || b ", (_) => {
-	_.ast = parse(_.text)
+import { ShortcutContextParser } from "@witchcraft/expressit/examples/ShortcutContextParser"
+import { createCondition as _createCondition } from "@witchcraft/spellcraft"
+
+const dummyContext = { a: { }, b: { c: {} } }
+const shortcutParser = new ShortcutContextParser(dummyContext) // see docs for details
+function parser(text: string, _: Condition) {
+	const res = shortcutsParser.parse(text)
+	// === undefined is to narrow out the ErrorToken type
+	if (!res.valid || res.type === undefined) {
+		throw new Error(`Shortcut context parser failed to parse condition ${_.text}`)
+	}
+
+	_.ast = res
 	return _
+}
+
+/** Creates a condition with the ast saved in it. */
+function createCondition(text: string) {
+	return _createCondition(text, parser)
+}
+const condition = createCondition("a || b")
+condition.ast // should exist
+
+// tell the manager how to evaluare the condition:
+const manager = createmanager({
+	context: createcontext<context<map<string, boolean>>>(new map()),
+	options: {
+		evaluatecondition(condition, context) {
+			if (condition.ast === undefined) throw new Error("condition ast is undefined")
+
+			const res = condition.ast.valid 
+				? conditionParser.evaluate(
+					conditionParser.normalize(condition.ast),
+					context.value.isActive
+				) 
+				: false 
+			return res
+		},
+	}
 })
+
 ```
+</details>
 
 ## Contexts
 
@@ -292,10 +338,10 @@ Similarly with contexts, you can use any sort of object or type that you like.
 You can tell the manager it's type when you create it. For example, say we wanted to use a map:
 
 ```ts
-const manager = createManager({
-	context: createContext<Context<Map<string, boolean>>>(new Map()),
+const manager = createmanager({
+	context: createcontext<context<map<string, boolean>>>(new map()),
 	options: {
-		evaluateCondition(condition, context) {
+		evaluatecondition(condition, context) {
 			// context is now correctly typed
 			return context.value.has(condition.text)
 		},
@@ -308,10 +354,10 @@ const manager = createManager({
 Creating a shortcut requires a the key/commands we created and the manager options to create a valid shortcut.
 
 ```ts
-const shortcut =createShortcut({
+const shortcut = createShortcut({
 	command: "test",
 	chain: [["a"]],
-	condition: createCondition("a || b", true),
+	condition: createCondition("a || b"),
 	enabled: true,
 }, {options, keys, commands}).unwrap()
 
@@ -379,6 +425,10 @@ Note that while the built in errors are property specific, custom errors are not
 
 A helper class `ShortcutManagerManager` is provided to help manage multiple managers.
 
+<details>
+
+<summary>Click to Expand</summary>
+
 ```ts
 import { ShortcutManagerManager } from "@witchcraft/spellcraft"
 
@@ -435,6 +485,9 @@ managerManager.duplicateManager("myManagerName", "myDuplicateManagerName")
 managerManager.deleteManager("myManagerName")
 managerManager.renameManager("myManagerName", "myNewManagerName")
 ```
+
+</details>
+
 You can then use the active manager's `onSet*Prop` hooks to call debouncedSave. You can wrap only the active manager to intercept all it's `onSet*Prop` calls. See the `useMultipleManagers` composable in the demo.
 
 ## Other Helpers and Utilities
@@ -453,6 +506,7 @@ There are many helpers provided to simplify common use cases under `/helpers`. S
 There's also some smaller utility functions in `/utils`:
 - `equals/dedupe/clone/*Key` These are particularly important for manipulating chords. This is because keys which are variants of eachother (see `Key.variants`) do not have matching ids and we usually want to be able to dedupe by the variants as well. 
 - `isAny/Trigger/Wheel/MouseKey`.
+- `getKeyCodesFromKeys` for getting the raw key codes from a list of keys for use with third-party libraries.
 
 
 There's also a few other functions that in the future might be moved from the demo were I created them and into the library. See [demo/src/common](https://github.com/AlansCodeLog/spellcraft/tree/master/demo/src/common).
@@ -490,18 +544,28 @@ Under gnome at least, if a key (usually Ctrl) is set to locate the cursor, it wi
 
 # FAQ 
 
-## Browser shortcuts interfere with certain shortcuts, how can this be avoided?
+
+<details>
+
+<summary>Browser shortcuts interfere with certain shortcuts, how can this be avoided?</summary>
 
 You can use a listener on the manager to e.preventDefault() some of these, but this doesn't work for all of them.
 
 If available you can also try using the [Keyboard API's](https://developer.mozilla.org/en-US/docs/Web/API/Keyboard_API) lock method (see [Keyboard Locking](https://developer.mozilla.org/en-US/docs/Web/API/Keyboard_API#keyboard_locking) ).
 
-## How to label keys with their local names?
+</details>
+
+<details>
+
+<summary>How to label keys with their local names?</summary>
 
 If the [Keyboard API](https://developer.mozilla.org/en-US/docs/Web/API/Keyboard_API) is available, you can use it's [navigator.keyboard.getLayoutMap method.](https://developer.mozilla.org/en-US/docs/Web/API/Keyboard/getLayoutMap). Helpers (getKeyboardLayoutMap and labelWithNavigator) are provided for this purpose, see them for details.
 
+</details>
 
-## How to set multiple manager properties safely (i.e. batch replace shortcuts/commands/keys)?
+<details>
+
+<summary>How to set multiple manager properties safely (i.e. batch replace shortcuts/commands/keys)?</summary>
 
 This can be an issue because there isn't a way to tell the manager you want to replace *multiple* properties and it might be impossible to, for example, replace commands with a smaller subset but not have it error even if you're planning to replace the shortcuts so they don't contain missing commands.
 
@@ -519,7 +583,11 @@ if (isValidManager(manager)) {
 }
 
 ```
-## How to create `modifier-only` shortcuts? (e.g. a shortcut `Ctrl` that changes the some state like enabling multiple selection).
+</details>
+
+<details>
+
+<summary>How to create `modifier-only` shortcuts? (e.g. a shortcut `Ctrl` that changes the some state like enabling multiple selection).</summary>
 
 To do this, instead of clearing the manager's chain, you just set the state directly.
 
@@ -563,17 +631,48 @@ function addToSelected(item) {
 }
 </script>
 ```
-# How to type the context?
+</details>
+
+<details>
+
+<summary>How to show pretty shortcut strings to the user?</summary>
+
+To show a pretty stringified version of a shortcut, use `manager.options.stringifier.stringify(shortcut.chain, manager)`.
+
+Here's an advanced example in vue that shows a hint only when needed:
+
+```ts
+const usageInstructions = computed(() => {
+	const manager = shortcuts.activeManager!.value!
+	const s = manager.options.stringifier
+	const context = shortcuts.context!
+	const isDragging = context.value.layout.drag.isDragging
+	const splitChain = manager.shortcuts.entries.find(_ => _.command === LAYOUT_COMMANDS.dragModifierSplit)?.chain
+		
+	return isDragging && splitChain
+		`Hold ${s.stringify(splitChain, manager)} to Split` 
+		: undefined,
+})
+```
+
+</details>
+
+<details>
+
+<summary>How to type the context?</summary>
+
+Types can be extended multiple times from different files so long as the `NAME` part below is unique for each extension.
 
 ```ts [global.ts]
 declare module "@witchcraft/spellcraft/types" {
 // or for nuxt
 // declare module "#witchcraft/spellcraft/types.js" {
 	export interface Register {
-		ExtendedContextInfo: {
+		ShortcutManagerContextNAME: { //replace NAME with something
 			// extend types here
 		}
 	}
 }
 ```
+</details>
 

package/dist/helpers/getKeyCodesFromKeys.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Given an list of keys, returns an array of deduped key codes.
+ *
+ * Useful for when the codes must be passed to a third-party library (for example, a dragging library that takes a list modifiers).
+ *
+ * This properly takes a look at the key and all it's variants.
+ *
+ * `skipIdIfHasVariants` is true by default and will skip adding the key's id if it has variants as it's assumed the id is not a valid name.
+ */
+import type { Key } from "../types/keys.js";
+export declare function getKeyCodesFromKeys(keys: Key[], { skipIdIfHasVariants }?: {
+    skipIdIfHasVariants?: boolean;
+}): string[];

package/dist/helpers/getKeyCodesFromKeys.js

@@ -0,0 +1,16 @@
+export function getKeyCodesFromKeys(keys, { skipIdIfHasVariants = true } = {}) {
+  const res = /* @__PURE__ */ new Set();
+  for (const key of keys) {
+    if (key.variants) {
+      if (!skipIdIfHasVariants) {
+        res.add(key.id);
+      }
+      for (const variant of key.variants) {
+        res.add(variant);
+      }
+    } else {
+      res.add(key.id);
+    }
+  }
+  return Array.from(res);
+}

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "witchcraftSpellcraft",
   "configKey": "witchcraftSpellcraft",
-  "version": "0.0.3",
+  "version": "0.1.0",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/module.mjs

@@ -1,12 +1,7 @@
 import { createResolver, defineNuxtModule, addTypeTemplate, addImportsDir } from '@nuxt/kit';
 
-const dependencies = {
-	"@witchcraft/ui": "^0.3.2"};
-const pkg = {
-	dependencies: dependencies};
-
 const { resolve } = createResolver(import.meta.url);
-const module = defineNuxtModule({
+const module$1 = defineNuxtModule({
   meta: {
     name: "witchcraftSpellcraft",
     configKey: "witchcraftSpellcraft"
@@ -14,7 +9,7 @@ const module = defineNuxtModule({
   defaults: {},
   moduleDependencies: {
     "@witchcraft/ui/nuxt": {
-      version: pkg.dependencies["@witchcraft/ui"]
+      version: "^0.3.6"
     }
   },
   async setup(_options, nuxt) {
@@ -37,4 +32,4 @@ const module = defineNuxtModule({
   }
 });
 
-export { module as default };
+export { module$1 as default };

package/dist/runtime/types.d.ts

@@ -1,9 +1,7 @@
 export interface Register {
 }
-type ExtendedContextInfo = Register extends {
-    ExtendedContextInfo: infer T;
-} ? T : unknown;
-export type ContextInfo = ExtendedContextInfo & {
+export type ExtendedShortcutManagerInfo = keyof Register extends `ShortcutManagerContext${infer T}` ? Register extends Record<`ShortcutManagerContext${T}`, infer U> ? U : {} : {};
+export type ContextInfo = ExtendedShortcutManagerInfo & {
     count: Record<string, number>;
     isActive: Record<string, boolean>;
 };

package/package.json

@@ -1,156 +1,157 @@
 {
-	"name": "@witchcraft/spellcraft",
-	"description": "A shortcut manager library for handling ALL the shortcut needs of an application.",
-	"version": "0.0.3",
-	"type": "module",
-	"main": "./dist/core/index.js",
-	"sideEffects": false,
-	"build": {
-		"failOnWarn": false
-	},
-	"exports": {
-		".": {
-			"types": "./dist/core/index.d.ts",
-			"import": "./dist/core/index.js"
-		},
-		"./utils": {
-			"types": "./dist/utils/index.d.ts",
-			"import": "./dist/utils/index.js"
-		},
-		"./helpers": {
-			"types": "./dist/helpers/index.d.ts",
-			"import": "./dist/helpers/index.js"
-		},
-		"./types": {
-			"types": "./dist/types/index.d.ts",
-			"import": "./dist/types/index.js"
-		},
-		"./core": {
-			"types": "./dist/core/index.d.ts",
-			"import": "./dist/core/index.js"
-		},
-		"./nuxt": {
-			"types": "./dist/types.d.mts",
-			"import": "./dist/module.mjs"
-		},
-		"./*": {
-			"types": "./dist/*.js",
-			"import": "./dist/*.js"
-		}
-	},
-	"scripts": {
-		"prepare": "husky && pnpm nuxt-module-build prepare && pnpm build:only && cd playground && pnpm i --ignore-scripts --ignore-workspace",
-		"build": "nuxt-module-build prepare && nuxt-module-build build && nuxi generate playground",
-		"build:only": "nuxt-module-build build",
-		"dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
-		"dev:playground": "nuxi dev playground",
-		"dev": "nuxi dev playground",
-		"test": "pnpm lint:types && vitest run --exclude '.direnv/**/*'",
-		"test:watch": "vitest --watch --exclude '.direnv/**/*'",
-		"test:inspect-errors": "cross-env INSPECT_ERRORS=true npm run test",
-		"coverage": "vitest --exclude '.direnv/**/*' --coverage",
-		"coverage:dev": "vitest --exclude '.direnv/**/*'  --watch --coverage",
-		"doc": "typedoc",
-		"doc:watch": "onchange -i \"src/**/*.ts\" \"typedoc.config.js\" -- pnpm doc",
-		"doc:serve": "http-server docs --port=5001",
-		"doc:dev": "concurrently \"pnpm doc:watch\" \"pnpm doc:serve\"",
-		"doc:check-invalid": "typedoc --listInvalidSymbolLinks",
-		"lint:eslint": "eslint \"{src,test,playground/app}/**/*.{js,ts,vue,cjs}\" \"*.{js,ts}\" --max-warnings=0 --report-unused-disable-directives",
-		"lint:types": "vue-tsc --noEmit && echo 'todo cd playground && vue-tsc --noEmit'",
-		"lint:commits": "commitlint --from-last-tag --to HEAD --verbose",
-		"lint:imports": "madge --circular --extensions ts ./src",
-		"lint": "pnpm lint:types && pnpm lint:eslint && pnpm lint:commits && pnpm lint:imports",
-		"actions:debug": "act -r -v",
-		"gen:exports": "indexit update -o '${path}.js'"
-	},
-	"peerDependencies": {
-		"@witchcraft/expressit": "^0.4.0",
-		"@witchcraft/ui": "^0.3.2"
-	},
-	"peerDependenciesMeta": {
-		"@witchcraft/ui": {
-			"optional": true
-		},
-		"@witchcraft/expressit": {
-			"optional": true
-		}
-	},
-	"dependencies": {
-		"@alanscodelog/utils": "^6.0.2",
-		"@witchcraft/expressit": "^0.4.1",
-		"@witchcraft/ui": "^0.3.2",
-		"vue": "^3.5.21"
-	},
-	"devDependencies": {
-		"@alanscodelog/commitlint-config": "^3.1.2",
-		"@alanscodelog/eslint-config": "^6.3.1",
-		"@alanscodelog/semantic-release-config": "^5.0.4",
-		"@alanscodelog/tsconfigs": "^6.2.0",
-		"@alanscodelog/vite-config": "^0.0.6",
-		"@commitlint/cli": "^19.8.1",
-		"@iconify/json": "^2.2.385",
-		"@nuxt/eslint-config": "^1.9.0",
-		"@nuxt/kit": "^4.1.2",
-		"@nuxt/module-builder": "^1.0.2",
-		"@nuxt/schema": "^4.1.2",
-		"@nuxt/types": "^2.18.1",
-		"@types/node": "^24.5.2",
-		"@vitejs/plugin-vue": "^6.0.1",
-		"@vitest/coverage-c8": "^0.33.0",
-		"concurrently": "^9.2.1",
-		"cross-env": "^10.0.0",
-		"defu": "^6.1.4",
-		"fast-glob": "^3.3.3",
-		"http-server": "^14.1.1",
-		"husky": "^9.1.7",
-		"indexit": "2.1.0-beta.3",
-		"madge": "^8.0.0",
-		"nuxt": "^4.1.2",
-		"onchange": "^7.1.0",
-		"semantic-release": "^24.2.8",
-		"tailwindcss": "^4.1.13",
-		"typedoc": "0.28.13",
-		"typescript": "^5.9.2",
-		"unbuild": "^3.6.1",
-		"unplugin-icons": "^22.3.0",
-		"vite-tsconfig-paths": "^5.1.4",
-		"vitest": "^3.2.4",
-		"vue-tsc": "^3.0.7"
-	},
-	"author": "Alan <alanscodelog@gmail.com>",
-	"repository": "https://github.com/witchcraftjs/spellcraft",
-	"license": "MIT",
-	"files": [
-		"src",
-		"dist"
-	],
-	"release": {
-		"extends": [
-			"@alanscodelog/semantic-release-config"
-		]
-	},
-	"commitlint": {
-		"extends": [
-			"@alanscodelog"
-		]
-	},
-	"babel": {
-		"presets": [
-			"@alanscodelog"
-		]
-	},
-	"madge": {
-		"detectiveOptions": {
-			"ts": {
-				"skipTypeImports": true
-			}
-		}
-	},
-	"browserslist": "> 0.5%, last 2 versions, not dead, not < 0.25%, not IE > 0, maintained node versions",
-	"engines": {
-		"node": ">=20.0.0"
-	},
-	"publishConfig": {
-		"access": "public"
-	}
-}
+  "name": "@witchcraft/spellcraft",
+  "description": "A shortcut manager library for handling ALL the shortcut needs of an application.",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "./dist/core/index.js",
+  "sideEffects": false,
+  "build": {
+    "failOnWarn": false
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/core/index.d.ts",
+      "import": "./dist/core/index.js"
+    },
+    "./utils": {
+      "types": "./dist/utils/index.d.ts",
+      "import": "./dist/utils/index.js"
+    },
+    "./helpers": {
+      "types": "./dist/helpers/index.d.ts",
+      "import": "./dist/helpers/index.js"
+    },
+    "./types": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/types/index.js"
+    },
+    "./core": {
+      "types": "./dist/core/index.d.ts",
+      "import": "./dist/core/index.js"
+    },
+    "./nuxt": {
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs"
+    },
+    "./*": {
+      "types": "./dist/*.js",
+      "import": "./dist/*.js"
+    }
+  },
+  "peerDependencies": {
+    "@witchcraft/expressit": "^0.4.1",
+    "@witchcraft/ui": "^0.3.20"
+  },
+  "peerDependenciesMeta": {
+    "@witchcraft/ui": {
+      "optional": true
+    },
+    "@witchcraft/expressit": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@alanscodelog/utils": "^6.0.2",
+    "@witchcraft/expressit": "^0.4.1",
+    "@witchcraft/ui": "^0.3.20",
+    "reka-ui": "^2.8.0",
+    "vue": "^3.5.27"
+  },
+  "devDependencies": {
+    "@alanscodelog/commitlint-config": "^3.1.2",
+    "@alanscodelog/eslint-config": "^6.3.1",
+    "@alanscodelog/semantic-release-config": "^6.0.0",
+    "@alanscodelog/tsconfigs": "^6.2.0",
+    "@alanscodelog/vite-config": "^0.0.7",
+    "@commitlint/cli": "^20.4.1",
+    "@iconify/json": "^2.2.436",
+    "@nuxt/eslint-config": "^1.13.0",
+    "@nuxt/kit": "^4.3.0",
+    "@nuxt/module-builder": "^1.0.2",
+    "@nuxt/schema": "^4.3.0",
+    "@nuxt/types": "^2.18.1",
+    "@types/node": "^25.2.1",
+    "@vitejs/plugin-vue": "^6.0.4",
+    "@vitest/coverage-c8": "^0.33.0",
+    "concurrently": "^9.2.1",
+    "cross-env": "^10.1.0",
+    "defu": "^6.1.4",
+    "fast-glob": "^3.3.3",
+    "http-server": "^14.1.1",
+    "husky": "^9.1.7",
+    "indexit": "2.1.0-beta.3",
+    "madge": "^8.0.0",
+    "nuxt": "^4.3.0",
+    "onchange": "^7.1.0",
+    "semantic-release": "^25.0.3",
+    "tailwindcss": "^4.1.18",
+    "typedoc": "0.28.16",
+    "typescript": "^5.9.3",
+    "unbuild": "^3.6.1",
+    "unplugin-icons": "^23.0.1",
+    "vite-tsconfig-paths": "^6.0.5",
+    "vitest": "^4.0.18",
+    "vue-tsc": "^3.2.4"
+  },
+  "author": "Alan <alanscodelog@gmail.com>",
+  "repository": "https://github.com/witchcraftjs/spellcraft",
+  "license": "MIT",
+  "files": [
+    "src",
+    "dist"
+  ],
+  "release": {
+    "extends": [
+      "@alanscodelog/semantic-release-config"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@alanscodelog"
+    ]
+  },
+  "babel": {
+    "presets": [
+      "@alanscodelog"
+    ]
+  },
+  "madge": {
+    "detectiveOptions": {
+      "ts": {
+        "skipTypeImports": true
+      }
+    }
+  },
+  "browserslist": "> 0.5%, last 2 versions, not dead, not < 0.25%, not IE > 0, maintained node versions",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "build": "nuxt-module-build prepare && nuxt-module-build build && nuxi generate playground",
+    "build:only": "nuxt-module-build build",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "dev:playground": "nuxi dev playground",
+    "dev": "nuxi dev playground",
+    "test": "pnpm lint:types && vitest run --exclude '.direnv/**/*'",
+    "test:watch": "vitest --watch --exclude '.direnv/**/*'",
+    "test:inspect-errors": "cross-env INSPECT_ERRORS=true npm run test",
+    "coverage": "vitest --exclude '.direnv/**/*' --coverage",
+    "coverage:dev": "vitest --exclude '.direnv/**/*'  --watch --coverage",
+    "doc": "typedoc",
+    "doc:watch": "onchange -i \"src/**/*.ts\" \"typedoc.config.js\" -- pnpm doc",
+    "doc:serve": "http-server docs --port=5001",
+    "doc:dev": "concurrently \"pnpm doc:watch\" \"pnpm doc:serve\"",
+    "doc:check-invalid": "typedoc --listInvalidSymbolLinks",
+    "lint:eslint": "eslint \"{src,test,playground/app}/**/*.{js,ts,vue,cjs}\" \"*.{js,ts}\" --max-warnings=0 --report-unused-disable-directives",
+    "lint:types": "vue-tsc --noEmit && echo 'todo cd playground && vue-tsc --noEmit'",
+    "lint:commits": "commitlint --from-last-tag --to HEAD --verbose",
+    "lint:imports": "madge --circular --extensions ts ./src",
+    "lint": "pnpm lint:types && pnpm lint:eslint && pnpm lint:commits && pnpm lint:imports",
+    "actions:debug": "act -r -v",
+    "gen:exports": "indexit update -o '${path}.js'"
+  }
+}

package/src/helpers/getKeyCodesFromKeys.ts

@@ -0,0 +1,28 @@
+/**
+ * Given an list of keys, returns an array of deduped key codes.
+ *
+ * Useful for when the codes must be passed to a third-party library (for example, a dragging library that takes a list modifiers).
+ *
+ * This properly takes a look at the key and all it's variants.
+ *
+ * `skipIdIfHasVariants` is true by default and will skip adding the key's id if it has variants as it's assumed the id is not a valid name.
+ */
+
+import type { Key } from "../types/keys.js"
+
+export function getKeyCodesFromKeys(keys: Key[], { skipIdIfHasVariants = true}: { skipIdIfHasVariants?: boolean } = {}): string[] {
+	const res = new Set<string>()
+	for (const key of keys) {
+		if (key.variants) {
+			if (!skipIdIfHasVariants) {
+				res.add(key.id)
+			}
+			for (const variant of key.variants) {
+				res.add(variant)
+			}
+		} else {
+			res.add(key.id)
+		}
+	}
+	return Array.from(res)
+}

package/src/module.ts

@@ -5,8 +5,6 @@ import {
 	defineNuxtModule
 } from "@nuxt/kit"
 
-import pkg from "../package.json" with { type: "json" }
-
 
 const { resolve } = createResolver(import.meta.url)
 
@@ -30,7 +28,7 @@ export default defineNuxtModule<ModuleOptions>({
 	},
 	moduleDependencies: {
 		"@witchcraft/ui/nuxt": {
-			version: pkg.dependencies["@witchcraft/ui"]
+			version: "^0.3.6"
 		}
 	},
 	async setup(_options, nuxt) {

package/src/runtime/types.ts

@@ -1,9 +1,22 @@
-export interface Register { }
+// allows users to register multiple contexts
+// @eslint-disable-next-line @typescript-eslint/no-empty-object-type
+export interface Register {}
 
-// eslint-disable-next-line @typescript-eslint/naming-convention
-type ExtendedContextInfo = Register extends { ExtendedContextInfo: infer T } ? T : unknown
+export type ExtendedShortcutManagerInfo = keyof Register extends `ShortcutManagerContext${infer T}`
+	? Register extends Record<`ShortcutManagerContext${T}`, infer U>
+		? U
+		// we can further constrain the type users can register if needed
+		// ? U extends { }
+		// 	? U
+		// 	: {}
+		// : {}
+		// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+		: {}
+	// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+	: {}
 
-export type ContextInfo = ExtendedContextInfo & {
+
+export type ContextInfo = ExtendedShortcutManagerInfo & {
 	count: Record<string, number>
 	isActive: Record<string, boolean>
 }