@refinedev/antd 5.20.0 → 5.22.0

package/CHANGELOG.md

@@ -1,5 +1,79 @@
 # @pankod/refine-antd
 
+## 5.22.0
+
+### Minor Changes
+
+-   [#4430](https://github.com/refinedev/refine/pull/4430) [`cf07d59587f`](https://github.com/refinedev/refine/commit/cf07d59587fae2adce97a79b40fdb60b9d9a9527) Thanks [@aliemir](https://github.com/aliemir)! - Updated the `useForm`, `useModalForm`, `useDrawerForm` and `useStepsForm` to accept `queryMeta` and `mutationMeta` properties of the `useForm` hook of `@refinedev/core`. These properties are used to pass specific meta values to the query or mutation. This is useful when you have overlapping values in your data provider's `getOne` and `update` methods. For example, you may want to change the `method` of the mutation to `PATCH` but if you pass it in the `meta` property, you'll end up changing the method of the `getOne` request as well.
+
+    `queryMeta` and `mutationMeta` has precedence over `meta`. This means that if you have the same property in `queryMeta` and `meta`, the value in `queryMeta` will be used.
+
+    **Usage**
+
+    ```tsx
+    import { useForm } from "@refinedev/core";
+
+    export const MyEditPage = () => {
+        const form = useForm({
+            // this is passed both to the mutation and the query requests
+            meta: {
+                myValue: "myValue",
+            },
+            // this is only passed to the query request
+            queryMeta: {
+                propertyOnlyWorksForQuery: "propertyOnlyWorksForQuery",
+            },
+            // this is only passed to the mutation request
+            mutationMeta: {
+                propertyOnlyWorksForMutation: "propertyOnlyWorksForMutation",
+            },
+        });
+    };
+    ```
+
+### Patch Changes
+
+-   [#4429](https://github.com/refinedev/refine/pull/4429) [`63daabcb703`](https://github.com/refinedev/refine/commit/63daabcb7037860bc36dff8cc417e9426e9ec027) Thanks [@aliemir](https://github.com/aliemir)! - Fixed the issue of `formLoading` property in return values of `useStepsForm` hook which was not being toggled correctly when the form was submitted or the form data was being fetched.
+
+-   [#4431](https://github.com/refinedev/refine/pull/4431) [`c29a3618cf6`](https://github.com/refinedev/refine/commit/c29a3618cf6b577c36e90ec514f3a691c87aad8f) Thanks [@aliemir](https://github.com/aliemir)! - Updated the TSDoc comments to fix the broken links in the documentation.
+
+## 5.21.0
+
+### Minor Changes
+
+-   [#4430](https://github.com/refinedev/refine/pull/4430) [`cf07d59587f`](https://github.com/refinedev/refine/commit/cf07d59587fae2adce97a79b40fdb60b9d9a9527) Thanks [@aliemir](https://github.com/aliemir)! - Updated the `useForm`, `useModalForm`, `useDrawerForm` and `useStepsForm` to accept `queryMeta` and `mutationMeta` properties of the `useForm` hook of `@refinedev/core`. These properties are used to pass specific meta values to the query or mutation. This is useful when you have overlapping values in your data provider's `getOne` and `update` methods. For example, you may want to change the `method` of the mutation to `PATCH` but if you pass it in the `meta` property, you'll end up changing the method of the `getOne` request as well.
+
+    `queryMeta` and `mutationMeta` has precedence over `meta`. This means that if you have the same property in `queryMeta` and `meta`, the value in `queryMeta` will be used.
+
+    **Usage**
+
+    ```tsx
+    import { useForm } from "@refinedev/core";
+
+    export const MyEditPage = () => {
+        const form = useForm({
+            // this is passed both to the mutation and the query requests
+            meta: {
+                myValue: "myValue",
+            },
+            // this is only passed to the query request
+            queryMeta: {
+                propertyOnlyWorksForQuery: "propertyOnlyWorksForQuery",
+            },
+            // this is only passed to the mutation request
+            mutationMeta: {
+                propertyOnlyWorksForMutation: "propertyOnlyWorksForMutation",
+            },
+        });
+    };
+    ```
+
+### Patch Changes
+
+-   [#4429](https://github.com/refinedev/refine/pull/4429) [`63daabcb703`](https://github.com/refinedev/refine/commit/63daabcb7037860bc36dff8cc417e9426e9ec027) Thanks [@aliemir](https://github.com/aliemir)! - Fixed the issue of `formLoading` property in return values of `useStepsForm` hook which was not being toggled correctly when the form was submitted or the form data was being fetched.
+
+-   [#4431](https://github.com/refinedev/refine/pull/4431) [`c29a3618cf6`](https://github.com/refinedev/refine/commit/c29a3618cf6b577c36e90ec514f3a691c87aad8f) Thanks [@aliemir](https://github.com/aliemir)! - Updated the TSDoc comments to fix the broken links in the documentation.
+
 ## 5.20.0
 
 ### Minor Changes

package/dist/components/buttons/clone/index.d.ts

@@ -2,10 +2,10 @@ import React from "react";
 import { CloneButtonProps } from "../types";
 /**
  * `<CloneButton>` uses Ant Design's {@link https://ant.design/components/button/ `<Button> component`}.
- * It uses the {@link https://refine.dev/docs/core/hooks/navigation/useNavigation#clone `clone`} method from {@link https://refine.dev/docs/core/hooks/navigation/useNavigation useNavigation} under the hood.
+ * It uses the {@link https://refine.dev/docs/api-reference/core/hooks/navigation/useNavigation#clone `clone`} method from {@link https://refine.dev/docs/api-reference/core/hooks/navigation/useNavigation useNavigation} under the hood.
  * It can be useful when redirecting the app to the create page with the record id route of resource.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/clone-button} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/buttons/clone-button} for more details.
  */
 export declare const CloneButton: React.FC<CloneButtonProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/buttons/create/index.d.ts

@@ -2,10 +2,10 @@ import React from "react";
 import { CreateButtonProps } from "../types";
 /**
  * <CreateButton> uses Ant Design's {@link https://ant.design/components/button/ `<Button> component`}.
- * It uses the {@link https://refine.dev/docs/core/hooks/navigation/useNavigation#create `create`} method from {@link https://refine.dev/docs/core/hooks/navigation/useNavigation `useNavigation`} under the hood.
+ * It uses the {@link https://refine.dev/docs/api-reference/core/hooks/navigation/useNavigation#create `create`} method from {@link https://refine.dev/docs/api-reference/core/hooks/navigation/useNavigation `useNavigation`} under the hood.
  * It can be useful to redirect the app to the create page route of resource}.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/create-button} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/buttons/create-button} for more details.
  */
 export declare const CreateButton: React.FC<CreateButtonProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/buttons/delete/index.d.ts

@@ -4,7 +4,7 @@ import { DeleteButtonProps } from "../types";
  * `<DeleteButton>` uses Ant Design's {@link https://ant.design/components/button/ `<Button>`} and {@link https://ant.design/components/button/ `<Popconfirm>`} components.
  * When you try to delete something, a pop-up shows up and asks for confirmation. When confirmed it executes the `useDelete` method provided by your `dataProvider`.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/delete-button} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/buttons/delete-button} for more details.
  */
 export declare const DeleteButton: React.FC<DeleteButtonProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/buttons/edit/index.d.ts

@@ -2,10 +2,10 @@ import React from "react";
 import { EditButtonProps } from "../types";
 /**
  * `<EditButton>` uses Ant Design's {@link https://ant.design/components/button/ `<Button>`} component.
- * It uses the {@link https://refine.dev/docs/core/hooks/navigation/useNavigation#edit `edit`} method from {@link https://refine.dev/docs/core/hooks/navigation/useNavigation `useNavigation`} under the hood.
+ * It uses the {@link https://refine.dev/docs/api-reference/core/hooks/navigation/useNavigation#edit `edit`} method from {@link https://refine.dev/docs/api-reference/core/hooks/navigation/useNavigation `useNavigation`} under the hood.
  * It can be useful when redirecting the app to the edit page with the record id route of resource}.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/edit-button} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/buttons/edit-button} for more details.
  */
 export declare const EditButton: React.FC<EditButtonProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/buttons/export/index.d.ts

@@ -4,7 +4,7 @@ import { ExportButtonProps } from "../types";
  * `<ExportButton>` is an Ant Design {@link https://ant.design/components/button/ `<Button>`} with a default export icon and a default text with "Export".
  * It only has presentational value.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/export-button} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/buttons/export-button} for more details.
  */
 export declare const ExportButton: React.FC<ExportButtonProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/buttons/import/index.d.ts

@@ -1,11 +1,11 @@
 import React from "react";
 import { ImportButtonProps } from "../types";
 /**
- * `<ImportButton>` is compatible with the {@link https://refine.dev/docs/ui-frameworks/antd/hooks/import/useImport `useImport`} hook and is meant to be used as it's upload button.
+ * `<ImportButton>` is compatible with the {@link https://refine.dev/docs/api-reference/antd/hooks/import/useImport `useImport`} hook and is meant to be used as it's upload button.
  * It uses Ant Design's {@link https://ant.design/components/button/ `<Button>`} and {@link https://ant.design/components/upload/ `<Upload>`} components.
  * It wraps a `<Button>` component with an `<Upload>` component and accepts properties for `<Button>` and `<Upload>` components separately.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/import-button} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/buttons/import-button} for more details.
  */
 export declare const ImportButton: React.FC<ImportButtonProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/buttons/list/index.d.ts

@@ -2,10 +2,10 @@ import React from "react";
 import { ListButtonProps } from "../types";
 /**
  * `<ListButton>` is using Ant Design's {@link https://ant.design/components/button/ `<Button>`} component.
- * It uses the  {@link https://refine.dev/docs/core/hooks/navigation/useNavigation#list `list`} method from {@link https://refine.dev/docs/core/hooks/navigation/useNavigation `useNavigation`} under the hood.
+ * It uses the  {@link https://refine.dev/docs/api-reference/core/hooks/navigation/useNavigation#list `list`} method from {@link https://refine.dev/docs/api-reference/core/hooks/navigation/useNavigation `useNavigation`} under the hood.
  * It can be useful when redirecting the app to the list page route of resource}.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/list-button} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/buttons/list-button} for more details.
  */
 export declare const ListButton: React.FC<ListButtonProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/buttons/refresh/index.d.ts

@@ -2,9 +2,9 @@ import React from "react";
 import { RefreshButtonProps } from "../types";
 /**
  * `<RefreshButton>` uses Ant Design's {@link https://ant.design/components/button/ `<Button>`} component
- * to update the data shown on the page via the {@link https://refine.dev/docs/core/hooks/data/useOne `useOne`} method provided by your dataProvider.
+ * to update the data shown on the page via the {@link https://refine.dev/docs/api-reference/core/hooks/data/useOne `useOne`} method provided by your dataProvider.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/refresh-button} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/buttons/refresh-button} for more details.
  */
 export declare const RefreshButton: React.FC<RefreshButtonProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/buttons/save/index.d.ts

@@ -4,7 +4,7 @@ import { SaveButtonProps } from "../types";
  * `<SaveButton>` uses Ant Design's {@link https://ant.design/components/button/ `<Button>`} component.
  * It uses it for presantation purposes only. Some of the hooks that refine has adds features to this button.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/save-button} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/buttons/save-button} for more details.
  */
 export declare const SaveButton: React.FC<SaveButtonProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/buttons/show/index.d.ts

@@ -2,10 +2,10 @@ import React from "react";
 import { ShowButtonProps } from "../types";
 /**
  * `<ShowButton>` uses Ant Design's {@link https://ant.design/components/button/ `<Button>`} component.
- * It uses the {@link https://refine.dev/docs/core/hooks/navigation/useNavigation#show `show`} method from {@link https://refine.dev/docs/core/hooks/navigation/useNavigation `useNavigation`} under the hood.
+ * It uses the {@link https://refine.dev/docs/api-reference/core/hooks/navigation/useNavigation#show `show`} method from {@link https://refine.dev/docs/api-reference/core/hooks/navigation/useNavigation `useNavigation`} under the hood.
  * It can be useful when redirecting the app to the show page with the record id route of resource.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/show-button} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/buttons/show-button} for more details.
  */
 export declare const ShowButton: React.FC<ShowButtonProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/fields/boolean/index.d.ts

@@ -3,7 +3,7 @@ import { BooleanFieldProps } from "../types";
 /**
  * This field is used to display boolean values. It uses the {@link https://ant.design/components/tooltip/#header `<Tooltip>`} values from Ant Design.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/fields/boolean} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/fields/boolean} for more details.
  */
 export declare const BooleanField: React.FC<BooleanFieldProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/fields/date/index.d.ts

@@ -3,7 +3,7 @@ import { DateFieldProps } from "../types";
 /**
  * This field is used to display dates. It uses {@link https://day.js.org/docs/en/display/format `Day.js`} to display date format.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/fields/date} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/fields/date} for more details.
  */
 export declare const DateField: React.FC<DateFieldProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/fields/email/index.d.ts

@@ -4,7 +4,7 @@ import { EmailFieldProps } from "../types";
  * This field is used to display email values. It uses the {@link https://ant.design/components/typography/#FAQ `<Link>`} component
  * of {@link https://ant.design/components/typography `<Typography>`} from Ant Design.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/fields/email} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/fields/email} for more details.
  */
 export declare const EmailField: React.FC<EmailFieldProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/fields/file/index.d.ts

@@ -3,7 +3,7 @@ import { FileFieldProps } from "../types";
 /**
  * This field is used to display files and uses {@link https://ant.design/components/typography `<Typography.Link>`} from Ant Design.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/fields/file} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/fields/file} for more details.
  */
 export declare const FileField: React.FC<FileFieldProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/fields/image/index.d.ts

@@ -3,7 +3,7 @@ import { ImageFieldProps } from "../types";
 /**
  * This field is used to display images and uses {@link https://ant.design/components/image/#header `<Image>`} from Ant Design.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/fields/image} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/fields/image} for more details.
  */
 export declare const ImageField: React.FC<ImageFieldProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/fields/markdown/index.d.ts

@@ -3,7 +3,7 @@ import { RefineFieldMarkdownProps } from "../types";
 /**
  * This field lets you display markdown content. It supports {@link https://github.github.com/gfm/ GitHub Flavored Markdown}.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/fields/markdown} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/fields/markdown} for more details.
  */
 export declare const MarkdownField: React.FC<RefineFieldMarkdownProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/fields/number/index.d.ts

@@ -3,7 +3,7 @@ import { NumberFieldProps } from "../types";
 /**
  * This field is used to display a number formatted according to the browser locale, right aligned. and uses {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl `Intl`} to display date format.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/fields/number} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/fields/number} for more details.
  */
 export declare const NumberField: React.FC<NumberFieldProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/fields/tag/index.d.ts

@@ -3,7 +3,7 @@ import { TagFieldProps } from "../types";
 /**
  * This field lets you display a value in a tag. It uses Ant Design's {@link https://ant.design/components/tag/ `<Tag>`} component.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/fields/tag} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/fields/tag} for more details.
  */
 export declare const TagField: React.FC<TagFieldProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/fields/text/index.d.ts

@@ -3,7 +3,7 @@ import { TextFieldProps } from "../types";
 /**
  * This field lets you show basic text. It uses Ant Design's {@link https://ant.design/components/typography/#Typography.Text `<Typography.Text>`} component.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/fields/text} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/fields/text} for more details.
  */
 export declare const TextField: React.FC<TextFieldProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/fields/url/index.d.ts

@@ -4,7 +4,7 @@ import { UrlFieldProps } from "../types";
  * This field lets you embed a link. It uses Ant Design's {@link https://ant.design/components/typography/ `<Typography.Link>`} component.
  * You can pass a URL in its `value` property and you can show a text in its place by passing any `children`.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/fields/url} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/fields/url} for more details.
  */
 export declare const UrlField: React.FC<UrlFieldProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/pages/auth/index.d.ts

@@ -8,7 +8,7 @@ export declare type AuthProps = AuthPageProps<LayoutProps, CardProps, FormProps>
 /**
  * **refine** has a default auth page form served on the `/login` route when the `authProvider` configuration is provided.
  *
- * @see {@link https://refine.dev/docs/ui-frameworks/antd/components/authpage/} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/antd/components/antd-auth-page/} for more details.
  */
 export declare const AuthPage: React.FC<AuthProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/pages/error/index.d.ts

@@ -4,7 +4,7 @@ import { RefineErrorPageProps } from "@refinedev/ui-types";
  * When the app is navigated to a non-existent route, refine shows a default error page.
  * A custom error component can be used for this error page.
  *
- * @see {@link https://refine.dev/docs/api-references/components/refine-config#catchall} for more details.
+ * @see {@link https://refine.dev/docs/packages/documentation/routers/} for more details.
  */
 export declare const ErrorComponent: React.FC<RefineErrorPageProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/pages/login/index.d.ts

@@ -9,7 +9,7 @@ export interface ILoginForm {
  * @deprecated LoginPage is deprecated. Use AuthPage instead. @see {@link https://refine.dev/docs/api-reference/antd/components/antd-auth-page} for more details.
  * **refine** has a default login page form which is served on `/login` route when the `authProvider` configuration is provided.
  *
- * @see {@link https://refine.dev/docs/api-references/components/refine-config#loginpage} for more details.
+ * @see {@link https://refine.dev/docs/api-reference/core/components/refine-config/#loginpage} for more details.
  */
 export declare const LoginPage: React.FC<LoginPageProps>;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/pages/ready/index.d.ts

@@ -3,7 +3,6 @@ import { RefineReadyPageProps } from "@refinedev/ui-types";
 /**
  * **refine** shows a default ready page on root route when no `resources` is passed to the `<Refine>` component as a property.
  *
- * @see {@link https://refine.dev/docs/api-references/components/refine-config#readypage} for more details.
  * @deprecated `ReadyPage` is deprecated and will be removed in the next major release.
  */
 export declare const ReadyPage: React.FC<RefineReadyPageProps>;

package/dist/components/pages/ready/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/pages/ready/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAoC3D;;;;;GAKG;AACH,eAAO,MAAM,SAAS,EAAE,KAAK,CAAC,EAAE,CAAC,oBAAoB,CAoDpD,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/pages/ready/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAoC3D;;;;GAIG;AACH,eAAO,MAAM,SAAS,EAAE,KAAK,CAAC,EAAE,CAAC,oBAAoB,CAoDpD,CAAC"}