Merge pull request 'feature/landing-stubs 0.1.0 (#33)' (#34) from feature/landing-stubs into main

Reviewed-on: #34
Reviewed-by: Primakov Alexandr Alexandrovich <primakovpro@gmail.com>

README.md

@@ -45,10 +45,12 @@
 ### MVP1
 
 **1. Landing**
+
 - преимущества сервиса
   - оставить заявку (редирект на Страницу оформления заказа)
 
 **2. Страница для оформления заказа**
+
 - форма
   - номер машины (mask input)
   - цвет машины
@@ -58,10 +60,12 @@
 - после заполнения редирект на страницу с деталями заказа
 
 **3. Страница с деталями заказа**
+
 - описание заказа
 - детали заказа (id, статус)
 
 **3. АРМ оператора**
+
 - список заказов (RUD)
   - id заказа
   - статус заказа (готово / не готово)
@@ -72,7 +76,6 @@
   - кнопка "Добавить"
   - кнопка "Удалить"
 
-
 ### Built With
 
 [![React][React.js]][React-url]
@@ -103,6 +106,14 @@
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
+## Instructions
+### Stubs types generation
+1. generate types with json-literal-typer (should be installed globally)
+   ```sh
+   npx json-literal-typer -i <path to json> -o <path to output ts-file>
+   ```
+2. export default type from output file
+
 <!-- PARTICIPANTS -->
 
 ## Participants

package-lock.json

@@ -6964,20 +6964,6 @@
             "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==",
             "license": "ISC"
         },
