@jcbuisson/express-x-plugins 4.0.4 → 4.0.5

package/README.md

@@ -1,23 +1,43 @@
-# express-x-electric
+# express-x-plugins
+
+Currently includes:
+
+- a plugin which preserves room membership and socket data across page reloads
+- a plugin integrating ElectricSQL sync engine into express-x, which greatly simplifies relational database
+access and provides powerful local-first features
 
-The smallest useful ElectricSQL integration for Express-X. Express-X handles
-authorized PostgreSQL mutations; Electric's Shape API streams those changes to
-clients: Electric is the sync engine.
 
 ## Install
 
 ```sh
-npm install @jcbuisson/express-x-electric pg
+npm install @jcbuisson/express-x-plugins
 ```
 
-This server-only installation does not install the browser Electric client or RxJS.
 
-## Server
+## Reload plugin
+
+### Server
+
+```js
+import { reloadPlugin } from '@jcbuisson/express-x-plugins/reload-server'
+```
+
+
+## Local-first Postgres plugin
+
+The smallest useful ElectricSQL integration for Express-X. Express-X handles authorized PostgreSQL mutations;
+Electric's Shape API streams those changes to clients: Electric is the sync engine.
+
+### Server
+
+```sh
+npm install pg
+```
 
 ```js
 import { Pool } from 'pg'
-import { expressX } from '@jcbuisson/express-x'
-import { electricOfflinePlugin } from '@jcbuisson/express-x-electric'
+import { expressX } from '@jcbuisson/express-x/server'
+import { electricOfflinePlugin } from '@jcbuisson/express-x-plugins/electric-server'
 
 const app = expressX()
 const db = new Pool({ connectionString: process.env.DATABASE_URL })
@@ -49,16 +69,16 @@ Mutation results remain `[value, meta]` tuples for compatibility. `meta.txid`
 contains `pg_current_xact_id()` and can be passed to an Electric-aware client to
 wait for the matching transaction in its Shape stream.
 
-## Client Shape
+### Client
 
 Install the optional client dependencies in the browser application:
 
 ```sh
-npm install @jcbuisson/express-x-electric @electric-sql/client rxjs vue
+npm install @electric-sql/client rxjs
 ```
 
 ```js
-import { electricClientPlugin } from '@jcbuisson/express-x-electric/client'
+import { electricClientPlugin } from '@jcbuisson/express-x-plugins/electric-client'
 
 app.configure(electricClientPlugin, {
   shapePath: '/electric/v1/shape',
@@ -93,7 +113,7 @@ Object filters use parameterized Electric Shape predicates. Exact values,
 All Electric cursor parameters are forwarded. The client cannot override the
 configured table, and Electric source credentials stay server-side.
 
-## Model configuration
+### Model configuration
 
 Models may be strings (table, service name, and default `uid` key) or objects:
 
@@ -108,7 +128,7 @@ Requires Node 18+ for the built-in Fetch API. The PostgreSQL client only needs a
 `query(sql, values)` method; a `pg.Pool` is recommended so each mutation and its
 transaction ID are captured in the same transaction.
 
-## Run Electric from Docker
+### Run Electric from Docker
 
 A local install of the Electric sync engine requires Elixir and Erlang; it is simpler to use a pre-built Docker image.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jcbuisson/express-x-plugins",
-  "version": "4.0.4",
+  "version": "4.0.5",
   "description": "Plugins for express-x",
   "type": "module",
   "main": "./src/electric-server-plugin.mjs",

package/src/electric-client-plugin.mjs

@@ -10,6 +10,7 @@ import { getCurrentScope, onScopeDispose, ref } from 'vue'
  *   electricClientPlugin(app)
  *   const todo = app.createElectricModel('todos')
  *   todo.getObservable({ completed: false }).subscribe(...)
+ *   const completedTodos = await todo.findMany({ completed: false })
  */
 export function electricClientPlugin(app, options = {}) {
    const shapePath = options.shapePath ?? '/electric/v1/shape'
@@ -47,13 +48,6 @@ export function electricClientPlugin(app, options = {}) {
          })
       }
 
-      function getVueRef(where = {}) {
-         const value = ref([])
-         const subscription = getObservable(where).subscribe(rows => { value.value = rows })
-         if (getCurrentScope()) onScopeDispose(() => subscription.unsubscribe())
-         return value
-      }
-
       function findMany(where = {}) {
          const observable = getObservable(where)
          if (!getCurrentScope()) return firstValueFrom(observable)
@@ -66,10 +60,6 @@ export function electricClientPlugin(app, options = {}) {
          return firstValueFrom(observable.pipe(takeUntil(scopeDisposed)))
       }
 
-      function findUnique(where = {}) {
-         return findMany(where).then(rows => rows[0] ?? null)
-      }
-
       async function create(data) {
          assertPlainObject(data, 'mutation data')
          const uid = globalThis.crypto?.randomUUID?.()
@@ -89,7 +79,7 @@ export function electricClientPlugin(app, options = {}) {
          return value
       }
 
-      return { getObservable, getVueRef, findMany, findUnique, create, update, remove }
+      return { getObservable, findMany, create, update, remove }
    }
 
    return Object.assign(app, { createElectricModel })