@treely/strapi-slices 7.5.1 → 7.5.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@treely/strapi-slices",
-  "version": "7.5.1",
+  "version": "7.5.3",
   "license": "MIT",
   "author": "Tree.ly FlexCo",
   "description": "@treely/strapi-slices is a open source library maintained by Tree.ly.",

package/src/integrations/strapi/getAllSlugsFromStrapi.test.ts

@@ -2,32 +2,13 @@ import MockAxios from 'jest-mock-axios';
 import getAllSlugsFromStrapi from './getAllSlugsFromStrapi';
 import StrapiPage from '../../models/strapi/StrapiPage';
 import { strapiPageMock } from '../../test/strapiMocks/strapiPage';
-import getAvailableLocalesFromStrapi from './getAvailableLocalesFromStrapi';
-
-jest.mock('./getAvailableLocalesFromStrapi', () => ({
-  __esModule: true,
-  default: jest.fn(),
-}));
 
 describe('The getAllSlugsFromStrapi function', () => {
   afterEach(() => {
     MockAxios.reset();
-    jest.clearAllMocks();
   });
 
   it('returns all slugs and creates a fallback for locales that dont have a translation', async () => {
-    (getAvailableLocalesFromStrapi as jest.Mock).mockResolvedValue([
-      'en',
-      'de',
-      'hu',
-    ]);
-
-    const slugsPromise = getAllSlugsFromStrapi<StrapiPage>('/api/pages', [
-      'en',
-      'de',
-      'hu',
-    ]);
-
     // This page is available in 'de', 'en', and 'hu'
     MockAxios.get
       .mockResolvedValueOnce({ data: { data: [strapiPageMock] } }) // english
@@ -44,9 +25,13 @@ describe('The getAllSlugsFromStrapi function', () => {
           ],
         },
       })
-      .mockResolvedValueOnce({ data: { data: [] } });
+      .mockRejectedValueOnce({ response: { status: 404 } }); // Hungarian version is missing (404)
 
-    const slugs = await slugsPromise;
+    const slugs = await getAllSlugsFromStrapi<StrapiPage>('/api/pages', [
+      'en',
+      'de',
+      'hu',
+    ]);
 
     expect(slugs).toStrictEqual([
       { locale: 'en', slug: strapiPageMock.attributes.slug },
@@ -54,5 +39,7 @@ describe('The getAllSlugsFromStrapi function', () => {
       // Fallback for 'hu' gets created
       { locale: 'hu', slug: strapiPageMock.attributes.slug },
     ]);
+
+    expect(MockAxios.get).toHaveBeenCalledTimes(3);
   });
 });

package/src/integrations/strapi/getAllSlugsFromStrapi.ts

