@dynamic-labs/sdk-react-core 0.19.0-alpha.0 → 0.19.0-alpha.2

package/src/lib/utils/hooks/useTransactionEstimatedGas/useTransactionEstimatedGas.d.ts

@@ -0,0 +1,20 @@
+import { ethers } from 'ethers';
+/**
+ * Hook to estimate the gas required for a transaction.
+ *
+ * This hook uses the `usePromise` hook to asynchronously estimate the gas required for a transaction.
+ * It first tries to estimate the gas without the 'from' field in the transaction, as the Alchemy API
+ * checks the origin address funds and can return an error if the origin wallet has no funds for the transaction.
+ * If the error 'UNPREDICTABLE_GAS_LIMIT' is encountered, it tries to estimate the gas again with the
+ * original transaction.
+ *
+ * @see {@link https://docs.alchemy.com/reference/eth-estimategas}
+ * @see {@link https://docs.ethers.org/v5/troubleshooting/errors/#help-UNPREDICTABLE_GAS_LIMIT}
+ *
+ * @param {ethers.providers.Web3Provider} provider - The Web3 provider to use for estimating the gas.
+ * @param {ethers.utils.Deferrable<ethers.providers.TransactionRequest>} transaction - The transaction for
+ * which to estimate the gas.
+ *
+ * @returns {PromiseState<ethers.BigNumber>} A promise that resolves to the estimated gas for the transaction.
+ */
+export declare const useTransactionEstimatedGas: (provider: ethers.providers.Web3Provider, transaction: ethers.utils.Deferrable<ethers.providers.TransactionRequest>) => import("../usePromise").PromiseState<ethers.BigNumber, Error>;

package/src/lib/utils/hooks/useTransactionEstimatedGas/useTransactionEstimatedGas.js

@@ -0,0 +1,57 @@
+import { __awaiter, __rest } from '../../../../../_virtual/_tslib.js';
+import { usePromise } from '../usePromise/usePromise.js';
+import '@dynamic-labs/sdk-api';
+import { logger } from '../../../shared/logger.js';
+import '@dynamic-labs/iconic';
+import '@dynamic-labs/wallet-connector-core';
+import 'react/jsx-runtime';
+import '../../../context/ViewContext/ViewContext.js';
+import 'react';
+import '@dynamic-labs/wallet-book';
+import '@dynamic-labs/utils';
+import '../../constants/colors.js';
+import '../../../shared/utils/classes/storage/localStorage.js';
+import 'ethers';
+import '../../../shared/consts/index.js';
+
+/**
+ * Hook to estimate the gas required for a transaction.
+ *
+ * This hook uses the `usePromise` hook to asynchronously estimate the gas required for a transaction.
+ * It first tries to estimate the gas without the 'from' field in the transaction, as the Alchemy API
+ * checks the origin address funds and can return an error if the origin wallet has no funds for the transaction.
+ * If the error 'UNPREDICTABLE_GAS_LIMIT' is encountered, it tries to estimate the gas again with the
+ * original transaction.
+ *
+ * @see {@link https://docs.alchemy.com/reference/eth-estimategas}
+ * @see {@link https://docs.ethers.org/v5/troubleshooting/errors/#help-UNPREDICTABLE_GAS_LIMIT}
+ *
+ * @param {ethers.providers.Web3Provider} provider - The Web3 provider to use for estimating the gas.
+ * @param {ethers.utils.Deferrable<ethers.providers.TransactionRequest>} transaction - The transaction for
+ * which to estimate the gas.
+ *
+ * @returns {PromiseState<ethers.BigNumber>} A promise that resolves to the estimated gas for the transaction.
+ */
+const useTransactionEstimatedGas = (provider, transaction) => usePromise(() => __awaiter(void 0, void 0, void 0, function* () {
+    // To safely run estimateGas using alchemy, we need to remove the from address
+    // because alchemy checks the origin address funds and can return an error if
+    // origin wallet has no funds for the transaction
+    // https://docs.alchemy.com/reference/eth-estimategas
+    const transactionWithNoOrigin = __rest(transaction, ["from"]);
+    try {
+        return yield provider.estimateGas(transactionWithNoOrigin);
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    }
+    catch (err) {
+        logger.error(err);
+        // If the error is UNPREDICTABLE_GAS_LIMIT, we try to estimate gas again
+        // with original transaction
+        // https://docs.ethers.org/v5/troubleshooting/errors/#help-UNPREDICTABLE_GAS_LIMIT
+        if (err.code === 'UNPREDICTABLE_GAS_LIMIT') {
+            return provider.estimateGas(transaction);
+        }
+        throw err;
+    }
+}), { deps: [transaction, provider] });
+
+export { useTransactionEstimatedGas };

