@faasjs/ant-design 8.0.0-beta.25 → 8.0.0-beta.27

package/dist/index.d.ts

@@ -18,22 +18,42 @@ import { MessageInstance } from "antd/es/message/interface.js";
 import { NotificationInstance } from "antd/es/notification/interface.js";
 
 //#region ../types/src/index.d.ts
+/**
+ * Action Type definitions for FaasJS and cross backend and frontend.
+ *
+ * [![License: MIT](https://img.shields.io/npm/l/@faasjs/types.svg)](https://github.com/faasjs/faasjs/blob/main/packages/types/LICENSE)
+ * [![NPM Version](https://img.shields.io/npm/v/@faasjs/types.svg)](https://www.npmjs.com/package/@faasjs/types)
+ *
+ * ## Install
+ *
+ * Normally you don't need to install this package manually. It's a dependency of `@faasjs/core` and `@faasjs/react`.
+ *
+ * ## Usage
+ *
+ * ### TypeScript config presets
+ *
+ * `@faasjs/types` also provides shared TypeScript presets under `tsconfig/`:
+ *
+ * - `@faasjs/types/tsconfig/base.json`: strict base options for common TypeScript projects.
+ * - `@faasjs/types/tsconfig/react.json`: base options with `jsx: "react-jsx"` for React projects.
+ * - `@faasjs/types/tsconfig/build.json`: build-oriented options for Vite apps, packages, and workspace modules.
+ *
+ * In your tsconfig.json:
+ *
+ * ```json
+ * {
+ *   "extends": "@faasjs/types/tsconfig/build.json"
+ * }
+ * ```
+ */
 /**
  * Interface for defining FaasJS actions.
  */
-interface FaasActions {
-  /**
-   * Internal placeholder to keep this interface visible in generated docs.
-   */
-  faasjsActionsPlaceholder?: {
-    Params: Record<string, any>;
-    Data: Record<string, any>;
-  };
-}
+interface FaasActions {}
 /**
- * Infer all action paths declared in {@link FaasActions}.
+ * Infer all declared action paths.
  */
-type FaasActionPaths = Exclude<Extract<keyof FaasActions, string>, 'faasjsActionsPlaceholder'>;
+type FaasActionPaths = Extract<keyof FaasActions, string>;
 /**
  * Union type accepted by action helpers when callers pass either an action path or inferred data shape.
  */
@@ -48,7 +68,7 @@ type FaasActionUnionType = Record<string, any> | string;
  */
 type FaasAction<T = any> = T extends FaasActionPaths ? T : string;
 //#endregion
-//#region src/Loading.d.ts
+//#region src/Loading/index.d.ts
 /**
  * Props for the {@link Loading} component.
  */
