All files / src/app/shared/cms/components/cms-product-list-rest cms-product-list-rest.component.ts

84% Statements 21/25
75% Branches 15/20
71.42% Functions 5/7
84% Lines 21/25

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85    1x 1x   1x   1x 1x 1x                                     1x           4x 4x 4x       3x 3x           3x         3x             3x   3x           3x       3x         3x 1x     3x        
/* eslint-disable ish-custom-rules/no-intelligence-in-artifacts */
// eslint-disable-next-line ish-custom-rules/ban-imports-file-pattern
import { HttpClient } from '@angular/common/http';
import { ChangeDetectionStrategy, Component, Input, OnChanges } from '@angular/core';
import { Observable } from 'rxjs';
import { map } from 'rxjs/operators';
 
import { ContentPageletView } from 'ish-core/models/content-view/content-view.model';
import { ApiService } from 'ish-core/services/api/api.service';
import { SparqueApiService } from 'ish-core/services/sparque-api/sparque-api.service';
import { CMSComponent } from 'ish-shared/cms/models/cms-component/cms-component.model';
 
/**
 * CMS component that displays a product list by fetching product SKUs from a REST endpoint.
 *
 * This component supports multiple API protocols:
 * - `icm://` - Uses the standard ICM API service
 * - `sparque://` - Uses the Sparque API service with v2 API version
 * - Standard HTTP URLs - Uses Angular's HttpClient
 *
 * The component can optionally apply a mapper function to transform the REST response
 * and limit the number of products displayed.
 */
@Component({
  selector: 'ish-cms-product-list-rest',
  templateUrl: './cms-product-list-rest.component.html',
  changeDetection: ChangeDetectionStrategy.OnPush,
})
export class CMSProductListRestComponent implements CMSComponent, OnChanges {
  @Input({ required: true }) pagelet: ContentPageletView;
 
  productSKUs$: Observable<string[]>;
 
  constructor(
    private httpClient: HttpClient,
    private apiService: ApiService,
    private sparqueApiService: SparqueApiService
  ) {}
 
  ngOnChanges() {
    if (this.pagelet.hasParam('ProductsRestEndpoint')) {
      this.productSKUs$ = this.getProductSKUs$();
    }
  }
 
  private getProductSKUs$(): Observable<string[]> {
    // determine which service to use based on the protocol prefix of the endpoint URL
    Iif (this.pagelet.stringParam('ProductsRestEndpoint').startsWith('icm://')) {
      // use standard ICM API service for 'icm' protocol
      return this.apiService
        .get(this.pagelet.stringParam('ProductsRestEndpoint').replace('icm://', ''))
        .pipe(map(data => this.mapProductData(data)));
    } else Iif (this.pagelet.stringParam('ProductsRestEndpoint').startsWith('sparque://')) {
      // use Sparque API service for 'sparque' protocol (use hardcoded apiVersion 'v2')
      return this.sparqueApiService
        .get(this.pagelet.stringParam('ProductsRestEndpoint').replace('sparque://', ''), 'v2')
        .pipe(map(data => this.mapProductData(data)));
    } else {
      // default to standard HTTP client for other URLs
      return this.httpClient
        .get<unknown>(this.pagelet.stringParam('ProductsRestEndpoint'))
        .pipe(map(data => this.mapProductData(data)));
    }
  }
 
  private mapProductData(data: unknown): string[] {
    {
      let skus: string[] = [];
 
      // if the REST response is not already an Array of SKUs
      // a given mapper function can be applied to the REST 'data' to map the data to an Array of SKUs
      skus = this.pagelet.hasParam('ProductsRestResponseMapper')
        ? Function('data', `"use strict"; return ${this.pagelet.stringParam('ProductsRestResponseMapper')}`)(data)
        : data;
 
      // limit the number of rendered products
      if (this.pagelet.hasParam('MaxNumberOfProducts')) {
        skus = skus.splice(0, this.pagelet.numberParam('MaxNumberOfProducts'));
      }
 
      return skus;
    }
  }
}