feat(core): add optimisticUpdateMap prop on useUpdate, useUpdateMany and useForm

[yildirayunlu]

If the mutation mode is defined as optimistic the useUpdate hook will automatically update the cache without waiting for the response from the server. You may want to disable or customize this behavior. You can do this by passing the optimisticUpdateMap prop.

list, many and detail are the keys of the optimisticUpdateMap object. For automatically updating the cache, you should pass the true. If you want not update the cache, you should pass the false.

const { mutate } = useUpdate();

mutate({
    //...
    mutationMode: "optimistic",
    optimisticUpdateMap: {
        list: true,
        many: true,
        detail: false,
    },
});

For useForm:

const { formProps, saveButtonProps } = useForm({
        mutationMode: "optimistic",
        optimisticUpdateMap: {
            list: true,
            many: true,
            detail: (previous, values, id) => {
                if (!previous) {
                    return null;
                }

                const data = {
                    id,
                    ...previous.data,
                    ...values,
                    foo: `bar-one`,
                };

                return {
                    ...previous,
                    data,
                };
            },
        },
    });

Self Check before Merge

Please check all items below before review.

• Corresponding issues are created/updated or not needed
• Docs are updated/provided or not needed
• Examples are updated/provided or not needed
• TypeScript definitions are updated/provided or not needed
• Tests are updated/provided or not needed
• Changesets are provided or not needed

[changeset-bot]

🦋 Changeset detected

Latest commit: 6c57ef1

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[netlify]

✅ Deploy Preview for lighthearted-pastelito-e86ad1 ready!

Name	Link
🔨 Latest commit	6c57ef1
🔍 Latest deploy log	https://app.netlify.com/sites/lighthearted-pastelito-e86ad1/deploys/6509ca95a2dc010008847026
😎 Deploy Preview	https://deploy-preview-4914--lighthearted-pastelito-e86ad1.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[netlify]

✅ Deploy Preview for refine-doc-live-previews ready!

Name	Link
🔨 Latest commit	6c57ef1
🔍 Latest deploy log	https://app.netlify.com/sites/refine-doc-live-previews/deploys/6509ca959240190007b49ae8
😎 Deploy Preview	https://deploy-preview-4914--refine-doc-live-previews.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[netlify]

✅ Deploy Preview for imaginative-sundae-1fd394 ready!

Name	Link
🔨 Latest commit	6c57ef1
🔍 Latest deploy log	https://app.netlify.com/sites/imaginative-sundae-1fd394/deploys/6509ca95a288990008eeb146
😎 Deploy Preview	https://deploy-preview-4914--imaginative-sundae-1fd394.netlify.app/
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 6c57ef1. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

✅ Successfully ran 7 targets

• lerna run build --include-dependencies --scope @refinedev/core --no-bail --scope=form-mui-use-modal-form --scope=form-react-hook-form-use-steps-form --scope=form-mui-use-steps-form --scope=i18n --scope=i18n-nextjs --scope=form-save-and-continue --scope=i18n-react --scope=import-export-antd --scope=import-export-mantine --scope=inferencer-antd --sco...
• lerna run build --include-dependencies --scope @refinedev/core --no-bail --scope=access-control-casbin --scope=auth-antd --scope=access-control-cerbos --scope=accessControl --scope=antd-audit-log --scope=auth-auth0 --scope=antdAuditLog --scope=app-crm --scope=audit-log-provider --scope=auth-chakra-ui --scope=auditLogProvider --scope=auth-mui --scop...
• lerna run build --include-dependencies --scope @refinedev/core --no-bail --scope=blog-next-refine-pwa --scope=base-chakra-ui --scope=blog-ra-chakra-tutorial --scope=blog-react-aria --scope=blog-react-dnd --scope=base-mantine --scope=blog-react-hook-dynamic-form --scope=blog-react-memoization-memo --scope=blog-react-toastify --scope=base-material-ui...
• lerna run build --include-dependencies --scope @refinedev/core --no-bail --scope=template-mui --scope=table-chakra-ui-advanced --scope=theme-antd-demo --scope=theme-chakra-ui-demo --scope=theme-mantine-demo --scope=table-chakra-ui-basic --scope=theme-material-ui-demo --scope=theme-mui-demo --scope=tutorial --scope=table-handson --scope=tutorial-ant...
• lerna run build --include-dependencies --scope @refinedev/core --no-bail --scope=calendar-app --scope=form-antd-use-modal-form --scope=cloud --scope=command-palette-kbar --scope=commandPalette --scope=form-antd-use-steps-form --scope=core --scope=core-use-import --scope=core-use-menu --scope=form-chakra-ui-mutation-mode --scope=core-use-modal --sco...
• lerna run build --include-dependencies --scope @refinedev/core --no-bail --scope=data-provider-multiple --scope=form-mantine-use-modal-form --scope=data-provider-nestjs-query --scope=data-provider-nestjsx-crud --scope=data-provider-nhost --scope=form-mantine-use-steps-form --scope=data-provider-strapi --scope=data-provider-strapi-graphql --scope=da...
• lerna run build --include-dependencies --scope @refinedev/core --no-bail --scope=mutation-mode --scope=server-side-form-validation-chakra-ui --scope=new-routing-example --scope=pixels --scope=pixels-admin --scope=server-side-form-validation-mantine --scope=react-location --scope=reactToastify --scope=real-world-example --scope=server-side-form-vali...

---

Sent with 💌 from NxCloud.

[netlify]

✅ Deploy Preview for aquamarine-panda-e208bf ready!

Name	Link
🔨 Latest commit	6c57ef1
🔍 Latest deploy log	https://app.netlify.com/sites/aquamarine-panda-e208bf/deploys/6509ca95d562e9000809a9ca
😎 Deploy Preview	https://deploy-preview-4914--aquamarine-panda-e208bf.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[netlify]

✅ Deploy Preview for zippy-semolina-4ad81e ready!

Name	Link
🔨 Latest commit	6c57ef1
🔍 Latest deploy log	https://app.netlify.com/sites/zippy-semolina-4ad81e/deploys/6509ca9536f9f30008dedd93
😎 Deploy Preview	https://deploy-preview-4914--zippy-semolina-4ad81e.netlify.app/
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[netlify]

✅ Deploy Preview for stupendous-taffy-33f80c ready!

Name	Link
🔨 Latest commit	6c57ef1
🔍 Latest deploy log	https://app.netlify.com/sites/stupendous-taffy-33f80c/deploys/6509ca95a2dc01000884702b
😎 Deploy Preview	https://deploy-preview-4914--stupendous-taffy-33f80c.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.