@qilin-agent/client-ui-shortcuts 0.0.0-stage → 3.1.4

package/lib/index.js

@@ -0,0 +1,6 @@
+//#region lib/types/index.js
+/** Host Loader entry; keyboard commands execute in the browser half. */
+/** Register the browser package without adding Host behavior. */
+function apply() {}
+//#endregion
+export { apply };

package/lib/types/client/Editor.d.ts

@@ -0,0 +1,18 @@
+import type { ShortcutCatalogEntry } from '@qilin-agent/client-shortcuts/client';
+import type { InjectFace, PropsLocale } from '@qilin-agent/client-ui-slots';
+import type { ReferenceInjected } from './Reference.tsx';
+type EditorInjected = ReferenceInjected;
+type EditorProps = InjectFace<EditorInjected> & PropsLocale<'shortcuts'> & {
+    target: ShortcutCatalogEntry;
+    onClose(this: void): void;
+    onSaved(this: void): void;
+    onError(this: void, message: string): void;
+};
+/**
+ * Save a released physical combination against the configuration the user reviewed.
+ * @param props - command, accepted snapshots, and storage/feedback callbacks.
+ * @returns inline command controls; failures retain the draft and allow another recording.
+ */
+export declare function ShortcutEditor({ target, onClose, onSaved, onError, useCatalog, useConfig, useFixedCatalog, edit, recording, describeBinding, runtime, platform, t }: EditorProps): import("react").JSX.Element;
+export {};
+//# sourceMappingURL=Editor.d.ts.map

package/lib/types/client/Icons.d.ts

@@ -0,0 +1,17 @@
+/** Supplied shortcut-control and feedback artwork, colored by the owning UI. */
+declare const artwork: {
+    edit: import("react").JSX.Element;
+    error: import("react").JSX.Element;
+    success: import("react").JSX.Element;
+};
+/**
+ * Render the shortcut design artwork at its supplied size.
+ * @param props - glyph kind and semantic color class.
+ * @returns an ornamental SVG hidden from assistive technology.
+ */
+export declare function ShortcutIcon({ kind, className }: {
+    kind: keyof typeof artwork;
+    className?: string | undefined;
+}): import("react").JSX.Element;
+export {};
+//# sourceMappingURL=Icons.d.ts.map

package/lib/types/client/Reference.d.ts

@@ -0,0 +1,33 @@
+import type { InjectFace, PropsLocale, PropsRuntime } from '@qilin-agent/client-ui-slots';
+import type { ObservableSnapshot, PropsStore } from '@qilin-agent/client-store';
+import type { ShortcutCatalogEntry, ShortcutPlatform, Shortcuts } from '@qilin-agent/client-shortcuts/client';
+import type { createShortcutsStore } from './store.ts';
+/** Catalog and device labels delivered through renderer-bound hooks. */
+export interface ReferenceInjected {
+    platform: ShortcutPlatform;
+    runtime: Shortcuts['runtime'];
+    edit: Shortcuts['edit'];
+    recording: Shortcuts['recording'];
+    describeBinding: Shortcuts['describeBinding'];
+    hooks: {
+        catalog: ObservableSnapshot<readonly ShortcutCatalogEntry[]>;
+        config: Shortcuts['config'];
+        fixedCatalog: Shortcuts['fixedCatalog'];
+    };
+}
+type Store = PropsStore<ReturnType<typeof createShortcutsStore>>;
+type Locale = PropsLocale<'shortcuts'>;
+/**
+ * Render the General Settings action that opens the shortcut reference.
+ * @param props - shared dialog action and localized labels.
+ * @returns the settings row.
+ */
+export declare function ShortcutsRow({ actions, t, useCatalog }: PropsRuntime<'settings.general.item'> & Store & Locale & InjectFace<ReferenceInjected>): import("react").JSX.Element;
+/**
+ * Render core actions in product order, then other commands by ID within each group. Search relevance takes precedence.
+ * @param props - root store, effective catalog, and localized copy.
+ * @returns the single reference dialog when open.
+ */
+export declare function ShortcutReference({ useStore, actions, useCatalog, useConfig, useFixedCatalog, platform, runtime, edit, recording, describeBinding, t, }: PropsRuntime<'shell.overlay'> & Store & Locale & InjectFace<ReferenceInjected>): import("react").JSX.Element;
+export {};
+//# sourceMappingURL=Reference.d.ts.map

