feat: pure-js sql client agnostic base lib

Author: gregnr

package-lock.json

@@ -15,12 +15,24 @@
   "imports": {
     "#package.json": "./package.json"
   },
+  "exports": {
+    ".": {
+      "types": "./dist/lib/index.d.ts",
+      "require": "./dist/lib/index.cjs",
+      "import": "./dist/lib/index.js"
+    },
+    "./base": {
+      "types": "./dist/lib/base.d.ts",
+      "require": "./dist/lib/base.cjs",
+      "import": "./dist/lib/base.js"
+    }
+  },
   "repository": "supabase/postgres-meta",
   "scripts": {
     "check": "tsc -p tsconfig.json --noEmit",
     "clean": "rimraf dist tsconfig.tsbuildinfo",
     "format": "prettier --write '{src,test}/**/*.ts' '*.ts'",
-    "build": "tsc -p tsconfig.json && cpy 'src/lib/sql/*.sql' dist/lib/sql",
+    "build": "tsup",
     "docs:export": "PG_META_EXPORT_DOCS=true node --loader ts-node/esm src/server/server.ts > openapi.json",
     "gen:types:typescript": "PG_META_GENERATE_TYPES=typescript node --loader ts-node/esm src/server/server.ts",
     "gen:types:go": "PG_META_GENERATE_TYPES=go node --loader ts-node/esm src/server/server.ts",
@@ -66,7 +78,9 @@
     "pino-pretty": "^10.2.3",
     "rimraf": "^5.0.5",
     "ts-node": "^10.9.1",
+    "tsup": "^8.1.0",
     "typescript": "^5.2.2",
+    "vite": "^5.3.1",
     "vitest": "^1.2.2"
   }
 }

package.json

@@ -1,76 +1,12 @@
 import { PoolConfig } from 'pg'
-import * as Parser from './Parser.js'
-import PostgresMetaColumnPrivileges from './PostgresMetaColumnPrivileges.js'
-import PostgresMetaColumns from './PostgresMetaColumns.js'
-import PostgresMetaConfig from './PostgresMetaConfig.js'
-import PostgresMetaExtensions from './PostgresMetaExtensions.js'
-import PostgresMetaForeignTables from './PostgresMetaForeignTables.js'
-import PostgresMetaFunctions from './PostgresMetaFunctions.js'
-import PostgresMetaIndexes from './PostgresMetaIndexes.js'
-import PostgresMetaMaterializedViews from './PostgresMetaMaterializedViews.js'
-import PostgresMetaPolicies from './PostgresMetaPolicies.js'
-import PostgresMetaPublications from './PostgresMetaPublications.js'
-import PostgresMetaRelationships from './PostgresMetaRelationships.js'
-import PostgresMetaRoles from './PostgresMetaRoles.js'
-import PostgresMetaSchemas from './PostgresMetaSchemas.js'
-import PostgresMetaTablePrivileges from './PostgresMetaTablePrivileges.js'
-import PostgresMetaTables from './PostgresMetaTables.js'
-import PostgresMetaTriggers from './PostgresMetaTriggers.js'
-import PostgresMetaTypes from './PostgresMetaTypes.js'
-import PostgresMetaVersion from './PostgresMetaVersion.js'
-import PostgresMetaViews from './PostgresMetaViews.js'
+import PostgresMetaBase from './PostgresMetaBase.js'
 import { init } from './db.js'
