es-application-template 0.0.7

package/dist/shortcuts/core/shortcut-binding.d.ts

@@ -0,0 +1,26 @@
+import { ShortcutPlatform } from './shortcut-platform';
+import { ShortcutBinding } from './types';
+export declare const shortcutCodeDisplay: (code: string) => string;
+/**
+ * Convert a stored logical binding into the physical modifier set for one OS.
+ * Primary => Ctrl on Windows/Linux/other, Meta(Command) on macOS.
+ */
+export declare const resolveShortcutBinding: (binding: ShortcutBinding, platform: ShortcutPlatform) => ShortcutBinding;
+export declare const resolvedBindingKey: (binding: ShortcutBinding | null | undefined, platform: ShortcutPlatform) => string;
+export declare const bindingsConflictOnPlatform: (left: ShortcutBinding, right: ShortcutBinding, platform: ShortcutPlatform) => boolean;
+/**
+ * Shortcut config is portable between products/devices. A binding pair is
+ * considered conflicting if it resolves to the same physical shortcut on any
+ * supported desktop platform. This prevents a config that works on Windows
+ * from becoming ambiguous when the same account opens macOS later.
+ */
+export declare const bindingsConflict: (left: ShortcutBinding, right: ShortcutBinding) => boolean;
+export declare const formatLogicalShortcutBinding: (binding?: ShortcutBinding | null) => string;
+/** Human-friendly display for the device that is currently running ADMIN. */
+export declare const formatShortcutBinding: (binding?: ShortcutBinding | null, platform?: ShortcutPlatform) => string;
+/**
+ * Keyboard events are physical (`Ctrl`/`Meta`). Only the settings capture UI
+ * translates the platform's main modifier into semantic `Primary`. Existing
+ * persisted Ctrl/Meta bindings therefore keep their original meaning.
+ */
+export declare const shortcutBindingFromCaptureEvent: (event: KeyboardEvent, platform?: ShortcutPlatform) => ShortcutBinding | null;

package/dist/shortcuts/core/shortcut-command.d.ts

@@ -0,0 +1,44 @@
+import { ReactNode } from 'react';
+import { ShortcutActionId } from './constants';
+import { ShortcutHandler, ShortcutHandlerContext } from './registry';
+export type ShortcutManagedScopeKind = Extract<ShortcutHandlerContext, 'page' | 'grid' | 'form' | 'control' | 'overlay'>;
+export type ShortcutCommand = {
+    handler: ShortcutHandler;
+    enabled?: boolean;
+};
+export type ShortcutCommandMap = Partial<Record<ShortcutActionId, ShortcutCommand>>;
+export type UseShortcutCommandOptions = {
+    enabled?: boolean;
+};
+type ManagedShortcutScopeValue = {
+    contextId: string;
+    kind: ShortcutManagedScopeKind;
+};
+type ManagedShortcutScopeProviderProps = ManagedShortcutScopeValue & {
+    children: ReactNode;
+};
+/**
+ * Compatibility API for screens that still use the old semantic Scope model.
+ * Feature code should prefer the <Shortcuts actions={...} /> facade.
+ */
+export declare const useShortcutCommand: (actionId: ShortcutActionId, handler: ShortcutHandler, options: UseShortcutCommandOptions) => void;
+/** Explicit opt-in for application-level commands. */
+export declare const useGlobalShortcutCommand: (actionId: ShortcutActionId, handler: ShortcutHandler, options: UseShortcutCommandOptions) => void;
+/** @internal Compatibility provider used only by the old semantic Scope API. */
+export declare const ManagedShortcutScopeProvider: ({ children, contextId, kind }: ManagedShortcutScopeProviderProps) => import("react/jsx-runtime").JSX.Element;
+/** @internal Compatibility registrar used only by the old semantic Scope API. */
+export declare const ShortcutCommandRegistrar: ({ commands }: {
+    commands?: ShortcutCommandMap;
+}) => import("react/jsx-runtime").JSX.Element;
+/**
+ * Internal auto-context registrar used by the feature-facing <Shortcuts /> facade.
+ *
+ * Feature code only supplies Action + Handler + Enabled. This registrar reads
+ * the real rendered DOM around its anchor and binds each action to the actual
+ * Page/Grid/Form/Overlay owner. It never accepts context id, parent id, active
+ * state, priority, or modal-stack information from the feature.
+ */
+export declare const ShortcutCommands: ({ commands }: {
+    commands?: ShortcutCommandMap;
+}) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/shortcuts/core/shortcut-config.d.ts

