@faststore/core 2.2.0-alpha.2 → 2.2.0-alpha.4

package/src/sdk/product/useProductGalleryQuery.ts

@@ -1,17 +1,26 @@
+import { sendAnalyticsEvent } from '@faststore/sdk'
 import { gql } from '@faststore/graphql-utils'
 
+import { useQuery } from 'src/sdk/graphql/useQuery'
+import { useLocalizedVariables } from './useLocalizedVariables'
+import { useSession } from 'src/sdk/session'
+
 import type {
   ClientProductGalleryQueryQuery as Query,
   ClientProductGalleryQueryQueryVariables as Variables,
 } from '@generated/graphql'
-import { useQuery } from 'src/sdk/graphql/useQuery'
-import { useLocalizedVariables } from './useLocalizedVariables'
+import type { IntelligentSearchQueryEvent } from 'src/sdk/analytics/types'
 
 /**
  * This query is run on the browser and contains
  * the current search state of the user
  */
 export const query = gql`
+  fragment SearchEvent_metadata on SearchMetadata {
+    isTermMisspelled
+    logicalOperator
+  }
+
   query ClientProductGalleryQuery(
     $first: Int!
     $after: String!
@@ -35,6 +44,9 @@ export const query = gql`
       facets {
         ...Filter_facets
       }
+      metadata {
+        ...SearchEvent_metadata
+      }
     }
   }
 `
@@ -45,6 +57,7 @@ export const useProductGalleryQuery = ({
   selectedFacets,
   itemsPerPage,
 }) => {
+  const { locale } = useSession()
   const localizedVariables = useLocalizedVariables({
     first: itemsPerPage,
     after: '0',
@@ -53,5 +66,21 @@ export const useProductGalleryQuery = ({
     selectedFacets,
   })
 
-  return useQuery<Query, Variables>(query, localizedVariables)
+  return useQuery<Query, Variables>(query, localizedVariables, {
+    onSuccess: (data) => {
+      if (data && term) {
+        sendAnalyticsEvent<IntelligentSearchQueryEvent>({
+          name: 'intelligent_search_query',
+          params: {
+            locale,
+            term,
+            url: window.location.href,
+            logicalOperator: data.search.metadata?.logicalOperator ?? 'and',
+            isTermMisspelled: data.search.metadata?.isTermMisspelled ?? false,
+            totalCount: data.search.products.pageInfo.totalCount,
+          },
+        })
+      }
+    },
+  })
 }

package/src/sdk/search/useSuggestions.ts

@@ -1,10 +1,14 @@
-import { gql } from '@faststore/graphql-utils'
+import { useMemo } from 'react'
 
+import { sendAnalyticsEvent } from '@faststore/sdk'
+import { gql } from '@faststore/graphql-utils'
 import { useQuery } from 'src/sdk/graphql/useQuery'
+
 import type {
   SearchSuggestionsQueryQuery as Query,
   SearchSuggestionsQueryQueryVariables as Variables,
 } from '@generated/graphql'
+import type { IntelligentSearchQueryEvent } from '../analytics/types'
 
 import { useSession } from '../session'
 
@@ -24,6 +28,14 @@ const query = gql`
           ...ProductSummary_product
         }
       }
