🔨 add exports for db types

db/db.ts

@@ -10,6 +10,10 @@ import {
     GRAPHER_DB_PORT,
 } from "../settings/serverSettings.js"
 import { registerExitHandler } from "./cleanup.js"
+import {
+    PostsGdocsXImagesRow,
+    PostsGdocsXImagesRowTableName,
+} from "./sql-ts/Database.js"
 let typeormDataSource: DataSource
 
 export const getConnection = async (
@@ -105,6 +109,10 @@ export const knexInstance = (): Knex<any, any[]> => {
     return _knexInstance
 }
 
+// export const bla = knexInstance()
+//     .from<PostsGdocsXImagesRow>(PostsGdocsXImagesRowTableName)
+//     .select("gdocId")
+
 export const knexTable = (table: string): Knex.QueryBuilder =>
     knexInstance().table(table)
 

db/tests/basic.test.ts

@@ -88,3 +88,9 @@ test("timestamps are automatically created and updated", async () => {
         }
     }
 })
+
+test("knex interface", async () => {
+    if (!knexInstance) throw new Error("Knex connection not initialized")
+    // const result = await knexInstance<
+    // expect(result.rows[0].solution).toBe(2)
+})

packages/@ourworldindata/types/src/dbTypes/ChartTags.ts

@@ -1,5 +1,5 @@
 import { KeyChartLevel } from "../grapherTypes/GrapherTypes.js"
-import { Tag } from "./Tags.js"
+import { TagsRow } from "./Tags.js"
 
 export const ChartTagsRowTableName = "chart_tags"
 export interface ChartTagsRowForInsert {
@@ -16,5 +16,5 @@ export type ChartTagsRow = Required<ChartTagsRowForInsert>
  * A common minimal union of the tags and chart_tags entities.
  * Used anywhere we're using the TagBadge component.
  */
-export type ChartTagJoin = Pick<Tag, "id" | "name"> &
+export type ChartTagJoin = Pick<TagsRow, "id" | "name"> &
     Partial<Pick<ChartTagsRow, "isApproved" | "keyChartLevel">>

packages/@ourworldindata/types/src/dbTypes/Charts.ts

@@ -30,13 +30,11 @@ export function serializeChartConfig(config: GrapherInterface): JsonString {
     return JSON.stringify(config)
 }
 
-export function parseChartRevisionsRow(row: ChartsRowRaw): ChartsRowEnriched {
+export function parseChartsRow(row: ChartsRowRaw): ChartsRowEnriched {
     return { ...row, config: parseChartConfig(row.config) }
 }
 
-export function serializeChartRevisionsRow(
-    row: ChartsRowEnriched
-): ChartsRowRaw {
+export function serializeChartsRow(row: ChartsRowEnriched): ChartsRowRaw {
     return {
         ...row,
         config: serializeChartConfig(row.config),

packages/@ourworldindata/types/src/dbTypes/Posts.ts

@@ -5,6 +5,7 @@ import {
 } from "../gdocTypes/Gdoc.js"
 import { FormattingOptions } from "../Wordpress.js"
 
+export const PostRowTableName = "posts"
 export interface PostRowPlainFields {
     id: number
     title: string
@@ -42,3 +43,45 @@ export type PostRowEnriched = Required<PostRowPlainFields & PostRowParsedFields>
 export interface PostRowWithGdocPublishStatus extends PostRowRaw {
     isGdocPublished: boolean
 }
+
+export function parsePostFormattingOptions(
+    formattingOptions: string
+): FormattingOptions {
+    return JSON.parse(formattingOptions)
+}
+
+export function parsePostAuthors(authors: string): string[] {
+    const authorsJson = JSON.parse(authors)
+    return authorsJson
+}
+
+export function parsePostArchieml(archieml: string): any {
+    // TODO: validation would be nice here
+    return JSON.parse(archieml)
+}
+
+export function parsePostRow(postRow: PostRowRaw): PostRowEnriched {
+    return {
+        ...postRow,
+        authors: postRow.authors ? parsePostAuthors(postRow.authors) : null,
+        formattingOptions: postRow.formattingOptions
+            ? parsePostFormattingOptions(postRow.formattingOptions)
+            : null,
+        archieml: postRow.archieml ? parsePostArchieml(postRow.archieml) : null,
+        archieml_update_statistics: postRow.archieml_update_statistics
+            ? JSON.parse(postRow.archieml_update_statistics)
+            : null,
+    }
+}
+
+export function serializePostRow(postRow: PostRowEnriched): PostRowRaw {
+    return {
+        ...postRow,
+        authors: JSON.stringify(postRow.authors),
+        formattingOptions: JSON.stringify(postRow.formattingOptions),
+        archieml: JSON.stringify(postRow.archieml),
+        archieml_update_statistics: JSON.stringify(
+            postRow.archieml_update_statistics
+        ),
+    }
+}

packages/@ourworldindata/types/src/dbTypes/Tags.ts

@@ -1,11 +1,13 @@
 /** the entity in the `tags` table */
-export interface Tag {
-    id: number
+export const TagsRowTableName = "tags"
+export interface TagsRowForInsert {
+    createdAt?: Date
+    id?: number
+    isBulkImport?: number
     name: string
-    createdAt: Date
-    updatedAt: Date
-    parentId: number
-    isBulkImport: boolean
-    specialType: string
-    slug: string | null
+    parentId?: number | null
+    slug?: string | null
+    specialType?: string | null
+    updatedAt?: Date | null
 }
+export type TagsRow = Required<TagsRowForInsert>

packages/@ourworldindata/types/src/domainTypes/Tag.ts

@@ -0,0 +1,10 @@
+export interface Tag {
+    id: number
+    name: string
+    createdAt: Date
+    updatedAt: Date
+    parentId: number
+    isBulkImport: boolean
+    specialType: string
+    slug: string | null
+}

packages/@ourworldindata/types/src/gdocTypes/Gdoc.ts

@@ -1,4 +1,4 @@
-import { Tag } from "../dbTypes/Tags.js"
+import { Tag } from "../domainTypes/Tag.js"
 import { RelatedChart } from "../grapherTypes/GrapherTypes.js"
 import { BreadcrumbItem } from "../domainTypes/Site.js"
 import { TocHeadingWithTitleSupertitle } from "../domainTypes/Toc.js"