@buildcanada/charts 0.1.0 → 0.2.0

package/src/grapher/stackedCharts/StackedDiscreteBarChartState.ts

@@ -2,7 +2,7 @@ import * as _ from "lodash-es"
 import { computed, makeObservable } from "mobx"
 import { ChartState } from "../chart/ChartInterface"
 import { StackedDiscreteBarChartManager } from "./StackedDiscreteBarChart"
-import { CoreColumn, OwidTable } from "../../core-table/index.js"
+import { CoreColumn, ChartsTable } from "../../core-table/index.js"
 import {
     ChartErrorInfo,
     ColorSchemeName,
@@ -39,18 +39,18 @@ export class StackedDiscreteBarChartState implements ChartState {
         makeObservable(this)
     }
 
-    @computed get inputTable(): OwidTable {
+    @computed get inputTable(): ChartsTable {
         return this.manager.table
     }
 
-    @computed get transformedTable(): OwidTable {
+    @computed get transformedTable(): ChartsTable {
         return (
             this.manager.transformedTable ??
             this.transformTable(this.inputTable)
         )
     }
 
-    transformTable(table: OwidTable): OwidTable {
+    transformTable(table: ChartsTable): ChartsTable {
         if (!this.yColumnSlugs.length) return table
 
         table = table.filterByEntityNames(
@@ -82,7 +82,7 @@ export class StackedDiscreteBarChartState implements ChartState {
         return table
     }
 
-    transformTableForSelection(table: OwidTable): OwidTable {
+    transformTableForSelection(table: ChartsTable): ChartsTable {
         table = table
             .replaceNonNumericCellsWithErrorValues(this.yColumnSlugs)
             .replaceNegativeCellsWithErrorValues(this.yColumnSlugs)
@@ -93,14 +93,14 @@ export class StackedDiscreteBarChartState implements ChartState {
         return table
     }
 
-    private applyMissingDataStrategy(table: OwidTable): OwidTable {
+    private applyMissingDataStrategy(table: ChartsTable): ChartsTable {
         // We want to remove all rows with missing data for at least one column if:
         // - MissingDataStrategy is explicitly set to hide, or
         // - We are in relative mode and MissingDataStrategy is not explicitly set to show:
         //     If we are showing relative mode, we want to drop all rows that are missing data for
         //     any column, because otherwise the displayed data will be misleading in that it may
         //     suggest patterns that are not actually present.
-        //     see https://github.com/owid/owid-grapher/issues/2860
+        //     see # legacy issue 2860
 
         const shouldRemoveRows =
             this.missingDataStrategy === MissingDataStrategy.hide ||
@@ -162,7 +162,7 @@ export class StackedDiscreteBarChartState implements ChartState {
         return (
             (this.manager.baseColorScheme
                 ? ColorSchemes.get(this.manager.baseColorScheme)
-                : null) ?? ColorSchemes.get(ColorSchemeName["owid-distinct"])
+                : null) ?? ColorSchemes.get(ColorSchemeName["distinct"])
         )
     }
 
@@ -187,7 +187,7 @@ export class StackedDiscreteBarChartState implements ChartState {
                         color: this.categoricalColorAssigner.assign(
                             col.displayName
                         ),
-                        points: col.owidRows.map((row) => ({
+                        points: col.dataRows.map((row) => ({
                             time: row.originalTime,
                             position: row.entityName,
                             value: row.value,
@@ -250,10 +250,10 @@ export class StackedDiscreteBarChartState implements ChartState {
                 sortByFunc = (item: Item): string => item.entityName
                 break
             case SortBy.column: {
-                const owidRowsByEntityName =
-                    this.sortColumn?.owidRowsByEntityName
+                const dataRowsByEntityName =
+                    this.sortColumn?.dataRowsByEntityName
                 sortByFunc = (item: Item): number => {
-                    const rows = owidRowsByEntityName?.get(item.entityName)
+                    const rows = dataRowsByEntityName?.get(item.entityName)
                     return rows?.[0]?.value ?? 0
                 }
                 break

package/src/grapher/stackedCharts/StackedDiscreteBars.tsx

@@ -28,7 +28,7 @@ import {
 } from "../axis/AxisViews"
 import { AxisConfig } from "../axis/AxisConfig"
 import { ChartInterface } from "../chart/ChartInterface"
-import { OwidTable, CoreColumn } from "../../core-table/index.js"
+import { ChartsTable, CoreColumn } from "../../core-table/index.js"
 import { ChartManager } from "../chart/ChartManager"
 import { TooltipFooterIcon } from "../tooltip/TooltipProps.js"
 import {
@@ -311,7 +311,7 @@ export class StackedDiscreteBars
             : this.renderInteractive()
     }
 
-    @computed private get inputTable(): OwidTable {
+    @computed private get inputTable(): ChartsTable {
         return this.chartState.inputTable
     }
 

package/src/grapher/tabs/Tabs.tsx

@@ -9,7 +9,7 @@ export interface TabItem<TabKey extends string = string> {
         className?: string
         ariaLabel?: string
         dataTrackNote?: string
-        ref?: React.RefObject<HTMLButtonElement | null>
+        ref?: React.RefObject<HTMLDivElement | null>
     }
 }
 

package/src/grapher/testData/{OwidTestData.sample.ts → TestData.sample.ts}

@@ -4,10 +4,10 @@ import { GrapherState } from "../core/GrapherState"
 import {
     TestData,
     TestMetadata,
-    createOwidTestDataset,
+    createTestDataset,
     fakeEntities,
-} from "../testData/OwidTestData"
-import { legacyToOwidTableAndDimensionsWithMandatorySlug } from "../core/LegacyToOwidTable.js"
+} from "../testData/TestData"
+import { legacyToChartsTableAndDimensionsWithMandatorySlug } from "../core/LegacyToChartsTable.js"
 
 /**
  * Comprehensive life expectancy test data covering:
@@ -170,8 +170,8 @@ export const LifeExpectancyGrapher = (
         ...props,
         dimensions,
     })
-    const inputTable = legacyToOwidTableAndDimensionsWithMandatorySlug(
-        createOwidTestDataset([
+    const inputTable = legacyToChartsTableAndDimensionsWithMandatorySlug(
+        createTestDataset([
             { data: lifeExpectancyData, metadata: lifeExpectancyMetadata },
         ]),
         dimensions,
@@ -261,8 +261,8 @@ export const CanadaProvinceGrapher = (
         ...props,
         dimensions,
     })
-    const inputTable = legacyToOwidTableAndDimensionsWithMandatorySlug(
-        createOwidTestDataset([
+    const inputTable = legacyToChartsTableAndDimensionsWithMandatorySlug(
+        createTestDataset([
             { data: provinceData, metadata: populationMetadata },
         ]),
         dimensions,

package/src/grapher/testData/{OwidTestData.ts → TestData.ts}

@@ -1,8 +1,8 @@
 import * as _ from "lodash-es"
 import { Region, regions } from "../../utils/index.js"
 import {
-    MultipleOwidVariableDataDimensionsMap,
-    OwidVariableWithSource,
+    MultipleVariableDataDimensionsMap,
+    VariableWithSource,
     EntityCode,
     EntityId,
     EntityName,
@@ -12,7 +12,7 @@ type Entity = { id: EntityId; code?: EntityCode; name?: EntityName }
 type TestDatum = { year: number; entity: Entity; value: string | number }
 
 export type TestData = TestDatum[]
-export type TestMetadata = OwidVariableWithSource
+export type TestMetadata = VariableWithSource
 
 const fakeRegions = regions.map((region: Region, index: number) => ({
     ...region,
@@ -26,12 +26,12 @@ export const fakeEntities = Object.fromEntries(
     ])
 )
 
-export function createOwidTestDataset(
+export function createTestDataset(
     indicators: {
         data: TestData
         metadata: TestMetadata
     }[]
-): MultipleOwidVariableDataDimensionsMap {
+): MultipleVariableDataDimensionsMap {
     return new Map(
         indicators.map(({ data, metadata }) => [
             metadata.id,

package/src/index.ts

@@ -194,20 +194,20 @@ export {
 
 // Legacy conversion
 export {
-    legacyToOwidTableAndDimensions,
-    legacyToOwidTableAndDimensionsWithMandatorySlug,
-} from "./grapher/core/LegacyToOwidTable.js"
+    legacyToChartsTableAndDimensions,
+    legacyToChartsTableAndDimensionsWithMandatorySlug,
+} from "./grapher/core/LegacyToChartsTable.js"
 
 export { legacyToCurrentGrapherUrl } from "./grapher/core/GrapherUrlMigrations.js"
 
 // Test data helpers (useful for demos and testing)
 export {
     fakeEntities,
-    createOwidTestDataset,
+    createTestDataset,
     type TestData,
     type TestMetadata,
-} from "./grapher/testData/OwidTestData.js"
-export { LifeExpectancyGrapher } from "./grapher/testData/OwidTestData.sample.js"
+} from "./grapher/testData/TestData.js"
+export { LifeExpectancyGrapher } from "./grapher/testData/TestData.sample.js"
 
 // Types commonly needed for data loading
 export {
@@ -223,4 +223,4 @@ export {
 
 // Utilities for data loading
 export { Bounds } from "./utils/index.js"
-export { parseDelimited, OwidTable, BlankOwidTable } from "./core-table/index.js"
+export { parseDelimited, ChartsTable, BlankChartsTable } from "./core-table/index.js"

package/src/types/{OwidOrigin.ts → Origin.ts}

@@ -1,12 +1,12 @@
-import { OwidLicense } from "./OwidVariable.js"
-export interface OwidOrigin {
+import { License } from "./Variable.js"
+export interface Origin {
     id?: number
     title?: string
     titleSnapshot?: string
     attribution?: string
     attributionShort?: string
     versionProducer?: string
-    license?: OwidLicense
+    license?: License
     descriptionSnapshot?: string
     description?: string
     producer?: string

package/src/types/{OwidSource.ts → Source.ts}

@@ -1,4 +1,4 @@
-export interface OwidSource {
+export interface Source {
     id?: number
     name?: string
     dataPublishedBy?: string

package/src/types/Variable.ts

@@ -0,0 +1,133 @@
+import { Origin } from "./Origin.js"
+import { Source } from "./Source.js"
+import { VariableDisplayConfigInterface } from "./VariableDisplayConfigInterface.js"
+
+export interface VariableWithSource {
+    id: number
+    name?: string
+    description?: string
+    descriptionShort?: string
+    descriptionFromProducer?: string
+    descriptionKey?: string[]
+    descriptionProcessing?: string
+    unit?: string
+    display?: VariableDisplayConfigInterface
+    shortUnit?: string
+    datasetName?: string
+    datasetId?: number
+    coverage?: string
+    nonRedistributable?: boolean
+    source?: Source
+    origins?: Origin[]
+    schemaVersion?: number
+    processingLevel?: ProcessingLevel
+    presentation?: VariablePresentation
+    shortName?: string
+    timespan?: string
+    catalogPath?: string
+    license?: License
+    updatePeriodDays?: number
+    datasetVersion?: string
+    licenses?: License[]
+    type?: VariableType
+
+    // 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 License {
+    name: string
+    url: string
+}
+
+export interface VariablePresentation {
+    titlePublic?: string
+    titleVariant?: string
+    attributionShort?: string
+    attribution?: string
+    topicTagsLinks?: string[]
+    faqs?: FaqLink[]
+}
+
+export type ProcessingLevel = "minor" | "major"
+
+export interface FaqLink {
+    gdocId: string
+    fragmentId: string
+}
+
+export type VariableWithSourceAndDimension = VariableWithSource & {
+    dimensions: VariableDimensions
+}
+
+export type VariableWithSourceAndDimensionWithoutId = Omit<
+    VariableWithSourceAndDimension,
+    "id"
+>
+
+export interface VariableMixedData {
+    years: number[]
+    entities: number[]
+    values: (string | number)[]
+}
+
+export type VariableWithDataAndSource = VariableWithSource &
+    VariableMixedData
+
+export interface VariableDimension {
+    values: VariableDimensionValuePartial[]
+}
+
+export interface VariableDimensions {
+    years: VariableDimension
+    entities: VariableDimension
+    values?: VariableDimension
+}
+
+export type VariableDataMetadataDimensions = {
+    data: VariableMixedData
+    metadata: VariableWithSourceAndDimension
+}
+export type MultipleVariableDataDimensionsMap = Map<
+    number,
+    VariableDataMetadataDimensions
+>
+
+export interface VariableDimensionValuePartial {
+    id: number
+    name?: string
+    code?: string
+}
+export type VariableDimensionValueFull =
+    Required<VariableDimensionValuePartial>
+
+export interface EntityKey {
+    [id: string]: VariableDimensionValuePartial
+}
+
+export type VariableType = "string" | "float" | "int" | "mixed" | "ordinal"

package/src/types/{OwidVariableDisplayConfigInterface.ts → VariableDisplayConfigInterface.ts}

@@ -1,17 +1,17 @@
-import { OwidVariableId } from "./domainTypes/Various.js"
+import { VariableId } from "./domainTypes/Various.js"
 import {
     ColumnSlug,
     DimensionProperty,
     Time,
 } from "./grapherTypes/GrapherTypes.js"
 
-export interface OwidVariableDisplayConfigInterface {
+export interface VariableDisplayConfigInterface {
     name?: string
     unit?: string
     shortUnit?: string
     isProjection?: boolean
     conversionFactor?: number
-    roundingMode?: OwidVariableRoundingMode
+    roundingMode?: VariableRoundingMode
     numDecimalPlaces?: number
     numSignificantFigures?: number
     tolerance?: number
@@ -19,31 +19,31 @@ export interface OwidVariableDisplayConfigInterface {
     zeroDay?: string
     entityAnnotationsMap?: string
     includeInTable?: boolean
-    tableDisplay?: OwidVariableDataTableConfigInterface
+    tableDisplay?: VariableDataTableConfigInterface
     color?: string
     plotMarkersOnlyInLineChart?: boolean
 }
 
 // todo: flatten onto the above
-export interface OwidVariableDataTableConfigInterface {
+export interface VariableDataTableConfigInterface {
     hideAbsoluteChange?: boolean
     hideRelativeChange?: boolean
 }
 
-export enum OwidVariableRoundingMode {
+export enum VariableRoundingMode {
     decimalPlaces = "decimalPlaces",
     significantFigures = "significantFigures",
 }
 
-export interface OwidChartDimensionInterface {
+export interface ChartDimensionInterface {
     property: DimensionProperty
     targetYear?: Time
-    display?: OwidVariableDisplayConfigInterface
-    variableId: OwidVariableId
+    display?: VariableDisplayConfigInterface
+    variableId: VariableId
     slug?: ColumnSlug
 }
 
-export interface OwidChartDimensionInterfaceWithMandatorySlug
-    extends OwidChartDimensionInterface {
+export interface ChartDimensionInterfaceWithMandatorySlug
+    extends ChartDimensionInterface {
     slug: ColumnSlug
 }

package/src/types/domainTypes/ContentGraph.ts

@@ -1,5 +1,5 @@
 import { DbPlainTag } from "../dbTypes/Tags.js"
-import { OwidGdocType } from "../gdocTypes/Gdoc.js"
+import { GdocType } from "../gdocTypes/Gdoc.js"
 
 export interface EntryMeta {
     slug: string
@@ -46,7 +46,7 @@ export interface TagGraphNode {
     weight: number
 }
 
-export type TagGraphRoot = TagGraphNode & {
+export interface TagGraphRoot {
     children: TagGraphNode[]
     id: number
     isTopic: false
@@ -61,7 +61,7 @@ export interface PostReference {
     title: string
     slug: string
     url: string
-    type: OwidGdocType
+    type: GdocType
 }
 
 export enum ContentGraphLinkType {

package/src/types/domainTypes/CoreTableTypes.ts

@@ -1,9 +1,9 @@
-import { OwidOrigin } from "../OwidOrigin.js"
+import { Origin } from "../Origin.js"
 import {
-    OwidProcessingLevel,
-    OwidVariablePresentation,
-} from "../OwidVariable.js"
-import { OwidVariableDisplayConfigInterface } from "../OwidVariableDisplayConfigInterface.js"
+    ProcessingLevel,
+    VariablePresentation,
+} from "../Variable.js"
+import { VariableDisplayConfigInterface } from "../VariableDisplayConfigInterface.js"
 import {
     Color,
     ColumnSlug,
@@ -119,7 +119,7 @@ type CoreVector = any[]
  */
 export type CoreMatrix = CoreVector[]
 
-export enum OwidTableSlugs {
+export enum ChartsTableSlugs {
     entityName = "entityName",
     entityColor = "entityColor",
     entityId = "entityId",
@@ -130,7 +130,7 @@ export enum OwidTableSlugs {
     date = "date",
 }
 
-enum OwidTableNames {
+enum ChartsTableNames {
     Entity = "Entity",
     Code = "Code",
 }
@@ -224,8 +224,8 @@ export interface CoreColumnDef extends ColumnColorScale {
     timespan?: string
 
     // Metadata v2
-    origins?: OwidOrigin[]
-    presentation?: OwidVariablePresentation
+    origins?: Origin[]
+    presentation?: VariablePresentation
     updatePeriodDays?: number
 
     // Dataset information
@@ -243,12 +243,12 @@ export interface CoreColumnDef extends ColumnColorScale {
     // DEPRECATED
     unit?: string // DEPRECATED: use an existing column type or create a new one instead.
     shortUnit?: string // DEPRECATED: use an existing column type or create a new one instead.
-    display?: OwidVariableDisplayConfigInterface // DEPRECATED: use an existing column type or create a new one instead, or migrate any properties you need onto this interface.
+    display?: VariableDisplayConfigInterface // DEPRECATED: use an existing column type or create a new one instead, or migrate any properties you need onto this interface.
 }
 
 // Todo: coverage, datasetId, and datasetName can just be on source, right? or should we flatten source onto this?
-export interface OwidColumnDef extends CoreColumnDef {
-    owidVariableId?: number
+export interface ColumnDef extends CoreColumnDef {
+    variableId?: number
     coverage?: string
     datasetId?: number
     datasetName?: string
@@ -257,36 +257,36 @@ export interface OwidColumnDef extends CoreColumnDef {
     nonRedistributable?: boolean
     skipParsing?: boolean
     catalogPath?: string
-    owidProcessingLevel?: OwidProcessingLevel
-    owidSchemaVersion?: number
+    processingLevel?: ProcessingLevel
+    schemaVersion?: number
     shortName?: string
 }
 
-export const OwidEntityNameColumnDef = {
-    name: OwidTableNames.Entity,
-    slug: OwidTableSlugs.entityName,
+export const EntityNameColumnDef = {
+    name: ChartsTableNames.Entity,
+    slug: ChartsTableSlugs.entityName,
     type: ColumnTypeNames.EntityName,
 }
 
-export const OwidEntityIdColumnDef = {
-    slug: OwidTableSlugs.entityId,
+export const EntityIdColumnDef = {
+    slug: ChartsTableSlugs.entityId,
     type: ColumnTypeNames.EntityId,
 }
 
-export const OwidEntityCodeColumnDef = {
-    name: OwidTableNames.Code,
-    slug: OwidTableSlugs.entityCode,
+export const EntityCodeColumnDef = {
+    name: ChartsTableNames.Code,
+    slug: ChartsTableSlugs.entityCode,
     type: ColumnTypeNames.EntityCode,
 }
 
-export const StandardOwidColumnDefs: OwidColumnDef[] = [
-    OwidEntityNameColumnDef,
-    OwidEntityIdColumnDef,
-    OwidEntityCodeColumnDef,
+export const StandardColumnDefs: ColumnDef[] = [
+    EntityNameColumnDef,
+    EntityIdColumnDef,
+    EntityCodeColumnDef,
 ]
 
-// This is a row with the additional columns specific to our OWID data model
-export interface OwidRow extends CoreRow {
+// This is a row with the additional columns specific to our data model
+export interface Row extends CoreRow {
     entityName: EntityName
     time: Time
     entityCode?: EntityCode
@@ -296,7 +296,7 @@ export interface OwidRow extends CoreRow {
     date?: string
 }
 
-export interface OwidVariableRow<ValueType extends PrimitiveType> {
+export interface VariableRow<ValueType extends PrimitiveType> {
     entityName: EntityName
     time: Time
     value: ValueType

package/src/types/domainTypes/Posts.ts

@@ -1,4 +1,4 @@
-import { OwidGdocType } from "../gdocTypes/Gdoc.js"
+import { GdocType } from "../gdocTypes/Gdoc.js"
 import { WP_PostType } from "../wordpressTypes/WordpressTypes.js"
 import { RelatedChart } from "../grapherTypes/GrapherTypes.js"
 import { TocHeading } from "./Toc.js"
@@ -15,7 +15,7 @@ export interface FormattedPost extends FullPost {
 export interface IndexPost {
     title: string
     slug: string
-    type?: WP_PostType | OwidGdocType
+    type?: WP_PostType | GdocType
     date: Date
     modifiedDate: Date
     authors: string[]

package/src/types/domainTypes/Search.ts

@@ -4,14 +4,14 @@ import type {
     Hit,
     HitHighlightResult,
 } from "instantsearch.js"
-import { OwidGdocType } from "../gdocTypes/Gdoc.js"
+import { GdocType } from "../gdocTypes/Gdoc.js"
 import { GrapherTabName } from "../grapherTypes/GrapherTypes.js"
 import * as z from "zod/mini"
 
 export const PagesIndexRecordSchema = z.object({
     objectID: z.string(),
     importance: z.number(),
-    type: z.enum(OwidGdocType),
+    type: z.enum(GdocType),
     slug: z.string(),
     title: z.string(),
     content: z.string(),
@@ -176,7 +176,7 @@ export type DataInsightHit = {
     thumbnailUrl: string
     date: string
     slug: string
-    type: OwidGdocType.DataInsight
+    type: GdocType.DataInsight
     objectID: string
     __position: number
 }
@@ -188,7 +188,7 @@ export type FlatArticleHit = {
     thumbnailUrl: string
     date: string
     slug: string
-    type: OwidGdocType.Article | OwidGdocType.AboutPage
+    type: GdocType.Article | GdocType.AboutPage
     content: string
     authors: string[]
     objectID: string
@@ -199,7 +199,7 @@ export type StackedArticleHit = {
     title: string
     thumbnailUrl: string
     slug: string
-    type: OwidGdocType.Article | OwidGdocType.AboutPage
+    type: GdocType.Article | GdocType.AboutPage
     content: string
     objectID: string
     __position: number
@@ -210,7 +210,7 @@ export type SearchFlatArticleResponse = SearchResponse<FlatArticleHit>
 
 export type TopicPageHit = {
     title: string
-    type: OwidGdocType.TopicPage | OwidGdocType.LinearTopicPage
+    type: GdocType.TopicPage | GdocType.LinearTopicPage
     slug: string
     excerpt: string
     excerptLong?: string[]

package/src/types/domainTypes/Various.ts

@@ -2,7 +2,7 @@ import { Nominal } from "../NominalType"
 
 export type Integer = number
 
-export type OwidVariableId = Integer // remove.
+export type VariableId = Integer // remove.
 
 export type JsonString = string
 export type Base64String = Nominal<string, "Base64">