@faasjs/ant-design 8.0.0-beta.34 → 8.0.0-beta.36

package/dist/index.d.ts

@@ -1,19 +1,11 @@
 import { ErrorBoundaryProps, FaasDataInjection, FaasDataInjection as FaasDataInjection$1, FaasDataWrapperProps as FaasDataWrapperProps$1, FaasDataWrapperRef, FaasReactClient, FaasReactClientOptions, faas, useFaas } from "@faasjs/react";
 import { ButtonProps, ConfigProviderProps as ConfigProviderProps$1, DatePickerProps, DescriptionsProps, Drawer, DrawerProps as DrawerProps$1, FormInstance, FormItemProps as FormItemProps$1, FormProps as FormProps$1, GlobalToken, InputNumberProps, InputProps, Modal, ModalProps as ModalProps$1, RadioProps, SelectProps, SwitchProps, TableColumnProps, TablePaginationConfig, TableProps as TableProps$1, TabsProps as TabsProps$1 } from "antd";
 import { BrowserRouterProps, RouteProps } from "react-router-dom";
-import * as _$react from "react";
 import { CSSProperties, ComponentType, Dispatch, FC, JSX, LazyExoticComponent, ReactElement, ReactNode, SetStateAction, lazy } from "react";
-import * as _$react_jsx_runtime0 from "react/jsx-runtime";
 import { Dayjs } from "dayjs";
 import { FaasActionPaths, FaasParams } from "@faasjs/types";
-import * as _$antd_es_form0 from "antd/es/form/index.js";
 import { RuleObject } from "antd/es/form/index.js";
 import { FilterValue, SorterResult, TableCurrentDataSource } from "antd/es/table/interface.js";
-import * as _$antd_es_form_Form0 from "antd/es/form/Form.js";
-import * as _$antd_es_form_hooks_useFormInstance0 from "antd/es/form/hooks/useFormInstance.js";
-import * as _$_rc_component_form0 from "@rc-component/form";
-import * as _$antd_es_form_context0 from "antd/es/form/context.js";
-import * as _$antd_es_form_FormItem0 from "antd/es/form/FormItem/index.js";
 import { Tab } from "@rc-component/tabs/lib/interface.js";
 import { MessageInstance } from "antd/es/message/interface.js";
 import { NotificationInstance } from "antd/es/notification/interface.js";
@@ -59,7 +51,7 @@ type LoadingProps = {
  * }
  * ```
  */
-declare function Loading(props: LoadingProps): _$react_jsx_runtime0.JSX.Element;
+declare function Loading(props: LoadingProps): import("react").JSX.Element;
 //#endregion
 //#region src/FaasDataWrapper/index.d.ts
 /**
@@ -299,7 +291,7 @@ interface ConfigProviderProps {
  * }
  * ```
  */
-declare const ConfigContext: _$react.Context<ConfigContextValue>;
+declare const ConfigContext: import("react").Context<ConfigContextValue>;
 /**
  * Provide theme overrides and optional FaasJS client initialization for descendants.
  *
@@ -330,7 +322,7 @@ declare const ConfigContext: _$react.Context<ConfigContextValue>;
  * }
  * ```
  */
-declare function ConfigProvider(props: ConfigProviderProps): _$react_jsx_runtime0.JSX.Element | null;
+declare function ConfigProvider(props: ConfigProviderProps): import("react").JSX.Element | null;
 /**
  * Read the current `@faasjs/ant-design` config context.
  *
@@ -389,7 +381,7 @@ declare function useConfigContext(): ConfigContextValue;
  * }
  * ```
  */
-declare function ErrorBoundary(props: ErrorBoundaryProps): _$react_jsx_runtime0.JSX.Element;
+declare function ErrorBoundary(props: ErrorBoundaryProps): import("react").JSX.Element;
 //#endregion
 //#region src/App/index.d.ts
 /**
@@ -458,7 +450,7 @@ declare function createOnErrorHandler(messageApi: {
  * }
  * ```
  */
-declare function App(props: AppProps): _$react_jsx_runtime0.JSX.Element;
+declare function App(props: AppProps): import("react").JSX.Element;
 //#endregion
 //#region src/Blank/index.d.ts
 /**
@@ -490,10 +482,23 @@ interface BlankProps {
 declare function Blank(options?: BlankProps): JSX.Element;
 //#endregion
 //#region src/FormItem/types.d.ts
+/**
+ * Type-level extension payload for custom form item types.
+ *
+ * @template T - Value type rendered or edited by the form item.
+ */
 type ExtendFormTypeProps<T = any> = BaseExtendTypeProps<T>;
+/**
+ * Dictionary of custom form item type renderers keyed by item type name.
+ */
 type ExtendTypes = {
   [type: string]: ExtendFormTypeProps;
 };