package/src/lib/utils/hooks/useTransactionWithGasPrice/index.d.ts

@@ -0,0 +1 @@
+export { useTransactionWithGasPrice } from './useTransactionWithGasPrice';

package/src/lib/utils/hooks/useTransactionWithGasPrice/useTransactionWithGasPrice.cjs

@@ -0,0 +1,47 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var usePromise = require('../usePromise/usePromise.cjs');
+
+const increaseGasPrice = (gasPrice, increasePercentage) => {
+    const increaseFactor = 100 + increasePercentage;
+    return gasPrice.mul(increaseFactor).div(100);
+};
+/**
+ * A React Hook that returns a transaction object with the gas price set to the current gas price from the provider.
+ * The gas price is increased by a certain percentage specified by the user. The hook also allows the user to enable
+ * or disable this functionality.
+ *
+ * @param {Object} props - The properties for the hook.
+ * @param {ethers.providers.Provider} props.provider - The provider to use for getting the current gas price.
+ * @param {ethers.utils.Deferrable<ethers.providers.TransactionRequest>} props.transaction - The transaction object.
+ * @param {number} props.increasePercentage - The percentage by which to increase the current gas price.
+ * @param {boolean} [props.enabled=true] - A flag to enable or disable the gas price increase functionality.
+ *
+ * @returns {ethers.utils.Deferrable<ethers.providers.TransactionRequest>} A new transaction object with the gas price.
+ * If the `enabled` flag is set to false, or if the gas price is not available, or if the transaction already has a
+ * gas price set, the original transaction object is returned.
+ *
+ * @example
+ * const updatedTransaction = useTransactionWithGasPrice({
+ *   provider: myProvider,
+ *   transaction: myTransaction,
+ *   increasePercentage: 10,
+ *   enabled: true,
+ * });
+ */
+const useTransactionWithGasPrice = ({ increasePercentage = 0, provider, transaction, enabled = true, }) => {
+    const isGasPriceDefinedInTransaction = Boolean(transaction.gasPrice);
+    const shouldLoadGasPrice = enabled && increasePercentage > 0 && !isGasPriceDefinedInTransaction;
+    const { data: gasPrice } = usePromise.usePromise(() => provider.getGasPrice(), {
+        deps: [transaction, provider],
+        enabled: shouldLoadGasPrice,
+    });
+    if (!gasPrice) {
+        return transaction;
+    }
+    return Object.assign(Object.assign({}, transaction), { gasPrice: increaseGasPrice(gasPrice, increasePercentage) });
+};
+
+exports.useTransactionWithGasPrice = useTransactionWithGasPrice;

package/src/lib/utils/hooks/useTransactionWithGasPrice/useTransactionWithGasPrice.d.ts

@@ -0,0 +1,32 @@
+import { ethers } from 'ethers';
+type UseTransactionWithGasPriceProps = {
+    provider: ethers.providers.Provider;
+    transaction: ethers.utils.Deferrable<ethers.providers.TransactionRequest>;
+    increasePercentage?: number;
+    enabled?: boolean;
+};
+/**
+ * A React Hook that returns a transaction object with the gas price set to the current gas price from the provider.
+ * The gas price is increased by a certain percentage specified by the user. The hook also allows the user to enable
+ * or disable this functionality.
+ *
+ * @param {Object} props - The properties for the hook.
+ * @param {ethers.providers.Provider} props.provider - The provider to use for getting the current gas price.
+ * @param {ethers.utils.Deferrable<ethers.providers.TransactionRequest>} props.transaction - The transaction object.
+ * @param {number} props.increasePercentage - The percentage by which to increase the current gas price.
+ * @param {boolean} [props.enabled=true] - A flag to enable or disable the gas price increase functionality.
+ *
+ * @returns {ethers.utils.Deferrable<ethers.providers.TransactionRequest>} A new transaction object with the gas price.
+ * If the `enabled` flag is set to false, or if the gas price is not available, or if the transaction already has a
+ * gas price set, the original transaction object is returned.
+ *
+ * @example
+ * const updatedTransaction = useTransactionWithGasPrice({
+ *   provider: myProvider,
+ *   transaction: myTransaction,
+ *   increasePercentage: 10,
+ *   enabled: true,
+ * });
+ */
+export declare const useTransactionWithGasPrice: ({ increasePercentage, provider, transaction, enabled, }: UseTransactionWithGasPriceProps) => ethers.utils.Deferrable<ethers.providers.TransactionRequest>;
+export {};

