@envive-ai/react-hooks 0.2.6-alpha-arthur-1 → 0.2.6-alpha.11

package/src/contexts/searchContext/searchContext.tsx

@@ -1,23 +1,30 @@
-import React, { createContext, useContext, useCallback, useMemo, useEffect } from 'react';
-import { useAtomValue } from 'jotai';
+import React, {
+  createContext,
+  useContext,
+  useCallback,
+  useMemo,
+  useEffect,
+} from "react";
+import { useAtomValue } from "jotai";
 import {
   Configuration,
   ResponseCategory,
   ResponseError,
   SearchApi,
-} from '@spiffy-ai/commerce-api-client';
-import { baseUrlAtom } from '../../atoms/envive/enviveConfig';
-import Logger from '../../application/logging/logger';
-import { SessionRestartRequired, UnsupportedProductException } from '../../exceptions';
-import { useAppDetails } from '../../hooks/AppDetails/useAppDetails';
-import { useEnviveConfig } from '../../contexts/enviveConfigContext/enviveConfigContext';
+} from "@spiffy-ai/commerce-api-client";
+import { baseUrlAtom } from "src/atoms/envive/enviveConfig";
+import Logger from "src/application/logging/logger";
+import { useAppDetails } from "src/hooks/AppDetails/useAppDetails";
+import { useEnviveConfig } from "src/contexts/enviveConfigContext/enviveConfigContext";
+import { SessionRestartRequired } from "src/types/exceptions/sessionExceptions";
+import { UnsupportedProductException } from "src/types/exceptions/unsupportedProductExceptions";
+import { SearchParams, SearchResult } from "src/application/models/api/search";
 import {
   clearSearchServiceFunction,
   setSearchServiceFunction,
-} from '../../atoms/search/searchServiceAdapter';
-import { SearchContextValue, SearchParams, SearchResult } from '@envive-ai/types';
+} from "src/atoms/search/searchServiceAdapter";
 
