feat(SW-285): Ship support for ContentPageBlocksCardsGrid

server/routers/contentstack/contentPage/output.ts

@@ -4,9 +4,13 @@ import { Lang } from "@/constants/languages"
 
 import { imageVaultAssetSchema } from "../schemas/imageVault"
 
-import { ContentBlocksTypenameEnum } from "@/types/components/content/enums"
+import {
+  CardsGridEnum,
+  ContentBlocksTypenameEnum,
+} from "@/types/components/content/enums"
 import { ImageVaultAsset } from "@/types/components/imageVault"
 import { Embeds } from "@/types/requests/embeds"
+import { PageLinkEnum } from "@/types/requests/pageLinks"
 import { RTEEmbedsEnum } from "@/types/requests/rte"
 import { EdgesWithTotalCount } from "@/types/requests/utils/edges"
 import { RTEDocument } from "@/types/rte/node"
@@ -41,9 +45,74 @@ const contentPageShortcuts = z.object({
   }),
 })
 
+// TODO: this is a separate entity, should be in a separate file.
+const cardBlock = z.object({
+  __typename: z.literal(CardsGridEnum.Card),
+  heading: z.string().nullable(),
+  body_text: z.string().nullable(),
+  background_image: z.any(),
+  scripted_top_title: z.string().nullable(),
+  primaryButton: z
+    .object({
+      openInNewTab: z.boolean(),
+      title: z.string(),
+      href: z.string(),
+      isExternal: z.boolean(),
+    })
+    .optional(),
+  secondaryButton: z
+    .object({
+      openInNewTab: z.boolean(),
+      title: z.string(),
+      href: z.string(),
+      isExternal: z.boolean(),
+    })
+    .optional(),
+  system: z.object({
+    locale: z.nativeEnum(Lang),
+    uid: z.string(),
+  }),
+})
+
+const loyaltyCardBlock = z.object({
+  __typename: z.literal(CardsGridEnum.LoyaltyCard),
+  heading: z.string().nullable(),
+  body_text: z.string().nullable(),
+  image: z.any(),
+  link: z
+    .object({
+      openInNewTab: z.boolean(),
+      title: z.string(),
+      href: z.string(),
+      isExternal: z.boolean(),
+    })
+    .optional(),
+  system: z.object({
+    locale: z.nativeEnum(Lang),
+    uid: z.string(),
+  }),
+})
+
+const contentPageCardsItems = z.discriminatedUnion("__typename", [
+  loyaltyCardBlock,
+  cardBlock,
+])
+
+const contentPageCards = z.object({
+  __typename: z.literal(ContentBlocksTypenameEnum.ContentPageBlocksCardsGrid),
+  cards_grid: z.object({
+    title: z.string().nullable(),
+    preamble: z.string().nullable(),
+    layout: z.enum(["twoColumnGrid", "threeColumnGrid", "twoPlusOne"]),
+    theme: z.enum(["one", "two", "three"]).nullable(),
+    cards: z.array(contentPageCardsItems),
+  }),
+})
+
 const contentPageBlockItem = z.discriminatedUnion("__typename", [
   contentPageBlockTextContent,
   contentPageShortcuts,
+  contentPageCards,
 ])
 
 type BlockContentRaw = z.infer<typeof contentPageBlockTextContent>
@@ -57,7 +126,22 @@ export interface RteBlockContent extends BlockContentRaw {
 }
 
 export type Shortcuts = z.infer<typeof contentPageShortcuts>
