fix(ES-549): categories type (#1525)

vuestorefront · May 10, 2024 · 3065ee7 · 3065ee7
1 parent 101d990
commit 3065ee7
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/.changeset/grumpy-papayas-obey.md b/.changeset/grumpy-papayas-obey.md
@@ -0,0 +1,5 @@
+---
+"@vue-storefront/magento-api": patch
+---
+
+[ADDED] `CategoriesQuery` type for `categories` endpoint.
diff --git a/packages/api-client/src/api/categories/index.ts b/packages/api-client/src/api/categories/index.ts
@@ -6,6 +6,8 @@ import categoriesQuery from "./categories";
 import { Context } from "../../types/context";
 import getHeaders from "../getHeaders";
 
+export type CategoriesQuery = Required<Pick<Query, "categories">>;
+
 /**
  * Fetch list of all categories matching specified filters
  *
@@ -64,15 +66,15 @@ export async function categories(
   params: QueryCategoriesArgs,
   customQuery: CustomQuery = { categories: "categories" },
   customHeaders: CustomHeaders = {}
-): Promise<ApolloQueryResult<Query["categories"]>> {
+): Promise<ApolloQueryResult<CategoriesQuery>> {
   const { categories: categoriesGQL } = context.extendQuery(customQuery, {
     categories: {
       query: categoriesQuery,
       variables: { ...params },
     },
   });
 
-  return context.client.query<Query["categories"], QueryCategoriesArgs>({
+  return context.client.query<CategoriesQuery, QueryCategoriesArgs>({
     query: gql`
       ${categoriesGQL.query}
     `,