es-application-template 0.0.7

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 0.1.0
+
+- Initial standalone package extracted from the verified ADMIN embedded module.
+- Includes Setting runtime and `SettingsPage`.
+- Includes Shortcut runtime and `ShortcutsPage` with the 54-action default catalog.
+- Includes JSON import/export for Setting management.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ES
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,127 @@
+# es-application-template
+
+Shared Setting and Shortcut infrastructure for ES applications.
+
+The package layout/build convention follows `client/es-document-template`: `src/index.tsx`, `src/package/index.ts`, `rollup.config.mjs`, one package `tsconfig.json`, CJS + ESM + declaration + extracted CSS output.
+
+## Install
+
+```bash
+npm install es-application-template
+```
+
+Host applications provide the peer dependencies declared in `package.json`, including React 18, TanStack React Query and `es-grid-template >=1.9.72 <2`.
+
+Package CSS is emitted at:
+
+```text
+dist/styles/index.css
+```
+
+## Provider
+
+```tsx
+import { AppProvider } from 'es-application-template'
+
+<AppProvider>
+  <App />
+</AppProvider>
+```
+
+The package uses the host `QueryClientProvider`; it does not create its own `QueryClient`.
+
+## Setting
+
+```ts
+import { setting } from 'es-application-template'
+
+const visible = setting.get(
+  'PurchaseRequest.ui.form.field.Code.visible',
+  true
+)
+```
+
+The public Setting contract remains `setting.get(key[, fallback])`. No public `useSetting()` API is added.
+
+## Shortcut
+
+```tsx
+import {
+  Shortcuts,
+  SHORTCUT_ACTION,
+  type ShortcutActions
+} from 'es-application-template'
+
+const actions: ShortcutActions = {
+  [SHORTCUT_ACTION.RECORD_EDIT]: {
+    handler: handleEdit,
+    enabled: canEdit
+  }
+}
+
+<Shortcuts actions={actions} />
+```
+
+## Management pages
+
+The management screens stay independent:
+
+```tsx
+import {
+  SettingsPage,
+  ShortcutsPage
+} from 'es-application-template'
+```
+
+The host owns routing/menu placement. These are full management pages, not modal content.
+
+## Public API
+
+```text
+AppProvider
+
+setting
+SettingsPage
+
+ShortcutsPage
+Shortcuts
+SHORTCUT_ACTION
+ShortcutTooltip
+ShortcutOverlayScope
+useShortcutHint
+
+ShortcutActionId
+ShortcutActions
+```
+
+## Deliberate differences from es-document-template
+
+The package follows its package/build skeleton, but does not copy unrelated document dependencies. In particular this package does not use:
+
+```text
+@esvndev/becoxy-ui
+@syncfusion/ej2-react-dropdowns
+react-custom-scrollbars
+rollup-plugin-dts
+```
+
+The Setting Feature tree selector is package-owned and implemented with `react-select` while preserving hierarchy/search/expand-collapse behavior.
+
+## Build
+
+```bash
+yarn install
+yarn typecheck
+yarn test
+yarn build
+npm pack
+```
+
+Expected output:
+
+```text
+dist/index.js
+dist/index.mjs
+dist/index.d.ts
+dist/styles/index.css
+```

package/dist/api/index.d.ts

@@ -0,0 +1,21 @@
+import { IConfig, IParamsConfigByCode } from '../domain/models/IConfig';
+import { IFListBoxResourceProductDeployParams } from '../domain/models/IProductsDeploy';
+export declare const configApi: {
+    getConfigByCodeApi: (params: IParamsConfigByCode) => Promise<any>;
+    updateApi: (params: IConfig) => Promise<any>;
+    deleteApi: (id: string) => Promise<any>;
+};
+export declare const settingCatalogApi: {
+    getResourceByTenantApi: (params: IFListBoxResourceProductDeployParams) => Promise<any>;
+};
+declare const _default: {
+    configApi: {
+        getConfigByCodeApi: (params: IParamsConfigByCode) => Promise<any>;
+        updateApi: (params: IConfig) => Promise<any>;
+        deleteApi: (id: string) => Promise<any>;
+    };
+    settingCatalogApi: {
+        getResourceByTenantApi: (params: IFListBoxResourceProductDeployParams) => Promise<any>;
+    };
+};
+export default _default;

package/dist/components/input/index.d.ts

@@ -0,0 +1,3 @@
+export { default as SwitchInput } from './input-switch';
+export type { SwitchInputProps } from './input-switch';
+export { default as TextInput } from './input-text';

package/dist/components/input/input-switch/index.d.ts

