colocate config types with connectors

Author: mbostock

src/databases/bigquery.ts

@@ -1,9 +1,17 @@
 import {BigQuery} from "@google-cloud/bigquery";
 import {BigQueryDate, BigQueryDatetime, BigQueryTimestamp} from "@google-cloud/bigquery";
 import type {TableField, TableSchema} from "@google-cloud/bigquery";
-import type {BigQueryConfig, QueryTemplateFunction} from "./index.js";
+import type {QueryTemplateFunction} from "./index.js";
 import type {ColumnSchema} from "../runtime/index.js";
 
+export type BigQueryConfig = {
+  type: "bigquery";
+  apiKey?: string;
+  keyFilename?: string;
+  keyFile?: string;
+  projectId?: string;
+};
+
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 export default function bigquery({type, ...options}: BigQueryConfig): QueryTemplateFunction {
   return async (strings, ...params) => {

src/databases/databricks.ts

@@ -1,6 +1,6 @@
 import {DBSQLClient, DBSQLLogger, LogLevel, thrift} from "@databricks/sql";
 import type {DBSQLSession} from "@databricks/sql";
-import type {DatabricksConfig, QueryTemplateFunction} from "./index.js";
+import type {QueryTemplateFunction} from "./index.js";
 import {ColumnSchema} from "../runtime/index.js";
 
 type IOperation = Awaited<ReturnType<DBSQLSession["executeStatement"]>>;
@@ -9,6 +9,15 @@ type TColumnDesc = TTableSchema["columns"][0];
 type TTypeDesc = TColumnDesc["typeDesc"];
 const TTypeId = thrift.TCLIService_types.TTypeId;
 
+export type DatabricksConfig = {
+  type: "databricks";
+  host: string;
+  path: string;
+} & (
+  | {authType?: "access-token"; token: string}
+  | {authType: "databricks-oauth"; oauthClientId?: string; oauthClientSecret?: string}
+);
+
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 export default function databricks({type, ...options}: DatabricksConfig): QueryTemplateFunction {
   return async (strings, ...params) => {

src/databases/duckdb.ts

@@ -1,9 +1,15 @@
 import type {DuckDBResult, DuckDBType, Json} from "@duckdb/node-api";
 import {DuckDBConnection, DuckDBInstance} from "@duckdb/node-api";
 import {BIGINT, BIT, BLOB, BOOLEAN, DATE, DOUBLE, FLOAT, HUGEINT, INTEGER, INTERVAL, SMALLINT, TIME, TIMESTAMP, TIMESTAMP_MS, TIMESTAMP_NS, TIMESTAMP_S, TIMESTAMPTZ, TINYINT, UBIGINT, UHUGEINT, UINTEGER, USMALLINT, UTINYINT, UUID, VARCHAR, VARINT} from "@duckdb/node-api"; // prettier-ignore
-import type {DuckDBConfig, QueryTemplateFunction} from "./index.js";
+import type {QueryTemplateFunction} from "./index.js";
 import type {ColumnSchema} from "../runtime/index.js";
 
+export type DuckDBConfig = {
+  type: "duckdb";
+  path?: string;
+  options?: {[key: string]: string}; // https://duckdb.org/docs/stable/configuration/overview.html
+};
+
 export default function duckdb({path, options}: DuckDBConfig): QueryTemplateFunction {
   return async (strings, ...params) => {
     const instance = await DuckDBInstance.create(path, options);

src/databases/index.ts

@@ -4,6 +4,12 @@ import {json} from "node:stream/consumers";
 import {isEnoent} from "../lib/error.js";
 import {hash as getQueryHash, nameHash as getNameHash} from "../lib/hash.js";
 import type {ColumnSchema, QueryParam} from "../runtime/index.js";
+import type {BigQueryConfig} from "./bigquery.js";
+import type {DatabricksConfig} from "./databricks.js";
+import type {DuckDBConfig} from "./duckdb.js";
+import type {SQLiteConfig} from "./sqlite.js";
+import type {SnowflakeConfig} from "./snowflake.js";
+import type {PostgresConfig} from "./postgres.js";
 
 export type DatabaseConfig =
   | BigQueryConfig
@@ -13,55 +19,6 @@ export type DatabaseConfig =
   | SnowflakeConfig
   | PostgresConfig;
 
-export type BigQueryConfig = {
-  type: "bigquery";
-  apiKey?: string;
-  keyFilename?: string;
-  keyFile?: string;
-  projectId?: string;
-};
-
-export type DatabricksConfig = {
-  type: "databricks";
-  host: string;
-  path: string;
-} & (
-  | {authType?: "access-token"; token: string}
-  | {authType: "databricks-oauth"; oauthClientId?: string; oauthClientSecret?: string}
-);
-
-export type DuckDBConfig = {
-  type: "duckdb";
-  path?: string;
-  options?: {[key: string]: string}; // https://duckdb.org/docs/stable/configuration/overview.html
-};
-
-export type SQLiteConfig = {
-  type: "sqlite";
-  path?: string;
-};
-
-export type SnowflakeConfig = {
-  type: "snowflake";
-  account: string;
-  database?: string;
-  role?: string;
-  schema?: string;
-  username?: string;
-  warehouse?: string;
-  password?: string;
-};
-
-export type PostgresConfig = {
-  type: "postgres";
-  host?: string;
-  port?: string | number;
-  username?: string;
-  password?: string;
-  database?: string;
-  ssl?: boolean;
-};
-
 export type QueryTemplateFunction = (
   strings: readonly string[],
   ...params: QueryParam[]

src/databases/postgres.ts

@@ -1,9 +1,19 @@
 import type {Column, RowList} from "postgres";
 import Postgres from "postgres";
 import type {ColumnSchema} from "../runtime/index.js";
-import type {PostgresConfig, QueryTemplateFunction} from "./index.js";
+import type {QueryTemplateFunction} from "./index.js";
 import {optionalBoolean, optionalNumber, optionalString} from "./options.js";
 
+export type PostgresConfig = {
+  type: "postgres";
+  host?: string;
+  port?: string | number;
+  username?: string;
+  password?: string;
+  database?: string;
+  ssl?: boolean;
+};
+
 export default function postgres(options: PostgresConfig): QueryTemplateFunction {
   return async (strings, ...params) => {
     const sql = Postgres({

src/databases/snowflake.ts

@@ -1,11 +1,22 @@
 import type {Column, Connection, ConnectionOptions, RowStatement} from "snowflake-sdk";
 import Snowflake from "snowflake-sdk";
 import type {ColumnSchema, QueryParam} from "../runtime/index.js";
-import {QueryTemplateFunction, SerializableQueryResult, SnowflakeConfig} from "./index.js";
+import {QueryTemplateFunction, SerializableQueryResult} from "./index.js";
 import {optionalString} from "./options.js";
 
 Snowflake.configure({logLevel: "OFF"});
 
+export type SnowflakeConfig = {
+  type: "snowflake";
+  account: string;
+  database?: string;
+  role?: string;
+  schema?: string;
+  username?: string;
+  warehouse?: string;
+  password?: string;
+};
+
 export default function snowflake(options: SnowflakeConfig): QueryTemplateFunction {
   return async (strings, ...params) => {
     const connection = await connect({

src/databases/sqlite-bun.ts

@@ -1,7 +1,8 @@
 import type {Statement} from "bun:sqlite";
 import {Database} from "bun:sqlite";
-import type {SQLiteConfig, QueryTemplateFunction} from "./index.js";
+import type {QueryTemplateFunction} from "./index.js";
 import type {ColumnSchema} from "../runtime/index.js";
+import type {SQLiteConfig} from "./sqlite.js";
 import {getColumnType} from "./sqlite.js";
 
 export default function sqlite({path = ":memory:"}: SQLiteConfig): QueryTemplateFunction {

src/databases/sqlite-node.ts

@@ -1,7 +1,8 @@
 import type {StatementSync} from "node:sqlite";
 import {DatabaseSync} from "node:sqlite";
-import type {SQLiteConfig, QueryTemplateFunction} from "./index.js";
+import type {QueryTemplateFunction} from "./index.js";
 import type {ColumnSchema} from "../runtime/index.js";
+import type {SQLiteConfig} from "./sqlite.js";
 import {getColumnType} from "./sqlite.js";
 
 export default function sqlite({path = ":memory:"}: SQLiteConfig): QueryTemplateFunction {

src/databases/sqlite.ts

@@ -1,5 +1,10 @@
 import type {ColumnSchema} from "../runtime/index.js";
 
+export type SQLiteConfig = {
+  type: "sqlite";
+  path?: string;
+};
+
 export function getColumnType(type: string | null): ColumnSchema["type"] {
   switch (type) {
     case "INT":