@envive-ai/react-hooks 0.2.10 → 0.3.0

package/src/contexts/searchContext/index.ts

@@ -1 +1 @@
-export * from "./searchContext";
+export * from './searchContext';

package/src/contexts/searchContext/searchContext.tsx

@@ -1,31 +1,25 @@
-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 "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";
+} 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 "src/atoms/search/searchServiceAdapter";
+} from 'src/atoms/search/searchServiceAdapter';
 
-const transformProductResponses = (products: SearchResult["products"]) =>
-  products.map((data) => ({
+const transformProductResponses = (products: SearchResult['products']) =>
+  products.map(data => ({
     id: data.id,
     responseId: data.response_id,
     category: ResponseCategory.Product,
@@ -61,19 +55,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();
   }
@@ -89,9 +83,7 @@ interface SearchContextValue {
 
 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();
@@ -106,8 +98,8 @@ export const SearchProvider: React.FC<{ children: React.ReactNode }> = ({
       accessToken: apiKey,
       basePath: baseUrl,
       headers: {
-        "Content-Type": "application/json",
-        Accept: "application/json",
+        'Content-Type': 'application/json',
+        Accept: 'application/json',
       },
     });
     return new SearchApi(config);
@@ -116,7 +108,7 @@ export const SearchProvider: React.FC<{ children: React.ReactNode }> = ({
   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 {
@@ -126,30 +118,26 @@ export const SearchProvider: React.FC<{ children: React.ReactNode }> = ({
           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
@@ -170,18 +158,16 @@ export const SearchProvider: React.FC<{ children: React.ReactNode }> = ({
       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/index.ts

@@ -1 +1 @@
-export * from "./sessionStorageContext";
+export * from './sessionStorageContext';

package/src/contexts/sessionStorageContext/sessionStorageContext.tsx

@@ -1,11 +1,5 @@
-import React, {
-  createContext,
-  useContext,
-  useCallback,
-  useMemo,
-  useEffect,
-} from "react";
-import Logger from "../../application/logging/logger";
+import React, { createContext, useContext, useCallback, useMemo, useEffect } from 'react';
+import Logger from '../../application/logging/logger';
 
 interface SessionStorageContextType {
   setItem: (key: string, value: string) => void;
@@ -13,16 +7,14 @@ interface SessionStorageContextType {
   isAvailable: boolean;
 }
 
-const SessionStorageContext = createContext<SessionStorageContextType | null>(
-  null
-);
+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;
     }
@@ -30,7 +22,7 @@ export const SessionStorageProvider: React.FC<{
 
   useEffect(() => {
     if (!isAvailable) {
-      Logger.logError("sessionStorage is not available", undefined);
+      Logger.logError('sessionStorage is not available', undefined);
     }
   }, [isAvailable]);
 
@@ -38,11 +30,9 @@ 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(
@@ -50,7 +40,7 @@ export const SessionStorageProvider: React.FC<{
       if (!isAvailable) return null;
       return sessionStorage.getItem(key);
     },
-    [isAvailable]
+    [isAvailable],
   );
 
   const value = useMemo(
@@ -59,22 +49,16 @@ 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/index.ts

@@ -1 +1 @@
-export * from "./shopifyUrlContext";
+export * from './shopifyUrlContext';

package/src/contexts/shopifyUrlContext/shopifyUrlContext.tsx

@@ -1,6 +1,6 @@
-import React, { createContext, useCallback, useContext, useMemo } from "react";
-import { IdExtractor } from "src/contexts/types";
-import { parseHref } from "src/application/utils/urlsParser";
+import React, { createContext, useCallback, useContext, useMemo } from 'react';
+import { IdExtractor } from 'src/contexts/types';
+import { parseHref } from 'src/application/utils/urlsParser';
 
 interface ShopifyUrlContextType {
   getTrimmedPathName: () => string | null;
@@ -10,23 +10,19 @@ interface ShopifyUrlContextType {
   isReady: boolean;
 }
 
-const ShopifyUrlContext = createContext<ShopifyUrlContextType | undefined>(
-  undefined
-);
+const ShopifyUrlContext = createContext<ShopifyUrlContextType | undefined>(undefined);
 
-export const ShopifyUrlProvider: React.FC<{ children: React.ReactNode }> = ({
-  children,
-}) => {
+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;
@@ -37,35 +33,34 @@ export const ShopifyUrlProvider: React.FC<{ children: React.ReactNode }> = ({
 
   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 idIndex = tokens?.findIndex((token) => token === pathSegment);
+      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]);
@@ -78,20 +73,16 @@ export const ShopifyUrlProvider: React.FC<{ children: React.ReactNode }> = ({
       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;
 };