@@ -0,0 +1,24 @@
+import { ReactNode } from 'react';
+import { Control, FieldValues, Path, RegisterOptions } from 'react-hook-form';
+export type SwitchInputProps<TFieldValues extends FieldValues = FieldValues> = {
+    control?: Control<TFieldValues>;
+    name?: Path<TFieldValues>;
+    label?: string;
+    description?: string;
+    disabled?: boolean;
+    checked?: boolean;
+    value?: boolean;
+    onChange?: (checked: boolean) => void;
+    callback?: (checked: boolean) => void;
+    rules?: RegisterOptions<TFieldValues>;
+    compact?: boolean;
+    suffix?: ReactNode;
+    className?: string;
+    inputClassName?: string;
+    labelClassName?: string;
+    descriptionClassName?: string;
+    id?: string;
+    [key: string]: any;
+};
+declare const SwitchInput: <TFieldValues extends FieldValues = FieldValues>({ control, name, label, description, disabled, checked, value, onChange, callback, rules, compact, suffix, className, inputClassName, labelClassName, descriptionClassName, id, ...rest }: SwitchInputProps<TFieldValues>) => import("react/jsx-runtime").JSX.Element;
+export default SwitchInput;

package/dist/components/input/input-text/index.d.ts

@@ -0,0 +1,35 @@
+import { InputType } from 'reactstrap/types/lib/Input';
+type ControlledTextValue = string | number | readonly string[] | undefined;
+type TextInputProps = {
+    control?: any;
+    name?: string;
+    type?: InputType;
+    label?: string;
+    labelClassName?: string;
+    labelSize?: string;
+    required?: boolean;
+    errors?: any;
+    classes?: string;
+    height?: number | string;
+    disabled?: boolean;
+    row?: number;
+    isLabel?: boolean;
+    inLine?: boolean;
+    autoFocus?: boolean;
+    widthInput?: number | string;
+    AlignRight?: boolean;
+    placeholder?: string;
+    callback?: (event: any) => void;
+    readOnly?: boolean;
+    handleBlur?: (value: string) => void;
+    description?: string;
+    rules?: any;
+    value?: ControlledTextValue;
+    onChange?: (value: string) => void;
+    size?: 'sm' | 'lg';
+    id?: string;
+    className?: string;
+    [key: string]: any;
+};
+declare const TextInput: ({ control, name, type, label, labelClassName, labelSize, required, errors, classes, height, disabled, row, isLabel, inLine, autoFocus, widthInput, AlignRight, placeholder, callback, readOnly, handleBlur, description, rules, value, onChange, size, id, className, ...rest }: TextInputProps) => import("react/jsx-runtime").JSX.Element;
+export default TextInput;

package/dist/components/modal-header/index.d.ts

@@ -0,0 +1,2 @@
+declare const ModalHeader: (props: any) => import("react/jsx-runtime").JSX.Element;
+export default ModalHeader;

package/dist/components/notifications/index.d.ts

@@ -0,0 +1,2 @@
+export declare const notificationSuccess: (message: string) => string;
+export declare const notificationError: (message: string) => string;

package/dist/components/select/select/index.d.ts

@@ -0,0 +1,35 @@
+type SelectOption = {
+    value: any;
+    label: string;
+    [key: string]: any;
+};
+type SelectBoxProps = {
+    control?: any;
+    name?: string;
+    placeholder?: string;
+    disabled?: boolean;
+    options: SelectOption[];
+    label?: string;
+    description?: string;
+    isLabel?: boolean;
+    labelSize?: string;
+    classes?: string;
+    required?: boolean;
+    errors?: any;
+    isMulti?: boolean;
+    isClearable?: boolean;
+    labelComponent?: any;
+    callback?: (option: any) => void;
+    onInputChange?: any;
+    fieldValue?: string;
+    inLine?: boolean;
+    selectRef?: any;
+    menuPosition?: 'fixed' | 'absolute';
+    rules?: any;
+    value?: any;
+    onChange?: (value: any) => void;
+    className?: string;
+    [key: string]: any;
+};
+declare const SelectBox: ({ control, name, placeholder, disabled, options, label, description, isLabel, labelSize, classes, required, errors, isMulti, isClearable, labelComponent, callback, onInputChange, fieldValue, inLine, selectRef, menuPosition, rules, value, onChange, className, ...rest }: SelectBoxProps) => import("react/jsx-runtime").JSX.Element;
+export default SelectBox;

package/dist/components/sidebar/index.d.ts

@@ -0,0 +1,14 @@
+interface IFDataProps {
+    open: boolean;
+    children: any;
+    toggleSidebar: any;
+    width?: string | number;
+    keyboard?: boolean;
+    hiddenBackground?: boolean;
+    hiddenFullScreenButton?: boolean;
+    backdropClassName?: string;
+    panelClassName?: string;
+    zIndex?: number;
+}
+declare const Sidebar: (props: IFDataProps) => import("react/jsx-runtime").JSX.Element;
+export default Sidebar;

package/dist/config/config-cache.d.ts

