@treely/strapi-slices 5.11.2 → 5.12.0

package/src/integrations/strapi/getStrapiCollectionType.ts

@@ -0,0 +1,61 @@
+import strapiClient from './strapiClient';
+import {
+  STRAPI_DEFAULT_PAGE_SIZE,
+  STRAPI_FALLBACK_LOCALE,
+} from '../../constants/strapi';
+import IStrapiData from '../../models/strapi/IStrapiData';
+import IStrapiResponse from '../../models/strapi/IStrapiResponse';
+import LocalizedEntity from '../../models/LocalizedEntity';
+
+interface Options {
+  locale?: string;
+  slug?: string;
+  preview?: boolean;
+  filters?: Record<string, any>;
+}
+
+const getStrapiCollectionType = async <
+  T extends LocalizedEntity<K>,
+  K extends string
+>(
+  path: string,
+  key: K,
+  { locale = 'en', preview = false, filters = {} }: Options
+): Promise<IStrapiData<T>[]> => {
+  const params: Record<string, any> = {
+    populate: 'deep,6',
+    locale: 'all',
+    'pagination[pageSize]': STRAPI_DEFAULT_PAGE_SIZE,
+    filters,
+  };
+
+  if (preview) {
+    params.publicationState = 'preview';
+  }
+
+  const { data } = await strapiClient.get<IStrapiResponse<IStrapiData<T>[]>>(
+    path,
+    { params }
+  );
+
+  const localizedResponses = data.data.filter(
+    (d) => d.attributes.locale === locale
+  );
+
+  const fallbackResponses = data.data.filter(
+    (d) => d.attributes.locale === STRAPI_FALLBACK_LOCALE
+  );
+
+  const responses = fallbackResponses.map((fallbackResponse) => {
+    const localizedResponse = localizedResponses.find(
+      (localized) =>
+        localized.attributes[key] === fallbackResponse.attributes[key]
+    );
+
+    return localizedResponse || fallbackResponse;
+  });
+
+  return responses;
+};
+
+export default getStrapiCollectionType;

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

@@ -0,0 +1,53 @@
+import MockAxios from 'jest-mock-axios';
+import getStrapiSingleType from './getStrapiSingleType';
+import StrapiPage from '../../models/strapi/StrapiPage';
+import minimalGlobalData from '../../test/strapiMocks/minimalGlobalData';
+import { waitFor } from '@testing-library/react';
+
+describe('The getStrapiSingleType function', () => {
+  afterEach(() => {
+    MockAxios.reset();
+  });
+
+  it('returns the localized versions if available', async () => {
+    const globalPromise = getStrapiSingleType<StrapiPage>('/api/global', {});
+
+    MockAxios.mockResponseFor(
+      { url: '/api/global' },
+      { data: { data: minimalGlobalData } }
+    );
+
+    const global = await globalPromise;
+
+    expect(global).toStrictEqual(minimalGlobalData);
+  });
+
+  it('returns the localized versions if available', async () => {
+    const globalPromise = getStrapiSingleType<StrapiPage>('/api/global', {
+      locale: 'de',
+    });
+
+    let firstRequestInfo = MockAxios.lastReqGet();
+
+    MockAxios.mockError(
+      { isAxiosError: true, response: { status: 404 } },
+      firstRequestInfo
+    );
+
+    let secondRequestInfo;
+
+    await waitFor(() => {
+      secondRequestInfo = MockAxios.lastReqGet();
+      expect(secondRequestInfo).toBeDefined();
+    });
+
+    MockAxios.mockResponse(
+      { data: { data: minimalGlobalData } },
+      secondRequestInfo
+    );
+
+    const global = await globalPromise;
+
+    await expect(global).toStrictEqual(minimalGlobalData);
+  });
+});

package/src/integrations/strapi/getStrapiSingleType.ts

@@ -0,0 +1,50 @@
+import { AxiosResponse } from 'axios';
+import strapiClient from './strapiClient';
+import {
+  STRAPI_DEFAULT_PAGE_SIZE,
+  STRAPI_FALLBACK_LOCALE,
+} from '../../constants/strapi';
+import IStrapiData from '../../models/strapi/IStrapiData';
+import IStrapiResponse from '../../models/strapi/IStrapiResponse';
+
+interface Options {
+  locale?: string;
+  preview?: boolean;
+  filters?: Record<string, any>;
+}
+
+const getStrapiSingleType = async <T>(
+  path: string,
+  { locale = 'en', preview = false, filters = {} }: Options
+): Promise<IStrapiData<T>> => {
+  const params: Record<string, any> = {
+    populate: 'deep,6',
+    locale,
+    'pagination[pageSize]': STRAPI_DEFAULT_PAGE_SIZE,
+    filters,
+  };
+
+  if (preview) {
+    params.publicationState = 'preview';
+  }
+
+  let response: AxiosResponse<IStrapiResponse<IStrapiData<T>>>;
+
+  try {
+    response = await strapiClient.get(path, { params });
+    return response.data.data;
+  } catch (error: any) {
+    if (error.isAxiosError && error.response?.status === 404) {
+      // Retry request with fallback locale
+      response = await strapiClient.get(path, {
+        params: { ...params, locale: STRAPI_FALLBACK_LOCALE },
+      });
+
+      return response.data.data;
+    }
+
+    throw error;
+  }
+};
+
+export default getStrapiSingleType;

package/src/models/Locale.ts

@@ -1,3 +1,5 @@
-type Locale = 'en' | 'de';
+/** @deprecated Removing this type because this project now falls back to
+ *              English if a locale is not supported. */
+type Locale = string;
 
 export default Locale;

package/src/models/LocalizedEntity.ts

@@ -0,0 +1,9 @@
+import Locale from './Locale';
+
+type LocalizedEntity<Key extends string = any> = {
+  [key in Key]: any;
+} & {
+  locale: Locale;
+};
+
+export default LocalizedEntity;

package/src/models/strapi/StrapiGlobal.ts

@@ -1,3 +1,4 @@
+import Locale from '../Locale';
 import IStrapi from './IStrapi';
 import IStrapiData from './IStrapiData';
 import StrapiBanner from './StrapiBanner';
@@ -9,6 +10,7 @@ import StrapiNavMenu from './StrapiNavMenu';
 import StrapiTopBanner from './StrapiTopBanner';
 
 interface StrapiGlobal {
+  locale: Locale;
   metadata: StrapiMetadata;
   favicon: IStrapi<IStrapiData<StrapiMedia>>;
   metaTitleSuffix: string;

package/src/test/strapiMocks/minimalGlobalData.ts

@@ -6,6 +6,7 @@ import { strapiMetadataMock } from './strapiMetadata';
 const minimalGlobalData: IStrapiData<StrapiGlobal> = {
   id: 1,
   attributes: {
+    locale: 'en',
     metadata: strapiMetadataMock,
     favicon: { data: strapiMediaMock },
     metaTitleSuffix: 'Meta title suffix',

package/src/utils/getMessages.ts

@@ -0,0 +1,18 @@
+import { STRAPI_FALLBACK_LOCALE } from '../constants/strapi';
+import rootMessagesDe from '../rootMessages.de';
+import rootMessagesEn from '../rootMessages.en';
+
+const messages = {
+  en: rootMessagesEn,
+  de: rootMessagesDe,
+};
+
+const getMessages = (locale: string) => {
+  const messagesLocale = Object.keys(messages).includes(`${locale}`)
+    ? (locale as keyof typeof messages)
+    : STRAPI_FALLBACK_LOCALE;
+
+  return messages[messagesLocale];
+};
+
+export default getMessages;