+/**
+ * Map from {@link FaasItemType} to the Ant Design input component props accepted by {@link FormItem}.
+ *
+ * @template T - Value type rendered or edited by the form item.
+ */
 type InputTypeMap<T> = {
   string: InputProps | SelectProps<T> | RadioProps;
   'string[]': InputProps | SelectProps<T> | RadioProps;
@@ -505,24 +510,51 @@ type InputTypeMap<T> = {
   object: never;
   'object[]': never;
 };
+/**
+ * Props for the {@link FormItem} component.
+ *
+ * Each field can render as a single form control, a list of controls, or a nested object/object-list
+ * group of child form items.
+ *
+ * @template T - Value type rendered or edited by the form item.
+ */
 interface FormItemProps<T = any> extends BaseItemProps, Omit<FormItemProps$1<T>, 'id' | 'children' | 'render'> {
+  /** Item type that determines which Ant Design control is rendered. */
   type?: FaasItemType;
+  /** Props forwarded to the Ant Design input component used for this field. */
   input?: InputTypeMap<T>[FaasItemType];
+  /** Maximum number of entries allowed in a list item. */
   maxCount?: number;
+  /** Nested item definitions used by `object` and `object[]` item types. */
   object?: FormItemProps[];
+  /** Whether the field is disabled. */
   disabled?: boolean;
+  /** Whether the field is required. When `true`, a required validation rule is appended. */
   required?: boolean;
+  /** Number of columns taken by this field in the Ant Design grid. */
   col?: number;
+  /** Generic custom element rendered when no form-specific child overrides it. */
   children?: UnionFaasItemElement<T> | null;
+  /** Form-specific custom element. */
   formChildren?: UnionFaasItemElement<T> | null;
+  /** Generic custom render callback. */
   render?: UnionFaasItemRender<T> | null;
+  /** Form-specific custom render callback. */
   formRender?: UnionFaasItemRender<T> | null;
+  /** Validation rules appended to the field. */
   rules?: RuleObject[];
+  /** Field label text, or `false` to hide the label. */
   label?: string | false;
+  /** Custom type renderers keyed by item type. */
   extendTypes?: ExtendTypes;
+  /** Called when the field value changes. */
   onValueChange?: (value: T, values: any, form: FormInstance) => void;
+  /** Conditional visibility predicate. When `false`, the field is hidden and rendered as a hidden input. */
   if?: (values: Record<string, any>) => boolean;
 }
+/**
+ * Extensible form item props that accept any string `type`.
+ */
 interface ExtendFormItemProps extends Omit<FormItemProps, 'type'> {
   type?: string;
 }
@@ -547,6 +579,11 @@ interface TableItemProps<T = any> extends FaasItemProps, Omit<TableColumnProps<T
   /** Nested item definitions used by `object` and `object[]` item types. */
   object?: TableItemProps<T>[];
 }
+/**
+ * Type-level extension payload for custom table column types.
+ *
+ * @template T - Row record type rendered by the table.
+ */
 type ExtendTableTypeProps<T = any> = BaseExtendTypeProps<T>;
 /**
  * Shared fields for extending table item unions.
@@ -605,7 +642,15 @@ type TableFaasDataResponse<T = any> = {
 };
 //#endregion
 //#region src/data/types.d.ts
+/**
+ * Supported item types used across {@link Form}, {@link Description}, and {@link Table}.
+ *
+ * Each type maps to a built-in Ant Design control or a nested renderer for `object` and `object[]`.
+ */
 type FaasItemType = 'string' | 'string[]' | 'number' | 'number[]' | 'boolean' | 'date' | 'time' | 'object' | 'object[]';
