@livestore/common 0.4.0-dev.2 → 0.4.0-dev.21

package/dist/schema/state/sqlite/query-builder/impl.test.js

@@ -64,7 +64,14 @@ const issue = State.SQLite.table({
         { name: 'issue_created', columns: ['created'] },
     ],
 });
-const db = { todos, todosWithIntId, comments, issue, UiState, UiStateWithDefaultId };
+const selections = State.SQLite.table({
+    name: 'selections',
+    columns: {
+        id: State.SQLite.integer({ primaryKey: true }),
+        group: State.SQLite.text({}),
+    },
+});
+const db = { todos, todosWithIntId, comments, issue, selections, UiState, UiStateWithDefaultId };
 const dump = (qb) => ({
     bindValues: qb.asSql().bindValues,
     query: qb.asSql().query,
@@ -83,14 +90,14 @@ describe('query builder', () => {
             expect(dump(db.todos.select('id'))).toMatchInlineSnapshot(`
         {
           "bindValues": [],
-          "query": "SELECT id FROM 'todos'",
+          "query": "SELECT "id" FROM 'todos'",
           "schema": "ReadonlyArray<({ readonly id: string } <-> string)>",
         }
       `);
             expect(dump(db.todos.select('id', 'text'))).toMatchInlineSnapshot(`
         {
           "bindValues": [],
-          "query": "SELECT id, text FROM 'todos'",
+          "query": "SELECT "id", "text" FROM 'todos'",
           "schema": "ReadonlyArray<{ readonly id: string; readonly text: string }>",
         }
       `);
@@ -101,7 +108,7 @@ describe('query builder', () => {
           "bindValues": [
             1,
           ],
-          "query": "SELECT id, text FROM 'todos' LIMIT ?",
+          "query": "SELECT "id", "text" FROM 'todos' LIMIT ?",
           "schema": "(ReadonlyArray<{ readonly id: string; readonly text: string } | undefined> <-> { readonly id: string; readonly text: string } | undefined)",
         }
       `);
@@ -110,7 +117,7 @@ describe('query builder', () => {
           "bindValues": [
             1,
           ],
-          "query": "SELECT id, text FROM 'todos' LIMIT ?",
+          "query": "SELECT "id", "text" FROM 'todos' LIMIT ?",
           "schema": "(ReadonlyArray<{ readonly id: string; readonly text: string }> <-> { readonly id: string; readonly text: string })",
         }
       `);
@@ -119,7 +126,7 @@ describe('query builder', () => {
           "bindValues": [
             1,
           ],
-          "query": "SELECT id, text FROM 'todos' LIMIT ?",
+          "query": "SELECT "id", "text" FROM 'todos' LIMIT ?",
           "schema": "(ReadonlyArray<{ readonly id: string; readonly text: string }> | readonly [undefined] <-> { readonly id: string; readonly text: string } | undefined)",
         }
       `);
@@ -130,7 +137,7 @@ describe('query builder', () => {
           "bindValues": [
             1,
           ],
-          "query": "SELECT id, text FROM 'todos' WHERE completed = ?",
+          "query": "SELECT "id", "text" FROM 'todos' WHERE "completed" = ?",
           "schema": "ReadonlyArray<{ readonly id: string; readonly text: string }>",
         }
       `);
@@ -139,7 +146,7 @@ describe('query builder', () => {
           "bindValues": [
             1,
           ],
-          "query": "SELECT id, text FROM 'todos' WHERE completed != ?",
+          "query": "SELECT "id", "text" FROM 'todos' WHERE "completed" != ?",
           "schema": "ReadonlyArray<{ readonly id: string; readonly text: string }>",
         }
       `);
@@ -148,59 +155,59 @@ describe('query builder', () => {
           "bindValues": [
             1,
           ],
-          "query": "SELECT id, text FROM 'todos' WHERE completed = ?",
+          "query": "SELECT "id", "text" FROM 'todos' WHERE "completed" = ?",
           "schema": "ReadonlyArray<{ readonly id: string; readonly text: string }>",
         }
       `);
             expect(dump(db.todos.select('id', 'text').where({ completed: undefined }))).toMatchInlineSnapshot(`
         {
           "bindValues": [],
-          "query": "SELECT id, text FROM 'todos'",
+          "query": "SELECT "id", "text" FROM 'todos'",
           "schema": "ReadonlyArray<{ readonly id: string; readonly text: string }>",
         }
       `);
             expect(dump(db.todos.select('id', 'text').where({ deletedAt: { op: '<=', value: new Date('2024-01-01') } }))).toMatchInlineSnapshot(`
-          {
-            "bindValues": [
-              "2024-01-01T00:00:00.000Z",
-            ],
-            "query": "SELECT id, text FROM 'todos' WHERE deletedAt <= ?",
-            "schema": "ReadonlyArray<{ readonly id: string; readonly text: string }>",
-          }
-        `);
+        {
+          "bindValues": [
+            "2024-01-01T00:00:00.000Z",
+          ],
+          "query": "SELECT "id", "text" FROM 'todos' WHERE "deletedAt" <= ?",
+          "schema": "ReadonlyArray<{ readonly id: string; readonly text: string }>",
+        }
+      `);
             expect(dump(db.todos.select('id', 'text').where({ status: { op: 'IN', value: ['active'] } }))).toMatchInlineSnapshot(`
-          {
-            "bindValues": [
-              "active",
-            ],
-            "query": "SELECT id, text FROM 'todos' WHERE status IN (?)",
-            "schema": "ReadonlyArray<{ readonly id: string; readonly text: string }>",
-          }
-        `);
+        {
+          "bindValues": [
+            "active",
+          ],
+          "query": "SELECT "id", "text" FROM 'todos' WHERE "status" IN (?)",
+          "schema": "ReadonlyArray<{ readonly id: string; readonly text: string }>",
+        }
+      `);
             expect(dump(db.todos.select('id', 'text').where({ status: { op: 'NOT IN', value: ['active', 'completed'] } }))).toMatchInlineSnapshot(`
-          {
-            "bindValues": [
-              "active",
-              "completed",
-            ],
-            "query": "SELECT id, text FROM 'todos' WHERE status NOT IN (?, ?)",
-            "schema": "ReadonlyArray<{ readonly id: string; readonly text: string }>",
-          }
-        `);
+        {
+          "bindValues": [
+            "active",
+            "completed",
+          ],
+          "query": "SELECT "id", "text" FROM 'todos' WHERE "status" NOT IN (?, ?)",
+          "schema": "ReadonlyArray<{ readonly id: string; readonly text: string }>",
+        }
+      `);
             expect(dump(db.todos
                 .select('id', 'text')
                 .where({ completed: false })
                 .where({ status: { op: 'IN', value: ['active'] } })
                 .where({ deletedAt: undefined }))).toMatchInlineSnapshot(`
-          {
-            "bindValues": [
-              0,
-              "active",
-            ],
-            "query": "SELECT id, text FROM 'todos' WHERE completed = ? AND status IN (?)",
-            "schema": "ReadonlyArray<{ readonly id: string; readonly text: string }>",
-          }
-        `);
+        {
+          "bindValues": [
+            0,
+            "active",
+          ],
+          "query": "SELECT "id", "text" FROM 'todos' WHERE "completed" = ? AND "status" IN (?)",
+          "schema": "ReadonlyArray<{ readonly id: string; readonly text: string }>",
+        }
+      `);
         });
         it('should handle OFFSET and LIMIT clauses', () => {
             expect(dump(db.todos.select('id', 'text').where('completed', true).offset(10).limit(10))).toMatchInlineSnapshot(`
@@ -210,7 +217,7 @@ describe('query builder', () => {
             10,
             10,
           ],
-          "query": "SELECT id, text FROM 'todos' WHERE completed = ? OFFSET ? LIMIT ?",
+          "query": "SELECT "id", "text" FROM 'todos' WHERE "completed" = ? LIMIT ? OFFSET ?",
           "schema": "ReadonlyArray<{ readonly id: string; readonly text: string }>",
         }
       `);
@@ -221,10 +228,10 @@ describe('query builder', () => {
         {
           "bindValues": [
             1,
-            5,
             10,
+            5,
           ],
-          "query": "SELECT id, text FROM 'todos' WHERE completed = ? OFFSET ? LIMIT ?",
+          "query": "SELECT "id", "text" FROM 'todos' WHERE "completed" = ? LIMIT ? OFFSET ?",
           "schema": "ReadonlyArray<{ readonly id: string; readonly text: string }>",
         }
       `);
@@ -235,7 +242,7 @@ describe('query builder', () => {
             1,
             5,
           ],
-          "query": "SELECT id, text FROM 'todos' WHERE completed = ? OFFSET ?",
+          "query": "SELECT "id", "text" FROM 'todos' WHERE "completed" = ? OFFSET ?",
           "schema": "ReadonlyArray<{ readonly id: string; readonly text: string }>",
         }
       `);
@@ -246,7 +253,7 @@ describe('query builder', () => {
             1,
             10,
           ],
-          "query": "SELECT id, text FROM 'todos' WHERE completed = ? LIMIT ?",
+          "query": "SELECT "id", "text" FROM 'todos' WHERE "completed" = ? LIMIT ?",
           "schema": "ReadonlyArray<{ readonly id: string; readonly text: string }>",
         }
       `);
@@ -264,7 +271,7 @@ describe('query builder', () => {
           "bindValues": [
             1,
           ],
-          "query": "SELECT COUNT(*) as count FROM 'todos' WHERE completed = ?",
+          "query": "SELECT COUNT(*) as count FROM 'todos' WHERE "completed" = ?",
           "schema": "(ReadonlyArray<({ readonly count: number } <-> number)> <-> number)",
         }
       `);
@@ -273,7 +280,7 @@ describe('query builder', () => {
           "bindValues": [
             1,
           ],
-          "query": "SELECT COUNT(*) as count FROM 'todos' WHERE completed = ?",
+          "query": "SELECT COUNT(*) as count FROM 'todos' WHERE "completed" = ?",
           "schema": "(ReadonlyArray<({ readonly count: number } <-> number)> <-> number)",
         }
       `);
@@ -282,14 +289,14 @@ describe('query builder', () => {
             expect(dump(db.todos.select('id', 'text').where('deletedAt', '=', null))).toMatchInlineSnapshot(`
         {
           "bindValues": [],
-          "query": "SELECT id, text FROM 'todos' WHERE deletedAt IS NULL",
+          "query": "SELECT "id", "text" FROM 'todos' WHERE "deletedAt" IS NULL",
           "schema": "ReadonlyArray<{ readonly id: string; readonly text: string }>",
         }
       `);
             expect(dump(db.todos.select('id', 'text').where('deletedAt', '!=', null))).toMatchInlineSnapshot(`
         {
           "bindValues": [],
-          "query": "SELECT id, text FROM 'todos' WHERE deletedAt IS NOT NULL",
+          "query": "SELECT "id", "text" FROM 'todos' WHERE "deletedAt" IS NOT NULL",
           "schema": "ReadonlyArray<{ readonly id: string; readonly text: string }>",
         }
       `);
@@ -298,14 +305,14 @@ describe('query builder', () => {
             expect(dump(db.todos.orderBy('completed', 'desc'))).toMatchInlineSnapshot(`
         {
           "bindValues": [],
-          "query": "SELECT * FROM 'todos' ORDER BY completed desc",
+          "query": "SELECT * FROM 'todos' ORDER BY "completed" desc",
           "schema": "ReadonlyArray<todos>",
         }
       `);
             expect(dump(db.todos.orderBy([{ col: 'completed', direction: 'desc' }]))).toMatchInlineSnapshot(`
         {
           "bindValues": [],
-          "query": "SELECT * FROM 'todos' ORDER BY completed desc",
+          "query": "SELECT * FROM 'todos' ORDER BY "completed" desc",
           "schema": "ReadonlyArray<todos>",
         }
       `);
@@ -360,20 +367,20 @@ describe('query builder', () => {
             "Buy milk",
             "active",
           ],
-          "query": "INSERT INTO 'todos' (id, text, status) VALUES (?, ?, ?)",
+          "query": "INSERT INTO 'todos' ("id", "text", "status") VALUES (?, ?, ?)",
           "schema": "number",
         }
       `);
         });
         it('should handle INSERT queries with undefined values', () => {
-            expect(dump(db.todos.insert({ id: '123', text: 'Buy milk', status: 'active', completed: undefined }))).toMatchInlineSnapshot(`
+            expect(dump(db.todos.insert({ id: '123', text: 'Buy milk', status: 'active' }))).toMatchInlineSnapshot(`
         {
           "bindValues": [
             "123",
             "Buy milk",
             "active",
           ],
-          "query": "INSERT INTO 'todos' (id, text, status) VALUES (?, ?, ?)",
+          "query": "INSERT INTO 'todos' ("id", "text", "status") VALUES (?, ?, ?)",
           "schema": "number",
         }
       `);
@@ -399,7 +406,7 @@ describe('query builder', () => {
             "a2",
             "John Doe",
           ],
-          "query": "INSERT INTO 'issue' (id, title, priority, created, modified, kanbanorder, creator) VALUES (?, ?, ?, ?, ?, ?, ?)",
+          "query": "INSERT INTO 'issue' ("id", "title", "priority", "created", "modified", "kanbanorder", "creator") VALUES (?, ?, ?, ?, ?, ?, ?)",
           "schema": "number",
         }
       `);
@@ -411,7 +418,7 @@ describe('query builder', () => {
             "completed",
             "123",
           ],
-          "query": "UPDATE 'todos' SET status = ? WHERE id = ?",
+          "query": "UPDATE 'todos' SET "status" = ? WHERE "id" = ?",
           "schema": "number",
         }
       `);
@@ -425,13 +432,13 @@ describe('query builder', () => {
       `);
         });
         it('should handle UPDATE queries with undefined values', () => {
-            expect(dump(db.todos.update({ status: undefined, text: 'some text' }).where({ id: '123' }))).toMatchInlineSnapshot(`
+            expect(dump(db.todos.update({ text: 'some text' }).where({ id: '123' }))).toMatchInlineSnapshot(`
         {
           "bindValues": [
             "some text",
             "123",
           ],
-          "query": "UPDATE 'todos' SET text = ? WHERE id = ?",
+          "query": "UPDATE 'todos' SET "text" = ? WHERE "id" = ?",
           "schema": "number",
         }
       `);
@@ -444,7 +451,7 @@ describe('query builder', () => {
             "John Doe",
             1,
           ],
-          "query": "UPDATE 'issue' SET priority = ?, creator = ? WHERE id = ?",
+          "query": "UPDATE 'issue' SET "priority" = ?, "creator" = ? WHERE "id" = ?",
           "schema": "number",
         }
       `);
@@ -455,7 +462,7 @@ describe('query builder', () => {
           "bindValues": [
             "completed",
           ],
-          "query": "DELETE FROM 'todos' WHERE status = ?",
+          "query": "DELETE FROM 'todos' WHERE "status" = ?",
           "schema": "number",
         }
       `);
@@ -468,7 +475,7 @@ describe('query builder', () => {
             "Buy milk",
             "active",
           ],
-          "query": "INSERT INTO 'todos' (id, text, status) VALUES (?, ?, ?) ON CONFLICT (id) DO NOTHING",
+          "query": "INSERT INTO 'todos' ("id", "text", "status") VALUES (?, ?, ?) ON CONFLICT ("id") DO NOTHING",
           "schema": "number",
         }
       `);
@@ -483,7 +490,7 @@ describe('query builder', () => {
             "Buy soy milk",
             "active",
           ],
-          "query": "INSERT INTO 'todos' (id, text, status) VALUES (?, ?, ?) ON CONFLICT (id) DO UPDATE SET text = ?, status = ?",
+          "query": "INSERT INTO 'todos' ("id", "text", "status") VALUES (?, ?, ?) ON CONFLICT ("id") DO UPDATE SET "text" = ?, "status" = ?",
           "schema": "number",
         }
       `);
@@ -494,7 +501,29 @@ describe('query builder', () => {
             "Buy milk",
             "active",
           ],
-          "query": "INSERT OR REPLACE INTO 'todos' (id, text, status) VALUES (?, ?, ?)",
+          "query": "INSERT OR REPLACE INTO 'todos' ("id", "text", "status") VALUES (?, ?, ?)",
+          "schema": "number",
+        }
+      `);
+        });
+        it('should quote reserved column names', () => {
+            expect(dump(db.selections.insert({ id: 1, group: 'alpha' }).onConflict('id', 'ignore'))).toMatchInlineSnapshot(`
+        {
+          "bindValues": [
+            1,
+            "alpha",
+          ],
+          "query": "INSERT INTO 'selections' ("id", "group") VALUES (?, ?) ON CONFLICT ("id") DO NOTHING",
+          "schema": "number",
+        }
+      `);
+            expect(dump(db.selections.update({ group: 'beta' }).where({ id: 1 }))).toMatchInlineSnapshot(`
+        {
+          "bindValues": [
+            "beta",
+            1,
+          ],
+          "query": "UPDATE 'selections' SET "group" = ? WHERE "id" = ?",
           "schema": "number",
         }
       `);
@@ -507,43 +536,178 @@ describe('query builder', () => {
             "Buy milk",
             "active",
           ],
-          "query": "INSERT INTO 'todos' (id, text, status) VALUES (?, ?, ?) ON CONFLICT (id, status) DO NOTHING",
+          "query": "INSERT INTO 'todos' ("id", "text", "status") VALUES (?, ?, ?) ON CONFLICT ("id", "status") DO NOTHING",
           "schema": "number",
         }
       `);
         });
         it('should handle RETURNING clause', () => {
             expect(dump(db.todos.insert({ id: '123', text: 'Buy milk', status: 'active' }).returning('id'))).toMatchInlineSnapshot(`
-          {
-            "bindValues": [
-              "123",
-              "Buy milk",
-              "active",
-            ],
-            "query": "INSERT INTO 'todos' (id, text, status) VALUES (?, ?, ?) RETURNING id",
-            "schema": "ReadonlyArray<{ readonly id: string }>",
-          }
-        `);
+        {
+          "bindValues": [
+            "123",
+            "Buy milk",
+            "active",
+          ],
+          "query": "INSERT INTO 'todos' ("id", "text", "status") VALUES (?, ?, ?) RETURNING "id"",
+          "schema": "ReadonlyArray<{ readonly id: string }>",
+        }
+      `);
             expect(dump(db.todos.update({ status: 'completed' }).where({ id: '123' }).returning('id'))).toMatchInlineSnapshot(`
-          {
-            "bindValues": [
-              "completed",
-              "123",
-            ],
-            "query": "UPDATE 'todos' SET status = ? WHERE id = ? RETURNING id",
-            "schema": "ReadonlyArray<{ readonly id: string }>",
-          }
-        `);
+        {
+          "bindValues": [
+            "completed",
+            "123",
+          ],
+          "query": "UPDATE 'todos' SET "status" = ? WHERE "id" = ? RETURNING "id"",
+          "schema": "ReadonlyArray<{ readonly id: string }>",
+        }
+      `);
             expect(dump(db.todos.delete().where({ status: 'completed' }).returning('id'))).toMatchInlineSnapshot(`
         {
           "bindValues": [
             "completed",
           ],
-          "query": "DELETE FROM 'todos' WHERE status = ? RETURNING id",
+          "query": "DELETE FROM 'todos' WHERE "status" = ? RETURNING "id"",
           "schema": "ReadonlyArray<{ readonly id: string }>",
         }
       `);
         });
+        it('should handle where().delete() - preserving where clauses', () => {
+            expect(dump(db.todos.where({ status: 'completed' }).delete())).toMatchInlineSnapshot(`
+        {
+          "bindValues": [
+            "completed",
+          ],
+          "query": "DELETE FROM 'todos' WHERE "status" = ?",
+          "schema": "number",
+        }
+      `);
+            // Multiple where clauses
+            expect(dump(db.todos.where({ status: 'completed' }).where({ deletedAt: null }).delete())).toMatchInlineSnapshot(`
+        {
+          "bindValues": [
+            "completed",
+          ],
+          "query": "DELETE FROM 'todos' WHERE "status" = ? AND "deletedAt" IS NULL",
+          "schema": "number",
+        }
+      `);
+        });
+        it('should handle where().update() - preserving where clauses', () => {
+            expect(dump(db.todos.where({ id: '123' }).update({ status: 'completed' }))).toMatchInlineSnapshot(`
+        {
+          "bindValues": [
+            "completed",
+            "123",
+          ],
+          "query": "UPDATE 'todos' SET "status" = ? WHERE "id" = ?",
+          "schema": "number",
+        }
+      `);
+            // Multiple where clauses
+            expect(dump(db.todos.where({ id: '123' }).where({ deletedAt: null }).update({ status: 'completed' }))).toMatchInlineSnapshot(`
+        {
+          "bindValues": [
+            "completed",
+            "123",
+          ],
+          "query": "UPDATE 'todos' SET "status" = ? WHERE "id" = ? AND "deletedAt" IS NULL",
+          "schema": "number",
+        }
+      `);
+        });
+        it('should have equivalent behavior for both delete patterns', () => {
+            const pattern1 = dump(db.todos.where({ status: 'completed', id: '123' }).delete());
+            const pattern2 = dump(db.todos.delete().where({ status: 'completed', id: '123' }));
+            expect(pattern1).toEqual(pattern2);
+        });
+        it('should have equivalent behavior for both update patterns', () => {
+            const pattern1 = dump(db.todos.where({ id: '123' }).update({ status: 'completed', text: 'Updated' }));
+            const pattern2 = dump(db.todos.update({ status: 'completed', text: 'Updated' }).where({ id: '123' }));
+            expect(pattern1).toEqual(pattern2);
+        });
+    });
+    describe('schema transforms', () => {
+        const Flat = Schema.Struct({
+            id: Schema.String.pipe(State.SQLite.withPrimaryKey),
+            contactFirstName: Schema.String,
+            contactLastName: Schema.String,
+            contactEmail: Schema.String.pipe(State.SQLite.withUnique),
+        });
+        const Nested = Schema.transform(Flat, Schema.Struct({
+            id: Schema.String,
+            contact: Schema.Struct({
+                firstName: Schema.String,
+                lastName: Schema.String,
+                email: Schema.String,
+            }),
+        }), {
+            decode: ({ id, contactFirstName, contactLastName, contactEmail }) => ({
+                id,
+                contact: {
+                    firstName: contactFirstName,
+                    lastName: contactLastName,
+                    email: contactEmail,
+                },
+            }),
+            encode: ({ id, contact }) => ({
+                id,
+                contactFirstName: contact.firstName,
+                contactLastName: contact.lastName,
+                contactEmail: contact.email,
+            }),
+        });
+        const makeContactsTable = () => State.SQLite.table({
+            name: 'contacts',
+            schema: Nested,
+            // schema: Flat,
+        });
+        it('exposes flattened insert type while schema type is nested', () => {
+            const contactsTable = makeContactsTable();
+            void contactsTable;
+        });
+        it('fails to encode nested inserts because flat columns are required', () => {
+            const contactsTable = makeContactsTable();
+            expect(contactsTable
+                // TODO in the future we should use decoded types here instead of encoded
+                .insert({
+                id: 'person-1',
+                contactFirstName: 'Ada',
+                contactLastName: 'Lovelace',
+                contactEmail: 'ada@example.com',
+            })
+                .asSql()).toMatchInlineSnapshot(`
+        {
+          "bindValues": [
+            "person-1",
+            "Ada",
+            "Lovelace",
+            "ada@example.com",
+          ],
+          "query": "INSERT INTO 'contacts' ("id", "contactFirstName", "contactLastName", "contactEmail") VALUES (?, ?, ?, ?)",
+          "usedTables": Set {
+            "contacts",
+          },
+        }
+      `);
+        });
+        it('fails to encode nested inserts because flat columns are required', () => {
+            const contactsTable = makeContactsTable();
+            expect(() => contactsTable
+                .insert({
+                id: 'person-1',
+                // @ts-expect-error
+                contact: {
+                    firstName: 'Ada',
+                    lastName: 'Lovelace',
+                    email: 'ada@example.com',
+                },
+            })
+                .asSql()).toThrowErrorMatchingInlineSnapshot(`
+        [ParseError: contacts\n└─ ["contactFirstName"]\n   └─ is missing]
+      `);
+        });
     });
 });
 // TODO nested queries