@jcbuisson/express-x 1.2.0 → 1.2.2

package/README.md

@@ -33,12 +33,11 @@ backed in a [Prisma](https://www.prisma.io/) database
 
 ```js
 // app.js
-import express from 'express'
 import bodyParser from 'body-parser'
-import expressX from '@jcbuisson/express-x'
+import { expressXServer } from '@jcbuisson/express-x'
 
-// `app` is a regular express application, enhanced with express-x features
-const app = expressX(express())
+// `app` is a regular express application, enhanced with service and real-time features
+const app = expressX()
 
 // create two CRUD database services. They provide Prisma methods: `create`, 'createMany', 'find', 'findMany', 'upsert', etc.
 app.createDatabaseService('User')
@@ -126,22 +125,16 @@ With a few lines of code, we got a complete REST API over the database tables. B
 
 ## Use it with a websocket client
 
-First install ExpressX client library:
-
-```bash
-npm i @jcbuisson/express-x-client
-```
-
 Create the following client NodeJS script:
 
 ```js
 // client.js
 import io from 'socket.io-client'
-import expressxClient from '@jcbuisson/express-x-client'
+import { expressXClient } from '@jcbuisson/express-x'
 
 const socket = io('http://localhost:8000', { transports: ["websocket"] })
 
-const app = expressxClient(socket)
+const app = expressXClient(socket)
 
 async function main() {
    const user = await app.service('User').create({
@@ -180,7 +173,7 @@ node client.js
 ```
 
 It prints the following lines in the console:
-```
+```json
 joe {
   id: 11,
   name: 'Joe',
@@ -218,12 +211,11 @@ and then broacasted to all connected clients, leading to real-time updates.
 
 ```js
 // app.js
-import express from 'express'
-import expressX from '@jcbuisson/express-x'
+import { expressXServer } from '@jcbuisson/express-x'
 import { PrismaClient } from '@prisma/client'
 
-// `app` is a regular express application, enhanced with express-x features
-const app = expressX(express())
+// `app` is a regular express application, enhanced with service and real-time features
+const app = expressX()
 
 // configure prisma client from schema
 app.set('prisma', new PrismaClient())
@@ -252,7 +244,6 @@ app.server.listen(8000, () => console.log(`App listening at http://localhost:800
 Here is how a client may listen to channel events:
 
 ```js
-// client.js
 ...
 app.service('Post').on('create', post => {
    console.log('post event created', post)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jcbuisson/express-x",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "",
   "type": "module",
   "main": "src/index.mjs",

package/src/index.mjs

@@ -1,10 +1,10 @@
 
-import { expressXServer } from './server.mjs'
+import { expressX } from './server.mjs'
 import { expressXClient } from './client.mjs'
 import { hashPassword, protect, setSessionJWT, } from './common-hooks.mjs'
 
 export {
-   expressXServer,
+   expressX,
    expressXClient,
 
    hashPassword,

package/src/server.mjs

@@ -1,14 +1,17 @@
 
 import http from 'http'
 import { Server } from "socket.io"
+import express from 'express'
 import { PrismaClient } from '@prisma/client'
 
 /*
- * Enhance `app` express application with Feathers-like services
+ * Enhance `app` express application with services and real-time features
  */
-export function expressXServer(app, options={}) {
+export function expressX(options = {}) {
 
-   if (options.debug === undefined) options.debug = false
+   const app = express()
+
+   if (options.debug === undefined) options.debug = true
    if (options.ws === undefined) options.ws = { ws_prefix: "expressx" }
 
    const services = {}
@@ -144,7 +147,7 @@ export function expressXServer(app, options={}) {
 
 
       app.post(path, async (req, res) => {
-         if (options.debug) console.log("http request POST", req)
+         if (options.debug) console.log("http request POST", req.url)
          context.http.req = req
          try {
             const value = await service.__create(context, { data: req.body })
@@ -157,7 +160,7 @@ export function expressXServer(app, options={}) {
       })
 
       app.get(path, async (req, res) => {
-         if (options.debug) console.log("http request GET", req)
+         if (options.debug) console.log("http request GET", req.url)
          context.http.req = req
          const query = { ...req.query }
          try {
@@ -193,7 +196,7 @@ export function expressXServer(app, options={}) {
       })
 
       app.get(`${path}/:id`, async (req, res) => {
-         if (options.debug) console.log("http request GET", req)
+         if (options.debug) console.log("http request GET", req.url)
          context.http.req = req
          try {
             const value = await service.__findUnique(context, {
@@ -210,7 +213,7 @@ export function expressXServer(app, options={}) {
       })
 
       app.patch(`${path}/:id`, async (req, res) => {
-         if (options.debug) console.log("http request PATCH", req)
+         if (options.debug) console.log("http request PATCH", req.url)
          context.http.req = req
          try {
             const value = await service.__update(context, {
@@ -228,7 +231,7 @@ export function expressXServer(app, options={}) {
       })
 
       app.delete(`${path}/:id`, async (req, res) => {
-         if (options.debug) console.log("http request DELETE", req)
+         if (options.debug) console.log("http request DELETE", req.url)
          context.http.req = req
          try {
             const value = await service.__delete(context, {

package/test/index.test.js

@@ -1,5 +1,4 @@
 
-import express from 'express'
 import bodyParser from 'body-parser'
 import axios from 'axios'
 import io from 'socket.io-client'
@@ -7,11 +6,11 @@ import io from 'socket.io-client'
 
 import { assert } from 'chai'
 
-import { expressXServer, expressXClient } from '../src/index.mjs'
+import { expressX, expressXClient } from '../src/index.mjs'
 
 
-// `app` is a regular express application, enhanced with express-x features
-const app = expressXServer(express(), { debug: false })
+// `app` is a regular express application, enhanced with services and real-time features
+const app = expressX()
 
 app.createDatabaseService('User')
 app.createDatabaseService('Post')