@dsh-stack/tweak-keybinds 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,5 @@
-# Temporary Holding Version
+# tweak-keybinds
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Keybind settings surface: the tweaks-keybinds section schema and validation consumed by the client.
+
+An extension of the `tweaks` settings surface, split out of the bundled `tweaks` package.

package/lib/index.d.ts

@@ -0,0 +1,27 @@
+/**
+ * `tweak-keybinds`: the keybind settings surface — the `tweaks-keybinds`
+ * section schema with validation, consumed by the client. Split out of the
+ * bundled `tweaks` package.
+ * @module tweak-keybinds
+ */
+import type { Context } from "@deepseek-ai/cordis";
+import type z from "@deepseek-ai/schemastery";
+import { type KeybindsConfig as KeybindsConfigType } from "./settings.js";
+export { NS_KEYBINDS, KeybindEntry, KeybindsConfig } from "./settings.js";
+export type { KeybindEntry as KeybindEntryType, KeybindsConfig as KeybindsConfigType, } from "./settings.js";
+export { validateKeybinds } from "./keybinds.js";
+export declare const name = "tweak-keybinds";
+export declare const inject: string[];
+/** The keybinds extension config: the keybinds section itself. */
+export type Config = KeybindsConfigType;
+export declare const Config: z<Config>;
+/**
+ * apply implementation.
+ *
+ * The keybind form is the `KeybindsConfig` this plugin already declares, and its
+ * namespace is this plugin's entry id, so there is nothing to install. The
+ * chord invariants are checked here instead of on write: the settings service
+ * validates a write against the schema alone, and an empty chord or an action
+ * bound to two chords is a cross-entry rule no field schema can express.
+ */
+export declare function apply(ctx: Context, config: Config): void;

package/lib/index.js

@@ -0,0 +1,31 @@
+/**
+ * `tweak-keybinds`: the keybind settings surface — the `tweaks-keybinds`
+ * section schema with validation, consumed by the client. Split out of the
+ * bundled `tweaks` package.
+ * @module tweak-keybinds
+ */
+import { declareCustomSettingsPage } from "@dsh-stack/plugin-kit";
+import { validateKeybinds } from "./keybinds.js";
+import { KeybindsConfig, } from "./settings.js";
+export { NS_KEYBINDS, KeybindEntry, KeybindsConfig } from "./settings.js";
+export { validateKeybinds } from "./keybinds.js";
+export const name = "tweak-keybinds";
+export const inject = [];
+export const Config = KeybindsConfig;
+/**
+ * apply implementation.
+ *
+ * The keybind form is the `KeybindsConfig` this plugin already declares, and its
+ * namespace is this plugin's entry id, so there is nothing to install. The
+ * chord invariants are checked here instead of on write: the settings service
+ * validates a write against the schema alone, and an empty chord or an action
+ * bound to two chords is a cross-entry rule no field schema can express.
+ */
+export function apply(ctx, config) {
+    const keybinds = {
+        enabled: config?.enabled ?? true,
+        keymap: config?.keymap ?? [],
+    };
+    validateKeybinds(keybinds.keymap);
+    declareCustomSettingsPage(ctx);
+}

package/lib/keybinds.d.ts

@@ -0,0 +1,8 @@
+/**
+ * tweak-keybinds validation: the settings `validate` hook logic for keybind
+ * entries.
+ * @module tweak-keybinds/keybinds
+ */
+import type { KeybindEntry } from "./settings.js";
+/** Validate a keybind entry list (used by the settings `validate` hook). */
+export declare function validateKeybinds(entries: KeybindEntry[]): void;

package/lib/keybinds.js

@@ -0,0 +1,19 @@
+/**
+ * tweak-keybinds validation: the settings `validate` hook logic for keybind
+ * entries.
+ * @module tweak-keybinds/keybinds
+ */
+/** Validate a keybind entry list (used by the settings `validate` hook). */
+export function validateKeybinds(entries) {
+    const seen = new Map();
+    for (const entry of entries) {
+        if (entry.keys.trim().length === 0) {
+            throw new Error(`keybind "${entry.action}" has an empty chord`);
+        }
+        const prior = seen.get(entry.action);
+        if (prior !== undefined && prior !== entry.keys) {
+            throw new Error(`keybind action "${entry.action}" bound twice (${prior} vs ${entry.keys})`);
+        }
+        seen.set(entry.action, entry.keys);
+    }
+}

