@graphcommerce/algolia-categories 9.1.0-canary.28 → 9.1.0-canary.31

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @graphcommerce/algolia-categories
 
+## 9.1.0-canary.31
+
+## 9.1.0-canary.30
+
+## 9.1.0-canary.29
+
+### Minor Changes
+
+- [#2525](https://github.com/graphcommerce-org/graphcommerce/pull/2525) [`f9176ad`](https://github.com/graphcommerce-org/graphcommerce/commit/f9176adf3bf643ac00c865fc173a80056d8b8170) - Search Categories through algolia ([@paales](https://github.com/paales))
+
+### Patch Changes
+
+- [#2525](https://github.com/graphcommerce-org/graphcommerce/pull/2525) [`c9ac114`](https://github.com/graphcommerce-org/graphcommerce/commit/c9ac1142cb92394eb32dc4a6d3944a1707b1b4e2) - Allow returning the algolia index name that is being searched ([@paales](https://github.com/paales))
+
 ## 9.1.0-canary.28
 
 ## 9.1.0-canary.27

package/graphql/fragments/AlgoliaCategorySearch.graphql

@@ -0,0 +1,4 @@
+fragment AlgoliaCategorySearch on CategoryResult @inject(into: ["CategorySearchFragment"]) {
+  algolia_queryID
+  algolia_indexName
+}

package/mesh/algoliaHitToMagentoCategory.ts

@@ -1,5 +1,4 @@
-import { algoliaUrlToUrlKey } from '@graphcommerce/algolia-products/mesh/algoliaHitToMagentoProduct'
-import type { GetStoreConfigReturn } from '@graphcommerce/algolia-products/mesh/getStoreConfig'
+import { algoliaUrlToUrlKey } from '@graphcommerce/algolia-products'
 import type {
   Algoliahit,
   AlgoliaProductHitAdditionalProperties,
@@ -39,18 +38,16 @@ export type CategoriesItemsItem = NonNullable<
   >['items']
 >[number]
 
-function mapBreadcrumbs(algoliaPath) {
-  const pathArray = algoliaPath.split(' / ')
+function mapBreadcrumbs(algoliaPath: string) {
+  // Remove the last item from the path, because it's the category itself
+  const pathArray = algoliaPath.split(' / ').slice(0, -1)
   return pathArray.map((item) => ({
     category_name: item,
-    category_uid: 0,
+    category_uid: '0',
   }))
 }
 
-export function algoliaHitToMagentoCategory(
-  hit: Algoliahit,
-  storeConfig: GetStoreConfigReturn,
-): CategoriesItemsItem {
+export function algoliaHitToMagentoCategory(hit: Algoliahit): CategoriesItemsItem {
   const { objectID, additionalProperties } = hit
 
   if (!assertAdditional(additionalProperties)) return null
@@ -62,7 +59,7 @@ export function algoliaHitToMagentoCategory(
     uid: objectID,
     redirect_code: 0,
     url_key: '',
-    url_path: algoliaUrlToUrlKey(additionalProperties.url, storeConfig?.base_link_url),
+    url_path: algoliaUrlToUrlKey(additionalProperties.url),
     breadcrumbs: mapBreadcrumbs(additionalProperties?.path),
     product_count: additionalProperties?.product_count,
     meta_description: additionalProperties?.meta_description,

package/mesh/resolvers.ts

@@ -1,8 +1,13 @@
-import { getStoreConfig } from '@graphcommerce/algolia-products/mesh/getStoreConfig'
+import { nonNullable } from '@graphcommerce/algolia-products'
 import { type Resolvers } from '@graphcommerce/graphql-mesh'
-import type { CategoriesItemsItem } from './algoliaHitToMagentoCategory'
+import type { GraphQLError } from 'graphql'
 import { algoliaHitToMagentoCategory } from './algoliaHitToMagentoCategory'
 import { getCategoryResults } from './getCategoryResults'
+import { getIndexName } from './getIndexName'
+
+function isGraphQLError(err: unknown): err is GraphQLError {
+  return !!(err as GraphQLError)?.message
+}
 
 export const resolvers: Resolvers = {
   Query: {
@@ -11,29 +16,21 @@ export const resolvers: Resolvers = {
 
       if (!isAgolia) return context.m2.Query.categories({ root, args, context, info })
 
-      const items: (CategoriesItemsItem | null)[] = []
+      const searchResults = await getCategoryResults(args, context, info)
 
-      const [algoliaResponse, storeConfig] = await Promise.all([
-        getCategoryResults(args, context, info),
-        getStoreConfig(context),
-      ])
-
-      if (!algoliaResponse?.hits) return context.m2.Query.categories({ root, args, context, info })
-      for (const hit of algoliaResponse.hits) {
-        if (hit?.objectID) {
-          const category = algoliaHitToMagentoCategory(hit, storeConfig)
-          items.push(category)
-        }
-      }
+      if (isGraphQLError(searchResults))
+        return context.m2.Query.categories({ root, args, context, info })
 
       return {
-        items,
+        items: (searchResults?.hits ?? []).filter(nonNullable).map(algoliaHitToMagentoCategory),
         page_info: {
-          current_page: algoliaResponse.page + 1,
-          page_size: algoliaResponse.hitsPerPage,
-          total_pages: algoliaResponse.nbPages,
+          current_page: (searchResults?.page ?? 0) + 1,
+          page_size: searchResults?.hitsPerPage,
+          total_pages: searchResults?.nbPages,
         },
-        total_count: algoliaResponse.nbHits,
+        total_count: searchResults?.nbHits,
+        algolia_queryID: searchResults?.queryID,
+        algolia_indexName: getIndexName(context),
       }
     },
   },

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graphcommerce/algolia-categories",
   "homepage": "https://www.graphcommerce.org/",
   "repository": "github:graphcommerce-org/graphcommerce",
-  "version": "9.1.0-canary.28",
+  "version": "9.1.0-canary.31",
   "sideEffects": false,
   "prettier": "@graphcommerce/prettier-config-pwa",
   "eslintConfig": {
@@ -15,15 +15,15 @@
     "generate": "tsx scripts/generate-spec.mts"
   },
   "peerDependencies": {
-    "@graphcommerce/algolia-products": "^9.1.0-canary.28",
-    "@graphcommerce/google-datalayer": "^9.1.0-canary.28",
-    "@graphcommerce/graphql": "^9.1.0-canary.28",
-    "@graphcommerce/graphql-mesh": "^9.1.0-canary.28",
-    "@graphcommerce/magento-customer": "^9.1.0-canary.28",
-    "@graphcommerce/magento-product": "^9.1.0-canary.28",
-    "@graphcommerce/magento-search": "^9.1.0-canary.28",
-    "@graphcommerce/next-config": "^9.1.0-canary.28",
-    "@graphcommerce/next-ui": "^9.1.0-canary.28",
+    "@graphcommerce/algolia-products": "^9.1.0-canary.31",
+    "@graphcommerce/google-datalayer": "^9.1.0-canary.31",
+    "@graphcommerce/graphql": "^9.1.0-canary.31",
+    "@graphcommerce/graphql-mesh": "^9.1.0-canary.31",
+    "@graphcommerce/magento-customer": "^9.1.0-canary.31",
+    "@graphcommerce/magento-product": "^9.1.0-canary.31",
+    "@graphcommerce/magento-search": "^9.1.0-canary.31",
+    "@graphcommerce/next-config": "^9.1.0-canary.31",
+    "@graphcommerce/next-ui": "^9.1.0-canary.31",
     "react": "^18.2.0"
   },
   "devDependencies": {

package/plugins/categoriesApplySearchDefaultAlgolia.ts

@@ -0,0 +1,16 @@
+import type { categoriesApplySearchDefaults as original } from '@graphcommerce/magento-search'
+import type { FunctionPlugin, PluginConfig } from '@graphcommerce/next-config'
+
+export const config: PluginConfig = {
+  type: 'function',
+  module: '@graphcommerce/magento-search',
+}
+
+export const categoriesApplySearchDefaults: FunctionPlugin<typeof original> = (
+  prev,
+  props,
+  conf,
+) => {
+  const result = prev(props, conf)
+  return { ...result, filters: { ...result.filters, engine: { in: ['algolia'] } } }
+}

package/schema/AlgoliaCategorySchema.graphqls

@@ -0,0 +1,4 @@
+type CategoryResult {
+  algolia_queryID: String
+  algolia_indexName: String
+}