refactor: match interfaces to SQL templates

Author: soedirgo

src/api/roles.ts

@@ -5,7 +5,7 @@ const { grants, roles } = sql
 import { coalesceRowsToArray } from '../lib/helpers'
 import { RunQuery } from '../lib/connectionPool'
 import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants/schemas'
-import { Roles } from '../lib/interfaces/roles'
+import { Roles } from '../lib/interfaces'
 
 /**
  * @param {boolean} [includeSystemSchemas=false] - Return system schemas as well as user schemas

src/api/schemas.ts

@@ -4,7 +4,7 @@ import sql = require('../lib/sql')
 const { schemas } = sql
 import { RunQuery } from '../lib/connectionPool'
 import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants/schemas'
-import { Schemas } from '../lib/interfaces/schemas'
+import { Schemas } from '../lib/interfaces'
 
 /**
  * @param {boolean} [includeSystemSchemas=false] - Return system schemas as well as user schemas

src/api/tables.ts

@@ -5,7 +5,7 @@ const { columns, grants, primary_keys, relationships, tables } = sql
 import { coalesceRowsToArray } from '../lib/helpers'
 import { RunQuery } from '../lib/connectionPool'
 import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants/schemas'
-import { Tables } from '../lib/interfaces/tables'
+import { Tables } from '../lib/interfaces'
 
 const router = Router()
 router.get('/', async (req, res) => {

src/api/types.ts

@@ -4,7 +4,7 @@ import sql = require('../lib/sql')
 const { types } = sql
 import { RunQuery } from '../lib/connectionPool'
 import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants/schemas'
-import { Types } from '../lib/interfaces/types'
+import { Types } from '../lib/interfaces'
 
 const router = Router()
 router.get('/', async (req, res) => {

src/lib/connectionPool.ts

@@ -1,4 +1,7 @@
 import pg = require('pg')
+// HACK: Number has 53 bits of precision, may overflow with bigint (64 bits).
+// Maybe use BigInt?
+// TODO: Use Date object for timestamptz?
 pg.types.setTypeParser(20, 'text', parseInt)
 const { Pool } = pg
 

src/lib/interfaces.ts

@@ -0,0 +1,125 @@
+export namespace Roles {
+  export interface Role {
+    name: string
+    id: number
+    has_create_db_privileges: boolean
+    is_super_user: boolean
+    has_replication_privileges: boolean
+    can_bypass_rls: boolean
+    valid_until: string | null
+    user_config: string | null
+    connections: number
+    max_user_connections: number
+    max_db_connections: number
+    grants: Grant[]
+  }
+
+  export interface Grant {
+    table_id: string
+    grantor: string
+    grantee: string
+    catalog: string
+    schema: string
+    table_name: string
+    privilege_type: string
+    is_grantable: boolean
+    with_hierarchy: boolean
+  }
+}
+
+export namespace Schemas {
+  export interface Schema {
+    catalog_name: string
+    name: string
+    owner: string
+    default_character_set_catalog: string | null
+    default_character_set_schema: string | null
+    default_character_set_name: string | null
+    sql_path: string | null
+  }
+}
+
+export namespace Tables {
+  export interface Table {
+    table_id: string
+    catalog: string
+    schema: string
+    name: string
+    is_insertable_into: boolean
+    is_typed: boolean
+    bytes: number
+    size: string
+
+    // pg_stat_all_tables columns
+    sequential_scans: number
+    sequential_scan_row_reads: number
+    index_scans: number
+    index_scan_row_reads: number
+    row_inserts: number
+    row_updates: number
+    row_deletes: number
+    row_hot_updates: number
+    live_rows: number
+    dead_rows: number
+    rows_modified_since_analyze: number
+    last_vacuum: string | null
+    last_autovacuum: string | null
+    last_analyze: string | null
+    last_autoanalyze: string | null
+    vacuum_count: number
+    autovacuum_count: number
+    analyze_count: number
+    autoanalyze_count: number
+
+    columns: Column[]
+    grants: Roles.Grant[]
+    primary_keys: PrimaryKey[]
+    relationships: Relationship[]
+  }
+
+  export interface Column {
+    schema: string
+    table: string
+    name: string
+    default_value: string | null
+    is_identity: boolean
+    is_nullable: boolean
+    is_updatable: boolean
+    data_type: string
+    format: string
+    identity_generation: string | null
+    table_id: string
+    description: string | null
+    enums: string[]
+  }
+
+  export interface PrimaryKey {
+    schema: string
+    table_name: string
+    name: string
+    table_id: string
+  }
+
+  export interface Relationship {
+    source_table_id: string
+    source_schema: string
+    source_table_name: string
+    source_column_name: string
+    target_table_id: string
+    target_table_schema: string
+    target_table_name: string
+    target_column_name: string
+    constraint_name: string
+  }
+}
+
+export namespace Types {
+  export interface Type {
+    type_id: string
+    name: string
+    schema: string
+    format: string
+    description: string | null
+    enums: string[]
+  }
+}