feat: #1214071 add/update GQL queries getSearchDocumentsQuery, getMor…

…eFacetOptionsQuery and getMoreFacetProductOptionsQuery and the related types
Elastic-Suite · Nov 7, 2023 · 6010868 · 6010868
1 parent 2992a51
commit 6010868
Show file tree

Hide file tree

Showing 22 changed files with 230 additions and 152 deletions.
diff --git a/packages/components/__mocks__/@elastic-suite/gally-admin-shared.ts b/packages/components/__mocks__/@elastic-suite/gally-admin-shared.ts
@@ -1,7 +1,7 @@
 import { api } from '@elastic-suite/gally-admin-shared/src/mocks'
 
 import catalog from '@elastic-suite/gally-admin-shared/src/mocks/static/catalog.json'
-import categorySortingOptions from '@elastic-suite/gally-admin-shared/src/mocks/static/category_sorting_options.json'
+import productSortingOptions from '@elastic-suite/gally-admin-shared/src/mocks/static/product_sorting_options.json'
 import docs from '@elastic-suite/gally-admin-shared/src/mocks/static/docs.json'
 import entrypoint from '@elastic-suite/gally-admin-shared/src/mocks/static/index.json'
 import graphql from '@elastic-suite/gally-admin-shared/src/mocks/static/graphql.json'