@@ -6,7 +6,6 @@ import {
 import IStrapiResponse from '../../models/strapi/IStrapiResponse';
 import IStrapiData from '../../models/strapi/IStrapiData';
 import LocalizedEntity from '../../models/LocalizedEntity';
-import getAvailableLocalesFromStrapi from './getAvailableLocalesFromStrapi';
 
 interface Options {
   filters?: Record<string, any>;
@@ -19,30 +18,33 @@ const getAllSlugsFromStrapi = async <T extends LocalizedEntity<'slug'>>(
   locales: string[],
   { filters = {} }: Options = { filters: {} }
 ): Promise<Slug[]> => {
-  const allLocales = await getAvailableLocalesFromStrapi();
-
-  const slugPromises = allLocales.map((locale) => {
-    const params: Record<string, any> = {
-      locale,
-      'pagination[pageSize]': STRAPI_DEFAULT_PAGE_SIZE,
-      filters,
-    };
-
-    return strapiClient.get<IStrapiResponse<IStrapiData<T>[]>>(path, {
-      params,
-    });
-  });
+  const slugPromises = locales.map((locale) =>
+    strapiClient
+      .get<IStrapiResponse<IStrapiData<T>[]>>(path, {
+        params: {
+          locale: locale,
+          'pagination[pageSize]': STRAPI_DEFAULT_PAGE_SIZE,
+          filters,
+        },
+      })
+      .then((response) =>
+        response.data.data.map((page) => ({
+          slug: page.attributes.slug,
+          locale: page.attributes.locale,
+        }))
+      )
+      // when a collection type for a requested locale does not exist, Strapi returns a 404. In this case, we return an empty array instead of throwing an error
+      .catch((error) => {
+        if (error.response?.status === 404) {
+          return [];
+        }
+        throw error;
+      })
+  );
 
   const slugResults = await Promise.all(slugPromises);
 
-  let allSlugs = slugResults
-    .map((result) =>
-      result.data.data.map((page) => ({
-        slug: page.attributes.slug,
-        locale: page.attributes.locale,
-      }))
-    )
-    .flat();
+  let allSlugs = slugResults.flat();
 
   // Identify missing locales for each slug
   const missingLocales = locales.flatMap((locale) => {

package/src/integrations/strapi/getStrapiCollectionType.test.ts

@@ -2,12 +2,6 @@ import MockAxios from 'jest-mock-axios';
 import getStrapiCollectionType from './getStrapiCollectionType';
 import StrapiPage from '../../models/strapi/StrapiPage';
 import { strapiPageMock } from '../../test/strapiMocks/strapiPage';
-import getAvailableLocalesFromStrapi from './getAvailableLocalesFromStrapi';
-
-jest.mock('./getAvailableLocalesFromStrapi', () => ({
-  __esModule: true,
-  default: jest.fn(),
-}));
 
 describe('The getStrapiCollectionType function', () => {
   const germanStrapiPageMock = {
@@ -25,14 +19,7 @@ describe('The getStrapiCollectionType function', () => {
   });
 
   it('returns the localized versions if available', async () => {
-    (getAvailableLocalesFromStrapi as jest.Mock).mockResolvedValue([
-      'en',
-      'de',
-      'hu',
-    ]);
-
     MockAxios.get
-      .mockResolvedValueOnce({ data: { data: [strapiPageMock] } }) // english
       .mockResolvedValueOnce({
         data: {
           data: [
@@ -46,6 +33,7 @@ describe('The getStrapiCollectionType function', () => {
           ],
         },
       })
+      .mockResolvedValueOnce({ data: { data: [strapiPageMock] } }) // english
       .mockResolvedValueOnce({ data: { data: [] } });
 
     const pages = getStrapiCollectionType<StrapiPage, 'slug'>(
@@ -66,16 +54,10 @@ describe('The getStrapiCollectionType function', () => {
   });
 
   it('returns the english versions if no localized version is available', async () => {
-    (getAvailableLocalesFromStrapi as jest.Mock).mockResolvedValue([
-      'en',
-      'de',
-      'hu',
-    ]);
-
     MockAxios.get
       .mockResolvedValueOnce({ data: { data: [strapiPageMock] } }) // english
-      .mockResolvedValueOnce({ data: { data: [] } })
-      .mockResolvedValueOnce({ data: { data: [] } });
+      .mockRejectedValueOnce({ response: { status: 404 } }) // Hungarian version is missing (404)
+      .mockRejectedValueOnce({ response: { status: 404 } }); // German version is missing (404)
 
     const pages = getStrapiCollectionType<StrapiPage, 'slug'>(
       '/api/pages',

package/src/integrations/strapi/getStrapiCollectionType.ts

@@ -6,7 +6,6 @@ import {
 import IStrapiData from '../../models/strapi/IStrapiData';
 import IStrapiResponse from '../../models/strapi/IStrapiResponse';
 import LocalizedEntity from '../../models/LocalizedEntity';
-import getAvailableLocalesFromStrapi from './getAvailableLocalesFromStrapi';
 
 interface Options {
   locale?: string;
@@ -24,52 +23,58 @@ const getStrapiCollectionType = async <
   { locale = 'en', preview = false, filters = {} }: Options
 ): Promise<IStrapiData<T>[]> => {
   const cache = preview ? false : undefined;
-  const allLocales = await getAvailableLocalesFromStrapi();
 
-  if (!allLocales.includes(STRAPI_FALLBACK_LOCALE)) {
-    allLocales.push(STRAPI_FALLBACK_LOCALE);
-  }
+  const sharedParams = {
+    pLevel: '6',
+    'pagination[pageSize]': STRAPI_DEFAULT_PAGE_SIZE,
+    filters,
+    ...(preview ? { publicationState: 'preview' } : {}),
+  };
 
-  const promises = allLocales.map((loc) => {
-    const params: Record<string, any> = {
-      pLevel: '6',
-      locale: loc,
-      'pagination[pageSize]': STRAPI_DEFAULT_PAGE_SIZE,
-      filters,
-    };
-
-    if (preview) {
-      params.publicationState = 'preview';
-    }
-
-    return strapiClient.get<IStrapiResponse<IStrapiData<T>[]>>(path, {
-      params,
+  const requestedLocaleData = await strapiClient
+    .get<IStrapiResponse<IStrapiData<T>[]>>(path, {
+      params: {
+        ...sharedParams,
+        locale,
+      },
       cache,
+    })
+    .then((response) => response.data.data)
+    // when a collection type for a requested locale does not exist, Strapi returns a 404. In this case, we return an empty array instead of throwing an error
+    .catch((error) => {
+      if (error.response?.status === 404) {
+        return [];
+      }
+      throw error;
     });
-  });
-
-  const responses = await Promise.all(promises);
 
-  const results = responses.flatMap((response) => response.data.data);
-
-  const localizedResponses = results.filter(
-    (d) => d.attributes.locale === locale
-  );
-
-  const fallbackResponses = results.filter(
-    (d) => d.attributes.locale === STRAPI_FALLBACK_LOCALE
-  );
+  const fallbackLocaleData = await strapiClient
+    .get<IStrapiResponse<IStrapiData<T>[]>>(path, {
+      params: {
+        ...sharedParams,
+        locale: STRAPI_FALLBACK_LOCALE,
+      },
+      cache,
+    })
+    .then((response) => response.data.data)
+    // when a collection type for a requested locale does not exist, Strapi returns a 404. In this case, we return an empty array instead of throwing an error
+    .catch((error) => {
+      if (error.response?.status === 404) {
+        return [];
+      }
+      throw error;
+    });
 
-  const result = fallbackResponses.map((fallbackResponse) => {
-    const localizedResponse = localizedResponses.find(
+  const results = fallbackLocaleData.map((fallbackLocaleDataEntry) => {
+    const requestedLocale = requestedLocaleData.find(
       (localized) =>
-        localized.attributes[key] === fallbackResponse.attributes[key]
+        localized.attributes[key] === fallbackLocaleDataEntry.attributes[key]
     );
 
-    return localizedResponse || fallbackResponse;
+    return requestedLocale || fallbackLocaleDataEntry;
   });
 
-  return result;
+  return results;
 };
 
 export default getStrapiCollectionType;

package/dist/integrations/strapi/getAvailableLocalesFromStrapi.d.ts

@@ -1,2 +0,0 @@
-declare const getAvailableLocalesFromStrapi: () => Promise<string[]>;
-export default getAvailableLocalesFromStrapi;

package/src/integrations/strapi/getAvailableLocalesFromStrapi.test.ts

@@ -1,22 +0,0 @@
-import getAvailableLocalesFromStrapi from './getAvailableLocalesFromStrapi';
-import strapiClient from './strapiClient';
-
-jest.mock('./strapiClient', () => ({
-  get: jest.fn(),
-}));
-
-describe('The getAvailableLocales function', () => {
-  it('should fetch available locales and return them correctly', async () => {
-    const mockResponse = {
-      data: [{ code: 'en' }, { code: 'de' }, { code: 'hu' }],
-    };
-
-    (strapiClient.get as jest.Mock).mockResolvedValue(mockResponse);
-
-    const locales = await getAvailableLocalesFromStrapi();
-
-    expect(locales).toEqual(['en', 'de', 'hu']);
-    expect(strapiClient.get).toHaveBeenCalledWith('/i18n/locales');
-    expect(strapiClient.get).toHaveBeenCalledTimes(1);
-  });
-});

package/src/integrations/strapi/getAvailableLocalesFromStrapi.ts

@@ -1,8 +0,0 @@
-import strapiClient from './strapiClient';
-
-const getAvailableLocalesFromStrapi = async (): Promise<string[]> => {
-  const { data } = await strapiClient.get('/i18n/locales');
-  return data.map((locale: { code: string }) => locale.code);
-};
-
-export default getAvailableLocalesFromStrapi;