update driver to work with the new gateway, remove pubsub support

Author: Gioee

.github/workflows/test.yml

@@ -34,7 +34,7 @@ jobs:
         env:
           CHINOOK_DATABASE_URL: ${{ secrets.CHINOOK_DATABASE_URL }}
           CHINOOK_API_KEY: ${{ secrets.CHINOOK_API_KEY }}
-          GATEWAY_URL: ${{ secrets.GATEWAY_URL }}
+          GATEWAY_URL: ${{ vars.GATEWAY_URL }}
         run: npm test
       - name: Upload Code Coverage
         uses: codecov/codecov-action@v4
@@ -260,6 +260,8 @@ jobs:
         run: npm i && npx playwright test
         env:
           VITE_DATABASE_URL: ${{ secrets.CHINOOK_DATABASE_URL }}
+          VITE_DATABASE_API_KEY: ${{ secrets.CHINOOK_API_KEY }}
+          VITE_GATEWAY_URL: ${{ vars.GATEWAY_URL }}
 
       - name: bun with-javascript-vite
         if: matrix.os != 'LinuxARM64'
@@ -271,13 +273,17 @@ jobs:
           bun playwright test
         env:
           VITE_DATABASE_URL: ${{ secrets.CHINOOK_DATABASE_URL }}
+          VITE_DATABASE_API_KEY: ${{ secrets.CHINOOK_API_KEY }}
+          VITE_GATEWAY_URL: ${{ vars.GATEWAY_URL }}
 
       - name: deno with-javascript-vite
         if: false #matrix.os != 'windows-latest' windows: https://github.com/denoland/deno/issues/23524#issuecomment-2292075726 linux-ubuntu: https://github.com/sqlitecloud/sqlitecloud-js/issues/197
         working-directory: examples/with-javascript-vite
         run: deno add npm:@playwright/test && deno run --allow-all npm:playwright test
         env:
           VITE_DATABASE_URL: ${{ secrets.CHINOOK_DATABASE_URL }}
+          VITE_DATABASE_API_KEY: ${{ secrets.CHINOOK_API_KEY }}
+          VITE_GATEWAY_URL: ${{ vars.GATEWAY_URL }}
           PW_DISABLE_TS_ESM: true
 
       - name: remove with-javascript-vite
@@ -287,11 +293,17 @@ jobs:
         if: matrix.os != 'LinuxARM64'
         working-directory: examples/with-javascript-browser
         run: npm i && node test.cjs
+        env:
+          DATABASE_URL: ${{ secrets.CHINOOK_DATABASE_URL }}?apikey=${{ secrets.CHINOOK_API_KEY }}
+          GATEWAY_URL: ${{ vars.GATEWAY_URL }}
 
       - name: bun with-javascript-browser
         if: matrix.os != 'windows-latest' && matrix.os != 'LinuxARM64' #cannot launch browsers on windows with bash in commonjs?
         working-directory: examples/with-javascript-browser
         run: bun i && bun test.cjs
+        env:
+          DATABASE_URL: ${{ secrets.CHINOOK_DATABASE_URL }}?apikey=${{ secrets.CHINOOK_API_KEY }}
+          GATEWAY_URL: ${{ vars.GATEWAY_URL }}
 
       # See issue https://github.com/sqlitecloud/sqlitecloud-js/issues/265
       # - name: deno with-javascript-browser

README.md

