@aaroncadillac/crudify-mongo 1.4.0 → 1.6.0

package/.github/workflows/publish.yml

@@ -1,6 +1,9 @@
+name : Publish
+
 on:
   push:
-    branches: master
+    tags:
+      - 'v*'
 
 jobs:
   publish:

package/.github/workflows/test.yml

@@ -10,9 +10,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '20'
       - name: Install dependencies

package/README.md

@@ -55,6 +55,116 @@ const routes = ( fastify, opts, done ) => {
   })
 ```
 
+### Swagger auto-documentation
+
+You can add Swagger auto-documentation to your API, using the [`@fastify/swagger`](https://github.com/fastify/fastify-swagger) and [`@fastify/swagger-ui`](https://github.com/fastify/fastify-swagger-ui) plugins.
+
+Once you have those plugins installed, you can use the following code to add Swagger auto-documentation to your API:
+
+```js
+// server.js
+
+import 'dotenv/config';
+import Fastify from 'fastify'
+import { dbConnection } from './db-connection.js';
+import { routes } from './routes.js';
+import * as Swagger  from '@fastify/swagger'
+import * as SwaggerUI from '@fastify/swagger-ui'
+
+const fastify = Fastify({
+  logger: true
+})
+
+fastify.register(await dbConnection)
+process.env.NODE_ENV == 'development' && fastify.register(Swagger) && await fastify.register(SwaggerUI, {
+  routePrefix: '/docs',
+  uiConfig: {
+    docExpansion: 'list',
+    deepLinking: true
+  },
+  uiHooks: {
+    onRequest: function (request, reply, next) { next() },
+    preHandler: function (request, reply, next) { next() }
+  },
+  staticCSP: true,
+  transformStaticCSP: (header) => header,
+  transformSpecification: (swaggerObject, request, reply) => { return swaggerObject },
+  transformSpecificationClone: true
+})
+
+fastify.register(routes)
+
+fastify.listen({ port: process.env.PORT || 3000, host: process.env.HOST || 'localhost' }, function (err, address) {
+  if (err) {
+    fastify.log.error(err)
+    process.exit(1)
+  }
+})
+```
+
+As you can see in the code above, you only need to import the `@fastify/swagger` and `@fastify/swagger-ui` plugins, and then use the `fastify.register` method to register the plugins., you even can customize your swagger documentation path and enable documentation only in development environment (recommended).
+
+### Body and Response schema auto generation
+
+To help you to use Swagger `crudify-mongo 1.5.0+` supports `body` and `response` schema auto generation, this feature is enable by default and you only need to install [`mongoose-schema-jsonschema`](https://github.com/DScheglov/mongoose-schema-jsonschema) to use it, this dependency helps you to use your mongoose model schema as a json schema compatible with fastify specification based on [AJV schema validation](https://ajv.js.org).
+
+Here an example
+
+```js
+// models/user.js
+
+import mongoose from 'mongoose';
+import paginate from 'mongoose-paginate-v2'; // Required for pagination
+import extendMongoose from 'mongoose-schema-jsonschema'; // Required for body and response schema auto generation
+
+extendMongoose(mongoose);
+
+const Schema = mongoose.Schema;
+
+const userSchema = new Schema({
+  name: {
+    type: String,
+    required: true,
+  },
+  age: {
+    type: Number,
+    required: true,
+  },
+  email: {
+    type: String,
+    required: true,
+  },
+}, {
+  timestamps: true,
+});
+
+userSchema.plugin(paginate);
+
+const UserSchema = userSchema.jsonSchema();
+const UserModel = mongoose.model('Users', userSchema);
+
+export {
+  UserModel,
+  UserSchema
+}
+```
+
+Then you need to add on the `JSONSchema` property of your fastify routes
+
+```js
+// routes.js
+import { Crudify } from '@aaroncadillac/crudify-mongo';
+import { UserModel, UserSchema } from './models/user.js';
+
+const routes = ( fastify, opts, done ) => {
+  fastify.register(Crudify, {
+    url: '/users',
+    Model: UserModel
+    JSONSchema: UserSchema
+  })
+}
+```
+
 ## Getting started
 
 ### Installation

package/crudify.js

@@ -1,21 +1,96 @@
-function Crudify (fastify, opts, next) {
-  fastify.get(`${opts.url}`, opts, async (req, reply) => {
-    try {
-      opts = { ...opts,
-        schema: {
-          querystring: {
-            type: 'object',
-            properties: {
-              filters: {
-                type: 'string'
-              },
-              pagination: {
-                type: 'string'
-              }
+function removeKeys(obj, keysToRemove) {
+  if (typeof obj !== 'object' || obj === null) return;
+
+  for (const key in obj) {
+    if (keysToRemove.includes(key)) {
+      delete obj[key];
+    } else if (typeof obj[key] === 'object' && obj[key] !== null) {
+      removeKeys(obj[key], keysToRemove);
+    }
+  }
+}
+
+
+function addPostBody(opts) {
+  const schema = opts.JSONSchema
+  if ( schema ) {
+    const properties = {...schema.properties}
+    removeKeys(properties, ['x-ref'])
+    const newOpts = {
+      ...opts,
+      schema: {
+        ...opts.schema,
+        body: {
+          type: schema.type,
+          properties,
+          required: schema.required
+        }
+      }
+    }
+    delete newOpts.schema.body.properties._id
+    delete newOpts.schema.body.properties.createdAt
+    delete newOpts.schema.body.properties.updatedAt
+    return newOpts
+  } else {
+    return opts
+  }
+}
+
+function addGetResponseUnitary(opts) {
+  const schema = opts.JSONSchema
+  if ( schema ) {
+    const newOpts = {
+      ...opts,
+      schema: {
+        response: {
+          200: schema
+        }
+      }
+    }
+    return newOpts
+  } else {
+    return opts
+  }
+}
+
+function addGetResponseArray(opts) {
+  const schema = opts.JSONSchema
+  if ( schema ) {
+    const newOpts = {
+      ...opts,
+      schema: {
+        response: {
+          200: {
+            type: 'array',
+            items: schema
+          }
+        },
+        querystring: {
+          type: 'object',
+          properties: {
+            filters: {
+              type: 'string'
+            },
+            pagination: {
+              type: 'string'
             }
           }
         }
       }
+    }
+    return newOpts
+  } else {
+    return opts
+  }
+}
+
+function Crudify (fastify, opts, next) {
+  const optsGet = addGetResponseUnitary(opts)
+  const optsGetAll = addGetResponseArray(opts)
+  const optsPost = addPostBody(optsGet)
+  
+  fastify.get(`${opts.url}`, optsGetAll, async (req, reply) => {
+    try {
       const filterObject = JSON.parse(req.query.filters ||= '{}')
       for (const key in filterObject) {
         if (typeof filterObject[key] === 'string') {
@@ -31,7 +106,7 @@ function Crudify (fastify, opts, next) {
     }
   })
 
-  fastify.get(`${opts.url}/:id`, opts, async (req, reply) => {
+  fastify.get(`${opts.url}/:id`, optsGet, async (req, reply) => {
     try {
       const response = await opts.Model.findById(req.params.id)
       if (!response) {
@@ -48,7 +123,7 @@ function Crudify (fastify, opts, next) {
     }
   })
 
-  fastify.post(`${opts.url}`, opts, async (req, reply) => {
+  fastify.post(`${opts.url}`, optsPost, async (req, reply) => {
     try {
       await opts.Model.validate(req.body)
     } catch (err) {
@@ -60,8 +135,8 @@ function Crudify (fastify, opts, next) {
       throw new Error(err)
     }
   })
-
-  fastify.put(`${opts.url}/:id`, opts, async (req, reply) => {
+  
+  fastify.put(`${opts.url}/:id`, optsGet, async (req, reply) => {
     try {
       const response = await opts.Model.findOneAndUpdate({ _id: req.params.id }, req.body, { 
         new: true,

package/jest-mongodb-config.js

@@ -6,6 +6,7 @@ export default {
     },
     autoStart: false,
     instance: {},
+    replSet: false
   },
-  useSharedDBForAllJestWorkers: false
+  useSharedDBForAllJestWorkers: false,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aaroncadillac/crudify-mongo",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "An automatic CRUD generator for fastify",
   "main": "crudify.js",
   "repository": "git@github.com:aaroncadillac/crudify-mongo.git",

package/test/crudify.test.js

@@ -10,10 +10,7 @@ let connection;
 
 beforeAll(async () => {
     app = fastify();
-    await connect(global.__MONGO_URI__, {
-        useNewUrlParser: true,
-        useUnifiedTopology: true,
-    });
+    await connect(global.__MONGO_URI__);
     connection = mongoose.connection
     const userSchema = new Schema({ name: String, age: Number, email: String });
     userSchema.plugin(paginate);