@@ -0,0 +1,25 @@
+import { ShortcutCatalogItem, ShortcutConfigDocument } from './types';
+type ShortcutActionMap = ShortcutConfigDocument['actions'];
+export declare const mergeShortcutActionMaps: (...maps: Array<ShortcutActionMap | null | undefined>) => ShortcutActionMap;
+export declare const mergeShortcutDocuments: (...documents: Array<ShortcutConfigDocument | null | undefined>) => ShortcutConfigDocument;
+export declare const parseShortcutConfigValue: (serialized: string | null | undefined, defaults: ShortcutConfigDocument) => ShortcutConfigDocument;
+export declare const resolveRuntimeShortcutDocument: (value: unknown, catalog: ShortcutCatalogItem[]) => ShortcutConfigDocument;
+/**
+ * Backend hiện trả System + User trong Value. Config mới giữ User intent ở
+ * userOverrides; dữ liệu actions cũ được khôi phục bằng diff với System.
+ */
+export declare const extractUserOverrides: (systemDocument: ShortcutConfigDocument, userEffectiveDocument: ShortcutConfigDocument) => ShortcutActionMap;
+export declare const buildUserShortcutSaveDocument: (systemDocument: ShortcutConfigDocument, userOverrides: ShortcutActionMap) => ShortcutConfigDocument;
+export type ShortcutImportIssueCode = 'UNKNOWN_ACTION' | 'RESERVED_BINDING' | 'CONFLICT' | 'INVALID_BINDING' | 'LOCKED_ACTION';
+export type ShortcutImportIssue = {
+    actionId?: string;
+    binding?: string;
+    code: ShortcutImportIssueCode;
+    message: string;
+};
+export type ShortcutImportResult = {
+    document: ShortcutConfigDocument;
+    issues: ShortcutImportIssue[];
+};
+export declare const parseShortcutImport: (value: unknown, catalog: ShortcutCatalogItem[], inheritedDocument: ShortcutConfigDocument) => ShortcutImportResult;
+export {};

package/dist/shortcuts/core/shortcut-dom-policy.d.ts

@@ -0,0 +1,13 @@
+export type ShortcutDomPolicy = {
+    pageBoundarySelector: string;
+    gridOwnerSelector: string;
+    overlayOwnerSelector: string;
+    blockingOverlaySelector: string;
+    /** Optional product selectors for rich text/grid editors beyond native form controls. */
+    editableTargetSelector?: string;
+    /** Optional product selectors for open dropdowns/popups that own Escape. */
+    nativePopupSelector?: string;
+};
+export type ShortcutDomPolicyOverride = Partial<ShortcutDomPolicy>;
+export declare const DEFAULT_SHORTCUT_DOM_POLICY: ShortcutDomPolicy;
+export declare const resolveShortcutDomPolicy: (override?: ShortcutDomPolicyOverride) => ShortcutDomPolicy;

package/dist/shortcuts/core/shortcut-platform.d.ts

@@ -0,0 +1,7 @@
+export type ShortcutPlatform = 'windows' | 'mac' | 'linux' | 'other';
+export declare const SUPPORTED_SHORTCUT_PLATFORMS: ShortcutPlatform[];
+/**
+ * Detect once at the runtime boundary. Feature code must never branch by OS.
+ * `other` intentionally follows the Windows/Linux Primary => Ctrl convention.
+ */
+export declare const getShortcutPlatform: () => ShortcutPlatform;

