@observablehq/notebook-kit 1.1.1 → 1.2.0-rc.2

package/dist/bin/query.js

@@ -3,6 +3,7 @@ import { mkdir, writeFile } from "node:fs/promises";
 import { dirname, join } from "node:path";
 import { parseArgs } from "node:util";
 import { getDatabase, getDatabaseConfig, getQueryCachePath } from "../src/databases/index.js";
+import { getReplacer } from "../src/databases/index.js";
 if (process.argv[1] === import.meta.filename)
     run();
 export default async function run(args) {
@@ -49,16 +50,19 @@ export default async function run(args) {
         const database = await getDatabase(config);
         const results = await database.call(null, strings, ...params);
         await mkdir(dirname(cachePath), { recursive: true });
-        await writeFile(cachePath, JSON.stringify(results, replace));
+        await writeFile(cachePath, JSON.stringify(results, await getReplacer(config)));
         console.log(join(values.root, cachePath));
     }
     catch (error) {
-        console.error(String(error));
+        console.error(getErrorMessage(error));
         process.exit(1);
     }
 }
-// Force dates to be serialized as ISO 8601 UTC, undoing this:
-// https://github.com/snowflakedb/snowflake-connector-nodejs/blob/a9174fb7/lib/connection/result/sf_timestamp.js#L177-L179
-function replace(key, value) {
-    return this[key] instanceof Date ? Date.prototype.toJSON.call(this[key]) : value;
+function getErrorMessage(error) {
+    return error instanceof Error &&
+        "errors" in error && // AggregateError
+        Array.isArray(error.errors) &&
+        error.errors.length > 0
+        ? String(error.errors[0])
+        : String(error);
 }

package/dist/package.json

@@ -5,7 +5,7 @@
         "type": "git",
         "url": "git+https://github.com/observablehq/notebook-kit.git"
     },