package/src/lib/utils/hooks/useTransactionWithGasPrice/useTransactionWithGasPrice.js

@@ -0,0 +1,43 @@
+import { usePromise } from '../usePromise/usePromise.js';
+
+const increaseGasPrice = (gasPrice, increasePercentage) => {
+    const increaseFactor = 100 + increasePercentage;
+    return gasPrice.mul(increaseFactor).div(100);
+};
+/**
+ * A React Hook that returns a transaction object with the gas price set to the current gas price from the provider.
+ * The gas price is increased by a certain percentage specified by the user. The hook also allows the user to enable
+ * or disable this functionality.
+ *
+ * @param {Object} props - The properties for the hook.
+ * @param {ethers.providers.Provider} props.provider - The provider to use for getting the current gas price.
+ * @param {ethers.utils.Deferrable<ethers.providers.TransactionRequest>} props.transaction - The transaction object.
+ * @param {number} props.increasePercentage - The percentage by which to increase the current gas price.
+ * @param {boolean} [props.enabled=true] - A flag to enable or disable the gas price increase functionality.
+ *
+ * @returns {ethers.utils.Deferrable<ethers.providers.TransactionRequest>} A new transaction object with the gas price.
+ * If the `enabled` flag is set to false, or if the gas price is not available, or if the transaction already has a
+ * gas price set, the original transaction object is returned.
+ *
+ * @example
+ * const updatedTransaction = useTransactionWithGasPrice({
+ *   provider: myProvider,
+ *   transaction: myTransaction,
+ *   increasePercentage: 10,
+ *   enabled: true,
+ * });
+ */
+const useTransactionWithGasPrice = ({ increasePercentage = 0, provider, transaction, enabled = true, }) => {
+    const isGasPriceDefinedInTransaction = Boolean(transaction.gasPrice);
+    const shouldLoadGasPrice = enabled && increasePercentage > 0 && !isGasPriceDefinedInTransaction;
+    const { data: gasPrice } = usePromise(() => provider.getGasPrice(), {
+        deps: [transaction, provider],
+        enabled: shouldLoadGasPrice,
+    });
+    if (!gasPrice) {
+        return transaction;
+    }
+    return Object.assign(Object.assign({}, transaction), { gasPrice: increaseGasPrice(gasPrice, increasePercentage) });
+};
+
+export { useTransactionWithGasPrice };

package/src/lib/utils/hooks/useUserDataForm/index.d.ts

@@ -0,0 +1 @@
+export * from './useUserDataForm';

package/src/lib/utils/hooks/useUserUpdateRequest/index.d.ts

@@ -0,0 +1,3 @@
+export * from './useUserUpdateRequest';
+export * from './useUpdateUserWithModal';
+export * from './useUpdateUser';

package/src/lib/utils/hooks/useUserUpdateRequest/useUpdateUser/index.d.ts

@@ -0,0 +1 @@
+export * from './useUpdateUser';

package/src/lib/utils/hooks/useUserUpdateRequest/useUpdateUser/useUpdateUser.cjs