-        "node_modules/fsevents": {
-            "version": "2.3.3",
-            "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz",
-            "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==",
-            "hasInstallScript": true,
-            "license": "MIT",
-            "optional": true,
-            "os": [
-                "darwin"
-            ],
-            "engines": {
-                "node": "^8.16.0 || ^10.6.0 || >=11.0.0"
-            }
-        },
         "node_modules/function-bind": {
             "version": "1.1.2",
             "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz",

src/components/landing/BenefitsSection/BenefitsSection.tsx

@@ -1,52 +1,29 @@
 import React, { FC } from 'react';
 import { useTranslation } from 'react-i18next';
-import {
-  MdEco,
-  MdMiscellaneousServices,
-  MdPlace,
-  MdHandshake,
-} from 'react-icons/md';
 import { Heading, HStack, List, Text, VStack } from '@chakra-ui/react';
 
 import { CtaButton, PageSection } from '../';
 
 import { ListItem } from './ListItem';
+import { BenefitsSectionProps } from './types';
+import { iconsMap } from './helper';
 
-export const BenefitsSection: FC = () => {
+export const BenefitsSection: FC<BenefitsSectionProps> = ({
-  const { t } = useTranslation('~', {
+  data: { heading, description, list } = {},
-    keyPrefix: 'dry-wash.landing.benefits-section',
+}) => {
-  });
+  const { t } = useTranslation('~', { keyPrefix: 'dry-wash.landing' });
-
-  const listData = [
-    {
-      Icon: MdEco,
-      children: t('list.0'),
-    },
-    {
-      Icon: MdMiscellaneousServices,
-      children: t('list.1'),
-    },
-    {
-      Icon: MdPlace,
-      children: t('list.2'),
-    },
-    {
-      Icon: MdHandshake,
-      children: t('list.3'),
-    },
-  ];
 
   return (
     <PageSection>
       <VStack w='full' spacing={2}>
-        <Heading as='h2'>{t('heading')}</Heading>
+        <Heading as='h2'>{t(heading)}</Heading>
-        <Text>
+        <Text>{t(description)}</Text>
-          {t('description')}
-        </Text>
       </VStack>
       <List display='flex' flexDirection='column' spacing={3}>
-        {listData.map((props, i) => (
+        {list.map((itemKey, i) => (
-          <ListItem key={i} {...props} />
+          <ListItem key={i} Icon={iconsMap[itemKey]}>
+            {t(itemKey)}
+          </ListItem>
         ))}
       </List>
       <HStack w='full' justify='flex-end'>

src/components/landing/BenefitsSection/helper.ts

@@ -0,0 +1,13 @@
+import { IconType } from "react-icons";
+import { MdEco, MdMiscellaneousServices, MdPlace, MdHandshake } from "react-icons/md";
+
+import { ArrElement } from "../../../lib";
+
+import { BenefitsList } from "./types";
+
+export const iconsMap: Record<ArrElement<BenefitsList>, IconType> = {
+  "benefits-section.list.0": MdEco,
+  "benefits-section.list.1": MdMiscellaneousServices,
+  "benefits-section.list.2": MdPlace,
+  "benefits-section.list.3": MdHandshake,
+};

src/components/landing/BenefitsSection/index.ts

@@ -1 +1,2 @@
+export type { BenefitsSectionProps } from './types';
 export { BenefitsSection } from './BenefitsSection';

src/components/landing/BenefitsSection/types.ts

@@ -0,0 +1,14 @@
+export type BenefitsList = [
+  'benefits-section.list.0',
+  'benefits-section.list.1',
+  'benefits-section.list.2',
+  'benefits-section.list.3',
+];
+
+export type BenefitsSectionProps = {
+  data: {
+    heading: 'benefits-section.heading';
+    description: 'benefits-section.description';
+    list: BenefitsList;
+  };
+};

src/components/landing/CtaButton/CtaButton.tsx

@@ -6,7 +6,7 @@ import { ButtonProps, Button } from '@chakra-ui/react';
 import { URLs } from '../../../__data__/urls';
 
 export const CtaButton: FC<ButtonProps> = (props) => {
-  const { t } = useTranslation();
+  const { t } = useTranslation('~', { keyPrefix: 'dry-wash.landing' });
 
   return (
     <Button
@@ -15,7 +15,7 @@ export const CtaButton: FC<ButtonProps> = (props) => {
       colorScheme='primary'
       {...props}
     >
-      {t('~:dry-wash.landing.make-order-button')}
+      {t('make-order-button')}
     </Button>
   );
 };

src/components/landing/HeroSection/HeroSection.tsx

@@ -1,22 +1,23 @@
 import React, { FC } from 'react';
 import { useTranslation } from 'react-i18next';
-import { Box, Heading, Text, Center, VStack, BoxProps } from '@chakra-ui/react';
+import { Box, Heading, Text, Center, VStack } from '@chakra-ui/react';
 
 import { DemoVideoPosterImg } from '../../../assets/images';
 import { CtaButton, SiteLogo, PageSection } from '../';
 
-type HeroSectionProps = Pick<BoxProps, 'flexShrink'>;
+import { HeroSectionProps } from './types';
 
-export const HeroSection: FC<HeroSectionProps> = ({ flexShrink }) => {
+export const HeroSection: FC<HeroSectionProps> = ({
-  const { t } = useTranslation('~', {
+  data: { headline, description, video } = {},
-    keyPrefix: 'dry-wash.landing.hero-section',
+  flexShrink,
-  });
+}) => {
+  const { t } = useTranslation('~', { keyPrefix: 'dry-wash.landing' });
 
   return (
     <Box flexShrink={flexShrink} as='header' pos='relative' zIndex={0}>
       <Box
         as='video'
-        src={`${__webpack_public_path__}/remote-assets/demo.mp4`}
+        src={`${__webpack_public_path__}/remote-assets/${video}`}
         poster={DemoVideoPosterImg}
         autoPlay
         loop
@@ -47,14 +48,14 @@ export const HeroSection: FC<HeroSectionProps> = ({ flexShrink }) => {
             color='white'
             __css={{ textWrap: 'balance' }}
           >
-            {t('headline')}
+            {t(headline)}
           </Heading>
           <Text
             textAlign='center'
             __css={{ textWrap: 'balance' }}
             color='white'
           >
-            {t('description')}
+            {t(description)}
           </Text>
         </VStack>
         <CtaButton size='lg' />

src/components/landing/HeroSection/types.ts

@@ -0,0 +1,9 @@
+import { BoxProps } from "@chakra-ui/react";
+
+export type HeroSectionProps = {
+  data: {
+    headline: 'hero-section.headline';
+    description: 'hero-section.description';
+    video: string;
+  };
+} & Pick<BoxProps, 'flexShrink'>;

src/components/landing/SocialProofSection/SocialProofSection.tsx

@@ -5,15 +5,16 @@ import { Heading, HStack } from '@chakra-ui/react';
 import { CtaButton, PageSection } from '../';
 
 import { ReviewsSlider } from './ReviewsSlider';
+import { SocialProofSectionProps } from './types';
 
-export const SocialProofSection: FC = () => {
+export const SocialProofSection: FC<SocialProofSectionProps> = ({
-  const { t } = useTranslation('~', {
+  data: { heading } = {},
-    keyPrefix: 'dry-wash.landing.social-proof-section',
+}) => {
-  });
+  const { t } = useTranslation('~', { keyPrefix: 'dry-wash.landing' });
 
   return (
     <PageSection>
-      <Heading as='h2'>{t('heading')}</Heading>
+      <Heading as='h2'>{t(heading)}</Heading>
       <ReviewsSlider />
       <HStack w='full' justify='flex-end'>
         <CtaButton />

src/components/landing/SocialProofSection/index.ts

@@ -1 +1,2 @@
+export type { SocialProofSectionProps } from './types';
 export { SocialProofSection } from './SocialProofSection';

src/components/landing/SocialProofSection/types.ts

@@ -0,0 +1,5 @@
+export type SocialProofSectionProps = {
+  data: {
+    heading: 'social-proof-section.heading';
+  };
+};

src/lib/index.ts

@@ -0,0 +1 @@
+export * from './types';

src/lib/types.ts

@@ -0,0 +1,41 @@
+/**
+ * @example type Output = ArrElement<['a', 'b', 'c']>;
+ * // "a" | "b" | "c"
+ */
+export type ArrElement<ArrType> = ArrType extends readonly (infer ElementType)[]
+  ? ElementType
+  : never;
+
+/** 
+ * @example type Output = Split<'a.b1' | 'a.b2', '.'>;
+ * // ["a", "b1"] | ["a", "b2"]
+*/
+type Split<S extends string, D extends string> =
+  S extends `${infer A}${D}${infer B}` ? [A, ...Split<B, D>] : [S];
+
+/** 
+ * @example type Output = NestedObject<["a", "b1"] | ["a", "b2"]>;
+ * // { a: { b1: string; }; } | { a: { b2: string; }; }
+*/
+type NestedObject<T extends string[]> =
+  T extends [infer Head, ...infer Tail] ?
+    Head extends string ?
+      { [key in Head]: NestedObject<Tail extends string[] ? Tail : []> } : never :
+    string;
+
+/** 
+ * @example type Output = UnionToIntersection<{ a: { b1: string; }; } | { a: { b2: string; }; }>;
+ * // { a: { b1: string; }; } & { a: { b2: string; }; }
+*/
+type UnionToIntersection<U> =
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+
+/** 
+ * @example type Output = CreateTree<'a.b1' | 'a.b2', '.'>;
+ * // { a: { b1: string; }; } & { a: { b2: string; }; }
+*/
+export type CreateTree<T> =
+  UnionToIntersection<T extends infer U ?
+    U extends string ?
+      NestedObject<Split<U, '.'>> : never : never>;

src/models/i18next.d.ts

@@ -1,24 +1,5 @@
 import defaultLocale from '../../locales/ru.json';
-
+import { CreateTree } from '../lib';
-type Split<S extends string, D extends string> =
-  S extends `${infer A}${D}${infer B}` ? [A, ...Split<B, D>] : [S];
-
-type NestedObject<T extends string[]> =
-  T extends [infer Head, ...infer Tail] ?
-    Head extends string ?
-      { [key in Head]: NestedObject<Tail extends string[] ? Tail : []> } : never :
-    string;
-
-// Основная утилита для обработки union type
-type CreateTree<T> =
-  UnionToIntersection<T extends infer U ?
-    U extends string ?
-      NestedObject<Split<U, '.'>> : never : never>;
-
-// Утилита для объединения типов
-type UnionToIntersection<U> =
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
 
 type LanguageResource = CreateTree<keyof typeof defaultLocale>;
 
@@ -26,6 +7,6 @@ declare module "i18next" {
   interface CustomTypeOptions {
     resources: {
       '~': LanguageResource
-    };
+    }
   }
 }

src/models/landing/index.ts

@@ -0,0 +1 @@
+export * from './stubs';

src/models/landing/stubs/index.ts

@@ -0,0 +1 @@
+export { default as LandingSuccessStub } from './success';

src/models/landing/stubs/success.ts

@@ -0,0 +1,27 @@
+// Generated by json-literal-typer
+// <-- BEGIN
+interface HeroXsection {
+  description: "hero-section.description";
+  headline: "hero-section.headline";
+  video: "demo.mp4";
+}
+
+interface Sections {
+  description?: "benefits-section.description";
+  heading: "benefits-section.heading" | "social-proof-section.heading";
+  list?: ("benefits-section.list.0" | "benefits-section.list.1" | "benefits-section.list.2" | "benefits-section.list.3")[];
+  type: "benefits-section" | "social-proof-section";
+}
+
+interface Body {
+  "hero-section": HeroXsection;
+  sections: Sections[];
+}
+
+interface Root {
+  body: Body;
+  success: true;
+}
+// END -->
+
+export default Root;

src/pages/landing/index.tsx

@@ -8,6 +8,12 @@ import {
   SocialProofSection,
 } from '../../components/landing';
 import { LandingThemeProvider } from '../../containers';
+import { LandingSuccessStub } from '../../models/landing';
+import landingSuccessStubJson from '../../../stubs/json/landing/success.json';
+
+import { isBenefitsSectionData, isSocialProofSectionData } from './types';
+
+const landingSuccessStub = landingSuccessStubJson as LandingSuccessStub;
 
 const Page: FC = () => {
   return (
@@ -21,10 +27,19 @@ const Page: FC = () => {
         centerContent
       >
         <VStack w='full' h='full' alignItems='stretch' flexGrow={1}>
-          <HeroSection flexShrink={0} />
+          <HeroSection
+            data={landingSuccessStub['body']['hero-section']}
+            flexShrink={0}
+          />
           <VStack as='main' flexGrow={1}>
-            <BenefitsSection />
+            {landingSuccessStub.body.sections.map(({ type, ...data }, i) => {
-            <SocialProofSection />
+              if (isBenefitsSectionData(type, data)) {
+                return <BenefitsSection key={i} data={data} />;
+              }
+              if (isSocialProofSectionData(type, data)) {
+                return <SocialProofSection key={i} data={data} />;
+              }
+            })}
           </VStack>
           <Footer />
         </VStack>

src/pages/landing/types.ts

@@ -0,0 +1,15 @@
+import LandingSuccess from "../../../stubs/json/landing/success.json";
+import { BenefitsSectionProps, SocialProofSectionProps } from "../../components/landing";
+import { ArrElement } from "../../lib";
+
+type SectionsItemData = ArrElement<typeof LandingSuccess['body']['sections']>;
+type SectionType = SectionsItemData['type'];
+type SectionData = Omit<SectionsItemData, 'type'>;
+
+export const isBenefitsSectionData = (type: SectionType, data: SectionData): data is BenefitsSectionProps['data'] => {
+  return type === 'benefits-section';
+};
+
+export const isSocialProofSectionData = (type: SectionType, data: SectionData): data is SocialProofSectionProps['data'] => {
+  return type === 'social-proof-section';
+};

stubs/json/landing/success.json

@@ -0,0 +1,27 @@
+{
+  "success": true,
+  "body": {
+    "hero-section": {
+      "headline": "hero-section.headline",
+      "description": "hero-section.description",
+      "video": "demo.mp4"
+    },
+    "sections": [
+      {
+        "type": "benefits-section",
+        "heading": "benefits-section.heading",
+        "description": "benefits-section.description",
+        "list": [
+          "benefits-section.list.0",
+          "benefits-section.list.1",
+          "benefits-section.list.2",
+          "benefits-section.list.3"
+        ]
+      },
+      {
+        "type": "social-proof-section",
+        "heading": "social-proof-section.heading"
+      }
+    ]
+  }
+}