@vef-framework/starter 2.0.11 → 2.1.0

package/dist/types/components/logo-icon/props.d.ts

@@ -1,10 +1,4 @@
 import { SVGProps } from 'react';
-/**
- * The props for the `IconLogo` component.
- */
 export interface LogoIconProps extends SVGProps<SVGSVGElement> {
-    /**
-     * The primary color of the logo.
-     */
     primaryColor?: string;
 }

package/dist/types/components/n-progress/components/bar.d.ts

@@ -1,5 +1,5 @@
 interface BarProps {
     progress: number;
 }
-export declare function Bar({ progress }: BarProps): import("@emotion/react/jsx-runtime").JSX.Element;
+export declare function Bar({ progress }: BarProps): React.ReactNode;
 export {};

package/dist/types/components/n-progress/components/container.d.ts

@@ -3,5 +3,5 @@ interface ContainerProps {
     animationDuration: number;
     isFinished: boolean;
 }
-export declare function Container({ animationDuration, isFinished, children }: PropsWithChildren<ContainerProps>): import("@emotion/react/jsx-runtime").JSX.Element;
+export declare function Container({ animationDuration, children, isFinished }: PropsWithChildren<ContainerProps>): React.ReactNode;
 export {};

package/dist/types/components/n-progress/event.d.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from '@vef-framework/shared';
-type NProgressEvent = {
-    start: void;
+interface NProgressEvent {
     complete: void;
-};
+    start: void;
+}
 export declare const nProgressEventEmitter: EventEmitter<NProgressEvent>;
 export {};

package/dist/types/components/n-progress/index.d.ts

@@ -1,2 +1,2 @@
-export declare function NProgress(): import("@emotion/react/jsx-runtime").JSX.Element;
+export declare function NProgress(): React.ReactNode;
 export { nProgressEventEmitter } from './event';

package/dist/types/components/not-found/index.d.ts

@@ -1 +1 @@
-export declare function NotFound(): import("@emotion/react/jsx-runtime").JSX.Element;
+export declare function NotFound(): React.ReactNode;

package/dist/types/components/page/components/aside-panel.d.ts

@@ -0,0 +1,11 @@
+import { SerializedStyles } from '@emotion/react';
+import { ReactNode } from 'react';
+import { AsideWidth } from '../props';
+export interface AsidePanelProps {
+    children: ReactNode;
+    className?: string;
+    containerStyle: SerializedStyles;
+    position: "left" | "right";
+    width?: AsideWidth;
+}
+export declare function AsidePanel({ children, className, containerStyle, position, width }: AsidePanelProps): import("@emotion/react/jsx-runtime").JSX.Element;

package/dist/types/components/page/components/index.d.ts

@@ -0,0 +1,3 @@
+export { AsidePanel } from './aside-panel';
+export { ResizeHandle } from './resize-handle';
+export { ScrollContent } from './scroll-content';

package/dist/types/components/page/components/resize-handle.d.ts

@@ -0,0 +1,7 @@
+import { MouseEvent, default as React } from 'react';
+export interface ResizeHandleProps {
+    isDragging: boolean;
+    position: "left" | "right";
+    onMouseDown: (event: MouseEvent) => void;
+}
+export declare function ResizeHandle({ isDragging, position, onMouseDown }: ResizeHandleProps): React.JSX.Element;

package/dist/types/components/page/{scroll-content.d.ts → components/scroll-content.d.ts}

@@ -4,5 +4,5 @@ interface ScrollContentProps extends PropsWithChildren {
     actionBar?: ReactNode;
     actionBarClassName?: string;
 }
-export declare function ScrollContent({ className, actionBar, actionBarClassName, children }: ScrollContentProps): import("@emotion/react/jsx-runtime").JSX.Element;
+export declare function ScrollContent({ className, actionBar, actionBarClassName, children }: ScrollContentProps): React.JSX.Element;
 export {};

package/dist/types/components/page/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export { usePageKey } from './use-page-key';
+export { useResize } from './use-resize';

package/dist/types/components/page/hooks/use-resize.d.ts

@@ -0,0 +1,15 @@
+import { MouseEvent as ReactMouseEvent } from 'react';
+export interface UseResizeOptions {
+    defaultWidth: number;
+    minWidth?: number;
+    maxWidth?: number;
+    /**
+     * true for left panel (drag right to increase), false for right panel (drag left to increase)
+     */
+    isLeftPanel?: boolean;
+}
+export declare function useResize(options: UseResizeOptions): {
+    width: number;
+    isDragging: boolean;
+    handleMouseDown: (event: ReactMouseEvent) => void;
+};