-const transformProductResponses = (products: SearchResult['products']) =>
+const transformProductResponses = (products: SearchResult["products"]) =>
   products.map((data) => ({
     id: data.id,
     responseId: data.response_id,
@@ -54,19 +61,19 @@ async function throwSessionRestartRequiredIf(errorMsg: string, error: unknown) {
 
   const errorResponse = await errorResponseBody(error);
   if (
-    errorResponse?.message?.toLowerCase() === 'unsupported product' ||
-    errorResponse?.app_code?.toUpperCase() === 'PRODUCT_NOT_FOUND'
+    errorResponse?.message?.toLowerCase() === "unsupported product" ||
+    errorResponse?.app_code?.toUpperCase() === "PRODUCT_NOT_FOUND"
   ) {
     throw new UnsupportedProductException();
   } else if (
-    errorResponse?.app_code?.toUpperCase() === 'RESTART_SESSION' ||
-    errorResponse?.sub_code?.toUpperCase() === 'NOT_FOUND'
+    errorResponse?.app_code?.toUpperCase() === "RESTART_SESSION" ||
+    errorResponse?.sub_code?.toUpperCase() === "NOT_FOUND"
   ) {
     Logger.logInfo(
-      'Session does not exist. Re-start session',
+      "Session does not exist. Re-start session",
       error,
       error.response,
-      errorResponse,
+      errorResponse
     );
     throw new SessionRestartRequired();
   }
@@ -75,9 +82,16 @@ async function throwSessionRestartRequiredIf(errorMsg: string, error: unknown) {
   throw error;
 }
 
+interface SearchContextValue {
+  searchProducts: (params: SearchParams) => Promise<SearchResult>;
+  isReady: boolean;
+}
+
 const SearchContext = createContext<SearchContextValue | undefined>(undefined);
 
-export const SearchProvider: React.FC<{ children: React.ReactNode }> = ({ children }) => {
+export const SearchProvider: React.FC<{ children: React.ReactNode }> = ({
+  children,
+}) => {
   const { orgLevelApiKey, publicKey } = useEnviveConfig();
   const apiKey = orgLevelApiKey || publicKey; // Replicate apiKeyAtom logic
   const appDetails = useAppDetails();
@@ -92,8 +106,8 @@ export const SearchProvider: React.FC<{ children: React.ReactNode }> = ({ childr
       accessToken: apiKey,
       basePath: baseUrl,
       headers: {
-        'Content-Type': 'application/json',
-        Accept: 'application/json',
+        "Content-Type": "application/json",
+        Accept: "application/json",
       },
     });
     return new SearchApi(config);
@@ -102,7 +116,7 @@ export const SearchProvider: React.FC<{ children: React.ReactNode }> = ({ childr
   const searchProducts = useCallback(
     async (params: SearchParams): Promise<SearchResult> => {
       if (!isReady || !searchApi) {
-        throw new Error('SearchService not ready - missing dependencies');
+        throw new Error("SearchService not ready - missing dependencies");
       }
 
       try {
@@ -112,26 +126,30 @@ export const SearchProvider: React.FC<{ children: React.ReactNode }> = ({ childr
           org_id: appDetails.orgId,
           user_id: appDetails.userId,
         });
-        const { products, filters, search_response_id: searchResponseId } = response;
+        const {
+          products,
+          filters,
+          search_response_id: searchResponseId,
+        } = response;
 
         return {
           products: transformProductResponses(products) || [],
           filters: filters || [],
           totalProductCount: products?.length || 0,
-          searchResponseId: searchResponseId || '',
+          searchResponseId: searchResponseId || "",
         };
       } catch (error) {
-        await throwSessionRestartRequiredIf('Failed to search products', error);
+        await throwSessionRestartRequiredIf("Failed to search products", error);
         // This part will not be reached if an exception is thrown, but it's required for type safety
         return {
           products: [],
           filters: [],
           totalProductCount: 0,
-          searchResponseId: '',
+          searchResponseId: "",
         };
       }
     },
-    [searchApi, isReady, appDetails],
+    [searchApi, isReady, appDetails]
   );
 
   // Register the search function with the adapter for use in atoms
@@ -152,16 +170,18 @@ export const SearchProvider: React.FC<{ children: React.ReactNode }> = ({ childr
       searchProducts,
       isReady,
     }),
-    [searchProducts, isReady],
+    [searchProducts, isReady]
   );
 
-  return <SearchContext.Provider value={value}>{children}</SearchContext.Provider>;
+  return (
+    <SearchContext.Provider value={value}>{children}</SearchContext.Provider>
+  );
 };
 
 export const useSearchService = () => {
   const context = useContext(SearchContext);
   if (!context) {
-    throw new Error('useSearchService must be used within a SearchProvider');
+    throw new Error("useSearchService must be used within a SearchProvider");
   }
   return context;
 };

package/src/contexts/sessionStorageContext/sessionStorageContext.tsx

@@ -1,15 +1,28 @@
-import React, { createContext, useContext, useCallback, useMemo, useEffect } from 'react';
-import Logger from '../../application/logging/logger';
-import { SessionStorageContextType } from '@envive-ai/types';
+import React, {
+  createContext,
+  useContext,
+  useCallback,
+  useMemo,
+  useEffect,
+} from "react";
+import Logger from "../../application/logging/logger";
 
-const SessionStorageContext = createContext<SessionStorageContextType | null>(null);
+interface SessionStorageContextType {
+  setItem: (key: string, value: string) => void;
+  getItem: (key: string) => string | null;
+  isAvailable: boolean;
+}
+
+const SessionStorageContext = createContext<SessionStorageContextType | null>(
+  null
+);
 
 export const SessionStorageProvider: React.FC<{
   children: React.ReactNode;
 }> = ({ children }) => {
   const isAvailable = useMemo(() => {
     try {
-      return typeof window !== 'undefined' && !!window.sessionStorage;
+      return typeof window !== "undefined" && !!window.sessionStorage;
     } catch {
       return false;
     }
@@ -17,7 +30,7 @@ export const SessionStorageProvider: React.FC<{
 
   useEffect(() => {
     if (!isAvailable) {
-      Logger.logError('sessionStorage is not available', undefined);
+      Logger.logError("sessionStorage is not available", undefined);
     }
   }, [isAvailable]);
 
@@ -25,9 +38,11 @@ export const SessionStorageProvider: React.FC<{
     (key: string, value: string) => {
       if (!isAvailable) return;
       sessionStorage.setItem(key, value);
-      window.dispatchEvent(new StorageEvent('storage', { key, newValue: value }));
+      window.dispatchEvent(
+        new StorageEvent("storage", { key, newValue: value })
+      );
     },
-    [isAvailable],
+    [isAvailable]
   );
 
   const getItem = useCallback(
@@ -35,7 +50,7 @@ export const SessionStorageProvider: React.FC<{
       if (!isAvailable) return null;
       return sessionStorage.getItem(key);
     },
-    [isAvailable],
+    [isAvailable]
   );
 
   const value = useMemo(
@@ -44,16 +59,22 @@ export const SessionStorageProvider: React.FC<{
       getItem,
       isAvailable,
     }),
-    [setItem, getItem, isAvailable],
+    [setItem, getItem, isAvailable]
   );
 
-  return <SessionStorageContext.Provider value={value}>{children}</SessionStorageContext.Provider>;
+  return (
+    <SessionStorageContext.Provider value={value}>
+      {children}
+    </SessionStorageContext.Provider>
+  );
 };
 
 export const useSessionStorage = () => {
   const context = useContext(SessionStorageContext);
   if (!context) {
-    throw new Error('useSessionStorage must be used within a SessionStorageProvider');
+    throw new Error(
+      "useSessionStorage must be used within a SessionStorageProvider"
+    );
   }
   return context;
 };

package/src/contexts/shopifyUrlContext/shopifyUrlContext.tsx

@@ -1,20 +1,32 @@
-import React, { createContext, useCallback, useContext, useMemo } from 'react';
-import { parseHref } from '../../application/utils/urlsParser';
-import { IdExtractor, ShopifyUrlContextType } from '@envive-ai/types';
+import React, { createContext, useCallback, useContext, useMemo } from "react";
+import { IdExtractor } from "src/contexts/types";
+import { parseHref } from "src/application/utils/urlsParser";
 
-const ShopifyUrlContext = createContext<ShopifyUrlContextType | undefined>(undefined);
+interface ShopifyUrlContextType {
+  getTrimmedPathName: () => string | null;
+  getPlpOrPdpId: (extractor: IdExtractor) => string | null;
+  isOnPdpPage: () => boolean;
+  isOnPlpPage: () => boolean;
+  isReady: boolean;
+}
 
-export const ShopifyUrlProvider: React.FC<{ children: React.ReactNode }> = ({ children }) => {
+const ShopifyUrlContext = createContext<ShopifyUrlContextType | undefined>(
+  undefined
+);
+
+export const ShopifyUrlProvider: React.FC<{ children: React.ReactNode }> = ({
+  children,
+}) => {
   const isReady = true; // No external dependencies, so always ready
 
   const getTrimmedPathName = useCallback((): string | null => {
     let { pathname } = window.location;
     // strip out the proxy path so local dev still works
-    pathname = pathname.replace('/proxy', '');
+    pathname = pathname.replace("/proxy", "");
     // remove trailing hash if it exists
-    pathname = pathname.replace(/#.*$/, '');
+    pathname = pathname.replace(/#.*$/, "");
     // remove trailing /, ie. some URLs can end with '/' like /collections/cast-iron/
-    pathname = pathname.replace(/\/$/, '');
+    pathname = pathname.replace(/\/$/, "");
 
     if (pathname === undefined || pathname === null || pathname.length === 0) {
       return null;
@@ -25,34 +37,35 @@ export const ShopifyUrlProvider: React.FC<{ children: React.ReactNode }> = ({ ch
 
   const getPlpOrPdpId = useCallback(
     (extractor: IdExtractor): string | null => {
-      if (extractor === 'shopify-product-variant-id') {
+      if (extractor === "shopify-product-variant-id") {
         const parsedHref = parseHref(window.location.href);
-        const variantId = parsedHref?.urlSearchParams?.get('variant');
+        const variantId = parsedHref?.urlSearchParams?.get("variant");
         if (!variantId) {
-          return getPlpOrPdpId('shopify-product-id');
+          return getPlpOrPdpId("shopify-product-id");
         }
         return variantId;
       }
 
-      const pathSegment = extractor === 'shopify-product-id' ? 'products' : 'collections';
-      const tokens = getTrimmedPathName()?.split('/');
+      const pathSegment =
+        extractor === "shopify-product-id" ? "products" : "collections";
+      const tokens = getTrimmedPathName()?.split("/");
       const idIndex = tokens?.findIndex((token) => token === pathSegment);
       if (idIndex !== undefined && idIndex >= 0 && tokens) {
         return decodeURIComponent(tokens[idIndex + 1]);
       }
       return null;
     },
-    [getTrimmedPathName],
+    [getTrimmedPathName]
   );
 
   const isOnPdpPage = useCallback((): boolean => {
-    return getTrimmedPathName()?.includes('/products') ?? false;
+    return getTrimmedPathName()?.includes("/products") ?? false;
   }, [getTrimmedPathName]);
 
   const isOnPlpPage = useCallback((): boolean => {
     return (
-      (getTrimmedPathName()?.includes('/collections') &&
-        !getTrimmedPathName()?.includes('/products')) ??
+      (getTrimmedPathName()?.includes("/collections") &&
+        !getTrimmedPathName()?.includes("/products")) ??
       false
     );
   }, [getTrimmedPathName]);
@@ -65,16 +78,20 @@ export const ShopifyUrlProvider: React.FC<{ children: React.ReactNode }> = ({ ch
       isOnPlpPage,
       isReady,
     }),
-    [getTrimmedPathName, getPlpOrPdpId, isOnPdpPage, isOnPlpPage, isReady],
+    [getTrimmedPathName, getPlpOrPdpId, isOnPdpPage, isOnPlpPage, isReady]
   );
 
-  return <ShopifyUrlContext.Provider value={value}>{children}</ShopifyUrlContext.Provider>;
+  return (
+    <ShopifyUrlContext.Provider value={value}>
+      {children}
+    </ShopifyUrlContext.Provider>
+  );
 };
 
 export const useShopifyUrl = () => {
   const context = useContext(ShopifyUrlContext);
   if (!context) {
-    throw new Error('useShopifyUrl must be used within a ShopifyUrlProvider');
+    throw new Error("useShopifyUrl must be used within a ShopifyUrlProvider");
   }
   return context;
 };

package/src/contexts/systemSettingsContext/systemSettingsContext.tsx

@@ -1,7 +1,14 @@
-import { GenerationParams } from '@envive-ai/types';
-import { useAtomValue } from 'jotai';
-import { Dispatch, ReactNode, SetStateAction, createContext, useMemo, useState } from 'react';
-import { baseUrlAtom } from 'src/atoms/envive/enviveConfig';
+import { useAtomValue } from "jotai";
+import {
+  Dispatch,
+  ReactNode,
+  SetStateAction,
+  createContext,
+  useMemo,
+  useState,
+} from "react";
+import { GenerationParams } from "src/application/models";
+import { baseUrlAtom } from "src/atoms/envive/enviveConfig";
 
 // TODO: Refactor this to a common service that handles query params (and spiffy variables all together)
 const getChatModelName = () => {
@@ -30,7 +37,9 @@ interface SystemSettingsContextProviderProps {
   showDebugBar?: boolean;
 }
 
-const SystemSettingsContext = createContext<SystemSettingsContextParams | undefined>(undefined);
+const SystemSettingsContext = createContext<
+  SystemSettingsContextParams | undefined
+>(undefined);
 
 const SystemSettingsContextProvider = ({
   children,
@@ -38,7 +47,7 @@ const SystemSettingsContextProvider = ({
   showDebugBar,
 }: SystemSettingsContextProviderProps) => {
   const [params, setParams] = useState<GenerationParams | undefined>(
-    () => generationParams ?? defaultGenerationParams,
+    () => generationParams ?? defaultGenerationParams
   );
   const endpointURL = useAtomValue(baseUrlAtom);
   const settingsContextValues = useMemo(
@@ -48,7 +57,7 @@ const SystemSettingsContextProvider = ({
       setGenerationParams: setParams,
       endpointURL,
     }),
-    [generationParams, endpointURL, showDebugBar],
+    [generationParams, endpointURL, showDebugBar]
   );
 
   return (
@@ -58,4 +67,8 @@ const SystemSettingsContextProvider = ({
   );
 };
 
-export { SystemSettingsContextProvider, SystemSettingsContext, defaultGenerationParams };
+export {
+  SystemSettingsContextProvider,
+  SystemSettingsContext,
+  defaultGenerationParams,
+};