cleanup docs and examples

Author: stevensJourney

packages/common/src/client/triggers/TriggerManager.ts

@@ -314,10 +314,10 @@ export interface TriggerManager {
    *  const dispose = database.triggers.trackTableDiff({
    *        source: 'todos',
    *        columns: ['list_id'],
+   *        operations: [DiffTriggerOperation.INSERT],
    *        when: {
-   *          [DiffTriggerOperation.INSERT]: whenClause`json_extract(NEW.data, '$.list_id') = '123'`
+   *          [DiffTriggerOperation.INSERT]: whenClause`json_extract(NEW.data, '$.list_id') = ${sanitizeUUID(someIdVariable)}`
    *        },
-   *        operations: [DiffTriggerOperation.INSERT],
    *        onChange: async (context) => {
    *          // Fetches the todo records that were inserted during this diff
    *          const newTodos = await context.getAll<Database['todos']>(`

packages/common/src/client/triggers/whenClause.ts

@@ -21,8 +21,8 @@ export function sanitizeUUID(uuid: string): string {
  *
  * **String placeholders:**
  * - All string values passed as placeholders are automatically wrapped in single quotes (`'`).
- * - Any single quotes within the string value are escaped by doubling them (`''`), as required by SQL syntax.
  * - Do not manually wrap placeholders in single quotes in your template string; the function will handle quoting and escaping for you.
+ * - Any single quotes within the string value are escaped by doubling them (`''`), as required by SQL syntax.
  *
  * **Other types:**
  * - `null` and `undefined` are converted to SQL `NULL`.

packages/node/tests/trigger.test.ts

@@ -31,19 +31,13 @@ describe('Triggers', () => {
         // This callback async processed. Invocations are sequential.
         onChange: async () => {
           await database.writeLock(async (tx) => {
-            // TODO
-            // API exposes a context to run things here.
-            // using execute seems to be important on Node.js
-            // the temp table is not present if using getAll
-            const changes = await tx.execute(/* sql */ `
+            const changes = await tx.getAll<TriggerDiffRecord>(/* sql */ `
               SELECT
                 *
               FROM
                 ${tempTable}
             `);
-
-            results.push(...(changes.rows?._array || []));
-
+            results.push(...changes);
             // Clear the temp table after processing
             await tx.execute(/* sql */ ` DELETE FROM ${tempTable}; `);
           });