@@ -91,7 +111,7 @@ type LoadingProps = {
  */
 declare function Loading(props: LoadingProps): _$react_jsx_runtime0.JSX.Element;
 //#endregion
-//#region src/FaasDataWrapper.d.ts
+//#region src/FaasDataWrapper/index.d.ts
 /**
  * Partial data injection exposed to wrapped Ant Design components.
  *
@@ -218,7 +238,7 @@ declare function FaasDataWrapper<T extends FaasActionUnionType = any>(props: Faa
  */
 declare function withFaasData<PathOrData extends FaasActionUnionType, TComponentProps extends Required<FaasDataInjection<PathOrData>> = Required<FaasDataInjection<PathOrData>>>(Component: React.FC<TComponentProps & Record<string, any>>, faasProps: FaasDataWrapperProps<PathOrData>): React.FC<Omit<TComponentProps, keyof FaasDataInjection<PathOrData>>>;
 //#endregion
-//#region src/Config.d.ts
+//#region src/Config/index.d.ts
 /**
  * Fully resolved theme object consumed by `@faasjs/ant-design` components.
  */
@@ -403,7 +423,7 @@ declare function ConfigProvider(props: ConfigProviderProps): _$react_jsx_runtime
  */
 declare function useConfigContext(): ConfigContextValue;
 //#endregion
-//#region src/ErrorBoundary.d.ts
+//#region src/ErrorBoundary/index.d.ts
 /**
  * Styled error boundary.
  *
@@ -427,7 +447,7 @@ declare function useConfigContext(): ConfigContextValue;
  */
 declare function ErrorBoundary(props: ErrorBoundaryProps): _$react_jsx_runtime0.JSX.Element;
 //#endregion
-//#region src/App.d.ts
+//#region src/App/index.d.ts
 /**
  * Props for the root {@link App} shell.
  *
@@ -493,7 +513,7 @@ interface AppProps {
  */
 declare function App(props: AppProps): _$react_jsx_runtime0.JSX.Element;
 //#endregion
-//#region src/Blank.d.ts
+//#region src/Blank/index.d.ts
 /**
  * Props for the {@link Blank} placeholder component.
  */
@@ -522,7 +542,7 @@ interface BlankProps {
  */
 declare function Blank(options?: BlankProps): JSX.Element;
 //#endregion
-//#region src/FormItem.d.ts
+//#region src/FormItem/index.d.ts
 /**
  * Custom renderer registration for a form item type.
  *
@@ -633,7 +653,7 @@ declare namespace FormItem {
   };
 }
 //#endregion
-//#region src/Table.d.ts
+//#region src/Table/index.d.ts
 /**
  * Column definition used by the FaasJS Ant Design {@link Table} component.
  *
@@ -754,7 +774,7 @@ type TableFaasDataResponse<T = any> = {
  */
 declare function Table<T extends Record<string, any>, ExtendTypes = any>(props: TableProps<T, ExtendTypes>): _$react_jsx_runtime0.JSX.Element;
 //#endregion
-//#region src/data.d.ts
+//#region src/data/index.d.ts
 /**
  * Supported built-in field types shared by form, table, and description components.
  */
@@ -940,7 +960,7 @@ interface UnionFaasItemProps<Value = any, Values = any> extends FormItemProps, D
  */
 declare function cloneUnionFaasItemElement(element: UnionFaasItemElement, props: any): ReactElement<UnionFaasItemInjection<any, any>, string | _$react.JSXElementConstructor<any>>;
 //#endregion
-//#region src/Description.d.ts
+//#region src/Description/index.d.ts
 /**
  * Custom renderer registration for a description item type.
  *
@@ -1048,7 +1068,7 @@ declare namespace Description {
   var displayName: string;
 }
 //#endregion
-//#region src/Drawer.d.ts
+//#region src/Drawer/index.d.ts
 /**
  * Props accepted by the hook-managed drawer wrapper.
  */
@@ -1094,7 +1114,7 @@ declare function useDrawer(init?: DrawerProps): {
   setDrawerProps: setDrawerProps;
 };
 //#endregion
-//#region src/Form.d.ts
+//#region src/Form/index.d.ts
 /**
  * Props for the built-in submit button rendered by {@link Form}.
  */
@@ -1199,7 +1219,7 @@ declare namespace Form {
   var Provider: _$react.FC<_$antd_es_form_context0.FormProviderProps>;
 }
 //#endregion
-//#region src/Link.d.ts
+//#region src/Link/index.d.ts
 /**
  * Props for the navigation-aware {@link Link} component.
  */
@@ -1249,7 +1269,7 @@ interface LinkProps {
  */
 declare function Link(props: LinkProps): _$react_jsx_runtime0.JSX.Element;
 //#endregion
-//#region src/Modal.d.ts
+//#region src/Modal/index.d.ts
 /**
  * Props accepted by the hook-managed modal wrapper.
  */
@@ -1295,7 +1315,7 @@ declare function useModal(init?: ModalProps): {
   setModalProps: setModalProps;
 };
 //#endregion
-//#region src/Routers.d.ts
+//#region src/Routers/index.d.ts
 /**
  * Default 404 route element that uses the configured localized title.
  *
@@ -1358,7 +1378,7 @@ interface RoutesProps {
  */
 declare function Routes(props: RoutesProps): _$react_jsx_runtime0.JSX.Element;
 //#endregion
-//#region src/Tabs.d.ts
+//#region src/Tabs/index.d.ts
 /**
  * Tab item accepted by the FaasJS Ant Design {@link Tabs} wrapper.
  */
@@ -1408,7 +1428,7 @@ interface TabsProps extends Omit<TabsProps$1, 'items'> {
  */
 declare function Tabs(props: TabsProps): _$react_jsx_runtime0.JSX.Element;
 //#endregion
-//#region src/Title.d.ts
+//#region src/Title/index.d.ts
 /**
  * Props for the document-title helper component.
  */
@@ -1456,7 +1476,7 @@ interface TitleProps {
  */
 declare function Title(props: TitleProps): JSX.Element | null;
 //#endregion
-//#region src/useApp.d.ts
+//#region src/useApp/index.d.ts
 /**
  * Shared app services exposed by {@link AppContext} and {@link useApp}.
  */
@@ -1521,7 +1541,7 @@ declare const AppContext: any;
  */
 declare function useApp<NewT extends useAppProps = useAppProps>(this: void): Readonly<NewT>;
 //#endregion
-//#region src/useThemeToken.d.ts
+//#region src/useThemeToken/index.d.ts
 /**
  * Read the current Ant Design theme token.
  *

package/dist/index.mjs

@@ -6,7 +6,7 @@ import { Suspense, cloneElement, createContext, createElement, isValidElement, l
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
 import { CheckOutlined, CloseOutlined, MinusCircleOutlined, PlusOutlined } from "@ant-design/icons";
 import dayjs from "dayjs";
-//#region src/Loading.tsx
+//#region src/Loading/index.tsx
 /**
 * Render an Ant Design loading spinner with an optional content fallback.
 *
@@ -42,7 +42,7 @@ function Loading(props) {
 	});
 }
 //#endregion
-//#region src/FaasDataWrapper.tsx
+//#region src/FaasDataWrapper/index.tsx
 /**
 * Render the `@faasjs/react` data wrapper with an Ant Design loading fallback.
 *
@@ -162,7 +162,7 @@ function withFaasData(Component, faasProps) {
 	});
 }
 //#endregion
-//#region src/Config.tsx
+//#region src/Config/index.tsx
 const zh = {
 	lang: "zh",
 	blank: "空",
@@ -315,7 +315,7 @@ function useConfigContext() {
 	return useContext(ConfigContext);
 }
 //#endregion
-//#region src/Drawer.tsx
+//#region src/Drawer/index.tsx
 /**
 * Create a hook-managed Ant Design drawer instance.
 *
@@ -369,7 +369,7 @@ function useDrawer(init) {
 	};
 }
 //#endregion
-//#region src/ErrorBoundary.tsx
+//#region src/ErrorBoundary/index.tsx
 function ErrorChildren(props) {
 	return /* @__PURE__ */ jsx(Alert, {
 		type: "error",
@@ -411,7 +411,7 @@ function ErrorBoundary(props) {
 	});
 }
 //#endregion
-//#region src/Modal.tsx
+//#region src/Modal/index.tsx
 /**
 * Create a hook-managed Ant Design modal instance.
 *
@@ -465,7 +465,7 @@ function useModal(init) {
 	};
 }
 //#endregion
-//#region src/useApp.ts
+//#region src/useApp/index.ts
 /**
 * Shared context storing message, notification, modal, and drawer helpers.
 *
@@ -522,7 +522,7 @@ function useApp() {
 	return AppContext.use();
 }
 //#endregion
-//#region src/App.tsx
+//#region src/App/index.tsx
 function RoutesApp(props) {
 	const location = useLocation();
 	const { drawerProps, setDrawerProps, modalProps, setModalProps } = useApp();
@@ -608,7 +608,7 @@ function App(props) {
 	});
 }
 //#endregion
-//#region src/Blank.tsx
+//#region src/Blank/index.tsx
 /**
 * Render a disabled placeholder when a value is empty.
 *
@@ -634,7 +634,7 @@ function Blank(options) {
 	}) : options.value;
 }
 //#endregion
-//#region src/data.ts
+//#region src/data/index.ts
 /**
 * Convert a snake_case, kebab-case, or spaced identifier into a title-style label.
 *
@@ -748,7 +748,7 @@ function cloneUnionFaasItemElement(element, props) {
 	return cloneElement(isValidElement(element) ? element : createElement(element), props);
 }
 //#endregion
-//#region src/Description.tsx
+//#region src/Description/index.tsx
 function DescriptionItemContent(props) {
 	const [computedProps, setComputedProps] = useState();
 	useEqualEffect(() => {
@@ -894,7 +894,7 @@ function Description(props) {
 }
 Description.displayName = "Description";
 //#endregion
-//#region src/FormItem.tsx
+//#region src/FormItem/index.tsx
 function isOptionsProps(item) {
 	return item && Array.isArray(item.options);
 }
@@ -1197,7 +1197,7 @@ function FormItem(props) {
 }
 FormItem.useStatus = Form$1.Item.useStatus;
 //#endregion
-//#region src/Form.tsx
+//#region src/Form/index.tsx
 function isFormItemProps(item) {
 	return item.id !== void 0;
 }
@@ -1396,7 +1396,7 @@ Form.List = Form$1.List;
 Form.ErrorList = Form$1.ErrorList;
 Form.Provider = Form$1.Provider;
 //#endregion
-//#region src/Link.tsx
+//#region src/Link/index.tsx
 /**
 * Render a navigation-aware link or button.
 *
@@ -1474,7 +1474,7 @@ function Link(props) {
 	});
 }
 //#endregion
-//#region src/Routers.tsx
+//#region src/Routers/index.tsx
 /**
 * Default 404 route element that uses the configured localized title.
 *
@@ -1547,7 +1547,7 @@ function Routes(props) {
 	}, "*")] });
 }
 //#endregion
-//#region src/Table.tsx
+//#region src/Table/index.tsx
 function processValue(item, value) {
 	const itemType = item.type ?? "string";
 	const transferred = transferValue(itemType, value);
@@ -1952,7 +1952,7 @@ function FaasDataTable({ props, columns, data, params, reload, loading }) {
 	});
 }
 //#endregion
-//#region src/Tabs.tsx
+//#region src/Tabs/index.tsx
 /**
 * Render an Ant Design tabs wrapper that accepts FaasJS-style tab definitions.
 *
@@ -1993,7 +1993,7 @@ function Tabs(props) {
 	});
 }
 //#endregion
-//#region src/Title.tsx
+//#region src/Title/index.tsx
 /**
 * Update `document.title` and optionally render the title inline.
 *
@@ -2034,7 +2034,7 @@ function Title(props) {
 	return null;
 }
 //#endregion
-//#region src/useThemeToken.ts
+//#region src/useThemeToken/index.ts
 /**
 * Read the current Ant Design theme token.
 *

package/package.json

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