@@ -46,9 +46,9 @@ fetchApi.mockImplementation((_, resource) => {
     data = { ...metadata }
   } else if (
     typeof resource === 'string' &&
-    resource.endsWith('category_sorting_options')
+    resource.endsWith('product_sorting_options')
   ) {
-    data = { ...categorySortingOptions }
+    data = { ...productSortingOptions }
   } else if (
     (typeof resource !== 'string' &&
       resource.title.toLowerCase() === 'source_field_option_label') ||

diff --git a/packages/components/src/components/stateful/ProductsContainer/ProductsContainer.tsx b/packages/components/src/components/stateful/ProductsContainer/ProductsContainer.tsx
@@ -10,11 +10,11 @@ import { useTranslation } from 'next-i18next'
 
 import {
   ICategory,
-  ICategorySortingOption,
   IGraphqlProductPosition,
   IParsedCategoryConfiguration,
   IProductFieldFilterInput,
   IProductPositions,
+  ISortingOption,
   LoadStatus,
   getProductPosition,
 } from '@elastic-suite/gally-admin-shared'
@@ -110,12 +110,12 @@ function ProductsContainer(props: IProps): JSX.Element {
     setBottomSelectedRows([])
   }
 
-  const resourceName = 'CategorySortingOption'
+  const resourceName = 'ProductSortingOption'
   const resourceSortingOption = useResource(resourceName)
-  const [{ data }] = useApiList<ICategorySortingOption>(resourceSortingOption)
+  const [{ data }] = useApiList<ISortingOption>(resourceSortingOption)
 
   const sortOption = data
-    ? data[`hydra:member`].map((obj: ICategorySortingOption) => ({
+    ? data[`hydra:member`].map((obj: ISortingOption) => ({
         value: obj.code,
         ...obj,
       }))

diff --git a/packages/shared/src/constants/category.ts b/packages/shared/src/constants/category.ts
@@ -0,0 +1 @@
+export const categoryEntityType = 'category'
diff --git a/packages/shared/src/constants/cmsPage.ts b/packages/shared/src/constants/cmsPage.ts
@@ -0,0 +1 @@
+export const cmsPageEntityType = 'cms_page'
diff --git a/packages/shared/src/constants/graphql.ts b/packages/shared/src/constants/graphql.ts
@@ -2,6 +2,7 @@ import { VariableType, jsonToGraphQLQuery } from 'json-to-graphql-query'
 
 import { IGraphqlQueryContent, IProductFieldFilterInput } from '../types'
 import { IDocumentFieldFilterInput } from '../types/documents'
+import { categoryEntityType } from './category'
 
 export function getSearchProductsQuery(
   filter: IProductFieldFilterInput | IProductFieldFilterInput[] = null,
@@ -98,7 +99,34 @@ export function getSearchCategoryQueryContent(
   filter: IDocumentFieldFilterInput | IDocumentFieldFilterInput[] = null,
   withAggregations = false
 ): IGraphqlQueryContent {
-  return getSearchDocumentQueryContent(filter, withAggregations, 'category')
+  return getSearchDocumentQueryContent(
+    filter,
+    withAggregations,
+    categoryEntityType
+  )
+}
+
+export function getSearchDocumentsQuery(
+  entityType: string,
+  filter: IDocumentFieldFilterInput | IDocumentFieldFilterInput[] = null,
+  withAggregations = false
+): string {
+  const documentQueryContent = getSearchDocumentQueryContent(
+    filter,
+    withAggregations,
+    entityType
+  )
+  return jsonToGraphQLQuery({
+    query: {
+      __name: 'getDocuments',
+      __variables: { ...documentQueryContent.variables },
+      documents: {
+        __aliasFor: 'documents',
+        __args: { ...documentQueryContent.args },
+        ...documentQueryContent.fields,
+      },
+    },
+  })
 }
 
 export function getSearchDocumentQueryContent(
@@ -162,15 +190,18 @@ export function getSearchDocumentQueryContent(
 }
 
 export function getAutoCompleteSearchQuery(
-  filter: IProductFieldFilterInput | IProductFieldFilterInput[] = null,
+  productFilter: IProductFieldFilterInput | IProductFieldFilterInput[] = null,
+  categoryFilter:
+    | IDocumentFieldFilterInput
+    | IDocumentFieldFilterInput[] = null,
   withAggregations = false
 ): string {
   const productQueryContent = getSearchProductsQueryContent(
-    filter,
+    productFilter,
     withAggregations
   )
   const categoryQueryContent = getSearchCategoryQueryContent(
-    filter,
+    categoryFilter,
     withAggregations
   )
   return jsonToGraphQLQuery({
@@ -195,6 +226,35 @@ export function getAutoCompleteSearchQuery(
 }
 
 export function getMoreFacetOptionsQuery(
+  filter: IDocumentFieldFilterInput | IDocumentFieldFilterInput[] = null
+): string {
+  return jsonToGraphQLQuery({
+    query: {
+      __name: 'viewMoreFacetOptions',
+      __variables: {
+        entityType: 'String!',
+        localizedCatalog: 'String!',
+        aggregation: 'String!',
+        search: 'String',
+      },
+      viewMoreFacetOptions: {
+        __args: {
+          entityType: new VariableType('entityType'),
+          localizedCatalog: new VariableType('localizedCatalog'),
+          aggregation: new VariableType('aggregation'),
+          search: new VariableType('search'),
+          filter,
+        },
+        id: true,
+        value: true,
+        label: true,
+        count: true,
+      },
+    },
+  })
+}
+
+export function getMoreFacetProductOptionsQuery(
   filter: IProductFieldFilterInput | IProductFieldFilterInput[] = null
 ): string {
   return jsonToGraphQLQuery({

diff --git a/packages/shared/src/constants/index.ts b/packages/shared/src/constants/index.ts
@@ -1,7 +1,10 @@
 export * from './api'
+export * from './category'
+export * from './cmsPage'
 export * from './customTable'
 export * from './graphql'
 export * from './hydra'
+export * from './product'
 export * from './rules'
 export * from './theme'
 export * from './url'

diff --git a/packages/shared/src/constants/product.ts b/packages/shared/src/constants/product.ts
@@ -0,0 +1 @@
+export const productEntityType = 'product'
diff --git a/packages/shared/src/mocks/api.ts b/packages/shared/src/mocks/api.ts
@@ -99,7 +99,7 @@ export const fieldDropdownWithApiOptions = {
   gally: {
     input: 'select',
     options: {
-      api_rest: '/category_sorting_options',
+      api_rest: '/product_sorting_options',
     },
     editable: false,
     position: 10,
@@ -1806,26 +1806,26 @@ export const resources = [
     url: 'https://localhost/categories',
   },
   {
-    '@id': 'https://localhost/docs.jsonld#CategorySortingOption',
+    '@id': 'https://localhost/docs.jsonld#ProductSortingOption',
     '@type': 'http://www.w3.org/ns/hydra/core#Class',
     supportedOperation: {
       '@type': [
         'http://www.w3.org/ns/hydra/core#Operation',
         'http://schema.org/FindAction',
       ],
       method: 'GET',
-      title: 'Retrieves the collection of CategorySortingOption resources.',
-      label: 'Retrieves the collection of CategorySortingOption resources.',
+      title: 'Retrieves the collection of ProductSortingOption resources.',
+      label: 'Retrieves the collection of ProductSortingOption resources.',
       returns: { '@id': 'http://www.w3.org/ns/hydra/core#Collection' },
     },
     supportedProperty: [
       {
         '@type': 'http://www.w3.org/ns/hydra/core#SupportedProperty',
         property: {
-          '@id': 'https://localhost/docs.jsonld#CategorySortingOption/label',
+          '@id': 'https://localhost/docs.jsonld#ProductSortingOption/label',
           '@type': 'http://www.w3.org/1999/02/22-rdf-syntax-ns#Property',
           domain: {
-            '@id': 'https://localhost/docs.jsonld#CategorySortingOption',
+            '@id': 'https://localhost/docs.jsonld#ProductSortingOption',
           },
           range: { '@id': 'http://www.w3.org/2001/XMLSchema#string' },
           label: 'label',
@@ -1838,10 +1838,10 @@ export const resources = [
       {
         '@type': 'http://www.w3.org/ns/hydra/core#SupportedProperty',
         property: {
-          '@id': 'https://localhost/docs.jsonld#CategorySortingOption/code',
+          '@id': 'https://localhost/docs.jsonld#ProductSortingOption/code',
           '@type': 'http://www.w3.org/1999/02/22-rdf-syntax-ns#Property',
           domain: {
-            '@id': 'https://localhost/docs.jsonld#CategorySortingOption',
+            '@id': 'https://localhost/docs.jsonld#ProductSortingOption',
           },
           range: { '@id': 'http://www.w3.org/2001/XMLSchema#string' },
           label: 'code',
@@ -1852,9 +1852,9 @@ export const resources = [
         writeable: true,
       },
     ],
-    title: 'CategorySortingOption',
-    label: 'CategorySortingOption',
-    url: 'https://localhost/category_sorting_options',
+    title: 'ProductSortingOption',
+    label: 'ProductSortingOption',
+    url: 'https://localhost/product_sorting_options',
   },
   {
     '@id': 'https://localhost/docs.jsonld#CategoryConfiguration',

diff --git a/packages/shared/src/mocks/expandedDocs.ts b/packages/shared/src/mocks/expandedDocs.ts
@@ -2545,20 +2545,19 @@ export const expandedDocs = {
       'http://www.w3.org/2000/01/rdf-schema#label': [{ '@value': 'Category' }],
     },
     {
-      '@id': 'https://localhost/docs.jsonld#CategorySortingOption',
+      '@id': 'https://localhost/docs.jsonld#ProductSortingOption',
       '@type': ['http://www.w3.org/ns/hydra/core#Class'],
       'http://www.w3.org/ns/hydra/core#supportedOperation': [],
       'http://www.w3.org/ns/hydra/core#supportedProperty': [
         {
           '@type': ['http://www.w3.org/ns/hydra/core#SupportedProperty'],
           'http://www.w3.org/ns/hydra/core#property': [
             {
-              '@id':
-                'https://localhost/docs.jsonld#CategorySortingOption/label',
+              '@id': 'https://localhost/docs.jsonld#ProductSortingOption/label',
               '@type': ['http://www.w3.org/1999/02/22-rdf-syntax-ns#Property'],
               'http://www.w3.org/2000/01/rdf-schema#domain': [
                 {
-                  '@id': 'https://localhost/docs.jsonld#CategorySortingOption',
+                  '@id': 'https://localhost/docs.jsonld#ProductSortingOption',
                 },
               ],
               'http://www.w3.org/2000/01/rdf-schema#range': [
@@ -2578,11 +2577,11 @@ export const expandedDocs = {
           '@type': ['http://www.w3.org/ns/hydra/core#SupportedProperty'],
           'http://www.w3.org/ns/hydra/core#property': [
             {
-              '@id': 'https://localhost/docs.jsonld#CategorySortingOption/code',
+              '@id': 'https://localhost/docs.jsonld#ProductSortingOption/code',
               '@type': ['http://www.w3.org/1999/02/22-rdf-syntax-ns#Property'],
               'http://www.w3.org/2000/01/rdf-schema#domain': [
                 {
-                  '@id': 'https://localhost/docs.jsonld#CategorySortingOption',
+                  '@id': 'https://localhost/docs.jsonld#ProductSortingOption',
                 },
               ],
               'http://www.w3.org/2000/01/rdf-schema#range': [
@@ -2600,10 +2599,10 @@ export const expandedDocs = {
         },
       ],
       'http://www.w3.org/ns/hydra/core#title': [
-        { '@value': 'CategorySortingOption' },
+        { '@value': 'ProductSortingOption' },
       ],
       'http://www.w3.org/2000/01/rdf-schema#label': [
-        { '@value': 'CategorySortingOption' },
+        { '@value': 'ProductSortingOption' },
       ],
     },
     {
@@ -4470,7 +4469,7 @@ export const expandedDocs = {
           'http://www.w3.org/ns/hydra/core#property': [
             {
               '@id':
-                'https://localhost/docs.jsonld#Entrypoint/categorySortingOption',
+                'https://localhost/docs.jsonld#Entrypoint/productSortingOption',
               '@type': ['http://www.w3.org/ns/hydra/core#Link'],
               'http://www.w3.org/2000/01/rdf-schema#domain': [
                 { '@id': 'https://localhost/docs.jsonld#Entrypoint' },
@@ -4487,13 +4486,13 @@ export const expandedDocs = {
                   'http://www.w3.org/ns/hydra/core#title': [
                     {
                       '@value':
-                        'Retrieves the collection of CategorySortingOption resources.',
+                        'Retrieves the collection of ProductSortingOption resources.',
                     },
                   ],
                   'http://www.w3.org/2000/01/rdf-schema#label': [
                     {
                       '@value':
-                        'Retrieves the collection of CategorySortingOption resources.',
+                        'Retrieves the collection of ProductSortingOption resources.',
                     },
                   ],
                   'http://www.w3.org/ns/hydra/core#returns': [
@@ -4503,7 +4502,7 @@ export const expandedDocs = {
               ],
               'http://www.w3.org/2000/01/rdf-schema#label': [
                 {
-                  '@value': 'The collection of CategorySortingOption resources',
+                  '@value': 'The collection of ProductSortingOption resources',
                 },
               ],
               'http://www.w3.org/2000/01/rdf-schema#range': [
@@ -4514,7 +4513,7 @@ export const expandedDocs = {
                       'http://www.w3.org/2002/07/owl#allValuesFrom': [
                         {
                           '@id':
-                            'https://localhost/docs.jsonld#CategorySortingOption',
+                            'https://localhost/docs.jsonld#ProductSortingOption',
                         },
                       ],
                       'http://www.w3.org/2002/07/owl#onProperty': [
@@ -4528,7 +4527,7 @@ export const expandedDocs = {
           ],
           'http://www.w3.org/ns/hydra/core#readable': [{ '@value': true }],
           'http://www.w3.org/ns/hydra/core#title': [
-            { '@value': 'The collection of CategorySortingOption resources' },
+            { '@value': 'The collection of ProductSortingOption resources' },
           ],
           'http://www.w3.org/ns/hydra/core#writeable': [{ '@value': false }],
         },

diff --git a/packages/shared/src/mocks/static/contexts/Entrypoint.json b/packages/shared/src/mocks/static/contexts/Entrypoint.json
@@ -65,8 +65,8 @@
       "@type": "@id"
     },
     "categoryTree": { "@id": "Entrypoint/categoryTree", "@type": "@id" },
-    "categorySortingOption": {
-      "@id": "Entrypoint/categorySortingOption",
+    "productSortingOption": {
+      "@id": "Entrypoint/productSortingOption",
       "@type": "@id"
     },
     "configuration": { "@id": "Entrypoint/configuration", "@type": "@id" },