@jcbuisson/express-x-plugins 4.1.1 → 4.1.2

package/README.md

@@ -105,7 +105,7 @@ app.configure(electricClientPlugin, {
   shapePath: '/electric/v1/shape',
 })
 
-// Client-generated UUID stored in the default `uid` primary key:
+// Client-generated UUID stored in the default `id` primary key:
 const todo = app.createElectricModel('todos')
 
 // Or, for a database-generated primary key such as SERIAL/IDENTITY:
@@ -121,8 +121,8 @@ const subscription = todo.getObservable({ completed: false }).subscribe(rows =>
 
 // Mutations use the matching Express-X service and are reflected by Electric.
 await todo.create({ title: 'Learn Shapes', completed: false })
-await todo.update(uid, { completed: true })
-await todo.remove(uid)
+await todo.update(id, { completed: true })
+await todo.remove(id)
 
 const created = await numberedTodo.create({ title: 'Assigned by PostgreSQL' })
 console.log(created.id)
@@ -143,7 +143,7 @@ configured table, and Electric source credentials stay server-side.
 
 ### Model configuration
 
-Server models may be strings (table, service name, and default `uid` key) or objects:
+Server models may be strings (table, service name, and default `id` key) or objects:
 
 ```js
 { name: 'todo', table: 'todos', primaryKey: 'id' }

package/package.json

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

package/src/electric-server-plugin.mjs

@@ -55,14 +55,14 @@ export function electricOfflinePlugin(app, db, models, options = {}) {
          },
 
          // create(data): the primary key is server-generated
-         // create(uid, data): uid (the primary key) is provided by the client
-         create: async function(uidOrData, data) {
+         // create(id, data): id (the primary key) is provided by the client
+         create: async function(idOrData, data) {
             const hasClientId = data !== undefined
-            const mutationData = hasClientId ? data : uidOrData
-            await authorize(this, model.name, 'create', hasClientId ? [uidOrData, mutationData] : [mutationData])
+            const mutationData = hasClientId ? data : idOrData
+            await authorize(this, model.name, 'create', hasClientId ? [idOrData, mutationData] : [mutationData])
             assertPlainObject(mutationData, 'mutation data')
             const safeData = hasClientId
-               ? { ...mutationData, [model.primaryKey]: uidOrData }
+               ? { ...mutationData, [model.primaryKey]: idOrData }
                : { ...mutationData }
             const entries = Object.entries(safeData).filter(([, value]) => value !== undefined)
             const columns = entries.map(([column]) => quoteIdentifier(column, 'data column'))
@@ -164,7 +164,7 @@ function normalizeModels(models) {
       }
       const name = config.name
       const table = config.table ?? name
-      const primaryKey = config.primaryKey ?? 'uid'
+      const primaryKey = config.primaryKey ?? 'id'
       quoteIdentifier(name, 'model name')
       return {
          name,

package/test/electric-server-plugin.test.mjs

@@ -10,7 +10,7 @@ function fixture({ authorize = async () => true, fetch } = {}) {
    const db = {
       async query(sql, values = []) {
          queries.push({ sql, values })
-         return { rows: [{ uid: values.at(-1) ?? 'one', label: 'row' }] }
+         return { rows: [{ id: values.at(-1) ?? 'one', label: 'row' }] }
       },
    }
    const app = {
@@ -25,14 +25,18 @@ test('registers the mutation API', async () => {
    const { services, queries } = fixture()
    const service = services.get('todos')
    assert.deepEqual(Object.keys(service), [
-      'create', 'update', 'delete',
+      'findUnique', 'findMany', 'create', 'update', 'delete',
    ])
 
    const value = await service.create.call({}, 'one', { label: 'new' })
-   assert.equal(value.uid, 'one')
+   assert.equal(value.id, 'one')
 
    await service.create.call({}, 'only-id', {})
-   assert.match(queries[1].sql, /DO UPDATE SET "uid" = EXCLUDED\."uid"/)
+   assert.match(queries[1].sql, /DO UPDATE SET "id" = EXCLUDED\."id"/)
+   assert.equal(queries[1].values[0], 'only-id')
+   assert.deepEqual(fixture().registration.models, [
+      { name: 'todos', table: 'todos', primaryKey: 'id' },
+   ])
    await assert.rejects(service.create.call({}, 'bad', []), /plain object/)
 })