@@ -0,0 +1,71 @@
+export declare const CONFIG_CACHE_POLICY: {
+    readonly FEATURE_FLAG: {
+        readonly staleTime: number;
+        readonly gcTime: number;
+        readonly persist: false;
+        readonly localStorageTtl: 0;
+        readonly refetchOnWindowFocus: true;
+        readonly refetchOnReconnect: true;
+    };
+    readonly SECURITY: {
+        readonly staleTime: number;
+        readonly gcTime: number;
+        readonly persist: false;
+        readonly localStorageTtl: 0;
+        readonly refetchOnWindowFocus: true;
+        readonly refetchOnReconnect: true;
+    };
+    readonly PRODUCT_RUNTIME: {
+        readonly staleTime: number;
+        readonly gcTime: number;
+        readonly persist: true;
+        readonly localStorageTtl: number;
+        readonly refetchOnWindowFocus: false;
+        readonly refetchOnReconnect: true;
+    };
+    readonly SETTING: {
+        readonly staleTime: number;
+        readonly gcTime: number;
+        readonly persist: false;
+        readonly localStorageTtl: 0;
+        readonly refetchOnWindowFocus: true;
+        readonly refetchOnReconnect: true;
+    };
+    readonly APPEARANCE: {
+        readonly staleTime: number;
+        readonly gcTime: number;
+        readonly persist: true;
+        readonly localStorageTtl: any;
+        readonly refetchOnWindowFocus: true;
+        readonly refetchOnReconnect: true;
+    };
+    readonly USER_PREFERENCE: {
+        readonly staleTime: number;
+        readonly gcTime: number;
+        readonly persist: true;
+        readonly localStorageTtl: number;
+        readonly refetchOnWindowFocus: false;
+        readonly refetchOnReconnect: true;
+    };
+    readonly USER_FREQUENT: {
+        readonly staleTime: number;
+        readonly gcTime: number;
+        readonly persist: true;
+        readonly localStorageTtl: number;
+        readonly refetchOnWindowFocus: true;
+        readonly refetchOnReconnect: true;
+    };
+    readonly ADMIN_RARE: {
+        readonly staleTime: number;
+        readonly gcTime: number;
+        readonly persist: false;
+        readonly localStorageTtl: 0;
+        readonly refetchOnWindowFocus: false;
+        readonly refetchOnReconnect: true;
+    };
+};
+export type ConfigCachePolicyName = keyof typeof CONFIG_CACHE_POLICY;
+export declare const configQueryKeys: {
+    byCodeRoot: (code: string) => readonly [string, string];
+    byCode: (code: string, productCode?: string | null, userId?: string | null) => readonly [string, string, string, string];
+};

package/dist/config/config-document.d.ts

@@ -0,0 +1,26 @@
+import { ConfigCachePolicyName } from './config-cache';
+type UseConfigDocumentOptions = {
+    productCode?: string | null;
+    userId?: string | null;
+    policy?: ConfigCachePolicyName;
+    enabled?: boolean;
+};
+export declare const useConfigDocument: <T extends Record<string, unknown>>(code: string, defaults: T, name?: string, normalize?: (value: T) => T, options?: UseConfigDocumentOptions) => {
+    value: T;
+    setValue: (next: T) => void;
+    patch: <K extends keyof T>(key: K, next: T[K]) => void;
+    save: (nextValue?: T) => Promise<boolean>;
+    reset: () => Promise<boolean>;
+    retry: () => Promise<void>;
+    discard: () => T;
+    ready: boolean;
+    loading: boolean;
+    fetching: boolean;
+    error: Error;
+    saving: boolean;
+    dirty: boolean;
+    remoteId: string;
+    exists: boolean;
+    dataMode: string;
+};
+export {};

package/dist/config/config-storage.d.ts

@@ -0,0 +1,15 @@
+import { IConfigIdentity } from '../domain/models/IConfig';
+import { QueryClient } from '@tanstack/react-query';
+export type ConfigSnapshot<T> = {
+    version: number;
+    code: string;
+    productCode: string | null;
+    userId: string | null;
+    cachedAt: number;
+    value: T;
+};
+export declare const saveConfigSnapshot: <T>(code: string, identity: IConfigIdentity, value: T) => void;
+export declare const loadConfigSnapshot: <T>(code: string, identity: IConfigIdentity, ttl?: number | null) => ConfigSnapshot<T> | null;
+export declare const removeConfigSnapshot: (code: string, identity: IConfigIdentity) => void;
+export declare const removeUserConfigSnapshots: (userId?: string | null) => void;
+export declare const registerConfigStorageSync: (queryClient: QueryClient) => () => void;

package/dist/config/config-utils.d.ts