@@ -0,0 +1,107 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _tslib = require('../../../../../../_virtual/_tslib.cjs');
+var React = require('react');
+var yup = require('yup');
+var useInternalDynamicContext = require('../../../../context/DynamicContext/useInternalDynamicContext.cjs');
+var EmailVerificationContext = require('../../../../context/EmailVerificationContext/EmailVerificationContext.cjs');
+var api = require('../../../../data/api.cjs');
+var decodeJwt = require('../../../../shared/utils/functions/decodeJwt/decodeJwt.cjs');
+require('@dynamic-labs/iconic');
+require('@dynamic-labs/wallet-connector-core');
+require('react/jsx-runtime');
+require('../../../../context/ViewContext/ViewContext.cjs');
+require('../../../../shared/logger.cjs');
+require('@dynamic-labs/wallet-book');
+require('@dynamic-labs/utils');
+require('../../../constants/colors.cjs');
+require('../../../../shared/utils/classes/storage/localStorage.cjs');
+require('ethers');
+require('../../../../shared/consts/index.cjs');
+var isEmailVerificationRequired = require('../../../functions/authenication/isEmailVerificationRequired/isEmailVerificationRequired.cjs');
+require('../../../../context/ErrorContext/ErrorContext.cjs');
+require('@dynamic-labs/multi-wallet');
+require('@dynamic-labs/sdk-api');
+require('../../../../context/AccessDeniedContext/AccessDeniedContext.cjs');
+require('../../../../context/AccountExistsContext/AccountExistsContext.cjs');
+require('../../../../context/CaptchaContext/CaptchaContext.cjs');
+var useEmailVerificationRequest = require('../../authenticationHooks/useEmailVerificationRequest/useEmailVerificationRequest.cjs');
+var useUpdateUserProfileByJWTCallback = require('../../useUpdateUserProfileByJWTCallback/useUpdateUserProfileByJWTCallback.cjs');
+
+// User Fields Schema without captchaToken and policiesConsent properties
+const userFieldsSchema = yup.object().shape({
+    alias: yup.string(),
+    btcWallet: yup.string(),
+    ckbWallet: yup.string(),
+    country: yup.string(),
+    discordNotification: yup.boolean(),
+    dogeWallet: yup.string(),
+    email: yup.string(),
+    emailNotification: yup.boolean(),
+    firstName: yup.string(),
+    jobTitle: yup.string(),
+    kasWallet: yup.string(),
+    kdaWallet: yup.string(),
+    lastName: yup.string(),
+    ltcWallet: yup.string(),
+    newsletterNotification: yup.boolean(),
+    phoneNumber: yup.string(),
+    tShirtSize: yup.string(),
+    team: yup.string(),
+    username: yup.string(),
+});
+const useUpdateUser = (validationSchemaStripUnknown) => {
+    const { authToken, onboardingOnlyJwt, environmentId } = useInternalDynamicContext.useInternalDynamicContext();
+    const jwtToken = onboardingOnlyJwt || authToken;
+    const { setVerificationUUID, setEmail } = EmailVerificationContext.useEmailVerificationContext();
+    const { verifyEmail } = useEmailVerificationRequest.useEmailVerificationRequest();
+    const { updateUserProfileByJWT } = useUpdateUserProfileByJWTCallback.useUpdateUserProfileByJWTCallback();
+    return React.useCallback((userFields, userEnvironmentId) => _tslib.__awaiter(void 0, void 0, void 0, function* () {
+        var _a, _b, _c;
+        const validatedUserFields = yield userFieldsSchema.validate(userFields, {
+            stripUnknown: validationSchemaStripUnknown,
+        });
+        const updateUserProfileResponse = yield api.updateUserProfileFields(jwtToken, userEnvironmentId || environmentId, validatedUserFields);
+        // check if decoded JWT still somehow has missing fields, we can't proceed if it does
+        const decodedJwt = decodeJwt.decodeJwt(updateUserProfileResponse.jwt);
+        const missingFields = (_a = decodedJwt === null || decodedJwt === void 0 ? void 0 : decodedJwt.missingFields) !== null && _a !== void 0 ? _a : [];
+        const _isEmailVerificationRequired = isEmailVerificationRequired.isEmailVerificationRequired(updateUserProfileResponse);
+        if (!_isEmailVerificationRequired) {
+            // If email verification is not needed then we can update the user profile immediately.
+            yield updateUserProfileByJWT(updateUserProfileResponse.jwt);
+            return {
+                isEmailVerificationRequired: false,
+                missingFields,
+                updateUserProfileResponse,
+            };
+        }
+        // We update EmailContext to use this information in the Email Verification view
+        setEmail((_b = updateUserProfileResponse.emailVerification) === null || _b === void 0 ? void 0 : _b.email);
+        setVerificationUUID((_c = updateUserProfileResponse.emailVerification) === null || _c === void 0 ? void 0 : _c.verificationUUID);
+        // DYN-2046 - Customers have the opportunity to programmatically use our email verification and profile editing.
+        // VerifyEmailFN was scoped to bypass the problem with memoization of the state at the beginning of Promise.
+        // setEmail and setVerificationUUID in the above lines will are not visible in this promise.
+        const scopedVerifyEmailFn = (verificationToken) => {
+            var _a;
+            return verifyEmail(verificationToken, (_a = updateUserProfileResponse.emailVerification) === null || _a === void 0 ? void 0 : _a.verificationUUID);
+        };
+        return {
+            isEmailVerificationRequired: true,
+            missingFields,
+            updateUserProfileResponse,
+            verifyEmailFn: scopedVerifyEmailFn,
+        };
+    }), [
+        environmentId,
+        jwtToken,
+        setEmail,
+        setVerificationUUID,
+        validationSchemaStripUnknown,
+        updateUserProfileByJWT,
+        verifyEmail,
+    ]);
+};
+
+exports.useUpdateUser = useUpdateUser;

