@graphcommerce/algolia-categories 9.0.0-canary.84

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @graphcommerce/algolia-categories
+
+## 9.0.0-canary.84
+
+### Minor Changes
+
+- [#2377](https://github.com/graphcommerce-org/graphcommerce/pull/2377) [`bca47b8`](https://github.com/graphcommerce-org/graphcommerce/commit/bca47b81061ea8608753cfc8940ce4db65ab27e3) - Enables algolia category search in graphql mesh. Integrated algolias category search into categories type within the mesh. This will only be used on search pages ([@Renzovh](https://github.com/Renzovh))

package/README.md

@@ -0,0 +1,3 @@
+# Algolia Magento 2
+
+[See algolia docs](../../docs/magento/algolia.md)

package/mesh/algoliaHitToMagentoCategory.ts

@@ -0,0 +1,72 @@
+import { algoliaUrlToUrlKey } from '@graphcommerce/algolia-products/mesh/algoliaHitToMagentoProduct'
+import { GetStoreConfigReturn } from '@graphcommerce/algolia-products/mesh/getStoreConfig'
+import {
+  RequireFields,
+  ResolverFn,
+  ResolversParentTypes,
+  ResolversTypes,
+  MeshContext,
+  QuerycategoriesArgs,
+  Algoliahit,
+  AlgoliaProductHitAdditionalProperties,
+} from '@graphcommerce/graphql-mesh'
+
+export type AlgoliaCategoryHitAddiotonalProperties = AlgoliaProductHitAdditionalProperties & {
+  path: string
+  url: string
+  product_count: number
+  meta_description: string
+  meta_title: string
+  level: number
+}
+
+export function assertAdditional(
+  additional: unknown,
+): additional is AlgoliaCategoryHitAddiotonalProperties {
+  return true
+}
+
+export type CategoriesItemsItem = NonNullable<
+  Awaited<
+    ReturnType<
+      ResolverFn<
+        ResolversTypes['CategoryResult'],
+        ResolversParentTypes['Query'],
+        MeshContext,
+        RequireFields<QuerycategoriesArgs, 'pageSize' | 'currentPage'>
+      >
+    >
+  >['items']
+>[number]
+
+function mapBreadcrumbs(algoliaPath) {
+  const pathArray = algoliaPath.split(' / ')
+  return pathArray.map((item) => ({
+    category_name: item,
+    category_uid: 0,
+  }))
+}
+
+export function algoliaHitToMagentoCategory(
+  hit: Algoliahit,
+  storeConfig: GetStoreConfigReturn,
+): CategoriesItemsItem {
+  const { objectID, additionalProperties } = hit
+
+  if (!assertAdditional(additionalProperties)) return null
+  return {
+    name: additionalProperties?.name,
+    children: null,
+    products: null,
+    image: additionalProperties?.image_url,
+    uid: objectID,
+    redirect_code: 0,
+    url_key: '',
+    url_path: algoliaUrlToUrlKey(additionalProperties.url, storeConfig?.base_link_url),
+    breadcrumbs: mapBreadcrumbs(additionalProperties?.path),
+    product_count: additionalProperties?.product_count,
+    meta_description: additionalProperties?.meta_description,
+    meta_title: additionalProperties?.meta_title,
+    level: additionalProperties?.level,
+  }
+}

package/mesh/getCategoryResults.ts

@@ -0,0 +1,34 @@
+import { MeshContext, QuerycategoryListArgs } from '@graphcommerce/graphql-mesh'
+import type { GraphQLResolveInfo } from 'graphql'
+import { getCategoryResultsInput } from './getCategoryResultsInput'
+import { getIndexName } from './getIndexName'
+
+export async function getCategoryResults(
+  args: QuerycategoryListArgs,
+  context: MeshContext,
+  info: GraphQLResolveInfo,
+) {
+  return context.algolia.Query.algolia_searchSingleIndex({
+    args: {
+      indexName: getIndexName(context),
+      input: await getCategoryResultsInput(args),
+    },
+    selectionSet: /* GraphQL */ `
+      {
+        nbPages
+        hitsPerPage
+        page
+        queryID
+        nbHits
+        hits {
+          __typename
+          objectID
+          additionalProperties
+        }
+        facets
+      }
+    `,
+    context,
+    info,
+  })
+}

package/mesh/getCategoryResultsInput.ts

@@ -0,0 +1,15 @@
+import {
+  Queryalgolia_searchSingleIndexArgs,
+  QuerycategoryListArgs,
+} from '@graphcommerce/graphql-mesh'
+
+// eslint-disable-next-line @typescript-eslint/require-await
+export async function getCategoryResultsInput(
+  args: QuerycategoryListArgs,
+): Promise<Queryalgolia_searchSingleIndexArgs['input']> {
+  return {
+    query: args.filters?.name?.match ?? '',
+    hitsPerPage: args.pageSize ? args.pageSize : 10,
+    page: args.currentPage ? args.currentPage - 1 : 0,
+  }
+}

package/mesh/getIndexName.ts

@@ -0,0 +1,11 @@
+import { MeshContext } from '@graphcommerce/graphql-mesh'
+import { storefrontConfigDefault } from '@graphcommerce/next-ui'
+
+function getStoreHeader(context: MeshContext) {
+  return (context as MeshContext & { headers: Record<string, string | undefined> }).headers.store
+}
+
+export function getIndexName(context: MeshContext) {
+  const storeCode = getStoreHeader(context) ?? storefrontConfigDefault().magentoStoreCode
+  return `${import.meta.graphCommerce.algolia.indexNamePrefix}${storeCode}_categories`
+}

package/mesh/resolvers.ts

@@ -0,0 +1,39 @@
+import { getStoreConfig } from '@graphcommerce/algolia-products/mesh/getStoreConfig'
+import { type Resolvers } from '@graphcommerce/graphql-mesh'
+import { algoliaHitToMagentoCategory, CategoriesItemsItem } from './algoliaHitToMagentoCategory'
+import { getCategoryResults } from './getCategoryResults'
+
+export const resolvers: Resolvers = {
+  Query: {
+    categories: async (root, args, context, info) => {
+      const isAgolia = (args.filters?.engine?.in ?? [args.filters?.engine?.eq])[0] === 'algolia'
+
+      if (!isAgolia) return context.m2.Query.categories({ root, args, context, info })
+
+      const items: (CategoriesItemsItem | null)[] = []
+
+      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)
+        }
+      }
+
+      return {
+        items,
+        page_info: {
+          current_page: algoliaResponse.page + 1,
+          page_size: algoliaResponse.hitsPerPage,
+          total_pages: algoliaResponse.nbPages,
+        },
+        total_count: algoliaResponse.nbHits,
+      }
+    },
+  },
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@graphcommerce/algolia-categories",
+  "homepage": "https://www.graphcommerce.org/",
+  "repository": "github:graphcommerce-org/graphcommerce",
+  "version": "9.0.0-canary.84",
+  "sideEffects": false,
+  "prettier": "@graphcommerce/prettier-config-pwa",
+  "eslintConfig": {
+    "extends": "@graphcommerce/eslint-config-pwa",
+    "parserOptions": {
+      "project": "./tsconfig.json"
+    }
+  },
+  "scripts": {
+    "generate": "tsx scripts/generate-spec.mts"
+  },
+  "peerDependencies": {
+    "@graphcommerce/algolia-products": "^9.0.0-canary.84",
+    "@graphcommerce/google-datalayer": "^9.0.0-canary.84",
+    "@graphcommerce/graphql": "^9.0.0-canary.84",
+    "@graphcommerce/graphql-mesh": "^9.0.0-canary.84",
+    "@graphcommerce/magento-customer": "^9.0.0-canary.84",
+    "@graphcommerce/magento-product": "^9.0.0-canary.84",
+    "@graphcommerce/magento-search": "^9.0.0-canary.84",
+    "@graphcommerce/next-config": "^9.0.0-canary.84",
+    "@graphcommerce/next-ui": "^9.0.0-canary.84",
+    "react": "^18.2.0"
+  },
+  "devDependencies": {
+    "graphql": "^16.0.0",
+    "tsx": "^4.16.2"
+  }
+}

package/plugins/meshConfigAlgoliaCategories.ts

@@ -0,0 +1,23 @@
+import type { meshConfig as meshConfigBase } from '@graphcommerce/graphql-mesh/meshConfig'
+import type { FunctionPlugin, PluginConfig } from '@graphcommerce/next-config'
+
+export const config: PluginConfig = {
+  module: '@graphcommerce/graphql-mesh/meshConfig',
+  type: 'function',
+}
+
+export const meshConfig: FunctionPlugin<typeof meshConfigBase> = (
+  prev,
+  baseConfig,
+  graphCommerceConfig,
+) =>
+  prev(
+    {
+      sources: [...baseConfig.sources],
+      additionalResolvers: [
+        ...(baseConfig.additionalResolvers ?? []),
+        '@graphcommerce/algolia-categories/mesh/resolvers.ts',
+      ],
+    },
+    graphCommerceConfig,
+  )