refactor: 💩 Refactors tables from JS file to TS

This is more of a kaizen - setting up a basic type for the tables. It's missing the "subitems" like columns typings.

Author: kiwicopple

dist/lib/interfaces/tables.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

src/api/tables.js renamed to src/api/tables.ts

@@ -3,12 +3,13 @@ const router = new Router()
 const { tables } = require('../lib/sql')
 const RunQuery = require('../lib/connectionPool')
 import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants/schemas'
+import { Tables } from '../lib/interfaces/tables'
 
 router.get('/', async (req, res) => {
   try {
     const { data } = await RunQuery(req.headers.pg, tables.list)
-    const query = req.query
-    let payload = data
+    const query: Fetch.QueryParams = req.query
+    let payload: Tables.Table[] = data
     if (!query?.includeSystemSchemas) payload = removeSystemSchemas(data)
     return res.status(200).json(payload)
   } catch (error) {
@@ -19,6 +20,19 @@ router.get('/', async (req, res) => {
 
 module.exports = router
 
-const removeSystemSchemas = (data) => {
+const removeSystemSchemas = (data: Tables.Table[]) => {
   return data.filter((x) => !DEFAULT_SYSTEM_SCHEMAS.includes(x.schema))
+}
+
+/**
+ * Types
+ */
+
+namespace Fetch {
+  /**
+   * @param {boolean} [includeSystemSchemas=false] - Return system schemas as well as user schemas
+   */
+  export interface QueryParams {
+    includeSystemSchemas: boolean
+  }
 }

src/lib/interfaces/tables.ts

@@ -0,0 +1,15 @@
+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
+  }
+
+}
+