+      products {
+        pageInfo {
+          totalCount
+        }
+      }
+      metadata {
+        ...SearchEvent_metadata
+      }
     }
   }
 `
@@ -31,12 +43,34 @@ const query = gql`
 function useSuggestions(term: string, limit: number = MAX_SUGGESTIONS) {
   const { channel, locale } = useSession()
 
-  const { data, error } = useQuery<Query, Variables>(query, {
-    term,
-    selectedFacets: [
-      { key: 'channel', value: channel ?? '' },
-      { key: 'locale', value: locale },
-    ],
+  const variables = useMemo(
+    () => ({
+      term,
+      selectedFacets: [
+        { key: 'channel', value: channel ?? '' },
+        { key: 'locale', value: locale },
+      ],
+    }),
+    [term, locale, channel]
+  )
+  const { data, error } = useQuery<Query, Variables>(query, variables, {
+    onSuccess: (callbackData) => {
+      if (callbackData && term) {
+        sendAnalyticsEvent<IntelligentSearchQueryEvent>({
+          name: 'intelligent_search_query',
+          params: {
+            locale,
+            term,
+            url: window.location.href,
+            logicalOperator:
+              callbackData.search.metadata?.logicalOperator ?? 'and',
+            isTermMisspelled:
+              callbackData.search.metadata?.isTermMisspelled ?? false,
+            totalCount: callbackData.search.products.pageInfo.totalCount,
+          },
+        })
+      }
+    },
   })
 
   return {

package/src/server/generator/schema.ts

@@ -1,3 +1,4 @@
+import path from 'path'
 import { writeFileSync } from 'fs-extra'
 import { getSchema, getTypeDefs } from '@faststore/api'
 import { printSchemaWithDirectives } from '@graphql-tools/utils'
@@ -69,7 +70,7 @@ export const getMergedSchema = (): GraphQLSchema =>
 export function writeGraphqlSchemaFile(apiSchema: GraphQLSchema) {
   try {
     writeFileSync(
-      [process.cwd(), '@generated', 'graphql', 'schema.graphql'].join('/'),
+      path.join(process.cwd(), '@generated', 'graphql', 'schema.graphql'),
       printSchemaWithDirectives(apiSchema)
     )
 

package/src/typings/overrides.ts

@@ -13,7 +13,7 @@ import type {
   IconButtonProps,
   IconProps,
   ImageGalleryProps,
-  ImageZoomProps,
+  ImageGalleryViewerProps,
   InputFieldProps,
   LinkButtonProps,
   NavbarButtonsProps,
@@ -197,7 +197,10 @@ export type ProductDetailsOverrideDefinition = SectionOverrideDefinition<
       ImageGalleryProps,
       ImageGalleryProps
     >
-    ImageZoom: ComponentOverrideDefinition<ImageZoomProps, ImageZoomProps>
+    ImageGalleryViewer: ComponentOverrideDefinition<
+      ImageGalleryViewerProps,
+      ImageGalleryViewerProps
+    >
     __experimentalImageGalleryImage: ComponentOverrideDefinition<any, any>
     __experimentalImageGallery: ComponentOverrideDefinition<any, any>
     __experimentalShippingSimulation: ComponentOverrideDefinition<any, any>

package/generate.sh

@@ -1,71 +0,0 @@
-#!/bin/sh
-
-# ANSI color codes
-RED='\033[0;31m'
-YELLOW='\033[1;33m'
-PURPLE='\033[0;35m'
-GREEN='\033[0;32m'
-NC='\033[0m' # No Color
-
-# Initialize debug flag to false
-DEBUG_FLAG=false
-
-# Check for --debug flag
-if [ "$1" = "--debug" ]; then
-    DEBUG_FLAG=true
-fi
-
-# Function to display errors with readable messages
-show_error() {
-    local cmd="$3"
-
-    echo "${RED}error${NC} $1"
-    if [ "$DEBUG_FLAG" = "true" ]; then
-        echo "${PURPLE}DEBUG - \$ $cmd ${RED}error root ↓${NC}\n$2"
-    fi
-    exit 1
-}
-
-# Function to display warnings
-show_warning() {
-    local cmd="$3"
-
-    echo "${YELLOW}warn${NC} $1"
-    if [ "$DEBUG_FLAG" = "true" ]; then
-        echo "${PURPLE}DEBUG - \$ $cmd ${YELLOW}warn root ↓${NC}\n$2"
-    fi
-}
-
-# Function to run a command and handle errors and warnings
-run_command() {
-    local cmd="$1"
-    local error_message="$2"
-    local warn="$3"
-    local output
-
-    if [ "$DEBUG_FLAG" = "true" ]; then
-        output="$($cmd --debug --verbose 2>&1)"
-    else
-        output="$($cmd 2>&1)"
-    fi
-
-    local exit_code="$?"
-    if [ "$warn" = "true" ]; then
-        if [ "$exit_code" -ne 0 ]; then
-            show_warning "$error_message" "$output" "$cmd"
-        fi
-    elif [ "$exit_code" -ne 0 ]; then
-        show_error "$error_message" "$output" "$cmd"
-    fi
-}
-
-# Run "yarn generate:schema" without outputting logs and errors
-run_command "yarn generate:schema" "Failed to run 'yarn generate:schema'. Please check your setup." "false"
-
-# Run "yarn graphql-codegen" and capture the output
-run_command "yarn graphql-codegen" "GraphQL was not optimized and TS files were not updated. Changes in the GraphQL layer did not take effect" "false"
-
-# Run "yarn format:generated" and display a warning if it produces output
-run_command "yarn format:generated" "Failed to format generated files. 'yarn format:generated' thrown errors" "true"
-
-echo "${GREEN}GraphQL schema, types, and optimizations successfully generated 🎉${NC}"