@vanillaspa/sqlite-database 1.1.0 → 1.2.0

package/index.js

@@ -1,6 +1,5 @@
 import sqlite3InitModule from '@sqlite.org/sqlite-wasm';
-// https://www.npmjs.com/package/@sqlite.org/sqlite-wasm
-// https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers
+import { addEventListener, dispatchEvent } from '@vanillaspa/event-bus';
 
 if (!window.Worker) throw new Error(`Your browser doesn't support web workers.`);
 export const name = "sqlite"; // module name
@@ -27,7 +26,6 @@ function initializeWorker(name) {
 
 function enqueue(worker, payload) {
     const { port1, port2 } = new MessageChannel();
-
     return new Promise((resolve, reject) => {
         port1.onmessage = ({ data }) => {
             port1.close();
@@ -39,34 +37,32 @@ function enqueue(worker, payload) {
             port1.close();
             reject(new Error('MessageChannel deserialization error'));
         };
-
         worker.postMessage(payload, [port2]);
     })
 }
 
 // Public API
-export function downloadDB(name = 'default') {
-    getWorker(name).postMessage({ action: 'downloadDB' });
-}
-
 export function createDB(name = 'default') {
-    initializeWorker(name); // in try-catch?
+    initializeWorker(name);
     return enqueue(getWorker(name), { action: 'createDB', name });
 }
 
 export async function deleteAndTerminateDB(name) {
     const worker = getWorker(name);
-
     await enqueue(worker, { action: 'closeDB' })
-
     const root = await navigator.storage.getDirectory();
     const fileHandle = await root.getFileHandle(`${name}.sqlite3`).catch(() => null);
     if (fileHandle) await fileHandle.remove();
-
     worker.terminate();
     workers.delete(name);
 }
 
+export function downloadDB(name = 'default') {
+    enqueue(getWorker(name), { action: 'downloadDB' }).then(blob => {
+        dispatchEvent(new CustomEvent('sqlite:download', { detail: { blob, name } }))
+    })
+}
+
 export function executeQuery(sql, name = 'default') {
     return enqueue(getWorker(name), { action: "executeQuery", sql });
 }
@@ -85,7 +81,7 @@ export function uploadDB(fileName, arrayBuffer) {
 }
 
 export function terminate(name = 'default') {
-    let worker = workers.get(name);
+    const worker = workers.get(name);
     if (worker) {
         worker.terminate();
         workers.delete(name);
@@ -95,3 +91,13 @@ export function terminate(name = 'default') {
 export function getWorkers() {
     return workers;
 }
+
+addEventListener('sqlite:download', (event) => {
+    const { blob, name } = event.detail;
+    const url = URL.createObjectURL(blob);
+    const a = document.createElement('a');
+    a.href = url;
+    a.download = `${name}.sqlite3`;
+    a.click();
+    URL.revokeObjectURL(url);
+});

package/package.json

@@ -5,11 +5,13 @@
     },
     "description": "A serverless SQLite database inside your browser.",
     "dependencies": {
-        "@sqlite.org/sqlite-wasm":"^3.51.2-build6"
+        "@sqlite.org/sqlite-wasm":"^3.51.2-build6",
+        "@vanillaspa/event-bus": "1.1.0"
     },
     "homepage": "https://github.com/vanillaspa/sqlite-database#readme",
     "keywords": [
         "Database",
+        "EventBus",
         "JavaScript",
         "OPFS",
         "SPA",
@@ -28,5 +30,5 @@
         "url": "git+https://github.com/vanillaspa/sqlite-database.git"
     },
     "type": "module",
-    "version": "1.1.0"
+    "version": "1.2.0"
 }

package/sqliteWorker.js

@@ -1,4 +1,5 @@
 import sqlite3InitModule from '@sqlite.org/sqlite-wasm';
+import { dispatchEvent } from '@vanillaspa/event-bus';
 
 let db = null;
 let sqlite3 = null;
@@ -10,15 +11,17 @@ async function getInstance() {
   return sqlite3;
 }
 
-function reply(result) {
-  postMessage({ type: 'application/json', result });
+function reply(port, result) {
+  port.postMessage({ type: 'application/json', result });
+  port.close();
 }
 
 function replyError(message) {
-  postMessage({ type: 'error', message });
+  port.postMessage({ type: 'error', message });
+  port.close();
 }
 
-function handleSQLiteError(sql, e) {
+function handleSQLiteError(port, sql, e) {
   if (e.message.includes('SQLITE_CANTOPEN')) {
     console.info("Info: No SQLite database available. Upload a new database or reload the page.");
   } else if (e.message.includes('SQLITE_CONSTRAINT_UNIQUE')) {
@@ -26,40 +29,43 @@ function handleSQLiteError(sql, e) {
   } else {
     console.error("Error executing SQL_", sql, e.message);
   }
-  replyError(e.message);
+  replyError(port, e.message);
 }
 
-onmessage = async function ({ data }) {
+onmessage = async function ({ data, ports }) {
   const { action } = data;
+  const port = ports[0] ?? null;
+
   switch (action) {
-    case 'downloadDB': { // special case fire-and-forget - no reply(), no enqueue()
+    case 'createDB': {
+      const { name } = data;
       try {
-        const byteArray = sqlite3.capi.sqlite3_js_db_export(db);
-        const blob = new Blob([byteArray.buffer], { type: "application/vnd.sqlite3" });
-        postMessage({ type: "application/vnd.sqlite3", blob }); // send the database Blob to the API
+        const { newDB, message } = await createDatabase(name)
+        db = newDB;
+        reply(port, message);
       } catch (e) {
-        console.error('downloadDB failed:', e.message)
+        replyError(port, e.message)
       }
       break;
     }
-    case 'createDB': {
-      const { name } = data;
+    case 'downloadDB': {
       try {
-        const { newDB, message } = await createDatabase(name)
-        db = newDB;
-        reply(message);
+        const byteArray = sqlite3.capi.sqlite3_js_db_export(db);
+        const blob = new Blob([byteArray.buffer], { type: "application/vnd.sqlite3" });
+        reply(port, blob);
       } catch (e) {
-        replyError(e.message)
+        replyError(port, e.message);
       }
       break;
     }
+
     case 'executeQuery': {
       const { sql } = data;
       try {
         const result = db.exec({ sql, returnValue: "resultRows" });
-        reply(result);
+        reply(port, result);
       } catch (e) {
-        handleSQLiteError(sql, e)
+        handleSQLiteError(port, sql, e)
       }
       break;
     }
@@ -75,9 +81,9 @@ onmessage = async function ({ data }) {
           const row = stmt.get([]);
           result.push(Object.fromEntries(columns.map((columnName, index) => [columnName, row[index]])));
         }
-        reply(result);
+        reply(port, result);
       } catch (e) {
-        handleSQLiteError(sql, e);
+        handleSQLiteError(port, sql, e);
       } finally {
         stmt?.finalize();
       }
@@ -87,18 +93,18 @@ onmessage = async function ({ data }) {
       const { name, arrayBuffer } = data;
       try {
         const message = await uploadDatabase(name, arrayBuffer)
-        reply(message);
+        reply(port, message);
       } catch (e) {
-        replyError(e.message);
+        replyError(port, e.message);
       }
       break;
     }
     case 'closeDB': {
       try {
         closeDB();
-        reply(null);
+        reply(port, null);
       } catch (e) {
-        replyError(e.message);
+        replyError(port, e.message);
       }
       break;
     }