@bigbinary/neeto-thank-you-frontend 2.1.44 → 2.1.45

package/README.md

@@ -1,11 +1,14 @@
 [![BuildStatus](https://neeto-engineering.neetoci.com/badges/neeto-thank-you-nano/workflows/branch.svg)](https://neeto-engineering.neetoci.com/projects/neeto-thank-you-nano)
 
-# neeto-thank-you-nano
+# neeto-thank-you-nano 
 
 The `neeto-thank-you-nano` manages the "Thank You" configuration page across
 neeto applications. The nano exports the `@bigbinary/neeto-thank-you-frontend`
 NPM package and `neeto-thank-you-engine` Rails engine for development.
 
+The nano also supports multiple thank you pages per entity, allowing you to
+configure and display different thank you pages as needed.
+
 # Contents
 
 1. [Development with Host Application](#development-with-host-application)
@@ -66,8 +69,9 @@ You can learn more about the setup and usage here:
 
 The package exports two components: `ConfigureThankYou` and `ShowThankYou`.
 
-The package also exports two hooks: `useShowThankYouPage` and
-`useShowThankYouConfiguration`
+The package also exports several hooks for managing thank you configurations,
+including `useFetchThankYouConfigurations` which can be used to retrieve
+multiple thank you configurations for an entity.
 
 ### Installation
 
@@ -92,6 +96,7 @@ application.
 
 ##### Props
 
+- `id` - ID of the specific thank you configuration
 - `breadcrumbs` - Set the header component's breadcrumbs
 - `socialHandles` - Set the URLs for sharing to social media
 - `isPublished` - Boolean to manage pointer events in the "Thank You" page
@@ -164,6 +169,7 @@ const App = () => {
       <ConfigureThankYou
         blockNavigation
         hasImageUploader
+        id
         breadcrumbs={breadcrumbs}
         entityId={entityId}
         publicLinkId={publicLinkId}
@@ -283,13 +289,14 @@ const { data: { thankYouConfiguration } = {} } = useShowThankYouPage({
 });
 ```
 
-#### `useShowThankYouConfiguration` ([source code](https://github.com/bigbinary/neeto-thank-you-nano/blob/fd519090a7b0ce63db912bdf795872bbdb6f9194/app/javascript/src/hooks/reactQuery/useThankYouConfigurationApi.js#L6))
+#### `useShowThankYouConfiguration` ([source code](https://github.com/bigbinary/neeto-thank-you-nano/blob/5183a59e3a3f097e58498ed27395c4d35067e8d1/app/javascript/src/hooks/reactQuery/useThankYouConfigurationApi.js#L27))
 
 This hook is used to fetch the thank you configuration of the entity.
 
 ##### Props
 
 - `entityId` - ID of the entity to load the thank you configuration
+- `id` - ID of the specific thank you configuration to fetch
 
 ##### Return value
 
@@ -305,7 +312,104 @@ import { useShowThankYouConfiguration } from "@bigbinary/neeto-thank-you-fronten
 const {
   isLoading: isThankYouActionLoading,
   data: { thankYouConfiguration } = {},
-} = useShowThankYouConfiguration({ entityId });
+} = useShowThankYouConfiguration({
+  entityId,
+  id,
+});
+```
+
+#### `useFetchThankYouConfigurations` ([source code](https://github.com/bigbinary/neeto-thank-you-nano/blob/5183a59e3a3f097e58498ed27395c4d35067e8d1/app/javascript/src/hooks/reactQuery/useThankYouConfigurationApi.js#L7))
+
+This hook is used to fetch multiple thank you configurations for an entity.
+
+##### Props
+
+- `entityId` - ID of the entity to load the thank you configurations
+- `filters` - Optional filters to apply when fetching configurations
+- `options` - Optional React Query options
+
+##### Return value
+
+Returns the `data` object which includes the `thankYouConfigurations` array
+containing all thank you configurations for the entity, and an `isLoading`
+boolean.
+
+##### Usage
+
+```js
+import { useFetchThankYouConfigurations } from "@bigbinary/neeto-thank-you-frontend";
+
+const { isLoading, data: { thankYouConfigurations } = {} } =
+  useFetchThankYouConfigurations(entityId, filters, options);
+```
+
+#### `useCreateThankYouConfiguration` ([source code](https://github.com/bigbinary/neeto-thank-you-nano/blob/5183a59e3a3f097e58498ed27395c4d35067e8d1/app/javascript/src/hooks/reactQuery/useThankYouConfigurationApi.js#L18))
+
+This hook is used to create a new thank you configuration for an entity.
+
+##### Props
+
+- `entityId` - ID of the entity to create the thank you configuration for
+- `options` - Optional React Query mutation options
+
+##### Return value
+
+Returns a mutation function and mutation state including `isPending` and `error`
+properties.
+
+##### Usage
+
+```js
+import { useCreateThankYouConfiguration } from "@bigbinary/neeto-thank-you-frontend";
+
+const { mutate: createConfiguration, isPending } =
+  useCreateThankYouConfiguration(entityId);
+```
+
+#### `useUpdateThankYouConfiguration` ([source code](https://github.com/bigbinary/neeto-thank-you-nano/blob/5183a59e3a3f097e58498ed27395c4d35067e8d1/app/javascript/src/hooks/reactQuery/useThankYouConfigurationApi.js#L34))
+
+This hook is used to update an existing thank you configuration.
+
+##### Props
+
+- `id` - ID of the thank you configuration to update
+- `options` - Optional React Query mutation options
+
+##### Return value
+
+Returns a mutation function and mutation state including `isPending` and `error`
+properties.
+
+##### Usage
+
+```js
+import { useUpdateThankYouConfiguration } from "@bigbinary/neeto-thank-you-frontend";
+
+const { mutate: updateConfiguration, isPending } =
+  useUpdateThankYouConfiguration(configurationId);
+```
+
+#### `useDeleteThankYouConfiguration` ([source code](https://github.com/bigbinary/neeto-thank-you-nano/blob/5183a59e3a3f097e58498ed27395c4d35067e8d1/app/javascript/src/hooks/reactQuery/useThankYouConfigurationApi.js#L44))
+
+This hook is used to delete a thank you configuration.
+
+##### Props
+
+- `entityId` - ID of the entity that owns the thank you configuration
+- `options` - Optional React Query mutation options
+
+##### Return value
+
+Returns a mutation function and mutation state including `isPending` and `error`
+properties.
+
+##### Usage
+
+```js
+import { useDeleteThankYouConfiguration } from "@bigbinary/neeto-thank-you-frontend";
+
+const { mutate: deleteConfiguration, isPending } =
+  useDeleteThankYouConfiguration(entityId);
 ```
 
 # Instructions for Publishing

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/neeto-thank-you-frontend",
-  "version": "2.1.44",
+  "version": "2.1.45",
   "description": "A repo acts as the source of truth for the new nano's structure, configs, data etc.",
   "license": "UNLICENSED",
   "homepage": "https://github.com/bigbinary/neeto-thank-you-nano",
@@ -58,15 +58,15 @@
     "@babel/preset-typescript": "7.26.0",
     "@babel/runtime": "7.26.10",
     "@bigbinary/babel-preset-neeto": "^1.0.3",
-    "@bigbinary/eslint-plugin-neeto": "1.6.2",
+    "@bigbinary/eslint-plugin-neeto": "1.6.3",
     "@bigbinary/neeto-cist": "1.0.17",
-    "@bigbinary/neeto-commons-frontend": "4.13.39",
-    "@bigbinary/neeto-editor": "1.47.7",
-    "@bigbinary/neeto-filters-frontend": "4.3.19",
-    "@bigbinary/neeto-icons": "1.20.47",
+    "@bigbinary/neeto-commons-frontend": "4.13.43",
+    "@bigbinary/neeto-editor": "1.47.16",
+    "@bigbinary/neeto-filters-frontend": "4.3.21",
+    "@bigbinary/neeto-icons": "1.20.49",
     "@bigbinary/neeto-image-uploader-frontend": "2.3.18",
-    "@bigbinary/neeto-molecules": "3.16.49",
-    "@bigbinary/neetoui": "8.3.6",
+    "@bigbinary/neeto-molecules": "3.16.63",
+    "@bigbinary/neetoui": "8.3.9",
     "@emotion/is-prop-valid": "1.2.0",
     "@faker-js/faker": "8.2.0",
     "@honeybadger-io/js": "6.10.1",
@@ -138,8 +138,8 @@
     "process": "^0.11.10",
     "qs": "^6.11.2",
     "ramda": "0.29.0",
-    "react": "18.2.0",
-    "react-dom": "18.2.0",
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
     "react-helmet": "^6.1.0",
     "react-i18next": "12.3.1",
     "react-router-dom": "5.3.3",
@@ -166,20 +166,20 @@
     "webpack": "5.76.0",
     "webpack-assets-manifest": "^5.1.0",
     "webpack-cli": "4.10.0",
-    "webpack-dev-server": "^4.15.0",
+    "webpack-dev-server": "^5.2.1",
     "yup": "0.32.11",
     "zustand": "4.4.2"
   },
   "peerDependencies": {
     "@babel/runtime": "7.26.10",
     "@bigbinary/neeto-cist": "1.0.17",
-    "@bigbinary/neeto-commons-frontend": "4.13.39",
-    "@bigbinary/neeto-editor": "1.47.7",
-    "@bigbinary/neeto-filters-frontend": "4.3.19",
-    "@bigbinary/neeto-icons": "1.20.47",
+    "@bigbinary/neeto-commons-frontend": "4.13.43",
+    "@bigbinary/neeto-editor": "1.47.16",
+    "@bigbinary/neeto-filters-frontend": "4.3.21",
+    "@bigbinary/neeto-icons": "1.20.49",
     "@bigbinary/neeto-image-uploader-frontend": "2.3.18",
-    "@bigbinary/neeto-molecules": "3.16.49",
-    "@bigbinary/neetoui": "8.3.6",
+    "@bigbinary/neeto-molecules": "3.16.63",
+    "@bigbinary/neetoui": "8.3.9",
     "@honeybadger-io/js": "6.10.1",
     "@honeybadger-io/react": "6.1.25",
     "@tailwindcss/container-queries": "^0.1.1",
@@ -200,8 +200,8 @@
     "path-browserify": "^1.0.1",
     "qs": "^6.11.2",
     "ramda": "0.29.0",
-    "react": "18.2.0",
-    "react-dom": "18.2.0",
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
     "react-helmet": "^6.1.0",
     "react-i18next": "12.3.1",
     "react-router-dom": "5.3.3",
@@ -220,7 +220,9 @@
   "resolutions": {
     "postcss": "^8",
     "wrap-ansi": "7.0.0",
-    "string-width": "4.1.0"
+    "string-width": "4.1.0",
+    "react": "18.3.1",
+    "react-dom": "18.3.1"
   },
   "engines": {
     "node": ">=22.13",

package/types/ConfigureThankYou.d.ts

@@ -13,6 +13,7 @@ type SocialHandle = {
 };
 
 interface ConfigureThankYouProps {
+  id?: string;
   breadcrumbs: Breadcrumb[];
   socialHandles?: SocialHandle[];
   entityId: string;