package/dist/types/components/page/index.d.ts

@@ -1,4 +1,4 @@
 import { PageProps } from './props';
-export declare function Page({ className, aside, asideClassName, asideWidth, header, headerClassName, footer, footerClassName, actionBar, actionBarClassName, scrollable, children }: PageProps): import("@emotion/react/jsx-runtime").JSX.Element;
-export { type PageProps } from './props';
+export declare function Page({ className, mainClassName, leftAside, leftAsideClassName, leftAsideWidth, rightAside, rightAsideClassName, rightAsideWidth, header, headerClassName, headerPosition, footer, footerClassName, footerPosition, actionBar, actionBarClassName, scrollable, scrollMargin, margin, gap, children }: PageProps): import("@emotion/react/jsx-runtime").JSX.Element;
+export { type AsideWidth, type PageProps, type Position, type ResizableWidth } from './props';
 export { useViewportHeight } from './viewport-context';

package/dist/types/components/page/props.d.ts

@@ -1,25 +1,91 @@
 import { Length } from '@vef-framework/components';
 import { PropsWithChildren, ReactNode } from 'react';
+/**
+ * Position type for header and footer.
+ * - `"inside"`: Inside the main content area
+ * - `"outside"`: Spans the full width of the page (including asides)
+ */
+export type Position = "inside" | "outside";
+/**
+ * Resizable width configuration for aside panels.
+ */
+export interface ResizableWidth {
+    /**
+     * Default width of the panel.
+     */
+    defaultWidth?: Length;
+    /**
+     * Minimum width constraint.
+     */
+    minWidth?: Length;
+    /**
+     * Maximum width constraint.
+     */
+    maxWidth?: Length;
+}
+/**
+ * Width type: fixed value or resizable configuration.
+ * - `string | number`: Fixed width, not resizable
+ * - `ResizableWidth`: Resizable with optional constraints
+ */
+export type AsideWidth = Length | ResizableWidth;
 /**
  * The props of the Page component.
  */
 export interface PageProps extends PropsWithChildren {
     /**
-     * The class name of the main content of the page.
+     * The class name of the page container.
      */
     className?: string;
     /**
-     * The aside content of the page.
+     * Whether the page container has margin.
+     * When true, applies var(--vef-spacing-md) margin to the container.
+     *
+     * @default false
+     */
+    margin?: boolean;
+    /**
+     * The gap between grid cells.
+     *
+     * @default "var(--vef-spacing-md)"
      */
-    aside?: ReactNode;
+    gap?: Length;
     /**
-     * The class name of the aside.
+     * The class name of the main content area.
      */
-    asideClassName?: string;
+    mainClassName?: string;
     /**
-     * The width of the aside.
+     * The left aside content of the page.
      */
-    asideWidth?: Length;
+    leftAside?: ReactNode;
+    /**
+     * The class name of the left aside.
+     */
+    leftAsideClassName?: string;
+    /**
+     * The width of the left aside.
+     * - `number | string`: Fixed width
+     * - `{ defaultWidth?, minWidth?, maxWidth? }`: Resizable with constraints
+     *
+     * @default 280
+     */
+    leftAsideWidth?: AsideWidth;
+    /**
+     * The right aside content of the page.
+     */
+    rightAside?: ReactNode;
+    /**
+     * The class name of the right aside.
+     */
+    rightAsideClassName?: string;
+    /**
+     * The width of the right aside.
+     * - `number | string`: Fixed width
+     * - `{ defaultWidth?, minWidth?, maxWidth? }`: Resizable with constraints
+     *
+     * @default 280
+     */
+    rightAsideWidth?: AsideWidth;
     /**
      * The header of the page.
      */
@@ -28,6 +94,14 @@ export interface PageProps extends PropsWithChildren {
      * The class name of the header.
      */
     headerClassName?: string;
+    /**
+     * The position of the header.
+     * - `"inside"`: Header is inside the main content area (default)
+     * - `"outside"`: Header spans the full width of the page (including asides)
+     *
+     * @default "inside"
+     */
+    headerPosition?: Position;
     /**
      * The footer of the page.
      */
@@ -36,6 +110,14 @@ export interface PageProps extends PropsWithChildren {
      * The class name of the footer.
      */
     footerClassName?: string;
+    /**
+     * The position of the footer.
+     * - `"inside"`: Footer is inside the main content area (default)
+     * - `"outside"`: Footer spans the full width of the page (including asides)
+     *
+     * @default "inside"
+     */
+    footerPosition?: Position;
     /**
      * The action bar of the page.
      */
@@ -48,4 +130,11 @@ export interface PageProps extends PropsWithChildren {
      * Whether the page main content is scrollable.
      */
     scrollable?: boolean;
+    /**
+     * Whether the scrollable content has automatic margin for scrollbar spacing.
+     * Only effective when scrollable is true.
+     *
+     * @default false
+     */
+    scrollMargin?: boolean;
 }

package/dist/types/components/page/styles.d.ts

@@ -1,11 +1,17 @@
 import { SerializedStyles } from '@emotion/serialize';
 export declare const page: SerializedStyles;
-export declare const aside: SerializedStyles;
+export declare const leftAside: SerializedStyles;
+export declare const rightAside: SerializedStyles;
+export declare const asideContent: SerializedStyles;
+export declare const resizeHandleGrip: SerializedStyles;
+export declare const resizeHandleLeft: SerializedStyles;
+export declare const resizeHandleRight: SerializedStyles;
 export declare const main: SerializedStyles;
 export declare const header: SerializedStyles;
+export declare const headerOutside: SerializedStyles;
 export declare const content: SerializedStyles;
-export declare const defaultContent: SerializedStyles;
 export declare const scrollWrapper: SerializedStyles;
 export declare const scrollContainer: SerializedStyles;
 export declare const footer: SerializedStyles;
+export declare const footerOutside: SerializedStyles;
 export declare const actionBar: SerializedStyles;

package/dist/types/components/pro-search/components/search-actions.d.ts

@@ -1,21 +1,9 @@
 import { ProSearchProps } from '../props';
 import { MemoExoticComponent } from 'react';
 interface SearchActionsProps {
-    /**
-     * Loading state
-     */
     loading?: boolean;
-    /**
-     * Search button props
-     */
     searchButtonProps?: ProSearchProps<never>["searchButtonProps"];
-    /**
-     * Reset button props, or false to hide the reset button
-     */
     resetButtonProps?: ProSearchProps<never>["resetButtonProps"];
-    /**
-     * Callback when search is reset
-     */
     onReset?: () => void;
 }
 export declare const SearchActions: MemoExoticComponent<({ loading, searchButtonProps, resetButtonProps, onReset }: SearchActionsProps) => import("@emotion/react/jsx-runtime").JSX.Element>;

package/dist/types/components/pro-table/components/table.d.ts

@@ -1,11 +1,12 @@
+import { AnyObject } from '@vef-framework/shared';
 import { NonPaginatedProTableProps, PaginatedProTableProps } from '../props';
 import { ColumnSettingsProp } from '../types';
-type PaginatedTableProps<TRow extends object, TParams extends object> = Pick<PaginatedProTableProps<TRow, TParams>, "className" | "style" | "size" | "queryFn" | "queryEnabled" | "queryParams" | "columns" | "rowKey" | "rowSelection" | "showSequenceColumn" | "operationColumn" | "selectedRowKeys" | "virtual" | "title" | "summary" | "onSelectedRowKeysChange"> & {
+type PaginatedTableProps<TRow extends AnyObject, TParams extends AnyObject> = Pick<PaginatedProTableProps<TRow, TParams>, "className" | "style" | "size" | "queryFn" | "queryEnabled" | "queryParams" | "columns" | "rowKey" | "rowSelection" | "showSequenceColumn" | "operationColumn" | "selectedRowKeys" | "virtual" | "title" | "summary" | "onSelectedRowKeysChange"> & {
     columnSettings: ColumnSettingsProp;
 };
-type NonPaginatedTableProps<TRow extends object, TParams extends object> = Pick<NonPaginatedProTableProps<TRow, TParams>, "className" | "style" | "size" | "queryFn" | "queryEnabled" | "queryParams" | "columns" | "rowKey" | "rowSelection" | "showSequenceColumn" | "operationColumn" | "selectedRowKeys" | "virtual" | "title" | "summary" | "onSelectedRowKeysChange"> & {
+type NonPaginatedTableProps<TRow extends AnyObject, TParams extends AnyObject> = Pick<NonPaginatedProTableProps<TRow, TParams>, "className" | "style" | "size" | "queryFn" | "queryEnabled" | "queryParams" | "columns" | "rowKey" | "rowSelection" | "showSequenceColumn" | "operationColumn" | "selectedRowKeys" | "virtual" | "title" | "summary" | "onSelectedRowKeysChange"> & {
     columnSettings: ColumnSettingsProp;
 };
-export declare function PaginatedTable<TRow extends object, TParams extends object>({ className, style, size, queryFn, columns, columnSettings, rowKey, rowSelection, queryEnabled, queryParams, showSequenceColumn, operationColumn, selectedRowKeys, virtual, title, summary, onSelectedRowKeysChange }: PaginatedTableProps<TRow, TParams>): import("@emotion/react/jsx-runtime").JSX.Element;
-export declare function NonPaginatedTable<TRow extends object, TParams extends object>({ className, style, size, queryFn, columns, columnSettings, rowKey, rowSelection, queryEnabled, queryParams, showSequenceColumn, operationColumn, selectedRowKeys, virtual, title, summary, onSelectedRowKeysChange }: NonPaginatedTableProps<TRow, TParams>): import("@emotion/react/jsx-runtime").JSX.Element;
+export declare function PaginatedTable<TRow extends AnyObject, TParams extends AnyObject>({ className, style, size, queryFn, columns, columnSettings, rowKey, rowSelection, queryEnabled, queryParams, showSequenceColumn, operationColumn, selectedRowKeys, virtual, title, summary, onSelectedRowKeysChange }: PaginatedTableProps<TRow, TParams>): import("@emotion/react/jsx-runtime").JSX.Element;
+export declare function NonPaginatedTable<TRow extends AnyObject, TParams extends AnyObject>({ className, style, size, queryFn, columns, columnSettings, rowKey, rowSelection, queryEnabled, queryParams, showSequenceColumn, operationColumn, selectedRowKeys, virtual, title, summary, onSelectedRowKeysChange }: NonPaginatedTableProps<TRow, TParams>): import("@emotion/react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/components/pro-table/hooks/use-row-selection.d.ts

@@ -2,11 +2,6 @@ import { TableRowSelection } from '@vef-framework/components';
 import { Key } from '@vef-framework/shared';
 import { RowSelectionConfig } from '../types';
 /**
- * Hook to create row selection configuration for ProTable
- *
- * @param config - The row selection configuration
- * @param selectedRowKeys - The currently selected row keys
- * @param onSelectedRowKeysChange - Callback when selected row keys change
- * @returns The table row selection configuration
+ * Hook to create row selection configuration for ProTable.
  */
-export declare function useRowSelection<TRow extends object>(config: RowSelectionConfig<TRow> | true | undefined, selectedRowKeys?: Key[], onSelectedRowKeysChange?: (selectedRowKeys: Key[], selectedRows: TRow[]) => void): TableRowSelection<TRow> | undefined;
+export declare function useRowSelection<TRow>(config: RowSelectionConfig<TRow> | true | undefined, selectedRowKeys?: Key[], onSelectedRowKeysChange?: (selectedRowKeys: Key[], selectedRows: TRow[]) => void): TableRowSelection<TRow> | undefined;

package/dist/types/components/pro-table/hooks/use-table-columns.d.ts

@@ -1,4 +1,5 @@
 import { TableColumn } from '@vef-framework/components';
+import { AnyObject } from '@vef-framework/shared';
 import { ColumnSettingsProp, OperationColumnConfig } from '../types';
 /**
  * The hook to use the table columns.
@@ -9,4 +10,4 @@ import { ColumnSettingsProp, OperationColumnConfig } from '../types';
  * @param columnSettingsProp - Column settings configuration.
  * @returns The table columns.
  */
-export declare function useTableColumns<TRow extends object>(tableColumns: Array<TableColumn<TRow>>, operationColumn?: OperationColumnConfig<TRow>, showSequenceColumn?: boolean, columnSettingsProp?: ColumnSettingsProp): Array<TableColumn<TRow>>;
+export declare function useTableColumns<TRow extends AnyObject>(tableColumns: Array<TableColumn<TRow>>, operationColumn?: OperationColumnConfig<TRow>, showSequenceColumn?: boolean, columnSettingsProp?: ColumnSettingsProp): Array<TableColumn<TRow>>;

package/dist/types/components/pro-table/index.d.ts

@@ -1,8 +1,8 @@
-import { Awaitable } from '@vef-framework/shared';
+import { AnyObject, Awaitable } from '@vef-framework/shared';
 import { FC, ReactNode } from 'react';
 import { ProTableProps } from './props';
 import { ProTableRef } from './types';
-export declare const ProTable: (<TRow extends object, TParams extends object>(props: ProTableProps<TRow, TParams> & {
+export declare const ProTable: (<TRow extends AnyObject, TParams extends AnyObject>(props: ProTableProps<TRow, TParams> & {
     ref?: React.Ref<ProTableRef>;
 }) => Awaitable<ReactNode>) & Pick<FC, "displayName">;
 export { OperationButtonGroup, TableSubscriber as ProTableSubscriber, type OperationButtonGroupProps, type TableSubscriberProps as ProTableSubscriberProps } from './components';

package/dist/types/components/pro-table/props.d.ts

@@ -1,6 +1,6 @@
 import { TableColumn, TableProps } from '@vef-framework/components';
 import { PaginationResult, QueryFunction } from '@vef-framework/core';
-import { DeepKeys, Key } from '@vef-framework/shared';
+import { AnyObject, DeepKeys, Key } from '@vef-framework/shared';
 import { CSSProperties, ReactNode } from 'react';
 import { ColumnSettingsProp, OperationColumnConfig, ParamsWithPagination, ParamsWithSort, RowSelectionConfig } from './types';
 /**
@@ -9,7 +9,7 @@ import { ColumnSettingsProp, OperationColumnConfig, ParamsWithPagination, Params
  * @template TRow - The type of table row data
  * @template TParams - The type of query parameters
  */
-interface BaseProTableProps<TRow, TParams> extends Pick<TableProps<TRow>, "size"> {
+interface BaseProTableProps<TRow extends AnyObject, TParams extends AnyObject> extends Pick<TableProps<TRow>, "size"> {
     /**
      * Class name for the table container
      */
@@ -26,25 +26,27 @@ interface BaseProTableProps<TRow, TParams> extends Pick<TableProps<TRow>, "size"
      * Column settings configuration.
      * - `false`: Disable column settings feature
      * - `{ storageKey?: string }`: Enable with optional localStorage persistence
+     *
      * @default {}
      */
     columnSettings?: ColumnSettingsProp;
     /**
      * Whether to show the sequence (row number) column. Default is true.
-    */
+     */
     showSequenceColumn?: boolean;
     /**
-      * Row key extractor: either a deep key of the row model or a function
-    */
+     * Row key extractor: either a deep key of the row model or a function
+     */
     rowKey?: DeepKeys<NoInfer<TRow>> | ((row: NoInfer<TRow>) => Key);
     /**
      * Enable virtual scrolling for the table to improve performance with large datasets
+     *
      * @default false
      */
     virtual?: boolean;
     /**
-   * Currently selected row keys
-   */
+     * Currently selected row keys
+     */
     selectedRowKeys?: Key[];
     /**
      * Operation column configuration for per-row actions
@@ -92,7 +94,7 @@ interface BaseProTableProps<TRow, TParams> extends Pick<TableProps<TRow>, "size"
  * @template TRow - The type of table row data
  * @template TParams - The type of query parameters
  */
-export interface PaginatedProTableProps<TRow, TParams> extends BaseProTableProps<TRow, TParams> {
+export interface PaginatedProTableProps<TRow extends AnyObject, TParams extends AnyObject> extends BaseProTableProps<TRow, TParams> {
     /**
      * Enable pagination mode. Default is true.
      */
@@ -108,7 +110,7 @@ export interface PaginatedProTableProps<TRow, TParams> extends BaseProTableProps
  * @template TRow - The type of table row data
  * @template TParams - The type of query parameters
  */
-export interface NonPaginatedProTableProps<TRow, TParams> extends BaseProTableProps<TRow, TParams> {
+export interface NonPaginatedProTableProps<TRow extends AnyObject, TParams extends AnyObject> extends BaseProTableProps<TRow, TParams> {
     /**
      * Disable pagination mode for this variant
      */
@@ -121,5 +123,5 @@ export interface NonPaginatedProTableProps<TRow, TParams> extends BaseProTablePr
 /**
  * Discriminated union of paginated and non-paginated ProTable props
  */
-export type ProTableProps<TRow, TParams> = PaginatedProTableProps<TRow, TParams> | NonPaginatedProTableProps<TRow, TParams>;
+export type ProTableProps<TRow extends AnyObject, TParams extends AnyObject> = PaginatedProTableProps<TRow, TParams> | NonPaginatedProTableProps<TRow, TParams>;
 export {};

package/dist/types/components/router-provider/context.d.ts

@@ -1,6 +1,7 @@
 import { AnyRouter, RegisteredRouter, RouterProps } from '@tanstack/react-router';
 import { MaybeNull } from '@vef-framework/shared';
 import { Provider } from 'react';
-export type UseRouterContext<TRouter extends AnyRouter = RegisteredRouter, TDehydrated extends Record<string, any> = Record<string, any>> = () => NonNullable<RouterProps<TRouter, TDehydrated>["context"]>;
-export declare function useRouterContextHook(): MaybeNull<UseRouterContext<AnyRouter, Record<string, any>>>;
+export type RouterContext<TRouter extends AnyRouter = RegisteredRouter, TDehydrated extends Record<string, any> = Record<string, any>> = NonNullable<RouterProps<TRouter, TDehydrated>["context"]>;
+export type UseRouterContext<TRouter extends AnyRouter = RegisteredRouter, TDehydrated extends Record<string, any> = Record<string, any>> = () => RouterContext<TRouter, TDehydrated>;
+export declare function useRouterContextHook(): MaybeNull<UseRouterContext>;
 export declare const RouterContextHookProvider: Provider<MaybeNull<UseRouterContext<AnyRouter, Record<string, any>>>>;

package/dist/types/components/router-provider/index.d.ts

@@ -1,5 +1,5 @@
 import { AnyRouter, RegisteredRouter } from '@tanstack/react-router';
 import { RouterProviderProps } from './props';
-export declare function RouterProvider<TRouter extends AnyRouter = RegisteredRouter, TDehydrated extends Record<string, any> = Record<string, any>>({ router }: RouterProviderProps<TRouter, TDehydrated>): import("@emotion/react/jsx-runtime").JSX.Element;
-export { RouterContextHookProvider, type UseRouterContext } from './context';
+export declare function RouterProvider<TRouter extends AnyRouter = RegisteredRouter, TDehydrated extends Record<string, any> = Record<string, any>>({ router }: RouterProviderProps<TRouter, TDehydrated>): React.ReactNode;
+export { RouterContextHookProvider, type RouterContext, type UseRouterContext } from './context';
 export { type RouterProviderProps } from './props';

package/dist/types/components/theme-config-provider/index.d.ts

@@ -1,2 +1,2 @@
 import { PropsWithChildren } from 'react';
-export declare function ThemeConfigProvider({ children }: PropsWithChildren): import("@emotion/react/jsx-runtime").JSX.Element;
+export declare function ThemeConfigProvider({ children }: PropsWithChildren): React.JSX.Element;

package/dist/types/constants/event.d.ts

@@ -1,12 +1,3 @@
-/**
- * The event type for reloading the page.
- */
 export declare const RELOAD_PAGE_EVENT = "__vef_reload_page_event";
-/**
- * The event type for access denied.
- */
 export declare const ACCESS_DENIED_EVENT = "__vef_access_denied_event";
-/**
- * The event type for unauthenticated.
- */
 export declare const UNAUTHENTICATED_EVENT = "__vef_unauthenticated_event";

package/dist/types/constants/router.d.ts

@@ -1,24 +1,6 @@
-/**
- * The route path of the login page.
- */
 export declare const LOGIN_ROUTE_PATH = "/login";
-/**
- * The route id of the login page.
- */
 export declare const LOGIN_ROUTE_ID = "/_common/login";
-/**
- * The route path of the index page.
- */
 export declare const INDEX_ROUTE_PATH = "/";
-/**
- * The route id of the index page.
- */
 export declare const INDEX_ROUTE_ID = "/_layout";
-/**
- * The route path of the access denied page.
- */
 export declare const ACCESS_DENIED_ROUTE_PATH = "/access-denied";
-/**
- * The route id of the access denied page.
- */
 export declare const ACCESS_DENIED_ROUTE_ID = "/_common/access-denied";

package/dist/types/constants/storage.d.ts

@@ -1,8 +1,2 @@
-/**
- * The prefix of the storage key.
- */
 export declare const STORAGE_KEY_PREFIX_STORE = "__VEF_STORE__";
-/**
- * The suffix of the storage key.
- */
 export declare const STORAGE_KEY_SUFFIX_STORE = "__";

package/dist/types/constants/symbols.d.ts

@@ -1,8 +1,2 @@
-/**
- * Global symbol for marking pagination metadata in request parameters.
- */
 export declare const SYMBOL_PAGINATION: unique symbol;
-/**
- * Global symbol for marking sort/order metadata in request parameters.
- */
 export declare const SYMBOL_SORT: unique symbol;

package/dist/types/helpers/app-version.d.ts

@@ -1,88 +1,19 @@
 import { ReactNode } from 'react';
-/**
- * Application changelog structure
- */
 export interface AppChangelog {
-    /**
-     * Version number
-     */
     version: string;
-    /**
-     * Release date
-     */
     date?: string;
-    /**
-     * Detailed description
-     */
     description?: string;
-    /**
-     * List of changes in this version
-     */
     changes?: string[];
 }
-/**
- * Configuration options for app version notification
- */
 export interface AppVersionNotificationOptions {
-    /**
-     * Whether to enable automatic update detection
-     *
-     * Recommended to set this to `import.meta.env.PROD` in your application,
-     * so it only runs in production builds.
-     *
-     * @default false
-     */
     enabled?: boolean;
-    /**
-     * Base path for all requests (e.g., "/app", "/static")
-     *
-     * This will be prepended to all URL requests for index.html and changelog.json
-     *
-     * @default "/"
-     */
     basePath?: string;
-    /**
-     * The interval (in seconds) to check for updates
-     *
-     * @default 60
-     */
     checkInterval?: number;
-    /**
-     * Custom notification title
-     */
     title?: ReactNode;
-    /**
-     * Custom notification description
-     */
     description?: ReactNode;
-    /**
-     * Custom confirm button text
-     */
     confirmText?: ReactNode;
-    /**
-     * Custom cancel button text
-     */
     cancelText?: ReactNode;
-    /**
-     * Callback when user confirms update
-     */
     onConfirm?: () => void;
-    /**
-     * Callback when user cancels update
-     */
     onCancel?: () => void;
 }
-/**
- * Setup automatic app version notification
- *
- * This function monitors for app version changes by comparing the current version
- * with the version in the deployed HTML file. When a new version is detected,
- * it shows a notification prompting the user to refresh the page.
- *
- * The version is obtained from the `<meta name="app-version">` tag in the HTML.
- * It uses semantic versioning comparison via the `compare-versions` library.
- *
- * @param options - Configuration options
- * @returns A cleanup function to stop version checking
- */
 export declare function setupAppVersionNotification(options?: AppVersionNotificationOptions): (() => void) | undefined;

package/dist/types/helpers/app.d.ts

@@ -1,24 +1,11 @@
 import { AnyRouter, RegisteredRouter } from '@tanstack/react-router';
 import { AppProps, UseRouterContext } from '../components';
-/**
- * Configuration options for creating an app instance
- */
-export interface AppOptions<TRouter extends AnyRouter = RegisteredRouter, TDehydrated extends Record<string, any> = Record<string, any>> {
-    /**
-     * Whether to enable React's StrictMode for development checks
-     */
+export interface AppOptions<TRouter extends AnyRouter = RegisteredRouter, TDehydrated extends Record<string, unknown> = Record<string, unknown>> {
     strictMode?: boolean;
-    /**
-     * Custom hook for accessing router context
-     */
     useRouterContext?: UseRouterContext<TRouter, TDehydrated>;
 }
-/**
- * Create the app
- *
- * @returns The app
- */
-export declare function createApp<TRouter extends AnyRouter = RegisteredRouter, TDehydrated extends Record<string, any> = Record<string, any>>({ strictMode, useRouterContext }?: AppOptions<TRouter, TDehydrated>): {
-    render(props: AppProps): void;
-    unmount(): void;
-};
+export interface AppInstance {
+    render: (props: AppProps) => void;
+    unmount: () => void;
+}
+export declare function createApp<TRouter extends AnyRouter = RegisteredRouter, TDehydrated extends Record<string, unknown> = Record<string, unknown>>({ strictMode, useRouterContext }?: AppOptions<TRouter, TDehydrated>): AppInstance;

package/dist/types/helpers/auth.d.ts

@@ -1,7 +1,2 @@
 import { AnyRouter } from '@tanstack/react-router';
-/**
- * Handles the client logout process.
- *
- * @param router - The router instance.
- */
 export declare function handleClientLogout(router: AnyRouter): Promise<void>;