tinybase 5.2.0-beta.4 → 5.2.0

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

@@ -46,13 +46,13 @@ const DATA_VERSION = 'data_version';
 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(
@@ -315,7 +315,7 @@ const setNew = (entryOrEntries) =>
 const setAdd = (set, value) => set?.add(value);
 
 const getCommandFunctions = (
-  cmd,
+  databaseExecuteCommand,
   managedTableNames,
   querySchema,
   onIgnoredError,
@@ -329,8 +329,9 @@ const getCommandFunctions = (
     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) =>
@@ -338,7 +339,9 @@ const getCommandFunctions = (
       ? objNew(
           arrayFilter(
             arrayMap(
-              await cmd(SELECT_STAR_FROM + escapeId(tableName)),
+              await databaseExecuteCommand(
+                SELECT_STAR_FROM + escapeId(tableName),
+              ),
               (row) => [
                 row[rowIdColumnName],
                 decode
@@ -371,7 +374,7 @@ const getCommandFunctions = (
       arrayIsEmpty(tableColumnNames) &&
       collHas(schemaMap, tableName)
     ) {
-      await cmd('DROP ' + TABLE + escapeId(tableName));
+      await databaseExecuteCommand('DROP ' + TABLE + escapeId(tableName));
       mapSet(schemaMap, tableName);
       return;
     }
@@ -379,7 +382,7 @@ const getCommandFunctions = (
     const currentColumnNames = setNew(collValues(tableSchemaColumns));
     if (!arrayIsEmpty(tableColumnNames)) {
       if (!collHas(schemaMap, tableName)) {
-        await cmd(
+        await databaseExecuteCommand(
           'CREATE ' +
             TABLE +
             escapeId(tableName) +
@@ -401,7 +404,7 @@ const getCommandFunctions = (
             [rowIdColumnName, ...tableColumnNames],
             async (columnName, index) => {
               if (!collDel(currentColumnNames, columnName)) {
-                await cmd(
+                await databaseExecuteCommand(
                   ALTER_TABLE +
                     escapeId(tableName) +
                     'ADD' +
@@ -409,7 +412,7 @@ const getCommandFunctions = (
                     columnType,
                 );
                 if (index == 0) {
-                  await cmd(
+                  await databaseExecuteCommand(
                     'CREATE UNIQUE INDEX pk ON ' +
                       escapeId(tableName) +
                       `(${escapeId(rowIdColumnName)})`,
@@ -426,7 +429,7 @@ const getCommandFunctions = (
       ...(!partial && deleteEmptyColumns
         ? arrayMap(collValues(currentColumnNames), async (columnName) => {
             if (columnName != rowIdColumnName) {
-              await cmd(
+              await databaseExecuteCommand(
                 ALTER_TABLE +
                   escapeId(tableName) +
                   'DROP' +
@@ -439,12 +442,14 @@ const getCommandFunctions = (
     ]);
     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 +
@@ -454,7 +459,7 @@ const getCommandFunctions = (
               );
             } else if (!arrayIsEmpty(tableColumnNames)) {
               await upsert(
-                cmd,
+                databaseExecuteCommand,
                 tableName,
                 rowIdColumnName,
                 objIds(row),
@@ -476,11 +481,11 @@ const getCommandFunctions = (
           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],
@@ -489,14 +494,14 @@ const getCommandFunctions = (
           arrayPush(deleteRowIds, rowId);
         });
         await upsert(
-          cmd,
+          databaseExecuteCommand,
           tableName,
           rowIdColumnName,
           changingColumnNames,
-          args,
+          params,
           orReplace,
         );
-        await cmd(
+        await databaseExecuteCommand(
           DELETE_FROM +
             escapeId(tableName) +
             WHERE +
@@ -505,32 +510,34 @@ const getCommandFunctions = (
           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' +
@@ -544,7 +551,7 @@ const upsert = async (
         ),
       ) +
       ')VALUES' +
-      getUpsertPlaceholders(args, size(changingColumnNames) + 1) +
+      getUpsertPlaceholders(params, size(changingColumnNames) + 1) +
       (orReplace
         ? EMPTY_STRING
         : 'ON CONFLICT(' +
@@ -558,7 +565,7 @@ const upsert = async (
             ),
             COMMA,
           )),
-    arrayMap(args, (arg) => arg ?? null),
+    arrayMap(params, (param) => param ?? null),
   );
 const getUpsertPlaceholders = (array, columnCount) =>
   arrayJoin(
@@ -580,7 +587,7 @@ const getUpsertPlaceholders = (array, columnCount) =>
 
 const createJsonPersister = (
   store,
-  cmd,
+  executeCommand,
   addPersisterListener,
   delPersisterListener,
   onIgnoredError,
@@ -596,7 +603,7 @@ const createJsonPersister = (
 ) => {
   const [refreshSchema, loadTable, saveTable, transaction] =
     getCommandFunctions(
-      cmd,
+      executeCommand,
       managedTableNames,
       querySchema,
       onIgnoredError,
@@ -648,7 +655,7 @@ const createJsonPersister = (
 
 const createTabularPersister = (
   store,
-  cmd,
+  executeCommand,
   addPersisterListener,
   delPersisterListener,
   onIgnoredError,
@@ -670,7 +677,7 @@ const createTabularPersister = (
 ) => {
   const [refreshSchema, loadTable, saveTable, transaction] =
     getCommandFunctions(
-      cmd,
+      executeCommand,
       managedTableNames,
       querySchema,
       onIgnoredError,
@@ -876,14 +883,15 @@ const getConfigStructures = (configOrStoreTableName) => {
   return [0, autoLoadIntervalSeconds, tabularConfig, managedTableNames];
 };
 
-const createSqlitePersister = (
+const createCustomSqlitePersister = (
   store,
   configOrStoreTableName,
-  rawCmd,
-  addUpdateListener,
-  delUpdateListener,
+  rawExecuteCommand,
+  addChangeListener,
+  delChangeListener,
   onSqlCommand,
   onIgnoredError,
+  destroy,
   persist,
   thing,
   getThing = 'getDb',
@@ -892,7 +900,7 @@ const createSqlitePersister = (
   let dataVersion;
   let schemaVersion;
   let totalChanges;
-  const cmd = getWrappedCommand(rawCmd, onSqlCommand);
+  const executeCommand = getWrappedCommand(rawExecuteCommand, onSqlCommand);
   const [
     isJson,
     autoLoadIntervalSeconds,
@@ -904,7 +912,7 @@ const createSqlitePersister = (
     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}`,
           );
@@ -922,7 +930,7 @@ const createSqlitePersister = (
       dataVersion = schemaVersion = totalChanges = null;
       stopInterval(interval);
     };
-    const listeningHandle = addUpdateListener((tableName) => {
+    const listeningHandle = addChangeListener((tableName) => {
       if (managedTableNamesSet.has(tableName)) {
         stopPolling();
         listener();
@@ -932,23 +940,23 @@ const createSqlitePersister = (
     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,
@@ -970,7 +978,7 @@ const createElectricSqlPersister = (
   onSqlCommand,
   onIgnoredError,
 ) =>
-  createSqlitePersister(
+  createCustomSqlitePersister(
     store,
     configOrStoreTableName,
     async (sql, args = []) => await electricClient.db.raw({sql, args}),
@@ -984,6 +992,7 @@ const createElectricSqlPersister = (
     (unsubscribeFunction) => unsubscribeFunction(),
     onSqlCommand,
     onIgnoredError,
+    () => 0,
     1,
     // StoreOnly,
     electricClient,

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

@@ -46,13 +46,13 @@ const DATA_VERSION = 'data_version';
 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(
@@ -315,7 +315,7 @@ const setNew = (entryOrEntries) =>
 const setAdd = (set, value) => set?.add(value);
 
 const getCommandFunctions = (
-  cmd,
+  databaseExecuteCommand,
   managedTableNames,
   querySchema,
   onIgnoredError,
@@ -329,8 +329,9 @@ const getCommandFunctions = (
     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) =>
@@ -338,7 +339,9 @@ const getCommandFunctions = (
       ? objNew(
           arrayFilter(
             arrayMap(
-              await cmd(SELECT_STAR_FROM + escapeId(tableName)),
+              await databaseExecuteCommand(
+                SELECT_STAR_FROM + escapeId(tableName),
+              ),
               (row) => [
                 row[rowIdColumnName],
                 decode
@@ -371,7 +374,7 @@ const getCommandFunctions = (
       arrayIsEmpty(tableColumnNames) &&
       collHas(schemaMap, tableName)
     ) {
-      await cmd('DROP ' + TABLE + escapeId(tableName));
+      await databaseExecuteCommand('DROP ' + TABLE + escapeId(tableName));
       mapSet(schemaMap, tableName);
       return;
     }
@@ -379,7 +382,7 @@ const getCommandFunctions = (
     const currentColumnNames = setNew(collValues(tableSchemaColumns));
     if (!arrayIsEmpty(tableColumnNames)) {
       if (!collHas(schemaMap, tableName)) {
-        await cmd(
+        await databaseExecuteCommand(
           'CREATE ' +
             TABLE +
             escapeId(tableName) +
@@ -401,7 +404,7 @@ const getCommandFunctions = (
             [rowIdColumnName, ...tableColumnNames],
             async (columnName, index) => {
               if (!collDel(currentColumnNames, columnName)) {
-                await cmd(
+                await databaseExecuteCommand(
                   ALTER_TABLE +
                     escapeId(tableName) +
                     'ADD' +
@@ -409,7 +412,7 @@ const getCommandFunctions = (
                     columnType,
                 );
                 if (index == 0) {
-                  await cmd(
+                  await databaseExecuteCommand(
                     'CREATE UNIQUE INDEX pk ON ' +
                       escapeId(tableName) +
                       `(${escapeId(rowIdColumnName)})`,
@@ -426,7 +429,7 @@ const getCommandFunctions = (
       ...(!partial && deleteEmptyColumns
         ? arrayMap(collValues(currentColumnNames), async (columnName) => {
             if (columnName != rowIdColumnName) {
-              await cmd(
+              await databaseExecuteCommand(
                 ALTER_TABLE +
                   escapeId(tableName) +
                   'DROP' +
@@ -439,12 +442,14 @@ const getCommandFunctions = (
     ]);
     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 +
@@ -454,7 +459,7 @@ const getCommandFunctions = (
               );
             } else if (!arrayIsEmpty(tableColumnNames)) {
               await upsert(
-                cmd,
+                databaseExecuteCommand,
                 tableName,
                 rowIdColumnName,
                 objIds(row),
@@ -476,11 +481,11 @@ const getCommandFunctions = (
           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],
@@ -489,14 +494,14 @@ const getCommandFunctions = (
           arrayPush(deleteRowIds, rowId);
         });
         await upsert(
-          cmd,
+          databaseExecuteCommand,
           tableName,
           rowIdColumnName,
           changingColumnNames,
-          args,
+          params,
           orReplace,
         );
-        await cmd(
+        await databaseExecuteCommand(
           DELETE_FROM +
             escapeId(tableName) +
             WHERE +
@@ -505,32 +510,34 @@ const getCommandFunctions = (
           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' +
@@ -544,7 +551,7 @@ const upsert = async (
         ),
       ) +
       ')VALUES' +
-      getUpsertPlaceholders(args, size(changingColumnNames) + 1) +
+      getUpsertPlaceholders(params, size(changingColumnNames) + 1) +
       (orReplace
         ? EMPTY_STRING
         : 'ON CONFLICT(' +
@@ -558,7 +565,7 @@ const upsert = async (
             ),
             COMMA,
           )),
-    arrayMap(args, (arg) => arg ?? null),
+    arrayMap(params, (param) => param ?? null),
   );
 const getUpsertPlaceholders = (array, columnCount) =>
   arrayJoin(
@@ -580,7 +587,7 @@ const getUpsertPlaceholders = (array, columnCount) =>
 
 const createJsonPersister = (
   store,
-  cmd,
+  executeCommand,
   addPersisterListener,
   delPersisterListener,
   onIgnoredError,
@@ -596,7 +603,7 @@ const createJsonPersister = (
 ) => {
   const [refreshSchema, loadTable, saveTable, transaction] =
     getCommandFunctions(
-      cmd,
+      executeCommand,
       managedTableNames,
       querySchema,
       onIgnoredError,
@@ -648,7 +655,7 @@ const createJsonPersister = (
 
 const createTabularPersister = (
   store,
-  cmd,
+  executeCommand,
   addPersisterListener,
   delPersisterListener,
   onIgnoredError,
@@ -670,7 +677,7 @@ const createTabularPersister = (
 ) => {
   const [refreshSchema, loadTable, saveTable, transaction] =
     getCommandFunctions(
-      cmd,
+      executeCommand,
       managedTableNames,
       querySchema,
       onIgnoredError,
@@ -876,14 +883,15 @@ const getConfigStructures = (configOrStoreTableName) => {
   return [0, autoLoadIntervalSeconds, tabularConfig, managedTableNames];
 };
 
-const createSqlitePersister = (
+const createCustomSqlitePersister = (
   store,
   configOrStoreTableName,
-  rawCmd,
-  addUpdateListener,
-  delUpdateListener,
+  rawExecuteCommand,
+  addChangeListener,
+  delChangeListener,
   onSqlCommand,
   onIgnoredError,
+  destroy,
   persist,
   thing,
   getThing = 'getDb',
@@ -892,7 +900,7 @@ const createSqlitePersister = (
   let dataVersion;
   let schemaVersion;
   let totalChanges;
-  const cmd = getWrappedCommand(rawCmd, onSqlCommand);
+  const executeCommand = getWrappedCommand(rawExecuteCommand, onSqlCommand);
   const [
     isJson,
     autoLoadIntervalSeconds,
@@ -904,7 +912,7 @@ const createSqlitePersister = (
     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}`,
           );
@@ -922,7 +930,7 @@ const createSqlitePersister = (
       dataVersion = schemaVersion = totalChanges = null;
       stopInterval(interval);
     };
-    const listeningHandle = addUpdateListener((tableName) => {
+    const listeningHandle = addChangeListener((tableName) => {
       if (managedTableNamesSet.has(tableName)) {
         stopPolling();
         listener();
@@ -932,23 +940,23 @@ const createSqlitePersister = (
     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,
@@ -970,7 +978,7 @@ const createElectricSqlPersister = (
   onSqlCommand,
   onIgnoredError,
 ) =>
-  createSqlitePersister(
+  createCustomSqlitePersister(
     store,
     configOrStoreTableName,
     async (sql, args = []) => await electricClient.db.raw({sql, args}),
@@ -984,6 +992,7 @@ const createElectricSqlPersister = (
     (unsubscribeFunction) => unsubscribeFunction(),
     onSqlCommand,
     onIgnoredError,
+    () => 0,
     1,
     // StoreOnly,
     electricClient,