Improve BunSqlite bindings

.changeset/light-parents-try.md

@@ -0,0 +1,5 @@
+---
+"rescript-bun": patch
+---
+
+Improve Sqlite bindings

src/BunSqlite.res

@@ -3,31 +3,33 @@ module Statement = {
 
   /** Runs a query and returns an array of JSON objects for the results. */
   @send
-  external all: (t, {..}) => array<JSON.t> = "all"
+  external all: (t, ~params: {..}=?) => array<JSON.t> = "all"
 
   /** Runs a query and returns raw JSON for the results. */
   @send
-  external allJson: (t, {..}) => JSON.t = "all"
+  external allJson: (t, ~params: {..}=?) => JSON.t = "all"
 
   /** Runs a query and returns raw JSON, using a dictionary for the parameters to make it easy to assemble parameters dynamically. */
   @send
   external allDictJson: (t, Dict.t<JSON.t>) => JSON.t = "all"
 
   /** Runs a query and returns a JSON object for the results. */
   @send
-  external get: (t, {..}) => Nullable.t<JSON.t> = "get"
+  external get: (t, ~params: {..}=?) => Nullable.t<JSON.t> = "get"
 
   /** Runs a query and returns a JSON object for the results, using a dictionary for the parameters to make it easy to assemble parameters dynamically. */
   @send
   external getDict: (t, Dict.t<JSON.t>) => Nullable.t<JSON.t> = "get"
 
+  type runResult = {lastInsertRowid: int, changes: int}
+
   /** Runs a query, expecting no results. */
   @send
-  external run: (t, {..}) => unit = "run"
+  external run: (t, ~params: {..}=?) => runResult = "run"
 
   /** Runs a query and returns an iterator over the results as raw JSON. */
   @send
-  external iterate: (t, {..}) => Iterator.t<JSON.t> = "iterate"
+  external iterate: (t, ~params: {..}=?) => Iterator.t<JSON.t> = "iterate"
 
   /** Destroys the statement, freeing up resources. */
   @send
@@ -44,8 +46,7 @@ module Database = {
   type dbOptions = {readonly?: bool, create?: bool, strict?: bool}
 
   /** Creates a new database. */
-  @module("bun:sqlite")
-  @new
+  @module("bun:sqlite") @new
   external make: (string, ~options: dbOptions=?) => t = "Database"
 
   /**
@@ -57,8 +58,7 @@ module Database = {
    let db = Database.makeInMemory()
    ```
    */
-  @module("bun:sqlite")
-  @new
+  @module("bun:sqlite") @new
   external makeInMemory: (@as(":memory:") _, ~options: dbOptions=?) => t = "Database"
 
   /**

test/BunSqlite.test.res

@@ -0,0 +1,66 @@
+open Test
+
+describe("BunSqlite", () => {
+  test("basic commands work", () => {
+    open BunSqlite
+    let db = Database.makeInMemory()
+
+    let resOne = db->Database.query("SELECT 1")->Statement.all
+    expect(resOne)->Expect.toEqual([
+      JSON.Object(
+        dict{
+          "1": JSON.Number((1 :> float)),
+        },
+      ),
+    ])
+
+    db
+    ->Database.query("
+CREATE TABLE IF NOT EXISTS pokemon (
+    id INTEGER PRIMARY KEY AUTOINCREMENT,
+    name TEXT NOT NULL
+);
+")
+    ->Statement.run
+    ->ignore
+
+    let insertResult =
+      db
+      ->Database.query("INSERT INTO pokemon (name) VALUES (@name)")
+      ->Statement.run(
+        ~params={
+          "@name": "Pikachu",
+        },
+      )
+
+    expect(insertResult.lastInsertRowid)->Expect.toBe(1)
+    expect(insertResult.changes)->Expect.toBe(1)
+
+    db
+    ->Database.query("INSERT INTO pokemon (name) VALUES (@name)")
+    ->Statement.run(
+      ~params={
+        "@name": "Raichu",
+      },
+    )
+    ->ignore
+
+    let allPokemons = db->Database.query("SELECT * FROM pokemon ORDER BY id")->Statement.all
+    expect(allPokemons)->Expect.toEqual([
+      JSON.Object(
+        dict{
+          "id": JSON.Number((1 :> float)),
+          "name": JSON.String("Pikachu"),
+        },
+      ),
+      JSON.Object(
+        dict{
+          "id": JSON.Number((2 :> float)),
+          "name": JSON.String("Raichu"),
+        },
+      ),
+    ])
+
+    db->Database.close
+  })
+})