feat(composable): useProductSearch types (#880)

shopware · Apr 17, 2024 · 2ade07a · 2ade07a
1 parent 2145d0b
commit 2ade07a
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 17 deletions.
diff --git a/.changeset/cyan-bees-relate.md b/.changeset/cyan-bees-relate.md
@@ -0,0 +1,5 @@
+---
+"@shopware-pwa/composables-next": patch
+---
+
+Adjust types in `useProductSearch` composable
diff --git a/packages/composables/src/useProductSearch.ts b/packages/composables/src/useProductSearch.ts
@@ -3,6 +3,11 @@ import type { Schemas } from "#shopware";
 import { cmsAssociations } from "./cms/cmsAssociations";
 import { defu } from "defu";
 
+type UseProductSearchReturnOptions = {
+  withCmsAssociations?: boolean;
+  criteria?: Partial<Schemas["Criteria"]>;
+};
+
 export type UseProductSearchReturn = {
   /**
    * Searches for a product by its id
@@ -12,10 +17,7 @@ export type UseProductSearchReturn = {
    */
   search: (
     productId: string,
-    options?: {
-      withCmsAssociations?: boolean;
-      criteria?: Partial<Schemas["Criteria"]>;
-    },
+    options?: UseProductSearchReturnOptions,
   ) => Promise<Schemas["ProductDetailResponse"]>;
 };
 
@@ -24,23 +26,12 @@ export type UseProductSearchReturn = {
  * @public
  * @category Navigation & Routing
  */
-export function useProductSearch(): {
-  search: (
-    productId: string,
-    options?: {
-      withCmsAssociations?: boolean;
-      criteria?: Partial<Schemas["Criteria"]>;
-    },
-  ) => Promise<Schemas["ProductDetailResponse"]>;
-} {
+export function useProductSearch(): UseProductSearchReturn {
   const { apiClient } = useShopwareContext();
 
   const search = async (
     productId: string,
-    options?: {
-      withCmsAssociations?: boolean;
-      criteria?: Partial<Schemas["Criteria"]>;
-    },
+    options?: UseProductSearchReturnOptions,
   ) => {
     const associations = defu(
       options?.withCmsAssociations ? cmsAssociations : {},