feat(r&w): add hide authors

owid · Mar 15, 2024 · 2e9fee4 · 2e9fee4
1 parent 451c52e
commit 2e9fee4
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 2 deletions.
diff --git a/db/model/Gdoc/enrichedToRaw.ts b/db/model/Gdoc/enrichedToRaw.ts
@@ -372,6 +372,7 @@ export function enrichedBlockToRawBlock(
                     type: b.type,
                     value: {
                         heading: b.heading,
+                        "hide-authors": b["hide-authors"].toString(),
                         primary: b.primary.map((enriched) =>
                             enrichedLinkToRawLink(enriched)
                         ),

diff --git a/db/model/Gdoc/exampleEnrichedBlocks.ts b/db/model/Gdoc/exampleEnrichedBlocks.ts
@@ -366,6 +366,7 @@ export const enrichedBlockExamples: Record<
         type: "research-and-writing",
         parseErrors: [],
         heading: "Featured Work",
+        "hide-authors": true,
         primary: [
             {
                 value: {

diff --git a/db/model/Gdoc/rawToArchie.ts b/db/model/Gdoc/rawToArchie.ts
@@ -496,6 +496,7 @@ function* rawResearchAndWritingToArchieMLString(
     }
     yield "{.research-and-writing}"
     yield* propertyToArchieMLString("heading", block.value)
+    yield* propertyToArchieMLString("hide-authors", block.value)
     if (primary) {
         yield "[.primary]"
         if (isArray(primary)) {

diff --git a/db/model/Gdoc/rawToEnriched.ts b/db/model/Gdoc/rawToEnriched.ts
@@ -1640,6 +1640,7 @@ function parseResearchAndWritingBlock(
     const createError = (
         error: ParseError,
         heading = "",
+        hideAuthors = false,
         primary = [
             {
                 value: { url: "" },
@@ -1662,6 +1663,7 @@ function parseResearchAndWritingBlock(
     ): EnrichedBlockResearchAndWriting => ({
         type: "research-and-writing",
         heading,
+        "hide-authors": hideAuthors,
         primary,
         secondary,
         more,
@@ -1719,6 +1721,15 @@ function parseResearchAndWritingBlock(
         } else return createLinkError(`Malformed link data: ${typeof rawLink}`)
     }
 
+    if (
+        raw.value["hide-authors"] &&
+        !["true", "false"].includes(raw.value["hide-authors"])
+    ) {
+        parseErrors.push({
+            message: `"hide-authors" must be true or false if present`,
+        })
+    }
+
     if (!raw.value.primary)
         return createError({ message: "Missing primary link" })
     const primary: EnrichedBlockResearchAndWritingLink[] = []
@@ -1778,6 +1789,7 @@ function parseResearchAndWritingBlock(
     return {
         type: "research-and-writing",
         heading: raw.value.heading,
+        "hide-authors": raw.value["hide-authors"] === "true",
         primary,
         secondary,
         more,

diff --git a/packages/@ourworldindata/types/src/gdocTypes/ArchieMlComponents.ts b/packages/@ourworldindata/types/src/gdocTypes/ArchieMlComponents.ts
@@ -544,6 +544,7 @@ export type RawBlockResearchAndWriting = {
     type: "research-and-writing"
     value: {
         heading?: string
+        "hide-authors"?: string
         // We're migrating these to be arrays, but have to support the old use-case until it's done
         primary?:
             | RawBlockResearchAndWritingLink
@@ -581,6 +582,7 @@ export type EnrichedBlockLatestWork = {
 export type EnrichedBlockResearchAndWriting = {
     type: "research-and-writing"
     heading?: string
+    "hide-authors": boolean
     primary: EnrichedBlockResearchAndWritingLink[]
     secondary: EnrichedBlockResearchAndWritingLink[]
     more?: EnrichedBlockResearchAndWritingRow

diff --git a/site/gdocs/components/ResearchAndWriting.tsx b/site/gdocs/components/ResearchAndWriting.tsx
@@ -28,6 +28,7 @@ function ResearchAndWritingLink(
         shouldHideThumbnail?: boolean
         shouldHideThumbnailSm?: boolean
         shouldHideSubtitle?: boolean
+        shouldHideAuthors?: boolean
     }
 ) {
     let {
@@ -43,6 +44,7 @@ function ResearchAndWritingLink(
         shouldHideThumbnailSm = false,
         isSmall = false,
         shouldHideSubtitle = false,
+        shouldHideAuthors = false,
         className,
     } = props
     const { linkedDocument, errorMessage } = useLinkedDocument(url)
@@ -110,7 +112,7 @@ function ResearchAndWritingLink(
                     {subtitle}
                 </p>
             ) : null}
-            {authors ? (
+            {authors && !shouldHideAuthors ? (
                 <p className="research-and-writing-link__authors body-3-medium-italic">
                     {formatAuthors({ authors })}
                 </p>
@@ -134,7 +136,16 @@ const parseLatestWorkToResearchAndWritingLink = (
 }
 
 export function ResearchAndWriting(props: ResearchAndWritingProps) {
-    const { heading, primary, secondary, more, rows, latest, className } = props
+    const {
+        heading,
+        "hide-authors": hideAuthors,
+        primary,
+        secondary,
+        more,
+        rows,
+        latest,
+        className,
+    } = props
 
     const slug = heading ? slugify(heading) : RESEARCH_AND_WRITING_ID
 
@@ -176,6 +187,7 @@ export function ResearchAndWriting(props: ResearchAndWritingProps) {
                         <ResearchAndWritingLink
                             className="span-cols-6 span-sm-cols-12"
                             key={i}
+                            shouldHideAuthors={hideAuthors}
                             {...link}
                         />
                     ))}
@@ -184,6 +196,7 @@ export function ResearchAndWriting(props: ResearchAndWritingProps) {
                             key={i}
                             className="span-cols-3 span-md-cols-6 span-sm-cols-12"
                             isSmall
+                            shouldHideAuthors={hideAuthors}
                             {...link}
                         />
                     ))}
@@ -198,6 +211,7 @@ export function ResearchAndWriting(props: ResearchAndWritingProps) {
                         {row.articles.map((link, i) => (
                             <ResearchAndWritingLink
                                 shouldHideSubtitle
+                                shouldHideAuthors={hideAuthors}
                                 isSmall
                                 className="span-cols-1"
                                 key={i}
@@ -217,6 +231,7 @@ export function ResearchAndWriting(props: ResearchAndWritingProps) {
                             <ResearchAndWritingLink
                                 shouldHideThumbnail
                                 shouldHideSubtitle
+                                shouldHideAuthors={hideAuthors}
                                 isSmall
                                 className="span-cols-1"
                                 key={i}
@@ -236,6 +251,7 @@ export function ResearchAndWriting(props: ResearchAndWritingProps) {
                             <ResearchAndWritingLink
                                 isSmall
                                 shouldHideThumbnailSm
+                                shouldHideAuthors={hideAuthors}
                                 className="span-cols-1"
                                 key={i}
                                 {...link}