Skip to content

Commit

Permalink
refactor: rename AssetMapEntry -> AssetMap
Browse files Browse the repository at this point in the history
  • Loading branch information
marcelgerber committed Feb 4, 2025
1 parent 53e7e38 commit 937fb28
Show file tree
Hide file tree
Showing 13 changed files with 43 additions and 46 deletions.
18 changes: 9 additions & 9 deletions baker/GrapherBaker.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import {
DbPlainChart,
DbRawChartConfig,
DbEnrichedImage,
AssetMapEntry,
AssetMap,
} from "@ourworldindata/types"
import ProgressBar from "progress"
import {
Expand Down Expand Up @@ -65,8 +65,8 @@ const renderDatapageIfApplicable = async (
runtimeAssetMap,
}: {
imageMetadataDictionary?: Record<string, DbEnrichedImage>
staticAssetMap?: AssetMapEntry
runtimeAssetMap?: AssetMapEntry
staticAssetMap?: AssetMap
runtimeAssetMap?: AssetMap
} = {}
) => {
const variable = await getVariableOfDatapageIfApplicable(grapher)
Expand Down Expand Up @@ -111,8 +111,8 @@ export const renderDataPageOrGrapherPage = async (
runtimeAssetMap,
}: {
imageMetadataDictionary?: Record<string, DbEnrichedImage>
staticAssetMap?: AssetMapEntry
runtimeAssetMap?: AssetMapEntry
staticAssetMap?: AssetMap
runtimeAssetMap?: AssetMap
} = {}
): Promise<string> => {
const datapage = await renderDatapageIfApplicable(grapher, false, knex, {
Expand Down Expand Up @@ -141,8 +141,8 @@ export async function renderDataPageV2(
useIndicatorGrapherConfigs: boolean
pageGrapher?: GrapherInterface
imageMetadataDictionary?: Record<string, ImageMetadata>
staticAssetMap?: AssetMapEntry
runtimeAssetMap?: AssetMapEntry
staticAssetMap?: AssetMap
runtimeAssetMap?: AssetMap
},
knex: db.KnexReadonlyTransaction
) {
Expand Down Expand Up @@ -296,8 +296,8 @@ export const bakeSingleGrapherPageForArchival = async (
runtimeAssetMap,
}: {
imageMetadataDictionary?: Record<string, DbEnrichedImage>
staticAssetMap?: AssetMapEntry
runtimeAssetMap?: AssetMapEntry
staticAssetMap?: AssetMap
runtimeAssetMap?: AssetMap
} = {}
) => {
const outPathHtml = `${bakedSiteDir}/grapher/${grapher.slug}.html`
Expand Down
4 changes: 2 additions & 2 deletions baker/buildLocalArchivalBake.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { getAllImages } from "../db/model/Image.js"
import { getChartConfigBySlug } from "../db/model/Chart.js"
import findProjectBaseDir from "../settings/findBaseDir.js"
import crypto from "crypto"
import { AssetMapEntry } from "@ourworldindata/types"
import { AssetMap } from "@ourworldindata/types"
import { getVariableData } from "../db/model/Variable.js"
import dayjs from "dayjs"
import { glob } from "glob"
Expand Down Expand Up @@ -124,7 +124,7 @@ const bakeAssets = async () => {

await fs.mkdirp(targetDir)

const staticAssetMap: AssetMapEntry = {}
const staticAssetMap: AssetMap = {}

for (const dirent of await fs.readdir(srcDir, { withFileTypes: true })) {
if (!dirent.isFile()) continue
Expand Down
8 changes: 4 additions & 4 deletions packages/@ourworldindata/grapher/src/core/Grapher.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ import {
SeriesName,
ChartViewInfo,
OwidChartDimensionInterfaceWithMandatorySlug,
AssetMapEntry,
AssetMap,
} from "@ourworldindata/types"
import {
BlankOwidTable,
Expand Down Expand Up @@ -277,7 +277,7 @@ async function loadVariablesDataAdmin(
async function loadVariablesDataSite(
variableIds: number[],
dataApiUrl: string,
assetMap?: AssetMapEntry
assetMap?: AssetMap
): Promise<MultipleOwidVariableDataDimensionsMap> {
const loadVariableDataPromises = variableIds.map((variableId) =>
loadVariableDataAndMetadata(variableId, dataApiUrl, assetMap)
Expand Down Expand Up @@ -341,7 +341,7 @@ export interface GrapherProgrammaticInterface extends GrapherInterface {
ChartViewInfo,
"parentChartSlug" | "queryParamsForParentChart"
>
runtimeAssetMap?: AssetMapEntry
runtimeAssetMap?: AssetMap

manager?: GrapherManager
instanceRef?: React.RefObject<Grapher>
Expand Down Expand Up @@ -522,7 +522,7 @@ export class Grapher
"name" | "parentChartSlug" | "queryParamsForParentChart"
> = undefined

runtimeAssetMap?: AssetMapEntry = this.props.runtimeAssetMap
runtimeAssetMap?: AssetMap = this.props.runtimeAssetMap

selection =
this.manager?.selection ??
Expand Down
8 changes: 4 additions & 4 deletions packages/@ourworldindata/grapher/src/core/loadVariable.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import {
AssetMapEntry,
AssetMap,
OwidVariableDataMetadataDimensions,
} from "@ourworldindata/types"
import { fetchWithRetry } from "@ourworldindata/utils"

export const getVariableDataRoute = (
dataApiUrl: string,
variableId: number,
assetMap?: AssetMapEntry
assetMap?: AssetMap
): string => {
if (dataApiUrl.includes("v1/indicators/")) {
const filename = `${variableId}.data.json`
Expand All @@ -22,7 +22,7 @@ export const getVariableDataRoute = (
export const getVariableMetadataRoute = (
dataApiUrl: string,
variableId: number,
assetMap?: AssetMapEntry
assetMap?: AssetMap
): string => {
if (dataApiUrl.includes("v1/indicators/")) {
const filename = `${variableId}.metadata.json`
Expand All @@ -37,7 +37,7 @@ export const getVariableMetadataRoute = (
export async function loadVariableDataAndMetadata(
variableId: number,
dataApiUrl: string,
assetMap?: AssetMapEntry
assetMap?: AssetMap
): Promise<OwidVariableDataMetadataDimensions> {
const dataPromise = fetchWithRetry(
getVariableDataRoute(dataApiUrl, variableId, assetMap)
Expand Down
6 changes: 3 additions & 3 deletions packages/@ourworldindata/types/src/domainTypes/Site.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ export interface KeyValueProps {
[key: string]: string | boolean | undefined
}

export type AssetMapEntry = Record<string, string>
export type AssetMap = Record<string, string>
export interface AssetMap {
viteAssets: AssetMapEntry
runtimeResources: AssetMapEntry
viteAssets: AssetMap
runtimeResources: AssetMap
}
2 changes: 1 addition & 1 deletion packages/@ourworldindata/types/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export {
export {
type BreadcrumbItem,
type KeyValueProps,
type AssetMapEntry,
type AssetMap,
type AssetMap,
} from "./domainTypes/Site.js"
export {
Expand Down
6 changes: 3 additions & 3 deletions site/DataPageV2.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import {
GrapherInterface,
ImageMetadata,
Url,
AssetMapEntry,
AssetMap,
} from "@ourworldindata/utils"
import { MarkdownTextWrap } from "@ourworldindata/components"
import urljoin from "url-join"
Expand Down Expand Up @@ -44,8 +44,8 @@ export const DataPageV2 = (props: {
faqEntries?: FaqEntryData
imageMetadata: Record<string, ImageMetadata>
tagToSlugMap: Record<string | number, string>
staticAssetMap?: AssetMapEntry
runtimeAssetMap?: AssetMapEntry
staticAssetMap?: AssetMap
runtimeAssetMap?: AssetMap
dataApiUrl?: string
}) => {
const {
Expand Down
4 changes: 2 additions & 2 deletions site/DataPageV2Content.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import {
GrapherInterface,
joinTitleFragments,
ImageMetadata,
AssetMapEntry,
AssetMap,
} from "@ourworldindata/utils"
import { DocumentContext } from "./gdocs/DocumentContext.js"
import { AttachmentsContext } from "./gdocs/AttachmentsContext.js"
Expand Down Expand Up @@ -42,7 +42,7 @@ export const DataPageV2Content = ({
}: DataPageV2ContentFields & {
grapherConfig: GrapherInterface
imageMetadata: Record<string, ImageMetadata>
runtimeAssetMap?: AssetMapEntry
runtimeAssetMap?: AssetMap
}) => {
const [grapher, setGrapher] = useState<Grapher | undefined>(undefined)

Expand Down
7 changes: 2 additions & 5 deletions site/Head.tsx
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
import { viteAssetsForSite } from "./viteUtils.js"
import { GOOGLE_TAG_MANAGER_ID } from "../settings/clientSettings.js"
import { NoJSDetector } from "./NoJSDetector.js"
import {
AssetMapEntry,
DEFAULT_THUMBNAIL_FILENAME,
} from "@ourworldindata/types"
import { AssetMap, DEFAULT_THUMBNAIL_FILENAME } from "@ourworldindata/types"

export const GTMScriptTags = ({ gtmId }: { gtmId: string }) => {
if (!gtmId || /["']/.test(gtmId)) return null
Expand Down Expand Up @@ -45,7 +42,7 @@ export const Head = (props: {
title: string
href: string
}
staticAssetMap?: AssetMapEntry
staticAssetMap?: AssetMap
}) => {
const { canonicalUrl, hideCanonicalUrl, baseUrl } = props
const pageTitle = props.pageTitle || `Our World in Data`
Expand Down
6 changes: 3 additions & 3 deletions site/SiteFooter.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome/index.js"
import { faAngleRight } from "@fortawesome/free-solid-svg-icons"
import { AssetMapEntry, SiteFooterContext } from "@ourworldindata/utils"
import { AssetMap, SiteFooterContext } from "@ourworldindata/utils"
import { viteAssetsForSite } from "./viteUtils.js"
import { ScriptLoadErrorDetector } from "./NoJSDetector.js"
import { RSS_FEEDS, SOCIALS } from "./SiteConstants.js"
Expand All @@ -12,8 +12,8 @@ interface SiteFooterProps {
context?: SiteFooterContext
debug?: boolean
isPreviewing?: boolean
staticAssetMap?: AssetMapEntry
runtimeAssetMap?: AssetMapEntry
staticAssetMap?: AssetMap
runtimeAssetMap?: AssetMap
}

export const SiteFooter = (props: SiteFooterProps) => (
Expand Down
4 changes: 2 additions & 2 deletions site/detailsOnDemand.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { BAKED_BASE_URL } from "../settings/clientSettings.js"
import { renderToStaticMarkup } from "react-dom/server.js"
import { ArticleBlocks } from "./gdocs/components/ArticleBlocks.js"
import {
AssetMapEntry,
AssetMap,
DetailDictionary,
fetchWithRetry,
} from "@ourworldindata/utils"
Expand All @@ -25,7 +25,7 @@ const siteAnalytics = new SiteAnalytics()
export async function runDetailsOnDemand({
runtimeAssetMap,
}: {
runtimeAssetMap?: AssetMapEntry
runtimeAssetMap?: AssetMap
} = {}) {
const dodFetchUrl =
runtimeAssetMap?.["dods.json"] ?? `${BAKED_BASE_URL}/dods.json`
Expand Down
6 changes: 3 additions & 3 deletions site/runSiteFooterScripts.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { StrictMode } from "react"
import { hydrate, render } from "react-dom"
import {
AssetMapEntry,
AssetMap,
DataPageV2ContentFields,
getOwidGdocFromJSON,
getWindowQueryStr,
Expand Down Expand Up @@ -80,7 +80,7 @@ function hydrateDataInsightsIndexPage() {
function hydrateDataPageV2Content({
isPreviewing,
runtimeAssetMap,
}: { isPreviewing?: boolean; runtimeAssetMap?: AssetMapEntry } = {}) {
}: { isPreviewing?: boolean; runtimeAssetMap?: AssetMap } = {}) {
const wrapper = document.querySelector(`#${OWID_DATAPAGE_CONTENT_ROOT_ID}`)
const props: DataPageV2ContentFields = window._OWID_DATAPAGEV2_PROPS
const grapherConfig = window._OWID_GRAPHER_CONFIG
Expand Down Expand Up @@ -272,7 +272,7 @@ export const runSiteFooterScripts = (
context?: SiteFooterContext
container?: HTMLElement
hideDonationFlag?: boolean
runtimeAssetMap?: AssetMapEntry
runtimeAssetMap?: AssetMap
}
| undefined
) => {
Expand Down
10 changes: 5 additions & 5 deletions site/viteUtils.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { POLYFILL_URL } from "./SiteConstants.js"
import type { Manifest, ManifestChunk } from "vite"
import { sortBy } from "@ourworldindata/utils"
import urljoin from "url-join"
import { AssetMapEntry } from "@ourworldindata/types"
import { AssetMap } from "@ourworldindata/types"

const VITE_DEV_URL = process.env.VITE_DEV_URL ?? "http://localhost:8090"

Expand Down Expand Up @@ -99,7 +99,7 @@ export const createTagsForManifestEntry = (
manifest: Manifest,
entry: string,
assetBaseUrl: string,
assetMap?: AssetMapEntry
assetMap?: AssetMap
): Assets => {
const createTags = (entry: string): React.ReactElement[] => {
const manifestEntry =
Expand Down Expand Up @@ -171,7 +171,7 @@ export const createTagsForManifestEntry = (
const prodAssets = (
entrypoint: ViteEntryPoint,
baseUrl: string,
prodAssetMap?: AssetMapEntry
prodAssetMap?: AssetMap
): Assets => {
const baseDir = findBaseDir(__dirname)
const entrypointInfo = VITE_ENTRYPOINT_INFO[entrypoint]
Expand Down Expand Up @@ -209,7 +209,7 @@ const viteAssets = (
{
prodBaseUrl,
prodAssetMap,
}: { prodBaseUrl?: string; prodAssetMap?: AssetMapEntry } = {}
}: { prodBaseUrl?: string; prodAssetMap?: AssetMap } = {}
) =>
useProductionAssets
? prodAssets(entrypoint, prodBaseUrl ?? "", prodAssetMap)
Expand All @@ -218,7 +218,7 @@ const viteAssets = (
export const viteAssetsForAdmin = () => viteAssets(ViteEntryPoint.Admin)
export const viteAssetsForSite = ({
staticAssetMap,
}: { staticAssetMap?: AssetMapEntry } = {}) =>
}: { staticAssetMap?: AssetMap } = {}) =>
viteAssets(ViteEntryPoint.Site, { prodAssetMap: staticAssetMap })

export const generateEmbedSnippet = () => {
Expand Down

0 comments on commit 937fb28

Please sign in to comment.