-import { PostgresMetaResult } from './types.js'
-
-export default class PostgresMeta {
-  query: (sql: string) => Promise<PostgresMetaResult<any>>
-  end: () => Promise<void>
-  columnPrivileges: PostgresMetaColumnPrivileges
-  columns: PostgresMetaColumns
-  config: PostgresMetaConfig
-  extensions: PostgresMetaExtensions
-  foreignTables: PostgresMetaForeignTables
-  functions: PostgresMetaFunctions
-  indexes: PostgresMetaIndexes
-  materializedViews: PostgresMetaMaterializedViews
-  policies: PostgresMetaPolicies
-  publications: PostgresMetaPublications
-  relationships: PostgresMetaRelationships
-  roles: PostgresMetaRoles
-  schemas: PostgresMetaSchemas
-  tablePrivileges: PostgresMetaTablePrivileges
-  tables: PostgresMetaTables
-  triggers: PostgresMetaTriggers
-  types: PostgresMetaTypes
-  version: PostgresMetaVersion
-  views: PostgresMetaViews
-
-  parse = Parser.Parse
-  deparse = Parser.Deparse
-  format = Parser.Format
 
+export default class PostgresMeta extends PostgresMetaBase {
   constructor(config: PoolConfig) {
     const { query, end } = init(config)
-    this.query = query
+    super({ query, end })
+
     this.end = end
-    this.columnPrivileges = new PostgresMetaColumnPrivileges(this.query)
-    this.columns = new PostgresMetaColumns(this.query)
-    this.config = new PostgresMetaConfig(this.query)
-    this.extensions = new PostgresMetaExtensions(this.query)
-    this.foreignTables = new PostgresMetaForeignTables(this.query)
-    this.functions = new PostgresMetaFunctions(this.query)
-    this.indexes = new PostgresMetaIndexes(this.query)
-    this.materializedViews = new PostgresMetaMaterializedViews(this.query)
-    this.policies = new PostgresMetaPolicies(this.query)
-    this.publications = new PostgresMetaPublications(this.query)
-    this.relationships = new PostgresMetaRelationships(this.query)
-    this.roles = new PostgresMetaRoles(this.query)
-    this.schemas = new PostgresMetaSchemas(this.query)
-    this.tablePrivileges = new PostgresMetaTablePrivileges(this.query)
-    this.tables = new PostgresMetaTables(this.query)
-    this.triggers = new PostgresMetaTriggers(this.query)
-    this.types = new PostgresMetaTypes(this.query)
-    this.version = new PostgresMetaVersion(this.query)
-    this.views = new PostgresMetaViews(this.query)
   }
 }

src/lib/PostgresMeta.ts

@@ -0,0 +1,80 @@
+import * as Parser from './Parser.js'
+import PostgresMetaColumnPrivileges from './PostgresMetaColumnPrivileges.js'
+import PostgresMetaColumns from './PostgresMetaColumns.js'
+import PostgresMetaConfig from './PostgresMetaConfig.js'
+import PostgresMetaExtensions from './PostgresMetaExtensions.js'
+import PostgresMetaForeignTables from './PostgresMetaForeignTables.js'
+import PostgresMetaFunctions from './PostgresMetaFunctions.js'
+import PostgresMetaIndexes from './PostgresMetaIndexes.js'
+import PostgresMetaMaterializedViews from './PostgresMetaMaterializedViews.js'
+import PostgresMetaPolicies from './PostgresMetaPolicies.js'
+import PostgresMetaPublications from './PostgresMetaPublications.js'
+import PostgresMetaRelationships from './PostgresMetaRelationships.js'
+import PostgresMetaRoles from './PostgresMetaRoles.js'
+import PostgresMetaSchemas from './PostgresMetaSchemas.js'
+import PostgresMetaTablePrivileges from './PostgresMetaTablePrivileges.js'
+import PostgresMetaTables from './PostgresMetaTables.js'
+import PostgresMetaTriggers from './PostgresMetaTriggers.js'
+import PostgresMetaTypes from './PostgresMetaTypes.js'
+import PostgresMetaVersion from './PostgresMetaVersion.js'
+import PostgresMetaViews from './PostgresMetaViews.js'
+import { EndFn, QueryFn } from './types.js'
+
+export type PostgresMetaBaseOptions = {
+  query: QueryFn
+  end: EndFn
+}
+
+export default class PostgresMetaBase {
+  query: QueryFn
+  end: EndFn
+
+  columnPrivileges: PostgresMetaColumnPrivileges
+  columns: PostgresMetaColumns
+  config: PostgresMetaConfig
+  extensions: PostgresMetaExtensions
+  foreignTables: PostgresMetaForeignTables
+  functions: PostgresMetaFunctions
+  indexes: PostgresMetaIndexes
+  materializedViews: PostgresMetaMaterializedViews
+  policies: PostgresMetaPolicies
+  publications: PostgresMetaPublications
+  relationships: PostgresMetaRelationships
+  roles: PostgresMetaRoles
+  schemas: PostgresMetaSchemas
+  tablePrivileges: PostgresMetaTablePrivileges
+  tables: PostgresMetaTables
+  triggers: PostgresMetaTriggers
+  types: PostgresMetaTypes
+  version: PostgresMetaVersion
+  views: PostgresMetaViews
+
+  parse = Parser.Parse
+  deparse = Parser.Deparse
+  format = Parser.Format
+
+  constructor(options: PostgresMetaBaseOptions) {
+    this.query = options.query
+    this.end = options.end
+
+    this.columnPrivileges = new PostgresMetaColumnPrivileges(this.query)
+    this.columns = new PostgresMetaColumns(this.query)
+    this.config = new PostgresMetaConfig(this.query)
+    this.extensions = new PostgresMetaExtensions(this.query)
+    this.foreignTables = new PostgresMetaForeignTables(this.query)
+    this.functions = new PostgresMetaFunctions(this.query)
+    this.indexes = new PostgresMetaIndexes(this.query)
+    this.materializedViews = new PostgresMetaMaterializedViews(this.query)
+    this.policies = new PostgresMetaPolicies(this.query)
+    this.publications = new PostgresMetaPublications(this.query)
+    this.relationships = new PostgresMetaRelationships(this.query)
+    this.roles = new PostgresMetaRoles(this.query)
+    this.schemas = new PostgresMetaSchemas(this.query)
+    this.tablePrivileges = new PostgresMetaTablePrivileges(this.query)
+    this.tables = new PostgresMetaTables(this.query)
+    this.triggers = new PostgresMetaTriggers(this.query)
+    this.types = new PostgresMetaTypes(this.query)
+    this.version = new PostgresMetaVersion(this.query)
+    this.views = new PostgresMetaViews(this.query)
+  }
+}

src/lib/PostgresMetaBase.ts

@@ -1,7 +1,7 @@
 import { ident, literal } from 'pg-format'
 import { DEFAULT_SYSTEM_SCHEMAS } from './constants.js'
 import { filterByList } from './helpers.js'
-import { columnPrivilegesSql } from './sql/index.js'
+import columnPrivilegesSql from './sql/column_privileges.sql'
 import {
   PostgresMetaResult,
   PostgresColumnPrivileges,

src/lib/PostgresMetaColumnPrivileges.ts

@@ -1,7 +1,7 @@
 import { ident, literal } from 'pg-format'
 import PostgresMetaTables from './PostgresMetaTables.js'
 import { DEFAULT_SYSTEM_SCHEMAS } from './constants.js'
-import { columnsSql } from './sql/index.js'
+import columnsSql from './sql/columns.sql'
 import { PostgresMetaResult, PostgresColumn } from './types.js'
 import { filterByList } from './helpers.js'
 

src/lib/PostgresMetaColumns.ts

@@ -1,4 +1,4 @@
-import { configSql } from './sql/index.js'
+import configSql from './sql/config.sql'
 import { PostgresMetaResult, PostgresConfig } from './types.js'
 
 export default class PostgresMetaConfig {

src/lib/PostgresMetaConfig.ts

@@ -1,5 +1,5 @@
 import { ident, literal } from 'pg-format'
-import { extensionsSql } from './sql/index.js'
+import extensionsSql from './sql/extensions.sql'
 import { PostgresMetaResult, PostgresExtension } from './types.js'
 
 export default class PostgresMetaExtensions {

src/lib/PostgresMetaExtensions.ts

@@ -1,6 +1,7 @@
 import { literal } from 'pg-format'
 import { coalesceRowsToArray, filterByList } from './helpers.js'
-import { columnsSql, foreignTablesSql } from './sql/index.js'
+import columnsSql from './sql/columns.sql'
+import foreignTablesSql from './sql/foreign_tables.sql'
 import { PostgresMetaResult, PostgresForeignTable } from './types.js'
 
 export default class PostgresMetaForeignTables {

src/lib/PostgresMetaForeignTables.ts

@@ -1,7 +1,7 @@
 import { ident, literal } from 'pg-format'
 import { DEFAULT_SYSTEM_SCHEMAS } from './constants.js'
 import { filterByList } from './helpers.js'
-import { functionsSql } from './sql/index.js'
+import functionsSql from './sql/functions.sql'
 import { PostgresMetaResult, PostgresFunction, PostgresFunctionCreate } from './types.js'
 
 export default class PostgresMetaFunctions {

src/lib/PostgresMetaFunctions.ts

@@ -1,7 +1,7 @@
 import { ident, literal } from 'pg-format'
 import { DEFAULT_SYSTEM_SCHEMAS } from './constants.js'
 import { filterByList } from './helpers.js'
-import { indexesSql } from './sql/index.js'
+import indexesSql from './sql/indexes.sql'
 import { PostgresMetaResult, PostgresIndex } from './types.js'
 
 export default class PostgresMetaFunctions {

src/lib/PostgresMetaIndexes.ts

@@ -1,6 +1,7 @@
 import { literal } from 'pg-format'
 import { coalesceRowsToArray, filterByList } from './helpers.js'
-import { columnsSql, materializedViewsSql } from './sql/index.js'
+import columnsSql from './sql/columns.sql'
+import materializedViewsSql from './sql/materialized_views.sql'
 import { PostgresMetaResult, PostgresMaterializedView } from './types.js'
 
 export default class PostgresMetaMaterializedViews {

src/lib/PostgresMetaMaterializedViews.ts

@@ -1,7 +1,7 @@
 import { ident, literal } from 'pg-format'
 import { DEFAULT_SYSTEM_SCHEMAS } from './constants.js'
 import { filterByList } from './helpers.js'
-import { policiesSql } from './sql/index.js'
+import policiesSql from './sql/policies.sql'
 import { PostgresMetaResult, PostgresPolicy } from './types.js'
 
 export default class PostgresMetaPolicies {

src/lib/PostgresMetaPolicies.ts

@@ -1,5 +1,5 @@
 import { ident, literal } from 'pg-format'
-import { publicationsSql } from './sql/index.js'
+import publicationsSql from './sql/publications.sql'
 import { PostgresMetaResult, PostgresPublication, PostgresTable } from './types.js'
 
 export default class PostgresMetaPublications {

src/lib/PostgresMetaPublications.ts

@@ -1,6 +1,7 @@
 import { literal } from 'pg-format'
 import { DEFAULT_SYSTEM_SCHEMAS } from './constants.js'
-import { tableRelationshipsSql, viewsKeyDependenciesSql } from './sql/index.js'
+import tableRelationshipsSql from './sql/table_relationships.sql'
+import viewsKeyDependenciesSql from './sql/views_key_dependencies.sql'
 import { PostgresMetaResult, PostgresRelationship } from './types.js'
 
 /*

src/lib/PostgresMetaRelationships.ts

@@ -1,5 +1,5 @@
 import { ident, literal } from 'pg-format'
-import { rolesSql } from './sql/index.js'
+import rolesSql from './sql/roles.sql'
 import {
   PostgresMetaResult,
   PostgresRole,

src/lib/PostgresMetaRoles.ts

@@ -1,6 +1,6 @@
 import { ident, literal } from 'pg-format'
 import { DEFAULT_SYSTEM_SCHEMAS } from './constants.js'
-import { schemasSql } from './sql/index.js'
+import schemasSql from './sql/schemas.sql'
 import {
   PostgresMetaResult,
   PostgresSchema,

src/lib/PostgresMetaSchemas.ts

@@ -1,7 +1,7 @@
 import { ident, literal } from 'pg-format'
 import { DEFAULT_SYSTEM_SCHEMAS } from './constants.js'
 import { filterByList } from './helpers.js'
-import { tablePrivilegesSql } from './sql/index.js'
+import tablePrivilegesSql from './sql/table_privileges.sql'
 import {
   PostgresMetaResult,
   PostgresTablePrivileges,

src/lib/PostgresMetaTablePrivileges.ts

@@ -1,7 +1,8 @@
 import { ident, literal } from 'pg-format'
 import { DEFAULT_SYSTEM_SCHEMAS } from './constants.js'
 import { coalesceRowsToArray, filterByList } from './helpers.js'
-import { columnsSql, tablesSql } from './sql/index.js'
+import columnsSql from './sql/columns.sql'
+import tablesSql from './sql/tables.sql'
 import {
   PostgresMetaResult,
   PostgresTable,

src/lib/PostgresMetaTables.ts

@@ -1,7 +1,7 @@
 import { ident, literal } from 'pg-format'
 import { DEFAULT_SYSTEM_SCHEMAS } from './constants.js'
 import { filterByList } from './helpers.js'
-import { triggersSql } from './sql/index.js'
+import triggersSql from './sql/triggers.sql'
 import { PostgresMetaResult, PostgresTrigger } from './types.js'
 
 export default class PostgresMetaTriggers {

src/lib/PostgresMetaTriggers.ts

@@ -1,6 +1,6 @@
 import { DEFAULT_SYSTEM_SCHEMAS } from './constants.js'
 import { filterByList } from './helpers.js'
-import { typesSql } from './sql/index.js'
+import typesSql from './sql/types.sql'
 import { PostgresMetaResult, PostgresType } from './types.js'
 
 export default class PostgresMetaTypes {

src/lib/PostgresMetaTypes.ts

@@ -1,4 +1,4 @@
-import { versionSql } from './sql/index.js'
+import versionSql from './sql/version.sql'
 import { PostgresMetaResult, PostgresVersion } from './types.js'
 
 export default class PostgresMetaVersion {

src/lib/PostgresMetaVersion.ts

@@ -1,7 +1,8 @@
 import { literal } from 'pg-format'
 import { DEFAULT_SYSTEM_SCHEMAS } from './constants.js'
 import { coalesceRowsToArray, filterByList } from './helpers.js'
-import { columnsSql, viewsSql } from './sql/index.js'
+import columnsSql from './sql/columns.sql'
+import viewsSql from './sql/views.sql'
 import { PostgresMetaResult, PostgresView } from './types.js'
 
 export default class PostgresMetaViews {

src/lib/PostgresMetaViews.ts

@@ -0,0 +1,29 @@
+export { default as PostgresMetaBase } from './PostgresMetaBase.js'
+export { wrapError, wrapResult } from './helpers.js'
+export {
+  EndFn,
+  PostgresColumn,
+  PostgresConfig,
+  PostgresExtension,
+  PostgresFunction,
+  PostgresFunctionCreate,
+  PostgresIndex,
+  PostgresMaterializedView,
+  PostgresMetaErr,
+  PostgresMetaOk,
+  PostgresMetaResult,
+  PostgresPolicy,
+  PostgresPrimaryKey,
+  PostgresPublication,
+  PostgresRelationship,
+  PostgresRole,
+  PostgresSchema,
+  PostgresSchemaCreate,
+  PostgresSchemaUpdate,
+  PostgresTable,
+  PostgresTrigger,
+  PostgresType,
+  PostgresVersion,
+  PostgresView,
+  QueryFn,
+} from './types.js'

src/lib/base.ts

@@ -1,7 +1,7 @@
 import pg, { PoolConfig } from 'pg'
-import { DatabaseError } from 'pg-protocol'
 import { parse as parseArray } from 'postgres-array'
-import { PostgresMetaResult } from './types.js'
+import { wrapError, wrapResult } from './helpers.js'
+import { EndFn, QueryFn } from './types.js'
 
 pg.types.setTypeParser(pg.types.builtins.INT8, (x) => {
   const asNumber = Number(x)
@@ -21,8 +21,8 @@ pg.types.setTypeParser(600, (x) => x) // point
 pg.types.setTypeParser(1017, (x) => x) // _point
 
 export const init: (config: PoolConfig) => {
-  query: (sql: string) => Promise<PostgresMetaResult<any>>
-  end: () => Promise<void>
+  query: QueryFn
+  end: EndFn
 } = (config) => {
   // node-postgres ignores config.ssl if any of sslmode, sslca, sslkey, sslcert,
   // sslrootcert are in the connection string. Here we allow setting sslmode in
@@ -76,77 +76,9 @@ export const init: (config: PoolConfig) => {
         if (Array.isArray(res)) {
           res = res.reverse().find((x) => x.rows.length !== 0) ?? { rows: [] }
         }
-        return { data: res.rows, error: null }
-      } catch (error: any) {
-        if (error instanceof DatabaseError) {
-          // Roughly based on:
-          // - https://github.com/postgres/postgres/blob/fc4089f3c65a5f1b413a3299ba02b66a8e5e37d0/src/interfaces/libpq/fe-protocol3.c#L1018
-          // - https://github.com/brianc/node-postgres/blob/b1a8947738ce0af004cb926f79829bb2abc64aa6/packages/pg/lib/native/query.js#L33
-          let formattedError = ''
-          {
-            if (error.severity) {
-              formattedError += `${error.severity}:  `
-            }
-            if (error.code) {
-              formattedError += `${error.code}: `
-            }
-            if (error.message) {
-              formattedError += error.message
-            }
-            formattedError += '\n'
-            if (error.position) {
-              // error.position is 1-based
-              const position = Number(error.position) - 1
-
-              let line = ''
-              let lineNumber = 0
-              let lineOffset = 0
-
-              const lines = sql.split('\n')
-              let currentOffset = 0
-              for (let i = 0; i < lines.length; i++) {
-                if (currentOffset + lines[i].length > position) {
-                  line = lines[i]
-                  lineNumber = i + 1 // 1-based
-                  lineOffset = position - currentOffset
-                  break
-                }
-                currentOffset += lines[i].length + 1 // 1 extra offset for newline
-              }
-              formattedError += `LINE ${lineNumber}: ${line}
-${' '.repeat(5 + lineNumber.toString().length + 2 + lineOffset)}^
-`
-            }
-            if (error.detail) {
-              formattedError += `DETAIL:  ${error.detail}
-`
-            }
-            if (error.hint) {
-              formattedError += `HINT:  ${error.hint}
-`
-            }
-            if (error.internalQuery) {
-              formattedError += `QUERY:  ${error.internalQuery}
-`
-            }
-            if (error.where) {
-              formattedError += `CONTEXT:  ${error.where}
-`
-            }
-          }
-
-          return {
-            data: null,
-            error: {
-              ...error,
-              // error.message is non-enumerable
-              message: error.message,
-              formattedError,
-            },
-          }
-        }
-
-        return { data: null, error: { message: error.message } }
+        return wrapResult(res.rows)
+      } catch (error) {
+        return wrapError(error, sql)
       }
     },
 

src/lib/db.ts

@@ -1,4 +1,86 @@
 import { literal } from 'pg-format'
+import { DatabaseError } from 'pg-protocol'
+import { PostgresMetaErr, PostgresMetaOk } from './types.js'
+
+export const wrapResult = <T>(result: T): PostgresMetaOk<T> => {
+  return { data: result, error: null }
+}
+
+export const wrapError = (error: unknown, sql: string): PostgresMetaErr => {
+  if (error instanceof DatabaseError) {
+    // Roughly based on:
+    // - https://github.com/postgres/postgres/blob/fc4089f3c65a5f1b413a3299ba02b66a8e5e37d0/src/interfaces/libpq/fe-protocol3.c#L1018
+    // - https://github.com/brianc/node-postgres/blob/b1a8947738ce0af004cb926f79829bb2abc64aa6/packages/pg/lib/native/query.js#L33
+    let formattedError = ''
+    {
+      if (error.severity) {
+        formattedError += `${error.severity}:  `
+      }
+      if (error.code) {
+        formattedError += `${error.code}: `
+      }
+      if (error.message) {
+        formattedError += error.message
+      }
+      formattedError += '\n'
+      if (error.position) {
+        // error.position is 1-based
+        const position = Number(error.position) - 1
+
+        let line = ''
+        let lineNumber = 0
+        let lineOffset = 0
+
+        const lines = sql.split('\n')
+        let currentOffset = 0
+        for (let i = 0; i < lines.length; i++) {
+          if (currentOffset + lines[i].length > position) {
+            line = lines[i]
+            lineNumber = i + 1 // 1-based
+            lineOffset = position - currentOffset
+            break
+          }
+          currentOffset += lines[i].length + 1 // 1 extra offset for newline
+        }
+        formattedError += `LINE ${lineNumber}: ${line}
+${' '.repeat(5 + lineNumber.toString().length + 2 + lineOffset)}^
+`
+      }
+      if (error.detail) {
+        formattedError += `DETAIL:  ${error.detail}
+`
+      }
+      if (error.hint) {
+        formattedError += `HINT:  ${error.hint}
+`
+      }
+      if (error.internalQuery) {
+        formattedError += `QUERY:  ${error.internalQuery}
+`
+      }
+      if (error.where) {
+        formattedError += `CONTEXT:  ${error.where}
+`
+      }
+    }
+
+    return {
+      data: null,
+      error: {
+        ...error,
+        // error.message is non-enumerable
+        message: error.message,
+        formattedError,
+      },
+    }
+  }
+
+  if (error instanceof Error) {
+    return { data: null, error: { message: error.message } }
+  }
+
+  throw error
+}
 
 export const coalesceRowsToArray = (source: string, filter: string) => {
   return `

src/lib/helpers.ts

@@ -1,26 +1,3 @@
+export * from './base.js'
+
 export { default as PostgresMeta } from './PostgresMeta.js'
-export {
-  PostgresMetaOk,
-  PostgresMetaErr,
-  PostgresMetaResult,
-  PostgresColumn,
-  PostgresConfig,
-  PostgresExtension,
-  PostgresFunction,
-  PostgresFunctionCreate,
-  PostgresIndex,
-  PostgresMaterializedView,
-  PostgresPolicy,
-  PostgresPrimaryKey,
-  PostgresPublication,
-  PostgresRelationship,
-  PostgresRole,
-  PostgresSchema,
-  PostgresSchemaCreate,
-  PostgresSchemaUpdate,
-  PostgresTable,
-  PostgresTrigger,
-  PostgresType,
-  PostgresVersion,
-  PostgresView,
-} from './types.js'

src/lib/index.ts

@@ -16,6 +16,9 @@ export interface PostgresMetaErr {
 
 export type PostgresMetaResult<T> = PostgresMetaOk<T> | PostgresMetaErr
 
+export type QueryFn = <T>(sql: string) => Promise<PostgresMetaResult<T[]>>
+export type EndFn = () => Promise<void>
+
 export const postgresColumnSchema = Type.Object({
   table_id: Type.Integer(),
   schema: Type.String(),

src/lib/sql/index.ts

@@ -0,0 +1,4 @@
+declare module '*.sql' {
+  const sql: string;
+  export default sql;
+}

src/lib/types.ts

@@ -0,0 +1,43 @@
+import { defineConfig } from 'tsup'
+
+export default defineConfig([
+  {
+    name: 'lib',
+    entry: {
+      index: './src/lib/index.ts',
+      base: './src/lib/base.ts',
+    },
+
+    format: ['cjs', 'esm'],
+    dts: {
+      compilerOptions: {
+        incremental: false,
+      },
+    },
+    sourcemap: true,
+    clean: true,
+    loader: {
+      '.sql': 'text',
+    },
+    outDir: 'dist/lib',
+  },
+  {
+    name: 'server',
+    entry: {
+      server: './src/server/server.ts',
+    },
+
+    format: ['esm'],
+    dts: {
+      compilerOptions: {
+        incremental: false,
+      },
+    },
+    sourcemap: true,
+    clean: true,
+    loader: {
+      '.sql': 'text',
+    },
+    outDir: 'dist/server',
+  },
+])

src/types/sql.d.ts

@@ -1,7 +1,23 @@
 /// <reference types="vitest" />
+import { readFile } from 'fs/promises'
+import { Plugin } from 'vite'
 import { defineConfig } from 'vitest/config'
 
+function sqlLoaderPlugin(): Plugin {
+  return {
+    name: 'sql-loader',
+    async transform(code, id) {
+      if (id.endsWith('.sql')) {
+        const textContent = await readFile(id, 'utf8')
+        return `export default ${JSON.stringify(textContent)};`
+      }
+      return code
+    },
+  }
+}
+
 export default defineConfig({
+  plugins: [sqlLoaderPlugin()],
   test: {
     maxConcurrency: 1,
     // https://github.com/vitest-dev/vitest/issues/317#issuecomment-1542319622