Feat/new api for v6.2

api/composables.api.md

@@ -20,6 +20,7 @@ import { NavigationElement } from '@shopware-pwa/commons/interfaces/models/conte
 import { Order } from '@shopware-pwa/commons/interfaces/models/checkout/order/Order';
 import { PaymentMethod } from '@shopware-pwa/commons/interfaces/models/checkout/payment/PaymentMethod';
 import { Product } from '@shopware-pwa/commons/interfaces/models/content/product/Product';
+import { ProductListingResult } from '@shopware-pwa/commons/interfaces/response/ProductListingResult';
 import { Ref } from '@vue/composition-api';
 import { Salutation } from '@shopware-pwa/commons/interfaces/models/system/salutation/Salutation';
 import { SessionContext } from '@shopware-pwa/commons/interfaces/response/SessionContext';
@@ -201,7 +202,7 @@ export interface UseProductListing {
 }
 
 // @alpha (undocumented)
-export const useProductListing: (initialProducts?: Product[]) => UseProductListing;
+export const useProductListing: (initialListing?: ProductListingResult | undefined) => UseProductListing;
 
 // @alpha (undocumented)
 export interface UseProductSearch {

api/shopware-6-client.api.md

@@ -24,6 +24,7 @@ import { NotFilter } from '@shopware-pwa/commons/interfaces/search/SearchFilter'
 import { Order } from '@shopware-pwa/commons/interfaces/models/checkout/order/Order';
 import { PaymentMethod } from '@shopware-pwa/commons/interfaces/models/checkout/payment/PaymentMethod';
 import { Product } from '@shopware-pwa/commons/interfaces/models/content/product/Product';
+import { ProductListingResult } from '@shopware-pwa/commons/interfaces/response/ProductListingResult';
 import { RangeFilter } from '@shopware-pwa/commons/interfaces/search/SearchFilter';
 import { Salutation } from '@shopware-pwa/commons/interfaces/models/system/salutation/Salutation';
 import { SearchCriteria } from '@shopware-pwa/commons/interfaces/search/SearchCriteria';
@@ -151,6 +152,9 @@ export function getCategories(searchCriteria?: SearchCriteria): Promise<SearchRe
 // @alpha (undocumented)
 export function getCategory(categoryId: string): Promise<Category>;
 
+// @alpha
+export const getCategoryProductsListing: (categoryId: string, searchCriteria?: SearchCriteria | undefined) => Promise<ProductListingResult>;
+
 // @beta
 export function getCustomer(): Promise<Customer | null>;
 
@@ -285,6 +289,8 @@ export interface ShopwareParams {
     // (undocumented)
     limit?: number;
     // (undocumented)
+    p?: number;
+    // (undocumented)
     page?: number;
     // (undocumented)
     sort?: string;

packages/commons/interfaces/response/ProductListingResult.ts

@@ -0,0 +1,25 @@
+import { Product } from "@shopware-pwa/commons/interfaces/models/content/product/Product";
+import { Sort } from "@shopware-pwa/commons/interfaces/search/SearchCriteria";
+import { Aggregation } from "@shopware-pwa/commons/interfaces/search/Aggregation";
+import {
+  EqualsFilter,
+  RangeFilter,
+  MultiFilter,
+  EqualsAnyFilter,
+} from "@shopware-pwa/commons/interfaces/search/SearchFilter";
+export interface ProductListingResult {
+  /**
+   * apiAlias - determines the entity name that can be used within "includes" functionality (added in store-api)
+   */
+  apiAlias: string;
+  total: number;
+  elements: Product[];
+  sorting: string;
+  page: number;
+  limit: number;
+  sortings: Sort[];
+  aggregations: Aggregation[];
+  currentFilters: Array<
+    EqualsFilter | EqualsAnyFilter | RangeFilter | MultiFilter
+  >;
+}

packages/commons/interfaces/search/SearchCriteria.ts

@@ -1,13 +1,13 @@
-import { Pagination } from "./Pagination";
+import { Pagination } from "@shopware-pwa/commons/interfaces/search/Pagination";
 import {
   EqualsFilter,
   RangeFilter,
   MultiFilter,
   EqualsAnyFilter,
-} from "./SearchFilter";
-import { Association } from "./Association";
-import { Aggregation } from "./Aggregation";
-import { TotalCountMode } from "./TotalCountMode";
+} from "@shopware-pwa/commons/interfaces/search/SearchFilter";
+import { Association } from "@shopware-pwa/commons/interfaces/search/Association";
+import { Aggregation } from "@shopware-pwa/commons/interfaces/search/Aggregation";
+import { TotalCountMode } from "@shopware-pwa/commons/interfaces/search/TotalCountMode";
 
 /**
  * @alpha

packages/composables/__tests__/useCms.spec.ts

@@ -67,6 +67,19 @@ describe("Shopware composables", () => {
     expect(error.value).toStrictEqual({ message: "Something went wrong..." });
   });
 
+  it("should performs search default pagination limit if not provided", async () => {
+    const { search, page } = useCms();
+    mockedGetPage.getPage.mockResolvedValueOnce({} as any);
+    expect(page.value).toEqual(null);
+    await search("");
+    expect(mockedGetPage.getPage).toBeCalledWith("", {
+      configuration: {
+        associations: [{ associations: [{ name: "group" }], name: "options" }],
+      },
+      pagination: { limit: 10 },
+    });
+  });
+
   it("should return activeCategoryId if it's included within the page object", async () => {
     const { categoryId, search } = useCms();
     const response: shopwareClient.PageResolverResult<any> = {

packages/composables/__tests__/useProductListing.spec.ts

@@ -37,7 +37,7 @@ describe("Composables - useProductListing", () => {
       expect(products.value).toHaveLength(0);
     });
     it("should have empty array if no products passed", async () => {
-      const { products } = useProductListing([]);
+      const { products } = useProductListing({ elements: [] } as any);
       expect(products.value).toHaveLength(0);
     });
   });
@@ -99,30 +99,57 @@ describe("Composables - useProductListing", () => {
       expect(selectedFilters.value).toHaveProperty("color");
       expect(selectedFilters.value.color).toStrictEqual([]);
     });
+
+    it("selectedFilters should append the filters array on force", async () => {
+      const {
+        selectedFilters,
+        toggleFilter,
+        resetFilters,
+      } = useProductListing();
+      resetFilters();
+
+      toggleFilter({
+        type: SearchFilterType.EQUALS,
+        value: "white",
+        field: "color",
+      } as EqualsFilter);
+
+      toggleFilter({
+        type: SearchFilterType.EQUALS,
+        value: "black",
+        field: "color",
+      } as EqualsFilter),
+        true;
+
+      expect(selectedFilters.value).toHaveProperty("color");
+      expect(selectedFilters.value.color).toStrictEqual(["white", "black"]);
+    });
   });
 
   describe("search", () => {
     it("should reset search criteria on category change event", async () => {
-      const { products, selectedFilters } = useProductListing([
-        { product: "1" } as any,
-      ]);
+      const { products, selectedFilters } = useProductListing({
+        elements: [{ product: "1" }],
+      } as any);
       expect(selectedFilters.value).toStrictEqual({});
 
       expect(products.value).toHaveLength(1);
     });
 
     it("should set loading property to false when search is done", async () => {
-      const { loading, search } = useProductListing([{ product: "1" } as any]);
+      const { loading, search } = useProductListing({
+        elements: [{ product: "1" }],
+      } as any);
       await search();
       expect(loading.value).toBe(false);
     });
 
     //
     it("should return default total and empty product listing when page resolver fails", async () => {
-      mockedGetPage.getProducts.mockResolvedValueOnce({} as any);
+      mockedGetPage.getCategoryProductsListing.mockResolvedValueOnce({} as any);
 
-      const { pagination, products, search } = useProductListing();
-      await search();
+      const { products, search, pagination } = useProductListing();
+      search();
       expect(pagination.value).toStrictEqual({
         currentPage: 1,
         perPage: 10,
@@ -132,8 +159,8 @@ describe("Composables - useProductListing", () => {
     });
 
     it("should return products if exist", async () => {
-      mockedGetPage.getProducts.mockResolvedValueOnce({
-        data: [
+      mockedGetPage.getCategoryProductsListing.mockResolvedValueOnce({
+        elements: [
           {
             id: "123456",
           },
@@ -175,18 +202,55 @@ describe("Composables - useProductListing", () => {
     it("should perform no search and leave default pagination if no change performed", async () => {
       const { pagination, changePagination } = useProductListing();
 
-      changePagination(undefined as any);
+      await changePagination(undefined as any);
       expect(pagination.value).toStrictEqual({
         currentPage: 1,
         perPage: 10,
         total: 0,
       });
     });
 
+    it("should not change pagination state to privided one once a useProductListing argument is passed hasn't any required fields", async () => {
+      const { pagination } = useProductListing({
+        page: undefined
+      } as any);
+
+      expect(pagination.value).toStrictEqual({
+        currentPage: 1,
+        perPage: 10,
+        total: 0,
+      });
+    });
+
+    it("should not change pagination state to privided one once a useProductListing argument is passed has no pagination data", async () => {
+      const { pagination } = useProductListing(undefined as any);
+
+      expect(pagination.value).toStrictEqual({
+        currentPage: 1,
+        perPage: 10,
+        total: 0,
+      });
+    });
+
+    it("should change pagination state to privided one as a useProductListing argument is passed", async () => {
+      const { pagination } = useProductListing({
+        total: 6,
+        page: 2,
+        limit: 10,
+        elements: [{ id: "123456" }],
+      } as any);
+
+      expect(pagination.value).toStrictEqual({
+        currentPage: 2,
+        perPage: 10,
+        total: 6,
+      });
+    });
+
     it("should perform change the shared pagination object if change succeeds", async () => {
       const { pagination, changePagination } = useProductListing();
 
-      changePagination(10);
+      await changePagination(10);
       expect(pagination.value).toStrictEqual({
         currentPage: 10,
         perPage: 10,