package/lib/types/client/feedback.d.ts

@@ -0,0 +1,22 @@
+/** Localized failures shared by direct removal and inline shortcut editing. */
+import type { ShortcutConfigSnapshot, ShortcutRuntime, ShortcutSaveResult } from '@qilin-agent/client-shortcuts/protocol';
+import type { ShortcutCatalogEntry } from '@qilin-agent/client-shortcuts/client';
+import type { PropsLocale } from '@qilin-agent/client-ui-slots';
+/**
+ * Identify the unreadable preferences, their recovery path, and the bindings still in use.
+ * @param config - failed read and last accepted preferences.
+ * @param runtime - storage owner whose location and reload action to show.
+ * @param t - shortcut dictionary.
+ * @returns localized recovery guidance without replacing the stored document.
+ */
+export declare function shortcutReadFailure(config: ShortcutConfigSnapshot, runtime: ShortcutRuntime, t: PropsLocale<'shortcuts'>['t']): string;
+/**
+ * Describe an unsuccessful preference write without losing command names.
+ * @param result - rejected operation result.
+ * @param catalog - current command labels.
+ * @param t - shortcut dictionary.
+ * @param runtime - storage owner for unreadable-document recovery guidance.
+ * @returns localized diagnosis for a system toast and accessible field description.
+ */
+export declare function shortcutFailure(result: ShortcutSaveResult, catalog: readonly Pick<ShortcutCatalogEntry, 'id' | 'label'>[], t: PropsLocale<'shortcuts'>['t'], runtime: ShortcutRuntime): string;
+//# sourceMappingURL=feedback.d.ts.map

package/lib/types/client/fixed.d.ts

@@ -0,0 +1,10 @@
+/** Menu reservations contributed by the product's shortcut reference integration. */
+import type { ShortcutFixedCommand } from '@qilin-agent/client-shortcuts/client';
+import type { PropsLocale } from '@qilin-agent/client-ui-slots';
+/**
+ * Describe shared menu actions for display and conflict checking.
+ * @param t - shortcut dictionary.
+ * @returns read-only actions and each physical combination they occupy.
+ */
+export declare function fixedCommands(t: PropsLocale<'shortcuts'>['t']): readonly ShortcutFixedCommand[];
+//# sourceMappingURL=fixed.d.ts.map

package/lib/types/client/index.d.ts

@@ -0,0 +1,17 @@
+/** Shortcut reference plugin; commands and entry points share one declared store. */
+import type { Context } from '@qilin-agent/kylin';
+import { zh } from './locales.ts';
+declare module '@qilin-agent/client-ui-slots' {
+    interface LocaleNamespaceMap {
+        /** Shortcut reference and settings entry copy. */
+        shortcuts: keyof typeof zh;
+    }
+}
+/** Required command, locale, and slot services. */
+export declare const inject: string[];
+/**
+ * Register the reference command, settings row, and single shell overlay.
+ * @param ctx - plugin-owned client context.
+ */
+export declare function apply(ctx: Context): void;
+//# sourceMappingURL=index.d.ts.map

package/lib/types/client/locales.d.ts