package/dist/shortcuts/core/shortcut-runtime-context.d.ts

@@ -0,0 +1,8 @@
+import { ShortcutActionId } from './constants';
+import { ShortcutDomPolicy } from './shortcut-dom-policy';
+import { ResolvedShortcutRow } from './types';
+export type ShortcutRuntimeContextValue = {
+    rowsByAction: ReadonlyMap<ShortcutActionId, ResolvedShortcutRow>;
+    domPolicy: ShortcutDomPolicy;
+};
+export declare const ShortcutRuntimeContext: import("react").Context<ShortcutRuntimeContextValue>;

package/dist/shortcuts/core/types.d.ts

@@ -0,0 +1,54 @@
+import { SHORTCUT_SCHEMA_VERSION, ShortcutActionId } from './constants';
+export type ShortcutModifier = 'Primary' | 'Ctrl' | 'Alt' | 'Shift' | 'Meta';
+export type ShortcutCatalogScope = 'global' | 'workspace' | 'module' | 'page' | 'context' | 'grid' | 'form' | 'overlay';
+export type ShortcutGroup = 'system' | 'record' | 'grid' | 'form' | 'data' | 'workflow';
+export type ShortcutCustomizeMode = 'locked' | 'customizable' | 'assignable';
+export type ShortcutBinding = {
+    modifiers: ShortcutModifier[];
+    code: string;
+    display: string;
+};
+export type ShortcutCatalogItem = {
+    actionId: ShortcutActionId;
+    label: string;
+    description?: string;
+    /** Nhóm thao tác chung, không phải module nghiệp vụ HRM/PM/MES. */
+    group: ShortcutGroup;
+    groupLabel: string;
+    /**
+     * Giữ lại để tương thích runtime hiện tại.
+     * Catalog chung dùng COMMON, không tạo shortcut theo từng module.
+     */
+    moduleCode: string;
+    moduleLabel: string;
+    scope: ShortcutCatalogScope;
+    defaultBinding?: ShortcutBinding;
+    customizeMode: ShortcutCustomizeMode;
+    customizable: boolean;
+    disableable: boolean;
+    locked: boolean;
+    dangerous?: boolean;
+    allowInEditable?: boolean;
+    repeatable?: boolean;
+    priority?: number;
+};
+export type ShortcutActionConfig = {
+    binding?: ShortcutBinding | null;
+    enabled?: boolean;
+};
+export type ShortcutConfigDocument = {
+    schemaVersion: typeof SHORTCUT_SCHEMA_VERSION;
+    actions: Partial<Record<ShortcutActionId, ShortcutActionConfig>>;
+    userOverrides?: Partial<Record<ShortcutActionId, ShortcutActionConfig>>;
+};
+export type ResolvedShortcutRow = ShortcutCatalogItem & {
+    currentBinding?: ShortcutBinding;
+    effectiveEnabled: boolean;
+    inheritedBinding?: ShortcutBinding;
+    inheritedEnabled: boolean;
+    customized: boolean;
+};
+export type ShortcutAction = ShortcutCatalogItem & {
+    id: string;
+    description: string;
+};

package/dist/shortcuts/core/use-shortcut-binding.d.ts

@@ -0,0 +1,14 @@
+import { ShortcutActionId } from './constants';
+import { ShortcutBinding } from './types';
+export type ShortcutHint = {
+    label: string;
+    description?: string;
+    binding?: ShortcutBinding;
+    enabled: boolean;
+};
+/**
+ * Trả về thông tin hiển thị của một shortcut theo cấu hình effective hiện tại.
+ * Hook chỉ đọc state đã resolve trong ShortcutProvider, không gọi API riêng.
+ */
+export declare const useShortcutHint: (actionId: ShortcutActionId) => ShortcutHint;
+export declare const useShortcutBinding: (actionId: ShortcutActionId) => ShortcutBinding | undefined;

package/dist/shortcuts/core/use-shortcut-context.d.ts

