feat: update fetchLanguages to use management client and adjust test cases

- Refactored fetchLanguages to remove token parameter and utilize managementClient for API calls.
- Updated related test cases to reflect changes in fetchLanguages function signature.
- Added a new command to createManagementClient for better management of API interactions.
- Adjusted launch configuration for debugging with a new space ID.

Author: alvarosabu

.vscode/launch.json

@@ -74,7 +74,7 @@
       "request": "launch",
       "name": "Debug Pull languages",
       "program": "${workspaceFolder}/dist/index.mjs",
-      "args": ["languages", "pull", "--space", "2950182323", "--path", ".storyblok"],
+      "args": ["languages", "pull", "--space", "295018", "--path", ".storyblok"],
       "cwd": "${workspaceFolder}",
       "console": "integratedTerminal",
       "sourceMaps": true,

src/commands/languages/actions.test.ts

@@ -5,10 +5,12 @@ import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, it, vi }
 import { fetchLanguages, saveLanguagesToFile } from './actions';
 import { FetchError } from 'src/utils/fetch';
 import { APIError } from 'src/utils';
+import { createManagementClient } from '../../api';
 
 const handlers = [
   http.get('https://api.storyblok.com/v1/spaces/12345', async ({ request }) => {
     const token = request.headers.get('Authorization');
+    console.log('msw token', token);
     if (token === 'valid-token') {
       return HttpResponse.json({
         space: {
@@ -30,6 +32,12 @@ const handlers = [
   }),
 ];
 
+// Mock the managementClient module
+vi.mock('src/api', () => ({
+  managementClient: vi.fn(),
+  createManagementClient: vi.fn(),
+}));
+
 const server = setupServer(...handlers);
 
 beforeAll(() => server.listen({ onUnhandledRequest: 'error' }));
@@ -40,14 +48,19 @@ afterAll(() => server.close());
 vi.mock('node:fs');
 vi.mock('node:fs/promises');
 
-describe('pull languages actions', () => {
+describe.only('pull languages actions', () => {
   beforeEach(() => {
     vi.clearAllMocks();
     vol.reset();
   });
 
   describe('fetchLanguages', () => {
-    it('should pull languages successfully with a valid token', async () => {
+    it('should pull languages successfully', async () => {
+      createManagementClient({
+        accessToken: 'valid-token',
+        region: 'eu',
+      });
+
       const mockResponse = {
         default_lang_name: 'en',
         languages: [
@@ -61,17 +74,26 @@ describe('pull languages actions', () => {
           },
         ],
       };
-      const result = await fetchLanguages('12345', 'valid-token', 'eu');
+      const result = await fetchLanguages('12345');
       expect(result).toEqual(mockResponse);
     });
   });
-  it.skip('should throw an masked error for invalid token', async () => {
-    // TODO: Fix this test, is the only of it's kind that is not working, it's not clear why
-    // Test return "Compared values have no visual difference." but fails anyway
-    const error = new FetchError('Non-JSON response', { status: 401, statusText: 'Unauthorized', data: null });
-    await expect(fetchLanguages('12345', 'invalid-token', 'eu')).rejects.toThrow(
-      new APIError('unauthorized', 'pull_languages', error, `The user is not authorized to access the API`),
-    );
+  it('should throw an masked error for invalid token', async () => {
+    createManagementClient({
+      accessToken: 'invalid-token',
+      region: 'eu',
+    });
+
+    await expect(fetchLanguages('12345')).rejects.toMatchObject({
+      name: 'API Error',
+      errorId: 'unauthorized',
+      cause: 'The user is not authorized to access the API',
+      code: 401,
+      messageStack: [
+        'Failed to pull languages',
+        'The user is not authorized to access the API',
+      ],
+    });
   });
 
   describe('saveLanguagesToFile', () => {

src/commands/languages/actions.ts

@@ -1,22 +1,16 @@
 import { join } from 'node:path';
 import { handleAPIError, handleFileSystemError } from '../../utils';
-import { customFetch } from '../../utils/fetch';
 import { resolvePath, saveToFile } from '../../utils/filesystem';
 import type { PullLanguagesOptions } from './constants';
-import type { RegionCode } from '../../constants';
 import type { SpaceInternationalization } from '../../types';
-import { getStoryblokUrl } from '../../utils/api-routes';
+import { managementClient } from '../../api';
 
-export const fetchLanguages = async (space: string, token: string, region: RegionCode): Promise<SpaceInternationalization | undefined> => {
+export const fetchLanguages = async (space: string): Promise<SpaceInternationalization | undefined> => {
   try {
-    const url = getStoryblokUrl(region);
-    const response = await customFetch<{
+    const { get } = managementClient();
+    const response = await get<{
       space: SpaceInternationalization;
-    }>(`${url}/spaces/${space}`, {
-      headers: {
-        Authorization: token,
-      },
-    });
+    }>(`/spaces/${space}`);
 
     return {
       default_lang_name: response.space.default_lang_name,

src/commands/languages/index.test.ts

@@ -91,7 +91,7 @@ describe('languagesCommand', () => {
 
         vi.mocked(fetchLanguages).mockResolvedValue(mockResponse);
         await languagesCommand.parseAsync(['node', 'test', 'pull', '--space', '12345']);
-        expect(fetchLanguages).toHaveBeenCalledWith('12345', 'valid-token', 'eu');
+        expect(fetchLanguages).toHaveBeenCalledWith('12345');
         expect(saveLanguagesToFile).toHaveBeenCalledWith('12345', mockResponse, {
           path: undefined,
         });
@@ -165,7 +165,7 @@ describe('languagesCommand', () => {
 
         vi.mocked(fetchLanguages).mockResolvedValue(mockResponse);
         await languagesCommand.parseAsync(['node', 'test', 'pull', '--space', '12345', '--path', '/tmp']);
-        expect(fetchLanguages).toHaveBeenCalledWith('12345', 'valid-token', 'eu');
+        expect(fetchLanguages).toHaveBeenCalledWith('12345');
         expect(saveLanguagesToFile).toHaveBeenCalledWith('12345', mockResponse, {
           path: '/tmp',
         });
@@ -196,7 +196,7 @@ describe('languagesCommand', () => {
 
         vi.mocked(fetchLanguages).mockResolvedValue(mockResponse);
         await languagesCommand.parseAsync(['node', 'test', 'pull', '--space', '12345', '--filename', 'custom-languages']);
-        expect(fetchLanguages).toHaveBeenCalledWith('12345', 'valid-token', 'eu');
+        expect(fetchLanguages).toHaveBeenCalledWith('12345');
         expect(saveLanguagesToFile).toHaveBeenCalledWith('12345', mockResponse, {
           filename: 'custom-languages',
           path: undefined,
@@ -228,7 +228,7 @@ describe('languagesCommand', () => {
 
         vi.mocked(fetchLanguages).mockResolvedValue(mockResponse);
         await languagesCommand.parseAsync(['node', 'test', 'pull', '--space', '12345', '--suffix', 'custom-suffix']);
-        expect(fetchLanguages).toHaveBeenCalledWith('12345', 'valid-token', 'eu');
+        expect(fetchLanguages).toHaveBeenCalledWith('12345');
         expect(saveLanguagesToFile).toHaveBeenCalledWith('12345', mockResponse, {
           suffix: 'custom-suffix',
           path: undefined,

src/commands/languages/index.ts

@@ -6,6 +6,7 @@ import { fetchLanguages, saveLanguagesToFile } from './actions';
 import chalk from 'chalk';
 import type { PullLanguagesOptions } from './constants';
 import { Spinner } from '@topcli/spinner';
+import { createManagementClient } from '../../api';
 
 const program = getProgram(); // Get the shared singleton instance
 
@@ -43,13 +44,18 @@ languagesCommand
       return;
     }
 
+    createManagementClient({
+      accessToken: state.password,
+      region: state.region,
+    });
+
     const spinner = new Spinner({
       verbose: !isVitest,
     });
     try {
       spinner.start(`Fetching ${chalk.hex(colorPalette.LANGUAGES)('languages')}`);
 
-      const internationalization = await fetchLanguages(space, state.password, state.region);
+      const internationalization = await fetchLanguages(space);
 
       if (!internationalization || internationalization.languages?.length === 0) {
         konsola.warn(`No languages found in the space ${space}`);

src/index.ts

@@ -13,6 +13,7 @@ import './commands/types';
 import pkg from '../package.json';
 
 import { colorPalette } from './constants';
+import { createManagementClient } from './api';
 
 export * from './types/storyblok';
 
@@ -33,6 +34,10 @@ program.on('command:*', () => {
   program.help();
 });
 
+program.command('test').action(() => {
+  const client = createManagementClient();
+});
+
 try {
   program.parse(process.argv);
 }

src/types/index.ts

@@ -17,7 +17,7 @@ export interface Language {
   name: string;
   code: string;
   fallback_code?: string;
-  ai_translation_code: string | null;
+  ai_translation_code?: string | null;
 }
 
 export interface SpaceInternationalization {

src/types/storyblok.ts

@@ -1,3 +1,38 @@
+export interface StoryblokBaseResponse<T> {
+  cv: number;
+  rels: string[];
+  links: string[];
+  stories: StoryblokStory<T>[];
+}
+
+export interface StoryblokContentBase {
+  _uid?: string;
+  component: string;
+  _editable?: string;
+}
+
+export interface StoryblokStory<T> {
+  id: number;
+  uuid: string;
+  name: string;
+  slug: string;
+  full_slug: string;
+  path: string;
+  content: StoryblokContentBase & T;
+  position: number;
+  tag_list: string[];
+  is_startpage: boolean;
+  group_id: string;
+  parent_id: number;
+  meta_title: string;
+  meta_description: string;
+  published: boolean;
+  created_at: string;
+  updated_at: string;
+  published_at: string;
+  alternates: string[];
+}
+
 export type StoryblokPropertyType = 'asset' | 'multiasset' | 'multilink' | 'table' | 'richtext';
 
 export interface StoryblokAsset {