@observablehq/notebook-kit 2.6.6 → 2.7.0

package/dist/package.json

@@ -5,7 +5,7 @@
         "type": "git",
         "url": "git+https://github.com/observablehq/notebook-kit.git"
     },
-    "version": "2.6.6",
+    "version": "2.7.0",
     "type": "module",
     "scripts": {
         "test": "TZ=America/Los_Angeles vitest",
@@ -35,6 +35,10 @@
             "types": "./dist/src/runtime/index.d.ts",
             "import": "./dist/src/runtime/index.js"
         },
+        "./sql": {
+            "types": "./dist/src/runtime/stdlib/sql.d.ts",
+            "import": "./dist/src/runtime/stdlib/sql.js"
+        },
         "./vite": {
             "types": "./dist/src/vite/index.d.ts",
             "import": "./dist/src/vite/index.js"

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

@@ -13,7 +13,6 @@ export type * from "./stdlib/fileAttachment.js";
 export { FileAttachment, requireFileRegistration, registerFile } from "./stdlib/fileAttachment.js";
 export type * from "./stdlib/interpreter.js";
 export { Interpreter } from "./stdlib/interpreter.js";
-export { sql } from "./stdlib/sql.js";
 export declare class NotebookRuntime {
     readonly runtime: Runtime & {
         fileAttachments: typeof fileAttachments;

package/dist/src/runtime/index.js

@@ -8,7 +8,6 @@ export * from "./stdlib/index.js";
 export { DatabaseClient } from "./stdlib/databaseClient.js";
 export { FileAttachment, requireFileRegistration, registerFile } from "./stdlib/fileAttachment.js";
 export { Interpreter } from "./stdlib/interpreter.js";
-export { sql } from "./stdlib/sql.js";
 export class NotebookRuntime {
     constructor(builtins = library) {
         Object.defineProperty(this, "runtime", {

package/dist/src/runtime/stdlib/duckdb.d.ts

@@ -1,6 +1,6 @@
 export class DuckDBClient {
     static of(sources?: {}, config?: {}): Promise<DuckDBClient>;
-    static sql(...args: any[]): Promise<(strings: any, ...args: any[]) => Promise<any>>;
+    static sql(...args: any[]): Promise<(strings: any, ...params: any[]) => Promise<any>>;
     constructor(db: any);
     queryStream(query: any, params: any): Promise<{
         schema: any;
@@ -8,7 +8,7 @@ export class DuckDBClient {
     }>;
     query(query: any, params: any): Promise<any>;
     queryRow(query: any, params: any): Promise<any>;
-    sql(strings: any, ...args: any[]): Promise<any>;
+    sql(strings: any, ...params: any[]): Promise<any>;
     queryTag(strings: any, ...params: any[]): any[];
     escape(name: any): string;
     describeTables(): Promise<{

package/dist/src/runtime/stdlib/duckdb.js

@@ -1,4 +1,5 @@
 import * as duckdb from "https://cdn.jsdelivr.net/npm/@duckdb/duckdb-wasm@1.32.0/+esm";
+import { sql } from "./sql.js";
 // Adapted from https://observablehq.com/@cmudig/duckdb-client
 // Copyright 2021 CMU Data Interaction Group
 //
@@ -132,8 +133,9 @@ export class DuckDBClient {
             await reader.return();
         }
     }
-    async sql(strings, ...args) {
-        return await this.query(strings.join("?"), args);
+    async sql(strings, ...params) {
+        ({ strings, params } = sql.call(null, strings, ...params).flat(this.dialect));
+        return await this.query(strings.join("?"), params);
     }
     queryTag(strings, ...params) {
         return [strings.join("?"), params];

package/dist/src/runtime/stdlib/index.d.ts

@@ -6,7 +6,6 @@ import * as Generators from "./generators/index.js";
 import { Interpreter } from "./interpreter.js";
 import { Mutable } from "./mutable.js";
 import * as Promises from "./promises/index.js";
-import { sql } from "./sql.js";
 export declare const root: HTMLElement;
 export declare const library: {
     aapl: () => Promise<any>;
@@ -41,6 +40,7 @@ export declare const library: {
     Plot: () => Promise<any>;
     React: () => Promise<any>;
     ReactDOM: () => Promise<any>;
+    sql: () => Promise<typeof import("./sql.js").sql>;
     tex: () => Promise<import("./template.js").RawTemplateRenderer & {
         options: (options?: any) => import("./template.js").RawTemplateRenderer;
         block: import("./template.js").RawTemplateRenderer;
@@ -104,5 +104,4 @@ export declare const library: {
     Promises: () => typeof Promises;
     Files: () => typeof Files;
     DOM: () => typeof DOM;
-    sql: () => typeof sql;
 };

package/dist/src/runtime/stdlib/index.js

@@ -8,7 +8,6 @@ import { Mutable } from "./mutable.js";
 import * as Promises from "./promises/index.js";
 import * as recommendedLibraries from "./recommendedLibraries.js";
 import * as sampleDatasets from "./sampleDatasets.js";
-import { sql } from "./sql.js";
 export const root = document.querySelector("main") ?? document.body;
 export const library = {
     dark: () => Generators.dark(),
@@ -22,7 +21,6 @@ export const library = {
     Promises: () => Promises, // deprecated!
     Files: () => Files, // deprecated!
     DOM: () => DOM, // deprecated!
-    sql: () => sql,
     ...recommendedLibraries,
     ...sampleDatasets
 };

package/dist/src/runtime/stdlib/recommendedLibraries.d.ts

@@ -18,6 +18,7 @@ export declare const mermaid: () => Promise<import("./template.js").AsyncRawTemp
 export declare const Plot: () => Promise<any>;
 export declare const React: () => Promise<any>;
 export declare const ReactDOM: () => Promise<any>;
+export declare const sql: () => Promise<typeof import("./sql.js").sql>;
 export declare const tex: () => Promise<import("./template.js").RawTemplateRenderer & {
     options: (options?: any) => import("./template.js").RawTemplateRenderer;
     block: import("./template.js").RawTemplateRenderer;

package/dist/src/runtime/stdlib/recommendedLibraries.js

@@ -18,6 +18,7 @@ export const mermaid = () => import("./mermaid.js").then((_) => _.mermaid);
 export const Plot = () => import("https://cdn.jsdelivr.net/npm/@observablehq/plot/+esm");
 export const React = () => import("https://cdn.jsdelivr.net/npm/react/+esm");
 export const ReactDOM = () => import("https://cdn.jsdelivr.net/npm/react-dom/+esm");
+export const sql = () => import("./sql.js").then((_) => _.sql);
 // export const SQLite = () => import("observablehq:stdlib/sqlite").then((_) => _.default);
 // export const SQLiteDatabaseClient = () => import("observablehq:stdlib/sqlite").then((_) => _.SQLiteDatabaseClient);
 export const tex = () => import("./tex.js").then((_) => _.tex);

package/dist/src/runtime/stdlib/sql.d.ts

@@ -8,7 +8,7 @@ export declare namespace sql {
     var view: (strings: readonly string[], ...params: unknown[]) => SqlView;
     var variant: (variants: Partial<Record<SqlDialect | "default", unknown>>) => SqlVariant;
     var ident: (name: string) => SqlVariant;
-    var text: (value: string) => SqlFragment;
+    var text: (value: string) => SqlVariant;
     var Fragment: typeof SqlFragment;
     var View: typeof SqlView;
     var Variant: typeof SqlVariant;

package/dist/src/runtime/stdlib/sql.js

@@ -8,20 +8,10 @@ sql.variant = function variant(variants) {
     return new SqlVariant(variants);
 };
 sql.ident = function ident(name) {
-    return new SqlVariant({
-        get databricks() {
-            return sql([tquote(name)]);
-        },
-        get bigquery() {
-            return sql([tquote(name)]);
-        },
-        get default() {
-            return sql([dquote(name)]);
-        }
-    });
+    return quoted(name, iquotes);
 };
 sql.text = function text(value) {
-    return sql([squote(value)]);
+    return quoted(value, squotes);
 };
 class SqlFragment {
     constructor(strings, params) {
@@ -155,6 +145,10 @@ class SqlVariant {
         return String(this.toDialect());
     }
 }
+// prevent mangling
+Object.defineProperty(SqlFragment, "name", { value: "SqlFragment" });
+Object.defineProperty(SqlView, "name", { value: "SqlView" });
+Object.defineProperty(SqlVariant, "name", { value: "SqlVariant" });
 sql.Fragment = SqlFragment;
 sql.View = SqlView;
 sql.Variant = SqlVariant;
@@ -270,15 +264,30 @@ function findUndernames(strings, params, names = new Set()) {
     }
     return names;
 }
+/** Identifier quoting, by dialect. */
+const iquotes = new Map([
+    ["bigquery", btquote],
+    ["databricks", tquote],
+    ["mssql", brquote],
+    ["mysql", tquote],
+    ["default", dquote]
+]);
+/** String literal quoting, by dialect. */
+const squotes = new Map([
+    ["bigquery", bsquote],
+    ["databricks", bsquote],
+    ["mssql", (value) => `N${squote(value.replace(/\\(?=\r?\n)/g, "\\\\\n"))}`],
+    ["mysql", (value) => squote(value.replace(/\\/g, "\\\\"))],
+    ["snowflake", bsquote],
+    ["default", squote]
+]);
+/** Returns a variant of the specified value quoted for each dialect. */
+function quoted(value, quotes) {
+    return new SqlVariant(Object.fromEntries(Array.from(quotes, ([d, q]) => [d, sql([q(value)])])));
+}
 /** Quotes the specified SQL identifier. */
-function getIquote(dialect) {
-    switch (dialect) {
-        case "databricks":
-        case "bigquery":
-            return tquote;
-        default:
-            return dquote;
-    }
+function getIquote(dialect = "default") {
+    return iquotes.get(dialect) ?? iquotes.get("default");
 }
 /** Quotes the specified name with double quotes. */
 function dquote(name) {
@@ -288,7 +297,23 @@ function dquote(name) {
 function tquote(name) {
     return `\`${name.replace(/`/g, "``")}\``;
 }
+/** Quotes the specified name with square brackets. */
+function brquote(name) {
+    return `[${name.replace(/]/g, "]]")}]`;
+}
+/** Quotes the specified name with backticks, escaping with backslashes. */
+function btquote(name) {
+    return `\`${name.replace(/[\\`\n\r]/g, bescape)}\``;
+}
 /** Quotes the specified name with single quotes. */
 function squote(name) {
     return `'${name.replace(/'/g, "''")}'`;
 }
+/** Quotes the specified value with single quotes, escaping with backslashes. */
+function bsquote(name) {
+    return `'${name.replace(/[\\'\n\r]/g, bescape)}'`;
+}
+/** Escapes the specified character with a backslash. */
+function bescape(char) {
+    return char === "\n" ? "\\n" : char === "\r" ? "\\r" : `\\${char}`;
+}

package/package.json

@@ -5,7 +5,7 @@
     "type": "git",
     "url": "git+https://github.com/observablehq/notebook-kit.git"
   },
-  "version": "2.6.6",
+  "version": "2.7.0",
   "type": "module",
   "scripts": {
     "test": "TZ=America/Los_Angeles vitest",
@@ -35,6 +35,10 @@
       "types": "./dist/src/runtime/index.d.ts",
       "import": "./dist/src/runtime/index.js"
     },
+    "./sql": {
+      "types": "./dist/src/runtime/stdlib/sql.d.ts",
+      "import": "./dist/src/runtime/stdlib/sql.js"
+    },
     "./vite": {
       "types": "./dist/src/vite/index.d.ts",
       "import": "./dist/src/vite/index.js"