-    "version": "1.1.1",
+    "version": "1.2.0-rc.2",
     "type": "module",
     "scripts": {
         "test": "vitest",
@@ -63,8 +63,10 @@
         "vite": "^7.0.0"
     },
     "devDependencies": {
+        "@databricks/sql": "^1.11.0",
         "@duckdb/node-api": "^1.3.2-alpha.26",
         "@eslint/js": "^9.29.0",
+        "@google-cloud/bigquery": "^8.1.1",
         "@types/jsdom": "^21.1.7",
         "@types/markdown-it": "^14.1.2",
         "bun-types": "^1.2.20",
@@ -79,14 +81,22 @@
         "vitest": "^3.2.4"
     },
     "peerDependencies": {
+        "@databricks/sql": "^1.11.0",
         "@duckdb/node-api": "^1.3.2-alpha.26",
+        "@google-cloud/bigquery": "^8.1.1",
         "postgres": "^3.4.7",
         "snowflake-sdk": "^2.1.3"
     },
     "peerDependenciesMeta": {
+        "@databricks/sql": {
+            "optional": true
+        },
         "@duckdb/node-api": {
             "optional": true
         },
+        "@google-cloud/bigquery": {
+            "optional": true
+        },
         "postgres": {
             "optional": true
         },

package/dist/src/databases/bigquery.d.ts

@@ -0,0 +1,5 @@
+import type { BigQueryConfig, QueryTemplateFunction } from "./index.js";
+export default function bigquery({ type, ...options }: BigQueryConfig): QueryTemplateFunction;
+export declare function replacer(this: {
+    [key: string]: unknown;
+}, key: string, value: unknown): unknown;

package/dist/src/databases/bigquery.js

@@ -0,0 +1,59 @@
+import { BigQuery } from "@google-cloud/bigquery";
+import { BigQueryDate, BigQueryDatetime, BigQueryTimestamp } from "@google-cloud/bigquery";
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export default function bigquery({ type, ...options }) {
+    return async (strings, ...params) => {
+        const bigquery = new BigQuery(options);
+        const date = new Date();
+        const [job] = await bigquery.createQueryJob({ query: strings.join("?"), params });
+        const [rows, , response] = await job.getQueryResults();
+        return { rows, schema: getTableSchema(response.schema), duration: Date.now() - +date, date };
+    };
+}
+function getTableSchema({ fields }) {
+    return fields.map(getColumnSchema);
+}
+function getColumnSchema(field) {
+    return { name: field.name, type: getColumnType(field) };
+}
+function getColumnType({ type, mode }) {
+    switch (mode) {
+        case "REPEATED":
+            return "array";
+    }
+    switch (type) {
+        case "DATE":
+        case "DATETIME":
+        case "TIMESTAMP":
+            return "date";
+        case "BOOL":
+        case "BOOLEAN":
+            return "boolean";
+        case "STRUCT":
+        case "RECORD":
+        case "GEOGRAPHY":
+            return "object";
+        case "BYTES":
+            return "buffer";
+        case "FLOAT":
+        case "FLOAT64":
+            return "number";
+        case "INT64":
+        case "INTEGER":
+            return "number";
+        case "NUMERIC":
+            return "number";
+        case "STRING":
+        case "TIME":
+        default:
+            return "string";
+    }
+}
+export function replacer(key, value) {
+    const v = this[key];
+    return v instanceof BigQueryDate ||
+        v instanceof BigQueryDatetime ||
+        v instanceof BigQueryTimestamp
+        ? new Date(v.value).toJSON()
+        : value;
+}

package/dist/src/databases/databricks.d.ts

@@ -0,0 +1,2 @@
+import type { DatabricksConfig, QueryTemplateFunction } from "./index.js";
+export default function databricks({ type, ...options }: DatabricksConfig): QueryTemplateFunction;

package/dist/src/databases/databricks.js

@@ -0,0 +1,65 @@
+import { DBSQLClient, DBSQLLogger, LogLevel, thrift } from "@databricks/sql";
+const TTypeId = thrift.TCLIService_types.TTypeId;
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export default function databricks({ type, ...options }) {
+    return async (strings, ...params) => {
+        const logger = new DBSQLLogger({ level: LogLevel.error });
+        const client = new DBSQLClient({ logger });
+        await client.connect(options);
+        try {
+            const session = await client.openSession();
+            try {
+                const date = new Date();
+                const operation = await session.executeStatement(strings.join("?"), {
+                    runAsync: true,
+                    ordinalParameters: params,
+                    maxRows: 10000
+                });
+                try {
+                    const rows = (await operation.fetchAll());
+                    const schema = await operation.getSchema();
+                    return { rows, schema: getTableSchema(schema), duration: Date.now() - +date, date };
+                }
+                finally {
+                    await operation.close();
+                }
+            }
+            finally {
+                await session.close();
+            }
+        }
+        finally {
+            await client.close();
+        }
+    };
+}
+function getTableSchema({ columns }) {
+    return columns.map(getColumnSchema);
+}
+function getColumnSchema(column) {
+    return { name: column.columnName, type: getColumnType(column.typeDesc) };
+}
+function getColumnType({ types: [type] }) {
+    switch (type.primitiveEntry?.type) {
+        case TTypeId.BINARY_TYPE:
+            return "buffer";
+        case TTypeId.BOOLEAN_TYPE:
+            return "boolean";
+        case TTypeId.BIGINT_TYPE:
+        case TTypeId.TINYINT_TYPE:
+        case TTypeId.SMALLINT_TYPE:
+        case TTypeId.INT_TYPE:
+        case TTypeId.DECIMAL_TYPE:
+            return "integer";
+        case TTypeId.DOUBLE_TYPE:
+        case TTypeId.FLOAT_TYPE:
+            return "number";
+        case TTypeId.DATE_TYPE:
+        case TTypeId.TIMESTAMP_TYPE:
+        case TTypeId.INTERVAL_DAY_TIME_TYPE:
+        case TTypeId.INTERVAL_YEAR_MONTH_TYPE:
+            return "date";
+        default:
+            return "string";
+    }
+}

package/dist/src/databases/index.d.ts

@@ -1,5 +1,24 @@
 import type { ColumnSchema, QueryParam } from "../runtime/index.js";
-export type DatabaseConfig = DuckDBConfig | SQLiteConfig | SnowflakeConfig | PostgresConfig;
+export type DatabaseConfig = BigQueryConfig | DatabricksConfig | DuckDBConfig | SQLiteConfig | 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;
@@ -39,4 +58,8 @@ export type SerializableQueryResult = {
 };
 export declare function getDatabaseConfig(sourcePath: string, databaseName: string): Promise<DatabaseConfig>;
 export declare function getDatabase(config: DatabaseConfig): Promise<QueryTemplateFunction>;
+export type Replacer = (this: {
+    [key: string]: unknown;
+}, key: string, value: unknown) => unknown;
+export declare function getReplacer(config: DatabaseConfig): Promise<Replacer | undefined>;
 export declare function getQueryCachePath(sourcePath: string, databaseName: string, strings: readonly string[], ...params: unknown[]): Promise<string>;

package/dist/src/databases/index.js

@@ -26,7 +26,7 @@ export async function getDatabaseConfig(sourcePath, databaseName) {
         else if (/\.duckdb$/i.test(databaseName))
             config = { type: "duckdb", path: databaseName };
         else if (/\.db$/i.test(databaseName))
-            config = { type: "sqlite", path: databaseName }; // TODO disambiguate
+            config = { type: "sqlite", path: databaseName };
         else
             throw new Error(`database not found: ${databaseName}`);
     }
@@ -34,10 +34,14 @@ export async function getDatabaseConfig(sourcePath, databaseName) {
 }
 export async function getDatabase(config) {
     switch (config.type) {
+        case "bigquery":
+            return (await import("./bigquery.js")).default(config);
+        case "databricks":
+            return (await import("./databricks.js")).default(config);
         case "duckdb":
             return (await import("./duckdb.js")).default(config);
         case "sqlite":
-            return (await import(process.versions.bun ? "./sqlite-bun.js" : "./sqlite-node.js")).default(config);
+            return (await import(process.versions.bun ? "./sqlite-bun.js" : "./sqlite-node.js")).default(config); // prettier-ignore
         case "snowflake":
             return (await import("./snowflake.js")).default(config);
         case "postgres":
@@ -46,6 +50,14 @@ export async function getDatabase(config) {
             throw new Error(`unsupported database type: ${config["type"]}`);
     }
 }
+export async function getReplacer(config) {
+    switch (config.type) {
+        case "bigquery":
+            return (await import("./bigquery.js")).replacer;
+        case "snowflake":
+            return (await import("./snowflake.js")).replacer;
+    }
+}
 export async function getQueryCachePath(sourcePath, databaseName, strings, ...params) {
     const sourceDir = dirname(sourcePath);
     const cacheName = `${await getNameHash(databaseName)}-${await getQueryHash(strings, ...params)}.json`;

package/dist/src/databases/snowflake.d.ts

@@ -1,2 +1,5 @@
 import { QueryTemplateFunction, SnowflakeConfig } from "./index.js";
 export default function snowflake(options: SnowflakeConfig): QueryTemplateFunction;
+export declare function replacer(this: {
+    [key: string]: unknown;
+}, key: string, value: unknown): unknown;

package/dist/src/databases/snowflake.js

@@ -100,3 +100,9 @@ function getColumnType(column) {
             return "other";
     }
 }
+// Force dates to be serialized as ISO 8601 UTC, undoing this:
+// https://github.com/snowflakedb/snowflake-connector-nodejs/blob/a9174fb7/lib/connection/result/sf_timestamp.js#L177-L179
+export function replacer(key, value) {
+    const v = this[key];
+    return v instanceof Date ? Date.prototype.toJSON.call(v) : value;
+}

package/package.json

@@ -5,7 +5,7 @@
     "type": "git",
     "url": "git+https://github.com/observablehq/notebook-kit.git"
   },
-  "version": "1.1.1",
+  "version": "1.2.0-rc.2",
   "type": "module",
   "scripts": {
     "test": "vitest",
@@ -63,8 +63,10 @@
     "vite": "^7.0.0"
   },
   "devDependencies": {
+    "@databricks/sql": "^1.11.0",
     "@duckdb/node-api": "^1.3.2-alpha.26",
     "@eslint/js": "^9.29.0",
+    "@google-cloud/bigquery": "^8.1.1",
     "@types/jsdom": "^21.1.7",
     "@types/markdown-it": "^14.1.2",
     "bun-types": "^1.2.20",
@@ -79,14 +81,22 @@
     "vitest": "^3.2.4"
   },
   "peerDependencies": {
+    "@databricks/sql": "^1.11.0",
     "@duckdb/node-api": "^1.3.2-alpha.26",
+    "@google-cloud/bigquery": "^8.1.1",
     "postgres": "^3.4.7",
     "snowflake-sdk": "^2.1.3"
   },
   "peerDependenciesMeta": {
+    "@databricks/sql": {
+      "optional": true
+    },
     "@duckdb/node-api": {
       "optional": true
     },
+    "@google-cloud/bigquery": {
+      "optional": true
+    },
     "postgres": {
       "optional": true
     },