package/src/lib/utils/hooks/useUserUpdateRequest/useUpdateUser/useUpdateUser.d.ts

@@ -0,0 +1,9 @@
+import { ProjectSettingsKyc, UpdateSelfResponse, UserFields } from '@dynamic-labs/sdk-api';
+export type UpdateUserFieldsArg = Omit<UserFields, 'captchaToken' | 'policiesConsent'>;
+export type UpdateUserReturnPayload = {
+    isEmailVerificationRequired: boolean;
+    missingFields: ProjectSettingsKyc[];
+    updateUserProfileResponse: UpdateSelfResponse;
+    verifyEmailFn?: (verificationToken: string) => Promise<UpdateSelfResponse>;
+};
+export declare const useUpdateUser: (validationSchemaStripUnknown: boolean) => (userFields: UpdateUserFieldsArg, userEnvironmentId?: string) => Promise<UpdateUserReturnPayload>;

package/src/lib/utils/hooks/useUserUpdateRequest/useUpdateUser/useUpdateUser.js

@@ -0,0 +1,103 @@
+import { __awaiter } from '../../../../../../_virtual/_tslib.js';
+import { useCallback } from 'react';
+import { object, string, boolean } from 'yup';
+import { useInternalDynamicContext } from '../../../../context/DynamicContext/useInternalDynamicContext.js';
+import { useEmailVerificationContext } from '../../../../context/EmailVerificationContext/EmailVerificationContext.js';
+import { updateUserProfileFields } from '../../../../data/api.js';
+import { decodeJwt } from '../../../../shared/utils/functions/decodeJwt/decodeJwt.js';
+import '@dynamic-labs/iconic';
+import '@dynamic-labs/wallet-connector-core';
+import 'react/jsx-runtime';
+import '../../../../context/ViewContext/ViewContext.js';
+import '../../../../shared/logger.js';
+import '@dynamic-labs/wallet-book';
+import '@dynamic-labs/utils';
+import '../../../constants/colors.js';
+import '../../../../shared/utils/classes/storage/localStorage.js';
+import 'ethers';
+import '../../../../shared/consts/index.js';
+import { isEmailVerificationRequired } from '../../../functions/authenication/isEmailVerificationRequired/isEmailVerificationRequired.js';
+import '../../../../context/ErrorContext/ErrorContext.js';
+import '@dynamic-labs/multi-wallet';
+import '@dynamic-labs/sdk-api';
+import '../../../../context/AccessDeniedContext/AccessDeniedContext.js';
+import '../../../../context/AccountExistsContext/AccountExistsContext.js';
+import '../../../../context/CaptchaContext/CaptchaContext.js';
+import { useEmailVerificationRequest } from '../../authenticationHooks/useEmailVerificationRequest/useEmailVerificationRequest.js';
+import { useUpdateUserProfileByJWTCallback } from '../../useUpdateUserProfileByJWTCallback/useUpdateUserProfileByJWTCallback.js';
+
+// User Fields Schema without captchaToken and policiesConsent properties
+const userFieldsSchema = object().shape({
+    alias: string(),
+    btcWallet: string(),
+    ckbWallet: string(),
+    country: string(),
+    discordNotification: boolean(),
+    dogeWallet: string(),
+    email: string(),
+    emailNotification: boolean(),
+    firstName: string(),
+    jobTitle: string(),
+    kasWallet: string(),
+    kdaWallet: string(),
+    lastName: string(),
+    ltcWallet: string(),
+    newsletterNotification: boolean(),
+    phoneNumber: string(),
+    tShirtSize: string(),
+    team: string(),
+    username: string(),
+});
+const useUpdateUser = (validationSchemaStripUnknown) => {
+    const { authToken, onboardingOnlyJwt, environmentId } = useInternalDynamicContext();
+    const jwtToken = onboardingOnlyJwt || authToken;
+    const { setVerificationUUID, setEmail } = useEmailVerificationContext();
+    const { verifyEmail } = useEmailVerificationRequest();
+    const { updateUserProfileByJWT } = useUpdateUserProfileByJWTCallback();
+    return useCallback((userFields, userEnvironmentId) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a, _b, _c;
+        const validatedUserFields = yield userFieldsSchema.validate(userFields, {
+            stripUnknown: validationSchemaStripUnknown,
+        });
+        const updateUserProfileResponse = yield updateUserProfileFields(jwtToken, userEnvironmentId || environmentId, validatedUserFields);
+        // check if decoded JWT still somehow has missing fields, we can't proceed if it does
+        const decodedJwt = decodeJwt(updateUserProfileResponse.jwt);
+        const missingFields = (_a = decodedJwt === null || decodedJwt === void 0 ? void 0 : decodedJwt.missingFields) !== null && _a !== void 0 ? _a : [];
+        const _isEmailVerificationRequired = isEmailVerificationRequired(updateUserProfileResponse);
+        if (!_isEmailVerificationRequired) {
+            // If email verification is not needed then we can update the user profile immediately.
+            yield updateUserProfileByJWT(updateUserProfileResponse.jwt);
+            return {
+                isEmailVerificationRequired: false,
+                missingFields,
+                updateUserProfileResponse,
+            };
+        }
+        // We update EmailContext to use this information in the Email Verification view
+        setEmail((_b = updateUserProfileResponse.emailVerification) === null || _b === void 0 ? void 0 : _b.email);
+        setVerificationUUID((_c = updateUserProfileResponse.emailVerification) === null || _c === void 0 ? void 0 : _c.verificationUUID);
+        // DYN-2046 - Customers have the opportunity to programmatically use our email verification and profile editing.
+        // VerifyEmailFN was scoped to bypass the problem with memoization of the state at the beginning of Promise.
+        // setEmail and setVerificationUUID in the above lines will are not visible in this promise.
+        const scopedVerifyEmailFn = (verificationToken) => {
+            var _a;
+            return verifyEmail(verificationToken, (_a = updateUserProfileResponse.emailVerification) === null || _a === void 0 ? void 0 : _a.verificationUUID);
+        };
+        return {
+            isEmailVerificationRequired: true,
+            missingFields,
+            updateUserProfileResponse,
+            verifyEmailFn: scopedVerifyEmailFn,
+        };
+    }), [
+        environmentId,
+        jwtToken,
+        setEmail,
+        setVerificationUUID,
+        validationSchemaStripUnknown,
+        updateUserProfileByJWT,
+        verifyEmail,
+    ]);
+};
+
+export { useUpdateUser };