-export type Block = RteBlockContent | Shortcuts
+
+type LoyaltyCardRaw = z.infer<typeof loyaltyCardBlock>
+type LoyaltyCard = Omit<LoyaltyCardRaw, "image"> & {
+  image?: ImageVaultAsset
+}
+type CardRaw = z.infer<typeof cardBlock>
+type Card = Omit<CardRaw, "background_image"> & {
+  backgroundImage?: ImageVaultAsset
+}
+type CardsGridRaw = z.infer<typeof contentPageCards>
+export type CardsGrid = Omit<CardsGridRaw, "cards"> & {
+  cards: (LoyaltyCard | Card)[]
+}
+export type CardsRaw = CardsGrid["cards_grid"]["cards"][number]
+
+export type Block = RteBlockContent | Shortcuts | CardsGrid
 
 // Content Page Schema and types
 export const validateContentPageSchema = z.object({
@@ -86,6 +170,20 @@ export type ContentPage = Omit<ContentPageRaw, "blocks" | "hero_image"> & {
   blocks: Block[]
 }
 
+const pageConnectionRefs = z.object({
+  edges: z.array(
+    z.object({
+      node: z.object({
+        __typename: z.nativeEnum(PageLinkEnum),
+        system: z.object({
+          content_type_uid: z.string(),
+          uid: z.string(),
+        }),
+      }),
+    })
+  ),
+})
+
 const rteConnectionRefs = z.object({
   edges: z.array(
     z.object({
@@ -100,6 +198,42 @@ const rteConnectionRefs = z.object({
   ),
 })
 
+const cardBlockRefs = z.object({
+  __typename: z.literal(CardsGridEnum.Card),
+  primary_button: z
+    .object({
+      linkConnection: pageConnectionRefs,
+    })
+    .nullable(),
+  secondary_button: z
+    .object({
+      linkConnection: pageConnectionRefs,
+    })
+    .nullable(),
+  system: z.object({
+    content_type_uid: z.string(),
+    uid: z.string(),
+  }),
+})
+
+const loyaltyCardBlockRefs = z.object({
+  __typename: z.literal(CardsGridEnum.LoyaltyCard),
+  link: z
+    .object({
+      linkConnection: pageConnectionRefs,
+    })
+    .nullable(),
+  system: z.object({
+    content_type_uid: z.string(),
+    uid: z.string(),
+  }),
+})
+
+const cardGridCardsRef = z.discriminatedUnion("__typename", [
+  loyaltyCardBlockRefs,
+  cardBlockRefs,
+])
+
 const contentPageBlockTextContentRefs = z.object({
   __typename: z.literal(ContentBlocksTypenameEnum.ContentPageBlocksContent),
   content: z.object({
@@ -109,6 +243,13 @@ const contentPageBlockTextContentRefs = z.object({
   }),
 })
 
+const contentPageCardsRefs = z.object({
+  __typename: z.literal(ContentBlocksTypenameEnum.ContentPageBlocksCardsGrid),
+  cards_grid: z.object({
+    cardConnection: cardGridCardsRef,
+  }),
+})
+
 const contentPageShortcutsRefs = z.object({
   __typename: z.literal(ContentBlocksTypenameEnum.ContentPageBlocksShortcuts),
   shortcuts: z.object({
@@ -123,6 +264,7 @@ const contentPageShortcutsRefs = z.object({
 const contentPageBlockRefsItem = z.discriminatedUnion("__typename", [
   contentPageBlockTextContentRefs,
   contentPageShortcutsRefs,
+  contentPageCardsRefs,
 ])
 
 export const validateContentPageRefsSchema = z.object({

server/routers/contentstack/contentPage/query.ts

@@ -18,10 +18,14 @@ import {
   fetchContentPageRefs,
   generatePageTags,
   getContentPageCounter,
+  makeButtonObject,
   validateContentPageRefs,
 } from "./utils"
 
-import { ContentBlocksTypenameEnum } from "@/types/components/content/enums"
+import {
+  CardsGridEnum,
+  ContentBlocksTypenameEnum,
+} from "@/types/components/content/enums"
 import {
   TrackingChannelEnum,
   TrackingSDKPageData,
@@ -85,6 +89,38 @@ export const contentPageQueryRouter = router({
                   })),
                 },
               }
+            case ContentBlocksTypenameEnum.ContentPageBlocksCardsGrid:
+              return {
+                ...block,
+                cards_grid: {
+                  ...block.cards_grid,
+                  cards: block.cards_grid.cardConnection.edges.map(
+                    ({ node: card }: { node: any }) => {
+                      switch (card.__typename) {
+                        case CardsGridEnum.Card:
+                          return {
+                            ...card,
+                            backgroundImage: makeImageVaultImage(
+                              card.background_image
+                            ),
+                            primaryButton: card.has_primary_button
+                              ? makeButtonObject(card.primary_button)
+                              : undefined,
+                            secondaryButton: card.has_secondary_button
+                              ? makeButtonObject(card.secondary_button)
+                              : undefined,
+                          }
+                        case CardsGridEnum.LoyaltyCard:
+                          return {
+                            ...card,
+                            image: makeImageVaultImage(card.image),
+                            link: makeButtonObject(card.link),
+                          }
+                      }
+                    }
+                  ),
+                },
+              }
             default:
               return block
           }

server/routers/contentstack/contentPage/utils.ts

@@ -6,6 +6,7 @@ import { request } from "@/lib/graphql/request"
 import { notFound } from "@/server/errors/trpc"
 
 import { generateTag, generateTags } from "@/utils/generateTag"
+import { removeMultipleSlashes } from "@/utils/url"
 
 import { removeEmptyObjects } from "../../utils"
 import { ContentPageRefsDataRaw, validateContentPageRefsSchema } from "./output"
@@ -130,3 +131,29 @@ export function getConnections(refs: ContentPageRefsDataRaw) {
   }
   return connections
 }
+
+export function makeButtonObject(button: any) {
+  if (!button) return null
+
+  const isContenstackLink =
+    button?.is_contentstack_link || button.linkConnection?.edges?.length
+  const linkConnnectionNode = isContenstackLink
+    ? button.linkConnection.edges[0]?.node
+    : null
+
+  return {
+    openInNewTab: button?.open_in_new_tab,
+    title:
+      button.cta_text ||
+      (linkConnnectionNode
+        ? linkConnnectionNode.title
+        : button.external_link.title),
+    href: linkConnnectionNode
+      ? linkConnnectionNode.web?.original_url ||
+        removeMultipleSlashes(
+          `/${linkConnnectionNode.system.locale}/${linkConnnectionNode.url}`
+        )
+      : button.external_link.href,
+    isExternal: !isContenstackLink,
+  }
+}