feat(navigation): add injectable fragment support to magento driver (#…

…2884)

libs/navigation/driver/magento/src/navigation.service.ts

@@ -3,6 +3,7 @@ import {
   Inject,
 } from '@angular/core';
 import { Apollo } from 'apollo-angular';
+import { DocumentNode } from 'graphql';
 import {
   Observable,
   of,
@@ -24,6 +25,7 @@ import {
   MagentoNavigationDriverConfig,
 } from './config/public_api';
 import { GetCategoryTreeResponse } from './models/get-category-tree-response';
+import { DAFF_NAVIGATION_MAGENTO_DRIVER_EXTRA_FRAGMENTS } from './queries/fragments/public_api';
 import { daffMagentoGetCategoryTree } from './queries/get-category-tree';
 import { magentoNavigationGetRootCategoryIdQuery } from './queries/get-root-category-id/public_api';
 
@@ -38,6 +40,7 @@ export class DaffMagentoNavigationService implements DaffNavigationServiceInterf
   constructor(
     private apollo: Apollo,
     @Inject(DaffNavigationTransformer) private transformer: DaffNavigationTransformerInterface<DaffNavigationTree>,
+    @Inject(DAFF_NAVIGATION_MAGENTO_DRIVER_EXTRA_FRAGMENTS) private extraFragments: Array<DocumentNode>,
     @Inject(MAGENTO_NAVIGATION_DRIVER_CONFIG) private config: MagentoNavigationDriverConfig,
   ) {}
 
@@ -57,7 +60,7 @@ export class DaffMagentoNavigationService implements DaffNavigationServiceInterf
 
   get(categoryId: string): Observable<DaffNavigationTree> {
     return this.apollo.query<GetCategoryTreeResponse>({
-      query: daffMagentoGetCategoryTree(this.config.navigationTreeQueryDepth),
+      query: daffMagentoGetCategoryTree(this.config.navigationTreeQueryDepth, this.extraFragments),
       variables: {
         filters: { category_uid: { eq: categoryId }},
       },

libs/navigation/driver/magento/src/public_api.ts

@@ -1,7 +1,7 @@
 export { DaffNavigationMagentoDriverModule } from './navigation-driver.module';
 export { DaffMagentoNavigationService } from './navigation.service';
 export { DaffMagentoNavigationTransformerService } from './transformers/navigation-transformer';
-export * from './queries/get-category-tree';
+export * from './queries/public_api';
 export * from './config/public_api';
 export * from './models/public_api';
 export * from './transforms/public_api';

libs/navigation/driver/magento/src/queries/fragments/category-node.ts → libs/navigation/driver/magento/src/queries/fragments/category-node/category-node.ts

@@ -1,6 +1,11 @@
 import { gql } from 'apollo-angular';
 import { DocumentNode } from 'graphql';
 
+import {
+  daffBuildFragmentDefinition,
+  daffBuildFragmentNameSpread,
+} from '@daffodil/core/graphql';
+
 
 const CATEGORY_NODE_FRAGMENT_NAME = 'categoryNode';
 
@@ -9,7 +14,7 @@ const CATEGORY_NODE_FRAGMENT_NAME = 'categoryNode';
  *
  * @param depth The maximum depth to which category children should be added to the fragment.
  */
-export function getCategoryNodeFragment(depth: number = 3): DocumentNode {
+export function getCategoryNodeFragment(depth: number = 3, extraFragments: Array<DocumentNode> = []): DocumentNode {
   const fragmentBody = new Array(depth).fill(null).reduce(acc => `
     ...${CATEGORY_NODE_FRAGMENT_NAME}
     children_count
@@ -34,10 +39,12 @@ export function getCategoryNodeFragment(depth: number = 3): DocumentNode {
       }
       position
       product_count
+      ${daffBuildFragmentNameSpread(...extraFragments)}
     }
 
     fragment recursiveCategoryNode on CategoryTree {
       ${fragmentBody}
     }
+    ${daffBuildFragmentDefinition(...extraFragments)}
   `;
 }

libs/navigation/driver/magento/src/queries/fragments/category-node/extra.token.ts

@@ -0,0 +1,8 @@
+import { DocumentNode } from 'graphql';
+
+import { createMultiInjectionToken } from '@daffodil/core';
+
+export const {
+  token: DAFF_NAVIGATION_MAGENTO_DRIVER_EXTRA_FRAGMENTS,
+  provider: daffNavigationMagentoDriverExtraFragments,
+} = createMultiInjectionToken<DocumentNode>('DAFF_NAVIGATION_MAGENTO_DRIVER_EXTRA_FRAGMENTS');

libs/navigation/driver/magento/src/queries/fragments/category-node/public_api.ts

@@ -0,0 +1,2 @@
+export * from './category-node';
+export * from './extra.token';

libs/navigation/driver/magento/src/queries/fragments/public_api.ts

@@ -0,0 +1 @@
+export * from './category-node/public_api';

libs/navigation/driver/magento/src/queries/get-category-tree.ts

@@ -1,6 +1,7 @@
 import { gql } from 'apollo-angular';
+import { DocumentNode } from 'graphql';
 
-import { getCategoryNodeFragment } from './fragments/category-node';
+import { getCategoryNodeFragment } from './fragments/category-node/category-node';
 
 export const DAFF_MAGENTO_GET_CATEGORY_TREE_QUERY_NAME = 'MagentoGetCategoryTree';
 
@@ -9,13 +10,13 @@ export const DAFF_MAGENTO_GET_CATEGORY_TREE_QUERY_NAME = 'MagentoGetCategoryTree
  *
  * @param depth The maximum depth to which category children should be added to the fragment.
  */
-export function daffMagentoGetCategoryTree(depth: number = 3) {
+export function daffMagentoGetCategoryTree(depth: number = 3, extraFragments: Array<DocumentNode> = []) {
   return gql`
     query ${DAFF_MAGENTO_GET_CATEGORY_TREE_QUERY_NAME}($filters: CategoryFilterInput!){
       categoryList(filters: $filters) {
         ...recursiveCategoryNode
       }
     }
-    ${getCategoryNodeFragment(depth)}
+    ${getCategoryNodeFragment(depth, extraFragments)}
   `;
 }

libs/navigation/driver/magento/src/queries/public_api.ts

@@ -0,0 +1,3 @@
+export * from './fragments/public_api';
+export * from './get-root-category-id/public_api';
+export * from './get-category-tree';

libs/navigation/testing/src/public_api.ts

@@ -1,2 +1,2 @@
-export { DaffNavigationTreeFactory } from './factories/navigation-tree.factory';
+export * from './factories/navigation-tree.factory';
 export { isNavigation } from './helpers/navigation-helper';