@@ -70,34 +70,6 @@ We aim for full compatibility with the established [sqlite3 API](https://www.npm
 
 The package is developed entirely in TypeScript and is fully compatible with JavaScript. It doesn't require any native libraries. This makes it a straightforward and effective tool for managing cloud-based databases in a familiar SQLite environment.
 
-## Publish / Subscribe (Pub/Sub)
-
-```ts
-import { Database } from '@sqlitecloud/drivers'
-import { PubSub, PUBSUB_ENTITY_TYPE } from '@sqlitecloud/drivers/lib/drivers/pubsub'
-
-let database = new Database('sqlitecloud://user:password@xxx.sqlite.cloud:8860/chinook.sqlite')
-// or use sqlitecloud://xxx.sqlite.cloud:8860?apikey=xxxxxxx
-
-const pubSub: PubSub = await database.getPubSub()
-
-await pubSub.listen(PUBSUB_ENTITY_TYPE.TABLE, 'albums', (error, results, data) => {
-  if (results) {
-    // Changes on albums table will be received here as JSON object
-    console.log('Received message:', results)
-  }
-})
-
-await database.sql("INSERT INTO albums (Title, ArtistId) values ('Brand new song', 1)")
-
-// Stop listening changes on the table
-await pubSub.unlisten(PUBSUB_ENTITY_TYPE.TABLE, 'albums')
-```
-
-Pub/Sub is a messaging pattern that allows multiple applications to communicate with each other asynchronously. In the context of SQLiteCloud, Pub/Sub can be used to provide real-time updates and notifications to subscribed applications whenever data changes in the database or it can be used to send payloads (messages) to anyone subscribed to a channel.
-
-Pub/Sub Documentation: [https://docs.sqlitecloud.io/docs/pub-sub](https://docs.sqlitecloud.io/docs/pub-sub)
-
 ## Examples
 
 Check out all the supported platforms with related examples [here](https://github.com/sqlitecloud/sqlitecloud-js/tree/main/examples)!

examples/with-javascript-browser/index.html

@@ -20,6 +20,10 @@ <h1>SQLite Cloud Drivers</h1>
         <input type="text" id="connectionStringInput"
             placeholder="Example: sqlitecloud://admin:password@host.sqlite.cloud:8860/chinook.sqlite"
             value="sqlitecloud://host.sqlite.cloud:8860?apikey=apikey" class="border rounded w-full pl-2 pr-2 mb-2" />
+        <div class="text-xs w-12">gatewayUrl</div>
+        <input type="text" id="gatewayUrlInput"
+            placeholder="Example: localhost (leave empty to use the default)"
+            value="" class="border rounded w-full pl-2 pr-2 mb-2" />
         <div class="text-sm w-12">sql:</div>
         <input type="text" id="messageInput"
             placeholder="Example: USE DATABASE chinook.sqlite; select * from customers limit 3"
@@ -47,12 +51,15 @@ <h2 class="pb-4">Results:</h2>
             // Get the input element by ID
             var connectionStringinputElement = document.getElementById('connectionStringInput');
             var connectionstring = connectionStringinputElement.value;
+            var gatewayUrl = document.getElementById('gatewayUrlInput').value.trim();
             // connect via websocket to the gateway on the same server
             const connectionConfig = {
-                gatewayUrl: `${window.location.protocol === 'https:' ? 'wss' : 'ws'
-                    }://${window.location.hostname}:443`,
-                connectionstring: connectionstring,
+                apikey: connectionstring.split('apikey=')[1],
+                connectionstring: connectionstring.split('?apikey=')[0],
             };
+            if (gatewayUrl) {
+                connectionConfig.gatewayurl = gatewayUrl;
+            }
             var database = new window.sqlitecloud.Database(
                 connectionConfig,
                 (error) => {

examples/with-javascript-browser/test.cjs

@@ -16,6 +16,9 @@ const { chromium, firefox, webkit } = require('playwright');
         if (messageInput != 'USE DATABASE chinook.sqlite; select * from customers limit 3') throw Error('Invalid message input');
 
         await page.fill('#connectionStringInput', process.env.DATABASE_URL);
+        if (process.env.GATEWAY_URL) {
+            await page.fill('#gatewayUrlInput', process.env.GATEWAY_URL);
+        }
         await page.click('button#sendButton');
 
         //sleep 3s

examples/with-javascript-vite/src/App.jsx

@@ -1,5 +1,5 @@
 import { useEffect, useState } from "react";
-import { Database } from "@sqlitecloud/drivers";
+import { Database, parseconnectionstring } from "@sqlitecloud/drivers";
 
 
 function App() {
@@ -8,7 +8,12 @@ function App() {
   const getAlbums = async () => {
     let database = null;
     try {
-      database = new Database(import.meta.env.VITE_DATABASE_URL)
+      let config = parseconnectionstring(import.meta.env.VITE_DATABASE_URL)
+      delete config.username
+      delete config.password
+      config.apikey = import.meta.env.VITE_DATABASE_API_KEY
+      if(import.meta.env.VITE_GATEWAY_URL) config.gatewayurl = import.meta.env.VITE_GATEWAY_URL
+      database = new Database(config)
       const result = await database.sql(`
         USE DATABASE chinook.sqlite; 
         SELECT albums.AlbumId as id, albums.Title as title, artists.name as artist