@@ -0,0 +1,8 @@
+import { IConfig } from '../domain/models/IConfig';
+export declare const isPlainObject: (value: unknown) => value is Record<string, unknown>;
+export declare const unwrapConfig: (response: unknown) => IConfig | undefined;
+export declare const deepMerge: <T>(defaults: T, stored: unknown) => T;
+export declare const parseConfigValue: <T>(serialized: string | null | undefined, defaults: T) => T;
+export declare const businessSucceeded: (response: unknown) => boolean;
+export declare const getHttpStatus: (error: unknown) => number | undefined;
+export declare const buildConfigOverride: (baseValue?: string | null, currentValue?: string | null) => string;

package/dist/config/mock-store.d.ts

@@ -0,0 +1,41 @@
+import { IConfig } from '../domain/models/IConfig';
+export declare const isSystemSettingsMockMode: () => boolean;
+export declare const mockConfigStore: {
+    get(code: string, productCode?: string | null, userId?: string | null): Promise<IConfig | undefined>;
+    save(payload: IConfig): Promise<IConfig & {
+        isValid: true;
+    }>;
+    remove(code: string, productCode?: string | null, userId?: string | null): Promise<{
+        isValid: true;
+    }>;
+    listByPrefix(prefix: string): Promise<IConfig[]>;
+    removeById(id: string): Promise<{
+        isValid: true;
+    }>;
+};
+export declare const mockEntityStore: {
+    ensure<T extends {
+        id: string;
+    }>(key: string, initial: T[]): void;
+    list<T extends {
+        id: string;
+    }>(key: string): Promise<T[]>;
+    create<T extends {
+        id: string;
+    }>(key: string, row: T): Promise<T & {
+        isValid: true;
+    }>;
+    update<T extends {
+        id: string;
+    }>(key: string, id: string, patch: Partial<T>): Promise<T & {
+        isValid: true;
+    }>;
+    remove(key: string, id: string): Promise<{
+        isValid: true;
+    }>;
+    reset<T extends {
+        id: string;
+    }>(key: string, rows: T[]): Promise<{
+        isValid: true;
+    }>;
+};

package/dist/config/runtime-identity.d.ts

@@ -0,0 +1,4 @@
+import { IConfigIdentity } from '../domain/models/IConfig';
+export declare const getCurrentProductCode: () => string | null;
+export declare const getCurrentUserId: () => string | null;
+export declare const getRuntimeConfigIdentity: () => IConfigIdentity;

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

@@ -0,0 +1,21 @@
+import { IConfig, IConfigIdentity } from '../domain/models/IConfig';
+import { ConfigCachePolicyName } from './config-cache';
+type UseRuntimeConfigOptions<T> = {
+    code: string;
+    defaults: T;
+    identity: IConfigIdentity;
+    policy: ConfigCachePolicyName;
+    normalize?: (value: T) => T;
+    enabled?: boolean;
+};
+export declare const useRuntimeConfig: <T extends Record<string, unknown>>({ code, defaults, identity, policy, normalize, enabled }: UseRuntimeConfigOptions<T>) => {
+    value: T;
+    ready: boolean;
+    config: IConfig;
+    loading: false;
+    fetching: boolean;
+    error: Error;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<any, Error>>;
+    dataMode: string;
+};
+export {};

package/dist/domain/constants/index.d.ts

@@ -0,0 +1,18 @@
+export declare const BASE_URL: string;
+export declare const PRODUCTDEPLOY: {
+    URL_API: {
+        GET_RESOURCE_API: string;
+    };
+};
+export declare const CONFIG: {
+    ACTION_TYPES: {
+        GET_BY_CODE: string;
+        UPDATE: string;
+        DELETE: string;
+    };
+    URL_API: {
+        GET_BY_CODE_API: string;
+        UPDATE_API: string;
+        DELETE_API: string;
+    };
+};

package/dist/domain/models/IConfig.d.ts

@@ -0,0 +1,28 @@
+export interface IConfig {
+    id?: string | null;
+    code: string;
+    name?: string | null;
+    description?: string | null;
+    value?: string | null;
+    status?: number | null;
+    displayOrder?: number | null;
+    groupId?: string | null;
+    groupName?: string | null;
+    createdBy?: string | null;
+    createdDate?: string | null;
+    updatedBy?: string | null;
+    updatedDate?: string | null;
+    updatedByName?: string | null;
+    createdByName?: string | null;
+    productCode?: string | null;
+    userId?: string | null;
+}
+export type IParamsConfigByCode = {
+    code: string;
+    productCode?: string | null;
+    userId?: string | null;
+};
+export type IConfigIdentity = {
+    productCode: string | null;
+    userId: string | null;
+};

package/dist/domain/models/IProductsDeploy.d.ts

@@ -0,0 +1,6 @@
+export interface IFListBoxResourceProductDeployParams {
+    $tenantCode: string;
+    $status?: number;
+    $productCode: string;
+    $keyword: string;
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import './styles.scss';
+export * from './package';