@@ -0,0 +1,35 @@
+import { FocusEvent as ReactFocusEvent } from 'react';
+import { ShortcutHandlerContext } from './registry';
+export declare const ShortcutParentContext: import("react").Context<string>;
+export type UseShortcutContextOptions = {
+    id?: string;
+    type?: ShortcutHandlerContext;
+    parentId?: string;
+    enabled?: boolean;
+    autoActivate?: boolean;
+};
+/** @internal Runtime primitive used by semantic scope components. */
+export declare const useShortcutRuntimeContext: (options?: UseShortcutContextOptions) => {
+    id: string;
+    contextId: string;
+    activate: (event?: {
+        currentTarget?: EventTarget | null;
+    }) => void;
+    deactivate: () => void;
+    ref: (owner: HTMLElement | null) => void;
+    ownerRef: import("react").MutableRefObject<HTMLElement>;
+    scopeProps: {
+        ref: (owner: HTMLElement | null) => void;
+        'data-shortcut-context-id': string;
+        onFocusCapture: (event?: {
+            currentTarget?: EventTarget | null;
+        }) => void;
+        onMouseDownCapture: (event?: {
+            currentTarget?: EventTarget | null;
+        }) => void;
+        onPointerDownCapture: (event?: {
+            currentTarget?: EventTarget | null;
+        }) => void;
+        onBlurCapture: (event: ReactFocusEvent<HTMLElement>) => void;
+    };
+};

package/dist/shortcuts/runtime/ShortcutGlobalActions.d.ts

@@ -0,0 +1,7 @@
+type ShortcutGlobalActionsProps = {
+    dashboardPath?: string;
+    shortcutSettingsPath?: string;
+    onSearch?: () => void;
+};
+export declare const ShortcutGlobalActions: ({ dashboardPath, shortcutSettingsPath, onSearch }: ShortcutGlobalActionsProps) => any;
+export {};

package/dist/shortcuts/runtime/ShortcutRuntime.d.ts

@@ -0,0 +1,9 @@
+import { ReactNode } from 'react';
+type ShortcutRuntimeProps = {
+    children: ReactNode;
+    dashboardPath?: string;
+    shortcutSettingsPath?: string;
+    onSearch?: () => void;
+};
+export declare const ShortcutRuntime: ({ children, dashboardPath, shortcutSettingsPath, onSearch }: ShortcutRuntimeProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/shortcuts/runtime/ShortcutTooltip.d.ts

@@ -0,0 +1,11 @@
+import { ShortcutActionId } from '../core';
+import { ReactNode } from 'react';
+type ShortcutTooltipPlacement = 'auto' | 'top' | 'bottom' | 'left' | 'right';
+type ShortcutTooltipProps = {
+    actionId: ShortcutActionId;
+    children: ReactNode;
+    placement?: ShortcutTooltipPlacement;
+};
+/** ADMIN UI adapter for rendering the effective shortcut hint with Reactstrap. */
+export declare const ShortcutTooltip: ({ actionId, children, placement }: ShortcutTooltipProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/shortcuts/runtime/app-shortcut-dom-policy.d.ts

@@ -0,0 +1,2 @@
+import { ShortcutDomPolicy } from '../core/runtime';
+export declare const APP_SHORTCUT_DOM_POLICY: ShortcutDomPolicy;

package/dist/shortcuts/runtime/constants.d.ts

@@ -0,0 +1,2 @@
+/** Shared system-setting code used to load and persist shortcut configuration. */
+export declare const SHORTCUT_CONFIG_CODE: "SYSTEM_SETTING_SHORTCUTS";

package/dist/shortcuts/runtime/use-shortcut-runtime-config.d.ts

@@ -0,0 +1,3 @@
+import { ShortcutConfigDocument } from '../core/runtime';
+/** Loads the effective shortcut document for the current product/user. */
+export declare const useShortcutRuntimeConfig: () => ShortcutConfigDocument;