support depth in getNavigationQuery

packages/client/src/restapi/navigation/get.test.tsx

@@ -39,4 +39,21 @@ describe('[GET] Navigation', () => {
 
     expect(result.current.error).toBeDefined();
   });
+
+  test('Depth parameter', async () => {
+    const path = '/';
+    const depth = 3;
+    const { result } = renderHook(
+      () => useQuery(getNavigationQuery({ path, depth })),
+      {
+        wrapper: createWrapper(),
+      },
+    );
+
+    await waitFor(() => expect(result.current.isSuccess).toBe(true));
+
+    expect(result.current.data?.['@id']).toBe(
+      'http://localhost:55001/plone/@navigation?expand.navigation.depth=3',
+    );
+  });
 });

packages/client/src/restapi/navigation/get.ts

@@ -5,6 +5,7 @@ import { z } from 'zod';
 
 const getNavigationSchema = z.object({
   path: z.string(),
+  depth: z.number().optional(),
 });
 
 export type NavigationArgs = z.infer<typeof getNavigationSchema> & {
@@ -13,23 +14,32 @@ export type NavigationArgs = z.infer<typeof getNavigationSchema> & {
 
 export const getNavigation = async ({
   path,
+  depth,
   config,
 }: NavigationArgs): Promise<NavigationResponse> => {
   const validatedArgs = getNavigationSchema.parse({
     path,
+    depth,
   });
 
   const options: ApiRequestParams = {
     config,
     params: {},
   };
 
-  const navigationPath = `${validatedArgs.path}/@navigation`;
+  let navigationPath = `${validatedArgs.path}/@navigation`;
+  if (validatedArgs.depth) {
+    navigationPath += `?expand.navigation.depth=${validatedArgs.depth}`;
+  }
 
   return apiRequest('get', navigationPath, options);
 };
 
-export const getNavigationQuery = ({ path, config }: NavigationArgs) => ({
-  queryKey: [path, 'get', 'navigation'],
-  queryFn: () => getNavigation({ path, config }),
+export const getNavigationQuery = ({
+  path,
+  depth,
+  config,
+}: NavigationArgs) => ({
+  queryKey: [path, depth, 'get', 'navigation'],
+  queryFn: () => getNavigation({ path, depth, config }),
 });