package/src/lib/utils/hooks/useUserUpdateRequest/useUpdateUserWithModal/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useUpdateUserWithModal';
+export * from './types';

package/src/lib/utils/hooks/useUserUpdateRequest/useUpdateUserWithModal/types.d.ts

@@ -0,0 +1,7 @@
+import { UserFields } from '@dynamic-labs/sdk-api';
+export type UpdateUserWithModalOptions = {
+    title?: string;
+    subtitle?: string;
+    submitText?: string;
+};
+export type UpdateUserWithModalFields = (keyof UserFields)[];

package/src/lib/utils/hooks/useUserUpdateRequest/useUpdateUserWithModal/useUpdateUserWithModal.cjs

@@ -0,0 +1,73 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _tslib = require('../../../../../../_virtual/_tslib.cjs');
+var React = require('react');
+var utils = require('@dynamic-labs/utils');
+var useInternalDynamicContext = require('../../../../context/DynamicContext/useInternalDynamicContext.cjs');
+var UserFieldEditorContext = require('../../../../context/UserFieldEditorContext/UserFieldEditorContext.cjs');
+var ViewContext = require('../../../../context/ViewContext/ViewContext.cjs');
+var validateUpdateRequest = require('./validateUpdateRequest/validateUpdateRequest.cjs');
+
+/** Saves the values updated by the user */
+const saveUserValues = ({ fields: newValues, updateUserResult: { isEmailVerificationRequired }, }, internalEvents, setShowAuthFlow, setView, resolve, reject) => _tslib.__awaiter(void 0, void 0, void 0, function* () {
+    // If no verification is needed, we are done
+    if (!isEmailVerificationRequired) {
+        resolve(newValues);
+        return;
+    }
+    // Show email verification view
+    setShowAuthFlow(true);
+    setView('verify-email');
+    // Subscribe to email verification result
+    internalEvents.current.once('emailVerificationResult', (wasSuccessful) => {
+        wasSuccessful
+            ? resolve(newValues)
+            : reject('Failed to verify email, no fields were updated');
+    });
+});
+// eslint-disable-next-line multiline-comment-style
+/** This hook allows to open the widget modal and expose any fields for editing.
+ * The fields must have been previously enabled in the dashboard
+ */
+const useUpdateUserWithModal = (updateUser) => {
+    const { user, projectSettings, setShowAuthFlow, internalEvents } = useInternalDynamicContext.useInternalDynamicContext();
+    const { setView } = ViewContext.useViewContext();
+    const editorContext = React.useContext(UserFieldEditorContext.UserFieldEditorContext);
+    if (!editorContext)
+        throw new utils.DynamicError('useUserUpdateRequest can only be used inside the context of DynamicContextProvider');
+    const { open: promptUserForValues } = editorContext;
+    const updateUserWithModal = React.useCallback((fields, options) => new Promise((resolve, reject) => {
+        // Catch invalid requests
+        const errorResponse = validateUpdateRequest.validateUpdateRequest(fields, user, projectSettings);
+        if (errorResponse) {
+            reject(errorResponse);
+            return;
+        }
+        // Get user values
+        promptUserForValues({
+            fields,
+            submitText: options === null || options === void 0 ? void 0 : options.submitText,
+            subtitle: options === null || options === void 0 ? void 0 : options.subtitle,
+            title: options === null || options === void 0 ? void 0 : options.title,
+        }, updateUser)
+            .then((updateValues) => saveUserValues(updateValues, internalEvents, setShowAuthFlow, setView, resolve, reject))
+            .catch((error) => {
+            if (/email already exists/gi.test(error))
+                throw error;
+            reject(error);
+        });
+    }), [
+        user,
+        projectSettings,
+        promptUserForValues,
+        updateUser,
+        setShowAuthFlow,
+        setView,
+        internalEvents,
+    ]);
+    return updateUserWithModal;
+};
+
+exports.useUpdateUserWithModal = useUpdateUserWithModal;

