@treely/strapi-slices 5.11.3 → 5.13.0

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/PageProps.ts

@@ -28,6 +28,7 @@ interface PageProps {
   topBanner?: StrapiTopBanner;
   customerStories: IStrapiData<StrapiCustomerStory>[];
   preview: boolean;
+  isFallbackLocale: boolean;
 }
 
 export default PageProps;

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;

package/src/utils/mergeGlobalAndStrapiBlogPostData.test.ts

@@ -7,7 +7,7 @@ import portfolioProjectMock from '../test/integrationMocks/portfolioProjectMock'
 
 describe('The mergeGlobalAndStrapiBlogPostData util', () => {
   it('returns the global metadata if there is no page metadata', () => {
-    const pageDataWithoutMetadata = {
+    const blogPostDataWithoutMetadata = {
       ...strapiBlogPostMock,
       attributes: {
         ...strapiBlogPostMock.attributes,
@@ -18,7 +18,7 @@ describe('The mergeGlobalAndStrapiBlogPostData util', () => {
     const result = mergeGlobalAndStrapiBlogPostData(
       getStaticPropsContextMock,
       minimalGlobalData,
-      pageDataWithoutMetadata,
+      blogPostDataWithoutMetadata,
       [],
       []
     );
@@ -32,10 +32,11 @@ describe('The mergeGlobalAndStrapiBlogPostData util', () => {
     expect(result.metadata.description).toBe(
       minimalGlobalData.attributes.metadata.description
     );
+    expect(result.isFallbackLocale).toBeFalsy();
   });
 
   it('returns the pages metadata if the page data includes metadata', () => {
-    const pageDataWithMetadata = {
+    const blogPostDataWithMetadata = {
       ...strapiBlogPostMock,
       data: {
         ...strapiBlogPostMock,
@@ -49,7 +50,7 @@ describe('The mergeGlobalAndStrapiBlogPostData util', () => {
     const result = mergeGlobalAndStrapiBlogPostData(
       getStaticPropsContextMock,
       minimalGlobalData,
-      pageDataWithMetadata,
+      blogPostDataWithMetadata,
       [],
       []
     );
@@ -198,4 +199,24 @@ describe('The mergeGlobalAndStrapiBlogPostData util', () => {
     expect(result.blogPosts).toStrictEqual([]);
     expect(result.projects).toStrictEqual([portfolioProjectMock]);
   });
+
+  it('returns isFallbackLocale=true if the blog post is in a different language', () => {
+    const blogPostDataInDe = {
+      ...strapiBlogPostMock,
+      attributes: {
+        ...strapiBlogPostMock.attributes,
+        locale: 'de',
+      },
+    };
+
+    const result = mergeGlobalAndStrapiBlogPostData(
+      getStaticPropsContextMock,
+      minimalGlobalData,
+      blogPostDataInDe,
+      [],
+      []
+    );
+
+    expect(result.isFallbackLocale).toBeTruthy();
+  });
 });

package/src/utils/mergeGlobalAndStrapiBlogPostData.ts

@@ -74,6 +74,7 @@ const mergeGlobalAndStrapiBlogPostData = (
     topBanner: post?.attributes.topBanner || global.attributes.topBanner,
     customerStories: [],
     preview: !!context.preview,
+    isFallbackLocale: context.locale !== post.attributes.locale,
   };
 };
 

package/src/utils/mergeGlobalAndStrapiCustomerStoryData.test.ts

@@ -6,7 +6,7 @@ import { strapiMetadataMock } from '../test/strapiMocks/strapiMetadata';
 
 describe('The mergeGlobalAndStrapiCustomerStoryData util', () => {
   it('returns the global metadata if there is no page metadata', () => {
-    const pageDataWithoutMetadata = {
+    const customerStoryDataWithoutMetadata = {
       ...strapiCustomerStoryMock,
       attributes: {
         ...strapiCustomerStoryMock.attributes,
@@ -17,7 +17,7 @@ describe('The mergeGlobalAndStrapiCustomerStoryData util', () => {
     const result = mergeGlobalAndStrapiCustomerStoryData(
       getStaticPropsContextMock,
       minimalGlobalData,
-      pageDataWithoutMetadata,
+      customerStoryDataWithoutMetadata,
       []
     );
 
@@ -30,10 +30,11 @@ describe('The mergeGlobalAndStrapiCustomerStoryData util', () => {
     expect(result.metadata.description).toBe(
       minimalGlobalData.attributes.metadata.description
     );
+    expect(result.isFallbackLocale).toBeFalsy();
   });
 
   it('returns the pages metadata if the page data includes metadata', () => {
-    const pageDataWithMetadata = {
+    const customerStoryDataWithMetadata = {
       ...strapiCustomerStoryMock,
       data: {
         ...strapiCustomerStoryMock,
@@ -47,7 +48,7 @@ describe('The mergeGlobalAndStrapiCustomerStoryData util', () => {
     const result = mergeGlobalAndStrapiCustomerStoryData(
       getStaticPropsContextMock,
       minimalGlobalData,
-      pageDataWithMetadata,
+      customerStoryDataWithMetadata,
       []
     );
 
@@ -167,4 +168,23 @@ describe('The mergeGlobalAndStrapiCustomerStoryData util', () => {
 
     expect(result.customerStories).toStrictEqual([strapiCustomerStoryMock]);
   });
+
+  it('returns isFallbackLocale=true if the customer story is in a different language', () => {
+    const customerStoryDataInDe = {
+      ...strapiCustomerStoryMock,
+      attributes: {
+        ...strapiCustomerStoryMock.attributes,
+        locale: 'de',
+      },
+    };
+
+    const result = mergeGlobalAndStrapiCustomerStoryData(
+      getStaticPropsContextMock,
+      minimalGlobalData,
+      customerStoryDataInDe,
+      []
+    );
+
+    expect(result.isFallbackLocale).toBeTruthy();
+  });
 });

package/src/utils/mergeGlobalAndStrapiCustomerStoryData.ts

@@ -68,6 +68,7 @@ const mergeGlobalAndStrapiCustomerStoryData = (
       customerStory?.attributes.topBanner || global.attributes.topBanner,
     blogPosts: [],
     preview: !!context.preview,
+    isFallbackLocale: context.locale !== customerStory.attributes.locale,
   };
 };
 

package/src/utils/mergeGlobalAndStrapiPageData.test.ts

@@ -35,6 +35,7 @@ describe('The mergeGlobalAndStrapiPageData util', () => {
     expect(result.metadata.description).toBe(
       minimalGlobalData.attributes.metadata.description
     );
+    expect(result.isFallbackLocale).toBeFalsy();
   });
 
   it('returns the pages metadata if the page data includes metadata', () => {
@@ -317,4 +318,25 @@ describe('The mergeGlobalAndStrapiPageData util', () => {
     expect(result.blogPosts).toStrictEqual([]);
     expect(result.customerStories).toStrictEqual([]);
   });
+
+  it('returns isFallbackLocale=true if the page is in a different language', () => {
+    const pageDataInDe = {
+      ...strapiPageMock,
+      attributes: {
+        ...strapiPageMock.attributes,
+        locale: 'de',
+      },
+    };
+
+    const result = mergeGlobalAndStrapiPageData(
+      getStaticPropsContextMock,
+      minimalGlobalData,
+      pageDataInDe,
+      [],
+      [],
+      []
+    );
+
+    expect(result.isFallbackLocale).toBeTruthy();
+  });
 });

package/src/utils/mergeGlobalAndStrapiPageData.ts

@@ -89,6 +89,7 @@ const mergeGlobalAndStrapiPageData = (
     topBanner: page?.attributes.topBanner || global.attributes.topBanner,
     customerStories: returnCustomerStories ? customerStories : [],
     preview: !!context.preview,
+    isFallbackLocale: context.locale !== page.attributes.locale,
   };
 };
 

package/src/utils/mergeGlobalAndStrapiProjectData.test.ts

@@ -8,7 +8,7 @@ import mergeGlobalAndStrapiProjectData from './mergeGlobalAndStrapiProjectData';
 
 describe('The mergeGlobalAndStrapiProjectData util', () => {
   it('returns the global metadata if there is no page metadata', () => {
-    const pageDataWithoutMetadata = {
+    const projectDataWithoutMetadata = {
       ...strapiProjectMock,
       attributes: {
         ...strapiProjectMock.attributes,
@@ -19,7 +19,7 @@ describe('The mergeGlobalAndStrapiProjectData util', () => {
     const result = mergeGlobalAndStrapiProjectData(
       getStaticPropsContextMock,
       minimalGlobalData,
-      pageDataWithoutMetadata,
+      projectDataWithoutMetadata,
       [],
       []
     );
@@ -33,10 +33,11 @@ describe('The mergeGlobalAndStrapiProjectData util', () => {
     expect(result.metadata.description).toBe(
       minimalGlobalData.attributes.metadata.description
     );
+    expect(result.isFallbackLocale).toBeFalsy();
   });
 
   it('returns the pages metadata if the page data includes metadata', () => {
-    const pageDataWithMetadata = {
+    const projectDataWithMetadata = {
       ...strapiProjectMock,
       attributes: {
         ...strapiProjectMock.attributes,
@@ -47,7 +48,7 @@ describe('The mergeGlobalAndStrapiProjectData util', () => {
     const result = mergeGlobalAndStrapiProjectData(
       getStaticPropsContextMock,
       minimalGlobalData,
-      pageDataWithMetadata,
+      projectDataWithMetadata,
       [],
       []
     );
@@ -280,4 +281,24 @@ describe('The mergeGlobalAndStrapiProjectData util', () => {
     expect(result.blogPosts).toStrictEqual([]);
     expect(result.projects).toStrictEqual([portfolioProjectMock]);
   });
+
+  it('returns isFallbackLocale=true if the project is in a different language', () => {
+    const projectDataInDe = {
+      ...strapiProjectMock,
+      attributes: {
+        ...strapiProjectMock.attributes,
+        locale: 'de',
+      },
+    };
+
+    const result = mergeGlobalAndStrapiProjectData(
+      getStaticPropsContextMock,
+      minimalGlobalData,
+      projectDataInDe,
+      [],
+      []
+    );
+
+    expect(result.isFallbackLocale).toBeTruthy();
+  });
 });

package/src/utils/mergeGlobalAndStrapiProjectData.ts

@@ -83,6 +83,7 @@ const mergeGlobalAndStrapiProject = (
     topBanner: project?.attributes.topBanner || global.attributes.topBanner,
     customerStories: [],
     preview: !!context.preview,
+    isFallbackLocale: context.locale !== project.attributes.locale,
   };
 };