All files / owid-grapher/clientUtils owidTypes.ts

100% Statements 85/85
100% Branches 4/4
100% Functions 0/0
100% Lines 85/85

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 3071x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x                                                                                                                                                                                                                                                                                                                                                                                                                                                            
// todo: remove when we ditch Year and YearIsDay
export const EPOCH_DATE = "2020-01-21"
 
/** The "plot" is a chart without any header, footer or controls */
export const IDEAL_PLOT_ASPECT_RATIO: number = 1.8
 
export interface Box {
    x: number
    y: number
    width: number
    height: number
}
 
export type Integer = number
// TODO: remove duplicate definition, also available in CoreTable
export enum SortOrder {
    asc = "asc",
    desc = "desc",
}
 
export enum SortBy {
    entityName = "entityName",
    column = "column",
    total = "total",
}
 
export interface SortConfig {
    sortBy?: SortBy
    sortOrder?: SortOrder
    sortColumnSlug?: string
}
 
export type Year = Integer
export type Color = string
 
/**
 * A concrete point in time (year or date). It's always supposed to be a finite number, but we
 * cannot enforce this in TypeScript.
 */
export type Time = Integer
export type TimeRange = [Time, Time]
 
export type PrimitiveType = number | string | boolean
export type ValueRange = [number, number]
 
export enum ScaleType {
    linear = "linear",
    log = "log",
}
 
export interface RelatedChart {
    title: string
    slug: string
    variantName?: string | null
}
 
export type OwidVariableId = Integer // remove.
 
export interface FormattedPost extends FullPost {
    supertitle?: string
    lastUpdated?: string
    byline?: string
    info?: string
    html: string
    style?: string
    references: Record<string, unknown>[]
    footnotes: string[]
    tocHeadings: { text: string; slug: string; isSubheading: boolean }[]
    pageDesc: string
}
 
export enum SubNavId {
    about = "about",
    biodiversity = "biodiversity",
    coronavirus = "coronavirus",
    co2 = "co2",
    energy = "energy",
    forests = "forests",
    water = "water",
}
 
export interface FormattingOptions {
    toc?: boolean
    hideAuthors?: boolean
    bodyClassName?: string
    subnavId?: SubNavId
    subnavCurrentId?: string
    raw?: boolean
    hideDonateFooter?: boolean
    footnotes?: boolean
}
 
export interface KeyValueProps {
    [key: string]: string | boolean | undefined
}
 
export interface DataValueQueryArgs {
    variableId?: number
    entityId?: number
    chartId?: number
    year?: number
}
 
export interface DataValueConfiguration {
    queryArgs: DataValueQueryArgs
    template: string
}
 
export interface DataValueResult {
    value: number
    year: number
    unit?: string
    entityName: string
}
 
export interface DataValueProps extends DataValueResult {
    formattedValue?: string
    template: string
}
 
export interface GitCommit {
    author_email: string
    author_name: string
    body: string
    date: string
    hash: string
    message: string
}
 
export interface SerializedGridProgram {
    slug: string
    program: string
    lastCommit?: GitCommit
}
 
export interface TocHeading {
    text: string
    html?: string
    slug: string
    isSubheading: boolean
}
 
// todo; remove
export interface PostRow {
    id: number
    title: string
    slug: string
    type: WP_PostType
    status: string
    content: string
    published_at: Date | null
    updated_at: Date
}
 
export interface EntryMeta {
    slug: string
    title: string
    excerpt: string
    kpi: string
}
 
export interface CategoryWithEntries {
    name: string
    slug: string
    entries: EntryMeta[]
    subcategories: CategoryWithEntries[]
}
 
export enum WP_PostType {
    Post = "post",
    Page = "page",
}
 
export enum WP_MediaSizes {
    Thumbnail = "thumbnail",
}
 
export interface EntryNode {
    slug: string
    title: string
    // in some edge cases (entry alone in a subcategory), WPGraphQL returns
    // null instead of an empty string)
    excerpt: string | null
    kpi: string
}
 
export interface DocumentNode {
    id: number
    title: string
    slug: string
    content: string | null // if content is empty
}
 
export interface CategoryNode {
    name: string
    slug: string
    pages: any
    children: any
}
 
export interface PostReference {
    id: number
    title: string
    slug: string
}
 
export type FilterFnPostRestApi = (post: PostRestApi) => boolean
 
export interface PostRestApi {
    slug: string
    meta: {
        owid_publication_context_meta_field?: {
            immediate_newsletter?: boolean
            homepage?: boolean
            latest?: boolean
        }
    }
}
export interface FullPost {
    id: number
    type: WP_PostType
    slug: string
    path: string
    title: string
    date: Date
    modifiedDate: Date
    authors: string[]
    content: string
    excerpt?: string
    imageUrl?: string
    imageId?: number
    postId?: number
    relatedCharts?: RelatedChart[]
    glossary: boolean
}
 
// Exception format that can be easily given as an API error
export class JsonError extends Error {
    status: number
    constructor(message: string, status?: number) {
        super(message)
        this.status = status || 400
    }
}
 
export enum DeployStatus {
    queued = "queued",
    pending = "pending",
    // done = "done"
}
 
export interface DeployChange {
    timeISOString?: string
    authorName?: string
    authorEmail?: string
    message?: string
}
 
export interface Deploy {
    status: DeployStatus
    changes: DeployChange[]
}
 
export interface Annotation {
    entityName?: string
    year?: number
}
 
export enum DimensionProperty {
    y = "y",
    x = "x",
    size = "size",
    color = "color",
    table = "table",
}
 
// see CoreTableConstants.ts
export type ColumnSlug = string // a url friendly name for a column in a table. cannot have spaces
 
export enum Position {
    top = "top",
    right = "right",
    bottom = "bottom",
    left = "left",
}
 
export type PositionMap<Value> = {
    [key in Position]?: Value
}
 
export enum HorizontalAlign {
    left = "left",
    center = "center",
    right = "right",
}
 
export enum VerticalAlign {
    top = "top",
    middle = "middle",
    bottom = "bottom",
}
 
export interface GridParameters {
    rows: number
    columns: number
}