@lifi/widget 1.23.1 → 1.25.0

package/stores/routes/useRouteExecutionStore.js

@@ -1,18 +1,20 @@
 import create from 'zustand';
 import { persist } from 'zustand/middleware';
 import { immer } from 'zustand/middleware/immer';
-import { isRouteCompleted, isRouteFailed } from './utils';
+import { hasEnumFlag } from '../../utils';
+import { RouteExecutionStatus } from './types';
+import { isRouteDone, isRouteFailed, isRoutePartiallyDone, isRouteRefunded, } from './utils';
 export const useRouteExecutionStore = create()(persist(immer((set) => ({
     routes: {},
     setExecutableRoute: (route) => set((state) => {
         if (!state.routes[route.id]) {
             // clean previous idle routes that were not executed
             Object.keys(state.routes)
-                .filter((routeId) => { var _a; return ((_a = state.routes[routeId]) === null || _a === void 0 ? void 0 : _a.status) === 'idle'; })
+                .filter((routeId) => { var _a; return ((_a = state.routes[routeId]) === null || _a === void 0 ? void 0 : _a.status) === RouteExecutionStatus.Idle; })
                 .forEach((routeId) => delete state.routes[routeId]);
             state.routes[route.id] = {
                 route,
-                status: 'idle',
+                status: RouteExecutionStatus.Idle,
             };
         }
     }),
@@ -21,22 +23,28 @@ export const useRouteExecutionStore = create()(persist(immer((set) => ({
             state.routes[route.id].route = route;
             const isFailed = isRouteFailed(route);
             if (isFailed) {
-                state.routes[route.id].status = 'error';
+                state.routes[route.id].status = RouteExecutionStatus.Failed;
                 return;
             }
-            const isDone = isRouteCompleted(route);
+            const isDone = isRouteDone(route);
             if (isDone) {
-                state.routes[route.id].status = 'success';
+                state.routes[route.id].status = RouteExecutionStatus.Done;
+                if (isRoutePartiallyDone(route)) {
+                    state.routes[route.id].status |= RouteExecutionStatus.Partial;
+                }
+                else if (isRouteRefunded(route)) {
+                    state.routes[route.id].status |= RouteExecutionStatus.Refunded;
+                }
                 return;
             }
             const isLoading = route.steps.some((step) => step.execution);
             if (isLoading) {
-                state.routes[route.id].status = 'loading';
+                state.routes[route.id].status = RouteExecutionStatus.Pending;
             }
         }
     }),
     restartRoute: (routeId) => set((state) => {
-        state.routes[routeId].status = 'loading';
+        state.routes[routeId].status = RouteExecutionStatus.Pending;
     }),
     deleteRoute: (routeId) => set((state) => {
         if (state.routes[routeId]) {
@@ -46,15 +54,16 @@ export const useRouteExecutionStore = create()(persist(immer((set) => ({
     deleteRoutes: (type) => set((state) => {
         Object.keys(state.routes)
             .filter((routeId) => {
-            var _a, _b;
+            var _a, _b, _c, _d;
             return type === 'completed'
-                ? ((_a = state.routes[routeId]) === null || _a === void 0 ? void 0 : _a.status) === 'success'
-                : ((_b = state.routes[routeId]) === null || _b === void 0 ? void 0 : _b.status) !== 'success';
+                ? hasEnumFlag((_b = (_a = state.routes[routeId]) === null || _a === void 0 ? void 0 : _a.status) !== null && _b !== void 0 ? _b : 0, RouteExecutionStatus.Done)
+                : !hasEnumFlag((_d = (_c = state.routes[routeId]) === null || _c === void 0 ? void 0 : _c.status) !== null && _d !== void 0 ? _d : 0, RouteExecutionStatus.Done);
         })
             .forEach((routeId) => delete state.routes[routeId]);
     }),
 })), {
     name: 'li.fi-widget-routes',
+    version: 1,
     partialize: (state) => ({ routes: state.routes }),
     merge: (persistedState, currentState) => {
         const state = Object.assign(Object.assign({}, currentState), persistedState);
@@ -68,21 +77,21 @@ export const useRouteExecutionStore = create()(persist(immer((set) => ({
                     }
                     state.routes[route.id] = {
                         route,
-                        status: 'idle',
+                        status: RouteExecutionStatus.Idle,
                     };
                     const isFailed = isRouteFailed(route);
                     if (isFailed) {
-                        state.routes[route.id].status = 'error';
+                        state.routes[route.id].status = RouteExecutionStatus.Failed;
                         return;
                     }
-                    const isDone = isRouteCompleted(route);
+                    const isDone = isRouteDone(route);
                     if (isDone) {
-                        state.routes[route.id].status = 'success';
+                        state.routes[route.id].status = RouteExecutionStatus.Done;
                         return;
                     }
                     const isLoading = route.steps.some((step) => step.execution);
                     if (isLoading) {
-                        state.routes[route.id].status = 'loading';
+                        state.routes[route.id].status = RouteExecutionStatus.Pending;
                     }
                 });
             }
@@ -93,4 +102,30 @@ export const useRouteExecutionStore = create()(persist(immer((set) => ({
         }
         return state;
     },
+    migrate: (persistedState, version) => {
+        if (version === 0) {
+            Object.values(persistedState.routes).forEach((route) => {
+                if (route) {
+                    switch (route.status) {
+                        case 'idle':
+                            route.status = RouteExecutionStatus.Idle;
+                            break;
+                        case 'loading':
+                            route.status = RouteExecutionStatus.Pending;
+                            break;
+                        case 'success':
+                        case 'warning':
+                            route.status = RouteExecutionStatus.Done;
+                            break;
+                        case 'error':
+                            route.status = RouteExecutionStatus.Failed;
+                            break;
+                        default:
+                            break;
+                    }
+                }
+            });
+        }
+        return persistedState;
+    },
 }));

package/stores/routes/useSwapHistory.js

@@ -1,8 +1,11 @@
 import shallow from 'zustand/shallow';
+import { hasEnumFlag } from '../../utils';
+import { RouteExecutionStatus } from './types';
 import { useRouteExecutionStore } from './useRouteExecutionStore';
 export const useSwapHistory = (address) => {
     return useRouteExecutionStore((state) => Object.values(state.routes)
-        .filter((item) => (item === null || item === void 0 ? void 0 : item.route.fromAddress) === address && (item === null || item === void 0 ? void 0 : item.status) === 'success')
+        .filter((item) => (item === null || item === void 0 ? void 0 : item.route.fromAddress) === address &&
+        hasEnumFlag(item.status, RouteExecutionStatus.Done))
         .sort((a, b) => {
         var _a, _b, _c, _d;
         return ((_b = (_a = b === null || b === void 0 ? void 0 : b.route.steps[0].execution) === null || _a === void 0 ? void 0 : _a.process[0].startedAt) !== null && _b !== void 0 ? _b : 0) -

package/stores/routes/utils.d.ts

@@ -1,5 +1,7 @@
 import type { Process, Route } from '@lifi/sdk';
-export declare const isRouteCompleted: (route: Route) => boolean;
+export declare const isRouteDone: (route: Route) => boolean;
+export declare const isRoutePartiallyDone: (route: Route) => boolean;
+export declare const isRouteRefunded: (route: Route) => boolean;
 export declare const isRouteFailed: (route: Route) => boolean;
 export declare const isRouteActive: (route?: Route) => boolean;
 export declare const getUpdatedProcess: (currentRoute: Route, updatedRoute: Route) => Process | undefined;

package/stores/routes/utils.js

@@ -1,7 +1,13 @@
 import microdiff from 'microdiff';
-export const isRouteCompleted = (route) => {
+export const isRouteDone = (route) => {
     return route.steps.every((step) => { var _a; return ((_a = step.execution) === null || _a === void 0 ? void 0 : _a.status) === 'DONE'; });
 };
+export const isRoutePartiallyDone = (route) => {
+    return route.steps.some((step) => { var _a; return (_a = step.execution) === null || _a === void 0 ? void 0 : _a.process.some((process) => process.substatus === 'PARTIAL'); });
+};
+export const isRouteRefunded = (route) => {
+    return route.steps.some((step) => { var _a; return (_a = step.execution) === null || _a === void 0 ? void 0 : _a.process.some((process) => process.substatus === 'REFUNDED'); });
+};
 export const isRouteFailed = (route) => {
     return route.steps.some((step) => { var _a; return ((_a = step.execution) === null || _a === void 0 ? void 0 : _a.status) === 'FAILED'; });
 };
@@ -9,7 +15,7 @@ export const isRouteActive = (route) => {
     if (!route) {
         return false;
     }
-    const isDone = isRouteCompleted(route);
+    const isDone = isRouteDone(route);
     const isFailed = isRouteFailed(route);
     const alreadyStarted = route.steps.some((step) => step.execution);
     return !isDone && !isFailed && alreadyStarted;

package/stores/settings/types.d.ts

@@ -1,17 +1,17 @@
 import type { Bridge, Exchange, Order } from '@lifi/sdk';
 import type { Appearance } from '../../types';
-export declare type ValueSetter<S> = <K extends keyof S>(key: K, value: S[Extract<K, string>]) => void;
-export declare type ValuesSetter<S> = <K extends keyof S>(values: Record<K, S[Extract<K, string>]>) => void;
-export declare type SettingsToolType = 'Bridges' | 'Exchanges';
+export type ValueSetter<S> = <K extends keyof S>(key: K, value: S[Extract<K, string>]) => void;
+export type ValuesSetter<S> = <K extends keyof S>(values: Record<K, S[Extract<K, string>]>) => void;
+export type SettingsToolType = 'Bridges' | 'Exchanges';
 export declare const SettingsToolTypes: SettingsToolType[];
 export interface SettingsState {
     advancedPreferences: boolean;
     appearance: Appearance;
-    gasPrice: string;
+    gasPrice?: string;
     language?: string;
-    routePriority: Order;
+    routePriority?: Order;
     showDestinationWallet: boolean;
-    slippage: string;
+    slippage?: string;
     enabledBridges?: string[];
     _enabledBridges?: Record<string, boolean>;
     enabledExchanges?: string[];

package/stores/settings/useSettingsStore.d.ts

@@ -1,5 +1,7 @@
+import type { WidgetConfig } from '../../types';
 import type { SettingsState, SettingsStore } from './types';
-export declare const defaultSettings: Omit<SettingsState, 'enabledBridges' | 'enabledExchanges' | '_enabledBridges' | '_enabledExchanges'>;
+export declare const defaultConfigurableSettings: Pick<SettingsState, 'routePriority' | 'slippage'>;
+export declare const defaultSettings: SettingsState;
 export declare const useSettingsStore: import("zustand").UseBoundStore<Omit<Omit<import("zustand").StoreApi<SettingsStore>, "persist"> & {
     persist: {
         setOptions: (options: Partial<import("zustand/middleware").PersistOptions<SettingsStore, {
@@ -8,12 +10,12 @@ export declare const useSettingsStore: import("zustand").UseBoundStore<Omit<Omit
             initializeTools(toolType: import("./types").SettingsToolType, tools: string[]): void;
             setTools(toolType: import("./types").SettingsToolType, tools: string[], availableTools: (Pick<import("@lifi/types").Bridge, "key"> | Pick<import("@lifi/types").Exchange, "key">)[]): void;
             advancedPreferences: boolean;
-            appearance: import("../..").Appearance;
-            gasPrice: string;
+            appearance: import("../../types").Appearance;
+            gasPrice?: string | undefined;
             language?: string | undefined;
-            routePriority: "RECOMMENDED" | "FASTEST" | "CHEAPEST" | "SAFEST";
+            routePriority?: "RECOMMENDED" | "FASTEST" | "CHEAPEST" | "SAFEST" | undefined;
             showDestinationWallet: boolean;
-            slippage: string;
+            slippage?: string | undefined;
             _enabledBridges?: Record<string, boolean> | undefined;
             _enabledExchanges?: Record<string, boolean> | undefined;
         }>>) => void;
@@ -28,12 +30,12 @@ export declare const useSettingsStore: import("zustand").UseBoundStore<Omit<Omit
             initializeTools(toolType: import("./types").SettingsToolType, tools: string[]): void;
             setTools(toolType: import("./types").SettingsToolType, tools: string[], availableTools: (Pick<import("@lifi/types").Bridge, "key"> | Pick<import("@lifi/types").Exchange, "key">)[]): void;
             advancedPreferences: boolean;
-            appearance: import("../..").Appearance;
-            gasPrice: string;
+            appearance: import("../../types").Appearance;
+            gasPrice?: string | undefined;
             language?: string | undefined;
-            routePriority: "RECOMMENDED" | "FASTEST" | "CHEAPEST" | "SAFEST";
+            routePriority?: "RECOMMENDED" | "FASTEST" | "CHEAPEST" | "SAFEST" | undefined;
             showDestinationWallet: boolean;
-            slippage: string;
+            slippage?: string | undefined;
             _enabledBridges?: Record<string, boolean> | undefined;
             _enabledExchanges?: Record<string, boolean> | undefined;
         }>>;
@@ -41,3 +43,4 @@ export declare const useSettingsStore: import("zustand").UseBoundStore<Omit<Omit
 }, "setState"> & {
     setState(nextStateOrUpdater: SettingsStore | Partial<SettingsStore> | ((state: import("immer/dist/internal").WritableDraft<SettingsStore>) => void), shouldReplace?: boolean | undefined): void;
 }>;
+export declare const setDefaultSettings: (config?: WidgetConfig) => void;

package/stores/settings/useSettingsStore.js

@@ -14,11 +14,13 @@ import create from 'zustand';
 import { persist } from 'zustand/middleware';
 import { immer } from 'zustand/middleware/immer';
 import { SettingsToolTypes } from './types';
+export const defaultConfigurableSettings = {
+    routePriority: 'RECOMMENDED',
+    slippage: '0.5',
+};
 export const defaultSettings = {
     appearance: 'auto',
     gasPrice: 'normal',
-    routePriority: 'RECOMMENDED',
-    slippage: '0.5',
     advancedPreferences: false,
     showDestinationWallet: true,
 };
@@ -78,11 +80,25 @@ export const useSettingsStore = create()(persist(immer((set) => (Object.assign(O
     },
     migrate: (persistedState, version) => {
         if (version === 0 && persistedState.appearance === 'system') {
-            persistedState.appearance = 'auto';
+            persistedState.appearance = defaultSettings.appearance;
         }
         if (version === 1) {
-            persistedState.slippage = '0.5';
+            persistedState.slippage = defaultConfigurableSettings.slippage;
         }
         return persistedState;
     },
 }));
+export const setDefaultSettings = (config) => {
+    var _a, _b, _c, _d, _e;
+    const { slippage, routePriority, setValue } = useSettingsStore.getState();
+    const defaultSlippage = ((config === null || config === void 0 ? void 0 : config.slippage) ||
+        ((_b = (_a = config === null || config === void 0 ? void 0 : config.sdkConfig) === null || _a === void 0 ? void 0 : _a.defaultRouteOptions) === null || _b === void 0 ? void 0 : _b.slippage) ||
+        0) * 100;
+    const defaultRoutePriority = (config === null || config === void 0 ? void 0 : config.routePriority) || ((_d = (_c = config === null || config === void 0 ? void 0 : config.sdkConfig) === null || _c === void 0 ? void 0 : _c.defaultRouteOptions) === null || _d === void 0 ? void 0 : _d.order);
+    if (!slippage) {
+        setValue('slippage', (_e = (defaultSlippage || defaultConfigurableSettings.slippage)) === null || _e === void 0 ? void 0 : _e.toString());
+    }
+    if (!routePriority) {
+        setValue('routePriority', defaultRoutePriority || defaultConfigurableSettings.routePriority);
+    }
+};