@buildcanada/charts 0.1.1 → 0.2.2

package/src/utils/{OwidVariable.ts → Variable.ts}

@@ -8,18 +8,18 @@ import {
     deleteRuntimeAndUnchangedProps,
 } from "./persistable/Persistable.js"
 import {
-    OwidVariableDataTableConfigInterface,
-    OwidVariableDisplayConfigInterface,
-    OwidVariableRoundingMode,
+    VariableDataTableConfigInterface,
+    VariableDisplayConfigInterface,
+    VariableRoundingMode,
 } from "../types/index.js"
 
-class OwidVariableDisplayConfigDefaults {
+class VariableDisplayConfigDefaults {
     name: string | undefined = undefined
     unit: string | undefined = undefined
     shortUnit: string | undefined = undefined
     isProjection: boolean | undefined = undefined
     conversionFactor: number | undefined = undefined
-    roundingMode: OwidVariableRoundingMode | undefined = undefined
+    roundingMode: VariableRoundingMode | undefined = undefined
     numDecimalPlaces: number | undefined = undefined
     numSignificantFigures: number | undefined = undefined
     tolerance: number | undefined = undefined
@@ -27,7 +27,7 @@ class OwidVariableDisplayConfigDefaults {
     zeroDay: string | undefined = undefined
     entityAnnotationsMap: string | undefined = undefined
     includeInTable: boolean | undefined = true
-    tableDisplay: OwidVariableDataTableConfigInterface | undefined = undefined
+    tableDisplay: VariableDataTableConfigInterface | undefined = undefined
     color: string | undefined = undefined
     plotMarkersOnlyInLineChart: boolean | undefined = undefined
 
@@ -53,30 +53,30 @@ class OwidVariableDisplayConfigDefaults {
     }
 }
 
-export class OwidVariableDisplayConfig
-    extends OwidVariableDisplayConfigDefaults
+export class VariableDisplayConfig
+    extends VariableDisplayConfigDefaults
     implements Persistable
 {
-    updateFromObject(obj?: Partial<OwidVariableDisplayConfigInterface>): void {
+    updateFromObject(obj?: Partial<VariableDisplayConfigInterface>): void {
         if (obj) updatePersistables(this, obj)
     }
 
-    toObject(): OwidVariableDisplayConfigDefaults {
+    toObject(): VariableDisplayConfigDefaults {
         return deleteRuntimeAndUnchangedProps(
             objectWithPersistablesToObject(this),
-            new OwidVariableDisplayConfigDefaults()
+            new VariableDisplayConfigDefaults()
         )
     }
 
-    constructor(obj?: Partial<OwidVariableDisplayConfigInterface>) {
+    constructor(obj?: Partial<VariableDisplayConfigInterface>) {
         super()
         if (obj) this.updateFromObject(obj)
     }
 }
 
-// export interface OwidVariablesAndEntityKey {
+// export interface VariablesAndEntityKey {
 //     variables: {
-//         [id: string]: OwidVariableWithDataAndSource
+//         [id: string]: VariableWithDataAndSource
 //     }
-//     entityKey: OwidEntityKey
+//     entityKey: EntityKey
 // }

package/src/utils/formatValue.ts

@@ -1,7 +1,7 @@
 import { FormatSpecifier } from "d3-format"
 import { createFormatter } from "./Util.js"
 import {
-    OwidVariableRoundingMode,
+    VariableRoundingMode,
     TickFormattingOptions,
 } from "../types/index.js"
 
@@ -22,11 +22,11 @@ function getTrim({
     roundingMode,
     trailingZeroes,
 }: {
-    roundingMode: OwidVariableRoundingMode
+    roundingMode: VariableRoundingMode
     trailingZeroes: boolean
 }): "~" | "" {
     // always show trailing zeroes when rounding to significant figures
-    return roundingMode === OwidVariableRoundingMode.significantFigures
+    return roundingMode === VariableRoundingMode.significantFigures
         ? ""
         : trailingZeroes
           ? ""
@@ -47,7 +47,7 @@ function getType({
     value,
     unit,
 }: {
-    roundingMode: OwidVariableRoundingMode
+    roundingMode: VariableRoundingMode
     numberAbbreviation: "long" | "short" | false
     value: number
     unit: string
@@ -56,9 +56,9 @@ function getType({
     // r: decimal notation, rounded to significant digits
     // s: decimal notation with an SI prefix, rounded to significant digits
 
-    const typeMap: Record<OwidVariableRoundingMode, "f" | "r"> = {
-        [OwidVariableRoundingMode.decimalPlaces]: "f",
-        [OwidVariableRoundingMode.significantFigures]: "r",
+    const typeMap: Record<VariableRoundingMode, "f" | "r"> = {
+        [VariableRoundingMode.decimalPlaces]: "f",
+        [VariableRoundingMode.significantFigures]: "r",
     }
     const type = typeMap[roundingMode]
 
@@ -85,12 +85,12 @@ function getPrecision({
     type,
 }: {
     value: number
-    roundingMode: OwidVariableRoundingMode
+    roundingMode: VariableRoundingMode
     numDecimalPlaces: number
     numSignificantFigures: number
     type: "f" | "s" | "r"
 }): string {
-    if (roundingMode === OwidVariableRoundingMode.significantFigures) {
+    if (roundingMode === VariableRoundingMode.significantFigures) {
         return `${numSignificantFigures}`
     }
 
@@ -157,7 +157,7 @@ function postprocessString({
     numDecimalPlaces,
 }: {
     string: string
-    roundingMode: OwidVariableRoundingMode
+    roundingMode: VariableRoundingMode
     numberAbbreviation: "long" | "short" | false
     spaceBeforeUnit: boolean
     useNoBreakSpace: boolean
@@ -168,7 +168,7 @@ function postprocessString({
     let output = string
 
     // handling infinitesimal values
-    if (roundingMode !== OwidVariableRoundingMode.significantFigures) {
+    if (roundingMode !== VariableRoundingMode.significantFigures) {
         const tooSmallThreshold = Math.pow(10, -numDecimalPlaces).toPrecision(1)
         if (numberAbbreviation && 0 < value && value < +tooSmallThreshold) {
             output = "<" + output.replace(/0\.?(\d+)?/, tooSmallThreshold)
@@ -194,7 +194,7 @@ function postprocessString({
 export function formatValue(
     value: number,
     {
-        roundingMode = OwidVariableRoundingMode.decimalPlaces,
+        roundingMode = VariableRoundingMode.decimalPlaces,
         trailingZeroes = false, // only applies to fixed-point notation
         unit = "",
         spaceBeforeUnit = !checkIsUnitPercent(unit),

package/src/utils/image.ts

@@ -6,8 +6,8 @@ Common utlities for deriving properties from image metadata.
 import { traverseEnrichedBlock } from "./Util.js"
 import {
     AssetMap,
-    OwidGdoc,
-    OwidGdocType,
+    Gdoc,
+    GdocType,
     ImageMetadata,
 } from "../types/index.js"
 import { match, P } from "ts-pattern"
@@ -172,18 +172,18 @@ export function generateSourceProps(
     return props
 }
 
-export function getFeaturedImageFilename(gdoc: OwidGdoc): string | undefined {
+export function getFeaturedImageFilename(gdoc: Gdoc): string | undefined {
     return match(gdoc)
         .with(
             {
                 content: {
                     type: P.union(
-                        OwidGdocType.Article,
-                        OwidGdocType.TopicPage,
-                        OwidGdocType.LinearTopicPage,
-                        OwidGdocType.AboutPage,
-                        OwidGdocType.Author,
-                        OwidGdocType.Announcement
+                        GdocType.Article,
+                        GdocType.TopicPage,
+                        GdocType.LinearTopicPage,
+                        GdocType.AboutPage,
+                        GdocType.Author,
+                        GdocType.Announcement
                     ),
                 },
             },
@@ -192,7 +192,7 @@ export function getFeaturedImageFilename(gdoc: OwidGdoc): string | undefined {
                 return featuredImageFilename
             }
         )
-        .with({ content: { type: OwidGdocType.DataInsight } }, (gdoc) => {
+        .with({ content: { type: GdocType.DataInsight } }, (gdoc) => {
             // Use the first image in the document as the featured image
             let filename: string | undefined = undefined
             for (const block of gdoc.content.body) {
@@ -206,7 +206,7 @@ export function getFeaturedImageFilename(gdoc: OwidGdoc): string | undefined {
         })
         .with(
             {
-                content: { type: OwidGdocType.Profile },
+                content: { type: GdocType.Profile },
             },
             (match) => match.content["featured-image"]
         )
@@ -214,7 +214,7 @@ export function getFeaturedImageFilename(gdoc: OwidGdoc): string | undefined {
             {
                 content: {
                     type: P.optional(
-                        P.union(OwidGdocType.Fragment, OwidGdocType.Homepage)
+                        P.union(GdocType.Fragment, GdocType.Homepage)
                     ),
                 },
             },

package/src/utils/index.ts

@@ -76,8 +76,8 @@ export {
     getPhraseForArchivalDate,
 } from "./metadataHelpers.js"
 
-// OwidVariable display config
-export { OwidVariableDisplayConfig } from "./OwidVariable.js"
+// Variable display config
+export { VariableDisplayConfig } from "./Variable.js"
 
 // Persistable
 export {
@@ -105,8 +105,8 @@ export {
     listedRegionsNames,
     type Country,
     type IncomeGroup,
-    type OwidIncomeGroupName,
-    checkIsOwidIncomeGroupName,
+    type IncomeGroupName,
+    checkIsIncomeGroupName,
     getCountryBySlug,
     getCountryByName,
     getRegionByNameOrVariantName,
@@ -123,7 +123,7 @@ export {
     getRegionAlternativeNames,
     mappableCountries,
     checkIsCountry,
-    checkIsOwidContinent,
+    checkIsContinent,
     checkIsIncomeGroup,
     getIncomeGroups,
     getCountryNamesForRegion,

package/src/utils/metadataHelpers.ts

@@ -1,12 +1,12 @@
 // @ts-nocheck
 import * as R from "remeda"
 import {
-    OwidOrigin,
-    OwidVariableWithSource,
-    OwidProcessingLevel,
+    Origin,
+    VariableWithSource,
+    ProcessingLevel,
     DisplaySource,
     IndicatorTitleWithFragments,
-    OwidSource,
+    Source,
 } from "../types/index.js"
 import * as _ from "lodash-es"
 import { excludeUndefined } from "./Util"
@@ -14,7 +14,7 @@ import dayjs from "./dayjs.js"
 import { parseArchivalDate } from "./archival/archivalDate.js"
 
 export function getOriginAttributionFragments(
-    origins: OwidOrigin[] | undefined
+    origins: Origin[] | undefined
 ): string[] {
     return origins
         ? origins.map((origin) => {
@@ -40,7 +40,7 @@ export const splitSourceTextIntoFragments = (
 
 export function getAttributionFragmentsFromVariable(
     variable: Pick<
-        OwidVariableWithSource,
+        VariableWithSource,
         "presentation" | "origins" | "source"
     >
 ): string[] {
@@ -89,7 +89,7 @@ const isDate = (date: string): boolean => {
 }
 
 export const getLastUpdatedFromVariable = (
-    variable: Pick<OwidVariableWithSource, "catalogPath" | "origins">
+    variable: Pick<VariableWithSource, "catalogPath" | "origins">
 ): string | undefined => {
     // if possible, extract date from the catalog path
     const version = getETLPathComponents(variable.catalogPath ?? "")?.version
@@ -110,7 +110,7 @@ export const getLastUpdatedFromVariable = (
 }
 
 export const getNextUpdateFromVariable = (
-    variable: Pick<OwidVariableWithSource, "catalogPath" | "updatePeriodDays">
+    variable: Pick<VariableWithSource, "catalogPath" | "updatePeriodDays">
 ): string | undefined => {
     const lastUpdated = getLastUpdatedFromVariable(variable)
     let nextUpdate = undefined
@@ -126,7 +126,7 @@ export const getNextUpdateFromVariable = (
 }
 
 export const getPhraseForProcessingLevel = (
-    processingLevel: OwidProcessingLevel | undefined
+    processingLevel: ProcessingLevel | undefined
 ): string => {
     switch (processingLevel) {
         case "major":
@@ -138,7 +138,7 @@ export const getPhraseForProcessingLevel = (
     }
 }
 
-const prepareOriginForDisplay = (origin: OwidOrigin): DisplaySource => {
+const prepareOriginForDisplay = (origin: Origin): DisplaySource => {
     let label = origin.producer ?? ""
     if (origin.title && origin.title !== label) {
         label += " – " + origin.title
@@ -154,7 +154,7 @@ const prepareOriginForDisplay = (origin: OwidOrigin): DisplaySource => {
 }
 
 export const prepareSourcesForDisplay = (
-    variable: Pick<OwidVariableWithSource, "origins" | "source">
+    variable: Pick<VariableWithSource, "origins" | "source">
 ): DisplaySource[] => {
     const { origins, source } = variable
 
@@ -181,7 +181,7 @@ export const prepareSourcesForDisplay = (
     return sourcesForDisplay
 }
 
-const getYearSuffixFromOrigin = (o: OwidOrigin): string => {
+const getYearSuffixFromOrigin = (o: Origin): string => {
     const year = o.dateAccessed
         ? dayjs(o.dateAccessed, ["YYYY-MM-DD", "YYYY"]).year()
         : o.datePublished
@@ -192,15 +192,15 @@ const getYearSuffixFromOrigin = (o: OwidOrigin): string => {
 }
 
 export const getCitationShort = (
-    origins: OwidOrigin[],
+    origins: Origin[],
     attributions: string[],
-    owidProcessingLevel: OwidProcessingLevel | undefined
+    processingLevel: ProcessingLevel | undefined
 ): string => {
     const producersWithYear = _.uniq(
         origins.map((o) => `${o.producer}${getYearSuffixFromOrigin(o)}`)
     )
     const processingLevelPhrase =
-        getPhraseForProcessingLevel(owidProcessingLevel)
+        getPhraseForProcessingLevel(processingLevel)
 
     const attributionFragments = attributions ?? producersWithYear
     const attributionPotentiallyShortened =
@@ -226,12 +226,12 @@ export const getPhraseForArchivalDate = (
 
 export const getCitationLong = (
     indicatorTitle: IndicatorTitleWithFragments,
-    origins: OwidOrigin[],
-    source: OwidSource | undefined,
+    origins: Origin[],
+    source: Source | undefined,
     attributions: string[],
     attributionShort: string | undefined,
     titleVariant: string | undefined,
-    owidProcessingLevel: OwidProcessingLevel | undefined,
+    processingLevel: ProcessingLevel | undefined,
     citationUrl: string | undefined,
     archivalDate: string | undefined
 ): string => {
@@ -243,7 +243,7 @@ export const getCitationLong = (
         origins.map((o) => `${o.producer}${getYearSuffixFromOrigin(o)}`)
     )
     const processingLevelPhrase =
-        getPhraseForProcessingLevel(owidProcessingLevel)
+        getPhraseForProcessingLevel(processingLevel)
 
     const attributionFragments = attributions ?? producersWithYear
     const attributionUnshortened = attributionFragments.join("; ")

package/src/utils/regions.ts

@@ -38,14 +38,14 @@ export interface Aggregate extends BaseRegion {
 }
 
 export interface Continent extends BaseRegion {
-    name: OwidContinentName
+    name: ContinentName
     regionType: RegionType.Continent
     translationCodes?: string[]
     members: string[]
 }
 
 export interface IncomeGroup extends BaseRegion {
-    name: OwidIncomeGroupName
+    name: IncomeGroupName
     regionType: RegionType.IncomeGroup
     members: string[]
 }
@@ -61,7 +61,7 @@ export type Region = Country | Aggregate | Continent | IncomeGroup | Province
 
 export const regions: Region[] = entities as Region[]
 
-type OwidContinentName =
+type ContinentName =
     | "Africa"
     | "Asia"
     | "Europe"
@@ -69,7 +69,7 @@ type OwidContinentName =
     | "Oceania"
     | "South America"
 
-export type OwidIncomeGroupName =
+export type IncomeGroupName =
     | "OWID_LIC"
     | "OWID_LMC"
     | "OWID_UMC"
@@ -85,9 +85,9 @@ export const aggregateSources = [
 ] as const
 export type AggregateSource = (typeof aggregateSources)[number]
 
-export function checkIsOwidIncomeGroupName(
+export function checkIsIncomeGroupName(
     name: string
-): name is OwidIncomeGroupName {
+): name is IncomeGroupName {
     return (
         name === "OWID_LIC" ||
         name === "OWID_LMC" ||
@@ -103,7 +103,7 @@ export function checkIsCountry(region: Region): region is Country {
     )
 }
 
-export function checkIsOwidContinent(region: Region): region is Continent {
+export function checkIsContinent(region: Region): region is Continent {
     return region.regionType === RegionType.Continent
 }
 
@@ -199,9 +199,9 @@ export const incomeGroupsByName = lazy(
     () =>
         Object.fromEntries(
             regions
-                .filter((region) => checkIsOwidIncomeGroupName(region.code))
+                .filter((region) => checkIsIncomeGroupName(region.code))
                 .map((region) => [region.code, region])
-        ) as Record<OwidIncomeGroupName, IncomeGroup>
+        ) as Record<IncomeGroupName, IncomeGroup>
 )
 
 const countriesBySlug = lazy(() =>

package/src/types/OwidVariable.ts

@@ -1,133 +0,0 @@
-import { OwidOrigin } from "./OwidOrigin.js"
-import { OwidSource } from "./OwidSource.js"
-import { OwidVariableDisplayConfigInterface } from "./OwidVariableDisplayConfigInterface.js"
-
-export interface OwidVariableWithSource {
-    id: number
-    name?: string
-    description?: string
-    descriptionShort?: string
-    descriptionFromProducer?: string
-    descriptionKey?: string[]
-    descriptionProcessing?: string
-    unit?: string
-    display?: OwidVariableDisplayConfigInterface
-    shortUnit?: string
-    datasetName?: string
-    datasetId?: number
-    coverage?: string
-    nonRedistributable?: boolean
-    source?: OwidSource
-    origins?: OwidOrigin[]
-    schemaVersion?: number
-    processingLevel?: OwidProcessingLevel
-    presentation?: OwidVariablePresentation
-    shortName?: string
-    timespan?: string
-    catalogPath?: string
-    license?: OwidLicense
-    updatePeriodDays?: number
-    datasetVersion?: string
-    licenses?: OwidLicense[]
-    type?: OwidVariableType
-
-    // omitted:
-    // code
-    // coverage
-    // dataPath
-    // metadataPath
-}
-
-export interface IndicatorTitleWithFragments {
-    title: string
-    attributionShort?: string
-    titleVariant?: string
-}
-
-export function joinTitleFragments(
-    attributionShort: string | undefined,
-    titleVariant: string | undefined
-): string | undefined {
-    if (attributionShort && titleVariant && attributionShort !== titleVariant) {
-        return `${titleVariant} – ${attributionShort}`
-    }
-    if (attributionShort) {
-        return attributionShort
-    }
-    if (titleVariant) {
-        return titleVariant
-    }
-    return undefined
-}
-
-export interface OwidLicense {
-    name: string
-    url: string
-}
-
-export interface OwidVariablePresentation {
-    titlePublic?: string
-    titleVariant?: string
-    attributionShort?: string
-    attribution?: string
-    topicTagsLinks?: string[]
-    faqs?: FaqLink[]
-}
-
-export type OwidProcessingLevel = "minor" | "major"
-
-export interface FaqLink {
-    gdocId: string
-    fragmentId: string
-}
-
-export type OwidVariableWithSourceAndDimension = OwidVariableWithSource & {
-    dimensions: OwidVariableDimensions
-}
-
-export type OwidVariableWithSourceAndDimensionWithoutId = Omit<
-    OwidVariableWithSourceAndDimension,
-    "id"
->
-
-export interface OwidVariableMixedData {
-    years: number[]
-    entities: number[]
-    values: (string | number)[]
-}
-
-export type OwidVariableWithDataAndSource = OwidVariableWithSource &
-    OwidVariableMixedData
-
-export interface OwidVariableDimension {
-    values: OwidVariableDimensionValuePartial[]
-}
-
-export interface OwidVariableDimensions {
-    years: OwidVariableDimension
-    entities: OwidVariableDimension
-    values?: OwidVariableDimension
-}
-
-export type OwidVariableDataMetadataDimensions = {
-    data: OwidVariableMixedData
-    metadata: OwidVariableWithSourceAndDimension
-}
-export type MultipleOwidVariableDataDimensionsMap = Map<
-    number,
-    OwidVariableDataMetadataDimensions
->
-
-export interface OwidVariableDimensionValuePartial {
-    id: number
-    name?: string
-    code?: string
-}
-export type OwidVariableDimensionValueFull =
-    Required<OwidVariableDimensionValuePartial>
-
-export interface OwidEntityKey {
-    [id: string]: OwidVariableDimensionValuePartial
-}
-
-export type OwidVariableType = "string" | "float" | "int" | "mixed" | "ordinal"