package/lib/settings.d.ts

@@ -0,0 +1,24 @@
+/**
+ * tweak-keybinds settings: the keybind settings surface schema — a keymap of
+ * action → chord consumed by the client.
+ * @module tweak-keybinds/settings
+ */
+import z from "@deepseek-ai/schemastery";
+/** Namespace of the keybind section — this plugin's own Loader entry id. */
+export declare const NS_KEYBINDS: import("@dsh-stack/plugin-kit").SettingsNamespace;
+/** One keybind: a named action bound to a key chord. */
+export interface KeybindEntry {
+    /** The action id (e.g. `plan.toggle`, `undo`, `redo`). */
+    action: string;
+    /** The key chord (e.g. `mod+t`, `alt+u`). */
+    keys: string;
+    /** Optional per-keymap override (default keymap implied when absent). */
+    when?: string;
+}
+export declare const KeybindEntry: z<KeybindEntry>;
+/** The keybind section: a keymap of action → chord. */
+export interface KeybindsConfig {
+    enabled: boolean;
+    keymap: KeybindEntry[];
+}
+export declare const KeybindsConfig: z<KeybindsConfig>;

package/lib/settings.js

@@ -0,0 +1,18 @@
+/**
+ * tweak-keybinds settings: the keybind settings surface schema — a keymap of
+ * action → chord consumed by the client.
+ * @module tweak-keybinds/settings
+ */
+import z from "@deepseek-ai/schemastery";
+import { settingsNamespace } from "@dsh-stack/plugin-kit";
+/** Namespace of the keybind section — this plugin's own Loader entry id. */
+export const NS_KEYBINDS = settingsNamespace("tweak-keybinds");
+export const KeybindEntry = z.object({
+    action: z.string(),
+    keys: z.string(),
+    when: z.string(),
+});
+export const KeybindsConfig = z.object({
+    enabled: z.boolean().default(true),
+    keymap: z.array(KeybindEntry).default([]),
+});

package/package.json

@@ -1,6 +1,52 @@
 {
   "name": "@dsh-stack/tweak-keybinds",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Keybind settings surface: the tweaks-keybinds section schema and validation consumed by the client.",
+  "license": "MIT",
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.js"
+    }
+  },
+  "files": [
+    "lib",
+    "README.md",
+    "package.json",
+    "stack.json"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "stack": {
+    "kind": "plugin",
+    "id": "stack.tweaks.keybinds"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "node check-plugin.mjs"
+  },
+  "peerDependencies": {
+    "@deepseek-ai/cordis": "^4.0.1",
+    "@deepseek-ai/schemastery": "*",
+    "@deepseek-ai/dsh-settings": "0.2.0-rc.2"
+  },
+  "dependencies": {
+    "@dsh-stack/plugin-kit": "0.1.0"
+  },
+  "devDependencies": {
+    "typescript": "^6.0.3",
+    "@deepseek-ai/cordis": "^4.0.1",
+    "@deepseek-ai/schemastery": "*",
+    "@deepseek-ai/dsh-settings": "0.2.0-rc.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/marius-patrik/dsh-stack.git",
+    "directory": "plugins/tweak-keybinds"
+  }
+}

package/stack.json

@@ -0,0 +1,10 @@
+{
+  "id": "stack.tweaks.keybinds",
+  "name": "@dsh-stack/tweak-keybinds",
+  "version": "0.1.0",
+  "kind": "plugin",
+  "description": "Keybind settings surface: the tweaks-keybinds section schema and validation consumed by the client.",
+  "files": ["lib", "README.md", "package.json", "stack.json"],
+  "dependencies": ["stack.library.plugin-kit"],
+  "optionalDependencies": []
+}