tinybase 5.2.0-beta.4 → 5.2.0

package/umd/persisters/persister-electric-sql/index.js

@@ -57,13 +57,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(
@@ -330,7 +330,7 @@
   const setAdd = (set, value) => set?.add(value);
 
   const getCommandFunctions = (
-    cmd,
+    databaseExecuteCommand,
     managedTableNames,
     querySchema,
     onIgnoredError,
@@ -344,8 +344,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) =>
@@ -353,7 +354,9 @@
         ? objNew(
             arrayFilter(
               arrayMap(
-                await cmd(SELECT_STAR_FROM + escapeId(tableName)),
+                await databaseExecuteCommand(
+                  SELECT_STAR_FROM + escapeId(tableName),
+                ),
                 (row) => [
                   row[rowIdColumnName],
                   decode
@@ -386,7 +389,7 @@
         arrayIsEmpty(tableColumnNames) &&
         collHas(schemaMap, tableName)
       ) {
-        await cmd('DROP ' + TABLE + escapeId(tableName));
+        await databaseExecuteCommand('DROP ' + TABLE + escapeId(tableName));
         mapSet(schemaMap, tableName);
         return;
       }
@@ -394,7 +397,7 @@
       const currentColumnNames = setNew(collValues(tableSchemaColumns));
       if (!arrayIsEmpty(tableColumnNames)) {
         if (!collHas(schemaMap, tableName)) {
-          await cmd(
+          await databaseExecuteCommand(
             'CREATE ' +
               TABLE +
               escapeId(tableName) +
@@ -416,7 +419,7 @@
               [rowIdColumnName, ...tableColumnNames],
               async (columnName, index) => {
                 if (!collDel(currentColumnNames, columnName)) {
-                  await cmd(
+                  await databaseExecuteCommand(
                     ALTER_TABLE +
                       escapeId(tableName) +
                       'ADD' +
@@ -424,7 +427,7 @@
                       columnType,
                   );
                   if (index == 0) {
-                    await cmd(
+                    await databaseExecuteCommand(
                       'CREATE UNIQUE INDEX pk ON ' +
                         escapeId(tableName) +
                         `(${escapeId(rowIdColumnName)})`,
@@ -441,7 +444,7 @@
         ...(!partial && deleteEmptyColumns
           ? arrayMap(collValues(currentColumnNames), async (columnName) => {
               if (columnName != rowIdColumnName) {
-                await cmd(
+                await databaseExecuteCommand(
                   ALTER_TABLE +
                     escapeId(tableName) +
                     'DROP' +
@@ -454,12 +457,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 +
@@ -469,7 +474,7 @@
                 );
               } else if (!arrayIsEmpty(tableColumnNames)) {
                 await upsert(
-                  cmd,
+                  databaseExecuteCommand,
                   tableName,
                   rowIdColumnName,
                   objIds(row),
@@ -491,11 +496,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],
@@ -504,14 +509,14 @@
             arrayPush(deleteRowIds, rowId);
           });
           await upsert(
-            cmd,
+            databaseExecuteCommand,
             tableName,
             rowIdColumnName,
             changingColumnNames,
-            args,
+            params,
             orReplace,
           );
-          await cmd(
+          await databaseExecuteCommand(
             DELETE_FROM +
               escapeId(tableName) +
               WHERE +
@@ -520,32 +525,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' +
@@ -559,7 +566,7 @@
           ),
         ) +
         ')VALUES' +
-        getUpsertPlaceholders(args, size(changingColumnNames) + 1) +
+        getUpsertPlaceholders(params, size(changingColumnNames) + 1) +
         (orReplace
           ? EMPTY_STRING
           : 'ON CONFLICT(' +
@@ -573,7 +580,7 @@
               ),
               COMMA,
             )),
-      arrayMap(args, (arg) => arg ?? null),
+      arrayMap(params, (param) => param ?? null),
     );
   const getUpsertPlaceholders = (array, columnCount) =>
     arrayJoin(
@@ -595,7 +602,7 @@
 
   const createJsonPersister = (
     store,
-    cmd,
+    executeCommand,
     addPersisterListener,
     delPersisterListener,
     onIgnoredError,
@@ -611,7 +618,7 @@
   ) => {
     const [refreshSchema, loadTable, saveTable, transaction] =
       getCommandFunctions(
-        cmd,
+        executeCommand,
         managedTableNames,
         querySchema,
         onIgnoredError,
@@ -663,7 +670,7 @@
 
   const createTabularPersister = (
     store,
-    cmd,
+    executeCommand,
     addPersisterListener,
     delPersisterListener,
     onIgnoredError,
@@ -685,7 +692,7 @@
   ) => {
     const [refreshSchema, loadTable, saveTable, transaction] =
       getCommandFunctions(
-        cmd,
+        executeCommand,
         managedTableNames,
         querySchema,
         onIgnoredError,
@@ -894,14 +901,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',
@@ -910,7 +918,7 @@
     let dataVersion;
     let schemaVersion;
     let totalChanges;
-    const cmd = getWrappedCommand(rawCmd, onSqlCommand);
+    const executeCommand = getWrappedCommand(rawExecuteCommand, onSqlCommand);
     const [
       isJson,
       autoLoadIntervalSeconds,
@@ -922,7 +930,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}`,
             );
@@ -940,7 +948,7 @@
         dataVersion = schemaVersion = totalChanges = null;
         stopInterval(interval);
       };
-      const listeningHandle = addUpdateListener((tableName) => {
+      const listeningHandle = addChangeListener((tableName) => {
         if (managedTableNamesSet.has(tableName)) {
           stopPolling();
           listener();
@@ -950,23 +958,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,7 +996,7 @@
     onSqlCommand,
     onIgnoredError,
   ) =>
-    createSqlitePersister(
+    createCustomSqlitePersister(
       store,
       configOrStoreTableName,
       async (sql, args = []) => await electricClient.db.raw({sql, args}),
@@ -1002,6 +1010,7 @@
       (unsubscribeFunction) => unsubscribeFunction(),
       onSqlCommand,
       onIgnoredError,
+      () => 0,
       1,
       // StoreOnly,
       electricClient,

package/umd/persisters/persister-electric-sql/with-schemas/index.js

@@ -57,13 +57,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(
@@ -330,7 +330,7 @@
   const setAdd = (set, value) => set?.add(value);
 
   const getCommandFunctions = (
-    cmd,
+    databaseExecuteCommand,
     managedTableNames,
     querySchema,
     onIgnoredError,
@@ -344,8 +344,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) =>
@@ -353,7 +354,9 @@
         ? objNew(
             arrayFilter(
               arrayMap(
-                await cmd(SELECT_STAR_FROM + escapeId(tableName)),
+                await databaseExecuteCommand(
+                  SELECT_STAR_FROM + escapeId(tableName),
+                ),
                 (row) => [
                   row[rowIdColumnName],
                   decode
@@ -386,7 +389,7 @@
         arrayIsEmpty(tableColumnNames) &&
         collHas(schemaMap, tableName)
       ) {
-        await cmd('DROP ' + TABLE + escapeId(tableName));
+        await databaseExecuteCommand('DROP ' + TABLE + escapeId(tableName));
         mapSet(schemaMap, tableName);
         return;
       }
@@ -394,7 +397,7 @@
       const currentColumnNames = setNew(collValues(tableSchemaColumns));
       if (!arrayIsEmpty(tableColumnNames)) {
         if (!collHas(schemaMap, tableName)) {
-          await cmd(
+          await databaseExecuteCommand(
             'CREATE ' +
               TABLE +
               escapeId(tableName) +
@@ -416,7 +419,7 @@
               [rowIdColumnName, ...tableColumnNames],
               async (columnName, index) => {
                 if (!collDel(currentColumnNames, columnName)) {
-                  await cmd(
+                  await databaseExecuteCommand(
                     ALTER_TABLE +
                       escapeId(tableName) +
                       'ADD' +
@@ -424,7 +427,7 @@
                       columnType,
                   );
                   if (index == 0) {
-                    await cmd(
+                    await databaseExecuteCommand(
                       'CREATE UNIQUE INDEX pk ON ' +
                         escapeId(tableName) +
                         `(${escapeId(rowIdColumnName)})`,
@@ -441,7 +444,7 @@
         ...(!partial && deleteEmptyColumns
           ? arrayMap(collValues(currentColumnNames), async (columnName) => {
               if (columnName != rowIdColumnName) {
-                await cmd(
+                await databaseExecuteCommand(
                   ALTER_TABLE +
                     escapeId(tableName) +
                     'DROP' +
@@ -454,12 +457,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 +
@@ -469,7 +474,7 @@
                 );
               } else if (!arrayIsEmpty(tableColumnNames)) {
                 await upsert(
-                  cmd,
+                  databaseExecuteCommand,
                   tableName,
                   rowIdColumnName,
                   objIds(row),
@@ -491,11 +496,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],
@@ -504,14 +509,14 @@
             arrayPush(deleteRowIds, rowId);
           });
           await upsert(
-            cmd,
+            databaseExecuteCommand,
             tableName,
             rowIdColumnName,
             changingColumnNames,
-            args,
+            params,
             orReplace,
           );
-          await cmd(
+          await databaseExecuteCommand(
             DELETE_FROM +
               escapeId(tableName) +
               WHERE +
@@ -520,32 +525,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' +
@@ -559,7 +566,7 @@
           ),
         ) +
         ')VALUES' +
-        getUpsertPlaceholders(args, size(changingColumnNames) + 1) +
+        getUpsertPlaceholders(params, size(changingColumnNames) + 1) +
         (orReplace
           ? EMPTY_STRING
           : 'ON CONFLICT(' +
@@ -573,7 +580,7 @@
               ),
               COMMA,
             )),
-      arrayMap(args, (arg) => arg ?? null),
+      arrayMap(params, (param) => param ?? null),
     );
   const getUpsertPlaceholders = (array, columnCount) =>
     arrayJoin(
@@ -595,7 +602,7 @@
 
   const createJsonPersister = (
     store,
-    cmd,
+    executeCommand,
     addPersisterListener,
     delPersisterListener,
     onIgnoredError,
@@ -611,7 +618,7 @@
   ) => {
     const [refreshSchema, loadTable, saveTable, transaction] =
       getCommandFunctions(
-        cmd,
+        executeCommand,
         managedTableNames,
         querySchema,
         onIgnoredError,
@@ -663,7 +670,7 @@
 
   const createTabularPersister = (
     store,
-    cmd,
+    executeCommand,
     addPersisterListener,
     delPersisterListener,
     onIgnoredError,
@@ -685,7 +692,7 @@
   ) => {
     const [refreshSchema, loadTable, saveTable, transaction] =
       getCommandFunctions(
-        cmd,
+        executeCommand,
         managedTableNames,
         querySchema,
         onIgnoredError,
@@ -894,14 +901,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',
@@ -910,7 +918,7 @@
     let dataVersion;
     let schemaVersion;
     let totalChanges;
-    const cmd = getWrappedCommand(rawCmd, onSqlCommand);
+    const executeCommand = getWrappedCommand(rawExecuteCommand, onSqlCommand);
     const [
       isJson,
       autoLoadIntervalSeconds,
@@ -922,7 +930,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}`,
             );
@@ -940,7 +948,7 @@
         dataVersion = schemaVersion = totalChanges = null;
         stopInterval(interval);
       };
-      const listeningHandle = addUpdateListener((tableName) => {
+      const listeningHandle = addChangeListener((tableName) => {
         if (managedTableNamesSet.has(tableName)) {
           stopPolling();
           listener();
@@ -950,23 +958,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,7 +996,7 @@
     onSqlCommand,
     onIgnoredError,
   ) =>
-    createSqlitePersister(
+    createCustomSqlitePersister(
       store,
       configOrStoreTableName,
       async (sql, args = []) => await electricClient.db.raw({sql, args}),
@@ -1002,6 +1010,7 @@
       (unsubscribeFunction) => unsubscribeFunction(),
       onSqlCommand,
       onIgnoredError,
+      () => 0,
       1,
       // StoreOnly,
       electricClient,