package/src/lib/utils/hooks/useUserUpdateRequest/useUpdateUserWithModal/useUpdateUserWithModal.d.ts

@@ -0,0 +1,7 @@
+import { UserFields } from '@dynamic-labs/sdk-api';
+import { useUpdateUser } from '../useUpdateUser/';
+import { UpdateUserWithModalFields, UpdateUserWithModalOptions } from './types';
+/** This hook allows to open the widget modal and expose any fields for editing.
+ * The fields must have been previously enabled in the dashboard
+ */
+export declare const useUpdateUserWithModal: (updateUser: ReturnType<typeof useUpdateUser>) => (fields: UpdateUserWithModalFields, options?: UpdateUserWithModalOptions) => Promise<UserFields>;

package/src/lib/utils/hooks/useUserUpdateRequest/useUpdateUserWithModal/useUpdateUserWithModal.js

@@ -0,0 +1,69 @@
+import { __awaiter } from '../../../../../../_virtual/_tslib.js';
+import { useContext, useCallback } from 'react';
+import { DynamicError } from '@dynamic-labs/utils';
+import { useInternalDynamicContext } from '../../../../context/DynamicContext/useInternalDynamicContext.js';
+import { UserFieldEditorContext } from '../../../../context/UserFieldEditorContext/UserFieldEditorContext.js';
+import { useViewContext } from '../../../../context/ViewContext/ViewContext.js';
+import { validateUpdateRequest } from './validateUpdateRequest/validateUpdateRequest.js';
+
+/** Saves the values updated by the user */
+const saveUserValues = ({ fields: newValues, updateUserResult: { isEmailVerificationRequired }, }, internalEvents, setShowAuthFlow, setView, resolve, reject) => __awaiter(void 0, void 0, void 0, function* () {
+    // If no verification is needed, we are done
+    if (!isEmailVerificationRequired) {
+        resolve(newValues);
+        return;
+    }
+    // Show email verification view
+    setShowAuthFlow(true);
+    setView('verify-email');
+    // Subscribe to email verification result
+    internalEvents.current.once('emailVerificationResult', (wasSuccessful) => {
+        wasSuccessful
+            ? resolve(newValues)
+            : reject('Failed to verify email, no fields were updated');
+    });
+});
+// eslint-disable-next-line multiline-comment-style
+/** This hook allows to open the widget modal and expose any fields for editing.
+ * The fields must have been previously enabled in the dashboard
+ */
+const useUpdateUserWithModal = (updateUser) => {
+    const { user, projectSettings, setShowAuthFlow, internalEvents } = useInternalDynamicContext();
+    const { setView } = useViewContext();
+    const editorContext = useContext(UserFieldEditorContext);
+    if (!editorContext)
+        throw new DynamicError('useUserUpdateRequest can only be used inside the context of DynamicContextProvider');
+    const { open: promptUserForValues } = editorContext;
+    const updateUserWithModal = useCallback((fields, options) => new Promise((resolve, reject) => {
+        // Catch invalid requests
+        const errorResponse = validateUpdateRequest(fields, user, projectSettings);
+        if (errorResponse) {
+            reject(errorResponse);
+            return;
+        }
+        // Get user values
+        promptUserForValues({
+            fields,
+            submitText: options === null || options === void 0 ? void 0 : options.submitText,
+            subtitle: options === null || options === void 0 ? void 0 : options.subtitle,
+            title: options === null || options === void 0 ? void 0 : options.title,
+        }, updateUser)
+            .then((updateValues) => saveUserValues(updateValues, internalEvents, setShowAuthFlow, setView, resolve, reject))
+            .catch((error) => {
+            if (/email already exists/gi.test(error))
+                throw error;
+            reject(error);
+        });
+    }), [
+        user,
+        projectSettings,
+        promptUserForValues,
+        updateUser,
+        setShowAuthFlow,
+        setView,
+        internalEvents,
+    ]);
+    return updateUserWithModal;
+};
+
+export { useUpdateUserWithModal };