@@ -0,0 +1,62 @@
+/** Shortcut reference copy; only implemented operations appear in the catalog. */
+export declare const zh: {
+    'edit-label': string;
+    record: string;
+    'record-help': string;
+    'web-help': string;
+    'unsupported-key': string;
+    reserved: string;
+    'modifier-required': string;
+    'too-many-keys': string;
+    'macos-web-help': string;
+    'windows-web-help': string;
+    'unsupported-browser': string;
+    conflict: string;
+    saved: string;
+    clear: string;
+    'retry-save': string;
+    reset: string;
+    'reset-all': string;
+    'modified-count': string;
+    'reset-title': string;
+    'reset-description': string;
+    cancel: string;
+    'reset-saved': string;
+    'close-confirmation': string;
+    'reset-failed': string;
+    review: string;
+    stale: string;
+    'write-failed': string;
+    'not-ready': string;
+    read: string;
+    invalid: string;
+    future: string;
+    'web-document': string;
+    'desktop-document': string;
+    'web-reload': string;
+    'desktop-reload': string;
+    'using-defaults': string;
+    'using-accepted': string;
+    'native-failed': string;
+    'global-hint': string;
+    'clear-search': string;
+    title: string;
+    open: string;
+    settings: string;
+    view: string;
+    description: string;
+    search: string;
+    close: string;
+    application: string;
+    input: string;
+    menus: string;
+    approval: string;
+    unbound: string;
+    empty: string;
+    move: string;
+    select: string;
+    dismiss: string;
+};
+/** Typed English counterpart. */
+export declare const en: Record<keyof typeof zh, string>;
+//# sourceMappingURL=locales.d.ts.map

package/lib/types/client/store.d.ts

@@ -0,0 +1,19 @@
+/** Shortcut reference visibility and search state, shared by its entry points. */
+import { type EngineStoreHandle } from '@qilin-agent/client-store';
+type State = {
+    open: boolean;
+    query: string;
+    focusRequest: number;
+};
+type Actions = {
+    open(draft: State): void;
+    close(draft: State): void;
+    search(draft: State, query: string): void;
+};
+/**
+ * Declare the reference dialog store.
+ * @returns root-scoped visibility, focus request, and search actions.
+ */
+export declare function createShortcutsStore(): EngineStoreHandle<State, Actions>;
+export {};
+//# sourceMappingURL=store.d.ts.map

package/lib/types/index.d.ts

@@ -0,0 +1,4 @@
+/** Host Loader entry; keyboard commands execute in the browser half. */
+/** Register the browser package without adding Host behavior. */
+export declare function apply(): void;
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,71 @@
 {
   "name": "@qilin-agent/client-ui-shortcuts",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "description": "Keyboard shortcut reference, recording, and local preference editing",
+  "version": "3.1.4",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kkutysllb/QiLin.git",
+    "directory": "packages/client/ui-shortcuts"
+  },
+  "engines": {
+    "node": "^22.19.0 || >=24.0.0"
+  },
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./client": {
+      "types": "./lib/types/client/index.d.ts",
+      "default": "./lib/client.js"
+    },
+    "./src/*": "./src/*",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "lib/index.js",
+    "lib/client.js",
+    "lib/types/**/*.d.ts"
+  ],
+  "license": "MIT",
+  "qilin": {
+    "client": {
+      "inject": [
+        "@qilin-agent/client-shortcuts",
+        "@qilin-agent/client-locale",
+        "@qilin-agent/client-ui-layout",
+        "@qilin-agent/client-ui-settings"
+      ],
+      "platform": "web"
+    }
+  },
+  "peerDependencies": {
+    "@qilin-agent/kylin": "~4.0.3"
+  },
+  "devDependencies": {
+    "@types/react": "~18.3.1",
+    "clsx": "^2.1.1",
+    "react": "^18.2.0",
+    "@qilin-agent/kylin": "~4.0.3",
+    "@qilin-agent/brand": "3.1.4",
+    "@qilin-agent/client-store": "3.1.4",
+    "@qilin-agent/client-test-runtime": "3.1.4",
+    "@qilin-agent/client-shortcuts": "3.1.4",
+    "@qilin-agent/client-locale": "3.1.4",
+    "@qilin-agent/client-ui-layout": "3.1.4",
+    "@qilin-agent/client-ui-renderer": "3.1.4",
+    "@qilin-agent/client-ui-primitives": "3.1.4",
+    "@qilin-agent/client-ui-settings": "3.1.4",
+    "@qilin-agent/client-ui-slots": "3.1.4"
+  },
+  "scripts": {
+    "bundle": "tsdown",
+    "watch": "tsdown --watch"
+  }
 }