feat(core): Add Facet queries to Shop API (#1016)

Closes #1013
vendure-ecommerce · Aug 3, 2021 · d6a049c · d6a049c
1 parent b787acb
commit d6a049c
Show file tree

Hide file tree

Showing 8 changed files with 5,440 additions and 5,936 deletions.
diff --git a/packages/common/src/generated-shop-types.ts b/packages/common/src/generated-shop-types.ts
@@ -40,6 +40,10 @@ export type Query = {
   eligibleShippingMethods: Array<ShippingMethodQuote>;
   /** Returns a list of payment methods and their eligibility based on the current active Order */
   eligiblePaymentMethods: Array<PaymentMethodQuote>;
+  /** A list of Facets available to the shop */
+  facets: FacetList;
+  /** Returns a Facet by its id */
+  facet?: Maybe<Facet>;
   /** Returns information about the current authenticated User */
   me?: Maybe<CurrentUser>;
   /** Returns the possible next states that the activeOrder can transition to */
@@ -76,6 +80,16 @@ export type QueryCollectionArgs = {
 };
 
 
+export type QueryFacetsArgs = {
+  options?: Maybe<FacetListOptions>;
+};
+
+
+export type QueryFacetArgs = {
+  id: Scalars['ID'];
+};
+
+
 export type QueryOrderArgs = {
   id: Scalars['ID'];
 };
@@ -2764,6 +2778,13 @@ export type CollectionListOptions = {
   filter?: Maybe<CollectionFilterParameter>;
 };
 
+export type FacetListOptions = {
+  skip?: Maybe<Scalars['Int']>;
+  take?: Maybe<Scalars['Int']>;
+  sort?: Maybe<FacetSortParameter>;
+  filter?: Maybe<FacetFilterParameter>;
+};
+
 export type OrderListOptions = {
   skip?: Maybe<Scalars['Int']>;
   take?: Maybe<Scalars['Int']>;
@@ -2924,6 +2945,22 @@ export type CollectionSortParameter = {
   description?: Maybe<SortOrder>;
 };
 
+export type FacetFilterParameter = {
+  createdAt?: Maybe<DateOperators>;
+  updatedAt?: Maybe<DateOperators>;
+  languageCode?: Maybe<StringOperators>;
+  name?: Maybe<StringOperators>;
+  code?: Maybe<StringOperators>;
+};
+
+export type FacetSortParameter = {
+  id?: Maybe<SortOrder>;
+  createdAt?: Maybe<SortOrder>;
+  updatedAt?: Maybe<SortOrder>;
+  name?: Maybe<SortOrder>;
+  code?: Maybe<SortOrder>;
+};
+
 export type ProductFilterParameter = {
   createdAt?: Maybe<DateOperators>;
   updatedAt?: Maybe<DateOperators>;

diff --git a/packages/core/e2e/facet.e2e-spec.ts b/packages/core/e2e/facet.e2e-spec.ts
@@ -32,7 +32,7 @@ import {
     ASSIGN_PRODUCT_TO_CHANNEL,
     CREATE_CHANNEL,
     CREATE_FACET,
-    GET_FACET_LIST,
+    GET_FACET_LIST, GET_FACET_LIST_SIMPLE,
     GET_PRODUCT_WITH_VARIANTS,
     UPDATE_FACET,
     UPDATE_PRODUCT,
@@ -43,7 +43,7 @@ import { assertThrowsWithMessage } from './utils/assert-throws-with-message';
 // tslint:disable:no-non-null-assertion
 
 describe('Facet resolver', () => {
-    const { server, adminClient } = createTestEnvironment(testConfig);
+    const { server, adminClient, shopClient } = createTestEnvironment(testConfig);
 
     let brandFacet: FacetWithValues.Fragment;
     let speakerTypeFacet: FacetWithValues.Fragment;
@@ -85,6 +85,7 @@ describe('Facet resolver', () => {
             input: {
                 id: speakerTypeFacet.id,
                 translations: [{ languageCode: LanguageCode.en, name: 'Speaker Category' }],
+                isPrivate: true
             },
         });
 
@@ -157,6 +158,14 @@ describe('Facet resolver', () => {
         speakerTypeFacet = items[1];
     });
 
+    it('facets by shop-api', async () => {
+        const result = await shopClient.query<GetFacetList.Query>(GET_FACET_LIST_SIMPLE);
+
+        const { items } = result.facets;
+        expect(items.length).toBe(1);
+        expect(items[0].name).toBe('category');
+    });
+
     it('facet', async () => {
         const result = await adminClient.query<GetFacetWithValues.Query, GetFacetWithValues.Variables>(
             GET_FACET_WITH_VALUES,