package/src/lib/utils/hooks/useUserUpdateRequest/useUpdateUserWithModal/validateUpdateRequest/index.d.ts

@@ -0,0 +1 @@
+export * from './validateUpdateRequest';

package/src/lib/utils/hooks/useUserUpdateRequest/useUpdateUserWithModal/validateUpdateRequest/validateUpdateRequest.cjs

@@ -0,0 +1,31 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var getUserProfileFields = require('../../../../functions/getUserProfileFields/getUserProfileFields.cjs');
+
+// eslint-disable-next-line multiline-comment-style
+/** This function is used to verify that an update request with modal is valid
+ * @returns empty string if request is valid, a string with the error message otherwise
+ */
+const validateUpdateRequest = (fields, user, projectSettings) => {
+    // Catch no fields
+    if (!fields.length)
+        return 'At least one field must be provided for editing';
+    // Catch no user
+    if (!user)
+        return 'No signed-in user';
+    // Catch field not set in dashboard
+    const allUserFields = getUserProfileFields.getUserProfileFields({
+        projectSettingsKyc: projectSettings === null || projectSettings === void 0 ? void 0 : projectSettings.kyc,
+        user,
+    });
+    for (const field of fields) {
+        // i.e. If any of the provided fields is not found in the project settings fields
+        if (!allUserFields.find(({ name }) => name === field))
+            return `Please ensure field "${field}" is enabled under "Configurations > Onboarding > Information capture" in your app's dashboard before using it with updateUserWithModal`;
+    }
+    return '';
+};
+
+exports.validateUpdateRequest = validateUpdateRequest;

package/src/lib/utils/hooks/useUserUpdateRequest/useUpdateUserWithModal/validateUpdateRequest/validateUpdateRequest.d.ts

@@ -0,0 +1,6 @@
+import { ProjectSettings, UserFields } from '@dynamic-labs/sdk-api';
+import { UserProfile } from '../../../../../shared';
+/** This function is used to verify that an update request with modal is valid
+ * @returns empty string if request is valid, a string with the error message otherwise
+ */
+export declare const validateUpdateRequest: (fields: (keyof UserFields)[], user: UserProfile | undefined, projectSettings: ProjectSettings | undefined) => string;