rename whenClause to sanitizeSQL

Author: stevensJourney

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

@@ -155,9 +155,9 @@ interface BaseCreateDiffTriggerOptions {
    *
    * @example
    * {
-   *  'INSERT': whenClause`json_extract(NEW.data, '$.list_id') = ${sanitizeUUID(list.id)}`
-   *  'UPDATE': whenClause`NEW.id = 'abcd' AND json_extract(NEW.data, '$.status') = 'active'`
-   *  'DELETE': whenClause`json_extract(OLD.data, '$.list_id') = 'abcd'`
+   *  'INSERT': sanitizeSQL`json_extract(NEW.data, '$.list_id') = ${sanitizeUUID(list.id)}`
+   *  'UPDATE': sanitizeSQL`NEW.id = 'abcd' AND json_extract(NEW.data, '$.status') = 'active'`
+   *  'DELETE': sanitizeSQL`json_extract(OLD.data, '$.list_id') = 'abcd'`
    * }
    */
   when?: Partial<Record<DiffTriggerOperation, string>>;
@@ -342,7 +342,7 @@ export interface TriggerManager {
    *        columns: ['list_id'],
    *        operations: [DiffTriggerOperation.INSERT],
    *        when: {
-   *          [DiffTriggerOperation.INSERT]: whenClause`json_extract(NEW.data, '$.list_id') = ${sanitizeUUID(someIdVariable)}`
+   *          [DiffTriggerOperation.INSERT]: sanitizeSQL`json_extract(NEW.data, '$.list_id') = ${sanitizeUUID(someIdVariable)}`
    *        },
    *        onChange: async (context) => {
    *          // Fetches the todo records that were inserted during this diff

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

@@ -3,7 +3,7 @@ function sanitizeString(input: string): string {
 }
 /**
  * Helper function for sanitizing UUID input strings.
- * Typically used with {@link whenClause}.
+ * Typically used with {@link sanitizeSQL}.
  */
 export function sanitizeUUID(uuid: string): string {
   const uuidRegex = /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
@@ -32,17 +32,17 @@ export function sanitizeUUID(uuid: string): string {
  * **Usage example:**
  * ```typescript
  * const myID = "O'Reilly";
- * const clause = whenClause`New.id = ${myID}`;
+ * const clause = sanitizeSQL`New.id = ${myID}`;
  * // Result: "New.id = 'O''Reilly'"
  * ```
  *
  * Avoid manually quoting placeholders:
  * ```typescript
  * // Incorrect:
- * whenClause`New.id = '${myID}'` // Produces double quotes: New.id = ''O''Reilly''
+ * sanitizeSQL`New.id = '${myID}'` // Produces double quotes: New.id = ''O''Reilly''
  * ```
  */
-export function whenClause(strings: TemplateStringsArray, ...values: any[]): string {
+export function sanitizeSQL(strings: TemplateStringsArray, ...values: any[]): string {
   let result = '';
   strings.forEach((str, i) => {
     result += str;

packages/common/src/index.ts

@@ -32,8 +32,8 @@ export * from './db/schema/Table.js';
 export * from './db/schema/TableV2.js';
 
 export * from './client/Query.js';
+export * from './client/triggers/sanitizeSQL.js';
 export * from './client/triggers/TriggerManager.js';
-export * from './client/triggers/whenClause.js';
 export * from './client/watched/GetAllQuery.js';
 export * from './client/watched/processors/AbstractQueryProcessor.js';
 export * from './client/watched/processors/comparators.js';

packages/node/tests/trigger.test.ts

@@ -2,11 +2,11 @@ import {
   column,
   DiffTriggerOperation,
   ExtractedTriggerDiffRecord,
+  sanitizeSQL,
   sanitizeUUID,
   Schema,
   Table,
-  TriggerDiffRecord,
-  whenClause
+  TriggerDiffRecord
 } from '@powersync/common';
 import { describe, expect, vi } from 'vitest';
 import { Database, databaseTest } from './utils';
@@ -114,7 +114,7 @@ describe('Triggers', () => {
       source: 'todos',
       columns: ['list_id'],
       when: {
-        [DiffTriggerOperation.INSERT]: whenClause`json_extract(NEW.data, '$.list_id') = ${sanitizeUUID(firstList.id)}`
+        [DiffTriggerOperation.INSERT]: sanitizeSQL`json_extract(NEW.data, '$.list_id') = ${sanitizeUUID(firstList.id)}`
       },
       operations: [DiffTriggerOperation.INSERT],
       onChange: async (context) => {
@@ -193,7 +193,7 @@ describe('Triggers', () => {
      */
     await database.triggers.trackTableDiff({
       source: 'lists',
-      when: { [DiffTriggerOperation.UPDATE]: whenClause`NEW.id = ${sanitizeUUID(list.id)}` },
+      when: { [DiffTriggerOperation.UPDATE]: sanitizeSQL`NEW.id = ${sanitizeUUID(list.id)}` },
       operations: [DiffTriggerOperation.UPDATE, DiffTriggerOperation.DELETE],
       onChange: async (context) => {
         // Fetches the todo records that were inserted during this diff
@@ -303,7 +303,7 @@ describe('Triggers', () => {
       source: 'todos',
       columns: ['list_id'],
       when: {
-        [DiffTriggerOperation.INSERT]: whenClause`json_extract(NEW.data, '$.list_id') = ${sanitizeUUID(firstList.id)}`
+        [DiffTriggerOperation.INSERT]: sanitizeSQL`json_extract(NEW.data, '$.list_id') = ${sanitizeUUID(firstList.id)}`
       },
       operations: [DiffTriggerOperation.INSERT],
       onChange: async (context) => {
@@ -393,7 +393,7 @@ describe('Triggers', () => {
     await database.triggers.trackTableDiff({
       source: 'todos',
       when: {
-        [DiffTriggerOperation.INSERT]: whenClause`json_extract(NEW.data, '$.list_id') = ${sanitizeUUID(firstList.id)}`
+        [DiffTriggerOperation.INSERT]: sanitizeSQL`json_extract(NEW.data, '$.list_id') = ${sanitizeUUID(firstList.id)}`
       },
       operations: [DiffTriggerOperation.INSERT],
       onChange: async (context) => {