tinybase 5.2.0-beta.4 → 5.2.0

package/umd/persisters/persister-postgres/with-schemas/index.js

@@ -48,13 +48,13 @@
   const ALTER_TABLE = 'ALTER ' + TABLE;
   const DELETE_FROM = 'DELETE FROM';
   const SELECT_STAR_FROM = SELECT + '*FROM';
-  const getWrappedCommand = (rawCmd, onSqlCommand) =>
+  const getWrappedCommand = (executeCommand, onSqlCommand) =>
     onSqlCommand
-      ? async (sql, args) => {
-          onSqlCommand(sql, args);
-          return await rawCmd(sql, args);
+      ? async (sql, params) => {
+          onSqlCommand(sql, params);
+          return await executeCommand(sql, params);
         }
-      : rawCmd;
+      : executeCommand;
   const escapeId = (str) => `"${str.replace(/"/g, '""')}"`;
   const getPlaceholders = (array) =>
     arrayJoin(
@@ -321,7 +321,7 @@
   const setAdd = (set, value) => set?.add(value);
 
   const getCommandFunctions = (
-    cmd,
+    databaseExecuteCommand,
     managedTableNames,
     querySchema,
     onIgnoredError,
@@ -335,8 +335,9 @@
       collHas(mapGet(schemaMap, tableName), rowIdColumnName);
     const refreshSchema = async () => {
       collClear(schemaMap);
-      arrayMap(await querySchema(cmd, managedTableNames), ({tn, cn}) =>
-        setAdd(mapEnsure(schemaMap, tn, setNew), cn),
+      arrayMap(
+        await querySchema(databaseExecuteCommand, managedTableNames),
+        ({tn, cn}) => setAdd(mapEnsure(schemaMap, tn, setNew), cn),
       );
     };
     const loadTable = async (tableName, rowIdColumnName) =>
@@ -344,7 +345,9 @@
         ? objNew(
             arrayFilter(
               arrayMap(
-                await cmd(SELECT_STAR_FROM + escapeId(tableName)),
+                await databaseExecuteCommand(
+                  SELECT_STAR_FROM + escapeId(tableName),
+                ),
                 (row) => [
                   row[rowIdColumnName],
                   decode
@@ -377,7 +380,7 @@
         arrayIsEmpty(tableColumnNames) &&
         collHas(schemaMap, tableName)
       ) {
-        await cmd('DROP ' + TABLE + escapeId(tableName));
+        await databaseExecuteCommand('DROP ' + TABLE + escapeId(tableName));
         mapSet(schemaMap, tableName);
         return;
       }
@@ -385,7 +388,7 @@
       const currentColumnNames = setNew(collValues(tableSchemaColumns));
       if (!arrayIsEmpty(tableColumnNames)) {
         if (!collHas(schemaMap, tableName)) {
-          await cmd(
+          await databaseExecuteCommand(
             'CREATE ' +
               TABLE +
               escapeId(tableName) +
@@ -407,7 +410,7 @@
               [rowIdColumnName, ...tableColumnNames],
               async (columnName, index) => {
                 if (!collDel(currentColumnNames, columnName)) {
-                  await cmd(
+                  await databaseExecuteCommand(
                     ALTER_TABLE +
                       escapeId(tableName) +
                       'ADD' +
@@ -415,7 +418,7 @@
                       columnType,
                   );
                   if (index == 0) {
-                    await cmd(
+                    await databaseExecuteCommand(
                       'CREATE UNIQUE INDEX pk ON ' +
                         escapeId(tableName) +
                         `(${escapeId(rowIdColumnName)})`,
@@ -432,7 +435,7 @@
         ...(!partial && deleteEmptyColumns
           ? arrayMap(collValues(currentColumnNames), async (columnName) => {
               if (columnName != rowIdColumnName) {
-                await cmd(
+                await databaseExecuteCommand(
                   ALTER_TABLE +
                     escapeId(tableName) +
                     'DROP' +
@@ -445,12 +448,14 @@
       ]);
       if (partial) {
         if (isUndefined(content)) {
-          await cmd(DELETE_FROM + escapeId(tableName) + WHERE + ' true');
+          await databaseExecuteCommand(
+            DELETE_FROM + escapeId(tableName) + WHERE + ' true',
+          );
         } else {
           await promiseAll(
             objToArray(content, async (row, rowId) => {
               if (isUndefined(row)) {
-                await cmd(
+                await databaseExecuteCommand(
                   DELETE_FROM +
                     escapeId(tableName) +
                     WHERE +
@@ -460,7 +465,7 @@
                 );
               } else if (!arrayIsEmpty(tableColumnNames)) {
                 await upsert(
-                  cmd,
+                  databaseExecuteCommand,
                   tableName,
                   rowIdColumnName,
                   objIds(row),
@@ -482,11 +487,11 @@
             collValues(mapGet(schemaMap, tableName)),
             (columnName) => columnName != rowIdColumnName,
           );
-          const args = [];
+          const params = [];
           const deleteRowIds = [];
           objToArray(content ?? {}, (row, rowId) => {
             arrayPush(
-              args,
+              params,
               rowId,
               ...arrayMap(changingColumnNames, (cellId) =>
                 encode ? encode(row?.[cellId]) : row?.[cellId],
@@ -495,14 +500,14 @@
             arrayPush(deleteRowIds, rowId);
           });
           await upsert(
-            cmd,
+            databaseExecuteCommand,
             tableName,
             rowIdColumnName,
             changingColumnNames,
-            args,
+            params,
             orReplace,
           );
-          await cmd(
+          await databaseExecuteCommand(
             DELETE_FROM +
               escapeId(tableName) +
               WHERE +
@@ -511,32 +516,34 @@
             deleteRowIds,
           );
         } else if (collHas(schemaMap, tableName)) {
-          await cmd(DELETE_FROM + escapeId(tableName) + WHERE + ' true');
+          await databaseExecuteCommand(
+            DELETE_FROM + escapeId(tableName) + WHERE + ' true',
+          );
         }
       }
     };
     const transaction = async (actions) => {
       let result;
-      await cmd('BEGIN');
+      await databaseExecuteCommand('BEGIN');
       try {
         result = await actions();
       } catch (error) {
         onIgnoredError?.(error);
       }
-      await cmd('END');
+      await databaseExecuteCommand('END');
       return result;
     };
     return [refreshSchema, loadTable, saveTable, transaction];
   };
   const upsert = async (
-    cmd,
+    executeCommand,
     tableName,
     rowIdColumnName,
     changingColumnNames,
-    args,
+    params,
     orReplace = 0,
   ) =>
-    await cmd(
+    await executeCommand(
       'INSERT ' +
         (orReplace ? 'OR REPLACE ' : EMPTY_STRING) +
         'INTO' +
@@ -550,7 +557,7 @@
           ),
         ) +
         ')VALUES' +
-        getUpsertPlaceholders(args, size(changingColumnNames) + 1) +
+        getUpsertPlaceholders(params, size(changingColumnNames) + 1) +
         (orReplace
           ? EMPTY_STRING
           : 'ON CONFLICT(' +
@@ -564,7 +571,7 @@
               ),
               COMMA,
             )),
-      arrayMap(args, (arg) => arg ?? null),
+      arrayMap(params, (param) => param ?? null),
     );
   const getUpsertPlaceholders = (array, columnCount) =>
     arrayJoin(
@@ -586,7 +593,7 @@
 
   const createJsonPersister = (
     store,
-    cmd,
+    executeCommand,
     addPersisterListener,
     delPersisterListener,
     onIgnoredError,
@@ -602,7 +609,7 @@
   ) => {
     const [refreshSchema, loadTable, saveTable, transaction] =
       getCommandFunctions(
-        cmd,
+        executeCommand,
         managedTableNames,
         querySchema,
         onIgnoredError,
@@ -654,7 +661,7 @@
 
   const createTabularPersister = (
     store,
-    cmd,
+    executeCommand,
     addPersisterListener,
     delPersisterListener,
     onIgnoredError,
@@ -676,7 +683,7 @@
   ) => {
     const [refreshSchema, loadTable, saveTable, transaction] =
       getCommandFunctions(
-        cmd,
+        executeCommand,
         managedTableNames,
         querySchema,
         onIgnoredError,
@@ -889,12 +896,12 @@
   const EVENT_REGEX = /^([cd]:)(.+)/;
   const CHANGE_DATA_TRIGGER = TINYBASE + '_data';
   const CREATE_TABLE_TRIGGER = TINYBASE + '_table';
-  const createPostgreSqlPersister = (
+  const createCustomPostgreSqlPersister = (
     store,
     configOrStoreTableName,
-    rawCmd,
-    addNotifyListener,
-    delNotifyListener,
+    rawExecuteCommand,
+    addChangeListener,
+    delChangeListener,
     onSqlCommand,
     onIgnoredError,
     destroy,
@@ -902,40 +909,40 @@
     thing,
     getThing = 'getDb',
   ) => {
-    const cmd = getWrappedCommand(rawCmd, onSqlCommand);
+    const executeCommand = getWrappedCommand(rawExecuteCommand, onSqlCommand);
     const [isJson, , defaultedConfig, managedTableNamesSet] =
       getConfigStructures(configOrStoreTableName);
     const addDataTrigger = async (tableName) => {
-      await cmd(
+      await executeCommand(
         // eslint-disable-next-line max-len
         `CREATE OR REPLACE TRIGGER ${escapeId(CHANGE_DATA_TRIGGER + '_' + tableName)} AFTER INSERT OR UPDATE OR DELETE ON ${escapeId(tableName)} EXECUTE FUNCTION ${CHANGE_DATA_TRIGGER}()`,
       );
     };
     const addPersisterListener = async (listener) => {
-      await cmd(
+      await executeCommand(
         // eslint-disable-next-line max-len
         `CREATE OR REPLACE FUNCTION ${CREATE_TABLE_TRIGGER}()RETURNS event_trigger AS $t2$ DECLARE row record; BEGIN FOR row IN SELECT object_identity FROM pg_event_trigger_ddl_commands()WHERE command_tag='CREATE TABLE' LOOP PERFORM pg_notify('${EVENT_CHANNEL}','c:'||SPLIT_PART(row.object_identity,'.',2));END LOOP;END;$t2$ LANGUAGE plpgsql;`,
       );
       try {
-        await cmd(
+        await executeCommand(
           // eslint-disable-next-line max-len
           `CREATE EVENT TRIGGER ${CREATE_TABLE_TRIGGER} ON ddl_command_end WHEN TAG IN('CREATE TABLE')EXECUTE FUNCTION ${CREATE_TABLE_TRIGGER}();`,
         );
       } catch {}
-      await cmd(
+      await executeCommand(
         // eslint-disable-next-line max-len
         `CREATE OR REPLACE FUNCTION ${CHANGE_DATA_TRIGGER}()RETURNS trigger AS $t1$ BEGIN PERFORM pg_notify('${EVENT_CHANNEL}','d:'||TG_TABLE_NAME);RETURN NULL;END;$t1$ LANGUAGE plpgsql;`,
       );
       await promiseAll(
         arrayMap(collValues(managedTableNamesSet), async (tableName) => {
-          await cmd(
+          await executeCommand(
             // eslint-disable-next-line max-len
             `CREATE TABLE IF NOT EXISTS ${escapeId(tableName)}("_id"text PRIMARY KEY)`,
           );
           await addDataTrigger(tableName);
         }),
       );
-      return await addNotifyListener(
+      return await addChangeListener(
         EVENT_CHANNEL,
         async (prefixAndTableName) =>
           await ifNotUndefined(
@@ -951,10 +958,10 @@
           ),
       );
     };
-    const delPersisterListener = delNotifyListener;
+    const delPersisterListener = delChangeListener;
     return (isJson ? createJsonPersister : createTabularPersister)(
       store,
-      cmd,
+      executeCommand,
       addPersisterListener,
       delPersisterListener,
       onIgnoredError,
@@ -962,8 +969,8 @@
       persist,
       defaultedConfig,
       collValues(managedTableNamesSet),
-      async (cmd2, managedTableNames) =>
-        await cmd2(
+      async (executeCommand2, managedTableNames) =>
+        await executeCommand2(
           // eslint-disable-next-line max-len
           `${SELECT} table_name tn,column_name cn FROM information_schema.columns ${WHERE} table_schema='public'AND table_name IN(${getPlaceholders(managedTableNames)})`,
           managedTableNames,
@@ -984,12 +991,12 @@
     onSqlCommand,
     onIgnoredError,
   ) => {
-    const cmdSql = await sql.reserve?.();
-    return createPostgreSqlPersister(
+    const commandSql = await sql.reserve?.();
+    return createCustomPostgreSqlPersister(
       store,
       configOrStoreTableName,
-      cmdSql?.unsafe,
-      async (channel, notifyListener) => sql.listen(channel, notifyListener),
+      commandSql?.unsafe,
+      async (channel, listener) => sql.listen(channel, listener),
       async (notifyListener) => {
         try {
           await notifyListener.unlisten();
@@ -999,7 +1006,7 @@
       },
       onSqlCommand,
       onIgnoredError,
-      () => cmdSql?.release?.(),
+      () => commandSql?.release?.(),
       3,
       // StoreOrMergeableStore,
       sql,

package/umd/persisters/persister-powersync/index.js

@@ -56,13 +56,13 @@
   const SCHEMA_VERSION = 'schema_version';
   const FROM = 'FROM ';
   const PRAGMA_TABLE = 'pragma_table_';
-  const getWrappedCommand = (rawCmd, onSqlCommand) =>
+  const getWrappedCommand = (executeCommand, onSqlCommand) =>
     onSqlCommand
-      ? async (sql, args) => {
-          onSqlCommand(sql, args);
-          return await rawCmd(sql, args);
+      ? async (sql, params) => {
+          onSqlCommand(sql, params);
+          return await executeCommand(sql, params);
         }
-      : rawCmd;
+      : executeCommand;
   const escapeId = (str) => `"${str.replace(/"/g, '""')}"`;
   const getPlaceholders = (array) =>
     arrayJoin(
@@ -329,7 +329,7 @@
   const setAdd = (set, value) => set?.add(value);
 
   const getCommandFunctions = (
-    cmd,
+    databaseExecuteCommand,
     managedTableNames,
     querySchema,
     onIgnoredError,
@@ -343,8 +343,9 @@
       collHas(mapGet(schemaMap, tableName), rowIdColumnName);
     const refreshSchema = async () => {
       collClear(schemaMap);
-      arrayMap(await querySchema(cmd, managedTableNames), ({tn, cn}) =>
-        setAdd(mapEnsure(schemaMap, tn, setNew), cn),
+      arrayMap(
+        await querySchema(databaseExecuteCommand, managedTableNames),
+        ({tn, cn}) => setAdd(mapEnsure(schemaMap, tn, setNew), cn),
       );
     };
     const loadTable = async (tableName, rowIdColumnName) =>
@@ -352,7 +353,9 @@
         ? objNew(
             arrayFilter(
               arrayMap(
-                await cmd(SELECT_STAR_FROM + escapeId(tableName)),
+                await databaseExecuteCommand(
+                  SELECT_STAR_FROM + escapeId(tableName),
+                ),
                 (row) => [
                   row[rowIdColumnName],
                   decode
@@ -385,7 +388,7 @@
         arrayIsEmpty(tableColumnNames) &&
         collHas(schemaMap, tableName)
       ) {
-        await cmd('DROP ' + TABLE + escapeId(tableName));
+        await databaseExecuteCommand('DROP ' + TABLE + escapeId(tableName));
         mapSet(schemaMap, tableName);
         return;
       }
@@ -393,7 +396,7 @@
       const currentColumnNames = setNew(collValues(tableSchemaColumns));
       if (!arrayIsEmpty(tableColumnNames)) {
         if (!collHas(schemaMap, tableName)) {
-          await cmd(
+          await databaseExecuteCommand(
             'CREATE ' +
               TABLE +
               escapeId(tableName) +
@@ -415,7 +418,7 @@
               [rowIdColumnName, ...tableColumnNames],
               async (columnName, index) => {
                 if (!collDel(currentColumnNames, columnName)) {
-                  await cmd(
+                  await databaseExecuteCommand(
                     ALTER_TABLE +
                       escapeId(tableName) +
                       'ADD' +
@@ -423,7 +426,7 @@
                       columnType,
                   );
                   if (index == 0) {
-                    await cmd(
+                    await databaseExecuteCommand(
                       'CREATE UNIQUE INDEX pk ON ' +
                         escapeId(tableName) +
                         `(${escapeId(rowIdColumnName)})`,
@@ -440,7 +443,7 @@
         ...(!partial && deleteEmptyColumns
           ? arrayMap(collValues(currentColumnNames), async (columnName) => {
               if (columnName != rowIdColumnName) {
-                await cmd(
+                await databaseExecuteCommand(
                   ALTER_TABLE +
                     escapeId(tableName) +
                     'DROP' +
@@ -453,12 +456,14 @@
       ]);
       if (partial) {
         if (isUndefined(content)) {
-          await cmd(DELETE_FROM + escapeId(tableName) + WHERE + ' true');
+          await databaseExecuteCommand(
+            DELETE_FROM + escapeId(tableName) + WHERE + ' true',
+          );
         } else {
           await promiseAll(
             objToArray(content, async (row, rowId) => {
               if (isUndefined(row)) {
-                await cmd(
+                await databaseExecuteCommand(
                   DELETE_FROM +
                     escapeId(tableName) +
                     WHERE +
@@ -468,7 +473,7 @@
                 );
               } else if (!arrayIsEmpty(tableColumnNames)) {
                 await upsert(
-                  cmd,
+                  databaseExecuteCommand,
                   tableName,
                   rowIdColumnName,
                   objIds(row),
@@ -490,11 +495,11 @@
             collValues(mapGet(schemaMap, tableName)),
             (columnName) => columnName != rowIdColumnName,
           );
-          const args = [];
+          const params = [];
           const deleteRowIds = [];
           objToArray(content ?? {}, (row, rowId) => {
             arrayPush(
-              args,
+              params,
               rowId,
               ...arrayMap(changingColumnNames, (cellId) =>
                 encode ? encode(row?.[cellId]) : row?.[cellId],
@@ -503,14 +508,14 @@
             arrayPush(deleteRowIds, rowId);
           });
           await upsert(
-            cmd,
+            databaseExecuteCommand,
             tableName,
             rowIdColumnName,
             changingColumnNames,
-            args,
+            params,
             orReplace,
           );
-          await cmd(
+          await databaseExecuteCommand(
             DELETE_FROM +
               escapeId(tableName) +
               WHERE +
@@ -519,32 +524,34 @@
             deleteRowIds,
           );
         } else if (collHas(schemaMap, tableName)) {
-          await cmd(DELETE_FROM + escapeId(tableName) + WHERE + ' true');
+          await databaseExecuteCommand(
+            DELETE_FROM + escapeId(tableName) + WHERE + ' true',
+          );
         }
       }
     };
     const transaction = async (actions) => {
       let result;
-      await cmd('BEGIN');
+      await databaseExecuteCommand('BEGIN');
       try {
         result = await actions();
       } catch (error) {
         onIgnoredError?.(error);
       }
-      await cmd('END');
+      await databaseExecuteCommand('END');
       return result;
     };
     return [refreshSchema, loadTable, saveTable, transaction];
   };
   const upsert = async (
-    cmd,
+    executeCommand,
     tableName,
     rowIdColumnName,
     changingColumnNames,
-    args,
+    params,
     orReplace = 0,
   ) =>
-    await cmd(
+    await executeCommand(
       'INSERT ' +
         (orReplace ? 'OR REPLACE ' : EMPTY_STRING) +
         'INTO' +
@@ -558,7 +565,7 @@
           ),
         ) +
         ')VALUES' +
-        getUpsertPlaceholders(args, size(changingColumnNames) + 1) +
+        getUpsertPlaceholders(params, size(changingColumnNames) + 1) +
         (orReplace
           ? EMPTY_STRING
           : 'ON CONFLICT(' +
@@ -572,7 +579,7 @@
               ),
               COMMA,
             )),
-      arrayMap(args, (arg) => arg ?? null),
+      arrayMap(params, (param) => param ?? null),
     );
   const getUpsertPlaceholders = (array, columnCount) =>
     arrayJoin(
@@ -594,7 +601,7 @@
 
   const createJsonPersister = (
     store,
-    cmd,
+    executeCommand,
     addPersisterListener,
     delPersisterListener,
     onIgnoredError,
@@ -610,7 +617,7 @@
   ) => {
     const [refreshSchema, loadTable, saveTable, transaction] =
       getCommandFunctions(
-        cmd,
+        executeCommand,
         managedTableNames,
         querySchema,
         onIgnoredError,
@@ -662,7 +669,7 @@
 
   const createTabularPersister = (
     store,
-    cmd,
+    executeCommand,
     addPersisterListener,
     delPersisterListener,
     onIgnoredError,
@@ -684,7 +691,7 @@
   ) => {
     const [refreshSchema, loadTable, saveTable, transaction] =
       getCommandFunctions(
-        cmd,
+        executeCommand,
         managedTableNames,
         querySchema,
         onIgnoredError,
@@ -893,14 +900,15 @@
     return [0, autoLoadIntervalSeconds, tabularConfig, managedTableNames];
   };
 
-  const createSqlitePersister = (
+  const createCustomSqlitePersister = (
     store,
     configOrStoreTableName,
-    rawCmd,
-    addUpdateListener,
-    delUpdateListener,
+    rawExecuteCommand,
+    addChangeListener,
+    delChangeListener,
     onSqlCommand,
     onIgnoredError,
+    destroy,
     persist,
     thing,
     getThing = 'getDb',
@@ -909,7 +917,7 @@
     let dataVersion;
     let schemaVersion;
     let totalChanges;
-    const cmd = getWrappedCommand(rawCmd, onSqlCommand);
+    const executeCommand = getWrappedCommand(rawExecuteCommand, onSqlCommand);
     const [
       isJson,
       autoLoadIntervalSeconds,
@@ -921,7 +929,7 @@
       const startPolling = () =>
         (interval = startInterval(async () => {
           try {
-            const [{d, s, c}] = await cmd(
+            const [{d, s, c}] = await executeCommand(
               // eslint-disable-next-line max-len
               `${SELECT} ${DATA_VERSION} d,${SCHEMA_VERSION} s,TOTAL_CHANGES() c FROM ${PRAGMA}${DATA_VERSION} JOIN ${PRAGMA}${SCHEMA_VERSION}`,
             );
@@ -939,7 +947,7 @@
         dataVersion = schemaVersion = totalChanges = null;
         stopInterval(interval);
       };
-      const listeningHandle = addUpdateListener((tableName) => {
+      const listeningHandle = addChangeListener((tableName) => {
         if (managedTableNamesSet.has(tableName)) {
           stopPolling();
           listener();
@@ -949,23 +957,23 @@
       startPolling();
       return () => {
         stopPolling();
-        delUpdateListener(listeningHandle);
+        delChangeListener(listeningHandle);
       };
     };
     const delPersisterListener = (stopPollingAndDelUpdateListener) =>
       stopPollingAndDelUpdateListener();
     return (isJson ? createJsonPersister : createTabularPersister)(
       store,
-      cmd,
+      executeCommand,
       addPersisterListener,
       delPersisterListener,
       onIgnoredError,
-      () => 0,
+      destroy,
       persist,
       defaultedConfig,
       collValues(managedTableNamesSet),
-      async (cmd2, managedTableNames) =>
-        await cmd2(
+      async (executeCommand2, managedTableNames) =>
+        await executeCommand2(
           // eslint-disable-next-line max-len
           `${SELECT} t.name tn,c.name cn ${FROM}${PRAGMA_TABLE}list()t,${PRAGMA_TABLE}info(t.name)c ${WHERE} t.schema='main'AND t.type IN('table','view')AND t.name IN(${getPlaceholders(managedTableNames)})ORDER BY t.name,c.name`,
           managedTableNames,
@@ -988,12 +996,12 @@
     onIgnoredError,
     orReplace = 1,
   ) =>
-    createSqlitePersister(
+    createCustomSqlitePersister(
       store,
       configOrStoreTableName,
-      async (sql, args = []) =>
+      async (sql, params = []) =>
         powerSync
-          .execute(sql, args)
+          .execute(sql, params)
           .then((result) => result.rows?._array ?? []),
       (listener) => {
         const abortController = new AbortController();
@@ -1011,6 +1019,7 @@
       (abortController) => abortController.abort(),
       onSqlCommand,
       onIgnoredError,
+      () => 0,
       1,
       // StoreOnly,
       powerSync,