+/**
+ * Map from {@link FaasItemType} to the expected JavaScript value type.
+ */
 type FaasItemTypeValue = {
   string: string;
   'string[]': string[];
@@ -617,68 +662,162 @@ type FaasItemTypeValue = {
   object: any;
   'object[]': any[];
 };
+/**
+ * Accepted form of a select/dropdown option before normalization.
+ */
 type BaseOption = string | number | {
   label: string;
   value?: any;
 };
+/**
+ * Minimal common shape shared by all item definition types.
+ */
 interface BaseItemProps {
   id: string | number;
   title?: string;
   options?: BaseOption[];
 }
+/**
+ * Minimal FaasJS-aware item definition that includes an optional type.
+ */
 interface FaasItemProps extends BaseItemProps {
   type?: FaasItemType;
 }
+/**
+ * Rendering surface that determines the available per-type defaults.
+ */
 type UnionScene = 'form' | 'description' | 'table';
+/**
+ * Props injected into a {@link UnionFaasItemElement} by the rendering host.
+ */
 type UnionFaasItemInjection<Value = any, Values = any> = {
   scene?: UnionScene;
   value?: Value;
   values?: Values;
   index?: number;
 };
+/**
+ * Render callback shared by form items, description items, and table columns.
+ *
+ * @param value - Normalized value for the field or column.
+ * @param values - Full record for the current row or form.
+ * @param index - Position of the item inside a list (always 0 for single items).
+ * @param scene - Rendering surface that triggered the callback.
+ */
 type UnionFaasItemRender<Value = any, Values = any> = (value: Value, values: Values, index: number, scene: UnionScene) => React.ReactNode;
+/**
+ * Shared element type accepted by `children` and `render` props across all surfaces.
+ */
 type UnionFaasItemElement<Value = any, Values = any> = ReactElement<UnionFaasItemInjection<Value, Values>> | FC<UnionFaasItemInjection<Value, Values>>;
+/**
+ * Combined item props that spans form, description, and table definitions.
+ */
 interface UnionFaasItemProps<Value = any, Values = any> extends FormItemProps, DescriptionItemProps, TableItemProps {
   children?: UnionFaasItemElement<Value, Values> | null;
   render?: UnionFaasItemRender<Value, Values> | null;
   object?: UnionFaasItemProps<Value, Values>[];
 }
+/**
+ * Base shape for custom item type definitions accepted by `extendTypes`.
+ *
+ * @template T - Value type rendered or edited by the custom type.
+ */
 type BaseExtendTypeProps<T = any> = {
   children?: UnionFaasItemElement<T>;
   render?: UnionFaasItemRender<T>;
 };
 //#endregion
 //#region src/Description/types.d.ts
+/**
+ * Type-level extension payload for custom description item types.
+ *
+ * @template T - Data record shape rendered by the description list.
+ */
 type ExtendDescriptionTypeProps<T = any> = BaseExtendTypeProps<T>;
+/**
+ * Extensible description item props that accept any item shape.
+ */
 type ExtendDescriptionItemProps = BaseItemProps;
+/**
+ * Description item meta-object consumed by the {@link Description} component.
+ *
+ * @template T - Data record shape rendered by the description list.
+ */
 interface DescriptionItemProps<T = any> extends FaasItemProps {
+  /** Generic custom element rendered when no description-specific child overrides it. */
   children?: UnionFaasItemElement<T> | null;
+  /** Description-specific custom element. */
   descriptionChildren?: UnionFaasItemElement<T> | null;
+  /** Generic custom render callback. */
   render?: UnionFaasItemRender<T> | null;
+  /** Description-specific custom render callback. */
   descriptionRender?: UnionFaasItemRender<T> | null;
+  /** Conditional visibility predicate. When `false`, the item is hidden from the description list. */
   if?: (values: Record<string, any>) => boolean;
+  /** Nested item definitions used by `object` and `object[]` item types. */
   object?: DescriptionItemProps<T>[];
 }
+/**
+ * Shared props used by both local-data and Faas-data description lists.
+ *
+ * @template T - Data record shape rendered by the description list.
+ * @template ExtendItemProps - Additional item prop shape accepted by `items`.
+ */
 interface DescriptionCommonProps<T = any, ExtendItemProps = any> extends Omit<DescriptionsProps, 'items'> {
+  /** Callback that returns a custom React node for the title. */
   renderTitle?(this: void, values: T): ReactNode;
+  /** Item metadata definitions rendered as description entries. */
   items: (DescriptionItemProps | ExtendItemProps)[];
+  /** Custom type renderers keyed by item type. */
   extendTypes?: {
     [key: string]: ExtendDescriptionTypeProps;
   };
 }
+/**
+ * Props for the {@link Description} component when rendering a local data source.
+ *
+ * @template T - Data record shape rendered by the description list.
+ * @template ExtendItemProps - Additional item prop shape accepted by `items`.
+ */
 interface DescriptionWithoutFaasProps<T = any, ExtendItemProps = any> extends DescriptionCommonProps<T, ExtendItemProps> {
+  /** Local data source rendered by the description list. */
   dataSource?: T;
+  /** Must not be set when using a local `dataSource`. */
   faasData?: never;
 }
+/**
+ * Props for the {@link Description} component when fetching data via FaasJS.
+ *
+ * @template Path - Action path type inferred from `faasData.action`.
+ * @template T - Data record shape rendered by the description list.
+ * @template ExtendItemProps - Additional item prop shape accepted by `items`.
+ */
 interface DescriptionWithFaasProps<Path extends FaasActionPaths = any, T = any, ExtendItemProps = any> extends DescriptionCommonProps<T, ExtendItemProps> {
+  /** Must not be set when using `faasData`. */
   dataSource?: never;
+  /** FaasJS data wrapper configuration that fetches the data source. */
   faasData?: FaasDataWrapperProps<Path>;
 }
+/**
+ * Full props union accepted by the {@link Description} component.
+ *
+ * @template T - Data record shape rendered by the description list.
+ * @template ExtendItemProps - Additional item prop shape accepted by `items`.
+ */
 type DescriptionProps<T = any, ExtendItemProps = any> = DescriptionWithoutFaasProps<T, ExtendItemProps> | DescriptionWithFaasProps<any, T, ExtendItemProps>;
+/**
+ * Props passed to the {@link DescriptionItemContent} internal renderer.
+ *
+ * @template T - Data record shape rendered by the description list.
+ */
 interface DescriptionItemContentProps<T = any> {
+  /** The item definition being rendered. */
   item: DescriptionItemProps;
+  /** Raw value read from the data source for this item's `id`. */
   value: T;
+  /** Entire data source record (optional). */
   values?: any;
+  /** Custom type renderers keyed by item type. */
   extendTypes?: {
     [key: string]: ExtendDescriptionTypeProps;
   };
@@ -795,25 +934,74 @@ type setDrawerProps = Dispatch<SetStateAction<DrawerProps>>;
  * ```
  */
 declare function useDrawer(init?: DrawerProps): {
-  drawer: _$react_jsx_runtime0.JSX.Element;
+  drawer: JSX.Element;
   drawerProps: DrawerProps;
   setDrawerProps: setDrawerProps;
 };
 //#endregion
 //#region src/data/render.d.ts
+/**
+ * Render a display value using FaasJS item-type-aware formatting.
+ *
+ * Arrays are joined by comma, booleans render as icons, date/time values are formatted,
+ * and option-backed values resolve the corresponding label before rendering. Empty values
+ * produce a {@link Blank} placeholder.
+ *
+ * @param type - Item type that controls the formatting logic.
+ * @param value - Raw value to display.
+ * @param options - Optional list of options used for label resolution.
+ * @returns React node representing the formatted display value.
+ */
 declare function renderDisplayValue(type: FaasItemType, value: any, options?: {
   label: string;
   value?: string | number;
 }[]): JSX.Element | string | number | boolean | null;
 //#endregion
 //#region src/data/utils.d.ts
+/**
+ * Derive a human-readable title from a raw identifier.
+ *
+ * Splits on whitespace, underscores, and hyphens, then capitalises each segment.
+ *
+ * @param id - Raw identifier.
+ * @returns Title-cased string derived from the identifier.
+ */
 declare function idToTitle(id: string | number): string;
+/**
+ * Normalise raw option entries into a stable shape with `label` and `value`.
+ *
+ * String and number options receive a title-cased label derived from the raw value.
+ *
+ * @param options - Raw options accepted by form items, description items, and table columns.
+ * @returns Normalised option objects.
+ */
 declare function transferOptions(options: BaseOption[]): {
   label: string;
   value?: string | number;
 }[];
+/**
+ * Coerce a raw value into the expected JavaScript type for a given {@link FaasItemType}.
+ *
+ * Falsy scalar values (including the strings `"null"` and `"undefined"`) are normalised to `null`.
+ * Array-typed values are coerced element-by-element. Date/time values are parsed into Dayjs objects
+ * and unix timestamps are auto-detected.
+ *
+ * @param type - Target item type (defaults to `"string"` when falsy).
+ * @param value - Raw value to normalise.
+ * @returns Normalised value matching the expected type.
+ */
 declare function transferValue(type: FaasItemType | null | undefined, value: any): any;
-declare function cloneUnionFaasItemElement(element: UnionFaasItemElement, props: any): _$react.ReactElement<UnionFaasItemInjection<any, any>, string | _$react.JSXElementConstructor<any>>;
+/**
+ * Clone a {@link UnionFaasItemElement} while injecting additional React props.
+ *
+ * If the element is a React element it is cloned in-place; if it is a function component
+ * it is instantiated via `createElement` with the given props.
+ *
+ * @param element - React element or function component to clone.
+ * @param props - Props injected into the cloned element.
+ * @returns Cloned React element with the injected props.
+ */
+declare function cloneUnionFaasItemElement(element: UnionFaasItemElement, props: any): import("react").ReactElement<UnionFaasItemInjection<any, any>, string | import("react").JSXElementConstructor<any>>;
 //#endregion
 //#region src/FormItem/index.d.ts
 /**
@@ -843,45 +1031,80 @@ declare function cloneUnionFaasItemElement(element: UnionFaasItemElement, props:
  * }
  * ```
  */
-declare function FormItem<T = any>(props: FormItemProps<T>): _$react_jsx_runtime0.JSX.Element | null;
+declare function FormItem<T = any>(props: FormItemProps<T>): import("react").JSX.Element | null;
 declare namespace FormItem {
   var useStatus: () => {
-    status?: _$antd_es_form_FormItem0.ValidateStatus;
+    status?: import("antd/es/form/FormItem").ValidateStatus;
     errors: React.ReactNode[];
     warnings: React.ReactNode[];
   };
 }
 //#endregion
 //#region src/Form/types.d.ts
+/**
+ * Submit button configuration for the {@link Form} component.
+ */
 type FormSubmitProps = {
-  text?: string;
+  /** Submit button label. */text?: string; /** Props forwarded to the Ant Design submit button. */
   buttonProps?: ButtonProps;
 };
+/**
+ * Configures FaasJS-backed form submission.
+ *
+ * @template Values - Form values shape.
+ * @template Path - Action path type inferred from the registered FaasJS actions.
+ */
 type FormFaasProps<Values extends Record<string, any> = any, Path extends FaasActionPaths = any> = {
-  action: Path;
-  params?: FaasParams<Path> | ((values: Record<string, any>) => FaasParams<Path>);
-  transformValues?: (values: Values) => Record<string, any> | Promise<Record<string, any>>;
-  onSuccess?: (result: any, values: Record<string, any>) => void;
-  onError?: (error: any, values: Record<string, any>) => void;
+  /** Fully qualified FaasJS action path. */action: Path; /** Static params or a factory that receives the current form values and returns the params payload. */
+  params?: FaasParams<Path> | ((values: Record<string, any>) => FaasParams<Path>); /** Transformer applied to form values before the FaasJS request is fired. */
+  transformValues?: (values: Values) => Record<string, any> | Promise<Record<string, any>>; /** Called after a successful FaasJS response. */
+  onSuccess?: (result: any, values: Record<string, any>) => void; /** Called after a failed FaasJS request. */
+  onError?: (error: any, values: Record<string, any>) => void; /** Called after the request settles, regardless of success or failure. */
   onFinally?: () => void;
 };
+/**
+ * Shared props used by both Faas-backed and manually-submitted forms.
+ *
+ * @template Values - Form values shape.
+ * @template ExtendItemProps - Additional item prop shape accepted by `items`.
+ */
 type FormCommonProps<Values extends Record<string, any>, ExtendItemProps extends ExtendFormItemProps = ExtendFormItemProps> = Omit<FormProps$1<Values>, 'onFinish' | 'children' | 'initialValues'> & {
-  items?: ((ExtendItemProps extends ExtendFormItemProps ? ExtendItemProps | FormItemProps : FormItemProps) | JSX.Element)[];
-  submit?: false | FormSubmitProps;
-  beforeItems?: JSX.Element | JSX.Element[];
-  footer?: JSX.Element | JSX.Element[];
-  extendTypes?: ExtendTypes;
-  children?: ReactNode;
+  /** Item definitions rendered as form fields. */items?: ((ExtendItemProps extends ExtendFormItemProps ? ExtendItemProps | FormItemProps : FormItemProps) | JSX.Element)[]; /** Submit button config, or `false` to hide the built-in submit button. */
+  submit?: false | FormSubmitProps; /** Elements rendered before the form items. */
+  beforeItems?: JSX.Element | JSX.Element[]; /** Elements rendered after the submit button. */
+  footer?: JSX.Element | JSX.Element[]; /** Custom type renderers keyed by item type. */
+  extendTypes?: ExtendTypes; /** Arbitrary children rendered between items and the submit button. */
+  children?: ReactNode; /** Initial field values for the form. */
   initialValues?: Partial<Values>;
 };
+/**
+ * Props for the {@link Form} component when NO FaasJS integration is used.
+ *
+ * @template Values - Form values shape.
+ * @template ExtendItemProps - Additional item prop shape accepted by `items`.
+ */
 type FormWithoutFaasProps<Values extends Record<string, any> = any, ExtendItemProps extends ExtendFormItemProps = ExtendFormItemProps> = FormCommonProps<Values, ExtendItemProps> & {
-  faas?: never;
+  /** Must not be set when using a custom `onFinish` handler. */faas?: never; /** Custom submit handler that replaces the built-in FaasJS flow. */
   onFinish?: (values: Values) => void | Promise<void>;
 };
+/**
+ * Props for the {@link Form} component when FaasJS integration IS used.
+ *
+ * @template Path - Action path type inferred from the registered FaasJS actions.
+ * @template Values - Form values shape.
+ * @template ExtendItemProps - Additional item prop shape accepted by `items`.
+ */
 type FormWithFaasProps<Path extends FaasActionPaths = any, Values extends Record<string, any> = any, ExtendItemProps extends ExtendFormItemProps = ExtendFormItemProps> = FormCommonProps<Values, ExtendItemProps> & {
-  faas?: FormFaasProps<Values, Path>;
+  /** FaasJS integration configuration. */faas?: FormFaasProps<Values, Path>; /** Must not be set when `faas` is provided. */
   onFinish?: never;
 };
+/**
+ * Full props union accepted by the {@link Form} component.
+ *
+ * @template Values - Form values shape.
+ * @template Path - Action path type (only relevant when `faas` is provided).
+ * @template ExtendItemProps - Additional item prop shape accepted by `items`.
+ */
 type FormProps<Values extends Record<string, any> = any, Path extends FaasActionPaths = any, ExtendItemProps extends ExtendFormItemProps = ExtendFormItemProps> = FormWithoutFaasProps<Values, ExtendItemProps> | FormWithFaasProps<Path, Values, ExtendItemProps>;
 //#endregion
 //#region src/Form/index.d.ts
@@ -956,13 +1179,13 @@ declare function Form<Path extends FaasActionPaths, Values extends Record<string
  */
 declare function Form<Values extends Record<string, any> = any, Path extends FaasActionPaths = any>(props: FormProps<Values, Path>): JSX.Element;
 declare namespace Form {
-  var useForm: typeof _$antd_es_form_Form0.useForm;
-  var useFormInstance: typeof _$antd_es_form_hooks_useFormInstance0.default;
-  var useWatch: typeof _$_rc_component_form0.useWatch;
+  var useForm: typeof import("antd/es/form/Form").useForm;
+  var useFormInstance: typeof import("antd/es/form/hooks/useFormInstance").default;
+  var useWatch: typeof import("@rc-component/form").useWatch;
   var Item: typeof FormItem;
-  var List: _$react.FC<_$antd_es_form0.FormListProps>;
-  var ErrorList: _$react.FC<_$antd_es_form0.ErrorListProps>;
-  var Provider: _$react.FC<_$antd_es_form_context0.FormProviderProps>;
+  var List: import("react").FC<import("antd/es/form").FormListProps>;
+  var ErrorList: import("react").FC<import("antd/es/form").ErrorListProps>;
+  var Provider: import("react").FC<import("antd/es/form/context").FormProviderProps>;
 }
 //#endregion
 //#region src/Link/index.d.ts
@@ -1013,7 +1236,7 @@ interface LinkProps {
  * }
  * ```
  */
-declare function Link(props: LinkProps): _$react_jsx_runtime0.JSX.Element;
+declare function Link(props: LinkProps): import("react").JSX.Element;
 //#endregion
 //#region src/Modal/index.d.ts
 /**
@@ -1056,7 +1279,7 @@ type setModalProps = Dispatch<SetStateAction<ModalProps>>;
  * ```
  */
 declare function useModal(init?: ModalProps): {
-  modal: _$react_jsx_runtime0.JSX.Element;
+  modal: JSX.Element;
   modalProps: ModalProps;
   setModalProps: setModalProps;
 };
@@ -1079,7 +1302,7 @@ declare function useModal(init?: ModalProps): {
  * }
  * ```
  */
-declare function PageNotFound(): _$react_jsx_runtime0.JSX.Element;
+declare function PageNotFound(): JSX.Element;
 /**
  * Props for the lazy-loading {@link Routes} wrapper.
  */
@@ -1113,7 +1336,7 @@ interface RoutesProps {
  *         routes={[
  *           {
  *             path: '/',
- *             page: lazy(() => import('./pages/home')),
+ *             page: lazy(() => import('./features/home')),
  *           },
  *         ]}
  *       />
@@ -1122,7 +1345,7 @@ interface RoutesProps {
  * }
  * ```
  */
-declare function Routes(props: RoutesProps): _$react_jsx_runtime0.JSX.Element;
+declare function Routes(props: RoutesProps): JSX.Element;
 //#endregion
 //#region src/Table/table.d.ts
 /**
@@ -1160,7 +1383,7 @@ declare function Routes(props: RoutesProps): _$react_jsx_runtime0.JSX.Element;
  * }
  * ```
  */
-declare function Table<T extends Record<string, any>, ExtendTypes = any>(props: TableProps<T, ExtendTypes>): _$react_jsx_runtime0.JSX.Element;
+declare function Table<T extends Record<string, any>, ExtendTypes = any>(props: TableProps<T, ExtendTypes>): import("react").JSX.Element;
 //#endregion
 //#region src/Tabs/index.d.ts
 /**
@@ -1210,7 +1433,7 @@ interface TabsProps extends Omit<TabsProps$1, 'items'> {
  * }
  * ```
  */
-declare function Tabs(props: TabsProps): _$react_jsx_runtime0.JSX.Element;
+declare function Tabs(props: TabsProps): import("react").JSX.Element;
 //#endregion
 //#region src/Title/index.d.ts
 /**

package/dist/index.mjs

@@ -655,6 +655,18 @@ function resolveOptionLabel(value, options) {
 	for (const option of options) if (option.value === value) return option.label ?? value;
 	return value;
 }
+/**
+* Render a display value using FaasJS item-type-aware formatting.
+*
+* Arrays are joined by comma, booleans render as icons, date/time values are formatted,
+* and option-backed values resolve the corresponding label before rendering. Empty values
+* produce a {@link Blank} placeholder.
+*
+* @param type - Item type that controls the formatting logic.
+* @param value - Raw value to display.
+* @param options - Optional list of options used for label resolution.
+* @returns React node representing the formatted display value.
+*/
 function renderDisplayValue(type, value, options) {
 	if (value === null || value === void 0 || Array.isArray(value) && value.length === 0) return /* @__PURE__ */ jsx(Blank, {});
 	if (options?.length) {
@@ -676,11 +688,27 @@ function renderDisplayValue(type, value, options) {
 }
 //#endregion
 //#region src/data/utils.ts
+/**
+* Derive a human-readable title from a raw identifier.
+*
+* Splits on whitespace, underscores, and hyphens, then capitalises each segment.
+*
+* @param id - Raw identifier.
+* @returns Title-cased string derived from the identifier.
+*/
 function idToTitle(id) {
 	if (typeof id === "number") return id.toString();
 	const splitted = id.split(/(\s|_|-)/).filter((word) => !/(\s|_|-)/.test(word)).map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join(" ");
 	return splitted.charAt(0).toUpperCase() + splitted.slice(1);
 }
+/**
+* Normalise raw option entries into a stable shape with `label` and `value`.
+*
+* String and number options receive a title-cased label derived from the raw value.
+*
+* @param options - Raw options accepted by form items, description items, and table columns.
+* @returns Normalised option objects.
+*/
 function transferOptions(options) {
 	if (!options) return [];
 	return options.map((item) => typeof item === "object" ? item : {
@@ -688,6 +716,17 @@ function transferOptions(options) {
 		value: item
 	});
 }
+/**
+* Coerce a raw value into the expected JavaScript type for a given {@link FaasItemType}.
+*
+* Falsy scalar values (including the strings `"null"` and `"undefined"`) are normalised to `null`.
+* Array-typed values are coerced element-by-element. Date/time values are parsed into Dayjs objects
+* and unix timestamps are auto-detected.
+*
+* @param type - Target item type (defaults to `"string"` when falsy).
+* @param value - Raw value to normalise.
+* @returns Normalised value matching the expected type.
+*/
 function transferValue(type, value) {
 	if (!type) type = "string";
 	if (!type.endsWith("[]") && (typeof value === "undefined" || value === null || value === "" || value === "null" || value === "undefined")) return null;
@@ -712,6 +751,16 @@ function transferValue(type, value) {
 	}
 	return value;
 }
+/**
+* Clone a {@link UnionFaasItemElement} while injecting additional React props.
+*
+* If the element is a React element it is cloned in-place; if it is a function component
+* it is instantiated via `createElement` with the given props.
+*
+* @param element - React element or function component to clone.
+* @param props - Props injected into the cloned element.
+* @returns Cloned React element with the injected props.
+*/
 function cloneUnionFaasItemElement(element, props) {
 	return cloneElement(isValidElement(element) ? element : createElement(element), props);
 }
@@ -1374,7 +1423,7 @@ function PageNotFound() {
 *         routes={[
 *           {
 *             path: '/',
-*             page: lazy(() => import('./pages/home')),
+*             page: lazy(() => import('./features/home')),
 *           },
 *         ]}
 *       />
@@ -1403,10 +1452,24 @@ function Routes(props) {
 }
 //#endregion
 //#region src/Table/utils.tsx
+/**
+* Transfer and render a display value for a table cell.
+*
+* @param item - Column definition being rendered.
+* @param value - Raw cell value.
+* @returns Formatted React node.
+*/
 function processValue(item, value) {
 	const itemType = item.type ?? "string";
 	return renderDisplayValue(itemType, transferValue(itemType, value), item.options);
 }
+/**
+* Convert normalized options into Ant Design table filter entries.
+*
+* @param options - Normalized column options.
+* @param includeBlank - Whether to append a blank/null filter option.
+* @returns Array of filter entries compatible with Ant Design column `filters`.
+*/
 function toTableFilters(options, includeBlank = false) {
 	const filters = options.map((option) => ({
 		text: option.label,
@@ -1418,6 +1481,15 @@ function toTableFilters(options, includeBlank = false) {
 	});
 	return filters;
 }
+/**
+* Generate filter dropdown UI for a table column based on its options.
+*
+* Mutates the column item in place. Options with fewer than 11 entries use simple filters;
+* larger option sets use a searchable multi-select dropdown.
+*
+* @param item - Column definition to populate with filter UI.
+* @param search - Localized search placeholder text.
+*/
 function generateFilterDropdown(item, search) {
 	if (item.filterDropdown && item.filterDropdown !== true) return;
 	if (!item.options?.length) return;
@@ -1452,6 +1524,14 @@ function generateFilterDropdown(item, search) {
 		})
 	});
 }
+/**
+* Create a text-search filter dropdown for a table column.
+*
+* @param item - Column definition providing the column title.
+* @param search - Localized search placeholder text.
+* @param transformValue - Optional value transformer applied to the search input before setting the filter key.
+* @returns An Ant Design filter dropdown render function.
+*/
 function createTextSearchFilterDropdown(item, search, transformValue) {
 	return ({ setSelectedKeys, confirm, clearFilters }) => /* @__PURE__ */ jsx(Input.Search, {
 		placeholder: `${search} ${item.title}`,
@@ -1466,6 +1546,16 @@ function createTextSearchFilterDropdown(item, search, transformValue) {
 		}
 	});
 }
+/**
+* Apply server-supplied options to table columns when using `faasData`.
+*
+* When the response includes an `options` map, matching columns receive option-driven
+* filters and renders automatically.
+*
+* @param columns - Current column definitions.
+* @param data - FaasJS response data object that may contain an `options` map.
+* @returns Updated column definitions, or the original array when no options are present.
+*/
 function applyFaasDataColumnOptions(columns, data) {
 	if (!data?.options) return columns;
 	let updated = false;
@@ -1483,6 +1573,18 @@ function applyFaasDataColumnOptions(columns, data) {
 }
 //#endregion
 //#region src/Table/column-builder.tsx
+/**
+* Build Ant Design table column definitions from FaasJS item metadata.
+*
+* The function applies default titles, data indices, renderers, sorters, and filter dropdowns
+* for each built-in item type. Custom types registered via `extendTypes` are resolved
+* through the configured children or render callbacks.
+*
+* @param items - Raw item metadata definitions.
+* @param options - Configuration including theme strings, custom type renderers, and optional FaasJS or local data.
+* @returns Fully populated column definitions ready for the Ant Design table.
+* @throws {Error} When a custom type in `extendTypes` omits both `children` and `render`.
+*/
 function createTableColumns(items, options) {
 	const columns = cloneDeep(items).filter((item) => !(item.tableChildren === null || item.children === null || item.tableRender === null || item.render === null));
 	for (const item of columns) {
@@ -1755,6 +1857,13 @@ function Table(props) {
 		})
 	});
 }
+/**
+* Internal table renderer that binds FaasJS data injection props to an Ant Design table.
+*
+* @param props - Combined FaasJS data injection and table props.
+*
+* @internal
+*/
 function FaasDataTable({ props, columns, data, params, reload, loading }) {
 	const currentColumns = useEqualMemo(() => !data || Array.isArray(data) ? columns : applyFaasDataColumnOptions(columns, data), [columns, data]);
 	const tableDataSource = !data ? [] : Array.isArray(data) ? data : data.rows;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/ant-design",
-  "version": "8.0.0-beta.34",
+  "version": "8.0.0-beta.36",
   "homepage": "https://faasjs.com/doc/ant-design",
   "bugs": {
     "url": "https://github.com/faasjs/faasjs/issues"
@@ -27,9 +27,9 @@
   },
   "devDependencies": {
     "@ant-design/icons": "*",
-    "@faasjs/react": ">=8.0.0-beta.34",
-    "@faasjs/types": ">=8.0.0-beta.34",
-    "@faasjs/utils": ">=8.0.0-beta.34",
+    "@faasjs/react": ">=8.0.0-beta.36",
+    "@faasjs/types": ">=8.0.0-beta.36",
+    "@faasjs/utils": ">=8.0.0-beta.36",
     "@types/lodash-es": "*",
     "@types/react": "^19.0.0",
     "@types/react-dom": "^19.0.0",
@@ -41,9 +41,9 @@
   },
   "peerDependencies": {
     "@ant-design/icons": "*",
-    "@faasjs/react": ">=8.0.0-beta.34",
-    "@faasjs/types": ">=8.0.0-beta.34",
-    "@faasjs/utils": ">=8.0.0-beta.34",
+    "@faasjs/react": ">=8.0.0-beta.36",
+    "@faasjs/types": ">=8.0.0-beta.36",
+    "@faasjs/utils": ">=8.0.0-beta.36",
     "antd": "^6.0.0",
     "lodash-es": "*",
     "react": "^19.0.0",